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/platf_interface.h"
22 #include "simgrid/datatypes.h"
23 #include "simgrid/forward.h"
26 /* Actions and models are highly connected structures... */
28 /* user-visible parameters */
29 extern XBT_PRIVATE double sg_tcp_gamma;
30 extern XBT_PRIVATE double sg_sender_gap;
31 extern XBT_PRIVATE double sg_latency_factor;
32 extern XBT_PRIVATE double sg_bandwidth_factor;
33 extern XBT_PRIVATE double sg_weight_S_parameter;
34 extern XBT_PRIVATE int sg_network_crosstraffic;
35 extern XBT_PRIVATE xbt_dynar_t surf_path;
38 SURF_NETWORK_ELEMENT_NULL = 0, /* NULL */
39 SURF_NETWORK_ELEMENT_HOST, /* host type */
40 SURF_NETWORK_ELEMENT_ROUTER, /* router type */
41 SURF_NETWORK_ELEMENT_AS /* AS type */
42 } e_surf_network_element_type_t;
59 class NetworkCm02Link;
62 class StorageActionLmm;
69 typedef simgrid::surf::Model surf_Model;
70 typedef simgrid::surf::CpuModel surf_CpuModel;
71 typedef simgrid::surf::HostModel surf_HostModel;
72 typedef simgrid::surf::VMModel surf_VMModel;
73 typedef simgrid::surf::NetworkModel surf_NetworkModel;
74 typedef simgrid::surf::StorageModel surf_StorageModel;
75 typedef simgrid::surf::Resource surf_Resource;
76 typedef simgrid::surf::ResourceLmm surf_ResourceLmm;
77 typedef simgrid::surf::Host surf_Host;
78 typedef simgrid::surf::HostCLM03 surf_HostCLM03;
79 typedef simgrid::surf::NetworkCm02Link surf_NetworkCm02Link;
80 typedef simgrid::surf::Action surf_Action;
81 typedef simgrid::surf::ActionLmm surf_ActionLmm;
82 typedef simgrid::surf::StorageActionLmm surf_StorageActionLmm;
83 typedef simgrid::surf::RoutingPlatf surf_RoutingPlatf;
87 typedef struct surf_Model surf_Model;
88 typedef struct surf_CpuModel surf_CpuModel;
89 typedef struct surf_HostModel surf_HostModel;
90 typedef struct surf_VMModel surf_VMModel;
91 typedef struct surf_NetworkModel surf_NetworkModel;
92 typedef struct surf_StorageModel surf_StorageModel;
93 typedef struct surf_Resource surf_Resource;
94 typedef struct surf_ResourceLmm surf_ResourceLmm;
95 typedef struct surf_HostCLM03 surf_HostCLM03;
96 typedef struct surf_Host surf_Host;
97 typedef struct surf_NetworkCm02Link surf_NetworkCm02Link;
98 typedef struct surf_Action surf_Action;
99 typedef struct surf_ActionLmm surf_ActionLmm;
100 typedef struct surf_StorageActionLmm surf_StorageActionLmm;
101 typedef struct surf_RoutingPlatf surf_RoutingPlatf;
105 /** @ingroup SURF_c_bindings
106 * \brief Model datatype
108 * Generic data structure for a model. The hosts,
109 * the CPUs and the network links are examples of models.
111 typedef surf_Model *surf_model_t;
112 typedef surf_CpuModel *surf_cpu_model_t;
113 typedef surf_HostModel *surf_host_model_t;
114 typedef surf_VMModel *surf_vm_model_t;
115 typedef surf_NetworkModel *surf_network_model_t;
116 typedef surf_StorageModel *surf_storage_model_t;
118 typedef xbt_dictelm_t surf_resource_t;
119 typedef surf_Resource *surf_cpp_resource_t;
120 typedef surf_Host *surf_host_t;
121 typedef surf_Cpu *surf_cpu_t;
123 /** @ingroup SURF_c_bindings
124 * \brief Action structure
126 * Never create s_surf_action_t by yourself ! The actions are created
127 * on the fly when you call execute or communicate on a model.
129 * \see e_surf_action_state_t
131 typedef surf_Action *surf_action_t;
132 typedef surf_RoutingPlatf *routing_platf_t;
134 typedef struct surf_file *surf_file_t;
136 XBT_PUBLIC(e_surf_network_element_type_t)
137 routing_get_network_element_type(const char* name);
139 /** @Brief Specify that we use that action */
140 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
142 /** @brief Creates a new action.
144 * @param size The size is the one of the subtype you want to create
145 * @param cost initial value
146 * @param model to which model we should attach this action
147 * @param failed whether we should start this action in failed mode
149 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
150 surf_model_t model, int failed);
152 /** \brief Resource model description
154 typedef struct surf_model_description {
156 const char *description;
157 void_f_void_t model_init_preparse;
158 } s_surf_model_description_t, *surf_model_description_t;
160 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
162 XBT_PUBLIC(void) model_help(const char *category,
163 s_surf_model_description_t * table);
165 /** @ingroup SURF_interface
166 * @brief Action states
171 SURF_ACTION_READY = 0, /**< Ready */
172 SURF_ACTION_RUNNING, /**< Running */
173 SURF_ACTION_FAILED, /**< Task Failure */
174 SURF_ACTION_DONE, /**< Completed */
175 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
176 SURF_ACTION_NOT_IN_THE_SYSTEM /**< Not in the system anymore. Why did you ask ? */
177 } e_surf_action_state_t;
179 /** @ingroup SURF_vm_interface
183 /* FIXME: Where should the VM state be defined? */
185 SURF_VM_STATE_CREATED, /**< created, but not yet started */
186 SURF_VM_STATE_RUNNING,
187 SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
189 SURF_VM_STATE_SAVING, /**< Save/restore involves disk I/O, so there should be transition states. */
191 SURF_VM_STATE_RESTORING,
194 /***************************/
195 /* Generic model object */
196 /***************************/
198 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
200 static inline void *surf_storage_resource_priv(const void *storage){
201 return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
204 static inline void *surf_storage_resource_by_name(const char *name){
205 return xbt_lib_get_elm_or_null(storage_lib, name);
208 /** @{ @ingroup SURF_c_bindings */
211 * @brief Pop an action from the done actions set
213 * @param model The model from which the action is extracted
214 * @return An action in done state
216 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
219 * @brief Pop an action from the failed actions set
221 * @param model The model from which the action is extracted
222 * @return An action in failed state
224 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
227 * @brief Get the size of the running action set of a model
229 * @param model The model
230 * @return The size of the running action set
232 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
234 /** @brief Get the route (dynar of sg_link_t) between two hosts */
235 XBT_PUBLIC(xbt_dynar_t) surf_host_model_get_route(
236 surf_host_model_t model, sg_host_t src, sg_host_t dst);
238 /** @brief Create a new VM on the specified host */
239 XBT_PUBLIC(void) surf_vm_model_create(const char *name, sg_host_t host_PM);
241 /** @brief Create a communication between two hosts
243 * @param model The model which handle the communication
244 * @param src The source host
245 * @param dst The destination host
246 * @param size The amount of data (in bytes) needed to transfer
247 * @param rate [description]
248 * @return The action corresponding to the communication
250 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);
253 * @brief Get the name of a surf resource (cpu, host, network, …)
255 * @param resource The surf resource
256 * @return The name of the surf resource
258 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
259 static inline const char * surf_cpu_name(surf_cpu_t cpu) {
260 return surf_resource_name((surf_cpp_resource_t)cpu);
263 /** @brief Get the available speed of cpu associated to a host */
264 XBT_PUBLIC(double) surf_host_get_available_speed(sg_host_t host);
266 /** @brief Create a sleep action on the given host */
267 XBT_PUBLIC(surf_action_t) surf_host_sleep(sg_host_t host, double duration);
269 /** @brief Create a file opening action on the given host */
270 XBT_PUBLIC(surf_action_t) surf_host_open(sg_host_t host, const char* fullpath);
272 /** @brief Create a file closing action on the given host */
273 XBT_PUBLIC(surf_action_t) surf_host_close(sg_host_t host, surf_file_t fd);
275 /** @brief Create a file reading action on the given host */
276 XBT_PUBLIC(surf_action_t) surf_host_read(sg_host_t host, surf_file_t fd, sg_size_t size);
278 /** @brief Create a file writing action on the given host */
279 XBT_PUBLIC(surf_action_t) surf_host_write(sg_host_t host, surf_file_t fd, sg_size_t size);
282 * @brief Get the informations of a file descriptor
283 * @details The returned xbt_dynar_t contains:
284 * - the size of the file,
286 * - the storage name,
287 * - the storage typeId,
288 * - the storage content type
290 * @param host The surf host
291 * @param fd The file descriptor
292 * @return An xbt_dynar_t with the file informations
294 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(sg_host_t host, surf_file_t fd);
297 * @brief Get the available space of the storage at the mount point
299 * @param resource The surf host
300 * @param name The mount point
301 * @return The amount of available space in bytes
303 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(sg_host_t resource, const char* name);
306 * @brief Get the used space of the storage at the mount point
308 * @param resource The surf host
309 * @param name The mount point
310 * @return The amount of used space in bytes
312 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(sg_host_t resource, const char* name);
314 /** @brief Get the list of VMs hosted on the host */
315 XBT_PUBLIC(xbt_dynar_t) surf_host_get_vms(sg_host_t resource);
317 /** @brief Retrieve the params of that VM
318 * @details You can use fields ramsize and overcommit on a PM, too.
320 XBT_PUBLIC(void) surf_host_get_params(sg_host_t resource, vm_params_t params);
322 /** @brief Sets the params of that VM/PM
323 * @details You can use fields ramsize and overcommit on a PM, too.
325 XBT_PUBLIC(void) surf_host_set_params(sg_host_t resource, vm_params_t params);
328 * @brief Destroy a VM
330 * @param resource The surf vm
332 XBT_PUBLIC(void) surf_vm_destroy(sg_host_t resource);
334 /** @brief Suspend a VM */
335 XBT_PUBLIC(void) surf_vm_suspend(sg_host_t resource);
337 /** @brief Resume a VM */
338 XBT_PUBLIC(void) surf_vm_resume(sg_host_t resource);
341 * @brief Save the VM (Not yet implemented)
343 * @param resource The surf vm
345 XBT_PUBLIC(void) surf_vm_save(sg_host_t resource);
348 * @brief Restore the VM (Not yet implemented)
350 * @param resource The surf vm
352 XBT_PUBLIC(void) surf_vm_restore(sg_host_t resource);
355 * @brief Migrate the VM to the destination host
357 * @param resource The surf vm
358 * @param ind_vm_ws_dest The destination host
360 XBT_PUBLIC(void) surf_vm_migrate(sg_host_t resource, sg_host_t ind_vm_ws_dest);
363 * @brief Get the physical machine hosting the VM
365 * @param resource The surf vm
366 * @return The physical machine hosting the VM
368 XBT_PUBLIC(sg_host_t) surf_vm_get_pm(sg_host_t resource);
371 * @brief [brief description]
372 * @details [long description]
374 * @param resource [description]
375 * @param bound [description]
377 XBT_PUBLIC(void) surf_vm_set_bound(sg_host_t resource, double bound);
380 * @brief [brief description]
381 * @details [long description]
383 * @param resource [description]
384 * @param cpu [description]
385 * @param mask [description]
387 XBT_PUBLIC(void) surf_vm_set_affinity(sg_host_t resource, sg_host_t cpu, unsigned long mask);
390 * @brief Get the list of storages attached to an host
392 * @param host The surf host
393 * @return Dictionary of storage
395 XBT_PUBLIC(xbt_dynar_t) surf_host_get_attached_storage_list(sg_host_t host);
398 * @brief Unlink a file descriptor
400 * @param host The surf host
401 * @param fd The file descriptor
403 * @return 0 if failed to unlink, 1 otherwise
405 XBT_PUBLIC(int) surf_host_unlink(sg_host_t host, surf_file_t fd);
408 * @brief Get the size of a file on a host
410 * @param host The surf host
411 * @param fd The file descriptor
413 * @return The size in bytes of the file
415 XBT_PUBLIC(size_t) surf_host_get_size(sg_host_t host, surf_file_t fd);
418 * @brief Get the current position of the file descriptor
420 * @param host The surf host
421 * @param fd The file descriptor
422 * @return The current position of the file descriptor
424 XBT_PUBLIC(size_t) surf_host_file_tell(sg_host_t host, surf_file_t fd);
427 * @brief Move a file to another location on the *same mount point*.
428 * @details [long description]
430 * @param host The surf host
431 * @param fd The file descriptor
432 * @param fullpath The new full path
434 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
436 XBT_PUBLIC(int) surf_host_file_move(sg_host_t host, surf_file_t fd, const char* fullpath);
439 * @brief Set the position indictator assiociated with the file descriptor to a new position
440 * @details [long description]
442 * @param host The surf host
443 * @param fd The file descriptor
444 * @param offset The offset from the origin
445 * @param origin Position used as a reference for the offset
446 * - SEEK_SET: beginning of the file
447 * - SEEK_CUR: current position indicator
448 * - SEEK_END: end of the file
449 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
451 XBT_PUBLIC(int) surf_host_file_seek(sg_host_t host,
452 surf_file_t fd, sg_offset_t offset,
456 * @brief Get the content of a storage
458 * @param resource The surf storage
459 * @return A xbt_dict_t with path as keys and size in bytes as values
461 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
464 * @brief Get the size in bytes of a storage
466 * @param resource The surf storage
467 * @return The size in bytes of the storage
469 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
472 * @brief Get the available size in bytes of a storage
474 * @param resource The surf storage
475 * @return The available size in bytes of the storage
477 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
480 * @brief Get the size in bytes of a storage
482 * @param resource The surf storage
483 * @return The used size in bytes of the storage
485 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
487 /** @brief return the properties set associated to that storage */
488 XBT_PUBLIC(xbt_dict_t) surf_storage_get_properties(surf_resource_t resource);
491 * @brief Get the data associated to the action
493 * @param action The surf action
494 * @return The data associated to the action
496 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
499 * @brief Set the data associated to the action
500 * @details [long description]
502 * @param action The surf action
503 * @param data The new data associated to the action
505 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
508 * @brief Get the start time of an action
510 * @param action The surf action
511 * @return The start time in seconds from the beginning of the simulation
513 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
516 * @brief Get the finish time of an action
518 * @param action The surf action
519 * @return The finish time in seconds from the beginning of the simulation
521 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
524 * @brief Get the remains amount of work to do of an action
526 * @param action The surf action
527 * @return The remains amount of work to do
529 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
532 * @brief Set the category of an action
533 * @details [long description]
535 * @param action The surf action
536 * @param category The new category of the action
538 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
541 * @brief Get the state of an action
543 * @param action The surf action
544 * @return The state of the action
546 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
549 * @brief Get the cost of an action
551 * @param action The surf action
552 * @return The cost of the action
554 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
557 * @brief [brief desrciption]
558 * @details [long description]
560 * @param action The surf cpu action
561 * @param cpu [description]
562 * @param mask [description]
564 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, sg_host_t cpu, unsigned long mask);
567 * @brief [brief description]
568 * @details [long description]
570 * @param action The surf cpu action
571 * @param bound [description]
573 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
576 * @brief [brief description]
577 * @details [long description]
579 * @param action The surf network action
581 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
584 * @brief Get the file associated to a storage action
586 * @param action The surf storage action
587 * @return The file associated to a storage action
589 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
592 * @brief Get the result dictionary of an ls action
594 * @param action The surf storage action
595 * @return The dictionry listing a path
597 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
601 * @brief Get the host the storage is attached to
603 * @param resource The surf storage
604 * @return The host name
607 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
611 /**************************************/
612 /* Implementations of model object */
613 /**************************************/
615 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
616 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
618 /** \ingroup SURF_models
619 * \brief The CPU model object for the physical machine layer
621 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
623 /** \ingroup SURF_models
624 * \brief The CPU model object for the virtual machine layer
626 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
629 /** \ingroup SURF_models
630 * \brief Initializes the CPU model with the model Cas01
632 * By default, this model uses the lazy optimization mechanism that
633 * relies on partial invalidation in LMM and a heap for lazy action update.
634 * You can change this behavior by setting the cpu/optim configuration
635 * variable to a different value.
637 * You shouldn't have to call it by yourself.
639 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
641 /** \ingroup SURF_models
642 * \brief Initializes the CPU model with trace integration [Deprecated]
644 * You shouldn't have to call it by yourself.
646 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
648 /** \ingroup SURF_models
649 * \brief The list of all available optimization modes (both for cpu and networks).
650 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
652 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
654 /** \ingroup SURF_plugins
655 * \brief The list of all available surf plugins
657 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
659 /** \ingroup SURF_models
660 * \brief The list of all available cpu model models
662 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
664 /**\brief create new host bypass the parser
669 /** \ingroup SURF_models
670 * \brief The network model
672 * When creating a new API on top on SURF, you shouldn't use the
673 * network model unless you know what you are doing. Only the host
674 * model should be accessed because depending on the platform model,
675 * the network model can be NULL.
677 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
679 /** \ingroup SURF_models
680 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
682 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
683 * based on the model 'LV08' and different correction factors depending on the communication
684 * size (< 1KiB, < 64KiB, >= 64KiB).
685 * See comments in the code for more information.
687 * \see surf_host_model_init_SMPI()
689 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
691 /** \ingroup SURF_models
692 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
694 * This model impelments a variant of the contention model on Infinband networks based on
695 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
697 * \see surf_host_model_init_IB()
699 XBT_PUBLIC(void) surf_network_model_init_IB(void);
701 /** \ingroup SURF_models
702 * \brief Initializes the platform with the network model 'LegrandVelho'
704 * This model is proposed by Arnaud Legrand and Pedro Velho based on
705 * the results obtained with the GTNets simulator for onelink and
706 * dogbone sharing scenarios. See comments in the code for more information.
708 * \see surf_host_model_init_LegrandVelho()
710 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
712 /** \ingroup SURF_models
713 * \brief Initializes the platform with the network model 'Constant'
715 * In this model, the communication time between two network cards is
716 * constant, hence no need for a routing table. This is particularly
717 * usefull when simulating huge distributed algorithms where
718 * scalability is really an issue. This function is called in
719 * conjunction with surf_host_model_init_compound.
721 * \see surf_host_model_init_compound()
723 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
725 /** \ingroup SURF_models
726 * \brief Initializes the platform with the network model CM02
728 * You sould call this function by yourself only if you plan using
729 * surf_host_model_init_compound.
730 * See comments in the code for more information.
732 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
735 /** \ingroup SURF_models
736 * \brief Initializes the platform with the network model NS3
738 * This function is called by surf_host_model_init_NS3
739 * or by yourself only if you plan using surf_host_model_init_compound
741 * \see surf_host_model_init_NS3()
743 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
746 /** \ingroup SURF_models
747 * \brief Initializes the platform with the network model Reno
749 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
752 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
753 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
755 * Call this function only if you plan using surf_host_model_init_compound.
758 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
760 /** \ingroup SURF_models
761 * \brief Initializes the platform with the network model Reno2
763 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
766 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
767 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
769 * Call this function only if you plan using surf_host_model_init_compound.
772 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
774 /** \ingroup SURF_models
775 * \brief Initializes the platform with the network model Vegas
777 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
778 * to the proportional fairness.
781 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
782 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
784 * Call this function only if you plan using surf_host_model_init_compound.
787 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
789 /** \ingroup SURF_models
790 * \brief The list of all available network model models
792 XBT_PUBLIC_DATA(s_surf_model_description_t)
793 surf_network_model_description[];
795 /** \ingroup SURF_models
796 * \brief The storage model
798 XBT_PUBLIC(void) surf_storage_model_init_default(void);
800 /** \ingroup SURF_models
801 * \brief The list of all available storage modes.
802 * This storage mode can be set using --cfg=storage/model:...
804 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
806 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
808 /** \ingroup SURF_models
809 * \brief The host model
811 * Note that when you create an API on top of SURF,
812 * the host model should be the only one you use
813 * because depending on the platform model, the network model and the CPU model
816 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
818 /** \ingroup SURF_models
819 * \brief The vm model
821 * Note that when you create an API on top of SURF,
822 * the vm model should be the only one you use
823 * because depending on the platform model, the network model and the CPU model
826 XBT_PUBLIC_DATA(surf_vm_model_t) surf_vm_model;
828 /** \ingroup SURF_models
829 * \brief Initializes the platform with a compound host model
831 * This function should be called after a cpu_model and a
832 * network_model have been set up.
835 XBT_PUBLIC(void) surf_host_model_init_compound(void);
837 /** \ingroup SURF_models
838 * \brief Initializes the platform with the current best network and cpu models at hand
840 * This platform model separates the host model and the network model.
841 * The host model will be initialized with the model compound, the network
842 * model with the model LV08 (with cross traffic support) and the CPU model with
844 * Such model is subject to modification with warning in the ChangeLog so monitor it!
847 XBT_PUBLIC(void) surf_host_model_init_current_default(void);
849 /** \ingroup SURF_models
850 * \brief Initializes the platform with the model L07
852 * With this model, only parallel tasks can be used. Resource sharing
853 * is done by identifying bottlenecks and giving an equal share of
854 * the model to each action.
857 XBT_PUBLIC(void) surf_host_model_init_ptask_L07(void);
859 /** \ingroup SURF_models
860 * \brief The list of all available host model models
862 XBT_PUBLIC_DATA(s_surf_model_description_t)
863 surf_host_model_description[];
865 /** \ingroup SURF_models
866 * \brief Initializes the platform with the current best network and cpu models at hand
868 * This platform model seperates the host model and the network model.
869 * The host model will be initialized with the model compound, the network
870 * model with the model LV08 (with cross traffic support) and the CPU model with
872 * Such model is subject to modification with warning in the ChangeLog so monitor it!
875 XBT_PUBLIC(void) surf_vm_model_init_HL13(void);
877 /** \ingroup SURF_models
878 * \brief The list of all available vm model models
880 XBT_PUBLIC_DATA(s_surf_model_description_t)
881 surf_vm_model_description[];
883 /*******************************************/
885 /** \ingroup SURF_models
886 * \brief List of initialized models
888 XBT_PUBLIC_DATA(xbt_dynar_t) all_existing_models;
890 /** \ingroup SURF_simulation
891 * \brief List of hosts that have just restarted and whose autorestart process should be restarted.
893 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
895 /** \ingroup SURF_simulation
896 * \brief List of hosts for which one want to be notified if they ever restart.
898 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
900 /*******************************************/
901 /*** SURF Platform *************************/
902 /*******************************************/
903 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
904 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
905 XBT_PUBLIC_DATA(AS_t) surf_AS_get_by_name(const char * name);
906 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
907 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
908 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
909 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
910 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
911 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_netcard_t edge);
913 /*******************************************/
914 /*** SURF Globals **************************/
915 /*******************************************/
917 /** \ingroup SURF_simulation
918 * \brief Initialize SURF
919 * \param argc argument number
920 * \param argv arguments
922 * This function has to be called to initialize the common
923 * structures. Then you will have to create the environment by
925 * e.g. surf_host_model_init_CM02()
927 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
929 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
931 /** \ingroup SURF_simulation
932 * \brief Finish simulation initialization
934 * This function must be called before the first call to surf_solve()
936 XBT_PUBLIC(void) surf_presolve(void);
938 /** \ingroup SURF_simulation
939 * \brief Performs a part of the simulation
940 * \param max_date Maximum date to update the simulation to, or -1
941 * \return the elapsed time, or -1.0 if no event could be executed
943 * This function execute all possible events, update the action states
944 * and returns the time elapsed.
945 * When you call execute or communicate on a model, the corresponding actions
946 * are not executed immediately but only when you call surf_solve.
947 * Note that the returned elapsed time can be zero.
949 XBT_PUBLIC(double) surf_solve(double max_date);
951 /** \ingroup SURF_simulation
952 * \brief Return the current time
954 * Return the current time in millisecond.
956 XBT_PUBLIC(double) surf_get_clock(void);
958 /** \ingroup SURF_simulation
965 XBT_PUBLIC(void) surf_exit(void);
967 /* Prototypes of the functions that handle the properties */
968 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
970 /* The same for model_prop set*/
971 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
973 /* surf parse file related (public because called from a test suite) */
974 XBT_PUBLIC(void) parse_platform_file(const char *file);
976 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
977 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
979 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
982 * Returns the initial path. On Windows the initial path is
983 * the current directory for the current process in the other
984 * case the function returns "./" that represents the current
985 * directory on Unix/Linux platforms.
987 const char *__surf_get_initial_path(void);
989 /********** Tracing **********/
990 /* from surf_instr.c */
991 void TRACE_surf_action(surf_action_t surf_action, const char *category);
992 void TRACE_surf_alloc(void);
993 void TRACE_surf_release(void);
995 /* instr_routing.c */
996 void instr_routing_define_callbacks (void);
997 void instr_new_variable_type (const char *new_typename, const char *color);
998 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
999 void instr_new_user_state_type (const char *father_type, const char *new_typename);
1000 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
1001 int instr_platform_traced (void);
1002 xbt_graph_t instr_routing_platform_graph (void);
1003 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1005 /********** Routing **********/
1006 void routing_AS_begin(sg_platf_AS_cbarg_t AS);
1007 void routing_AS_end(void);
1008 surf_NetCard* routing_add_host(surf_As* as, sg_platf_host_cbarg_t host);
1009 void routing_cluster_add_backbone(void* bb);
1010 surf_As* routing_get_current();
1013 #endif /* _SURF_SURF_H */