Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
5e01fde7347fb99b071c48375827b4f6fec0cc4a
[simgrid.git] / src / include / surf / surf.h
1 /* Copyright (c) 2004-2015. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #ifndef _SURF_SURF_H
8 #define _SURF_SURF_H
9
10 #include "xbt/swag.h"
11 #include "xbt/dynar.h"
12 #include "xbt/dict.h"
13 #include "xbt/graph.h"
14 #include "xbt/misc.h"
15 #include "xbt/config.h"
16 #include "src/portable.h"
17 #include "surf/surf_routing.h"
18 #include "surf/datatypes.h"
19 #include "xbt/lib.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"
25
26 SG_BEGIN_DECL()
27 /* Actions and models are highly connected structures... */
28
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;
37
38 typedef enum {
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;
44
45 #ifdef __cplusplus
46
47 namespace simgrid {
48 namespace surf {
49
50 class Model;
51 class CpuModel;
52 class HostModel;
53 class VMModel;
54 class NetworkModel;
55 class StorageModel;
56 class Resource;
57 class ResourceLmm;
58 class Host;
59 class HostCLM03;
60 class NetworkCm02Link;
61 class Action;
62 class ActionLmm;
63 class StorageActionLmm;
64 class As;
65 class RoutingPlatf;
66
67 }
68 }
69
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;
85
86 #else
87
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;
103
104 #endif
105
106 /** @ingroup SURF_c_bindings
107  *  \brief Model datatype
108  *
109  *  Generic data structure for a model. The hosts,
110  *  the CPUs and the network links are examples of models.
111  */
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;
118
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;
123
124 /** @ingroup SURF_c_bindings
125  *  \brief Action structure
126  *
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.
129  *
130  *  \see e_surf_action_state_t
131  */
132 typedef surf_Action *surf_action_t;
133 typedef surf_RoutingPlatf *routing_platf_t;
134
135 typedef struct surf_file *surf_file_t;
136
137 XBT_PUBLIC(e_surf_network_element_type_t)
138   routing_get_network_element_type(const char* name);
139
140 /** @Brief Specify that we use that action */
141 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
142
143 /** @brief Creates a new action.
144  *
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
149  */
150 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
151                                    surf_model_t model, int failed);
152
153 /** \brief Resource model description
154  */
155 typedef struct surf_model_description {
156   const char *name;
157   const char *description;
158   void_f_void_t model_init_preparse;
159 } s_surf_model_description_t, *surf_model_description_t;
160
161 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
162                                        const char *name);
163 XBT_PUBLIC(void) model_help(const char *category,
164                             s_surf_model_description_t * table);
165
166 /** @ingroup SURF_interface
167  *  @brief Action states
168  *
169  *  @see Action
170  */
171 typedef enum {
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;
179
180 /** @ingroup SURF_vm_interface
181  *
182  *
183  */
184 /* FIXME: Where should the VM state be defined? */
185 typedef enum {
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. */
189
190   SURF_VM_STATE_SAVING, /**< Save/restore involves disk I/O, so there should be transition states. */
191   SURF_VM_STATE_SAVED,
192   SURF_VM_STATE_RESTORING,
193 } e_surf_vm_state_t;
194
195 /***************************/
196 /* Generic model object */
197 /***************************/
198
199 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
200
201 static inline surf_host_t surf_host_resource_priv(sg_host_t host)
202 {
203   return (surf_host_t) sg_host_get_facet(host, SURF_HOST_LEVEL);
204 }
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);
207 }
208
209 static inline void *surf_storage_resource_by_name(const char *name){
210   return xbt_lib_get_elm_or_null(storage_lib, name);
211 }
212
213 /** @{ @ingroup SURF_c_bindings */
214
215 /**
216  * @brief Pop an action from the done actions set
217  *
218  * @param model The model from which the action is extracted
219  * @return An action in done state
220  */
221 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
222
223 /**
224  * @brief Pop an action from the failed actions set
225  *
226  * @param model The model from which the action is extracted
227  * @return An action in failed state
228  */
229 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
230
231 /**
232  * @brief Pop an action from the ready actions set
233  *
234  * @param model The model from which the action is extracted
235  * @return An action in ready state
236  */
237 XBT_PUBLIC(surf_action_t) surf_model_extract_ready_action_set(surf_model_t model);
238
239 /**
240  * @brief Pop an action from the running actions set
241  *
242  * @param model The model from which the action is extracted
243  * @return An action in running state
244  */
245 XBT_PUBLIC(surf_action_t) surf_model_extract_running_action_set(surf_model_t model);
246
247 /**
248  * @brief Get the size of the running action set of a model
249  *
250  * @param model The model
251  * @return The size of the running action set
252  */
253 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
254
255 /**
256  * @brief Execute a parallel task
257  * @details [long description]
258  *
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
266  */
267 XBT_PUBLIC(surf_action_t) surf_host_model_execute_parallel_task(surf_host_model_t model,
268                                                     int host_nb,
269                                         sg_host_t *host_list,
270                                             double *flops_amount,
271                                             double *bytes_amount,
272                                             double rate);
273
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);
277
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);
280
281 /** @brief Create a communication between two hosts
282  *
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
289  */
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);
291
292 /**
293  * @brief Get the name of a surf resource (cpu, host, network, …)
294  *
295  * @param resource The surf resource
296  * @return The name of the surf resource
297  */
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);
301 }
302
303 /** @brief Get the properties of an host */
304 XBT_PUBLIC(xbt_dict_t) sg_host_get_properties(sg_host_t host);
305
306
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);
309
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);
312 }
313
314
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);
319 }
320
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);
323
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);
326
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);
329
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);
332
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);
335
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);
338
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);
341
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);
344
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);
347
348 /**
349  * @brief Get the informations of a file descriptor
350  * @details The returned xbt_dynar_t contains:
351  *  - the size of the file,
352  *  - the mount point,
353  *  - the storage name,
354  *  - the storage typeId,
355  *  - the storage content type
356  *
357  * @param host The surf host
358  * @param fd The file descriptor
359  * @return An xbt_dynar_t with the file informations
360  */
361 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(sg_host_t host, surf_file_t fd);
362
363 /**
364  * @brief Get the available space of the storage at the mount point
365  *
366  * @param resource The surf host
367  * @param name The mount point
368  * @return The amount of available space in bytes
369  */
370 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(sg_host_t resource, const char* name);
371
372 /**
373  * @brief Get the used space of the storage at the mount point
374  *
375  * @param resource The surf host
376  * @param name The mount point
377  * @return The amount of used space in bytes
378  */
379 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(sg_host_t resource, const char* name);
380
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);
383
384 /** @brief Retrieve the params of that VM
385  * @details You can use fields ramsize and overcommit on a PM, too.
386  */
387 XBT_PUBLIC(void) surf_host_get_params(sg_host_t resource, vm_params_t params);
388
389 /** @brief Sets the params of that VM/PM
390  * @details You can use fields ramsize and overcommit on a PM, too.
391  */
392 XBT_PUBLIC(void) surf_host_set_params(sg_host_t resource, vm_params_t params);
393
394 /**
395  * @brief Destroy a VM
396  *
397  * @param resource The surf vm
398  */
399 XBT_PUBLIC(void) surf_vm_destroy(sg_host_t resource);
400
401 /** @brief Suspend a VM */
402 XBT_PUBLIC(void) surf_vm_suspend(sg_host_t resource);
403
404 /** @brief Resume a VM */
405 XBT_PUBLIC(void) surf_vm_resume(sg_host_t resource);
406
407 /**
408  * @brief Save the VM (Not yet implemented)
409  *
410  * @param resource The surf vm
411  */
412 XBT_PUBLIC(void) surf_vm_save(sg_host_t resource);
413
414 /**
415  * @brief Restore the VM (Not yet implemented)
416  *
417  * @param resource The surf vm
418  */
419 XBT_PUBLIC(void) surf_vm_restore(sg_host_t resource);
420
421 /**
422  * @brief Migrate the VM to the destination host
423  *
424  * @param resource The surf vm
425  * @param ind_vm_ws_dest The destination host
426  */
427 XBT_PUBLIC(void) surf_vm_migrate(sg_host_t resource, sg_host_t ind_vm_ws_dest);
428
429 /**
430  * @brief Get the physical machine hosting the VM
431  *
432  * @param resource The surf vm
433  * @return The physical machine hosting the VM
434  */
435 XBT_PUBLIC(sg_host_t) surf_vm_get_pm(sg_host_t resource);
436
437 /**
438  * @brief [brief description]
439  * @details [long description]
440  *
441  * @param resource [description]
442  * @param bound [description]
443  */
444 XBT_PUBLIC(void) surf_vm_set_bound(sg_host_t resource, double bound);
445
446 /**
447  * @brief [brief description]
448  * @details [long description]
449  *
450  * @param resource [description]
451  * @param cpu [description]
452  * @param mask [description]
453  */
454 XBT_PUBLIC(void) surf_vm_set_affinity(sg_host_t resource, sg_host_t cpu, unsigned long mask);
455
456 /**
457  * @brief Execute some quantity of computation
458  *
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
462  */
463 XBT_PUBLIC(surf_action_t) surf_cpu_execute(sg_host_t cpu, double size);
464
465 /**
466  * @brief Make the cpu sleep for duration (in seconds)
467  * @details [long description]
468  *
469  * @param cpu The surf cpu
470  * @param duration The number of seconds to sleep
471  * @return The surf action corresponding to the sleeping
472  */
473 XBT_PUBLIC(surf_action_t) surf_cpu_sleep(sg_host_t cpu, double duration);
474
475 /**
476  * @brief Get the host power peak
477  * @details [long description]
478  *
479  * @param host The surf host
480  * @return The power peak
481  */
482 XBT_PUBLIC(double) surf_host_get_current_power_peak(sg_host_t host);
483
484 /**
485  * @brief [brief description]
486  * @details [long description]
487  *
488  * @param host [description]
489  * @param pstate_index [description]
490  *
491  * @return [description]
492  */
493 XBT_PUBLIC(double) surf_host_get_power_peak_at(sg_host_t host, int pstate_index);
494
495 /**
496  * @brief [brief description]
497  * @details [long description]
498  *
499  * @param host [description]
500  * @return [description]
501  */
502 XBT_PUBLIC(int) surf_host_get_nb_pstates(sg_host_t host);
503
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);
508
509 /**
510  * @brief Get the consumed energy (in joules) of an host
511  *
512  * @param host The surf host
513  * @return The consumed energy
514  */
515 XBT_PUBLIC(double) surf_host_get_consumed_energy(sg_host_t host);
516
517 /**
518  * @brief Get the list of storages mounted on an host
519  *
520  * @param host The surf host
521  * @return Dictionary of mount point, Storage
522  */
523 XBT_PUBLIC(xbt_dict_t) surf_host_get_mounted_storage_list(sg_host_t host);
524
525 /**
526  * @brief Get the list of storages attached to an host
527  *
528  * @param host The surf host
529  * @return Dictionary of storage
530  */
531 XBT_PUBLIC(xbt_dynar_t) surf_host_get_attached_storage_list(sg_host_t host);
532
533 /**
534  * @brief Unlink a file descriptor
535  *
536  * @param host The surf host
537  * @param fd The file descriptor
538  *
539  * @return 0 if failed to unlink, 1 otherwise
540  */
541 XBT_PUBLIC(int) surf_host_unlink(sg_host_t host, surf_file_t fd);
542
543 /**
544  * @brief Get the size of a file on a host
545  *
546  * @param host The surf host
547  * @param fd The file descriptor
548  *
549  * @return The size in bytes of the file
550  */
551 XBT_PUBLIC(size_t) surf_host_get_size(sg_host_t host, surf_file_t fd);
552
553 /**
554  * @brief Get the current position of the file descriptor
555  *
556  * @param host The surf host
557  * @param fd The file descriptor
558  * @return The current position of the file descriptor
559  */
560 XBT_PUBLIC(size_t) surf_host_file_tell(sg_host_t host, surf_file_t fd);
561
562 /**
563  * @brief Move a file to another location on the *same mount point*.
564  * @details [long description]
565  *
566  * @param host The surf host
567  * @param fd The file descriptor
568  * @param fullpath The new full path
569  *
570  * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
571  */
572 XBT_PUBLIC(int) surf_host_file_move(sg_host_t host, surf_file_t fd, const char* fullpath);
573
574 /**
575  * @brief Set the position indictator assiociated with the file descriptor to a new position
576  * @details [long description]
577  *
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
586  */
587 XBT_PUBLIC(int) surf_host_file_seek(sg_host_t host,
588                                            surf_file_t fd, sg_offset_t offset,
589                                            int origin);
590
591 /**
592  * @brief Get the content of a storage
593  *
594  * @param resource The surf storage
595  * @return A xbt_dict_t with path as keys and size in bytes as values
596  */
597 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
598
599 /**
600  * @brief Get the size in bytes of a storage
601  *
602  * @param resource The surf storage
603  * @return The size in bytes of the storage
604  */
605 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
606
607 /**
608  * @brief Get the available size in bytes of a storage
609  *
610  * @param resource The surf storage
611  * @return The available size in bytes of the storage
612  */
613 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
614
615 /**
616  * @brief Get the size in bytes of a storage
617  *
618  * @param resource The surf storage
619  * @return The used size in bytes of the storage
620  */
621 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
622
623 /** @brief return the properties set associated to that storage */
624 XBT_PUBLIC(xbt_dict_t) surf_storage_get_properties(surf_resource_t resource);
625
626 /**
627  * @brief Get the data associated to the action
628  *
629  * @param action The surf action
630  * @return The data associated to the action
631  */
632 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
633
634 /**
635  * @brief Set the data associated to the action
636  * @details [long description]
637  *
638  * @param action The surf action
639  * @param data The new data associated to the action
640  */
641 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
642
643 /**
644  * @brief Unreference an action
645  *
646  * @param action The surf action
647  */
648 XBT_PUBLIC(void) surf_action_unref(surf_action_t action);
649
650 /**
651  * @brief Get the start time of an action
652  *
653  * @param action The surf action
654  * @return The start time in seconds from the beginning of the simulation
655  */
656 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
657
658 /**
659  * @brief Get the finish time of an action
660  *
661  * @param action The surf action
662  * @return The finish time in seconds from the beginning of the simulation
663  */
664 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
665
666 /**
667  * @brief Get the remains amount of work to do of an action
668  *
669  * @param action The surf action
670  * @return  The remains amount of work to do
671  */
672 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
673
674 /**
675  * @brief Suspend an action
676  *
677  * @param action The surf action
678  */
679 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
680
681 /**
682  * @brief Resume an action
683  *
684  * @param action The surf action
685  */
686 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
687
688 /**
689  * @brief Cancel an action
690  *
691  * @param action The surf action
692  */
693 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
694
695 /**
696  * @brief Set the priority of an action
697  * @details [long description]
698  *
699  * @param action The surf action
700  * @param priority The new priority [TODO]
701  */
702 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
703
704 /**
705  * @brief Set the category of an action
706  * @details [long description]
707  *
708  * @param action The surf action
709  * @param category The new category of the action
710  */
711 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
712
713 /**
714  * @brief Get the state of an action
715  *
716  * @param action The surf action
717  * @return The state of the action
718  */
719 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
720
721 /**
722  * @brief Get the cost of an action
723  *
724  * @param action The surf action
725  * @return The cost of the action
726  */
727 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
728
729 /**
730  * @brief [brief desrciption]
731  * @details [long description]
732  *
733  * @param action The surf cpu action
734  * @param cpu [description]
735  * @param mask [description]
736  */
737 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, sg_host_t cpu, unsigned long mask);
738
739 /**
740  * @brief [brief description]
741  * @details [long description]
742  *
743  * @param action The surf cpu action
744  * @param bound [description]
745  */
746 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
747
748 /**
749  * @brief [brief description]
750  * @details [long description]
751  *
752  * @param action The surf network action
753  */
754 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
755
756 /**
757  * @brief Get the file associated to a storage action
758  *
759  * @param action The surf storage action
760  * @return The file associated to a storage action
761  */
762 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
763
764 /**
765  * @brief Get the result dictionary of an ls action
766  *
767  * @param action The surf storage action
768  * @return The dictionry listing a path
769  */
770 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
771
772
773 /**
774  * @brief Get the host the storage is attached to
775  *
776  * @param resource The surf storage
777  * @return The host name
778  * may not exist.
779  */
780 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
781
782 XBT_PUBLIC(surf_host_model_t) surf_host_get_model(sg_host_t host);
783
784 /** @} */
785
786 /**************************************/
787 /* Implementations of model object */
788 /**************************************/
789
790 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
791 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
792
793 /** \ingroup SURF_models
794  *  \brief The CPU model object for the physical machine layer
795  */
796 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
797
798 /** \ingroup SURF_models
799  *  \brief The CPU model object for the virtual machine layer
800  */
801 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
802
803
804 /** \ingroup SURF_models
805  *  \brief Initializes the CPU model with the model Cas01
806  *
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.
811  *
812  *  You shouldn't have to call it by yourself.
813  */
814 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
815
816 /** \ingroup SURF_models
817  *  \brief Initializes the CPU model with trace integration [Deprecated]
818  *
819  *  You shouldn't have to call it by yourself.
820  */
821 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
822
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:...
826  */
827 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
828
829 /** \ingroup SURF_plugins
830  *  \brief The list of all available surf plugins
831  */
832 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
833
834 /** \ingroup SURF_models
835  *  \brief The list of all available cpu model models
836  */
837 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
838
839 /**\brief create new host bypass the parser
840  *
841  */
842
843
844 /** \ingroup SURF_models
845  *  \brief The network model
846  *
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.
851  */
852 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
853
854 /** \ingroup SURF_models
855  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
856  *
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.
861  *
862  *  \see surf_host_model_init_SMPI()
863  */
864 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
865
866 /** \ingroup SURF_models
867  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
868  *
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
871  *
872  *  \see surf_host_model_init_IB()
873  */
874 XBT_PUBLIC(void) surf_network_model_init_IB(void);
875
876 /** \ingroup SURF_models
877  *  \brief Initializes the platform with the network model 'LegrandVelho'
878  *
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.
882  *
883  *  \see surf_host_model_init_LegrandVelho()
884  */
885 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
886
887 /** \ingroup SURF_models
888  *  \brief Initializes the platform with the network model 'Constant'
889  *
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.
895  *
896  *  \see surf_host_model_init_compound()
897  */
898 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
899
900 /** \ingroup SURF_models
901  *  \brief Initializes the platform with the network model CM02
902  *
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.
906  */
907 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
908
909 #ifdef HAVE_NS3
910 /** \ingroup SURF_models
911  *  \brief Initializes the platform with the network model NS3
912  *
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
915  *
916  *  \see surf_host_model_init_NS3()
917  */
918 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
919 #endif
920
921 /** \ingroup SURF_models
922  *  \brief Initializes the platform with the network model Reno
923  *
924  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
925  *
926  *  Reference:
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.
929  *
930  *  Call this function only if you plan using surf_host_model_init_compound.
931  *
932  */
933 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
934
935 /** \ingroup SURF_models
936  *  \brief Initializes the platform with the network model Reno2
937  *
938  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
939  *
940  *  Reference:
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.
943  *
944  *  Call this function only if you plan using surf_host_model_init_compound.
945  *
946  */
947 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
948
949 /** \ingroup SURF_models
950  *  \brief Initializes the platform with the network model Vegas
951  *
952  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
953  *  to the proportional fairness.
954  *
955  *  Reference:
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.
958  *
959  *  Call this function only if you plan using surf_host_model_init_compound.
960  *
961  */
962 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
963
964 /** \ingroup SURF_models
965  *  \brief The list of all available network model models
966  */
967 XBT_PUBLIC_DATA(s_surf_model_description_t)
968     surf_network_model_description[];
969
970 /** \ingroup SURF_models
971  *  \brief The storage model
972  */
973 XBT_PUBLIC(void) surf_storage_model_init_default(void);
974
975 /** \ingroup SURF_models
976  *  \brief The list of all available storage modes.
977  *  This storage mode can be set using --cfg=storage/model:...
978  */
979 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
980
981 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
982
983 /** \ingroup SURF_models
984  *  \brief The host model
985  *
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
989  *  may not exist.
990  */
991 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
992
993 /** \ingroup SURF_models
994  *  \brief The vm model
995  *
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
999  *  may not exist.
1000  */
1001 XBT_PUBLIC_DATA(surf_vm_model_t) surf_vm_model;
1002
1003 /** \ingroup SURF_models
1004  *  \brief Initializes the platform with a compound host model
1005  *
1006  *  This function should be called after a cpu_model and a
1007  *  network_model have been set up.
1008  *
1009  */
1010 XBT_PUBLIC(void) surf_host_model_init_compound(void);
1011
1012 /** \ingroup SURF_models
1013  *  \brief Initializes the platform with the current best network and cpu models at hand
1014  *
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
1018  *  the model Cas01.
1019  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
1020  *
1021  */
1022 XBT_PUBLIC(void) surf_host_model_init_current_default(void);
1023
1024 /** \ingroup SURF_models
1025  *  \brief Initializes the platform with the model L07
1026  *
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.
1030  *
1031  */
1032 XBT_PUBLIC(void) surf_host_model_init_ptask_L07(void);
1033
1034 /** \ingroup SURF_models
1035  *  \brief The list of all available host model models
1036  */
1037 XBT_PUBLIC_DATA(s_surf_model_description_t)
1038     surf_host_model_description[];
1039
1040 /** \ingroup SURF_models
1041  *  \brief Initializes the platform with the current best network and cpu models at hand
1042  *
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
1046  *  the model Cas01.
1047  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
1048  *
1049  */
1050 XBT_PUBLIC(void) surf_vm_model_init_HL13(void);
1051
1052 /** \ingroup SURF_models
1053  *  \brief The list of all available vm model models
1054  */
1055 XBT_PUBLIC_DATA(s_surf_model_description_t)
1056     surf_vm_model_description[];
1057
1058 /*******************************************/
1059
1060 /** \ingroup SURF_models
1061  *  \brief List of initialized models
1062  */
1063 XBT_PUBLIC_DATA(xbt_dynar_t) all_existing_models;
1064
1065 /** \ingroup SURF_simulation
1066  *  \brief List of hosts that have just restarted and whose autorestart process should be restarted.
1067  */
1068 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
1069
1070 /** \ingroup SURF_simulation
1071  *  \brief List of hosts for which one want to be notified if they ever restart.
1072  */
1073 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
1074
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);
1087
1088 /*******************************************/
1089 /*** SURF Globals **************************/
1090 /*******************************************/
1091
1092 /** \ingroup SURF_simulation
1093  *  \brief Initialize SURF
1094  *  \param argc argument number
1095  *  \param argv arguments
1096  *
1097  *  This function has to be called to initialize the common
1098  *  structures.  Then you will have to create the environment by
1099  *  calling
1100  *  e.g. surf_host_model_init_CM02()
1101  *
1102  *  \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
1103  */
1104 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
1105
1106 /** \ingroup SURF_simulation
1107  *  \brief Finish simulation initialization
1108  *
1109  *  This function must be called before the first call to surf_solve()
1110  */
1111 XBT_PUBLIC(void) surf_presolve(void);
1112
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
1117  *
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.
1123  */
1124 XBT_PUBLIC(double) surf_solve(double max_date);
1125
1126 /** \ingroup SURF_simulation
1127  *  \brief Return the current time
1128  *
1129  *  Return the current time in millisecond.
1130  */
1131 XBT_PUBLIC(double) surf_get_clock(void);
1132
1133 /** \ingroup SURF_simulation
1134  *  \brief Exit SURF
1135  *
1136  *  Clean everything.
1137  *
1138  *  \see surf_init()
1139  */
1140 XBT_PUBLIC(void) surf_exit(void);
1141
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) */
1144
1145 /* The same for model_prop set*/
1146 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
1147
1148 /* surf parse file related (public because called from a test suite) */
1149 XBT_PUBLIC(void) parse_platform_file(const char *file);
1150
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;
1158
1159
1160 XBT_PUBLIC(double) get_cpu_speed(const char *power);
1161
1162 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
1163
1164 int surf_get_nthreads(void);
1165 void surf_set_nthreads(int nthreads);
1166
1167 /*
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.
1172  */
1173 const char *__surf_get_initial_path(void);
1174
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);
1180
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);
1190
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();
1197
1198 SG_END_DECL()
1199 #endif                          /* _SURF_SURF_H */