Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
change simgrid::surf::Resource into simgrid::kernel::model::Resource
[simgrid.git] / src / surf / cpu_interface.hpp
index b2f4e8a..9a8bdde 100644 (file)
@@ -1,66 +1,22 @@
-/* Copyright (c) 2004-2014. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include "surf_interface.hpp"
-#include "maxmin_private.hpp"
-
 #ifndef SURF_CPU_INTERFACE_HPP_
 #define SURF_CPU_INTERFACE_HPP_
 
+#include "simgrid/s4u/Host.hpp"
+#include "src/kernel/lmm/maxmin.hpp"
+
+#include <list>
+
 /***********
  * Classes *
  ***********/
-class CpuModel;
-typedef CpuModel *CpuModelPtr;
-
-class Cpu;
-typedef Cpu *CpuPtr;
-
-class CpuAction;
-typedef CpuAction *CpuActionPtr;
-
-class CpuPlugin;
-typedef CpuPlugin *CpuPluginPtr;
-
-/*************
- * Callbacks *
- *************/
-XBT_PUBLIC(CpuPtr) getActionCpu(CpuActionPtr action);
-
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emit the callbacks after Cpu creation *
- * @details Callback functions have the following signature: `void(CpuPtr)`
- */
-XBT_PUBLIC_DATA( surf_callback(void, CpuPtr)) cpuCreatedCallbacks;
-
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emit the callbacks after Cpu destruction *
- * @details Callback functions have the following signature: `void(CpuPtr)`
- */
-XBT_PUBLIC_DATA( surf_callback(void, CpuPtr)) cpuDestructedCallbacks;
-
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emit the callbacks after Cpu State changed *
- * @details Callback functions have the following signature: `void(CpuActionPtr action, e_surf_resource_state_t old, e_surf_resource_state_t current)`
- */
-XBT_PUBLIC_DATA( surf_callback(void, CpuPtr, e_surf_resource_state_t, e_surf_resource_state_t)) cpuStateChangedCallbacks;
-
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emit the callbacks after CpuAction State changed *
- * @details Callback functions have the following signature: `void(CpuActionPtr action, e_surf_action_state_t old, e_surf_action_state_t current)`
- */
-XBT_PUBLIC_DATA( surf_callback(void, CpuActionPtr, e_surf_action_state_t, e_surf_action_state_t)) cpuActionStateChangedCallbacks;
-
-XBT_PUBLIC(void) parse_cpu_init(sg_platf_host_cbarg_t host);
 
-XBT_PUBLIC(void) add_traces_cpu();
-
-/*********
- * Model *
- *********/
+namespace simgrid {
+namespace surf {
 
  /** @ingroup SURF_cpu_interface
  * @brief SURF cpu model interface class
@@ -68,31 +24,17 @@ XBT_PUBLIC(void) add_traces_cpu();
  */
 XBT_PUBLIC_CLASS CpuModel : public Model {
 public:
-  /**
-   * @brief CpuModel constructor
-   *
-   * @param name The name of the model
-   */
-  CpuModel(const char *name) : Model(name) {};
-
   /**
    * @brief Create a Cpu
    *
-   * @param host [TODO]
+   * @param host The host that will have this CPU
+   * @param speedPerPstate Processor speed (in Flops) of each pstate. This ignores any potential external load coming from a trace.
+   * @param core The number of core of this Cpu
    */
-  void parseInit(sg_platf_host_cbarg_t host);
-
-  virtual CpuPtr createResource(const char *name, xbt_dynar_t power_peak,
-                      int pstate, double power_scale,
-                          tmgr_trace_t power_trace, int core,
-                          e_surf_resource_state_t state_initial,
-                          tmgr_trace_t state_trace,
-                          xbt_dict_t cpu_properties)=0;
-
-  void updateActionsStateLazy(double now, double delta);
-  void updateActionsStateFull(double now, double delta);
+  virtual Cpu *createCpu(simgrid::s4u::Host *host, std::vector<double> *speedPerPstate, int core)=0;
 
-  virtual void addTraces() =0;
+  void updateActionsStateLazy(double now, double delta) override;
+  void updateActionsStateFull(double now, double delta) override;
 };
 
 /************
@@ -101,45 +43,33 @@ public:
 
 /** @ingroup SURF_cpu_interface
 * @brief SURF cpu resource interface class
-* @details A Cpu represent a cpu associated to a workstation
+* @details A Cpu represent a cpu associated to a host
 */
-XBT_PUBLIC_CLASS Cpu : public Resource {
+XBT_PUBLIC_CLASS Cpu : public simgrid::kernel::model::Resource
+{
 public:
-  /**
-   * @brief Cpu constructor
-   */
-  Cpu();
-
   /**
    * @brief Cpu constructor
    *
    * @param model The CpuModel associated to this Cpu
-   * @param name The name of the Cpu
-   * @param props Dictionary of properties associated to this Cpu
+   * @param host The host in which this Cpu should be plugged
    * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component
+   * @param speedPerPstate Processor speed (in flop per second) for each pstate
    * @param core The number of core of this Cpu
-   * @param powerPeak The power peak of this Cpu
-   * @param powerScale The power scale of this Cpu
    */
-  Cpu(ModelPtr model, const char *name, xbt_dict_t props,
-         lmm_constraint_t constraint, int core, double powerPeak, double powerScale);
+  Cpu(simgrid::surf::Model * model, simgrid::s4u::Host * host, kernel::lmm::Constraint * constraint,
+      std::vector<double> * speedPerPstate, int core);
 
   /**
    * @brief Cpu constructor
    *
    * @param model The CpuModel associated to this Cpu
-   * @param name The name of the Cpu
-   * @param props Dictionary of properties associated to this Cpu
+   * @param host The host in which this Cpu should be plugged
+   * @param speedPerPstate Processor speed (in flop per second) for each pstate
    * @param core The number of core of this Cpu
-   * @param powerPeak The power peak of this Cpu in [TODO]
-   * @param powerScale The power scale of this Cpu in [TODO]
    */
-  Cpu(ModelPtr model, const char *name, xbt_dict_t props,
-         int core, double powerPeak, double powerScale);
+  Cpu(simgrid::surf::Model* model, simgrid::s4u::Host* host, std::vector<double>* speedPerPstate, int core);
 
-  /**
-   * @brief Cpu destructor
-   */
   ~Cpu();
 
   /**
@@ -148,65 +78,63 @@ public:
    * @param size The value of the processing amount (in flop) needed to process
    * @return The CpuAction corresponding to the processing
    */
-  virtual CpuActionPtr execute(double size)=0;
+  virtual simgrid::surf::Action *execution_start(double size)=0;
 
   /**
-   * @brief Make a process sleep for duration (in seconds)
+   * @brief Execute some quantity of computation on more than one core
    *
-   * @param duration The number of seconds to sleep
-   * @return The CpuAction corresponding to the sleeping
+   * @param size The value of the processing amount (in flop) needed to process
+   * @param requestedCores The desired amount of cores. Must be >= 1
+   * @return The CpuAction corresponding to the processing
    */
-  virtual CpuActionPtr sleep(double duration)=0;
+  virtual simgrid::surf::Action* execution_start(double size, int requestedCores)
+  {
+    THROW_UNIMPLEMENTED;
+    return nullptr;
+  }
 
   /**
-   * @brief Get the number of cores of the current Cpu
+   * @brief Make a process sleep for duration (in seconds)
    *
-   * @return The number of cores of the current Cpu
+   * @param duration The number of seconds to sleep
+   * @return The CpuAction corresponding to the sleeping
    */
-  virtual int getCore();
+  virtual simgrid::surf::Action *sleep(double duration)=0;
 
-  /**
-   * @brief Get the speed of the current Cpu
-   * @details [TODO] load * m_powerPeak
-   *
-   * @param load [TODO]
-   *
-   * @return The speed of the current Cpu
-   */
+  /** @brief Get the amount of cores */
+  virtual int coreCount();
+
+  /** @brief Get the speed, accounting for the trace load and provided process load instead of the real current one */
   virtual double getSpeed(double load);
 
-  /**
-   * @brief Get the available speed of the current Cpu
-   * @details [TODO]
-   *
-   * @return The available speed of the current Cpu
-   */
-  virtual double getAvailableSpeed();
+protected:
+  /** @brief Take speed changes (either load or max) into account */
+  virtual void onSpeedChange();
 
-  /**
-   * @brief Get the current Cpu power peak
-   *
-   * @return The current Cpu power peak
-   */
-  virtual double getCurrentPowerPeak();
+public:
+  /** @brief Get the available speed of the current Cpu */
+  virtual double getAvailableSpeed();
 
+  /** @brief Get the current Cpu computational speed */
+  virtual double getPstateSpeed(int pstate_index);
 
-  virtual double getPowerPeakAt(int pstate_index)=0;
+  virtual int getNbPStates();
+  virtual void setPState(int pstate_index);
+  virtual int  getPState();
 
-  virtual int getNbPstates()=0;
+  simgrid::s4u::Host* getHost() { return host_; }
 
-  virtual void setPowerPeakAt(int pstate_index)=0;
+  int coresAmount_ = 1;
+  simgrid::s4u::Host* host_;
 
-  void setState(e_surf_resource_state_t state);
+  std::vector<double> speedPerPstate_; /*< List of supported CPU capacities (pstate related) */
+  int pstate_ = 0;                     /*< Current pstate (index in the speedPeakList)*/
 
-  void addTraces(void);
-  int m_core;
-  double m_powerPeak;            /*< CPU power peak */
-  double m_powerScale;           /*< Percentage of CPU disponible */
+  virtual void setStateTrace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF). Trace must contain boolean values (0 or 1). */
+  virtual void setSpeedTrace(tmgr_trace_t trace); /*< setup the trace file with availability events (peak speed changes due to external load). Trace must contain relative values (ratio between 0 and 1) */
 
-  /* Note (hypervisor): */
-  lmm_constraint_t *p_constraintCore;
-  void **p_constraintCoreId;
+  tmgr_trace_event_t stateEvent_ = nullptr;
+  s_surf_metric_t speed_ = {1.0, 0, nullptr};
 };
 
 /**********
@@ -214,46 +142,37 @@ public:
  **********/
 
  /** @ingroup SURF_cpu_interface
- * @brief SURF Cpu action interface class
- * @details A CpuAction represent the execution of code on a Cpu
+ * @brief A CpuAction represents the execution of code on one or several Cpus
  */
-XBT_PUBLIC_CLASS CpuAction : public Action {
-friend CpuPtr getActionCpu(CpuActionPtr action);
-public:
-  /**
-   * @brief CpuAction constructor
-   *
-   * @param model The CpuModel associated to this CpuAction
-   * @param cost [TODO]
-   * @param failed [TODO]
-   */
-  CpuAction(ModelPtr model, double cost, bool failed)
-    : Action(model, cost, failed) {} //FIXME:REMOVE
+XBT_PUBLIC_CLASS CpuAction : public simgrid::surf::Action {
+  friend XBT_PUBLIC(Cpu*) getActionCpu(CpuAction* action);
 
-  /**
-   * @brief CpuAction constructor
-   *
-   * @param model The CpuModel associated to this CpuAction
-   * @param cost [TODO]
-   * @param failed [TODO]
-   * @param var The lmm variable associated to this CpuAction if it is part of a LMM component
+public:
+  /** @brief Signal emitted when the action state changes (ready/running/done, etc)
+   *  Signature: `void(CpuAction *action, simgrid::surf::Action::State previous)`
    */
-  CpuAction(ModelPtr model, double cost, bool failed, lmm_variable_t var)
-    : Action(model, cost, failed, var) {}
-
-  /**
-   * @brief Set the affinity of the current CpuAction
-   * @details [TODO]
-   *
-   * @param cpu [TODO]
-   * @param mask [TODO]
+  static simgrid::xbt::signal<void(simgrid::surf::CpuAction*, simgrid::surf::Action::State)> onStateChange;
+  /** @brief Signal emitted when the action share changes (amount of flops it gets)
+   *  Signature: `void(CpuAction *action)`
    */
-  virtual void setAffinity(CpuPtr cpu, unsigned long mask);
+  static simgrid::xbt::signal<void(simgrid::surf::CpuAction*)> onShareChange;
 
-  void setState(e_surf_action_state_t state);
+  CpuAction(simgrid::surf::Model* model, double cost, bool failed) : Action(model, cost, failed) {}
+  CpuAction(simgrid::surf::Model * model, double cost, bool failed, kernel::lmm::Variable* var)
+      : Action(model, cost, failed, var)
+  {
+  }
 
-  void updateRemainingLazy(double now);
+  void setState(simgrid::surf::Action::State state) override;
 
+  void updateRemainingLazy(double now) override;
+  std::list<Cpu*> cpus();
+  
+  void suspend() override;
+  void resume() override;
 };
 
+}
+}
+
 #endif /* SURF_CPU_INTERFACE_HPP_ */