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;
55 class VMModel; // FIXME: KILLME
64 typedef simgrid::surf::Model surf_Model;
65 typedef simgrid::surf::CpuModel surf_CpuModel;
66 typedef simgrid::surf::HostModel surf_HostModel;
67 typedef simgrid::vm::VMModel surf_VMModel;
68 typedef simgrid::surf::NetworkModel surf_NetworkModel;
69 typedef simgrid::surf::StorageModel surf_StorageModel;
70 typedef simgrid::surf::Resource surf_Resource;
71 typedef simgrid::surf::ResourceLmm surf_ResourceLmm;
72 typedef simgrid::surf::HostImpl surf_Host;
73 typedef simgrid::surf::HostCLM03 surf_HostCLM03;
74 typedef simgrid::surf::NetworkCm02Link surf_NetworkCm02Link;
75 typedef simgrid::surf::Action surf_Action;
76 typedef simgrid::surf::ActionLmm surf_ActionLmm;
77 typedef simgrid::surf::StorageActionLmm surf_StorageActionLmm;
78 typedef simgrid::kernel::routing::RoutingPlatf surf_RoutingPlatf;
82 typedef struct surf_Model surf_Model;
83 typedef struct surf_CpuModel surf_CpuModel;
84 typedef struct surf_HostModel surf_HostModel;
85 typedef struct surf_VMModel surf_VMModel;
86 typedef struct surf_NetworkModel surf_NetworkModel;
87 typedef struct surf_StorageModel surf_StorageModel;
88 typedef struct surf_Resource surf_Resource;
89 typedef struct surf_ResourceLmm surf_ResourceLmm;
90 typedef struct surf_HostCLM03 surf_HostCLM03;
91 typedef struct surf_Host surf_Host;
92 typedef struct surf_NetworkCm02Link surf_NetworkCm02Link;
93 typedef struct surf_Action surf_Action;
94 typedef struct surf_ActionLmm surf_ActionLmm;
95 typedef struct surf_StorageActionLmm surf_StorageActionLmm;
96 typedef struct surf_RoutingPlatf surf_RoutingPlatf;
100 /** @ingroup SURF_c_bindings
101 * \brief Model datatype
103 * Generic data structure for a model. The hosts,
104 * the CPUs and the network links are examples of models.
106 typedef surf_Model *surf_model_t;
107 typedef surf_CpuModel *surf_cpu_model_t;
108 typedef surf_HostModel *surf_host_model_t;
109 typedef surf_VMModel *surf_vm_model_t;
110 typedef surf_NetworkModel *surf_network_model_t;
111 typedef surf_StorageModel *surf_storage_model_t;
113 typedef xbt_dictelm_t surf_resource_t;
114 typedef surf_Resource *surf_cpp_resource_t;
115 typedef surf_Host *surf_host_t;
116 typedef surf_Cpu *surf_cpu_t;
118 /** @ingroup SURF_c_bindings
119 * \brief Action structure
121 * Never create s_surf_action_t by yourself ! The actions are created
122 * on the fly when you call execute or communicate on a model.
124 * \see e_surf_action_state_t
126 typedef surf_Action *surf_action_t;
127 typedef surf_RoutingPlatf *routing_platf_t;
129 typedef struct surf_file *surf_file_t;
131 /** \brief Resource model description
133 struct surf_model_description {
135 const char *description;
136 void_f_void_t model_init_preparse;
138 typedef struct surf_model_description s_surf_model_description_t;
139 typedef struct surf_model_description* surf_model_description_t;
141 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table, const char *name);
142 XBT_PUBLIC(void) model_help(const char *category, s_surf_model_description_t * table);
144 /***************************/
145 /* Generic model object */
146 /***************************/
148 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
150 static inline void *surf_storage_resource_priv(const void *storage){
151 return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
154 static inline void *surf_storage_resource_by_name(const char *name){
155 return xbt_lib_get_elm_or_null(storage_lib, name);
158 /** @{ @ingroup SURF_c_bindings */
161 * @brief Pop an action from the done actions set
163 * @param model The model from which the action is extracted
164 * @return An action in done state
166 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
169 * @brief Pop an action from the failed actions set
171 * @param model The model from which the action is extracted
172 * @return An action in failed state
174 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
177 * @brief Get the size of the running action set of a model
179 * @param model The model
180 * @return The size of the running action set
182 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
184 /** @brief Create a sleep action on the given host */
185 XBT_PUBLIC(surf_action_t) surf_host_sleep(sg_host_t host, double duration);
187 /** @brief Create a file opening action on the given host */
188 XBT_PUBLIC(surf_action_t) surf_host_open(sg_host_t host, const char* fullpath);
190 /** @brief Create a file closing action on the given host */
191 XBT_PUBLIC(surf_action_t) surf_host_close(sg_host_t host, surf_file_t fd);
193 /** @brief Create a file reading action on the given host */
194 XBT_PUBLIC(surf_action_t) surf_host_read(sg_host_t host, surf_file_t fd, sg_size_t size);
196 /** @brief Create a file writing action on the given host */
197 XBT_PUBLIC(surf_action_t) surf_host_write(sg_host_t host, surf_file_t fd, sg_size_t size);
200 * @brief Get the information of a file descriptor
201 * @details The returned xbt_dynar_t contains:
202 * - the size of the file,
204 * - the storage name,
205 * - the storage typeId,
206 * - the storage content type
208 * @param host The surf host
209 * @param fd The file descriptor
210 * @return An xbt_dynar_t with the file information
212 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(sg_host_t host, surf_file_t fd);
215 * @brief Get the available space of the storage at the mount point
217 * @param resource The surf host
218 * @param name The mount point
219 * @return The amount of available space in bytes
221 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(sg_host_t resource, const char* name);
224 * @brief Get the used space of the storage at the mount point
226 * @param resource The surf host
227 * @param name The mount point
228 * @return The amount of used space in bytes
230 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(sg_host_t resource, const char* name);
233 * @brief Unlink a file descriptor
235 * @param host The surf host
236 * @param fd The file descriptor
238 * @return 0 if failed to unlink, 1 otherwise
240 XBT_PUBLIC(int) surf_host_unlink(sg_host_t host, surf_file_t fd);
243 * @brief Get the size of a file on a host
245 * @param host The surf host
246 * @param fd The file descriptor
248 * @return The size in bytes of the file
250 XBT_PUBLIC(size_t) surf_host_get_size(sg_host_t host, surf_file_t fd);
253 * @brief Get the current position of the file descriptor
255 * @param host The surf host
256 * @param fd The file descriptor
257 * @return The current position of the file descriptor
259 XBT_PUBLIC(size_t) surf_host_file_tell(sg_host_t host, surf_file_t fd);
262 * @brief Move a file to another location on the *same mount point*.
263 * @details [long description]
265 * @param host The surf host
266 * @param fd The file descriptor
267 * @param fullpath The new full path
269 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
271 XBT_PUBLIC(int) surf_host_file_move(sg_host_t host, surf_file_t fd, const char* fullpath);
274 * @brief Set the position indictator assiociated with the file descriptor to a new position
275 * @details [long description]
277 * @param host The surf host
278 * @param fd The file descriptor
279 * @param offset The offset from the origin
280 * @param origin Position used as a reference for the offset
281 * - SEEK_SET: beginning of the file
282 * - SEEK_CUR: current position indicator
283 * - SEEK_END: end of the file
284 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
286 XBT_PUBLIC(int) surf_host_file_seek(sg_host_t host, surf_file_t fd, sg_offset_t offset, int origin);
289 * @brief Get the content of a storage
291 * @param resource The surf storage
292 * @return A xbt_dict_t with path as keys and size in bytes as values
294 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
297 * @brief Get the size in bytes of a storage
299 * @param resource The surf storage
300 * @return The size in bytes of the storage
302 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
305 * @brief Get the available size in bytes of a storage
307 * @param resource The surf storage
308 * @return The available size in bytes of the storage
310 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
313 * @brief Get the size in bytes of a storage
315 * @param resource The surf storage
316 * @return The used size in bytes of the storage
318 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
320 /** @brief return the properties set associated to that storage */
321 XBT_PUBLIC(xbt_dict_t) surf_storage_get_properties(surf_resource_t resource);
324 * @brief [brief description]
325 * @details [long description]
327 * @param action The surf cpu action
328 * @param bound [description]
330 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
333 * @brief [brief description]
334 * @details [long description]
336 * @param action The surf network action
338 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
341 * @brief Get the file associated to a storage action
343 * @param action The surf storage action
344 * @return The file associated to a storage action
346 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
349 * @brief Get the result dictionary of an ls action
351 * @param action The surf storage action
352 * @return The dictionry listing a path
354 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
358 * @brief Get the host the storage is attached to
360 * @param resource The surf storage
361 * @return The host name
364 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
368 /**************************************/
369 /* Implementations of model object */
370 /**************************************/
372 /** \ingroup SURF_models
373 * \brief The CPU model object for the physical machine layer
375 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
377 /** \ingroup SURF_models
378 * \brief The CPU model object for the virtual machine layer
380 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
383 /** \ingroup SURF_models
384 * \brief Initializes the CPU model with the model Cas01
386 * By default, this model uses the lazy optimization mechanism that relies on partial invalidation in LMM and a heap
387 * for lazy action update.
388 * You can change this behavior by setting the cpu/optim configuration variable to a different value.
390 * You shouldn't have to call it by yourself.
392 XBT_PUBLIC(void) surf_cpu_model_init_Cas01();
394 /** \ingroup SURF_models
395 * \brief Initializes the CPU model with trace integration [Deprecated]
397 * You shouldn't have to call it by yourself.
399 XBT_PUBLIC(void) surf_cpu_model_init_ti();
401 /** \ingroup SURF_models
402 * \brief The list of all available optimization modes (both for cpu and networks).
403 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
405 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
407 /** \ingroup SURF_plugins
408 * \brief The list of all available surf plugins
410 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
412 /** \ingroup SURF_models
413 * \brief The list of all available cpu model models
415 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
417 /** \ingroup SURF_models
418 * \brief The network model
420 * When creating a new API on top on SURF, you shouldn't use the network model unless you know what you are doing.
421 * Only the host model should be accessed because depending on the platform model, the network model can be NULL.
423 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
425 /** \ingroup SURF_models
426 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
428 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud based on the model 'LV08' and
429 * different correction factors depending on the communication size (< 1KiB, < 64KiB, >= 64KiB).
430 * See comments in the code for more information.
432 * \see surf_host_model_init_SMPI()
434 XBT_PUBLIC(void) surf_network_model_init_SMPI();
436 /** \ingroup SURF_models
437 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
439 * This model impelments a variant of the contention model on Infinband networks based on
440 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
442 * \see surf_host_model_init_IB()
444 XBT_PUBLIC(void) surf_network_model_init_IB();
446 /** \ingroup SURF_models
447 * \brief Initializes the platform with the network model 'LegrandVelho'
449 * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for
450 * onelink and dogbone sharing scenarios. See comments in the code for more information.
452 * \see surf_host_model_init_LegrandVelho()
454 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho();
456 /** \ingroup SURF_models
457 * \brief Initializes the platform with the network model 'Constant'
459 * In this model, the communication time between two network cards is constant, hence no need for a routing table.
460 * This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This
461 * function is called in conjunction with surf_host_model_init_compound.
463 * \see surf_host_model_init_compound()
465 XBT_PUBLIC(void) surf_network_model_init_Constant();
467 /** \ingroup SURF_models
468 * \brief Initializes the platform with the network model CM02
470 * You sould call this function by yourself only if you plan using surf_host_model_init_compound.
471 * See comments in the code for more information.
473 XBT_PUBLIC(void) surf_network_model_init_CM02();
475 /** \ingroup SURF_models
476 * \brief Initializes the platform with the network model NS3
478 * This function is called by surf_host_model_init_NS3 or by yourself only if you plan using
479 * surf_host_model_init_compound
481 * \see surf_host_model_init_NS3()
483 XBT_PUBLIC(void) surf_network_model_init_NS3();
485 /** \ingroup SURF_models
486 * \brief Initializes the platform with the network model Reno
488 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
491 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
492 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
494 * Call this function only if you plan using surf_host_model_init_compound.
496 XBT_PUBLIC(void) surf_network_model_init_Reno();
498 /** \ingroup SURF_models
499 * \brief Initializes the platform with the network model Reno2
501 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
504 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
505 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
507 * Call this function only if you plan using surf_host_model_init_compound.
509 XBT_PUBLIC(void) surf_network_model_init_Reno2();
511 /** \ingroup SURF_models
512 * \brief Initializes the platform with the network model Vegas
514 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent to the proportional fairness.
517 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
518 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
520 * Call this function only if you plan using surf_host_model_init_compound.
522 XBT_PUBLIC(void) surf_network_model_init_Vegas();
524 /** \ingroup SURF_models
525 * \brief The list of all available network model models
527 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
529 /** \ingroup SURF_models
530 * \brief The storage model
532 XBT_PUBLIC(void) surf_storage_model_init_default();
534 /** \ingroup SURF_models
535 * \brief The list of all available storage modes.
536 * This storage mode can be set using --cfg=storage/model:...
538 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
540 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
542 /** \ingroup SURF_models
543 * \brief The host model
545 * Note that when you create an API on top of SURF, the host model should be the only one you use
546 * because depending on the platform model, the network model and the CPU model may not exist.
548 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
550 /** \ingroup SURF_models
551 * \brief The vm model
553 * Note that when you create an API on top of SURF,the vm model should be the only one you use
554 * because depending on the platform model, the network model and the CPU model may not exist.
556 XBT_PUBLIC_DATA(surf_vm_model_t) surf_vm_model;
558 /** \ingroup SURF_models
559 * \brief Initializes the platform with a compound host model
561 * This function should be called after a cpu_model and a network_model have been set up.
563 XBT_PUBLIC(void) surf_host_model_init_compound();
565 /** \ingroup SURF_models
566 * \brief Initializes the platform with the current best network and cpu models at hand
568 * This platform model separates the host model and the network model.
569 * The host model will be initialized with the model compound, the network model with the model LV08 (with cross
570 * traffic support) and the CPU model with the model Cas01.
571 * Such model is subject to modification with warning in the ChangeLog so monitor it!
573 XBT_PUBLIC(void) surf_host_model_init_current_default();
575 /** \ingroup SURF_models
576 * \brief Initializes the platform with the model L07
578 * With this model, only parallel tasks can be used. Resource sharing is done by identifying bottlenecks and giving an
579 * equal share of the model to each action.
581 XBT_PUBLIC(void) surf_host_model_init_ptask_L07();
583 /** \ingroup SURF_models
584 * \brief The list of all available host model models
586 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_host_model_description[];
588 /** \ingroup SURF_models
589 * \brief Initializes the platform with the current best network and cpu models at hand
591 * This platform model seperates the host model and the network model.
592 * The host model will be initialized with the model compound, the network model with the model LV08 (with cross
593 * traffic support) and the CPU model with the model Cas01.
594 * Such model is subject to modification with warning in the ChangeLog so monitor it!
596 XBT_PUBLIC(void) surf_vm_model_init_HL13();
598 /** \ingroup SURF_models
599 * \brief The list of all available vm model models
601 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_vm_model_description[];
603 /** \ingroup SURF_simulation
604 * \brief List of hosts for which one want to be notified if they ever restart.
606 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
608 /*** SURF Globals **************************/
610 /** \ingroup SURF_simulation
611 * \brief Initialize SURF
612 * \param argc argument number
613 * \param argv arguments
615 * This function has to be called to initialize the common structures. Then you will have to create the environment by
616 * calling e.g. surf_host_model_init_CM02()
618 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
620 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
622 /** \ingroup SURF_simulation
623 * \brief Finish simulation initialization
625 * This function must be called before the first call to surf_solve()
627 XBT_PUBLIC(void) surf_presolve();
629 /** \ingroup SURF_simulation
630 * \brief Performs a part of the simulation
631 * \param max_date Maximum date to update the simulation to, or -1
632 * \return the elapsed time, or -1.0 if no event could be executed
634 * This function execute all possible events, update the action states and returns the time elapsed.
635 * When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
636 * when you call surf_solve.
637 * Note that the returned elapsed time can be zero.
639 XBT_PUBLIC(double) surf_solve(double max_date);
641 /** \ingroup SURF_simulation
642 * \brief Return the current time
644 * Return the current time in millisecond.
646 XBT_PUBLIC(double) surf_get_clock();
648 /** \ingroup SURF_simulation
655 XBT_PUBLIC(void) surf_exit();
657 /* Prototypes of the functions that handle the properties */
658 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;// the prop set for the currently parsed element (also used in SIMIX)
659 /* The same for model_prop set*/
660 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
662 /* surf parse file related (public because called from a test suite) */
663 XBT_PUBLIC(void) parse_platform_file(const char *file);
665 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
666 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
668 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
671 * Returns the initial path. On Windows the initial path is the current directory for the current process in the other
672 * case the function returns "./" that represents the current directory on Unix/Linux platforms.
674 const char *__surf_get_initial_path();
676 /********** Tracing **********/
677 /* from surf_instr.c */
678 void TRACE_surf_action(surf_action_t surf_action, const char *category);
679 void TRACE_surf_alloc();
680 void TRACE_surf_release();
682 /* instr_routing.c */
683 void instr_routing_define_callbacks ();
684 void instr_new_variable_type (const char *new_typename, const char *color);
685 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
686 void instr_new_user_state_type (const char *father_type, const char *new_typename);
687 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
688 int instr_platform_traced ();
689 xbt_graph_t instr_routing_platform_graph ();
690 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
693 #endif /* _SURF_SURF_H */