Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add example of java cpu model
[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 fullpath The path to the file
413  * @return The surf action corresponding to the openning
414  */
415 XBT_PUBLIC(surf_action_t) surf_workstation_open(surf_resource_t workstation, const char* fullpath);
416
417 /**
418  * @brief Close a file descriptor on a workstation
419  *
420  * @param workstation The surf workstation
421  * @param fd The file descriptor
422  *
423  * @return The surf action corresponding to the closing
424  */
425 XBT_PUBLIC(surf_action_t) surf_workstation_close(surf_resource_t workstation, surf_file_t fd);
426
427 /**
428  * @brief Read a file
429  *
430  * @param resource The surf workstation
431  * @param fd The file descriptor to read
432  * @param size The size in bytes to read
433  * @return The surf action corresponding to the reading
434  */
435 XBT_PUBLIC(surf_action_t) surf_workstation_read(surf_resource_t resource, surf_file_t fd, sg_size_t size);
436
437 /**
438  * @brief Write a file
439  *
440  * @param resource The surf workstation
441  * @param fd The file descriptor to write
442  * @param size The size in bytes to write
443  * @return The surf action corresponding to the writing
444  */
445 XBT_PUBLIC(surf_action_t) surf_workstation_write(surf_resource_t resource, surf_file_t fd, sg_size_t size);
446
447 /**
448  * @brief Get the informations of a file descriptor
449  * @details The returned xbt_dynar_t contains:
450  *  - the size of the file,
451  *  - the mount point,
452  *  - the storage name,
453  *  - the storage typeId,
454  *  - the storage content type
455  *
456  * @param resource The surf workstation
457  * @param fd The file descriptor
458  * @return An xbt_dynar_t with the file informations
459  */
460 XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_info(surf_resource_t resource, surf_file_t fd);
461
462 /**
463  * @brief Get the available space of the storage at the mount point
464  *
465  * @param resource The surf workstation
466  * @param name The mount point
467  * @return The amount of availble space in bytes
468  */
469 XBT_PUBLIC(sg_size_t) surf_workstation_get_free_size(surf_resource_t resource, const char* name);
470
471 /**
472  * @brief Get the used space of the storage at the mount point
473  *
474  * @param resource The surf workstation
475  * @param name The mount point
476  * @return The amount of used space in bytes
477  */
478 XBT_PUBLIC(sg_size_t) surf_workstation_get_used_size(surf_resource_t resource, const char* name);
479
480 /**
481  * @brief Get the VMs hosted on the workstation
482  *
483  * @param resource The surf workstation
484  * @return The list of VMs on the workstation
485  */
486 XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_vms(surf_resource_t resource);
487
488 /**
489  * @brief [brief description]
490  * @details [long description]
491  *
492  * @param resource [description]
493  * @param params [description]
494  */
495 XBT_PUBLIC(void) surf_workstation_get_params(surf_resource_t resource, ws_params_t params);
496
497 /**
498  * @brief [brief description]
499  * @details [long description]
500  *
501  * @param resource [description]
502  * @param params [description]
503  */
504 XBT_PUBLIC(void) surf_workstation_set_params(surf_resource_t resource, ws_params_t params);
505
506 /**
507  * @brief Destroy a Workstation VM
508  *
509  * @param resource The surf workstation vm
510  */
511 XBT_PUBLIC(void) surf_vm_workstation_destroy(surf_resource_t resource);
512
513 /**
514  * @brief Suspend a Workstation VM
515  *
516  * @param resource The surf workstation vm
517  */
518 XBT_PUBLIC(void) surf_vm_workstation_suspend(surf_resource_t resource);
519
520 /**
521  * @brief Resume a Workstation VM
522  *
523  * @param resource The surf workstation vm
524  */
525 XBT_PUBLIC(void) surf_vm_workstation_resume(surf_resource_t resource);
526
527 /**
528  * @brief Save the Workstation VM (Not yet implemented)
529  *
530  * @param resource The surf workstation vm
531  */
532 XBT_PUBLIC(void) surf_vm_workstation_save(surf_resource_t resource);
533
534 /**
535  * @brief Restore the Workstation VM (Not yet implemented)
536  *
537  * @param resource The surf workstation vm
538  */
539 XBT_PUBLIC(void) surf_vm_workstation_restore(surf_resource_t resource);
540
541 /**
542  * @brief Migrate the VM to the destination host
543  *
544  * @param resource The surf workstation vm
545  * @param ind_vm_ws_dest The destination host
546  */
547 XBT_PUBLIC(void) surf_vm_workstation_migrate(surf_resource_t resource, surf_resource_t ind_vm_ws_dest);
548
549 /**
550  * @brief Get the physical machine hosting the VM
551  *
552  * @param resource The surf workstation vm
553  * @return The physical machine hosting the VM
554  */
555 XBT_PUBLIC(surf_resource_t) surf_vm_workstation_get_pm(surf_resource_t resource);
556
557 /**
558  * @brief [brief description]
559  * @details [long description]
560  *
561  * @param resource [description]
562  * @param bound [description]
563  */
564 XBT_PUBLIC(void) surf_vm_workstation_set_bound(surf_resource_t resource, double bound);
565
566 /**
567  * @brief [brief description]
568  * @details [long description]
569  *
570  * @param resource [description]
571  * @param cpu [description]
572  * @param mask [description]
573  */
574 XBT_PUBLIC(void) surf_vm_workstation_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask);
575
576 /**
577  * @brief Execute some quantity of computation
578  *
579  * @param cpu The surf cpu
580  * @param size The value of the processing amount (in flop) needed to process
581  * @return The surf action corresponding to the processing
582  */
583 XBT_PUBLIC(surf_action_t) surf_cpu_execute(surf_resource_t cpu, double size);
584
585 /**
586  * @brief Make the cpu sleep for duration (in seconds)
587  * @details [long description]
588  *
589  * @param cpu The surf cpu
590  * @param duration The number of seconds to sleep
591  * @return The surf action corresponding to the sleeping
592  */
593 XBT_PUBLIC(surf_action_t) surf_cpu_sleep(surf_resource_t cpu, double duration);
594
595 /**
596  * @brief Get the workstation power peak
597  * @details [long description]
598  *
599  * @param host The surf workstation
600  * @return The power peak
601  */
602 XBT_PUBLIC(double) surf_workstation_get_current_power_peak(surf_resource_t host);
603
604 /**
605  * @brief [brief description]
606  * @details [long description]
607  *
608  * @param host [description]
609  * @param pstate_index [description]
610  *
611  * @return [description]
612  */
613 XBT_PUBLIC(double) surf_workstation_get_power_peak_at(surf_resource_t host, int pstate_index);
614
615 /**
616  * @brief [brief description]
617  * @details [long description]
618  *
619  * @param host [description]
620  * @return [description]
621  */
622 XBT_PUBLIC(int) surf_workstation_get_nb_pstates(surf_resource_t host);
623
624 /**
625  * @brief [brief description]
626  * @details [long description]
627  *
628  * @param host [description]
629  * @param pstate_index [description]
630  */
631 XBT_PUBLIC(void) surf_workstation_set_power_peak_at(surf_resource_t host, int pstate_index);
632
633 /**
634  * @brief Get the consumed energy (in joules) of a workstation
635  *
636  * @param host The surf workstation
637  * @return The consumed energy
638  */
639 XBT_PUBLIC(double) surf_workstation_get_consumed_energy(surf_resource_t host);
640
641 /**
642  * @brief Get the list of storages mounted on a workstation
643  *
644  * @param workstation The surf workstation
645  * @return Dictionary of mount point, Storage
646  */
647 XBT_PUBLIC(xbt_dict_t) surf_workstation_get_mounted_storage_list(surf_resource_t workstation);
648
649 /**
650  * @brief Get the list of storages attached to a workstation
651  *
652  * @param workstation The surf workstation
653  * @return Dictionary of storage
654  */
655 XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_attached_storage_list(surf_resource_t workstation);
656
657 /**
658  * @brief Unlink a file descriptor
659  *
660  * @param workstation The surf workstation
661  * @param fd The file descriptor
662  *
663  * @return 0 if failed to unlink, 1 otherwise
664  */
665 XBT_PUBLIC(int) surf_workstation_unlink(surf_resource_t workstation, surf_file_t fd);
666
667 /**
668  * @brief Get the size of a file on a workstation
669  *
670  * @param workstation The surf workstation
671  * @param fd The file descriptor
672  *
673  * @return The size in bytes of the file
674  */
675 XBT_PUBLIC(size_t) surf_workstation_get_size(surf_resource_t workstation, surf_file_t fd);
676
677 /**
678  * @brief Get the current position of the file descriptor
679  *
680  * @param workstation The surf workstation
681  * @param fd The file descriptor
682  * @return The current position of the file descriptor
683  */
684 XBT_PUBLIC(size_t) surf_workstation_file_tell(surf_resource_t workstation, surf_file_t fd);
685
686 /**
687  * @brief Move a file to another location on the *same mount point*.
688  * @details [long description]
689  *
690  * @param workstation The surf workstation
691  * @param fd The file descriptor
692  * @param fullpath The new full path
693  *
694  * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
695  */
696 XBT_PUBLIC(int) surf_workstation_file_move(surf_resource_t workstation, surf_file_t fd, const char* fullpath);
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 Get the data associated to the action
756  *
757  * @param action The surf action
758  * @return The data associated to the action
759  */
760 XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
761
762 /**
763  * @brief Set the data associated to the action
764  * @details [long description]
765  *
766  * @param action The surf action
767  * @param data The new data associated to the action
768  */
769 XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
770
771 /**
772  * @brief Unreference an action
773  *
774  * @param action The surf action
775  */
776 XBT_PUBLIC(void) surf_action_unref(surf_action_t action);
777
778 /**
779  * @brief Get the start time of an action
780  *
781  * @param action The surf action
782  * @return The start time in seconds from the beginning of the simulation
783  */
784 XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
785
786 /**
787  * @brief Get the finish time of an action
788  *
789  * @param action The surf action
790  * @return The finish time in seconds from the beginning of the simulation
791  */
792 XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
793
794 /**
795  * @brief Get the remains amount of work to do of an action
796  *
797  * @param action The surf action
798  * @return  The remains amount of work to do
799  */
800 XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
801
802 /**
803  * @brief Suspend an action
804  *
805  * @param action The surf action
806  */
807 XBT_PUBLIC(void) surf_action_suspend(surf_action_t action);
808
809 /**
810  * @brief Resume an action
811  *
812  * @param action The surf action
813  */
814 XBT_PUBLIC(void) surf_action_resume(surf_action_t action);
815
816 /**
817  * @brief Cancel an action
818  *
819  * @param action The surf action
820  */
821 XBT_PUBLIC(void) surf_action_cancel(surf_action_t action);
822
823 /**
824  * @brief Set the priority of an action
825  * @details [long description]
826  *
827  * @param action The surf action
828  * @param priority The new priority [TODO]
829  */
830 XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority);
831
832 /**
833  * @brief Set the category of an action
834  * @details [long description]
835  *
836  * @param action The surf action
837  * @param category The new category of the action
838  */
839 XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
840
841 /**
842  * @brief Get the state of an action
843  *
844  * @param action The surf action
845  * @return The state of the action
846  */
847 XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
848
849 /**
850  * @brief Get the cost of an action
851  *
852  * @param action The surf action
853  * @return The cost of the action
854  */
855 XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
856
857 /**
858  * @brief [brief desrciption]
859  * @details [long description]
860  *
861  * @param action The surf cpu action
862  * @param cpu [description]
863  * @param mask [description]
864  */
865 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask);
866
867 /**
868  * @brief [brief description]
869  * @details [long description]
870  *
871  * @param action The surf cpu action
872  * @param bound [description]
873  */
874 XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
875
876 /**
877  * @brief [brief description]
878  * @details [long description]
879  *
880  * @param action The surf network action
881  */
882 XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
883
884 /**
885  * @brief Get the file associated to a storage action
886  *
887  * @param action The surf storage action
888  * @return The file associated to a storage action
889  */
890 XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
891
892 /**
893  * @brief Get the result dictionary of an ls action
894  *
895  * @param action The surf storage action
896  * @return The dictionry listing a path
897  */
898 XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
899
900
901 /**
902  * @brief Get the host the storage is attached to
903  *
904  * @param resource The surf storage
905  * @return The host name
906  */
907 XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
908
909 XBT_PUBLIC(surf_model_t) surf_resource_model(const void *host, int level);
910
911 /** @} */
912
913 /**************************************/
914 /* Implementations of model object */
915 /**************************************/
916
917 XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
918 extern void_f_void_t surf_cpu_model_init_preparse;
919
920 /** \ingroup SURF_models
921  *  \brief The CPU model object for the physical machine layer
922  */
923 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
924
925 /** \ingroup SURF_models
926  *  \brief The CPU model object for the virtual machine layer
927  */
928 XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
929
930
931 /** \ingroup SURF_models
932  *  \brief Initializes the CPU model with the model Cas01
933  *
934  *  By default, this model uses the lazy optimization mechanism that
935  *  relies on partial invalidation in LMM and a heap for lazy action update.
936  *  You can change this behavior by setting the cpu/optim configuration
937  *  variable to a different value.
938  *
939  *  You shouldn't have to call it by yourself.
940  */
941 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
942
943 /** \ingroup SURF_models
944  *  \brief Initializes the CPU model with trace integration [Deprecated]
945  *
946  *  You shouldn't have to call it by yourself.
947  */
948 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
949
950 /** \ingroup SURF_models
951  *  \brief The list of all available optimization modes (both for cpu and networks).
952  *  These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
953  */
954 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
955
956 /** \ingroup SURF_plugins
957  *  \brief The list of all available surf plugins
958  */
959 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
960
961 /** \ingroup SURF_models
962  *  \brief The list of all available cpu model models
963  */
964 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
965
966 /**\brief create new host bypass the parser
967  *
968  */
969
970
971 /** \ingroup SURF_models
972  *  \brief The network model
973  *
974  *  When creating a new API on top on SURF, you shouldn't use the
975  *  network model unless you know what you are doing. Only the workstation
976  *  model should be accessed because depending on the platform model,
977  *  the network model can be NULL.
978  */
979 XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
980
981 /** \ingroup SURF_models
982  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
983  *
984  * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
985  * based on the model 'LV08' and different correction factors depending on the communication
986  * size (< 1KiB, < 64KiB, >= 64KiB).
987  * See comments in the code for more information.
988  *
989  *  \see surf_workstation_model_init_SMPI()
990  */
991 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
992
993 /** \ingroup SURF_models
994  *  \brief Initializes the platform with the network model 'LegrandVelho'
995  *
996  * This model is proposed by Arnaud Legrand and Pedro Velho based on
997  * the results obtained with the GTNets simulator for onelink and
998  * dogbone sharing scenarios. See comments in the code for more information.
999  *
1000  *  \see surf_workstation_model_init_LegrandVelho()
1001  */
1002 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
1003
1004 /** \ingroup SURF_models
1005  *  \brief Initializes the platform with the network model 'Constant'
1006  *
1007  *  In this model, the communication time between two network cards is
1008  *  constant, hence no need for a routing table. This is particularly
1009  *  usefull when simulating huge distributed algorithms where
1010  *  scalability is really an issue. This function is called in
1011  *  conjunction with surf_workstation_model_init_compound.
1012  *
1013  *  \see surf_workstation_model_init_compound()
1014  */
1015 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
1016
1017 /** \ingroup SURF_models
1018  *  \brief Initializes the platform with the network model CM02
1019  *
1020  *  You sould call this function by yourself only if you plan using
1021  *  surf_workstation_model_init_compound.
1022  *  See comments in the code for more information.
1023  */
1024 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
1025
1026 #ifdef HAVE_GTNETS
1027 /** \ingroup SURF_models
1028  *  \brief Initializes the platform with the network model GTNETS
1029  *  \param filename XML platform file name
1030  *
1031  *  This function is called by surf_workstation_model_init_GTNETS
1032  *  or by yourself only if you plan using surf_workstation_model_init_compound
1033  *
1034  *  \see surf_workstation_model_init_GTNETS()
1035  */
1036 XBT_PUBLIC(void) surf_network_model_init_GTNETS(void);
1037 #endif
1038
1039 #ifdef HAVE_NS3
1040 /** \ingroup SURF_models
1041  *  \brief Initializes the platform with the network model NS3
1042  *  \param filename XML platform file name
1043  *
1044  *  This function is called by surf_workstation_model_init_NS3
1045  *  or by yourself only if you plan using surf_workstation_model_init_compound
1046  *
1047  *  \see surf_workstation_model_init_NS3()
1048  */
1049 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
1050 #endif
1051
1052 /** \ingroup SURF_models
1053  *  \brief Initializes the platform with the network model Reno
1054  *  \param filename XML platform file name
1055  *
1056  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
1057  *
1058  *  Reference:
1059  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1060  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1061  *
1062  *  Call this function only if you plan using surf_workstation_model_init_compound.
1063  *
1064  */
1065 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
1066
1067 /** \ingroup SURF_models
1068  *  \brief Initializes the platform with the network model Reno2
1069  *  \param filename XML platform file name
1070  *
1071  *  The problem is related to max( sum( arctan(C * Df * xi) ) ).
1072  *
1073  *  Reference:
1074  *  [LOW01] 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_Reno2(void);
1081
1082 /** \ingroup SURF_models
1083  *  \brief Initializes the platform with the network model Vegas
1084  *  \param filename XML platform file name
1085  *
1086  *  This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
1087  *  to the proportional fairness.
1088  *
1089  *  Reference:
1090  *  [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
1091  *  IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
1092  *
1093  *  Call this function only if you plan using surf_workstation_model_init_compound.
1094  *
1095  */
1096 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
1097
1098 /** \ingroup SURF_models
1099  *  \brief The list of all available network model models
1100  */
1101 XBT_PUBLIC_DATA(s_surf_model_description_t)
1102     surf_network_model_description[];
1103
1104 /** \ingroup SURF_models
1105  *  \brief The storage model
1106  */
1107 XBT_PUBLIC(void) surf_storage_model_init_default(void);
1108
1109 /** \ingroup SURF_models
1110  *  \brief The list of all available storage modes.
1111  *  This storage mode can be set using --cfg=storage/model:...
1112  */
1113 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
1114
1115 XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
1116
1117 /** \ingroup SURF_models
1118  *  \brief The workstation model
1119  *
1120  *  Note that when you create an API on top of SURF,
1121  *  the workstation model should be the only one you use
1122  *  because depending on the platform model, the network model and the CPU model
1123  *  may not exist.
1124  */
1125 XBT_PUBLIC_DATA(surf_workstation_model_t) surf_workstation_model;
1126
1127 /** \ingroup SURF_models
1128  *  \brief The vm_workstation model
1129  *
1130  *  Note that when you create an API on top of SURF,
1131  *  the vm_workstation model should be the only one you use
1132  *  because depending on the platform model, the network model and the CPU model
1133  *  may not exist.
1134  */
1135 XBT_PUBLIC_DATA(surf_vm_workstation_model_t) surf_vm_workstation_model;
1136
1137 /** \ingroup SURF_models
1138  *  \brief Initializes the platform with a compound workstation model
1139  *
1140  *  This function should be called after a cpu_model and a
1141  *  network_model have been set up.
1142  *
1143  */
1144 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
1145
1146 /** \ingroup SURF_models
1147  *  \brief Initializes the platform with the current best network and cpu models at hand
1148  *
1149  *  This platform model seperates the workstation model and the network model.
1150  *  The workstation model will be initialized with the model compound, the network
1151  *  model with the model LV08 (with cross traffic support) and the CPU model with
1152  *  the model Cas01.
1153  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
1154  *
1155  */
1156 XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
1157
1158 /** \ingroup SURF_models
1159  *  \brief Initializes the platform with the model KCCFLN05
1160  *
1161  *  With this model, only parallel tasks can be used. Resource sharing
1162  *  is done by identifying bottlenecks and giving an equal share of
1163  *  the model to each action.
1164  *
1165  */
1166 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
1167
1168 /** \ingroup SURF_models
1169  *  \brief The list of all available workstation model models
1170  */
1171 XBT_PUBLIC_DATA(s_surf_model_description_t)
1172     surf_workstation_model_description[];
1173
1174 /** \ingroup SURF_models
1175  *  \brief Initializes the platform with the current best network and cpu models at hand
1176  *
1177  *  This platform model seperates the workstation model and the network model.
1178  *  The workstation model will be initialized with the model compound, the network
1179  *  model with the model LV08 (with cross traffic support) and the CPU model with
1180  *  the model Cas01.
1181  *  Such model is subject to modification with warning in the ChangeLog so monitor it!
1182  *
1183  */
1184 XBT_PUBLIC(void) surf_vm_workstation_model_init_current_default(void);
1185
1186 /** \ingroup SURF_models
1187  *  \brief The list of all available vm workstation model models
1188  */
1189 XBT_PUBLIC_DATA(s_surf_model_description_t)
1190     surf_vm_workstation_model_description[];
1191
1192 /*******************************************/
1193
1194 /** \ingroup SURF_models
1195  *  \brief List of initialized models
1196  */
1197 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
1198 XBT_PUBLIC_DATA(xbt_dynar_t) model_list_invoke;
1199
1200 /** \ingroup SURF_simulation
1201  *  \brief List of hosts that have juste restarted and whose autorestart process should be restarted.
1202  */
1203 XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
1204
1205 /** \ingroup SURF_simulation
1206  *  \brief List of hosts for which one want to be notified if they ever restart.
1207  */
1208 XBT_PUBLIC(xbt_dict_t) watched_hosts_lib;
1209
1210 /*******************************************/
1211 /*** SURF Platform *************************/
1212 /*******************************************/
1213 XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
1214 XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
1215 XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
1216 XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
1217 XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
1218 XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
1219 XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
1220 XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
1221
1222 /*******************************************/
1223 /*** SURF Globals **************************/
1224 /*******************************************/
1225
1226 /** \ingroup SURF_simulation
1227  *  \brief Initialize SURF
1228  *  \param argc argument number
1229  *  \param argv arguments
1230  *
1231  *  This function has to be called to initialize the common
1232  *  structures.  Then you will have to create the environment by
1233  *  calling
1234  *  e.g. surf_workstation_model_init_CM02()
1235  *
1236  *  \see surf_workstation_model_init_CM02(), surf_workstation_model_init_compound(), surf_exit()
1237  */
1238 XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common structures */
1239
1240 /** \ingroup SURF_simulation
1241  *  \brief Finish simulation initialization
1242  *
1243  *  This function must be called before the first call to surf_solve()
1244  */
1245 XBT_PUBLIC(void) surf_presolve(void);
1246
1247 /** \ingroup SURF_simulation
1248  *  \brief Performs a part of the simulation
1249  *  \param max_date Maximum date to update the simulation to, or -1
1250  *  \return the elapsed time, or -1.0 if no event could be executed
1251  *
1252  *  This function execute all possible events, update the action states
1253  *  and returns the time elapsed.
1254  *  When you call execute or communicate on a model, the corresponding actions
1255  *  are not executed immediately but only when you call surf_solve.
1256  *  Note that the returned elapsed time can be zero.
1257  */
1258 XBT_PUBLIC(double) surf_solve(double max_date);
1259
1260 /** \ingroup SURF_simulation
1261  *  \brief Return the current time
1262  *
1263  *  Return the current time in millisecond.
1264  */
1265 XBT_PUBLIC(double) surf_get_clock(void);
1266
1267 /** \ingroup SURF_simulation
1268  *  \brief Exit SURF
1269  *
1270  *  Clean everything.
1271  *
1272  *  \see surf_init()
1273  */
1274 XBT_PUBLIC(void) surf_exit(void);
1275
1276 /* Prototypes of the functions that handle the properties */
1277 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;       /* the prop set for the currently parsed element (also used in SIMIX) */
1278
1279 /* The same for model_prop set*/
1280 XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
1281
1282 /* surf parse file related (public because called from a test suite) */
1283 XBT_PUBLIC(void) parse_platform_file(const char *file);
1284
1285 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
1286 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
1287 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
1288 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
1289 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
1290 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
1291 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
1292
1293
1294 XBT_PUBLIC(double) get_cpu_power(const char *power);
1295
1296 XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
1297
1298 int surf_get_nthreads(void);
1299 void surf_set_nthreads(int nthreads);
1300
1301 /*
1302  * Returns the initial path. On Windows the initial path is
1303  * the current directory for the current process in the other
1304  * case the function returns "./" that represents the current
1305  * directory on Unix/Linux platforms.
1306  */
1307 const char *__surf_get_initial_path(void);
1308
1309 /********** Tracing **********/
1310 /* from surf_instr.c */
1311 void TRACE_surf_action(surf_action_t surf_action, const char *category);
1312 void TRACE_surf_alloc(void);
1313 void TRACE_surf_release(void);
1314
1315 /* instr_routing.c */
1316 void instr_routing_define_callbacks (void);
1317 void instr_new_variable_type (const char *new_typename, const char *color);
1318 void instr_new_user_variable_type  (const char *father_type, const char *new_typename, const char *color);
1319 void instr_new_user_state_type (const char *father_type, const char *new_typename);
1320 void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
1321 int instr_platform_traced (void);
1322 xbt_graph_t instr_routing_platform_graph (void);
1323 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
1324
1325 SG_END_DECL()
1326 #endif                          /* _SURF_SURF_H */