Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
further doxygen cleanups
[simgrid.git] / src / surf / host_interface.hpp
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 #include "surf_interface.hpp"
8 #include "storage_interface.hpp"
9 #include "cpu_interface.hpp"
10 #include "network_interface.hpp"
11
12 #ifndef SURF_HOST_INTERFACE_HPP_
13 #define SURF_HOST_INTERFACE_HPP_
14
15 /***********
16  * Classes *
17  ***********/
18
19 class HostModel;
20 class Host;
21 class HostAction;
22
23 /*************
24  * Callbacks *
25  *************/
26
27 /** @ingroup SURF_callbacks
28  * @brief Callbacks fired after Host creation. Signature: `void(Host*)`
29  */
30 XBT_PUBLIC_DATA(surf_callback(void, Host*)) hostCreatedCallbacks;
31
32 /** @ingroup SURF_callbacks
33  * @brief Callbacks fired Host destruction. Signature: `void(Host*)`
34  */
35 XBT_PUBLIC_DATA(surf_callback(void, Host*)) hostDestructedCallbacks;
36
37 /** @ingroup SURF_callbacks
38  * @brief Callbacks fired after Host State changed. Signature: `void(Host *, e_surf_resource_state_t old, e_surf_resource_state_t current)`
39  */
40 XBT_PUBLIC_DATA(surf_callback(void, Host*, e_surf_resource_state_t, e_surf_resource_state_t)) hostStateChangedCallbacks;
41
42 /** @ingroup SURF_callbacks
43  * @brief Callbacks fired HostAction State changed. Signature: `void(HostAction *, e_surf_action_state_t old, e_surf_action_state_t current)`
44  */
45 XBT_PUBLIC_DATA(surf_callback(void, HostAction*, e_surf_action_state_t, e_surf_action_state_t)) hostActionStateChangedCallbacks;
46
47 /*********
48  * Tools *
49  *********/
50 XBT_PUBLIC_DATA(HostModel*) surf_host_model;
51 XBT_PUBLIC(void) host_parse_init(sg_platf_host_cbarg_t host);
52 XBT_PUBLIC(void) host_add_traces();
53
54 /*********
55  * Model *
56  *********/
57 /** @ingroup SURF_host_interface
58  * @brief SURF Host model interface class
59  * @details A model is an object which handle the interactions between its Resources and its Actions
60  */
61 class HostModel : public Model {
62 public:
63   HostModel() : Model() {}
64   ~HostModel() {}
65
66   virtual Host *createHost(const char *name)=0;
67   void addTraces(){DIE_IMPOSSIBLE;}
68
69   virtual void adjustWeightOfDummyCpuActions();
70   virtual Action *executeParallelTask(int host_nb,
71                                       sg_host_t *host_list,
72                                                                           double *flops_amount,
73                                                                           double *bytes_amount,
74                                                                           double rate)=0;
75
76   bool shareResourcesIsIdempotent() {return true;}
77 };
78
79 /************
80  * Resource *
81  ************/
82 /** @ingroup SURF_host_interface
83  * @brief SURF Host interface class
84  * @details An host represents a machine with a aggregation of a Cpu, a Link and a Storage
85  */
86 class Host : public Resource {
87 public:
88   /**
89    * @brief Host constructor
90    *
91    * @param model HostModel associated to this Host
92    * @param name The name of the Host
93    * @param props Dictionary of properties associated to this Host
94    * @param storage The Storage associated to this Host
95    * @param netElm The RoutingEdge associated to this Host
96    * @param cpu The Cpu associated to this Host
97    */
98   Host(Model *model, const char *name, xbt_dict_t props,
99                       xbt_dynar_t storage, RoutingEdge *netElm, Cpu *cpu);
100
101   /**
102    * @brief Host constructor
103    *
104    * @param model HostModel associated to this Host
105    * @param name The name of the Host
106    * @param props Dictionary of properties associated to this Host
107    * @param constraint The lmm constraint associated to this Host if it is part of a LMM component
108    * @param storage The Storage associated to this Host
109    * @param netElm The RoutingEdge associated to this Host
110    * @param cpu The Cpu associated to this Host
111    */
112   Host(Model *model, const char *name, xbt_dict_t props,
113       lmm_constraint_t constraint, xbt_dynar_t storage, RoutingEdge *netElm,
114       Cpu *cpu);
115
116   /** @brief Host destructor */
117   ~ Host();
118
119   void setState(e_surf_resource_state_t state);
120
121   /**
122    * @brief Get the properties of the current Host
123    *
124    * @return The properties of the current Host
125    */
126   xbt_dict_t getProperties();
127
128   /**
129    * @brief Execute some quantity of computation
130    *
131    * @param flops_amount The value of the processing amount (in flop) needed to process
132    * @return The CpuAction corresponding to the processing
133    * @see Cpu
134    */
135   virtual Action *execute(double flops_amount)=0;
136
137   /**
138    * @brief Make a process sleep for duration seconds
139    *
140    * @param duration The number of seconds to sleep
141    * @return The CpuAction corresponding to the sleeping
142    * @see Cpu
143    */
144   virtual Action *sleep(double duration)=0;
145
146   /**
147    * @brief Get the number of cores of the associated Cpu
148    *
149    * @return The number of cores of the associated Cpu
150    * @see Cpu
151    */
152   virtual int getCore();
153
154   /**
155    * @brief Get the speed of the associated Cpu
156    *
157    * @param load [TODO]
158    * @return The speed of the associated Cpu
159    * @see Cpu
160    */
161   virtual double getSpeed(double load);
162
163   /**
164    * @brief Get the available speed of the associated Cpu
165    * @details [TODO]
166    *
167    * @return The available speed of the associated Cpu
168    * @see Cpu
169    */
170   virtual double getAvailableSpeed();
171
172   /** @brief Get the associated Cpu power peak */
173   virtual double getCurrentPowerPeak();
174
175   virtual double getPowerPeakAt(int pstate_index);
176   virtual int getNbPstates();
177   virtual void setPstate(int pstate_index);
178   virtual int  getPstate();
179
180   /** @brief Return the storage of corresponding mount point */
181   virtual Storage *findStorageOnMountList(const char* storage);
182
183   /** @brief Get the xbt_dict_t of mount_point: Storage */
184   virtual xbt_dict_t getMountedStorageList();
185
186   /** @brief Get the xbt_dynar_t of storages attached to the Host */
187   virtual xbt_dynar_t getAttachedStorageList();
188
189   /**
190    * @brief Open a file
191    *
192    * @param fullpath The full path to the file
193    *
194    * @return The StorageAction corresponding to the opening
195    */
196   virtual Action *open(const char* fullpath);
197
198   /**
199    * @brief Close a file
200    *
201    * @param fd The file descriptor to close
202    * @return The StorageAction corresponding to the closing
203    */
204   virtual Action *close(surf_file_t fd);
205
206   /**
207    * @brief Unlink a file
208    * @details [long description]
209    *
210    * @param fd [description]
211    * @return [description]
212    */
213   virtual int unlink(surf_file_t fd);
214
215   /**
216    * @brief Get the size in bytes of the file
217    *
218    * @param fd The file descriptor to read
219    * @return The size in bytes of the file
220    */
221   virtual sg_size_t getSize(surf_file_t fd);
222
223   /**
224    * @brief Read a file
225    *
226    * @param fd The file descriptor to read
227    * @param size The size in bytes to read
228    * @return The StorageAction corresponding to the reading
229    */
230   virtual Action *read(surf_file_t fd, sg_size_t size);
231
232   /**
233    * @brief Write a file
234    *
235    * @param fd The file descriptor to write
236    * @param size The size in bytes to write
237    * @return The StorageAction corresponding to the writing
238    */
239   virtual Action *write(surf_file_t fd, sg_size_t size);
240
241   /**
242    * @brief Get the informations of a file descriptor
243    * @details The returned xbt_dynar_t contains:
244    *  - the size of the file,
245    *  - the mount point,
246    *  - the storage name,
247    *  - the storage typeId,
248    *  - the storage content type
249    *
250    * @param fd The file descriptor
251    * @return An xbt_dynar_t with the file informations
252    */
253   virtual xbt_dynar_t getInfo(surf_file_t fd);
254
255   /**
256    * @brief Get the current position of the file descriptor
257    *
258    * @param fd The file descriptor
259    * @return The current position of the file descriptor
260    */
261   virtual sg_size_t fileTell(surf_file_t fd);
262
263   /**
264    * @brief Set the position indicator associated with the file descriptor to a new position
265    * @details [long description]
266    *
267    * @param fd The file descriptor
268    * @param offset The offset from the origin
269    * @param origin Position used as a reference for the offset
270    *  - SEEK_SET: beginning of the file
271    *  - SEEK_CUR: current position indicator
272    *  - SEEK_END: end of the file
273    * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
274    */
275   virtual int fileSeek(surf_file_t fd, sg_offset_t offset, int origin);
276
277   /**
278    * @brief Move a file to another location on the *same mount point*.
279    * @details [long description]
280    *
281    * @param fd The file descriptor
282    * @param fullpath The new full path
283    * @return MSG_OK if successful, MSG_TASK_CANCELED and a warning if the new
284    * full path is not on the same mount point
285    */
286   virtual int fileMove(surf_file_t fd, const char* fullpath);
287
288   xbt_dynar_t p_storage;
289   RoutingEdge *p_netElm;
290   Cpu *p_cpu;
291
292   /** @brief Get the list of virtual machines on the current Host */
293   xbt_dynar_t getVms();
294
295   /* common with vm */
296   /** @brief Retrieve a copy of the parameters of that VM/PM
297    *  @details The ramsize and overcommit fields are used on the PM too */
298   void getParams(vm_params_t params);
299   /** @brief Sets the params of that VM/PM */
300   void setParams(vm_params_t params);
301 private:
302   s_vm_params_t p_params;
303 };
304
305 /**********
306  * Action *
307  **********/
308
309 /** @ingroup SURF_host_interface
310  * @brief SURF host action interface class
311  */
312 class HostAction : public Action {
313 public:
314   /**
315    * @brief HostAction constructor
316    *
317    * @param model The HostModel associated to this HostAction
318    * @param cost The cost of this HostAction in [TODO]
319    * @param failed [description]
320    */
321   HostAction(Model *model, double cost, bool failed)
322   : Action(model, cost, failed) {}
323
324   /**
325    * @brief HostAction constructor
326    *
327    * @param model The HostModel associated to this HostAction
328    * @param cost The cost of this HostAction in [TODO]
329    * @param failed [description]
330    * @param var The lmm variable associated to this StorageAction if it is part of a LMM component
331    */
332   HostAction(Model *model, double cost, bool failed, lmm_variable_t var)
333   : Action(model, cost, failed, var) {}
334
335   void setState(e_surf_action_state_t state);
336 };
337
338
339 #endif /* SURF_Host_INTERFACE_HPP_ */