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. */
10 #include <xbt/dynar.h>
11 #include <xbt/signal.hpp>
13 #include <simgrid/forward.h>
14 #include <simgrid/s4u/host.hpp>
16 #include "surf/datatypes.h"
17 #include "surf_interface.hpp"
18 #include "maxmin_private.hpp"
19 #include "trace_mgr.hpp"
21 #ifndef SURF_CPU_INTERFACE_HPP_
22 #define SURF_CPU_INTERFACE_HPP_
34 class CpuPlugin;// FIXME:DEADCODE
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() {};
48 * @param host The host that will have this CPU
49 * @param speedPerPstate Processor speed (in Flops) of each pstate. This ignores any potential external load coming from a trace.
50 * @param core The number of core of this Cpu
52 virtual Cpu *createCpu(simgrid::s4u::Host *host, xbt_dynar_t speedPerPstate, int core)=0;
54 void updateActionsStateLazy(double now, double delta) override;
55 void updateActionsStateFull(double now, double delta) override;
56 bool next_occuring_event_isIdempotent() override;
63 /** @ingroup SURF_cpu_interface
64 * @brief SURF cpu resource interface class
65 * @details A Cpu represent a cpu associated to a host
67 XBT_PUBLIC_CLASS Cpu : public simgrid::surf::Resource {
70 * @brief Cpu constructor
72 * @param model The CpuModel associated to this Cpu
73 * @param host The host in which this Cpu should be plugged
74 * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component
75 * @param speedPerPstate Processor speed (in flop per second) for each pstate
76 * @param core The number of core of this Cpu
78 Cpu(simgrid::surf::Model *model, simgrid::s4u::Host *host, lmm_constraint_t constraint, xbt_dynar_t speedPerPstate, int core);
81 * @brief Cpu constructor
83 * @param model The CpuModel associated to this Cpu
84 * @param host The host in which this Cpu should be plugged
85 * @param speedPerPstate Processor speed (in flop per second) for each pstate
86 * @param core The number of core of this Cpu
88 Cpu(simgrid::surf::Model *model, simgrid::s4u::Host *host, xbt_dynar_t speedPerPstate, int core);
93 * @brief Execute some quantity of computation
95 * @param size The value of the processing amount (in flop) needed to process
96 * @return The CpuAction corresponding to the processing
98 virtual simgrid::surf::Action *execution_start(double size)=0;
101 * @brief Make a process sleep for duration (in seconds)
103 * @param duration The number of seconds to sleep
104 * @return The CpuAction corresponding to the sleeping
106 virtual simgrid::surf::Action *sleep(double duration)=0;
108 /** @brief Get the amount of cores */
109 virtual int getCore();
111 /** @brief Get the speed, accounting for the trace load and provided process load instead of the real current one */
112 virtual double getSpeed(double load);
115 /** @brief Take speed changes (either load or max) into account */
116 virtual void onSpeedChange();
119 /** @brief Get the available speed of the current Cpu */
120 virtual double getAvailableSpeed();
122 /** @brief Get the current Cpu computational speed */
123 virtual double getPstateSpeedCurrent();
124 virtual double getPstateSpeed(int pstate_index);
126 virtual int getNbPStates();
127 virtual void setPState(int pstate_index);
128 virtual int getPState();
130 simgrid::s4u::Host* getHost() { return host_; }
133 int coresAmount_ = 1;
134 simgrid::s4u::Host* host_;
136 xbt_dynar_t speedPerPstate_ = nullptr; /*< List of supported CPU capacities (pstate related) */
137 int pstate_ = 0; /*< Current pstate (index in the speedPeakList)*/
139 /* Note (hypervisor): */
140 lmm_constraint_t *p_constraintCore=nullptr;
141 void **p_constraintCoreId=nullptr;
144 virtual void setStateTrace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF). Trace must contain boolean values (0 or 1). */
145 virtual void setSpeedTrace(tmgr_trace_t trace); /*< setup the trace file with availability events (peak speed changes due to external load). Trace must contain relative values (ratio between 0 and 1) */
147 tmgr_trace_iterator_t stateEvent_ = nullptr;
148 s_surf_metric_t speed_ = {1.0, 0, nullptr};
155 /** @ingroup SURF_cpu_interface
156 * @brief A CpuAction represents the execution of code on one or several Cpus
158 XBT_PUBLIC_CLASS CpuAction : public simgrid::surf::Action {
159 friend XBT_PUBLIC(Cpu*) getActionCpu(CpuAction *action);
161 /** @brief Callbacks handler which emit the callbacks after CpuAction State changed *
162 * @details Callback functions have the following signature: `void(CpuAction *action, simgrid::surf::Action::State previous)`
164 static simgrid::xbt::signal<void(simgrid::surf::CpuAction*, simgrid::surf::Action::State)> onStateChange;
166 CpuAction(simgrid::surf::Model *model, double cost, bool failed)
167 : Action(model, cost, failed) {} //FIXME:DEADCODE?
168 CpuAction(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var)
169 : Action(model, cost, failed, var) {}
171 /** @brief Set the affinity of the current CpuAction */
172 virtual void setAffinity(Cpu *cpu, unsigned long mask);
174 void setState(simgrid::surf::Action::State state) override;
176 void updateRemainingLazy(double now) override;
177 std::list<Cpu*> cpus();
183 #endif /* SURF_CPU_INTERFACE_HPP_ */