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_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 /***************************/
192 //FIXME:REMOVE typedef struct s_routing_platf s_routing_platf_t, *routing_platf_t;
193 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
195 static inline void *surf_cpu_resource_priv(const void *host) {
196 return xbt_lib_get_level((xbt_dictelm_t)host, SURF_CPU_LEVEL);
198 static inline void *surf_workstation_resource_priv(const void *host){
199 return (void*)xbt_lib_get_level((xbt_dictelm_t)host, SURF_WKS_LEVEL);
201 static inline void *surf_storage_resource_priv(const void *storage){
202 return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
205 static inline void *surf_cpu_resource_by_name(const char *name) {
206 return xbt_lib_get_elm_or_null(host_lib, name);
208 static inline void *surf_workstation_resource_by_name(const char *name){
209 return xbt_lib_get_elm_or_null(host_lib, name);
211 static inline void *surf_storage_resource_by_name(const char *name){
212 return xbt_lib_get_elm_or_null(storage_lib, name);
216 XBT_PUBLIC(char *) surf_routing_edge_name(sg_routing_edge_t edge);
217 XBT_PUBLIC(void *) surf_as_cluster_get_backbone(AS_t as);
218 XBT_PUBLIC(void) surf_as_cluster_set_backbone(AS_t as, void* backbone);
220 /** @{ @ingroup SURF_c_bindings */
223 * @brief Get the name of a surf model
225 * @param model A model
226 * @return The name of the model
228 XBT_PUBLIC(const char *) surf_model_name(surf_model_t model);
231 * @brief Pop an action from the done actions set
233 * @param model The model from which the action is extracted
234 * @return An action in done state
236 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
239 * @brief Pop an action from the failed actions set
241 * @param model The model from which the action is extracted
242 * @return An action in failed state
244 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
247 * @brief Pop an action from the ready actions set
249 * @param model The model from which the action is extracted
250 * @return An action in ready state
252 XBT_PUBLIC(surf_action_t) surf_model_extract_ready_action_set(surf_model_t model);
255 * @brief Pop an action from the running actions set
257 * @param model The model from which the action is extracted
258 * @return An action in running state
260 XBT_PUBLIC(surf_action_t) surf_model_extract_running_action_set(surf_model_t model);
263 * @brief Get the size of the running action set of a model
265 * @param model The model
266 * @return The size of the running action set
268 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
271 * @brief Execute a parallel task
272 * @details [long description]
274 * @param model The model which handle the parallelisation
275 * @param workstation_nb The number of workstations
276 * @param workstation_list The list of workstations on which the task is executed
277 * @param computation_amount The processing amount (in flop) needed to process
278 * @param communication_amount The amount of data (in bytes) needed to transfer
279 * @param rate [description]
280 * @return The action corresponding to the parallele execution task
282 XBT_PUBLIC(surf_action_t) surf_workstation_model_execute_parallel_task(surf_workstation_model_t model,
284 void **workstation_list,
285 double *computation_amount,
286 double *communication_amount,
290 * @brief Create a communication between two hosts
292 * @param model The model which handle the communication
293 * @param src The source host
294 * @param dst The destination host
295 * @param size The amount of data (in bytes) needed to transfer
296 * @param rate [description]
297 * @return The action corresponding to the communication
299 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);
302 * @brief Get the route between two hosts
303 * @details [long description]
305 * @param model The model which handle the routes
306 * @param src The source host
307 * @param dst The destination host
308 * @return The list of [TODO] from the source to the host
310 XBT_PUBLIC(xbt_dynar_t) surf_workstation_model_get_route(surf_workstation_model_t model, surf_resource_t src, surf_resource_t dst);
313 * @brief Create a new VM on the specified host
315 * @param name The name of the workstation
316 * @param ind_phys_host The host on which the VM is created
318 XBT_PUBLIC(void) surf_vm_workstation_model_create(const char *name, surf_resource_t ind_phys_host);
321 * @brief Create a communication between two routing edges [TODO]
322 * @details [long description]
324 * @param model The model which handle the communication
325 * @param src The source host
326 * @param dst The destination host
327 * @param size The amount of data (in bytes) needed to transfer
328 * @param rate [description]
329 * @return The action corresponding to the communication
331 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);
334 * @brief Get the name of a surf resource (cpu, workstation, network, …)
336 * @param resource The surf resource
337 * @return The name of the surf resource
339 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
342 * @brief Get the properties of a surf resource (cpu, workstation, network, …)
344 * @param resource The surf resource
345 * @return The properties of the surf resource
347 XBT_PUBLIC(xbt_dict_t) surf_resource_get_properties(surf_cpp_resource_t resource);
350 * @brief Get the state of a surf resource (cpu, workstation, network, …)
352 * @param resource The surf resource
353 * @return The state of the surf resource
355 XBT_PUBLIC(e_surf_resource_state_t) surf_resource_get_state(surf_cpp_resource_t resource);
358 * @brief Set the state of a surf resource (cpu, workstation, network, …)
360 * @param resource The surf resource
361 * @param state The new state of the surf resource
363 XBT_PUBLIC(void) surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state);
366 * @brief Get the speed of the cpu associtated to a workstation
368 * @param resource The surf workstation
369 * @param load [description]
371 * @return [description]
373 XBT_PUBLIC(double) surf_workstation_get_speed(surf_resource_t resource, double load);
376 * @brief Get the available speed of cpu associtated to a workstation
378 * @param resource The surf workstation
379 * @return [description]
381 XBT_PUBLIC(double) surf_workstation_get_available_speed(surf_resource_t resource);
384 * @brief Get the number of cores of the cpu associated to a workstation
386 * @param resource The surf workstation
387 * @return The number of cores
389 XBT_PUBLIC(int) surf_workstation_get_core(surf_resource_t resource);
392 * @brief Execute some quantity of computation
394 * @param resource The surf workstation
395 * @param size The value of the processing amount (in flop) needed to process
397 * @return The surf action corresponding to the processing
399 XBT_PUBLIC(surf_action_t) surf_workstation_execute(surf_resource_t resource, double size);
402 * @brief Make the workstation sleep
404 * @param resource The surf workstation
405 * @param duration The number of seconds to sleep
406 * @return The surf action corresponding to the sleep
408 XBT_PUBLIC(surf_action_t) surf_workstation_sleep(surf_resource_t resource, double duration);
411 * @brief Open a file on a workstation
413 * @param workstation The surf workstation
414 * @param mount The mount point
415 * @param path The path to the file
416 * @return The surf action corresponding to the openning
418 XBT_PUBLIC(surf_action_t) surf_workstation_open(surf_resource_t workstation, const char* mount, const char* path);
421 * @brief Close a file descriptor on a workstation
423 * @param workstation The surf workstation
424 * @param fd The file descriptor
426 * @return The surf action corresponding to the closing
428 XBT_PUBLIC(surf_action_t) surf_workstation_close(surf_resource_t workstation, surf_file_t fd);
433 * @param resource The surf workstation
434 * @param fd The file descriptor to read
435 * @param size The size in bytes to read
436 * @return The surf action corresponding to the reading
438 XBT_PUBLIC(surf_action_t) surf_workstation_read(surf_resource_t resource, surf_file_t fd, sg_size_t size);
441 * @brief Write a file
443 * @param resource The surf workstation
444 * @param fd The file descriptor to write
445 * @param size The size in bytes to write
446 * @return The surf action corresponding to the writing
448 XBT_PUBLIC(surf_action_t) surf_workstation_write(surf_resource_t resource, surf_file_t fd, sg_size_t size);
451 * @brief Get the informations of a file descriptor
452 * @details The returned xbt_dynar_t contains:
453 * - the size of the file,
455 * - the storage name,
456 * - the storage typeId,
457 * - the storage content type
459 * @param resource The surf workstation
460 * @param fd The file descriptor
461 * @return An xbt_dynar_t with the file informations
463 XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_info(surf_resource_t resource, surf_file_t fd);
466 * @brief Get the available space of the storage at the mount point
468 * @param resource The surf workstation
469 * @param name The mount point
470 * @return The amount of availble space in bytes
472 XBT_PUBLIC(sg_size_t) surf_workstation_get_free_size(surf_resource_t resource, const char* name);
475 * @brief Get the used space of the storage at the mount point
477 * @param resource The surf workstation
478 * @param name The mount point
479 * @return The amount of used space in bytes
481 XBT_PUBLIC(sg_size_t) surf_workstation_get_used_size(surf_resource_t resource, const char* name);
484 * @brief Get the VMs hosted on the workstation
486 * @param resource The surf workstation
487 * @return The list of VMs on the workstation
489 XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_vms(surf_resource_t resource);
492 * @brief [brief description]
493 * @details [long description]
495 * @param resource [description]
496 * @param params [description]
498 XBT_PUBLIC(void) surf_workstation_get_params(surf_resource_t resource, ws_params_t params);
501 * @brief [brief description]
502 * @details [long description]
504 * @param resource [description]
505 * @param params [description]
507 XBT_PUBLIC(void) surf_workstation_set_params(surf_resource_t resource, ws_params_t params);
510 * @brief Destroy a Workstation VM
512 * @param resource The surf workstation vm
514 XBT_PUBLIC(void) surf_vm_workstation_destroy(surf_resource_t resource);
517 * @brief Suspend a Workstation VM
519 * @param resource The surf workstation vm
521 XBT_PUBLIC(void) surf_vm_workstation_suspend(surf_resource_t resource);
524 * @brief Resume a Workstation VM
526 * @param resource The surf workstation vm
528 XBT_PUBLIC(void) surf_vm_workstation_resume(surf_resource_t resource);
531 * @brief Save the Workstation VM (Not yet implemented)
533 * @param resource The surf workstation vm
535 XBT_PUBLIC(void) surf_vm_workstation_save(surf_resource_t resource);
538 * @brief Restore the Workstation VM (Not yet implemented)
540 * @param resource The surf workstation vm
542 XBT_PUBLIC(void) surf_vm_workstation_restore(surf_resource_t resource);
545 * @brief Migrate the VM to the destination host
547 * @param resource The surf workstation vm
548 * @param ind_vm_ws_dest The destination host
550 XBT_PUBLIC(void) surf_vm_workstation_migrate(surf_resource_t resource, surf_resource_t ind_vm_ws_dest);
553 * @brief Get the physical machine hosting the VM
555 * @param resource The surf workstation vm
556 * @return The physical machine hosting the VM
558 XBT_PUBLIC(surf_resource_t) surf_vm_workstation_get_pm(surf_resource_t resource);
561 * @brief [brief description]
562 * @details [long description]
564 * @param resource [description]
565 * @param bound [description]
567 XBT_PUBLIC(void) surf_vm_workstation_set_bound(surf_resource_t resource, double bound);
570 * @brief [brief description]
571 * @details [long description]
573 * @param resource [description]
574 * @param cpu [description]
575 * @param mask [description]
577 XBT_PUBLIC(void) surf_vm_workstation_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask);
580 * @brief Execute some quantity of computation
582 * @param cpu The surf cpu
583 * @param size The value of the processing amount (in flop) needed to process
584 * @return The surf action corresponding to the processing
586 XBT_PUBLIC(surf_action_t) surf_cpu_execute(surf_resource_t cpu, double size);
589 * @brief Make the cpu sleep for duration (in seconds)
590 * @details [long description]
592 * @param cpu The surf cpu
593 * @param duration The number of seconds to sleep
594 * @return The surf action corresponding to the sleeping
596 XBT_PUBLIC(surf_action_t) surf_cpu_sleep(surf_resource_t cpu, double duration);
599 * @brief Get the workstation power peak
600 * @details [long description]
602 * @param host The surf workstation
603 * @return The power peak
605 XBT_PUBLIC(double) surf_workstation_get_current_power_peak(surf_resource_t host);
608 * @brief [brief description]
609 * @details [long description]
611 * @param host [description]
612 * @param pstate_index [description]
614 * @return [description]
616 XBT_PUBLIC(double) surf_workstation_get_power_peak_at(surf_resource_t host, int pstate_index);
619 * @brief [brief description]
620 * @details [long description]
622 * @param host [description]
623 * @return [description]
625 XBT_PUBLIC(int) surf_workstation_get_nb_pstates(surf_resource_t host);
628 * @brief [brief description]
629 * @details [long description]
631 * @param host [description]
632 * @param pstate_index [description]
634 XBT_PUBLIC(void) surf_workstation_set_power_peak_at(surf_resource_t host, int pstate_index);
637 * @brief Get the consumed energy (in joules) of a workstation
639 * @param host The surf workstation
640 * @return The consumed energy
642 XBT_PUBLIC(double) surf_workstation_get_consumed_energy(surf_resource_t host);
645 * @brief Get the list of storages of a workstation
647 * @param workstation The surf workstation
648 * @return Dictionary of mount point, Storage
650 XBT_PUBLIC(xbt_dict_t) surf_workstation_get_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 List directory contents of a path
664 * @details [long description]
666 * @param workstation The surf workstation
667 * @param mount The mount point
668 * @param path The path to the directory
669 * @return The surf action corresponding to the ls action
671 XBT_PUBLIC(surf_action_t) surf_workstation_ls(surf_resource_t workstation, const char* mount, const char *path);
674 * @brief Get the size of a file on a workstation
676 * @param workstation The surf workstation
677 * @param fd The file descriptor
679 * @return The size in bytes of the file
681 XBT_PUBLIC(size_t) surf_workstation_get_size(surf_resource_t workstation, surf_file_t fd);
684 * @brief Get the current position of the file descriptor
686 * @param workstation The surf workstation
687 * @param fd The file descriptor
688 * @return The current position of the file descriptor
690 XBT_PUBLIC(size_t) surf_workstation_file_tell(surf_resource_t workstation, surf_file_t fd);
693 * @brief Set the position indictator assiociated with the file descriptor to a new position
694 * @details [long description]
696 * @param workstation The surf workstation
697 * @param fd The file descriptor
698 * @param offset The offset from the origin
699 * @param origin Position used as a reference for the offset
700 * - SEEK_SET: beginning of the file
701 * - SEEK_CUR: current position indicator
702 * - SEEK_END: end of the file
703 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
705 XBT_PUBLIC(int) surf_workstation_file_seek(surf_resource_t workstation, surf_file_t fd, sg_size_t offset, int origin);
708 * @brief [brief description]
709 * @details [long description]
711 * @param link [description]
712 * @return [description]
714 XBT_PUBLIC(int) surf_network_link_is_shared(surf_cpp_resource_t link);
717 * @brief Get the bandwidth of a link in bytes per second
719 * @param link The surf link
720 * @return The bandwidth in bytes per second
722 XBT_PUBLIC(double) surf_network_link_get_bandwidth(surf_cpp_resource_t link);
725 * @brief Get the latency of a link in seconds
727 * @param link The surf link
728 * @return The latency in seconds
730 XBT_PUBLIC(double) surf_network_link_get_latency(surf_cpp_resource_t link);
733 * @brief Get the content of a storage
735 * @param resource The surf storage
736 * @return A xbt_dict_t with path as keys and size in bytes as values
738 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
741 * @brief Get the size in bytes of a storage
743 * @param resource The surf storage
744 * @return The size in bytes of the storage
746 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
749 * @brief Rename a path
751 * @param resource The surf storage
752 * @param src The old path
753 * @param dest The new path
755 XBT_PUBLIC(void) surf_storage_rename(surf_resource_t resource, const char* src, const char* dest);
758 * @brief Get the data associated to the action
760 * @param action The surf action
761 * @return The data associated to the action
763 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
766 * @brief Set the data associated to the action
767 * @details [long description]
769 * @param action The surf action
770 * @param data The new data associated to the action
772 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
775 * @brief Unreference an action
777 * @param action The surf action
779 XBT_PUBLIC(void) surf_action_unref(surf_action_t action);
782 * @brief Get the start time of an action
784 * @param action The surf action
785 * @return The start time in seconds from the beginning of the simulation
787 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
790 * @brief Get the finish time of an action
792 * @param action The surf action
793 * @return The finish time in seconds from the beginning of the simulation
795 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
798 * @brief Get the remains amount of work to do of an action
800 * @param action The surf action
801 * @return The remains amount of work to do
803 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
806 * @brief Suspend an action
808 * @param action The surf action
810 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
813 * @brief Resume an action
815 * @param action The surf action
817 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
820 * @brief Cancel an action
822 * @param action The surf action
824 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
827 * @brief Set the priority of an action
828 * @details [long description]
830 * @param action The surf action
831 * @param priority The new priority [TODO]
833 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
836 * @brief Set the category of an action
837 * @details [long description]
839 * @param action The surf action
840 * @param category The new category of the action
842 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
845 * @brief Get the state of an action
847 * @param action The surf action
848 * @return The state of the action
850 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
853 * @brief Get the cost of an action
855 * @param action The surf action
856 * @return The cost of the action
858 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
861 * @brief [brief desrciption]
862 * @details [long description]
864 * @param action The surf cpu action
865 * @param cpu [description]
866 * @param mask [description]
868 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask);
871 * @brief [brief description]
872 * @details [long description]
874 * @param action The surf cpu action
875 * @param bound [description]
877 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
880 * @brief [brief description]
881 * @details [long description]
883 * @param action The surf network action
885 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
888 * @brief Get the file associated to a storage action
890 * @param action The surf storage action
891 * @return The file associated to a storage action
893 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
896 * @brief Get the result dictionary of an ls action
898 * @param action The surf storage action
899 * @return The dictionry listing a path
901 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
903 XBT_PUBLIC(surf_model_t) surf_resource_model(const void *host, int level);
907 /**************************************/
908 /* Implementations of model object */
909 /**************************************/
911 /** \ingroup SURF_models
912 * \brief The CPU model object for the physical machine layer
914 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
916 /** \ingroup SURF_models
917 * \brief The CPU model object for the virtual machine layer
919 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
922 /** \ingroup SURF_models
923 * \brief Initializes the CPU model with the model Cas01
925 * By default, this model uses the lazy optimization mechanism that
926 * relies on partial invalidation in LMM and a heap for lazy action update.
927 * You can change this behavior by setting the cpu/optim configuration
928 * variable to a different value.
930 * You shouldn't have to call it by yourself.
932 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
934 /** \ingroup SURF_models
935 * \brief Initializes the CPU model with trace integration [Deprecated]
937 * You shouldn't have to call it by yourself.
939 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
941 /** \ingroup SURF_models
942 * \brief The list of all available optimization modes (both for cpu and networks).
943 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
945 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
947 /** \ingroup SURF_plugins
948 * \brief The list of all available surf plugins
950 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
952 /** \ingroup SURF_models
953 * \brief The list of all available cpu model models
955 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
957 /**\brief create new host bypass the parser
962 /** \ingroup SURF_models
963 * \brief The network model
965 * When creating a new API on top on SURF, you shouldn't use the
966 * network model unless you know what you are doing. Only the workstation
967 * model should be accessed because depending on the platform model,
968 * the network model can be NULL.
970 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
972 /** \ingroup SURF_models
973 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
975 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
976 * based on the model 'LV08' and different correction factors depending on the communication
977 * size (< 1KiB, < 64KiB, >= 64KiB).
978 * See comments in the code for more information.
980 * \see surf_workstation_model_init_SMPI()
982 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
984 /** \ingroup SURF_models
985 * \brief Initializes the platform with the network model 'LegrandVelho'
987 * This model is proposed by Arnaud Legrand and Pedro Velho based on
988 * the results obtained with the GTNets simulator for onelink and
989 * dogbone sharing scenarios. See comments in the code for more information.
991 * \see surf_workstation_model_init_LegrandVelho()
993 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
995 /** \ingroup SURF_models
996 * \brief Initializes the platform with the network model 'Constant'
998 * In this model, the communication time between two network cards is
999 * constant, hence no need for a routing table. This is particularly
1000 * usefull when simulating huge distributed algorithms where
1001 * scalability is really an issue. This function is called in
1002 * conjunction with surf_workstation_model_init_compound.
1004 * \see surf_workstation_model_init_compound()
1006 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
1008 /** \ingroup SURF_models
1009 * \brief Initializes the platform with the network model CM02
1011 * You sould call this function by yourself only if you plan using
1012 * surf_workstation_model_init_compound.
1013 * See comments in the code for more information.
1015 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
1018 /** \ingroup SURF_models
1019 * \brief Initializes the platform with the network model GTNETS
1020 * \param filename XML platform file name
1022 * This function is called by surf_workstation_model_init_GTNETS
1023 * or by yourself only if you plan using surf_workstation_model_init_compound
1025 * \see surf_workstation_model_init_GTNETS()
1027 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
1031 /** \ingroup SURF_models
1032 * \brief Initializes the platform with the network model NS3
1033 * \param filename XML platform file name
1035 * This function is called by surf_workstation_model_init_NS3
1036 * or by yourself only if you plan using surf_workstation_model_init_compound
1038 * \see surf_workstation_model_init_NS3()
1040 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
1043 /** \ingroup SURF_models
1044 * \brief Initializes the platform with the network model Reno
1045 * \param filename XML platform file name
1047 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
1050 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1051 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1053 * Call this function only if you plan using surf_workstation_model_init_compound.
1056 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
1058 /** \ingroup SURF_models
1059 * \brief Initializes the platform with the network model Reno2
1060 * \param filename XML platform file name
1062 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
1065 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
1066 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1068 * Call this function only if you plan using surf_workstation_model_init_compound.
1071 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
1073 /** \ingroup SURF_models
1074 * \brief Initializes the platform with the network model Vegas
1075 * \param filename XML platform file name
1077 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
1078 * to the proportional fairness.
1081 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1082 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1084 * Call this function only if you plan using surf_workstation_model_init_compound.
1087 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
1089 /** \ingroup SURF_models
1090 * \brief The list of all available network model models
1092 XBT_PUBLIC_DATA(s_surf_model_description_t)
1093 surf_network_model_description[];
1095 /** \ingroup SURF_models
1096 * \brief The storage model
1098 XBT_PUBLIC(void) surf_storage_model_init_default(void);
1100 /** \ingroup SURF_models
1101 * \brief The list of all available storage modes.
1102 * This storage mode can be set using --cfg=storage/model:...
1104 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
1106 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
1108 /** \ingroup SURF_models
1109 * \brief The workstation model
1111 * Note that when you create an API on top of SURF,
1112 * the workstation model should be the only one you use
1113 * because depending on the platform model, the network model and the CPU model
1116 XBT_PUBLIC_DATA(surf_workstation_model_t) surf_workstation_model;
1118 /** \ingroup SURF_models
1119 * \brief The vm_workstation model
1121 * Note that when you create an API on top of SURF,
1122 * the vm_workstation model should be the only one you use
1123 * because depending on the platform model, the network model and the CPU model
1126 XBT_PUBLIC_DATA(surf_vm_workstation_model_t) surf_vm_workstation_model;
1128 /** \ingroup SURF_models
1129 * \brief Initializes the platform with a compound workstation model
1131 * This function should be called after a cpu_model and a
1132 * network_model have been set up.
1135 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
1137 /** \ingroup SURF_models
1138 * \brief Initializes the platform with the current best network and cpu models at hand
1140 * This platform model seperates the workstation model and the network model.
1141 * The workstation model will be initialized with the model compound, the network
1142 * model with the model LV08 (with cross traffic support) and the CPU model with
1144 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1147 XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
1149 /** \ingroup SURF_models
1150 * \brief Initializes the platform with the model KCCFLN05
1152 * With this model, only parallel tasks can be used. Resource sharing
1153 * is done by identifying bottlenecks and giving an equal share of
1154 * the model to each action.
1157 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
1159 /** \ingroup SURF_models
1160 * \brief The list of all available workstation model models
1162 XBT_PUBLIC_DATA(s_surf_model_description_t)
1163 surf_workstation_model_description[];
1165 /** \ingroup SURF_models
1166 * \brief Initializes the platform with the current best network and cpu models at hand
1168 * This platform model seperates the workstation model and the network model.
1169 * The workstation model will be initialized with the model compound, the network
1170 * model with the model LV08 (with cross traffic support) and the CPU model with
1172 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1175 XBT_PUBLIC(void) surf_vm_workstation_model_init_current_default(void);
1177 /** \ingroup SURF_models
1178 * \brief The list of all available vm workstation model models
1180 XBT_PUBLIC_DATA(s_surf_model_description_t)
1181 surf_vm_workstation_model_description[];
1183 /*******************************************/
1185 /** \ingroup SURF_models
1186 * \brief List of initialized models
1188 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
1189 XBT_PUBLIC_DATA(xbt_dynar_t) model_list_invoke;
1191 /** \ingroup SURF_simulation
1192 * \brief List of hosts that have juste restarted and whose autorestart process should be restarted.
1194 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
1196 /** \ingroup SURF_simulation
1197 * \brief List of hosts for which one want to be notified if they ever restart.
1199 XBT_PUBLIC(xbt_dict_t) watched_hosts_lib;
1201 /*******************************************/
1202 /*** SURF Platform *************************/
1203 /*******************************************/
1204 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
1205 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
1206 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
1207 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
1208 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
1209 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
1210 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
1211 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
1213 /*******************************************/
1214 /*** SURF Globals **************************/
1215 /*******************************************/
1217 /** \ingroup SURF_simulation
1218 * \brief Initialize SURF
1219 * \param argc argument number
1220 * \param argv arguments
1222 * This function has to be called to initialize the common
1223 * structures. Then you will have to create the environment by
1225 * e.g. surf_workstation_model_init_CM02()
1227 * \see surf_workstation_model_init_CM02(), surf_workstation_model_init_compound(), surf_exit()
1229 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
1231 /** \ingroup SURF_simulation
1232 * \brief Finish simulation initialization
1234 * This function must be called before the first call to surf_solve()
1236 XBT_PUBLIC(void) surf_presolve(void);
1238 /** \ingroup SURF_simulation
1239 * \brief Performs a part of the simulation
1240 * \param max_date Maximum date to update the simulation to, or -1
1241 * \return the elapsed time, or -1.0 if no event could be executed
1243 * This function execute all possible events, update the action states
1244 * and returns the time elapsed.
1245 * When you call execute or communicate on a model, the corresponding actions
1246 * are not executed immediately but only when you call surf_solve.
1247 * Note that the returned elapsed time can be zero.
1249 XBT_PUBLIC(double) surf_solve(double max_date);
1251 /** \ingroup SURF_simulation
1252 * \brief Return the current time
1254 * Return the current time in millisecond.
1256 XBT_PUBLIC(double) surf_get_clock(void);
1258 /** \ingroup SURF_simulation
1265 XBT_PUBLIC(void) surf_exit(void);
1267 /* Prototypes of the functions that handle the properties */
1268 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
1270 /* surf parse file related (public because called from a test suite) */
1271 XBT_PUBLIC(void) parse_platform_file(const char *file);
1273 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
1274 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
1275 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
1276 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
1277 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
1278 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
1279 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
1282 XBT_PUBLIC(double) get_cpu_power(const char *power);
1284 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
1286 int surf_get_nthreads(void);
1287 void surf_set_nthreads(int nthreads);
1290 * Returns the initial path. On Windows the initial path is
1291 * the current directory for the current process in the other
1292 * case the function returns "./" that represents the current
1293 * directory on Unix/Linux platforms.
1295 const char *__surf_get_initial_path(void);
1297 /********** Tracing **********/
1298 /* from surf_instr.c */
1299 void TRACE_surf_action(surf_action_t surf_action, const char *category);
1300 void TRACE_surf_alloc(void);
1301 void TRACE_surf_release(void);
1303 /* instr_routing.c */
1304 void instr_routing_define_callbacks (void);
1305 void instr_new_variable_type (const char *new_typename, const char *color);
1306 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
1307 void instr_new_user_state_type (const char *father_type, const char *new_typename);
1308 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
1309 int instr_platform_traced (void);
1310 xbt_graph_t instr_routing_platform_graph (void);
1311 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1314 #endif /* _SURF_SURF_H */