1 /* Copyright (c) 2004-2014. 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_
17 typedef CpuModel *CpuModelPtr;
23 typedef CpuAction *CpuActionPtr;
26 typedef CpuPlugin *CpuPluginPtr;
31 XBT_PUBLIC(CpuPtr) getActionCpu(CpuActionPtr action);
33 /** @ingroup SURF_callbacks
34 * @brief Callbacks handler which emit the callbacks after Cpu creation *
35 * @details Callback functions have the following signature: `void(CpuPtr)`
37 XBT_PUBLIC_DATA( surf_callback(void, CpuPtr)) cpuCreatedCallbacks;
39 /** @ingroup SURF_callbacks
40 * @brief Callbacks handler which emit the callbacks after Cpu destruction *
41 * @details Callback functions have the following signature: `void(CpuPtr)`
43 XBT_PUBLIC_DATA( surf_callback(void, CpuPtr)) cpuDestructedCallbacks;
45 /** @ingroup SURF_callbacks
46 * @brief Callbacks handler which emit the callbacks after Cpu State changed *
47 * @details Callback functions have the following signature: `void(CpuActionPtr action, e_surf_resource_state_t old, e_surf_resource_state_t current)`
49 XBT_PUBLIC_DATA( surf_callback(void, CpuPtr, e_surf_resource_state_t, e_surf_resource_state_t)) cpuStateChangedCallbacks;
51 /** @ingroup SURF_callbacks
52 * @brief Callbacks handler which emit the callbacks after CpuAction State changed *
53 * @details Callback functions have the following signature: `void(CpuActionPtr action, e_surf_action_state_t old, e_surf_action_state_t current)`
55 XBT_PUBLIC_DATA( surf_callback(void, CpuActionPtr, e_surf_action_state_t, e_surf_action_state_t)) cpuActionStateChangedCallbacks;
57 XBT_PUBLIC(void) cpu_parse_init(sg_platf_host_cbarg_t host);
59 XBT_PUBLIC(void) cpu_add_traces();
65 /** @ingroup SURF_cpu_interface
66 * @brief SURF cpu model interface class
67 * @details A model is an object which handle the interactions between its Resources and its Actions
69 XBT_PUBLIC_CLASS CpuModel : public Model {
72 * @brief CpuModel constructor
74 * @param name The name of the model
76 CpuModel(const char *name) : Model(name) {};
81 * @param name The name of the Cpu
82 * @param power_peak The power peak of this Cpu
83 * @param pstate [TODO]
84 * @param power_scale The power scale of this Cpu
85 * @param power_trace [TODO]
86 * @param core The number of core of this Cpu
87 * @param state_initial [TODO]
88 * @param state_trace [TODO]
89 * @param cpu_properties Dictionary of properties associated to this Cpu
91 virtual CpuPtr createCpu(const char *name, xbt_dynar_t power_peak,
92 int pstate, double power_scale,
93 tmgr_trace_t power_trace, int core,
94 e_surf_resource_state_t state_initial,
95 tmgr_trace_t state_trace,
96 xbt_dict_t cpu_properties)=0;
98 void updateActionsStateLazy(double now, double delta);
99 void updateActionsStateFull(double now, double delta);
106 /** @ingroup SURF_cpu_interface
107 * @brief SURF cpu resource interface class
108 * @details A Cpu represent a cpu associated to a workstation
110 XBT_PUBLIC_CLASS Cpu : public Resource {
113 * @brief Cpu constructor
118 * @brief Cpu constructor
120 * @param model The CpuModel associated to this Cpu
121 * @param name The name of the Cpu
122 * @param props Dictionary of properties associated to this Cpu
123 * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component
124 * @param core The number of core of this Cpu
125 * @param powerPeak The power peak of this Cpu
126 * @param powerScale The power scale of this Cpu
128 Cpu(ModelPtr model, const char *name, xbt_dict_t props,
129 lmm_constraint_t constraint, int core, double powerPeak, double powerScale);
132 * @brief Cpu constructor
134 * @param model The CpuModel associated to this Cpu
135 * @param name The name of the Cpu
136 * @param props Dictionary of properties associated to this Cpu
137 * @param core The number of core of this Cpu
138 * @param powerPeak The power peak of this Cpu in [TODO]
139 * @param powerScale The power scale of this Cpu in [TODO]
141 Cpu(ModelPtr model, const char *name, xbt_dict_t props,
142 int core, double powerPeak, double powerScale);
145 * @brief Cpu destructor
150 * @brief Execute some quantity of computation
152 * @param size The value of the processing amount (in flop) needed to process
153 * @return The CpuAction corresponding to the processing
155 virtual CpuActionPtr execute(double size)=0;
158 * @brief Make a process sleep for duration (in seconds)
160 * @param duration The number of seconds to sleep
161 * @return The CpuAction corresponding to the sleeping
163 virtual CpuActionPtr sleep(double duration)=0;
166 * @brief Get the number of cores of the current Cpu
168 * @return The number of cores of the current Cpu
170 virtual int getCore();
173 * @brief Get the speed of the current Cpu
174 * @details [TODO] load * m_powerPeak
178 * @return The speed of the current Cpu
180 virtual double getSpeed(double load);
183 * @brief Get the available speed of the current Cpu
186 * @return The available speed of the current Cpu
188 virtual double getAvailableSpeed();
191 * @brief Get the current Cpu power peak
193 * @return The current Cpu power peak
195 virtual double getCurrentPowerPeak();
198 virtual double getPowerPeakAt(int pstate_index)=0;
200 virtual int getNbPstates()=0;
202 virtual void setPowerPeakAt(int pstate_index)=0;
204 void setState(e_surf_resource_state_t state);
206 void addTraces(void);
208 double m_powerPeak; /*< CPU power peak */
209 double m_powerScale; /*< Percentage of CPU disponible */
211 /* Note (hypervisor): */
212 lmm_constraint_t *p_constraintCore;
213 void **p_constraintCoreId;
220 /** @ingroup SURF_cpu_interface
221 * @brief SURF Cpu action interface class
222 * @details A CpuAction represent the execution of code on a Cpu
224 XBT_PUBLIC_CLASS CpuAction : public Action {
225 friend CpuPtr getActionCpu(CpuActionPtr action);
228 * @brief CpuAction constructor
230 * @param model The CpuModel associated to this CpuAction
232 * @param failed [TODO]
234 CpuAction(ModelPtr model, double cost, bool failed)
235 : Action(model, cost, failed) {} //FIXME:REMOVE
238 * @brief CpuAction constructor
240 * @param model The CpuModel associated to this CpuAction
242 * @param failed [TODO]
243 * @param var The lmm variable associated to this CpuAction if it is part of a LMM component
245 CpuAction(ModelPtr model, double cost, bool failed, lmm_variable_t var)
246 : Action(model, cost, failed, var) {}
249 * @brief Set the affinity of the current CpuAction
255 virtual void setAffinity(CpuPtr cpu, unsigned long mask);
257 void setState(e_surf_action_state_t state);
259 void updateRemainingLazy(double now);
263 #endif /* SURF_CPU_INTERFACE_HPP_ */