-/* Copyright (c) 2004-2018. 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. */
***********/
namespace simgrid {
-namespace surf {
+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 XBT_PUBLIC CpuModel : public kernel::resource::Model {
+class CpuAction;
+
+/*********
+ * Model *
+ *********/
+class XBT_PUBLIC CpuModel : public Model {
public:
+ using Model::Model;
+
/**
* @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(s4u::Host* host, const std::vector<double>& speed_per_pstate, int core) = 0;
- void updateActionsStateLazy(double now, double delta) override;
- void updateActionsStateFull(double now, double delta) override;
+ void update_actions_state_lazy(double now, double delta) override;
+ void update_actions_state_full(double now, double delta) override;
};
/************
* Resource *
************/
-/** @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 simgrid::kernel::resource::Resource {
+class XBT_PUBLIC Cpu : public Resource_T<Cpu> {
+ friend vm::VirtualMachineImpl; // Resets the VCPU
+
+ s4u::Host* piface_;
+ int core_count_ = 1;
+ 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 */
+
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(simgrid::kernel::resource::Model * model, simgrid::s4u::Host * host, kernel::lmm::Constraint * constraint,
- std::vector<double> * speedPerPstate, 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(simgrid::kernel::resource::Model * model, simgrid::s4u::Host * host, std::vector<double> * speedPerPstate,
- int core);
+ virtual double get_speed(double load) const { return load * speed_.peak; }
+
+ /** @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; }
- ~Cpu();
+ /** @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
* @param size The value of the processing amount (in flop) needed to process
* @return The CpuAction corresponding to the processing
*/
- virtual simgrid::kernel::resource::Action* execution_start(double size) = 0;
+ virtual CpuAction* 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 requestedCores The desired amount of cores. Must be >= 1
+ * @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 requestedCores) = 0;
+ virtual CpuAction* execution_start(double size, int requested_cores) = 0;
/**
* @brief Make a process sleep for duration (in seconds)
* @param duration The number of seconds to sleep
* @return The CpuAction corresponding to the sleeping
*/
- virtual simgrid::kernel::resource::Action* sleep(double duration) = 0;
-
- /** @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);
+ virtual CpuAction* sleep(double duration) = 0;
protected:
/** @brief Take speed changes (either load or max) into account */
- virtual void onSpeedChange();
-
-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 void on_speed_change();
- virtual int getNbPStates();
- virtual void setPState(int pstate_index);
- virtual int getPState();
-
- simgrid::s4u::Host* getHost() { return host_; }
-
- int coresAmount_ = 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)*/
-
- 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) */
+ /** Reset most characteristics of this CPU to the one of that CPU.
+ *
+ * Used to reset a VCPU when its VM migrates to another host, so it only resets the fields that should be in this
+ *case.
+ **/
+ virtual void reset_vcpu(Cpu* that);
- tmgr_trace_event_t stateEvent_ = nullptr;
Metric speed_ = {1.0, 0, nullptr};
};
/** @ingroup SURF_cpu_interface
* @brief A CpuAction represents the execution of code on one or several Cpus
*/
-class XBT_PUBLIC CpuAction : public simgrid::kernel::resource::Action {
- friend XBT_PUBLIC Cpu* getActionCpu(CpuAction * action);
-
+class XBT_PUBLIC CpuAction : public Action {
public:
/** @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)> onStateChange;
- /** @brief Signal emitted when the action share changes (amount of flops it gets)
- * Signature: `void(CpuAction *action)`
+ * Signature: `void(CpuAction const& action, simgrid::kernel::resource::Action::State previous)`
*/
- static simgrid::xbt::signal<void(simgrid::surf::CpuAction*)> onShareChange;
+ static xbt::signal<void(CpuAction const&, Action::State)> on_state_change;
- 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)
- {
- }
+ using Action::Action;
- void set_state(simgrid::kernel::resource::Action::State state) override;
+ void set_state(Action::State state) override;
void update_remains_lazy(double now) override;
- std::list<Cpu*> cpus();
-
+ std::list<Cpu*> cpus() const;
+
void suspend() override;
void resume() override;
};
-
-}
-}
+} // namespace resource
+} // namespace kernel
+} // namespace simgrid
#endif /* SURF_CPU_INTERFACE_HPP_ */
