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