sched_ext: Documentation: Remove mentions of scx_bpf_switch_all
PATCH 1/1 sched_ext: Documentation: Remove mentions of scx_bpf_switch_all
Updated sched_ext doc to eliminate references to scx_bpf_switch_all, which has been removed in recent sched_ext versions.
--- Documentation/scheduler/sched-ext.rst | 32 ++++++++++++++++----------- 1 file changed, 19 insertions(+), 13 deletions(-)
Documentation/scheduler/sched-ext.rst +19 -13
@@ -44,17 +44,24 @@ options should be enabled to use sched_ext: CONFIG_PAHOLE_HAS_SPLIT_BTF=y CONFIG_PAHOLE_HAS_BTF_TAG=y -sched_ext is used only when the BPF scheduler is loaded and running. -If a task explicitly sets its scheduling policy to ``SCHED_EXT``, it will be -treated as ``SCHED_NORMAL`` and scheduled by CFS until the BPF scheduler is -loaded. On load, such tasks will be switched to and scheduled by sched_ext. +sched_ext is used only when the BPF scheduler is loaded and running. To use +sched_ext, a task can invoke ``sched_setscheduler`` with the ``SCHED_EXT`` +policy constant. -The BPF scheduler can choose to schedule all normal and lower class tasks by -calling ``scx_bpf_switch_all()`` from its ``init()`` operation. In this -case, all ``SCHED_NORMAL``, ``SCHED_BATCH``, ``SCHED_IDLE`` and -``SCHED_EXT`` tasks are scheduled by sched_ext. In the example schedulers, -this mode can be selected with the ``-a`` option. +When the BPF scheduler is not loaded, tasks with the ``SCHED_EXT`` policy are +treated as ``SCHED_NORMAL`` and scheduled by CFS. ``SCHED_NORMAL`` tasks +continue to be scheduled by CFS. + +When the BPF scheduler is loaded, all tasks with the ``SCHED_EXT`` policy are +switched to sched_ext. By default, if the ``struct ops->flag`` is not set to +``SCX_OPS_SWITCH_PARTIAL``, ``SCHED_EXT``, ``SCHED_NORMAL``, and lower class +tasks are scheduled by sched_ext. In this case, all ``SCHED_NORMAL``, +``SCHED_BATCH``, ``SCHED_IDLE``, and ``SCHED_EXT`` tasks are scheduled by +sched_ext. + +However, if the ``struct ops->flag`` is set to``SCX_OPS_SWITCH_PARTIAL``, +only tasks with the policy set to ``SCHED_EXT`` are scheduled by sched_ext. Terminating the sched_ext scheduler program, triggering :kbd:`SysRq-S`, or detection of any internal error including stalled runnable tasks aborts the
@@ -156,13 +163,12 @@ optional. The following modified excerpt is from scx_bpf_dispatch(p, SCX_DSQ_GLOBAL, SCX_SLICE_DFL, enq_flags); } - s32 BPF_STRUCT_OPS(simple_init) + s32 BPF_STRUCT_OPS_SLEEPABLE(simple_init) { /* - * All SCHED_OTHER, SCHED_IDLE, and SCHED_BATCH tasks should - * use sched_ext. + * By default, all SCHED_EXT, SCHED_OTHER, SCHED_IDLE, and + * SCHED_BATCH tasks should use sched_ext. */ - scx_bpf_switch_all(); return 0; }
Signature · 1 line
2.25.1
Hello,
On Mon, Jul 01, 2024 at 06:00:22PM +0530, Aboorva Devarajan wrote:
...
Documentation/scheduler/sched-ext.rst options should be enabled to use sched_ext: · line 50
Quoted 3 lines
Documentation/scheduler/sched-ext.rst +3
-0+sched_ext is used only when the BPF scheduler is loaded and running. To use +sched_ext, a task can invoke ``sched_setscheduler`` with the ``SCHED_EXT`` +policy constant.
I wonder whether the last sentence is a bit confusing given that tasks can be on SCX without setting SCHED_EXT.
Documentation/scheduler/sched-ext.rst options should be enabled to use sched_ext: · line 61
Quoted 10 lines
Documentation/scheduler/sched-ext.rst +10
-0+When the BPF scheduler is not loaded, tasks with the ``SCHED_EXT`` policy are +treated as ``SCHED_NORMAL`` and scheduled by CFS. ``SCHED_NORMAL`` tasks +continue to be scheduled by CFS. + +When the BPF scheduler is loaded, all tasks with the ``SCHED_EXT`` policy are +switched to sched_ext. By default, if the ``struct ops->flag`` is not set to +``SCX_OPS_SWITCH_PARTIAL``, ``SCHED_EXT``, ``SCHED_NORMAL``, and lower class +tasks are scheduled by sched_ext. In this case, all ``SCHED_NORMAL``, +``SCHED_BATCH``, ``SCHED_IDLE``, and ``SCHED_EXT`` tasks are scheduled by +sched_ext.
How about something like:
When the BPF scheduler is loaded and ``SCX_OPS_SWITCH_PARTIAL`` is not set in ops->flags, all ``SCHED_NORMAL``, ``SCHED_BATCH``, ``SCHED_IDLE``, and ``SCHED_EXT`` tasks are scheduled by sched_ext.
Documentation/scheduler/sched-ext.rst options should be enabled to use sched_ext: · line 64
Quoted 2 lines
Documentation/scheduler/sched-ext.rst +2
-0+However, if the ``struct ops->flag`` is set to``SCX_OPS_SWITCH_PARTIAL``, +only tasks with the policy set to ``SCHED_EXT`` are scheduled by sched_ext.
And update this paragraph in a similar fashion?
Thanks.
Signature · 1 line
tejun
Quoted 40 lines · Tejun Heo
Hello,
On Mon, Jul 01, 2024 at 06:00:22PM +0530, Aboorva Devarajan wrote:
...Quoted 5 lines
+sched_ext is used only when the BPF scheduler is loaded and running. To use
+sched_ext, a task can invoke ``sched_setscheduler`` with the ``SCHED_EXT``
+policy constant.I wonder whether the last sentence is a bit confusing given that tasks can
be on SCX without settingSCHED_EXT.Quoted 9 lines
+When the BPF scheduler is not loaded, tasks with the ``SCHED_EXT`` policy are
+treated as ``SCHED_NORMAL`` and scheduled by CFS. ``SCHED_NORMAL`` tasksDocumentation/scheduler/sched-ext.rst +3
-0+continue to be scheduled by CFS. + +When the BPF scheduler is loaded, all tasks with the``SCHED_EXT`` policy are
+switched tosched_ext. By default, if the ``struct ops->flag`` isQuoted 8 lines
not set to
+``SCX_OPS_SWITCH_PARTIAL``, ``SCHED_EXT``, ``SCHED_NORMAL``, and lower class
+tasks are scheduled bysched_ext. In this case, all ``SCHED_NORMAL``,
+``SCHED_BATCH``, ``SCHED_IDLE``, and ``SCHED_EXT`` tasks are scheduled by
+sched_ext.How about something like:
When the BPF scheduler is loaded and ``SCX_OPS_SWITCH_PARTIAL`` is not set
inops->flags, all ``SCHED_NORMAL``, ``SCHED_BATCH``, ``SCHED_IDLE``, and
``SCHED_EXT`` tasks are scheduled bysched_ext.
Quoted 9 lines
Quoted 4 lines
+However, if the ``struct ops->flag`` is set to``SCX_OPS_SWITCH_PARTIAL``,
+only tasks with the policy set to ``SCHED_EXT`` are scheduled bysched_ext.And update this paragraph in a similar fashion?
Thanks.
Hi Tejun, Thanks for the review.
Sent out a v2 with the suggested changes.