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/plugins.h"
24 #include "simgrid/forward.h"
27 /* Actions and models are highly connected structures... */
29 /* user-visible parameters */
30 extern XBT_PRIVATE double sg_tcp_gamma;
31 extern XBT_PRIVATE double sg_sender_gap;
32 extern XBT_PRIVATE double sg_latency_factor;
33 extern XBT_PRIVATE double sg_bandwidth_factor;
34 extern XBT_PRIVATE double sg_weight_S_parameter;
35 extern XBT_PRIVATE int sg_network_crosstraffic;
36 extern XBT_PRIVATE xbt_dynar_t surf_path;
39 SURF_NETWORK_ELEMENT_NULL = 0, /* NULL */
40 SURF_NETWORK_ELEMENT_HOST, /* host type */
41 SURF_NETWORK_ELEMENT_ROUTER, /* router type */
42 SURF_NETWORK_ELEMENT_AS /* AS type */
43 } e_surf_network_element_type_t;
60 class NetworkCm02Link;
63 class StorageActionLmm;
70 typedef simgrid::surf::Model surf_Model;
71 typedef simgrid::surf::CpuModel surf_CpuModel;
72 typedef simgrid::surf::HostModel surf_HostModel;
73 typedef simgrid::surf::VMModel surf_VMModel;
74 typedef simgrid::surf::NetworkModel surf_NetworkModel;
75 typedef simgrid::surf::StorageModel surf_StorageModel;
76 typedef simgrid::surf::Resource surf_Resource;
77 typedef simgrid::surf::ResourceLmm surf_ResourceLmm;
78 typedef simgrid::surf::Host surf_Host;
79 typedef simgrid::surf::HostCLM03 surf_HostCLM03;
80 typedef simgrid::surf::NetworkCm02Link surf_NetworkCm02Link;
81 typedef simgrid::surf::Action surf_Action;
82 typedef simgrid::surf::ActionLmm surf_ActionLmm;
83 typedef simgrid::surf::StorageActionLmm surf_StorageActionLmm;
84 typedef simgrid::surf::RoutingPlatf surf_RoutingPlatf;
88 typedef struct surf_Model surf_Model;
89 typedef struct surf_CpuModel surf_CpuModel;
90 typedef struct surf_HostModel surf_HostModel;
91 typedef struct surf_VMModel surf_VMModel;
92 typedef struct surf_NetworkModel surf_NetworkModel;
93 typedef struct surf_StorageModel surf_StorageModel;
94 typedef struct surf_Resource surf_Resource;
95 typedef struct surf_ResourceLmm surf_ResourceLmm;
96 typedef struct surf_HostCLM03 surf_HostCLM03;
97 typedef struct surf_Host surf_Host;
98 typedef struct surf_NetworkCm02Link surf_NetworkCm02Link;
99 typedef struct surf_Action surf_Action;
100 typedef struct surf_ActionLmm surf_ActionLmm;
101 typedef struct surf_StorageActionLmm surf_StorageActionLmm;
102 typedef struct surf_RoutingPlatf surf_RoutingPlatf;
106 /** @ingroup SURF_c_bindings
107 * \brief Model datatype
109 * Generic data structure for a model. The hosts,
110 * the CPUs and the network links are examples of models.
112 typedef surf_Model *surf_model_t;
113 typedef surf_CpuModel *surf_cpu_model_t;
114 typedef surf_HostModel *surf_host_model_t;
115 typedef surf_VMModel *surf_vm_model_t;
116 typedef surf_NetworkModel *surf_network_model_t;
117 typedef surf_StorageModel *surf_storage_model_t;
119 typedef xbt_dictelm_t surf_resource_t;
120 typedef surf_Resource *surf_cpp_resource_t;
121 typedef surf_Host *surf_host_t;
122 typedef surf_Cpu *surf_cpu_t;
124 /** @ingroup SURF_c_bindings
125 * \brief Action structure
127 * Never create s_surf_action_t by yourself ! The actions are created
128 * on the fly when you call execute or communicate on a model.
130 * \see e_surf_action_state_t
132 typedef surf_Action *surf_action_t;
133 typedef surf_RoutingPlatf *routing_platf_t;
135 typedef struct surf_file *surf_file_t;
137 XBT_PUBLIC(e_surf_network_element_type_t)
138 routing_get_network_element_type(const char* name);
140 /** @Brief Specify that we use that action */
141 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
143 /** @brief Creates a new action.
145 * @param size The size is the one of the subtype you want to create
146 * @param cost initial value
147 * @param model to which model we should attach this action
148 * @param failed whether we should start this action in failed mode
150 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
151 surf_model_t model, int failed);
153 /** \brief Resource model description
155 typedef struct surf_model_description {
157 const char *description;
158 void_f_void_t model_init_preparse;
159 } s_surf_model_description_t, *surf_model_description_t;
161 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
163 XBT_PUBLIC(void) model_help(const char *category,
164 s_surf_model_description_t * table);
166 /** @ingroup SURF_interface
167 * @brief Action states
172 SURF_ACTION_READY = 0, /**< Ready */
173 SURF_ACTION_RUNNING, /**< Running */
174 SURF_ACTION_FAILED, /**< Task Failure */
175 SURF_ACTION_DONE, /**< Completed */
176 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
177 SURF_ACTION_NOT_IN_THE_SYSTEM /**< Not in the system anymore. Why did you ask ? */
178 } e_surf_action_state_t;
180 /** @ingroup SURF_vm_interface
184 /* FIXME: Where should the VM state be defined? */
186 SURF_VM_STATE_CREATED, /**< created, but not yet started */
187 SURF_VM_STATE_RUNNING,
188 SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
190 SURF_VM_STATE_SAVING, /**< Save/restore involves disk I/O, so there should be transition states. */
192 SURF_VM_STATE_RESTORING,
195 /***************************/
196 /* Generic model object */
197 /***************************/
199 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
201 XBT_PUBLIC(surf_host_t) surf_host_resource_priv(sg_host_t host);
203 static inline void *surf_storage_resource_priv(const void *storage){
204 return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
207 static inline void *surf_storage_resource_by_name(const char *name){
208 return xbt_lib_get_elm_or_null(storage_lib, name);
211 /** @{ @ingroup SURF_c_bindings */
214 * @brief Pop an action from the done actions set
216 * @param model The model from which the action is extracted
217 * @return An action in done state
219 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
222 * @brief Pop an action from the failed actions set
224 * @param model The model from which the action is extracted
225 * @return An action in failed state
227 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
230 * @brief Pop an action from the ready actions set
232 * @param model The model from which the action is extracted
233 * @return An action in ready state
235 XBT_PUBLIC(surf_action_t) surf_model_extract_ready_action_set(surf_model_t model);
238 * @brief Pop an action from the running actions set
240 * @param model The model from which the action is extracted
241 * @return An action in running state
243 XBT_PUBLIC(surf_action_t) surf_model_extract_running_action_set(surf_model_t model);
246 * @brief Get the size of the running action set of a model
248 * @param model The model
249 * @return The size of the running action set
251 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
254 * @brief Execute a parallel task
255 * @details [long description]
257 * @param model The model which handle the parallelisation
258 * @param host_nb The number of hosts
259 * @param host_list The list of hosts on which the task is executed
260 * @param flops_amount The processing amount (in flop) needed to process
261 * @param bytes_amount The amount of data (in bytes) needed to transfer
262 * @param rate [description]
263 * @return The action corresponding to the parallele execution task
265 XBT_PUBLIC(surf_action_t) surf_host_model_execute_parallel_task(surf_host_model_t model,
267 sg_host_t *host_list,
268 double *flops_amount,
269 double *bytes_amount,
272 /** @brief Get the route (dynar of sg_link_t) between two hosts */
273 XBT_PUBLIC(xbt_dynar_t) surf_host_model_get_route(
274 surf_host_model_t model, sg_host_t src, sg_host_t dst);
276 /** @brief Create a new VM on the specified host */
277 XBT_PUBLIC(void) surf_vm_model_create(const char *name, sg_host_t host_PM);
279 /** @brief Create a communication between two hosts
281 * @param model The model which handle the communication
282 * @param src The source host
283 * @param dst The destination host
284 * @param size The amount of data (in bytes) needed to transfer
285 * @param rate [description]
286 * @return The action corresponding to the communication
288 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);
291 * @brief Get the name of a surf resource (cpu, host, network, …)
293 * @param resource The surf resource
294 * @return The name of the surf resource
296 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
297 static inline const char * surf_cpu_name(surf_cpu_t cpu) {
298 return surf_resource_name((surf_cpp_resource_t)cpu);
301 /** @brief Get the properties of an host */
302 XBT_PUBLIC(xbt_dict_t) sg_host_get_properties(sg_host_t host);
304 /** @brief Get the available speed of cpu associated to a host */
305 XBT_PUBLIC(double) surf_host_get_available_speed(sg_host_t host);
307 /** @brief Create a sleep action on the given host */
308 XBT_PUBLIC(surf_action_t) surf_host_sleep(sg_host_t host, double duration);
310 /** @brief Create a file opening action on the given host */
311 XBT_PUBLIC(surf_action_t) surf_host_open(sg_host_t host, const char* fullpath);
313 /** @brief Create a file closing action on the given host */
314 XBT_PUBLIC(surf_action_t) surf_host_close(sg_host_t host, surf_file_t fd);
316 /** @brief Create a file reading action on the given host */
317 XBT_PUBLIC(surf_action_t) surf_host_read(sg_host_t host, surf_file_t fd, sg_size_t size);
319 /** @brief Create a file writing action on the given host */
320 XBT_PUBLIC(surf_action_t) surf_host_write(sg_host_t host, surf_file_t fd, sg_size_t size);
323 * @brief Get the informations of a file descriptor
324 * @details The returned xbt_dynar_t contains:
325 * - the size of the file,
327 * - the storage name,
328 * - the storage typeId,
329 * - the storage content type
331 * @param host The surf host
332 * @param fd The file descriptor
333 * @return An xbt_dynar_t with the file informations
335 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(sg_host_t host, surf_file_t fd);
338 * @brief Get the available space of the storage at the mount point
340 * @param resource The surf host
341 * @param name The mount point
342 * @return The amount of available space in bytes
344 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(sg_host_t resource, const char* name);
347 * @brief Get the used space of the storage at the mount point
349 * @param resource The surf host
350 * @param name The mount point
351 * @return The amount of used space in bytes
353 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(sg_host_t resource, const char* name);
355 /** @brief Get the list of VMs hosted on the host */
356 XBT_PUBLIC(xbt_dynar_t) surf_host_get_vms(sg_host_t resource);
358 /** @brief Retrieve the params of that VM
359 * @details You can use fields ramsize and overcommit on a PM, too.
361 XBT_PUBLIC(void) surf_host_get_params(sg_host_t resource, vm_params_t params);
363 /** @brief Sets the params of that VM/PM
364 * @details You can use fields ramsize and overcommit on a PM, too.
366 XBT_PUBLIC(void) surf_host_set_params(sg_host_t resource, vm_params_t params);
369 * @brief Destroy a VM
371 * @param resource The surf vm
373 XBT_PUBLIC(void) surf_vm_destroy(sg_host_t resource);
375 /** @brief Suspend a VM */
376 XBT_PUBLIC(void) surf_vm_suspend(sg_host_t resource);
378 /** @brief Resume a VM */
379 XBT_PUBLIC(void) surf_vm_resume(sg_host_t resource);
382 * @brief Save the VM (Not yet implemented)
384 * @param resource The surf vm
386 XBT_PUBLIC(void) surf_vm_save(sg_host_t resource);
389 * @brief Restore the VM (Not yet implemented)
391 * @param resource The surf vm
393 XBT_PUBLIC(void) surf_vm_restore(sg_host_t resource);
396 * @brief Migrate the VM to the destination host
398 * @param resource The surf vm
399 * @param ind_vm_ws_dest The destination host
401 XBT_PUBLIC(void) surf_vm_migrate(sg_host_t resource, sg_host_t ind_vm_ws_dest);
404 * @brief Get the physical machine hosting the VM
406 * @param resource The surf vm
407 * @return The physical machine hosting the VM
409 XBT_PUBLIC(sg_host_t) surf_vm_get_pm(sg_host_t resource);
412 * @brief [brief description]
413 * @details [long description]
415 * @param resource [description]
416 * @param bound [description]
418 XBT_PUBLIC(void) surf_vm_set_bound(sg_host_t resource, double bound);
421 * @brief [brief description]
422 * @details [long description]
424 * @param resource [description]
425 * @param cpu [description]
426 * @param mask [description]
428 XBT_PUBLIC(void) surf_vm_set_affinity(sg_host_t resource, sg_host_t cpu, unsigned long mask);
431 * @brief Get the host power peak
432 * @details [long description]
434 * @param host The surf host
435 * @return The power peak
437 XBT_PUBLIC(double) surf_host_get_current_power_peak(sg_host_t host);
440 * @brief [brief description]
441 * @details [long description]
443 * @param host [description]
444 * @param pstate_index [description]
446 * @return [description]
448 XBT_PUBLIC(double) surf_host_get_power_peak_at(sg_host_t host, int pstate_index);
450 XBT_PUBLIC(double) surf_host_get_wattmin_at(sg_host_t resource, int pstate);
451 XBT_PUBLIC(double) surf_host_get_wattmax_at(sg_host_t resource, int pstate);
454 * @brief Get the consumed energy (in joules) of an host
456 * @param host The surf host
457 * @return The consumed energy
459 XBT_PUBLIC(double) surf_host_get_consumed_energy(sg_host_t host);
462 * @brief Get the list of storages mounted on an host
464 * @param host The surf host
465 * @return Dictionary of mount point, Storage
467 XBT_PUBLIC(xbt_dict_t) surf_host_get_mounted_storage_list(sg_host_t host);
470 * @brief Get the list of storages attached to an host
472 * @param host The surf host
473 * @return Dictionary of storage
475 XBT_PUBLIC(xbt_dynar_t) surf_host_get_attached_storage_list(sg_host_t host);
478 * @brief Unlink a file descriptor
480 * @param host The surf host
481 * @param fd The file descriptor
483 * @return 0 if failed to unlink, 1 otherwise
485 XBT_PUBLIC(int) surf_host_unlink(sg_host_t host, surf_file_t fd);
488 * @brief Get the size of a file on a host
490 * @param host The surf host
491 * @param fd The file descriptor
493 * @return The size in bytes of the file
495 XBT_PUBLIC(size_t) surf_host_get_size(sg_host_t host, surf_file_t fd);
498 * @brief Get the current position of the file descriptor
500 * @param host The surf host
501 * @param fd The file descriptor
502 * @return The current position of the file descriptor
504 XBT_PUBLIC(size_t) surf_host_file_tell(sg_host_t host, surf_file_t fd);
507 * @brief Move a file to another location on the *same mount point*.
508 * @details [long description]
510 * @param host The surf host
511 * @param fd The file descriptor
512 * @param fullpath The new full path
514 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
516 XBT_PUBLIC(int) surf_host_file_move(sg_host_t host, surf_file_t fd, const char* fullpath);
519 * @brief Set the position indictator assiociated with the file descriptor to a new position
520 * @details [long description]
522 * @param host The surf host
523 * @param fd The file descriptor
524 * @param offset The offset from the origin
525 * @param origin Position used as a reference for the offset
526 * - SEEK_SET: beginning of the file
527 * - SEEK_CUR: current position indicator
528 * - SEEK_END: end of the file
529 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
531 XBT_PUBLIC(int) surf_host_file_seek(sg_host_t host,
532 surf_file_t fd, sg_offset_t offset,
536 * @brief Get the content of a storage
538 * @param resource The surf storage
539 * @return A xbt_dict_t with path as keys and size in bytes as values
541 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
544 * @brief Get the size in bytes of a storage
546 * @param resource The surf storage
547 * @return The size in bytes of the storage
549 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
552 * @brief Get the available size in bytes of a storage
554 * @param resource The surf storage
555 * @return The available size in bytes of the storage
557 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
560 * @brief Get the size in bytes of a storage
562 * @param resource The surf storage
563 * @return The used size in bytes of the storage
565 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
567 /** @brief return the properties set associated to that storage */
568 XBT_PUBLIC(xbt_dict_t) surf_storage_get_properties(surf_resource_t resource);
571 * @brief Get the data associated to the action
573 * @param action The surf action
574 * @return The data associated to the action
576 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
579 * @brief Set the data associated to the action
580 * @details [long description]
582 * @param action The surf action
583 * @param data The new data associated to the action
585 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
588 * @brief Get the start time of an action
590 * @param action The surf action
591 * @return The start time in seconds from the beginning of the simulation
593 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
596 * @brief Get the finish time of an action
598 * @param action The surf action
599 * @return The finish time in seconds from the beginning of the simulation
601 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
604 * @brief Get the remains amount of work to do of an action
606 * @param action The surf action
607 * @return The remains amount of work to do
609 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
612 * @brief Suspend an action
614 * @param action The surf action
616 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
619 * @brief Resume an action
621 * @param action The surf action
623 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
626 * @brief Cancel an action
628 * @param action The surf action
630 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
633 * @brief Set the priority of an action
634 * @details [long description]
636 * @param action The surf action
637 * @param priority The new priority [TODO]
639 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
642 * @brief Set the category of an action
643 * @details [long description]
645 * @param action The surf action
646 * @param category The new category of the action
648 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
651 * @brief Get the state of an action
653 * @param action The surf action
654 * @return The state of the action
656 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
659 * @brief Get the cost of an action
661 * @param action The surf action
662 * @return The cost of the action
664 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
667 * @brief [brief desrciption]
668 * @details [long description]
670 * @param action The surf cpu action
671 * @param cpu [description]
672 * @param mask [description]
674 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, sg_host_t cpu, unsigned long mask);
677 * @brief [brief description]
678 * @details [long description]
680 * @param action The surf cpu action
681 * @param bound [description]
683 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
686 * @brief [brief description]
687 * @details [long description]
689 * @param action The surf network action
691 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
694 * @brief Get the file associated to a storage action
696 * @param action The surf storage action
697 * @return The file associated to a storage action
699 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
702 * @brief Get the result dictionary of an ls action
704 * @param action The surf storage action
705 * @return The dictionry listing a path
707 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
711 * @brief Get the host the storage is attached to
713 * @param resource The surf storage
714 * @return The host name
717 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
719 XBT_PUBLIC(surf_host_model_t) surf_host_get_model(sg_host_t host);
723 /**************************************/
724 /* Implementations of model object */
725 /**************************************/
727 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
728 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
730 /** \ingroup SURF_models
731 * \brief The CPU model object for the physical machine layer
733 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
735 /** \ingroup SURF_models
736 * \brief The CPU model object for the virtual machine layer
738 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
741 /** \ingroup SURF_models
742 * \brief Initializes the CPU model with the model Cas01
744 * By default, this model uses the lazy optimization mechanism that
745 * relies on partial invalidation in LMM and a heap for lazy action update.
746 * You can change this behavior by setting the cpu/optim configuration
747 * variable to a different value.
749 * You shouldn't have to call it by yourself.
751 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
753 /** \ingroup SURF_models
754 * \brief Initializes the CPU model with trace integration [Deprecated]
756 * You shouldn't have to call it by yourself.
758 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
760 /** \ingroup SURF_models
761 * \brief The list of all available optimization modes (both for cpu and networks).
762 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
764 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
766 /** \ingroup SURF_plugins
767 * \brief The list of all available surf plugins
769 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
771 /** \ingroup SURF_models
772 * \brief The list of all available cpu model models
774 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
776 /**\brief create new host bypass the parser
781 /** \ingroup SURF_models
782 * \brief The network model
784 * When creating a new API on top on SURF, you shouldn't use the
785 * network model unless you know what you are doing. Only the host
786 * model should be accessed because depending on the platform model,
787 * the network model can be NULL.
789 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
791 /** \ingroup SURF_models
792 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
794 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
795 * based on the model 'LV08' and different correction factors depending on the communication
796 * size (< 1KiB, < 64KiB, >= 64KiB).
797 * See comments in the code for more information.
799 * \see surf_host_model_init_SMPI()
801 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
803 /** \ingroup SURF_models
804 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
806 * This model impelments a variant of the contention model on Infinband networks based on
807 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
809 * \see surf_host_model_init_IB()
811 XBT_PUBLIC(void) surf_network_model_init_IB(void);
813 /** \ingroup SURF_models
814 * \brief Initializes the platform with the network model 'LegrandVelho'
816 * This model is proposed by Arnaud Legrand and Pedro Velho based on
817 * the results obtained with the GTNets simulator for onelink and
818 * dogbone sharing scenarios. See comments in the code for more information.
820 * \see surf_host_model_init_LegrandVelho()
822 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
824 /** \ingroup SURF_models
825 * \brief Initializes the platform with the network model 'Constant'
827 * In this model, the communication time between two network cards is
828 * constant, hence no need for a routing table. This is particularly
829 * usefull when simulating huge distributed algorithms where
830 * scalability is really an issue. This function is called in
831 * conjunction with surf_host_model_init_compound.
833 * \see surf_host_model_init_compound()
835 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
837 /** \ingroup SURF_models
838 * \brief Initializes the platform with the network model CM02
840 * You sould call this function by yourself only if you plan using
841 * surf_host_model_init_compound.
842 * See comments in the code for more information.
844 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
847 /** \ingroup SURF_models
848 * \brief Initializes the platform with the network model NS3
850 * This function is called by surf_host_model_init_NS3
851 * or by yourself only if you plan using surf_host_model_init_compound
853 * \see surf_host_model_init_NS3()
855 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
858 /** \ingroup SURF_models
859 * \brief Initializes the platform with the network model Reno
861 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
864 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
865 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
867 * Call this function only if you plan using surf_host_model_init_compound.
870 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
872 /** \ingroup SURF_models
873 * \brief Initializes the platform with the network model Reno2
875 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
878 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
879 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
881 * Call this function only if you plan using surf_host_model_init_compound.
884 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
886 /** \ingroup SURF_models
887 * \brief Initializes the platform with the network model Vegas
889 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
890 * to the proportional fairness.
893 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
894 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
896 * Call this function only if you plan using surf_host_model_init_compound.
899 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
901 /** \ingroup SURF_models
902 * \brief The list of all available network model models
904 XBT_PUBLIC_DATA(s_surf_model_description_t)
905 surf_network_model_description[];
907 /** \ingroup SURF_models
908 * \brief The storage model
910 XBT_PUBLIC(void) surf_storage_model_init_default(void);
912 /** \ingroup SURF_models
913 * \brief The list of all available storage modes.
914 * This storage mode can be set using --cfg=storage/model:...
916 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
918 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
920 /** \ingroup SURF_models
921 * \brief The host model
923 * Note that when you create an API on top of SURF,
924 * the host model should be the only one you use
925 * because depending on the platform model, the network model and the CPU model
928 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
930 /** \ingroup SURF_models
931 * \brief The vm model
933 * Note that when you create an API on top of SURF,
934 * the vm model should be the only one you use
935 * because depending on the platform model, the network model and the CPU model
938 XBT_PUBLIC_DATA(surf_vm_model_t) surf_vm_model;
940 /** \ingroup SURF_models
941 * \brief Initializes the platform with a compound host model
943 * This function should be called after a cpu_model and a
944 * network_model have been set up.
947 XBT_PUBLIC(void) surf_host_model_init_compound(void);
949 /** \ingroup SURF_models
950 * \brief Initializes the platform with the current best network and cpu models at hand
952 * This platform model separates the host model and the network model.
953 * The host model will be initialized with the model compound, the network
954 * model with the model LV08 (with cross traffic support) and the CPU model with
956 * Such model is subject to modification with warning in the ChangeLog so monitor it!
959 XBT_PUBLIC(void) surf_host_model_init_current_default(void);
961 /** \ingroup SURF_models
962 * \brief Initializes the platform with the model L07
964 * With this model, only parallel tasks can be used. Resource sharing
965 * is done by identifying bottlenecks and giving an equal share of
966 * the model to each action.
969 XBT_PUBLIC(void) surf_host_model_init_ptask_L07(void);
971 /** \ingroup SURF_models
972 * \brief The list of all available host model models
974 XBT_PUBLIC_DATA(s_surf_model_description_t)
975 surf_host_model_description[];
977 /** \ingroup SURF_models
978 * \brief Initializes the platform with the current best network and cpu models at hand
980 * This platform model seperates the host model and the network model.
981 * The host model will be initialized with the model compound, the network
982 * model with the model LV08 (with cross traffic support) and the CPU model with
984 * Such model is subject to modification with warning in the ChangeLog so monitor it!
987 XBT_PUBLIC(void) surf_vm_model_init_HL13(void);
989 /** \ingroup SURF_models
990 * \brief The list of all available vm model models
992 XBT_PUBLIC_DATA(s_surf_model_description_t)
993 surf_vm_model_description[];
995 /*******************************************/
997 /** \ingroup SURF_models
998 * \brief List of initialized models
1000 XBT_PUBLIC_DATA(xbt_dynar_t) all_existing_models;
1002 /** \ingroup SURF_simulation
1003 * \brief List of hosts that have just restarted and whose autorestart process should be restarted.
1005 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
1007 /** \ingroup SURF_simulation
1008 * \brief List of hosts for which one want to be notified if they ever restart.
1010 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
1012 /*******************************************/
1013 /*** SURF Platform *************************/
1014 /*******************************************/
1015 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
1016 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
1017 XBT_PUBLIC_DATA(AS_t) surf_AS_get_by_name(const char * name);
1018 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
1019 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
1020 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
1021 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
1022 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
1023 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_netcard_t edge);
1025 /*******************************************/
1026 /*** SURF Globals **************************/
1027 /*******************************************/
1029 /** \ingroup SURF_simulation
1030 * \brief Initialize SURF
1031 * \param argc argument number
1032 * \param argv arguments
1034 * This function has to be called to initialize the common
1035 * structures. Then you will have to create the environment by
1037 * e.g. surf_host_model_init_CM02()
1039 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
1041 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
1043 /** \ingroup SURF_simulation
1044 * \brief Finish simulation initialization
1046 * This function must be called before the first call to surf_solve()
1048 XBT_PUBLIC(void) surf_presolve(void);
1050 /** \ingroup SURF_simulation
1051 * \brief Performs a part of the simulation
1052 * \param max_date Maximum date to update the simulation to, or -1
1053 * \return the elapsed time, or -1.0 if no event could be executed
1055 * This function execute all possible events, update the action states
1056 * and returns the time elapsed.
1057 * When you call execute or communicate on a model, the corresponding actions
1058 * are not executed immediately but only when you call surf_solve.
1059 * Note that the returned elapsed time can be zero.
1061 XBT_PUBLIC(double) surf_solve(double max_date);
1063 /** \ingroup SURF_simulation
1064 * \brief Return the current time
1066 * Return the current time in millisecond.
1068 XBT_PUBLIC(double) surf_get_clock(void);
1070 /** \ingroup SURF_simulation
1077 XBT_PUBLIC(void) surf_exit(void);
1079 /* Prototypes of the functions that handle the properties */
1080 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
1082 /* The same for model_prop set*/
1083 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
1085 /* surf parse file related (public because called from a test suite) */
1086 XBT_PUBLIC(void) parse_platform_file(const char *file);
1088 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
1089 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
1090 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
1091 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
1092 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
1093 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
1094 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
1097 XBT_PUBLIC(double) get_cpu_speed(const char *power);
1099 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
1101 int surf_get_nthreads(void);
1102 void surf_set_nthreads(int nthreads);
1105 * Returns the initial path. On Windows the initial path is
1106 * the current directory for the current process in the other
1107 * case the function returns "./" that represents the current
1108 * directory on Unix/Linux platforms.
1110 const char *__surf_get_initial_path(void);
1112 /********** Tracing **********/
1113 /* from surf_instr.c */
1114 void TRACE_surf_action(surf_action_t surf_action, const char *category);
1115 void TRACE_surf_alloc(void);
1116 void TRACE_surf_release(void);
1118 /* instr_routing.c */
1119 void instr_routing_define_callbacks (void);
1120 void instr_new_variable_type (const char *new_typename, const char *color);
1121 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
1122 void instr_new_user_state_type (const char *father_type, const char *new_typename);
1123 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
1124 int instr_platform_traced (void);
1125 xbt_graph_t instr_routing_platform_graph (void);
1126 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1128 /********** Routing **********/
1129 void routing_AS_begin(sg_platf_AS_cbarg_t AS);
1130 void routing_AS_end(void);
1131 surf_NetCard* routing_add_host(surf_As* as, sg_platf_host_cbarg_t host);
1132 void routing_cluster_add_backbone(void* bb);
1133 surf_As* routing_get_current();
1136 #endif /* _SURF_SURF_H */