Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
typo in comments
[simgrid.git] / src / include / surf / surf.h
1 /* Copyright (c) 2004-2014. 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 "portable.h"
16 #include "xbt/config.h"
17 #include "surf/datatypes.h"
18 #include "xbt/lib.h"
19 #include "surf/surf_routing.h"
20 #include "simgrid/platf_interface.h"
21 #include "simgrid/datatypes.h"
22 #include "simgrid/plugins.h"
23
24 SG_BEGIN_DECL()
25 /* Actions and models are highly connected structures... */
26
27 /* user-visible parameters */
28 extern double sg_tcp_gamma;
29 extern double sg_sender_gap;
30 extern double sg_latency_factor;
31 extern double sg_bandwidth_factor;
32 extern double sg_weight_S_parameter;
33 extern int sg_network_crosstraffic;
34 #ifdef HAVE_GTNETS
35 extern double sg_gtnets_jitter;
36 extern int sg_gtnets_jitter_seed;
37 #endif
38 extern xbt_dynar_t surf_path;
39
40 typedef enum {
41   SURF_NETWORK_ELEMENT_NULL = 0,        /* NULL */
42   SURF_NETWORK_ELEMENT_HOST,    /* host type */
43   SURF_NETWORK_ELEMENT_ROUTER,  /* router type */
44   SURF_NETWORK_ELEMENT_AS       /* AS type */
45 } e_surf_network_element_type_t;
46
47 #ifdef __cplusplus
48 class Model;
49 class CpuModel;
50 class HostModel;
51 class VMModel;
52 class NetworkModel;
53 class StorageModel;
54 class Resource;
55 class ResourceLmm;
56 class Host;
57 class HostCLM03;
58 class NetworkCm02Link;
59 class Action;
60 class ActionLmm;
61 class StorageActionLmm;
62 struct As;
63 struct RoutingEdge;
64 class RoutingPlatf;
65 #else
66 typedef struct Model Model;
67 typedef struct CpuModel CpuModel;
68 typedef struct HostModel HostModel;
69 typedef struct VMModel VMModel;
70 typedef struct NetworkModel NetworkModel;
71 typedef struct StorageModel StorageModel;
72 typedef struct Resource Resource;
73 typedef struct ResourceLmm ResourceLmm;
74 typedef struct HostCLM03 HostCLM03;
75 typedef struct Host Host;
76 typedef struct NetworkCm02Link NetworkCm02Link;
77 typedef struct Action Action;
78 typedef struct ActionLmm ActionLmm;
79 typedef struct StorageActionLmm StorageActionLmm;
80 typedef struct As As;
81 typedef struct RoutingEdge RoutingEdge;
82 typedef struct RoutingPlatf RoutingPlatf;
83 #endif
84
85 /** @ingroup SURF_c_bindings
86  *  \brief Model datatype
87  *
88  *  Generic data structure for a model. The hosts,
89  *  the CPUs and the network links are examples of models.
90  */
91 typedef Model *surf_model_t;
92 typedef CpuModel *surf_cpu_model_t;
93 typedef HostModel *surf_host_model_t;
94 typedef VMModel *surf_vm_model_t;
95
96 typedef NetworkModel *surf_network_model_t;
97 typedef StorageModel *surf_storage_model_t;
98
99 typedef xbt_dictelm_t surf_resource_t;
100 typedef Resource *surf_cpp_resource_t;
101 typedef Host *surf_host_t;
102
103 /** @ingroup SURF_c_bindings
104  *  \brief Action structure
105  *
106  *  Never create s_surf_action_t by yourself ! The actions are created
107  *  on the fly when you call execute or communicate on a model.
108  *
109  *  \see e_surf_action_state_t
110  */
111 typedef Action *surf_action_t;
112
113 typedef As *AS_t;
114 typedef RoutingEdge *routing_edge_t;
115 typedef RoutingPlatf *routing_platf_t;
116
117 typedef struct surf_file *surf_file_t;
118
119 XBT_PUBLIC(e_surf_network_element_type_t)
120   routing_get_network_element_type(const char* name);
121
122 /** @Brief Specify that we use that action */
123 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
124
125 /** @brief Creates a new action.
126  *
127  * @param size The size is the one of the subtype you want to create
128  * @param cost initial value
129  * @param model to which model we should attach this action
130  * @param failed whether we should start this action in failed mode
131  */
132 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
133                                    surf_model_t model, int failed);
134
135 /** \brief Resource model description
136  */
137 typedef struct surf_model_description {
138   const char *name;
139   const char *description;
140   void_f_void_t model_init_preparse;
141 } s_surf_model_description_t, *surf_model_description_t;
142
143 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
144                                        const char *name);
145 XBT_PUBLIC(void) model_help(const char *category,
146                             s_surf_model_description_t * table);
147
148 /** @ingroup SURF_interface
149  *  @brief Action states
150  *
151  *  Action states.
152  *
153  *  @see Action
154  */
155 typedef enum {
156   SURF_ACTION_READY = 0,        /**< Ready        */
157   SURF_ACTION_RUNNING,          /**< Running      */
158   SURF_ACTION_FAILED,           /**< Task Failure */
159   SURF_ACTION_DONE,             /**< Completed    */
160   SURF_ACTION_TO_FREE,          /**< Action to free in next cleanup */
161   SURF_ACTION_NOT_IN_THE_SYSTEM /**< Not in the system anymore. Why did you ask ? */
162 } e_surf_action_state_t;
163
164 /** @ingroup SURF_vm_interface
165  *
166  *
167  */
168 /* FIXME: Where should the VM state be defined? */
169 typedef enum {
170   SURF_VM_STATE_CREATED, /**< created, but not yet started */
171   SURF_VM_STATE_RUNNING,
172   SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
173
174   SURF_VM_STATE_SAVING, /**< Save/restore involves disk I/O, so there should be transition states. */
175   SURF_VM_STATE_SAVED,
176   SURF_VM_STATE_RESTORING,
177 } e_surf_vm_state_t;
178
179 /***************************/
180 /* Generic model object */
181 /***************************/
182
183 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
184
185 static inline surf_host_t surf_host_resource_priv(const void *host){
186   return (surf_host_t) xbt_lib_get_level((xbt_dictelm_t)host, SURF_HOST_LEVEL);
187 }
188 static inline void *surf_storage_resource_priv(const void *storage){
189   return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
190 }
191
192 static inline void *surf_storage_resource_by_name(const char *name){
193   return xbt_lib_get_elm_or_null(storage_lib, name);
194 }
195
196 XBT_PUBLIC(void *) surf_as_cluster_get_backbone(AS_t as);
197 XBT_PUBLIC(void) surf_as_cluster_set_backbone(AS_t as, void* backbone);
198
199 /** @{ @ingroup SURF_c_bindings */
200
201 /**
202  * @brief Get the name of a surf model
203  *
204  * @param model A model
205  * @return The name of the model
206  */
207 XBT_PUBLIC(const char *) surf_model_name(surf_model_t model);
208
209 /**
210  * @brief Pop an action from the done actions set
211  *
212  * @param model The model from which the action is extracted
213  * @return An action in done state
214  */
215 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
216
217 /**
218  * @brief Pop an action from the failed actions set
219  *
220  * @param model The model from which the action is extracted
221  * @return An action in failed state
222  */
223 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
224
225 /**
226  * @brief Pop an action from the ready actions set
227  *
228  * @param model The model from which the action is extracted
229  * @return An action in ready state
230  */
231 XBT_PUBLIC(surf_action_t) surf_model_extract_ready_action_set(surf_model_t model);
232
233 /**
234  * @brief Pop an action from the running actions set
235  *
236  * @param model The model from which the action is extracted
237  * @return An action in running state
238  */
239 XBT_PUBLIC(surf_action_t) surf_model_extract_running_action_set(surf_model_t model);
240
241 /**
242  * @brief Get the size of the running action set of a model
243  *
244  * @param model The model
245  * @return The size of the running action set
246  */
247 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
248
249 /**
250  * @brief Execute a parallel task
251  * @details [long description]
252  *
253  * @param model The model which handle the parallelisation
254  * @param host_nb The number of hosts
255  * @param host_list The list of hosts on which the task is executed
256  * @param flops_amount The processing amount (in flop) needed to process
257  * @param bytes_amount The amount of data (in bytes) needed to transfer
258  * @param rate [description]
259  * @return The action corresponding to the parallele execution task
260  */
261 XBT_PUBLIC(surf_action_t) surf_host_model_execute_parallel_task(surf_host_model_t model,
262                                                     int host_nb,
263                                             void **host_list,
264                                             double *flops_amount,
265                                             double *bytes_amount,
266                                             double rate);
267
268 /**
269  * @brief Create a communication between two hosts
270  *
271  * @param model The model which handle the communication
272  * @param src The source host
273  * @param dst The destination host
274  * @param size The amount of data (in bytes) needed to transfer
275  * @param rate [description]
276  * @return The action corresponding to the communication
277  */
278 XBT_PUBLIC(surf_action_t) surf_host_model_communicate(surf_host_model_t model, surf_resource_t src, surf_resource_t dst, double size, double rate);
279
280 /**
281  * @brief Get the route between two hosts
282  * @details [long description]
283  *
284  * @param model The model which handle the routes
285  * @param src The source host
286  * @param dst The destination host
287  * @return The list of [TODO] from the source to the host
288  */
289 XBT_PUBLIC(xbt_dynar_t) surf_host_model_get_route(surf_host_model_t model, surf_resource_t src, surf_resource_t dst);
290
291 /**
292  * @brief Create a new VM on the specified host
293  *
294  * @param name The name of the VM
295  * @param host_PM The host on which the VM is created
296  */
297 XBT_PUBLIC(void) surf_vm_model_create(const char *name, surf_resource_t host_PM);
298
299 /**
300  * @brief Create a communication between two routing edges [TODO]
301  * @details [long description]
302  *
303  * @param model The model which handle the communication
304  * @param src The source host
305  * @param dst The destination host
306  * @param size The amount of data (in bytes) needed to transfer
307  * @param rate [description]
308  * @return The action corresponding to the communication
309  */
310 XBT_PUBLIC(surf_action_t) surf_network_model_communicate(surf_network_model_t model, sg_routing_edge_t src, sg_routing_edge_t dst, double size, double rate);
311
312 /**
313  * @brief Get the name of a surf resource (cpu, host, network, â€¦)
314  *
315  * @param resource The surf resource
316  * @return The name of the surf resource
317  */
318 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
319 static inline const char * surf_cpu_name(surf_cpu_t cpu) {
320         return surf_resource_name((surf_cpp_resource_t)cpu);
321 }
322
323 /**
324  * @brief Get the properties of a surf resource (cpu, host, network, â€¦)
325  *
326  * @param resource The surf resource
327  * @return The properties of the surf resource
328  */
329 XBT_PUBLIC(xbt_dict_t) surf_resource_get_properties(surf_cpp_resource_t resource);
330 static XBT_INLINE xbt_dict_t surf_host_get_properties(surf_host_t host) {
331         return surf_resource_get_properties((surf_cpp_resource_t)host);
332 }
333
334
335 /**
336  * @brief Get the state of a surf resource (cpu, host, network, â€¦)
337  *
338  * @param resource The surf resource
339  * @return The state of the surf resource
340  */
341 XBT_PUBLIC(e_surf_resource_state_t) surf_resource_get_state(surf_cpp_resource_t resource);
342
343 static XBT_INLINE e_surf_resource_state_t surf_host_get_state(surf_host_t host) {
344         return surf_resource_get_state((surf_cpp_resource_t)host);
345 }
346
347
348 /**
349  * @brief Set the state of a surf resource (cpu, host, network, â€¦)
350  *
351  * @param resource The surf resource
352  * @param state The new state of the surf resource
353  */
354 XBT_PUBLIC(void) surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state);
355 static inline void surf_host_set_state(surf_host_t host, e_surf_resource_state_t state) {
356         surf_resource_set_state((surf_cpp_resource_t)host, state);
357 }
358
359 /**
360  * @brief Get the speed of the cpu associated to a host
361  *
362  * @param resource The surf host
363  * @param load [description]
364  *
365  * @return [description]
366  */
367 XBT_PUBLIC(double) surf_host_get_speed(surf_resource_t resource, double load);
368
369 /**
370  * @brief Get the available speed of cpu associated to a host
371  *
372  * @param resource The surf host
373  * @return [description]
374  */
375 XBT_PUBLIC(double) surf_host_get_available_speed(surf_resource_t resource);
376
377 /**
378  * @brief Get the number of cores of the cpu associated to a host
379  *
380  * @param resource The surf host
381  * @return The number of cores
382  */
383 XBT_PUBLIC(int) surf_host_get_core(surf_resource_t resource);
384
385 /**
386  * @brief Execute some quantity of computation
387  *
388  * @param resource The surf host
389  * @param size The value of the processing amount (in flop) needed to process
390  *
391  * @return The surf action corresponding to the processing
392  */
393 XBT_PUBLIC(surf_action_t) surf_host_execute(surf_resource_t resource, double size);
394
395 /**
396  * @brief Make the host sleep
397  *
398  * @param resource The surf host
399  * @param duration The number of seconds to sleep
400  * @return The surf action corresponding to the sleep
401  */
402 XBT_PUBLIC(surf_action_t) surf_host_sleep(surf_resource_t resource, double duration);
403
404 /**
405  * @brief Open a file on an host
406  *
407  * @param host The surf host
408  * @param fullpath The path to the file
409  * @return The surf action corresponding to the openning
410  */
411 XBT_PUBLIC(surf_action_t) surf_host_open(surf_resource_t host, const char* fullpath);
412
413 /**
414  * @brief Close a file descriptor on an host
415  *
416  * @param host The surf host
417  * @param fd The file descriptor
418  *
419  * @return The surf action corresponding to the closing
420  */
421 XBT_PUBLIC(surf_action_t) surf_host_close(surf_resource_t host, surf_file_t fd);
422
423 /**
424  * @brief Read a file
425  *
426  * @param host The surf host
427  * @param fd The file descriptor to read
428  * @param size The size in bytes to read
429  * @return The surf action corresponding to the reading
430  */
431 XBT_PUBLIC(surf_action_t) surf_host_read(surf_resource_t host, surf_file_t fd, sg_size_t size);
432
433 /**
434  * @brief Write a file
435  *
436  * @param host The surf host
437  * @param fd The file descriptor to write
438  * @param size The size in bytes to write
439  * @return The surf action corresponding to the writing
440  */
441 XBT_PUBLIC(surf_action_t) surf_host_write(surf_resource_t host, surf_file_t fd, sg_size_t size);
442
443 /**
444  * @brief Get the informations of a file descriptor
445  * @details The returned xbt_dynar_t contains:
446  *  - the size of the file,
447  *  - the mount point,
448  *  - the storage name,
449  *  - the storage typeId,
450  *  - the storage content type
451  *
452  * @param host The surf host
453  * @param fd The file descriptor
454  * @return An xbt_dynar_t with the file informations
455  */
456 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(surf_resource_t host, surf_file_t fd);
457
458 /**
459  * @brief Get the available space of the storage at the mount point
460  *
461  * @param resource The surf host
462  * @param name The mount point
463  * @return The amount of available space in bytes
464  */
465 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(surf_resource_t resource, const char* name);
466
467 /**
468  * @brief Get the used space of the storage at the mount point
469  *
470  * @param resource The surf host
471  * @param name The mount point
472  * @return The amount of used space in bytes
473  */
474 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(surf_resource_t resource, const char* name);
475
476 /**
477  * @brief Get the VMs hosted on the host
478  *
479  * @param resource The surf host
480  * @return The list of VMs on the host
481  */
482 XBT_PUBLIC(xbt_dynar_t) surf_host_get_vms(surf_resource_t resource);
483
484 /**
485  * @brief [brief description]
486  * @details [long description]
487  *
488  * @param resource [description]
489  * @param params [description]
490  */
491 XBT_PUBLIC(void) surf_host_get_params(surf_resource_t resource, ws_params_t params);
492
493 /**
494  * @brief [brief description]
495  * @details [long description]
496  *
497  * @param resource [description]
498  * @param params [description]
499  */
500 XBT_PUBLIC(void) surf_host_set_params(surf_resource_t resource, ws_params_t params);
501
502 /**
503  * @brief Destroy a VM
504  *
505  * @param resource The surf vm
506  */
507 XBT_PUBLIC(void) surf_vm_destroy(surf_resource_t resource);
508
509 /**
510  * @brief Suspend a VM
511  *
512  * @param resource The surf vm
513  */
514 XBT_PUBLIC(void) surf_vm_suspend(surf_resource_t resource);
515
516 /**
517  * @brief Resume a VM
518  *
519  * @param resource The surf vm
520  */
521 XBT_PUBLIC(void) surf_vm_resume(surf_resource_t resource);
522
523 /**
524  * @brief Save the VM (Not yet implemented)
525  *
526  * @param resource The surf vm
527  */
528 XBT_PUBLIC(void) surf_vm_save(surf_resource_t resource);
529
530 /**
531  * @brief Restore the VM (Not yet implemented)
532  *
533  * @param resource The surf vm
534  */
535 XBT_PUBLIC(void) surf_vm_restore(surf_resource_t resource);
536
537 /**
538  * @brief Migrate the VM to the destination host
539  *
540  * @param resource The surf vm
541  * @param ind_vm_ws_dest The destination host
542  */
543 XBT_PUBLIC(void) surf_vm_migrate(surf_resource_t resource, surf_resource_t ind_vm_ws_dest);
544
545 /**
546  * @brief Get the physical machine hosting the VM
547  *
548  * @param resource The surf vm
549  * @return The physical machine hosting the VM
550  */
551 XBT_PUBLIC(surf_resource_t) surf_vm_get_pm(surf_resource_t resource);
552
553 /**
554  * @brief [brief description]
555  * @details [long description]
556  *
557  * @param resource [description]
558  * @param bound [description]
559  */
560 XBT_PUBLIC(void) surf_vm_set_bound(surf_resource_t resource, double bound);
561
562 /**
563  * @brief [brief description]
564  * @details [long description]
565  *
566  * @param resource [description]
567  * @param cpu [description]
568  * @param mask [description]
569  */
570 XBT_PUBLIC(void) surf_vm_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask);
571
572 /**
573  * @brief Execute some quantity of computation
574  *
575  * @param cpu The surf cpu
576  * @param size The value of the processing amount (in flop) needed to process
577  * @return The surf action corresponding to the processing
578  */
579 XBT_PUBLIC(surf_action_t) surf_cpu_execute(surf_resource_t cpu, double size);
580
581 /**
582  * @brief Make the cpu sleep for duration (in seconds)
583  * @details [long description]
584  *
585  * @param cpu The surf cpu
586  * @param duration The number of seconds to sleep
587  * @return The surf action corresponding to the sleeping
588  */
589 XBT_PUBLIC(surf_action_t) surf_cpu_sleep(surf_resource_t cpu, double duration);
590
591 /**
592  * @brief Get the host power peak
593  * @details [long description]
594  *
595  * @param host The surf host
596  * @return The power peak
597  */
598 XBT_PUBLIC(double) surf_host_get_current_power_peak(surf_resource_t host);
599
600 /**
601  * @brief [brief description]
602  * @details [long description]
603  *
604  * @param host [description]
605  * @param pstate_index [description]
606  *
607  * @return [description]
608  */
609 XBT_PUBLIC(double) surf_host_get_power_peak_at(surf_resource_t host, int pstate_index);
610
611 /**
612  * @brief [brief description]
613  * @details [long description]
614  *
615  * @param host [description]
616  * @return [description]
617  */
618 XBT_PUBLIC(int) surf_host_get_nb_pstates(surf_resource_t host);
619
620 XBT_PUBLIC(void) surf_host_set_pstate(surf_resource_t host, int pstate_index);
621 XBT_PUBLIC(int) surf_host_get_pstate(surf_resource_t host);
622 XBT_PUBLIC(double) surf_host_get_wattmin_at(surf_resource_t resource, int pstate);
623 XBT_PUBLIC(double) surf_host_get_wattmax_at(surf_resource_t resource, int pstate);
624
625 /**
626  * @brief Get the consumed energy (in joules) of an host
627  *
628  * @param host The surf host
629  * @return The consumed energy
630  */
631 XBT_PUBLIC(double) surf_host_get_consumed_energy(surf_resource_t host);
632
633 /**
634  * @brief Get the list of storages mounted on an host
635  *
636  * @param host The surf host
637  * @return Dictionary of mount point, Storage
638  */
639 XBT_PUBLIC(xbt_dict_t) surf_host_get_mounted_storage_list(surf_resource_t host);
640
641 /**
642  * @brief Get the list of storages attached to an host
643  *
644  * @param host The surf host
645  * @return Dictionary of storage
646  */
647 XBT_PUBLIC(xbt_dynar_t) surf_host_get_attached_storage_list(surf_resource_t host);
648
649 /**
650  * @brief Unlink a file descriptor
651  *
652  * @param host The surf host
653  * @param fd The file descriptor
654  *
655  * @return 0 if failed to unlink, 1 otherwise
656  */
657 XBT_PUBLIC(int) surf_host_unlink(surf_resource_t host, surf_file_t fd);
658
659 /**
660  * @brief Get the size of a file on a host
661  *
662  * @param host The surf host
663  * @param fd The file descriptor
664  *
665  * @return The size in bytes of the file
666  */
667 XBT_PUBLIC(size_t) surf_host_get_size(surf_resource_t host, surf_file_t fd);
668
669 /**
670  * @brief Get the current position of the file descriptor
671  *
672  * @param host The surf host
673  * @param fd The file descriptor
674  * @return The current position of the file descriptor
675  */
676 XBT_PUBLIC(size_t) surf_host_file_tell(surf_resource_t host, surf_file_t fd);
677
678 /**
679  * @brief Move a file to another location on the *same mount point*.
680  * @details [long description]
681  *
682  * @param host The surf host
683  * @param fd The file descriptor
684  * @param fullpath The new full path
685  *
686  * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
687  */
688 XBT_PUBLIC(int) surf_host_file_move(surf_resource_t host, surf_file_t fd, const char* fullpath);
689
690 /**
691  * @brief Set the position indictator assiociated with the file descriptor to a new position
692  * @details [long description]
693  *
694  * @param host The surf host
695  * @param fd The file descriptor
696  * @param offset The offset from the origin
697  * @param origin Position used as a reference for the offset
698  *  - SEEK_SET: beginning of the file
699  *  - SEEK_CUR: current position indicator
700  *  - SEEK_END: end of the file
701  * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
702  */
703 XBT_PUBLIC(int) surf_host_file_seek(surf_resource_t host,
704                                            surf_file_t fd, sg_offset_t offset,
705                                            int origin);
706
707 /**
708  * @brief Get the content of a storage
709  *
710  * @param resource The surf storage
711  * @return A xbt_dict_t with path as keys and size in bytes as values
712  */
713 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
714
715 /**
716  * @brief Get the size in bytes of a storage
717  *
718  * @param resource The surf storage
719  * @return The size in bytes of the storage
720  */
721 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
722
723 /**
724  * @brief Get the available size in bytes of a storage
725  *
726  * @param resource The surf storage
727  * @return The available size in bytes of the storage
728  */
729 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
730
731 /**
732  * @brief Get the size in bytes of a storage
733  *
734  * @param resource The surf storage
735  * @return The used size in bytes of the storage
736  */
737 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
738
739
740 /**
741  * @brief Get the data associated to the action
742  *
743  * @param action The surf action
744  * @return The data associated to the action
745  */
746 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
747
748 /**
749  * @brief Set the data associated to the action
750  * @details [long description]
751  *
752  * @param action The surf action
753  * @param data The new data associated to the action
754  */
755 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
756
757 /**
758  * @brief Unreference an action
759  *
760  * @param action The surf action
761  */
762 XBT_PUBLIC(void) surf_action_unref(surf_action_t action);
763
764 /**
765  * @brief Get the start time of an action
766  *
767  * @param action The surf action
768  * @return The start time in seconds from the beginning of the simulation
769  */
770 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
771
772 /**
773  * @brief Get the finish time of an action
774  *
775  * @param action The surf action
776  * @return The finish time in seconds from the beginning of the simulation
777  */
778 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
779
780 /**
781  * @brief Get the remains amount of work to do of an action
782  *
783  * @param action The surf action
784  * @return  The remains amount of work to do
785  */
786 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
787
788 /**
789  * @brief Suspend an action
790  *
791  * @param action The surf action
792  */
793 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
794
795 /**
796  * @brief Resume an action
797  *
798  * @param action The surf action
799  */
800 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
801
802 /**
803  * @brief Cancel an action
804  *
805  * @param action The surf action
806  */
807 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
808
809 /**
810  * @brief Set the priority of an action
811  * @details [long description]
812  *
813  * @param action The surf action
814  * @param priority The new priority [TODO]
815  */
816 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
817
818 /**
819  * @brief Set the category of an action
820  * @details [long description]
821  *
822  * @param action The surf action
823  * @param category The new category of the action
824  */
825 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
826
827 /**
828  * @brief Get the state of an action
829  *
830  * @param action The surf action
831  * @return The state of the action
832  */
833 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
834
835 /**
836  * @brief Get the cost of an action
837  *
838  * @param action The surf action
839  * @return The cost of the action
840  */
841 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
842
843 /**
844  * @brief [brief desrciption]
845  * @details [long description]
846  *
847  * @param action The surf cpu action
848  * @param cpu [description]
849  * @param mask [description]
850  */
851 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask);
852
853 /**
854  * @brief [brief description]
855  * @details [long description]
856  *
857  * @param action The surf cpu action
858  * @param bound [description]
859  */
860 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
861
862 /**
863  * @brief [brief description]
864  * @details [long description]
865  *
866  * @param action The surf network action
867  */
868 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
869
870 /**
871  * @brief Get the file associated to a storage action
872  *
873  * @param action The surf storage action
874  * @return The file associated to a storage action
875  */
876 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
877
878 /**
879  * @brief Get the result dictionary of an ls action
880  *
881  * @param action The surf storage action
882  * @return The dictionry listing a path
883  */
884 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
885
886
887 /**
888  * @brief Get the host the storage is attached to
889  *
890  * @param resource The surf storage
891  * @return The host name
892  */
893 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
894
895 XBT_PUBLIC(surf_model_t) surf_resource_model(const void *host, int level);
896
897 /** @} */
898
899 /**************************************/
900 /* Implementations of model object */
901 /**************************************/
902
903 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
904 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
905
906 /** \ingroup SURF_models
907  *  \brief The CPU model object for the physical machine layer
908  */
909 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
910
911 /** \ingroup SURF_models
912  *  \brief The CPU model object for the virtual machine layer
913  */
914 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
915
916
917 /** \ingroup SURF_models
918  *  \brief Initializes the CPU model with the model Cas01
919  *
920  *  By default, this model uses the lazy optimization mechanism that
921  *  relies on partial invalidation in LMM and a heap for lazy action update.
922  *  You can change this behavior by setting the cpu/optim configuration
923  *  variable to a different value.
924  *
925  *  You shouldn't have to call it by yourself.
926  */
927 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
928
929 /** \ingroup SURF_models
930  *  \brief Initializes the CPU model with trace integration [Deprecated]
931  *
932  *  You shouldn't have to call it by yourself.
933  */
934 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
935
936 /** \ingroup SURF_models
937  *  \brief The list of all available optimization modes (both for cpu and networks).
938  *  These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
939  */
940 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
941
942 /** \ingroup SURF_plugins
943  *  \brief The list of all available surf plugins
944  */
945 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
946
947 /** \ingroup SURF_models
948  *  \brief The list of all available cpu model models
949  */
950 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
951
952 /**\brief create new host bypass the parser
953  *
954  */
955
956
957 /** \ingroup SURF_models
958  *  \brief The network model
959  *
960  *  When creating a new API on top on SURF, you shouldn't use the
961  *  network model unless you know what you are doing. Only the host
962  *  model should be accessed because depending on the platform model,
963  *  the network model can be NULL.
964  */
965 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
966
967 /** \ingroup SURF_models
968  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
969  *
970  * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
971  * based on the model 'LV08' and different correction factors depending on the communication
972  * size (< 1KiB, < 64KiB, >= 64KiB).
973  * See comments in the code for more information.
974  *
975  *  \see surf_host_model_init_SMPI()
976  */
977 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
978
979 /** \ingroup SURF_models
980  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
981  *
982  * This model impelments a variant of the contention model on Infinband networks based on
983  * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
984  *
985  *  \see surf_host_model_init_IB()
986  */
987 XBT_PUBLIC(void) surf_network_model_init_IB(void);
988
989 /** \ingroup SURF_models
990  *  \brief Initializes the platform with the network model 'LegrandVelho'
991  *
992  * This model is proposed by Arnaud Legrand and Pedro Velho based on
993  * the results obtained with the GTNets simulator for onelink and
994  * dogbone sharing scenarios. See comments in the code for more information.
995  *
996  *  \see surf_host_model_init_LegrandVelho()
997  */
998 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
999
1000 /** \ingroup SURF_models
1001  *  \brief Initializes the platform with the network model 'Constant'
1002  *
1003  *  In this model, the communication time between two network cards is
1004  *  constant, hence no need for a routing table. This is particularly
1005  *  usefull when simulating huge distributed algorithms where
1006  *  scalability is really an issue. This function is called in
1007  *  conjunction with surf_host_model_init_compound.
1008  *
1009  *  \see surf_host_model_init_compound()
1010  */
1011 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
1012
1013 /** \ingroup SURF_models
1014  *  \brief Initializes the platform with the network model CM02
1015  *
1016  *  You sould call this function by yourself only if you plan using
1017  *  surf_host_model_init_compound.
1018  *  See comments in the code for more information.
1019  */
1020 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
1021
1022 #ifdef HAVE_GTNETS
1023 /** \ingroup SURF_models
1024  *  \brief Initializes the platform with the network model GTNETS
1025  *  \param filename XML platform file name
1026  *
1027  *  This function is called by surf_host_model_init_GTNETS
1028  *  or by yourself only if you plan using surf_host_model_init_compound
1029  *
1030  *  \see surf_host_model_init_GTNETS()
1031  */
1032 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
1033 #endif
1034
1035 #ifdef HAVE_NS3
1036 /** \ingroup SURF_models
1037  *  \brief Initializes the platform with the network model NS3
1038  *  \param filename XML platform file name
1039  *
1040  *  This function is called by surf_host_model_init_NS3
1041  *  or by yourself only if you plan using surf_host_model_init_compound
1042  *
1043  *  \see surf_host_model_init_NS3()
1044  */
1045 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
1046 #endif
1047
1048 /** \ingroup SURF_models
1049  *  \brief Initializes the platform with the network model Reno
1050  *  \param filename XML platform file name
1051  *
1052  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
1053  *
1054  *  Reference:
1055  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1056  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1057  *
1058  *  Call this function only if you plan using surf_host_model_init_compound.
1059  *
1060  */
1061 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
1062
1063 /** \ingroup SURF_models
1064  *  \brief Initializes the platform with the network model Reno2
1065  *  \param filename XML platform file name
1066  *
1067  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
1068  *
1069  *  Reference:
1070  *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
1071  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1072  *
1073  *  Call this function only if you plan using surf_host_model_init_compound.
1074  *
1075  */
1076 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
1077
1078 /** \ingroup SURF_models
1079  *  \brief Initializes the platform with the network model Vegas
1080  *  \param filename XML platform file name
1081  *
1082  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
1083  *  to the proportional fairness.
1084  *
1085  *  Reference:
1086  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1087  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1088  *
1089  *  Call this function only if you plan using surf_host_model_init_compound.
1090  *
1091  */
1092 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
1093
1094 /** \ingroup SURF_models
1095  *  \brief The list of all available network model models
1096  */
1097 XBT_PUBLIC_DATA(s_surf_model_description_t)
1098     surf_network_model_description[];
1099
1100 /** \ingroup SURF_models
1101  *  \brief The storage model
1102  */
1103 XBT_PUBLIC(void) surf_storage_model_init_default(void);
1104
1105 /** \ingroup SURF_models
1106  *  \brief The list of all available storage modes.
1107  *  This storage mode can be set using --cfg=storage/model:...
1108  */
1109 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
1110
1111 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
1112
1113 /** \ingroup SURF_models
1114  *  \brief The host model
1115  *
1116  *  Note that when you create an API on top of SURF,
1117  *  the host model should be the only one you use
1118  *  because depending on the platform model, the network model and the CPU model
1119  *  may not exist.
1120  */
1121 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
1122
1123 /** \ingroup SURF_models
1124  *  \brief The vm model
1125  *
1126  *  Note that when you create an API on top of SURF,
1127  *  the vm model should be the only one you use
1128  *  because depending on the platform model, the network model and the CPU model
1129  *  may not exist.
1130  */
1131 XBT_PUBLIC_DATA(surf_vm_model_t) surf_vm_model;
1132
1133 /** \ingroup SURF_models
1134  *  \brief Initializes the platform with a compound host model
1135  *
1136  *  This function should be called after a cpu_model and a
1137  *  network_model have been set up.
1138  *
1139  */
1140 XBT_PUBLIC(void) surf_host_model_init_compound(void);
1141
1142 /** \ingroup SURF_models
1143  *  \brief Initializes the platform with the current best network and cpu models at hand
1144  *
1145  *  This platform model separates the host model and the network model.
1146  *  The host model will be initialized with the model compound, the network
1147  *  model with the model LV08 (with cross traffic support) and the CPU model with
1148  *  the model Cas01.
1149  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
1150  *
1151  */
1152 XBT_PUBLIC(void) surf_host_model_init_current_default(void);
1153
1154 /** \ingroup SURF_models
1155  *  \brief Initializes the platform with the model L07
1156  *
1157  *  With this model, only parallel tasks can be used. Resource sharing
1158  *  is done by identifying bottlenecks and giving an equal share of
1159  *  the model to each action.
1160  *
1161  */
1162 XBT_PUBLIC(void) surf_host_model_init_ptask_L07(void);
1163
1164 /** \ingroup SURF_models
1165  *  \brief The list of all available host model models
1166  */
1167 XBT_PUBLIC_DATA(s_surf_model_description_t)
1168     surf_host_model_description[];
1169
1170 /** \ingroup SURF_models
1171  *  \brief Initializes the platform with the current best network and cpu models at hand
1172  *
1173  *  This platform model seperates the host model and the network model.
1174  *  The host model will be initialized with the model compound, the network
1175  *  model with the model LV08 (with cross traffic support) and the CPU model with
1176  *  the model Cas01.
1177  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
1178  *
1179  */
1180 XBT_PUBLIC(void) surf_vm_model_init_HL13(void);
1181
1182 /** \ingroup SURF_models
1183  *  \brief The list of all available vm model models
1184  */
1185 XBT_PUBLIC_DATA(s_surf_model_description_t)
1186     surf_vm_model_description[];
1187
1188 /*******************************************/
1189
1190 /** \ingroup SURF_models
1191  *  \brief List of initialized models
1192  */
1193 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
1194 XBT_PUBLIC_DATA(xbt_dynar_t) model_list_invoke;
1195
1196 /** \ingroup SURF_simulation
1197  *  \brief List of hosts that have juste restarted and whose autorestart process should be restarted.
1198  */
1199 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
1200
1201 /** \ingroup SURF_simulation
1202  *  \brief List of hosts for which one want to be notified if they ever restart.
1203  */
1204 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
1205
1206 /*******************************************/
1207 /*** SURF Platform *************************/
1208 /*******************************************/
1209 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
1210 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
1211 XBT_PUBLIC_DATA(AS_t) surf_AS_get_by_name(const char * name);
1212 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
1213 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
1214 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
1215 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
1216 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
1217 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
1218
1219 /*******************************************/
1220 /*** SURF Globals **************************/
1221 /*******************************************/
1222
1223 /** \ingroup SURF_simulation
1224  *  \brief Initialize SURF
1225  *  \param argc argument number
1226  *  \param argv arguments
1227  *
1228  *  This function has to be called to initialize the common
1229  *  structures.  Then you will have to create the environment by
1230  *  calling
1231  *  e.g. surf_host_model_init_CM02()
1232  *
1233  *  \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
1234  */
1235 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
1236
1237 /** \ingroup SURF_simulation
1238  *  \brief Finish simulation initialization
1239  *
1240  *  This function must be called before the first call to surf_solve()
1241  */
1242 XBT_PUBLIC(void) surf_presolve(void);
1243
1244 /** \ingroup SURF_simulation
1245  *  \brief Performs a part of the simulation
1246  *  \param max_date Maximum date to update the simulation to, or -1
1247  *  \return the elapsed time, or -1.0 if no event could be executed
1248  *
1249  *  This function execute all possible events, update the action states
1250  *  and returns the time elapsed.
1251  *  When you call execute or communicate on a model, the corresponding actions
1252  *  are not executed immediately but only when you call surf_solve.
1253  *  Note that the returned elapsed time can be zero.
1254  */
1255 XBT_PUBLIC(double) surf_solve(double max_date);
1256
1257 /** \ingroup SURF_simulation
1258  *  \brief Return the current time
1259  *
1260  *  Return the current time in millisecond.
1261  */
1262 XBT_PUBLIC(double) surf_get_clock(void);
1263
1264 /** \ingroup SURF_simulation
1265  *  \brief Exit SURF
1266  *
1267  *  Clean everything.
1268  *
1269  *  \see surf_init()
1270  */
1271 XBT_PUBLIC(void) surf_exit(void);
1272
1273 /* Prototypes of the functions that handle the properties */
1274 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;       /* the prop set for the currently parsed element (also used in SIMIX) */
1275
1276 /* The same for model_prop set*/
1277 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
1278
1279 /* surf parse file related (public because called from a test suite) */
1280 XBT_PUBLIC(void) parse_platform_file(const char *file);
1281
1282 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
1283 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
1284 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
1285 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
1286 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
1287 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
1288 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
1289
1290
1291 XBT_PUBLIC(double) get_cpu_power(const char *power);
1292
1293 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
1294
1295 int surf_get_nthreads(void);
1296 void surf_set_nthreads(int nthreads);
1297
1298 /*
1299  * Returns the initial path. On Windows the initial path is
1300  * the current directory for the current process in the other
1301  * case the function returns "./" that represents the current
1302  * directory on Unix/Linux platforms.
1303  */
1304 const char *__surf_get_initial_path(void);
1305
1306 /********** Tracing **********/
1307 /* from surf_instr.c */
1308 void TRACE_surf_action(surf_action_t surf_action, const char *category);
1309 void TRACE_surf_alloc(void);
1310 void TRACE_surf_release(void);
1311
1312 /* instr_routing.c */
1313 void instr_routing_define_callbacks (void);
1314 void instr_new_variable_type (const char *new_typename, const char *color);
1315 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color);
1316 void instr_new_user_state_type (const char *father_type, const char *new_typename);
1317 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
1318 int instr_platform_traced (void);
1319 xbt_graph_t instr_routing_platform_graph (void);
1320 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1321
1322 SG_END_DECL()
1323 #endif                          /* _SURF_SURF_H */