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