src/surf/HostImpl.hpp

   1 /* Copyright (c) 2004-2016. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "surf_interface.hpp"
   7 #include "cpu_interface.hpp"
   8 #include "network_interface.hpp"
   9 #include "src/surf/PropertyHolder.hpp"
  10
  11 #include "StorageImpl.hpp"
  12 #include <xbt/base.h>
  13
  14 #ifndef SURF_HOST_INTERFACE_HPP_
  15 #define SURF_HOST_INTERFACE_HPP_
  16
  17 /***********
  18  * Classes *
  19  ***********/
  20
  21 namespace simgrid {
  22 namespace surf {
  23
  24 class XBT_PRIVATE HostModel;
  25 class XBT_PRIVATE HostImpl;
  26 class XBT_PRIVATE HostAction;
  27 }
  28 }
  29
  30 /*********
  31  * Tools *
  32  *********/
  33
  34 XBT_PUBLIC_DATA(simgrid::surf::HostModel*) surf_host_model;
  35
  36 /*********
  37  * Model *
  38  *********/
  39
  40 namespace simgrid {
  41 namespace surf {
  42
  43 /** @ingroup SURF_host_interface
  44  * @brief SURF Host model interface class
  45  * @details A model is an object which handle the interactions between its Resources and its Actions
  46  */
  47 class HostModel : public Model {
  48 public:
  49   HostModel() : Model() {}
  50
  51   virtual void ignoreEmptyVmInPmLMM();
  52   virtual Action* executeParallelTask(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount,
  53                                       double rate);
  54 };
  55
  56 /************
  57  * Resource *
  58  ************/
  59 /** @ingroup SURF_host_interface
  60  * @brief SURF Host interface class
  61  * @details An host represents a machine with a aggregation of a Cpu, a RoutingEdge and a Storage
  62  */
  63 class HostImpl : public simgrid::surf::PropertyHolder {
  64
  65 public:
  66   explicit HostImpl(s4u::Host* host);
  67   virtual ~HostImpl() = default;
  68
  69   /** @brief Return the storage of corresponding mount point */
  70   virtual simgrid::surf::StorageImpl* findStorageOnMountList(const char* storage);
  71
  72   /** @brief Get the xbt_dynar_t of storages attached to the Host */
  73   virtual void getAttachedStorageList(std::vector<const char*>* storages);
  74
  75   /**
  76    * @brief Close a file
  77    *
  78    * @param fd The file descriptor to close
  79    * @return The StorageAction corresponding to the closing
  80    */
  81   virtual Action* close(surf_file_t fd);
  82
  83   /**
  84    * @brief Unlink a file
  85    * @details [long description]
  86    *
  87    * @param fd [description]
  88    * @return [description]
  89    */
  90   virtual int unlink(surf_file_t fd);
  91
  92   /**
  93    * @brief Get the size in bytes of the file
  94    *
  95    * @param fd The file descriptor to read
  96    * @return The size in bytes of the file
  97    */
  98   virtual sg_size_t getSize(surf_file_t fd);
  99
 100   /**
 101    * @brief Read a file
 102    *
 103    * @param fd The file descriptor to read
 104    * @param size The size in bytes to read
 105    * @return The StorageAction corresponding to the reading
 106    */
 107   virtual Action* read(surf_file_t fd, sg_size_t size);
 108
 109   /**
 110    * @brief Write a file
 111    *
 112    * @param fd The file descriptor to write
 113    * @param size The size in bytes to write
 114    * @return The StorageAction corresponding to the writing
 115    */
 116   virtual Action* write(surf_file_t fd, sg_size_t size);
 117
 118   /**
 119    * @brief Get the current position of the file descriptor
 120    *
 121    * @param fd The file descriptor
 122    * @return The current position of the file descriptor
 123    */
 124   virtual sg_size_t fileTell(surf_file_t fd);
 125
 126   /**
 127    * @brief Set the position indicator associated with the file descriptor to a new position
 128    * @details [long description]
 129    *
 130    * @param fd The file descriptor
 131    * @param offset The offset from the origin
 132    * @param origin Position used as a reference for the offset
 133    *  - SEEK_SET: beginning of the file
 134    *  - SEEK_CUR: current position indicator
 135    *  - SEEK_END: end of the file
 136    * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
 137    */
 138   virtual int fileSeek(surf_file_t fd, sg_offset_t offset, int origin);
 139
 140   /**
 141    * @brief Move a file to another location on the *same mount point*.
 142    * @details [long description]
 143    *
 144    * @param fd The file descriptor
 145    * @param fullpath The new full path
 146    * @return MSG_OK if successful, MSG_TASK_CANCELED and a warning if the new
 147    * full path is not on the same mount point
 148    */
 149   virtual int fileMove(surf_file_t fd, const char* fullpath);
 150
 151   std::map<std::string, simgrid::surf::StorageImpl*> storage_;
 152   simgrid::s4u::Host* piface_ = nullptr;
 153
 154   simgrid::s4u::Host* getHost() { return piface_; }
 155 };
 156 }
 157 }
 158
 159 #endif /* SURF_Host_INTERFACE_HPP_ */