Logo AND Algorithmique Numérique Distribuée

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