Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
force gnu_source here.
[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 "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 The network model
140  *
141  *  When creating a new API on top on SURF, you shouldn't use the network model unless you know what you are doing.
142  *  Only the host model should be accessed because depending on the platform model, the network model can be NULL.
143  */
144 XBT_PUBLIC_DATA surf_network_model_t surf_network_model;
145
146 /** \ingroup SURF_models
147  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
148  *
149  * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud based on the model 'LV08' and
150  * different correction factors depending on the communication size (< 1KiB, < 64KiB, >= 64KiB).
151  * See comments in the code for more information.
152  *
153  *  \see surf_host_model_init_SMPI()
154  */
155 XBT_PUBLIC void surf_network_model_init_SMPI();
156
157 /** \ingroup SURF_models
158  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
159  *
160  * This model impelments a variant of the contention model on Infinband networks based on
161  * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
162  *
163  *  \see surf_host_model_init_IB()
164  */
165 XBT_PUBLIC void surf_network_model_init_IB();
166
167 /** \ingroup SURF_models
168  *  \brief Initializes the platform with the network model 'LegrandVelho'
169  *
170  * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for
171  * onelink and dogbone sharing scenarios. See comments in the code for more information.
172  *
173  *  \see surf_host_model_init_LegrandVelho()
174  */
175 XBT_PUBLIC void surf_network_model_init_LegrandVelho();
176
177 /** \ingroup SURF_models
178  *  \brief Initializes the platform with the network model 'Constant'
179  *
180  *  In this model, the communication time between two network cards is constant, hence no need for a routing table.
181  *  This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This
182  *  function is called in conjunction with surf_host_model_init_compound.
183  *
184  *  \see surf_host_model_init_compound()
185  */
186 XBT_PUBLIC void surf_network_model_init_Constant();
187
188 /** \ingroup SURF_models
189  *  \brief Initializes the platform with the network model CM02
190  *
191  *  You sould call this function by yourself only if you plan using surf_host_model_init_compound.
192  *  See comments in the code for more information.
193  */
194 XBT_PUBLIC void surf_network_model_init_CM02();
195
196 /** \ingroup SURF_models
197  *  \brief Initializes the platform with the network model NS3
198  *
199  *  This function is called by surf_host_model_init_NS3 or by yourself only if you plan using
200  *  surf_host_model_init_compound
201  *
202  *  \see surf_host_model_init_NS3()
203  */
204 XBT_PUBLIC void surf_network_model_init_NS3();
205
206 /** \ingroup SURF_models
207  *  \brief Initializes the platform with the network model Reno
208  *
209  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
210  *
211  *  Reference:
212  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
213  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
214  *
215  *  Call this function only if you plan using surf_host_model_init_compound.
216  */
217 XBT_PUBLIC void surf_network_model_init_Reno();
218
219 /** \ingroup SURF_models
220  *  \brief Initializes the platform with the network model Reno2
221  *
222  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
223  *
224  *  Reference:
225  *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
226  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
227  *
228  *  Call this function only if you plan using surf_host_model_init_compound.
229  */
230 XBT_PUBLIC void surf_network_model_init_Reno2();
231
232 /** \ingroup SURF_models
233  *  \brief Initializes the platform with the network model Vegas
234  *
235  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent  to the proportional fairness.
236  *
237  *  Reference:
238  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
239  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
240  *
241  *  Call this function only if you plan using surf_host_model_init_compound.
242  */
243 XBT_PUBLIC void surf_network_model_init_Vegas();
244
245 /** \ingroup SURF_models
246  *  \brief The list of all available network model models
247  */
248 XBT_PUBLIC_DATA s_surf_model_description_t surf_network_model_description[];
249
250 /** \ingroup SURF_models
251  *  \brief The storage model
252  */
253 XBT_PUBLIC void surf_storage_model_init_default();
254
255 /** \ingroup SURF_models
256  *  \brief The list of all available storage modes.
257  *  This storage mode can be set using --cfg=storage/model:...
258  */
259 XBT_PUBLIC_DATA s_surf_model_description_t surf_storage_model_description[];
260
261 XBT_PUBLIC_DATA surf_storage_model_t surf_storage_model;
262
263 /** \ingroup SURF_models
264  *  \brief The host model
265  *
266  *  Note that when you create an API on top of SURF, the host model should be the only one you use
267  *  because depending on the platform model, the network model and the CPU model may not exist.
268  */
269 XBT_PUBLIC_DATA surf_host_model_t surf_host_model;
270
271 /** \ingroup SURF_models
272  *  \brief Initializes the platform with a compound host model
273  *
274  *  This function should be called after a cpu_model and a network_model have been set up.
275  */
276 XBT_PUBLIC void surf_host_model_init_compound();
277
278 /** \ingroup SURF_models
279  *  \brief Initializes the platform with the current best network and cpu models at hand
280  *
281  *  This platform model separates the host model and the network model.
282  *  The host model will be initialized with the model compound, the network model with the model LV08 (with cross
283  *  traffic support) and the CPU model with the model Cas01.
284  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
285  */
286 XBT_PUBLIC void surf_host_model_init_current_default();
287
288 /** \ingroup SURF_models
289  *  \brief Initializes the platform with the model L07
290  *
291  *  With this model, only parallel tasks can be used. Resource sharing is done by identifying bottlenecks and giving an
292  *  equal share of the model to each action.
293  */
294 XBT_PUBLIC void surf_host_model_init_ptask_L07();
295
296 /** \ingroup SURF_models
297  *  \brief The list of all available host model models
298  */
299 XBT_PUBLIC_DATA s_surf_model_description_t surf_host_model_description[];
300
301 /** \ingroup SURF_models
302  *  \brief Initializes the platform with the current best network and cpu models at hand
303  *
304  *  This platform model seperates the host model and the network model.
305  *  The host model will be initialized with the model compound, the network model with the model LV08 (with cross
306  *  traffic support) and the CPU model with the model Cas01.
307  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
308  */
309 XBT_PUBLIC void surf_vm_model_init_HL13();
310
311 /*** SURF Globals **************************/
312
313 /** \ingroup SURF_simulation
314  *  \brief Initialize SURF
315  *  \param argc argument number
316  *  \param argv arguments
317  *
318  *  This function has to be called to initialize the common structures. Then you will have to create the environment by
319  *  calling  e.g. surf_host_model_init_CM02()
320  *
321  *  \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
322  */
323 XBT_PUBLIC void surf_init(int* argc, char** argv); /* initialize common structures */
324
325 /** \ingroup SURF_simulation
326  *  \brief Finish simulation initialization
327  *
328  *  This function must be called before the first call to surf_solve()
329  */
330 XBT_PUBLIC void surf_presolve();
331
332 /** \ingroup SURF_simulation
333  *  \brief Performs a part of the simulation
334  *  \param max_date Maximum date to update the simulation to, or -1
335  *  \return the elapsed time, or -1.0 if no event could be executed
336  *
337  *  This function execute all possible events, update the action states  and returns the time elapsed.
338  *  When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
339  *  when you call surf_solve.
340  *  Note that the returned elapsed time can be zero.
341  */
342 XBT_PUBLIC double surf_solve(double max_date);
343
344 /** \ingroup SURF_simulation
345  *  \brief Return the current time
346  *
347  *  Return the current time in millisecond.
348  */
349 XBT_PUBLIC double surf_get_clock();
350
351 /** \ingroup SURF_simulation
352  *  \brief Exit SURF
353  *
354  *  Clean everything.
355  *
356  *  \see surf_init()
357  */
358 XBT_PUBLIC void surf_exit();
359
360 /* surf parse file related (public because called from a test suite) */
361 XBT_PUBLIC void parse_platform_file(const char* file);
362
363 /********** Tracing **********/
364
365 /* instr_routing.c */
366 void instr_routing_define_callbacks();
367 xbt_graph_t instr_routing_platform_graph();
368 void instr_routing_platform_graph_export_graphviz(xbt_graph_t g, const char* filename);
369
370 #endif