src/surf/HostImpl.hpp

   1 /* Copyright (c) 2004-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   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. */
   6
   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"
  12
  13 #include <xbt/base.h>
  14
  15 #ifndef SURF_HOST_INTERFACE_HPP_
  16 #define SURF_HOST_INTERFACE_HPP_
  17
  18 /***********
  19  * Classes *
  20  ***********/
  21
  22 namespace simgrid {
  23 namespace surf {
  24
  25 class XBT_PRIVATE HostModel;
  26 class XBT_PRIVATE HostImpl;
  27 class XBT_PRIVATE HostAction;
  28
  29
  30 }
  31 }
  32
  33 /*********
  34  * Tools *
  35  *********/
  36
  37 XBT_PUBLIC_DATA(simgrid::surf::HostModel*) surf_host_model;
  38
  39 /*********
  40  * Model *
  41  *********/
  42
  43 namespace simgrid {
  44 namespace surf {
  45
  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
  49  */
  50 class HostModel : public Model {
  51 public:
  52   HostModel() : Model() {}
  53
  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);
  57 };
  58
  59 /************
  60  * Resource *
  61  ************/
  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
  65  */
  66 class HostImpl : public simgrid::surf::PropertyHolder {
  67
  68 public:
  69   /**
  70    * @brief Host constructor
  71    *
  72    * @param model HostModel associated to this Host
  73    * @param name The name of the Host
  74    * @param storage The Storage associated to this Host
  75    */
  76   HostImpl(HostModel* model, const char* name, xbt_dynar_t storage);
  77
  78   /* Host destruction logic */
  79   /**************************/
  80   virtual ~HostImpl();
  81
  82 public:
  83   void attach(simgrid::s4u::Host* host);
  84
  85   /** @brief Return the storage of corresponding mount point */
  86   virtual simgrid::surf::Storage *findStorageOnMountList(const char* storage);
  87
  88   /** @brief Get the xbt_dict_t of mount_point: Storage */
  89   virtual xbt_dict_t getMountedStorageList();
  90
  91   /** @brief Get the xbt_dynar_t of storages attached to the Host */
  92   virtual xbt_dynar_t getAttachedStorageList();
  93
  94   /**
  95    * @brief Open a file
  96    *
  97    * @param fullpath The full path to the file
  98    * @return The StorageAction corresponding to the opening
  99    */
 100   virtual Action *open(const char* fullpath);
 101
 102   /**
 103    * @brief Close a file
 104    *
 105    * @param fd The file descriptor to close
 106    * @return The StorageAction corresponding to the closing
 107    */
 108   virtual Action *close(surf_file_t fd);
 109
 110   /**
 111    * @brief Unlink a file
 112    * @details [long description]
 113    *
 114    * @param fd [description]
 115    * @return [description]
 116    */
 117   virtual int unlink(surf_file_t fd);
 118
 119   /**
 120    * @brief Get the size in bytes of the file
 121    *
 122    * @param fd The file descriptor to read
 123    * @return The size in bytes of the file
 124    */
 125   virtual sg_size_t getSize(surf_file_t fd);
 126
 127   /**
 128    * @brief Read a file
 129    *
 130    * @param fd The file descriptor to read
 131    * @param size The size in bytes to read
 132    * @return The StorageAction corresponding to the reading
 133    */
 134   virtual Action *read(surf_file_t fd, sg_size_t size);
 135
 136   /**
 137    * @brief Write a file
 138    *
 139    * @param fd The file descriptor to write
 140    * @param size The size in bytes to write
 141    * @return The StorageAction corresponding to the writing
 142    */
 143   virtual Action *write(surf_file_t fd, sg_size_t size);
 144
 145   /**
 146    * @brief Get the information of a file descriptor
 147    * @details The returned xbt_dynar_t contains:
 148    *  - the size of the file,
 149    *  - the mount point,
 150    *  - the storage name,
 151    *  - the storage typeId,
 152    *  - the storage content type
 153    *
 154    * @param fd The file descriptor
 155    * @return An xbt_dynar_t with the file information
 156    */
 157   virtual xbt_dynar_t getInfo(surf_file_t fd);
 158
 159   /**
 160    * @brief Get the current position of the file descriptor
 161    *
 162    * @param fd The file descriptor
 163    * @return The current position of the file descriptor
 164    */
 165   virtual sg_size_t fileTell(surf_file_t fd);
 166
 167   /**
 168    * @brief Set the position indicator associated with the file descriptor to a new position
 169    * @details [long description]
 170    *
 171    * @param fd The file descriptor
 172    * @param offset The offset from the origin
 173    * @param origin Position used as a reference for the offset
 174    *  - SEEK_SET: beginning of the file
 175    *  - SEEK_CUR: current position indicator
 176    *  - SEEK_END: end of the file
 177    * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
 178    */
 179   virtual int fileSeek(surf_file_t fd, sg_offset_t offset, int origin);
 180
 181   /**
 182    * @brief Move a file to another location on the *same mount point*.
 183    * @details [long description]
 184    *
 185    * @param fd The file descriptor
 186    * @param fullpath The new full path
 187    * @return MSG_OK if successful, MSG_TASK_CANCELED and a warning if the new
 188    * full path is not on the same mount point
 189    */
 190   virtual int fileMove(surf_file_t fd, const char* fullpath);
 191
 192 public:
 193   xbt_dynar_t storage_        = nullptr;
 194   simgrid::s4u::Host* piface_ = nullptr;
 195
 196   /** @brief Get the list of virtual machines on the current Host */
 197   xbt_dynar_t getVms();
 198
 199   /* common with vm */
 200   /** @brief Retrieve a copy of the parameters of that VM/PM
 201    *  @details The ramsize and overcommit fields are used on the PM too */
 202   void getParams(vm_params_t params);
 203   /** @brief Sets the params of that VM/PM */
 204   void setParams(vm_params_t params);
 205   simgrid::s4u::Host* getHost() { return piface_; }
 206 private:
 207   s_vm_params_t params_;
 208 };
 209
 210 }
 211 }
 212
 213 #endif /* SURF_Host_INTERFACE_HPP_ */