src/surf/cpu_interface.hpp

   1 /* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SURF_CPU_INTERFACE_HPP_
   7 #define SURF_CPU_INTERFACE_HPP_
   8
   9 #include "simgrid/kernel/resource/Model.hpp"
  10 #include "simgrid/kernel/resource/Resource.hpp"
  11 #include "simgrid/s4u/Host.hpp"
  12 #include "src/kernel/lmm/maxmin.hpp"
  13
  14 #include <list>
  15
  16 /***********
  17  * Classes *
  18  ***********/
  19
  20 namespace simgrid {
  21 namespace surf {
  22
  23  /** @ingroup SURF_cpu_interface
  24  * @brief SURF cpu model interface class
  25  * @details A model is an object which handle the interactions between its Resources and its Actions
  26  */
  27 class XBT_PUBLIC CpuModel : public kernel::resource::Model {
  28 public:
  29   CpuModel(kernel::resource::Model::UpdateAlgo algo) : Model(algo) {}
  30   CpuModel() : Model() {}
  31
  32   /**
  33    * @brief Create a Cpu
  34    *
  35    * @param host The host that will have this CPU
  36    * @param speedPerPstate Processor speed (in Flops) of each pstate. This ignores any potential external load coming from a trace.
  37    * @param core The number of core of this Cpu
  38    */
  39   virtual Cpu *createCpu(simgrid::s4u::Host *host, std::vector<double> *speedPerPstate, int core)=0;
  40
  41   void update_actions_state_lazy(double now, double delta) override;
  42   void update_actions_state_full(double now, double delta) override;
  43 };
  44
  45 /************
  46  * Resource *
  47  ************/
  48
  49 /** @ingroup SURF_cpu_interface
  50 * @brief SURF cpu resource interface class
  51 * @details A Cpu represent a cpu associated to a host
  52 */
  53 class XBT_PUBLIC Cpu : public simgrid::kernel::resource::Resource {
  54 public:
  55   /**
  56    * @brief Cpu constructor
  57    *
  58    * @param model The CpuModel associated to this Cpu
  59    * @param host The host in which this Cpu should be plugged
  60    * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component
  61    * @param speedPerPstate Processor speed (in flop per second) for each pstate
  62    * @param core The number of core of this Cpu
  63    */
  64   Cpu(simgrid::kernel::resource::Model * model, simgrid::s4u::Host * host, kernel::lmm::Constraint * constraint,
  65       std::vector<double> * speedPerPstate, int core);
  66
  67   /**
  68    * @brief Cpu constructor
  69    *
  70    * @param model The CpuModel associated to this Cpu
  71    * @param host The host in which this Cpu should be plugged
  72    * @param speedPerPstate Processor speed (in flop per second) for each pstate
  73    * @param core The number of core of this Cpu
  74    */
  75   Cpu(simgrid::kernel::resource::Model * model, simgrid::s4u::Host * host, std::vector<double> * speedPerPstate,
  76       int core);
  77
  78   ~Cpu();
  79
  80   /**
  81    * @brief Execute some quantity of computation
  82    *
  83    * @param size The value of the processing amount (in flop) needed to process
  84    * @return The CpuAction corresponding to the processing
  85    */
  86   virtual simgrid::kernel::resource::Action* execution_start(double size) = 0;
  87
  88   /**
  89    * @brief Execute some quantity of computation on more than one core
  90    *
  91    * @param size The value of the processing amount (in flop) needed to process
  92    * @param requestedCores The desired amount of cores. Must be >= 1
  93    * @return The CpuAction corresponding to the processing
  94    */
  95   virtual simgrid::kernel::resource::Action* execution_start(double size, int requestedCores) = 0;
  96
  97   /**
  98    * @brief Make a process sleep for duration (in seconds)
  99    *
 100    * @param duration The number of seconds to sleep
 101    * @return The CpuAction corresponding to the sleeping
 102    */
 103   virtual simgrid::kernel::resource::Action* sleep(double duration) = 0;
 104
 105   /** @brief Get the amount of cores */
 106   virtual int coreCount();
 107
 108   /** @brief Get the speed, accounting for the trace load and provided process load instead of the real current one */
 109   virtual double getSpeed(double load);
 110
 111 protected:
 112   /** @brief Take speed changes (either load or max) into account */
 113   virtual void onSpeedChange();
 114
 115 public:
 116   /** @brief Get the available speed of the current Cpu */
 117   virtual double getAvailableSpeed();
 118
 119   /** @brief Get the current Cpu computational speed */
 120   virtual double getPstateSpeed(int pstate_index);
 121
 122   virtual int getNbPStates();
 123   virtual void setPState(int pstate_index);
 124   virtual int  getPState();
 125
 126   simgrid::s4u::Host* getHost() { return host_; }
 127
 128   int coresAmount_ = 1;
 129   simgrid::s4u::Host* host_;
 130
 131   std::vector<double> speedPerPstate_; /*< List of supported CPU capacities (pstate related) */
 132   int pstate_ = 0;                     /*< Current pstate (index in the speedPeakList)*/
 133
 134   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). */
 135   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) */
 136
 137   tmgr_trace_event_t stateEvent_ = nullptr;
 138   Metric speed_                  = {1.0, 0, nullptr};
 139 };
 140
 141 /**********
 142  * Action *
 143  **********/
 144
 145  /** @ingroup SURF_cpu_interface
 146  * @brief A CpuAction represents the execution of code on one or several Cpus
 147  */
 148 class XBT_PUBLIC CpuAction : public simgrid::kernel::resource::Action {
 149   friend XBT_PUBLIC Cpu* getActionCpu(CpuAction * action);
 150
 151 public:
 152   /** @brief Signal emitted when the action state changes (ready/running/done, etc)
 153    *  Signature: `void(CpuAction *action, simgrid::kernel::resource::Action::State previous)`
 154    */
 155   static simgrid::xbt::signal<void(simgrid::surf::CpuAction*, simgrid::kernel::resource::Action::State)> onStateChange;
 156   /** @brief Signal emitted when the action share changes (amount of flops it gets)
 157    *  Signature: `void(CpuAction *action)`
 158    */
 159   static simgrid::xbt::signal<void(simgrid::surf::CpuAction*)> onShareChange;
 160
 161   CpuAction(simgrid::kernel::resource::Model * model, double cost, bool failed) : Action(model, cost, failed) {}
 162   CpuAction(simgrid::kernel::resource::Model * model, double cost, bool failed, kernel::lmm::Variable* var)
 163       : Action(model, cost, failed, var)
 164   {
 165   }
 166
 167   void set_state(simgrid::kernel::resource::Action::State state) override;
 168
 169   void update_remains_lazy(double now) override;
 170   std::list<Cpu*> cpus();
 171
 172   void suspend() override;
 173   void resume() override;
 174 };
 175
 176 }
 177 }
 178
 179 #endif /* SURF_CPU_INTERFACE_HPP_ */