1 /* Copyright (c) 2004-2023. 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. */
9 #include "simgrid/kernel/resource/Model.hpp"
10 #include "simgrid/s4u/Host.hpp"
11 #include "src/kernel/lmm/maxmin.hpp"
12 #include "src/kernel/resource/Resource.hpp"
17 namespace simgrid::kernel::resource {
28 class XBT_PUBLIC CpuModel : public Model {
35 * @param host The host that will have this CPU
36 * @param speed_per_pstate Processor speed (in Flops) of each pstate.
37 * This ignores any potential external load coming from a trace.
38 * @param core The number of core of this Cpu
40 virtual CpuImpl* create_cpu(s4u::Host* host, const std::vector<double>& speed_per_pstate) = 0;
42 void update_actions_state_lazy(double now, double delta) override;
43 void update_actions_state_full(double now, double delta) override;
50 class XBT_PUBLIC CpuImpl : public Resource_T<CpuImpl> {
51 friend VirtualMachineImpl; // Resets the VCPU
55 unsigned long pstate_ = 0; /*< Current pstate (index in the speed_per_pstate_)*/
56 std::vector<double> speed_per_pstate_; /*< List of supported CPU capacities (pstate related). Not 'const' because VCPU
57 get modified on migration */
58 s4u::Host::SharingPolicy sharing_policy_ = s4u::Host::SharingPolicy::LINEAR;
59 s4u::NonLinearResourceCb sharing_policy_cb_;
61 void apply_sharing_policy_cfg() const;
65 * @brief Cpu constructor
67 * @param host The host in which this Cpu should be plugged
68 * @param speed_per_pstate Processor speed (in flop per second) for each pstate
70 CpuImpl(s4u::Host* host, const std::vector<double>& speed_per_pstate);
72 CpuImpl(const CpuImpl&) = delete;
73 CpuImpl& operator=(const CpuImpl&) = delete;
75 /** @brief Public interface */
76 s4u::Host* get_iface() const { return piface_; }
78 CpuImpl* set_core_count(int core_count);
79 virtual int get_core_count() const { return core_count_; }
81 void turn_off() override;
83 bool is_used() const override { return true; }
87 /** @brief Get a forecast of the speed (in flops/s) if the load were as provided.
89 * The provided load should encompasses both the application's activities and the external load that come from a
92 * Use a load of 1.0 to compute the amount of flops that the Cpu would deliver with one CPU-bound task.
93 * If you use a load of 0, this function will return 0: when nobody is using the Cpu, it delivers nothing.
95 * If you want to know the amount of flops currently delivered, use load = get_load()*get_speed_ratio()
97 virtual double get_speed(double load) const { return load * speed_.peak; }
99 /** @brief Get the available speed ratio, in [0:1]. This accounts for external load (see @ref set_speed_profile()). */
100 virtual double get_speed_ratio() { return speed_.scale; }
102 /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
103 virtual double get_pstate_peak_speed(unsigned long pstate_index) const;
105 virtual unsigned long get_pstate_count() const { return speed_per_pstate_.size(); }
107 virtual unsigned long get_pstate() const { return pstate_; }
108 virtual CpuImpl* set_pstate(unsigned long pstate_index);
110 /*< @brief Setup the profile file with availability events (peak speed changes due to external load).
111 * Profile must contain relative values (ratio between 0 and 1)
113 virtual CpuImpl* set_speed_profile(profile::Profile* profile);
116 * @brief Set the CPU's speed
118 * @param speed_per_state list of powers for this processor (default power is at index 0)
120 CpuImpl* set_pstate_speed(const std::vector<double>& speed_per_state);
122 void set_sharing_policy(s4u::Host::SharingPolicy policy, const s4u::NonLinearResourceCb& cb);
123 s4u::Host::SharingPolicy get_sharing_policy() const { return sharing_policy_; }
126 * @brief Sets factor callback
127 * Implemented only for cas01
129 virtual void set_factor_cb(const std::function<s4u::Host::CpuFactorCb>& cb) { THROW_UNIMPLEMENTED; }
132 * @brief Execute some quantity of computation
134 * @param size The value of the processing amount (in flop) needed to process
135 * @param user_bound User's bound for execution speed
136 * @return The CpuAction corresponding to the processing
138 virtual CpuAction* execution_start(double size, double user_bound) = 0;
141 * @brief Execute some quantity of computation on more than one core
143 * @param size The value of the processing amount (in flop) needed to process
144 * @param requested_cores The desired amount of cores. Must be >= 1
145 * @param user_bound User's bound for execution speed
146 * @return The CpuAction corresponding to the processing
148 virtual CpuAction* execution_start(double size, int requested_cores, double user_bound) = 0;
151 * @brief Make a process sleep for duration (in seconds)
153 * @param duration The number of seconds to sleep
154 * @return The CpuAction corresponding to the sleeping
156 virtual CpuAction* sleep(double duration) = 0;
159 /** @brief Take speed changes (either load or max) into account */
160 virtual void on_speed_change();
162 /** Reset most characteristics of this CPU to the one of that CPU.
164 * Used to reset a VCPU when its VM migrates to another host, so it only resets the fields that should be in this
167 virtual void reset_vcpu(CpuImpl* that);
169 Metric speed_ = {1.0, 0, nullptr};
176 /** @ingroup Model_cpu_interface
177 * @brief A CpuAction represents the execution of code on one or several Cpus
179 class XBT_PUBLIC CpuAction : public Action {
181 using Action::Action;
183 /** @brief Signal emitted when the action state changes (ready/running/done, etc)
184 * Signature: `void(CpuAction const& action, simgrid::kernel::resource::Action::State previous)`
186 static xbt::signal<void(CpuAction const&, Action::State)> on_state_change;
188 void set_state(Action::State state) override;
190 void update_remains_lazy(double now) override;
191 std::list<CpuImpl*> cpus() const;
193 void suspend() override;
194 void resume() override;
196 } // namespace simgrid::kernel::resource
198 #endif /* CPU_IMPL_HPP_ */