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 "src/internal_config.h"
11 #include "xbt/config.h"
13 #include "xbt/dynar.h"
14 #include "xbt/graph.h"
18 #error This is a C++ only file, now
28 class NetworkCm02Link;
33 /** @ingroup SURF_c_bindings
34 * \brief Model datatype
36 * Generic data structure for a model. The hosts,
37 * the CPUs and the network links are examples of models.
39 typedef simgrid::surf::Model* surf_model_t;
40 typedef simgrid::surf::CpuModel* surf_cpu_model_t;
41 typedef simgrid::surf::HostModel* surf_host_model_t;
42 typedef simgrid::surf::NetworkModel* surf_network_model_t;
43 typedef simgrid::surf::StorageModel* surf_storage_model_t;
44 /** @ingroup SURF_c_bindings
45 * \brief Action structure
47 * Never create s_surf_action_t by yourself ! The actions are created
48 * on the fly when you call execute or communicate on a model.
50 * \see e_surf_action_state_t
52 typedef simgrid::surf::Action* surf_action_t;
55 /* Actions and models are highly connected structures... */
57 /* user-visible parameters */
58 extern XBT_PRIVATE double sg_tcp_gamma;
59 extern XBT_PRIVATE double sg_latency_factor;
60 extern XBT_PRIVATE double sg_bandwidth_factor;
61 extern XBT_PRIVATE double sg_weight_S_parameter;
62 extern XBT_PRIVATE int sg_network_crosstraffic;
64 /** \brief Resource model description
66 struct surf_model_description {
68 const char* description;
69 void_f_void_t model_init_preparse;
71 typedef struct surf_model_description s_surf_model_description_t;
73 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t* table, std::string name);
74 XBT_PUBLIC(void) model_help(const char* category, s_surf_model_description_t* table);
76 /***************************/
77 /* Generic model object */
78 /***************************/
80 /** @{ @ingroup SURF_c_bindings */
83 * @brief Pop an action from the done actions set
85 * @param model The model from which the action is extracted
86 * @return An action in done state
88 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
91 * @brief Pop an action from the failed actions set
93 * @param model The model from which the action is extracted
94 * @return An action in failed state
96 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
99 * @brief Get the size of the running action set of a model
101 * @param model The model
102 * @return The size of the running action set
104 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
107 * @brief [brief description]
108 * @details [long description]
110 * @param action The surf cpu action
111 * @param bound [description]
113 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
117 /**************************************/
118 /* Implementations of model object */
119 /**************************************/
121 /** \ingroup SURF_models
122 * \brief The CPU model object for the physical machine layer
124 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
126 /** \ingroup SURF_models
127 * \brief The CPU model object for the virtual machine layer
129 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
131 /** \ingroup SURF_models
132 * \brief Initializes the CPU model with the model Cas01
134 * By default, this model uses the lazy optimization mechanism that relies on partial invalidation in LMM and a heap
135 * for lazy action update.
136 * You can change this behavior by setting the cpu/optim configuration variable to a different value.
138 * You shouldn't have to call it by yourself.
140 XBT_PUBLIC(void) surf_cpu_model_init_Cas01();
142 /** \ingroup SURF_models
143 * \brief Initializes the CPU model with trace integration [Deprecated]
145 * You shouldn't have to call it by yourself.
147 XBT_PUBLIC(void) surf_cpu_model_init_ti();
149 /** \ingroup SURF_models
150 * \brief The list of all available optimization modes (both for cpu and networks).
151 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
153 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
155 /** \ingroup SURF_plugins
156 * \brief The list of all available surf plugins
158 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
160 /** \ingroup SURF_models
161 * \brief The list of all available cpu model models
163 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
165 /** \ingroup SURF_models
166 * \brief The network model
168 * When creating a new API on top on SURF, you shouldn't use the network model unless you know what you are doing.
169 * Only the host model should be accessed because depending on the platform model, the network model can be NULL.
171 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
173 /** \ingroup SURF_models
174 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
176 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud based on the model 'LV08' and
177 * different correction factors depending on the communication size (< 1KiB, < 64KiB, >= 64KiB).
178 * See comments in the code for more information.
180 * \see surf_host_model_init_SMPI()
182 XBT_PUBLIC(void) surf_network_model_init_SMPI();
184 /** \ingroup SURF_models
185 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
187 * This model impelments a variant of the contention model on Infinband networks based on
188 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
190 * \see surf_host_model_init_IB()
192 XBT_PUBLIC(void) surf_network_model_init_IB();
194 /** \ingroup SURF_models
195 * \brief Initializes the platform with the network model 'LegrandVelho'
197 * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for
198 * onelink and dogbone sharing scenarios. See comments in the code for more information.
200 * \see surf_host_model_init_LegrandVelho()
202 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho();
204 /** \ingroup SURF_models
205 * \brief Initializes the platform with the network model 'Constant'
207 * In this model, the communication time between two network cards is constant, hence no need for a routing table.
208 * This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This
209 * function is called in conjunction with surf_host_model_init_compound.
211 * \see surf_host_model_init_compound()
213 XBT_PUBLIC(void) surf_network_model_init_Constant();
215 /** \ingroup SURF_models
216 * \brief Initializes the platform with the network model CM02
218 * You sould call this function by yourself only if you plan using surf_host_model_init_compound.
219 * See comments in the code for more information.
221 XBT_PUBLIC(void) surf_network_model_init_CM02();
223 /** \ingroup SURF_models
224 * \brief Initializes the platform with the network model NS3
226 * This function is called by surf_host_model_init_NS3 or by yourself only if you plan using
227 * surf_host_model_init_compound
229 * \see surf_host_model_init_NS3()
231 XBT_PUBLIC(void) surf_network_model_init_NS3();
233 /** \ingroup SURF_models
234 * \brief Initializes the platform with the network model Reno
236 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
239 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
240 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
242 * Call this function only if you plan using surf_host_model_init_compound.
244 XBT_PUBLIC(void) surf_network_model_init_Reno();
246 /** \ingroup SURF_models
247 * \brief Initializes the platform with the network model Reno2
249 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
252 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
253 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
255 * Call this function only if you plan using surf_host_model_init_compound.
257 XBT_PUBLIC(void) surf_network_model_init_Reno2();
259 /** \ingroup SURF_models
260 * \brief Initializes the platform with the network model Vegas
262 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent to the proportional fairness.
265 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
266 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
268 * Call this function only if you plan using surf_host_model_init_compound.
270 XBT_PUBLIC(void) surf_network_model_init_Vegas();
272 /** \ingroup SURF_models
273 * \brief The list of all available network model models
275 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
277 /** \ingroup SURF_models
278 * \brief The storage model
280 XBT_PUBLIC(void) surf_storage_model_init_default();
282 /** \ingroup SURF_models
283 * \brief The list of all available storage modes.
284 * This storage mode can be set using --cfg=storage/model:...
286 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
288 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
290 /** \ingroup SURF_models
291 * \brief The host model
293 * Note that when you create an API on top of SURF, the host model should be the only one you use
294 * because depending on the platform model, the network model and the CPU model may not exist.
296 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
298 /** \ingroup SURF_models
299 * \brief Initializes the platform with a compound host model
301 * This function should be called after a cpu_model and a network_model have been set up.
303 XBT_PUBLIC(void) surf_host_model_init_compound();
305 /** \ingroup SURF_models
306 * \brief Initializes the platform with the current best network and cpu models at hand
308 * This platform model separates the host model and the network model.
309 * The host model will be initialized with the model compound, the network model with the model LV08 (with cross
310 * traffic support) and the CPU model with the model Cas01.
311 * Such model is subject to modification with warning in the ChangeLog so monitor it!
313 XBT_PUBLIC(void) surf_host_model_init_current_default();
315 /** \ingroup SURF_models
316 * \brief Initializes the platform with the model L07
318 * With this model, only parallel tasks can be used. Resource sharing is done by identifying bottlenecks and giving an
319 * equal share of the model to each action.
321 XBT_PUBLIC(void) surf_host_model_init_ptask_L07();
323 /** \ingroup SURF_models
324 * \brief The list of all available host model models
326 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_host_model_description[];
328 /** \ingroup SURF_models
329 * \brief Initializes the platform with the current best network and cpu models at hand
331 * This platform model seperates the host model and the network model.
332 * The host model will be initialized with the model compound, the network model with the model LV08 (with cross
333 * traffic support) and the CPU model with the model Cas01.
334 * Such model is subject to modification with warning in the ChangeLog so monitor it!
336 XBT_PUBLIC(void) surf_vm_model_init_HL13();
338 /*** SURF Globals **************************/
340 /** \ingroup SURF_simulation
341 * \brief Initialize SURF
342 * \param argc argument number
343 * \param argv arguments
345 * This function has to be called to initialize the common structures. Then you will have to create the environment by
346 * calling e.g. surf_host_model_init_CM02()
348 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
350 XBT_PUBLIC(void) surf_init(int* argc, char** argv); /* initialize common structures */
352 /** \ingroup SURF_simulation
353 * \brief Finish simulation initialization
355 * This function must be called before the first call to surf_solve()
357 XBT_PUBLIC(void) surf_presolve();
359 /** \ingroup SURF_simulation
360 * \brief Performs a part of the simulation
361 * \param max_date Maximum date to update the simulation to, or -1
362 * \return the elapsed time, or -1.0 if no event could be executed
364 * This function execute all possible events, update the action states and returns the time elapsed.
365 * When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
366 * when you call surf_solve.
367 * Note that the returned elapsed time can be zero.
369 XBT_PUBLIC(double) surf_solve(double max_date);
371 /** \ingroup SURF_simulation
372 * \brief Return the current time
374 * Return the current time in millisecond.
376 XBT_PUBLIC(double) surf_get_clock();
378 /** \ingroup SURF_simulation
385 XBT_PUBLIC(void) surf_exit();
387 /* surf parse file related (public because called from a test suite) */
388 XBT_PUBLIC(void) parse_platform_file(const char* file);
390 /********** Tracing **********/
392 /* instr_routing.c */
393 void instr_routing_define_callbacks();
394 int instr_platform_traced();
395 xbt_graph_t instr_routing_platform_graph();
396 void instr_routing_platform_graph_export_graphviz(xbt_graph_t g, const char* filename);