-/* Copyright (c) 2004-2014. The SimGrid Team.
- * All rights reserved. */
+/* Copyright (c) 2004-2018. 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 "src/surf/trace_mgr.hpp"
+
+#include <list>
+
/***********
* Classes *
***********/
-class CpuModel;
-typedef CpuModel *CpuModelPtr;
-
-class Cpu;
-typedef Cpu *CpuPtr;
-
-class CpuAction;
-typedef CpuAction *CpuActionPtr;
-
-class CpuPlugin;
-typedef CpuPlugin *CpuPluginPtr;
-
-/*************
- * Callbacks *
- *************/
-XBT_PUBLIC(CpuPtr) getActionCpu(CpuActionPtr 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, CpuPtr)) 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, CpuPtr)) cpuDestructedCallbacks;
-
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emit the callbacks after Cpu State changed *
- * @details Callback functions have the following signature: `void(CpuActionPtr action, e_surf_resource_state_t old, e_surf_resource_state_t current)`
- */
-XBT_PUBLIC_DATA( surf_callback(void, CpuPtr, 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(CpuActionPtr action, e_surf_action_state_t old, e_surf_action_state_t current)`
- */
-XBT_PUBLIC_DATA( surf_callback(void, CpuActionPtr, e_surf_action_state_t, e_surf_action_state_t)) cpuActionStateChangedCallbacks;
-
-XBT_PUBLIC(void) cpu_parse_init(sg_platf_host_cbarg_t host);
-XBT_PUBLIC(void) cpu_add_traces();
-
-/*********
- * Model *
- *********/
+namespace simgrid {
+namespace surf {
/** @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:
- /**
- * @brief CpuModel constructor
- *
- * @param name The name of the model
- */
- CpuModel(const char *name) : Model(name) {};
+ explicit CpuModel(kernel::resource::Model::UpdateAlgo algo) : Model(algo) {}
/**
* @brief Create a Cpu
*
- * @param name The name of the Cpu
- * @param power_peak The power peak of this Cpu
- * @param pstate [TODO]
- * @param power_scale The power scale of this Cpu
- * @param power_trace [TODO]
+ * @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 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 CpuPtr createCpu(const char *name, xbt_dynar_t power_peak,
- int pstate, double power_scale,
- tmgr_trace_t power_trace, 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);
+ virtual Cpu* create_cpu(simgrid::s4u::Host* host, std::vector<double>* speedPerPstate, int core) = 0;
+
+ void update_actions_state_lazy(double now, double delta) override;
+ void update_actions_state_full(double now, double delta) override;
};
/************
/** @ingroup SURF_cpu_interface
* @brief SURF cpu resource interface class
-* @details A Cpu represent a cpu associated to a workstation
+* @details A Cpu represent a cpu associated to a host
*/
-XBT_PUBLIC_CLASS Cpu : public Resource {
+class XBT_PUBLIC Cpu : public simgrid::kernel::resource::Resource {
public:
- /**
- * @brief Cpu constructor
- */
- Cpu();
-
/**
* @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 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 powerPeak The power peak of this Cpu
- * @param powerScale The power scale of this Cpu
*/
- Cpu(ModelPtr model, const char *name, xbt_dict_t props,
- lmm_constraint_t constraint, int core, double powerPeak, double powerScale);
+ Cpu(simgrid::kernel::resource::Model * model, simgrid::s4u::Host * host, kernel::lmm::Constraint * constraint,
+ std::vector<double> * speedPerPstate, int core);
/**
* @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 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
- * @param powerPeak The power peak of this Cpu in [TODO]
- * @param powerScale The power scale of this Cpu in [TODO]
*/
- Cpu(ModelPtr model, const char *name, xbt_dict_t props,
- int core, double powerPeak, double powerScale);
+ Cpu(simgrid::kernel::resource::Model * model, simgrid::s4u::Host * host, std::vector<double> * speedPerPstate,
+ int core);
- /**
- * @brief Cpu destructor
- */
~Cpu();
/**
* @param size The value of the processing amount (in flop) needed to process
* @return The CpuAction corresponding to the processing
*/
- virtual CpuActionPtr execute(double size)=0;
+ virtual simgrid::kernel::resource::Action* execution_start(double size) = 0;
/**
- * @brief Make a process sleep for duration (in seconds)
+ * @brief Execute some quantity of computation on more than one core
*
- * @param duration The number of seconds to sleep
- * @return The CpuAction corresponding to the sleeping
+ * @param size The value of the processing amount (in flop) needed to process
+ * @param requestedCores The desired amount of cores. Must be >= 1
+ * @return The CpuAction corresponding to the processing
*/
- virtual CpuActionPtr sleep(double duration)=0;
+ virtual simgrid::kernel::resource::Action* execution_start(double size, int requestedCores) = 0;
/**
- * @brief Get the number of cores of the current Cpu
+ * @brief Make a process sleep for duration (in seconds)
*
- * @return The number of cores of the current Cpu
+ * @param duration The number of seconds to sleep
+ * @return The CpuAction corresponding to the sleeping
*/
- virtual int getCore();
+ virtual simgrid::kernel::resource::Action* sleep(double duration) = 0;
- /**
- * @brief Get the speed of the current Cpu
- * @details [TODO] load * m_powerPeak
+ /** @brief Get the amount of cores */
+ virtual int get_cores_count();
+
+ /** @brief Get a forecast of the speed (in flops/s) if the load were as provided.
*
- * @param load [TODO]
+ * The provided load should encompasses both the application's activities and the external load that come from a trace.
*
- * @return The speed of the current Cpu
- */
- virtual double getSpeed(double load);
-
- /**
- * @brief Get the available speed of the current Cpu
- * @details [TODO]
+ * 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.
*
- * @return The available speed of the current Cpu
+ * If you want to know the amount of flops currently delivered, use load = get_load()*get_speed_ratio()
*/
- virtual double getAvailableSpeed();
+ virtual double get_speed(double load);
- /**
- * @brief Get the current Cpu power peak
+protected:
+ /** @brief Take speed changes (either load or max) into account */
+ virtual void on_speed_change();
+
+public:
+ /** @brief Get the available speed ratio, between 0 and 1.
*
- * @return The current Cpu power peak
+ * This accounts for external load (see @ref set_speed_trace()).
*/
- virtual double getCurrentPowerPeak();
+ 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);
- virtual double getPowerPeakAt(int pstate_index)=0;
+ virtual int get_pstates_count();
+ virtual void set_pstate(int pstate_index);
+ virtual int get_pstate();
- virtual int getNbPstates()=0;
+ simgrid::s4u::Host* get_host() { return host_; }
- virtual void setPowerPeakAt(int pstate_index)=0;
+private:
+ int cores_count_ = 1;
+ simgrid::s4u::Host* host_;
- void setState(e_surf_resource_state_t state);
+ int pstate_ = 0; /*< Current pstate (index in the speed_per_pstate_)*/
+ std::vector<double> speed_per_pstate_; /*< List of supported CPU capacities (pstate related) */
- void addTraces(void);
- int m_core;
- double m_powerPeak; /*< CPU power peak */
- double m_powerScale; /*< Percentage of CPU disponible */
+public:
+ /** @brief Setup the trace file with states events (ON or OFF).
+ * Trace must contain boolean values (0 or 1).
+ */
+ virtual void set_state_trace(tmgr_trace_t trace);
+ /*< @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_trace(tmgr_trace_t trace);
- /* Note (hypervisor): */
- lmm_constraint_t *p_constraintCore;
- void **p_constraintCoreId;
+protected:
+ tmgr_trace_event_t state_event_ = nullptr;
+ 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 Action {
-friend CpuPtr getActionCpu(CpuActionPtr action);
+class XBT_PUBLIC CpuAction : public simgrid::kernel::resource::Action {
public:
- /**
- * @brief CpuAction constructor
- *
- * @param model The CpuModel associated to this CpuAction
- * @param cost [TODO]
- * @param failed [TODO]
+ /** @brief Signal emitted when the action state changes (ready/running/done, etc)
+ * Signature: `void(CpuAction *action, simgrid::kernel::resource::Action::State previous)`
*/
- CpuAction(ModelPtr model, double cost, bool failed)
- : Action(model, cost, failed) {} //FIXME:REMOVE
-
- /**
- * @brief CpuAction constructor
- *
- * @param model The CpuModel associated to this CpuAction
- * @param cost [TODO]
- * @param failed [TODO]
- * @param var The lmm variable associated to this CpuAction if it is part of a LMM component
+ 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)`
*/
- CpuAction(ModelPtr model, double cost, bool failed, lmm_variable_t var)
- : Action(model, cost, failed, var) {}
+ static simgrid::xbt::signal<void(simgrid::surf::CpuAction*)> onShareChange;
- /**
- * @brief Set the affinity of the current CpuAction
- * @details [TODO]
- *
- * @param cpu [TODO]
- * @param mask [TODO]
- */
- virtual void setAffinity(CpuPtr cpu, unsigned long mask);
+ 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(e_surf_action_state_t state);
+ void set_state(simgrid::kernel::resource::Action::State state) override;
- void updateRemainingLazy(double now);
+ void update_remains_lazy(double now) override;
+ std::list<Cpu*> cpus();
+ void suspend() override;
+ void resume() override;
};
+}
+}
+
#endif /* SURF_CPU_INTERFACE_HPP_ */
