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;
50 class WorkstationModel;
51 class WorkstationVMModel;
56 class WorkstationCLM03;
57 class NetworkCm02Link;
61 class StorageActionLmm;
66 typedef struct Model Model;
67 typedef struct CpuModel CpuModel;
68 typedef struct WorkstationModel WorkstationModel;
69 typedef struct WorkstationVMModel WorkstationVMModel;
70 typedef struct NetworkModel NetworkModel;
71 typedef struct StorageModel StorageModel;
72 typedef struct Resource Resource;
73 typedef struct ResourceLmm ResourceLmm;
74 typedef struct WorkstationCLM03 WorkstationCLM03;
75 typedef struct NetworkCm02Link NetworkCm02Link;
76 typedef struct Cpu Cpu;
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 workstations,
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 WorkstationModel *surf_workstation_model_t;
94 typedef WorkstationVMModel *surf_vm_workstation_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 WorkstationCLM03 *surf_workstation_CLM03_t;
102 typedef NetworkCm02Link *surf_network_link_t;
103 typedef Cpu *surf_cpu_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 //FIXME:REMOVE typedef struct s_routing_platf s_routing_platf_t, *routing_platf_t;
187 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
189 static inline void *surf_cpu_resource_priv(const void *host) {
190 return xbt_lib_get_level((xbt_dictelm_t)host, SURF_CPU_LEVEL);
192 static inline void *surf_workstation_resource_priv(const void *host){
193 return (void*)xbt_lib_get_level((xbt_dictelm_t)host, SURF_WKS_LEVEL);
195 static inline void *surf_routing_resource_priv(const void *host){
196 return (void*)xbt_lib_get_level((xbt_dictelm_t)host, ROUTING_HOST_LEVEL);
198 static inline void *surf_storage_resource_priv(const void *storage){
199 return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
202 static inline void *surf_cpu_resource_by_name(const char *name) {
203 return xbt_lib_get_elm_or_null(host_lib, name);
205 static inline void *surf_workstation_resource_by_name(const char *name){
206 return xbt_lib_get_elm_or_null(host_lib, name);
208 static inline void *surf_storage_resource_by_name(const char *name){
209 return xbt_lib_get_elm_or_null(storage_lib, name);
213 XBT_PUBLIC(char *) surf_routing_edge_name(sg_routing_edge_t edge);
214 XBT_PUBLIC(void *) surf_as_cluster_get_backbone(AS_t as);
215 XBT_PUBLIC(void) surf_as_cluster_set_backbone(AS_t as, void* backbone);
217 /** @{ @ingroup SURF_c_bindings */
220 * @brief Get the name of a surf model
222 * @param model A model
223 * @return The name of the model
225 XBT_PUBLIC(const char *) surf_model_name(surf_model_t model);
228 * @brief Pop an action from the done actions set
230 * @param model The model from which the action is extracted
231 * @return An action in done state
233 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
236 * @brief Pop an action from the failed actions set
238 * @param model The model from which the action is extracted
239 * @return An action in failed state
241 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
244 * @brief Pop an action from the ready actions set
246 * @param model The model from which the action is extracted
247 * @return An action in ready state
249 XBT_PUBLIC(surf_action_t) surf_model_extract_ready_action_set(surf_model_t model);
252 * @brief Pop an action from the running actions set
254 * @param model The model from which the action is extracted
255 * @return An action in running state
257 XBT_PUBLIC(surf_action_t) surf_model_extract_running_action_set(surf_model_t model);
260 * @brief Get the size of the running action set of a model
262 * @param model The model
263 * @return The size of the running action set
265 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
268 * @brief Execute a parallel task
269 * @details [long description]
271 * @param model The model which handle the parallelisation
272 * @param workstation_nb The number of workstations
273 * @param workstation_list The list of workstations on which the task is executed
274 * @param flops_amount The processing amount (in flop) needed to process
275 * @param bytes_amount The amount of data (in bytes) needed to transfer
276 * @param rate [description]
277 * @return The action corresponding to the parallele execution task
279 XBT_PUBLIC(surf_action_t) surf_workstation_model_execute_parallel_task(surf_workstation_model_t model,
281 void **workstation_list,
282 double *flops_amount,
283 double *bytes_amount,
287 * @brief Create a communication between two hosts
289 * @param model The model which handle the communication
290 * @param src The source host
291 * @param dst The destination host
292 * @param size The amount of data (in bytes) needed to transfer
293 * @param rate [description]
294 * @return The action corresponding to the communication
296 XBT_PUBLIC(surf_action_t) surf_workstation_model_communicate(surf_workstation_model_t model, surf_resource_t src, surf_resource_t dst, double size, double rate);
299 * @brief Get the route between two hosts
300 * @details [long description]
302 * @param model The model which handle the routes
303 * @param src The source host
304 * @param dst The destination host
305 * @return The list of [TODO] from the source to the host
307 XBT_PUBLIC(xbt_dynar_t) surf_workstation_model_get_route(surf_workstation_model_t model, surf_resource_t src, surf_resource_t dst);
310 * @brief Create a new VM on the specified host
312 * @param name The name of the workstation
313 * @param ind_phys_host The host on which the VM is created
315 XBT_PUBLIC(void) surf_vm_workstation_model_create(const char *name, surf_resource_t ind_phys_host);
318 * @brief Create a communication between two routing edges [TODO]
319 * @details [long description]
321 * @param model The model which handle the communication
322 * @param src The source host
323 * @param dst The destination host
324 * @param size The amount of data (in bytes) needed to transfer
325 * @param rate [description]
326 * @return The action corresponding to the communication
328 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);
331 * @brief Get the name of a surf resource (cpu, workstation, network, …)
333 * @param resource The surf resource
334 * @return The name of the surf resource
336 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
339 * @brief Get the properties of a surf resource (cpu, workstation, network, …)
341 * @param resource The surf resource
342 * @return The properties of the surf resource
344 XBT_PUBLIC(xbt_dict_t) surf_resource_get_properties(surf_cpp_resource_t resource);
347 * @brief Get the state of a surf resource (cpu, workstation, network, …)
349 * @param resource The surf resource
350 * @return The state of the surf resource
352 XBT_PUBLIC(e_surf_resource_state_t) surf_resource_get_state(surf_cpp_resource_t resource);
355 * @brief Set the state of a surf resource (cpu, workstation, network, …)
357 * @param resource The surf resource
358 * @param state The new state of the surf resource
360 XBT_PUBLIC(void) surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state);
363 * @brief Get the speed of the cpu associtated to a workstation
365 * @param resource The surf workstation
366 * @param load [description]
368 * @return [description]
370 XBT_PUBLIC(double) surf_workstation_get_speed(surf_resource_t resource, double load);
373 * @brief Get the available speed of cpu associtated to a workstation
375 * @param resource The surf workstation
376 * @return [description]
378 XBT_PUBLIC(double) surf_workstation_get_available_speed(surf_resource_t resource);
381 * @brief Get the number of cores of the cpu associated to a workstation
383 * @param resource The surf workstation
384 * @return The number of cores
386 XBT_PUBLIC(int) surf_workstation_get_core(surf_resource_t resource);
389 * @brief Execute some quantity of computation
391 * @param resource The surf workstation
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_workstation_execute(surf_resource_t resource, double size);
399 * @brief Make the workstation sleep
401 * @param resource The surf workstation
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_workstation_sleep(surf_resource_t resource, double duration);
408 * @brief Open a file on a workstation
410 * @param workstation The surf workstation
411 * @param fullpath The path to the file
412 * @return The surf action corresponding to the openning
414 XBT_PUBLIC(surf_action_t) surf_workstation_open(surf_resource_t workstation, const char* fullpath);
417 * @brief Close a file descriptor on a workstation
419 * @param workstation The surf workstation
420 * @param fd The file descriptor
422 * @return The surf action corresponding to the closing
424 XBT_PUBLIC(surf_action_t) surf_workstation_close(surf_resource_t workstation, surf_file_t fd);
429 * @param resource The surf workstation
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_workstation_read(surf_resource_t resource, surf_file_t fd, sg_size_t size);
437 * @brief Write a file
439 * @param resource The surf workstation
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_workstation_write(surf_resource_t resource, 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 resource The surf workstation
456 * @param fd The file descriptor
457 * @return An xbt_dynar_t with the file informations
459 XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_info(surf_resource_t resource, surf_file_t fd);
462 * @brief Get the available space of the storage at the mount point
464 * @param resource The surf workstation
465 * @param name The mount point
466 * @return The amount of availble space in bytes
468 XBT_PUBLIC(sg_size_t) surf_workstation_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 workstation
474 * @param name The mount point
475 * @return The amount of used space in bytes
477 XBT_PUBLIC(sg_size_t) surf_workstation_get_used_size(surf_resource_t resource, const char* name);
480 * @brief Get the VMs hosted on the workstation
482 * @param resource The surf workstation
483 * @return The list of VMs on the workstation
485 XBT_PUBLIC(xbt_dynar_t) surf_workstation_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_workstation_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_workstation_set_params(surf_resource_t resource, ws_params_t params);
506 * @brief Destroy a Workstation VM
508 * @param resource The surf workstation vm
510 XBT_PUBLIC(void) surf_vm_workstation_destroy(surf_resource_t resource);
513 * @brief Suspend a Workstation VM
515 * @param resource The surf workstation vm
517 XBT_PUBLIC(void) surf_vm_workstation_suspend(surf_resource_t resource);
520 * @brief Resume a Workstation VM
522 * @param resource The surf workstation vm
524 XBT_PUBLIC(void) surf_vm_workstation_resume(surf_resource_t resource);
527 * @brief Save the Workstation VM (Not yet implemented)
529 * @param resource The surf workstation vm
531 XBT_PUBLIC(void) surf_vm_workstation_save(surf_resource_t resource);
534 * @brief Restore the Workstation VM (Not yet implemented)
536 * @param resource The surf workstation vm
538 XBT_PUBLIC(void) surf_vm_workstation_restore(surf_resource_t resource);
541 * @brief Migrate the VM to the destination host
543 * @param resource The surf workstation vm
544 * @param ind_vm_ws_dest The destination host
546 XBT_PUBLIC(void) surf_vm_workstation_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 workstation vm
552 * @return The physical machine hosting the VM
554 XBT_PUBLIC(surf_resource_t) surf_vm_workstation_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_workstation_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_workstation_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 workstation power peak
596 * @details [long description]
598 * @param host The surf workstation
599 * @return The power peak
601 XBT_PUBLIC(double) surf_workstation_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_workstation_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_workstation_get_nb_pstates(surf_resource_t host);
623 XBT_PUBLIC(void) surf_workstation_set_pstate(surf_resource_t host, int pstate_index);
624 XBT_PUBLIC(int) surf_workstation_get_pstate(surf_resource_t host);
625 XBT_PUBLIC(double) surf_workstation_get_wattmin_at(surf_resource_t resource, int pstate);
626 XBT_PUBLIC(double) surf_workstation_get_wattmax_at(surf_resource_t resource, int pstate);
629 * @brief Get the consumed energy (in joules) of a workstation
631 * @param host The surf workstation
632 * @return The consumed energy
634 XBT_PUBLIC(double) surf_workstation_get_consumed_energy(surf_resource_t host);
637 * @brief Get the list of storages mounted on a workstation
639 * @param workstation The surf workstation
640 * @return Dictionary of mount point, Storage
642 XBT_PUBLIC(xbt_dict_t) surf_workstation_get_mounted_storage_list(surf_resource_t workstation);
645 * @brief Get the list of storages attached to a workstation
647 * @param workstation The surf workstation
648 * @return Dictionary of storage
650 XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_attached_storage_list(surf_resource_t workstation);
653 * @brief Unlink a file descriptor
655 * @param workstation The surf workstation
656 * @param fd The file descriptor
658 * @return 0 if failed to unlink, 1 otherwise
660 XBT_PUBLIC(int) surf_workstation_unlink(surf_resource_t workstation, surf_file_t fd);
663 * @brief Get the size of a file on a workstation
665 * @param workstation The surf workstation
666 * @param fd The file descriptor
668 * @return The size in bytes of the file
670 XBT_PUBLIC(size_t) surf_workstation_get_size(surf_resource_t workstation, surf_file_t fd);
673 * @brief Get the current position of the file descriptor
675 * @param workstation The surf workstation
676 * @param fd The file descriptor
677 * @return The current position of the file descriptor
679 XBT_PUBLIC(size_t) surf_workstation_file_tell(surf_resource_t workstation, surf_file_t fd);
682 * @brief Move a file to another location on the *same mount point*.
683 * @details [long description]
685 * @param workstation The surf workstation
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_workstation_file_move(surf_resource_t workstation, 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 workstation The surf workstation
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_workstation_file_seek(surf_resource_t workstation,
707 surf_file_t fd, sg_offset_t offset,
711 * @brief [brief description]
712 * @details [long description]
714 * @param link [description]
715 * @return [description]
717 XBT_PUBLIC(int) surf_network_link_is_shared(surf_cpp_resource_t link);
720 * @brief Get the bandwidth of a link in bytes per second
722 * @param link The surf link
723 * @return The bandwidth in bytes per second
725 XBT_PUBLIC(double) surf_network_link_get_bandwidth(surf_cpp_resource_t link);
728 * @brief Get the latency of a link in seconds
730 * @param link The surf link
731 * @return The latency in seconds
733 XBT_PUBLIC(double) surf_network_link_get_latency(surf_cpp_resource_t link);
736 * @brief Get the content of a storage
738 * @param resource The surf storage
739 * @return A xbt_dict_t with path as keys and size in bytes as values
741 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
744 * @brief Get the size in bytes of a storage
746 * @param resource The surf storage
747 * @return The size in bytes of the storage
749 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
752 * @brief Get the available size in bytes of a storage
754 * @param resource The surf storage
755 * @return The available size in bytes of the storage
757 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
760 * @brief Get the size in bytes of a storage
762 * @param resource The surf storage
763 * @return The used size in bytes of the storage
765 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
769 * @brief Get the data associated to the action
771 * @param action The surf action
772 * @return The data associated to the action
774 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
777 * @brief Set the data associated to the action
778 * @details [long description]
780 * @param action The surf action
781 * @param data The new data associated to the action
783 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
786 * @brief Unreference an action
788 * @param action The surf action
790 XBT_PUBLIC(void) surf_action_unref(surf_action_t action);
793 * @brief Get the start time of an action
795 * @param action The surf action
796 * @return The start time in seconds from the beginning of the simulation
798 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
801 * @brief Get the finish time of an action
803 * @param action The surf action
804 * @return The finish time in seconds from the beginning of the simulation
806 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
809 * @brief Get the remains amount of work to do of an action
811 * @param action The surf action
812 * @return The remains amount of work to do
814 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
817 * @brief Suspend an action
819 * @param action The surf action
821 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
824 * @brief Resume an action
826 * @param action The surf action
828 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
831 * @brief Cancel an action
833 * @param action The surf action
835 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
838 * @brief Set the priority of an action
839 * @details [long description]
841 * @param action The surf action
842 * @param priority The new priority [TODO]
844 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
847 * @brief Set the category of an action
848 * @details [long description]
850 * @param action The surf action
851 * @param category The new category of the action
853 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
856 * @brief Get the state of an action
858 * @param action The surf action
859 * @return The state of the action
861 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
864 * @brief Get the cost of an action
866 * @param action The surf action
867 * @return The cost of the action
869 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
872 * @brief [brief desrciption]
873 * @details [long description]
875 * @param action The surf cpu action
876 * @param cpu [description]
877 * @param mask [description]
879 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask);
882 * @brief [brief description]
883 * @details [long description]
885 * @param action The surf cpu action
886 * @param bound [description]
888 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
891 * @brief [brief description]
892 * @details [long description]
894 * @param action The surf network action
896 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
899 * @brief Get the file associated to a storage action
901 * @param action The surf storage action
902 * @return The file associated to a storage action
904 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
907 * @brief Get the result dictionary of an ls action
909 * @param action The surf storage action
910 * @return The dictionry listing a path
912 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
916 * @brief Get the host the storage is attached to
918 * @param resource The surf storage
919 * @return The host name
921 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
923 XBT_PUBLIC(surf_model_t) surf_resource_model(const void *host, int level);
927 /**************************************/
928 /* Implementations of model object */
929 /**************************************/
931 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
932 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
934 /** \ingroup SURF_models
935 * \brief The CPU model object for the physical machine layer
937 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
939 /** \ingroup SURF_models
940 * \brief The CPU model object for the virtual machine layer
942 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
945 /** \ingroup SURF_models
946 * \brief Initializes the CPU model with the model Cas01
948 * By default, this model uses the lazy optimization mechanism that
949 * relies on partial invalidation in LMM and a heap for lazy action update.
950 * You can change this behavior by setting the cpu/optim configuration
951 * variable to a different value.
953 * You shouldn't have to call it by yourself.
955 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
957 /** \ingroup SURF_models
958 * \brief Initializes the CPU model with trace integration [Deprecated]
960 * You shouldn't have to call it by yourself.
962 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
964 /** \ingroup SURF_models
965 * \brief The list of all available optimization modes (both for cpu and networks).
966 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
968 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
970 /** \ingroup SURF_plugins
971 * \brief The list of all available surf plugins
973 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
975 /** \ingroup SURF_models
976 * \brief The list of all available cpu model models
978 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
980 /**\brief create new host bypass the parser
985 /** \ingroup SURF_models
986 * \brief The network model
988 * When creating a new API on top on SURF, you shouldn't use the
989 * network model unless you know what you are doing. Only the workstation
990 * model should be accessed because depending on the platform model,
991 * the network model can be NULL.
993 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
995 /** \ingroup SURF_models
996 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
998 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
999 * based on the model 'LV08' and different correction factors depending on the communication
1000 * size (< 1KiB, < 64KiB, >= 64KiB).
1001 * See comments in the code for more information.
1003 * \see surf_workstation_model_init_SMPI()
1005 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
1007 /** \ingroup SURF_models
1008 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
1010 * This model impelments a variant of the contention model on Infinband networks based on
1011 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
1013 * \see surf_workstation_model_init_IB()
1015 XBT_PUBLIC(void) surf_network_model_init_IB(void);
1017 /** \ingroup SURF_models
1018 * \brief Initializes the platform with the network model 'LegrandVelho'
1020 * This model is proposed by Arnaud Legrand and Pedro Velho based on
1021 * the results obtained with the GTNets simulator for onelink and
1022 * dogbone sharing scenarios. See comments in the code for more information.
1024 * \see surf_workstation_model_init_LegrandVelho()
1026 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
1028 /** \ingroup SURF_models
1029 * \brief Initializes the platform with the network model 'Constant'
1031 * In this model, the communication time between two network cards is
1032 * constant, hence no need for a routing table. This is particularly
1033 * usefull when simulating huge distributed algorithms where
1034 * scalability is really an issue. This function is called in
1035 * conjunction with surf_workstation_model_init_compound.
1037 * \see surf_workstation_model_init_compound()
1039 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
1041 /** \ingroup SURF_models
1042 * \brief Initializes the platform with the network model CM02
1044 * You sould call this function by yourself only if you plan using
1045 * surf_workstation_model_init_compound.
1046 * See comments in the code for more information.
1048 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
1051 /** \ingroup SURF_models
1052 * \brief Initializes the platform with the network model GTNETS
1053 * \param filename XML platform file name
1055 * This function is called by surf_workstation_model_init_GTNETS
1056 * or by yourself only if you plan using surf_workstation_model_init_compound
1058 * \see surf_workstation_model_init_GTNETS()
1060 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
1064 /** \ingroup SURF_models
1065 * \brief Initializes the platform with the network model NS3
1066 * \param filename XML platform file name
1068 * This function is called by surf_workstation_model_init_NS3
1069 * or by yourself only if you plan using surf_workstation_model_init_compound
1071 * \see surf_workstation_model_init_NS3()
1073 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
1076 /** \ingroup SURF_models
1077 * \brief Initializes the platform with the network model Reno
1078 * \param filename XML platform file name
1080 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
1083 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1084 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1086 * Call this function only if you plan using surf_workstation_model_init_compound.
1089 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
1091 /** \ingroup SURF_models
1092 * \brief Initializes the platform with the network model Reno2
1093 * \param filename XML platform file name
1095 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
1098 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
1099 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1101 * Call this function only if you plan using surf_workstation_model_init_compound.
1104 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
1106 /** \ingroup SURF_models
1107 * \brief Initializes the platform with the network model Vegas
1108 * \param filename XML platform file name
1110 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
1111 * to the proportional fairness.
1114 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1115 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1117 * Call this function only if you plan using surf_workstation_model_init_compound.
1120 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
1122 /** \ingroup SURF_models
1123 * \brief The list of all available network model models
1125 XBT_PUBLIC_DATA(s_surf_model_description_t)
1126 surf_network_model_description[];
1128 /** \ingroup SURF_models
1129 * \brief The storage model
1131 XBT_PUBLIC(void) surf_storage_model_init_default(void);
1133 /** \ingroup SURF_models
1134 * \brief The list of all available storage modes.
1135 * This storage mode can be set using --cfg=storage/model:...
1137 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
1139 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
1141 /** \ingroup SURF_models
1142 * \brief The workstation model
1144 * Note that when you create an API on top of SURF,
1145 * the workstation model should be the only one you use
1146 * because depending on the platform model, the network model and the CPU model
1149 XBT_PUBLIC_DATA(surf_workstation_model_t) surf_workstation_model;
1151 /** \ingroup SURF_models
1152 * \brief The vm_workstation model
1154 * Note that when you create an API on top of SURF,
1155 * the vm_workstation model should be the only one you use
1156 * because depending on the platform model, the network model and the CPU model
1159 XBT_PUBLIC_DATA(surf_vm_workstation_model_t) surf_vm_workstation_model;
1161 /** \ingroup SURF_models
1162 * \brief Initializes the platform with a compound workstation model
1164 * This function should be called after a cpu_model and a
1165 * network_model have been set up.
1168 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
1170 /** \ingroup SURF_models
1171 * \brief Initializes the platform with the current best network and cpu models at hand
1173 * This platform model seperates the workstation model and the network model.
1174 * The workstation model will be initialized with the model compound, the network
1175 * model with the model LV08 (with cross traffic support) and the CPU model with
1177 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1180 XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
1182 /** \ingroup SURF_models
1183 * \brief Initializes the platform with the model KCCFLN05
1185 * With this model, only parallel tasks can be used. Resource sharing
1186 * is done by identifying bottlenecks and giving an equal share of
1187 * the model to each action.
1190 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
1192 /** \ingroup SURF_models
1193 * \brief The list of all available workstation model models
1195 XBT_PUBLIC_DATA(s_surf_model_description_t)
1196 surf_workstation_model_description[];
1198 /** \ingroup SURF_models
1199 * \brief Initializes the platform with the current best network and cpu models at hand
1201 * This platform model seperates the workstation model and the network model.
1202 * The workstation model will be initialized with the model compound, the network
1203 * model with the model LV08 (with cross traffic support) and the CPU model with
1205 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1208 XBT_PUBLIC(void) surf_vm_workstation_model_init_HL13(void);
1210 /** \ingroup SURF_models
1211 * \brief The list of all available vm workstation model models
1213 XBT_PUBLIC_DATA(s_surf_model_description_t)
1214 surf_vm_workstation_model_description[];
1216 /*******************************************/
1218 /** \ingroup SURF_models
1219 * \brief List of initialized models
1221 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
1222 XBT_PUBLIC_DATA(xbt_dynar_t) model_list_invoke;
1224 /** \ingroup SURF_simulation
1225 * \brief List of hosts that have juste restarted and whose autorestart process should be restarted.
1227 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
1229 /** \ingroup SURF_simulation
1230 * \brief List of hosts for which one want to be notified if they ever restart.
1232 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
1234 /*******************************************/
1235 /*** SURF Platform *************************/
1236 /*******************************************/
1237 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
1238 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
1239 XBT_PUBLIC_DATA(AS_t) surf_AS_get_by_name(const char * name);
1240 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
1241 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
1242 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
1243 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
1244 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
1245 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
1247 /*******************************************/
1248 /*** SURF Globals **************************/
1249 /*******************************************/
1251 /** \ingroup SURF_simulation
1252 * \brief Initialize SURF
1253 * \param argc argument number
1254 * \param argv arguments
1256 * This function has to be called to initialize the common
1257 * structures. Then you will have to create the environment by
1259 * e.g. surf_workstation_model_init_CM02()
1261 * \see surf_workstation_model_init_CM02(), surf_workstation_model_init_compound(), surf_exit()
1263 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
1265 /** \ingroup SURF_simulation
1266 * \brief Finish simulation initialization
1268 * This function must be called before the first call to surf_solve()
1270 XBT_PUBLIC(void) surf_presolve(void);
1272 /** \ingroup SURF_simulation
1273 * \brief Performs a part of the simulation
1274 * \param max_date Maximum date to update the simulation to, or -1
1275 * \return the elapsed time, or -1.0 if no event could be executed
1277 * This function execute all possible events, update the action states
1278 * and returns the time elapsed.
1279 * When you call execute or communicate on a model, the corresponding actions
1280 * are not executed immediately but only when you call surf_solve.
1281 * Note that the returned elapsed time can be zero.
1283 XBT_PUBLIC(double) surf_solve(double max_date);
1285 /** \ingroup SURF_simulation
1286 * \brief Return the current time
1288 * Return the current time in millisecond.
1290 XBT_PUBLIC(double) surf_get_clock(void);
1292 /** \ingroup SURF_simulation
1299 XBT_PUBLIC(void) surf_exit(void);
1301 /* Prototypes of the functions that handle the properties */
1302 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
1304 /* The same for model_prop set*/
1305 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
1307 /* surf parse file related (public because called from a test suite) */
1308 XBT_PUBLIC(void) parse_platform_file(const char *file);
1310 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
1311 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
1312 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
1313 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
1314 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
1315 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
1316 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
1319 XBT_PUBLIC(double) get_cpu_power(const char *power);
1321 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
1323 int surf_get_nthreads(void);
1324 void surf_set_nthreads(int nthreads);
1327 * Returns the initial path. On Windows the initial path is
1328 * the current directory for the current process in the other
1329 * case the function returns "./" that represents the current
1330 * directory on Unix/Linux platforms.
1332 const char *__surf_get_initial_path(void);
1334 /********** Tracing **********/
1335 /* from surf_instr.c */
1336 void TRACE_surf_action(surf_action_t surf_action, const char *category);
1337 void TRACE_surf_alloc(void);
1338 void TRACE_surf_release(void);
1340 /* instr_routing.c */
1341 void instr_routing_define_callbacks (void);
1342 void instr_new_variable_type (const char *new_typename, const char *color);
1343 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
1344 void instr_new_user_state_type (const char *father_type, const char *new_typename);
1345 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
1346 int instr_platform_traced (void);
1347 xbt_graph_t instr_routing_platform_graph (void);
1348 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1351 #endif /* _SURF_SURF_H */