History

sched: Document arch_scale_*_capacity()

Rather that hide their purpose in some dark, damp corner of Documentation/, add some documentation to the default implementations.

Valentin Schneider committed 6 years ago

Commit f4470cd1 parent fcd7c9c2 files · +20 −0Browse files

Showing the changes to include/linux (1 of 2 files). Show all

Unified · Split

include/linux/sched/topology.h+10−0
@@ -217,6 +217,16 @@ static inline bool cpus_share_cache(int this_cpu, int that_cpu) · 216 unmodified lines
217217 #endif /* !CONFIG_SMP */
218218
219219 #ifndef arch_scale_cpu_capacity
220+/**
221+ * arch_scale_cpu_capacity - get the capacity scale factor of a given CPU.
222+ * @cpu: the CPU in question.
223+ *
224+ * Return: the CPU scale factor normalized against SCHED_CAPACITY_SCALE, i.e.
225+ *
226+ * max_perf(cpu)
227+ * ----------------------------- * SCHED_CAPACITY_SCALE
228+ * max(max_perf(c) : c \in CPUs)
229+ */
220230 static __always_inline
221231 unsigned long arch_scale_cpu_capacity(int cpu)
222232 {