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"
11 #include "src/surf/PropertyHolder.hpp"
15 #ifndef SURF_HOST_INTERFACE_HPP_
16 #define SURF_HOST_INTERFACE_HPP_
25 class XBT_PRIVATE HostModel;
26 class XBT_PRIVATE Host;
27 class XBT_PRIVATE HostAction;
36 XBT_PUBLIC_DATA(simgrid::surf::HostModel*) surf_host_model;
37 XBT_PUBLIC(void) host_add_traces();
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
50 class HostModel : public Model{
52 HostModel() : Model() {}
55 Host *createHost(const char *name, NetCard *net, Cpu *cpu, xbt_dict_t props);
56 void addTraces() override {DIE_IMPOSSIBLE;}
58 virtual void adjustWeightOfDummyCpuActions();
59 virtual Action *executeParallelTask(int host_nb,
65 bool shareResourcesIsIdempotent() override {return true;}
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 RoutingEdge and a Storage
76 public simgrid::surf::Resource,
77 public simgrid::surf::PropertyHolder {
79 static simgrid::xbt::Extension<simgrid::Host, Host> EXTENSION_ID;
82 static simgrid::surf::signal<void(Host*)> onCreation; /** Called on each newly created object */
83 static simgrid::surf::signal<void(Host*)> onDestruction; /** Called just before destructing an object */
84 static simgrid::surf::signal<void(simgrid::surf::Host*, e_surf_resource_state_t, e_surf_resource_state_t)> onStateChange;
87 static void classInit(); // must be called before the first use of that class
89 * @brief Host constructor
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
98 Host(simgrid::surf::Model *model, const char *name, xbt_dict_t props,
99 xbt_dynar_t storage, NetCard *netElm, Cpu *cpu);
102 * @brief Host constructor
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
112 Host(simgrid::surf::Model *model, const char *name, xbt_dict_t props,
113 lmm_constraint_t constraint, xbt_dynar_t storage, NetCard *netElm,
116 /* Host destruction logic */
117 /**************************/
121 void destroy(); // Must be called instead of the destructor
123 bool currentlyDestroying_ = false;
127 void attach(simgrid::Host* host);
129 e_surf_resource_state_t getState();
130 void setState(e_surf_resource_state_t state);
132 /** @brief Return the storage of corresponding mount point */
133 virtual simgrid::surf::Storage *findStorageOnMountList(const char* storage);
135 /** @brief Get the xbt_dict_t of mount_point: Storage */
136 virtual xbt_dict_t getMountedStorageList();
138 /** @brief Get the xbt_dynar_t of storages attached to the Host */
139 virtual xbt_dynar_t getAttachedStorageList();
144 * @param fullpath The full path to the file
145 * @return The StorageAction corresponding to the opening
147 virtual Action *open(const char* fullpath);
150 * @brief Close a file
152 * @param fd The file descriptor to close
153 * @return The StorageAction corresponding to the closing
155 virtual Action *close(surf_file_t fd);
158 * @brief Unlink a file
159 * @details [long description]
161 * @param fd [description]
162 * @return [description]
164 virtual int unlink(surf_file_t fd);
167 * @brief Get the size in bytes of the file
169 * @param fd The file descriptor to read
170 * @return The size in bytes of the file
172 virtual sg_size_t getSize(surf_file_t fd);
177 * @param fd The file descriptor to read
178 * @param size The size in bytes to read
179 * @return The StorageAction corresponding to the reading
181 virtual Action *read(surf_file_t fd, sg_size_t size);
184 * @brief Write a file
186 * @param fd The file descriptor to write
187 * @param size The size in bytes to write
188 * @return The StorageAction corresponding to the writing
190 virtual Action *write(surf_file_t fd, sg_size_t size);
193 * @brief Get the informations of a file descriptor
194 * @details The returned xbt_dynar_t contains:
195 * - the size of the file,
197 * - the storage name,
198 * - the storage typeId,
199 * - the storage content type
201 * @param fd The file descriptor
202 * @return An xbt_dynar_t with the file informations
204 virtual xbt_dynar_t getInfo(surf_file_t fd);
207 * @brief Get the current position of the file descriptor
209 * @param fd The file descriptor
210 * @return The current position of the file descriptor
212 virtual sg_size_t fileTell(surf_file_t fd);
215 * @brief Set the position indicator associated with the file descriptor to a new position
216 * @details [long description]
218 * @param fd The file descriptor
219 * @param offset The offset from the origin
220 * @param origin Position used as a reference for the offset
221 * - SEEK_SET: beginning of the file
222 * - SEEK_CUR: current position indicator
223 * - SEEK_END: end of the file
224 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
226 virtual int fileSeek(surf_file_t fd, sg_offset_t offset, int origin);
229 * @brief Move a file to another location on the *same mount point*.
230 * @details [long description]
232 * @param fd The file descriptor
233 * @param fullpath The new full path
234 * @return MSG_OK if successful, MSG_TASK_CANCELED and a warning if the new
235 * full path is not on the same mount point
237 virtual int fileMove(surf_file_t fd, const char* fullpath);
239 bool isUsed() override {DIE_IMPOSSIBLE;} // FIXME: Host should not be a Resource
240 void updateState(tmgr_trace_event_t event_type, double value, double date) override
241 {THROW_IMPOSSIBLE;} // FIXME: Host should not be a Resource
244 xbt_dynar_t p_storage;
247 simgrid::Host* p_host = nullptr;
249 /** @brief Get the list of virtual machines on the current Host */
250 xbt_dynar_t getVms();
253 /** @brief Retrieve a copy of the parameters of that VM/PM
254 * @details The ramsize and overcommit fields are used on the PM too */
255 void getParams(vm_params_t params);
256 /** @brief Sets the params of that VM/PM */
257 void setParams(vm_params_t params);
258 simgrid::Host* getHost() { return p_host; }
260 s_vm_params_t p_params;
266 #endif /* SURF_Host_INTERFACE_HPP_ */