Logo AND Algorithmique Numérique Distribuée

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