1 /* Copyright (c) 2004-2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
11 #include "xbt/dynar.h"
13 #include "xbt/graph.h"
15 #include "xbt/config.h"
16 #include "src/internal_config.h"
17 #include "surf/surf_routing.h"
18 #include "surf/datatypes.h"
20 #include "surf/surf_routing.h"
21 #include "simgrid/datatypes.h"
22 #include "simgrid/forward.h"
25 /* Actions and models are highly connected structures... */
27 /* user-visible parameters */
28 extern XBT_PRIVATE double sg_tcp_gamma;
29 extern XBT_PRIVATE double sg_sender_gap;
30 extern XBT_PRIVATE double sg_latency_factor;
31 extern XBT_PRIVATE double sg_bandwidth_factor;
32 extern XBT_PRIVATE double sg_weight_S_parameter;
33 extern XBT_PRIVATE int sg_network_crosstraffic;
34 extern XBT_PRIVATE xbt_dynar_t surf_path;
49 class NetworkCm02Link;
52 class StorageActionLmm;
56 typedef simgrid::surf::Model surf_Model;
57 typedef simgrid::surf::CpuModel surf_CpuModel;
58 typedef simgrid::surf::HostModel surf_HostModel;
59 typedef simgrid::surf::NetworkModel surf_NetworkModel;
60 typedef simgrid::surf::StorageModel surf_StorageModel;
61 typedef simgrid::surf::Resource surf_Resource;
62 typedef simgrid::surf::ResourceLmm surf_ResourceLmm;
63 typedef simgrid::surf::HostImpl surf_Host;
64 typedef simgrid::surf::HostCLM03 surf_HostCLM03;
65 typedef simgrid::surf::NetworkCm02Link surf_NetworkCm02Link;
66 typedef simgrid::surf::Action surf_Action;
67 typedef simgrid::surf::ActionLmm surf_ActionLmm;
68 typedef simgrid::surf::StorageActionLmm surf_StorageActionLmm;
72 typedef struct surf_Model surf_Model;
73 typedef struct surf_CpuModel surf_CpuModel;
74 typedef struct surf_HostModel surf_HostModel;
75 typedef struct surf_NetworkModel surf_NetworkModel;
76 typedef struct surf_StorageModel surf_StorageModel;
77 typedef struct surf_Resource surf_Resource;
78 typedef struct surf_ResourceLmm surf_ResourceLmm;
79 typedef struct surf_HostCLM03 surf_HostCLM03;
80 typedef struct surf_Host surf_Host;
81 typedef struct surf_NetworkCm02Link surf_NetworkCm02Link;
82 typedef struct surf_Action surf_Action;
83 typedef struct surf_ActionLmm surf_ActionLmm;
84 typedef struct surf_StorageActionLmm surf_StorageActionLmm;
88 /** @ingroup SURF_c_bindings
89 * \brief Model datatype
91 * Generic data structure for a model. The hosts,
92 * the CPUs and the network links are examples of models.
94 typedef surf_Model *surf_model_t;
95 typedef surf_CpuModel *surf_cpu_model_t;
96 typedef surf_HostModel *surf_host_model_t;
97 typedef surf_NetworkModel *surf_network_model_t;
98 typedef surf_StorageModel *surf_storage_model_t;
100 typedef xbt_dictelm_t surf_resource_t;
101 typedef surf_Resource *surf_cpp_resource_t;
102 typedef surf_Host *surf_host_t;
103 typedef surf_Cpu *surf_cpu_t;
105 /** @ingroup SURF_c_bindings
106 * \brief Action structure
108 * Never create s_surf_action_t by yourself ! The actions are created
109 * on the fly when you call execute or communicate on a model.
111 * \see e_surf_action_state_t
113 typedef surf_Action *surf_action_t;
115 typedef struct surf_file *surf_file_t;
117 /** \brief Resource model description
119 struct surf_model_description {
121 const char *description;
122 void_f_void_t model_init_preparse;
124 typedef struct surf_model_description s_surf_model_description_t;
125 typedef struct surf_model_description* surf_model_description_t;
127 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table, const char *name);
128 XBT_PUBLIC(void) model_help(const char *category, s_surf_model_description_t * table);
130 /***************************/
131 /* Generic model object */
132 /***************************/
134 static inline void *surf_storage_resource_priv(const void *storage){
135 return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
138 static inline void *surf_storage_resource_by_name(const char *name){
139 return xbt_lib_get_elm_or_null(storage_lib, name);
142 /** @{ @ingroup SURF_c_bindings */
145 * @brief Pop an action from the done actions set
147 * @param model The model from which the action is extracted
148 * @return An action in done state
150 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
153 * @brief Pop an action from the failed actions set
155 * @param model The model from which the action is extracted
156 * @return An action in failed state
158 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
161 * @brief Get the size of the running action set of a model
163 * @param model The model
164 * @return The size of the running action set
166 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
168 /** @brief Create a sleep action on the given host */
169 XBT_PUBLIC(surf_action_t) surf_host_sleep(sg_host_t host, double duration);
171 /** @brief Create a file opening action on the given host */
172 XBT_PUBLIC(surf_action_t) surf_host_open(sg_host_t host, const char* fullpath);
174 /** @brief Create a file closing action on the given host */
175 XBT_PUBLIC(surf_action_t) surf_host_close(sg_host_t host, surf_file_t fd);
177 /** @brief Create a file reading action on the given host */
178 XBT_PUBLIC(surf_action_t) surf_host_read(sg_host_t host, surf_file_t fd, sg_size_t size);
180 /** @brief Create a file writing action on the given host */
181 XBT_PUBLIC(surf_action_t) surf_host_write(sg_host_t host, surf_file_t fd, sg_size_t size);
184 * @brief Get the information of a file descriptor
185 * @details The returned xbt_dynar_t contains:
186 * - the size of the file,
188 * - the storage name,
189 * - the storage typeId,
190 * - the storage content type
192 * @param host The surf host
193 * @param fd The file descriptor
194 * @return An xbt_dynar_t with the file information
196 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(sg_host_t host, surf_file_t fd);
199 * @brief Get the available space of the storage at the mount point
201 * @param resource The surf host
202 * @param name The mount point
203 * @return The amount of available space in bytes
205 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(sg_host_t resource, const char* name);
208 * @brief Get the used space of the storage at the mount point
210 * @param resource The surf host
211 * @param name The mount point
212 * @return The amount of used space in bytes
214 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(sg_host_t resource, const char* name);
217 * @brief Unlink a file descriptor
219 * @param host The surf host
220 * @param fd The file descriptor
222 * @return 0 if failed to unlink, 1 otherwise
224 XBT_PUBLIC(int) surf_host_unlink(sg_host_t host, surf_file_t fd);
227 * @brief Get the size of a file on a host
229 * @param host The surf host
230 * @param fd The file descriptor
232 * @return The size in bytes of the file
234 XBT_PUBLIC(size_t) surf_host_get_size(sg_host_t host, surf_file_t fd);
237 * @brief Get the current position of the file descriptor
239 * @param host The surf host
240 * @param fd The file descriptor
241 * @return The current position of the file descriptor
243 XBT_PUBLIC(size_t) surf_host_file_tell(sg_host_t host, surf_file_t fd);
246 * @brief Move a file to another location on the *same mount point*.
247 * @details [long description]
249 * @param host The surf host
250 * @param fd The file descriptor
251 * @param fullpath The new full path
253 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
255 XBT_PUBLIC(int) surf_host_file_move(sg_host_t host, surf_file_t fd, const char* fullpath);
258 * @brief Set the position indictator assiociated with the file descriptor to a new position
259 * @details [long description]
261 * @param host The surf host
262 * @param fd The file descriptor
263 * @param offset The offset from the origin
264 * @param origin Position used as a reference for the offset
265 * - SEEK_SET: beginning of the file
266 * - SEEK_CUR: current position indicator
267 * - SEEK_END: end of the file
268 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
270 XBT_PUBLIC(int) surf_host_file_seek(sg_host_t host, surf_file_t fd, sg_offset_t offset, int origin);
273 * @brief Get the content of a storage
275 * @param resource The surf storage
276 * @return A xbt_dict_t with path as keys and size in bytes as values
278 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
281 * @brief Get the size in bytes of a storage
283 * @param resource The surf storage
284 * @return The size in bytes of the storage
286 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
289 * @brief Get the available size in bytes of a storage
291 * @param resource The surf storage
292 * @return The available size in bytes of the storage
294 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
297 * @brief Get the size in bytes of a storage
299 * @param resource The surf storage
300 * @return The used size in bytes of the storage
302 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
304 /** @brief return the properties set associated to that storage */
305 XBT_PUBLIC(xbt_dict_t) surf_storage_get_properties(surf_resource_t resource);
308 * @brief [brief description]
309 * @details [long description]
311 * @param action The surf cpu action
312 * @param bound [description]
314 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
317 * @brief [brief description]
318 * @details [long description]
320 * @param action The surf network action
322 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
325 * @brief Get the file associated to a storage action
327 * @param action The surf storage action
328 * @return The file associated to a storage action
330 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
333 * @brief Get the result dictionary of an ls action
335 * @param action The surf storage action
336 * @return The dictionry listing a path
338 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
342 * @brief Get the host the storage is attached to
344 * @param resource The surf storage
345 * @return The host name
348 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
352 /**************************************/
353 /* Implementations of model object */
354 /**************************************/
356 /** \ingroup SURF_models
357 * \brief The CPU model object for the physical machine layer
359 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
361 /** \ingroup SURF_models
362 * \brief The CPU model object for the virtual machine layer
364 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
367 /** \ingroup SURF_models
368 * \brief Initializes the CPU model with the model Cas01
370 * By default, this model uses the lazy optimization mechanism that relies on partial invalidation in LMM and a heap
371 * for lazy action update.
372 * You can change this behavior by setting the cpu/optim configuration variable to a different value.
374 * You shouldn't have to call it by yourself.
376 XBT_PUBLIC(void) surf_cpu_model_init_Cas01();
378 /** \ingroup SURF_models
379 * \brief Initializes the CPU model with trace integration [Deprecated]
381 * You shouldn't have to call it by yourself.
383 XBT_PUBLIC(void) surf_cpu_model_init_ti();
385 /** \ingroup SURF_models
386 * \brief The list of all available optimization modes (both for cpu and networks).
387 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
389 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
391 /** \ingroup SURF_plugins
392 * \brief The list of all available surf plugins
394 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
396 /** \ingroup SURF_models
397 * \brief The list of all available cpu model models
399 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
401 /** \ingroup SURF_models
402 * \brief The network model
404 * When creating a new API on top on SURF, you shouldn't use the network model unless you know what you are doing.
405 * Only the host model should be accessed because depending on the platform model, the network model can be NULL.
407 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
409 /** \ingroup SURF_models
410 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
412 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud based on the model 'LV08' and
413 * different correction factors depending on the communication size (< 1KiB, < 64KiB, >= 64KiB).
414 * See comments in the code for more information.
416 * \see surf_host_model_init_SMPI()
418 XBT_PUBLIC(void) surf_network_model_init_SMPI();
420 /** \ingroup SURF_models
421 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
423 * This model impelments a variant of the contention model on Infinband networks based on
424 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
426 * \see surf_host_model_init_IB()
428 XBT_PUBLIC(void) surf_network_model_init_IB();
430 /** \ingroup SURF_models
431 * \brief Initializes the platform with the network model 'LegrandVelho'
433 * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for
434 * onelink and dogbone sharing scenarios. See comments in the code for more information.
436 * \see surf_host_model_init_LegrandVelho()
438 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho();
440 /** \ingroup SURF_models
441 * \brief Initializes the platform with the network model 'Constant'
443 * In this model, the communication time between two network cards is constant, hence no need for a routing table.
444 * This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This
445 * function is called in conjunction with surf_host_model_init_compound.
447 * \see surf_host_model_init_compound()
449 XBT_PUBLIC(void) surf_network_model_init_Constant();
451 /** \ingroup SURF_models
452 * \brief Initializes the platform with the network model CM02
454 * You sould call this function by yourself only if you plan using surf_host_model_init_compound.
455 * See comments in the code for more information.
457 XBT_PUBLIC(void) surf_network_model_init_CM02();
459 /** \ingroup SURF_models
460 * \brief Initializes the platform with the network model NS3
462 * This function is called by surf_host_model_init_NS3 or by yourself only if you plan using
463 * surf_host_model_init_compound
465 * \see surf_host_model_init_NS3()
467 XBT_PUBLIC(void) surf_network_model_init_NS3();
469 /** \ingroup SURF_models
470 * \brief Initializes the platform with the network model Reno
472 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
475 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
476 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
478 * Call this function only if you plan using surf_host_model_init_compound.
480 XBT_PUBLIC(void) surf_network_model_init_Reno();
482 /** \ingroup SURF_models
483 * \brief Initializes the platform with the network model Reno2
485 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
488 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
489 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
491 * Call this function only if you plan using surf_host_model_init_compound.
493 XBT_PUBLIC(void) surf_network_model_init_Reno2();
495 /** \ingroup SURF_models
496 * \brief Initializes the platform with the network model Vegas
498 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent to the proportional fairness.
501 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
502 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
504 * Call this function only if you plan using surf_host_model_init_compound.
506 XBT_PUBLIC(void) surf_network_model_init_Vegas();
508 /** \ingroup SURF_models
509 * \brief The list of all available network model models
511 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
513 /** \ingroup SURF_models
514 * \brief The storage model
516 XBT_PUBLIC(void) surf_storage_model_init_default();
518 /** \ingroup SURF_models
519 * \brief The list of all available storage modes.
520 * This storage mode can be set using --cfg=storage/model:...
522 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
524 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
526 /** \ingroup SURF_models
527 * \brief The host model
529 * Note that when you create an API on top of SURF, the host model should be the only one you use
530 * because depending on the platform model, the network model and the CPU model may not exist.
532 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
534 /** \ingroup SURF_models
535 * \brief Initializes the platform with a compound host model
537 * This function should be called after a cpu_model and a network_model have been set up.
539 XBT_PUBLIC(void) surf_host_model_init_compound();
541 /** \ingroup SURF_models
542 * \brief Initializes the platform with the current best network and cpu models at hand
544 * This platform model separates 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_host_model_init_current_default();
551 /** \ingroup SURF_models
552 * \brief Initializes the platform with the model L07
554 * With this model, only parallel tasks can be used. Resource sharing is done by identifying bottlenecks and giving an
555 * equal share of the model to each action.
557 XBT_PUBLIC(void) surf_host_model_init_ptask_L07();
559 /** \ingroup SURF_models
560 * \brief The list of all available host model models
562 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_host_model_description[];
564 /** \ingroup SURF_models
565 * \brief Initializes the platform with the current best network and cpu models at hand
567 * This platform model seperates the host model and the network model.
568 * The host model will be initialized with the model compound, the network model with the model LV08 (with cross
569 * traffic support) and the CPU model with the model Cas01.
570 * Such model is subject to modification with warning in the ChangeLog so monitor it!
572 XBT_PUBLIC(void) surf_vm_model_init_HL13();
574 /** \ingroup SURF_simulation
575 * \brief List of hosts for which one want to be notified if they ever restart.
577 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
579 /*** SURF Globals **************************/
581 /** \ingroup SURF_simulation
582 * \brief Initialize SURF
583 * \param argc argument number
584 * \param argv arguments
586 * This function has to be called to initialize the common structures. Then you will have to create the environment by
587 * calling e.g. surf_host_model_init_CM02()
589 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
591 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
593 /** \ingroup SURF_simulation
594 * \brief Finish simulation initialization
596 * This function must be called before the first call to surf_solve()
598 XBT_PUBLIC(void) surf_presolve();
600 /** \ingroup SURF_simulation
601 * \brief Performs a part of the simulation
602 * \param max_date Maximum date to update the simulation to, or -1
603 * \return the elapsed time, or -1.0 if no event could be executed
605 * This function execute all possible events, update the action states and returns the time elapsed.
606 * When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
607 * when you call surf_solve.
608 * Note that the returned elapsed time can be zero.
610 XBT_PUBLIC(double) surf_solve(double max_date);
612 /** \ingroup SURF_simulation
613 * \brief Return the current time
615 * Return the current time in millisecond.
617 XBT_PUBLIC(double) surf_get_clock();
619 /** \ingroup SURF_simulation
626 XBT_PUBLIC(void) surf_exit();
628 /* Prototypes of the functions that handle the properties */
629 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;// the prop set for the currently parsed element (also used in SIMIX)
630 /* The same for model_prop set*/
631 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
633 /* surf parse file related (public because called from a test suite) */
634 XBT_PUBLIC(void) parse_platform_file(const char *file);
636 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
637 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
640 * Returns the initial path. On Windows the initial path is the current directory for the current process in the other
641 * case the function returns "./" that represents the current directory on Unix/Linux platforms.
643 const char *__surf_get_initial_path();
645 /********** Tracing **********/
646 /* from surf_instr.c */
647 void TRACE_surf_action(surf_action_t surf_action, const char *category);
648 void TRACE_surf_alloc();
649 void TRACE_surf_release();
651 /* instr_routing.c */
652 void instr_routing_define_callbacks ();
653 void instr_new_variable_type (const char *new_typename, const char *color);
654 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
655 void instr_new_user_state_type (const char *father_type, const char *new_typename);
656 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
657 int instr_platform_traced ();
658 xbt_graph_t instr_routing_platform_graph ();
659 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
662 #endif /* _SURF_SURF_H */