Logo AND Algorithmique Numérique Distribuée

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