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 computation action on the given host */
308 XBT_PUBLIC(surf_action_t) surf_host_execute(sg_host_t host, double size);
310 /** @brief Create a sleep action on the given host */
311 XBT_PUBLIC(surf_action_t) surf_host_sleep(sg_host_t host, double duration);
313 /** @brief Create a file opening action on the given host */
314 XBT_PUBLIC(surf_action_t) surf_host_open(sg_host_t host, const char* fullpath);
316 /** @brief Create a file closing action on the given host */
317 XBT_PUBLIC(surf_action_t) surf_host_close(sg_host_t host, surf_file_t fd);
319 /** @brief Create a file reading action on the given host */
320 XBT_PUBLIC(surf_action_t) surf_host_read(sg_host_t host, surf_file_t fd, sg_size_t size);
322 /** @brief Create a file writing action on the given host */
323 XBT_PUBLIC(surf_action_t) surf_host_write(sg_host_t host, surf_file_t fd, sg_size_t size);
326 * @brief Get the informations of a file descriptor
327 * @details The returned xbt_dynar_t contains:
328 * - the size of the file,
330 * - the storage name,
331 * - the storage typeId,
332 * - the storage content type
334 * @param host The surf host
335 * @param fd The file descriptor
336 * @return An xbt_dynar_t with the file informations
338 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(sg_host_t host, surf_file_t fd);
341 * @brief Get the available space of the storage at the mount point
343 * @param resource The surf host
344 * @param name The mount point
345 * @return The amount of available space in bytes
347 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(sg_host_t resource, const char* name);
350 * @brief Get the used space of the storage at the mount point
352 * @param resource The surf host
353 * @param name The mount point
354 * @return The amount of used space in bytes
356 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(sg_host_t resource, const char* name);
358 /** @brief Get the list of VMs hosted on the host */
359 XBT_PUBLIC(xbt_dynar_t) surf_host_get_vms(sg_host_t resource);
361 /** @brief Retrieve the params of that VM
362 * @details You can use fields ramsize and overcommit on a PM, too.
364 XBT_PUBLIC(void) surf_host_get_params(sg_host_t resource, vm_params_t params);
366 /** @brief Sets the params of that VM/PM
367 * @details You can use fields ramsize and overcommit on a PM, too.
369 XBT_PUBLIC(void) surf_host_set_params(sg_host_t resource, vm_params_t params);
372 * @brief Destroy a VM
374 * @param resource The surf vm
376 XBT_PUBLIC(void) surf_vm_destroy(sg_host_t resource);
378 /** @brief Suspend a VM */
379 XBT_PUBLIC(void) surf_vm_suspend(sg_host_t resource);
381 /** @brief Resume a VM */
382 XBT_PUBLIC(void) surf_vm_resume(sg_host_t resource);
385 * @brief Save the VM (Not yet implemented)
387 * @param resource The surf vm
389 XBT_PUBLIC(void) surf_vm_save(sg_host_t resource);
392 * @brief Restore the VM (Not yet implemented)
394 * @param resource The surf vm
396 XBT_PUBLIC(void) surf_vm_restore(sg_host_t resource);
399 * @brief Migrate the VM to the destination host
401 * @param resource The surf vm
402 * @param ind_vm_ws_dest The destination host
404 XBT_PUBLIC(void) surf_vm_migrate(sg_host_t resource, sg_host_t ind_vm_ws_dest);
407 * @brief Get the physical machine hosting the VM
409 * @param resource The surf vm
410 * @return The physical machine hosting the VM
412 XBT_PUBLIC(sg_host_t) surf_vm_get_pm(sg_host_t resource);
415 * @brief [brief description]
416 * @details [long description]
418 * @param resource [description]
419 * @param bound [description]
421 XBT_PUBLIC(void) surf_vm_set_bound(sg_host_t resource, double bound);
424 * @brief [brief description]
425 * @details [long description]
427 * @param resource [description]
428 * @param cpu [description]
429 * @param mask [description]
431 XBT_PUBLIC(void) surf_vm_set_affinity(sg_host_t resource, sg_host_t cpu, unsigned long mask);
434 * @brief Get the host power peak
435 * @details [long description]
437 * @param host The surf host
438 * @return The power peak
440 XBT_PUBLIC(double) surf_host_get_current_power_peak(sg_host_t host);
443 * @brief [brief description]
444 * @details [long description]
446 * @param host [description]
447 * @param pstate_index [description]
449 * @return [description]
451 XBT_PUBLIC(double) surf_host_get_power_peak_at(sg_host_t host, int pstate_index);
454 * @brief [brief description]
455 * @details [long description]
457 * @param host [description]
458 * @return [description]
460 XBT_PUBLIC(int) surf_host_get_nb_pstates(sg_host_t host);
462 XBT_PUBLIC(void) surf_host_set_pstate(sg_host_t host, int pstate_index);
463 XBT_PUBLIC(int) surf_host_get_pstate(sg_host_t host);
464 XBT_PUBLIC(double) surf_host_get_wattmin_at(sg_host_t resource, int pstate);
465 XBT_PUBLIC(double) surf_host_get_wattmax_at(sg_host_t resource, int pstate);
468 * @brief Get the consumed energy (in joules) of an host
470 * @param host The surf host
471 * @return The consumed energy
473 XBT_PUBLIC(double) surf_host_get_consumed_energy(sg_host_t host);
476 * @brief Get the list of storages mounted on an host
478 * @param host The surf host
479 * @return Dictionary of mount point, Storage
481 XBT_PUBLIC(xbt_dict_t) surf_host_get_mounted_storage_list(sg_host_t host);
484 * @brief Get the list of storages attached to an host
486 * @param host The surf host
487 * @return Dictionary of storage
489 XBT_PUBLIC(xbt_dynar_t) surf_host_get_attached_storage_list(sg_host_t host);
492 * @brief Unlink a file descriptor
494 * @param host The surf host
495 * @param fd The file descriptor
497 * @return 0 if failed to unlink, 1 otherwise
499 XBT_PUBLIC(int) surf_host_unlink(sg_host_t host, surf_file_t fd);
502 * @brief Get the size of a file on a host
504 * @param host The surf host
505 * @param fd The file descriptor
507 * @return The size in bytes of the file
509 XBT_PUBLIC(size_t) surf_host_get_size(sg_host_t host, surf_file_t fd);
512 * @brief Get the current position of the file descriptor
514 * @param host The surf host
515 * @param fd The file descriptor
516 * @return The current position of the file descriptor
518 XBT_PUBLIC(size_t) surf_host_file_tell(sg_host_t host, surf_file_t fd);
521 * @brief Move a file to another location on the *same mount point*.
522 * @details [long description]
524 * @param host The surf host
525 * @param fd The file descriptor
526 * @param fullpath The new full path
528 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
530 XBT_PUBLIC(int) surf_host_file_move(sg_host_t host, surf_file_t fd, const char* fullpath);
533 * @brief Set the position indictator assiociated with the file descriptor to a new position
534 * @details [long description]
536 * @param host The surf host
537 * @param fd The file descriptor
538 * @param offset The offset from the origin
539 * @param origin Position used as a reference for the offset
540 * - SEEK_SET: beginning of the file
541 * - SEEK_CUR: current position indicator
542 * - SEEK_END: end of the file
543 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
545 XBT_PUBLIC(int) surf_host_file_seek(sg_host_t host,
546 surf_file_t fd, sg_offset_t offset,
550 * @brief Get the content of a storage
552 * @param resource The surf storage
553 * @return A xbt_dict_t with path as keys and size in bytes as values
555 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
558 * @brief Get the size in bytes of a storage
560 * @param resource The surf storage
561 * @return The size in bytes of the storage
563 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
566 * @brief Get the available size in bytes of a storage
568 * @param resource The surf storage
569 * @return The available size in bytes of the storage
571 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
574 * @brief Get the size in bytes of a storage
576 * @param resource The surf storage
577 * @return The used size in bytes of the storage
579 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
581 /** @brief return the properties set associated to that storage */
582 XBT_PUBLIC(xbt_dict_t) surf_storage_get_properties(surf_resource_t resource);
585 * @brief Get the data associated to the action
587 * @param action The surf action
588 * @return The data associated to the action
590 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
593 * @brief Set the data associated to the action
594 * @details [long description]
596 * @param action The surf action
597 * @param data The new data associated to the action
599 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
602 * @brief Get the start time of an action
604 * @param action The surf action
605 * @return The start time in seconds from the beginning of the simulation
607 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
610 * @brief Get the finish time of an action
612 * @param action The surf action
613 * @return The finish time in seconds from the beginning of the simulation
615 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
618 * @brief Get the remains amount of work to do of an action
620 * @param action The surf action
621 * @return The remains amount of work to do
623 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
626 * @brief Suspend an action
628 * @param action The surf action
630 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
633 * @brief Resume an action
635 * @param action The surf action
637 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
640 * @brief Cancel an action
642 * @param action The surf action
644 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
647 * @brief Set the priority of an action
648 * @details [long description]
650 * @param action The surf action
651 * @param priority The new priority [TODO]
653 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
656 * @brief Set the category of an action
657 * @details [long description]
659 * @param action The surf action
660 * @param category The new category of the action
662 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
665 * @brief Get the state of an action
667 * @param action The surf action
668 * @return The state of the action
670 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
673 * @brief Get the cost of an action
675 * @param action The surf action
676 * @return The cost of the action
678 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
681 * @brief [brief desrciption]
682 * @details [long description]
684 * @param action The surf cpu action
685 * @param cpu [description]
686 * @param mask [description]
688 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, sg_host_t cpu, unsigned long mask);
691 * @brief [brief description]
692 * @details [long description]
694 * @param action The surf cpu action
695 * @param bound [description]
697 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
700 * @brief [brief description]
701 * @details [long description]
703 * @param action The surf network action
705 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
708 * @brief Get the file associated to a storage action
710 * @param action The surf storage action
711 * @return The file associated to a storage action
713 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
716 * @brief Get the result dictionary of an ls action
718 * @param action The surf storage action
719 * @return The dictionry listing a path
721 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
725 * @brief Get the host the storage is attached to
727 * @param resource The surf storage
728 * @return The host name
731 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
733 XBT_PUBLIC(surf_host_model_t) surf_host_get_model(sg_host_t host);
737 /**************************************/
738 /* Implementations of model object */
739 /**************************************/
741 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
742 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
744 /** \ingroup SURF_models
745 * \brief The CPU model object for the physical machine layer
747 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
749 /** \ingroup SURF_models
750 * \brief The CPU model object for the virtual machine layer
752 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
755 /** \ingroup SURF_models
756 * \brief Initializes the CPU model with the model Cas01
758 * By default, this model uses the lazy optimization mechanism that
759 * relies on partial invalidation in LMM and a heap for lazy action update.
760 * You can change this behavior by setting the cpu/optim configuration
761 * variable to a different value.
763 * You shouldn't have to call it by yourself.
765 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
767 /** \ingroup SURF_models
768 * \brief Initializes the CPU model with trace integration [Deprecated]
770 * You shouldn't have to call it by yourself.
772 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
774 /** \ingroup SURF_models
775 * \brief The list of all available optimization modes (both for cpu and networks).
776 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
778 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
780 /** \ingroup SURF_plugins
781 * \brief The list of all available surf plugins
783 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
785 /** \ingroup SURF_models
786 * \brief The list of all available cpu model models
788 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
790 /**\brief create new host bypass the parser
795 /** \ingroup SURF_models
796 * \brief The network model
798 * When creating a new API on top on SURF, you shouldn't use the
799 * network model unless you know what you are doing. Only the host
800 * model should be accessed because depending on the platform model,
801 * the network model can be NULL.
803 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
805 /** \ingroup SURF_models
806 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
808 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
809 * based on the model 'LV08' and different correction factors depending on the communication
810 * size (< 1KiB, < 64KiB, >= 64KiB).
811 * See comments in the code for more information.
813 * \see surf_host_model_init_SMPI()
815 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
817 /** \ingroup SURF_models
818 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
820 * This model impelments a variant of the contention model on Infinband networks based on
821 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
823 * \see surf_host_model_init_IB()
825 XBT_PUBLIC(void) surf_network_model_init_IB(void);
827 /** \ingroup SURF_models
828 * \brief Initializes the platform with the network model 'LegrandVelho'
830 * This model is proposed by Arnaud Legrand and Pedro Velho based on
831 * the results obtained with the GTNets simulator for onelink and
832 * dogbone sharing scenarios. See comments in the code for more information.
834 * \see surf_host_model_init_LegrandVelho()
836 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
838 /** \ingroup SURF_models
839 * \brief Initializes the platform with the network model 'Constant'
841 * In this model, the communication time between two network cards is
842 * constant, hence no need for a routing table. This is particularly
843 * usefull when simulating huge distributed algorithms where
844 * scalability is really an issue. This function is called in
845 * conjunction with surf_host_model_init_compound.
847 * \see surf_host_model_init_compound()
849 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
851 /** \ingroup SURF_models
852 * \brief Initializes the platform with the network model CM02
854 * You sould call this function by yourself only if you plan using
855 * surf_host_model_init_compound.
856 * See comments in the code for more information.
858 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
861 /** \ingroup SURF_models
862 * \brief Initializes the platform with the network model NS3
864 * This function is called by surf_host_model_init_NS3
865 * or by yourself only if you plan using surf_host_model_init_compound
867 * \see surf_host_model_init_NS3()
869 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
872 /** \ingroup SURF_models
873 * \brief Initializes the platform with the network model Reno
875 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
878 * [LOW03] 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_Reno(void);
886 /** \ingroup SURF_models
887 * \brief Initializes the platform with the network model Reno2
889 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
892 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
893 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
895 * Call this function only if you plan using surf_host_model_init_compound.
898 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
900 /** \ingroup SURF_models
901 * \brief Initializes the platform with the network model Vegas
903 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
904 * to the proportional fairness.
907 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
908 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
910 * Call this function only if you plan using surf_host_model_init_compound.
913 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
915 /** \ingroup SURF_models
916 * \brief The list of all available network model models
918 XBT_PUBLIC_DATA(s_surf_model_description_t)
919 surf_network_model_description[];
921 /** \ingroup SURF_models
922 * \brief The storage model
924 XBT_PUBLIC(void) surf_storage_model_init_default(void);
926 /** \ingroup SURF_models
927 * \brief The list of all available storage modes.
928 * This storage mode can be set using --cfg=storage/model:...
930 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
932 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
934 /** \ingroup SURF_models
935 * \brief The host model
937 * Note that when you create an API on top of SURF,
938 * the host model should be the only one you use
939 * because depending on the platform model, the network model and the CPU model
942 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
944 /** \ingroup SURF_models
945 * \brief The vm model
947 * Note that when you create an API on top of SURF,
948 * the vm model should be the only one you use
949 * because depending on the platform model, the network model and the CPU model
952 XBT_PUBLIC_DATA(surf_vm_model_t) surf_vm_model;
954 /** \ingroup SURF_models
955 * \brief Initializes the platform with a compound host model
957 * This function should be called after a cpu_model and a
958 * network_model have been set up.
961 XBT_PUBLIC(void) surf_host_model_init_compound(void);
963 /** \ingroup SURF_models
964 * \brief Initializes the platform with the current best network and cpu models at hand
966 * This platform model separates the host model and the network model.
967 * The host model will be initialized with the model compound, the network
968 * model with the model LV08 (with cross traffic support) and the CPU model with
970 * Such model is subject to modification with warning in the ChangeLog so monitor it!
973 XBT_PUBLIC(void) surf_host_model_init_current_default(void);
975 /** \ingroup SURF_models
976 * \brief Initializes the platform with the model L07
978 * With this model, only parallel tasks can be used. Resource sharing
979 * is done by identifying bottlenecks and giving an equal share of
980 * the model to each action.
983 XBT_PUBLIC(void) surf_host_model_init_ptask_L07(void);
985 /** \ingroup SURF_models
986 * \brief The list of all available host model models
988 XBT_PUBLIC_DATA(s_surf_model_description_t)
989 surf_host_model_description[];
991 /** \ingroup SURF_models
992 * \brief Initializes the platform with the current best network and cpu models at hand
994 * This platform model seperates the host model and the network model.
995 * The host model will be initialized with the model compound, the network
996 * model with the model LV08 (with cross traffic support) and the CPU model with
998 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1001 XBT_PUBLIC(void) surf_vm_model_init_HL13(void);
1003 /** \ingroup SURF_models
1004 * \brief The list of all available vm model models
1006 XBT_PUBLIC_DATA(s_surf_model_description_t)
1007 surf_vm_model_description[];
1009 /*******************************************/
1011 /** \ingroup SURF_models
1012 * \brief List of initialized models
1014 XBT_PUBLIC_DATA(xbt_dynar_t) all_existing_models;
1016 /** \ingroup SURF_simulation
1017 * \brief List of hosts that have just restarted and whose autorestart process should be restarted.
1019 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
1021 /** \ingroup SURF_simulation
1022 * \brief List of hosts for which one want to be notified if they ever restart.
1024 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
1026 /*******************************************/
1027 /*** SURF Platform *************************/
1028 /*******************************************/
1029 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
1030 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
1031 XBT_PUBLIC_DATA(AS_t) surf_AS_get_by_name(const char * name);
1032 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
1033 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
1034 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
1035 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
1036 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
1037 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_netcard_t edge);
1039 /*******************************************/
1040 /*** SURF Globals **************************/
1041 /*******************************************/
1043 /** \ingroup SURF_simulation
1044 * \brief Initialize SURF
1045 * \param argc argument number
1046 * \param argv arguments
1048 * This function has to be called to initialize the common
1049 * structures. Then you will have to create the environment by
1051 * e.g. surf_host_model_init_CM02()
1053 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
1055 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
1057 /** \ingroup SURF_simulation
1058 * \brief Finish simulation initialization
1060 * This function must be called before the first call to surf_solve()
1062 XBT_PUBLIC(void) surf_presolve(void);
1064 /** \ingroup SURF_simulation
1065 * \brief Performs a part of the simulation
1066 * \param max_date Maximum date to update the simulation to, or -1
1067 * \return the elapsed time, or -1.0 if no event could be executed
1069 * This function execute all possible events, update the action states
1070 * and returns the time elapsed.
1071 * When you call execute or communicate on a model, the corresponding actions
1072 * are not executed immediately but only when you call surf_solve.
1073 * Note that the returned elapsed time can be zero.
1075 XBT_PUBLIC(double) surf_solve(double max_date);
1077 /** \ingroup SURF_simulation
1078 * \brief Return the current time
1080 * Return the current time in millisecond.
1082 XBT_PUBLIC(double) surf_get_clock(void);
1084 /** \ingroup SURF_simulation
1091 XBT_PUBLIC(void) surf_exit(void);
1093 /* Prototypes of the functions that handle the properties */
1094 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
1096 /* The same for model_prop set*/
1097 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
1099 /* surf parse file related (public because called from a test suite) */
1100 XBT_PUBLIC(void) parse_platform_file(const char *file);
1102 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
1103 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
1104 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
1105 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
1106 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
1107 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
1108 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
1111 XBT_PUBLIC(double) get_cpu_speed(const char *power);
1113 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
1115 int surf_get_nthreads(void);
1116 void surf_set_nthreads(int nthreads);
1119 * Returns the initial path. On Windows the initial path is
1120 * the current directory for the current process in the other
1121 * case the function returns "./" that represents the current
1122 * directory on Unix/Linux platforms.
1124 const char *__surf_get_initial_path(void);
1126 /********** Tracing **********/
1127 /* from surf_instr.c */
1128 void TRACE_surf_action(surf_action_t surf_action, const char *category);
1129 void TRACE_surf_alloc(void);
1130 void TRACE_surf_release(void);
1132 /* instr_routing.c */
1133 void instr_routing_define_callbacks (void);
1134 void instr_new_variable_type (const char *new_typename, const char *color);
1135 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
1136 void instr_new_user_state_type (const char *father_type, const char *new_typename);
1137 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
1138 int instr_platform_traced (void);
1139 xbt_graph_t instr_routing_platform_graph (void);
1140 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1142 /********** Routing **********/
1143 void routing_AS_begin(sg_platf_AS_cbarg_t AS);
1144 void routing_AS_end(void);
1145 surf_NetCard* routing_add_host(surf_As* as, sg_platf_host_cbarg_t host);
1146 void routing_cluster_add_backbone(void* bb);
1147 surf_As* routing_get_current();
1150 #endif /* _SURF_SURF_H */