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/surf_routing.h"
17 #include "surf/datatypes.h"
19 #include "surf/surf_routing.h"
20 #include "simgrid/datatypes.h"
21 #include "simgrid/forward.h"
24 /* Actions and models are highly connected structures... */
26 /* user-visible parameters */
27 extern XBT_PRIVATE double sg_tcp_gamma;
28 extern XBT_PRIVATE double sg_sender_gap;
29 extern XBT_PRIVATE double sg_latency_factor;
30 extern XBT_PRIVATE double sg_bandwidth_factor;
31 extern XBT_PRIVATE double sg_weight_S_parameter;
32 extern XBT_PRIVATE int sg_network_crosstraffic;
45 class NetworkCm02Link;
50 typedef simgrid::surf::Model surf_Model;
51 typedef simgrid::surf::CpuModel surf_CpuModel;
52 typedef simgrid::surf::Cpu surf_Cpu;
53 typedef simgrid::surf::HostModel surf_HostModel;
54 typedef simgrid::surf::NetworkModel surf_NetworkModel;
55 typedef simgrid::surf::Storage surf_Storage;
56 typedef simgrid::surf::StorageModel surf_StorageModel;
57 typedef simgrid::surf::Resource surf_Resource;
58 typedef simgrid::surf::HostImpl surf_Host;
59 typedef simgrid::surf::Action surf_Action;
63 typedef struct surf_Model surf_Model;
64 typedef struct surf_CpuModel surf_CpuModel;
65 typedef struct surf_Cpu surf_Cpu;
66 typedef struct surf_HostModel surf_HostModel;
67 typedef struct surf_NetworkModel surf_NetworkModel;
68 typedef struct surf_Storage surf_Storage;
69 typedef struct surf_StorageModel surf_StorageModel;
70 typedef struct surf_Resource surf_Resource;
71 typedef struct surf_Host surf_Host;
72 typedef struct surf_Action surf_Action;
76 /** @ingroup SURF_c_bindings
77 * \brief Model datatype
79 * Generic data structure for a model. The hosts,
80 * the CPUs and the network links are examples of models.
82 typedef surf_Model *surf_model_t;
83 typedef surf_CpuModel *surf_cpu_model_t;
84 typedef surf_HostModel *surf_host_model_t;
85 typedef surf_NetworkModel *surf_network_model_t;
86 typedef surf_StorageModel *surf_storage_model_t;
87 typedef surf_Storage* surf_storage_t;
89 typedef xbt_dictelm_t surf_resource_t;
91 /** @ingroup SURF_c_bindings
92 * \brief Action structure
94 * Never create s_surf_action_t by yourself ! The actions are created
95 * on the fly when you call execute or communicate on a model.
97 * \see e_surf_action_state_t
99 typedef surf_Action *surf_action_t;
101 typedef struct surf_file *surf_file_t;
103 /** \brief Resource model description
105 struct surf_model_description {
107 const char *description;
108 void_f_void_t model_init_preparse;
110 typedef struct surf_model_description s_surf_model_description_t;
111 typedef struct surf_model_description* surf_model_description_t;
113 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table, const char *name);
114 XBT_PUBLIC(void) model_help(const char *category, s_surf_model_description_t * table);
116 /***************************/
117 /* Generic model object */
118 /***************************/
120 static inline surf_storage_t surf_storage_resource_priv(const void* storage)
122 return (surf_storage_t)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
125 static inline void *surf_storage_resource_by_name(const char *name){
126 return xbt_lib_get_elm_or_null(storage_lib, name);
129 /** @{ @ingroup SURF_c_bindings */
132 * @brief Pop an action from the done actions set
134 * @param model The model from which the action is extracted
135 * @return An action in done state
137 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
140 * @brief Pop an action from the failed actions set
142 * @param model The model from which the action is extracted
143 * @return An action in failed state
145 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
148 * @brief Get the size of the running action set of a model
150 * @param model The model
151 * @return The size of the running action set
153 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
155 /** @brief Create a file opening action on the given host */
156 XBT_PUBLIC(surf_action_t) surf_host_open(sg_host_t host, const char* fullpath);
158 /** @brief Create a file closing action on the given host */
159 XBT_PUBLIC(surf_action_t) surf_host_close(sg_host_t host, surf_file_t fd);
161 /** @brief Create a file reading action on the given host */
162 XBT_PUBLIC(surf_action_t) surf_host_read(sg_host_t host, surf_file_t fd, sg_size_t size);
164 /** @brief Create a file writing action on the given host */
165 XBT_PUBLIC(surf_action_t) surf_host_write(sg_host_t host, surf_file_t fd, sg_size_t size);
168 * @brief Get the information of a file descriptor
169 * @details The returned xbt_dynar_t contains:
170 * - the size of the file,
172 * - the storage name,
173 * - the storage typeId,
174 * - the storage content type
176 * @param host The surf host
177 * @param fd The file descriptor
178 * @return An xbt_dynar_t with the file information
180 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(sg_host_t host, surf_file_t fd);
183 * @brief Get the available space of the storage at the mount point
185 * @param resource The surf host
186 * @param name The mount point
187 * @return The amount of available space in bytes
189 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(sg_host_t resource, const char* name);
192 * @brief Get the used space of the storage at the mount point
194 * @param resource The surf host
195 * @param name The mount point
196 * @return The amount of used space in bytes
198 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(sg_host_t resource, const char* name);
201 * @brief Unlink a file descriptor
203 * @param host The surf host
204 * @param fd The file descriptor
206 * @return 0 if failed to unlink, 1 otherwise
208 XBT_PUBLIC(int) surf_host_unlink(sg_host_t host, surf_file_t fd);
211 * @brief Get the size of a file on a host
213 * @param host The surf host
214 * @param fd The file descriptor
216 * @return The size in bytes of the file
218 XBT_PUBLIC(size_t) surf_host_get_size(sg_host_t host, surf_file_t fd);
221 * @brief Get the current position of the file descriptor
223 * @param host The surf host
224 * @param fd The file descriptor
225 * @return The current position of the file descriptor
227 XBT_PUBLIC(size_t) surf_host_file_tell(sg_host_t host, surf_file_t fd);
230 * @brief Move a file to another location on the *same mount point*.
231 * @details [long description]
233 * @param host The surf host
234 * @param fd The file descriptor
235 * @param fullpath The new full path
237 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
239 XBT_PUBLIC(int) surf_host_file_move(sg_host_t host, surf_file_t fd, const char* fullpath);
242 * @brief Set the position indictator assiociated with the file descriptor to a new position
243 * @details [long description]
245 * @param host The surf host
246 * @param fd The file descriptor
247 * @param offset The offset from the origin
248 * @param origin Position used as a reference for the offset
249 * - SEEK_SET: beginning of the file
250 * - SEEK_CUR: current position indicator
251 * - SEEK_END: end of the file
252 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
254 XBT_PUBLIC(int) surf_host_file_seek(sg_host_t host, surf_file_t fd, sg_offset_t offset, int origin);
257 * @brief Get the size in bytes of a storage
259 * @param resource The surf storage
260 * @return The size in bytes of the storage
262 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
265 * @brief Get the available size in bytes of a storage
267 * @param resource The surf storage
268 * @return The available size in bytes of the storage
270 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
273 * @brief Get the size in bytes of a storage
275 * @param resource The surf storage
276 * @return The used size in bytes of the storage
278 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
280 /** @brief return the properties set associated to that storage */
281 XBT_PUBLIC(xbt_dict_t) surf_storage_get_properties(surf_resource_t resource);
284 * @brief [brief description]
285 * @details [long description]
287 * @param action The surf cpu action
288 * @param bound [description]
290 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
293 * @brief [brief description]
294 * @details [long description]
296 * @param action The surf network action
298 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
301 * @brief Get the file associated to a storage action
303 * @param action The surf storage action
304 * @return The file associated to a storage action
306 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
309 * @brief Get the result dictionary of an ls action
311 * @param action The surf storage action
312 * @return The dictionry listing a path
314 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
318 * @brief Get the host the storage is attached to
320 * @param resource The surf storage
321 * @return The host name
324 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
325 XBT_PUBLIC(const char * ) surf_storage_get_name(surf_resource_t resource);
329 /**************************************/
330 /* Implementations of model object */
331 /**************************************/
333 /** \ingroup SURF_models
334 * \brief The CPU model object for the physical machine layer
336 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
338 /** \ingroup SURF_models
339 * \brief The CPU model object for the virtual machine layer
341 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
344 /** \ingroup SURF_models
345 * \brief Initializes the CPU model with the model Cas01
347 * By default, this model uses the lazy optimization mechanism that relies on partial invalidation in LMM and a heap
348 * for lazy action update.
349 * You can change this behavior by setting the cpu/optim configuration variable to a different value.
351 * You shouldn't have to call it by yourself.
353 XBT_PUBLIC(void) surf_cpu_model_init_Cas01();
355 /** \ingroup SURF_models
356 * \brief Initializes the CPU model with trace integration [Deprecated]
358 * You shouldn't have to call it by yourself.
360 XBT_PUBLIC(void) surf_cpu_model_init_ti();
362 /** \ingroup SURF_models
363 * \brief The list of all available optimization modes (both for cpu and networks).
364 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
366 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
368 /** \ingroup SURF_plugins
369 * \brief The list of all available surf plugins
371 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
373 /** \ingroup SURF_models
374 * \brief The list of all available cpu model models
376 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
378 /** \ingroup SURF_models
379 * \brief The network model
381 * When creating a new API on top on SURF, you shouldn't use the network model unless you know what you are doing.
382 * Only the host model should be accessed because depending on the platform model, the network model can be NULL.
384 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
386 /** \ingroup SURF_models
387 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
389 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud based on the model 'LV08' and
390 * different correction factors depending on the communication size (< 1KiB, < 64KiB, >= 64KiB).
391 * See comments in the code for more information.
393 * \see surf_host_model_init_SMPI()
395 XBT_PUBLIC(void) surf_network_model_init_SMPI();
397 /** \ingroup SURF_models
398 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
400 * This model impelments a variant of the contention model on Infinband networks based on
401 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
403 * \see surf_host_model_init_IB()
405 XBT_PUBLIC(void) surf_network_model_init_IB();
407 /** \ingroup SURF_models
408 * \brief Initializes the platform with the network model 'LegrandVelho'
410 * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for
411 * onelink and dogbone sharing scenarios. See comments in the code for more information.
413 * \see surf_host_model_init_LegrandVelho()
415 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho();
417 /** \ingroup SURF_models
418 * \brief Initializes the platform with the network model 'Constant'
420 * In this model, the communication time between two network cards is constant, hence no need for a routing table.
421 * This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This
422 * function is called in conjunction with surf_host_model_init_compound.
424 * \see surf_host_model_init_compound()
426 XBT_PUBLIC(void) surf_network_model_init_Constant();
428 /** \ingroup SURF_models
429 * \brief Initializes the platform with the network model CM02
431 * You sould call this function by yourself only if you plan using surf_host_model_init_compound.
432 * See comments in the code for more information.
434 XBT_PUBLIC(void) surf_network_model_init_CM02();
436 /** \ingroup SURF_models
437 * \brief Initializes the platform with the network model NS3
439 * This function is called by surf_host_model_init_NS3 or by yourself only if you plan using
440 * surf_host_model_init_compound
442 * \see surf_host_model_init_NS3()
444 XBT_PUBLIC(void) surf_network_model_init_NS3();
446 /** \ingroup SURF_models
447 * \brief Initializes the platform with the network model Reno
449 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
452 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
453 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
455 * Call this function only if you plan using surf_host_model_init_compound.
457 XBT_PUBLIC(void) surf_network_model_init_Reno();
459 /** \ingroup SURF_models
460 * \brief Initializes the platform with the network model Reno2
462 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
465 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
466 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
468 * Call this function only if you plan using surf_host_model_init_compound.
470 XBT_PUBLIC(void) surf_network_model_init_Reno2();
472 /** \ingroup SURF_models
473 * \brief Initializes the platform with the network model Vegas
475 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent to the proportional fairness.
478 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
479 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
481 * Call this function only if you plan using surf_host_model_init_compound.
483 XBT_PUBLIC(void) surf_network_model_init_Vegas();
485 /** \ingroup SURF_models
486 * \brief The list of all available network model models
488 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
490 /** \ingroup SURF_models
491 * \brief The storage model
493 XBT_PUBLIC(void) surf_storage_model_init_default();
495 /** \ingroup SURF_models
496 * \brief The list of all available storage modes.
497 * This storage mode can be set using --cfg=storage/model:...
499 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
501 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
503 /** \ingroup SURF_models
504 * \brief The host model
506 * Note that when you create an API on top of SURF, the host model should be the only one you use
507 * because depending on the platform model, the network model and the CPU model may not exist.
509 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
511 /** \ingroup SURF_models
512 * \brief Initializes the platform with a compound host model
514 * This function should be called after a cpu_model and a network_model have been set up.
516 XBT_PUBLIC(void) surf_host_model_init_compound();
518 /** \ingroup SURF_models
519 * \brief Initializes the platform with the current best network and cpu models at hand
521 * This platform model separates the host model and the network model.
522 * The host model will be initialized with the model compound, the network model with the model LV08 (with cross
523 * traffic support) and the CPU model with the model Cas01.
524 * Such model is subject to modification with warning in the ChangeLog so monitor it!
526 XBT_PUBLIC(void) surf_host_model_init_current_default();
528 /** \ingroup SURF_models
529 * \brief Initializes the platform with the model L07
531 * With this model, only parallel tasks can be used. Resource sharing is done by identifying bottlenecks and giving an
532 * equal share of the model to each action.
534 XBT_PUBLIC(void) surf_host_model_init_ptask_L07();
536 /** \ingroup SURF_models
537 * \brief The list of all available host model models
539 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_host_model_description[];
541 /** \ingroup SURF_models
542 * \brief Initializes the platform with the current best network and cpu models at hand
544 * This platform model seperates the host model and the network model.
545 * The host model will be initialized with the model compound, the network model with the model LV08 (with cross
546 * traffic support) and the CPU model with the model Cas01.
547 * Such model is subject to modification with warning in the ChangeLog so monitor it!
549 XBT_PUBLIC(void) surf_vm_model_init_HL13();
551 /** \ingroup SURF_simulation
552 * \brief List of hosts for which one want to be notified if they ever restart.
554 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
556 /*** SURF Globals **************************/
558 /** \ingroup SURF_simulation
559 * \brief Initialize SURF
560 * \param argc argument number
561 * \param argv arguments
563 * This function has to be called to initialize the common structures. Then you will have to create the environment by
564 * calling e.g. surf_host_model_init_CM02()
566 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
568 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
570 /** \ingroup SURF_simulation
571 * \brief Finish simulation initialization
573 * This function must be called before the first call to surf_solve()
575 XBT_PUBLIC(void) surf_presolve();
577 /** \ingroup SURF_simulation
578 * \brief Performs a part of the simulation
579 * \param max_date Maximum date to update the simulation to, or -1
580 * \return the elapsed time, or -1.0 if no event could be executed
582 * This function execute all possible events, update the action states and returns the time elapsed.
583 * When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
584 * when you call surf_solve.
585 * Note that the returned elapsed time can be zero.
587 XBT_PUBLIC(double) surf_solve(double max_date);
589 /** \ingroup SURF_simulation
590 * \brief Return the current time
592 * Return the current time in millisecond.
594 XBT_PUBLIC(double) surf_get_clock();
596 /** \ingroup SURF_simulation
603 XBT_PUBLIC(void) surf_exit();
605 /* Prototypes of the functions that handle the properties */
606 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;// the prop set for the currently parsed element (also used in SIMIX)
608 /* surf parse file related (public because called from a test suite) */
609 XBT_PUBLIC(void) parse_platform_file(const char *file);
611 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
612 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
615 * Returns the initial path. On Windows the initial path is the current directory for the current process in the other
616 * case the function returns "./" that represents the current directory on Unix/Linux platforms.
618 const char *__surf_get_initial_path();
620 /********** Tracing **********/
621 /* from surf_instr.c */
622 void TRACE_surf_action(surf_action_t surf_action, const char *category);
623 void TRACE_surf_alloc();
624 void TRACE_surf_release();
626 /* instr_routing.c */
627 void instr_routing_define_callbacks ();
628 void instr_new_variable_type (const char *new_typename, const char *color);
629 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
630 void instr_new_user_state_type (const char *father_type, const char *new_typename);
631 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
632 int instr_platform_traced ();
633 xbt_graph_t instr_routing_platform_graph ();
634 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);