Files
linux/kernel/sched/ext/internal.h
T
Tejun Heo a9e3760b08 sched_ext: Maintain an online cid mask in the scheduler arena
Schedulers on the default cid mapping treat [0, nr_online_cids) as the
online set and restart on hotplug. Schedulers that install their own mapping
with scx_bpf_cid_override() have no way to learn which cids are online: the
count no longer identifies members and the CPU-form cpumask is unusable from
cid programs. This is an obvious hole in the cid API.

Add scx_bpf_online_cmask(), a kernel-maintained cmask in the scheduler's
arena, allocated alongside the per-CPU scratch masks and populated after the
cid mapping is finalized and before ops.init(), for child schedulers too.
The pointer stays valid through ops.exit() with no reference to take. It is
the arena offset as a void pointer, the same form struct_ops arena arguments
arrive in. The verifier types the void return as a scalar for the program's
arena cast.

The mask follows the SCX hotplug notifications: seeded from cpu_active_mask
and updated before ops.cid_online/offline() runs, so it lags cpu_online_mask
only inside a hotplug transition. Updates walk the scheduler list under the
lock that also serializes unlinking. Reads are live, not atomic snapshots.
Root initialization excludes hotplug.

v2: Reworded the getter kerneldoc (Andrea Righi).

Signed-off-by: Tejun Heo <tj@kernel.org>
Reviewed-by: Andrea Righi <arighi@nvidia.com>
2026-09-15 06:57:20 -10:00

2497 lines
85 KiB
C

/* SPDX-License-Identifier: GPL-2.0 */
/*
* BPF extensible scheduler class: Documentation/scheduler/sched-ext.rst
*
* Copyright (c) 2025 Meta Platforms, Inc. and affiliates.
* Copyright (c) 2025 Tejun Heo <tj@kernel.org>
*/
#ifndef _KERNEL_SCHED_EXT_INTERNAL_H
#define _KERNEL_SCHED_EXT_INTERNAL_H
#include "../sched.h"
#include "types.h"
#include <trace/events/sched_ext.h>
/**
* scx_add_event - Increase an event counter for 'name' by 'cnt'
* @sch: scx_sched to account events for
* @name: an event name defined in struct scx_event_stats
* @cnt: the number of the event occurred
*
* This can be used when preemption is not disabled.
*/
#define scx_add_event(sch, name, cnt) do { \
this_cpu_add((sch)->pcpu->event_stats.name, (cnt)); \
trace_sched_ext_event(#name, (cnt)); \
} while(0)
/**
* __scx_add_event - Increase an event counter for 'name' by 'cnt'
* @sch: scx_sched to account events for
* @name: an event name defined in struct scx_event_stats
* @cnt: the number of the event occurred
*
* This should be used only when preemption is disabled.
*/
#define __scx_add_event(sch, name, cnt) do { \
__this_cpu_add((sch)->pcpu->event_stats.name, (cnt)); \
trace_sched_ext_event(#name, cnt); \
} while(0)
#define SCX_OP_IDX(op) (offsetof(struct sched_ext_ops, op) / sizeof(void (*)(void)))
#define SCX_MOFF_IDX(moff) ((moff) / sizeof(void (*)(void)))
enum scx_exit_kind {
SCX_EXIT_NONE,
SCX_EXIT_DONE,
SCX_EXIT_UNREG = 64, /* user-space initiated unregistration */
SCX_EXIT_UNREG_BPF, /* BPF-initiated unregistration */
SCX_EXIT_UNREG_KERN, /* kernel-initiated unregistration */
SCX_EXIT_SYSRQ, /* requested by 'S' sysrq */
SCX_EXIT_PARENT, /* parent exiting */
SCX_EXIT_PARENT_KILL, /* killed by parent scheduler */
SCX_EXIT_ERROR = 1024, /* runtime error, error msg contains details */
SCX_EXIT_ERROR_BPF, /* ERROR but triggered through scx_bpf_error() */
SCX_EXIT_ERROR_STALL, /* watchdog detected stalled runnable tasks */
SCX_EXIT_ERROR_REENQ, /* task hit reenqueue limit without running */
SCX_EXIT_ERROR_RESCUE, /* ejected for overloading rescue execution */
};
/*
* An exit code can be specified when exiting with scx_bpf_exit() or scx_exit(),
* corresponding to exit_kind UNREG_BPF and UNREG_KERN respectively. The codes
* are 64bit of the format:
*
* Bits: [63 .. 48 47 .. 32 31 .. 0]
* [ SYS ACT ] [ SYS RSN ] [ USR ]
*
* SYS ACT: System-defined exit actions
* SYS RSN: System-defined exit reasons
* USR : User-defined exit codes and reasons
*
* Using the above, users may communicate intention and context by ORing system
* actions and/or system reasons with a user-defined exit code.
*/
enum scx_exit_code {
/* Reasons */
SCX_ECODE_RSN_HOTPLUG = 1LLU << 32,
SCX_ECODE_RSN_CGROUP_OFFLINE = 2LLU << 32,
/* Actions */
SCX_ECODE_ACT_RESTART = 1LLU << 48,
};
enum scx_exit_flags {
/*
* ops.exit() may be called even if the loading failed before ops.init()
* finishes successfully. This is because ops.exit() allows rich exit
* info communication. The following flag indicates whether ops.init()
* finished successfully.
*/
SCX_EFLAG_INITIALIZED = 1LLU << 0,
};
/*
* scx_exit_info is passed to ops.exit() to describe why the BPF scheduler is
* being disabled.
*/
struct scx_exit_info {
/* %SCX_EXIT_* - broad category of the exit reason */
enum scx_exit_kind kind;
/*
* CPU that initiated the exit, valid once @kind has been set.
* Negative if the exit path didn't identify a CPU.
*/
s32 exit_cpu;
/* exit code if gracefully exiting */
s64 exit_code;
/* %SCX_EFLAG_* */
u64 flags;
/* textual representation of the above */
const char *reason;
/* backtrace if exiting due to an error */
unsigned long *bt;
u32 bt_len;
/* informational message */
char *msg;
/* debug dump */
char *dump;
};
/* sched_ext_ops.flags */
enum scx_ops_flags {
/*
* Keep built-in idle tracking even if ops.update_idle() is implemented.
*/
SCX_OPS_KEEP_BUILTIN_IDLE = 1LLU << 0,
/*
* By default, if there are no other task to run on the CPU, ext core
* keeps running the current task even after its slice expires. If this
* flag is specified, such tasks are passed to ops.enqueue() with
* %SCX_ENQ_LAST. See the comment above %SCX_ENQ_LAST for more info.
*/
SCX_OPS_ENQ_LAST = 1LLU << 1,
/*
* An exiting task may schedule after PF_EXITING is set. In such cases,
* bpf_task_from_pid() may not be able to find the task and if the BPF
* scheduler depends on pid lookup for dispatching, the task will be
* lost leading to various issues including RCU grace period stalls.
*
* To mask this problem, by default, unhashed tasks are automatically
* dispatched to the local DSQ on enqueue. If the BPF scheduler doesn't
* depend on pid lookups and wants to handle these tasks directly, the
* following flag can be used. With %SCX_OPS_TID_TO_TASK,
* scx_bpf_tid_to_task() can find exiting tasks reliably.
*/
SCX_OPS_ENQ_EXITING = 1LLU << 2,
/*
* If set, only tasks with policy set to SCHED_EXT are attached to
* sched_ext. If clear, SCHED_NORMAL tasks are also included.
*/
SCX_OPS_SWITCH_PARTIAL = 1LLU << 3,
/*
* A migration disabled task can only execute on its current CPU. By
* default, such tasks are automatically put on the CPU's local DSQ with
* the default slice on enqueue. If this ops flag is set, they also go
* through ops.enqueue().
*
* A migration disabled task never invokes ops.select_cpu() as it can
* only select the current CPU. Also, p->cpus_ptr will only contain its
* current CPU while p->nr_cpus_allowed keeps tracking p->user_cpus_ptr
* and thus may disagree with cpumask_weight(p->cpus_ptr).
*/
SCX_OPS_ENQ_MIGRATION_DISABLED = 1LLU << 4,
/*
* Queued wakeup (ttwu_queue) is a wakeup optimization that invokes
* ops.enqueue() on the ops.select_cpu() selected or the wakee's
* previous CPU via IPI (inter-processor interrupt) to reduce cacheline
* transfers. When this optimization is enabled, ops.select_cpu() is
* skipped in some cases (when racing against the wakee switching out).
* As the BPF scheduler may depend on ops.select_cpu() being invoked
* during wakeups, queued wakeup is disabled by default.
*
* If this ops flag is set, queued wakeup optimization is enabled and
* the BPF scheduler must be able to handle ops.enqueue() invoked on the
* wakee's CPU without preceding ops.select_cpu() even for tasks which
* may be executed on multiple CPUs.
*/
SCX_OPS_ALLOW_QUEUED_WAKEUP = 1LLU << 5,
/*
* If set, enable per-node idle cpumasks. If clear, use a single global
* flat idle cpumask.
*/
SCX_OPS_BUILTIN_IDLE_PER_NODE = 1LLU << 6,
/*
* If set, %SCX_ENQ_IMMED is assumed to be set on all local DSQ
* enqueues.
*/
SCX_OPS_ALWAYS_ENQ_IMMED = 1LLU << 7,
/*
* Maintain a mapping from p->scx.tid to task_struct so the BPF
* scheduler can recover task pointers from stored tids via
* scx_bpf_tid_to_task().
*
* Only the root scheduler turns this on. A sub-sched may set the flag
* to declare a dependency on the lookup; if the root scheduler hasn't
* enabled it, attaching the sub-sched is rejected.
*/
SCX_OPS_TID_TO_TASK = 1LLU << 8,
SCX_OPS_ALL_FLAGS = SCX_OPS_KEEP_BUILTIN_IDLE |
SCX_OPS_ENQ_LAST |
SCX_OPS_ENQ_EXITING |
SCX_OPS_ENQ_MIGRATION_DISABLED |
SCX_OPS_ALLOW_QUEUED_WAKEUP |
SCX_OPS_SWITCH_PARTIAL |
SCX_OPS_BUILTIN_IDLE_PER_NODE |
SCX_OPS_ALWAYS_ENQ_IMMED |
SCX_OPS_TID_TO_TASK,
/* high 8 bits are internal, don't include in SCX_OPS_ALL_FLAGS */
__SCX_OPS_INTERNAL_MASK = 0xffLLU << 56,
SCX_OPS_HAS_CPU_PREEMPT = 1LLU << 56,
};
/* argument container for ops.init_task() */
struct scx_init_task_args {
/*
* Set if ops.init_task() is being invoked on the fork path, as opposed
* to the scheduler transition path.
*/
bool fork;
#ifdef CONFIG_EXT_GROUP_SCHED
/* the cgroup the task is joining */
struct cgroup *cgroup;
#endif
};
/* argument container for ops.exit_task() */
struct scx_exit_task_args {
/* Whether the task exited before running on sched_ext. */
bool cancelled;
};
/* argument container for ops.cgroup_init() */
struct scx_cgroup_init_args {
/* the weight of the cgroup [1..10000] */
u32 weight;
/* bandwidth control parameters from cpu.max and cpu.max.burst */
u64 bw_period_us;
u64 bw_quota_us;
u64 bw_burst_us;
/* whether the cgroup is configured SCHED_IDLE via cpu.idle */
bool sched_idle;
};
enum scx_cpu_preempt_reason {
/* next task is being scheduled by &sched_class_rt */
SCX_CPU_PREEMPT_RT,
/* next task is being scheduled by &sched_class_dl */
SCX_CPU_PREEMPT_DL,
/* next task is being scheduled by &sched_class_stop */
SCX_CPU_PREEMPT_STOP,
/* unknown reason for SCX being preempted */
SCX_CPU_PREEMPT_UNKNOWN,
};
/*
* Argument container for ops.cpu_acquire(). Currently empty, but may be
* expanded in the future.
*/
struct scx_cpu_acquire_args {};
/* argument container for ops.cpu_release() */
struct scx_cpu_release_args {
/* the reason the CPU was preempted */
enum scx_cpu_preempt_reason reason;
/* the task that's going to be scheduled on the CPU */
struct task_struct *task;
};
/* informational context provided to dump operations */
struct scx_dump_ctx {
enum scx_exit_kind kind;
s64 exit_code;
const char *reason;
u64 at_ns;
u64 at_jiffies;
};
/* argument container for ops.sub_attach() */
struct scx_sub_attach_args {
struct sched_ext_ops *ops;
char *cgroup_path;
};
/* argument container for ops.sub_detach() */
struct scx_sub_detach_args {
struct sched_ext_ops *ops;
char *cgroup_path;
};
/**
* struct sched_ext_ops - Operation table for BPF scheduler implementation
*
* A BPF scheduler can implement an arbitrary scheduling policy by
* implementing and loading operations in this table. Note that a userland
* scheduling policy can also be implemented using the BPF scheduler
* as a shim layer.
*/
struct sched_ext_ops {
/**
* @select_cpu: Pick the target CPU for a task which is being woken up
* @p: task being woken up
* @prev_cpu: the cpu @p was on before sleeping
* @wake_flags: SCX_WAKE_*
*
* Decision made here isn't final. @p may be moved to any CPU while it
* is getting dispatched for execution later. However, as @p is not on
* the rq at this point, getting the eventual execution CPU right here
* saves a small bit of overhead down the line.
*
* If an idle CPU is returned, the CPU is kicked and will try to
* dispatch. While an explicit custom mechanism can be added,
* select_cpu() serves as the default way to wake up idle CPUs.
*
* @p may be inserted into a DSQ directly by calling
* scx_bpf_dsq_insert(). If so, the ops.enqueue() will be skipped.
* Directly inserting into %SCX_DSQ_LOCAL will put @p in the local DSQ
* of the CPU returned by this operation.
*
* Note that select_cpu() is never called for tasks that can only run
* on a single CPU or tasks with migration disabled, as they don't have
* the option to select a different CPU. See select_task_rq() for
* details.
*/
s32 (*select_cpu)(struct task_struct *p, s32 prev_cpu, u64 wake_flags);
/**
* @enqueue: Enqueue a task on the BPF scheduler
* @p: task being enqueued
* @enq_flags: %SCX_ENQ_*
*
* @p is ready to run. Insert directly into a DSQ by calling
* scx_bpf_dsq_insert() or enqueue on the BPF scheduler. If not directly
* inserted, the bpf scheduler owns @p and if it fails to dispatch @p,
* the task will stall.
*
* If @p was inserted into a DSQ from ops.select_cpu(), this callback is
* skipped.
*/
void (*enqueue)(struct task_struct *p, u64 enq_flags);
/**
* @dequeue: Remove a task from the BPF scheduler
* @p: task being dequeued
* @deq_flags: %SCX_DEQ_*
*
* Remove @p from the BPF scheduler. This is usually called to isolate
* the task while updating its scheduling properties (e.g. priority).
*
* The ext core keeps track of whether the BPF side owns a given task or
* not and can gracefully ignore spurious dispatches from BPF side,
* which makes it safe to not implement this method. However, depending
* on the scheduling logic, this can lead to confusing behaviors - e.g.
* scheduling position not being updated across a priority change.
*/
void (*dequeue)(struct task_struct *p, u64 deq_flags);
/**
* @dispatch: Dispatch tasks from the BPF scheduler and/or user DSQs
* @cpu: CPU to dispatch tasks for
* @prev: previous task being switched out
*
* Called when a CPU's local dsq is empty. The operation should dispatch
* one or more tasks from the BPF scheduler into the DSQs using
* scx_bpf_dsq_insert() and/or move from user DSQs into the local DSQ
* using scx_bpf_dsq_move_to_local().
*
* The maximum number of times scx_bpf_dsq_insert() can be called
* without an intervening scx_bpf_dsq_move_to_local() is specified by
* ops.dispatch_max_batch. See the comments on top of the two functions
* for more details.
*
* When not %NULL, @prev is an SCX task with its slice depleted. If
* @prev is still runnable as indicated by set %SCX_TASK_QUEUED in
* @prev->scx.flags, it is not enqueued yet and will be enqueued after
* ops.dispatch() returns. To keep executing @prev, return without
* dispatching or moving any tasks. Also see %SCX_OPS_ENQ_LAST.
*/
void (*dispatch)(s32 cpu, struct task_struct *prev);
/**
* @tick: Periodic tick
* @p: task running currently
*
* This operation is called every 1/HZ seconds on CPUs which are
* executing an SCX task. Setting a slice of 0 for @p with
* scx_bpf_task_set_slice() will trigger an immediate dispatch cycle on
* the CPU.
*/
void (*tick)(struct task_struct *p);
/**
* @runnable: A task is becoming runnable on its associated CPU
* @p: task becoming runnable
* @enq_flags: %SCX_ENQ_*
*
* This and the following three functions can be used to track a task's
* execution state transitions. A task becomes ->runnable() on a CPU,
* and then goes through one or more ->running() and ->stopping() pairs
* as it runs on the CPU, and eventually becomes ->quiescent() when it's
* done running on the CPU.
*
* @p is becoming runnable on the CPU because it's
*
* - waking up (%SCX_ENQ_WAKEUP)
* - being moved from another CPU
* - being restored after temporarily taken off the queue for an
* attribute change.
*
* This and ->enqueue() are related but not coupled. This operation
* notifies @p's state transition and may not be followed by ->enqueue()
* e.g. when @p is being dispatched to a remote CPU, or when @p is
* being enqueued on a CPU experiencing a hotplug event. Likewise, a
* task may be ->enqueue()'d without being preceded by this operation
* e.g. after exhausting its slice.
*/
void (*runnable)(struct task_struct *p, u64 enq_flags);
/**
* @running: A task is starting to run on its associated CPU
* @p: task starting to run
*
* Note that this callback may be called from a CPU other than the
* one the task is going to run on. This can happen when a task
* property is changed (i.e., affinity), since set_next_task_scx(),
* which triggers this callback, may run on a CPU different from
* the task's assigned CPU.
*
* Therefore, always use scx_bpf_task_cpu(@p) to determine the
* target CPU the task is going to use.
*
* See ->runnable() for explanation on the task state notifiers.
*/
void (*running)(struct task_struct *p);
/**
* @stopping: A task is stopping execution
* @p: task stopping to run
* @runnable: is task @p still runnable?
*
* Note that this callback may be called from a CPU other than the
* one the task was running on. This can happen when a task
* property is changed (i.e., affinity), since dequeue_task_scx(),
* which triggers this callback, may run on a CPU different from
* the task's assigned CPU.
*
* Therefore, always use scx_bpf_task_cpu(@p) to retrieve the CPU
* the task was running on.
*
* See ->runnable() for explanation on the task state notifiers. If
* !@runnable, ->quiescent() will be invoked after this operation
* returns.
*/
void (*stopping)(struct task_struct *p, bool runnable);
/**
* @quiescent: A task is becoming not runnable on its associated CPU
* @p: task becoming not runnable
* @deq_flags: %SCX_DEQ_*
*
* See ->runnable() for explanation on the task state notifiers.
*
* @p is becoming quiescent on the CPU because it's
*
* - sleeping (%SCX_DEQ_SLEEP)
* - being moved to another CPU
* - being temporarily taken off the queue for an attribute change
* (%SCX_DEQ_SCHED_CHANGE)
*
* This and ->dequeue() are related but not coupled. This operation
* notifies @p's state transition and may not be preceded by ->dequeue()
* e.g. when @p is being dispatched to a remote CPU.
*/
void (*quiescent)(struct task_struct *p, u64 deq_flags);
/**
* @yield: Yield CPU
* @from: yielding task
* @to: optional yield target task
*
* If @to is NULL, @from is yielding the CPU to other runnable tasks.
* The BPF scheduler should ensure that other available tasks are
* dispatched before the yielding task. Return value is ignored in this
* case.
*
* If @to is not-NULL, @from wants to yield the CPU to @to. If the bpf
* scheduler can implement the request, return %true; otherwise, %false.
*/
bool (*yield)(struct task_struct *from, struct task_struct *to);
/**
* @core_sched_before: Task ordering for core-sched
* @a: task A
* @b: task B
*
* Used by core-sched to determine the ordering between two tasks. See
* Documentation/admin-guide/hw-vuln/core-scheduling.rst for details on
* core-sched.
*
* Both @a and @b are runnable and may or may not currently be queued on
* the BPF scheduler. Should return %true if @a should run before @b.
* %false if there's no required ordering or @b should run before @a.
*
* In a scheduler hierarchy, a pair spanning two schedulers is ordered
* by the nearest common ancestor implementing this op, so the op may be
* called on tasks that the scheduler delegated to its sub-schedulers
* and is not scheduling anymore. See scx_prio_less().
*
* If not specified, the default is ordering them according to when they
* became runnable.
*/
bool (*core_sched_before)(struct task_struct *a, struct task_struct *b);
/**
* @set_weight: Set task weight
* @p: task to set weight for
* @weight: new weight [1..10000]
*
* Update @p's weight to @weight.
*/
void (*set_weight)(struct task_struct *p, u32 weight);
/**
* @set_cpumask: Set CPU affinity
* @p: task to set CPU affinity for
* @cpumask: cpumask of cpus that @p can run on
*
* Update @p's CPU affinity to @cpumask.
*/
void (*set_cpumask)(struct task_struct *p,
const struct cpumask *cpumask);
/**
* @update_idle: Update the idle state of a CPU
* @cpu: CPU to update the idle state for
* @idle: whether entering or exiting the idle state
*
* This operation is called when @rq's CPU goes or leaves the idle
* state. By default, implementing this operation disables the built-in
* idle CPU tracking and the following helpers become unavailable:
*
* - scx_bpf_select_cpu_dfl()
* - scx_bpf_select_cpu_and()
* - scx_bpf_test_and_clear_cpu_idle()
* - scx_bpf_pick_idle_cpu()
*
* The user also must implement ops.select_cpu() as the default
* implementation relies on scx_bpf_select_cpu_dfl().
*
* Specify the %SCX_OPS_KEEP_BUILTIN_IDLE flag to keep the built-in idle
* tracking.
*
* Only actual transitions are reported. A CPU that is claimed with an
* idle pick and kicked but dispatches no task returns to idle without a
* transition. A scheduler tracking idle CPUs itself must restore the
* idle state from ops.dispatch() when it returns without the next task
* to run.
*/
void (*update_idle)(s32 cpu, bool idle);
/**
* @init_task: Initialize a task to run in a BPF scheduler
* @p: task to initialize for BPF scheduling
* @args: init arguments, see the struct definition
*
* Either we're loading a BPF scheduler or a new task is being forked.
* Initialize @p for BPF scheduling. This operation may block and can
* be used for allocations, and is called exactly once for a task.
*
* Return 0 for success, -errno for failure. An error return while
* loading will abort loading of the BPF scheduler. During a fork, it
* will abort that specific fork.
*/
s32 (*init_task)(struct task_struct *p, struct scx_init_task_args *args);
/**
* @exit_task: Exit a previously-running task from the system
* @p: task to exit
* @args: exit arguments, see the struct definition
*
* @p is exiting or the BPF scheduler is being unloaded. Perform any
* necessary cleanup for @p.
*/
void (*exit_task)(struct task_struct *p, struct scx_exit_task_args *args);
/**
* @enable: Enable BPF scheduling for a task
* @p: task to enable BPF scheduling for
*
* Enable @p for BPF scheduling. enable() is called on @p any time it
* enters SCX, and is always paired with a matching disable().
*/
void (*enable)(struct task_struct *p);
/**
* @disable: Disable BPF scheduling for a task
* @p: task to disable BPF scheduling for
*
* @p is exiting, leaving SCX or the BPF scheduler is being unloaded.
* Disable BPF scheduling for @p. A disable() call is always matched
* with a prior enable() call.
*/
void (*disable)(struct task_struct *p);
/**
* @dump: Dump BPF scheduler state on error
* @ctx: debug dump context
*
* Use scx_bpf_dump() to generate BPF scheduler specific debug dump.
*/
void (*dump)(struct scx_dump_ctx *ctx);
/**
* @dump_cpu: Dump BPF scheduler state for a CPU on error
* @ctx: debug dump context
* @cpu: CPU to generate debug dump for
* @idle: @cpu is currently idle without any runnable tasks
*
* Use scx_bpf_dump() to generate BPF scheduler specific debug dump for
* @cpu. If @idle is %true and this operation doesn't produce any
* output, @cpu is skipped for dump.
*/
void (*dump_cpu)(struct scx_dump_ctx *ctx, s32 cpu, bool idle);
/**
* @dump_task: Dump BPF scheduler state for a runnable task on error
* @ctx: debug dump context
* @p: runnable task to generate debug dump for
*
* Use scx_bpf_dump() to generate BPF scheduler specific debug dump for
* @p.
*/
void (*dump_task)(struct scx_dump_ctx *ctx, struct task_struct *p);
#ifdef CONFIG_EXT_GROUP_SCHED
/**
* @cgroup_init: Initialize a cgroup
* @cgrp: cgroup being initialized
* @args: init arguments, see the struct definition
*
* Initialize @cgrp for sched_ext, delivered to @cgrp's sched either
* when the BPF scheduler is being loaded or when @cgrp is created. This
* operation may block.
*
* Cgroup handovers also generate these ops: an enabling sub-scheduler
* receives ops.cgroup_init() for every cgroup in its subtree while the
* previous sched receives ops.cgroup_exit(), and disabling reverses the
* two.
*
* When the BPF scheduler is being loaded or cgroups are being handed
* over, @cgrp may already have been removed by userspace: a removed
* cgroup stays schedulable until its dying tasks finish their final
* context switches.
*
* Return 0 for success, -errno for failure. An error return while
* loading will abort loading of the BPF scheduler. During cgroup
* creation, it will abort the specific cgroup creation.
*/
s32 (*cgroup_init)(struct cgroup *cgrp,
struct scx_cgroup_init_args *args);
/**
* @cgroup_exit: Exit a cgroup
* @cgrp: cgroup being exited
*
* Exit @cgrp for sched_ext, delivered to the sched whose
* ops.cgroup_init() it pairs with, either when the BPF scheduler is
* being unloaded or when @cgrp is destroyed. This operation may block.
*
* For a destroyed @cgrp, delivery follows the last scheduling event on
* it: a removed cgroup stays schedulable until its dying tasks finish
* their final context switches.
*/
void (*cgroup_exit)(struct cgroup *cgrp);
/**
* @cgroup_prep_move: Prepare a task to be moved to a different cgroup
* @p: task being moved
* @from: cgroup @p is being moved from
* @to: cgroup @p is being moved to
*
* Prepare @p for move from cgroup @from to @to. This operation may
* block and can be used for allocations.
*
* The cgroup_move ops are delivered to @p's sched, and only for moves
* that don't re-home @p. A re-homing move is reported through
* ops.exit_task() and ops.init_task() instead. @from and @to can
* reference cgroups the sched never received ops.cgroup_init() for, as
* the cpu controller can be coarser than the sub-scheduler topology.
*
* Return 0 for success, -errno for failure. An error return aborts the
* migration.
*/
s32 (*cgroup_prep_move)(struct task_struct *p,
struct cgroup *from, struct cgroup *to);
/**
* @cgroup_move: Commit cgroup move
* @p: task being moved
* @from: cgroup @p is being moved from
* @to: cgroup @p is being moved to
*
* Commit the move. @p is dequeued during this operation.
*/
void (*cgroup_move)(struct task_struct *p,
struct cgroup *from, struct cgroup *to);
/**
* @cgroup_cancel_move: Cancel cgroup move
* @p: task whose cgroup move is being canceled
* @from: cgroup @p was being moved from
* @to: cgroup @p was being moved to
*
* @p was cgroup_prep_move()'d but failed before reaching cgroup_move().
* Undo the preparation.
*/
void (*cgroup_cancel_move)(struct task_struct *p,
struct cgroup *from, struct cgroup *to);
/**
* @cgroup_set_weight: A cgroup's weight is being changed
* @cgrp: cgroup whose weight is being updated
* @weight: new weight [1..10000]
*
* Update @cgrp's weight to @weight.
*
* Knobs of a cgroup belong to the parent, so the set_* ops are
* delivered to @cgrp's parent's sched. That sched may never have seen
* ops.cgroup_init() for @cgrp - at a sub-scheduler attach point, the
* parent sched tracks @cgrp through ops.sub_attach() instead.
*/
void (*cgroup_set_weight)(struct cgroup *cgrp, u32 weight);
/**
* @cgroup_set_bandwidth: A cgroup's bandwidth is being changed
* @cgrp: cgroup whose bandwidth is being updated
* @period_us: bandwidth control period
* @quota_us: bandwidth control quota
* @burst_us: bandwidth control burst
*
* Update @cgrp's bandwidth control parameters. This is from the cpu.max
* cgroup interface. This operation may block.
*
* @quota_us / @period_us determines the CPU bandwidth @cgrp is entitled
* to. For example, if @period_us is 1_000_000 and @quota_us is
* 2_500_000. @cgrp is entitled to 2.5 CPUs. @burst_us can be
* interpreted in the same fashion and specifies how much @cgrp can
* burst temporarily. The specific control mechanism and thus the
* interpretation of @period_us and burstiness is up to the BPF
* scheduler.
*
* Delivery follows the same rule as cgroup_set_weight().
*/
void (*cgroup_set_bandwidth)(struct cgroup *cgrp,
u64 period_us, u64 quota_us, u64 burst_us);
/**
* @cgroup_set_idle: A cgroup's idle state is being changed
* @cgrp: cgroup whose idle state is being updated
* @idle: whether the cgroup is entering or exiting idle state
*
* Update @cgrp's idle state to @idle. This callback is invoked when
* a cgroup transitions between idle and non-idle states, allowing the
* BPF scheduler to adjust its behavior accordingly.
*
* Delivery follows the same rule as cgroup_set_weight().
*/
void (*cgroup_set_idle)(struct cgroup *cgrp, bool idle);
#endif /* CONFIG_EXT_GROUP_SCHED */
/**
* @sub_attach: Attach a sub-scheduler
* @args: argument container, see the struct definition
*
* Return 0 to accept the sub-scheduler. -errno to reject.
*/
s32 (*sub_attach)(struct scx_sub_attach_args *args);
/**
* @sub_detach: Detach a sub-scheduler
* @args: argument container, see the struct definition
*/
void (*sub_detach)(struct scx_sub_detach_args *args);
/**
* @sub_caps_updated: Caps on this sub-sched's shard changed
* @cmask: cids whose caps changed (cmask->base identifies the shard)
* @caps: SCX_CAP_* that changed
*
* Invoked after grant or revoke modifies caps on a shard. There can be
* only one in-flight invocation per shard. @cmask and @caps coalesce
* all changes since the last delivery. Direction (set vs cleared) isn't
* encoded. Query current state with scx_bpf_sub_caps().
*
* Delivered asynchronously after the change is recorded, and may run
* before it takes effect on any given cpu. Use it to track which caps
* the sub-sched holds and propagate to its own children, not to decide
* if a task can run on a cpu now. sub_ecaps_updated() reports that per
* cpu, once it is in effect.
*
* May call scx_bpf_sub_grant() / scx_bpf_sub_revoke() on children.
*/
void (*sub_caps_updated)(const struct scx_cmask *cmask, u64 caps);
/**
* @sub_ecaps_updated: This sub-sched's effective caps on a cid changed
* @cid: the cid whose effective caps changed
* @before: effective caps as of the last delivery
* @after: effective caps now
*
* Invoked when this sub-sched's effective caps on @cid change, once the
* change is in effect on the cpu. Runs in dispatch context with rq lock
* held, and can perform all operations allowed in ops.dispatch()
* including inserting/moving tasks.
*/
void (*sub_ecaps_updated)(s32 cid, u64 before, u64 after);
/*
* All online ops must come before ops.cpu_online().
*/
/**
* @cpu_online: A CPU became online
* @cpu: CPU which just came up
*
* @cpu just came online. @cpu will not call ops.enqueue() or
* ops.dispatch(), nor run tasks associated with other CPUs beforehand.
*/
void (*cpu_online)(s32 cpu);
/**
* @cpu_offline: A CPU is going offline
* @cpu: CPU which is going offline
*
* @cpu is going offline. @cpu will not call ops.enqueue() or
* ops.dispatch(), nor run tasks associated with other CPUs afterwards.
*/
void (*cpu_offline)(s32 cpu);
/*
* All CPU hotplug ops must come before ops.init_cids().
*/
/**
* @init_cids: Finalize the cid layout (cid-form only)
*
* Runs after the default cid layout is built, before caps and shards
* are finalized. A cid-form scheduler may call scx_bpf_cid_override()
* here for a custom layout. Ignored for cpu-form schedulers.
*/
s32 (*init_cids)(void);
/**
* @init: Initialize the BPF scheduler
*/
s32 (*init)(void);
/**
* @exit: Clean up after the BPF scheduler
* @info: Exit info
*
* ops.exit() is also called on ops.init() failure, which is a bit
* unusual. This is to allow rich reporting through @info on how
* ops.init() failed.
*/
void (*exit)(struct scx_exit_info *info);
/*
* Data fields must comes after all ops fields.
*/
/**
* @dispatch_max_batch: Max nr of tasks that dispatch() can dispatch
*/
u32 dispatch_max_batch;
/**
* @flags: %SCX_OPS_* flags
*/
u64 flags;
/**
* @timeout_ms: The maximum amount of time, in milliseconds, that a
* runnable task should be able to wait before being scheduled. The
* maximum timeout may not exceed the default timeout of 30 seconds.
*
* Defaults to the maximum allowed timeout value of 30 seconds.
*/
u32 timeout_ms;
/**
* @exit_dump_len: scx_exit_info.dump buffer length. If 0, the default
* value of 32768 is used.
*/
u32 exit_dump_len;
/**
* @hotplug_seq: A sequence number that may be set by the scheduler to
* detect when a hotplug event has occurred during the loading process.
* If 0, no detection occurs. Otherwise, the scheduler will fail to
* load if the sequence number does not match @scx_hotplug_seq on the
* enable path.
*/
u64 hotplug_seq;
/**
* @cid_shard_size: Target number of CIDs per shard
*
* Shards are contiguous CID ranges used as operation and locking
* domains for sub-scheduling. Each LLC is divided into ceil(nr_cpus /
* @cid_shard_size) shards, then cores are distributed across them
* evenly. If one core has more logical CPUs than @cid_shard_size, its
* shard will become larger than @cid_shard_size. Values above
* SCX_CID_SHARD_MAX_CPUS are capped. 0 means use the default (24).
*/
u32 cid_shard_size;
/**
* @rescue_bandwidth_ppt: Rescue execution bandwidth in parts per thousand
*
* The fraction of each CPU's time that may be consumed running tasks
* from its rescue DSQ. A higher bandwidth admits and escalates rescues
* faster, see @rescue_quantum_us.
*
* Only the root scheduler's value is used. 0 means the default of 20
* (2%). May not exceed 250 (25%). %SCX_RESCUE_DISABLE disables rescue -
* %SCX_ENQ_RESCUE inserts are then rejected like any other insert
* lacking the caps.
*/
u32 rescue_bandwidth_ppt;
/**
* @rescue_quantum_us: Rescue execution quantum in microseconds
*
* How much CPU time each rescue gets. Rescues run one at a time per CPU
* and admissions are paced to keep rescue execution within
* @rescue_bandwidth_ppt - with the defaults, one 5ms rescue every
* 250ms. A crowded queue round-robins on the quantum divided across the
* waiters, floored at 1ms. A stuck rescue eventually escalates to
* forced execution. A larger quantum interrupts the CPU less often but
* for longer and spaces rescues further apart.
*
* Only the root scheduler's value is used. 0 means the default (5000).
* Non-zero values must be within [1000, 100000]. Values too short for
* the kernel to meter are lifted silently.
*/
u32 rescue_quantum_us;
/**
* @sub_cgroup_id: When >1, attach the scheduler as a sub-scheduler
* on the specified cgroup.
*/
u64 sub_cgroup_id;
/**
* @name: BPF scheduler's name
*
* Must be a non-zero valid BPF object name including only isalnum(),
* '_' and '.' chars. Exposed via the ops file in the scheduler's sysfs
* directory, /sys/kernel/sched_ext/root/ops for the root scheduler,
* while the BPF scheduler is enabled.
*/
char name[SCX_OPS_NAME_LEN];
/* internal use only, must be NULL */
void __rcu *priv;
/*
* Deprecated callbacks. Kept at the end of the struct so the cid-form
* struct (sched_ext_ops_cid) can omit them without affecting the
* shared field offsets. Use SCX_ENQ_IMMED instead. Sitting past
* SCX_OPI_END means has_op doesn't cover them, so SCX_HAS_OP() cannot
* be used; callers must test sch->ops.cpu_acquire / cpu_release
* directly.
*/
/**
* @cpu_acquire: A CPU is becoming available to the BPF scheduler
* @cpu: The CPU being acquired by the BPF scheduler.
* @args: Acquire arguments, see the struct definition.
*
* A CPU that was previously released from the BPF scheduler is now once
* again under its control. Deprecated; use SCX_ENQ_IMMED instead.
*/
void (*cpu_acquire)(s32 cpu, struct scx_cpu_acquire_args *args);
/**
* @cpu_release: A CPU is taken away from the BPF scheduler
* @cpu: The CPU being released by the BPF scheduler.
* @args: Release arguments, see the struct definition.
*
* The specified CPU is no longer under the control of the BPF
* scheduler. This could be because it was preempted by a higher
* priority sched_class, though there may be other reasons as well. The
* caller should consult @args->reason to determine the cause.
* Deprecated; use SCX_ENQ_IMMED instead.
*/
void (*cpu_release)(s32 cpu, struct scx_cpu_release_args *args);
};
/**
* struct sched_ext_ops_cid - cid-form alternative to struct sched_ext_ops
*
* Mirrors struct sched_ext_ops with cpu/cpumask substituted with cid/cmask
* where applicable. Layout up to and including @priv matches sched_ext_ops
* byte-for-byte (verified by BUILD_BUG_ON checks at scx_init() time) so
* shared field offsets work for both struct types in bpf_scx_init_member()
* and bpf_scx_check_member(). The deprecated cpu_acquire/cpu_release
* callbacks at the tail of sched_ext_ops are omitted here entirely.
*
* Differences from sched_ext_ops:
* - select_cpu -> select_cid (returns cid)
* - dispatch -> dispatch (cpu arg is now cid)
* - update_idle -> update_idle (cpu arg is now cid)
* - set_cpumask -> set_cmask (cmask instead of cpumask)
* - cpu_online -> cid_online
* - cpu_offline -> cid_offline
* - dump_cpu -> dump_cid
* - cgroup_* -> cpuctl_* (they track the cgroup cpu controller)
* - cpu_acquire/cpu_release -> not present (deprecated in sched_ext_ops)
*
* BPF schedulers using this type cannot call cpu-form scx_bpf_* kfuncs;
* use the cid-form variants instead. Enforced at BPF verifier time via
* scx_kfunc_context_filter() branching on prog->aux->st_ops.
*
* See sched_ext_ops for callback documentation.
*/
struct sched_ext_ops_cid {
s32 (*select_cid)(struct task_struct *p, s32 prev_cid, u64 wake_flags);
void (*enqueue)(struct task_struct *p, u64 enq_flags);
void (*dequeue)(struct task_struct *p, u64 deq_flags);
void (*dispatch)(s32 cid, struct task_struct *prev);
void (*tick)(struct task_struct *p);
void (*runnable)(struct task_struct *p, u64 enq_flags);
void (*running)(struct task_struct *p);
void (*stopping)(struct task_struct *p, bool runnable);
void (*quiescent)(struct task_struct *p, u64 deq_flags);
bool (*yield)(struct task_struct *from, struct task_struct *to);
bool (*core_sched_before)(struct task_struct *a,
struct task_struct *b);
void (*set_weight)(struct task_struct *p, u32 weight);
void (*set_cmask)(struct task_struct *p,
const struct scx_cmask *cmask__arena);
void (*update_idle)(s32 cid, bool idle);
s32 (*init_task)(struct task_struct *p,
struct scx_init_task_args *args);
void (*exit_task)(struct task_struct *p,
struct scx_exit_task_args *args);
void (*enable)(struct task_struct *p);
void (*disable)(struct task_struct *p);
void (*dump)(struct scx_dump_ctx *ctx);
void (*dump_cid)(struct scx_dump_ctx *ctx, s32 cid, bool idle);
void (*dump_task)(struct scx_dump_ctx *ctx, struct task_struct *p);
#ifdef CONFIG_EXT_GROUP_SCHED
s32 (*cpuctl_init)(struct cgroup *cgrp, struct scx_cgroup_init_args *args);
void (*cpuctl_exit)(struct cgroup *cgrp);
s32 (*cpuctl_prep_move)(struct task_struct *p, struct cgroup *from,
struct cgroup *to);
void (*cpuctl_move)(struct task_struct *p, struct cgroup *from, struct cgroup *to);
void (*cpuctl_cancel_move)(struct task_struct *p, struct cgroup *from,
struct cgroup *to);
void (*cpuctl_set_weight)(struct cgroup *cgrp, u32 weight);
void (*cpuctl_set_bandwidth)(struct cgroup *cgrp, u64 period_us, u64 quota_us,
u64 burst_us);
void (*cpuctl_set_idle)(struct cgroup *cgrp, bool idle);
#endif /* CONFIG_EXT_GROUP_SCHED */
s32 (*sub_attach)(struct scx_sub_attach_args *args);
void (*sub_detach)(struct scx_sub_detach_args *args);
void (*sub_caps_updated)(const struct scx_cmask *cmask__arena, u64 caps);
void (*sub_ecaps_updated)(s32 cid, u64 before, u64 after);
void (*cid_online)(s32 cid);
void (*cid_offline)(s32 cid);
s32 (*init_cids)(void);
s32 (*init)(void);
void (*exit)(struct scx_exit_info *info);
/* Data fields - must match sched_ext_ops layout exactly */
u32 dispatch_max_batch;
u64 flags;
u32 timeout_ms;
u32 exit_dump_len;
u64 hotplug_seq;
u32 cid_shard_size;
u32 rescue_bandwidth_ppt;
u32 rescue_quantum_us;
u64 sub_cgroup_id;
char name[SCX_OPS_NAME_LEN];
/* internal use only, must be NULL */
void __rcu *priv;
/* layout end anchor for the BUILD_BUG_ON in scx_init(); keep last */
char __end[0];
};
enum scx_opi {
SCX_OPI_BEGIN = 0,
SCX_OPI_NORMAL_BEGIN = 0,
SCX_OPI_NORMAL_END = SCX_OP_IDX(cpu_online),
SCX_OPI_CPU_HOTPLUG_BEGIN = SCX_OP_IDX(cpu_online),
SCX_OPI_CPU_HOTPLUG_END = SCX_OP_IDX(init_cids),
SCX_OPI_END = SCX_OP_IDX(init_cids),
};
/*
* Collection of event counters. Event types are placed in descending order.
*/
struct scx_event_stats {
/*
* If ops.select_cpu() returns a CPU which can't be used by the task,
* the core scheduler code silently picks a fallback CPU.
*/
s64 SCX_EV_SELECT_CPU_FALLBACK;
/*
* When dispatching to a local DSQ, the CPU may have gone offline in
* the meantime. In this case, the task is bounced to the global DSQ.
*/
s64 SCX_EV_DISPATCH_LOCAL_DSQ_OFFLINE;
/*
* If SCX_OPS_ENQ_LAST is not set, the number of times that a task
* continued to run because there were no other tasks on the CPU.
*/
s64 SCX_EV_DISPATCH_KEEP_LAST;
/*
* If SCX_OPS_ENQ_EXITING is not set, the number of times that a task
* is dispatched to a local DSQ when exiting.
*/
s64 SCX_EV_ENQ_SKIP_EXITING;
/*
* If SCX_OPS_ENQ_MIGRATION_DISABLED is not set, the number of times a
* migration disabled task skips ops.enqueue() and is dispatched to its
* local DSQ.
*/
s64 SCX_EV_ENQ_SKIP_MIGRATION_DISABLED;
/*
* The number of times a task, enqueued on a local DSQ with
* SCX_ENQ_IMMED, was re-enqueued because the CPU was not available for
* immediate execution.
*/
s64 SCX_EV_REENQ_IMMED;
/*
* The number of times a reenqueue (%SCX_ENQ_REENQ) led to another
* reenqueue without the task running in between. This count climbing
* rapidly indicates that the BPF scheduler keeps re-deciding placements
* it can't honor. A single task reenqueued more than
* %SCX_REENQ_MAX_REPEAT times gets its owning scheduler ejected.
*/
s64 SCX_EV_REENQ_REPEAT;
/*
* Total number of times a task's time slice was refilled with the
* default value (SCX_SLICE_DFL).
*/
s64 SCX_EV_REFILL_SLICE_DFL;
/*
* The number of times an out-of-band slice request exceeded the maximum
* representable value and was clamped.
*/
s64 SCX_EV_SLICE_CLAMPED;
/*
* The number of times a slice extension was denied because the
* scheduler lacked baseline cpu access on the task's cpu.
*/
s64 SCX_EV_SLICE_DENIED;
/*
* The total duration of bypass modes in nanoseconds.
*/
s64 SCX_EV_BYPASS_DURATION;
/*
* The number of tasks dispatched in the bypassing mode.
*/
s64 SCX_EV_BYPASS_DISPATCH;
/*
* The number of times the bypassing mode has been activated.
*/
s64 SCX_EV_BYPASS_ACTIVATE;
/*
* The number of times the scheduler attempted to insert a task that it
* doesn't own into a DSQ. Such attempts are ignored.
*
* As BPF schedulers are allowed to ignore dequeues, it's difficult to
* tell whether such an attempt is from a scheduler malfunction or an
* ignored dequeue around sub-sched enabling. If this count keeps going
* up regardless of sub-sched enabling, it likely indicates a bug in the
* scheduler.
*/
s64 SCX_EV_INSERT_NOT_OWNED;
/*
* The number of times tasks from bypassing descendants are scheduled
* from sub_bypass_dsq's.
*/
s64 SCX_EV_SUB_BYPASS_DISPATCH;
/*
* The number of times a migration-disabled task lacking the cap for its
* cid was allowed onto the local DSQ. It must run on its pinned CPU, so
* it can't be rejected. The violation is counted here.
*/
s64 SCX_EV_SUB_FORCED_ADMIT;
/*
* The number of times a preempting kick was refused because the
* sub-sched lacked SCX_CAP_PREEMPT for a task outside its subtree. The
* kick degrades to a plain reschedule.
*/
s64 SCX_EV_SUB_PREEMPT_DENIED;
/*
* The number of times a kick was skipped because the sub-sched lacked
* baseline access on the target cid. The preempt-part degradation of a
* delivered kick is counted in SCX_EV_SUB_PREEMPT_DENIED instead.
*/
s64 SCX_EV_SUB_KICK_DENIED;
/*
* The number of times a local DSQ reenq was dropped because the
* sub-sched lacked baseline access on the target cid.
*/
s64 SCX_EV_SUB_REENQ_DENIED;
/*
* The number of times scx_bpf_cidperf_set() was denied because the
* sub-sched lacked SCX_CAP_PERF on the target cid.
*/
s64 SCX_EV_SUB_CIDPERF_DENIED;
/*
* The number of times an insert carrying %SCX_ENQ_RESCUE lacked the
* caps for its cid and the task entered the rescue path.
*/
s64 SCX_EV_SUB_RESCUE;
};
#define SCX_EVENTS_LIST(SCX_EVENT) \
SCX_EVENT(SCX_EV_SELECT_CPU_FALLBACK); \
SCX_EVENT(SCX_EV_DISPATCH_LOCAL_DSQ_OFFLINE); \
SCX_EVENT(SCX_EV_DISPATCH_KEEP_LAST); \
SCX_EVENT(SCX_EV_ENQ_SKIP_EXITING); \
SCX_EVENT(SCX_EV_ENQ_SKIP_MIGRATION_DISABLED); \
SCX_EVENT(SCX_EV_REENQ_IMMED); \
SCX_EVENT(SCX_EV_REENQ_REPEAT); \
SCX_EVENT(SCX_EV_REFILL_SLICE_DFL); \
SCX_EVENT(SCX_EV_SLICE_CLAMPED); \
SCX_EVENT(SCX_EV_SLICE_DENIED); \
SCX_EVENT(SCX_EV_BYPASS_DURATION); \
SCX_EVENT(SCX_EV_BYPASS_DISPATCH); \
SCX_EVENT(SCX_EV_BYPASS_ACTIVATE); \
SCX_EVENT(SCX_EV_INSERT_NOT_OWNED); \
SCX_EVENT(SCX_EV_SUB_BYPASS_DISPATCH); \
SCX_EVENT(SCX_EV_SUB_FORCED_ADMIT); \
SCX_EVENT(SCX_EV_SUB_PREEMPT_DENIED); \
SCX_EVENT(SCX_EV_SUB_KICK_DENIED); \
SCX_EVENT(SCX_EV_SUB_REENQ_DENIED); \
SCX_EVENT(SCX_EV_SUB_CIDPERF_DENIED); \
SCX_EVENT(SCX_EV_SUB_RESCUE)
struct scx_sched;
enum scx_sched_pcpu_flags {
SCX_SCHED_PCPU_BYPASSING = 1LLU << 0,
};
/* dispatch buf */
struct scx_dsp_buf_ent {
struct task_struct *task;
unsigned long qseq;
u64 dsq_id;
u64 slice;
u64 vtime;
u64 enq_flags;
};
struct scx_dsp_ctx {
struct rq *rq;
u32 cursor;
u32 nr_tasks;
struct scx_dsp_buf_ent buf[];
};
struct scx_deferred_reenq_local {
struct list_head node;
u64 flags;
};
struct scx_sched_pcpu {
struct scx_sched *sch;
u64 flags; /* protected by rq lock */
/*
* Kick state owned by this cpu for this sched. scx_kick_cpu() records
* targets here and links @to_kick_node onto the cpu's
* rq->scx.sched_pcpus_to_kick. The cpu's single kick irq_work walks
* that list and kicks each sched's targets on its behalf. Per-sched so
* a kick stays attributed to its scheduler.
*/
cpumask_var_t cpus_to_kick;
cpumask_var_t cpus_to_kick_if_idle;
cpumask_var_t cpus_to_preempt;
cpumask_var_t cpus_to_wait;
struct list_head to_kick_node;
#ifdef CONFIG_EXT_SUB_SCHED
/*
* pshard->caps[cap_bit] is the set of cids the sched holds that one
* cap on. ecaps is its transpose: the set of SCX_CAP_* bits the sched
* effectively holds on this cpu, with implied caps folded in, so that
* the hot-path check is a single read.
*
* While pshard->caps[] under pshard->lock is the target configuration,
* ecaps is the effective copy owned by the cpu. It is written under the
* rq lock while processing rq->ecaps_to_sync. Can also be read with
* READ_ONCE() outside rq lock.
*
* See queue_sync_ecaps() and scx_process_sync_ecaps().
*/
u64 ecaps;
struct llist_node ecaps_to_sync_node;
/* owed a forced update_idle() re-notify on this cpu */
bool idle_renotify;
/* effective caps as of the last sub_ecaps_updated() delivery */
u64 reported_ecaps;
/*
* Decaying rescue runtime consumed on this cpu, see
* scx_rescue_decay_avg(). Overload on this cpu ejects the sub with the
* largest value. Accessed only under this cpu's rq lock.
*/
u64 rescue_avg;
u64 rescue_avg_at; /* last decay, jiffies_64 */
#endif
/*
* The event counters are in a per-CPU variable to minimize the
* accounting overhead. A system-wide view on the event counter is
* constructed when requested by scx_bpf_events().
*/
struct scx_event_stats event_stats;
struct scx_deferred_reenq_local deferred_reenq_local;
struct scx_dispatch_q bypass_dsq;
#ifdef CONFIG_EXT_SUB_SCHED
u32 bypass_host_seq;
#endif
/* must be the last entry - contains flex array */
struct scx_dsp_ctx dsp_ctx;
};
struct scx_sched_pnode {
struct scx_dispatch_q global_dsq;
};
/*
* Sub-sched capability delegation.
*
* Caps are per-cid permissions parents delegate to direct children via
* scx_bpf_sub_grant() / scx_bpf_sub_revoke(). A child's cap set is always a
* subset of its parent's. A sub-sched checks its caps locally, and cross-sched
* communication is needed only when the delegation set itself changes.
*
* Caps are used to implement sub-sched scheduling on the enqueue path. Picking
* a cid for a task at a leaf depends on which cids the leaf is allowed to use.
* Resolving that programmatically on every enqueue would mean a cross-sched
* round-trip call chain, possibly retrying if the request can't be granted
* as-is.
*
* The dispatch path is different - it runs as top-down recursion via
* scx_bpf_sub_dispatch(): a sched's dispatch op invokes a child's dispatch op
* on the local rq, and the subtree dispatches in a single pass.
*
* Locking is per shard. cid space is split into shards, and each sub-sched has
* its own pshard->lock for each shard. Operations are broken up on shard
* boundaries. Different shards never contend. Shards are expected to be
* topology-aligned and likely to serve as the locality unit when cids are
* allocated to schedulers, so per-shard lock granularity scales naturally with
* the allocation pattern.
*
* ENQ_IMMED insert an IMMED task onto the cid's local DSQ
* - kick the cid's cpu (except SCX_KICK_PREEMPT)
*
* ENQ insert any task onto the cid's local DSQ (implies ENQ_IMMED)
*
* PREEMPT preempt any task running on the cid regardless of the owning
* sched (implies ENQ). Preempting a task in the sched's own subtree
* doesn't require any cap.
* - SCX_ENQ_PREEMPT inserts
* - SCX_KICK_PREEMPT kicks
*
* PERF control the cid's cpu power/perf management state, currently the
* cpufreq target set through scx_bpf_cidperf_set(). Hardware
* control is a separate axis from queue access: PERF neither
* implies nor is implied by the caps above.
*
* Implied caps apply to the holder's own use of a cid, not to delegation.
* scx_bpf_sub_grant() delegates literally-held caps, so a cap held only through
* implication is usable but cannot be re-delegated to a child. When granting a
* cap, it usually makes sense to delegate its implied caps explicitly alongside
* it.
*/
enum scx_cap_flags {
__SCX_CAP_ENQ_IMMED = 0,
__SCX_CAP_ENQ = 1,
__SCX_CAP_PREEMPT = 2,
__SCX_CAP_PERF = 3,
__SCX_NR_CAPS,
__SCX_CAP_ALL = BIT_U64(__SCX_NR_CAPS) - 1,
SCX_CAP_ENQ_IMMED = BIT_U64(__SCX_CAP_ENQ_IMMED),
SCX_CAP_ENQ = BIT_U64(__SCX_CAP_ENQ),
SCX_CAP_PREEMPT = BIT_U64(__SCX_CAP_PREEMPT),
SCX_CAP_PERF = BIT_U64(__SCX_CAP_PERF),
/* alias for minimal cap to make any use of a cpu */
SCX_CAP_BASE = SCX_CAP_ENQ_IMMED,
/* caps whose loss strands queued tasks, see scx_process_sync_ecaps() */
SCX_CAPS_REENQ_ON_LOSS = SCX_CAP_ENQ_IMMED | SCX_CAP_ENQ,
};
#ifdef CONFIG_EXT_SUB_SCHED
/* iterate set bits in a u64 cap mask */
#define scx_for_each_cap_bit(cap_bit, caps) \
for (u64 __caps = (caps); \
__caps && ((cap_bit) = __ffs64(__caps), true); \
__caps &= __caps - 1)
/*
* Sub-cap update notifier.
*
* ops_cid.sub_caps_updated() notifies sub-scheds when their cap state changes
* so they can refresh internal state without polling scx_bpf_sub_caps() per
* enqueue.
*
* Three constraints shape the design:
*
* 1. Static memory. Deliveries use a fixed-size buffer, both for runtime
* efficiency and so notifications can't be lost under memory pressure.
*
* 2. High-frequency updates. Grant/revoke can mutate caps in bursts, and the
* notifier path must absorb that without amplifying it.
*
* 3. Recursive grant/revoke from the callback. A child receiving a
* notification can call grant/revoke on its own children, which can
* cascade recursively down its subtree.
*
* (1) and (2) lead to coalescing into a fixed payload. Each delivery carries a
* single (cmask, caps) pair covering every change since the previous one.
* Direction (set vs cleared) isn't encoded as it doesn't fit in the fixed-size
* summary. The callback queries scx_bpf_sub_caps() for current state. Only one
* delivery is in flight per shard. Further changes fold into the same buffer
* and ship as the next callback, so a shard's callbacks fire in order.
*
* (3) leads to deferred delivery. Events accumulate during grant/revoke and are
* delivered after the shard lock is released.
*/
struct scx_caps_updated {
raw_spinlock_t lock;
u64 caps;
struct scx_cmask *cmask_arena_out;
struct list_head node_in_flight;
/* Kernel-side accumulator. Access as &cu->cmask. */
TRAILING_OVERLAP(struct scx_cmask, cmask, bits,
u64 _bits[SCX_CMASK_NR_WORDS(SCX_CID_SHARD_MAX_CPUS)];
);
};
struct scx_pshard {
raw_spinlock_t lock; /* serializes caps */
struct scx_sched *sch; /* backpointer */
struct scx_caps_updated caps_updated;
/*
* Per-cap cmask, inline via TRAILING_OVERLAP so cmask.bits[] overlaps
* the trailing _bits[] storage. Access as &caps[i].cmask. See
* scx_sched_pcpu->ecaps.
*/
TRAILING_OVERLAP(struct scx_cmask, cmask, bits,
u64 _bits[SCX_CMASK_NR_WORDS(SCX_CID_SHARD_MAX_CPUS)];
) caps[__SCX_NR_CAPS];
/*
* Shard geometry captured at alloc. cmask_arena_out's own header is
* bpf-writable and the live shard range can change before the
* rcu-deferred free, so re-init and size cmask_arena_out from these
* trusted copies instead.
*/
u32 base;
u32 nr_cids;
};
#endif
struct scx_sched {
/*
* cpu-form and cid-form ops share field offsets up to .priv (verified
* by BUILD_BUG_ON in scx_init()). The anonymous union lets the kernel
* access either view of the same storage without function-pointer
* casts: use .ops for cpu-form and shared fields, .ops_cid for the
* cid-renamed callbacks (set_cmask, select_cid, cid_online, ...).
*/
union {
struct sched_ext_ops ops;
struct sched_ext_ops_cid ops_cid;
};
bool is_cid_type; /* true if registered via bpf_sched_ext_ops_cid */
bool dead; /* set after ops.exit(), gates scx_prog_sched() */
/*
* Arena map auto-discovered from member progs at struct_ops attach.
* cid-form schedulers must use exactly one arena across all member
* progs. NULL on cpu-form.
*
* @arena_pool sub-allocates @arena_map. Each gen_pool chunk is added
* at the kernel-side mapping address. @arena_kern_base is the start
* of the arena's kern_vm range. See scx_arena_to_kaddr().
*/
struct bpf_map *arena_map;
struct gen_pool *arena_pool;
uintptr_t arena_kern_base;
/*
* Per-CPU arena cmask used by scx_call_op_set_cpumask() to hand a cmask
* to ops_cid.set_cmask(). The kernel writes through the stored kern_va
* and passes it to the callback's __arena argument.
*/
struct scx_cmask * __percpu *set_cmask_scratch;
struct scx_cmask *online_cmask;
DECLARE_BITMAP(has_op, SCX_OPI_END);
/*
* Dispatch queues.
*
* The global DSQ (%SCX_DSQ_GLOBAL) is split per-node for scalability.
* This is to avoid live-locking in bypass mode where all tasks are
* dispatched to %SCX_DSQ_GLOBAL and all CPUs consume from it. If
* per-node split isn't sufficient, it can be further split.
*/
struct rhashtable dsq_hash;
struct scx_sched_pnode **pnode;
#ifdef CONFIG_EXT_SUB_SCHED
struct scx_pshard **pshard; /* indexed by shard_idx */
#endif
struct scx_sched_pcpu __percpu *pcpu;
u64 slice_dfl;
u64 bypass_timestamp;
s32 bypass_depth;
/* bypass dispatch path enable state, see scx_bypass_dsp_enabled() */
unsigned long bypass_dsp_claim;
atomic_t bypass_dsp_enable_depth;
bool aborting;
bool dump_disabled; /* protected by scx_dump_lock */
u32 dsp_max_batch;
s32 level;
#ifdef CONFIG_EXT_SUB_SCHED
/*
* pshard[] size captured at enable for the async RCU free path -
* scx_nr_cid_shards may be rewritten by a later enable's
* scx_cid_publish_tables() before free runs. While sch is active, use
* the global.
*/
u32 nr_pshards;
#endif
/*
* Updates to the following warned bitfields can race causing RMW issues
* but it doesn't really matter.
*/
bool warned_zero_slice:1;
bool warned_unassoc_progs:1;
struct list_head all;
/* unique instance id, monotonic and never reused */
u64 id;
#ifdef CONFIG_EXT_SUB_SCHED
struct rhash_head hash_node;
struct list_head children;
struct list_head sibling;
struct cgroup *cgrp;
char *cgrp_path;
struct kset *sub_kset;
bool linked; /* on ->children, see scx_link_sched() */
bool sub_attached;
#endif /* CONFIG_EXT_SUB_SCHED */
/*
* The maximum amount of time in jiffies that a task may be runnable
* without being scheduled on a CPU. If this timeout is exceeded, it
* will trigger scx_error().
*/
unsigned long watchdog_timeout;
atomic_t exit_kind;
struct scx_exit_info *exit_info;
struct kobject kobj;
struct kthread_worker *helper;
struct irq_work disable_irq_work;
struct kthread_work disable_work;
struct irq_work propagate_exit_irq_work; /* see scx_claim_exit() */
struct timer_list bypass_lb_timer;
cpumask_var_t bypass_lb_donee_cpumask;
cpumask_var_t bypass_lb_resched_cpumask;
cpumask_var_t stall_cpus;
struct rcu_work rcu_work;
/* all ancestors including self */
struct scx_sched *ancestors[];
};
/**
* scx_arena_to_kaddr - Translate a BPF-arena pointer to its kernel address
* @sch: scheduler whose arena hosts @bpf_ptr
* @bpf_ptr: BPF-arena pointer, only the low 32 bits are used
*
* The (u32) cast normalizes any input into the arena's 4 GiB kern_vm range,
* which combined with scratch-page fault recovery makes the returned pointer
* safe to dereference up to GUARD_SZ / 2 past the intended object. Accesses
* larger than GUARD_SZ / 2 must be explicitly bounds-checked.
*/
static inline void *scx_arena_to_kaddr(struct scx_sched *sch, const void *bpf_ptr)
{
return (void *)(sch->arena_kern_base + (u32)(uintptr_t)bpf_ptr);
}
enum scx_wake_flags {
/* expose select WF_* flags as enums */
SCX_WAKE_FORK = WF_FORK,
SCX_WAKE_TTWU = WF_TTWU,
SCX_WAKE_SYNC = WF_SYNC,
};
enum scx_enq_flags {
/* expose select ENQUEUE_* flags as enums */
SCX_ENQ_WAKEUP = ENQUEUE_WAKEUP,
SCX_ENQ_HEAD = ENQUEUE_HEAD,
SCX_ENQ_CPU_SELECTED = ENQUEUE_RQ_SELECTED,
/* high 32bits are SCX specific */
/*
* Set the following to trigger preemption when calling
* scx_bpf_dsq_insert() with a local dsq as the target. The slice of the
* current task is cleared to zero and the CPU is kicked into the
* scheduling path. Implies %SCX_ENQ_HEAD.
*/
SCX_ENQ_PREEMPT = 1LLU << 32,
/*
* Only allowed on local DSQs. Guarantees that the task either gets
* on the CPU immediately and stays on it, or gets reenqueued back
* to the BPF scheduler. It will never linger on a local DSQ or be
* silently put back after preemption.
*
* The protection persists until the next fresh enqueue - it
* survives SAVE/RESTORE cycles, slice extensions and preemption.
* If the task can't stay on the CPU for any reason, it gets
* reenqueued back to the BPF scheduler.
*
* Exiting and migration-disabled tasks bypass ops.enqueue() and
* are placed directly on a local DSQ without IMMED protection
* unless %SCX_OPS_ENQ_EXITING and %SCX_OPS_ENQ_MIGRATION_DISABLED
* are set respectively.
*/
SCX_ENQ_IMMED = 1LLU << 33,
/*
* Only allowed on local DSQs. If the insert lacks the caps for the
* target cid, divert the task to the CPU's rescue path instead of
* rejecting and reenqueueing, e.g. when the task's affinity is
* restricted to cids the scheduler doesn't hold. The kernel runs
* rescued tasks on the target CPU. Rescue execution is guaranteed to
* make forward progress and is bandwidth-limited, see the
* rescue_bandwidth_ppt and rescue_quantum_us ops fields.
*/
SCX_ENQ_RESCUE = 1LLU << 34,
/*
* The task being enqueued was previously enqueued on a DSQ, but was
* removed and is being re-enqueued. See SCX_TASK_REENQ_* flags to find
* out why a given task is being reenqueued.
*/
SCX_ENQ_REENQ = 1LLU << 40,
/*
* The task being enqueued is the only task available for the cpu. By
* default, ext core keeps executing such tasks but when
* %SCX_OPS_ENQ_LAST is specified, they're ops.enqueue()'d with the
* %SCX_ENQ_LAST flag set.
*
* The BPF scheduler is responsible for triggering a follow-up
* scheduling event. Otherwise, Execution may stall.
*/
SCX_ENQ_LAST = 1LLU << 41,
/* high 8 bits are internal */
__SCX_ENQ_INTERNAL_MASK = 0xffLLU << 56,
SCX_ENQ_CLEAR_OPSS = 1LLU << 56,
SCX_ENQ_DSQ_PRIQ = 1LLU << 57,
SCX_ENQ_NESTED = 1LLU << 58,
SCX_ENQ_GDSQ_FALLBACK = 1LLU << 59, /* fell back to global DSQ */
SCX_ENQ_IGNORE_CAPS = 1LLU << 60, /* admit to local DSQ ignoring caps */
SCX_ENQ_APPLY_SLICE = 1LLU << 61, /* apply carried slice/vtime at insertion */
SCX_ENQ_SLICE_DFL = 1LLU << 62, /* carried slice is a default refill */
};
enum scx_deq_flags {
/* expose select DEQUEUE_* flags as enums */
SCX_DEQ_SLEEP = DEQUEUE_SLEEP,
/* high 32bits are SCX specific */
/*
* The generic core-sched layer decided to execute the task even though
* it hasn't been dispatched yet. Dequeue from the BPF side.
*/
SCX_DEQ_CORE_SCHED_EXEC = 1LLU << 32,
/*
* The task is being dequeued due to a property change (e.g.,
* sched_setaffinity(), sched_setscheduler(), set_user_nice(),
* etc.).
*/
SCX_DEQ_SCHED_CHANGE = 1LLU << 33,
};
enum scx_reenq_flags {
/* low 16bits determine which tasks should be reenqueued */
SCX_REENQ_ANY = 1LLU << 0, /* all tasks */
/* internal: kernel-issued on cap revoke, not accepted from BPF */
SCX_REENQ_CAP_REVOKE = 1LLU << 1,
__SCX_REENQ_FILTER_MASK = 0xffffLLU,
__SCX_REENQ_USER_MASK = SCX_REENQ_ANY,
/* bits 32-35 used by task_should_reenq() */
SCX_REENQ_TSR_RQ_OPEN = 1LLU << 32,
SCX_REENQ_TSR_NOT_FIRST = 1LLU << 33,
__SCX_REENQ_TSR_MASK = 0xfLLU << 32,
};
enum scx_pick_idle_cpu_flags {
SCX_PICK_IDLE_CORE = 1LLU << 0, /* pick a CPU whose SMT siblings are also idle */
SCX_PICK_IDLE_IN_NODE = 1LLU << 1, /* pick a CPU in the same target NUMA node */
};
enum scx_kick_flags {
/*
* Kick the target CPU if idle. Guarantees that the target CPU goes
* through at least one full scheduling cycle before going idle. If the
* target CPU can be determined to be currently not idle and going to go
* through a scheduling cycle before going idle, noop.
*/
SCX_KICK_IDLE = 1LLU << 0,
/*
* Preempt the current task and execute the dispatch path. If the
* current task of the target CPU is an SCX task, its ->scx.slice is
* cleared to zero before the scheduling path is invoked so that the
* task expires and the dispatch path is invoked.
*/
SCX_KICK_PREEMPT = 1LLU << 1,
/*
* The scx_bpf_kick_cpu() call will return after the current SCX task of
* the target CPU switches out. This can be used to implement e.g. core
* scheduling. This has no effect if the current task on the target CPU
* is not on SCX.
*/
SCX_KICK_WAIT = 1LLU << 2,
};
enum scx_tg_flags {
SCX_TG_ONLINE = 1U << 0,
SCX_TG_INITED = 1U << 1,
SCX_TG_SUB_INIT = 1U << 2, /* see scx_cgroup_claim_subtree() */
};
enum scx_enable_state {
SCX_ENABLING,
SCX_ENABLED,
SCX_DISABLING,
SCX_DISABLED,
};
static const char *scx_enable_state_str[] = {
[SCX_ENABLING] = "enabling",
[SCX_ENABLED] = "enabled",
[SCX_DISABLING] = "disabling",
[SCX_DISABLED] = "disabled",
};
/*
* Task Ownership State Machine (sched_ext_entity->ops_state)
*
* The sched_ext core uses this state machine to track task ownership
* between the SCX core and the BPF scheduler. This allows the BPF
* scheduler to dispatch tasks without strict ordering requirements, while
* the SCX core safely rejects invalid dispatches.
*
* State Transitions
*
* .------------> NONE (owned by SCX core)
* | | ^
* | enqueue | | direct dispatch
* | v |
* | QUEUEING -------'
* | |
* | enqueue |
* | completes |
* | v
* | QUEUED (owned by BPF scheduler)
* | |
* | dispatch |
* | |
* | v
* | DISPATCHING
* | |
* | dispatch |
* | completes |
* `---------------'
*
* State Descriptions
*
* - %SCX_OPSS_NONE:
* Task is owned by the SCX core. It's either on a run queue, running,
* or being manipulated by the core scheduler. The BPF scheduler has no
* claim on this task.
*
* - %SCX_OPSS_QUEUEING:
* Transitional state while transferring a task from the SCX core to
* the BPF scheduler. The task's rq lock is held during this state.
* Since QUEUEING is both entered and exited under the rq lock, dequeue
* can never observe this state (it would be a BUG). When finishing a
* dispatch, if the task is still in %SCX_OPSS_QUEUEING the completion
* path busy-waits for it to leave this state (via wait_ops_state())
* before retrying.
*
* - %SCX_OPSS_QUEUED:
* Task is owned by the BPF scheduler. It's on a DSQ (dispatch queue)
* and the BPF scheduler is responsible for dispatching it. A QSEQ
* (queue sequence number) is embedded in this state to detect
* dispatch/dequeue races: if a task is dequeued and re-enqueued, the
* QSEQ changes and any in-flight dispatch operations targeting the old
* QSEQ are safely ignored.
*
* - %SCX_OPSS_DISPATCHING:
* Transitional state while transferring a task from the BPF scheduler
* back to the SCX core. This state indicates the BPF scheduler has
* selected the task for execution. When dequeue needs to take the task
* off a DSQ and it is still in %SCX_OPSS_DISPATCHING, the dequeue path
* busy-waits for it to leave this state (via wait_ops_state()) before
* proceeding. Exits to %SCX_OPSS_NONE when dispatch completes.
*
* Memory Ordering
*
* Transitions out of %SCX_OPSS_QUEUEING and %SCX_OPSS_DISPATCHING into
* %SCX_OPSS_NONE or %SCX_OPSS_QUEUED must use atomic_long_set_release()
* and waiters must use atomic_long_read_acquire(). This ensures proper
* synchronization between concurrent operations.
*
* Cross-CPU Task Migration
*
* When moving a task in the %SCX_OPSS_DISPATCHING state, we can't simply
* grab the target CPU's rq lock because a concurrent dequeue might be
* waiting on %SCX_OPSS_DISPATCHING while holding the source rq lock
* (deadlock).
*
* The sched_ext core uses a "lock dancing" protocol coordinated by
* p->scx.holding_cpu. When moving a task to a different rq:
*
* 1. Set p->scx.holding_cpu to the current CPU
* 2. Set task state to %SCX_OPSS_NONE; dequeue waits while DISPATCHING
* is set, so clearing DISPATCHING first prevents the circular wait
* (safe to lock the rq we need)
* 3. Unlock the current CPU's rq
* 4. Lock src_rq (where the task currently lives)
* 5. Verify p->scx.holding_cpu == current CPU, if not, dequeue won the
* race (dequeue clears holding_cpu to -1 when it takes the task), in
* this case migration is aborted
* 6. If src_rq == dst_rq: clear holding_cpu and enqueue directly
* into dst_rq's local DSQ (no lock swap needed)
* 7. Otherwise, verify under src_rq lock that the task can be moved to dst_rq
* (CPU affinity, migration_disabled, etc.). If not, clear holding_cpu,
* leave the task on src_rq, and enqueue it on the fallback DSQ.
* 8. Otherwise (i.e. if the task can be moved to dst_rq), call
* move_remote_task_to_local_dsq(), which releases src_rq, locks dst_rq,
* and performs the deactivate/activate migration cycle
* (dst_rq is held on return)
* 9. Unlock dst_rq and re-lock the current CPU's rq to restore
* the lock state expected by the caller
*
* If any verification fails, abort the migration.
*
* This state tracking allows the BPF scheduler to try to dispatch any task
* at any time regardless of its state. The SCX core can safely
* reject/ignore invalid dispatches, simplifying the BPF scheduler
* implementation.
*/
enum scx_ops_state {
SCX_OPSS_NONE, /* owned by the SCX core */
SCX_OPSS_QUEUEING, /* in transit to the BPF scheduler */
SCX_OPSS_QUEUED, /* owned by the BPF scheduler */
SCX_OPSS_DISPATCHING, /* in transit back to the SCX core */
/*
* QSEQ brands each QUEUED instance so that, when dispatch races
* dequeue/requeue, the dispatcher can tell whether it still has a claim
* on the task being dispatched.
*
* As some 32bit archs can't do 64bit store_release/load_acquire,
* p->scx.ops_state is atomic_long_t which leaves 30 bits for QSEQ on
* 32bit machines. The dispatch race window QSEQ protects is very narrow
* and runs with IRQ disabled. 30 bits should be sufficient.
*/
SCX_OPSS_QSEQ_SHIFT = 2,
};
/* Use macros to ensure that the type is unsigned long for the masks */
#define SCX_OPSS_STATE_MASK ((1LU << SCX_OPSS_QSEQ_SHIFT) - 1)
#define SCX_OPSS_QSEQ_MASK (~SCX_OPSS_STATE_MASK)
/*
* SCX task iterator.
*/
struct scx_task_iter {
struct sched_ext_entity cursor;
struct task_struct *locked_task;
struct rq *rq;
struct rq_flags rf;
u32 cnt;
bool list_locked;
#ifdef CONFIG_EXT_SUB_SCHED
struct cgroup *cgrp;
struct cgroup_subsys_state *css_pos;
struct css_task_iter css_iter;
#endif
};
/*
* scx_enable() is offloaded to a dedicated system-wide RT kthread to avoid
* starvation. During the READY -> ENABLED task switching loop, the calling
* thread's sched_class gets switched from fair to ext. As fair has higher
* priority than ext, the calling thread can be indefinitely starved under
* fair-class saturation, leading to a system hang.
*/
struct scx_enable_cmd {
struct kthread_work work;
union {
struct sched_ext_ops *ops;
struct sched_ext_ops_cid *ops_cid;
};
bool is_cid_type;
struct bpf_map *arena_map; /* arena ref to transfer to sch */
int ret;
};
/* string formatting from BPF */
struct scx_bstr_buf {
u64 data[MAX_BPRINTF_VARARGS];
char line[SCX_EXIT_MSG_LEN];
};
/* Internal helper for DEFINE_SCX_COMPAT_MARKER(). */
#define DECLARE_SCX_COMPAT_MARKER(func) \
extern void scx_compat_marker_##func(void)
/**
* DEFINE_SCX_COMPAT_MARKER() - define a userspace capability marker
* @func: marker suffix; the defined symbol is scx_compat_marker_@func
*
* Emit an empty, callerless function that is retained in the kernel's BTF.
* Its presence is part of the kernel<->userspace contract: userspace probes
* scx_compat_marker_@func (e.g. via BTF) to detect that this kernel supports
* the corresponding feature.
*
* The leading declaration suppresses the missing-prototype warning; the
* trailing declaration consumes the semicolon at the use site.
*/
#define DEFINE_SCX_COMPAT_MARKER(func) \
DECLARE_SCX_COMPAT_MARKER(func); \
__used __retain void scx_compat_marker_##func(void) {} \
DECLARE_SCX_COMPAT_MARKER(func)
extern struct scx_sched __rcu *scx_root;
DECLARE_PER_CPU(struct rq *, scx_locked_rq_state);
/*
* True when the currently loaded scheduler hierarchy is cid-form. All scheds
* in a hierarchy share one form, so this single key tells callsites which
* view to use without per-sch dereferences. Use scx_is_cid_type() to test.
*/
DECLARE_STATIC_KEY_FALSE(__scx_is_cid_type);
int scx_kfunc_context_filter(const struct bpf_prog *prog, u32 kfunc_id);
bool scx_cpu_valid(struct scx_sched *sch, s32 cpu, const char *where);
__printf(5, 0) bool scx_vexit(struct scx_sched *sch, enum scx_exit_kind kind,
s64 exit_code, s32 exit_cpu, const char *fmt,
va_list args);
__printf(5, 6) bool __scx_exit(struct scx_sched *sch, enum scx_exit_kind kind,
s64 exit_code, s32 exit_cpu, const char *fmt, ...);
u32 scx_get_task_state(const struct task_struct *p);
void scx_set_task_state(struct task_struct *p, u32 state);
void scx_task_iter_start(struct scx_task_iter *iter, struct cgroup *cgrp);
void scx_task_iter_unlock(struct scx_task_iter *iter);
void scx_task_iter_stop(struct scx_task_iter *iter);
struct task_struct *scx_task_iter_next_locked(struct scx_task_iter *iter);
bool scx_set_task_slice(struct task_struct *p, u64 slice);
void scx_task_slice_ended(struct rq *rq, struct task_struct *p);
void scx_task_unlink_from_dsq(struct task_struct *p, struct scx_dispatch_q *dsq);
void scx_dispatch_dequeue(struct rq *rq, struct task_struct *p);
void scx_do_enqueue_task(struct rq *rq, struct task_struct *p, u64 enq_flags,
int sticky_cpu);
void scx_move_local_task_to_local_dsq(struct scx_sched *sch, struct task_struct *p,
u64 enq_flags, struct scx_dispatch_q *src_dsq,
struct rq *dst_rq);
bool scx_consume_dispatch_q(struct scx_sched *sch, struct rq *rq,
struct scx_dispatch_q *dsq, u64 enq_flags);
bool scx_consume_global_dsq(struct scx_sched *sch, struct rq *rq);
bool scx_rq_online(struct rq *rq);
void scx_flush_dispatch_buf(struct scx_sched *sch, struct rq *rq);
s32 scx_init_dsq(struct scx_dispatch_q *dsq, u64 dsq_id, struct scx_sched *sch);
__printf(2, 3) void scx_dump_line(struct seq_buf *s, const char *fmt, ...);
void scx_kick_cpu(struct scx_sched *sch, s32 cpu, u64 flags);
u64 __scx_bpf_now(struct rq *rq);
void schedule_dsq_reenq(struct scx_sched *sch, struct scx_dispatch_q *dsq,
u64 reenq_flags, struct rq *locked_rq);
int __scx_init_task(struct scx_sched *sch, struct task_struct *p,
struct cgroup *cgrp, bool fork);
void scx_enable_task(struct scx_sched *sch, struct task_struct *p);
void __scx_disable_and_exit_task(struct scx_sched *sch, struct task_struct *p);
void scx_sub_init_cancel_task(struct scx_sched *sch, struct task_struct *p);
void scx_disable_and_exit_task(struct scx_sched *sch, struct task_struct *p);
#if defined(CONFIG_EXT_GROUP_SCHED) || defined(CONFIG_EXT_SUB_SCHED)
void scx_cgroup_lock(void);
void scx_cgroup_unlock(void);
#endif
s32 scx_alloc_kern_arena_objs(struct scx_sched *sch);
void scx_disable_bypass_dsp(struct scx_sched *sch);
void scx_bypass(struct scx_sched *sch, bool bypass);
s32 scx_link_sched(struct scx_sched *sch);
void scx_unlink_sched(struct scx_sched *sch);
void scx_disable_dump(struct scx_sched *sch);
void scx_log_sched_disable(struct scx_sched *sch);
void scx_flush_disable_work(struct scx_sched *sch);
struct scx_sched *scx_alloc_and_add_sched(struct scx_enable_cmd *cmd,
struct cgroup *cgrp,
struct scx_sched *parent);
int scx_validate_ops(struct scx_sched *sch, const struct sched_ext_ops *ops);
int scx_sched_sysfs_add(struct scx_sched *sch);
bool scx_is_descendant(struct scx_sched *sch, struct scx_sched *ancestor);
__printf(5, 0) bool scx_exit_bstr(struct scx_sched *sch, enum scx_exit_kind kind,
s64 exit_code, struct scx_sched *fmt_blame,
char *fmt, unsigned long long *data, u32 data__sz);
extern raw_spinlock_t scx_sched_lock;
extern struct mutex scx_enable_mutex;
extern struct percpu_rw_semaphore scx_fork_rwsem;
extern bool scx_cgroup_enabled;
extern struct list_head scx_sched_all;
#ifdef CONFIG_EXT_SUB_SCHED
extern const struct rhashtable_params scx_sched_hash_params;
extern struct rhashtable scx_sched_hash;
extern struct scx_sched *scx_enabling_sub_sched;
#endif
#define scx_exit(sch, kind, exit_code, fmt, args...) \
__scx_exit(sch, kind, exit_code, raw_smp_processor_id(), fmt, ##args)
#define scx_error(sch, fmt, args...) \
scx_exit((sch), SCX_EXIT_ERROR, 0, fmt, ##args)
/**
* scx_root_protected_live - Root sched for paths that only run while live
*
* scx_root is published before the scheduler goes live and cleared only after
* it is fully drained, so a path that only executes while the scheduler is live
* can never race an update. Return the root sched with a plain load, never
* %NULL.
*/
static inline struct scx_sched *scx_root_protected_live(void)
{
return rcu_dereference_protected(scx_root, true);
}
/**
* scx_root_protected - Root sched for contexts that exclude its updates
*
* Both scx_root updates run under the locks checked below, so holding one
* excludes them. Return the root sched with a plain load, %NULL if no scheduler
* is loaded.
*/
static inline struct scx_sched *scx_root_protected(void)
{
return rcu_dereference_protected(scx_root,
lockdep_is_cpus_held() ||
lockdep_is_held(&scx_enable_mutex));
}
static inline struct scx_dispatch_q *scx_bypass_dsq(struct scx_sched *sch, s32 cpu)
{
return &per_cpu_ptr(sch->pcpu, cpu)->bypass_dsq;
}
/**
* scx_bypass_dsp_enabled - Check if bypass dispatch path is enabled
* @sch: scheduler to check
*
* When a descendant scheduler enters bypass mode, bypassed tasks are scheduled
* by the nearest non-bypassing ancestor, or the root scheduler if all ancestors
* are bypassing. In the former case, the ancestor is not itself bypassing but
* its bypass DSQs will be populated with bypassed tasks from descendants. Thus,
* the ancestor's bypass dispatch path must be active even though its own
* bypass_depth remains zero.
*
* This function checks bypass_dsp_enable_depth which is managed separately from
* bypass_depth to enable this decoupling. See enable_bypass_dsp() and
* scx_disable_bypass_dsp().
*/
static inline bool scx_bypass_dsp_enabled(struct scx_sched *sch)
{
return unlikely(atomic_read(&sch->bypass_dsp_enable_depth));
}
/**
* scx_ops_sanitize_err - Sanitize a -errno value
* @sch: scx_sched to error out on error
* @ops_name: operation to blame on failure
* @err: -errno value to sanitize
*
* Verify @err is a valid -errno. If not, trigger scx_error() and return
* -%EPROTO. This is necessary because returning a rogue -errno up the chain can
* cause misbehaviors. For an example, a large negative return from
* ops.init_task() triggers an oops when passed up the call chain because the
* value fails IS_ERR() test after being encoded with ERR_PTR() and then is
* handled as a pointer.
*/
static inline int scx_ops_sanitize_err(struct scx_sched *sch, const char *ops_name, s32 err)
{
if (err < 0 && err >= -MAX_ERRNO)
return err;
scx_error(sch, "ops.%s() returned an invalid errno %d", ops_name, err);
return -EPROTO;
}
static inline void scx_schedule_reenq_local(struct rq *rq, u64 reenq_flags)
{
struct scx_sched *root = rcu_dereference_sched(scx_root);
if (WARN_ON_ONCE(!root))
return;
schedule_dsq_reenq(root, &rq->scx.local_dsq, reenq_flags, rq);
}
/*
* Return the rq currently locked from an scx callback, or NULL if no rq is
* locked.
*/
static inline struct rq *scx_locked_rq(void)
{
return __this_cpu_read(scx_locked_rq_state);
}
static inline void update_locked_rq(struct rq *rq)
{
/*
* Check whether @rq is actually locked. This can help expose bugs
* or incorrect assumptions about the context in which a kfunc or
* callback is executed.
*/
if (rq)
lockdep_assert_rq_held(rq);
__this_cpu_write(scx_locked_rq_state, rq);
}
#define SCX_HAS_OP(sch, op) test_bit(SCX_OP_IDX(op), (sch)->has_op)
/*
* SCX ops can recurse via scx_bpf_sub_dispatch() - the inner call must not
* clobber the outer's scx_locked_rq_state. Save it on entry, restore on exit.
*
* @ops is the ops table to dispatch through: ops for the cpu form, ops_cid
* for the cid form.
*/
#define __SCX_CALL_OP(sch, ops, op, locked_rq, args...) \
do { \
struct rq *__prev_locked_rq; \
\
if (locked_rq) { \
__prev_locked_rq = scx_locked_rq(); \
update_locked_rq(locked_rq); \
} \
(sch)->ops.op(args); \
if (locked_rq) \
update_locked_rq(__prev_locked_rq); \
} while (0)
#define SCX_CALL_OP(sch, op, locked_rq, args...) \
__SCX_CALL_OP(sch, ops, op, locked_rq, ##args)
#define SCX_CALL_OP_RET(sch, op, locked_rq, args...) \
({ \
struct rq *__prev_locked_rq; \
__typeof__((sch)->ops.op(args)) __ret; \
\
if (locked_rq) { \
__prev_locked_rq = scx_locked_rq(); \
update_locked_rq(locked_rq); \
} \
__ret = (sch)->ops.op(args); \
if (locked_rq) \
update_locked_rq(__prev_locked_rq); \
__ret; \
})
/*
* SCX_CALL_OP_TASK*() invokes an SCX op that takes one or two task arguments
* and records them in current->scx.kf_tasks[] for the duration of the call. A
* kfunc invoked from inside such an op can then use
* scx_kf_arg_task_ok() to verify that its task argument is one of
* those subject tasks.
*
* Every SCX_CALL_OP_TASK*() call site invokes its op with @p's rq lock held -
* either via the @locked_rq argument here, or (for ops.select_cpu()) via @p's
* pi_lock held by try_to_wake_up() with rq tracking via scx_rq.in_select_cpu.
* So if kf_tasks[] is set, @p's scheduler-protected fields are stable.
*
* kf_tasks[] can not stack, so task-based SCX ops must not nest. The
* WARN_ON_ONCE() in each macro catches a re-entry of any of the three variants
* while a previous one is still in progress.
*/
#define __SCX_CALL_OP_TASK(sch, ops, op, locked_rq, task, args...) \
do { \
WARN_ON_ONCE(current->scx.kf_tasks[0]); \
current->scx.kf_tasks[0] = task; \
__SCX_CALL_OP((sch), ops, op, locked_rq, task, ##args); \
current->scx.kf_tasks[0] = NULL; \
} while (0)
/*
* A per-task op runs on @task's owner - WARN if @sch isn't it. Sites that must
* target a different scheduler call __SCX_CALL_OP_TASK() directly.
*/
#define SCX_CALL_OP_TASK(sch, op, locked_rq, task, args...) \
do { \
WARN_ON_ONCE(scx_has_subs() && (sch) != scx_task_sched_rcu(task)); \
__SCX_CALL_OP_TASK((sch), ops, op, locked_rq, task, ##args); \
} while (0)
/*
* Dispatch a task op through the cid-form ops_cid table. Only set_cmask() needs
* this: it takes an arena cmask address instead of a cpumask, so it cannot be
* invoked via its cpu-form set_cpumask() slot.
*/
#define SCX_CALL_CID_OP_TASK(sch, op, locked_rq, task, args...) \
__SCX_CALL_OP_TASK(sch, ops_cid, op, locked_rq, task, ##args)
#define SCX_CALL_OP_TASK_RET(sch, op, locked_rq, task, args...) \
({ \
__typeof__((sch)->ops.op(task, ##args)) __ret; \
WARN_ON_ONCE(scx_has_subs() && (sch) != scx_task_sched_rcu(task)); \
WARN_ON_ONCE(current->scx.kf_tasks[0]); \
current->scx.kf_tasks[0] = task; \
__ret = SCX_CALL_OP_RET((sch), op, locked_rq, task, ##args); \
current->scx.kf_tasks[0] = NULL; \
__ret; \
})
#define SCX_CALL_OP_2TASKS_RET(sch, op, locked_rq, task0, task1, args...) \
({ \
__typeof__((sch)->ops.op(task0, task1, ##args)) __ret; \
WARN_ON_ONCE(current->scx.kf_tasks[0]); \
current->scx.kf_tasks[0] = task0; \
current->scx.kf_tasks[1] = task1; \
__ret = SCX_CALL_OP_RET((sch), op, locked_rq, task0, task1, ##args); \
current->scx.kf_tasks[0] = NULL; \
current->scx.kf_tasks[1] = NULL; \
__ret; \
})
/* see SCX_CALL_OP_TASK() */
static __always_inline bool scx_kf_arg_task_ok(struct scx_sched *sch,
struct task_struct *p)
{
if (unlikely((p != current->scx.kf_tasks[0] &&
p != current->scx.kf_tasks[1]))) {
scx_error(sch, "called on a task not being operated on");
return false;
}
return true;
}
static inline bool scx_bypassing(struct scx_sched *sch, s32 cpu)
{
return unlikely(per_cpu_ptr(sch->pcpu, cpu)->flags &
SCX_SCHED_PCPU_BYPASSING);
}
#ifdef CONFIG_EXT_SUB_SCHED
DECLARE_STATIC_KEY_FALSE(__scx_has_subs);
/**
* scx_has_subs - Whether any sub-scheduler exists
*
* Gates the sub-sched portions of hot paths so that a root-only system doesn't
* pay for them. See scx_sub_enable_workfn() and scx_sched_free_rcu_work().
*/
static inline bool scx_has_subs(void)
{
return static_branch_unlikely(&__scx_has_subs);
}
/**
* scx_task_sched - Find scx_sched scheduling a task
* @p: task of interest
*
* Return @p's scheduler instance. Must be called with @p's pi_lock or rq lock
* held.
*/
static inline struct scx_sched *scx_task_sched(const struct task_struct *p)
{
return rcu_dereference_protected(p->scx.sched,
lockdep_is_held(&p->pi_lock) ||
lockdep_is_held(__rq_lockp(task_rq(p))));
}
/**
* scx_task_sched_rcu - Find scx_sched scheduling a task
* @p: task of interest
*
* Return @p's scheduler instance. The returned scx_sched is RCU protected.
*/
static inline struct scx_sched *scx_task_sched_rcu(const struct task_struct *p)
{
return rcu_dereference_all(p->scx.sched);
}
/**
* scx_task_on_sched - Is a task on the specified sched?
* @sch: sched to test against
* @p: task of interest
*
* Returns %true if @p is on @sch, %false otherwise.
*/
static inline bool scx_task_on_sched(struct scx_sched *sch,
const struct task_struct *p)
{
return rcu_access_pointer(p->scx.sched) == sch;
}
/**
* scx_prog_sched - Find scx_sched associated with a BPF prog
* @aux: aux passed in from BPF to a kfunc
*
* To be called from kfuncs. Return the scheduler instance associated with the
* BPF program given the implicit kfunc argument aux. The returned scx_sched is
* RCU protected.
*/
static inline struct scx_sched *scx_prog_sched(const struct bpf_prog_aux *aux)
{
struct sched_ext_ops *ops;
struct scx_sched *sch, *root;
ops = bpf_prog_get_assoc_struct_ops(aux);
if (likely(ops)) {
sch = rcu_dereference_all(ops->priv);
if (sch && unlikely(READ_ONCE(sch->dead)))
return NULL;
return sch;
}
root = rcu_dereference_all(scx_root);
if (root) {
if (unlikely(READ_ONCE(root->dead)))
return NULL;
/*
* COMPAT-v6.19: Schedulers built before sub-sched support was
* introduced may have unassociated non-struct_ops programs.
*/
if (!root->ops.sub_attach)
return root;
if (!root->warned_unassoc_progs) {
printk_deferred(KERN_WARNING "sched_ext: Unassociated program %s (id %d)\n",
aux->name, aux->id);
root->warned_unassoc_progs = true;
}
}
return NULL;
}
/**
* scx_parent - Find the parent sched
* @sch: sched to find the parent of
*
* Returns the parent scheduler or %NULL if @sch is root.
*/
static inline struct scx_sched *scx_parent(struct scx_sched *sch)
{
if (sch->level)
return sch->ancestors[sch->level - 1];
else
return NULL;
}
#else /* CONFIG_EXT_SUB_SCHED */
static inline bool scx_has_subs(void) { return false; }
static inline struct scx_sched *scx_task_sched(const struct task_struct *p)
{
return rcu_dereference_protected(scx_root,
lockdep_is_held(&p->pi_lock) ||
lockdep_is_held(__rq_lockp(task_rq(p))));
}
static inline struct scx_sched *scx_task_sched_rcu(const struct task_struct *p)
{
return rcu_dereference_all(scx_root);
}
static inline bool scx_task_on_sched(struct scx_sched *sch,
const struct task_struct *p)
{
return true;
}
static inline struct scx_sched *scx_prog_sched(const struct bpf_prog_aux *aux)
{
struct scx_sched *root = rcu_dereference_all(scx_root);
if (root && unlikely(READ_ONCE(root->dead)))
return NULL;
return root;
}
static inline struct scx_sched *scx_parent(struct scx_sched *sch) { return NULL; }
#endif /* CONFIG_EXT_SUB_SCHED */
#endif /* _KERNEL_SCHED_EXT_INTERNAL_H */