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