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 */
175 SURF_VM_STATE_RUNNING,
176 SURF_VM_STATE_MIGRATING,
178 SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
180 SURF_VM_STATE_SAVING, /**< Save/restore involves disk I/O, so there should be transition states. */
182 SURF_VM_STATE_RESTORING,
186 /***************************/
187 /* Generic model object */
188 /***************************/
190 //FIXME:REMOVE typedef struct s_routing_platf s_routing_platf_t, *routing_platf_t;
191 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
193 static inline void *surf_cpu_resource_priv(const void *host) {
194 return xbt_lib_get_level((xbt_dictelm_t)host, SURF_CPU_LEVEL);
196 static inline void *surf_workstation_resource_priv(const void *host){
197 return (void*)xbt_lib_get_level((xbt_dictelm_t)host, SURF_WKS_LEVEL);
199 static inline void *surf_storage_resource_priv(const void *storage){
200 return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
203 static inline void *surf_cpu_resource_by_name(const char *name) {
204 return xbt_lib_get_elm_or_null(host_lib, name);
206 static inline void *surf_workstation_resource_by_name(const char *name){
207 return xbt_lib_get_elm_or_null(host_lib, name);
209 static inline void *surf_storage_resource_by_name(const char *name){
210 return xbt_lib_get_elm_or_null(storage_lib, name);
214 XBT_PUBLIC(char *) surf_routing_edge_name(sg_routing_edge_t edge);
215 XBT_PUBLIC(void *) surf_as_cluster_get_backbone(AS_t as);
216 XBT_PUBLIC(void) surf_as_cluster_set_backbone(AS_t as, void* backbone);
218 /** @{ @ingroup SURF_c_bindings */
221 * @brief Get the name of a surf model
223 * @param model A model
224 * @return The name of the model
226 XBT_PUBLIC(const char *) surf_model_name(surf_model_t model);
229 * @brief Pop an action from the done actions set
231 * @param model The model from which the action is extracted
232 * @return An action in done state
234 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
237 * @brief Pop an action from the failed actions set
239 * @param model The model from which the action is extracted
240 * @return An action in failed state
242 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
245 * @brief Pop an action from the ready actions set
247 * @param model The model from which the action is extracted
248 * @return An action in ready state
250 XBT_PUBLIC(surf_action_t) surf_model_extract_ready_action_set(surf_model_t model);
253 * @brief Pop an action from the running actions set
255 * @param model The model from which the action is extracted
256 * @return An action in running state
258 XBT_PUBLIC(surf_action_t) surf_model_extract_running_action_set(surf_model_t model);
261 * @brief Get the size of the running action set of a model
263 * @param model The model
264 * @return The size of the running action set
266 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
269 * @brief Execute a parallel task
270 * @details [long description]
272 * @param model The model which handle the parallelisation
273 * @param workstation_nb The number of workstations
274 * @param workstation_list The list of workstations on which the task is executed
275 * @param computation_amount The processing amount (in flop) needed to process
276 * @param communication_amount The amount of data (in bytes) needed to transfer
277 * @param rate [description]
278 * @return The action corresponding to the parallele execution task
280 XBT_PUBLIC(surf_action_t) surf_workstation_model_execute_parallel_task(surf_workstation_model_t model,
282 void **workstation_list,
283 double *computation_amount,
284 double *communication_amount,
288 * @brief Create a communication between two hosts
290 * @param model The model which handle the communication
291 * @param src The source host
292 * @param dst The destination host
293 * @param size The amount of data (in bytes) needed to transfer
294 * @param rate [description]
295 * @return The action corresponding to the communication
297 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);
300 * @brief Get the route between two hosts
301 * @details [long description]
303 * @param model The model which handle the routes
304 * @param src The source host
305 * @param dst The destination host
306 * @return The list of [TODO] from the source to the host
308 XBT_PUBLIC(xbt_dynar_t) surf_workstation_model_get_route(surf_workstation_model_t model, surf_resource_t src, surf_resource_t dst);
311 * @brief Create a new VM on the specified host
313 * @param name The name of the workstation
314 * @param ind_phys_host The host on which the VM is created
316 XBT_PUBLIC(void) surf_vm_workstation_model_create(const char *name, surf_resource_t ind_phys_host);
319 * @brief Create a communication between two routing edges [TODO]
320 * @details [long description]
322 * @param model The model which handle the communication
323 * @param src The source host
324 * @param dst The destination host
325 * @param size The amount of data (in bytes) needed to transfer
326 * @param rate [description]
327 * @return The action corresponding to the communication
329 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);
332 * @brief Get the name of a surf resource (cpu, workstation, network, …)
334 * @param resource The surf resource
335 * @return The name of the surf resource
337 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
340 * @brief Get the properties of a surf resource (cpu, workstation, network, …)
342 * @param resource The surf resource
343 * @return The properties of the surf resource
345 XBT_PUBLIC(xbt_dict_t) surf_resource_get_properties(surf_cpp_resource_t resource);
348 * @brief Get the state of a surf resource (cpu, workstation, network, …)
350 * @param resource The surf resource
351 * @return The state of the surf resource
353 XBT_PUBLIC(e_surf_resource_state_t) surf_resource_get_state(surf_cpp_resource_t resource);
356 * @brief Set the state of a surf resource (cpu, workstation, network, …)
358 * @param resource The surf resource
359 * @param state The new state of the surf resource
361 XBT_PUBLIC(void) surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state);
364 * @brief Get the speed of the cpu associtated to a workstation
366 * @param resource The surf workstation
367 * @param load [description]
369 * @return [description]
371 XBT_PUBLIC(double) surf_workstation_get_speed(surf_resource_t resource, double load);
374 * @brief Get the available speed of cpu associtated to a workstation
376 * @param resource The surf workstation
377 * @return [description]
379 XBT_PUBLIC(double) surf_workstation_get_available_speed(surf_resource_t resource);
382 * @brief Get the number of cores of the cpu associated to a workstation
384 * @param resource The surf workstation
385 * @return The number of cores
387 XBT_PUBLIC(int) surf_workstation_get_core(surf_resource_t resource);
390 * @brief Execute some quantity of computation
392 * @param resource The surf workstation
393 * @param size The value of the processing amount (in flop) needed to process
395 * @return The surf action corresponding to the processing
397 XBT_PUBLIC(surf_action_t) surf_workstation_execute(surf_resource_t resource, double size);
400 * @brief Make the workstation sleep
402 * @param resource The surf workstation
403 * @param duration The number of seconds to sleep
404 * @return The surf action corresponding to the sleep
406 XBT_PUBLIC(surf_action_t) surf_workstation_sleep(surf_resource_t resource, double duration);
409 * @brief Open a file on a workstation
411 * @param workstation The surf workstation
412 * @param mount The mount point
413 * @param path The path to the file
414 * @return The surf action corresponding to the openning
416 XBT_PUBLIC(surf_action_t) surf_workstation_open(surf_resource_t workstation, const char* mount, const char* path);
419 * @brief Close a file descriptor on a workstation
421 * @param workstation The surf workstation
422 * @param fd The file descriptor
424 * @return The surf action corresponding to the closing
426 XBT_PUBLIC(surf_action_t) surf_workstation_close(surf_resource_t workstation, surf_file_t fd);
431 * @param resource The surf workstation
432 * @param fd The file descriptor to read
433 * @param size The size in bytes to read
434 * @return The surf action corresponding to the reading
436 XBT_PUBLIC(surf_action_t) surf_workstation_read(surf_resource_t resource, surf_file_t fd, sg_size_t size);
439 * @brief Write a file
441 * @param resource The surf workstation
442 * @param fd The file descriptor to write
443 * @param size The size in bytes to write
444 * @return The surf action corresponding to the writing
446 XBT_PUBLIC(surf_action_t) surf_workstation_write(surf_resource_t resource, surf_file_t fd, sg_size_t size);
449 * @brief Get the informations of a file descriptor
450 * @details The returned xbt_dynar_t contains:
451 * - the size of the file,
453 * - the storage name,
454 * - the storage typeId,
455 * - the storage content type
457 * @param resource The surf workstation
458 * @param fd The file descriptor
459 * @return An xbt_dynar_t with the file informations
461 XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_info(surf_resource_t resource, surf_file_t fd);
464 * @brief Get the available space of the storage at the mount point
466 * @param resource The surf workstation
467 * @param name The mount point
468 * @return The amount of availble space in bytes
470 XBT_PUBLIC(sg_size_t) surf_workstation_get_free_size(surf_resource_t resource, const char* name);
473 * @brief Get the used space of the storage at the mount point
475 * @param resource The surf workstation
476 * @param name The mount point
477 * @return The amount of used space in bytes
479 XBT_PUBLIC(sg_size_t) surf_workstation_get_used_size(surf_resource_t resource, const char* name);
482 * @brief Get the VMs hosted on the workstation
484 * @param resource The surf workstation
485 * @return The list of VMs on the workstation
487 XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_vms(surf_resource_t resource);
490 * @brief [brief description]
491 * @details [long description]
493 * @param resource [description]
494 * @param params [description]
496 XBT_PUBLIC(void) surf_workstation_get_params(surf_resource_t resource, ws_params_t params);
499 * @brief [brief description]
500 * @details [long description]
502 * @param resource [description]
503 * @param params [description]
505 XBT_PUBLIC(void) surf_workstation_set_params(surf_resource_t resource, ws_params_t params);
508 * @brief Destroy a Workstation VM
510 * @param resource The surf workstation vm
512 XBT_PUBLIC(void) surf_vm_workstation_destroy(surf_resource_t resource);
515 * @brief Suspend a Workstation VM
517 * @param resource The surf workstation vm
519 XBT_PUBLIC(void) surf_vm_workstation_suspend(surf_resource_t resource);
522 * @brief Resume a Workstation VM
524 * @param resource The surf workstation vm
526 XBT_PUBLIC(void) surf_vm_workstation_resume(surf_resource_t resource);
529 * @brief Save the Workstation VM (Not yet implemented)
531 * @param resource The surf workstation vm
533 XBT_PUBLIC(void) surf_vm_workstation_save(surf_resource_t resource);
536 * @brief Restore the Workstation VM (Not yet implemented)
538 * @param resource The surf workstation vm
540 XBT_PUBLIC(void) surf_vm_workstation_restore(surf_resource_t resource);
543 * @brief Migrate the VM to the destination host
545 * @param resource The surf workstation vm
546 * @param ind_vm_ws_dest The destination host
548 XBT_PUBLIC(void) surf_vm_workstation_migrate(surf_resource_t resource, surf_resource_t ind_vm_ws_dest);
551 * @brief Get the physical machine hosting the VM
553 * @param resource The surf workstation vm
554 * @return The physical machine hosting the VM
556 XBT_PUBLIC(surf_resource_t) surf_vm_workstation_get_pm(surf_resource_t resource);
559 * @brief [brief description]
560 * @details [long description]
562 * @param resource [description]
563 * @param bound [description]
565 XBT_PUBLIC(void) surf_vm_workstation_set_bound(surf_resource_t resource, double bound);
568 * @brief [brief description]
569 * @details [long description]
571 * @param resource [description]
572 * @param cpu [description]
573 * @param mask [description]
575 XBT_PUBLIC(void) surf_vm_workstation_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask);
578 * @brief Execute some quantity of computation
580 * @param cpu The surf cpu
581 * @param size The value of the processing amount (in flop) needed to process
582 * @return The surf action corresponding to the processing
584 XBT_PUBLIC(surf_action_t) surf_cpu_execute(surf_resource_t cpu, double size);
587 * @brief Make the cpu sleep for duration (in seconds)
588 * @details [long description]
590 * @param cpu The surf cpu
591 * @param duration The number of seconds to sleep
592 * @return The surf action corresponding to the sleeping
594 XBT_PUBLIC(surf_action_t) surf_cpu_sleep(surf_resource_t cpu, double duration);
597 * @brief Get the workstation power peak
598 * @details [long description]
600 * @param host The surf workstation
601 * @return The power peak
603 XBT_PUBLIC(double) surf_workstation_get_current_power_peak(surf_resource_t host);
606 * @brief [brief description]
607 * @details [long description]
609 * @param host [description]
610 * @param pstate_index [description]
612 * @return [description]
614 XBT_PUBLIC(double) surf_workstation_get_power_peak_at(surf_resource_t host, int pstate_index);
617 * @brief [brief description]
618 * @details [long description]
620 * @param host [description]
621 * @return [description]
623 XBT_PUBLIC(int) surf_workstation_get_nb_pstates(surf_resource_t host);
626 * @brief [brief description]
627 * @details [long description]
629 * @param host [description]
630 * @param pstate_index [description]
632 XBT_PUBLIC(void) surf_workstation_set_power_peak_at(surf_resource_t host, int pstate_index);
635 * @brief Get the consumed energy (in joules) of a workstation
637 * @param host The surf workstation
638 * @return The consumed energy
640 XBT_PUBLIC(double) surf_workstation_get_consumed_energy(surf_resource_t host);
643 * @brief Get the list of storages mounted on a workstation
645 * @param workstation The surf workstation
646 * @return Dictionary of mount point, Storage
648 XBT_PUBLIC(xbt_dict_t) surf_workstation_get_mounted_storage_list(surf_resource_t workstation);
651 * @brief Get the list of storages attached to a workstation
653 * @param workstation The surf workstation
654 * @return Dictionary of storage
656 XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_attached_storage_list(surf_resource_t workstation);
659 * @brief Unlink a file descriptor
661 * @param workstation The surf workstation
662 * @param fd The file descriptor
664 * @return 0 if failed to unlink, 1 otherwise
666 XBT_PUBLIC(int) surf_workstation_unlink(surf_resource_t workstation, surf_file_t fd);
669 * @brief List directory contents of a path
670 * @details [long description]
672 * @param workstation The surf workstation
673 * @param mount The mount point
674 * @param path The path to the directory
675 * @return The surf action corresponding to the ls action
677 XBT_PUBLIC(surf_action_t) surf_workstation_ls(surf_resource_t workstation, const char* mount, const char *path);
680 * @brief Get the size of a file on a workstation
682 * @param workstation The surf workstation
683 * @param fd The file descriptor
685 * @return The size in bytes of the file
687 XBT_PUBLIC(size_t) surf_workstation_get_size(surf_resource_t workstation, surf_file_t fd);
690 * @brief Get the current position of the file descriptor
692 * @param workstation The surf workstation
693 * @param fd The file descriptor
694 * @return The current position of the file descriptor
696 XBT_PUBLIC(size_t) surf_workstation_file_tell(surf_resource_t workstation, surf_file_t fd);
699 * @brief Set the position indictator assiociated with the file descriptor to a new position
700 * @details [long description]
702 * @param workstation The surf workstation
703 * @param fd The file descriptor
704 * @param offset The offset from the origin
705 * @param origin Position used as a reference for the offset
706 * - SEEK_SET: beginning of the file
707 * - SEEK_CUR: current position indicator
708 * - SEEK_END: end of the file
709 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
711 XBT_PUBLIC(int) surf_workstation_file_seek(surf_resource_t workstation, surf_file_t fd, sg_size_t offset, int origin);
714 * @brief [brief description]
715 * @details [long description]
717 * @param link [description]
718 * @return [description]
720 XBT_PUBLIC(int) surf_network_link_is_shared(surf_cpp_resource_t link);
723 * @brief Get the bandwidth of a link in bytes per second
725 * @param link The surf link
726 * @return The bandwidth in bytes per second
728 XBT_PUBLIC(double) surf_network_link_get_bandwidth(surf_cpp_resource_t link);
731 * @brief Get the latency of a link in seconds
733 * @param link The surf link
734 * @return The latency in seconds
736 XBT_PUBLIC(double) surf_network_link_get_latency(surf_cpp_resource_t link);
739 * @brief Get the content of a storage
741 * @param resource The surf storage
742 * @return A xbt_dict_t with path as keys and size in bytes as values
744 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
747 * @brief Get the size in bytes of a storage
749 * @param resource The surf storage
750 * @return The size in bytes of the storage
752 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
755 * @brief Rename a path
757 * @param resource The surf storage
758 * @param src The old path
759 * @param dest The new path
761 XBT_PUBLIC(void) surf_storage_rename(surf_resource_t resource, const char* src, const char* dest);
764 * @brief Get the data associated to the action
766 * @param action The surf action
767 * @return The data associated to the action
769 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
772 * @brief Set the data associated to the action
773 * @details [long description]
775 * @param action The surf action
776 * @param data The new data associated to the action
778 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
781 * @brief Unreference an action
783 * @param action The surf action
785 XBT_PUBLIC(void) surf_action_unref(surf_action_t action);
788 * @brief Get the start time of an action
790 * @param action The surf action
791 * @return The start time in seconds from the beginning of the simulation
793 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
796 * @brief Get the finish time of an action
798 * @param action The surf action
799 * @return The finish time in seconds from the beginning of the simulation
801 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
804 * @brief Get the remains amount of work to do of an action
806 * @param action The surf action
807 * @return The remains amount of work to do
809 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
812 * @brief Suspend an action
814 * @param action The surf action
816 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
819 * @brief Resume an action
821 * @param action The surf action
823 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
826 * @brief Cancel an action
828 * @param action The surf action
830 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
833 * @brief Set the priority of an action
834 * @details [long description]
836 * @param action The surf action
837 * @param priority The new priority [TODO]
839 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
842 * @brief Set the category of an action
843 * @details [long description]
845 * @param action The surf action
846 * @param category The new category of the action
848 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
851 * @brief Get the state of an action
853 * @param action The surf action
854 * @return The state of the action
856 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
859 * @brief Get the cost of an action
861 * @param action The surf action
862 * @return The cost of the action
864 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
867 * @brief [brief desrciption]
868 * @details [long description]
870 * @param action The surf cpu action
871 * @param cpu [description]
872 * @param mask [description]
874 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask);
877 * @brief [brief description]
878 * @details [long description]
880 * @param action The surf cpu action
881 * @param bound [description]
883 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
886 * @brief [brief description]
887 * @details [long description]
889 * @param action The surf network action
891 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
894 * @brief Get the file associated to a storage action
896 * @param action The surf storage action
897 * @return The file associated to a storage action
899 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
902 * @brief Get the result dictionary of an ls action
904 * @param action The surf storage action
905 * @return The dictionry listing a path
907 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
911 * @brief Get the host the storage is attached to
913 * @param resource The surf storage
914 * @return The host name
916 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
918 XBT_PUBLIC(surf_model_t) surf_resource_model(const void *host, int level);
922 /**************************************/
923 /* Implementations of model object */
924 /**************************************/
926 /** \ingroup SURF_models
927 * \brief The CPU model object for the physical machine layer
929 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
931 /** \ingroup SURF_models
932 * \brief The CPU model object for the virtual machine layer
934 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
937 /** \ingroup SURF_models
938 * \brief Initializes the CPU model with the model Cas01
940 * By default, this model uses the lazy optimization mechanism that
941 * relies on partial invalidation in LMM and a heap for lazy action update.
942 * You can change this behavior by setting the cpu/optim configuration
943 * variable to a different value.
945 * You shouldn't have to call it by yourself.
947 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
949 /** \ingroup SURF_models
950 * \brief Initializes the CPU model with trace integration [Deprecated]
952 * You shouldn't have to call it by yourself.
954 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
956 /** \ingroup SURF_models
957 * \brief The list of all available optimization modes (both for cpu and networks).
958 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
960 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
962 /** \ingroup SURF_plugins
963 * \brief The list of all available surf plugins
965 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
967 /** \ingroup SURF_models
968 * \brief The list of all available cpu model models
970 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
972 /**\brief create new host bypass the parser
977 /** \ingroup SURF_models
978 * \brief The network model
980 * When creating a new API on top on SURF, you shouldn't use the
981 * network model unless you know what you are doing. Only the workstation
982 * model should be accessed because depending on the platform model,
983 * the network model can be NULL.
985 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
987 /** \ingroup SURF_models
988 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
990 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
991 * based on the model 'LV08' and different correction factors depending on the communication
992 * size (< 1KiB, < 64KiB, >= 64KiB).
993 * See comments in the code for more information.
995 * \see surf_workstation_model_init_SMPI()
997 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
999 /** \ingroup SURF_models
1000 * \brief Initializes the platform with the network model 'LegrandVelho'
1002 * This model is proposed by Arnaud Legrand and Pedro Velho based on
1003 * the results obtained with the GTNets simulator for onelink and
1004 * dogbone sharing scenarios. See comments in the code for more information.
1006 * \see surf_workstation_model_init_LegrandVelho()
1008 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
1010 /** \ingroup SURF_models
1011 * \brief Initializes the platform with the network model 'Constant'
1013 * In this model, the communication time between two network cards is
1014 * constant, hence no need for a routing table. This is particularly
1015 * usefull when simulating huge distributed algorithms where
1016 * scalability is really an issue. This function is called in
1017 * conjunction with surf_workstation_model_init_compound.
1019 * \see surf_workstation_model_init_compound()
1021 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
1023 /** \ingroup SURF_models
1024 * \brief Initializes the platform with the network model CM02
1026 * You sould call this function by yourself only if you plan using
1027 * surf_workstation_model_init_compound.
1028 * See comments in the code for more information.
1030 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
1033 /** \ingroup SURF_models
1034 * \brief Initializes the platform with the network model GTNETS
1035 * \param filename XML platform file name
1037 * This function is called by surf_workstation_model_init_GTNETS
1038 * or by yourself only if you plan using surf_workstation_model_init_compound
1040 * \see surf_workstation_model_init_GTNETS()
1042 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
1046 /** \ingroup SURF_models
1047 * \brief Initializes the platform with the network model NS3
1048 * \param filename XML platform file name
1050 * This function is called by surf_workstation_model_init_NS3
1051 * or by yourself only if you plan using surf_workstation_model_init_compound
1053 * \see surf_workstation_model_init_NS3()
1055 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
1058 /** \ingroup SURF_models
1059 * \brief Initializes the platform with the network model Reno
1060 * \param filename XML platform file name
1062 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
1065 * [LOW03] 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_Reno(void);
1073 /** \ingroup SURF_models
1074 * \brief Initializes the platform with the network model Reno2
1075 * \param filename XML platform file name
1077 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
1080 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
1081 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1083 * Call this function only if you plan using surf_workstation_model_init_compound.
1086 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
1088 /** \ingroup SURF_models
1089 * \brief Initializes the platform with the network model Vegas
1090 * \param filename XML platform file name
1092 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
1093 * to the proportional fairness.
1096 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1097 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1099 * Call this function only if you plan using surf_workstation_model_init_compound.
1102 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
1104 /** \ingroup SURF_models
1105 * \brief The list of all available network model models
1107 XBT_PUBLIC_DATA(s_surf_model_description_t)
1108 surf_network_model_description[];
1110 /** \ingroup SURF_models
1111 * \brief The storage model
1113 XBT_PUBLIC(void) surf_storage_model_init_default(void);
1115 /** \ingroup SURF_models
1116 * \brief The list of all available storage modes.
1117 * This storage mode can be set using --cfg=storage/model:...
1119 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
1121 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
1123 /** \ingroup SURF_models
1124 * \brief The workstation model
1126 * Note that when you create an API on top of SURF,
1127 * the workstation model should be the only one you use
1128 * because depending on the platform model, the network model and the CPU model
1131 XBT_PUBLIC_DATA(surf_workstation_model_t) surf_workstation_model;
1133 /** \ingroup SURF_models
1134 * \brief The vm_workstation model
1136 * Note that when you create an API on top of SURF,
1137 * the vm_workstation model should be the only one you use
1138 * because depending on the platform model, the network model and the CPU model
1141 XBT_PUBLIC_DATA(surf_vm_workstation_model_t) surf_vm_workstation_model;
1143 /** \ingroup SURF_models
1144 * \brief Initializes the platform with a compound workstation model
1146 * This function should be called after a cpu_model and a
1147 * network_model have been set up.
1150 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
1152 /** \ingroup SURF_models
1153 * \brief Initializes the platform with the current best network and cpu models at hand
1155 * This platform model seperates the workstation model and the network model.
1156 * The workstation model will be initialized with the model compound, the network
1157 * model with the model LV08 (with cross traffic support) and the CPU model with
1159 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1162 XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
1164 /** \ingroup SURF_models
1165 * \brief Initializes the platform with the model KCCFLN05
1167 * With this model, only parallel tasks can be used. Resource sharing
1168 * is done by identifying bottlenecks and giving an equal share of
1169 * the model to each action.
1172 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
1174 /** \ingroup SURF_models
1175 * \brief The list of all available workstation model models
1177 XBT_PUBLIC_DATA(s_surf_model_description_t)
1178 surf_workstation_model_description[];
1180 /** \ingroup SURF_models
1181 * \brief Initializes the platform with the current best network and cpu models at hand
1183 * This platform model seperates the workstation model and the network model.
1184 * The workstation model will be initialized with the model compound, the network
1185 * model with the model LV08 (with cross traffic support) and the CPU model with
1187 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1190 XBT_PUBLIC(void) surf_vm_workstation_model_init_current_default(void);
1192 /** \ingroup SURF_models
1193 * \brief The list of all available vm workstation model models
1195 XBT_PUBLIC_DATA(s_surf_model_description_t)
1196 surf_vm_workstation_model_description[];
1198 /*******************************************/
1200 /** \ingroup SURF_models
1201 * \brief List of initialized models
1203 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
1204 XBT_PUBLIC_DATA(xbt_dynar_t) model_list_invoke;
1206 /** \ingroup SURF_simulation
1207 * \brief List of hosts that have juste restarted and whose autorestart process should be restarted.
1209 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
1211 /** \ingroup SURF_simulation
1212 * \brief List of hosts for which one want to be notified if they ever restart.
1214 XBT_PUBLIC(xbt_dict_t) watched_hosts_lib;
1216 /*******************************************/
1217 /*** SURF Platform *************************/
1218 /*******************************************/
1219 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
1220 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
1221 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
1222 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
1223 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
1224 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
1225 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
1226 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
1228 /*******************************************/
1229 /*** SURF Globals **************************/
1230 /*******************************************/
1232 /** \ingroup SURF_simulation
1233 * \brief Initialize SURF
1234 * \param argc argument number
1235 * \param argv arguments
1237 * This function has to be called to initialize the common
1238 * structures. Then you will have to create the environment by
1240 * e.g. surf_workstation_model_init_CM02()
1242 * \see surf_workstation_model_init_CM02(), surf_workstation_model_init_compound(), surf_exit()
1244 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
1246 /** \ingroup SURF_simulation
1247 * \brief Finish simulation initialization
1249 * This function must be called before the first call to surf_solve()
1251 XBT_PUBLIC(void) surf_presolve(void);
1253 /** \ingroup SURF_simulation
1254 * \brief Performs a part of the simulation
1255 * \param max_date Maximum date to update the simulation to, or -1
1256 * \return the elapsed time, or -1.0 if no event could be executed
1258 * This function execute all possible events, update the action states
1259 * and returns the time elapsed.
1260 * When you call execute or communicate on a model, the corresponding actions
1261 * are not executed immediately but only when you call surf_solve.
1262 * Note that the returned elapsed time can be zero.
1264 XBT_PUBLIC(double) surf_solve(double max_date);
1266 /** \ingroup SURF_simulation
1267 * \brief Return the current time
1269 * Return the current time in millisecond.
1271 XBT_PUBLIC(double) surf_get_clock(void);
1273 /** \ingroup SURF_simulation
1280 XBT_PUBLIC(void) surf_exit(void);
1282 /* Prototypes of the functions that handle the properties */
1283 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
1285 /* The same for model_prop set*/
1286 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
1288 /* surf parse file related (public because called from a test suite) */
1289 XBT_PUBLIC(void) parse_platform_file(const char *file);
1291 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
1292 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
1293 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
1294 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
1295 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
1296 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
1297 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
1300 XBT_PUBLIC(double) get_cpu_power(const char *power);
1302 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
1304 int surf_get_nthreads(void);
1305 void surf_set_nthreads(int nthreads);
1308 * Returns the initial path. On Windows the initial path is
1309 * the current directory for the current process in the other
1310 * case the function returns "./" that represents the current
1311 * directory on Unix/Linux platforms.
1313 const char *__surf_get_initial_path(void);
1315 /********** Tracing **********/
1316 /* from surf_instr.c */
1317 void TRACE_surf_action(surf_action_t surf_action, const char *category);
1318 void TRACE_surf_alloc(void);
1319 void TRACE_surf_release(void);
1321 /* instr_routing.c */
1322 void instr_routing_define_callbacks (void);
1323 void instr_new_variable_type (const char *new_typename, const char *color);
1324 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
1325 void instr_new_user_state_type (const char *father_type, const char *new_typename);
1326 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
1327 int instr_platform_traced (void);
1328 xbt_graph_t instr_routing_platform_graph (void);
1329 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1332 #endif /* _SURF_SURF_H */