Logo AND Algorithmique Numérique Distribuée

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