Logo AND Algorithmique Numérique Distribuée

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