Logo AND Algorithmique Numérique Distribuée

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