Logo AND Algorithmique Numérique Distribuée

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