src/surf/host_interface.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 Host;
  27 class XBT_PRIVATE HostAction;
  28
  29
  30 }
  31 }
  32
  33 /*********
  34  * Tools *
  35  *********/
  36 XBT_PUBLIC_DATA(simgrid::surf::HostModel*) surf_host_model;
  37 XBT_PUBLIC(void) host_add_traces();
  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   ~HostModel() {}
  54
  55   Host *createHost(const char *name, RoutingEdge *net, Cpu *cpu, xbt_dict_t props);
  56   void addTraces() override {DIE_IMPOSSIBLE;}
  57
  58   virtual void adjustWeightOfDummyCpuActions();
  59   virtual Action *executeParallelTask(int host_nb,
  60                                       sg_host_t *host_list,
  61                                                                           double *flops_amount,
  62                                                                           double *bytes_amount,
  63                                                                           double rate)=0;
  64
  65   bool shareResourcesIsIdempotent() override {return true;}
  66 };
  67
  68 /************
  69  * Resource *
  70  ************/
  71 /** @ingroup SURF_host_interface
  72  * @brief SURF Host interface class
  73  * @details An host represents a machine with a aggregation of a Cpu, a RoutingEdge and a Storage
  74  */
  75 class Host :
  76          public simgrid::surf::Resource,
  77          public simgrid::surf::PropertyHolder {
  78 public:
  79   static simgrid::xbt::Extension<simgrid::Host, Host> EXTENSION_ID;
  80
  81   /* callbacks */
  82   static simgrid::surf::signal<void(Host*)> onCreation;    /** Called on each newly created object */
  83   static simgrid::surf::signal<void(Host*)> onDestruction; /** Called just before destructing an object */
  84   static simgrid::surf::signal<void(simgrid::surf::Host*, e_surf_resource_state_t, e_surf_resource_state_t)> onStateChange;
  85
  86 public:
  87   static void classInit(); // must be called before the first use of that class
  88   /**
  89    * @brief Host constructor
  90    *
  91    * @param model HostModel associated to this Host
  92    * @param name The name of the Host
  93    * @param props Dictionary of properties associated to this Host
  94    * @param storage The Storage associated to this Host
  95    * @param netElm The RoutingEdge associated to this Host
  96    * @param cpu The Cpu associated to this Host
  97    */
  98   Host(simgrid::surf::Model *model, const char *name, xbt_dict_t props,
  99                       xbt_dynar_t storage, RoutingEdge *netElm, Cpu *cpu);
 100
 101   /**
 102    * @brief Host constructor
 103    *
 104    * @param model HostModel associated to this Host
 105    * @param name The name of the Host
 106    * @param props Dictionary of properties associated to this Host
 107    * @param constraint The lmm constraint associated to this Host if it is part of a LMM component
 108    * @param storage The Storage associated to this Host
 109    * @param netElm The RoutingEdge associated to this Host
 110    * @param cpu The Cpu associated to this Host
 111    */
 112   Host(simgrid::surf::Model *model, const char *name, xbt_dict_t props,
 113       lmm_constraint_t constraint, xbt_dynar_t storage, RoutingEdge *netElm,
 114       Cpu *cpu);
 115
 116   /* Host destruction logic */
 117   /**************************/
 118 protected:
 119   ~Host();
 120 public:
 121         void destroy(); // Must be called instead of the destructor
 122 private:
 123         bool currentlyDestroying_ = false;
 124
 125
 126 public:
 127   void attach(simgrid::Host* host);
 128
 129   e_surf_resource_state_t getState();
 130   void setState(e_surf_resource_state_t state);
 131
 132   /** @brief Return the storage of corresponding mount point */
 133   virtual simgrid::surf::Storage *findStorageOnMountList(const char* storage);
 134
 135   /** @brief Get the xbt_dict_t of mount_point: Storage */
 136   virtual xbt_dict_t getMountedStorageList();
 137
 138   /** @brief Get the xbt_dynar_t of storages attached to the Host */
 139   virtual xbt_dynar_t getAttachedStorageList();
 140
 141   /**
 142    * @brief Open a file
 143    *
 144    * @param fullpath The full path to the file
 145    * @return The StorageAction corresponding to the opening
 146    */
 147   virtual Action *open(const char* fullpath);
 148
 149   /**
 150    * @brief Close a file
 151    *
 152    * @param fd The file descriptor to close
 153    * @return The StorageAction corresponding to the closing
 154    */
 155   virtual Action *close(surf_file_t fd);
 156
 157   /**
 158    * @brief Unlink a file
 159    * @details [long description]
 160    *
 161    * @param fd [description]
 162    * @return [description]
 163    */
 164   virtual int unlink(surf_file_t fd);
 165
 166   /**
 167    * @brief Get the size in bytes of the file
 168    *
 169    * @param fd The file descriptor to read
 170    * @return The size in bytes of the file
 171    */
 172   virtual sg_size_t getSize(surf_file_t fd);
 173
 174   /**
 175    * @brief Read a file
 176    *
 177    * @param fd The file descriptor to read
 178    * @param size The size in bytes to read
 179    * @return The StorageAction corresponding to the reading
 180    */
 181   virtual Action *read(surf_file_t fd, sg_size_t size);
 182
 183   /**
 184    * @brief Write a file
 185    *
 186    * @param fd The file descriptor to write
 187    * @param size The size in bytes to write
 188    * @return The StorageAction corresponding to the writing
 189    */
 190   virtual Action *write(surf_file_t fd, sg_size_t size);
 191
 192   /**
 193    * @brief Get the informations of a file descriptor
 194    * @details The returned xbt_dynar_t contains:
 195    *  - the size of the file,
 196    *  - the mount point,
 197    *  - the storage name,
 198    *  - the storage typeId,
 199    *  - the storage content type
 200    *
 201    * @param fd The file descriptor
 202    * @return An xbt_dynar_t with the file informations
 203    */
 204   virtual xbt_dynar_t getInfo(surf_file_t fd);
 205
 206   /**
 207    * @brief Get the current position of the file descriptor
 208    *
 209    * @param fd The file descriptor
 210    * @return The current position of the file descriptor
 211    */
 212   virtual sg_size_t fileTell(surf_file_t fd);
 213
 214   /**
 215    * @brief Set the position indicator associated with the file descriptor to a new position
 216    * @details [long description]
 217    *
 218    * @param fd The file descriptor
 219    * @param offset The offset from the origin
 220    * @param origin Position used as a reference for the offset
 221    *  - SEEK_SET: beginning of the file
 222    *  - SEEK_CUR: current position indicator
 223    *  - SEEK_END: end of the file
 224    * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
 225    */
 226   virtual int fileSeek(surf_file_t fd, sg_offset_t offset, int origin);
 227
 228   /**
 229    * @brief Move a file to another location on the *same mount point*.
 230    * @details [long description]
 231    *
 232    * @param fd The file descriptor
 233    * @param fullpath The new full path
 234    * @return MSG_OK if successful, MSG_TASK_CANCELED and a warning if the new
 235    * full path is not on the same mount point
 236    */
 237   virtual int fileMove(surf_file_t fd, const char* fullpath);
 238
 239   bool isUsed() override {DIE_IMPOSSIBLE;} // FIXME: Host should not be a Resource
 240   void updateState(tmgr_trace_event_t event_type, double value, double date) override
 241     {THROW_IMPOSSIBLE;} // FIXME: Host should not be a Resource
 242
 243 public:
 244   xbt_dynar_t p_storage;
 245   RoutingEdge *p_netElm;
 246   Cpu *p_cpu;
 247   simgrid::Host* p_host = nullptr;
 248
 249   /** @brief Get the list of virtual machines on the current Host */
 250   xbt_dynar_t getVms();
 251
 252   /* common with vm */
 253   /** @brief Retrieve a copy of the parameters of that VM/PM
 254    *  @details The ramsize and overcommit fields are used on the PM too */
 255   void getParams(vm_params_t params);
 256   /** @brief Sets the params of that VM/PM */
 257   void setParams(vm_params_t params);
 258   simgrid::Host* getHost() { return p_host; }
 259 private:
 260   s_vm_params_t p_params;
 261 };
 262
 263 }
 264 }
 265
 266 #endif /* SURF_Host_INTERFACE_HPP_ */