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 HostImpl;
27 class XBT_PRIVATE HostAction;
37 XBT_PUBLIC_DATA(simgrid::surf::HostModel*) surf_host_model;
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() {}
54 HostImpl *createHost(const char *name, kernel::routing::NetCard *net, Cpu *cpu);
56 virtual void adjustWeightOfDummyCpuActions();
57 virtual Action *executeParallelTask(int host_nb, sg_host_t *host_list,
58 double *flops_amount, double *bytes_amount, double rate);
64 /** @ingroup SURF_host_interface
65 * @brief SURF Host interface class
66 * @details An host represents a machine with a aggregation of a Cpu, a RoutingEdge and a Storage
69 : public simgrid::surf::Resource,
70 public simgrid::surf::PropertyHolder {
72 static simgrid::xbt::Extension<simgrid::s4u::Host, HostImpl> EXTENSION_ID;
76 * @brief Host constructor
78 * @param model HostModel associated to this Host
79 * @param name The name of the Host
80 * @param storage The Storage associated to this Host
81 * @param cpu The Cpu associated to this Host
83 HostImpl(HostModel *model, const char *name, xbt_dynar_t storage, Cpu *cpu);
86 * @brief Host constructor
88 * @param model HostModel associated to this Host
89 * @param name The name of the Host
90 * @param constraint The lmm constraint associated to this Host if it is part of a LMM component
91 * @param storage The Storage associated to this Host
92 * @param cpu The Cpu associated to this Host
94 HostImpl(HostModel *model, const char *name,
95 lmm_constraint_t constraint, xbt_dynar_t storage, Cpu *cpu);
97 /* Host destruction logic */
98 /**************************/
102 // Overload the method for covariant return type:
103 HostModel *getModel()
105 return static_cast<HostModel*>(Resource::getModel());
107 void attach(simgrid::s4u::Host* host);
109 bool isOn() const override;
110 bool isOff() const override;
111 void turnOn() override;
112 void turnOff() override;
114 /** @brief Return the storage of corresponding mount point */
115 virtual simgrid::surf::Storage *findStorageOnMountList(const char* storage);
117 /** @brief Get the xbt_dict_t of mount_point: Storage */
118 virtual xbt_dict_t getMountedStorageList();
120 /** @brief Get the xbt_dynar_t of storages attached to the Host */
121 virtual xbt_dynar_t getAttachedStorageList();
126 * @param fullpath The full path to the file
127 * @return The StorageAction corresponding to the opening
129 virtual Action *open(const char* fullpath);
132 * @brief Close a file
134 * @param fd The file descriptor to close
135 * @return The StorageAction corresponding to the closing
137 virtual Action *close(surf_file_t fd);
140 * @brief Unlink a file
141 * @details [long description]
143 * @param fd [description]
144 * @return [description]
146 virtual int unlink(surf_file_t fd);
149 * @brief Get the size in bytes of the file
151 * @param fd The file descriptor to read
152 * @return The size in bytes of the file
154 virtual sg_size_t getSize(surf_file_t fd);
159 * @param fd The file descriptor to read
160 * @param size The size in bytes to read
161 * @return The StorageAction corresponding to the reading
163 virtual Action *read(surf_file_t fd, sg_size_t size);
166 * @brief Write a file
168 * @param fd The file descriptor to write
169 * @param size The size in bytes to write
170 * @return The StorageAction corresponding to the writing
172 virtual Action *write(surf_file_t fd, sg_size_t size);
175 * @brief Get the information of a file descriptor
176 * @details The returned xbt_dynar_t contains:
177 * - the size of the file,
179 * - the storage name,
180 * - the storage typeId,
181 * - the storage content type
183 * @param fd The file descriptor
184 * @return An xbt_dynar_t with the file information
186 virtual xbt_dynar_t getInfo(surf_file_t fd);
189 * @brief Get the current position of the file descriptor
191 * @param fd The file descriptor
192 * @return The current position of the file descriptor
194 virtual sg_size_t fileTell(surf_file_t fd);
197 * @brief Set the position indicator associated with the file descriptor to a new position
198 * @details [long description]
200 * @param fd The file descriptor
201 * @param offset The offset from the origin
202 * @param origin Position used as a reference for the offset
203 * - SEEK_SET: beginning of the file
204 * - SEEK_CUR: current position indicator
205 * - SEEK_END: end of the file
206 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
208 virtual int fileSeek(surf_file_t fd, sg_offset_t offset, int origin);
211 * @brief Move a file to another location on the *same mount point*.
212 * @details [long description]
214 * @param fd The file descriptor
215 * @param fullpath The new full path
216 * @return MSG_OK if successful, MSG_TASK_CANCELED and a warning if the new
217 * full path is not on the same mount point
219 virtual int fileMove(surf_file_t fd, const char* fullpath);
221 bool isUsed() override {DIE_IMPOSSIBLE;} // FIXME: Host should not be a Resource
222 void apply_event(tmgr_trace_iterator_t event, double value) override
223 {THROW_IMPOSSIBLE;} // FIXME: Host should not be a Resource
226 xbt_dynar_t storage_;
228 simgrid::s4u::Host* piface_ = nullptr;
230 /** @brief Get the list of virtual machines on the current Host */
231 xbt_dynar_t getVms();
234 /** @brief Retrieve a copy of the parameters of that VM/PM
235 * @details The ramsize and overcommit fields are used on the PM too */
236 void getParams(vm_params_t params);
237 /** @brief Sets the params of that VM/PM */
238 void setParams(vm_params_t params);
239 simgrid::s4u::Host* getHost() { return piface_; }
241 s_vm_params_t params_;
247 #endif /* SURF_Host_INTERFACE_HPP_ */