Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of git+ssh://scm.gforge.inria.fr//gitroot/simgrid/simgrid
[simgrid.git] / src / include / surf / surf.h
1 /* Copyright (c) 2004-2014. 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 "portable.h"
16 #include "xbt/config.h"
17 #include "surf/datatypes.h"
18 #include "xbt/lib.h"
19 #include "surf/surf_routing.h"
20 #include "simgrid/platf_interface.h"
21 #include "simgrid/datatypes.h"
22 #include "simgrid/plugins.h"
23
24 SG_BEGIN_DECL()
25 /* Actions and models are highly connected structures... */
26
27 /* user-visible parameters */
28 extern double sg_tcp_gamma;
29 extern double sg_sender_gap;
30 extern double sg_latency_factor;
31 extern double sg_bandwidth_factor;
32 extern double sg_weight_S_parameter;
33 extern int sg_network_crosstraffic;
34 #ifdef HAVE_GTNETS
35 extern double sg_gtnets_jitter;
36 extern int sg_gtnets_jitter_seed;
37 #endif
38 extern xbt_dynar_t surf_path;
39
40 typedef enum {
41   SURF_NETWORK_ELEMENT_NULL = 0,        /* NULL */
42   SURF_NETWORK_ELEMENT_HOST,    /* host type */
43   SURF_NETWORK_ELEMENT_ROUTER,  /* router type */
44   SURF_NETWORK_ELEMENT_AS       /* AS type */
45 } e_surf_network_element_type_t;
46
47 #ifdef __cplusplus
48 class Model;
49 class CpuModel;
50 class WorkstationModel;
51 class WorkstationVMModel;
52 class NetworkModel;
53 class StorageModel;
54 class Resource;
55 class ResourceLmm;
56 class WorkstationCLM03;
57 class NetworkCm02Link;
58 class Cpu;
59 class Action;
60 class ActionLmm;
61 class StorageActionLmm;
62 struct As;
63 struct RoutingEdge;
64 class RoutingPlatf;
65 #else
66 typedef struct Model Model;
67 typedef struct CpuModel CpuModel;
68 typedef struct WorkstationModel WorkstationModel;
69 typedef struct WorkstationVMModel WorkstationVMModel;
70 typedef struct NetworkModel NetworkModel;
71 typedef struct StorageModel StorageModel;
72 typedef struct Resource Resource;
73 typedef struct ResourceLmm ResourceLmm;
74 typedef struct WorkstationCLM03 WorkstationCLM03;
75 typedef struct NetworkCm02Link NetworkCm02Link;
76 typedef struct Cpu Cpu;
77 typedef struct Action Action;
78 typedef struct ActionLmm ActionLmm;
79 typedef struct StorageActionLmm StorageActionLmm;
80 typedef struct As As;
81 typedef struct RoutingEdge RoutingEdge;
82 typedef struct RoutingPlatf RoutingPlatf;
83 #endif
84
85 /** @ingroup SURF_c_bindings
86  *  \brief Model datatype
87  *
88  *  Generic data structure for a model. The workstations,
89  *  the CPUs and the network links are examples of models.
90  */
91 typedef Model *surf_model_t;
92 typedef CpuModel *surf_cpu_model_t;
93 typedef WorkstationModel *surf_workstation_model_t;
94 typedef WorkstationVMModel *surf_vm_workstation_model_t;
95
96 typedef NetworkModel *surf_network_model_t;
97 typedef StorageModel *surf_storage_model_t;
98
99 typedef xbt_dictelm_t surf_resource_t;
100 typedef Resource *surf_cpp_resource_t;
101 typedef WorkstationCLM03 *surf_workstation_CLM03_t;
102 typedef NetworkCm02Link *surf_network_link_t;
103 typedef Cpu *surf_cpu_t;
104
105 /** @ingroup SURF_c_bindings
106  *  \brief Action structure
107  *
108  *  Never create s_surf_action_t by yourself ! The actions are created
109  *  on the fly when you call execute or communicate on a model.
110  *
111  *  \see e_surf_action_state_t
112  */
113 typedef Action *surf_action_t;
114
115 typedef As *AS_t;
116 typedef RoutingEdge *routing_edge_t;
117 typedef RoutingPlatf *routing_platf_t;
118
119 typedef struct surf_file *surf_file_t;
120
121 XBT_PUBLIC(e_surf_network_element_type_t)
122   routing_get_network_element_type(const char* name);
123
124 /** @Brief Specify that we use that action */
125 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
126
127 /** @brief Creates a new action.
128  *
129  * @param size The size is the one of the subtype you want to create
130  * @param cost initial value
131  * @param model to which model we should attach this action
132  * @param failed whether we should start this action in failed mode
133  */
134 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
135                                    surf_model_t model, int failed);
136
137 /** \brief Resource model description
138  */
139 typedef struct surf_model_description {
140   const char *name;
141   const char *description;
142   void_f_void_t model_init_preparse;
143 } s_surf_model_description_t, *surf_model_description_t;
144
145 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
146                                        const char *name);
147 XBT_PUBLIC(void) model_help(const char *category,
148                             s_surf_model_description_t * table);
149
150 /** @ingroup SURF_interface
151  *  @brief Action states
152  *
153  *  Action states.
154  *
155  *  @see Action
156  */
157 typedef enum {
158   SURF_ACTION_READY = 0,        /**< Ready        */
159   SURF_ACTION_RUNNING,          /**< Running      */
160   SURF_ACTION_FAILED,           /**< Task Failure */
161   SURF_ACTION_DONE,             /**< Completed    */
162   SURF_ACTION_TO_FREE,          /**< Action to free in next cleanup */
163   SURF_ACTION_NOT_IN_THE_SYSTEM
164                                 /**< Not in the system anymore. Why did you ask ? */
165 } e_surf_action_state_t;
166
167 /** @ingroup SURF_vm_interface
168  *
169  *
170  */
171 /* FIXME: Where should the VM state be defined? */
172 typedef enum {
173   SURF_VM_STATE_CREATED, /**< created, but not yet started */
174   SURF_VM_STATE_RUNNING,
175   SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
176
177   SURF_VM_STATE_SAVING, /**< Save/restore involves disk I/O, so there should be transition states. */
178   SURF_VM_STATE_SAVED,
179   SURF_VM_STATE_RESTORING,
180 } e_surf_vm_state_t;
181
182 /***************************/
183 /* Generic model object */
184 /***************************/
185
186 //FIXME:REMOVE typedef struct s_routing_platf s_routing_platf_t, *routing_platf_t;
187 XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
188
189 static inline void *surf_cpu_resource_priv(const void *host) {
190   return xbt_lib_get_level((xbt_dictelm_t)host, SURF_CPU_LEVEL);
191 }
192 static inline void *surf_workstation_resource_priv(const void *host){
193   return (void*)xbt_lib_get_level((xbt_dictelm_t)host, SURF_WKS_LEVEL);
194 }
195 static inline void *surf_storage_resource_priv(const void *storage){
196   return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
197 }
198
199 static inline void *surf_cpu_resource_by_name(const char *name) {
200   return xbt_lib_get_elm_or_null(host_lib, name);
201 }
202 static inline void *surf_workstation_resource_by_name(const char *name){
203   return xbt_lib_get_elm_or_null(host_lib, name);
204 }
205 static inline void *surf_storage_resource_by_name(const char *name){
206   return xbt_lib_get_elm_or_null(storage_lib, name);
207 }
208
209
210 XBT_PUBLIC(char *) surf_routing_edge_name(sg_routing_edge_t edge);
211 XBT_PUBLIC(void *) surf_as_cluster_get_backbone(AS_t as);
212 XBT_PUBLIC(void) surf_as_cluster_set_backbone(AS_t as, void* backbone);
213
214 /** @{ @ingroup SURF_c_bindings */
215
216 /**
217  * @brief Get the name of a surf model
218  *
219  * @param model A model
220  * @return The name of the model
221  */
222 XBT_PUBLIC(const char *) surf_model_name(surf_model_t model);
223
224 /**
225  * @brief Pop an action from the done actions set
226  *
227  * @param model The model from which the action is extracted
228  * @return An action in done state
229  */
230 XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
231
232 /**
233  * @brief Pop an action from the failed actions set
234  *
235  * @param model The model from which the action is extracted
236  * @return An action in failed state
237  */
238 XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
239
240 /**
241  * @brief Pop an action from the ready actions set
242  *
243  * @param model The model from which the action is extracted
244  * @return An action in ready state
245  */
246 XBT_PUBLIC(surf_action_t) surf_model_extract_ready_action_set(surf_model_t model);
247
248 /**
249  * @brief Pop an action from the running actions set
250  *
251  * @param model The model from which the action is extracted
252  * @return An action in running state
253  */
254 XBT_PUBLIC(surf_action_t) surf_model_extract_running_action_set(surf_model_t model);
255
256 /**
257  * @brief Get the size of the running action set of a model
258  *
259  * @param model The model
260  * @return The size of the running action set
261  */
262 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
263
264 /**
265  * @brief Execute a parallel task
266  * @details [long description]
267  *
268  * @param model The model which handle the parallelisation
269  * @param workstation_nb The number of workstations
270  * @param workstation_list The list of workstations on which the task is executed
271  * @param computation_amount The processing amount (in flop) needed to process
272  * @param communication_amount The amount of data (in bytes) needed to transfer
273  * @param rate [description]
274  * @return The action corresponding to the parallele execution task
275  */
276 XBT_PUBLIC(surf_action_t) surf_workstation_model_execute_parallel_task(surf_workstation_model_t model,
277                                                     int workstation_nb,
278                                             void **workstation_list,
279                                             double *computation_amount,
280                                             double *communication_amount,
281                                             double rate);
282
283 /**
284  * @brief Create a communication between two hosts
285  *
286  * @param model The model which handle the communication
287  * @param src The source host
288  * @param dst The destination host
289  * @param size The amount of data (in bytes) needed to transfer
290  * @param rate [description]
291  * @return The action corresponding to the communication
292  */
293 XBT_PUBLIC(surf_action_t) surf_workstation_model_communicate(surf_workstation_model_t model, surf_resource_t src, surf_resource_t dst, double size, double rate);
294
295 /**
296  * @brief Get the route between two hosts
297  * @details [long description]
298  *
299  * @param model The model which handle the routes
300  * @param src The source host
301  * @param dst The destination host
302  * @return The list of [TODO] from the source to the host
303  */
304 XBT_PUBLIC(xbt_dynar_t) surf_workstation_model_get_route(surf_workstation_model_t model, surf_resource_t src, surf_resource_t dst);
305
306 /**
307  * @brief Create a new VM on the specified host
308  *
309  * @param name The name of the workstation
310  * @param ind_phys_host The host on which the VM is created
311  */
312 XBT_PUBLIC(void) surf_vm_workstation_model_create(const char *name, surf_resource_t ind_phys_host);
313
314 /**
315  * @brief Create a communication between two routing edges [TODO]
316  * @details [long description]
317  *
318  * @param model The model which handle the communication
319  * @param src The source host
320  * @param dst The destination host
321  * @param size The amount of data (in bytes) needed to transfer
322  * @param rate [description]
323  * @return The action corresponding to the communication
324  */
325 XBT_PUBLIC(surf_action_t) surf_network_model_communicate(surf_network_model_t model, sg_routing_edge_t src, sg_routing_edge_t dst, double size, double rate);
326
327 /**
328  * @brief Get the name of a surf resource (cpu, workstation, network, â€¦)
329  *
330  * @param resource The surf resource
331  * @return The name of the surf resource
332  */
333 XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
334
335 /**
336  * @brief Get the properties of a surf resource (cpu, workstation, network, â€¦)
337  *
338  * @param resource The surf resource
339  * @return The properties of the surf resource
340  */
341 XBT_PUBLIC(xbt_dict_t) surf_resource_get_properties(surf_cpp_resource_t resource);
342
343 /**
344  * @brief Get the state of a surf resource (cpu, workstation, network, â€¦)
345  *
346  * @param resource The surf resource
347  * @return The state of the surf resource
348  */
349 XBT_PUBLIC(e_surf_resource_state_t) surf_resource_get_state(surf_cpp_resource_t resource);
350
351 /**
352  * @brief Set the state of a surf resource (cpu, workstation, network, â€¦)
353  *
354  * @param resource The surf resource
355  * @param state The new state of the surf resource
356  */
357 XBT_PUBLIC(void) surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state);
358
359 /**
360  * @brief Get the speed of the cpu associtated to a workstation
361  *
362  * @param resource The surf workstation
363  * @param load [description]
364  *
365  * @return [description]
366  */
367 XBT_PUBLIC(double) surf_workstation_get_speed(surf_resource_t resource, double load);
368
369 /**
370  * @brief Get the available speed of cpu associtated to a workstation
371  *
372  * @param resource The surf workstation
373  * @return [description]
374  */
375 XBT_PUBLIC(double) surf_workstation_get_available_speed(surf_resource_t resource);
376
377 /**
378  * @brief Get the number of cores of the cpu associated to a workstation
379  *
380  * @param resource The surf workstation
381  * @return The number of cores
382  */
383 XBT_PUBLIC(int) surf_workstation_get_core(surf_resource_t resource);
384
385 /**
386  * @brief Execute some quantity of computation
387  *
388  * @param resource The surf workstation
389  * @param size The value of the processing amount (in flop) needed to process
390  *
391  * @return The surf action corresponding to the processing
392  */
393 XBT_PUBLIC(surf_action_t) surf_workstation_execute(surf_resource_t resource, double size);
394
395 /**
396  * @brief Make the workstation sleep
397  *
398  * @param resource The surf workstation
399  * @param duration The number of seconds to sleep
400  * @return The surf action corresponding to the sleep
401  */
402 XBT_PUBLIC(surf_action_t) surf_workstation_sleep(surf_resource_t resource, double duration);
403
404 /**
405  * @brief Open a file on a workstation
406  *
407  * @param workstation The surf workstation
408  * @param fullpath The path to the file
409  * @return The surf action corresponding to the openning
410  */
411 XBT_PUBLIC(surf_action_t) surf_workstation_open(surf_resource_t workstation, const char* fullpath);
412
413 /**
414  * @brief Close a file descriptor on a workstation
415  *
416  * @param workstation The surf workstation
417  * @param fd The file descriptor
418  *
419  * @return The surf action corresponding to the closing
420  */
421 XBT_PUBLIC(surf_action_t) surf_workstation_close(surf_resource_t workstation, surf_file_t fd);
422
423 /**
424  * @brief Read a file
425  *
426  * @param resource The surf workstation
427  * @param fd The file descriptor to read
428  * @param size The size in bytes to read
429  * @return The surf action corresponding to the reading
430  */
431 XBT_PUBLIC(surf_action_t) surf_workstation_read(surf_resource_t resource, surf_file_t fd, sg_size_t size);
432
433 /**
434  * @brief Write a file
435  *
436  * @param resource The surf workstation
437  * @param fd The file descriptor to write
438  * @param size The size in bytes to write
439  * @return The surf action corresponding to the writing
440  */
441 XBT_PUBLIC(surf_action_t) surf_workstation_write(surf_resource_t resource, surf_file_t fd, sg_size_t size);
442
443 /**
444  * @brief Get the informations of a file descriptor
445  * @details The returned xbt_dynar_t contains:
446  *  - the size of the file,
447  *  - the mount point,
448  *  - the storage name,
449  *  - the storage typeId,
450  *  - the storage content type
451  *
452  * @param resource The surf workstation
453  * @param fd The file descriptor
454  * @return An xbt_dynar_t with the file informations
455  */
456 XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_info(surf_resource_t resource, surf_file_t fd);
457
458 /**
459  * @brief Get the available space of the storage at the mount point
460  *
461  * @param resource The surf workstation
462  * @param name The mount point
463  * @return The amount of availble space in bytes
464  */
465 XBT_PUBLIC(sg_size_t) surf_workstation_get_free_size(surf_resource_t resource, const char* name);
466
467 /**
468  * @brief Get the used space of the storage at the mount point
469  *
470  * @param resource The surf workstation
471  * @param name The mount point
472  * @return The amount of used space in bytes
473  */
474 XBT_PUBLIC(sg_size_t) surf_workstation_get_used_size(surf_resource_t resource, const char* name);
475
476 /**
477  * @brief Get the VMs hosted on the workstation
478  *
479  * @param resource The surf workstation
480  * @return The list of VMs on the workstation
481  */
482 XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_vms(surf_resource_t resource);
483
484 /**
485  * @brief [brief description]
486  * @details [long description]
487  *
488  * @param resource [description]
489  * @param params [description]
490  */
491 XBT_PUBLIC(void) surf_workstation_get_params(surf_resource_t resource, ws_params_t params);
492
493 /**
494  * @brief [brief description]
495  * @details [long description]
496  *
497  * @param resource [description]
498  * @param params [description]
499  */
500 XBT_PUBLIC(void) surf_workstation_set_params(surf_resource_t resource, ws_params_t params);
501
502 /**
503  * @brief Destroy a Workstation VM
504  *
505  * @param resource The surf workstation vm
506  */
507 XBT_PUBLIC(void) surf_vm_workstation_destroy(surf_resource_t resource);
508
509 /**
510  * @brief Suspend a Workstation VM
511  *
512  * @param resource The surf workstation vm
513  */
514 XBT_PUBLIC(void) surf_vm_workstation_suspend(surf_resource_t resource);
515
516 /**
517  * @brief Resume a Workstation VM
518  *
519  * @param resource The surf workstation vm
520  */
521 XBT_PUBLIC(void) surf_vm_workstation_resume(surf_resource_t resource);
522
523 /**
524  * @brief Save the Workstation VM (Not yet implemented)
525  *
526  * @param resource The surf workstation vm
527  */
528 XBT_PUBLIC(void) surf_vm_workstation_save(surf_resource_t resource);
529
530 /**
531  * @brief Restore the Workstation VM (Not yet implemented)
532  *
533  * @param resource The surf workstation vm
534  */
535 XBT_PUBLIC(void) surf_vm_workstation_restore(surf_resource_t resource);
536
537 /**
538  * @brief Migrate the VM to the destination host
539  *
540  * @param resource The surf workstation vm
541  * @param ind_vm_ws_dest The destination host
542  */
543 XBT_PUBLIC(void) surf_vm_workstation_migrate(surf_resource_t resource, surf_resource_t ind_vm_ws_dest);
544
545 /**
546  * @brief Get the physical machine hosting the VM
547  *
548  * @param resource The surf workstation vm
549  * @return The physical machine hosting the VM
550  */
551 XBT_PUBLIC(surf_resource_t) surf_vm_workstation_get_pm(surf_resource_t resource);
552
553 /**
554  * @brief [brief description]
555  * @details [long description]
556  *
557  * @param resource [description]
558  * @param bound [description]
559  */
560 XBT_PUBLIC(void) surf_vm_workstation_set_bound(surf_resource_t resource, double bound);
561
562 /**
563  * @brief [brief description]
564  * @details [long description]
565  *
566  * @param resource [description]
567  * @param cpu [description]
568  * @param mask [description]
569  */
570 XBT_PUBLIC(void) surf_vm_workstation_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask);
571
572 /**
573  * @brief Execute some quantity of computation
574  *
575  * @param cpu The surf cpu
576  * @param size The value of the processing amount (in flop) needed to process
577  * @return The surf action corresponding to the processing
578  */
579 XBT_PUBLIC(surf_action_t) surf_cpu_execute(surf_resource_t cpu, double size);
580
581 /**
582  * @brief Make the cpu sleep for duration (in seconds)
583  * @details [long description]
584  *
585  * @param cpu The surf cpu
586  * @param duration The number of seconds to sleep
587  * @return The surf action corresponding to the sleeping
588  */
589 XBT_PUBLIC(surf_action_t) surf_cpu_sleep(surf_resource_t cpu, double duration);
590
591 /**
592  * @brief Get the workstation power peak
593  * @details [long description]
594  *
595  * @param host The surf workstation
596  * @return The power peak
597  */
598 XBT_PUBLIC(double) surf_workstation_get_current_power_peak(surf_resource_t host);
599
600 /**
601  * @brief [brief description]
602  * @details [long description]
603  *
604  * @param host [description]
605  * @param pstate_index [description]
606  *
607  * @return [description]
608  */
609 XBT_PUBLIC(double) surf_workstation_get_power_peak_at(surf_resource_t host, int pstate_index);
610
611 /**
612  * @brief [brief description]
613  * @details [long description]
614  *
615  * @param host [description]
616  * @return [description]
617  */
618 XBT_PUBLIC(int) surf_workstation_get_nb_pstates(surf_resource_t host);
619
620 /**
621  * @brief [brief description]
622  * @details [long description]
623  *
624  * @param host [description]
625  * @param pstate_index [description]
626  */
627 XBT_PUBLIC(void) surf_workstation_set_power_peak_at(surf_resource_t host, int pstate_index);
628
629 /**
630  * @brief Get the consumed energy (in joules) of a workstation
631  *
632  * @param host The surf workstation
633  * @return The consumed energy
634  */
635 XBT_PUBLIC(double) surf_workstation_get_consumed_energy(surf_resource_t host);
636
637 /**
638  * @brief Get the list of storages mounted on a workstation
639  *
640  * @param workstation The surf workstation
641  * @return Dictionary of mount point, Storage
642  */
643 XBT_PUBLIC(xbt_dict_t) surf_workstation_get_mounted_storage_list(surf_resource_t workstation);
644
645 /**
646  * @brief Get the list of storages attached to a workstation
647  *
648  * @param workstation The surf workstation
649  * @return Dictionary of storage
650  */
651 XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_attached_storage_list(surf_resource_t workstation);
652
653 /**
654  * @brief Unlink a file descriptor
655  *
656  * @param workstation The surf workstation
657  * @param fd The file descriptor
658  *
659  * @return 0 if failed to unlink, 1 otherwise
660  */
661 XBT_PUBLIC(int) surf_workstation_unlink(surf_resource_t workstation, surf_file_t fd);
662
663 /**
664  * @brief Get the size of a file on a workstation
665  *
666  * @param workstation The surf workstation
667  * @param fd The file descriptor
668  *
669  * @return The size in bytes of the file
670  */
671 XBT_PUBLIC(size_t) surf_workstation_get_size(surf_resource_t workstation, surf_file_t fd);
672
673 /**
674  * @brief Get the current position of the file descriptor
675  *
676  * @param workstation The surf workstation
677  * @param fd The file descriptor
678  * @return The current position of the file descriptor
679  */
680 XBT_PUBLIC(size_t) surf_workstation_file_tell(surf_resource_t workstation, surf_file_t fd);
681
682 /**
683  * @brief Move a file to another location on the *same mount point*.
684  * @details [long description]
685  *
686  * @param workstation The surf workstation
687  * @param fd The file descriptor
688  * @param fullpath The new full path
689  *
690  * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
691  */
692 XBT_PUBLIC(int) surf_workstation_file_move(surf_resource_t workstation, surf_file_t fd, const char* fullpath);
693
694 /**
695  * @brief Set the position indictator assiociated with the file descriptor to a new position
696  * @details [long description]
697  *
698  * @param workstation The surf workstation
699  * @param fd The file descriptor
700  * @param offset The offset from the origin
701  * @param origin Position used as a reference for the offset
702  *  - SEEK_SET: beginning of the file
703  *  - SEEK_CUR: current position indicator
704  *  - SEEK_END: end of the file
705  * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
706  */
707 XBT_PUBLIC(int) surf_workstation_file_seek(surf_resource_t workstation,
708                                            surf_file_t fd, sg_offset_t offset,
709                                            int origin);
710
711 /**
712  * @brief [brief description]
713  * @details [long description]
714  *
715  * @param link [description]
716  * @return [description]
717  */
718 XBT_PUBLIC(int) surf_network_link_is_shared(surf_cpp_resource_t link);
719
720 /**
721  * @brief Get the bandwidth of a link in bytes per second
722  *
723  * @param link The surf link
724  * @return The bandwidth in bytes per second
725  */
726 XBT_PUBLIC(double) surf_network_link_get_bandwidth(surf_cpp_resource_t link);
727
728 /**
729  * @brief Get the latency of a link in seconds
730  *
731  * @param link The surf link
732  * @return The latency in seconds
733  */
734 XBT_PUBLIC(double) surf_network_link_get_latency(surf_cpp_resource_t link);
735
736 /**
737  * @brief Get the content of a storage
738  *
739  * @param resource The surf storage
740  * @return A xbt_dict_t with path as keys and size in bytes as values
741  */
742 XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
743
744 /**
745  * @brief Get the size in bytes of a storage
746  *
747  * @param resource The surf storage
748  * @return The size in bytes of the storage
749  */
750 XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
751
752 /**
753  * @brief Get the available size in bytes of a storage
754  *
755  * @param resource The surf storage
756  * @return The available size in bytes of the storage
757  */
758 XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
759
760 /**
761  * @brief Get the size in bytes of a storage
762  *
763  * @param resource The surf storage
764  * @return The used size in bytes of the storage
765  */
766 XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
767
768
769 /**
770  * @brief Get the data associated to the action
771  *
772  * @param action The surf action
773  * @return The data associated to the action
774  */
775 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
776
777 /**
778  * @brief Set the data associated to the action
779  * @details [long description]
780  *
781  * @param action The surf action
782  * @param data The new data associated to the action
783  */
784 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
785
786 /**
787  * @brief Unreference an action
788  *
789  * @param action The surf action
790  */
791 XBT_PUBLIC(void) surf_action_unref(surf_action_t action);
792
793 /**
794  * @brief Get the start time of an action
795  *
796  * @param action The surf action
797  * @return The start time in seconds from the beginning of the simulation
798  */
799 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
800
801 /**
802  * @brief Get the finish time of an action
803  *
804  * @param action The surf action
805  * @return The finish time in seconds from the beginning of the simulation
806  */
807 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
808
809 /**
810  * @brief Get the remains amount of work to do of an action
811  *
812  * @param action The surf action
813  * @return  The remains amount of work to do
814  */
815 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
816
817 /**
818  * @brief Suspend an action
819  *
820  * @param action The surf action
821  */
822 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
823
824 /**
825  * @brief Resume an action
826  *
827  * @param action The surf action
828  */
829 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
830
831 /**
832  * @brief Cancel an action
833  *
834  * @param action The surf action
835  */
836 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
837
838 /**
839  * @brief Set the priority of an action
840  * @details [long description]
841  *
842  * @param action The surf action
843  * @param priority The new priority [TODO]
844  */
845 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
846
847 /**
848  * @brief Set the category of an action
849  * @details [long description]
850  *
851  * @param action The surf action
852  * @param category The new category of the action
853  */
854 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
855
856 /**
857  * @brief Get the state of an action
858  *
859  * @param action The surf action
860  * @return The state of the action
861  */
862 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
863
864 /**
865  * @brief Get the cost of an action
866  *
867  * @param action The surf action
868  * @return The cost of the action
869  */
870 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
871
872 /**
873  * @brief [brief desrciption]
874  * @details [long description]
875  *
876  * @param action The surf cpu action
877  * @param cpu [description]
878  * @param mask [description]
879  */
880 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask);
881
882 /**
883  * @brief [brief description]
884  * @details [long description]
885  *
886  * @param action The surf cpu action
887  * @param bound [description]
888  */
889 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
890
891 /**
892  * @brief [brief description]
893  * @details [long description]
894  *
895  * @param action The surf network action
896  */
897 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
898
899 /**
900  * @brief Get the file associated to a storage action
901  *
902  * @param action The surf storage action
903  * @return The file associated to a storage action
904  */
905 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
906
907 /**
908  * @brief Get the result dictionary of an ls action
909  *
910  * @param action The surf storage action
911  * @return The dictionry listing a path
912  */
913 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
914
915
916 /**
917  * @brief Get the host the storage is attached to
918  *
919  * @param resource The surf storage
920  * @return The host name
921  */
922 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
923
924 XBT_PUBLIC(surf_model_t) surf_resource_model(const void *host, int level);
925
926 /** @} */
927
928 /**************************************/
929 /* Implementations of model object */
930 /**************************************/
931
932 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
933 XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
934
935 /** \ingroup SURF_models
936  *  \brief The CPU model object for the physical machine layer
937  */
938 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
939
940 /** \ingroup SURF_models
941  *  \brief The CPU model object for the virtual machine layer
942  */
943 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
944
945
946 /** \ingroup SURF_models
947  *  \brief Initializes the CPU model with the model Cas01
948  *
949  *  By default, this model uses the lazy optimization mechanism that
950  *  relies on partial invalidation in LMM and a heap for lazy action update.
951  *  You can change this behavior by setting the cpu/optim configuration
952  *  variable to a different value.
953  *
954  *  You shouldn't have to call it by yourself.
955  */
956 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
957
958 /** \ingroup SURF_models
959  *  \brief Initializes the CPU model with trace integration [Deprecated]
960  *
961  *  You shouldn't have to call it by yourself.
962  */
963 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
964
965 /** \ingroup SURF_models
966  *  \brief The list of all available optimization modes (both for cpu and networks).
967  *  These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
968  */
969 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
970
971 /** \ingroup SURF_plugins
972  *  \brief The list of all available surf plugins
973  */
974 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
975
976 /** \ingroup SURF_models
977  *  \brief The list of all available cpu model models
978  */
979 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
980
981 /**\brief create new host bypass the parser
982  *
983  */
984
985
986 /** \ingroup SURF_models
987  *  \brief The network model
988  *
989  *  When creating a new API on top on SURF, you shouldn't use the
990  *  network model unless you know what you are doing. Only the workstation
991  *  model should be accessed because depending on the platform model,
992  *  the network model can be NULL.
993  */
994 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
995
996 /** \ingroup SURF_models
997  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
998  *
999  * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
1000  * based on the model 'LV08' and different correction factors depending on the communication
1001  * size (< 1KiB, < 64KiB, >= 64KiB).
1002  * See comments in the code for more information.
1003  *
1004  *  \see surf_workstation_model_init_SMPI()
1005  */
1006 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
1007
1008 /** \ingroup SURF_models
1009  *  \brief Initializes the platform with the network model 'LegrandVelho'
1010  *
1011  * This model is proposed by Arnaud Legrand and Pedro Velho based on
1012  * the results obtained with the GTNets simulator for onelink and
1013  * dogbone sharing scenarios. See comments in the code for more information.
1014  *
1015  *  \see surf_workstation_model_init_LegrandVelho()
1016  */
1017 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
1018
1019 /** \ingroup SURF_models
1020  *  \brief Initializes the platform with the network model 'Constant'
1021  *
1022  *  In this model, the communication time between two network cards is
1023  *  constant, hence no need for a routing table. This is particularly
1024  *  usefull when simulating huge distributed algorithms where
1025  *  scalability is really an issue. This function is called in
1026  *  conjunction with surf_workstation_model_init_compound.
1027  *
1028  *  \see surf_workstation_model_init_compound()
1029  */
1030 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
1031
1032 /** \ingroup SURF_models
1033  *  \brief Initializes the platform with the network model CM02
1034  *
1035  *  You sould call this function by yourself only if you plan using
1036  *  surf_workstation_model_init_compound.
1037  *  See comments in the code for more information.
1038  */
1039 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
1040
1041 #ifdef HAVE_GTNETS
1042 /** \ingroup SURF_models
1043  *  \brief Initializes the platform with the network model GTNETS
1044  *  \param filename XML platform file name
1045  *
1046  *  This function is called by surf_workstation_model_init_GTNETS
1047  *  or by yourself only if you plan using surf_workstation_model_init_compound
1048  *
1049  *  \see surf_workstation_model_init_GTNETS()
1050  */
1051 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
1052 #endif
1053
1054 #ifdef HAVE_NS3
1055 /** \ingroup SURF_models
1056  *  \brief Initializes the platform with the network model NS3
1057  *  \param filename XML platform file name
1058  *
1059  *  This function is called by surf_workstation_model_init_NS3
1060  *  or by yourself only if you plan using surf_workstation_model_init_compound
1061  *
1062  *  \see surf_workstation_model_init_NS3()
1063  */
1064 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
1065 #endif
1066
1067 /** \ingroup SURF_models
1068  *  \brief Initializes the platform with the network model Reno
1069  *  \param filename XML platform file name
1070  *
1071  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
1072  *
1073  *  Reference:
1074  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1075  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1076  *
1077  *  Call this function only if you plan using surf_workstation_model_init_compound.
1078  *
1079  */
1080 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
1081
1082 /** \ingroup SURF_models
1083  *  \brief Initializes the platform with the network model Reno2
1084  *  \param filename XML platform file name
1085  *
1086  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
1087  *
1088  *  Reference:
1089  *  [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
1090  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1091  *
1092  *  Call this function only if you plan using surf_workstation_model_init_compound.
1093  *
1094  */
1095 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
1096
1097 /** \ingroup SURF_models
1098  *  \brief Initializes the platform with the network model Vegas
1099  *  \param filename XML platform file name
1100  *
1101  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
1102  *  to the proportional fairness.
1103  *
1104  *  Reference:
1105  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1106  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1107  *
1108  *  Call this function only if you plan using surf_workstation_model_init_compound.
1109  *
1110  */
1111 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
1112
1113 /** \ingroup SURF_models
1114  *  \brief The list of all available network model models
1115  */
1116 XBT_PUBLIC_DATA(s_surf_model_description_t)
1117     surf_network_model_description[];
1118
1119 /** \ingroup SURF_models
1120  *  \brief The storage model
1121  */
1122 XBT_PUBLIC(void) surf_storage_model_init_default(void);
1123
1124 /** \ingroup SURF_models
1125  *  \brief The list of all available storage modes.
1126  *  This storage mode can be set using --cfg=storage/model:...
1127  */
1128 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
1129
1130 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
1131
1132 /** \ingroup SURF_models
1133  *  \brief The workstation model
1134  *
1135  *  Note that when you create an API on top of SURF,
1136  *  the workstation model should be the only one you use
1137  *  because depending on the platform model, the network model and the CPU model
1138  *  may not exist.
1139  */
1140 XBT_PUBLIC_DATA(surf_workstation_model_t) surf_workstation_model;
1141
1142 /** \ingroup SURF_models
1143  *  \brief The vm_workstation model
1144  *
1145  *  Note that when you create an API on top of SURF,
1146  *  the vm_workstation model should be the only one you use
1147  *  because depending on the platform model, the network model and the CPU model
1148  *  may not exist.
1149  */
1150 XBT_PUBLIC_DATA(surf_vm_workstation_model_t) surf_vm_workstation_model;
1151
1152 /** \ingroup SURF_models
1153  *  \brief Initializes the platform with a compound workstation model
1154  *
1155  *  This function should be called after a cpu_model and a
1156  *  network_model have been set up.
1157  *
1158  */
1159 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
1160
1161 /** \ingroup SURF_models
1162  *  \brief Initializes the platform with the current best network and cpu models at hand
1163  *
1164  *  This platform model seperates the workstation model and the network model.
1165  *  The workstation model will be initialized with the model compound, the network
1166  *  model with the model LV08 (with cross traffic support) and the CPU model with
1167  *  the model Cas01.
1168  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
1169  *
1170  */
1171 XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
1172
1173 /** \ingroup SURF_models
1174  *  \brief Initializes the platform with the model KCCFLN05
1175  *
1176  *  With this model, only parallel tasks can be used. Resource sharing
1177  *  is done by identifying bottlenecks and giving an equal share of
1178  *  the model to each action.
1179  *
1180  */
1181 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
1182
1183 /** \ingroup SURF_models
1184  *  \brief The list of all available workstation model models
1185  */
1186 XBT_PUBLIC_DATA(s_surf_model_description_t)
1187     surf_workstation_model_description[];
1188
1189 /** \ingroup SURF_models
1190  *  \brief Initializes the platform with the current best network and cpu models at hand
1191  *
1192  *  This platform model seperates the workstation model and the network model.
1193  *  The workstation model will be initialized with the model compound, the network
1194  *  model with the model LV08 (with cross traffic support) and the CPU model with
1195  *  the model Cas01.
1196  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
1197  *
1198  */
1199 XBT_PUBLIC(void) surf_vm_workstation_model_init_HL13(void);
1200
1201 /** \ingroup SURF_models
1202  *  \brief The list of all available vm workstation model models
1203  */
1204 XBT_PUBLIC_DATA(s_surf_model_description_t)
1205     surf_vm_workstation_model_description[];
1206
1207 /*******************************************/
1208
1209 /** \ingroup SURF_models
1210  *  \brief List of initialized models
1211  */
1212 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
1213 XBT_PUBLIC_DATA(xbt_dynar_t) model_list_invoke;
1214
1215 /** \ingroup SURF_simulation
1216  *  \brief List of hosts that have juste restarted and whose autorestart process should be restarted.
1217  */
1218 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
1219
1220 /** \ingroup SURF_simulation
1221  *  \brief List of hosts for which one want to be notified if they ever restart.
1222  */
1223 XBT_PUBLIC(xbt_dict_t) watched_hosts_lib;
1224
1225 /*******************************************/
1226 /*** SURF Platform *************************/
1227 /*******************************************/
1228 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
1229 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
1230 XBT_PUBLIC_DATA(AS_t) surf_AS_get_by_name(const char * name);
1231 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
1232 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
1233 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
1234 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
1235 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
1236 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
1237
1238 /*******************************************/
1239 /*** SURF Globals **************************/
1240 /*******************************************/
1241
1242 /** \ingroup SURF_simulation
1243  *  \brief Initialize SURF
1244  *  \param argc argument number
1245  *  \param argv arguments
1246  *
1247  *  This function has to be called to initialize the common
1248  *  structures.  Then you will have to create the environment by
1249  *  calling
1250  *  e.g. surf_workstation_model_init_CM02()
1251  *
1252  *  \see surf_workstation_model_init_CM02(), surf_workstation_model_init_compound(), surf_exit()
1253  */
1254 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
1255
1256 /** \ingroup SURF_simulation
1257  *  \brief Finish simulation initialization
1258  *
1259  *  This function must be called before the first call to surf_solve()
1260  */
1261 XBT_PUBLIC(void) surf_presolve(void);
1262
1263 /** \ingroup SURF_simulation
1264  *  \brief Performs a part of the simulation
1265  *  \param max_date Maximum date to update the simulation to, or -1
1266  *  \return the elapsed time, or -1.0 if no event could be executed
1267  *
1268  *  This function execute all possible events, update the action states
1269  *  and returns the time elapsed.
1270  *  When you call execute or communicate on a model, the corresponding actions
1271  *  are not executed immediately but only when you call surf_solve.
1272  *  Note that the returned elapsed time can be zero.
1273  */
1274 XBT_PUBLIC(double) surf_solve(double max_date);
1275
1276 /** \ingroup SURF_simulation
1277  *  \brief Return the current time
1278  *
1279  *  Return the current time in millisecond.
1280  */
1281 XBT_PUBLIC(double) surf_get_clock(void);
1282
1283 /** \ingroup SURF_simulation
1284  *  \brief Exit SURF
1285  *
1286  *  Clean everything.
1287  *
1288  *  \see surf_init()
1289  */
1290 XBT_PUBLIC(void) surf_exit(void);
1291
1292 /* Prototypes of the functions that handle the properties */
1293 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;       /* the prop set for the currently parsed element (also used in SIMIX) */
1294
1295 /* The same for model_prop set*/
1296 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
1297
1298 /* surf parse file related (public because called from a test suite) */
1299 XBT_PUBLIC(void) parse_platform_file(const char *file);
1300
1301 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
1302 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
1303 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
1304 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
1305 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
1306 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
1307 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
1308
1309
1310 XBT_PUBLIC(double) get_cpu_power(const char *power);
1311
1312 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
1313
1314 int surf_get_nthreads(void);
1315 void surf_set_nthreads(int nthreads);
1316
1317 /*
1318  * Returns the initial path. On Windows the initial path is
1319  * the current directory for the current process in the other
1320  * case the function returns "./" that represents the current
1321  * directory on Unix/Linux platforms.
1322  */
1323 const char *__surf_get_initial_path(void);
1324
1325 /********** Tracing **********/
1326 /* from surf_instr.c */
1327 void TRACE_surf_action(surf_action_t surf_action, const char *category);
1328 void TRACE_surf_alloc(void);
1329 void TRACE_surf_release(void);
1330
1331 /* instr_routing.c */
1332 void instr_routing_define_callbacks (void);
1333 void instr_new_variable_type (const char *new_typename, const char *color);
1334 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color);
1335 void instr_new_user_state_type (const char *father_type, const char *new_typename);
1336 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
1337 int instr_platform_traced (void);
1338 xbt_graph_t instr_routing_platform_graph (void);
1339 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1340
1341 SG_END_DECL()
1342 #endif                          /* _SURF_SURF_H */