1 /* Copyright (c) 2004-2017. 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/datatypes.h"
10 #include "simgrid/forward.h"
11 #include "src/internal_config.h"
12 #include "surf/datatypes.h"
13 #include "xbt/config.h"
15 #include "xbt/dynar.h"
16 #include "xbt/graph.h"
21 #error This is a C++ only file, now
31 class NetworkCm02Link;
36 /** @ingroup SURF_c_bindings
37 * \brief Model datatype
39 * Generic data structure for a model. The hosts,
40 * the CPUs and the network links are examples of models.
42 typedef simgrid::surf::Model* surf_model_t;
43 typedef simgrid::surf::CpuModel* surf_cpu_model_t;
44 typedef simgrid::surf::HostModel* surf_host_model_t;
45 typedef simgrid::surf::NetworkModel* surf_network_model_t;
46 typedef simgrid::surf::StorageModel* surf_storage_model_t;
47 /** @ingroup SURF_c_bindings
48 * \brief Action structure
50 * Never create s_surf_action_t by yourself ! The actions are created
51 * on the fly when you call execute or communicate on a model.
53 * \see e_surf_action_state_t
55 typedef simgrid::surf::Action* surf_action_t;
58 /* Actions and models are highly connected structures... */
60 /* user-visible parameters */
61 extern XBT_PRIVATE double sg_tcp_gamma;
62 extern XBT_PRIVATE double sg_latency_factor;
63 extern XBT_PRIVATE double sg_bandwidth_factor;
64 extern XBT_PRIVATE double sg_weight_S_parameter;
65 extern XBT_PRIVATE int sg_network_crosstraffic;
67 /** \brief Resource model description
69 struct surf_model_description {
71 const char* description;
72 void_f_void_t model_init_preparse;
74 typedef struct surf_model_description s_surf_model_description_t;
76 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t* table, std::string name);
77 XBT_PUBLIC(void) model_help(const char* category, s_surf_model_description_t* table);
79 /***************************/
80 /* Generic model object */
81 /***************************/
83 /** @{ @ingroup SURF_c_bindings */
86 * @brief Pop an action from the done actions set
88 * @param model The model from which the action is extracted
89 * @return An action in done state
91 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
94 * @brief Pop an action from the failed actions set
96 * @param model The model from which the action is extracted
97 * @return An action in failed state
99 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
102 * @brief Get the size of the running action set of a model
104 * @param model The model
105 * @return The size of the running action set
107 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
110 * @brief [brief description]
111 * @details [long description]
113 * @param action The surf cpu action
114 * @param bound [description]
116 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
119 * @brief [brief description]
120 * @details [long description]
122 * @param action The surf network action
124 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
128 /**************************************/
129 /* Implementations of model object */
130 /**************************************/
132 /** \ingroup SURF_models
133 * \brief The CPU model object for the physical machine layer
135 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
137 /** \ingroup SURF_models
138 * \brief The CPU model object for the virtual machine layer
140 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
142 /** \ingroup SURF_models
143 * \brief Initializes the CPU model with the model Cas01
145 * By default, this model uses the lazy optimization mechanism that relies on partial invalidation in LMM and a heap
146 * for lazy action update.
147 * You can change this behavior by setting the cpu/optim configuration variable to a different value.
149 * You shouldn't have to call it by yourself.
151 XBT_PUBLIC(void) surf_cpu_model_init_Cas01();
153 /** \ingroup SURF_models
154 * \brief Initializes the CPU model with trace integration [Deprecated]
156 * You shouldn't have to call it by yourself.
158 XBT_PUBLIC(void) surf_cpu_model_init_ti();
160 /** \ingroup SURF_models
161 * \brief The list of all available optimization modes (both for cpu and networks).
162 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
164 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
166 /** \ingroup SURF_plugins
167 * \brief The list of all available surf plugins
169 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
171 /** \ingroup SURF_models
172 * \brief The list of all available cpu model models
174 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
176 /** \ingroup SURF_models
177 * \brief The network model
179 * When creating a new API on top on SURF, you shouldn't use the network model unless you know what you are doing.
180 * Only the host model should be accessed because depending on the platform model, the network model can be NULL.
182 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
184 /** \ingroup SURF_models
185 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
187 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud based on the model 'LV08' and
188 * different correction factors depending on the communication size (< 1KiB, < 64KiB, >= 64KiB).
189 * See comments in the code for more information.
191 * \see surf_host_model_init_SMPI()
193 XBT_PUBLIC(void) surf_network_model_init_SMPI();
195 /** \ingroup SURF_models
196 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
198 * This model impelments a variant of the contention model on Infinband networks based on
199 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
201 * \see surf_host_model_init_IB()
203 XBT_PUBLIC(void) surf_network_model_init_IB();
205 /** \ingroup SURF_models
206 * \brief Initializes the platform with the network model 'LegrandVelho'
208 * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for
209 * onelink and dogbone sharing scenarios. See comments in the code for more information.
211 * \see surf_host_model_init_LegrandVelho()
213 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho();
215 /** \ingroup SURF_models
216 * \brief Initializes the platform with the network model 'Constant'
218 * In this model, the communication time between two network cards is constant, hence no need for a routing table.
219 * This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This
220 * function is called in conjunction with surf_host_model_init_compound.
222 * \see surf_host_model_init_compound()
224 XBT_PUBLIC(void) surf_network_model_init_Constant();
226 /** \ingroup SURF_models
227 * \brief Initializes the platform with the network model CM02
229 * You sould call this function by yourself only if you plan using surf_host_model_init_compound.
230 * See comments in the code for more information.
232 XBT_PUBLIC(void) surf_network_model_init_CM02();
234 /** \ingroup SURF_models
235 * \brief Initializes the platform with the network model NS3
237 * This function is called by surf_host_model_init_NS3 or by yourself only if you plan using
238 * surf_host_model_init_compound
240 * \see surf_host_model_init_NS3()
242 XBT_PUBLIC(void) surf_network_model_init_NS3();
244 /** \ingroup SURF_models
245 * \brief Initializes the platform with the network model Reno
247 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
250 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
251 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
253 * Call this function only if you plan using surf_host_model_init_compound.
255 XBT_PUBLIC(void) surf_network_model_init_Reno();
257 /** \ingroup SURF_models
258 * \brief Initializes the platform with the network model Reno2
260 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
263 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
264 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
266 * Call this function only if you plan using surf_host_model_init_compound.
268 XBT_PUBLIC(void) surf_network_model_init_Reno2();
270 /** \ingroup SURF_models
271 * \brief Initializes the platform with the network model Vegas
273 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent to the proportional fairness.
276 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
277 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
279 * Call this function only if you plan using surf_host_model_init_compound.
281 XBT_PUBLIC(void) surf_network_model_init_Vegas();
283 /** \ingroup SURF_models
284 * \brief The list of all available network model models
286 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
288 /** \ingroup SURF_models
289 * \brief The storage model
291 XBT_PUBLIC(void) surf_storage_model_init_default();
293 /** \ingroup SURF_models
294 * \brief The list of all available storage modes.
295 * This storage mode can be set using --cfg=storage/model:...
297 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
299 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
301 /** \ingroup SURF_models
302 * \brief The host model
304 * Note that when you create an API on top of SURF, the host model should be the only one you use
305 * because depending on the platform model, the network model and the CPU model may not exist.
307 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
309 /** \ingroup SURF_models
310 * \brief Initializes the platform with a compound host model
312 * This function should be called after a cpu_model and a network_model have been set up.
314 XBT_PUBLIC(void) surf_host_model_init_compound();
316 /** \ingroup SURF_models
317 * \brief Initializes the platform with the current best network and cpu models at hand
319 * This platform model separates the host model and the network model.
320 * The host model will be initialized with the model compound, the network model with the model LV08 (with cross
321 * traffic support) and the CPU model with the model Cas01.
322 * Such model is subject to modification with warning in the ChangeLog so monitor it!
324 XBT_PUBLIC(void) surf_host_model_init_current_default();
326 /** \ingroup SURF_models
327 * \brief Initializes the platform with the model L07
329 * With this model, only parallel tasks can be used. Resource sharing is done by identifying bottlenecks and giving an
330 * equal share of the model to each action.
332 XBT_PUBLIC(void) surf_host_model_init_ptask_L07();
334 /** \ingroup SURF_models
335 * \brief The list of all available host model models
337 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_host_model_description[];
339 /** \ingroup SURF_models
340 * \brief Initializes the platform with the current best network and cpu models at hand
342 * This platform model seperates 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!
347 XBT_PUBLIC(void) surf_vm_model_init_HL13();
349 /*** SURF Globals **************************/
351 /** \ingroup SURF_simulation
352 * \brief Initialize SURF
353 * \param argc argument number
354 * \param argv arguments
356 * This function has to be called to initialize the common structures. Then you will have to create the environment by
357 * calling e.g. surf_host_model_init_CM02()
359 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
361 XBT_PUBLIC(void) surf_init(int* argc, char** argv); /* initialize common structures */
363 /** \ingroup SURF_simulation
364 * \brief Finish simulation initialization
366 * This function must be called before the first call to surf_solve()
368 XBT_PUBLIC(void) surf_presolve();
370 /** \ingroup SURF_simulation
371 * \brief Performs a part of the simulation
372 * \param max_date Maximum date to update the simulation to, or -1
373 * \return the elapsed time, or -1.0 if no event could be executed
375 * This function execute all possible events, update the action states and returns the time elapsed.
376 * When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
377 * when you call surf_solve.
378 * Note that the returned elapsed time can be zero.
380 XBT_PUBLIC(double) surf_solve(double max_date);
382 /** \ingroup SURF_simulation
383 * \brief Return the current time
385 * Return the current time in millisecond.
387 XBT_PUBLIC(double) surf_get_clock();
389 /** \ingroup SURF_simulation
396 XBT_PUBLIC(void) surf_exit();
398 /* surf parse file related (public because called from a test suite) */
399 XBT_PUBLIC(void) parse_platform_file(const char* file);
401 /********** Tracing **********/
402 /* from surf_instr.c */
403 void TRACE_surf_action(surf_action_t surf_action, const char* category);
405 /* instr_routing.c */
406 void instr_routing_define_callbacks();
407 int instr_platform_traced();
408 xbt_graph_t instr_routing_platform_graph();
409 void instr_routing_platform_graph_export_graphviz(xbt_graph_t g, const char* filename);