src/include/surf/surf.hpp

   1 /* Copyright (c) 2004-2018. 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 "simgrid/forward.h"
  10 #include "xbt/graph.h"
  11
  12 namespace simgrid {
  13 namespace surf {
  14 class CpuModel;
  15 class HostModel;
  16 class NetworkModel;
  17 class StorageModel;
  18 class NetworkCm02Link;
  19 }
  20 }
  21
  22 /** @ingroup SURF_c_bindings
  23  *  \brief Model datatype
  24  *
  25  *  Generic data structure for a model. The hosts,
  26  *  the CPUs and the network links are examples of models.
  27  */
  28 typedef simgrid::surf::CpuModel* surf_cpu_model_t;
  29 typedef simgrid::surf::HostModel* surf_host_model_t;
  30 typedef simgrid::surf::NetworkModel* surf_network_model_t;
  31 typedef simgrid::surf::StorageModel* surf_storage_model_t;
  32
  33 /* Actions and models are highly connected structures... */
  34
  35 /** \brief Resource model description
  36  */
  37 struct surf_model_description {
  38   const char* name;
  39   const char* description;
  40   void_f_void_t model_init_preparse;
  41 };
  42 typedef struct surf_model_description s_surf_model_description_t;
  43
  44 XBT_PUBLIC int find_model_description(s_surf_model_description_t* table, std::string name);
  45 XBT_PUBLIC void model_help(const char* category, s_surf_model_description_t* table);
  46
  47 /***************************/
  48 /* Generic model object */
  49 /***************************/
  50
  51 /** @{ @ingroup SURF_c_bindings */
  52
  53 /**
  54  * @brief Pop an action from the done actions set
  55  *
  56  * @param model The model from which the action is extracted
  57  * @return An action in done state
  58  */
  59 XBT_PUBLIC simgrid::kernel::resource::Action*
  60 surf_model_extract_done_action_set(simgrid::kernel::resource::Model* model);
  61
  62 /**
  63  * @brief Pop an action from the failed actions set
  64  *
  65  * @param model The model from which the action is extracted
  66  * @return An action in failed state
  67  */
  68 XBT_PUBLIC simgrid::kernel::resource::Action*
  69 surf_model_extract_failed_action_set(simgrid::kernel::resource::Model* model);
  70
  71 /**
  72  * @brief Get the size of the running action set of a model
  73  *
  74  * @param model The model
  75  * @return The size of the running action set
  76  */
  77 XBT_PUBLIC int surf_model_running_action_set_size(simgrid::kernel::resource::Model* model);
  78
  79 /**
  80  * @brief [brief description]
  81  * @details [long description]
  82  *
  83  * @param action The surf cpu action
  84  * @param bound [description]
  85  */
  86 XBT_PUBLIC void surf_cpu_action_set_bound(simgrid::kernel::resource::Action* action, double bound);
  87
  88 /** @} */
  89
  90 /**************************************/
  91 /* Implementations of model object */
  92 /**************************************/
  93
  94 /** \ingroup SURF_models
  95  *  \brief The CPU model object for the physical machine layer
  96  */
  97 XBT_PUBLIC_DATA surf_cpu_model_t surf_cpu_model_pm;
  98
  99 /** \ingroup SURF_models
 100  *  \brief The CPU model object for the virtual machine layer
 101  */
 102 XBT_PUBLIC_DATA surf_cpu_model_t surf_cpu_model_vm;
 103
 104 /** \ingroup SURF_models
 105  *  \brief Initializes the CPU model with the model Cas01
 106  *
 107  *  By default, this model uses the lazy optimization mechanism that relies on partial invalidation in LMM and a heap
 108  *  for lazy action update.
 109  *  You can change this behavior by setting the cpu/optim configuration variable to a different value.
 110  *
 111  *  You shouldn't have to call it by yourself.
 112  */
 113 XBT_PUBLIC void surf_cpu_model_init_Cas01();
 114
 115 /** \ingroup SURF_models
 116  *  \brief Initializes the CPU model with trace integration [Deprecated]
 117  *
 118  *  You shouldn't have to call it by yourself.
 119  */
 120 XBT_PUBLIC void surf_cpu_model_init_ti();
 121
 122 /** \ingroup SURF_models
 123  *  \brief The list of all available optimization modes (both for cpu and networks).
 124  *  These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
 125  */
 126 XBT_PUBLIC_DATA s_surf_model_description_t surf_optimization_mode_description[];
 127
 128 /** \ingroup SURF_plugins
 129  *  \brief The list of all available surf plugins
 130  */
 131 XBT_PUBLIC_DATA s_surf_model_description_t surf_plugin_description[];
 132
 133 /** \ingroup SURF_models
 134  *  \brief The list of all available cpu model models
 135  */
 136 XBT_PUBLIC_DATA s_surf_model_description_t surf_cpu_model_description[];
 137
 138 /** \ingroup SURF_models
 139  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
 140  *
 141  * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud based on the model 'LV08' and
 142  * different correction factors depending on the communication size (< 1KiB, < 64KiB, >= 64KiB).
 143  * See comments in the code for more information.
 144  *
 145  *  \see surf_host_model_init_SMPI()
 146  */
 147 XBT_PUBLIC void surf_network_model_init_SMPI();
 148
 149 /** \ingroup SURF_models
 150  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
 151  *
 152  * This model impelments a variant of the contention model on Infinband networks based on
 153  * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
 154  *
 155  *  \see surf_host_model_init_IB()
 156  */
 157 XBT_PUBLIC void surf_network_model_init_IB();
 158
 159 /** \ingroup SURF_models
 160  *  \brief Initializes the platform with the network model 'LegrandVelho'
 161  *
 162  * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for
 163  * onelink and dogbone sharing scenarios. See comments in the code for more information.
 164  *
 165  *  \see surf_host_model_init_LegrandVelho()
 166  */
 167 XBT_PUBLIC void surf_network_model_init_LegrandVelho();
 168
 169 /** \ingroup SURF_models
 170  *  \brief Initializes the platform with the network model 'Constant'
 171  *
 172  *  In this model, the communication time between two network cards is constant, hence no need for a routing table.
 173  *  This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This
 174  *  function is called in conjunction with surf_host_model_init_compound.
 175  *
 176  *  \see surf_host_model_init_compound()
 177  */
 178 XBT_PUBLIC void surf_network_model_init_Constant();
 179
 180 /** \ingroup SURF_models
 181  *  \brief Initializes the platform with the network model CM02
 182  *
 183  *  You sould call this function by yourself only if you plan using surf_host_model_init_compound.
 184  *  See comments in the code for more information.
 185  */
 186 XBT_PUBLIC void surf_network_model_init_CM02();
 187
 188 /** \ingroup SURF_models
 189  *  \brief Initializes the platform with the network model NS3
 190  *
 191  *  This function is called by surf_host_model_init_NS3 or by yourself only if you plan using
 192  *  surf_host_model_init_compound
 193  *
 194  *  \see surf_host_model_init_NS3()
 195  */
 196 XBT_PUBLIC void surf_network_model_init_NS3();
 197
 198 /** \ingroup SURF_models
 199  *  \brief Initializes the platform with the network model Reno
 200  *
 201  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 202  *
 203  *  Reference:
 204  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 205  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 206  *
 207  *  Call this function only if you plan using surf_host_model_init_compound.
 208  */
 209 XBT_PUBLIC void surf_network_model_init_Reno();
 210
 211 /** \ingroup SURF_models
 212  *  \brief Initializes the platform with the network model Reno2
 213  *
 214  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
 215  *
 216  *  Reference:
 217  *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
 218  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 219  *
 220  *  Call this function only if you plan using surf_host_model_init_compound.
 221  */
 222 XBT_PUBLIC void surf_network_model_init_Reno2();
 223
 224 /** \ingroup SURF_models
 225  *  \brief Initializes the platform with the network model Vegas
 226  *
 227  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent  to the proportional fairness.
 228  *
 229  *  Reference:
 230  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
 231  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
 232  *
 233  *  Call this function only if you plan using surf_host_model_init_compound.
 234  */
 235 XBT_PUBLIC void surf_network_model_init_Vegas();
 236
 237 /** \ingroup SURF_models
 238  *  \brief The list of all available network model models
 239  */
 240 XBT_PUBLIC_DATA s_surf_model_description_t surf_network_model_description[];
 241
 242 /** \ingroup SURF_models
 243  *  \brief The storage model
 244  */
 245 XBT_PUBLIC void surf_storage_model_init_default();
 246
 247 /** \ingroup SURF_models
 248  *  \brief The list of all available storage modes.
 249  *  This storage mode can be set using --cfg=storage/model:...
 250  */
 251 XBT_PUBLIC_DATA s_surf_model_description_t surf_storage_model_description[];
 252
 253 XBT_PUBLIC_DATA surf_storage_model_t surf_storage_model;
 254
 255 /** \ingroup SURF_models
 256  *  \brief The host model
 257  *
 258  *  Note that when you create an API on top of SURF, the host model should be the only one you use
 259  *  because depending on the platform model, the network model and the CPU model may not exist.
 260  */
 261 XBT_PUBLIC_DATA surf_host_model_t surf_host_model;
 262
 263 /** \ingroup SURF_models
 264  *  \brief Initializes the platform with a compound host model
 265  *
 266  *  This function should be called after a cpu_model and a network_model have been set up.
 267  */
 268 XBT_PUBLIC void surf_host_model_init_compound();
 269
 270 /** \ingroup SURF_models
 271  *  \brief Initializes the platform with the current best network and cpu models at hand
 272  *
 273  *  This platform model separates the host model and the network model.
 274  *  The host model will be initialized with the model compound, the network model with the model LV08 (with cross
 275  *  traffic support) and the CPU model with the model Cas01.
 276  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
 277  */
 278 XBT_PUBLIC void surf_host_model_init_current_default();
 279
 280 /** \ingroup SURF_models
 281  *  \brief Initializes the platform with the model L07
 282  *
 283  *  With this model, only parallel tasks can be used. Resource sharing is done by identifying bottlenecks and giving an
 284  *  equal share of the model to each action.
 285  */
 286 XBT_PUBLIC void surf_host_model_init_ptask_L07();
 287
 288 /** \ingroup SURF_models
 289  *  \brief The list of all available host model models
 290  */
 291 XBT_PUBLIC_DATA s_surf_model_description_t surf_host_model_description[];
 292
 293 /** \ingroup SURF_models
 294  *  \brief Initializes the platform with the current best network and cpu models at hand
 295  *
 296  *  This platform model seperates the host model and the network model.
 297  *  The host model will be initialized with the model compound, the network model with the model LV08 (with cross
 298  *  traffic support) and the CPU model with the model Cas01.
 299  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
 300  */
 301 XBT_PUBLIC void surf_vm_model_init_HL13();
 302
 303 /*** SURF Globals **************************/
 304
 305 /** \ingroup SURF_simulation
 306  *  \brief Initialize SURF
 307  *  \param argc argument number
 308  *  \param argv arguments
 309  *
 310  *  This function has to be called to initialize the common structures. Then you will have to create the environment by
 311  *  calling  e.g. surf_host_model_init_CM02()
 312  *
 313  *  \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
 314  */
 315 XBT_PUBLIC void surf_init(int* argc, char** argv); /* initialize common structures */
 316
 317 /** \ingroup SURF_simulation
 318  *  \brief Finish simulation initialization
 319  *
 320  *  This function must be called before the first call to surf_solve()
 321  */
 322 XBT_PUBLIC void surf_presolve();
 323
 324 /** \ingroup SURF_simulation
 325  *  \brief Performs a part of the simulation
 326  *  \param max_date Maximum date to update the simulation to, or -1
 327  *  \return the elapsed time, or -1.0 if no event could be executed
 328  *
 329  *  This function execute all possible events, update the action states  and returns the time elapsed.
 330  *  When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
 331  *  when you call surf_solve.
 332  *  Note that the returned elapsed time can be zero.
 333  */
 334 XBT_PUBLIC double surf_solve(double max_date);
 335
 336 /** \ingroup SURF_simulation
 337  *  \brief Return the current time
 338  *
 339  *  Return the current time in millisecond.
 340  */
 341 XBT_PUBLIC double surf_get_clock();
 342
 343 /** \ingroup SURF_simulation
 344  *  \brief Exit SURF
 345  *
 346  *  Clean everything.
 347  *
 348  *  \see surf_init()
 349  */
 350 XBT_PUBLIC void surf_exit();
 351
 352 /* surf parse file related (public because called from a test suite) */
 353 XBT_PUBLIC void parse_platform_file(const char* file);
 354
 355 /********** Tracing **********/
 356
 357 /* instr_routing.c */
 358 void instr_routing_define_callbacks();
 359 xbt_graph_t instr_routing_platform_graph();
 360 void instr_routing_platform_graph_export_graphviz(xbt_graph_t g, const char* filename);
 361
 362 #endif