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