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