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"
25 /* Actions and models are highly connected structures... */
27 /* user-visible parameters */
28 extern XBT_PRIVATE double sg_tcp_gamma;
29 extern XBT_PRIVATE double sg_sender_gap;
30 extern XBT_PRIVATE double sg_latency_factor;
31 extern XBT_PRIVATE double sg_bandwidth_factor;
32 extern XBT_PRIVATE double sg_weight_S_parameter;
33 extern XBT_PRIVATE int sg_network_crosstraffic;
34 extern XBT_PRIVATE xbt_dynar_t surf_path;
37 SURF_NETWORK_ELEMENT_NULL = 0, /* NULL */
38 SURF_NETWORK_ELEMENT_HOST, /* host type */
39 SURF_NETWORK_ELEMENT_ROUTER, /* router type */
40 SURF_NETWORK_ELEMENT_AS /* AS type */
41 } e_surf_network_element_type_t;
54 class NetworkCm02Link;
57 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 RoutingEdge RoutingEdge;
78 typedef struct RoutingPlatf RoutingPlatf;
81 /** @ingroup SURF_c_bindings
82 * \brief Model datatype
84 * Generic data structure for a model. The hosts,
85 * the CPUs and the network links are examples of models.
87 typedef Model *surf_model_t;
88 typedef CpuModel *surf_cpu_model_t;
89 typedef HostModel *surf_host_model_t;
90 typedef VMModel *surf_vm_model_t;
92 typedef NetworkModel *surf_network_model_t;
93 typedef StorageModel *surf_storage_model_t;
95 typedef xbt_dictelm_t surf_resource_t;
96 typedef Resource *surf_cpp_resource_t;
97 typedef Host *surf_host_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 RoutingEdge *routing_edge_t;
111 typedef RoutingPlatf *routing_platf_t;
113 typedef struct surf_file *surf_file_t;
115 XBT_PUBLIC(e_surf_network_element_type_t)
116 routing_get_network_element_type(const char* name);
118 /** @Brief Specify that we use that action */
119 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
121 /** @brief Creates a new action.
123 * @param size The size is the one of the subtype you want to create
124 * @param cost initial value
125 * @param model to which model we should attach this action
126 * @param failed whether we should start this action in failed mode
128 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
129 surf_model_t model, int failed);
131 /** \brief Resource model description
133 typedef struct surf_model_description {
135 const char *description;
136 void_f_void_t model_init_preparse;
137 } s_surf_model_description_t, *surf_model_description_t;
139 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
141 XBT_PUBLIC(void) model_help(const char *category,
142 s_surf_model_description_t * table);
144 /** @ingroup SURF_interface
145 * @brief Action states
150 SURF_ACTION_READY = 0, /**< Ready */
151 SURF_ACTION_RUNNING, /**< Running */
152 SURF_ACTION_FAILED, /**< Task Failure */
153 SURF_ACTION_DONE, /**< Completed */
154 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
155 SURF_ACTION_NOT_IN_THE_SYSTEM /**< Not in the system anymore. Why did you ask ? */
156 } e_surf_action_state_t;
158 /** @ingroup SURF_vm_interface
162 /* FIXME: Where should the VM state be defined? */
164 SURF_VM_STATE_CREATED, /**< created, but not yet started */
165 SURF_VM_STATE_RUNNING,
166 SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
168 SURF_VM_STATE_SAVING, /**< Save/restore involves disk I/O, so there should be transition states. */
170 SURF_VM_STATE_RESTORING,
173 /***************************/
174 /* Generic model object */
175 /***************************/
177 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
179 static inline surf_host_t surf_host_resource_priv(const void *host){
180 return (surf_host_t) xbt_lib_get_level((xbt_dictelm_t)host, SURF_HOST_LEVEL);
182 static inline void *surf_storage_resource_priv(const void *storage){
183 return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
186 static inline void *surf_storage_resource_by_name(const char *name){
187 return xbt_lib_get_elm_or_null(storage_lib, name);
190 /** @{ @ingroup SURF_c_bindings */
193 * @brief Pop an action from the done actions set
195 * @param model The model from which the action is extracted
196 * @return An action in done state
198 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
201 * @brief Pop an action from the failed actions set
203 * @param model The model from which the action is extracted
204 * @return An action in failed state
206 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
209 * @brief Pop an action from the ready actions set
211 * @param model The model from which the action is extracted
212 * @return An action in ready state
214 XBT_PUBLIC(surf_action_t) surf_model_extract_ready_action_set(surf_model_t model);
217 * @brief Pop an action from the running actions set
219 * @param model The model from which the action is extracted
220 * @return An action in running state
222 XBT_PUBLIC(surf_action_t) surf_model_extract_running_action_set(surf_model_t model);
225 * @brief Get the size of the running action set of a model
227 * @param model The model
228 * @return The size of the running action set
230 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
233 * @brief Execute a parallel task
234 * @details [long description]
236 * @param model The model which handle the parallelisation
237 * @param host_nb The number of hosts
238 * @param host_list The list of hosts on which the task is executed
239 * @param flops_amount The processing amount (in flop) needed to process
240 * @param bytes_amount The amount of data (in bytes) needed to transfer
241 * @param rate [description]
242 * @return The action corresponding to the parallele execution task
244 XBT_PUBLIC(surf_action_t) surf_host_model_execute_parallel_task(surf_host_model_t model,
246 sg_host_t *host_list,
247 double *flops_amount,
248 double *bytes_amount,
251 /** @brief Get the route (dynar of sg_link_t) between two hosts */
252 XBT_PUBLIC(xbt_dynar_t) surf_host_model_get_route(surf_host_model_t model, surf_resource_t src, surf_resource_t dst);
254 /** @brief Create a new VM on the specified host */
255 XBT_PUBLIC(void) surf_vm_model_create(const char *name, surf_resource_t host_PM);
257 /** @brief Create a communication between two hosts
259 * @param model The model which handle the communication
260 * @param src The source host
261 * @param dst The destination host
262 * @param size The amount of data (in bytes) needed to transfer
263 * @param rate [description]
264 * @return The action corresponding to the communication
266 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);
269 * @brief Get the name of a surf resource (cpu, host, network, …)
271 * @param resource The surf resource
272 * @return The name of the surf resource
274 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
275 static inline const char * surf_cpu_name(surf_cpu_t cpu) {
276 return surf_resource_name((surf_cpp_resource_t)cpu);
279 /** @brief Get the properties of a surf resource (cpu, host, network, …) */
280 XBT_PUBLIC(xbt_dict_t) surf_resource_get_properties(surf_cpp_resource_t resource);
281 static XBT_INLINE xbt_dict_t surf_host_get_properties(surf_host_t host) {
282 return surf_resource_get_properties((surf_cpp_resource_t)host);
286 /** @brief Get the state of a surf resource (cpu, host, network, …) */
287 XBT_PUBLIC(e_surf_resource_state_t) surf_resource_get_state(surf_cpp_resource_t resource);
289 static XBT_INLINE e_surf_resource_state_t surf_host_get_state(surf_host_t host) {
290 return surf_resource_get_state((surf_cpp_resource_t)host);
294 /** @brief Set the state of a surf resource (cpu, host, network, …) */
295 XBT_PUBLIC(void) surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state);
296 static inline void surf_host_set_state(surf_host_t host, e_surf_resource_state_t state) {
297 surf_resource_set_state((surf_cpp_resource_t)host, state);
300 /** @brief Get the speed of the cpu associated to a host */
301 XBT_PUBLIC(double) surf_host_get_speed(surf_resource_t resource, double load);
303 /** @brief Get the available speed of cpu associated to a host */
304 XBT_PUBLIC(double) surf_host_get_available_speed(surf_resource_t host);
306 /** @brief Get the number of cores of the cpu associated to a host */
307 XBT_PUBLIC(int) surf_host_get_core(surf_resource_t host);
309 /** @brief Create a computation action on the given host */
310 XBT_PUBLIC(surf_action_t) surf_host_execute(surf_resource_t host, double size);
312 /** @brief Create a sleep action on the given host */
313 XBT_PUBLIC(surf_action_t) surf_host_sleep(surf_resource_t host, double duration);
315 /** @brief Create a file opening action on the given host */
316 XBT_PUBLIC(surf_action_t) surf_host_open(surf_resource_t host, const char* fullpath);
318 /** @brief Create a file closing action on the given host */
319 XBT_PUBLIC(surf_action_t) surf_host_close(surf_resource_t host, surf_file_t fd);
321 /** @brief Create a file reading action on the given host */
322 XBT_PUBLIC(surf_action_t) surf_host_read(surf_resource_t host, surf_file_t fd, sg_size_t size);
324 /** @brief Create a file writing action on the given host */
325 XBT_PUBLIC(surf_action_t) surf_host_write(surf_resource_t host, surf_file_t fd, sg_size_t size);
328 * @brief Get the informations of a file descriptor
329 * @details The returned xbt_dynar_t contains:
330 * - the size of the file,
332 * - the storage name,
333 * - the storage typeId,
334 * - the storage content type
336 * @param host The surf host
337 * @param fd The file descriptor
338 * @return An xbt_dynar_t with the file informations
340 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(surf_resource_t host, surf_file_t fd);
343 * @brief Get the available space of the storage at the mount point
345 * @param resource The surf host
346 * @param name The mount point
347 * @return The amount of available space in bytes
349 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(surf_resource_t resource, const char* name);
352 * @brief Get the used space of the storage at the mount point
354 * @param resource The surf host
355 * @param name The mount point
356 * @return The amount of used space in bytes
358 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(surf_resource_t resource, const char* name);
360 /** @brief Get the list of VMs hosted on the host */
361 XBT_PUBLIC(xbt_dynar_t) surf_host_get_vms(surf_resource_t resource);
363 /** @brief Retrieve the params of that VM
364 * @details You can use fields ramsize and overcommit on a PM, too.
366 XBT_PUBLIC(void) surf_host_get_params(surf_resource_t resource, vm_params_t params);
368 /** @brief Sets the params of that VM/PM
369 * @details You can use fields ramsize and overcommit on a PM, too.
371 XBT_PUBLIC(void) surf_host_set_params(surf_resource_t resource, vm_params_t params);
374 * @brief Destroy a VM
376 * @param resource The surf vm
378 XBT_PUBLIC(void) surf_vm_destroy(surf_resource_t resource);
380 /** @brief Suspend a VM */
381 XBT_PUBLIC(void) surf_vm_suspend(surf_resource_t resource);
383 /** @brief Resume a VM */
384 XBT_PUBLIC(void) surf_vm_resume(surf_resource_t resource);
387 * @brief Save the VM (Not yet implemented)
389 * @param resource The surf vm
391 XBT_PUBLIC(void) surf_vm_save(surf_resource_t resource);
394 * @brief Restore the VM (Not yet implemented)
396 * @param resource The surf vm
398 XBT_PUBLIC(void) surf_vm_restore(surf_resource_t resource);
401 * @brief Migrate the VM to the destination host
403 * @param resource The surf vm
404 * @param ind_vm_ws_dest The destination host
406 XBT_PUBLIC(void) surf_vm_migrate(surf_resource_t resource, surf_resource_t ind_vm_ws_dest);
409 * @brief Get the physical machine hosting the VM
411 * @param resource The surf vm
412 * @return The physical machine hosting the VM
414 XBT_PUBLIC(surf_resource_t) surf_vm_get_pm(surf_resource_t resource);
417 * @brief [brief description]
418 * @details [long description]
420 * @param resource [description]
421 * @param bound [description]
423 XBT_PUBLIC(void) surf_vm_set_bound(surf_resource_t resource, double bound);
426 * @brief [brief description]
427 * @details [long description]
429 * @param resource [description]
430 * @param cpu [description]
431 * @param mask [description]
433 XBT_PUBLIC(void) surf_vm_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask);
436 * @brief Execute some quantity of computation
438 * @param cpu The surf cpu
439 * @param size The value of the processing amount (in flop) needed to process
440 * @return The surf action corresponding to the processing
442 XBT_PUBLIC(surf_action_t) surf_cpu_execute(surf_resource_t cpu, double size);
445 * @brief Make the cpu sleep for duration (in seconds)
446 * @details [long description]
448 * @param cpu The surf cpu
449 * @param duration The number of seconds to sleep
450 * @return The surf action corresponding to the sleeping
452 XBT_PUBLIC(surf_action_t) surf_cpu_sleep(surf_resource_t cpu, double duration);
455 * @brief Get the host power peak
456 * @details [long description]
458 * @param host The surf host
459 * @return The power peak
461 XBT_PUBLIC(double) surf_host_get_current_power_peak(surf_resource_t host);
464 * @brief [brief description]
465 * @details [long description]
467 * @param host [description]
468 * @param pstate_index [description]
470 * @return [description]
472 XBT_PUBLIC(double) surf_host_get_power_peak_at(surf_resource_t host, int pstate_index);
475 * @brief [brief description]
476 * @details [long description]
478 * @param host [description]
479 * @return [description]
481 XBT_PUBLIC(int) surf_host_get_nb_pstates(surf_resource_t host);
483 XBT_PUBLIC(void) surf_host_set_pstate(surf_resource_t host, int pstate_index);
484 XBT_PUBLIC(int) surf_host_get_pstate(surf_resource_t host);
485 XBT_PUBLIC(double) surf_host_get_wattmin_at(surf_resource_t resource, int pstate);
486 XBT_PUBLIC(double) surf_host_get_wattmax_at(surf_resource_t resource, int pstate);
489 * @brief Get the consumed energy (in joules) of an host
491 * @param host The surf host
492 * @return The consumed energy
494 XBT_PUBLIC(double) surf_host_get_consumed_energy(surf_resource_t host);
497 * @brief Get the list of storages mounted on an host
499 * @param host The surf host
500 * @return Dictionary of mount point, Storage
502 XBT_PUBLIC(xbt_dict_t) surf_host_get_mounted_storage_list(surf_resource_t host);
505 * @brief Get the list of storages attached to an host
507 * @param host The surf host
508 * @return Dictionary of storage
510 XBT_PUBLIC(xbt_dynar_t) surf_host_get_attached_storage_list(surf_resource_t host);
513 * @brief Unlink a file descriptor
515 * @param host The surf host
516 * @param fd The file descriptor
518 * @return 0 if failed to unlink, 1 otherwise
520 XBT_PUBLIC(int) surf_host_unlink(surf_resource_t host, surf_file_t fd);
523 * @brief Get the size of a file on a host
525 * @param host The surf host
526 * @param fd The file descriptor
528 * @return The size in bytes of the file
530 XBT_PUBLIC(size_t) surf_host_get_size(surf_resource_t host, surf_file_t fd);
533 * @brief Get the current position of the file descriptor
535 * @param host The surf host
536 * @param fd The file descriptor
537 * @return The current position of the file descriptor
539 XBT_PUBLIC(size_t) surf_host_file_tell(surf_resource_t host, surf_file_t fd);
542 * @brief Move a file to another location on the *same mount point*.
543 * @details [long description]
545 * @param host The surf host
546 * @param fd The file descriptor
547 * @param fullpath The new full path
549 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
551 XBT_PUBLIC(int) surf_host_file_move(surf_resource_t host, surf_file_t fd, const char* fullpath);
554 * @brief Set the position indictator assiociated with the file descriptor to a new position
555 * @details [long description]
557 * @param host The surf host
558 * @param fd The file descriptor
559 * @param offset The offset from the origin
560 * @param origin Position used as a reference for the offset
561 * - SEEK_SET: beginning of the file
562 * - SEEK_CUR: current position indicator
563 * - SEEK_END: end of the file
564 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
566 XBT_PUBLIC(int) surf_host_file_seek(surf_resource_t host,
567 surf_file_t fd, sg_offset_t offset,
571 * @brief Get the content of a storage
573 * @param resource The surf storage
574 * @return A xbt_dict_t with path as keys and size in bytes as values
576 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
579 * @brief Get the size in bytes of a storage
581 * @param resource The surf storage
582 * @return The size in bytes of the storage
584 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
587 * @brief Get the available size in bytes of a storage
589 * @param resource The surf storage
590 * @return The available size in bytes of the storage
592 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
595 * @brief Get the size in bytes of a storage
597 * @param resource The surf storage
598 * @return The used size in bytes of the storage
600 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
604 * @brief Get the data associated to the action
606 * @param action The surf action
607 * @return The data associated to the action
609 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
612 * @brief Set the data associated to the action
613 * @details [long description]
615 * @param action The surf action
616 * @param data The new data associated to the action
618 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
621 * @brief Unreference an action
623 * @param action The surf action
625 XBT_PUBLIC(void) surf_action_unref(surf_action_t action);
628 * @brief Get the start time of an action
630 * @param action The surf action
631 * @return The start time in seconds from the beginning of the simulation
633 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
636 * @brief Get the finish time of an action
638 * @param action The surf action
639 * @return The finish time in seconds from the beginning of the simulation
641 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
644 * @brief Get the remains amount of work to do of an action
646 * @param action The surf action
647 * @return The remains amount of work to do
649 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
652 * @brief Suspend an action
654 * @param action The surf action
656 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
659 * @brief Resume an action
661 * @param action The surf action
663 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
666 * @brief Cancel an action
668 * @param action The surf action
670 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
673 * @brief Set the priority of an action
674 * @details [long description]
676 * @param action The surf action
677 * @param priority The new priority [TODO]
679 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
682 * @brief Set the category of an action
683 * @details [long description]
685 * @param action The surf action
686 * @param category The new category of the action
688 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
691 * @brief Get the state of an action
693 * @param action The surf action
694 * @return The state of the action
696 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
699 * @brief Get the cost of an action
701 * @param action The surf action
702 * @return The cost of the action
704 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
707 * @brief [brief desrciption]
708 * @details [long description]
710 * @param action The surf cpu action
711 * @param cpu [description]
712 * @param mask [description]
714 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask);
717 * @brief [brief description]
718 * @details [long description]
720 * @param action The surf cpu action
721 * @param bound [description]
723 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
726 * @brief [brief description]
727 * @details [long description]
729 * @param action The surf network action
731 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
734 * @brief Get the file associated to a storage action
736 * @param action The surf storage action
737 * @return The file associated to a storage action
739 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
742 * @brief Get the result dictionary of an ls action
744 * @param action The surf storage action
745 * @return The dictionry listing a path
747 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
751 * @brief Get the host the storage is attached to
753 * @param resource The surf storage
754 * @return The host name
756 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
758 XBT_PUBLIC(surf_model_t) surf_resource_model(const void *host, int level);
762 /**************************************/
763 /* Implementations of model object */
764 /**************************************/
766 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
767 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
769 /** \ingroup SURF_models
770 * \brief The CPU model object for the physical machine layer
772 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
774 /** \ingroup SURF_models
775 * \brief The CPU model object for the virtual machine layer
777 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
780 /** \ingroup SURF_models
781 * \brief Initializes the CPU model with the model Cas01
783 * By default, this model uses the lazy optimization mechanism that
784 * relies on partial invalidation in LMM and a heap for lazy action update.
785 * You can change this behavior by setting the cpu/optim configuration
786 * variable to a different value.
788 * You shouldn't have to call it by yourself.
790 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
792 /** \ingroup SURF_models
793 * \brief Initializes the CPU model with trace integration [Deprecated]
795 * You shouldn't have to call it by yourself.
797 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
799 /** \ingroup SURF_models
800 * \brief The list of all available optimization modes (both for cpu and networks).
801 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
803 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
805 /** \ingroup SURF_plugins
806 * \brief The list of all available surf plugins
808 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
810 /** \ingroup SURF_models
811 * \brief The list of all available cpu model models
813 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
815 /**\brief create new host bypass the parser
820 /** \ingroup SURF_models
821 * \brief The network model
823 * When creating a new API on top on SURF, you shouldn't use the
824 * network model unless you know what you are doing. Only the host
825 * model should be accessed because depending on the platform model,
826 * the network model can be NULL.
828 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
830 /** \ingroup SURF_models
831 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
833 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
834 * based on the model 'LV08' and different correction factors depending on the communication
835 * size (< 1KiB, < 64KiB, >= 64KiB).
836 * See comments in the code for more information.
838 * \see surf_host_model_init_SMPI()
840 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
842 /** \ingroup SURF_models
843 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
845 * This model impelments a variant of the contention model on Infinband networks based on
846 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
848 * \see surf_host_model_init_IB()
850 XBT_PUBLIC(void) surf_network_model_init_IB(void);
852 /** \ingroup SURF_models
853 * \brief Initializes the platform with the network model 'LegrandVelho'
855 * This model is proposed by Arnaud Legrand and Pedro Velho based on
856 * the results obtained with the GTNets simulator for onelink and
857 * dogbone sharing scenarios. See comments in the code for more information.
859 * \see surf_host_model_init_LegrandVelho()
861 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
863 /** \ingroup SURF_models
864 * \brief Initializes the platform with the network model 'Constant'
866 * In this model, the communication time between two network cards is
867 * constant, hence no need for a routing table. This is particularly
868 * usefull when simulating huge distributed algorithms where
869 * scalability is really an issue. This function is called in
870 * conjunction with surf_host_model_init_compound.
872 * \see surf_host_model_init_compound()
874 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
876 /** \ingroup SURF_models
877 * \brief Initializes the platform with the network model CM02
879 * You sould call this function by yourself only if you plan using
880 * surf_host_model_init_compound.
881 * See comments in the code for more information.
883 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
886 /** \ingroup SURF_models
887 * \brief Initializes the platform with the network model NS3
889 * This function is called by surf_host_model_init_NS3
890 * or by yourself only if you plan using surf_host_model_init_compound
892 * \see surf_host_model_init_NS3()
894 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
897 /** \ingroup SURF_models
898 * \brief Initializes the platform with the network model Reno
900 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
903 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
904 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
906 * Call this function only if you plan using surf_host_model_init_compound.
909 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
911 /** \ingroup SURF_models
912 * \brief Initializes the platform with the network model Reno2
914 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
917 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
918 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
920 * Call this function only if you plan using surf_host_model_init_compound.
923 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
925 /** \ingroup SURF_models
926 * \brief Initializes the platform with the network model Vegas
928 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
929 * to the proportional fairness.
932 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
933 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
935 * Call this function only if you plan using surf_host_model_init_compound.
938 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
940 /** \ingroup SURF_models
941 * \brief The list of all available network model models
943 XBT_PUBLIC_DATA(s_surf_model_description_t)
944 surf_network_model_description[];
946 /** \ingroup SURF_models
947 * \brief The storage model
949 XBT_PUBLIC(void) surf_storage_model_init_default(void);
951 /** \ingroup SURF_models
952 * \brief The list of all available storage modes.
953 * This storage mode can be set using --cfg=storage/model:...
955 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
957 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
959 /** \ingroup SURF_models
960 * \brief The host model
962 * Note that when you create an API on top of SURF,
963 * the host model should be the only one you use
964 * because depending on the platform model, the network model and the CPU model
967 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
969 /** \ingroup SURF_models
970 * \brief The vm model
972 * Note that when you create an API on top of SURF,
973 * the vm model should be the only one you use
974 * because depending on the platform model, the network model and the CPU model
977 XBT_PUBLIC_DATA(surf_vm_model_t) surf_vm_model;
979 /** \ingroup SURF_models
980 * \brief Initializes the platform with a compound host model
982 * This function should be called after a cpu_model and a
983 * network_model have been set up.
986 XBT_PUBLIC(void) surf_host_model_init_compound(void);
988 /** \ingroup SURF_models
989 * \brief Initializes the platform with the current best network and cpu models at hand
991 * This platform model separates the host model and the network model.
992 * The host model will be initialized with the model compound, the network
993 * model with the model LV08 (with cross traffic support) and the CPU model with
995 * Such model is subject to modification with warning in the ChangeLog so monitor it!
998 XBT_PUBLIC(void) surf_host_model_init_current_default(void);
1000 /** \ingroup SURF_models
1001 * \brief Initializes the platform with the model L07
1003 * With this model, only parallel tasks can be used. Resource sharing
1004 * is done by identifying bottlenecks and giving an equal share of
1005 * the model to each action.
1008 XBT_PUBLIC(void) surf_host_model_init_ptask_L07(void);
1010 /** \ingroup SURF_models
1011 * \brief The list of all available host model models
1013 XBT_PUBLIC_DATA(s_surf_model_description_t)
1014 surf_host_model_description[];
1016 /** \ingroup SURF_models
1017 * \brief Initializes the platform with the current best network and cpu models at hand
1019 * This platform model seperates the host model and the network model.
1020 * The host model will be initialized with the model compound, the network
1021 * model with the model LV08 (with cross traffic support) and the CPU model with
1023 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1026 XBT_PUBLIC(void) surf_vm_model_init_HL13(void);
1028 /** \ingroup SURF_models
1029 * \brief The list of all available vm model models
1031 XBT_PUBLIC_DATA(s_surf_model_description_t)
1032 surf_vm_model_description[];
1034 /*******************************************/
1036 /** \ingroup SURF_models
1037 * \brief List of initialized models
1039 XBT_PUBLIC_DATA(xbt_dynar_t) all_existing_models;
1041 /** \ingroup SURF_simulation
1042 * \brief List of hosts that have just restarted and whose autorestart process should be restarted.
1044 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
1046 /** \ingroup SURF_simulation
1047 * \brief List of hosts for which one want to be notified if they ever restart.
1049 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
1051 /*******************************************/
1052 /*** SURF Platform *************************/
1053 /*******************************************/
1054 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
1055 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
1056 XBT_PUBLIC_DATA(AS_t) surf_AS_get_by_name(const char * name);
1057 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
1058 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
1059 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
1060 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
1061 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
1062 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
1064 /*******************************************/
1065 /*** SURF Globals **************************/
1066 /*******************************************/
1068 /** \ingroup SURF_simulation
1069 * \brief Initialize SURF
1070 * \param argc argument number
1071 * \param argv arguments
1073 * This function has to be called to initialize the common
1074 * structures. Then you will have to create the environment by
1076 * e.g. surf_host_model_init_CM02()
1078 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
1080 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
1082 /** \ingroup SURF_simulation
1083 * \brief Finish simulation initialization
1085 * This function must be called before the first call to surf_solve()
1087 XBT_PUBLIC(void) surf_presolve(void);
1089 /** \ingroup SURF_simulation
1090 * \brief Performs a part of the simulation
1091 * \param max_date Maximum date to update the simulation to, or -1
1092 * \return the elapsed time, or -1.0 if no event could be executed
1094 * This function execute all possible events, update the action states
1095 * and returns the time elapsed.
1096 * When you call execute or communicate on a model, the corresponding actions
1097 * are not executed immediately but only when you call surf_solve.
1098 * Note that the returned elapsed time can be zero.
1100 XBT_PUBLIC(double) surf_solve(double max_date);
1102 /** \ingroup SURF_simulation
1103 * \brief Return the current time
1105 * Return the current time in millisecond.
1107 XBT_PUBLIC(double) surf_get_clock(void);
1109 /** \ingroup SURF_simulation
1116 XBT_PUBLIC(void) surf_exit(void);
1118 /* Prototypes of the functions that handle the properties */
1119 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
1121 /* The same for model_prop set*/
1122 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
1124 /* surf parse file related (public because called from a test suite) */
1125 XBT_PUBLIC(void) parse_platform_file(const char *file);
1127 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
1128 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
1129 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
1130 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
1131 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
1132 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
1133 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
1136 XBT_PUBLIC(double) get_cpu_power(const char *power);
1138 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
1140 int surf_get_nthreads(void);
1141 void surf_set_nthreads(int nthreads);
1144 * Returns the initial path. On Windows the initial path is
1145 * the current directory for the current process in the other
1146 * case the function returns "./" that represents the current
1147 * directory on Unix/Linux platforms.
1149 const char *__surf_get_initial_path(void);
1151 /********** Tracing **********/
1152 /* from surf_instr.c */
1153 void TRACE_surf_action(surf_action_t surf_action, const char *category);
1154 void TRACE_surf_alloc(void);
1155 void TRACE_surf_release(void);
1157 /* instr_routing.c */
1158 void instr_routing_define_callbacks (void);
1159 void instr_new_variable_type (const char *new_typename, const char *color);
1160 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
1161 void instr_new_user_state_type (const char *father_type, const char *new_typename);
1162 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
1163 int instr_platform_traced (void);
1164 xbt_graph_t instr_routing_platform_graph (void);
1165 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1168 #endif /* _SURF_SURF_H */