1 /* Copyright (c) 2004-2021. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #ifndef SURF_CPU_INTERFACE_HPP_
7 #define SURF_CPU_INTERFACE_HPP_
9 #include "simgrid/kernel/resource/Model.hpp"
10 #include "simgrid/kernel/resource/Resource.hpp"
11 #include "simgrid/s4u/Host.hpp"
12 #include "src/kernel/lmm/maxmin.hpp"
29 class XBT_PUBLIC CpuModel : public Model {
36 * @param host The host that will have this CPU
37 * @param speed_per_pstate Processor speed (in Flops) of each pstate.
38 * This ignores any potential external load coming from a trace.
39 * @param core The number of core of this Cpu
41 virtual Cpu* create_cpu(s4u::Host* host, const std::vector<double>& speed_per_pstate, int core) = 0;
43 void update_actions_state_lazy(double now, double delta) override;
44 void update_actions_state_full(double now, double delta) override;
51 class XBT_PUBLIC Cpu : public Resource_T<Cpu> {
52 friend vm::VirtualMachineImpl; // Resets the VCPU
56 int pstate_ = 0; /*< Current pstate (index in the speed_per_pstate_)*/
57 std::vector<double> speed_per_pstate_; /*< List of supported CPU capacities (pstate related). Not 'const' because VCPU
58 get modified on migration */
62 * @brief Cpu constructor
64 * @param host The host in which this Cpu should be plugged
65 * @param speed_per_pstate Processor speed (in flop per second) for each pstate
67 Cpu(s4u::Host* host, const std::vector<double>& speed_per_pstate);
69 Cpu(const Cpu&) = delete;
70 Cpu& operator=(const Cpu&) = delete;
72 /** @brief Public interface */
73 s4u::Host* get_iface() { return piface_; }
75 Cpu* set_core_count(int core_count);
76 virtual int get_core_count();
78 /** @brief Get a forecast of the speed (in flops/s) if the load were as provided.
80 * The provided load should encompasses both the application's activities and the external load that come from a
83 * Use a load of 1.0 to compute the amount of flops that the Cpu would deliver with one CPU-bound task.
84 * If you use a load of 0, this function will return 0: when nobody is using the Cpu, it delivers nothing.
86 * If you want to know the amount of flops currently delivered, use load = get_load()*get_speed_ratio()
88 virtual double get_speed(double load) const { return load * speed_.peak; }
90 /** @brief Get the available speed ratio, in [0:1]. This accounts for external load (see @ref set_speed_profile()). */
91 virtual double get_speed_ratio() { return speed_.scale; }
93 /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
94 virtual double get_pstate_peak_speed(int pstate_index) const;
96 virtual int get_pstate_count() const { return speed_per_pstate_.size(); }
98 virtual void set_pstate(int pstate_index);
99 virtual int get_pstate() const { return pstate_; }
101 /*< @brief Setup the trace file with availability events (peak speed changes due to external load).
102 * Trace must contain relative values (ratio between 0 and 1)
104 virtual void set_speed_profile(profile::Profile* profile);
107 * @brief Execute some quantity of computation
109 * @param size The value of the processing amount (in flop) needed to process
110 * @return The CpuAction corresponding to the processing
112 virtual CpuAction* execution_start(double size) = 0;
115 * @brief Execute some quantity of computation on more than one core
117 * @param size The value of the processing amount (in flop) needed to process
118 * @param requested_cores The desired amount of cores. Must be >= 1
119 * @return The CpuAction corresponding to the processing
121 virtual CpuAction* execution_start(double size, int requested_cores) = 0;
124 * @brief Make a process sleep for duration (in seconds)
126 * @param duration The number of seconds to sleep
127 * @return The CpuAction corresponding to the sleeping
129 virtual CpuAction* sleep(double duration) = 0;
132 /** @brief Take speed changes (either load or max) into account */
133 virtual void on_speed_change();
135 /** Reset most characteristics of this CPU to the one of that CPU.
137 * Used to reset a VCPU when its VM migrates to another host, so it only resets the fields that should be in this
140 virtual void reset_vcpu(Cpu* that);
142 Metric speed_ = {1.0, 0, nullptr};
149 /** @ingroup SURF_cpu_interface
150 * @brief A CpuAction represents the execution of code on one or several Cpus
152 class XBT_PUBLIC CpuAction : public Action {
154 /** @brief Signal emitted when the action state changes (ready/running/done, etc)
155 * Signature: `void(CpuAction const& action, simgrid::kernel::resource::Action::State previous)`
157 static xbt::signal<void(CpuAction const&, Action::State)> on_state_change;
159 using Action::Action;
161 void set_state(Action::State state) override;
163 void update_remains_lazy(double now) override;
164 std::list<Cpu*> cpus() const;
166 void suspend() override;
167 void resume() override;
169 } // namespace resource
170 } // namespace kernel
171 } // namespace simgrid
173 #endif /* SURF_CPU_INTERFACE_HPP_ */