1 /* Copyright (c) 2004-2015. 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"
15 #include "xbt/config.h"
16 #include "src/portable.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"
23 #include "simgrid/forward.h"
26 /* Actions and models are highly connected structures... */
28 /* user-visible parameters */
29 extern XBT_PRIVATE double sg_tcp_gamma;
30 extern XBT_PRIVATE double sg_sender_gap;
31 extern XBT_PRIVATE double sg_latency_factor;
32 extern XBT_PRIVATE double sg_bandwidth_factor;
33 extern XBT_PRIVATE double sg_weight_S_parameter;
34 extern XBT_PRIVATE int sg_network_crosstraffic;
35 extern XBT_PRIVATE xbt_dynar_t surf_path;
38 SURF_NETWORK_ELEMENT_NULL = 0, /* NULL */
39 SURF_NETWORK_ELEMENT_HOST, /* host type */
40 SURF_NETWORK_ELEMENT_ROUTER, /* router type */
41 SURF_NETWORK_ELEMENT_AS /* AS type */
42 } e_surf_network_element_type_t;
55 class NetworkCm02Link;
58 class StorageActionLmm;
62 typedef struct Model Model;
63 typedef struct CpuModel CpuModel;
64 typedef struct HostModel HostModel;
65 typedef struct VMModel VMModel;
66 typedef struct NetworkModel NetworkModel;
67 typedef struct StorageModel StorageModel;
68 typedef struct Resource Resource;
69 typedef struct ResourceLmm ResourceLmm;
70 typedef struct HostCLM03 HostCLM03;
71 typedef struct Host Host;
72 typedef struct NetworkCm02Link NetworkCm02Link;
73 typedef struct Action Action;
74 typedef struct ActionLmm ActionLmm;
75 typedef struct StorageActionLmm StorageActionLmm;
77 typedef struct RoutingPlatf RoutingPlatf;
80 /** @ingroup SURF_c_bindings
81 * \brief Model datatype
83 * Generic data structure for a model. The hosts,
84 * the CPUs and the network links are examples of models.
86 typedef Model *surf_model_t;
87 typedef CpuModel *surf_cpu_model_t;
88 typedef HostModel *surf_host_model_t;
89 typedef VMModel *surf_vm_model_t;
91 typedef NetworkModel *surf_network_model_t;
92 typedef StorageModel *surf_storage_model_t;
94 typedef xbt_dictelm_t surf_resource_t;
95 typedef Resource *surf_cpp_resource_t;
96 typedef Host *surf_host_t;
97 typedef Cpu *surf_cpu_t;
99 /** @ingroup SURF_c_bindings
100 * \brief Action structure
102 * Never create s_surf_action_t by yourself ! The actions are created
103 * on the fly when you call execute or communicate on a model.
105 * \see e_surf_action_state_t
107 typedef Action *surf_action_t;
110 typedef RoutingPlatf *routing_platf_t;
112 typedef struct surf_file *surf_file_t;
114 XBT_PUBLIC(e_surf_network_element_type_t)
115 routing_get_network_element_type(const char* name);
117 /** @Brief Specify that we use that action */
118 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
120 /** @brief Creates a new action.
122 * @param size The size is the one of the subtype you want to create
123 * @param cost initial value
124 * @param model to which model we should attach this action
125 * @param failed whether we should start this action in failed mode
127 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
128 surf_model_t model, int failed);
130 /** \brief Resource model description
132 typedef struct surf_model_description {
134 const char *description;
135 void_f_void_t model_init_preparse;
136 } s_surf_model_description_t, *surf_model_description_t;
138 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
140 XBT_PUBLIC(void) model_help(const char *category,
141 s_surf_model_description_t * table);
143 /** @ingroup SURF_interface
144 * @brief Action states
149 SURF_ACTION_READY = 0, /**< Ready */
150 SURF_ACTION_RUNNING, /**< Running */
151 SURF_ACTION_FAILED, /**< Task Failure */
152 SURF_ACTION_DONE, /**< Completed */
153 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
154 SURF_ACTION_NOT_IN_THE_SYSTEM /**< Not in the system anymore. Why did you ask ? */
155 } e_surf_action_state_t;
157 /** @ingroup SURF_vm_interface
161 /* FIXME: Where should the VM state be defined? */
163 SURF_VM_STATE_CREATED, /**< created, but not yet started */
164 SURF_VM_STATE_RUNNING,
165 SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
167 SURF_VM_STATE_SAVING, /**< Save/restore involves disk I/O, so there should be transition states. */
169 SURF_VM_STATE_RESTORING,
172 /***************************/
173 /* Generic model object */
174 /***************************/
176 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
178 static inline surf_host_t surf_host_resource_priv(const void *host){
179 return (surf_host_t) xbt_lib_get_level((xbt_dictelm_t)host, SURF_HOST_LEVEL);
181 static inline void *surf_storage_resource_priv(const void *storage){
182 return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
185 static inline void *surf_storage_resource_by_name(const char *name){
186 return xbt_lib_get_elm_or_null(storage_lib, name);
189 /** @{ @ingroup SURF_c_bindings */
192 * @brief Pop an action from the done actions set
194 * @param model The model from which the action is extracted
195 * @return An action in done state
197 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
200 * @brief Pop an action from the failed actions set
202 * @param model The model from which the action is extracted
203 * @return An action in failed state
205 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
208 * @brief Pop an action from the ready actions set
210 * @param model The model from which the action is extracted
211 * @return An action in ready state
213 XBT_PUBLIC(surf_action_t) surf_model_extract_ready_action_set(surf_model_t model);
216 * @brief Pop an action from the running actions set
218 * @param model The model from which the action is extracted
219 * @return An action in running state
221 XBT_PUBLIC(surf_action_t) surf_model_extract_running_action_set(surf_model_t model);
224 * @brief Get the size of the running action set of a model
226 * @param model The model
227 * @return The size of the running action set
229 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
232 * @brief Execute a parallel task
233 * @details [long description]
235 * @param model The model which handle the parallelisation
236 * @param host_nb The number of hosts
237 * @param host_list The list of hosts on which the task is executed
238 * @param flops_amount The processing amount (in flop) needed to process
239 * @param bytes_amount The amount of data (in bytes) needed to transfer
240 * @param rate [description]
241 * @return The action corresponding to the parallele execution task
243 XBT_PUBLIC(surf_action_t) surf_host_model_execute_parallel_task(surf_host_model_t model,
245 sg_host_t *host_list,
246 double *flops_amount,
247 double *bytes_amount,
250 /** @brief Get the route (dynar of sg_link_t) between two hosts */
251 XBT_PUBLIC(xbt_dynar_t) surf_host_model_get_route(surf_host_model_t model, surf_resource_t src, surf_resource_t dst);
253 /** @brief Create a new VM on the specified host */
254 XBT_PUBLIC(void) surf_vm_model_create(const char *name, surf_resource_t host_PM);
256 /** @brief Create a communication between two hosts
258 * @param model The model which handle the communication
259 * @param src The source host
260 * @param dst The destination host
261 * @param size The amount of data (in bytes) needed to transfer
262 * @param rate [description]
263 * @return The action corresponding to the communication
265 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);
268 * @brief Get the name of a surf resource (cpu, host, network, …)
270 * @param resource The surf resource
271 * @return The name of the surf resource
273 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
274 static inline const char * surf_cpu_name(surf_cpu_t cpu) {
275 return surf_resource_name((surf_cpp_resource_t)cpu);
278 /** @brief Get the properties of a surf resource (cpu, host, network, …) */
279 XBT_PUBLIC(xbt_dict_t) surf_resource_get_properties(surf_cpp_resource_t resource);
280 static XBT_INLINE xbt_dict_t surf_host_get_properties(surf_host_t host) {
281 return surf_resource_get_properties((surf_cpp_resource_t)host);
285 /** @brief Get the state of a surf resource (cpu, host, network, …) */
286 XBT_PUBLIC(e_surf_resource_state_t) surf_resource_get_state(surf_cpp_resource_t resource);
288 static XBT_INLINE e_surf_resource_state_t surf_host_get_state(surf_host_t host) {
289 return surf_resource_get_state((surf_cpp_resource_t)host);
293 /** @brief Set the state of a surf resource (cpu, host, network, …) */
294 XBT_PUBLIC(void) surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state);
295 static inline void surf_host_set_state(surf_host_t host, e_surf_resource_state_t state) {
296 surf_resource_set_state((surf_cpp_resource_t)host, state);
299 /** @brief Get the speed of the cpu associated to a host */
300 XBT_PUBLIC(double) surf_host_get_speed(surf_resource_t resource, double load);
302 /** @brief Get the available speed of cpu associated to a host */
303 XBT_PUBLIC(double) surf_host_get_available_speed(surf_resource_t host);
305 /** @brief Get the number of cores of the cpu associated to a host */
306 XBT_PUBLIC(int) surf_host_get_core(surf_resource_t host);
308 /** @brief Create a computation action on the given host */
309 XBT_PUBLIC(surf_action_t) surf_host_execute(surf_resource_t host, double size);
311 /** @brief Create a sleep action on the given host */
312 XBT_PUBLIC(surf_action_t) surf_host_sleep(surf_resource_t host, double duration);
314 /** @brief Create a file opening action on the given host */
315 XBT_PUBLIC(surf_action_t) surf_host_open(surf_resource_t host, const char* fullpath);
317 /** @brief Create a file closing action on the given host */
318 XBT_PUBLIC(surf_action_t) surf_host_close(surf_resource_t host, surf_file_t fd);
320 /** @brief Create a file reading action on the given host */
321 XBT_PUBLIC(surf_action_t) surf_host_read(surf_resource_t host, surf_file_t fd, sg_size_t size);
323 /** @brief Create a file writing action on the given host */
324 XBT_PUBLIC(surf_action_t) surf_host_write(surf_resource_t host, surf_file_t fd, sg_size_t size);
327 * @brief Get the informations of a file descriptor
328 * @details The returned xbt_dynar_t contains:
329 * - the size of the file,
331 * - the storage name,
332 * - the storage typeId,
333 * - the storage content type
335 * @param host The surf host
336 * @param fd The file descriptor
337 * @return An xbt_dynar_t with the file informations
339 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(surf_resource_t host, surf_file_t fd);
342 * @brief Get the available space of the storage at the mount point
344 * @param resource The surf host
345 * @param name The mount point
346 * @return The amount of available space in bytes
348 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(surf_resource_t resource, const char* name);
351 * @brief Get the used space of the storage at the mount point
353 * @param resource The surf host
354 * @param name The mount point
355 * @return The amount of used space in bytes
357 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(surf_resource_t resource, const char* name);
359 /** @brief Get the list of VMs hosted on the host */
360 XBT_PUBLIC(xbt_dynar_t) surf_host_get_vms(surf_resource_t resource);
362 /** @brief Retrieve the params of that VM
363 * @details You can use fields ramsize and overcommit on a PM, too.
365 XBT_PUBLIC(void) surf_host_get_params(surf_resource_t resource, vm_params_t params);
367 /** @brief Sets the params of that VM/PM
368 * @details You can use fields ramsize and overcommit on a PM, too.
370 XBT_PUBLIC(void) surf_host_set_params(surf_resource_t resource, vm_params_t params);
373 * @brief Destroy a VM
375 * @param resource The surf vm
377 XBT_PUBLIC(void) surf_vm_destroy(surf_resource_t resource);
379 /** @brief Suspend a VM */
380 XBT_PUBLIC(void) surf_vm_suspend(surf_resource_t resource);
382 /** @brief Resume a VM */
383 XBT_PUBLIC(void) surf_vm_resume(surf_resource_t resource);
386 * @brief Save the VM (Not yet implemented)
388 * @param resource The surf vm
390 XBT_PUBLIC(void) surf_vm_save(surf_resource_t resource);
393 * @brief Restore the VM (Not yet implemented)
395 * @param resource The surf vm
397 XBT_PUBLIC(void) surf_vm_restore(surf_resource_t resource);
400 * @brief Migrate the VM to the destination host
402 * @param resource The surf vm
403 * @param ind_vm_ws_dest The destination host
405 XBT_PUBLIC(void) surf_vm_migrate(surf_resource_t resource, surf_resource_t ind_vm_ws_dest);
408 * @brief Get the physical machine hosting the VM
410 * @param resource The surf vm
411 * @return The physical machine hosting the VM
413 XBT_PUBLIC(surf_resource_t) surf_vm_get_pm(surf_resource_t resource);
416 * @brief [brief description]
417 * @details [long description]
419 * @param resource [description]
420 * @param bound [description]
422 XBT_PUBLIC(void) surf_vm_set_bound(surf_resource_t resource, double bound);
425 * @brief [brief description]
426 * @details [long description]
428 * @param resource [description]
429 * @param cpu [description]
430 * @param mask [description]
432 XBT_PUBLIC(void) surf_vm_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask);
435 * @brief Execute some quantity of computation
437 * @param cpu The surf cpu
438 * @param size The value of the processing amount (in flop) needed to process
439 * @return The surf action corresponding to the processing
441 XBT_PUBLIC(surf_action_t) surf_cpu_execute(surf_resource_t cpu, double size);
444 * @brief Make the cpu sleep for duration (in seconds)
445 * @details [long description]
447 * @param cpu The surf cpu
448 * @param duration The number of seconds to sleep
449 * @return The surf action corresponding to the sleeping
451 XBT_PUBLIC(surf_action_t) surf_cpu_sleep(surf_resource_t cpu, double duration);
454 * @brief Get the host power peak
455 * @details [long description]
457 * @param host The surf host
458 * @return The power peak
460 XBT_PUBLIC(double) surf_host_get_current_power_peak(surf_resource_t host);
463 * @brief [brief description]
464 * @details [long description]
466 * @param host [description]
467 * @param pstate_index [description]
469 * @return [description]
471 XBT_PUBLIC(double) surf_host_get_power_peak_at(surf_resource_t host, int pstate_index);
474 * @brief [brief description]
475 * @details [long description]
477 * @param host [description]
478 * @return [description]
480 XBT_PUBLIC(int) surf_host_get_nb_pstates(surf_resource_t host);
482 XBT_PUBLIC(void) surf_host_set_pstate(surf_resource_t host, int pstate_index);
483 XBT_PUBLIC(int) surf_host_get_pstate(surf_resource_t host);
484 XBT_PUBLIC(double) surf_host_get_wattmin_at(surf_resource_t resource, int pstate);
485 XBT_PUBLIC(double) surf_host_get_wattmax_at(surf_resource_t resource, int pstate);
488 * @brief Get the consumed energy (in joules) of an host
490 * @param host The surf host
491 * @return The consumed energy
493 XBT_PUBLIC(double) surf_host_get_consumed_energy(surf_resource_t host);
496 * @brief Get the list of storages mounted on an host
498 * @param host The surf host
499 * @return Dictionary of mount point, Storage
501 XBT_PUBLIC(xbt_dict_t) surf_host_get_mounted_storage_list(surf_resource_t host);
504 * @brief Get the list of storages attached to an host
506 * @param host The surf host
507 * @return Dictionary of storage
509 XBT_PUBLIC(xbt_dynar_t) surf_host_get_attached_storage_list(surf_resource_t host);
512 * @brief Unlink a file descriptor
514 * @param host The surf host
515 * @param fd The file descriptor
517 * @return 0 if failed to unlink, 1 otherwise
519 XBT_PUBLIC(int) surf_host_unlink(surf_resource_t host, surf_file_t fd);
522 * @brief Get the size of a file on a host
524 * @param host The surf host
525 * @param fd The file descriptor
527 * @return The size in bytes of the file
529 XBT_PUBLIC(size_t) surf_host_get_size(surf_resource_t host, surf_file_t fd);
532 * @brief Get the current position of the file descriptor
534 * @param host The surf host
535 * @param fd The file descriptor
536 * @return The current position of the file descriptor
538 XBT_PUBLIC(size_t) surf_host_file_tell(surf_resource_t host, surf_file_t fd);
541 * @brief Move a file to another location on the *same mount point*.
542 * @details [long description]
544 * @param host The surf host
545 * @param fd The file descriptor
546 * @param fullpath The new full path
548 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
550 XBT_PUBLIC(int) surf_host_file_move(surf_resource_t host, surf_file_t fd, const char* fullpath);
553 * @brief Set the position indictator assiociated with the file descriptor to a new position
554 * @details [long description]
556 * @param host The surf host
557 * @param fd The file descriptor
558 * @param offset The offset from the origin
559 * @param origin Position used as a reference for the offset
560 * - SEEK_SET: beginning of the file
561 * - SEEK_CUR: current position indicator
562 * - SEEK_END: end of the file
563 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
565 XBT_PUBLIC(int) surf_host_file_seek(surf_resource_t host,
566 surf_file_t fd, sg_offset_t offset,
570 * @brief Get the content of a storage
572 * @param resource The surf storage
573 * @return A xbt_dict_t with path as keys and size in bytes as values
575 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
578 * @brief Get the size in bytes of a storage
580 * @param resource The surf storage
581 * @return The size in bytes of the storage
583 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
586 * @brief Get the available size in bytes of a storage
588 * @param resource The surf storage
589 * @return The available size in bytes of the storage
591 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
594 * @brief Get the size in bytes of a storage
596 * @param resource The surf storage
597 * @return The used size in bytes of the storage
599 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
603 * @brief Get the data associated to the action
605 * @param action The surf action
606 * @return The data associated to the action
608 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
611 * @brief Set the data associated to the action
612 * @details [long description]
614 * @param action The surf action
615 * @param data The new data associated to the action
617 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
620 * @brief Unreference an action
622 * @param action The surf action
624 XBT_PUBLIC(void) surf_action_unref(surf_action_t action);
627 * @brief Get the start time of an action
629 * @param action The surf action
630 * @return The start time in seconds from the beginning of the simulation
632 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
635 * @brief Get the finish time of an action
637 * @param action The surf action
638 * @return The finish time in seconds from the beginning of the simulation
640 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
643 * @brief Get the remains amount of work to do of an action
645 * @param action The surf action
646 * @return The remains amount of work to do
648 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
651 * @brief Suspend an action
653 * @param action The surf action
655 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
658 * @brief Resume an action
660 * @param action The surf action
662 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
665 * @brief Cancel an action
667 * @param action The surf action
669 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
672 * @brief Set the priority of an action
673 * @details [long description]
675 * @param action The surf action
676 * @param priority The new priority [TODO]
678 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
681 * @brief Set the category of an action
682 * @details [long description]
684 * @param action The surf action
685 * @param category The new category of the action
687 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
690 * @brief Get the state of an action
692 * @param action The surf action
693 * @return The state of the action
695 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
698 * @brief Get the cost of an action
700 * @param action The surf action
701 * @return The cost of the action
703 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
706 * @brief [brief desrciption]
707 * @details [long description]
709 * @param action The surf cpu action
710 * @param cpu [description]
711 * @param mask [description]
713 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask);
716 * @brief [brief description]
717 * @details [long description]
719 * @param action The surf cpu action
720 * @param bound [description]
722 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
725 * @brief [brief description]
726 * @details [long description]
728 * @param action The surf network action
730 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
733 * @brief Get the file associated to a storage action
735 * @param action The surf storage action
736 * @return The file associated to a storage action
738 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
741 * @brief Get the result dictionary of an ls action
743 * @param action The surf storage action
744 * @return The dictionry listing a path
746 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
750 * @brief Get the host the storage is attached to
752 * @param resource The surf storage
753 * @return The host name
755 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
757 XBT_PUBLIC(surf_model_t) surf_resource_model(const void *host, int level);
761 /**************************************/
762 /* Implementations of model object */
763 /**************************************/
765 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
766 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
768 /** \ingroup SURF_models
769 * \brief The CPU model object for the physical machine layer
771 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
773 /** \ingroup SURF_models
774 * \brief The CPU model object for the virtual machine layer
776 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
779 /** \ingroup SURF_models
780 * \brief Initializes the CPU model with the model Cas01
782 * By default, this model uses the lazy optimization mechanism that
783 * relies on partial invalidation in LMM and a heap for lazy action update.
784 * You can change this behavior by setting the cpu/optim configuration
785 * variable to a different value.
787 * You shouldn't have to call it by yourself.
789 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
791 /** \ingroup SURF_models
792 * \brief Initializes the CPU model with trace integration [Deprecated]
794 * You shouldn't have to call it by yourself.
796 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
798 /** \ingroup SURF_models
799 * \brief The list of all available optimization modes (both for cpu and networks).
800 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
802 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
804 /** \ingroup SURF_plugins
805 * \brief The list of all available surf plugins
807 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
809 /** \ingroup SURF_models
810 * \brief The list of all available cpu model models
812 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
814 /**\brief create new host bypass the parser
819 /** \ingroup SURF_models
820 * \brief The network model
822 * When creating a new API on top on SURF, you shouldn't use the
823 * network model unless you know what you are doing. Only the host
824 * model should be accessed because depending on the platform model,
825 * the network model can be NULL.
827 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
829 /** \ingroup SURF_models
830 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
832 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
833 * based on the model 'LV08' and different correction factors depending on the communication
834 * size (< 1KiB, < 64KiB, >= 64KiB).
835 * See comments in the code for more information.
837 * \see surf_host_model_init_SMPI()
839 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
841 /** \ingroup SURF_models
842 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
844 * This model impelments a variant of the contention model on Infinband networks based on
845 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
847 * \see surf_host_model_init_IB()
849 XBT_PUBLIC(void) surf_network_model_init_IB(void);
851 /** \ingroup SURF_models
852 * \brief Initializes the platform with the network model 'LegrandVelho'
854 * This model is proposed by Arnaud Legrand and Pedro Velho based on
855 * the results obtained with the GTNets simulator for onelink and
856 * dogbone sharing scenarios. See comments in the code for more information.
858 * \see surf_host_model_init_LegrandVelho()
860 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
862 /** \ingroup SURF_models
863 * \brief Initializes the platform with the network model 'Constant'
865 * In this model, the communication time between two network cards is
866 * constant, hence no need for a routing table. This is particularly
867 * usefull when simulating huge distributed algorithms where
868 * scalability is really an issue. This function is called in
869 * conjunction with surf_host_model_init_compound.
871 * \see surf_host_model_init_compound()
873 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
875 /** \ingroup SURF_models
876 * \brief Initializes the platform with the network model CM02
878 * You sould call this function by yourself only if you plan using
879 * surf_host_model_init_compound.
880 * See comments in the code for more information.
882 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
885 /** \ingroup SURF_models
886 * \brief Initializes the platform with the network model NS3
888 * This function is called by surf_host_model_init_NS3
889 * or by yourself only if you plan using surf_host_model_init_compound
891 * \see surf_host_model_init_NS3()
893 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
896 /** \ingroup SURF_models
897 * \brief Initializes the platform with the network model Reno
899 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
902 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
903 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
905 * Call this function only if you plan using surf_host_model_init_compound.
908 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
910 /** \ingroup SURF_models
911 * \brief Initializes the platform with the network model Reno2
913 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
916 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
917 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
919 * Call this function only if you plan using surf_host_model_init_compound.
922 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
924 /** \ingroup SURF_models
925 * \brief Initializes the platform with the network model Vegas
927 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
928 * to the proportional fairness.
931 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
932 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
934 * Call this function only if you plan using surf_host_model_init_compound.
937 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
939 /** \ingroup SURF_models
940 * \brief The list of all available network model models
942 XBT_PUBLIC_DATA(s_surf_model_description_t)
943 surf_network_model_description[];
945 /** \ingroup SURF_models
946 * \brief The storage model
948 XBT_PUBLIC(void) surf_storage_model_init_default(void);
950 /** \ingroup SURF_models
951 * \brief The list of all available storage modes.
952 * This storage mode can be set using --cfg=storage/model:...
954 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
956 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
958 /** \ingroup SURF_models
959 * \brief The host model
961 * Note that when you create an API on top of SURF,
962 * the host model should be the only one you use
963 * because depending on the platform model, the network model and the CPU model
966 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
968 /** \ingroup SURF_models
969 * \brief The vm model
971 * Note that when you create an API on top of SURF,
972 * the vm model should be the only one you use
973 * because depending on the platform model, the network model and the CPU model
976 XBT_PUBLIC_DATA(surf_vm_model_t) surf_vm_model;
978 /** \ingroup SURF_models
979 * \brief Initializes the platform with a compound host model
981 * This function should be called after a cpu_model and a
982 * network_model have been set up.
985 XBT_PUBLIC(void) surf_host_model_init_compound(void);
987 /** \ingroup SURF_models
988 * \brief Initializes the platform with the current best network and cpu models at hand
990 * This platform model separates the host model and the network model.
991 * The host model will be initialized with the model compound, the network
992 * model with the model LV08 (with cross traffic support) and the CPU model with
994 * Such model is subject to modification with warning in the ChangeLog so monitor it!
997 XBT_PUBLIC(void) surf_host_model_init_current_default(void);
999 /** \ingroup SURF_models
1000 * \brief Initializes the platform with the model L07
1002 * With this model, only parallel tasks can be used. Resource sharing
1003 * is done by identifying bottlenecks and giving an equal share of
1004 * the model to each action.
1007 XBT_PUBLIC(void) surf_host_model_init_ptask_L07(void);
1009 /** \ingroup SURF_models
1010 * \brief The list of all available host model models
1012 XBT_PUBLIC_DATA(s_surf_model_description_t)
1013 surf_host_model_description[];
1015 /** \ingroup SURF_models
1016 * \brief Initializes the platform with the current best network and cpu models at hand
1018 * This platform model seperates the host model and the network model.
1019 * The host model will be initialized with the model compound, the network
1020 * model with the model LV08 (with cross traffic support) and the CPU model with
1022 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1025 XBT_PUBLIC(void) surf_vm_model_init_HL13(void);
1027 /** \ingroup SURF_models
1028 * \brief The list of all available vm model models
1030 XBT_PUBLIC_DATA(s_surf_model_description_t)
1031 surf_vm_model_description[];
1033 /*******************************************/
1035 /** \ingroup SURF_models
1036 * \brief List of initialized models
1038 XBT_PUBLIC_DATA(xbt_dynar_t) all_existing_models;
1040 /** \ingroup SURF_simulation
1041 * \brief List of hosts that have just restarted and whose autorestart process should be restarted.
1043 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
1045 /** \ingroup SURF_simulation
1046 * \brief List of hosts for which one want to be notified if they ever restart.
1048 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
1050 /*******************************************/
1051 /*** SURF Platform *************************/
1052 /*******************************************/
1053 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
1054 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
1055 XBT_PUBLIC_DATA(AS_t) surf_AS_get_by_name(const char * name);
1056 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
1057 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
1058 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
1059 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
1060 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
1061 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
1063 /*******************************************/
1064 /*** SURF Globals **************************/
1065 /*******************************************/
1067 /** \ingroup SURF_simulation
1068 * \brief Initialize SURF
1069 * \param argc argument number
1070 * \param argv arguments
1072 * This function has to be called to initialize the common
1073 * structures. Then you will have to create the environment by
1075 * e.g. surf_host_model_init_CM02()
1077 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
1079 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
1081 /** \ingroup SURF_simulation
1082 * \brief Finish simulation initialization
1084 * This function must be called before the first call to surf_solve()
1086 XBT_PUBLIC(void) surf_presolve(void);
1088 /** \ingroup SURF_simulation
1089 * \brief Performs a part of the simulation
1090 * \param max_date Maximum date to update the simulation to, or -1
1091 * \return the elapsed time, or -1.0 if no event could be executed
1093 * This function execute all possible events, update the action states
1094 * and returns the time elapsed.
1095 * When you call execute or communicate on a model, the corresponding actions
1096 * are not executed immediately but only when you call surf_solve.
1097 * Note that the returned elapsed time can be zero.
1099 XBT_PUBLIC(double) surf_solve(double max_date);
1101 /** \ingroup SURF_simulation
1102 * \brief Return the current time
1104 * Return the current time in millisecond.
1106 XBT_PUBLIC(double) surf_get_clock(void);
1108 /** \ingroup SURF_simulation
1115 XBT_PUBLIC(void) surf_exit(void);
1117 /* Prototypes of the functions that handle the properties */
1118 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
1120 /* The same for model_prop set*/
1121 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
1123 /* surf parse file related (public because called from a test suite) */
1124 XBT_PUBLIC(void) parse_platform_file(const char *file);
1126 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
1127 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
1128 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
1129 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
1130 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
1131 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
1132 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
1135 XBT_PUBLIC(double) get_cpu_speed(const char *power);
1137 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
1139 int surf_get_nthreads(void);
1140 void surf_set_nthreads(int nthreads);
1143 * Returns the initial path. On Windows the initial path is
1144 * the current directory for the current process in the other
1145 * case the function returns "./" that represents the current
1146 * directory on Unix/Linux platforms.
1148 const char *__surf_get_initial_path(void);
1150 /********** Tracing **********/
1151 /* from surf_instr.c */
1152 void TRACE_surf_action(surf_action_t surf_action, const char *category);
1153 void TRACE_surf_alloc(void);
1154 void TRACE_surf_release(void);
1156 /* instr_routing.c */
1157 void instr_routing_define_callbacks (void);
1158 void instr_new_variable_type (const char *new_typename, const char *color);
1159 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
1160 void instr_new_user_state_type (const char *father_type, const char *new_typename);
1161 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
1162 int instr_platform_traced (void);
1163 xbt_graph_t instr_routing_platform_graph (void);
1164 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1166 /********** Routing **********/
1167 void routing_AS_begin(sg_platf_AS_cbarg_t AS);
1168 void routing_AS_end(void);
1169 RoutingEdge *routing_add_host(As* as, sg_platf_host_cbarg_t host);
1170 void routing_cluster_add_backbone(void* bb);
1171 As* routing_get_current();
1174 #endif /* _SURF_SURF_H */