src/surf/host_interface.hpp

   1 /* Copyright (c) 2004-2014. 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
  12 #ifndef SURF_HOST_INTERFACE_HPP_
  13 #define SURF_HOST_INTERFACE_HPP_
  14
  15 /***********
  16  * Classes *
  17  ***********/
  18
  19 class HostModel;
  20 class Host;
  21 class HostAction;
  22
  23 /*************
  24  * Callbacks *
  25  *************/
  26
  27 /** @ingroup SURF_callbacks
  28  * @brief Callbacks fired after Host creation. Signature: `void(Host*)`
  29  */
  30 XBT_PUBLIC_DATA(surf_callback(void, Host*)) hostCreatedCallbacks;
  31
  32 /** @ingroup SURF_callbacks
  33  * @brief Callbacks fired Host destruction. Signature: `void(Host*)`
  34  */
  35 XBT_PUBLIC_DATA(surf_callback(void, Host*)) hostDestructedCallbacks;
  36
  37 /** @ingroup SURF_callbacks
  38  * @brief Callbacks fired after Host State changed. Signature: `void(Host *, e_surf_resource_state_t old, e_surf_resource_state_t current)`
  39  */
  40 XBT_PUBLIC_DATA(surf_callback(void, Host*, e_surf_resource_state_t, e_surf_resource_state_t)) hostStateChangedCallbacks;
  41
  42 /** @ingroup SURF_callbacks
  43  * @brief Callbacks fired HostAction State changed. Signature: `void(HostAction *, e_surf_action_state_t old, e_surf_action_state_t current)`
  44  */
  45 XBT_PUBLIC_DATA(surf_callback(void, HostAction*, e_surf_action_state_t, e_surf_action_state_t)) hostActionStateChangedCallbacks;
  46
  47 /*********
  48  * Tools *
  49  *********/
  50 XBT_PUBLIC_DATA(HostModel*) surf_host_model;
  51 XBT_PUBLIC(void) host_parse_init(sg_platf_host_cbarg_t host);
  52 XBT_PUBLIC(void) host_add_traces();
  53
  54 /*********
  55  * Model *
  56  *********/
  57 /** @ingroup SURF_host_interface
  58  * @brief SURF Host model interface class
  59  * @details A model is an object which handle the interactions between its Resources and its Actions
  60  */
  61 class HostModel : public Model {
  62 public:
  63   HostModel() : Model() {}
  64   ~HostModel() {}
  65
  66   virtual Host *createHost(const char *name)=0;
  67   void addTraces(){DIE_IMPOSSIBLE;}
  68
  69   virtual void adjustWeightOfDummyCpuActions();
  70   virtual Action *executeParallelTask(int host_nb,
  71                                       sg_host_t *host_list,
  72                                                                           double *flops_amount,
  73                                                                           double *bytes_amount,
  74                                                                           double rate)=0;
  75
  76   bool shareResourcesIsIdempotent() {return true;}
  77 };
  78
  79 /************
  80  * Resource *
  81  ************/
  82 /** @ingroup SURF_host_interface
  83  * @brief SURF Host interface class
  84  * @details An host represents a machine with a aggregation of a Cpu, a Link and a Storage
  85  */
  86 class Host : public Resource {
  87 public:
  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(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(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   /** @brief Host destructor */
 117   ~ Host();
 118
 119   void setState(e_surf_resource_state_t state);
 120
 121   /**
 122    * @brief Get the properties of the current Host
 123    *
 124    * @return The properties of the current Host
 125    */
 126   xbt_dict_t getProperties();
 127
 128   /**
 129    * @brief Execute some quantity of computation
 130    *
 131    * @param flops_amount The value of the processing amount (in flop) needed to process
 132    * @return The CpuAction corresponding to the processing
 133    * @see Cpu
 134    */
 135   virtual Action *execute(double flops_amount)=0;
 136
 137   /**
 138    * @brief Make a process sleep for duration seconds
 139    *
 140    * @param duration The number of seconds to sleep
 141    * @return The CpuAction corresponding to the sleeping
 142    * @see Cpu
 143    */
 144   virtual Action *sleep(double duration)=0;
 145
 146   /** @brief Return the storage of corresponding mount point */
 147   virtual Storage *findStorageOnMountList(const char* storage);
 148
 149   /** @brief Get the xbt_dict_t of mount_point: Storage */
 150   virtual xbt_dict_t getMountedStorageList();
 151
 152   /** @brief Get the xbt_dynar_t of storages attached to the Host */
 153   virtual xbt_dynar_t getAttachedStorageList();
 154
 155   /**
 156    * @brief Open a file
 157    *
 158    * @param fullpath The full path to the file
 159    *
 160    * @return The StorageAction corresponding to the opening
 161    */
 162   virtual Action *open(const char* fullpath);
 163
 164   /**
 165    * @brief Close a file
 166    *
 167    * @param fd The file descriptor to close
 168    * @return The StorageAction corresponding to the closing
 169    */
 170   virtual Action *close(surf_file_t fd);
 171
 172   /**
 173    * @brief Unlink a file
 174    * @details [long description]
 175    *
 176    * @param fd [description]
 177    * @return [description]
 178    */
 179   virtual int unlink(surf_file_t fd);
 180
 181   /**
 182    * @brief Get the size in bytes of the file
 183    *
 184    * @param fd The file descriptor to read
 185    * @return The size in bytes of the file
 186    */
 187   virtual sg_size_t getSize(surf_file_t fd);
 188
 189   /**
 190    * @brief Read a file
 191    *
 192    * @param fd The file descriptor to read
 193    * @param size The size in bytes to read
 194    * @return The StorageAction corresponding to the reading
 195    */
 196   virtual Action *read(surf_file_t fd, sg_size_t size);
 197
 198   /**
 199    * @brief Write a file
 200    *
 201    * @param fd The file descriptor to write
 202    * @param size The size in bytes to write
 203    * @return The StorageAction corresponding to the writing
 204    */
 205   virtual Action *write(surf_file_t fd, sg_size_t size);
 206
 207   /**
 208    * @brief Get the informations of a file descriptor
 209    * @details The returned xbt_dynar_t contains:
 210    *  - the size of the file,
 211    *  - the mount point,
 212    *  - the storage name,
 213    *  - the storage typeId,
 214    *  - the storage content type
 215    *
 216    * @param fd The file descriptor
 217    * @return An xbt_dynar_t with the file informations
 218    */
 219   virtual xbt_dynar_t getInfo(surf_file_t fd);
 220
 221   /**
 222    * @brief Get the current position of the file descriptor
 223    *
 224    * @param fd The file descriptor
 225    * @return The current position of the file descriptor
 226    */
 227   virtual sg_size_t fileTell(surf_file_t fd);
 228
 229   /**
 230    * @brief Set the position indicator associated with the file descriptor to a new position
 231    * @details [long description]
 232    *
 233    * @param fd The file descriptor
 234    * @param offset The offset from the origin
 235    * @param origin Position used as a reference for the offset
 236    *  - SEEK_SET: beginning of the file
 237    *  - SEEK_CUR: current position indicator
 238    *  - SEEK_END: end of the file
 239    * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
 240    */
 241   virtual int fileSeek(surf_file_t fd, sg_offset_t offset, int origin);
 242
 243   /**
 244    * @brief Move a file to another location on the *same mount point*.
 245    * @details [long description]
 246    *
 247    * @param fd The file descriptor
 248    * @param fullpath The new full path
 249    * @return MSG_OK if successful, MSG_TASK_CANCELED and a warning if the new
 250    * full path is not on the same mount point
 251    */
 252   virtual int fileMove(surf_file_t fd, const char* fullpath);
 253
 254   xbt_dynar_t p_storage;
 255   RoutingEdge *p_netElm;
 256   Cpu *p_cpu;
 257
 258   /** @brief Get the list of virtual machines on the current Host */
 259   xbt_dynar_t getVms();
 260
 261   /* common with vm */
 262   /** @brief Retrieve a copy of the parameters of that VM/PM
 263    *  @details The ramsize and overcommit fields are used on the PM too */
 264   void getParams(vm_params_t params);
 265   /** @brief Sets the params of that VM/PM */
 266   void setParams(vm_params_t params);
 267 private:
 268   s_vm_params_t p_params;
 269 };
 270
 271 /**********
 272  * Action *
 273  **********/
 274
 275 /** @ingroup SURF_host_interface
 276  * @brief SURF host action interface class
 277  */
 278 class HostAction : public Action {
 279 public:
 280   /**
 281    * @brief HostAction constructor
 282    *
 283    * @param model The HostModel associated to this HostAction
 284    * @param cost The cost of this HostAction in [TODO]
 285    * @param failed [description]
 286    */
 287   HostAction(Model *model, double cost, bool failed)
 288   : Action(model, cost, failed) {}
 289
 290   /**
 291    * @brief HostAction constructor
 292    *
 293    * @param model The HostModel associated to this HostAction
 294    * @param cost The cost of this HostAction in [TODO]
 295    * @param failed [description]
 296    * @param var The lmm variable associated to this StorageAction if it is part of a LMM component
 297    */
 298   HostAction(Model *model, double cost, bool failed, lmm_variable_t var)
 299   : Action(model, cost, failed, var) {}
 300
 301   void setState(e_surf_action_state_t state);
 302 };
 303
 304
 305 #endif /* SURF_Host_INTERFACE_HPP_ */