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