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 storage The Storage associated to this Host
  73    */
  74   HostImpl(s4u::Host* host, xbt_dynar_t storage);
  75
  76   /* Host destruction logic */
  77   /**************************/
  78   virtual ~HostImpl();
  79
  80 public:
  81   /** @brief Return the storage of corresponding mount point */
  82   virtual simgrid::surf::Storage *findStorageOnMountList(const char* storage);
  83
  84   /** @brief Get the xbt_dict_t of mount_point: Storage */
  85   virtual xbt_dict_t getMountedStorageList();
  86
  87   /** @brief Get the xbt_dynar_t of storages attached to the Host */
  88   virtual xbt_dynar_t getAttachedStorageList();
  89
  90   /**
  91    * @brief Open a file
  92    *
  93    * @param fullpath The full path to the file
  94    * @return The StorageAction corresponding to the opening
  95    */
  96   virtual Action *open(const char* fullpath);
  97
  98   /**
  99    * @brief Close a file
 100    *
 101    * @param fd The file descriptor to close
 102    * @return The StorageAction corresponding to the closing
 103    */
 104   virtual Action *close(surf_file_t fd);
 105
 106   /**
 107    * @brief Unlink a file
 108    * @details [long description]
 109    *
 110    * @param fd [description]
 111    * @return [description]
 112    */
 113   virtual int unlink(surf_file_t fd);
 114
 115   /**
 116    * @brief Get the size in bytes of the file
 117    *
 118    * @param fd The file descriptor to read
 119    * @return The size in bytes of the file
 120    */
 121   virtual sg_size_t getSize(surf_file_t fd);
 122
 123   /**
 124    * @brief Read a file
 125    *
 126    * @param fd The file descriptor to read
 127    * @param size The size in bytes to read
 128    * @return The StorageAction corresponding to the reading
 129    */
 130   virtual Action *read(surf_file_t fd, sg_size_t size);
 131
 132   /**
 133    * @brief Write a file
 134    *
 135    * @param fd The file descriptor to write
 136    * @param size The size in bytes to write
 137    * @return The StorageAction corresponding to the writing
 138    */
 139   virtual Action *write(surf_file_t fd, sg_size_t size);
 140
 141   /**
 142    * @brief Get the information of a file descriptor
 143    * @details The returned xbt_dynar_t contains:
 144    *  - the size of the file,
 145    *  - the mount point,
 146    *  - the storage name,
 147    *  - the storage typeId,
 148    *  - the storage content type
 149    *
 150    * @param fd The file descriptor
 151    * @return An xbt_dynar_t with the file information
 152    */
 153   virtual xbt_dynar_t getInfo(surf_file_t fd);
 154
 155   /**
 156    * @brief Get the current position of the file descriptor
 157    *
 158    * @param fd The file descriptor
 159    * @return The current position of the file descriptor
 160    */
 161   virtual sg_size_t fileTell(surf_file_t fd);
 162
 163   /**
 164    * @brief Set the position indicator associated with the file descriptor to a new position
 165    * @details [long description]
 166    *
 167    * @param fd The file descriptor
 168    * @param offset The offset from the origin
 169    * @param origin Position used as a reference for the offset
 170    *  - SEEK_SET: beginning of the file
 171    *  - SEEK_CUR: current position indicator
 172    *  - SEEK_END: end of the file
 173    * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
 174    */
 175   virtual int fileSeek(surf_file_t fd, sg_offset_t offset, int origin);
 176
 177   /**
 178    * @brief Move a file to another location on the *same mount point*.
 179    * @details [long description]
 180    *
 181    * @param fd The file descriptor
 182    * @param fullpath The new full path
 183    * @return MSG_OK if successful, MSG_TASK_CANCELED and a warning if the new
 184    * full path is not on the same mount point
 185    */
 186   virtual int fileMove(surf_file_t fd, const char* fullpath);
 187
 188 public:
 189   xbt_dynar_t storage_        = nullptr;
 190   simgrid::s4u::Host* piface_ = nullptr;
 191
 192   /** @brief Get the list of virtual machines on the current Host */
 193   xbt_dynar_t getVms();
 194
 195   /* common with vm */
 196   /** @brief Retrieve a copy of the parameters of that VM/PM
 197    *  @details The ramsize and overcommit fields are used on the PM too */
 198   void getParams(vm_params_t params);
 199   /** @brief Sets the params of that VM/PM */
 200   void setParams(vm_params_t params);
 201   simgrid::s4u::Host* getHost() { return piface_; }
 202 private:
 203   s_vm_params_t params_;
 204 };
 205
 206 }
 207 }
 208
 209 #endif /* SURF_Host_INTERFACE_HPP_ */