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/surf_routing.h"
18 #include "surf/datatypes.h"
20 #include "surf/surf_routing.h"
21 #include "simgrid/platf_interface.h"
22 #include "simgrid/datatypes.h"
23 #include "simgrid/plugins.h"
24 #include "simgrid/forward.h"
27 /* Actions and models are highly connected structures... */
29 /* user-visible parameters */
30 extern XBT_PRIVATE double sg_tcp_gamma;
31 extern XBT_PRIVATE double sg_sender_gap;
32 extern XBT_PRIVATE double sg_latency_factor;
33 extern XBT_PRIVATE double sg_bandwidth_factor;
34 extern XBT_PRIVATE double sg_weight_S_parameter;
35 extern XBT_PRIVATE int sg_network_crosstraffic;
36 extern XBT_PRIVATE xbt_dynar_t surf_path;
39 SURF_NETWORK_ELEMENT_NULL = 0, /* NULL */
40 SURF_NETWORK_ELEMENT_HOST, /* host type */
41 SURF_NETWORK_ELEMENT_ROUTER, /* router type */
42 SURF_NETWORK_ELEMENT_AS /* AS type */
43 } e_surf_network_element_type_t;
60 class NetworkCm02Link;
63 class StorageActionLmm;
70 typedef simgrid::surf::Model surf_Model;
71 typedef simgrid::surf::CpuModel surf_CpuModel;
72 typedef simgrid::surf::HostModel surf_HostModel;
73 typedef simgrid::surf::VMModel surf_VMModel;
74 typedef simgrid::surf::NetworkModel surf_NetworkModel;
75 typedef simgrid::surf::StorageModel surf_StorageModel;
76 typedef simgrid::surf::Resource surf_Resource;
77 typedef simgrid::surf::ResourceLmm surf_ResourceLmm;
78 typedef simgrid::surf::Host surf_Host;
79 typedef simgrid::surf::HostCLM03 surf_HostCLM03;
80 typedef simgrid::surf::NetworkCm02Link surf_NetworkCm02Link;
81 typedef simgrid::surf::Action surf_Action;
82 typedef simgrid::surf::ActionLmm surf_ActionLmm;
83 typedef simgrid::surf::StorageActionLmm surf_StorageActionLmm;
84 typedef simgrid::surf::RoutingPlatf surf_RoutingPlatf;
88 typedef struct surf_Model surf_Model;
89 typedef struct surf_CpuModel surf_CpuModel;
90 typedef struct surf_HostModel surf_HostModel;
91 typedef struct surf_VMModel surf_VMModel;
92 typedef struct surf_NetworkModel surf_NetworkModel;
93 typedef struct surf_StorageModel surf_StorageModel;
94 typedef struct surf_Resource surf_Resource;
95 typedef struct surf_ResourceLmm surf_ResourceLmm;
96 typedef struct surf_HostCLM03 surf_HostCLM03;
97 typedef struct surf_Host surf_Host;
98 typedef struct surf_NetworkCm02Link surf_NetworkCm02Link;
99 typedef struct surf_Action surf_Action;
100 typedef struct surf_ActionLmm surf_ActionLmm;
101 typedef struct surf_StorageActionLmm surf_StorageActionLmm;
102 typedef struct surf_RoutingPlatf surf_RoutingPlatf;
106 /** @ingroup SURF_c_bindings
107 * \brief Model datatype
109 * Generic data structure for a model. The hosts,
110 * the CPUs and the network links are examples of models.
112 typedef surf_Model *surf_model_t;
113 typedef surf_CpuModel *surf_cpu_model_t;
114 typedef surf_HostModel *surf_host_model_t;
115 typedef surf_VMModel *surf_vm_model_t;
116 typedef surf_NetworkModel *surf_network_model_t;
117 typedef surf_StorageModel *surf_storage_model_t;
119 typedef xbt_dictelm_t surf_resource_t;
120 typedef surf_Resource *surf_cpp_resource_t;
121 typedef surf_Host *surf_host_t;
122 typedef surf_Cpu *surf_cpu_t;
124 /** @ingroup SURF_c_bindings
125 * \brief Action structure
127 * Never create s_surf_action_t by yourself ! The actions are created
128 * on the fly when you call execute or communicate on a model.
130 * \see e_surf_action_state_t
132 typedef surf_Action *surf_action_t;
133 typedef surf_RoutingPlatf *routing_platf_t;
135 typedef struct surf_file *surf_file_t;
137 XBT_PUBLIC(e_surf_network_element_type_t)
138 routing_get_network_element_type(const char* name);
140 /** @Brief Specify that we use that action */
141 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
143 /** @brief Creates a new action.
145 * @param size The size is the one of the subtype you want to create
146 * @param cost initial value
147 * @param model to which model we should attach this action
148 * @param failed whether we should start this action in failed mode
150 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
151 surf_model_t model, int failed);
153 /** \brief Resource model description
155 typedef struct surf_model_description {
157 const char *description;
158 void_f_void_t model_init_preparse;
159 } s_surf_model_description_t, *surf_model_description_t;
161 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
163 XBT_PUBLIC(void) model_help(const char *category,
164 s_surf_model_description_t * table);
166 /** @ingroup SURF_interface
167 * @brief Action states
172 SURF_ACTION_READY = 0, /**< Ready */
173 SURF_ACTION_RUNNING, /**< Running */
174 SURF_ACTION_FAILED, /**< Task Failure */
175 SURF_ACTION_DONE, /**< Completed */
176 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
177 SURF_ACTION_NOT_IN_THE_SYSTEM /**< Not in the system anymore. Why did you ask ? */
178 } e_surf_action_state_t;
180 /** @ingroup SURF_vm_interface
184 /* FIXME: Where should the VM state be defined? */
186 SURF_VM_STATE_CREATED, /**< created, but not yet started */
187 SURF_VM_STATE_RUNNING,
188 SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
190 SURF_VM_STATE_SAVING, /**< Save/restore involves disk I/O, so there should be transition states. */
192 SURF_VM_STATE_RESTORING,
195 /***************************/
196 /* Generic model object */
197 /***************************/
199 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
201 static inline surf_host_t surf_host_resource_priv(sg_host_t host)
203 return (surf_host_t) sg_host_get_facet(host, SURF_HOST_LEVEL);
205 static inline void *surf_storage_resource_priv(const void *storage){
206 return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
209 static inline void *surf_storage_resource_by_name(const char *name){
210 return xbt_lib_get_elm_or_null(storage_lib, name);
213 /** @{ @ingroup SURF_c_bindings */
216 * @brief Pop an action from the done actions set
218 * @param model The model from which the action is extracted
219 * @return An action in done state
221 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
224 * @brief Pop an action from the failed actions set
226 * @param model The model from which the action is extracted
227 * @return An action in failed state
229 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
232 * @brief Pop an action from the ready actions set
234 * @param model The model from which the action is extracted
235 * @return An action in ready state
237 XBT_PUBLIC(surf_action_t) surf_model_extract_ready_action_set(surf_model_t model);
240 * @brief Pop an action from the running actions set
242 * @param model The model from which the action is extracted
243 * @return An action in running state
245 XBT_PUBLIC(surf_action_t) surf_model_extract_running_action_set(surf_model_t model);
248 * @brief Get the size of the running action set of a model
250 * @param model The model
251 * @return The size of the running action set
253 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
256 * @brief Execute a parallel task
257 * @details [long description]
259 * @param model The model which handle the parallelisation
260 * @param host_nb The number of hosts
261 * @param host_list The list of hosts on which the task is executed
262 * @param flops_amount The processing amount (in flop) needed to process
263 * @param bytes_amount The amount of data (in bytes) needed to transfer
264 * @param rate [description]
265 * @return The action corresponding to the parallele execution task
267 XBT_PUBLIC(surf_action_t) surf_host_model_execute_parallel_task(surf_host_model_t model,
269 sg_host_t *host_list,
270 double *flops_amount,
271 double *bytes_amount,
274 /** @brief Get the route (dynar of sg_link_t) between two hosts */
275 XBT_PUBLIC(xbt_dynar_t) surf_host_model_get_route(
276 surf_host_model_t model, sg_host_t src, sg_host_t dst);
278 /** @brief Create a new VM on the specified host */
279 XBT_PUBLIC(void) surf_vm_model_create(const char *name, sg_host_t host_PM);
281 /** @brief Create a communication between two hosts
283 * @param model The model which handle the communication
284 * @param src The source host
285 * @param dst The destination host
286 * @param size The amount of data (in bytes) needed to transfer
287 * @param rate [description]
288 * @return The action corresponding to the communication
290 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);
293 * @brief Get the name of a surf resource (cpu, host, network, …)
295 * @param resource The surf resource
296 * @return The name of the surf resource
298 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
299 static inline const char * surf_cpu_name(surf_cpu_t cpu) {
300 return surf_resource_name((surf_cpp_resource_t)cpu);
303 /** @brief Get the properties of an host */
304 XBT_PUBLIC(xbt_dict_t) sg_host_get_properties(sg_host_t host);
307 /** @brief Get the state of a surf resource (cpu, host, network, …) */
308 XBT_PUBLIC(e_surf_resource_state_t) surf_resource_get_state(surf_cpp_resource_t resource);
310 static XBT_INLINE e_surf_resource_state_t surf_host_get_state(surf_host_t host) {
311 return surf_resource_get_state((surf_cpp_resource_t)host);
315 /** @brief Set the state of a surf resource (cpu, host, network, …) */
316 XBT_PUBLIC(void) surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state);
317 static inline void surf_host_set_state(surf_host_t host, e_surf_resource_state_t state) {
318 surf_resource_set_state((surf_cpp_resource_t)host, state);
321 /** @brief Get the speed of the cpu associated to a host */
322 XBT_PUBLIC(double) surf_host_get_speed(sg_host_t resource, double load);
324 /** @brief Get the available speed of cpu associated to a host */
325 XBT_PUBLIC(double) surf_host_get_available_speed(sg_host_t host);
327 /** @brief Get the number of cores of the cpu associated to a host */
328 XBT_PUBLIC(int) surf_host_get_core(sg_host_t host);
330 /** @brief Create a computation action on the given host */
331 XBT_PUBLIC(surf_action_t) surf_host_execute(sg_host_t host, double size);
333 /** @brief Create a sleep action on the given host */
334 XBT_PUBLIC(surf_action_t) surf_host_sleep(sg_host_t host, double duration);
336 /** @brief Create a file opening action on the given host */
337 XBT_PUBLIC(surf_action_t) surf_host_open(sg_host_t host, const char* fullpath);
339 /** @brief Create a file closing action on the given host */
340 XBT_PUBLIC(surf_action_t) surf_host_close(sg_host_t host, surf_file_t fd);
342 /** @brief Create a file reading action on the given host */
343 XBT_PUBLIC(surf_action_t) surf_host_read(sg_host_t host, surf_file_t fd, sg_size_t size);
345 /** @brief Create a file writing action on the given host */
346 XBT_PUBLIC(surf_action_t) surf_host_write(sg_host_t host, surf_file_t fd, sg_size_t size);
349 * @brief Get the informations of a file descriptor
350 * @details The returned xbt_dynar_t contains:
351 * - the size of the file,
353 * - the storage name,
354 * - the storage typeId,
355 * - the storage content type
357 * @param host The surf host
358 * @param fd The file descriptor
359 * @return An xbt_dynar_t with the file informations
361 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(sg_host_t host, surf_file_t fd);
364 * @brief Get the available space of the storage at the mount point
366 * @param resource The surf host
367 * @param name The mount point
368 * @return The amount of available space in bytes
370 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(sg_host_t resource, const char* name);
373 * @brief Get the used space of the storage at the mount point
375 * @param resource The surf host
376 * @param name The mount point
377 * @return The amount of used space in bytes
379 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(sg_host_t resource, const char* name);
381 /** @brief Get the list of VMs hosted on the host */
382 XBT_PUBLIC(xbt_dynar_t) surf_host_get_vms(sg_host_t resource);
384 /** @brief Retrieve the params of that VM
385 * @details You can use fields ramsize and overcommit on a PM, too.
387 XBT_PUBLIC(void) surf_host_get_params(sg_host_t resource, vm_params_t params);
389 /** @brief Sets the params of that VM/PM
390 * @details You can use fields ramsize and overcommit on a PM, too.
392 XBT_PUBLIC(void) surf_host_set_params(sg_host_t resource, vm_params_t params);
395 * @brief Destroy a VM
397 * @param resource The surf vm
399 XBT_PUBLIC(void) surf_vm_destroy(sg_host_t resource);
401 /** @brief Suspend a VM */
402 XBT_PUBLIC(void) surf_vm_suspend(sg_host_t resource);
404 /** @brief Resume a VM */
405 XBT_PUBLIC(void) surf_vm_resume(sg_host_t resource);
408 * @brief Save the VM (Not yet implemented)
410 * @param resource The surf vm
412 XBT_PUBLIC(void) surf_vm_save(sg_host_t resource);
415 * @brief Restore the VM (Not yet implemented)
417 * @param resource The surf vm
419 XBT_PUBLIC(void) surf_vm_restore(sg_host_t resource);
422 * @brief Migrate the VM to the destination host
424 * @param resource The surf vm
425 * @param ind_vm_ws_dest The destination host
427 XBT_PUBLIC(void) surf_vm_migrate(sg_host_t resource, sg_host_t ind_vm_ws_dest);
430 * @brief Get the physical machine hosting the VM
432 * @param resource The surf vm
433 * @return The physical machine hosting the VM
435 XBT_PUBLIC(sg_host_t) surf_vm_get_pm(sg_host_t resource);
438 * @brief [brief description]
439 * @details [long description]
441 * @param resource [description]
442 * @param bound [description]
444 XBT_PUBLIC(void) surf_vm_set_bound(sg_host_t resource, double bound);
447 * @brief [brief description]
448 * @details [long description]
450 * @param resource [description]
451 * @param cpu [description]
452 * @param mask [description]
454 XBT_PUBLIC(void) surf_vm_set_affinity(sg_host_t resource, sg_host_t cpu, unsigned long mask);
457 * @brief Execute some quantity of computation
459 * @param cpu The surf cpu
460 * @param size The value of the processing amount (in flop) needed to process
461 * @return The surf action corresponding to the processing
463 XBT_PUBLIC(surf_action_t) surf_cpu_execute(sg_host_t cpu, double size);
466 * @brief Make the cpu sleep for duration (in seconds)
467 * @details [long description]
469 * @param cpu The surf cpu
470 * @param duration The number of seconds to sleep
471 * @return The surf action corresponding to the sleeping
473 XBT_PUBLIC(surf_action_t) surf_cpu_sleep(sg_host_t cpu, double duration);
476 * @brief Get the host power peak
477 * @details [long description]
479 * @param host The surf host
480 * @return The power peak
482 XBT_PUBLIC(double) surf_host_get_current_power_peak(sg_host_t host);
485 * @brief [brief description]
486 * @details [long description]
488 * @param host [description]
489 * @param pstate_index [description]
491 * @return [description]
493 XBT_PUBLIC(double) surf_host_get_power_peak_at(sg_host_t host, int pstate_index);
496 * @brief [brief description]
497 * @details [long description]
499 * @param host [description]
500 * @return [description]
502 XBT_PUBLIC(int) surf_host_get_nb_pstates(sg_host_t host);
504 XBT_PUBLIC(void) surf_host_set_pstate(sg_host_t host, int pstate_index);
505 XBT_PUBLIC(int) surf_host_get_pstate(sg_host_t host);
506 XBT_PUBLIC(double) surf_host_get_wattmin_at(sg_host_t resource, int pstate);
507 XBT_PUBLIC(double) surf_host_get_wattmax_at(sg_host_t resource, int pstate);
510 * @brief Get the consumed energy (in joules) of an host
512 * @param host The surf host
513 * @return The consumed energy
515 XBT_PUBLIC(double) surf_host_get_consumed_energy(sg_host_t host);
518 * @brief Get the list of storages mounted on an host
520 * @param host The surf host
521 * @return Dictionary of mount point, Storage
523 XBT_PUBLIC(xbt_dict_t) surf_host_get_mounted_storage_list(sg_host_t host);
526 * @brief Get the list of storages attached to an host
528 * @param host The surf host
529 * @return Dictionary of storage
531 XBT_PUBLIC(xbt_dynar_t) surf_host_get_attached_storage_list(sg_host_t host);
534 * @brief Unlink a file descriptor
536 * @param host The surf host
537 * @param fd The file descriptor
539 * @return 0 if failed to unlink, 1 otherwise
541 XBT_PUBLIC(int) surf_host_unlink(sg_host_t host, surf_file_t fd);
544 * @brief Get the size of a file on a host
546 * @param host The surf host
547 * @param fd The file descriptor
549 * @return The size in bytes of the file
551 XBT_PUBLIC(size_t) surf_host_get_size(sg_host_t host, surf_file_t fd);
554 * @brief Get the current position of the file descriptor
556 * @param host The surf host
557 * @param fd The file descriptor
558 * @return The current position of the file descriptor
560 XBT_PUBLIC(size_t) surf_host_file_tell(sg_host_t host, surf_file_t fd);
563 * @brief Move a file to another location on the *same mount point*.
564 * @details [long description]
566 * @param host The surf host
567 * @param fd The file descriptor
568 * @param fullpath The new full path
570 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
572 XBT_PUBLIC(int) surf_host_file_move(sg_host_t host, surf_file_t fd, const char* fullpath);
575 * @brief Set the position indictator assiociated with the file descriptor to a new position
576 * @details [long description]
578 * @param host The surf host
579 * @param fd The file descriptor
580 * @param offset The offset from the origin
581 * @param origin Position used as a reference for the offset
582 * - SEEK_SET: beginning of the file
583 * - SEEK_CUR: current position indicator
584 * - SEEK_END: end of the file
585 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
587 XBT_PUBLIC(int) surf_host_file_seek(sg_host_t host,
588 surf_file_t fd, sg_offset_t offset,
592 * @brief Get the content of a storage
594 * @param resource The surf storage
595 * @return A xbt_dict_t with path as keys and size in bytes as values
597 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
600 * @brief Get the size in bytes of a storage
602 * @param resource The surf storage
603 * @return The size in bytes of the storage
605 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
608 * @brief Get the available size in bytes of a storage
610 * @param resource The surf storage
611 * @return The available size in bytes of the storage
613 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
616 * @brief Get the size in bytes of a storage
618 * @param resource The surf storage
619 * @return The used size in bytes of the storage
621 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
623 /** @brief return the properties set associated to that storage */
624 XBT_PUBLIC(xbt_dict_t) surf_storage_get_properties(surf_resource_t resource);
627 * @brief Get the data associated to the action
629 * @param action The surf action
630 * @return The data associated to the action
632 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
635 * @brief Set the data associated to the action
636 * @details [long description]
638 * @param action The surf action
639 * @param data The new data associated to the action
641 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
644 * @brief Unreference an action
646 * @param action The surf action
648 XBT_PUBLIC(void) surf_action_unref(surf_action_t action);
651 * @brief Get the start time of an action
653 * @param action The surf action
654 * @return The start time in seconds from the beginning of the simulation
656 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
659 * @brief Get the finish time of an action
661 * @param action The surf action
662 * @return The finish time in seconds from the beginning of the simulation
664 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
667 * @brief Get the remains amount of work to do of an action
669 * @param action The surf action
670 * @return The remains amount of work to do
672 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
675 * @brief Suspend an action
677 * @param action The surf action
679 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
682 * @brief Resume an action
684 * @param action The surf action
686 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
689 * @brief Cancel an action
691 * @param action The surf action
693 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
696 * @brief Set the priority of an action
697 * @details [long description]
699 * @param action The surf action
700 * @param priority The new priority [TODO]
702 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
705 * @brief Set the category of an action
706 * @details [long description]
708 * @param action The surf action
709 * @param category The new category of the action
711 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
714 * @brief Get the state of an action
716 * @param action The surf action
717 * @return The state of the action
719 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
722 * @brief Get the cost of an action
724 * @param action The surf action
725 * @return The cost of the action
727 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
730 * @brief [brief desrciption]
731 * @details [long description]
733 * @param action The surf cpu action
734 * @param cpu [description]
735 * @param mask [description]
737 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, sg_host_t cpu, unsigned long mask);
740 * @brief [brief description]
741 * @details [long description]
743 * @param action The surf cpu action
744 * @param bound [description]
746 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
749 * @brief [brief description]
750 * @details [long description]
752 * @param action The surf network action
754 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
757 * @brief Get the file associated to a storage action
759 * @param action The surf storage action
760 * @return The file associated to a storage action
762 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
765 * @brief Get the result dictionary of an ls action
767 * @param action The surf storage action
768 * @return The dictionry listing a path
770 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
774 * @brief Get the host the storage is attached to
776 * @param resource The surf storage
777 * @return The host name
780 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
782 XBT_PUBLIC(surf_host_model_t) surf_host_get_model(sg_host_t host);
786 /**************************************/
787 /* Implementations of model object */
788 /**************************************/
790 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
791 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
793 /** \ingroup SURF_models
794 * \brief The CPU model object for the physical machine layer
796 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
798 /** \ingroup SURF_models
799 * \brief The CPU model object for the virtual machine layer
801 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
804 /** \ingroup SURF_models
805 * \brief Initializes the CPU model with the model Cas01
807 * By default, this model uses the lazy optimization mechanism that
808 * relies on partial invalidation in LMM and a heap for lazy action update.
809 * You can change this behavior by setting the cpu/optim configuration
810 * variable to a different value.
812 * You shouldn't have to call it by yourself.
814 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
816 /** \ingroup SURF_models
817 * \brief Initializes the CPU model with trace integration [Deprecated]
819 * You shouldn't have to call it by yourself.
821 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
823 /** \ingroup SURF_models
824 * \brief The list of all available optimization modes (both for cpu and networks).
825 * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
827 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
829 /** \ingroup SURF_plugins
830 * \brief The list of all available surf plugins
832 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
834 /** \ingroup SURF_models
835 * \brief The list of all available cpu model models
837 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
839 /**\brief create new host bypass the parser
844 /** \ingroup SURF_models
845 * \brief The network model
847 * When creating a new API on top on SURF, you shouldn't use the
848 * network model unless you know what you are doing. Only the host
849 * model should be accessed because depending on the platform model,
850 * the network model can be NULL.
852 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
854 /** \ingroup SURF_models
855 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
857 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
858 * based on the model 'LV08' and different correction factors depending on the communication
859 * size (< 1KiB, < 64KiB, >= 64KiB).
860 * See comments in the code for more information.
862 * \see surf_host_model_init_SMPI()
864 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
866 /** \ingroup SURF_models
867 * \brief Same as network model 'LagrangeVelho', only with different correction factors.
869 * This model impelments a variant of the contention model on Infinband networks based on
870 * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
872 * \see surf_host_model_init_IB()
874 XBT_PUBLIC(void) surf_network_model_init_IB(void);
876 /** \ingroup SURF_models
877 * \brief Initializes the platform with the network model 'LegrandVelho'
879 * This model is proposed by Arnaud Legrand and Pedro Velho based on
880 * the results obtained with the GTNets simulator for onelink and
881 * dogbone sharing scenarios. See comments in the code for more information.
883 * \see surf_host_model_init_LegrandVelho()
885 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
887 /** \ingroup SURF_models
888 * \brief Initializes the platform with the network model 'Constant'
890 * In this model, the communication time between two network cards is
891 * constant, hence no need for a routing table. This is particularly
892 * usefull when simulating huge distributed algorithms where
893 * scalability is really an issue. This function is called in
894 * conjunction with surf_host_model_init_compound.
896 * \see surf_host_model_init_compound()
898 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
900 /** \ingroup SURF_models
901 * \brief Initializes the platform with the network model CM02
903 * You sould call this function by yourself only if you plan using
904 * surf_host_model_init_compound.
905 * See comments in the code for more information.
907 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
910 /** \ingroup SURF_models
911 * \brief Initializes the platform with the network model NS3
913 * This function is called by surf_host_model_init_NS3
914 * or by yourself only if you plan using surf_host_model_init_compound
916 * \see surf_host_model_init_NS3()
918 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
921 /** \ingroup SURF_models
922 * \brief Initializes the platform with the network model Reno
924 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
927 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
928 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
930 * Call this function only if you plan using surf_host_model_init_compound.
933 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
935 /** \ingroup SURF_models
936 * \brief Initializes the platform with the network model Reno2
938 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
941 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
942 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
944 * Call this function only if you plan using surf_host_model_init_compound.
947 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
949 /** \ingroup SURF_models
950 * \brief Initializes the platform with the network model Vegas
952 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
953 * to the proportional fairness.
956 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
957 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
959 * Call this function only if you plan using surf_host_model_init_compound.
962 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
964 /** \ingroup SURF_models
965 * \brief The list of all available network model models
967 XBT_PUBLIC_DATA(s_surf_model_description_t)
968 surf_network_model_description[];
970 /** \ingroup SURF_models
971 * \brief The storage model
973 XBT_PUBLIC(void) surf_storage_model_init_default(void);
975 /** \ingroup SURF_models
976 * \brief The list of all available storage modes.
977 * This storage mode can be set using --cfg=storage/model:...
979 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
981 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
983 /** \ingroup SURF_models
984 * \brief The host model
986 * Note that when you create an API on top of SURF,
987 * the host model should be the only one you use
988 * because depending on the platform model, the network model and the CPU model
991 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
993 /** \ingroup SURF_models
994 * \brief The vm model
996 * Note that when you create an API on top of SURF,
997 * the vm model should be the only one you use
998 * because depending on the platform model, the network model and the CPU model
1001 XBT_PUBLIC_DATA(surf_vm_model_t) surf_vm_model;
1003 /** \ingroup SURF_models
1004 * \brief Initializes the platform with a compound host model
1006 * This function should be called after a cpu_model and a
1007 * network_model have been set up.
1010 XBT_PUBLIC(void) surf_host_model_init_compound(void);
1012 /** \ingroup SURF_models
1013 * \brief Initializes the platform with the current best network and cpu models at hand
1015 * This platform model separates the host model and the network model.
1016 * The host model will be initialized with the model compound, the network
1017 * model with the model LV08 (with cross traffic support) and the CPU model with
1019 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1022 XBT_PUBLIC(void) surf_host_model_init_current_default(void);
1024 /** \ingroup SURF_models
1025 * \brief Initializes the platform with the model L07
1027 * With this model, only parallel tasks can be used. Resource sharing
1028 * is done by identifying bottlenecks and giving an equal share of
1029 * the model to each action.
1032 XBT_PUBLIC(void) surf_host_model_init_ptask_L07(void);
1034 /** \ingroup SURF_models
1035 * \brief The list of all available host model models
1037 XBT_PUBLIC_DATA(s_surf_model_description_t)
1038 surf_host_model_description[];
1040 /** \ingroup SURF_models
1041 * \brief Initializes the platform with the current best network and cpu models at hand
1043 * This platform model seperates the host model and the network model.
1044 * The host model will be initialized with the model compound, the network
1045 * model with the model LV08 (with cross traffic support) and the CPU model with
1047 * Such model is subject to modification with warning in the ChangeLog so monitor it!
1050 XBT_PUBLIC(void) surf_vm_model_init_HL13(void);
1052 /** \ingroup SURF_models
1053 * \brief The list of all available vm model models
1055 XBT_PUBLIC_DATA(s_surf_model_description_t)
1056 surf_vm_model_description[];
1058 /*******************************************/
1060 /** \ingroup SURF_models
1061 * \brief List of initialized models
1063 XBT_PUBLIC_DATA(xbt_dynar_t) all_existing_models;
1065 /** \ingroup SURF_simulation
1066 * \brief List of hosts that have just restarted and whose autorestart process should be restarted.
1068 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
1070 /** \ingroup SURF_simulation
1071 * \brief List of hosts for which one want to be notified if they ever restart.
1073 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
1075 /*******************************************/
1076 /*** SURF Platform *************************/
1077 /*******************************************/
1078 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
1079 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
1080 XBT_PUBLIC_DATA(AS_t) surf_AS_get_by_name(const char * name);
1081 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
1082 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
1083 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
1084 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
1085 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
1086 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
1088 /*******************************************/
1089 /*** SURF Globals **************************/
1090 /*******************************************/
1092 /** \ingroup SURF_simulation
1093 * \brief Initialize SURF
1094 * \param argc argument number
1095 * \param argv arguments
1097 * This function has to be called to initialize the common
1098 * structures. Then you will have to create the environment by
1100 * e.g. surf_host_model_init_CM02()
1102 * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
1104 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
1106 /** \ingroup SURF_simulation
1107 * \brief Finish simulation initialization
1109 * This function must be called before the first call to surf_solve()
1111 XBT_PUBLIC(void) surf_presolve(void);
1113 /** \ingroup SURF_simulation
1114 * \brief Performs a part of the simulation
1115 * \param max_date Maximum date to update the simulation to, or -1
1116 * \return the elapsed time, or -1.0 if no event could be executed
1118 * This function execute all possible events, update the action states
1119 * and returns the time elapsed.
1120 * When you call execute or communicate on a model, the corresponding actions
1121 * are not executed immediately but only when you call surf_solve.
1122 * Note that the returned elapsed time can be zero.
1124 XBT_PUBLIC(double) surf_solve(double max_date);
1126 /** \ingroup SURF_simulation
1127 * \brief Return the current time
1129 * Return the current time in millisecond.
1131 XBT_PUBLIC(double) surf_get_clock(void);
1133 /** \ingroup SURF_simulation
1140 XBT_PUBLIC(void) surf_exit(void);
1142 /* Prototypes of the functions that handle the properties */
1143 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
1145 /* The same for model_prop set*/
1146 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
1148 /* surf parse file related (public because called from a test suite) */
1149 XBT_PUBLIC(void) parse_platform_file(const char *file);
1151 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
1152 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
1153 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
1154 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
1155 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
1156 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
1157 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
1160 XBT_PUBLIC(double) get_cpu_speed(const char *power);
1162 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
1164 int surf_get_nthreads(void);
1165 void surf_set_nthreads(int nthreads);
1168 * Returns the initial path. On Windows the initial path is
1169 * the current directory for the current process in the other
1170 * case the function returns "./" that represents the current
1171 * directory on Unix/Linux platforms.
1173 const char *__surf_get_initial_path(void);
1175 /********** Tracing **********/
1176 /* from surf_instr.c */
1177 void TRACE_surf_action(surf_action_t surf_action, const char *category);
1178 void TRACE_surf_alloc(void);
1179 void TRACE_surf_release(void);
1181 /* instr_routing.c */
1182 void instr_routing_define_callbacks (void);
1183 void instr_new_variable_type (const char *new_typename, const char *color);
1184 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
1185 void instr_new_user_state_type (const char *father_type, const char *new_typename);
1186 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
1187 int instr_platform_traced (void);
1188 xbt_graph_t instr_routing_platform_graph (void);
1189 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1191 /********** Routing **********/
1192 void routing_AS_begin(sg_platf_AS_cbarg_t AS);
1193 void routing_AS_end(void);
1194 surf_RoutingEdge* routing_add_host(surf_As* as, sg_platf_host_cbarg_t host);
1195 void routing_cluster_add_backbone(void* bb);
1196 surf_As* routing_get_current();
1199 #endif /* _SURF_SURF_H */