1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 * BPF extensible scheduler class: Documentation/scheduler/sched-ext.rst
4 *
5 * Copyright (c) 2025 Meta Platforms, Inc. and affiliates.
6 * Copyright (c) 2025 Tejun Heo <tj@kernel.org>
7 */
8 #ifndef _KERNEL_SCHED_EXT_INTERNAL_H
9 #define _KERNEL_SCHED_EXT_INTERNAL_H
10
11 #include "../sched.h"
12 #include "types.h"
13
14 #include <trace/events/sched_ext.h>
15
16 /**
17 * scx_add_event - Increase an event counter for 'name' by 'cnt'
18 * @sch: scx_sched to account events for
19 * @name: an event name defined in struct scx_event_stats
20 * @cnt: the number of the event occurred
21 *
22 * This can be used when preemption is not disabled.
23 */
24 #define scx_add_event(sch, name, cnt) do { \
25 this_cpu_add((sch)->pcpu->event_stats.name, (cnt)); \
26 trace_sched_ext_event(#name, (cnt)); \
27 } while(0)
28
29 /**
30 * __scx_add_event - Increase an event counter for 'name' by 'cnt'
31 * @sch: scx_sched to account events for
32 * @name: an event name defined in struct scx_event_stats
33 * @cnt: the number of the event occurred
34 *
35 * This should be used only when preemption is disabled.
36 */
37 #define __scx_add_event(sch, name, cnt) do { \
38 __this_cpu_add((sch)->pcpu->event_stats.name, (cnt)); \
39 trace_sched_ext_event(#name, cnt); \
40 } while(0)
41
42 #define SCX_OP_IDX(op) (offsetof(struct sched_ext_ops, op) / sizeof(void (*)(void)))
43 #define SCX_MOFF_IDX(moff) ((moff) / sizeof(void (*)(void)))
44
45 enum scx_exit_kind {
46 SCX_EXIT_NONE,
47 SCX_EXIT_DONE,
48
49 SCX_EXIT_UNREG = 64, /* user-space initiated unregistration */
50 SCX_EXIT_UNREG_BPF, /* BPF-initiated unregistration */
51 SCX_EXIT_UNREG_KERN, /* kernel-initiated unregistration */
52 SCX_EXIT_SYSRQ, /* requested by 'S' sysrq */
53 SCX_EXIT_PARENT, /* parent exiting */
54 SCX_EXIT_PARENT_KILL, /* killed by parent scheduler */
55
56 SCX_EXIT_ERROR = 1024, /* runtime error, error msg contains details */
57 SCX_EXIT_ERROR_BPF, /* ERROR but triggered through scx_bpf_error() */
58 SCX_EXIT_ERROR_STALL, /* watchdog detected stalled runnable tasks */
59 SCX_EXIT_ERROR_REENQ, /* task hit reenqueue limit without running */
60 SCX_EXIT_ERROR_RESCUE, /* ejected for overloading rescue execution */
61 };
62
63 /*
64 * An exit code can be specified when exiting with scx_bpf_exit() or scx_exit(),
65 * corresponding to exit_kind UNREG_BPF and UNREG_KERN respectively. The codes
66 * are 64bit of the format:
67 *
68 * Bits: [63 .. 48 47 .. 32 31 .. 0]
69 * [ SYS ACT ] [ SYS RSN ] [ USR ]
70 *
71 * SYS ACT: System-defined exit actions
72 * SYS RSN: System-defined exit reasons
73 * USR : User-defined exit codes and reasons
74 *
75 * Using the above, users may communicate intention and context by ORing system
76 * actions and/or system reasons with a user-defined exit code.
77 */
78 enum scx_exit_code {
79 /* Reasons */
80 SCX_ECODE_RSN_HOTPLUG = 1LLU << 32,
81 SCX_ECODE_RSN_CGROUP_OFFLINE = 2LLU << 32,
82
83 /* Actions */
84 SCX_ECODE_ACT_RESTART = 1LLU << 48,
85 };
86
87 enum scx_exit_flags {
88 /*
89 * ops.exit() may be called even if the loading failed before ops.init()
90 * finishes successfully. This is because ops.exit() allows rich exit
91 * info communication. The following flag indicates whether ops.init()
92 * finished successfully.
93 */
94 SCX_EFLAG_INITIALIZED = 1LLU << 0,
95 };
96
97 /*
98 * scx_exit_info is passed to ops.exit() to describe why the BPF scheduler is
99 * being disabled.
100 */
101 struct scx_exit_info {
102 /* %SCX_EXIT_* - broad category of the exit reason */
103 enum scx_exit_kind kind;
104
105 /*
106 * CPU that initiated the exit, valid once @kind has been set.
107 * Negative if the exit path didn't identify a CPU.
108 */
109 s32 exit_cpu;
110
111 /* exit code if gracefully exiting */
112 s64 exit_code;
113
114 /* %SCX_EFLAG_* */
115 u64 flags;
116
117 /* textual representation of the above */
118 const char *reason;
119
120 /* backtrace if exiting due to an error */
121 unsigned long *bt;
122 u32 bt_len;
123
124 /* informational message */
125 char *msg;
126
127 /* debug dump */
128 char *dump;
129 };
130
131 /* sched_ext_ops.flags */
132 enum scx_ops_flags {
133 /*
134 * Keep built-in idle tracking even if ops.update_idle() is implemented.
135 */
136 SCX_OPS_KEEP_BUILTIN_IDLE = 1LLU << 0,
137
138 /*
139 * By default, if there are no other task to run on the CPU, ext core
140 * keeps running the current task even after its slice expires. If this
141 * flag is specified, such tasks are passed to ops.enqueue() with
142 * %SCX_ENQ_LAST. See the comment above %SCX_ENQ_LAST for more info.
143 */
144 SCX_OPS_ENQ_LAST = 1LLU << 1,
145
146 /*
147 * An exiting task may schedule after PF_EXITING is set. In such cases,
148 * bpf_task_from_pid() may not be able to find the task and if the BPF
149 * scheduler depends on pid lookup for dispatching, the task will be
150 * lost leading to various issues including RCU grace period stalls.
151 *
152 * To mask this problem, by default, unhashed tasks are automatically
153 * dispatched to the local DSQ on enqueue. If the BPF scheduler doesn't
154 * depend on pid lookups and wants to handle these tasks directly, the
155 * following flag can be used. With %SCX_OPS_TID_TO_TASK,
156 * scx_bpf_tid_to_task() can find exiting tasks reliably.
157 */
158 SCX_OPS_ENQ_EXITING = 1LLU << 2,
159
160 /*
161 * If set, only tasks with policy set to SCHED_EXT are attached to
162 * sched_ext. If clear, SCHED_NORMAL tasks are also included.
163 */
164 SCX_OPS_SWITCH_PARTIAL = 1LLU << 3,
165
166 /*
167 * A migration disabled task can only execute on its current CPU. By
168 * default, such tasks are automatically put on the CPU's local DSQ with
169 * the default slice on enqueue. If this ops flag is set, they also go
170 * through ops.enqueue().
171 *
172 * A migration disabled task never invokes ops.select_cpu() as it can
173 * only select the current CPU. Also, p->cpus_ptr will only contain its
174 * current CPU while p->nr_cpus_allowed keeps tracking p->user_cpus_ptr
175 * and thus may disagree with cpumask_weight(p->cpus_ptr).
176 */
177 SCX_OPS_ENQ_MIGRATION_DISABLED = 1LLU << 4,
178
179 /*
180 * Queued wakeup (ttwu_queue) is a wakeup optimization that invokes
181 * ops.enqueue() on the ops.select_cpu() selected or the wakee's
182 * previous CPU via IPI (inter-processor interrupt) to reduce cacheline
183 * transfers. When this optimization is enabled, ops.select_cpu() is
184 * skipped in some cases (when racing against the wakee switching out).
185 * As the BPF scheduler may depend on ops.select_cpu() being invoked
186 * during wakeups, queued wakeup is disabled by default.
187 *
188 * If this ops flag is set, queued wakeup optimization is enabled and
189 * the BPF scheduler must be able to handle ops.enqueue() invoked on the
190 * wakee's CPU without preceding ops.select_cpu() even for tasks which
191 * may be executed on multiple CPUs.
192 */
193 SCX_OPS_ALLOW_QUEUED_WAKEUP = 1LLU << 5,
194
195 /*
196 * If set, enable per-node idle cpumasks. If clear, use a single global
197 * flat idle cpumask.
198 */
199 SCX_OPS_BUILTIN_IDLE_PER_NODE = 1LLU << 6,
200
201 /*
202 * If set, %SCX_ENQ_IMMED is assumed to be set on all local DSQ
203 * enqueues.
204 */
205 SCX_OPS_ALWAYS_ENQ_IMMED = 1LLU << 7,
206
207 /*
208 * Maintain a mapping from p->scx.tid to task_struct so the BPF
209 * scheduler can recover task pointers from stored tids via
210 * scx_bpf_tid_to_task().
211 *
212 * Only the root scheduler turns this on. A sub-sched may set the flag
213 * to declare a dependency on the lookup; if the root scheduler hasn't
214 * enabled it, attaching the sub-sched is rejected.
215 */
216 SCX_OPS_TID_TO_TASK = 1LLU << 8,
217
218 SCX_OPS_ALL_FLAGS = SCX_OPS_KEEP_BUILTIN_IDLE |
219 SCX_OPS_ENQ_LAST |
220 SCX_OPS_ENQ_EXITING |
221 SCX_OPS_ENQ_MIGRATION_DISABLED |
222 SCX_OPS_ALLOW_QUEUED_WAKEUP |
223 SCX_OPS_SWITCH_PARTIAL |
224 SCX_OPS_BUILTIN_IDLE_PER_NODE |
225 SCX_OPS_ALWAYS_ENQ_IMMED |
226 SCX_OPS_TID_TO_TASK,
227
228 /* high 8 bits are internal, don't include in SCX_OPS_ALL_FLAGS */
229 __SCX_OPS_INTERNAL_MASK = 0xffLLU << 56,
230
231 SCX_OPS_HAS_CPU_PREEMPT = 1LLU << 56,
232 };
233
234 /* argument container for ops.init_task() */
235 struct scx_init_task_args {
236 /*
237 * Set if ops.init_task() is being invoked on the fork path, as opposed
238 * to the scheduler transition path.
239 */
240 bool fork;
241 #ifdef CONFIG_EXT_GROUP_SCHED
242 /* the cgroup the task is joining */
243 struct cgroup *cgroup;
244 #endif
245 };
246
247 /* argument container for ops.exit_task() */
248 struct scx_exit_task_args {
249 /* Whether the task exited before running on sched_ext. */
250 bool cancelled;
251 };
252
253 /* argument container for ops.cgroup_init() */
254 struct scx_cgroup_init_args {
255 /* the weight of the cgroup [1..10000] */
256 u32 weight;
257
258 /* bandwidth control parameters from cpu.max and cpu.max.burst */
259 u64 bw_period_us;
260 u64 bw_quota_us;
261 u64 bw_burst_us;
262 };
263
264 enum scx_cpu_preempt_reason {
265 /* next task is being scheduled by &sched_class_rt */
266 SCX_CPU_PREEMPT_RT,
267 /* next task is being scheduled by &sched_class_dl */
268 SCX_CPU_PREEMPT_DL,
269 /* next task is being scheduled by &sched_class_stop */
270 SCX_CPU_PREEMPT_STOP,
271 /* unknown reason for SCX being preempted */
272 SCX_CPU_PREEMPT_UNKNOWN,
273 };
274
275 /*
276 * Argument container for ops.cpu_acquire(). Currently empty, but may be
277 * expanded in the future.
278 */
279 struct scx_cpu_acquire_args {};
280
281 /* argument container for ops.cpu_release() */
282 struct scx_cpu_release_args {
283 /* the reason the CPU was preempted */
284 enum scx_cpu_preempt_reason reason;
285
286 /* the task that's going to be scheduled on the CPU */
287 struct task_struct *task;
288 };
289
290 /* informational context provided to dump operations */
291 struct scx_dump_ctx {
292 enum scx_exit_kind kind;
293 s64 exit_code;
294 const char *reason;
295 u64 at_ns;
296 u64 at_jiffies;
297 };
298
299 /* argument container for ops.sub_attach() */
300 struct scx_sub_attach_args {
301 struct sched_ext_ops *ops;
302 char *cgroup_path;
303 };
304
305 /* argument container for ops.sub_detach() */
306 struct scx_sub_detach_args {
307 struct sched_ext_ops *ops;
308 char *cgroup_path;
309 };
310
311 /**
312 * struct sched_ext_ops - Operation table for BPF scheduler implementation
313 *
314 * A BPF scheduler can implement an arbitrary scheduling policy by
315 * implementing and loading operations in this table. Note that a userland
316 * scheduling policy can also be implemented using the BPF scheduler
317 * as a shim layer.
318 */
319 struct sched_ext_ops {
320 /**
321 * @select_cpu: Pick the target CPU for a task which is being woken up
322 * @p: task being woken up
323 * @prev_cpu: the cpu @p was on before sleeping
324 * @wake_flags: SCX_WAKE_*
325 *
326 * Decision made here isn't final. @p may be moved to any CPU while it
327 * is getting dispatched for execution later. However, as @p is not on
328 * the rq at this point, getting the eventual execution CPU right here
329 * saves a small bit of overhead down the line.
330 *
331 * If an idle CPU is returned, the CPU is kicked and will try to
332 * dispatch. While an explicit custom mechanism can be added,
333 * select_cpu() serves as the default way to wake up idle CPUs.
334 *
335 * @p may be inserted into a DSQ directly by calling
336 * scx_bpf_dsq_insert(). If so, the ops.enqueue() will be skipped.
337 * Directly inserting into %SCX_DSQ_LOCAL will put @p in the local DSQ
338 * of the CPU returned by this operation.
339 *
340 * Note that select_cpu() is never called for tasks that can only run
341 * on a single CPU or tasks with migration disabled, as they don't have
342 * the option to select a different CPU. See select_task_rq() for
343 * details.
344 */
345 s32 (*select_cpu)(struct task_struct *p, s32 prev_cpu, u64 wake_flags);
346
347 /**
348 * @enqueue: Enqueue a task on the BPF scheduler
349 * @p: task being enqueued
350 * @enq_flags: %SCX_ENQ_*
351 *
352 * @p is ready to run. Insert directly into a DSQ by calling
353 * scx_bpf_dsq_insert() or enqueue on the BPF scheduler. If not directly
354 * inserted, the bpf scheduler owns @p and if it fails to dispatch @p,
355 * the task will stall.
356 *
357 * If @p was inserted into a DSQ from ops.select_cpu(), this callback is
358 * skipped.
359 */
360 void (*enqueue)(struct task_struct *p, u64 enq_flags);
361
362 /**
363 * @dequeue: Remove a task from the BPF scheduler
364 * @p: task being dequeued
365 * @deq_flags: %SCX_DEQ_*
366 *
367 * Remove @p from the BPF scheduler. This is usually called to isolate
368 * the task while updating its scheduling properties (e.g. priority).
369 *
370 * The ext core keeps track of whether the BPF side owns a given task or
371 * not and can gracefully ignore spurious dispatches from BPF side,
372 * which makes it safe to not implement this method. However, depending
373 * on the scheduling logic, this can lead to confusing behaviors - e.g.
374 * scheduling position not being updated across a priority change.
375 */
376 void (*dequeue)(struct task_struct *p, u64 deq_flags);
377
378 /**
379 * @dispatch: Dispatch tasks from the BPF scheduler and/or user DSQs
380 * @cpu: CPU to dispatch tasks for
381 * @prev: previous task being switched out
382 *
383 * Called when a CPU's local dsq is empty. The operation should dispatch
384 * one or more tasks from the BPF scheduler into the DSQs using
385 * scx_bpf_dsq_insert() and/or move from user DSQs into the local DSQ
386 * using scx_bpf_dsq_move_to_local().
387 *
388 * The maximum number of times scx_bpf_dsq_insert() can be called
389 * without an intervening scx_bpf_dsq_move_to_local() is specified by
390 * ops.dispatch_max_batch. See the comments on top of the two functions
391 * for more details.
392 *
393 * When not %NULL, @prev is an SCX task with its slice depleted. If
394 * @prev is still runnable as indicated by set %SCX_TASK_QUEUED in
395 * @prev->scx.flags, it is not enqueued yet and will be enqueued after
396 * ops.dispatch() returns. To keep executing @prev, return without
397 * dispatching or moving any tasks. Also see %SCX_OPS_ENQ_LAST.
398 */
399 void (*dispatch)(s32 cpu, struct task_struct *prev);
400
401 /**
402 * @tick: Periodic tick
403 * @p: task running currently
404 *
405 * This operation is called every 1/HZ seconds on CPUs which are
406 * executing an SCX task. Setting a slice of 0 for @p with
407 * scx_bpf_task_set_slice() will trigger an immediate dispatch cycle on
408 * the CPU.
409 */
410 void (*tick)(struct task_struct *p);
411
412 /**
413 * @runnable: A task is becoming runnable on its associated CPU
414 * @p: task becoming runnable
415 * @enq_flags: %SCX_ENQ_*
416 *
417 * This and the following three functions can be used to track a task's
418 * execution state transitions. A task becomes ->runnable() on a CPU,
419 * and then goes through one or more ->running() and ->stopping() pairs
420 * as it runs on the CPU, and eventually becomes ->quiescent() when it's
421 * done running on the CPU.
422 *
423 * @p is becoming runnable on the CPU because it's
424 *
425 * - waking up (%SCX_ENQ_WAKEUP)
426 * - being moved from another CPU
427 * - being restored after temporarily taken off the queue for an
428 * attribute change.
429 *
430 * This and ->enqueue() are related but not coupled. This operation
431 * notifies @p's state transition and may not be followed by ->enqueue()
432 * e.g. when @p is being dispatched to a remote CPU, or when @p is
433 * being enqueued on a CPU experiencing a hotplug event. Likewise, a
434 * task may be ->enqueue()'d without being preceded by this operation
435 * e.g. after exhausting its slice.
436 */
437 void (*runnable)(struct task_struct *p, u64 enq_flags);
438
439 /**
440 * @running: A task is starting to run on its associated CPU
441 * @p: task starting to run
442 *
443 * Note that this callback may be called from a CPU other than the
444 * one the task is going to run on. This can happen when a task
445 * property is changed (i.e., affinity), since scx_next_task_scx(),
446 * which triggers this callback, may run on a CPU different from
447 * the task's assigned CPU.
448 *
449 * Therefore, always use scx_bpf_task_cpu(@p) to determine the
450 * target CPU the task is going to use.
451 *
452 * See ->runnable() for explanation on the task state notifiers.
453 */
454 void (*running)(struct task_struct *p);
455
456 /**
457 * @stopping: A task is stopping execution
458 * @p: task stopping to run
459 * @runnable: is task @p still runnable?
460 *
461 * Note that this callback may be called from a CPU other than the
462 * one the task was running on. This can happen when a task
463 * property is changed (i.e., affinity), since dequeue_task_scx(),
464 * which triggers this callback, may run on a CPU different from
465 * the task's assigned CPU.
466 *
467 * Therefore, always use scx_bpf_task_cpu(@p) to retrieve the CPU
468 * the task was running on.
469 *
470 * See ->runnable() for explanation on the task state notifiers. If
471 * !@runnable, ->quiescent() will be invoked after this operation
472 * returns.
473 */
474 void (*stopping)(struct task_struct *p, bool runnable);
475
476 /**
477 * @quiescent: A task is becoming not runnable on its associated CPU
478 * @p: task becoming not runnable
479 * @deq_flags: %SCX_DEQ_*
480 *
481 * See ->runnable() for explanation on the task state notifiers.
482 *
483 * @p is becoming quiescent on the CPU because it's
484 *
485 * - sleeping (%SCX_DEQ_SLEEP)
486 * - being moved to another CPU
487 * - being temporarily taken off the queue for an attribute change
488 * (%SCX_DEQ_SCHED_CHANGE)
489 *
490 * This and ->dequeue() are related but not coupled. This operation
491 * notifies @p's state transition and may not be preceded by ->dequeue()
492 * e.g. when @p is being dispatched to a remote CPU.
493 */
494 void (*quiescent)(struct task_struct *p, u64 deq_flags);
495
496 /**
497 * @yield: Yield CPU
498 * @from: yielding task
499 * @to: optional yield target task
500 *
501 * If @to is NULL, @from is yielding the CPU to other runnable tasks.
502 * The BPF scheduler should ensure that other available tasks are
503 * dispatched before the yielding task. Return value is ignored in this
504 * case.
505 *
506 * If @to is not-NULL, @from wants to yield the CPU to @to. If the bpf
507 * scheduler can implement the request, return %true; otherwise, %false.
508 */
509 bool (*yield)(struct task_struct *from, struct task_struct *to);
510
511 /**
512 * @core_sched_before: Task ordering for core-sched
513 * @a: task A
514 * @b: task B
515 *
516 * Used by core-sched to determine the ordering between two tasks. See
517 * Documentation/admin-guide/hw-vuln/core-scheduling.rst for details on
518 * core-sched.
519 *
520 * Both @a and @b are runnable and may or may not currently be queued on
521 * the BPF scheduler. Should return %true if @a should run before @b.
522 * %false if there's no required ordering or @b should run before @a.
523 *
524 * In a scheduler hierarchy, a pair spanning two schedulers is ordered
525 * by the nearest common ancestor implementing this op, so the op may be
526 * called on tasks that the scheduler delegated to its sub-schedulers
527 * and is not scheduling anymore. See scx_prio_less().
528 *
529 * If not specified, the default is ordering them according to when they
530 * became runnable.
531 */
532 bool (*core_sched_before)(struct task_struct *a, struct task_struct *b);
533
534 /**
535 * @set_weight: Set task weight
536 * @p: task to set weight for
537 * @weight: new weight [1..10000]
538 *
539 * Update @p's weight to @weight.
540 */
541 void (*set_weight)(struct task_struct *p, u32 weight);
542
543 /**
544 * @set_cpumask: Set CPU affinity
545 * @p: task to set CPU affinity for
546 * @cpumask: cpumask of cpus that @p can run on
547 *
548 * Update @p's CPU affinity to @cpumask.
549 */
550 void (*set_cpumask)(struct task_struct *p,
551 const struct cpumask *cpumask);
552
553 /**
554 * @update_idle: Update the idle state of a CPU
555 * @cpu: CPU to update the idle state for
556 * @idle: whether entering or exiting the idle state
557 *
558 * This operation is called when @rq's CPU goes or leaves the idle
559 * state. By default, implementing this operation disables the built-in
560 * idle CPU tracking and the following helpers become unavailable:
561 *
562 * - scx_bpf_select_cpu_dfl()
563 * - scx_bpf_select_cpu_and()
564 * - scx_bpf_test_and_clear_cpu_idle()
565 * - scx_bpf_pick_idle_cpu()
566 *
567 * The user also must implement ops.select_cpu() as the default
568 * implementation relies on scx_bpf_select_cpu_dfl().
569 *
570 * Specify the %SCX_OPS_KEEP_BUILTIN_IDLE flag to keep the built-in idle
571 * tracking.
572 */
573 void (*update_idle)(s32 cpu, bool idle);
574
575 /**
576 * @init_task: Initialize a task to run in a BPF scheduler
577 * @p: task to initialize for BPF scheduling
578 * @args: init arguments, see the struct definition
579 *
580 * Either we're loading a BPF scheduler or a new task is being forked.
581 * Initialize @p for BPF scheduling. This operation may block and can
582 * be used for allocations, and is called exactly once for a task.
583 *
584 * Return 0 for success, -errno for failure. An error return while
585 * loading will abort loading of the BPF scheduler. During a fork, it
586 * will abort that specific fork.
587 */
588 s32 (*init_task)(struct task_struct *p, struct scx_init_task_args *args);
589
590 /**
591 * @exit_task: Exit a previously-running task from the system
592 * @p: task to exit
593 * @args: exit arguments, see the struct definition
594 *
595 * @p is exiting or the BPF scheduler is being unloaded. Perform any
596 * necessary cleanup for @p.
597 */
598 void (*exit_task)(struct task_struct *p, struct scx_exit_task_args *args);
599
600 /**
601 * @enable: Enable BPF scheduling for a task
602 * @p: task to enable BPF scheduling for
603 *
604 * Enable @p for BPF scheduling. enable() is called on @p any time it
605 * enters SCX, and is always paired with a matching disable().
606 */
607 void (*enable)(struct task_struct *p);
608
609 /**
610 * @disable: Disable BPF scheduling for a task
611 * @p: task to disable BPF scheduling for
612 *
613 * @p is exiting, leaving SCX or the BPF scheduler is being unloaded.
614 * Disable BPF scheduling for @p. A disable() call is always matched
615 * with a prior enable() call.
616 */
617 void (*disable)(struct task_struct *p);
618
619 /**
620 * @dump: Dump BPF scheduler state on error
621 * @ctx: debug dump context
622 *
623 * Use scx_bpf_dump() to generate BPF scheduler specific debug dump.
624 */
625 void (*dump)(struct scx_dump_ctx *ctx);
626
627 /**
628 * @dump_cpu: Dump BPF scheduler state for a CPU on error
629 * @ctx: debug dump context
630 * @cpu: CPU to generate debug dump for
631 * @idle: @cpu is currently idle without any runnable tasks
632 *
633 * Use scx_bpf_dump() to generate BPF scheduler specific debug dump for
634 * @cpu. If @idle is %true and this operation doesn't produce any
635 * output, @cpu is skipped for dump.
636 */
637 void (*dump_cpu)(struct scx_dump_ctx *ctx, s32 cpu, bool idle);
638
639 /**
640 * @dump_task: Dump BPF scheduler state for a runnable task on error
641 * @ctx: debug dump context
642 * @p: runnable task to generate debug dump for
643 *
644 * Use scx_bpf_dump() to generate BPF scheduler specific debug dump for
645 * @p.
646 */
647 void (*dump_task)(struct scx_dump_ctx *ctx, struct task_struct *p);
648
649 #ifdef CONFIG_EXT_GROUP_SCHED
650 /**
651 * @cgroup_init: Initialize a cgroup
652 * @cgrp: cgroup being initialized
653 * @args: init arguments, see the struct definition
654 *
655 * Initialize @cgrp for sched_ext, delivered to @cgrp's sched either
656 * when the BPF scheduler is being loaded or when @cgrp is created. This
657 * operation may block.
658 *
659 * Cgroup handovers also generate these ops: an enabling sub-scheduler
660 * receives ops.cgroup_init() for every cgroup in its subtree while the
661 * previous sched receives ops.cgroup_exit(), and disabling reverses the
662 * two.
663 *
664 * When the BPF scheduler is being loaded or cgroups are being handed
665 * over, @cgrp may already have been removed by userspace: a removed
666 * cgroup stays schedulable until its dying tasks finish their final
667 * context switches.
668 *
669 * Return 0 for success, -errno for failure. An error return while
670 * loading will abort loading of the BPF scheduler. During cgroup
671 * creation, it will abort the specific cgroup creation.
672 */
673 s32 (*cgroup_init)(struct cgroup *cgrp,
674 struct scx_cgroup_init_args *args);
675
676 /**
677 * @cgroup_exit: Exit a cgroup
678 * @cgrp: cgroup being exited
679 *
680 * Exit @cgrp for sched_ext, delivered to the sched whose
681 * ops.cgroup_init() it pairs with, either when the BPF scheduler is
682 * being unloaded or when @cgrp is destroyed. This operation may block.
683 *
684 * For a destroyed @cgrp, delivery follows the last scheduling event on
685 * it: a removed cgroup stays schedulable until its dying tasks finish
686 * their final context switches.
687 */
688 void (*cgroup_exit)(struct cgroup *cgrp);
689
690 /**
691 * @cgroup_prep_move: Prepare a task to be moved to a different cgroup
692 * @p: task being moved
693 * @from: cgroup @p is being moved from
694 * @to: cgroup @p is being moved to
695 *
696 * Prepare @p for move from cgroup @from to @to. This operation may
697 * block and can be used for allocations.
698 *
699 * The cgroup_move ops are delivered to @p's sched, and only for moves
700 * that don't re-home @p. A re-homing move is reported through
701 * ops.exit_task() and ops.init_task() instead. @from and @to can
702 * reference cgroups the sched never received ops.cgroup_init() for, as
703 * the cpu controller can be coarser than the sub-scheduler topology.
704 *
705 * Return 0 for success, -errno for failure. An error return aborts the
706 * migration.
707 */
708 s32 (*cgroup_prep_move)(struct task_struct *p,
709 struct cgroup *from, struct cgroup *to);
710
711 /**
712 * @cgroup_move: Commit cgroup move
713 * @p: task being moved
714 * @from: cgroup @p is being moved from
715 * @to: cgroup @p is being moved to
716 *
717 * Commit the move. @p is dequeued during this operation.
718 */
719 void (*cgroup_move)(struct task_struct *p,
720 struct cgroup *from, struct cgroup *to);
721
722 /**
723 * @cgroup_cancel_move: Cancel cgroup move
724 * @p: task whose cgroup move is being canceled
725 * @from: cgroup @p was being moved from
726 * @to: cgroup @p was being moved to
727 *
728 * @p was cgroup_prep_move()'d but failed before reaching cgroup_move().
729 * Undo the preparation.
730 */
731 void (*cgroup_cancel_move)(struct task_struct *p,
732 struct cgroup *from, struct cgroup *to);
733
734 /**
735 * @cgroup_set_weight: A cgroup's weight is being changed
736 * @cgrp: cgroup whose weight is being updated
737 * @weight: new weight [1..10000]
738 *
739 * Update @cgrp's weight to @weight.
740 *
741 * Knobs of a cgroup belong to the parent, so the set_* ops are
742 * delivered to @cgrp's parent's sched. That sched may never have seen
743 * ops.cgroup_init() for @cgrp - at a sub-scheduler attach point, the
744 * parent sched tracks @cgrp through ops.sub_attach() instead.
745 */
746 void (*cgroup_set_weight)(struct cgroup *cgrp, u32 weight);
747
748 /**
749 * @cgroup_set_bandwidth: A cgroup's bandwidth is being changed
750 * @cgrp: cgroup whose bandwidth is being updated
751 * @period_us: bandwidth control period
752 * @quota_us: bandwidth control quota
753 * @burst_us: bandwidth control burst
754 *
755 * Update @cgrp's bandwidth control parameters. This is from the cpu.max
756 * cgroup interface.
757 *
758 * @quota_us / @period_us determines the CPU bandwidth @cgrp is entitled
759 * to. For example, if @period_us is 1_000_000 and @quota_us is
760 * 2_500_000. @cgrp is entitled to 2.5 CPUs. @burst_us can be
761 * interpreted in the same fashion and specifies how much @cgrp can
762 * burst temporarily. The specific control mechanism and thus the
763 * interpretation of @period_us and burstiness is up to the BPF
764 * scheduler.
765 *
766 * Delivery follows the same rule as cgroup_set_weight().
767 */
768 void (*cgroup_set_bandwidth)(struct cgroup *cgrp,
769 u64 period_us, u64 quota_us, u64 burst_us);
770
771 /**
772 * @cgroup_set_idle: A cgroup's idle state is being changed
773 * @cgrp: cgroup whose idle state is being updated
774 * @idle: whether the cgroup is entering or exiting idle state
775 *
776 * Update @cgrp's idle state to @idle. This callback is invoked when
777 * a cgroup transitions between idle and non-idle states, allowing the
778 * BPF scheduler to adjust its behavior accordingly.
779 *
780 * Delivery follows the same rule as cgroup_set_weight().
781 */
782 void (*cgroup_set_idle)(struct cgroup *cgrp, bool idle);
783
784 #endif /* CONFIG_EXT_GROUP_SCHED */
785
786 /**
787 * @sub_attach: Attach a sub-scheduler
788 * @args: argument container, see the struct definition
789 *
790 * Return 0 to accept the sub-scheduler. -errno to reject.
791 */
792 s32 (*sub_attach)(struct scx_sub_attach_args *args);
793
794 /**
795 * @sub_detach: Detach a sub-scheduler
796 * @args: argument container, see the struct definition
797 */
798 void (*sub_detach)(struct scx_sub_detach_args *args);
799
800 /**
801 * @sub_caps_updated: Caps on this sub-sched's shard changed
802 * @cmask: cids whose caps changed (cmask->base identifies the shard)
803 * @caps: SCX_CAP_* that changed
804 *
805 * Invoked after grant or revoke modifies caps on a shard. There can be
806 * only one in-flight invocation per shard. @cmask and @caps coalesce
807 * all changes since the last delivery. Direction (set vs cleared) isn't
808 * encoded. Query current state with scx_bpf_sub_caps().
809 *
810 * Delivered asynchronously after the change is recorded, and may run
811 * before it takes effect on any given cpu. Use it to track which caps
812 * the sub-sched holds and propagate to its own children, not to decide
813 * if a task can run on a cpu now. sub_ecaps_updated() reports that per
814 * cpu, once it is in effect.
815 *
816 * May call scx_bpf_sub_grant() / scx_bpf_sub_revoke() on children.
817 */
818 void (*sub_caps_updated)(const struct scx_cmask *cmask, u64 caps);
819
820 /**
821 * @sub_ecaps_updated: This sub-sched's effective caps on a cid changed
822 * @cid: the cid whose effective caps changed
823 * @before: effective caps as of the last delivery
824 * @after: effective caps now
825 *
826 * Invoked when this sub-sched's effective caps on @cid change, once the
827 * change is in effect on the cpu. Runs in dispatch context with rq lock
828 * held, and can perform all operations allowed in ops.dispatch()
829 * including inserting/moving tasks.
830 */
831 void (*sub_ecaps_updated)(s32 cid, u64 before, u64 after);
832
833 /*
834 * All online ops must come before ops.cpu_online().
835 */
836
837 /**
838 * @cpu_online: A CPU became online
839 * @cpu: CPU which just came up
840 *
841 * @cpu just came online. @cpu will not call ops.enqueue() or
842 * ops.dispatch(), nor run tasks associated with other CPUs beforehand.
843 */
844 void (*cpu_online)(s32 cpu);
845
846 /**
847 * @cpu_offline: A CPU is going offline
848 * @cpu: CPU which is going offline
849 *
850 * @cpu is going offline. @cpu will not call ops.enqueue() or
851 * ops.dispatch(), nor run tasks associated with other CPUs afterwards.
852 */
853 void (*cpu_offline)(s32 cpu);
854
855 /*
856 * All CPU hotplug ops must come before ops.init_cids().
857 */
858
859 /**
860 * @init_cids: Finalize the cid layout (cid-form only)
861 *
862 * Runs after the default cid layout is built, before caps and shards
863 * are finalized. A cid-form scheduler may call scx_bpf_cid_override()
864 * here for a custom layout. Ignored for cpu-form schedulers.
865 */
866 s32 (*init_cids)(void);
867
868 /**
869 * @init: Initialize the BPF scheduler
870 */
871 s32 (*init)(void);
872
873 /**
874 * @exit: Clean up after the BPF scheduler
875 * @info: Exit info
876 *
877 * ops.exit() is also called on ops.init() failure, which is a bit
878 * unusual. This is to allow rich reporting through @info on how
879 * ops.init() failed.
880 */
881 void (*exit)(struct scx_exit_info *info);
882
883 /*
884 * Data fields must comes after all ops fields.
885 */
886
887 /**
888 * @dispatch_max_batch: Max nr of tasks that dispatch() can dispatch
889 */
890 u32 dispatch_max_batch;
891
892 /**
893 * @flags: %SCX_OPS_* flags
894 */
895 u64 flags;
896
897 /**
898 * @timeout_ms: The maximum amount of time, in milliseconds, that a
899 * runnable task should be able to wait before being scheduled. The
900 * maximum timeout may not exceed the default timeout of 30 seconds.
901 *
902 * Defaults to the maximum allowed timeout value of 30 seconds.
903 */
904 u32 timeout_ms;
905
906 /**
907 * @exit_dump_len: scx_exit_info.dump buffer length. If 0, the default
908 * value of 32768 is used.
909 */
910 u32 exit_dump_len;
911
912 /**
913 * @hotplug_seq: A sequence number that may be set by the scheduler to
914 * detect when a hotplug event has occurred during the loading process.
915 * If 0, no detection occurs. Otherwise, the scheduler will fail to
916 * load if the sequence number does not match @scx_hotplug_seq on the
917 * enable path.
918 */
919 u64 hotplug_seq;
920
921 /**
922 * @cid_shard_size: Target number of CIDs per shard
923 *
924 * Shards are contiguous CID ranges used as operation and locking
925 * domains for sub-scheduling. Each LLC is divided into ceil(nr_cpus /
926 * @cid_shard_size) shards, then cores are distributed across them
927 * evenly. If one core has more logical CPUs than @cid_shard_size, its
928 * shard will become larger than @cid_shard_size. Values above
929 * SCX_CID_SHARD_MAX_CPUS are capped. 0 means use the default (24).
930 */
931 u32 cid_shard_size;
932
933 /**
934 * @rescue_bandwidth_ppt: Rescue execution bandwidth in parts per thousand
935 *
936 * The fraction of each CPU's time that may be consumed running tasks
937 * from its rescue DSQ. A higher bandwidth admits and escalates rescues
938 * faster, see @rescue_quantum_us.
939 *
940 * Only the root scheduler's value is used. 0 means the default of 20
941 * (2%). May not exceed 250 (25%). %SCX_RESCUE_DISABLE disables rescue -
942 * %SCX_ENQ_RESCUE inserts are then rejected like any other insert
943 * lacking the caps.
944 */
945 u32 rescue_bandwidth_ppt;
946
947 /**
948 * @rescue_quantum_us: Rescue execution quantum in microseconds
949 *
950 * How much CPU time each rescue gets. Rescues run one at a time per CPU
951 * and admissions are paced to keep rescue execution within
952 * @rescue_bandwidth_ppt - with the defaults, one 5ms rescue every
953 * 250ms. A crowded queue round-robins on the quantum divided across the
954 * waiters, floored at 1ms. A stuck rescue eventually escalates to
955 * forced execution. A larger quantum interrupts the CPU less often but
956 * for longer and spaces rescues further apart.
957 *
958 * Only the root scheduler's value is used. 0 means the default (5000).
959 * Non-zero values must be within [1000, 100000]. Values too short for
960 * the kernel to meter are lifted silently.
961 */
962 u32 rescue_quantum_us;
963
964 /**
965 * @sub_cgroup_id: When >1, attach the scheduler as a sub-scheduler
966 * on the specified cgroup.
967 */
968 u64 sub_cgroup_id;
969
970 /**
971 * @name: BPF scheduler's name
972 *
973 * Must be a non-zero valid BPF object name including only isalnum(),
974 * '_' and '.' chars. Exposed via the ops file in the scheduler's sysfs
975 * directory, /sys/kernel/sched_ext/root/ops for the root scheduler,
976 * while the BPF scheduler is enabled.
977 */
978 char name[SCX_OPS_NAME_LEN];
979
980 /* internal use only, must be NULL */
981 void __rcu *priv;
982
983 /*
984 * Deprecated callbacks. Kept at the end of the struct so the cid-form
985 * struct (sched_ext_ops_cid) can omit them without affecting the
986 * shared field offsets. Use SCX_ENQ_IMMED instead. Sitting past
987 * SCX_OPI_END means has_op doesn't cover them, so SCX_HAS_OP() cannot
988 * be used; callers must test sch->ops.cpu_acquire / cpu_release
989 * directly.
990 */
991
992 /**
993 * @cpu_acquire: A CPU is becoming available to the BPF scheduler
994 * @cpu: The CPU being acquired by the BPF scheduler.
995 * @args: Acquire arguments, see the struct definition.
996 *
997 * A CPU that was previously released from the BPF scheduler is now once
998 * again under its control. Deprecated; use SCX_ENQ_IMMED instead.
999 */
1000 void (*cpu_acquire)(s32 cpu, struct scx_cpu_acquire_args *args);
1001
1002 /**
1003 * @cpu_release: A CPU is taken away from the BPF scheduler
1004 * @cpu: The CPU being released by the BPF scheduler.
1005 * @args: Release arguments, see the struct definition.
1006 *
1007 * The specified CPU is no longer under the control of the BPF
1008 * scheduler. This could be because it was preempted by a higher
1009 * priority sched_class, though there may be other reasons as well. The
1010 * caller should consult @args->reason to determine the cause.
1011 * Deprecated; use SCX_ENQ_IMMED instead.
1012 */
1013 void (*cpu_release)(s32 cpu, struct scx_cpu_release_args *args);
1014 };
1015
1016 /**
1017 * struct sched_ext_ops_cid - cid-form alternative to struct sched_ext_ops
1018 *
1019 * Mirrors struct sched_ext_ops with cpu/cpumask substituted with cid/cmask
1020 * where applicable. Layout up to and including @priv matches sched_ext_ops
1021 * byte-for-byte (verified by BUILD_BUG_ON checks at scx_init() time) so
1022 * shared field offsets work for both struct types in bpf_scx_init_member()
1023 * and bpf_scx_check_member(). The deprecated cpu_acquire/cpu_release
1024 * callbacks at the tail of sched_ext_ops are omitted here entirely.
1025 *
1026 * Differences from sched_ext_ops:
1027 * - select_cpu -> select_cid (returns cid)
1028 * - dispatch -> dispatch (cpu arg is now cid)
1029 * - update_idle -> update_idle (cpu arg is now cid)
1030 * - set_cpumask -> set_cmask (cmask instead of cpumask)
1031 * - cpu_online -> cid_online
1032 * - cpu_offline -> cid_offline
1033 * - dump_cpu -> dump_cid
1034 * - cgroup_* -> cpuctl_* (they track the cgroup cpu controller)
1035 * - cpu_acquire/cpu_release -> not present (deprecated in sched_ext_ops)
1036 *
1037 * BPF schedulers using this type cannot call cpu-form scx_bpf_* kfuncs;
1038 * use the cid-form variants instead. Enforced at BPF verifier time via
1039 * scx_kfunc_context_filter() branching on prog->aux->st_ops.
1040 *
1041 * See sched_ext_ops for callback documentation.
1042 */
1043 struct sched_ext_ops_cid {
1044 s32 (*select_cid)(struct task_struct *p, s32 prev_cid, u64 wake_flags);
1045 void (*enqueue)(struct task_struct *p, u64 enq_flags);
1046 void (*dequeue)(struct task_struct *p, u64 deq_flags);
1047 void (*dispatch)(s32 cid, struct task_struct *prev);
1048 void (*tick)(struct task_struct *p);
1049 void (*runnable)(struct task_struct *p, u64 enq_flags);
1050 void (*running)(struct task_struct *p);
1051 void (*stopping)(struct task_struct *p, bool runnable);
1052 void (*quiescent)(struct task_struct *p, u64 deq_flags);
1053 bool (*yield)(struct task_struct *from, struct task_struct *to);
1054 bool (*core_sched_before)(struct task_struct *a,
1055 struct task_struct *b);
1056 void (*set_weight)(struct task_struct *p, u32 weight);
1057 void (*set_cmask)(struct task_struct *p,
1058 const struct scx_cmask *cmask__arena);
1059 void (*update_idle)(s32 cid, bool idle);
1060 s32 (*init_task)(struct task_struct *p,
1061 struct scx_init_task_args *args);
1062 void (*exit_task)(struct task_struct *p,
1063 struct scx_exit_task_args *args);
1064 void (*enable)(struct task_struct *p);
1065 void (*disable)(struct task_struct *p);
1066 void (*dump)(struct scx_dump_ctx *ctx);
1067 void (*dump_cid)(struct scx_dump_ctx *ctx, s32 cid, bool idle);
1068 void (*dump_task)(struct scx_dump_ctx *ctx, struct task_struct *p);
1069 #ifdef CONFIG_EXT_GROUP_SCHED
1070 s32 (*cpuctl_init)(struct cgroup *cgrp, struct scx_cgroup_init_args *args);
1071 void (*cpuctl_exit)(struct cgroup *cgrp);
1072 s32 (*cpuctl_prep_move)(struct task_struct *p, struct cgroup *from,
1073 struct cgroup *to);
1074 void (*cpuctl_move)(struct task_struct *p, struct cgroup *from, struct cgroup *to);
1075 void (*cpuctl_cancel_move)(struct task_struct *p, struct cgroup *from,
1076 struct cgroup *to);
1077 void (*cpuctl_set_weight)(struct cgroup *cgrp, u32 weight);
1078 void (*cpuctl_set_bandwidth)(struct cgroup *cgrp, u64 period_us, u64 quota_us,
1079 u64 burst_us);
1080 void (*cpuctl_set_idle)(struct cgroup *cgrp, bool idle);
1081 #endif /* CONFIG_EXT_GROUP_SCHED */
1082 s32 (*sub_attach)(struct scx_sub_attach_args *args);
1083 void (*sub_detach)(struct scx_sub_detach_args *args);
1084 void (*sub_caps_updated)(const struct scx_cmask *cmask__arena, u64 caps);
1085 void (*sub_ecaps_updated)(s32 cid, u64 before, u64 after);
1086 void (*cid_online)(s32 cid);
1087 void (*cid_offline)(s32 cid);
1088 s32 (*init_cids)(void);
1089 s32 (*init)(void);
1090 void (*exit)(struct scx_exit_info *info);
1091
1092 /* Data fields - must match sched_ext_ops layout exactly */
1093 u32 dispatch_max_batch;
1094 u64 flags;
1095 u32 timeout_ms;
1096 u32 exit_dump_len;
1097 u64 hotplug_seq;
1098 u32 cid_shard_size;
1099 u32 rescue_bandwidth_ppt;
1100 u32 rescue_quantum_us;
1101 u64 sub_cgroup_id;
1102 char name[SCX_OPS_NAME_LEN];
1103
1104 /* internal use only, must be NULL */
1105 void __rcu *priv;
1106
1107 /* layout end anchor for the BUILD_BUG_ON in scx_init(); keep last */
1108 char __end[0];
1109 };
1110
1111 enum scx_opi {
1112 SCX_OPI_BEGIN = 0,
1113 SCX_OPI_NORMAL_BEGIN = 0,
1114 SCX_OPI_NORMAL_END = SCX_OP_IDX(cpu_online),
1115 SCX_OPI_CPU_HOTPLUG_BEGIN = SCX_OP_IDX(cpu_online),
1116 SCX_OPI_CPU_HOTPLUG_END = SCX_OP_IDX(init_cids),
1117 SCX_OPI_END = SCX_OP_IDX(init_cids),
1118 };
1119
1120 /*
1121 * Collection of event counters. Event types are placed in descending order.
1122 */
1123 struct scx_event_stats {
1124 /*
1125 * If ops.select_cpu() returns a CPU which can't be used by the task,
1126 * the core scheduler code silently picks a fallback CPU.
1127 */
1128 s64 SCX_EV_SELECT_CPU_FALLBACK;
1129
1130 /*
1131 * When dispatching to a local DSQ, the CPU may have gone offline in
1132 * the meantime. In this case, the task is bounced to the global DSQ.
1133 */
1134 s64 SCX_EV_DISPATCH_LOCAL_DSQ_OFFLINE;
1135
1136 /*
1137 * If SCX_OPS_ENQ_LAST is not set, the number of times that a task
1138 * continued to run because there were no other tasks on the CPU.
1139 */
1140 s64 SCX_EV_DISPATCH_KEEP_LAST;
1141
1142 /*
1143 * If SCX_OPS_ENQ_EXITING is not set, the number of times that a task
1144 * is dispatched to a local DSQ when exiting.
1145 */
1146 s64 SCX_EV_ENQ_SKIP_EXITING;
1147
1148 /*
1149 * If SCX_OPS_ENQ_MIGRATION_DISABLED is not set, the number of times a
1150 * migration disabled task skips ops.enqueue() and is dispatched to its
1151 * local DSQ.
1152 */
1153 s64 SCX_EV_ENQ_SKIP_MIGRATION_DISABLED;
1154
1155 /*
1156 * The number of times a task, enqueued on a local DSQ with
1157 * SCX_ENQ_IMMED, was re-enqueued because the CPU was not available for
1158 * immediate execution.
1159 */
1160 s64 SCX_EV_REENQ_IMMED;
1161
1162 /*
1163 * The number of times a reenqueue (%SCX_ENQ_REENQ) led to another
1164 * reenqueue without the task running in between. This count climbing
1165 * rapidly indicates that the BPF scheduler keeps re-deciding placements
1166 * it can't honor. A single task reenqueued more than
1167 * %SCX_REENQ_MAX_REPEAT times gets its owning scheduler ejected.
1168 */
1169 s64 SCX_EV_REENQ_REPEAT;
1170
1171 /*
1172 * Total number of times a task's time slice was refilled with the
1173 * default value (SCX_SLICE_DFL).
1174 */
1175 s64 SCX_EV_REFILL_SLICE_DFL;
1176
1177 /*
1178 * The number of times an out-of-band slice request exceeded the maximum
1179 * representable value and was clamped.
1180 */
1181 s64 SCX_EV_SLICE_CLAMPED;
1182
1183 /*
1184 * The number of times a slice extension was denied because the
1185 * scheduler lacked baseline cpu access on the task's cpu.
1186 */
1187 s64 SCX_EV_SLICE_DENIED;
1188
1189 /*
1190 * The total duration of bypass modes in nanoseconds.
1191 */
1192 s64 SCX_EV_BYPASS_DURATION;
1193
1194 /*
1195 * The number of tasks dispatched in the bypassing mode.
1196 */
1197 s64 SCX_EV_BYPASS_DISPATCH;
1198
1199 /*
1200 * The number of times the bypassing mode has been activated.
1201 */
1202 s64 SCX_EV_BYPASS_ACTIVATE;
1203
1204 /*
1205 * The number of times the scheduler attempted to insert a task that it
1206 * doesn't own into a DSQ. Such attempts are ignored.
1207 *
1208 * As BPF schedulers are allowed to ignore dequeues, it's difficult to
1209 * tell whether such an attempt is from a scheduler malfunction or an
1210 * ignored dequeue around sub-sched enabling. If this count keeps going
1211 * up regardless of sub-sched enabling, it likely indicates a bug in the
1212 * scheduler.
1213 */
1214 s64 SCX_EV_INSERT_NOT_OWNED;
1215
1216 /*
1217 * The number of times tasks from bypassing descendants are scheduled
1218 * from sub_bypass_dsq's.
1219 */
1220 s64 SCX_EV_SUB_BYPASS_DISPATCH;
1221
1222 /*
1223 * The number of times a migration-disabled task lacking the cap for its
1224 * cid was allowed onto the local DSQ. It must run on its pinned CPU, so
1225 * it can't be rejected. The violation is counted here.
1226 */
1227 s64 SCX_EV_SUB_FORCED_ADMIT;
1228
1229 /*
1230 * The number of times a preempting kick was refused because the
1231 * sub-sched lacked SCX_CAP_PREEMPT for a task outside its subtree. The
1232 * kick degrades to a plain reschedule.
1233 */
1234 s64 SCX_EV_SUB_PREEMPT_DENIED;
1235
1236 /*
1237 * The number of times a kick was skipped because the sub-sched lacked
1238 * baseline access on the target cid. The preempt-part degradation of a
1239 * delivered kick is counted in SCX_EV_SUB_PREEMPT_DENIED instead.
1240 */
1241 s64 SCX_EV_SUB_KICK_DENIED;
1242
1243 /*
1244 * The number of times a local DSQ reenq was dropped because the
1245 * sub-sched lacked baseline access on the target cid.
1246 */
1247 s64 SCX_EV_SUB_REENQ_DENIED;
1248
1249 /*
1250 * The number of times scx_bpf_cidperf_set() was denied because the
1251 * sub-sched lacked SCX_CAP_PERF on the target cid.
1252 */
1253 s64 SCX_EV_SUB_CIDPERF_DENIED;
1254
1255 /*
1256 * The number of times an insert carrying %SCX_ENQ_RESCUE lacked the
1257 * caps for its cid and the task entered the rescue path.
1258 */
1259 s64 SCX_EV_SUB_RESCUE;
1260 };
1261
1262 #define SCX_EVENTS_LIST(SCX_EVENT) \
1263 SCX_EVENT(SCX_EV_SELECT_CPU_FALLBACK); \
1264 SCX_EVENT(SCX_EV_DISPATCH_LOCAL_DSQ_OFFLINE); \
1265 SCX_EVENT(SCX_EV_DISPATCH_KEEP_LAST); \
1266 SCX_EVENT(SCX_EV_ENQ_SKIP_EXITING); \
1267 SCX_EVENT(SCX_EV_ENQ_SKIP_MIGRATION_DISABLED); \
1268 SCX_EVENT(SCX_EV_REENQ_IMMED); \
1269 SCX_EVENT(SCX_EV_REENQ_REPEAT); \
1270 SCX_EVENT(SCX_EV_REFILL_SLICE_DFL); \
1271 SCX_EVENT(SCX_EV_SLICE_CLAMPED); \
1272 SCX_EVENT(SCX_EV_SLICE_DENIED); \
1273 SCX_EVENT(SCX_EV_BYPASS_DURATION); \
1274 SCX_EVENT(SCX_EV_BYPASS_DISPATCH); \
1275 SCX_EVENT(SCX_EV_BYPASS_ACTIVATE); \
1276 SCX_EVENT(SCX_EV_INSERT_NOT_OWNED); \
1277 SCX_EVENT(SCX_EV_SUB_BYPASS_DISPATCH); \
1278 SCX_EVENT(SCX_EV_SUB_FORCED_ADMIT); \
1279 SCX_EVENT(SCX_EV_SUB_PREEMPT_DENIED); \
1280 SCX_EVENT(SCX_EV_SUB_KICK_DENIED); \
1281 SCX_EVENT(SCX_EV_SUB_REENQ_DENIED); \
1282 SCX_EVENT(SCX_EV_SUB_CIDPERF_DENIED); \
1283 SCX_EVENT(SCX_EV_SUB_RESCUE)
1284
1285 struct scx_sched;
1286
1287 enum scx_sched_pcpu_flags {
1288 SCX_SCHED_PCPU_BYPASSING = 1LLU << 0,
1289 };
1290
1291 /* dispatch buf */
1292 struct scx_dsp_buf_ent {
1293 struct task_struct *task;
1294 unsigned long qseq;
1295 u64 dsq_id;
1296 u64 slice;
1297 u64 vtime;
1298 u64 enq_flags;
1299 };
1300
1301 struct scx_dsp_ctx {
1302 struct rq *rq;
1303 u32 cursor;
1304 u32 nr_tasks;
1305 struct scx_dsp_buf_ent buf[];
1306 };
1307
1308 struct scx_deferred_reenq_local {
1309 struct list_head node;
1310 u64 flags;
1311 };
1312
1313 struct scx_sched_pcpu {
1314 struct scx_sched *sch;
1315 u64 flags; /* protected by rq lock */
1316
1317 /*
1318 * Kick state owned by this cpu for this sched. scx_kick_cpu() records
1319 * targets here and links @to_kick_node onto the cpu's
1320 * rq->scx.sched_pcpus_to_kick. The cpu's single kick irq_work walks
1321 * that list and kicks each sched's targets on its behalf. Per-sched so
1322 * a kick stays attributed to its scheduler.
1323 */
1324 cpumask_var_t cpus_to_kick;
1325 cpumask_var_t cpus_to_kick_if_idle;
1326 cpumask_var_t cpus_to_preempt;
1327 cpumask_var_t cpus_to_wait;
1328 struct list_head to_kick_node;
1329
1330 #ifdef CONFIG_EXT_SUB_SCHED
1331 /*
1332 * pshard->caps[cap_bit] is the set of cids the sched holds that one
1333 * cap on. ecaps is its transpose: the set of SCX_CAP_* bits the sched
1334 * effectively holds on this cpu, with implied caps folded in, so that
1335 * the hot-path check is a single read.
1336 *
1337 * While pshard->caps[] under pshard->lock is the target configuration,
1338 * ecaps is the effective copy owned by the cpu. It is written under the
1339 * rq lock while processing rq->ecaps_to_sync. Can also be read with
1340 * READ_ONCE() outside rq lock.
1341 *
1342 * See queue_sync_ecaps() and scx_process_sync_ecaps().
1343 */
1344 u64 ecaps;
1345 struct llist_node ecaps_to_sync_node;
1346 /* owed a forced update_idle() re-notify on this cpu */
1347 bool idle_renotify;
1348 /* effective caps as of the last sub_ecaps_updated() delivery */
1349 u64 reported_ecaps;
1350
1351 /*
1352 * Decaying rescue runtime consumed on this cpu, see
1353 * scx_rescue_decay_avg(). Overload on this cpu ejects the sub with the
1354 * largest value. Accessed only under this cpu's rq lock.
1355 */
1356 u64 rescue_avg;
1357 u64 rescue_avg_at; /* last decay, jiffies_64 */
1358 #endif
1359
1360 /*
1361 * The event counters are in a per-CPU variable to minimize the
1362 * accounting overhead. A system-wide view on the event counter is
1363 * constructed when requested by scx_bpf_events().
1364 */
1365 struct scx_event_stats event_stats;
1366
1367 struct scx_deferred_reenq_local deferred_reenq_local;
1368 struct scx_dispatch_q bypass_dsq;
1369 #ifdef CONFIG_EXT_SUB_SCHED
1370 u32 bypass_host_seq;
1371 #endif
1372
1373 /* must be the last entry - contains flex array */
1374 struct scx_dsp_ctx dsp_ctx;
1375 };
1376
1377 struct scx_sched_pnode {
1378 struct scx_dispatch_q global_dsq;
1379 };
1380
1381 /*
1382 * Sub-sched capability delegation.
1383 *
1384 * Caps are per-cid permissions parents delegate to direct children via
1385 * scx_bpf_sub_grant() / scx_bpf_sub_revoke(). A child's cap set is always a
1386 * subset of its parent's. A sub-sched checks its caps locally, and cross-sched
1387 * communication is needed only when the delegation set itself changes.
1388 *
1389 * Caps are used to implement sub-sched scheduling on the enqueue path. Picking
1390 * a cid for a task at a leaf depends on which cids the leaf is allowed to use.
1391 * Resolving that programmatically on every enqueue would mean a cross-sched
1392 * round-trip call chain, possibly retrying if the request can't be granted
1393 * as-is.
1394 *
1395 * The dispatch path is different - it runs as top-down recursion via
1396 * scx_bpf_sub_dispatch(): a sched's dispatch op invokes a child's dispatch op
1397 * on the local rq, and the subtree dispatches in a single pass.
1398 *
1399 * Locking is per shard. cid space is split into shards, and each sub-sched has
1400 * its own pshard->lock for each shard. Operations are broken up on shard
1401 * boundaries. Different shards never contend. Shards are expected to be
1402 * topology-aligned and likely to serve as the locality unit when cids are
1403 * allocated to schedulers, so per-shard lock granularity scales naturally with
1404 * the allocation pattern.
1405 *
1406 * ENQ_IMMED insert an IMMED task onto the cid's local DSQ
1407 * - kick the cid's cpu (except SCX_KICK_PREEMPT)
1408 *
1409 * ENQ insert any task onto the cid's local DSQ (implies ENQ_IMMED)
1410 *
1411 * PREEMPT preempt any task running on the cid regardless of the owning
1412 * sched (implies ENQ). Preempting a task in the sched's own subtree
1413 * doesn't require any cap.
1414 * - SCX_ENQ_PREEMPT inserts
1415 * - SCX_KICK_PREEMPT kicks
1416 *
1417 * PERF control the cid's cpu power/perf management state, currently the
1418 * cpufreq target set through scx_bpf_cidperf_set(). Hardware
1419 * control is a separate axis from queue access: PERF neither
1420 * implies nor is implied by the caps above.
1421 *
1422 * Implied caps apply to the holder's own use of a cid, not to delegation.
1423 * scx_bpf_sub_grant() delegates literally-held caps, so a cap held only through
1424 * implication is usable but cannot be re-delegated to a child. When granting a
1425 * cap, it usually makes sense to delegate its implied caps explicitly alongside
1426 * it.
1427 */
1428 enum scx_cap_flags {
1429 __SCX_CAP_ENQ_IMMED = 0,
1430 __SCX_CAP_ENQ = 1,
1431 __SCX_CAP_PREEMPT = 2,
1432 __SCX_CAP_PERF = 3,
1433
1434 __SCX_NR_CAPS,
1435 __SCX_CAP_ALL = BIT_U64(__SCX_NR_CAPS) - 1,
1436
1437 SCX_CAP_ENQ_IMMED = BIT_U64(__SCX_CAP_ENQ_IMMED),
1438 SCX_CAP_ENQ = BIT_U64(__SCX_CAP_ENQ),
1439 SCX_CAP_PREEMPT = BIT_U64(__SCX_CAP_PREEMPT),
1440 SCX_CAP_PERF = BIT_U64(__SCX_CAP_PERF),
1441
1442 /* alias for minimal cap to make any use of a cpu */
1443 SCX_CAP_BASE = SCX_CAP_ENQ_IMMED,
1444
1445 /* caps whose loss strands queued tasks, see scx_process_sync_ecaps() */
1446 SCX_CAPS_REENQ_ON_LOSS = SCX_CAP_ENQ_IMMED | SCX_CAP_ENQ,
1447 };
1448
1449 #ifdef CONFIG_EXT_SUB_SCHED
1450 /* iterate set bits in a u64 cap mask */
1451 #define scx_for_each_cap_bit(cap_bit, caps) \
1452 for (u64 __caps = (caps); \
1453 __caps && ((cap_bit) = __ffs64(__caps), true); \
1454 __caps &= __caps - 1)
1455
1456 /*
1457 * Sub-cap update notifier.
1458 *
1459 * ops_cid.sub_caps_updated() notifies sub-scheds when their cap state changes
1460 * so they can refresh internal state without polling scx_bpf_sub_caps() per
1461 * enqueue.
1462 *
1463 * Three constraints shape the design:
1464 *
1465 * 1. Static memory. Deliveries use a fixed-size buffer, both for runtime
1466 * efficiency and so notifications can't be lost under memory pressure.
1467 *
1468 * 2. High-frequency updates. Grant/revoke can mutate caps in bursts, and the
1469 * notifier path must absorb that without amplifying it.
1470 *
1471 * 3. Recursive grant/revoke from the callback. A child receiving a
1472 * notification can call grant/revoke on its own children, which can
1473 * cascade recursively down its subtree.
1474 *
1475 * (1) and (2) lead to coalescing into a fixed payload. Each delivery carries a
1476 * single (cmask, caps) pair covering every change since the previous one.
1477 * Direction (set vs cleared) isn't encoded as it doesn't fit in the fixed-size
1478 * summary. The callback queries scx_bpf_sub_caps() for current state. Only one
1479 * delivery is in flight per shard. Further changes fold into the same buffer
1480 * and ship as the next callback, so a shard's callbacks fire in order.
1481 *
1482 * (3) leads to deferred delivery. Events accumulate during grant/revoke and are
1483 * delivered after the shard lock is released.
1484 */
1485 struct scx_caps_updated {
1486 raw_spinlock_t lock;
1487 u64 caps;
1488 struct scx_cmask *cmask_arena_out;
1489 struct list_head node_in_flight;
1490 /* Kernel-side accumulator. Access as &cu->cmask. */
1491 TRAILING_OVERLAP(struct scx_cmask, cmask, bits,
1492 u64 _bits[SCX_CMASK_NR_WORDS(SCX_CID_SHARD_MAX_CPUS)];
1493 );
1494 };
1495
1496 struct scx_pshard {
1497 raw_spinlock_t lock; /* serializes caps */
1498 struct scx_sched *sch; /* backpointer */
1499 struct scx_caps_updated caps_updated;
1500
1501 /*
1502 * Per-cap cmask, inline via TRAILING_OVERLAP so cmask.bits[] overlaps
1503 * the trailing _bits[] storage. Access as &caps[i].cmask. See
1504 * scx_sched_pcpu->ecaps.
1505 */
1506 TRAILING_OVERLAP(struct scx_cmask, cmask, bits,
1507 u64 _bits[SCX_CMASK_NR_WORDS(SCX_CID_SHARD_MAX_CPUS)];
1508 ) caps[__SCX_NR_CAPS];
1509
1510 /*
1511 * Shard geometry captured at alloc. cmask_arena_out's own header is
1512 * bpf-writable and the live shard range can change before the
1513 * rcu-deferred free, so re-init and size cmask_arena_out from these
1514 * trusted copies instead.
1515 */
1516 u32 base;
1517 u32 nr_cids;
1518 };
1519 #endif
1520
1521 struct scx_sched {
1522 /*
1523 * cpu-form and cid-form ops share field offsets up to .priv (verified
1524 * by BUILD_BUG_ON in scx_init()). The anonymous union lets the kernel
1525 * access either view of the same storage without function-pointer
1526 * casts: use .ops for cpu-form and shared fields, .ops_cid for the
1527 * cid-renamed callbacks (set_cmask, select_cid, cid_online, ...).
1528 */
1529 union {
1530 struct sched_ext_ops ops;
1531 struct sched_ext_ops_cid ops_cid;
1532 };
1533 bool is_cid_type; /* true if registered via bpf_sched_ext_ops_cid */
1534 bool dead; /* set after ops.exit(), gates scx_prog_sched() */
1535
1536 /*
1537 * Arena map auto-discovered from member progs at struct_ops attach.
1538 * cid-form schedulers must use exactly one arena across all member
1539 * progs. NULL on cpu-form.
1540 *
1541 * @arena_pool sub-allocates @arena_map. Each gen_pool chunk is added
1542 * at the kernel-side mapping address. @arena_kern_base is the start
1543 * of the arena's kern_vm range. See scx_arena_to_kaddr().
1544 */
1545 struct bpf_map *arena_map;
1546 struct gen_pool *arena_pool;
1547 uintptr_t arena_kern_base;
1548
1549 /*
1550 * Per-CPU arena cmask used by scx_call_op_set_cpumask() to hand a cmask
1551 * to ops_cid.set_cmask(). The kernel writes through the stored kern_va
1552 * and passes it to the callback's __arena argument.
1553 */
1554 struct scx_cmask * __percpu *set_cmask_scratch;
1555
1556 DECLARE_BITMAP(has_op, SCX_OPI_END);
1557
1558 /*
1559 * Dispatch queues.
1560 *
1561 * The global DSQ (%SCX_DSQ_GLOBAL) is split per-node for scalability.
1562 * This is to avoid live-locking in bypass mode where all tasks are
1563 * dispatched to %SCX_DSQ_GLOBAL and all CPUs consume from it. If
1564 * per-node split isn't sufficient, it can be further split.
1565 */
1566 struct rhashtable dsq_hash;
1567 struct scx_sched_pnode **pnode;
1568 #ifdef CONFIG_EXT_SUB_SCHED
1569 struct scx_pshard **pshard; /* indexed by shard_idx */
1570 #endif
1571 struct scx_sched_pcpu __percpu *pcpu;
1572
1573 u64 slice_dfl;
1574 u64 bypass_timestamp;
1575 s32 bypass_depth;
1576
1577 /* bypass dispatch path enable state, see scx_bypass_dsp_enabled() */
1578 unsigned long bypass_dsp_claim;
1579 atomic_t bypass_dsp_enable_depth;
1580
1581 bool aborting;
1582 bool dump_disabled; /* protected by scx_dump_lock */
1583 u32 dsp_max_batch;
1584 s32 level;
1585
1586 #ifdef CONFIG_EXT_SUB_SCHED
1587 /*
1588 * pshard[] size captured at enable for the async RCU free path -
1589 * scx_nr_cid_shards may be rewritten by a later enable's
1590 * scx_cid_publish_tables() before free runs. While sch is active, use
1591 * the global.
1592 */
1593 u32 nr_pshards;
1594 #endif
1595
1596 /*
1597 * Updates to the following warned bitfields can race causing RMW issues
1598 * but it doesn't really matter.
1599 */
1600 bool warned_zero_slice:1;
1601 bool warned_unassoc_progs:1;
1602
1603 struct list_head all;
1604
1605 /* unique instance id, monotonic and never reused */
1606 u64 id;
1607
1608 #ifdef CONFIG_EXT_SUB_SCHED
1609 struct rhash_head hash_node;
1610
1611 struct list_head children;
1612 struct list_head sibling;
1613 struct cgroup *cgrp;
1614 char *cgrp_path;
1615 struct kset *sub_kset;
1616
1617 bool linked; /* on ->children, see scx_link_sched() */
1618 bool sub_attached;
1619 #endif /* CONFIG_EXT_SUB_SCHED */
1620
1621 /*
1622 * The maximum amount of time in jiffies that a task may be runnable
1623 * without being scheduled on a CPU. If this timeout is exceeded, it
1624 * will trigger scx_error().
1625 */
1626 unsigned long watchdog_timeout;
1627
1628 atomic_t exit_kind;
1629 struct scx_exit_info *exit_info;
1630
1631 struct kobject kobj;
1632
1633 struct kthread_worker *helper;
1634 struct irq_work disable_irq_work;
1635 struct kthread_work disable_work;
1636 struct irq_work propagate_exit_irq_work; /* see scx_claim_exit() */
1637 struct timer_list bypass_lb_timer;
1638 cpumask_var_t bypass_lb_donee_cpumask;
1639 cpumask_var_t bypass_lb_resched_cpumask;
1640 cpumask_var_t stall_cpus;
1641 struct rcu_work rcu_work;
1642
1643 /* all ancestors including self */
1644 struct scx_sched *ancestors[];
1645 };
1646
1647 /**
1648 * scx_arena_to_kaddr - Translate a BPF-arena pointer to its kernel address
1649 * @sch: scheduler whose arena hosts @bpf_ptr
1650 * @bpf_ptr: BPF-arena pointer, only the low 32 bits are used
1651 *
1652 * The (u32) cast normalizes any input into the arena's 4 GiB kern_vm range,
1653 * which combined with scratch-page fault recovery makes the returned pointer
1654 * safe to dereference up to GUARD_SZ / 2 past the intended object. Accesses
1655 * larger than GUARD_SZ / 2 must be explicitly bounds-checked.
1656 */
scx_arena_to_kaddr(struct scx_sched * sch,const void * bpf_ptr)1657 static inline void *scx_arena_to_kaddr(struct scx_sched *sch, const void *bpf_ptr)
1658 {
1659 return (void *)(sch->arena_kern_base + (u32)(uintptr_t)bpf_ptr);
1660 }
1661
1662 enum scx_wake_flags {
1663 /* expose select WF_* flags as enums */
1664 SCX_WAKE_FORK = WF_FORK,
1665 SCX_WAKE_TTWU = WF_TTWU,
1666 SCX_WAKE_SYNC = WF_SYNC,
1667 };
1668
1669 enum scx_enq_flags {
1670 /* expose select ENQUEUE_* flags as enums */
1671 SCX_ENQ_WAKEUP = ENQUEUE_WAKEUP,
1672 SCX_ENQ_HEAD = ENQUEUE_HEAD,
1673 SCX_ENQ_CPU_SELECTED = ENQUEUE_RQ_SELECTED,
1674
1675 /* high 32bits are SCX specific */
1676
1677 /*
1678 * Set the following to trigger preemption when calling
1679 * scx_bpf_dsq_insert() with a local dsq as the target. The slice of the
1680 * current task is cleared to zero and the CPU is kicked into the
1681 * scheduling path. Implies %SCX_ENQ_HEAD.
1682 */
1683 SCX_ENQ_PREEMPT = 1LLU << 32,
1684
1685 /*
1686 * Only allowed on local DSQs. Guarantees that the task either gets
1687 * on the CPU immediately and stays on it, or gets reenqueued back
1688 * to the BPF scheduler. It will never linger on a local DSQ or be
1689 * silently put back after preemption.
1690 *
1691 * The protection persists until the next fresh enqueue - it
1692 * survives SAVE/RESTORE cycles, slice extensions and preemption.
1693 * If the task can't stay on the CPU for any reason, it gets
1694 * reenqueued back to the BPF scheduler.
1695 *
1696 * Exiting and migration-disabled tasks bypass ops.enqueue() and
1697 * are placed directly on a local DSQ without IMMED protection
1698 * unless %SCX_OPS_ENQ_EXITING and %SCX_OPS_ENQ_MIGRATION_DISABLED
1699 * are set respectively.
1700 */
1701 SCX_ENQ_IMMED = 1LLU << 33,
1702
1703 /*
1704 * Only allowed on local DSQs. If the insert lacks the caps for the
1705 * target cid, divert the task to the CPU's rescue path instead of
1706 * rejecting and reenqueueing, e.g. when the task's affinity is
1707 * restricted to cids the scheduler doesn't hold. The kernel runs
1708 * rescued tasks on the target CPU. Rescue execution is guaranteed to
1709 * make forward progress and is bandwidth-limited, see the
1710 * rescue_bandwidth_ppt and rescue_quantum_us ops fields.
1711 */
1712 SCX_ENQ_RESCUE = 1LLU << 34,
1713
1714 /*
1715 * The task being enqueued was previously enqueued on a DSQ, but was
1716 * removed and is being re-enqueued. See SCX_TASK_REENQ_* flags to find
1717 * out why a given task is being reenqueued.
1718 */
1719 SCX_ENQ_REENQ = 1LLU << 40,
1720
1721 /*
1722 * The task being enqueued is the only task available for the cpu. By
1723 * default, ext core keeps executing such tasks but when
1724 * %SCX_OPS_ENQ_LAST is specified, they're ops.enqueue()'d with the
1725 * %SCX_ENQ_LAST flag set.
1726 *
1727 * The BPF scheduler is responsible for triggering a follow-up
1728 * scheduling event. Otherwise, Execution may stall.
1729 */
1730 SCX_ENQ_LAST = 1LLU << 41,
1731
1732 /* high 8 bits are internal */
1733 __SCX_ENQ_INTERNAL_MASK = 0xffLLU << 56,
1734
1735 SCX_ENQ_CLEAR_OPSS = 1LLU << 56,
1736 SCX_ENQ_DSQ_PRIQ = 1LLU << 57,
1737 SCX_ENQ_NESTED = 1LLU << 58,
1738 SCX_ENQ_GDSQ_FALLBACK = 1LLU << 59, /* fell back to global DSQ */
1739 SCX_ENQ_IGNORE_CAPS = 1LLU << 60, /* admit to local DSQ ignoring caps */
1740 SCX_ENQ_APPLY_SLICE = 1LLU << 61, /* apply carried slice/vtime at insertion */
1741 SCX_ENQ_SLICE_DFL = 1LLU << 62, /* carried slice is a default refill */
1742 };
1743
1744 enum scx_deq_flags {
1745 /* expose select DEQUEUE_* flags as enums */
1746 SCX_DEQ_SLEEP = DEQUEUE_SLEEP,
1747
1748 /* high 32bits are SCX specific */
1749
1750 /*
1751 * The generic core-sched layer decided to execute the task even though
1752 * it hasn't been dispatched yet. Dequeue from the BPF side.
1753 */
1754 SCX_DEQ_CORE_SCHED_EXEC = 1LLU << 32,
1755
1756 /*
1757 * The task is being dequeued due to a property change (e.g.,
1758 * sched_setaffinity(), sched_setscheduler(), set_user_nice(),
1759 * etc.).
1760 */
1761 SCX_DEQ_SCHED_CHANGE = 1LLU << 33,
1762 };
1763
1764 enum scx_reenq_flags {
1765 /* low 16bits determine which tasks should be reenqueued */
1766 SCX_REENQ_ANY = 1LLU << 0, /* all tasks */
1767
1768 /* internal: kernel-issued on cap revoke, not accepted from BPF */
1769 SCX_REENQ_CAP_REVOKE = 1LLU << 1,
1770
1771 __SCX_REENQ_FILTER_MASK = 0xffffLLU,
1772
1773 __SCX_REENQ_USER_MASK = SCX_REENQ_ANY,
1774
1775 /* bits 32-35 used by task_should_reenq() */
1776 SCX_REENQ_TSR_RQ_OPEN = 1LLU << 32,
1777 SCX_REENQ_TSR_NOT_FIRST = 1LLU << 33,
1778
1779 __SCX_REENQ_TSR_MASK = 0xfLLU << 32,
1780 };
1781
1782 enum scx_pick_idle_cpu_flags {
1783 SCX_PICK_IDLE_CORE = 1LLU << 0, /* pick a CPU whose SMT siblings are also idle */
1784 SCX_PICK_IDLE_IN_NODE = 1LLU << 1, /* pick a CPU in the same target NUMA node */
1785 };
1786
1787 enum scx_kick_flags {
1788 /*
1789 * Kick the target CPU if idle. Guarantees that the target CPU goes
1790 * through at least one full scheduling cycle before going idle. If the
1791 * target CPU can be determined to be currently not idle and going to go
1792 * through a scheduling cycle before going idle, noop.
1793 */
1794 SCX_KICK_IDLE = 1LLU << 0,
1795
1796 /*
1797 * Preempt the current task and execute the dispatch path. If the
1798 * current task of the target CPU is an SCX task, its ->scx.slice is
1799 * cleared to zero before the scheduling path is invoked so that the
1800 * task expires and the dispatch path is invoked.
1801 */
1802 SCX_KICK_PREEMPT = 1LLU << 1,
1803
1804 /*
1805 * The scx_bpf_kick_cpu() call will return after the current SCX task of
1806 * the target CPU switches out. This can be used to implement e.g. core
1807 * scheduling. This has no effect if the current task on the target CPU
1808 * is not on SCX.
1809 */
1810 SCX_KICK_WAIT = 1LLU << 2,
1811 };
1812
1813 enum scx_tg_flags {
1814 SCX_TG_ONLINE = 1U << 0,
1815 SCX_TG_INITED = 1U << 1,
1816 SCX_TG_SUB_INIT = 1U << 2, /* see scx_cgroup_claim_subtree() */
1817 };
1818
1819 enum scx_enable_state {
1820 SCX_ENABLING,
1821 SCX_ENABLED,
1822 SCX_DISABLING,
1823 SCX_DISABLED,
1824 };
1825
1826 static const char *scx_enable_state_str[] = {
1827 [SCX_ENABLING] = "enabling",
1828 [SCX_ENABLED] = "enabled",
1829 [SCX_DISABLING] = "disabling",
1830 [SCX_DISABLED] = "disabled",
1831 };
1832
1833 /*
1834 * Task Ownership State Machine (sched_ext_entity->ops_state)
1835 *
1836 * The sched_ext core uses this state machine to track task ownership
1837 * between the SCX core and the BPF scheduler. This allows the BPF
1838 * scheduler to dispatch tasks without strict ordering requirements, while
1839 * the SCX core safely rejects invalid dispatches.
1840 *
1841 * State Transitions
1842 *
1843 * .------------> NONE (owned by SCX core)
1844 * | | ^
1845 * | enqueue | | direct dispatch
1846 * | v |
1847 * | QUEUEING -------'
1848 * | |
1849 * | enqueue |
1850 * | completes |
1851 * | v
1852 * | QUEUED (owned by BPF scheduler)
1853 * | |
1854 * | dispatch |
1855 * | |
1856 * | v
1857 * | DISPATCHING
1858 * | |
1859 * | dispatch |
1860 * | completes |
1861 * `---------------'
1862 *
1863 * State Descriptions
1864 *
1865 * - %SCX_OPSS_NONE:
1866 * Task is owned by the SCX core. It's either on a run queue, running,
1867 * or being manipulated by the core scheduler. The BPF scheduler has no
1868 * claim on this task.
1869 *
1870 * - %SCX_OPSS_QUEUEING:
1871 * Transitional state while transferring a task from the SCX core to
1872 * the BPF scheduler. The task's rq lock is held during this state.
1873 * Since QUEUEING is both entered and exited under the rq lock, dequeue
1874 * can never observe this state (it would be a BUG). When finishing a
1875 * dispatch, if the task is still in %SCX_OPSS_QUEUEING the completion
1876 * path busy-waits for it to leave this state (via wait_ops_state())
1877 * before retrying.
1878 *
1879 * - %SCX_OPSS_QUEUED:
1880 * Task is owned by the BPF scheduler. It's on a DSQ (dispatch queue)
1881 * and the BPF scheduler is responsible for dispatching it. A QSEQ
1882 * (queue sequence number) is embedded in this state to detect
1883 * dispatch/dequeue races: if a task is dequeued and re-enqueued, the
1884 * QSEQ changes and any in-flight dispatch operations targeting the old
1885 * QSEQ are safely ignored.
1886 *
1887 * - %SCX_OPSS_DISPATCHING:
1888 * Transitional state while transferring a task from the BPF scheduler
1889 * back to the SCX core. This state indicates the BPF scheduler has
1890 * selected the task for execution. When dequeue needs to take the task
1891 * off a DSQ and it is still in %SCX_OPSS_DISPATCHING, the dequeue path
1892 * busy-waits for it to leave this state (via wait_ops_state()) before
1893 * proceeding. Exits to %SCX_OPSS_NONE when dispatch completes.
1894 *
1895 * Memory Ordering
1896 *
1897 * Transitions out of %SCX_OPSS_QUEUEING and %SCX_OPSS_DISPATCHING into
1898 * %SCX_OPSS_NONE or %SCX_OPSS_QUEUED must use atomic_long_set_release()
1899 * and waiters must use atomic_long_read_acquire(). This ensures proper
1900 * synchronization between concurrent operations.
1901 *
1902 * Cross-CPU Task Migration
1903 *
1904 * When moving a task in the %SCX_OPSS_DISPATCHING state, we can't simply
1905 * grab the target CPU's rq lock because a concurrent dequeue might be
1906 * waiting on %SCX_OPSS_DISPATCHING while holding the source rq lock
1907 * (deadlock).
1908 *
1909 * The sched_ext core uses a "lock dancing" protocol coordinated by
1910 * p->scx.holding_cpu. When moving a task to a different rq:
1911 *
1912 * 1. Set p->scx.holding_cpu to the current CPU
1913 * 2. Set task state to %SCX_OPSS_NONE; dequeue waits while DISPATCHING
1914 * is set, so clearing DISPATCHING first prevents the circular wait
1915 * (safe to lock the rq we need)
1916 * 3. Unlock the current CPU's rq
1917 * 4. Lock src_rq (where the task currently lives)
1918 * 5. Verify p->scx.holding_cpu == current CPU, if not, dequeue won the
1919 * race (dequeue clears holding_cpu to -1 when it takes the task), in
1920 * this case migration is aborted
1921 * 6. If src_rq == dst_rq: clear holding_cpu and enqueue directly
1922 * into dst_rq's local DSQ (no lock swap needed)
1923 * 7. Otherwise, verify under src_rq lock that the task can be moved to dst_rq
1924 * (CPU affinity, migration_disabled, etc.). If not, clear holding_cpu,
1925 * leave the task on src_rq, and enqueue it on the fallback DSQ.
1926 * 8. Otherwise (i.e. if the task can be moved to dst_rq), call
1927 * move_remote_task_to_local_dsq(), which releases src_rq, locks dst_rq,
1928 * and performs the deactivate/activate migration cycle
1929 * (dst_rq is held on return)
1930 * 9. Unlock dst_rq and re-lock the current CPU's rq to restore
1931 * the lock state expected by the caller
1932 *
1933 * If any verification fails, abort the migration.
1934 *
1935 * This state tracking allows the BPF scheduler to try to dispatch any task
1936 * at any time regardless of its state. The SCX core can safely
1937 * reject/ignore invalid dispatches, simplifying the BPF scheduler
1938 * implementation.
1939 */
1940 enum scx_ops_state {
1941 SCX_OPSS_NONE, /* owned by the SCX core */
1942 SCX_OPSS_QUEUEING, /* in transit to the BPF scheduler */
1943 SCX_OPSS_QUEUED, /* owned by the BPF scheduler */
1944 SCX_OPSS_DISPATCHING, /* in transit back to the SCX core */
1945
1946 /*
1947 * QSEQ brands each QUEUED instance so that, when dispatch races
1948 * dequeue/requeue, the dispatcher can tell whether it still has a claim
1949 * on the task being dispatched.
1950 *
1951 * As some 32bit archs can't do 64bit store_release/load_acquire,
1952 * p->scx.ops_state is atomic_long_t which leaves 30 bits for QSEQ on
1953 * 32bit machines. The dispatch race window QSEQ protects is very narrow
1954 * and runs with IRQ disabled. 30 bits should be sufficient.
1955 */
1956 SCX_OPSS_QSEQ_SHIFT = 2,
1957 };
1958
1959 /* Use macros to ensure that the type is unsigned long for the masks */
1960 #define SCX_OPSS_STATE_MASK ((1LU << SCX_OPSS_QSEQ_SHIFT) - 1)
1961 #define SCX_OPSS_QSEQ_MASK (~SCX_OPSS_STATE_MASK)
1962
1963 /*
1964 * SCX task iterator.
1965 */
1966 struct scx_task_iter {
1967 struct sched_ext_entity cursor;
1968 struct task_struct *locked_task;
1969 struct rq *rq;
1970 struct rq_flags rf;
1971 u32 cnt;
1972 bool list_locked;
1973 #ifdef CONFIG_EXT_SUB_SCHED
1974 struct cgroup *cgrp;
1975 struct cgroup_subsys_state *css_pos;
1976 struct css_task_iter css_iter;
1977 #endif
1978 };
1979
1980 /*
1981 * scx_enable() is offloaded to a dedicated system-wide RT kthread to avoid
1982 * starvation. During the READY -> ENABLED task switching loop, the calling
1983 * thread's sched_class gets switched from fair to ext. As fair has higher
1984 * priority than ext, the calling thread can be indefinitely starved under
1985 * fair-class saturation, leading to a system hang.
1986 */
1987 struct scx_enable_cmd {
1988 struct kthread_work work;
1989 union {
1990 struct sched_ext_ops *ops;
1991 struct sched_ext_ops_cid *ops_cid;
1992 };
1993 bool is_cid_type;
1994 struct bpf_map *arena_map; /* arena ref to transfer to sch */
1995 int ret;
1996 };
1997
1998 /* string formatting from BPF */
1999 struct scx_bstr_buf {
2000 u64 data[MAX_BPRINTF_VARARGS];
2001 char line[SCX_EXIT_MSG_LEN];
2002 };
2003
2004 extern struct scx_sched __rcu *scx_root;
2005 DECLARE_PER_CPU(struct rq *, scx_locked_rq_state);
2006
2007 /*
2008 * True when the currently loaded scheduler hierarchy is cid-form. All scheds
2009 * in a hierarchy share one form, so this single key tells callsites which
2010 * view to use without per-sch dereferences. Use scx_is_cid_type() to test.
2011 */
2012 DECLARE_STATIC_KEY_FALSE(__scx_is_cid_type);
2013
2014 int scx_kfunc_context_filter(const struct bpf_prog *prog, u32 kfunc_id);
2015
2016 bool scx_cpu_valid(struct scx_sched *sch, s32 cpu, const char *where);
2017
2018 __printf(5, 0) bool scx_vexit(struct scx_sched *sch, enum scx_exit_kind kind,
2019 s64 exit_code, s32 exit_cpu, const char *fmt,
2020 va_list args);
2021 __printf(5, 6) bool __scx_exit(struct scx_sched *sch, enum scx_exit_kind kind,
2022 s64 exit_code, s32 exit_cpu, const char *fmt, ...);
2023
2024 u32 scx_get_task_state(const struct task_struct *p);
2025 void scx_set_task_state(struct task_struct *p, u32 state);
2026 void scx_task_iter_start(struct scx_task_iter *iter, struct cgroup *cgrp);
2027 void scx_task_iter_unlock(struct scx_task_iter *iter);
2028 void scx_task_iter_stop(struct scx_task_iter *iter);
2029 struct task_struct *scx_task_iter_next_locked(struct scx_task_iter *iter);
2030 bool scx_set_task_slice(struct task_struct *p, u64 slice);
2031 void scx_task_slice_ended(struct rq *rq, struct task_struct *p);
2032 void scx_task_unlink_from_dsq(struct task_struct *p, struct scx_dispatch_q *dsq);
2033 void scx_dispatch_dequeue(struct rq *rq, struct task_struct *p);
2034 void scx_do_enqueue_task(struct rq *rq, struct task_struct *p, u64 enq_flags,
2035 int sticky_cpu);
2036 void scx_move_local_task_to_local_dsq(struct scx_sched *sch, struct task_struct *p,
2037 u64 enq_flags, struct scx_dispatch_q *src_dsq,
2038 struct rq *dst_rq);
2039 bool scx_consume_dispatch_q(struct scx_sched *sch, struct rq *rq,
2040 struct scx_dispatch_q *dsq, u64 enq_flags);
2041 bool scx_consume_global_dsq(struct scx_sched *sch, struct rq *rq);
2042 bool scx_rq_online(struct rq *rq);
2043 void scx_flush_dispatch_buf(struct scx_sched *sch, struct rq *rq);
2044 s32 scx_init_dsq(struct scx_dispatch_q *dsq, u64 dsq_id, struct scx_sched *sch);
2045 __printf(2, 3) void scx_dump_line(struct seq_buf *s, const char *fmt, ...);
2046 void scx_kick_cpu(struct scx_sched *sch, s32 cpu, u64 flags);
2047 u64 __scx_bpf_now(struct rq *rq);
2048 void schedule_dsq_reenq(struct scx_sched *sch, struct scx_dispatch_q *dsq,
2049 u64 reenq_flags, struct rq *locked_rq);
2050 int __scx_init_task(struct scx_sched *sch, struct task_struct *p,
2051 struct cgroup *cgrp, bool fork);
2052 void scx_enable_task(struct scx_sched *sch, struct task_struct *p);
2053 void __scx_disable_and_exit_task(struct scx_sched *sch, struct task_struct *p);
2054 void scx_sub_init_cancel_task(struct scx_sched *sch, struct task_struct *p);
2055 void scx_disable_and_exit_task(struct scx_sched *sch, struct task_struct *p);
2056 #if defined(CONFIG_EXT_GROUP_SCHED) || defined(CONFIG_EXT_SUB_SCHED)
2057 void scx_cgroup_lock(void);
2058 void scx_cgroup_unlock(void);
2059 #endif
2060 s32 scx_set_cmask_scratch_alloc(struct scx_sched *sch);
2061 void scx_disable_bypass_dsp(struct scx_sched *sch);
2062 void scx_bypass(struct scx_sched *sch, bool bypass);
2063 s32 scx_link_sched(struct scx_sched *sch);
2064 void scx_unlink_sched(struct scx_sched *sch);
2065 void scx_disable_dump(struct scx_sched *sch);
2066 void scx_log_sched_disable(struct scx_sched *sch);
2067 void scx_flush_disable_work(struct scx_sched *sch);
2068 struct scx_sched *scx_alloc_and_add_sched(struct scx_enable_cmd *cmd,
2069 struct cgroup *cgrp,
2070 struct scx_sched *parent);
2071 int scx_validate_ops(struct scx_sched *sch, const struct sched_ext_ops *ops);
2072 int scx_sched_sysfs_add(struct scx_sched *sch);
2073 bool scx_is_descendant(struct scx_sched *sch, struct scx_sched *ancestor);
2074 __printf(5, 0) bool scx_exit_bstr(struct scx_sched *sch, enum scx_exit_kind kind,
2075 s64 exit_code, struct scx_sched *fmt_blame,
2076 char *fmt, unsigned long long *data, u32 data__sz);
2077
2078 extern raw_spinlock_t scx_sched_lock;
2079 extern struct mutex scx_enable_mutex;
2080 extern struct percpu_rw_semaphore scx_fork_rwsem;
2081 extern bool scx_cgroup_enabled;
2082 extern struct list_head scx_sched_all;
2083 #ifdef CONFIG_EXT_SUB_SCHED
2084 extern const struct rhashtable_params scx_sched_hash_params;
2085 extern struct rhashtable scx_sched_hash;
2086 extern struct scx_sched *scx_enabling_sub_sched;
2087 #endif
2088
2089 #define scx_exit(sch, kind, exit_code, fmt, args...) \
2090 __scx_exit(sch, kind, exit_code, raw_smp_processor_id(), fmt, ##args)
2091 #define scx_error(sch, fmt, args...) \
2092 scx_exit((sch), SCX_EXIT_ERROR, 0, fmt, ##args)
2093
2094 /**
2095 * scx_root_protected_live - Root sched for paths that only run while live
2096 *
2097 * scx_root is published before the scheduler goes live and cleared only after
2098 * it is fully drained, so a path that only executes while the scheduler is live
2099 * can never race an update. Return the root sched with a plain load, never
2100 * %NULL.
2101 */
scx_root_protected_live(void)2102 static inline struct scx_sched *scx_root_protected_live(void)
2103 {
2104 return rcu_dereference_protected(scx_root, true);
2105 }
2106
2107 /**
2108 * scx_root_protected - Root sched for contexts that exclude its updates
2109 *
2110 * Both scx_root updates run under the locks checked below, so holding one
2111 * excludes them. Return the root sched with a plain load, %NULL if no scheduler
2112 * is loaded.
2113 */
scx_root_protected(void)2114 static inline struct scx_sched *scx_root_protected(void)
2115 {
2116 return rcu_dereference_protected(scx_root,
2117 lockdep_is_cpus_held() ||
2118 lockdep_is_held(&scx_enable_mutex));
2119 }
2120
scx_bypass_dsq(struct scx_sched * sch,s32 cpu)2121 static inline struct scx_dispatch_q *scx_bypass_dsq(struct scx_sched *sch, s32 cpu)
2122 {
2123 return &per_cpu_ptr(sch->pcpu, cpu)->bypass_dsq;
2124 }
2125
2126 /**
2127 * scx_bypass_dsp_enabled - Check if bypass dispatch path is enabled
2128 * @sch: scheduler to check
2129 *
2130 * When a descendant scheduler enters bypass mode, bypassed tasks are scheduled
2131 * by the nearest non-bypassing ancestor, or the root scheduler if all ancestors
2132 * are bypassing. In the former case, the ancestor is not itself bypassing but
2133 * its bypass DSQs will be populated with bypassed tasks from descendants. Thus,
2134 * the ancestor's bypass dispatch path must be active even though its own
2135 * bypass_depth remains zero.
2136 *
2137 * This function checks bypass_dsp_enable_depth which is managed separately from
2138 * bypass_depth to enable this decoupling. See enable_bypass_dsp() and
2139 * scx_disable_bypass_dsp().
2140 */
scx_bypass_dsp_enabled(struct scx_sched * sch)2141 static inline bool scx_bypass_dsp_enabled(struct scx_sched *sch)
2142 {
2143 return unlikely(atomic_read(&sch->bypass_dsp_enable_depth));
2144 }
2145
2146 /**
2147 * scx_ops_sanitize_err - Sanitize a -errno value
2148 * @sch: scx_sched to error out on error
2149 * @ops_name: operation to blame on failure
2150 * @err: -errno value to sanitize
2151 *
2152 * Verify @err is a valid -errno. If not, trigger scx_error() and return
2153 * -%EPROTO. This is necessary because returning a rogue -errno up the chain can
2154 * cause misbehaviors. For an example, a large negative return from
2155 * ops.init_task() triggers an oops when passed up the call chain because the
2156 * value fails IS_ERR() test after being encoded with ERR_PTR() and then is
2157 * handled as a pointer.
2158 */
scx_ops_sanitize_err(struct scx_sched * sch,const char * ops_name,s32 err)2159 static inline int scx_ops_sanitize_err(struct scx_sched *sch, const char *ops_name, s32 err)
2160 {
2161 if (err < 0 && err >= -MAX_ERRNO)
2162 return err;
2163
2164 scx_error(sch, "ops.%s() returned an invalid errno %d", ops_name, err);
2165 return -EPROTO;
2166 }
2167
scx_schedule_reenq_local(struct rq * rq,u64 reenq_flags)2168 static inline void scx_schedule_reenq_local(struct rq *rq, u64 reenq_flags)
2169 {
2170 struct scx_sched *root = rcu_dereference_sched(scx_root);
2171
2172 if (WARN_ON_ONCE(!root))
2173 return;
2174
2175 schedule_dsq_reenq(root, &rq->scx.local_dsq, reenq_flags, rq);
2176 }
2177
2178 /*
2179 * Return the rq currently locked from an scx callback, or NULL if no rq is
2180 * locked.
2181 */
scx_locked_rq(void)2182 static inline struct rq *scx_locked_rq(void)
2183 {
2184 return __this_cpu_read(scx_locked_rq_state);
2185 }
2186
update_locked_rq(struct rq * rq)2187 static inline void update_locked_rq(struct rq *rq)
2188 {
2189 /*
2190 * Check whether @rq is actually locked. This can help expose bugs
2191 * or incorrect assumptions about the context in which a kfunc or
2192 * callback is executed.
2193 */
2194 if (rq)
2195 lockdep_assert_rq_held(rq);
2196 __this_cpu_write(scx_locked_rq_state, rq);
2197 }
2198
2199 #define SCX_HAS_OP(sch, op) test_bit(SCX_OP_IDX(op), (sch)->has_op)
2200
2201 /*
2202 * SCX ops can recurse via scx_bpf_sub_dispatch() - the inner call must not
2203 * clobber the outer's scx_locked_rq_state. Save it on entry, restore on exit.
2204 *
2205 * @ops is the ops table to dispatch through: ops for the cpu form, ops_cid
2206 * for the cid form.
2207 */
2208 #define __SCX_CALL_OP(sch, ops, op, locked_rq, args...) \
2209 do { \
2210 struct rq *__prev_locked_rq; \
2211 \
2212 if (locked_rq) { \
2213 __prev_locked_rq = scx_locked_rq(); \
2214 update_locked_rq(locked_rq); \
2215 } \
2216 (sch)->ops.op(args); \
2217 if (locked_rq) \
2218 update_locked_rq(__prev_locked_rq); \
2219 } while (0)
2220
2221 #define SCX_CALL_OP(sch, op, locked_rq, args...) \
2222 __SCX_CALL_OP(sch, ops, op, locked_rq, ##args)
2223
2224 #define SCX_CALL_OP_RET(sch, op, locked_rq, args...) \
2225 ({ \
2226 struct rq *__prev_locked_rq; \
2227 __typeof__((sch)->ops.op(args)) __ret; \
2228 \
2229 if (locked_rq) { \
2230 __prev_locked_rq = scx_locked_rq(); \
2231 update_locked_rq(locked_rq); \
2232 } \
2233 __ret = (sch)->ops.op(args); \
2234 if (locked_rq) \
2235 update_locked_rq(__prev_locked_rq); \
2236 __ret; \
2237 })
2238
2239 /*
2240 * SCX_CALL_OP_TASK*() invokes an SCX op that takes one or two task arguments
2241 * and records them in current->scx.kf_tasks[] for the duration of the call. A
2242 * kfunc invoked from inside such an op can then use
2243 * scx_kf_arg_task_ok() to verify that its task argument is one of
2244 * those subject tasks.
2245 *
2246 * Every SCX_CALL_OP_TASK*() call site invokes its op with @p's rq lock held -
2247 * either via the @locked_rq argument here, or (for ops.select_cpu()) via @p's
2248 * pi_lock held by try_to_wake_up() with rq tracking via scx_rq.in_select_cpu.
2249 * So if kf_tasks[] is set, @p's scheduler-protected fields are stable.
2250 *
2251 * kf_tasks[] can not stack, so task-based SCX ops must not nest. The
2252 * WARN_ON_ONCE() in each macro catches a re-entry of any of the three variants
2253 * while a previous one is still in progress.
2254 */
2255 #define __SCX_CALL_OP_TASK(sch, ops, op, locked_rq, task, args...) \
2256 do { \
2257 WARN_ON_ONCE(current->scx.kf_tasks[0]); \
2258 current->scx.kf_tasks[0] = task; \
2259 __SCX_CALL_OP((sch), ops, op, locked_rq, task, ##args); \
2260 current->scx.kf_tasks[0] = NULL; \
2261 } while (0)
2262
2263 /*
2264 * A per-task op runs on @task's owner - WARN if @sch isn't it. Sites that must
2265 * target a different scheduler call __SCX_CALL_OP_TASK() directly.
2266 */
2267 #define SCX_CALL_OP_TASK(sch, op, locked_rq, task, args...) \
2268 do { \
2269 WARN_ON_ONCE(scx_has_subs() && (sch) != scx_task_sched_rcu(task)); \
2270 __SCX_CALL_OP_TASK((sch), ops, op, locked_rq, task, ##args); \
2271 } while (0)
2272
2273 /*
2274 * Dispatch a task op through the cid-form ops_cid table. Only set_cmask() needs
2275 * this: it takes an arena cmask address instead of a cpumask, so it cannot be
2276 * invoked via its cpu-form set_cpumask() slot.
2277 */
2278 #define SCX_CALL_CID_OP_TASK(sch, op, locked_rq, task, args...) \
2279 __SCX_CALL_OP_TASK(sch, ops_cid, op, locked_rq, task, ##args)
2280
2281 #define SCX_CALL_OP_TASK_RET(sch, op, locked_rq, task, args...) \
2282 ({ \
2283 __typeof__((sch)->ops.op(task, ##args)) __ret; \
2284 WARN_ON_ONCE(scx_has_subs() && (sch) != scx_task_sched_rcu(task)); \
2285 WARN_ON_ONCE(current->scx.kf_tasks[0]); \
2286 current->scx.kf_tasks[0] = task; \
2287 __ret = SCX_CALL_OP_RET((sch), op, locked_rq, task, ##args); \
2288 current->scx.kf_tasks[0] = NULL; \
2289 __ret; \
2290 })
2291
2292 #define SCX_CALL_OP_2TASKS_RET(sch, op, locked_rq, task0, task1, args...) \
2293 ({ \
2294 __typeof__((sch)->ops.op(task0, task1, ##args)) __ret; \
2295 WARN_ON_ONCE(current->scx.kf_tasks[0]); \
2296 current->scx.kf_tasks[0] = task0; \
2297 current->scx.kf_tasks[1] = task1; \
2298 __ret = SCX_CALL_OP_RET((sch), op, locked_rq, task0, task1, ##args); \
2299 current->scx.kf_tasks[0] = NULL; \
2300 current->scx.kf_tasks[1] = NULL; \
2301 __ret; \
2302 })
2303
2304 /* see SCX_CALL_OP_TASK() */
scx_kf_arg_task_ok(struct scx_sched * sch,struct task_struct * p)2305 static __always_inline bool scx_kf_arg_task_ok(struct scx_sched *sch,
2306 struct task_struct *p)
2307 {
2308 if (unlikely((p != current->scx.kf_tasks[0] &&
2309 p != current->scx.kf_tasks[1]))) {
2310 scx_error(sch, "called on a task not being operated on");
2311 return false;
2312 }
2313
2314 return true;
2315 }
2316
scx_bypassing(struct scx_sched * sch,s32 cpu)2317 static inline bool scx_bypassing(struct scx_sched *sch, s32 cpu)
2318 {
2319 return unlikely(per_cpu_ptr(sch->pcpu, cpu)->flags &
2320 SCX_SCHED_PCPU_BYPASSING);
2321 }
2322
2323 #ifdef CONFIG_EXT_SUB_SCHED
2324 DECLARE_STATIC_KEY_FALSE(__scx_has_subs);
2325
2326 /**
2327 * scx_has_subs - Whether any sub-scheduler exists
2328 *
2329 * Gates the sub-sched portions of hot paths so that a root-only system doesn't
2330 * pay for them. See scx_sub_enable_workfn() and scx_sched_free_rcu_work().
2331 */
scx_has_subs(void)2332 static inline bool scx_has_subs(void)
2333 {
2334 return static_branch_unlikely(&__scx_has_subs);
2335 }
2336
2337 /**
2338 * scx_task_sched - Find scx_sched scheduling a task
2339 * @p: task of interest
2340 *
2341 * Return @p's scheduler instance. Must be called with @p's pi_lock or rq lock
2342 * held.
2343 */
scx_task_sched(const struct task_struct * p)2344 static inline struct scx_sched *scx_task_sched(const struct task_struct *p)
2345 {
2346 return rcu_dereference_protected(p->scx.sched,
2347 lockdep_is_held(&p->pi_lock) ||
2348 lockdep_is_held(__rq_lockp(task_rq(p))));
2349 }
2350
2351 /**
2352 * scx_task_sched_rcu - Find scx_sched scheduling a task
2353 * @p: task of interest
2354 *
2355 * Return @p's scheduler instance. The returned scx_sched is RCU protected.
2356 */
scx_task_sched_rcu(const struct task_struct * p)2357 static inline struct scx_sched *scx_task_sched_rcu(const struct task_struct *p)
2358 {
2359 return rcu_dereference_all(p->scx.sched);
2360 }
2361
2362 /**
2363 * scx_task_on_sched - Is a task on the specified sched?
2364 * @sch: sched to test against
2365 * @p: task of interest
2366 *
2367 * Returns %true if @p is on @sch, %false otherwise.
2368 */
scx_task_on_sched(struct scx_sched * sch,const struct task_struct * p)2369 static inline bool scx_task_on_sched(struct scx_sched *sch,
2370 const struct task_struct *p)
2371 {
2372 return rcu_access_pointer(p->scx.sched) == sch;
2373 }
2374
2375 /**
2376 * scx_prog_sched - Find scx_sched associated with a BPF prog
2377 * @aux: aux passed in from BPF to a kfunc
2378 *
2379 * To be called from kfuncs. Return the scheduler instance associated with the
2380 * BPF program given the implicit kfunc argument aux. The returned scx_sched is
2381 * RCU protected.
2382 */
scx_prog_sched(const struct bpf_prog_aux * aux)2383 static inline struct scx_sched *scx_prog_sched(const struct bpf_prog_aux *aux)
2384 {
2385 struct sched_ext_ops *ops;
2386 struct scx_sched *sch, *root;
2387
2388 ops = bpf_prog_get_assoc_struct_ops(aux);
2389 if (likely(ops)) {
2390 sch = rcu_dereference_all(ops->priv);
2391 if (sch && unlikely(READ_ONCE(sch->dead)))
2392 return NULL;
2393 return sch;
2394 }
2395
2396 root = rcu_dereference_all(scx_root);
2397 if (root) {
2398 if (unlikely(READ_ONCE(root->dead)))
2399 return NULL;
2400 /*
2401 * COMPAT-v6.19: Schedulers built before sub-sched support was
2402 * introduced may have unassociated non-struct_ops programs.
2403 */
2404 if (!root->ops.sub_attach)
2405 return root;
2406
2407 if (!root->warned_unassoc_progs) {
2408 printk_deferred(KERN_WARNING "sched_ext: Unassociated program %s (id %d)\n",
2409 aux->name, aux->id);
2410 root->warned_unassoc_progs = true;
2411 }
2412 }
2413
2414 return NULL;
2415 }
2416
2417 /**
2418 * scx_parent - Find the parent sched
2419 * @sch: sched to find the parent of
2420 *
2421 * Returns the parent scheduler or %NULL if @sch is root.
2422 */
scx_parent(struct scx_sched * sch)2423 static inline struct scx_sched *scx_parent(struct scx_sched *sch)
2424 {
2425 if (sch->level)
2426 return sch->ancestors[sch->level - 1];
2427 else
2428 return NULL;
2429 }
2430
2431 #else /* CONFIG_EXT_SUB_SCHED */
scx_has_subs(void)2432 static inline bool scx_has_subs(void) { return false; }
2433
scx_task_sched(const struct task_struct * p)2434 static inline struct scx_sched *scx_task_sched(const struct task_struct *p)
2435 {
2436 return rcu_dereference_protected(scx_root,
2437 lockdep_is_held(&p->pi_lock) ||
2438 lockdep_is_held(__rq_lockp(task_rq(p))));
2439 }
2440
scx_task_sched_rcu(const struct task_struct * p)2441 static inline struct scx_sched *scx_task_sched_rcu(const struct task_struct *p)
2442 {
2443 return rcu_dereference_all(scx_root);
2444 }
2445
scx_task_on_sched(struct scx_sched * sch,const struct task_struct * p)2446 static inline bool scx_task_on_sched(struct scx_sched *sch,
2447 const struct task_struct *p)
2448 {
2449 return true;
2450 }
2451
scx_prog_sched(const struct bpf_prog_aux * aux)2452 static inline struct scx_sched *scx_prog_sched(const struct bpf_prog_aux *aux)
2453 {
2454 struct scx_sched *root = rcu_dereference_all(scx_root);
2455
2456 if (root && unlikely(READ_ONCE(root->dead)))
2457 return NULL;
2458 return root;
2459 }
2460
scx_parent(struct scx_sched * sch)2461 static inline struct scx_sched *scx_parent(struct scx_sched *sch) { return NULL; }
2462
2463 #endif /* CONFIG_EXT_SUB_SCHED */
2464
2465 #endif /* _KERNEL_SCHED_EXT_INTERNAL_H */
2466