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 "simgrid/datatypes.h"
20 #include "simgrid/forward.h"
23 /* Actions and models are highly connected structures... */
25 /* user-visible parameters */
26 extern XBT_PRIVATE double sg_tcp_gamma;
27 extern XBT_PRIVATE double sg_sender_gap;
28 extern XBT_PRIVATE double sg_latency_factor;
29 extern XBT_PRIVATE double sg_bandwidth_factor;
30 extern XBT_PRIVATE double sg_weight_S_parameter;
31 extern XBT_PRIVATE int sg_network_crosstraffic;
44 class NetworkCm02Link;
49 typedef simgrid::surf::Model surf_Model;
50 typedef simgrid::surf::CpuModel surf_CpuModel;
51 typedef simgrid::surf::Cpu surf_Cpu;
52 typedef simgrid::surf::HostModel surf_HostModel;
53 typedef simgrid::surf::NetworkModel surf_NetworkModel;
54 typedef simgrid::surf::StorageImpl surf_Storage;
55 typedef simgrid::surf::StorageModel surf_StorageModel;
56 typedef simgrid::surf::Resource surf_Resource;
57 typedef simgrid::surf::HostImpl surf_Host;
58 typedef simgrid::surf::Action surf_Action;
62 typedef struct surf_Model surf_Model;
63 typedef struct surf_CpuModel surf_CpuModel;
64 typedef struct surf_Cpu surf_Cpu;
65 typedef struct surf_HostModel surf_HostModel;
66 typedef struct surf_NetworkModel surf_NetworkModel;
67 typedef struct surf_StorageImpl surf_Storage;
68 typedef struct surf_StorageModel surf_StorageModel;
69 typedef struct surf_Resource surf_Resource;
70 typedef struct surf_Host surf_Host;
71 typedef struct surf_Action surf_Action;
75 /** @ingroup SURF_c_bindings
76 * \brief Model datatype
78 * Generic data structure for a model. The hosts,
79 * the CPUs and the network links are examples of models.
81 typedef surf_Model *surf_model_t;
82 typedef surf_CpuModel *surf_cpu_model_t;
83 typedef surf_HostModel *surf_host_model_t;
84 typedef surf_NetworkModel *surf_network_model_t;
85 typedef surf_StorageModel *surf_storage_model_t;
86 typedef surf_Storage* surf_storage_t;
88 typedef xbt_dictelm_t surf_resource_t;
90 /** @ingroup SURF_c_bindings
91 * \brief Action structure
93 * Never create s_surf_action_t by yourself ! The actions are created
94 * on the fly when you call execute or communicate on a model.
96 * \see e_surf_action_state_t
98 typedef surf_Action *surf_action_t;
100 typedef struct surf_file *surf_file_t;
102 /** \brief Resource model description
104 struct surf_model_description {
106 const char *description;
107 void_f_void_t model_init_preparse;
109 typedef struct surf_model_description s_surf_model_description_t;
110 typedef struct surf_model_description* surf_model_description_t;
112 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table, const char *name);
113 XBT_PUBLIC(void) model_help(const char *category, s_surf_model_description_t * table);
115 /***************************/
116 /* Generic model object */
117 /***************************/
119 static inline surf_storage_t surf_storage_resource_priv(const void* storage)
121 return (surf_storage_t)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
124 static inline void *surf_storage_resource_by_name(const char *name){
125 return xbt_lib_get_elm_or_null(storage_lib, name);
128 /** @{ @ingroup SURF_c_bindings */
131 * @brief Pop an action from the done actions set
133 * @param model The model from which the action is extracted
134 * @return An action in done state
136 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
139 * @brief Pop an action from the failed actions set
141 * @param model The model from which the action is extracted
142 * @return An action in failed state
144 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
147 * @brief Get the size of the running action set of a model
149 * @param model The model
150 * @return The size of the running action set
152 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
154 /** @brief Create a file opening action on the given host */
155 XBT_PUBLIC(surf_action_t) surf_host_open(sg_host_t host, const char* fullpath);
157 /** @brief Create a file closing action on the given host */
158 XBT_PUBLIC(surf_action_t) surf_host_close(sg_host_t host, surf_file_t fd);
160 /** @brief Create a file reading action on the given host */
161 XBT_PUBLIC(surf_action_t) surf_host_read(sg_host_t host, surf_file_t fd, sg_size_t size);
163 /** @brief Create a file writing action on the given host */
164 XBT_PUBLIC(surf_action_t) surf_host_write(sg_host_t host, surf_file_t fd, sg_size_t size);
167 * @brief Get the information of a file descriptor
168 * @details The returned xbt_dynar_t contains:
169 * - the size of the file,
171 * - the storage name,
172 * - the storage typeId,
173 * - the storage content type
175 * @param host The surf host
176 * @param fd The file descriptor
177 * @return An xbt_dynar_t with the file information
179 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(sg_host_t host, surf_file_t fd);
182 * @brief Get the available space of the storage at the mount point
184 * @param resource The surf host
185 * @param name The mount point
186 * @return The amount of available space in bytes
188 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(sg_host_t resource, const char* name);
191 * @brief Get the used space of the storage at the mount point
193 * @param resource The surf host
194 * @param name The mount point
195 * @return The amount of used space in bytes
197 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(sg_host_t resource, const char* name);
200 * @brief Unlink a file descriptor
202 * @param host The surf host
203 * @param fd The file descriptor
205 * @return 0 if failed to unlink, 1 otherwise
207 XBT_PUBLIC(int) surf_host_unlink(sg_host_t host, surf_file_t fd);
210 * @brief Get the size of a file on a host
212 * @param host The surf host
213 * @param fd The file descriptor
215 * @return The size in bytes of the file
217 XBT_PUBLIC(size_t) surf_host_get_size(sg_host_t host, surf_file_t fd);
220 * @brief Get the current position of the file descriptor
222 * @param host The surf host
223 * @param fd The file descriptor
224 * @return The current position of the file descriptor
226 XBT_PUBLIC(size_t) surf_host_file_tell(sg_host_t host, surf_file_t fd);
229 * @brief Move a file to another location on the *same mount point*.
230 * @details [long description]
232 * @param host The surf host
233 * @param fd The file descriptor
234 * @param fullpath The new full path
236 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
238 XBT_PUBLIC(int) surf_host_file_move(sg_host_t host, surf_file_t fd, const char* fullpath);
241 * @brief Set the position indictator assiociated with the file descriptor to a new position
242 * @details [long description]
244 * @param host The surf host
245 * @param fd The file descriptor
246 * @param offset The offset from the origin
247 * @param origin Position used as a reference for the offset
248 * - SEEK_SET: beginning of the file
249 * - SEEK_CUR: current position indicator
250 * - SEEK_END: end of the file
251 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
253 XBT_PUBLIC(int) surf_host_file_seek(sg_host_t host, surf_file_t fd, sg_offset_t offset, int origin);
256 * @brief Get the size in bytes of a storage
258 * @param resource The surf storage
259 * @return The size in bytes of the storage
261 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
264 * @brief Get the available size in bytes of a storage
266 * @param resource The surf storage
267 * @return The available size in bytes of the storage
269 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
272 * @brief Get the size in bytes of a storage
274 * @param resource The surf storage
275 * @return The used size in bytes of the storage
277 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
279 /** @brief return the properties set associated to that storage */
280 XBT_PUBLIC(xbt_dict_t) surf_storage_get_properties(surf_resource_t resource);
283 * @brief [brief description]
284 * @details [long description]
286 * @param action The surf cpu action
287 * @param bound [description]
289 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
292 * @brief [brief description]
293 * @details [long description]
295 * @param action The surf network action
297 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
300 * @brief Get the file associated to a storage action
302 * @param action The surf storage action
303 * @return The file associated to a storage action
305 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
308 * @brief Get the result dictionary of an ls action
310 * @param action The surf storage action
311 * @return The dictionry listing a path
313 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
317 * @brief Get the host the storage is attached to
319 * @param resource The surf storage
320 * @return The host name
323 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
324 XBT_PUBLIC(const char * ) surf_storage_get_name(surf_resource_t resource);
328 /**************************************/
329 /* Implementations of model object */
330 /**************************************/
332 /** \ingroup SURF_models
333 * \brief The CPU model object for the physical machine layer
335 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
337 /** \ingroup SURF_models
338 * \brief The CPU model object for the virtual machine layer
340 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
343 /** \ingroup SURF_models
344 * \brief Initializes the CPU model with the model Cas01
346 * By default, this model uses the lazy optimization mechanism that relies on partial invalidation in LMM and a heap
347 * for lazy action update.
348 * You can change this behavior by setting the cpu/optim configuration variable to a different value.
350 * You shouldn't have to call it by yourself.
352 XBT_PUBLIC(void) surf_cpu_model_init_Cas01();
354 /** \ingroup SURF_models
355 * \brief Initializes the CPU model with trace integration [Deprecated]
357 * You shouldn't have to call it by yourself.
359 XBT_PUBLIC(void) surf_cpu_model_init_ti();
361 /** \ingroup SURF_models
362 * \brief The list of all available optimization modes (both for cpu and networks).
363 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
365 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
367 /** \ingroup SURF_plugins
368 * \brief The list of all available surf plugins
370 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
372 /** \ingroup SURF_models
373 * \brief The list of all available cpu model models
375 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
377 /** \ingroup SURF_models
378 * \brief The network model
380 * When creating a new API on top on SURF, you shouldn't use the network model unless you know what you are doing.
381 * Only the host model should be accessed because depending on the platform model, the network model can be NULL.
383 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
385 /** \ingroup SURF_models
386 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
388 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud based on the model 'LV08' and
389 * different correction factors depending on the communication size (< 1KiB, < 64KiB, >= 64KiB).
390 * See comments in the code for more information.
392 * \see surf_host_model_init_SMPI()
394 XBT_PUBLIC(void) surf_network_model_init_SMPI();
396 /** \ingroup SURF_models
397 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
399 * This model impelments a variant of the contention model on Infinband networks based on
400 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
402 * \see surf_host_model_init_IB()
404 XBT_PUBLIC(void) surf_network_model_init_IB();
406 /** \ingroup SURF_models
407 * \brief Initializes the platform with the network model 'LegrandVelho'
409 * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for
410 * onelink and dogbone sharing scenarios. See comments in the code for more information.
412 * \see surf_host_model_init_LegrandVelho()
414 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho();
416 /** \ingroup SURF_models
417 * \brief Initializes the platform with the network model 'Constant'
419 * In this model, the communication time between two network cards is constant, hence no need for a routing table.
420 * This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This
421 * function is called in conjunction with surf_host_model_init_compound.
423 * \see surf_host_model_init_compound()
425 XBT_PUBLIC(void) surf_network_model_init_Constant();
427 /** \ingroup SURF_models
428 * \brief Initializes the platform with the network model CM02
430 * You sould call this function by yourself only if you plan using surf_host_model_init_compound.
431 * See comments in the code for more information.
433 XBT_PUBLIC(void) surf_network_model_init_CM02();
435 /** \ingroup SURF_models
436 * \brief Initializes the platform with the network model NS3
438 * This function is called by surf_host_model_init_NS3 or by yourself only if you plan using
439 * surf_host_model_init_compound
441 * \see surf_host_model_init_NS3()
443 XBT_PUBLIC(void) surf_network_model_init_NS3();
445 /** \ingroup SURF_models
446 * \brief Initializes the platform with the network model Reno
448 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
451 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
452 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
454 * Call this function only if you plan using surf_host_model_init_compound.
456 XBT_PUBLIC(void) surf_network_model_init_Reno();
458 /** \ingroup SURF_models
459 * \brief Initializes the platform with the network model Reno2
461 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
464 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
465 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
467 * Call this function only if you plan using surf_host_model_init_compound.
469 XBT_PUBLIC(void) surf_network_model_init_Reno2();
471 /** \ingroup SURF_models
472 * \brief Initializes the platform with the network model Vegas
474 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent to the proportional fairness.
477 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
478 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
480 * Call this function only if you plan using surf_host_model_init_compound.
482 XBT_PUBLIC(void) surf_network_model_init_Vegas();
484 /** \ingroup SURF_models
485 * \brief The list of all available network model models
487 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
489 /** \ingroup SURF_models
490 * \brief The storage model
492 XBT_PUBLIC(void) surf_storage_model_init_default();
494 /** \ingroup SURF_models
495 * \brief The list of all available storage modes.
496 * This storage mode can be set using --cfg=storage/model:...
498 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
500 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
502 /** \ingroup SURF_models
503 * \brief The host model
505 * Note that when you create an API on top of SURF, the host model should be the only one you use
506 * because depending on the platform model, the network model and the CPU model may not exist.
508 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
510 /** \ingroup SURF_models
511 * \brief Initializes the platform with a compound host model
513 * This function should be called after a cpu_model and a network_model have been set up.
515 XBT_PUBLIC(void) surf_host_model_init_compound();
517 /** \ingroup SURF_models
518 * \brief Initializes the platform with the current best network and cpu models at hand
520 * This platform model separates the host model and the network model.
521 * The host model will be initialized with the model compound, the network model with the model LV08 (with cross
522 * traffic support) and the CPU model with the model Cas01.
523 * Such model is subject to modification with warning in the ChangeLog so monitor it!
525 XBT_PUBLIC(void) surf_host_model_init_current_default();
527 /** \ingroup SURF_models
528 * \brief Initializes the platform with the model L07
530 * With this model, only parallel tasks can be used. Resource sharing is done by identifying bottlenecks and giving an
531 * equal share of the model to each action.
533 XBT_PUBLIC(void) surf_host_model_init_ptask_L07();
535 /** \ingroup SURF_models
536 * \brief The list of all available host model models
538 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_host_model_description[];
540 /** \ingroup SURF_models
541 * \brief Initializes the platform with the current best network and cpu models at hand
543 * This platform model seperates the host model and the network model.
544 * The host model will be initialized with the model compound, the network model with the model LV08 (with cross
545 * traffic support) and the CPU model with the model Cas01.
546 * Such model is subject to modification with warning in the ChangeLog so monitor it!
548 XBT_PUBLIC(void) surf_vm_model_init_HL13();
550 /** \ingroup SURF_simulation
551 * \brief List of hosts for which one want to be notified if they ever restart.
553 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
555 /*** SURF Globals **************************/
557 /** \ingroup SURF_simulation
558 * \brief Initialize SURF
559 * \param argc argument number
560 * \param argv arguments
562 * This function has to be called to initialize the common structures. Then you will have to create the environment by
563 * calling e.g. surf_host_model_init_CM02()
565 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
567 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
569 /** \ingroup SURF_simulation
570 * \brief Finish simulation initialization
572 * This function must be called before the first call to surf_solve()
574 XBT_PUBLIC(void) surf_presolve();
576 /** \ingroup SURF_simulation
577 * \brief Performs a part of the simulation
578 * \param max_date Maximum date to update the simulation to, or -1
579 * \return the elapsed time, or -1.0 if no event could be executed
581 * This function execute all possible events, update the action states and returns the time elapsed.
582 * When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
583 * when you call surf_solve.
584 * Note that the returned elapsed time can be zero.
586 XBT_PUBLIC(double) surf_solve(double max_date);
588 /** \ingroup SURF_simulation
589 * \brief Return the current time
591 * Return the current time in millisecond.
593 XBT_PUBLIC(double) surf_get_clock();
595 /** \ingroup SURF_simulation
602 XBT_PUBLIC(void) surf_exit();
604 /* Prototypes of the functions that handle the properties */
605 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;// the prop set for the currently parsed element (also used in SIMIX)
607 /* surf parse file related (public because called from a test suite) */
608 XBT_PUBLIC(void) parse_platform_file(const char *file);
610 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
611 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
614 * Returns the initial path. On Windows the initial path is the current directory for the current process in the other
615 * case the function returns "./" that represents the current directory on Unix/Linux platforms.
617 const char *__surf_get_initial_path();
619 /********** Tracing **********/
620 /* from surf_instr.c */
621 void TRACE_surf_action(surf_action_t surf_action, const char *category);
622 void TRACE_surf_alloc();
623 void TRACE_surf_release();
625 /* instr_routing.c */
626 void instr_routing_define_callbacks ();
627 void instr_new_variable_type (const char *new_typename, const char *color);
628 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
629 void instr_new_user_state_type (const char *father_type, const char *new_typename);
630 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
631 int instr_platform_traced ();
632 xbt_graph_t instr_routing_platform_graph ();
633 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);