src/include/surf/surf.h

   1 /* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SURF_SURF_H
   7 #define SURF_SURF_H
   8
   9 #include "xbt/swag.h"
  10 #include "xbt/dynar.h"
  11 #include "xbt/dict.h"
  12 #include "xbt/graph.h"
  13 #include "xbt/misc.h"
  14 #include "xbt/config.h"
  15 #include "src/internal_config.h"
  16 #include "surf/datatypes.h"
  17 #include "simgrid/datatypes.h"
  18 #include "simgrid/forward.h"
  19
  20 SG_BEGIN_DECL()
  21 /* Actions and models are highly connected structures... */
  22
  23 /* user-visible parameters */
  24 extern XBT_PRIVATE double sg_tcp_gamma;
  25 extern XBT_PRIVATE double sg_sender_gap;
  26 extern XBT_PRIVATE double sg_latency_factor;
  27 extern XBT_PRIVATE double sg_bandwidth_factor;
  28 extern XBT_PRIVATE double sg_weight_S_parameter;
  29 extern XBT_PRIVATE int sg_network_crosstraffic;
  30
  31 #ifdef __cplusplus
  32
  33 namespace simgrid {
  34 namespace surf {
  35
  36 class Model;
  37 class CpuModel;
  38 class HostModel;
  39 class NetworkModel;
  40 class StorageModel;
  41 class Resource;
  42 class NetworkCm02Link;
  43 class Action;
  44 }
  45 }
  46
  47 typedef simgrid::surf::Model surf_Model;
  48 typedef simgrid::surf::CpuModel surf_CpuModel;
  49 typedef simgrid::surf::Cpu surf_Cpu;
  50 typedef simgrid::surf::HostModel surf_HostModel;
  51 typedef simgrid::surf::NetworkModel surf_NetworkModel;
  52 typedef simgrid::surf::StorageImpl surf_Storage;
  53 typedef simgrid::surf::StorageModel surf_StorageModel;
  54 typedef simgrid::surf::Resource surf_Resource;
  55 typedef simgrid::surf::HostImpl surf_Host;
  56 typedef simgrid::surf::Action surf_Action;
  57 typedef simgrid::surf::FileImpl surf_File;
  58
  59 #else
  60
  61 typedef struct surf_Model surf_Model;
  62 typedef struct surf_CpuModel surf_CpuModel;
  63 typedef struct surf_Cpu surf_Cpu;
  64 typedef struct surf_HostModel surf_HostModel;
  65 typedef struct surf_NetworkModel surf_NetworkModel;
  66 typedef struct surf_StorageImpl surf_Storage;
  67 typedef struct surf_StorageModel surf_StorageModel;
  68 typedef struct surf_Resource surf_Resource;
  69 typedef struct surf_Host surf_Host;
  70 typedef struct surf_Action surf_Action;
  71 typedef struct surf_File surf_File;
  72
  73 #endif
  74
  75 /** @ingroup SURF_c_bindings
  76  *  \brief Model datatype
  77  *
  78  *  Generic data structure for a model. The hosts,
  79  *  the CPUs and the network links are examples of models.
  80  */
  81 typedef surf_Model *surf_model_t;
  82 typedef surf_CpuModel *surf_cpu_model_t;
  83 typedef surf_HostModel *surf_host_model_t;
  84 typedef surf_NetworkModel *surf_network_model_t;
  85 typedef surf_StorageModel *surf_storage_model_t;
  86 typedef surf_Storage* surf_storage_t;
  87 typedef surf_File* surf_file_t;
  88
  89 /** @ingroup SURF_c_bindings
  90  *  \brief Action structure
  91  *
  92  *  Never create s_surf_action_t by yourself ! The actions are created
  93  *  on the fly when you call execute or communicate on a model.
  94  *
  95  *  \see e_surf_action_state_t
  96  */
  97 typedef surf_Action *surf_action_t;
  98
  99
 100 /** \brief Resource model description
 101  */
 102 struct surf_model_description {
 103   const char *name;
 104   const char *description;
 105   void_f_void_t model_init_preparse;
 106 };
 107 typedef struct surf_model_description  s_surf_model_description_t;
 108 typedef struct surf_model_description* surf_model_description_t;
 109
 110 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table, const char *name);
 111 XBT_PUBLIC(void) model_help(const char *category, s_surf_model_description_t * table);
 112
 113 /***************************/
 114 /* Generic model object */
 115 /***************************/
 116
 117 /** @{ @ingroup SURF_c_bindings */
 118
 119 /**
 120  * @brief Pop an action from the done actions set
 121  *
 122  * @param model The model from which the action is extracted
 123  * @return An action in done state
 124  */
 125 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
 126
 127 /**
 128  * @brief Pop an action from the failed actions set
 129  *
 130  * @param model The model from which the action is extracted
 131  * @return An action in failed state
 132  */
 133 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
 134
 135 /**
 136  * @brief Get the size of the running action set of a model
 137  *
 138  * @param model The model
 139  * @return The size of the running action set
 140  */
 141 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
 142
 143 /** @brief Create a file closing action on the given host */
 144 XBT_PUBLIC(surf_action_t) surf_host_close(sg_host_t host, surf_file_t fd);
 145
 146 /** @brief Create a file reading action on the given host */
 147 XBT_PUBLIC(surf_action_t) surf_host_read(sg_host_t host, surf_file_t fd, sg_size_t size);
 148
 149 /** @brief Create a file writing action on the given host  */
 150 XBT_PUBLIC(surf_action_t) surf_host_write(sg_host_t host, surf_file_t fd, sg_size_t size);
 151
 152 /**
 153  * @brief Unlink a file descriptor
 154  *
 155  * @param host The surf host
 156  * @param fd The file descriptor
 157  *
 158  * @return 0 if failed to unlink, 1 otherwise
 159  */
 160 XBT_PUBLIC(int) surf_host_unlink(sg_host_t host, surf_file_t fd);
 161
 162 /**
 163  * @brief Move a file to another location on the *same mount point*.
 164  * @details [long description]
 165  *
 166  * @param host The surf host
 167  * @param fd The file descriptor
 168  * @param fullpath The new full path
 169  *
 170  * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
 171  */
 172 XBT_PUBLIC(int) surf_host_file_move(sg_host_t host, surf_file_t fd, const char* fullpath);
 173
 174 /**
 175  * @brief Set the position indictator assiociated with the file descriptor to a new position
 176  * @details [long description]
 177  *
 178  * @param host The surf host
 179  * @param fd The file descriptor
 180  * @param offset The offset from the origin
 181  * @param origin Position used as a reference for the offset
 182  *  - SEEK_SET: beginning of the file
 183  *  - SEEK_CUR: current position indicator
 184  *  - SEEK_END: end of the file
 185  * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
 186  */
 187 XBT_PUBLIC(int) surf_host_file_seek(sg_host_t host, surf_file_t fd, sg_offset_t offset, int origin);
 188
 189 /**
 190  * @brief [brief description]
 191  * @details [long description]
 192  *
 193  * @param action The surf cpu action
 194  * @param bound [description]
 195  */
 196 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
 197
 198 /**
 199  * @brief [brief description]
 200  * @details [long description]
 201  *
 202  * @param action The surf network action
 203  */
 204 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
 205
 206 /**
 207  * @brief Get the file associated to a storage action
 208  *
 209  * @param action The surf storage action
 210  * @return The file associated to a storage action
 211  */
 212 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
 213
 214 /** @} */
 215
 216 /**************************************/
 217 /* Implementations of model object */
 218 /**************************************/
 219
 220 /** \ingroup SURF_models
 221  *  \brief The CPU model object for the physical machine layer
 222  */
 223 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
 224
 225 /** \ingroup SURF_models
 226  *  \brief The CPU model object for the virtual machine layer
 227  */
 228 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
 229
 230
 231 /** \ingroup SURF_models
 232  *  \brief Initializes the CPU model with the model Cas01
 233  *
 234  *  By default, this model uses the lazy optimization mechanism that relies on partial invalidation in LMM and a heap
 235  *  for lazy action update.
 236  *  You can change this behavior by setting the cpu/optim configuration variable to a different value.
 237  *
 238  *  You shouldn't have to call it by yourself.
 239  */
 240 XBT_PUBLIC(void) surf_cpu_model_init_Cas01();
 241
 242 /** \ingroup SURF_models
 243  *  \brief Initializes the CPU model with trace integration [Deprecated]
 244  *
 245  *  You shouldn't have to call it by yourself.
 246  */
 247 XBT_PUBLIC(void) surf_cpu_model_init_ti();
 248
 249 /** \ingroup SURF_models
 250  *  \brief The list of all available optimization modes (both for cpu and networks).
 251  *  These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
 252  */
 253 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
 254
 255 /** \ingroup SURF_plugins
 256  *  \brief The list of all available surf plugins
 257  */
 258 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
 259
 260 /** \ingroup SURF_models
 261  *  \brief The list of all available cpu model models
 262  */
 263 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
 264
 265 /** \ingroup SURF_models
 266  *  \brief The network model
 267  *
 268  *  When creating a new API on top on SURF, you shouldn't use the network model unless you know what you are doing.
 269  *  Only the host model should be accessed because depending on the platform model, the network model can be NULL.
 270  */
 271 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
 272
 273 /** \ingroup SURF_models
 274  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
 275  *
 276  * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud based on the model 'LV08' and
 277  * different correction factors depending on the communication size (< 1KiB, < 64KiB, >= 64KiB).
 278  * See comments in the code for more information.
 279  *
 280  *  \see surf_host_model_init_SMPI()
 281  */
 282 XBT_PUBLIC(void) surf_network_model_init_SMPI();
 283
 284 /** \ingroup SURF_models
 285  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
 286  *
 287  * This model impelments a variant of the contention model on Infinband networks based on
 288  * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
 289  *
 290  *  \see surf_host_model_init_IB()
 291  */
 292 XBT_PUBLIC(void) surf_network_model_init_IB();
 293
 294 /** \ingroup SURF_models
 295  *  \brief Initializes the platform with the network model 'LegrandVelho'
 296  *
 297  * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for
 298  * onelink and dogbone sharing scenarios. See comments in the code for more information.
 299  *
 300  *  \see surf_host_model_init_LegrandVelho()
 301  */
 302 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho();
 303
 304 /** \ingroup SURF_models
 305  *  \brief Initializes the platform with the network model 'Constant'
 306  *
 307  *  In this model, the communication time between two network cards is constant, hence no need for a routing table.
 308  *  This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This
 309  *  function is called in conjunction with surf_host_model_init_compound.
 310  *
 311  *  \see surf_host_model_init_compound()
 312  */
 313 XBT_PUBLIC(void) surf_network_model_init_Constant();
 314
 315 /** \ingroup SURF_models
 316  *  \brief Initializes the platform with the network model CM02
 317  *
 318  *  You sould call this function by yourself only if you plan using surf_host_model_init_compound.
 319  *  See comments in the code for more information.
 320  */
 321 XBT_PUBLIC(void) surf_network_model_init_CM02();
 322
 323 /** \ingroup SURF_models
 324  *  \brief Initializes the platform with the network model NS3
 325  *
 326  *  This function is called by surf_host_model_init_NS3 or by yourself only if you plan using
 327  *  surf_host_model_init_compound
 328  *
 329  *  \see surf_host_model_init_NS3()
 330  */
 331 XBT_PUBLIC(void) surf_network_model_init_NS3();
 332
 333 /** \ingroup SURF_models
 334  *  \brief Initializes the platform with the network model Reno
 335  *
 336  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 337  *
 338  *  Reference:
 339  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 340  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 341  *
 342  *  Call this function only if you plan using surf_host_model_init_compound.
 343  */
 344 XBT_PUBLIC(void) surf_network_model_init_Reno();
 345
 346 /** \ingroup SURF_models
 347  *  \brief Initializes the platform with the network model Reno2
 348  *
 349  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 350  *
 351  *  Reference:
 352  *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
 353  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 354  *
 355  *  Call this function only if you plan using surf_host_model_init_compound.
 356  */
 357 XBT_PUBLIC(void) surf_network_model_init_Reno2();
 358
 359 /** \ingroup SURF_models
 360  *  \brief Initializes the platform with the network model Vegas
 361  *
 362  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent  to the proportional fairness.
 363  *
 364  *  Reference:
 365  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 366  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 367  *
 368  *  Call this function only if you plan using surf_host_model_init_compound.
 369  */
 370 XBT_PUBLIC(void) surf_network_model_init_Vegas();
 371
 372 /** \ingroup SURF_models
 373  *  \brief The list of all available network model models
 374  */
 375 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
 376
 377 /** \ingroup SURF_models
 378  *  \brief The storage model
 379  */
 380 XBT_PUBLIC(void) surf_storage_model_init_default();
 381
 382 /** \ingroup SURF_models
 383  *  \brief The list of all available storage modes.
 384  *  This storage mode can be set using --cfg=storage/model:...
 385  */
 386 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
 387
 388 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
 389
 390 /** \ingroup SURF_models
 391  *  \brief The host model
 392  *
 393  *  Note that when you create an API on top of SURF, the host model should be the only one you use
 394  *  because depending on the platform model, the network model and the CPU model may not exist.
 395  */
 396 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
 397
 398 /** \ingroup SURF_models
 399  *  \brief Initializes the platform with a compound host model
 400  *
 401  *  This function should be called after a cpu_model and a network_model have been set up.
 402  */
 403 XBT_PUBLIC(void) surf_host_model_init_compound();
 404
 405 /** \ingroup SURF_models
 406  *  \brief Initializes the platform with the current best network and cpu models at hand
 407  *
 408  *  This platform model separates the host model and the network model.
 409  *  The host model will be initialized with the model compound, the network model with the model LV08 (with cross
 410  *  traffic support) and the CPU model with the model Cas01.
 411  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
 412  */
 413 XBT_PUBLIC(void) surf_host_model_init_current_default();
 414
 415 /** \ingroup SURF_models
 416  *  \brief Initializes the platform with the model L07
 417  *
 418  *  With this model, only parallel tasks can be used. Resource sharing is done by identifying bottlenecks and giving an
 419  *  equal share of the model to each action.
 420  */
 421 XBT_PUBLIC(void) surf_host_model_init_ptask_L07();
 422
 423 /** \ingroup SURF_models
 424  *  \brief The list of all available host model models
 425  */
 426 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_host_model_description[];
 427
 428 /** \ingroup SURF_models
 429  *  \brief Initializes the platform with the current best network and cpu models at hand
 430  *
 431  *  This platform model seperates the host model and the network model.
 432  *  The host model will be initialized with the model compound, the network model with the model LV08 (with cross
 433  *  traffic support) and the CPU model with the model Cas01.
 434  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
 435  */
 436 XBT_PUBLIC(void) surf_vm_model_init_HL13();
 437
 438 /** \ingroup SURF_simulation
 439  *  \brief List of hosts for which one want to be notified if they ever restart.
 440  */
 441 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
 442
 443 /*** SURF Globals **************************/
 444
 445 /** \ingroup SURF_simulation
 446  *  \brief Initialize SURF
 447  *  \param argc argument number
 448  *  \param argv arguments
 449  *
 450  *  This function has to be called to initialize the common structures. Then you will have to create the environment by
 451  *  calling  e.g. surf_host_model_init_CM02()
 452  *
 453  *  \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
 454  */
 455 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
 456
 457 /** \ingroup SURF_simulation
 458  *  \brief Finish simulation initialization
 459  *
 460  *  This function must be called before the first call to surf_solve()
 461  */
 462 XBT_PUBLIC(void) surf_presolve();
 463
 464 /** \ingroup SURF_simulation
 465  *  \brief Performs a part of the simulation
 466  *  \param max_date Maximum date to update the simulation to, or -1
 467  *  \return the elapsed time, or -1.0 if no event could be executed
 468  *
 469  *  This function execute all possible events, update the action states  and returns the time elapsed.
 470  *  When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
 471  *  when you call surf_solve.
 472  *  Note that the returned elapsed time can be zero.
 473  */
 474 XBT_PUBLIC(double) surf_solve(double max_date);
 475
 476 /** \ingroup SURF_simulation
 477  *  \brief Return the current time
 478  *
 479  *  Return the current time in millisecond.
 480  */
 481 XBT_PUBLIC(double) surf_get_clock();
 482
 483 /** \ingroup SURF_simulation
 484  *  \brief Exit SURF
 485  *
 486  *  Clean everything.
 487  *
 488  *  \see surf_init()
 489  */
 490 XBT_PUBLIC(void) surf_exit();
 491
 492 /* Prototypes of the functions that handle the properties */
 493 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;// the prop set for the currently parsed element (also used in SIMIX)
 494
 495 /* surf parse file related (public because called from a test suite) */
 496 XBT_PUBLIC(void) parse_platform_file(const char *file);
 497
 498 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
 499 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
 500
 501 /*
 502  * Returns the initial path. On Windows the initial path is the current directory for the current process in the other
 503  * case the function returns "./" that represents the current directory on Unix/Linux platforms.
 504  */
 505 const char *__surf_get_initial_path();
 506
 507 /********** Tracing **********/
 508 /* from surf_instr.c */
 509 void TRACE_surf_action(surf_action_t surf_action, const char *category);
 510 void TRACE_surf_alloc();
 511 void TRACE_surf_release();
 512
 513 /* instr_routing.c */
 514 void instr_routing_define_callbacks ();
 515 void instr_new_variable_type (const char *new_typename, const char *color);
 516 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color);
 517 void instr_new_user_state_type (const char *father_type, const char *new_typename);
 518 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
 519 int instr_platform_traced ();
 520 xbt_graph_t instr_routing_platform_graph ();
 521 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
 522
 523 SG_END_DECL()
 524
 525 #endif