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;
103 /** @ingroup SURF_c_bindings
104 * \brief Action structure
106 * Never create s_surf_action_t by yourself ! The actions are created
107 * on the fly when you call execute or communicate on a model.
109 * \see e_surf_action_state_t
111 typedef Action *surf_action_t;
114 typedef RoutingEdge *routing_edge_t;
115 typedef RoutingPlatf *routing_platf_t;
117 typedef struct surf_file *surf_file_t;
119 XBT_PUBLIC(e_surf_network_element_type_t)
120 routing_get_network_element_type(const char* name);
122 /** @Brief Specify that we use that action */
123 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
125 /** @brief Creates a new action.
127 * @param size The size is the one of the subtype you want to create
128 * @param cost initial value
129 * @param model to which model we should attach this action
130 * @param failed whether we should start this action in failed mode
132 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
133 surf_model_t model, int failed);
135 /** \brief Resource model description
137 typedef struct surf_model_description {
139 const char *description;
140 void_f_void_t model_init_preparse;
141 } s_surf_model_description_t, *surf_model_description_t;
143 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
145 XBT_PUBLIC(void) model_help(const char *category,
146 s_surf_model_description_t * table);
148 /** @ingroup SURF_interface
149 * @brief Action states
156 SURF_ACTION_READY = 0, /**< Ready */
157 SURF_ACTION_RUNNING, /**< Running */
158 SURF_ACTION_FAILED, /**< Task Failure */
159 SURF_ACTION_DONE, /**< Completed */
160 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
161 SURF_ACTION_NOT_IN_THE_SYSTEM /**< Not in the system anymore. Why did you ask ? */
162 } e_surf_action_state_t;
164 /** @ingroup SURF_vm_interface
168 /* FIXME: Where should the VM state be defined? */
170 SURF_VM_STATE_CREATED, /**< created, but not yet started */
171 SURF_VM_STATE_RUNNING,
172 SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
174 SURF_VM_STATE_SAVING, /**< Save/restore involves disk I/O, so there should be transition states. */
176 SURF_VM_STATE_RESTORING,
179 /***************************/
180 /* Generic model object */
181 /***************************/
183 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
185 static inline surf_host_t surf_host_resource_priv(const void *host){
186 return (surf_host_t) xbt_lib_get_level((xbt_dictelm_t)host, SURF_HOST_LEVEL);
188 static inline void *surf_storage_resource_priv(const void *storage){
189 return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
192 static inline void *surf_storage_resource_by_name(const char *name){
193 return xbt_lib_get_elm_or_null(storage_lib, name);
196 XBT_PUBLIC(void *) surf_as_cluster_get_backbone(AS_t as);
197 XBT_PUBLIC(void) surf_as_cluster_set_backbone(AS_t as, void* backbone);
199 /** @{ @ingroup SURF_c_bindings */
201 /** @brief Get the name of a surf model (dont rely on exact value)
203 * This is implemented using typeid(), so it may change with the compiler
205 XBT_PUBLIC(const char *) surf_model_name(surf_model_t model);
208 * @brief Pop an action from the done actions set
210 * @param model The model from which the action is extracted
211 * @return An action in done state
213 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
216 * @brief Pop an action from the failed actions set
218 * @param model The model from which the action is extracted
219 * @return An action in failed state
221 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
224 * @brief Pop an action from the ready actions set
226 * @param model The model from which the action is extracted
227 * @return An action in ready state
229 XBT_PUBLIC(surf_action_t) surf_model_extract_ready_action_set(surf_model_t model);
232 * @brief Pop an action from the running actions set
234 * @param model The model from which the action is extracted
235 * @return An action in running state
237 XBT_PUBLIC(surf_action_t) surf_model_extract_running_action_set(surf_model_t model);
240 * @brief Get the size of the running action set of a model
242 * @param model The model
243 * @return The size of the running action set
245 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
248 * @brief Execute a parallel task
249 * @details [long description]
251 * @param model The model which handle the parallelisation
252 * @param host_nb The number of hosts
253 * @param host_list The list of hosts on which the task is executed
254 * @param flops_amount The processing amount (in flop) needed to process
255 * @param bytes_amount The amount of data (in bytes) needed to transfer
256 * @param rate [description]
257 * @return The action corresponding to the parallele execution task
259 XBT_PUBLIC(surf_action_t) surf_host_model_execute_parallel_task(surf_host_model_t model,
262 double *flops_amount,
263 double *bytes_amount,
267 * @brief Get the route between two hosts
268 * @details [long description]
270 * @param model The model which handle the routes
271 * @param src The source host
272 * @param dst The destination host
273 * @return The list of [TODO] from the source to the host
275 XBT_PUBLIC(xbt_dynar_t) surf_host_model_get_route(surf_host_model_t model, surf_resource_t src, surf_resource_t dst);
278 * @brief Create a new VM on the specified host
280 * @param name The name of the VM
281 * @param host_PM The host on which the VM is created
283 XBT_PUBLIC(void) surf_vm_model_create(const char *name, surf_resource_t host_PM);
286 * @brief Create a communication between two routing edges
288 * @param model The model which handle the communication
289 * @param src The source host
290 * @param dst The destination host
291 * @param size The amount of data (in bytes) needed to transfer
292 * @param rate [description]
293 * @return The action corresponding to the communication
295 XBT_PUBLIC(surf_action_t) surf_network_model_communicate(surf_network_model_t model, sg_host_t src, sg_host_t dst, double size, double rate);
298 * @brief Get the name of a surf resource (cpu, host, network, …)
300 * @param resource The surf resource
301 * @return The name of the surf resource
303 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
304 static inline const char * surf_cpu_name(surf_cpu_t cpu) {
305 return surf_resource_name((surf_cpp_resource_t)cpu);
309 * @brief Get the properties of a surf resource (cpu, host, network, …)
311 * @param resource The surf resource
312 * @return The properties of the surf resource
314 XBT_PUBLIC(xbt_dict_t) surf_resource_get_properties(surf_cpp_resource_t resource);
315 static XBT_INLINE xbt_dict_t surf_host_get_properties(surf_host_t host) {
316 return surf_resource_get_properties((surf_cpp_resource_t)host);
321 * @brief Get the state of a surf resource (cpu, host, network, …)
323 * @param resource The surf resource
324 * @return The state of the surf resource
326 XBT_PUBLIC(e_surf_resource_state_t) surf_resource_get_state(surf_cpp_resource_t resource);
328 static XBT_INLINE e_surf_resource_state_t surf_host_get_state(surf_host_t host) {
329 return surf_resource_get_state((surf_cpp_resource_t)host);
334 * @brief Set the state of a surf resource (cpu, host, network, …)
336 * @param resource The surf resource
337 * @param state The new state of the surf resource
339 XBT_PUBLIC(void) surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state);
340 static inline void surf_host_set_state(surf_host_t host, e_surf_resource_state_t state) {
341 surf_resource_set_state((surf_cpp_resource_t)host, state);
345 * @brief Get the speed of the cpu associated to a host
347 * @param resource The surf host
348 * @param load [description]
350 * @return [description]
352 XBT_PUBLIC(double) surf_host_get_speed(surf_resource_t resource, double load);
355 * @brief Get the available speed of cpu associated to a host
357 * @param resource The surf host
358 * @return [description]
360 XBT_PUBLIC(double) surf_host_get_available_speed(surf_resource_t resource);
363 * @brief Get the number of cores of the cpu associated to a host
365 * @param resource The surf host
366 * @return The number of cores
368 XBT_PUBLIC(int) surf_host_get_core(surf_resource_t resource);
371 * @brief Execute some quantity of computation
373 * @param resource The surf host
374 * @param size The value of the processing amount (in flop) needed to process
376 * @return The surf action corresponding to the processing
378 XBT_PUBLIC(surf_action_t) surf_host_execute(surf_resource_t resource, double size);
381 * @brief Make the host sleep
383 * @param resource The surf host
384 * @param duration The number of seconds to sleep
385 * @return The surf action corresponding to the sleep
387 XBT_PUBLIC(surf_action_t) surf_host_sleep(surf_resource_t resource, double duration);
390 * @brief Open a file on an host
392 * @param host The surf host
393 * @param fullpath The path to the file
394 * @return The surf action corresponding to the openning
396 XBT_PUBLIC(surf_action_t) surf_host_open(surf_resource_t host, const char* fullpath);
399 * @brief Close a file descriptor on an host
401 * @param host The surf host
402 * @param fd The file descriptor
404 * @return The surf action corresponding to the closing
406 XBT_PUBLIC(surf_action_t) surf_host_close(surf_resource_t host, surf_file_t fd);
411 * @param host The surf host
412 * @param fd The file descriptor to read
413 * @param size The size in bytes to read
414 * @return The surf action corresponding to the reading
416 XBT_PUBLIC(surf_action_t) surf_host_read(surf_resource_t host, surf_file_t fd, sg_size_t size);
419 * @brief Write a file
421 * @param host The surf host
422 * @param fd The file descriptor to write
423 * @param size The size in bytes to write
424 * @return The surf action corresponding to the writing
426 XBT_PUBLIC(surf_action_t) surf_host_write(surf_resource_t host, surf_file_t fd, sg_size_t size);
429 * @brief Get the informations of a file descriptor
430 * @details The returned xbt_dynar_t contains:
431 * - the size of the file,
433 * - the storage name,
434 * - the storage typeId,
435 * - the storage content type
437 * @param host The surf host
438 * @param fd The file descriptor
439 * @return An xbt_dynar_t with the file informations
441 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(surf_resource_t host, surf_file_t fd);
444 * @brief Get the available space of the storage at the mount point
446 * @param resource The surf host
447 * @param name The mount point
448 * @return The amount of available space in bytes
450 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(surf_resource_t resource, const char* name);
453 * @brief Get the used space of the storage at the mount point
455 * @param resource The surf host
456 * @param name The mount point
457 * @return The amount of used space in bytes
459 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(surf_resource_t resource, const char* name);
462 * @brief Get the VMs hosted on the host
464 * @param resource The surf host
465 * @return The list of VMs on the host
467 XBT_PUBLIC(xbt_dynar_t) surf_host_get_vms(surf_resource_t resource);
470 * @brief [brief description]
471 * @details [long description]
473 * @param resource [description]
474 * @param params [description]
476 XBT_PUBLIC(void) surf_host_get_params(surf_resource_t resource, ws_params_t params);
479 * @brief [brief description]
480 * @details [long description]
482 * @param resource [description]
483 * @param params [description]
485 XBT_PUBLIC(void) surf_host_set_params(surf_resource_t resource, ws_params_t params);
488 * @brief Destroy a VM
490 * @param resource The surf vm
492 XBT_PUBLIC(void) surf_vm_destroy(surf_resource_t resource);
495 * @brief Suspend a VM
497 * @param resource The surf vm
499 XBT_PUBLIC(void) surf_vm_suspend(surf_resource_t resource);
504 * @param resource The surf vm
506 XBT_PUBLIC(void) surf_vm_resume(surf_resource_t resource);
509 * @brief Save the VM (Not yet implemented)
511 * @param resource The surf vm
513 XBT_PUBLIC(void) surf_vm_save(surf_resource_t resource);
516 * @brief Restore the VM (Not yet implemented)
518 * @param resource The surf vm
520 XBT_PUBLIC(void) surf_vm_restore(surf_resource_t resource);
523 * @brief Migrate the VM to the destination host
525 * @param resource The surf vm
526 * @param ind_vm_ws_dest The destination host
528 XBT_PUBLIC(void) surf_vm_migrate(surf_resource_t resource, surf_resource_t ind_vm_ws_dest);
531 * @brief Get the physical machine hosting the VM
533 * @param resource The surf vm
534 * @return The physical machine hosting the VM
536 XBT_PUBLIC(surf_resource_t) surf_vm_get_pm(surf_resource_t resource);
539 * @brief [brief description]
540 * @details [long description]
542 * @param resource [description]
543 * @param bound [description]
545 XBT_PUBLIC(void) surf_vm_set_bound(surf_resource_t resource, double bound);
548 * @brief [brief description]
549 * @details [long description]
551 * @param resource [description]
552 * @param cpu [description]
553 * @param mask [description]
555 XBT_PUBLIC(void) surf_vm_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask);
558 * @brief Execute some quantity of computation
560 * @param cpu The surf cpu
561 * @param size The value of the processing amount (in flop) needed to process
562 * @return The surf action corresponding to the processing
564 XBT_PUBLIC(surf_action_t) surf_cpu_execute(surf_resource_t cpu, double size);
567 * @brief Make the cpu sleep for duration (in seconds)
568 * @details [long description]
570 * @param cpu The surf cpu
571 * @param duration The number of seconds to sleep
572 * @return The surf action corresponding to the sleeping
574 XBT_PUBLIC(surf_action_t) surf_cpu_sleep(surf_resource_t cpu, double duration);
577 * @brief Get the host power peak
578 * @details [long description]
580 * @param host The surf host
581 * @return The power peak
583 XBT_PUBLIC(double) surf_host_get_current_power_peak(surf_resource_t host);
586 * @brief [brief description]
587 * @details [long description]
589 * @param host [description]
590 * @param pstate_index [description]
592 * @return [description]
594 XBT_PUBLIC(double) surf_host_get_power_peak_at(surf_resource_t host, int pstate_index);
597 * @brief [brief description]
598 * @details [long description]
600 * @param host [description]
601 * @return [description]
603 XBT_PUBLIC(int) surf_host_get_nb_pstates(surf_resource_t host);
605 XBT_PUBLIC(void) surf_host_set_pstate(surf_resource_t host, int pstate_index);
606 XBT_PUBLIC(int) surf_host_get_pstate(surf_resource_t host);
607 XBT_PUBLIC(double) surf_host_get_wattmin_at(surf_resource_t resource, int pstate);
608 XBT_PUBLIC(double) surf_host_get_wattmax_at(surf_resource_t resource, int pstate);
611 * @brief Get the consumed energy (in joules) of an host
613 * @param host The surf host
614 * @return The consumed energy
616 XBT_PUBLIC(double) surf_host_get_consumed_energy(surf_resource_t host);
619 * @brief Get the list of storages mounted on an host
621 * @param host The surf host
622 * @return Dictionary of mount point, Storage
624 XBT_PUBLIC(xbt_dict_t) surf_host_get_mounted_storage_list(surf_resource_t host);
627 * @brief Get the list of storages attached to an host
629 * @param host The surf host
630 * @return Dictionary of storage
632 XBT_PUBLIC(xbt_dynar_t) surf_host_get_attached_storage_list(surf_resource_t host);
635 * @brief Unlink a file descriptor
637 * @param host The surf host
638 * @param fd The file descriptor
640 * @return 0 if failed to unlink, 1 otherwise
642 XBT_PUBLIC(int) surf_host_unlink(surf_resource_t host, surf_file_t fd);
645 * @brief Get the size of a file on a host
647 * @param host The surf host
648 * @param fd The file descriptor
650 * @return The size in bytes of the file
652 XBT_PUBLIC(size_t) surf_host_get_size(surf_resource_t host, surf_file_t fd);
655 * @brief Get the current position of the file descriptor
657 * @param host The surf host
658 * @param fd The file descriptor
659 * @return The current position of the file descriptor
661 XBT_PUBLIC(size_t) surf_host_file_tell(surf_resource_t host, surf_file_t fd);
664 * @brief Move a file to another location on the *same mount point*.
665 * @details [long description]
667 * @param host The surf host
668 * @param fd The file descriptor
669 * @param fullpath The new full path
671 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
673 XBT_PUBLIC(int) surf_host_file_move(surf_resource_t host, surf_file_t fd, const char* fullpath);
676 * @brief Set the position indictator assiociated with the file descriptor to a new position
677 * @details [long description]
679 * @param host The surf host
680 * @param fd The file descriptor
681 * @param offset The offset from the origin
682 * @param origin Position used as a reference for the offset
683 * - SEEK_SET: beginning of the file
684 * - SEEK_CUR: current position indicator
685 * - SEEK_END: end of the file
686 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
688 XBT_PUBLIC(int) surf_host_file_seek(surf_resource_t host,
689 surf_file_t fd, sg_offset_t offset,
693 * @brief Get the content of a storage
695 * @param resource The surf storage
696 * @return A xbt_dict_t with path as keys and size in bytes as values
698 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
701 * @brief Get the size in bytes of a storage
703 * @param resource The surf storage
704 * @return The size in bytes of the storage
706 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
709 * @brief Get the available size in bytes of a storage
711 * @param resource The surf storage
712 * @return The available size in bytes of the storage
714 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
717 * @brief Get the size in bytes of a storage
719 * @param resource The surf storage
720 * @return The used size in bytes of the storage
722 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
726 * @brief Get the data associated to the action
728 * @param action The surf action
729 * @return The data associated to the action
731 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
734 * @brief Set the data associated to the action
735 * @details [long description]
737 * @param action The surf action
738 * @param data The new data associated to the action
740 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
743 * @brief Unreference an action
745 * @param action The surf action
747 XBT_PUBLIC(void) surf_action_unref(surf_action_t action);
750 * @brief Get the start time of an action
752 * @param action The surf action
753 * @return The start time in seconds from the beginning of the simulation
755 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
758 * @brief Get the finish time of an action
760 * @param action The surf action
761 * @return The finish time in seconds from the beginning of the simulation
763 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
766 * @brief Get the remains amount of work to do of an action
768 * @param action The surf action
769 * @return The remains amount of work to do
771 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
774 * @brief Suspend an action
776 * @param action The surf action
778 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
781 * @brief Resume an action
783 * @param action The surf action
785 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
788 * @brief Cancel an action
790 * @param action The surf action
792 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
795 * @brief Set the priority of an action
796 * @details [long description]
798 * @param action The surf action
799 * @param priority The new priority [TODO]
801 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
804 * @brief Set the category of an action
805 * @details [long description]
807 * @param action The surf action
808 * @param category The new category of the action
810 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
813 * @brief Get the state of an action
815 * @param action The surf action
816 * @return The state of the action
818 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
821 * @brief Get the cost of an action
823 * @param action The surf action
824 * @return The cost of the action
826 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
829 * @brief [brief desrciption]
830 * @details [long description]
832 * @param action The surf cpu action
833 * @param cpu [description]
834 * @param mask [description]
836 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask);
839 * @brief [brief description]
840 * @details [long description]
842 * @param action The surf cpu action
843 * @param bound [description]
845 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
848 * @brief [brief description]
849 * @details [long description]
851 * @param action The surf network action
853 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
856 * @brief Get the file associated to a storage action
858 * @param action The surf storage action
859 * @return The file associated to a storage action
861 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
864 * @brief Get the result dictionary of an ls action
866 * @param action The surf storage action
867 * @return The dictionry listing a path
869 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
873 * @brief Get the host the storage is attached to
875 * @param resource The surf storage
876 * @return The host name
878 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
880 XBT_PUBLIC(surf_model_t) surf_resource_model(const void *host, int level);
884 /**************************************/
885 /* Implementations of model object */
886 /**************************************/
888 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
889 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
891 /** \ingroup SURF_models
892 * \brief The CPU model object for the physical machine layer
894 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
896 /** \ingroup SURF_models
897 * \brief The CPU model object for the virtual machine layer
899 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
902 /** \ingroup SURF_models
903 * \brief Initializes the CPU model with the model Cas01
905 * By default, this model uses the lazy optimization mechanism that
906 * relies on partial invalidation in LMM and a heap for lazy action update.
907 * You can change this behavior by setting the cpu/optim configuration
908 * variable to a different value.
910 * You shouldn't have to call it by yourself.
912 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
914 /** \ingroup SURF_models
915 * \brief Initializes the CPU model with trace integration [Deprecated]
917 * You shouldn't have to call it by yourself.
919 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
921 /** \ingroup SURF_models
922 * \brief The list of all available optimization modes (both for cpu and networks).
923 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
925 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
927 /** \ingroup SURF_plugins
928 * \brief The list of all available surf plugins
930 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
932 /** \ingroup SURF_models
933 * \brief The list of all available cpu model models
935 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
937 /**\brief create new host bypass the parser
942 /** \ingroup SURF_models
943 * \brief The network model
945 * When creating a new API on top on SURF, you shouldn't use the
946 * network model unless you know what you are doing. Only the host
947 * model should be accessed because depending on the platform model,
948 * the network model can be NULL.
950 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
952 /** \ingroup SURF_models
953 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
955 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
956 * based on the model 'LV08' and different correction factors depending on the communication
957 * size (< 1KiB, < 64KiB, >= 64KiB).
958 * See comments in the code for more information.
960 * \see surf_host_model_init_SMPI()
962 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
964 /** \ingroup SURF_models
965 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
967 * This model impelments a variant of the contention model on Infinband networks based on
968 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
970 * \see surf_host_model_init_IB()
972 XBT_PUBLIC(void) surf_network_model_init_IB(void);
974 /** \ingroup SURF_models
975 * \brief Initializes the platform with the network model 'LegrandVelho'
977 * This model is proposed by Arnaud Legrand and Pedro Velho based on
978 * the results obtained with the GTNets simulator for onelink and
979 * dogbone sharing scenarios. See comments in the code for more information.
981 * \see surf_host_model_init_LegrandVelho()
983 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
985 /** \ingroup SURF_models
986 * \brief Initializes the platform with the network model 'Constant'
988 * In this model, the communication time between two network cards is
989 * constant, hence no need for a routing table. This is particularly
990 * usefull when simulating huge distributed algorithms where
991 * scalability is really an issue. This function is called in
992 * conjunction with surf_host_model_init_compound.
994 * \see surf_host_model_init_compound()
996 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
998 /** \ingroup SURF_models
999 * \brief Initializes the platform with the network model CM02
1001 * You sould call this function by yourself only if you plan using
1002 * surf_host_model_init_compound.
1003 * See comments in the code for more information.
1005 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
1008 /** \ingroup SURF_models
1009 * \brief Initializes the platform with the network model GTNETS
1010 * \param filename XML platform file name
1012 * This function is called by surf_host_model_init_GTNETS
1013 * or by yourself only if you plan using surf_host_model_init_compound
1015 * \see surf_host_model_init_GTNETS()
1017 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
1021 /** \ingroup SURF_models
1022 * \brief Initializes the platform with the network model NS3
1023 * \param filename XML platform file name
1025 * This function is called by surf_host_model_init_NS3
1026 * or by yourself only if you plan using surf_host_model_init_compound
1028 * \see surf_host_model_init_NS3()
1030 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
1033 /** \ingroup SURF_models
1034 * \brief Initializes the platform with the network model Reno
1035 * \param filename XML platform file name
1037 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
1040 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1041 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1043 * Call this function only if you plan using surf_host_model_init_compound.
1046 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
1048 /** \ingroup SURF_models
1049 * \brief Initializes the platform with the network model Reno2
1050 * \param filename XML platform file name
1052 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
1055 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
1056 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1058 * Call this function only if you plan using surf_host_model_init_compound.
1061 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
1063 /** \ingroup SURF_models
1064 * \brief Initializes the platform with the network model Vegas
1065 * \param filename XML platform file name
1067 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
1068 * to the proportional fairness.
1071 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1072 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1074 * Call this function only if you plan using surf_host_model_init_compound.
1077 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
1079 /** \ingroup SURF_models
1080 * \brief The list of all available network model models
1082 XBT_PUBLIC_DATA(s_surf_model_description_t)
1083 surf_network_model_description[];
1085 /** \ingroup SURF_models
1086 * \brief The storage model
1088 XBT_PUBLIC(void) surf_storage_model_init_default(void);
1090 /** \ingroup SURF_models
1091 * \brief The list of all available storage modes.
1092 * This storage mode can be set using --cfg=storage/model:...
1094 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
1096 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
1098 /** \ingroup SURF_models
1099 * \brief The host model
1101 * Note that when you create an API on top of SURF,
1102 * the host model should be the only one you use
1103 * because depending on the platform model, the network model and the CPU model
1106 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
1108 /** \ingroup SURF_models
1109 * \brief The vm model
1111 * Note that when you create an API on top of SURF,
1112 * the vm 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_vm_model_t) surf_vm_model;
1118 /** \ingroup SURF_models
1119 * \brief Initializes the platform with a compound host model
1121 * This function should be called after a cpu_model and a
1122 * network_model have been set up.
1125 XBT_PUBLIC(void) surf_host_model_init_compound(void);
1127 /** \ingroup SURF_models
1128 * \brief Initializes the platform with the current best network and cpu models at hand
1130 * This platform model separates the host model and the network model.
1131 * The host model will be initialized with the model compound, the network
1132 * model with the model LV08 (with cross traffic support) and the CPU model with
1134 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1137 XBT_PUBLIC(void) surf_host_model_init_current_default(void);
1139 /** \ingroup SURF_models
1140 * \brief Initializes the platform with the model L07
1142 * With this model, only parallel tasks can be used. Resource sharing
1143 * is done by identifying bottlenecks and giving an equal share of
1144 * the model to each action.
1147 XBT_PUBLIC(void) surf_host_model_init_ptask_L07(void);
1149 /** \ingroup SURF_models
1150 * \brief The list of all available host model models
1152 XBT_PUBLIC_DATA(s_surf_model_description_t)
1153 surf_host_model_description[];
1155 /** \ingroup SURF_models
1156 * \brief Initializes the platform with the current best network and cpu models at hand
1158 * This platform model seperates the host model and the network model.
1159 * The host model will be initialized with the model compound, the network
1160 * model with the model LV08 (with cross traffic support) and the CPU model with
1162 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1165 XBT_PUBLIC(void) surf_vm_model_init_HL13(void);
1167 /** \ingroup SURF_models
1168 * \brief The list of all available vm model models
1170 XBT_PUBLIC_DATA(s_surf_model_description_t)
1171 surf_vm_model_description[];
1173 /*******************************************/
1175 /** \ingroup SURF_models
1176 * \brief List of initialized models
1178 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
1179 XBT_PUBLIC_DATA(xbt_dynar_t) model_list_invoke;
1181 /** \ingroup SURF_simulation
1182 * \brief List of hosts that have juste restarted and whose autorestart process should be restarted.
1184 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
1186 /** \ingroup SURF_simulation
1187 * \brief List of hosts for which one want to be notified if they ever restart.
1189 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
1191 /*******************************************/
1192 /*** SURF Platform *************************/
1193 /*******************************************/
1194 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
1195 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
1196 XBT_PUBLIC_DATA(AS_t) surf_AS_get_by_name(const char * name);
1197 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
1198 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
1199 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
1200 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
1201 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
1202 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
1204 /*******************************************/
1205 /*** SURF Globals **************************/
1206 /*******************************************/
1208 /** \ingroup SURF_simulation
1209 * \brief Initialize SURF
1210 * \param argc argument number
1211 * \param argv arguments
1213 * This function has to be called to initialize the common
1214 * structures. Then you will have to create the environment by
1216 * e.g. surf_host_model_init_CM02()
1218 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
1220 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
1222 /** \ingroup SURF_simulation
1223 * \brief Finish simulation initialization
1225 * This function must be called before the first call to surf_solve()
1227 XBT_PUBLIC(void) surf_presolve(void);
1229 /** \ingroup SURF_simulation
1230 * \brief Performs a part of the simulation
1231 * \param max_date Maximum date to update the simulation to, or -1
1232 * \return the elapsed time, or -1.0 if no event could be executed
1234 * This function execute all possible events, update the action states
1235 * and returns the time elapsed.
1236 * When you call execute or communicate on a model, the corresponding actions
1237 * are not executed immediately but only when you call surf_solve.
1238 * Note that the returned elapsed time can be zero.
1240 XBT_PUBLIC(double) surf_solve(double max_date);
1242 /** \ingroup SURF_simulation
1243 * \brief Return the current time
1245 * Return the current time in millisecond.
1247 XBT_PUBLIC(double) surf_get_clock(void);
1249 /** \ingroup SURF_simulation
1256 XBT_PUBLIC(void) surf_exit(void);
1258 /* Prototypes of the functions that handle the properties */
1259 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
1261 /* The same for model_prop set*/
1262 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
1264 /* surf parse file related (public because called from a test suite) */
1265 XBT_PUBLIC(void) parse_platform_file(const char *file);
1267 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
1268 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
1269 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
1270 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
1271 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
1272 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
1273 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
1276 XBT_PUBLIC(double) get_cpu_power(const char *power);
1278 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
1280 int surf_get_nthreads(void);
1281 void surf_set_nthreads(int nthreads);
1284 * Returns the initial path. On Windows the initial path is
1285 * the current directory for the current process in the other
1286 * case the function returns "./" that represents the current
1287 * directory on Unix/Linux platforms.
1289 const char *__surf_get_initial_path(void);
1291 /********** Tracing **********/
1292 /* from surf_instr.c */
1293 void TRACE_surf_action(surf_action_t surf_action, const char *category);
1294 void TRACE_surf_alloc(void);
1295 void TRACE_surf_release(void);
1297 /* instr_routing.c */
1298 void instr_routing_define_callbacks (void);
1299 void instr_new_variable_type (const char *new_typename, const char *color);
1300 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
1301 void instr_new_user_state_type (const char *father_type, const char *new_typename);
1302 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
1303 int instr_platform_traced (void);
1304 xbt_graph_t instr_routing_platform_graph (void);
1305 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1308 #endif /* _SURF_SURF_H */