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() {}
53 ~HostModel() override {}
55 HostImpl *createHost(const char *name, routing::NetCard *net, Cpu *cpu);
57 virtual void adjustWeightOfDummyCpuActions();
58 virtual Action *executeParallelTask(int host_nb, sg_host_t *host_list,
59 double *flops_amount, double *bytes_amount, double rate);
61 bool next_occuring_event_isIdempotent() override {return true;}
67 /** @ingroup SURF_host_interface
68 * @brief SURF Host interface class
69 * @details An host represents a machine with a aggregation of a Cpu, a RoutingEdge and a Storage
72 : public simgrid::surf::Resource,
73 public simgrid::surf::PropertyHolder {
75 static simgrid::xbt::Extension<simgrid::s4u::Host, HostImpl> EXTENSION_ID;
78 static void classInit(); // must be called before the first use of that class
80 * @brief Host constructor
82 * @param model HostModel associated to this Host
83 * @param name The name of the Host
84 * @param storage The Storage associated to this Host
85 * @param cpu The Cpu associated to this Host
87 HostImpl(HostModel *model, const char *name, xbt_dynar_t storage, Cpu *cpu);
90 * @brief Host constructor
92 * @param model HostModel associated to this Host
93 * @param name The name of the Host
94 * @param constraint The lmm constraint associated to this Host if it is part of a LMM component
95 * @param storage The Storage associated to this Host
96 * @param cpu The Cpu associated to this Host
98 HostImpl(HostModel *model, const char *name,
99 lmm_constraint_t constraint, xbt_dynar_t storage, Cpu *cpu);
101 /* Host destruction logic */
102 /**************************/
103 ~HostImpl() override;
106 // Overload the method for covariant return type:
107 HostModel *getModel()
109 return static_cast<HostModel*>(Resource::getModel());
111 void attach(simgrid::s4u::Host* host);
113 bool isOn() const override;
114 bool isOff() const override;
115 void turnOn() override;
116 void turnOff() override;
118 /** @brief Return the storage of corresponding mount point */
119 virtual simgrid::surf::Storage *findStorageOnMountList(const char* storage);
121 /** @brief Get the xbt_dict_t of mount_point: Storage */
122 virtual xbt_dict_t getMountedStorageList();
124 /** @brief Get the xbt_dynar_t of storages attached to the Host */
125 virtual xbt_dynar_t getAttachedStorageList();
130 * @param fullpath The full path to the file
131 * @return The StorageAction corresponding to the opening
133 virtual Action *open(const char* fullpath);
136 * @brief Close a file
138 * @param fd The file descriptor to close
139 * @return The StorageAction corresponding to the closing
141 virtual Action *close(surf_file_t fd);
144 * @brief Unlink a file
145 * @details [long description]
147 * @param fd [description]
148 * @return [description]
150 virtual int unlink(surf_file_t fd);
153 * @brief Get the size in bytes of the file
155 * @param fd The file descriptor to read
156 * @return The size in bytes of the file
158 virtual sg_size_t getSize(surf_file_t fd);
163 * @param fd The file descriptor to read
164 * @param size The size in bytes to read
165 * @return The StorageAction corresponding to the reading
167 virtual Action *read(surf_file_t fd, sg_size_t size);
170 * @brief Write a file
172 * @param fd The file descriptor to write
173 * @param size The size in bytes to write
174 * @return The StorageAction corresponding to the writing
176 virtual Action *write(surf_file_t fd, sg_size_t size);
179 * @brief Get the information of a file descriptor
180 * @details The returned xbt_dynar_t contains:
181 * - the size of the file,
183 * - the storage name,
184 * - the storage typeId,
185 * - the storage content type
187 * @param fd The file descriptor
188 * @return An xbt_dynar_t with the file information
190 virtual xbt_dynar_t getInfo(surf_file_t fd);
193 * @brief Get the current position of the file descriptor
195 * @param fd The file descriptor
196 * @return The current position of the file descriptor
198 virtual sg_size_t fileTell(surf_file_t fd);
201 * @brief Set the position indicator associated with the file descriptor to a new position
202 * @details [long description]
204 * @param fd The file descriptor
205 * @param offset The offset from the origin
206 * @param origin Position used as a reference for the offset
207 * - SEEK_SET: beginning of the file
208 * - SEEK_CUR: current position indicator
209 * - SEEK_END: end of the file
210 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
212 virtual int fileSeek(surf_file_t fd, sg_offset_t offset, int origin);
215 * @brief Move a file to another location on the *same mount point*.
216 * @details [long description]
218 * @param fd The file descriptor
219 * @param fullpath The new full path
220 * @return MSG_OK if successful, MSG_TASK_CANCELED and a warning if the new
221 * full path is not on the same mount point
223 virtual int fileMove(surf_file_t fd, const char* fullpath);
225 bool isUsed() override {DIE_IMPOSSIBLE;} // FIXME: Host should not be a Resource
226 void apply_event(tmgr_trace_iterator_t event, double value) override
227 {THROW_IMPOSSIBLE;} // FIXME: Host should not be a Resource
230 xbt_dynar_t p_storage;
232 simgrid::s4u::Host* p_host = nullptr;
234 /** @brief Get the list of virtual machines on the current Host */
235 xbt_dynar_t getVms();
238 /** @brief Retrieve a copy of the parameters of that VM/PM
239 * @details The ramsize and overcommit fields are used on the PM too */
240 void getParams(vm_params_t params);
241 /** @brief Sets the params of that VM/PM */
242 void setParams(vm_params_t params);
243 simgrid::s4u::Host* getHost() { return p_host; }
245 s_vm_params_t p_params;
251 #endif /* SURF_Host_INTERFACE_HPP_ */