+/* Copyright (c) 2004-2015. 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.h"
+#include "maxmin_private.hpp"
#ifndef SURF_CPU_INTERFACE_HPP_
#define SURF_CPU_INTERFACE_HPP_
/***********
* Classes *
***********/
-class CpuModel;
-typedef CpuModel *CpuModelPtr;
-
-class Cpu;
-typedef Cpu *CpuPtr;
-class CpuLmm;
-typedef CpuLmm *CpuLmmPtr;
+namespace simgrid {
+namespace surf {
+class CpuModel;
+class Cpu;
class CpuAction;
-typedef CpuAction *CpuActionPtr;
+class CpuPlugin;
-class CpuActionLmm;
-typedef CpuActionLmm *CpuActionLmmPtr;
+/*************
+ * Callbacks *
+ *************/
+XBT_PUBLIC(Cpu*) getActionCpu(CpuAction *action);
/*********
* Model *
*********/
-class CpuModel : public 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 {
public:
- CpuModel(string name) : Model(name) {};
- CpuPtr createResource(string name);
+ CpuModel() : Model() {};
+
+ /**
+ * @brief Create a Cpu
+ *
+ * @param host The host that will have this 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 core The number of core of this Cpu
+ * @param initiallyOn [TODO]
+ * @param state_trace [TODO]
+ */
+ virtual Cpu *createCpu(simgrid::s4u::Host *host, xbt_dynar_t speedPeak,
+ int pstate, double speedScale,
+ tmgr_trace_t speedTrace, int core,
+ int initiallyOn,
+ tmgr_trace_t state_trace)=0;
+
void updateActionsStateLazy(double now, double delta);
void updateActionsStateFull(double now, double delta);
-
- virtual void addTraces() =0;
+ bool shareResourcesIsIdempotent() {return true;}
};
/************
* Resource *
************/
-class Cpu : virtual public 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(){};
- Cpu(CpuModelPtr model, const char* name, xbt_dict_t properties, int core, double powerPeak, double powerScale)
- : Resource(model, name, properties), m_core(core), m_powerPeak(powerPeak), m_powerScale(powerScale)
- {};
- virtual ActionPtr execute(double size)=0;
- virtual ActionPtr sleep(double duration)=0;
+ /**
+ * @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 speedPeakList [TODO]
+ * @param pstate [TODO]
+ * @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 initiallyOn whether it is created running or crashed
+ */
+ Cpu(simgrid::surf::Model *model, simgrid::s4u::Host *host,
+ lmm_constraint_t constraint,
+ xbt_dynar_t speedPeakList, int pstate,
+ int core, double speedPeak, double speedScale,
+ int initiallyOn);
+
+ /**
+ * @brief Cpu constructor
+ *
+ * @param model The CpuModel associated to this Cpu
+ * @param host The host in which this Cpu should be plugged
+ * @param speedPeakList [TODO]
+ * @param pstate
+ * @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 initiallyOn whether it is created running or crashed
+ */
+ Cpu(simgrid::surf::Model *model, simgrid::s4u::Host *host,
+ xbt_dynar_t speedPeakList, int pstate,
+ int core, double speedPeak, double speedScale,
+ int initiallyOn);
+
+ ~Cpu();
+
+ /**
+ * @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 *execution_start(double size)=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);
+
+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();
- virtual double getCurrentPowerPeak()=0;
- virtual double getPowerPeakAt(int pstate_index)=0;
- virtual int getNbPstates()=0;
- virtual void setPowerPeakAt(int pstate_index)=0;
- virtual double getConsumedEnergy()=0;
+ /** @brief Get the current Cpu power peak */
+ virtual double getCurrentPowerPeak();
- void addTraces(void);
- int m_core;
- double m_powerPeak; /*< CPU power peak */
- double m_powerScale; /*< Percentage of CPU disponible */
-protected:
+ virtual double getPowerPeakAt(int pstate_index);
- //virtual boost::shared_ptr<Action> execute(double size) = 0;
- //virtual boost::shared_ptr<Action> sleep(double duration) = 0;
-};
+ virtual int getNbPStates();
+ virtual void setPState(int pstate_index);
+ virtual int getPState();
+
+ simgrid::s4u::Host* getHost() { return m_host; }
-class CpuLmm : public ResourceLmm, public Cpu {
public:
- CpuLmm() : p_constraintCore(NULL), p_constraintCoreId(NULL) {};
- CpuLmm(CpuModelPtr model, const char* name, xbt_dict_t properties, int core, double powerPeak, double powerScale);
- ~CpuLmm();
+ 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] */
+ simgrid::s4u::Host* m_host;
+
+ xbt_dynar_t p_speedPeakList = NULL; /*< List of supported CPU capacities (pstate related) */
+ int m_pstate = 0; /*< Current pstate (index in the speedPeakList)*/
+
/* Note (hypervisor): */
- lmm_constraint_t *p_constraintCore;
- void **p_constraintCoreId;
+ lmm_constraint_t *p_constraintCore=NULL;
+ void **p_constraintCoreId=NULL;
+public:
+ void set_state_trace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF) */
+ void set_speed_trace(tmgr_trace_t trace); /*< setup the trace file with availability events (peak speed changes due to external load) */
+protected:
+ tmgr_trace_iterator_t p_stateEvent = nullptr;
+ tmgr_trace_iterator_t p_speedEvent = nullptr;
};
/**********
* Action *
**********/
-class CpuAction : virtual public Action {
-public:
- CpuAction(){};
- CpuAction(ModelPtr model, double cost, bool failed)
- : Action(model, cost, failed) {};
- virtual void setAffinity(CpuPtr cpu, unsigned long mask)=0;
- virtual void setBound(double bound)=0;
-};
-class CpuActionLmm : public ActionLmm, public CpuAction {
+ /** @ingroup SURF_cpu_interface
+ * @brief SURF Cpu action interface class
+ * @details A CpuAction represent the execution of code on a Cpu
+ */
+XBT_PUBLIC_CLASS CpuAction : public simgrid::surf::Action {
+friend XBT_PUBLIC(Cpu*) getActionCpu(CpuAction *action);
public:
- CpuActionLmm(){};
- CpuActionLmm(ModelPtr model, double cost, bool failed)
- : Action(model, cost, failed), ActionLmm(model, cost, failed), CpuAction(model, cost, failed) {};
+/** @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 previous)`
+ */
+ static simgrid::xbt::signal<void(simgrid::surf::CpuAction*, e_surf_action_state_t)> onStateChange;
+
+ /** @brief CpuAction constructor */
+ CpuAction(simgrid::surf::Model *model, double cost, bool failed)
+ : Action(model, cost, failed) {} //FIXME:DEADCODE?
+
+ /** @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]
+ */
+ virtual void setAffinity(Cpu *cpu, unsigned long mask);
+
+ void setState(e_surf_action_state_t state);
+
void updateRemainingLazy(double now);
- virtual void updateEnergy()=0;
- void setAffinity(CpuPtr cpu, unsigned long mask);
- void setBound(double bound);
- double m_bound;
+
};
+}
+}
#endif /* SURF_CPU_INTERFACE_HPP_ */
