Logo AND Algorithmique Numérique Distribuée

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