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