1 /* Copyright (c) 2004-2017. 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/s4u/Host.hpp"
10 #include "src/surf/maxmin_private.hpp"
23 /** @ingroup SURF_cpu_interface
24 * @brief SURF cpu model interface class
25 * @details A model is an object which handle the interactions between its Resources and its Actions
27 XBT_PUBLIC_CLASS CpuModel : public Model {
32 * @param host The host that will have this CPU
33 * @param speedPerPstate Processor speed (in Flops) of each pstate. This ignores any potential external load coming from a trace.
34 * @param core The number of core of this Cpu
36 virtual Cpu *createCpu(simgrid::s4u::Host *host, std::vector<double> *speedPerPstate, int core)=0;
38 void updateActionsStateLazy(double now, double delta) override;
39 void updateActionsStateFull(double now, double delta) override;
46 /** @ingroup SURF_cpu_interface
47 * @brief SURF cpu resource interface class
48 * @details A Cpu represent a cpu associated to a host
50 XBT_PUBLIC_CLASS Cpu : public simgrid::surf::Resource {
53 * @brief Cpu constructor
55 * @param model The CpuModel associated to this Cpu
56 * @param host The host in which this Cpu should be plugged
57 * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component
58 * @param speedPerPstate Processor speed (in flop per second) for each pstate
59 * @param core The number of core of this Cpu
61 Cpu(simgrid::surf::Model *model, simgrid::s4u::Host *host, lmm_constraint_t constraint,
62 std::vector<double> *speedPerPstate, int core);
65 * @brief Cpu constructor
67 * @param model The CpuModel associated to this Cpu
68 * @param host The host in which this Cpu should be plugged
69 * @param speedPerPstate Processor speed (in flop per second) for each pstate
70 * @param core The number of core of this Cpu
72 Cpu(simgrid::surf::Model *model, simgrid::s4u::Host *host, std::vector<double> *speedPerPstate, int core);
77 * @brief Execute some quantity of computation
79 * @param size The value of the processing amount (in flop) needed to process
80 * @return The CpuAction corresponding to the processing
82 virtual simgrid::surf::Action *execution_start(double size)=0;
85 * @brief Make a process sleep for duration (in seconds)
87 * @param duration The number of seconds to sleep
88 * @return The CpuAction corresponding to the sleeping
90 virtual simgrid::surf::Action *sleep(double duration)=0;
92 /** @brief Get the amount of cores */
93 virtual int coreCount();
95 /** @brief Get the speed, accounting for the trace load and provided process load instead of the real current one */
96 virtual double getSpeed(double load);
99 /** @brief Take speed changes (either load or max) into account */
100 virtual void onSpeedChange();
103 /** @brief Get the available speed of the current Cpu */
104 virtual double getAvailableSpeed();
106 /** @brief Get the current Cpu computational speed */
107 virtual double getPstateSpeed(int pstate_index);
109 virtual int getNbPStates();
110 virtual void setPState(int pstate_index);
111 virtual int getPState();
113 simgrid::s4u::Host* getHost() { return host_; }
115 int coresAmount_ = 1;
116 simgrid::s4u::Host* host_;
118 std::vector<double> speedPerPstate_; /*< List of supported CPU capacities (pstate related) */
119 int pstate_ = 0; /*< Current pstate (index in the speedPeakList)*/
121 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). */
122 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) */
124 tmgr_trace_event_t stateEvent_ = nullptr;
125 s_surf_metric_t speed_ = {1.0, 0, nullptr};
132 /** @ingroup SURF_cpu_interface
133 * @brief A CpuAction represents the execution of code on one or several Cpus
135 XBT_PUBLIC_CLASS CpuAction : public simgrid::surf::Action {
136 friend XBT_PUBLIC(Cpu*) getActionCpu(CpuAction *action);
138 /** @brief Signal emitted when the action state changes (ready/running/done, etc)
139 * Signature: `void(CpuAction *action, simgrid::surf::Action::State previous)`
141 static simgrid::xbt::signal<void(simgrid::surf::CpuAction*, simgrid::surf::Action::State)> onStateChange;
142 /** @brief Signal emitted when the action share changes (amount of flops it gets)
143 * Signature: `void(CpuAction *action)`
145 static simgrid::xbt::signal<void(simgrid::surf::CpuAction*)> onShareChange;
147 CpuAction(simgrid::surf::Model *model, double cost, bool failed)
148 : Action(model, cost, failed) {}
149 CpuAction(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var)
150 : Action(model, cost, failed, var) {}
152 void setState(simgrid::surf::Action::State state) override;
154 void updateRemainingLazy(double now) override;
155 std::list<Cpu*> cpus();
161 #endif /* SURF_CPU_INTERFACE_HPP_ */