Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Revert "remove a C-like pimple"
[simgrid.git] / src / surf / host_interface.hpp
index 5752a64..236ccdb 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;
-class Host;
-class HostAction;
-
-/*************
- * Callbacks *
- *************/
-
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emit the callbacks after Host creation *
- * @details Callback functions have the following signature: `void(HostPtr)`
- */
-XBT_PUBLIC_DATA(surf_callback(void, Host*)) hostCreatedCallbacks;
+namespace simgrid {
+namespace surf {
 
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emit the callbacks after Host destruction *
- * @details Callback functions have the following signature: `void(HostPtr)`
- */
-XBT_PUBLIC_DATA(surf_callback(void, Host*)) hostDestructedCallbacks;
+class XBT_PRIVATE HostModel;
+class XBT_PRIVATE Host;
+class XBT_PRIVATE HostAction;
 
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emit the callbacks after Host State changed *
- * @details Callback functions have the following signature: `void(HostAction *action, e_surf_resource_state_t old, e_surf_resource_state_t current)`
- */
-XBT_PUBLIC_DATA(surf_callback(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(HostAction *action, e_surf_resource_state_t old, e_surf_resource_state_t current)`
- */
-XBT_PUBLIC_DATA(surf_callback(void, HostAction*, e_surf_action_state_t, e_surf_action_state_t)) hostActionStateChangedCallbacks;
+}
+}
 
 /*********
  * Tools *
  *********/
-XBT_PUBLIC_DATA(HostModel*) 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 {
+class HostModel : public Model{
 public:
-    /**
-   * @brief HostModel constructor
-   *
-   * @param name the name of the model
-   */
-  HostModel(const char *name);
-
-  /** @brief HostModel constructor */
-  HostModel();
+  HostModel() : Model() {}
+  ~HostModel() {}
 
-  /** @brief HostModel destructor */
-  ~HostModel();
+  Host *createHost(const char *name, NetCard *net, Cpu *cpu, xbt_dict_t props);
+  void addTraces() override {DIE_IMPOSSIBLE;}
 
-  virtual Host *createHost(const char *name)=0;
-  void addTraces(){DIE_IMPOSSIBLE;}
-
-  /**
-   * @brief [brief description]
-   * @details [long description]
-   */
   virtual void adjustWeightOfDummyCpuActions();
-
-  /**
-   * @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 Action *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 Action *communicate(Host *src, Host *dst, double size, double rate)=0;
-
- CpuModel *p_cpuModel;
+                                      sg_host_t *host_list,
+                                                                         double *flops_amount,
+                                                                         double *bytes_amount,
+                                                                         double rate)=0;
+
+  bool shareResourcesIsIdempotent() override {return true;}
 };
 
 /************
@@ -123,10 +70,21 @@ public:
  ************/
 /** @ingroup SURF_host_interface
  * @brief SURF Host interface class
- * @details An host represents a machine with a aggregation of a Cpu, a Link and a Storage
+ * @details An host represents a machine with a aggregation of a Cpu, a RoutingEdge 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;
+
+  /* callbacks */
+  static simgrid::surf::signal<void(Host*)> onCreation;    /** Called on each newly created object */
+  static simgrid::surf::signal<void(Host*)> onDestruction; /** Called just before destructing an object */
+  static simgrid::surf::signal<void(Host*)> onStateChange; /** Called when the machine is turned on or off */
+
+public:
+  static void classInit(); // must be called before the first use of that class
   /**
    * @brief Host constructor
    *
@@ -134,11 +92,10 @@ public:
    * @param name The name of the Host
    * @param props Dictionary of properties associated to this Host
    * @param storage The Storage associated to this Host
-   * @param netElm The RoutingEdge associated to this Host
    * @param cpu The Cpu associated to this Host
    */
-  Host(Model *model, const char *name, xbt_dict_t props,
-                     xbt_dynar_t storage, RoutingEdge *netElm, Cpu *cpu);
+  Host(simgrid::surf::Model *model, const char *name, xbt_dict_t props,
+                     xbt_dynar_t storage, Cpu *cpu);
 
   /**
    * @brief Host constructor
@@ -148,109 +105,42 @@ public:
    * @param props Dictionary of properties associated to this Host
    * @param constraint The lmm constraint associated to this Host if it is part of a LMM component
    * @param storage The Storage associated to this Host
-   * @param netElm The RoutingEdge associated to this Host
    * @param cpu The Cpu associated to this Host
    */
-  Host(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();
-
-  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
-   *
-   * @param flops_amount The value of the processing amount (in flop) needed to process
-   * @return The CpuAction corresponding to the processing
-   * @see Cpu
-   */
-  virtual Action *execute(double flops_amount)=0;
+  Host(simgrid::surf::Model *model, const char *name, xbt_dict_t props,
+      lmm_constraint_t constraint, xbt_dynar_t storage, Cpu *cpu);
 
-  /**
-   * @brief Make a process sleep for duration seconds
-   *
-   * @param duration The number of seconds to sleep
-   * @return The CpuAction corresponding to the sleeping
-   * @see Cpu
-   */
-  virtual Action *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();
-
-  /**
-   * @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);
+  /* Host destruction logic */
+  /**************************/
+protected:
+  ~Host();
+public:
+       void destroy(); // Must be called instead of the destructor
+private:
+       bool currentlyDestroying_ = false;
 
-  /**
-   * @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();
+public:
+  void attach(simgrid::Host* host);
 
-  virtual double getPowerPeakAt(int pstate_index);
-  virtual int getNbPstates();
-  virtual void setPstate(int pstate_index);
-  virtual int  getPstate();
+  bool isOn() override;
+  bool isOff() override;
+  void turnOn() override;
+  void turnOff() override;
 
-  /**
-   * @brief Return the storage of corresponding mount point
-   *
-   * @param storage The mount point
-   * @return The corresponding Storage
-   */
-  virtual Storage *findStorageOnMountList(const char* storage);
+  /** @brief Return the storage of corresponding mount point */
+  virtual simgrid::surf::Storage *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();
 
   /**
    * @brief Open a file
    *
    * @param fullpath The full path to the file
-   *
    * @return The StorageAction corresponding to the opening
    */
   virtual Action *open(const char* fullpath);
@@ -345,68 +235,30 @@ public:
    */
   virtual int fileMove(surf_file_t fd, const char* fullpath);
 
+  bool isUsed() override {DIE_IMPOSSIBLE;} // FIXME: Host should not be a Resource
+  void updateState(tmgr_trace_event_t event_type, double value, double date) override
+    {THROW_IMPOSSIBLE;} // FIXME: Host should not be a Resource
+
+public:
   xbt_dynar_t p_storage;
-  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;
-};
-
-/**********
- * Action *
- **********/
-
-/** @ingroup SURF_host_interface
- * @brief SURF host action interface class
- */
-class HostAction : public Action {
-public:
-  /**
-   * @brief HostAction constructor
-   *
-   * @param model The HostModel associated to this HostAction
-   * @param cost The cost of this HostAction in [TODO]
-   * @param failed [description]
-   */
-  HostAction(Model *model, double cost, bool failed)
-  : Action(model, cost, failed) {}
-
-  /**
-   * @brief HostAction constructor
-   *
-   * @param model The HostModel associated to this HostAction
-   * @param cost The cost of this HostAction in [TODO]
-   * @param failed [description]
-   * @param var The lmm variable associated to this StorageAction if it is part of a LMM component
-   */
-  HostAction(Model *model, double cost, bool failed, lmm_variable_t var)
-  : Action(model, cost, failed, var) {}
-
-  void setState(e_surf_action_state_t state);
+  /** @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;
 };
 
+}
+}
 
 #endif /* SURF_Host_INTERFACE_HPP_ */