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"
21 #error This is a C++ only file, now
33 class NetworkCm02Link;
38 typedef simgrid::surf::Model surf_Model;
39 typedef simgrid::surf::CpuModel surf_CpuModel;
40 typedef simgrid::surf::HostModel surf_HostModel;
41 typedef simgrid::surf::NetworkModel surf_NetworkModel;
42 typedef simgrid::surf::StorageModel surf_StorageModel;
43 typedef simgrid::surf::Action surf_Action;
47 typedef struct surf_Model surf_Model;
48 typedef struct surf_CpuModel surf_CpuModel;
49 typedef struct surf_HostModel surf_HostModel;
50 typedef struct surf_NetworkModel surf_NetworkModel;
51 typedef struct surf_StorageModel surf_StorageModel;
52 typedef struct surf_Action surf_Action;
57 /* Actions and models are highly connected structures... */
59 /* user-visible parameters */
60 extern XBT_PRIVATE double sg_tcp_gamma;
61 extern XBT_PRIVATE double sg_latency_factor;
62 extern XBT_PRIVATE double sg_bandwidth_factor;
63 extern XBT_PRIVATE double sg_weight_S_parameter;
64 extern XBT_PRIVATE int sg_network_crosstraffic;
66 /** @ingroup SURF_c_bindings
67 * \brief Model datatype
69 * Generic data structure for a model. The hosts,
70 * the CPUs and the network links are examples of models.
72 typedef surf_Model *surf_model_t;
73 typedef surf_CpuModel *surf_cpu_model_t;
74 typedef surf_HostModel *surf_host_model_t;
75 typedef surf_NetworkModel *surf_network_model_t;
76 typedef surf_StorageModel *surf_storage_model_t;
78 /** @ingroup SURF_c_bindings
79 * \brief Action structure
81 * Never create s_surf_action_t by yourself ! The actions are created
82 * on the fly when you call execute or communicate on a model.
84 * \see e_surf_action_state_t
86 typedef surf_Action *surf_action_t;
89 /** \brief Resource model description
91 struct surf_model_description {
93 const char *description;
94 void_f_void_t model_init_preparse;
96 typedef struct surf_model_description s_surf_model_description_t;
99 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t* table, std::string name);
101 XBT_PUBLIC(void) model_help(const char *category, s_surf_model_description_t * table);
103 /***************************/
104 /* Generic model object */
105 /***************************/
107 /** @{ @ingroup SURF_c_bindings */
110 * @brief Pop an action from the done actions set
112 * @param model The model from which the action is extracted
113 * @return An action in done state
115 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
118 * @brief Pop an action from the failed actions set
120 * @param model The model from which the action is extracted
121 * @return An action in failed state
123 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
126 * @brief Get the size of the running action set of a model
128 * @param model The model
129 * @return The size of the running action set
131 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
134 * @brief [brief description]
135 * @details [long description]
137 * @param action The surf cpu action
138 * @param bound [description]
140 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
143 * @brief [brief description]
144 * @details [long description]
146 * @param action The surf network action
148 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
152 /**************************************/
153 /* Implementations of model object */
154 /**************************************/
156 /** \ingroup SURF_models
157 * \brief The CPU model object for the physical machine layer
159 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
161 /** \ingroup SURF_models
162 * \brief The CPU model object for the virtual machine layer
164 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
167 /** \ingroup SURF_models
168 * \brief Initializes the CPU model with the model Cas01
170 * By default, this model uses the lazy optimization mechanism that relies on partial invalidation in LMM and a heap
171 * for lazy action update.
172 * You can change this behavior by setting the cpu/optim configuration variable to a different value.
174 * You shouldn't have to call it by yourself.
176 XBT_PUBLIC(void) surf_cpu_model_init_Cas01();
178 /** \ingroup SURF_models
179 * \brief Initializes the CPU model with trace integration [Deprecated]
181 * You shouldn't have to call it by yourself.
183 XBT_PUBLIC(void) surf_cpu_model_init_ti();
185 /** \ingroup SURF_models
186 * \brief The list of all available optimization modes (both for cpu and networks).
187 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
189 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
191 /** \ingroup SURF_plugins
192 * \brief The list of all available surf plugins
194 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
196 /** \ingroup SURF_models
197 * \brief The list of all available cpu model models
199 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
201 /** \ingroup SURF_models
202 * \brief The network model
204 * When creating a new API on top on SURF, you shouldn't use the network model unless you know what you are doing.
205 * Only the host model should be accessed because depending on the platform model, the network model can be NULL.
207 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
209 /** \ingroup SURF_models
210 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
212 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud based on the model 'LV08' and
213 * different correction factors depending on the communication size (< 1KiB, < 64KiB, >= 64KiB).
214 * See comments in the code for more information.
216 * \see surf_host_model_init_SMPI()
218 XBT_PUBLIC(void) surf_network_model_init_SMPI();
220 /** \ingroup SURF_models
221 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
223 * This model impelments a variant of the contention model on Infinband networks based on
224 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
226 * \see surf_host_model_init_IB()
228 XBT_PUBLIC(void) surf_network_model_init_IB();
230 /** \ingroup SURF_models
231 * \brief Initializes the platform with the network model 'LegrandVelho'
233 * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for
234 * onelink and dogbone sharing scenarios. See comments in the code for more information.
236 * \see surf_host_model_init_LegrandVelho()
238 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho();
240 /** \ingroup SURF_models
241 * \brief Initializes the platform with the network model 'Constant'
243 * In this model, the communication time between two network cards is constant, hence no need for a routing table.
244 * This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This
245 * function is called in conjunction with surf_host_model_init_compound.
247 * \see surf_host_model_init_compound()
249 XBT_PUBLIC(void) surf_network_model_init_Constant();
251 /** \ingroup SURF_models
252 * \brief Initializes the platform with the network model CM02
254 * You sould call this function by yourself only if you plan using surf_host_model_init_compound.
255 * See comments in the code for more information.
257 XBT_PUBLIC(void) surf_network_model_init_CM02();
259 /** \ingroup SURF_models
260 * \brief Initializes the platform with the network model NS3
262 * This function is called by surf_host_model_init_NS3 or by yourself only if you plan using
263 * surf_host_model_init_compound
265 * \see surf_host_model_init_NS3()
267 XBT_PUBLIC(void) surf_network_model_init_NS3();
269 /** \ingroup SURF_models
270 * \brief Initializes the platform with the network model Reno
272 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
275 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
276 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
278 * Call this function only if you plan using surf_host_model_init_compound.
280 XBT_PUBLIC(void) surf_network_model_init_Reno();
282 /** \ingroup SURF_models
283 * \brief Initializes the platform with the network model Reno2
285 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
288 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
289 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
291 * Call this function only if you plan using surf_host_model_init_compound.
293 XBT_PUBLIC(void) surf_network_model_init_Reno2();
295 /** \ingroup SURF_models
296 * \brief Initializes the platform with the network model Vegas
298 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent to the proportional fairness.
301 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
302 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
304 * Call this function only if you plan using surf_host_model_init_compound.
306 XBT_PUBLIC(void) surf_network_model_init_Vegas();
308 /** \ingroup SURF_models
309 * \brief The list of all available network model models
311 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
313 /** \ingroup SURF_models
314 * \brief The storage model
316 XBT_PUBLIC(void) surf_storage_model_init_default();
318 /** \ingroup SURF_models
319 * \brief The list of all available storage modes.
320 * This storage mode can be set using --cfg=storage/model:...
322 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
324 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
326 /** \ingroup SURF_models
327 * \brief The host model
329 * Note that when you create an API on top of SURF, the host model should be the only one you use
330 * because depending on the platform model, the network model and the CPU model may not exist.
332 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
334 /** \ingroup SURF_models
335 * \brief Initializes the platform with a compound host model
337 * This function should be called after a cpu_model and a network_model have been set up.
339 XBT_PUBLIC(void) surf_host_model_init_compound();
341 /** \ingroup SURF_models
342 * \brief Initializes the platform with the current best network and cpu models at hand
344 * This platform model separates the host model and the network model.
345 * The host model will be initialized with the model compound, the network model with the model LV08 (with cross
346 * traffic support) and the CPU model with the model Cas01.
347 * Such model is subject to modification with warning in the ChangeLog so monitor it!
349 XBT_PUBLIC(void) surf_host_model_init_current_default();
351 /** \ingroup SURF_models
352 * \brief Initializes the platform with the model L07
354 * With this model, only parallel tasks can be used. Resource sharing is done by identifying bottlenecks and giving an
355 * equal share of the model to each action.
357 XBT_PUBLIC(void) surf_host_model_init_ptask_L07();
359 /** \ingroup SURF_models
360 * \brief The list of all available host model models
362 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_host_model_description[];
364 /** \ingroup SURF_models
365 * \brief Initializes the platform with the current best network and cpu models at hand
367 * This platform model seperates the host model and the network model.
368 * The host model will be initialized with the model compound, the network model with the model LV08 (with cross
369 * traffic support) and the CPU model with the model Cas01.
370 * Such model is subject to modification with warning in the ChangeLog so monitor it!
372 XBT_PUBLIC(void) surf_vm_model_init_HL13();
374 /*** SURF Globals **************************/
376 /** \ingroup SURF_simulation
377 * \brief Initialize SURF
378 * \param argc argument number
379 * \param argv arguments
381 * This function has to be called to initialize the common structures. Then you will have to create the environment by
382 * calling e.g. surf_host_model_init_CM02()
384 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
386 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
388 /** \ingroup SURF_simulation
389 * \brief Finish simulation initialization
391 * This function must be called before the first call to surf_solve()
393 XBT_PUBLIC(void) surf_presolve();
395 /** \ingroup SURF_simulation
396 * \brief Performs a part of the simulation
397 * \param max_date Maximum date to update the simulation to, or -1
398 * \return the elapsed time, or -1.0 if no event could be executed
400 * This function execute all possible events, update the action states and returns the time elapsed.
401 * When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
402 * when you call surf_solve.
403 * Note that the returned elapsed time can be zero.
405 XBT_PUBLIC(double) surf_solve(double max_date);
407 /** \ingroup SURF_simulation
408 * \brief Return the current time
410 * Return the current time in millisecond.
412 XBT_PUBLIC(double) surf_get_clock();
414 /** \ingroup SURF_simulation
421 XBT_PUBLIC(void) surf_exit();
423 /* surf parse file related (public because called from a test suite) */
424 XBT_PUBLIC(void) parse_platform_file(const char *file);
426 /********** Tracing **********/
427 /* from surf_instr.c */
428 void TRACE_surf_action(surf_action_t surf_action, const char *category);
430 /* instr_routing.c */
431 void instr_routing_define_callbacks ();
432 int instr_platform_traced ();
433 xbt_graph_t instr_routing_platform_graph ();
434 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);