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) parse_cpu_init(sg_platf_host_cbarg_t host);
59 XBT_PUBLIC(void) add_traces_cpu();
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) {};
83 void parseInit(sg_platf_host_cbarg_t host);
85 virtual CpuPtr createResource(const char *name, xbt_dynar_t power_peak,
86 int pstate, double power_scale,
87 tmgr_trace_t power_trace, int core,
88 e_surf_resource_state_t state_initial,
89 tmgr_trace_t state_trace,
90 xbt_dict_t cpu_properties)=0;
92 void updateActionsStateLazy(double now, double delta);
93 void updateActionsStateFull(double now, double delta);
95 virtual void addTraces() =0;
102 /** @ingroup SURF_cpu_interface
103 * @brief SURF cpu resource interface class
104 * @details A Cpu represent a cpu associated to a workstation
106 XBT_PUBLIC_CLASS Cpu : public Resource {
109 * @brief Cpu constructor
114 * @brief Cpu constructor
116 * @param model The CpuModel associated to this Cpu
117 * @param name The name of the Cpu
118 * @param props Dictionary of properties associated to this Cpu
119 * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component
120 * @param core The number of core of this Cpu
121 * @param powerPeak The power peak of this Cpu
122 * @param powerScale The power scale of this Cpu
124 Cpu(ModelPtr model, const char *name, xbt_dict_t props,
125 lmm_constraint_t constraint, int core, double powerPeak, double powerScale);
128 * @brief Cpu constructor
130 * @param model The CpuModel associated to this Cpu
131 * @param name The name of the Cpu
132 * @param props Dictionary of properties associated to this Cpu
133 * @param core The number of core of this Cpu
134 * @param powerPeak The power peak of this Cpu in [TODO]
135 * @param powerScale The power scale of this Cpu in [TODO]
137 Cpu(ModelPtr model, const char *name, xbt_dict_t props,
138 int core, double powerPeak, double powerScale);
141 * @brief Cpu destructor
146 * @brief Execute some quantity of computation
148 * @param size The value of the processing amount (in flop) needed to process
149 * @return The CpuAction corresponding to the processing
151 virtual CpuActionPtr execute(double size)=0;
154 * @brief Make a process sleep for duration (in seconds)
156 * @param duration The number of seconds to sleep
157 * @return The CpuAction corresponding to the sleeping
159 virtual CpuActionPtr sleep(double duration)=0;
162 * @brief Get the number of cores of the current Cpu
164 * @return The number of cores of the current Cpu
166 virtual int getCore();
169 * @brief Get the speed of the current Cpu
170 * @details [TODO] load * m_powerPeak
174 * @return The speed of the current Cpu
176 virtual double getSpeed(double load);
179 * @brief Get the available speed of the current Cpu
182 * @return The available speed of the current Cpu
184 virtual double getAvailableSpeed();
187 * @brief Get the current Cpu power peak
189 * @return The current Cpu power peak
191 virtual double getCurrentPowerPeak();
194 virtual double getPowerPeakAt(int pstate_index)=0;
196 virtual int getNbPstates()=0;
198 virtual void setPowerPeakAt(int pstate_index)=0;
200 void setState(e_surf_resource_state_t state);
202 void addTraces(void);
204 double m_powerPeak; /*< CPU power peak */
205 double m_powerScale; /*< Percentage of CPU disponible */
207 /* Note (hypervisor): */
208 lmm_constraint_t *p_constraintCore;
209 void **p_constraintCoreId;
216 /** @ingroup SURF_cpu_interface
217 * @brief SURF Cpu action interface class
218 * @details A CpuAction represent the execution of code on a Cpu
220 XBT_PUBLIC_CLASS CpuAction : public Action {
221 friend CpuPtr getActionCpu(CpuActionPtr action);
224 * @brief CpuAction constructor
226 * @param model The CpuModel associated to this CpuAction
228 * @param failed [TODO]
230 CpuAction(ModelPtr model, double cost, bool failed)
231 : Action(model, cost, failed) {} //FIXME:REMOVE
234 * @brief CpuAction constructor
236 * @param model The CpuModel associated to this CpuAction
238 * @param failed [TODO]
239 * @param var The lmm variable associated to this CpuAction if it is part of a LMM component
241 CpuAction(ModelPtr model, double cost, bool failed, lmm_variable_t var)
242 : Action(model, cost, failed, var) {}
245 * @brief Set the affinity of the current CpuAction
251 virtual void setAffinity(CpuPtr cpu, unsigned long mask);
253 void setState(e_surf_action_state_t state);
255 void updateRemainingLazy(double now);
259 #endif /* SURF_CPU_INTERFACE_HPP_ */