Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove unused type definitions.
[simgrid.git] / src / surf / cpu_interface.hpp
index 790e61c..93bc683 100644 (file)
@@ -1,25 +1,19 @@
-/* Copyright (c) 2004-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2004-2019. 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 <list>
-
-#include <xbt/base.h>
-#include <xbt/signal.hpp>
-
-#include <simgrid/forward.h>
-#include <simgrid/s4u/host.hpp>
-
-#include "surf/datatypes.h"
-#include "surf_interface.hpp"
-#include "maxmin_private.hpp"
-#include "trace_mgr.hpp"
-
 #ifndef SURF_CPU_INTERFACE_HPP_
 #define SURF_CPU_INTERFACE_HPP_
 
+#include "simgrid/kernel/resource/Model.hpp"
+#include "simgrid/kernel/resource/Resource.hpp"
+#include "simgrid/s4u/Host.hpp"
+#include "src/kernel/lmm/maxmin.hpp"
+#include "src/kernel/resource/profile/trace_mgr.hpp"
+
+#include <list>
+
 /***********
  * Classes *
  ***********/
 namespace simgrid {
 namespace surf {
 
-class CpuModel;
-class Cpu;
-class CpuAction;
-
  /** @ingroup SURF_cpu_interface
  * @brief SURF cpu model interface class
  * @details A model is an object which handle the interactions between its Resources and its Actions
  */
-XBT_PUBLIC_CLASS CpuModel : public Model {
+class XBT_PUBLIC CpuModel : public kernel::resource::Model {
 public:
-  CpuModel() : Model() {};
-  ~CpuModel() = default;
+  explicit CpuModel(kernel::resource::Model::UpdateAlgo algo) : Model(algo) {}
 
   /**
    * @brief Create a Cpu
    *
    * @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 speed_per_pstate 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
    */
-  virtual Cpu *createCpu(simgrid::s4u::Host *host, std::vector<double> *speedPerPstate, int core)=0;
+  virtual Cpu* create_cpu(simgrid::s4u::Host* host, std::vector<double>* speed_per_pstate, int core) = 0;
 
-  void updateActionsStateLazy(double now, double delta) override;
-  void updateActionsStateFull(double now, double delta) override;
-  bool next_occuring_event_isIdempotent() override;
+  void update_actions_state_lazy(double now, double delta) override;
+  void update_actions_state_full(double now, double delta) override;
 };
 
 /************
@@ -62,7 +51,7 @@ public:
 * @brief SURF cpu resource interface class
 * @details A Cpu represent a cpu associated to a host
 */
-XBT_PUBLIC_CLASS Cpu : public simgrid::surf::Resource {
+class XBT_PUBLIC Cpu : public simgrid::kernel::resource::Resource {
 public:
   /**
    * @brief Cpu constructor
@@ -73,8 +62,8 @@ public:
    * @param speedPerPstate Processor speed (in flop per second) for each pstate
    * @param core The number of core of this Cpu
    */
-  Cpu(simgrid::surf::Model *model, simgrid::s4u::Host *host, lmm_constraint_t constraint,
-      std::vector<double> *speedPerPstate, int core);
+  Cpu(simgrid::kernel::resource::Model * model, simgrid::s4u::Host * host, kernel::lmm::Constraint * constraint,
+      std::vector<double> * speedPerPstate, int core);
 
   /**
    * @brief Cpu constructor
@@ -84,8 +73,11 @@ public:
    * @param speedPerPstate Processor speed (in flop per second) for each pstate
    * @param core The number of core of this Cpu
    */
-  Cpu(simgrid::surf::Model *model, simgrid::s4u::Host *host, std::vector<double> *speedPerPstate, int core);
+  Cpu(simgrid::kernel::resource::Model * model, simgrid::s4u::Host * host, std::vector<double> * speedPerPstate,
+      int core);
 
+  Cpu(const Cpu&) = delete;
+  Cpu& operator=(const Cpu&) = delete;
   ~Cpu();
 
   /**
@@ -94,7 +86,16 @@ public:
    * @param size The value of the processing amount (in flop) needed to process
    * @return The CpuAction corresponding to the processing
    */
-  virtual simgrid::surf::Action *execution_start(double size)=0;
+  virtual simgrid::kernel::resource::Action* execution_start(double size) = 0;
+
+  /**
+   * @brief Execute some quantity of computation on more than one core
+   *
+   * @param size The value of the processing amount (in flop) needed to process
+   * @param requested_cores The desired amount of cores. Must be >= 1
+   * @return The CpuAction corresponding to the processing
+   */
+  virtual simgrid::kernel::resource::Action* execution_start(double size, int requested_cores) = 0;
 
   /**
    * @brief Make a process sleep for duration (in seconds)
@@ -102,45 +103,57 @@ public:
    * @param duration The number of seconds to sleep
    * @return The CpuAction corresponding to the sleeping
    */
-  virtual simgrid::surf::Action *sleep(double duration)=0;
+  virtual simgrid::kernel::resource::Action* sleep(double duration) = 0;
 
   /** @brief Get the amount of cores */
-  virtual int getCoreCount();
+  virtual int get_core_count();
 
-  /** @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 a forecast of the speed (in flops/s) if the load were as provided.
+   *
+   * The provided load should encompasses both the application's activities and the external load that come from a trace.
+   *
+   * Use a load of 1.0 to compute the amount of flops that the Cpu would deliver with one CPU-bound task.
+   * If you use a load of 0, this function will return 0: when nobody is using the Cpu, it delivers nothing.
+   *
+   * If you want to know the amount of flops currently delivered, use  load = get_load()*get_speed_ratio()
+   */
+  virtual double get_speed(double load);
 
 protected:
   /** @brief Take speed changes (either load or max) into account */
-  virtual void onSpeedChange();
+  virtual void on_speed_change();
 
 public:
-  /** @brief Get the available speed of the current Cpu */
-  virtual double getAvailableSpeed();
+  /** @brief Get the available speed ratio, between 0 and 1.
+   *
+   * This accounts for external load (see @ref set_speed_trace()).
+   */
+  virtual double get_speed_ratio();
 
-  /** @brief Get the current Cpu computational speed */
-  virtual double getPstateSpeedCurrent();
-  virtual double getPstateSpeed(int pstate_index);
+  /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
+  virtual double get_pstate_peak_speed(int pstate_index);
 
-  virtual int getNbPStates();
-  virtual void setPState(int pstate_index);
-  virtual int  getPState();
+  virtual int get_pstate_count();
+  virtual void set_pstate(int pstate_index);
+  virtual int get_pstate();
 
-  simgrid::s4u::Host* getHost() { return host_; }
+  simgrid::s4u::Host* get_host() { return host_; }
 
-public:
-  int coresAmount_ = 1;
+private:
+  int core_count_ = 1;
   simgrid::s4u::Host* host_;
 
-  std::vector<double> speedPerPstate_; /*< List of supported CPU capacities (pstate related) */
-  int pstate_ = 0;                     /*< Current pstate (index in the speedPeakList)*/
+  int pstate_ = 0;                       /*< Current pstate (index in the speed_per_pstate_)*/
+  std::vector<double> speed_per_pstate_; /*< List of supported CPU capacities (pstate related) */
 
 public:
-  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) */
+  /*< @brief Setup the trace file with availability events (peak speed changes due to external load).
+   * Trace must contain relative values (ratio between 0 and 1)
+   */
+  virtual void set_speed_profile(kernel::profile::Profile* profile);
 
-  tmgr_trace_iterator_t stateEvent_ = nullptr;
-  s_surf_metric_t speed_ = {1.0, 0, nullptr};
+protected:
+  Metric speed_                  = {1.0, 0, nullptr};
 };
 
 /**********
@@ -150,27 +163,30 @@ public:
  /** @ingroup SURF_cpu_interface
  * @brief A CpuAction represents the execution of code on one or several Cpus
  */
-XBT_PUBLIC_CLASS CpuAction : public simgrid::surf::Action {
-friend XBT_PUBLIC(Cpu*) getActionCpu(CpuAction *action);
+class XBT_PUBLIC CpuAction : public simgrid::kernel::resource::Action {
 public:
-/** @brief Signal emitted when the action state changes (ready/running/done, etc)
*  Signature: `void(CpuAction *action, simgrid::surf::Action::State previous)`
- */
-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)`
- */
-static simgrid::xbt::signal<void(simgrid::surf::CpuAction*)> onShareChange;
+  /** @brief Signal emitted when the action state changes (ready/running/done, etc)
  *  Signature: `void(CpuAction *action, simgrid::kernel::resource::Action::State previous)`
  */
+  static simgrid::xbt::signal<void(simgrid::surf::CpuAction*, simgrid::kernel::resource::Action::State)> on_state_change;
+  /** @brief Signal emitted when the action share changes (amount of flops it gets)
  *  Signature: `void(CpuAction *action)`
  */
+  static simgrid::xbt::signal<void(simgrid::surf::CpuAction*)> on_share_change;
 
-  CpuAction(simgrid::surf::Model *model, double cost, bool failed)
-  : Action(model, cost, failed) {}
-  CpuAction(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var)
-  : Action(model, cost, failed, var) {}
+  CpuAction(simgrid::kernel::resource::Model * model, double cost, bool failed) : Action(model, cost, failed) {}
+  CpuAction(simgrid::kernel::resource::Model * model, double cost, bool failed, kernel::lmm::Variable* var)
+      : Action(model, cost, failed, var)
+  {
+  }
 
-  void setState(simgrid::surf::Action::State state) override;
+  void set_state(simgrid::kernel::resource::Action::State state) override;
 
-  void updateRemainingLazy(double now) override;
+  void update_remains_lazy(double now) override;
   std::list<Cpu*> cpus();
+
+  void suspend() override;
+  void resume() override;
 };
 
 }