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,
261 sg_host_t *host_list,
262 double *flops_amount,
263 double *bytes_amount,
266 /** @brief Get the route (dynar of sg_link_t) between two hosts */
267 XBT_PUBLIC(xbt_dynar_t) surf_host_model_get_route(surf_host_model_t model, surf_resource_t src, surf_resource_t dst);
269 /** @brief Create a new VM on the specified host */
270 XBT_PUBLIC(void) surf_vm_model_create(const char *name, surf_resource_t host_PM);
272 /** @brief Create a communication between two hosts
274 * @param model The model which handle the communication
275 * @param src The source host
276 * @param dst The destination host
277 * @param size The amount of data (in bytes) needed to transfer
278 * @param rate [description]
279 * @return The action corresponding to the communication
281 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);
284 * @brief Get the name of a surf resource (cpu, host, network, …)
286 * @param resource The surf resource
287 * @return The name of the surf resource
289 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
290 static inline const char * surf_cpu_name(surf_cpu_t cpu) {
291 return surf_resource_name((surf_cpp_resource_t)cpu);
294 /** @brief Get the properties of a surf resource (cpu, host, network, …) */
295 XBT_PUBLIC(xbt_dict_t) surf_resource_get_properties(surf_cpp_resource_t resource);
296 static XBT_INLINE xbt_dict_t surf_host_get_properties(surf_host_t host) {
297 return surf_resource_get_properties((surf_cpp_resource_t)host);
301 /** @brief Get the state of a surf resource (cpu, host, network, …) */
302 XBT_PUBLIC(e_surf_resource_state_t) surf_resource_get_state(surf_cpp_resource_t resource);
304 static XBT_INLINE e_surf_resource_state_t surf_host_get_state(surf_host_t host) {
305 return surf_resource_get_state((surf_cpp_resource_t)host);
309 /** @brief Set the state of a surf resource (cpu, host, network, …) */
310 XBT_PUBLIC(void) surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state);
311 static inline void surf_host_set_state(surf_host_t host, e_surf_resource_state_t state) {
312 surf_resource_set_state((surf_cpp_resource_t)host, state);
316 * @brief Get the speed of the cpu associated to a host
318 * @param resource The surf host
319 * @param load [description]
321 * @return [description]
323 XBT_PUBLIC(double) surf_host_get_speed(surf_resource_t resource, double load);
326 * @brief Get the available speed of cpu associated to a host
328 * @param resource The surf host
329 * @return [description]
331 XBT_PUBLIC(double) surf_host_get_available_speed(surf_resource_t resource);
333 /** @brief Get the number of cores of the cpu associated to a host */
334 XBT_PUBLIC(int) surf_host_get_core(surf_resource_t resource);
336 /** @brief Create a computation action on the given host */
337 XBT_PUBLIC(surf_action_t) surf_host_execute(surf_resource_t resource, double size);
339 /** @brief Create a sleep action on the given host */
340 XBT_PUBLIC(surf_action_t) surf_host_sleep(surf_resource_t resource, double duration);
342 /** @brief Create a file opening action on the given host */
343 XBT_PUBLIC(surf_action_t) surf_host_open(surf_resource_t host, const char* fullpath);
345 /** @brief Create a file closing action on the given host */
346 XBT_PUBLIC(surf_action_t) surf_host_close(surf_resource_t host, surf_file_t fd);
348 /** @brief Create a file reading action on the given host */
349 XBT_PUBLIC(surf_action_t) surf_host_read(surf_resource_t host, surf_file_t fd, sg_size_t size);
351 /** @brief Create a file writing action on the given host */
352 XBT_PUBLIC(surf_action_t) surf_host_write(surf_resource_t host, surf_file_t fd, sg_size_t size);
355 * @brief Get the informations of a file descriptor
356 * @details The returned xbt_dynar_t contains:
357 * - the size of the file,
359 * - the storage name,
360 * - the storage typeId,
361 * - the storage content type
363 * @param host The surf host
364 * @param fd The file descriptor
365 * @return An xbt_dynar_t with the file informations
367 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(surf_resource_t host, surf_file_t fd);
370 * @brief Get the available space of the storage at the mount point
372 * @param resource The surf host
373 * @param name The mount point
374 * @return The amount of available space in bytes
376 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(surf_resource_t resource, const char* name);
379 * @brief Get the used space of the storage at the mount point
381 * @param resource The surf host
382 * @param name The mount point
383 * @return The amount of used space in bytes
385 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(surf_resource_t resource, const char* name);
387 /** @brief Get the list of VMs hosted on the host */
388 XBT_PUBLIC(xbt_dynar_t) surf_host_get_vms(surf_resource_t resource);
391 * @brief [brief description]
392 * @details [long description]
394 * @param resource [description]
395 * @param params [description]
397 XBT_PUBLIC(void) surf_host_get_params(surf_resource_t resource, ws_params_t params);
400 * @brief [brief description]
401 * @details [long description]
403 * @param resource [description]
404 * @param params [description]
406 XBT_PUBLIC(void) surf_host_set_params(surf_resource_t resource, ws_params_t params);
409 * @brief Destroy a VM
411 * @param resource The surf vm
413 XBT_PUBLIC(void) surf_vm_destroy(surf_resource_t resource);
416 * @brief Suspend a VM
418 * @param resource The surf vm
420 XBT_PUBLIC(void) surf_vm_suspend(surf_resource_t resource);
425 * @param resource The surf vm
427 XBT_PUBLIC(void) surf_vm_resume(surf_resource_t resource);
430 * @brief Save the VM (Not yet implemented)
432 * @param resource The surf vm
434 XBT_PUBLIC(void) surf_vm_save(surf_resource_t resource);
437 * @brief Restore the VM (Not yet implemented)
439 * @param resource The surf vm
441 XBT_PUBLIC(void) surf_vm_restore(surf_resource_t resource);
444 * @brief Migrate the VM to the destination host
446 * @param resource The surf vm
447 * @param ind_vm_ws_dest The destination host
449 XBT_PUBLIC(void) surf_vm_migrate(surf_resource_t resource, surf_resource_t ind_vm_ws_dest);
452 * @brief Get the physical machine hosting the VM
454 * @param resource The surf vm
455 * @return The physical machine hosting the VM
457 XBT_PUBLIC(surf_resource_t) surf_vm_get_pm(surf_resource_t resource);
460 * @brief [brief description]
461 * @details [long description]
463 * @param resource [description]
464 * @param bound [description]
466 XBT_PUBLIC(void) surf_vm_set_bound(surf_resource_t resource, double bound);
469 * @brief [brief description]
470 * @details [long description]
472 * @param resource [description]
473 * @param cpu [description]
474 * @param mask [description]
476 XBT_PUBLIC(void) surf_vm_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask);
479 * @brief Execute some quantity of computation
481 * @param cpu The surf cpu
482 * @param size The value of the processing amount (in flop) needed to process
483 * @return The surf action corresponding to the processing
485 XBT_PUBLIC(surf_action_t) surf_cpu_execute(surf_resource_t cpu, double size);
488 * @brief Make the cpu sleep for duration (in seconds)
489 * @details [long description]
491 * @param cpu The surf cpu
492 * @param duration The number of seconds to sleep
493 * @return The surf action corresponding to the sleeping
495 XBT_PUBLIC(surf_action_t) surf_cpu_sleep(surf_resource_t cpu, double duration);
498 * @brief Get the host power peak
499 * @details [long description]
501 * @param host The surf host
502 * @return The power peak
504 XBT_PUBLIC(double) surf_host_get_current_power_peak(surf_resource_t host);
507 * @brief [brief description]
508 * @details [long description]
510 * @param host [description]
511 * @param pstate_index [description]
513 * @return [description]
515 XBT_PUBLIC(double) surf_host_get_power_peak_at(surf_resource_t host, int pstate_index);
518 * @brief [brief description]
519 * @details [long description]
521 * @param host [description]
522 * @return [description]
524 XBT_PUBLIC(int) surf_host_get_nb_pstates(surf_resource_t host);
526 XBT_PUBLIC(void) surf_host_set_pstate(surf_resource_t host, int pstate_index);
527 XBT_PUBLIC(int) surf_host_get_pstate(surf_resource_t host);
528 XBT_PUBLIC(double) surf_host_get_wattmin_at(surf_resource_t resource, int pstate);
529 XBT_PUBLIC(double) surf_host_get_wattmax_at(surf_resource_t resource, int pstate);
532 * @brief Get the consumed energy (in joules) of an host
534 * @param host The surf host
535 * @return The consumed energy
537 XBT_PUBLIC(double) surf_host_get_consumed_energy(surf_resource_t host);
540 * @brief Get the list of storages mounted on an host
542 * @param host The surf host
543 * @return Dictionary of mount point, Storage
545 XBT_PUBLIC(xbt_dict_t) surf_host_get_mounted_storage_list(surf_resource_t host);
548 * @brief Get the list of storages attached to an host
550 * @param host The surf host
551 * @return Dictionary of storage
553 XBT_PUBLIC(xbt_dynar_t) surf_host_get_attached_storage_list(surf_resource_t host);
556 * @brief Unlink a file descriptor
558 * @param host The surf host
559 * @param fd The file descriptor
561 * @return 0 if failed to unlink, 1 otherwise
563 XBT_PUBLIC(int) surf_host_unlink(surf_resource_t host, surf_file_t fd);
566 * @brief Get the size of a file on a host
568 * @param host The surf host
569 * @param fd The file descriptor
571 * @return The size in bytes of the file
573 XBT_PUBLIC(size_t) surf_host_get_size(surf_resource_t host, surf_file_t fd);
576 * @brief Get the current position of the file descriptor
578 * @param host The surf host
579 * @param fd The file descriptor
580 * @return The current position of the file descriptor
582 XBT_PUBLIC(size_t) surf_host_file_tell(surf_resource_t host, surf_file_t fd);
585 * @brief Move a file to another location on the *same mount point*.
586 * @details [long description]
588 * @param host The surf host
589 * @param fd The file descriptor
590 * @param fullpath The new full path
592 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
594 XBT_PUBLIC(int) surf_host_file_move(surf_resource_t host, surf_file_t fd, const char* fullpath);
597 * @brief Set the position indictator assiociated with the file descriptor to a new position
598 * @details [long description]
600 * @param host The surf host
601 * @param fd The file descriptor
602 * @param offset The offset from the origin
603 * @param origin Position used as a reference for the offset
604 * - SEEK_SET: beginning of the file
605 * - SEEK_CUR: current position indicator
606 * - SEEK_END: end of the file
607 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
609 XBT_PUBLIC(int) surf_host_file_seek(surf_resource_t host,
610 surf_file_t fd, sg_offset_t offset,
614 * @brief Get the content of a storage
616 * @param resource The surf storage
617 * @return A xbt_dict_t with path as keys and size in bytes as values
619 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
622 * @brief Get the size in bytes of a storage
624 * @param resource The surf storage
625 * @return The size in bytes of the storage
627 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
630 * @brief Get the available size in bytes of a storage
632 * @param resource The surf storage
633 * @return The available size in bytes of the storage
635 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
638 * @brief Get the size in bytes of a storage
640 * @param resource The surf storage
641 * @return The used size in bytes of the storage
643 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
647 * @brief Get the data associated to the action
649 * @param action The surf action
650 * @return The data associated to the action
652 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
655 * @brief Set the data associated to the action
656 * @details [long description]
658 * @param action The surf action
659 * @param data The new data associated to the action
661 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
664 * @brief Unreference an action
666 * @param action The surf action
668 XBT_PUBLIC(void) surf_action_unref(surf_action_t action);
671 * @brief Get the start time of an action
673 * @param action The surf action
674 * @return The start time in seconds from the beginning of the simulation
676 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
679 * @brief Get the finish time of an action
681 * @param action The surf action
682 * @return The finish time in seconds from the beginning of the simulation
684 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
687 * @brief Get the remains amount of work to do of an action
689 * @param action The surf action
690 * @return The remains amount of work to do
692 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
695 * @brief Suspend an action
697 * @param action The surf action
699 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
702 * @brief Resume an action
704 * @param action The surf action
706 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
709 * @brief Cancel an action
711 * @param action The surf action
713 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
716 * @brief Set the priority of an action
717 * @details [long description]
719 * @param action The surf action
720 * @param priority The new priority [TODO]
722 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
725 * @brief Set the category of an action
726 * @details [long description]
728 * @param action The surf action
729 * @param category The new category of the action
731 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
734 * @brief Get the state of an action
736 * @param action The surf action
737 * @return The state of the action
739 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
742 * @brief Get the cost of an action
744 * @param action The surf action
745 * @return The cost of the action
747 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
750 * @brief [brief desrciption]
751 * @details [long description]
753 * @param action The surf cpu action
754 * @param cpu [description]
755 * @param mask [description]
757 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask);
760 * @brief [brief description]
761 * @details [long description]
763 * @param action The surf cpu action
764 * @param bound [description]
766 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
769 * @brief [brief description]
770 * @details [long description]
772 * @param action The surf network action
774 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
777 * @brief Get the file associated to a storage action
779 * @param action The surf storage action
780 * @return The file associated to a storage action
782 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
785 * @brief Get the result dictionary of an ls action
787 * @param action The surf storage action
788 * @return The dictionry listing a path
790 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
794 * @brief Get the host the storage is attached to
796 * @param resource The surf storage
797 * @return The host name
799 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
801 XBT_PUBLIC(surf_model_t) surf_resource_model(const void *host, int level);
805 /**************************************/
806 /* Implementations of model object */
807 /**************************************/
809 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
810 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
812 /** \ingroup SURF_models
813 * \brief The CPU model object for the physical machine layer
815 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
817 /** \ingroup SURF_models
818 * \brief The CPU model object for the virtual machine layer
820 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
823 /** \ingroup SURF_models
824 * \brief Initializes the CPU model with the model Cas01
826 * By default, this model uses the lazy optimization mechanism that
827 * relies on partial invalidation in LMM and a heap for lazy action update.
828 * You can change this behavior by setting the cpu/optim configuration
829 * variable to a different value.
831 * You shouldn't have to call it by yourself.
833 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
835 /** \ingroup SURF_models
836 * \brief Initializes the CPU model with trace integration [Deprecated]
838 * You shouldn't have to call it by yourself.
840 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
842 /** \ingroup SURF_models
843 * \brief The list of all available optimization modes (both for cpu and networks).
844 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
846 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
848 /** \ingroup SURF_plugins
849 * \brief The list of all available surf plugins
851 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
853 /** \ingroup SURF_models
854 * \brief The list of all available cpu model models
856 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
858 /**\brief create new host bypass the parser
863 /** \ingroup SURF_models
864 * \brief The network model
866 * When creating a new API on top on SURF, you shouldn't use the
867 * network model unless you know what you are doing. Only the host
868 * model should be accessed because depending on the platform model,
869 * the network model can be NULL.
871 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
873 /** \ingroup SURF_models
874 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
876 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
877 * based on the model 'LV08' and different correction factors depending on the communication
878 * size (< 1KiB, < 64KiB, >= 64KiB).
879 * See comments in the code for more information.
881 * \see surf_host_model_init_SMPI()
883 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
885 /** \ingroup SURF_models
886 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
888 * This model impelments a variant of the contention model on Infinband networks based on
889 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
891 * \see surf_host_model_init_IB()
893 XBT_PUBLIC(void) surf_network_model_init_IB(void);
895 /** \ingroup SURF_models
896 * \brief Initializes the platform with the network model 'LegrandVelho'
898 * This model is proposed by Arnaud Legrand and Pedro Velho based on
899 * the results obtained with the GTNets simulator for onelink and
900 * dogbone sharing scenarios. See comments in the code for more information.
902 * \see surf_host_model_init_LegrandVelho()
904 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
906 /** \ingroup SURF_models
907 * \brief Initializes the platform with the network model 'Constant'
909 * In this model, the communication time between two network cards is
910 * constant, hence no need for a routing table. This is particularly
911 * usefull when simulating huge distributed algorithms where
912 * scalability is really an issue. This function is called in
913 * conjunction with surf_host_model_init_compound.
915 * \see surf_host_model_init_compound()
917 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
919 /** \ingroup SURF_models
920 * \brief Initializes the platform with the network model CM02
922 * You sould call this function by yourself only if you plan using
923 * surf_host_model_init_compound.
924 * See comments in the code for more information.
926 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
929 /** \ingroup SURF_models
930 * \brief Initializes the platform with the network model GTNETS
931 * \param filename XML platform file name
933 * This function is called by surf_host_model_init_GTNETS
934 * or by yourself only if you plan using surf_host_model_init_compound
936 * \see surf_host_model_init_GTNETS()
938 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
942 /** \ingroup SURF_models
943 * \brief Initializes the platform with the network model NS3
944 * \param filename XML platform file name
946 * This function is called by surf_host_model_init_NS3
947 * or by yourself only if you plan using surf_host_model_init_compound
949 * \see surf_host_model_init_NS3()
951 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
954 /** \ingroup SURF_models
955 * \brief Initializes the platform with the network model Reno
956 * \param filename XML platform file name
958 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
961 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
962 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
964 * Call this function only if you plan using surf_host_model_init_compound.
967 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
969 /** \ingroup SURF_models
970 * \brief Initializes the platform with the network model Reno2
971 * \param filename XML platform file name
973 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
976 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
977 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
979 * Call this function only if you plan using surf_host_model_init_compound.
982 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
984 /** \ingroup SURF_models
985 * \brief Initializes the platform with the network model Vegas
986 * \param filename XML platform file name
988 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
989 * to the proportional fairness.
992 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
993 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
995 * Call this function only if you plan using surf_host_model_init_compound.
998 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
1000 /** \ingroup SURF_models
1001 * \brief The list of all available network model models
1003 XBT_PUBLIC_DATA(s_surf_model_description_t)
1004 surf_network_model_description[];
1006 /** \ingroup SURF_models
1007 * \brief The storage model
1009 XBT_PUBLIC(void) surf_storage_model_init_default(void);
1011 /** \ingroup SURF_models
1012 * \brief The list of all available storage modes.
1013 * This storage mode can be set using --cfg=storage/model:...
1015 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
1017 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
1019 /** \ingroup SURF_models
1020 * \brief The host model
1022 * Note that when you create an API on top of SURF,
1023 * the host model should be the only one you use
1024 * because depending on the platform model, the network model and the CPU model
1027 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
1029 /** \ingroup SURF_models
1030 * \brief The vm model
1032 * Note that when you create an API on top of SURF,
1033 * the vm model should be the only one you use
1034 * because depending on the platform model, the network model and the CPU model
1037 XBT_PUBLIC_DATA(surf_vm_model_t) surf_vm_model;
1039 /** \ingroup SURF_models
1040 * \brief Initializes the platform with a compound host model
1042 * This function should be called after a cpu_model and a
1043 * network_model have been set up.
1046 XBT_PUBLIC(void) surf_host_model_init_compound(void);
1048 /** \ingroup SURF_models
1049 * \brief Initializes the platform with the current best network and cpu models at hand
1051 * This platform model separates the host model and the network model.
1052 * The host model will be initialized with the model compound, the network
1053 * model with the model LV08 (with cross traffic support) and the CPU model with
1055 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1058 XBT_PUBLIC(void) surf_host_model_init_current_default(void);
1060 /** \ingroup SURF_models
1061 * \brief Initializes the platform with the model L07
1063 * With this model, only parallel tasks can be used. Resource sharing
1064 * is done by identifying bottlenecks and giving an equal share of
1065 * the model to each action.
1068 XBT_PUBLIC(void) surf_host_model_init_ptask_L07(void);
1070 /** \ingroup SURF_models
1071 * \brief The list of all available host model models
1073 XBT_PUBLIC_DATA(s_surf_model_description_t)
1074 surf_host_model_description[];
1076 /** \ingroup SURF_models
1077 * \brief Initializes the platform with the current best network and cpu models at hand
1079 * This platform model seperates the host model and the network model.
1080 * The host model will be initialized with the model compound, the network
1081 * model with the model LV08 (with cross traffic support) and the CPU model with
1083 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1086 XBT_PUBLIC(void) surf_vm_model_init_HL13(void);
1088 /** \ingroup SURF_models
1089 * \brief The list of all available vm model models
1091 XBT_PUBLIC_DATA(s_surf_model_description_t)
1092 surf_vm_model_description[];
1094 /*******************************************/
1096 /** \ingroup SURF_models
1097 * \brief List of initialized models
1099 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
1100 XBT_PUBLIC_DATA(xbt_dynar_t) model_list_invoke;
1102 /** \ingroup SURF_simulation
1103 * \brief List of hosts that have juste restarted and whose autorestart process should be restarted.
1105 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
1107 /** \ingroup SURF_simulation
1108 * \brief List of hosts for which one want to be notified if they ever restart.
1110 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
1112 /*******************************************/
1113 /*** SURF Platform *************************/
1114 /*******************************************/
1115 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
1116 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
1117 XBT_PUBLIC_DATA(AS_t) surf_AS_get_by_name(const char * name);
1118 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
1119 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
1120 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
1121 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
1122 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
1123 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
1125 /*******************************************/
1126 /*** SURF Globals **************************/
1127 /*******************************************/
1129 /** \ingroup SURF_simulation
1130 * \brief Initialize SURF
1131 * \param argc argument number
1132 * \param argv arguments
1134 * This function has to be called to initialize the common
1135 * structures. Then you will have to create the environment by
1137 * e.g. surf_host_model_init_CM02()
1139 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
1141 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
1143 /** \ingroup SURF_simulation
1144 * \brief Finish simulation initialization
1146 * This function must be called before the first call to surf_solve()
1148 XBT_PUBLIC(void) surf_presolve(void);
1150 /** \ingroup SURF_simulation
1151 * \brief Performs a part of the simulation
1152 * \param max_date Maximum date to update the simulation to, or -1
1153 * \return the elapsed time, or -1.0 if no event could be executed
1155 * This function execute all possible events, update the action states
1156 * and returns the time elapsed.
1157 * When you call execute or communicate on a model, the corresponding actions
1158 * are not executed immediately but only when you call surf_solve.
1159 * Note that the returned elapsed time can be zero.
1161 XBT_PUBLIC(double) surf_solve(double max_date);
1163 /** \ingroup SURF_simulation
1164 * \brief Return the current time
1166 * Return the current time in millisecond.
1168 XBT_PUBLIC(double) surf_get_clock(void);
1170 /** \ingroup SURF_simulation
1177 XBT_PUBLIC(void) surf_exit(void);
1179 /* Prototypes of the functions that handle the properties */
1180 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
1182 /* The same for model_prop set*/
1183 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
1185 /* surf parse file related (public because called from a test suite) */
1186 XBT_PUBLIC(void) parse_platform_file(const char *file);
1188 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
1189 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
1190 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
1191 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
1192 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
1193 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
1194 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
1197 XBT_PUBLIC(double) get_cpu_power(const char *power);
1199 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
1201 int surf_get_nthreads(void);
1202 void surf_set_nthreads(int nthreads);
1205 * Returns the initial path. On Windows the initial path is
1206 * the current directory for the current process in the other
1207 * case the function returns "./" that represents the current
1208 * directory on Unix/Linux platforms.
1210 const char *__surf_get_initial_path(void);
1212 /********** Tracing **********/
1213 /* from surf_instr.c */
1214 void TRACE_surf_action(surf_action_t surf_action, const char *category);
1215 void TRACE_surf_alloc(void);
1216 void TRACE_surf_release(void);
1218 /* instr_routing.c */
1219 void instr_routing_define_callbacks (void);
1220 void instr_new_variable_type (const char *new_typename, const char *color);
1221 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
1222 void instr_new_user_state_type (const char *father_type, const char *new_typename);
1223 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
1224 int instr_platform_traced (void);
1225 xbt_graph_t instr_routing_platform_graph (void);
1226 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1229 #endif /* _SURF_SURF_H */