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 virtual void adjustWeightOfDummyCpuActions();
55 virtual Action *executeParallelTask(int host_nb, sg_host_t *host_list,
56 double *flops_amount, double *bytes_amount, double rate);
62 /** @ingroup SURF_host_interface
63 * @brief SURF Host interface class
64 * @details An host represents a machine with a aggregation of a Cpu, a RoutingEdge and a Storage
67 : public simgrid::surf::Resource,
68 public simgrid::surf::PropertyHolder {
72 * @brief Host constructor
74 * @param model HostModel associated to this Host
75 * @param name The name of the Host
76 * @param storage The Storage associated to this Host
77 * @param cpu The Cpu associated to this Host
79 HostImpl(HostModel *model, const char *name, xbt_dynar_t storage, Cpu *cpu);
82 * @brief Host constructor
84 * @param model HostModel associated to this Host
85 * @param name The name of the Host
86 * @param constraint The lmm constraint associated to this Host if it is part of a LMM component
87 * @param storage The Storage associated to this Host
88 * @param cpu The Cpu associated to this Host
90 HostImpl(HostModel *model, const char *name,
91 lmm_constraint_t constraint, xbt_dynar_t storage, Cpu *cpu);
93 /* Host destruction logic */
94 /**************************/
98 // Overload the method for covariant return type:
101 return static_cast<HostModel*>(Resource::getModel());
103 void attach(simgrid::s4u::Host* host);
105 bool isOn() const override;
106 bool isOff() const override;
107 void turnOn() override;
108 void turnOff() override;
110 /** @brief Return the storage of corresponding mount point */
111 virtual simgrid::surf::Storage *findStorageOnMountList(const char* storage);
113 /** @brief Get the xbt_dict_t of mount_point: Storage */
114 virtual xbt_dict_t getMountedStorageList();
116 /** @brief Get the xbt_dynar_t of storages attached to the Host */
117 virtual xbt_dynar_t getAttachedStorageList();
122 * @param fullpath The full path to the file
123 * @return The StorageAction corresponding to the opening
125 virtual Action *open(const char* fullpath);
128 * @brief Close a file
130 * @param fd The file descriptor to close
131 * @return The StorageAction corresponding to the closing
133 virtual Action *close(surf_file_t fd);
136 * @brief Unlink a file
137 * @details [long description]
139 * @param fd [description]
140 * @return [description]
142 virtual int unlink(surf_file_t fd);
145 * @brief Get the size in bytes of the file
147 * @param fd The file descriptor to read
148 * @return The size in bytes of the file
150 virtual sg_size_t getSize(surf_file_t fd);
155 * @param fd The file descriptor to read
156 * @param size The size in bytes to read
157 * @return The StorageAction corresponding to the reading
159 virtual Action *read(surf_file_t fd, sg_size_t size);
162 * @brief Write a file
164 * @param fd The file descriptor to write
165 * @param size The size in bytes to write
166 * @return The StorageAction corresponding to the writing
168 virtual Action *write(surf_file_t fd, sg_size_t size);
171 * @brief Get the information of a file descriptor
172 * @details The returned xbt_dynar_t contains:
173 * - the size of the file,
175 * - the storage name,
176 * - the storage typeId,
177 * - the storage content type
179 * @param fd The file descriptor
180 * @return An xbt_dynar_t with the file information
182 virtual xbt_dynar_t getInfo(surf_file_t fd);
185 * @brief Get the current position of the file descriptor
187 * @param fd The file descriptor
188 * @return The current position of the file descriptor
190 virtual sg_size_t fileTell(surf_file_t fd);
193 * @brief Set the position indicator associated with the file descriptor to a new position
194 * @details [long description]
196 * @param fd The file descriptor
197 * @param offset The offset from the origin
198 * @param origin Position used as a reference for the offset
199 * - SEEK_SET: beginning of the file
200 * - SEEK_CUR: current position indicator
201 * - SEEK_END: end of the file
202 * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
204 virtual int fileSeek(surf_file_t fd, sg_offset_t offset, int origin);
207 * @brief Move a file to another location on the *same mount point*.
208 * @details [long description]
210 * @param fd The file descriptor
211 * @param fullpath The new full path
212 * @return MSG_OK if successful, MSG_TASK_CANCELED and a warning if the new
213 * full path is not on the same mount point
215 virtual int fileMove(surf_file_t fd, const char* fullpath);
217 bool isUsed() override {DIE_IMPOSSIBLE;} // FIXME: Host should not be a Resource
218 void apply_event(tmgr_trace_iterator_t event, double value) override
219 {THROW_IMPOSSIBLE;} // FIXME: Host should not be a Resource
222 xbt_dynar_t storage_ = nullptr;
224 simgrid::s4u::Host* piface_ = nullptr;
226 /** @brief Get the list of virtual machines on the current Host */
227 xbt_dynar_t getVms();
230 /** @brief Retrieve a copy of the parameters of that VM/PM
231 * @details The ramsize and overcommit fields are used on the PM too */
232 void getParams(vm_params_t params);
233 /** @brief Sets the params of that VM/PM */
234 void setParams(vm_params_t params);
235 simgrid::s4u::Host* getHost() { return piface_; }
237 s_vm_params_t params_;
243 #endif /* SURF_Host_INTERFACE_HPP_ */