-/* Copyright (c) 2004-2015. 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. */
-#include "surf_interface.hpp"
-#include "maxmin_private.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 <list>
+
/***********
* Classes *
***********/
namespace simgrid {
-namespace surf {
+namespace kernel {
+namespace resource {
-class CpuModel;
-class Cpu;
class CpuAction;
-class CpuPlugin;
-
-/*************
- * Callbacks *
- *************/
-XBT_PUBLIC(Cpu*) getActionCpu(CpuAction *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, Cpu*)) 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, Cpu*)) cpuDestructedCallbacks;
-
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emit the callbacks after Cpu State changed *
- * @details Callback functions have the following signature: `void(CpuAction *action, e_surf_resource_state_t old, e_surf_resource_state_t current)`
- */
-XBT_PUBLIC_DATA( surf_callback(void, Cpu*, 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(CpuAction *action, e_surf_action_state_t old, e_surf_action_state_t current)`
- */
-XBT_PUBLIC_DATA( surf_callback(void, CpuAction*, e_surf_action_state_t, e_surf_action_state_t)) cpuActionStateChangedCallbacks;
-
-XBT_PUBLIC(void) cpu_add_traces();
/*********
* Model *
*********/
-
- /** @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 Model {
public:
- CpuModel() : Model() {};
+ using Model::Model;
/**
* @brief Create a Cpu
*
- * @param name The name of the Cpu
- * @param speedPeak The peak spead (max speed in Flops)
- * @param pstate [TODO]
- * @param speedScale The speed scale (in [O;1] available speed from peak)
- * @param speedTrace Trace variations
+ * @param host The host that will have this CPU
+ * @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
- * @param state_initial [TODO]
- * @param state_trace [TODO]
- * @param cpu_properties Dictionary of properties associated to this Cpu
*/
- virtual Cpu *createCpu(const char *name, xbt_dynar_t speedPeak,
- int pstate, double speedScale,
- tmgr_trace_t speedTrace, 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);
- bool shareResourcesIsIdempotent() {return true;}
+ virtual Cpu* create_cpu(s4u::Host* host, const std::vector<double>& speed_per_pstate, int core) = 0;
+
+ 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
-*/
-XBT_PUBLIC_CLASS Cpu : public simgrid::surf::Resource {
-public:
- Cpu();
+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 name The name of the Cpu
- * @param props Dictionary of properties associated to this Cpu
- * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component
- * @param core The number of core of this Cpu
- * @param speedPeak The speed peak of this Cpu in flops (max speed)
- * @param speedScale The speed scale of this Cpu in [0;1] (available amount)
- * @param stateInitial whether it is created running or crashed
+ * @param host The host in which this Cpu should be plugged
+ * @param speed_per_pstate Processor speed (in flop per second) for each pstate
*/
- Cpu(simgrid::surf::Model *model, const char *name, xbt_dict_t props,
- lmm_constraint_t constraint, int core, double speedPeak, double speedScale,
- e_surf_resource_state_t stateInitial);
+ 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 name The name of the Cpu
- * @param props Dictionary of properties associated to this Cpu
- * @param core The number of core of this Cpu
- * @param speedPeak The speed peak of this Cpu in flops (max speed)
- * @param speedScale The speed scale of this Cpu in [0;1] (available amount)
- * @param stateInitial whether it is created running or crashed
+ * 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::surf::Model *model, const char *name, xbt_dict_t props,
- int core, double speedPeak, double speedScale,
- e_surf_resource_state_t stateInitial);
+ virtual double get_speed(double load) const { return load * speed_.peak; }
- Cpu(simgrid::surf::Model *model, const char *name, xbt_dict_t props,
- lmm_constraint_t constraint, int core, double speedPeak, double speedScale);
- Cpu(simgrid::surf::Model *model, const char *name, xbt_dict_t props,
- int core, double speedPeak, double speedScale);
+ /** @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::surf::Action *execute(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 requested_cores The desired amount of cores. Must be >= 1
+ * @return The CpuAction corresponding to the processing
+ */
+ 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::surf::Action *sleep(double duration)=0;
-
- /** @brief Get the amount of cores */
- virtual int getCore();
-
- /** @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 */
- virtual double getAvailableSpeed();
-
- /** @brief Get the current Cpu power peak */
- virtual double getCurrentPowerPeak();
-
- virtual double getPowerPeakAt(int pstate_index)=0;
-
- virtual int getNbPstates()=0;
- virtual void setPstate(int pstate_index)=0;
- virtual int getPstate()=0;
+ virtual CpuAction* sleep(double duration) = 0;
- void setState(e_surf_resource_state_t state);
+protected:
+ /** @brief Take speed changes (either load or max) into account */
+ virtual void on_speed_change();
- void addTraces(void);
- int m_core = 1; /* Amount of cores */
- double m_speedPeak; /*< CPU speed peak, ie max value */
- double m_speedScale; /*< Percentage of CPU available according to the trace, in [O,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);
- /* Note (hypervisor): */
- lmm_constraint_t *p_constraintCore;
- void **p_constraintCoreId;
+ Metric speed_ = {1.0, 0, nullptr};
};
/**********
**********/
/** @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 simgrid::surf::Action {
-friend XBT_PUBLIC(Cpu*) getActionCpu(CpuAction *action);
+class XBT_PUBLIC CpuAction : public Action {
public:
- /** @brief CpuAction constructor */
- CpuAction(simgrid::surf::Model *model, double cost, bool failed)
- : Action(model, cost, failed) {} //FIXME:REMOVE
-
- /** @brief CpuAction constructor */
- CpuAction(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var)
- : Action(model, cost, failed, var) {}
-
- /**
- * @brief Set the affinity of the current CpuAction
- * @details [TODO]
+ /** @brief Signal emitted when the action state changes (ready/running/done, etc)
+ * Signature: `void(CpuAction const& action, simgrid::kernel::resource::Action::State previous)`
*/
- virtual void setAffinity(Cpu *cpu, unsigned long mask);
+ static xbt::signal<void(CpuAction const&, Action::State)> on_state_change;
- void setState(e_surf_action_state_t state);
+ using Action::Action;
- void updateRemainingLazy(double now);
+ void set_state(Action::State state) override;
-};
+ void update_remains_lazy(double now) override;
+ std::list<Cpu*> cpus() const;
-}
-}
+ void suspend() override;
+ void resume() override;
+};
+} // namespace resource
+} // namespace kernel
+} // namespace simgrid
#endif /* SURF_CPU_INTERFACE_HPP_ */