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;
51 class NetworkCm02Link;
54 class StorageActionLmm;
59 typedef simgrid::surf::Model surf_Model;
60 typedef simgrid::surf::CpuModel surf_CpuModel;
61 typedef simgrid::surf::HostModel surf_HostModel;
62 typedef simgrid::surf::VMModel surf_VMModel;
63 typedef simgrid::surf::NetworkModel surf_NetworkModel;
64 typedef simgrid::surf::StorageModel surf_StorageModel;
65 typedef simgrid::surf::Resource surf_Resource;
66 typedef simgrid::surf::ResourceLmm surf_ResourceLmm;
67 typedef simgrid::surf::HostImpl surf_Host;
68 typedef simgrid::surf::HostCLM03 surf_HostCLM03;
69 typedef simgrid::surf::NetworkCm02Link surf_NetworkCm02Link;
70 typedef simgrid::surf::Action surf_Action;
71 typedef simgrid::surf::ActionLmm surf_ActionLmm;
72 typedef simgrid::surf::StorageActionLmm surf_StorageActionLmm;
73 typedef simgrid::surf::RoutingPlatf surf_RoutingPlatf;
77 typedef struct surf_Model surf_Model;
78 typedef struct surf_CpuModel surf_CpuModel;
79 typedef struct surf_HostModel surf_HostModel;
80 typedef struct surf_VMModel surf_VMModel;
81 typedef struct surf_NetworkModel surf_NetworkModel;
82 typedef struct surf_StorageModel surf_StorageModel;
83 typedef struct surf_Resource surf_Resource;
84 typedef struct surf_ResourceLmm surf_ResourceLmm;
85 typedef struct surf_HostCLM03 surf_HostCLM03;
86 typedef struct surf_Host surf_Host;
87 typedef struct surf_NetworkCm02Link surf_NetworkCm02Link;
88 typedef struct surf_Action surf_Action;
89 typedef struct surf_ActionLmm surf_ActionLmm;
90 typedef struct surf_StorageActionLmm surf_StorageActionLmm;
91 typedef struct surf_RoutingPlatf surf_RoutingPlatf;
95 /** @ingroup SURF_c_bindings
96 * \brief Model datatype
98 * Generic data structure for a model. The hosts,
99 * the CPUs and the network links are examples of models.
101 typedef surf_Model *surf_model_t;
102 typedef surf_CpuModel *surf_cpu_model_t;
103 typedef surf_HostModel *surf_host_model_t;
104 typedef surf_VMModel *surf_vm_model_t;
105 typedef surf_NetworkModel *surf_network_model_t;
106 typedef surf_StorageModel *surf_storage_model_t;
108 typedef xbt_dictelm_t surf_resource_t;
109 typedef surf_Resource *surf_cpp_resource_t;
110 typedef surf_Host *surf_host_t;
111 typedef surf_Cpu *surf_cpu_t;
113 /** @ingroup SURF_c_bindings
114 * \brief Action structure
116 * Never create s_surf_action_t by yourself ! The actions are created
117 * on the fly when you call execute or communicate on a model.
119 * \see e_surf_action_state_t
121 typedef surf_Action *surf_action_t;
122 typedef surf_RoutingPlatf *routing_platf_t;
124 typedef struct surf_file *surf_file_t;
126 /** \brief Resource model description
128 struct surf_model_description {
130 const char *description;
131 void_f_void_t model_init_preparse;
133 typedef struct surf_model_description s_surf_model_description_t;
134 typedef struct surf_model_description* surf_model_description_t;
136 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table, const char *name);
137 XBT_PUBLIC(void) model_help(const char *category, s_surf_model_description_t * table);
139 /** @ingroup SURF_vm_interface */
140 /* FIXME: Where should the VM state be defined? */
142 SURF_VM_STATE_CREATED, /**< created, but not yet started */
143 SURF_VM_STATE_RUNNING,
144 SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
146 SURF_VM_STATE_SAVING, /**< Save/restore involves disk I/O, so there should be transition states. */
148 SURF_VM_STATE_RESTORING,
151 /***************************/
152 /* Generic model object */
153 /***************************/
155 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
157 static inline void *surf_storage_resource_priv(const void *storage){
158 return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
161 static inline void *surf_storage_resource_by_name(const char *name){
162 return xbt_lib_get_elm_or_null(storage_lib, name);
165 /** @{ @ingroup SURF_c_bindings */
168 * @brief Pop an action from the done actions set
170 * @param model The model from which the action is extracted
171 * @return An action in done state
173 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
176 * @brief Pop an action from the failed actions set
178 * @param model The model from which the action is extracted
179 * @return An action in failed state
181 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
184 * @brief Get the size of the running action set of a model
186 * @param model The model
187 * @return The size of the running action set
189 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
191 /** @brief Create a new VM on the specified host */
192 XBT_PUBLIC(void) surf_vm_model_create(const char *name, sg_host_t host_PM);
194 /** @brief Create a communication between two hosts
196 * @param model The model which handle the communication
197 * @param src The source host
198 * @param dst The destination host
199 * @param size The amount of data (in bytes) needed to transfer
200 * @param rate [description]
201 * @return The action corresponding to the communication
203 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);
205 /** @brief Create a sleep action on the given host */
206 XBT_PUBLIC(surf_action_t) surf_host_sleep(sg_host_t host, double duration);
208 /** @brief Create a file opening action on the given host */
209 XBT_PUBLIC(surf_action_t) surf_host_open(sg_host_t host, const char* fullpath);
211 /** @brief Create a file closing action on the given host */
212 XBT_PUBLIC(surf_action_t) surf_host_close(sg_host_t host, surf_file_t fd);
214 /** @brief Create a file reading action on the given host */
215 XBT_PUBLIC(surf_action_t) surf_host_read(sg_host_t host, surf_file_t fd, sg_size_t size);
217 /** @brief Create a file writing action on the given host */
218 XBT_PUBLIC(surf_action_t) surf_host_write(sg_host_t host, surf_file_t fd, sg_size_t size);
221 * @brief Get the information of a file descriptor
222 * @details The returned xbt_dynar_t contains:
223 * - the size of the file,
225 * - the storage name,
226 * - the storage typeId,
227 * - the storage content type
229 * @param host The surf host
230 * @param fd The file descriptor
231 * @return An xbt_dynar_t with the file information
233 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(sg_host_t host, surf_file_t fd);
236 * @brief Get the available space of the storage at the mount point
238 * @param resource The surf host
239 * @param name The mount point
240 * @return The amount of available space in bytes
242 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(sg_host_t resource, const char* name);
245 * @brief Get the used space of the storage at the mount point
247 * @param resource The surf host
248 * @param name The mount point
249 * @return The amount of used space in bytes
251 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(sg_host_t resource, const char* name);
254 * @brief Destroy a VM
256 * @param resource The surf vm
258 XBT_PUBLIC(void) surf_vm_destroy(sg_host_t resource);
260 /** @brief Suspend a VM */
261 XBT_PUBLIC(void) surf_vm_suspend(sg_host_t resource);
263 /** @brief Resume a VM */
264 XBT_PUBLIC(void) surf_vm_resume(sg_host_t resource);
267 * @brief Save the VM (Not yet implemented)
269 * @param resource The surf vm
271 XBT_PUBLIC(void) surf_vm_save(sg_host_t resource);
274 * @brief Restore the VM (Not yet implemented)
276 * @param resource The surf vm
278 XBT_PUBLIC(void) surf_vm_restore(sg_host_t resource);
281 * @brief Migrate the VM to the destination host
283 * @param resource The surf vm
284 * @param ind_vm_ws_dest The destination host
286 XBT_PUBLIC(void) surf_vm_migrate(sg_host_t resource, sg_host_t ind_vm_ws_dest);
289 * @brief Get the physical machine hosting the VM
291 * @param resource The surf vm
292 * @return The physical machine hosting the VM
294 XBT_PUBLIC(sg_host_t) surf_vm_get_pm(sg_host_t resource);
297 * @brief [brief description]
298 * @details [long description]
300 * @param resource [description]
301 * @param bound [description]
303 XBT_PUBLIC(void) surf_vm_set_bound(sg_host_t resource, double bound);
306 * @brief [brief description]
307 * @details [long description]
309 * @param resource [description]
310 * @param cpu [description]
311 * @param mask [description]
313 XBT_PUBLIC(void) surf_vm_set_affinity(sg_host_t resource, sg_host_t cpu, unsigned long mask);
316 * @brief Unlink a file descriptor
318 * @param host The surf host
319 * @param fd The file descriptor
321 * @return 0 if failed to unlink, 1 otherwise
323 XBT_PUBLIC(int) surf_host_unlink(sg_host_t host, surf_file_t fd);
326 * @brief Get the size of a file on a host
328 * @param host The surf host
329 * @param fd The file descriptor
331 * @return The size in bytes of the file
333 XBT_PUBLIC(size_t) surf_host_get_size(sg_host_t host, surf_file_t fd);
336 * @brief Get the current position of the file descriptor
338 * @param host The surf host
339 * @param fd The file descriptor
340 * @return The current position of the file descriptor
342 XBT_PUBLIC(size_t) surf_host_file_tell(sg_host_t host, surf_file_t fd);
345 * @brief Move a file to another location on the *same mount point*.
346 * @details [long description]
348 * @param host The surf host
349 * @param fd The file descriptor
350 * @param fullpath The new full path
352 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
354 XBT_PUBLIC(int) surf_host_file_move(sg_host_t host, surf_file_t fd, const char* fullpath);
357 * @brief Set the position indictator assiociated with the file descriptor to a new position
358 * @details [long description]
360 * @param host The surf host
361 * @param fd The file descriptor
362 * @param offset The offset from the origin
363 * @param origin Position used as a reference for the offset
364 * - SEEK_SET: beginning of the file
365 * - SEEK_CUR: current position indicator
366 * - SEEK_END: end of the file
367 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
369 XBT_PUBLIC(int) surf_host_file_seek(sg_host_t host,
370 surf_file_t fd, sg_offset_t offset,
374 * @brief Get the content of a storage
376 * @param resource The surf storage
377 * @return A xbt_dict_t with path as keys and size in bytes as values
379 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
382 * @brief Get the size in bytes of a storage
384 * @param resource The surf storage
385 * @return The size in bytes of the storage
387 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
390 * @brief Get the available size in bytes of a storage
392 * @param resource The surf storage
393 * @return The available size in bytes of the storage
395 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
398 * @brief Get the size in bytes of a storage
400 * @param resource The surf storage
401 * @return The used size in bytes of the storage
403 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
405 /** @brief return the properties set associated to that storage */
406 XBT_PUBLIC(xbt_dict_t) surf_storage_get_properties(surf_resource_t resource);
409 * @brief [brief description]
410 * @details [long description]
412 * @param action The surf cpu action
413 * @param bound [description]
415 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
418 * @brief [brief description]
419 * @details [long description]
421 * @param action The surf network action
423 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
426 * @brief Get the file associated to a storage action
428 * @param action The surf storage action
429 * @return The file associated to a storage action
431 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
434 * @brief Get the result dictionary of an ls action
436 * @param action The surf storage action
437 * @return The dictionry listing a path
439 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
443 * @brief Get the host the storage is attached to
445 * @param resource The surf storage
446 * @return The host name
449 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
453 /**************************************/
454 /* Implementations of model object */
455 /**************************************/
457 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
459 /** \ingroup SURF_models
460 * \brief The CPU model object for the physical machine layer
462 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
464 /** \ingroup SURF_models
465 * \brief The CPU model object for the virtual machine layer
467 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
470 /** \ingroup SURF_models
471 * \brief Initializes the CPU model with the model Cas01
473 * By default, this model uses the lazy optimization mechanism that relies on partial invalidation in LMM and a heap
474 * for lazy action update.
475 * You can change this behavior by setting the cpu/optim configuration variable to a different value.
477 * You shouldn't have to call it by yourself.
479 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
481 /** \ingroup SURF_models
482 * \brief Initializes the CPU model with trace integration [Deprecated]
484 * You shouldn't have to call it by yourself.
486 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
488 /** \ingroup SURF_models
489 * \brief The list of all available optimization modes (both for cpu and networks).
490 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
492 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
494 /** \ingroup SURF_plugins
495 * \brief The list of all available surf plugins
497 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
499 /** \ingroup SURF_models
500 * \brief The list of all available cpu model models
502 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
504 /** \ingroup SURF_models
505 * \brief The network model
507 * When creating a new API on top on SURF, you shouldn't use the network model unless you know what you are doing.
508 * Only the host model should be accessed because depending on the platform model, the network model can be NULL.
510 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
512 /** \ingroup SURF_models
513 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
515 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud based on the model 'LV08' and
516 * different correction factors depending on the communication size (< 1KiB, < 64KiB, >= 64KiB).
517 * See comments in the code for more information.
519 * \see surf_host_model_init_SMPI()
521 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
523 /** \ingroup SURF_models
524 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
526 * This model impelments a variant of the contention model on Infinband networks based on
527 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
529 * \see surf_host_model_init_IB()
531 XBT_PUBLIC(void) surf_network_model_init_IB(void);
533 /** \ingroup SURF_models
534 * \brief Initializes the platform with the network model 'LegrandVelho'
536 * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for
537 * onelink and dogbone sharing scenarios. See comments in the code for more information.
539 * \see surf_host_model_init_LegrandVelho()
541 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
543 /** \ingroup SURF_models
544 * \brief Initializes the platform with the network model 'Constant'
546 * In this model, the communication time between two network cards is constant, hence no need for a routing table.
547 * This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This
548 * function is called in conjunction with surf_host_model_init_compound.
550 * \see surf_host_model_init_compound()
552 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
554 /** \ingroup SURF_models
555 * \brief Initializes the platform with the network model CM02
557 * You sould call this function by yourself only if you plan using surf_host_model_init_compound.
558 * See comments in the code for more information.
560 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
563 /** \ingroup SURF_models
564 * \brief Initializes the platform with the network model NS3
566 * This function is called by surf_host_model_init_NS3 or by yourself only if you plan using
567 * surf_host_model_init_compound
569 * \see surf_host_model_init_NS3()
571 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
574 /** \ingroup SURF_models
575 * \brief Initializes the platform with the network model Reno
577 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
580 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
581 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
583 * Call this function only if you plan using surf_host_model_init_compound.
585 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
587 /** \ingroup SURF_models
588 * \brief Initializes the platform with the network model Reno2
590 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
593 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
594 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
596 * Call this function only if you plan using surf_host_model_init_compound.
598 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
600 /** \ingroup SURF_models
601 * \brief Initializes the platform with the network model Vegas
603 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent to the proportional fairness.
606 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
607 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
609 * Call this function only if you plan using surf_host_model_init_compound.
611 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
613 /** \ingroup SURF_models
614 * \brief The list of all available network model models
616 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
618 /** \ingroup SURF_models
619 * \brief The storage model
621 XBT_PUBLIC(void) surf_storage_model_init_default(void);
623 /** \ingroup SURF_models
624 * \brief The list of all available storage modes.
625 * This storage mode can be set using --cfg=storage/model:...
627 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
629 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
631 /** \ingroup SURF_models
632 * \brief The host model
634 * Note that when you create an API on top of SURF, the host model should be the only one you use
635 * because depending on the platform model, the network model and the CPU model may not exist.
637 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
639 /** \ingroup SURF_models
640 * \brief The vm model
642 * Note that when you create an API on top of SURF,the vm model should be the only one you use
643 * because depending on the platform model, the network model and the CPU model may not exist.
645 XBT_PUBLIC_DATA(surf_vm_model_t) surf_vm_model;
647 /** \ingroup SURF_models
648 * \brief Initializes the platform with a compound host model
650 * This function should be called after a cpu_model and a network_model have been set up.
652 XBT_PUBLIC(void) surf_host_model_init_compound(void);
654 /** \ingroup SURF_models
655 * \brief Initializes the platform with the current best network and cpu models at hand
657 * This platform model separates the host model and the network model.
658 * The host model will be initialized with the model compound, the network model with the model LV08 (with cross
659 * traffic support) and the CPU model with the model Cas01.
660 * Such model is subject to modification with warning in the ChangeLog so monitor it!
662 XBT_PUBLIC(void) surf_host_model_init_current_default(void);
664 /** \ingroup SURF_models
665 * \brief Initializes the platform with the model L07
667 * With this model, only parallel tasks can be used. Resource sharing is done by identifying bottlenecks and giving an
668 * equal share of the model to each action.
670 XBT_PUBLIC(void) surf_host_model_init_ptask_L07(void);
672 /** \ingroup SURF_models
673 * \brief The list of all available host model models
675 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_host_model_description[];
677 /** \ingroup SURF_models
678 * \brief Initializes the platform with the current best network and cpu models at hand
680 * This platform model seperates the host model and the network model.
681 * The host model will be initialized with the model compound, the network model with the model LV08 (with cross
682 * traffic support) and the CPU model with the model Cas01.
683 * Such model is subject to modification with warning in the ChangeLog so monitor it!
685 XBT_PUBLIC(void) surf_vm_model_init_HL13(void);
687 /** \ingroup SURF_models
688 * \brief The list of all available vm model models
690 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_vm_model_description[];
692 /** \ingroup SURF_models
693 * \brief List of initialized models
695 XBT_PUBLIC_DATA(xbt_dynar_t) all_existing_models;
697 /** \ingroup SURF_simulation
698 * \brief List of hosts that have just restarted and whose autorestart process should be restarted.
700 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
702 /** \ingroup SURF_simulation
703 * \brief List of hosts for which one want to be notified if they ever restart.
705 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
707 /*** SURF Globals **************************/
709 /** \ingroup SURF_simulation
710 * \brief Initialize SURF
711 * \param argc argument number
712 * \param argv arguments
714 * This function has to be called to initialize the common structures. Then you will have to create the environment by
715 * calling e.g. surf_host_model_init_CM02()
717 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
719 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
721 /** \ingroup SURF_simulation
722 * \brief Finish simulation initialization
724 * This function must be called before the first call to surf_solve()
726 XBT_PUBLIC(void) surf_presolve(void);
728 /** \ingroup SURF_simulation
729 * \brief Performs a part of the simulation
730 * \param max_date Maximum date to update the simulation to, or -1
731 * \return the elapsed time, or -1.0 if no event could be executed
733 * This function execute all possible events, update the action states and returns the time elapsed.
734 * When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
735 * when you call surf_solve.
736 * Note that the returned elapsed time can be zero.
738 XBT_PUBLIC(double) surf_solve(double max_date);
740 /** \ingroup SURF_simulation
741 * \brief Return the current time
743 * Return the current time in millisecond.
745 XBT_PUBLIC(double) surf_get_clock(void);
747 /** \ingroup SURF_simulation
754 XBT_PUBLIC(void) surf_exit(void);
756 /* Prototypes of the functions that handle the properties */
757 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;// the prop set for the currently parsed element (also used in SIMIX)
758 /* The same for model_prop set*/
759 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
761 /* surf parse file related (public because called from a test suite) */
762 XBT_PUBLIC(void) parse_platform_file(const char *file);
764 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
765 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
767 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
770 * Returns the initial path. On Windows the initial path is the current directory for the current process in the other
771 * case the function returns "./" that represents the current directory on Unix/Linux platforms.
773 const char *__surf_get_initial_path(void);
775 /********** Tracing **********/
776 /* from surf_instr.c */
777 void TRACE_surf_action(surf_action_t surf_action, const char *category);
778 void TRACE_surf_alloc(void);
779 void TRACE_surf_release(void);
781 /* instr_routing.c */
782 void instr_routing_define_callbacks (void);
783 void instr_new_variable_type (const char *new_typename, const char *color);
784 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
785 void instr_new_user_state_type (const char *father_type, const char *new_typename);
786 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
787 int instr_platform_traced (void);
788 xbt_graph_t instr_routing_platform_graph (void);
789 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
792 #endif /* _SURF_SURF_H */