1 /* Copyright (c) 2004-2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #include "surf_interface.hpp"
8 #include "maxmin_private.hpp"
10 #ifndef SURF_CPU_INTERFACE_HPP_
11 #define SURF_CPU_INTERFACE_HPP_
28 XBT_PUBLIC(Cpu*) getActionCpu(CpuAction *action);
30 XBT_PUBLIC(void) cpu_add_traces();
36 /** @ingroup SURF_cpu_interface
37 * @brief SURF cpu model interface class
38 * @details A model is an object which handle the interactions between its Resources and its Actions
40 XBT_PUBLIC_CLASS CpuModel : public Model {
42 CpuModel() : Model() {};
47 * @param name The name of the Cpu
48 * @param speedPeak The peak spead (max speed in Flops)
49 * @param pstate [TODO]
50 * @param speedScale The speed scale (in [O;1] available speed from peak)
51 * @param speedTrace Trace variations
52 * @param core The number of core of this Cpu
53 * @param state_initial [TODO]
54 * @param state_trace [TODO]
56 virtual Cpu *createCpu(simgrid::Host *host, xbt_dynar_t speedPeak,
57 int pstate, double speedScale,
58 tmgr_trace_t speedTrace, int core,
60 tmgr_trace_t state_trace)=0;
62 void updateActionsStateLazy(double now, double delta);
63 void updateActionsStateFull(double now, double delta);
64 bool shareResourcesIsIdempotent() {return true;}
71 /** @ingroup SURF_cpu_interface
72 * @brief SURF cpu resource interface class
73 * @details A Cpu represent a cpu associated to a host
75 XBT_PUBLIC_CLASS Cpu : public simgrid::surf::Resource {
78 * @brief Cpu constructor
80 * @param model The CpuModel associated to this Cpu
81 * @param host The host in which this Cpu should be plugged
82 * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component
83 * @param core The number of core of this Cpu
84 * @param speedPeak The speed peak of this Cpu in flops (max speed)
85 * @param speedScale The speed scale of this Cpu in [0;1] (available amount)
86 * @param stateInitial whether it is created running or crashed
88 Cpu(simgrid::surf::Model *model, simgrid::Host *host, lmm_constraint_t constraint,
89 xbt_dynar_t speedPeakList, int pstate,
90 int core, double speedPeak, double speedScale,
94 * @brief Cpu constructor
96 * @param model The CpuModel associated to this Cpu
97 * @param host The host in which this Cpu should be plugged
98 * @param core The number of core of this Cpu
99 * @param speedPeak The speed peak of this Cpu in flops (max speed)
100 * @param speedScale The speed scale of this Cpu in [0;1] (available amount)
101 * @param stateInitial whether it is created running or crashed
103 Cpu(simgrid::surf::Model *model, simgrid::Host *host,
104 xbt_dynar_t speedPeakList, int pstate,
105 int core, double speedPeak, double speedScale,
111 * @brief Execute some quantity of computation
113 * @param size The value of the processing amount (in flop) needed to process
114 * @return The CpuAction corresponding to the processing
116 virtual simgrid::surf::Action *execute(double size)=0;
119 * @brief Make a process sleep for duration (in seconds)
121 * @param duration The number of seconds to sleep
122 * @return The CpuAction corresponding to the sleeping
124 virtual simgrid::surf::Action *sleep(double duration)=0;
126 /** @brief Get the amount of cores */
127 virtual int getCore();
129 /** @brief Get the speed, accounting for the trace load and provided process load instead of the real current one */
130 virtual double getSpeed(double load);
133 /** @brief Take speed changes (either load or max) into account */
134 virtual void onSpeedChange();
137 /** @brief Get the available speed of the current Cpu */
138 virtual double getAvailableSpeed();
140 /** @brief Get the current Cpu power peak */
141 virtual double getCurrentPowerPeak();
143 virtual double getPowerPeakAt(int pstate_index);
145 virtual int getNbPStates();
146 virtual void setPState(int pstate_index);
147 virtual int getPState();
149 void addTraces(void);
150 simgrid::Host* getHost() { return m_host; }
153 int m_core = 1; /* Amount of cores */
154 double m_speedPeak; /*< CPU speed peak, ie max value */
155 double m_speedScale; /*< Percentage of CPU available according to the trace, in [O,1] */
156 simgrid::Host* m_host;
158 xbt_dynar_t p_speedPeakList = NULL; /*< List of supported CPU capacities (pstate related) */
159 int m_pstate = 0; /*< Current pstate (index in the speedPeakList)*/
161 /* Note (hypervisor): */
162 lmm_constraint_t *p_constraintCore=NULL;
163 void **p_constraintCoreId=NULL;
171 /** @ingroup SURF_cpu_interface
172 * @brief SURF Cpu action interface class
173 * @details A CpuAction represent the execution of code on a Cpu
175 XBT_PUBLIC_CLASS CpuAction : public simgrid::surf::Action {
176 friend XBT_PUBLIC(Cpu*) getActionCpu(CpuAction *action);
178 /** @brief Callbacks handler which emit the callbacks after CpuAction State changed *
179 * @details Callback functions have the following signature: `void(CpuAction *action, e_surf_action_state_t old, e_surf_action_state_t current)`
181 static simgrid::xbt::signal<void(simgrid::surf::CpuAction*, e_surf_action_state_t, e_surf_action_state_t)> onStateChange;
183 /** @brief CpuAction constructor */
184 CpuAction(simgrid::surf::Model *model, double cost, bool failed)
185 : Action(model, cost, failed) {} //FIXME:DEADCODE?
187 /** @brief CpuAction constructor */
188 CpuAction(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var)
189 : Action(model, cost, failed, var) {}
192 * @brief Set the affinity of the current CpuAction
195 virtual void setAffinity(Cpu *cpu, unsigned long mask);
197 void setState(e_surf_action_state_t state);
199 void updateRemainingLazy(double now);
206 #endif /* SURF_CPU_INTERFACE_HPP_ */