1 /* Copyright (c) 2004-2014. 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"
16 #include "xbt/config.h"
17 #include "surf/datatypes.h"
19 #include "surf/surf_routing.h"
20 #include "simgrid/platf_interface.h"
21 #include "simgrid/datatypes.h"
22 #include "simgrid/plugins.h"
25 /* Actions and models are highly connected structures... */
27 /* user-visible parameters */
28 extern double sg_tcp_gamma;
29 extern double sg_sender_gap;
30 extern double sg_latency_factor;
31 extern double sg_bandwidth_factor;
32 extern double sg_weight_S_parameter;
33 extern int sg_network_crosstraffic;
35 extern double sg_gtnets_jitter;
36 extern int sg_gtnets_jitter_seed;
38 extern xbt_dynar_t surf_path;
41 SURF_NETWORK_ELEMENT_NULL = 0, /* NULL */
42 SURF_NETWORK_ELEMENT_HOST, /* host type */
43 SURF_NETWORK_ELEMENT_ROUTER, /* router type */
44 SURF_NETWORK_ELEMENT_AS /* AS type */
45 } e_surf_network_element_type_t;
58 class NetworkCm02Link;
61 class StorageActionLmm;
66 typedef struct Model Model;
67 typedef struct CpuModel CpuModel;
68 typedef struct HostModel HostModel;
69 typedef struct VMModel VMModel;
70 typedef struct NetworkModel NetworkModel;
71 typedef struct StorageModel StorageModel;
72 typedef struct Resource Resource;
73 typedef struct ResourceLmm ResourceLmm;
74 typedef struct HostCLM03 HostCLM03;
75 typedef struct Host Host;
76 typedef struct NetworkCm02Link NetworkCm02Link;
77 typedef struct Action Action;
78 typedef struct ActionLmm ActionLmm;
79 typedef struct StorageActionLmm StorageActionLmm;
81 typedef struct RoutingEdge RoutingEdge;
82 typedef struct RoutingPlatf RoutingPlatf;
85 /** @ingroup SURF_c_bindings
86 * \brief Model datatype
88 * Generic data structure for a model. The hosts,
89 * the CPUs and the network links are examples of models.
91 typedef Model *surf_model_t;
92 typedef CpuModel *surf_cpu_model_t;
93 typedef HostModel *surf_host_model_t;
94 typedef VMModel *surf_vm_model_t;
96 typedef NetworkModel *surf_network_model_t;
97 typedef StorageModel *surf_storage_model_t;
99 typedef xbt_dictelm_t surf_resource_t;
100 typedef Resource *surf_cpp_resource_t;
101 typedef Host *surf_host_t;
103 /** @ingroup SURF_c_bindings
104 * \brief Action structure
106 * Never create s_surf_action_t by yourself ! The actions are created
107 * on the fly when you call execute or communicate on a model.
109 * \see e_surf_action_state_t
111 typedef Action *surf_action_t;
114 typedef RoutingEdge *routing_edge_t;
115 typedef RoutingPlatf *routing_platf_t;
117 typedef struct surf_file *surf_file_t;
119 XBT_PUBLIC(e_surf_network_element_type_t)
120 routing_get_network_element_type(const char* name);
122 /** @Brief Specify that we use that action */
123 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
125 /** @brief Creates a new action.
127 * @param size The size is the one of the subtype you want to create
128 * @param cost initial value
129 * @param model to which model we should attach this action
130 * @param failed whether we should start this action in failed mode
132 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
133 surf_model_t model, int failed);
135 /** \brief Resource model description
137 typedef struct surf_model_description {
139 const char *description;
140 void_f_void_t model_init_preparse;
141 } s_surf_model_description_t, *surf_model_description_t;
143 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
145 XBT_PUBLIC(void) model_help(const char *category,
146 s_surf_model_description_t * table);
148 /** @ingroup SURF_interface
149 * @brief Action states
156 SURF_ACTION_READY = 0, /**< Ready */
157 SURF_ACTION_RUNNING, /**< Running */
158 SURF_ACTION_FAILED, /**< Task Failure */
159 SURF_ACTION_DONE, /**< Completed */
160 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
161 SURF_ACTION_NOT_IN_THE_SYSTEM /**< Not in the system anymore. Why did you ask ? */
162 } e_surf_action_state_t;
164 /** @ingroup SURF_vm_interface
168 /* FIXME: Where should the VM state be defined? */
170 SURF_VM_STATE_CREATED, /**< created, but not yet started */
171 SURF_VM_STATE_RUNNING,
172 SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
174 SURF_VM_STATE_SAVING, /**< Save/restore involves disk I/O, so there should be transition states. */
176 SURF_VM_STATE_RESTORING,
179 /***************************/
180 /* Generic model object */
181 /***************************/
183 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
185 static inline surf_host_t surf_host_resource_priv(const void *host){
186 return (surf_host_t) xbt_lib_get_level((xbt_dictelm_t)host, SURF_HOST_LEVEL);
188 static inline void *surf_storage_resource_priv(const void *storage){
189 return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
192 static inline void *surf_storage_resource_by_name(const char *name){
193 return xbt_lib_get_elm_or_null(storage_lib, name);
197 XBT_PUBLIC(void *) surf_as_cluster_get_backbone(AS_t as);
198 XBT_PUBLIC(void) surf_as_cluster_set_backbone(AS_t as, void* backbone);
200 /** @{ @ingroup SURF_c_bindings */
203 * @brief Get the name of a surf model
205 * @param model A model
206 * @return The name of the model
208 XBT_PUBLIC(const char *) surf_model_name(surf_model_t model);
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 Pop an action from the ready actions set
229 * @param model The model from which the action is extracted
230 * @return An action in ready state
232 XBT_PUBLIC(surf_action_t) surf_model_extract_ready_action_set(surf_model_t model);
235 * @brief Pop an action from the running actions set
237 * @param model The model from which the action is extracted
238 * @return An action in running state
240 XBT_PUBLIC(surf_action_t) surf_model_extract_running_action_set(surf_model_t model);
243 * @brief Get the size of the running action set of a model
245 * @param model The model
246 * @return The size of the running action set
248 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
251 * @brief Execute a parallel task
252 * @details [long description]
254 * @param model The model which handle the parallelisation
255 * @param host_nb The number of hosts
256 * @param host_list The list of hosts on which the task is executed
257 * @param flops_amount The processing amount (in flop) needed to process
258 * @param bytes_amount The amount of data (in bytes) needed to transfer
259 * @param rate [description]
260 * @return The action corresponding to the parallele execution task
262 XBT_PUBLIC(surf_action_t) surf_host_model_execute_parallel_task(surf_host_model_t model,
265 double *flops_amount,
266 double *bytes_amount,
270 * @brief Create a communication between two hosts
272 * @param model The model which handle the communication
273 * @param src The source host
274 * @param dst The destination host
275 * @param size The amount of data (in bytes) needed to transfer
276 * @param rate [description]
277 * @return The action corresponding to the communication
279 XBT_PUBLIC(surf_action_t) surf_host_model_communicate(surf_host_model_t model, surf_resource_t src, surf_resource_t dst, double size, double rate);
282 * @brief Get the route between two hosts
283 * @details [long description]
285 * @param model The model which handle the routes
286 * @param src The source host
287 * @param dst The destination host
288 * @return The list of [TODO] from the source to the host
290 XBT_PUBLIC(xbt_dynar_t) surf_host_model_get_route(surf_host_model_t model, surf_resource_t src, surf_resource_t dst);
293 * @brief Create a new VM on the specified host
295 * @param name The name of the VM
296 * @param host_PM The host on which the VM is created
298 XBT_PUBLIC(void) surf_vm_model_create(const char *name, surf_resource_t host_PM);
301 * @brief Create a communication between two routing edges [TODO]
302 * @details [long description]
304 * @param model The model which handle the communication
305 * @param src The source host
306 * @param dst The destination host
307 * @param size The amount of data (in bytes) needed to transfer
308 * @param rate [description]
309 * @return The action corresponding to the communication
311 XBT_PUBLIC(surf_action_t) surf_network_model_communicate(surf_network_model_t model, sg_routing_edge_t src, sg_routing_edge_t dst, double size, double rate);
314 * @brief Get the name of a surf resource (cpu, host, network, …)
316 * @param resource The surf resource
317 * @return The name of the surf resource
319 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
320 static inline const char * surf_cpu_name(surf_cpu_t cpu) {
321 return surf_resource_name((surf_cpp_resource_t)cpu);
325 * @brief Get the properties of a surf resource (cpu, host, network, …)
327 * @param resource The surf resource
328 * @return The properties of the surf resource
330 XBT_PUBLIC(xbt_dict_t) surf_resource_get_properties(surf_cpp_resource_t resource);
331 static XBT_INLINE xbt_dict_t surf_host_get_properties(surf_host_t host) {
332 return surf_resource_get_properties((surf_cpp_resource_t)host);
337 * @brief Get the state of a surf resource (cpu, host, network, …)
339 * @param resource The surf resource
340 * @return The state of the surf resource
342 XBT_PUBLIC(e_surf_resource_state_t) surf_resource_get_state(surf_cpp_resource_t resource);
344 static XBT_INLINE e_surf_resource_state_t surf_host_get_state(surf_host_t host) {
345 return surf_resource_get_state((surf_cpp_resource_t)host);
350 * @brief Set the state of a surf resource (cpu, host, network, …)
352 * @param resource The surf resource
353 * @param state The new state of the surf resource
355 XBT_PUBLIC(void) surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state);
356 static inline void surf_host_set_state(surf_host_t host, e_surf_resource_state_t state) {
357 surf_resource_set_state((surf_cpp_resource_t)host, state);
361 * @brief Get the speed of the cpu associated to a host
363 * @param resource The surf host
364 * @param load [description]
366 * @return [description]
368 XBT_PUBLIC(double) surf_host_get_speed(surf_resource_t resource, double load);
371 * @brief Get the available speed of cpu associated to a host
373 * @param resource The surf host
374 * @return [description]
376 XBT_PUBLIC(double) surf_host_get_available_speed(surf_resource_t resource);
379 * @brief Get the number of cores of the cpu associated to a host
381 * @param resource The surf host
382 * @return The number of cores
384 XBT_PUBLIC(int) surf_host_get_core(surf_resource_t resource);
387 * @brief Execute some quantity of computation
389 * @param resource The surf host
390 * @param size The value of the processing amount (in flop) needed to process
392 * @return The surf action corresponding to the processing
394 XBT_PUBLIC(surf_action_t) surf_host_execute(surf_resource_t resource, double size);
397 * @brief Make the host sleep
399 * @param resource The surf host
400 * @param duration The number of seconds to sleep
401 * @return The surf action corresponding to the sleep
403 XBT_PUBLIC(surf_action_t) surf_host_sleep(surf_resource_t resource, double duration);
406 * @brief Open a file on an host
408 * @param host The surf host
409 * @param fullpath The path to the file
410 * @return The surf action corresponding to the openning
412 XBT_PUBLIC(surf_action_t) surf_host_open(surf_resource_t host, const char* fullpath);
415 * @brief Close a file descriptor on an host
417 * @param host The surf host
418 * @param fd The file descriptor
420 * @return The surf action corresponding to the closing
422 XBT_PUBLIC(surf_action_t) surf_host_close(surf_resource_t host, surf_file_t fd);
427 * @param host The surf host
428 * @param fd The file descriptor to read
429 * @param size The size in bytes to read
430 * @return The surf action corresponding to the reading
432 XBT_PUBLIC(surf_action_t) surf_host_read(surf_resource_t host, surf_file_t fd, sg_size_t size);
435 * @brief Write a file
437 * @param host The surf host
438 * @param fd The file descriptor to write
439 * @param size The size in bytes to write
440 * @return The surf action corresponding to the writing
442 XBT_PUBLIC(surf_action_t) surf_host_write(surf_resource_t host, surf_file_t fd, sg_size_t size);
445 * @brief Get the informations of a file descriptor
446 * @details The returned xbt_dynar_t contains:
447 * - the size of the file,
449 * - the storage name,
450 * - the storage typeId,
451 * - the storage content type
453 * @param host The surf host
454 * @param fd The file descriptor
455 * @return An xbt_dynar_t with the file informations
457 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(surf_resource_t host, surf_file_t fd);
460 * @brief Get the available space of the storage at the mount point
462 * @param resource The surf host
463 * @param name The mount point
464 * @return The amount of available space in bytes
466 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(surf_resource_t resource, const char* name);
469 * @brief Get the used space of the storage at the mount point
471 * @param resource The surf host
472 * @param name The mount point
473 * @return The amount of used space in bytes
475 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(surf_resource_t resource, const char* name);
478 * @brief Get the VMs hosted on the host
480 * @param resource The surf host
481 * @return The list of VMs on the host
483 XBT_PUBLIC(xbt_dynar_t) surf_host_get_vms(surf_resource_t resource);
486 * @brief [brief description]
487 * @details [long description]
489 * @param resource [description]
490 * @param params [description]
492 XBT_PUBLIC(void) surf_host_get_params(surf_resource_t resource, ws_params_t params);
495 * @brief [brief description]
496 * @details [long description]
498 * @param resource [description]
499 * @param params [description]
501 XBT_PUBLIC(void) surf_host_set_params(surf_resource_t resource, ws_params_t params);
504 * @brief Destroy a VM
506 * @param resource The surf vm
508 XBT_PUBLIC(void) surf_vm_destroy(surf_resource_t resource);
511 * @brief Suspend a VM
513 * @param resource The surf vm
515 XBT_PUBLIC(void) surf_vm_suspend(surf_resource_t resource);
520 * @param resource The surf vm
522 XBT_PUBLIC(void) surf_vm_resume(surf_resource_t resource);
525 * @brief Save the VM (Not yet implemented)
527 * @param resource The surf vm
529 XBT_PUBLIC(void) surf_vm_save(surf_resource_t resource);
532 * @brief Restore the VM (Not yet implemented)
534 * @param resource The surf vm
536 XBT_PUBLIC(void) surf_vm_restore(surf_resource_t resource);
539 * @brief Migrate the VM to the destination host
541 * @param resource The surf vm
542 * @param ind_vm_ws_dest The destination host
544 XBT_PUBLIC(void) surf_vm_migrate(surf_resource_t resource, surf_resource_t ind_vm_ws_dest);
547 * @brief Get the physical machine hosting the VM
549 * @param resource The surf vm
550 * @return The physical machine hosting the VM
552 XBT_PUBLIC(surf_resource_t) surf_vm_get_pm(surf_resource_t resource);
555 * @brief [brief description]
556 * @details [long description]
558 * @param resource [description]
559 * @param bound [description]
561 XBT_PUBLIC(void) surf_vm_set_bound(surf_resource_t resource, double bound);
564 * @brief [brief description]
565 * @details [long description]
567 * @param resource [description]
568 * @param cpu [description]
569 * @param mask [description]
571 XBT_PUBLIC(void) surf_vm_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask);
574 * @brief Execute some quantity of computation
576 * @param cpu The surf cpu
577 * @param size The value of the processing amount (in flop) needed to process
578 * @return The surf action corresponding to the processing
580 XBT_PUBLIC(surf_action_t) surf_cpu_execute(surf_resource_t cpu, double size);
583 * @brief Make the cpu sleep for duration (in seconds)
584 * @details [long description]
586 * @param cpu The surf cpu
587 * @param duration The number of seconds to sleep
588 * @return The surf action corresponding to the sleeping
590 XBT_PUBLIC(surf_action_t) surf_cpu_sleep(surf_resource_t cpu, double duration);
593 * @brief Get the host power peak
594 * @details [long description]
596 * @param host The surf host
597 * @return The power peak
599 XBT_PUBLIC(double) surf_host_get_current_power_peak(surf_resource_t host);
602 * @brief [brief description]
603 * @details [long description]
605 * @param host [description]
606 * @param pstate_index [description]
608 * @return [description]
610 XBT_PUBLIC(double) surf_host_get_power_peak_at(surf_resource_t host, int pstate_index);
613 * @brief [brief description]
614 * @details [long description]
616 * @param host [description]
617 * @return [description]
619 XBT_PUBLIC(int) surf_host_get_nb_pstates(surf_resource_t host);
621 XBT_PUBLIC(void) surf_host_set_pstate(surf_resource_t host, int pstate_index);
622 XBT_PUBLIC(int) surf_host_get_pstate(surf_resource_t host);
623 XBT_PUBLIC(double) surf_host_get_wattmin_at(surf_resource_t resource, int pstate);
624 XBT_PUBLIC(double) surf_host_get_wattmax_at(surf_resource_t resource, int pstate);
627 * @brief Get the consumed energy (in joules) of an host
629 * @param host The surf host
630 * @return The consumed energy
632 XBT_PUBLIC(double) surf_host_get_consumed_energy(surf_resource_t host);
635 * @brief Get the list of storages mounted on an host
637 * @param host The surf host
638 * @return Dictionary of mount point, Storage
640 XBT_PUBLIC(xbt_dict_t) surf_host_get_mounted_storage_list(surf_resource_t host);
643 * @brief Get the list of storages attached to an host
645 * @param host The surf host
646 * @return Dictionary of storage
648 XBT_PUBLIC(xbt_dynar_t) surf_host_get_attached_storage_list(surf_resource_t host);
651 * @brief Unlink a file descriptor
653 * @param host The surf host
654 * @param fd The file descriptor
656 * @return 0 if failed to unlink, 1 otherwise
658 XBT_PUBLIC(int) surf_host_unlink(surf_resource_t host, surf_file_t fd);
661 * @brief Get the size of a file on a host
663 * @param host The surf host
664 * @param fd The file descriptor
666 * @return The size in bytes of the file
668 XBT_PUBLIC(size_t) surf_host_get_size(surf_resource_t host, surf_file_t fd);
671 * @brief Get the current position of the file descriptor
673 * @param host The surf host
674 * @param fd The file descriptor
675 * @return The current position of the file descriptor
677 XBT_PUBLIC(size_t) surf_host_file_tell(surf_resource_t host, surf_file_t fd);
680 * @brief Move a file to another location on the *same mount point*.
681 * @details [long description]
683 * @param host The surf host
684 * @param fd The file descriptor
685 * @param fullpath The new full path
687 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
689 XBT_PUBLIC(int) surf_host_file_move(surf_resource_t host, surf_file_t fd, const char* fullpath);
692 * @brief Set the position indictator assiociated with the file descriptor to a new position
693 * @details [long description]
695 * @param host The surf host
696 * @param fd The file descriptor
697 * @param offset The offset from the origin
698 * @param origin Position used as a reference for the offset
699 * - SEEK_SET: beginning of the file
700 * - SEEK_CUR: current position indicator
701 * - SEEK_END: end of the file
702 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
704 XBT_PUBLIC(int) surf_host_file_seek(surf_resource_t host,
705 surf_file_t fd, sg_offset_t offset,
709 * @brief Get the content of a storage
711 * @param resource The surf storage
712 * @return A xbt_dict_t with path as keys and size in bytes as values
714 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
717 * @brief Get the size in bytes of a storage
719 * @param resource The surf storage
720 * @return The size in bytes of the storage
722 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
725 * @brief Get the available size in bytes of a storage
727 * @param resource The surf storage
728 * @return The available size in bytes of the storage
730 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
733 * @brief Get the size in bytes of a storage
735 * @param resource The surf storage
736 * @return The used size in bytes of the storage
738 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
742 * @brief Get the data associated to the action
744 * @param action The surf action
745 * @return The data associated to the action
747 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
750 * @brief Set the data associated to the action
751 * @details [long description]
753 * @param action The surf action
754 * @param data The new data associated to the action
756 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
759 * @brief Unreference an action
761 * @param action The surf action
763 XBT_PUBLIC(void) surf_action_unref(surf_action_t action);
766 * @brief Get the start time of an action
768 * @param action The surf action
769 * @return The start time in seconds from the beginning of the simulation
771 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
774 * @brief Get the finish time of an action
776 * @param action The surf action
777 * @return The finish time in seconds from the beginning of the simulation
779 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
782 * @brief Get the remains amount of work to do of an action
784 * @param action The surf action
785 * @return The remains amount of work to do
787 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
790 * @brief Suspend an action
792 * @param action The surf action
794 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
797 * @brief Resume an action
799 * @param action The surf action
801 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
804 * @brief Cancel an action
806 * @param action The surf action
808 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
811 * @brief Set the priority of an action
812 * @details [long description]
814 * @param action The surf action
815 * @param priority The new priority [TODO]
817 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
820 * @brief Set the category of an action
821 * @details [long description]
823 * @param action The surf action
824 * @param category The new category of the action
826 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
829 * @brief Get the state of an action
831 * @param action The surf action
832 * @return The state of the action
834 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
837 * @brief Get the cost of an action
839 * @param action The surf action
840 * @return The cost of the action
842 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
845 * @brief [brief desrciption]
846 * @details [long description]
848 * @param action The surf cpu action
849 * @param cpu [description]
850 * @param mask [description]
852 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask);
855 * @brief [brief description]
856 * @details [long description]
858 * @param action The surf cpu action
859 * @param bound [description]
861 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
864 * @brief [brief description]
865 * @details [long description]
867 * @param action The surf network action
869 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
872 * @brief Get the file associated to a storage action
874 * @param action The surf storage action
875 * @return The file associated to a storage action
877 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
880 * @brief Get the result dictionary of an ls action
882 * @param action The surf storage action
883 * @return The dictionry listing a path
885 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
889 * @brief Get the host the storage is attached to
891 * @param resource The surf storage
892 * @return The host name
894 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
896 XBT_PUBLIC(surf_model_t) surf_resource_model(const void *host, int level);
900 /**************************************/
901 /* Implementations of model object */
902 /**************************************/
904 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
905 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
907 /** \ingroup SURF_models
908 * \brief The CPU model object for the physical machine layer
910 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
912 /** \ingroup SURF_models
913 * \brief The CPU model object for the virtual machine layer
915 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
918 /** \ingroup SURF_models
919 * \brief Initializes the CPU model with the model Cas01
921 * By default, this model uses the lazy optimization mechanism that
922 * relies on partial invalidation in LMM and a heap for lazy action update.
923 * You can change this behavior by setting the cpu/optim configuration
924 * variable to a different value.
926 * You shouldn't have to call it by yourself.
928 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
930 /** \ingroup SURF_models
931 * \brief Initializes the CPU model with trace integration [Deprecated]
933 * You shouldn't have to call it by yourself.
935 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
937 /** \ingroup SURF_models
938 * \brief The list of all available optimization modes (both for cpu and networks).
939 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
941 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
943 /** \ingroup SURF_plugins
944 * \brief The list of all available surf plugins
946 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
948 /** \ingroup SURF_models
949 * \brief The list of all available cpu model models
951 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
953 /**\brief create new host bypass the parser
958 /** \ingroup SURF_models
959 * \brief The network model
961 * When creating a new API on top on SURF, you shouldn't use the
962 * network model unless you know what you are doing. Only the host
963 * model should be accessed because depending on the platform model,
964 * the network model can be NULL.
966 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
968 /** \ingroup SURF_models
969 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
971 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
972 * based on the model 'LV08' and different correction factors depending on the communication
973 * size (< 1KiB, < 64KiB, >= 64KiB).
974 * See comments in the code for more information.
976 * \see surf_host_model_init_SMPI()
978 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
980 /** \ingroup SURF_models
981 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
983 * This model impelments a variant of the contention model on Infinband networks based on
984 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
986 * \see surf_host_model_init_IB()
988 XBT_PUBLIC(void) surf_network_model_init_IB(void);
990 /** \ingroup SURF_models
991 * \brief Initializes the platform with the network model 'LegrandVelho'
993 * This model is proposed by Arnaud Legrand and Pedro Velho based on
994 * the results obtained with the GTNets simulator for onelink and
995 * dogbone sharing scenarios. See comments in the code for more information.
997 * \see surf_host_model_init_LegrandVelho()
999 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
1001 /** \ingroup SURF_models
1002 * \brief Initializes the platform with the network model 'Constant'
1004 * In this model, the communication time between two network cards is
1005 * constant, hence no need for a routing table. This is particularly
1006 * usefull when simulating huge distributed algorithms where
1007 * scalability is really an issue. This function is called in
1008 * conjunction with surf_host_model_init_compound.
1010 * \see surf_host_model_init_compound()
1012 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
1014 /** \ingroup SURF_models
1015 * \brief Initializes the platform with the network model CM02
1017 * You sould call this function by yourself only if you plan using
1018 * surf_host_model_init_compound.
1019 * See comments in the code for more information.
1021 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
1024 /** \ingroup SURF_models
1025 * \brief Initializes the platform with the network model GTNETS
1026 * \param filename XML platform file name
1028 * This function is called by surf_host_model_init_GTNETS
1029 * or by yourself only if you plan using surf_host_model_init_compound
1031 * \see surf_host_model_init_GTNETS()
1033 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
1037 /** \ingroup SURF_models
1038 * \brief Initializes the platform with the network model NS3
1039 * \param filename XML platform file name
1041 * This function is called by surf_host_model_init_NS3
1042 * or by yourself only if you plan using surf_host_model_init_compound
1044 * \see surf_host_model_init_NS3()
1046 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
1049 /** \ingroup SURF_models
1050 * \brief Initializes the platform with the network model Reno
1051 * \param filename XML platform file name
1053 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
1056 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1057 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1059 * Call this function only if you plan using surf_host_model_init_compound.
1062 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
1064 /** \ingroup SURF_models
1065 * \brief Initializes the platform with the network model Reno2
1066 * \param filename XML platform file name
1068 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
1071 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
1072 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1074 * Call this function only if you plan using surf_host_model_init_compound.
1077 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
1079 /** \ingroup SURF_models
1080 * \brief Initializes the platform with the network model Vegas
1081 * \param filename XML platform file name
1083 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
1084 * to the proportional fairness.
1087 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1088 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1090 * Call this function only if you plan using surf_host_model_init_compound.
1093 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
1095 /** \ingroup SURF_models
1096 * \brief The list of all available network model models
1098 XBT_PUBLIC_DATA(s_surf_model_description_t)
1099 surf_network_model_description[];
1101 /** \ingroup SURF_models
1102 * \brief The storage model
1104 XBT_PUBLIC(void) surf_storage_model_init_default(void);
1106 /** \ingroup SURF_models
1107 * \brief The list of all available storage modes.
1108 * This storage mode can be set using --cfg=storage/model:...
1110 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
1112 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
1114 /** \ingroup SURF_models
1115 * \brief The host model
1117 * Note that when you create an API on top of SURF,
1118 * the host model should be the only one you use
1119 * because depending on the platform model, the network model and the CPU model
1122 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
1124 /** \ingroup SURF_models
1125 * \brief The vm model
1127 * Note that when you create an API on top of SURF,
1128 * the vm model should be the only one you use
1129 * because depending on the platform model, the network model and the CPU model
1132 XBT_PUBLIC_DATA(surf_vm_model_t) surf_vm_model;
1134 /** \ingroup SURF_models
1135 * \brief Initializes the platform with a compound host model
1137 * This function should be called after a cpu_model and a
1138 * network_model have been set up.
1141 XBT_PUBLIC(void) surf_host_model_init_compound(void);
1143 /** \ingroup SURF_models
1144 * \brief Initializes the platform with the current best network and cpu models at hand
1146 * This platform model separates the host model and the network model.
1147 * The host model will be initialized with the model compound, the network
1148 * model with the model LV08 (with cross traffic support) and the CPU model with
1150 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1153 XBT_PUBLIC(void) surf_host_model_init_current_default(void);
1155 /** \ingroup SURF_models
1156 * \brief Initializes the platform with the model L07
1158 * With this model, only parallel tasks can be used. Resource sharing
1159 * is done by identifying bottlenecks and giving an equal share of
1160 * the model to each action.
1163 XBT_PUBLIC(void) surf_host_model_init_ptask_L07(void);
1165 /** \ingroup SURF_models
1166 * \brief The list of all available host model models
1168 XBT_PUBLIC_DATA(s_surf_model_description_t)
1169 surf_host_model_description[];
1171 /** \ingroup SURF_models
1172 * \brief Initializes the platform with the current best network and cpu models at hand
1174 * This platform model seperates the host model and the network model.
1175 * The host model will be initialized with the model compound, the network
1176 * model with the model LV08 (with cross traffic support) and the CPU model with
1178 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1181 XBT_PUBLIC(void) surf_vm_model_init_HL13(void);
1183 /** \ingroup SURF_models
1184 * \brief The list of all available vm model models
1186 XBT_PUBLIC_DATA(s_surf_model_description_t)
1187 surf_vm_model_description[];
1189 /*******************************************/
1191 /** \ingroup SURF_models
1192 * \brief List of initialized models
1194 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
1195 XBT_PUBLIC_DATA(xbt_dynar_t) model_list_invoke;
1197 /** \ingroup SURF_simulation
1198 * \brief List of hosts that have juste restarted and whose autorestart process should be restarted.
1200 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
1202 /** \ingroup SURF_simulation
1203 * \brief List of hosts for which one want to be notified if they ever restart.
1205 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
1207 /*******************************************/
1208 /*** SURF Platform *************************/
1209 /*******************************************/
1210 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
1211 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
1212 XBT_PUBLIC_DATA(AS_t) surf_AS_get_by_name(const char * name);
1213 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
1214 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
1215 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
1216 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
1217 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
1218 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
1220 /*******************************************/
1221 /*** SURF Globals **************************/
1222 /*******************************************/
1224 /** \ingroup SURF_simulation
1225 * \brief Initialize SURF
1226 * \param argc argument number
1227 * \param argv arguments
1229 * This function has to be called to initialize the common
1230 * structures. Then you will have to create the environment by
1232 * e.g. surf_host_model_init_CM02()
1234 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
1236 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
1238 /** \ingroup SURF_simulation
1239 * \brief Finish simulation initialization
1241 * This function must be called before the first call to surf_solve()
1243 XBT_PUBLIC(void) surf_presolve(void);
1245 /** \ingroup SURF_simulation
1246 * \brief Performs a part of the simulation
1247 * \param max_date Maximum date to update the simulation to, or -1
1248 * \return the elapsed time, or -1.0 if no event could be executed
1250 * This function execute all possible events, update the action states
1251 * and returns the time elapsed.
1252 * When you call execute or communicate on a model, the corresponding actions
1253 * are not executed immediately but only when you call surf_solve.
1254 * Note that the returned elapsed time can be zero.
1256 XBT_PUBLIC(double) surf_solve(double max_date);
1258 /** \ingroup SURF_simulation
1259 * \brief Return the current time
1261 * Return the current time in millisecond.
1263 XBT_PUBLIC(double) surf_get_clock(void);
1265 /** \ingroup SURF_simulation
1272 XBT_PUBLIC(void) surf_exit(void);
1274 /* Prototypes of the functions that handle the properties */
1275 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
1277 /* The same for model_prop set*/
1278 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
1280 /* surf parse file related (public because called from a test suite) */
1281 XBT_PUBLIC(void) parse_platform_file(const char *file);
1283 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
1284 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
1285 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
1286 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
1287 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
1288 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
1289 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
1292 XBT_PUBLIC(double) get_cpu_power(const char *power);
1294 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
1296 int surf_get_nthreads(void);
1297 void surf_set_nthreads(int nthreads);
1300 * Returns the initial path. On Windows the initial path is
1301 * the current directory for the current process in the other
1302 * case the function returns "./" that represents the current
1303 * directory on Unix/Linux platforms.
1305 const char *__surf_get_initial_path(void);
1307 /********** Tracing **********/
1308 /* from surf_instr.c */
1309 void TRACE_surf_action(surf_action_t surf_action, const char *category);
1310 void TRACE_surf_alloc(void);
1311 void TRACE_surf_release(void);
1313 /* instr_routing.c */
1314 void instr_routing_define_callbacks (void);
1315 void instr_new_variable_type (const char *new_typename, const char *color);
1316 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
1317 void instr_new_user_state_type (const char *father_type, const char *new_typename);
1318 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
1319 int instr_platform_traced (void);
1320 xbt_graph_t instr_routing_platform_graph (void);
1321 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1324 #endif /* _SURF_SURF_H */