1 /* Copyright (c) 2004-2013. 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_models
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_actions
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;
114 typedef ActionLmm *surf_action_lmm_t;
115 typedef StorageActionLmm *surf_storage_action_lmm_t;
118 typedef RoutingEdge *routing_edge_t;
119 typedef RoutingPlatf *routing_platf_t;
121 typedef struct surf_file *surf_file_t;
123 XBT_PUBLIC(e_surf_network_element_type_t)
124 routing_get_network_element_type(const char* name);
126 /** @Brief Specify that we use that action */
127 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
129 /** @brief Creates a new action.
131 * @param size The size is the one of the subtype you want to create
132 * @param cost initial value
133 * @param model to which model we should attach this action
134 * @param failed whether we should start this action in failed mode
136 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
137 surf_model_t model, int failed);
139 /** \brief Resource model description
141 typedef struct surf_model_description {
143 const char *description;
144 void_f_void_t model_init_preparse;
145 } s_surf_model_description_t, *surf_model_description_t;
147 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
149 XBT_PUBLIC(void) model_help(const char *category,
150 s_surf_model_description_t * table);
152 /** @ingroup SURF_interface
153 * @brief Action states
160 SURF_ACTION_READY = 0, /**< Ready */
161 SURF_ACTION_RUNNING, /**< Running */
162 SURF_ACTION_FAILED, /**< Task Failure */
163 SURF_ACTION_DONE, /**< Completed */
164 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
165 SURF_ACTION_NOT_IN_THE_SYSTEM
166 /**< Not in the system anymore. Why did you ask ? */
167 } e_surf_action_state_t;
169 /** @ingroup SURF_vm_interface
173 /* FIXME: Where should the VM state be defined? */
175 SURF_VM_STATE_CREATED, /**< created, but not yet started */
177 SURF_VM_STATE_RUNNING,
178 SURF_VM_STATE_MIGRATING,
180 SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
182 SURF_VM_STATE_SAVING, /**< Save/restore involves disk I/O, so there should be transition states. */
184 SURF_VM_STATE_RESTORING,
188 /***************************/
189 /* Generic model object */
190 /***************************/
191 //FIXME:REMOVE typedef struct s_routing_platf s_routing_platf_t, *routing_platf_t;
192 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
194 static inline void *surf_cpu_resource_priv(const void *host) {
195 return xbt_lib_get_level((xbt_dictelm_t)host, SURF_CPU_LEVEL);
197 static inline void *surf_workstation_resource_priv(const void *host){
198 return (void*)xbt_lib_get_level((xbt_dictelm_t)host, SURF_WKS_LEVEL);
200 static inline void *surf_storage_resource_priv(const void *storage){
201 return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
204 static inline void *surf_cpu_resource_by_name(const char *name) {
205 return xbt_lib_get_elm_or_null(host_lib, name);
207 static inline void *surf_workstation_resource_by_name(const char *name){
208 return xbt_lib_get_elm_or_null(host_lib, name);
210 static inline void *surf_storage_resource_by_name(const char *name){
211 return xbt_lib_get_elm_or_null(storage_lib, name);
215 XBT_PUBLIC(char *) surf_routing_edge_name(sg_routing_edge_t edge);
216 XBT_PUBLIC(void *) surf_as_cluster_get_backbone(AS_t as);
217 XBT_PUBLIC(void) surf_as_cluster_set_backbone(AS_t as, void* backbone);
219 /** @{ @ingroup SURF_c_bindings */
222 * @brief Get the name of a surf model
224 * @param model A model
225 * @return The name of the model
227 XBT_PUBLIC(const char *) surf_model_name(surf_model_t model);
230 * @brief Pop an action from the done actions set
232 * @param model The model from which the action is extracted
233 * @return An action in done state
235 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
238 * @brief Pop an action from the failed actions set
240 * @param model The model from which the action is extracted
241 * @return An action in failed state
243 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
246 * @brief Pop an action from the ready actions set
248 * @param model The model from which the action is extracted
249 * @return An action in ready state
251 XBT_PUBLIC(surf_action_t) surf_model_extract_ready_action_set(surf_model_t model);
254 * @brief Pop an action from the running actions set
256 * @param model The model from which the action is extracted
257 * @return An action in running state
259 XBT_PUBLIC(surf_action_t) surf_model_extract_running_action_set(surf_model_t model);
262 * @brief Get the size of the running action set of a model
264 * @param model The model
265 * @return The size of the running action set
267 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
270 * @brief Execute a parallel task
271 * @details [long description]
273 * @param model The model which handle the parallelisation
274 * @param workstation_nb The number of workstations
275 * @param workstation_list The list of workstations on which the task is executed
276 * @param computation_amount The processing amount (in flop) needed to process
277 * @param communication_amount The amount of data (in bytes) needed to transfer
278 * @param rate [description]
279 * @return The action corresponding to the parallele execution task
281 XBT_PUBLIC(surf_action_t) surf_workstation_model_execute_parallel_task(surf_workstation_model_t model,
283 void **workstation_list,
284 double *computation_amount,
285 double *communication_amount,
289 * @brief Create a communication between two hosts
291 * @param model The model which handle the communication
292 * @param src The source host
293 * @param dst The destination host
294 * @param size The amount of data (in bytes) needed to transfer
295 * @param rate [description]
296 * @return The action corresponding to the communication
298 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);
301 * @brief Get the route between two hosts
302 * @details [long description]
304 * @param model The model which handle the routes
305 * @param src The source host
306 * @param dst The destination host
307 * @return The list of [TODO] from the source to the host
309 XBT_PUBLIC(xbt_dynar_t) surf_workstation_model_get_route(surf_workstation_model_t model, surf_resource_t src, surf_resource_t dst);
312 * @brief Create a new VM on the specified host
314 * @param name The name of the workstation
315 * @param ind_phys_host The host on which the VM is created
317 XBT_PUBLIC(void) surf_vm_workstation_model_create(const char *name, surf_resource_t ind_phys_host);
320 * @brief Create a communication between two routing edges [TODO]
321 * @details [long description]
323 * @param model The model which handle the communication
324 * @param src The source host
325 * @param dst The destination host
326 * @param size The amount of data (in bytes) needed to transfer
327 * @param rate [description]
328 * @return The action corresponding to the communication
330 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);
333 * @brief Get the name of a surf resource (cpu, workstation, network, …)
335 * @param resource The surf resource
336 * @return The name of the surf resource
338 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
341 * @brief Get the properties of a surf resource (cpu, workstation, network, …)
343 * @param resource The surf resource
344 * @return The properties of the surf resource
346 XBT_PUBLIC(xbt_dict_t) surf_resource_get_properties(surf_cpp_resource_t resource);
349 * @brief Get the state of a surf resource (cpu, workstation, network, …)
351 * @param resource The surf resource
352 * @return The state of the surf resource
354 XBT_PUBLIC(e_surf_resource_state_t) surf_resource_get_state(surf_cpp_resource_t resource);
357 * @brief Set the state of a surf resource (cpu, workstation, 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);
365 * @brief Get the speed of the cpu associtated to a workstation
367 * @param resource The surf workstation
368 * @param load [description]
370 * @return [description]
372 XBT_PUBLIC(double) surf_workstation_get_speed(surf_resource_t resource, double load);
375 * @brief Get the available speed of cpu associtated to a workstation
377 * @param resource The surf workstation
378 * @return [description]
380 XBT_PUBLIC(double) surf_workstation_get_available_speed(surf_resource_t resource);
383 * @brief Get the number of cores of the cpu associated to a workstation
385 * @param resource The surf workstation
386 * @return The number of cores
388 XBT_PUBLIC(int) surf_workstation_get_core(surf_resource_t resource);
391 * @brief Execute some quantity of computation
393 * @param resource The surf workstation
394 * @param size The value of the processing amount (in flop) needed to process
396 * @return The surf action corresponding to the processing
398 XBT_PUBLIC(surf_action_t) surf_workstation_execute(surf_resource_t resource, double size);
401 * @brief Make the workstation sleep
403 * @param resource The surf workstation
404 * @param duration The number of seconds to sleep
405 * @return The surf action corresponding to the sleep
407 XBT_PUBLIC(surf_action_t) surf_workstation_sleep(surf_resource_t resource, double duration);
410 * @brief Open a file on a workstation
412 * @param workstation The surf workstation
413 * @param mount The mount point
414 * @param path The path to the file
415 * @return The surf action corresponding to the openning
417 XBT_PUBLIC(surf_action_t) surf_workstation_open(surf_resource_t workstation, const char* mount, const char* path);
420 * @brief Close a file descriptor on a workstation
422 * @param workstation The surf workstation
423 * @param fd The file descriptor
425 * @return The surf action corresponding to the closing
427 XBT_PUBLIC(surf_action_t) surf_workstation_close(surf_resource_t workstation, surf_file_t fd);
432 * @param resource The surf workstation
433 * @param fd The file descriptor to read
434 * @param size The size in bytes to read
435 * @return The surf action corresponding to the reading
437 XBT_PUBLIC(surf_action_t) surf_workstation_read(surf_resource_t resource, surf_file_t fd, sg_size_t size);
440 * @brief Write a file
442 * @param resource The surf workstation
443 * @param fd The file descriptor to write
444 * @param size The size in bytes to write
445 * @return The surf action corresponding to the writing
447 XBT_PUBLIC(surf_action_t) surf_workstation_write(surf_resource_t resource, surf_file_t fd, sg_size_t size);
450 * @brief Get the informations of a file descriptor
451 * @details The returned xbt_dynar_t contains:
452 * - the size of the file,
454 * - the storage name,
455 * - the storage typeId,
456 * - the storage content type
458 * @param resource The surf workstation
459 * @param fd The file descriptor
460 * @return An xbt_dynar_t with the file informations
462 XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_info(surf_resource_t resource, surf_file_t fd);
465 * @brief Get the available space of the storage at the mount point
467 * @param resource The surf workstation
468 * @param name The mount point
469 * @return The amount of availble space in bytes
471 XBT_PUBLIC(sg_size_t) surf_workstation_get_free_size(surf_resource_t resource, const char* name);
474 * @brief Get the used space of the storage at the mount point
476 * @param resource The surf workstation
477 * @param name The mount point
478 * @return The amount of used space in bytes
480 XBT_PUBLIC(sg_size_t) surf_workstation_get_used_size(surf_resource_t resource, const char* name);
483 * @brief Get the VMs hosted on the workstation
485 * @param resource The surf workstation
486 * @return The list of VMs on the workstation
488 XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_vms(surf_resource_t resource);
491 * @brief [brief description]
492 * @details [long description]
494 * @param resource [description]
495 * @param params [description]
497 XBT_PUBLIC(void) surf_workstation_get_params(surf_resource_t resource, ws_params_t params);
500 * @brief [brief description]
501 * @details [long description]
503 * @param resource [description]
504 * @param params [description]
506 XBT_PUBLIC(void) surf_workstation_set_params(surf_resource_t resource, ws_params_t params);
509 * @brief Destroy a Workstation VM
511 * @param resource The surf workstation vm
513 XBT_PUBLIC(void) surf_vm_workstation_destroy(surf_resource_t resource);
516 * @brief Suspend a Workstation VM
518 * @param resource The surf workstation vm
520 XBT_PUBLIC(void) surf_vm_workstation_suspend(surf_resource_t resource);
523 * @brief Resume a Workstation VM
525 * @param resource The surf workstation vm
527 XBT_PUBLIC(void) surf_vm_workstation_resume(surf_resource_t resource);
530 * @brief Save the Workstation VM (Not yet implemented)
532 * @param resource The surf workstation vm
534 XBT_PUBLIC(void) surf_vm_workstation_save(surf_resource_t resource);
537 * @brief Restore the Workstation VM (Not yet implemented)
539 * @param resource The surf workstation vm
541 XBT_PUBLIC(void) surf_vm_workstation_restore(surf_resource_t resource);
544 * @brief Migrate the VM to the destination host
546 * @param resource The surf workstation vm
547 * @param ind_vm_ws_dest The destination host
549 XBT_PUBLIC(void) surf_vm_workstation_migrate(surf_resource_t resource, surf_resource_t ind_vm_ws_dest);
552 * @brief Get the physical machine hosting the VM
554 * @param resource The surf workstation vm
555 * @return The physical machine hosting the VM
557 XBT_PUBLIC(surf_resource_t) surf_vm_workstation_get_pm(surf_resource_t resource);
560 * @brief [brief description]
561 * @details [long description]
563 * @param resource [description]
564 * @param bound [description]
566 XBT_PUBLIC(void) surf_vm_workstation_set_bound(surf_resource_t resource, double bound);
569 * @brief [brief description]
570 * @details [long description]
572 * @param resource [description]
573 * @param cpu [description]
574 * @param long [description]
576 XBT_PUBLIC(void) surf_vm_workstation_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask);
579 * @brief Execute some quantity of computation
581 * @param cpu The surf cpu
582 * @param size The value of the processing amount (in flop) needed to process
583 * @return The surf action corresponding to the processing
585 XBT_PUBLIC(surf_action_t) surf_cpu_execute(surf_resource_t cpu, double size);
588 * @brief Make the cpu sleep for duration (in seconds)
589 * @details [long description]
591 * @param cpu The surf cpu
592 * @param duration The number of seconds to sleep
593 * @return The surf action corresponding to the sleeping
595 XBT_PUBLIC(surf_action_t) surf_cpu_sleep(surf_resource_t cpu, double duration);
598 * @brief Get the workstation power peak
599 * @details [long description]
601 * @param resource The surf workstation
602 * @return The power peak
604 XBT_PUBLIC(double) surf_workstation_get_current_power_peak(surf_resource_t host);
607 * @brief [brief description]
608 * @details [long description]
610 * @param resource [description]
611 * @param pstate_index [description]
613 * @return [description]
615 XBT_PUBLIC(double) surf_workstation_get_power_peak_at(surf_resource_t host, int pstate_index);
618 * @brief [brief description]
619 * @details [long description]
621 * @param resource [description]
622 * @return [description]
624 XBT_PUBLIC(int) surf_workstation_get_nb_pstates(surf_resource_t host);
627 * @brief [brief description]
628 * @details [long description]
630 * @param resource [description]
631 * @param pstate_index [description]
633 XBT_PUBLIC(void) surf_workstation_set_power_peak_at(surf_resource_t host, int pstate_index);
636 * @brief Get the consumed energy (in joules) of a workstation
638 * @param resource The surf workstation
639 * @return The consumed energy
641 XBT_PUBLIC(double) surf_workstation_get_consumed_energy(surf_resource_t host);
644 * @brief Get the list of storages of a workstation
646 * @param workstation The surf workstation
647 * @return Dictionary of mount point, Storage
649 XBT_PUBLIC(xbt_dict_t) surf_workstation_get_storage_list(surf_resource_t workstation);
652 * @brief Unlink a file descriptor
654 * @param workstation The surf workstation
655 * @param fd The file descriptor
657 * @return 0 if failed to unlink, 1 otherwise
659 XBT_PUBLIC(int) surf_workstation_unlink(surf_resource_t workstation, surf_file_t fd);
662 * @brief List directory contents of a path
663 * @details [long description]
665 * @param workstation The surf workstation
666 * @param mount The mount point
667 * @param path The path to the directory
668 * @return The surf action corresponding to the ls action
670 XBT_PUBLIC(surf_action_t) surf_workstation_ls(surf_resource_t workstation, const char* mount, const char *path);
673 * @brief Get the size of a file on a workstation
675 * @param workstation The surf workstation
676 * @param fd The file descriptor
678 * @return The size in bytes of the file
680 XBT_PUBLIC(size_t) surf_workstation_get_size(surf_resource_t workstation, surf_file_t fd);
683 * @brief Get the current position of the file descriptor
685 * @param workstation The surf workstation
686 * @param fd The file descriptor
687 * @return The current position of the file descriptor
689 XBT_PUBLIC(size_t) surf_workstation_file_tell(surf_resource_t workstation, surf_file_t fd);
692 * @brief Set the position indictator assiociated with the file descriptor to a new position
693 * @details [long description]
695 * @param workstation The surf workstation
696 * @param fd The file descriptor
697 * @param offset The offset from the origin
698 * @param origin Position used as a reference for the offset
699 * - SEEK_SET: beginning of the file
700 * - SEEK_CUR: current position indicator
701 * - SEEK_END: end of the file
702 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
704 XBT_PUBLIC(int) surf_workstation_file_seek(surf_resource_t workstation, surf_file_t fd, sg_size_t offset, int origin);
707 * @brief [brief description]
708 * @details [long description]
710 * @param link [description]
711 * @return [description]
713 XBT_PUBLIC(int) surf_network_link_is_shared(surf_cpp_resource_t link);
716 * @brief Get the bandwidth of a link in bytes per second
718 * @param link The surf link
719 * @return The bandwidth in bytes per second
721 XBT_PUBLIC(double) surf_network_link_get_bandwidth(surf_cpp_resource_t link);
724 * @brief Get the latency of a link in seconds
726 * @param link The surf link
727 * @return The latency in seconds
729 XBT_PUBLIC(double) surf_network_link_get_latency(surf_cpp_resource_t link);
732 * @brief Get the content of a storage
734 * @param resource The surf storage
735 * @return A xbt_dict_t with path as keys and size in bytes as values
737 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
740 * @brief Get the size in bytes of a storage
742 * @param resource The surf storage
743 * @return The size in bytes of the storage
745 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
748 * @brief Rename a path
750 * @param resource The surf storage
751 * @param src The old path
752 * @param dest The new path
754 XBT_PUBLIC(void) surf_storage_rename(surf_resource_t resource, const char* src, const char* dest);
757 * @brief Get the data associated to the action
759 * @param action The surf action
760 * @return The data associated to the action
762 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
765 * @brief Set the data associated to the action
766 * @details [long description]
768 * @param action The surf action
769 * @param data The new data associated to the action
771 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
774 * @brief Unreference an action
776 * @param action The surf action
778 XBT_PUBLIC(void) surf_action_unref(surf_action_t action);
781 * @brief Get the start time of an action
783 * @param action The surf action
784 * @return The start time in seconds from the beginning of the simulation
786 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
789 * @brief Get the finish time of an action
791 * @param action The surf action
792 * @return The finish time in seconds from the beginning of the simulation
794 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
797 * @brief Get the remains amount of work to do of an action
799 * @param action The surf action
800 * @return The remains amount of work to do
802 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
805 * @brief Suspend an action
807 * @param action The surf action
809 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
812 * @brief Resume an action
814 * @param action The surf action
816 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
819 * @brief Cancel an action
821 * @param action The surf action
823 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
826 * @brief Set the priority of an action
827 * @details [long description]
829 * @param action The surf action
830 * @param priority The new priority [TODO]
832 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
835 * @brief Set the category of an action
836 * @details [long description]
838 * @param action The surf action
839 * @param category The new category of the action
841 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
844 * @brief Get the state of an action
846 * @param action The surf action
847 * @return The state of the action
849 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
852 * @brief Get the cost of an action
854 * @param action The surf action
855 * @return The cost of the action
857 XBT_PUBLIC(int) surf_action_get_cost(surf_action_t action);
860 * @brief [brief desrciption]
861 * @details [long description]
863 * @param action The surf cpu action
864 * @param cpu [description]
865 * @param long [description]
867 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask);
870 * @brief [brief description]
871 * @details [long description]
873 * @param action The surf cpu action
874 * @param bound [description]
876 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
879 * @brief Get the file associated to a storage action
881 * @param action The surf storage action
882 * @return The file associated to a storage action
884 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
887 * @brief Get the result dictionary of an ls action
889 * @param action The surf storage action
890 * @return The dictionry listing a path
892 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
894 XBT_PUBLIC(surf_model_t) surf_resource_model(const void *host, int level);
898 /**************************************/
899 /* Implementations of model object */
900 /**************************************/
902 /** \ingroup SURF_models
903 * \brief The CPU model object for the physical machine layer
905 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
907 /** \ingroup SURF_models
908 * \brief The CPU model object for the virtual machine layer
910 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
913 /** \ingroup SURF_models
914 * \brief Initializes the CPU model with the model Cas01
916 * By default, this model uses the lazy optimization mechanism that
917 * relies on partial invalidation in LMM and a heap for lazy action update.
918 * You can change this behavior by setting the cpu/optim configuration
919 * variable to a different value.
921 * You shouldn't have to call it by yourself.
923 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
925 /** \ingroup SURF_models
926 * \brief Initializes the CPU model with trace integration [Deprecated]
928 * You shouldn't have to call it by yourself.
930 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
932 /** \ingroup SURF_models
933 * \brief The list of all available optimization modes (both for cpu and networks).
934 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
936 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
938 /** \ingroup SURF_plugins
939 * \brief The list of all available surf plugins
941 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
943 /** \ingroup SURF_models
944 * \brief The list of all available cpu model models
946 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
948 /**\brief create new host bypass the parser
953 /** \ingroup SURF_models
954 * \brief The network model
956 * When creating a new API on top on SURF, you shouldn't use the
957 * network model unless you know what you are doing. Only the workstation
958 * model should be accessed because depending on the platform model,
959 * the network model can be NULL.
961 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
963 /** \ingroup SURF_models
964 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
966 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
967 * based on the model 'LV08' and different correction factors depending on the communication
968 * size (< 1KiB, < 64KiB, >= 64KiB).
969 * See comments in the code for more information.
971 * \see surf_workstation_model_init_SMPI()
973 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
975 /** \ingroup SURF_models
976 * \brief Initializes the platform with the network model 'LegrandVelho'
978 * This model is proposed by Arnaud Legrand and Pedro Velho based on
979 * the results obtained with the GTNets simulator for onelink and
980 * dogbone sharing scenarios. See comments in the code for more information.
982 * \see surf_workstation_model_init_LegrandVelho()
984 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
986 /** \ingroup SURF_models
987 * \brief Initializes the platform with the network model 'Constant'
989 * In this model, the communication time between two network cards is
990 * constant, hence no need for a routing table. This is particularly
991 * usefull when simulating huge distributed algorithms where
992 * scalability is really an issue. This function is called in
993 * conjunction with surf_workstation_model_init_compound.
995 * \see surf_workstation_model_init_compound()
997 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
999 /** \ingroup SURF_models
1000 * \brief Initializes the platform with the network model CM02
1002 * You sould call this function by yourself only if you plan using
1003 * surf_workstation_model_init_compound.
1004 * See comments in the code for more information.
1006 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
1009 /** \ingroup SURF_models
1010 * \brief Initializes the platform with the network model GTNETS
1011 * \param filename XML platform file name
1013 * This function is called by surf_workstation_model_init_GTNETS
1014 * or by yourself only if you plan using surf_workstation_model_init_compound
1016 * \see surf_workstation_model_init_GTNETS()
1018 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
1022 /** \ingroup SURF_models
1023 * \brief Initializes the platform with the network model NS3
1024 * \param filename XML platform file name
1026 * This function is called by surf_workstation_model_init_NS3
1027 * or by yourself only if you plan using surf_workstation_model_init_compound
1029 * \see surf_workstation_model_init_NS3()
1031 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
1034 /** \ingroup SURF_models
1035 * \brief Initializes the platform with the network model Reno
1036 * \param filename XML platform file name
1038 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
1041 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1042 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1044 * Call this function only if you plan using surf_workstation_model_init_compound.
1047 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
1049 /** \ingroup SURF_models
1050 * \brief Initializes the platform with the network model Reno2
1051 * \param filename XML platform file name
1053 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
1056 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
1057 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1059 * Call this function only if you plan using surf_workstation_model_init_compound.
1062 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
1064 /** \ingroup SURF_models
1065 * \brief Initializes the platform with the network model Vegas
1066 * \param filename XML platform file name
1068 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
1069 * to the proportional fairness.
1072 * [LOW03] 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_workstation_model_init_compound.
1078 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
1080 /** \ingroup SURF_models
1081 * \brief The list of all available network model models
1083 XBT_PUBLIC_DATA(s_surf_model_description_t)
1084 surf_network_model_description[];
1086 /** \ingroup SURF_models
1087 * \brief The storage model
1089 XBT_PUBLIC(void) surf_storage_model_init_default(void);
1091 /** \ingroup SURF_models
1092 * \brief The list of all available storage modes.
1093 * This storage mode can be set using --cfg=storage/model:...
1095 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
1097 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
1099 /** \ingroup SURF_models
1100 * \brief The workstation model
1102 * Note that when you create an API on top of SURF,
1103 * the workstation model should be the only one you use
1104 * because depending on the platform model, the network model and the CPU model
1107 XBT_PUBLIC_DATA(surf_workstation_model_t) surf_workstation_model;
1109 /** \ingroup SURF_models
1110 * \brief The vm_workstation model
1112 * Note that when you create an API on top of SURF,
1113 * the vm_workstation model should be the only one you use
1114 * because depending on the platform model, the network model and the CPU model
1117 XBT_PUBLIC_DATA(surf_vm_workstation_model_t) surf_vm_workstation_model;
1119 /** \ingroup SURF_models
1120 * \brief Initializes the platform with a compound workstation model
1122 * This function should be called after a cpu_model and a
1123 * network_model have been set up.
1126 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
1128 /** \ingroup SURF_models
1129 * \brief Initializes the platform with the current best network and cpu models at hand
1131 * This platform model seperates the workstation model and the network model.
1132 * The workstation model will be initialized with the model compound, the network
1133 * model with the model LV08 (with cross traffic support) and the CPU model with
1135 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1138 XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
1140 /** \ingroup SURF_models
1141 * \brief Initializes the platform with the model KCCFLN05
1143 * With this model, only parallel tasks can be used. Resource sharing
1144 * is done by identifying bottlenecks and giving an equal share of
1145 * the model to each action.
1148 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
1150 /** \ingroup SURF_models
1151 * \brief The list of all available workstation model models
1153 XBT_PUBLIC_DATA(s_surf_model_description_t)
1154 surf_workstation_model_description[];
1156 /** \ingroup SURF_models
1157 * \brief Initializes the platform with the current best network and cpu models at hand
1159 * This platform model seperates the workstation model and the network model.
1160 * The workstation model will be initialized with the model compound, the network
1161 * model with the model LV08 (with cross traffic support) and the CPU model with
1163 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1166 XBT_PUBLIC(void) surf_vm_workstation_model_init_current_default(void);
1168 /** \ingroup SURF_models
1169 * \brief The list of all available vm workstation model models
1171 XBT_PUBLIC_DATA(s_surf_model_description_t)
1172 surf_vm_workstation_model_description[];
1174 /*******************************************/
1176 /** \ingroup SURF_models
1177 * \brief List of initialized models
1179 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
1180 XBT_PUBLIC_DATA(xbt_dynar_t) model_list_invoke;
1182 /** \ingroup SURF_simulation
1183 * \brief List of hosts that have juste restarted and whose autorestart process should be restarted.
1185 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
1187 /** \ingroup SURF_simulation
1188 * \brief List of hosts for which one want to be notified if they ever restart.
1190 XBT_PUBLIC(xbt_dict_t) watched_hosts_lib;
1192 /*******************************************/
1193 /*** SURF Platform *************************/
1194 /*******************************************/
1195 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
1196 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
1197 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
1198 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
1199 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
1200 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
1201 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
1202 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
1204 /*******************************************/
1205 /*** SURF Globals **************************/
1206 /*******************************************/
1208 /** \ingroup SURF_simulation
1209 * \brief Initialize SURF
1210 * \param argc argument number
1211 * \param argv arguments
1213 * This function has to be called to initialize the common
1214 * structures. Then you will have to create the environment by
1216 * e.g. surf_workstation_model_init_CM02()
1218 * \see surf_workstation_model_init_CM02(), surf_workstation_model_init_compound(), surf_exit()
1220 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
1222 /** \ingroup SURF_simulation
1223 * \brief Finish simulation initialization
1225 * This function must be called before the first call to surf_solve()
1227 XBT_PUBLIC(void) surf_presolve(void);
1229 /** \ingroup SURF_simulation
1230 * \brief Performs a part of the simulation
1231 * \param max_date Maximum date to update the simulation to, or -1
1232 * \return the elapsed time, or -1.0 if no event could be executed
1234 * This function execute all possible events, update the action states
1235 * and returns the time elapsed.
1236 * When you call execute or communicate on a model, the corresponding actions
1237 * are not executed immediately but only when you call surf_solve.
1238 * Note that the returned elapsed time can be zero.
1240 XBT_PUBLIC(double) surf_solve(double max_date);
1242 /** \ingroup SURF_simulation
1243 * \brief Return the current time
1245 * Return the current time in millisecond.
1247 XBT_PUBLIC(double) surf_get_clock(void);
1249 /** \ingroup SURF_simulation
1256 XBT_PUBLIC(void) surf_exit(void);
1258 /* Prototypes of the functions that handle the properties */
1259 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
1261 /* surf parse file related (public because called from a test suite) */
1262 XBT_PUBLIC(void) parse_platform_file(const char *file);
1264 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
1265 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
1266 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
1267 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
1268 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
1269 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
1270 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
1273 XBT_PUBLIC(double) get_cpu_power(const char *power);
1275 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
1277 int surf_get_nthreads(void);
1278 void surf_set_nthreads(int nthreads);
1281 * Returns the initial path. On Windows the initial path is
1282 * the current directory for the current process in the other
1283 * case the function returns "./" that represents the current
1284 * directory on Unix/Linux platforms.
1286 const char *__surf_get_initial_path(void);
1288 /********** Tracing **********/
1289 /* from surf_instr.c */
1290 void TRACE_surf_action(surf_action_t surf_action, const char *category);
1291 void TRACE_surf_alloc(void);
1292 void TRACE_surf_release(void);
1294 /* instr_routing.c */
1295 void instr_routing_define_callbacks (void);
1296 void instr_new_variable_type (const char *new_typename, const char *color);
1297 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
1298 void instr_new_user_state_type (const char *father_type, const char *new_typename);
1299 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
1300 int instr_platform_traced (void);
1301 xbt_graph_t instr_routing_platform_graph (void);
1302 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1305 #endif /* _SURF_SURF_H */