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
162 /**< Not in the system anymore. Why did you ask ? */
163 } e_surf_action_state_t;
165 /** @ingroup SURF_vm_interface
169 /* FIXME: Where should the VM state be defined? */
171 SURF_VM_STATE_CREATED, /**< created, but not yet started */
172 SURF_VM_STATE_RUNNING,
173 SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
175 SURF_VM_STATE_SAVING, /**< Save/restore involves disk I/O, so there should be transition states. */
177 SURF_VM_STATE_RESTORING,
180 /***************************/
181 /* Generic model object */
182 /***************************/
184 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
186 static inline surf_host_t surf_host_resource_priv(const void *host){
187 return (surf_host_t) xbt_lib_get_level((xbt_dictelm_t)host, SURF_HOST_LEVEL);
189 static inline void *surf_storage_resource_priv(const void *storage){
190 return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
193 static inline void *surf_storage_resource_by_name(const char *name){
194 return xbt_lib_get_elm_or_null(storage_lib, name);
198 XBT_PUBLIC(char *) surf_routing_edge_name(sg_routing_edge_t edge);
199 XBT_PUBLIC(void *) surf_as_cluster_get_backbone(AS_t as);
200 XBT_PUBLIC(void) surf_as_cluster_set_backbone(AS_t as, void* backbone);
202 /** @{ @ingroup SURF_c_bindings */
205 * @brief Get the name of a surf model
207 * @param model A model
208 * @return The name of the model
210 XBT_PUBLIC(const char *) surf_model_name(surf_model_t model);
213 * @brief Pop an action from the done actions set
215 * @param model The model from which the action is extracted
216 * @return An action in done state
218 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
221 * @brief Pop an action from the failed actions set
223 * @param model The model from which the action is extracted
224 * @return An action in failed state
226 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
229 * @brief Pop an action from the ready actions set
231 * @param model The model from which the action is extracted
232 * @return An action in ready state
234 XBT_PUBLIC(surf_action_t) surf_model_extract_ready_action_set(surf_model_t model);
237 * @brief Pop an action from the running actions set
239 * @param model The model from which the action is extracted
240 * @return An action in running state
242 XBT_PUBLIC(surf_action_t) surf_model_extract_running_action_set(surf_model_t model);
245 * @brief Get the size of the running action set of a model
247 * @param model The model
248 * @return The size of the running action set
250 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
253 * @brief Execute a parallel task
254 * @details [long description]
256 * @param model The model which handle the parallelisation
257 * @param host_nb The number of hosts
258 * @param host_list The list of hosts on which the task is executed
259 * @param flops_amount The processing amount (in flop) needed to process
260 * @param bytes_amount The amount of data (in bytes) needed to transfer
261 * @param rate [description]
262 * @return The action corresponding to the parallele execution task
264 XBT_PUBLIC(surf_action_t) surf_host_model_execute_parallel_task(surf_host_model_t model,
267 double *flops_amount,
268 double *bytes_amount,
272 * @brief Create a communication between two hosts
274 * @param model The model which handle the communication
275 * @param src The source host
276 * @param dst The destination host
277 * @param size The amount of data (in bytes) needed to transfer
278 * @param rate [description]
279 * @return The action corresponding to the communication
281 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);
284 * @brief Get the route between two hosts
285 * @details [long description]
287 * @param model The model which handle the routes
288 * @param src The source host
289 * @param dst The destination host
290 * @return The list of [TODO] from the source to the host
292 XBT_PUBLIC(xbt_dynar_t) surf_host_model_get_route(surf_host_model_t model, surf_resource_t src, surf_resource_t dst);
295 * @brief Create a new VM on the specified host
297 * @param name The name of the VM
298 * @param host_PM The host on which the VM is created
300 XBT_PUBLIC(void) surf_vm_model_create(const char *name, surf_resource_t host_PM);
303 * @brief Create a communication between two routing edges [TODO]
304 * @details [long description]
306 * @param model The model which handle the communication
307 * @param src The source host
308 * @param dst The destination host
309 * @param size The amount of data (in bytes) needed to transfer
310 * @param rate [description]
311 * @return The action corresponding to the communication
313 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);
316 * @brief Get the name of a surf resource (cpu, host, network, …)
318 * @param resource The surf resource
319 * @return The name of the surf resource
321 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
322 static inline const char * surf_cpu_name(surf_cpu_t cpu) {
323 return surf_resource_name((surf_cpp_resource_t)cpu);
327 * @brief Get the properties of a surf resource (cpu, host, network, …)
329 * @param resource The surf resource
330 * @return The properties of the surf resource
332 XBT_PUBLIC(xbt_dict_t) surf_resource_get_properties(surf_cpp_resource_t resource);
333 static XBT_INLINE xbt_dict_t surf_host_get_properties(surf_host_t host) {
334 return surf_resource_get_properties((surf_cpp_resource_t)host);
339 * @brief Get the state of a surf resource (cpu, host, network, …)
341 * @param resource The surf resource
342 * @return The state of the surf resource
344 XBT_PUBLIC(e_surf_resource_state_t) surf_resource_get_state(surf_cpp_resource_t resource);
346 static XBT_INLINE e_surf_resource_state_t surf_host_get_state(surf_host_t host) {
347 return surf_resource_get_state((surf_cpp_resource_t)host);
352 * @brief Set the state of a surf resource (cpu, host, network, …)
354 * @param resource The surf resource
355 * @param state The new state of the surf resource
357 XBT_PUBLIC(void) surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state);
358 static inline void surf_host_set_state(surf_host_t host, e_surf_resource_state_t state) {
359 surf_resource_set_state((surf_cpp_resource_t)host, state);
363 * @brief Get the speed of the cpu associated to a host
365 * @param resource The surf host
366 * @param load [description]
368 * @return [description]
370 XBT_PUBLIC(double) surf_host_get_speed(surf_resource_t resource, double load);
373 * @brief Get the available speed of cpu associated to a host
375 * @param resource The surf host
376 * @return [description]
378 XBT_PUBLIC(double) surf_host_get_available_speed(surf_resource_t resource);
381 * @brief Get the number of cores of the cpu associated to a host
383 * @param resource The surf host
384 * @return The number of cores
386 XBT_PUBLIC(int) surf_host_get_core(surf_resource_t resource);
389 * @brief Execute some quantity of computation
391 * @param resource The surf host
392 * @param size The value of the processing amount (in flop) needed to process
394 * @return The surf action corresponding to the processing
396 XBT_PUBLIC(surf_action_t) surf_host_execute(surf_resource_t resource, double size);
399 * @brief Make the host sleep
401 * @param resource The surf host
402 * @param duration The number of seconds to sleep
403 * @return The surf action corresponding to the sleep
405 XBT_PUBLIC(surf_action_t) surf_host_sleep(surf_resource_t resource, double duration);
408 * @brief Open a file on an host
410 * @param host The surf host
411 * @param fullpath The path to the file
412 * @return The surf action corresponding to the openning
414 XBT_PUBLIC(surf_action_t) surf_host_open(surf_resource_t host, const char* fullpath);
417 * @brief Close a file descriptor on an host
419 * @param host The surf host
420 * @param fd The file descriptor
422 * @return The surf action corresponding to the closing
424 XBT_PUBLIC(surf_action_t) surf_host_close(surf_resource_t host, surf_file_t fd);
429 * @param host The surf host
430 * @param fd The file descriptor to read
431 * @param size The size in bytes to read
432 * @return The surf action corresponding to the reading
434 XBT_PUBLIC(surf_action_t) surf_host_read(surf_resource_t host, surf_file_t fd, sg_size_t size);
437 * @brief Write a file
439 * @param host The surf host
440 * @param fd The file descriptor to write
441 * @param size The size in bytes to write
442 * @return The surf action corresponding to the writing
444 XBT_PUBLIC(surf_action_t) surf_host_write(surf_resource_t host, surf_file_t fd, sg_size_t size);
447 * @brief Get the informations of a file descriptor
448 * @details The returned xbt_dynar_t contains:
449 * - the size of the file,
451 * - the storage name,
452 * - the storage typeId,
453 * - the storage content type
455 * @param host The surf host
456 * @param fd The file descriptor
457 * @return An xbt_dynar_t with the file informations
459 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(surf_resource_t host, surf_file_t fd);
462 * @brief Get the available space of the storage at the mount point
464 * @param resource The surf host
465 * @param name The mount point
466 * @return The amount of available space in bytes
468 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(surf_resource_t resource, const char* name);
471 * @brief Get the used space of the storage at the mount point
473 * @param resource The surf host
474 * @param name The mount point
475 * @return The amount of used space in bytes
477 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(surf_resource_t resource, const char* name);
480 * @brief Get the VMs hosted on the host
482 * @param resource The surf host
483 * @return The list of VMs on the host
485 XBT_PUBLIC(xbt_dynar_t) surf_host_get_vms(surf_resource_t resource);
488 * @brief [brief description]
489 * @details [long description]
491 * @param resource [description]
492 * @param params [description]
494 XBT_PUBLIC(void) surf_host_get_params(surf_resource_t resource, ws_params_t params);
497 * @brief [brief description]
498 * @details [long description]
500 * @param resource [description]
501 * @param params [description]
503 XBT_PUBLIC(void) surf_host_set_params(surf_resource_t resource, ws_params_t params);
506 * @brief Destroy a VM
508 * @param resource The surf vm
510 XBT_PUBLIC(void) surf_vm_destroy(surf_resource_t resource);
513 * @brief Suspend a VM
515 * @param resource The surf vm
517 XBT_PUBLIC(void) surf_vm_suspend(surf_resource_t resource);
522 * @param resource The surf vm
524 XBT_PUBLIC(void) surf_vm_resume(surf_resource_t resource);
527 * @brief Save the VM (Not yet implemented)
529 * @param resource The surf vm
531 XBT_PUBLIC(void) surf_vm_save(surf_resource_t resource);
534 * @brief Restore the VM (Not yet implemented)
536 * @param resource The surf vm
538 XBT_PUBLIC(void) surf_vm_restore(surf_resource_t resource);
541 * @brief Migrate the VM to the destination host
543 * @param resource The surf vm
544 * @param ind_vm_ws_dest The destination host
546 XBT_PUBLIC(void) surf_vm_migrate(surf_resource_t resource, surf_resource_t ind_vm_ws_dest);
549 * @brief Get the physical machine hosting the VM
551 * @param resource The surf vm
552 * @return The physical machine hosting the VM
554 XBT_PUBLIC(surf_resource_t) surf_vm_get_pm(surf_resource_t resource);
557 * @brief [brief description]
558 * @details [long description]
560 * @param resource [description]
561 * @param bound [description]
563 XBT_PUBLIC(void) surf_vm_set_bound(surf_resource_t resource, double bound);
566 * @brief [brief description]
567 * @details [long description]
569 * @param resource [description]
570 * @param cpu [description]
571 * @param mask [description]
573 XBT_PUBLIC(void) surf_vm_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask);
576 * @brief Execute some quantity of computation
578 * @param cpu The surf cpu
579 * @param size The value of the processing amount (in flop) needed to process
580 * @return The surf action corresponding to the processing
582 XBT_PUBLIC(surf_action_t) surf_cpu_execute(surf_resource_t cpu, double size);
585 * @brief Make the cpu sleep for duration (in seconds)
586 * @details [long description]
588 * @param cpu The surf cpu
589 * @param duration The number of seconds to sleep
590 * @return The surf action corresponding to the sleeping
592 XBT_PUBLIC(surf_action_t) surf_cpu_sleep(surf_resource_t cpu, double duration);
595 * @brief Get the host power peak
596 * @details [long description]
598 * @param host The surf host
599 * @return The power peak
601 XBT_PUBLIC(double) surf_host_get_current_power_peak(surf_resource_t host);
604 * @brief [brief description]
605 * @details [long description]
607 * @param host [description]
608 * @param pstate_index [description]
610 * @return [description]
612 XBT_PUBLIC(double) surf_host_get_power_peak_at(surf_resource_t host, int pstate_index);
615 * @brief [brief description]
616 * @details [long description]
618 * @param host [description]
619 * @return [description]
621 XBT_PUBLIC(int) surf_host_get_nb_pstates(surf_resource_t host);
623 XBT_PUBLIC(void) surf_host_set_pstate(surf_resource_t host, int pstate_index);
624 XBT_PUBLIC(int) surf_host_get_pstate(surf_resource_t host);
625 XBT_PUBLIC(double) surf_host_get_wattmin_at(surf_resource_t resource, int pstate);
626 XBT_PUBLIC(double) surf_host_get_wattmax_at(surf_resource_t resource, int pstate);
629 * @brief Get the consumed energy (in joules) of an host
631 * @param host The surf host
632 * @return The consumed energy
634 XBT_PUBLIC(double) surf_host_get_consumed_energy(surf_resource_t host);
637 * @brief Get the list of storages mounted on an host
639 * @param host The surf host
640 * @return Dictionary of mount point, Storage
642 XBT_PUBLIC(xbt_dict_t) surf_host_get_mounted_storage_list(surf_resource_t host);
645 * @brief Get the list of storages attached to an host
647 * @param host The surf host
648 * @return Dictionary of storage
650 XBT_PUBLIC(xbt_dynar_t) surf_host_get_attached_storage_list(surf_resource_t host);
653 * @brief Unlink a file descriptor
655 * @param host The surf host
656 * @param fd The file descriptor
658 * @return 0 if failed to unlink, 1 otherwise
660 XBT_PUBLIC(int) surf_host_unlink(surf_resource_t host, surf_file_t fd);
663 * @brief Get the size of a file on a host
665 * @param host The surf host
666 * @param fd The file descriptor
668 * @return The size in bytes of the file
670 XBT_PUBLIC(size_t) surf_host_get_size(surf_resource_t host, surf_file_t fd);
673 * @brief Get the current position of the file descriptor
675 * @param host The surf host
676 * @param fd The file descriptor
677 * @return The current position of the file descriptor
679 XBT_PUBLIC(size_t) surf_host_file_tell(surf_resource_t host, surf_file_t fd);
682 * @brief Move a file to another location on the *same mount point*.
683 * @details [long description]
685 * @param host The surf host
686 * @param fd The file descriptor
687 * @param fullpath The new full path
689 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
691 XBT_PUBLIC(int) surf_host_file_move(surf_resource_t host, surf_file_t fd, const char* fullpath);
694 * @brief Set the position indictator assiociated with the file descriptor to a new position
695 * @details [long description]
697 * @param host The surf host
698 * @param fd The file descriptor
699 * @param offset The offset from the origin
700 * @param origin Position used as a reference for the offset
701 * - SEEK_SET: beginning of the file
702 * - SEEK_CUR: current position indicator
703 * - SEEK_END: end of the file
704 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
706 XBT_PUBLIC(int) surf_host_file_seek(surf_resource_t host,
707 surf_file_t fd, sg_offset_t offset,
711 * @brief Get the content of a storage
713 * @param resource The surf storage
714 * @return A xbt_dict_t with path as keys and size in bytes as values
716 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
719 * @brief Get the size in bytes of a storage
721 * @param resource The surf storage
722 * @return The size in bytes of the storage
724 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
727 * @brief Get the available size in bytes of a storage
729 * @param resource The surf storage
730 * @return The available size in bytes of the storage
732 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
735 * @brief Get the size in bytes of a storage
737 * @param resource The surf storage
738 * @return The used size in bytes of the storage
740 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
744 * @brief Get the data associated to the action
746 * @param action The surf action
747 * @return The data associated to the action
749 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
752 * @brief Set the data associated to the action
753 * @details [long description]
755 * @param action The surf action
756 * @param data The new data associated to the action
758 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
761 * @brief Unreference an action
763 * @param action The surf action
765 XBT_PUBLIC(void) surf_action_unref(surf_action_t action);
768 * @brief Get the start time of an action
770 * @param action The surf action
771 * @return The start time in seconds from the beginning of the simulation
773 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
776 * @brief Get the finish time of an action
778 * @param action The surf action
779 * @return The finish time in seconds from the beginning of the simulation
781 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
784 * @brief Get the remains amount of work to do of an action
786 * @param action The surf action
787 * @return The remains amount of work to do
789 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
792 * @brief Suspend an action
794 * @param action The surf action
796 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
799 * @brief Resume an action
801 * @param action The surf action
803 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
806 * @brief Cancel an action
808 * @param action The surf action
810 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
813 * @brief Set the priority of an action
814 * @details [long description]
816 * @param action The surf action
817 * @param priority The new priority [TODO]
819 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
822 * @brief Set the category of an action
823 * @details [long description]
825 * @param action The surf action
826 * @param category The new category of the action
828 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
831 * @brief Get the state of an action
833 * @param action The surf action
834 * @return The state of the action
836 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
839 * @brief Get the cost of an action
841 * @param action The surf action
842 * @return The cost of the action
844 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
847 * @brief [brief desrciption]
848 * @details [long description]
850 * @param action The surf cpu action
851 * @param cpu [description]
852 * @param mask [description]
854 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask);
857 * @brief [brief description]
858 * @details [long description]
860 * @param action The surf cpu action
861 * @param bound [description]
863 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
866 * @brief [brief description]
867 * @details [long description]
869 * @param action The surf network action
871 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
874 * @brief Get the file associated to a storage action
876 * @param action The surf storage action
877 * @return The file associated to a storage action
879 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
882 * @brief Get the result dictionary of an ls action
884 * @param action The surf storage action
885 * @return The dictionry listing a path
887 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
891 * @brief Get the host the storage is attached to
893 * @param resource The surf storage
894 * @return The host name
896 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
898 XBT_PUBLIC(surf_model_t) surf_resource_model(const void *host, int level);
902 /**************************************/
903 /* Implementations of model object */
904 /**************************************/
906 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
907 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
909 /** \ingroup SURF_models
910 * \brief The CPU model object for the physical machine layer
912 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
914 /** \ingroup SURF_models
915 * \brief The CPU model object for the virtual machine layer
917 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
920 /** \ingroup SURF_models
921 * \brief Initializes the CPU model with the model Cas01
923 * By default, this model uses the lazy optimization mechanism that
924 * relies on partial invalidation in LMM and a heap for lazy action update.
925 * You can change this behavior by setting the cpu/optim configuration
926 * variable to a different value.
928 * You shouldn't have to call it by yourself.
930 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
932 /** \ingroup SURF_models
933 * \brief Initializes the CPU model with trace integration [Deprecated]
935 * You shouldn't have to call it by yourself.
937 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
939 /** \ingroup SURF_models
940 * \brief The list of all available optimization modes (both for cpu and networks).
941 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
943 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
945 /** \ingroup SURF_plugins
946 * \brief The list of all available surf plugins
948 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
950 /** \ingroup SURF_models
951 * \brief The list of all available cpu model models
953 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
955 /**\brief create new host bypass the parser
960 /** \ingroup SURF_models
961 * \brief The network model
963 * When creating a new API on top on SURF, you shouldn't use the
964 * network model unless you know what you are doing. Only the host
965 * model should be accessed because depending on the platform model,
966 * the network model can be NULL.
968 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
970 /** \ingroup SURF_models
971 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
973 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
974 * based on the model 'LV08' and different correction factors depending on the communication
975 * size (< 1KiB, < 64KiB, >= 64KiB).
976 * See comments in the code for more information.
978 * \see surf_host_model_init_SMPI()
980 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
982 /** \ingroup SURF_models
983 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
985 * This model impelments a variant of the contention model on Infinband networks based on
986 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
988 * \see surf_host_model_init_IB()
990 XBT_PUBLIC(void) surf_network_model_init_IB(void);
992 /** \ingroup SURF_models
993 * \brief Initializes the platform with the network model 'LegrandVelho'
995 * This model is proposed by Arnaud Legrand and Pedro Velho based on
996 * the results obtained with the GTNets simulator for onelink and
997 * dogbone sharing scenarios. See comments in the code for more information.
999 * \see surf_host_model_init_LegrandVelho()
1001 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
1003 /** \ingroup SURF_models
1004 * \brief Initializes the platform with the network model 'Constant'
1006 * In this model, the communication time between two network cards is
1007 * constant, hence no need for a routing table. This is particularly
1008 * usefull when simulating huge distributed algorithms where
1009 * scalability is really an issue. This function is called in
1010 * conjunction with surf_host_model_init_compound.
1012 * \see surf_host_model_init_compound()
1014 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
1016 /** \ingroup SURF_models
1017 * \brief Initializes the platform with the network model CM02
1019 * You sould call this function by yourself only if you plan using
1020 * surf_host_model_init_compound.
1021 * See comments in the code for more information.
1023 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
1026 /** \ingroup SURF_models
1027 * \brief Initializes the platform with the network model GTNETS
1028 * \param filename XML platform file name
1030 * This function is called by surf_host_model_init_GTNETS
1031 * or by yourself only if you plan using surf_host_model_init_compound
1033 * \see surf_host_model_init_GTNETS()
1035 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
1039 /** \ingroup SURF_models
1040 * \brief Initializes the platform with the network model NS3
1041 * \param filename XML platform file name
1043 * This function is called by surf_host_model_init_NS3
1044 * or by yourself only if you plan using surf_host_model_init_compound
1046 * \see surf_host_model_init_NS3()
1048 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
1051 /** \ingroup SURF_models
1052 * \brief Initializes the platform with the network model Reno
1053 * \param filename XML platform file name
1055 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
1058 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1059 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1061 * Call this function only if you plan using surf_host_model_init_compound.
1064 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
1066 /** \ingroup SURF_models
1067 * \brief Initializes the platform with the network model Reno2
1068 * \param filename XML platform file name
1070 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
1073 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
1074 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1076 * Call this function only if you plan using surf_host_model_init_compound.
1079 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
1081 /** \ingroup SURF_models
1082 * \brief Initializes the platform with the network model Vegas
1083 * \param filename XML platform file name
1085 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
1086 * to the proportional fairness.
1089 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1090 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1092 * Call this function only if you plan using surf_host_model_init_compound.
1095 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
1097 /** \ingroup SURF_models
1098 * \brief The list of all available network model models
1100 XBT_PUBLIC_DATA(s_surf_model_description_t)
1101 surf_network_model_description[];
1103 /** \ingroup SURF_models
1104 * \brief The storage model
1106 XBT_PUBLIC(void) surf_storage_model_init_default(void);
1108 /** \ingroup SURF_models
1109 * \brief The list of all available storage modes.
1110 * This storage mode can be set using --cfg=storage/model:...
1112 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
1114 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
1116 /** \ingroup SURF_models
1117 * \brief The host model
1119 * Note that when you create an API on top of SURF,
1120 * the host model should be the only one you use
1121 * because depending on the platform model, the network model and the CPU model
1124 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
1126 /** \ingroup SURF_models
1127 * \brief The vm model
1129 * Note that when you create an API on top of SURF,
1130 * the vm model should be the only one you use
1131 * because depending on the platform model, the network model and the CPU model
1134 XBT_PUBLIC_DATA(surf_vm_model_t) surf_vm_model;
1136 /** \ingroup SURF_models
1137 * \brief Initializes the platform with a compound host model
1139 * This function should be called after a cpu_model and a
1140 * network_model have been set up.
1143 XBT_PUBLIC(void) surf_host_model_init_compound(void);
1145 /** \ingroup SURF_models
1146 * \brief Initializes the platform with the current best network and cpu models at hand
1148 * This platform model separates the host model and the network model.
1149 * The host model will be initialized with the model compound, the network
1150 * model with the model LV08 (with cross traffic support) and the CPU model with
1152 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1155 XBT_PUBLIC(void) surf_host_model_init_current_default(void);
1157 /** \ingroup SURF_models
1158 * \brief Initializes the platform with the model L07
1160 * With this model, only parallel tasks can be used. Resource sharing
1161 * is done by identifying bottlenecks and giving an equal share of
1162 * the model to each action.
1165 XBT_PUBLIC(void) surf_host_model_init_ptask_L07(void);
1167 /** \ingroup SURF_models
1168 * \brief The list of all available host model models
1170 XBT_PUBLIC_DATA(s_surf_model_description_t)
1171 surf_host_model_description[];
1173 /** \ingroup SURF_models
1174 * \brief Initializes the platform with the current best network and cpu models at hand
1176 * This platform model seperates the host model and the network model.
1177 * The host model will be initialized with the model compound, the network
1178 * model with the model LV08 (with cross traffic support) and the CPU model with
1180 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1183 XBT_PUBLIC(void) surf_vm_model_init_HL13(void);
1185 /** \ingroup SURF_models
1186 * \brief The list of all available vm model models
1188 XBT_PUBLIC_DATA(s_surf_model_description_t)
1189 surf_vm_model_description[];
1191 /*******************************************/
1193 /** \ingroup SURF_models
1194 * \brief List of initialized models
1196 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
1197 XBT_PUBLIC_DATA(xbt_dynar_t) model_list_invoke;
1199 /** \ingroup SURF_simulation
1200 * \brief List of hosts that have juste restarted and whose autorestart process should be restarted.
1202 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
1204 /** \ingroup SURF_simulation
1205 * \brief List of hosts for which one want to be notified if they ever restart.
1207 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
1209 /*******************************************/
1210 /*** SURF Platform *************************/
1211 /*******************************************/
1212 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
1213 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
1214 XBT_PUBLIC_DATA(AS_t) surf_AS_get_by_name(const char * name);
1215 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
1216 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
1217 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
1218 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
1219 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
1220 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
1222 /*******************************************/
1223 /*** SURF Globals **************************/
1224 /*******************************************/
1226 /** \ingroup SURF_simulation
1227 * \brief Initialize SURF
1228 * \param argc argument number
1229 * \param argv arguments
1231 * This function has to be called to initialize the common
1232 * structures. Then you will have to create the environment by
1234 * e.g. surf_host_model_init_CM02()
1236 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
1238 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
1240 /** \ingroup SURF_simulation
1241 * \brief Finish simulation initialization
1243 * This function must be called before the first call to surf_solve()
1245 XBT_PUBLIC(void) surf_presolve(void);
1247 /** \ingroup SURF_simulation
1248 * \brief Performs a part of the simulation
1249 * \param max_date Maximum date to update the simulation to, or -1
1250 * \return the elapsed time, or -1.0 if no event could be executed
1252 * This function execute all possible events, update the action states
1253 * and returns the time elapsed.
1254 * When you call execute or communicate on a model, the corresponding actions
1255 * are not executed immediately but only when you call surf_solve.
1256 * Note that the returned elapsed time can be zero.
1258 XBT_PUBLIC(double) surf_solve(double max_date);
1260 /** \ingroup SURF_simulation
1261 * \brief Return the current time
1263 * Return the current time in millisecond.
1265 XBT_PUBLIC(double) surf_get_clock(void);
1267 /** \ingroup SURF_simulation
1274 XBT_PUBLIC(void) surf_exit(void);
1276 /* Prototypes of the functions that handle the properties */
1277 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
1279 /* The same for model_prop set*/
1280 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
1282 /* surf parse file related (public because called from a test suite) */
1283 XBT_PUBLIC(void) parse_platform_file(const char *file);
1285 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
1286 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
1287 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
1288 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
1289 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
1290 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
1291 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
1294 XBT_PUBLIC(double) get_cpu_power(const char *power);
1296 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
1298 int surf_get_nthreads(void);
1299 void surf_set_nthreads(int nthreads);
1302 * Returns the initial path. On Windows the initial path is
1303 * the current directory for the current process in the other
1304 * case the function returns "./" that represents the current
1305 * directory on Unix/Linux platforms.
1307 const char *__surf_get_initial_path(void);
1309 /********** Tracing **********/
1310 /* from surf_instr.c */
1311 void TRACE_surf_action(surf_action_t surf_action, const char *category);
1312 void TRACE_surf_alloc(void);
1313 void TRACE_surf_release(void);
1315 /* instr_routing.c */
1316 void instr_routing_define_callbacks (void);
1317 void instr_new_variable_type (const char *new_typename, const char *color);
1318 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
1319 void instr_new_user_state_type (const char *father_type, const char *new_typename);
1320 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
1321 int instr_platform_traced (void);
1322 xbt_graph_t instr_routing_platform_graph (void);
1323 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1326 #endif /* _SURF_SURF_H */