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 *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 ((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 (sch->ops.cpu_acquire)
2940 SCX_CALL_OP(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(sch, 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(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
2976 * %SCX_OPS_ENQ_LAST is in effect.
2977 */
2978 if ((prev->scx.flags & SCX_TASK_QUEUED) &&
2979 (!(sch->ops.flags & SCX_OPS_ENQ_LAST) || scx_bypassing(sch, cpu)) &&
2980 scx_task_can_stay_on_cpu(rq, prev)) {
2981 __scx_add_event(sch, SCX_EV_DISPATCH_KEEP_LAST, 1);
2982 verdict = SCX_DSP_PREV;
2983 goto has_tasks;
2984 }
2985 rq->scx.flags &= ~SCX_RQ_IN_DISPATCH;
2986 return SCX_DSP_NONE;
2987
2988 has_tasks:
2989 /*
2990 * @rq may have extra IMMED tasks without reenq scheduled:
2991 *
2992 * - rq_is_open() can't reliably tell when and how slice is going to be
2993 * modified for $curr and allows IMMED tasks to be queued while
2994 * dispatch is in progress.
2995 *
2996 * - A non-IMMED HEAD task can get queued in front of an IMMED task
2997 * between the IMMED queueing and the subsequent scheduling event.
2998 */
2999 if (unlikely(rq->scx.local_dsq.nr > 1 && rq->scx.nr_immed))
3000 scx_schedule_reenq_local(rq, 0);
3001
3002 rq->scx.flags &= ~SCX_RQ_IN_DISPATCH;
3003 return verdict;
3004 }
3005
set_next_task_scx(struct rq * rq,struct task_struct * p,bool first)3006 static void set_next_task_scx(struct rq *rq, struct task_struct *p, bool first)
3007 {
3008 struct scx_sched *sch = scx_task_sched(p);
3009
3010 if (p->scx.flags & SCX_TASK_QUEUED) {
3011 /*
3012 * Core-sched might decide to execute @p before it is
3013 * dispatched. Call ops_dequeue() to notify the BPF scheduler.
3014 */
3015 ops_dequeue(rq, p, SCX_DEQ_CORE_SCHED_EXEC);
3016 scx_dispatch_dequeue(rq, p);
3017 }
3018
3019 p->se.exec_start = rq_clock_task(rq);
3020
3021 /* see dequeue_task_scx() on why we skip when !QUEUED */
3022 if (SCX_HAS_OP(sch, running) && (p->scx.flags & SCX_TASK_QUEUED))
3023 SCX_CALL_OP_TASK(sch, running, rq, p);
3024
3025 clr_task_runnable(p, true);
3026
3027 /* apply any pending out-of-band slice request before the tick decision */
3028 apply_task_slice_oob(rq, p);
3029
3030 /*
3031 * @p is getting newly scheduled or got kicked after someone updated its
3032 * slice. Update SCX_RQ_CAN_STOP_TICK to reflect whether the tick can be
3033 * stopped. See scx_can_stop_tick().
3034 *
3035 * Moreover, refresh the load_avgs just when transitioning in and out of
3036 * nohz. In the future, we might want to add a mechanism to update
3037 * load_avgs periodically on tick-stopped CPUs.
3038 */
3039 if (p->scx.slice == SCX_SLICE_INF) {
3040 if (!(rq->scx.flags & SCX_RQ_CAN_STOP_TICK)) {
3041 /*
3042 * Bypass mode always assigns finite slices, so @p
3043 * can't have an infinite slice while bypassing.
3044 * Therefore, sched_update_tick_dependency() can safely
3045 * evaluate the outgoing task.
3046 */
3047 rq->scx.flags |= SCX_RQ_CAN_STOP_TICK;
3048 sched_update_tick_dependency(rq);
3049
3050 update_other_load_avgs(rq);
3051 }
3052 } else {
3053 if (rq->scx.flags & SCX_RQ_CAN_STOP_TICK) {
3054 rq->scx.flags &= ~SCX_RQ_CAN_STOP_TICK;
3055 update_other_load_avgs(rq);
3056 }
3057
3058 /*
3059 * @rq still references the outgoing scheduling context. A finite
3060 * slice is sufficient by itself to require the tick.
3061 */
3062 if (tick_nohz_full_cpu(cpu_of(rq)))
3063 tick_nohz_dep_set_cpu(cpu_of(rq), TICK_DEP_BIT_SCHED);
3064 }
3065 }
3066
3067 static enum scx_cpu_preempt_reason
preempt_reason_from_class(const struct sched_class * class)3068 preempt_reason_from_class(const struct sched_class *class)
3069 {
3070 if (class == &stop_sched_class)
3071 return SCX_CPU_PREEMPT_STOP;
3072 if (class == &dl_sched_class)
3073 return SCX_CPU_PREEMPT_DL;
3074 if (class == &rt_sched_class)
3075 return SCX_CPU_PREEMPT_RT;
3076 return SCX_CPU_PREEMPT_UNKNOWN;
3077 }
3078
switch_class(struct rq * rq,struct task_struct * next)3079 static void switch_class(struct rq *rq, struct task_struct *next)
3080 {
3081 struct scx_sched *sch = scx_root_protected_live();
3082 const struct sched_class *next_class = next->sched_class;
3083
3084 if (!(sch->ops.flags & SCX_OPS_HAS_CPU_PREEMPT))
3085 return;
3086
3087 /*
3088 * The callback is conceptually meant to convey that the CPU is no
3089 * longer under the control of SCX. Therefore, don't invoke the callback
3090 * if the next class is below SCX (in which case the BPF scheduler has
3091 * actively decided not to schedule any tasks on the CPU).
3092 */
3093 if (sched_class_above(&ext_sched_class, next_class))
3094 return;
3095
3096 /*
3097 * At this point we know that SCX was preempted by a higher priority
3098 * sched_class, so invoke the ->cpu_release() callback if we have not
3099 * done so already. We only send the callback once between SCX being
3100 * preempted, and it regaining control of the CPU.
3101 *
3102 * ->cpu_release() complements ->cpu_acquire(), which is emitted the
3103 * next time that dispatch_one() is invoked.
3104 */
3105 if (!rq->scx.cpu_released) {
3106 if (sch->ops.cpu_release) {
3107 struct scx_cpu_release_args args = {
3108 .reason = preempt_reason_from_class(next_class),
3109 .task = next,
3110 };
3111
3112 SCX_CALL_OP(sch, cpu_release, rq, cpu_of(rq), &args);
3113 }
3114 rq->scx.cpu_released = true;
3115 }
3116 }
3117
put_prev_task_scx(struct rq * rq,struct task_struct * p,struct task_struct * next)3118 static void put_prev_task_scx(struct rq *rq, struct task_struct *p,
3119 struct task_struct *next)
3120 {
3121 struct scx_sched *sch = scx_task_sched(p);
3122 bool rescue_keep = false;
3123
3124 /* see kick_sync_wait_bal_cb() */
3125 smp_store_release(&rq->scx.kick_sync, rq->scx.kick_sync + 1);
3126
3127 update_curr_scx(rq);
3128
3129 /*
3130 * If the slice is consumed, protection ends with it. A rescuee
3131 * preempted beforehand keeps going, see scx_rescue_keep().
3132 */
3133 if (!p->scx.slice) {
3134 if (unlikely(p == scx_rescuee(rq)))
3135 rescue_keep = scx_rescue_keep(rq, p);
3136 if (!rescue_keep)
3137 scx_task_slice_ended(rq, p);
3138 }
3139
3140 /* see dequeue_task_scx() on why we skip when !QUEUED */
3141 if (SCX_HAS_OP(sch, stopping) && (p->scx.flags & SCX_TASK_QUEUED))
3142 SCX_CALL_OP_TASK(sch, stopping, rq, p, true);
3143
3144 if (p->scx.flags & SCX_TASK_QUEUED) {
3145 set_task_runnable(rq, p);
3146
3147 /*
3148 * If @p has slice left and is being put, @p is getting
3149 * preempted by a higher priority scheduler class or core-sched
3150 * forcing a different task. Leave it at the head of the local
3151 * DSQ unless it was an IMMED task. IMMED tasks should not
3152 * linger on a busy CPU, reenqueue them to the BPF scheduler.
3153 *
3154 * An open rescue must keep @p on the local DSQ even if the
3155 * scheduler zeroed the slice in ops.stopping() above.
3156 */
3157 if ((p->scx.slice || unlikely(p == scx_rescuee(rq))) &&
3158 !scx_bypassing(sch, cpu_of(rq))) {
3159 if (p->scx.flags & SCX_TASK_IMMED) {
3160 p->scx.flags |= SCX_TASK_REENQ_PREEMPTED;
3161 scx_do_enqueue_task(rq, p, SCX_ENQ_REENQ, -1);
3162 p->scx.flags &= ~SCX_TASK_REENQ_REASON_MASK;
3163 } else {
3164 u64 enq_flags = 0;
3165
3166 /*
3167 * Keep a preempted rescue going. If preempted
3168 * by another SCX task, append to the local DSQ,
3169 * see scx_rescue_keep().
3170 */
3171 if (unlikely(p == scx_rescuee(rq))) {
3172 enq_flags |= SCX_ENQ_IGNORE_CAPS;
3173 if (!rescue_keep)
3174 enq_flags |= SCX_ENQ_HEAD;
3175 } else {
3176 enq_flags |= SCX_ENQ_HEAD;
3177 }
3178
3179 scx_dispatch_enqueue(sch, rq, &rq->scx.local_dsq, p, 0, 0,
3180 enq_flags);
3181 }
3182 goto switch_class;
3183 }
3184
3185 /*
3186 * If @p is runnable but we're about to enter a lower
3187 * sched_class, %SCX_OPS_ENQ_LAST must be set. Tell
3188 * ops.enqueue() that @p is the only one available for this cpu,
3189 * which should trigger an explicit follow-up scheduling event.
3190 * This doesn't apply if the baseline access on the CPU is lost.
3191 *
3192 * Under core scheduling, a pick dispatches only when nothing is
3193 * locally runnable and can legitimately go idle with @p still
3194 * runnable (see do_pick_task_scx()).
3195 */
3196 if (next && sched_class_above(&ext_sched_class, next->sched_class) &&
3197 scx_task_can_stay_on_cpu(rq, p)) {
3198 WARN_ON_ONCE(!sched_core_enabled(rq) &&
3199 !(sch->ops.flags & SCX_OPS_ENQ_LAST));
3200 scx_do_enqueue_task(rq, p, SCX_ENQ_LAST, -1);
3201 } else {
3202 scx_do_enqueue_task(rq, p, 0, -1);
3203 }
3204 }
3205
3206 switch_class:
3207 if (next && next->sched_class != &ext_sched_class)
3208 switch_class(rq, next);
3209 }
3210
kick_sync_wait_bal_cb(struct rq * rq)3211 static void kick_sync_wait_bal_cb(struct rq *rq)
3212 {
3213 struct scx_kick_syncs __rcu *ks;
3214 unsigned long *ksyncs;
3215 bool waited;
3216 s32 cpu;
3217
3218 /*
3219 * This callback is queued and normally flushed within @rq's own
3220 * scheduling pass. However, dispatch can drop the rq lock while it sits
3221 * queued, and lock takers in that window (the sched class change paths,
3222 * the scx task iterator) flush pending balance callbacks on release,
3223 * running this one on a foreign CPU whose snapshots are unrelated. The
3224 * kicked CPUs are already on their way to advance the kick_syncs being
3225 * waited on. Don't get in the way.
3226 */
3227 if (unlikely(cpu_of(rq) != smp_processor_id()))
3228 return;
3229
3230 ks = __this_cpu_read(scx_kick_syncs);
3231 ksyncs = rcu_dereference_sched(ks)->syncs;
3232
3233 /*
3234 * Drop rq lock and enable IRQs while waiting. IRQs must be enabled
3235 * — a target CPU may be waiting for us to process an IPI (e.g. TLB
3236 * flush) while we wait for its kick_sync to advance.
3237 *
3238 * Also, keep advancing our own kick_sync so that new kick_sync waits
3239 * targeting us, which can start after we drop the lock, cannot form
3240 * cyclic dependencies.
3241 */
3242 retry:
3243 waited = false;
3244 for_each_cpu(cpu, rq->scx.cpus_to_sync) {
3245 /*
3246 * smp_load_acquire() pairs with smp_store_release() on
3247 * kick_sync updates on the target CPUs.
3248 */
3249 if (cpu == cpu_of(rq) ||
3250 smp_load_acquire(&cpu_rq(cpu)->scx.kick_sync) != ksyncs[cpu]) {
3251 cpumask_clear_cpu(cpu, rq->scx.cpus_to_sync);
3252 continue;
3253 }
3254
3255 scx_rq_lock_drop(rq);
3256 raw_spin_rq_unlock_irq(rq);
3257 while (READ_ONCE(cpu_rq(cpu)->scx.kick_sync) == ksyncs[cpu]) {
3258 smp_store_release(&rq->scx.kick_sync, rq->scx.kick_sync + 1);
3259 cpu_relax();
3260 }
3261 raw_spin_rq_lock_irq(rq);
3262 waited = true;
3263 }
3264
3265 if (waited)
3266 goto retry;
3267 }
3268
first_local_task(struct rq * rq)3269 static struct task_struct *first_local_task(struct rq *rq)
3270 {
3271 return list_first_entry_or_null(&rq->scx.local_dsq.list,
3272 struct task_struct, scx.dsq_list.node);
3273 }
3274
3275 /*
3276 * Run dispatch and queue the follow-up work for a pick.
3277 */
dispatch_pick(struct rq * rq,struct rq_flags * rf,struct task_struct * prev)3278 static enum scx_dsp_verdict dispatch_pick(struct rq *rq, struct rq_flags *rf,
3279 struct task_struct *prev)
3280 {
3281 enum scx_dsp_verdict verdict;
3282
3283 rq_unpin_lock(rq, rf);
3284 verdict = dispatch_one(rq, prev);
3285 rq_repin_lock(rq, rf);
3286 maybe_queue_balance_callback(rq);
3287
3288 /*
3289 * Defer to a balance callback which can drop rq lock and enable IRQs.
3290 * Waiting directly in the pick path would deadlock against CPUs sending
3291 * us IPIs (e.g. TLB flushes) while we wait for them.
3292 */
3293 if (unlikely(rq->scx.kick_sync_pending)) {
3294 rq->scx.kick_sync_pending = false;
3295 queue_balance_callback(rq, &rq->scx.kick_sync_bal_cb,
3296 kick_sync_wait_bal_cb);
3297 }
3298
3299 return verdict;
3300 }
3301
3302 #ifdef CONFIG_SCHED_CORE
3303 /*
3304 * Dispatch for a pick when core scheduling is enabled. The selection picks for
3305 * all SMT siblings and the rq_i->core_pick state it builds must stay atomic
3306 * throughout. If the dispatch released the rq lock, anything can have happened
3307 * in between - return %SCX_DSP_RETRY to restart the selection against current
3308 * state.
3309 */
dispatch_core_pick(struct rq * rq,struct rq_flags * rf,struct task_struct * prev)3310 static enum scx_dsp_verdict dispatch_core_pick(struct rq *rq, struct rq_flags *rf,
3311 struct task_struct *prev)
3312 {
3313 enum scx_dsp_verdict verdict;
3314 u32 seq = rq->scx.lock_drop_seq;
3315
3316 /* another dispatch is in flight on @rq, let that handle it */
3317 if (rq->scx.flags & SCX_RQ_IN_DISPATCH)
3318 return SCX_DSP_NONE;
3319
3320 rq_unpin_lock(rq, rf);
3321
3322 verdict = dispatch_one(rq, prev);
3323
3324 if (cpu_of(rq) == smp_processor_id()) {
3325 maybe_queue_balance_callback(rq);
3326
3327 /* see dispatch_pick() */
3328 if (unlikely(rq->scx.kick_sync_pending)) {
3329 rq->scx.kick_sync_pending = false;
3330 queue_balance_callback(rq, &rq->scx.kick_sync_bal_cb,
3331 kick_sync_wait_bal_cb);
3332 }
3333 } else if (unlikely(rq->scx.flags & SCX_RQ_BAL_CB_PENDING)) {
3334 /*
3335 * Balance callbacks must run in the context that queued them,
3336 * so they can't be queued on another CPU's rq. Run the deferred
3337 * work directly instead.
3338 */
3339 rq->scx.flags &= ~SCX_RQ_BAL_CB_PENDING;
3340 run_deferred(rq);
3341 }
3342
3343 rq_repin_lock(rq, rf);
3344
3345 /* if dispatch_one() released the rq lock, restart the selection */
3346 if (rq->scx.lock_drop_seq != seq)
3347 return SCX_DSP_RETRY;
3348
3349 return verdict;
3350 }
3351 #else /* CONFIG_SCHED_CORE */
dispatch_core_pick(struct rq * rq,struct rq_flags * rf,struct task_struct * prev)3352 static enum scx_dsp_verdict dispatch_core_pick(struct rq *rq, struct rq_flags *rf,
3353 struct task_struct *prev)
3354 {
3355 return SCX_DSP_NONE;
3356 }
3357 #endif /* CONFIG_SCHED_CORE */
3358
3359 static struct task_struct *
do_pick_task_scx(struct rq * rq,struct rq_flags * rf,bool force_scx)3360 do_pick_task_scx(struct rq *rq, struct rq_flags *rf, bool force_scx)
3361 {
3362 struct task_struct *prev = rq->curr;
3363 enum scx_dsp_verdict verdict;
3364 struct task_struct *p;
3365
3366 /* see kick_sync_wait_bal_cb() */
3367 smp_store_release(&rq->scx.kick_sync, rq->scx.kick_sync + 1);
3368
3369 rq_modified_begin(rq, &ext_sched_class);
3370
3371 if (sched_core_enabled(rq))
3372 verdict = dispatch_core_pick(rq, rf, prev);
3373 else
3374 verdict = dispatch_pick(rq, rf, prev);
3375
3376 if (verdict == SCX_DSP_RETRY)
3377 return RETRY_TASK;
3378
3379 /*
3380 * If any higher-priority sched class enqueued a runnable task on this
3381 * rq during dispatch_one(), abort and return RETRY_TASK, so that the
3382 * scheduler loop can restart.
3383 *
3384 * If @force_scx is true, always try to pick a SCHED_EXT task,
3385 * regardless of any higher-priority sched classes activity.
3386 */
3387 if (!force_scx && rq_modified_above(rq, &ext_sched_class))
3388 return RETRY_TASK;
3389
3390 /*
3391 * If we're keeping @prev, replenish slice if necessary and keep running
3392 * @prev. Otherwise, pop the first one from the local DSQ.
3393 */
3394 if (verdict == SCX_DSP_PREV) {
3395 p = prev;
3396 if (!p->scx.slice) {
3397 /* the slice is consumed, protection ends */
3398 scx_task_slice_ended(rq, p);
3399 refill_task_slice_dfl(scx_task_sched(p), p);
3400 }
3401 } else {
3402 p = first_local_task(rq);
3403 if (!p)
3404 return NULL;
3405
3406 if (unlikely(!p->scx.slice) && scx_task_can_stay_on_cpu(rq, p)) {
3407 struct scx_sched *sch = scx_task_sched(p);
3408
3409 if (!scx_bypassing(sch, cpu_of(rq)) &&
3410 !sch->warned_zero_slice) {
3411 printk_deferred(KERN_WARNING "sched_ext: %s[%d] has zero slice in %s()\n",
3412 p->comm, p->pid, __func__);
3413 sch->warned_zero_slice = true;
3414 }
3415 refill_task_slice_dfl(sch, p);
3416 }
3417 }
3418
3419 return p;
3420 }
3421
pick_task_scx(struct rq * rq,struct rq_flags * rf)3422 static struct task_struct *pick_task_scx(struct rq *rq, struct rq_flags *rf)
3423 {
3424 return do_pick_task_scx(rq, rf, false);
3425 }
3426
3427 /*
3428 * Select the next task to run from the ext scheduling class.
3429 *
3430 * Use do_pick_task_scx() directly with @force_scx enabled, since the
3431 * dl_server must always select a sched_ext task.
3432 */
3433 static struct task_struct *
ext_server_pick_task(struct sched_dl_entity * dl_se,struct rq_flags * rf)3434 ext_server_pick_task(struct sched_dl_entity *dl_se, struct rq_flags *rf)
3435 {
3436 if (!scx_enabled())
3437 return NULL;
3438
3439 return do_pick_task_scx(dl_se->rq, rf, true);
3440 }
3441
3442 /*
3443 * Initialize the ext server deadline entity.
3444 */
ext_server_init(struct rq * rq)3445 void ext_server_init(struct rq *rq)
3446 {
3447 struct sched_dl_entity *dl_se = &rq->ext_server;
3448
3449 init_dl_entity(dl_se);
3450
3451 dl_server_init(dl_se, rq, ext_server_pick_task);
3452 }
3453
3454 #ifdef CONFIG_SCHED_CORE
3455 /**
3456 * scx_prio_less - Task ordering for core-sched
3457 * @a: task A
3458 * @b: task B
3459 * @in_fi: in forced idle state
3460 *
3461 * Core-sched is implemented as an additional scheduling layer on top of the
3462 * usual sched_class'es and needs to find out the expected task ordering. For
3463 * SCX, core-sched calls this function to interrogate the task ordering.
3464 *
3465 * A pair of tasks owned by one scheduler is ordered by the owner's
3466 * ops.core_sched_before(). A pair spanning two schedulers is ordered by their
3467 * nearest common ancestor which implements the op - the one case where the op
3468 * is called on tasks that the scheduler delegated to its sub-schedulers and may
3469 * not be scheduling anymore.
3470 *
3471 * When neither applies, or the deciding scheduler is bypassing on either task's
3472 * CPU, the default ordering runs the task which has been waiting longer first.
3473 * A running task counts as the most recently serviced and orders after every
3474 * waiting task. Waiting tasks are compared by @p->scx.runnable_at.
3475 *
3476 * Return: %true if @a should run after @b.
3477 */
scx_prio_less(const struct task_struct * a,const struct task_struct * b,bool in_fi)3478 bool scx_prio_less(const struct task_struct *a, const struct task_struct *b,
3479 bool in_fi)
3480 {
3481 struct scx_sched *sch_a = scx_task_sched(a);
3482 struct scx_sched *sch_b = scx_task_sched(b);
3483 struct scx_sched *sch = NULL;
3484 bool a_running, b_running;
3485
3486 if (sch_a == sch_b) {
3487 if (SCX_HAS_OP(sch_a, core_sched_before))
3488 sch = sch_a;
3489 } else {
3490 s32 level;
3491
3492 for (level = min(sch_a->level, sch_b->level); level >= 0; level--) {
3493 struct scx_sched *anc = sch_a->ancestors[level];
3494
3495 if (anc == sch_b->ancestors[level] &&
3496 SCX_HAS_OP(anc, core_sched_before)) {
3497 sch = anc;
3498 break;
3499 }
3500 }
3501 }
3502
3503 /*
3504 * scx_prio_less() returns whether @a should run after @b while
3505 * ops.core_sched_before() returns whether its first argument should run
3506 * before the second. Swap the arguments.
3507 *
3508 * The const qualifiers are dropped from task_struct pointers when
3509 * calling ops.core_sched_before(). Accesses are controlled by the
3510 * verifier.
3511 */
3512 if (sch && !scx_bypassing(sch, task_cpu(a)) && !scx_bypassing(sch, task_cpu(b)))
3513 return SCX_CALL_OP_2TASKS_RET(sch, core_sched_before, task_rq(a),
3514 (struct task_struct *)b,
3515 (struct task_struct *)a);
3516
3517 /*
3518 * runnable_at is refreshed only on enqueue, so a task which keeps
3519 * occupying its CPU carries a stale stamp. A running task is the most
3520 * recently serviced whatever its stamp says. Order it after every
3521 * waiting task.
3522 */
3523 a_running = a->on_cpu;
3524 b_running = b->on_cpu;
3525 if (a_running != b_running)
3526 return a_running;
3527
3528 return time_after(a->scx.runnable_at, b->scx.runnable_at);
3529 }
3530 #endif /* CONFIG_SCHED_CORE */
3531
select_task_rq_scx(struct task_struct * p,int prev_cpu,int wake_flags)3532 static int select_task_rq_scx(struct task_struct *p, int prev_cpu, int wake_flags)
3533 {
3534 struct scx_sched *sch = scx_task_sched(p);
3535 bool bypassing;
3536
3537 /*
3538 * sched_exec() calls with %WF_EXEC when @p is about to exec(2) as it
3539 * can be a good migration opportunity with low cache and memory
3540 * footprint. Returning a CPU different than @prev_cpu triggers
3541 * immediate rq migration. However, for SCX, as the current rq
3542 * association doesn't dictate where the task is going to run, this
3543 * doesn't fit well. If necessary, we can later add a dedicated method
3544 * which can decide to preempt self to force it through the regular
3545 * scheduling path.
3546 */
3547 if (unlikely(wake_flags & WF_EXEC))
3548 return prev_cpu;
3549
3550 bypassing = scx_bypassing(sch, task_cpu(p));
3551 if (likely(SCX_HAS_OP(sch, select_cpu)) && !bypassing) {
3552 s32 cpu;
3553 struct task_struct **ddsp_taskp;
3554
3555 ddsp_taskp = this_cpu_ptr(&direct_dispatch_task);
3556 WARN_ON_ONCE(*ddsp_taskp);
3557 *ddsp_taskp = p;
3558
3559 this_rq()->scx.in_select_cpu = true;
3560 cpu = SCX_CALL_OP_TASK_RET(sch, select_cpu, NULL, p,
3561 scx_cpu_arg(prev_cpu), wake_flags);
3562 cpu = scx_cpu_ret(sch, cpu);
3563 this_rq()->scx.in_select_cpu = false;
3564 p->scx.selected_cpu = cpu;
3565 *ddsp_taskp = NULL;
3566 if (scx_cpu_valid(sch, cpu, "from ops.select_cpu()"))
3567 return cpu;
3568 else
3569 return prev_cpu;
3570 } else {
3571 s32 cpu;
3572
3573 /*
3574 * While bypassing, the enqueue path routes @p to a bypass DSQ
3575 * without consulting the direct-dispatch target, making the
3576 * default selection pointless. It doesn't work anyway when the
3577 * scheduler does its own idle tracking and the built-in idle
3578 * cpumasks are not updated. Leave @p on @prev_cpu.
3579 */
3580 if (bypassing) {
3581 __scx_add_event(sch, SCX_EV_BYPASS_DISPATCH, 1);
3582 p->scx.selected_cpu = prev_cpu;
3583 return prev_cpu;
3584 }
3585
3586 cpu = scx_select_cpu_dfl(p, prev_cpu, wake_flags, NULL, 0);
3587 if (cpu >= 0) {
3588 /*
3589 * Carry the slice refill and let the insertion commit
3590 * it under rq lock. See the write rules.
3591 */
3592 __scx_add_event(sch, SCX_EV_REFILL_SLICE_DFL, 1);
3593 p->scx.ddsp_slice = READ_ONCE(sch->slice_dfl);
3594 p->scx.ddsp_enq_flags = SCX_ENQ_SLICE_DFL;
3595 p->scx.ddsp_dsq_id = SCX_DSQ_LOCAL;
3596 } else {
3597 cpu = prev_cpu;
3598 }
3599 p->scx.selected_cpu = cpu;
3600
3601 return cpu;
3602 }
3603 }
3604
task_woken_scx(struct rq * rq,struct task_struct * p)3605 static void task_woken_scx(struct rq *rq, struct task_struct *p)
3606 {
3607 run_deferred(rq);
3608 }
3609
set_cpus_allowed_scx(struct task_struct * p,struct affinity_context * ac)3610 static void set_cpus_allowed_scx(struct task_struct *p,
3611 struct affinity_context *ac)
3612 {
3613 struct scx_sched *sch = scx_task_sched(p);
3614
3615 set_cpus_allowed_common(p, ac);
3616
3617 if (task_dead_and_done(p))
3618 return;
3619
3620 /*
3621 * The effective cpumask is stored in @p->cpus_ptr which may temporarily
3622 * differ from the configured one in @p->cpus_mask. Always tell the bpf
3623 * scheduler the effective one.
3624 *
3625 * Fine-grained memory write control is enforced by BPF making the const
3626 * designation pointless. Cast it away when calling the operation.
3627 */
3628 if (SCX_HAS_OP(sch, set_cpumask))
3629 scx_call_op_set_cpumask(sch, task_rq(p), p, (struct cpumask *)p->cpus_ptr);
3630 }
3631
handle_hotplug(struct rq * rq,bool online)3632 static void handle_hotplug(struct rq *rq, bool online)
3633 {
3634 struct scx_sched *sch = scx_root_protected();
3635 s32 cpu = cpu_of(rq);
3636 s32 cpu_or_cid = cpu;
3637
3638 atomic_long_inc(&scx_hotplug_seq);
3639
3640 /*
3641 * scx_root updates are protected by cpus_read_lock() and will stay
3642 * stable here. Note that we can't depend on scx_enabled() test as the
3643 * hotplug ops need to be enabled before __scx_enabled is set.
3644 */
3645 if (unlikely(!sch))
3646 return;
3647
3648 if (scx_enabled())
3649 scx_idle_update_selcpu_topology(&sch->ops);
3650
3651 if (online)
3652 scx_online_ecaps(rq);
3653 else
3654 scx_offline_ecaps(rq);
3655
3656 /*
3657 * The tables can't be retired while this function is running as the
3658 * retirement is inside cpus_read_lock. However, scx_cpu_arg() is
3659 * awkward here as the tables can be NULL after root enable failure and
3660 * lockdep would trigger without surrounding rcu_read_lock(). Open code
3661 * the translation. If the table is NULL, the ops are also cleared and
3662 * @cpu_or_cid goes unused.
3663 */
3664 if (scx_is_cid_type()) {
3665 s16 *tbl = rcu_dereference_check(scx_cpu_to_cid_tbl,
3666 lockdep_is_cpus_held());
3667
3668 if (tbl)
3669 cpu_or_cid = tbl[cpu];
3670 }
3671
3672 if (online && SCX_HAS_OP(sch, cpu_online))
3673 SCX_CALL_OP(sch, cpu_online, NULL, cpu_or_cid);
3674 else if (!online && SCX_HAS_OP(sch, cpu_offline))
3675 SCX_CALL_OP(sch, cpu_offline, NULL, cpu_or_cid);
3676 else
3677 scx_exit(sch, SCX_EXIT_UNREG_KERN,
3678 SCX_ECODE_ACT_RESTART | SCX_ECODE_RSN_HOTPLUG,
3679 "cpu %d going %s, exiting scheduler", cpu,
3680 online ? "online" : "offline");
3681 }
3682
scx_rq_activate(struct rq * rq)3683 void scx_rq_activate(struct rq *rq)
3684 {
3685 handle_hotplug(rq, true);
3686 }
3687
scx_rq_deactivate(struct rq * rq)3688 void scx_rq_deactivate(struct rq *rq)
3689 {
3690 handle_hotplug(rq, false);
3691 }
3692
rq_online_scx(struct rq * rq)3693 static void rq_online_scx(struct rq *rq)
3694 {
3695 rq->scx.flags |= SCX_RQ_ONLINE;
3696 }
3697
rq_offline_scx(struct rq * rq)3698 static void rq_offline_scx(struct rq *rq)
3699 {
3700 rq->scx.flags &= ~SCX_RQ_ONLINE;
3701 scx_rescue_flush(rq);
3702 }
3703
check_rq_for_timeouts(struct rq * rq)3704 static bool check_rq_for_timeouts(struct rq *rq)
3705 {
3706 struct scx_sched *sch;
3707 struct task_struct *p;
3708 struct rq_flags rf;
3709 bool timed_out = false;
3710
3711 rq_lock_irqsave(rq, &rf);
3712 sch = rcu_dereference_bh(scx_root);
3713 if (unlikely(!sch))
3714 goto out_unlock;
3715
3716 list_for_each_entry(p, &rq->scx.runnable_list, scx.runnable_node) {
3717 struct scx_sched *sch = scx_task_sched(p);
3718 unsigned long last_runnable = p->scx.runnable_at;
3719
3720 if (unlikely(time_after(jiffies,
3721 last_runnable + READ_ONCE(sch->watchdog_timeout)))) {
3722 struct scx_dispatch_q *dsq = READ_ONCE(p->scx.dsq);
3723 u32 dur_ms = jiffies_to_msecs(jiffies - last_runnable);
3724
3725 /*
3726 * A task can be stuck on a DSQ that a sched other than
3727 * its owner is responsible for draining, e.g. an
3728 * ancestor's bypass DSQ while the owner is bypassing.
3729 * Blame the drainer. The local DSQ is consumed by the
3730 * cpu itself and keeps blame on the owner.
3731 */
3732 if (dsq && dsq->sched && dsq->id != SCX_DSQ_LOCAL)
3733 sch = dsq->sched;
3734
3735 __scx_exit(sch, SCX_EXIT_ERROR_STALL, 0, cpu_of(rq),
3736 "%s[%d] failed to run for %u.%03us",
3737 p->comm, p->pid, dur_ms / 1000,
3738 dur_ms % 1000);
3739 timed_out = true;
3740 break;
3741 }
3742 }
3743 out_unlock:
3744 rq_unlock_irqrestore(rq, &rf);
3745 return timed_out;
3746 }
3747
scx_watchdog_workfn(struct work_struct * work)3748 static void scx_watchdog_workfn(struct work_struct *work)
3749 {
3750 unsigned long intv;
3751 int cpu;
3752
3753 WRITE_ONCE(scx_watchdog_timestamp, jiffies);
3754
3755 for_each_online_cpu(cpu) {
3756 if (unlikely(check_rq_for_timeouts(cpu_rq(cpu))))
3757 break;
3758
3759 cond_resched();
3760 }
3761
3762 intv = READ_ONCE(scx_watchdog_interval);
3763 if (intv < ULONG_MAX)
3764 queue_delayed_work(system_dfl_wq, to_delayed_work(work), intv);
3765 }
3766
scx_tick(struct rq * rq)3767 void scx_tick(struct rq *rq)
3768 {
3769 struct scx_sched *root;
3770 unsigned long last_check;
3771
3772 if (!scx_enabled())
3773 return;
3774
3775 root = rcu_dereference_bh(scx_root);
3776 if (unlikely(!root))
3777 return;
3778
3779 last_check = READ_ONCE(scx_watchdog_timestamp);
3780 if (unlikely(time_after(jiffies,
3781 last_check + READ_ONCE(root->watchdog_timeout)))) {
3782 u32 dur_ms = jiffies_to_msecs(jiffies - last_check);
3783
3784 scx_exit(root, SCX_EXIT_ERROR_STALL, 0,
3785 "watchdog failed to check in for %u.%03us",
3786 dur_ms / 1000, dur_ms % 1000);
3787 }
3788
3789 update_other_load_avgs(rq);
3790 }
3791
task_tick_scx(struct rq * rq,struct task_struct * curr,int queued)3792 static void task_tick_scx(struct rq *rq, struct task_struct *curr, int queued)
3793 {
3794 struct scx_sched *sch = scx_task_sched(curr);
3795
3796 update_curr_scx(rq);
3797
3798 /*
3799 * While disabling, always resched as we can't trust the slice
3800 * management.
3801 */
3802 if (scx_bypassing(sch, cpu_of(rq)))
3803 scx_set_task_slice(curr, 0);
3804 else if (SCX_HAS_OP(sch, tick))
3805 SCX_CALL_OP_TASK(sch, tick, rq, curr);
3806
3807 if (!curr->scx.slice)
3808 resched_curr(rq);
3809 }
3810
3811 #ifdef CONFIG_EXT_GROUP_SCHED
tg_cgrp(struct task_group * tg)3812 static struct cgroup *tg_cgrp(struct task_group *tg)
3813 {
3814 /*
3815 * If CGROUP_SCHED is disabled, @tg is NULL. If @tg is an autogroup,
3816 * @tg->css.cgroup is NULL. In both cases, @tg can be treated as the
3817 * root cgroup.
3818 */
3819 if (tg && tg->css.cgroup)
3820 return tg->css.cgroup;
3821 else
3822 return &cgrp_dfl_root.cgrp;
3823 }
3824
3825 #define SCX_INIT_TASK_ARGS_CGROUP(cgrp) .cgroup = (cgrp),
3826
3827 #else /* CONFIG_EXT_GROUP_SCHED */
3828
3829 #define SCX_INIT_TASK_ARGS_CGROUP(cgrp)
3830
3831 #endif /* CONFIG_EXT_GROUP_SCHED */
3832
3833 /**
3834 * __scx_init_task - Initialize a task for a sched
3835 * @sch: sched to initialize @p for
3836 * @p: task of interest
3837 * @cgrp: cgroup @p is joining, %NULL for @p's current task_group's cgroup
3838 * @fork: %true if @p is being forked
3839 *
3840 * Pre-commit cgroup migration passes @cgrp explicitly as @p's task_group
3841 * still reflects the source.
3842 *
3843 * Return 0 on success, -errno on failure.
3844 */
__scx_init_task(struct scx_sched * sch,struct task_struct * p,struct cgroup * cgrp,bool fork)3845 int __scx_init_task(struct scx_sched *sch, struct task_struct *p,
3846 struct cgroup *cgrp, bool fork)
3847 {
3848 int ret;
3849
3850 p->scx.disallow = false;
3851
3852 if (SCX_HAS_OP(sch, init_task)) {
3853 struct scx_init_task_args args = {
3854 SCX_INIT_TASK_ARGS_CGROUP(cgrp ?: tg_cgrp(task_group(p)))
3855 .fork = fork,
3856 };
3857
3858 ret = SCX_CALL_OP_RET(sch, init_task, NULL, p, &args);
3859 if (unlikely(ret)) {
3860 ret = scx_ops_sanitize_err(sch, "init_task", ret);
3861 return ret;
3862 }
3863 }
3864
3865 if (p->scx.disallow) {
3866 if (unlikely(scx_parent(sch))) {
3867 scx_error(sch, "non-root ops.init_task() set task->scx.disallow for %s[%d]",
3868 p->comm, p->pid);
3869 } else if (unlikely(fork)) {
3870 scx_error(sch, "ops.init_task() set task->scx.disallow for %s[%d] during fork",
3871 p->comm, p->pid);
3872 } else if (unlikely(scx_enable_state() != SCX_ENABLING)) {
3873 scx_error(sch, "ops.init_task() set task->scx.disallow for %s[%d] outside the enable path",
3874 p->comm, p->pid);
3875 } else {
3876 struct rq *rq;
3877 struct rq_flags rf;
3878
3879 rq = task_rq_lock(p, &rf);
3880
3881 /*
3882 * We're in the load path and @p->policy will be applied
3883 * right after. Reverting @p->policy here and rejecting
3884 * %SCHED_EXT transitions from scx_check_setscheduler()
3885 * guarantees that if ops.init_task() sets @p->disallow,
3886 * @p can never be in SCX.
3887 */
3888 if (p->policy == SCHED_EXT) {
3889 p->policy = SCHED_NORMAL;
3890 atomic_long_inc(&scx_nr_rejected);
3891 }
3892
3893 task_rq_unlock(rq, p, &rf);
3894 }
3895 }
3896
3897 return 0;
3898 }
3899
__scx_enable_task(struct scx_sched * sch,struct task_struct * p)3900 static void __scx_enable_task(struct scx_sched *sch, struct task_struct *p)
3901 {
3902 struct rq *rq = task_rq(p);
3903 u32 weight;
3904
3905 lockdep_assert_rq_held(rq);
3906
3907 /*
3908 * Verify the task is not in BPF scheduler's custody. If flag
3909 * transitions are consistent, the flag should always be clear
3910 * here.
3911 */
3912 WARN_ON_ONCE(p->scx.flags & SCX_TASK_IN_CUSTODY);
3913
3914 /*
3915 * Set the weight before calling ops.enable() so that the scheduler
3916 * doesn't see a stale value if they inspect the task struct.
3917 */
3918 if (task_has_idle_policy(p))
3919 weight = WEIGHT_IDLEPRIO;
3920 else
3921 weight = sched_prio_to_weight[p->static_prio - MAX_RT_PRIO];
3922
3923 p->scx.weight = sched_weight_to_cgroup(weight);
3924
3925 if (SCX_HAS_OP(sch, enable))
3926 SCX_CALL_OP_TASK(sch, enable, rq, p);
3927
3928 if (SCX_HAS_OP(sch, set_weight))
3929 SCX_CALL_OP_TASK(sch, set_weight, rq, p, p->scx.weight);
3930 }
3931
scx_enable_task(struct scx_sched * sch,struct task_struct * p)3932 void scx_enable_task(struct scx_sched *sch, struct task_struct *p)
3933 {
3934 __scx_enable_task(sch, p);
3935 scx_set_task_state(p, SCX_TASK_ENABLED);
3936 }
3937
scx_disable_task(struct scx_sched * sch,struct task_struct * p)3938 static void scx_disable_task(struct scx_sched *sch, struct task_struct *p)
3939 {
3940 struct rq *rq = task_rq(p);
3941
3942 lockdep_assert_rq_held(rq);
3943 WARN_ON_ONCE(scx_get_task_state(p) != SCX_TASK_ENABLED);
3944
3945 clear_direct_dispatch(p);
3946
3947 if (SCX_HAS_OP(sch, disable))
3948 SCX_CALL_OP_TASK(sch, disable, rq, p);
3949 scx_set_task_state(p, SCX_TASK_READY);
3950
3951 /*
3952 * Reset the SCX-managed fields when @p leaves the BPF scheduler's
3953 * control, after ops.disable() has observed their final values.
3954 */
3955 p->scx.dsq_vtime = 0;
3956 scx_task_slice_ended(rq, p);
3957 scx_set_task_slice(p, 0);
3958 p->scx.reenq_cnt = 0;
3959
3960 /*
3961 * Verify the task is not in BPF scheduler's custody. If flag
3962 * transitions are consistent, the flag should always be clear
3963 * here.
3964 */
3965 WARN_ON_ONCE(p->scx.flags & SCX_TASK_IN_CUSTODY);
3966 }
3967
__scx_disable_and_exit_task(struct scx_sched * sch,struct task_struct * p)3968 void __scx_disable_and_exit_task(struct scx_sched *sch, struct task_struct *p)
3969 {
3970 struct scx_exit_task_args args = {
3971 .cancelled = false,
3972 };
3973
3974 lockdep_assert_held(&p->pi_lock);
3975 lockdep_assert_rq_held(task_rq(p));
3976
3977 switch (scx_get_task_state(p)) {
3978 case SCX_TASK_NONE:
3979 return;
3980 case SCX_TASK_INIT:
3981 args.cancelled = true;
3982 break;
3983 case SCX_TASK_READY:
3984 break;
3985 case SCX_TASK_ENABLED:
3986 scx_disable_task(sch, p);
3987 break;
3988 default:
3989 WARN_ON_ONCE(true);
3990 return;
3991 }
3992
3993 if (SCX_HAS_OP(sch, exit_task))
3994 SCX_CALL_OP_TASK(sch, exit_task, task_rq(p), p, &args);
3995 }
3996
3997 /*
3998 * Undo a completed __scx_init_task(sch, p, false) when scx_enable_task() never
3999 * ran. The task state has not been transitioned, so this mirrors the
4000 * SCX_TASK_INIT branch in __scx_disable_and_exit_task().
4001 */
scx_sub_init_cancel_task(struct scx_sched * sch,struct task_struct * p)4002 void scx_sub_init_cancel_task(struct scx_sched *sch, struct task_struct *p)
4003 {
4004 struct scx_exit_task_args args = { .cancelled = true };
4005
4006 lockdep_assert_held(&p->pi_lock);
4007 lockdep_assert_rq_held(task_rq(p));
4008
4009 /* @p was never associated with @sch, dispatch on the explicit @sch */
4010 if (SCX_HAS_OP(sch, exit_task))
4011 __SCX_CALL_OP_TASK(sch, ops, exit_task, task_rq(p), p, &args);
4012 }
4013
scx_disable_and_exit_task(struct scx_sched * sch,struct task_struct * p)4014 void scx_disable_and_exit_task(struct scx_sched *sch, struct task_struct *p)
4015 {
4016 __scx_disable_and_exit_task(sch, p);
4017
4018 /*
4019 * If set, @p exited between __scx_init_task() and scx_enable_task() in
4020 * scx_sub_enable() and is initialized for both the associated sched and
4021 * its parent. Exit for the child too - scx_enable_task() never ran for
4022 * it, so undo only init_task. The flag is only set on the sub-enable
4023 * path, so it's always clear when @p arrives here in %SCX_TASK_NONE.
4024 */
4025 if (p->scx.flags & SCX_TASK_SUB_INIT) {
4026 if (!WARN_ON_ONCE(!scx_enabling_sub_sched))
4027 scx_sub_init_cancel_task(scx_enabling_sub_sched, p);
4028 p->scx.flags &= ~SCX_TASK_SUB_INIT;
4029 }
4030
4031 scx_set_task_sched(p, NULL);
4032 scx_set_task_state(p, SCX_TASK_NONE);
4033 }
4034
init_scx_entity(struct sched_ext_entity * scx)4035 void init_scx_entity(struct sched_ext_entity *scx)
4036 {
4037 memset(scx, 0, sizeof(*scx));
4038 INIT_LIST_HEAD(&scx->dsq_list.node);
4039 RB_CLEAR_NODE(&scx->dsq_priq);
4040 scx->sticky_cpu = -1;
4041 scx->holding_cpu = -1;
4042 scx->runnable_cpu = -1;
4043 INIT_LIST_HEAD(&scx->runnable_node);
4044 scx->runnable_at = jiffies;
4045 scx->ddsp_dsq_id = SCX_DSQ_INVALID;
4046 scx->slice = SCX_SLICE_DFL;
4047 }
4048
4049 /* See scx_tid_alloc / scx_tid_cursor. */
scx_alloc_tid(void)4050 static u64 scx_alloc_tid(void)
4051 {
4052 struct scx_tid_alloc *ta;
4053
4054 guard(preempt)();
4055 ta = this_cpu_ptr(&scx_tid_alloc);
4056
4057 if (unlikely(ta->next >= ta->end)) {
4058 ta->next = atomic64_fetch_add(SCX_TID_CHUNK, &scx_tid_cursor);
4059 ta->end = ta->next + SCX_TID_CHUNK;
4060 }
4061 return ta->next++;
4062 }
4063
scx_tid_hash_insert(struct task_struct * p)4064 static void scx_tid_hash_insert(struct task_struct *p)
4065 {
4066 int ret;
4067
4068 lockdep_assert_held(&scx_tasks_lock);
4069
4070 ret = rhashtable_lookup_insert_fast(&scx_tid_hash,
4071 &p->scx.tid_hash_node,
4072 scx_tid_hash_params);
4073 WARN_ON_ONCE(ret);
4074 }
4075
scx_pre_fork(struct task_struct * p)4076 void scx_pre_fork(struct task_struct *p)
4077 {
4078 /*
4079 * BPF scheduler enable/disable paths want to be able to iterate and
4080 * update all tasks which can become complex when racing forks. As
4081 * enable/disable are very cold paths, let's use a percpu_rwsem to
4082 * exclude forks.
4083 */
4084 percpu_down_read(&scx_fork_rwsem);
4085 }
4086
scx_fork(struct task_struct * p,struct kernel_clone_args * kargs)4087 int scx_fork(struct task_struct *p, struct kernel_clone_args *kargs)
4088 {
4089 s32 ret;
4090
4091 percpu_rwsem_assert_held(&scx_fork_rwsem);
4092
4093 p->scx.tid = scx_alloc_tid();
4094
4095 if (scx_init_task_enabled) {
4096 #ifdef CONFIG_EXT_SUB_SCHED
4097 struct scx_sched *sch = scx_cgroup_sched(kargs->cset->dfl_cgrp);
4098 #else
4099 struct scx_sched *sch = scx_root_protected_live();
4100 #endif
4101 scx_set_task_state(p, SCX_TASK_INIT_BEGIN);
4102 ret = __scx_init_task(sch, p, NULL, true);
4103 if (unlikely(ret)) {
4104 scx_set_task_state(p, SCX_TASK_NONE);
4105 return ret;
4106 }
4107 scx_set_task_state(p, SCX_TASK_INIT);
4108 scx_set_task_sched(p, sch);
4109 }
4110
4111 return 0;
4112 }
4113
scx_post_fork(struct task_struct * p)4114 void scx_post_fork(struct task_struct *p)
4115 {
4116 if (scx_init_task_enabled) {
4117 scx_set_task_state(p, SCX_TASK_READY);
4118
4119 /*
4120 * Enable the task immediately if it's running on sched_ext.
4121 * Otherwise, it'll be enabled in switching_to_scx() if and
4122 * when it's ever configured to run with a SCHED_EXT policy.
4123 */
4124 if (p->sched_class == &ext_sched_class) {
4125 struct rq_flags rf;
4126 struct rq *rq;
4127
4128 rq = task_rq_lock(p, &rf);
4129 scx_enable_task(scx_task_sched(p), p);
4130 task_rq_unlock(rq, p, &rf);
4131 }
4132 }
4133
4134 scoped_guard(raw_spinlock_irq, &scx_tasks_lock) {
4135 list_add_tail(&p->scx.tasks_node, &scx_tasks);
4136 if (scx_tid_to_task_enabled())
4137 scx_tid_hash_insert(p);
4138 }
4139
4140 percpu_up_read(&scx_fork_rwsem);
4141 }
4142
scx_cancel_fork(struct task_struct * p)4143 void scx_cancel_fork(struct task_struct *p)
4144 {
4145 if (scx_init_task_enabled) {
4146 struct rq *rq;
4147 struct rq_flags rf;
4148
4149 rq = task_rq_lock(p, &rf);
4150 WARN_ON_ONCE(scx_get_task_state(p) >= SCX_TASK_READY);
4151 scx_disable_and_exit_task(scx_task_sched(p), p);
4152 task_rq_unlock(rq, p, &rf);
4153 }
4154
4155 percpu_up_read(&scx_fork_rwsem);
4156 }
4157
4158 /**
4159 * task_dead_and_done - Is a task dead and done running?
4160 * @p: target task
4161 *
4162 * Once sched_ext_dead() removes the dead task from scx_tasks and exits it, the
4163 * task no longer exists from SCX's POV. However, certain sched_class ops may be
4164 * invoked on these dead tasks leading to failures - e.g. sched_setscheduler()
4165 * may try to switch a task which finished sched_ext_dead() back into SCX
4166 * triggering invalid SCX task state transitions and worse.
4167 *
4168 * Once a task has finished the final switch, sched_ext_dead() is the only thing
4169 * that needs to happen on the task. Use this test to short-circuit sched_class
4170 * operations which may be called on dead tasks.
4171 */
task_dead_and_done(struct task_struct * p)4172 static bool task_dead_and_done(struct task_struct *p)
4173 {
4174 struct rq *rq = task_rq(p);
4175
4176 lockdep_assert_rq_held(rq);
4177
4178 /*
4179 * In do_task_dead(), a dying task sets %TASK_DEAD with preemption
4180 * disabled and __schedule(). If @p has %TASK_DEAD set and off CPU, @p
4181 * won't ever run again.
4182 */
4183 return unlikely(READ_ONCE(p->__state) == TASK_DEAD) &&
4184 !task_on_cpu(rq, p);
4185 }
4186
sched_ext_dead(struct task_struct * p)4187 void sched_ext_dead(struct task_struct *p)
4188 {
4189 /*
4190 * By the time control reaches here, @p has %TASK_DEAD set, switched out
4191 * for the last time and then dropped the rq lock - task_dead_and_done()
4192 * should be returning %true nullifying the straggling sched_class ops.
4193 * Remove from scx_tasks and exit @p.
4194 */
4195 scoped_guard(raw_spinlock_irqsave, &scx_tasks_lock) {
4196 list_del_init(&p->scx.tasks_node);
4197 if (scx_tid_to_task_enabled())
4198 rhashtable_remove_fast(&scx_tid_hash,
4199 &p->scx.tid_hash_node,
4200 scx_tid_hash_params);
4201 }
4202
4203 /*
4204 * @p is off scx_tasks and wholly ours. scx_root_enable()'s READY ->
4205 * ENABLED transitions can't race us. Disable ops for @p.
4206 *
4207 * %SCX_TASK_DEAD synchronizes against cgroup task iteration - see
4208 * scx_task_iter_next_locked(). NONE tasks need no marking: cgroup
4209 * iteration is only used from sub-sched paths, which require root
4210 * enabled. Root enable transitions every live task to at least READY.
4211 *
4212 * %INIT_BEGIN means ops.init_task() is running for @p. Don't call
4213 * into ops; transition to %DEAD so the post-init recheck unwinds
4214 * via scx_sub_init_cancel_task().
4215 */
4216 if (scx_get_task_state(p) != SCX_TASK_NONE) {
4217 struct rq_flags rf;
4218 struct rq *rq;
4219
4220 rq = task_rq_lock(p, &rf);
4221 if (scx_get_task_state(p) != SCX_TASK_INIT_BEGIN)
4222 scx_disable_and_exit_task(scx_task_sched(p), p);
4223 scx_set_task_state(p, SCX_TASK_DEAD);
4224 task_rq_unlock(rq, p, &rf);
4225 }
4226 }
4227
reweight_task_scx(struct rq * rq,struct task_struct * p,const struct load_weight * lw)4228 static void reweight_task_scx(struct rq *rq, struct task_struct *p,
4229 const struct load_weight *lw)
4230 {
4231 struct scx_sched *sch = scx_task_sched(p);
4232
4233 lockdep_assert_rq_held(task_rq(p));
4234
4235 if (task_dead_and_done(p))
4236 return;
4237
4238 /*
4239 * When switching sched_class away from SCX, reweight_task_scx()
4240 * is called _after_ scx_disable_task(). Skip calling ops.set_weight()
4241 * since the BPF scheduler may have already forgotten the task in
4242 * ops.disable().
4243 * p->scx.weight will be recalculated in scx_enable_task() if the task
4244 * ever returns to SCX class.
4245 */
4246 if (scx_get_task_state(p) != SCX_TASK_ENABLED)
4247 return;
4248
4249 p->scx.weight = sched_weight_to_cgroup(scale_load_down(lw->weight));
4250 if (SCX_HAS_OP(sch, set_weight))
4251 SCX_CALL_OP_TASK(sch, set_weight, rq, p, p->scx.weight);
4252 }
4253
prio_changed_scx(struct rq * rq,struct task_struct * p,u64 oldprio)4254 static void prio_changed_scx(struct rq *rq, struct task_struct *p, u64 oldprio)
4255 {
4256 }
4257
switching_to_scx(struct rq * rq,struct task_struct * p)4258 static void switching_to_scx(struct rq *rq, struct task_struct *p)
4259 {
4260 struct scx_sched *sch = scx_task_sched(p);
4261
4262 if (task_dead_and_done(p))
4263 return;
4264
4265 scx_enable_task(sch, p);
4266
4267 /*
4268 * set_cpus_allowed_scx() is not called while @p is associated with a
4269 * different scheduler class. Keep the BPF scheduler up-to-date.
4270 */
4271 if (SCX_HAS_OP(sch, set_cpumask))
4272 scx_call_op_set_cpumask(sch, rq, p, (struct cpumask *)p->cpus_ptr);
4273 }
4274
switched_from_scx(struct rq * rq,struct task_struct * p)4275 static void switched_from_scx(struct rq *rq, struct task_struct *p)
4276 {
4277 if (task_dead_and_done(p))
4278 return;
4279
4280 /*
4281 * %NONE means SCX is no longer tracking @p at the task level (e.g.
4282 * scx_fail_parent() handed @p back to the parent at NONE pending the
4283 * parent's own teardown). There is nothing to disable; calling
4284 * scx_disable_task() would WARN on the non-%ENABLED state and trigger a
4285 * NONE -> READY validation failure.
4286 */
4287 if (scx_get_task_state(p) == SCX_TASK_NONE)
4288 return;
4289
4290 scx_disable_task(scx_task_sched(p), p);
4291 }
4292
switched_to_scx(struct rq * rq,struct task_struct * p)4293 static void switched_to_scx(struct rq *rq, struct task_struct *p) {}
4294
scx_check_setscheduler(struct task_struct * p,int policy)4295 int scx_check_setscheduler(struct task_struct *p, int policy)
4296 {
4297 lockdep_assert_rq_held(task_rq(p));
4298
4299 /* if disallow, reject transitioning into SCX */
4300 if (scx_enabled() && READ_ONCE(p->scx.disallow) &&
4301 p->policy != policy && policy == SCHED_EXT)
4302 return -EACCES;
4303
4304 return 0;
4305 }
4306
process_ddsp_deferred_locals(struct rq * rq)4307 static void process_ddsp_deferred_locals(struct rq *rq)
4308 {
4309 struct task_struct *p;
4310
4311 lockdep_assert_rq_held(rq);
4312
4313 /*
4314 * Now that @rq can be unlocked, execute the deferred enqueueing of
4315 * tasks directly dispatched to the local DSQs of other CPUs. See
4316 * direct_dispatch(). Keep popping from the head instead of using
4317 * list_for_each_entry_safe() as dispatch_local_dsq() may unlock @rq
4318 * temporarily.
4319 */
4320 while ((p = list_first_entry_or_null(&rq->scx.ddsp_deferred_locals,
4321 struct task_struct, scx.dsq_list.node))) {
4322 struct scx_sched *sch = scx_task_sched(p);
4323 struct scx_dispatch_q *dsq;
4324 u64 dsq_id = p->scx.ddsp_dsq_id;
4325 u64 enq_flags = p->scx.ddsp_enq_flags;
4326 u64 slice = p->scx.ddsp_slice;
4327 u64 vtime = p->scx.ddsp_vtime;
4328
4329 list_del_init(&p->scx.dsq_list.node);
4330 clear_direct_dispatch(p);
4331
4332 dsq = find_dsq_for_dispatch(sch, rq, dsq_id, task_cpu(p));
4333 if (!WARN_ON_ONCE(dsq->id != SCX_DSQ_LOCAL))
4334 dispatch_to_local_dsq(sch, rq, dsq, p, slice, vtime, enq_flags);
4335 }
4336 }
4337
4338 /*
4339 * Determine whether @p should be reenqueued from a local DSQ.
4340 *
4341 * @reenq_flags is mutable and accumulates state across the DSQ walk:
4342 *
4343 * - %SCX_REENQ_TSR_NOT_FIRST: Set after the first task is visited. "First"
4344 * tracks position in the DSQ list, not among IMMED tasks. A non-IMMED task at
4345 * the head consumes the first slot.
4346 *
4347 * - %SCX_REENQ_TSR_RQ_OPEN: Set by reenq_local() before the walk if
4348 * rq_is_open() is true.
4349 *
4350 * An IMMED task is kept (returns %false) only if it's the first task in the DSQ
4351 * AND the current task is done — i.e. it will execute immediately. All other
4352 * IMMED tasks are reenqueued. This means if a non-IMMED task sits at the head,
4353 * every IMMED task behind it gets reenqueued.
4354 *
4355 * Reenqueued tasks go through ops.enqueue() with %SCX_ENQ_REENQ |
4356 * %SCX_TASK_REENQ_IMMED. If the BPF scheduler dispatches back to the same local
4357 * DSQ with %SCX_ENQ_IMMED while the CPU is still unavailable, this triggers
4358 * another reenq cycle. Repetitions are bounded by %SCX_REENQ_MAX_REPEAT in
4359 * scx_do_enqueue_task(), which ejects the task's owning scheduler.
4360 */
local_task_should_reenq(struct rq * rq,struct task_struct * p,u64 * reenq_flags,u32 * reason)4361 static bool local_task_should_reenq(struct rq *rq, struct task_struct *p,
4362 u64 *reenq_flags, u32 *reason)
4363 {
4364 bool first;
4365
4366 first = !(*reenq_flags & SCX_REENQ_TSR_NOT_FIRST);
4367 *reenq_flags |= SCX_REENQ_TSR_NOT_FIRST;
4368
4369 if (unlikely((p->scx.flags & SCX_TASK_PROTECTED) || p == scx_rescuee(rq)))
4370 return false;
4371
4372 *reason = SCX_TASK_REENQ_KFUNC;
4373
4374 if ((p->scx.flags & SCX_TASK_IMMED) &&
4375 (!first || !(*reenq_flags & SCX_REENQ_TSR_RQ_OPEN))) {
4376 __scx_add_event(scx_task_sched(p), SCX_EV_REENQ_IMMED, 1);
4377 *reason = SCX_TASK_REENQ_IMMED;
4378 return true;
4379 }
4380
4381 if ((*reenq_flags & SCX_REENQ_CAP_REVOKE) &&
4382 scx_task_reenq_on_cap_revoke(rq, p)) {
4383 *reason = SCX_TASK_REENQ_CAP;
4384 return true;
4385 }
4386
4387 return *reenq_flags & SCX_REENQ_ANY;
4388 }
4389
reenq_local(struct scx_sched * sch,struct rq * rq,u64 reenq_flags)4390 static u32 reenq_local(struct scx_sched *sch, struct rq *rq, u64 reenq_flags)
4391 {
4392 LIST_HEAD(tasks);
4393 u32 nr_enqueued = 0;
4394 struct task_struct *p, *n;
4395
4396 lockdep_assert_rq_held(rq);
4397
4398 if (WARN_ON_ONCE(reenq_flags & __SCX_REENQ_TSR_MASK))
4399 reenq_flags &= ~__SCX_REENQ_TSR_MASK;
4400 if (rq_is_open(rq, 0))
4401 reenq_flags |= SCX_REENQ_TSR_RQ_OPEN;
4402
4403 /*
4404 * The BPF scheduler may choose to dispatch tasks back to
4405 * @rq->scx.local_dsq. Move all candidate tasks off to a private list
4406 * first to avoid processing the same tasks repeatedly.
4407 */
4408 list_for_each_entry_safe(p, n, &rq->scx.local_dsq.list,
4409 scx.dsq_list.node) {
4410 struct scx_sched *task_sch = scx_task_sched(p);
4411 u32 reason;
4412
4413 /*
4414 * If @p is being migrated, @p's current CPU may not agree with
4415 * its allowed CPUs and the migration_cpu_stop is about to
4416 * deactivate and re-activate @p anyway. Skip re-enqueueing.
4417 *
4418 * While racing sched property changes may also dequeue and
4419 * re-enqueue a migrating task while its current CPU and allowed
4420 * CPUs disagree, they use %ENQUEUE_RESTORE which is bypassed to
4421 * the current local DSQ for running tasks and thus are not
4422 * visible to the BPF scheduler.
4423 */
4424 if (p->migration_pending)
4425 continue;
4426
4427 if (!scx_is_descendant(task_sch, sch))
4428 continue;
4429
4430 if (!local_task_should_reenq(rq, p, &reenq_flags, &reason))
4431 continue;
4432
4433 scx_dispatch_dequeue(rq, p);
4434
4435 if (WARN_ON_ONCE(p->scx.flags & SCX_TASK_REENQ_REASON_MASK))
4436 p->scx.flags &= ~SCX_TASK_REENQ_REASON_MASK;
4437 p->scx.flags |= reason;
4438
4439 list_add_tail(&p->scx.dsq_list.node, &tasks);
4440 }
4441
4442 list_for_each_entry_safe(p, n, &tasks, scx.dsq_list.node) {
4443 list_del_init(&p->scx.dsq_list.node);
4444
4445 scx_do_enqueue_task(rq, p, SCX_ENQ_REENQ, -1);
4446
4447 p->scx.flags &= ~SCX_TASK_REENQ_REASON_MASK;
4448 nr_enqueued++;
4449 }
4450
4451 /*
4452 * The revoke that scheduled this scan may have raced the pick: curr
4453 * may be a now-capless task, either one that kept running or one
4454 * promoted off the local DSQ between the ecaps sync and this scan.
4455 * Zero the slice to evict it. The enqueue gate blocks new capless
4456 * inserts, so no later pick can slip through after the scan.
4457 */
4458 if ((reenq_flags & SCX_REENQ_CAP_REVOKE) &&
4459 rq->curr->sched_class == &ext_sched_class &&
4460 scx_task_reenq_on_cap_revoke(rq, rq->curr)) {
4461 scx_set_task_slice(rq->curr, 0);
4462 resched_curr(rq);
4463 }
4464
4465 return nr_enqueued;
4466 }
4467
process_deferred_reenq_locals(struct rq * rq)4468 static void process_deferred_reenq_locals(struct rq *rq)
4469 {
4470 lockdep_assert_rq_held(rq);
4471
4472 /*
4473 * A task can be re-queued within this loop when a reenqueued task
4474 * bounces straight back to the local DSQ. That recursion is bounded by
4475 * the per-task reenqueue cap in scx_do_enqueue_task().
4476 */
4477 while (true) {
4478 struct scx_sched *sch;
4479 u64 reenq_flags;
4480
4481 scoped_guard (raw_spinlock, &rq->scx.deferred_reenq_lock) {
4482 struct scx_deferred_reenq_local *drl =
4483 list_first_entry_or_null(&rq->scx.deferred_reenq_locals,
4484 struct scx_deferred_reenq_local,
4485 node);
4486 struct scx_sched_pcpu *sch_pcpu;
4487
4488 if (!drl)
4489 return;
4490
4491 sch_pcpu = container_of(drl, struct scx_sched_pcpu,
4492 deferred_reenq_local);
4493 sch = sch_pcpu->sch;
4494
4495 reenq_flags = drl->flags;
4496 WRITE_ONCE(drl->flags, 0);
4497 list_del_init(&drl->node);
4498 }
4499
4500 /* see schedule_dsq_reenq() */
4501 smp_mb();
4502
4503 reenq_local(sch, rq, reenq_flags);
4504 }
4505 }
4506
user_task_should_reenq(struct task_struct * p,u64 reenq_flags,u32 * reason)4507 static bool user_task_should_reenq(struct task_struct *p, u64 reenq_flags, u32 *reason)
4508 {
4509 *reason = SCX_TASK_REENQ_KFUNC;
4510 return reenq_flags & SCX_REENQ_ANY;
4511 }
4512
reenq_user(struct rq * rq,struct scx_dispatch_q * dsq,u64 reenq_flags)4513 static void reenq_user(struct rq *rq, struct scx_dispatch_q *dsq, u64 reenq_flags)
4514 {
4515 struct rq *locked_rq = rq;
4516 struct scx_sched *sch = dsq->sched;
4517 struct scx_dsq_list_node cursor = INIT_DSQ_LIST_CURSOR(cursor, dsq, 0);
4518 struct task_struct *p;
4519 s32 nr_enqueued = 0;
4520
4521 lockdep_assert_rq_held(rq);
4522
4523 raw_spin_lock(&dsq->lock);
4524
4525 while (likely(!READ_ONCE(sch->bypass_depth))) {
4526 struct rq *task_rq;
4527 u32 reason;
4528
4529 p = nldsq_cursor_next_task(&cursor, dsq);
4530 if (!p)
4531 break;
4532
4533 if (!user_task_should_reenq(p, reenq_flags, &reason))
4534 continue;
4535
4536 task_rq = task_rq(p);
4537
4538 if (locked_rq != task_rq) {
4539 if (locked_rq) {
4540 scx_rq_lock_drop(locked_rq);
4541 raw_spin_rq_unlock(locked_rq);
4542 }
4543 if (unlikely(!raw_spin_rq_trylock(task_rq))) {
4544 raw_spin_unlock(&dsq->lock);
4545 raw_spin_rq_lock(task_rq);
4546 raw_spin_lock(&dsq->lock);
4547 }
4548 locked_rq = task_rq;
4549
4550 /* did we lose @p while switching locks? */
4551 if (nldsq_cursor_lost_task(&cursor, task_rq, dsq, p))
4552 continue;
4553 }
4554
4555 /* @p is on @dsq, its rq and @dsq are locked */
4556 dispatch_dequeue_locked(p, dsq);
4557 raw_spin_unlock(&dsq->lock);
4558
4559 if (WARN_ON_ONCE(p->scx.flags & SCX_TASK_REENQ_REASON_MASK))
4560 p->scx.flags &= ~SCX_TASK_REENQ_REASON_MASK;
4561 p->scx.flags |= reason;
4562
4563 scx_do_enqueue_task(task_rq, p, SCX_ENQ_REENQ, -1);
4564
4565 p->scx.flags &= ~SCX_TASK_REENQ_REASON_MASK;
4566
4567 if (!(++nr_enqueued % SCX_TASK_ITER_BATCH)) {
4568 scx_rq_lock_drop(locked_rq);
4569 raw_spin_rq_unlock(locked_rq);
4570 locked_rq = NULL;
4571 cpu_relax();
4572 }
4573
4574 raw_spin_lock(&dsq->lock);
4575 }
4576
4577 list_del_init(&cursor.node);
4578 raw_spin_unlock(&dsq->lock);
4579
4580 if (locked_rq != rq) {
4581 if (locked_rq) {
4582 scx_rq_lock_drop(locked_rq);
4583 raw_spin_rq_unlock(locked_rq);
4584 }
4585 raw_spin_rq_lock(rq);
4586 }
4587 }
4588
process_deferred_reenq_users(struct rq * rq)4589 static void process_deferred_reenq_users(struct rq *rq)
4590 {
4591 lockdep_assert_rq_held(rq);
4592
4593 while (true) {
4594 struct scx_dispatch_q *dsq;
4595 u64 dsq_id, reenq_flags;
4596
4597 scoped_guard (raw_spinlock, &rq->scx.deferred_reenq_lock) {
4598 struct scx_deferred_reenq_user *dru =
4599 list_first_entry_or_null(&rq->scx.deferred_reenq_users,
4600 struct scx_deferred_reenq_user,
4601 node);
4602 struct scx_dsq_pcpu *dsq_pcpu;
4603
4604 if (!dru)
4605 return;
4606
4607 dsq_pcpu = container_of(dru, struct scx_dsq_pcpu,
4608 deferred_reenq_user);
4609 dsq = dsq_pcpu->dsq;
4610 reenq_flags = dru->flags;
4611 WRITE_ONCE(dru->flags, 0);
4612 list_del_init(&dru->node);
4613 }
4614
4615 /* see schedule_dsq_reenq() */
4616 smp_mb();
4617
4618 /* destroy_dsq() may have raced and invalidated @dsq, nothing to reenq */
4619 dsq_id = READ_ONCE(dsq->id);
4620 if (unlikely(dsq_id == SCX_DSQ_INVALID))
4621 continue;
4622
4623 BUG_ON(dsq_id & SCX_DSQ_FLAG_BUILTIN);
4624 reenq_user(rq, dsq, reenq_flags);
4625 }
4626 }
4627
run_deferred(struct rq * rq)4628 static void run_deferred(struct rq *rq)
4629 {
4630 process_ddsp_deferred_locals(rq);
4631
4632 if (!list_empty(&rq->scx.deferred_reenq_locals))
4633 process_deferred_reenq_locals(rq);
4634
4635 if (!list_empty(&rq->scx.deferred_reenq_users))
4636 process_deferred_reenq_users(rq);
4637
4638 scx_reenq_reject(rq);
4639 }
4640
4641 #ifdef CONFIG_NO_HZ_FULL
scx_can_stop_tick(struct rq * rq)4642 bool scx_can_stop_tick(struct rq *rq)
4643 {
4644 struct task_struct *p = rq->curr;
4645 struct scx_sched *sch = scx_task_sched(p);
4646
4647 if (p->sched_class != &ext_sched_class)
4648 return true;
4649
4650 /*
4651 * @rq->curr may still reference an outgoing EXT task after it has been
4652 * dequeued. If no EXT tasks are accounted on @rq, ignore its stale
4653 * slice state. If another task is dispatched from a DSQ,
4654 * set_next_task_scx() will update the dependency for the incoming task.
4655 */
4656 if (!rq->scx.nr_running)
4657 return true;
4658
4659 if (scx_bypassing(sch, cpu_of(rq)))
4660 return false;
4661
4662 /*
4663 * A running rescuee's charging and expiry are tick-driven, see
4664 * scx_rescue_charge(). Keep the tick while rescue is in progress.
4665 */
4666 if (unlikely(p == scx_rescuee(rq)))
4667 return false;
4668
4669 /*
4670 * @rq can dispatch from different DSQs, so we can't tell whether it
4671 * needs the tick or not by looking at nr_running. Allow stopping ticks
4672 * iff the BPF scheduler indicated so. See set_next_task_scx().
4673 */
4674 return rq->scx.flags & SCX_RQ_CAN_STOP_TICK;
4675 }
4676 #endif
4677
4678 #ifdef CONFIG_EXT_GROUP_SCHED
4679
4680 DEFINE_STATIC_PERCPU_RWSEM(scx_cgroup_ops_rwsem);
4681
scx_tg_init(struct task_group * tg)4682 void scx_tg_init(struct task_group *tg)
4683 {
4684 tg->scx.weight = CGROUP_WEIGHT_DFL;
4685 tg->scx.bw_period_us = default_bw_period_us();
4686 tg->scx.bw_quota_us = RUNTIME_INF;
4687 tg->scx.idle = false;
4688 }
4689
4690 /**
4691 * scx_tg_sched - Resolve a task_group's sched
4692 * @tg: task_group of interest
4693 *
4694 * Return the sched that @tg's ops.cgroup_init() succeeded on, %NULL if @tg
4695 * isn't inited. An autogroup tg has no cgroup of its own and resolves to the
4696 * root sched.
4697 *
4698 * When a child sched exits, its task_groups are moved to the parent and
4699 * re-inited on it. A failed re-init fails the parent in turn and leaves the
4700 * task_group without a sched it's inited on, resolving to %NULL. See
4701 * scx_cgroup_return_subtree().
4702 *
4703 * Safe for callers read-locking the ops rwsem. tg->scx.sched rewrites
4704 * write-lock it, and tg on/offline can't overlap such callers as a css's files
4705 * are created after online and drained before offline.
4706 */
scx_tg_sched(struct task_group * tg)4707 static struct scx_sched *scx_tg_sched(struct task_group *tg)
4708 {
4709 lockdep_assert(lockdep_is_held(&cgroup_mutex) ||
4710 lockdep_is_held(&scx_cgroup_ops_rwsem));
4711
4712 if (!tg->css.cgroup)
4713 tg = &root_task_group;
4714 /* INITED means ops.cgroup_init() succeeded on @tg->scx.sched */
4715 return (tg->scx.flags & SCX_TG_INITED) ? tg->scx.sched : NULL;
4716 }
4717
4718 /**
4719 * scx_tg_knob_sched - Resolve the sched receiving a task_group's knob updates
4720 * @tg: task_group of interest
4721 *
4722 * Knobs of a cgroup belong to the parent. Deliver the set_* ops to the
4723 * parent task_group's sched, which equals @tg's own sched everywhere except
4724 * at a sub-scheduler attach point, where the sub's parent sched receives
4725 * them.
4726 *
4727 * Return %NULL if the parent task_group has no sched. That can happen when the
4728 * parent's ops.cgroup_init() fails while a sub-scheduler is being disabled.
4729 *
4730 * The callers sit in @tg's cgroup file writes holding the ops rwsem read
4731 * side. That extends scx_tg_sched()'s file-write argument to the parent's
4732 * sched read: a parent css outlives its children's files.
4733 */
scx_tg_knob_sched(struct task_group * tg)4734 static struct scx_sched *scx_tg_knob_sched(struct task_group *tg)
4735 {
4736 lockdep_assert(lockdep_is_held(&cgroup_mutex) ||
4737 lockdep_is_held(&scx_cgroup_ops_rwsem));
4738
4739 if (!tg->css.cgroup || !tg->css.parent)
4740 return scx_tg_sched(&root_task_group);
4741 return scx_tg_sched(css_tg(tg->css.parent));
4742 }
4743
scx_tg_online(struct task_group * tg)4744 int scx_tg_online(struct task_group *tg)
4745 {
4746 int ret = 0;
4747
4748 WARN_ON_ONCE(tg->scx.flags & (SCX_TG_ONLINE | SCX_TG_INITED));
4749
4750 if (scx_cgroup_enabled) {
4751 struct scx_sched *sch;
4752
4753 /*
4754 * The cgroup lifetime notifier populates cgrp->scx_sched before
4755 * css_online, but only on the default hierarchy. Sub-scheds are
4756 * attached to the cgroup2 hierarchy, so a cgroup1 task_group
4757 * always belongs to the root sched.
4758 */
4759 if (cgroup_on_dfl(tg->css.cgroup))
4760 sch = scx_cgroup_sched(tg->css.cgroup);
4761 else
4762 sch = scx_tg_sched(&root_task_group);
4763
4764 if (SCX_HAS_OP(sch, cgroup_init)) {
4765 struct scx_cgroup_init_args args =
4766 { .weight = tg->scx.weight,
4767 .bw_period_us = tg->scx.bw_period_us,
4768 .bw_quota_us = tg->scx.bw_quota_us,
4769 .bw_burst_us = tg->scx.bw_burst_us };
4770
4771 ret = SCX_CALL_OP_RET(sch, cgroup_init,
4772 NULL, tg->css.cgroup, &args);
4773 if (ret)
4774 ret = scx_ops_sanitize_err(sch, "cgroup_init", ret);
4775 }
4776 if (ret == 0) {
4777 tg->scx.sched = sch;
4778 tg->scx.flags |= SCX_TG_ONLINE | SCX_TG_INITED;
4779 }
4780 } else {
4781 tg->scx.flags |= SCX_TG_ONLINE;
4782 }
4783
4784 return ret;
4785 }
4786
scx_tg_offline(struct task_group * tg)4787 void scx_tg_offline(struct task_group *tg)
4788 {
4789 struct scx_sched *sch = tg->scx.sched;
4790
4791 WARN_ON_ONCE(!(tg->scx.flags & SCX_TG_ONLINE));
4792
4793 /* INITED implies non-NULL @sch, test before SCX_HAS_OP() derefs */
4794 if (scx_cgroup_enabled && (tg->scx.flags & SCX_TG_INITED) &&
4795 SCX_HAS_OP(sch, cgroup_exit))
4796 SCX_CALL_OP(sch, cgroup_exit, NULL, tg->css.cgroup);
4797 tg->scx.sched = NULL;
4798 tg->scx.flags &= ~(SCX_TG_ONLINE | SCX_TG_INITED);
4799 }
4800
4801 /*
4802 * @p's sched for the cgroup migration paths. Stable as re-homes happen either
4803 * at CGROUP_TASK_MIGRATED of the same migration or under scx_cgroup_lock(),
4804 * both while holding cgroup_mutex.
4805 */
scx_cgroup_task_sched(struct task_struct * p)4806 static struct scx_sched *scx_cgroup_task_sched(struct task_struct *p)
4807 {
4808 return rcu_dereference_protected(p->scx.sched, lockdep_is_held(&cgroup_mutex));
4809 }
4810
scx_cgroup_can_attach(struct cgroup_taskset * tset)4811 int scx_cgroup_can_attach(struct cgroup_taskset *tset)
4812 {
4813 struct cgroup_subsys_state *css;
4814 struct task_struct *p;
4815 int ret;
4816
4817 if (!scx_cgroup_enabled)
4818 return 0;
4819
4820 cgroup_taskset_for_each(p, css, tset) {
4821 struct scx_sched *sch = scx_cgroup_task_sched(p);
4822 struct cgroup *from = tg_cgrp(task_group(p));
4823 struct cgroup *to = tg_cgrp(css_tg(css));
4824
4825 WARN_ON_ONCE(p->scx.cgrp_moving_from);
4826
4827 /*
4828 * sched_move_task() omits identity migrations. Let's match the
4829 * behavior so that ops.cgroup_prep_move() and ops.cgroup_move()
4830 * always match one-to-one.
4831 */
4832 if (from == to)
4833 continue;
4834
4835 /*
4836 * The cgroup_move ops are delivered to @p's sched, and only for
4837 * moves that don't re-home @p. A re-homing move changes the dfl
4838 * cgroup's sched and is reported through the
4839 * exit_task/init_task pair that the re-homing generates.
4840 */
4841 if (!sch || sch != scx_cgroup_sched(task_css_set(p)->mg_dst_cset->dfl_cgrp))
4842 continue;
4843
4844 if (SCX_HAS_OP(sch, cgroup_prep_move)) {
4845 ret = SCX_CALL_OP_RET(sch, cgroup_prep_move, NULL,
4846 p, from, css->cgroup);
4847 if (ret) {
4848 ret = scx_ops_sanitize_err(sch, "cgroup_prep_move", ret);
4849 goto err;
4850 }
4851 }
4852
4853 p->scx.cgrp_moving_from = from;
4854 }
4855
4856 return 0;
4857
4858 err:
4859 cgroup_taskset_for_each(p, css, tset) {
4860 struct scx_sched *sch = scx_cgroup_task_sched(p);
4861
4862 /* cgrp_moving_from implies non-NULL @sch, test it first */
4863 if (p->scx.cgrp_moving_from && SCX_HAS_OP(sch, cgroup_cancel_move))
4864 SCX_CALL_OP(sch, cgroup_cancel_move, NULL,
4865 p, p->scx.cgrp_moving_from, css->cgroup);
4866 p->scx.cgrp_moving_from = NULL;
4867 }
4868
4869 return ret;
4870 }
4871
scx_cgroup_move_task(struct task_struct * p)4872 void scx_cgroup_move_task(struct task_struct *p)
4873 {
4874 struct scx_sched *sch;
4875
4876 if (!scx_cgroup_enabled)
4877 return;
4878
4879 /*
4880 * Migration keys off css rather than cgroup identity, so it can hand an
4881 * unchanged-cgroup task here with cgrp_moving_from NULL. Nothing to
4882 * report to the BPF scheduler then, so skip it and keep prep_move and
4883 * move paired.
4884 */
4885 sch = scx_cgroup_task_sched(p);
4886 if (p->scx.cgrp_moving_from && SCX_HAS_OP(sch, cgroup_move))
4887 SCX_CALL_OP_TASK(sch, cgroup_move, task_rq(p),
4888 p, p->scx.cgrp_moving_from,
4889 tg_cgrp(task_group(p)));
4890 p->scx.cgrp_moving_from = NULL;
4891 }
4892
scx_cgroup_cancel_attach(struct cgroup_taskset * tset)4893 void scx_cgroup_cancel_attach(struct cgroup_taskset *tset)
4894 {
4895 struct cgroup_subsys_state *css;
4896 struct task_struct *p;
4897
4898 if (!scx_cgroup_enabled)
4899 return;
4900
4901 cgroup_taskset_for_each(p, css, tset) {
4902 struct scx_sched *sch = scx_cgroup_task_sched(p);
4903
4904 /* cgrp_moving_from implies non-NULL @sch, test it first */
4905 if (p->scx.cgrp_moving_from && SCX_HAS_OP(sch, cgroup_cancel_move))
4906 SCX_CALL_OP(sch, cgroup_cancel_move, NULL,
4907 p, p->scx.cgrp_moving_from, css->cgroup);
4908 p->scx.cgrp_moving_from = NULL;
4909 }
4910 }
4911
scx_group_set_weight(struct task_group * tg,unsigned long weight)4912 void scx_group_set_weight(struct task_group *tg, unsigned long weight)
4913 {
4914 struct scx_sched *sch;
4915
4916 percpu_down_read(&scx_cgroup_ops_rwsem);
4917 sch = scx_tg_knob_sched(tg);
4918
4919 if (scx_cgroup_enabled && sch && SCX_HAS_OP(sch, cgroup_set_weight) &&
4920 tg->scx.weight != weight)
4921 SCX_CALL_OP(sch, cgroup_set_weight, NULL, tg_cgrp(tg), weight);
4922
4923 tg->scx.weight = weight;
4924
4925 percpu_up_read(&scx_cgroup_ops_rwsem);
4926 }
4927
scx_group_set_idle(struct task_group * tg,bool idle)4928 void scx_group_set_idle(struct task_group *tg, bool idle)
4929 {
4930 struct scx_sched *sch;
4931
4932 percpu_down_read(&scx_cgroup_ops_rwsem);
4933 sch = scx_tg_knob_sched(tg);
4934
4935 if (scx_cgroup_enabled && sch && SCX_HAS_OP(sch, cgroup_set_idle))
4936 SCX_CALL_OP(sch, cgroup_set_idle, NULL, tg_cgrp(tg), idle);
4937
4938 /* Update the task group's idle state */
4939 tg->scx.idle = idle;
4940
4941 percpu_up_read(&scx_cgroup_ops_rwsem);
4942 }
4943
scx_group_set_bandwidth(struct task_group * tg,u64 period_us,u64 quota_us,u64 burst_us)4944 void scx_group_set_bandwidth(struct task_group *tg,
4945 u64 period_us, u64 quota_us, u64 burst_us)
4946 {
4947 struct scx_sched *sch;
4948
4949 percpu_down_read(&scx_cgroup_ops_rwsem);
4950 sch = scx_tg_knob_sched(tg);
4951
4952 if (scx_cgroup_enabled && sch && SCX_HAS_OP(sch, cgroup_set_bandwidth) &&
4953 (tg->scx.bw_period_us != period_us ||
4954 tg->scx.bw_quota_us != quota_us ||
4955 tg->scx.bw_burst_us != burst_us))
4956 SCX_CALL_OP(sch, cgroup_set_bandwidth, NULL,
4957 tg_cgrp(tg), period_us, quota_us, burst_us);
4958
4959 tg->scx.bw_period_us = period_us;
4960 tg->scx.bw_quota_us = quota_us;
4961 tg->scx.bw_burst_us = burst_us;
4962
4963 percpu_up_read(&scx_cgroup_ops_rwsem);
4964 }
4965 #endif /* CONFIG_EXT_GROUP_SCHED */
4966
4967 #if defined(CONFIG_EXT_GROUP_SCHED) || defined(CONFIG_EXT_SUB_SCHED)
root_cgroup(void)4968 static struct cgroup *root_cgroup(void)
4969 {
4970 return &cgrp_dfl_root.cgrp;
4971 }
4972
4973 /*
4974 * cgroup_lock() must nest outside the rwsem write side: a writer waiting
4975 * for cgroup_mutex deadlocks with cgroup teardown, which holds it while
4976 * draining a set_* file write blocked on the rwsem behind the writer.
4977 */
scx_cgroup_lock(void)4978 void scx_cgroup_lock(void)
4979 {
4980 cgroup_lock();
4981 #ifdef CONFIG_EXT_GROUP_SCHED
4982 percpu_down_write(&scx_cgroup_ops_rwsem);
4983 #endif
4984 }
4985
scx_cgroup_unlock(void)4986 void scx_cgroup_unlock(void)
4987 {
4988 #ifdef CONFIG_EXT_GROUP_SCHED
4989 percpu_up_write(&scx_cgroup_ops_rwsem);
4990 #endif
4991 cgroup_unlock();
4992 }
4993 #else /* CONFIG_EXT_GROUP_SCHED || CONFIG_EXT_SUB_SCHED */
root_cgroup(void)4994 static inline struct cgroup *root_cgroup(void) { return NULL; }
scx_cgroup_lock(void)4995 static inline void scx_cgroup_lock(void) {}
scx_cgroup_unlock(void)4996 static inline void scx_cgroup_unlock(void) {}
4997 #endif /* CONFIG_EXT_GROUP_SCHED || CONFIG_EXT_SUB_SCHED */
4998
4999 /*
5000 * Omitted operations:
5001 *
5002 * - migrate_task_rq: Unnecessary as task to cpu mapping is transient.
5003 *
5004 * - task_fork/dead: We need fork/dead notifications for all tasks regardless of
5005 * their current sched_class. Call them directly from sched core instead.
5006 */
5007 DEFINE_SCHED_CLASS(ext) = {
5008 .enqueue_task = enqueue_task_scx,
5009 .dequeue_task = dequeue_task_scx,
5010 .yield_task = yield_task_scx,
5011 .yield_to_task = yield_to_task_scx,
5012
5013 .wakeup_preempt = wakeup_preempt_scx,
5014
5015 .pick_task = pick_task_scx,
5016
5017 .put_prev_task = put_prev_task_scx,
5018 .set_next_task = set_next_task_scx,
5019
5020 .select_task_rq = select_task_rq_scx,
5021 .task_woken = task_woken_scx,
5022 .set_cpus_allowed = set_cpus_allowed_scx,
5023
5024 .rq_online = rq_online_scx,
5025 .rq_offline = rq_offline_scx,
5026
5027 .task_tick = task_tick_scx,
5028
5029 .switching_to = switching_to_scx,
5030 .switched_from = switched_from_scx,
5031 .switched_to = switched_to_scx,
5032 .reweight_task = reweight_task_scx,
5033 .prio_changed = prio_changed_scx,
5034
5035 .update_curr = update_curr_scx,
5036
5037 #ifdef CONFIG_UCLAMP_TASK
5038 .uclamp_enabled = 1,
5039 #endif
5040 };
5041
scx_init_dsq(struct scx_dispatch_q * dsq,u64 dsq_id,struct scx_sched * sch)5042 s32 scx_init_dsq(struct scx_dispatch_q *dsq, u64 dsq_id, struct scx_sched *sch)
5043 {
5044 s32 cpu;
5045
5046 memset(dsq, 0, sizeof(*dsq));
5047
5048 raw_spin_lock_init(&dsq->lock);
5049 INIT_LIST_HEAD(&dsq->list);
5050 dsq->id = dsq_id;
5051 dsq->sched = sch;
5052
5053 dsq->pcpu = alloc_percpu(struct scx_dsq_pcpu);
5054 if (!dsq->pcpu)
5055 return -ENOMEM;
5056
5057 for_each_possible_cpu(cpu) {
5058 struct scx_dsq_pcpu *pcpu = per_cpu_ptr(dsq->pcpu, cpu);
5059
5060 pcpu->dsq = dsq;
5061 INIT_LIST_HEAD(&pcpu->deferred_reenq_user.node);
5062 }
5063
5064 return 0;
5065 }
5066
exit_dsq(struct scx_dispatch_q * dsq)5067 static void exit_dsq(struct scx_dispatch_q *dsq)
5068 {
5069 s32 cpu;
5070
5071 for_each_possible_cpu(cpu) {
5072 struct scx_dsq_pcpu *pcpu = per_cpu_ptr(dsq->pcpu, cpu);
5073 struct scx_deferred_reenq_user *dru = &pcpu->deferred_reenq_user;
5074 struct rq *rq = cpu_rq(cpu);
5075
5076 /*
5077 * There must have been a RCU grace period since the last
5078 * insertion and @dsq should be off the deferred list by now.
5079 */
5080 if (WARN_ON_ONCE(!list_empty(&dru->node))) {
5081 guard(raw_spinlock_irqsave)(&rq->scx.deferred_reenq_lock);
5082 list_del_init(&dru->node);
5083 }
5084 }
5085
5086 free_percpu(dsq->pcpu);
5087 }
5088
free_dsq_rcufn(struct rcu_head * rcu)5089 static void free_dsq_rcufn(struct rcu_head *rcu)
5090 {
5091 struct scx_dispatch_q *dsq = container_of(rcu, struct scx_dispatch_q, rcu);
5092
5093 exit_dsq(dsq);
5094 kfree(dsq);
5095 }
5096
free_dsq_irq_workfn(struct irq_work * irq_work)5097 static void free_dsq_irq_workfn(struct irq_work *irq_work)
5098 {
5099 struct llist_node *to_free = llist_del_all(&dsqs_to_free);
5100 struct scx_dispatch_q *dsq, *tmp_dsq;
5101
5102 llist_for_each_entry_safe(dsq, tmp_dsq, to_free, free_node)
5103 call_rcu(&dsq->rcu, free_dsq_rcufn);
5104 }
5105
5106 static DEFINE_IRQ_WORK(free_dsq_irq_work, free_dsq_irq_workfn);
5107
destroy_dsq(struct scx_sched * sch,u64 dsq_id)5108 static void destroy_dsq(struct scx_sched *sch, u64 dsq_id)
5109 {
5110 struct scx_dispatch_q *dsq;
5111 unsigned long flags;
5112
5113 rcu_read_lock();
5114
5115 dsq = find_user_dsq(sch, dsq_id);
5116 if (!dsq)
5117 goto out_unlock_rcu;
5118
5119 raw_spin_lock_irqsave(&dsq->lock, flags);
5120
5121 if (dsq->nr) {
5122 scx_error(sch, "attempting to destroy in-use dsq 0x%016llx (nr=%u)",
5123 dsq->id, dsq->nr);
5124 goto out_unlock_dsq;
5125 }
5126
5127 if (rhashtable_remove_fast(&sch->dsq_hash, &dsq->hash_node,
5128 dsq_hash_params))
5129 goto out_unlock_dsq;
5130
5131 /*
5132 * Mark dead by invalidating ->id to prevent scx_dispatch_enqueue() from
5133 * queueing more tasks. As this function can be called from anywhere,
5134 * freeing is bounced through an irq work to avoid nesting RCU
5135 * operations inside scheduler locks.
5136 */
5137 dsq->id = SCX_DSQ_INVALID;
5138 if (llist_add(&dsq->free_node, &dsqs_to_free))
5139 irq_work_queue(&free_dsq_irq_work);
5140
5141 out_unlock_dsq:
5142 raw_spin_unlock_irqrestore(&dsq->lock, flags);
5143 out_unlock_rcu:
5144 rcu_read_unlock();
5145 }
5146
5147 #ifdef CONFIG_EXT_GROUP_SCHED
scx_cgroup_exit(struct scx_sched * sch)5148 static void scx_cgroup_exit(struct scx_sched *sch)
5149 {
5150 struct cgroup_subsys_state *css;
5151
5152 /*
5153 * scx_tg_on/offline() are excluded through cgroup_lock(). If we walk
5154 * cgroups and exit all the inited ones, all online cgroups are exited.
5155 */
5156 css_for_each_descendant_post(css, &root_task_group.css) {
5157 struct task_group *tg = css_tg(css);
5158
5159 /* also clear the sched of tgs whose ops.cgroup_init() failed */
5160 tg->scx.sched = NULL;
5161 if (tg->scx.flags & SCX_TG_INITED) {
5162 tg->scx.flags &= ~SCX_TG_INITED;
5163 if (sch->ops.cgroup_exit)
5164 SCX_CALL_OP(sch, cgroup_exit, NULL, css->cgroup);
5165 }
5166 }
5167 }
5168
scx_cgroup_init(struct scx_sched * sch)5169 static int scx_cgroup_init(struct scx_sched *sch)
5170 {
5171 struct cgroup_subsys_state *css;
5172 int ret;
5173
5174 /*
5175 * scx_tg_on/offline() are excluded through cgroup_lock(). If we walk
5176 * cgroups and init, all online cgroups are initialized.
5177 */
5178 css_for_each_descendant_pre(css, &root_task_group.css) {
5179 struct task_group *tg = css_tg(css);
5180
5181 if ((tg->scx.flags & (SCX_TG_ONLINE | SCX_TG_INITED)) != SCX_TG_ONLINE)
5182 continue;
5183
5184 if (sch->ops.cgroup_init) {
5185 struct scx_cgroup_init_args args = {
5186 .weight = tg->scx.weight,
5187 .bw_period_us = tg->scx.bw_period_us,
5188 .bw_quota_us = tg->scx.bw_quota_us,
5189 .bw_burst_us = tg->scx.bw_burst_us,
5190 };
5191
5192 ret = SCX_CALL_OP_RET(sch, cgroup_init, NULL, css->cgroup, &args);
5193 if (ret) {
5194 scx_error(sch, "ops.cgroup_init() failed (%d)", ret);
5195 return ret;
5196 }
5197 }
5198
5199 tg->scx.sched = sch;
5200 tg->scx.flags |= SCX_TG_INITED;
5201 }
5202
5203 return 0;
5204 }
5205
5206 #else
scx_cgroup_exit(struct scx_sched * sch)5207 static void scx_cgroup_exit(struct scx_sched *sch) {}
scx_cgroup_init(struct scx_sched * sch)5208 static int scx_cgroup_init(struct scx_sched *sch) { return 0; }
5209 #endif
5210
5211
5212 /********************************************************************************
5213 * Sysfs interface and ops enable/disable.
5214 */
5215
5216 #define SCX_ATTR(_name) \
5217 static struct kobj_attribute scx_attr_##_name = { \
5218 .attr = { .name = __stringify(_name), .mode = 0444 }, \
5219 .show = scx_attr_##_name##_show, \
5220 }
5221
scx_attr_state_show(struct kobject * kobj,struct kobj_attribute * ka,char * buf)5222 static ssize_t scx_attr_state_show(struct kobject *kobj,
5223 struct kobj_attribute *ka, char *buf)
5224 {
5225 return sysfs_emit(buf, "%s\n", scx_enable_state_str[scx_enable_state()]);
5226 }
5227 SCX_ATTR(state);
5228
scx_attr_switch_all_show(struct kobject * kobj,struct kobj_attribute * ka,char * buf)5229 static ssize_t scx_attr_switch_all_show(struct kobject *kobj,
5230 struct kobj_attribute *ka, char *buf)
5231 {
5232 return sysfs_emit(buf, "%d\n", READ_ONCE(scx_switching_all));
5233 }
5234 SCX_ATTR(switch_all);
5235
scx_attr_nr_rejected_show(struct kobject * kobj,struct kobj_attribute * ka,char * buf)5236 static ssize_t scx_attr_nr_rejected_show(struct kobject *kobj,
5237 struct kobj_attribute *ka, char *buf)
5238 {
5239 return sysfs_emit(buf, "%ld\n", atomic_long_read(&scx_nr_rejected));
5240 }
5241 SCX_ATTR(nr_rejected);
5242
scx_attr_hotplug_seq_show(struct kobject * kobj,struct kobj_attribute * ka,char * buf)5243 static ssize_t scx_attr_hotplug_seq_show(struct kobject *kobj,
5244 struct kobj_attribute *ka, char *buf)
5245 {
5246 return sysfs_emit(buf, "%ld\n", atomic_long_read(&scx_hotplug_seq));
5247 }
5248 SCX_ATTR(hotplug_seq);
5249
scx_attr_enable_seq_show(struct kobject * kobj,struct kobj_attribute * ka,char * buf)5250 static ssize_t scx_attr_enable_seq_show(struct kobject *kobj,
5251 struct kobj_attribute *ka, char *buf)
5252 {
5253 return sysfs_emit(buf, "%ld\n", atomic_long_read(&scx_enable_seq));
5254 }
5255 SCX_ATTR(enable_seq);
5256
5257 static struct attribute *scx_global_attrs[] = {
5258 &scx_attr_state.attr,
5259 &scx_attr_switch_all.attr,
5260 &scx_attr_nr_rejected.attr,
5261 &scx_attr_hotplug_seq.attr,
5262 &scx_attr_enable_seq.attr,
5263 NULL,
5264 };
5265
5266 static const struct attribute_group scx_global_attr_group = {
5267 .attrs = scx_global_attrs,
5268 };
5269
5270 static void free_pnode(struct scx_sched_pnode *pnode);
5271 static void free_exit_info(struct scx_exit_info *ei);
5272 static const char *scx_exit_reason(enum scx_exit_kind kind);
5273 static bool scx_claim_exit(struct scx_sched *sch, enum scx_exit_kind kind);
5274
scx_set_cmask_scratch_alloc(struct scx_sched * sch)5275 s32 scx_set_cmask_scratch_alloc(struct scx_sched *sch)
5276 {
5277 size_t size = struct_size_t(struct scx_cmask, bits,
5278 SCX_CMASK_NR_WORDS(num_possible_cpus()));
5279 int cpu;
5280
5281 if (!sch->is_cid_type || !sch->arena_pool)
5282 return 0;
5283
5284 sch->set_cmask_scratch = alloc_percpu(struct scx_cmask *);
5285 if (!sch->set_cmask_scratch)
5286 return -ENOMEM;
5287
5288 for_each_possible_cpu(cpu) {
5289 struct scx_cmask **slot = per_cpu_ptr(sch->set_cmask_scratch, cpu);
5290
5291 *slot = scx_arena_alloc(sch, size);
5292 if (!*slot)
5293 return -ENOMEM;
5294 scx_cmask_init(*slot, 0, num_possible_cpus());
5295 }
5296 return 0;
5297 }
5298
scx_set_cmask_scratch_free(struct scx_sched * sch)5299 static void scx_set_cmask_scratch_free(struct scx_sched *sch)
5300 {
5301 size_t size = struct_size_t(struct scx_cmask, bits,
5302 SCX_CMASK_NR_WORDS(num_possible_cpus()));
5303 int cpu;
5304
5305 if (!sch->set_cmask_scratch)
5306 return;
5307
5308 for_each_possible_cpu(cpu) {
5309 struct scx_cmask **slot = per_cpu_ptr(sch->set_cmask_scratch, cpu);
5310
5311 scx_arena_free(sch, *slot, size);
5312 }
5313 free_percpu(sch->set_cmask_scratch);
5314 sch->set_cmask_scratch = NULL;
5315 }
5316
scx_sched_free_rcu_work(struct work_struct * work)5317 static void scx_sched_free_rcu_work(struct work_struct *work)
5318 {
5319 struct rcu_work *rcu_work = to_rcu_work(work);
5320 struct scx_sched *sch = container_of(rcu_work, struct scx_sched, rcu_work);
5321 struct rhashtable_iter rht_iter;
5322 struct scx_dispatch_q *dsq;
5323 int cpu, node;
5324
5325 irq_work_sync(&sch->propagate_exit_irq_work);
5326 irq_work_sync(&sch->disable_irq_work);
5327 kthread_destroy_worker(sch->helper);
5328 timer_shutdown_sync(&sch->bypass_lb_timer);
5329 free_cpumask_var(sch->bypass_lb_donee_cpumask);
5330 free_cpumask_var(sch->bypass_lb_resched_cpumask);
5331 free_cpumask_var(sch->stall_cpus);
5332
5333 #ifdef CONFIG_EXT_SUB_SCHED
5334 kfree(sch->cgrp_path);
5335 if (sch_cgroup(sch))
5336 cgroup_put(sch_cgroup(sch));
5337 if (sch->sub_kset)
5338 kobject_put(&sch->sub_kset->kobj);
5339 if (scx_parent(sch))
5340 kobject_put(&scx_parent(sch)->kobj);
5341 #endif /* CONFIG_EXT_SUB_SCHED */
5342
5343 for_each_possible_cpu(cpu) {
5344 struct scx_sched_pcpu *pcpu = per_cpu_ptr(sch->pcpu, cpu);
5345
5346 /*
5347 * $sch would have entered bypass mode before the RCU grace
5348 * period. As that blocks new deferrals, all
5349 * deferred_reenq_local_node's must be off-list by now.
5350 */
5351 WARN_ON_ONCE(!list_empty(&pcpu->deferred_reenq_local.node));
5352
5353 /* remove the queued ecaps sync so the pcpu can be freed */
5354 scx_discard_ecaps_to_sync(cpu, pcpu);
5355
5356 /*
5357 * Bypass blocks new kicks. Flush the kick irq_work so this
5358 * pcpu's to_kick_node is off the list before it is freed.
5359 */
5360 irq_work_sync(&cpu_rq(cpu)->scx.kick_cpus_irq_work);
5361 WARN_ON_ONCE(!list_empty(&pcpu->to_kick_node));
5362 free_cpumask_var(pcpu->cpus_to_kick);
5363 free_cpumask_var(pcpu->cpus_to_kick_if_idle);
5364 free_cpumask_var(pcpu->cpus_to_preempt);
5365 free_cpumask_var(pcpu->cpus_to_wait);
5366
5367 exit_dsq(scx_bypass_dsq(sch, cpu));
5368 }
5369
5370 free_percpu(sch->pcpu);
5371
5372 for_each_node_state(node, N_POSSIBLE)
5373 free_pnode(sch->pnode[node]);
5374 kfree(sch->pnode);
5375
5376 scx_free_pshards(sch);
5377
5378 rhashtable_walk_enter(&sch->dsq_hash, &rht_iter);
5379 do {
5380 rhashtable_walk_start(&rht_iter);
5381
5382 while (!IS_ERR_OR_NULL((dsq = rhashtable_walk_next(&rht_iter))))
5383 destroy_dsq(sch, dsq->id);
5384
5385 rhashtable_walk_stop(&rht_iter);
5386 } while (dsq == ERR_PTR(-EAGAIN));
5387 rhashtable_walk_exit(&rht_iter);
5388
5389 rhashtable_free_and_destroy(&sch->dsq_hash, NULL, NULL);
5390 free_exit_info(sch->exit_info);
5391 scx_set_cmask_scratch_free(sch);
5392 scx_arena_pool_destroy(sch);
5393 if (sch->arena_map)
5394 bpf_map_put(sch->arena_map);
5395
5396 /* @sch is completely inactive by now */
5397 scx_dec_has_subs(sch);
5398
5399 kfree(sch);
5400 }
5401
scx_kobj_release(struct kobject * kobj)5402 static void scx_kobj_release(struct kobject *kobj)
5403 {
5404 struct scx_sched *sch = container_of(kobj, struct scx_sched, kobj);
5405
5406 INIT_RCU_WORK(&sch->rcu_work, scx_sched_free_rcu_work);
5407 queue_rcu_work(system_dfl_wq, &sch->rcu_work);
5408 }
5409
scx_attr_ops_show(struct kobject * kobj,struct kobj_attribute * ka,char * buf)5410 static ssize_t scx_attr_ops_show(struct kobject *kobj,
5411 struct kobj_attribute *ka, char *buf)
5412 {
5413 struct scx_sched *sch = container_of(kobj, struct scx_sched, kobj);
5414
5415 return sysfs_emit(buf, "%s\n", sch->ops.name);
5416 }
5417 SCX_ATTR(ops);
5418
5419 #define scx_attr_event_show(buf, at, events, kind) ({ \
5420 sysfs_emit_at(buf, at, "%s %llu\n", #kind, (events)->kind); \
5421 })
5422
scx_attr_events_show(struct kobject * kobj,struct kobj_attribute * ka,char * buf)5423 static ssize_t scx_attr_events_show(struct kobject *kobj,
5424 struct kobj_attribute *ka, char *buf)
5425 {
5426 struct scx_sched *sch = container_of(kobj, struct scx_sched, kobj);
5427 struct scx_event_stats events;
5428 int at = 0;
5429
5430 scx_read_events(sch, &events);
5431 #define SCX_EVENT(name) (at += scx_attr_event_show(buf, at, &events, name))
5432 SCX_EVENTS_LIST(SCX_EVENT);
5433 #undef SCX_EVENT
5434 return at;
5435 }
5436 SCX_ATTR(events);
5437
5438 #ifdef CONFIG_EXT_SUB_SCHED
5439 static const char *scx_cap_names[__SCX_NR_CAPS] = {
5440 [__SCX_CAP_ENQ_IMMED] = "enq_immed",
5441 [__SCX_CAP_ENQ] = "enq",
5442 [__SCX_CAP_PREEMPT] = "preempt",
5443 [__SCX_CAP_PERF] = "perf",
5444 };
5445
scx_attr_caps_show(struct kobject * kobj,struct kobj_attribute * ka,char * buf)5446 static ssize_t scx_attr_caps_show(struct kobject *kobj,
5447 struct kobj_attribute *ka, char *buf)
5448 {
5449 struct scx_sched *sch = container_of(kobj, struct scx_sched, kobj);
5450 u32 npossible = num_possible_cpus();
5451 struct scx_cmask *agg __free(kfree) =
5452 kzalloc(struct_size(agg, bits, SCX_CMASK_NR_WORDS(npossible)), GFP_KERNEL);
5453 unsigned long *agg_bm __free(bitmap) = bitmap_zalloc(npossible, GFP_KERNEL);
5454 ssize_t count = 0;
5455 s32 cap, si;
5456
5457 if (!agg || !agg_bm)
5458 return -ENOMEM;
5459
5460 for (cap = 0; cap < __SCX_NR_CAPS; cap++) {
5461 SCX_CMASK_DEFINE(snap, 0, SCX_CID_SHARD_MAX_CPUS);
5462
5463 scx_cmask_init(agg, 0, npossible);
5464 for (si = 0; si < sch->nr_pshards; si++) {
5465 struct scx_cmask *cm = &sch->pshard[si]->caps[cap].cmask;
5466
5467 scx_cmask_reframe(snap, cm->base, cm->nr_cids);
5468 scx_cmask_copy(snap, cm);
5469 scx_cmask_or(agg, snap);
5470 }
5471 /* %*pbl takes unsigned long bitmap layout, convert from u64 */
5472 bitmap_from_arr64(agg_bm, agg->bits, npossible);
5473 count += sysfs_emit_at(buf, count, "%s: %*pbl\n",
5474 scx_cap_names[cap], npossible, agg_bm);
5475 }
5476 return count;
5477 }
5478 SCX_ATTR(caps);
5479 #endif /* CONFIG_EXT_SUB_SCHED */
5480
5481 static struct attribute *scx_sched_attrs[] = {
5482 &scx_attr_ops.attr,
5483 &scx_attr_events.attr,
5484 #ifdef CONFIG_EXT_SUB_SCHED
5485 &scx_attr_caps.attr,
5486 #endif
5487 NULL,
5488 };
5489 ATTRIBUTE_GROUPS(scx_sched);
5490
5491 static const struct kobj_type scx_ktype = {
5492 .release = scx_kobj_release,
5493 .sysfs_ops = &kobj_sysfs_ops,
5494 .default_groups = scx_sched_groups,
5495 };
5496
scx_uevent(const struct kobject * kobj,struct kobj_uevent_env * env)5497 static int scx_uevent(const struct kobject *kobj, struct kobj_uevent_env *env)
5498 {
5499 const struct scx_sched *sch;
5500
5501 /*
5502 * scx_uevent() can be reached by both scx_sched kobjects (scx_ktype)
5503 * and sub-scheduler kset kobjects (kset_ktype) through the parent
5504 * chain walk. Filter out the latter to avoid invalid casts.
5505 */
5506 if (kobj->ktype != &scx_ktype)
5507 return 0;
5508
5509 sch = container_of(kobj, struct scx_sched, kobj);
5510
5511 return add_uevent_var(env, "SCXOPS=%s", sch->ops.name);
5512 }
5513
5514 static const struct kset_uevent_ops scx_uevent_ops = {
5515 .uevent = scx_uevent,
5516 };
5517
5518 /*
5519 * Used by sched_fork() and __setscheduler_class() to pick the matching
5520 * sched_class. dl/rt are already handled.
5521 */
task_should_scx(int policy)5522 bool task_should_scx(int policy)
5523 {
5524 /* if disabled, nothing should be on it */
5525 if (!scx_enabled())
5526 return false;
5527
5528 /* scx is taking over all SCHED_OTHER and SCHED_EXT tasks */
5529 if (READ_ONCE(scx_switching_all))
5530 return true;
5531
5532 /*
5533 * scx is tearing down - keep new SCHED_EXT tasks out.
5534 *
5535 * Must come after scx_switching_all test, which serves as a proxy
5536 * for __scx_switched_all. While __scx_switched_all is set, we must
5537 * return true via the branch above: a fork routed to fair would
5538 * stall because next_active_class() skips fair.
5539 *
5540 * This can develop into a deadlock - scx holds scx_enable_mutex across
5541 * kthread_create() in scx_alloc_and_add_sched(); if the new kthread is
5542 * the stalled task, the disable path can never grab the mutex to clear
5543 * scx_switching_all.
5544 */
5545 if (unlikely(scx_enable_state() == SCX_DISABLING))
5546 return false;
5547
5548 return policy == SCHED_EXT;
5549 }
5550
scx_allow_ttwu_queue(const struct task_struct * p)5551 bool scx_allow_ttwu_queue(const struct task_struct *p)
5552 {
5553 struct scx_sched *sch;
5554
5555 if (!scx_enabled())
5556 return true;
5557
5558 sch = scx_task_sched(p);
5559 if (unlikely(!sch))
5560 return true;
5561
5562 if (sch->ops.flags & SCX_OPS_ALLOW_QUEUED_WAKEUP)
5563 return true;
5564
5565 if (unlikely(p->sched_class != &ext_sched_class))
5566 return true;
5567
5568 return false;
5569 }
5570
5571 /**
5572 * handle_lockup - sched_ext common lockup handler
5573 * @exit_cpu: CPU to record in exit_info. Pass the stalled/hung CPU, not current.
5574 * @fmt: format string
5575 *
5576 * Called on system stall or lockup condition and initiates abort of sched_ext
5577 * if enabled, which may resolve the reported lockup.
5578 *
5579 * Returns %true if sched_ext is enabled and abort was initiated, which may
5580 * resolve the lockup. %false if sched_ext is not enabled or abort was already
5581 * initiated by someone else.
5582 */
handle_lockup(int exit_cpu,const char * fmt,...)5583 static __printf(2, 3) bool handle_lockup(int exit_cpu, const char *fmt, ...)
5584 {
5585 struct scx_sched *sch;
5586 va_list args;
5587 bool ret;
5588
5589 guard(rcu)();
5590
5591 sch = rcu_dereference(scx_root);
5592 if (unlikely(!sch))
5593 return false;
5594
5595 switch (scx_enable_state()) {
5596 case SCX_ENABLING:
5597 case SCX_ENABLED:
5598 va_start(args, fmt);
5599 ret = scx_vexit(sch, SCX_EXIT_ERROR, 0, exit_cpu, fmt, args);
5600 va_end(args);
5601 return ret;
5602 default:
5603 return false;
5604 }
5605 }
5606
5607 /**
5608 * scx_rcu_cpu_stall - sched_ext RCU CPU stall handler
5609 * @stalled_mask: bit mask of stalled CPUs
5610 *
5611 * While there are various reasons why RCU CPU stalls can occur on a system
5612 * that may not be caused by the current BPF scheduler, try kicking out the
5613 * current scheduler in an attempt to recover the system to a good state before
5614 * issuing panics.
5615 *
5616 * Returns %true if sched_ext is enabled and abort was initiated, which may
5617 * resolve the reported RCU stall. %false if sched_ext is not enabled or someone
5618 * else already initiated abort.
5619 */
scx_rcu_cpu_stall(const struct cpumask * stalled_mask)5620 bool scx_rcu_cpu_stall(const struct cpumask *stalled_mask)
5621 {
5622 struct scx_sched *sch;
5623 struct scx_exit_info *ei;
5624 int exit_cpu;
5625
5626 guard(rcu)();
5627
5628 sch = rcu_dereference(scx_root);
5629 if (unlikely(!sch))
5630 return false;
5631
5632 switch (scx_enable_state()) {
5633 case SCX_ENABLING:
5634 case SCX_ENABLED:
5635 break;
5636 default:
5637 return false;
5638 }
5639
5640 exit_cpu = cpumask_empty(stalled_mask) ? -1 : (int)cpumask_first(stalled_mask);
5641 ei = sch->exit_info;
5642
5643 guard(preempt)();
5644
5645 if (!scx_claim_exit(sch, SCX_EXIT_ERROR))
5646 return false;
5647
5648 #ifdef CONFIG_STACKTRACE
5649 ei->bt_len = stack_trace_save(ei->bt, SCX_EXIT_BT_LEN, 1);
5650 #endif
5651 scnprintf(ei->msg, SCX_EXIT_MSG_LEN, "RCU CPU stall on CPUs (%*pbl)",
5652 cpumask_pr_args(stalled_mask));
5653 ei->kind = SCX_EXIT_ERROR;
5654 ei->reason = scx_exit_reason(SCX_EXIT_ERROR);
5655 ei->exit_cpu = exit_cpu;
5656 cpumask_copy(sch->stall_cpus, stalled_mask);
5657
5658 irq_work_queue(&sch->disable_irq_work);
5659 return true;
5660 }
5661
5662 /**
5663 * scx_softlockup - sched_ext softlockup handler
5664 * @dur_s: number of seconds of CPU stuck due to soft lockup
5665 *
5666 * On some multi-socket setups (e.g. 2x Intel 8480c), the BPF scheduler can
5667 * live-lock the system by making many CPUs target the same DSQ to the point
5668 * where soft-lockup detection triggers. This function is called from
5669 * soft-lockup watchdog when the triggering point is close and tries to unjam
5670 * the system and aborting the BPF scheduler.
5671 */
scx_softlockup(u32 dur_s)5672 void scx_softlockup(u32 dur_s)
5673 {
5674 int cpu = smp_processor_id();
5675
5676 if (!handle_lockup(cpu, "soft lockup - CPU %d stuck for %us", cpu, dur_s))
5677 return;
5678
5679 printk_deferred(KERN_ERR "sched_ext: Soft lockup - CPU %d stuck for %us, disabling BPF scheduler\n",
5680 cpu, dur_s);
5681 }
5682
5683 /**
5684 * scx_hardlockup - sched_ext hardlockup handler
5685 * @cpu: the target CPU
5686 *
5687 * A poorly behaving BPF scheduler can trigger hard lockup by e.g. putting
5688 * numerous affinitized tasks in a single queue and directing all CPUs at it.
5689 * Try kicking out the current scheduler in an attempt to recover the system to
5690 * a good state before taking more drastic actions.
5691 *
5692 * Called from NMI. Aborting the scheduler sets ->aborting throughout the
5693 * hierarchy before returning, which is what breaks the dispatch-path live-locks
5694 * that can hard-lock CPUs.
5695 *
5696 * Returns %true if sched_ext is enabled and abort was initiated, which may
5697 * resolve the lockup. %false if sched_ext is not enabled or abort was already
5698 * initiated by someone else.
5699 */
scx_hardlockup(int cpu)5700 bool scx_hardlockup(int cpu)
5701 {
5702 if (!handle_lockup(cpu, "hard lockup - CPU %d", cpu))
5703 return false;
5704
5705 printk_deferred(KERN_ERR "sched_ext: Hard lockup - CPU %d, disabling BPF scheduler\n",
5706 cpu);
5707 return true;
5708 }
5709
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)5710 static u32 bypass_lb_cpu(struct scx_sched *sch, s32 donor,
5711 struct cpumask *donee_mask, struct cpumask *resched_mask,
5712 u32 nr_donor_target, u32 nr_donee_target)
5713 {
5714 struct rq *donor_rq = cpu_rq(donor);
5715 struct scx_dispatch_q *donor_dsq = scx_bypass_dsq(sch, donor);
5716 struct task_struct *p, *n;
5717 struct scx_dsq_list_node cursor = INIT_DSQ_LIST_CURSOR(cursor, donor_dsq, 0);
5718 s32 delta = READ_ONCE(donor_dsq->nr) - nr_donor_target;
5719 u32 nr_balanced = 0, min_delta_us;
5720
5721 /*
5722 * All we want to guarantee is reasonable forward progress. No reason to
5723 * fine tune. Assuming every task on @donor_dsq runs their full slice,
5724 * consider offloading iff the total queued duration is over the
5725 * threshold.
5726 */
5727 min_delta_us = READ_ONCE(scx_bypass_lb_intv_us) / SCX_BYPASS_LB_MIN_DELTA_DIV;
5728 if (delta < DIV_ROUND_UP(min_delta_us, READ_ONCE(scx_slice_bypass_us)))
5729 return 0;
5730
5731 raw_spin_rq_lock_irq(donor_rq);
5732 raw_spin_lock(&donor_dsq->lock);
5733 list_add(&cursor.node, &donor_dsq->list);
5734 resume:
5735 n = container_of(&cursor, struct task_struct, scx.dsq_list);
5736 n = nldsq_next_task(donor_dsq, n, false);
5737
5738 while ((p = n)) {
5739 struct scx_dispatch_q *donee_dsq;
5740 int donee;
5741
5742 n = nldsq_next_task(donor_dsq, n, false);
5743
5744 if (donor_dsq->nr <= nr_donor_target)
5745 break;
5746
5747 if (cpumask_empty(donee_mask))
5748 break;
5749
5750 /*
5751 * If an earlier pass placed @p on @donor_dsq from a different
5752 * CPU and the donee hasn't consumed it yet, @p is still on the
5753 * previous CPU and task_rq(@p) != @donor_rq. @p can't be moved
5754 * without its rq locked. Skip.
5755 */
5756 if (task_rq(p) != donor_rq)
5757 continue;
5758
5759 donee = cpumask_any_and_distribute(donee_mask, p->cpus_ptr);
5760 if (donee >= nr_cpu_ids)
5761 continue;
5762
5763 donee_dsq = scx_bypass_dsq(sch, donee);
5764
5765 /*
5766 * $p's rq is not locked but $p's DSQ lock protects its
5767 * scheduling properties making this test safe.
5768 */
5769 if (!task_can_run_on_remote_rq(sch, p, cpu_rq(donee), false))
5770 continue;
5771
5772 /*
5773 * Moving $p from one non-local DSQ to another. The source rq
5774 * and DSQ are already locked. Do an abbreviated dequeue and
5775 * then perform enqueue without unlocking $donor_dsq.
5776 *
5777 * We don't want to drop and reacquire the lock on each
5778 * iteration as @donor_dsq can be very long and potentially
5779 * highly contended. Donee DSQs are less likely to be contended.
5780 * The nested locking is safe as only this LB moves tasks
5781 * between bypass DSQs.
5782 */
5783 dispatch_dequeue_locked(p, donor_dsq);
5784 scx_dispatch_enqueue(sch, cpu_rq(donee), donee_dsq, p, 0, 0, SCX_ENQ_NESTED);
5785
5786 /*
5787 * $donee might have been idle and need to be woken up. No need
5788 * to be clever. Kick every CPU that receives tasks.
5789 */
5790 cpumask_set_cpu(donee, resched_mask);
5791
5792 if (READ_ONCE(donee_dsq->nr) >= nr_donee_target)
5793 cpumask_clear_cpu(donee, donee_mask);
5794
5795 nr_balanced++;
5796 if (!(nr_balanced % SCX_BYPASS_LB_BATCH) && n) {
5797 list_move_tail(&cursor.node, &n->scx.dsq_list.node);
5798 raw_spin_unlock(&donor_dsq->lock);
5799 scx_rq_lock_drop(donor_rq);
5800 raw_spin_rq_unlock_irq(donor_rq);
5801 cpu_relax();
5802 raw_spin_rq_lock_irq(donor_rq);
5803 raw_spin_lock(&donor_dsq->lock);
5804 goto resume;
5805 }
5806 }
5807
5808 list_del_init(&cursor.node);
5809 raw_spin_unlock(&donor_dsq->lock);
5810 scx_rq_lock_drop(donor_rq);
5811 raw_spin_rq_unlock_irq(donor_rq);
5812
5813 return nr_balanced;
5814 }
5815
bypass_lb_node(struct scx_sched * sch,int node)5816 static void bypass_lb_node(struct scx_sched *sch, int node)
5817 {
5818 const struct cpumask *node_mask = cpumask_of_node(node);
5819 struct cpumask *donee_mask = sch->bypass_lb_donee_cpumask;
5820 struct cpumask *resched_mask = sch->bypass_lb_resched_cpumask;
5821 u32 nr_tasks = 0, nr_cpus = 0, nr_balanced = 0;
5822 u32 nr_target, nr_donor_target;
5823 u32 before_min = U32_MAX, before_max = 0;
5824 u32 after_min = U32_MAX, after_max = 0;
5825 int cpu;
5826
5827 /* count the target tasks and CPUs */
5828 for_each_cpu_and(cpu, cpu_online_mask, node_mask) {
5829 u32 nr = READ_ONCE(scx_bypass_dsq(sch, cpu)->nr);
5830
5831 nr_tasks += nr;
5832 nr_cpus++;
5833
5834 before_min = min(nr, before_min);
5835 before_max = max(nr, before_max);
5836 }
5837
5838 if (!nr_cpus)
5839 return;
5840
5841 /*
5842 * We don't want CPUs to have more than $nr_donor_target tasks and
5843 * balancing to fill donee CPUs upto $nr_target. Once targets are
5844 * calculated, find the donee CPUs.
5845 */
5846 nr_target = DIV_ROUND_UP(nr_tasks, nr_cpus);
5847 nr_donor_target = DIV_ROUND_UP(nr_target * SCX_BYPASS_LB_DONOR_PCT, 100);
5848
5849 cpumask_clear(donee_mask);
5850 for_each_cpu_and(cpu, cpu_online_mask, node_mask) {
5851 if (READ_ONCE(scx_bypass_dsq(sch, cpu)->nr) < nr_target)
5852 cpumask_set_cpu(cpu, donee_mask);
5853 }
5854
5855 /* iterate !donee CPUs and see if they should be offloaded */
5856 cpumask_clear(resched_mask);
5857 for_each_cpu_and(cpu, cpu_online_mask, node_mask) {
5858 if (cpumask_empty(donee_mask))
5859 break;
5860 if (cpumask_test_cpu(cpu, donee_mask))
5861 continue;
5862 if (READ_ONCE(scx_bypass_dsq(sch, cpu)->nr) <= nr_donor_target)
5863 continue;
5864
5865 nr_balanced += bypass_lb_cpu(sch, cpu, donee_mask, resched_mask,
5866 nr_donor_target, nr_target);
5867 }
5868
5869 for_each_cpu(cpu, resched_mask)
5870 resched_cpu(cpu);
5871
5872 for_each_cpu_and(cpu, cpu_online_mask, node_mask) {
5873 u32 nr = READ_ONCE(scx_bypass_dsq(sch, cpu)->nr);
5874
5875 after_min = min(nr, after_min);
5876 after_max = max(nr, after_max);
5877
5878 }
5879
5880 trace_sched_ext_bypass_lb(node, nr_cpus, nr_tasks, nr_balanced,
5881 before_min, before_max, after_min, after_max);
5882 }
5883
5884 /*
5885 * In bypass mode, all tasks are put on the per-CPU bypass DSQs. If the machine
5886 * is over-saturated and the BPF scheduler skewed tasks into few CPUs, some
5887 * bypass DSQs can be overloaded. If there are enough tasks to saturate other
5888 * lightly loaded CPUs, such imbalance can lead to very high execution latency
5889 * on the overloaded CPUs and thus to hung tasks and RCU stalls. To avoid such
5890 * outcomes, a simple load balancing mechanism is implemented by the following
5891 * timer which runs periodically while bypass mode is in effect.
5892 */
scx_bypass_lb_timerfn(struct timer_list * timer)5893 static void scx_bypass_lb_timerfn(struct timer_list *timer)
5894 {
5895 struct scx_sched *sch = container_of(timer, struct scx_sched, bypass_lb_timer);
5896 int node;
5897 u32 intv_us;
5898
5899 if (!scx_bypass_dsp_enabled(sch))
5900 return;
5901
5902 for_each_node_with_cpus(node)
5903 bypass_lb_node(sch, node);
5904
5905 intv_us = READ_ONCE(scx_bypass_lb_intv_us);
5906 if (intv_us)
5907 mod_timer(timer, jiffies + usecs_to_jiffies(intv_us));
5908 }
5909
inc_bypass_depth(struct scx_sched * sch)5910 static bool inc_bypass_depth(struct scx_sched *sch)
5911 {
5912 lockdep_assert_held(&scx_bypass_lock);
5913
5914 WARN_ON_ONCE(sch->bypass_depth < 0);
5915 WRITE_ONCE(sch->bypass_depth, sch->bypass_depth + 1);
5916 if (sch->bypass_depth != 1)
5917 return false;
5918
5919 WRITE_ONCE(sch->slice_dfl, READ_ONCE(scx_slice_bypass_us) * NSEC_PER_USEC);
5920 sch->bypass_timestamp = ktime_get_ns();
5921 scx_add_event(sch, SCX_EV_BYPASS_ACTIVATE, 1);
5922 return true;
5923 }
5924
dec_bypass_depth(struct scx_sched * sch)5925 static bool dec_bypass_depth(struct scx_sched *sch)
5926 {
5927 lockdep_assert_held(&scx_bypass_lock);
5928
5929 WARN_ON_ONCE(sch->bypass_depth < 1);
5930 WRITE_ONCE(sch->bypass_depth, sch->bypass_depth - 1);
5931 if (sch->bypass_depth != 0)
5932 return false;
5933
5934 WRITE_ONCE(sch->slice_dfl, SCX_SLICE_DFL);
5935 scx_add_event(sch, SCX_EV_BYPASS_DURATION,
5936 ktime_get_ns() - sch->bypass_timestamp);
5937 return true;
5938 }
5939
enable_bypass_dsp(struct scx_sched * sch)5940 static void enable_bypass_dsp(struct scx_sched *sch)
5941 {
5942 struct scx_sched *host = scx_parent(sch) ?: sch;
5943 u32 intv_us = READ_ONCE(scx_bypass_lb_intv_us);
5944 s32 ret;
5945
5946 /*
5947 * @sch->bypass_depth transitioning from 0 to 1 triggers enabling.
5948 * Shouldn't stagger.
5949 */
5950 if (WARN_ON_ONCE(test_and_set_bit(0, &sch->bypass_dsp_claim)))
5951 return;
5952
5953 /*
5954 * When a sub-sched bypasses, its tasks are queued on the bypass DSQs of
5955 * the nearest non-bypassing ancestor or root. As enable_bypass_dsp() is
5956 * called iff @sch is not already bypassed due to an ancestor bypassing,
5957 * we can assume that the parent is not bypassing and thus will be the
5958 * host of the bypass DSQs.
5959 *
5960 * While the situation may change in the future, the following
5961 * guarantees that the nearest non-bypassing ancestor or root has bypass
5962 * dispatch enabled while a descendant is bypassing, which is all that's
5963 * required.
5964 *
5965 * scx_bypass_dsp_enabled() test is used to determine whether to enter
5966 * the bypass dispatch handling path from both bypassing and hosting
5967 * scheds. Bump enable depth on both @sch and bypass dispatch host.
5968 */
5969 ret = atomic_inc_return(&sch->bypass_dsp_enable_depth);
5970 WARN_ON_ONCE(ret <= 0);
5971
5972 if (host != sch) {
5973 ret = atomic_inc_return(&host->bypass_dsp_enable_depth);
5974 WARN_ON_ONCE(ret <= 0);
5975 }
5976
5977 /*
5978 * The LB timer will stop running if bypass dispatch is disabled. Start
5979 * after enabling bypass dispatch.
5980 */
5981 if (intv_us && !timer_pending(&host->bypass_lb_timer))
5982 mod_timer(&host->bypass_lb_timer,
5983 jiffies + usecs_to_jiffies(intv_us));
5984 }
5985
5986 /* may be called without holding scx_bypass_lock */
scx_disable_bypass_dsp(struct scx_sched * sch)5987 void scx_disable_bypass_dsp(struct scx_sched *sch)
5988 {
5989 s32 ret;
5990
5991 if (!test_and_clear_bit(0, &sch->bypass_dsp_claim))
5992 return;
5993
5994 ret = atomic_dec_return(&sch->bypass_dsp_enable_depth);
5995 WARN_ON_ONCE(ret < 0);
5996
5997 if (scx_parent(sch)) {
5998 ret = atomic_dec_return(&scx_parent(sch)->bypass_dsp_enable_depth);
5999 WARN_ON_ONCE(ret < 0);
6000 }
6001 }
6002
6003 /**
6004 * unbypass_renotify_idle - Arm an idle re-notify for a sched leaving bypass
6005 * @rq: rq of the cpu leaving bypass
6006 * @pos: scheduler that just left bypass on @rq's cpu
6007 * @pcpu: @pos's per-cpu state for @rq's cpu
6008 *
6009 * A sched leaving bypass is owed the ops.update_idle() calls suppressed while
6010 * bypassing. A cpu that goes idle during the bypass window and stays idle won't
6011 * produce a notification. Arm a re-notify that scx_bypass()'s resched flushes
6012 * on the next idle pick.
6013 *
6014 * An acute case is ops.sub_attach(). If the parent grants the child cids while
6015 * attaching, when attach is complete and bypass is lifted, the child may hold
6016 * idle cids it never saw go idle.
6017 *
6018 * The root is no exception as bypass suppresses its notifications the same way.
6019 * However, the root uses a separate per-rq flag so its re-notify keeps working
6020 * even when !CONFIG_EXT_SUB_SCHED.
6021 */
unbypass_renotify_idle(struct rq * rq,struct scx_sched * pos,struct scx_sched_pcpu * pcpu)6022 static void unbypass_renotify_idle(struct rq *rq, struct scx_sched *pos,
6023 struct scx_sched_pcpu *pcpu)
6024 {
6025 if (!pos->level) {
6026 rq->scx.flags |= SCX_RQ_ROOT_IDLE_RENOTIFY;
6027 return;
6028 }
6029 #ifdef CONFIG_EXT_SUB_SCHED
6030 pcpu->idle_renotify = true;
6031 rq->scx.flags |= SCX_RQ_SUB_IDLE_RENOTIFY;
6032 #endif
6033 }
6034
6035 /**
6036 * scx_bypass - [Un]bypass scx_ops and guarantee forward progress
6037 * @sch: sched to bypass
6038 * @bypass: true for bypass, false for unbypass
6039 *
6040 * Bypassing guarantees that all runnable tasks make forward progress without
6041 * trusting the BPF scheduler. We can't grab any mutexes or rwsems as they might
6042 * be held by tasks that the BPF scheduler is forgetting to run, which
6043 * unfortunately also excludes toggling the static branches.
6044 *
6045 * Let's work around by overriding a couple ops and modifying behaviors based on
6046 * the DISABLING state and then cycling the queued tasks through dequeue/enqueue
6047 * to force global FIFO scheduling.
6048 *
6049 * - ops.select_cpu() is ignored and the default select_cpu() is used.
6050 *
6051 * - ops.enqueue() is ignored and tasks are queued in simple global FIFO order.
6052 * %SCX_OPS_ENQ_LAST is also ignored.
6053 *
6054 * - ops.dispatch() is ignored.
6055 *
6056 * - dispatch_one() does not report %SCX_DSP_PREV on non-zero slice as slice
6057 * can't be trusted. Whenever a tick triggers, the running task is rotated to
6058 * the tail of the queue.
6059 *
6060 * - pick_next_task() suppresses zero slice warning.
6061 *
6062 * - scx_kick_cpu() is disabled to avoid irq_work malfunction during PM
6063 * operations.
6064 *
6065 * - scx_prio_less() reverts to the default runnable_at order.
6066 */
scx_bypass(struct scx_sched * sch,bool bypass)6067 void scx_bypass(struct scx_sched *sch, bool bypass)
6068 {
6069 struct scx_sched *pos;
6070 unsigned long flags;
6071 int cpu;
6072
6073 raw_spin_lock_irqsave(&scx_bypass_lock, flags);
6074
6075 if (bypass) {
6076 if (!inc_bypass_depth(sch))
6077 goto unlock;
6078
6079 enable_bypass_dsp(sch);
6080 } else {
6081 if (!dec_bypass_depth(sch))
6082 goto unlock;
6083 }
6084
6085 /*
6086 * Bypass state is propagated to all descendants - an scx_sched bypasses
6087 * if itself or any of its ancestors are in bypass mode.
6088 */
6089 raw_spin_lock(&scx_sched_lock);
6090 scx_for_each_descendant_pre(pos, sch) {
6091 if (pos == sch)
6092 continue;
6093 if (bypass)
6094 inc_bypass_depth(pos);
6095 else
6096 dec_bypass_depth(pos);
6097 }
6098 raw_spin_unlock(&scx_sched_lock);
6099
6100 /*
6101 * No task property is changing. We just need to make sure all currently
6102 * queued tasks are re-queued according to the new scx_bypassing()
6103 * state. As an optimization, walk each rq's runnable_list instead of
6104 * the scx_tasks list.
6105 *
6106 * This function can't trust the scheduler and thus can't use
6107 * cpus_read_lock(). Walk all possible CPUs instead of online.
6108 */
6109 for_each_possible_cpu(cpu) {
6110 struct rq *rq = cpu_rq(cpu);
6111 struct task_struct *p, *n;
6112
6113 raw_spin_rq_lock(rq);
6114 raw_spin_lock(&scx_sched_lock);
6115
6116 scx_for_each_descendant_pre(pos, sch) {
6117 struct scx_sched_pcpu *pcpu = per_cpu_ptr(pos->pcpu, cpu);
6118 bool was_bypassing = pcpu->flags & SCX_SCHED_PCPU_BYPASSING;
6119
6120 if (pos->bypass_depth) {
6121 pcpu->flags |= SCX_SCHED_PCPU_BYPASSING;
6122 } else {
6123 pcpu->flags &= ~SCX_SCHED_PCPU_BYPASSING;
6124 if (was_bypassing) {
6125 unbypass_renotify_idle(rq, pos, pcpu);
6126 scx_unbypass_replay_ecaps(rq, pos);
6127 }
6128 }
6129 }
6130
6131 raw_spin_unlock(&scx_sched_lock);
6132
6133 /*
6134 * We need to guarantee that no tasks are on the BPF scheduler
6135 * while bypassing. Either we see enabled or the enable path
6136 * sees scx_bypassing() before moving tasks to SCX.
6137 */
6138 if (!scx_enabled()) {
6139 scx_rq_lock_drop(rq);
6140 raw_spin_rq_unlock(rq);
6141 continue;
6142 }
6143
6144 /*
6145 * The use of list_for_each_entry_safe_reverse() is required
6146 * because each task is going to be removed from and added back
6147 * to the runnable_list during iteration. Because they're added
6148 * to the tail of the list, safe reverse iteration can still
6149 * visit all nodes.
6150 */
6151 list_for_each_entry_safe_reverse(p, n, &rq->scx.runnable_list,
6152 scx.runnable_node) {
6153 if (!scx_is_descendant(scx_task_sched(p), sch))
6154 continue;
6155
6156 /*
6157 * Bypass trumps protection. Cycling clears for queued
6158 * tasks but current task needs explicit stripping.
6159 */
6160 if (bypass && task_current(rq, p))
6161 scx_task_slice_ended(rq, p);
6162
6163 /* cycling deq/enq is enough, see the function comment */
6164 scoped_guard (sched_change, p, DEQUEUE_SAVE | DEQUEUE_MOVE) {
6165 /* nothing */ ;
6166 }
6167 }
6168
6169 /* resched to restore ticks and idle state */
6170 if (cpu_online(cpu) || cpu == smp_processor_id())
6171 resched_curr(rq);
6172
6173 scx_rq_lock_drop(rq);
6174 raw_spin_rq_unlock(rq);
6175 }
6176
6177 /* disarming must come after moving all tasks out of the bypass DSQs */
6178 if (!bypass)
6179 scx_disable_bypass_dsp(sch);
6180 unlock:
6181 raw_spin_unlock_irqrestore(&scx_bypass_lock, flags);
6182 }
6183
free_exit_info(struct scx_exit_info * ei)6184 static void free_exit_info(struct scx_exit_info *ei)
6185 {
6186 kvfree(ei->dump);
6187 kfree(ei->msg);
6188 kfree(ei->bt);
6189 kfree(ei);
6190 }
6191
alloc_exit_info(size_t exit_dump_len)6192 static struct scx_exit_info *alloc_exit_info(size_t exit_dump_len)
6193 {
6194 struct scx_exit_info *ei;
6195
6196 ei = kzalloc_obj(*ei);
6197 if (!ei)
6198 return NULL;
6199
6200 ei->exit_cpu = -1;
6201 ei->bt = kzalloc_objs(ei->bt[0], SCX_EXIT_BT_LEN);
6202 ei->msg = kzalloc(SCX_EXIT_MSG_LEN, GFP_KERNEL);
6203 ei->dump = kvzalloc(exit_dump_len, GFP_KERNEL);
6204
6205 if (!ei->bt || !ei->msg || !ei->dump) {
6206 free_exit_info(ei);
6207 return NULL;
6208 }
6209
6210 return ei;
6211 }
6212
scx_exit_reason(enum scx_exit_kind kind)6213 static const char *scx_exit_reason(enum scx_exit_kind kind)
6214 {
6215 switch (kind) {
6216 case SCX_EXIT_UNREG:
6217 return "unregistered from user space";
6218 case SCX_EXIT_UNREG_BPF:
6219 return "unregistered from BPF";
6220 case SCX_EXIT_UNREG_KERN:
6221 return "unregistered from the main kernel";
6222 case SCX_EXIT_SYSRQ:
6223 return "disabled by sysrq-S";
6224 case SCX_EXIT_PARENT:
6225 return "parent exiting";
6226 case SCX_EXIT_PARENT_KILL:
6227 return "killed by parent scheduler";
6228 case SCX_EXIT_ERROR:
6229 return "runtime error";
6230 case SCX_EXIT_ERROR_BPF:
6231 return "scx_bpf_error";
6232 case SCX_EXIT_ERROR_STALL:
6233 return "runnable task stall";
6234 case SCX_EXIT_ERROR_REENQ:
6235 return "reenqueue limit";
6236 case SCX_EXIT_ERROR_RESCUE:
6237 return "rescue bandwidth overload";
6238 default:
6239 return "<UNKNOWN>";
6240 }
6241 }
6242
free_kick_syncs(void)6243 static void free_kick_syncs(void)
6244 {
6245 int cpu;
6246
6247 for_each_possible_cpu(cpu) {
6248 struct scx_kick_syncs __rcu **ksyncs = per_cpu_ptr(&scx_kick_syncs, cpu);
6249 struct scx_kick_syncs *to_free;
6250
6251 /* flush the pending kick before freeing @ksyncs */
6252 irq_work_sync(&cpu_rq(cpu)->scx.kick_cpus_irq_work);
6253 to_free = rcu_replace_pointer(*ksyncs, NULL, true);
6254 if (to_free)
6255 kvfree_rcu(to_free, rcu);
6256 }
6257 }
6258
refresh_watchdog(void)6259 static void refresh_watchdog(void)
6260 {
6261 struct scx_sched *sch;
6262 unsigned long intv = ULONG_MAX;
6263
6264 /* take the shortest timeout and use its half for watchdog interval */
6265 rcu_read_lock();
6266 list_for_each_entry_rcu(sch, &scx_sched_all, all)
6267 intv = max(min(intv, sch->watchdog_timeout / 2), 1);
6268 rcu_read_unlock();
6269
6270 WRITE_ONCE(scx_watchdog_timestamp, jiffies);
6271 WRITE_ONCE(scx_watchdog_interval, intv);
6272
6273 if (intv < ULONG_MAX)
6274 mod_delayed_work(system_dfl_wq, &scx_watchdog_work, intv);
6275 else
6276 cancel_delayed_work_sync(&scx_watchdog_work);
6277 }
6278
scx_link_sched(struct scx_sched * sch)6279 s32 scx_link_sched(struct scx_sched *sch)
6280 {
6281 scoped_guard(raw_spinlock_irqsave, &scx_bypass_lock) /* for the parent bypass check */
6282 scoped_guard(raw_spinlock, &scx_sched_lock) {
6283 #ifdef CONFIG_EXT_SUB_SCHED
6284 struct scx_sched *parent = scx_parent(sch);
6285
6286 if (parent) {
6287 s32 ret;
6288
6289 /*
6290 * Bypass state is spread across per-cpu flags and a
6291 * depth count, so inheriting it is tricky and has no
6292 * valid use case. Refuse it.
6293 */
6294 if (READ_ONCE(parent->bypass_depth)) {
6295 scx_error(sch, "parent bypassing (%d)", -EBUSY);
6296 return -EBUSY;
6297 }
6298
6299 ret = rhashtable_lookup_insert_fast(&scx_sched_hash,
6300 &sch->hash_node, scx_sched_hash_params);
6301 if (ret) {
6302 scx_error(sch, "failed to insert into scx_sched_hash (%d)",
6303 ret);
6304 return ret;
6305 }
6306
6307 list_add_tail_rcu(&sch->sibling, &parent->children);
6308
6309 /*
6310 * Pairs with the mb after the ->aborting assertion in
6311 * scx_claim_exit(). Either we see ->aborting and back
6312 * out, or the exit path sees us and exits us.
6313 */
6314 smp_mb();
6315 if (unlikely(READ_ONCE(parent->aborting))) {
6316 rhashtable_remove_fast(&scx_sched_hash, &sch->hash_node,
6317 scx_sched_hash_params);
6318 list_del_rcu(&sch->sibling);
6319 scx_error(sch, "parent disabled (%d)", -ENOENT);
6320 return -ENOENT;
6321 }
6322
6323 sch->linked = true;
6324 }
6325 #endif /* CONFIG_EXT_SUB_SCHED */
6326
6327 list_add_tail_rcu(&sch->all, &scx_sched_all);
6328 }
6329
6330 refresh_watchdog();
6331 return 0;
6332 }
6333
scx_unlink_sched(struct scx_sched * sch)6334 void scx_unlink_sched(struct scx_sched *sch)
6335 {
6336 scoped_guard(raw_spinlock_irq, &scx_sched_lock) {
6337 #ifdef CONFIG_EXT_SUB_SCHED
6338 if (sch->linked) {
6339 rhashtable_remove_fast(&scx_sched_hash, &sch->hash_node,
6340 scx_sched_hash_params);
6341 list_del_rcu(&sch->sibling);
6342 sch->linked = false;
6343 }
6344 #endif /* CONFIG_EXT_SUB_SCHED */
6345 list_del_rcu(&sch->all);
6346 }
6347
6348 refresh_watchdog();
6349 }
6350
6351 /*
6352 * Called to disable future dumps and wait for in-progress one while disabling
6353 * @sch. Once @sch becomes empty during disable, there's no point in dumping it.
6354 * This prevents calling dump ops on a dead sch.
6355 */
scx_disable_dump(struct scx_sched * sch)6356 void scx_disable_dump(struct scx_sched *sch)
6357 {
6358 guard(raw_spinlock_irqsave)(&scx_dump_lock);
6359 sch->dump_disabled = true;
6360 }
6361
scx_log_sched_disable(struct scx_sched * sch)6362 void scx_log_sched_disable(struct scx_sched *sch)
6363 {
6364 struct scx_exit_info *ei = sch->exit_info;
6365 const char *type = scx_parent(sch) ? "sub-scheduler" : "scheduler";
6366
6367 if (ei->kind >= SCX_EXIT_ERROR) {
6368 pr_err("sched_ext: BPF %s \"%s\" disabled (%s)\n", type,
6369 sch->ops.name, ei->reason);
6370
6371 if (ei->msg[0] != '\0')
6372 pr_err("sched_ext: %s: %s\n", sch->ops.name, ei->msg);
6373 #ifdef CONFIG_STACKTRACE
6374 stack_trace_print(ei->bt, ei->bt_len, 2);
6375 #endif
6376 } else {
6377 pr_info("sched_ext: BPF %s \"%s\" disabled (%s)\n", type,
6378 sch->ops.name, ei->reason);
6379 }
6380 }
6381
scx_root_disable(struct scx_sched * sch)6382 static void scx_root_disable(struct scx_sched *sch)
6383 {
6384 struct scx_task_iter sti;
6385 struct task_struct *p;
6386 bool was_switched_all;
6387 int cpu;
6388
6389 /* guarantee forward progress and wait for descendants to be disabled */
6390 scx_bypass(sch, true);
6391 drain_descendants(sch);
6392
6393 switch (scx_set_enable_state(SCX_DISABLING)) {
6394 case SCX_DISABLING:
6395 WARN_ONCE(true, "sched_ext: duplicate disabling instance?");
6396 break;
6397 case SCX_DISABLED:
6398 pr_warn("sched_ext: ops error detected without ops (%s)\n",
6399 sch->exit_info->msg);
6400 WARN_ON_ONCE(scx_set_enable_state(SCX_DISABLED) != SCX_DISABLING);
6401 goto done;
6402 default:
6403 break;
6404 }
6405
6406 /*
6407 * Here, every runnable task is guaranteed to make forward progress and
6408 * we can safely use blocking synchronization constructs. Actually
6409 * disable ops.
6410 */
6411 mutex_lock(&scx_enable_mutex);
6412
6413 was_switched_all = scx_switched_all();
6414
6415 static_branch_disable(&__scx_switched_all);
6416 WRITE_ONCE(scx_switching_all, false);
6417
6418 /*
6419 * Shut down cgroup support before tasks so that the cgroup attach and
6420 * migration paths don't race against scx_disable_and_exit_task().
6421 */
6422 scx_cgroup_lock();
6423 scx_cgroup_enabled = false;
6424 scx_cgroup_exit(sch);
6425 scx_cgroup_unlock();
6426
6427 /*
6428 * The BPF scheduler is going away. All tasks including %TASK_DEAD ones
6429 * must be switched out and exited synchronously.
6430 */
6431 percpu_down_write(&scx_fork_rwsem);
6432
6433 scx_init_task_enabled = false;
6434
6435 scx_task_iter_start(&sti, NULL);
6436 while ((p = scx_task_iter_next_locked(&sti))) {
6437 unsigned int queue_flags = DEQUEUE_SAVE | DEQUEUE_MOVE | DEQUEUE_NOCLOCK;
6438 const struct sched_class *old_class = p->sched_class;
6439 const struct sched_class *new_class = scx_setscheduler_class(p);
6440
6441 update_rq_clock(task_rq(p));
6442
6443 if (old_class != new_class)
6444 queue_flags |= DEQUEUE_CLASS;
6445
6446 scoped_guard (sched_change, p, queue_flags) {
6447 p->sched_class = new_class;
6448 }
6449
6450 scx_disable_and_exit_task(scx_task_sched(p), p);
6451 }
6452 scx_task_iter_stop(&sti);
6453
6454 scx_disable_dump(sch);
6455
6456 scx_cgroup_lock();
6457 set_cgroup_sched(sch_cgroup(sch), NULL);
6458 scx_cgroup_unlock();
6459
6460 percpu_up_write(&scx_fork_rwsem);
6461
6462 /*
6463 * Re-balance the dl_server bandwidth reservations: detach ext_server
6464 * (no more sched_ext tasks) and reinstate fair_server if it was
6465 * previously detached because we were running in full mode.
6466 *
6467 * Unlike the enable path, this runs on a recovery path that cannot
6468 * fail, so we use dl_server_swap_bw() to atomically free ext_server's
6469 * bandwidth and reclaim it for fair_server under the same dl_b lock.
6470 *
6471 * The swap can still fail with -EBUSY if someone bumped ext_server's
6472 * runtime via debugfs between enable and disable; in that narrow case
6473 * both servers end up detached and we just WARN.
6474 */
6475 for_each_possible_cpu(cpu) {
6476 struct rq *rq = cpu_rq(cpu);
6477
6478 scoped_guard(rq_lock_irqsave, rq) {
6479 update_rq_clock(rq);
6480 if (was_switched_all) {
6481 if (WARN_ON_ONCE(dl_server_swap_bw(&rq->ext_server,
6482 &rq->fair_server)))
6483 pr_warn("failed to re-attach fair_server on CPU %d\n", cpu);
6484 } else {
6485 dl_server_detach_bw(&rq->ext_server);
6486 }
6487 }
6488 }
6489
6490 /* no task is on scx, turn off all the switches and flush in-progress calls */
6491 static_branch_disable(&__scx_enabled);
6492 static_branch_disable(&__scx_is_cid_type);
6493 if (sch->ops.flags & SCX_OPS_TID_TO_TASK)
6494 static_branch_disable(&__scx_tid_to_task_enabled);
6495 bitmap_zero(sch->has_op, SCX_OPI_END);
6496 scx_idle_disable();
6497 synchronize_rcu();
6498 if (sch->ops.flags & SCX_OPS_TID_TO_TASK)
6499 rhashtable_free_and_destroy(&scx_tid_hash, NULL, NULL);
6500
6501 scx_log_sched_disable(sch);
6502
6503 if (sch->ops.exit)
6504 SCX_CALL_OP(sch, exit, NULL, sch->exit_info);
6505
6506 /*
6507 * @sch's non-ops programs such as timers and tracers can fire after
6508 * ops.exit(). Now that exit is complete, stop scx_prog_sched() from
6509 * resolving to @sch and drain in-flight resolvers.
6510 */
6511 WRITE_ONCE(sch->dead, true);
6512 synchronize_rcu();
6513
6514 scx_unlink_sched(sch);
6515
6516 /*
6517 * scx_root clearing and cid table retirement must be inside
6518 * cpus_read_lock(). See handle_hotplug().
6519 */
6520 cpus_read_lock();
6521 RCU_INIT_POINTER(scx_root, NULL);
6522 scx_cid_retire_tables();
6523 cpus_read_unlock();
6524
6525 /*
6526 * Delete the kobject from the hierarchy synchronously. Otherwise, sysfs
6527 * could observe an object of the same name still in the hierarchy when
6528 * the next scheduler is loaded.
6529 */
6530 #ifdef CONFIG_EXT_SUB_SCHED
6531 if (sch->sub_kset)
6532 kobject_del(&sch->sub_kset->kobj);
6533 #endif
6534 /* not added if enable failed before scx_sched_sysfs_add() */
6535 if (sch->kobj.state_in_sysfs)
6536 kobject_del(&sch->kobj);
6537
6538 free_kick_syncs();
6539
6540 mutex_unlock(&scx_enable_mutex);
6541
6542 WARN_ON_ONCE(scx_set_enable_state(SCX_DISABLED) != SCX_DISABLING);
6543 done:
6544 scx_bypass(sch, false);
6545 }
6546
6547 /**
6548 * scx_propagate_exit_irq_workfn - Claim SCX_EXIT_PARENT on the exiting subtree
6549 * @irq_work: &scx_sched.propagate_exit_irq_work
6550 *
6551 * Queued by scx_claim_exit() after a non-PARENT claim. Claims SCX_EXIT_PARENT
6552 * on each descendant, giving every one its own disable work - most of disabling
6553 * is serialized but ops.exit() can take arbitrarily long and running them in
6554 * separate helper kthreads parallelizes it. No recursion as only non-PARENT
6555 * claims propagate.
6556 */
scx_propagate_exit_irq_workfn(struct irq_work * irq_work)6557 static void scx_propagate_exit_irq_workfn(struct irq_work *irq_work)
6558 {
6559 struct scx_sched *sch = container_of(irq_work, struct scx_sched,
6560 propagate_exit_irq_work);
6561 struct scx_sched *pos;
6562
6563 scoped_guard (raw_spinlock_irqsave, &scx_sched_lock) {
6564 scx_for_each_descendant_pre(pos, sch)
6565 scx_disable(pos, SCX_EXIT_PARENT);
6566 }
6567 }
6568
6569 /*
6570 * Claim the exit on @sch. The caller must ensure that the helper kthread work
6571 * is kicked before the current task can be preempted. Once exit_kind is
6572 * claimed, scx_error() can no longer trigger, so if the current task gets
6573 * preempted and the BPF scheduler fails to schedule it back, the helper work
6574 * will never be kicked and the whole system can wedge.
6575 *
6576 * Lock-free and safe to call from any context including NMI.
6577 */
scx_claim_exit(struct scx_sched * sch,enum scx_exit_kind kind)6578 static bool scx_claim_exit(struct scx_sched *sch, enum scx_exit_kind kind)
6579 {
6580 int none = SCX_EXIT_NONE;
6581
6582 lockdep_assert_preemption_disabled();
6583
6584 if (WARN_ON_ONCE(kind == SCX_EXIT_NONE || kind == SCX_EXIT_DONE))
6585 kind = SCX_EXIT_ERROR;
6586
6587 if (!atomic_try_cmpxchg(&sch->exit_kind, &none, kind))
6588 return false;
6589
6590 if (kind == SCX_EXIT_PARENT) {
6591 /* an ancestor is already sweeping the subtree */
6592 WRITE_ONCE(sch->aborting, true);
6593 } else {
6594 struct scx_sched *pos;
6595
6596 /*
6597 * CPUs may be live-locked in the dispatch paths of @sch or its
6598 * descendants, which ->aborting breaks. Sweep the subtree
6599 * locklessly so that this works from NMI. smp_store_mb() orders
6600 * each node's ->aborting store before its children are walked -
6601 * either we see a racing scx_link_sched() on ->children or it
6602 * sees ->aborting.
6603 */
6604 scoped_guard (rcu) {
6605 scx_for_each_descendant_pre(pos, sch)
6606 smp_store_mb(pos->aborting, true);
6607 }
6608
6609 irq_work_queue(&sch->propagate_exit_irq_work);
6610 }
6611
6612 /* fired after ->aborting is set so callbacks can't delay recovery */
6613 trace_sched_ext_exit(sch, kind);
6614
6615 return true;
6616 }
6617
scx_disable_workfn(struct kthread_work * work)6618 static void scx_disable_workfn(struct kthread_work *work)
6619 {
6620 struct scx_sched *sch = container_of(work, struct scx_sched, disable_work);
6621 struct scx_exit_info *ei = sch->exit_info;
6622 int kind;
6623
6624 kind = atomic_read(&sch->exit_kind);
6625 while (true) {
6626 if (kind == SCX_EXIT_DONE) /* already disabled? */
6627 return;
6628 WARN_ON_ONCE(kind == SCX_EXIT_NONE);
6629 if (atomic_try_cmpxchg(&sch->exit_kind, &kind, SCX_EXIT_DONE))
6630 break;
6631 }
6632 ei->kind = kind;
6633 ei->reason = scx_exit_reason(ei->kind);
6634
6635 if (scx_parent(sch))
6636 scx_sub_disable(sch);
6637 else
6638 scx_root_disable(sch);
6639 }
6640
scx_disable(struct scx_sched * sch,enum scx_exit_kind kind)6641 static void scx_disable(struct scx_sched *sch, enum scx_exit_kind kind)
6642 {
6643 guard(preempt)();
6644 if (scx_claim_exit(sch, kind))
6645 irq_work_queue(&sch->disable_irq_work);
6646 }
6647
6648 /**
6649 * scx_flush_disable_work - flush the disable work and wait for it to finish
6650 * @sch: the scheduler
6651 *
6652 * sch->disable_work might still not queued, causing kthread_flush_work()
6653 * as a noop. Syncing the irq_work first is required to guarantee the
6654 * kthread work has been queued before waiting for it.
6655 */
scx_flush_disable_work(struct scx_sched * sch)6656 void scx_flush_disable_work(struct scx_sched *sch)
6657 {
6658 int kind;
6659
6660 do {
6661 irq_work_sync(&sch->disable_irq_work);
6662 kthread_flush_work(&sch->disable_work);
6663 kind = atomic_read(&sch->exit_kind);
6664 } while (kind != SCX_EXIT_NONE && kind != SCX_EXIT_DONE);
6665 }
6666
dump_newline(struct seq_buf * s)6667 static void dump_newline(struct seq_buf *s)
6668 {
6669 trace_sched_ext_dump("");
6670
6671 /* @s may be zero sized and seq_buf triggers WARN if so */
6672 if (s->size)
6673 seq_buf_putc(s, '\n');
6674 }
6675
scx_dump_line(struct seq_buf * s,const char * fmt,...)6676 __printf(2, 3) void scx_dump_line(struct seq_buf *s, const char *fmt, ...)
6677 {
6678 va_list args;
6679
6680 #ifdef CONFIG_TRACEPOINTS
6681 if (trace_sched_ext_dump_enabled()) {
6682 /* protected by scx_dump_lock */
6683 static char line_buf[SCX_EXIT_MSG_LEN];
6684
6685 va_start(args, fmt);
6686 vscnprintf(line_buf, sizeof(line_buf), fmt, args);
6687 va_end(args);
6688
6689 trace_call__sched_ext_dump(line_buf);
6690 }
6691 #endif
6692 /* @s may be zero sized and seq_buf triggers WARN if so */
6693 if (s->size) {
6694 va_start(args, fmt);
6695 seq_buf_vprintf(s, fmt, args);
6696 va_end(args);
6697
6698 seq_buf_putc(s, '\n');
6699 }
6700 }
6701
dump_stack_trace(struct seq_buf * s,const char * prefix,const unsigned long * bt,unsigned int len)6702 static void dump_stack_trace(struct seq_buf *s, const char *prefix,
6703 const unsigned long *bt, unsigned int len)
6704 {
6705 unsigned int i;
6706
6707 for (i = 0; i < len; i++)
6708 scx_dump_line(s, "%s%pS", prefix, (void *)bt[i]);
6709 }
6710
ops_dump_init(struct seq_buf * s,const char * prefix)6711 static void ops_dump_init(struct seq_buf *s, const char *prefix)
6712 {
6713 struct scx_dump_data *dd = &scx_dump_data;
6714
6715 lockdep_assert_irqs_disabled();
6716
6717 dd->cpu = smp_processor_id(); /* allow scx_bpf_dump() */
6718 dd->first = true;
6719 dd->cursor = 0;
6720 dd->s = s;
6721 dd->prefix = prefix;
6722 }
6723
ops_dump_flush(void)6724 static void ops_dump_flush(void)
6725 {
6726 struct scx_dump_data *dd = &scx_dump_data;
6727 char *line = dd->buf.line;
6728
6729 if (!dd->cursor)
6730 return;
6731
6732 /*
6733 * There's something to flush and this is the first line. Insert a blank
6734 * line to distinguish ops dump.
6735 */
6736 if (dd->first) {
6737 dump_newline(dd->s);
6738 dd->first = false;
6739 }
6740
6741 /*
6742 * There may be multiple lines in $line. Scan and emit each line
6743 * separately.
6744 */
6745 while (true) {
6746 char *end = line;
6747 char c;
6748
6749 while (*end != '\n' && *end != '\0')
6750 end++;
6751
6752 /*
6753 * If $line overflowed, it may not have newline at the end.
6754 * Always emit with a newline.
6755 */
6756 c = *end;
6757 *end = '\0';
6758 scx_dump_line(dd->s, "%s%s", dd->prefix, line);
6759 if (c == '\0')
6760 break;
6761
6762 /* move to the next line */
6763 end++;
6764 if (*end == '\0')
6765 break;
6766 line = end;
6767 }
6768
6769 dd->cursor = 0;
6770 }
6771
ops_dump_exit(void)6772 static void ops_dump_exit(void)
6773 {
6774 ops_dump_flush();
6775 scx_dump_data.cpu = -1;
6776 }
6777
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)6778 static void scx_dump_task(struct scx_sched *sch, struct seq_buf *s, struct scx_dump_ctx *dctx,
6779 struct rq *rq, struct task_struct *p, char marker)
6780 {
6781 static unsigned long bt[SCX_EXIT_BT_LEN];
6782 struct scx_sched *task_sch = scx_task_sched(p);
6783 const char *own_marker;
6784 char sch_id_buf[32];
6785 char dsq_id_buf[19] = "(n/a)";
6786 unsigned long ops_state = atomic_long_read(&p->scx.ops_state);
6787 unsigned int bt_len = 0;
6788
6789 own_marker = task_sch == sch ? "*" : "";
6790
6791 if (task_sch->level == 0)
6792 scnprintf(sch_id_buf, sizeof(sch_id_buf), "root");
6793 else
6794 scnprintf(sch_id_buf, sizeof(sch_id_buf), "sub%d-%llu",
6795 task_sch->level, task_sch->ops.sub_cgroup_id);
6796
6797 if (p->scx.dsq)
6798 scnprintf(dsq_id_buf, sizeof(dsq_id_buf), "0x%llx",
6799 (unsigned long long)p->scx.dsq->id);
6800
6801 dump_newline(s);
6802 scx_dump_line(s, " %c%c %s[%d] %s%s %+ldms",
6803 marker, task_state_to_char(p), p->comm, p->pid, own_marker, sch_id_buf,
6804 jiffies_delta_msecs(p->scx.runnable_at, dctx->at_jiffies));
6805 scx_dump_line(s, " scx_state/flags=%u/0x%x dsq_flags=0x%x ops_state/qseq=%lu/%lu",
6806 scx_get_task_state(p) >> SCX_TASK_STATE_SHIFT,
6807 p->scx.flags & ~SCX_TASK_STATE_MASK, p->scx.dsq_flags,
6808 ops_state & SCX_OPSS_STATE_MASK, ops_state >> SCX_OPSS_QSEQ_SHIFT);
6809 scx_dump_line(s, " sticky/holding_cpu=%d/%d dsq_id=%s",
6810 p->scx.sticky_cpu, p->scx.holding_cpu, dsq_id_buf);
6811 scx_dump_line(s, " dsq_vtime=%llu slice=%llu weight=%u",
6812 p->scx.dsq_vtime, p->scx.slice, p->scx.weight);
6813 scx_dump_line(s, " cpus=%*pb no_mig=%u", cpumask_pr_args(p->cpus_ptr),
6814 p->migration_disabled);
6815
6816 if (SCX_HAS_OP(sch, dump_task)) {
6817 ops_dump_init(s, " ");
6818 SCX_CALL_OP(sch, dump_task, rq, dctx, p);
6819 ops_dump_exit();
6820 }
6821
6822 #ifdef CONFIG_STACKTRACE
6823 bt_len = stack_trace_save_tsk(p, bt, SCX_EXIT_BT_LEN, 1);
6824 #endif
6825 if (bt_len) {
6826 dump_newline(s);
6827 dump_stack_trace(s, " ", bt, bt_len);
6828 }
6829 }
6830
scx_dump_cpu(struct scx_sched * sch,struct seq_buf * s,struct scx_dump_ctx * dctx,int cpu,bool dump_all_tasks)6831 static void scx_dump_cpu(struct scx_sched *sch, struct seq_buf *s,
6832 struct scx_dump_ctx *dctx, int cpu,
6833 bool dump_all_tasks)
6834 {
6835 struct rq *rq = cpu_rq(cpu);
6836 struct scx_sched_pcpu *pcpu = per_cpu_ptr(sch->pcpu, cpu);
6837 struct rq_flags rf;
6838 struct task_struct *p;
6839 struct seq_buf ns;
6840 size_t avail, used;
6841 char *buf;
6842 bool idle;
6843
6844 rq_lock_irqsave(rq, &rf);
6845
6846 idle = list_empty(&rq->scx.runnable_list) &&
6847 rq->curr->sched_class == &idle_sched_class;
6848
6849 if (idle && !SCX_HAS_OP(sch, dump_cpu))
6850 goto next;
6851
6852 /*
6853 * We don't yet know whether ops.dump_cpu() will produce output
6854 * and we may want to skip the default CPU dump if it doesn't.
6855 * Use a nested seq_buf to generate the standard dump so that we
6856 * can decide whether to commit later.
6857 */
6858 avail = seq_buf_get_buf(s, &buf);
6859 seq_buf_init(&ns, buf, avail);
6860
6861 dump_newline(&ns);
6862 scx_dump_line(&ns, "CPU %-4d: nr_run=%u flags=0x%x cpu_rel=%d ops_qseq=%lu ksync=%lu",
6863 cpu, rq->scx.nr_running, rq->scx.flags, rq->scx.cpu_released,
6864 rq->scx.ops_qseq, rq->scx.kick_sync);
6865 scx_rescue_dump(&ns, rq);
6866 scx_dump_line(&ns, " curr=%s[%d] class=%ps",
6867 rq->curr->comm, rq->curr->pid, rq->curr->sched_class);
6868 if (!cpumask_empty(pcpu->cpus_to_kick))
6869 scx_dump_line(&ns, " cpus_to_kick : %*pb",
6870 cpumask_pr_args(pcpu->cpus_to_kick));
6871 if (!cpumask_empty(pcpu->cpus_to_kick_if_idle))
6872 scx_dump_line(&ns, " idle_to_kick : %*pb",
6873 cpumask_pr_args(pcpu->cpus_to_kick_if_idle));
6874 if (!cpumask_empty(pcpu->cpus_to_preempt))
6875 scx_dump_line(&ns, " cpus_to_preempt: %*pb",
6876 cpumask_pr_args(pcpu->cpus_to_preempt));
6877 if (!cpumask_empty(pcpu->cpus_to_wait))
6878 scx_dump_line(&ns, " cpus_to_wait : %*pb",
6879 cpumask_pr_args(pcpu->cpus_to_wait));
6880 if (!cpumask_empty(rq->scx.cpus_to_sync))
6881 scx_dump_line(&ns, " cpus_to_sync : %*pb",
6882 cpumask_pr_args(rq->scx.cpus_to_sync));
6883
6884 used = seq_buf_used(&ns);
6885 if (SCX_HAS_OP(sch, dump_cpu)) {
6886 ops_dump_init(&ns, " ");
6887 SCX_CALL_OP(sch, dump_cpu, rq, dctx, scx_cpu_arg(cpu), idle);
6888 ops_dump_exit();
6889 }
6890
6891 /*
6892 * If idle && nothing generated by ops.dump_cpu(), there's
6893 * nothing interesting. Skip.
6894 */
6895 if (idle && used == seq_buf_used(&ns))
6896 goto next;
6897
6898 /*
6899 * $s may already have overflowed when $ns was created. If so,
6900 * calling commit on it will trigger BUG.
6901 */
6902 if (avail) {
6903 seq_buf_commit(s, seq_buf_used(&ns));
6904 if (seq_buf_has_overflowed(&ns))
6905 seq_buf_set_overflow(s);
6906 }
6907
6908 if (rq->curr->sched_class == &ext_sched_class &&
6909 (dump_all_tasks || scx_task_on_sched(sch, rq->curr)))
6910 scx_dump_task(sch, s, dctx, rq, rq->curr, '*');
6911
6912 list_for_each_entry(p, &rq->scx.runnable_list, scx.runnable_node)
6913 if (dump_all_tasks || scx_task_on_sched(sch, p))
6914 scx_dump_task(sch, s, dctx, rq, p, ' ');
6915 next:
6916 rq_unlock_irqrestore(rq, &rf);
6917 }
6918
6919 /*
6920 * Dump scheduler state. If @dump_all_tasks is true, dump all tasks regardless
6921 * of which scheduler they belong to. If false, only dump tasks owned by @sch.
6922 * For SysRq-D dumps, @dump_all_tasks=false since all schedulers are dumped
6923 * separately. For error dumps, @dump_all_tasks=true since only the failing
6924 * scheduler is dumped.
6925 */
scx_dump_state(struct scx_sched * sch,struct scx_exit_info * ei,size_t dump_len,bool dump_all_tasks)6926 static void scx_dump_state(struct scx_sched *sch, struct scx_exit_info *ei,
6927 size_t dump_len, bool dump_all_tasks)
6928 {
6929 static const char trunc_marker[] = "\n\n~~~~ TRUNCATED ~~~~\n";
6930 struct scx_dump_ctx dctx = {
6931 .kind = ei->kind,
6932 .exit_code = ei->exit_code,
6933 .reason = ei->reason,
6934 .at_ns = ktime_get_ns(),
6935 .at_jiffies = jiffies,
6936 };
6937 struct seq_buf s;
6938 struct scx_event_stats events;
6939 int cpu;
6940
6941 guard(raw_spinlock_irqsave)(&scx_dump_lock);
6942
6943 if (sch->dump_disabled)
6944 return;
6945
6946 seq_buf_init(&s, ei->dump, dump_len);
6947
6948 #ifdef CONFIG_EXT_SUB_SCHED
6949 if (sch->level == 0)
6950 scx_dump_line(&s, "%s: root", sch->ops.name);
6951 else
6952 scx_dump_line(&s, "%s: sub%d-%llu %s",
6953 sch->ops.name, sch->level, sch->ops.sub_cgroup_id,
6954 sch->cgrp_path);
6955 #endif
6956 if (ei->kind == SCX_EXIT_NONE) {
6957 scx_dump_line(&s, "Debug dump triggered by %s", ei->reason);
6958 } else {
6959 if (ei->exit_cpu >= 0)
6960 scx_dump_line(&s, "%s[%d] triggered exit kind %d on CPU %d:",
6961 current->comm, current->pid, ei->kind,
6962 ei->exit_cpu);
6963 else
6964 scx_dump_line(&s, "%s[%d] triggered exit kind %d:",
6965 current->comm, current->pid, ei->kind);
6966 scx_dump_line(&s, " %s (%s)", ei->reason, ei->msg);
6967 dump_newline(&s);
6968 scx_dump_line(&s, "Backtrace:");
6969 dump_stack_trace(&s, " ", ei->bt, ei->bt_len);
6970 }
6971
6972 if (SCX_HAS_OP(sch, dump)) {
6973 ops_dump_init(&s, "");
6974 SCX_CALL_OP(sch, dump, NULL, &dctx);
6975 ops_dump_exit();
6976 }
6977
6978 dump_newline(&s);
6979 scx_dump_line(&s, "CPU states");
6980 scx_dump_line(&s, "----------");
6981
6982 /*
6983 * Dump stalled CPUs first so they aren't lost to dump truncation, then
6984 * walk the rest in order. Fall back to exit_cpu if no stall mask set.
6985 */
6986 if (!cpumask_empty(sch->stall_cpus)) {
6987 for_each_cpu(cpu, sch->stall_cpus)
6988 scx_dump_cpu(sch, &s, &dctx, cpu, dump_all_tasks);
6989 for_each_possible_cpu(cpu) {
6990 if (!cpumask_test_cpu(cpu, sch->stall_cpus))
6991 scx_dump_cpu(sch, &s, &dctx, cpu, dump_all_tasks);
6992 }
6993 } else {
6994 if (ei->exit_cpu >= 0)
6995 scx_dump_cpu(sch, &s, &dctx, ei->exit_cpu, dump_all_tasks);
6996 for_each_possible_cpu(cpu) {
6997 if (cpu != ei->exit_cpu)
6998 scx_dump_cpu(sch, &s, &dctx, cpu, dump_all_tasks);
6999 }
7000 }
7001
7002 dump_newline(&s);
7003 scx_dump_line(&s, "Event counters");
7004 scx_dump_line(&s, "--------------");
7005
7006 scx_read_events(sch, &events);
7007 #define SCX_EVENT(name) scx_dump_event(s, &events, name)
7008 SCX_EVENTS_LIST(SCX_EVENT);
7009 #undef SCX_EVENT
7010
7011 if (seq_buf_has_overflowed(&s) && dump_len >= sizeof(trunc_marker))
7012 memcpy(ei->dump + dump_len - sizeof(trunc_marker),
7013 trunc_marker, sizeof(trunc_marker));
7014 }
7015
scx_disable_irq_workfn(struct irq_work * irq_work)7016 static void scx_disable_irq_workfn(struct irq_work *irq_work)
7017 {
7018 struct scx_sched *sch = container_of(irq_work, struct scx_sched, disable_irq_work);
7019 struct scx_exit_info *ei = sch->exit_info;
7020
7021 if (ei->kind >= SCX_EXIT_ERROR)
7022 scx_dump_state(sch, ei, sch->ops.exit_dump_len, true);
7023
7024 kthread_queue_work(sch->helper, &sch->disable_work);
7025 }
7026
7027 /* 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)7028 static void scx_finish_exit(struct scx_sched *sch, enum scx_exit_kind kind,
7029 s64 exit_code, s32 exit_cpu)
7030 {
7031 struct scx_exit_info *ei = sch->exit_info;
7032
7033 ei->exit_code = exit_code;
7034 #ifdef CONFIG_STACKTRACE
7035 /*
7036 * stack_trace_save()'s NMI-safety is arch-dependent and undocumented.
7037 * Skip the backtrace when exiting from NMI.
7038 */
7039 if (kind >= SCX_EXIT_ERROR && !in_nmi())
7040 ei->bt_len = stack_trace_save(ei->bt, SCX_EXIT_BT_LEN, 1);
7041 #endif
7042 /*
7043 * Set ei->kind and ->reason for scx_dump_state(). They'll be set again
7044 * in scx_disable_workfn().
7045 */
7046 ei->kind = kind;
7047 ei->reason = scx_exit_reason(ei->kind);
7048 ei->exit_cpu = exit_cpu;
7049
7050 irq_work_queue(&sch->disable_irq_work);
7051 }
7052
scx_vexit(struct scx_sched * sch,enum scx_exit_kind kind,s64 exit_code,s32 exit_cpu,const char * fmt,va_list args)7053 bool scx_vexit(struct scx_sched *sch,
7054 enum scx_exit_kind kind, s64 exit_code, s32 exit_cpu,
7055 const char *fmt, va_list args)
7056 {
7057 struct scx_exit_info *ei = sch->exit_info;
7058
7059 guard(preempt)();
7060
7061 if (!scx_claim_exit(sch, kind))
7062 return false;
7063
7064 vscnprintf(ei->msg, SCX_EXIT_MSG_LEN, fmt, args);
7065
7066 scx_finish_exit(sch, kind, exit_code, exit_cpu);
7067 return true;
7068 }
7069
alloc_kick_syncs(void)7070 static int alloc_kick_syncs(void)
7071 {
7072 int cpu;
7073
7074 /*
7075 * Allocate per-CPU arrays sized by nr_cpu_ids. Use kvzalloc as size
7076 * can exceed percpu allocator limits on large machines.
7077 */
7078 for_each_possible_cpu(cpu) {
7079 struct scx_kick_syncs __rcu **ksyncs = per_cpu_ptr(&scx_kick_syncs, cpu);
7080 struct scx_kick_syncs *new_ksyncs;
7081
7082 WARN_ON_ONCE(rcu_access_pointer(*ksyncs));
7083
7084 new_ksyncs = kvzalloc_node(struct_size(new_ksyncs, syncs, nr_cpu_ids),
7085 GFP_KERNEL, cpu_to_node(cpu));
7086 if (!new_ksyncs) {
7087 free_kick_syncs();
7088 return -ENOMEM;
7089 }
7090
7091 rcu_assign_pointer(*ksyncs, new_ksyncs);
7092 }
7093
7094 return 0;
7095 }
7096
free_pnode(struct scx_sched_pnode * pnode)7097 static void free_pnode(struct scx_sched_pnode *pnode)
7098 {
7099 if (!pnode)
7100 return;
7101 exit_dsq(&pnode->global_dsq);
7102 kfree(pnode);
7103 }
7104
alloc_pnode(struct scx_sched * sch,int node)7105 static struct scx_sched_pnode *alloc_pnode(struct scx_sched *sch, int node)
7106 {
7107 struct scx_sched_pnode *pnode;
7108
7109 pnode = kzalloc_node(sizeof(*pnode), GFP_KERNEL, node);
7110 if (!pnode)
7111 return NULL;
7112
7113 if (scx_init_dsq(&pnode->global_dsq, SCX_DSQ_GLOBAL, sch)) {
7114 kfree(pnode);
7115 return NULL;
7116 }
7117
7118 return pnode;
7119 }
7120
7121 /*
7122 * Allocate and initialize a new scx_sched. @cgrp's reference is always
7123 * consumed whether the function succeeds or fails.
7124 */
scx_alloc_and_add_sched(struct scx_enable_cmd * cmd,struct cgroup * cgrp,struct scx_sched * parent)7125 struct scx_sched *scx_alloc_and_add_sched(struct scx_enable_cmd *cmd,
7126 struct cgroup *cgrp,
7127 struct scx_sched *parent)
7128 {
7129 struct sched_ext_ops *ops = cmd->ops;
7130 struct scx_sched *sch;
7131 s32 level = parent ? parent->level + 1 : 0;
7132 s32 node, cpu, ret, bypass_fail_cpu = nr_cpu_ids;
7133
7134 sch = kzalloc_flex(*sch, ancestors, level + 1);
7135 if (!sch) {
7136 ret = -ENOMEM;
7137 goto err_put_cgrp;
7138 }
7139
7140 sch->exit_info = alloc_exit_info(ops->exit_dump_len);
7141 if (!sch->exit_info) {
7142 ret = -ENOMEM;
7143 goto err_free_sch;
7144 }
7145
7146 ret = rhashtable_init(&sch->dsq_hash, &dsq_hash_params);
7147 if (ret < 0)
7148 goto err_free_ei;
7149
7150 sch->pnode = kzalloc_objs(sch->pnode[0], nr_node_ids);
7151 if (!sch->pnode) {
7152 ret = -ENOMEM;
7153 goto err_free_hash;
7154 }
7155
7156 for_each_node_state(node, N_POSSIBLE) {
7157 sch->pnode[node] = alloc_pnode(sch, node);
7158 if (!sch->pnode[node]) {
7159 ret = -ENOMEM;
7160 goto err_free_pnode;
7161 }
7162 }
7163
7164 sch->dsp_max_batch = ops->dispatch_max_batch ?: SCX_DSP_DFL_MAX_BATCH;
7165 sch->pcpu = __alloc_percpu(struct_size_t(struct scx_sched_pcpu,
7166 dsp_ctx.buf, sch->dsp_max_batch),
7167 __alignof__(struct scx_sched_pcpu));
7168 if (!sch->pcpu) {
7169 ret = -ENOMEM;
7170 goto err_free_pnode;
7171 }
7172
7173 for_each_possible_cpu(cpu) {
7174 ret = scx_init_dsq(scx_bypass_dsq(sch, cpu), SCX_DSQ_BYPASS, sch);
7175 if (ret) {
7176 bypass_fail_cpu = cpu;
7177 goto err_free_pcpu;
7178 }
7179 }
7180
7181 for_each_possible_cpu(cpu) {
7182 struct scx_sched_pcpu *pcpu = per_cpu_ptr(sch->pcpu, cpu);
7183
7184 node = cpu_to_node(cpu);
7185 pcpu->sch = sch;
7186 INIT_LIST_HEAD(&pcpu->deferred_reenq_local.node);
7187 #ifdef CONFIG_EXT_SUB_SCHED
7188 init_llist_node(&pcpu->ecaps_to_sync_node);
7189 #endif
7190 INIT_LIST_HEAD(&pcpu->to_kick_node);
7191 if (!zalloc_cpumask_var_node(&pcpu->cpus_to_kick, GFP_KERNEL, node) ||
7192 !zalloc_cpumask_var_node(&pcpu->cpus_to_kick_if_idle, GFP_KERNEL, node) ||
7193 !zalloc_cpumask_var_node(&pcpu->cpus_to_preempt, GFP_KERNEL, node) ||
7194 !zalloc_cpumask_var_node(&pcpu->cpus_to_wait, GFP_KERNEL, node)) {
7195 ret = -ENOMEM;
7196 goto err_free_pcpu;
7197 }
7198 }
7199
7200 sch->helper = kthread_run_worker(0, "sched_ext_helper");
7201 if (IS_ERR(sch->helper)) {
7202 ret = PTR_ERR(sch->helper);
7203 goto err_free_pcpu;
7204 }
7205
7206 sched_set_fifo(sch->helper->task);
7207
7208 if (parent)
7209 memcpy(sch->ancestors, parent->ancestors,
7210 level * sizeof(parent->ancestors[0]));
7211 sch->ancestors[level] = sch;
7212 sch->level = level;
7213 sch->id = atomic64_inc_return(&scx_sched_id_cursor);
7214
7215 if (ops->timeout_ms)
7216 sch->watchdog_timeout = msecs_to_jiffies(ops->timeout_ms);
7217 else
7218 sch->watchdog_timeout = SCX_WATCHDOG_MAX_TIMEOUT;
7219
7220 sch->slice_dfl = SCX_SLICE_DFL;
7221 atomic_set(&sch->exit_kind, SCX_EXIT_NONE);
7222 sch->disable_irq_work = IRQ_WORK_INIT_HARD(scx_disable_irq_workfn);
7223 sch->propagate_exit_irq_work = IRQ_WORK_INIT_HARD(scx_propagate_exit_irq_workfn);
7224 kthread_init_work(&sch->disable_work, scx_disable_workfn);
7225 timer_setup(&sch->bypass_lb_timer, scx_bypass_lb_timerfn, 0);
7226
7227 if (!alloc_cpumask_var(&sch->bypass_lb_donee_cpumask, GFP_KERNEL)) {
7228 ret = -ENOMEM;
7229 goto err_stop_helper;
7230 }
7231 if (!alloc_cpumask_var(&sch->bypass_lb_resched_cpumask, GFP_KERNEL)) {
7232 ret = -ENOMEM;
7233 goto err_free_lb_cpumask;
7234 }
7235 if (!zalloc_cpumask_var(&sch->stall_cpus, GFP_KERNEL)) {
7236 ret = -ENOMEM;
7237 goto err_free_lb_resched_cpumask;
7238 }
7239 /*
7240 * Copy ops through the right union view. For cid-form the source is
7241 * struct sched_ext_ops_cid which lacks the trailing cpu_acquire/
7242 * cpu_release; those stay zero from kzalloc.
7243 */
7244 if (cmd->is_cid_type) {
7245 sch->ops_cid = *cmd->ops_cid;
7246 sch->is_cid_type = true;
7247 } else {
7248 sch->ops = *cmd->ops;
7249 }
7250
7251 #ifdef CONFIG_EXT_SUB_SCHED
7252 char *buf = kzalloc(PATH_MAX, GFP_KERNEL);
7253 if (!buf) {
7254 ret = -ENOMEM;
7255 goto err_free_lb_resched;
7256 }
7257 cgroup_path(cgrp, buf, PATH_MAX);
7258 sch->cgrp_path = kstrdup(buf, GFP_KERNEL);
7259 kfree(buf);
7260 if (!sch->cgrp_path) {
7261 ret = -ENOMEM;
7262 goto err_free_lb_resched;
7263 }
7264
7265 sch->cgrp = cgrp;
7266 INIT_LIST_HEAD(&sch->children);
7267 INIT_LIST_HEAD(&sch->sibling);
7268 #endif /* CONFIG_EXT_SUB_SCHED */
7269
7270 /*
7271 * Publishing makes @sch visible to scx_prog_sched() readers. Failure
7272 * paths after this point must free @sch through kobject_put() whose
7273 * release path defers the actual freeing by an RCU grace period.
7274 */
7275 rcu_assign_pointer(ops->priv, sch);
7276
7277 sch->kobj.kset = scx_kset;
7278 INIT_LIST_HEAD(&sch->all);
7279
7280 #ifdef CONFIG_EXT_SUB_SCHED
7281 if (parent) {
7282 /*
7283 * Pin @parent for @sch's lifetime. The kobject hierarchy pins
7284 * it only via @parent->sub_kset, which is dropped during
7285 * disable. Released in scx_sched_free_rcu_work().
7286 */
7287 kobject_get(&parent->kobj);
7288 }
7289 #endif /* CONFIG_EXT_SUB_SCHED */
7290
7291 /*
7292 * Init the kobj but don't add to sysfs yet. The enable path calls
7293 * scx_sched_sysfs_add() once @sch's sysfs-visible state is initialized.
7294 */
7295 kobject_init(&sch->kobj, &scx_ktype);
7296
7297 /*
7298 * Consume the arena_map ref bpf_scx_reg_cid() took. Defer to here so
7299 * earlier failure paths leave cmd->arena_map set and bpf_scx_reg_cid
7300 * drops the ref. After this point, sch owns the ref and any cleanup
7301 * runs through scx_sched_free_rcu_work() which puts it.
7302 */
7303 sch->arena_map = cmd->arena_map;
7304 /* BPF arena is only available on MMU && 64BIT */
7305 #if defined(CONFIG_MMU) && defined(CONFIG_64BIT)
7306 if (sch->arena_map)
7307 sch->arena_kern_base = bpf_arena_map_kern_vm_start(sch->arena_map);
7308 #endif
7309 cmd->arena_map = NULL;
7310 return sch;
7311
7312 #ifdef CONFIG_EXT_SUB_SCHED
7313 err_free_lb_resched:
7314 free_cpumask_var(sch->stall_cpus);
7315 #endif
7316 err_free_lb_resched_cpumask:
7317 free_cpumask_var(sch->bypass_lb_resched_cpumask);
7318 err_free_lb_cpumask:
7319 free_cpumask_var(sch->bypass_lb_donee_cpumask);
7320 err_stop_helper:
7321 kthread_destroy_worker(sch->helper);
7322 err_free_pcpu:
7323 for_each_possible_cpu(cpu) {
7324 struct scx_sched_pcpu *pcpu = per_cpu_ptr(sch->pcpu, cpu);
7325
7326 free_cpumask_var(pcpu->cpus_to_kick);
7327 free_cpumask_var(pcpu->cpus_to_kick_if_idle);
7328 free_cpumask_var(pcpu->cpus_to_preempt);
7329 free_cpumask_var(pcpu->cpus_to_wait);
7330 }
7331 for_each_possible_cpu(cpu) {
7332 if (cpu == bypass_fail_cpu)
7333 break;
7334 exit_dsq(scx_bypass_dsq(sch, cpu));
7335 }
7336 free_percpu(sch->pcpu);
7337 err_free_pnode:
7338 for_each_node_state(node, N_POSSIBLE)
7339 free_pnode(sch->pnode[node]);
7340 kfree(sch->pnode);
7341 err_free_hash:
7342 rhashtable_free_and_destroy(&sch->dsq_hash, NULL, NULL);
7343 err_free_ei:
7344 free_exit_info(sch->exit_info);
7345 err_free_sch:
7346 kfree(sch);
7347 err_put_cgrp:
7348 #ifdef CONFIG_EXT_SUB_SCHED
7349 cgroup_put(cgrp);
7350 #endif
7351 return ERR_PTR(ret);
7352 }
7353
7354 /*
7355 * Add @sch's kobject to sysfs, and create its sub_kset if the scheduler
7356 * implements ops.sub_attach. Called by the enable workfns once @sch's
7357 * sysfs-visible state is initialized.
7358 */
scx_sched_sysfs_add(struct scx_sched * sch)7359 int scx_sched_sysfs_add(struct scx_sched *sch)
7360 {
7361 #ifdef CONFIG_EXT_SUB_SCHED
7362 struct scx_sched *parent = scx_parent(sch);
7363 int ret;
7364
7365 if (parent)
7366 ret = kobject_add(&sch->kobj, &parent->sub_kset->kobj,
7367 "sub-%llu", cgroup_id(sch_cgroup(sch)));
7368 else
7369 ret = kobject_add(&sch->kobj, NULL, "root");
7370 if (ret < 0)
7371 return ret;
7372
7373 if (sch->ops.sub_attach) {
7374 sch->sub_kset = kset_create_and_add("sub", NULL, &sch->kobj);
7375 if (!sch->sub_kset)
7376 return -ENOMEM;
7377 }
7378 return 0;
7379 #else
7380 return kobject_add(&sch->kobj, NULL, "root");
7381 #endif
7382 }
7383
check_hotplug_seq(struct scx_sched * sch,const struct sched_ext_ops * ops)7384 static int check_hotplug_seq(struct scx_sched *sch,
7385 const struct sched_ext_ops *ops)
7386 {
7387 unsigned long long global_hotplug_seq;
7388
7389 /*
7390 * If a hotplug event has occurred between when a scheduler was
7391 * initialized, and when we were able to attach, exit and notify user
7392 * space about it.
7393 */
7394 if (ops->hotplug_seq) {
7395 global_hotplug_seq = atomic_long_read(&scx_hotplug_seq);
7396 if (ops->hotplug_seq != global_hotplug_seq) {
7397 scx_exit(sch, SCX_EXIT_UNREG_KERN,
7398 SCX_ECODE_ACT_RESTART | SCX_ECODE_RSN_HOTPLUG,
7399 "expected hotplug seq %llu did not match actual %llu",
7400 ops->hotplug_seq, global_hotplug_seq);
7401 return -EBUSY;
7402 }
7403 }
7404
7405 return 0;
7406 }
7407
scx_validate_ops(struct scx_sched * sch,const struct sched_ext_ops * ops)7408 int scx_validate_ops(struct scx_sched *sch, const struct sched_ext_ops *ops)
7409 {
7410 /*
7411 * It doesn't make sense to specify the SCX_OPS_ENQ_LAST flag if the
7412 * ops.enqueue() callback isn't implemented.
7413 */
7414 if ((ops->flags & SCX_OPS_ENQ_LAST) && !ops->enqueue) {
7415 scx_error(sch, "SCX_OPS_ENQ_LAST requires ops.enqueue() to be implemented");
7416 return -EINVAL;
7417 }
7418
7419 /*
7420 * SCX_OPS_TID_TO_TASK is enabled by the root scheduler. A sub-sched
7421 * may set it to declare a dependency; reject if the root hasn't
7422 * enabled it.
7423 */
7424 if ((ops->flags & SCX_OPS_TID_TO_TASK) && scx_parent(sch) &&
7425 !(sch->ancestors[0]->ops.flags & SCX_OPS_TID_TO_TASK)) {
7426 scx_error(sch, "SCX_OPS_TID_TO_TASK requires root scheduler to enable it");
7427 return -EINVAL;
7428 }
7429
7430 /*
7431 * SCX_OPS_BUILTIN_IDLE_PER_NODE requires built-in CPU idle
7432 * selection policy to be enabled.
7433 */
7434 if ((ops->flags & SCX_OPS_BUILTIN_IDLE_PER_NODE) &&
7435 (ops->update_idle && !(ops->flags & SCX_OPS_KEEP_BUILTIN_IDLE))) {
7436 scx_error(sch, "SCX_OPS_BUILTIN_IDLE_PER_NODE requires CPU idle selection enabled");
7437 return -EINVAL;
7438 }
7439
7440 /*
7441 * cid-form's struct is shorter and doesn't include the cpu_acquire /
7442 * cpu_release tail; reading those fields off a cid-form @ops would
7443 * run past the BPF allocation. Skip for cid-form.
7444 */
7445 if (!sch->is_cid_type && (ops->cpu_acquire || ops->cpu_release))
7446 pr_warn_ratelimited("ops->cpu_acquire/release() are deprecated, use sched_switch TP instead\n");
7447
7448 /*
7449 * Sub-scheduler support is tied to the cid-form struct_ops. A sub-sched
7450 * attaches through a cid-form-only interface (sub_attach/sub_detach),
7451 * and a root that accepts sub-scheds must expose cid-form state to
7452 * them. Reject cpu-form schedulers on either side.
7453 */
7454 if (!sch->is_cid_type) {
7455 if (scx_parent(sch)) {
7456 scx_error(sch, "sub-sched requires cid-form struct_ops");
7457 return -EINVAL;
7458 }
7459 if (ops->sub_attach || ops->sub_detach) {
7460 scx_error(sch, "sub_attach/sub_detach requires cid-form struct_ops");
7461 return -EINVAL;
7462 }
7463 }
7464
7465 return 0;
7466 }
7467
scx_root_enable_workfn(struct kthread_work * work)7468 static void scx_root_enable_workfn(struct kthread_work *work)
7469 {
7470 struct scx_enable_cmd *cmd = container_of(work, struct scx_enable_cmd, work);
7471 struct sched_ext_ops *ops = cmd->ops;
7472 struct cgroup *cgrp = root_cgroup();
7473 struct scx_sched *sch;
7474 struct scx_task_iter sti;
7475 struct task_struct *p;
7476 int i, cpu, ret;
7477
7478 mutex_lock(&scx_enable_mutex);
7479
7480 if (scx_enable_state() != SCX_DISABLED) {
7481 ret = -EBUSY;
7482 goto err_unlock;
7483 }
7484
7485 /*
7486 * @ops->priv binds @ops to its scx_sched instance. It is set here by
7487 * scx_alloc_and_add_sched() and cleared at the tail of bpf_scx_unreg(),
7488 * which runs after scx_root_disable() has dropped scx_enable_mutex. If
7489 * it's still non-NULL here, a previous attachment on @ops has not
7490 * finished tearing down; proceeding would let the in-flight unreg's
7491 * RCU_INIT_POINTER(NULL) clobber the @ops->priv we are about to assign.
7492 */
7493 if (rcu_access_pointer(ops->priv)) {
7494 ret = -EBUSY;
7495 goto err_unlock;
7496 }
7497
7498 ret = alloc_kick_syncs();
7499 if (ret)
7500 goto err_unlock;
7501
7502 if (ops->flags & SCX_OPS_TID_TO_TASK) {
7503 ret = rhashtable_init(&scx_tid_hash, &scx_tid_hash_params);
7504 if (ret)
7505 goto err_free_ksyncs;
7506 }
7507
7508 #ifdef CONFIG_EXT_SUB_SCHED
7509 cgroup_get(cgrp);
7510 #endif
7511 sch = scx_alloc_and_add_sched(cmd, cgrp, NULL);
7512 if (IS_ERR(sch)) {
7513 ret = PTR_ERR(sch);
7514 goto err_free_tid_hash;
7515 }
7516
7517 if (sch->is_cid_type)
7518 static_branch_enable(&__scx_is_cid_type);
7519
7520 /*
7521 * Transition to ENABLING and clear exit info to arm the disable path.
7522 * Failure triggers full disabling from here on.
7523 */
7524 WARN_ON_ONCE(scx_set_enable_state(SCX_ENABLING) != SCX_DISABLED);
7525 WARN_ON_ONCE(scx_root);
7526
7527 atomic_long_set(&scx_nr_rejected, 0);
7528
7529 for_each_possible_cpu(cpu) {
7530 struct rq *rq = cpu_rq(cpu);
7531
7532 rq->scx.local_dsq.sched = sch;
7533 rq->scx.cpuperf_target = SCX_CPUPERF_ONE;
7534 }
7535
7536 scx_discard_stale_ecaps_syncs();
7537 scx_rescue_set_knobs(sch);
7538
7539 /*
7540 * Keep CPUs stable during enable so that the BPF scheduler can track
7541 * online CPUs by watching ->on/offline_cpu() after ->init().
7542 */
7543 cpus_read_lock();
7544
7545 /*
7546 * Build the cid mapping into a private under-construction set. It
7547 * becomes visible to readers only through scx_cid_publish_tables() once
7548 * ops.init_cids() has finalized the layout.
7549 */
7550 ret = scx_cid_init(sch);
7551 if (ret) {
7552 cpus_read_unlock();
7553 goto err_disable;
7554 }
7555
7556 /*
7557 * Make the scheduler instance visible. Must be inside cpus_read_lock().
7558 * See handle_hotplug().
7559 */
7560 rcu_assign_pointer(scx_root, sch);
7561
7562 ret = scx_link_sched(sch);
7563 if (ret) {
7564 cpus_read_unlock();
7565 goto err_disable;
7566 }
7567
7568 scx_idle_enable(ops);
7569
7570 /*
7571 * A cid-form scheduler finalizes its cid layout in ops.init_cids(),
7572 * which may call scx_bpf_cid_override(). Run it before the caps and
7573 * shard state are built so the final layout is in effect.
7574 */
7575 if (sch->is_cid_type && sch->ops_cid.init_cids) {
7576 ret = SCX_CALL_OP_RET(sch, init_cids, NULL);
7577 if (ret) {
7578 ret = scx_ops_sanitize_err(sch, "init_cids", ret);
7579 cpus_read_unlock();
7580 scx_error(sch, "ops.init_cids() failed (%d)", ret);
7581 goto err_disable;
7582 }
7583 }
7584
7585 /* the cid layout is final, expose it to readers */
7586 scx_cid_publish_tables();
7587
7588 ret = scx_arena_pool_init(sch);
7589 if (ret) {
7590 cpus_read_unlock();
7591 goto err_disable;
7592 }
7593
7594 ret = scx_set_cmask_scratch_alloc(sch);
7595 if (ret) {
7596 cpus_read_unlock();
7597 goto err_disable;
7598 }
7599
7600 ret = scx_alloc_pshards(sch);
7601 if (ret) {
7602 cpus_read_unlock();
7603 goto err_disable;
7604 }
7605
7606 scx_init_root_caps(sch);
7607
7608 /* the cid caps and shards are live now, so ops.init() can query them */
7609 if (sch->ops.init) {
7610 ret = SCX_CALL_OP_RET(sch, init, NULL);
7611 if (ret) {
7612 ret = scx_ops_sanitize_err(sch, "init", ret);
7613 cpus_read_unlock();
7614 scx_error(sch, "ops.init() failed (%d)", ret);
7615 goto err_disable;
7616 }
7617 sch->exit_info->flags |= SCX_EFLAG_INITIALIZED;
7618 }
7619
7620 ret = scx_sched_sysfs_add(sch);
7621 if (ret) {
7622 cpus_read_unlock();
7623 goto err_disable;
7624 }
7625
7626 for (i = SCX_OPI_CPU_HOTPLUG_BEGIN; i < SCX_OPI_CPU_HOTPLUG_END; i++)
7627 if (((void (**)(void))ops)[i])
7628 set_bit(i, sch->has_op);
7629
7630 ret = check_hotplug_seq(sch, ops);
7631 if (ret) {
7632 cpus_read_unlock();
7633 goto err_disable;
7634 }
7635 scx_idle_update_selcpu_topology(ops);
7636
7637 cpus_read_unlock();
7638
7639 ret = scx_validate_ops(sch, ops);
7640 if (ret)
7641 goto err_disable;
7642
7643 /*
7644 * Attach the ext_server bandwidth reservation before anything is
7645 * committed so that we can fail the enable if the root domain cannot
7646 * accommodate it. The matching fair_server detach is deferred to the
7647 * tail of this function, after the switch is fully committed and can no
7648 * longer fail.
7649 *
7650 * On failure, err_disable funnels into scx_root_disable() which
7651 * detaches ext_server, so partially-attached state is cleaned up
7652 * automatically.
7653 */
7654 for_each_possible_cpu(cpu) {
7655 struct rq *rq = cpu_rq(cpu);
7656
7657 scoped_guard(rq_lock_irqsave, rq) {
7658 update_rq_clock(rq);
7659 ret = dl_server_attach_bw(&rq->ext_server);
7660 }
7661 if (ret) {
7662 pr_warn("sched_ext: failed to attach ext_server on CPU %d (%d)\n",
7663 cpu, ret);
7664 goto err_disable;
7665 }
7666 }
7667
7668 /*
7669 * Once __scx_enabled is set, %current can be switched to SCX anytime.
7670 * This can lead to stalls as some BPF schedulers (e.g. userspace
7671 * scheduling) may not function correctly before all tasks are switched.
7672 * Init in bypass mode to guarantee forward progress.
7673 */
7674 scx_bypass(sch, true);
7675
7676 for (i = SCX_OPI_NORMAL_BEGIN; i < SCX_OPI_NORMAL_END; i++)
7677 if (((void (**)(void))ops)[i])
7678 set_bit(i, sch->has_op);
7679
7680 if (sch->ops.cpu_acquire || sch->ops.cpu_release)
7681 sch->ops.flags |= SCX_OPS_HAS_CPU_PREEMPT;
7682
7683 /*
7684 * Lock out forks, cgroup on/offlining and moves before opening the
7685 * floodgate so that they don't wander into the operations prematurely.
7686 */
7687 percpu_down_write(&scx_fork_rwsem);
7688
7689 WARN_ON_ONCE(scx_init_task_enabled);
7690 scx_init_task_enabled = true;
7691
7692 /* flip under fork_rwsem; the iter below covers existing tasks */
7693 if (ops->flags & SCX_OPS_TID_TO_TASK)
7694 static_branch_enable(&__scx_tid_to_task_enabled);
7695
7696 /*
7697 * Enable ops for every task. Fork is excluded by scx_fork_rwsem
7698 * preventing new tasks from being added. No need to exclude tasks
7699 * leaving as sched_ext_dead() can handle both prepped and enabled
7700 * tasks. Prep all tasks first and then enable them with preemption
7701 * disabled.
7702 *
7703 * All cgroups should be initialized before scx_init_task() so that the
7704 * BPF scheduler can reliably track each task's cgroup membership from
7705 * scx_init_task(). Lock out cgroup on/offlining and task migrations
7706 * while tasks are being initialized so that scx_cgroup_can_attach()
7707 * never sees uninitialized tasks.
7708 */
7709 scx_cgroup_lock();
7710 set_cgroup_sched(sch_cgroup(sch), sch);
7711 ret = scx_cgroup_init(sch);
7712 if (ret)
7713 goto err_disable_unlock_all;
7714
7715 WARN_ON_ONCE(scx_cgroup_enabled);
7716 scx_cgroup_enabled = true;
7717
7718 scx_task_iter_start(&sti, NULL);
7719 while ((p = scx_task_iter_next_locked(&sti))) {
7720 /*
7721 * @p is in scx_tasks under scx_tasks_lock, and SCX_TASK_DEAD
7722 * tasks are filtered by scx_task_iter_next_locked().
7723 * sched_ext_dead() removes @p from scx_tasks under the same
7724 * lock before put_task_struct_rcu_user() runs, so @p->usage
7725 * is guaranteed > 0 here.
7726 */
7727 get_task_struct(p);
7728
7729 /*
7730 * Set %INIT_BEGIN under the iter's rq lock so that a concurrent
7731 * sched_ext_dead() does not call ops.exit_task() on @p while
7732 * ops.init_task() is running. If sched_ext_dead() runs before
7733 * this store, it has already removed @p from scx_tasks and the
7734 * iter won't visit @p; if it runs after, it observes
7735 * %INIT_BEGIN and transitions to %DEAD without calling ops,
7736 * leaving the post-init recheck below to unwind.
7737 */
7738 scx_set_task_state(p, SCX_TASK_INIT_BEGIN);
7739 scx_task_iter_unlock(&sti);
7740
7741 ret = __scx_init_task(sch, p, NULL, false);
7742
7743 scx_task_iter_relock(&sti, p);
7744
7745 if (unlikely(ret)) {
7746 if (scx_get_task_state(p) != SCX_TASK_DEAD)
7747 scx_set_task_state(p, SCX_TASK_NONE);
7748 scx_task_iter_stop(&sti);
7749 scx_error(sch, "ops.init_task() failed (%d) for %s[%d]",
7750 ret, p->comm, p->pid);
7751 put_task_struct(p);
7752 goto err_disable_unlock_all;
7753 }
7754
7755 if (scx_get_task_state(p) == SCX_TASK_DEAD) {
7756 /*
7757 * sched_ext_dead() observed %INIT_BEGIN and set %DEAD.
7758 * ops.exit_task() is owed to the sched __scx_init_task()
7759 * ran against; call it now.
7760 */
7761 scx_sub_init_cancel_task(sch, p);
7762 } else {
7763 scx_set_task_state(p, SCX_TASK_INIT);
7764 scx_set_task_sched(p, sch);
7765 scx_set_task_state(p, SCX_TASK_READY);
7766 }
7767
7768 /*
7769 * Insert into the tid hash. scx_tasks_lock is held by the iter;
7770 * list_empty() guards against sched_ext_dead() having taken @p
7771 * off the list while init ran unlocked.
7772 */
7773 if (scx_tid_to_task_enabled() && !list_empty(&p->scx.tasks_node))
7774 scx_tid_hash_insert(p);
7775
7776 put_task_struct(p);
7777 }
7778 scx_task_iter_stop(&sti);
7779 scx_cgroup_unlock();
7780 percpu_up_write(&scx_fork_rwsem);
7781
7782 /*
7783 * All tasks are READY. It's safe to turn on scx_enabled() and switch
7784 * all eligible tasks.
7785 */
7786 WRITE_ONCE(scx_switching_all, !(ops->flags & SCX_OPS_SWITCH_PARTIAL));
7787 static_branch_enable(&__scx_enabled);
7788
7789 /*
7790 * We're fully committed and can't fail. The task READY -> ENABLED
7791 * transitions here are synchronized against sched_ext_dead() through
7792 * scx_tasks_lock.
7793 */
7794 percpu_down_write(&scx_fork_rwsem);
7795 scx_task_iter_start(&sti, NULL);
7796 while ((p = scx_task_iter_next_locked(&sti))) {
7797 unsigned int queue_flags = DEQUEUE_SAVE | DEQUEUE_MOVE;
7798 const struct sched_class *old_class = p->sched_class;
7799 const struct sched_class *new_class = scx_setscheduler_class(p);
7800
7801 if (scx_get_task_state(p) != SCX_TASK_READY)
7802 continue;
7803
7804 if (old_class != new_class)
7805 queue_flags |= DEQUEUE_CLASS;
7806
7807 scoped_guard (sched_change, p, queue_flags) {
7808 scx_set_task_slice(p, READ_ONCE(sch->slice_dfl));
7809 p->sched_class = new_class;
7810 }
7811 }
7812 scx_task_iter_stop(&sti);
7813 percpu_up_write(&scx_fork_rwsem);
7814
7815 scx_bypass(sch, false);
7816
7817 if (!scx_tryset_enable_state(SCX_ENABLED, SCX_ENABLING)) {
7818 WARN_ON_ONCE(atomic_read(&sch->exit_kind) == SCX_EXIT_NONE);
7819 ret = -EBUSY;
7820 goto err_disable;
7821 }
7822
7823 if (!(ops->flags & SCX_OPS_SWITCH_PARTIAL))
7824 static_branch_enable(&__scx_switched_all);
7825
7826 /*
7827 * Detach the fair_server bandwidth reservation now that the switch
7828 * is fully committed. In full mode (!SCX_OPS_SWITCH_PARTIAL) no
7829 * task will ever run in the fair class, so give that bandwidth
7830 * back to the RT class. The matching ext_server attach already
7831 * happened earlier; this only releases bandwidth and cannot fail.
7832 *
7833 * In partial mode keep fair_server attached.
7834 */
7835 if (scx_switched_all()) {
7836 for_each_possible_cpu(cpu) {
7837 struct rq *rq = cpu_rq(cpu);
7838
7839 guard(rq_lock_irqsave)(rq);
7840 update_rq_clock(rq);
7841 dl_server_detach_bw(&rq->fair_server);
7842 }
7843 }
7844
7845 pr_info("sched_ext: BPF scheduler \"%s\" enabled%s\n",
7846 sch->ops.name, scx_switched_all() ? "" : " (partial)");
7847 kobject_uevent(&sch->kobj, KOBJ_ADD);
7848 mutex_unlock(&scx_enable_mutex);
7849
7850 atomic_long_inc(&scx_enable_seq);
7851
7852 cmd->ret = 0;
7853 return;
7854
7855 err_free_tid_hash:
7856 if (ops->flags & SCX_OPS_TID_TO_TASK)
7857 rhashtable_free_and_destroy(&scx_tid_hash, NULL, NULL);
7858 err_free_ksyncs:
7859 free_kick_syncs();
7860 err_unlock:
7861 mutex_unlock(&scx_enable_mutex);
7862 cmd->ret = ret;
7863 return;
7864
7865 err_disable_unlock_all:
7866 scx_cgroup_unlock();
7867 percpu_up_write(&scx_fork_rwsem);
7868 /* we'll soon enter disable path, keep bypass on */
7869 err_disable:
7870 mutex_unlock(&scx_enable_mutex);
7871 /*
7872 * Returning an error code here would not pass all the error information
7873 * to userspace. Record errno using scx_error() for cases scx_error()
7874 * wasn't already invoked and exit indicating success so that the error
7875 * is notified through ops.exit() with all the details.
7876 *
7877 * Flush scx_disable_work to ensure that error is reported before init
7878 * completion. sch's base reference will be put by bpf_scx_unreg().
7879 */
7880 scx_error(sch, "scx_root_enable() failed (%d)", ret);
7881 scx_flush_disable_work(sch);
7882 cmd->ret = 0;
7883 }
7884
scx_enable(struct scx_enable_cmd * cmd,struct bpf_link * link)7885 static s32 scx_enable(struct scx_enable_cmd *cmd, struct bpf_link *link)
7886 {
7887 static struct kthread_worker *helper;
7888 static DEFINE_MUTEX(helper_mutex);
7889
7890 if (housekeeping_enabled(HK_TYPE_DOMAIN_BOOT)) {
7891 pr_err("sched_ext: Not compatible with \"isolcpus=\" domain isolation\n");
7892 return -EINVAL;
7893 }
7894
7895 if (!READ_ONCE(helper)) {
7896 mutex_lock(&helper_mutex);
7897 if (!helper) {
7898 struct kthread_worker *w =
7899 kthread_run_worker(0, "scx_enable_helper");
7900 if (IS_ERR_OR_NULL(w)) {
7901 mutex_unlock(&helper_mutex);
7902 return -ENOMEM;
7903 }
7904 sched_set_fifo(w->task);
7905 WRITE_ONCE(helper, w);
7906 }
7907 mutex_unlock(&helper_mutex);
7908 }
7909
7910 #ifdef CONFIG_EXT_SUB_SCHED
7911 if (cmd->ops->sub_cgroup_id > 1)
7912 kthread_init_work(&cmd->work, scx_sub_enable_workfn);
7913 else
7914 #endif /* CONFIG_EXT_SUB_SCHED */
7915 kthread_init_work(&cmd->work, scx_root_enable_workfn);
7916
7917 kthread_queue_work(READ_ONCE(helper), &cmd->work);
7918 kthread_flush_work(&cmd->work);
7919 return cmd->ret;
7920 }
7921
7922
7923 /********************************************************************************
7924 * bpf_struct_ops plumbing.
7925 */
7926 #include <linux/bpf_verifier.h>
7927 #include <linux/bpf.h>
7928 #include <linux/btf.h>
7929
7930 static const struct btf_type *task_struct_type;
7931
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)7932 static bool bpf_scx_is_valid_access(int off, int size,
7933 enum bpf_access_type type,
7934 const struct bpf_prog *prog,
7935 struct bpf_insn_access_aux *info)
7936 {
7937 if (type != BPF_READ)
7938 return false;
7939 if (off < 0 || off >= sizeof(__u64) * MAX_BPF_FUNC_ARGS)
7940 return false;
7941 if (off % size != 0)
7942 return false;
7943
7944 return btf_ctx_access(off, size, type, prog, info);
7945 }
7946
7947 /* 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)7948 static int bpf_scx_btf_struct_access_common(const struct bpf_reg_state *reg,
7949 int off, int size)
7950 {
7951 const struct btf_type *t;
7952
7953 t = btf_type_by_id(reg->btf, reg->btf_id);
7954 if (t == task_struct_type &&
7955 off >= offsetof(struct task_struct, scx.disallow) &&
7956 off + size <= offsetofend(struct task_struct, scx.disallow))
7957 return SCALAR_VALUE;
7958
7959 return -EACCES;
7960 }
7961
bpf_scx_btf_struct_access(struct bpf_verifier_log * log,const struct bpf_reg_state * reg,int off,int size)7962 static int bpf_scx_btf_struct_access(struct bpf_verifier_log *log,
7963 const struct bpf_reg_state *reg, int off,
7964 int size)
7965 {
7966 const struct btf_type *t;
7967
7968 t = btf_type_by_id(reg->btf, reg->btf_id);
7969 if (t == task_struct_type) {
7970 if ((off >= offsetof(struct task_struct, scx.slice) &&
7971 off + size <= offsetofend(struct task_struct, scx.slice)) ||
7972 (off >= offsetof(struct task_struct, scx.dsq_vtime) &&
7973 off + size <= offsetofend(struct task_struct, scx.dsq_vtime)))
7974 return SCALAR_VALUE;
7975 }
7976
7977 return bpf_scx_btf_struct_access_common(reg, off, size);
7978 }
7979
7980 /* 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)7981 static int bpf_scx_cid_btf_struct_access(struct bpf_verifier_log *log,
7982 const struct bpf_reg_state *reg, int off,
7983 int size)
7984 {
7985 return bpf_scx_btf_struct_access_common(reg, off, size);
7986 }
7987
7988 static const struct bpf_verifier_ops bpf_scx_verifier_ops = {
7989 .get_func_proto = bpf_base_func_proto,
7990 .is_valid_access = bpf_scx_is_valid_access,
7991 .btf_struct_access = bpf_scx_btf_struct_access,
7992 };
7993
7994 static const struct bpf_verifier_ops bpf_scx_cid_verifier_ops = {
7995 .get_func_proto = bpf_base_func_proto,
7996 .is_valid_access = bpf_scx_is_valid_access,
7997 .btf_struct_access = bpf_scx_cid_btf_struct_access,
7998 };
7999
bpf_scx_init_member(const struct btf_type * t,const struct btf_member * member,void * kdata,const void * udata)8000 static int bpf_scx_init_member(const struct btf_type *t,
8001 const struct btf_member *member,
8002 void *kdata, const void *udata)
8003 {
8004 const struct sched_ext_ops *uops = udata;
8005 struct sched_ext_ops *ops = kdata;
8006 u32 moff = __btf_member_bit_offset(t, member) / 8;
8007 int ret;
8008
8009 switch (moff) {
8010 case offsetof(struct sched_ext_ops, dispatch_max_batch):
8011 if (*(u32 *)(udata + moff) > INT_MAX)
8012 return -E2BIG;
8013 ops->dispatch_max_batch = *(u32 *)(udata + moff);
8014 return 1;
8015 case offsetof(struct sched_ext_ops, flags):
8016 if (*(u64 *)(udata + moff) & ~SCX_OPS_ALL_FLAGS)
8017 return -EINVAL;
8018 ops->flags = *(u64 *)(udata + moff);
8019 return 1;
8020 case offsetof(struct sched_ext_ops, name):
8021 ret = bpf_obj_name_cpy(ops->name, uops->name,
8022 sizeof(ops->name));
8023 if (ret < 0)
8024 return ret;
8025 if (ret == 0)
8026 return -EINVAL;
8027 return 1;
8028 case offsetof(struct sched_ext_ops, timeout_ms):
8029 if (msecs_to_jiffies(*(u32 *)(udata + moff)) >
8030 SCX_WATCHDOG_MAX_TIMEOUT)
8031 return -E2BIG;
8032 ops->timeout_ms = *(u32 *)(udata + moff);
8033 return 1;
8034 case offsetof(struct sched_ext_ops, exit_dump_len):
8035 ops->exit_dump_len =
8036 *(u32 *)(udata + moff) ?: SCX_EXIT_DUMP_DFL_LEN;
8037 return 1;
8038 case offsetof(struct sched_ext_ops, hotplug_seq):
8039 ops->hotplug_seq = *(u64 *)(udata + moff);
8040 return 1;
8041 case offsetof(struct sched_ext_ops, cid_shard_size):
8042 ops->cid_shard_size = *(u32 *)(udata + moff);
8043 return 1;
8044 case offsetof(struct sched_ext_ops, rescue_bandwidth_ppt): {
8045 u32 bw_ppt = *(u32 *)(udata + moff);
8046
8047 if (bw_ppt > SCX_RESCUE_MAX_BW_PPT && bw_ppt != SCX_RESCUE_DISABLE)
8048 return -E2BIG;
8049 ops->rescue_bandwidth_ppt = bw_ppt;
8050 return 1;
8051 }
8052 case offsetof(struct sched_ext_ops, rescue_quantum_us): {
8053 u32 quantum_us = *(u32 *)(udata + moff);
8054
8055 if (quantum_us > SCX_RESCUE_MAX_QUANTUM_US)
8056 return -E2BIG;
8057 if (quantum_us && quantum_us < SCX_RESCUE_MIN_QUANTUM_US)
8058 return -EINVAL;
8059 ops->rescue_quantum_us = quantum_us;
8060 return 1;
8061 }
8062 #ifdef CONFIG_EXT_SUB_SCHED
8063 case offsetof(struct sched_ext_ops, sub_cgroup_id):
8064 ops->sub_cgroup_id = *(u64 *)(udata + moff);
8065 return 1;
8066 #endif /* CONFIG_EXT_SUB_SCHED */
8067 }
8068
8069 return 0;
8070 }
8071
bpf_scx_check_member(const struct btf_type * t,const struct btf_member * member,const struct bpf_prog * prog)8072 static int bpf_scx_check_member(const struct btf_type *t,
8073 const struct btf_member *member,
8074 const struct bpf_prog *prog)
8075 {
8076 u32 moff = __btf_member_bit_offset(t, member) / 8;
8077
8078 switch (moff) {
8079 case offsetof(struct sched_ext_ops, init_task):
8080 #ifdef CONFIG_EXT_GROUP_SCHED
8081 case offsetof(struct sched_ext_ops, cgroup_init):
8082 case offsetof(struct sched_ext_ops, cgroup_exit):
8083 case offsetof(struct sched_ext_ops, cgroup_prep_move):
8084 case offsetof(struct sched_ext_ops, cgroup_set_bandwidth):
8085 #endif
8086 case offsetof(struct sched_ext_ops, cpu_online):
8087 case offsetof(struct sched_ext_ops, cpu_offline):
8088 case offsetof(struct sched_ext_ops, init_cids):
8089 case offsetof(struct sched_ext_ops, init):
8090 case offsetof(struct sched_ext_ops, exit):
8091 case offsetof(struct sched_ext_ops, sub_attach):
8092 case offsetof(struct sched_ext_ops, sub_detach):
8093 break;
8094 default:
8095 if (prog->sleepable)
8096 return -EINVAL;
8097 }
8098
8099 #ifdef CONFIG_EXT_SUB_SCHED
8100 /*
8101 * Enable private stack for operations that can nest along the
8102 * hierarchy.
8103 *
8104 * XXX - Ideally, we should only do this for scheds that allow
8105 * sub-scheds and sub-scheds themselves but I don't know how to access
8106 * struct_ops from here.
8107 */
8108 switch (moff) {
8109 case offsetof(struct sched_ext_ops, dispatch):
8110 prog->aux->priv_stack_requested = true;
8111 prog->aux->recursion_detected = scx_pstack_recursion_on_dispatch;
8112 break;
8113 case offsetof(struct sched_ext_ops, sub_caps_updated):
8114 prog->aux->priv_stack_requested = true;
8115 prog->aux->recursion_detected = scx_pstack_recursion_on_caps_updated;
8116 break;
8117 }
8118 #endif /* CONFIG_EXT_SUB_SCHED */
8119
8120 return 0;
8121 }
8122
bpf_scx_reg(void * kdata,struct bpf_link * link)8123 static int bpf_scx_reg(void *kdata, struct bpf_link *link)
8124 {
8125 struct scx_enable_cmd cmd = { .ops = kdata };
8126
8127 return scx_enable(&cmd, link);
8128 }
8129
8130 struct scx_arena_scan {
8131 struct bpf_map *arena;
8132 int err;
8133 };
8134
8135 /*
8136 * The verifier enforces one arena per BPF program, so each struct_ops
8137 * member prog contributes at most one arena via bpf_prog_arena().
8138 * Require all non-NULL contributions to match.
8139 */
scx_arena_scan_prog(struct bpf_prog * prog,void * data)8140 static int scx_arena_scan_prog(struct bpf_prog *prog, void *data)
8141 {
8142 struct scx_arena_scan *s = data;
8143 struct bpf_map *arena = NULL;
8144
8145 /* arena.o, which defines these, is built only on MMU && 64BIT */
8146 #if defined(CONFIG_MMU) && defined(CONFIG_64BIT)
8147 arena = bpf_prog_arena(prog);
8148 #endif
8149 if (!arena)
8150 return 0;
8151 if (s->arena && s->arena != arena) {
8152 s->err = -EINVAL;
8153 return 1;
8154 }
8155 s->arena = arena;
8156 return 0;
8157 }
8158
bpf_scx_reg_cid(void * kdata,struct bpf_link * link)8159 static int bpf_scx_reg_cid(void *kdata, struct bpf_link *link)
8160 {
8161 struct scx_enable_cmd cmd = { .ops_cid = kdata, .is_cid_type = true };
8162 struct scx_arena_scan scan = {};
8163 int ret;
8164
8165 bpf_struct_ops_for_each_prog(kdata, scx_arena_scan_prog, &scan);
8166 if (scan.err) {
8167 pr_err("sched_ext: cid-form scheduler uses multiple arena maps\n");
8168 return scan.err;
8169 }
8170 if (!scan.arena) {
8171 pr_err("sched_ext: cid-form scheduler must use a BPF arena map\n");
8172 return -EINVAL;
8173 }
8174
8175 bpf_map_inc(scan.arena);
8176 cmd.arena_map = scan.arena;
8177 ret = scx_enable(&cmd, link);
8178 if (cmd.arena_map) /* not consumed by scx_alloc_and_add_sched() */
8179 bpf_map_put(cmd.arena_map);
8180 return ret;
8181 }
8182
bpf_scx_unreg(void * kdata,struct bpf_link * link)8183 static void bpf_scx_unreg(void *kdata, struct bpf_link *link)
8184 {
8185 struct sched_ext_ops *ops = kdata;
8186 struct scx_sched *sch = rcu_dereference_protected(ops->priv, true);
8187
8188 scx_disable(sch, SCX_EXIT_UNREG);
8189 scx_flush_disable_work(sch);
8190 RCU_INIT_POINTER(ops->priv, NULL);
8191 kobject_put(&sch->kobj);
8192 }
8193
bpf_scx_init(struct btf * btf)8194 static int bpf_scx_init(struct btf *btf)
8195 {
8196 task_struct_type = btf_type_by_id(btf, btf_tracing_ids[BTF_TRACING_TYPE_TASK]);
8197
8198 return 0;
8199 }
8200
bpf_scx_update(void * kdata,void * old_kdata,struct bpf_link * link)8201 static int bpf_scx_update(void *kdata, void *old_kdata, struct bpf_link *link)
8202 {
8203 /*
8204 * sched_ext does not support updating the actively-loaded BPF
8205 * scheduler, as registering a BPF scheduler can always fail if the
8206 * scheduler returns an error code for e.g. ops.init(), ops.init_task(),
8207 * etc. Similarly, we can always race with unregistration happening
8208 * elsewhere, such as with sysrq.
8209 */
8210 return -EOPNOTSUPP;
8211 }
8212
bpf_scx_validate(void * kdata)8213 static int bpf_scx_validate(void *kdata)
8214 {
8215 return 0;
8216 }
8217
sched_ext_ops__select_cpu(struct task_struct * p,s32 prev_cpu,u64 wake_flags)8218 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)8219 static void sched_ext_ops__enqueue(struct task_struct *p, u64 enq_flags) {}
sched_ext_ops__dequeue(struct task_struct * p,u64 enq_flags)8220 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)8221 static void sched_ext_ops__dispatch(s32 prev_cpu, struct task_struct *prev__nullable) {}
sched_ext_ops__tick(struct task_struct * p)8222 static void sched_ext_ops__tick(struct task_struct *p) {}
sched_ext_ops__runnable(struct task_struct * p,u64 enq_flags)8223 static void sched_ext_ops__runnable(struct task_struct *p, u64 enq_flags) {}
sched_ext_ops__running(struct task_struct * p)8224 static void sched_ext_ops__running(struct task_struct *p) {}
sched_ext_ops__stopping(struct task_struct * p,bool runnable)8225 static void sched_ext_ops__stopping(struct task_struct *p, bool runnable) {}
sched_ext_ops__quiescent(struct task_struct * p,u64 deq_flags)8226 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)8227 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)8228 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)8229 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)8230 static void sched_ext_ops__set_cpumask(struct task_struct *p, const struct cpumask *mask) {}
sched_ext_ops__update_idle(s32 cpu,bool idle)8231 static void sched_ext_ops__update_idle(s32 cpu, bool idle) {}
sched_ext_ops__cpu_acquire(s32 cpu,struct scx_cpu_acquire_args * args)8232 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)8233 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)8234 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)8235 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)8236 static void sched_ext_ops__enable(struct task_struct *p) {}
sched_ext_ops__disable(struct task_struct * p)8237 static void sched_ext_ops__disable(struct task_struct *p) {}
8238 #ifdef CONFIG_EXT_GROUP_SCHED
sched_ext_ops__cgroup_init(struct cgroup * cgrp,struct scx_cgroup_init_args * args)8239 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)8240 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)8241 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)8242 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)8243 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)8244 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)8245 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)8246 static void sched_ext_ops__cgroup_set_idle(struct cgroup *cgrp, bool idle) {}
8247 #endif /* CONFIG_EXT_GROUP_SCHED */
sched_ext_ops__sub_attach(struct scx_sub_attach_args * args)8248 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)8249 static void sched_ext_ops__sub_detach(struct scx_sub_detach_args *args) {}
sched_ext_ops__cpu_online(s32 cpu)8250 static void sched_ext_ops__cpu_online(s32 cpu) {}
sched_ext_ops__cpu_offline(s32 cpu)8251 static void sched_ext_ops__cpu_offline(s32 cpu) {}
sched_ext_ops__init_cids(void)8252 static s32 sched_ext_ops__init_cids(void) { return -EINVAL; }
sched_ext_ops__init(void)8253 static s32 sched_ext_ops__init(void) { return -EINVAL; }
sched_ext_ops__exit(struct scx_exit_info * info)8254 static void sched_ext_ops__exit(struct scx_exit_info *info) {}
sched_ext_ops__dump(struct scx_dump_ctx * ctx)8255 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)8256 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)8257 static void sched_ext_ops__dump_task(struct scx_dump_ctx *ctx, struct task_struct *p) {}
8258
8259 static struct sched_ext_ops __bpf_ops_sched_ext_ops = {
8260 .select_cpu = sched_ext_ops__select_cpu,
8261 .enqueue = sched_ext_ops__enqueue,
8262 .dequeue = sched_ext_ops__dequeue,
8263 .dispatch = sched_ext_ops__dispatch,
8264 .tick = sched_ext_ops__tick,
8265 .runnable = sched_ext_ops__runnable,
8266 .running = sched_ext_ops__running,
8267 .stopping = sched_ext_ops__stopping,
8268 .quiescent = sched_ext_ops__quiescent,
8269 .yield = sched_ext_ops__yield,
8270 .core_sched_before = sched_ext_ops__core_sched_before,
8271 .set_weight = sched_ext_ops__set_weight,
8272 .set_cpumask = sched_ext_ops__set_cpumask,
8273 .update_idle = sched_ext_ops__update_idle,
8274 .cpu_acquire = sched_ext_ops__cpu_acquire,
8275 .cpu_release = sched_ext_ops__cpu_release,
8276 .init_task = sched_ext_ops__init_task,
8277 .exit_task = sched_ext_ops__exit_task,
8278 .enable = sched_ext_ops__enable,
8279 .disable = sched_ext_ops__disable,
8280 #ifdef CONFIG_EXT_GROUP_SCHED
8281 .cgroup_init = sched_ext_ops__cgroup_init,
8282 .cgroup_exit = sched_ext_ops__cgroup_exit,
8283 .cgroup_prep_move = sched_ext_ops__cgroup_prep_move,
8284 .cgroup_move = sched_ext_ops__cgroup_move,
8285 .cgroup_cancel_move = sched_ext_ops__cgroup_cancel_move,
8286 .cgroup_set_weight = sched_ext_ops__cgroup_set_weight,
8287 .cgroup_set_bandwidth = sched_ext_ops__cgroup_set_bandwidth,
8288 .cgroup_set_idle = sched_ext_ops__cgroup_set_idle,
8289 #endif
8290 .sub_attach = sched_ext_ops__sub_attach,
8291 .sub_detach = sched_ext_ops__sub_detach,
8292 .cpu_online = sched_ext_ops__cpu_online,
8293 .cpu_offline = sched_ext_ops__cpu_offline,
8294 .init_cids = sched_ext_ops__init_cids,
8295 .init = sched_ext_ops__init,
8296 .exit = sched_ext_ops__exit,
8297 .dump = sched_ext_ops__dump,
8298 .dump_cpu = sched_ext_ops__dump_cpu,
8299 .dump_task = sched_ext_ops__dump_task,
8300 };
8301
8302 static struct bpf_struct_ops bpf_sched_ext_ops = {
8303 .verifier_ops = &bpf_scx_verifier_ops,
8304 .reg = bpf_scx_reg,
8305 .unreg = bpf_scx_unreg,
8306 .check_member = bpf_scx_check_member,
8307 .init_member = bpf_scx_init_member,
8308 .init = bpf_scx_init,
8309 .update = bpf_scx_update,
8310 .validate = bpf_scx_validate,
8311 .name = "sched_ext_ops",
8312 .owner = THIS_MODULE,
8313 .cfi_stubs = &__bpf_ops_sched_ext_ops
8314 };
8315
8316 /*
8317 * cid-form cfi stubs. Stubs whose signatures match the cpu-form (param types
8318 * identical, only param names differ across structs) are reused. Some need
8319 * fresh stubs, set_cmask due to an argument type difference and the sub-sched
8320 * notifiers because no cpu-form stub exists to reuse.
8321 */
sched_ext_ops_cid__set_cmask(struct task_struct * p,const struct scx_cmask * cmask__arena)8322 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)8323 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)8324 static void sched_ext_ops__sub_ecaps_updated(s32 cid, u64 before, u64 after) {}
8325
8326 static struct sched_ext_ops_cid __bpf_ops_sched_ext_ops_cid = {
8327 .select_cid = sched_ext_ops__select_cpu,
8328 .enqueue = sched_ext_ops__enqueue,
8329 .dequeue = sched_ext_ops__dequeue,
8330 .dispatch = sched_ext_ops__dispatch,
8331 .tick = sched_ext_ops__tick,
8332 .runnable = sched_ext_ops__runnable,
8333 .running = sched_ext_ops__running,
8334 .stopping = sched_ext_ops__stopping,
8335 .quiescent = sched_ext_ops__quiescent,
8336 .yield = sched_ext_ops__yield,
8337 .core_sched_before = sched_ext_ops__core_sched_before,
8338 .set_weight = sched_ext_ops__set_weight,
8339 .set_cmask = sched_ext_ops_cid__set_cmask,
8340 .update_idle = sched_ext_ops__update_idle,
8341 .init_task = sched_ext_ops__init_task,
8342 .exit_task = sched_ext_ops__exit_task,
8343 .enable = sched_ext_ops__enable,
8344 .disable = sched_ext_ops__disable,
8345 #ifdef CONFIG_EXT_GROUP_SCHED
8346 .cpuctl_init = sched_ext_ops__cgroup_init,
8347 .cpuctl_exit = sched_ext_ops__cgroup_exit,
8348 .cpuctl_prep_move = sched_ext_ops__cgroup_prep_move,
8349 .cpuctl_move = sched_ext_ops__cgroup_move,
8350 .cpuctl_cancel_move = sched_ext_ops__cgroup_cancel_move,
8351 .cpuctl_set_weight = sched_ext_ops__cgroup_set_weight,
8352 .cpuctl_set_bandwidth = sched_ext_ops__cgroup_set_bandwidth,
8353 .cpuctl_set_idle = sched_ext_ops__cgroup_set_idle,
8354 #endif
8355 .sub_attach = sched_ext_ops__sub_attach,
8356 .sub_detach = sched_ext_ops__sub_detach,
8357 .sub_caps_updated = sched_ext_ops__sub_caps_updated,
8358 .sub_ecaps_updated = sched_ext_ops__sub_ecaps_updated,
8359 .cid_online = sched_ext_ops__cpu_online,
8360 .cid_offline = sched_ext_ops__cpu_offline,
8361 .init_cids = sched_ext_ops__init_cids,
8362 .init = sched_ext_ops__init,
8363 .exit = sched_ext_ops__exit,
8364 .dump = sched_ext_ops__dump,
8365 .dump_cid = sched_ext_ops__dump_cpu,
8366 .dump_task = sched_ext_ops__dump_task,
8367 };
8368
8369 /*
8370 * The cid-form struct_ops shares all bpf_struct_ops hooks with the cpu form.
8371 * init_member, check_member, reg, unreg, etc. process kdata as the byte block
8372 * verified to match by the BUILD_BUG_ON checks in scx_init().
8373 */
8374 static struct bpf_struct_ops bpf_sched_ext_ops_cid = {
8375 .verifier_ops = &bpf_scx_cid_verifier_ops,
8376 .reg = bpf_scx_reg_cid,
8377 .unreg = bpf_scx_unreg,
8378 .check_member = bpf_scx_check_member,
8379 .init_member = bpf_scx_init_member,
8380 .init = bpf_scx_init,
8381 .update = bpf_scx_update,
8382 .validate = bpf_scx_validate,
8383 .name = "sched_ext_ops_cid",
8384 .owner = THIS_MODULE,
8385 .cfi_stubs = &__bpf_ops_sched_ext_ops_cid
8386 };
8387
8388
8389 /********************************************************************************
8390 * System integration and init.
8391 */
8392
sysrq_handle_sched_ext_reset(u8 key)8393 static void sysrq_handle_sched_ext_reset(u8 key)
8394 {
8395 struct scx_sched *sch;
8396
8397 sch = rcu_dereference(scx_root);
8398 if (likely(sch))
8399 scx_disable(sch, SCX_EXIT_SYSRQ);
8400 else
8401 pr_info("sched_ext: BPF schedulers not loaded\n");
8402 }
8403
8404 static const struct sysrq_key_op sysrq_sched_ext_reset_op = {
8405 .handler = sysrq_handle_sched_ext_reset,
8406 .help_msg = "reset-sched-ext(S)",
8407 .action_msg = "Disable sched_ext and revert all tasks to CFS",
8408 .enable_mask = SYSRQ_ENABLE_RTNICE,
8409 };
8410
sysrq_handle_sched_ext_dump(u8 key)8411 static void sysrq_handle_sched_ext_dump(u8 key)
8412 {
8413 struct scx_exit_info ei = {
8414 .kind = SCX_EXIT_NONE,
8415 .exit_cpu = -1,
8416 .reason = "SysRq-D",
8417 };
8418 struct scx_sched *sch;
8419
8420 list_for_each_entry_rcu(sch, &scx_sched_all, all)
8421 scx_dump_state(sch, &ei, 0, false);
8422 }
8423
8424 static const struct sysrq_key_op sysrq_sched_ext_dump_op = {
8425 .handler = sysrq_handle_sched_ext_dump,
8426 .help_msg = "dump-sched-ext(D)",
8427 .action_msg = "Trigger sched_ext debug dump",
8428 .enable_mask = SYSRQ_ENABLE_RTNICE,
8429 };
8430
can_skip_idle_kick(struct rq * rq)8431 static bool can_skip_idle_kick(struct rq *rq)
8432 {
8433 lockdep_assert_rq_held(rq);
8434
8435 /*
8436 * We can skip idle kicking if @rq is going to go through at least one
8437 * full SCX scheduling cycle before going idle. Just checking whether
8438 * curr is not idle is insufficient because we could be racing
8439 * dispatch_one() trying to pull the next task from a remote rq, which
8440 * may fail, and @rq may become idle afterwards.
8441 *
8442 * The race window is small and we don't and can't guarantee that @rq is
8443 * only kicked while idle anyway. Skip only when sure.
8444 */
8445 return !is_idle_task(rq->curr) && !(rq->scx.flags & SCX_RQ_IN_DISPATCH);
8446 }
8447
kick_one_cpu(s32 cpu,struct scx_sched_pcpu * pcpu,struct rq * this_rq,unsigned long * ksyncs)8448 static bool kick_one_cpu(s32 cpu, struct scx_sched_pcpu *pcpu, struct rq *this_rq,
8449 unsigned long *ksyncs)
8450 {
8451 struct rq *rq = cpu_rq(cpu);
8452 struct scx_rq *this_scx = &this_rq->scx;
8453 const struct sched_class *cur_class;
8454 bool should_wait = false;
8455 bool kickable;
8456 unsigned long flags;
8457
8458 raw_spin_rq_lock_irqsave(rq, flags);
8459 cur_class = rq->curr->sched_class;
8460
8461 /*
8462 * During CPU hotplug, a CPU may depend on kicking itself to make
8463 * forward progress. Allow kicking self regardless of online state. If
8464 * @cpu is running a higher class task, we have no control over @cpu.
8465 * Skip kicking. A sub-sched lacking baseline access on @cid has no
8466 * business forcing a reschedule there - skip. This is the authoritative
8467 * cap check: ecaps is read here under @rq's lock.
8468 */
8469 kickable = (cpu_online(cpu) || cpu == cpu_of(this_rq)) &&
8470 !sched_class_above(cur_class, &ext_sched_class);
8471
8472 if (kickable && !scx_missing_caps(pcpu->sch, cpu, SCX_CAP_BASE)) {
8473 if (cpumask_test_cpu(cpu, pcpu->cpus_to_preempt)) {
8474 if (cur_class == &ext_sched_class) {
8475 u64 caps = scx_caps_for_preempt(pcpu->sch, rq, 0);
8476
8477 if (unlikely(scx_missing_caps(pcpu->sch, cpu, caps)))
8478 __scx_add_event(pcpu->sch, SCX_EV_SUB_PREEMPT_DENIED, 1);
8479 else if (unlikely(!scx_set_task_slice(rq->curr, 0)))
8480 __scx_add_event(pcpu->sch, SCX_EV_SLICE_DENIED, 1);
8481 }
8482 cpumask_clear_cpu(cpu, pcpu->cpus_to_preempt);
8483 }
8484
8485 if (cpumask_test_cpu(cpu, pcpu->cpus_to_wait)) {
8486 if (cur_class == &ext_sched_class) {
8487 cpumask_set_cpu(cpu, this_scx->cpus_to_sync);
8488 ksyncs[cpu] = rq->scx.kick_sync;
8489 should_wait = true;
8490 }
8491 cpumask_clear_cpu(cpu, pcpu->cpus_to_wait);
8492 }
8493
8494 resched_curr(rq);
8495 } else {
8496 /* a kickable cpu was skipped solely for the missing caps */
8497 if (kickable)
8498 __scx_add_event(pcpu->sch, SCX_EV_SUB_KICK_DENIED, 1);
8499 cpumask_clear_cpu(cpu, pcpu->cpus_to_preempt);
8500 cpumask_clear_cpu(cpu, pcpu->cpus_to_wait);
8501 }
8502
8503 scx_rq_lock_drop(rq);
8504 raw_spin_rq_unlock_irqrestore(rq, flags);
8505
8506 return should_wait;
8507 }
8508
kick_one_cpu_if_idle(s32 cpu,struct scx_sched_pcpu * pcpu,struct rq * this_rq)8509 static void kick_one_cpu_if_idle(s32 cpu, struct scx_sched_pcpu *pcpu,
8510 struct rq *this_rq)
8511 {
8512 struct rq *rq = cpu_rq(cpu);
8513 unsigned long flags;
8514
8515 raw_spin_rq_lock_irqsave(rq, flags);
8516
8517 /* idle kicks need baseline access too, see kick_one_cpu() */
8518 if (!can_skip_idle_kick(rq) &&
8519 (cpu_online(cpu) || cpu == cpu_of(this_rq))) {
8520 if (likely(!scx_missing_caps(pcpu->sch, cpu, SCX_CAP_BASE)))
8521 resched_curr(rq);
8522 else
8523 __scx_add_event(pcpu->sch, SCX_EV_SUB_KICK_DENIED, 1);
8524 }
8525
8526 scx_rq_lock_drop(rq);
8527 raw_spin_rq_unlock_irqrestore(rq, flags);
8528 }
8529
kick_cpus_irq_workfn(struct irq_work * irq_work)8530 static void kick_cpus_irq_workfn(struct irq_work *irq_work)
8531 {
8532 struct rq *this_rq = this_rq();
8533 struct scx_rq *this_scx = &this_rq->scx;
8534 struct scx_kick_syncs __rcu *ksyncs_pcpu = __this_cpu_read(scx_kick_syncs);
8535 struct scx_sched_pcpu *pcpu, *tmp;
8536 bool should_wait = false;
8537 unsigned long *ksyncs;
8538 s32 cpu;
8539
8540 /* can race with free_kick_syncs() during scheduler disable */
8541 if (unlikely(!ksyncs_pcpu))
8542 return;
8543
8544 ksyncs = rcu_dereference_bh(ksyncs_pcpu)->syncs;
8545
8546 /*
8547 * Walk scheds with pending kicks on this cpu. scx_kick_cpu() adds to
8548 * the list under local_irq_save() and only this irq_work consumes it.
8549 * A plain list without locking is sufficient.
8550 */
8551 list_for_each_entry_safe(pcpu, tmp, &this_scx->sched_pcpus_to_kick, to_kick_node) {
8552 list_del_init(&pcpu->to_kick_node);
8553
8554 for_each_cpu(cpu, pcpu->cpus_to_kick) {
8555 should_wait |= kick_one_cpu(cpu, pcpu, this_rq, ksyncs);
8556 cpumask_clear_cpu(cpu, pcpu->cpus_to_kick);
8557 cpumask_clear_cpu(cpu, pcpu->cpus_to_kick_if_idle);
8558 }
8559
8560 for_each_cpu(cpu, pcpu->cpus_to_kick_if_idle) {
8561 kick_one_cpu_if_idle(cpu, pcpu, this_rq);
8562 cpumask_clear_cpu(cpu, pcpu->cpus_to_kick_if_idle);
8563 }
8564 }
8565
8566 /*
8567 * Can't wait in hardirq — kick_sync can't advance, deadlocking if
8568 * CPUs wait for each other. Defer to kick_sync_wait_bal_cb().
8569 */
8570 if (should_wait) {
8571 raw_spin_rq_lock(this_rq);
8572 this_scx->kick_sync_pending = true;
8573 resched_curr(this_rq);
8574 scx_rq_lock_drop(this_rq);
8575 raw_spin_rq_unlock(this_rq);
8576 }
8577 }
8578
8579 /**
8580 * print_scx_info - print out sched_ext scheduler state
8581 * @log_lvl: the log level to use when printing
8582 * @p: target task
8583 *
8584 * If a sched_ext scheduler is enabled, print the name and state of the
8585 * scheduler. If @p is on sched_ext, print further information about the task.
8586 *
8587 * This function can be safely called on any task as long as the task_struct
8588 * itself is accessible. While safe, this function isn't synchronized and may
8589 * print out mixups or garbages of limited length.
8590 */
print_scx_info(const char * log_lvl,struct task_struct * p)8591 void print_scx_info(const char *log_lvl, struct task_struct *p)
8592 {
8593 struct scx_sched *sch;
8594 enum scx_enable_state state = scx_enable_state();
8595 const char *all = READ_ONCE(scx_switching_all) ? "+all" : "";
8596 char runnable_at_buf[22] = "?";
8597 struct sched_class *class;
8598 unsigned long runnable_at;
8599
8600 guard(rcu)();
8601
8602 sch = scx_task_sched_rcu(p);
8603
8604 if (!sch)
8605 return;
8606
8607 /*
8608 * Carefully check if the task was running on sched_ext, and then
8609 * carefully copy the time it's been runnable, and its state.
8610 */
8611 if (copy_from_kernel_nofault(&class, &p->sched_class, sizeof(class)) ||
8612 class != &ext_sched_class) {
8613 printk("%sSched_ext: %s (%s%s)", log_lvl, sch->ops.name,
8614 scx_enable_state_str[state], all);
8615 return;
8616 }
8617
8618 if (!copy_from_kernel_nofault(&runnable_at, &p->scx.runnable_at,
8619 sizeof(runnable_at)))
8620 scnprintf(runnable_at_buf, sizeof(runnable_at_buf), "%+ldms",
8621 jiffies_delta_msecs(runnable_at, jiffies));
8622
8623 /* print everything onto one line to conserve console space */
8624 printk("%sSched_ext: %s (%s%s), task: runnable_at=%s",
8625 log_lvl, sch->ops.name, scx_enable_state_str[state], all,
8626 runnable_at_buf);
8627 }
8628
scx_pm_handler(struct notifier_block * nb,unsigned long event,void * ptr)8629 static int scx_pm_handler(struct notifier_block *nb, unsigned long event, void *ptr)
8630 {
8631 struct scx_sched *sch;
8632
8633 guard(rcu)();
8634
8635 sch = rcu_dereference(scx_root);
8636 if (!sch)
8637 return NOTIFY_OK;
8638
8639 /*
8640 * SCX schedulers often have userspace components which are sometimes
8641 * involved in critial scheduling paths. PM operations involve freezing
8642 * userspace which can lead to scheduling misbehaviors including stalls.
8643 * Let's bypass while PM operations are in progress.
8644 */
8645 switch (event) {
8646 case PM_HIBERNATION_PREPARE:
8647 case PM_SUSPEND_PREPARE:
8648 case PM_RESTORE_PREPARE:
8649 scx_bypass(sch, true);
8650 break;
8651 case PM_POST_HIBERNATION:
8652 case PM_POST_SUSPEND:
8653 case PM_POST_RESTORE:
8654 scx_bypass(sch, false);
8655 break;
8656 }
8657
8658 return NOTIFY_OK;
8659 }
8660
8661 static struct notifier_block scx_pm_notifier = {
8662 .notifier_call = scx_pm_handler,
8663 };
8664
init_sched_ext_class(void)8665 void __init init_sched_ext_class(void)
8666 {
8667 s32 cpu, v;
8668
8669 /*
8670 * The following is to prevent the compiler from optimizing out the enum
8671 * definitions so that BPF scheduler implementations can use them
8672 * through the generated vmlinux.h.
8673 */
8674 WRITE_ONCE(v, SCX_ENQ_WAKEUP | SCX_DEQ_SLEEP | SCX_KICK_PREEMPT |
8675 SCX_TG_ONLINE);
8676
8677 scx_idle_init_masks();
8678
8679 for_each_possible_cpu(cpu) {
8680 struct rq *rq = cpu_rq(cpu);
8681 int n = cpu_to_node(cpu);
8682
8683 /* local_dsq's sch will be set during scx_root_enable() */
8684 BUG_ON(scx_init_dsq(&rq->scx.local_dsq, SCX_DSQ_LOCAL, NULL));
8685 #ifdef CONFIG_EXT_SUB_SCHED
8686 BUG_ON(scx_init_dsq(&rq->scx.reject_dsq, SCX_DSQ_REJECT, NULL));
8687 scx_rescue_init(rq);
8688 #endif
8689
8690 INIT_LIST_HEAD(&rq->scx.runnable_list);
8691 INIT_LIST_HEAD(&rq->scx.ddsp_deferred_locals);
8692
8693 BUG_ON(!zalloc_cpumask_var_node(&rq->scx.cpus_to_sync, GFP_KERNEL, n));
8694 INIT_LIST_HEAD(&rq->scx.sched_pcpus_to_kick);
8695 raw_spin_lock_init(&rq->scx.deferred_reenq_lock);
8696 INIT_LIST_HEAD(&rq->scx.deferred_reenq_locals);
8697 INIT_LIST_HEAD(&rq->scx.deferred_reenq_users);
8698 rq->scx.deferred_irq_work = IRQ_WORK_INIT_HARD(deferred_irq_workfn);
8699 rq->scx.kick_cpus_irq_work = IRQ_WORK_INIT_HARD(kick_cpus_irq_workfn);
8700
8701 if (cpu_online(cpu))
8702 cpu_rq(cpu)->scx.flags |= SCX_RQ_ONLINE;
8703 }
8704
8705 register_sysrq_key('S', &sysrq_sched_ext_reset_op);
8706 register_sysrq_key('D', &sysrq_sched_ext_dump_op);
8707 INIT_DELAYED_WORK(&scx_watchdog_work, scx_watchdog_workfn);
8708
8709 #ifdef CONFIG_EXT_SUB_SCHED
8710 BUG_ON(rhashtable_init(&scx_sched_hash, &scx_sched_hash_params));
8711 #endif /* CONFIG_EXT_SUB_SCHED */
8712 }
8713
8714
8715 /********************************************************************************
8716 * Helpers that can be called from the BPF scheduler.
8717 */
scx_vet_enq_flags(struct scx_sched * sch,u64 dsq_id,u64 * enq_flags)8718 static bool scx_vet_enq_flags(struct scx_sched *sch, u64 dsq_id, u64 *enq_flags)
8719 {
8720 bool is_local = dsq_id == SCX_DSQ_LOCAL ||
8721 (dsq_id & SCX_DSQ_LOCAL_ON) == SCX_DSQ_LOCAL_ON;
8722
8723 if (unlikely(*enq_flags & __SCX_ENQ_INTERNAL_MASK)) {
8724 scx_error(sch, "invalid enq_flags 0x%llx", *enq_flags);
8725 return false;
8726 }
8727
8728 if (*enq_flags & SCX_ENQ_IMMED) {
8729 if (unlikely(!is_local)) {
8730 scx_error(sch, "SCX_ENQ_IMMED on a non-local DSQ 0x%llx", dsq_id);
8731 return false;
8732 }
8733 } else if ((sch->ops.flags & SCX_OPS_ALWAYS_ENQ_IMMED) && is_local) {
8734 *enq_flags |= SCX_ENQ_IMMED;
8735 }
8736
8737 if (unlikely((*enq_flags & SCX_ENQ_RESCUE) && !is_local)) {
8738 scx_error(sch, "SCX_ENQ_RESCUE on a non-local DSQ 0x%llx", dsq_id);
8739 return false;
8740 }
8741
8742 return true;
8743 }
8744
scx_dsq_insert_preamble(struct scx_sched * sch,struct task_struct * p,u64 dsq_id,u64 * enq_flags)8745 static bool scx_dsq_insert_preamble(struct scx_sched *sch, struct task_struct *p,
8746 u64 dsq_id, u64 *enq_flags)
8747 {
8748 lockdep_assert_irqs_disabled();
8749
8750 if (unlikely(!p)) {
8751 scx_error(sch, "called with NULL task");
8752 return false;
8753 }
8754
8755 /* see SCX_EV_INSERT_NOT_OWNED definition */
8756 if (unlikely(!scx_task_on_sched(sch, p))) {
8757 __scx_add_event(sch, SCX_EV_INSERT_NOT_OWNED, 1);
8758 return false;
8759 }
8760
8761 if (!scx_vet_enq_flags(sch, dsq_id, enq_flags))
8762 return false;
8763
8764 return true;
8765 }
8766
scx_dsq_insert_commit(struct scx_sched * sch,struct task_struct * p,u64 dsq_id,u64 slice,u64 vtime,u64 enq_flags)8767 static void scx_dsq_insert_commit(struct scx_sched *sch, struct task_struct *p,
8768 u64 dsq_id, u64 slice, u64 vtime, u64 enq_flags)
8769 {
8770 struct scx_dsp_ctx *dspc = &this_cpu_ptr(sch->pcpu)->dsp_ctx;
8771 struct task_struct *ddsp_task;
8772
8773 ddsp_task = __this_cpu_read(direct_dispatch_task);
8774 if (ddsp_task) {
8775 mark_direct_dispatch(sch, ddsp_task, p, dsq_id, slice, vtime, enq_flags);
8776 return;
8777 }
8778
8779 if (unlikely(dspc->cursor >= sch->dsp_max_batch)) {
8780 scx_error(sch, "dispatch buffer overflow");
8781 return;
8782 }
8783
8784 dspc->buf[dspc->cursor++] = (struct scx_dsp_buf_ent){
8785 .task = p,
8786 .qseq = atomic_long_read(&p->scx.ops_state) & SCX_OPSS_QSEQ_MASK,
8787 .dsq_id = dsq_id,
8788 .slice = slice,
8789 .vtime = vtime,
8790 .enq_flags = enq_flags,
8791 };
8792 }
8793
8794 __bpf_kfunc_start_defs();
8795
8796 /**
8797 * scx_bpf_dsq_insert___v2 - Insert a task into the FIFO queue of a DSQ
8798 * @p: task_struct to insert
8799 * @dsq_id: DSQ to insert into
8800 * @slice: duration @p can run for in nsecs, 0 to keep the current value
8801 * @enq_flags: SCX_ENQ_*
8802 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
8803 *
8804 * Insert @p into the FIFO queue of the DSQ identified by @dsq_id. It is safe to
8805 * call this function spuriously. Can be called from ops.enqueue(),
8806 * ops.select_cpu(), and ops.dispatch().
8807 *
8808 * When called from ops.select_cpu() or ops.enqueue(), it's for direct dispatch
8809 * and @p must match the task being enqueued.
8810 *
8811 * When called from ops.select_cpu(), @enq_flags and @dsq_id are stored, and @p
8812 * will be directly inserted into the corresponding dispatch queue after
8813 * ops.select_cpu() returns. If @p is inserted into SCX_DSQ_LOCAL, it will be
8814 * inserted into the local DSQ of the CPU returned by ops.select_cpu().
8815 * @enq_flags are OR'd with the enqueue flags on the enqueue path before the
8816 * task is inserted.
8817 *
8818 * When called from ops.dispatch(), there are no restrictions on @p or @dsq_id
8819 * and this function can be called upto ops.dispatch_max_batch times to insert
8820 * multiple tasks. scx_bpf_dispatch_nr_slots() returns the number of the
8821 * remaining slots. scx_bpf_dsq_move_to_local() flushes the batch and resets the
8822 * counter.
8823 *
8824 * This function doesn't have any locking restrictions and may be called under
8825 * BPF locks (in the future when BPF introduces more flexible locking).
8826 *
8827 * @p is allowed to run for @slice. The scheduling path is triggered on slice
8828 * exhaustion. If zero, the current residual slice is maintained. If
8829 * %SCX_SLICE_INF, @p never expires and the BPF scheduler must kick the CPU with
8830 * scx_bpf_kick_cpu() to trigger scheduling.
8831 *
8832 * Returns %true on successful insertion, %false on failure. On the root
8833 * scheduler, %false return triggers scheduler abort and the caller doesn't need
8834 * to check the return value.
8835 */
scx_bpf_dsq_insert___v2(struct task_struct * p,u64 dsq_id,u64 slice,u64 enq_flags,const struct bpf_prog_aux * aux)8836 __bpf_kfunc bool scx_bpf_dsq_insert___v2(struct task_struct *p, u64 dsq_id,
8837 u64 slice, u64 enq_flags,
8838 const struct bpf_prog_aux *aux)
8839 {
8840 struct scx_sched *sch;
8841
8842 guard(rcu)();
8843 sch = scx_prog_sched(aux);
8844 if (unlikely(!sch))
8845 return false;
8846
8847 if (!scx_dsq_insert_preamble(sch, p, dsq_id, &enq_flags))
8848 return false;
8849
8850 scx_dsq_insert_commit(sch, p, dsq_id, slice, 0, enq_flags);
8851
8852 return true;
8853 }
8854
8855 /*
8856 * COMPAT: Will be removed in v6.23 along with the ___v2 suffix.
8857 */
scx_bpf_dsq_insert(struct task_struct * p,u64 dsq_id,u64 slice,u64 enq_flags,const struct bpf_prog_aux * aux)8858 __bpf_kfunc void scx_bpf_dsq_insert(struct task_struct *p, u64 dsq_id,
8859 u64 slice, u64 enq_flags,
8860 const struct bpf_prog_aux *aux)
8861 {
8862 scx_bpf_dsq_insert___v2(p, dsq_id, slice, enq_flags, aux);
8863 }
8864
scx_dsq_insert_vtime(struct scx_sched * sch,struct task_struct * p,u64 dsq_id,u64 slice,u64 vtime,u64 enq_flags)8865 static bool scx_dsq_insert_vtime(struct scx_sched *sch, struct task_struct *p,
8866 u64 dsq_id, u64 slice, u64 vtime, u64 enq_flags)
8867 {
8868 if (!scx_dsq_insert_preamble(sch, p, dsq_id, &enq_flags))
8869 return false;
8870
8871 scx_dsq_insert_commit(sch, p, dsq_id, slice, vtime, enq_flags | SCX_ENQ_DSQ_PRIQ);
8872
8873 return true;
8874 }
8875
8876 struct scx_bpf_dsq_insert_vtime_args {
8877 /* @p can't be packed together as KF_RCU is not transitive */
8878 u64 dsq_id;
8879 u64 slice;
8880 u64 vtime;
8881 u64 enq_flags;
8882 };
8883
8884 /**
8885 * __scx_bpf_dsq_insert_vtime - Arg-wrapped vtime DSQ insertion
8886 * @p: task_struct to insert
8887 * @args: struct containing the rest of the arguments
8888 * @args->dsq_id: DSQ to insert into
8889 * @args->slice: duration @p can run for in nsecs, 0 to keep the current value
8890 * @args->vtime: @p's ordering inside the vtime-sorted queue of the target DSQ
8891 * @args->enq_flags: SCX_ENQ_*
8892 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
8893 *
8894 * Wrapper kfunc that takes arguments via struct to work around BPF's 5 argument
8895 * limit. BPF programs should use scx_bpf_dsq_insert_vtime() which is provided
8896 * as an inline wrapper in common.bpf.h.
8897 *
8898 * Insert @p into the vtime priority queue of the DSQ identified by
8899 * @args->dsq_id. Tasks queued into the priority queue are ordered by
8900 * @args->vtime. All other aspects are identical to scx_bpf_dsq_insert().
8901 *
8902 * @args->vtime ordering is according to time_before64() which considers
8903 * wrapping. A numerically larger vtime may indicate an earlier position in the
8904 * ordering and vice-versa.
8905 *
8906 * A DSQ can only be used as a FIFO or priority queue at any given time and this
8907 * function must not be called on a DSQ which already has one or more FIFO tasks
8908 * queued and vice-versa. Also, the built-in DSQs (SCX_DSQ_LOCAL and
8909 * SCX_DSQ_GLOBAL) cannot be used as priority queues.
8910 *
8911 * Returns %true on successful insertion, %false on failure. On the root
8912 * scheduler, %false return triggers scheduler abort and the caller doesn't need
8913 * to check the return value.
8914 */
8915 __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)8916 __scx_bpf_dsq_insert_vtime(struct task_struct *p,
8917 struct scx_bpf_dsq_insert_vtime_args *args,
8918 const struct bpf_prog_aux *aux)
8919 {
8920 struct scx_sched *sch;
8921
8922 guard(rcu)();
8923
8924 sch = scx_prog_sched(aux);
8925 if (unlikely(!sch))
8926 return false;
8927
8928 return scx_dsq_insert_vtime(sch, p, args->dsq_id, args->slice,
8929 args->vtime, args->enq_flags);
8930 }
8931
8932 /*
8933 * COMPAT: Will be removed in v6.23.
8934 */
scx_bpf_dsq_insert_vtime(struct task_struct * p,u64 dsq_id,u64 slice,u64 vtime,u64 enq_flags)8935 __bpf_kfunc void scx_bpf_dsq_insert_vtime(struct task_struct *p, u64 dsq_id,
8936 u64 slice, u64 vtime, u64 enq_flags)
8937 {
8938 struct scx_sched *sch;
8939
8940 guard(rcu)();
8941
8942 sch = rcu_dereference(scx_root);
8943 if (unlikely(!sch))
8944 return;
8945
8946 #ifdef CONFIG_EXT_SUB_SCHED
8947 /*
8948 * Disallow if any sub-scheds are attached. There is no way to tell
8949 * which scheduler called us, just error out @p's scheduler.
8950 */
8951 if (unlikely(!list_empty(&sch->children))) {
8952 scx_error(scx_task_sched(p), "__scx_bpf_dsq_insert_vtime() must be used");
8953 return;
8954 }
8955 #endif
8956
8957 scx_dsq_insert_vtime(sch, p, dsq_id, slice, vtime, enq_flags);
8958 }
8959
8960 __bpf_kfunc_end_defs();
8961
8962 BTF_KFUNCS_START(scx_kfunc_ids_enqueue_dispatch)
8963 BTF_ID_FLAGS(func, scx_bpf_dsq_insert, KF_IMPLICIT_ARGS | KF_RCU)
8964 BTF_ID_FLAGS(func, scx_bpf_dsq_insert___v2, KF_IMPLICIT_ARGS | KF_RCU)
8965 BTF_ID_FLAGS(func, __scx_bpf_dsq_insert_vtime, KF_IMPLICIT_ARGS | KF_RCU)
8966 BTF_ID_FLAGS(func, scx_bpf_dsq_insert_vtime, KF_RCU)
8967 BTF_KFUNCS_END(scx_kfunc_ids_enqueue_dispatch)
8968
8969 static const struct btf_kfunc_id_set scx_kfunc_set_enqueue_dispatch = {
8970 .owner = THIS_MODULE,
8971 .set = &scx_kfunc_ids_enqueue_dispatch,
8972 .filter = scx_kfunc_context_filter,
8973 };
8974
scx_dsq_move(struct bpf_iter_scx_dsq_kern * kit,struct task_struct * p,u64 dsq_id,u64 enq_flags,bool priq)8975 static bool scx_dsq_move(struct bpf_iter_scx_dsq_kern *kit,
8976 struct task_struct *p, u64 dsq_id, u64 enq_flags,
8977 bool priq)
8978 {
8979 struct scx_dispatch_q *src_dsq = kit->dsq, *dst_dsq;
8980 struct scx_sched *sch;
8981 struct rq *p_rq, *src_rq, *locked_rq;
8982 bool dispatched = false;
8983 unsigned long flags;
8984
8985 /*
8986 * The verifier considers an iterator slot initialized on any
8987 * KF_ITER_NEW return, so a BPF program may legally reach here after
8988 * bpf_iter_scx_dsq_new() failed and left @kit->dsq NULL.
8989 */
8990 if (unlikely(!src_dsq))
8991 return false;
8992
8993 sch = src_dsq->sched;
8994
8995 if (!scx_vet_enq_flags(sch, dsq_id, &enq_flags))
8996 return false;
8997
8998 /* internal bit, can only go in after @enq_flags is vetted */
8999 if (priq)
9000 enq_flags |= SCX_ENQ_DSQ_PRIQ;
9001
9002 /*
9003 * If the BPF scheduler keeps calling this function repeatedly, it can
9004 * cause similar live-lock conditions as scx_consume_dispatch_q().
9005 */
9006 if (unlikely(READ_ONCE(sch->aborting)))
9007 return false;
9008
9009 /*
9010 * Can be called from either ops.dispatch() holding the dispatched rq's
9011 * lock or any context where no rq lock is held. If latter, lock @p's
9012 * task_rq which we'll likely need anyway.
9013 */
9014 src_rq = task_rq(p);
9015
9016 local_irq_save(flags);
9017
9018 /*
9019 * Under core scheduling, dispatch can run for a sibling rq, so the
9020 * locked rq is not necessarily this CPU's.
9021 */
9022 locked_rq = scx_locked_rq();
9023
9024 if (locked_rq) {
9025 if (locked_rq != src_rq)
9026 switch_rq_lock(locked_rq, src_rq);
9027 } else {
9028 raw_spin_rq_lock(src_rq);
9029 }
9030
9031 p_rq = src_rq;
9032 raw_spin_lock(&src_dsq->lock);
9033
9034 /* did someone else get to it while we dropped the locks? */
9035 if (nldsq_cursor_lost_task(&kit->cursor, src_rq, src_dsq, p)) {
9036 raw_spin_unlock(&src_dsq->lock);
9037 goto out;
9038 }
9039
9040 /*
9041 * @p has been on $src_dsq and can't move anymore. If @p is not on @sch,
9042 * the caller didn't have authority over @p at the time of the call.
9043 */
9044 if (unlikely(!scx_task_on_sched(sch, p))) {
9045 scx_error(sch, "scx_bpf_dsq_move[_vtime]() on %s[%d] but the task belongs to a different scheduler",
9046 p->comm, p->pid);
9047 raw_spin_unlock(&src_dsq->lock);
9048 goto out;
9049 }
9050
9051 /* @p is still on $src_dsq and stable, determine the destination */
9052 dst_dsq = find_dsq_for_dispatch(sch, locked_rq ?: this_rq(), dsq_id, task_cpu(p));
9053
9054 /*
9055 * Apply vtime and slice updates before moving. @p is still on $src_dsq
9056 * with both $src_dsq and its task_rq locked, satisfying the write
9057 * rules, and the PRIQ insertion into $dst_dsq reads the new vtime.
9058 */
9059 if (kit->cursor.flags & __SCX_DSQ_ITER_HAS_VTIME)
9060 p->scx.dsq_vtime = kit->vtime;
9061 if (kit->cursor.flags & __SCX_DSQ_ITER_HAS_SLICE)
9062 scx_set_task_slice(p, kit->slice);
9063
9064 /* execute move */
9065 p_rq = move_task_between_dsqs(sch, p, enq_flags, src_dsq, dst_dsq);
9066 dispatched = true;
9067 out:
9068 if (locked_rq) {
9069 if (locked_rq != p_rq)
9070 switch_rq_lock(p_rq, locked_rq);
9071 } else {
9072 scx_rq_lock_drop(p_rq);
9073 raw_spin_rq_unlock_irqrestore(p_rq, flags);
9074 }
9075
9076 kit->cursor.flags &= ~(__SCX_DSQ_ITER_HAS_SLICE |
9077 __SCX_DSQ_ITER_HAS_VTIME);
9078 return dispatched;
9079 }
9080
9081 __bpf_kfunc_start_defs();
9082
9083 /**
9084 * scx_bpf_dispatch_nr_slots - Return the number of remaining dispatch slots
9085 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9086 *
9087 * Can only be called from ops.dispatch().
9088 */
scx_bpf_dispatch_nr_slots(const struct bpf_prog_aux * aux)9089 __bpf_kfunc u32 scx_bpf_dispatch_nr_slots(const struct bpf_prog_aux *aux)
9090 {
9091 struct scx_sched *sch;
9092
9093 guard(rcu)();
9094
9095 sch = scx_prog_sched(aux);
9096 if (unlikely(!sch))
9097 return 0;
9098
9099 return sch->dsp_max_batch - __this_cpu_read(sch->pcpu->dsp_ctx.cursor);
9100 }
9101
9102 /**
9103 * scx_bpf_dispatch_cancel - Cancel the latest dispatch
9104 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9105 *
9106 * Cancel the latest dispatch. Can be called multiple times to cancel further
9107 * dispatches. Can only be called from ops.dispatch().
9108 */
scx_bpf_dispatch_cancel(const struct bpf_prog_aux * aux)9109 __bpf_kfunc void scx_bpf_dispatch_cancel(const struct bpf_prog_aux *aux)
9110 {
9111 struct scx_sched *sch;
9112 struct scx_dsp_ctx *dspc;
9113
9114 guard(rcu)();
9115
9116 sch = scx_prog_sched(aux);
9117 if (unlikely(!sch))
9118 return;
9119
9120 dspc = &this_cpu_ptr(sch->pcpu)->dsp_ctx;
9121
9122 if (dspc->cursor > 0)
9123 dspc->cursor--;
9124 else
9125 scx_error(sch, "dispatch buffer underflow");
9126 }
9127
9128 /**
9129 * scx_bpf_dsq_move_to_local___v2 - move a task from a DSQ to the current CPU's local DSQ
9130 * @dsq_id: DSQ to move task from. Must be a user-created DSQ
9131 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9132 * @enq_flags: %SCX_ENQ_*
9133 *
9134 * Move a task from the non-local DSQ identified by @dsq_id to the current CPU's
9135 * local DSQ for execution with @enq_flags applied. Can only be called from
9136 * ops.dispatch().
9137 *
9138 * Built-in DSQs (%SCX_DSQ_GLOBAL and %SCX_DSQ_LOCAL*) are not supported as
9139 * sources. Local DSQs support reenqueueing (a task can be picked up for
9140 * execution, dequeued for property changes, or reenqueued), but the BPF
9141 * scheduler cannot directly iterate or move tasks from them. %SCX_DSQ_GLOBAL
9142 * is similar but also doesn't support reenqueueing, as it maps to multiple
9143 * per-node DSQs making the scope difficult to define; this may change in the
9144 * future.
9145 *
9146 * This function flushes the in-flight dispatches from scx_bpf_dsq_insert()
9147 * before trying to move from the specified DSQ. It may also grab rq locks and
9148 * thus can't be called under any BPF locks.
9149 *
9150 * Returns %true if a task has been moved, %false if there isn't any task to
9151 * move.
9152 */
scx_bpf_dsq_move_to_local___v2(u64 dsq_id,u64 enq_flags,const struct bpf_prog_aux * aux)9153 __bpf_kfunc bool scx_bpf_dsq_move_to_local___v2(u64 dsq_id, u64 enq_flags,
9154 const struct bpf_prog_aux *aux)
9155 {
9156 struct scx_dispatch_q *dsq;
9157 struct scx_sched *sch;
9158 struct scx_dsp_ctx *dspc;
9159
9160 guard(rcu)();
9161
9162 sch = scx_prog_sched(aux);
9163 if (unlikely(!sch))
9164 return false;
9165
9166 if (!scx_vet_enq_flags(sch, SCX_DSQ_LOCAL, &enq_flags))
9167 return false;
9168
9169 dspc = &this_cpu_ptr(sch->pcpu)->dsp_ctx;
9170
9171 scx_flush_dispatch_buf(sch, dspc->rq);
9172
9173 dsq = find_user_dsq(sch, dsq_id);
9174 if (unlikely(!dsq)) {
9175 scx_error(sch, "invalid DSQ ID 0x%016llx", dsq_id);
9176 return false;
9177 }
9178
9179 if (scx_consume_dispatch_q(sch, dspc->rq, dsq, enq_flags)) {
9180 /*
9181 * A successfully consumed task can be dequeued before it starts
9182 * running while the CPU is trying to migrate other dispatched
9183 * tasks. Bump nr_tasks to tell dispatch_one() to retry on empty
9184 * local DSQ.
9185 */
9186 dspc->nr_tasks++;
9187 return true;
9188 } else {
9189 return false;
9190 }
9191 }
9192
9193 /*
9194 * COMPAT: ___v2 was introduced in v7.1. Remove this and ___v2 tag in the future.
9195 */
scx_bpf_dsq_move_to_local(u64 dsq_id,const struct bpf_prog_aux * aux)9196 __bpf_kfunc bool scx_bpf_dsq_move_to_local(u64 dsq_id, const struct bpf_prog_aux *aux)
9197 {
9198 return scx_bpf_dsq_move_to_local___v2(dsq_id, 0, aux);
9199 }
9200
9201 /**
9202 * scx_bpf_dsq_move_set_slice - Override slice when moving between DSQs
9203 * @it__iter: DSQ iterator in progress
9204 * @slice: duration the moved task can run for in nsecs
9205 *
9206 * Override the slice of the next task that will be moved from @it__iter using
9207 * scx_bpf_dsq_move[_vtime](). If this function is not called, the previous
9208 * slice duration is kept.
9209 */
scx_bpf_dsq_move_set_slice(struct bpf_iter_scx_dsq * it__iter,u64 slice)9210 __bpf_kfunc void scx_bpf_dsq_move_set_slice(struct bpf_iter_scx_dsq *it__iter,
9211 u64 slice)
9212 {
9213 struct bpf_iter_scx_dsq_kern *kit = (void *)it__iter;
9214
9215 kit->slice = slice;
9216 kit->cursor.flags |= __SCX_DSQ_ITER_HAS_SLICE;
9217 }
9218
9219 /**
9220 * scx_bpf_dsq_move_set_vtime - Override vtime when moving between DSQs
9221 * @it__iter: DSQ iterator in progress
9222 * @vtime: task's ordering inside the vtime-sorted queue of the target DSQ
9223 *
9224 * Override the vtime of the next task that will be moved from @it__iter using
9225 * scx_bpf_dsq_move_vtime(). If this function is not called, the previous slice
9226 * vtime is kept. If scx_bpf_dsq_move() is used to dispatch the next task, the
9227 * override is ignored and cleared.
9228 */
scx_bpf_dsq_move_set_vtime(struct bpf_iter_scx_dsq * it__iter,u64 vtime)9229 __bpf_kfunc void scx_bpf_dsq_move_set_vtime(struct bpf_iter_scx_dsq *it__iter,
9230 u64 vtime)
9231 {
9232 struct bpf_iter_scx_dsq_kern *kit = (void *)it__iter;
9233
9234 kit->vtime = vtime;
9235 kit->cursor.flags |= __SCX_DSQ_ITER_HAS_VTIME;
9236 }
9237
9238 /**
9239 * scx_bpf_dsq_move - Move a task from DSQ iteration to a DSQ
9240 * @it__iter: DSQ iterator in progress
9241 * @p: task to transfer
9242 * @dsq_id: DSQ to move @p to
9243 * @enq_flags: SCX_ENQ_*
9244 *
9245 * Transfer @p which is on the DSQ currently iterated by @it__iter to the DSQ
9246 * specified by @dsq_id. All DSQs - local DSQs, global DSQ and user DSQs - can
9247 * be the destination.
9248 *
9249 * For the transfer to be successful, @p must still be on the DSQ and have been
9250 * queued before the DSQ iteration started. This function doesn't care whether
9251 * @p was obtained from the DSQ iteration. @p just has to be on the DSQ and have
9252 * been queued before the iteration started.
9253 *
9254 * @p's slice is kept by default. Use scx_bpf_dsq_move_set_slice() to update.
9255 *
9256 * Can be called from ops.dispatch() or any BPF context which doesn't hold a rq
9257 * lock (e.g. BPF timers or SYSCALL programs).
9258 *
9259 * Returns %true if @p has been consumed, %false if @p had already been
9260 * consumed, dequeued, or, for sub-scheds, @dsq_id points to a disallowed local
9261 * DSQ.
9262 */
scx_bpf_dsq_move(struct bpf_iter_scx_dsq * it__iter,struct task_struct * p,u64 dsq_id,u64 enq_flags)9263 __bpf_kfunc bool scx_bpf_dsq_move(struct bpf_iter_scx_dsq *it__iter,
9264 struct task_struct *p, u64 dsq_id,
9265 u64 enq_flags)
9266 {
9267 return scx_dsq_move((struct bpf_iter_scx_dsq_kern *)it__iter,
9268 p, dsq_id, enq_flags, false);
9269 }
9270
9271 /**
9272 * scx_bpf_dsq_move_vtime - Move a task from DSQ iteration to a PRIQ DSQ
9273 * @it__iter: DSQ iterator in progress
9274 * @p: task to transfer
9275 * @dsq_id: DSQ to move @p to
9276 * @enq_flags: SCX_ENQ_*
9277 *
9278 * Transfer @p which is on the DSQ currently iterated by @it__iter to the
9279 * priority queue of the DSQ specified by @dsq_id. The destination must be a
9280 * user DSQ as only user DSQs support priority queue.
9281 *
9282 * @p's slice and vtime are kept by default. Use scx_bpf_dsq_move_set_slice()
9283 * and scx_bpf_dsq_move_set_vtime() to update.
9284 *
9285 * All other aspects are identical to scx_bpf_dsq_move(). See
9286 * scx_bpf_dsq_insert_vtime() for more information on @vtime.
9287 */
scx_bpf_dsq_move_vtime(struct bpf_iter_scx_dsq * it__iter,struct task_struct * p,u64 dsq_id,u64 enq_flags)9288 __bpf_kfunc bool scx_bpf_dsq_move_vtime(struct bpf_iter_scx_dsq *it__iter,
9289 struct task_struct *p, u64 dsq_id,
9290 u64 enq_flags)
9291 {
9292 return scx_dsq_move((struct bpf_iter_scx_dsq_kern *)it__iter,
9293 p, dsq_id, enq_flags, true);
9294 }
9295
9296 __bpf_kfunc_end_defs();
9297
9298 BTF_KFUNCS_START(scx_kfunc_ids_dispatch)
9299 BTF_ID_FLAGS(func, scx_bpf_dispatch_nr_slots, KF_IMPLICIT_ARGS)
9300 BTF_ID_FLAGS(func, scx_bpf_dispatch_cancel, KF_IMPLICIT_ARGS)
9301 BTF_ID_FLAGS(func, scx_bpf_dsq_move_to_local, KF_IMPLICIT_ARGS)
9302 BTF_ID_FLAGS(func, scx_bpf_dsq_move_to_local___v2, KF_IMPLICIT_ARGS)
9303 /* scx_bpf_dsq_move*() also in scx_kfunc_ids_unlocked: callable from unlocked contexts */
9304 BTF_ID_FLAGS(func, scx_bpf_dsq_move_set_slice, KF_RCU)
9305 BTF_ID_FLAGS(func, scx_bpf_dsq_move_set_vtime, KF_RCU)
9306 BTF_ID_FLAGS(func, scx_bpf_dsq_move, KF_RCU)
9307 BTF_ID_FLAGS(func, scx_bpf_dsq_move_vtime, KF_RCU)
9308 #ifdef CONFIG_EXT_SUB_SCHED
9309 BTF_ID_FLAGS(func, scx_bpf_sub_dispatch, KF_IMPLICIT_ARGS)
9310 #endif
9311 BTF_KFUNCS_END(scx_kfunc_ids_dispatch)
9312
9313 static const struct btf_kfunc_id_set scx_kfunc_set_dispatch = {
9314 .owner = THIS_MODULE,
9315 .set = &scx_kfunc_ids_dispatch,
9316 .filter = scx_kfunc_context_filter,
9317 };
9318
9319 __bpf_kfunc_start_defs();
9320
9321 /**
9322 * scx_bpf_reenqueue_local - Re-enqueue tasks on a local DSQ
9323 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9324 *
9325 * Iterate over all of the tasks currently enqueued on the local DSQ of the
9326 * caller's CPU, and re-enqueue them in the BPF scheduler. Returns the number of
9327 * processed tasks. Can only be called from ops.cpu_release().
9328 */
scx_bpf_reenqueue_local(const struct bpf_prog_aux * aux)9329 __bpf_kfunc u32 scx_bpf_reenqueue_local(const struct bpf_prog_aux *aux)
9330 {
9331 struct scx_sched *sch;
9332 struct rq *rq;
9333
9334 guard(rcu)();
9335 sch = scx_prog_sched(aux);
9336 if (unlikely(!sch))
9337 return 0;
9338
9339 rq = cpu_rq(smp_processor_id());
9340 lockdep_assert_rq_held(rq);
9341
9342 return reenq_local(sch, rq, SCX_REENQ_ANY);
9343 }
9344
9345 __bpf_kfunc_end_defs();
9346
9347 BTF_KFUNCS_START(scx_kfunc_ids_cpu_release)
9348 BTF_ID_FLAGS(func, scx_bpf_reenqueue_local, KF_IMPLICIT_ARGS)
9349 BTF_KFUNCS_END(scx_kfunc_ids_cpu_release)
9350
9351 static const struct btf_kfunc_id_set scx_kfunc_set_cpu_release = {
9352 .owner = THIS_MODULE,
9353 .set = &scx_kfunc_ids_cpu_release,
9354 .filter = scx_kfunc_context_filter,
9355 };
9356
9357 __bpf_kfunc_start_defs();
9358
9359 /**
9360 * scx_bpf_create_dsq - Create a custom DSQ
9361 * @dsq_id: DSQ to create
9362 * @node: NUMA node to allocate from
9363 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9364 *
9365 * Create a custom DSQ identified by @dsq_id. Can be called from any sleepable
9366 * scx callback, and any BPF_PROG_TYPE_SYSCALL prog.
9367 */
scx_bpf_create_dsq(u64 dsq_id,s32 node,const struct bpf_prog_aux * aux)9368 __bpf_kfunc s32 scx_bpf_create_dsq(u64 dsq_id, s32 node, const struct bpf_prog_aux *aux)
9369 {
9370 struct scx_dispatch_q *dsq;
9371 struct scx_sched *sch;
9372 s32 ret;
9373
9374 if (unlikely(node >= (int)nr_node_ids ||
9375 (node < 0 && node != NUMA_NO_NODE)))
9376 return -EINVAL;
9377
9378 if (unlikely(dsq_id & SCX_DSQ_FLAG_BUILTIN))
9379 return -EINVAL;
9380
9381 dsq = kmalloc_node(sizeof(*dsq), GFP_KERNEL, node);
9382 if (!dsq)
9383 return -ENOMEM;
9384
9385 /*
9386 * scx_init_dsq() must be called in GFP_KERNEL context. Init it with
9387 * NULL @sch and update afterwards.
9388 */
9389 ret = scx_init_dsq(dsq, dsq_id, NULL);
9390 if (ret) {
9391 kfree(dsq);
9392 return ret;
9393 }
9394
9395 rcu_read_lock();
9396
9397 sch = scx_prog_sched(aux);
9398 if (sch) {
9399 dsq->sched = sch;
9400 ret = rhashtable_lookup_insert_fast(&sch->dsq_hash, &dsq->hash_node,
9401 dsq_hash_params);
9402 } else {
9403 ret = -ENODEV;
9404 }
9405
9406 rcu_read_unlock();
9407 if (ret) {
9408 exit_dsq(dsq);
9409 kfree(dsq);
9410 }
9411 return ret;
9412 }
9413
9414 __bpf_kfunc_end_defs();
9415
9416 BTF_KFUNCS_START(scx_kfunc_ids_unlocked)
9417 BTF_ID_FLAGS(func, scx_bpf_create_dsq, KF_IMPLICIT_ARGS | KF_SLEEPABLE)
9418 /* also in scx_kfunc_ids_dispatch: also callable from ops.dispatch() */
9419 BTF_ID_FLAGS(func, scx_bpf_dsq_move_set_slice, KF_RCU)
9420 BTF_ID_FLAGS(func, scx_bpf_dsq_move_set_vtime, KF_RCU)
9421 BTF_ID_FLAGS(func, scx_bpf_dsq_move, KF_RCU)
9422 BTF_ID_FLAGS(func, scx_bpf_dsq_move_vtime, KF_RCU)
9423 /* also in scx_kfunc_ids_select_cpu: also callable from ops.select_cpu()/ops.enqueue() */
9424 BTF_ID_FLAGS(func, __scx_bpf_select_cpu_and, KF_IMPLICIT_ARGS | KF_RCU)
9425 BTF_ID_FLAGS(func, scx_bpf_select_cpu_and, KF_RCU)
9426 BTF_ID_FLAGS(func, scx_bpf_select_cpu_dfl, KF_IMPLICIT_ARGS | KF_RCU)
9427 BTF_KFUNCS_END(scx_kfunc_ids_unlocked)
9428
9429 static const struct btf_kfunc_id_set scx_kfunc_set_unlocked = {
9430 .owner = THIS_MODULE,
9431 .set = &scx_kfunc_ids_unlocked,
9432 .filter = scx_kfunc_context_filter,
9433 };
9434
9435 __bpf_kfunc_start_defs();
9436
9437 /**
9438 * scx_bpf_task_set_slice - Set task's time slice
9439 * @p: task of interest
9440 * @slice: time slice to set in nsecs
9441 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9442 *
9443 * Set @p's time slice. @p must be on the calling scheduler. The value is
9444 * applied whether or not the caller holds @p's rq lock - see the slice write
9445 * rules above for the ownership model.
9446 *
9447 * Raising the slice is honored only while the scheduler holds %SCX_CAP_BASE on
9448 * @p's cpu, otherwise it is counted in %SCX_EV_SLICE_DENIED. Shortening is
9449 * always allowed. On the stashed path the slice is packed into an atomic64_t
9450 * with the scheduler id and a flag bit, so a slice too large to fit is clamped
9451 * and counted in %SCX_EV_SLICE_CLAMPED. %SCX_SLICE_INF is preserved.
9452 *
9453 * Return %true on success, %false if @p is not on the calling scheduler.
9454 */
scx_bpf_task_set_slice(struct task_struct * p,u64 slice,const struct bpf_prog_aux * aux)9455 __bpf_kfunc bool scx_bpf_task_set_slice(struct task_struct *p, u64 slice,
9456 const struct bpf_prog_aux *aux)
9457 {
9458 struct scx_sched *sch;
9459 struct rq *locked_rq;
9460
9461 guard(rcu)();
9462 sch = scx_prog_sched(aux);
9463 if (unlikely(!sch || !scx_task_on_sched(sch, p)))
9464 return false;
9465
9466 /*
9467 * Directly write only when we hold the lock of the rq @p is queued or
9468 * running on. See the write rules above.
9469 *
9470 * While @p is queued on a user DSQ or in the BPF scheduler,
9471 * synchronization is the scheduler's responsibility. This write can
9472 * race a concurrent dispatch's commit, see apply_slice_vtime().
9473 *
9474 * Making this kfunc always go through the oob stash would leave the
9475 * commit as the only direct writer and close the race, but that would
9476 * require two more oob application points - the dispatch keep-prev test
9477 * and the tick-time expiry check.
9478 */
9479 locked_rq = scx_locked_rq();
9480 if (!locked_rq ||
9481 (READ_ONCE(p->scx.runnable_cpu) != cpu_of(locked_rq) &&
9482 !task_current(locked_rq, p))) {
9483 set_task_slice_oob(sch, p, slice);
9484 return true;
9485 }
9486
9487 /* under the rq lock: apply now, extensions gated on baseline access */
9488 if (slice > p->scx.slice &&
9489 unlikely(scx_missing_caps(sch, cpu_of(locked_rq), SCX_CAP_BASE))) {
9490 __scx_add_event(sch, SCX_EV_SLICE_DENIED, 1);
9491 return true;
9492 }
9493
9494 if (unlikely(!scx_set_task_slice(p, slice)))
9495 __scx_add_event(sch, SCX_EV_SLICE_DENIED, 1);
9496
9497 return true;
9498 }
9499
9500 /**
9501 * scx_bpf_task_set_dsq_vtime - Set task's virtual time for DSQ ordering
9502 * @p: task of interest
9503 * @vtime: virtual time to set
9504 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9505 *
9506 * Set @p's virtual time to @vtime. Returns %true on success, %false if the
9507 * calling scheduler doesn't have authority over @p.
9508 */
scx_bpf_task_set_dsq_vtime(struct task_struct * p,u64 vtime,const struct bpf_prog_aux * aux)9509 __bpf_kfunc bool scx_bpf_task_set_dsq_vtime(struct task_struct *p, u64 vtime,
9510 const struct bpf_prog_aux *aux)
9511 {
9512 struct scx_sched *sch;
9513
9514 guard(rcu)();
9515 sch = scx_prog_sched(aux);
9516 if (unlikely(!sch || !scx_task_on_sched(sch, p)))
9517 return false;
9518
9519 p->scx.dsq_vtime = vtime;
9520 return true;
9521 }
9522
scx_kick_cpu(struct scx_sched * sch,s32 cpu,u64 flags)9523 void scx_kick_cpu(struct scx_sched *sch, s32 cpu, u64 flags)
9524 {
9525 struct scx_sched_pcpu *pcpu;
9526 struct rq *this_rq;
9527 unsigned long irq_flags;
9528
9529 /*
9530 * The per-cpu kick list is guarded only by local_irq_save(), which does
9531 * not mask NMIs, so kicking from NMI could corrupt it and is unsupported.
9532 */
9533 if (unlikely(in_nmi())) {
9534 scx_error(sch, "scx_bpf_kick_cpu() called from NMI");
9535 return;
9536 }
9537
9538 local_irq_save(irq_flags);
9539
9540 this_rq = this_rq();
9541 pcpu = this_cpu_ptr(sch->pcpu);
9542
9543 /*
9544 * While bypassing for PM ops, IRQ handling may not be online which can
9545 * lead to irq_work_queue() malfunction such as infinite busy wait for
9546 * IRQ status update. Suppress kicking.
9547 */
9548 if (scx_bypassing(sch, cpu_of(this_rq)))
9549 goto out;
9550
9551 /*
9552 * Actual kicking is bounced to kick_cpus_irq_workfn() to avoid nesting
9553 * rq locks. We can probably be smarter and avoid bouncing if called
9554 * from ops which don't hold a rq lock.
9555 *
9556 * The kick masks are owned by @sch->pcpu, so that a preempt kick can be
9557 * attributed to @sch.
9558 */
9559 if (flags & SCX_KICK_IDLE) {
9560 struct rq *target_rq = cpu_rq(cpu);
9561
9562 if (unlikely(flags & (SCX_KICK_PREEMPT | SCX_KICK_WAIT)))
9563 scx_error(sch, "PREEMPT/WAIT cannot be used with SCX_KICK_IDLE");
9564
9565 if (raw_spin_rq_trylock(target_rq)) {
9566 if (can_skip_idle_kick(target_rq)) {
9567 scx_rq_lock_drop(target_rq);
9568 raw_spin_rq_unlock(target_rq);
9569 goto out;
9570 }
9571 scx_rq_lock_drop(target_rq);
9572 raw_spin_rq_unlock(target_rq);
9573 }
9574 cpumask_set_cpu(cpu, pcpu->cpus_to_kick_if_idle);
9575 } else {
9576 cpumask_set_cpu(cpu, pcpu->cpus_to_kick);
9577
9578 if (flags & SCX_KICK_PREEMPT)
9579 cpumask_set_cpu(cpu, pcpu->cpus_to_preempt);
9580 if (flags & SCX_KICK_WAIT)
9581 cpumask_set_cpu(cpu, pcpu->cpus_to_wait);
9582 }
9583
9584 if (list_empty(&pcpu->to_kick_node))
9585 list_add_tail(&pcpu->to_kick_node, &this_rq->scx.sched_pcpus_to_kick);
9586 irq_work_queue(&this_rq->scx.kick_cpus_irq_work);
9587 out:
9588 local_irq_restore(irq_flags);
9589 }
9590
9591 /**
9592 * scx_bpf_kick_cpu - Trigger reschedule on a CPU
9593 * @cpu: cpu to kick
9594 * @flags: %SCX_KICK_* flags
9595 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9596 *
9597 * Kick @cpu into rescheduling. This can be used to wake up an idle CPU or
9598 * trigger rescheduling on a busy CPU. This can be called from any online
9599 * scx_ops operation and the actual kicking is performed asynchronously through
9600 * an irq work.
9601 */
scx_bpf_kick_cpu(s32 cpu,u64 flags,const struct bpf_prog_aux * aux)9602 __bpf_kfunc void scx_bpf_kick_cpu(s32 cpu, u64 flags, const struct bpf_prog_aux *aux)
9603 {
9604 struct scx_sched *sch;
9605
9606 guard(rcu)();
9607 sch = scx_prog_sched(aux);
9608 if (likely(sch) && scx_cpu_valid(sch, cpu, NULL))
9609 scx_kick_cpu(sch, cpu, flags);
9610 }
9611
9612 /**
9613 * scx_bpf_kick_cid - Trigger reschedule on the CPU mapped to @cid
9614 * @cid: cid to kick
9615 * @flags: %SCX_KICK_* flags
9616 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9617 *
9618 * cid-addressed equivalent of scx_bpf_kick_cpu(). An invalid @cid aborts the
9619 * scheduler via scx_cid_to_cpu(). Caps are enforced on the delivery path: a
9620 * kick is dropped if the caller lacks baseline access on @cid, and a
9621 * %SCX_KICK_PREEMPT degrades to a plain reschedule if the caller lacks
9622 * %SCX_CAP_PREEMPT for a task outside its subtree.
9623 */
scx_bpf_kick_cid(s32 cid,u64 flags,const struct bpf_prog_aux * aux)9624 __bpf_kfunc void scx_bpf_kick_cid(s32 cid, u64 flags, const struct bpf_prog_aux *aux)
9625 {
9626 struct scx_sched *sch;
9627 s32 cpu;
9628
9629 guard(rcu)();
9630 sch = scx_prog_sched(aux);
9631 if (unlikely(!sch))
9632 return;
9633 cpu = scx_cid_to_cpu(sch, cid);
9634 if (cpu < 0)
9635 return;
9636 scx_kick_cpu(sch, cpu, flags);
9637 }
9638
9639 /**
9640 * scx_bpf_dsq_nr_queued - Return the number of queued tasks
9641 * @dsq_id: id of the DSQ
9642 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9643 *
9644 * Return the number of tasks in the DSQ matching @dsq_id. If not found,
9645 * -%ENOENT is returned.
9646 *
9647 * %SCX_DSQ_LOCAL resolves to the local DSQ of the rq the current scheduler
9648 * operation is locked to - e.g. the rq being dispatched for in ops.dispatch() -
9649 * or the calling CPU's when no rq is locked.
9650 */
scx_bpf_dsq_nr_queued(u64 dsq_id,const struct bpf_prog_aux * aux)9651 __bpf_kfunc s32 scx_bpf_dsq_nr_queued(u64 dsq_id, const struct bpf_prog_aux *aux)
9652 {
9653 struct scx_sched *sch;
9654 struct scx_dispatch_q *dsq;
9655 s32 ret;
9656
9657 preempt_disable();
9658
9659 sch = scx_prog_sched(aux);
9660 if (unlikely(!sch)) {
9661 ret = -ENODEV;
9662 goto out;
9663 }
9664
9665 if (dsq_id == SCX_DSQ_LOCAL) {
9666 ret = READ_ONCE((scx_locked_rq() ?: this_rq())->scx.local_dsq.nr);
9667 goto out;
9668 } else if ((dsq_id & SCX_DSQ_LOCAL_ON) == SCX_DSQ_LOCAL_ON) {
9669 s32 cpu = scx_cpu_ret(sch, dsq_id & SCX_DSQ_LOCAL_CPU_MASK);
9670
9671 if (scx_cpu_valid(sch, cpu, NULL)) {
9672 ret = READ_ONCE(cpu_rq(cpu)->scx.local_dsq.nr);
9673 goto out;
9674 }
9675 } else {
9676 dsq = find_user_dsq(sch, dsq_id);
9677 if (dsq) {
9678 ret = READ_ONCE(dsq->nr);
9679 goto out;
9680 }
9681 }
9682 ret = -ENOENT;
9683 out:
9684 preempt_enable();
9685 return ret;
9686 }
9687
9688 /**
9689 * scx_bpf_destroy_dsq - Destroy a custom DSQ
9690 * @dsq_id: DSQ to destroy
9691 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9692 *
9693 * Destroy the custom DSQ identified by @dsq_id. Only DSQs created with
9694 * scx_bpf_create_dsq() can be destroyed. The caller must ensure that the DSQ is
9695 * empty and no further tasks are dispatched to it. Ignored if called on a DSQ
9696 * which doesn't exist. Can be called from any online scx_ops operations.
9697 */
scx_bpf_destroy_dsq(u64 dsq_id,const struct bpf_prog_aux * aux)9698 __bpf_kfunc void scx_bpf_destroy_dsq(u64 dsq_id, const struct bpf_prog_aux *aux)
9699 {
9700 struct scx_sched *sch;
9701
9702 guard(rcu)();
9703 sch = scx_prog_sched(aux);
9704 if (sch)
9705 destroy_dsq(sch, dsq_id);
9706 }
9707
9708 /**
9709 * bpf_iter_scx_dsq_new - Create a DSQ iterator
9710 * @it: iterator to initialize
9711 * @dsq_id: DSQ to iterate
9712 * @flags: %SCX_DSQ_ITER_*
9713 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9714 *
9715 * Initialize BPF iterator @it which can be used with bpf_for_each() to walk
9716 * tasks in the DSQ specified by @dsq_id. Iteration using @it only includes
9717 * tasks which are already queued when this function is invoked.
9718 */
bpf_iter_scx_dsq_new(struct bpf_iter_scx_dsq * it,u64 dsq_id,u64 flags,const struct bpf_prog_aux * aux)9719 __bpf_kfunc int bpf_iter_scx_dsq_new(struct bpf_iter_scx_dsq *it, u64 dsq_id,
9720 u64 flags, const struct bpf_prog_aux *aux)
9721 {
9722 struct bpf_iter_scx_dsq_kern *kit = (void *)it;
9723 struct scx_sched *sch;
9724
9725 BUILD_BUG_ON(sizeof(struct bpf_iter_scx_dsq_kern) >
9726 sizeof(struct bpf_iter_scx_dsq));
9727 BUILD_BUG_ON(__alignof__(struct bpf_iter_scx_dsq_kern) !=
9728 __alignof__(struct bpf_iter_scx_dsq));
9729 BUILD_BUG_ON(__SCX_DSQ_ITER_ALL_FLAGS &
9730 ((1U << __SCX_DSQ_LNODE_PRIV_SHIFT) - 1));
9731
9732 /*
9733 * next() and destroy() will be called regardless of the return value.
9734 * Always clear $kit->dsq.
9735 */
9736 kit->dsq = NULL;
9737
9738 sch = scx_prog_sched(aux);
9739 if (unlikely(!sch))
9740 return -ENODEV;
9741
9742 if (flags & ~__SCX_DSQ_ITER_USER_FLAGS)
9743 return -EINVAL;
9744
9745 kit->dsq = find_user_dsq(sch, dsq_id);
9746 if (!kit->dsq)
9747 return -ENOENT;
9748
9749 kit->cursor = INIT_DSQ_LIST_CURSOR(kit->cursor, kit->dsq, flags);
9750
9751 return 0;
9752 }
9753
9754 /**
9755 * bpf_iter_scx_dsq_next - Progress a DSQ iterator
9756 * @it: iterator to progress
9757 *
9758 * Return the next task. See bpf_iter_scx_dsq_new().
9759 */
bpf_iter_scx_dsq_next(struct bpf_iter_scx_dsq * it)9760 __bpf_kfunc struct task_struct *bpf_iter_scx_dsq_next(struct bpf_iter_scx_dsq *it)
9761 {
9762 struct bpf_iter_scx_dsq_kern *kit = (void *)it;
9763
9764 if (!kit->dsq)
9765 return NULL;
9766
9767 guard(raw_spinlock_irqsave)(&kit->dsq->lock);
9768
9769 return nldsq_cursor_next_task(&kit->cursor, kit->dsq);
9770 }
9771
9772 /**
9773 * bpf_iter_scx_dsq_destroy - Destroy a DSQ iterator
9774 * @it: iterator to destroy
9775 *
9776 * Undo bpf_iter_scx_dsq_new().
9777 */
bpf_iter_scx_dsq_destroy(struct bpf_iter_scx_dsq * it)9778 __bpf_kfunc void bpf_iter_scx_dsq_destroy(struct bpf_iter_scx_dsq *it)
9779 {
9780 struct bpf_iter_scx_dsq_kern *kit = (void *)it;
9781
9782 if (!kit->dsq)
9783 return;
9784
9785 if (!list_empty(&kit->cursor.node)) {
9786 unsigned long flags;
9787
9788 raw_spin_lock_irqsave(&kit->dsq->lock, flags);
9789 list_del_init(&kit->cursor.node);
9790 raw_spin_unlock_irqrestore(&kit->dsq->lock, flags);
9791 }
9792 kit->dsq = NULL;
9793 }
9794
9795 /**
9796 * scx_bpf_dsq_peek - Lockless peek at the first element.
9797 * @dsq_id: DSQ to examine.
9798 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9799 *
9800 * Read the first element in the DSQ. This is semantically equivalent to using
9801 * the DSQ iterator, but is lockfree. Of course, like any lockless operation,
9802 * this provides only a point-in-time snapshot, and the contents may change
9803 * by the time any subsequent locking operation reads the queue.
9804 *
9805 * Returns the pointer, or NULL indicates an empty queue OR internal error.
9806 */
scx_bpf_dsq_peek(u64 dsq_id,const struct bpf_prog_aux * aux)9807 __bpf_kfunc struct task_struct *scx_bpf_dsq_peek(u64 dsq_id,
9808 const struct bpf_prog_aux *aux)
9809 {
9810 struct scx_sched *sch;
9811 struct scx_dispatch_q *dsq;
9812
9813 sch = scx_prog_sched(aux);
9814 if (unlikely(!sch))
9815 return NULL;
9816
9817 if (unlikely(dsq_id & SCX_DSQ_FLAG_BUILTIN)) {
9818 scx_error(sch, "peek disallowed on builtin DSQ 0x%llx", dsq_id);
9819 return NULL;
9820 }
9821
9822 dsq = find_user_dsq(sch, dsq_id);
9823 if (unlikely(!dsq)) {
9824 scx_error(sch, "peek on non-existent DSQ 0x%llx", dsq_id);
9825 return NULL;
9826 }
9827
9828 return rcu_dereference(dsq->first_task);
9829 }
9830
9831 /**
9832 * scx_bpf_dsq_reenq - Re-enqueue tasks on a DSQ
9833 * @dsq_id: DSQ to re-enqueue
9834 * @reenq_flags: %SCX_RENQ_*
9835 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9836 *
9837 * Iterate over all of the tasks currently enqueued on the DSQ identified by
9838 * @dsq_id, and re-enqueue them in the BPF scheduler. The following DSQs are
9839 * supported:
9840 *
9841 * - Local DSQs (%SCX_DSQ_LOCAL or %SCX_DSQ_LOCAL_ON | $cpu)
9842 * - User DSQs
9843 *
9844 * Re-enqueues are performed asynchronously. Can be called from anywhere.
9845 *
9846 * %SCX_DSQ_LOCAL resolves to the local DSQ of the rq the current scheduler
9847 * operation is locked to - e.g. the rq being dispatched for in ops.dispatch() -
9848 * or the calling CPU's when no rq is locked.
9849 */
scx_bpf_dsq_reenq(u64 dsq_id,u64 reenq_flags,const struct bpf_prog_aux * aux)9850 __bpf_kfunc void scx_bpf_dsq_reenq(u64 dsq_id, u64 reenq_flags,
9851 const struct bpf_prog_aux *aux)
9852 {
9853 struct rq *locked_rq = scx_locked_rq();
9854 struct scx_sched *sch;
9855 struct scx_dispatch_q *dsq;
9856
9857 guard(preempt)();
9858
9859 sch = scx_prog_sched(aux);
9860 if (unlikely(!sch))
9861 return;
9862
9863 if (unlikely(reenq_flags & ~__SCX_REENQ_USER_MASK)) {
9864 scx_error(sch, "invalid SCX_REENQ flags 0x%llx", reenq_flags);
9865 return;
9866 }
9867
9868 /* not specifying any filter bits is the same as %SCX_REENQ_ANY */
9869 if (!(reenq_flags & __SCX_REENQ_FILTER_MASK))
9870 reenq_flags |= SCX_REENQ_ANY;
9871
9872 dsq = find_dsq_for_dispatch(sch, locked_rq ?: this_rq(), dsq_id, smp_processor_id());
9873 schedule_dsq_reenq(sch, dsq, reenq_flags, locked_rq);
9874 }
9875
9876 /**
9877 * scx_bpf_reenqueue_local___v2 - Re-enqueue tasks on a local DSQ
9878 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9879 *
9880 * Iterate over all of the tasks currently enqueued on the local DSQ of the
9881 * caller's CPU, and re-enqueue them in the BPF scheduler. Can be called from
9882 * anywhere.
9883 *
9884 * This is now a special case of scx_bpf_dsq_reenq() and may be removed in the
9885 * future.
9886 */
scx_bpf_reenqueue_local___v2(const struct bpf_prog_aux * aux)9887 __bpf_kfunc void scx_bpf_reenqueue_local___v2(const struct bpf_prog_aux *aux)
9888 {
9889 scx_bpf_dsq_reenq(SCX_DSQ_LOCAL, 0, aux);
9890 }
9891
9892 __bpf_kfunc_end_defs();
9893
9894 __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)9895 static s32 __bstr_format(struct scx_sched *sch, u64 *data_buf, char *line_buf,
9896 size_t line_size, char *fmt, unsigned long long *data,
9897 u32 data__sz)
9898 {
9899 struct bpf_bprintf_data bprintf_data = { .get_bin_args = true };
9900 s32 ret;
9901
9902 if (data__sz % 8 || data__sz > MAX_BPRINTF_VARARGS * 8 ||
9903 (data__sz && !data)) {
9904 scx_error(sch, "invalid data=%p and data__sz=%u", (void *)data, data__sz);
9905 return -EINVAL;
9906 }
9907
9908 ret = copy_from_kernel_nofault(data_buf, data, data__sz);
9909 if (ret < 0) {
9910 scx_error(sch, "failed to read data fields (%d)", ret);
9911 return ret;
9912 }
9913
9914 ret = bpf_bprintf_prepare(fmt, UINT_MAX, data_buf, data__sz / 8,
9915 &bprintf_data);
9916 if (ret < 0) {
9917 scx_error(sch, "format preparation failed (%d)", ret);
9918 return ret;
9919 }
9920
9921 ret = bstr_printf(line_buf, line_size, fmt,
9922 bprintf_data.bin_args);
9923 bpf_bprintf_cleanup(&bprintf_data);
9924 if (ret < 0) {
9925 scx_error(sch, "(\"%s\", %p, %u) failed to format", fmt, data, data__sz);
9926 return ret;
9927 }
9928
9929 return ret;
9930 }
9931
9932 /*
9933 * Exit @sch with the reason formatted from a BPF-supplied bstr format. The exit
9934 * is claimed first and the reason is formatted directly into the winner-owned
9935 * exit_info buffer, which allows use from any context including NMI.
9936 *
9937 * @fmt_blame is the sched blamed for formatting failures through the
9938 * scx_error() calls in __bstr_format() and differs from @sch when a parent
9939 * supplies the kill reason for a child. A formatting failure doesn't revert the
9940 * claim - @sch still exits with the claimed kind and a fallback message.
9941 */
9942 __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)9943 bool scx_exit_bstr(struct scx_sched *sch, enum scx_exit_kind kind,
9944 s64 exit_code, struct scx_sched *fmt_blame, char *fmt,
9945 unsigned long long *data, u32 data__sz)
9946 {
9947 struct scx_exit_info *ei = sch->exit_info;
9948 u64 data_buf[MAX_BPRINTF_VARARGS];
9949 s32 ret;
9950
9951 guard(preempt)();
9952
9953 if (!scx_claim_exit(sch, kind))
9954 return false;
9955
9956 ret = __bstr_format(fmt_blame, data_buf, ei->msg, SCX_EXIT_MSG_LEN,
9957 fmt, data, data__sz);
9958 if (ret < 0)
9959 scnprintf(ei->msg, SCX_EXIT_MSG_LEN,
9960 "exit message formatting failed (%d)", ret);
9961
9962 scx_finish_exit(sch, kind, exit_code, raw_smp_processor_id());
9963 return true;
9964 }
9965
9966 __bpf_kfunc_start_defs();
9967
9968 /**
9969 * scx_bpf_exit_bstr - Gracefully exit the BPF scheduler.
9970 * @exit_code: Exit value to pass to user space via struct scx_exit_info.
9971 * @fmt: error message format string
9972 * @data: format string parameters packaged using ___bpf_fill() macro
9973 * @data__sz: @data len, must end in '__sz' for the verifier
9974 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
9975 *
9976 * Indicate that the BPF scheduler wants to exit gracefully, and initiate ops
9977 * disabling.
9978 */
9979 __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)9980 __bpf_kfunc void scx_bpf_exit_bstr(s64 exit_code, char *fmt,
9981 unsigned long long *data, u32 data__sz,
9982 const struct bpf_prog_aux *aux)
9983 {
9984 struct scx_sched *sch;
9985
9986 guard(rcu)();
9987
9988 sch = scx_prog_sched(aux);
9989 if (likely(sch))
9990 scx_exit_bstr(sch, SCX_EXIT_UNREG_BPF, exit_code, sch, fmt,
9991 data, data__sz);
9992 }
9993
9994 /**
9995 * scx_bpf_error_bstr - Indicate fatal error
9996 * @fmt: error message format string
9997 * @data: format string parameters packaged using ___bpf_fill() macro
9998 * @data__sz: @data len, must end in '__sz' for the verifier
9999 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10000 *
10001 * Indicate that the BPF scheduler encountered a fatal error and initiate ops
10002 * disabling.
10003 */
10004 __printf(1, 0)
scx_bpf_error_bstr(char * fmt,unsigned long long * data,u32 data__sz,const struct bpf_prog_aux * aux)10005 __bpf_kfunc void scx_bpf_error_bstr(char *fmt, unsigned long long *data,
10006 u32 data__sz, const struct bpf_prog_aux *aux)
10007 {
10008 struct scx_sched *sch;
10009
10010 guard(rcu)();
10011
10012 sch = scx_prog_sched(aux);
10013 if (likely(sch))
10014 scx_exit_bstr(sch, SCX_EXIT_ERROR_BPF, 0, sch, fmt, data,
10015 data__sz);
10016 }
10017
10018 /**
10019 * scx_bpf_dump_bstr - Generate extra debug dump specific to the BPF scheduler
10020 * @fmt: format string
10021 * @data: format string parameters packaged using ___bpf_fill() macro
10022 * @data__sz: @data len, must end in '__sz' for the verifier
10023 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10024 *
10025 * To be called through scx_bpf_dump() helper from ops.dump(), dump_cpu() and
10026 * dump_task() to generate extra debug dump specific to the BPF scheduler.
10027 *
10028 * The extra dump may be multiple lines. A single line may be split over
10029 * multiple calls. The last line is automatically terminated.
10030 */
10031 __printf(1, 0)
scx_bpf_dump_bstr(char * fmt,unsigned long long * data,u32 data__sz,const struct bpf_prog_aux * aux)10032 __bpf_kfunc void scx_bpf_dump_bstr(char *fmt, unsigned long long *data,
10033 u32 data__sz, const struct bpf_prog_aux *aux)
10034 {
10035 struct scx_sched *sch;
10036 struct scx_dump_data *dd = &scx_dump_data;
10037 struct scx_bstr_buf *buf = &dd->buf;
10038 s32 ret;
10039
10040 guard(rcu)();
10041
10042 sch = scx_prog_sched(aux);
10043 if (unlikely(!sch))
10044 return;
10045
10046 if (raw_smp_processor_id() != dd->cpu) {
10047 scx_error(sch, "scx_bpf_dump() must only be called from ops.dump() and friends");
10048 return;
10049 }
10050
10051 /* append the formatted string to the line buf */
10052 ret = __bstr_format(sch, buf->data, buf->line + dd->cursor,
10053 sizeof(buf->line) - dd->cursor, fmt, data, data__sz);
10054 if (ret < 0) {
10055 scx_dump_line(dd->s, "%s[!] (\"%s\", %p, %u) failed to format (%d)",
10056 dd->prefix, fmt, data, data__sz, ret);
10057 return;
10058 }
10059
10060 dd->cursor += ret;
10061 dd->cursor = min_t(s32, dd->cursor, sizeof(buf->line));
10062
10063 if (!dd->cursor)
10064 return;
10065
10066 /*
10067 * If the line buf overflowed or ends in a newline, flush it into the
10068 * dump. This is to allow the caller to generate a single line over
10069 * multiple calls. As ops_dump_flush() can also handle multiple lines in
10070 * the line buf, the only case which can lead to an unexpected
10071 * truncation is when the caller keeps generating newlines in the middle
10072 * instead of the end consecutively. Don't do that.
10073 */
10074 if (dd->cursor >= sizeof(buf->line) || buf->line[dd->cursor - 1] == '\n')
10075 ops_dump_flush();
10076 }
10077
10078 /**
10079 * scx_bpf_cpuperf_cap - Query the maximum relative capacity of a CPU
10080 * @cpu: CPU of interest
10081 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10082 *
10083 * Return the maximum relative capacity of @cpu in relation to the most
10084 * performant CPU in the system. The return value is in the range [1,
10085 * %SCX_CPUPERF_ONE]. See scx_bpf_cpuperf_cur().
10086 */
scx_bpf_cpuperf_cap(s32 cpu,const struct bpf_prog_aux * aux)10087 __bpf_kfunc u32 scx_bpf_cpuperf_cap(s32 cpu, const struct bpf_prog_aux *aux)
10088 {
10089 struct scx_sched *sch;
10090
10091 guard(rcu)();
10092
10093 sch = scx_prog_sched(aux);
10094 if (likely(sch) && scx_cpu_valid(sch, cpu, NULL))
10095 return arch_scale_cpu_capacity(cpu);
10096 else
10097 return SCX_CPUPERF_ONE;
10098 }
10099
10100 /**
10101 * scx_bpf_cidperf_cap - Query the maximum relative capacity of the CPU at @cid
10102 * @cid: cid of the CPU to query
10103 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10104 *
10105 * cid-addressed equivalent of scx_bpf_cpuperf_cap().
10106 */
scx_bpf_cidperf_cap(s32 cid,const struct bpf_prog_aux * aux)10107 __bpf_kfunc u32 scx_bpf_cidperf_cap(s32 cid, const struct bpf_prog_aux *aux)
10108 {
10109 struct scx_sched *sch;
10110 s32 cpu;
10111
10112 guard(rcu)();
10113
10114 sch = scx_prog_sched(aux);
10115 if (unlikely(!sch))
10116 return SCX_CPUPERF_ONE;
10117 cpu = scx_cid_to_cpu(sch, cid);
10118 if (cpu < 0)
10119 return SCX_CPUPERF_ONE;
10120 return arch_scale_cpu_capacity(cpu);
10121 }
10122
10123 /**
10124 * scx_bpf_cpuperf_cur - Query the current relative performance of a CPU
10125 * @cpu: CPU of interest
10126 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10127 *
10128 * Return the current relative performance of @cpu in relation to its maximum.
10129 * The return value is in the range [1, %SCX_CPUPERF_ONE].
10130 *
10131 * The current performance level of a CPU in relation to the maximum performance
10132 * available in the system can be calculated as follows:
10133 *
10134 * scx_bpf_cpuperf_cap() * scx_bpf_cpuperf_cur() / %SCX_CPUPERF_ONE
10135 *
10136 * The result is in the range [1, %SCX_CPUPERF_ONE].
10137 */
scx_bpf_cpuperf_cur(s32 cpu,const struct bpf_prog_aux * aux)10138 __bpf_kfunc u32 scx_bpf_cpuperf_cur(s32 cpu, const struct bpf_prog_aux *aux)
10139 {
10140 struct scx_sched *sch;
10141
10142 guard(rcu)();
10143
10144 sch = scx_prog_sched(aux);
10145 if (likely(sch) && scx_cpu_valid(sch, cpu, NULL))
10146 return arch_scale_freq_capacity(cpu);
10147 else
10148 return SCX_CPUPERF_ONE;
10149 }
10150
10151 /**
10152 * scx_bpf_cidperf_cur - Query the current performance of the CPU at @cid
10153 * @cid: cid of the CPU to query
10154 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10155 *
10156 * cid-addressed equivalent of scx_bpf_cpuperf_cur().
10157 */
scx_bpf_cidperf_cur(s32 cid,const struct bpf_prog_aux * aux)10158 __bpf_kfunc u32 scx_bpf_cidperf_cur(s32 cid, const struct bpf_prog_aux *aux)
10159 {
10160 struct scx_sched *sch;
10161 s32 cpu;
10162
10163 guard(rcu)();
10164
10165 sch = scx_prog_sched(aux);
10166 if (unlikely(!sch))
10167 return SCX_CPUPERF_ONE;
10168 cpu = scx_cid_to_cpu(sch, cid);
10169 if (cpu < 0)
10170 return SCX_CPUPERF_ONE;
10171 return arch_scale_freq_capacity(cpu);
10172 }
10173
10174 /* validate and apply a cpuperf target, see scx_bpf_cpuperf_set() */
scx_cpuperf_set(struct scx_sched * sch,s32 cpu,u32 perf)10175 static s32 scx_cpuperf_set(struct scx_sched *sch, s32 cpu, u32 perf)
10176 {
10177 struct rq *rq, *locked_rq;
10178 struct rq_flags rf;
10179 s32 ret;
10180
10181 if (unlikely(perf > SCX_CPUPERF_ONE)) {
10182 scx_error(sch, "Invalid cpuperf target %u for CPU %d", perf, cpu);
10183 return -EINVAL;
10184 }
10185
10186 if (!scx_cpu_valid(sch, cpu, NULL))
10187 return -EINVAL;
10188
10189 rq = cpu_rq(cpu);
10190 locked_rq = scx_locked_rq();
10191
10192 /*
10193 * When called with an rq lock held, restrict the operation to the
10194 * corresponding CPU to prevent ABBA deadlocks.
10195 */
10196 if (locked_rq && rq != locked_rq) {
10197 scx_error(sch, "Invalid target CPU %d", cpu);
10198 return -EINVAL;
10199 }
10200
10201 /*
10202 * If no rq lock is held, allow to operate on any CPU by acquiring
10203 * the corresponding rq lock.
10204 */
10205 if (!locked_rq) {
10206 rq_lock_irqsave(rq, &rf);
10207 update_rq_clock(rq);
10208 }
10209
10210 /*
10211 * ecaps updates are folded under the rq lock, making this test
10212 * authoritative: a write can never land after a revoke has taken
10213 * effect on @cpu.
10214 */
10215 if (likely(!scx_missing_caps(sch, cpu, SCX_CAP_PERF))) {
10216 rq->scx.cpuperf_target = perf;
10217 cpufreq_update_util(rq, 0);
10218 ret = 0;
10219 } else {
10220 __scx_add_event(sch, SCX_EV_SUB_CIDPERF_DENIED, 1);
10221 ret = -EACCES;
10222 }
10223
10224 if (!locked_rq)
10225 rq_unlock_irqrestore(rq, &rf);
10226
10227 return ret;
10228 }
10229
10230 /**
10231 * scx_bpf_cpuperf_set - Set the relative performance target of a CPU
10232 * @cpu: CPU of interest
10233 * @perf: target performance level [0, %SCX_CPUPERF_ONE]
10234 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10235 *
10236 * Set the target performance level of @cpu to @perf. @perf is in linear
10237 * relative scale between 0 and %SCX_CPUPERF_ONE. This determines how the
10238 * schedutil cpufreq governor chooses the target frequency.
10239 *
10240 * The actual performance level chosen, CPU grouping, and the overhead and
10241 * latency of the operations are dependent on the hardware and cpufreq driver in
10242 * use. Consult hardware and cpufreq documentation for more information. The
10243 * current performance level can be monitored using scx_bpf_cpuperf_cur().
10244 */
scx_bpf_cpuperf_set(s32 cpu,u32 perf,const struct bpf_prog_aux * aux)10245 __bpf_kfunc void scx_bpf_cpuperf_set(s32 cpu, u32 perf, const struct bpf_prog_aux *aux)
10246 {
10247 struct scx_sched *sch;
10248
10249 guard(rcu)();
10250
10251 sch = scx_prog_sched(aux);
10252 if (unlikely(!sch))
10253 return;
10254
10255 scx_cpuperf_set(sch, cpu, perf);
10256 }
10257
10258 /**
10259 * scx_bpf_cidperf_set - Set the performance target of the CPU at @cid
10260 * @cid: cid of the CPU to target
10261 * @perf: target performance level [0, %SCX_CPUPERF_ONE]
10262 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10263 *
10264 * cid-addressed equivalent of scx_bpf_cpuperf_set(). A sub-sched needs
10265 * SCX_CAP_PERF on @cid. Returns 0 if the target was applied, -%EACCES if
10266 * the write was denied for missing caps, other -errnos if @cid didn't
10267 * resolve.
10268 */
scx_bpf_cidperf_set(s32 cid,u32 perf,const struct bpf_prog_aux * aux)10269 __bpf_kfunc s32 scx_bpf_cidperf_set(s32 cid, u32 perf,
10270 const struct bpf_prog_aux *aux)
10271 {
10272 struct scx_sched *sch;
10273 s32 cpu;
10274
10275 guard(rcu)();
10276
10277 sch = scx_prog_sched(aux);
10278 if (unlikely(!sch))
10279 return -ENODEV;
10280 cpu = scx_cid_to_cpu(sch, cid);
10281 if (cpu < 0)
10282 return cpu;
10283
10284 return scx_cpuperf_set(sch, cpu, perf);
10285 }
10286
10287 /**
10288 * scx_bpf_nr_node_ids - Return the number of possible node IDs
10289 *
10290 * All valid node IDs in the system are smaller than the returned value.
10291 */
scx_bpf_nr_node_ids(void)10292 __bpf_kfunc u32 scx_bpf_nr_node_ids(void)
10293 {
10294 return nr_node_ids;
10295 }
10296
10297 /**
10298 * scx_bpf_nr_cpu_ids - Return the number of possible CPU IDs
10299 *
10300 * All valid CPU IDs in the system are smaller than the returned value.
10301 */
scx_bpf_nr_cpu_ids(void)10302 __bpf_kfunc u32 scx_bpf_nr_cpu_ids(void)
10303 {
10304 return nr_cpu_ids;
10305 }
10306
10307 /**
10308 * scx_bpf_nr_cids - Return the size of the cid space
10309 *
10310 * Equals num_possible_cpus(). All valid cids are in [0, return value).
10311 */
scx_bpf_nr_cids(void)10312 __bpf_kfunc u32 scx_bpf_nr_cids(void)
10313 {
10314 return num_possible_cpus();
10315 }
10316
10317 /**
10318 * scx_bpf_nr_online_cids - Return current count of online CPUs in cid space
10319 *
10320 * Return num_online_cpus(). The standard model restarts the scheduler on
10321 * hotplug, which lets schedulers treat [0, nr_online_cids) as the online
10322 * range. Schedulers that prefer to handle hotplug without a restart should
10323 * install a custom mapping via scx_bpf_cid_override() and track onlining
10324 * through the ops.cid_online / ops.cid_offline callbacks.
10325 */
scx_bpf_nr_online_cids(void)10326 __bpf_kfunc u32 scx_bpf_nr_online_cids(void)
10327 {
10328 return num_online_cpus();
10329 }
10330
10331 /**
10332 * scx_bpf_this_cid - Return the cid of the CPU this program is running on
10333 *
10334 * cid-addressed equivalent of bpf_get_smp_processor_id() for scx programs.
10335 * The current cpu is trivially valid, so this is just a table lookup. Return
10336 * -EINVAL if called before any scheduler has ever published its cid tables.
10337 */
scx_bpf_this_cid(void)10338 __bpf_kfunc s32 scx_bpf_this_cid(void)
10339 {
10340 s16 *tbl;
10341
10342 guard(rcu)();
10343
10344 tbl = rcu_dereference(scx_cpu_to_cid_tbl);
10345 if (!tbl)
10346 return -EINVAL;
10347 return tbl[raw_smp_processor_id()];
10348 }
10349
10350 /**
10351 * scx_bpf_get_possible_cpumask - Get a referenced kptr to cpu_possible_mask
10352 */
scx_bpf_get_possible_cpumask(void)10353 __bpf_kfunc const struct cpumask *scx_bpf_get_possible_cpumask(void)
10354 {
10355 return cpu_possible_mask;
10356 }
10357
10358 /**
10359 * scx_bpf_get_online_cpumask - Get a referenced kptr to cpu_online_mask
10360 */
scx_bpf_get_online_cpumask(void)10361 __bpf_kfunc const struct cpumask *scx_bpf_get_online_cpumask(void)
10362 {
10363 return cpu_online_mask;
10364 }
10365
10366 /**
10367 * scx_bpf_put_cpumask - Release a possible/online cpumask
10368 * @cpumask: cpumask to release
10369 */
scx_bpf_put_cpumask(const struct cpumask * cpumask)10370 __bpf_kfunc void scx_bpf_put_cpumask(const struct cpumask *cpumask)
10371 {
10372 /*
10373 * Empty function body because we aren't actually acquiring or releasing
10374 * a reference to a global cpumask, which is read-only in the caller and
10375 * is never released. The acquire / release semantics here are just used
10376 * to make the cpumask is a trusted pointer in the caller.
10377 */
10378 }
10379
10380 /**
10381 * scx_bpf_task_running - Is task currently running?
10382 * @p: task of interest
10383 */
scx_bpf_task_running(const struct task_struct * p)10384 __bpf_kfunc bool scx_bpf_task_running(const struct task_struct *p)
10385 {
10386 return task_rq(p)->curr == p;
10387 }
10388
10389 /**
10390 * scx_bpf_task_cpu - CPU a task is currently associated with
10391 * @p: task of interest
10392 */
scx_bpf_task_cpu(const struct task_struct * p)10393 __bpf_kfunc s32 scx_bpf_task_cpu(const struct task_struct *p)
10394 {
10395 return task_cpu(p);
10396 }
10397
10398 /**
10399 * scx_bpf_task_cid - cid a task is currently associated with
10400 * @p: task of interest
10401 *
10402 * cid-addressed equivalent of scx_bpf_task_cpu(). task_cpu(p) is always a
10403 * valid cpu, so this is just a table lookup. Return -EINVAL if called before
10404 * any scheduler has ever published its cid tables.
10405 */
scx_bpf_task_cid(const struct task_struct * p)10406 __bpf_kfunc s32 scx_bpf_task_cid(const struct task_struct *p)
10407 {
10408 s16 *tbl;
10409
10410 /* KF_RCU covers only @p - a sleepable program holds no RCU lock */
10411 guard(rcu)();
10412
10413 tbl = rcu_dereference(scx_cpu_to_cid_tbl);
10414 if (!tbl)
10415 return -EINVAL;
10416 return tbl[task_cpu(p)];
10417 }
10418
10419 /**
10420 * scx_bpf_locked_rq - Return the rq currently locked by SCX
10421 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10422 *
10423 * Returns the rq if a rq lock is currently held by SCX.
10424 * Otherwise emits an error and returns NULL.
10425 */
scx_bpf_locked_rq(const struct bpf_prog_aux * aux)10426 __bpf_kfunc struct rq *scx_bpf_locked_rq(const struct bpf_prog_aux *aux)
10427 {
10428 struct scx_sched *sch;
10429 struct rq *rq;
10430
10431 guard(preempt)();
10432
10433 sch = scx_prog_sched(aux);
10434 if (unlikely(!sch))
10435 return NULL;
10436
10437 rq = scx_locked_rq();
10438 if (!rq) {
10439 scx_error(sch, "accessing rq without holding rq lock");
10440 return NULL;
10441 }
10442
10443 return rq;
10444 }
10445
10446 /**
10447 * scx_bpf_cpu_curr - Return remote CPU's curr task
10448 * @cpu: CPU of interest
10449 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10450 *
10451 * Callers must hold RCU read lock (KF_RCU).
10452 */
scx_bpf_cpu_curr(s32 cpu,const struct bpf_prog_aux * aux)10453 __bpf_kfunc struct task_struct *scx_bpf_cpu_curr(s32 cpu, const struct bpf_prog_aux *aux)
10454 {
10455 struct scx_sched *sch;
10456
10457 guard(rcu)();
10458
10459 sch = scx_prog_sched(aux);
10460 if (unlikely(!sch))
10461 return NULL;
10462
10463 if (!scx_cpu_valid(sch, cpu, NULL))
10464 return NULL;
10465
10466 return rcu_dereference(cpu_rq(cpu)->curr);
10467 }
10468
10469 /**
10470 * scx_bpf_cid_curr - Return the curr task on the CPU at @cid
10471 * @cid: cid of interest
10472 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10473 *
10474 * cid-addressed equivalent of scx_bpf_cpu_curr(). Callers must hold RCU
10475 * read lock (KF_RCU).
10476 */
scx_bpf_cid_curr(s32 cid,const struct bpf_prog_aux * aux)10477 __bpf_kfunc struct task_struct *scx_bpf_cid_curr(s32 cid, const struct bpf_prog_aux *aux)
10478 {
10479 struct scx_sched *sch;
10480 s32 cpu;
10481
10482 guard(rcu)();
10483
10484 sch = scx_prog_sched(aux);
10485 if (unlikely(!sch))
10486 return NULL;
10487 cpu = scx_cid_to_cpu(sch, cid);
10488 if (cpu < 0)
10489 return NULL;
10490 return rcu_dereference(cpu_rq(cpu)->curr);
10491 }
10492
10493 /**
10494 * scx_bpf_tid_to_task - Look up a task by its scx tid
10495 * @tid: task ID previously read from p->scx.tid
10496 *
10497 * Returns the task with the given tid, or NULL if no such task exists. The
10498 * returned pointer is valid until the end of the current RCU read section
10499 * (KF_RCU_PROTECTED). Requires SCX_OPS_TID_TO_TASK to be set on the root
10500 * scheduler; otherwise an error is raised and NULL returned.
10501 */
scx_bpf_tid_to_task(u64 tid)10502 __bpf_kfunc struct task_struct *scx_bpf_tid_to_task(u64 tid)
10503 {
10504 struct sched_ext_entity *scx;
10505
10506 if (!scx_tid_to_task_enabled()) {
10507 struct scx_sched *sch = rcu_dereference(scx_root);
10508
10509 if (sch)
10510 scx_error(sch, "scx_bpf_tid_to_task() called without SCX_OPS_TID_TO_TASK");
10511 return NULL;
10512 }
10513
10514 scx = rhashtable_lookup(&scx_tid_hash, &tid, scx_tid_hash_params);
10515 if (!scx)
10516 return NULL;
10517
10518 return container_of(scx, struct task_struct, scx);
10519 }
10520
__scx_bpf_now(struct rq * rq)10521 u64 __scx_bpf_now(struct rq *rq)
10522 {
10523 /* the caller must be on @rq's cpu or hold its lock */
10524 lockdep_assert((rq == this_rq() && !preemptible()) ||
10525 lockdep_is_held(__rq_lockp(rq)));
10526
10527 if (smp_load_acquire(&rq->scx.flags) & SCX_RQ_CLK_VALID) {
10528 /* if the rq clock is valid, use the cached rq clock */
10529 return READ_ONCE(rq->scx.clock);
10530 } else {
10531 /*
10532 * Otherwise, return a fresh rq clock.
10533 *
10534 * The rq clock is updated outside of the rq lock.
10535 * In this case, keep the updated rq clock invalid so the next
10536 * read outside the rq lock gets a fresh rq clock.
10537 */
10538 return sched_clock_cpu(cpu_of(rq));
10539 }
10540 }
10541
10542 /**
10543 * scx_bpf_now - Returns a high-performance monotonically non-decreasing
10544 * clock for the current CPU. The clock returned is in nanoseconds.
10545 *
10546 * It provides the following properties:
10547 *
10548 * 1) High performance: Many BPF schedulers call bpf_ktime_get_ns() frequently
10549 * to account for execution time and track tasks' runtime properties.
10550 * Unfortunately, in some hardware platforms, bpf_ktime_get_ns() -- which
10551 * eventually reads a hardware timestamp counter -- is neither performant nor
10552 * scalable. scx_bpf_now() aims to provide a high-performance clock by
10553 * using the rq clock in the scheduler core whenever possible.
10554 *
10555 * 2) High enough resolution for the BPF scheduler use cases: In most BPF
10556 * scheduler use cases, the required clock resolution is lower than the most
10557 * accurate hardware clock (e.g., rdtsc in x86). scx_bpf_now() basically
10558 * uses the rq clock in the scheduler core whenever it is valid. It considers
10559 * that the rq clock is valid from the time the rq clock is updated
10560 * (update_rq_clock) until the rq is unlocked (rq_unpin_lock).
10561 *
10562 * 3) Monotonically non-decreasing clock for the same CPU: scx_bpf_now()
10563 * guarantees the clock never goes backward when comparing them in the same
10564 * CPU. On the other hand, when comparing clocks in different CPUs, there
10565 * is no such guarantee -- the clock can go backward. It provides a
10566 * monotonically *non-decreasing* clock so that it would provide the same
10567 * clock values in two different scx_bpf_now() calls in the same CPU
10568 * during the same period of when the rq clock is valid.
10569 */
scx_bpf_now(void)10570 __bpf_kfunc u64 scx_bpf_now(void)
10571 {
10572 /*
10573 * Note that scx_bpf_now() is re-entrant between a process context and
10574 * an interrupt context (e.g., timer interrupt). However, we don't need
10575 * to consider the race between them because such race is not observable
10576 * from a caller.
10577 */
10578 guard(preempt)();
10579 return __scx_bpf_now(this_rq());
10580 }
10581
scx_read_events(struct scx_sched * sch,struct scx_event_stats * events)10582 static void scx_read_events(struct scx_sched *sch, struct scx_event_stats *events)
10583 {
10584 int cpu;
10585
10586 /* Aggregate per-CPU event counters into @events. */
10587 memset(events, 0, sizeof(*events));
10588 for_each_possible_cpu(cpu) {
10589 struct scx_event_stats *e_cpu = &per_cpu_ptr(sch->pcpu, cpu)->event_stats;
10590 #define SCX_EVENT(name) (events->name += READ_ONCE(e_cpu->name))
10591 SCX_EVENTS_LIST(SCX_EVENT);
10592 #undef SCX_EVENT
10593 }
10594 }
10595
10596 /**
10597 * scx_bpf_events - Read the event counters of the calling scheduler
10598 * @events: output buffer from a BPF program
10599 * @events__sz: @events len, must end in '__sz' for the verifier
10600 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10601 *
10602 * Read the event counters of the scheduler associated with the calling program.
10603 * @events is zeroed when no scheduler can be resolved.
10604 */
scx_bpf_events(struct scx_event_stats * events,size_t events__sz,const struct bpf_prog_aux * aux)10605 __bpf_kfunc void scx_bpf_events(struct scx_event_stats *events, size_t events__sz,
10606 const struct bpf_prog_aux *aux)
10607 {
10608 struct scx_sched *sch;
10609 struct scx_event_stats e_sys;
10610
10611 rcu_read_lock();
10612 sch = scx_prog_sched(aux);
10613 if (sch)
10614 scx_read_events(sch, &e_sys);
10615 else
10616 memset(&e_sys, 0, sizeof(e_sys));
10617 rcu_read_unlock();
10618
10619 /*
10620 * We cannot entirely trust a BPF-provided size since a BPF program
10621 * might be compiled against a different vmlinux.h, of which
10622 * scx_event_stats would be larger (a newer vmlinux.h) or smaller
10623 * (an older vmlinux.h). Hence, we use the smaller size to avoid
10624 * memory corruption.
10625 */
10626 events__sz = min(events__sz, sizeof(*events));
10627 memcpy(events, &e_sys, events__sz);
10628 }
10629
10630 #ifdef CONFIG_CGROUP_SCHED
10631 /**
10632 * scx_bpf_task_cgroup - Return the sched cgroup of a task
10633 * @p: task of interest
10634 * @aux: implicit BPF argument to access bpf_prog_aux hidden from BPF progs
10635 *
10636 * @p->sched_task_group->css.cgroup represents the cgroup @p is associated with
10637 * from the scheduler's POV. SCX operations should use this function to
10638 * determine @p's current cgroup as, unlike following @p->cgroups,
10639 * @p->sched_task_group is stable for the duration of the SCX op. See
10640 * SCX_CALL_OP_TASK() for details.
10641 */
scx_bpf_task_cgroup(struct task_struct * p,const struct bpf_prog_aux * aux)10642 __bpf_kfunc struct cgroup *scx_bpf_task_cgroup(struct task_struct *p,
10643 const struct bpf_prog_aux *aux)
10644 {
10645 struct task_group *tg = p->sched_task_group;
10646 struct cgroup *cgrp = &cgrp_dfl_root.cgrp;
10647 struct scx_sched *sch;
10648
10649 guard(rcu)();
10650
10651 sch = scx_prog_sched(aux);
10652 if (unlikely(!sch))
10653 goto out;
10654
10655 if (!scx_kf_arg_task_ok(sch, p))
10656 goto out;
10657
10658 cgrp = tg_cgrp(tg);
10659
10660 out:
10661 cgroup_get(cgrp);
10662 return cgrp;
10663 }
10664 #endif /* CONFIG_CGROUP_SCHED */
10665
10666 __bpf_kfunc_end_defs();
10667
10668 BTF_KFUNCS_START(scx_kfunc_ids_any)
10669 BTF_ID_FLAGS(func, scx_bpf_task_set_slice, KF_IMPLICIT_ARGS | KF_RCU);
10670 BTF_ID_FLAGS(func, scx_bpf_task_set_dsq_vtime, KF_IMPLICIT_ARGS | KF_RCU);
10671 BTF_ID_FLAGS(func, scx_bpf_kick_cpu, KF_IMPLICIT_ARGS)
10672 BTF_ID_FLAGS(func, scx_bpf_kick_cid, KF_IMPLICIT_ARGS)
10673 BTF_ID_FLAGS(func, scx_bpf_dsq_nr_queued, KF_IMPLICIT_ARGS)
10674 BTF_ID_FLAGS(func, scx_bpf_destroy_dsq, KF_IMPLICIT_ARGS)
10675 BTF_ID_FLAGS(func, scx_bpf_dsq_peek, KF_IMPLICIT_ARGS | KF_RCU_PROTECTED | KF_RET_NULL)
10676 BTF_ID_FLAGS(func, scx_bpf_dsq_reenq, KF_IMPLICIT_ARGS)
10677 BTF_ID_FLAGS(func, scx_bpf_reenqueue_local___v2, KF_IMPLICIT_ARGS)
10678 BTF_ID_FLAGS(func, bpf_iter_scx_dsq_new, KF_IMPLICIT_ARGS | KF_ITER_NEW | KF_RCU_PROTECTED)
10679 BTF_ID_FLAGS(func, bpf_iter_scx_dsq_next, KF_ITER_NEXT | KF_RET_NULL)
10680 BTF_ID_FLAGS(func, bpf_iter_scx_dsq_destroy, KF_ITER_DESTROY)
10681 BTF_ID_FLAGS(func, scx_bpf_exit_bstr, KF_IMPLICIT_ARGS)
10682 BTF_ID_FLAGS(func, scx_bpf_error_bstr, KF_IMPLICIT_ARGS)
10683 BTF_ID_FLAGS(func, scx_bpf_dump_bstr, KF_IMPLICIT_ARGS)
10684 BTF_ID_FLAGS(func, scx_bpf_cpuperf_cap, KF_IMPLICIT_ARGS)
10685 BTF_ID_FLAGS(func, scx_bpf_cpuperf_cur, KF_IMPLICIT_ARGS)
10686 BTF_ID_FLAGS(func, scx_bpf_cpuperf_set, KF_IMPLICIT_ARGS)
10687 BTF_ID_FLAGS(func, scx_bpf_cidperf_cap, KF_IMPLICIT_ARGS)
10688 BTF_ID_FLAGS(func, scx_bpf_cidperf_cur, KF_IMPLICIT_ARGS)
10689 BTF_ID_FLAGS(func, scx_bpf_cidperf_set, KF_IMPLICIT_ARGS)
10690 BTF_ID_FLAGS(func, scx_bpf_nr_node_ids)
10691 BTF_ID_FLAGS(func, scx_bpf_nr_cpu_ids)
10692 BTF_ID_FLAGS(func, scx_bpf_nr_cids)
10693 BTF_ID_FLAGS(func, scx_bpf_nr_online_cids)
10694 BTF_ID_FLAGS(func, scx_bpf_this_cid)
10695 BTF_ID_FLAGS(func, scx_bpf_get_possible_cpumask, KF_ACQUIRE)
10696 BTF_ID_FLAGS(func, scx_bpf_get_online_cpumask, KF_ACQUIRE)
10697 BTF_ID_FLAGS(func, scx_bpf_put_cpumask, KF_RELEASE)
10698 BTF_ID_FLAGS(func, scx_bpf_task_running, KF_RCU)
10699 BTF_ID_FLAGS(func, scx_bpf_task_cpu, KF_RCU)
10700 BTF_ID_FLAGS(func, scx_bpf_task_cid, KF_RCU)
10701 BTF_ID_FLAGS(func, scx_bpf_locked_rq, KF_IMPLICIT_ARGS | KF_RET_NULL)
10702 BTF_ID_FLAGS(func, scx_bpf_cpu_curr, KF_IMPLICIT_ARGS | KF_RET_NULL | KF_RCU_PROTECTED)
10703 BTF_ID_FLAGS(func, scx_bpf_cid_curr, KF_IMPLICIT_ARGS | KF_RET_NULL | KF_RCU_PROTECTED)
10704 BTF_ID_FLAGS(func, scx_bpf_tid_to_task, KF_RET_NULL | KF_RCU_PROTECTED)
10705 BTF_ID_FLAGS(func, scx_bpf_now)
10706 BTF_ID_FLAGS(func, scx_bpf_events, KF_IMPLICIT_ARGS)
10707 #ifdef CONFIG_CGROUP_SCHED
10708 BTF_ID_FLAGS(func, scx_bpf_task_cgroup, KF_IMPLICIT_ARGS | KF_RCU | KF_ACQUIRE)
10709 #endif
10710 BTF_ID_FLAGS(func, scx_bpf_sub_grant, KF_IMPLICIT_ARGS)
10711 BTF_ID_FLAGS(func, scx_bpf_sub_revoke, KF_IMPLICIT_ARGS)
10712 BTF_ID_FLAGS(func, scx_bpf_sub_caps, KF_IMPLICIT_ARGS)
10713 BTF_ID_FLAGS(func, scx_bpf_sub_kill_bstr, KF_IMPLICIT_ARGS)
10714 BTF_KFUNCS_END(scx_kfunc_ids_any)
10715
10716 static const struct btf_kfunc_id_set scx_kfunc_set_any = {
10717 .owner = THIS_MODULE,
10718 .set = &scx_kfunc_ids_any,
10719 .filter = scx_kfunc_context_filter,
10720 };
10721
10722 /*
10723 * cpu-form kfuncs that are forbidden from cid-form schedulers
10724 * (bpf_sched_ext_ops_cid). Programs targeting the cid struct_ops type must
10725 * use the cid-form alternative (cid/cmask kfuncs).
10726 *
10727 * Membership overlaps with scx_kfunc_ids_{any,idle,select_cpu}; the filter
10728 * tests this set independently and rejects matches before the per-op
10729 * allow-list check runs.
10730 *
10731 * pahole/resolve_btfids scans every BTF_ID_FLAGS() at build time and
10732 * intersects flags across duplicate entries, so each entry must carry the
10733 * same flags as the kfunc's primary declaration; otherwise the flags get
10734 * dropped globally.
10735 */
10736 BTF_KFUNCS_START(scx_kfunc_ids_cpu_only)
10737 BTF_ID_FLAGS(func, scx_bpf_kick_cpu, KF_IMPLICIT_ARGS)
10738 BTF_ID_FLAGS(func, scx_bpf_task_cpu, KF_RCU)
10739 BTF_ID_FLAGS(func, scx_bpf_cpu_curr, KF_IMPLICIT_ARGS | KF_RET_NULL | KF_RCU_PROTECTED)
10740 BTF_ID_FLAGS(func, scx_bpf_cpu_node, KF_IMPLICIT_ARGS)
10741 BTF_ID_FLAGS(func, scx_bpf_cpuperf_cap, KF_IMPLICIT_ARGS)
10742 BTF_ID_FLAGS(func, scx_bpf_cpuperf_cur, KF_IMPLICIT_ARGS)
10743 BTF_ID_FLAGS(func, scx_bpf_cpuperf_set, KF_IMPLICIT_ARGS)
10744 BTF_ID_FLAGS(func, scx_bpf_get_possible_cpumask, KF_ACQUIRE)
10745 BTF_ID_FLAGS(func, scx_bpf_get_online_cpumask, KF_ACQUIRE)
10746 BTF_ID_FLAGS(func, scx_bpf_put_cpumask, KF_RELEASE)
10747 BTF_ID_FLAGS(func, scx_bpf_select_cpu_dfl, KF_IMPLICIT_ARGS | KF_RCU)
10748 BTF_ID_FLAGS(func, __scx_bpf_select_cpu_and, KF_IMPLICIT_ARGS | KF_RCU)
10749 BTF_ID_FLAGS(func, scx_bpf_select_cpu_and, KF_RCU)
10750 BTF_ID_FLAGS(func, scx_bpf_get_idle_cpumask, KF_IMPLICIT_ARGS | KF_ACQUIRE)
10751 BTF_ID_FLAGS(func, scx_bpf_get_idle_cpumask_node, KF_IMPLICIT_ARGS | KF_ACQUIRE)
10752 BTF_ID_FLAGS(func, scx_bpf_get_idle_smtmask, KF_IMPLICIT_ARGS | KF_ACQUIRE)
10753 BTF_ID_FLAGS(func, scx_bpf_get_idle_smtmask_node, KF_IMPLICIT_ARGS | KF_ACQUIRE)
10754 BTF_ID_FLAGS(func, scx_bpf_put_idle_cpumask, KF_RELEASE)
10755 BTF_ID_FLAGS(func, scx_bpf_test_and_clear_cpu_idle, KF_IMPLICIT_ARGS)
10756 BTF_ID_FLAGS(func, scx_bpf_pick_idle_cpu, KF_IMPLICIT_ARGS | KF_RCU)
10757 BTF_ID_FLAGS(func, scx_bpf_pick_idle_cpu_node, KF_IMPLICIT_ARGS | KF_RCU)
10758 BTF_ID_FLAGS(func, scx_bpf_pick_any_cpu, KF_IMPLICIT_ARGS | KF_RCU)
10759 BTF_ID_FLAGS(func, scx_bpf_pick_any_cpu_node, KF_IMPLICIT_ARGS | KF_RCU)
10760 BTF_KFUNCS_END(scx_kfunc_ids_cpu_only)
10761
10762 /*
10763 * Per-op kfunc allow flags. Each bit corresponds to a context-sensitive kfunc
10764 * group; an op may permit zero or more groups, with the union expressed in
10765 * scx_kf_allow_flags[]. The verifier-time filter (scx_kfunc_context_filter())
10766 * consults this table to decide whether a context-sensitive kfunc is callable
10767 * from a given SCX op.
10768 */
10769 enum scx_kf_allow_flags {
10770 SCX_KF_ALLOW_UNLOCKED = 1 << 0,
10771 SCX_KF_ALLOW_INIT_CIDS = 1 << 1,
10772 SCX_KF_ALLOW_CPU_RELEASE = 1 << 2,
10773 SCX_KF_ALLOW_DISPATCH = 1 << 3,
10774 SCX_KF_ALLOW_ENQUEUE = 1 << 4,
10775 SCX_KF_ALLOW_SELECT_CPU = 1 << 5,
10776 };
10777
10778 /*
10779 * Map each SCX op to the union of kfunc groups it permits, indexed by
10780 * SCX_OP_IDX(op). Ops not listed only permit kfuncs that are not
10781 * context-sensitive.
10782 */
10783 static const u32 scx_kf_allow_flags[] = {
10784 [SCX_OP_IDX(select_cpu)] = SCX_KF_ALLOW_SELECT_CPU | SCX_KF_ALLOW_ENQUEUE,
10785 [SCX_OP_IDX(enqueue)] = SCX_KF_ALLOW_SELECT_CPU | SCX_KF_ALLOW_ENQUEUE,
10786 [SCX_OP_IDX(dispatch)] = SCX_KF_ALLOW_ENQUEUE | SCX_KF_ALLOW_DISPATCH,
10787 [SCX_OP_IDX(cpu_release)] = SCX_KF_ALLOW_CPU_RELEASE,
10788 [SCX_OP_IDX(init_task)] = SCX_KF_ALLOW_UNLOCKED,
10789 [SCX_OP_IDX(dump)] = SCX_KF_ALLOW_UNLOCKED,
10790 #ifdef CONFIG_EXT_GROUP_SCHED
10791 [SCX_OP_IDX(cgroup_init)] = SCX_KF_ALLOW_UNLOCKED,
10792 [SCX_OP_IDX(cgroup_exit)] = SCX_KF_ALLOW_UNLOCKED,
10793 [SCX_OP_IDX(cgroup_prep_move)] = SCX_KF_ALLOW_UNLOCKED,
10794 [SCX_OP_IDX(cgroup_cancel_move)] = SCX_KF_ALLOW_UNLOCKED,
10795 [SCX_OP_IDX(cgroup_set_weight)] = SCX_KF_ALLOW_UNLOCKED,
10796 [SCX_OP_IDX(cgroup_set_bandwidth)] = SCX_KF_ALLOW_UNLOCKED,
10797 [SCX_OP_IDX(cgroup_set_idle)] = SCX_KF_ALLOW_UNLOCKED,
10798 #endif /* CONFIG_EXT_GROUP_SCHED */
10799 [SCX_OP_IDX(sub_attach)] = SCX_KF_ALLOW_UNLOCKED,
10800 [SCX_OP_IDX(sub_detach)] = SCX_KF_ALLOW_UNLOCKED,
10801 [SCX_OP_IDX(sub_ecaps_updated)] = SCX_KF_ALLOW_ENQUEUE | SCX_KF_ALLOW_DISPATCH,
10802 [SCX_OP_IDX(cpu_online)] = SCX_KF_ALLOW_UNLOCKED,
10803 [SCX_OP_IDX(cpu_offline)] = SCX_KF_ALLOW_UNLOCKED,
10804 [SCX_OP_IDX(init_cids)] = SCX_KF_ALLOW_UNLOCKED | SCX_KF_ALLOW_INIT_CIDS,
10805 [SCX_OP_IDX(init)] = SCX_KF_ALLOW_UNLOCKED,
10806 [SCX_OP_IDX(exit)] = SCX_KF_ALLOW_UNLOCKED,
10807 };
10808
10809 /*
10810 * Verifier-time filter for SCX kfuncs. Registered via the .filter field on
10811 * each per-group btf_kfunc_id_set. The BPF core invokes this for every kfunc
10812 * call in the registered hook (BPF_PROG_TYPE_STRUCT_OPS or
10813 * BPF_PROG_TYPE_SYSCALL), regardless of which set originally introduced the
10814 * kfunc - so the filter must short-circuit on kfuncs it doesn't govern by
10815 * falling through to "allow" when none of the SCX sets contain the kfunc.
10816 */
scx_kfunc_context_filter(const struct bpf_prog * prog,u32 kfunc_id)10817 int scx_kfunc_context_filter(const struct bpf_prog *prog, u32 kfunc_id)
10818 {
10819 bool in_unlocked = btf_id_set8_contains(&scx_kfunc_ids_unlocked, kfunc_id);
10820 bool in_init_cids = btf_id_set8_contains(&scx_kfunc_ids_init_cids, kfunc_id);
10821 bool in_select_cpu = btf_id_set8_contains(&scx_kfunc_ids_select_cpu, kfunc_id);
10822 bool in_enqueue = btf_id_set8_contains(&scx_kfunc_ids_enqueue_dispatch, kfunc_id);
10823 bool in_dispatch = btf_id_set8_contains(&scx_kfunc_ids_dispatch, kfunc_id);
10824 bool in_cpu_release = btf_id_set8_contains(&scx_kfunc_ids_cpu_release, kfunc_id);
10825 bool in_idle = btf_id_set8_contains(&scx_kfunc_ids_idle, kfunc_id);
10826 bool in_any = btf_id_set8_contains(&scx_kfunc_ids_any, kfunc_id);
10827 bool in_cpu_only = btf_id_set8_contains(&scx_kfunc_ids_cpu_only, kfunc_id);
10828 bool in_cid = btf_id_set8_contains(&scx_kfunc_ids_cid, kfunc_id);
10829 u32 moff, flags;
10830
10831 /* Not an SCX kfunc - allow. */
10832 if (!(in_unlocked || in_init_cids || in_select_cpu || in_enqueue || in_dispatch ||
10833 in_cpu_release || in_idle || in_any || in_cid))
10834 return 0;
10835
10836 /* SYSCALL progs (e.g. BPF test_run()) may call unlocked and select_cpu kfuncs. */
10837 if (prog->type == BPF_PROG_TYPE_SYSCALL)
10838 return (in_unlocked || in_select_cpu || in_idle || in_any || in_cid) ? 0 : -EACCES;
10839
10840 if (prog->type != BPF_PROG_TYPE_STRUCT_OPS)
10841 return (in_any || in_idle || in_cid) ? 0 : -EACCES;
10842
10843 /*
10844 * add_subprog_and_kfunc() collects all kfunc calls, including dead code
10845 * guarded by bpf_ksym_exists(), before check_attach_btf_id() sets
10846 * prog->aux->st_ops. Allow all kfuncs when st_ops is not yet set;
10847 * do_check_main() re-runs the filter with st_ops set and enforces the
10848 * actual restrictions.
10849 */
10850 if (!prog->aux->st_ops)
10851 return 0;
10852
10853 /*
10854 * Non-SCX struct_ops: SCX kfuncs are not permitted.
10855 *
10856 * Both bpf_sched_ext_ops (cpu-form) and bpf_sched_ext_ops_cid
10857 * (cid-form) are valid SCX struct_ops. Member offsets match between
10858 * the two (verified by BUILD_BUG_ON in scx_init()), so the shared
10859 * scx_kf_allow_flags[] table indexed by SCX_MOFF_IDX(moff) applies to
10860 * both.
10861 */
10862 if (prog->aux->st_ops != &bpf_sched_ext_ops &&
10863 prog->aux->st_ops != &bpf_sched_ext_ops_cid)
10864 return -EACCES;
10865
10866 /*
10867 * cid-form schedulers must use cid/cmask kfuncs. cid and cpu are both
10868 * small s32s and trivially confused, so cpu-only kfuncs are rejected at
10869 * load time. The reverse (cpu-form calling cid-form kfuncs) is
10870 * intentionally permissive to ease gradual cpumask -> cid migration.
10871 */
10872 if (prog->aux->st_ops == &bpf_sched_ext_ops_cid && in_cpu_only)
10873 return -EACCES;
10874
10875 /* SCX struct_ops: check the per-op allow list. */
10876 if (in_any || in_idle || in_cid)
10877 return 0;
10878
10879 moff = prog->aux->attach_st_ops_member_off;
10880 flags = scx_kf_allow_flags[SCX_MOFF_IDX(moff)];
10881
10882 if ((flags & SCX_KF_ALLOW_UNLOCKED) && in_unlocked)
10883 return 0;
10884 if ((flags & SCX_KF_ALLOW_INIT_CIDS) && in_init_cids)
10885 return 0;
10886 if ((flags & SCX_KF_ALLOW_CPU_RELEASE) && in_cpu_release)
10887 return 0;
10888 if ((flags & SCX_KF_ALLOW_DISPATCH) && in_dispatch)
10889 return 0;
10890 if ((flags & SCX_KF_ALLOW_ENQUEUE) && in_enqueue)
10891 return 0;
10892 if ((flags & SCX_KF_ALLOW_SELECT_CPU) && in_select_cpu)
10893 return 0;
10894
10895 return -EACCES;
10896 }
10897
scx_init(void)10898 static int __init scx_init(void)
10899 {
10900 int ret;
10901
10902 /*
10903 * sched_ext_ops_cid mirrors sched_ext_ops up to and including @priv.
10904 * Both bpf_scx_init_member() and bpf_scx_check_member() use offsets
10905 * from struct sched_ext_ops; sched_ext_ops_cid relies on those offsets
10906 * matching for the shared fields. Catch any drift at boot.
10907 */
10908 #define CID_OFFSET_MATCH(cpu_field, cid_field) \
10909 BUILD_BUG_ON(offsetof(struct sched_ext_ops, cpu_field) != \
10910 offsetof(struct sched_ext_ops_cid, cid_field))
10911 /* data fields used by bpf_scx_init_member() */
10912 CID_OFFSET_MATCH(dispatch_max_batch, dispatch_max_batch);
10913 CID_OFFSET_MATCH(flags, flags);
10914 CID_OFFSET_MATCH(name, name);
10915 CID_OFFSET_MATCH(timeout_ms, timeout_ms);
10916 CID_OFFSET_MATCH(exit_dump_len, exit_dump_len);
10917 CID_OFFSET_MATCH(hotplug_seq, hotplug_seq);
10918 CID_OFFSET_MATCH(cid_shard_size, cid_shard_size);
10919 CID_OFFSET_MATCH(rescue_bandwidth_ppt, rescue_bandwidth_ppt);
10920 CID_OFFSET_MATCH(rescue_quantum_us, rescue_quantum_us);
10921 CID_OFFSET_MATCH(sub_cgroup_id, sub_cgroup_id);
10922 /* shared callbacks: the union view requires byte-for-byte offset match */
10923 CID_OFFSET_MATCH(enqueue, enqueue);
10924 CID_OFFSET_MATCH(dequeue, dequeue);
10925 CID_OFFSET_MATCH(dispatch, dispatch);
10926 CID_OFFSET_MATCH(tick, tick);
10927 CID_OFFSET_MATCH(runnable, runnable);
10928 CID_OFFSET_MATCH(running, running);
10929 CID_OFFSET_MATCH(stopping, stopping);
10930 CID_OFFSET_MATCH(quiescent, quiescent);
10931 CID_OFFSET_MATCH(yield, yield);
10932 CID_OFFSET_MATCH(core_sched_before, core_sched_before);
10933 CID_OFFSET_MATCH(set_weight, set_weight);
10934 CID_OFFSET_MATCH(update_idle, update_idle);
10935 CID_OFFSET_MATCH(init_task, init_task);
10936 CID_OFFSET_MATCH(exit_task, exit_task);
10937 CID_OFFSET_MATCH(enable, enable);
10938 CID_OFFSET_MATCH(disable, disable);
10939 CID_OFFSET_MATCH(dump, dump);
10940 CID_OFFSET_MATCH(dump_task, dump_task);
10941 CID_OFFSET_MATCH(sub_attach, sub_attach);
10942 CID_OFFSET_MATCH(sub_detach, sub_detach);
10943 CID_OFFSET_MATCH(sub_caps_updated, sub_caps_updated);
10944 CID_OFFSET_MATCH(sub_ecaps_updated, sub_ecaps_updated);
10945 CID_OFFSET_MATCH(init_cids, init_cids);
10946 CID_OFFSET_MATCH(init, init);
10947 CID_OFFSET_MATCH(exit, exit);
10948 /* renamed callbacks must occupy the same slot as their cpu-form sibling */
10949 CID_OFFSET_MATCH(select_cpu, select_cid);
10950 CID_OFFSET_MATCH(set_cpumask, set_cmask);
10951 CID_OFFSET_MATCH(cpu_online, cid_online);
10952 CID_OFFSET_MATCH(cpu_offline, cid_offline);
10953 CID_OFFSET_MATCH(dump_cpu, dump_cid);
10954 #ifdef CONFIG_EXT_GROUP_SCHED
10955 CID_OFFSET_MATCH(cgroup_init, cpuctl_init);
10956 CID_OFFSET_MATCH(cgroup_exit, cpuctl_exit);
10957 CID_OFFSET_MATCH(cgroup_prep_move, cpuctl_prep_move);
10958 CID_OFFSET_MATCH(cgroup_move, cpuctl_move);
10959 CID_OFFSET_MATCH(cgroup_cancel_move, cpuctl_cancel_move);
10960 CID_OFFSET_MATCH(cgroup_set_weight, cpuctl_set_weight);
10961 CID_OFFSET_MATCH(cgroup_set_bandwidth, cpuctl_set_bandwidth);
10962 CID_OFFSET_MATCH(cgroup_set_idle, cpuctl_set_idle);
10963 #endif
10964 /* @priv tail must align since both share the same data block */
10965 CID_OFFSET_MATCH(priv, priv);
10966 /*
10967 * cid-form must end exactly at @priv - scx_validate_ops() skips
10968 * cpu_acquire/cpu_release for cid-form because reading those fields
10969 * past the BPF allocation would be UB.
10970 */
10971 BUILD_BUG_ON(offsetof(struct sched_ext_ops_cid, __end) !=
10972 offsetofend(struct sched_ext_ops, priv));
10973 #undef CID_OFFSET_MATCH
10974
10975 /*
10976 * kfunc registration can't be done from init_sched_ext_class() as
10977 * register_btf_kfunc_id_set() needs most of the system to be up.
10978 *
10979 * Some kfuncs are context-sensitive and can only be called from
10980 * specific SCX ops. They are grouped into per-context BTF sets, each
10981 * registered with scx_kfunc_context_filter as its .filter callback. The
10982 * BPF core dedups identical filter pointers per hook
10983 * (btf_populate_kfunc_set()), so the filter is invoked exactly once per
10984 * kfunc lookup; it consults scx_kf_allow_flags[] to enforce per-op
10985 * restrictions at verify time.
10986 */
10987 if ((ret = register_btf_kfunc_id_set(BPF_PROG_TYPE_STRUCT_OPS,
10988 &scx_kfunc_set_enqueue_dispatch)) ||
10989 (ret = register_btf_kfunc_id_set(BPF_PROG_TYPE_STRUCT_OPS,
10990 &scx_kfunc_set_dispatch)) ||
10991 (ret = register_btf_kfunc_id_set(BPF_PROG_TYPE_STRUCT_OPS,
10992 &scx_kfunc_set_cpu_release)) ||
10993 (ret = register_btf_kfunc_id_set(BPF_PROG_TYPE_STRUCT_OPS,
10994 &scx_kfunc_set_unlocked)) ||
10995 (ret = register_btf_kfunc_id_set(BPF_PROG_TYPE_SYSCALL,
10996 &scx_kfunc_set_unlocked)) ||
10997 (ret = register_btf_kfunc_id_set(BPF_PROG_TYPE_STRUCT_OPS,
10998 &scx_kfunc_set_any)) ||
10999 (ret = register_btf_kfunc_id_set(BPF_PROG_TYPE_TRACING,
11000 &scx_kfunc_set_any)) ||
11001 (ret = register_btf_kfunc_id_set(BPF_PROG_TYPE_SYSCALL,
11002 &scx_kfunc_set_any))) {
11003 pr_err("sched_ext: Failed to register kfunc sets (%d)\n", ret);
11004 return ret;
11005 }
11006
11007 ret = scx_idle_init();
11008 if (ret) {
11009 pr_err("sched_ext: Failed to initialize idle tracking (%d)\n", ret);
11010 return ret;
11011 }
11012
11013 ret = scx_cid_kfunc_init();
11014 if (ret) {
11015 pr_err("sched_ext: Failed to register cid kfuncs (%d)\n", ret);
11016 return ret;
11017 }
11018
11019 ret = register_bpf_struct_ops(&bpf_sched_ext_ops, sched_ext_ops);
11020 if (ret) {
11021 pr_err("sched_ext: Failed to register struct_ops (%d)\n", ret);
11022 return ret;
11023 }
11024
11025 ret = register_bpf_struct_ops(&bpf_sched_ext_ops_cid, sched_ext_ops_cid);
11026 if (ret) {
11027 pr_err("sched_ext: Failed to register cid struct_ops (%d)\n", ret);
11028 return ret;
11029 }
11030
11031 ret = register_pm_notifier(&scx_pm_notifier);
11032 if (ret) {
11033 pr_err("sched_ext: Failed to register PM notifier (%d)\n", ret);
11034 return ret;
11035 }
11036
11037 scx_kset = kset_create_and_add("sched_ext", &scx_uevent_ops, kernel_kobj);
11038 if (!scx_kset) {
11039 pr_err("sched_ext: Failed to create /sys/kernel/sched_ext\n");
11040 return -ENOMEM;
11041 }
11042
11043 ret = sysfs_create_group(&scx_kset->kobj, &scx_global_attr_group);
11044 if (ret < 0) {
11045 pr_err("sched_ext: Failed to add global attributes\n");
11046 return ret;
11047 }
11048
11049 return 0;
11050 }
11051 __initcall(scx_init);
11052
11053 /*
11054 * Compatibility markers for userspace. Existence of a marker function
11055 * represents that the kernel supports that sched-ext feature.
11056 */
11057
11058 /*
11059 * scx_compat_marker_cgroup_set_bandwidth_may_sleep: advertises that
11060 * ops.cgroup_set_bandwidth() may be implemented as a sleepable callback.
11061 */
11062 #ifdef CONFIG_EXT_GROUP_SCHED
11063 DEFINE_SCX_COMPAT_MARKER(cgroup_set_bandwidth_may_sleep);
11064 #endif /* CONFIG_EXT_GROUP_SCHED */
11065