Logo AND Algorithmique Numérique Distribuée

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