1 /* Copyright (c) 2004-2015. The SimGrid Team.
2 * All rights reserved. */
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. */
7 #include "surf_interface.hpp"
8 #include "storage_interface.hpp"
9 #include "cpu_interface.hpp"
10 #include "network_interface.hpp"
14 #ifndef SURF_HOST_INTERFACE_HPP_
15 #define SURF_HOST_INTERFACE_HPP_
21 class XBT_PRIVATE HostModel;
22 class XBT_PRIVATE Host;
23 class XBT_PRIVATE HostAction;
29 /** @ingroup SURF_callbacks
30 * @brief Callbacks fired after Host creation. Signature: `void(Host*)`
32 XBT_PUBLIC_DATA(surf_callback(void, Host*)) hostCreatedCallbacks;
34 /** @ingroup SURF_callbacks
35 * @brief Callbacks fired Host destruction. Signature: `void(Host*)`
37 XBT_PUBLIC_DATA(surf_callback(void, Host*)) hostDestructedCallbacks;
39 /** @ingroup SURF_callbacks
40 * @brief Callbacks fired after Host State changed. Signature: `void(Host *, e_surf_resource_state_t old, e_surf_resource_state_t current)`
42 XBT_PUBLIC_DATA(surf_callback(void, Host*, e_surf_resource_state_t, e_surf_resource_state_t)) hostStateChangedCallbacks;
44 /** @ingroup SURF_callbacks
45 * @brief Callbacks fired HostAction State changed. Signature: `void(HostAction *, e_surf_action_state_t old, e_surf_action_state_t current)`
47 XBT_PUBLIC_DATA(surf_callback(void, HostAction*, e_surf_action_state_t, e_surf_action_state_t)) hostActionStateChangedCallbacks;
52 XBT_PUBLIC_DATA(HostModel*) surf_host_model;
53 XBT_PUBLIC(void) host_add_traces();
58 /** @ingroup SURF_host_interface
59 * @brief SURF Host model interface class
60 * @details A model is an object which handle the interactions between its Resources and its Actions
62 class HostModel : public Model {
64 HostModel() : Model() {}
67 virtual Host *createHost(const char *name, RoutingEdge *net, Cpu *cpu)=0;
68 void addTraces(){DIE_IMPOSSIBLE;}
70 virtual void adjustWeightOfDummyCpuActions();
71 virtual Action *executeParallelTask(int host_nb,
77 bool shareResourcesIsIdempotent() {return true;}
83 /** @ingroup SURF_host_interface
84 * @brief SURF Host interface class
85 * @details An host represents a machine with a aggregation of a Cpu, a Link and a Storage
87 class Host : public Resource {
90 * @brief Host constructor
92 * @param model HostModel associated to this Host
93 * @param name The name of the Host
94 * @param props Dictionary of properties associated to this Host
95 * @param storage The Storage associated to this Host
96 * @param netElm The RoutingEdge associated to this Host
97 * @param cpu The Cpu associated to this Host
99 Host(Model *model, const char *name, xbt_dict_t props,
100 xbt_dynar_t storage, RoutingEdge *netElm, Cpu *cpu);
103 * @brief Host constructor
105 * @param model HostModel associated to this Host
106 * @param name The name of the Host
107 * @param props Dictionary of properties associated to this Host
108 * @param constraint The lmm constraint associated to this Host if it is part of a LMM component
109 * @param storage The Storage associated to this Host
110 * @param netElm The RoutingEdge associated to this Host
111 * @param cpu The Cpu associated to this Host
113 Host(Model *model, const char *name, xbt_dict_t props,
114 lmm_constraint_t constraint, xbt_dynar_t storage, RoutingEdge *netElm,
117 /** @brief Host destructor */
120 void setState(e_surf_resource_state_t state);
123 * @brief Get the properties of the current Host
125 * @return The properties of the current Host
127 xbt_dict_t getProperties();
130 * @brief Execute some quantity of computation
132 * @param flops_amount The value of the processing amount (in flop) needed to process
133 * @return The CpuAction corresponding to the processing
136 virtual Action *execute(double flops_amount)=0;
139 * @brief Make a process sleep for duration seconds
141 * @param duration The number of seconds to sleep
142 * @return The CpuAction corresponding to the sleeping
145 virtual Action *sleep(double duration)=0;
147 /** @brief Return the storage of corresponding mount point */
148 virtual Storage *findStorageOnMountList(const char* storage);
150 /** @brief Get the xbt_dict_t of mount_point: Storage */
151 virtual xbt_dict_t getMountedStorageList();
153 /** @brief Get the xbt_dynar_t of storages attached to the Host */
154 virtual xbt_dynar_t getAttachedStorageList();
159 * @param fullpath The full path to the file
161 * @return The StorageAction corresponding to the opening
163 virtual Action *open(const char* fullpath);
166 * @brief Close a file
168 * @param fd The file descriptor to close
169 * @return The StorageAction corresponding to the closing
171 virtual Action *close(surf_file_t fd);
174 * @brief Unlink a file
175 * @details [long description]
177 * @param fd [description]
178 * @return [description]
180 virtual int unlink(surf_file_t fd);
183 * @brief Get the size in bytes of the file
185 * @param fd The file descriptor to read
186 * @return The size in bytes of the file
188 virtual sg_size_t getSize(surf_file_t fd);
193 * @param fd The file descriptor to read
194 * @param size The size in bytes to read
195 * @return The StorageAction corresponding to the reading
197 virtual Action *read(surf_file_t fd, sg_size_t size);
200 * @brief Write a file
202 * @param fd The file descriptor to write
203 * @param size The size in bytes to write
204 * @return The StorageAction corresponding to the writing
206 virtual Action *write(surf_file_t fd, sg_size_t size);
209 * @brief Get the informations of a file descriptor
210 * @details The returned xbt_dynar_t contains:
211 * - the size of the file,
213 * - the storage name,
214 * - the storage typeId,
215 * - the storage content type
217 * @param fd The file descriptor
218 * @return An xbt_dynar_t with the file informations
220 virtual xbt_dynar_t getInfo(surf_file_t fd);
223 * @brief Get the current position of the file descriptor
225 * @param fd The file descriptor
226 * @return The current position of the file descriptor
228 virtual sg_size_t fileTell(surf_file_t fd);
231 * @brief Set the position indicator associated with the file descriptor to a new position
232 * @details [long description]
234 * @param fd The file descriptor
235 * @param offset The offset from the origin
236 * @param origin Position used as a reference for the offset
237 * - SEEK_SET: beginning of the file
238 * - SEEK_CUR: current position indicator
239 * - SEEK_END: end of the file
240 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
242 virtual int fileSeek(surf_file_t fd, sg_offset_t offset, int origin);
245 * @brief Move a file to another location on the *same mount point*.
246 * @details [long description]
248 * @param fd The file descriptor
249 * @param fullpath The new full path
250 * @return MSG_OK if successful, MSG_TASK_CANCELED and a warning if the new
251 * full path is not on the same mount point
253 virtual int fileMove(surf_file_t fd, const char* fullpath);
255 xbt_dynar_t p_storage;
256 RoutingEdge *p_netElm;
259 /** @brief Get the list of virtual machines on the current Host */
260 xbt_dynar_t getVms();
263 /** @brief Retrieve a copy of the parameters of that VM/PM
264 * @details The ramsize and overcommit fields are used on the PM too */
265 void getParams(vm_params_t params);
266 /** @brief Sets the params of that VM/PM */
267 void setParams(vm_params_t params);
269 s_vm_params_t p_params;
276 /** @ingroup SURF_host_interface
277 * @brief SURF host action interface class
279 class HostAction : public Action {
282 * @brief HostAction constructor
284 * @param model The HostModel associated to this HostAction
285 * @param cost The cost of this HostAction in [TODO]
286 * @param failed [description]
288 HostAction(Model *model, double cost, bool failed)
289 : Action(model, cost, failed) {}
292 * @brief HostAction constructor
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
299 HostAction(Model *model, double cost, bool failed, lmm_variable_t var)
300 : Action(model, cost, failed, var) {}
302 void setState(e_surf_action_state_t state);
306 #endif /* SURF_Host_INTERFACE_HPP_ */