1 /* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved. */
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. */
9 #include "simgrid/forward.h"
10 #include "xbt/graph.h"
12 /** \brief Resource model description
14 struct surf_model_description {
16 const char* description;
17 void_f_void_t model_init_preparse;
19 typedef struct surf_model_description s_surf_model_description_t;
21 XBT_PUBLIC int find_model_description(s_surf_model_description_t* table, std::string name);
22 XBT_PUBLIC void model_help(const char* category, s_surf_model_description_t* table);
24 /***************************/
25 /* Generic model object */
26 /***************************/
28 /** @{ @ingroup SURF_c_bindings */
31 * @brief Pop an action from the done actions set
33 * @param model The model from which the action is extracted
34 * @return An action in done state
36 XBT_PUBLIC simgrid::kernel::resource::Action*
37 surf_model_extract_done_action_set(simgrid::kernel::resource::Model* model);
40 * @brief Pop an action from the failed actions set
42 * @param model The model from which the action is extracted
43 * @return An action in failed state
45 XBT_PUBLIC simgrid::kernel::resource::Action*
46 surf_model_extract_failed_action_set(simgrid::kernel::resource::Model* model);
49 * @brief Get the size of the running action set of a model
51 * @param model The model
52 * @return The size of the running action set
54 XBT_PUBLIC int surf_model_running_action_set_size(simgrid::kernel::resource::Model* model);
57 * @brief [brief description]
58 * @details [long description]
60 * @param action The surf cpu action
61 * @param bound [description]
63 XBT_PUBLIC void surf_cpu_action_set_bound(simgrid::kernel::resource::Action* action, double bound);
67 /**************************************/
68 /* Implementations of model object */
69 /**************************************/
71 /** \ingroup SURF_models
72 * \brief The CPU model object for the physical machine layer
74 XBT_PUBLIC_DATA simgrid::surf::CpuModel* surf_cpu_model_pm;
76 /** \ingroup SURF_models
77 * \brief The CPU model object for the virtual machine layer
79 XBT_PUBLIC_DATA simgrid::surf::CpuModel* surf_cpu_model_vm;
81 /** \ingroup SURF_models
82 * \brief Initializes the CPU model with the model Cas01
84 * By default, this model uses the lazy optimization mechanism that relies on partial invalidation in LMM and a heap
85 * for lazy action update.
86 * You can change this behavior by setting the cpu/optim configuration variable to a different value.
88 * You shouldn't have to call it by yourself.
90 XBT_PUBLIC void surf_cpu_model_init_Cas01();
92 /** \ingroup SURF_models
93 * \brief Initializes the CPU model with trace integration [Deprecated]
95 * You shouldn't have to call it by yourself.
97 XBT_PUBLIC void surf_cpu_model_init_ti();
99 /** \ingroup SURF_models
100 * \brief The list of all available optimization modes (both for cpu and networks).
101 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
103 XBT_PUBLIC_DATA s_surf_model_description_t surf_optimization_mode_description[];
105 /** \ingroup SURF_plugins
106 * \brief The list of all available surf plugins
108 XBT_PUBLIC_DATA s_surf_model_description_t surf_plugin_description[];
110 /** \ingroup SURF_models
111 * \brief The list of all available cpu model models
113 XBT_PUBLIC_DATA s_surf_model_description_t surf_cpu_model_description[];
115 /** \ingroup SURF_models
116 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
118 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud based on the model 'LV08' and
119 * different correction factors depending on the communication size (< 1KiB, < 64KiB, >= 64KiB).
120 * See comments in the code for more information.
122 * \see surf_host_model_init_SMPI()
124 XBT_PUBLIC void surf_network_model_init_SMPI();
126 /** \ingroup SURF_models
127 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
129 * This model impelments a variant of the contention model on Infinband networks based on
130 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
132 * \see surf_host_model_init_IB()
134 XBT_PUBLIC void surf_network_model_init_IB();
136 /** \ingroup SURF_models
137 * \brief Initializes the platform with the network model 'LegrandVelho'
139 * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for
140 * onelink and dogbone sharing scenarios. See comments in the code for more information.
142 * \see surf_host_model_init_LegrandVelho()
144 XBT_PUBLIC void surf_network_model_init_LegrandVelho();
146 /** \ingroup SURF_models
147 * \brief Initializes the platform with the network model 'Constant'
149 * In this model, the communication time between two network cards is constant, hence no need for a routing table.
150 * This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This
151 * function is called in conjunction with surf_host_model_init_compound.
153 * \see surf_host_model_init_compound()
155 XBT_PUBLIC void surf_network_model_init_Constant();
157 /** \ingroup SURF_models
158 * \brief Initializes the platform with the network model CM02
160 * You sould call this function by yourself only if you plan using surf_host_model_init_compound.
161 * See comments in the code for more information.
163 XBT_PUBLIC void surf_network_model_init_CM02();
165 /** \ingroup SURF_models
166 * \brief Initializes the platform with the network model NS3
168 * This function is called by surf_host_model_init_NS3 or by yourself only if you plan using
169 * surf_host_model_init_compound
171 * \see surf_host_model_init_NS3()
173 XBT_PUBLIC void surf_network_model_init_NS3();
175 /** \ingroup SURF_models
176 * \brief Initializes the platform with the network model Reno
178 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
181 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
182 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
184 * Call this function only if you plan using surf_host_model_init_compound.
186 XBT_PUBLIC void surf_network_model_init_Reno();
188 /** \ingroup SURF_models
189 * \brief Initializes the platform with the network model Reno2
191 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
194 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
195 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
197 * Call this function only if you plan using surf_host_model_init_compound.
199 XBT_PUBLIC void surf_network_model_init_Reno2();
201 /** \ingroup SURF_models
202 * \brief Initializes the platform with the network model Vegas
204 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent to the proportional fairness.
207 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
208 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
210 * Call this function only if you plan using surf_host_model_init_compound.
212 XBT_PUBLIC void surf_network_model_init_Vegas();
214 /** \ingroup SURF_models
215 * \brief The list of all available network model models
217 XBT_PUBLIC_DATA s_surf_model_description_t surf_network_model_description[];
219 /** \ingroup SURF_models
220 * \brief The storage model
222 XBT_PUBLIC void surf_storage_model_init_default();
224 /** \ingroup SURF_models
225 * \brief The list of all available storage modes.
226 * This storage mode can be set using --cfg=storage/model:...
228 XBT_PUBLIC_DATA s_surf_model_description_t surf_storage_model_description[];
230 XBT_PUBLIC_DATA simgrid::surf::StorageModel* surf_storage_model;
232 /** \ingroup SURF_models
233 * \brief The host model
235 * Note that when you create an API on top of SURF, the host model should be the only one you use
236 * because depending on the platform model, the network model and the CPU model may not exist.
238 XBT_PUBLIC_DATA simgrid::surf::HostModel* surf_host_model;
240 /** \ingroup SURF_models
241 * \brief Initializes the platform with a compound host model
243 * This function should be called after a cpu_model and a network_model have been set up.
245 XBT_PUBLIC void surf_host_model_init_compound();
247 /** \ingroup SURF_models
248 * \brief Initializes the platform with the current best network and cpu models at hand
250 * This platform model separates the host model and the network model.
251 * The host model will be initialized with the model compound, the network model with the model LV08 (with cross
252 * traffic support) and the CPU model with the model Cas01.
253 * Such model is subject to modification with warning in the ChangeLog so monitor it!
255 XBT_PUBLIC void surf_host_model_init_current_default();
257 /** \ingroup SURF_models
258 * \brief Initializes the platform with the model L07
260 * With this model, only parallel tasks can be used. Resource sharing is done by identifying bottlenecks and giving an
261 * equal share of the model to each action.
263 XBT_PUBLIC void surf_host_model_init_ptask_L07();
265 /** \ingroup SURF_models
266 * \brief The list of all available host model models
268 XBT_PUBLIC_DATA s_surf_model_description_t surf_host_model_description[];
270 /** \ingroup SURF_models
271 * \brief Initializes the platform with the current best network and cpu models at hand
273 * This platform model seperates the host model and the network model.
274 * The host model will be initialized with the model compound, the network model with the model LV08 (with cross
275 * traffic support) and the CPU model with the model Cas01.
276 * Such model is subject to modification with warning in the ChangeLog so monitor it!
278 XBT_PUBLIC void surf_vm_model_init_HL13();
280 /*** SURF Globals **************************/
282 /** \ingroup SURF_simulation
283 * \brief Initialize SURF
284 * \param argc argument number
285 * \param argv arguments
287 * This function has to be called to initialize the common structures. Then you will have to create the environment by
288 * calling e.g. surf_host_model_init_CM02()
290 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
292 XBT_PUBLIC void surf_init(int* argc, char** argv); /* initialize common structures */
294 /** \ingroup SURF_simulation
295 * \brief Finish simulation initialization
297 * This function must be called before the first call to surf_solve()
299 XBT_PUBLIC void surf_presolve();
301 /** \ingroup SURF_simulation
302 * \brief Performs a part of the simulation
303 * \param max_date Maximum date to update the simulation to, or -1
304 * \return the elapsed time, or -1.0 if no event could be executed
306 * This function execute all possible events, update the action states and returns the time elapsed.
307 * When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
308 * when you call surf_solve.
309 * Note that the returned elapsed time can be zero.
311 XBT_PUBLIC double surf_solve(double max_date);
313 /** \ingroup SURF_simulation
314 * \brief Return the current time
316 * Return the current time in millisecond.
318 XBT_PUBLIC double surf_get_clock();
320 /** \ingroup SURF_simulation
327 XBT_PUBLIC void surf_exit();
329 /* surf parse file related (public because called from a test suite) */
330 XBT_PUBLIC void parse_platform_file(const char* file);
332 /********** Tracing **********/
334 /* instr_routing.c */
335 xbt_graph_t instr_routing_platform_graph();
336 void instr_routing_platform_graph_export_graphviz(xbt_graph_t g, const char* filename);