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