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"
30 class NetworkCm02Link;
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;
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;
56 /* Actions and models are highly connected structures... */
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;
65 /** @ingroup SURF_c_bindings
66 * \brief Model datatype
68 * Generic data structure for a model. The hosts,
69 * the CPUs and the network links are examples of models.
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;
77 /** @ingroup SURF_c_bindings
78 * \brief Action structure
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.
83 * \see e_surf_action_state_t
85 typedef surf_Action *surf_action_t;
88 /** \brief Resource model description
90 struct surf_model_description {
92 const char *description;
93 void_f_void_t model_init_preparse;
95 typedef struct surf_model_description s_surf_model_description_t;
96 typedef struct surf_model_description* surf_model_description_t;
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);
101 /***************************/
102 /* Generic model object */
103 /***************************/
105 /** @{ @ingroup SURF_c_bindings */
108 * @brief Pop an action from the done actions set
110 * @param model The model from which the action is extracted
111 * @return An action in done state
113 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
116 * @brief Pop an action from the failed actions set
118 * @param model The model from which the action is extracted
119 * @return An action in failed state
121 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
124 * @brief Get the size of the running action set of a model
126 * @param model The model
127 * @return The size of the running action set
129 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
132 * @brief [brief description]
133 * @details [long description]
135 * @param action The surf cpu action
136 * @param bound [description]
138 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
141 * @brief [brief description]
142 * @details [long description]
144 * @param action The surf network action
146 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
150 /**************************************/
151 /* Implementations of model object */
152 /**************************************/
154 /** \ingroup SURF_models
155 * \brief The CPU model object for the physical machine layer
157 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
159 /** \ingroup SURF_models
160 * \brief The CPU model object for the virtual machine layer
162 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
165 /** \ingroup SURF_models
166 * \brief Initializes the CPU model with the model Cas01
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.
172 * You shouldn't have to call it by yourself.
174 XBT_PUBLIC(void) surf_cpu_model_init_Cas01();
176 /** \ingroup SURF_models
177 * \brief Initializes the CPU model with trace integration [Deprecated]
179 * You shouldn't have to call it by yourself.
181 XBT_PUBLIC(void) surf_cpu_model_init_ti();
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:...
187 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
189 /** \ingroup SURF_plugins
190 * \brief The list of all available surf plugins
192 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
194 /** \ingroup SURF_models
195 * \brief The list of all available cpu model models
197 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
199 /** \ingroup SURF_models
200 * \brief The network model
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.
205 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
207 /** \ingroup SURF_models
208 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
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.
214 * \see surf_host_model_init_SMPI()
216 XBT_PUBLIC(void) surf_network_model_init_SMPI();
218 /** \ingroup SURF_models
219 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
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
224 * \see surf_host_model_init_IB()
226 XBT_PUBLIC(void) surf_network_model_init_IB();
228 /** \ingroup SURF_models
229 * \brief Initializes the platform with the network model 'LegrandVelho'
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.
234 * \see surf_host_model_init_LegrandVelho()
236 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho();
238 /** \ingroup SURF_models
239 * \brief Initializes the platform with the network model 'Constant'
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.
245 * \see surf_host_model_init_compound()
247 XBT_PUBLIC(void) surf_network_model_init_Constant();
249 /** \ingroup SURF_models
250 * \brief Initializes the platform with the network model CM02
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.
255 XBT_PUBLIC(void) surf_network_model_init_CM02();
257 /** \ingroup SURF_models
258 * \brief Initializes the platform with the network model NS3
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
263 * \see surf_host_model_init_NS3()
265 XBT_PUBLIC(void) surf_network_model_init_NS3();
267 /** \ingroup SURF_models
268 * \brief Initializes the platform with the network model Reno
270 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
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.
276 * Call this function only if you plan using surf_host_model_init_compound.
278 XBT_PUBLIC(void) surf_network_model_init_Reno();
280 /** \ingroup SURF_models
281 * \brief Initializes the platform with the network model Reno2
283 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
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.
289 * Call this function only if you plan using surf_host_model_init_compound.
291 XBT_PUBLIC(void) surf_network_model_init_Reno2();
293 /** \ingroup SURF_models
294 * \brief Initializes the platform with the network model Vegas
296 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent to the proportional fairness.
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.
302 * Call this function only if you plan using surf_host_model_init_compound.
304 XBT_PUBLIC(void) surf_network_model_init_Vegas();
306 /** \ingroup SURF_models
307 * \brief The list of all available network model models
309 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
311 /** \ingroup SURF_models
312 * \brief The storage model
314 XBT_PUBLIC(void) surf_storage_model_init_default();
316 /** \ingroup SURF_models
317 * \brief The list of all available storage modes.
318 * This storage mode can be set using --cfg=storage/model:...
320 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
322 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
324 /** \ingroup SURF_models
325 * \brief The host model
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.
330 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
332 /** \ingroup SURF_models
333 * \brief Initializes the platform with a compound host model
335 * This function should be called after a cpu_model and a network_model have been set up.
337 XBT_PUBLIC(void) surf_host_model_init_compound();
339 /** \ingroup SURF_models
340 * \brief Initializes the platform with the current best network and cpu models at hand
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!
347 XBT_PUBLIC(void) surf_host_model_init_current_default();
349 /** \ingroup SURF_models
350 * \brief Initializes the platform with the model L07
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.
355 XBT_PUBLIC(void) surf_host_model_init_ptask_L07();
357 /** \ingroup SURF_models
358 * \brief The list of all available host model models
360 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_host_model_description[];
362 /** \ingroup SURF_models
363 * \brief Initializes the platform with the current best network and cpu models at hand
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!
370 XBT_PUBLIC(void) surf_vm_model_init_HL13();
372 /*** SURF Globals **************************/
374 /** \ingroup SURF_simulation
375 * \brief Initialize SURF
376 * \param argc argument number
377 * \param argv arguments
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()
382 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
384 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
386 /** \ingroup SURF_simulation
387 * \brief Finish simulation initialization
389 * This function must be called before the first call to surf_solve()
391 XBT_PUBLIC(void) surf_presolve();
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
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.
403 XBT_PUBLIC(double) surf_solve(double max_date);
405 /** \ingroup SURF_simulation
406 * \brief Return the current time
408 * Return the current time in millisecond.
410 XBT_PUBLIC(double) surf_get_clock();
412 /** \ingroup SURF_simulation
419 XBT_PUBLIC(void) surf_exit();
421 /* surf parse file related (public because called from a test suite) */
422 XBT_PUBLIC(void) parse_platform_file(const char *file);
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.
428 const char *__surf_get_initial_path();
430 /********** Tracing **********/
431 /* from surf_instr.c */
432 void TRACE_surf_action(surf_action_t surf_action, const char *category);
434 /* instr_routing.c */
435 void instr_routing_define_callbacks ();
436 int instr_platform_traced ();
437 xbt_graph_t instr_routing_platform_graph ();
438 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);