Logo AND Algorithmique Numérique Distribuée

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