Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
add some missing 'override' markers in the surf::Host hierarchy
[simgrid.git] / src / surf / host_interface.hpp
index 71ee1b7..8fde63d 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2014. The SimGrid Team.
+/* Copyright (c) 2004-2015. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
@@ -8,6 +8,9 @@
 #include "storage_interface.hpp"
 #include "cpu_interface.hpp"
 #include "network_interface.hpp"
+#include "src/surf/PropertyHolder.hpp"
+
+#include <xbt/base.h>
 
 #ifndef SURF_HOST_INTERFACE_HPP_
 #define SURF_HOST_INTERFACE_HPP_
  * Classes *
  ***********/
 
-class HostModel;
-typedef HostModel *HostModelPtr;
-
-class Host;
-typedef Host *HostPtr;
+namespace simgrid {
+namespace surf {
 
-class HostAction;
-typedef HostAction *HostActionPtr;
+class XBT_PRIVATE HostModel;
+class XBT_PRIVATE Host;
+class XBT_PRIVATE HostAction;
 
 /*************
  * Callbacks *
  *************/
 
 /** @ingroup SURF_callbacks
- * @brief Callbacks handler which emit the callbacks after Host creation *
- * @details Callback functions have the following signature: `void(HostPtr)`
+ * @brief Callbacks fired after Host creation. Signature: `void(Host*)`
  */
-XBT_PUBLIC_DATA(surf_callback(void, HostPtr)) hostCreatedCallbacks;
+XBT_PUBLIC_DATA(simgrid::surf::signal<void(Host*)>) hostCreatedCallbacks;
 
 /** @ingroup SURF_callbacks
- * @brief Callbacks handler which emit the callbacks after Host destruction *
- * @details Callback functions have the following signature: `void(HostPtr)`
+ * @brief Callbacks fired Host destruction. Signature: `void(Host*)`
  */
-XBT_PUBLIC_DATA(surf_callback(void, HostPtr)) hostDestructedCallbacks;
+XBT_PUBLIC_DATA(simgrid::surf::signal<void(Host*)>) hostDestructedCallbacks;
 
 /** @ingroup SURF_callbacks
- * @brief Callbacks handler which emit the callbacks after Host State changed *
- * @details Callback functions have the following signature: `void(HostActionPtr action, e_surf_resource_state_t old, e_surf_resource_state_t current)`
+ * @brief Callbacks fired after Host State changed. Signature: `void(Host *, e_surf_resource_state_t old, e_surf_resource_state_t current)`
  */
-XBT_PUBLIC_DATA(surf_callback(void, HostPtr, e_surf_resource_state_t, e_surf_resource_state_t)) hostStateChangedCallbacks;
+XBT_PUBLIC_DATA(simgrid::surf::signal<void(Host*, e_surf_resource_state_t, e_surf_resource_state_t)>) hostStateChangedCallbacks;
 
 /** @ingroup SURF_callbacks
- * @brief Callbacks handler which emit the callbacks after HostAction State changed *
- * @details Callback functions have the following signature: `void(HostActionPtr action, e_surf_resource_state_t old, e_surf_resource_state_t current)`
+ * @brief Callbacks fired HostAction State changed. Signature: `void(HostAction *, e_surf_action_state_t old, e_surf_action_state_t current)`
  */
-XBT_PUBLIC_DATA(surf_callback(void, HostActionPtr, e_surf_action_state_t, e_surf_action_state_t)) hostActionStateChangedCallbacks;
+XBT_PUBLIC_DATA(simgrid::surf::signal<void(HostAction*, e_surf_action_state_t, e_surf_action_state_t)>) hostActionStateChangedCallbacks;
+
+}
+}
 
 /*********
  * Tools *
  *********/
-XBT_PUBLIC_DATA(HostModelPtr) surf_host_model;
-XBT_PUBLIC(void) host_parse_init(sg_platf_host_cbarg_t host);
+XBT_PUBLIC_DATA(simgrid::surf::HostModel*) surf_host_model;
 XBT_PUBLIC(void) host_add_traces();
 
 /*********
  * Model *
  *********/
+
+namespace simgrid {
+namespace surf {
+
 /** @ingroup SURF_host_interface
  * @brief SURF Host model interface class
  * @details A model is an object which handle the interactions between its Resources and its Actions
  */
 class HostModel : public Model {
 public:
-    /**
-   * @brief HostModel constructor
-   *
-   * @param name the name of the model
-   */
-  HostModel(const char *name);
-
-  /** @brief HostModel constructor */
-  HostModel();
-
-  /** @brief HostModel destructor */
-  ~HostModel();
+  HostModel() : Model() {}
+  ~HostModel() {}
 
-  virtual HostPtr createHost(const char *name)=0;
-  void addTraces(){DIE_IMPOSSIBLE;}
+  virtual Host *createHost(const char *name, RoutingEdge *net, Cpu *cpu, xbt_dict_t props)=0;
+  void addTraces() override {DIE_IMPOSSIBLE;}
 
-  /**
-   * @brief [brief description]
-   * @details [long description]
-   */
   virtual void adjustWeightOfDummyCpuActions();
+  virtual Action *executeParallelTask(int host_nb,
+                                      sg_host_t *host_list,
+                                                                         double *flops_amount,
+                                                                         double *bytes_amount,
+                                                                         double rate)=0;
 
-  /**
-   * @brief [brief description]
-   * @details [long description]
-   *
-   * @param host_nb [description]
-   * @param host_list [description]
-   * @param flops_amount [description]
-   * @param bytes_amount [description]
-   * @param rate [description]
-   * @return [description]
-   */
-  virtual ActionPtr executeParallelTask(int host_nb,
-                                        void **host_list,
-                                        double *flops_amount,
-                                        double *bytes_amount,
-                                        double rate)=0;
-
- /**
-  * @brief [brief description]
-  * @details [long description]
-  *
-  * @param src [description]
-  * @param dst [description]
-  * @param size [description]
-  * @param rate [description]
-  * @return [description]
-  */
- virtual ActionPtr communicate(HostPtr src, HostPtr dst, double size, double rate)=0;
-
- CpuModelPtr p_cpuModel;
+  bool shareResourcesIsIdempotent() override {return true;}
 };
 
 /************
@@ -128,10 +93,13 @@ public:
  ************/
 /** @ingroup SURF_host_interface
  * @brief SURF Host interface class
- * @details An host represents a machine with a aggregation of a Cpu, a NetworkLink and a Storage
+ * @details An host represents a machine with a aggregation of a Cpu, a Link and a Storage
  */
-class Host : public Resource {
+class Host : public simgrid::surf::Resource,
+                public simgrid::surf::PropertyHolder {
 public:
+  static simgrid::xbt::Extension<simgrid::Host, Host> EXTENSION_ID;
+  static void init();
   /**
    * @brief Host constructor
    *
@@ -142,8 +110,8 @@ public:
    * @param netElm The RoutingEdge associated to this Host
    * @param cpu The Cpu associated to this Host
    */
-  Host(ModelPtr model, const char *name, xbt_dict_t props,
-                     xbt_dynar_t storage, RoutingEdgePtr netElm, CpuPtr cpu);
+  Host(simgrid::surf::Model *model, const char *name, xbt_dict_t props,
+                     xbt_dynar_t storage, RoutingEdge *netElm, Cpu *cpu);
 
   /**
    * @brief Host constructor
@@ -156,22 +124,16 @@ public:
    * @param netElm The RoutingEdge associated to this Host
    * @param cpu The Cpu associated to this Host
    */
-  Host(ModelPtr model, const char *name, xbt_dict_t props,
-      lmm_constraint_t constraint, xbt_dynar_t storage, RoutingEdgePtr netElm,
-      CpuPtr cpu);
+  Host(simgrid::surf::Model *model, const char *name, xbt_dict_t props,
+      lmm_constraint_t constraint, xbt_dynar_t storage, RoutingEdge *netElm,
+      Cpu *cpu);
 
   /** @brief Host destructor */
-  ~ Host();
+  ~Host();
 
+  void attach(simgrid::Host* host);
   void setState(e_surf_resource_state_t state);
 
-  /**
-   * @brief Get the properties of the current Host
-   *
-   * @return The properties of the current Host
-   */
-  xbt_dict_t getProperties();
-
   /**
    * @brief Execute some quantity of computation
    *
@@ -179,7 +141,7 @@ public:
    * @return The CpuAction corresponding to the processing
    * @see Cpu
    */
-  virtual ActionPtr execute(double flops_amount)=0;
+  virtual Action *execute(double flops_amount)=0;
 
   /**
    * @brief Make a process sleep for duration seconds
@@ -188,67 +150,15 @@ public:
    * @return The CpuAction corresponding to the sleeping
    * @see Cpu
    */
-  virtual ActionPtr sleep(double duration)=0;
-
-  /**
-   * @brief Get the number of cores of the associated Cpu
-   *
-   * @return The number of cores of the associated Cpu
-   * @see Cpu
-   */
-  virtual int getCore();
+  virtual Action *sleep(double duration)=0;
 
-  /**
-   * @brief Get the speed of the associated Cpu
-   *
-   * @param load [TODO]
-   * @return The speed of the associated Cpu
-   * @see Cpu
-   */
-  virtual double getSpeed(double load);
+  /** @brief Return the storage of corresponding mount point */
+  virtual simgrid::surf::Storage *findStorageOnMountList(const char* storage);
 
-  /**
-   * @brief Get the available speed of the associated Cpu
-   * @details [TODO]
-   *
-   * @return The available speed of the associated Cpu
-   * @see Cpu
-   */
-  virtual double getAvailableSpeed();
-
-  /**
-   * @brief Get the associated Cpu power peak
-   *
-   * @return The associated Cpu power peak
-   * @see Cpu
-   */
-  virtual double getCurrentPowerPeak();
-
-  virtual double getPowerPeakAt(int pstate_index);
-  virtual int getNbPstates();
-  virtual void setPstate(int pstate_index);
-  virtual int  getPstate();
-
-  /**
-   * @brief Return the storage of corresponding mount point
-   *
-   * @param storage The mount point
-   * @return The corresponding Storage
-   */
-  virtual StoragePtr findStorageOnMountList(const char* storage);
-
-  /**
-   * @brief Get the xbt_dict_t of mount_point: Storage
-   *
-   * @return The xbt_dict_t of mount_point: Storage
-   */
+  /** @brief Get the xbt_dict_t of mount_point: Storage */
   virtual xbt_dict_t getMountedStorageList();
 
-  /**
-   * @brief Get the xbt_dynar_t of storages attached to the Host
-   *
-   * @return The xbt_dynar_t of Storage names
-   */
+  /** @brief Get the xbt_dynar_t of storages attached to the Host */
   virtual xbt_dynar_t getAttachedStorageList();
 
   /**
@@ -258,7 +168,7 @@ public:
    *
    * @return The StorageAction corresponding to the opening
    */
-  virtual ActionPtr open(const char* fullpath);
+  virtual Action *open(const char* fullpath);
 
   /**
    * @brief Close a file
@@ -266,7 +176,7 @@ public:
    * @param fd The file descriptor to close
    * @return The StorageAction corresponding to the closing
    */
-  virtual ActionPtr close(surf_file_t fd);
+  virtual Action *close(surf_file_t fd);
 
   /**
    * @brief Unlink a file
@@ -292,7 +202,7 @@ public:
    * @param size The size in bytes to read
    * @return The StorageAction corresponding to the reading
    */
-  virtual ActionPtr read(surf_file_t fd, sg_size_t size);
+  virtual Action *read(surf_file_t fd, sg_size_t size);
 
   /**
    * @brief Write a file
@@ -301,7 +211,7 @@ public:
    * @param size The size in bytes to write
    * @return The StorageAction corresponding to the writing
    */
-  virtual ActionPtr write(surf_file_t fd, sg_size_t size);
+  virtual Action *write(surf_file_t fd, sg_size_t size);
 
   /**
    * @brief Get the informations of a file descriptor
@@ -350,35 +260,27 @@ public:
    */
   virtual int fileMove(surf_file_t fd, const char* fullpath);
 
+protected:
+  void onDie() override;
+
+public:
   xbt_dynar_t p_storage;
-  RoutingEdgePtr p_netElm;
-  CpuPtr p_cpu;
-  NetworkLinkPtr p_network;
+  RoutingEdge *p_netElm;
+  Cpu *p_cpu;
+  simgrid::Host* p_host = nullptr;
 
-  /**
-   * @brief Get the list of virtual machines on the current Host
-   *
-   * @return The list of VMs
-   */
+  /** @brief Get the list of virtual machines on the current Host */
   xbt_dynar_t getVms();
 
   /* common with vm */
-  /**
-   * @brief [brief description]
-   * @details [long description]
-   *
-   * @param params [description]
-   */
-  void getParams(ws_params_t params);
-
-  /**
-   * @brief [brief description]
-   * @details [long description]
-   *
-   * @param params [description]
-   */
-  void setParams(ws_params_t params);
-  s_ws_params_t p_params;
+  /** @brief Retrieve a copy of the parameters of that VM/PM
+   *  @details The ramsize and overcommit fields are used on the PM too */
+  void getParams(vm_params_t params);
+  /** @brief Sets the params of that VM/PM */
+  void setParams(vm_params_t params);
+  simgrid::Host* getHost() { return p_host; }
+private:
+  s_vm_params_t p_params;
 };
 
 /**********
@@ -397,7 +299,7 @@ public:
    * @param cost The cost of this HostAction in [TODO]
    * @param failed [description]
    */
-  HostAction(ModelPtr model, double cost, bool failed)
+  HostAction(simgrid::surf::Model *model, double cost, bool failed)
   : Action(model, cost, failed) {}
 
   /**
@@ -408,11 +310,13 @@ public:
    * @param failed [description]
    * @param var The lmm variable associated to this StorageAction if it is part of a LMM component
    */
-  HostAction(ModelPtr model, double cost, bool failed, lmm_variable_t var)
+  HostAction(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var)
   : Action(model, cost, failed, var) {}
 
   void setState(e_surf_action_state_t state);
 };
 
+}
+}
 
 #endif /* SURF_Host_INTERFACE_HPP_ */