Logo AND Algorithmique Numérique Distribuée

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