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/portable.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;
37 SURF_NETWORK_ELEMENT_HOST=1, /* host type */
38 SURF_NETWORK_ELEMENT_ROUTER, /* router type */
39 SURF_NETWORK_ELEMENT_AS /* AS type */
40 } e_surf_network_element_type_t;
57 class NetworkCm02Link;
60 class StorageActionLmm;
67 typedef simgrid::surf::Model surf_Model;
68 typedef simgrid::surf::CpuModel surf_CpuModel;
69 typedef simgrid::surf::HostModel surf_HostModel;
70 typedef simgrid::surf::VMModel surf_VMModel;
71 typedef simgrid::surf::NetworkModel surf_NetworkModel;
72 typedef simgrid::surf::StorageModel surf_StorageModel;
73 typedef simgrid::surf::Resource surf_Resource;
74 typedef simgrid::surf::ResourceLmm surf_ResourceLmm;
75 typedef simgrid::surf::Host surf_Host;
76 typedef simgrid::surf::HostCLM03 surf_HostCLM03;
77 typedef simgrid::surf::NetworkCm02Link surf_NetworkCm02Link;
78 typedef simgrid::surf::Action surf_Action;
79 typedef simgrid::surf::ActionLmm surf_ActionLmm;
80 typedef simgrid::surf::StorageActionLmm surf_StorageActionLmm;
81 typedef simgrid::surf::RoutingPlatf surf_RoutingPlatf;
85 typedef struct surf_Model surf_Model;
86 typedef struct surf_CpuModel surf_CpuModel;
87 typedef struct surf_HostModel surf_HostModel;
88 typedef struct surf_VMModel surf_VMModel;
89 typedef struct surf_NetworkModel surf_NetworkModel;
90 typedef struct surf_StorageModel surf_StorageModel;
91 typedef struct surf_Resource surf_Resource;
92 typedef struct surf_ResourceLmm surf_ResourceLmm;
93 typedef struct surf_HostCLM03 surf_HostCLM03;
94 typedef struct surf_Host surf_Host;
95 typedef struct surf_NetworkCm02Link surf_NetworkCm02Link;
96 typedef struct surf_Action surf_Action;
97 typedef struct surf_ActionLmm surf_ActionLmm;
98 typedef struct surf_StorageActionLmm surf_StorageActionLmm;
99 typedef struct surf_RoutingPlatf surf_RoutingPlatf;
103 /** @ingroup SURF_c_bindings
104 * \brief Model datatype
106 * Generic data structure for a model. The hosts,
107 * the CPUs and the network links are examples of models.
109 typedef surf_Model *surf_model_t;
110 typedef surf_CpuModel *surf_cpu_model_t;
111 typedef surf_HostModel *surf_host_model_t;
112 typedef surf_VMModel *surf_vm_model_t;
113 typedef surf_NetworkModel *surf_network_model_t;
114 typedef surf_StorageModel *surf_storage_model_t;
116 typedef xbt_dictelm_t surf_resource_t;
117 typedef surf_Resource *surf_cpp_resource_t;
118 typedef surf_Host *surf_host_t;
119 typedef surf_Cpu *surf_cpu_t;
121 /** @ingroup SURF_c_bindings
122 * \brief Action structure
124 * Never create s_surf_action_t by yourself ! The actions are created
125 * on the fly when you call execute or communicate on a model.
127 * \see e_surf_action_state_t
129 typedef surf_Action *surf_action_t;
130 typedef surf_RoutingPlatf *routing_platf_t;
132 typedef struct surf_file *surf_file_t;
134 /** @Brief Specify that we use that action */
135 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
137 /** @brief Creates a new action.
139 * @param size The size is the one of the subtype you want to create
140 * @param cost initial value
141 * @param model to which model we should attach this action
142 * @param failed whether we should start this action in failed mode
144 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
145 surf_model_t model, int failed);
147 /** \brief Resource model description
149 typedef struct surf_model_description {
151 const char *description;
152 void_f_void_t model_init_preparse;
153 } s_surf_model_description_t, *surf_model_description_t;
155 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
157 XBT_PUBLIC(void) model_help(const char *category,
158 s_surf_model_description_t * table);
160 /** @ingroup SURF_interface
161 * @brief Action states
166 SURF_ACTION_READY = 0, /**< Ready */
167 SURF_ACTION_RUNNING, /**< Running */
168 SURF_ACTION_FAILED, /**< Task Failure */
169 SURF_ACTION_DONE, /**< Completed */
170 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
171 SURF_ACTION_NOT_IN_THE_SYSTEM /**< Not in the system anymore. Why did you ask ? */
172 } e_surf_action_state_t;
174 /** @ingroup SURF_vm_interface
178 /* FIXME: Where should the VM state be defined? */
180 SURF_VM_STATE_CREATED, /**< created, but not yet started */
181 SURF_VM_STATE_RUNNING,
182 SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
184 SURF_VM_STATE_SAVING, /**< Save/restore involves disk I/O, so there should be transition states. */
186 SURF_VM_STATE_RESTORING,
189 /***************************/
190 /* Generic model object */
191 /***************************/
193 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
195 static inline void *surf_storage_resource_priv(const void *storage){
196 return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
199 static inline void *surf_storage_resource_by_name(const char *name){
200 return xbt_lib_get_elm_or_null(storage_lib, name);
203 /** @{ @ingroup SURF_c_bindings */
206 * @brief Pop an action from the done actions set
208 * @param model The model from which the action is extracted
209 * @return An action in done state
211 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
214 * @brief Pop an action from the failed actions set
216 * @param model The model from which the action is extracted
217 * @return An action in failed state
219 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
222 * @brief Get the size of the running action set of a model
224 * @param model The model
225 * @return The size of the running action set
227 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
229 /** @brief Get the route (dynar of sg_link_t) between two hosts */
230 XBT_PUBLIC(xbt_dynar_t) surf_host_model_get_route(
231 surf_host_model_t model, sg_host_t src, sg_host_t dst);
233 /** @brief Create a new VM on the specified host */
234 XBT_PUBLIC(void) surf_vm_model_create(const char *name, sg_host_t host_PM);
236 /** @brief Create a communication between two hosts
238 * @param model The model which handle the communication
239 * @param src The source host
240 * @param dst The destination host
241 * @param size The amount of data (in bytes) needed to transfer
242 * @param rate [description]
243 * @return The action corresponding to the communication
245 XBT_PUBLIC(surf_action_t) surf_network_model_communicate(surf_network_model_t model, sg_host_t src, sg_host_t dst, double size, double rate);
248 * @brief Get the name of a surf resource (cpu, host, network, …)
250 * @param resource The surf resource
251 * @return The name of the surf resource
253 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
255 /** @brief Get the available speed of cpu associated to a host */
256 XBT_PUBLIC(double) surf_host_get_available_speed(sg_host_t host);
258 /** @brief Create a sleep action on the given host */
259 XBT_PUBLIC(surf_action_t) surf_host_sleep(sg_host_t host, double duration);
261 /** @brief Create a file opening action on the given host */
262 XBT_PUBLIC(surf_action_t) surf_host_open(sg_host_t host, const char* fullpath);
264 /** @brief Create a file closing action on the given host */
265 XBT_PUBLIC(surf_action_t) surf_host_close(sg_host_t host, surf_file_t fd);
267 /** @brief Create a file reading action on the given host */
268 XBT_PUBLIC(surf_action_t) surf_host_read(sg_host_t host, surf_file_t fd, sg_size_t size);
270 /** @brief Create a file writing action on the given host */
271 XBT_PUBLIC(surf_action_t) surf_host_write(sg_host_t host, surf_file_t fd, sg_size_t size);
274 * @brief Get the informations of a file descriptor
275 * @details The returned xbt_dynar_t contains:
276 * - the size of the file,
278 * - the storage name,
279 * - the storage typeId,
280 * - the storage content type
282 * @param host The surf host
283 * @param fd The file descriptor
284 * @return An xbt_dynar_t with the file informations
286 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(sg_host_t host, surf_file_t fd);
289 * @brief Get the available space of the storage at the mount point
291 * @param resource The surf host
292 * @param name The mount point
293 * @return The amount of available space in bytes
295 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(sg_host_t resource, const char* name);
298 * @brief Get the used space of the storage at the mount point
300 * @param resource The surf host
301 * @param name The mount point
302 * @return The amount of used space in bytes
304 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(sg_host_t resource, const char* name);
307 * @brief Destroy a VM
309 * @param resource The surf vm
311 XBT_PUBLIC(void) surf_vm_destroy(sg_host_t resource);
313 /** @brief Suspend a VM */
314 XBT_PUBLIC(void) surf_vm_suspend(sg_host_t resource);
316 /** @brief Resume a VM */
317 XBT_PUBLIC(void) surf_vm_resume(sg_host_t resource);
320 * @brief Save the VM (Not yet implemented)
322 * @param resource The surf vm
324 XBT_PUBLIC(void) surf_vm_save(sg_host_t resource);
327 * @brief Restore the VM (Not yet implemented)
329 * @param resource The surf vm
331 XBT_PUBLIC(void) surf_vm_restore(sg_host_t resource);
334 * @brief Migrate the VM to the destination host
336 * @param resource The surf vm
337 * @param ind_vm_ws_dest The destination host
339 XBT_PUBLIC(void) surf_vm_migrate(sg_host_t resource, sg_host_t ind_vm_ws_dest);
342 * @brief Get the physical machine hosting the VM
344 * @param resource The surf vm
345 * @return The physical machine hosting the VM
347 XBT_PUBLIC(sg_host_t) surf_vm_get_pm(sg_host_t resource);
350 * @brief [brief description]
351 * @details [long description]
353 * @param resource [description]
354 * @param bound [description]
356 XBT_PUBLIC(void) surf_vm_set_bound(sg_host_t resource, double bound);
359 * @brief [brief description]
360 * @details [long description]
362 * @param resource [description]
363 * @param cpu [description]
364 * @param mask [description]
366 XBT_PUBLIC(void) surf_vm_set_affinity(sg_host_t resource, sg_host_t cpu, unsigned long mask);
369 * @brief Unlink a file descriptor
371 * @param host The surf host
372 * @param fd The file descriptor
374 * @return 0 if failed to unlink, 1 otherwise
376 XBT_PUBLIC(int) surf_host_unlink(sg_host_t host, surf_file_t fd);
379 * @brief Get the size of a file on a host
381 * @param host The surf host
382 * @param fd The file descriptor
384 * @return The size in bytes of the file
386 XBT_PUBLIC(size_t) surf_host_get_size(sg_host_t host, surf_file_t fd);
389 * @brief Get the current position of the file descriptor
391 * @param host The surf host
392 * @param fd The file descriptor
393 * @return The current position of the file descriptor
395 XBT_PUBLIC(size_t) surf_host_file_tell(sg_host_t host, surf_file_t fd);
398 * @brief Move a file to another location on the *same mount point*.
399 * @details [long description]
401 * @param host The surf host
402 * @param fd The file descriptor
403 * @param fullpath The new full path
405 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
407 XBT_PUBLIC(int) surf_host_file_move(sg_host_t host, surf_file_t fd, const char* fullpath);
410 * @brief Set the position indictator assiociated with the file descriptor to a new position
411 * @details [long description]
413 * @param host The surf host
414 * @param fd The file descriptor
415 * @param offset The offset from the origin
416 * @param origin Position used as a reference for the offset
417 * - SEEK_SET: beginning of the file
418 * - SEEK_CUR: current position indicator
419 * - SEEK_END: end of the file
420 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
422 XBT_PUBLIC(int) surf_host_file_seek(sg_host_t host,
423 surf_file_t fd, sg_offset_t offset,
427 * @brief Get the content of a storage
429 * @param resource The surf storage
430 * @return A xbt_dict_t with path as keys and size in bytes as values
432 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
435 * @brief Get the size in bytes of a storage
437 * @param resource The surf storage
438 * @return The size in bytes of the storage
440 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
443 * @brief Get the available size in bytes of a storage
445 * @param resource The surf storage
446 * @return The available size in bytes of the storage
448 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
451 * @brief Get the size in bytes of a storage
453 * @param resource The surf storage
454 * @return The used size in bytes of the storage
456 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
458 /** @brief return the properties set associated to that storage */
459 XBT_PUBLIC(xbt_dict_t) surf_storage_get_properties(surf_resource_t resource);
462 * @brief [brief description]
463 * @details [long description]
465 * @param action The surf cpu action
466 * @param bound [description]
468 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
471 * @brief [brief description]
472 * @details [long description]
474 * @param action The surf network action
476 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
479 * @brief Get the file associated to a storage action
481 * @param action The surf storage action
482 * @return The file associated to a storage action
484 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
487 * @brief Get the result dictionary of an ls action
489 * @param action The surf storage action
490 * @return The dictionry listing a path
492 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
496 * @brief Get the host the storage is attached to
498 * @param resource The surf storage
499 * @return The host name
502 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
506 /**************************************/
507 /* Implementations of model object */
508 /**************************************/
510 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
511 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
513 /** \ingroup SURF_models
514 * \brief The CPU model object for the physical machine layer
516 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
518 /** \ingroup SURF_models
519 * \brief The CPU model object for the virtual machine layer
521 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
524 /** \ingroup SURF_models
525 * \brief Initializes the CPU model with the model Cas01
527 * By default, this model uses the lazy optimization mechanism that
528 * relies on partial invalidation in LMM and a heap for lazy action update.
529 * You can change this behavior by setting the cpu/optim configuration
530 * variable to a different value.
532 * You shouldn't have to call it by yourself.
534 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
536 /** \ingroup SURF_models
537 * \brief Initializes the CPU model with trace integration [Deprecated]
539 * You shouldn't have to call it by yourself.
541 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
543 /** \ingroup SURF_models
544 * \brief The list of all available optimization modes (both for cpu and networks).
545 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
547 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
549 /** \ingroup SURF_plugins
550 * \brief The list of all available surf plugins
552 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
554 /** \ingroup SURF_models
555 * \brief The list of all available cpu model models
557 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
559 /**\brief create new host bypass the parser
564 /** \ingroup SURF_models
565 * \brief The network model
567 * When creating a new API on top on SURF, you shouldn't use the
568 * network model unless you know what you are doing. Only the host
569 * model should be accessed because depending on the platform model,
570 * the network model can be NULL.
572 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
574 /** \ingroup SURF_models
575 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
577 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
578 * based on the model 'LV08' and different correction factors depending on the communication
579 * size (< 1KiB, < 64KiB, >= 64KiB).
580 * See comments in the code for more information.
582 * \see surf_host_model_init_SMPI()
584 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
586 /** \ingroup SURF_models
587 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
589 * This model impelments a variant of the contention model on Infinband networks based on
590 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
592 * \see surf_host_model_init_IB()
594 XBT_PUBLIC(void) surf_network_model_init_IB(void);
596 /** \ingroup SURF_models
597 * \brief Initializes the platform with the network model 'LegrandVelho'
599 * This model is proposed by Arnaud Legrand and Pedro Velho based on
600 * the results obtained with the GTNets simulator for onelink and
601 * dogbone sharing scenarios. See comments in the code for more information.
603 * \see surf_host_model_init_LegrandVelho()
605 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
607 /** \ingroup SURF_models
608 * \brief Initializes the platform with the network model 'Constant'
610 * In this model, the communication time between two network cards is
611 * constant, hence no need for a routing table. This is particularly
612 * usefull when simulating huge distributed algorithms where
613 * scalability is really an issue. This function is called in
614 * conjunction with surf_host_model_init_compound.
616 * \see surf_host_model_init_compound()
618 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
620 /** \ingroup SURF_models
621 * \brief Initializes the platform with the network model CM02
623 * You sould call this function by yourself only if you plan using
624 * surf_host_model_init_compound.
625 * See comments in the code for more information.
627 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
630 /** \ingroup SURF_models
631 * \brief Initializes the platform with the network model NS3
633 * This function is called by surf_host_model_init_NS3
634 * or by yourself only if you plan using surf_host_model_init_compound
636 * \see surf_host_model_init_NS3()
638 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
641 /** \ingroup SURF_models
642 * \brief Initializes the platform with the network model Reno
644 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
647 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
648 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
650 * Call this function only if you plan using surf_host_model_init_compound.
653 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
655 /** \ingroup SURF_models
656 * \brief Initializes the platform with the network model Reno2
658 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
661 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
662 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
664 * Call this function only if you plan using surf_host_model_init_compound.
667 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
669 /** \ingroup SURF_models
670 * \brief Initializes the platform with the network model Vegas
672 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
673 * to the proportional fairness.
676 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
677 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
679 * Call this function only if you plan using surf_host_model_init_compound.
682 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
684 /** \ingroup SURF_models
685 * \brief The list of all available network model models
687 XBT_PUBLIC_DATA(s_surf_model_description_t)
688 surf_network_model_description[];
690 /** \ingroup SURF_models
691 * \brief The storage model
693 XBT_PUBLIC(void) surf_storage_model_init_default(void);
695 /** \ingroup SURF_models
696 * \brief The list of all available storage modes.
697 * This storage mode can be set using --cfg=storage/model:...
699 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
701 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
703 /** \ingroup SURF_models
704 * \brief The host model
706 * Note that when you create an API on top of SURF,
707 * the host model should be the only one you use
708 * because depending on the platform model, the network model and the CPU model
711 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
713 /** \ingroup SURF_models
714 * \brief The vm model
716 * Note that when you create an API on top of SURF,
717 * the vm model should be the only one you use
718 * because depending on the platform model, the network model and the CPU model
721 XBT_PUBLIC_DATA(surf_vm_model_t) surf_vm_model;
723 /** \ingroup SURF_models
724 * \brief Initializes the platform with a compound host model
726 * This function should be called after a cpu_model and a
727 * network_model have been set up.
730 XBT_PUBLIC(void) surf_host_model_init_compound(void);
732 /** \ingroup SURF_models
733 * \brief Initializes the platform with the current best network and cpu models at hand
735 * This platform model separates the host model and the network model.
736 * The host model will be initialized with the model compound, the network
737 * model with the model LV08 (with cross traffic support) and the CPU model with
739 * Such model is subject to modification with warning in the ChangeLog so monitor it!
742 XBT_PUBLIC(void) surf_host_model_init_current_default(void);
744 /** \ingroup SURF_models
745 * \brief Initializes the platform with the model L07
747 * With this model, only parallel tasks can be used. Resource sharing
748 * is done by identifying bottlenecks and giving an equal share of
749 * the model to each action.
752 XBT_PUBLIC(void) surf_host_model_init_ptask_L07(void);
754 /** \ingroup SURF_models
755 * \brief The list of all available host model models
757 XBT_PUBLIC_DATA(s_surf_model_description_t)
758 surf_host_model_description[];
760 /** \ingroup SURF_models
761 * \brief Initializes the platform with the current best network and cpu models at hand
763 * This platform model seperates the host model and the network model.
764 * The host model will be initialized with the model compound, the network
765 * model with the model LV08 (with cross traffic support) and the CPU model with
767 * Such model is subject to modification with warning in the ChangeLog so monitor it!
770 XBT_PUBLIC(void) surf_vm_model_init_HL13(void);
772 /** \ingroup SURF_models
773 * \brief The list of all available vm model models
775 XBT_PUBLIC_DATA(s_surf_model_description_t)
776 surf_vm_model_description[];
778 /*******************************************/
780 /** \ingroup SURF_models
781 * \brief List of initialized models
783 XBT_PUBLIC_DATA(xbt_dynar_t) all_existing_models;
785 /** \ingroup SURF_simulation
786 * \brief List of hosts that have just restarted and whose autorestart process should be restarted.
788 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
790 /** \ingroup SURF_simulation
791 * \brief List of hosts for which one want to be notified if they ever restart.
793 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
795 /*******************************************/
796 /*** SURF Platform *************************/
797 /*******************************************/
798 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
799 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
800 XBT_PUBLIC_DATA(AS_t) surf_AS_get_by_name(const char * name);
801 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
802 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
803 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
805 /*******************************************/
806 /*** SURF Globals **************************/
807 /*******************************************/
809 /** \ingroup SURF_simulation
810 * \brief Initialize SURF
811 * \param argc argument number
812 * \param argv arguments
814 * This function has to be called to initialize the common
815 * structures. Then you will have to create the environment by
817 * e.g. surf_host_model_init_CM02()
819 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
821 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
823 /** \ingroup SURF_simulation
824 * \brief Finish simulation initialization
826 * This function must be called before the first call to surf_solve()
828 XBT_PUBLIC(void) surf_presolve(void);
830 /** \ingroup SURF_simulation
831 * \brief Performs a part of the simulation
832 * \param max_date Maximum date to update the simulation to, or -1
833 * \return the elapsed time, or -1.0 if no event could be executed
835 * This function execute all possible events, update the action states
836 * and returns the time elapsed.
837 * When you call execute or communicate on a model, the corresponding actions
838 * are not executed immediately but only when you call surf_solve.
839 * Note that the returned elapsed time can be zero.
841 XBT_PUBLIC(double) surf_solve(double max_date);
843 /** \ingroup SURF_simulation
844 * \brief Return the current time
846 * Return the current time in millisecond.
848 XBT_PUBLIC(double) surf_get_clock(void);
850 /** \ingroup SURF_simulation
857 XBT_PUBLIC(void) surf_exit(void);
859 /* Prototypes of the functions that handle the properties */
860 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
862 /* The same for model_prop set*/
863 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
865 /* surf parse file related (public because called from a test suite) */
866 XBT_PUBLIC(void) parse_platform_file(const char *file);
868 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
869 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
871 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
874 * Returns the initial path. On Windows the initial path is
875 * the current directory for the current process in the other
876 * case the function returns "./" that represents the current
877 * directory on Unix/Linux platforms.
879 const char *__surf_get_initial_path(void);
881 /********** Tracing **********/
882 /* from surf_instr.c */
883 void TRACE_surf_action(surf_action_t surf_action, const char *category);
884 void TRACE_surf_alloc(void);
885 void TRACE_surf_release(void);
887 /* instr_routing.c */
888 void instr_routing_define_callbacks (void);
889 void instr_new_variable_type (const char *new_typename, const char *color);
890 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
891 void instr_new_user_state_type (const char *father_type, const char *new_typename);
892 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
893 int instr_platform_traced (void);
894 xbt_graph_t instr_routing_platform_graph (void);
895 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
899 #endif /* _SURF_SURF_H */