Logo AND Algorithmique Numérique Distribuée

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