Logo AND Algorithmique Numérique Distribuée

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