Logo AND Algorithmique Numérique Distribuée

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