Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
use #if instead if #ifdef for the things in the public config header
[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/datatypes.h"
22 #include "simgrid/forward.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_HOST=1,     /* host type */
38   SURF_NETWORK_ELEMENT_ROUTER,   /* router type */
39   SURF_NETWORK_ELEMENT_AS        /* AS type */
40 } e_surf_network_element_type_t;
41
42 #ifdef __cplusplus
43
44 namespace simgrid {
45 namespace surf {
46
47 class Model;
48 class CpuModel;
49 class HostModel;
50 class VMModel;
51 class NetworkModel;
52 class StorageModel;
53 class Resource;
54 class ResourceLmm;
55 class HostImpl;
56 class HostCLM03;
57 class NetworkCm02Link;
58 class Action;
59 class ActionLmm;
60 class StorageActionLmm;
61 class RoutingPlatf;
62 }
63 }
64
65 typedef simgrid::surf::Model surf_Model;
66 typedef simgrid::surf::CpuModel surf_CpuModel;
67 typedef simgrid::surf::HostModel surf_HostModel;
68 typedef simgrid::surf::VMModel surf_VMModel;
69 typedef simgrid::surf::NetworkModel surf_NetworkModel;
70 typedef simgrid::surf::StorageModel surf_StorageModel;
71 typedef simgrid::surf::Resource surf_Resource;
72 typedef simgrid::surf::ResourceLmm surf_ResourceLmm;
73 typedef simgrid::surf::HostImpl surf_Host;
74 typedef simgrid::surf::HostCLM03 surf_HostCLM03;
75 typedef simgrid::surf::NetworkCm02Link surf_NetworkCm02Link;
76 typedef simgrid::surf::Action surf_Action;
77 typedef simgrid::surf::ActionLmm surf_ActionLmm;
78 typedef simgrid::surf::StorageActionLmm surf_StorageActionLmm;
79 typedef simgrid::surf::RoutingPlatf surf_RoutingPlatf;
80
81 #else
82
83 typedef struct surf_Model surf_Model;
84 typedef struct surf_CpuModel surf_CpuModel;
85 typedef struct surf_HostModel surf_HostModel;
86 typedef struct surf_VMModel surf_VMModel;
87 typedef struct surf_NetworkModel surf_NetworkModel;
88 typedef struct surf_StorageModel surf_StorageModel;
89 typedef struct surf_Resource surf_Resource;
90 typedef struct surf_ResourceLmm surf_ResourceLmm;
91 typedef struct surf_HostCLM03 surf_HostCLM03;
92 typedef struct surf_Host surf_Host;
93 typedef struct surf_NetworkCm02Link surf_NetworkCm02Link;
94 typedef struct surf_Action surf_Action;
95 typedef struct surf_ActionLmm surf_ActionLmm;
96 typedef struct surf_StorageActionLmm surf_StorageActionLmm;
97 typedef struct surf_RoutingPlatf surf_RoutingPlatf;
98
99 #endif
100
101 /** @ingroup SURF_c_bindings
102  *  \brief Model datatype
103  *
104  *  Generic data structure for a model. The hosts,
105  *  the CPUs and the network links are examples of models.
106  */
107 typedef surf_Model *surf_model_t;
108 typedef surf_CpuModel *surf_cpu_model_t;
109 typedef surf_HostModel *surf_host_model_t;
110 typedef surf_VMModel *surf_vm_model_t;
111 typedef surf_NetworkModel *surf_network_model_t;
112 typedef surf_StorageModel *surf_storage_model_t;
113
114 typedef xbt_dictelm_t surf_resource_t;
115 typedef surf_Resource *surf_cpp_resource_t;
116 typedef surf_Host *surf_host_t;
117 typedef surf_Cpu *surf_cpu_t;
118
119 /** @ingroup SURF_c_bindings
120  *  \brief Action structure
121  *
122  *  Never create s_surf_action_t by yourself ! The actions are created
123  *  on the fly when you call execute or communicate on a model.
124  *
125  *  \see e_surf_action_state_t
126  */
127 typedef surf_Action *surf_action_t;
128 typedef surf_RoutingPlatf *routing_platf_t;
129
130 typedef struct surf_file *surf_file_t;
131
132 /** \brief Resource model description
133  */
134 typedef struct surf_model_description {
135   const char *name;
136   const char *description;
137   void_f_void_t model_init_preparse;
138 } s_surf_model_description_t, *surf_model_description_t;
139
140 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table, const char *name);
141 XBT_PUBLIC(void) model_help(const char *category, s_surf_model_description_t * table);
142
143 /** @ingroup SURF_interface
144  *  @brief Action states
145  *
146  *  @see Action
147  */
148 typedef enum {
149   SURF_ACTION_READY = 0,        /**< Ready        */
150   SURF_ACTION_RUNNING,          /**< Running      */
151   SURF_ACTION_FAILED,           /**< Task Failure */
152   SURF_ACTION_DONE,             /**< Completed    */
153   SURF_ACTION_TO_FREE,          /**< Action to free in next cleanup */
154   SURF_ACTION_NOT_IN_THE_SYSTEM /**< Not in the system anymore. Why did you ask ? */
155 } e_surf_action_state_t;
156
157 /** @ingroup SURF_vm_interface
158  *
159  *
160  */
161 /* FIXME: Where should the VM state be defined? */
162 typedef enum {
163   SURF_VM_STATE_CREATED, /**< created, but not yet started */
164   SURF_VM_STATE_RUNNING,
165   SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
166
167   SURF_VM_STATE_SAVING, /**< Save/restore involves disk I/O, so there should be transition states. */
168   SURF_VM_STATE_SAVED,
169   SURF_VM_STATE_RESTORING,
170 } e_surf_vm_state_t;
171
172 /***************************/
173 /* Generic model object */
174 /***************************/
175
176 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
177
178 static inline void *surf_storage_resource_priv(const void *storage){
179   return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
180 }
181
182 static inline void *surf_storage_resource_by_name(const char *name){
183   return xbt_lib_get_elm_or_null(storage_lib, name);
184 }
185
186 /** @{ @ingroup SURF_c_bindings */
187
188 /**
189  * @brief Pop an action from the done actions set
190  *
191  * @param model The model from which the action is extracted
192  * @return An action in done state
193  */
194 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
195
196 /**
197  * @brief Pop an action from the failed actions set
198  *
199  * @param model The model from which the action is extracted
200  * @return An action in failed state
201  */
202 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
203
204 /**
205  * @brief Get the size of the running action set of a model
206  *
207  * @param model The model
208  * @return The size of the running action set
209  */
210 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
211
212 /** @brief Create a new VM on the specified host */
213 XBT_PUBLIC(void) surf_vm_model_create(const char *name, sg_host_t host_PM);
214
215 /** @brief Create a communication between two hosts
216  *
217  * @param model The model which handle the communication
218  * @param src The source host
219  * @param dst The destination host
220  * @param size The amount of data (in bytes) needed to transfer
221  * @param rate [description]
222  * @return The action corresponding to the communication
223  */
224 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);
225
226 /**
227  * @brief Get the name of a surf resource (cpu, host, network, …)
228  *
229  * @param resource The surf resource
230  * @return The name of the surf resource
231  */
232 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
233
234 /** @brief Get the available speed of cpu associated to a host */
235 XBT_PUBLIC(double) surf_host_get_available_speed(sg_host_t host);
236
237 /** @brief Create a sleep action on the given host */
238 XBT_PUBLIC(surf_action_t) surf_host_sleep(sg_host_t host, double duration);
239
240 /** @brief Create a file opening action on the given host */
241 XBT_PUBLIC(surf_action_t) surf_host_open(sg_host_t host, const char* fullpath);
242
243 /** @brief Create a file closing action on the given host */
244 XBT_PUBLIC(surf_action_t) surf_host_close(sg_host_t host, surf_file_t fd);
245
246 /** @brief Create a file reading action on the given host */
247 XBT_PUBLIC(surf_action_t) surf_host_read(sg_host_t host, surf_file_t fd, sg_size_t size);
248
249 /** @brief Create a file writing action on the given host  */
250 XBT_PUBLIC(surf_action_t) surf_host_write(sg_host_t host, surf_file_t fd, sg_size_t size);
251
252 /**
253  * @brief Get the informations of a file descriptor
254  * @details The returned xbt_dynar_t contains:
255  *  - the size of the file,
256  *  - the mount point,
257  *  - the storage name,
258  *  - the storage typeId,
259  *  - the storage content type
260  *
261  * @param host The surf host
262  * @param fd The file descriptor
263  * @return An xbt_dynar_t with the file informations
264  */
265 XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(sg_host_t host, surf_file_t fd);
266
267 /**
268  * @brief Get the available space of the storage at the mount point
269  *
270  * @param resource The surf host
271  * @param name The mount point
272  * @return The amount of available space in bytes
273  */
274 XBT_PUBLIC(sg_size_t) surf_host_get_free_size(sg_host_t resource, const char* name);
275
276 /**
277  * @brief Get the used space of the storage at the mount point
278  *
279  * @param resource The surf host
280  * @param name The mount point
281  * @return The amount of used space in bytes
282  */
283 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(sg_host_t resource, const char* name);
284
285 /**
286  * @brief Destroy a VM
287  *
288  * @param resource The surf vm
289  */
290 XBT_PUBLIC(void) surf_vm_destroy(sg_host_t resource);
291
292 /** @brief Suspend a VM */
293 XBT_PUBLIC(void) surf_vm_suspend(sg_host_t resource);
294
295 /** @brief Resume a VM */
296 XBT_PUBLIC(void) surf_vm_resume(sg_host_t resource);
297
298 /**
299  * @brief Save the VM (Not yet implemented)
300  *
301  * @param resource The surf vm
302  */
303 XBT_PUBLIC(void) surf_vm_save(sg_host_t resource);
304
305 /**
306  * @brief Restore the VM (Not yet implemented)
307  *
308  * @param resource The surf vm
309  */
310 XBT_PUBLIC(void) surf_vm_restore(sg_host_t resource);
311
312 /**
313  * @brief Migrate the VM to the destination host
314  *
315  * @param resource The surf vm
316  * @param ind_vm_ws_dest The destination host
317  */
318 XBT_PUBLIC(void) surf_vm_migrate(sg_host_t resource, sg_host_t ind_vm_ws_dest);
319
320 /**
321  * @brief Get the physical machine hosting the VM
322  *
323  * @param resource The surf vm
324  * @return The physical machine hosting the VM
325  */
326 XBT_PUBLIC(sg_host_t) surf_vm_get_pm(sg_host_t resource);
327
328 /**
329  * @brief [brief description]
330  * @details [long description]
331  *
332  * @param resource [description]
333  * @param bound [description]
334  */
335 XBT_PUBLIC(void) surf_vm_set_bound(sg_host_t resource, double bound);
336
337 /**
338  * @brief [brief description]
339  * @details [long description]
340  *
341  * @param resource [description]
342  * @param cpu [description]
343  * @param mask [description]
344  */
345 XBT_PUBLIC(void) surf_vm_set_affinity(sg_host_t resource, sg_host_t cpu, unsigned long mask);
346
347 /**
348  * @brief Unlink a file descriptor
349  *
350  * @param host The surf host
351  * @param fd The file descriptor
352  *
353  * @return 0 if failed to unlink, 1 otherwise
354  */
355 XBT_PUBLIC(int) surf_host_unlink(sg_host_t host, surf_file_t fd);
356
357 /**
358  * @brief Get the size of a file on a host
359  *
360  * @param host The surf host
361  * @param fd The file descriptor
362  *
363  * @return The size in bytes of the file
364  */
365 XBT_PUBLIC(size_t) surf_host_get_size(sg_host_t host, surf_file_t fd);
366
367 /**
368  * @brief Get the current position of the file descriptor
369  *
370  * @param host The surf host
371  * @param fd The file descriptor
372  * @return The current position of the file descriptor
373  */
374 XBT_PUBLIC(size_t) surf_host_file_tell(sg_host_t host, surf_file_t fd);
375
376 /**
377  * @brief Move a file to another location on the *same mount point*.
378  * @details [long description]
379  *
380  * @param host The surf host
381  * @param fd The file descriptor
382  * @param fullpath The new full path
383  *
384  * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
385  */
386 XBT_PUBLIC(int) surf_host_file_move(sg_host_t host, surf_file_t fd, const char* fullpath);
387
388 /**
389  * @brief Set the position indictator assiociated with the file descriptor to a new position
390  * @details [long description]
391  *
392  * @param host The surf host
393  * @param fd The file descriptor
394  * @param offset The offset from the origin
395  * @param origin Position used as a reference for the offset
396  *  - SEEK_SET: beginning of the file
397  *  - SEEK_CUR: current position indicator
398  *  - SEEK_END: end of the file
399  * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
400  */
401 XBT_PUBLIC(int) surf_host_file_seek(sg_host_t host,
402                                            surf_file_t fd, sg_offset_t offset,
403                                            int origin);
404
405 /**
406  * @brief Get the content of a storage
407  *
408  * @param resource The surf storage
409  * @return A xbt_dict_t with path as keys and size in bytes as values
410  */
411 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
412
413 /**
414  * @brief Get the size in bytes of a storage
415  *
416  * @param resource The surf storage
417  * @return The size in bytes of the storage
418  */
419 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
420
421 /**
422  * @brief Get the available size in bytes of a storage
423  *
424  * @param resource The surf storage
425  * @return The available size in bytes of the storage
426  */
427 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
428
429 /**
430  * @brief Get the size in bytes of a storage
431  *
432  * @param resource The surf storage
433  * @return The used size in bytes of the storage
434  */
435 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
436
437 /** @brief return the properties set associated to that storage */
438 XBT_PUBLIC(xbt_dict_t) surf_storage_get_properties(surf_resource_t resource);
439
440 /**
441  * @brief [brief description]
442  * @details [long description]
443  *
444  * @param action The surf cpu action
445  * @param bound [description]
446  */
447 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
448
449 /**
450  * @brief [brief description]
451  * @details [long description]
452  *
453  * @param action The surf network action
454  */
455 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
456
457 /**
458  * @brief Get the file associated to a storage action
459  *
460  * @param action The surf storage action
461  * @return The file associated to a storage action
462  */
463 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
464
465 /**
466  * @brief Get the result dictionary of an ls action
467  *
468  * @param action The surf storage action
469  * @return The dictionry listing a path
470  */
471 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
472
473
474 /**
475  * @brief Get the host the storage is attached to
476  *
477  * @param resource The surf storage
478  * @return The host name
479  * may not exist.
480  */
481 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
482
483 /** @} */
484
485 /**************************************/
486 /* Implementations of model object */
487 /**************************************/
488
489 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
490 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
491
492 /** \ingroup SURF_models
493  *  \brief The CPU model object for the physical machine layer
494  */
495 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
496
497 /** \ingroup SURF_models
498  *  \brief The CPU model object for the virtual machine layer
499  */
500 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
501
502
503 /** \ingroup SURF_models
504  *  \brief Initializes the CPU model with the model Cas01
505  *
506  *  By default, this model uses the lazy optimization mechanism that relies on partial invalidation in LMM and a heap
507  *  for lazy action update.
508  *  You can change this behavior by setting the cpu/optim configuration variable to a different value.
509  *
510  *  You shouldn't have to call it by yourself.
511  */
512 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
513
514 /** \ingroup SURF_models
515  *  \brief Initializes the CPU model with trace integration [Deprecated]
516  *
517  *  You shouldn't have to call it by yourself.
518  */
519 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
520
521 /** \ingroup SURF_models
522  *  \brief The list of all available optimization modes (both for cpu and networks).
523  *  These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
524  */
525 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
526
527 /** \ingroup SURF_plugins
528  *  \brief The list of all available surf plugins
529  */
530 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
531
532 /** \ingroup SURF_models
533  *  \brief The list of all available cpu model models
534  */
535 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
536
537 /** \ingroup SURF_models
538  *  \brief The network model
539  *
540  *  When creating a new API on top on SURF, you shouldn't use the network model unless you know what you are doing.
541  *  Only the host model should be accessed because depending on the platform model, the network model can be NULL.
542  */
543 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
544
545 /** \ingroup SURF_models
546  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
547  *
548  * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud based on the model 'LV08' and
549  * different correction factors depending on the communication size (< 1KiB, < 64KiB, >= 64KiB).
550  * See comments in the code for more information.
551  *
552  *  \see surf_host_model_init_SMPI()
553  */
554 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
555
556 /** \ingroup SURF_models
557  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
558  *
559  * This model impelments a variant of the contention model on Infinband networks based on
560  * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
561  *
562  *  \see surf_host_model_init_IB()
563  */
564 XBT_PUBLIC(void) surf_network_model_init_IB(void);
565
566 /** \ingroup SURF_models
567  *  \brief Initializes the platform with the network model 'LegrandVelho'
568  *
569  * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for
570  * onelink and dogbone sharing scenarios. See comments in the code for more information.
571  *
572  *  \see surf_host_model_init_LegrandVelho()
573  */
574 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
575
576 /** \ingroup SURF_models
577  *  \brief Initializes the platform with the network model 'Constant'
578  *
579  *  In this model, the communication time between two network cards is constant, hence no need for a routing table.
580  *  This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This
581  *  function is called in conjunction with surf_host_model_init_compound.
582  *
583  *  \see surf_host_model_init_compound()
584  */
585 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
586
587 /** \ingroup SURF_models
588  *  \brief Initializes the platform with the network model CM02
589  *
590  *  You sould call this function by yourself only if you plan using surf_host_model_init_compound.
591  *  See comments in the code for more information.
592  */
593 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
594
595 #if HAVE_NS3
596 /** \ingroup SURF_models
597  *  \brief Initializes the platform with the network model NS3
598  *
599  *  This function is called by surf_host_model_init_NS3 or by yourself only if you plan using
600  *  surf_host_model_init_compound
601  *
602  *  \see surf_host_model_init_NS3()
603  */
604 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
605 #endif
606
607 /** \ingroup SURF_models
608  *  \brief Initializes the platform with the network model Reno
609  *
610  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
611  *
612  *  Reference:
613  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
614  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
615  *
616  *  Call this function only if you plan using surf_host_model_init_compound.
617  */
618 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
619
620 /** \ingroup SURF_models
621  *  \brief Initializes the platform with the network model Reno2
622  *
623  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
624  *
625  *  Reference:
626  *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
627  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
628  *
629  *  Call this function only if you plan using surf_host_model_init_compound.
630  */
631 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
632
633 /** \ingroup SURF_models
634  *  \brief Initializes the platform with the network model Vegas
635  *
636  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent  to the proportional fairness.
637  *
638  *  Reference:
639  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
640  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
641  *
642  *  Call this function only if you plan using surf_host_model_init_compound.
643  */
644 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
645
646 /** \ingroup SURF_models
647  *  \brief The list of all available network model models
648  */
649 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
650
651 /** \ingroup SURF_models
652  *  \brief The storage model
653  */
654 XBT_PUBLIC(void) surf_storage_model_init_default(void);
655
656 /** \ingroup SURF_models
657  *  \brief The list of all available storage modes.
658  *  This storage mode can be set using --cfg=storage/model:...
659  */
660 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
661
662 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
663
664 /** \ingroup SURF_models
665  *  \brief The host model
666  *
667  *  Note that when you create an API on top of SURF, the host model should be the only one you use
668  *  because depending on the platform model, the network model and the CPU model may not exist.
669  */
670 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
671
672 /** \ingroup SURF_models
673  *  \brief The vm model
674  *
675  *  Note that when you create an API on top of SURF,the vm model should be the only one you use
676  *  because depending on the platform model, the network model and the CPU model may not exist.
677  */
678 XBT_PUBLIC_DATA(surf_vm_model_t) surf_vm_model;
679
680 /** \ingroup SURF_models
681  *  \brief Initializes the platform with a compound host model
682  *
683  *  This function should be called after a cpu_model and a network_model have been set up.
684  */
685 XBT_PUBLIC(void) surf_host_model_init_compound(void);
686
687 /** \ingroup SURF_models
688  *  \brief Initializes the platform with the current best network and cpu models at hand
689  *
690  *  This platform model separates the host model and the network model.
691  *  The host model will be initialized with the model compound, the network model with the model LV08 (with cross
692  *  traffic support) and the CPU model with the model Cas01.
693  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
694  */
695 XBT_PUBLIC(void) surf_host_model_init_current_default(void);
696
697 /** \ingroup SURF_models
698  *  \brief Initializes the platform with the model L07
699  *
700  *  With this model, only parallel tasks can be used. Resource sharing is done by identifying bottlenecks and giving an
701  *  equal share of the model to each action.
702  */
703 XBT_PUBLIC(void) surf_host_model_init_ptask_L07(void);
704
705 /** \ingroup SURF_models
706  *  \brief The list of all available host model models
707  */
708 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_host_model_description[];
709
710 /** \ingroup SURF_models
711  *  \brief Initializes the platform with the current best network and cpu models at hand
712  *
713  *  This platform model seperates the host model and the network model.
714  *  The host model will be initialized with the model compound, the network model with the model LV08 (with cross
715  *  traffic support) and the CPU model with the model Cas01.
716  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
717  */
718 XBT_PUBLIC(void) surf_vm_model_init_HL13(void);
719
720 /** \ingroup SURF_models
721  *  \brief The list of all available vm model models
722  */
723 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_vm_model_description[];
724
725 /** \ingroup SURF_models
726  *  \brief List of initialized models
727  */
728 XBT_PUBLIC_DATA(xbt_dynar_t) all_existing_models;
729
730 /** \ingroup SURF_simulation
731  *  \brief List of hosts that have just restarted and whose autorestart process should be restarted.
732  */
733 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
734
735 /** \ingroup SURF_simulation
736  *  \brief List of hosts for which one want to be notified if they ever restart.
737  */
738 XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
739
740 /*** SURF Globals **************************/
741
742 /** \ingroup SURF_simulation
743  *  \brief Initialize SURF
744  *  \param argc argument number
745  *  \param argv arguments
746  *
747  *  This function has to be called to initialize the common structures. Then you will have to create the environment by
748  *  calling  e.g. surf_host_model_init_CM02()
749  *
750  *  \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
751  */
752 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
753
754 /** \ingroup SURF_simulation
755  *  \brief Finish simulation initialization
756  *
757  *  This function must be called before the first call to surf_solve()
758  */
759 XBT_PUBLIC(void) surf_presolve(void);
760
761 /** \ingroup SURF_simulation
762  *  \brief Performs a part of the simulation
763  *  \param max_date Maximum date to update the simulation to, or -1
764  *  \return the elapsed time, or -1.0 if no event could be executed
765  *
766  *  This function execute all possible events, update the action states  and returns the time elapsed.
767  *  When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
768  *  when you call surf_solve.
769  *  Note that the returned elapsed time can be zero.
770  */
771 XBT_PUBLIC(double) surf_solve(double max_date);
772
773 /** \ingroup SURF_simulation
774  *  \brief Return the current time
775  *
776  *  Return the current time in millisecond.
777  */
778 XBT_PUBLIC(double) surf_get_clock(void);
779
780 /** \ingroup SURF_simulation
781  *  \brief Exit SURF
782  *
783  *  Clean everything.
784  *
785  *  \see surf_init()
786  */
787 XBT_PUBLIC(void) surf_exit(void);
788
789 /* Prototypes of the functions that handle the properties */
790 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;// the prop set for the currently parsed element (also used in SIMIX)
791 /* The same for model_prop set*/
792 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
793
794 /* surf parse file related (public because called from a test suite) */
795 XBT_PUBLIC(void) parse_platform_file(const char *file);
796
797 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
798 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
799
800 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
801
802 /*
803  * Returns the initial path. On Windows the initial path is the current directory for the current process in the other
804  * case the function returns "./" that represents the current directory on Unix/Linux platforms.
805  */
806 const char *__surf_get_initial_path(void);
807
808 /********** Tracing **********/
809 /* from surf_instr.c */
810 void TRACE_surf_action(surf_action_t surf_action, const char *category);
811 void TRACE_surf_alloc(void);
812 void TRACE_surf_release(void);
813
814 /* instr_routing.c */
815 void instr_routing_define_callbacks (void);
816 void instr_new_variable_type (const char *new_typename, const char *color);
817 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color);
818 void instr_new_user_state_type (const char *father_type, const char *new_typename);
819 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
820 int instr_platform_traced (void);
821 xbt_graph_t instr_routing_platform_graph (void);
822 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
823
824 SG_END_DECL()
825 #endif                          /* _SURF_SURF_H */