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;
33 extern XBT_PRIVATE xbt_dynar_t surf_path;
48 class NetworkCm02Link;
51 class StorageActionLmm;
55 typedef simgrid::surf::Model surf_Model;
56 typedef simgrid::surf::CpuModel surf_CpuModel;
57 typedef simgrid::surf::Cpu surf_Cpu;
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_Cpu surf_Cpu;
75 typedef struct surf_HostModel surf_HostModel;
76 typedef struct surf_NetworkModel surf_NetworkModel;
77 typedef struct surf_StorageModel surf_StorageModel;
78 typedef struct surf_Resource surf_Resource;
79 typedef struct surf_ResourceLmm surf_ResourceLmm;
80 typedef struct surf_HostCLM03 surf_HostCLM03;
81 typedef struct surf_Host surf_Host;
82 typedef struct surf_NetworkCm02Link surf_NetworkCm02Link;
83 typedef struct surf_Action surf_Action;
84 typedef struct surf_ActionLmm surf_ActionLmm;
85 typedef struct surf_StorageActionLmm surf_StorageActionLmm;
89 /** @ingroup SURF_c_bindings
90 * \brief Model datatype
92 * Generic data structure for a model. The hosts,
93 * the CPUs and the network links are examples of models.
95 typedef surf_Model *surf_model_t;
96 typedef surf_CpuModel *surf_cpu_model_t;
97 typedef surf_Cpu* surf_cpu_t;
98 typedef surf_HostModel *surf_host_model_t;
99 typedef surf_NetworkModel *surf_network_model_t;
100 typedef surf_StorageModel *surf_storage_model_t;
102 typedef xbt_dictelm_t surf_resource_t;
103 typedef surf_Resource *surf_cpp_resource_t;
104 typedef surf_Host *surf_host_t;
105 typedef surf_Cpu *surf_cpu_t;
107 /** @ingroup SURF_c_bindings
108 * \brief Action structure
110 * Never create s_surf_action_t by yourself ! The actions are created
111 * on the fly when you call execute or communicate on a model.
113 * \see e_surf_action_state_t
115 typedef surf_Action *surf_action_t;
117 typedef struct surf_file *surf_file_t;
119 /** \brief Resource model description
121 struct surf_model_description {
123 const char *description;
124 void_f_void_t model_init_preparse;
126 typedef struct surf_model_description s_surf_model_description_t;
127 typedef struct surf_model_description* surf_model_description_t;
129 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table, const char *name);
130 XBT_PUBLIC(void) model_help(const char *category, s_surf_model_description_t * table);
132 /***************************/
133 /* Generic model object */
134 /***************************/
136 static inline void *surf_storage_resource_priv(const void *storage){
137 return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
140 static inline void *surf_storage_resource_by_name(const char *name){
141 return xbt_lib_get_elm_or_null(storage_lib, name);
144 /** @{ @ingroup SURF_c_bindings */
147 * @brief Pop an action from the done actions set
149 * @param model The model from which the action is extracted
150 * @return An action in done state
152 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
155 * @brief Pop an action from the failed actions set
157 * @param model The model from which the action is extracted
158 * @return An action in failed state
160 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
163 * @brief Get the size of the running action set of a model
165 * @param model The model
166 * @return The size of the running action set
168 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
170 /** @brief Create a file opening action on the given host */
171 XBT_PUBLIC(surf_action_t) surf_host_open(sg_host_t host, const char* fullpath);
173 /** @brief Create a file closing action on the given host */
174 XBT_PUBLIC(surf_action_t) surf_host_close(sg_host_t host, surf_file_t fd);
176 /** @brief Create a file reading action on the given host */
177 XBT_PUBLIC(surf_action_t) surf_host_read(sg_host_t host, surf_file_t fd, sg_size_t size);
179 /** @brief Create a file writing action on the given host */
180 XBT_PUBLIC(surf_action_t) surf_host_write(sg_host_t host, surf_file_t fd, sg_size_t size);
183 * @brief Get the information of a file descriptor
184 * @details The returned xbt_dynar_t contains:
185 * - the size of the file,
187 * - the storage name,
188 * - the storage typeId,
189 * - the storage content type
191 * @param host The surf host
192 * @param fd The file descriptor
193 * @return An xbt_dynar_t with the file information
195 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(sg_host_t host, surf_file_t fd);
198 * @brief Get the available space of the storage at the mount point
200 * @param resource The surf host
201 * @param name The mount point
202 * @return The amount of available space in bytes
204 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(sg_host_t resource, const char* name);
207 * @brief Get the used space of the storage at the mount point
209 * @param resource The surf host
210 * @param name The mount point
211 * @return The amount of used space in bytes
213 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(sg_host_t resource, const char* name);
216 * @brief Unlink a file descriptor
218 * @param host The surf host
219 * @param fd The file descriptor
221 * @return 0 if failed to unlink, 1 otherwise
223 XBT_PUBLIC(int) surf_host_unlink(sg_host_t host, surf_file_t fd);
226 * @brief Get the size of a file on a host
228 * @param host The surf host
229 * @param fd The file descriptor
231 * @return The size in bytes of the file
233 XBT_PUBLIC(size_t) surf_host_get_size(sg_host_t host, surf_file_t fd);
236 * @brief Get the current position of the file descriptor
238 * @param host The surf host
239 * @param fd The file descriptor
240 * @return The current position of the file descriptor
242 XBT_PUBLIC(size_t) surf_host_file_tell(sg_host_t host, surf_file_t fd);
245 * @brief Move a file to another location on the *same mount point*.
246 * @details [long description]
248 * @param host The surf host
249 * @param fd The file descriptor
250 * @param fullpath The new full path
252 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
254 XBT_PUBLIC(int) surf_host_file_move(sg_host_t host, surf_file_t fd, const char* fullpath);
257 * @brief Set the position indictator assiociated with the file descriptor to a new position
258 * @details [long description]
260 * @param host The surf host
261 * @param fd The file descriptor
262 * @param offset The offset from the origin
263 * @param origin Position used as a reference for the offset
264 * - SEEK_SET: beginning of the file
265 * - SEEK_CUR: current position indicator
266 * - SEEK_END: end of the file
267 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
269 XBT_PUBLIC(int) surf_host_file_seek(sg_host_t host, surf_file_t fd, sg_offset_t offset, int origin);
272 * @brief Get the content of a storage
274 * @param resource The surf storage
275 * @return A xbt_dict_t with path as keys and size in bytes as values
277 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
280 * @brief Get the size in bytes of a storage
282 * @param resource The surf storage
283 * @return The size in bytes of the storage
285 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
288 * @brief Get the available size in bytes of a storage
290 * @param resource The surf storage
291 * @return The available size in bytes of the storage
293 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
296 * @brief Get the size in bytes of a storage
298 * @param resource The surf storage
299 * @return The used size in bytes of the storage
301 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
303 /** @brief return the properties set associated to that storage */
304 XBT_PUBLIC(xbt_dict_t) surf_storage_get_properties(surf_resource_t resource);
307 * @brief [brief description]
308 * @details [long description]
310 * @param action The surf cpu action
311 * @param bound [description]
313 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
316 * @brief [brief description]
317 * @details [long description]
319 * @param action The surf network action
321 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
324 * @brief Get the file associated to a storage action
326 * @param action The surf storage action
327 * @return The file associated to a storage action
329 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
332 * @brief Get the result dictionary of an ls action
334 * @param action The surf storage action
335 * @return The dictionry listing a path
337 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
341 * @brief Get the host the storage is attached to
343 * @param resource The surf storage
344 * @return The host name
347 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
351 /**************************************/
352 /* Implementations of model object */
353 /**************************************/
355 /** \ingroup SURF_models
356 * \brief The CPU model object for the physical machine layer
358 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
360 /** \ingroup SURF_models
361 * \brief The CPU model object for the virtual machine layer
363 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
366 /** \ingroup SURF_models
367 * \brief Initializes the CPU model with the model Cas01
369 * By default, this model uses the lazy optimization mechanism that relies on partial invalidation in LMM and a heap
370 * for lazy action update.
371 * You can change this behavior by setting the cpu/optim configuration variable to a different value.
373 * You shouldn't have to call it by yourself.
375 XBT_PUBLIC(void) surf_cpu_model_init_Cas01();
377 /** \ingroup SURF_models
378 * \brief Initializes the CPU model with trace integration [Deprecated]
380 * You shouldn't have to call it by yourself.
382 XBT_PUBLIC(void) surf_cpu_model_init_ti();
384 /** \ingroup SURF_models
385 * \brief The list of all available optimization modes (both for cpu and networks).
386 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
388 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
390 /** \ingroup SURF_plugins
391 * \brief The list of all available surf plugins
393 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
395 /** \ingroup SURF_models
396 * \brief The list of all available cpu model models
398 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
400 /** \ingroup SURF_models
401 * \brief The network model
403 * When creating a new API on top on SURF, you shouldn't use the network model unless you know what you are doing.
404 * Only the host model should be accessed because depending on the platform model, the network model can be NULL.
406 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
408 /** \ingroup SURF_models
409 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
411 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud based on the model 'LV08' and
412 * different correction factors depending on the communication size (< 1KiB, < 64KiB, >= 64KiB).
413 * See comments in the code for more information.
415 * \see surf_host_model_init_SMPI()
417 XBT_PUBLIC(void) surf_network_model_init_SMPI();
419 /** \ingroup SURF_models
420 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
422 * This model impelments a variant of the contention model on Infinband networks based on
423 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
425 * \see surf_host_model_init_IB()
427 XBT_PUBLIC(void) surf_network_model_init_IB();
429 /** \ingroup SURF_models
430 * \brief Initializes the platform with the network model 'LegrandVelho'
432 * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for
433 * onelink and dogbone sharing scenarios. See comments in the code for more information.
435 * \see surf_host_model_init_LegrandVelho()
437 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho();
439 /** \ingroup SURF_models
440 * \brief Initializes the platform with the network model 'Constant'
442 * In this model, the communication time between two network cards is constant, hence no need for a routing table.
443 * This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This
444 * function is called in conjunction with surf_host_model_init_compound.
446 * \see surf_host_model_init_compound()
448 XBT_PUBLIC(void) surf_network_model_init_Constant();
450 /** \ingroup SURF_models
451 * \brief Initializes the platform with the network model CM02
453 * You sould call this function by yourself only if you plan using surf_host_model_init_compound.
454 * See comments in the code for more information.
456 XBT_PUBLIC(void) surf_network_model_init_CM02();
458 /** \ingroup SURF_models
459 * \brief Initializes the platform with the network model NS3
461 * This function is called by surf_host_model_init_NS3 or by yourself only if you plan using
462 * surf_host_model_init_compound
464 * \see surf_host_model_init_NS3()
466 XBT_PUBLIC(void) surf_network_model_init_NS3();
468 /** \ingroup SURF_models
469 * \brief Initializes the platform with the network model Reno
471 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
474 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
475 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
477 * Call this function only if you plan using surf_host_model_init_compound.
479 XBT_PUBLIC(void) surf_network_model_init_Reno();
481 /** \ingroup SURF_models
482 * \brief Initializes the platform with the network model Reno2
484 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
487 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
488 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
490 * Call this function only if you plan using surf_host_model_init_compound.
492 XBT_PUBLIC(void) surf_network_model_init_Reno2();
494 /** \ingroup SURF_models
495 * \brief Initializes the platform with the network model Vegas
497 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent to the proportional fairness.
500 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
501 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
503 * Call this function only if you plan using surf_host_model_init_compound.
505 XBT_PUBLIC(void) surf_network_model_init_Vegas();
507 /** \ingroup SURF_models
508 * \brief The list of all available network model models
510 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
512 /** \ingroup SURF_models
513 * \brief The storage model
515 XBT_PUBLIC(void) surf_storage_model_init_default();
517 /** \ingroup SURF_models
518 * \brief The list of all available storage modes.
519 * This storage mode can be set using --cfg=storage/model:...
521 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
523 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
525 /** \ingroup SURF_models
526 * \brief The host model
528 * Note that when you create an API on top of SURF, the host model should be the only one you use
529 * because depending on the platform model, the network model and the CPU model may not exist.
531 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
533 /** \ingroup SURF_models
534 * \brief Initializes the platform with a compound host model
536 * This function should be called after a cpu_model and a network_model have been set up.
538 XBT_PUBLIC(void) surf_host_model_init_compound();
540 /** \ingroup SURF_models
541 * \brief Initializes the platform with the current best network and cpu models at hand
543 * This platform model separates 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_host_model_init_current_default();
550 /** \ingroup SURF_models
551 * \brief Initializes the platform with the model L07
553 * With this model, only parallel tasks can be used. Resource sharing is done by identifying bottlenecks and giving an
554 * equal share of the model to each action.
556 XBT_PUBLIC(void) surf_host_model_init_ptask_L07();
558 /** \ingroup SURF_models
559 * \brief The list of all available host model models
561 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_host_model_description[];
563 /** \ingroup SURF_models
564 * \brief Initializes the platform with the current best network and cpu models at hand
566 * This platform model seperates the host model and the network model.
567 * The host model will be initialized with the model compound, the network model with the model LV08 (with cross
568 * traffic support) and the CPU model with the model Cas01.
569 * Such model is subject to modification with warning in the ChangeLog so monitor it!
571 XBT_PUBLIC(void) surf_vm_model_init_HL13();
573 /** \ingroup SURF_simulation
574 * \brief List of hosts for which one want to be notified if they ever restart.
576 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
578 /*** SURF Globals **************************/
580 /** \ingroup SURF_simulation
581 * \brief Initialize SURF
582 * \param argc argument number
583 * \param argv arguments
585 * This function has to be called to initialize the common structures. Then you will have to create the environment by
586 * calling e.g. surf_host_model_init_CM02()
588 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
590 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
592 /** \ingroup SURF_simulation
593 * \brief Finish simulation initialization
595 * This function must be called before the first call to surf_solve()
597 XBT_PUBLIC(void) surf_presolve();
599 /** \ingroup SURF_simulation
600 * \brief Performs a part of the simulation
601 * \param max_date Maximum date to update the simulation to, or -1
602 * \return the elapsed time, or -1.0 if no event could be executed
604 * This function execute all possible events, update the action states and returns the time elapsed.
605 * When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
606 * when you call surf_solve.
607 * Note that the returned elapsed time can be zero.
609 XBT_PUBLIC(double) surf_solve(double max_date);
611 /** \ingroup SURF_simulation
612 * \brief Return the current time
614 * Return the current time in millisecond.
616 XBT_PUBLIC(double) surf_get_clock();
618 /** \ingroup SURF_simulation
625 XBT_PUBLIC(void) surf_exit();
627 /* Prototypes of the functions that handle the properties */
628 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;// the prop set for the currently parsed element (also used in SIMIX)
629 /* The same for model_prop set*/
630 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
632 /* surf parse file related (public because called from a test suite) */
633 XBT_PUBLIC(void) parse_platform_file(const char *file);
635 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
636 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
639 * Returns the initial path. On Windows the initial path is the current directory for the current process in the other
640 * case the function returns "./" that represents the current directory on Unix/Linux platforms.
642 const char *__surf_get_initial_path();
644 /********** Tracing **********/
645 /* from surf_instr.c */
646 void TRACE_surf_action(surf_action_t surf_action, const char *category);
647 void TRACE_surf_alloc();
648 void TRACE_surf_release();
650 /* instr_routing.c */
651 void instr_routing_define_callbacks ();
652 void instr_new_variable_type (const char *new_typename, const char *color);
653 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
654 void instr_new_user_state_type (const char *father_type, const char *new_typename);
655 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
656 int instr_platform_traced ();
657 xbt_graph_t instr_routing_platform_graph ();
658 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
661 #endif /* SURF_SURF_H */