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 */
59 s4u::Host::SharingPolicy sharing_policy_ = s4u::Host::SharingPolicy::LINEAR;
60 s4u::NonLinearResourceCb sharing_policy_cb_;
62 void apply_sharing_policy_cfg() const;
66 * @brief Cpu constructor
68 * @param host The host in which this Cpu should be plugged
69 * @param speed_per_pstate Processor speed (in flop per second) for each pstate
71 CpuImpl(s4u::Host* host, const std::vector<double>& speed_per_pstate);
73 CpuImpl(const CpuImpl&) = delete;
74 CpuImpl& operator=(const CpuImpl&) = delete;
76 /** @brief Public interface */
77 s4u::Host* get_iface() { return piface_; }
79 CpuImpl* set_core_count(int core_count);
80 virtual int get_core_count();
84 /** @brief Get a forecast of the speed (in flops/s) if the load were as provided.
86 * The provided load should encompasses both the application's activities and the external load that come from a
89 * Use a load of 1.0 to compute the amount of flops that the Cpu would deliver with one CPU-bound task.
90 * If you use a load of 0, this function will return 0: when nobody is using the Cpu, it delivers nothing.
92 * If you want to know the amount of flops currently delivered, use load = get_load()*get_speed_ratio()
94 virtual double get_speed(double load) const { return load * speed_.peak; }
96 /** @brief Get the available speed ratio, in [0:1]. This accounts for external load (see @ref set_speed_profile()). */
97 virtual double get_speed_ratio() { return speed_.scale; }
99 /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
100 virtual double get_pstate_peak_speed(int pstate_index) const;
102 virtual int get_pstate_count() const { return speed_per_pstate_.size(); }
104 virtual int get_pstate() const { return pstate_; }
105 virtual CpuImpl* set_pstate(int pstate_index);
107 /*< @brief Setup the profile file with availability events (peak speed changes due to external load).
108 * Profile must contain relative values (ratio between 0 and 1)
110 virtual CpuImpl* set_speed_profile(profile::Profile* profile);
113 * @brief Set the CPU's speed
115 * @param speed_per_state list of powers for this processor (default power is at index 0)
117 CpuImpl* set_pstate_speed(const std::vector<double>& speed_per_state);
119 void set_sharing_policy(s4u::Host::SharingPolicy policy, const s4u::NonLinearResourceCb& cb);
120 s4u::Host::SharingPolicy get_sharing_policy() const;
123 * @brief Execute some quantity of computation
125 * @param size The value of the processing amount (in flop) needed to process
126 * @return The CpuAction corresponding to the processing
128 virtual CpuAction* execution_start(double size) = 0;
131 * @brief Execute some quantity of computation on more than one core
133 * @param size The value of the processing amount (in flop) needed to process
134 * @param requested_cores The desired amount of cores. Must be >= 1
135 * @return The CpuAction corresponding to the processing
137 virtual CpuAction* execution_start(double size, int requested_cores) = 0;
140 * @brief Make a process sleep for duration (in seconds)
142 * @param duration The number of seconds to sleep
143 * @return The CpuAction corresponding to the sleeping
145 virtual CpuAction* sleep(double duration) = 0;
148 /** @brief Take speed changes (either load or max) into account */
149 virtual void on_speed_change();
151 /** Reset most characteristics of this CPU to the one of that CPU.
153 * Used to reset a VCPU when its VM migrates to another host, so it only resets the fields that should be in this
156 virtual void reset_vcpu(CpuImpl* that);
158 Metric speed_ = {1.0, 0, nullptr};
165 /** @ingroup SURF_cpu_interface
166 * @brief A CpuAction represents the execution of code on one or several Cpus
168 class XBT_PUBLIC CpuAction : public Action {
170 /** @brief Signal emitted when the action state changes (ready/running/done, etc)
171 * Signature: `void(CpuAction const& action, simgrid::kernel::resource::Action::State previous)`
173 static xbt::signal<void(CpuAction const&, Action::State)> on_state_change;
175 using Action::Action;
177 void set_state(Action::State state) override;
179 void update_remains_lazy(double now) override;
180 std::list<CpuImpl*> cpus() const;
182 void suspend() override;
183 void resume() override;
185 } // namespace resource
186 } // namespace kernel
187 } // namespace simgrid
189 #endif /* SURF_CPU_INTERFACE_HPP_ */