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. */
10 #include "xbt/dynar.h"
12 #include "xbt/graph.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"
29 class NetworkCm02Link;
34 typedef simgrid::surf::Model surf_Model;
35 typedef simgrid::surf::CpuModel surf_CpuModel;
36 typedef simgrid::surf::HostModel surf_HostModel;
37 typedef simgrid::surf::NetworkModel surf_NetworkModel;
38 typedef simgrid::surf::StorageModel surf_StorageModel;
39 typedef simgrid::surf::Action surf_Action;
43 typedef struct surf_Model surf_Model;
44 typedef struct surf_CpuModel surf_CpuModel;
45 typedef struct surf_HostModel surf_HostModel;
46 typedef struct surf_NetworkModel surf_NetworkModel;
47 typedef struct surf_StorageModel surf_StorageModel;
48 typedef struct surf_Action surf_Action;
53 /* Actions and models are highly connected structures... */
55 /* user-visible parameters */
56 extern XBT_PRIVATE double sg_tcp_gamma;
57 extern XBT_PRIVATE double sg_latency_factor;
58 extern XBT_PRIVATE double sg_bandwidth_factor;
59 extern XBT_PRIVATE double sg_weight_S_parameter;
60 extern XBT_PRIVATE int sg_network_crosstraffic;
62 /** @ingroup SURF_c_bindings
63 * \brief Model datatype
65 * Generic data structure for a model. The hosts,
66 * the CPUs and the network links are examples of models.
68 typedef surf_Model *surf_model_t;
69 typedef surf_CpuModel *surf_cpu_model_t;
70 typedef surf_HostModel *surf_host_model_t;
71 typedef surf_NetworkModel *surf_network_model_t;
72 typedef surf_StorageModel *surf_storage_model_t;
74 /** @ingroup SURF_c_bindings
75 * \brief Action structure
77 * Never create s_surf_action_t by yourself ! The actions are created
78 * on the fly when you call execute or communicate on a model.
80 * \see e_surf_action_state_t
82 typedef surf_Action *surf_action_t;
85 /** \brief Resource model description
87 struct surf_model_description {
89 const char *description;
90 void_f_void_t model_init_preparse;
92 typedef struct surf_model_description s_surf_model_description_t;
93 typedef struct surf_model_description* surf_model_description_t;
95 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table, const char *name);
96 XBT_PUBLIC(void) model_help(const char *category, s_surf_model_description_t * table);
98 /***************************/
99 /* Generic model object */
100 /***************************/
102 /** @{ @ingroup SURF_c_bindings */
105 * @brief Pop an action from the done actions set
107 * @param model The model from which the action is extracted
108 * @return An action in done state
110 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
113 * @brief Pop an action from the failed actions set
115 * @param model The model from which the action is extracted
116 * @return An action in failed state
118 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
121 * @brief Get the size of the running action set of a model
123 * @param model The model
124 * @return The size of the running action set
126 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
129 * @brief [brief description]
130 * @details [long description]
132 * @param action The surf cpu action
133 * @param bound [description]
135 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
138 * @brief [brief description]
139 * @details [long description]
141 * @param action The surf network action
143 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
147 /**************************************/
148 /* Implementations of model object */
149 /**************************************/
151 /** \ingroup SURF_models
152 * \brief The CPU model object for the physical machine layer
154 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
156 /** \ingroup SURF_models
157 * \brief The CPU model object for the virtual machine layer
159 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
162 /** \ingroup SURF_models
163 * \brief Initializes the CPU model with the model Cas01
165 * By default, this model uses the lazy optimization mechanism that relies on partial invalidation in LMM and a heap
166 * for lazy action update.
167 * You can change this behavior by setting the cpu/optim configuration variable to a different value.
169 * You shouldn't have to call it by yourself.
171 XBT_PUBLIC(void) surf_cpu_model_init_Cas01();
173 /** \ingroup SURF_models
174 * \brief Initializes the CPU model with trace integration [Deprecated]
176 * You shouldn't have to call it by yourself.
178 XBT_PUBLIC(void) surf_cpu_model_init_ti();
180 /** \ingroup SURF_models
181 * \brief The list of all available optimization modes (both for cpu and networks).
182 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
184 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
186 /** \ingroup SURF_plugins
187 * \brief The list of all available surf plugins
189 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
191 /** \ingroup SURF_models
192 * \brief The list of all available cpu model models
194 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
196 /** \ingroup SURF_models
197 * \brief The network model
199 * When creating a new API on top on SURF, you shouldn't use the network model unless you know what you are doing.
200 * Only the host model should be accessed because depending on the platform model, the network model can be NULL.
202 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
204 /** \ingroup SURF_models
205 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
207 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud based on the model 'LV08' and
208 * different correction factors depending on the communication size (< 1KiB, < 64KiB, >= 64KiB).
209 * See comments in the code for more information.
211 * \see surf_host_model_init_SMPI()
213 XBT_PUBLIC(void) surf_network_model_init_SMPI();
215 /** \ingroup SURF_models
216 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
218 * This model impelments a variant of the contention model on Infinband networks based on
219 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
221 * \see surf_host_model_init_IB()
223 XBT_PUBLIC(void) surf_network_model_init_IB();
225 /** \ingroup SURF_models
226 * \brief Initializes the platform with the network model 'LegrandVelho'
228 * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for
229 * onelink and dogbone sharing scenarios. See comments in the code for more information.
231 * \see surf_host_model_init_LegrandVelho()
233 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho();
235 /** \ingroup SURF_models
236 * \brief Initializes the platform with the network model 'Constant'
238 * In this model, the communication time between two network cards is constant, hence no need for a routing table.
239 * This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This
240 * function is called in conjunction with surf_host_model_init_compound.
242 * \see surf_host_model_init_compound()
244 XBT_PUBLIC(void) surf_network_model_init_Constant();
246 /** \ingroup SURF_models
247 * \brief Initializes the platform with the network model CM02
249 * You sould call this function by yourself only if you plan using surf_host_model_init_compound.
250 * See comments in the code for more information.
252 XBT_PUBLIC(void) surf_network_model_init_CM02();
254 /** \ingroup SURF_models
255 * \brief Initializes the platform with the network model NS3
257 * This function is called by surf_host_model_init_NS3 or by yourself only if you plan using
258 * surf_host_model_init_compound
260 * \see surf_host_model_init_NS3()
262 XBT_PUBLIC(void) surf_network_model_init_NS3();
264 /** \ingroup SURF_models
265 * \brief Initializes the platform with the network model Reno
267 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
270 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
271 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
273 * Call this function only if you plan using surf_host_model_init_compound.
275 XBT_PUBLIC(void) surf_network_model_init_Reno();
277 /** \ingroup SURF_models
278 * \brief Initializes the platform with the network model Reno2
280 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
283 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
284 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
286 * Call this function only if you plan using surf_host_model_init_compound.
288 XBT_PUBLIC(void) surf_network_model_init_Reno2();
290 /** \ingroup SURF_models
291 * \brief Initializes the platform with the network model Vegas
293 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent to the proportional fairness.
296 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
297 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
299 * Call this function only if you plan using surf_host_model_init_compound.
301 XBT_PUBLIC(void) surf_network_model_init_Vegas();
303 /** \ingroup SURF_models
304 * \brief The list of all available network model models
306 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
308 /** \ingroup SURF_models
309 * \brief The storage model
311 XBT_PUBLIC(void) surf_storage_model_init_default();
313 /** \ingroup SURF_models
314 * \brief The list of all available storage modes.
315 * This storage mode can be set using --cfg=storage/model:...
317 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
319 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
321 /** \ingroup SURF_models
322 * \brief The host model
324 * Note that when you create an API on top of SURF, the host model should be the only one you use
325 * because depending on the platform model, the network model and the CPU model may not exist.
327 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
329 /** \ingroup SURF_models
330 * \brief Initializes the platform with a compound host model
332 * This function should be called after a cpu_model and a network_model have been set up.
334 XBT_PUBLIC(void) surf_host_model_init_compound();
336 /** \ingroup SURF_models
337 * \brief Initializes the platform with the current best network and cpu models at hand
339 * This platform model separates the host model and the network model.
340 * The host model will be initialized with the model compound, the network model with the model LV08 (with cross
341 * traffic support) and the CPU model with the model Cas01.
342 * Such model is subject to modification with warning in the ChangeLog so monitor it!
344 XBT_PUBLIC(void) surf_host_model_init_current_default();
346 /** \ingroup SURF_models
347 * \brief Initializes the platform with the model L07
349 * With this model, only parallel tasks can be used. Resource sharing is done by identifying bottlenecks and giving an
350 * equal share of the model to each action.
352 XBT_PUBLIC(void) surf_host_model_init_ptask_L07();
354 /** \ingroup SURF_models
355 * \brief The list of all available host model models
357 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_host_model_description[];
359 /** \ingroup SURF_models
360 * \brief Initializes the platform with the current best network and cpu models at hand
362 * This platform model seperates the host model and the network model.
363 * The host model will be initialized with the model compound, the network model with the model LV08 (with cross
364 * traffic support) and the CPU model with the model Cas01.
365 * Such model is subject to modification with warning in the ChangeLog so monitor it!
367 XBT_PUBLIC(void) surf_vm_model_init_HL13();
369 /*** SURF Globals **************************/
371 /** \ingroup SURF_simulation
372 * \brief Initialize SURF
373 * \param argc argument number
374 * \param argv arguments
376 * This function has to be called to initialize the common structures. Then you will have to create the environment by
377 * calling e.g. surf_host_model_init_CM02()
379 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
381 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
383 /** \ingroup SURF_simulation
384 * \brief Finish simulation initialization
386 * This function must be called before the first call to surf_solve()
388 XBT_PUBLIC(void) surf_presolve();
390 /** \ingroup SURF_simulation
391 * \brief Performs a part of the simulation
392 * \param max_date Maximum date to update the simulation to, or -1
393 * \return the elapsed time, or -1.0 if no event could be executed
395 * This function execute all possible events, update the action states and returns the time elapsed.
396 * When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
397 * when you call surf_solve.
398 * Note that the returned elapsed time can be zero.
400 XBT_PUBLIC(double) surf_solve(double max_date);
402 /** \ingroup SURF_simulation
403 * \brief Return the current time
405 * Return the current time in millisecond.
407 XBT_PUBLIC(double) surf_get_clock();
409 /** \ingroup SURF_simulation
416 XBT_PUBLIC(void) surf_exit();
418 /* surf parse file related (public because called from a test suite) */
419 XBT_PUBLIC(void) parse_platform_file(const char *file);
422 * Returns the initial path. On Windows the initial path is the current directory for the current process in the other
423 * case the function returns "./" that represents the current directory on Unix/Linux platforms.
425 const char *__surf_get_initial_path();
427 /********** Tracing **********/
428 /* from surf_instr.c */
429 void TRACE_surf_action(surf_action_t surf_action, const char *category);
431 /* instr_routing.c */
432 void instr_routing_define_callbacks ();
433 int instr_platform_traced ();
434 xbt_graph_t instr_routing_platform_graph ();
435 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);