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 CpuImpl* create_cpu(s4u::Host* host, const std::vector<double>& speed_per_pstate) = 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 CpuImpl : public Resource_T<CpuImpl> {
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 CpuImpl(s4u::Host* host, const std::vector<double>& speed_per_pstate);
69 CpuImpl(const CpuImpl&) = delete;
70 CpuImpl& operator=(const CpuImpl&) = delete;
72 /** @brief Public interface */
73 s4u::Host* get_iface() { return piface_; }
75 CpuImpl* set_core_count(int core_count);
76 virtual int get_core_count();
80 /** @brief Get a forecast of the speed (in flops/s) if the load were as provided.
82 * The provided load should encompasses both the application's activities and the external load that come from a
85 * Use a load of 1.0 to compute the amount of flops that the Cpu would deliver with one CPU-bound task.
86 * If you use a load of 0, this function will return 0: when nobody is using the Cpu, it delivers nothing.
88 * If you want to know the amount of flops currently delivered, use load = get_load()*get_speed_ratio()
90 virtual double get_speed(double load) const { return load * speed_.peak; }
92 /** @brief Get the available speed ratio, in [0:1]. This accounts for external load (see @ref set_speed_profile()). */
93 virtual double get_speed_ratio() { return speed_.scale; }
95 /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
96 virtual double get_pstate_peak_speed(int pstate_index) const;
98 virtual int get_pstate_count() const { return speed_per_pstate_.size(); }
100 virtual int get_pstate() const { return pstate_; }
101 virtual CpuImpl* set_pstate(int pstate_index);
103 /*< @brief Setup the profile file with availability events (peak speed changes due to external load).
104 * Profile must contain relative values (ratio between 0 and 1)
106 virtual CpuImpl* set_speed_profile(profile::Profile* profile);
109 * @brief Set the CPU's speed
111 * @param speed_per_state list of powers for this processor (default power is at index 0)
113 CpuImpl* set_pstate_speed(const std::vector<double>& speed_per_state);
116 * @brief Execute some quantity of computation
118 * @param size The value of the processing amount (in flop) needed to process
119 * @return The CpuAction corresponding to the processing
121 virtual CpuAction* execution_start(double size) = 0;
124 * @brief Execute some quantity of computation on more than one core
126 * @param size The value of the processing amount (in flop) needed to process
127 * @param requested_cores The desired amount of cores. Must be >= 1
128 * @return The CpuAction corresponding to the processing
130 virtual CpuAction* execution_start(double size, int requested_cores) = 0;
133 * @brief Make a process sleep for duration (in seconds)
135 * @param duration The number of seconds to sleep
136 * @return The CpuAction corresponding to the sleeping
138 virtual CpuAction* sleep(double duration) = 0;
141 /** @brief Take speed changes (either load or max) into account */
142 virtual void on_speed_change();
144 /** Reset most characteristics of this CPU to the one of that CPU.
146 * Used to reset a VCPU when its VM migrates to another host, so it only resets the fields that should be in this
149 virtual void reset_vcpu(CpuImpl* that);
151 Metric speed_ = {1.0, 0, nullptr};
158 /** @ingroup SURF_cpu_interface
159 * @brief A CpuAction represents the execution of code on one or several Cpus
161 class XBT_PUBLIC CpuAction : public Action {
163 /** @brief Signal emitted when the action state changes (ready/running/done, etc)
164 * Signature: `void(CpuAction const& action, simgrid::kernel::resource::Action::State previous)`
166 static xbt::signal<void(CpuAction const&, Action::State)> on_state_change;
168 using Action::Action;
170 void set_state(Action::State state) override;
172 void update_remains_lazy(double now) override;
173 std::list<CpuImpl*> cpus() const;
175 void suspend() override;
176 void resume() override;
178 } // namespace resource
179 } // namespace kernel
180 } // namespace simgrid
182 #endif /* SURF_CPU_INTERFACE_HPP_ */