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, NetCard *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   /**
  88    * @brief Host constructor
  89    *
  90    * @param model HostModel associated to this Host
  91    * @param name The name of the Host
  92    * @param props Dictionary of properties associated to this Host
  93    * @param storage The Storage associated to this Host
  94    * @param netElm The RoutingEdge associated to this Host
  95    * @param cpu The Cpu associated to this Host
  96    */
  97   Host(simgrid::surf::Model *model, const char *name, xbt_dict_t props,
  98                       xbt_dynar_t storage, NetCard *netElm, Cpu *cpu);
  99
 100   /**
 101    * @brief Host constructor
 102    *
 103    * @param model HostModel associated to this Host
 104    * @param name The name of the Host
 105    * @param props Dictionary of properties associated to this Host
 106    * @param constraint The lmm constraint associated to this Host if it is part of a LMM component
 107    * @param storage The Storage associated to this Host
 108    * @param netElm The RoutingEdge associated to this Host
 109    * @param cpu The Cpu associated to this Host
 110    */
 111   Host(simgrid::surf::Model *model, const char *name, xbt_dict_t props,
 112       lmm_constraint_t constraint, xbt_dynar_t storage, NetCard *netElm,
 113       Cpu *cpu);
 114
 115   /* Host destruction logic */
 116   /**************************/
 117 protected:
 118   ~Host();
 119 public:
 120         void destroy(); // Must be called instead of the destructor
 121 private:
 122         bool currentlyDestroying_ = false;
 123
 124
 125 public:
 126   void attach(simgrid::Host* host);
 127
 128   e_surf_resource_state_t getState();
 129   void setState(e_surf_resource_state_t state);
 130
 131   /** @brief Return the storage of corresponding mount point */
 132   virtual simgrid::surf::Storage *findStorageOnMountList(const char* storage);
 133
 134   /** @brief Get the xbt_dict_t of mount_point: Storage */
 135   virtual xbt_dict_t getMountedStorageList();
 136
 137   /** @brief Get the xbt_dynar_t of storages attached to the Host */
 138   virtual xbt_dynar_t getAttachedStorageList();
 139
 140   /**
 141    * @brief Open a file
 142    *
 143    * @param fullpath The full path to the file
 144    * @return The StorageAction corresponding to the opening
 145    */
 146   virtual Action *open(const char* fullpath);
 147
 148   /**
 149    * @brief Close a file
 150    *
 151    * @param fd The file descriptor to close
 152    * @return The StorageAction corresponding to the closing
 153    */
 154   virtual Action *close(surf_file_t fd);
 155
 156   /**
 157    * @brief Unlink a file
 158    * @details [long description]
 159    *
 160    * @param fd [description]
 161    * @return [description]
 162    */
 163   virtual int unlink(surf_file_t fd);
 164
 165   /**
 166    * @brief Get the size in bytes of the file
 167    *
 168    * @param fd The file descriptor to read
 169    * @return The size in bytes of the file
 170    */
 171   virtual sg_size_t getSize(surf_file_t fd);
 172
 173   /**
 174    * @brief Read a file
 175    *
 176    * @param fd The file descriptor to read
 177    * @param size The size in bytes to read
 178    * @return The StorageAction corresponding to the reading
 179    */
 180   virtual Action *read(surf_file_t fd, sg_size_t size);
 181
 182   /**
 183    * @brief Write a file
 184    *
 185    * @param fd The file descriptor to write
 186    * @param size The size in bytes to write
 187    * @return The StorageAction corresponding to the writing
 188    */
 189   virtual Action *write(surf_file_t fd, sg_size_t size);
 190
 191   /**
 192    * @brief Get the informations of a file descriptor
 193    * @details The returned xbt_dynar_t contains:
 194    *  - the size of the file,
 195    *  - the mount point,
 196    *  - the storage name,
 197    *  - the storage typeId,
 198    *  - the storage content type
 199    *
 200    * @param fd The file descriptor
 201    * @return An xbt_dynar_t with the file informations
 202    */
 203   virtual xbt_dynar_t getInfo(surf_file_t fd);
 204
 205   /**
 206    * @brief Get the current position of the file descriptor
 207    *
 208    * @param fd The file descriptor
 209    * @return The current position of the file descriptor
 210    */
 211   virtual sg_size_t fileTell(surf_file_t fd);
 212
 213   /**
 214    * @brief Set the position indicator associated with the file descriptor to a new position
 215    * @details [long description]
 216    *
 217    * @param fd The file descriptor
 218    * @param offset The offset from the origin
 219    * @param origin Position used as a reference for the offset
 220    *  - SEEK_SET: beginning of the file
 221    *  - SEEK_CUR: current position indicator
 222    *  - SEEK_END: end of the file
 223    * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
 224    */
 225   virtual int fileSeek(surf_file_t fd, sg_offset_t offset, int origin);
 226
 227   /**
 228    * @brief Move a file to another location on the *same mount point*.
 229    * @details [long description]
 230    *
 231    * @param fd The file descriptor
 232    * @param fullpath The new full path
 233    * @return MSG_OK if successful, MSG_TASK_CANCELED and a warning if the new
 234    * full path is not on the same mount point
 235    */
 236   virtual int fileMove(surf_file_t fd, const char* fullpath);
 237
 238   bool isUsed() override {DIE_IMPOSSIBLE;} // FIXME: Host should not be a Resource
 239   void updateState(tmgr_trace_event_t event_type, double value, double date) override
 240     {THROW_IMPOSSIBLE;} // FIXME: Host should not be a Resource
 241
 242 public:
 243   xbt_dynar_t p_storage;
 244   NetCard *p_netElm;
 245   Cpu *p_cpu;
 246   simgrid::Host* p_host = nullptr;
 247
 248   /** @brief Get the list of virtual machines on the current Host */
 249   xbt_dynar_t getVms();
 250
 251   /* common with vm */
 252   /** @brief Retrieve a copy of the parameters of that VM/PM
 253    *  @details The ramsize and overcommit fields are used on the PM too */
 254   void getParams(vm_params_t params);
 255   /** @brief Sets the params of that VM/PM */
 256   void setParams(vm_params_t params);
 257   simgrid::Host* getHost() { return p_host; }
 258 private:
 259   s_vm_params_t p_params;
 260 };
 261
 262 }
 263 }
 264
 265 #endif /* SURF_Host_INTERFACE_HPP_ */