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;
102 typedef HostCLM03 *surf_host_CLM03_t;
103 typedef NetworkCm02Link *surf_network_link_t;
105 /** @ingroup SURF_c_bindings
106 * \brief Action structure
108 * Never create s_surf_action_t by yourself ! The actions are created
109 * on the fly when you call execute or communicate on a model.
111 * \see e_surf_action_state_t
113 typedef Action *surf_action_t;
116 typedef RoutingEdge *routing_edge_t;
117 typedef RoutingPlatf *routing_platf_t;
119 typedef struct surf_file *surf_file_t;
121 XBT_PUBLIC(e_surf_network_element_type_t)
122 routing_get_network_element_type(const char* name);
124 /** @Brief Specify that we use that action */
125 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
127 /** @brief Creates a new action.
129 * @param size The size is the one of the subtype you want to create
130 * @param cost initial value
131 * @param model to which model we should attach this action
132 * @param failed whether we should start this action in failed mode
134 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
135 surf_model_t model, int failed);
137 /** \brief Resource model description
139 typedef struct surf_model_description {
141 const char *description;
142 void_f_void_t model_init_preparse;
143 } s_surf_model_description_t, *surf_model_description_t;
145 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
147 XBT_PUBLIC(void) model_help(const char *category,
148 s_surf_model_description_t * table);
150 /** @ingroup SURF_interface
151 * @brief Action states
158 SURF_ACTION_READY = 0, /**< Ready */
159 SURF_ACTION_RUNNING, /**< Running */
160 SURF_ACTION_FAILED, /**< Task Failure */
161 SURF_ACTION_DONE, /**< Completed */
162 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
163 SURF_ACTION_NOT_IN_THE_SYSTEM
164 /**< Not in the system anymore. Why did you ask ? */
165 } e_surf_action_state_t;
167 /** @ingroup SURF_vm_interface
171 /* FIXME: Where should the VM state be defined? */
173 SURF_VM_STATE_CREATED, /**< created, but not yet started */
174 SURF_VM_STATE_RUNNING,
175 SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
177 SURF_VM_STATE_SAVING, /**< Save/restore involves disk I/O, so there should be transition states. */
179 SURF_VM_STATE_RESTORING,
182 /***************************/
183 /* Generic model object */
184 /***************************/
186 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
188 static inline surf_host_t surf_host_resource_priv(const void *host){
189 return (surf_host_t) xbt_lib_get_level((xbt_dictelm_t)host, SURF_HOST_LEVEL);
191 static inline void *surf_routing_resource_priv(const void *host){
192 return (void*)xbt_lib_get_level((xbt_dictelm_t)host, ROUTING_HOST_LEVEL);
194 static inline void *surf_storage_resource_priv(const void *storage){
195 return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
198 static inline void *surf_storage_resource_by_name(const char *name){
199 return xbt_lib_get_elm_or_null(storage_lib, name);
203 XBT_PUBLIC(char *) surf_routing_edge_name(sg_routing_edge_t edge);
204 XBT_PUBLIC(void *) surf_as_cluster_get_backbone(AS_t as);
205 XBT_PUBLIC(void) surf_as_cluster_set_backbone(AS_t as, void* backbone);
207 /** @{ @ingroup SURF_c_bindings */
210 * @brief Get the name of a surf model
212 * @param model A model
213 * @return The name of the model
215 XBT_PUBLIC(const char *) surf_model_name(surf_model_t model);
218 * @brief Pop an action from the done actions set
220 * @param model The model from which the action is extracted
221 * @return An action in done state
223 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
226 * @brief Pop an action from the failed actions set
228 * @param model The model from which the action is extracted
229 * @return An action in failed state
231 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
234 * @brief Pop an action from the ready actions set
236 * @param model The model from which the action is extracted
237 * @return An action in ready state
239 XBT_PUBLIC(surf_action_t) surf_model_extract_ready_action_set(surf_model_t model);
242 * @brief Pop an action from the running actions set
244 * @param model The model from which the action is extracted
245 * @return An action in running state
247 XBT_PUBLIC(surf_action_t) surf_model_extract_running_action_set(surf_model_t model);
250 * @brief Get the size of the running action set of a model
252 * @param model The model
253 * @return The size of the running action set
255 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
258 * @brief Execute a parallel task
259 * @details [long description]
261 * @param model The model which handle the parallelisation
262 * @param host_nb The number of hosts
263 * @param host_list The list of hosts on which the task is executed
264 * @param flops_amount The processing amount (in flop) needed to process
265 * @param bytes_amount The amount of data (in bytes) needed to transfer
266 * @param rate [description]
267 * @return The action corresponding to the parallele execution task
269 XBT_PUBLIC(surf_action_t) surf_host_model_execute_parallel_task(surf_host_model_t model,
272 double *flops_amount,
273 double *bytes_amount,
277 * @brief Create a communication between two hosts
279 * @param model The model which handle the communication
280 * @param src The source host
281 * @param dst The destination host
282 * @param size The amount of data (in bytes) needed to transfer
283 * @param rate [description]
284 * @return The action corresponding to the communication
286 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);
289 * @brief Get the route between two hosts
290 * @details [long description]
292 * @param model The model which handle the routes
293 * @param src The source host
294 * @param dst The destination host
295 * @return The list of [TODO] from the source to the host
297 XBT_PUBLIC(xbt_dynar_t) surf_host_model_get_route(surf_host_model_t model, surf_resource_t src, surf_resource_t dst);
300 * @brief Create a new VM on the specified host
302 * @param name The name of the VM
303 * @param host_PM The host on which the VM is created
305 XBT_PUBLIC(void) surf_vm_model_create(const char *name, surf_resource_t host_PM);
308 * @brief Create a communication between two routing edges [TODO]
309 * @details [long description]
311 * @param model The model which handle the communication
312 * @param src The source host
313 * @param dst The destination host
314 * @param size The amount of data (in bytes) needed to transfer
315 * @param rate [description]
316 * @return The action corresponding to the communication
318 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);
321 * @brief Get the name of a surf resource (cpu, host, network, …)
323 * @param resource The surf resource
324 * @return The name of the surf resource
326 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
327 static inline const char * surf_cpu_name(surf_cpu_t cpu) {
328 return surf_resource_name((surf_cpp_resource_t)cpu);
332 * @brief Get the properties of a surf resource (cpu, host, network, …)
334 * @param resource The surf resource
335 * @return The properties of the surf resource
337 XBT_PUBLIC(xbt_dict_t) surf_resource_get_properties(surf_cpp_resource_t resource);
338 static XBT_INLINE xbt_dict_t surf_host_get_properties(surf_host_t host) {
339 return surf_resource_get_properties((surf_cpp_resource_t)host);
344 * @brief Get the state of a surf resource (cpu, host, network, …)
346 * @param resource The surf resource
347 * @return The state of the surf resource
349 XBT_PUBLIC(e_surf_resource_state_t) surf_resource_get_state(surf_cpp_resource_t resource);
351 static XBT_INLINE e_surf_resource_state_t surf_host_get_state(surf_host_t host) {
352 return surf_resource_get_state((surf_cpp_resource_t)host);
357 * @brief Set the state of a surf resource (cpu, host, network, …)
359 * @param resource The surf resource
360 * @param state The new state of the surf resource
362 XBT_PUBLIC(void) surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state);
363 static inline void surf_host_set_state(surf_host_t host, e_surf_resource_state_t state) {
364 surf_resource_set_state((surf_cpp_resource_t)host, state);
368 * @brief Get the speed of the cpu associated to a host
370 * @param resource The surf host
371 * @param load [description]
373 * @return [description]
375 XBT_PUBLIC(double) surf_host_get_speed(surf_resource_t resource, double load);
378 * @brief Get the available speed of cpu associated to a host
380 * @param resource The surf host
381 * @return [description]
383 XBT_PUBLIC(double) surf_host_get_available_speed(surf_resource_t resource);
386 * @brief Get the number of cores of the cpu associated to a host
388 * @param resource The surf host
389 * @return The number of cores
391 XBT_PUBLIC(int) surf_host_get_core(surf_resource_t resource);
394 * @brief Execute some quantity of computation
396 * @param resource The surf host
397 * @param size The value of the processing amount (in flop) needed to process
399 * @return The surf action corresponding to the processing
401 XBT_PUBLIC(surf_action_t) surf_host_execute(surf_resource_t resource, double size);
404 * @brief Make the host sleep
406 * @param resource The surf host
407 * @param duration The number of seconds to sleep
408 * @return The surf action corresponding to the sleep
410 XBT_PUBLIC(surf_action_t) surf_host_sleep(surf_resource_t resource, double duration);
413 * @brief Open a file on an host
415 * @param host The surf host
416 * @param fullpath The path to the file
417 * @return The surf action corresponding to the openning
419 XBT_PUBLIC(surf_action_t) surf_host_open(surf_resource_t host, const char* fullpath);
422 * @brief Close a file descriptor on an host
424 * @param host The surf host
425 * @param fd The file descriptor
427 * @return The surf action corresponding to the closing
429 XBT_PUBLIC(surf_action_t) surf_host_close(surf_resource_t host, surf_file_t fd);
434 * @param host The surf host
435 * @param fd The file descriptor to read
436 * @param size The size in bytes to read
437 * @return The surf action corresponding to the reading
439 XBT_PUBLIC(surf_action_t) surf_host_read(surf_resource_t host, surf_file_t fd, sg_size_t size);
442 * @brief Write a file
444 * @param host The surf host
445 * @param fd The file descriptor to write
446 * @param size The size in bytes to write
447 * @return The surf action corresponding to the writing
449 XBT_PUBLIC(surf_action_t) surf_host_write(surf_resource_t host, surf_file_t fd, sg_size_t size);
452 * @brief Get the informations of a file descriptor
453 * @details The returned xbt_dynar_t contains:
454 * - the size of the file,
456 * - the storage name,
457 * - the storage typeId,
458 * - the storage content type
460 * @param host The surf host
461 * @param fd The file descriptor
462 * @return An xbt_dynar_t with the file informations
464 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(surf_resource_t host, surf_file_t fd);
467 * @brief Get the available space of the storage at the mount point
469 * @param resource The surf host
470 * @param name The mount point
471 * @return The amount of available space in bytes
473 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(surf_resource_t resource, const char* name);
476 * @brief Get the used space of the storage at the mount point
478 * @param resource The surf host
479 * @param name The mount point
480 * @return The amount of used space in bytes
482 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(surf_resource_t resource, const char* name);
485 * @brief Get the VMs hosted on the host
487 * @param resource The surf host
488 * @return The list of VMs on the host
490 XBT_PUBLIC(xbt_dynar_t) surf_host_get_vms(surf_resource_t resource);
493 * @brief [brief description]
494 * @details [long description]
496 * @param resource [description]
497 * @param params [description]
499 XBT_PUBLIC(void) surf_host_get_params(surf_resource_t resource, ws_params_t params);
502 * @brief [brief description]
503 * @details [long description]
505 * @param resource [description]
506 * @param params [description]
508 XBT_PUBLIC(void) surf_host_set_params(surf_resource_t resource, ws_params_t params);
511 * @brief Destroy a VM
513 * @param resource The surf vm
515 XBT_PUBLIC(void) surf_vm_destroy(surf_resource_t resource);
518 * @brief Suspend a VM
520 * @param resource The surf vm
522 XBT_PUBLIC(void) surf_vm_suspend(surf_resource_t resource);
527 * @param resource The surf vm
529 XBT_PUBLIC(void) surf_vm_resume(surf_resource_t resource);
532 * @brief Save the VM (Not yet implemented)
534 * @param resource The surf vm
536 XBT_PUBLIC(void) surf_vm_save(surf_resource_t resource);
539 * @brief Restore the VM (Not yet implemented)
541 * @param resource The surf vm
543 XBT_PUBLIC(void) surf_vm_restore(surf_resource_t resource);
546 * @brief Migrate the VM to the destination host
548 * @param resource The surf vm
549 * @param ind_vm_ws_dest The destination host
551 XBT_PUBLIC(void) surf_vm_migrate(surf_resource_t resource, surf_resource_t ind_vm_ws_dest);
554 * @brief Get the physical machine hosting the VM
556 * @param resource The surf vm
557 * @return The physical machine hosting the VM
559 XBT_PUBLIC(surf_resource_t) surf_vm_get_pm(surf_resource_t resource);
562 * @brief [brief description]
563 * @details [long description]
565 * @param resource [description]
566 * @param bound [description]
568 XBT_PUBLIC(void) surf_vm_set_bound(surf_resource_t resource, double bound);
571 * @brief [brief description]
572 * @details [long description]
574 * @param resource [description]
575 * @param cpu [description]
576 * @param mask [description]
578 XBT_PUBLIC(void) surf_vm_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask);
581 * @brief Execute some quantity of computation
583 * @param cpu The surf cpu
584 * @param size The value of the processing amount (in flop) needed to process
585 * @return The surf action corresponding to the processing
587 XBT_PUBLIC(surf_action_t) surf_cpu_execute(surf_resource_t cpu, double size);
590 * @brief Make the cpu sleep for duration (in seconds)
591 * @details [long description]
593 * @param cpu The surf cpu
594 * @param duration The number of seconds to sleep
595 * @return The surf action corresponding to the sleeping
597 XBT_PUBLIC(surf_action_t) surf_cpu_sleep(surf_resource_t cpu, double duration);
600 * @brief Get the host power peak
601 * @details [long description]
603 * @param host The surf host
604 * @return The power peak
606 XBT_PUBLIC(double) surf_host_get_current_power_peak(surf_resource_t host);
609 * @brief [brief description]
610 * @details [long description]
612 * @param host [description]
613 * @param pstate_index [description]
615 * @return [description]
617 XBT_PUBLIC(double) surf_host_get_power_peak_at(surf_resource_t host, int pstate_index);
620 * @brief [brief description]
621 * @details [long description]
623 * @param host [description]
624 * @return [description]
626 XBT_PUBLIC(int) surf_host_get_nb_pstates(surf_resource_t host);
628 XBT_PUBLIC(void) surf_host_set_pstate(surf_resource_t host, int pstate_index);
629 XBT_PUBLIC(int) surf_host_get_pstate(surf_resource_t host);
630 XBT_PUBLIC(double) surf_host_get_wattmin_at(surf_resource_t resource, int pstate);
631 XBT_PUBLIC(double) surf_host_get_wattmax_at(surf_resource_t resource, int pstate);
634 * @brief Get the consumed energy (in joules) of an host
636 * @param host The surf host
637 * @return The consumed energy
639 XBT_PUBLIC(double) surf_host_get_consumed_energy(surf_resource_t host);
642 * @brief Get the list of storages mounted on an host
644 * @param host The surf host
645 * @return Dictionary of mount point, Storage
647 XBT_PUBLIC(xbt_dict_t) surf_host_get_mounted_storage_list(surf_resource_t host);
650 * @brief Get the list of storages attached to an host
652 * @param host The surf host
653 * @return Dictionary of storage
655 XBT_PUBLIC(xbt_dynar_t) surf_host_get_attached_storage_list(surf_resource_t host);
658 * @brief Unlink a file descriptor
660 * @param host The surf host
661 * @param fd The file descriptor
663 * @return 0 if failed to unlink, 1 otherwise
665 XBT_PUBLIC(int) surf_host_unlink(surf_resource_t host, surf_file_t fd);
668 * @brief Get the size of a file on a host
670 * @param host The surf host
671 * @param fd The file descriptor
673 * @return The size in bytes of the file
675 XBT_PUBLIC(size_t) surf_host_get_size(surf_resource_t host, surf_file_t fd);
678 * @brief Get the current position of the file descriptor
680 * @param host The surf host
681 * @param fd The file descriptor
682 * @return The current position of the file descriptor
684 XBT_PUBLIC(size_t) surf_host_file_tell(surf_resource_t host, surf_file_t fd);
687 * @brief Move a file to another location on the *same mount point*.
688 * @details [long description]
690 * @param host The surf host
691 * @param fd The file descriptor
692 * @param fullpath The new full path
694 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
696 XBT_PUBLIC(int) surf_host_file_move(surf_resource_t host, surf_file_t fd, const char* fullpath);
699 * @brief Set the position indictator assiociated with the file descriptor to a new position
700 * @details [long description]
702 * @param host The surf host
703 * @param fd The file descriptor
704 * @param offset The offset from the origin
705 * @param origin Position used as a reference for the offset
706 * - SEEK_SET: beginning of the file
707 * - SEEK_CUR: current position indicator
708 * - SEEK_END: end of the file
709 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
711 XBT_PUBLIC(int) surf_host_file_seek(surf_resource_t host,
712 surf_file_t fd, sg_offset_t offset,
716 * @brief [brief description]
717 * @details [long description]
719 * @param link [description]
720 * @return [description]
722 XBT_PUBLIC(int) surf_network_link_is_shared(surf_cpp_resource_t link);
725 * @brief Get the bandwidth of a link in bytes per second
727 * @param link The surf link
728 * @return The bandwidth in bytes per second
730 XBT_PUBLIC(double) surf_network_link_get_bandwidth(surf_cpp_resource_t link);
733 * @brief Get the latency of a link in seconds
735 * @param link The surf link
736 * @return The latency in seconds
738 XBT_PUBLIC(double) surf_network_link_get_latency(surf_cpp_resource_t link);
741 * @brief Get the content of a storage
743 * @param resource The surf storage
744 * @return A xbt_dict_t with path as keys and size in bytes as values
746 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
749 * @brief Get the size in bytes of a storage
751 * @param resource The surf storage
752 * @return The size in bytes of the storage
754 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
757 * @brief Get the available size in bytes of a storage
759 * @param resource The surf storage
760 * @return The available size in bytes of the storage
762 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
765 * @brief Get the size in bytes of a storage
767 * @param resource The surf storage
768 * @return The used size in bytes of the storage
770 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
774 * @brief Get the data associated to the action
776 * @param action The surf action
777 * @return The data associated to the action
779 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
782 * @brief Set the data associated to the action
783 * @details [long description]
785 * @param action The surf action
786 * @param data The new data associated to the action
788 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
791 * @brief Unreference an action
793 * @param action The surf action
795 XBT_PUBLIC(void) surf_action_unref(surf_action_t action);
798 * @brief Get the start time of an action
800 * @param action The surf action
801 * @return The start time in seconds from the beginning of the simulation
803 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
806 * @brief Get the finish time of an action
808 * @param action The surf action
809 * @return The finish time in seconds from the beginning of the simulation
811 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
814 * @brief Get the remains amount of work to do of an action
816 * @param action The surf action
817 * @return The remains amount of work to do
819 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
822 * @brief Suspend an action
824 * @param action The surf action
826 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
829 * @brief Resume an action
831 * @param action The surf action
833 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
836 * @brief Cancel an action
838 * @param action The surf action
840 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
843 * @brief Set the priority of an action
844 * @details [long description]
846 * @param action The surf action
847 * @param priority The new priority [TODO]
849 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
852 * @brief Set the category of an action
853 * @details [long description]
855 * @param action The surf action
856 * @param category The new category of the action
858 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
861 * @brief Get the state of an action
863 * @param action The surf action
864 * @return The state of the action
866 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
869 * @brief Get the cost of an action
871 * @param action The surf action
872 * @return The cost of the action
874 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
877 * @brief [brief desrciption]
878 * @details [long description]
880 * @param action The surf cpu action
881 * @param cpu [description]
882 * @param mask [description]
884 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask);
887 * @brief [brief description]
888 * @details [long description]
890 * @param action The surf cpu action
891 * @param bound [description]
893 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
896 * @brief [brief description]
897 * @details [long description]
899 * @param action The surf network action
901 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
904 * @brief Get the file associated to a storage action
906 * @param action The surf storage action
907 * @return The file associated to a storage action
909 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
912 * @brief Get the result dictionary of an ls action
914 * @param action The surf storage action
915 * @return The dictionry listing a path
917 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
921 * @brief Get the host the storage is attached to
923 * @param resource The surf storage
924 * @return The host name
926 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
928 XBT_PUBLIC(surf_model_t) surf_resource_model(const void *host, int level);
932 /**************************************/
933 /* Implementations of model object */
934 /**************************************/
936 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
937 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
939 /** \ingroup SURF_models
940 * \brief The CPU model object for the physical machine layer
942 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
944 /** \ingroup SURF_models
945 * \brief The CPU model object for the virtual machine layer
947 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
950 /** \ingroup SURF_models
951 * \brief Initializes the CPU model with the model Cas01
953 * By default, this model uses the lazy optimization mechanism that
954 * relies on partial invalidation in LMM and a heap for lazy action update.
955 * You can change this behavior by setting the cpu/optim configuration
956 * variable to a different value.
958 * You shouldn't have to call it by yourself.
960 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
962 /** \ingroup SURF_models
963 * \brief Initializes the CPU model with trace integration [Deprecated]
965 * You shouldn't have to call it by yourself.
967 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
969 /** \ingroup SURF_models
970 * \brief The list of all available optimization modes (both for cpu and networks).
971 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
973 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
975 /** \ingroup SURF_plugins
976 * \brief The list of all available surf plugins
978 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
980 /** \ingroup SURF_models
981 * \brief The list of all available cpu model models
983 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
985 /**\brief create new host bypass the parser
990 /** \ingroup SURF_models
991 * \brief The network model
993 * When creating a new API on top on SURF, you shouldn't use the
994 * network model unless you know what you are doing. Only the host
995 * model should be accessed because depending on the platform model,
996 * the network model can be NULL.
998 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
1000 /** \ingroup SURF_models
1001 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
1003 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
1004 * based on the model 'LV08' and different correction factors depending on the communication
1005 * size (< 1KiB, < 64KiB, >= 64KiB).
1006 * See comments in the code for more information.
1008 * \see surf_host_model_init_SMPI()
1010 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
1012 /** \ingroup SURF_models
1013 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
1015 * This model impelments a variant of the contention model on Infinband networks based on
1016 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
1018 * \see surf_host_model_init_IB()
1020 XBT_PUBLIC(void) surf_network_model_init_IB(void);
1022 /** \ingroup SURF_models
1023 * \brief Initializes the platform with the network model 'LegrandVelho'
1025 * This model is proposed by Arnaud Legrand and Pedro Velho based on
1026 * the results obtained with the GTNets simulator for onelink and
1027 * dogbone sharing scenarios. See comments in the code for more information.
1029 * \see surf_host_model_init_LegrandVelho()
1031 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
1033 /** \ingroup SURF_models
1034 * \brief Initializes the platform with the network model 'Constant'
1036 * In this model, the communication time between two network cards is
1037 * constant, hence no need for a routing table. This is particularly
1038 * usefull when simulating huge distributed algorithms where
1039 * scalability is really an issue. This function is called in
1040 * conjunction with surf_host_model_init_compound.
1042 * \see surf_host_model_init_compound()
1044 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
1046 /** \ingroup SURF_models
1047 * \brief Initializes the platform with the network model CM02
1049 * You sould call this function by yourself only if you plan using
1050 * surf_host_model_init_compound.
1051 * See comments in the code for more information.
1053 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
1056 /** \ingroup SURF_models
1057 * \brief Initializes the platform with the network model GTNETS
1058 * \param filename XML platform file name
1060 * This function is called by surf_host_model_init_GTNETS
1061 * or by yourself only if you plan using surf_host_model_init_compound
1063 * \see surf_host_model_init_GTNETS()
1065 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
1069 /** \ingroup SURF_models
1070 * \brief Initializes the platform with the network model NS3
1071 * \param filename XML platform file name
1073 * This function is called by surf_host_model_init_NS3
1074 * or by yourself only if you plan using surf_host_model_init_compound
1076 * \see surf_host_model_init_NS3()
1078 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
1081 /** \ingroup SURF_models
1082 * \brief Initializes the platform with the network model Reno
1083 * \param filename XML platform file name
1085 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
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_Reno(void);
1096 /** \ingroup SURF_models
1097 * \brief Initializes the platform with the network model Reno2
1098 * \param filename XML platform file name
1100 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
1103 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
1104 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1106 * Call this function only if you plan using surf_host_model_init_compound.
1109 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
1111 /** \ingroup SURF_models
1112 * \brief Initializes the platform with the network model Vegas
1113 * \param filename XML platform file name
1115 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
1116 * to the proportional fairness.
1119 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1120 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1122 * Call this function only if you plan using surf_host_model_init_compound.
1125 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
1127 /** \ingroup SURF_models
1128 * \brief The list of all available network model models
1130 XBT_PUBLIC_DATA(s_surf_model_description_t)
1131 surf_network_model_description[];
1133 /** \ingroup SURF_models
1134 * \brief The storage model
1136 XBT_PUBLIC(void) surf_storage_model_init_default(void);
1138 /** \ingroup SURF_models
1139 * \brief The list of all available storage modes.
1140 * This storage mode can be set using --cfg=storage/model:...
1142 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
1144 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
1146 /** \ingroup SURF_models
1147 * \brief The host model
1149 * Note that when you create an API on top of SURF,
1150 * the host model should be the only one you use
1151 * because depending on the platform model, the network model and the CPU model
1154 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
1156 /** \ingroup SURF_models
1157 * \brief The vm model
1159 * Note that when you create an API on top of SURF,
1160 * the vm model should be the only one you use
1161 * because depending on the platform model, the network model and the CPU model
1164 XBT_PUBLIC_DATA(surf_vm_model_t) surf_vm_model;
1166 /** \ingroup SURF_models
1167 * \brief Initializes the platform with a compound host model
1169 * This function should be called after a cpu_model and a
1170 * network_model have been set up.
1173 XBT_PUBLIC(void) surf_host_model_init_compound(void);
1175 /** \ingroup SURF_models
1176 * \brief Initializes the platform with the current best network and cpu models at hand
1178 * This platform model separates the host model and the network model.
1179 * The host model will be initialized with the model compound, the network
1180 * model with the model LV08 (with cross traffic support) and the CPU model with
1182 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1185 XBT_PUBLIC(void) surf_host_model_init_current_default(void);
1187 /** \ingroup SURF_models
1188 * \brief Initializes the platform with the model L07
1190 * With this model, only parallel tasks can be used. Resource sharing
1191 * is done by identifying bottlenecks and giving an equal share of
1192 * the model to each action.
1195 XBT_PUBLIC(void) surf_host_model_init_ptask_L07(void);
1197 /** \ingroup SURF_models
1198 * \brief The list of all available host model models
1200 XBT_PUBLIC_DATA(s_surf_model_description_t)
1201 surf_host_model_description[];
1203 /** \ingroup SURF_models
1204 * \brief Initializes the platform with the current best network and cpu models at hand
1206 * This platform model seperates the host model and the network model.
1207 * The host model will be initialized with the model compound, the network
1208 * model with the model LV08 (with cross traffic support) and the CPU model with
1210 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1213 XBT_PUBLIC(void) surf_vm_model_init_HL13(void);
1215 /** \ingroup SURF_models
1216 * \brief The list of all available vm model models
1218 XBT_PUBLIC_DATA(s_surf_model_description_t)
1219 surf_vm_model_description[];
1221 /*******************************************/
1223 /** \ingroup SURF_models
1224 * \brief List of initialized models
1226 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
1227 XBT_PUBLIC_DATA(xbt_dynar_t) model_list_invoke;
1229 /** \ingroup SURF_simulation
1230 * \brief List of hosts that have juste restarted and whose autorestart process should be restarted.
1232 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
1234 /** \ingroup SURF_simulation
1235 * \brief List of hosts for which one want to be notified if they ever restart.
1237 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
1239 /*******************************************/
1240 /*** SURF Platform *************************/
1241 /*******************************************/
1242 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
1243 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
1244 XBT_PUBLIC_DATA(AS_t) surf_AS_get_by_name(const char * name);
1245 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
1246 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
1247 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
1248 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
1249 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
1250 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
1252 /*******************************************/
1253 /*** SURF Globals **************************/
1254 /*******************************************/
1256 /** \ingroup SURF_simulation
1257 * \brief Initialize SURF
1258 * \param argc argument number
1259 * \param argv arguments
1261 * This function has to be called to initialize the common
1262 * structures. Then you will have to create the environment by
1264 * e.g. surf_host_model_init_CM02()
1266 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
1268 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
1270 /** \ingroup SURF_simulation
1271 * \brief Finish simulation initialization
1273 * This function must be called before the first call to surf_solve()
1275 XBT_PUBLIC(void) surf_presolve(void);
1277 /** \ingroup SURF_simulation
1278 * \brief Performs a part of the simulation
1279 * \param max_date Maximum date to update the simulation to, or -1
1280 * \return the elapsed time, or -1.0 if no event could be executed
1282 * This function execute all possible events, update the action states
1283 * and returns the time elapsed.
1284 * When you call execute or communicate on a model, the corresponding actions
1285 * are not executed immediately but only when you call surf_solve.
1286 * Note that the returned elapsed time can be zero.
1288 XBT_PUBLIC(double) surf_solve(double max_date);
1290 /** \ingroup SURF_simulation
1291 * \brief Return the current time
1293 * Return the current time in millisecond.
1295 XBT_PUBLIC(double) surf_get_clock(void);
1297 /** \ingroup SURF_simulation
1304 XBT_PUBLIC(void) surf_exit(void);
1306 /* Prototypes of the functions that handle the properties */
1307 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
1309 /* The same for model_prop set*/
1310 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
1312 /* surf parse file related (public because called from a test suite) */
1313 XBT_PUBLIC(void) parse_platform_file(const char *file);
1315 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
1316 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
1317 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
1318 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
1319 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
1320 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
1321 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
1324 XBT_PUBLIC(double) get_cpu_power(const char *power);
1326 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
1328 int surf_get_nthreads(void);
1329 void surf_set_nthreads(int nthreads);
1332 * Returns the initial path. On Windows the initial path is
1333 * the current directory for the current process in the other
1334 * case the function returns "./" that represents the current
1335 * directory on Unix/Linux platforms.
1337 const char *__surf_get_initial_path(void);
1339 /********** Tracing **********/
1340 /* from surf_instr.c */
1341 void TRACE_surf_action(surf_action_t surf_action, const char *category);
1342 void TRACE_surf_alloc(void);
1343 void TRACE_surf_release(void);
1345 /* instr_routing.c */
1346 void instr_routing_define_callbacks (void);
1347 void instr_new_variable_type (const char *new_typename, const char *color);
1348 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
1349 void instr_new_user_state_type (const char *father_type, const char *new_typename);
1350 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
1351 int instr_platform_traced (void);
1352 xbt_graph_t instr_routing_platform_graph (void);
1353 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1356 #endif /* _SURF_SURF_H */