Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
add boolean state to resources and protect set_core_count
[simgrid.git] / src / surf / cpu_interface.hpp
index 0215897..b71f146 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2020. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2021. 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. */
@@ -21,13 +21,14 @@ namespace simgrid {
 namespace kernel {
 namespace resource {
 
-/** @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
- */
+class CpuAction;
+
+/*********
+ * Model *
+ *********/
 class XBT_PUBLIC CpuModel : public Model {
 public:
-  explicit CpuModel(Model::UpdateAlgo algo) : Model(algo) {}
+  using Model::Model;
 
   /**
    * @brief Create a Cpu
@@ -47,45 +48,62 @@ public:
  * Resource *
  ************/
 
-class CpuAction;
+class XBT_PUBLIC Cpu : public Resource_T<Cpu> {
+  friend vm::VirtualMachineImpl; // Resets the VCPU
 
-/** @ingroup SURF_cpu_interface
-* @brief SURF cpu resource interface class
-* @details A Cpu represent a cpu associated to a host
-*/
-class XBT_PUBLIC Cpu : public Resource {
+  s4u::Host* piface_;
   int core_count_ = 1;
-  s4u::Host* host_;
   int pstate_ = 0;                       /*< Current pstate (index in the speed_per_pstate_)*/
   std::vector<double> speed_per_pstate_; /*< List of supported CPU capacities (pstate related). Not 'const' because VCPU
                                             get modified on migration */
-  friend simgrid::vm::VirtualMachineImpl; // Resets the VCPU
 
 public:
   /**
    * @brief Cpu constructor
    *
-   * @param model The CpuModel 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 speed_per_pstate Processor speed (in flop per second) for each pstate
    */
-  Cpu(Model* model, s4u::Host* host, lmm::Constraint* constraint, const std::vector<double>& speed_per_pstate,
-      int core);
+  Cpu(s4u::Host* host, const std::vector<double>& speed_per_pstate);
 
-  /**
-   * @brief Cpu constructor
+  Cpu(const Cpu&) = delete;
+  Cpu& operator=(const Cpu&) = delete;
+
+  /** @brief Public interface */
+  s4u::Host* get_iface() { return piface_; }
+
+  Cpu* set_core_count(int core_count);
+  virtual int get_core_count();
+
+  void seal();
+
+  /** @brief Get a forecast of the speed (in flops/s) if the load were as provided.
    *
-   * @param model The CpuModel 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
+   * 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()
    */
-  Cpu(Model* model, s4u::Host* host, const std::vector<double>& speed_per_pstate, int core);
+  virtual double get_speed(double load) const { return load * speed_.peak; }
 
-  Cpu(const Cpu&) = delete;
-  Cpu& operator=(const Cpu&) = delete;
+  /** @brief Get the available speed ratio, in [0:1]. This accounts for external load (see @ref set_speed_profile()). */
+  virtual double get_speed_ratio() { return speed_.scale; }
+
+  /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
+  virtual double get_pstate_peak_speed(int pstate_index) const;
+
+  virtual int get_pstate_count() const { return speed_per_pstate_.size(); }
+
+  virtual void set_pstate(int pstate_index);
+  virtual int get_pstate() const { return pstate_; }
+
+  /*< @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(profile::Profile* profile);
 
   /**
    * @brief Execute some quantity of computation
@@ -112,20 +130,6 @@ public:
    */
   virtual CpuAction* sleep(double duration) = 0;
 
-  /** @brief Get the amount of cores */
-  virtual int get_core_count();
-
-  /** @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) const;
-
 protected:
   /** @brief Take speed changes (either load or max) into account */
   virtual void on_speed_change();
@@ -137,28 +141,6 @@ protected:
    **/
   virtual void reset_vcpu(Cpu* that);
 
-public:
-  /** @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 peak processor speed (in flops/s), at the specified pstate */
-  virtual double get_pstate_peak_speed(int pstate_index) const;
-
-  virtual int get_pstate_count() const;
-  virtual void set_pstate(int pstate_index);
-  virtual int get_pstate() const;
-
-  s4u::Host* get_host() { return host_; }
-
-  /*< @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(profile::Profile* profile);
-
-protected:
   Metric speed_                  = {1.0, 0, nullptr};
 };
 
@@ -176,8 +158,7 @@ public:
    */
   static xbt::signal<void(CpuAction const&, Action::State)> on_state_change;
 
-  CpuAction(Model* model, double cost, bool failed) : Action(model, cost, failed) {}
-  CpuAction(Model* model, double cost, bool failed, lmm::Variable* var) : Action(model, cost, failed, var) {}
+  using Action::Action;
 
   void set_state(Action::State state) override;