xref: /linux/kernel/sched/ext/ext.c (revision 546b928da0427b0d6c663cbb992bd7bfa9ac7971)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * BPF extensible scheduler class: Documentation/scheduler/sched-ext.rst
4  *
5  * Copyright (c) 2022 Meta Platforms, Inc. and affiliates.
6  * Copyright (c) 2022 Tejun Heo <tj@kernel.org>
7  * Copyright (c) 2022 David Vernet <dvernet@meta.com>
8  */
9 #include <linux/bitmap.h>
10 #include <linux/btf_ids.h>
11 #include <linux/rhashtable.h>
12 #include <linux/sched/clock.h>
13 #include <linux/sched/isolation.h>
14 #include <linux/suspend.h>
15 #include <linux/sysrq.h>
16 
17 #include "../pelt.h"
18 #include "internal.h"
19 #include "cid.h"
20 #include "arena.h"
21 #include "idle.h"
22 #include "sub.h"
23 #include "inlines.h"
24 
25 DEFINE_RAW_SPINLOCK(scx_sched_lock);
26 
27 /*
28  * NOTE: sched_ext is in the process of growing multiple scheduler support and
29  * scx_root usage is in a transitional state. Naked dereferences are safe if the
30  * caller is one of the tasks attached to SCX and explicit RCU dereference is
31  * necessary otherwise. Naked scx_root dereferences trigger sparse warnings but
32  * are used as temporary markers to indicate that the dereferences need to be
33  * updated to point to the associated scheduler instances rather than scx_root.
34  */
35 struct scx_sched __rcu *scx_root;
36 
37 /*
38  * All scheds, writers must hold both scx_enable_mutex and scx_sched_lock.
39  * Readers can hold either or rcu_read_lock().
40  */
41 LIST_HEAD(scx_sched_all);
42 
43 #ifdef CONFIG_EXT_SUB_SCHED
44 const struct rhashtable_params scx_sched_hash_params = {
45 	.key_len		= sizeof_field(struct scx_sched, ops.sub_cgroup_id),
46 	.key_offset		= offsetof(struct scx_sched, ops.sub_cgroup_id),
47 	.head_offset		= offsetof(struct scx_sched, hash_node),
48 	.insecure_elasticity	= true,	/* inserted under scx_sched_lock */
49 };
50 
51 struct rhashtable scx_sched_hash;
52 #endif
53 
54 /* see SCX_OPS_TID_TO_TASK */
55 static const struct rhashtable_params scx_tid_hash_params = {
56 	.key_len		= sizeof_field(struct sched_ext_entity, tid),
57 	.key_offset		= offsetof(struct sched_ext_entity, tid),
58 	.head_offset		= offsetof(struct sched_ext_entity, tid_hash_node),
59 	.insecure_elasticity	= true,	/* inserted/removed under scx_tasks_lock */
60 };
61 static struct rhashtable scx_tid_hash;
62 
63 /*
64  * During exit, a task may schedule after losing its PIDs. When disabling the
65  * BPF scheduler, we need to be able to iterate tasks in every state to
66  * guarantee system safety. Maintain a dedicated task list which contains every
67  * task between its fork and eventual free.
68  */
69 static DEFINE_RAW_SPINLOCK(scx_tasks_lock);
70 static LIST_HEAD(scx_tasks);
71 
72 /* ops enable/disable */
73 DEFINE_MUTEX(scx_enable_mutex);
74 DEFINE_STATIC_KEY_FALSE(__scx_enabled);
75 DEFINE_PERCPU_RWSEM(scx_fork_rwsem);
76 static atomic_t scx_enable_state_var = ATOMIC_INIT(SCX_DISABLED);
77 static DEFINE_RAW_SPINLOCK(scx_bypass_lock);
78 static bool scx_init_task_enabled;
79 static bool scx_switching_all;
80 DEFINE_STATIC_KEY_FALSE(__scx_switched_all);
81 static DEFINE_STATIC_KEY_FALSE(__scx_tid_to_task_enabled);
82 
83 /*
84  * Gates cgroup ops delivery. Set at the end of the cgroup init phase of root
85  * enable and cleared before root disable starts tearing down tasks, both under
86  * scx_cgroup_lock(). Holding cgroup_lock() and seeing %true guarantees no race
87  * against root tearing down tasks.
88  */
89 bool scx_cgroup_enabled;
90 
91 /*
92  * True once SCX_OPS_TID_TO_TASK has been negotiated with the root scheduler
93  * and the tid->task table is live. Wraps the static key so callers don't
94  * take the address, and hints "likely enabled" for the common case where
95  * the feature is in use.
96  */
scx_tid_to_task_enabled(void)97 static inline bool scx_tid_to_task_enabled(void)
98 {
99 	return static_branch_likely(&__scx_tid_to_task_enabled);
100 }
101 
102 static atomic_long_t scx_nr_rejected = ATOMIC_LONG_INIT(0);
103 static atomic_long_t scx_hotplug_seq = ATOMIC_LONG_INIT(0);
104 
105 /* Global cursor for the per-CPU tid allocator. Starts at 1; tid 0 is reserved. */
106 static atomic64_t scx_tid_cursor = ATOMIC64_INIT(1);
107 
108 /* is @dsq synchronized by the containing rq lock instead of dsq->lock? */
dsq_is_rq_owned(struct scx_dispatch_q * dsq)109 static bool dsq_is_rq_owned(struct scx_dispatch_q *dsq)
110 {
111 	switch (dsq->id) {
112 	case SCX_DSQ_LOCAL:
113 	case SCX_DSQ_REJECT:
114 	case SCX_DSQ_RESCUE:
115 		return true;
116 	default:
117 		return false;
118 	}
119 }
120 
121 /* Cursor for unique scx_sched instance ids. id 0 is reserved. */
122 static atomic64_t scx_sched_id_cursor = ATOMIC64_INIT(0);
123 
124 #ifdef CONFIG_EXT_SUB_SCHED
125 /*
126  * The sub sched being enabled. Used by scx_disable_and_exit_task() to exit
127  * tasks for the sub-sched being enabled. Use a global variable instead of a
128  * per-task field as all enables are serialized.
129  */
130 struct scx_sched *scx_enabling_sub_sched;
131 #else
132 #define scx_enabling_sub_sched	(struct scx_sched *)NULL
133 #endif	/* CONFIG_EXT_SUB_SCHED */
134 
135 /*
136  * A monotonically increasing sequence number that is incremented every time a
137  * scheduler is enabled. This can be used to check if any custom sched_ext
138  * scheduler has ever been used in the system.
139  */
140 static atomic_long_t scx_enable_seq = ATOMIC_LONG_INIT(0);
141 
142 /*
143  * Watchdog interval. All scx_sched's share a single watchdog timer and the
144  * interval is half of the shortest sch->watchdog_timeout.
145  */
146 static unsigned long scx_watchdog_interval;
147 
148 /*
149  * The last time the delayed work was run. This delayed work relies on
150  * ksoftirqd being able to run to service timer interrupts, so it's possible
151  * that this work itself could get wedged. To account for this, we check that
152  * it's not stalled in the timer tick, and trigger an error if it is.
153  */
154 static unsigned long scx_watchdog_timestamp = INITIAL_JIFFIES;
155 
156 static struct delayed_work scx_watchdog_work;
157 
158 /*
159  * For %SCX_KICK_WAIT: Each CPU has a pointer to an array of kick_sync sequence
160  * numbers. The arrays are allocated with kvzalloc() as size can exceed percpu
161  * allocator limits on large machines. O(nr_cpu_ids^2) allocation, allocated
162  * lazily when enabling and freed when disabling to avoid waste when sched_ext
163  * isn't active.
164  */
165 struct scx_kick_syncs {
166 	struct rcu_head		rcu;
167 	unsigned long		syncs[];
168 };
169 
170 static DEFINE_PER_CPU(struct scx_kick_syncs __rcu *, scx_kick_syncs);
171 
172 /*
173  * Per-CPU buffered allocator state for p->scx.tid. Each CPU pulls a chunk of
174  * SCX_TID_CHUNK ids from scx_tid_cursor and hands them out locally without
175  * further synchronization. See scx_alloc_tid().
176  */
177 struct scx_tid_alloc {
178 	u64	next;
179 	u64	end;
180 };
181 static DEFINE_PER_CPU(struct scx_tid_alloc, scx_tid_alloc);
182 
183 /*
184  * Direct dispatch marker.
185  *
186  * Non-NULL values are used for direct dispatch from enqueue path. A valid
187  * pointer points to the task currently being enqueued. An ERR_PTR value is used
188  * to indicate that direct dispatch has already happened.
189  */
190 static DEFINE_PER_CPU(struct task_struct *, direct_dispatch_task);
191 
192 static const struct rhashtable_params dsq_hash_params = {
193 	.key_len		= sizeof_field(struct scx_dispatch_q, id),
194 	.key_offset		= offsetof(struct scx_dispatch_q, id),
195 	.head_offset		= offsetof(struct scx_dispatch_q, hash_node),
196 };
197 
198 static LLIST_HEAD(dsqs_to_free);
199 
200 /* ops debug dump */
201 static DEFINE_RAW_SPINLOCK(scx_dump_lock);
202 
203 struct scx_dump_data {
204 	s32			cpu;
205 	bool			first;
206 	s32			cursor;
207 	struct seq_buf		*s;
208 	const char		*prefix;
209 	struct scx_bstr_buf	buf;
210 };
211 
212 static struct scx_dump_data scx_dump_data = {
213 	.cpu			= -1,
214 };
215 
216 /* /sys/kernel/sched_ext interface */
217 static struct kset *scx_kset;
218 
219 /*
220  * Parameters that can be adjusted through /sys/module/sched_ext/parameters.
221  * There usually is no reason to modify these as normal scheduler operation
222  * shouldn't be affected by them. The knobs are primarily for debugging.
223  */
224 static unsigned int scx_slice_bypass_us = SCX_SLICE_BYPASS / NSEC_PER_USEC;
225 static unsigned int scx_bypass_lb_intv_us = SCX_BYPASS_LB_DFL_INTV_US;
226 
set_slice_us(const char * val,const struct kernel_param * kp)227 static int set_slice_us(const char *val, const struct kernel_param *kp)
228 {
229 	return param_set_uint_minmax(val, kp, 100, 100 * USEC_PER_MSEC);
230 }
231 
232 static const struct kernel_param_ops slice_us_param_ops = {
233 	.set = set_slice_us,
234 	.get = param_get_uint,
235 };
236 
set_bypass_lb_intv_us(const char * val,const struct kernel_param * kp)237 static int set_bypass_lb_intv_us(const char *val, const struct kernel_param *kp)
238 {
239 	return param_set_uint_minmax(val, kp, 0, 10 * USEC_PER_SEC);
240 }
241 
242 static const struct kernel_param_ops bypass_lb_intv_us_param_ops = {
243 	.set = set_bypass_lb_intv_us,
244 	.get = param_get_uint,
245 };
246 
247 #undef MODULE_PARAM_PREFIX
248 #define MODULE_PARAM_PREFIX	"sched_ext."
249 
250 module_param_cb(slice_bypass_us, &slice_us_param_ops, &scx_slice_bypass_us, 0600);
251 MODULE_PARM_DESC(slice_bypass_us, "bypass slice in microseconds, applied on [un]load (100us to 100ms)");
252 module_param_cb(bypass_lb_intv_us, &bypass_lb_intv_us_param_ops, &scx_bypass_lb_intv_us, 0600);
253 MODULE_PARM_DESC(bypass_lb_intv_us, "bypass load balance interval in microseconds (0 (disable) to 10s)");
254 
255 #undef MODULE_PARAM_PREFIX
256 
257 #define CREATE_TRACE_POINTS
258 #include <trace/events/sched_ext.h>
259 
260 static void run_deferred(struct rq *rq);
261 static bool task_dead_and_done(struct task_struct *p);
262 static void scx_disable(struct scx_sched *sch, enum scx_exit_kind kind);
263 
__scx_exit(struct scx_sched * sch,enum scx_exit_kind kind,s64 exit_code,s32 exit_cpu,const char * fmt,...)264 __printf(5, 6) bool __scx_exit(struct scx_sched *sch,
265 			       enum scx_exit_kind kind, s64 exit_code,
266 			       s32 exit_cpu, const char *fmt, ...)
267 {
268 	va_list args;
269 	bool ret;
270 
271 	va_start(args, fmt);
272 	ret = scx_vexit(sch, kind, exit_code, exit_cpu, fmt, args);
273 	va_end(args);
274 
275 	return ret;
276 }
277 
jiffies_delta_msecs(unsigned long at,unsigned long now)278 static long jiffies_delta_msecs(unsigned long at, unsigned long now)
279 {
280 	if (time_after(at, now))
281 		return jiffies_to_msecs(at - now);
282 	else
283 		return -(long)jiffies_to_msecs(now - at);
284 }
285 
u32_before(u32 a,u32 b)286 static bool u32_before(u32 a, u32 b)
287 {
288 	return (s32)(a - b) < 0;
289 }
290 
291 /**
292  * scx_is_descendant - Test whether sched is a descendant
293  * @sch: sched to test
294  * @ancestor: ancestor sched to test against
295  *
296  * Test whether @sch is a descendant of @ancestor.
297  */
scx_is_descendant(struct scx_sched * sch,struct scx_sched * ancestor)298 bool scx_is_descendant(struct scx_sched *sch, struct scx_sched *ancestor)
299 {
300 	if (sch->level < ancestor->level)
301 		return false;
302 	return sch->ancestors[ancestor->level] == ancestor;
303 }
304 
find_global_dsq(struct scx_sched * sch,s32 cpu)305 static struct scx_dispatch_q *find_global_dsq(struct scx_sched *sch, s32 cpu)
306 {
307 	return &sch->pnode[cpu_to_node(cpu)]->global_dsq;
308 }
309 
find_user_dsq(struct scx_sched * sch,u64 dsq_id)310 static struct scx_dispatch_q *find_user_dsq(struct scx_sched *sch, u64 dsq_id)
311 {
312 	return rhashtable_lookup(&sch->dsq_hash, &dsq_id, dsq_hash_params);
313 }
314 
scx_setscheduler_class(struct task_struct * p)315 static const struct sched_class *scx_setscheduler_class(struct task_struct *p)
316 {
317 	if (p->sched_class == &stop_sched_class)
318 		return &stop_sched_class;
319 
320 	return __setscheduler_class(p->policy, p->prio);
321 }
322 
bypass_enq_target_dsq(struct scx_sched * sch,s32 cpu)323 static struct scx_dispatch_q *bypass_enq_target_dsq(struct scx_sched *sch, s32 cpu)
324 {
325 #ifdef CONFIG_EXT_SUB_SCHED
326 	/*
327 	 * If @sch is a sub-sched which is bypassing, its tasks should go into
328 	 * the bypass DSQs of the nearest ancestor which is not bypassing. The
329 	 * not-bypassing ancestor is responsible for scheduling all tasks from
330 	 * bypassing sub-trees. If all ancestors including root are bypassing,
331 	 * all tasks should go to the root's bypass DSQs.
332 	 *
333 	 * Whenever a sched starts bypassing, all runnable tasks in its subtree
334 	 * are re-enqueued after scx_bypassing() is turned on, guaranteeing that
335 	 * all tasks are transferred to the right DSQs.
336 	 */
337 	while (scx_parent(sch) && scx_bypassing(sch, cpu))
338 		sch = scx_parent(sch);
339 #endif	/* CONFIG_EXT_SUB_SCHED */
340 
341 	return scx_bypass_dsq(sch, cpu);
342 }
343 
344 /**
345  * rq_is_open - Is the rq available for immediate execution of an SCX task?
346  * @rq: rq to test
347  * @enq_flags: optional %SCX_ENQ_* of the task being enqueued
348  *
349  * Returns %true if @rq is currently open for executing an SCX task. After a
350  * %false return, @rq is guaranteed to invoke SCX dispatch path at least once
351  * before going to idle and not inserting a task into @rq's local DSQ after a
352  * %false return doesn't cause @rq to stall.
353  */
rq_is_open(struct rq * rq,u64 enq_flags)354 static bool rq_is_open(struct rq *rq, u64 enq_flags)
355 {
356 	lockdep_assert_rq_held(rq);
357 
358 	/*
359 	 * A higher-priority class task is either running or in the process of
360 	 * waking up on @rq.
361 	 */
362 	if (sched_class_above(rq->next_class, &ext_sched_class))
363 		return false;
364 
365 	/*
366 	 * @rq is either in transition to or in idle and there is no
367 	 * higher-priority class task waking up on it.
368 	 */
369 	if (sched_class_above(&ext_sched_class, rq->next_class))
370 		return true;
371 
372 	/*
373 	 * @rq is either picking, in transition to, or running an SCX task.
374 	 */
375 
376 	/*
377 	 * If we're in the dispatch path holding rq lock, $curr may or may not
378 	 * be ready depending on whether the on-going dispatch decides to extend
379 	 * $curr's slice. We say yes here and resolve it at the end of dispatch.
380 	 * See dispatch_one().
381 	 */
382 	if (rq->scx.flags & SCX_RQ_IN_DISPATCH)
383 		return true;
384 
385 	/*
386 	 * %SCX_ENQ_PREEMPT clears $curr's slice if on SCX and kicks dispatch,
387 	 * so allow it to avoid spuriously triggering reenq on a combined
388 	 * PREEMPT|IMMED insertion.
389 	 */
390 	if (enq_flags & SCX_ENQ_PREEMPT) {
391 		struct task_struct *curr = rq->curr;
392 
393 		/*
394 		 * A protected slice refuses the preemption and the cpu stays
395 		 * occupied. See rq_owned_post_enq().
396 		 */
397 		return curr->sched_class != &ext_sched_class ||
398 			likely(!(curr->scx.flags & SCX_TASK_PROTECTED));
399 	}
400 
401 	/*
402 	 * @rq is either in transition to or running an SCX task and can't go
403 	 * idle without another SCX dispatch cycle.
404 	 */
405 	return false;
406 }
407 
408 /*
409  * Track the rq currently locked.
410  *
411  * This allows kfuncs to safely operate on rq from any scx ops callback,
412  * knowing which rq is already locked.
413  */
414 DEFINE_PER_CPU(struct rq *, scx_locked_rq_state);
415 
416 /*
417  * Under core scheduling, a pick that releases the rq lock invalidates the
418  * core-wide selection it is part of. Count the releases so that the core-sched
419  * pick can tell whether one happened across dispatch.
420  */
scx_rq_lock_drop(struct rq * rq)421 static void scx_rq_lock_drop(struct rq *rq)
422 {
423 	lockdep_assert_rq_held(rq);
424 #ifdef CONFIG_SCHED_CORE
425 	if (sched_core_enabled(rq))
426 		rq->scx.lock_drop_seq++;
427 #endif
428 }
429 
switch_rq_lock(struct rq * from,struct rq * to)430 static void switch_rq_lock(struct rq *from, struct rq *to)
431 {
432 	bool tracked = scx_locked_rq() == from;
433 
434 	if (tracked)
435 		update_locked_rq(NULL);
436 	scx_rq_lock_drop(from);
437 	raw_spin_rq_unlock(from);
438 	raw_spin_rq_lock(to);
439 	if (tracked)
440 		update_locked_rq(to);
441 }
442 
443 /*
444  * Flipped on enable per sch->is_cid_type. Declared in internal.h so
445  * subsystem inlines can read it.
446  */
447 DEFINE_STATIC_KEY_FALSE(__scx_is_cid_type);
448 
449 /**
450  * scx_call_op_set_cpumask - invoke ops.set_cpumask / ops_cid.set_cmask for @task
451  * @sch: scx_sched being invoked
452  * @rq: rq to update as the currently-locked rq, or NULL
453  * @task: task whose affinity is changing
454  * @cpumask: new cpumask
455  *
456  * For cid-form schedulers, translate @cpumask to a cmask via the per-cpu
457  * scratch in cid.c and dispatch through the ops_cid union view. Caller
458  * must hold @rq's rq lock so this_cpu_ptr is stable across the call.
459  */
scx_call_op_set_cpumask(struct scx_sched * sch,struct rq * rq,struct task_struct * task,const struct cpumask * cpumask)460 static inline void scx_call_op_set_cpumask(struct scx_sched *sch, struct rq *rq,
461 					   struct task_struct *task,
462 					   const struct cpumask *cpumask)
463 {
464 	if (scx_is_cid_type()) {
465 		struct scx_cmask *kern_va = *this_cpu_ptr(sch->set_cmask_scratch);
466 		struct scx_cmask_ref ref;
467 
468 		/*
469 		 * Build the per-cpu arena cmask from kernel geometry via @ref,
470 		 * never reading its BPF-writable header. set_cmask()'s __arena
471 		 * argument takes the kernel address and the struct_ops
472 		 * trampoline rebases it into BPF's arena pointer form. The rq
473 		 * lock makes this cpu the sole kernel writer.
474 		 */
475 		scx_cmask_ref_init_kern(sch, kern_va, 0, num_possible_cpus(), &ref);
476 		scx_cmask_ref_from_cpumask(&ref, cpumask);
477 		SCX_CALL_CID_OP_TASK(sch, set_cmask, rq, task, kern_va);
478 	} else {
479 		SCX_CALL_OP_TASK(sch, set_cpumask, rq, task, cpumask);
480 	}
481 }
482 
483 enum scx_dsq_iter_flags {
484 	/* iterate in the reverse dispatch order */
485 	SCX_DSQ_ITER_REV		= 1U << 16,
486 
487 	__SCX_DSQ_ITER_HAS_SLICE	= 1U << 30,
488 	__SCX_DSQ_ITER_HAS_VTIME	= 1U << 31,
489 
490 	__SCX_DSQ_ITER_USER_FLAGS	= SCX_DSQ_ITER_REV,
491 	__SCX_DSQ_ITER_ALL_FLAGS	= __SCX_DSQ_ITER_USER_FLAGS |
492 					  __SCX_DSQ_ITER_HAS_SLICE |
493 					  __SCX_DSQ_ITER_HAS_VTIME,
494 };
495 
496 /**
497  * nldsq_next_task - Iterate to the next task in a non-local DSQ
498  * @dsq: non-local dsq being iterated
499  * @cur: current position, %NULL to start iteration
500  * @rev: walk backwards
501  *
502  * Returns %NULL when iteration is finished.
503  */
nldsq_next_task(struct scx_dispatch_q * dsq,struct task_struct * cur,bool rev)504 static struct task_struct *nldsq_next_task(struct scx_dispatch_q *dsq,
505 					   struct task_struct *cur, bool rev)
506 {
507 	struct list_head *list_node;
508 	struct scx_dsq_list_node *dsq_lnode;
509 
510 	lockdep_assert_held(&dsq->lock);
511 
512 	if (cur)
513 		list_node = &cur->scx.dsq_list.node;
514 	else
515 		list_node = &dsq->list;
516 
517 	/* find the next task, need to skip BPF iteration cursors */
518 	do {
519 		if (rev)
520 			list_node = list_node->prev;
521 		else
522 			list_node = list_node->next;
523 
524 		if (list_node == &dsq->list)
525 			return NULL;
526 
527 		dsq_lnode = container_of(list_node, struct scx_dsq_list_node,
528 					 node);
529 	} while (dsq_lnode->flags & SCX_DSQ_LNODE_ITER_CURSOR);
530 
531 	return container_of(dsq_lnode, struct task_struct, scx.dsq_list);
532 }
533 
534 #define nldsq_for_each_task(p, dsq)						\
535 	for ((p) = nldsq_next_task((dsq), NULL, false); (p);			\
536 	     (p) = nldsq_next_task((dsq), (p), false))
537 
538 /**
539  * nldsq_cursor_next_task - Iterate to the next task given a cursor in a non-local DSQ
540  * @cursor: scx_dsq_list_node initialized with INIT_DSQ_LIST_CURSOR()
541  * @dsq: non-local dsq being iterated
542  *
543  * Find the next task in a cursor based iteration. The caller must have
544  * initialized @cursor using INIT_DSQ_LIST_CURSOR() and can release the DSQ lock
545  * between the iteration steps.
546  *
547  * Only tasks which were queued before @cursor was initialized are visible. This
548  * bounds the iteration and guarantees that vtime never jumps in the other
549  * direction while iterating.
550  */
nldsq_cursor_next_task(struct scx_dsq_list_node * cursor,struct scx_dispatch_q * dsq)551 static struct task_struct *nldsq_cursor_next_task(struct scx_dsq_list_node *cursor,
552 						  struct scx_dispatch_q *dsq)
553 {
554 	bool rev = cursor->flags & SCX_DSQ_ITER_REV;
555 	struct task_struct *p;
556 
557 	lockdep_assert_held(&dsq->lock);
558 	BUG_ON(!(cursor->flags & SCX_DSQ_LNODE_ITER_CURSOR));
559 
560 	if (list_empty(&cursor->node))
561 		p = NULL;
562 	else
563 		p = container_of(cursor, struct task_struct, scx.dsq_list);
564 
565 	/* skip cursors and tasks that were queued after @cursor init */
566 	do {
567 		p = nldsq_next_task(dsq, p, rev);
568 	} while (p && unlikely(u32_before(cursor->priv, p->scx.dsq_seq)));
569 
570 	if (p) {
571 		if (rev)
572 			list_move_tail(&cursor->node, &p->scx.dsq_list.node);
573 		else
574 			list_move(&cursor->node, &p->scx.dsq_list.node);
575 	} else {
576 		list_del_init(&cursor->node);
577 	}
578 
579 	return p;
580 }
581 
582 /**
583  * nldsq_cursor_lost_task - Test whether someone else took the task since iteration
584  * @cursor: scx_dsq_list_node initialized with INIT_DSQ_LIST_CURSOR()
585  * @rq: rq @p was on
586  * @dsq: dsq @p was on
587  * @p: target task
588  *
589  * @p is a task returned by nldsq_cursor_next_task(). The locks may have been
590  * dropped and re-acquired inbetween. Verify that no one else took or is in the
591  * process of taking @p from @dsq.
592  *
593  * On %false return, the caller can assume full ownership of @p.
594  */
nldsq_cursor_lost_task(struct scx_dsq_list_node * cursor,struct rq * rq,struct scx_dispatch_q * dsq,struct task_struct * p)595 static bool nldsq_cursor_lost_task(struct scx_dsq_list_node *cursor,
596 				   struct rq *rq, struct scx_dispatch_q *dsq,
597 				   struct task_struct *p)
598 {
599 	lockdep_assert_rq_held(rq);
600 	lockdep_assert_held(&dsq->lock);
601 
602 	/*
603 	 * @p could have already left $src_dsq, got re-enqueud, or be in the
604 	 * process of being consumed by someone else.
605 	 */
606 	if (unlikely(p->scx.dsq != dsq ||
607 		     u32_before(cursor->priv, p->scx.dsq_seq) ||
608 		     p->scx.holding_cpu >= 0))
609 		return true;
610 
611 	/* if @p has stayed on @dsq, its rq couldn't have changed */
612 	if (WARN_ON_ONCE(rq != task_rq(p)))
613 		return true;
614 
615 	return false;
616 }
617 
618 /*
619  * BPF DSQ iterator. Tasks in a non-local DSQ can be iterated in [reverse]
620  * dispatch order. BPF-visible iterator is opaque and larger to allow future
621  * changes without breaking backward compatibility. Can be used with
622  * bpf_for_each(). See bpf_iter_scx_dsq_*().
623  */
624 struct bpf_iter_scx_dsq_kern {
625 	struct scx_dsq_list_node	cursor;
626 	struct scx_dispatch_q		*dsq;
627 	u64				slice;
628 	u64				vtime;
629 } __attribute__((aligned(8)));
630 
631 struct bpf_iter_scx_dsq {
632 	u64				__opaque[6];
633 } __attribute__((aligned(8)));
634 
635 
scx_get_task_state(const struct task_struct * p)636 u32 scx_get_task_state(const struct task_struct *p)
637 {
638 	return p->scx.flags & SCX_TASK_STATE_MASK;
639 }
640 
scx_set_task_state(struct task_struct * p,u32 state)641 void scx_set_task_state(struct task_struct *p, u32 state)
642 {
643 	u32 prev_state = scx_get_task_state(p);
644 	bool warn = false;
645 
646 	switch (state) {
647 	case SCX_TASK_NONE:
648 		warn = prev_state == SCX_TASK_DEAD;
649 		break;
650 	case SCX_TASK_INIT_BEGIN:
651 		warn = prev_state != SCX_TASK_NONE;
652 		break;
653 	case SCX_TASK_INIT:
654 		warn = prev_state != SCX_TASK_INIT_BEGIN;
655 		p->scx.flags |= SCX_TASK_RESET_RUNNABLE_AT;
656 		break;
657 	case SCX_TASK_READY:
658 		warn = !(prev_state == SCX_TASK_INIT ||
659 			 prev_state == SCX_TASK_ENABLED);
660 		break;
661 	case SCX_TASK_ENABLED:
662 		warn = prev_state != SCX_TASK_READY;
663 		break;
664 	case SCX_TASK_DEAD:
665 		warn = !(prev_state == SCX_TASK_NONE ||
666 			 prev_state == SCX_TASK_INIT_BEGIN);
667 		break;
668 	default:
669 		WARN_ONCE(1, "sched_ext: Invalid task state %d -> %d for %s[%d]",
670 			  prev_state, state, p->comm, p->pid);
671 		return;
672 	}
673 
674 	WARN_ONCE(warn, "sched_ext: Invalid task state transition 0x%x -> 0x%x for %s[%d]",
675 		  prev_state, state, p->comm, p->pid);
676 
677 	p->scx.flags &= ~SCX_TASK_STATE_MASK;
678 	p->scx.flags |= state;
679 }
680 
681 /**
682  * scx_task_iter_start - Lock scx_tasks_lock and start a task iteration
683  * @iter: iterator to init
684  * @cgrp: Optional root of cgroup subhierarchy to iterate
685  *
686  * Initialize @iter. Once initialized, @iter must eventually be stopped with
687  * scx_task_iter_stop().
688  *
689  * If @cgrp is %NULL, scx_tasks is used for iteration and this function returns
690  * with scx_tasks_lock held and @iter->cursor inserted into scx_tasks.
691  *
692  * If @cgrp is not %NULL, @cgrp and its descendants' tasks are walked using
693  * @iter->css_iter. The caller must be holding cgroup_lock() to prevent cgroup
694  * task migrations.
695  *
696  * The two modes of iterations are largely independent and it's likely that
697  * scx_tasks can be removed in favor of always using cgroup iteration if
698  * CONFIG_SCHED_CLASS_EXT depends on CONFIG_CGROUPS.
699  *
700  * scx_tasks_lock and the rq lock may be released using scx_task_iter_unlock()
701  * between this and the first next() call or between any two next() calls. If
702  * the locks are released between two next() calls, the caller is responsible
703  * for ensuring that the task being iterated remains accessible either through
704  * RCU read lock or obtaining a reference count.
705  *
706  * All tasks which existed when the iteration started are guaranteed to be
707  * visited as long as they are not dead.
708  */
scx_task_iter_start(struct scx_task_iter * iter,struct cgroup * cgrp)709 void scx_task_iter_start(struct scx_task_iter *iter, struct cgroup *cgrp)
710 {
711 	memset(iter, 0, sizeof(*iter));
712 
713 #ifdef CONFIG_EXT_SUB_SCHED
714 	if (cgrp) {
715 		lockdep_assert_held(&cgroup_mutex);
716 		iter->cgrp = cgrp;
717 		iter->css_pos = css_next_descendant_pre(NULL, &iter->cgrp->self);
718 		css_task_iter_start(iter->css_pos, CSS_TASK_ITER_WITH_DEAD,
719 				    &iter->css_iter);
720 		return;
721 	}
722 #endif
723 	raw_spin_lock_irq(&scx_tasks_lock);
724 
725 	iter->cursor = (struct sched_ext_entity){ .flags = SCX_TASK_CURSOR };
726 	list_add(&iter->cursor.tasks_node, &scx_tasks);
727 	iter->list_locked = true;
728 }
729 
__scx_task_iter_rq_unlock(struct scx_task_iter * iter)730 static void __scx_task_iter_rq_unlock(struct scx_task_iter *iter)
731 {
732 	if (iter->locked_task) {
733 		__balance_callbacks(iter->rq, &iter->rf);
734 		task_rq_unlock(iter->rq, iter->locked_task, &iter->rf);
735 		iter->locked_task = NULL;
736 	}
737 }
738 
739 /**
740  * scx_task_iter_unlock - Unlock rq and scx_tasks_lock held by a task iterator
741  * @iter: iterator to unlock
742  *
743  * If @iter is in the middle of a locked iteration, it may be locking the rq of
744  * the task currently being visited in addition to scx_tasks_lock. Unlock both.
745  * This function can be safely called anytime during an iteration. The next
746  * iterator operation will automatically restore the necessary locking.
747  */
scx_task_iter_unlock(struct scx_task_iter * iter)748 void scx_task_iter_unlock(struct scx_task_iter *iter)
749 {
750 	__scx_task_iter_rq_unlock(iter);
751 	if (iter->list_locked) {
752 		iter->list_locked = false;
753 		raw_spin_unlock_irq(&scx_tasks_lock);
754 	}
755 }
756 
__scx_task_iter_maybe_relock(struct scx_task_iter * iter)757 static void __scx_task_iter_maybe_relock(struct scx_task_iter *iter)
758 {
759 	if (!iter->list_locked) {
760 		raw_spin_lock_irq(&scx_tasks_lock);
761 		iter->list_locked = true;
762 	}
763 }
764 
765 /**
766  * scx_task_iter_relock - Re-acquire scx_tasks_lock and, optionally, @p's rq
767  * @iter: iterator to relock
768  * @p: task whose rq to lock, or %NULL for scx_tasks_lock only
769  *
770  * Counterpart to scx_task_iter_unlock(). Locking @p's rq is optional. Once
771  * re-acquired, both locks are managed by the iterator from here on.
772  */
scx_task_iter_relock(struct scx_task_iter * iter,struct task_struct * p)773 static void scx_task_iter_relock(struct scx_task_iter *iter,
774 				 struct task_struct *p)
775 {
776 	__scx_task_iter_maybe_relock(iter);
777 	if (p) {
778 		iter->rq = task_rq_lock(p, &iter->rf);
779 		iter->locked_task = p;
780 	}
781 }
782 
783 /**
784  * scx_task_iter_stop - Stop a task iteration and unlock scx_tasks_lock
785  * @iter: iterator to exit
786  *
787  * Exit a previously initialized @iter. Must be called with scx_tasks_lock held
788  * which is released on return. If the iterator holds a task's rq lock, that rq
789  * lock is also released. See scx_task_iter_start() for details.
790  */
scx_task_iter_stop(struct scx_task_iter * iter)791 void scx_task_iter_stop(struct scx_task_iter *iter)
792 {
793 #ifdef CONFIG_EXT_SUB_SCHED
794 	if (iter->cgrp) {
795 		if (iter->css_pos)
796 			css_task_iter_end(&iter->css_iter);
797 		__scx_task_iter_rq_unlock(iter);
798 		return;
799 	}
800 #endif
801 	__scx_task_iter_maybe_relock(iter);
802 	list_del_init(&iter->cursor.tasks_node);
803 	scx_task_iter_unlock(iter);
804 }
805 
806 /**
807  * scx_task_iter_next - Next task
808  * @iter: iterator to walk
809  *
810  * Visit the next task. See scx_task_iter_start() for details. Locks are dropped
811  * and re-acquired every %SCX_TASK_ITER_BATCH iterations to avoid causing stalls
812  * by holding scx_tasks_lock for too long.
813  */
scx_task_iter_next(struct scx_task_iter * iter)814 static struct task_struct *scx_task_iter_next(struct scx_task_iter *iter)
815 {
816 	struct list_head *cursor = &iter->cursor.tasks_node;
817 	struct sched_ext_entity *pos;
818 
819 	if (!(++iter->cnt % SCX_TASK_ITER_BATCH)) {
820 		scx_task_iter_unlock(iter);
821 		cond_resched();
822 	}
823 
824 #ifdef CONFIG_EXT_SUB_SCHED
825 	if (iter->cgrp) {
826 		while (iter->css_pos) {
827 			struct task_struct *p;
828 
829 			p = css_task_iter_next(&iter->css_iter);
830 			if (p)
831 				return p;
832 
833 			css_task_iter_end(&iter->css_iter);
834 			iter->css_pos = css_next_descendant_pre(iter->css_pos,
835 								&iter->cgrp->self);
836 			if (iter->css_pos)
837 				css_task_iter_start(iter->css_pos, CSS_TASK_ITER_WITH_DEAD,
838 						    &iter->css_iter);
839 		}
840 		return NULL;
841 	}
842 #endif
843 	__scx_task_iter_maybe_relock(iter);
844 
845 	list_for_each_entry(pos, cursor, tasks_node) {
846 		if (&pos->tasks_node == &scx_tasks)
847 			return NULL;
848 		if (!(pos->flags & SCX_TASK_CURSOR)) {
849 			list_move(cursor, &pos->tasks_node);
850 			return container_of(pos, struct task_struct, scx);
851 		}
852 	}
853 
854 	/* can't happen, should always terminate at scx_tasks above */
855 	BUG();
856 }
857 
858 /**
859  * scx_task_iter_next_locked - Next non-idle task with its rq locked
860  * @iter: iterator to walk
861  *
862  * Visit the non-idle task with its rq lock held. Allows callers to specify
863  * whether they would like to filter out dead tasks. See scx_task_iter_start()
864  * for details.
865  */
scx_task_iter_next_locked(struct scx_task_iter * iter)866 struct task_struct *scx_task_iter_next_locked(struct scx_task_iter *iter)
867 {
868 	struct task_struct *p;
869 
870 	__scx_task_iter_rq_unlock(iter);
871 
872 	while ((p = scx_task_iter_next(iter))) {
873 		/*
874 		 * scx_task_iter is used to prepare and move tasks into SCX
875 		 * while loading the BPF scheduler and vice-versa while
876 		 * unloading. The init_tasks ("swappers") should be excluded
877 		 * from the iteration because:
878 		 *
879 		 * - It's unsafe to use __setscheduler_class() on an init_task
880 		 *   to determine the sched_class to use as it won't preserve
881 		 *   its idle_sched_class.
882 		 *
883 		 * - ops.init/exit_task() can easily be confused if called with
884 		 *   init_tasks as they, e.g., share PID 0.
885 		 *
886 		 * As init_tasks are never scheduled through SCX, they can be
887 		 * skipped safely. Note that is_idle_task() which tests %PF_IDLE
888 		 * doesn't work here:
889 		 *
890 		 * - %PF_IDLE may not be set for an init_task whose CPU hasn't
891 		 *   yet been onlined.
892 		 *
893 		 * - %PF_IDLE can be set on tasks that are not init_tasks. See
894 		 *   play_idle_precise() used by CONFIG_IDLE_INJECT.
895 		 *
896 		 * Test for idle_sched_class as only init_tasks are on it.
897 		 */
898 		if (p->sched_class == &idle_sched_class)
899 			continue;
900 
901 		iter->rq = task_rq_lock(p, &iter->rf);
902 		iter->locked_task = p;
903 
904 		/*
905 		 * cgroup_task_dead() removes the dead tasks from cset->tasks
906 		 * after sched_ext_dead() and cgroup iteration may see tasks
907 		 * which already finished sched_ext_dead(). %SCX_TASK_DEAD is
908 		 * set by sched_ext_dead() under @p's rq lock. Test it to
909 		 * avoid visiting tasks which are already dead from SCX POV.
910 		 */
911 		if (scx_get_task_state(p) == SCX_TASK_DEAD) {
912 			__scx_task_iter_rq_unlock(iter);
913 			continue;
914 		}
915 
916 		return p;
917 	}
918 	return NULL;
919 }
920 
921 /**
922  * scx_dump_event - Dump an event 'kind' in 'events' to 's'
923  * @s: output seq_buf
924  * @events: event stats
925  * @kind: a kind of event to dump
926  */
927 #define scx_dump_event(s, events, kind) do {					\
928 	scx_dump_line(&(s), "%40s: %16lld", #kind, (events)->kind);		\
929 } while (0)
930 
931 
932 static void scx_read_events(struct scx_sched *sch,
933 			    struct scx_event_stats *events);
934 
scx_enable_state(void)935 static enum scx_enable_state scx_enable_state(void)
936 {
937 	return atomic_read(&scx_enable_state_var);
938 }
939 
scx_set_enable_state(enum scx_enable_state to)940 static enum scx_enable_state scx_set_enable_state(enum scx_enable_state to)
941 {
942 	return atomic_xchg(&scx_enable_state_var, to);
943 }
944 
scx_tryset_enable_state(enum scx_enable_state to,enum scx_enable_state from)945 static bool scx_tryset_enable_state(enum scx_enable_state to,
946 				    enum scx_enable_state from)
947 {
948 	int from_v = from;
949 
950 	return atomic_try_cmpxchg(&scx_enable_state_var, &from_v, to);
951 }
952 
953 /**
954  * wait_ops_state - Busy-wait the specified ops state to end
955  * @p: target task
956  * @opss: state to wait the end of
957  *
958  * Busy-wait for @p to transition out of @opss. This can only be used when the
959  * state part of @opss is %SCX_QUEUEING or %SCX_DISPATCHING. This function also
960  * has load_acquire semantics to ensure that the caller can see the updates made
961  * in the enqueueing and dispatching paths.
962  */
wait_ops_state(struct task_struct * p,unsigned long opss)963 static void wait_ops_state(struct task_struct *p, unsigned long opss)
964 {
965 	do {
966 		cpu_relax();
967 	} while (atomic_long_read_acquire(&p->scx.ops_state) == opss);
968 }
969 
__cpu_valid(s32 cpu)970 static inline bool __cpu_valid(s32 cpu)
971 {
972 	return likely(cpu >= 0 && cpu < nr_cpu_ids && cpu_possible(cpu));
973 }
974 
975 /**
976  * scx_cpu_valid - Verify a cpu number, to be used on ops input args
977  * @sch: scx_sched to abort on error
978  * @cpu: cpu number which came from a BPF ops
979  * @where: extra information reported on error
980  *
981  * @cpu is a cpu number which came from the BPF scheduler and can be any value.
982  * Verify that it is in range and one of the possible cpus. If invalid, trigger
983  * an ops error.
984  */
scx_cpu_valid(struct scx_sched * sch,s32 cpu,const char * where)985 bool scx_cpu_valid(struct scx_sched *sch, s32 cpu, const char *where)
986 {
987 	if (__cpu_valid(cpu)) {
988 		return true;
989 	} else {
990 		scx_error(sch, "invalid CPU %d%s%s", cpu, where ? " " : "", where ?: "");
991 		return false;
992 	}
993 }
994 
deferred_bal_cb_workfn(struct rq * rq)995 static void deferred_bal_cb_workfn(struct rq *rq)
996 {
997 	run_deferred(rq);
998 }
999 
deferred_irq_workfn(struct irq_work * irq_work)1000 static void deferred_irq_workfn(struct irq_work *irq_work)
1001 {
1002 	struct rq *rq = container_of(irq_work, struct rq, scx.deferred_irq_work);
1003 
1004 	raw_spin_rq_lock(rq);
1005 	run_deferred(rq);
1006 	scx_rq_lock_drop(rq);
1007 	raw_spin_rq_unlock(rq);
1008 }
1009 
1010 /**
1011  * schedule_deferred - Schedule execution of deferred actions on an rq
1012  * @rq: target rq
1013  *
1014  * Schedule execution of deferred actions on @rq. Deferred actions are executed
1015  * with @rq locked but unpinned, and thus can unlock @rq to e.g. migrate tasks
1016  * to other rqs.
1017  */
schedule_deferred(struct rq * rq)1018 static void schedule_deferred(struct rq *rq)
1019 {
1020 	/*
1021 	 * This is the fallback when schedule_deferred_locked() can't use
1022 	 * the cheaper balance callback or wakeup hook paths (the target
1023 	 * CPU is not in dispatch or wakeup). Currently, this is primarily
1024 	 * hit by reenqueue operations targeting a remote CPU.
1025 	 *
1026 	 * Queue on the target CPU. The deferred work can run from any CPU
1027 	 * correctly - the _locked() path already processes remote rqs from
1028 	 * the calling CPU - but targeting the owning CPU allows IPI delivery
1029 	 * without waiting for the calling CPU to re-enable IRQs and is
1030 	 * cheaper as the reenqueue runs locally.
1031 	 */
1032 	irq_work_queue_on(&rq->scx.deferred_irq_work, cpu_of(rq));
1033 }
1034 
1035 /**
1036  * schedule_deferred_locked - Schedule execution of deferred actions on an rq
1037  * @rq: target rq
1038  *
1039  * Schedule execution of deferred actions on @rq. Equivalent to
1040  * schedule_deferred() but requires @rq to be locked and can be more efficient.
1041  */
schedule_deferred_locked(struct rq * rq)1042 static void schedule_deferred_locked(struct rq *rq)
1043 {
1044 	lockdep_assert_rq_held(rq);
1045 
1046 	/*
1047 	 * If in the middle of waking up a task, task_woken_scx() will be called
1048 	 * afterwards which will then run the deferred actions, no need to
1049 	 * schedule anything.
1050 	 */
1051 	if (rq->scx.flags & SCX_RQ_IN_WAKEUP)
1052 		return;
1053 
1054 	/* Don't do anything if there already is a deferred operation. */
1055 	if (rq->scx.flags & SCX_RQ_BAL_CB_PENDING)
1056 		return;
1057 
1058 	/*
1059 	 * If in dispatch, the balance callbacks will be called before rq lock
1060 	 * is released. Schedule one.
1061 	 *
1062 	 *
1063 	 * We can't directly insert the callback into the
1064 	 * rq's list: The call can drop its lock and make the pending balance
1065 	 * callback visible to unrelated code paths that call rq_pin_lock().
1066 	 *
1067 	 * Just let dispatch_one() know that it must do it itself.
1068 	 */
1069 	if (rq->scx.flags & SCX_RQ_IN_DISPATCH) {
1070 		rq->scx.flags |= SCX_RQ_BAL_CB_PENDING;
1071 		return;
1072 	}
1073 
1074 	/*
1075 	 * No scheduler hooks available. Use the generic irq_work path. The
1076 	 * above WAKEUP and DISPATCH paths should cover most of the cases and
1077 	 * the time to IRQ re-enable shouldn't be long.
1078 	 */
1079 	schedule_deferred(rq);
1080 }
1081 
schedule_dsq_reenq(struct scx_sched * sch,struct scx_dispatch_q * dsq,u64 reenq_flags,struct rq * locked_rq)1082 void schedule_dsq_reenq(struct scx_sched *sch, struct scx_dispatch_q *dsq,
1083 			u64 reenq_flags, struct rq *locked_rq)
1084 {
1085 	struct rq *rq;
1086 
1087 	/*
1088 	 * Allowing reenqueues doesn't make sense while bypassing. This also
1089 	 * blocks from new reenqueues to be scheduled on dead scheds.
1090 	 */
1091 	if (unlikely(READ_ONCE(sch->bypass_depth)))
1092 		return;
1093 
1094 	if (dsq->id == SCX_DSQ_LOCAL) {
1095 		rq = container_of(dsq, struct rq, scx.local_dsq);
1096 
1097 		/*
1098 		 * A sub-sched lacking baseline access on the target cid has no
1099 		 * business triggering IPIs. The lockless test is fine: slipping
1100 		 * through right after a revoke is harmless and a wrong denial
1101 		 * can't happen - if the caller has seen its ownership, so does
1102 		 * this test.
1103 		 */
1104 		if (unlikely(scx_missing_caps(sch, cpu_of(rq), SCX_CAP_BASE))) {
1105 			__scx_add_event(sch, SCX_EV_SUB_REENQ_DENIED, 1);
1106 			return;
1107 		}
1108 
1109 		struct scx_sched_pcpu *sch_pcpu = per_cpu_ptr(sch->pcpu, cpu_of(rq));
1110 		struct scx_deferred_reenq_local *drl = &sch_pcpu->deferred_reenq_local;
1111 
1112 		/*
1113 		 * Pairs with smp_mb() in process_deferred_reenq_locals() and
1114 		 * guarantees that there is a reenq_local() afterwards.
1115 		 */
1116 		smp_mb();
1117 
1118 		if (list_empty(&drl->node) ||
1119 		    (READ_ONCE(drl->flags) & reenq_flags) != reenq_flags) {
1120 
1121 			guard(raw_spinlock_irqsave)(&rq->scx.deferred_reenq_lock);
1122 
1123 			if (list_empty(&drl->node))
1124 				list_move_tail(&drl->node, &rq->scx.deferred_reenq_locals);
1125 			WRITE_ONCE(drl->flags, drl->flags | reenq_flags);
1126 		}
1127 	} else if (!(dsq->id & SCX_DSQ_FLAG_BUILTIN)) {
1128 		rq = this_rq();
1129 
1130 		struct scx_dsq_pcpu *dsq_pcpu = per_cpu_ptr(dsq->pcpu, cpu_of(rq));
1131 		struct scx_deferred_reenq_user *dru = &dsq_pcpu->deferred_reenq_user;
1132 
1133 		/*
1134 		 * Pairs with smp_mb() in process_deferred_reenq_users() and
1135 		 * guarantees that there is a reenq_user() afterwards.
1136 		 */
1137 		smp_mb();
1138 
1139 		if (list_empty(&dru->node) ||
1140 		    (READ_ONCE(dru->flags) & reenq_flags) != reenq_flags) {
1141 
1142 			guard(raw_spinlock_irqsave)(&rq->scx.deferred_reenq_lock);
1143 
1144 			if (list_empty(&dru->node))
1145 				list_move_tail(&dru->node, &rq->scx.deferred_reenq_users);
1146 			WRITE_ONCE(dru->flags, dru->flags | reenq_flags);
1147 		}
1148 	} else {
1149 		scx_error(sch, "DSQ 0x%llx not allowed for reenq", dsq->id);
1150 		return;
1151 	}
1152 
1153 	if (rq == locked_rq)
1154 		schedule_deferred_locked(rq);
1155 	else
1156 		schedule_deferred(rq);
1157 }
1158 
1159 /*
1160  * p->scx.slice_oob packs an out-of-band slice request into one atomic64. A zero
1161  * word means no request. Otherwise the fields are:
1162  *
1163  *   63      SCX_SLICE_OOB_PENDING, set on every request
1164  *   62-43   lower bits of issuing scheduler's id
1165  *   42-0    requested slice duration in nsecs
1166  *
1167  * A duration of SCX_SLICE_OOB_DUR_MASK means SCX_SLICE_INF. A finite dur
1168  * saturates at SCX_SLICE_OOB_DUR_MASK - 1. The id is used to detect and ignore
1169  * a request that outlived a task ownership change.
1170  *
1171  * Only the low 20 bits of sch->id are packed, which is enough to make
1172  * collisions practically impossible. A theoretical collision just lets a stale
1173  * request through once.
1174  */
1175 enum scx_slice_oob_consts {
1176 	SCX_SLICE_OOB_DUR_BITS	= 43,
1177 	SCX_SLICE_OOB_ID_BITS	= 64 - SCX_SLICE_OOB_DUR_BITS - 1,
1178 
1179 	SCX_SLICE_OOB_DUR_MASK	= (1LLU << SCX_SLICE_OOB_DUR_BITS) - 1,
1180 	SCX_SLICE_OOB_ID_SHIFT	= SCX_SLICE_OOB_DUR_BITS,
1181 	SCX_SLICE_OOB_ID_MASK	= (1LLU << SCX_SLICE_OOB_ID_BITS) - 1,
1182 	SCX_SLICE_OOB_PENDING	= 1LLU << 63,
1183 };
1184 
1185 /*
1186  * Slice and dsq_vtime write rules
1187  *
1188  * While @p is running, sleeping or queued on an rq-owned DSQ, both fields are
1189  * protected by the rq lock. While running, the rq lock is required because
1190  * update_curr_scx() RMWs the slice and the cap check for slice extension is
1191  * only reliable under the rq lock.
1192  *
1193  * While @p is queued on a user DSQ or on the BPF side, the kernel neither
1194  * consumes nor decides on the fields. Synchronizing the writers is the BPF
1195  * scheduler's responsibility. An rq-locked scx_bpf_task_set_slice() write and a
1196  * concurrent DSQ insertion commit can race each other and whichever lands last
1197  * wins.
1198  *
1199  * A DSQ insert kfunc doesn't update the fields directly. The verdict carries
1200  * the values and apply_slice_vtime() commits them at the insertion.
1201  *
1202  * scx_bpf_task_set_slice() may be called from any context and writes directly
1203  * only if @p's rq lock is already held, otherwise it bounces through
1204  * p->scx.slice_oob, applied under @p's rq lock at the next slice consideration.
1205  *
1206  * While %SCX_TASK_PROTECTED is set, every scheduler-reachable slice update is
1207  * refused. See set_task_slice_keep_oob().
1208  *
1209  * dsq_vtime orders the next PRIQ insertion and has no running-side consumer, so
1210  * scx_bpf_task_set_dsq_vtime() writes it directly. Fork-time init and direct
1211  * BPF stores from non-cid-form schedulers are outside these rules.
1212  */
1213 
1214 /* clear a pending slice request */
clear_task_slice_oob(struct task_struct * p)1215 static void clear_task_slice_oob(struct task_struct *p)
1216 {
1217 	if (unlikely(atomic64_read(&p->scx.slice_oob)))
1218 		atomic64_set(&p->scx.slice_oob, 0);
1219 }
1220 
1221 /**
1222  * dsq_insert_head - FIFO head insertion honoring %SCX_TASK_PROTECTED
1223  * @dsq: DSQ to insert into
1224  * @p: task being inserted
1225  *
1226  * A HEAD insert should land behind any leading protected tasks. Return %true
1227  * indicates whether @p became the first entry.
1228  */
dsq_insert_head(struct scx_dispatch_q * dsq,struct task_struct * p)1229 static bool dsq_insert_head(struct scx_dispatch_q *dsq, struct task_struct *p)
1230 {
1231 	struct list_head *pos = &dsq->list;
1232 	struct scx_dsq_list_node *node;
1233 
1234 	/*
1235 	 * Only rq-owned DSQs can hold protected tasks and the associated rq
1236 	 * lock keeps their flags stable.
1237 	 */
1238 	if (!dsq_is_rq_owned(dsq)) {
1239 		list_add(&p->scx.dsq_list.node, &dsq->list);
1240 		return true;
1241 	}
1242 
1243 	list_for_each_entry(node, &dsq->list, node) {
1244 		struct task_struct *q;
1245 
1246 		if (WARN_ON_ONCE(node->flags & SCX_DSQ_LNODE_ITER_CURSOR))
1247 			continue;
1248 
1249 		q = container_of(node, struct task_struct, scx.dsq_list);
1250 		if (!(q->scx.flags & SCX_TASK_PROTECTED))
1251 			break;
1252 
1253 		pos = &node->node;
1254 	}
1255 
1256 	list_add(&p->scx.dsq_list.node, pos);
1257 
1258 	return pos == &dsq->list;
1259 }
1260 
1261 /**
1262  * set_task_slice_keep_oob - Set @p's slice, leaving any pending oob request
1263  * @p: task of interest
1264  * @slice: slice to set
1265  *
1266  * While %SCX_TASK_PROTECTED is set, BPF schedulers may not modify the slice.
1267  * Refuse and return %false.
1268  */
set_task_slice_keep_oob(struct task_struct * p,u64 slice)1269 static bool set_task_slice_keep_oob(struct task_struct *p, u64 slice)
1270 {
1271 	lockdep_assert_rq_held(task_rq(p));
1272 
1273 	if (unlikely(p->scx.flags & SCX_TASK_PROTECTED))
1274 		return false;
1275 
1276 	p->scx.slice = slice;
1277 	return true;
1278 }
1279 
1280 /* set @p's slice, superseding any pending out-of-band request */
scx_set_task_slice(struct task_struct * p,u64 slice)1281 bool scx_set_task_slice(struct task_struct *p, u64 slice)
1282 {
1283 	if (!set_task_slice_keep_oob(p, slice))
1284 		return false;
1285 	clear_task_slice_oob(p);
1286 	return true;
1287 }
1288 
1289 /**
1290  * scx_task_slice_ended - @p's slice is consumed or given up
1291  * @rq: rq @p is on
1292  * @p: task of interest
1293  *
1294  * End what rides on the slice - the protection, and the rescue if @p is being
1295  * rescued.
1296  *
1297  * A dequeue normally ends the slice too. The exception is a save/restore pair
1298  * on the running task. Attribute changes like renice cycle the task through
1299  * dequeue and enqueue while it keeps executing, so the slice continues. A
1300  * queued task instead loses its DSQ position on any dequeue and the slice ends
1301  * with it.
1302  */
scx_task_slice_ended(struct rq * rq,struct task_struct * p)1303 void scx_task_slice_ended(struct rq *rq, struct task_struct *p)
1304 {
1305 	lockdep_assert_rq_held(rq);
1306 
1307 	p->scx.flags &= ~SCX_TASK_PROTECTED;
1308 	if (unlikely(p == scx_rescuee(rq)))
1309 		scx_rescue_end(rq);
1310 }
1311 
1312 /* request @p's slice to be set to @slice, see the write rules above */
set_task_slice_oob(struct scx_sched * sch,struct task_struct * p,u64 slice)1313 static void set_task_slice_oob(struct scx_sched *sch, struct task_struct *p, u64 slice)
1314 {
1315 	u64 dur;
1316 
1317 	if (slice == SCX_SLICE_INF) {
1318 		dur = SCX_SLICE_OOB_DUR_MASK;
1319 	} else if (unlikely(slice >= SCX_SLICE_OOB_DUR_MASK)) {
1320 		dur = SCX_SLICE_OOB_DUR_MASK - 1;
1321 		scx_add_event(sch, SCX_EV_SLICE_CLAMPED, 1);
1322 	} else {
1323 		dur = slice;
1324 	}
1325 
1326 	atomic64_set(&p->scx.slice_oob, SCX_SLICE_OOB_PENDING |
1327 		     ((sch->id & SCX_SLICE_OOB_ID_MASK) << SCX_SLICE_OOB_ID_SHIFT) | dur);
1328 }
1329 
1330 /*
1331  * Apply a pending out-of-band slice request under @rq's lock. A request whose
1332  * packed id no longer matches @p's current owner is dropped. An extension needs
1333  * baseline cpu access on @p's cid, shortening is always allowed, and a
1334  * protected slice refuses both. %SCX_EV_SLICE_DENIED counts the denials. See
1335  * the write rules above.
1336  */
apply_task_slice_oob(struct rq * rq,struct task_struct * p)1337 static void apply_task_slice_oob(struct rq *rq, struct task_struct *p)
1338 {
1339 	u64 oob, dur, slice;
1340 
1341 	lockdep_assert_rq_held(rq);
1342 
1343 	if (likely(!atomic64_read(&p->scx.slice_oob)))
1344 		return;
1345 
1346 	oob = atomic64_xchg(&p->scx.slice_oob, 0);
1347 	if (unlikely(!oob))
1348 		return;
1349 
1350 	/* the issuing scheduler no longer owns @p, drop the request */
1351 	if (unlikely(((oob >> SCX_SLICE_OOB_ID_SHIFT) & SCX_SLICE_OOB_ID_MASK) !=
1352 		     (scx_task_sched(p)->id & SCX_SLICE_OOB_ID_MASK)))
1353 		return;
1354 
1355 	dur = oob & SCX_SLICE_OOB_DUR_MASK;
1356 	slice = dur == SCX_SLICE_OOB_DUR_MASK ? SCX_SLICE_INF : dur;
1357 
1358 	if (slice > p->scx.slice &&
1359 	    unlikely(scx_missing_caps(scx_task_sched(p), cpu_of(rq), SCX_CAP_BASE))) {
1360 		__scx_add_event(scx_task_sched(p), SCX_EV_SLICE_DENIED, 1);
1361 		return;
1362 	}
1363 
1364 	if (unlikely(!set_task_slice_keep_oob(p, slice)))
1365 		__scx_add_event(scx_task_sched(p), SCX_EV_SLICE_DENIED, 1);
1366 }
1367 
1368 /*
1369  * A dsq insert kfunc doesn't write slice or dsq_vtime. The verdict carries them
1370  * and they are committed here, at the insertion. A zero @slice keeps the
1371  * current value, floored at 1 so the task isn't treated as expired.
1372  */
apply_slice_vtime(struct task_struct * p,u64 slice,u64 vtime,u64 enq_flags)1373 static void apply_slice_vtime(struct task_struct *p, u64 slice, u64 vtime, u64 enq_flags)
1374 {
1375 	if (slice) {
1376 		p->scx.slice = slice;
1377 		/*
1378 		 * An explicit slice supersedes a pending oob request. A carried
1379 		 * default refill is not an explicit request and must keep it.
1380 		 */
1381 		if (!(enq_flags & SCX_ENQ_SLICE_DFL))
1382 			clear_task_slice_oob(p);
1383 	} else if (!p->scx.slice) {
1384 		p->scx.slice = 1;
1385 	}
1386 
1387 	if (enq_flags & SCX_ENQ_DSQ_PRIQ)
1388 		p->scx.dsq_vtime = vtime;
1389 }
1390 
update_curr_scx(struct rq * rq)1391 static void update_curr_scx(struct rq *rq)
1392 {
1393 	struct task_struct *curr = rq->curr;
1394 	s64 delta_exec;
1395 
1396 	/* apply even on 0 delta_exec, callers may still act on the slice */
1397 	apply_task_slice_oob(rq, curr);
1398 
1399 	delta_exec = update_curr_common(rq);
1400 	if (unlikely(delta_exec <= 0))
1401 		return;
1402 
1403 	if (curr->scx.slice != SCX_SLICE_INF)
1404 		curr->scx.slice -= min_t(u64, curr->scx.slice, delta_exec);
1405 
1406 	if (unlikely(curr == scx_rescuee(rq)))
1407 		scx_rescue_charge(rq, delta_exec);
1408 
1409 	dl_server_update(&rq->ext_server, delta_exec);
1410 }
1411 
scx_dsq_priq_less(struct rb_node * node_a,const struct rb_node * node_b)1412 static bool scx_dsq_priq_less(struct rb_node *node_a,
1413 			      const struct rb_node *node_b)
1414 {
1415 	const struct task_struct *a =
1416 		container_of(node_a, struct task_struct, scx.dsq_priq);
1417 	const struct task_struct *b =
1418 		container_of(node_b, struct task_struct, scx.dsq_priq);
1419 
1420 	return time_before64(a->scx.dsq_vtime, b->scx.dsq_vtime);
1421 }
1422 
dsq_inc_nr(struct scx_dispatch_q * dsq,struct task_struct * p,u64 enq_flags)1423 static void dsq_inc_nr(struct scx_dispatch_q *dsq, struct task_struct *p, u64 enq_flags)
1424 {
1425 	/* scx_bpf_dsq_nr_queued() reads ->nr without locking, use WRITE_ONCE() */
1426 	WRITE_ONCE(dsq->nr, dsq->nr + 1);
1427 
1428 	/*
1429 	 * Once @p reaches a local DSQ, it can only leave it by being dispatched
1430 	 * to the CPU or dequeued. In both cases, the only way @p can go back to
1431 	 * the BPF sched is through enqueueing. If being inserted into a local
1432 	 * DSQ with IMMED, persist the state until the next enqueueing event in
1433 	 * scx_do_enqueue_task() so that we can maintain IMMED protection
1434 	 * through e.g. SAVE/RESTORE cycles and slice extensions.
1435 	 */
1436 	if (enq_flags & SCX_ENQ_IMMED) {
1437 		if (unlikely(dsq->id != SCX_DSQ_LOCAL)) {
1438 			WARN_ON_ONCE(!(enq_flags & SCX_ENQ_GDSQ_FALLBACK));
1439 			return;
1440 		}
1441 		p->scx.flags |= SCX_TASK_IMMED;
1442 	}
1443 
1444 	if (p->scx.flags & SCX_TASK_IMMED) {
1445 		struct rq *rq = container_of(dsq, struct rq, scx.local_dsq);
1446 
1447 		if (WARN_ON_ONCE(dsq->id != SCX_DSQ_LOCAL))
1448 			return;
1449 
1450 		rq->scx.nr_immed++;
1451 
1452 		/*
1453 		 * If @rq already had other tasks or the current task is not
1454 		 * done yet, @p can't go on the CPU immediately. Re-enqueue.
1455 		 */
1456 		if (unlikely(dsq->nr > 1 || !rq_is_open(rq, enq_flags)))
1457 			scx_schedule_reenq_local(rq, 0);
1458 	}
1459 }
1460 
dsq_dec_nr(struct scx_dispatch_q * dsq,struct task_struct * p)1461 static void dsq_dec_nr(struct scx_dispatch_q *dsq, struct task_struct *p)
1462 {
1463 	/* see dsq_inc_nr() */
1464 	WRITE_ONCE(dsq->nr, dsq->nr - 1);
1465 
1466 	if (p->scx.flags & SCX_TASK_IMMED) {
1467 		struct rq *rq = container_of(dsq, struct rq, scx.local_dsq);
1468 
1469 		if (WARN_ON_ONCE(dsq->id != SCX_DSQ_LOCAL) ||
1470 		    WARN_ON_ONCE(rq->scx.nr_immed <= 0))
1471 			return;
1472 
1473 		rq->scx.nr_immed--;
1474 	}
1475 }
1476 
refill_task_slice_dfl(struct scx_sched * sch,struct task_struct * p)1477 static void refill_task_slice_dfl(struct scx_sched *sch, struct task_struct *p)
1478 {
1479 	/*
1480 	 * A default refill is not an explicit request, so it must not drop a
1481 	 * pending out-of-band one, which is applied when @p next runs.
1482 	 */
1483 	set_task_slice_keep_oob(p, READ_ONCE(sch->slice_dfl));
1484 	__scx_add_event(sch, SCX_EV_REFILL_SLICE_DFL, 1);
1485 }
1486 
1487 /*
1488  * Return true if @p is moving due to an internal SCX migration, false
1489  * otherwise.
1490  */
task_scx_migrating(struct task_struct * p)1491 static inline bool task_scx_migrating(struct task_struct *p)
1492 {
1493 	/*
1494 	 * We only need to check sticky_cpu: it is set to the destination
1495 	 * CPU in move_remote_task_to_local_dsq() before deactivate_task()
1496 	 * and cleared when the task is enqueued on the destination, so it
1497 	 * is only non-negative during an internal SCX migration.
1498 	 */
1499 	return p->scx.sticky_cpu >= 0;
1500 }
1501 
1502 /*
1503  * Call ops.dequeue() if the task is in BPF custody and not migrating.
1504  * Clears %SCX_TASK_IN_CUSTODY when the callback is invoked.
1505  */
call_task_dequeue(struct scx_sched * sch,struct rq * rq,struct task_struct * p,u64 deq_flags)1506 static void call_task_dequeue(struct scx_sched *sch, struct rq *rq,
1507 			      struct task_struct *p, u64 deq_flags)
1508 {
1509 	if (!(p->scx.flags & SCX_TASK_IN_CUSTODY) || task_scx_migrating(p))
1510 		return;
1511 
1512 	if (SCX_HAS_OP(sch, dequeue))
1513 		SCX_CALL_OP_TASK(sch, dequeue, rq, p, deq_flags);
1514 
1515 	p->scx.flags &= ~SCX_TASK_IN_CUSTODY;
1516 }
1517 
rq_owned_post_enq(struct scx_sched * sch,struct rq * rq,struct scx_dispatch_q * dsq,struct task_struct * p,u64 enq_flags)1518 static void rq_owned_post_enq(struct scx_sched *sch, struct rq *rq,
1519 			      struct scx_dispatch_q *dsq, struct task_struct *p,
1520 			      u64 enq_flags)
1521 {
1522 	call_task_dequeue(sch, rq, p, 0);
1523 
1524 	/*
1525 	 * Only local inserts get the wakeup treatment below. Rejects kick the
1526 	 * deferred reenq and rescue parks are paced by the rescue timer.
1527 	 */
1528 	if (unlikely(dsq->id != SCX_DSQ_LOCAL)) {
1529 		if (dsq->id == SCX_DSQ_REJECT)
1530 			schedule_deferred_locked(rq);
1531 		return;
1532 	}
1533 
1534 	/*
1535 	 * Note that @rq's lock may be dropped between this enqueue and @p
1536 	 * actually getting on CPU. This gives higher-class tasks (e.g. RT)
1537 	 * an opportunity to wake up on @rq and prevent @p from running.
1538 	 * Here are some concrete examples:
1539 	 *
1540 	 * Example 1:
1541 	 *
1542 	 * We dispatch two tasks from a single ops.dispatch():
1543 	 * - First, a local task to this CPU's local DSQ;
1544 	 * - Second, a local/remote task to a remote CPU's local DSQ.
1545 	 * We must drop the local rq lock in order to finish the second
1546 	 * dispatch. In that time, an RT task can wake up on the local rq.
1547 	 *
1548 	 * Example 2:
1549 	 *
1550 	 * We dispatch a local/remote task to a remote CPU's local DSQ.
1551 	 * We must drop the remote rq lock before the dispatched task can run,
1552 	 * which gives an RT task an opportunity to wake up on the remote rq.
1553 	 *
1554 	 * Both examples work the same if we replace dispatching with moving
1555 	 * the tasks from a user-created DSQ.
1556 	 *
1557 	 * We must detect these wakeups so that we can re-enqueue IMMED tasks
1558 	 * from @rq's local DSQ. scx_wakeup_preempt() serves exactly this
1559 	 * purpose, but for it to be invoked, we must ensure that we bump
1560 	 * @rq->next_class to &ext_sched_class if it's currently idle.
1561 	 *
1562 	 * wakeup_preempt() does the bumping, and since we only invoke it if
1563 	 * @rq->next_class is below &ext_sched_class, it will also
1564 	 * resched_curr(rq).
1565 	 */
1566 	if (sched_class_above(p->sched_class, rq->next_class))
1567 		wakeup_preempt(rq, p, 0);
1568 
1569 	/*
1570 	 * If @rq is in dispatch, the CPU is already vacant and looking for the
1571 	 * next task to run. No need to preempt or trigger resched after moving
1572 	 * @p into its local DSQ.
1573 	 * Note that the wakeup_preempt() above may have already triggered
1574 	 * a resched if @rq->next_class was idle. It's harmless, since
1575 	 * need_resched is cleared immediately after task pick.
1576 	 */
1577 	if (rq->scx.flags & SCX_RQ_IN_DISPATCH)
1578 		return;
1579 
1580 	if ((enq_flags & SCX_ENQ_PREEMPT) && p != rq->curr &&
1581 	    rq->curr->sched_class == &ext_sched_class) {
1582 		if (likely(scx_set_task_slice(rq->curr, 0)))
1583 			resched_curr(rq);
1584 		else
1585 			__scx_add_event(sch, SCX_EV_SLICE_DENIED, 1);
1586 	}
1587 }
1588 
scx_dispatch_enqueue(struct scx_sched * sch,struct rq * rq,struct scx_dispatch_q * dsq,struct task_struct * p,u64 slice,u64 vtime,u64 enq_flags)1589 static void scx_dispatch_enqueue(struct scx_sched *sch, struct rq *rq,
1590 				 struct scx_dispatch_q *dsq, struct task_struct *p,
1591 				 u64 slice, u64 vtime, u64 enq_flags)
1592 {
1593 	bool is_rq_owned = false;
1594 
1595 	if (dsq->id == SCX_DSQ_LOCAL) {
1596 		dsq = scx_resolve_local_dsq(sch, rq, p, &enq_flags);
1597 		is_rq_owned = true;
1598 	}
1599 
1600 	WARN_ON_ONCE(p->scx.dsq || !list_empty(&p->scx.dsq_list.node));
1601 	WARN_ON_ONCE((p->scx.dsq_flags & SCX_TASK_DSQ_ON_PRIQ) ||
1602 		     !RB_EMPTY_NODE(&p->scx.dsq_priq));
1603 
1604 	if (!is_rq_owned) {
1605 		raw_spin_lock_nested(&dsq->lock,
1606 			(enq_flags & SCX_ENQ_NESTED) ? SINGLE_DEPTH_NESTING : 0);
1607 
1608 		if (unlikely(dsq->id == SCX_DSQ_INVALID)) {
1609 			scx_error(sch, "attempting to dispatch to a destroyed dsq");
1610 			/* fall back to the global dsq */
1611 			raw_spin_unlock(&dsq->lock);
1612 			dsq = find_global_dsq(sch, task_cpu(p));
1613 			raw_spin_lock(&dsq->lock);
1614 		}
1615 	}
1616 
1617 	if (unlikely((dsq->id & SCX_DSQ_FLAG_BUILTIN) &&
1618 		     (enq_flags & SCX_ENQ_DSQ_PRIQ))) {
1619 		/*
1620 		 * SCX_DSQ_LOCAL and SCX_DSQ_GLOBAL DSQs always consume from
1621 		 * their FIFO queues. To avoid confusion and accidentally
1622 		 * starving vtime-dispatched tasks by FIFO-dispatched tasks, we
1623 		 * disallow any internal DSQ from doing vtime ordering of
1624 		 * tasks.
1625 		 */
1626 		scx_error(sch, "cannot use vtime ordering for built-in DSQs");
1627 		enq_flags &= ~SCX_ENQ_DSQ_PRIQ;
1628 	}
1629 
1630 	/*
1631 	 * @dsq is locked and @enq_flags is sanitized. Commit the carried slice
1632 	 * and vtime before the PRIQ insertion below reads the new dsq_vtime.
1633 	 */
1634 	if (enq_flags & SCX_ENQ_APPLY_SLICE)
1635 		apply_slice_vtime(p, slice, vtime, enq_flags);
1636 
1637 	if (enq_flags & SCX_ENQ_DSQ_PRIQ) {
1638 		struct rb_node *rbp;
1639 
1640 		/*
1641 		 * A PRIQ DSQ shouldn't be using FIFO enqueueing. As tasks are
1642 		 * linked to both the rbtree and list on PRIQs, this can only be
1643 		 * tested easily when adding the first task.
1644 		 */
1645 		if (unlikely(RB_EMPTY_ROOT(&dsq->priq) &&
1646 			     nldsq_next_task(dsq, NULL, false)))
1647 			scx_error(sch, "DSQ ID 0x%016llx already had FIFO-enqueued tasks",
1648 				  dsq->id);
1649 
1650 		p->scx.dsq_flags |= SCX_TASK_DSQ_ON_PRIQ;
1651 		rb_add(&p->scx.dsq_priq, &dsq->priq, scx_dsq_priq_less);
1652 
1653 		/*
1654 		 * Find the previous task and insert after it on the list so
1655 		 * that @dsq->list is vtime ordered.
1656 		 */
1657 		rbp = rb_prev(&p->scx.dsq_priq);
1658 		if (rbp) {
1659 			struct task_struct *prev =
1660 				container_of(rbp, struct task_struct,
1661 					     scx.dsq_priq);
1662 			list_add(&p->scx.dsq_list.node, &prev->scx.dsq_list.node);
1663 			/* first task unchanged - no update needed */
1664 		} else {
1665 			list_add(&p->scx.dsq_list.node, &dsq->list);
1666 			/* not builtin and new task is at head - use fastpath */
1667 			rcu_assign_pointer(dsq->first_task, p);
1668 		}
1669 	} else {
1670 		/* a FIFO DSQ shouldn't be using PRIQ enqueuing */
1671 		if (unlikely(!RB_EMPTY_ROOT(&dsq->priq)))
1672 			scx_error(sch, "DSQ ID 0x%016llx already had PRIQ-enqueued tasks",
1673 				  dsq->id);
1674 
1675 		if (enq_flags & (SCX_ENQ_HEAD | SCX_ENQ_PREEMPT)) {
1676 			/* new task inserted at head - use fastpath */
1677 			if (dsq_insert_head(dsq, p) && !(dsq->id & SCX_DSQ_FLAG_BUILTIN))
1678 				rcu_assign_pointer(dsq->first_task, p);
1679 		} else {
1680 			/*
1681 			 * dsq->list can contain parked BPF iterator cursors, so
1682 			 * list_empty() here isn't a reliable proxy for "no real
1683 			 * task in the DSQ". Test dsq->first_task directly.
1684 			 */
1685 			list_add_tail(&p->scx.dsq_list.node, &dsq->list);
1686 			if (!dsq->first_task && !(dsq->id & SCX_DSQ_FLAG_BUILTIN))
1687 				rcu_assign_pointer(dsq->first_task, p);
1688 		}
1689 	}
1690 
1691 	/* seq records the order tasks are queued, used by BPF DSQ iterator */
1692 	WRITE_ONCE(dsq->seq, dsq->seq + 1);
1693 	p->scx.dsq_seq = dsq->seq;
1694 
1695 	dsq_inc_nr(dsq, p, enq_flags);
1696 	p->scx.dsq = dsq;
1697 
1698 	/*
1699 	 * Update custody and call ops.dequeue() before clearing ops_state:
1700 	 * once ops_state is cleared, waiters in ops_dequeue() can proceed
1701 	 * and dequeue_task_scx() will RMW p->scx.flags. If we clear
1702 	 * ops_state first, both sides would modify p->scx.flags
1703 	 * concurrently in a non-atomic way.
1704 	 */
1705 	if (is_rq_owned) {
1706 		rq_owned_post_enq(sch, rq, dsq, p, enq_flags);
1707 	} else {
1708 		/*
1709 		 * Global and bypass DSQs are terminal - the task leaves the
1710 		 * scheduler's custody, so ops.dequeue() fires here. It can run
1711 		 * without @p's rq lock (finish_dispatch() passes the dispatch
1712 		 * rq); that's safe because dequeue_task_scx() waits on
1713 		 * SCX_OPSS_DISPATCHING (see the ops_state note above) and so
1714 		 * can't race it. A non-terminal DSQ keeps the task in custody.
1715 		 */
1716 		if (dsq->id == SCX_DSQ_GLOBAL || dsq->id == SCX_DSQ_BYPASS)
1717 			call_task_dequeue(sch, rq, p, 0);
1718 		else
1719 			p->scx.flags |= SCX_TASK_IN_CUSTODY;
1720 
1721 		raw_spin_unlock(&dsq->lock);
1722 	}
1723 
1724 	/*
1725 	 * We're transitioning out of QUEUEING or DISPATCHING. store_release to
1726 	 * match waiters' load_acquire.
1727 	 */
1728 	if (enq_flags & SCX_ENQ_CLEAR_OPSS)
1729 		atomic_long_set_release(&p->scx.ops_state, SCX_OPSS_NONE);
1730 }
1731 
scx_task_unlink_from_dsq(struct task_struct * p,struct scx_dispatch_q * dsq)1732 void scx_task_unlink_from_dsq(struct task_struct *p, struct scx_dispatch_q *dsq)
1733 {
1734 	WARN_ON_ONCE(list_empty(&p->scx.dsq_list.node));
1735 
1736 	if (p->scx.dsq_flags & SCX_TASK_DSQ_ON_PRIQ) {
1737 		rb_erase(&p->scx.dsq_priq, &dsq->priq);
1738 		RB_CLEAR_NODE(&p->scx.dsq_priq);
1739 		p->scx.dsq_flags &= ~SCX_TASK_DSQ_ON_PRIQ;
1740 	}
1741 
1742 	list_del_init(&p->scx.dsq_list.node);
1743 	dsq_dec_nr(dsq, p);
1744 
1745 	if (!(dsq->id & SCX_DSQ_FLAG_BUILTIN) && rcu_access_pointer(dsq->first_task) == p) {
1746 		struct task_struct *first_task;
1747 
1748 		first_task = nldsq_next_task(dsq, NULL, false);
1749 		rcu_assign_pointer(dsq->first_task, first_task);
1750 	}
1751 }
1752 
scx_dispatch_dequeue(struct rq * rq,struct task_struct * p)1753 void scx_dispatch_dequeue(struct rq *rq, struct task_struct *p)
1754 {
1755 	struct scx_dispatch_q *dsq = p->scx.dsq;
1756 	bool is_rq_owned = dsq && dsq_is_rq_owned(dsq);
1757 
1758 	lockdep_assert_rq_held(rq);
1759 
1760 	if (!dsq) {
1761 		/*
1762 		 * If !dsq && on-list, @p is on @rq's ddsp_deferred_locals.
1763 		 * Unlinking is all that's needed to cancel.
1764 		 */
1765 		if (unlikely(!list_empty(&p->scx.dsq_list.node)))
1766 			list_del_init(&p->scx.dsq_list.node);
1767 
1768 		/*
1769 		 * When dispatching directly from the BPF scheduler to a local
1770 		 * DSQ, the task isn't associated with any DSQ but
1771 		 * @p->scx.holding_cpu may be set under the protection of
1772 		 * %SCX_OPSS_DISPATCHING.
1773 		 */
1774 		if (p->scx.holding_cpu >= 0)
1775 			p->scx.holding_cpu = -1;
1776 
1777 		return;
1778 	}
1779 
1780 	if (!is_rq_owned)
1781 		raw_spin_lock(&dsq->lock);
1782 
1783 	/*
1784 	 * Now that we hold @dsq->lock, @p->holding_cpu and @p->scx.dsq_* can't
1785 	 * change underneath us.
1786 	*/
1787 	if (p->scx.holding_cpu < 0) {
1788 		/* @p must still be on @dsq, dequeue */
1789 		scx_task_unlink_from_dsq(p, dsq);
1790 	} else {
1791 		/*
1792 		 * We're racing against dispatch_to_local_dsq() which already
1793 		 * removed @p from @dsq and set @p->scx.holding_cpu. Clear the
1794 		 * holding_cpu which tells dispatch_to_local_dsq() that it lost
1795 		 * the race.
1796 		 */
1797 		WARN_ON_ONCE(!list_empty(&p->scx.dsq_list.node));
1798 		p->scx.holding_cpu = -1;
1799 	}
1800 	p->scx.dsq = NULL;
1801 
1802 	if (!is_rq_owned)
1803 		raw_spin_unlock(&dsq->lock);
1804 }
1805 
1806 /*
1807  * Abbreviated version of scx_dispatch_dequeue() that can be used when both
1808  * @p's rq and dsq are locked.
1809  */
dispatch_dequeue_locked(struct task_struct * p,struct scx_dispatch_q * dsq)1810 static void dispatch_dequeue_locked(struct task_struct *p,
1811 				    struct scx_dispatch_q *dsq)
1812 {
1813 	lockdep_assert_rq_held(task_rq(p));
1814 	lockdep_assert_held(&dsq->lock);
1815 
1816 	scx_task_unlink_from_dsq(p, dsq);
1817 	p->scx.dsq = NULL;
1818 }
1819 
find_dsq_for_dispatch(struct scx_sched * sch,struct rq * rq,u64 dsq_id,s32 tcpu)1820 static struct scx_dispatch_q *find_dsq_for_dispatch(struct scx_sched *sch,
1821 						    struct rq *rq, u64 dsq_id,
1822 						    s32 tcpu)
1823 {
1824 	struct scx_dispatch_q *dsq;
1825 
1826 	if (dsq_id == SCX_DSQ_LOCAL)
1827 		return &rq->scx.local_dsq;
1828 
1829 	if ((dsq_id & SCX_DSQ_LOCAL_ON) == SCX_DSQ_LOCAL_ON) {
1830 		s32 cpu = scx_cpu_ret(sch, dsq_id & SCX_DSQ_LOCAL_CPU_MASK);
1831 
1832 		if (!scx_cpu_valid(sch, cpu, "in SCX_DSQ_LOCAL_ON dispatch verdict"))
1833 			return find_global_dsq(sch, tcpu);
1834 
1835 		return &cpu_rq(cpu)->scx.local_dsq;
1836 	}
1837 
1838 	if (dsq_id == SCX_DSQ_GLOBAL)
1839 		dsq = find_global_dsq(sch, tcpu);
1840 	else
1841 		dsq = find_user_dsq(sch, dsq_id);
1842 
1843 	/*
1844 	 * Built-in DSQs are never inserted into dsq_hash, so REJECT and RESCUE
1845 	 * hit the error below. They cannot be reached with an ID.
1846 	 */
1847 	if (unlikely(!dsq)) {
1848 		scx_error(sch, "non-existent DSQ 0x%llx", dsq_id);
1849 		return find_global_dsq(sch, tcpu);
1850 	}
1851 
1852 	return dsq;
1853 }
1854 
mark_direct_dispatch(struct scx_sched * sch,struct task_struct * ddsp_task,struct task_struct * p,u64 dsq_id,u64 slice,u64 vtime,u64 enq_flags)1855 static void mark_direct_dispatch(struct scx_sched *sch,
1856 				 struct task_struct *ddsp_task,
1857 				 struct task_struct *p, u64 dsq_id,
1858 				 u64 slice, u64 vtime, u64 enq_flags)
1859 {
1860 	/*
1861 	 * Mark that dispatch already happened from ops.select_cpu() or
1862 	 * ops.enqueue() by spoiling direct_dispatch_task with a non-NULL value
1863 	 * which can never match a valid task pointer.
1864 	 */
1865 	__this_cpu_write(direct_dispatch_task, ERR_PTR(-ESRCH));
1866 
1867 	/* @p must match the task on the enqueue path */
1868 	if (unlikely(p != ddsp_task)) {
1869 		if (IS_ERR(ddsp_task))
1870 			scx_error(sch, "%s[%d] already direct-dispatched",
1871 				  p->comm, p->pid);
1872 		else
1873 			scx_error(sch, "scheduling for %s[%d] but trying to direct-dispatch %s[%d]",
1874 				  ddsp_task->comm, ddsp_task->pid,
1875 				  p->comm, p->pid);
1876 		return;
1877 	}
1878 
1879 	WARN_ON_ONCE(p->scx.ddsp_dsq_id != SCX_DSQ_INVALID);
1880 	WARN_ON_ONCE(p->scx.ddsp_enq_flags);
1881 
1882 	p->scx.ddsp_slice = slice;
1883 	p->scx.ddsp_vtime = vtime;
1884 	p->scx.ddsp_dsq_id = dsq_id;
1885 	p->scx.ddsp_enq_flags = enq_flags;
1886 }
1887 
1888 /*
1889  * Clear @p direct dispatch state when leaving the scheduler.
1890  *
1891  * Direct dispatch state must be cleared in the following cases:
1892  *  - direct_dispatch(): cleared on the synchronous enqueue path, deferred
1893  *    dispatch keeps the state until consumed
1894  *  - process_ddsp_deferred_locals(): cleared after consuming deferred state,
1895  *  - scx_do_enqueue_task(): cleared on enqueue fallbacks where the dispatch
1896  *    verdict is ignored (local/global/bypass)
1897  *  - dequeue_task_scx(): cleared after scx_dispatch_dequeue(), covering
1898  *    deferred cancellation and holding_cpu races
1899  *  - scx_disable_task(): cleared for queued wakeup tasks, which are excluded by
1900  *    the scx_bypass() loop, so that stale state is not reused by a subsequent
1901  *    scheduler instance
1902  */
clear_direct_dispatch(struct task_struct * p)1903 static inline void clear_direct_dispatch(struct task_struct *p)
1904 {
1905 	p->scx.ddsp_dsq_id = SCX_DSQ_INVALID;
1906 	p->scx.ddsp_enq_flags = 0;
1907 }
1908 
direct_dispatch(struct scx_sched * sch,struct task_struct * p,u64 enq_flags)1909 static void direct_dispatch(struct scx_sched *sch, struct task_struct *p,
1910 			    u64 enq_flags)
1911 {
1912 	struct rq *rq = task_rq(p);
1913 	struct scx_dispatch_q *dsq =
1914 		find_dsq_for_dispatch(sch, rq, p->scx.ddsp_dsq_id, task_cpu(p));
1915 	u64 ddsp_enq_flags, slice, vtime;
1916 
1917 	p->scx.ddsp_enq_flags |= enq_flags;
1918 
1919 	/*
1920 	 * We are in the enqueue path with @rq locked and pinned, and thus can't
1921 	 * double lock a remote rq and enqueue to its local DSQ. For
1922 	 * DSQ_LOCAL_ON verdicts targeting the local DSQ of a remote CPU, defer
1923 	 * the enqueue so that it's executed when @rq can be unlocked.
1924 	 */
1925 	if (dsq->id == SCX_DSQ_LOCAL && dsq != &rq->scx.local_dsq) {
1926 		unsigned long opss;
1927 
1928 		opss = atomic_long_read(&p->scx.ops_state) & SCX_OPSS_STATE_MASK;
1929 
1930 		switch (opss & SCX_OPSS_STATE_MASK) {
1931 		case SCX_OPSS_NONE:
1932 			break;
1933 		case SCX_OPSS_QUEUEING:
1934 			/*
1935 			 * As @p was never passed to the BPF side, _release is
1936 			 * not strictly necessary. Still do it for consistency.
1937 			 */
1938 			atomic_long_set_release(&p->scx.ops_state, SCX_OPSS_NONE);
1939 			break;
1940 		default:
1941 			WARN_ONCE(true, "sched_ext: %s[%d] has invalid ops state 0x%lx in direct_dispatch()",
1942 				  p->comm, p->pid, opss);
1943 			atomic_long_set_release(&p->scx.ops_state, SCX_OPSS_NONE);
1944 			break;
1945 		}
1946 
1947 		WARN_ON_ONCE(p->scx.dsq || !list_empty(&p->scx.dsq_list.node));
1948 		list_add_tail(&p->scx.dsq_list.node,
1949 			      &rq->scx.ddsp_deferred_locals);
1950 		schedule_deferred_locked(rq);
1951 		return;
1952 	}
1953 
1954 	ddsp_enq_flags = p->scx.ddsp_enq_flags;
1955 	slice = p->scx.ddsp_slice;
1956 	vtime = p->scx.ddsp_vtime;
1957 	clear_direct_dispatch(p);
1958 
1959 	scx_dispatch_enqueue(sch, rq, dsq, p, slice, vtime,
1960 			     ddsp_enq_flags | SCX_ENQ_APPLY_SLICE | SCX_ENQ_CLEAR_OPSS);
1961 }
1962 
scx_rq_online(struct rq * rq)1963 bool scx_rq_online(struct rq *rq)
1964 {
1965 	/*
1966 	 * Test both cpu_active() and %SCX_RQ_ONLINE. %SCX_RQ_ONLINE indicates
1967 	 * the online state as seen from the BPF scheduler. cpu_active() test
1968 	 * guarantees that, if this function returns %true, %SCX_RQ_ONLINE will
1969 	 * stay set until the current scheduling operation is complete even if
1970 	 * we aren't locking @rq.
1971 	 */
1972 	return likely((rq->scx.flags & SCX_RQ_ONLINE) && cpu_active(cpu_of(rq)));
1973 }
1974 
scx_do_enqueue_task(struct rq * rq,struct task_struct * p,u64 enq_flags,int sticky_cpu)1975 void scx_do_enqueue_task(struct rq *rq, struct task_struct *p, u64 enq_flags,
1976 			 int sticky_cpu)
1977 {
1978 	struct scx_sched *sch = scx_task_sched(p);
1979 	struct task_struct **ddsp_taskp;
1980 	struct scx_dispatch_q *dsq;
1981 	unsigned long qseq;
1982 
1983 	WARN_ON_ONCE(!(p->scx.flags & SCX_TASK_QUEUED));
1984 
1985 	/* internal movements - rq migration / RESTORE */
1986 	if (sticky_cpu == cpu_of(rq))
1987 		goto local_norefill;
1988 
1989 	/*
1990 	 * Clear persistent TASK_IMMED for fresh enqueues, see dsq_inc_nr().
1991 	 * Note that exiting and migration-disabled tasks that skip
1992 	 * ops.enqueue() below will lose IMMED protection unless
1993 	 * %SCX_OPS_ENQ_EXITING / %SCX_OPS_ENQ_MIGRATION_DISABLED are set.
1994 	 */
1995 	p->scx.flags &= ~SCX_TASK_IMMED;
1996 
1997 	/*
1998 	 * A task reenqueued too many times without running means the scheduler
1999 	 * keeps re-deciding a placement it can't honor, e.g. re-inserting to a
2000 	 * cid it lacks caps on. Eject the owning scheduler and strand the task
2001 	 * to be picked up during sched exit.
2002 	 */
2003 	if (enq_flags & SCX_ENQ_REENQ) {
2004 		if (++p->scx.reenq_cnt > 1)
2005 			__scx_add_event(sch, SCX_EV_REENQ_REPEAT, 1);
2006 
2007 		if (unlikely(p->scx.reenq_cnt > SCX_REENQ_MAX_REPEAT)) {
2008 			__scx_exit(sch, SCX_EXIT_ERROR_REENQ, 0, cpu_of(rq),
2009 				   "%s[%d] reenqueued %u times without running",
2010 				   p->comm, p->pid, p->scx.reenq_cnt);
2011 			return;
2012 		}
2013 	}
2014 
2015 	/*
2016 	 * If !scx_rq_online(), we already told the BPF scheduler that the CPU
2017 	 * is offline and are just running the hotplug path. Don't bother the
2018 	 * BPF scheduler.
2019 	 */
2020 	if (!scx_rq_online(rq))
2021 		goto local;
2022 
2023 	if (scx_bypassing(sch, cpu_of(rq))) {
2024 		__scx_add_event(sch, SCX_EV_BYPASS_DISPATCH, 1);
2025 		goto bypass;
2026 	}
2027 
2028 	if (p->scx.ddsp_dsq_id != SCX_DSQ_INVALID)
2029 		goto direct;
2030 
2031 	/* see %SCX_OPS_ENQ_EXITING */
2032 	if (!(sch->ops.flags & SCX_OPS_ENQ_EXITING) &&
2033 	    unlikely(p->flags & PF_EXITING)) {
2034 		__scx_add_event(sch, SCX_EV_ENQ_SKIP_EXITING, 1);
2035 		enq_flags |= SCX_ENQ_RESCUE;	/* avoid looping on cap rejection */
2036 		goto local;
2037 	}
2038 
2039 	/* see %SCX_OPS_ENQ_MIGRATION_DISABLED */
2040 	if (!(sch->ops.flags & SCX_OPS_ENQ_MIGRATION_DISABLED) &&
2041 	    is_migration_disabled(p)) {
2042 		__scx_add_event(sch, SCX_EV_ENQ_SKIP_MIGRATION_DISABLED, 1);
2043 		goto local;
2044 	}
2045 
2046 	if (unlikely(!SCX_HAS_OP(sch, enqueue)))
2047 		goto global;
2048 
2049 	/* DSQ bypass didn't trigger, enqueue on the BPF scheduler */
2050 	qseq = rq->scx.ops_qseq++ << SCX_OPSS_QSEQ_SHIFT;
2051 
2052 	WARN_ON_ONCE(atomic_long_read(&p->scx.ops_state) != SCX_OPSS_NONE);
2053 	atomic_long_set(&p->scx.ops_state, SCX_OPSS_QUEUEING | qseq);
2054 
2055 	ddsp_taskp = this_cpu_ptr(&direct_dispatch_task);
2056 	WARN_ON_ONCE(*ddsp_taskp);
2057 	*ddsp_taskp = p;
2058 
2059 	SCX_CALL_OP_TASK(sch, enqueue, rq, p, enq_flags);
2060 
2061 	*ddsp_taskp = NULL;
2062 	if (p->scx.ddsp_dsq_id != SCX_DSQ_INVALID)
2063 		goto direct;
2064 
2065 	/*
2066 	 * Task is now in BPF scheduler's custody. Set %SCX_TASK_IN_CUSTODY
2067 	 * so ops.dequeue() is called when it leaves custody.
2068 	 */
2069 	p->scx.flags |= SCX_TASK_IN_CUSTODY;
2070 
2071 	/*
2072 	 * If not directly dispatched, QUEUEING isn't clear yet and dispatch or
2073 	 * dequeue may be waiting. The store_release matches their load_acquire.
2074 	 */
2075 	atomic_long_set_release(&p->scx.ops_state, SCX_OPSS_QUEUED | qseq);
2076 	return;
2077 
2078 direct:
2079 	direct_dispatch(sch, p, enq_flags);
2080 	return;
2081 local_norefill:
2082 	scx_dispatch_enqueue(sch, rq, &rq->scx.local_dsq, p, 0, 0, enq_flags);
2083 	return;
2084 local:
2085 	dsq = &rq->scx.local_dsq;
2086 	goto enqueue;
2087 global:
2088 	dsq = find_global_dsq(sch, task_cpu(p));
2089 	goto enqueue;
2090 bypass:
2091 	dsq = bypass_enq_target_dsq(sch, task_cpu(p));
2092 	goto enqueue;
2093 
2094 enqueue:
2095 	refill_task_slice_dfl(sch, p);
2096 	clear_direct_dispatch(p);
2097 	scx_dispatch_enqueue(sch, rq, dsq, p, 0, 0, enq_flags);
2098 }
2099 
task_runnable(const struct task_struct * p)2100 static bool task_runnable(const struct task_struct *p)
2101 {
2102 	return !list_empty(&p->scx.runnable_node);
2103 }
2104 
set_task_runnable(struct rq * rq,struct task_struct * p)2105 static void set_task_runnable(struct rq *rq, struct task_struct *p)
2106 {
2107 	lockdep_assert_rq_held(rq);
2108 
2109 	if (p->scx.flags & SCX_TASK_RESET_RUNNABLE_AT) {
2110 		p->scx.runnable_at = jiffies;
2111 		p->scx.flags &= ~SCX_TASK_RESET_RUNNABLE_AT;
2112 	}
2113 
2114 	/*
2115 	 * list_add_tail() must be used. scx_bypass() depends on tasks being
2116 	 * appended to the runnable_list.
2117 	 */
2118 	list_add_tail(&p->scx.runnable_node, &rq->scx.runnable_list);
2119 
2120 	/*
2121 	 * Record the rq @p is runnable on, maintained under the rq lock so it
2122 	 * stays valid unlike task_cpu(), which a remote wakeup can move under
2123 	 * pi_lock alone.
2124 	 */
2125 	WRITE_ONCE(p->scx.runnable_cpu, cpu_of(rq));
2126 }
2127 
clr_task_runnable(struct task_struct * p,bool reset_runnable_at)2128 static void clr_task_runnable(struct task_struct *p, bool reset_runnable_at)
2129 {
2130 	list_del_init(&p->scx.runnable_node);
2131 	WRITE_ONCE(p->scx.runnable_cpu, -1);
2132 	if (reset_runnable_at) {
2133 		p->scx.flags |= SCX_TASK_RESET_RUNNABLE_AT;
2134 		p->scx.reenq_cnt = 0;
2135 	}
2136 }
2137 
enqueue_task_scx(struct rq * rq,struct task_struct * p,int core_enq_flags)2138 static void enqueue_task_scx(struct rq *rq, struct task_struct *p, int core_enq_flags)
2139 {
2140 	struct scx_sched *sch = scx_task_sched(p);
2141 	int sticky_cpu = p->scx.sticky_cpu;
2142 	u64 enq_flags = core_enq_flags | rq->scx.remote_activate_enq_flags;
2143 
2144 	if (enq_flags & ENQUEUE_WAKEUP)
2145 		rq->scx.flags |= SCX_RQ_IN_WAKEUP;
2146 
2147 	/*
2148 	 * Restoring a running task will be immediately followed by
2149 	 * set_next_task_scx() which expects the task to not be on the BPF
2150 	 * scheduler as tasks can only start running through local DSQs. Force
2151 	 * direct-dispatch into the local DSQ by setting the sticky_cpu. Mark
2152 	 * IGNORE_CAPS to force entry into the local DSQ.
2153 	 */
2154 	if (unlikely(enq_flags & ENQUEUE_RESTORE) && task_current(rq, p)) {
2155 		sticky_cpu = cpu_of(rq);
2156 		enq_flags |= SCX_ENQ_IGNORE_CAPS;
2157 	}
2158 
2159 	if (p->scx.flags & SCX_TASK_QUEUED) {
2160 		WARN_ON_ONCE(!task_runnable(p));
2161 		goto out;
2162 	}
2163 
2164 	set_task_runnable(rq, p);
2165 	p->scx.flags |= SCX_TASK_QUEUED;
2166 	rq->scx.nr_running++;
2167 	add_nr_running(rq, 1);
2168 
2169 	if (SCX_HAS_OP(sch, runnable) && !task_on_rq_migrating(p))
2170 		SCX_CALL_OP_TASK(sch, runnable, rq, p, enq_flags);
2171 
2172 	/* Start dl_server if this is the first task being enqueued */
2173 	if (rq->scx.nr_running == 1)
2174 		dl_server_start(&rq->ext_server);
2175 
2176 	scx_do_enqueue_task(rq, p, enq_flags, sticky_cpu);
2177 
2178 	if (sticky_cpu >= 0)
2179 		p->scx.sticky_cpu = -1;
2180 out:
2181 	rq->scx.flags &= ~SCX_RQ_IN_WAKEUP;
2182 
2183 	if ((enq_flags & SCX_ENQ_CPU_SELECTED) &&
2184 	    unlikely(cpu_of(rq) != p->scx.selected_cpu))
2185 		__scx_add_event(sch, SCX_EV_SELECT_CPU_FALLBACK, 1);
2186 }
2187 
ops_dequeue(struct rq * rq,struct task_struct * p,u64 deq_flags)2188 static void ops_dequeue(struct rq *rq, struct task_struct *p, u64 deq_flags)
2189 {
2190 	struct scx_sched *sch = scx_task_sched(p);
2191 	unsigned long opss;
2192 
2193 	/* dequeue is always temporary, don't reset runnable_at */
2194 	clr_task_runnable(p, false);
2195 
2196 retry:
2197 	/* acquire ensures that we see the preceding updates on QUEUED */
2198 	opss = atomic_long_read_acquire(&p->scx.ops_state);
2199 
2200 	switch (opss & SCX_OPSS_STATE_MASK) {
2201 	case SCX_OPSS_NONE:
2202 		break;
2203 	case SCX_OPSS_QUEUEING:
2204 		/*
2205 		 * QUEUEING is started and finished while holding @p's rq lock.
2206 		 * As we're holding the rq lock now, we shouldn't see QUEUEING.
2207 		 */
2208 		BUG();
2209 	case SCX_OPSS_QUEUED:
2210 		/*
2211 		 * A queued task must always be in BPF scheduler's custody. If
2212 		 * SCX_TASK_IN_CUSTODY is clear, finish_dispatch() on another
2213 		 * CPU has already passed call_task_dequeue() (which clears the
2214 		 * flag), but has not yet written SCX_OPSS_NONE. That final
2215 		 * store does not require this rq's lock, so retrying with
2216 		 * cpu_relax() is bounded: we will observe NONE (or DISPATCHING,
2217 		 * handled by the fallthrough) on a subsequent iteration.
2218 		 */
2219 		if (unlikely(!(READ_ONCE(p->scx.flags) & SCX_TASK_IN_CUSTODY))) {
2220 			cpu_relax();
2221 			goto retry;
2222 		}
2223 
2224 		if (atomic_long_try_cmpxchg(&p->scx.ops_state, &opss,
2225 					    SCX_OPSS_NONE))
2226 			break;
2227 		fallthrough;
2228 	case SCX_OPSS_DISPATCHING:
2229 		/*
2230 		 * If @p is being dispatched from the BPF scheduler to a DSQ,
2231 		 * wait for the transfer to complete so that @p doesn't get
2232 		 * added to its DSQ after dequeueing is complete.
2233 		 *
2234 		 * As we're waiting on DISPATCHING with the rq locked, the
2235 		 * dispatching side shouldn't try to lock the rq while
2236 		 * DISPATCHING is set. See dispatch_to_local_dsq().
2237 		 *
2238 		 * DISPATCHING shouldn't have qseq set and control can reach
2239 		 * here with NONE @opss from the above QUEUED case block.
2240 		 * Explicitly wait on %SCX_OPSS_DISPATCHING instead of @opss.
2241 		 */
2242 		wait_ops_state(p, SCX_OPSS_DISPATCHING);
2243 		BUG_ON(atomic_long_read(&p->scx.ops_state) != SCX_OPSS_NONE);
2244 		break;
2245 	}
2246 
2247 	/*
2248 	 * Call ops.dequeue() if the task is still in BPF custody.
2249 	 *
2250 	 * The code that clears ops_state to %SCX_OPSS_NONE does not always
2251 	 * clear %SCX_TASK_IN_CUSTODY: in dispatch_to_local_dsq(), when
2252 	 * we're moving a task that was in %SCX_OPSS_DISPATCHING to a
2253 	 * remote CPU's local DSQ, we only set ops_state to %SCX_OPSS_NONE
2254 	 * so that a concurrent dequeue can proceed, but we clear
2255 	 * %SCX_TASK_IN_CUSTODY only when we later enqueue or move the
2256 	 * task. So we can see NONE + IN_CUSTODY here and we must handle
2257 	 * it. Similarly, after waiting on %SCX_OPSS_DISPATCHING we see
2258 	 * NONE but the task may still have %SCX_TASK_IN_CUSTODY set until
2259 	 * it is enqueued on the destination.
2260 	 */
2261 	call_task_dequeue(sch, rq, p, deq_flags);
2262 }
2263 
dequeue_task_scx(struct rq * rq,struct task_struct * p,int core_deq_flags)2264 static bool dequeue_task_scx(struct rq *rq, struct task_struct *p, int core_deq_flags)
2265 {
2266 	struct scx_sched *sch = scx_task_sched(p);
2267 	u64 deq_flags = core_deq_flags;
2268 
2269 	/*
2270 	 * Set %SCX_DEQ_SCHED_CHANGE when the dequeue is due to a property
2271 	 * change (not sleep).
2272 	 */
2273 	if (!(deq_flags & DEQUEUE_SLEEP))
2274 		deq_flags |= SCX_DEQ_SCHED_CHANGE;
2275 
2276 	if (!(p->scx.flags & SCX_TASK_QUEUED)) {
2277 		WARN_ON_ONCE(task_runnable(p));
2278 		return true;
2279 	}
2280 
2281 	ops_dequeue(rq, p, deq_flags);
2282 
2283 	/*
2284 	 * A currently running task which is going off @rq first gets dequeued
2285 	 * and then stops running. As we want running <-> stopping transitions
2286 	 * to be contained within runnable <-> quiescent transitions, trigger
2287 	 * ->stopping() early here instead of in put_prev_task_scx().
2288 	 *
2289 	 * @p may go through multiple stopping <-> running transitions between
2290 	 * here and put_prev_task_scx() if task attribute changes occur while
2291 	 * dispatch_one() leaves @rq unlocked. However, they don't contain any
2292 	 * information meaningful to the BPF scheduler and can be suppressed by
2293 	 * skipping the callbacks if the task is !QUEUED.
2294 	 */
2295 	if (task_current(rq, p) &&
2296 	    (SCX_HAS_OP(sch, stopping) || unlikely(p == scx_rescuee(rq)))) {
2297 		update_curr_scx(rq);
2298 		if (SCX_HAS_OP(sch, stopping))
2299 			SCX_CALL_OP_TASK(sch, stopping, rq, p, false);
2300 	}
2301 
2302 	if (SCX_HAS_OP(sch, quiescent) && !task_on_rq_migrating(p))
2303 		SCX_CALL_OP_TASK(sch, quiescent, rq, p, deq_flags);
2304 
2305 	if (deq_flags & SCX_DEQ_SLEEP)
2306 		p->scx.flags |= SCX_TASK_DEQD_FOR_SLEEP;
2307 	else
2308 		p->scx.flags &= ~SCX_TASK_DEQD_FOR_SLEEP;
2309 
2310 	p->scx.flags &= ~SCX_TASK_QUEUED;
2311 	rq->scx.nr_running--;
2312 	sub_nr_running(rq, 1);
2313 
2314 	scx_dispatch_dequeue(rq, p);
2315 
2316 	/* see scx_task_slice_ended() for the save/restore exception */
2317 	if (!((deq_flags & DEQUEUE_SAVE) && task_current(rq, p)))
2318 		scx_task_slice_ended(rq, p);
2319 
2320 	clear_direct_dispatch(p);
2321 	return true;
2322 }
2323 
yield_task_scx(struct rq * rq)2324 static void yield_task_scx(struct rq *rq)
2325 {
2326 	struct task_struct *p = rq->donor;
2327 	struct scx_sched *sch = scx_task_sched(p);
2328 
2329 	/* a yield gives the slice up */
2330 	scx_task_slice_ended(rq, p);
2331 
2332 	if (SCX_HAS_OP(sch, yield))
2333 		SCX_CALL_OP_2TASKS_RET(sch, yield, rq, p, NULL);
2334 	else
2335 		scx_set_task_slice(p, 0);
2336 }
2337 
yield_to_task_scx(struct rq * rq,struct task_struct * to)2338 static bool yield_to_task_scx(struct rq *rq, struct task_struct *to)
2339 {
2340 	struct task_struct *from = rq->donor;
2341 	struct scx_sched *sch = scx_task_sched(from);
2342 
2343 	/* like a plain yield, giving the slice up ends the protection */
2344 	scx_task_slice_ended(rq, from);
2345 
2346 	if (SCX_HAS_OP(sch, yield) && sch == scx_task_sched(to))
2347 		return SCX_CALL_OP_2TASKS_RET(sch, yield, rq, from, to);
2348 	else
2349 		return false;
2350 }
2351 
wakeup_preempt_scx(struct rq * rq,struct task_struct * p,int wake_flags)2352 static void wakeup_preempt_scx(struct rq *rq, struct task_struct *p, int wake_flags)
2353 {
2354 	/*
2355 	 * Preemption between SCX tasks is implemented by resetting the victim
2356 	 * task's slice to 0 and triggering reschedule on the target CPU.
2357 	 * Nothing to do.
2358 	 */
2359 	if (p->sched_class == &ext_sched_class)
2360 		return;
2361 
2362 	/*
2363 	 * Getting preempted by a higher-priority class. Reenqueue IMMED tasks.
2364 	 * This captures all preemption cases including:
2365 	 *
2366 	 * - A SCX task is currently running.
2367 	 *
2368 	 * - @rq is waking from idle due to a SCX task waking to it.
2369 	 *
2370 	 * - A higher-priority wakes up while SCX dispatch is in progress.
2371 	 */
2372 	if (rq->scx.nr_immed)
2373 		scx_schedule_reenq_local(rq, 0);
2374 }
2375 
scx_move_local_task_to_local_dsq(struct scx_sched * sch,struct task_struct * p,u64 enq_flags,struct scx_dispatch_q * src_dsq,struct rq * dst_rq)2376 void scx_move_local_task_to_local_dsq(struct scx_sched *sch, struct task_struct *p,
2377 				      u64 enq_flags, struct scx_dispatch_q *src_dsq,
2378 				      struct rq *dst_rq)
2379 {
2380 	struct scx_dispatch_q *dst_dsq = scx_resolve_local_dsq(sch, dst_rq, p, &enq_flags);
2381 
2382 	/* @p is on @dst_rq, an rq-owned @src_dsq is covered by the rq lock */
2383 	if (!dsq_is_rq_owned(src_dsq))
2384 		lockdep_assert_held(&src_dsq->lock);
2385 	lockdep_assert_rq_held(dst_rq);
2386 
2387 	WARN_ON_ONCE(p->scx.holding_cpu >= 0);
2388 
2389 	if (enq_flags & (SCX_ENQ_HEAD | SCX_ENQ_PREEMPT))
2390 		dsq_insert_head(dst_dsq, p);
2391 	else
2392 		list_add_tail(&p->scx.dsq_list.node, &dst_dsq->list);
2393 
2394 	dsq_inc_nr(dst_dsq, p, enq_flags);
2395 	p->scx.dsq = dst_dsq;
2396 
2397 	rq_owned_post_enq(sch, dst_rq, dst_dsq, p, enq_flags);
2398 }
2399 
2400 /**
2401  * move_remote_task_to_local_dsq - Move a task from a foreign rq to a local DSQ
2402  * @sch: scheduler placing @p
2403  * @p: task to move
2404  * @enq_flags: %SCX_ENQ_*
2405  * @src_rq: rq to move the task from, locked on entry, released on return
2406  * @dst_rq: rq to move the task into, locked on return
2407  *
2408  * Move @p which is currently on @src_rq to @dst_rq's local DSQ.
2409  */
move_remote_task_to_local_dsq(struct scx_sched * sch,struct task_struct * p,u64 enq_flags,struct rq * src_rq,struct rq * dst_rq)2410 static void move_remote_task_to_local_dsq(struct scx_sched *sch,
2411 					  struct task_struct *p, u64 enq_flags,
2412 					  struct rq *src_rq, struct rq *dst_rq)
2413 {
2414 	lockdep_assert_rq_held(src_rq);
2415 
2416 	/*
2417 	 * Set sticky_cpu before deactivate_task() to properly mark the
2418 	 * beginning of an SCX-internal migration.
2419 	 */
2420 	p->scx.sticky_cpu = cpu_of(dst_rq);
2421 	deactivate_task(src_rq, p, 0);
2422 	set_task_cpu(p, cpu_of(dst_rq));
2423 
2424 	switch_rq_lock(src_rq, dst_rq);
2425 
2426 	/*
2427 	 * activate_task() below truncates enq_flags to 32 bits and re-derives
2428 	 * @p's owner, dropping our scx flags and the placing @sch. We own @rq,
2429 	 * so stash both across the call. The enqueue reads them back, keeping
2430 	 * the scx flags and checking caps against the placer, not the owner.
2431 	 */
2432 	WARN_ON_ONCE(!cpumask_test_cpu(cpu_of(dst_rq), p->cpus_ptr));
2433 	WARN_ON_ONCE(dst_rq->scx.remote_activate_enq_flags ||
2434 		     dst_rq->scx.remote_activate_sch);
2435 	dst_rq->scx.remote_activate_enq_flags = enq_flags;
2436 	dst_rq->scx.remote_activate_sch = sch;
2437 	activate_task(dst_rq, p, 0);
2438 	dst_rq->scx.remote_activate_enq_flags = 0;
2439 	dst_rq->scx.remote_activate_sch = NULL;
2440 }
2441 
2442 /*
2443  * Similar to kernel/sched/core.c::is_cpu_allowed(). However, there are two
2444  * differences:
2445  *
2446  * - is_cpu_allowed() asks "Can this task run on this CPU?" while
2447  *   task_can_run_on_remote_rq() asks "Can the BPF scheduler migrate the task to
2448  *   this CPU?".
2449  *
2450  *   While migration is disabled, is_cpu_allowed() has to say "yes" as the task
2451  *   must be allowed to finish on the CPU that it's currently on regardless of
2452  *   the CPU state. However, task_can_run_on_remote_rq() must say "no" as the
2453  *   BPF scheduler shouldn't attempt to migrate a task which has migration
2454  *   disabled.
2455  *
2456  * - The BPF scheduler is bypassed while the rq is offline and we can always say
2457  *   no to the BPF scheduler initiated migrations while offline.
2458  *
2459  * The caller must ensure that @p and @rq are on different CPUs.
2460  * If enforce == true, caller must hold @p's rq lock.
2461  */
task_can_run_on_remote_rq(struct scx_sched * sch,struct task_struct * p,struct rq * rq,bool enforce)2462 static bool task_can_run_on_remote_rq(struct scx_sched *sch,
2463 				      struct task_struct *p, struct rq *rq,
2464 				      bool enforce)
2465 {
2466 	s32 cpu = cpu_of(rq);
2467 
2468 	/*
2469 	 * To prevent races with @p still running on its old CPU while switching
2470 	 * out, make sure we're holding @p's rq lock so as not to risk
2471 	 * erroneously killing the BPF scheduler.
2472 	 */
2473 	if (enforce)
2474 		lockdep_assert_rq_held(task_rq(p));
2475 
2476 	WARN_ON_ONCE(task_cpu(p) == cpu);
2477 
2478 	/*
2479 	 * If @p has migration disabled, @p->cpus_ptr is updated to contain only
2480 	 * the pinned CPU in migrate_disable_switch() while @p is being switched
2481 	 * out. However, put_prev_task_scx() is called before @p->cpus_ptr is
2482 	 * updated and thus another CPU may see @p on a DSQ inbetween leading to
2483 	 * @p passing the below task_allowed_on_cpu() check while migration is
2484 	 * disabled.
2485 	 *
2486 	 * Test the migration disabled state first as the race window is narrow
2487 	 * and the BPF scheduler failing to check migration disabled state can
2488 	 * easily be masked if task_allowed_on_cpu() is done first.
2489 	 */
2490 	if (unlikely(is_migration_disabled(p))) {
2491 		if (enforce)
2492 			scx_error(sch, "SCX_DSQ_LOCAL[_ON] cannot move migration disabled %s[%d] from CPU %d to %d",
2493 				  p->comm, p->pid, task_cpu(p), cpu);
2494 		return false;
2495 	}
2496 
2497 	/*
2498 	 * We don't require the BPF scheduler to avoid dispatching to offline
2499 	 * CPUs mostly for convenience but also because CPUs can go offline
2500 	 * between scx_bpf_dsq_insert() calls and here. Trigger error iff the
2501 	 * picked CPU is outside the allowed mask.
2502 	 */
2503 	if (!task_allowed_on_cpu(p, cpu)) {
2504 		if (enforce)
2505 			scx_error(sch, "SCX_DSQ_LOCAL[_ON] target CPU %d not allowed for %s[%d]",
2506 				  cpu, p->comm, p->pid);
2507 		return false;
2508 	}
2509 
2510 	if (!scx_rq_online(rq)) {
2511 		if (enforce)
2512 			__scx_add_event(sch, SCX_EV_DISPATCH_LOCAL_DSQ_OFFLINE, 1);
2513 		return false;
2514 	}
2515 
2516 	return true;
2517 }
2518 
2519 /**
2520  * unlink_dsq_and_switch_rq_lock() - Unlink task and switch to its rq lock
2521  * @p: target task
2522  * @dsq: locked DSQ @p is currently on
2523  * @locked_rq: currently locked rq
2524  * @src_rq: rq @p is currently on, stable with @dsq locked
2525  *
2526  * Called with @dsq and @locked_rq locked. We want to move @p to a different DSQ,
2527  * including any local DSQ, but are not locking @src_rq. Locking @src_rq is
2528  * required when transferring into a local DSQ. Even when transferring into a
2529  * non-local DSQ, it's better to use the same mechanism to protect against
2530  * dequeues and maintain the invariant that @p->scx.dsq can only change while
2531  * @src_rq is locked, which e.g. scx_dump_task() depends on.
2532  *
2533  * We want to grab @src_rq but that can deadlock if we try while locking @dsq,
2534  * so we want to unlink @p from @dsq, drop its lock and then lock @src_rq. As
2535  * this may race with dequeue, which can't drop the rq lock or fail, do a little
2536  * dancing from our side.
2537  *
2538  * @p->scx.holding_cpu is set to this CPU before @dsq is unlocked. If @p gets
2539  * dequeued after we unlock @dsq but before locking @src_rq, the holding_cpu
2540  * would be cleared to -1. While other cpus may have updated it to different
2541  * values afterwards, as this operation can't be preempted or recurse, the
2542  * holding_cpu can never become this CPU again before we're done. Thus, we can
2543  * tell whether we lost to dequeue by testing whether the holding_cpu still
2544  * points to this CPU. See scx_dispatch_dequeue() for the counterpart.
2545  *
2546  * On return, @dsq is unlocked and @src_rq is locked. Returns %true if @p is
2547  * still valid. %false if lost to dequeue.
2548  */
unlink_dsq_and_switch_rq_lock(struct task_struct * p,struct scx_dispatch_q * dsq,struct rq * locked_rq,struct rq * src_rq)2549 static bool unlink_dsq_and_switch_rq_lock(struct task_struct *p,
2550 					  struct scx_dispatch_q *dsq,
2551 					  struct rq *locked_rq,
2552 					  struct rq *src_rq)
2553 {
2554 	s32 cpu = raw_smp_processor_id();
2555 
2556 	lockdep_assert_held(&dsq->lock);
2557 	lockdep_assert_rq_held(locked_rq);
2558 
2559 	WARN_ON_ONCE(p->scx.holding_cpu >= 0);
2560 	scx_task_unlink_from_dsq(p, dsq);
2561 	p->scx.holding_cpu = cpu;
2562 
2563 	raw_spin_unlock(&dsq->lock);
2564 	switch_rq_lock(locked_rq, src_rq);
2565 
2566 	/* task_rq couldn't have changed if we're still the holding cpu */
2567 	return likely(p->scx.holding_cpu == cpu) &&
2568 		!WARN_ON_ONCE(src_rq != task_rq(p));
2569 }
2570 
consume_remote_task(struct scx_sched * sch,struct rq * this_rq,struct task_struct * p,u64 enq_flags,struct scx_dispatch_q * dsq,struct rq * src_rq)2571 static bool consume_remote_task(struct scx_sched *sch, struct rq *this_rq,
2572 				struct task_struct *p, u64 enq_flags,
2573 				struct scx_dispatch_q *dsq, struct rq *src_rq)
2574 {
2575 	if (unlink_dsq_and_switch_rq_lock(p, dsq, this_rq, src_rq)) {
2576 		move_remote_task_to_local_dsq(sch, p, enq_flags, src_rq, this_rq);
2577 		return true;
2578 	} else {
2579 		switch_rq_lock(src_rq, this_rq);
2580 		return false;
2581 	}
2582 }
2583 
2584 /**
2585  * move_task_between_dsqs() - Move a task from one DSQ to another
2586  * @sch: scx_sched being operated on
2587  * @p: target task
2588  * @enq_flags: %SCX_ENQ_*
2589  * @src_dsq: DSQ @p is currently on, must not be a local DSQ
2590  * @dst_dsq: DSQ @p is being moved to, can be any DSQ
2591  *
2592  * Must be called with @p's task_rq and @src_dsq locked. If @dst_dsq is a local
2593  * DSQ and @p is on a different CPU, @p will be migrated and thus its task_rq
2594  * will change. As @p's task_rq is locked, this function doesn't need to use the
2595  * holding_cpu mechanism.
2596  *
2597  * On return, @src_dsq is unlocked and only @p's new task_rq, which is the
2598  * return value, is locked.
2599  */
move_task_between_dsqs(struct scx_sched * sch,struct task_struct * p,u64 enq_flags,struct scx_dispatch_q * src_dsq,struct scx_dispatch_q * dst_dsq)2600 static struct rq *move_task_between_dsqs(struct scx_sched *sch,
2601 					 struct task_struct *p, u64 enq_flags,
2602 					 struct scx_dispatch_q *src_dsq,
2603 					 struct scx_dispatch_q *dst_dsq)
2604 {
2605 	struct rq *src_rq = task_rq(p), *dst_rq;
2606 
2607 	BUG_ON(src_dsq->id == SCX_DSQ_LOCAL);
2608 	lockdep_assert_held(&src_dsq->lock);
2609 	lockdep_assert_rq_held(src_rq);
2610 
2611 	if (dst_dsq->id == SCX_DSQ_LOCAL) {
2612 		dst_rq = container_of(dst_dsq, struct rq, scx.local_dsq);
2613 		if (src_rq != dst_rq &&
2614 		    unlikely(!task_can_run_on_remote_rq(sch, p, dst_rq, true))) {
2615 			dst_dsq = find_global_dsq(sch, task_cpu(p));
2616 			dst_rq = src_rq;
2617 			enq_flags |= SCX_ENQ_GDSQ_FALLBACK;
2618 		}
2619 	} else {
2620 		/* no need to migrate if destination is a non-local DSQ */
2621 		dst_rq = src_rq;
2622 	}
2623 
2624 	/*
2625 	 * Move @p into $dst_dsq. If $dst_dsq is the local DSQ of a different
2626 	 * CPU, @p will be migrated.
2627 	 */
2628 	if (dst_dsq->id == SCX_DSQ_LOCAL) {
2629 		/* @p is going from a non-local DSQ to a local DSQ */
2630 		if (src_rq == dst_rq) {
2631 			scx_task_unlink_from_dsq(p, src_dsq);
2632 			scx_move_local_task_to_local_dsq(sch, p, enq_flags, src_dsq, dst_rq);
2633 			raw_spin_unlock(&src_dsq->lock);
2634 		} else {
2635 			raw_spin_unlock(&src_dsq->lock);
2636 			move_remote_task_to_local_dsq(sch, p, enq_flags, src_rq, dst_rq);
2637 		}
2638 	} else {
2639 		/*
2640 		 * @p is going from a non-local DSQ to a non-local DSQ. As
2641 		 * $src_dsq is already locked, do an abbreviated dequeue.
2642 		 */
2643 		dispatch_dequeue_locked(p, src_dsq);
2644 		raw_spin_unlock(&src_dsq->lock);
2645 
2646 		scx_dispatch_enqueue(sch, dst_rq, dst_dsq, p, 0, 0, enq_flags);
2647 	}
2648 
2649 	return dst_rq;
2650 }
2651 
scx_consume_dispatch_q(struct scx_sched * sch,struct rq * rq,struct scx_dispatch_q * dsq,u64 enq_flags)2652 bool scx_consume_dispatch_q(struct scx_sched *sch, struct rq *rq,
2653 			    struct scx_dispatch_q *dsq, u64 enq_flags)
2654 {
2655 	struct task_struct *p;
2656 retry:
2657 	/*
2658 	 * The caller can't expect to successfully consume a task if the task's
2659 	 * addition to @dsq isn't guaranteed to be visible somehow. Test
2660 	 * @dsq->list without locking and skip if it seems empty.
2661 	 */
2662 	if (list_empty(&dsq->list))
2663 		return false;
2664 
2665 	raw_spin_lock(&dsq->lock);
2666 
2667 	nldsq_for_each_task(p, dsq) {
2668 		struct rq *task_rq = task_rq(p);
2669 
2670 		/*
2671 		 * This loop can lead to multiple lockup scenarios, e.g. the BPF
2672 		 * scheduler can put an enormous number of affinitized tasks into
2673 		 * a contended DSQ, or the outer retry loop can repeatedly race
2674 		 * against scx_bypass() dequeueing tasks from @dsq trying to put
2675 		 * the system into the bypass mode. This can easily live-lock the
2676 		 * machine. If aborting, exit from all non-bypass DSQs.
2677 		 */
2678 		if (unlikely(READ_ONCE(sch->aborting)) && dsq->id != SCX_DSQ_BYPASS)
2679 			break;
2680 
2681 		if (rq == task_rq) {
2682 			scx_task_unlink_from_dsq(p, dsq);
2683 			scx_move_local_task_to_local_dsq(sch, p, enq_flags, dsq, rq);
2684 			raw_spin_unlock(&dsq->lock);
2685 			return true;
2686 		}
2687 
2688 		if (task_can_run_on_remote_rq(sch, p, rq, false)) {
2689 			if (likely(consume_remote_task(sch, rq, p, enq_flags, dsq, task_rq)))
2690 				return true;
2691 			goto retry;
2692 		}
2693 	}
2694 
2695 	raw_spin_unlock(&dsq->lock);
2696 	return false;
2697 }
2698 
scx_consume_global_dsq(struct scx_sched * sch,struct rq * rq)2699 bool scx_consume_global_dsq(struct scx_sched *sch, struct rq *rq)
2700 {
2701 	int node = cpu_to_node(cpu_of(rq));
2702 
2703 	return scx_consume_dispatch_q(sch, rq, &sch->pnode[node]->global_dsq, 0);
2704 }
2705 
2706 /**
2707  * dispatch_to_local_dsq - Dispatch a task to a local dsq
2708  * @sch: scx_sched being operated on
2709  * @rq: current rq which is locked
2710  * @dst_dsq: destination DSQ
2711  * @p: task to dispatch
2712  * @slice: slice carried by the insert verdict, 0 keeps the current value
2713  * @vtime: vtime carried by the insert verdict, committed on PRIQ inserts
2714  * @enq_flags: %SCX_ENQ_*
2715  *
2716  * We're holding @rq lock and want to dispatch @p to @dst_dsq which is a local
2717  * DSQ. This function performs all the synchronization dancing needed because
2718  * local DSQs are protected with rq locks.
2719  *
2720  * The caller must have exclusive ownership of @p (e.g. through
2721  * %SCX_OPSS_DISPATCHING).
2722  */
dispatch_to_local_dsq(struct scx_sched * sch,struct rq * rq,struct scx_dispatch_q * dst_dsq,struct task_struct * p,u64 slice,u64 vtime,u64 enq_flags)2723 static void dispatch_to_local_dsq(struct scx_sched *sch, struct rq *rq,
2724 				  struct scx_dispatch_q *dst_dsq, struct task_struct *p,
2725 				  u64 slice, u64 vtime, u64 enq_flags)
2726 {
2727 	struct rq *src_rq = task_rq(p);
2728 	struct rq *dst_rq = container_of(dst_dsq, struct rq, scx.local_dsq);
2729 	struct rq *locked_rq = rq;
2730 
2731 	/*
2732 	 * We're synchronized against dequeue through DISPATCHING. As @p can't
2733 	 * be dequeued, its task_rq and cpus_allowed are stable too.
2734 	 *
2735 	 * If dispatching to @rq that @p is already on, no lock dancing needed.
2736 	 */
2737 	if (rq == src_rq && rq == dst_rq) {
2738 		scx_dispatch_enqueue(sch, rq, dst_dsq, p, slice, vtime,
2739 				     enq_flags | SCX_ENQ_APPLY_SLICE | SCX_ENQ_CLEAR_OPSS);
2740 		return;
2741 	}
2742 
2743 	/*
2744 	 * @p is on a possibly remote @src_rq which we need to lock to move the
2745 	 * task. If dequeue is in progress, it'd be locking @src_rq and waiting
2746 	 * on DISPATCHING, so we can't grab @src_rq lock while holding
2747 	 * DISPATCHING.
2748 	 *
2749 	 * As DISPATCHING guarantees that @p is wholly ours, we can pretend that
2750 	 * we're moving from a DSQ and use the same mechanism - mark the task
2751 	 * under transfer with holding_cpu, release DISPATCHING and then follow
2752 	 * the same protocol. See unlink_dsq_and_switch_rq_lock().
2753 	 */
2754 	p->scx.holding_cpu = raw_smp_processor_id();
2755 
2756 	/* store_release ensures that dequeue sees the above */
2757 	atomic_long_set_release(&p->scx.ops_state, SCX_OPSS_NONE);
2758 
2759 	/* switch to @src_rq lock */
2760 	if (locked_rq != src_rq) {
2761 		switch_rq_lock(locked_rq, src_rq);
2762 		locked_rq = src_rq;
2763 	}
2764 
2765 	/* task_rq couldn't have changed if we're still the holding cpu */
2766 	if (likely(p->scx.holding_cpu == raw_smp_processor_id()) &&
2767 	    !WARN_ON_ONCE(src_rq != task_rq(p))) {
2768 		bool fallback = false;
2769 		/*
2770 		 * If @p is staying on the same rq, there's no need to go
2771 		 * through the full deactivate/activate cycle. Optimize by
2772 		 * abbreviating move_remote_task_to_local_dsq().
2773 		 */
2774 		if (src_rq == dst_rq) {
2775 			p->scx.holding_cpu = -1;
2776 			scx_dispatch_enqueue(sch, dst_rq, &dst_rq->scx.local_dsq, p,
2777 					     slice, vtime, enq_flags | SCX_ENQ_APPLY_SLICE);
2778 		} else if (unlikely(!task_can_run_on_remote_rq(sch, p, dst_rq, true))) {
2779 			p->scx.holding_cpu = -1;
2780 			fallback = true;
2781 			scx_dispatch_enqueue(sch, src_rq, find_global_dsq(sch, task_cpu(p)),
2782 					     p, slice, vtime,
2783 					     enq_flags | SCX_ENQ_APPLY_SLICE |
2784 					     SCX_ENQ_GDSQ_FALLBACK);
2785 		} else {
2786 			apply_slice_vtime(p, slice, vtime, enq_flags);
2787 			move_remote_task_to_local_dsq(sch, p, enq_flags, src_rq, dst_rq);
2788 			/* task has been moved to dst_rq, which is now locked */
2789 			locked_rq = dst_rq;
2790 		}
2791 
2792 		/* if the destination CPU is idle, wake it up */
2793 		if (!fallback && sched_class_above(p->sched_class, dst_rq->curr->sched_class))
2794 			resched_curr(dst_rq);
2795 	}
2796 
2797 	/* switch back to @rq lock */
2798 	if (locked_rq != rq)
2799 		switch_rq_lock(locked_rq, rq);
2800 }
2801 
2802 /**
2803  * finish_dispatch - Asynchronously finish dispatching a task
2804  * @sch: the scheduler
2805  * @rq: current rq which is locked
2806  * @p: task to finish dispatching
2807  * @qseq_at_dispatch: qseq when @p started getting dispatched
2808  * @dsq_id: destination DSQ ID
2809  * @slice: slice carried by the insert verdict, 0 keeps the current value
2810  * @vtime: vtime carried by the insert verdict, committed on PRIQ inserts
2811  * @enq_flags: %SCX_ENQ_*
2812  *
2813  * Dispatching to local DSQs may need to wait for queueing to complete or
2814  * require rq lock dancing. As we don't wanna do either while inside
2815  * ops.dispatch() to avoid locking order inversion, we split dispatching into
2816  * two parts. scx_bpf_dsq_insert() which is called by ops.dispatch() records the
2817  * task and its qseq. Once ops.dispatch() returns, this function is called to
2818  * finish up.
2819  *
2820  * There is no guarantee that @p is still valid for dispatching or even that it
2821  * was valid in the first place. Make sure that the task is still owned by the
2822  * BPF scheduler and claim the ownership before dispatching.
2823  */
finish_dispatch(struct scx_sched * sch,struct rq * rq,struct task_struct * p,unsigned long qseq_at_dispatch,u64 dsq_id,u64 slice,u64 vtime,u64 enq_flags)2824 static void finish_dispatch(struct scx_sched *sch, struct rq *rq, struct task_struct *p,
2825 			    unsigned long qseq_at_dispatch, u64 dsq_id,
2826 			    u64 slice, u64 vtime, u64 enq_flags)
2827 {
2828 	struct scx_dispatch_q *dsq;
2829 	unsigned long opss;
2830 
2831 retry:
2832 	/*
2833 	 * No need for _acquire here. @p is accessed only after a successful
2834 	 * try_cmpxchg to DISPATCHING.
2835 	 */
2836 	opss = atomic_long_read(&p->scx.ops_state);
2837 
2838 	switch (opss & SCX_OPSS_STATE_MASK) {
2839 	case SCX_OPSS_DISPATCHING:
2840 	case SCX_OPSS_NONE:
2841 		/* someone else already got to it */
2842 		return;
2843 	case SCX_OPSS_QUEUED:
2844 		/*
2845 		 * If qseq doesn't match, @p has gone through at least one
2846 		 * dispatch/dequeue and re-enqueue cycle between
2847 		 * scx_bpf_dsq_insert() and here and we have no claim on it.
2848 		 */
2849 		if ((opss & SCX_OPSS_QSEQ_MASK) != qseq_at_dispatch)
2850 			return;
2851 
2852 		/* see SCX_EV_INSERT_NOT_OWNED definition */
2853 		if (unlikely(!scx_task_on_sched(sch, p))) {
2854 			__scx_add_event(sch, SCX_EV_INSERT_NOT_OWNED, 1);
2855 			return;
2856 		}
2857 
2858 		/*
2859 		 * While we know @p is accessible, we don't yet have a claim on
2860 		 * it - the BPF scheduler is allowed to dispatch tasks
2861 		 * spuriously and there can be a racing dequeue attempt. Let's
2862 		 * claim @p by atomically transitioning it from QUEUED to
2863 		 * DISPATCHING.
2864 		 */
2865 		if (likely(atomic_long_try_cmpxchg(&p->scx.ops_state, &opss,
2866 						   SCX_OPSS_DISPATCHING)))
2867 			break;
2868 		goto retry;
2869 	case SCX_OPSS_QUEUEING:
2870 		/*
2871 		 * scx_do_enqueue_task() is in the process of transferring the
2872 		 * task to the BPF scheduler while holding @p's rq lock. As we
2873 		 * aren't holding any kernel or BPF resource that the enqueue
2874 		 * path may depend upon, it's safe to wait.
2875 		 */
2876 		wait_ops_state(p, opss);
2877 		goto retry;
2878 	}
2879 
2880 	BUG_ON(!(p->scx.flags & SCX_TASK_QUEUED));
2881 
2882 	dsq = find_dsq_for_dispatch(sch, rq, dsq_id, task_cpu(p));
2883 
2884 	if (dsq->id == SCX_DSQ_LOCAL)
2885 		dispatch_to_local_dsq(sch, rq, dsq, p, slice, vtime, enq_flags);
2886 	else
2887 		scx_dispatch_enqueue(sch, rq, dsq, p, slice, vtime,
2888 				     enq_flags | SCX_ENQ_APPLY_SLICE | SCX_ENQ_CLEAR_OPSS);
2889 }
2890 
scx_flush_dispatch_buf(struct scx_sched * sch,struct rq * rq)2891 void scx_flush_dispatch_buf(struct scx_sched *sch, struct rq *rq)
2892 {
2893 	struct scx_dsp_ctx *dspc = &this_cpu_ptr(sch->pcpu)->dsp_ctx;
2894 	u32 u;
2895 
2896 	for (u = 0; u < dspc->cursor; u++) {
2897 		struct scx_dsp_buf_ent *ent = &dspc->buf[u];
2898 
2899 		finish_dispatch(sch, rq, ent->task, ent->qseq, ent->dsq_id,
2900 				ent->slice, ent->vtime, ent->enq_flags);
2901 	}
2902 
2903 	dspc->nr_tasks += dspc->cursor;
2904 	dspc->cursor = 0;
2905 }
2906 
maybe_queue_balance_callback(struct rq * rq)2907 static inline void maybe_queue_balance_callback(struct rq *rq)
2908 {
2909 	lockdep_assert_rq_held(rq);
2910 
2911 	if (!(rq->scx.flags & SCX_RQ_BAL_CB_PENDING))
2912 		return;
2913 
2914 	queue_balance_callback(rq, &rq->scx.deferred_bal_cb,
2915 				deferred_bal_cb_workfn);
2916 
2917 	rq->scx.flags &= ~SCX_RQ_BAL_CB_PENDING;
2918 }
2919 
dispatch_one(struct rq * rq,struct task_struct * prev)2920 static enum scx_dsp_verdict dispatch_one(struct rq *rq, struct task_struct *prev)
2921 {
2922 	struct scx_sched *root_sch = scx_root_protected_live();
2923 	enum scx_dsp_verdict verdict;
2924 	s32 cpu = cpu_of(rq);
2925 
2926 	lockdep_assert_rq_held(rq);
2927 	rq->scx.flags |= SCX_RQ_IN_DISPATCH;
2928 
2929 	scx_process_sync_ecaps(rq, prev);
2930 
2931 	if ((root_sch->ops.flags & SCX_OPS_HAS_CPU_PREEMPT) &&
2932 	    unlikely(rq->scx.cpu_released)) {
2933 		/*
2934 		 * If the previous sched_class for the current CPU was not SCX,
2935 		 * notify the BPF scheduler that it again has control of the
2936 		 * core. This callback complements ->cpu_release(), which is
2937 		 * emitted in switch_class().
2938 		 */
2939 		if (root_sch->ops.cpu_acquire)
2940 			SCX_CALL_OP(root_sch, cpu_acquire, rq, cpu, NULL);
2941 		rq->scx.cpu_released = false;
2942 	}
2943 
2944 	if (prev->sched_class == &ext_sched_class) {
2945 		update_curr_scx(rq);
2946 
2947 		/*
2948 		 * If @prev is runnable & has slice left, it has priority and
2949 		 * fetching more just increases latency for the fetched tasks.
2950 		 * Tell pick_task_scx() to keep running @prev. If the BPF
2951 		 * scheduler wants to handle this explicitly, it should
2952 		 * implement ->cpu_release().
2953 		 *
2954 		 * See scx_disable_workfn() for the explanation on the bypassing
2955 		 * test.
2956 		 */
2957 		if ((prev->scx.flags & SCX_TASK_QUEUED) && prev->scx.slice &&
2958 		    !scx_bypassing(scx_task_sched(prev), cpu)) {
2959 			verdict = SCX_DSP_PREV;
2960 			goto has_tasks;
2961 		}
2962 	}
2963 
2964 	/* if there already are tasks to run, nothing to do */
2965 	if (rq->scx.local_dsq.nr) {
2966 		verdict = SCX_DSP_LOCAL;
2967 		goto has_tasks;
2968 	}
2969 
2970 	verdict = scx_dispatch_sched(root_sch, rq, prev, false);
2971 	if (verdict != SCX_DSP_NONE)
2972 		goto has_tasks;
2973 
2974 	/*
2975 	 * Didn't find another task to run. Keep running @prev unless its own
2976 	 * scheduler set %SCX_OPS_ENQ_LAST and takes the enqueue instead, see
2977 	 * put_prev_task_scx(). Read the scheduler here as the dispatch above
2978 	 * may have dropped the rq lock while @prev changed class or scheduler.
2979 	 */
2980 	if (prev->scx.flags & SCX_TASK_QUEUED) {
2981 		struct scx_sched *prev_sch = scx_task_sched(prev);
2982 
2983 		if ((!(prev_sch->ops.flags & SCX_OPS_ENQ_LAST) ||
2984 		     scx_bypassing(prev_sch, cpu)) && scx_task_can_stay_on_cpu(rq, prev)) {
2985 			__scx_add_event(prev_sch, SCX_EV_DISPATCH_KEEP_LAST, 1);
2986 			verdict = SCX_DSP_PREV;
2987 			goto has_tasks;
2988 		}
2989 	}
2990 	rq->scx.flags &= ~SCX_RQ_IN_DISPATCH;
2991 	return SCX_DSP_NONE;
2992 
2993 has_tasks:
2994 	/*
2995 	 * @rq may have extra IMMED tasks without reenq scheduled:
2996 	 *
2997 	 * - rq_is_open() can't reliably tell when and how slice is going to be
2998 	 *   modified for $curr and allows IMMED tasks to be queued while
2999 	 *   dispatch is in progress.
3000 	 *
3001 	 * - A non-IMMED HEAD task can get queued in front of an IMMED task
3002 	 *   between the IMMED queueing and the subsequent scheduling event.
3003 	 */
3004 	if (unlikely(rq->scx.local_dsq.nr > 1 && rq->scx.nr_immed))
3005 		scx_schedule_reenq_local(rq, 0);
3006 
3007 	rq->scx.flags &= ~SCX_RQ_IN_DISPATCH;
3008 	return verdict;
3009 }
3010 
set_next_task_scx(struct rq * rq,struct task_struct * p,bool first)3011 static void set_next_task_scx(struct rq *rq, struct task_struct *p, bool first)
3012 {
3013 	struct scx_sched *sch = scx_task_sched(p);
3014 
3015 	if (p->scx.flags & SCX_TASK_QUEUED) {
3016 		/*
3017 		 * Core-sched might decide to execute @p before it is
3018 		 * dispatched. Call ops_dequeue() to notify the BPF scheduler.
3019 		 */
3020 		ops_dequeue(rq, p, SCX_DEQ_CORE_SCHED_EXEC);
3021 		scx_dispatch_dequeue(rq, p);
3022 	}
3023 
3024 	p->se.exec_start = rq_clock_task(rq);
3025 
3026 	/* see dequeue_task_scx() on why we skip when !QUEUED */
3027 	if (SCX_HAS_OP(sch, running) && (p->scx.flags & SCX_TASK_QUEUED))
3028 		SCX_CALL_OP_TASK(sch, running, rq, p);
3029 
3030 	clr_task_runnable(p, true);
3031 
3032 	/* apply any pending out-of-band slice request before the tick decision */
3033 	apply_task_slice_oob(rq, p);
3034 
3035 	/*
3036 	 * @p is getting newly scheduled or got kicked after someone updated its
3037 	 * slice. Update SCX_RQ_CAN_STOP_TICK to reflect whether the tick can be
3038 	 * stopped. See scx_can_stop_tick().
3039 	 *
3040 	 * Moreover, refresh the load_avgs just when transitioning in and out of
3041 	 * nohz. In the future, we might want to add a mechanism to update
3042 	 * load_avgs periodically on tick-stopped CPUs.
3043 	 */
3044 	if (p->scx.slice == SCX_SLICE_INF) {
3045 		if (!(rq->scx.flags & SCX_RQ_CAN_STOP_TICK)) {
3046 			/*
3047 			 * Bypass mode always assigns finite slices, so @p
3048 			 * can't have an infinite slice while bypassing.
3049 			 * Therefore, sched_update_tick_dependency() can safely
3050 			 * evaluate the outgoing task.
3051 			 */
3052 			rq->scx.flags |= SCX_RQ_CAN_STOP_TICK;
3053 			sched_update_tick_dependency(rq);
3054 
3055 			update_other_load_avgs(rq);
3056 		}
3057 	} else {
3058 		if (rq->scx.flags & SCX_RQ_CAN_STOP_TICK) {
3059 			rq->scx.flags &= ~SCX_RQ_CAN_STOP_TICK;
3060 			update_other_load_avgs(rq);
3061 		}
3062 
3063 		/*
3064 		 * @rq still references the outgoing scheduling context. A finite
3065 		 * slice is sufficient by itself to require the tick.
3066 		 */
3067 		if (tick_nohz_full_cpu(cpu_of(rq)))
3068 			tick_nohz_dep_set_cpu(cpu_of(rq), TICK_DEP_BIT_SCHED);
3069 	}
3070 }
3071 
3072 static enum scx_cpu_preempt_reason
preempt_reason_from_class(const struct sched_class * class)3073 preempt_reason_from_class(const struct sched_class *class)
3074 {
3075 	if (class == &stop_sched_class)
3076 		return SCX_CPU_PREEMPT_STOP;
3077 	if (class == &dl_sched_class)
3078 		return SCX_CPU_PREEMPT_DL;
3079 	if (class == &rt_sched_class)
3080 		return SCX_CPU_PREEMPT_RT;
3081 	return SCX_CPU_PREEMPT_UNKNOWN;
3082 }
3083 
switch_class(struct rq * rq,struct task_struct * next)3084 static void switch_class(struct rq *rq, struct task_struct *next)
3085 {
3086 	struct scx_sched *sch = scx_root_protected_live();
3087 	const struct sched_class *next_class = next->sched_class;
3088 
3089 	if (!(sch->ops.flags & SCX_OPS_HAS_CPU_PREEMPT))
3090 		return;
3091 
3092 	/*
3093 	 * The callback is conceptually meant to convey that the CPU is no
3094 	 * longer under the control of SCX. Therefore, don't invoke the callback
3095 	 * if the next class is below SCX (in which case the BPF scheduler has
3096 	 * actively decided not to schedule any tasks on the CPU).
3097 	 */
3098 	if (sched_class_above(&ext_sched_class, next_class))
3099 		return;
3100 
3101 	/*
3102 	 * At this point we know that SCX was preempted by a higher priority
3103 	 * sched_class, so invoke the ->cpu_release() callback if we have not
3104 	 * done so already. We only send the callback once between SCX being
3105 	 * preempted, and it regaining control of the CPU.
3106 	 *
3107 	 * ->cpu_release() complements ->cpu_acquire(), which is emitted the
3108 	 *  next time that dispatch_one() is invoked.
3109 	 */
3110 	if (!rq->scx.cpu_released) {
3111 		if (sch->ops.cpu_release) {
3112 			struct scx_cpu_release_args args = {
3113 				.reason = preempt_reason_from_class(next_class),
3114 				.task = next,
3115 			};
3116 
3117 			SCX_CALL_OP(sch, cpu_release, rq, cpu_of(rq), &args);
3118 		}
3119 		rq->scx.cpu_released = true;
3120 	}
3121 }
3122 
put_prev_task_scx(struct rq * rq,struct task_struct * p,struct task_struct * next)3123 static void put_prev_task_scx(struct rq *rq, struct task_struct *p,
3124 			      struct task_struct *next)
3125 {
3126 	struct scx_sched *sch = scx_task_sched(p);
3127 	bool rescue_keep = false;
3128 
3129 	/* see kick_sync_wait_bal_cb() */
3130 	smp_store_release(&rq->scx.kick_sync, rq->scx.kick_sync + 1);
3131 
3132 	update_curr_scx(rq);
3133 
3134 	/*
3135 	 * If the slice is consumed, protection ends with it. A rescuee
3136 	 * preempted beforehand keeps going, see scx_rescue_keep().
3137 	 */
3138 	if (!p->scx.slice) {
3139 		if (unlikely(p == scx_rescuee(rq)))
3140 			rescue_keep = scx_rescue_keep(rq, p);
3141 		if (!rescue_keep)
3142 			scx_task_slice_ended(rq, p);
3143 	}
3144 
3145 	/* see dequeue_task_scx() on why we skip when !QUEUED */
3146 	if (SCX_HAS_OP(sch, stopping) && (p->scx.flags & SCX_TASK_QUEUED))
3147 		SCX_CALL_OP_TASK(sch, stopping, rq, p, true);
3148 
3149 	if (p->scx.flags & SCX_TASK_QUEUED) {
3150 		set_task_runnable(rq, p);
3151 
3152 		/*
3153 		 * If @p has slice left and is being put, @p is getting
3154 		 * preempted by a higher priority scheduler class or core-sched
3155 		 * forcing a different task. Leave it at the head of the local
3156 		 * DSQ unless it was an IMMED task. IMMED tasks should not
3157 		 * linger on a busy CPU, reenqueue them to the BPF scheduler.
3158 		 *
3159 		 * An open rescue must keep @p on the local DSQ even if the
3160 		 * scheduler zeroed the slice in ops.stopping() above.
3161 		 */
3162 		if ((p->scx.slice || unlikely(p == scx_rescuee(rq))) &&
3163 		    !scx_bypassing(sch, cpu_of(rq))) {
3164 			if (p->scx.flags & SCX_TASK_IMMED) {
3165 				p->scx.flags |= SCX_TASK_REENQ_PREEMPTED;
3166 				scx_do_enqueue_task(rq, p, SCX_ENQ_REENQ, -1);
3167 				p->scx.flags &= ~SCX_TASK_REENQ_REASON_MASK;
3168 			} else {
3169 				u64 enq_flags = 0;
3170 
3171 				/*
3172 				 * Keep a preempted rescue going. If preempted
3173 				 * by another SCX task, append to the local DSQ,
3174 				 * see scx_rescue_keep().
3175 				 */
3176 				if (unlikely(p == scx_rescuee(rq))) {
3177 					enq_flags |= SCX_ENQ_IGNORE_CAPS;
3178 					if (!rescue_keep)
3179 						enq_flags |= SCX_ENQ_HEAD;
3180 				} else {
3181 					enq_flags |= SCX_ENQ_HEAD;
3182 				}
3183 
3184 				scx_dispatch_enqueue(sch, rq, &rq->scx.local_dsq, p, 0, 0,
3185 						     enq_flags);
3186 			}
3187 			goto switch_class;
3188 		}
3189 
3190 		/*
3191 		 * If @p is runnable but we're about to enter a lower
3192 		 * sched_class, %SCX_OPS_ENQ_LAST must be set. Tell
3193 		 * ops.enqueue() that @p is the only one available for this cpu,
3194 		 * which should trigger an explicit follow-up scheduling event.
3195 		 * This doesn't apply if the baseline access on the CPU is lost.
3196 		 *
3197 		 * Under core scheduling, a pick dispatches only when nothing is
3198 		 * locally runnable and can legitimately go idle with @p still
3199 		 * runnable (see do_pick_task_scx()).
3200 		 */
3201 		if (next && sched_class_above(&ext_sched_class, next->sched_class) &&
3202 		    scx_task_can_stay_on_cpu(rq, p)) {
3203 			WARN_ON_ONCE(!sched_core_enabled(rq) &&
3204 				     !(sch->ops.flags & SCX_OPS_ENQ_LAST));
3205 			scx_do_enqueue_task(rq, p, SCX_ENQ_LAST, -1);
3206 		} else {
3207 			scx_do_enqueue_task(rq, p, 0, -1);
3208 		}
3209 	}
3210 
3211 switch_class:
3212 	if (next && next->sched_class != &ext_sched_class)
3213 		switch_class(rq, next);
3214 }
3215 
kick_sync_wait_bal_cb(struct rq * rq)3216 static void kick_sync_wait_bal_cb(struct rq *rq)
3217 {
3218 	struct scx_kick_syncs __rcu *ks;
3219 	unsigned long *ksyncs;
3220 	bool waited;
3221 	s32 cpu;
3222 
3223 	/*
3224 	 * This callback is queued and normally flushed within @rq's own
3225 	 * scheduling pass. However, dispatch can drop the rq lock while it sits
3226 	 * queued, and lock takers in that window (the sched class change paths,
3227 	 * the scx task iterator) flush pending balance callbacks on release,
3228 	 * running this one on a foreign CPU whose snapshots are unrelated. The
3229 	 * kicked CPUs are already on their way to advance the kick_syncs being
3230 	 * waited on. Don't get in the way.
3231 	 */
3232 	if (unlikely(cpu_of(rq) != smp_processor_id()))
3233 		return;
3234 
3235 	ks = __this_cpu_read(scx_kick_syncs);
3236 	ksyncs = rcu_dereference_sched(ks)->syncs;
3237 
3238 	/*
3239 	 * Drop rq lock and enable IRQs while waiting. IRQs must be enabled
3240 	 * — a target CPU may be waiting for us to process an IPI (e.g. TLB
3241 	 * flush) while we wait for its kick_sync to advance.
3242 	 *
3243 	 * Also, keep advancing our own kick_sync so that new kick_sync waits
3244 	 * targeting us, which can start after we drop the lock, cannot form
3245 	 * cyclic dependencies.
3246 	 */
3247 retry:
3248 	waited = false;
3249 	for_each_cpu(cpu, rq->scx.cpus_to_sync) {
3250 		/*
3251 		 * smp_load_acquire() pairs with smp_store_release() on
3252 		 * kick_sync updates on the target CPUs.
3253 		 */
3254 		if (cpu == cpu_of(rq) ||
3255 		    smp_load_acquire(&cpu_rq(cpu)->scx.kick_sync) != ksyncs[cpu]) {
3256 			cpumask_clear_cpu(cpu, rq->scx.cpus_to_sync);
3257 			continue;
3258 		}
3259 
3260 		scx_rq_lock_drop(rq);
3261 		raw_spin_rq_unlock_irq(rq);
3262 		while (READ_ONCE(cpu_rq(cpu)->scx.kick_sync) == ksyncs[cpu]) {
3263 			smp_store_release(&rq->scx.kick_sync, rq->scx.kick_sync + 1);
3264 			cpu_relax();
3265 		}
3266 		raw_spin_rq_lock_irq(rq);
3267 		waited = true;
3268 	}
3269 
3270 	if (waited)
3271 		goto retry;
3272 }
3273 
first_local_task(struct rq * rq)3274 static struct task_struct *first_local_task(struct rq *rq)
3275 {
3276 	return list_first_entry_or_null(&rq->scx.local_dsq.list,
3277 					struct task_struct, scx.dsq_list.node);
3278 }
3279 
3280 /*
3281  * Run dispatch and queue the follow-up work for a pick.
3282  */
dispatch_pick(struct rq * rq,struct rq_flags * rf,struct task_struct * prev)3283 static enum scx_dsp_verdict dispatch_pick(struct rq *rq, struct rq_flags *rf,
3284 					  struct task_struct *prev)
3285 {
3286 	enum scx_dsp_verdict verdict;
3287 
3288 	rq_unpin_lock(rq, rf);
3289 	verdict = dispatch_one(rq, prev);
3290 	rq_repin_lock(rq, rf);
3291 	maybe_queue_balance_callback(rq);
3292 
3293 	/*
3294 	 * Defer to a balance callback which can drop rq lock and enable IRQs.
3295 	 * Waiting directly in the pick path would deadlock against CPUs sending
3296 	 * us IPIs (e.g. TLB flushes) while we wait for them.
3297 	 */
3298 	if (unlikely(rq->scx.kick_sync_pending)) {
3299 		rq->scx.kick_sync_pending = false;
3300 		queue_balance_callback(rq, &rq->scx.kick_sync_bal_cb,
3301 				       kick_sync_wait_bal_cb);
3302 	}
3303 
3304 	return verdict;
3305 }
3306 
3307 #ifdef CONFIG_SCHED_CORE
3308 /*
3309  * Dispatch for a pick when core scheduling is enabled. The selection picks for
3310  * all SMT siblings and the rq_i->core_pick state it builds must stay atomic
3311  * throughout. If the dispatch released the rq lock, anything can have happened
3312  * in between - return %SCX_DSP_RETRY to restart the selection against current
3313  * state.
3314  */
dispatch_core_pick(struct rq * rq,struct rq_flags * rf,struct task_struct * prev)3315 static enum scx_dsp_verdict dispatch_core_pick(struct rq *rq, struct rq_flags *rf,
3316 					       struct task_struct *prev)
3317 {
3318 	enum scx_dsp_verdict verdict;
3319 	u32 seq = rq->scx.lock_drop_seq;
3320 
3321 	/* another dispatch is in flight on @rq, let that handle it */
3322 	if (rq->scx.flags & SCX_RQ_IN_DISPATCH)
3323 		return SCX_DSP_NONE;
3324 
3325 	rq_unpin_lock(rq, rf);
3326 
3327 	verdict = dispatch_one(rq, prev);
3328 
3329 	if (cpu_of(rq) == smp_processor_id()) {
3330 		maybe_queue_balance_callback(rq);
3331 
3332 		/* see dispatch_pick() */
3333 		if (unlikely(rq->scx.kick_sync_pending)) {
3334 			rq->scx.kick_sync_pending = false;
3335 			queue_balance_callback(rq, &rq->scx.kick_sync_bal_cb,
3336 					       kick_sync_wait_bal_cb);
3337 		}
3338 	} else if (unlikely(rq->scx.flags & SCX_RQ_BAL_CB_PENDING)) {
3339 		/*
3340 		 * Balance callbacks must run in the context that queued them,
3341 		 * so they can't be queued on another CPU's rq. Run the deferred
3342 		 * work directly instead.
3343 		 */
3344 		rq->scx.flags &= ~SCX_RQ_BAL_CB_PENDING;
3345 		run_deferred(rq);
3346 	}
3347 
3348 	rq_repin_lock(rq, rf);
3349 
3350 	/* if dispatch_one() released the rq lock, restart the selection */
3351 	if (rq->scx.lock_drop_seq != seq)
3352 		return SCX_DSP_RETRY;
3353 
3354 	return verdict;
3355 }
3356 #else	/* CONFIG_SCHED_CORE */
dispatch_core_pick(struct rq * rq,struct rq_flags * rf,struct task_struct * prev)3357 static enum scx_dsp_verdict dispatch_core_pick(struct rq *rq, struct rq_flags *rf,
3358 					       struct task_struct *prev)
3359 {
3360 	return SCX_DSP_NONE;
3361 }
3362 #endif	/* CONFIG_SCHED_CORE */
3363 
3364 static struct task_struct *
do_pick_task_scx(struct rq * rq,struct rq_flags * rf,bool force_scx)3365 do_pick_task_scx(struct rq *rq, struct rq_flags *rf, bool force_scx)
3366 {
3367 	struct task_struct *prev = rq->curr;
3368 	enum scx_dsp_verdict verdict;
3369 	struct task_struct *p;
3370 
3371 	/* see kick_sync_wait_bal_cb() */
3372 	smp_store_release(&rq->scx.kick_sync, rq->scx.kick_sync + 1);
3373 
3374 	rq_modified_begin(rq, &ext_sched_class);
3375 
3376 	if (sched_core_enabled(rq))
3377 		verdict = dispatch_core_pick(rq, rf, prev);
3378 	else
3379 		verdict = dispatch_pick(rq, rf, prev);
3380 
3381 	if (verdict == SCX_DSP_RETRY)
3382 		return RETRY_TASK;
3383 
3384 	/*
3385 	 * If any higher-priority sched class enqueued a runnable task on this
3386 	 * rq during dispatch_one(), abort and return RETRY_TASK, so that the
3387 	 * scheduler loop can restart.
3388 	 *
3389 	 * If @force_scx is true, always try to pick a SCHED_EXT task,
3390 	 * regardless of any higher-priority sched classes activity.
3391 	 */
3392 	if (!force_scx && rq_modified_above(rq, &ext_sched_class))
3393 		return RETRY_TASK;
3394 
3395 	/*
3396 	 * If we're keeping @prev, replenish slice if necessary and keep running
3397 	 * @prev. Otherwise, pop the first one from the local DSQ.
3398 	 */
3399 	if (verdict == SCX_DSP_PREV) {
3400 		p = prev;
3401 		if (!p->scx.slice) {
3402 			/* the slice is consumed, protection ends */
3403 			scx_task_slice_ended(rq, p);
3404 			refill_task_slice_dfl(scx_task_sched(p), p);
3405 		}
3406 	} else {
3407 		p = first_local_task(rq);
3408 		if (!p)
3409 			return NULL;
3410 
3411 		if (unlikely(!p->scx.slice) && scx_task_can_stay_on_cpu(rq, p)) {
3412 			struct scx_sched *sch = scx_task_sched(p);
3413 
3414 			if (!scx_bypassing(sch, cpu_of(rq)) &&
3415 			    !sch->warned_zero_slice) {
3416 				printk_deferred(KERN_WARNING "sched_ext: %s[%d] has zero slice in %s()\n",
3417 						p->comm, p->pid, __func__);
3418 				sch->warned_zero_slice = true;
3419 			}
3420 			refill_task_slice_dfl(sch, p);
3421 		}
3422 	}
3423 
3424 	return p;
3425 }
3426 
pick_task_scx(struct rq * rq,struct rq_flags * rf)3427 static struct task_struct *pick_task_scx(struct rq *rq, struct rq_flags *rf)
3428 {
3429 	return do_pick_task_scx(rq, rf, false);
3430 }
3431 
3432 /*
3433  * Select the next task to run from the ext scheduling class.
3434  *
3435  * Use do_pick_task_scx() directly with @force_scx enabled, since the
3436  * dl_server must always select a sched_ext task.
3437  */
3438 static struct task_struct *
ext_server_pick_task(struct sched_dl_entity * dl_se,struct rq_flags * rf)3439 ext_server_pick_task(struct sched_dl_entity *dl_se, struct rq_flags *rf)
3440 {
3441 	if (!scx_enabled())
3442 		return NULL;
3443 
3444 	return do_pick_task_scx(dl_se->rq, rf, true);
3445 }
3446 
3447 /*
3448  * Initialize the ext server deadline entity.
3449  */
ext_server_init(struct rq * rq)3450 void ext_server_init(struct rq *rq)
3451 {
3452 	struct sched_dl_entity *dl_se = &rq->ext_server;
3453 
3454 	init_dl_entity(dl_se);
3455 
3456 	dl_server_init(dl_se, rq, ext_server_pick_task);
3457 }
3458 
3459 #ifdef CONFIG_SCHED_CORE
3460 /**
3461  * scx_prio_less - Task ordering for core-sched
3462  * @a: task A
3463  * @b: task B
3464  * @in_fi: in forced idle state
3465  *
3466  * Core-sched is implemented as an additional scheduling layer on top of the
3467  * usual sched_class'es and needs to find out the expected task ordering. For
3468  * SCX, core-sched calls this function to interrogate the task ordering.
3469  *
3470  * A pair of tasks owned by one scheduler is ordered by the owner's
3471  * ops.core_sched_before(). A pair spanning two schedulers is ordered by their
3472  * nearest common ancestor which implements the op - the one case where the op
3473  * is called on tasks that the scheduler delegated to its sub-schedulers and may
3474  * not be scheduling anymore.
3475  *
3476  * When neither applies, or the deciding scheduler is bypassing on either task's
3477  * CPU, the default ordering runs the task which has been waiting longer first.
3478  * A running task counts as the most recently serviced and orders after every
3479  * waiting task. Waiting tasks are compared by @p->scx.runnable_at.
3480  *
3481  * Return: %true if @a should run after @b.
3482  */
scx_prio_less(const struct task_struct * a,const struct task_struct * b,bool in_fi)3483 bool scx_prio_less(const struct task_struct *a, const struct task_struct *b,
3484 		   bool in_fi)
3485 {
3486 	struct scx_sched *sch_a = scx_task_sched(a);
3487 	struct scx_sched *sch_b = scx_task_sched(b);
3488 	struct scx_sched *sch = NULL;
3489 	bool a_running, b_running;
3490 
3491 	if (sch_a == sch_b) {
3492 		if (SCX_HAS_OP(sch_a, core_sched_before))
3493 			sch = sch_a;
3494 	} else {
3495 		s32 level;
3496 
3497 		for (level = min(sch_a->level, sch_b->level); level >= 0; level--) {
3498 			struct scx_sched *anc = sch_a->ancestors[level];
3499 
3500 			if (anc == sch_b->ancestors[level] &&
3501 			    SCX_HAS_OP(anc, core_sched_before)) {
3502 				sch = anc;
3503 				break;
3504 			}
3505 		}
3506 	}
3507 
3508 	/*
3509 	 * scx_prio_less() returns whether @a should run after @b while
3510 	 * ops.core_sched_before() returns whether its first argument should run
3511 	 * before the second. Swap the arguments.
3512 	 *
3513 	 * The const qualifiers are dropped from task_struct pointers when
3514 	 * calling ops.core_sched_before(). Accesses are controlled by the
3515 	 * verifier.
3516 	 */
3517 	if (sch && !scx_bypassing(sch, task_cpu(a)) && !scx_bypassing(sch, task_cpu(b)))
3518 		return SCX_CALL_OP_2TASKS_RET(sch, core_sched_before, task_rq(a),
3519 					      (struct task_struct *)b,
3520 					      (struct task_struct *)a);
3521 
3522 	/*
3523 	 * runnable_at is refreshed only on enqueue, so a task which keeps
3524 	 * occupying its CPU carries a stale stamp. A running task is the most
3525 	 * recently serviced whatever its stamp says. Order it after every
3526 	 * waiting task.
3527 	 */
3528 	a_running = a->on_cpu;
3529 	b_running = b->on_cpu;
3530 	if (a_running != b_running)
3531 		return a_running;
3532 
3533 	return time_after(a->scx.runnable_at, b->scx.runnable_at);
3534 }
3535 #endif	/* CONFIG_SCHED_CORE */
3536 
select_task_rq_scx(struct task_struct * p,int prev_cpu,int wake_flags)3537 static int select_task_rq_scx(struct task_struct *p, int prev_cpu, int wake_flags)
3538 {
3539 	struct scx_sched *sch = scx_task_sched(p);
3540 	bool bypassing;
3541 
3542 	/*
3543 	 * sched_exec() calls with %WF_EXEC when @p is about to exec(2) as it
3544 	 * can be a good migration opportunity with low cache and memory
3545 	 * footprint. Returning a CPU different than @prev_cpu triggers
3546 	 * immediate rq migration. However, for SCX, as the current rq
3547 	 * association doesn't dictate where the task is going to run, this
3548 	 * doesn't fit well. If necessary, we can later add a dedicated method
3549 	 * which can decide to preempt self to force it through the regular
3550 	 * scheduling path.
3551 	 */
3552 	if (unlikely(wake_flags & WF_EXEC))
3553 		return prev_cpu;
3554 
3555 	bypassing = scx_bypassing(sch, task_cpu(p));
3556 	if (likely(SCX_HAS_OP(sch, select_cpu)) && !bypassing) {
3557 		s32 cpu;
3558 		struct task_struct **ddsp_taskp;
3559 
3560 		ddsp_taskp = this_cpu_ptr(&direct_dispatch_task);
3561 		WARN_ON_ONCE(*ddsp_taskp);
3562 		*ddsp_taskp = p;
3563 
3564 		this_rq()->scx.in_select_cpu = true;
3565 		cpu = SCX_CALL_OP_TASK_RET(sch, select_cpu, NULL, p,
3566 					   scx_cpu_arg(prev_cpu), wake_flags);
3567 		cpu = scx_cpu_ret(sch, cpu);
3568 		this_rq()->scx.in_select_cpu = false;
3569 		p->scx.selected_cpu = cpu;
3570 		*ddsp_taskp = NULL;
3571 		if (scx_cpu_valid(sch, cpu, "from ops.select_cpu()"))
3572 			return cpu;
3573 		else
3574 			return prev_cpu;
3575 	} else {
3576 		s32 cpu;
3577 
3578 		/*
3579 		 * While bypassing, the enqueue path routes @p to a bypass DSQ
3580 		 * without consulting the direct-dispatch target, making the
3581 		 * default selection pointless. It doesn't work anyway when the
3582 		 * scheduler does its own idle tracking and the built-in idle
3583 		 * cpumasks are not updated. Leave @p on @prev_cpu.
3584 		 */
3585 		if (bypassing) {
3586 			__scx_add_event(sch, SCX_EV_BYPASS_DISPATCH, 1);
3587 			p->scx.selected_cpu = prev_cpu;
3588 			return prev_cpu;
3589 		}
3590 
3591 		cpu = scx_select_cpu_dfl(p, prev_cpu, wake_flags, NULL, 0);
3592 		if (cpu >= 0) {
3593 			/*
3594 			 * Carry the slice refill and let the insertion commit
3595 			 * it under rq lock. See the write rules.
3596 			 */
3597 			__scx_add_event(sch, SCX_EV_REFILL_SLICE_DFL, 1);
3598 			p->scx.ddsp_slice = READ_ONCE(sch->slice_dfl);
3599 			p->scx.ddsp_enq_flags = SCX_ENQ_SLICE_DFL;
3600 			p->scx.ddsp_dsq_id = SCX_DSQ_LOCAL;
3601 		} else {
3602 			cpu = prev_cpu;
3603 		}
3604 		p->scx.selected_cpu = cpu;
3605 
3606 		return cpu;
3607 	}
3608 }
3609 
task_woken_scx(struct rq * rq,struct task_struct * p)3610 static void task_woken_scx(struct rq *rq, struct task_struct *p)
3611 {
3612 	run_deferred(rq);
3613 }
3614 
set_cpus_allowed_scx(struct task_struct * p,struct affinity_context * ac)3615 static void set_cpus_allowed_scx(struct task_struct *p,
3616 				 struct affinity_context *ac)
3617 {
3618 	struct scx_sched *sch = scx_task_sched(p);
3619 
3620 	set_cpus_allowed_common(p, ac);
3621 
3622 	if (task_dead_and_done(p))
3623 		return;
3624 
3625 	/*
3626 	 * The effective cpumask is stored in @p->cpus_ptr which may temporarily
3627 	 * differ from the configured one in @p->cpus_mask. Always tell the bpf
3628 	 * scheduler the effective one.
3629 	 *
3630 	 * Fine-grained memory write control is enforced by BPF making the const
3631 	 * designation pointless. Cast it away when calling the operation.
3632 	 */
3633 	if (SCX_HAS_OP(sch, set_cpumask))
3634 		scx_call_op_set_cpumask(sch, task_rq(p), p, (struct cpumask *)p->cpus_ptr);
3635 }
3636 
handle_hotplug(struct rq * rq,bool online)3637 static void handle_hotplug(struct rq *rq, bool online)
3638 {
3639 	struct scx_sched *sch = scx_root_protected();
3640 	s32 cpu = cpu_of(rq);
3641 	s32 cpu_or_cid = cpu;
3642 
3643 	atomic_long_inc(&scx_hotplug_seq);
3644 
3645 	/*
3646 	 * scx_root updates are protected by cpus_read_lock() and will stay
3647 	 * stable here. Note that we can't depend on scx_enabled() test as the
3648 	 * hotplug ops need to be enabled before __scx_enabled is set.
3649 	 */
3650 	if (unlikely(!sch))
3651 		return;
3652 
3653 	if (scx_enabled())
3654 		scx_idle_update_selcpu_topology(&sch->ops);
3655 
3656 	if (online)
3657 		scx_online_ecaps(rq);
3658 	else
3659 		scx_offline_ecaps(rq);
3660 
3661 	/*
3662 	 * The tables can't be retired while this function is running as the
3663 	 * retirement is inside cpus_read_lock. However, scx_cpu_arg() is
3664 	 * awkward here as the tables can be NULL after root enable failure and
3665 	 * lockdep would trigger without surrounding rcu_read_lock(). Open code
3666 	 * the translation. If the table is NULL, the ops are also cleared and
3667 	 * @cpu_or_cid goes unused.
3668 	 */
3669 	if (scx_is_cid_type()) {
3670 		s16 *tbl = rcu_dereference_check(scx_cpu_to_cid_tbl,
3671 						 lockdep_is_cpus_held());
3672 
3673 		if (tbl) {
3674 			struct scx_sched *pos;
3675 
3676 			cpu_or_cid = tbl[cpu];
3677 
3678 			guard(raw_spinlock_irqsave)(&scx_sched_lock);
3679 			list_for_each_entry(pos, &scx_sched_all, all) {
3680 				struct scx_cmask *mask = pos->online_cmask;
3681 
3682 				if (mask)
3683 					__assign_bit(cpu_or_cid, (unsigned long *)mask->bits,
3684 						     online);
3685 			}
3686 		}
3687 	}
3688 
3689 	if (online && SCX_HAS_OP(sch, cpu_online))
3690 		SCX_CALL_OP(sch, cpu_online, NULL, cpu_or_cid);
3691 	else if (!online && SCX_HAS_OP(sch, cpu_offline))
3692 		SCX_CALL_OP(sch, cpu_offline, NULL, cpu_or_cid);
3693 	else
3694 		scx_exit(sch, SCX_EXIT_UNREG_KERN,
3695 			 SCX_ECODE_ACT_RESTART | SCX_ECODE_RSN_HOTPLUG,
3696 			 "cpu %d going %s, exiting scheduler", cpu,
3697 			 online ? "online" : "offline");
3698 }
3699 
scx_rq_activate(struct rq * rq)3700 void scx_rq_activate(struct rq *rq)
3701 {
3702 	handle_hotplug(rq, true);
3703 }
3704 
scx_rq_deactivate(struct rq * rq)3705 void scx_rq_deactivate(struct rq *rq)
3706 {
3707 	handle_hotplug(rq, false);
3708 }
3709 
rq_online_scx(struct rq * rq)3710 static void rq_online_scx(struct rq *rq)
3711 {
3712 	rq->scx.flags |= SCX_RQ_ONLINE;
3713 }
3714 
rq_offline_scx(struct rq * rq)3715 static void rq_offline_scx(struct rq *rq)
3716 {
3717 	rq->scx.flags &= ~SCX_RQ_ONLINE;
3718 	scx_rescue_flush(rq);
3719 }
3720 
check_rq_for_timeouts(struct rq * rq)3721 static bool check_rq_for_timeouts(struct rq *rq)
3722 {
3723 	struct scx_sched *sch;
3724 	struct task_struct *p;
3725 	struct rq_flags rf;
3726 	bool timed_out = false;
3727 
3728 	rq_lock_irqsave(rq, &rf);
3729 	sch = rcu_dereference_bh(scx_root);
3730 	if (unlikely(!sch))
3731 		goto out_unlock;
3732 
3733 	list_for_each_entry(p, &rq->scx.runnable_list, scx.runnable_node) {
3734 		struct scx_sched *sch = scx_task_sched(p);
3735 		unsigned long last_runnable = p->scx.runnable_at;
3736 
3737 		if (unlikely(time_after(jiffies,
3738 					last_runnable + READ_ONCE(sch->watchdog_timeout)))) {
3739 			struct scx_dispatch_q *dsq = READ_ONCE(p->scx.dsq);
3740 			u32 dur_ms = jiffies_to_msecs(jiffies - last_runnable);
3741 
3742 			/*
3743 			 * A task can be stuck on a DSQ that a sched other than
3744 			 * its owner is responsible for draining, e.g. an
3745 			 * ancestor's bypass DSQ while the owner is bypassing.
3746 			 * Blame the drainer. The local DSQ is consumed by the
3747 			 * cpu itself and keeps blame on the owner.
3748 			 */
3749 			if (dsq && dsq->sched && dsq->id != SCX_DSQ_LOCAL)
3750 				sch = dsq->sched;
3751 
3752 			__scx_exit(sch, SCX_EXIT_ERROR_STALL, 0, cpu_of(rq),
3753 				   "%s[%d] failed to run for %u.%03us",
3754 				   p->comm, p->pid, dur_ms / 1000,
3755 				   dur_ms % 1000);
3756 			timed_out = true;
3757 			break;
3758 		}
3759 	}
3760 out_unlock:
3761 	rq_unlock_irqrestore(rq, &rf);
3762 	return timed_out;
3763 }
3764 
scx_watchdog_workfn(struct work_struct * work)3765 static void scx_watchdog_workfn(struct work_struct *work)
3766 {
3767 	unsigned long intv;
3768 	int cpu;
3769 
3770 	WRITE_ONCE(scx_watchdog_timestamp, jiffies);
3771 
3772 	for_each_online_cpu(cpu) {
3773 		if (unlikely(check_rq_for_timeouts(cpu_rq(cpu))))
3774 			break;
3775 
3776 		cond_resched();
3777 	}
3778 
3779 	intv = READ_ONCE(scx_watchdog_interval);
3780 	if (intv < ULONG_MAX)
3781 		queue_delayed_work(system_dfl_wq, to_delayed_work(work), intv);
3782 }
3783 
scx_tick(struct rq * rq)3784 void scx_tick(struct rq *rq)
3785 {
3786 	struct scx_sched *root;
3787 	unsigned long last_check;
3788 
3789 	if (!scx_enabled())
3790 		return;
3791 
3792 	root = rcu_dereference_bh(scx_root);
3793 	if (unlikely(!root))
3794 		return;
3795 
3796 	last_check = READ_ONCE(scx_watchdog_timestamp);
3797 	if (unlikely(time_after(jiffies,
3798 				last_check + READ_ONCE(root->watchdog_timeout)))) {
3799 		u32 dur_ms = jiffies_to_msecs(jiffies - last_check);
3800 
3801 		scx_exit(root, SCX_EXIT_ERROR_STALL, 0,
3802 			 "watchdog failed to check in for %u.%03us",
3803 			 dur_ms / 1000, dur_ms % 1000);
3804 	}
3805 
3806 	update_other_load_avgs(rq);
3807 }
3808 
task_tick_scx(struct rq * rq,struct task_struct * curr,int queued)3809 static void task_tick_scx(struct rq *rq, struct task_struct *curr, int queued)
3810 {
3811 	struct scx_sched *sch = scx_task_sched(curr);
3812 
3813 	update_curr_scx(rq);
3814 
3815 	/*
3816 	 * While disabling, always resched as we can't trust the slice
3817 	 * management.
3818 	 */
3819 	if (scx_bypassing(sch, cpu_of(rq)))
3820 		scx_set_task_slice(curr, 0);
3821 	else if (SCX_HAS_OP(sch, tick))
3822 		SCX_CALL_OP_TASK(sch, tick, rq, curr);
3823 
3824 	if (!curr->scx.slice)
3825 		resched_curr(rq);
3826 }
3827 
3828 #ifdef CONFIG_EXT_GROUP_SCHED
tg_cgrp(struct task_group * tg)3829 static struct cgroup *tg_cgrp(struct task_group *tg)
3830 {
3831 	/*
3832 	 * If CGROUP_SCHED is disabled, @tg is NULL. If @tg is an autogroup,
3833 	 * @tg->css.cgroup is NULL. In both cases, @tg can be treated as the
3834 	 * root cgroup.
3835 	 */
3836 	if (tg && tg->css.cgroup)
3837 		return tg->css.cgroup;
3838 	else
3839 		return &cgrp_dfl_root.cgrp;
3840 }
3841 
3842 #define SCX_INIT_TASK_ARGS_CGROUP(cgrp)		.cgroup = (cgrp),
3843 
3844 #else	/* CONFIG_EXT_GROUP_SCHED */
3845 
3846 #define SCX_INIT_TASK_ARGS_CGROUP(cgrp)
3847 
3848 #endif	/* CONFIG_EXT_GROUP_SCHED */
3849 
3850 /**
3851  * __scx_init_task - Initialize a task for a sched
3852  * @sch: sched to initialize @p for
3853  * @p: task of interest
3854  * @cgrp: cgroup @p is joining, %NULL for @p's current task_group's cgroup
3855  * @fork: %true if @p is being forked
3856  *
3857  * Pre-commit cgroup migration passes @cgrp explicitly as @p's task_group
3858  * still reflects the source.
3859  *
3860  * Return 0 on success, -errno on failure.
3861  */
__scx_init_task(struct scx_sched * sch,struct task_struct * p,struct cgroup * cgrp,bool fork)3862 int __scx_init_task(struct scx_sched *sch, struct task_struct *p,
3863 		    struct cgroup *cgrp, bool fork)
3864 {
3865 	int ret;
3866 
3867 	p->scx.disallow = false;
3868 
3869 	if (SCX_HAS_OP(sch, init_task)) {
3870 		struct scx_init_task_args args = {
3871 			SCX_INIT_TASK_ARGS_CGROUP(cgrp ?: tg_cgrp(task_group(p)))
3872 			.fork = fork,
3873 		};
3874 
3875 		ret = SCX_CALL_OP_RET(sch, init_task, NULL, p, &args);
3876 		if (unlikely(ret)) {
3877 			ret = scx_ops_sanitize_err(sch, "init_task", ret);
3878 			return ret;
3879 		}
3880 	}
3881 
3882 	if (p->scx.disallow) {
3883 		if (unlikely(scx_parent(sch))) {
3884 			scx_error(sch, "non-root ops.init_task() set task->scx.disallow for %s[%d]",
3885 				  p->comm, p->pid);
3886 		} else if (unlikely(fork)) {
3887 			scx_error(sch, "ops.init_task() set task->scx.disallow for %s[%d] during fork",
3888 				  p->comm, p->pid);
3889 		} else if (unlikely(scx_enable_state() != SCX_ENABLING)) {
3890 			scx_error(sch, "ops.init_task() set task->scx.disallow for %s[%d] outside the enable path",
3891 				  p->comm, p->pid);
3892 		} else {
3893 			struct rq *rq;
3894 			struct rq_flags rf;
3895 
3896 			rq = task_rq_lock(p, &rf);
3897 
3898 			/*
3899 			 * We're in the load path and @p->policy will be applied
3900 			 * right after. Reverting @p->policy here and rejecting
3901 			 * %SCHED_EXT transitions from scx_check_setscheduler()
3902 			 * guarantees that if ops.init_task() sets @p->disallow,
3903 			 * @p can never be in SCX.
3904 			 */
3905 			if (p->policy == SCHED_EXT) {
3906 				p->policy = SCHED_NORMAL;
3907 				atomic_long_inc(&scx_nr_rejected);
3908 			}
3909 
3910 			task_rq_unlock(rq, p, &rf);
3911 		}
3912 	}
3913 
3914 	return 0;
3915 }
3916 
__scx_enable_task(struct scx_sched * sch,struct task_struct * p)3917 static void __scx_enable_task(struct scx_sched *sch, struct task_struct *p)
3918 {
3919 	struct rq *rq = task_rq(p);
3920 	u32 weight;
3921 
3922 	lockdep_assert_rq_held(rq);
3923 
3924 	/*
3925 	 * Verify the task is not in BPF scheduler's custody. If flag
3926 	 * transitions are consistent, the flag should always be clear
3927 	 * here.
3928 	 */
3929 	WARN_ON_ONCE(p->scx.flags & SCX_TASK_IN_CUSTODY);
3930 
3931 	/*
3932 	 * Set the weight before calling ops.enable() so that the scheduler
3933 	 * doesn't see a stale value if they inspect the task struct.
3934 	 */
3935 	if (task_has_idle_policy(p))
3936 		weight = WEIGHT_IDLEPRIO;
3937 	else
3938 		weight = sched_prio_to_weight[p->static_prio - MAX_RT_PRIO];
3939 
3940 	p->scx.weight = sched_weight_to_cgroup(weight);
3941 
3942 	if (SCX_HAS_OP(sch, enable))
3943 		SCX_CALL_OP_TASK(sch, enable, rq, p);
3944 
3945 	if (SCX_HAS_OP(sch, set_weight))
3946 		SCX_CALL_OP_TASK(sch, set_weight, rq, p, p->scx.weight);
3947 }
3948 
scx_enable_task(struct scx_sched * sch,struct task_struct * p)3949 void scx_enable_task(struct scx_sched *sch, struct task_struct *p)
3950 {
3951 	__scx_enable_task(sch, p);
3952 	scx_set_task_state(p, SCX_TASK_ENABLED);
3953 }
3954 
scx_disable_task(struct scx_sched * sch,struct task_struct * p)3955 static void scx_disable_task(struct scx_sched *sch, struct task_struct *p)
3956 {
3957 	struct rq *rq = task_rq(p);
3958 
3959 	lockdep_assert_rq_held(rq);
3960 	WARN_ON_ONCE(scx_get_task_state(p) != SCX_TASK_ENABLED);
3961 
3962 	clear_direct_dispatch(p);
3963 
3964 	if (SCX_HAS_OP(sch, disable))
3965 		SCX_CALL_OP_TASK(sch, disable, rq, p);
3966 	scx_set_task_state(p, SCX_TASK_READY);
3967 
3968 	/*
3969 	 * Reset the SCX-managed fields when @p leaves the BPF scheduler's
3970 	 * control, after ops.disable() has observed their final values.
3971 	 */
3972 	p->scx.dsq_vtime = 0;
3973 	scx_task_slice_ended(rq, p);
3974 	scx_set_task_slice(p, 0);
3975 	p->scx.reenq_cnt = 0;
3976 
3977 	/*
3978 	 * Verify the task is not in BPF scheduler's custody. If flag
3979 	 * transitions are consistent, the flag should always be clear
3980 	 * here.
3981 	 */
3982 	WARN_ON_ONCE(p->scx.flags & SCX_TASK_IN_CUSTODY);
3983 }
3984 
__scx_disable_and_exit_task(struct scx_sched * sch,struct task_struct * p)3985 void __scx_disable_and_exit_task(struct scx_sched *sch, struct task_struct *p)
3986 {
3987 	struct scx_exit_task_args args = {
3988 		.cancelled = false,
3989 	};
3990 
3991 	lockdep_assert_held(&p->pi_lock);
3992 	lockdep_assert_rq_held(task_rq(p));
3993 
3994 	switch (scx_get_task_state(p)) {
3995 	case SCX_TASK_NONE:
3996 		return;
3997 	case SCX_TASK_INIT:
3998 		args.cancelled = true;
3999 		break;
4000 	case SCX_TASK_READY:
4001 		break;
4002 	case SCX_TASK_ENABLED:
4003 		scx_disable_task(sch, p);
4004 		break;
4005 	default:
4006 		WARN_ON_ONCE(true);
4007 		return;
4008 	}
4009 
4010 	if (SCX_HAS_OP(sch, exit_task))
4011 		SCX_CALL_OP_TASK(sch, exit_task, task_rq(p), p, &args);
4012 }
4013 
4014 /*
4015  * Undo a completed __scx_init_task(sch, p, false) when scx_enable_task() never
4016  * ran. The task state has not been transitioned, so this mirrors the
4017  * SCX_TASK_INIT branch in __scx_disable_and_exit_task().
4018  */
scx_sub_init_cancel_task(struct scx_sched * sch,struct task_struct * p)4019 void scx_sub_init_cancel_task(struct scx_sched *sch, struct task_struct *p)
4020 {
4021 	struct scx_exit_task_args args = { .cancelled = true };
4022 
4023 	lockdep_assert_held(&p->pi_lock);
4024 	lockdep_assert_rq_held(task_rq(p));
4025 
4026 	/* @p was never associated with @sch, dispatch on the explicit @sch */
4027 	if (SCX_HAS_OP(sch, exit_task))
4028 		__SCX_CALL_OP_TASK(sch, ops, exit_task, task_rq(p), p, &args);
4029 }
4030 
scx_disable_and_exit_task(struct scx_sched * sch,struct task_struct * p)4031 void scx_disable_and_exit_task(struct scx_sched *sch, struct task_struct *p)
4032 {
4033 	__scx_disable_and_exit_task(sch, p);
4034 
4035 	/*
4036 	 * If set, @p exited between __scx_init_task() and scx_enable_task() in
4037 	 * scx_sub_enable() and is initialized for both the associated sched and
4038 	 * its parent. Exit for the child too - scx_enable_task() never ran for
4039 	 * it, so undo only init_task. The flag is only set on the sub-enable
4040 	 * path, so it's always clear when @p arrives here in %SCX_TASK_NONE.
4041 	 */
4042 	if (p->scx.flags & SCX_TASK_SUB_INIT) {
4043 		if (!WARN_ON_ONCE(!scx_enabling_sub_sched))
4044 			scx_sub_init_cancel_task(scx_enabling_sub_sched, p);
4045 		p->scx.flags &= ~SCX_TASK_SUB_INIT;
4046 	}
4047 
4048 	scx_set_task_sched(p, NULL);
4049 	scx_set_task_state(p, SCX_TASK_NONE);
4050 }
4051 
init_scx_entity(struct sched_ext_entity * scx)4052 void init_scx_entity(struct sched_ext_entity *scx)
4053 {
4054 	memset(scx, 0, sizeof(*scx));
4055 	INIT_LIST_HEAD(&scx->dsq_list.node);
4056 	RB_CLEAR_NODE(&scx->dsq_priq);
4057 	scx->sticky_cpu = -1;
4058 	scx->holding_cpu = -1;
4059 	scx->runnable_cpu = -1;
4060 	INIT_LIST_HEAD(&scx->runnable_node);
4061 	scx->runnable_at = jiffies;
4062 	scx->ddsp_dsq_id = SCX_DSQ_INVALID;
4063 	scx->slice = SCX_SLICE_DFL;
4064 }
4065 
4066 /* See scx_tid_alloc / scx_tid_cursor. */
scx_alloc_tid(void)4067 static u64 scx_alloc_tid(void)
4068 {
4069 	struct scx_tid_alloc *ta;
4070 
4071 	guard(preempt)();
4072 	ta = this_cpu_ptr(&scx_tid_alloc);
4073 
4074 	if (unlikely(ta->next >= ta->end)) {
4075 		ta->next = atomic64_fetch_add(SCX_TID_CHUNK, &scx_tid_cursor);
4076 		ta->end = ta->next + SCX_TID_CHUNK;
4077 	}
4078 	return ta->next++;
4079 }
4080 
scx_tid_hash_insert(struct task_struct * p)4081 static void scx_tid_hash_insert(struct task_struct *p)
4082 {
4083 	int ret;
4084 
4085 	lockdep_assert_held(&scx_tasks_lock);
4086 
4087 	ret = rhashtable_lookup_insert_fast(&scx_tid_hash,
4088 					    &p->scx.tid_hash_node,
4089 					    scx_tid_hash_params);
4090 	WARN_ON_ONCE(ret);
4091 }
4092 
scx_pre_fork(struct task_struct * p)4093 void scx_pre_fork(struct task_struct *p)
4094 {
4095 	/*
4096 	 * BPF scheduler enable/disable paths want to be able to iterate and
4097 	 * update all tasks which can become complex when racing forks. As
4098 	 * enable/disable are very cold paths, let's use a percpu_rwsem to
4099 	 * exclude forks.
4100 	 */
4101 	percpu_down_read(&scx_fork_rwsem);
4102 }
4103 
scx_fork(struct task_struct * p,struct kernel_clone_args * kargs)4104 int scx_fork(struct task_struct *p, struct kernel_clone_args *kargs)
4105 {
4106 	s32 ret;
4107 
4108 	percpu_rwsem_assert_held(&scx_fork_rwsem);
4109 
4110 	p->scx.tid = scx_alloc_tid();
4111 
4112 	if (scx_init_task_enabled) {
4113 #ifdef CONFIG_EXT_SUB_SCHED
4114 		struct scx_sched *sch = scx_cgroup_sched(kargs->cset->dfl_cgrp);
4115 #else
4116 		struct scx_sched *sch = scx_root_protected_live();
4117 #endif
4118 		scx_set_task_state(p, SCX_TASK_INIT_BEGIN);
4119 		ret = __scx_init_task(sch, p, NULL, true);
4120 		if (unlikely(ret)) {
4121 			scx_set_task_state(p, SCX_TASK_NONE);
4122 			return ret;
4123 		}
4124 		scx_set_task_state(p, SCX_TASK_INIT);
4125 		scx_set_task_sched(p, sch);
4126 	}
4127 
4128 	return 0;
4129 }
4130 
scx_post_fork(struct task_struct * p)4131 void scx_post_fork(struct task_struct *p)
4132 {
4133 	if (scx_init_task_enabled) {
4134 		scx_set_task_state(p, SCX_TASK_READY);
4135 
4136 		/*
4137 		 * Enable the task immediately if it's running on sched_ext.
4138 		 * Otherwise, it'll be enabled in switching_to_scx() if and
4139 		 * when it's ever configured to run with a SCHED_EXT policy.
4140 		 */
4141 		if (p->sched_class == &ext_sched_class) {
4142 			struct rq_flags rf;
4143 			struct rq *rq;
4144 
4145 			rq = task_rq_lock(p, &rf);
4146 			scx_enable_task(scx_task_sched(p), p);
4147 			task_rq_unlock(rq, p, &rf);
4148 		}
4149 	}
4150 
4151 	scoped_guard(raw_spinlock_irq, &scx_tasks_lock) {
4152 		list_add_tail(&p->scx.tasks_node, &scx_tasks);
4153 		if (scx_tid_to_task_enabled())
4154 			scx_tid_hash_insert(p);
4155 	}
4156 
4157 	percpu_up_read(&scx_fork_rwsem);
4158 }
4159 
scx_cancel_fork(struct task_struct * p)4160 void scx_cancel_fork(struct task_struct *p)
4161 {
4162 	if (scx_init_task_enabled) {
4163 		struct rq *rq;
4164 		struct rq_flags rf;
4165 
4166 		rq = task_rq_lock(p, &rf);
4167 		WARN_ON_ONCE(scx_get_task_state(p) >= SCX_TASK_READY);
4168 		scx_disable_and_exit_task(scx_task_sched(p), p);
4169 		task_rq_unlock(rq, p, &rf);
4170 	}
4171 
4172 	percpu_up_read(&scx_fork_rwsem);
4173 }
4174 
4175 /**
4176  * task_dead_and_done - Is a task dead and done running?
4177  * @p: target task
4178  *
4179  * Once sched_ext_dead() removes the dead task from scx_tasks and exits it, the
4180  * task no longer exists from SCX's POV. However, certain sched_class ops may be
4181  * invoked on these dead tasks leading to failures - e.g. sched_setscheduler()
4182  * may try to switch a task which finished sched_ext_dead() back into SCX
4183  * triggering invalid SCX task state transitions and worse.
4184  *
4185  * Once a task has finished the final switch, sched_ext_dead() is the only thing
4186  * that needs to happen on the task. Use this test to short-circuit sched_class
4187  * operations which may be called on dead tasks.
4188  */
task_dead_and_done(struct task_struct * p)4189 static bool task_dead_and_done(struct task_struct *p)
4190 {
4191 	struct rq *rq = task_rq(p);
4192 
4193 	lockdep_assert_rq_held(rq);
4194 
4195 	/*
4196 	 * In do_task_dead(), a dying task sets %TASK_DEAD with preemption
4197 	 * disabled and __schedule(). If @p has %TASK_DEAD set and off CPU, @p
4198 	 * won't ever run again.
4199 	 */
4200 	return unlikely(READ_ONCE(p->__state) == TASK_DEAD) &&
4201 		!task_on_cpu(rq, p);
4202 }
4203 
sched_ext_dead(struct task_struct * p)4204 void sched_ext_dead(struct task_struct *p)
4205 {
4206 	/*
4207 	 * By the time control reaches here, @p has %TASK_DEAD set, switched out
4208 	 * for the last time and then dropped the rq lock - task_dead_and_done()
4209 	 * should be returning %true nullifying the straggling sched_class ops.
4210 	 * Remove from scx_tasks and exit @p.
4211 	 */
4212 	scoped_guard(raw_spinlock_irqsave, &scx_tasks_lock) {
4213 		list_del_init(&p->scx.tasks_node);
4214 		if (scx_tid_to_task_enabled())
4215 			rhashtable_remove_fast(&scx_tid_hash,
4216 					       &p->scx.tid_hash_node,
4217 					       scx_tid_hash_params);
4218 	}
4219 
4220 	/*
4221 	 * @p is off scx_tasks and wholly ours. scx_root_enable()'s READY ->
4222 	 * ENABLED transitions can't race us. Disable ops for @p.
4223 	 *
4224 	 * %SCX_TASK_DEAD synchronizes against cgroup task iteration - see
4225 	 * scx_task_iter_next_locked(). NONE tasks need no marking: cgroup
4226 	 * iteration is only used from sub-sched paths, which require root
4227 	 * enabled. Root enable transitions every live task to at least READY.
4228 	 *
4229 	 * %INIT_BEGIN means ops.init_task() is running for @p. Don't call
4230 	 * into ops; transition to %DEAD so the post-init recheck unwinds
4231 	 * via scx_sub_init_cancel_task().
4232 	 */
4233 	if (scx_get_task_state(p) != SCX_TASK_NONE) {
4234 		struct rq_flags rf;
4235 		struct rq *rq;
4236 
4237 		rq = task_rq_lock(p, &rf);
4238 		if (scx_get_task_state(p) != SCX_TASK_INIT_BEGIN)
4239 			scx_disable_and_exit_task(scx_task_sched(p), p);
4240 		scx_set_task_state(p, SCX_TASK_DEAD);
4241 		task_rq_unlock(rq, p, &rf);
4242 	}
4243 }
4244 
reweight_task_scx(struct rq * rq,struct task_struct * p,const struct load_weight * lw)4245 static void reweight_task_scx(struct rq *rq, struct task_struct *p,
4246 			      const struct load_weight *lw)
4247 {
4248 	struct scx_sched *sch = scx_task_sched(p);
4249 
4250 	lockdep_assert_rq_held(task_rq(p));
4251 
4252 	if (task_dead_and_done(p))
4253 		return;
4254 
4255 	/*
4256 	 * When switching sched_class away from SCX, reweight_task_scx()
4257 	 * is called _after_ scx_disable_task(). Skip calling ops.set_weight()
4258 	 * since the BPF scheduler may have already forgotten the task in
4259 	 * ops.disable().
4260 	 * p->scx.weight will be recalculated in scx_enable_task() if the task
4261 	 * ever returns to SCX class.
4262 	 */
4263 	if (scx_get_task_state(p) != SCX_TASK_ENABLED)
4264 		return;
4265 
4266 	p->scx.weight = sched_weight_to_cgroup(scale_load_down(lw->weight));
4267 	if (SCX_HAS_OP(sch, set_weight))
4268 		SCX_CALL_OP_TASK(sch, set_weight, rq, p, p->scx.weight);
4269 }
4270 
prio_changed_scx(struct rq * rq,struct task_struct * p,u64 oldprio)4271 static void prio_changed_scx(struct rq *rq, struct task_struct *p, u64 oldprio)
4272 {
4273 }
4274 
switching_to_scx(struct rq * rq,struct task_struct * p)4275 static void switching_to_scx(struct rq *rq, struct task_struct *p)
4276 {
4277 	struct scx_sched *sch = scx_task_sched(p);
4278 
4279 	if (task_dead_and_done(p))
4280 		return;
4281 
4282 	scx_enable_task(sch, p);
4283 
4284 	/*
4285 	 * set_cpus_allowed_scx() is not called while @p is associated with a
4286 	 * different scheduler class. Keep the BPF scheduler up-to-date.
4287 	 */
4288 	if (SCX_HAS_OP(sch, set_cpumask))
4289 		scx_call_op_set_cpumask(sch, rq, p, (struct cpumask *)p->cpus_ptr);
4290 }
4291 
switched_from_scx(struct rq * rq,struct task_struct * p)4292 static void switched_from_scx(struct rq *rq, struct task_struct *p)
4293 {
4294 	if (task_dead_and_done(p))
4295 		return;
4296 
4297 	/*
4298 	 * %NONE means SCX is no longer tracking @p at the task level (e.g.
4299 	 * scx_fail_parent() handed @p back to the parent at NONE pending the
4300 	 * parent's own teardown). There is nothing to disable; calling
4301 	 * scx_disable_task() would WARN on the non-%ENABLED state and trigger a
4302 	 * NONE -> READY validation failure.
4303 	 */
4304 	if (scx_get_task_state(p) == SCX_TASK_NONE)
4305 		return;
4306 
4307 	scx_disable_task(scx_task_sched(p), p);
4308 }
4309 
switched_to_scx(struct rq * rq,struct task_struct * p)4310 static void switched_to_scx(struct rq *rq, struct task_struct *p) {}
4311 
scx_check_setscheduler(struct task_struct * p,int policy)4312 int scx_check_setscheduler(struct task_struct *p, int policy)
4313 {
4314 	lockdep_assert_rq_held(task_rq(p));
4315 
4316 	/* if disallow, reject transitioning into SCX */
4317 	if (scx_enabled() && READ_ONCE(p->scx.disallow) &&
4318 	    p->policy != policy && policy == SCHED_EXT)
4319 		return -EACCES;
4320 
4321 	return 0;
4322 }
4323 
process_ddsp_deferred_locals(struct rq * rq)4324 static void process_ddsp_deferred_locals(struct rq *rq)
4325 {
4326 	struct task_struct *p;
4327 
4328 	lockdep_assert_rq_held(rq);
4329 
4330 	/*
4331 	 * Now that @rq can be unlocked, execute the deferred enqueueing of
4332 	 * tasks directly dispatched to the local DSQs of other CPUs. See
4333 	 * direct_dispatch(). Keep popping from the head instead of using
4334 	 * list_for_each_entry_safe() as dispatch_local_dsq() may unlock @rq
4335 	 * temporarily.
4336 	 */
4337 	while ((p = list_first_entry_or_null(&rq->scx.ddsp_deferred_locals,
4338 				struct task_struct, scx.dsq_list.node))) {
4339 		struct scx_sched *sch = scx_task_sched(p);
4340 		struct scx_dispatch_q *dsq;
4341 		u64 dsq_id = p->scx.ddsp_dsq_id;
4342 		u64 enq_flags = p->scx.ddsp_enq_flags;
4343 		u64 slice = p->scx.ddsp_slice;
4344 		u64 vtime = p->scx.ddsp_vtime;
4345 
4346 		list_del_init(&p->scx.dsq_list.node);
4347 		clear_direct_dispatch(p);
4348 
4349 		dsq = find_dsq_for_dispatch(sch, rq, dsq_id, task_cpu(p));
4350 		if (!WARN_ON_ONCE(dsq->id != SCX_DSQ_LOCAL))
4351 			dispatch_to_local_dsq(sch, rq, dsq, p, slice, vtime, enq_flags);
4352 	}
4353 }
4354 
4355 /*
4356  * Determine whether @p should be reenqueued from a local DSQ.
4357  *
4358  * @reenq_flags is mutable and accumulates state across the DSQ walk:
4359  *
4360  * - %SCX_REENQ_TSR_NOT_FIRST: Set after the first task is visited. "First"
4361  *   tracks position in the DSQ list, not among IMMED tasks. A non-IMMED task at
4362  *   the head consumes the first slot.
4363  *
4364  * - %SCX_REENQ_TSR_RQ_OPEN: Set by reenq_local() before the walk if
4365  *   rq_is_open() is true.
4366  *
4367  * An IMMED task is kept (returns %false) only if it's the first task in the DSQ
4368  * AND the current task is done — i.e. it will execute immediately. All other
4369  * IMMED tasks are reenqueued. This means if a non-IMMED task sits at the head,
4370  * every IMMED task behind it gets reenqueued.
4371  *
4372  * Reenqueued tasks go through ops.enqueue() with %SCX_ENQ_REENQ |
4373  * %SCX_TASK_REENQ_IMMED. If the BPF scheduler dispatches back to the same local
4374  * DSQ with %SCX_ENQ_IMMED while the CPU is still unavailable, this triggers
4375  * another reenq cycle. Repetitions are bounded by %SCX_REENQ_MAX_REPEAT in
4376  * scx_do_enqueue_task(), which ejects the task's owning scheduler.
4377  */
local_task_should_reenq(struct rq * rq,struct task_struct * p,u64 * reenq_flags,u32 * reason)4378 static bool local_task_should_reenq(struct rq *rq, struct task_struct *p,
4379 				    u64 *reenq_flags, u32 *reason)
4380 {
4381 	bool first;
4382 
4383 	first = !(*reenq_flags & SCX_REENQ_TSR_NOT_FIRST);
4384 	*reenq_flags |= SCX_REENQ_TSR_NOT_FIRST;
4385 
4386 	if (unlikely((p->scx.flags & SCX_TASK_PROTECTED) || p == scx_rescuee(rq)))
4387 		return false;
4388 
4389 	*reason = SCX_TASK_REENQ_KFUNC;
4390 
4391 	if ((p->scx.flags & SCX_TASK_IMMED) &&
4392 	    (!first || !(*reenq_flags & SCX_REENQ_TSR_RQ_OPEN))) {
4393 		__scx_add_event(scx_task_sched(p), SCX_EV_REENQ_IMMED, 1);
4394 		*reason = SCX_TASK_REENQ_IMMED;
4395 		return true;
4396 	}
4397 
4398 	if ((*reenq_flags & SCX_REENQ_CAP_REVOKE) &&
4399 	    scx_task_reenq_on_cap_revoke(rq, p)) {
4400 		*reason = SCX_TASK_REENQ_CAP;
4401 		return true;
4402 	}
4403 
4404 	return *reenq_flags & SCX_REENQ_ANY;
4405 }
4406 
reenq_local(struct scx_sched * sch,struct rq * rq,u64 reenq_flags)4407 static u32 reenq_local(struct scx_sched *sch, struct rq *rq, u64 reenq_flags)
4408 {
4409 	LIST_HEAD(tasks);
4410 	u32 nr_enqueued = 0;
4411 	struct task_struct *p, *n;
4412 
4413 	lockdep_assert_rq_held(rq);
4414 
4415 	if (WARN_ON_ONCE(reenq_flags & __SCX_REENQ_TSR_MASK))
4416 		reenq_flags &= ~__SCX_REENQ_TSR_MASK;
4417 	if (rq_is_open(rq, 0))
4418 		reenq_flags |= SCX_REENQ_TSR_RQ_OPEN;
4419 
4420 	/*
4421 	 * The BPF scheduler may choose to dispatch tasks back to
4422 	 * @rq->scx.local_dsq. Move all candidate tasks off to a private list
4423 	 * first to avoid processing the same tasks repeatedly.
4424 	 */
4425 	list_for_each_entry_safe(p, n, &rq->scx.local_dsq.list,
4426 				 scx.dsq_list.node) {
4427 		struct scx_sched *task_sch = scx_task_sched(p);
4428 		u32 reason;
4429 
4430 		/*
4431 		 * If @p is being migrated, @p's current CPU may not agree with
4432 		 * its allowed CPUs and the migration_cpu_stop is about to
4433 		 * deactivate and re-activate @p anyway. Skip re-enqueueing.
4434 		 *
4435 		 * While racing sched property changes may also dequeue and
4436 		 * re-enqueue a migrating task while its current CPU and allowed
4437 		 * CPUs disagree, they use %ENQUEUE_RESTORE which is bypassed to
4438 		 * the current local DSQ for running tasks and thus are not
4439 		 * visible to the BPF scheduler.
4440 		 */
4441 		if (p->migration_pending)
4442 			continue;
4443 
4444 		if (!scx_is_descendant(task_sch, sch))
4445 			continue;
4446 
4447 		if (!local_task_should_reenq(rq, p, &reenq_flags, &reason))
4448 			continue;
4449 
4450 		scx_dispatch_dequeue(rq, p);
4451 
4452 		if (WARN_ON_ONCE(p->scx.flags & SCX_TASK_REENQ_REASON_MASK))
4453 			p->scx.flags &= ~SCX_TASK_REENQ_REASON_MASK;
4454 		p->scx.flags |= reason;
4455 
4456 		list_add_tail(&p->scx.dsq_list.node, &tasks);
4457 	}
4458 
4459 	list_for_each_entry_safe(p, n, &tasks, scx.dsq_list.node) {
4460 		list_del_init(&p->scx.dsq_list.node);
4461 
4462 		scx_do_enqueue_task(rq, p, SCX_ENQ_REENQ, -1);
4463 
4464 		p->scx.flags &= ~SCX_TASK_REENQ_REASON_MASK;
4465 		nr_enqueued++;
4466 	}
4467 
4468 	/*
4469 	 * The revoke that scheduled this scan may have raced the pick: curr
4470 	 * may be a now-capless task, either one that kept running or one
4471 	 * promoted off the local DSQ between the ecaps sync and this scan.
4472 	 * Zero the slice to evict it. The enqueue gate blocks new capless
4473 	 * inserts, so no later pick can slip through after the scan.
4474 	 */
4475 	if ((reenq_flags & SCX_REENQ_CAP_REVOKE) &&
4476 	    rq->curr->sched_class == &ext_sched_class &&
4477 	    scx_task_reenq_on_cap_revoke(rq, rq->curr)) {
4478 		scx_set_task_slice(rq->curr, 0);
4479 		resched_curr(rq);
4480 	}
4481 
4482 	return nr_enqueued;
4483 }
4484 
process_deferred_reenq_locals(struct rq * rq)4485 static void process_deferred_reenq_locals(struct rq *rq)
4486 {
4487 	lockdep_assert_rq_held(rq);
4488 
4489 	/*
4490 	 * A task can be re-queued within this loop when a reenqueued task
4491 	 * bounces straight back to the local DSQ. That recursion is bounded by
4492 	 * the per-task reenqueue cap in scx_do_enqueue_task().
4493 	 */
4494 	while (true) {
4495 		struct scx_sched *sch;
4496 		u64 reenq_flags;
4497 
4498 		scoped_guard (raw_spinlock, &rq->scx.deferred_reenq_lock) {
4499 			struct scx_deferred_reenq_local *drl =
4500 				list_first_entry_or_null(&rq->scx.deferred_reenq_locals,
4501 							 struct scx_deferred_reenq_local,
4502 							 node);
4503 			struct scx_sched_pcpu *sch_pcpu;
4504 
4505 			if (!drl)
4506 				return;
4507 
4508 			sch_pcpu = container_of(drl, struct scx_sched_pcpu,
4509 						deferred_reenq_local);
4510 			sch = sch_pcpu->sch;
4511 
4512 			reenq_flags = drl->flags;
4513 			WRITE_ONCE(drl->flags, 0);
4514 			list_del_init(&drl->node);
4515 		}
4516 
4517 		/* see schedule_dsq_reenq() */
4518 		smp_mb();
4519 
4520 		reenq_local(sch, rq, reenq_flags);
4521 	}
4522 }
4523 
user_task_should_reenq(struct task_struct * p,u64 reenq_flags,u32 * reason)4524 static bool user_task_should_reenq(struct task_struct *p, u64 reenq_flags, u32 *reason)
4525 {
4526 	*reason = SCX_TASK_REENQ_KFUNC;
4527 	return reenq_flags & SCX_REENQ_ANY;
4528 }
4529 
reenq_user(struct rq * rq,struct scx_dispatch_q * dsq,u64 reenq_flags)4530 static void reenq_user(struct rq *rq, struct scx_dispatch_q *dsq, u64 reenq_flags)
4531 {
4532 	struct rq *locked_rq = rq;
4533 	struct scx_sched *sch = dsq->sched;
4534 	struct scx_dsq_list_node cursor = INIT_DSQ_LIST_CURSOR(cursor, dsq, 0);
4535 	struct task_struct *p;
4536 	s32 nr_enqueued = 0;
4537 
4538 	lockdep_assert_rq_held(rq);
4539 
4540 	raw_spin_lock(&dsq->lock);
4541 
4542 	while (likely(!READ_ONCE(sch->bypass_depth))) {
4543 		struct rq *task_rq;
4544 		u32 reason;
4545 
4546 		p = nldsq_cursor_next_task(&cursor, dsq);
4547 		if (!p)
4548 			break;
4549 
4550 		if (!user_task_should_reenq(p, reenq_flags, &reason))
4551 			continue;
4552 
4553 		task_rq = task_rq(p);
4554 
4555 		if (locked_rq != task_rq) {
4556 			if (locked_rq) {
4557 				scx_rq_lock_drop(locked_rq);
4558 				raw_spin_rq_unlock(locked_rq);
4559 			}
4560 			if (unlikely(!raw_spin_rq_trylock(task_rq))) {
4561 				raw_spin_unlock(&dsq->lock);
4562 				raw_spin_rq_lock(task_rq);
4563 				raw_spin_lock(&dsq->lock);
4564 			}
4565 			locked_rq = task_rq;
4566 
4567 			/* did we lose @p while switching locks? */
4568 			if (nldsq_cursor_lost_task(&cursor, task_rq, dsq, p))
4569 				continue;
4570 		}
4571 
4572 		/* @p is on @dsq, its rq and @dsq are locked */
4573 		dispatch_dequeue_locked(p, dsq);
4574 		raw_spin_unlock(&dsq->lock);
4575 
4576 		if (WARN_ON_ONCE(p->scx.flags & SCX_TASK_REENQ_REASON_MASK))
4577 			p->scx.flags &= ~SCX_TASK_REENQ_REASON_MASK;
4578 		p->scx.flags |= reason;
4579 
4580 		scx_do_enqueue_task(task_rq, p, SCX_ENQ_REENQ, -1);
4581 
4582 		p->scx.flags &= ~SCX_TASK_REENQ_REASON_MASK;
4583 
4584 		if (!(++nr_enqueued % SCX_TASK_ITER_BATCH)) {
4585 			scx_rq_lock_drop(locked_rq);
4586 			raw_spin_rq_unlock(locked_rq);
4587 			locked_rq = NULL;
4588 			cpu_relax();
4589 		}
4590 
4591 		raw_spin_lock(&dsq->lock);
4592 	}
4593 
4594 	list_del_init(&cursor.node);
4595 	raw_spin_unlock(&dsq->lock);
4596 
4597 	if (locked_rq != rq) {
4598 		if (locked_rq) {
4599 			scx_rq_lock_drop(locked_rq);
4600 			raw_spin_rq_unlock(locked_rq);
4601 		}
4602 		raw_spin_rq_lock(rq);
4603 	}
4604 }
4605 
process_deferred_reenq_users(struct rq * rq)4606 static void process_deferred_reenq_users(struct rq *rq)
4607 {
4608 	lockdep_assert_rq_held(rq);
4609 
4610 	while (true) {
4611 		struct scx_dispatch_q *dsq;
4612 		u64 dsq_id, reenq_flags;
4613 
4614 		scoped_guard (raw_spinlock, &rq->scx.deferred_reenq_lock) {
4615 			struct scx_deferred_reenq_user *dru =
4616 				list_first_entry_or_null(&rq->scx.deferred_reenq_users,
4617 							 struct scx_deferred_reenq_user,
4618 							 node);
4619 			struct scx_dsq_pcpu *dsq_pcpu;
4620 
4621 			if (!dru)
4622 				return;
4623 
4624 			dsq_pcpu = container_of(dru, struct scx_dsq_pcpu,
4625 						deferred_reenq_user);
4626 			dsq = dsq_pcpu->dsq;
4627 			reenq_flags = dru->flags;
4628 			WRITE_ONCE(dru->flags, 0);
4629 			list_del_init(&dru->node);
4630 		}
4631 
4632 		/* see schedule_dsq_reenq() */
4633 		smp_mb();
4634 
4635 		/* destroy_dsq() may have raced and invalidated @dsq, nothing to reenq */
4636 		dsq_id = READ_ONCE(dsq->id);
4637 		if (unlikely(dsq_id == SCX_DSQ_INVALID))
4638 			continue;
4639 
4640 		BUG_ON(dsq_id & SCX_DSQ_FLAG_BUILTIN);
4641 		reenq_user(rq, dsq, reenq_flags);
4642 	}
4643 }
4644 
run_deferred(struct rq * rq)4645 static void run_deferred(struct rq *rq)
4646 {
4647 	process_ddsp_deferred_locals(rq);
4648 
4649 	if (!list_empty(&rq->scx.deferred_reenq_locals))
4650 		process_deferred_reenq_locals(rq);
4651 
4652 	if (!list_empty(&rq->scx.deferred_reenq_users))
4653 		process_deferred_reenq_users(rq);
4654 
4655 	scx_reenq_reject(rq);
4656 }
4657 
4658 #ifdef CONFIG_NO_HZ_FULL
scx_can_stop_tick(struct rq * rq)4659 bool scx_can_stop_tick(struct rq *rq)
4660 {
4661 	struct task_struct *p = rq->curr;
4662 	struct scx_sched *sch = scx_task_sched(p);
4663 
4664 	if (p->sched_class != &ext_sched_class)
4665 		return true;
4666 
4667 	/*
4668 	 * @rq->curr may still reference an outgoing EXT task after it has been
4669 	 * dequeued. If no EXT tasks are accounted on @rq, ignore its stale
4670 	 * slice state. If another task is dispatched from a DSQ,
4671 	 * set_next_task_scx() will update the dependency for the incoming task.
4672 	 */
4673 	if (!rq->scx.nr_running)
4674 		return true;
4675 
4676 	if (scx_bypassing(sch, cpu_of(rq)))
4677 		return false;
4678 
4679 	/*
4680 	 * A running rescuee's charging and expiry are tick-driven, see
4681 	 * scx_rescue_charge(). Keep the tick while rescue is in progress.
4682 	 */
4683 	if (unlikely(p == scx_rescuee(rq)))
4684 		return false;
4685 
4686 	/*
4687 	 * @rq can dispatch from different DSQs, so we can't tell whether it
4688 	 * needs the tick or not by looking at nr_running. Allow stopping ticks
4689 	 * iff the BPF scheduler indicated so. See set_next_task_scx().
4690 	 */
4691 	return rq->scx.flags & SCX_RQ_CAN_STOP_TICK;
4692 }
4693 #endif
4694 
4695 #ifdef CONFIG_EXT_GROUP_SCHED
4696 
4697 DEFINE_STATIC_PERCPU_RWSEM(scx_cgroup_ops_rwsem);
4698 
scx_tg_init(struct task_group * tg)4699 void scx_tg_init(struct task_group *tg)
4700 {
4701 	tg->scx.weight = CGROUP_WEIGHT_DFL;
4702 	tg->scx.bw_period_us = default_bw_period_us();
4703 	tg->scx.bw_quota_us = RUNTIME_INF;
4704 	tg->scx.idle = false;
4705 }
4706 
4707 /**
4708  * scx_tg_sched - Resolve a task_group's sched
4709  * @tg: task_group of interest
4710  *
4711  * Return the sched that @tg's ops.cgroup_init() succeeded on, %NULL if @tg
4712  * isn't inited. An autogroup tg has no cgroup of its own and resolves to the
4713  * root sched.
4714  *
4715  * When a child sched exits, its task_groups are moved to the parent and
4716  * re-inited on it. A failed re-init fails the parent in turn and leaves the
4717  * task_group without a sched it's inited on, resolving to %NULL. See
4718  * scx_cgroup_return_subtree().
4719  *
4720  * Safe for callers read-locking the ops rwsem. tg->scx.sched rewrites
4721  * write-lock it, and tg on/offline can't overlap such callers as a css's files
4722  * are created after online and drained before offline.
4723  */
scx_tg_sched(struct task_group * tg)4724 static struct scx_sched *scx_tg_sched(struct task_group *tg)
4725 {
4726 	lockdep_assert(lockdep_is_held(&cgroup_mutex) ||
4727 		       lockdep_is_held(&scx_cgroup_ops_rwsem));
4728 
4729 	if (!tg->css.cgroup)
4730 		tg = &root_task_group;
4731 	/* INITED means ops.cgroup_init() succeeded on @tg->scx.sched */
4732 	return (tg->scx.flags & SCX_TG_INITED) ? tg->scx.sched : NULL;
4733 }
4734 
4735 /**
4736  * scx_tg_knob_sched - Resolve the sched receiving a task_group's knob updates
4737  * @tg: task_group of interest
4738  *
4739  * Knobs of a cgroup belong to the parent. Deliver the set_* ops to the
4740  * parent task_group's sched, which equals @tg's own sched everywhere except
4741  * at a sub-scheduler attach point, where the sub's parent sched receives
4742  * them.
4743  *
4744  * Return %NULL if the parent task_group has no sched. That can happen when the
4745  * parent's ops.cgroup_init() fails while a sub-scheduler is being disabled.
4746  *
4747  * The callers sit in @tg's cgroup file writes holding the ops rwsem read
4748  * side. That extends scx_tg_sched()'s file-write argument to the parent's
4749  * sched read: a parent css outlives its children's files.
4750  */
scx_tg_knob_sched(struct task_group * tg)4751 static struct scx_sched *scx_tg_knob_sched(struct task_group *tg)
4752 {
4753 	lockdep_assert(lockdep_is_held(&cgroup_mutex) ||
4754 		       lockdep_is_held(&scx_cgroup_ops_rwsem));
4755 
4756 	if (!tg->css.cgroup || !tg->css.parent)
4757 		return scx_tg_sched(&root_task_group);
4758 	return scx_tg_sched(css_tg(tg->css.parent));
4759 }
4760 
scx_tg_online(struct task_group * tg)4761 int scx_tg_online(struct task_group *tg)
4762 {
4763 	int ret = 0;
4764 
4765 	WARN_ON_ONCE(tg->scx.flags & (SCX_TG_ONLINE | SCX_TG_INITED));
4766 
4767 	if (scx_cgroup_enabled) {
4768 		struct scx_sched *sch;
4769 
4770 		/*
4771 		 * The cgroup lifetime notifier populates cgrp->scx_sched before
4772 		 * css_online, but only on the default hierarchy. Sub-scheds are
4773 		 * attached to the cgroup2 hierarchy, so a cgroup1 task_group
4774 		 * always belongs to the root sched.
4775 		 */
4776 		if (cgroup_on_dfl(tg->css.cgroup))
4777 			sch = scx_cgroup_sched(tg->css.cgroup);
4778 		else
4779 			sch = scx_tg_sched(&root_task_group);
4780 
4781 		if (SCX_HAS_OP(sch, cgroup_init)) {
4782 			struct scx_cgroup_init_args args =
4783 				{ .weight = tg->scx.weight,
4784 				  .bw_period_us = tg->scx.bw_period_us,
4785 				  .bw_quota_us = tg->scx.bw_quota_us,
4786 				  .bw_burst_us = tg->scx.bw_burst_us,
4787 				  .sched_idle = tg->scx.idle };
4788 
4789 			ret = SCX_CALL_OP_RET(sch, cgroup_init,
4790 					      NULL, tg->css.cgroup, &args);
4791 			if (ret)
4792 				ret = scx_ops_sanitize_err(sch, "cgroup_init", ret);
4793 		}
4794 		if (ret == 0) {
4795 			tg->scx.sched = sch;
4796 			tg->scx.flags |= SCX_TG_ONLINE | SCX_TG_INITED;
4797 		}
4798 	} else {
4799 		tg->scx.flags |= SCX_TG_ONLINE;
4800 	}
4801 
4802 	return ret;
4803 }
4804 
scx_tg_offline(struct task_group * tg)4805 void scx_tg_offline(struct task_group *tg)
4806 {
4807 	struct scx_sched *sch = tg->scx.sched;
4808 
4809 	WARN_ON_ONCE(!(tg->scx.flags & SCX_TG_ONLINE));
4810 
4811 	/* INITED implies non-NULL @sch, test before SCX_HAS_OP() derefs */
4812 	if (scx_cgroup_enabled && (tg->scx.flags & SCX_TG_INITED) &&
4813 	    SCX_HAS_OP(sch, cgroup_exit))
4814 		SCX_CALL_OP(sch, cgroup_exit, NULL, tg->css.cgroup);
4815 	tg->scx.sched = NULL;
4816 	tg->scx.flags &= ~(SCX_TG_ONLINE | SCX_TG_INITED);
4817 }
4818 
4819 /*
4820  * @p's sched for the cgroup migration paths. Stable as re-homes happen either
4821  * at CGROUP_TASK_MIGRATED of the same migration or under scx_cgroup_lock(),
4822  * both while holding cgroup_mutex.
4823  */
scx_cgroup_task_sched(struct task_struct * p)4824 static struct scx_sched *scx_cgroup_task_sched(struct task_struct *p)
4825 {
4826 	return rcu_dereference_protected(p->scx.sched, lockdep_is_held(&cgroup_mutex));
4827 }
4828 
scx_cgroup_can_attach(struct cgroup_taskset * tset)4829 int scx_cgroup_can_attach(struct cgroup_taskset *tset)
4830 {
4831 	struct cgroup_subsys_state *css;
4832 	struct task_struct *p;
4833 	int ret;
4834 
4835 	if (!scx_cgroup_enabled)
4836 		return 0;
4837 
4838 	cgroup_taskset_for_each(p, css, tset) {
4839 		struct scx_sched *sch = scx_cgroup_task_sched(p);
4840 		struct cgroup *from = tg_cgrp(task_group(p));
4841 		struct cgroup *to = tg_cgrp(css_tg(css));
4842 
4843 		WARN_ON_ONCE(p->scx.cgrp_moving_from);
4844 
4845 		/*
4846 		 * sched_move_task() omits identity migrations. Let's match the
4847 		 * behavior so that ops.cgroup_prep_move() and ops.cgroup_move()
4848 		 * always match one-to-one.
4849 		 */
4850 		if (from == to)
4851 			continue;
4852 
4853 		/*
4854 		 * The cgroup_move ops are delivered to @p's sched, and only for
4855 		 * moves that don't re-home @p. A re-homing move changes the dfl
4856 		 * cgroup's sched and is reported through the
4857 		 * exit_task/init_task pair that the re-homing generates.
4858 		 */
4859 		if (!sch || sch != scx_cgroup_sched(task_css_set(p)->mg_dst_cset->dfl_cgrp))
4860 			continue;
4861 
4862 		if (SCX_HAS_OP(sch, cgroup_prep_move)) {
4863 			ret = SCX_CALL_OP_RET(sch, cgroup_prep_move, NULL,
4864 					      p, from, css->cgroup);
4865 			if (ret) {
4866 				ret = scx_ops_sanitize_err(sch, "cgroup_prep_move", ret);
4867 				goto err;
4868 			}
4869 		}
4870 
4871 		p->scx.cgrp_moving_from = from;
4872 	}
4873 
4874 	return 0;
4875 
4876 err:
4877 	cgroup_taskset_for_each(p, css, tset) {
4878 		struct scx_sched *sch = scx_cgroup_task_sched(p);
4879 
4880 		/* cgrp_moving_from implies non-NULL @sch, test it first */
4881 		if (p->scx.cgrp_moving_from && SCX_HAS_OP(sch, cgroup_cancel_move))
4882 			SCX_CALL_OP(sch, cgroup_cancel_move, NULL,
4883 				    p, p->scx.cgrp_moving_from, css->cgroup);
4884 		p->scx.cgrp_moving_from = NULL;
4885 	}
4886 
4887 	return ret;
4888 }
4889 
scx_cgroup_move_task(struct task_struct * p)4890 void scx_cgroup_move_task(struct task_struct *p)
4891 {
4892 	struct scx_sched *sch;
4893 
4894 	if (!scx_cgroup_enabled)
4895 		return;
4896 
4897 	/*
4898 	 * Migration keys off css rather than cgroup identity, so it can hand an
4899 	 * unchanged-cgroup task here with cgrp_moving_from NULL. Nothing to
4900 	 * report to the BPF scheduler then, so skip it and keep prep_move and
4901 	 * move paired.
4902 	 */
4903 	sch = scx_cgroup_task_sched(p);
4904 	if (p->scx.cgrp_moving_from && SCX_HAS_OP(sch, cgroup_move))
4905 		SCX_CALL_OP_TASK(sch, cgroup_move, task_rq(p),
4906 				 p, p->scx.cgrp_moving_from,
4907 				 tg_cgrp(task_group(p)));
4908 	p->scx.cgrp_moving_from = NULL;
4909 }
4910 
scx_cgroup_cancel_attach(struct cgroup_taskset * tset)4911 void scx_cgroup_cancel_attach(struct cgroup_taskset *tset)
4912 {
4913 	struct cgroup_subsys_state *css;
4914 	struct task_struct *p;
4915 
4916 	if (!scx_cgroup_enabled)
4917 		return;
4918 
4919 	cgroup_taskset_for_each(p, css, tset) {
4920 		struct scx_sched *sch = scx_cgroup_task_sched(p);
4921 
4922 		/* cgrp_moving_from implies non-NULL @sch, test it first */
4923 		if (p->scx.cgrp_moving_from && SCX_HAS_OP(sch, cgroup_cancel_move))
4924 			SCX_CALL_OP(sch, cgroup_cancel_move, NULL,
4925 				    p, p->scx.cgrp_moving_from, css->cgroup);
4926 		p->scx.cgrp_moving_from = NULL;
4927 	}
4928 }
4929 
scx_group_set_weight(struct task_group * tg,unsigned long weight)4930 void scx_group_set_weight(struct task_group *tg, unsigned long weight)
4931 {
4932 	struct scx_sched *sch;
4933 
4934 	percpu_down_read(&scx_cgroup_ops_rwsem);
4935 	sch = scx_tg_knob_sched(tg);
4936 
4937 	if (scx_cgroup_enabled && sch && SCX_HAS_OP(sch, cgroup_set_weight) &&
4938 	    tg->scx.weight != weight)
4939 		SCX_CALL_OP(sch, cgroup_set_weight, NULL, tg_cgrp(tg), weight);
4940 
4941 	tg->scx.weight = weight;
4942 
4943 	percpu_up_read(&scx_cgroup_ops_rwsem);
4944 }
4945 
scx_group_set_idle(struct task_group * tg,bool idle)4946 void scx_group_set_idle(struct task_group *tg, bool idle)
4947 {
4948 	struct scx_sched *sch;
4949 
4950 	percpu_down_read(&scx_cgroup_ops_rwsem);
4951 	sch = scx_tg_knob_sched(tg);
4952 
4953 	if (scx_cgroup_enabled && sch && SCX_HAS_OP(sch, cgroup_set_idle) &&
4954 	    tg->scx.idle != idle)
4955 		SCX_CALL_OP(sch, cgroup_set_idle, NULL, tg_cgrp(tg), idle);
4956 
4957 	/* Update the task group's idle state */
4958 	tg->scx.idle = idle;
4959 
4960 	percpu_up_read(&scx_cgroup_ops_rwsem);
4961 }
4962 
scx_group_set_bandwidth(struct task_group * tg,u64 period_us,u64 quota_us,u64 burst_us)4963 void scx_group_set_bandwidth(struct task_group *tg,
4964 			     u64 period_us, u64 quota_us, u64 burst_us)
4965 {
4966 	struct scx_sched *sch;
4967 
4968 	percpu_down_read(&scx_cgroup_ops_rwsem);
4969 	sch = scx_tg_knob_sched(tg);
4970 
4971 	if (scx_cgroup_enabled && sch && SCX_HAS_OP(sch, cgroup_set_bandwidth) &&
4972 	    (tg->scx.bw_period_us != period_us ||
4973 	     tg->scx.bw_quota_us != quota_us ||
4974 	     tg->scx.bw_burst_us != burst_us))
4975 		SCX_CALL_OP(sch, cgroup_set_bandwidth, NULL,
4976 			    tg_cgrp(tg), period_us, quota_us, burst_us);
4977 
4978 	tg->scx.bw_period_us = period_us;
4979 	tg->scx.bw_quota_us = quota_us;
4980 	tg->scx.bw_burst_us = burst_us;
4981 
4982 	percpu_up_read(&scx_cgroup_ops_rwsem);
4983 }
4984 #endif	/* CONFIG_EXT_GROUP_SCHED */
4985 
4986 #if defined(CONFIG_EXT_GROUP_SCHED) || defined(CONFIG_EXT_SUB_SCHED)
root_cgroup(void)4987 static struct cgroup *root_cgroup(void)
4988 {
4989 	return &cgrp_dfl_root.cgrp;
4990 }
4991 
4992 /*
4993  * cgroup_lock() must nest outside the rwsem write side: a writer waiting
4994  * for cgroup_mutex deadlocks with cgroup teardown, which holds it while
4995  * draining a set_* file write blocked on the rwsem behind the writer.
4996  */
scx_cgroup_lock(void)4997 void scx_cgroup_lock(void)
4998 {
4999 	cgroup_lock();
5000 #ifdef CONFIG_EXT_GROUP_SCHED
5001 	percpu_down_write(&scx_cgroup_ops_rwsem);
5002 #endif
5003 }
5004 
scx_cgroup_unlock(void)5005 void scx_cgroup_unlock(void)
5006 {
5007 #ifdef CONFIG_EXT_GROUP_SCHED
5008 	percpu_up_write(&scx_cgroup_ops_rwsem);
5009 #endif
5010 	cgroup_unlock();
5011 }
5012 #else	/* CONFIG_EXT_GROUP_SCHED || CONFIG_EXT_SUB_SCHED */
root_cgroup(void)5013 static inline struct cgroup *root_cgroup(void) { return NULL; }
scx_cgroup_lock(void)5014 static inline void scx_cgroup_lock(void) {}
scx_cgroup_unlock(void)5015 static inline void scx_cgroup_unlock(void) {}
5016 #endif	/* CONFIG_EXT_GROUP_SCHED || CONFIG_EXT_SUB_SCHED */
5017 
5018 /*
5019  * Omitted operations:
5020  *
5021  * - migrate_task_rq: Unnecessary as task to cpu mapping is transient.
5022  *
5023  * - task_fork/dead: We need fork/dead notifications for all tasks regardless of
5024  *   their current sched_class. Call them directly from sched core instead.
5025  */
5026 DEFINE_SCHED_CLASS(ext) = {
5027 	.enqueue_task		= enqueue_task_scx,
5028 	.dequeue_task		= dequeue_task_scx,
5029 	.yield_task		= yield_task_scx,
5030 	.yield_to_task		= yield_to_task_scx,
5031 
5032 	.wakeup_preempt		= wakeup_preempt_scx,
5033 
5034 	.pick_task		= pick_task_scx,
5035 
5036 	.put_prev_task		= put_prev_task_scx,
5037 	.set_next_task		= set_next_task_scx,
5038 
5039 	.select_task_rq		= select_task_rq_scx,
5040 	.task_woken		= task_woken_scx,
5041 	.set_cpus_allowed	= set_cpus_allowed_scx,
5042 
5043 	.rq_online		= rq_online_scx,
5044 	.rq_offline		= rq_offline_scx,
5045 
5046 	.task_tick		= task_tick_scx,
5047 
5048 	.switching_to		= switching_to_scx,
5049 	.switched_from		= switched_from_scx,
5050 	.switched_to		= switched_to_scx,
5051 	.reweight_task		= reweight_task_scx,
5052 	.prio_changed		= prio_changed_scx,
5053 
5054 	.update_curr		= update_curr_scx,
5055 
5056 #ifdef CONFIG_UCLAMP_TASK
5057 	.uclamp_enabled		= 1,
5058 #endif
5059 };
5060 
scx_init_dsq(struct scx_dispatch_q * dsq,u64 dsq_id,struct scx_sched * sch)5061 s32 scx_init_dsq(struct scx_dispatch_q *dsq, u64 dsq_id, struct scx_sched *sch)
5062 {
5063 	s32 cpu;
5064 
5065 	memset(dsq, 0, sizeof(*dsq));
5066 
5067 	raw_spin_lock_init(&dsq->lock);
5068 	INIT_LIST_HEAD(&dsq->list);
5069 	dsq->id = dsq_id;
5070 	dsq->sched = sch;
5071 
5072 	dsq->pcpu = alloc_percpu(struct scx_dsq_pcpu);
5073 	if (!dsq->pcpu)
5074 		return -ENOMEM;
5075 
5076 	for_each_possible_cpu(cpu) {
5077 		struct scx_dsq_pcpu *pcpu = per_cpu_ptr(dsq->pcpu, cpu);
5078 
5079 		pcpu->dsq = dsq;
5080 		INIT_LIST_HEAD(&pcpu->deferred_reenq_user.node);
5081 	}
5082 
5083 	return 0;
5084 }
5085 
exit_dsq(struct scx_dispatch_q * dsq)5086 static void exit_dsq(struct scx_dispatch_q *dsq)
5087 {
5088 	s32 cpu;
5089 
5090 	for_each_possible_cpu(cpu) {
5091 		struct scx_dsq_pcpu *pcpu = per_cpu_ptr(dsq->pcpu, cpu);
5092 		struct scx_deferred_reenq_user *dru = &pcpu->deferred_reenq_user;
5093 		struct rq *rq = cpu_rq(cpu);
5094 
5095 		/*
5096 		 * There must have been a RCU grace period since the last
5097 		 * insertion and @dsq should be off the deferred list by now.
5098 		 */
5099 		if (WARN_ON_ONCE(!list_empty(&dru->node))) {
5100 			guard(raw_spinlock_irqsave)(&rq->scx.deferred_reenq_lock);
5101 			list_del_init(&dru->node);
5102 		}
5103 	}
5104 
5105 	free_percpu(dsq->pcpu);
5106 }
5107 
free_dsq_rcufn(struct rcu_head * rcu)5108 static void free_dsq_rcufn(struct rcu_head *rcu)
5109 {
5110 	struct scx_dispatch_q *dsq = container_of(rcu, struct scx_dispatch_q, rcu);
5111 
5112 	exit_dsq(dsq);
5113 	kfree(dsq);
5114 }
5115 
free_dsq_irq_workfn(struct irq_work * irq_work)5116 static void free_dsq_irq_workfn(struct irq_work *irq_work)
5117 {
5118 	struct llist_node *to_free = llist_del_all(&dsqs_to_free);
5119 	struct scx_dispatch_q *dsq, *tmp_dsq;
5120 
5121 	llist_for_each_entry_safe(dsq, tmp_dsq, to_free, free_node)
5122 		call_rcu(&dsq->rcu, free_dsq_rcufn);
5123 }
5124 
5125 static DEFINE_IRQ_WORK(free_dsq_irq_work, free_dsq_irq_workfn);
5126 
destroy_dsq(struct scx_sched * sch,u64 dsq_id)5127 static void destroy_dsq(struct scx_sched *sch, u64 dsq_id)
5128 {
5129 	struct scx_dispatch_q *dsq;
5130 	unsigned long flags;
5131 
5132 	rcu_read_lock();
5133 
5134 	dsq = find_user_dsq(sch, dsq_id);
5135 	if (!dsq)
5136 		goto out_unlock_rcu;
5137 
5138 	raw_spin_lock_irqsave(&dsq->lock, flags);
5139 
5140 	if (dsq->nr) {
5141 		scx_error(sch, "attempting to destroy in-use dsq 0x%016llx (nr=%u)",
5142 			  dsq->id, dsq->nr);
5143 		goto out_unlock_dsq;
5144 	}
5145 
5146 	if (rhashtable_remove_fast(&sch->dsq_hash, &dsq->hash_node,
5147 				   dsq_hash_params))
5148 		goto out_unlock_dsq;
5149 
5150 	/*
5151 	 * Mark dead by invalidating ->id to prevent scx_dispatch_enqueue() from
5152 	 * queueing more tasks. As this function can be called from anywhere,
5153 	 * freeing is bounced through an irq work to avoid nesting RCU
5154 	 * operations inside scheduler locks.
5155 	 */
5156 	dsq->id = SCX_DSQ_INVALID;
5157 	if (llist_add(&dsq->free_node, &dsqs_to_free))
5158 		irq_work_queue(&free_dsq_irq_work);
5159 
5160 out_unlock_dsq:
5161 	raw_spin_unlock_irqrestore(&dsq->lock, flags);
5162 out_unlock_rcu:
5163 	rcu_read_unlock();
5164 }
5165 
5166 #ifdef CONFIG_EXT_GROUP_SCHED
scx_cgroup_exit(struct scx_sched * sch)5167 static void scx_cgroup_exit(struct scx_sched *sch)
5168 {
5169 	struct cgroup_subsys_state *css;
5170 
5171 	/*
5172 	 * scx_tg_on/offline() are excluded through cgroup_lock(). If we walk
5173 	 * cgroups and exit all the inited ones, all online cgroups are exited.
5174 	 */
5175 	css_for_each_descendant_post(css, &root_task_group.css) {
5176 		struct task_group *tg = css_tg(css);
5177 
5178 		/* also clear the sched of tgs whose ops.cgroup_init() failed */
5179 		tg->scx.sched = NULL;
5180 		if (tg->scx.flags & SCX_TG_INITED) {
5181 			tg->scx.flags &= ~SCX_TG_INITED;
5182 			if (sch->ops.cgroup_exit)
5183 				SCX_CALL_OP(sch, cgroup_exit, NULL, css->cgroup);
5184 		}
5185 	}
5186 }
5187 
scx_cgroup_init(struct scx_sched * sch)5188 static int scx_cgroup_init(struct scx_sched *sch)
5189 {
5190 	struct cgroup_subsys_state *css;
5191 	int ret;
5192 
5193 	/*
5194 	 * scx_tg_on/offline() are excluded through cgroup_lock(). If we walk
5195 	 * cgroups and init, all online cgroups are initialized.
5196 	 */
5197 	css_for_each_descendant_pre(css, &root_task_group.css) {
5198 		struct task_group *tg = css_tg(css);
5199 
5200 		if ((tg->scx.flags & (SCX_TG_ONLINE | SCX_TG_INITED)) != SCX_TG_ONLINE)
5201 			continue;
5202 
5203 		if (sch->ops.cgroup_init) {
5204 			struct scx_cgroup_init_args args = {
5205 				.weight = tg->scx.weight,
5206 				.bw_period_us = tg->scx.bw_period_us,
5207 				.bw_quota_us = tg->scx.bw_quota_us,
5208 				.bw_burst_us = tg->scx.bw_burst_us,
5209 				.sched_idle = tg->scx.idle,
5210 			};
5211 
5212 			ret = SCX_CALL_OP_RET(sch, cgroup_init, NULL, css->cgroup, &args);
5213 			if (ret) {
5214 				scx_error(sch, "ops.cgroup_init() failed (%d)", ret);
5215 				return ret;
5216 			}
5217 		}
5218 
5219 		tg->scx.sched = sch;
5220 		tg->scx.flags |= SCX_TG_INITED;
5221 	}
5222 
5223 	return 0;
5224 }
5225 
5226 #else
scx_cgroup_exit(struct scx_sched * sch)5227 static void scx_cgroup_exit(struct scx_sched *sch) {}
scx_cgroup_init(struct scx_sched * sch)5228 static int scx_cgroup_init(struct scx_sched *sch) { return 0; }
5229 #endif
5230 
5231 
5232 /********************************************************************************
5233  * Sysfs interface and ops enable/disable.
5234  */
5235 
5236 #define SCX_ATTR(_name)								\
5237 	static struct kobj_attribute scx_attr_##_name = {			\
5238 		.attr = { .name = __stringify(_name), .mode = 0444 },		\
5239 		.show = scx_attr_##_name##_show,				\
5240 	}
5241 
scx_attr_state_show(struct kobject * kobj,struct kobj_attribute * ka,char * buf)5242 static ssize_t scx_attr_state_show(struct kobject *kobj,
5243 				   struct kobj_attribute *ka, char *buf)
5244 {
5245 	return sysfs_emit(buf, "%s\n", scx_enable_state_str[scx_enable_state()]);
5246 }
5247 SCX_ATTR(state);
5248 
scx_attr_switch_all_show(struct kobject * kobj,struct kobj_attribute * ka,char * buf)5249 static ssize_t scx_attr_switch_all_show(struct kobject *kobj,
5250 					struct kobj_attribute *ka, char *buf)
5251 {
5252 	return sysfs_emit(buf, "%d\n", READ_ONCE(scx_switching_all));
5253 }
5254 SCX_ATTR(switch_all);
5255 
scx_attr_nr_rejected_show(struct kobject * kobj,struct kobj_attribute * ka,char * buf)5256 static ssize_t scx_attr_nr_rejected_show(struct kobject *kobj,
5257 					 struct kobj_attribute *ka, char *buf)
5258 {
5259 	return sysfs_emit(buf, "%ld\n", atomic_long_read(&scx_nr_rejected));
5260 }
5261 SCX_ATTR(nr_rejected);
5262 
scx_attr_hotplug_seq_show(struct kobject * kobj,struct kobj_attribute * ka,char * buf)5263 static ssize_t scx_attr_hotplug_seq_show(struct kobject *kobj,
5264 					 struct kobj_attribute *ka, char *buf)
5265 {
5266 	return sysfs_emit(buf, "%ld\n", atomic_long_read(&scx_hotplug_seq));
5267 }
5268 SCX_ATTR(hotplug_seq);
5269 
scx_attr_enable_seq_show(struct kobject * kobj,struct kobj_attribute * ka,char * buf)5270 static ssize_t scx_attr_enable_seq_show(struct kobject *kobj,
5271 					struct kobj_attribute *ka, char *buf)
5272 {
5273 	return sysfs_emit(buf, "%ld\n", atomic_long_read(&scx_enable_seq));
5274 }
5275 SCX_ATTR(enable_seq);
5276 
5277 static struct attribute *scx_global_attrs[] = {
5278 	&scx_attr_state.attr,
5279 	&scx_attr_switch_all.attr,
5280 	&scx_attr_nr_rejected.attr,
5281 	&scx_attr_hotplug_seq.attr,
5282 	&scx_attr_enable_seq.attr,
5283 	NULL,
5284 };
5285 
5286 static const struct attribute_group scx_global_attr_group = {
5287 	.attrs = scx_global_attrs,
5288 };
5289 
5290 static void free_pnode(struct scx_sched_pnode *pnode);
5291 static void free_exit_info(struct scx_exit_info *ei);
5292 static const char *scx_exit_reason(enum scx_exit_kind kind);
5293 static bool scx_claim_exit(struct scx_sched *sch, enum scx_exit_kind kind);
5294 
scx_alloc_kern_arena_objs(struct scx_sched * sch)5295 s32 scx_alloc_kern_arena_objs(struct scx_sched *sch)
5296 {
5297 	size_t size = struct_size_t(struct scx_cmask, bits,
5298 				    SCX_CMASK_NR_WORDS(num_possible_cpus()));
5299 	struct scx_cmask *online;
5300 	struct scx_cmask_ref ref;
5301 	int cpu;
5302 
5303 	/* hotplug stays excluded until the online mask is published */
5304 	lockdep_assert_cpus_held();
5305 
5306 	if (!sch->is_cid_type || !sch->arena_pool)
5307 		return 0;
5308 
5309 	sch->set_cmask_scratch = alloc_percpu(struct scx_cmask *);
5310 	if (!sch->set_cmask_scratch)
5311 		return -ENOMEM;
5312 
5313 	for_each_possible_cpu(cpu) {
5314 		struct scx_cmask **slot = per_cpu_ptr(sch->set_cmask_scratch, cpu);
5315 
5316 		*slot = scx_arena_alloc(sch, size);
5317 		if (!*slot)
5318 			return -ENOMEM;
5319 		scx_cmask_init(*slot, 0, num_possible_cpus());
5320 	}
5321 
5322 	/* pack the online mask alongside the scratch masks */
5323 	online = scx_arena_alloc(sch, size);
5324 	if (!online)
5325 		return -ENOMEM;
5326 
5327 	scoped_guard(rcu) {
5328 		scx_cmask_ref_init_kern(sch, online, 0, num_possible_cpus(), &ref);
5329 		scx_cmask_ref_from_cpumask(&ref, cpu_active_mask);
5330 	}
5331 	sch->online_cmask = online;
5332 
5333 	return 0;
5334 }
5335 
scx_free_kern_arena_objs(struct scx_sched * sch)5336 static void scx_free_kern_arena_objs(struct scx_sched *sch)
5337 {
5338 	size_t size = struct_size_t(struct scx_cmask, bits,
5339 				    SCX_CMASK_NR_WORDS(num_possible_cpus()));
5340 	int cpu;
5341 
5342 	scx_arena_free(sch, sch->online_cmask, size);
5343 	if (!sch->set_cmask_scratch)
5344 		return;
5345 
5346 	for_each_possible_cpu(cpu) {
5347 		struct scx_cmask **slot = per_cpu_ptr(sch->set_cmask_scratch, cpu);
5348 
5349 		scx_arena_free(sch, *slot, size);
5350 	}
5351 	free_percpu(sch->set_cmask_scratch);
5352 	sch->set_cmask_scratch = NULL;
5353 }
5354 
scx_sched_free_rcu_work(struct work_struct * work)5355 static void scx_sched_free_rcu_work(struct work_struct *work)
5356 {
5357 	struct rcu_work *rcu_work = to_rcu_work(work);
5358 	struct scx_sched *sch = container_of(rcu_work, struct scx_sched, rcu_work);
5359 	struct rhashtable_iter rht_iter;
5360 	struct scx_dispatch_q *dsq;
5361 	int cpu, node;
5362 
5363 	irq_work_sync(&sch->propagate_exit_irq_work);
5364 	irq_work_sync(&sch->disable_irq_work);
5365 	kthread_destroy_worker(sch->helper);
5366 	timer_shutdown_sync(&sch->bypass_lb_timer);
5367 	free_cpumask_var(sch->bypass_lb_donee_cpumask);
5368 	free_cpumask_var(sch->bypass_lb_resched_cpumask);
5369 	free_cpumask_var(sch->stall_cpus);
5370 
5371 #ifdef CONFIG_EXT_SUB_SCHED
5372 	kfree(sch->cgrp_path);
5373 	if (sch_cgroup(sch))
5374 		cgroup_put(sch_cgroup(sch));
5375 	if (sch->sub_kset)
5376 		kobject_put(&sch->sub_kset->kobj);
5377 	if (scx_parent(sch))
5378 		kobject_put(&scx_parent(sch)->kobj);
5379 #endif	/* CONFIG_EXT_SUB_SCHED */
5380 
5381 	for_each_possible_cpu(cpu) {
5382 		struct scx_sched_pcpu *pcpu = per_cpu_ptr(sch->pcpu, cpu);
5383 
5384 		/*
5385 		 * $sch would have entered bypass mode before the RCU grace
5386 		 * period. As that blocks new deferrals, all
5387 		 * deferred_reenq_local_node's must be off-list by now.
5388 		 */
5389 		WARN_ON_ONCE(!list_empty(&pcpu->deferred_reenq_local.node));
5390 
5391 		/* remove the queued ecaps sync so the pcpu can be freed */
5392 		scx_discard_ecaps_to_sync(cpu, pcpu);
5393 
5394 		/*
5395 		 * Bypass blocks new kicks. Flush the kick irq_work so this
5396 		 * pcpu's to_kick_node is off the list before it is freed.
5397 		 */
5398 		irq_work_sync(&cpu_rq(cpu)->scx.kick_cpus_irq_work);
5399 		WARN_ON_ONCE(!list_empty(&pcpu->to_kick_node));
5400 		free_cpumask_var(pcpu->cpus_to_kick);
5401 		free_cpumask_var(pcpu->cpus_to_kick_if_idle);
5402 		free_cpumask_var(pcpu->cpus_to_preempt);
5403 		free_cpumask_var(pcpu->cpus_to_wait);
5404 
5405 		exit_dsq(scx_bypass_dsq(sch, cpu));
5406 	}
5407 
5408 	free_percpu(sch->pcpu);
5409 
5410 	for_each_node_state(node, N_POSSIBLE)
5411 		free_pnode(sch->pnode[node]);
5412 	kfree(sch->pnode);
5413 
5414 	scx_free_pshards(sch);
5415 
5416 	rhashtable_walk_enter(&sch->dsq_hash, &rht_iter);
5417 	do {
5418 		rhashtable_walk_start(&rht_iter);
5419 
5420 		while (!IS_ERR_OR_NULL((dsq = rhashtable_walk_next(&rht_iter))))
5421 			destroy_dsq(sch, dsq->id);
5422 
5423 		rhashtable_walk_stop(&rht_iter);
5424 	} while (dsq == ERR_PTR(-EAGAIN));
5425 	rhashtable_walk_exit(&rht_iter);
5426 
5427 	rhashtable_free_and_destroy(&sch->dsq_hash, NULL, NULL);
5428 	free_exit_info(sch->exit_info);
5429 	scx_free_kern_arena_objs(sch);
5430 	scx_arena_pool_destroy(sch);
5431 	if (sch->arena_map)
5432 		bpf_map_put(sch->arena_map);
5433 
5434 	/* @sch is completely inactive by now */
5435 	scx_dec_has_subs(sch);
5436 
5437 	kfree(sch);
5438 }
5439 
scx_kobj_release(struct kobject * kobj)5440 static void scx_kobj_release(struct kobject *kobj)
5441 {
5442 	struct scx_sched *sch = container_of(kobj, struct scx_sched, kobj);
5443 
5444 	INIT_RCU_WORK(&sch->rcu_work, scx_sched_free_rcu_work);
5445 	queue_rcu_work(system_dfl_wq, &sch->rcu_work);
5446 }
5447 
scx_attr_ops_show(struct kobject * kobj,struct kobj_attribute * ka,char * buf)5448 static ssize_t scx_attr_ops_show(struct kobject *kobj,
5449 				 struct kobj_attribute *ka, char *buf)
5450 {
5451 	struct scx_sched *sch = container_of(kobj, struct scx_sched, kobj);
5452 
5453 	return sysfs_emit(buf, "%s\n", sch->ops.name);
5454 }
5455 SCX_ATTR(ops);
5456 
5457 #define scx_attr_event_show(buf, at, events, kind) ({				\
5458 	sysfs_emit_at(buf, at, "%s %llu\n", #kind, (events)->kind);		\
5459 })
5460 
scx_attr_events_show(struct kobject * kobj,struct kobj_attribute * ka,char * buf)5461 static ssize_t scx_attr_events_show(struct kobject *kobj,
5462 				    struct kobj_attribute *ka, char *buf)
5463 {
5464 	struct scx_sched *sch = container_of(kobj, struct scx_sched, kobj);
5465 	struct scx_event_stats events;
5466 	int at = 0;
5467 
5468 	scx_read_events(sch, &events);
5469 #define SCX_EVENT(name)	(at += scx_attr_event_show(buf, at, &events, name))
5470 	SCX_EVENTS_LIST(SCX_EVENT);
5471 #undef SCX_EVENT
5472 	return at;
5473 }
5474 SCX_ATTR(events);
5475 
5476 #ifdef CONFIG_EXT_SUB_SCHED
5477 static const char *scx_cap_names[__SCX_NR_CAPS] = {
5478 	[__SCX_CAP_ENQ_IMMED]	= "enq_immed",
5479 	[__SCX_CAP_ENQ]		= "enq",
5480 	[__SCX_CAP_PREEMPT]	= "preempt",
5481 	[__SCX_CAP_PERF]	= "perf",
5482 };
5483 
scx_attr_caps_show(struct kobject * kobj,struct kobj_attribute * ka,char * buf)5484 static ssize_t scx_attr_caps_show(struct kobject *kobj,
5485 				  struct kobj_attribute *ka, char *buf)
5486 {
5487 	struct scx_sched *sch = container_of(kobj, struct scx_sched, kobj);
5488 	u32 npossible = num_possible_cpus();
5489 	struct scx_cmask *agg __free(kfree) =
5490 		kzalloc_flex(*agg, bits, SCX_CMASK_NR_WORDS(npossible));
5491 	unsigned long *agg_bm __free(bitmap) = bitmap_zalloc(npossible, GFP_KERNEL);
5492 	ssize_t count = 0;
5493 	s32 cap, si;
5494 
5495 	if (!agg || !agg_bm)
5496 		return -ENOMEM;
5497 
5498 	for (cap = 0; cap < __SCX_NR_CAPS; cap++) {
5499 		SCX_CMASK_DEFINE(snap, 0, SCX_CID_SHARD_MAX_CPUS);
5500 
5501 		scx_cmask_init(agg, 0, npossible);
5502 		for (si = 0; si < sch->nr_pshards; si++) {
5503 			struct scx_cmask *cm = &sch->pshard[si]->caps[cap].cmask;
5504 
5505 			scx_cmask_reframe(snap, cm->base, cm->nr_cids);
5506 			scx_cmask_copy(snap, cm);
5507 			scx_cmask_or(agg, snap);
5508 		}
5509 		/* %*pbl takes unsigned long bitmap layout, convert from u64 */
5510 		bitmap_from_arr64(agg_bm, agg->bits, npossible);
5511 		count += sysfs_emit_at(buf, count, "%s: %*pbl\n",
5512 				       scx_cap_names[cap], npossible, agg_bm);
5513 	}
5514 	return count;
5515 }
5516 SCX_ATTR(caps);
5517 #endif	/* CONFIG_EXT_SUB_SCHED */
5518 
5519 static struct attribute *scx_sched_attrs[] = {
5520 	&scx_attr_ops.attr,
5521 	&scx_attr_events.attr,
5522 #ifdef CONFIG_EXT_SUB_SCHED
5523 	&scx_attr_caps.attr,
5524 #endif
5525 	NULL,
5526 };
5527 ATTRIBUTE_GROUPS(scx_sched);
5528 
5529 static const struct kobj_type scx_ktype = {
5530 	.release = scx_kobj_release,
5531 	.sysfs_ops = &kobj_sysfs_ops,
5532 	.default_groups = scx_sched_groups,
5533 };
5534 
scx_uevent(const struct kobject * kobj,struct kobj_uevent_env * env)5535 static int scx_uevent(const struct kobject *kobj, struct kobj_uevent_env *env)
5536 {
5537 	const struct scx_sched *sch;
5538 
5539 	/*
5540 	 * scx_uevent() can be reached by both scx_sched kobjects (scx_ktype)
5541 	 * and sub-scheduler kset kobjects (kset_ktype) through the parent
5542 	 * chain walk. Filter out the latter to avoid invalid casts.
5543 	 */
5544 	if (kobj->ktype != &scx_ktype)
5545 		return 0;
5546 
5547 	sch = container_of(kobj, struct scx_sched, kobj);
5548 
5549 	return add_uevent_var(env, "SCXOPS=%s", sch->ops.name);
5550 }
5551 
5552 static const struct kset_uevent_ops scx_uevent_ops = {
5553 	.uevent = scx_uevent,
5554 };
5555 
5556 /*
5557  * Used by sched_fork() and __setscheduler_class() to pick the matching
5558  * sched_class. dl/rt are already handled.
5559  */
task_should_scx(int policy)5560 bool task_should_scx(int policy)
5561 {
5562 	/* if disabled, nothing should be on it */
5563 	if (!scx_enabled())
5564 		return false;
5565 
5566 	/* scx is taking over all SCHED_OTHER and SCHED_EXT tasks */
5567 	if (READ_ONCE(scx_switching_all))
5568 		return true;
5569 
5570 	/*
5571 	 * scx is tearing down - keep new SCHED_EXT tasks out.
5572 	 *
5573 	 * Must come after scx_switching_all test, which serves as a proxy
5574 	 * for __scx_switched_all. While __scx_switched_all is set, we must
5575 	 * return true via the branch above: a fork routed to fair would
5576 	 * stall because next_active_class() skips fair.
5577 	 *
5578 	 * This can develop into a deadlock - scx holds scx_enable_mutex across
5579 	 * kthread_create() in scx_alloc_and_add_sched(); if the new kthread is
5580 	 * the stalled task, the disable path can never grab the mutex to clear
5581 	 * scx_switching_all.
5582 	 */
5583 	if (unlikely(scx_enable_state() == SCX_DISABLING))
5584 		return false;
5585 
5586 	return policy == SCHED_EXT;
5587 }
5588 
scx_allow_ttwu_queue(const struct task_struct * p)5589 bool scx_allow_ttwu_queue(const struct task_struct *p)
5590 {
5591 	struct scx_sched *sch;
5592 
5593 	if (!scx_enabled())
5594 		return true;
5595 
5596 	sch = scx_task_sched(p);
5597 	if (unlikely(!sch))
5598 		return true;
5599 
5600 	if (sch->ops.flags & SCX_OPS_ALLOW_QUEUED_WAKEUP)
5601 		return true;
5602 
5603 	if (unlikely(p->sched_class != &ext_sched_class))
5604 		return true;
5605 
5606 	return false;
5607 }
5608 
5609 /**
5610  * handle_lockup - sched_ext common lockup handler
5611  * @exit_cpu: CPU to record in exit_info. Pass the stalled/hung CPU, not current.
5612  * @fmt: format string
5613  *
5614  * Called on system stall or lockup condition and initiates abort of sched_ext
5615  * if enabled, which may resolve the reported lockup.
5616  *
5617  * Returns %true if sched_ext is enabled and abort was initiated, which may
5618  * resolve the lockup. %false if sched_ext is not enabled or abort was already
5619  * initiated by someone else.
5620  */
handle_lockup(int exit_cpu,const char * fmt,...)5621 static __printf(2, 3) bool handle_lockup(int exit_cpu, const char *fmt, ...)
5622 {
5623 	struct scx_sched *sch;
5624 	va_list args;
5625 	bool ret;
5626 
5627 	guard(rcu)();
5628 
5629 	sch = rcu_dereference(scx_root);
5630 	if (unlikely(!sch))
5631 		return false;
5632 
5633 	switch (scx_enable_state()) {
5634 	case SCX_ENABLING:
5635 	case SCX_ENABLED:
5636 		va_start(args, fmt);
5637 		ret = scx_vexit(sch, SCX_EXIT_ERROR, 0, exit_cpu, fmt, args);
5638 		va_end(args);
5639 		return ret;
5640 	default:
5641 		return false;
5642 	}
5643 }
5644 
5645 /**
5646  * scx_rcu_cpu_stall - sched_ext RCU CPU stall handler
5647  * @stalled_mask: bit mask of stalled CPUs
5648  *
5649  * While there are various reasons why RCU CPU stalls can occur on a system
5650  * that may not be caused by the current BPF scheduler, try kicking out the
5651  * current scheduler in an attempt to recover the system to a good state before
5652  * issuing panics.
5653  *
5654  * Returns %true if sched_ext is enabled and abort was initiated, which may
5655  * resolve the reported RCU stall. %false if sched_ext is not enabled or someone
5656  * else already initiated abort.
5657  */
scx_rcu_cpu_stall(const struct cpumask * stalled_mask)5658 bool scx_rcu_cpu_stall(const struct cpumask *stalled_mask)
5659 {
5660 	struct scx_sched *sch;
5661 	struct scx_exit_info *ei;
5662 	int exit_cpu;
5663 
5664 	guard(rcu)();
5665 
5666 	sch = rcu_dereference(scx_root);
5667 	if (unlikely(!sch))
5668 		return false;
5669 
5670 	switch (scx_enable_state()) {
5671 	case SCX_ENABLING:
5672 	case SCX_ENABLED:
5673 		break;
5674 	default:
5675 		return false;
5676 	}
5677 
5678 	exit_cpu = cpumask_empty(stalled_mask) ? -1 : (int)cpumask_first(stalled_mask);
5679 	ei = sch->exit_info;
5680 
5681 	guard(preempt)();
5682 
5683 	if (!scx_claim_exit(sch, SCX_EXIT_ERROR))
5684 		return false;
5685 
5686 #ifdef CONFIG_STACKTRACE
5687 	ei->bt_len = stack_trace_save(ei->bt, SCX_EXIT_BT_LEN, 1);
5688 #endif
5689 	scnprintf(ei->msg, SCX_EXIT_MSG_LEN, "RCU CPU stall on CPUs (%*pbl)",
5690 		  cpumask_pr_args(stalled_mask));
5691 	ei->kind = SCX_EXIT_ERROR;
5692 	ei->reason = scx_exit_reason(SCX_EXIT_ERROR);
5693 	ei->exit_cpu = exit_cpu;
5694 	cpumask_copy(sch->stall_cpus, stalled_mask);
5695 
5696 	irq_work_queue(&sch->disable_irq_work);
5697 	return true;
5698 }
5699 
5700 /**
5701  * scx_softlockup - sched_ext softlockup handler
5702  * @dur_s: number of seconds of CPU stuck due to soft lockup
5703  *
5704  * On some multi-socket setups (e.g. 2x Intel 8480c), the BPF scheduler can
5705  * live-lock the system by making many CPUs target the same DSQ to the point
5706  * where soft-lockup detection triggers. This function is called from
5707  * soft-lockup watchdog when the triggering point is close and tries to unjam
5708  * the system and aborting the BPF scheduler.
5709  */
scx_softlockup(u32 dur_s)5710 void scx_softlockup(u32 dur_s)
5711 {
5712 	int cpu = smp_processor_id();
5713 
5714 	if (!handle_lockup(cpu, "soft lockup - CPU %d stuck for %us", cpu, dur_s))
5715 		return;
5716 
5717 	printk_deferred(KERN_ERR "sched_ext: Soft lockup - CPU %d stuck for %us, disabling BPF scheduler\n",
5718 			cpu, dur_s);
5719 }
5720 
5721 /**
5722  * scx_hardlockup - sched_ext hardlockup handler
5723  * @cpu: the target CPU
5724  *
5725  * A poorly behaving BPF scheduler can trigger hard lockup by e.g. putting
5726  * numerous affinitized tasks in a single queue and directing all CPUs at it.
5727  * Try kicking out the current scheduler in an attempt to recover the system to
5728  * a good state before taking more drastic actions.
5729  *
5730  * Called from NMI. Aborting the scheduler sets ->aborting throughout the
5731  * hierarchy before returning, which is what breaks the dispatch-path live-locks
5732  * that can hard-lock CPUs.
5733  *
5734  * Returns %true if sched_ext is enabled and abort was initiated, which may
5735  * resolve the lockup. %false if sched_ext is not enabled or abort was already
5736  * initiated by someone else.
5737  */
scx_hardlockup(int cpu)5738 bool scx_hardlockup(int cpu)
5739 {
5740 	if (!handle_lockup(cpu, "hard lockup - CPU %d", cpu))
5741 		return false;
5742 
5743 	printk_deferred(KERN_ERR "sched_ext: Hard lockup - CPU %d, disabling BPF scheduler\n",
5744 			cpu);
5745 	return true;
5746 }
5747 
bypass_lb_cpu(struct scx_sched * sch,s32 donor,struct cpumask * donee_mask,struct cpumask * resched_mask,u32 nr_donor_target,u32 nr_donee_target)5748 static u32 bypass_lb_cpu(struct scx_sched *sch, s32 donor,
5749 			 struct cpumask *donee_mask, struct cpumask *resched_mask,
5750 			 u32 nr_donor_target, u32 nr_donee_target)
5751 {
5752 	struct rq *donor_rq = cpu_rq(donor);
5753 	struct scx_dispatch_q *donor_dsq = scx_bypass_dsq(sch, donor);
5754 	struct task_struct *p, *n;
5755 	struct scx_dsq_list_node cursor = INIT_DSQ_LIST_CURSOR(cursor, donor_dsq, 0);
5756 	s32 delta = READ_ONCE(donor_dsq->nr) - nr_donor_target;
5757 	u32 nr_balanced = 0, min_delta_us;
5758 
5759 	/*
5760 	 * All we want to guarantee is reasonable forward progress. No reason to
5761 	 * fine tune. Assuming every task on @donor_dsq runs their full slice,
5762 	 * consider offloading iff the total queued duration is over the
5763 	 * threshold.
5764 	 */
5765 	min_delta_us = READ_ONCE(scx_bypass_lb_intv_us) / SCX_BYPASS_LB_MIN_DELTA_DIV;
5766 	if (delta < DIV_ROUND_UP(min_delta_us, READ_ONCE(scx_slice_bypass_us)))
5767 		return 0;
5768 
5769 	raw_spin_rq_lock_irq(donor_rq);
5770 	raw_spin_lock(&donor_dsq->lock);
5771 	list_add(&cursor.node, &donor_dsq->list);
5772 resume:
5773 	n = container_of(&cursor, struct task_struct, scx.dsq_list);
5774 	n = nldsq_next_task(donor_dsq, n, false);
5775 
5776 	while ((p = n)) {
5777 		struct scx_dispatch_q *donee_dsq;
5778 		int donee;
5779 
5780 		n = nldsq_next_task(donor_dsq, n, false);
5781 
5782 		if (donor_dsq->nr <= nr_donor_target)
5783 			break;
5784 
5785 		if (cpumask_empty(donee_mask))
5786 			break;
5787 
5788 		/*
5789 		 * If an earlier pass placed @p on @donor_dsq from a different
5790 		 * CPU and the donee hasn't consumed it yet, @p is still on the
5791 		 * previous CPU and task_rq(@p) != @donor_rq. @p can't be moved
5792 		 * without its rq locked. Skip.
5793 		 */
5794 		if (task_rq(p) != donor_rq)
5795 			continue;
5796 
5797 		donee = cpumask_any_and_distribute(donee_mask, p->cpus_ptr);
5798 		if (donee >= nr_cpu_ids)
5799 			continue;
5800 
5801 		donee_dsq = scx_bypass_dsq(sch, donee);
5802 
5803 		/*
5804 		 * $p's rq is not locked but $p's DSQ lock protects its
5805 		 * scheduling properties making this test safe.
5806 		 */
5807 		if (!task_can_run_on_remote_rq(sch, p, cpu_rq(donee), false))
5808 			continue;
5809 
5810 		/*
5811 		 * Moving $p from one non-local DSQ to another. The source rq
5812 		 * and DSQ are already locked. Do an abbreviated dequeue and
5813 		 * then perform enqueue without unlocking $donor_dsq.
5814 		 *
5815 		 * We don't want to drop and reacquire the lock on each
5816 		 * iteration as @donor_dsq can be very long and potentially
5817 		 * highly contended. Donee DSQs are less likely to be contended.
5818 		 * The nested locking is safe as only this LB moves tasks
5819 		 * between bypass DSQs.
5820 		 */
5821 		dispatch_dequeue_locked(p, donor_dsq);
5822 		scx_dispatch_enqueue(sch, cpu_rq(donee), donee_dsq, p, 0, 0, SCX_ENQ_NESTED);
5823 
5824 		/*
5825 		 * $donee might have been idle and need to be woken up. No need
5826 		 * to be clever. Kick every CPU that receives tasks.
5827 		 */
5828 		cpumask_set_cpu(donee, resched_mask);
5829 
5830 		if (READ_ONCE(donee_dsq->nr) >= nr_donee_target)
5831 			cpumask_clear_cpu(donee, donee_mask);
5832 
5833 		nr_balanced++;
5834 		if (!(nr_balanced % SCX_BYPASS_LB_BATCH) && n) {
5835 			list_move_tail(&cursor.node, &n->scx.dsq_list.node);
5836 			raw_spin_unlock(&donor_dsq->lock);
5837 			scx_rq_lock_drop(donor_rq);
5838 			raw_spin_rq_unlock_irq(donor_rq);
5839 			cpu_relax();
5840 			raw_spin_rq_lock_irq(donor_rq);
5841 			raw_spin_lock(&donor_dsq->lock);
5842 			goto resume;
5843 		}
5844 	}
5845 
5846 	list_del_init(&cursor.node);
5847 	raw_spin_unlock(&donor_dsq->lock);
5848 	scx_rq_lock_drop(donor_rq);
5849 	raw_spin_rq_unlock_irq(donor_rq);
5850 
5851 	return nr_balanced;
5852 }
5853 
bypass_lb_node(struct scx_sched * sch,int node)5854 static void bypass_lb_node(struct scx_sched *sch, int node)
5855 {
5856 	const struct cpumask *node_mask = cpumask_of_node(node);
5857 	struct cpumask *donee_mask = sch->bypass_lb_donee_cpumask;
5858 	struct cpumask *resched_mask = sch->bypass_lb_resched_cpumask;
5859 	u32 nr_tasks = 0, nr_cpus = 0, nr_balanced = 0;
5860 	u32 nr_target, nr_donor_target;
5861 	u32 before_min = U32_MAX, before_max = 0;
5862 	u32 after_min = U32_MAX, after_max = 0;
5863 	int cpu;
5864 
5865 	/* count the target tasks and CPUs */
5866 	for_each_cpu_and(cpu, cpu_online_mask, node_mask) {
5867 		u32 nr = READ_ONCE(scx_bypass_dsq(sch, cpu)->nr);
5868 
5869 		nr_tasks += nr;
5870 		nr_cpus++;
5871 
5872 		before_min = min(nr, before_min);
5873 		before_max = max(nr, before_max);
5874 	}
5875 
5876 	if (!nr_cpus)
5877 		return;
5878 
5879 	/*
5880 	 * We don't want CPUs to have more than $nr_donor_target tasks and
5881 	 * balancing to fill donee CPUs upto $nr_target. Once targets are
5882 	 * calculated, find the donee CPUs.
5883 	 */
5884 	nr_target = DIV_ROUND_UP(nr_tasks, nr_cpus);
5885 	nr_donor_target = DIV_ROUND_UP(nr_target * SCX_BYPASS_LB_DONOR_PCT, 100);
5886 
5887 	cpumask_clear(donee_mask);
5888 	for_each_cpu_and(cpu, cpu_online_mask, node_mask) {
5889 		if (READ_ONCE(scx_bypass_dsq(sch, cpu)->nr) < nr_target)
5890 			cpumask_set_cpu(cpu, donee_mask);
5891 	}
5892 
5893 	/* iterate !donee CPUs and see if they should be offloaded */
5894 	cpumask_clear(resched_mask);
5895 	for_each_cpu_and(cpu, cpu_online_mask, node_mask) {
5896 		if (cpumask_empty(donee_mask))
5897 			break;
5898 		if (cpumask_test_cpu(cpu, donee_mask))
5899 			continue;
5900 		if (READ_ONCE(scx_bypass_dsq(sch, cpu)->nr) <= nr_donor_target)
5901 			continue;
5902 
5903 		nr_balanced += bypass_lb_cpu(sch, cpu, donee_mask, resched_mask,
5904 					     nr_donor_target, nr_target);
5905 	}
5906 
5907 	for_each_cpu(cpu, resched_mask)
5908 		resched_cpu(cpu);
5909 
5910 	for_each_cpu_and(cpu, cpu_online_mask, node_mask) {
5911 		u32 nr = READ_ONCE(scx_bypass_dsq(sch, cpu)->nr);
5912 
5913 		after_min = min(nr, after_min);
5914 		after_max = max(nr, after_max);
5915 
5916 	}
5917 
5918 	trace_sched_ext_bypass_lb(node, nr_cpus, nr_tasks, nr_balanced,
5919 				  before_min, before_max, after_min, after_max);
5920 }
5921 
5922 /*
5923  * In bypass mode, all tasks are put on the per-CPU bypass DSQs. If the machine
5924  * is over-saturated and the BPF scheduler skewed tasks into few CPUs, some
5925  * bypass DSQs can be overloaded. If there are enough tasks to saturate other
5926  * lightly loaded CPUs, such imbalance can lead to very high execution latency
5927  * on the overloaded CPUs and thus to hung tasks and RCU stalls. To avoid such
5928  * outcomes, a simple load balancing mechanism is implemented by the following
5929  * timer which runs periodically while bypass mode is in effect.
5930  */
scx_bypass_lb_timerfn(struct timer_list * timer)5931 static void scx_bypass_lb_timerfn(struct timer_list *timer)
5932 {
5933 	struct scx_sched *sch = container_of(timer, struct scx_sched, bypass_lb_timer);
5934 	int node;
5935 	u32 intv_us;
5936 
5937 	if (!scx_bypass_dsp_enabled(sch))
5938 		return;
5939 
5940 	for_each_node_with_cpus(node)
5941 		bypass_lb_node(sch, node);
5942 
5943 	intv_us = READ_ONCE(scx_bypass_lb_intv_us);
5944 	if (intv_us)
5945 		mod_timer(timer, jiffies + usecs_to_jiffies(intv_us));
5946 }
5947 
inc_bypass_depth(struct scx_sched * sch)5948 static bool inc_bypass_depth(struct scx_sched *sch)
5949 {
5950 	lockdep_assert_held(&scx_bypass_lock);
5951 
5952 	WARN_ON_ONCE(sch->bypass_depth < 0);
5953 	WRITE_ONCE(sch->bypass_depth, sch->bypass_depth + 1);
5954 	if (sch->bypass_depth != 1)
5955 		return false;
5956 
5957 	WRITE_ONCE(sch->slice_dfl, READ_ONCE(scx_slice_bypass_us) * NSEC_PER_USEC);
5958 	sch->bypass_timestamp = ktime_get_ns();
5959 	scx_add_event(sch, SCX_EV_BYPASS_ACTIVATE, 1);
5960 	return true;
5961 }
5962 
dec_bypass_depth(struct scx_sched * sch)5963 static bool dec_bypass_depth(struct scx_sched *sch)
5964 {
5965 	lockdep_assert_held(&scx_bypass_lock);
5966 
5967 	WARN_ON_ONCE(sch->bypass_depth < 1);
5968 	WRITE_ONCE(sch->bypass_depth, sch->bypass_depth - 1);
5969 	if (sch->bypass_depth != 0)
5970 		return false;
5971 
5972 	WRITE_ONCE(sch->slice_dfl, SCX_SLICE_DFL);
5973 	scx_add_event(sch, SCX_EV_BYPASS_DURATION,
5974 		      ktime_get_ns() - sch->bypass_timestamp);
5975 	return true;
5976 }
5977 
enable_bypass_dsp(struct scx_sched * sch)5978 static void enable_bypass_dsp(struct scx_sched *sch)
5979 {
5980 	struct scx_sched *host = scx_parent(sch) ?: sch;
5981 	u32 intv_us = READ_ONCE(scx_bypass_lb_intv_us);
5982 	s32 ret;
5983 
5984 	/*
5985 	 * @sch->bypass_depth transitioning from 0 to 1 triggers enabling.
5986 	 * Shouldn't stagger.
5987 	 */
5988 	if (WARN_ON_ONCE(test_and_set_bit(0, &sch->bypass_dsp_claim)))
5989 		return;
5990 
5991 	/*
5992 	 * When a sub-sched bypasses, its tasks are queued on the bypass DSQs of
5993 	 * the nearest non-bypassing ancestor or root. As enable_bypass_dsp() is
5994 	 * called iff @sch is not already bypassed due to an ancestor bypassing,
5995 	 * we can assume that the parent is not bypassing and thus will be the
5996 	 * host of the bypass DSQs.
5997 	 *
5998 	 * While the situation may change in the future, the following
5999 	 * guarantees that the nearest non-bypassing ancestor or root has bypass
6000 	 * dispatch enabled while a descendant is bypassing, which is all that's
6001 	 * required.
6002 	 *
6003 	 * scx_bypass_dsp_enabled() test is used to determine whether to enter
6004 	 * the bypass dispatch handling path from both bypassing and hosting
6005 	 * scheds. Bump enable depth on both @sch and bypass dispatch host.
6006 	 */
6007 	ret = atomic_inc_return(&sch->bypass_dsp_enable_depth);
6008 	WARN_ON_ONCE(ret <= 0);
6009 
6010 	if (host != sch) {
6011 		ret = atomic_inc_return(&host->bypass_dsp_enable_depth);
6012 		WARN_ON_ONCE(ret <= 0);
6013 	}
6014 
6015 	/*
6016 	 * The LB timer will stop running if bypass dispatch is disabled. Start
6017 	 * after enabling bypass dispatch.
6018 	 */
6019 	if (intv_us && !timer_pending(&host->bypass_lb_timer))
6020 		mod_timer(&host->bypass_lb_timer,
6021 			  jiffies + usecs_to_jiffies(intv_us));
6022 }
6023 
6024 /* may be called without holding scx_bypass_lock */
scx_disable_bypass_dsp(struct scx_sched * sch)6025 void scx_disable_bypass_dsp(struct scx_sched *sch)
6026 {
6027 	s32 ret;
6028 
6029 	if (!test_and_clear_bit(0, &sch->bypass_dsp_claim))
6030 		return;
6031 
6032 	ret = atomic_dec_return(&sch->bypass_dsp_enable_depth);
6033 	WARN_ON_ONCE(ret < 0);
6034 
6035 	if (scx_parent(sch)) {
6036 		ret = atomic_dec_return(&scx_parent(sch)->bypass_dsp_enable_depth);
6037 		WARN_ON_ONCE(ret < 0);
6038 	}
6039 }
6040 
6041 /**
6042  * unbypass_renotify_idle - Arm an idle re-notify for a sched leaving bypass
6043  * @rq: rq of the cpu leaving bypass
6044  * @pos: scheduler that just left bypass on @rq's cpu
6045  * @pcpu: @pos's per-cpu state for @rq's cpu
6046  *
6047  * A sched leaving bypass is owed the ops.update_idle() calls suppressed while
6048  * bypassing. A cpu that goes idle during the bypass window and stays idle won't
6049  * produce a notification. Arm a re-notify that scx_bypass()'s resched flushes
6050  * on the next idle pick.
6051  *
6052  * An acute case is ops.sub_attach(). If the parent grants the child cids while
6053  * attaching, when attach is complete and bypass is lifted, the child may hold
6054  * idle cids it never saw go idle.
6055  *
6056  * The root is no exception as bypass suppresses its notifications the same way.
6057  * However, the root uses a separate per-rq flag so its re-notify keeps working
6058  * even when !CONFIG_EXT_SUB_SCHED.
6059  */
unbypass_renotify_idle(struct rq * rq,struct scx_sched * pos,struct scx_sched_pcpu * pcpu)6060 static void unbypass_renotify_idle(struct rq *rq, struct scx_sched *pos,
6061 				   struct scx_sched_pcpu *pcpu)
6062 {
6063 	if (!pos->level) {
6064 		rq->scx.flags |= SCX_RQ_ROOT_IDLE_RENOTIFY;
6065 		return;
6066 	}
6067 #ifdef CONFIG_EXT_SUB_SCHED
6068 	pcpu->idle_renotify = true;
6069 	rq->scx.flags |= SCX_RQ_SUB_IDLE_RENOTIFY;
6070 #endif
6071 }
6072 
6073 /**
6074  * scx_bypass - [Un]bypass scx_ops and guarantee forward progress
6075  * @sch: sched to bypass
6076  * @bypass: true for bypass, false for unbypass
6077  *
6078  * Bypassing guarantees that all runnable tasks make forward progress without
6079  * trusting the BPF scheduler. We can't grab any mutexes or rwsems as they might
6080  * be held by tasks that the BPF scheduler is forgetting to run, which
6081  * unfortunately also excludes toggling the static branches.
6082  *
6083  * Let's work around by overriding a couple ops and modifying behaviors based on
6084  * the DISABLING state and then cycling the queued tasks through dequeue/enqueue
6085  * to force global FIFO scheduling.
6086  *
6087  * - ops.select_cpu() is ignored and the default select_cpu() is used.
6088  *
6089  * - ops.enqueue() is ignored and tasks are queued in simple global FIFO order.
6090  *   %SCX_OPS_ENQ_LAST is also ignored.
6091  *
6092  * - ops.dispatch() is ignored.
6093  *
6094  * - dispatch_one() does not report %SCX_DSP_PREV on non-zero slice as slice
6095  *   can't be trusted. Whenever a tick triggers, the running task is rotated to
6096  *   the tail of the queue.
6097  *
6098  * - pick_next_task() suppresses zero slice warning.
6099  *
6100  * - scx_kick_cpu() is disabled to avoid irq_work malfunction during PM
6101  *   operations.
6102  *
6103  * - scx_prio_less() reverts to the default runnable_at order.
6104  */
scx_bypass(struct scx_sched * sch,bool bypass)6105 void scx_bypass(struct scx_sched *sch, bool bypass)
6106 {
6107 	struct scx_sched *pos;
6108 	unsigned long flags;
6109 	int cpu;
6110 
6111 	raw_spin_lock_irqsave(&scx_bypass_lock, flags);
6112 
6113 	if (bypass) {
6114 		if (!inc_bypass_depth(sch))
6115 			goto unlock;
6116 
6117 		enable_bypass_dsp(sch);
6118 	} else {
6119 		if (!dec_bypass_depth(sch))
6120 			goto unlock;
6121 	}
6122 
6123 	/*
6124 	 * Bypass state is propagated to all descendants - an scx_sched bypasses
6125 	 * if itself or any of its ancestors are in bypass mode.
6126 	 */
6127 	raw_spin_lock(&scx_sched_lock);
6128 	scx_for_each_descendant_pre(pos, sch) {
6129 		if (pos == sch)
6130 			continue;
6131 		if (bypass)
6132 			inc_bypass_depth(pos);
6133 		else
6134 			dec_bypass_depth(pos);
6135 	}
6136 	raw_spin_unlock(&scx_sched_lock);
6137 
6138 	/*
6139 	 * No task property is changing. We just need to make sure all currently
6140 	 * queued tasks are re-queued according to the new scx_bypassing()
6141 	 * state. As an optimization, walk each rq's runnable_list instead of
6142 	 * the scx_tasks list.
6143 	 *
6144 	 * This function can't trust the scheduler and thus can't use
6145 	 * cpus_read_lock(). Walk all possible CPUs instead of online.
6146 	 */
6147 	for_each_possible_cpu(cpu) {
6148 		struct rq *rq = cpu_rq(cpu);
6149 		struct task_struct *p, *n;
6150 
6151 		raw_spin_rq_lock(rq);
6152 		raw_spin_lock(&scx_sched_lock);
6153 
6154 		scx_for_each_descendant_pre(pos, sch) {
6155 			struct scx_sched_pcpu *pcpu = per_cpu_ptr(pos->pcpu, cpu);
6156 			bool was_bypassing = pcpu->flags & SCX_SCHED_PCPU_BYPASSING;
6157 
6158 			if (pos->bypass_depth) {
6159 				pcpu->flags |= SCX_SCHED_PCPU_BYPASSING;
6160 			} else {
6161 				pcpu->flags &= ~SCX_SCHED_PCPU_BYPASSING;
6162 				if (was_bypassing) {
6163 					unbypass_renotify_idle(rq, pos, pcpu);
6164 					scx_unbypass_replay_ecaps(rq, pos);
6165 				}
6166 			}
6167 		}
6168 
6169 		raw_spin_unlock(&scx_sched_lock);
6170 
6171 		/*
6172 		 * We need to guarantee that no tasks are on the BPF scheduler
6173 		 * while bypassing. Either we see enabled or the enable path
6174 		 * sees scx_bypassing() before moving tasks to SCX.
6175 		 */
6176 		if (!scx_enabled()) {
6177 			scx_rq_lock_drop(rq);
6178 			raw_spin_rq_unlock(rq);
6179 			continue;
6180 		}
6181 
6182 		/*
6183 		 * The use of list_for_each_entry_safe_reverse() is required
6184 		 * because each task is going to be removed from and added back
6185 		 * to the runnable_list during iteration. Because they're added
6186 		 * to the tail of the list, safe reverse iteration can still
6187 		 * visit all nodes.
6188 		 */
6189 		list_for_each_entry_safe_reverse(p, n, &rq->scx.runnable_list,
6190 						 scx.runnable_node) {
6191 			if (!scx_is_descendant(scx_task_sched(p), sch))
6192 				continue;
6193 
6194 			/*
6195 			 * Bypass trumps protection. Cycling clears for queued
6196 			 * tasks but current task needs explicit stripping.
6197 			 */
6198 			if (bypass && task_current(rq, p))
6199 				scx_task_slice_ended(rq, p);
6200 
6201 			/* cycling deq/enq is enough, see the function comment */
6202 			scoped_guard (sched_change, p, DEQUEUE_SAVE | DEQUEUE_MOVE) {
6203 				/* nothing */ ;
6204 			}
6205 		}
6206 
6207 		/* resched to restore ticks and idle state */
6208 		if (cpu_online(cpu) || cpu == smp_processor_id())
6209 			resched_curr(rq);
6210 
6211 		scx_rq_lock_drop(rq);
6212 		raw_spin_rq_unlock(rq);
6213 	}
6214 
6215 	/* disarming must come after moving all tasks out of the bypass DSQs */
6216 	if (!bypass)
6217 		scx_disable_bypass_dsp(sch);
6218 unlock:
6219 	raw_spin_unlock_irqrestore(&scx_bypass_lock, flags);
6220 }
6221 
free_exit_info(struct scx_exit_info * ei)6222 static void free_exit_info(struct scx_exit_info *ei)
6223 {
6224 	kvfree(ei->dump);
6225 	kfree(ei->msg);
6226 	kfree(ei->bt);
6227 	kfree(ei);
6228 }
6229 
alloc_exit_info(size_t exit_dump_len)6230 static struct scx_exit_info *alloc_exit_info(size_t exit_dump_len)
6231 {
6232 	struct scx_exit_info *ei;
6233 
6234 	ei = kzalloc_obj(*ei);
6235 	if (!ei)
6236 		return NULL;
6237 
6238 	ei->exit_cpu = -1;
6239 	ei->bt = kzalloc_objs(ei->bt[0], SCX_EXIT_BT_LEN);
6240 	ei->msg = kzalloc(SCX_EXIT_MSG_LEN, GFP_KERNEL);
6241 	ei->dump = kvzalloc(exit_dump_len, GFP_KERNEL);
6242 
6243 	if (!ei->bt || !ei->msg || !ei->dump) {
6244 		free_exit_info(ei);
6245 		return NULL;
6246 	}
6247 
6248 	return ei;
6249 }
6250 
scx_exit_reason(enum scx_exit_kind kind)6251 static const char *scx_exit_reason(enum scx_exit_kind kind)
6252 {
6253 	switch (kind) {
6254 	case SCX_EXIT_UNREG:
6255 		return "unregistered from user space";
6256 	case SCX_EXIT_UNREG_BPF:
6257 		return "unregistered from BPF";
6258 	case SCX_EXIT_UNREG_KERN:
6259 		return "unregistered from the main kernel";
6260 	case SCX_EXIT_SYSRQ:
6261 		return "disabled by sysrq-S";
6262 	case SCX_EXIT_PARENT:
6263 		return "parent exiting";
6264 	case SCX_EXIT_PARENT_KILL:
6265 		return "killed by parent scheduler";
6266 	case SCX_EXIT_ERROR:
6267 		return "runtime error";
6268 	case SCX_EXIT_ERROR_BPF:
6269 		return "scx_bpf_error";
6270 	case SCX_EXIT_ERROR_STALL:
6271 		return "runnable task stall";
6272 	case SCX_EXIT_ERROR_REENQ:
6273 		return "reenqueue limit";
6274 	case SCX_EXIT_ERROR_RESCUE:
6275 		return "rescue bandwidth overload";
6276 	default:
6277 		return "<UNKNOWN>";
6278 	}
6279 }
6280 
free_kick_syncs(void)6281 static void free_kick_syncs(void)
6282 {
6283 	int cpu;
6284 
6285 	for_each_possible_cpu(cpu) {
6286 		struct scx_kick_syncs __rcu **ksyncs = per_cpu_ptr(&scx_kick_syncs, cpu);
6287 		struct scx_kick_syncs *to_free;
6288 
6289 		/* flush the pending kick before freeing @ksyncs */
6290 		irq_work_sync(&cpu_rq(cpu)->scx.kick_cpus_irq_work);
6291 		to_free = rcu_replace_pointer(*ksyncs, NULL, true);
6292 		if (to_free)
6293 			kvfree_rcu(to_free, rcu);
6294 	}
6295 }
6296 
refresh_watchdog(void)6297 static void refresh_watchdog(void)
6298 {
6299 	struct scx_sched *sch;
6300 	unsigned long intv = ULONG_MAX;
6301 
6302 	/* take the shortest timeout and use its half for watchdog interval */
6303 	rcu_read_lock();
6304 	list_for_each_entry_rcu(sch, &scx_sched_all, all)
6305 		intv = max(min(intv, sch->watchdog_timeout / 2), 1);
6306 	rcu_read_unlock();
6307 
6308 	WRITE_ONCE(scx_watchdog_timestamp, jiffies);
6309 	WRITE_ONCE(scx_watchdog_interval, intv);
6310 
6311 	if (intv < ULONG_MAX)
6312 		mod_delayed_work(system_dfl_wq, &scx_watchdog_work, intv);
6313 	else
6314 		cancel_delayed_work_sync(&scx_watchdog_work);
6315 }
6316 
scx_link_sched(struct scx_sched * sch)6317 s32 scx_link_sched(struct scx_sched *sch)
6318 {
6319 	scoped_guard(raw_spinlock_irqsave, &scx_bypass_lock)	/* for the parent bypass check */
6320 	scoped_guard(raw_spinlock, &scx_sched_lock) {
6321 #ifdef CONFIG_EXT_SUB_SCHED
6322 		struct scx_sched *parent = scx_parent(sch);
6323 
6324 		if (parent) {
6325 			s32 ret;
6326 
6327 			/*
6328 			 * Bypass state is spread across per-cpu flags and a
6329 			 * depth count, so inheriting it is tricky and has no
6330 			 * valid use case. Refuse it.
6331 			 */
6332 			if (READ_ONCE(parent->bypass_depth)) {
6333 				scx_error(sch, "parent bypassing (%d)", -EBUSY);
6334 				return -EBUSY;
6335 			}
6336 
6337 			ret = rhashtable_lookup_insert_fast(&scx_sched_hash,
6338 					&sch->hash_node, scx_sched_hash_params);
6339 			if (ret) {
6340 				scx_error(sch, "failed to insert into scx_sched_hash (%d)",
6341 					  ret);
6342 				return ret;
6343 			}
6344 
6345 			list_add_tail_rcu(&sch->sibling, &parent->children);
6346 
6347 			/*
6348 			 * Pairs with the mb after the ->aborting assertion in
6349 			 * scx_claim_exit(). Either we see ->aborting and back
6350 			 * out, or the exit path sees us and exits us.
6351 			 */
6352 			smp_mb();
6353 			if (unlikely(READ_ONCE(parent->aborting))) {
6354 				rhashtable_remove_fast(&scx_sched_hash, &sch->hash_node,
6355 						       scx_sched_hash_params);
6356 				list_del_rcu(&sch->sibling);
6357 				scx_error(sch, "parent disabled (%d)", -ENOENT);
6358 				return -ENOENT;
6359 			}
6360 
6361 			sch->linked = true;
6362 		}
6363 #endif	/* CONFIG_EXT_SUB_SCHED */
6364 
6365 		list_add_tail_rcu(&sch->all, &scx_sched_all);
6366 	}
6367 
6368 	refresh_watchdog();
6369 	return 0;
6370 }
6371 
scx_unlink_sched(struct scx_sched * sch)6372 void scx_unlink_sched(struct scx_sched *sch)
6373 {
6374 	scoped_guard(raw_spinlock_irq, &scx_sched_lock) {
6375 #ifdef CONFIG_EXT_SUB_SCHED
6376 		if (sch->linked) {
6377 			rhashtable_remove_fast(&scx_sched_hash, &sch->hash_node,
6378 					       scx_sched_hash_params);
6379 			list_del_rcu(&sch->sibling);
6380 			sch->linked = false;
6381 		}
6382 #endif	/* CONFIG_EXT_SUB_SCHED */
6383 		list_del_rcu(&sch->all);
6384 	}
6385 
6386 	refresh_watchdog();
6387 }
6388 
6389 /*
6390  * Called to disable future dumps and wait for in-progress one while disabling
6391  * @sch. Once @sch becomes empty during disable, there's no point in dumping it.
6392  * This prevents calling dump ops on a dead sch.
6393  */
scx_disable_dump(struct scx_sched * sch)6394 void scx_disable_dump(struct scx_sched *sch)
6395 {
6396 	guard(raw_spinlock_irqsave)(&scx_dump_lock);
6397 	sch->dump_disabled = true;
6398 }
6399 
scx_log_sched_disable(struct scx_sched * sch)6400 void scx_log_sched_disable(struct scx_sched *sch)
6401 {
6402 	struct scx_exit_info *ei = sch->exit_info;
6403 	const char *type = scx_parent(sch) ? "sub-scheduler" : "scheduler";
6404 
6405 	if (ei->kind >= SCX_EXIT_ERROR) {
6406 		pr_err("sched_ext: BPF %s \"%s\" disabled (%s)\n", type,
6407 		       sch->ops.name, ei->reason);
6408 
6409 		if (ei->msg[0] != '\0')
6410 			pr_err("sched_ext: %s: %s\n", sch->ops.name, ei->msg);
6411 #ifdef CONFIG_STACKTRACE
6412 		stack_trace_print(ei->bt, ei->bt_len, 2);
6413 #endif
6414 	} else {
6415 		pr_info("sched_ext: BPF %s \"%s\" disabled (%s)\n", type,
6416 			sch->ops.name, ei->reason);
6417 	}
6418 }
6419 
scx_root_disable(struct scx_sched * sch)6420 static void scx_root_disable(struct scx_sched *sch)
6421 {
6422 	struct scx_task_iter sti;
6423 	struct task_struct *p;
6424 	bool was_switched_all;
6425 	int cpu;
6426 
6427 	/* guarantee forward progress and wait for descendants to be disabled */
6428 	scx_bypass(sch, true);
6429 	drain_descendants(sch);
6430 
6431 	switch (scx_set_enable_state(SCX_DISABLING)) {
6432 	case SCX_DISABLING:
6433 		WARN_ONCE(true, "sched_ext: duplicate disabling instance?");
6434 		break;
6435 	case SCX_DISABLED:
6436 		pr_warn("sched_ext: ops error detected without ops (%s)\n",
6437 			sch->exit_info->msg);
6438 		WARN_ON_ONCE(scx_set_enable_state(SCX_DISABLED) != SCX_DISABLING);
6439 		goto done;
6440 	default:
6441 		break;
6442 	}
6443 
6444 	/*
6445 	 * Here, every runnable task is guaranteed to make forward progress and
6446 	 * we can safely use blocking synchronization constructs. Actually
6447 	 * disable ops.
6448 	 */
6449 	mutex_lock(&scx_enable_mutex);
6450 
6451 	was_switched_all = scx_switched_all();
6452 
6453 	static_branch_disable(&__scx_switched_all);
6454 	WRITE_ONCE(scx_switching_all, false);
6455 
6456 	/*
6457 	 * Shut down cgroup support before tasks so that the cgroup attach and
6458 	 * migration paths don't race against scx_disable_and_exit_task().
6459 	 */
6460 	scx_cgroup_lock();
6461 	scx_cgroup_enabled = false;
6462 	scx_cgroup_exit(sch);
6463 	scx_cgroup_unlock();
6464 
6465 	/*
6466 	 * The BPF scheduler is going away. All tasks including %TASK_DEAD ones
6467 	 * must be switched out and exited synchronously.
6468 	 */
6469 	percpu_down_write(&scx_fork_rwsem);
6470 
6471 	scx_init_task_enabled = false;
6472 
6473 	scx_task_iter_start(&sti, NULL);
6474 	while ((p = scx_task_iter_next_locked(&sti))) {
6475 		unsigned int queue_flags = DEQUEUE_SAVE | DEQUEUE_MOVE | DEQUEUE_NOCLOCK;
6476 		const struct sched_class *old_class = p->sched_class;
6477 		const struct sched_class *new_class = scx_setscheduler_class(p);
6478 
6479 		update_rq_clock(task_rq(p));
6480 
6481 		if (old_class != new_class)
6482 			queue_flags |= DEQUEUE_CLASS;
6483 
6484 		scoped_guard (sched_change, p, queue_flags) {
6485 			p->sched_class = new_class;
6486 		}
6487 
6488 		scx_disable_and_exit_task(scx_task_sched(p), p);
6489 	}
6490 	scx_task_iter_stop(&sti);
6491 
6492 	scx_disable_dump(sch);
6493 
6494 	scx_cgroup_lock();
6495 	set_cgroup_sched(sch_cgroup(sch), NULL);
6496 	scx_cgroup_unlock();
6497 
6498 	percpu_up_write(&scx_fork_rwsem);
6499 
6500 	/*
6501 	 * Re-balance the dl_server bandwidth reservations: detach ext_server
6502 	 * (no more sched_ext tasks) and reinstate fair_server if it was
6503 	 * previously detached because we were running in full mode.
6504 	 *
6505 	 * Unlike the enable path, this runs on a recovery path that cannot
6506 	 * fail, so we use dl_server_swap_bw() to atomically free ext_server's
6507 	 * bandwidth and reclaim it for fair_server under the same dl_b lock.
6508 	 *
6509 	 * The swap can still fail with -EBUSY if someone bumped ext_server's
6510 	 * runtime via debugfs between enable and disable; in that narrow case
6511 	 * both servers end up detached and we just WARN.
6512 	 */
6513 	for_each_possible_cpu(cpu) {
6514 		struct rq *rq = cpu_rq(cpu);
6515 
6516 		scoped_guard(rq_lock_irqsave, rq) {
6517 			update_rq_clock(rq);
6518 			if (was_switched_all) {
6519 				if (WARN_ON_ONCE(dl_server_swap_bw(&rq->ext_server,
6520 								   &rq->fair_server)))
6521 					pr_warn("failed to re-attach fair_server on CPU %d\n", cpu);
6522 			} else {
6523 				dl_server_detach_bw(&rq->ext_server);
6524 			}
6525 		}
6526 	}
6527 
6528 	/* no task is on scx, turn off all the switches and flush in-progress calls */
6529 	static_branch_disable(&__scx_enabled);
6530 	static_branch_disable(&__scx_is_cid_type);
6531 	if (sch->ops.flags & SCX_OPS_TID_TO_TASK)
6532 		static_branch_disable(&__scx_tid_to_task_enabled);
6533 	bitmap_zero(sch->has_op, SCX_OPI_END);
6534 	scx_idle_disable();
6535 	synchronize_rcu();
6536 	if (sch->ops.flags & SCX_OPS_TID_TO_TASK)
6537 		rhashtable_free_and_destroy(&scx_tid_hash, NULL, NULL);
6538 
6539 	scx_log_sched_disable(sch);
6540 
6541 	if (sch->ops.exit)
6542 		SCX_CALL_OP(sch, exit, NULL, sch->exit_info);
6543 
6544 	/*
6545 	 * @sch's non-ops programs such as timers and tracers can fire after
6546 	 * ops.exit(). Now that exit is complete, stop scx_prog_sched() from
6547 	 * resolving to @sch and drain in-flight resolvers.
6548 	 */
6549 	WRITE_ONCE(sch->dead, true);
6550 	synchronize_rcu();
6551 
6552 	scx_unlink_sched(sch);
6553 
6554 	/*
6555 	 * scx_root clearing and cid table retirement must be inside
6556 	 * cpus_read_lock(). See handle_hotplug().
6557 	 */
6558 	cpus_read_lock();
6559 	RCU_INIT_POINTER(scx_root, NULL);
6560 	scx_cid_retire_tables();
6561 	cpus_read_unlock();
6562 
6563 	/*
6564 	 * Delete the kobject from the hierarchy synchronously. Otherwise, sysfs
6565 	 * could observe an object of the same name still in the hierarchy when
6566 	 * the next scheduler is loaded.
6567 	 */
6568 #ifdef CONFIG_EXT_SUB_SCHED
6569 	if (sch->sub_kset)
6570 		kobject_del(&sch->sub_kset->kobj);
6571 #endif
6572 	/* not added if enable failed before scx_sched_sysfs_add() */
6573 	if (sch->kobj.state_in_sysfs)
6574 		kobject_del(&sch->kobj);
6575 
6576 	free_kick_syncs();
6577 
6578 	mutex_unlock(&scx_enable_mutex);
6579 
6580 	WARN_ON_ONCE(scx_set_enable_state(SCX_DISABLED) != SCX_DISABLING);
6581 done:
6582 	scx_bypass(sch, false);
6583 }
6584 
6585 /**
6586  * scx_propagate_exit_irq_workfn - Claim SCX_EXIT_PARENT on the exiting subtree
6587  * @irq_work: &scx_sched.propagate_exit_irq_work
6588  *
6589  * Queued by scx_claim_exit() after a non-PARENT claim. Claims SCX_EXIT_PARENT
6590  * on each descendant, giving every one its own disable work - most of disabling
6591  * is serialized but ops.exit() can take arbitrarily long and running them in
6592  * separate helper kthreads parallelizes it. No recursion as only non-PARENT
6593  * claims propagate.
6594  */
scx_propagate_exit_irq_workfn(struct irq_work * irq_work)6595 static void scx_propagate_exit_irq_workfn(struct irq_work *irq_work)
6596 {
6597 	struct scx_sched *sch = container_of(irq_work, struct scx_sched,
6598 					     propagate_exit_irq_work);
6599 	struct scx_sched *pos;
6600 
6601 	scoped_guard (raw_spinlock_irqsave, &scx_sched_lock) {
6602 		scx_for_each_descendant_pre(pos, sch)
6603 			scx_disable(pos, SCX_EXIT_PARENT);
6604 	}
6605 }
6606 
6607 /*
6608  * Claim the exit on @sch. The caller must ensure that the helper kthread work
6609  * is kicked before the current task can be preempted. Once exit_kind is
6610  * claimed, scx_error() can no longer trigger, so if the current task gets
6611  * preempted and the BPF scheduler fails to schedule it back, the helper work
6612  * will never be kicked and the whole system can wedge.
6613  *
6614  * Lock-free and safe to call from any context including NMI.
6615  */
scx_claim_exit(struct scx_sched * sch,enum scx_exit_kind kind)6616 static bool scx_claim_exit(struct scx_sched *sch, enum scx_exit_kind kind)
6617 {
6618 	int none = SCX_EXIT_NONE;
6619 
6620 	lockdep_assert_preemption_disabled();
6621 
6622 	if (WARN_ON_ONCE(kind == SCX_EXIT_NONE || kind == SCX_EXIT_DONE))
6623 		kind = SCX_EXIT_ERROR;
6624 
6625 	if (!atomic_try_cmpxchg(&sch->exit_kind, &none, kind))
6626 		return false;
6627 
6628 	if (kind == SCX_EXIT_PARENT) {
6629 		/* an ancestor is already sweeping the subtree */
6630 		WRITE_ONCE(sch->aborting, true);
6631 	} else {
6632 		struct scx_sched *pos;
6633 
6634 		/*
6635 		 * CPUs may be live-locked in the dispatch paths of @sch or its
6636 		 * descendants, which ->aborting breaks. Sweep the subtree
6637 		 * locklessly so that this works from NMI. smp_store_mb() orders
6638 		 * each node's ->aborting store before its children are walked -
6639 		 * either we see a racing scx_link_sched() on ->children or it
6640 		 * sees ->aborting.
6641 		 */
6642 		scoped_guard (rcu) {
6643 			scx_for_each_descendant_pre(pos, sch)
6644 				smp_store_mb(pos->aborting, true);
6645 		}
6646 
6647 		irq_work_queue(&sch->propagate_exit_irq_work);
6648 	}
6649 
6650 	/* fired after ->aborting is set so callbacks can't delay recovery */
6651 	trace_sched_ext_exit(sch, kind);
6652 
6653 	return true;
6654 }
6655 
scx_disable_workfn(struct kthread_work * work)6656 static void scx_disable_workfn(struct kthread_work *work)
6657 {
6658 	struct scx_sched *sch = container_of(work, struct scx_sched, disable_work);
6659 	struct scx_exit_info *ei = sch->exit_info;
6660 	int kind;
6661 
6662 	kind = atomic_read(&sch->exit_kind);
6663 	while (true) {
6664 		if (kind == SCX_EXIT_DONE)	/* already disabled? */
6665 			return;
6666 		WARN_ON_ONCE(kind == SCX_EXIT_NONE);
6667 		if (atomic_try_cmpxchg(&sch->exit_kind, &kind, SCX_EXIT_DONE))
6668 			break;
6669 	}
6670 	ei->kind = kind;
6671 	ei->reason = scx_exit_reason(ei->kind);
6672 
6673 	if (scx_parent(sch))
6674 		scx_sub_disable(sch);
6675 	else
6676 		scx_root_disable(sch);
6677 }
6678 
scx_disable(struct scx_sched * sch,enum scx_exit_kind kind)6679 static void scx_disable(struct scx_sched *sch, enum scx_exit_kind kind)
6680 {
6681 	guard(preempt)();
6682 	if (scx_claim_exit(sch, kind))
6683 		irq_work_queue(&sch->disable_irq_work);
6684 }
6685 
6686 /**
6687  * scx_flush_disable_work - flush the disable work and wait for it to finish
6688  * @sch: the scheduler
6689  *
6690  * sch->disable_work might still not queued, causing kthread_flush_work()
6691  * as a noop. Syncing the irq_work first is required to guarantee the
6692  * kthread work has been queued before waiting for it.
6693  */
scx_flush_disable_work(struct scx_sched * sch)6694 void scx_flush_disable_work(struct scx_sched *sch)
6695 {
6696 	int kind;
6697 
6698 	do {
6699 		irq_work_sync(&sch->disable_irq_work);
6700 		kthread_flush_work(&sch->disable_work);
6701 		kind = atomic_read(&sch->exit_kind);
6702 	} while (kind != SCX_EXIT_NONE && kind != SCX_EXIT_DONE);
6703 }
6704 
dump_newline(struct seq_buf * s)6705 static void dump_newline(struct seq_buf *s)
6706 {
6707 	trace_sched_ext_dump("");
6708 
6709 	/* @s may be zero sized and seq_buf triggers WARN if so */
6710 	if (s->size)
6711 		seq_buf_putc(s, '\n');
6712 }
6713 
scx_dump_line(struct seq_buf * s,const char * fmt,...)6714 __printf(2, 3) void scx_dump_line(struct seq_buf *s, const char *fmt, ...)
6715 {
6716 	va_list args;
6717 
6718 #ifdef CONFIG_TRACEPOINTS
6719 	if (trace_sched_ext_dump_enabled()) {
6720 		/* protected by scx_dump_lock */
6721 		static char line_buf[SCX_EXIT_MSG_LEN];
6722 
6723 		va_start(args, fmt);
6724 		vscnprintf(line_buf, sizeof(line_buf), fmt, args);
6725 		va_end(args);
6726 
6727 		trace_call__sched_ext_dump(line_buf);
6728 	}
6729 #endif
6730 	/* @s may be zero sized and seq_buf triggers WARN if so */
6731 	if (s->size) {
6732 		va_start(args, fmt);
6733 		seq_buf_vprintf(s, fmt, args);
6734 		va_end(args);
6735 
6736 		seq_buf_putc(s, '\n');
6737 	}
6738 }
6739 
dump_stack_trace(struct seq_buf * s,const char * prefix,const unsigned long * bt,unsigned int len)6740 static void dump_stack_trace(struct seq_buf *s, const char *prefix,
6741 			     const unsigned long *bt, unsigned int len)
6742 {
6743 	unsigned int i;
6744 
6745 	for (i = 0; i < len; i++)
6746 		scx_dump_line(s, "%s%pS", prefix, (void *)bt[i]);
6747 }
6748 
ops_dump_init(struct seq_buf * s,const char * prefix)6749 static void ops_dump_init(struct seq_buf *s, const char *prefix)
6750 {
6751 	struct scx_dump_data *dd = &scx_dump_data;
6752 
6753 	lockdep_assert_irqs_disabled();
6754 
6755 	dd->cpu = smp_processor_id();		/* allow scx_bpf_dump() */
6756 	dd->first = true;
6757 	dd->cursor = 0;
6758 	dd->s = s;
6759 	dd->prefix = prefix;
6760 }
6761 
ops_dump_flush(void)6762 static void ops_dump_flush(void)
6763 {
6764 	struct scx_dump_data *dd = &scx_dump_data;
6765 	char *line = dd->buf.line;
6766 
6767 	if (!dd->cursor)
6768 		return;
6769 
6770 	/*
6771 	 * There's something to flush and this is the first line. Insert a blank
6772 	 * line to distinguish ops dump.
6773 	 */
6774 	if (dd->first) {
6775 		dump_newline(dd->s);
6776 		dd->first = false;
6777 	}
6778 
6779 	/*
6780 	 * There may be multiple lines in $line. Scan and emit each line
6781 	 * separately.
6782 	 */
6783 	while (true) {
6784 		char *end = line;
6785 		char c;
6786 
6787 		while (*end != '\n' && *end != '\0')
6788 			end++;
6789 
6790 		/*
6791 		 * If $line overflowed, it may not have newline at the end.
6792 		 * Always emit with a newline.
6793 		 */
6794 		c = *end;
6795 		*end = '\0';
6796 		scx_dump_line(dd->s, "%s%s", dd->prefix, line);
6797 		if (c == '\0')
6798 			break;
6799 
6800 		/* move to the next line */
6801 		end++;
6802 		if (*end == '\0')
6803 			break;
6804 		line = end;
6805 	}
6806 
6807 	dd->cursor = 0;
6808 }
6809 
ops_dump_exit(void)6810 static void ops_dump_exit(void)
6811 {
6812 	ops_dump_flush();
6813 	scx_dump_data.cpu = -1;
6814 }
6815 
scx_dump_task(struct scx_sched * sch,struct seq_buf * s,struct scx_dump_ctx * dctx,struct rq * rq,struct task_struct * p,char marker)6816 static void scx_dump_task(struct scx_sched *sch, struct seq_buf *s, struct scx_dump_ctx *dctx,
6817 			  struct rq *rq, struct task_struct *p, char marker)
6818 {
6819 	static unsigned long bt[SCX_EXIT_BT_LEN];
6820 	struct scx_sched *task_sch = scx_task_sched(p);
6821 	const char *own_marker;
6822 	char sch_id_buf[32];
6823 	char dsq_id_buf[19] = "(n/a)";
6824 	unsigned long ops_state = atomic_long_read(&p->scx.ops_state);
6825 	unsigned int bt_len = 0;
6826 
6827 	own_marker = task_sch == sch ? "*" : "";
6828 
6829 	if (task_sch->level == 0)
6830 		scnprintf(sch_id_buf, sizeof(sch_id_buf), "root");
6831 	else
6832 		scnprintf(sch_id_buf, sizeof(sch_id_buf), "sub%d-%llu",
6833 			  task_sch->level, task_sch->ops.sub_cgroup_id);
6834 
6835 	if (p->scx.dsq)
6836 		scnprintf(dsq_id_buf, sizeof(dsq_id_buf), "0x%llx",
6837 			  (unsigned long long)p->scx.dsq->id);
6838 
6839 	dump_newline(s);
6840 	scx_dump_line(s, " %c%c %s[%d] %s%s %+ldms",
6841 		      marker, task_state_to_char(p), p->comm, p->pid, own_marker, sch_id_buf,
6842 		      jiffies_delta_msecs(p->scx.runnable_at, dctx->at_jiffies));
6843 	scx_dump_line(s, "      scx_state/flags=%u/0x%x dsq_flags=0x%x ops_state/qseq=%lu/%lu",
6844 		      scx_get_task_state(p) >> SCX_TASK_STATE_SHIFT,
6845 		      p->scx.flags & ~SCX_TASK_STATE_MASK, p->scx.dsq_flags,
6846 		      ops_state & SCX_OPSS_STATE_MASK, ops_state >> SCX_OPSS_QSEQ_SHIFT);
6847 	scx_dump_line(s, "      sticky/holding_cpu=%d/%d dsq_id=%s",
6848 		      p->scx.sticky_cpu, p->scx.holding_cpu, dsq_id_buf);
6849 	scx_dump_line(s, "      dsq_vtime=%llu slice=%llu weight=%u",
6850 		      p->scx.dsq_vtime, p->scx.slice, p->scx.weight);
6851 	scx_dump_line(s, "      cpus=%*pb no_mig=%u", cpumask_pr_args(p->cpus_ptr),
6852 		      p->migration_disabled);
6853 
6854 	if (SCX_HAS_OP(sch, dump_task)) {
6855 		ops_dump_init(s, "    ");
6856 		SCX_CALL_OP(sch, dump_task, rq, dctx, p);
6857 		ops_dump_exit();
6858 	}
6859 
6860 #ifdef CONFIG_STACKTRACE
6861 	bt_len = stack_trace_save_tsk(p, bt, SCX_EXIT_BT_LEN, 1);
6862 #endif
6863 	if (bt_len) {
6864 		dump_newline(s);
6865 		dump_stack_trace(s, "    ", bt, bt_len);
6866 	}
6867 }
6868 
scx_dump_cpu(struct scx_sched * sch,struct seq_buf * s,struct scx_dump_ctx * dctx,int cpu,bool dump_all_tasks)6869 static void scx_dump_cpu(struct scx_sched *sch, struct seq_buf *s,
6870 			 struct scx_dump_ctx *dctx, int cpu,
6871 			 bool dump_all_tasks)
6872 {
6873 	struct rq *rq = cpu_rq(cpu);
6874 	struct scx_sched_pcpu *pcpu = per_cpu_ptr(sch->pcpu, cpu);
6875 	struct rq_flags rf;
6876 	struct task_struct *p;
6877 	struct seq_buf ns;
6878 	size_t avail, used;
6879 	char *buf;
6880 	bool idle;
6881 
6882 	rq_lock_irqsave(rq, &rf);
6883 
6884 	idle = list_empty(&rq->scx.runnable_list) &&
6885 		rq->curr->sched_class == &idle_sched_class;
6886 
6887 	if (idle && !SCX_HAS_OP(sch, dump_cpu))
6888 		goto next;
6889 
6890 	/*
6891 	 * We don't yet know whether ops.dump_cpu() will produce output
6892 	 * and we may want to skip the default CPU dump if it doesn't.
6893 	 * Use a nested seq_buf to generate the standard dump so that we
6894 	 * can decide whether to commit later.
6895 	 */
6896 	avail = seq_buf_get_buf(s, &buf);
6897 	seq_buf_init(&ns, buf, avail);
6898 
6899 	dump_newline(&ns);
6900 	scx_dump_line(&ns, "CPU %-4d: nr_run=%u flags=0x%x cpu_rel=%d ops_qseq=%lu ksync=%lu",
6901 		      cpu, rq->scx.nr_running, rq->scx.flags, rq->scx.cpu_released,
6902 		      rq->scx.ops_qseq, rq->scx.kick_sync);
6903 	scx_rescue_dump(&ns, rq);
6904 	scx_dump_line(&ns, "          curr=%s[%d] class=%ps",
6905 		      rq->curr->comm, rq->curr->pid, rq->curr->sched_class);
6906 	if (!cpumask_empty(pcpu->cpus_to_kick))
6907 		scx_dump_line(&ns, "  cpus_to_kick   : %*pb",
6908 			      cpumask_pr_args(pcpu->cpus_to_kick));
6909 	if (!cpumask_empty(pcpu->cpus_to_kick_if_idle))
6910 		scx_dump_line(&ns, "  idle_to_kick   : %*pb",
6911 			      cpumask_pr_args(pcpu->cpus_to_kick_if_idle));
6912 	if (!cpumask_empty(pcpu->cpus_to_preempt))
6913 		scx_dump_line(&ns, "  cpus_to_preempt: %*pb",
6914 			      cpumask_pr_args(pcpu->cpus_to_preempt));
6915 	if (!cpumask_empty(pcpu->cpus_to_wait))
6916 		scx_dump_line(&ns, "  cpus_to_wait   : %*pb",
6917 			      cpumask_pr_args(pcpu->cpus_to_wait));
6918 	if (!cpumask_empty(rq->scx.cpus_to_sync))
6919 		scx_dump_line(&ns, "  cpus_to_sync   : %*pb",
6920 			      cpumask_pr_args(rq->scx.cpus_to_sync));
6921 
6922 	used = seq_buf_used(&ns);
6923 	if (SCX_HAS_OP(sch, dump_cpu)) {
6924 		ops_dump_init(&ns, "  ");
6925 		SCX_CALL_OP(sch, dump_cpu, rq, dctx, scx_cpu_arg(cpu), idle);
6926 		ops_dump_exit();
6927 	}
6928 
6929 	/*
6930 	 * If idle && nothing generated by ops.dump_cpu(), there's
6931 	 * nothing interesting. Skip.
6932 	 */
6933 	if (idle && used == seq_buf_used(&ns))
6934 		goto next;
6935 
6936 	/*
6937 	 * $s may already have overflowed when $ns was created. If so,
6938 	 * calling commit on it will trigger BUG.
6939 	 */
6940 	if (avail) {
6941 		seq_buf_commit(s, seq_buf_used(&ns));
6942 		if (seq_buf_has_overflowed(&ns))
6943 			seq_buf_set_overflow(s);
6944 	}
6945 
6946 	if (rq->curr->sched_class == &ext_sched_class &&
6947 	    (dump_all_tasks || scx_task_on_sched(sch, rq->curr)))
6948 		scx_dump_task(sch, s, dctx, rq, rq->curr, '*');
6949 
6950 	list_for_each_entry(p, &rq->scx.runnable_list, scx.runnable_node)
6951 		if (dump_all_tasks || scx_task_on_sched(sch, p))
6952 			scx_dump_task(sch, s, dctx, rq, p, ' ');
6953 next:
6954 	rq_unlock_irqrestore(rq, &rf);
6955 }
6956 
6957 /*
6958  * Dump scheduler state. If @dump_all_tasks is true, dump all tasks regardless
6959  * of which scheduler they belong to. If false, only dump tasks owned by @sch.
6960  * For SysRq-D dumps, @dump_all_tasks=false since all schedulers are dumped
6961  * separately. For error dumps, @dump_all_tasks=true since only the failing
6962  * scheduler is dumped.
6963  */
scx_dump_state(struct scx_sched * sch,struct scx_exit_info * ei,size_t dump_len,bool dump_all_tasks)6964 static void scx_dump_state(struct scx_sched *sch, struct scx_exit_info *ei,
6965 			   size_t dump_len, bool dump_all_tasks)
6966 {
6967 	static const char trunc_marker[] = "\n\n~~~~ TRUNCATED ~~~~\n";
6968 	struct scx_dump_ctx dctx = {
6969 		.kind = ei->kind,
6970 		.exit_code = ei->exit_code,
6971 		.reason = ei->reason,
6972 		.at_ns = ktime_get_ns(),
6973 		.at_jiffies = jiffies,
6974 	};
6975 	struct seq_buf s;
6976 	struct scx_event_stats events;
6977 	int cpu;
6978 
6979 	guard(raw_spinlock_irqsave)(&scx_dump_lock);
6980 
6981 	if (sch->dump_disabled)
6982 		return;
6983 
6984 	seq_buf_init(&s, ei->dump, dump_len);
6985 
6986 #ifdef CONFIG_EXT_SUB_SCHED
6987 	if (sch->level == 0)
6988 		scx_dump_line(&s, "%s: root", sch->ops.name);
6989 	else
6990 		scx_dump_line(&s, "%s: sub%d-%llu %s",
6991 			      sch->ops.name, sch->level, sch->ops.sub_cgroup_id,
6992 			      sch->cgrp_path);
6993 #endif
6994 	if (ei->kind == SCX_EXIT_NONE) {
6995 		scx_dump_line(&s, "Debug dump triggered by %s", ei->reason);
6996 	} else {
6997 		if (ei->exit_cpu >= 0)
6998 			scx_dump_line(&s, "%s[%d] triggered exit kind %d on CPU %d:",
6999 				      current->comm, current->pid, ei->kind,
7000 				      ei->exit_cpu);
7001 		else
7002 			scx_dump_line(&s, "%s[%d] triggered exit kind %d:",
7003 				      current->comm, current->pid, ei->kind);
7004 		scx_dump_line(&s, "  %s (%s)", ei->reason, ei->msg);
7005 		dump_newline(&s);
7006 		scx_dump_line(&s, "Backtrace:");
7007 		dump_stack_trace(&s, "  ", ei->bt, ei->bt_len);
7008 	}
7009 
7010 	if (SCX_HAS_OP(sch, dump)) {
7011 		ops_dump_init(&s, "");
7012 		SCX_CALL_OP(sch, dump, NULL, &dctx);
7013 		ops_dump_exit();
7014 	}
7015 
7016 	dump_newline(&s);
7017 	scx_dump_line(&s, "CPU states");
7018 	scx_dump_line(&s, "----------");
7019 
7020 	/*
7021 	 * Dump stalled CPUs first so they aren't lost to dump truncation, then
7022 	 * walk the rest in order. Fall back to exit_cpu if no stall mask set.
7023 	 */
7024 	if (!cpumask_empty(sch->stall_cpus)) {
7025 		for_each_cpu(cpu, sch->stall_cpus)
7026 			scx_dump_cpu(sch, &s, &dctx, cpu, dump_all_tasks);
7027 		for_each_possible_cpu(cpu) {
7028 			if (!cpumask_test_cpu(cpu, sch->stall_cpus))
7029 				scx_dump_cpu(sch, &s, &dctx, cpu, dump_all_tasks);
7030 		}
7031 	} else {
7032 		if (ei->exit_cpu >= 0)
7033 			scx_dump_cpu(sch, &s, &dctx, ei->exit_cpu, dump_all_tasks);
7034 		for_each_possible_cpu(cpu) {
7035 			if (cpu != ei->exit_cpu)
7036 				scx_dump_cpu(sch, &s, &dctx, cpu, dump_all_tasks);
7037 		}
7038 	}
7039 
7040 	dump_newline(&s);
7041 	scx_dump_line(&s, "Event counters");
7042 	scx_dump_line(&s, "--------------");
7043 
7044 	scx_read_events(sch, &events);
7045 #define SCX_EVENT(name)	scx_dump_event(s, &events, name)
7046 	SCX_EVENTS_LIST(SCX_EVENT);
7047 #undef SCX_EVENT
7048 
7049 	if (seq_buf_has_overflowed(&s) && dump_len >= sizeof(trunc_marker))
7050 		memcpy(ei->dump + dump_len - sizeof(trunc_marker),
7051 		       trunc_marker, sizeof(trunc_marker));
7052 }
7053 
scx_disable_irq_workfn(struct irq_work * irq_work)7054 static void scx_disable_irq_workfn(struct irq_work *irq_work)
7055 {
7056 	struct scx_sched *sch = container_of(irq_work, struct scx_sched, disable_irq_work);
7057 	struct scx_exit_info *ei = sch->exit_info;
7058 
7059 	if (ei->kind >= SCX_EXIT_ERROR)
7060 		scx_dump_state(sch, ei, sch->ops.exit_dump_len, true);
7061 
7062 	kthread_queue_work(sch->helper, &sch->disable_work);
7063 }
7064 
7065 /* finish exit_info and kick the disable work, ei->msg must already be set */
scx_finish_exit(struct scx_sched * sch,enum scx_exit_kind kind,s64 exit_code,s32 exit_cpu)7066 static void scx_finish_exit(struct scx_sched *sch, enum scx_exit_kind kind,
7067 			    s64 exit_code, s32 exit_cpu)
7068 {
7069 	struct scx_exit_info *ei = sch->exit_info;
7070 
7071 	ei->exit_code = exit_code;
7072 #ifdef CONFIG_STACKTRACE
7073 	/*
7074 	 * stack_trace_save()'s NMI-safety is arch-dependent and undocumented.
7075 	 * Skip the backtrace when exiting from NMI.
7076 	 */
7077 	if (kind >= SCX_EXIT_ERROR && !in_nmi())
7078 		ei->bt_len = stack_trace_save(ei->bt, SCX_EXIT_BT_LEN, 1);
7079 #endif
7080 	/*
7081 	 * Set ei->kind and ->reason for scx_dump_state(). They'll be set again
7082 	 * in scx_disable_workfn().
7083 	 */
7084 	ei->kind = kind;
7085 	ei->reason = scx_exit_reason(ei->kind);
7086 	ei->exit_cpu = exit_cpu;
7087 
7088 	irq_work_queue(&sch->disable_irq_work);
7089 }
7090 
scx_vexit(struct scx_sched * sch,enum scx_exit_kind kind,s64 exit_code,s32 exit_cpu,const char * fmt,va_list args)7091 bool scx_vexit(struct scx_sched *sch,
7092 	       enum scx_exit_kind kind, s64 exit_code, s32 exit_cpu,
7093 	       const char *fmt, va_list args)
7094 {
7095 	struct scx_exit_info *ei = sch->exit_info;
7096 
7097 	guard(preempt)();
7098 
7099 	if (!scx_claim_exit(sch, kind))
7100 		return false;
7101 
7102 	vscnprintf(ei->msg, SCX_EXIT_MSG_LEN, fmt, args);
7103 
7104 	scx_finish_exit(sch, kind, exit_code, exit_cpu);
7105 	return true;
7106 }
7107 
alloc_kick_syncs(void)7108 static int alloc_kick_syncs(void)
7109 {
7110 	int cpu;
7111 
7112 	/*
7113 	 * Allocate per-CPU arrays sized by nr_cpu_ids. Use kvzalloc as size
7114 	 * can exceed percpu allocator limits on large machines.
7115 	 */
7116 	for_each_possible_cpu(cpu) {
7117 		struct scx_kick_syncs __rcu **ksyncs = per_cpu_ptr(&scx_kick_syncs, cpu);
7118 		struct scx_kick_syncs *new_ksyncs;
7119 
7120 		WARN_ON_ONCE(rcu_access_pointer(*ksyncs));
7121 
7122 		new_ksyncs = kvzalloc_node(struct_size(new_ksyncs, syncs, nr_cpu_ids),
7123 					   GFP_KERNEL, cpu_to_node(cpu));
7124 		if (!new_ksyncs) {
7125 			free_kick_syncs();
7126 			return -ENOMEM;
7127 		}
7128 
7129 		rcu_assign_pointer(*ksyncs, new_ksyncs);
7130 	}
7131 
7132 	return 0;
7133 }
7134 
free_pnode(struct scx_sched_pnode * pnode)7135 static void free_pnode(struct scx_sched_pnode *pnode)
7136 {
7137 	if (!pnode)
7138 		return;
7139 	exit_dsq(&pnode->global_dsq);
7140 	kfree(pnode);
7141 }
7142 
alloc_pnode(struct scx_sched * sch,int node)7143 static struct scx_sched_pnode *alloc_pnode(struct scx_sched *sch, int node)
7144 {
7145 	struct scx_sched_pnode *pnode;
7146 
7147 	pnode = kzalloc_node(sizeof(*pnode), GFP_KERNEL, node);
7148 	if (!pnode)
7149 		return NULL;
7150 
7151 	if (scx_init_dsq(&pnode->global_dsq, SCX_DSQ_GLOBAL, sch)) {
7152 		kfree(pnode);
7153 		return NULL;
7154 	}
7155 
7156 	return pnode;
7157 }
7158 
7159 /*
7160  * Allocate and initialize a new scx_sched. @cgrp's reference is always
7161  * consumed whether the function succeeds or fails.
7162  */
scx_alloc_and_add_sched(struct scx_enable_cmd * cmd,struct cgroup * cgrp,struct scx_sched * parent)7163 struct scx_sched *scx_alloc_and_add_sched(struct scx_enable_cmd *cmd,
7164 					  struct cgroup *cgrp,
7165 					  struct scx_sched *parent)
7166 {
7167 	struct sched_ext_ops *ops = cmd->ops;
7168 	struct scx_sched *sch;
7169 	s32 level = parent ? parent->level + 1 : 0;
7170 	s32 node, cpu, ret, bypass_fail_cpu = nr_cpu_ids;
7171 
7172 	sch = kzalloc_flex(*sch, ancestors, level + 1);
7173 	if (!sch) {
7174 		ret = -ENOMEM;
7175 		goto err_put_cgrp;
7176 	}
7177 
7178 	sch->exit_info = alloc_exit_info(ops->exit_dump_len);
7179 	if (!sch->exit_info) {
7180 		ret = -ENOMEM;
7181 		goto err_free_sch;
7182 	}
7183 
7184 	ret = rhashtable_init(&sch->dsq_hash, &dsq_hash_params);
7185 	if (ret < 0)
7186 		goto err_free_ei;
7187 
7188 	sch->pnode = kzalloc_objs(sch->pnode[0], nr_node_ids);
7189 	if (!sch->pnode) {
7190 		ret = -ENOMEM;
7191 		goto err_free_hash;
7192 	}
7193 
7194 	for_each_node_state(node, N_POSSIBLE) {
7195 		sch->pnode[node] = alloc_pnode(sch, node);
7196 		if (!sch->pnode[node]) {
7197 			ret = -ENOMEM;
7198 			goto err_free_pnode;
7199 		}
7200 	}
7201 
7202 	sch->dsp_max_batch = ops->dispatch_max_batch ?: SCX_DSP_DFL_MAX_BATCH;
7203 	sch->pcpu = __alloc_percpu(struct_size_t(struct scx_sched_pcpu,
7204 						 dsp_ctx.buf, sch->dsp_max_batch),
7205 				   __alignof__(struct scx_sched_pcpu));
7206 	if (!sch->pcpu) {
7207 		ret = -ENOMEM;
7208 		goto err_free_pnode;
7209 	}
7210 
7211 	for_each_possible_cpu(cpu) {
7212 		ret = scx_init_dsq(scx_bypass_dsq(sch, cpu), SCX_DSQ_BYPASS, sch);
7213 		if (ret) {
7214 			bypass_fail_cpu = cpu;
7215 			goto err_free_pcpu;
7216 		}
7217 	}
7218 
7219 	for_each_possible_cpu(cpu) {
7220 		struct scx_sched_pcpu *pcpu = per_cpu_ptr(sch->pcpu, cpu);
7221 
7222 		node = cpu_to_node(cpu);
7223 		pcpu->sch = sch;
7224 		INIT_LIST_HEAD(&pcpu->deferred_reenq_local.node);
7225 #ifdef CONFIG_EXT_SUB_SCHED
7226 		init_llist_node(&pcpu->ecaps_to_sync_node);
7227 #endif
7228 		INIT_LIST_HEAD(&pcpu->to_kick_node);
7229 		if (!zalloc_cpumask_var_node(&pcpu->cpus_to_kick, GFP_KERNEL, node) ||
7230 		    !zalloc_cpumask_var_node(&pcpu->cpus_to_kick_if_idle, GFP_KERNEL, node) ||
7231 		    !zalloc_cpumask_var_node(&pcpu->cpus_to_preempt, GFP_KERNEL, node) ||
7232 		    !zalloc_cpumask_var_node(&pcpu->cpus_to_wait, GFP_KERNEL, node)) {
7233 			ret = -ENOMEM;
7234 			goto err_free_pcpu;
7235 		}
7236 	}
7237 
7238 	sch->helper = kthread_run_worker(0, "sched_ext_helper");
7239 	if (IS_ERR(sch->helper)) {
7240 		ret = PTR_ERR(sch->helper);
7241 		goto err_free_pcpu;
7242 	}
7243 
7244 	sched_set_fifo(sch->helper->task);
7245 
7246 	if (parent)
7247 		memcpy(sch->ancestors, parent->ancestors,
7248 		       level * sizeof(parent->ancestors[0]));
7249 	sch->ancestors[level] = sch;
7250 	sch->level = level;
7251 	sch->id = atomic64_inc_return(&scx_sched_id_cursor);
7252 
7253 	if (ops->timeout_ms)
7254 		sch->watchdog_timeout = msecs_to_jiffies(ops->timeout_ms);
7255 	else
7256 		sch->watchdog_timeout = SCX_WATCHDOG_MAX_TIMEOUT;
7257 
7258 	sch->slice_dfl = SCX_SLICE_DFL;
7259 	atomic_set(&sch->exit_kind, SCX_EXIT_NONE);
7260 	sch->disable_irq_work = IRQ_WORK_INIT_HARD(scx_disable_irq_workfn);
7261 	sch->propagate_exit_irq_work = IRQ_WORK_INIT_HARD(scx_propagate_exit_irq_workfn);
7262 	kthread_init_work(&sch->disable_work, scx_disable_workfn);
7263 	timer_setup(&sch->bypass_lb_timer, scx_bypass_lb_timerfn, 0);
7264 
7265 	if (!alloc_cpumask_var(&sch->bypass_lb_donee_cpumask, GFP_KERNEL)) {
7266 		ret = -ENOMEM;
7267 		goto err_stop_helper;
7268 	}
7269 	if (!alloc_cpumask_var(&sch->bypass_lb_resched_cpumask, GFP_KERNEL)) {
7270 		ret = -ENOMEM;
7271 		goto err_free_lb_cpumask;
7272 	}
7273 	if (!zalloc_cpumask_var(&sch->stall_cpus, GFP_KERNEL)) {
7274 		ret = -ENOMEM;
7275 		goto err_free_lb_resched_cpumask;
7276 	}
7277 	/*
7278 	 * Copy ops through the right union view. For cid-form the source is
7279 	 * struct sched_ext_ops_cid which lacks the trailing cpu_acquire/
7280 	 * cpu_release; those stay zero from kzalloc.
7281 	 */
7282 	if (cmd->is_cid_type) {
7283 		sch->ops_cid = *cmd->ops_cid;
7284 		sch->is_cid_type = true;
7285 	} else {
7286 		sch->ops = *cmd->ops;
7287 	}
7288 
7289 #ifdef CONFIG_EXT_SUB_SCHED
7290 	char *buf = kzalloc(PATH_MAX, GFP_KERNEL);
7291 	if (!buf) {
7292 		ret = -ENOMEM;
7293 		goto err_free_lb_resched;
7294 	}
7295 	cgroup_path(cgrp, buf, PATH_MAX);
7296 	sch->cgrp_path = kstrdup(buf, GFP_KERNEL);
7297 	kfree(buf);
7298 	if (!sch->cgrp_path) {
7299 		ret = -ENOMEM;
7300 		goto err_free_lb_resched;
7301 	}
7302 
7303 	sch->cgrp = cgrp;
7304 	INIT_LIST_HEAD(&sch->children);
7305 	INIT_LIST_HEAD(&sch->sibling);
7306 #endif	/* CONFIG_EXT_SUB_SCHED */
7307 
7308 	/*
7309 	 * Publishing makes @sch visible to scx_prog_sched() readers. Failure
7310 	 * paths after this point must free @sch through kobject_put() whose
7311 	 * release path defers the actual freeing by an RCU grace period.
7312 	 */
7313 	rcu_assign_pointer(ops->priv, sch);
7314 
7315 	sch->kobj.kset = scx_kset;
7316 	INIT_LIST_HEAD(&sch->all);
7317 
7318 #ifdef CONFIG_EXT_SUB_SCHED
7319 	if (parent) {
7320 		/*
7321 		 * Pin @parent for @sch's lifetime. The kobject hierarchy pins
7322 		 * it only via @parent->sub_kset, which is dropped during
7323 		 * disable. Released in scx_sched_free_rcu_work().
7324 		 */
7325 		kobject_get(&parent->kobj);
7326 	}
7327 #endif	/* CONFIG_EXT_SUB_SCHED */
7328 
7329 	/*
7330 	 * Init the kobj but don't add to sysfs yet. The enable path calls
7331 	 * scx_sched_sysfs_add() once @sch's sysfs-visible state is initialized.
7332 	 */
7333 	kobject_init(&sch->kobj, &scx_ktype);
7334 
7335 	/*
7336 	 * Consume the arena_map ref bpf_scx_reg_cid() took. Defer to here so
7337 	 * earlier failure paths leave cmd->arena_map set and bpf_scx_reg_cid
7338 	 * drops the ref. After this point, sch owns the ref and any cleanup
7339 	 * runs through scx_sched_free_rcu_work() which puts it.
7340 	 */
7341 	sch->arena_map = cmd->arena_map;
7342 	/* BPF arena is only available on MMU && 64BIT */
7343 #if defined(CONFIG_MMU) && defined(CONFIG_64BIT)
7344 	if (sch->arena_map)
7345 		sch->arena_kern_base = bpf_arena_map_kern_vm_start(sch->arena_map);
7346 #endif
7347 	cmd->arena_map = NULL;
7348 	return sch;
7349 
7350 #ifdef CONFIG_EXT_SUB_SCHED
7351 err_free_lb_resched:
7352 	free_cpumask_var(sch->stall_cpus);
7353 #endif
7354 err_free_lb_resched_cpumask:
7355 	free_cpumask_var(sch->bypass_lb_resched_cpumask);
7356 err_free_lb_cpumask:
7357 	free_cpumask_var(sch->bypass_lb_donee_cpumask);
7358 err_stop_helper:
7359 	kthread_destroy_worker(sch->helper);
7360 err_free_pcpu:
7361 	for_each_possible_cpu(cpu) {
7362 		struct scx_sched_pcpu *pcpu = per_cpu_ptr(sch->pcpu, cpu);
7363 
7364 		free_cpumask_var(pcpu->cpus_to_kick);
7365 		free_cpumask_var(pcpu->cpus_to_kick_if_idle);
7366 		free_cpumask_var(pcpu->cpus_to_preempt);
7367 		free_cpumask_var(pcpu->cpus_to_wait);
7368 	}
7369 	for_each_possible_cpu(cpu) {
7370 		if (cpu == bypass_fail_cpu)
7371 			break;
7372 		exit_dsq(scx_bypass_dsq(sch, cpu));
7373 	}
7374 	free_percpu(sch->pcpu);
7375 err_free_pnode:
7376 	for_each_node_state(node, N_POSSIBLE)
7377 		free_pnode(sch->pnode[node]);
7378 	kfree(sch->pnode);
7379 err_free_hash:
7380 	rhashtable_free_and_destroy(&sch->dsq_hash, NULL, NULL);
7381 err_free_ei:
7382 	free_exit_info(sch->exit_info);
7383 err_free_sch:
7384 	kfree(sch);
7385 err_put_cgrp:
7386 #ifdef CONFIG_EXT_SUB_SCHED
7387 	cgroup_put(cgrp);
7388 #endif
7389 	return ERR_PTR(ret);
7390 }
7391 
7392 /*
7393  * Add @sch's kobject to sysfs, and create its sub_kset if the scheduler
7394  * implements ops.sub_attach. Called by the enable workfns once @sch's
7395  * sysfs-visible state is initialized.
7396  */
scx_sched_sysfs_add(struct scx_sched * sch)7397 int scx_sched_sysfs_add(struct scx_sched *sch)
7398 {
7399 #ifdef CONFIG_EXT_SUB_SCHED
7400 	struct scx_sched *parent = scx_parent(sch);
7401 	int ret;
7402 
7403 	if (parent)
7404 		ret = kobject_add(&sch->kobj, &parent->sub_kset->kobj,
7405 				  "sub-%llu", cgroup_id(sch_cgroup(sch)));
7406 	else
7407 		ret = kobject_add(&sch->kobj, NULL, "root");
7408 	if (ret < 0)
7409 		return ret;
7410 
7411 	if (sch->ops.sub_attach) {
7412 		sch->sub_kset = kset_create_and_add("sub", NULL, &sch->kobj);
7413 		if (!sch->sub_kset)
7414 			return -ENOMEM;
7415 	}
7416 	return 0;
7417 #else
7418 	return kobject_add(&sch->kobj, NULL, "root");
7419 #endif
7420 }
7421 
check_hotplug_seq(struct scx_sched * sch,const struct sched_ext_ops * ops)7422 static int check_hotplug_seq(struct scx_sched *sch,
7423 			      const struct sched_ext_ops *ops)
7424 {
7425 	unsigned long long global_hotplug_seq;
7426 
7427 	/*
7428 	 * If a hotplug event has occurred between when a scheduler was
7429 	 * initialized, and when we were able to attach, exit and notify user
7430 	 * space about it.
7431 	 */
7432 	if (ops->hotplug_seq) {
7433 		global_hotplug_seq = atomic_long_read(&scx_hotplug_seq);
7434 		if (ops->hotplug_seq != global_hotplug_seq) {
7435 			scx_exit(sch, SCX_EXIT_UNREG_KERN,
7436 				 SCX_ECODE_ACT_RESTART | SCX_ECODE_RSN_HOTPLUG,
7437 				 "expected hotplug seq %llu did not match actual %llu",
7438 				 ops->hotplug_seq, global_hotplug_seq);
7439 			return -EBUSY;
7440 		}
7441 	}
7442 
7443 	return 0;
7444 }
7445 
scx_validate_ops(struct scx_sched * sch,const struct sched_ext_ops * ops)7446 int scx_validate_ops(struct scx_sched *sch, const struct sched_ext_ops *ops)
7447 {
7448 	/*
7449 	 * It doesn't make sense to specify the SCX_OPS_ENQ_LAST flag if the
7450 	 * ops.enqueue() callback isn't implemented.
7451 	 */
7452 	if ((ops->flags & SCX_OPS_ENQ_LAST) && !ops->enqueue) {
7453 		scx_error(sch, "SCX_OPS_ENQ_LAST requires ops.enqueue() to be implemented");
7454 		return -EINVAL;
7455 	}
7456 
7457 	/*
7458 	 * SCX_OPS_TID_TO_TASK is enabled by the root scheduler. A sub-sched
7459 	 * may set it to declare a dependency; reject if the root hasn't
7460 	 * enabled it.
7461 	 */
7462 	if ((ops->flags & SCX_OPS_TID_TO_TASK) && scx_parent(sch) &&
7463 	    !(sch->ancestors[0]->ops.flags & SCX_OPS_TID_TO_TASK)) {
7464 		scx_error(sch, "SCX_OPS_TID_TO_TASK requires root scheduler to enable it");
7465 		return -EINVAL;
7466 	}
7467 
7468 	/*
7469 	 * SCX_OPS_BUILTIN_IDLE_PER_NODE requires built-in CPU idle
7470 	 * selection policy to be enabled.
7471 	 */
7472 	if ((ops->flags & SCX_OPS_BUILTIN_IDLE_PER_NODE) &&
7473 	    (ops->update_idle && !(ops->flags & SCX_OPS_KEEP_BUILTIN_IDLE))) {
7474 		scx_error(sch, "SCX_OPS_BUILTIN_IDLE_PER_NODE requires CPU idle selection enabled");
7475 		return -EINVAL;
7476 	}
7477 
7478 	/*
7479 	 * cid-form's struct is shorter and doesn't include the cpu_acquire /
7480 	 * cpu_release tail; reading those fields off a cid-form @ops would
7481 	 * run past the BPF allocation. Skip for cid-form.
7482 	 */
7483 	if (!sch->is_cid_type && (ops->cpu_acquire || ops->cpu_release))
7484 		pr_warn_ratelimited("ops->cpu_acquire/release() are deprecated, use sched_switch TP instead\n");
7485 
7486 	/*
7487 	 * Sub-scheduler support is tied to the cid-form struct_ops. A sub-sched
7488 	 * attaches through a cid-form-only interface (sub_attach/sub_detach),
7489 	 * and a root that accepts sub-scheds must expose cid-form state to
7490 	 * them. Reject cpu-form schedulers on either side.
7491 	 */
7492 	if (!sch->is_cid_type) {
7493 		if (scx_parent(sch)) {
7494 			scx_error(sch, "sub-sched requires cid-form struct_ops");
7495 			return -EINVAL;
7496 		}
7497 		if (ops->sub_attach || ops->sub_detach) {
7498 			scx_error(sch, "sub_attach/sub_detach requires cid-form struct_ops");
7499 			return -EINVAL;
7500 		}
7501 	}
7502 
7503 	return 0;
7504 }
7505 
scx_root_enable_workfn(struct kthread_work * work)7506 static void scx_root_enable_workfn(struct kthread_work *work)
7507 {
7508 	struct scx_enable_cmd *cmd = container_of(work, struct scx_enable_cmd, work);
7509 	struct sched_ext_ops *ops = cmd->ops;
7510 	struct cgroup *cgrp = root_cgroup();
7511 	struct scx_sched *sch;
7512 	struct scx_task_iter sti;
7513 	struct task_struct *p;
7514 	int i, cpu, ret;
7515 
7516 	mutex_lock(&scx_enable_mutex);
7517 
7518 	if (scx_enable_state() != SCX_DISABLED) {
7519 		ret = -EBUSY;
7520 		goto err_unlock;
7521 	}
7522 
7523 	/*
7524 	 * @ops->priv binds @ops to its scx_sched instance. It is set here by
7525 	 * scx_alloc_and_add_sched() and cleared at the tail of bpf_scx_unreg(),
7526 	 * which runs after scx_root_disable() has dropped scx_enable_mutex. If
7527 	 * it's still non-NULL here, a previous attachment on @ops has not
7528 	 * finished tearing down; proceeding would let the in-flight unreg's
7529 	 * RCU_INIT_POINTER(NULL) clobber the @ops->priv we are about to assign.
7530 	 */
7531 	if (rcu_access_pointer(ops->priv)) {
7532 		ret = -EBUSY;
7533 		goto err_unlock;
7534 	}
7535 
7536 	ret = alloc_kick_syncs();
7537 	if (ret)
7538 		goto err_unlock;
7539 
7540 	if (ops->flags & SCX_OPS_TID_TO_TASK) {
7541 		ret = rhashtable_init(&scx_tid_hash, &scx_tid_hash_params);
7542 		if (ret)
7543 			goto err_free_ksyncs;
7544 	}
7545 
7546 #ifdef CONFIG_EXT_SUB_SCHED
7547 	cgroup_get(cgrp);
7548 #endif
7549 	/*
7550 	 * Transition to ENABLING to arm the disable path. Allocation failure
7551 	 * still unwinds locally. Full disabling on failure applies only after
7552 	 * scx_alloc_and_add_sched() succeeds.
7553 	 */
7554 	WARN_ON_ONCE(scx_set_enable_state(SCX_ENABLING) != SCX_DISABLED);
7555 	WARN_ON_ONCE(scx_root);
7556 
7557 	sch = scx_alloc_and_add_sched(cmd, cgrp, NULL);
7558 	if (IS_ERR(sch)) {
7559 		ret = PTR_ERR(sch);
7560 		WARN_ON_ONCE(scx_set_enable_state(SCX_DISABLED) != SCX_ENABLING);
7561 		goto err_free_tid_hash;
7562 	}
7563 
7564 	if (sch->is_cid_type)
7565 		static_branch_enable(&__scx_is_cid_type);
7566 
7567 	atomic_long_set(&scx_nr_rejected, 0);
7568 
7569 	for_each_possible_cpu(cpu) {
7570 		struct rq *rq = cpu_rq(cpu);
7571 
7572 		rq->scx.local_dsq.sched = sch;
7573 		rq->scx.cpuperf_target = SCX_CPUPERF_ONE;
7574 	}
7575 
7576 	scx_discard_stale_ecaps_syncs();
7577 	scx_rescue_set_knobs(sch);
7578 
7579 	/*
7580 	 * Keep CPUs stable during enable so that the BPF scheduler can track
7581 	 * online CPUs by watching ->on/offline_cpu() after ->init().
7582 	 */
7583 	cpus_read_lock();
7584 
7585 	/*
7586 	 * Build the cid mapping into a private under-construction set. It
7587 	 * becomes visible to readers only through scx_cid_publish_tables() once
7588 	 * ops.init_cids() has finalized the layout.
7589 	 */
7590 	ret = scx_cid_init(sch);
7591 	if (ret) {
7592 		cpus_read_unlock();
7593 		goto err_disable;
7594 	}
7595 
7596 	/*
7597 	 * Make the scheduler instance visible. Must be inside cpus_read_lock().
7598 	 * See handle_hotplug().
7599 	 */
7600 	rcu_assign_pointer(scx_root, sch);
7601 
7602 	ret = scx_link_sched(sch);
7603 	if (ret) {
7604 		cpus_read_unlock();
7605 		goto err_disable;
7606 	}
7607 
7608 	scx_idle_enable(ops);
7609 
7610 	/*
7611 	 * A cid-form scheduler finalizes its cid layout in ops.init_cids(),
7612 	 * which may call scx_bpf_cid_override(). Run it before the caps and
7613 	 * shard state are built so the final layout is in effect.
7614 	 */
7615 	if (sch->is_cid_type && sch->ops_cid.init_cids) {
7616 		ret = SCX_CALL_OP_RET(sch, init_cids, NULL);
7617 		if (ret) {
7618 			ret = scx_ops_sanitize_err(sch, "init_cids", ret);
7619 			cpus_read_unlock();
7620 			scx_error(sch, "ops.init_cids() failed (%d)", ret);
7621 			goto err_disable;
7622 		}
7623 	}
7624 
7625 	/* the cid layout is final, expose it to readers */
7626 	scx_cid_publish_tables();
7627 
7628 	ret = scx_arena_pool_init(sch);
7629 	if (ret) {
7630 		cpus_read_unlock();
7631 		goto err_disable;
7632 	}
7633 
7634 	ret = scx_alloc_kern_arena_objs(sch);
7635 	if (ret) {
7636 		cpus_read_unlock();
7637 		goto err_disable;
7638 	}
7639 
7640 	ret = scx_alloc_pshards(sch);
7641 	if (ret) {
7642 		cpus_read_unlock();
7643 		goto err_disable;
7644 	}
7645 
7646 	scx_init_root_caps(sch);
7647 
7648 	/* the cid caps and shards are live now, so ops.init() can query them */
7649 	if (sch->ops.init) {
7650 		ret = SCX_CALL_OP_RET(sch, init, NULL);
7651 		if (ret) {
7652 			ret = scx_ops_sanitize_err(sch, "init", ret);
7653 			cpus_read_unlock();
7654 			scx_error(sch, "ops.init() failed (%d)", ret);
7655 			goto err_disable;
7656 		}
7657 		sch->exit_info->flags |= SCX_EFLAG_INITIALIZED;
7658 	}
7659 
7660 	ret = scx_sched_sysfs_add(sch);
7661 	if (ret) {
7662 		cpus_read_unlock();
7663 		goto err_disable;
7664 	}
7665 
7666 	for (i = SCX_OPI_CPU_HOTPLUG_BEGIN; i < SCX_OPI_CPU_HOTPLUG_END; i++)
7667 		if (((void (**)(void))ops)[i])
7668 			set_bit(i, sch->has_op);
7669 
7670 	ret = check_hotplug_seq(sch, ops);
7671 	if (ret) {
7672 		cpus_read_unlock();
7673 		goto err_disable;
7674 	}
7675 	scx_idle_update_selcpu_topology(ops);
7676 
7677 	cpus_read_unlock();
7678 
7679 	ret = scx_validate_ops(sch, ops);
7680 	if (ret)
7681 		goto err_disable;
7682 
7683 	/*
7684 	 * Attach the ext_server bandwidth reservation before anything is
7685 	 * committed so that we can fail the enable if the root domain cannot
7686 	 * accommodate it. The matching fair_server detach is deferred to the
7687 	 * tail of this function, after the switch is fully committed and can no
7688 	 * longer fail.
7689 	 *
7690 	 * On failure, err_disable funnels into scx_root_disable() which
7691 	 * detaches ext_server, so partially-attached state is cleaned up
7692 	 * automatically.
7693 	 */
7694 	for_each_possible_cpu(cpu) {
7695 		struct rq *rq = cpu_rq(cpu);
7696 
7697 		scoped_guard(rq_lock_irqsave, rq) {
7698 			update_rq_clock(rq);
7699 			ret = dl_server_attach_bw(&rq->ext_server);
7700 		}
7701 		if (ret) {
7702 			pr_warn("sched_ext: failed to attach ext_server on CPU %d (%d)\n",
7703 				cpu, ret);
7704 			goto err_disable;
7705 		}
7706 	}
7707 
7708 	/*
7709 	 * Once __scx_enabled is set, %current can be switched to SCX anytime.
7710 	 * This can lead to stalls as some BPF schedulers (e.g. userspace
7711 	 * scheduling) may not function correctly before all tasks are switched.
7712 	 * Init in bypass mode to guarantee forward progress.
7713 	 */
7714 	scx_bypass(sch, true);
7715 
7716 	for (i = SCX_OPI_NORMAL_BEGIN; i < SCX_OPI_NORMAL_END; i++)
7717 		if (((void (**)(void))ops)[i])
7718 			set_bit(i, sch->has_op);
7719 
7720 	if (sch->ops.cpu_acquire || sch->ops.cpu_release)
7721 		sch->ops.flags |= SCX_OPS_HAS_CPU_PREEMPT;
7722 
7723 	/*
7724 	 * Lock out forks, cgroup on/offlining and moves before opening the
7725 	 * floodgate so that they don't wander into the operations prematurely.
7726 	 */
7727 	percpu_down_write(&scx_fork_rwsem);
7728 
7729 	WARN_ON_ONCE(scx_init_task_enabled);
7730 	scx_init_task_enabled = true;
7731 
7732 	/* flip under fork_rwsem; the iter below covers existing tasks */
7733 	if (ops->flags & SCX_OPS_TID_TO_TASK)
7734 		static_branch_enable(&__scx_tid_to_task_enabled);
7735 
7736 	/*
7737 	 * Enable ops for every task. Fork is excluded by scx_fork_rwsem
7738 	 * preventing new tasks from being added. No need to exclude tasks
7739 	 * leaving as sched_ext_dead() can handle both prepped and enabled
7740 	 * tasks. Prep all tasks first and then enable them with preemption
7741 	 * disabled.
7742 	 *
7743 	 * All cgroups should be initialized before scx_init_task() so that the
7744 	 * BPF scheduler can reliably track each task's cgroup membership from
7745 	 * scx_init_task(). Lock out cgroup on/offlining and task migrations
7746 	 * while tasks are being initialized so that scx_cgroup_can_attach()
7747 	 * never sees uninitialized tasks.
7748 	 */
7749 	scx_cgroup_lock();
7750 	set_cgroup_sched(sch_cgroup(sch), sch);
7751 	ret = scx_cgroup_init(sch);
7752 	if (ret)
7753 		goto err_disable_unlock_all;
7754 
7755 	WARN_ON_ONCE(scx_cgroup_enabled);
7756 	scx_cgroup_enabled = true;
7757 
7758 	scx_task_iter_start(&sti, NULL);
7759 	while ((p = scx_task_iter_next_locked(&sti))) {
7760 		/*
7761 		 * @p is in scx_tasks under scx_tasks_lock, and SCX_TASK_DEAD
7762 		 * tasks are filtered by scx_task_iter_next_locked().
7763 		 * sched_ext_dead() removes @p from scx_tasks under the same
7764 		 * lock before put_task_struct_rcu_user() runs, so @p->usage
7765 		 * is guaranteed > 0 here.
7766 		 */
7767 		get_task_struct(p);
7768 
7769 		/*
7770 		 * Set %INIT_BEGIN under the iter's rq lock so that a concurrent
7771 		 * sched_ext_dead() does not call ops.exit_task() on @p while
7772 		 * ops.init_task() is running. If sched_ext_dead() runs before
7773 		 * this store, it has already removed @p from scx_tasks and the
7774 		 * iter won't visit @p; if it runs after, it observes
7775 		 * %INIT_BEGIN and transitions to %DEAD without calling ops,
7776 		 * leaving the post-init recheck below to unwind.
7777 		 */
7778 		scx_set_task_state(p, SCX_TASK_INIT_BEGIN);
7779 		scx_task_iter_unlock(&sti);
7780 
7781 		ret = __scx_init_task(sch, p, NULL, false);
7782 
7783 		scx_task_iter_relock(&sti, p);
7784 
7785 		if (unlikely(ret)) {
7786 			if (scx_get_task_state(p) != SCX_TASK_DEAD)
7787 				scx_set_task_state(p, SCX_TASK_NONE);
7788 			scx_task_iter_stop(&sti);
7789 			scx_error(sch, "ops.init_task() failed (%d) for %s[%d]",
7790 				  ret, p->comm, p->pid);
7791 			put_task_struct(p);
7792 			goto err_disable_unlock_all;
7793 		}
7794 
7795 		if (scx_get_task_state(p) == SCX_TASK_DEAD) {
7796 			/*
7797 			 * sched_ext_dead() observed %INIT_BEGIN and set %DEAD.
7798 			 * ops.exit_task() is owed to the sched __scx_init_task()
7799 			 * ran against; call it now.
7800 			 */
7801 			scx_sub_init_cancel_task(sch, p);
7802 		} else {
7803 			scx_set_task_state(p, SCX_TASK_INIT);
7804 			scx_set_task_sched(p, sch);
7805 			scx_set_task_state(p, SCX_TASK_READY);
7806 		}
7807 
7808 		/*
7809 		 * Insert into the tid hash. scx_tasks_lock is held by the iter;
7810 		 * list_empty() guards against sched_ext_dead() having taken @p
7811 		 * off the list while init ran unlocked.
7812 		 */
7813 		if (scx_tid_to_task_enabled() && !list_empty(&p->scx.tasks_node))
7814 			scx_tid_hash_insert(p);
7815 
7816 		put_task_struct(p);
7817 	}
7818 	scx_task_iter_stop(&sti);
7819 	scx_cgroup_unlock();
7820 	percpu_up_write(&scx_fork_rwsem);
7821 
7822 	/*
7823 	 * All tasks are READY. It's safe to turn on scx_enabled() and switch
7824 	 * all eligible tasks.
7825 	 */
7826 	WRITE_ONCE(scx_switching_all, !(ops->flags & SCX_OPS_SWITCH_PARTIAL));
7827 	static_branch_enable(&__scx_enabled);
7828 
7829 	/*
7830 	 * We're fully committed and can't fail. The task READY -> ENABLED
7831 	 * transitions here are synchronized against sched_ext_dead() through
7832 	 * scx_tasks_lock.
7833 	 */
7834 	percpu_down_write(&scx_fork_rwsem);
7835 	scx_task_iter_start(&sti, NULL);
7836 	while ((p = scx_task_iter_next_locked(&sti))) {
7837 		unsigned int queue_flags = DEQUEUE_SAVE | DEQUEUE_MOVE;
7838 		const struct sched_class *old_class = p->sched_class;
7839 		const struct sched_class *new_class = scx_setscheduler_class(p);
7840 
7841 		if (scx_get_task_state(p) != SCX_TASK_READY)
7842 			continue;
7843 
7844 		if (old_class != new_class)
7845 			queue_flags |= DEQUEUE_CLASS;
7846 
7847 		scoped_guard (sched_change, p, queue_flags) {
7848 			scx_set_task_slice(p, READ_ONCE(sch->slice_dfl));
7849 			p->sched_class = new_class;
7850 		}
7851 	}
7852 	scx_task_iter_stop(&sti);
7853 	percpu_up_write(&scx_fork_rwsem);
7854 
7855 	scx_bypass(sch, false);
7856 
7857 	if (!scx_tryset_enable_state(SCX_ENABLED, SCX_ENABLING)) {
7858 		WARN_ON_ONCE(atomic_read(&sch->exit_kind) == SCX_EXIT_NONE);
7859 		ret = -EBUSY;
7860 		goto err_disable;
7861 	}
7862 
7863 	if (!(ops->flags & SCX_OPS_SWITCH_PARTIAL))
7864 		static_branch_enable(&__scx_switched_all);
7865 
7866 	/*
7867 	 * Detach the fair_server bandwidth reservation now that the switch
7868 	 * is fully committed. In full mode (!SCX_OPS_SWITCH_PARTIAL) no
7869 	 * task will ever run in the fair class, so give that bandwidth
7870 	 * back to the RT class. The matching ext_server attach already
7871 	 * happened earlier; this only releases bandwidth and cannot fail.
7872 	 *
7873 	 * In partial mode keep fair_server attached.
7874 	 */
7875 	if (scx_switched_all()) {
7876 		for_each_possible_cpu(cpu) {
7877 			struct rq *rq = cpu_rq(cpu);
7878 
7879 			guard(rq_lock_irqsave)(rq);
7880 			update_rq_clock(rq);
7881 			dl_server_detach_bw(&rq->fair_server);
7882 		}
7883 	}
7884 
7885 	pr_info("sched_ext: BPF scheduler \"%s\" enabled%s\n",
7886 		sch->ops.name, scx_switched_all() ? "" : " (partial)");
7887 	kobject_uevent(&sch->kobj, KOBJ_ADD);
7888 	mutex_unlock(&scx_enable_mutex);
7889 
7890 	atomic_long_inc(&scx_enable_seq);
7891 
7892 	cmd->ret = 0;
7893 	return;
7894 
7895 err_free_tid_hash:
7896 	if (ops->flags & SCX_OPS_TID_TO_TASK)
7897 		rhashtable_free_and_destroy(&scx_tid_hash, NULL, NULL);
7898 err_free_ksyncs:
7899 	free_kick_syncs();
7900 err_unlock:
7901 	mutex_unlock(&scx_enable_mutex);
7902 	cmd->ret = ret;
7903 	return;
7904 
7905 err_disable_unlock_all:
7906 	scx_cgroup_unlock();
7907 	percpu_up_write(&scx_fork_rwsem);
7908 	/* we'll soon enter disable path, keep bypass on */
7909 err_disable:
7910 	mutex_unlock(&scx_enable_mutex);
7911 	/*
7912 	 * Returning an error code here would not pass all the error information
7913 	 * to userspace. Record errno using scx_error() for cases scx_error()
7914 	 * wasn't already invoked and exit indicating success so that the error
7915 	 * is notified through ops.exit() with all the details.
7916 	 *
7917 	 * Flush scx_disable_work to ensure that error is reported before init
7918 	 * completion. sch's base reference will be put by bpf_scx_unreg().
7919 	 */
7920 	scx_error(sch, "scx_root_enable() failed (%d)", ret);
7921 	scx_flush_disable_work(sch);
7922 	cmd->ret = 0;
7923 }
7924 
scx_enable(struct scx_enable_cmd * cmd,struct bpf_link * link)7925 static s32 scx_enable(struct scx_enable_cmd *cmd, struct bpf_link *link)
7926 {
7927 	static struct kthread_worker *helper;
7928 	static DEFINE_MUTEX(helper_mutex);
7929 
7930 	if (housekeeping_enabled(HK_TYPE_DOMAIN_BOOT)) {
7931 		pr_err("sched_ext: Not compatible with \"isolcpus=\" domain isolation\n");
7932 		return -EINVAL;
7933 	}
7934 
7935 	if (!READ_ONCE(helper)) {
7936 		mutex_lock(&helper_mutex);
7937 		if (!helper) {
7938 			struct kthread_worker *w =
7939 				kthread_run_worker(0, "scx_enable_helper");
7940 			if (IS_ERR_OR_NULL(w)) {
7941 				mutex_unlock(&helper_mutex);
7942 				return -ENOMEM;
7943 			}
7944 			sched_set_fifo(w->task);
7945 			WRITE_ONCE(helper, w);
7946 		}
7947 		mutex_unlock(&helper_mutex);
7948 	}
7949 
7950 #ifdef CONFIG_EXT_SUB_SCHED
7951 	if (cmd->ops->sub_cgroup_id > 1)
7952 		kthread_init_work(&cmd->work, scx_sub_enable_workfn);
7953 	else
7954 #endif	/* CONFIG_EXT_SUB_SCHED */
7955 		kthread_init_work(&cmd->work, scx_root_enable_workfn);
7956 
7957 	kthread_queue_work(READ_ONCE(helper), &cmd->work);
7958 	kthread_flush_work(&cmd->work);
7959 	return cmd->ret;
7960 }
7961 
7962 
7963 /********************************************************************************
7964  * bpf_struct_ops plumbing.
7965  */
7966 #include <linux/bpf_verifier.h>
7967 #include <linux/bpf.h>
7968 #include <linux/btf.h>
7969 
7970 static const struct btf_type *task_struct_type;
7971 
bpf_scx_is_valid_access(int off,int size,enum bpf_access_type type,const struct bpf_prog * prog,struct bpf_insn_access_aux * info)7972 static bool bpf_scx_is_valid_access(int off, int size,
7973 				    enum bpf_access_type type,
7974 				    const struct bpf_prog *prog,
7975 				    struct bpf_insn_access_aux *info)
7976 {
7977 	if (type != BPF_READ)
7978 		return false;
7979 	if (off < 0 || off >= sizeof(__u64) * MAX_BPF_FUNC_ARGS)
7980 		return false;
7981 	if (off % size != 0)
7982 		return false;
7983 
7984 	return btf_ctx_access(off, size, type, prog, info);
7985 }
7986 
7987 /* common to both forms: only scx.disallow is writable */
bpf_scx_btf_struct_access_common(const struct bpf_reg_state * reg,int off,int size)7988 static int bpf_scx_btf_struct_access_common(const struct bpf_reg_state *reg,
7989 					    int off, int size)
7990 {
7991 	const struct btf_type *t;
7992 
7993 	t = btf_type_by_id(reg->btf, reg->btf_id);
7994 	if (t == task_struct_type &&
7995 	    off >= offsetof(struct task_struct, scx.disallow) &&
7996 	    off + size <= offsetofend(struct task_struct, scx.disallow))
7997 		return SCALAR_VALUE;
7998 
7999 	return -EACCES;
8000 }
8001 
bpf_scx_btf_struct_access(struct bpf_verifier_log * log,const struct bpf_reg_state * reg,int off,int size)8002 static int bpf_scx_btf_struct_access(struct bpf_verifier_log *log,
8003 				     const struct bpf_reg_state *reg, int off,
8004 				     int size)
8005 {
8006 	const struct btf_type *t;
8007 
8008 	t = btf_type_by_id(reg->btf, reg->btf_id);
8009 	if (t == task_struct_type) {
8010 		if ((off >= offsetof(struct task_struct, scx.slice) &&
8011 		     off + size <= offsetofend(struct task_struct, scx.slice)) ||
8012 		    (off >= offsetof(struct task_struct, scx.dsq_vtime) &&
8013 		     off + size <= offsetofend(struct task_struct, scx.dsq_vtime)))
8014 			return SCALAR_VALUE;
8015 	}
8016 
8017 	return bpf_scx_btf_struct_access_common(reg, off, size);
8018 }
8019 
8020 /* cid-form rejects direct slice and dsq_vtime writes in favor of the kfuncs */
bpf_scx_cid_btf_struct_access(struct bpf_verifier_log * log,const struct bpf_reg_state * reg,int off,int size)8021 static int bpf_scx_cid_btf_struct_access(struct bpf_verifier_log *log,
8022 					 const struct bpf_reg_state *reg, int off,
8023 					 int size)
8024 {
8025 	return bpf_scx_btf_struct_access_common(reg, off, size);
8026 }
8027 
8028 static const struct bpf_verifier_ops bpf_scx_verifier_ops = {
8029 	.get_func_proto = bpf_base_func_proto,
8030 	.is_valid_access = bpf_scx_is_valid_access,
8031 	.btf_struct_access = bpf_scx_btf_struct_access,
8032 };
8033 
8034 static const struct bpf_verifier_ops bpf_scx_cid_verifier_ops = {
8035 	.get_func_proto = bpf_base_func_proto,
8036 	.is_valid_access = bpf_scx_is_valid_access,
8037 	.btf_struct_access = bpf_scx_cid_btf_struct_access,
8038 };
8039 
bpf_scx_init_member(const struct btf_type * t,const struct btf_member * member,void * kdata,const void * udata)8040 static int bpf_scx_init_member(const struct btf_type *t,
8041 			       const struct btf_member *member,
8042 			       void *kdata, const void *udata)
8043 {
8044 	const struct sched_ext_ops *uops = udata;
8045 	struct sched_ext_ops *ops = kdata;
8046 	u32 moff = __btf_member_bit_offset(t, member) / 8;
8047 	int ret;
8048 
8049 	switch (moff) {
8050 	case offsetof(struct sched_ext_ops, dispatch_max_batch):
8051 		if (*(u32 *)(udata + moff) > INT_MAX)
8052 			return -E2BIG;
8053 		ops->dispatch_max_batch = *(u32 *)(udata + moff);
8054 		return 1;
8055 	case offsetof(struct sched_ext_ops, flags):
8056 		if (*(u64 *)(udata + moff) & ~SCX_OPS_ALL_FLAGS)
8057 			return -EINVAL;
8058 		ops->flags = *(u64 *)(udata + moff);
8059 		return 1;
8060 	case offsetof(struct sched_ext_ops, name):
8061 		ret = bpf_obj_name_cpy(ops->name, uops->name,
8062 				       sizeof(ops->name));
8063 		if (ret < 0)
8064 			return ret;
8065 		if (ret == 0)
8066 			return -EINVAL;
8067 		return 1;
8068 	case offsetof(struct sched_ext_ops, timeout_ms):
8069 		if (msecs_to_jiffies(*(u32 *)(udata + moff)) >
8070 		    SCX_WATCHDOG_MAX_TIMEOUT)
8071 			return -E2BIG;
8072 		ops->timeout_ms = *(u32 *)(udata + moff);
8073 		return 1;
8074 	case offsetof(struct sched_ext_ops, exit_dump_len):
8075 		ops->exit_dump_len =
8076 			*(u32 *)(udata + moff) ?: SCX_EXIT_DUMP_DFL_LEN;
8077 		return 1;
8078 	case offsetof(struct sched_ext_ops, hotplug_seq):
8079 		ops->hotplug_seq = *(u64 *)(udata + moff);
8080 		return 1;
8081 	case offsetof(struct sched_ext_ops, cid_shard_size):
8082 		ops->cid_shard_size = *(u32 *)(udata + moff);
8083 		return 1;
8084 	case offsetof(struct sched_ext_ops, rescue_bandwidth_ppt): {
8085 		u32 bw_ppt = *(u32 *)(udata + moff);
8086 
8087 		if (bw_ppt > SCX_RESCUE_MAX_BW_PPT && bw_ppt != SCX_RESCUE_DISABLE)
8088 			return -E2BIG;
8089 		ops->rescue_bandwidth_ppt = bw_ppt;
8090 		return 1;
8091 	}
8092 	case offsetof(struct sched_ext_ops, rescue_quantum_us): {
8093 		u32 quantum_us = *(u32 *)(udata + moff);
8094 
8095 		if (quantum_us > SCX_RESCUE_MAX_QUANTUM_US)
8096 			return -E2BIG;
8097 		if (quantum_us && quantum_us < SCX_RESCUE_MIN_QUANTUM_US)
8098 			return -EINVAL;
8099 		ops->rescue_quantum_us = quantum_us;
8100 		return 1;
8101 	}
8102 #ifdef CONFIG_EXT_SUB_SCHED
8103 	case offsetof(struct sched_ext_ops, sub_cgroup_id):
8104 		ops->sub_cgroup_id = *(u64 *)(udata + moff);
8105 		return 1;
8106 #endif	/* CONFIG_EXT_SUB_SCHED */
8107 	}
8108 
8109 	return 0;
8110 }
8111 
bpf_scx_check_member(const struct btf_type * t,const struct btf_member * member,const struct bpf_prog * prog)8112 static int bpf_scx_check_member(const struct btf_type *t,
8113 				const struct btf_member *member,
8114 				const struct bpf_prog *prog)
8115 {
8116 	u32 moff = __btf_member_bit_offset(t, member) / 8;
8117 
8118 	switch (moff) {
8119 	case offsetof(struct sched_ext_ops, init_task):
8120 #ifdef CONFIG_EXT_GROUP_SCHED
8121 	case offsetof(struct sched_ext_ops, cgroup_init):
8122 	case offsetof(struct sched_ext_ops, cgroup_exit):
8123 	case offsetof(struct sched_ext_ops, cgroup_prep_move):
8124 	case offsetof(struct sched_ext_ops, cgroup_set_bandwidth):
8125 #endif
8126 	case offsetof(struct sched_ext_ops, cpu_online):
8127 	case offsetof(struct sched_ext_ops, cpu_offline):
8128 	case offsetof(struct sched_ext_ops, init_cids):
8129 	case offsetof(struct sched_ext_ops, init):
8130 	case offsetof(struct sched_ext_ops, exit):
8131 	case offsetof(struct sched_ext_ops, sub_attach):
8132 	case offsetof(struct sched_ext_ops, sub_detach):
8133 		break;
8134 	default:
8135 		if (prog->sleepable)
8136 			return -EINVAL;
8137 	}
8138 
8139 #ifdef CONFIG_EXT_SUB_SCHED
8140 	/*
8141 	 * Enable private stack for operations that can nest along the
8142 	 * hierarchy.
8143 	 *
8144 	 * XXX - Ideally, we should only do this for scheds that allow
8145 	 * sub-scheds and sub-scheds themselves but I don't know how to access
8146 	 * struct_ops from here.
8147 	 */
8148 	switch (moff) {
8149 	case offsetof(struct sched_ext_ops, dispatch):
8150 		prog->aux->priv_stack_requested = true;
8151 		prog->aux->recursion_detected = scx_pstack_recursion_on_dispatch;
8152 		break;
8153 	case offsetof(struct sched_ext_ops, sub_caps_updated):
8154 		prog->aux->priv_stack_requested = true;
8155 		prog->aux->recursion_detected = scx_pstack_recursion_on_caps_updated;
8156 		break;
8157 	}
8158 #endif	/* CONFIG_EXT_SUB_SCHED */
8159 
8160 	return 0;
8161 }
8162 
bpf_scx_reg(void * kdata,struct bpf_link * link)8163 static int bpf_scx_reg(void *kdata, struct bpf_link *link)
8164 {
8165 	struct scx_enable_cmd cmd = { .ops = kdata };
8166 
8167 	return scx_enable(&cmd, link);
8168 }
8169 
8170 struct scx_arena_scan {
8171 	struct bpf_map	*arena;
8172 	int		err;
8173 };
8174 
8175 /*
8176  * The verifier enforces one arena per BPF program, so each struct_ops
8177  * member prog contributes at most one arena via bpf_prog_arena().
8178  * Require all non-NULL contributions to match.
8179  */
scx_arena_scan_prog(struct bpf_prog * prog,void * data)8180 static int scx_arena_scan_prog(struct bpf_prog *prog, void *data)
8181 {
8182 	struct scx_arena_scan *s = data;
8183 	struct bpf_map *arena = NULL;
8184 
8185 	/* arena.o, which defines these, is built only on MMU && 64BIT */
8186 #if defined(CONFIG_MMU) && defined(CONFIG_64BIT)
8187 	arena = bpf_prog_arena(prog);
8188 #endif
8189 	if (!arena)
8190 		return 0;
8191 	if (s->arena && s->arena != arena) {
8192 		s->err = -EINVAL;
8193 		return 1;
8194 	}
8195 	s->arena = arena;
8196 	return 0;
8197 }
8198 
bpf_scx_reg_cid(void * kdata,struct bpf_link * link)8199 static int bpf_scx_reg_cid(void *kdata, struct bpf_link *link)
8200 {
8201 	struct scx_enable_cmd cmd = { .ops_cid = kdata, .is_cid_type = true };
8202 	struct scx_arena_scan scan = {};
8203 	int ret;
8204 
8205 	bpf_struct_ops_for_each_prog(kdata, scx_arena_scan_prog, &scan);
8206 	if (scan.err) {
8207 		pr_err("sched_ext: cid-form scheduler uses multiple arena maps\n");
8208 		return scan.err;
8209 	}
8210 	if (!scan.arena) {
8211 		pr_err("sched_ext: cid-form scheduler must use a BPF arena map\n");
8212 		return -EINVAL;
8213 	}
8214 
8215 	bpf_map_inc(scan.arena);
8216 	cmd.arena_map = scan.arena;
8217 	ret = scx_enable(&cmd, link);
8218 	if (cmd.arena_map)		/* not consumed by scx_alloc_and_add_sched() */
8219 		bpf_map_put(cmd.arena_map);
8220 	return ret;
8221 }
8222 
bpf_scx_unreg(void * kdata,struct bpf_link * link)8223 static void bpf_scx_unreg(void *kdata, struct bpf_link *link)
8224 {
8225 	struct sched_ext_ops *ops = kdata;
8226 	struct scx_sched *sch = rcu_dereference_protected(ops->priv, true);
8227 
8228 	scx_disable(sch, SCX_EXIT_UNREG);
8229 	scx_flush_disable_work(sch);
8230 	RCU_INIT_POINTER(ops->priv, NULL);
8231 	kobject_put(&sch->kobj);
8232 }
8233 
bpf_scx_init(struct btf * btf)8234 static int bpf_scx_init(struct btf *btf)
8235 {
8236 	task_struct_type = btf_type_by_id(btf, btf_tracing_ids[BTF_TRACING_TYPE_TASK]);
8237 
8238 	return 0;
8239 }
8240 
bpf_scx_update(void * kdata,void * old_kdata,struct bpf_link * link)8241 static int bpf_scx_update(void *kdata, void *old_kdata, struct bpf_link *link)
8242 {
8243 	/*
8244 	 * sched_ext does not support updating the actively-loaded BPF
8245 	 * scheduler, as registering a BPF scheduler can always fail if the
8246 	 * scheduler returns an error code for e.g. ops.init(), ops.init_task(),
8247 	 * etc. Similarly, we can always race with unregistration happening
8248 	 * elsewhere, such as with sysrq.
8249 	 */
8250 	return -EOPNOTSUPP;
8251 }
8252 
bpf_scx_validate(void * kdata)8253 static int bpf_scx_validate(void *kdata)
8254 {
8255 	return 0;
8256 }
8257 
sched_ext_ops__select_cpu(struct task_struct * p,s32 prev_cpu,u64 wake_flags)8258 static s32 sched_ext_ops__select_cpu(struct task_struct *p, s32 prev_cpu, u64 wake_flags) { return -EINVAL; }
sched_ext_ops__enqueue(struct task_struct * p,u64 enq_flags)8259 static void sched_ext_ops__enqueue(struct task_struct *p, u64 enq_flags) {}
sched_ext_ops__dequeue(struct task_struct * p,u64 enq_flags)8260 static void sched_ext_ops__dequeue(struct task_struct *p, u64 enq_flags) {}
sched_ext_ops__dispatch(s32 prev_cpu,struct task_struct * prev__nullable)8261 static void sched_ext_ops__dispatch(s32 prev_cpu, struct task_struct *prev__nullable) {}
sched_ext_ops__tick(struct task_struct * p)8262 static void sched_ext_ops__tick(struct task_struct *p) {}
sched_ext_ops__runnable(struct task_struct * p,u64 enq_flags)8263 static void sched_ext_ops__runnable(struct task_struct *p, u64 enq_flags) {}
sched_ext_ops__running(struct task_struct * p)8264 static void sched_ext_ops__running(struct task_struct *p) {}
sched_ext_ops__stopping(struct task_struct * p,bool runnable)8265 static void sched_ext_ops__stopping(struct task_struct *p, bool runnable) {}
sched_ext_ops__quiescent(struct task_struct * p,u64 deq_flags)8266 static void sched_ext_ops__quiescent(struct task_struct *p, u64 deq_flags) {}
sched_ext_ops__yield(struct task_struct * from,struct task_struct * to__nullable)8267 static bool sched_ext_ops__yield(struct task_struct *from, struct task_struct *to__nullable) { return false; }
sched_ext_ops__core_sched_before(struct task_struct * a,struct task_struct * b)8268 static bool sched_ext_ops__core_sched_before(struct task_struct *a, struct task_struct *b) { return false; }
sched_ext_ops__set_weight(struct task_struct * p,u32 weight)8269 static void sched_ext_ops__set_weight(struct task_struct *p, u32 weight) {}
sched_ext_ops__set_cpumask(struct task_struct * p,const struct cpumask * mask)8270 static void sched_ext_ops__set_cpumask(struct task_struct *p, const struct cpumask *mask) {}
sched_ext_ops__update_idle(s32 cpu,bool idle)8271 static void sched_ext_ops__update_idle(s32 cpu, bool idle) {}
sched_ext_ops__cpu_acquire(s32 cpu,struct scx_cpu_acquire_args * args)8272 static void sched_ext_ops__cpu_acquire(s32 cpu, struct scx_cpu_acquire_args *args) {}
sched_ext_ops__cpu_release(s32 cpu,struct scx_cpu_release_args * args)8273 static void sched_ext_ops__cpu_release(s32 cpu, struct scx_cpu_release_args *args) {}
sched_ext_ops__init_task(struct task_struct * p,struct scx_init_task_args * args)8274 static s32 sched_ext_ops__init_task(struct task_struct *p, struct scx_init_task_args *args) { return -EINVAL; }
sched_ext_ops__exit_task(struct task_struct * p,struct scx_exit_task_args * args)8275 static void sched_ext_ops__exit_task(struct task_struct *p, struct scx_exit_task_args *args) {}
sched_ext_ops__enable(struct task_struct * p)8276 static void sched_ext_ops__enable(struct task_struct *p) {}
sched_ext_ops__disable(struct task_struct * p)8277 static void sched_ext_ops__disable(struct task_struct *p) {}
8278 #ifdef CONFIG_EXT_GROUP_SCHED
sched_ext_ops__cgroup_init(struct cgroup * cgrp,struct scx_cgroup_init_args * args)8279 static s32 sched_ext_ops__cgroup_init(struct cgroup *cgrp, struct scx_cgroup_init_args *args) { return -EINVAL; }
sched_ext_ops__cgroup_exit(struct cgroup * cgrp)8280 static void sched_ext_ops__cgroup_exit(struct cgroup *cgrp) {}
sched_ext_ops__cgroup_prep_move(struct task_struct * p,struct cgroup * from,struct cgroup * to)8281 static s32 sched_ext_ops__cgroup_prep_move(struct task_struct *p, struct cgroup *from, struct cgroup *to) { return -EINVAL; }
sched_ext_ops__cgroup_move(struct task_struct * p,struct cgroup * from,struct cgroup * to)8282 static void sched_ext_ops__cgroup_move(struct task_struct *p, struct cgroup *from, struct cgroup *to) {}
sched_ext_ops__cgroup_cancel_move(struct task_struct * p,struct cgroup * from,struct cgroup * to)8283 static void sched_ext_ops__cgroup_cancel_move(struct task_struct *p, struct cgroup *from, struct cgroup *to) {}
sched_ext_ops__cgroup_set_weight(struct cgroup * cgrp,u32 weight)8284 static void sched_ext_ops__cgroup_set_weight(struct cgroup *cgrp, u32 weight) {}
sched_ext_ops__cgroup_set_bandwidth(struct cgroup * cgrp,u64 period_us,u64 quota_us,u64 burst_us)8285 static void sched_ext_ops__cgroup_set_bandwidth(struct cgroup *cgrp, u64 period_us, u64 quota_us, u64 burst_us) {}
sched_ext_ops__cgroup_set_idle(struct cgroup * cgrp,bool idle)8286 static void sched_ext_ops__cgroup_set_idle(struct cgroup *cgrp, bool idle) {}
8287 #endif	/* CONFIG_EXT_GROUP_SCHED */
sched_ext_ops__sub_attach(struct scx_sub_attach_args * args)8288 static s32 sched_ext_ops__sub_attach(struct scx_sub_attach_args *args) { return -EINVAL; }
sched_ext_ops__sub_detach(struct scx_sub_detach_args * args)8289 static void sched_ext_ops__sub_detach(struct scx_sub_detach_args *args) {}
sched_ext_ops__cpu_online(s32 cpu)8290 static void sched_ext_ops__cpu_online(s32 cpu) {}
sched_ext_ops__cpu_offline(s32 cpu)8291 static void sched_ext_ops__cpu_offline(s32 cpu) {}
sched_ext_ops__init_cids(void)8292 static s32 sched_ext_ops__init_cids(void) { return -EINVAL; }
sched_ext_ops__init(void)8293 static s32 sched_ext_ops__init(void) { return -EINVAL; }
sched_ext_ops__exit(struct scx_exit_info * info)8294 static void sched_ext_ops__exit(struct scx_exit_info *info) {}
sched_ext_ops__dump(struct scx_dump_ctx * ctx)8295 static void sched_ext_ops__dump(struct scx_dump_ctx *ctx) {}
sched_ext_ops__dump_cpu(struct scx_dump_ctx * ctx,s32 cpu,bool idle)8296 static void sched_ext_ops__dump_cpu(struct scx_dump_ctx *ctx, s32 cpu, bool idle) {}
sched_ext_ops__dump_task(struct scx_dump_ctx * ctx,struct task_struct * p)8297 static void sched_ext_ops__dump_task(struct scx_dump_ctx *ctx, struct task_struct *p) {}
8298 
8299 static struct sched_ext_ops __bpf_ops_sched_ext_ops = {
8300 	.select_cpu		= sched_ext_ops__select_cpu,
8301 	.enqueue		= sched_ext_ops__enqueue,
8302 	.dequeue		= sched_ext_ops__dequeue,
8303 	.dispatch		= sched_ext_ops__dispatch,
8304 	.tick			= sched_ext_ops__tick,
8305 	.runnable		= sched_ext_ops__runnable,
8306 	.running		= sched_ext_ops__running,
8307 	.stopping		= sched_ext_ops__stopping,
8308 	.quiescent		= sched_ext_ops__quiescent,
8309 	.yield			= sched_ext_ops__yield,
8310 	.core_sched_before	= sched_ext_ops__core_sched_before,
8311 	.set_weight		= sched_ext_ops__set_weight,
8312 	.set_cpumask		= sched_ext_ops__set_cpumask,
8313 	.update_idle		= sched_ext_ops__update_idle,
8314 	.cpu_acquire		= sched_ext_ops__cpu_acquire,
8315 	.cpu_release		= sched_ext_ops__cpu_release,
8316 	.init_task		= sched_ext_ops__init_task,
8317 	.exit_task		= sched_ext_ops__exit_task,
8318 	.enable			= sched_ext_ops__enable,
8319 	.disable		= sched_ext_ops__disable,
8320 #ifdef CONFIG_EXT_GROUP_SCHED
8321 	.cgroup_init		= sched_ext_ops__cgroup_init,
8322 	.cgroup_exit		= sched_ext_ops__cgroup_exit,
8323 	.cgroup_prep_move	= sched_ext_ops__cgroup_prep_move,
8324 	.cgroup_move		= sched_ext_ops__cgroup_move,
8325 	.cgroup_cancel_move	= sched_ext_ops__cgroup_cancel_move,
8326 	.cgroup_set_weight	= sched_ext_ops__cgroup_set_weight,
8327 	.cgroup_set_bandwidth	= sched_ext_ops__cgroup_set_bandwidth,
8328 	.cgroup_set_idle	= sched_ext_ops__cgroup_set_idle,
8329 #endif
8330 	.sub_attach		= sched_ext_ops__sub_attach,
8331 	.sub_detach		= sched_ext_ops__sub_detach,
8332 	.cpu_online		= sched_ext_ops__cpu_online,
8333 	.cpu_offline		= sched_ext_ops__cpu_offline,
8334 	.init_cids		= sched_ext_ops__init_cids,
8335 	.init			= sched_ext_ops__init,
8336 	.exit			= sched_ext_ops__exit,
8337 	.dump			= sched_ext_ops__dump,
8338 	.dump_cpu		= sched_ext_ops__dump_cpu,
8339 	.dump_task		= sched_ext_ops__dump_task,
8340 };
8341 
8342 static struct bpf_struct_ops bpf_sched_ext_ops = {
8343 	.verifier_ops = &bpf_scx_verifier_ops,
8344 	.reg = bpf_scx_reg,
8345 	.unreg = bpf_scx_unreg,
8346 	.check_member = bpf_scx_check_member,
8347 	.init_member = bpf_scx_init_member,
8348 	.init = bpf_scx_init,
8349 	.update = bpf_scx_update,
8350 	.validate = bpf_scx_validate,
8351 	.name = "sched_ext_ops",
8352 	.owner = THIS_MODULE,
8353 	.cfi_stubs = &__bpf_ops_sched_ext_ops
8354 };
8355 
8356 /*
8357  * cid-form cfi stubs. Stubs whose signatures match the cpu-form (param types
8358  * identical, only param names differ across structs) are reused. Some need
8359  * fresh stubs, set_cmask due to an argument type difference and the sub-sched
8360  * notifiers because no cpu-form stub exists to reuse.
8361  */
sched_ext_ops_cid__set_cmask(struct task_struct * p,const struct scx_cmask * cmask__arena)8362 static void sched_ext_ops_cid__set_cmask(struct task_struct *p, const struct scx_cmask *cmask__arena) {}
sched_ext_ops__sub_caps_updated(const struct scx_cmask * cmask__arena,u64 caps)8363 static void sched_ext_ops__sub_caps_updated(const struct scx_cmask *cmask__arena, u64 caps) {}
sched_ext_ops__sub_ecaps_updated(s32 cid,u64 before,u64 after)8364 static void sched_ext_ops__sub_ecaps_updated(s32 cid, u64 before, u64 after) {}
8365 
8366 static struct sched_ext_ops_cid __bpf_ops_sched_ext_ops_cid = {
8367 	.select_cid		= sched_ext_ops__select_cpu,
8368 	.enqueue		= sched_ext_ops__enqueue,
8369 	.dequeue		= sched_ext_ops__dequeue,
8370 	.dispatch		= sched_ext_ops__dispatch,
8371 	.tick			= sched_ext_ops__tick,
8372 	.runnable		= sched_ext_ops__runnable,
8373 	.running		= sched_ext_ops__running,
8374 	.stopping		= sched_ext_ops__stopping,
8375 	.quiescent		= sched_ext_ops__quiescent,
8376 	.yield			= sched_ext_ops__yield,
8377 	.core_sched_before	= sched_ext_ops__core_sched_before,
8378 	.set_weight		= sched_ext_ops__set_weight,
8379 	.set_cmask		= sched_ext_ops_cid__set_cmask,
8380 	.update_idle		= sched_ext_ops__update_idle,
8381 	.init_task		= sched_ext_ops__init_task,
8382 	.exit_task		= sched_ext_ops__exit_task,
8383 	.enable			= sched_ext_ops__enable,
8384 	.disable		= sched_ext_ops__disable,
8385 #ifdef CONFIG_EXT_GROUP_SCHED
8386 	.cpuctl_init		= sched_ext_ops__cgroup_init,
8387 	.cpuctl_exit		= sched_ext_ops__cgroup_exit,
8388 	.cpuctl_prep_move	= sched_ext_ops__cgroup_prep_move,
8389 	.cpuctl_move		= sched_ext_ops__cgroup_move,
8390 	.cpuctl_cancel_move	= sched_ext_ops__cgroup_cancel_move,
8391 	.cpuctl_set_weight	= sched_ext_ops__cgroup_set_weight,
8392 	.cpuctl_set_bandwidth	= sched_ext_ops__cgroup_set_bandwidth,
8393 	.cpuctl_set_idle	= sched_ext_ops__cgroup_set_idle,
8394 #endif
8395 	.sub_attach		= sched_ext_ops__sub_attach,
8396 	.sub_detach		= sched_ext_ops__sub_detach,
8397 	.sub_caps_updated	= sched_ext_ops__sub_caps_updated,
8398 	.sub_ecaps_updated	= sched_ext_ops__sub_ecaps_updated,
8399 	.cid_online		= sched_ext_ops__cpu_online,
8400 	.cid_offline		= sched_ext_ops__cpu_offline,
8401 	.init_cids		= sched_ext_ops__init_cids,
8402 	.init			= sched_ext_ops__init,
8403 	.exit			= sched_ext_ops__exit,
8404 	.dump			= sched_ext_ops__dump,
8405 	.dump_cid		= sched_ext_ops__dump_cpu,
8406 	.dump_task		= sched_ext_ops__dump_task,
8407 };
8408 
8409 /*
8410  * The cid-form struct_ops shares all bpf_struct_ops hooks with the cpu form.
8411  * init_member, check_member, reg, unreg, etc. process kdata as the byte block
8412  * verified to match by the BUILD_BUG_ON checks in scx_init().
8413  */
8414 static struct bpf_struct_ops bpf_sched_ext_ops_cid = {
8415 	.verifier_ops = &bpf_scx_cid_verifier_ops,
8416 	.reg = bpf_scx_reg_cid,
8417 	.unreg = bpf_scx_unreg,
8418 	.check_member = bpf_scx_check_member,
8419 	.init_member = bpf_scx_init_member,
8420 	.init = bpf_scx_init,
8421 	.update = bpf_scx_update,
8422 	.validate = bpf_scx_validate,
8423 	.name = "sched_ext_ops_cid",
8424 	.owner = THIS_MODULE,
8425 	.cfi_stubs = &__bpf_ops_sched_ext_ops_cid
8426 };
8427 
8428 
8429 /********************************************************************************
8430  * System integration and init.
8431  */
8432 
sysrq_handle_sched_ext_reset(u8 key)8433 static void sysrq_handle_sched_ext_reset(u8 key)
8434 {
8435 	struct scx_sched *sch;
8436 
8437 	sch = rcu_dereference(scx_root);
8438 	if (likely(sch))
8439 		scx_disable(sch, SCX_EXIT_SYSRQ);
8440 	else
8441 		pr_info("sched_ext: BPF schedulers not loaded\n");
8442 }
8443 
8444 static const struct sysrq_key_op sysrq_sched_ext_reset_op = {
8445 	.handler	= sysrq_handle_sched_ext_reset,
8446 	.help_msg	= "reset-sched-ext(S)",
8447 	.action_msg	= "Disable sched_ext and revert all tasks to CFS",
8448 	.enable_mask	= SYSRQ_ENABLE_RTNICE,
8449 };
8450 
sysrq_handle_sched_ext_dump(u8 key)8451 static void sysrq_handle_sched_ext_dump(u8 key)
8452 {
8453 	struct scx_exit_info ei = {
8454 		.kind		= SCX_EXIT_NONE,
8455 		.exit_cpu	= -1,
8456 		.reason		= "SysRq-D",
8457 	};
8458 	struct scx_sched *sch;
8459 
8460 	list_for_each_entry_rcu(sch, &scx_sched_all, all)
8461 		scx_dump_state(sch, &ei, 0, false);
8462 }
8463 
8464 static const struct sysrq_key_op sysrq_sched_ext_dump_op = {
8465 	.handler	= sysrq_handle_sched_ext_dump,
8466 	.help_msg	= "dump-sched-ext(D)",
8467 	.action_msg	= "Trigger sched_ext debug dump",
8468 	.enable_mask	= SYSRQ_ENABLE_RTNICE,
8469 };
8470 
can_skip_idle_kick(struct rq * rq)8471 static bool can_skip_idle_kick(struct rq *rq)
8472 {
8473 	lockdep_assert_rq_held(rq);
8474 
8475 	/*
8476 	 * We can skip idle kicking if @rq is going to go through at least one
8477 	 * full SCX scheduling cycle before going idle. Just checking whether
8478 	 * curr is not idle is insufficient because we could be racing
8479 	 * dispatch_one() trying to pull the next task from a remote rq, which
8480 	 * may fail, and @rq may become idle afterwards.
8481 	 *
8482 	 * The race window is small and we don't and can't guarantee that @rq is
8483 	 * only kicked while idle anyway. Skip only when sure.
8484 	 */
8485 	return !is_idle_task(rq->curr) && !(rq->scx.flags & SCX_RQ_IN_DISPATCH);
8486 }
8487 
kick_one_cpu(s32 cpu,struct scx_sched_pcpu * pcpu,struct rq * this_rq,unsigned long * ksyncs)8488 static bool kick_one_cpu(s32 cpu, struct scx_sched_pcpu *pcpu, struct rq *this_rq,
8489 			 unsigned long *ksyncs)
8490 {
8491 	struct rq *rq = cpu_rq(cpu);
8492 	struct scx_rq *this_scx = &this_rq->scx;
8493 	const struct sched_class *cur_class;
8494 	bool should_wait = false;
8495 	bool kickable;
8496 	unsigned long flags;
8497 
8498 	raw_spin_rq_lock_irqsave(rq, flags);
8499 	cur_class = rq->curr->sched_class;
8500 
8501 	/*
8502 	 * During CPU hotplug, a CPU may depend on kicking itself to make
8503 	 * forward progress. Allow kicking self regardless of online state. If
8504 	 * @cpu is running a higher class task, we have no control over @cpu.
8505 	 * Skip kicking. A sub-sched lacking baseline access on @cid has no
8506 	 * business forcing a reschedule there - skip. This is the authoritative
8507 	 * cap check: ecaps is read here under @rq's lock.
8508 	 */
8509 	kickable = (cpu_online(cpu) || cpu == cpu_of(this_rq)) &&
8510 		   !sched_class_above(cur_class, &ext_sched_class);
8511 
8512 	if (kickable && !scx_missing_caps(pcpu->sch, cpu, SCX_CAP_BASE)) {
8513 		if (cpumask_test_cpu(cpu, pcpu->cpus_to_preempt)) {
8514 			if (cur_class == &ext_sched_class) {
8515 				u64 caps = scx_caps_for_preempt(pcpu->sch, rq, 0);
8516 
8517 				if (unlikely(scx_missing_caps(pcpu->sch, cpu, caps)))
8518 					__scx_add_event(pcpu->sch, SCX_EV_SUB_PREEMPT_DENIED, 1);
8519 				else if (unlikely(!scx_set_task_slice(rq->curr, 0)))
8520 					__scx_add_event(pcpu->sch, SCX_EV_SLICE_DENIED, 1);
8521 			}
8522 			cpumask_clear_cpu(cpu, pcpu->cpus_to_preempt);
8523 		}
8524 
8525 		if (cpumask_test_cpu(cpu, pcpu->cpus_to_wait)) {
8526 			if (cur_class == &ext_sched_class) {
8527 				cpumask_set_cpu(cpu, this_scx->cpus_to_sync);
8528 				ksyncs[cpu] = rq->scx.kick_sync;
8529 				should_wait = true;
8530 			}
8531 			cpumask_clear_cpu(cpu, pcpu->cpus_to_wait);
8532 		}
8533 
8534 		resched_curr(rq);
8535 	} else {
8536 		/* a kickable cpu was skipped solely for the missing caps */
8537 		if (kickable)
8538 			__scx_add_event(pcpu->sch, SCX_EV_SUB_KICK_DENIED, 1);
8539 		cpumask_clear_cpu(cpu, pcpu->cpus_to_preempt);
8540 		cpumask_clear_cpu(cpu, pcpu->cpus_to_wait);
8541 	}
8542 
8543 	scx_rq_lock_drop(rq);
8544 	raw_spin_rq_unlock_irqrestore(rq, flags);
8545 
8546 	return should_wait;
8547 }
8548 
kick_one_cpu_if_idle(s32 cpu,struct scx_sched_pcpu * pcpu,struct rq * this_rq)8549 static void kick_one_cpu_if_idle(s32 cpu, struct scx_sched_pcpu *pcpu,
8550 				 struct rq *this_rq)
8551 {
8552 	struct rq *rq = cpu_rq(cpu);
8553 	unsigned long flags;
8554 
8555 	raw_spin_rq_lock_irqsave(rq, flags);
8556 
8557 	/* idle kicks need baseline access too, see kick_one_cpu() */
8558 	if (!can_skip_idle_kick(rq) &&
8559 	    (cpu_online(cpu) || cpu == cpu_of(this_rq))) {
8560 		if (likely(!scx_missing_caps(pcpu->sch, cpu, SCX_CAP_BASE)))
8561 			resched_curr(rq);
8562 		else
8563 			__scx_add_event(pcpu->sch, SCX_EV_SUB_KICK_DENIED, 1);
8564 	}
8565 
8566 	scx_rq_lock_drop(rq);
8567 	raw_spin_rq_unlock_irqrestore(rq, flags);
8568 }
8569 
kick_cpus_irq_workfn(struct irq_work * irq_work)8570 static void kick_cpus_irq_workfn(struct irq_work *irq_work)
8571 {
8572 	struct rq *this_rq = this_rq();
8573 	struct scx_rq *this_scx = &this_rq->scx;
8574 	struct scx_kick_syncs __rcu *ksyncs_pcpu = __this_cpu_read(scx_kick_syncs);
8575 	struct scx_sched_pcpu *pcpu, *tmp;
8576 	bool should_wait = false;
8577 	unsigned long *ksyncs;
8578 	s32 cpu;
8579 
8580 	/* can race with free_kick_syncs() during scheduler disable */
8581 	if (unlikely(!ksyncs_pcpu))
8582 		return;
8583 
8584 	ksyncs = rcu_dereference_bh(ksyncs_pcpu)->syncs;
8585 
8586 	/*
8587 	 * Walk scheds with pending kicks on this cpu. scx_kick_cpu() adds to
8588 	 * the list under local_irq_save() and only this irq_work consumes it.
8589 	 * A plain list without locking is sufficient.
8590 	 */
8591 	list_for_each_entry_safe(pcpu, tmp, &this_scx->sched_pcpus_to_kick, to_kick_node) {
8592 		list_del_init(&pcpu->to_kick_node);
8593 
8594 		for_each_cpu(cpu, pcpu->cpus_to_kick) {
8595 			should_wait |= kick_one_cpu(cpu, pcpu, this_rq, ksyncs);
8596 			cpumask_clear_cpu(cpu, pcpu->cpus_to_kick);
8597 			cpumask_clear_cpu(cpu, pcpu->cpus_to_kick_if_idle);
8598 		}
8599 
8600 		for_each_cpu(cpu, pcpu->cpus_to_kick_if_idle) {
8601 			kick_one_cpu_if_idle(cpu, pcpu, this_rq);
8602 			cpumask_clear_cpu(cpu, pcpu->cpus_to_kick_if_idle);
8603 		}
8604 	}
8605 
8606 	/*
8607 	 * Can't wait in hardirq — kick_sync can't advance, deadlocking if
8608 	 * CPUs wait for each other. Defer to kick_sync_wait_bal_cb().
8609 	 */
8610 	if (should_wait) {
8611 		raw_spin_rq_lock(this_rq);
8612 		this_scx->kick_sync_pending = true;
8613 		resched_curr(this_rq);
8614 		scx_rq_lock_drop(this_rq);
8615 		raw_spin_rq_unlock(this_rq);
8616 	}
8617 }
8618 
8619 /**
8620  * print_scx_info - print out sched_ext scheduler state
8621  * @log_lvl: the log level to use when printing
8622  * @p: target task
8623  *
8624  * If a sched_ext scheduler is enabled, print the name and state of the
8625  * scheduler. If @p is on sched_ext, print further information about the task.
8626  *
8627  * This function can be safely called on any task as long as the task_struct
8628  * itself is accessible. While safe, this function isn't synchronized and may
8629  * print out mixups or garbages of limited length.
8630  */
print_scx_info(const char * log_lvl,struct task_struct * p)8631 void print_scx_info(const char *log_lvl, struct task_struct *p)
8632 {
8633 	struct scx_sched *sch;
8634 	enum scx_enable_state state = scx_enable_state();
8635 	const char *all = READ_ONCE(scx_switching_all) ? "+all" : "";
8636 	char runnable_at_buf[22] = "?";
8637 	struct sched_class *class;
8638 	unsigned long runnable_at;
8639 
8640 	guard(rcu)();
8641 
8642 	sch = scx_task_sched_rcu(p);
8643 
8644 	if (!sch)
8645 		return;
8646 
8647 	/*
8648 	 * Carefully check if the task was running on sched_ext, and then
8649 	 * carefully copy the time it's been runnable, and its state.
8650 	 */
8651 	if (copy_from_kernel_nofault(&class, &p->sched_class, sizeof(class)) ||
8652 	    class != &ext_sched_class) {
8653 		printk("%sSched_ext: %s (%s%s)", log_lvl, sch->ops.name,
8654 		       scx_enable_state_str[state], all);
8655 		return;
8656 	}
8657 
8658 	if (!copy_from_kernel_nofault(&runnable_at, &p->scx.runnable_at,
8659 				      sizeof(runnable_at)))
8660 		scnprintf(runnable_at_buf, sizeof(runnable_at_buf), "%+ldms",
8661 			  jiffies_delta_msecs(runnable_at, jiffies));
8662 
8663 	/* print everything onto one line to conserve console space */
8664 	printk("%sSched_ext: %s (%s%s), task: runnable_at=%s",
8665 	       log_lvl, sch->ops.name, scx_enable_state_str[state], all,
8666 	       runnable_at_buf);
8667 }
8668 
scx_pm_handler(struct notifier_block * nb,unsigned long event,void * ptr)8669 static int scx_pm_handler(struct notifier_block *nb, unsigned long event, void *ptr)
8670 {
8671 	struct scx_sched *sch;
8672 
8673 	guard(rcu)();
8674 
8675 	sch = rcu_dereference(scx_root);
8676 	if (!sch)
8677 		return NOTIFY_OK;
8678 
8679 	/*
8680 	 * SCX schedulers often have userspace components which are sometimes
8681 	 * involved in critial scheduling paths. PM operations involve freezing
8682 	 * userspace which can lead to scheduling misbehaviors including stalls.
8683 	 * Let's bypass while PM operations are in progress.
8684 	 */
8685 	switch (event) {
8686 	case PM_HIBERNATION_PREPARE:
8687 	case PM_SUSPEND_PREPARE:
8688 	case PM_RESTORE_PREPARE:
8689 		scx_bypass(sch, true);
8690 		break;
8691 	case PM_POST_HIBERNATION:
8692 	case PM_POST_SUSPEND:
8693 	case PM_POST_RESTORE:
8694 		scx_bypass(sch, false);
8695 		break;
8696 	}
8697 
8698 	return NOTIFY_OK;
8699 }
8700 
8701 static struct notifier_block scx_pm_notifier = {
8702 	.notifier_call = scx_pm_handler,
8703 };
8704 
init_sched_ext_class(void)8705 void __init init_sched_ext_class(void)
8706 {
8707 	s32 cpu, v;
8708 
8709 	/*
8710 	 * The following is to prevent the compiler from optimizing out the enum
8711 	 * definitions so that BPF scheduler implementations can use them
8712 	 * through the generated vmlinux.h.
8713 	 */
8714 	WRITE_ONCE(v, SCX_ENQ_WAKEUP | SCX_DEQ_SLEEP | SCX_KICK_PREEMPT |
8715 		   SCX_TG_ONLINE);
8716 
8717 	scx_idle_init_masks();
8718 
8719 	for_each_possible_cpu(cpu) {
8720 		struct rq *rq = cpu_rq(cpu);
8721 		int  n = cpu_to_node(cpu);
8722 
8723 		/* local_dsq's sch will be set during scx_root_enable() */
8724 		BUG_ON(scx_init_dsq(&rq->scx.local_dsq, SCX_DSQ_LOCAL, NULL));
8725 #ifdef CONFIG_EXT_SUB_SCHED
8726 		BUG_ON(scx_init_dsq(&rq->scx.reject_dsq, SCX_DSQ_REJECT, NULL));
8727 		scx_rescue_init(rq);
8728 #endif
8729 
8730 		INIT_LIST_HEAD(&rq->scx.runnable_list);
8731 		INIT_LIST_HEAD(&rq->scx.ddsp_deferred_locals);
8732 
8733 		BUG_ON(!zalloc_cpumask_var_node(&rq->scx.cpus_to_sync, GFP_KERNEL, n));
8734 		INIT_LIST_HEAD(&rq->scx.sched_pcpus_to_kick);
8735 		raw_spin_lock_init(&rq->scx.deferred_reenq_lock);
8736 		INIT_LIST_HEAD(&rq->scx.deferred_reenq_locals);
8737 		INIT_LIST_HEAD(&rq->scx.deferred_reenq_users);
8738 		rq->scx.deferred_irq_work = IRQ_WORK_INIT_HARD(deferred_irq_workfn);
8739 		rq->scx.kick_cpus_irq_work = IRQ_WORK_INIT_HARD(kick_cpus_irq_workfn);
8740 
8741 		if (cpu_online(cpu))
8742 			cpu_rq(cpu)->scx.flags |= SCX_RQ_ONLINE;
8743 	}
8744 
8745 	register_sysrq_key('S', &sysrq_sched_ext_reset_op);
8746 	register_sysrq_key('D', &sysrq_sched_ext_dump_op);
8747 	INIT_DELAYED_WORK(&scx_watchdog_work, scx_watchdog_workfn);
8748 
8749 #ifdef CONFIG_EXT_SUB_SCHED
8750 	BUG_ON(rhashtable_init(&scx_sched_hash, &scx_sched_hash_params));
8751 #endif	/* CONFIG_EXT_SUB_SCHED */
8752 }
8753 
8754 
8755 /********************************************************************************
8756  * Helpers that can be called from the BPF scheduler.
8757  */
scx_vet_enq_flags(struct scx_sched * sch,u64 dsq_id,u64 * enq_flags)8758 static bool scx_vet_enq_flags(struct scx_sched *sch, u64 dsq_id, u64 *enq_flags)
8759 {
8760 	bool is_local = dsq_id == SCX_DSQ_LOCAL ||
8761 		(dsq_id & SCX_DSQ_LOCAL_ON) == SCX_DSQ_LOCAL_ON;
8762 
8763 	if (unlikely(*enq_flags & __SCX_ENQ_INTERNAL_MASK)) {
8764 		scx_error(sch, "invalid enq_flags 0x%llx", *enq_flags);
8765 		return false;
8766 	}
8767 
8768 	if (*enq_flags & SCX_ENQ_IMMED) {
8769 		if (unlikely(!is_local)) {
8770 			scx_error(sch, "SCX_ENQ_IMMED on a non-local DSQ 0x%llx", dsq_id);
8771 			return false;
8772 		}
8773 	} else if ((sch->ops.flags & SCX_OPS_ALWAYS_ENQ_IMMED) && is_local) {
8774 		*enq_flags |= SCX_ENQ_IMMED;
8775 	}
8776 
8777 	if (unlikely((*enq_flags & SCX_ENQ_RESCUE) && !is_local)) {
8778 		scx_error(sch, "SCX_ENQ_RESCUE on a non-local DSQ 0x%llx", dsq_id);
8779 		return false;
8780 	}
8781 
8782 	return true;
8783 }
8784 
scx_dsq_insert_preamble(struct scx_sched * sch,struct task_struct * p,u64 dsq_id,u64 * enq_flags)8785 static bool scx_dsq_insert_preamble(struct scx_sched *sch, struct task_struct *p,
8786 				    u64 dsq_id, u64 *enq_flags)
8787 {
8788 	lockdep_assert_irqs_disabled();
8789 
8790 	if (unlikely(!p)) {
8791 		scx_error(sch, "called with NULL task");
8792 		return false;
8793 	}
8794 
8795 	/* see SCX_EV_INSERT_NOT_OWNED definition */
8796 	if (unlikely(!scx_task_on_sched(sch, p))) {
8797 		__scx_add_event(sch, SCX_EV_INSERT_NOT_OWNED, 1);
8798 		return false;
8799 	}
8800 
8801 	if (!scx_vet_enq_flags(sch, dsq_id, enq_flags))
8802 		return false;
8803 
8804 	return true;
8805 }
8806 
scx_dsq_insert_commit(struct scx_sched * sch,struct task_struct * p,u64 dsq_id,u64 slice,u64 vtime,u64 enq_flags)8807 static void scx_dsq_insert_commit(struct scx_sched *sch, struct task_struct *p,
8808 				  u64 dsq_id, u64 slice, u64 vtime, u64 enq_flags)
8809 {
8810 	struct scx_dsp_ctx *dspc = &this_cpu_ptr(sch->pcpu)->dsp_ctx;
8811 	struct task_struct *ddsp_task;
8812 
8813 	ddsp_task = __this_cpu_read(direct_dispatch_task);
8814 	if (ddsp_task) {
8815 		mark_direct_dispatch(sch, ddsp_task, p, dsq_id, slice, vtime, enq_flags);
8816 		return;
8817 	}
8818 
8819 	if (unlikely(dspc->cursor >= sch->dsp_max_batch)) {
8820 		scx_error(sch, "dispatch buffer overflow");
8821 		return;
8822 	}
8823 
8824 	dspc->buf[dspc->cursor++] = (struct scx_dsp_buf_ent){
8825 		.task = p,
8826 		.qseq = atomic_long_read(&p->scx.ops_state) & SCX_OPSS_QSEQ_MASK,
8827 		.dsq_id = dsq_id,
8828 		.slice = slice,
8829 		.vtime = vtime,
8830 		.enq_flags = enq_flags,
8831 	};
8832 }
8833 
8834 __bpf_kfunc_start_defs();
8835 
8836 /**
8837  * scx_bpf_dsq_insert___v2 - Insert a task into the FIFO queue of a DSQ
8838  * @p: task_struct to insert
8839  * @dsq_id: DSQ to insert into
8840  * @slice: duration @p can run for in nsecs, 0 to keep the current value
8841  * @enq_flags: SCX_ENQ_*
8842  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
8843  *
8844  * Insert @p into the FIFO queue of the DSQ identified by @dsq_id. It is safe to
8845  * call this function spuriously. Can be called from ops.enqueue(),
8846  * ops.select_cpu(), and ops.dispatch().
8847  *
8848  * When called from ops.select_cpu() or ops.enqueue(), it's for direct dispatch
8849  * and @p must match the task being enqueued.
8850  *
8851  * When called from ops.select_cpu(), @enq_flags and @dsq_id are stored, and @p
8852  * will be directly inserted into the corresponding dispatch queue after
8853  * ops.select_cpu() returns. If @p is inserted into SCX_DSQ_LOCAL, it will be
8854  * inserted into the local DSQ of the CPU returned by ops.select_cpu().
8855  * @enq_flags are OR'd with the enqueue flags on the enqueue path before the
8856  * task is inserted.
8857  *
8858  * When called from ops.dispatch(), there are no restrictions on @p or @dsq_id
8859  * and this function can be called upto ops.dispatch_max_batch times to insert
8860  * multiple tasks. scx_bpf_dispatch_nr_slots() returns the number of the
8861  * remaining slots. scx_bpf_dsq_move_to_local() flushes the batch and resets the
8862  * counter.
8863  *
8864  * This function doesn't have any locking restrictions and may be called under
8865  * BPF locks (in the future when BPF introduces more flexible locking).
8866  *
8867  * @p is allowed to run for @slice. The scheduling path is triggered on slice
8868  * exhaustion. If zero, the current residual slice is maintained. If
8869  * %SCX_SLICE_INF, @p never expires and the BPF scheduler must kick the CPU with
8870  * scx_bpf_kick_cpu() to trigger scheduling.
8871  *
8872  * Returns %true on successful insertion, %false on failure. On the root
8873  * scheduler, %false return triggers scheduler abort and the caller doesn't need
8874  * to check the return value.
8875  */
scx_bpf_dsq_insert___v2(struct task_struct * p,u64 dsq_id,u64 slice,u64 enq_flags,const struct bpf_prog_aux * aux)8876 __bpf_kfunc bool scx_bpf_dsq_insert___v2(struct task_struct *p, u64 dsq_id,
8877 					 u64 slice, u64 enq_flags,
8878 					 const struct bpf_prog_aux *aux)
8879 {
8880 	struct scx_sched *sch;
8881 
8882 	guard(rcu)();
8883 	sch = scx_prog_sched(aux);
8884 	if (unlikely(!sch))
8885 		return false;
8886 
8887 	if (!scx_dsq_insert_preamble(sch, p, dsq_id, &enq_flags))
8888 		return false;
8889 
8890 	scx_dsq_insert_commit(sch, p, dsq_id, slice, 0, enq_flags);
8891 
8892 	return true;
8893 }
8894 
8895 /*
8896  * COMPAT: Will be removed in v6.23 along with the ___v2 suffix.
8897  */
scx_bpf_dsq_insert(struct task_struct * p,u64 dsq_id,u64 slice,u64 enq_flags,const struct bpf_prog_aux * aux)8898 __bpf_kfunc void scx_bpf_dsq_insert(struct task_struct *p, u64 dsq_id,
8899 				    u64 slice, u64 enq_flags,
8900 				    const struct bpf_prog_aux *aux)
8901 {
8902 	scx_bpf_dsq_insert___v2(p, dsq_id, slice, enq_flags, aux);
8903 }
8904 
scx_dsq_insert_vtime(struct scx_sched * sch,struct task_struct * p,u64 dsq_id,u64 slice,u64 vtime,u64 enq_flags)8905 static bool scx_dsq_insert_vtime(struct scx_sched *sch, struct task_struct *p,
8906 				 u64 dsq_id, u64 slice, u64 vtime, u64 enq_flags)
8907 {
8908 	if (!scx_dsq_insert_preamble(sch, p, dsq_id, &enq_flags))
8909 		return false;
8910 
8911 	scx_dsq_insert_commit(sch, p, dsq_id, slice, vtime, enq_flags | SCX_ENQ_DSQ_PRIQ);
8912 
8913 	return true;
8914 }
8915 
8916 struct scx_bpf_dsq_insert_vtime_args {
8917 	/* @p can't be packed together as KF_RCU is not transitive */
8918 	u64			dsq_id;
8919 	u64			slice;
8920 	u64			vtime;
8921 	u64			enq_flags;
8922 };
8923 
8924 /**
8925  * __scx_bpf_dsq_insert_vtime - Arg-wrapped vtime DSQ insertion
8926  * @p: task_struct to insert
8927  * @args: struct containing the rest of the arguments
8928  *       @args->dsq_id: DSQ to insert into
8929  *       @args->slice: duration @p can run for in nsecs, 0 to keep the current value
8930  *       @args->vtime: @p's ordering inside the vtime-sorted queue of the target DSQ
8931  *       @args->enq_flags: SCX_ENQ_*
8932  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
8933  *
8934  * Wrapper kfunc that takes arguments via struct to work around BPF's 5 argument
8935  * limit. BPF programs should use scx_bpf_dsq_insert_vtime() which is provided
8936  * as an inline wrapper in common.bpf.h.
8937  *
8938  * Insert @p into the vtime priority queue of the DSQ identified by
8939  * @args->dsq_id. Tasks queued into the priority queue are ordered by
8940  * @args->vtime. All other aspects are identical to scx_bpf_dsq_insert().
8941  *
8942  * @args->vtime ordering is according to time_before64() which considers
8943  * wrapping. A numerically larger vtime may indicate an earlier position in the
8944  * ordering and vice-versa.
8945  *
8946  * A DSQ can only be used as a FIFO or priority queue at any given time and this
8947  * function must not be called on a DSQ which already has one or more FIFO tasks
8948  * queued and vice-versa. Also, the built-in DSQs (SCX_DSQ_LOCAL and
8949  * SCX_DSQ_GLOBAL) cannot be used as priority queues.
8950  *
8951  * Returns %true on successful insertion, %false on failure. On the root
8952  * scheduler, %false return triggers scheduler abort and the caller doesn't need
8953  * to check the return value.
8954  */
8955 __bpf_kfunc bool
__scx_bpf_dsq_insert_vtime(struct task_struct * p,struct scx_bpf_dsq_insert_vtime_args * args,const struct bpf_prog_aux * aux)8956 __scx_bpf_dsq_insert_vtime(struct task_struct *p,
8957 			   struct scx_bpf_dsq_insert_vtime_args *args,
8958 			   const struct bpf_prog_aux *aux)
8959 {
8960 	struct scx_sched *sch;
8961 
8962 	guard(rcu)();
8963 
8964 	sch = scx_prog_sched(aux);
8965 	if (unlikely(!sch))
8966 		return false;
8967 
8968 	return scx_dsq_insert_vtime(sch, p, args->dsq_id, args->slice,
8969 				    args->vtime, args->enq_flags);
8970 }
8971 
8972 /*
8973  * COMPAT: Will be removed in v6.23.
8974  */
scx_bpf_dsq_insert_vtime(struct task_struct * p,u64 dsq_id,u64 slice,u64 vtime,u64 enq_flags)8975 __bpf_kfunc void scx_bpf_dsq_insert_vtime(struct task_struct *p, u64 dsq_id,
8976 					  u64 slice, u64 vtime, u64 enq_flags)
8977 {
8978 	struct scx_sched *sch;
8979 
8980 	guard(rcu)();
8981 
8982 	sch = rcu_dereference(scx_root);
8983 	if (unlikely(!sch))
8984 		return;
8985 
8986 #ifdef CONFIG_EXT_SUB_SCHED
8987 	/*
8988 	 * Disallow if any sub-scheds are attached. There is no way to tell
8989 	 * which scheduler called us, so error out @p's scheduler -- read it
8990 	 * under RCU as @p's locks aren't necessarily held here. @p may be a
8991 	 * task past sched_ext_dead() or an idle task, in which case its
8992 	 * scheduler can't be determined and there is nothing obviously wrong
8993 	 * to report; just refuse the call.
8994 	 */
8995 	if (unlikely(!list_empty(&sch->children))) {
8996 		struct scx_sched *tsch = scx_task_sched_rcu(p);
8997 
8998 		if (tsch)
8999 			scx_error(tsch, "__scx_bpf_dsq_insert_vtime() must be used");
9000 		return;
9001 	}
9002 #endif
9003 
9004 	scx_dsq_insert_vtime(sch, p, dsq_id, slice, vtime, enq_flags);
9005 }
9006 
9007 __bpf_kfunc_end_defs();
9008 
9009 BTF_KFUNCS_START(scx_kfunc_ids_enqueue_dispatch)
9010 BTF_ID_FLAGS(func, scx_bpf_dsq_insert, KF_IMPLICIT_ARGS | KF_RCU)
9011 BTF_ID_FLAGS(func, scx_bpf_dsq_insert___v2, KF_IMPLICIT_ARGS | KF_RCU)
9012 BTF_ID_FLAGS(func, __scx_bpf_dsq_insert_vtime, KF_IMPLICIT_ARGS | KF_RCU)
9013 BTF_ID_FLAGS(func, scx_bpf_dsq_insert_vtime, KF_RCU)
9014 BTF_KFUNCS_END(scx_kfunc_ids_enqueue_dispatch)
9015 
9016 static const struct btf_kfunc_id_set scx_kfunc_set_enqueue_dispatch = {
9017 	.owner			= THIS_MODULE,
9018 	.set			= &scx_kfunc_ids_enqueue_dispatch,
9019 	.filter			= scx_kfunc_context_filter,
9020 };
9021 
scx_dsq_move(struct bpf_iter_scx_dsq_kern * kit,struct task_struct * p,u64 dsq_id,u64 enq_flags,bool priq)9022 static bool scx_dsq_move(struct bpf_iter_scx_dsq_kern *kit,
9023 			 struct task_struct *p, u64 dsq_id, u64 enq_flags,
9024 			 bool priq)
9025 {
9026 	struct scx_dispatch_q *src_dsq = kit->dsq, *dst_dsq;
9027 	struct scx_sched *sch;
9028 	struct rq *p_rq, *src_rq, *locked_rq;
9029 	bool dispatched = false;
9030 	unsigned long flags;
9031 
9032 	/*
9033 	 * The verifier considers an iterator slot initialized on any
9034 	 * KF_ITER_NEW return, so a BPF program may legally reach here after
9035 	 * bpf_iter_scx_dsq_new() failed and left @kit->dsq NULL.
9036 	 */
9037 	if (unlikely(!src_dsq))
9038 		return false;
9039 
9040 	sch = src_dsq->sched;
9041 
9042 	if (!scx_vet_enq_flags(sch, dsq_id, &enq_flags))
9043 		return false;
9044 
9045 	/* internal bit, can only go in after @enq_flags is vetted */
9046 	if (priq)
9047 		enq_flags |= SCX_ENQ_DSQ_PRIQ;
9048 
9049 	/*
9050 	 * If the BPF scheduler keeps calling this function repeatedly, it can
9051 	 * cause similar live-lock conditions as scx_consume_dispatch_q().
9052 	 */
9053 	if (unlikely(READ_ONCE(sch->aborting)))
9054 		return false;
9055 
9056 	/*
9057 	 * Can be called from either ops.dispatch() holding the dispatched rq's
9058 	 * lock or any context where no rq lock is held. If latter, lock @p's
9059 	 * task_rq which we'll likely need anyway.
9060 	 */
9061 	src_rq = task_rq(p);
9062 
9063 	local_irq_save(flags);
9064 
9065 	/*
9066 	 * Under core scheduling, dispatch can run for a sibling rq, so the
9067 	 * locked rq is not necessarily this CPU's.
9068 	 */
9069 	locked_rq = scx_locked_rq();
9070 
9071 	if (locked_rq) {
9072 		if (locked_rq != src_rq)
9073 			switch_rq_lock(locked_rq, src_rq);
9074 	} else {
9075 		raw_spin_rq_lock(src_rq);
9076 	}
9077 
9078 	p_rq = src_rq;
9079 	raw_spin_lock(&src_dsq->lock);
9080 
9081 	/* did someone else get to it while we dropped the locks? */
9082 	if (nldsq_cursor_lost_task(&kit->cursor, src_rq, src_dsq, p)) {
9083 		raw_spin_unlock(&src_dsq->lock);
9084 		goto out;
9085 	}
9086 
9087 	/*
9088 	 * @p has been on $src_dsq and can't move anymore. If @p is not on @sch,
9089 	 * the caller didn't have authority over @p at the time of the call.
9090 	 */
9091 	if (unlikely(!scx_task_on_sched(sch, p))) {
9092 		scx_error(sch, "scx_bpf_dsq_move[_vtime]() on %s[%d] but the task belongs to a different scheduler",
9093 			  p->comm, p->pid);
9094 		raw_spin_unlock(&src_dsq->lock);
9095 		goto out;
9096 	}
9097 
9098 	/* @p is still on $src_dsq and stable, determine the destination */
9099 	dst_dsq = find_dsq_for_dispatch(sch, locked_rq ?: this_rq(), dsq_id, task_cpu(p));
9100 
9101 	/*
9102 	 * Apply vtime and slice updates before moving. @p is still on $src_dsq
9103 	 * with both $src_dsq and its task_rq locked, satisfying the write
9104 	 * rules, and the PRIQ insertion into $dst_dsq reads the new vtime.
9105 	 */
9106 	if (kit->cursor.flags & __SCX_DSQ_ITER_HAS_VTIME)
9107 		p->scx.dsq_vtime = kit->vtime;
9108 	if (kit->cursor.flags & __SCX_DSQ_ITER_HAS_SLICE)
9109 		scx_set_task_slice(p, kit->slice);
9110 
9111 	/* execute move */
9112 	p_rq = move_task_between_dsqs(sch, p, enq_flags, src_dsq, dst_dsq);
9113 	dispatched = true;
9114 out:
9115 	if (locked_rq) {
9116 		if (locked_rq != p_rq)
9117 			switch_rq_lock(p_rq, locked_rq);
9118 	} else {
9119 		scx_rq_lock_drop(p_rq);
9120 		raw_spin_rq_unlock_irqrestore(p_rq, flags);
9121 	}
9122 
9123 	kit->cursor.flags &= ~(__SCX_DSQ_ITER_HAS_SLICE |
9124 			       __SCX_DSQ_ITER_HAS_VTIME);
9125 	return dispatched;
9126 }
9127 
9128 __bpf_kfunc_start_defs();
9129 
9130 /**
9131  * scx_bpf_dispatch_nr_slots - Return the number of remaining dispatch slots
9132  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9133  *
9134  * Can only be called from ops.dispatch().
9135  */
scx_bpf_dispatch_nr_slots(const struct bpf_prog_aux * aux)9136 __bpf_kfunc u32 scx_bpf_dispatch_nr_slots(const struct bpf_prog_aux *aux)
9137 {
9138 	struct scx_sched *sch;
9139 
9140 	guard(rcu)();
9141 
9142 	sch = scx_prog_sched(aux);
9143 	if (unlikely(!sch))
9144 		return 0;
9145 
9146 	return sch->dsp_max_batch - __this_cpu_read(sch->pcpu->dsp_ctx.cursor);
9147 }
9148 
9149 /**
9150  * scx_bpf_dispatch_cancel - Cancel the latest dispatch
9151  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9152  *
9153  * Cancel the latest dispatch. Can be called multiple times to cancel further
9154  * dispatches. Can only be called from ops.dispatch().
9155  */
scx_bpf_dispatch_cancel(const struct bpf_prog_aux * aux)9156 __bpf_kfunc void scx_bpf_dispatch_cancel(const struct bpf_prog_aux *aux)
9157 {
9158 	struct scx_sched *sch;
9159 	struct scx_dsp_ctx *dspc;
9160 
9161 	guard(rcu)();
9162 
9163 	sch = scx_prog_sched(aux);
9164 	if (unlikely(!sch))
9165 		return;
9166 
9167 	dspc = &this_cpu_ptr(sch->pcpu)->dsp_ctx;
9168 
9169 	if (dspc->cursor > 0)
9170 		dspc->cursor--;
9171 	else
9172 		scx_error(sch, "dispatch buffer underflow");
9173 }
9174 
9175 /**
9176  * scx_bpf_dsq_move_to_local___v2 - move a task from a DSQ to the current CPU's local DSQ
9177  * @dsq_id: DSQ to move task from. Must be a user-created DSQ
9178  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9179  * @enq_flags: %SCX_ENQ_*
9180  *
9181  * Move a task from the non-local DSQ identified by @dsq_id to the current CPU's
9182  * local DSQ for execution with @enq_flags applied. Can only be called from
9183  * ops.dispatch().
9184  *
9185  * Built-in DSQs (%SCX_DSQ_GLOBAL and %SCX_DSQ_LOCAL*) are not supported as
9186  * sources. Local DSQs support reenqueueing (a task can be picked up for
9187  * execution, dequeued for property changes, or reenqueued), but the BPF
9188  * scheduler cannot directly iterate or move tasks from them. %SCX_DSQ_GLOBAL
9189  * is similar but also doesn't support reenqueueing, as it maps to multiple
9190  * per-node DSQs making the scope difficult to define; this may change in the
9191  * future.
9192  *
9193  * This function flushes the in-flight dispatches from scx_bpf_dsq_insert()
9194  * before trying to move from the specified DSQ. It may also grab rq locks and
9195  * thus can't be called under any BPF locks.
9196  *
9197  * Returns %true if a task has been moved, %false if there isn't any task to
9198  * move.
9199  */
scx_bpf_dsq_move_to_local___v2(u64 dsq_id,u64 enq_flags,const struct bpf_prog_aux * aux)9200 __bpf_kfunc bool scx_bpf_dsq_move_to_local___v2(u64 dsq_id, u64 enq_flags,
9201 						const struct bpf_prog_aux *aux)
9202 {
9203 	struct scx_dispatch_q *dsq;
9204 	struct scx_sched *sch;
9205 	struct scx_dsp_ctx *dspc;
9206 
9207 	guard(rcu)();
9208 
9209 	sch = scx_prog_sched(aux);
9210 	if (unlikely(!sch))
9211 		return false;
9212 
9213 	if (!scx_vet_enq_flags(sch, SCX_DSQ_LOCAL, &enq_flags))
9214 		return false;
9215 
9216 	dspc = &this_cpu_ptr(sch->pcpu)->dsp_ctx;
9217 
9218 	scx_flush_dispatch_buf(sch, dspc->rq);
9219 
9220 	dsq = find_user_dsq(sch, dsq_id);
9221 	if (unlikely(!dsq)) {
9222 		scx_error(sch, "invalid DSQ ID 0x%016llx", dsq_id);
9223 		return false;
9224 	}
9225 
9226 	if (scx_consume_dispatch_q(sch, dspc->rq, dsq, enq_flags)) {
9227 		/*
9228 		 * A successfully consumed task can be dequeued before it starts
9229 		 * running while the CPU is trying to migrate other dispatched
9230 		 * tasks. Bump nr_tasks to tell dispatch_one() to retry on empty
9231 		 * local DSQ.
9232 		 */
9233 		dspc->nr_tasks++;
9234 		return true;
9235 	} else {
9236 		return false;
9237 	}
9238 }
9239 
9240 /*
9241  * COMPAT: ___v2 was introduced in v7.1. Remove this and ___v2 tag in the future.
9242  */
scx_bpf_dsq_move_to_local(u64 dsq_id,const struct bpf_prog_aux * aux)9243 __bpf_kfunc bool scx_bpf_dsq_move_to_local(u64 dsq_id, const struct bpf_prog_aux *aux)
9244 {
9245 	return scx_bpf_dsq_move_to_local___v2(dsq_id, 0, aux);
9246 }
9247 
9248 /**
9249  * scx_bpf_dsq_move_set_slice - Override slice when moving between DSQs
9250  * @it__iter: DSQ iterator in progress
9251  * @slice: duration the moved task can run for in nsecs
9252  *
9253  * Override the slice of the next task that will be moved from @it__iter using
9254  * scx_bpf_dsq_move[_vtime](). If this function is not called, the previous
9255  * slice duration is kept.
9256  */
scx_bpf_dsq_move_set_slice(struct bpf_iter_scx_dsq * it__iter,u64 slice)9257 __bpf_kfunc void scx_bpf_dsq_move_set_slice(struct bpf_iter_scx_dsq *it__iter,
9258 					    u64 slice)
9259 {
9260 	struct bpf_iter_scx_dsq_kern *kit = (void *)it__iter;
9261 
9262 	kit->slice = slice;
9263 	kit->cursor.flags |= __SCX_DSQ_ITER_HAS_SLICE;
9264 }
9265 
9266 /**
9267  * scx_bpf_dsq_move_set_vtime - Override vtime when moving between DSQs
9268  * @it__iter: DSQ iterator in progress
9269  * @vtime: task's ordering inside the vtime-sorted queue of the target DSQ
9270  *
9271  * Override the vtime of the next task that will be moved from @it__iter using
9272  * scx_bpf_dsq_move_vtime(). If this function is not called, the previous slice
9273  * vtime is kept. If scx_bpf_dsq_move() is used to dispatch the next task, the
9274  * override is ignored and cleared.
9275  */
scx_bpf_dsq_move_set_vtime(struct bpf_iter_scx_dsq * it__iter,u64 vtime)9276 __bpf_kfunc void scx_bpf_dsq_move_set_vtime(struct bpf_iter_scx_dsq *it__iter,
9277 					    u64 vtime)
9278 {
9279 	struct bpf_iter_scx_dsq_kern *kit = (void *)it__iter;
9280 
9281 	kit->vtime = vtime;
9282 	kit->cursor.flags |= __SCX_DSQ_ITER_HAS_VTIME;
9283 }
9284 
9285 /**
9286  * scx_bpf_dsq_move - Move a task from DSQ iteration to a DSQ
9287  * @it__iter: DSQ iterator in progress
9288  * @p: task to transfer
9289  * @dsq_id: DSQ to move @p to
9290  * @enq_flags: SCX_ENQ_*
9291  *
9292  * Transfer @p which is on the DSQ currently iterated by @it__iter to the DSQ
9293  * specified by @dsq_id. All DSQs - local DSQs, global DSQ and user DSQs - can
9294  * be the destination.
9295  *
9296  * For the transfer to be successful, @p must still be on the DSQ and have been
9297  * queued before the DSQ iteration started. This function doesn't care whether
9298  * @p was obtained from the DSQ iteration. @p just has to be on the DSQ and have
9299  * been queued before the iteration started.
9300  *
9301  * @p's slice is kept by default. Use scx_bpf_dsq_move_set_slice() to update.
9302  *
9303  * Can be called from ops.dispatch() or any BPF context which doesn't hold a rq
9304  * lock (e.g. BPF timers or SYSCALL programs).
9305  *
9306  * Returns %true if @p has been consumed, %false if @p had already been
9307  * consumed, dequeued, or, for sub-scheds, @dsq_id points to a disallowed local
9308  * DSQ.
9309  */
scx_bpf_dsq_move(struct bpf_iter_scx_dsq * it__iter,struct task_struct * p,u64 dsq_id,u64 enq_flags)9310 __bpf_kfunc bool scx_bpf_dsq_move(struct bpf_iter_scx_dsq *it__iter,
9311 				  struct task_struct *p, u64 dsq_id,
9312 				  u64 enq_flags)
9313 {
9314 	return scx_dsq_move((struct bpf_iter_scx_dsq_kern *)it__iter,
9315 			    p, dsq_id, enq_flags, false);
9316 }
9317 
9318 /**
9319  * scx_bpf_dsq_move_vtime - Move a task from DSQ iteration to a PRIQ DSQ
9320  * @it__iter: DSQ iterator in progress
9321  * @p: task to transfer
9322  * @dsq_id: DSQ to move @p to
9323  * @enq_flags: SCX_ENQ_*
9324  *
9325  * Transfer @p which is on the DSQ currently iterated by @it__iter to the
9326  * priority queue of the DSQ specified by @dsq_id. The destination must be a
9327  * user DSQ as only user DSQs support priority queue.
9328  *
9329  * @p's slice and vtime are kept by default. Use scx_bpf_dsq_move_set_slice()
9330  * and scx_bpf_dsq_move_set_vtime() to update.
9331  *
9332  * All other aspects are identical to scx_bpf_dsq_move(). See
9333  * scx_bpf_dsq_insert_vtime() for more information on @vtime.
9334  */
scx_bpf_dsq_move_vtime(struct bpf_iter_scx_dsq * it__iter,struct task_struct * p,u64 dsq_id,u64 enq_flags)9335 __bpf_kfunc bool scx_bpf_dsq_move_vtime(struct bpf_iter_scx_dsq *it__iter,
9336 					struct task_struct *p, u64 dsq_id,
9337 					u64 enq_flags)
9338 {
9339 	return scx_dsq_move((struct bpf_iter_scx_dsq_kern *)it__iter,
9340 			    p, dsq_id, enq_flags, true);
9341 }
9342 
9343 __bpf_kfunc_end_defs();
9344 
9345 BTF_KFUNCS_START(scx_kfunc_ids_dispatch)
9346 BTF_ID_FLAGS(func, scx_bpf_dispatch_nr_slots, KF_IMPLICIT_ARGS)
9347 BTF_ID_FLAGS(func, scx_bpf_dispatch_cancel, KF_IMPLICIT_ARGS)
9348 BTF_ID_FLAGS(func, scx_bpf_dsq_move_to_local, KF_IMPLICIT_ARGS)
9349 BTF_ID_FLAGS(func, scx_bpf_dsq_move_to_local___v2, KF_IMPLICIT_ARGS)
9350 /* scx_bpf_dsq_move*() also in scx_kfunc_ids_unlocked: callable from unlocked contexts */
9351 BTF_ID_FLAGS(func, scx_bpf_dsq_move_set_slice, KF_RCU)
9352 BTF_ID_FLAGS(func, scx_bpf_dsq_move_set_vtime, KF_RCU)
9353 BTF_ID_FLAGS(func, scx_bpf_dsq_move, KF_RCU)
9354 BTF_ID_FLAGS(func, scx_bpf_dsq_move_vtime, KF_RCU)
9355 #ifdef CONFIG_EXT_SUB_SCHED
9356 BTF_ID_FLAGS(func, scx_bpf_sub_dispatch, KF_IMPLICIT_ARGS)
9357 #endif
9358 BTF_KFUNCS_END(scx_kfunc_ids_dispatch)
9359 
9360 static const struct btf_kfunc_id_set scx_kfunc_set_dispatch = {
9361 	.owner			= THIS_MODULE,
9362 	.set			= &scx_kfunc_ids_dispatch,
9363 	.filter			= scx_kfunc_context_filter,
9364 };
9365 
9366 __bpf_kfunc_start_defs();
9367 
9368 /**
9369  * scx_bpf_reenqueue_local - Re-enqueue tasks on a local DSQ
9370  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9371  *
9372  * Iterate over all of the tasks currently enqueued on the local DSQ of the
9373  * caller's CPU, and re-enqueue them in the BPF scheduler. Returns the number of
9374  * processed tasks. Can only be called from ops.cpu_release().
9375  */
scx_bpf_reenqueue_local(const struct bpf_prog_aux * aux)9376 __bpf_kfunc u32 scx_bpf_reenqueue_local(const struct bpf_prog_aux *aux)
9377 {
9378 	struct scx_sched *sch;
9379 	struct rq *rq;
9380 
9381 	guard(rcu)();
9382 	sch = scx_prog_sched(aux);
9383 	if (unlikely(!sch))
9384 		return 0;
9385 
9386 	rq = cpu_rq(smp_processor_id());
9387 	lockdep_assert_rq_held(rq);
9388 
9389 	return reenq_local(sch, rq, SCX_REENQ_ANY);
9390 }
9391 
9392 __bpf_kfunc_end_defs();
9393 
9394 BTF_KFUNCS_START(scx_kfunc_ids_cpu_release)
9395 BTF_ID_FLAGS(func, scx_bpf_reenqueue_local, KF_IMPLICIT_ARGS)
9396 BTF_KFUNCS_END(scx_kfunc_ids_cpu_release)
9397 
9398 static const struct btf_kfunc_id_set scx_kfunc_set_cpu_release = {
9399 	.owner			= THIS_MODULE,
9400 	.set			= &scx_kfunc_ids_cpu_release,
9401 	.filter			= scx_kfunc_context_filter,
9402 };
9403 
9404 __bpf_kfunc_start_defs();
9405 
9406 /**
9407  * scx_bpf_create_dsq - Create a custom DSQ
9408  * @dsq_id: DSQ to create
9409  * @node: NUMA node to allocate from
9410  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9411  *
9412  * Create a custom DSQ identified by @dsq_id. Can be called from any sleepable
9413  * scx callback, and any BPF_PROG_TYPE_SYSCALL prog.
9414  */
scx_bpf_create_dsq(u64 dsq_id,s32 node,const struct bpf_prog_aux * aux)9415 __bpf_kfunc s32 scx_bpf_create_dsq(u64 dsq_id, s32 node, const struct bpf_prog_aux *aux)
9416 {
9417 	struct scx_dispatch_q *dsq;
9418 	struct scx_sched *sch;
9419 	s32 ret;
9420 
9421 	if (unlikely(node >= (int)nr_node_ids ||
9422 		     (node < 0 && node != NUMA_NO_NODE)))
9423 		return -EINVAL;
9424 
9425 	if (unlikely(dsq_id & SCX_DSQ_FLAG_BUILTIN))
9426 		return -EINVAL;
9427 
9428 	dsq = kmalloc_node(sizeof(*dsq), GFP_KERNEL, node);
9429 	if (!dsq)
9430 		return -ENOMEM;
9431 
9432 	/*
9433 	 * scx_init_dsq() must be called in GFP_KERNEL context. Init it with
9434 	 * NULL @sch and update afterwards.
9435 	 */
9436 	ret = scx_init_dsq(dsq, dsq_id, NULL);
9437 	if (ret) {
9438 		kfree(dsq);
9439 		return ret;
9440 	}
9441 
9442 	rcu_read_lock();
9443 
9444 	sch = scx_prog_sched(aux);
9445 	if (sch) {
9446 		dsq->sched = sch;
9447 		ret = rhashtable_lookup_insert_fast(&sch->dsq_hash, &dsq->hash_node,
9448 						    dsq_hash_params);
9449 	} else {
9450 		ret = -ENODEV;
9451 	}
9452 
9453 	rcu_read_unlock();
9454 	if (ret) {
9455 		exit_dsq(dsq);
9456 		kfree(dsq);
9457 	}
9458 	return ret;
9459 }
9460 
9461 __bpf_kfunc_end_defs();
9462 
9463 BTF_KFUNCS_START(scx_kfunc_ids_unlocked)
9464 BTF_ID_FLAGS(func, scx_bpf_create_dsq, KF_IMPLICIT_ARGS | KF_SLEEPABLE)
9465 /* also in scx_kfunc_ids_dispatch: also callable from ops.dispatch() */
9466 BTF_ID_FLAGS(func, scx_bpf_dsq_move_set_slice, KF_RCU)
9467 BTF_ID_FLAGS(func, scx_bpf_dsq_move_set_vtime, KF_RCU)
9468 BTF_ID_FLAGS(func, scx_bpf_dsq_move, KF_RCU)
9469 BTF_ID_FLAGS(func, scx_bpf_dsq_move_vtime, KF_RCU)
9470 /* also in scx_kfunc_ids_select_cpu: also callable from ops.select_cpu()/ops.enqueue() */
9471 BTF_ID_FLAGS(func, __scx_bpf_select_cpu_and, KF_IMPLICIT_ARGS | KF_RCU)
9472 BTF_ID_FLAGS(func, scx_bpf_select_cpu_and, KF_RCU)
9473 BTF_ID_FLAGS(func, scx_bpf_select_cpu_dfl, KF_IMPLICIT_ARGS | KF_RCU)
9474 BTF_KFUNCS_END(scx_kfunc_ids_unlocked)
9475 
9476 static const struct btf_kfunc_id_set scx_kfunc_set_unlocked = {
9477 	.owner			= THIS_MODULE,
9478 	.set			= &scx_kfunc_ids_unlocked,
9479 	.filter			= scx_kfunc_context_filter,
9480 };
9481 
9482 __bpf_kfunc_start_defs();
9483 
9484 /**
9485  * scx_bpf_task_set_slice - Set task's time slice
9486  * @p: task of interest
9487  * @slice: time slice to set in nsecs
9488  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9489  *
9490  * Set @p's time slice. @p must be on the calling scheduler. The value is
9491  * applied whether or not the caller holds @p's rq lock - see the slice write
9492  * rules above for the ownership model.
9493  *
9494  * Raising the slice is honored only while the scheduler holds %SCX_CAP_BASE on
9495  * @p's cpu, otherwise it is counted in %SCX_EV_SLICE_DENIED. Shortening is
9496  * always allowed. On the stashed path the slice is packed into an atomic64_t
9497  * with the scheduler id and a flag bit, so a slice too large to fit is clamped
9498  * and counted in %SCX_EV_SLICE_CLAMPED. %SCX_SLICE_INF is preserved.
9499  *
9500  * Return %true on success, %false if @p is not on the calling scheduler.
9501  */
scx_bpf_task_set_slice(struct task_struct * p,u64 slice,const struct bpf_prog_aux * aux)9502 __bpf_kfunc bool scx_bpf_task_set_slice(struct task_struct *p, u64 slice,
9503 					const struct bpf_prog_aux *aux)
9504 {
9505 	struct scx_sched *sch;
9506 	struct rq *locked_rq;
9507 
9508 	guard(rcu)();
9509 	sch = scx_prog_sched(aux);
9510 	if (unlikely(!sch || !scx_task_on_sched(sch, p)))
9511 		return false;
9512 
9513 	/*
9514 	 * Directly write only when we hold the lock of the rq @p is queued or
9515 	 * running on. See the write rules above.
9516 	 *
9517 	 * While @p is queued on a user DSQ or in the BPF scheduler,
9518 	 * synchronization is the scheduler's responsibility. This write can
9519 	 * race a concurrent dispatch's commit, see apply_slice_vtime().
9520 	 *
9521 	 * Making this kfunc always go through the oob stash would leave the
9522 	 * commit as the only direct writer and close the race, but that would
9523 	 * require two more oob application points - the dispatch keep-prev test
9524 	 * and the tick-time expiry check.
9525 	 */
9526 	locked_rq = scx_locked_rq();
9527 	if (!locked_rq ||
9528 	    (READ_ONCE(p->scx.runnable_cpu) != cpu_of(locked_rq) &&
9529 	     !task_current(locked_rq, p))) {
9530 		set_task_slice_oob(sch, p, slice);
9531 		return true;
9532 	}
9533 
9534 	/* under the rq lock: apply now, extensions gated on baseline access */
9535 	if (slice > p->scx.slice &&
9536 	    unlikely(scx_missing_caps(sch, cpu_of(locked_rq), SCX_CAP_BASE))) {
9537 		__scx_add_event(sch, SCX_EV_SLICE_DENIED, 1);
9538 		return true;
9539 	}
9540 
9541 	if (unlikely(!scx_set_task_slice(p, slice)))
9542 		__scx_add_event(sch, SCX_EV_SLICE_DENIED, 1);
9543 
9544 	return true;
9545 }
9546 
9547 /**
9548  * scx_bpf_task_set_dsq_vtime - Set task's virtual time for DSQ ordering
9549  * @p: task of interest
9550  * @vtime: virtual time to set
9551  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9552  *
9553  * Set @p's virtual time to @vtime. Returns %true on success, %false if the
9554  * calling scheduler doesn't have authority over @p.
9555  */
scx_bpf_task_set_dsq_vtime(struct task_struct * p,u64 vtime,const struct bpf_prog_aux * aux)9556 __bpf_kfunc bool scx_bpf_task_set_dsq_vtime(struct task_struct *p, u64 vtime,
9557 					    const struct bpf_prog_aux *aux)
9558 {
9559 	struct scx_sched *sch;
9560 
9561 	guard(rcu)();
9562 	sch = scx_prog_sched(aux);
9563 	if (unlikely(!sch || !scx_task_on_sched(sch, p)))
9564 		return false;
9565 
9566 	p->scx.dsq_vtime = vtime;
9567 	return true;
9568 }
9569 
scx_kick_cpu(struct scx_sched * sch,s32 cpu,u64 flags)9570 void scx_kick_cpu(struct scx_sched *sch, s32 cpu, u64 flags)
9571 {
9572 	struct scx_sched_pcpu *pcpu;
9573 	struct rq *this_rq;
9574 	unsigned long irq_flags;
9575 
9576 	/*
9577 	 * The per-cpu kick list is guarded only by local_irq_save(), which does
9578 	 * not mask NMIs, so kicking from NMI could corrupt it and is unsupported.
9579 	 */
9580 	if (unlikely(in_nmi())) {
9581 		scx_error(sch, "scx_bpf_kick_cpu() called from NMI");
9582 		return;
9583 	}
9584 
9585 	local_irq_save(irq_flags);
9586 
9587 	this_rq = this_rq();
9588 	pcpu = this_cpu_ptr(sch->pcpu);
9589 
9590 	/*
9591 	 * While bypassing for PM ops, IRQ handling may not be online which can
9592 	 * lead to irq_work_queue() malfunction such as infinite busy wait for
9593 	 * IRQ status update. Suppress kicking.
9594 	 */
9595 	if (scx_bypassing(sch, cpu_of(this_rq)))
9596 		goto out;
9597 
9598 	/*
9599 	 * Actual kicking is bounced to kick_cpus_irq_workfn() to avoid nesting
9600 	 * rq locks. We can probably be smarter and avoid bouncing if called
9601 	 * from ops which don't hold a rq lock.
9602 	 *
9603 	 * The kick masks are owned by @sch->pcpu, so that a preempt kick can be
9604 	 * attributed to @sch.
9605 	 */
9606 	if (flags & SCX_KICK_IDLE) {
9607 		struct rq *target_rq = cpu_rq(cpu);
9608 
9609 		if (unlikely(flags & (SCX_KICK_PREEMPT | SCX_KICK_WAIT)))
9610 			scx_error(sch, "PREEMPT/WAIT cannot be used with SCX_KICK_IDLE");
9611 
9612 		if (raw_spin_rq_trylock(target_rq)) {
9613 			if (can_skip_idle_kick(target_rq)) {
9614 				scx_rq_lock_drop(target_rq);
9615 				raw_spin_rq_unlock(target_rq);
9616 				goto out;
9617 			}
9618 			scx_rq_lock_drop(target_rq);
9619 			raw_spin_rq_unlock(target_rq);
9620 		}
9621 		cpumask_set_cpu(cpu, pcpu->cpus_to_kick_if_idle);
9622 	} else {
9623 		cpumask_set_cpu(cpu, pcpu->cpus_to_kick);
9624 
9625 		if (flags & SCX_KICK_PREEMPT)
9626 			cpumask_set_cpu(cpu, pcpu->cpus_to_preempt);
9627 		if (flags & SCX_KICK_WAIT)
9628 			cpumask_set_cpu(cpu, pcpu->cpus_to_wait);
9629 	}
9630 
9631 	if (list_empty(&pcpu->to_kick_node))
9632 		list_add_tail(&pcpu->to_kick_node, &this_rq->scx.sched_pcpus_to_kick);
9633 	irq_work_queue(&this_rq->scx.kick_cpus_irq_work);
9634 out:
9635 	local_irq_restore(irq_flags);
9636 }
9637 
9638 /**
9639  * scx_bpf_kick_cpu - Trigger reschedule on a CPU
9640  * @cpu: cpu to kick
9641  * @flags: %SCX_KICK_* flags
9642  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9643  *
9644  * Kick @cpu into rescheduling. This can be used to wake up an idle CPU or
9645  * trigger rescheduling on a busy CPU. This can be called from any online
9646  * scx_ops operation and the actual kicking is performed asynchronously through
9647  * an irq work.
9648  */
scx_bpf_kick_cpu(s32 cpu,u64 flags,const struct bpf_prog_aux * aux)9649 __bpf_kfunc void scx_bpf_kick_cpu(s32 cpu, u64 flags, const struct bpf_prog_aux *aux)
9650 {
9651 	struct scx_sched *sch;
9652 
9653 	guard(rcu)();
9654 	sch = scx_prog_sched(aux);
9655 	if (likely(sch) && scx_cpu_valid(sch, cpu, NULL))
9656 		scx_kick_cpu(sch, cpu, flags);
9657 }
9658 
9659 /**
9660  * scx_bpf_kick_cid - Trigger reschedule on the CPU mapped to @cid
9661  * @cid: cid to kick
9662  * @flags: %SCX_KICK_* flags
9663  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9664  *
9665  * cid-addressed equivalent of scx_bpf_kick_cpu(). An invalid @cid aborts the
9666  * scheduler via scx_cid_to_cpu(). Caps are enforced on the delivery path: a
9667  * kick is dropped if the caller lacks baseline access on @cid, and a
9668  * %SCX_KICK_PREEMPT degrades to a plain reschedule if the caller lacks
9669  * %SCX_CAP_PREEMPT for a task outside its subtree.
9670  */
scx_bpf_kick_cid(s32 cid,u64 flags,const struct bpf_prog_aux * aux)9671 __bpf_kfunc void scx_bpf_kick_cid(s32 cid, u64 flags, const struct bpf_prog_aux *aux)
9672 {
9673 	struct scx_sched *sch;
9674 	s32 cpu;
9675 
9676 	guard(rcu)();
9677 	sch = scx_prog_sched(aux);
9678 	if (unlikely(!sch))
9679 		return;
9680 	cpu = scx_cid_to_cpu(sch, cid);
9681 	if (cpu < 0)
9682 		return;
9683 	scx_kick_cpu(sch, cpu, flags);
9684 }
9685 
9686 /**
9687  * scx_bpf_dsq_nr_queued - Return the number of queued tasks
9688  * @dsq_id: id of the DSQ
9689  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9690  *
9691  * Return the number of tasks in the DSQ matching @dsq_id. If not found,
9692  * -%ENOENT is returned.
9693  *
9694  * %SCX_DSQ_LOCAL resolves to the local DSQ of the rq the current scheduler
9695  * operation is locked to - e.g. the rq being dispatched for in ops.dispatch() -
9696  * or the calling CPU's when no rq is locked.
9697  */
scx_bpf_dsq_nr_queued(u64 dsq_id,const struct bpf_prog_aux * aux)9698 __bpf_kfunc s32 scx_bpf_dsq_nr_queued(u64 dsq_id, const struct bpf_prog_aux *aux)
9699 {
9700 	struct scx_sched *sch;
9701 	struct scx_dispatch_q *dsq;
9702 	s32 ret;
9703 
9704 	preempt_disable();
9705 
9706 	sch = scx_prog_sched(aux);
9707 	if (unlikely(!sch)) {
9708 		ret = -ENODEV;
9709 		goto out;
9710 	}
9711 
9712 	if (dsq_id == SCX_DSQ_LOCAL) {
9713 		ret = READ_ONCE((scx_locked_rq() ?: this_rq())->scx.local_dsq.nr);
9714 		goto out;
9715 	} else if ((dsq_id & SCX_DSQ_LOCAL_ON) == SCX_DSQ_LOCAL_ON) {
9716 		s32 cpu = scx_cpu_ret(sch, dsq_id & SCX_DSQ_LOCAL_CPU_MASK);
9717 
9718 		if (scx_cpu_valid(sch, cpu, NULL)) {
9719 			ret = READ_ONCE(cpu_rq(cpu)->scx.local_dsq.nr);
9720 			goto out;
9721 		}
9722 	} else {
9723 		dsq = find_user_dsq(sch, dsq_id);
9724 		if (dsq) {
9725 			ret = READ_ONCE(dsq->nr);
9726 			goto out;
9727 		}
9728 	}
9729 	ret = -ENOENT;
9730 out:
9731 	preempt_enable();
9732 	return ret;
9733 }
9734 
9735 /**
9736  * scx_bpf_destroy_dsq - Destroy a custom DSQ
9737  * @dsq_id: DSQ to destroy
9738  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9739  *
9740  * Destroy the custom DSQ identified by @dsq_id. Only DSQs created with
9741  * scx_bpf_create_dsq() can be destroyed. The caller must ensure that the DSQ is
9742  * empty and no further tasks are dispatched to it. Ignored if called on a DSQ
9743  * which doesn't exist. Can be called from any online scx_ops operations.
9744  */
scx_bpf_destroy_dsq(u64 dsq_id,const struct bpf_prog_aux * aux)9745 __bpf_kfunc void scx_bpf_destroy_dsq(u64 dsq_id, const struct bpf_prog_aux *aux)
9746 {
9747 	struct scx_sched *sch;
9748 
9749 	guard(rcu)();
9750 	sch = scx_prog_sched(aux);
9751 	if (sch)
9752 		destroy_dsq(sch, dsq_id);
9753 }
9754 
9755 /**
9756  * bpf_iter_scx_dsq_new - Create a DSQ iterator
9757  * @it: iterator to initialize
9758  * @dsq_id: DSQ to iterate
9759  * @flags: %SCX_DSQ_ITER_*
9760  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9761  *
9762  * Initialize BPF iterator @it which can be used with bpf_for_each() to walk
9763  * tasks in the DSQ specified by @dsq_id. Iteration using @it only includes
9764  * tasks which are already queued when this function is invoked.
9765  */
bpf_iter_scx_dsq_new(struct bpf_iter_scx_dsq * it,u64 dsq_id,u64 flags,const struct bpf_prog_aux * aux)9766 __bpf_kfunc int bpf_iter_scx_dsq_new(struct bpf_iter_scx_dsq *it, u64 dsq_id,
9767 				     u64 flags, const struct bpf_prog_aux *aux)
9768 {
9769 	struct bpf_iter_scx_dsq_kern *kit = (void *)it;
9770 	struct scx_sched *sch;
9771 
9772 	BUILD_BUG_ON(sizeof(struct bpf_iter_scx_dsq_kern) >
9773 		     sizeof(struct bpf_iter_scx_dsq));
9774 	BUILD_BUG_ON(__alignof__(struct bpf_iter_scx_dsq_kern) !=
9775 		     __alignof__(struct bpf_iter_scx_dsq));
9776 	BUILD_BUG_ON(__SCX_DSQ_ITER_ALL_FLAGS &
9777 		     ((1U << __SCX_DSQ_LNODE_PRIV_SHIFT) - 1));
9778 
9779 	/*
9780 	 * next() and destroy() will be called regardless of the return value.
9781 	 * Always clear $kit->dsq.
9782 	 */
9783 	kit->dsq = NULL;
9784 
9785 	sch = scx_prog_sched(aux);
9786 	if (unlikely(!sch))
9787 		return -ENODEV;
9788 
9789 	if (flags & ~__SCX_DSQ_ITER_USER_FLAGS)
9790 		return -EINVAL;
9791 
9792 	kit->dsq = find_user_dsq(sch, dsq_id);
9793 	if (!kit->dsq)
9794 		return -ENOENT;
9795 
9796 	kit->cursor = INIT_DSQ_LIST_CURSOR(kit->cursor, kit->dsq, flags);
9797 
9798 	return 0;
9799 }
9800 
9801 /**
9802  * bpf_iter_scx_dsq_next - Progress a DSQ iterator
9803  * @it: iterator to progress
9804  *
9805  * Return the next task. See bpf_iter_scx_dsq_new().
9806  */
bpf_iter_scx_dsq_next(struct bpf_iter_scx_dsq * it)9807 __bpf_kfunc struct task_struct *bpf_iter_scx_dsq_next(struct bpf_iter_scx_dsq *it)
9808 {
9809 	struct bpf_iter_scx_dsq_kern *kit = (void *)it;
9810 
9811 	if (!kit->dsq)
9812 		return NULL;
9813 
9814 	guard(raw_spinlock_irqsave)(&kit->dsq->lock);
9815 
9816 	return nldsq_cursor_next_task(&kit->cursor, kit->dsq);
9817 }
9818 
9819 /**
9820  * bpf_iter_scx_dsq_destroy - Destroy a DSQ iterator
9821  * @it: iterator to destroy
9822  *
9823  * Undo bpf_iter_scx_dsq_new().
9824  */
bpf_iter_scx_dsq_destroy(struct bpf_iter_scx_dsq * it)9825 __bpf_kfunc void bpf_iter_scx_dsq_destroy(struct bpf_iter_scx_dsq *it)
9826 {
9827 	struct bpf_iter_scx_dsq_kern *kit = (void *)it;
9828 
9829 	if (!kit->dsq)
9830 		return;
9831 
9832 	if (!list_empty(&kit->cursor.node)) {
9833 		unsigned long flags;
9834 
9835 		raw_spin_lock_irqsave(&kit->dsq->lock, flags);
9836 		list_del_init(&kit->cursor.node);
9837 		raw_spin_unlock_irqrestore(&kit->dsq->lock, flags);
9838 	}
9839 	kit->dsq = NULL;
9840 }
9841 
9842 /**
9843  * scx_bpf_dsq_peek - Lockless peek at the first element.
9844  * @dsq_id: DSQ to examine.
9845  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9846  *
9847  * Read the first element in the DSQ. This is semantically equivalent to using
9848  * the DSQ iterator, but is lockfree. Of course, like any lockless operation,
9849  * this provides only a point-in-time snapshot, and the contents may change
9850  * by the time any subsequent locking operation reads the queue.
9851  *
9852  * Returns the pointer, or NULL indicates an empty queue OR internal error.
9853  */
scx_bpf_dsq_peek(u64 dsq_id,const struct bpf_prog_aux * aux)9854 __bpf_kfunc struct task_struct *scx_bpf_dsq_peek(u64 dsq_id,
9855 						 const struct bpf_prog_aux *aux)
9856 {
9857 	struct scx_sched *sch;
9858 	struct scx_dispatch_q *dsq;
9859 
9860 	sch = scx_prog_sched(aux);
9861 	if (unlikely(!sch))
9862 		return NULL;
9863 
9864 	if (unlikely(dsq_id & SCX_DSQ_FLAG_BUILTIN)) {
9865 		scx_error(sch, "peek disallowed on builtin DSQ 0x%llx", dsq_id);
9866 		return NULL;
9867 	}
9868 
9869 	dsq = find_user_dsq(sch, dsq_id);
9870 	if (unlikely(!dsq)) {
9871 		scx_error(sch, "peek on non-existent DSQ 0x%llx", dsq_id);
9872 		return NULL;
9873 	}
9874 
9875 	return rcu_dereference(dsq->first_task);
9876 }
9877 
9878 /**
9879  * scx_bpf_dsq_reenq - Re-enqueue tasks on a DSQ
9880  * @dsq_id: DSQ to re-enqueue
9881  * @reenq_flags: %SCX_RENQ_*
9882  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9883  *
9884  * Iterate over all of the tasks currently enqueued on the DSQ identified by
9885  * @dsq_id, and re-enqueue them in the BPF scheduler. The following DSQs are
9886  * supported:
9887  *
9888  * - Local DSQs (%SCX_DSQ_LOCAL or %SCX_DSQ_LOCAL_ON | $cpu)
9889  * - User DSQs
9890  *
9891  * Re-enqueues are performed asynchronously. Can be called from anywhere.
9892  *
9893  * %SCX_DSQ_LOCAL resolves to the local DSQ of the rq the current scheduler
9894  * operation is locked to - e.g. the rq being dispatched for in ops.dispatch() -
9895  * or the calling CPU's when no rq is locked.
9896  */
scx_bpf_dsq_reenq(u64 dsq_id,u64 reenq_flags,const struct bpf_prog_aux * aux)9897 __bpf_kfunc void scx_bpf_dsq_reenq(u64 dsq_id, u64 reenq_flags,
9898 				   const struct bpf_prog_aux *aux)
9899 {
9900 	struct rq *locked_rq = scx_locked_rq();
9901 	struct scx_sched *sch;
9902 	struct scx_dispatch_q *dsq;
9903 
9904 	guard(preempt)();
9905 
9906 	sch = scx_prog_sched(aux);
9907 	if (unlikely(!sch))
9908 		return;
9909 
9910 	if (unlikely(reenq_flags & ~__SCX_REENQ_USER_MASK)) {
9911 		scx_error(sch, "invalid SCX_REENQ flags 0x%llx", reenq_flags);
9912 		return;
9913 	}
9914 
9915 	/* not specifying any filter bits is the same as %SCX_REENQ_ANY */
9916 	if (!(reenq_flags & __SCX_REENQ_FILTER_MASK))
9917 		reenq_flags |= SCX_REENQ_ANY;
9918 
9919 	dsq = find_dsq_for_dispatch(sch, locked_rq ?: this_rq(), dsq_id, smp_processor_id());
9920 	schedule_dsq_reenq(sch, dsq, reenq_flags, locked_rq);
9921 }
9922 
9923 /**
9924  * scx_bpf_reenqueue_local___v2 - Re-enqueue tasks on a local DSQ
9925  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9926  *
9927  * Iterate over all of the tasks currently enqueued on the local DSQ of the
9928  * caller's CPU, and re-enqueue them in the BPF scheduler. Can be called from
9929  * anywhere.
9930  *
9931  * This is now a special case of scx_bpf_dsq_reenq() and may be removed in the
9932  * future.
9933  */
scx_bpf_reenqueue_local___v2(const struct bpf_prog_aux * aux)9934 __bpf_kfunc void scx_bpf_reenqueue_local___v2(const struct bpf_prog_aux *aux)
9935 {
9936 	scx_bpf_dsq_reenq(SCX_DSQ_LOCAL, 0, aux);
9937 }
9938 
9939 __bpf_kfunc_end_defs();
9940 
9941 __printf(5, 0)
__bstr_format(struct scx_sched * sch,u64 * data_buf,char * line_buf,size_t line_size,char * fmt,unsigned long long * data,u32 data__sz)9942 static s32 __bstr_format(struct scx_sched *sch, u64 *data_buf, char *line_buf,
9943 			 size_t line_size, char *fmt, unsigned long long *data,
9944 			 u32 data__sz)
9945 {
9946 	struct bpf_bprintf_data bprintf_data = { .get_bin_args = true };
9947 	s32 ret;
9948 
9949 	if (data__sz % 8 || data__sz > MAX_BPRINTF_VARARGS * 8 ||
9950 	    (data__sz && !data)) {
9951 		scx_error(sch, "invalid data=%p and data__sz=%u", (void *)data, data__sz);
9952 		return -EINVAL;
9953 	}
9954 
9955 	ret = copy_from_kernel_nofault(data_buf, data, data__sz);
9956 	if (ret < 0) {
9957 		scx_error(sch, "failed to read data fields (%d)", ret);
9958 		return ret;
9959 	}
9960 
9961 	ret = bpf_bprintf_prepare(fmt, UINT_MAX, data_buf, data__sz / 8,
9962 				  &bprintf_data);
9963 	if (ret < 0) {
9964 		scx_error(sch, "format preparation failed (%d)", ret);
9965 		return ret;
9966 	}
9967 
9968 	ret = bstr_printf(line_buf, line_size, fmt,
9969 			  bprintf_data.bin_args);
9970 	bpf_bprintf_cleanup(&bprintf_data);
9971 	if (ret < 0) {
9972 		scx_error(sch, "(\"%s\", %p, %u) failed to format", fmt, data, data__sz);
9973 		return ret;
9974 	}
9975 
9976 	return ret;
9977 }
9978 
9979 /*
9980  * Exit @sch with the reason formatted from a BPF-supplied bstr format. The exit
9981  * is claimed first and the reason is formatted directly into the winner-owned
9982  * exit_info buffer, which allows use from any context including NMI.
9983  *
9984  * @fmt_blame is the sched blamed for formatting failures through the
9985  * scx_error() calls in __bstr_format() and differs from @sch when a parent
9986  * supplies the kill reason for a child. A formatting failure doesn't revert the
9987  * claim - @sch still exits with the claimed kind and a fallback message.
9988  */
9989 __printf(5, 0)
scx_exit_bstr(struct scx_sched * sch,enum scx_exit_kind kind,s64 exit_code,struct scx_sched * fmt_blame,char * fmt,unsigned long long * data,u32 data__sz)9990 bool scx_exit_bstr(struct scx_sched *sch, enum scx_exit_kind kind,
9991 		   s64 exit_code, struct scx_sched *fmt_blame, char *fmt,
9992 		   unsigned long long *data, u32 data__sz)
9993 {
9994 	struct scx_exit_info *ei = sch->exit_info;
9995 	u64 data_buf[MAX_BPRINTF_VARARGS];
9996 	s32 ret;
9997 
9998 	guard(preempt)();
9999 
10000 	if (!scx_claim_exit(sch, kind))
10001 		return false;
10002 
10003 	ret = __bstr_format(fmt_blame, data_buf, ei->msg, SCX_EXIT_MSG_LEN,
10004 			    fmt, data, data__sz);
10005 	if (ret < 0)
10006 		scnprintf(ei->msg, SCX_EXIT_MSG_LEN,
10007 			  "exit message formatting failed (%d)", ret);
10008 
10009 	scx_finish_exit(sch, kind, exit_code, raw_smp_processor_id());
10010 	return true;
10011 }
10012 
10013 __bpf_kfunc_start_defs();
10014 
10015 /**
10016  * scx_bpf_exit_bstr - Gracefully exit the BPF scheduler.
10017  * @exit_code: Exit value to pass to user space via struct scx_exit_info.
10018  * @fmt: error message format string
10019  * @data: format string parameters packaged using ___bpf_fill() macro
10020  * @data__sz: @data len, must end in '__sz' for the verifier
10021  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10022  *
10023  * Indicate that the BPF scheduler wants to exit gracefully, and initiate ops
10024  * disabling.
10025  */
10026 __printf(2, 0)
scx_bpf_exit_bstr(s64 exit_code,char * fmt,unsigned long long * data,u32 data__sz,const struct bpf_prog_aux * aux)10027 __bpf_kfunc void scx_bpf_exit_bstr(s64 exit_code, char *fmt,
10028 				   unsigned long long *data, u32 data__sz,
10029 				   const struct bpf_prog_aux *aux)
10030 {
10031 	struct scx_sched *sch;
10032 
10033 	guard(rcu)();
10034 
10035 	sch = scx_prog_sched(aux);
10036 	if (likely(sch))
10037 		scx_exit_bstr(sch, SCX_EXIT_UNREG_BPF, exit_code, sch, fmt,
10038 			      data, data__sz);
10039 }
10040 
10041 /**
10042  * scx_bpf_error_bstr - Indicate fatal error
10043  * @fmt: error message format string
10044  * @data: format string parameters packaged using ___bpf_fill() macro
10045  * @data__sz: @data len, must end in '__sz' for the verifier
10046  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10047  *
10048  * Indicate that the BPF scheduler encountered a fatal error and initiate ops
10049  * disabling.
10050  */
10051 __printf(1, 0)
scx_bpf_error_bstr(char * fmt,unsigned long long * data,u32 data__sz,const struct bpf_prog_aux * aux)10052 __bpf_kfunc void scx_bpf_error_bstr(char *fmt, unsigned long long *data,
10053 				    u32 data__sz, const struct bpf_prog_aux *aux)
10054 {
10055 	struct scx_sched *sch;
10056 
10057 	guard(rcu)();
10058 
10059 	sch = scx_prog_sched(aux);
10060 	if (likely(sch))
10061 		scx_exit_bstr(sch, SCX_EXIT_ERROR_BPF, 0, sch, fmt, data,
10062 			      data__sz);
10063 }
10064 
10065 /**
10066  * scx_bpf_dump_bstr - Generate extra debug dump specific to the BPF scheduler
10067  * @fmt: format string
10068  * @data: format string parameters packaged using ___bpf_fill() macro
10069  * @data__sz: @data len, must end in '__sz' for the verifier
10070  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10071  *
10072  * To be called through scx_bpf_dump() helper from ops.dump(), dump_cpu() and
10073  * dump_task() to generate extra debug dump specific to the BPF scheduler.
10074  *
10075  * The extra dump may be multiple lines. A single line may be split over
10076  * multiple calls. The last line is automatically terminated.
10077  */
10078 __printf(1, 0)
scx_bpf_dump_bstr(char * fmt,unsigned long long * data,u32 data__sz,const struct bpf_prog_aux * aux)10079 __bpf_kfunc void scx_bpf_dump_bstr(char *fmt, unsigned long long *data,
10080 				   u32 data__sz, const struct bpf_prog_aux *aux)
10081 {
10082 	struct scx_sched *sch;
10083 	struct scx_dump_data *dd = &scx_dump_data;
10084 	struct scx_bstr_buf *buf = &dd->buf;
10085 	s32 ret;
10086 
10087 	guard(rcu)();
10088 
10089 	sch = scx_prog_sched(aux);
10090 	if (unlikely(!sch))
10091 		return;
10092 
10093 	if (raw_smp_processor_id() != dd->cpu) {
10094 		scx_error(sch, "scx_bpf_dump() must only be called from ops.dump() and friends");
10095 		return;
10096 	}
10097 
10098 	/* append the formatted string to the line buf */
10099 	ret = __bstr_format(sch, buf->data, buf->line + dd->cursor,
10100 			    sizeof(buf->line) - dd->cursor, fmt, data, data__sz);
10101 	if (ret < 0) {
10102 		scx_dump_line(dd->s, "%s[!] (\"%s\", %p, %u) failed to format (%d)",
10103 			      dd->prefix, fmt, data, data__sz, ret);
10104 		return;
10105 	}
10106 
10107 	dd->cursor += ret;
10108 	dd->cursor = min_t(s32, dd->cursor, sizeof(buf->line));
10109 
10110 	if (!dd->cursor)
10111 		return;
10112 
10113 	/*
10114 	 * If the line buf overflowed or ends in a newline, flush it into the
10115 	 * dump. This is to allow the caller to generate a single line over
10116 	 * multiple calls. As ops_dump_flush() can also handle multiple lines in
10117 	 * the line buf, the only case which can lead to an unexpected
10118 	 * truncation is when the caller keeps generating newlines in the middle
10119 	 * instead of the end consecutively. Don't do that.
10120 	 */
10121 	if (dd->cursor >= sizeof(buf->line) || buf->line[dd->cursor - 1] == '\n')
10122 		ops_dump_flush();
10123 }
10124 
10125 /**
10126  * scx_bpf_cpuperf_cap - Query the maximum relative capacity of a CPU
10127  * @cpu: CPU of interest
10128  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10129  *
10130  * Return the maximum relative capacity of @cpu in relation to the most
10131  * performant CPU in the system. The return value is in the range [1,
10132  * %SCX_CPUPERF_ONE]. See scx_bpf_cpuperf_cur().
10133  */
scx_bpf_cpuperf_cap(s32 cpu,const struct bpf_prog_aux * aux)10134 __bpf_kfunc u32 scx_bpf_cpuperf_cap(s32 cpu, const struct bpf_prog_aux *aux)
10135 {
10136 	struct scx_sched *sch;
10137 
10138 	guard(rcu)();
10139 
10140 	sch = scx_prog_sched(aux);
10141 	if (likely(sch) && scx_cpu_valid(sch, cpu, NULL))
10142 		return arch_scale_cpu_capacity(cpu);
10143 	else
10144 		return SCX_CPUPERF_ONE;
10145 }
10146 
10147 /**
10148  * scx_bpf_cidperf_cap - Query the maximum relative capacity of the CPU at @cid
10149  * @cid: cid of the CPU to query
10150  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10151  *
10152  * cid-addressed equivalent of scx_bpf_cpuperf_cap().
10153  */
scx_bpf_cidperf_cap(s32 cid,const struct bpf_prog_aux * aux)10154 __bpf_kfunc u32 scx_bpf_cidperf_cap(s32 cid, const struct bpf_prog_aux *aux)
10155 {
10156 	struct scx_sched *sch;
10157 	s32 cpu;
10158 
10159 	guard(rcu)();
10160 
10161 	sch = scx_prog_sched(aux);
10162 	if (unlikely(!sch))
10163 		return SCX_CPUPERF_ONE;
10164 	cpu = scx_cid_to_cpu(sch, cid);
10165 	if (cpu < 0)
10166 		return SCX_CPUPERF_ONE;
10167 	return arch_scale_cpu_capacity(cpu);
10168 }
10169 
10170 /**
10171  * scx_bpf_cpuperf_cur - Query the current relative performance of a CPU
10172  * @cpu: CPU of interest
10173  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10174  *
10175  * Return the current relative performance of @cpu in relation to its maximum.
10176  * The return value is in the range [1, %SCX_CPUPERF_ONE].
10177  *
10178  * The current performance level of a CPU in relation to the maximum performance
10179  * available in the system can be calculated as follows:
10180  *
10181  *   scx_bpf_cpuperf_cap() * scx_bpf_cpuperf_cur() / %SCX_CPUPERF_ONE
10182  *
10183  * The result is in the range [1, %SCX_CPUPERF_ONE].
10184  */
scx_bpf_cpuperf_cur(s32 cpu,const struct bpf_prog_aux * aux)10185 __bpf_kfunc u32 scx_bpf_cpuperf_cur(s32 cpu, const struct bpf_prog_aux *aux)
10186 {
10187 	struct scx_sched *sch;
10188 
10189 	guard(rcu)();
10190 
10191 	sch = scx_prog_sched(aux);
10192 	if (likely(sch) && scx_cpu_valid(sch, cpu, NULL))
10193 		return arch_scale_freq_capacity(cpu);
10194 	else
10195 		return SCX_CPUPERF_ONE;
10196 }
10197 
10198 /**
10199  * scx_bpf_cidperf_cur - Query the current performance of the CPU at @cid
10200  * @cid: cid of the CPU to query
10201  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10202  *
10203  * cid-addressed equivalent of scx_bpf_cpuperf_cur().
10204  */
scx_bpf_cidperf_cur(s32 cid,const struct bpf_prog_aux * aux)10205 __bpf_kfunc u32 scx_bpf_cidperf_cur(s32 cid, const struct bpf_prog_aux *aux)
10206 {
10207 	struct scx_sched *sch;
10208 	s32 cpu;
10209 
10210 	guard(rcu)();
10211 
10212 	sch = scx_prog_sched(aux);
10213 	if (unlikely(!sch))
10214 		return SCX_CPUPERF_ONE;
10215 	cpu = scx_cid_to_cpu(sch, cid);
10216 	if (cpu < 0)
10217 		return SCX_CPUPERF_ONE;
10218 	return arch_scale_freq_capacity(cpu);
10219 }
10220 
10221 /* validate and apply a cpuperf target, see scx_bpf_cpuperf_set() */
scx_cpuperf_set(struct scx_sched * sch,s32 cpu,u32 perf)10222 static s32 scx_cpuperf_set(struct scx_sched *sch, s32 cpu, u32 perf)
10223 {
10224 	struct rq *rq, *locked_rq;
10225 	struct rq_flags rf;
10226 	s32 ret;
10227 
10228 	if (unlikely(perf > SCX_CPUPERF_ONE)) {
10229 		scx_error(sch, "Invalid cpuperf target %u for CPU %d", perf, cpu);
10230 		return -EINVAL;
10231 	}
10232 
10233 	if (!scx_cpu_valid(sch, cpu, NULL))
10234 		return -EINVAL;
10235 
10236 	rq = cpu_rq(cpu);
10237 	locked_rq = scx_locked_rq();
10238 
10239 	/*
10240 	 * When called with an rq lock held, restrict the operation to the
10241 	 * corresponding CPU to prevent ABBA deadlocks.
10242 	 */
10243 	if (locked_rq && rq != locked_rq) {
10244 		scx_error(sch, "Invalid target CPU %d", cpu);
10245 		return -EINVAL;
10246 	}
10247 
10248 	/*
10249 	 * If no rq lock is held, allow to operate on any CPU by acquiring
10250 	 * the corresponding rq lock.
10251 	 */
10252 	if (!locked_rq) {
10253 		rq_lock_irqsave(rq, &rf);
10254 		update_rq_clock(rq);
10255 	}
10256 
10257 	/*
10258 	 * ecaps updates are folded under the rq lock, making this test
10259 	 * authoritative: a write can never land after a revoke has taken
10260 	 * effect on @cpu.
10261 	 */
10262 	if (likely(!scx_missing_caps(sch, cpu, SCX_CAP_PERF))) {
10263 		rq->scx.cpuperf_target = perf;
10264 		cpufreq_update_util(rq, 0);
10265 		ret = 0;
10266 	} else {
10267 		__scx_add_event(sch, SCX_EV_SUB_CIDPERF_DENIED, 1);
10268 		ret = -EACCES;
10269 	}
10270 
10271 	if (!locked_rq)
10272 		rq_unlock_irqrestore(rq, &rf);
10273 
10274 	return ret;
10275 }
10276 
10277 /**
10278  * scx_bpf_cpuperf_set - Set the relative performance target of a CPU
10279  * @cpu: CPU of interest
10280  * @perf: target performance level [0, %SCX_CPUPERF_ONE]
10281  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10282  *
10283  * Set the target performance level of @cpu to @perf. @perf is in linear
10284  * relative scale between 0 and %SCX_CPUPERF_ONE. This determines how the
10285  * schedutil cpufreq governor chooses the target frequency.
10286  *
10287  * The actual performance level chosen, CPU grouping, and the overhead and
10288  * latency of the operations are dependent on the hardware and cpufreq driver in
10289  * use. Consult hardware and cpufreq documentation for more information. The
10290  * current performance level can be monitored using scx_bpf_cpuperf_cur().
10291  */
scx_bpf_cpuperf_set(s32 cpu,u32 perf,const struct bpf_prog_aux * aux)10292 __bpf_kfunc void scx_bpf_cpuperf_set(s32 cpu, u32 perf, const struct bpf_prog_aux *aux)
10293 {
10294 	struct scx_sched *sch;
10295 
10296 	guard(rcu)();
10297 
10298 	sch = scx_prog_sched(aux);
10299 	if (unlikely(!sch))
10300 		return;
10301 
10302 	scx_cpuperf_set(sch, cpu, perf);
10303 }
10304 
10305 /**
10306  * scx_bpf_cidperf_set - Set the performance target of the CPU at @cid
10307  * @cid: cid of the CPU to target
10308  * @perf: target performance level [0, %SCX_CPUPERF_ONE]
10309  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10310  *
10311  * cid-addressed equivalent of scx_bpf_cpuperf_set(). A sub-sched needs
10312  * SCX_CAP_PERF on @cid. Returns 0 if the target was applied, -%EACCES if
10313  * the write was denied for missing caps, other -errnos if @cid didn't
10314  * resolve.
10315  */
scx_bpf_cidperf_set(s32 cid,u32 perf,const struct bpf_prog_aux * aux)10316 __bpf_kfunc s32 scx_bpf_cidperf_set(s32 cid, u32 perf,
10317 				    const struct bpf_prog_aux *aux)
10318 {
10319 	struct scx_sched *sch;
10320 	s32 cpu;
10321 
10322 	guard(rcu)();
10323 
10324 	sch = scx_prog_sched(aux);
10325 	if (unlikely(!sch))
10326 		return -ENODEV;
10327 	cpu = scx_cid_to_cpu(sch, cid);
10328 	if (cpu < 0)
10329 		return cpu;
10330 
10331 	return scx_cpuperf_set(sch, cpu, perf);
10332 }
10333 
10334 /**
10335  * scx_bpf_nr_node_ids - Return the number of possible node IDs
10336  *
10337  * All valid node IDs in the system are smaller than the returned value.
10338  */
scx_bpf_nr_node_ids(void)10339 __bpf_kfunc u32 scx_bpf_nr_node_ids(void)
10340 {
10341 	return nr_node_ids;
10342 }
10343 
10344 /**
10345  * scx_bpf_nr_cpu_ids - Return the number of possible CPU IDs
10346  *
10347  * All valid CPU IDs in the system are smaller than the returned value.
10348  */
scx_bpf_nr_cpu_ids(void)10349 __bpf_kfunc u32 scx_bpf_nr_cpu_ids(void)
10350 {
10351 	return nr_cpu_ids;
10352 }
10353 
10354 /**
10355  * scx_bpf_nr_cids - Return the size of the cid space
10356  *
10357  * Equals num_possible_cpus(). All valid cids are in [0, return value).
10358  */
scx_bpf_nr_cids(void)10359 __bpf_kfunc u32 scx_bpf_nr_cids(void)
10360 {
10361 	return num_possible_cpus();
10362 }
10363 
10364 /**
10365  * scx_bpf_nr_online_cids - Return current count of online CPUs in cid space
10366  *
10367  * Return num_online_cpus(). The standard model restarts the scheduler on
10368  * hotplug, which lets schedulers treat [0, nr_online_cids) as the online
10369  * range. Schedulers that prefer to handle hotplug without a restart should
10370  * install a custom mapping via scx_bpf_cid_override() and track onlining
10371  * through the ops.cid_online / ops.cid_offline callbacks, starting from the
10372  * mask scx_bpf_online_cmask() returns.
10373  */
scx_bpf_nr_online_cids(void)10374 __bpf_kfunc u32 scx_bpf_nr_online_cids(void)
10375 {
10376 	return num_online_cpus();
10377 }
10378 
10379 /**
10380  * scx_bpf_online_cmask - Return the online cid mask in the scheduler arena
10381  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10382  *
10383  * Return a kernel-maintained cmask covering [0, scx_bpf_nr_cids()), or NULL if
10384  * the calling program is not associated with a live cid-form scheduler or the
10385  * mask is not allocated yet, as in ops.init_cids(). Treat the mask as read-only
10386  * even though arena memory stays writable by the BPF scheduler. The mask
10387  * follows the SCX hotplug notifications: a cid's bit is updated before
10388  * ops.cid_online/offline() runs for it. The pointer is valid from ops.init()
10389  * through ops.exit(). Root ops.init() runs with hotplug excluded. Other
10390  * contexts can observe concurrent updates.
10391  */
scx_bpf_online_cmask(const struct bpf_prog_aux * aux)10392 __bpf_kfunc const void *scx_bpf_online_cmask(const struct bpf_prog_aux *aux)
10393 {
10394 	struct scx_sched *sch;
10395 	struct scx_cmask *online;
10396 
10397 	guard(rcu)();
10398 
10399 	sch = scx_prog_sched(aux);
10400 	if (unlikely(!sch))
10401 		return NULL;
10402 	online = sch->online_cmask;
10403 	if (unlikely(!online))
10404 		return NULL;
10405 
10406 	/* BPF rebases by the low 32 bits, like __arena callback args */
10407 	return (void *)((unsigned long)online - sch->arena_kern_base);
10408 }
10409 
10410 /**
10411  * scx_bpf_this_cid - Return the cid of the CPU this program is running on
10412  *
10413  * cid-addressed equivalent of bpf_get_smp_processor_id() for scx programs.
10414  * The current cpu is trivially valid, so this is just a table lookup. Return
10415  * -EINVAL if called before any scheduler has ever published its cid tables.
10416  */
scx_bpf_this_cid(void)10417 __bpf_kfunc s32 scx_bpf_this_cid(void)
10418 {
10419 	s16 *tbl;
10420 
10421 	guard(rcu)();
10422 
10423 	tbl = rcu_dereference(scx_cpu_to_cid_tbl);
10424 	if (!tbl)
10425 		return -EINVAL;
10426 	return tbl[raw_smp_processor_id()];
10427 }
10428 
10429 /**
10430  * scx_bpf_get_possible_cpumask - Get a referenced kptr to cpu_possible_mask
10431  */
scx_bpf_get_possible_cpumask(void)10432 __bpf_kfunc const struct cpumask *scx_bpf_get_possible_cpumask(void)
10433 {
10434 	return cpu_possible_mask;
10435 }
10436 
10437 /**
10438  * scx_bpf_get_online_cpumask - Get a referenced kptr to cpu_online_mask
10439  */
scx_bpf_get_online_cpumask(void)10440 __bpf_kfunc const struct cpumask *scx_bpf_get_online_cpumask(void)
10441 {
10442 	return cpu_online_mask;
10443 }
10444 
10445 /**
10446  * scx_bpf_put_cpumask - Release a possible/online cpumask
10447  * @cpumask: cpumask to release
10448  */
scx_bpf_put_cpumask(const struct cpumask * cpumask)10449 __bpf_kfunc void scx_bpf_put_cpumask(const struct cpumask *cpumask)
10450 {
10451 	/*
10452 	 * Empty function body because we aren't actually acquiring or releasing
10453 	 * a reference to a global cpumask, which is read-only in the caller and
10454 	 * is never released. The acquire / release semantics here are just used
10455 	 * to make the cpumask is a trusted pointer in the caller.
10456 	 */
10457 }
10458 
10459 /**
10460  * scx_bpf_task_running - Is task currently running?
10461  * @p: task of interest
10462  */
scx_bpf_task_running(const struct task_struct * p)10463 __bpf_kfunc bool scx_bpf_task_running(const struct task_struct *p)
10464 {
10465 	return task_rq(p)->curr == p;
10466 }
10467 
10468 /**
10469  * scx_bpf_task_cpu - CPU a task is currently associated with
10470  * @p: task of interest
10471  */
scx_bpf_task_cpu(const struct task_struct * p)10472 __bpf_kfunc s32 scx_bpf_task_cpu(const struct task_struct *p)
10473 {
10474 	return task_cpu(p);
10475 }
10476 
10477 /**
10478  * scx_bpf_task_cid - cid a task is currently associated with
10479  * @p: task of interest
10480  *
10481  * cid-addressed equivalent of scx_bpf_task_cpu(). task_cpu(p) is always a
10482  * valid cpu, so this is just a table lookup. Return -EINVAL if called before
10483  * any scheduler has ever published its cid tables.
10484  */
scx_bpf_task_cid(const struct task_struct * p)10485 __bpf_kfunc s32 scx_bpf_task_cid(const struct task_struct *p)
10486 {
10487 	s16 *tbl;
10488 
10489 	/* KF_RCU covers only @p - a sleepable program holds no RCU lock */
10490 	guard(rcu)();
10491 
10492 	tbl = rcu_dereference(scx_cpu_to_cid_tbl);
10493 	if (!tbl)
10494 		return -EINVAL;
10495 	return tbl[task_cpu(p)];
10496 }
10497 
10498 /**
10499  * scx_bpf_locked_rq - Return the rq currently locked by SCX
10500  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10501  *
10502  * Returns the rq if a rq lock is currently held by SCX.
10503  * Otherwise emits an error and returns NULL.
10504  */
scx_bpf_locked_rq(const struct bpf_prog_aux * aux)10505 __bpf_kfunc struct rq *scx_bpf_locked_rq(const struct bpf_prog_aux *aux)
10506 {
10507 	struct scx_sched *sch;
10508 	struct rq *rq;
10509 
10510 	guard(preempt)();
10511 
10512 	sch = scx_prog_sched(aux);
10513 	if (unlikely(!sch))
10514 		return NULL;
10515 
10516 	rq = scx_locked_rq();
10517 	if (!rq) {
10518 		scx_error(sch, "accessing rq without holding rq lock");
10519 		return NULL;
10520 	}
10521 
10522 	return rq;
10523 }
10524 
10525 /**
10526  * scx_bpf_cpu_curr - Return remote CPU's curr task
10527  * @cpu: CPU of interest
10528  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10529  *
10530  * Callers must hold RCU read lock (KF_RCU).
10531  */
scx_bpf_cpu_curr(s32 cpu,const struct bpf_prog_aux * aux)10532 __bpf_kfunc struct task_struct *scx_bpf_cpu_curr(s32 cpu, const struct bpf_prog_aux *aux)
10533 {
10534 	struct scx_sched *sch;
10535 
10536 	guard(rcu)();
10537 
10538 	sch = scx_prog_sched(aux);
10539 	if (unlikely(!sch))
10540 		return NULL;
10541 
10542 	if (!scx_cpu_valid(sch, cpu, NULL))
10543 		return NULL;
10544 
10545 	return rcu_dereference(cpu_rq(cpu)->curr);
10546 }
10547 
10548 /**
10549  * scx_bpf_cid_curr - Return the curr task on the CPU at @cid
10550  * @cid: cid of interest
10551  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10552  *
10553  * cid-addressed equivalent of scx_bpf_cpu_curr(). Callers must hold RCU
10554  * read lock (KF_RCU).
10555  */
scx_bpf_cid_curr(s32 cid,const struct bpf_prog_aux * aux)10556 __bpf_kfunc struct task_struct *scx_bpf_cid_curr(s32 cid, const struct bpf_prog_aux *aux)
10557 {
10558 	struct scx_sched *sch;
10559 	s32 cpu;
10560 
10561 	guard(rcu)();
10562 
10563 	sch = scx_prog_sched(aux);
10564 	if (unlikely(!sch))
10565 		return NULL;
10566 	cpu = scx_cid_to_cpu(sch, cid);
10567 	if (cpu < 0)
10568 		return NULL;
10569 	return rcu_dereference(cpu_rq(cpu)->curr);
10570 }
10571 
10572 /**
10573  * scx_bpf_tid_to_task - Look up a task by its scx tid
10574  * @tid: task ID previously read from p->scx.tid
10575  *
10576  * Returns the task with the given tid, or NULL if no such task exists. The
10577  * returned pointer is valid until the end of the current RCU read section
10578  * (KF_RCU_PROTECTED). Requires SCX_OPS_TID_TO_TASK to be set on the root
10579  * scheduler; otherwise an error is raised and NULL returned.
10580  */
scx_bpf_tid_to_task(u64 tid)10581 __bpf_kfunc struct task_struct *scx_bpf_tid_to_task(u64 tid)
10582 {
10583 	struct sched_ext_entity *scx;
10584 
10585 	if (!scx_tid_to_task_enabled()) {
10586 		struct scx_sched *sch = rcu_dereference(scx_root);
10587 
10588 		if (sch)
10589 			scx_error(sch, "scx_bpf_tid_to_task() called without SCX_OPS_TID_TO_TASK");
10590 		return NULL;
10591 	}
10592 
10593 	scx = rhashtable_lookup(&scx_tid_hash, &tid, scx_tid_hash_params);
10594 	if (!scx)
10595 		return NULL;
10596 
10597 	return container_of(scx, struct task_struct, scx);
10598 }
10599 
__scx_bpf_now(struct rq * rq)10600 u64 __scx_bpf_now(struct rq *rq)
10601 {
10602 	/* the caller must be on @rq's cpu or hold its lock */
10603 	lockdep_assert((rq == this_rq() && !preemptible()) ||
10604 		       lockdep_is_held(__rq_lockp(rq)));
10605 
10606 	if (smp_load_acquire(&rq->scx.flags) & SCX_RQ_CLK_VALID) {
10607 		/* if the rq clock is valid, use the cached rq clock */
10608 		return READ_ONCE(rq->scx.clock);
10609 	} else {
10610 		/*
10611 		 * Otherwise, return a fresh rq clock.
10612 		 *
10613 		 * The rq clock is updated outside of the rq lock.
10614 		 * In this case, keep the updated rq clock invalid so the next
10615 		 * read outside the rq lock gets a fresh rq clock.
10616 		 */
10617 		return sched_clock_cpu(cpu_of(rq));
10618 	}
10619 }
10620 
10621 /**
10622  * scx_bpf_now - Returns a high-performance monotonically non-decreasing
10623  * clock for the current CPU. The clock returned is in nanoseconds.
10624  *
10625  * It provides the following properties:
10626  *
10627  * 1) High performance: Many BPF schedulers call bpf_ktime_get_ns() frequently
10628  *  to account for execution time and track tasks' runtime properties.
10629  *  Unfortunately, in some hardware platforms, bpf_ktime_get_ns() -- which
10630  *  eventually reads a hardware timestamp counter -- is neither performant nor
10631  *  scalable. scx_bpf_now() aims to provide a high-performance clock by
10632  *  using the rq clock in the scheduler core whenever possible.
10633  *
10634  * 2) High enough resolution for the BPF scheduler use cases: In most BPF
10635  *  scheduler use cases, the required clock resolution is lower than the most
10636  *  accurate hardware clock (e.g., rdtsc in x86). scx_bpf_now() basically
10637  *  uses the rq clock in the scheduler core whenever it is valid. It considers
10638  *  that the rq clock is valid from the time the rq clock is updated
10639  *  (update_rq_clock) until the rq is unlocked (rq_unpin_lock).
10640  *
10641  * 3) Monotonically non-decreasing clock for the same CPU: scx_bpf_now()
10642  *  guarantees the clock never goes backward when comparing them in the same
10643  *  CPU. On the other hand, when comparing clocks in different CPUs, there
10644  *  is no such guarantee -- the clock can go backward. It provides a
10645  *  monotonically *non-decreasing* clock so that it would provide the same
10646  *  clock values in two different scx_bpf_now() calls in the same CPU
10647  *  during the same period of when the rq clock is valid.
10648  */
scx_bpf_now(void)10649 __bpf_kfunc u64 scx_bpf_now(void)
10650 {
10651 	/*
10652 	 * Note that scx_bpf_now() is re-entrant between a process context and
10653 	 * an interrupt context (e.g., timer interrupt). However, we don't need
10654 	 * to consider the race between them because such race is not observable
10655 	 * from a caller.
10656 	 */
10657 	guard(preempt)();
10658 	return __scx_bpf_now(this_rq());
10659 }
10660 
scx_read_events(struct scx_sched * sch,struct scx_event_stats * events)10661 static void scx_read_events(struct scx_sched *sch, struct scx_event_stats *events)
10662 {
10663 	int cpu;
10664 
10665 	/* Aggregate per-CPU event counters into @events. */
10666 	memset(events, 0, sizeof(*events));
10667 	for_each_possible_cpu(cpu) {
10668 		struct scx_event_stats *e_cpu = &per_cpu_ptr(sch->pcpu, cpu)->event_stats;
10669 #define SCX_EVENT(name)	(events->name += READ_ONCE(e_cpu->name))
10670 		SCX_EVENTS_LIST(SCX_EVENT);
10671 #undef SCX_EVENT
10672 	}
10673 }
10674 
10675 /**
10676  * scx_bpf_events - Read the event counters of the calling scheduler
10677  * @events: output buffer from a BPF program
10678  * @events__sz: @events len, must end in '__sz' for the verifier
10679  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10680  *
10681  * Read the event counters of the scheduler associated with the calling program.
10682  * @events is zeroed when no scheduler can be resolved.
10683  */
scx_bpf_events(struct scx_event_stats * events,size_t events__sz,const struct bpf_prog_aux * aux)10684 __bpf_kfunc void scx_bpf_events(struct scx_event_stats *events, size_t events__sz,
10685 				const struct bpf_prog_aux *aux)
10686 {
10687 	struct scx_sched *sch;
10688 	struct scx_event_stats e_sys;
10689 
10690 	rcu_read_lock();
10691 	sch = scx_prog_sched(aux);
10692 	if (sch)
10693 		scx_read_events(sch, &e_sys);
10694 	else
10695 		memset(&e_sys, 0, sizeof(e_sys));
10696 	rcu_read_unlock();
10697 
10698 	/*
10699 	 * We cannot entirely trust a BPF-provided size since a BPF program
10700 	 * might be compiled against a different vmlinux.h, of which
10701 	 * scx_event_stats would be larger (a newer vmlinux.h) or smaller
10702 	 * (an older vmlinux.h). Hence, we use the smaller size to avoid
10703 	 * memory corruption.
10704 	 */
10705 	events__sz = min(events__sz, sizeof(*events));
10706 	memcpy(events, &e_sys, events__sz);
10707 }
10708 
10709 #ifdef CONFIG_CGROUP_SCHED
10710 /**
10711  * scx_bpf_task_cgroup - Return the sched cgroup of a task
10712  * @p: task of interest
10713  * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10714  *
10715  * @p->sched_task_group->css.cgroup represents the cgroup @p is associated with
10716  * from the scheduler's POV. SCX operations should use this function to
10717  * determine @p's current cgroup as, unlike following @p->cgroups,
10718  * @p->sched_task_group is stable for the duration of the SCX op. See
10719  * SCX_CALL_OP_TASK() for details.
10720  */
scx_bpf_task_cgroup(struct task_struct * p,const struct bpf_prog_aux * aux)10721 __bpf_kfunc struct cgroup *scx_bpf_task_cgroup(struct task_struct *p,
10722 					       const struct bpf_prog_aux *aux)
10723 {
10724 	struct task_group *tg = p->sched_task_group;
10725 	struct cgroup *cgrp = &cgrp_dfl_root.cgrp;
10726 	struct scx_sched *sch;
10727 
10728 	guard(rcu)();
10729 
10730 	sch = scx_prog_sched(aux);
10731 	if (unlikely(!sch))
10732 		goto out;
10733 
10734 	if (!scx_kf_arg_task_ok(sch, p))
10735 		goto out;
10736 
10737 	cgrp = tg_cgrp(tg);
10738 
10739 out:
10740 	cgroup_get(cgrp);
10741 	return cgrp;
10742 }
10743 #endif	/* CONFIG_CGROUP_SCHED */
10744 
10745 __bpf_kfunc_end_defs();
10746 
10747 BTF_KFUNCS_START(scx_kfunc_ids_any)
10748 BTF_ID_FLAGS(func, scx_bpf_task_set_slice, KF_IMPLICIT_ARGS | KF_RCU);
10749 BTF_ID_FLAGS(func, scx_bpf_task_set_dsq_vtime, KF_IMPLICIT_ARGS | KF_RCU);
10750 BTF_ID_FLAGS(func, scx_bpf_kick_cpu, KF_IMPLICIT_ARGS)
10751 BTF_ID_FLAGS(func, scx_bpf_kick_cid, KF_IMPLICIT_ARGS)
10752 BTF_ID_FLAGS(func, scx_bpf_dsq_nr_queued, KF_IMPLICIT_ARGS)
10753 BTF_ID_FLAGS(func, scx_bpf_destroy_dsq, KF_IMPLICIT_ARGS)
10754 BTF_ID_FLAGS(func, scx_bpf_dsq_peek, KF_IMPLICIT_ARGS | KF_RCU_PROTECTED | KF_RET_NULL)
10755 BTF_ID_FLAGS(func, scx_bpf_dsq_reenq, KF_IMPLICIT_ARGS)
10756 BTF_ID_FLAGS(func, scx_bpf_reenqueue_local___v2, KF_IMPLICIT_ARGS)
10757 BTF_ID_FLAGS(func, bpf_iter_scx_dsq_new, KF_IMPLICIT_ARGS | KF_ITER_NEW | KF_RCU_PROTECTED)
10758 BTF_ID_FLAGS(func, bpf_iter_scx_dsq_next, KF_ITER_NEXT | KF_RET_NULL)
10759 BTF_ID_FLAGS(func, bpf_iter_scx_dsq_destroy, KF_ITER_DESTROY)
10760 BTF_ID_FLAGS(func, scx_bpf_exit_bstr, KF_IMPLICIT_ARGS)
10761 BTF_ID_FLAGS(func, scx_bpf_error_bstr, KF_IMPLICIT_ARGS)
10762 BTF_ID_FLAGS(func, scx_bpf_dump_bstr, KF_IMPLICIT_ARGS)
10763 BTF_ID_FLAGS(func, scx_bpf_cpuperf_cap, KF_IMPLICIT_ARGS)
10764 BTF_ID_FLAGS(func, scx_bpf_cpuperf_cur, KF_IMPLICIT_ARGS)
10765 BTF_ID_FLAGS(func, scx_bpf_cpuperf_set, KF_IMPLICIT_ARGS)
10766 BTF_ID_FLAGS(func, scx_bpf_cidperf_cap, KF_IMPLICIT_ARGS)
10767 BTF_ID_FLAGS(func, scx_bpf_cidperf_cur, KF_IMPLICIT_ARGS)
10768 BTF_ID_FLAGS(func, scx_bpf_cidperf_set, KF_IMPLICIT_ARGS)
10769 BTF_ID_FLAGS(func, scx_bpf_nr_node_ids)
10770 BTF_ID_FLAGS(func, scx_bpf_nr_cpu_ids)
10771 BTF_ID_FLAGS(func, scx_bpf_nr_cids)
10772 BTF_ID_FLAGS(func, scx_bpf_nr_online_cids)
10773 BTF_ID_FLAGS(func, scx_bpf_online_cmask, KF_IMPLICIT_ARGS | KF_ARENA_RET)
10774 BTF_ID_FLAGS(func, scx_bpf_this_cid)
10775 BTF_ID_FLAGS(func, scx_bpf_get_possible_cpumask, KF_ACQUIRE)
10776 BTF_ID_FLAGS(func, scx_bpf_get_online_cpumask, KF_ACQUIRE)
10777 BTF_ID_FLAGS(func, scx_bpf_put_cpumask, KF_RELEASE)
10778 BTF_ID_FLAGS(func, scx_bpf_task_running, KF_RCU)
10779 BTF_ID_FLAGS(func, scx_bpf_task_cpu, KF_RCU)
10780 BTF_ID_FLAGS(func, scx_bpf_task_cid, KF_RCU)
10781 BTF_ID_FLAGS(func, scx_bpf_locked_rq, KF_IMPLICIT_ARGS | KF_RET_NULL)
10782 BTF_ID_FLAGS(func, scx_bpf_cpu_curr, KF_IMPLICIT_ARGS | KF_RET_NULL | KF_RCU_PROTECTED)
10783 BTF_ID_FLAGS(func, scx_bpf_cid_curr, KF_IMPLICIT_ARGS | KF_RET_NULL | KF_RCU_PROTECTED)
10784 BTF_ID_FLAGS(func, scx_bpf_tid_to_task, KF_RET_NULL | KF_RCU_PROTECTED)
10785 BTF_ID_FLAGS(func, scx_bpf_now)
10786 BTF_ID_FLAGS(func, scx_bpf_events, KF_IMPLICIT_ARGS)
10787 #ifdef CONFIG_CGROUP_SCHED
10788 BTF_ID_FLAGS(func, scx_bpf_task_cgroup, KF_IMPLICIT_ARGS | KF_RCU | KF_ACQUIRE)
10789 #endif
10790 BTF_ID_FLAGS(func, scx_bpf_sub_grant, KF_IMPLICIT_ARGS)
10791 BTF_ID_FLAGS(func, scx_bpf_sub_revoke, KF_IMPLICIT_ARGS)
10792 BTF_ID_FLAGS(func, scx_bpf_sub_caps, KF_IMPLICIT_ARGS)
10793 BTF_ID_FLAGS(func, scx_bpf_sub_kill_bstr, KF_IMPLICIT_ARGS)
10794 BTF_KFUNCS_END(scx_kfunc_ids_any)
10795 
10796 static const struct btf_kfunc_id_set scx_kfunc_set_any = {
10797 	.owner			= THIS_MODULE,
10798 	.set			= &scx_kfunc_ids_any,
10799 	.filter			= scx_kfunc_context_filter,
10800 };
10801 
10802 /*
10803  * cpu-form kfuncs that are forbidden from cid-form schedulers
10804  * (bpf_sched_ext_ops_cid). Programs targeting the cid struct_ops type must
10805  * use the cid-form alternative (cid/cmask kfuncs).
10806  *
10807  * Membership overlaps with scx_kfunc_ids_{any,idle,select_cpu}; the filter
10808  * tests this set independently and rejects matches before the per-op
10809  * allow-list check runs.
10810  *
10811  * pahole/resolve_btfids scans every BTF_ID_FLAGS() at build time and
10812  * intersects flags across duplicate entries, so each entry must carry the
10813  * same flags as the kfunc's primary declaration; otherwise the flags get
10814  * dropped globally.
10815  */
10816 BTF_KFUNCS_START(scx_kfunc_ids_cpu_only)
10817 BTF_ID_FLAGS(func, scx_bpf_kick_cpu, KF_IMPLICIT_ARGS)
10818 BTF_ID_FLAGS(func, scx_bpf_task_cpu, KF_RCU)
10819 BTF_ID_FLAGS(func, scx_bpf_cpu_curr, KF_IMPLICIT_ARGS | KF_RET_NULL | KF_RCU_PROTECTED)
10820 BTF_ID_FLAGS(func, scx_bpf_cpu_node, KF_IMPLICIT_ARGS)
10821 BTF_ID_FLAGS(func, scx_bpf_cpuperf_cap, KF_IMPLICIT_ARGS)
10822 BTF_ID_FLAGS(func, scx_bpf_cpuperf_cur, KF_IMPLICIT_ARGS)
10823 BTF_ID_FLAGS(func, scx_bpf_cpuperf_set, KF_IMPLICIT_ARGS)
10824 BTF_ID_FLAGS(func, scx_bpf_get_possible_cpumask, KF_ACQUIRE)
10825 BTF_ID_FLAGS(func, scx_bpf_get_online_cpumask, KF_ACQUIRE)
10826 BTF_ID_FLAGS(func, scx_bpf_put_cpumask, KF_RELEASE)
10827 BTF_ID_FLAGS(func, scx_bpf_select_cpu_dfl, KF_IMPLICIT_ARGS | KF_RCU)
10828 BTF_ID_FLAGS(func, __scx_bpf_select_cpu_and, KF_IMPLICIT_ARGS | KF_RCU)
10829 BTF_ID_FLAGS(func, scx_bpf_select_cpu_and, KF_RCU)
10830 BTF_ID_FLAGS(func, scx_bpf_get_idle_cpumask, KF_IMPLICIT_ARGS | KF_ACQUIRE)
10831 BTF_ID_FLAGS(func, scx_bpf_get_idle_cpumask_node, KF_IMPLICIT_ARGS | KF_ACQUIRE)
10832 BTF_ID_FLAGS(func, scx_bpf_get_idle_smtmask, KF_IMPLICIT_ARGS | KF_ACQUIRE)
10833 BTF_ID_FLAGS(func, scx_bpf_get_idle_smtmask_node, KF_IMPLICIT_ARGS | KF_ACQUIRE)
10834 BTF_ID_FLAGS(func, scx_bpf_put_idle_cpumask, KF_RELEASE)
10835 BTF_ID_FLAGS(func, scx_bpf_test_and_clear_cpu_idle, KF_IMPLICIT_ARGS)
10836 BTF_ID_FLAGS(func, scx_bpf_pick_idle_cpu, KF_IMPLICIT_ARGS | KF_RCU)
10837 BTF_ID_FLAGS(func, scx_bpf_pick_idle_cpu_node, KF_IMPLICIT_ARGS | KF_RCU)
10838 BTF_ID_FLAGS(func, scx_bpf_pick_any_cpu, KF_IMPLICIT_ARGS | KF_RCU)
10839 BTF_ID_FLAGS(func, scx_bpf_pick_any_cpu_node, KF_IMPLICIT_ARGS | KF_RCU)
10840 BTF_KFUNCS_END(scx_kfunc_ids_cpu_only)
10841 
10842 /*
10843  * Per-op kfunc allow flags. Each bit corresponds to a context-sensitive kfunc
10844  * group; an op may permit zero or more groups, with the union expressed in
10845  * scx_kf_allow_flags[]. The verifier-time filter (scx_kfunc_context_filter())
10846  * consults this table to decide whether a context-sensitive kfunc is callable
10847  * from a given SCX op.
10848  */
10849 enum scx_kf_allow_flags {
10850 	SCX_KF_ALLOW_UNLOCKED		= 1 << 0,
10851 	SCX_KF_ALLOW_INIT_CIDS		= 1 << 1,
10852 	SCX_KF_ALLOW_CPU_RELEASE	= 1 << 2,
10853 	SCX_KF_ALLOW_DISPATCH		= 1 << 3,
10854 	SCX_KF_ALLOW_ENQUEUE		= 1 << 4,
10855 	SCX_KF_ALLOW_SELECT_CPU		= 1 << 5,
10856 };
10857 
10858 /*
10859  * Map each SCX op to the union of kfunc groups it permits, indexed by
10860  * SCX_OP_IDX(op). Ops not listed only permit kfuncs that are not
10861  * context-sensitive.
10862  */
10863 static const u32 scx_kf_allow_flags[] = {
10864 	[SCX_OP_IDX(select_cpu)]	= SCX_KF_ALLOW_SELECT_CPU | SCX_KF_ALLOW_ENQUEUE,
10865 	[SCX_OP_IDX(enqueue)]		= SCX_KF_ALLOW_SELECT_CPU | SCX_KF_ALLOW_ENQUEUE,
10866 	[SCX_OP_IDX(dispatch)]		= SCX_KF_ALLOW_ENQUEUE | SCX_KF_ALLOW_DISPATCH,
10867 	[SCX_OP_IDX(cpu_release)]	= SCX_KF_ALLOW_CPU_RELEASE,
10868 	[SCX_OP_IDX(init_task)]		= SCX_KF_ALLOW_UNLOCKED,
10869 	[SCX_OP_IDX(dump)]		= SCX_KF_ALLOW_UNLOCKED,
10870 #ifdef CONFIG_EXT_GROUP_SCHED
10871 	[SCX_OP_IDX(cgroup_init)]	= SCX_KF_ALLOW_UNLOCKED,
10872 	[SCX_OP_IDX(cgroup_exit)]	= SCX_KF_ALLOW_UNLOCKED,
10873 	[SCX_OP_IDX(cgroup_prep_move)]	= SCX_KF_ALLOW_UNLOCKED,
10874 	[SCX_OP_IDX(cgroup_cancel_move)] = SCX_KF_ALLOW_UNLOCKED,
10875 	[SCX_OP_IDX(cgroup_set_weight)]	= SCX_KF_ALLOW_UNLOCKED,
10876 	[SCX_OP_IDX(cgroup_set_bandwidth)] = SCX_KF_ALLOW_UNLOCKED,
10877 	[SCX_OP_IDX(cgroup_set_idle)]	= SCX_KF_ALLOW_UNLOCKED,
10878 #endif	/* CONFIG_EXT_GROUP_SCHED */
10879 	[SCX_OP_IDX(sub_attach)]	= SCX_KF_ALLOW_UNLOCKED,
10880 	[SCX_OP_IDX(sub_detach)]	= SCX_KF_ALLOW_UNLOCKED,
10881 	[SCX_OP_IDX(sub_ecaps_updated)]	= SCX_KF_ALLOW_ENQUEUE | SCX_KF_ALLOW_DISPATCH,
10882 	[SCX_OP_IDX(cpu_online)]	= SCX_KF_ALLOW_UNLOCKED,
10883 	[SCX_OP_IDX(cpu_offline)]	= SCX_KF_ALLOW_UNLOCKED,
10884 	[SCX_OP_IDX(init_cids)]		= SCX_KF_ALLOW_UNLOCKED | SCX_KF_ALLOW_INIT_CIDS,
10885 	[SCX_OP_IDX(init)]		= SCX_KF_ALLOW_UNLOCKED,
10886 	[SCX_OP_IDX(exit)]		= SCX_KF_ALLOW_UNLOCKED,
10887 };
10888 
10889 /*
10890  * Verifier-time filter for SCX kfuncs. Registered via the .filter field on
10891  * each per-group btf_kfunc_id_set. The BPF core invokes this for every kfunc
10892  * call in the registered hook (BPF_PROG_TYPE_STRUCT_OPS or
10893  * BPF_PROG_TYPE_SYSCALL), regardless of which set originally introduced the
10894  * kfunc - so the filter must short-circuit on kfuncs it doesn't govern by
10895  * falling through to "allow" when none of the SCX sets contain the kfunc.
10896  */
scx_kfunc_context_filter(const struct bpf_prog * prog,u32 kfunc_id)10897 int scx_kfunc_context_filter(const struct bpf_prog *prog, u32 kfunc_id)
10898 {
10899 	bool in_unlocked = btf_id_set8_contains(&scx_kfunc_ids_unlocked, kfunc_id);
10900 	bool in_init_cids = btf_id_set8_contains(&scx_kfunc_ids_init_cids, kfunc_id);
10901 	bool in_select_cpu = btf_id_set8_contains(&scx_kfunc_ids_select_cpu, kfunc_id);
10902 	bool in_enqueue = btf_id_set8_contains(&scx_kfunc_ids_enqueue_dispatch, kfunc_id);
10903 	bool in_dispatch = btf_id_set8_contains(&scx_kfunc_ids_dispatch, kfunc_id);
10904 	bool in_cpu_release = btf_id_set8_contains(&scx_kfunc_ids_cpu_release, kfunc_id);
10905 	bool in_idle = btf_id_set8_contains(&scx_kfunc_ids_idle, kfunc_id);
10906 	bool in_any = btf_id_set8_contains(&scx_kfunc_ids_any, kfunc_id);
10907 	bool in_cpu_only = btf_id_set8_contains(&scx_kfunc_ids_cpu_only, kfunc_id);
10908 	bool in_cid = btf_id_set8_contains(&scx_kfunc_ids_cid, kfunc_id);
10909 	u32 moff, flags;
10910 
10911 	/* Not an SCX kfunc - allow. */
10912 	if (!(in_unlocked || in_init_cids || in_select_cpu || in_enqueue || in_dispatch ||
10913 	      in_cpu_release || in_idle || in_any || in_cid))
10914 		return 0;
10915 
10916 	/* SYSCALL progs (e.g. BPF test_run()) may call unlocked and select_cpu kfuncs. */
10917 	if (prog->type == BPF_PROG_TYPE_SYSCALL)
10918 		return (in_unlocked || in_select_cpu || in_idle || in_any || in_cid) ? 0 : -EACCES;
10919 
10920 	if (prog->type != BPF_PROG_TYPE_STRUCT_OPS)
10921 		return (in_any || in_idle || in_cid) ? 0 : -EACCES;
10922 
10923 	/*
10924 	 * add_subprog_and_kfunc() collects all kfunc calls, including dead code
10925 	 * guarded by bpf_ksym_exists(), before check_attach_btf_id() sets
10926 	 * prog->aux->st_ops. Allow all kfuncs when st_ops is not yet set;
10927 	 * do_check_main() re-runs the filter with st_ops set and enforces the
10928 	 * actual restrictions.
10929 	 */
10930 	if (!prog->aux->st_ops)
10931 		return 0;
10932 
10933 	/*
10934 	 * Non-SCX struct_ops: SCX kfuncs are not permitted.
10935 	 *
10936 	 * Both bpf_sched_ext_ops (cpu-form) and bpf_sched_ext_ops_cid
10937 	 * (cid-form) are valid SCX struct_ops. Member offsets match between
10938 	 * the two (verified by BUILD_BUG_ON in scx_init()), so the shared
10939 	 * scx_kf_allow_flags[] table indexed by SCX_MOFF_IDX(moff) applies to
10940 	 * both.
10941 	 */
10942 	if (prog->aux->st_ops != &bpf_sched_ext_ops &&
10943 	    prog->aux->st_ops != &bpf_sched_ext_ops_cid)
10944 		return -EACCES;
10945 
10946 	/*
10947 	 * cid-form schedulers must use cid/cmask kfuncs. cid and cpu are both
10948 	 * small s32s and trivially confused, so cpu-only kfuncs are rejected at
10949 	 * load time. The reverse (cpu-form calling cid-form kfuncs) is
10950 	 * intentionally permissive to ease gradual cpumask -> cid migration.
10951 	 */
10952 	if (prog->aux->st_ops == &bpf_sched_ext_ops_cid && in_cpu_only)
10953 		return -EACCES;
10954 
10955 	/* SCX struct_ops: check the per-op allow list. */
10956 	if (in_any || in_idle || in_cid)
10957 		return 0;
10958 
10959 	moff = prog->aux->attach_st_ops_member_off;
10960 	flags = scx_kf_allow_flags[SCX_MOFF_IDX(moff)];
10961 
10962 	if ((flags & SCX_KF_ALLOW_UNLOCKED) && in_unlocked)
10963 		return 0;
10964 	if ((flags & SCX_KF_ALLOW_INIT_CIDS) && in_init_cids)
10965 		return 0;
10966 	if ((flags & SCX_KF_ALLOW_CPU_RELEASE) && in_cpu_release)
10967 		return 0;
10968 	if ((flags & SCX_KF_ALLOW_DISPATCH) && in_dispatch)
10969 		return 0;
10970 	if ((flags & SCX_KF_ALLOW_ENQUEUE) && in_enqueue)
10971 		return 0;
10972 	if ((flags & SCX_KF_ALLOW_SELECT_CPU) && in_select_cpu)
10973 		return 0;
10974 
10975 	return -EACCES;
10976 }
10977 
scx_init(void)10978 static int __init scx_init(void)
10979 {
10980 	int ret;
10981 
10982 	/*
10983 	 * sched_ext_ops_cid mirrors sched_ext_ops up to and including @priv.
10984 	 * Both bpf_scx_init_member() and bpf_scx_check_member() use offsets
10985 	 * from struct sched_ext_ops; sched_ext_ops_cid relies on those offsets
10986 	 * matching for the shared fields. Catch any drift at boot.
10987 	 */
10988 #define CID_OFFSET_MATCH(cpu_field, cid_field)					\
10989 	BUILD_BUG_ON(offsetof(struct sched_ext_ops, cpu_field) !=		\
10990 		     offsetof(struct sched_ext_ops_cid, cid_field))
10991 	/* data fields used by bpf_scx_init_member() */
10992 	CID_OFFSET_MATCH(dispatch_max_batch, dispatch_max_batch);
10993 	CID_OFFSET_MATCH(flags, flags);
10994 	CID_OFFSET_MATCH(name, name);
10995 	CID_OFFSET_MATCH(timeout_ms, timeout_ms);
10996 	CID_OFFSET_MATCH(exit_dump_len, exit_dump_len);
10997 	CID_OFFSET_MATCH(hotplug_seq, hotplug_seq);
10998 	CID_OFFSET_MATCH(cid_shard_size, cid_shard_size);
10999 	CID_OFFSET_MATCH(rescue_bandwidth_ppt, rescue_bandwidth_ppt);
11000 	CID_OFFSET_MATCH(rescue_quantum_us, rescue_quantum_us);
11001 	CID_OFFSET_MATCH(sub_cgroup_id, sub_cgroup_id);
11002 	/* shared callbacks: the union view requires byte-for-byte offset match */
11003 	CID_OFFSET_MATCH(enqueue, enqueue);
11004 	CID_OFFSET_MATCH(dequeue, dequeue);
11005 	CID_OFFSET_MATCH(dispatch, dispatch);
11006 	CID_OFFSET_MATCH(tick, tick);
11007 	CID_OFFSET_MATCH(runnable, runnable);
11008 	CID_OFFSET_MATCH(running, running);
11009 	CID_OFFSET_MATCH(stopping, stopping);
11010 	CID_OFFSET_MATCH(quiescent, quiescent);
11011 	CID_OFFSET_MATCH(yield, yield);
11012 	CID_OFFSET_MATCH(core_sched_before, core_sched_before);
11013 	CID_OFFSET_MATCH(set_weight, set_weight);
11014 	CID_OFFSET_MATCH(update_idle, update_idle);
11015 	CID_OFFSET_MATCH(init_task, init_task);
11016 	CID_OFFSET_MATCH(exit_task, exit_task);
11017 	CID_OFFSET_MATCH(enable, enable);
11018 	CID_OFFSET_MATCH(disable, disable);
11019 	CID_OFFSET_MATCH(dump, dump);
11020 	CID_OFFSET_MATCH(dump_task, dump_task);
11021 	CID_OFFSET_MATCH(sub_attach, sub_attach);
11022 	CID_OFFSET_MATCH(sub_detach, sub_detach);
11023 	CID_OFFSET_MATCH(sub_caps_updated, sub_caps_updated);
11024 	CID_OFFSET_MATCH(sub_ecaps_updated, sub_ecaps_updated);
11025 	CID_OFFSET_MATCH(init_cids, init_cids);
11026 	CID_OFFSET_MATCH(init, init);
11027 	CID_OFFSET_MATCH(exit, exit);
11028 	/* renamed callbacks must occupy the same slot as their cpu-form sibling */
11029 	CID_OFFSET_MATCH(select_cpu, select_cid);
11030 	CID_OFFSET_MATCH(set_cpumask, set_cmask);
11031 	CID_OFFSET_MATCH(cpu_online, cid_online);
11032 	CID_OFFSET_MATCH(cpu_offline, cid_offline);
11033 	CID_OFFSET_MATCH(dump_cpu, dump_cid);
11034 #ifdef CONFIG_EXT_GROUP_SCHED
11035 	CID_OFFSET_MATCH(cgroup_init, cpuctl_init);
11036 	CID_OFFSET_MATCH(cgroup_exit, cpuctl_exit);
11037 	CID_OFFSET_MATCH(cgroup_prep_move, cpuctl_prep_move);
11038 	CID_OFFSET_MATCH(cgroup_move, cpuctl_move);
11039 	CID_OFFSET_MATCH(cgroup_cancel_move, cpuctl_cancel_move);
11040 	CID_OFFSET_MATCH(cgroup_set_weight, cpuctl_set_weight);
11041 	CID_OFFSET_MATCH(cgroup_set_bandwidth, cpuctl_set_bandwidth);
11042 	CID_OFFSET_MATCH(cgroup_set_idle, cpuctl_set_idle);
11043 #endif
11044 	/* @priv tail must align since both share the same data block */
11045 	CID_OFFSET_MATCH(priv, priv);
11046 	/*
11047 	 * cid-form must end exactly at @priv - scx_validate_ops() skips
11048 	 * cpu_acquire/cpu_release for cid-form because reading those fields
11049 	 * past the BPF allocation would be UB.
11050 	 */
11051 	BUILD_BUG_ON(offsetof(struct sched_ext_ops_cid, __end) !=
11052 		     offsetofend(struct sched_ext_ops, priv));
11053 #undef CID_OFFSET_MATCH
11054 
11055 	/*
11056 	 * kfunc registration can't be done from init_sched_ext_class() as
11057 	 * register_btf_kfunc_id_set() needs most of the system to be up.
11058 	 *
11059 	 * Some kfuncs are context-sensitive and can only be called from
11060 	 * specific SCX ops. They are grouped into per-context BTF sets, each
11061 	 * registered with scx_kfunc_context_filter as its .filter callback. The
11062 	 * BPF core dedups identical filter pointers per hook
11063 	 * (btf_populate_kfunc_set()), so the filter is invoked exactly once per
11064 	 * kfunc lookup; it consults scx_kf_allow_flags[] to enforce per-op
11065 	 * restrictions at verify time.
11066 	 */
11067 	if ((ret = register_btf_kfunc_id_set(BPF_PROG_TYPE_STRUCT_OPS,
11068 					     &scx_kfunc_set_enqueue_dispatch)) ||
11069 	    (ret = register_btf_kfunc_id_set(BPF_PROG_TYPE_STRUCT_OPS,
11070 					     &scx_kfunc_set_dispatch)) ||
11071 	    (ret = register_btf_kfunc_id_set(BPF_PROG_TYPE_STRUCT_OPS,
11072 					     &scx_kfunc_set_cpu_release)) ||
11073 	    (ret = register_btf_kfunc_id_set(BPF_PROG_TYPE_STRUCT_OPS,
11074 					     &scx_kfunc_set_unlocked)) ||
11075 	    (ret = register_btf_kfunc_id_set(BPF_PROG_TYPE_SYSCALL,
11076 					     &scx_kfunc_set_unlocked)) ||
11077 	    (ret = register_btf_kfunc_id_set(BPF_PROG_TYPE_STRUCT_OPS,
11078 					     &scx_kfunc_set_any)) ||
11079 	    (ret = register_btf_kfunc_id_set(BPF_PROG_TYPE_TRACING,
11080 					     &scx_kfunc_set_any)) ||
11081 	    (ret = register_btf_kfunc_id_set(BPF_PROG_TYPE_SYSCALL,
11082 					     &scx_kfunc_set_any))) {
11083 		pr_err("sched_ext: Failed to register kfunc sets (%d)\n", ret);
11084 		return ret;
11085 	}
11086 
11087 	ret = scx_idle_init();
11088 	if (ret) {
11089 		pr_err("sched_ext: Failed to initialize idle tracking (%d)\n", ret);
11090 		return ret;
11091 	}
11092 
11093 	ret = scx_cid_kfunc_init();
11094 	if (ret) {
11095 		pr_err("sched_ext: Failed to register cid kfuncs (%d)\n", ret);
11096 		return ret;
11097 	}
11098 
11099 	ret = register_bpf_struct_ops(&bpf_sched_ext_ops, sched_ext_ops);
11100 	if (ret) {
11101 		pr_err("sched_ext: Failed to register struct_ops (%d)\n", ret);
11102 		return ret;
11103 	}
11104 
11105 	ret = register_bpf_struct_ops(&bpf_sched_ext_ops_cid, sched_ext_ops_cid);
11106 	if (ret) {
11107 		pr_err("sched_ext: Failed to register cid struct_ops (%d)\n", ret);
11108 		return ret;
11109 	}
11110 
11111 	ret = register_pm_notifier(&scx_pm_notifier);
11112 	if (ret) {
11113 		pr_err("sched_ext: Failed to register PM notifier (%d)\n", ret);
11114 		return ret;
11115 	}
11116 
11117 	scx_kset = kset_create_and_add("sched_ext", &scx_uevent_ops, kernel_kobj);
11118 	if (!scx_kset) {
11119 		pr_err("sched_ext: Failed to create /sys/kernel/sched_ext\n");
11120 		return -ENOMEM;
11121 	}
11122 
11123 	ret = sysfs_create_group(&scx_kset->kobj, &scx_global_attr_group);
11124 	if (ret < 0) {
11125 		pr_err("sched_ext: Failed to add global attributes\n");
11126 		return ret;
11127 	}
11128 
11129 	return 0;
11130 }
11131 __initcall(scx_init);
11132 
11133 /*
11134  * Compatibility markers for userspace. Existence of a marker function
11135  * represents that the kernel supports that sched-ext feature.
11136  */
11137 
11138 /*
11139  * scx_compat_marker_cgroup_set_bandwidth_may_sleep: advertises that
11140  * ops.cgroup_set_bandwidth() may be implemented as a sleepable callback.
11141  */
11142 #ifdef CONFIG_EXT_GROUP_SCHED
11143 DEFINE_SCX_COMPAT_MARKER(cgroup_set_bandwidth_may_sleep);
11144 #endif	/* CONFIG_EXT_GROUP_SCHED */
11145