1 /* Copyright (c) 2004-2014. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
11 #include "xbt/dynar.h"
13 #include "xbt/graph.h"
16 #include "xbt/config.h"
17 #include "surf/datatypes.h"
19 #include "surf/surf_routing.h"
20 #include "simgrid/platf_interface.h"
21 #include "simgrid/datatypes.h"
22 #include "simgrid/plugins.h"
25 /* Actions and models are highly connected structures... */
27 /* user-visible parameters */
28 extern double sg_tcp_gamma;
29 extern double sg_sender_gap;
30 extern double sg_latency_factor;
31 extern double sg_bandwidth_factor;
32 extern double sg_weight_S_parameter;
33 extern int sg_network_crosstraffic;
35 extern double sg_gtnets_jitter;
36 extern int sg_gtnets_jitter_seed;
38 extern xbt_dynar_t surf_path;
41 SURF_NETWORK_ELEMENT_NULL = 0, /* NULL */
42 SURF_NETWORK_ELEMENT_HOST, /* host type */
43 SURF_NETWORK_ELEMENT_ROUTER, /* router type */
44 SURF_NETWORK_ELEMENT_AS /* AS type */
45 } e_surf_network_element_type_t;
58 class NetworkCm02Link;
61 class StorageActionLmm;
66 typedef struct Model Model;
67 typedef struct CpuModel CpuModel;
68 typedef struct HostModel HostModel;
69 typedef struct VMModel VMModel;
70 typedef struct NetworkModel NetworkModel;
71 typedef struct StorageModel StorageModel;
72 typedef struct Resource Resource;
73 typedef struct ResourceLmm ResourceLmm;
74 typedef struct HostCLM03 HostCLM03;
75 typedef struct Host Host;
76 typedef struct NetworkCm02Link NetworkCm02Link;
77 typedef struct Action Action;
78 typedef struct ActionLmm ActionLmm;
79 typedef struct StorageActionLmm StorageActionLmm;
81 typedef struct RoutingEdge RoutingEdge;
82 typedef struct RoutingPlatf RoutingPlatf;
85 /** @ingroup SURF_c_bindings
86 * \brief Model datatype
88 * Generic data structure for a model. The hosts,
89 * the CPUs and the network links are examples of models.
91 typedef Model *surf_model_t;
92 typedef CpuModel *surf_cpu_model_t;
93 typedef HostModel *surf_host_model_t;
94 typedef VMModel *surf_vm_model_t;
96 typedef NetworkModel *surf_network_model_t;
97 typedef StorageModel *surf_storage_model_t;
99 typedef xbt_dictelm_t surf_resource_t;
100 typedef Resource *surf_cpp_resource_t;
101 typedef Host *surf_host_t;
102 typedef HostCLM03 *surf_host_CLM03_t;
103 typedef NetworkCm02Link *surf_network_link_t;
105 /** @ingroup SURF_c_bindings
106 * \brief Action structure
108 * Never create s_surf_action_t by yourself ! The actions are created
109 * on the fly when you call execute or communicate on a model.
111 * \see e_surf_action_state_t
113 typedef Action *surf_action_t;
116 typedef RoutingEdge *routing_edge_t;
117 typedef RoutingPlatf *routing_platf_t;
119 typedef struct surf_file *surf_file_t;
121 XBT_PUBLIC(e_surf_network_element_type_t)
122 routing_get_network_element_type(const char* name);
124 /** @Brief Specify that we use that action */
125 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
127 /** @brief Creates a new action.
129 * @param size The size is the one of the subtype you want to create
130 * @param cost initial value
131 * @param model to which model we should attach this action
132 * @param failed whether we should start this action in failed mode
134 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
135 surf_model_t model, int failed);
137 /** \brief Resource model description
139 typedef struct surf_model_description {
141 const char *description;
142 void_f_void_t model_init_preparse;
143 } s_surf_model_description_t, *surf_model_description_t;
145 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
147 XBT_PUBLIC(void) model_help(const char *category,
148 s_surf_model_description_t * table);
150 /** @ingroup SURF_interface
151 * @brief Action states
158 SURF_ACTION_READY = 0, /**< Ready */
159 SURF_ACTION_RUNNING, /**< Running */
160 SURF_ACTION_FAILED, /**< Task Failure */
161 SURF_ACTION_DONE, /**< Completed */
162 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
163 SURF_ACTION_NOT_IN_THE_SYSTEM
164 /**< Not in the system anymore. Why did you ask ? */
165 } e_surf_action_state_t;
167 /** @ingroup SURF_vm_interface
171 /* FIXME: Where should the VM state be defined? */
173 SURF_VM_STATE_CREATED, /**< created, but not yet started */
174 SURF_VM_STATE_RUNNING,
175 SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
177 SURF_VM_STATE_SAVING, /**< Save/restore involves disk I/O, so there should be transition states. */
179 SURF_VM_STATE_RESTORING,
182 /***************************/
183 /* Generic model object */
184 /***************************/
186 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
188 static inline surf_host_t surf_host_resource_priv(const void *host){
189 return (surf_host_t) xbt_lib_get_level((xbt_dictelm_t)host, SURF_HOST_LEVEL);
191 static inline void *surf_storage_resource_priv(const void *storage){
192 return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
195 static inline void *surf_storage_resource_by_name(const char *name){
196 return xbt_lib_get_elm_or_null(storage_lib, name);
200 XBT_PUBLIC(char *) surf_routing_edge_name(sg_routing_edge_t edge);
201 XBT_PUBLIC(void *) surf_as_cluster_get_backbone(AS_t as);
202 XBT_PUBLIC(void) surf_as_cluster_set_backbone(AS_t as, void* backbone);
204 /** @{ @ingroup SURF_c_bindings */
207 * @brief Get the name of a surf model
209 * @param model A model
210 * @return The name of the model
212 XBT_PUBLIC(const char *) surf_model_name(surf_model_t model);
215 * @brief Pop an action from the done actions set
217 * @param model The model from which the action is extracted
218 * @return An action in done state
220 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
223 * @brief Pop an action from the failed actions set
225 * @param model The model from which the action is extracted
226 * @return An action in failed state
228 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
231 * @brief Pop an action from the ready actions set
233 * @param model The model from which the action is extracted
234 * @return An action in ready state
236 XBT_PUBLIC(surf_action_t) surf_model_extract_ready_action_set(surf_model_t model);
239 * @brief Pop an action from the running actions set
241 * @param model The model from which the action is extracted
242 * @return An action in running state
244 XBT_PUBLIC(surf_action_t) surf_model_extract_running_action_set(surf_model_t model);
247 * @brief Get the size of the running action set of a model
249 * @param model The model
250 * @return The size of the running action set
252 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
255 * @brief Execute a parallel task
256 * @details [long description]
258 * @param model The model which handle the parallelisation
259 * @param host_nb The number of hosts
260 * @param host_list The list of hosts on which the task is executed
261 * @param flops_amount The processing amount (in flop) needed to process
262 * @param bytes_amount The amount of data (in bytes) needed to transfer
263 * @param rate [description]
264 * @return The action corresponding to the parallele execution task
266 XBT_PUBLIC(surf_action_t) surf_host_model_execute_parallel_task(surf_host_model_t model,
269 double *flops_amount,
270 double *bytes_amount,
274 * @brief Create a communication between two hosts
276 * @param model The model which handle the communication
277 * @param src The source host
278 * @param dst The destination host
279 * @param size The amount of data (in bytes) needed to transfer
280 * @param rate [description]
281 * @return The action corresponding to the communication
283 XBT_PUBLIC(surf_action_t) surf_host_model_communicate(surf_host_model_t model, surf_resource_t src, surf_resource_t dst, double size, double rate);
286 * @brief Get the route between two hosts
287 * @details [long description]
289 * @param model The model which handle the routes
290 * @param src The source host
291 * @param dst The destination host
292 * @return The list of [TODO] from the source to the host
294 XBT_PUBLIC(xbt_dynar_t) surf_host_model_get_route(surf_host_model_t model, surf_resource_t src, surf_resource_t dst);
297 * @brief Create a new VM on the specified host
299 * @param name The name of the VM
300 * @param host_PM The host on which the VM is created
302 XBT_PUBLIC(void) surf_vm_model_create(const char *name, surf_resource_t host_PM);
305 * @brief Create a communication between two routing edges [TODO]
306 * @details [long description]
308 * @param model The model which handle the communication
309 * @param src The source host
310 * @param dst The destination host
311 * @param size The amount of data (in bytes) needed to transfer
312 * @param rate [description]
313 * @return The action corresponding to the communication
315 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);
318 * @brief Get the name of a surf resource (cpu, host, network, …)
320 * @param resource The surf resource
321 * @return The name of the surf resource
323 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
324 static inline const char * surf_cpu_name(surf_cpu_t cpu) {
325 return surf_resource_name((surf_cpp_resource_t)cpu);
329 * @brief Get the properties of a surf resource (cpu, host, network, …)
331 * @param resource The surf resource
332 * @return The properties of the surf resource
334 XBT_PUBLIC(xbt_dict_t) surf_resource_get_properties(surf_cpp_resource_t resource);
335 static XBT_INLINE xbt_dict_t surf_host_get_properties(surf_host_t host) {
336 return surf_resource_get_properties((surf_cpp_resource_t)host);
341 * @brief Get the state of a surf resource (cpu, host, network, …)
343 * @param resource The surf resource
344 * @return The state of the surf resource
346 XBT_PUBLIC(e_surf_resource_state_t) surf_resource_get_state(surf_cpp_resource_t resource);
348 static XBT_INLINE e_surf_resource_state_t surf_host_get_state(surf_host_t host) {
349 return surf_resource_get_state((surf_cpp_resource_t)host);
354 * @brief Set the state of a surf resource (cpu, host, network, …)
356 * @param resource The surf resource
357 * @param state The new state of the surf resource
359 XBT_PUBLIC(void) surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state);
360 static inline void surf_host_set_state(surf_host_t host, e_surf_resource_state_t state) {
361 surf_resource_set_state((surf_cpp_resource_t)host, state);
365 * @brief Get the speed of the cpu associated to a host
367 * @param resource The surf host
368 * @param load [description]
370 * @return [description]
372 XBT_PUBLIC(double) surf_host_get_speed(surf_resource_t resource, double load);
375 * @brief Get the available speed of cpu associated to a host
377 * @param resource The surf host
378 * @return [description]
380 XBT_PUBLIC(double) surf_host_get_available_speed(surf_resource_t resource);
383 * @brief Get the number of cores of the cpu associated to a host
385 * @param resource The surf host
386 * @return The number of cores
388 XBT_PUBLIC(int) surf_host_get_core(surf_resource_t resource);
391 * @brief Execute some quantity of computation
393 * @param resource The surf host
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_host_execute(surf_resource_t resource, double size);
401 * @brief Make the host sleep
403 * @param resource The surf host
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_host_sleep(surf_resource_t resource, double duration);
410 * @brief Open a file on an host
412 * @param host The surf host
413 * @param fullpath The path to the file
414 * @return The surf action corresponding to the openning
416 XBT_PUBLIC(surf_action_t) surf_host_open(surf_resource_t host, const char* fullpath);
419 * @brief Close a file descriptor on an host
421 * @param host The surf host
422 * @param fd The file descriptor
424 * @return The surf action corresponding to the closing
426 XBT_PUBLIC(surf_action_t) surf_host_close(surf_resource_t host, surf_file_t fd);
431 * @param host The surf host
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_host_read(surf_resource_t host, surf_file_t fd, sg_size_t size);
439 * @brief Write a file
441 * @param host The surf host
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_host_write(surf_resource_t host, 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 host The surf host
458 * @param fd The file descriptor
459 * @return An xbt_dynar_t with the file informations
461 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(surf_resource_t host, surf_file_t fd);
464 * @brief Get the available space of the storage at the mount point
466 * @param resource The surf host
467 * @param name The mount point
468 * @return The amount of available space in bytes
470 XBT_PUBLIC(sg_size_t) surf_host_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 host
476 * @param name The mount point
477 * @return The amount of used space in bytes
479 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(surf_resource_t resource, const char* name);
482 * @brief Get the VMs hosted on the host
484 * @param resource The surf host
485 * @return The list of VMs on the host
487 XBT_PUBLIC(xbt_dynar_t) surf_host_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_host_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_host_set_params(surf_resource_t resource, ws_params_t params);
508 * @brief Destroy a VM
510 * @param resource The surf vm
512 XBT_PUBLIC(void) surf_vm_destroy(surf_resource_t resource);
515 * @brief Suspend a VM
517 * @param resource The surf vm
519 XBT_PUBLIC(void) surf_vm_suspend(surf_resource_t resource);
524 * @param resource The surf vm
526 XBT_PUBLIC(void) surf_vm_resume(surf_resource_t resource);
529 * @brief Save the VM (Not yet implemented)
531 * @param resource The surf vm
533 XBT_PUBLIC(void) surf_vm_save(surf_resource_t resource);
536 * @brief Restore the VM (Not yet implemented)
538 * @param resource The surf vm
540 XBT_PUBLIC(void) surf_vm_restore(surf_resource_t resource);
543 * @brief Migrate the VM to the destination host
545 * @param resource The surf vm
546 * @param ind_vm_ws_dest The destination host
548 XBT_PUBLIC(void) surf_vm_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 vm
554 * @return The physical machine hosting the VM
556 XBT_PUBLIC(surf_resource_t) surf_vm_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_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_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 host power peak
598 * @details [long description]
600 * @param host The surf host
601 * @return The power peak
603 XBT_PUBLIC(double) surf_host_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_host_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_host_get_nb_pstates(surf_resource_t host);
625 XBT_PUBLIC(void) surf_host_set_pstate(surf_resource_t host, int pstate_index);
626 XBT_PUBLIC(int) surf_host_get_pstate(surf_resource_t host);
627 XBT_PUBLIC(double) surf_host_get_wattmin_at(surf_resource_t resource, int pstate);
628 XBT_PUBLIC(double) surf_host_get_wattmax_at(surf_resource_t resource, int pstate);
631 * @brief Get the consumed energy (in joules) of an host
633 * @param host The surf host
634 * @return The consumed energy
636 XBT_PUBLIC(double) surf_host_get_consumed_energy(surf_resource_t host);
639 * @brief Get the list of storages mounted on an host
641 * @param host The surf host
642 * @return Dictionary of mount point, Storage
644 XBT_PUBLIC(xbt_dict_t) surf_host_get_mounted_storage_list(surf_resource_t host);
647 * @brief Get the list of storages attached to an host
649 * @param host The surf host
650 * @return Dictionary of storage
652 XBT_PUBLIC(xbt_dynar_t) surf_host_get_attached_storage_list(surf_resource_t host);
655 * @brief Unlink a file descriptor
657 * @param host The surf host
658 * @param fd The file descriptor
660 * @return 0 if failed to unlink, 1 otherwise
662 XBT_PUBLIC(int) surf_host_unlink(surf_resource_t host, surf_file_t fd);
665 * @brief Get the size of a file on a host
667 * @param host The surf host
668 * @param fd The file descriptor
670 * @return The size in bytes of the file
672 XBT_PUBLIC(size_t) surf_host_get_size(surf_resource_t host, surf_file_t fd);
675 * @brief Get the current position of the file descriptor
677 * @param host The surf host
678 * @param fd The file descriptor
679 * @return The current position of the file descriptor
681 XBT_PUBLIC(size_t) surf_host_file_tell(surf_resource_t host, surf_file_t fd);
684 * @brief Move a file to another location on the *same mount point*.
685 * @details [long description]
687 * @param host The surf host
688 * @param fd The file descriptor
689 * @param fullpath The new full path
691 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
693 XBT_PUBLIC(int) surf_host_file_move(surf_resource_t host, surf_file_t fd, const char* fullpath);
696 * @brief Set the position indictator assiociated with the file descriptor to a new position
697 * @details [long description]
699 * @param host The surf host
700 * @param fd The file descriptor
701 * @param offset The offset from the origin
702 * @param origin Position used as a reference for the offset
703 * - SEEK_SET: beginning of the file
704 * - SEEK_CUR: current position indicator
705 * - SEEK_END: end of the file
706 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
708 XBT_PUBLIC(int) surf_host_file_seek(surf_resource_t host,
709 surf_file_t fd, sg_offset_t offset,
713 * @brief [brief description]
714 * @details [long description]
716 * @param link [description]
717 * @return [description]
719 XBT_PUBLIC(int) surf_network_link_is_shared(surf_cpp_resource_t link);
722 * @brief Get the bandwidth of a link in bytes per second
724 * @param link The surf link
725 * @return The bandwidth in bytes per second
727 XBT_PUBLIC(double) surf_network_link_get_bandwidth(surf_cpp_resource_t link);
730 * @brief Get the latency of a link in seconds
732 * @param link The surf link
733 * @return The latency in seconds
735 XBT_PUBLIC(double) surf_network_link_get_latency(surf_cpp_resource_t link);
738 * @brief Get the content of a storage
740 * @param resource The surf storage
741 * @return A xbt_dict_t with path as keys and size in bytes as values
743 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
746 * @brief Get the size in bytes of a storage
748 * @param resource The surf storage
749 * @return The size in bytes of the storage
751 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
754 * @brief Get the available size in bytes of a storage
756 * @param resource The surf storage
757 * @return The available size in bytes of the storage
759 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
762 * @brief Get the size in bytes of a storage
764 * @param resource The surf storage
765 * @return The used size in bytes of the storage
767 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
771 * @brief Get the data associated to the action
773 * @param action The surf action
774 * @return The data associated to the action
776 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
779 * @brief Set the data associated to the action
780 * @details [long description]
782 * @param action The surf action
783 * @param data The new data associated to the action
785 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
788 * @brief Unreference an action
790 * @param action The surf action
792 XBT_PUBLIC(void) surf_action_unref(surf_action_t action);
795 * @brief Get the start time of an action
797 * @param action The surf action
798 * @return The start time in seconds from the beginning of the simulation
800 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
803 * @brief Get the finish time of an action
805 * @param action The surf action
806 * @return The finish time in seconds from the beginning of the simulation
808 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
811 * @brief Get the remains amount of work to do of an action
813 * @param action The surf action
814 * @return The remains amount of work to do
816 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
819 * @brief Suspend an action
821 * @param action The surf action
823 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
826 * @brief Resume an action
828 * @param action The surf action
830 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
833 * @brief Cancel an action
835 * @param action The surf action
837 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
840 * @brief Set the priority of an action
841 * @details [long description]
843 * @param action The surf action
844 * @param priority The new priority [TODO]
846 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
849 * @brief Set the category of an action
850 * @details [long description]
852 * @param action The surf action
853 * @param category The new category of the action
855 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
858 * @brief Get the state of an action
860 * @param action The surf action
861 * @return The state of the action
863 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
866 * @brief Get the cost of an action
868 * @param action The surf action
869 * @return The cost of the action
871 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
874 * @brief [brief desrciption]
875 * @details [long description]
877 * @param action The surf cpu action
878 * @param cpu [description]
879 * @param mask [description]
881 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask);
884 * @brief [brief description]
885 * @details [long description]
887 * @param action The surf cpu action
888 * @param bound [description]
890 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
893 * @brief [brief description]
894 * @details [long description]
896 * @param action The surf network action
898 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
901 * @brief Get the file associated to a storage action
903 * @param action The surf storage action
904 * @return The file associated to a storage action
906 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
909 * @brief Get the result dictionary of an ls action
911 * @param action The surf storage action
912 * @return The dictionry listing a path
914 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
918 * @brief Get the host the storage is attached to
920 * @param resource The surf storage
921 * @return The host name
923 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
925 XBT_PUBLIC(surf_model_t) surf_resource_model(const void *host, int level);
929 /**************************************/
930 /* Implementations of model object */
931 /**************************************/
933 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
934 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
936 /** \ingroup SURF_models
937 * \brief The CPU model object for the physical machine layer
939 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
941 /** \ingroup SURF_models
942 * \brief The CPU model object for the virtual machine layer
944 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
947 /** \ingroup SURF_models
948 * \brief Initializes the CPU model with the model Cas01
950 * By default, this model uses the lazy optimization mechanism that
951 * relies on partial invalidation in LMM and a heap for lazy action update.
952 * You can change this behavior by setting the cpu/optim configuration
953 * variable to a different value.
955 * You shouldn't have to call it by yourself.
957 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
959 /** \ingroup SURF_models
960 * \brief Initializes the CPU model with trace integration [Deprecated]
962 * You shouldn't have to call it by yourself.
964 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
966 /** \ingroup SURF_models
967 * \brief The list of all available optimization modes (both for cpu and networks).
968 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
970 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
972 /** \ingroup SURF_plugins
973 * \brief The list of all available surf plugins
975 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
977 /** \ingroup SURF_models
978 * \brief The list of all available cpu model models
980 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
982 /**\brief create new host bypass the parser
987 /** \ingroup SURF_models
988 * \brief The network model
990 * When creating a new API on top on SURF, you shouldn't use the
991 * network model unless you know what you are doing. Only the host
992 * model should be accessed because depending on the platform model,
993 * the network model can be NULL.
995 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
997 /** \ingroup SURF_models
998 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
1000 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
1001 * based on the model 'LV08' and different correction factors depending on the communication
1002 * size (< 1KiB, < 64KiB, >= 64KiB).
1003 * See comments in the code for more information.
1005 * \see surf_host_model_init_SMPI()
1007 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
1009 /** \ingroup SURF_models
1010 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
1012 * This model impelments a variant of the contention model on Infinband networks based on
1013 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
1015 * \see surf_host_model_init_IB()
1017 XBT_PUBLIC(void) surf_network_model_init_IB(void);
1019 /** \ingroup SURF_models
1020 * \brief Initializes the platform with the network model 'LegrandVelho'
1022 * This model is proposed by Arnaud Legrand and Pedro Velho based on
1023 * the results obtained with the GTNets simulator for onelink and
1024 * dogbone sharing scenarios. See comments in the code for more information.
1026 * \see surf_host_model_init_LegrandVelho()
1028 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
1030 /** \ingroup SURF_models
1031 * \brief Initializes the platform with the network model 'Constant'
1033 * In this model, the communication time between two network cards is
1034 * constant, hence no need for a routing table. This is particularly
1035 * usefull when simulating huge distributed algorithms where
1036 * scalability is really an issue. This function is called in
1037 * conjunction with surf_host_model_init_compound.
1039 * \see surf_host_model_init_compound()
1041 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
1043 /** \ingroup SURF_models
1044 * \brief Initializes the platform with the network model CM02
1046 * You sould call this function by yourself only if you plan using
1047 * surf_host_model_init_compound.
1048 * See comments in the code for more information.
1050 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
1053 /** \ingroup SURF_models
1054 * \brief Initializes the platform with the network model GTNETS
1055 * \param filename XML platform file name
1057 * This function is called by surf_host_model_init_GTNETS
1058 * or by yourself only if you plan using surf_host_model_init_compound
1060 * \see surf_host_model_init_GTNETS()
1062 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
1066 /** \ingroup SURF_models
1067 * \brief Initializes the platform with the network model NS3
1068 * \param filename XML platform file name
1070 * This function is called by surf_host_model_init_NS3
1071 * or by yourself only if you plan using surf_host_model_init_compound
1073 * \see surf_host_model_init_NS3()
1075 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
1078 /** \ingroup SURF_models
1079 * \brief Initializes the platform with the network model Reno
1080 * \param filename XML platform file name
1082 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
1085 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1086 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1088 * Call this function only if you plan using surf_host_model_init_compound.
1091 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
1093 /** \ingroup SURF_models
1094 * \brief Initializes the platform with the network model Reno2
1095 * \param filename XML platform file name
1097 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
1100 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
1101 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1103 * Call this function only if you plan using surf_host_model_init_compound.
1106 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
1108 /** \ingroup SURF_models
1109 * \brief Initializes the platform with the network model Vegas
1110 * \param filename XML platform file name
1112 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
1113 * to the proportional fairness.
1116 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1117 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1119 * Call this function only if you plan using surf_host_model_init_compound.
1122 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
1124 /** \ingroup SURF_models
1125 * \brief The list of all available network model models
1127 XBT_PUBLIC_DATA(s_surf_model_description_t)
1128 surf_network_model_description[];
1130 /** \ingroup SURF_models
1131 * \brief The storage model
1133 XBT_PUBLIC(void) surf_storage_model_init_default(void);
1135 /** \ingroup SURF_models
1136 * \brief The list of all available storage modes.
1137 * This storage mode can be set using --cfg=storage/model:...
1139 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
1141 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
1143 /** \ingroup SURF_models
1144 * \brief The host model
1146 * Note that when you create an API on top of SURF,
1147 * the host model should be the only one you use
1148 * because depending on the platform model, the network model and the CPU model
1151 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
1153 /** \ingroup SURF_models
1154 * \brief The vm model
1156 * Note that when you create an API on top of SURF,
1157 * the vm model should be the only one you use
1158 * because depending on the platform model, the network model and the CPU model
1161 XBT_PUBLIC_DATA(surf_vm_model_t) surf_vm_model;
1163 /** \ingroup SURF_models
1164 * \brief Initializes the platform with a compound host model
1166 * This function should be called after a cpu_model and a
1167 * network_model have been set up.
1170 XBT_PUBLIC(void) surf_host_model_init_compound(void);
1172 /** \ingroup SURF_models
1173 * \brief Initializes the platform with the current best network and cpu models at hand
1175 * This platform model separates the host model and the network model.
1176 * The host model will be initialized with the model compound, the network
1177 * model with the model LV08 (with cross traffic support) and the CPU model with
1179 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1182 XBT_PUBLIC(void) surf_host_model_init_current_default(void);
1184 /** \ingroup SURF_models
1185 * \brief Initializes the platform with the model L07
1187 * With this model, only parallel tasks can be used. Resource sharing
1188 * is done by identifying bottlenecks and giving an equal share of
1189 * the model to each action.
1192 XBT_PUBLIC(void) surf_host_model_init_ptask_L07(void);
1194 /** \ingroup SURF_models
1195 * \brief The list of all available host model models
1197 XBT_PUBLIC_DATA(s_surf_model_description_t)
1198 surf_host_model_description[];
1200 /** \ingroup SURF_models
1201 * \brief Initializes the platform with the current best network and cpu models at hand
1203 * This platform model seperates the host model and the network model.
1204 * The host model will be initialized with the model compound, the network
1205 * model with the model LV08 (with cross traffic support) and the CPU model with
1207 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1210 XBT_PUBLIC(void) surf_vm_model_init_HL13(void);
1212 /** \ingroup SURF_models
1213 * \brief The list of all available vm model models
1215 XBT_PUBLIC_DATA(s_surf_model_description_t)
1216 surf_vm_model_description[];
1218 /*******************************************/
1220 /** \ingroup SURF_models
1221 * \brief List of initialized models
1223 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
1224 XBT_PUBLIC_DATA(xbt_dynar_t) model_list_invoke;
1226 /** \ingroup SURF_simulation
1227 * \brief List of hosts that have juste restarted and whose autorestart process should be restarted.
1229 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
1231 /** \ingroup SURF_simulation
1232 * \brief List of hosts for which one want to be notified if they ever restart.
1234 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
1236 /*******************************************/
1237 /*** SURF Platform *************************/
1238 /*******************************************/
1239 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
1240 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
1241 XBT_PUBLIC_DATA(AS_t) surf_AS_get_by_name(const char * name);
1242 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
1243 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
1244 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
1245 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
1246 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
1247 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
1249 /*******************************************/
1250 /*** SURF Globals **************************/
1251 /*******************************************/
1253 /** \ingroup SURF_simulation
1254 * \brief Initialize SURF
1255 * \param argc argument number
1256 * \param argv arguments
1258 * This function has to be called to initialize the common
1259 * structures. Then you will have to create the environment by
1261 * e.g. surf_host_model_init_CM02()
1263 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
1265 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
1267 /** \ingroup SURF_simulation
1268 * \brief Finish simulation initialization
1270 * This function must be called before the first call to surf_solve()
1272 XBT_PUBLIC(void) surf_presolve(void);
1274 /** \ingroup SURF_simulation
1275 * \brief Performs a part of the simulation
1276 * \param max_date Maximum date to update the simulation to, or -1
1277 * \return the elapsed time, or -1.0 if no event could be executed
1279 * This function execute all possible events, update the action states
1280 * and returns the time elapsed.
1281 * When you call execute or communicate on a model, the corresponding actions
1282 * are not executed immediately but only when you call surf_solve.
1283 * Note that the returned elapsed time can be zero.
1285 XBT_PUBLIC(double) surf_solve(double max_date);
1287 /** \ingroup SURF_simulation
1288 * \brief Return the current time
1290 * Return the current time in millisecond.
1292 XBT_PUBLIC(double) surf_get_clock(void);
1294 /** \ingroup SURF_simulation
1301 XBT_PUBLIC(void) surf_exit(void);
1303 /* Prototypes of the functions that handle the properties */
1304 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
1306 /* The same for model_prop set*/
1307 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
1309 /* surf parse file related (public because called from a test suite) */
1310 XBT_PUBLIC(void) parse_platform_file(const char *file);
1312 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
1313 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
1314 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
1315 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
1316 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
1317 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
1318 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
1321 XBT_PUBLIC(double) get_cpu_power(const char *power);
1323 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
1325 int surf_get_nthreads(void);
1326 void surf_set_nthreads(int nthreads);
1329 * Returns the initial path. On Windows the initial path is
1330 * the current directory for the current process in the other
1331 * case the function returns "./" that represents the current
1332 * directory on Unix/Linux platforms.
1334 const char *__surf_get_initial_path(void);
1336 /********** Tracing **********/
1337 /* from surf_instr.c */
1338 void TRACE_surf_action(surf_action_t surf_action, const char *category);
1339 void TRACE_surf_alloc(void);
1340 void TRACE_surf_release(void);
1342 /* instr_routing.c */
1343 void instr_routing_define_callbacks (void);
1344 void instr_new_variable_type (const char *new_typename, const char *color);
1345 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
1346 void instr_new_user_state_type (const char *father_type, const char *new_typename);
1347 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
1348 int instr_platform_traced (void);
1349 xbt_graph_t instr_routing_platform_graph (void);
1350 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1353 #endif /* _SURF_SURF_H */