src/include/surf/surf.h

   1 /* Copyright (c) 2004-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef _SURF_SURF_H
   8 #define _SURF_SURF_H
   9
  10 #include "xbt/swag.h"
  11 #include "xbt/dynar.h"
  12 #include "xbt/dict.h"
  13 #include "xbt/graph.h"
  14 #include "xbt/misc.h"
  15 #include "xbt/config.h"
  16 #include "src/portable.h"
  17 #include "surf/surf_routing.h"
  18 #include "surf/datatypes.h"
  19 #include "xbt/lib.h"
  20 #include "surf/surf_routing.h"
  21 #include "simgrid/platf_interface.h"
  22 #include "simgrid/datatypes.h"
  23 #include "simgrid/forward.h"
  24
  25 SG_BEGIN_DECL()
  26 /* Actions and models are highly connected structures... */
  27
  28 /* user-visible parameters */
  29 extern XBT_PRIVATE double sg_tcp_gamma;
  30 extern XBT_PRIVATE double sg_sender_gap;
  31 extern XBT_PRIVATE double sg_latency_factor;
  32 extern XBT_PRIVATE double sg_bandwidth_factor;
  33 extern XBT_PRIVATE double sg_weight_S_parameter;
  34 extern XBT_PRIVATE int sg_network_crosstraffic;
  35 extern XBT_PRIVATE xbt_dynar_t surf_path;
  36
  37 typedef enum {
  38   SURF_NETWORK_ELEMENT_NULL = 0, /* NULL */
  39   SURF_NETWORK_ELEMENT_HOST,     /* host type */
  40   SURF_NETWORK_ELEMENT_ROUTER,   /* router type */
  41   SURF_NETWORK_ELEMENT_AS        /* AS type */
  42 } e_surf_network_element_type_t;
  43
  44 #ifdef __cplusplus
  45
  46 namespace simgrid {
  47 namespace surf {
  48
  49 class Model;
  50 class CpuModel;
  51 class HostModel;
  52 class VMModel;
  53 class NetworkModel;
  54 class StorageModel;
  55 class Resource;
  56 class ResourceLmm;
  57 class Host;
  58 class HostCLM03;
  59 class NetworkCm02Link;
  60 class Action;
  61 class ActionLmm;
  62 class StorageActionLmm;
  63 class As;
  64 class RoutingPlatf;
  65
  66 }
  67 }
  68
  69 typedef simgrid::surf::Model surf_Model;
  70 typedef simgrid::surf::CpuModel surf_CpuModel;
  71 typedef simgrid::surf::HostModel surf_HostModel;
  72 typedef simgrid::surf::VMModel surf_VMModel;
  73 typedef simgrid::surf::NetworkModel surf_NetworkModel;
  74 typedef simgrid::surf::StorageModel surf_StorageModel;
  75 typedef simgrid::surf::Resource surf_Resource;
  76 typedef simgrid::surf::ResourceLmm surf_ResourceLmm;
  77 typedef simgrid::surf::Host surf_Host;
  78 typedef simgrid::surf::HostCLM03 surf_HostCLM03;
  79 typedef simgrid::surf::NetworkCm02Link surf_NetworkCm02Link;
  80 typedef simgrid::surf::Action surf_Action;
  81 typedef simgrid::surf::ActionLmm surf_ActionLmm;
  82 typedef simgrid::surf::StorageActionLmm surf_StorageActionLmm;
  83 typedef simgrid::surf::RoutingPlatf surf_RoutingPlatf;
  84
  85 #else
  86
  87 typedef struct surf_Model surf_Model;
  88 typedef struct surf_CpuModel surf_CpuModel;
  89 typedef struct surf_HostModel surf_HostModel;
  90 typedef struct surf_VMModel surf_VMModel;
  91 typedef struct surf_NetworkModel surf_NetworkModel;
  92 typedef struct surf_StorageModel surf_StorageModel;
  93 typedef struct surf_Resource surf_Resource;
  94 typedef struct surf_ResourceLmm surf_ResourceLmm;
  95 typedef struct surf_HostCLM03 surf_HostCLM03;
  96 typedef struct surf_Host surf_Host;
  97 typedef struct surf_NetworkCm02Link surf_NetworkCm02Link;
  98 typedef struct surf_Action surf_Action;
  99 typedef struct surf_ActionLmm surf_ActionLmm;
 100 typedef struct surf_StorageActionLmm surf_StorageActionLmm;
 101 typedef struct surf_RoutingPlatf surf_RoutingPlatf;
 102
 103 #endif
 104
 105 /** @ingroup SURF_c_bindings
 106  *  \brief Model datatype
 107  *
 108  *  Generic data structure for a model. The hosts,
 109  *  the CPUs and the network links are examples of models.
 110  */
 111 typedef surf_Model *surf_model_t;
 112 typedef surf_CpuModel *surf_cpu_model_t;
 113 typedef surf_HostModel *surf_host_model_t;
 114 typedef surf_VMModel *surf_vm_model_t;
 115 typedef surf_NetworkModel *surf_network_model_t;
 116 typedef surf_StorageModel *surf_storage_model_t;
 117
 118 typedef xbt_dictelm_t surf_resource_t;
 119 typedef surf_Resource *surf_cpp_resource_t;
 120 typedef surf_Host *surf_host_t;
 121 typedef surf_Cpu *surf_cpu_t;
 122
 123 /** @ingroup SURF_c_bindings
 124  *  \brief Action structure
 125  *
 126  *  Never create s_surf_action_t by yourself ! The actions are created
 127  *  on the fly when you call execute or communicate on a model.
 128  *
 129  *  \see e_surf_action_state_t
 130  */
 131 typedef surf_Action *surf_action_t;
 132 typedef surf_RoutingPlatf *routing_platf_t;
 133
 134 typedef struct surf_file *surf_file_t;
 135
 136 /** @Brief Specify that we use that action */
 137 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
 138
 139 /** @brief Creates a new action.
 140  *
 141  * @param size The size is the one of the subtype you want to create
 142  * @param cost initial value
 143  * @param model to which model we should attach this action
 144  * @param failed whether we should start this action in failed mode
 145  */
 146 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
 147                                    surf_model_t model, int failed);
 148
 149 /** \brief Resource model description
 150  */
 151 typedef struct surf_model_description {
 152   const char *name;
 153   const char *description;
 154   void_f_void_t model_init_preparse;
 155 } s_surf_model_description_t, *surf_model_description_t;
 156
 157 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
 158                                        const char *name);
 159 XBT_PUBLIC(void) model_help(const char *category,
 160                             s_surf_model_description_t * table);
 161
 162 /** @ingroup SURF_interface
 163  *  @brief Action states
 164  *
 165  *  @see Action
 166  */
 167 typedef enum {
 168   SURF_ACTION_READY = 0,        /**< Ready        */
 169   SURF_ACTION_RUNNING,          /**< Running      */
 170   SURF_ACTION_FAILED,           /**< Task Failure */
 171   SURF_ACTION_DONE,             /**< Completed    */
 172   SURF_ACTION_TO_FREE,          /**< Action to free in next cleanup */
 173   SURF_ACTION_NOT_IN_THE_SYSTEM /**< Not in the system anymore. Why did you ask ? */
 174 } e_surf_action_state_t;
 175
 176 /** @ingroup SURF_vm_interface
 177  *
 178  *
 179  */
 180 /* FIXME: Where should the VM state be defined? */
 181 typedef enum {
 182   SURF_VM_STATE_CREATED, /**< created, but not yet started */
 183   SURF_VM_STATE_RUNNING,
 184   SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
 185
 186   SURF_VM_STATE_SAVING, /**< Save/restore involves disk I/O, so there should be transition states. */
 187   SURF_VM_STATE_SAVED,
 188   SURF_VM_STATE_RESTORING,
 189 } e_surf_vm_state_t;
 190
 191 /***************************/
 192 /* Generic model object */
 193 /***************************/
 194
 195 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
 196
 197 static inline void *surf_storage_resource_priv(const void *storage){
 198   return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
 199 }
 200
 201 static inline void *surf_storage_resource_by_name(const char *name){
 202   return xbt_lib_get_elm_or_null(storage_lib, name);
 203 }
 204
 205 /** @{ @ingroup SURF_c_bindings */
 206
 207 /**
 208  * @brief Pop an action from the done actions set
 209  *
 210  * @param model The model from which the action is extracted
 211  * @return An action in done state
 212  */
 213 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
 214
 215 /**
 216  * @brief Pop an action from the failed actions set
 217  *
 218  * @param model The model from which the action is extracted
 219  * @return An action in failed state
 220  */
 221 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
 222
 223 /**
 224  * @brief Get the size of the running action set of a model
 225  *
 226  * @param model The model
 227  * @return The size of the running action set
 228  */
 229 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
 230
 231 /** @brief Get the route (dynar of sg_link_t) between two hosts */
 232 XBT_PUBLIC(xbt_dynar_t) surf_host_model_get_route(
 233   surf_host_model_t model, sg_host_t src, sg_host_t dst);
 234
 235 /** @brief Create a new VM on the specified host */
 236 XBT_PUBLIC(void) surf_vm_model_create(const char *name, sg_host_t host_PM);
 237
 238 /** @brief Create a communication between two hosts
 239  *
 240  * @param model The model which handle the communication
 241  * @param src The source host
 242  * @param dst The destination host
 243  * @param size The amount of data (in bytes) needed to transfer
 244  * @param rate [description]
 245  * @return The action corresponding to the communication
 246  */
 247 XBT_PUBLIC(surf_action_t) surf_network_model_communicate(surf_network_model_t model, sg_host_t src, sg_host_t dst, double size, double rate);
 248
 249 /**
 250  * @brief Get the name of a surf resource (cpu, host, network, …)
 251  *
 252  * @param resource The surf resource
 253  * @return The name of the surf resource
 254  */
 255 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
 256 static inline const char * surf_cpu_name(surf_cpu_t cpu) {
 257   return surf_resource_name((surf_cpp_resource_t)cpu);
 258 }
 259
 260 /** @brief Get the available speed of cpu associated to a host */
 261 XBT_PUBLIC(double) surf_host_get_available_speed(sg_host_t host);
 262
 263 /** @brief Create a sleep action on the given host */
 264 XBT_PUBLIC(surf_action_t) surf_host_sleep(sg_host_t host, double duration);
 265
 266 /** @brief Create a file opening action on the given host */
 267 XBT_PUBLIC(surf_action_t) surf_host_open(sg_host_t host, const char* fullpath);
 268
 269 /** @brief Create a file closing action on the given host */
 270 XBT_PUBLIC(surf_action_t) surf_host_close(sg_host_t host, surf_file_t fd);
 271
 272 /** @brief Create a file reading action on the given host */
 273 XBT_PUBLIC(surf_action_t) surf_host_read(sg_host_t host, surf_file_t fd, sg_size_t size);
 274
 275 /** @brief Create a file writing action on the given host  */
 276 XBT_PUBLIC(surf_action_t) surf_host_write(sg_host_t host, surf_file_t fd, sg_size_t size);
 277
 278 /**
 279  * @brief Get the informations of a file descriptor
 280  * @details The returned xbt_dynar_t contains:
 281  *  - the size of the file,
 282  *  - the mount point,
 283  *  - the storage name,
 284  *  - the storage typeId,
 285  *  - the storage content type
 286  *
 287  * @param host The surf host
 288  * @param fd The file descriptor
 289  * @return An xbt_dynar_t with the file informations
 290  */
 291 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(sg_host_t host, surf_file_t fd);
 292
 293 /**
 294  * @brief Get the available space of the storage at the mount point
 295  *
 296  * @param resource The surf host
 297  * @param name The mount point
 298  * @return The amount of available space in bytes
 299  */
 300 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(sg_host_t resource, const char* name);
 301
 302 /**
 303  * @brief Get the used space of the storage at the mount point
 304  *
 305  * @param resource The surf host
 306  * @param name The mount point
 307  * @return The amount of used space in bytes
 308  */
 309 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(sg_host_t resource, const char* name);
 310
 311 /** @brief Get the list of VMs hosted on the host */
 312 XBT_PUBLIC(xbt_dynar_t) surf_host_get_vms(sg_host_t resource);
 313
 314 /** @brief Retrieve the params of that VM
 315  * @details You can use fields ramsize and overcommit on a PM, too.
 316  */
 317 XBT_PUBLIC(void) surf_host_get_params(sg_host_t resource, vm_params_t params);
 318
 319 /** @brief Sets the params of that VM/PM
 320  * @details You can use fields ramsize and overcommit on a PM, too.
 321  */
 322 XBT_PUBLIC(void) surf_host_set_params(sg_host_t resource, vm_params_t params);
 323
 324 /**
 325  * @brief Destroy a VM
 326  *
 327  * @param resource The surf vm
 328  */
 329 XBT_PUBLIC(void) surf_vm_destroy(sg_host_t resource);
 330
 331 /** @brief Suspend a VM */
 332 XBT_PUBLIC(void) surf_vm_suspend(sg_host_t resource);
 333
 334 /** @brief Resume a VM */
 335 XBT_PUBLIC(void) surf_vm_resume(sg_host_t resource);
 336
 337 /**
 338  * @brief Save the VM (Not yet implemented)
 339  *
 340  * @param resource The surf vm
 341  */
 342 XBT_PUBLIC(void) surf_vm_save(sg_host_t resource);
 343
 344 /**
 345  * @brief Restore the VM (Not yet implemented)
 346  *
 347  * @param resource The surf vm
 348  */
 349 XBT_PUBLIC(void) surf_vm_restore(sg_host_t resource);
 350
 351 /**
 352  * @brief Migrate the VM to the destination host
 353  *
 354  * @param resource The surf vm
 355  * @param ind_vm_ws_dest The destination host
 356  */
 357 XBT_PUBLIC(void) surf_vm_migrate(sg_host_t resource, sg_host_t ind_vm_ws_dest);
 358
 359 /**
 360  * @brief Get the physical machine hosting the VM
 361  *
 362  * @param resource The surf vm
 363  * @return The physical machine hosting the VM
 364  */
 365 XBT_PUBLIC(sg_host_t) surf_vm_get_pm(sg_host_t resource);
 366
 367 /**
 368  * @brief [brief description]
 369  * @details [long description]
 370  *
 371  * @param resource [description]
 372  * @param bound [description]
 373  */
 374 XBT_PUBLIC(void) surf_vm_set_bound(sg_host_t resource, double bound);
 375
 376 /**
 377  * @brief [brief description]
 378  * @details [long description]
 379  *
 380  * @param resource [description]
 381  * @param cpu [description]
 382  * @param mask [description]
 383  */
 384 XBT_PUBLIC(void) surf_vm_set_affinity(sg_host_t resource, sg_host_t cpu, unsigned long mask);
 385
 386 /**
 387  * @brief Get the list of storages attached to an host
 388  *
 389  * @param host The surf host
 390  * @return Dictionary of storage
 391  */
 392 XBT_PUBLIC(xbt_dynar_t) surf_host_get_attached_storage_list(sg_host_t host);
 393
 394 /**
 395  * @brief Unlink a file descriptor
 396  *
 397  * @param host The surf host
 398  * @param fd The file descriptor
 399  *
 400  * @return 0 if failed to unlink, 1 otherwise
 401  */
 402 XBT_PUBLIC(int) surf_host_unlink(sg_host_t host, surf_file_t fd);
 403
 404 /**
 405  * @brief Get the size of a file on a host
 406  *
 407  * @param host The surf host
 408  * @param fd The file descriptor
 409  *
 410  * @return The size in bytes of the file
 411  */
 412 XBT_PUBLIC(size_t) surf_host_get_size(sg_host_t host, surf_file_t fd);
 413
 414 /**
 415  * @brief Get the current position of the file descriptor
 416  *
 417  * @param host The surf host
 418  * @param fd The file descriptor
 419  * @return The current position of the file descriptor
 420  */
 421 XBT_PUBLIC(size_t) surf_host_file_tell(sg_host_t host, surf_file_t fd);
 422
 423 /**
 424  * @brief Move a file to another location on the *same mount point*.
 425  * @details [long description]
 426  *
 427  * @param host The surf host
 428  * @param fd The file descriptor
 429  * @param fullpath The new full path
 430  *
 431  * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
 432  */
 433 XBT_PUBLIC(int) surf_host_file_move(sg_host_t host, surf_file_t fd, const char* fullpath);
 434
 435 /**
 436  * @brief Set the position indictator assiociated with the file descriptor to a new position
 437  * @details [long description]
 438  *
 439  * @param host The surf host
 440  * @param fd The file descriptor
 441  * @param offset The offset from the origin
 442  * @param origin Position used as a reference for the offset
 443  *  - SEEK_SET: beginning of the file
 444  *  - SEEK_CUR: current position indicator
 445  *  - SEEK_END: end of the file
 446  * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
 447  */
 448 XBT_PUBLIC(int) surf_host_file_seek(sg_host_t host,
 449                                            surf_file_t fd, sg_offset_t offset,
 450                                            int origin);
 451
 452 /**
 453  * @brief Get the content of a storage
 454  *
 455  * @param resource The surf storage
 456  * @return A xbt_dict_t with path as keys and size in bytes as values
 457  */
 458 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
 459
 460 /**
 461  * @brief Get the size in bytes of a storage
 462  *
 463  * @param resource The surf storage
 464  * @return The size in bytes of the storage
 465  */
 466 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
 467
 468 /**
 469  * @brief Get the available size in bytes of a storage
 470  *
 471  * @param resource The surf storage
 472  * @return The available size in bytes of the storage
 473  */
 474 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
 475
 476 /**
 477  * @brief Get the size in bytes of a storage
 478  *
 479  * @param resource The surf storage
 480  * @return The used size in bytes of the storage
 481  */
 482 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
 483
 484 /** @brief return the properties set associated to that storage */
 485 XBT_PUBLIC(xbt_dict_t) surf_storage_get_properties(surf_resource_t resource);
 486
 487 /**
 488  * @brief Get the data associated to the action
 489  *
 490  * @param action The surf action
 491  * @return The data associated to the action
 492  */
 493 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
 494
 495 /**
 496  * @brief Set the data associated to the action
 497  * @details [long description]
 498  *
 499  * @param action The surf action
 500  * @param data The new data associated to the action
 501  */
 502 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
 503
 504 /**
 505  * @brief Get the start time of an action
 506  *
 507  * @param action The surf action
 508  * @return The start time in seconds from the beginning of the simulation
 509  */
 510 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
 511
 512 /**
 513  * @brief Get the finish time of an action
 514  *
 515  * @param action The surf action
 516  * @return The finish time in seconds from the beginning of the simulation
 517  */
 518 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
 519
 520 /**
 521  * @brief Get the remains amount of work to do of an action
 522  *
 523  * @param action The surf action
 524  * @return  The remains amount of work to do
 525  */
 526 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
 527
 528 /**
 529  * @brief Set the category of an action
 530  * @details [long description]
 531  *
 532  * @param action The surf action
 533  * @param category The new category of the action
 534  */
 535 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
 536
 537 /**
 538  * @brief Get the state of an action
 539  *
 540  * @param action The surf action
 541  * @return The state of the action
 542  */
 543 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
 544
 545 /**
 546  * @brief Get the cost of an action
 547  *
 548  * @param action The surf action
 549  * @return The cost of the action
 550  */
 551 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
 552
 553 /**
 554  * @brief [brief desrciption]
 555  * @details [long description]
 556  *
 557  * @param action The surf cpu action
 558  * @param cpu [description]
 559  * @param mask [description]
 560  */
 561 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, sg_host_t cpu, unsigned long mask);
 562
 563 /**
 564  * @brief [brief description]
 565  * @details [long description]
 566  *
 567  * @param action The surf cpu action
 568  * @param bound [description]
 569  */
 570 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
 571
 572 /**
 573  * @brief [brief description]
 574  * @details [long description]
 575  *
 576  * @param action The surf network action
 577  */
 578 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
 579
 580 /**
 581  * @brief Get the file associated to a storage action
 582  *
 583  * @param action The surf storage action
 584  * @return The file associated to a storage action
 585  */
 586 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
 587
 588 /**
 589  * @brief Get the result dictionary of an ls action
 590  *
 591  * @param action The surf storage action
 592  * @return The dictionry listing a path
 593  */
 594 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
 595
 596
 597 /**
 598  * @brief Get the host the storage is attached to
 599  *
 600  * @param resource The surf storage
 601  * @return The host name
 602  * may not exist.
 603  */
 604 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
 605
 606 /** @} */
 607
 608 /**************************************/
 609 /* Implementations of model object */
 610 /**************************************/
 611
 612 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
 613 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
 614
 615 /** \ingroup SURF_models
 616  *  \brief The CPU model object for the physical machine layer
 617  */
 618 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
 619
 620 /** \ingroup SURF_models
 621  *  \brief The CPU model object for the virtual machine layer
 622  */
 623 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
 624
 625
 626 /** \ingroup SURF_models
 627  *  \brief Initializes the CPU model with the model Cas01
 628  *
 629  *  By default, this model uses the lazy optimization mechanism that
 630  *  relies on partial invalidation in LMM and a heap for lazy action update.
 631  *  You can change this behavior by setting the cpu/optim configuration
 632  *  variable to a different value.
 633  *
 634  *  You shouldn't have to call it by yourself.
 635  */
 636 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
 637
 638 /** \ingroup SURF_models
 639  *  \brief Initializes the CPU model with trace integration [Deprecated]
 640  *
 641  *  You shouldn't have to call it by yourself.
 642  */
 643 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
 644
 645 /** \ingroup SURF_models
 646  *  \brief The list of all available optimization modes (both for cpu and networks).
 647  *  These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
 648  */
 649 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
 650
 651 /** \ingroup SURF_plugins
 652  *  \brief The list of all available surf plugins
 653  */
 654 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
 655
 656 /** \ingroup SURF_models
 657  *  \brief The list of all available cpu model models
 658  */
 659 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
 660
 661 /**\brief create new host bypass the parser
 662  *
 663  */
 664
 665
 666 /** \ingroup SURF_models
 667  *  \brief The network model
 668  *
 669  *  When creating a new API on top on SURF, you shouldn't use the
 670  *  network model unless you know what you are doing. Only the host
 671  *  model should be accessed because depending on the platform model,
 672  *  the network model can be NULL.
 673  */
 674 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
 675
 676 /** \ingroup SURF_models
 677  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
 678  *
 679  * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
 680  * based on the model 'LV08' and different correction factors depending on the communication
 681  * size (< 1KiB, < 64KiB, >= 64KiB).
 682  * See comments in the code for more information.
 683  *
 684  *  \see surf_host_model_init_SMPI()
 685  */
 686 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
 687
 688 /** \ingroup SURF_models
 689  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
 690  *
 691  * This model impelments a variant of the contention model on Infinband networks based on
 692  * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
 693  *
 694  *  \see surf_host_model_init_IB()
 695  */
 696 XBT_PUBLIC(void) surf_network_model_init_IB(void);
 697
 698 /** \ingroup SURF_models
 699  *  \brief Initializes the platform with the network model 'LegrandVelho'
 700  *
 701  * This model is proposed by Arnaud Legrand and Pedro Velho based on
 702  * the results obtained with the GTNets simulator for onelink and
 703  * dogbone sharing scenarios. See comments in the code for more information.
 704  *
 705  *  \see surf_host_model_init_LegrandVelho()
 706  */
 707 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
 708
 709 /** \ingroup SURF_models
 710  *  \brief Initializes the platform with the network model 'Constant'
 711  *
 712  *  In this model, the communication time between two network cards is
 713  *  constant, hence no need for a routing table. This is particularly
 714  *  usefull when simulating huge distributed algorithms where
 715  *  scalability is really an issue. This function is called in
 716  *  conjunction with surf_host_model_init_compound.
 717  *
 718  *  \see surf_host_model_init_compound()
 719  */
 720 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
 721
 722 /** \ingroup SURF_models
 723  *  \brief Initializes the platform with the network model CM02
 724  *
 725  *  You sould call this function by yourself only if you plan using
 726  *  surf_host_model_init_compound.
 727  *  See comments in the code for more information.
 728  */
 729 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
 730
 731 #ifdef HAVE_NS3
 732 /** \ingroup SURF_models
 733  *  \brief Initializes the platform with the network model NS3
 734  *
 735  *  This function is called by surf_host_model_init_NS3
 736  *  or by yourself only if you plan using surf_host_model_init_compound
 737  *
 738  *  \see surf_host_model_init_NS3()
 739  */
 740 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
 741 #endif
 742
 743 /** \ingroup SURF_models
 744  *  \brief Initializes the platform with the network model Reno
 745  *
 746  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 747  *
 748  *  Reference:
 749  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 750  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 751  *
 752  *  Call this function only if you plan using surf_host_model_init_compound.
 753  *
 754  */
 755 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
 756
 757 /** \ingroup SURF_models
 758  *  \brief Initializes the platform with the network model Reno2
 759  *
 760  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 761  *
 762  *  Reference:
 763  *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
 764  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 765  *
 766  *  Call this function only if you plan using surf_host_model_init_compound.
 767  *
 768  */
 769 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
 770
 771 /** \ingroup SURF_models
 772  *  \brief Initializes the platform with the network model Vegas
 773  *
 774  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
 775  *  to the proportional fairness.
 776  *
 777  *  Reference:
 778  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 779  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 780  *
 781  *  Call this function only if you plan using surf_host_model_init_compound.
 782  *
 783  */
 784 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
 785
 786 /** \ingroup SURF_models
 787  *  \brief The list of all available network model models
 788  */
 789 XBT_PUBLIC_DATA(s_surf_model_description_t)
 790     surf_network_model_description[];
 791
 792 /** \ingroup SURF_models
 793  *  \brief The storage model
 794  */
 795 XBT_PUBLIC(void) surf_storage_model_init_default(void);
 796
 797 /** \ingroup SURF_models
 798  *  \brief The list of all available storage modes.
 799  *  This storage mode can be set using --cfg=storage/model:...
 800  */
 801 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
 802
 803 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
 804
 805 /** \ingroup SURF_models
 806  *  \brief The host model
 807  *
 808  *  Note that when you create an API on top of SURF,
 809  *  the host model should be the only one you use
 810  *  because depending on the platform model, the network model and the CPU model
 811  *  may not exist.
 812  */
 813 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
 814
 815 /** \ingroup SURF_models
 816  *  \brief The vm model
 817  *
 818  *  Note that when you create an API on top of SURF,
 819  *  the vm model should be the only one you use
 820  *  because depending on the platform model, the network model and the CPU model
 821  *  may not exist.
 822  */
 823 XBT_PUBLIC_DATA(surf_vm_model_t) surf_vm_model;
 824
 825 /** \ingroup SURF_models
 826  *  \brief Initializes the platform with a compound host model
 827  *
 828  *  This function should be called after a cpu_model and a
 829  *  network_model have been set up.
 830  *
 831  */
 832 XBT_PUBLIC(void) surf_host_model_init_compound(void);
 833
 834 /** \ingroup SURF_models
 835  *  \brief Initializes the platform with the current best network and cpu models at hand
 836  *
 837  *  This platform model separates the host model and the network model.
 838  *  The host model will be initialized with the model compound, the network
 839  *  model with the model LV08 (with cross traffic support) and the CPU model with
 840  *  the model Cas01.
 841  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
 842  *
 843  */
 844 XBT_PUBLIC(void) surf_host_model_init_current_default(void);
 845
 846 /** \ingroup SURF_models
 847  *  \brief Initializes the platform with the model L07
 848  *
 849  *  With this model, only parallel tasks can be used. Resource sharing
 850  *  is done by identifying bottlenecks and giving an equal share of
 851  *  the model to each action.
 852  *
 853  */
 854 XBT_PUBLIC(void) surf_host_model_init_ptask_L07(void);
 855
 856 /** \ingroup SURF_models
 857  *  \brief The list of all available host model models
 858  */
 859 XBT_PUBLIC_DATA(s_surf_model_description_t)
 860     surf_host_model_description[];
 861
 862 /** \ingroup SURF_models
 863  *  \brief Initializes the platform with the current best network and cpu models at hand
 864  *
 865  *  This platform model seperates the host model and the network model.
 866  *  The host model will be initialized with the model compound, the network
 867  *  model with the model LV08 (with cross traffic support) and the CPU model with
 868  *  the model Cas01.
 869  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
 870  *
 871  */
 872 XBT_PUBLIC(void) surf_vm_model_init_HL13(void);
 873
 874 /** \ingroup SURF_models
 875  *  \brief The list of all available vm model models
 876  */
 877 XBT_PUBLIC_DATA(s_surf_model_description_t)
 878     surf_vm_model_description[];
 879
 880 /*******************************************/
 881
 882 /** \ingroup SURF_models
 883  *  \brief List of initialized models
 884  */
 885 XBT_PUBLIC_DATA(xbt_dynar_t) all_existing_models;
 886
 887 /** \ingroup SURF_simulation
 888  *  \brief List of hosts that have just restarted and whose autorestart process should be restarted.
 889  */
 890 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
 891
 892 /** \ingroup SURF_simulation
 893  *  \brief List of hosts for which one want to be notified if they ever restart.
 894  */
 895 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
 896
 897 /*******************************************/
 898 /*** SURF Platform *************************/
 899 /*******************************************/
 900 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
 901 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
 902 XBT_PUBLIC_DATA(AS_t) surf_AS_get_by_name(const char * name);
 903 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
 904 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
 905 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
 906 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
 907 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_netcard_t edge);
 908
 909 /*******************************************/
 910 /*** SURF Globals **************************/
 911 /*******************************************/
 912
 913 /** \ingroup SURF_simulation
 914  *  \brief Initialize SURF
 915  *  \param argc argument number
 916  *  \param argv arguments
 917  *
 918  *  This function has to be called to initialize the common
 919  *  structures.  Then you will have to create the environment by
 920  *  calling
 921  *  e.g. surf_host_model_init_CM02()
 922  *
 923  *  \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
 924  */
 925 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
 926
 927 /** \ingroup SURF_simulation
 928  *  \brief Finish simulation initialization
 929  *
 930  *  This function must be called before the first call to surf_solve()
 931  */
 932 XBT_PUBLIC(void) surf_presolve(void);
 933
 934 /** \ingroup SURF_simulation
 935  *  \brief Performs a part of the simulation
 936  *  \param max_date Maximum date to update the simulation to, or -1
 937  *  \return the elapsed time, or -1.0 if no event could be executed
 938  *
 939  *  This function execute all possible events, update the action states
 940  *  and returns the time elapsed.
 941  *  When you call execute or communicate on a model, the corresponding actions
 942  *  are not executed immediately but only when you call surf_solve.
 943  *  Note that the returned elapsed time can be zero.
 944  */
 945 XBT_PUBLIC(double) surf_solve(double max_date);
 946
 947 /** \ingroup SURF_simulation
 948  *  \brief Return the current time
 949  *
 950  *  Return the current time in millisecond.
 951  */
 952 XBT_PUBLIC(double) surf_get_clock(void);
 953
 954 /** \ingroup SURF_simulation
 955  *  \brief Exit SURF
 956  *
 957  *  Clean everything.
 958  *
 959  *  \see surf_init()
 960  */
 961 XBT_PUBLIC(void) surf_exit(void);
 962
 963 /* Prototypes of the functions that handle the properties */
 964 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;       /* the prop set for the currently parsed element (also used in SIMIX) */
 965
 966 /* The same for model_prop set*/
 967 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
 968
 969 /* surf parse file related (public because called from a test suite) */
 970 XBT_PUBLIC(void) parse_platform_file(const char *file);
 971
 972 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
 973 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
 974
 975 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
 976
 977 /*
 978  * Returns the initial path. On Windows the initial path is
 979  * the current directory for the current process in the other
 980  * case the function returns "./" that represents the current
 981  * directory on Unix/Linux platforms.
 982  */
 983 const char *__surf_get_initial_path(void);
 984
 985 /********** Tracing **********/
 986 /* from surf_instr.c */
 987 void TRACE_surf_action(surf_action_t surf_action, const char *category);
 988 void TRACE_surf_alloc(void);
 989 void TRACE_surf_release(void);
 990
 991 /* instr_routing.c */
 992 void instr_routing_define_callbacks (void);
 993 void instr_new_variable_type (const char *new_typename, const char *color);
 994 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color);
 995 void instr_new_user_state_type (const char *father_type, const char *new_typename);
 996 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
 997 int instr_platform_traced (void);
 998 xbt_graph_t instr_routing_platform_graph (void);
 999 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1000
1001 /********** Routing **********/
1002 void routing_AS_begin(sg_platf_AS_cbarg_t AS);
1003 void routing_AS_end(void);
1004 void routing_cluster_add_backbone(Link* bb);
1005 surf_As* routing_get_current();
1006
1007 SG_END_DECL()
1008 #endif                          /* _SURF_SURF_H */