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(char *) surf_routing_edge_name(sg_routing_edge_t edge);
198 XBT_PUBLIC(void *) surf_as_cluster_get_backbone(AS_t as);
199 XBT_PUBLIC(void) surf_as_cluster_set_backbone(AS_t as, void* backbone);
201 /** @{ @ingroup SURF_c_bindings */
204 * @brief Get the name of a surf model
206 * @param model A model
207 * @return The name of the model
209 XBT_PUBLIC(const char *) surf_model_name(surf_model_t model);
212 * @brief Pop an action from the done actions set
214 * @param model The model from which the action is extracted
215 * @return An action in done state
217 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
220 * @brief Pop an action from the failed actions set
222 * @param model The model from which the action is extracted
223 * @return An action in failed state
225 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
228 * @brief Pop an action from the ready actions set
230 * @param model The model from which the action is extracted
231 * @return An action in ready state
233 XBT_PUBLIC(surf_action_t) surf_model_extract_ready_action_set(surf_model_t model);
236 * @brief Pop an action from the running actions set
238 * @param model The model from which the action is extracted
239 * @return An action in running state
241 XBT_PUBLIC(surf_action_t) surf_model_extract_running_action_set(surf_model_t model);
244 * @brief Get the size of the running action set of a model
246 * @param model The model
247 * @return The size of the running action set
249 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
252 * @brief Execute a parallel task
253 * @details [long description]
255 * @param model The model which handle the parallelisation
256 * @param host_nb The number of hosts
257 * @param host_list The list of hosts on which the task is executed
258 * @param flops_amount The processing amount (in flop) needed to process
259 * @param bytes_amount The amount of data (in bytes) needed to transfer
260 * @param rate [description]
261 * @return The action corresponding to the parallele execution task
263 XBT_PUBLIC(surf_action_t) surf_host_model_execute_parallel_task(surf_host_model_t model,
266 double *flops_amount,
267 double *bytes_amount,
271 * @brief Create a communication between two hosts
273 * @param model The model which handle the communication
274 * @param src The source host
275 * @param dst The destination host
276 * @param size The amount of data (in bytes) needed to transfer
277 * @param rate [description]
278 * @return The action corresponding to the communication
280 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);
283 * @brief Get the route between two hosts
284 * @details [long description]
286 * @param model The model which handle the routes
287 * @param src The source host
288 * @param dst The destination host
289 * @return The list of [TODO] from the source to the host
291 XBT_PUBLIC(xbt_dynar_t) surf_host_model_get_route(surf_host_model_t model, surf_resource_t src, surf_resource_t dst);
294 * @brief Create a new VM on the specified host
296 * @param name The name of the VM
297 * @param host_PM The host on which the VM is created
299 XBT_PUBLIC(void) surf_vm_model_create(const char *name, surf_resource_t host_PM);
302 * @brief Create a communication between two routing edges [TODO]
303 * @details [long description]
305 * @param model The model which handle the communication
306 * @param src The source host
307 * @param dst The destination host
308 * @param size The amount of data (in bytes) needed to transfer
309 * @param rate [description]
310 * @return The action corresponding to the communication
312 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);
315 * @brief Get the name of a surf resource (cpu, host, network, …)
317 * @param resource The surf resource
318 * @return The name of the surf resource
320 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
321 static inline const char * surf_cpu_name(surf_cpu_t cpu) {
322 return surf_resource_name((surf_cpp_resource_t)cpu);
326 * @brief Get the properties of a surf resource (cpu, host, network, …)
328 * @param resource The surf resource
329 * @return The properties of the surf resource
331 XBT_PUBLIC(xbt_dict_t) surf_resource_get_properties(surf_cpp_resource_t resource);
332 static XBT_INLINE xbt_dict_t surf_host_get_properties(surf_host_t host) {
333 return surf_resource_get_properties((surf_cpp_resource_t)host);
338 * @brief Get the state of a surf resource (cpu, host, network, …)
340 * @param resource The surf resource
341 * @return The state of the surf resource
343 XBT_PUBLIC(e_surf_resource_state_t) surf_resource_get_state(surf_cpp_resource_t resource);
345 static XBT_INLINE e_surf_resource_state_t surf_host_get_state(surf_host_t host) {
346 return surf_resource_get_state((surf_cpp_resource_t)host);
351 * @brief Set the state of a surf resource (cpu, host, network, …)
353 * @param resource The surf resource
354 * @param state The new state of the surf resource
356 XBT_PUBLIC(void) surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state);
357 static inline void surf_host_set_state(surf_host_t host, e_surf_resource_state_t state) {
358 surf_resource_set_state((surf_cpp_resource_t)host, state);
362 * @brief Get the speed of the cpu associated to a host
364 * @param resource The surf host
365 * @param load [description]
367 * @return [description]
369 XBT_PUBLIC(double) surf_host_get_speed(surf_resource_t resource, double load);
372 * @brief Get the available speed of cpu associated to a host
374 * @param resource The surf host
375 * @return [description]
377 XBT_PUBLIC(double) surf_host_get_available_speed(surf_resource_t resource);
380 * @brief Get the number of cores of the cpu associated to a host
382 * @param resource The surf host
383 * @return The number of cores
385 XBT_PUBLIC(int) surf_host_get_core(surf_resource_t resource);
388 * @brief Execute some quantity of computation
390 * @param resource The surf host
391 * @param size The value of the processing amount (in flop) needed to process
393 * @return The surf action corresponding to the processing
395 XBT_PUBLIC(surf_action_t) surf_host_execute(surf_resource_t resource, double size);
398 * @brief Make the host sleep
400 * @param resource The surf host
401 * @param duration The number of seconds to sleep
402 * @return The surf action corresponding to the sleep
404 XBT_PUBLIC(surf_action_t) surf_host_sleep(surf_resource_t resource, double duration);
407 * @brief Open a file on an host
409 * @param host The surf host
410 * @param fullpath The path to the file
411 * @return The surf action corresponding to the openning
413 XBT_PUBLIC(surf_action_t) surf_host_open(surf_resource_t host, const char* fullpath);
416 * @brief Close a file descriptor on an host
418 * @param host The surf host
419 * @param fd The file descriptor
421 * @return The surf action corresponding to the closing
423 XBT_PUBLIC(surf_action_t) surf_host_close(surf_resource_t host, surf_file_t fd);
428 * @param host The surf host
429 * @param fd The file descriptor to read
430 * @param size The size in bytes to read
431 * @return The surf action corresponding to the reading
433 XBT_PUBLIC(surf_action_t) surf_host_read(surf_resource_t host, surf_file_t fd, sg_size_t size);
436 * @brief Write a file
438 * @param host The surf host
439 * @param fd The file descriptor to write
440 * @param size The size in bytes to write
441 * @return The surf action corresponding to the writing
443 XBT_PUBLIC(surf_action_t) surf_host_write(surf_resource_t host, surf_file_t fd, sg_size_t size);
446 * @brief Get the informations of a file descriptor
447 * @details The returned xbt_dynar_t contains:
448 * - the size of the file,
450 * - the storage name,
451 * - the storage typeId,
452 * - the storage content type
454 * @param host The surf host
455 * @param fd The file descriptor
456 * @return An xbt_dynar_t with the file informations
458 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(surf_resource_t host, surf_file_t fd);
461 * @brief Get the available space of the storage at the mount point
463 * @param resource The surf host
464 * @param name The mount point
465 * @return The amount of available space in bytes
467 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(surf_resource_t resource, const char* name);
470 * @brief Get the used space of the storage at the mount point
472 * @param resource The surf host
473 * @param name The mount point
474 * @return The amount of used space in bytes
476 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(surf_resource_t resource, const char* name);
479 * @brief Get the VMs hosted on the host
481 * @param resource The surf host
482 * @return The list of VMs on the host
484 XBT_PUBLIC(xbt_dynar_t) surf_host_get_vms(surf_resource_t resource);
487 * @brief [brief description]
488 * @details [long description]
490 * @param resource [description]
491 * @param params [description]
493 XBT_PUBLIC(void) surf_host_get_params(surf_resource_t resource, ws_params_t params);
496 * @brief [brief description]
497 * @details [long description]
499 * @param resource [description]
500 * @param params [description]
502 XBT_PUBLIC(void) surf_host_set_params(surf_resource_t resource, ws_params_t params);
505 * @brief Destroy a VM
507 * @param resource The surf vm
509 XBT_PUBLIC(void) surf_vm_destroy(surf_resource_t resource);
512 * @brief Suspend a VM
514 * @param resource The surf vm
516 XBT_PUBLIC(void) surf_vm_suspend(surf_resource_t resource);
521 * @param resource The surf vm
523 XBT_PUBLIC(void) surf_vm_resume(surf_resource_t resource);
526 * @brief Save the VM (Not yet implemented)
528 * @param resource The surf vm
530 XBT_PUBLIC(void) surf_vm_save(surf_resource_t resource);
533 * @brief Restore the VM (Not yet implemented)
535 * @param resource The surf vm
537 XBT_PUBLIC(void) surf_vm_restore(surf_resource_t resource);
540 * @brief Migrate the VM to the destination host
542 * @param resource The surf vm
543 * @param ind_vm_ws_dest The destination host
545 XBT_PUBLIC(void) surf_vm_migrate(surf_resource_t resource, surf_resource_t ind_vm_ws_dest);
548 * @brief Get the physical machine hosting the VM
550 * @param resource The surf vm
551 * @return The physical machine hosting the VM
553 XBT_PUBLIC(surf_resource_t) surf_vm_get_pm(surf_resource_t resource);
556 * @brief [brief description]
557 * @details [long description]
559 * @param resource [description]
560 * @param bound [description]
562 XBT_PUBLIC(void) surf_vm_set_bound(surf_resource_t resource, double bound);
565 * @brief [brief description]
566 * @details [long description]
568 * @param resource [description]
569 * @param cpu [description]
570 * @param mask [description]
572 XBT_PUBLIC(void) surf_vm_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask);
575 * @brief Execute some quantity of computation
577 * @param cpu The surf cpu
578 * @param size The value of the processing amount (in flop) needed to process
579 * @return The surf action corresponding to the processing
581 XBT_PUBLIC(surf_action_t) surf_cpu_execute(surf_resource_t cpu, double size);
584 * @brief Make the cpu sleep for duration (in seconds)
585 * @details [long description]
587 * @param cpu The surf cpu
588 * @param duration The number of seconds to sleep
589 * @return The surf action corresponding to the sleeping
591 XBT_PUBLIC(surf_action_t) surf_cpu_sleep(surf_resource_t cpu, double duration);
594 * @brief Get the host power peak
595 * @details [long description]
597 * @param host The surf host
598 * @return The power peak
600 XBT_PUBLIC(double) surf_host_get_current_power_peak(surf_resource_t host);
603 * @brief [brief description]
604 * @details [long description]
606 * @param host [description]
607 * @param pstate_index [description]
609 * @return [description]
611 XBT_PUBLIC(double) surf_host_get_power_peak_at(surf_resource_t host, int pstate_index);
614 * @brief [brief description]
615 * @details [long description]
617 * @param host [description]
618 * @return [description]
620 XBT_PUBLIC(int) surf_host_get_nb_pstates(surf_resource_t host);
622 XBT_PUBLIC(void) surf_host_set_pstate(surf_resource_t host, int pstate_index);
623 XBT_PUBLIC(int) surf_host_get_pstate(surf_resource_t host);
624 XBT_PUBLIC(double) surf_host_get_wattmin_at(surf_resource_t resource, int pstate);
625 XBT_PUBLIC(double) surf_host_get_wattmax_at(surf_resource_t resource, int pstate);
628 * @brief Get the consumed energy (in joules) of an host
630 * @param host The surf host
631 * @return The consumed energy
633 XBT_PUBLIC(double) surf_host_get_consumed_energy(surf_resource_t host);
636 * @brief Get the list of storages mounted on an host
638 * @param host The surf host
639 * @return Dictionary of mount point, Storage
641 XBT_PUBLIC(xbt_dict_t) surf_host_get_mounted_storage_list(surf_resource_t host);
644 * @brief Get the list of storages attached to an host
646 * @param host The surf host
647 * @return Dictionary of storage
649 XBT_PUBLIC(xbt_dynar_t) surf_host_get_attached_storage_list(surf_resource_t host);
652 * @brief Unlink a file descriptor
654 * @param host The surf host
655 * @param fd The file descriptor
657 * @return 0 if failed to unlink, 1 otherwise
659 XBT_PUBLIC(int) surf_host_unlink(surf_resource_t host, surf_file_t fd);
662 * @brief Get the size of a file on a host
664 * @param host The surf host
665 * @param fd The file descriptor
667 * @return The size in bytes of the file
669 XBT_PUBLIC(size_t) surf_host_get_size(surf_resource_t host, surf_file_t fd);
672 * @brief Get the current position of the file descriptor
674 * @param host The surf host
675 * @param fd The file descriptor
676 * @return The current position of the file descriptor
678 XBT_PUBLIC(size_t) surf_host_file_tell(surf_resource_t host, surf_file_t fd);
681 * @brief Move a file to another location on the *same mount point*.
682 * @details [long description]
684 * @param host The surf host
685 * @param fd The file descriptor
686 * @param fullpath The new full path
688 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
690 XBT_PUBLIC(int) surf_host_file_move(surf_resource_t host, surf_file_t fd, const char* fullpath);
693 * @brief Set the position indictator assiociated with the file descriptor to a new position
694 * @details [long description]
696 * @param host The surf host
697 * @param fd The file descriptor
698 * @param offset The offset from the origin
699 * @param origin Position used as a reference for the offset
700 * - SEEK_SET: beginning of the file
701 * - SEEK_CUR: current position indicator
702 * - SEEK_END: end of the file
703 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
705 XBT_PUBLIC(int) surf_host_file_seek(surf_resource_t host,
706 surf_file_t fd, sg_offset_t offset,
710 * @brief Get the content of a storage
712 * @param resource The surf storage
713 * @return A xbt_dict_t with path as keys and size in bytes as values
715 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
718 * @brief Get the size in bytes of a storage
720 * @param resource The surf storage
721 * @return The size in bytes of the storage
723 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
726 * @brief Get the available size in bytes of a storage
728 * @param resource The surf storage
729 * @return The available size in bytes of the storage
731 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
734 * @brief Get the size in bytes of a storage
736 * @param resource The surf storage
737 * @return The used size in bytes of the storage
739 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
743 * @brief Get the data associated to the action
745 * @param action The surf action
746 * @return The data associated to the action
748 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
751 * @brief Set the data associated to the action
752 * @details [long description]
754 * @param action The surf action
755 * @param data The new data associated to the action
757 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
760 * @brief Unreference an action
762 * @param action The surf action
764 XBT_PUBLIC(void) surf_action_unref(surf_action_t action);
767 * @brief Get the start time of an action
769 * @param action The surf action
770 * @return The start time in seconds from the beginning of the simulation
772 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
775 * @brief Get the finish time of an action
777 * @param action The surf action
778 * @return The finish time in seconds from the beginning of the simulation
780 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
783 * @brief Get the remains amount of work to do of an action
785 * @param action The surf action
786 * @return The remains amount of work to do
788 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
791 * @brief Suspend an action
793 * @param action The surf action
795 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
798 * @brief Resume an action
800 * @param action The surf action
802 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
805 * @brief Cancel an action
807 * @param action The surf action
809 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
812 * @brief Set the priority of an action
813 * @details [long description]
815 * @param action The surf action
816 * @param priority The new priority [TODO]
818 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
821 * @brief Set the category of an action
822 * @details [long description]
824 * @param action The surf action
825 * @param category The new category of the action
827 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
830 * @brief Get the state of an action
832 * @param action The surf action
833 * @return The state of the action
835 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
838 * @brief Get the cost of an action
840 * @param action The surf action
841 * @return The cost of the action
843 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
846 * @brief [brief desrciption]
847 * @details [long description]
849 * @param action The surf cpu action
850 * @param cpu [description]
851 * @param mask [description]
853 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask);
856 * @brief [brief description]
857 * @details [long description]
859 * @param action The surf cpu action
860 * @param bound [description]
862 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
865 * @brief [brief description]
866 * @details [long description]
868 * @param action The surf network action
870 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
873 * @brief Get the file associated to a storage action
875 * @param action The surf storage action
876 * @return The file associated to a storage action
878 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
881 * @brief Get the result dictionary of an ls action
883 * @param action The surf storage action
884 * @return The dictionry listing a path
886 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
890 * @brief Get the host the storage is attached to
892 * @param resource The surf storage
893 * @return The host name
895 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
897 XBT_PUBLIC(surf_model_t) surf_resource_model(const void *host, int level);
901 /**************************************/
902 /* Implementations of model object */
903 /**************************************/
905 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
906 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
908 /** \ingroup SURF_models
909 * \brief The CPU model object for the physical machine layer
911 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
913 /** \ingroup SURF_models
914 * \brief The CPU model object for the virtual machine layer
916 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
919 /** \ingroup SURF_models
920 * \brief Initializes the CPU model with the model Cas01
922 * By default, this model uses the lazy optimization mechanism that
923 * relies on partial invalidation in LMM and a heap for lazy action update.
924 * You can change this behavior by setting the cpu/optim configuration
925 * variable to a different value.
927 * You shouldn't have to call it by yourself.
929 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
931 /** \ingroup SURF_models
932 * \brief Initializes the CPU model with trace integration [Deprecated]
934 * You shouldn't have to call it by yourself.
936 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
938 /** \ingroup SURF_models
939 * \brief The list of all available optimization modes (both for cpu and networks).
940 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
942 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
944 /** \ingroup SURF_plugins
945 * \brief The list of all available surf plugins
947 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
949 /** \ingroup SURF_models
950 * \brief The list of all available cpu model models
952 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
954 /**\brief create new host bypass the parser
959 /** \ingroup SURF_models
960 * \brief The network model
962 * When creating a new API on top on SURF, you shouldn't use the
963 * network model unless you know what you are doing. Only the host
964 * model should be accessed because depending on the platform model,
965 * the network model can be NULL.
967 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
969 /** \ingroup SURF_models
970 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
972 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
973 * based on the model 'LV08' and different correction factors depending on the communication
974 * size (< 1KiB, < 64KiB, >= 64KiB).
975 * See comments in the code for more information.
977 * \see surf_host_model_init_SMPI()
979 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
981 /** \ingroup SURF_models
982 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
984 * This model impelments a variant of the contention model on Infinband networks based on
985 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
987 * \see surf_host_model_init_IB()
989 XBT_PUBLIC(void) surf_network_model_init_IB(void);
991 /** \ingroup SURF_models
992 * \brief Initializes the platform with the network model 'LegrandVelho'
994 * This model is proposed by Arnaud Legrand and Pedro Velho based on
995 * the results obtained with the GTNets simulator for onelink and
996 * dogbone sharing scenarios. See comments in the code for more information.
998 * \see surf_host_model_init_LegrandVelho()
1000 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
1002 /** \ingroup SURF_models
1003 * \brief Initializes the platform with the network model 'Constant'
1005 * In this model, the communication time between two network cards is
1006 * constant, hence no need for a routing table. This is particularly
1007 * usefull when simulating huge distributed algorithms where
1008 * scalability is really an issue. This function is called in
1009 * conjunction with surf_host_model_init_compound.
1011 * \see surf_host_model_init_compound()
1013 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
1015 /** \ingroup SURF_models
1016 * \brief Initializes the platform with the network model CM02
1018 * You sould call this function by yourself only if you plan using
1019 * surf_host_model_init_compound.
1020 * See comments in the code for more information.
1022 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
1025 /** \ingroup SURF_models
1026 * \brief Initializes the platform with the network model GTNETS
1027 * \param filename XML platform file name
1029 * This function is called by surf_host_model_init_GTNETS
1030 * or by yourself only if you plan using surf_host_model_init_compound
1032 * \see surf_host_model_init_GTNETS()
1034 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
1038 /** \ingroup SURF_models
1039 * \brief Initializes the platform with the network model NS3
1040 * \param filename XML platform file name
1042 * This function is called by surf_host_model_init_NS3
1043 * or by yourself only if you plan using surf_host_model_init_compound
1045 * \see surf_host_model_init_NS3()
1047 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
1050 /** \ingroup SURF_models
1051 * \brief Initializes the platform with the network model Reno
1052 * \param filename XML platform file name
1054 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
1057 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1058 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1060 * Call this function only if you plan using surf_host_model_init_compound.
1063 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
1065 /** \ingroup SURF_models
1066 * \brief Initializes the platform with the network model Reno2
1067 * \param filename XML platform file name
1069 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
1072 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
1073 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1075 * Call this function only if you plan using surf_host_model_init_compound.
1078 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
1080 /** \ingroup SURF_models
1081 * \brief Initializes the platform with the network model Vegas
1082 * \param filename XML platform file name
1084 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
1085 * to the proportional fairness.
1088 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1089 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1091 * Call this function only if you plan using surf_host_model_init_compound.
1094 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
1096 /** \ingroup SURF_models
1097 * \brief The list of all available network model models
1099 XBT_PUBLIC_DATA(s_surf_model_description_t)
1100 surf_network_model_description[];
1102 /** \ingroup SURF_models
1103 * \brief The storage model
1105 XBT_PUBLIC(void) surf_storage_model_init_default(void);
1107 /** \ingroup SURF_models
1108 * \brief The list of all available storage modes.
1109 * This storage mode can be set using --cfg=storage/model:...
1111 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
1113 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
1115 /** \ingroup SURF_models
1116 * \brief The host model
1118 * Note that when you create an API on top of SURF,
1119 * the host model should be the only one you use
1120 * because depending on the platform model, the network model and the CPU model
1123 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
1125 /** \ingroup SURF_models
1126 * \brief The vm model
1128 * Note that when you create an API on top of SURF,
1129 * the vm model should be the only one you use
1130 * because depending on the platform model, the network model and the CPU model
1133 XBT_PUBLIC_DATA(surf_vm_model_t) surf_vm_model;
1135 /** \ingroup SURF_models
1136 * \brief Initializes the platform with a compound host model
1138 * This function should be called after a cpu_model and a
1139 * network_model have been set up.
1142 XBT_PUBLIC(void) surf_host_model_init_compound(void);
1144 /** \ingroup SURF_models
1145 * \brief Initializes the platform with the current best network and cpu models at hand
1147 * This platform model separates the host model and the network model.
1148 * The host model will be initialized with the model compound, the network
1149 * model with the model LV08 (with cross traffic support) and the CPU model with
1151 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1154 XBT_PUBLIC(void) surf_host_model_init_current_default(void);
1156 /** \ingroup SURF_models
1157 * \brief Initializes the platform with the model L07
1159 * With this model, only parallel tasks can be used. Resource sharing
1160 * is done by identifying bottlenecks and giving an equal share of
1161 * the model to each action.
1164 XBT_PUBLIC(void) surf_host_model_init_ptask_L07(void);
1166 /** \ingroup SURF_models
1167 * \brief The list of all available host model models
1169 XBT_PUBLIC_DATA(s_surf_model_description_t)
1170 surf_host_model_description[];
1172 /** \ingroup SURF_models
1173 * \brief Initializes the platform with the current best network and cpu models at hand
1175 * This platform model seperates the host model and the network model.
1176 * The host model will be initialized with the model compound, the network
1177 * model with the model LV08 (with cross traffic support) and the CPU model with
1179 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1182 XBT_PUBLIC(void) surf_vm_model_init_HL13(void);
1184 /** \ingroup SURF_models
1185 * \brief The list of all available vm model models
1187 XBT_PUBLIC_DATA(s_surf_model_description_t)
1188 surf_vm_model_description[];
1190 /*******************************************/
1192 /** \ingroup SURF_models
1193 * \brief List of initialized models
1195 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
1196 XBT_PUBLIC_DATA(xbt_dynar_t) model_list_invoke;
1198 /** \ingroup SURF_simulation
1199 * \brief List of hosts that have juste restarted and whose autorestart process should be restarted.
1201 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
1203 /** \ingroup SURF_simulation
1204 * \brief List of hosts for which one want to be notified if they ever restart.
1206 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
1208 /*******************************************/
1209 /*** SURF Platform *************************/
1210 /*******************************************/
1211 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
1212 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
1213 XBT_PUBLIC_DATA(AS_t) surf_AS_get_by_name(const char * name);
1214 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
1215 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
1216 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
1217 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
1218 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
1219 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
1221 /*******************************************/
1222 /*** SURF Globals **************************/
1223 /*******************************************/
1225 /** \ingroup SURF_simulation
1226 * \brief Initialize SURF
1227 * \param argc argument number
1228 * \param argv arguments
1230 * This function has to be called to initialize the common
1231 * structures. Then you will have to create the environment by
1233 * e.g. surf_host_model_init_CM02()
1235 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
1237 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
1239 /** \ingroup SURF_simulation
1240 * \brief Finish simulation initialization
1242 * This function must be called before the first call to surf_solve()
1244 XBT_PUBLIC(void) surf_presolve(void);
1246 /** \ingroup SURF_simulation
1247 * \brief Performs a part of the simulation
1248 * \param max_date Maximum date to update the simulation to, or -1
1249 * \return the elapsed time, or -1.0 if no event could be executed
1251 * This function execute all possible events, update the action states
1252 * and returns the time elapsed.
1253 * When you call execute or communicate on a model, the corresponding actions
1254 * are not executed immediately but only when you call surf_solve.
1255 * Note that the returned elapsed time can be zero.
1257 XBT_PUBLIC(double) surf_solve(double max_date);
1259 /** \ingroup SURF_simulation
1260 * \brief Return the current time
1262 * Return the current time in millisecond.
1264 XBT_PUBLIC(double) surf_get_clock(void);
1266 /** \ingroup SURF_simulation
1273 XBT_PUBLIC(void) surf_exit(void);
1275 /* Prototypes of the functions that handle the properties */
1276 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
1278 /* The same for model_prop set*/
1279 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
1281 /* surf parse file related (public because called from a test suite) */
1282 XBT_PUBLIC(void) parse_platform_file(const char *file);
1284 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
1285 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
1286 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
1287 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
1288 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
1289 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
1290 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
1293 XBT_PUBLIC(double) get_cpu_power(const char *power);
1295 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
1297 int surf_get_nthreads(void);
1298 void surf_set_nthreads(int nthreads);
1301 * Returns the initial path. On Windows the initial path is
1302 * the current directory for the current process in the other
1303 * case the function returns "./" that represents the current
1304 * directory on Unix/Linux platforms.
1306 const char *__surf_get_initial_path(void);
1308 /********** Tracing **********/
1309 /* from surf_instr.c */
1310 void TRACE_surf_action(surf_action_t surf_action, const char *category);
1311 void TRACE_surf_alloc(void);
1312 void TRACE_surf_release(void);
1314 /* instr_routing.c */
1315 void instr_routing_define_callbacks (void);
1316 void instr_new_variable_type (const char *new_typename, const char *color);
1317 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
1318 void instr_new_user_state_type (const char *father_type, const char *new_typename);
1319 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
1320 int instr_platform_traced (void);
1321 xbt_graph_t instr_routing_platform_graph (void);
1322 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1325 #endif /* _SURF_SURF_H */