From: John Mathew <john.mathew@unikie.com>
To: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, corbet@lwn.net, mingo@redhat.com,
peterz@infradead.org, juri.lelli@redhat.com,
vincent.guittot@linaro.org, dietmar.eggemann@arm.com,
rostedt@goodmis.org, bsegall@google.com, mgorman@suse.de,
bristot@redhat.com, tsbogend@alpha.franken.de,
lukas.bulwahn@gmail.com, x86@kernel.org,
linux-mips@vger.kernel.org, tglx@linutronix.de,
mostafa.chamanara@basemark.com,
John Mathew <john.mathew@unikie.com>
Subject: [RFC PATCH 0/3] Add scheduler overview documentation
Date: Wed, 1 Apr 2020 13:00:26 +0300 [thread overview]
Message-ID: <20200401100029.1445-1-john.mathew@unikie.com> (raw)
Hi all,
Based on our investigation in the area of the MIPS scheduler context
switch we wish to share our learnings about the kernel scheduler in
the form of kernel documentation. Investigations were done mostly by
stepping through the code using GDB and code inspection. The aim of
the patchset is to provide a brief overview of the kernel scheduler
starting from a brief history, the overview of the kernel structs
used by the scheduler, scheduler invocation and context switch. We
have also added a small section on scheduler state modelling
possibilities. In order to add these subjects we have restructured
the existing scheduler documentation so as to put them in to suitable
sections. We hope the new structure will enable easy extension of the
scheduler documentation.
Patch 1 creates place holders and new structure for the scheduler documentation.
The main sections are
- Scheduler overview: Overview of the scheduler.
- CFS: A section dedicated to CFS scheduler.
- Process context switching: Context switching overview.
- Scheduler features: We thought most of the existing documentation can be moved
here.
- Architecture Specific Scheduler Implementation Differences: Aimed for each
architecture and future updates.
- Scheduler Debugging Interface: For scheduler diagnostics and utilities
- Scheduler related functions: Scheduler API reference.
Patch 2: Adds documentation for the place holders of the Scheduler overview,
Scheduler State Transition and CFS sections.
Patch 3: Adds documentation for the place holder of the Process context switching
and add 2 new sections to for x86 and MIPS context switch.
John Mathew (3):
docs: scheduler: Restructure scheduler documentation.
docs: scheduler: Add scheduler overview documentation
docs: scheduler: Add introduction to scheduler context-switch
Documentation/scheduler/arch-specific.rst | 14 +
Documentation/scheduler/cfs-data-structs.rst | 208 ++++++++++++++
Documentation/scheduler/cfs-overview.rst | 46 ++++
.../scheduler/cfs-sched-overview.rst | 17 ++
Documentation/scheduler/context-switching.rst | 71 +++++
Documentation/scheduler/index.rst | 31 ++-
.../scheduler/mips-context-switch.rst | 78 ++++++
Documentation/scheduler/overview.rst | 260 ++++++++++++++++++
Documentation/scheduler/sched-debugging.rst | 14 +
Documentation/scheduler/sched-features.rst | 20 ++
Documentation/scheduler/scheduler-api.rst | 34 +++
.../scheduler/x86-context-switch.rst | 59 ++++
kernel/sched/core.c | 36 ++-
13 files changed, 867 insertions(+), 21 deletions(-)
create mode 100644 Documentation/scheduler/arch-specific.rst
create mode 100644 Documentation/scheduler/cfs-data-structs.rst
create mode 100644 Documentation/scheduler/cfs-overview.rst
create mode 100644 Documentation/scheduler/cfs-sched-overview.rst
create mode 100644 Documentation/scheduler/context-switching.rst
create mode 100644 Documentation/scheduler/mips-context-switch.rst
create mode 100644 Documentation/scheduler/overview.rst
create mode 100644 Documentation/scheduler/sched-debugging.rst
create mode 100644 Documentation/scheduler/sched-features.rst
create mode 100644 Documentation/scheduler/scheduler-api.rst
create mode 100644 Documentation/scheduler/x86-context-switch.rst
--
2.17.1
next reply other threads:[~2020-04-01 10:02 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-04-01 10:00 John Mathew [this message]
2020-04-01 10:00 ` [RFC PATCH 1/3] docs: scheduler: Restructure scheduler documentation John Mathew
2020-04-01 10:00 ` [RFC PATCH 2/3] docs: scheduler: Add scheduler overview documentation John Mathew
2020-04-01 10:35 ` Peter Zijlstra
2020-04-01 11:47 ` Daniel Bristot de Oliveira
2020-04-01 12:26 ` Peter Zijlstra
2020-04-01 13:45 ` Valentin Schneider
2020-04-07 19:40 ` Jonathan Corbet
2020-04-08 5:35 ` Daniel Bristot de Oliveira
2020-04-01 11:54 ` Matthew Wilcox
2020-04-01 14:36 ` Jonathan Corbet
2020-04-01 12:20 ` Juri Lelli
2020-04-01 15:03 ` Valentin Schneider
2020-04-01 10:00 ` [RFC PATCH 3/3] docs: scheduler: Add introduction to scheduler context-switch John Mathew
2020-04-01 11:06 ` Peter Zijlstra
2020-04-06 5:07 ` [RFC PATCH 0/3] Add scheduler overview documentation John Mathew
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200401100029.1445-1-john.mathew@unikie.com \
--to=john.mathew@unikie.com \
--cc=bristot@redhat.com \
--cc=bsegall@google.com \
--cc=corbet@lwn.net \
--cc=dietmar.eggemann@arm.com \
--cc=juri.lelli@redhat.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mips@vger.kernel.org \
--cc=lukas.bulwahn@gmail.com \
--cc=mgorman@suse.de \
--cc=mingo@redhat.com \
--cc=mostafa.chamanara@basemark.com \
--cc=peterz@infradead.org \
--cc=rostedt@goodmis.org \
--cc=tglx@linutronix.de \
--cc=tsbogend@alpha.franken.de \
--cc=vincent.guittot@linaro.org \
--cc=x86@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).