data_type large_stringclasses 3
values | source large_stringclasses 29
values | code large_stringlengths 98 49.4M | filepath large_stringlengths 5 161 ⌀ | message large_stringclasses 234
values | commit large_stringclasses 234
values | subject large_stringclasses 418
values | critique large_stringlengths 101 1.26M ⌀ | metadata dict |
|---|---|---|---|---|---|---|---|---|
source | linux | ============
Swap suspend
============
Some warnings, first.
.. warning::
**BIG FAT WARNING**
If you touch anything on disk between suspend and resume...
...kiss your data goodbye.
If you do resume from initrd after your filesystems are mounted...
...bye bye root partition.
[this is actually s... | Documentation/power/swsusp.rst | null | null | null | null | null |
source | linux | ================
swsusp/S3 tricks
================
Pavel Machek <pavel@ucw.cz>
If you want to trick swsusp/S3 into working, you might want to try:
* go with minimal config, turn off drivers like USB, AGP you don't
really need
* turn off APIC and preempt
* use ext2. At least it has working fsck. [If something see... | Documentation/power/tricks.rst | null | null | null | null | null |
source | linux | =====================================================
Documentation for userland software suspend interface
=====================================================
(C) 2006 Rafael J. Wysocki <rjw@sisk.pl>
First, the warnings at the beginning of swsusp.txt still apply.
Second, you should read the FAQ in swsusp.txt _no... | Documentation/power/userland-swsusp.rst | null | null | null | null | null |
source | linux | ===========================
Video issues with S3 resume
===========================
2003-2006, Pavel Machek
During S3 resume, hardware needs to be reinitialized. For most
devices, this is easy, and kernel driver knows how to do
it. Unfortunately there's one exception: video card. Those are usually
initialized by BIOS... | Documentation/power/video.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==========================================
Dynamic Thermal Power Management framework
==========================================
On the embedded world, the complexity of the SoC leads to an
increasing number of hotspots which need to be monitored and mitigated
as a whole in order t... | Documentation/power/powercap/dtpm.rst | null | null | null | null | null |
source | linux | =======================
Power Capping Framework
=======================
The power capping framework provides a consistent interface between the kernel
and the user space that allows power capping drivers to expose the settings to
user space in a uniform way.
Terminology
===========
The framework exposes power cappin... | Documentation/power/powercap/powercap.rst | null | null | null | null | null |
source | linux | ===================================
Regulator Consumer Driver Interface
===================================
This text describes the regulator interface for consumer device drivers.
Please see overview.txt for a description of the terms used in this text.
1. Consumer Regulator Access (static & dynamic drivers)
======... | Documentation/power/regulator/consumer.rst | null | null | null | null | null |
source | linux | ==========================
Regulator API design notes
==========================
This document provides a brief, partially structured, overview of some
of the design considerations which impact the regulator API design.
Safety
------
- Errors in regulator configuration can have very serious consequences
for the ... | Documentation/power/regulator/design.rst | null | null | null | null | null |
source | linux | ==================================
Regulator Machine Driver Interface
==================================
The regulator machine driver interface is intended for board/machine specific
initialisation code to configure the regulator subsystem.
Consider the following machine::
Regulator-1 -+-> Regulator-2 --> [Consume... | Documentation/power/regulator/machine.rst | null | null | null | null | null |
source | linux | =============================================
Linux voltage and current regulator framework
=============================================
About
=====
This framework is designed to provide a standard kernel interface to control
voltage and current regulators.
The intention is to allow systems to dynamically control r... | Documentation/power/regulator/overview.rst | null | null | null | null | null |
source | linux | ==========================
Regulator Driver Interface
==========================
The regulator driver interface is relatively simple and designed to allow
regulator drivers to register their services with the core framework.
Registration
============
Drivers can register a regulator by calling::
struct regulator... | Documentation/power/regulator/regulator.rst | null | null | null | null | null |
source | linux | .. _development_process_intro:
Introduction
============
Executive summary
-----------------
The rest of this section covers the scope of the kernel development process
and the kinds of frustrations that developers and their employers can
encounter there. There are a great many reasons why kernel code should be
mer... | Documentation/process/1.Intro.rst | null | null | null | null | null |
source | linux | .. _development_process:
How the development process works
=================================
Linux kernel development in the early 1990s was a pretty loose affair,
with relatively small numbers of users and developers involved. With a
user base in the millions and with some 2,000 developers involved over the
course ... | Documentation/process/2.Process.rst | null | null | null | null | null |
source | linux | .. _development_early_stage:
Early-stage planning
====================
When contemplating a Linux kernel development project, it can be tempting
to jump right in and start coding. As with any significant project,
though, much of the groundwork for success is best laid before the first
line of code is written. Some ... | Documentation/process/3.Early-stage.rst | null | null | null | null | null |
source | linux | .. _development_coding:
Getting the code right
======================
While there is much to be said for a solid and community-oriented design
process, the proof of any kernel development project is in the resulting
code. It is the code which will be examined by other developers and merged
(or not) into the mainline... | Documentation/process/4.Coding.rst | null | null | null | null | null |
source | linux | .. _development_posting:
Posting patches
===============
Sooner or later, the time comes when your work is ready to be presented to
the community for review and, eventually, inclusion into the mainline
kernel. Unsurprisingly, the kernel development community has evolved a set
of conventions and procedures which are ... | Documentation/process/5.Posting.rst | null | null | null | null | null |
source | linux | .. _development_followthrough:
Followthrough
=============
At this point, you have followed the guidelines given so far and, with the
addition of your own engineering skills, have posted a perfect series of
patches. One of the biggest mistakes that even experienced kernel
developers can make is to conclude that thei... | Documentation/process/6.Followthrough.rst | null | null | null | null | null |
source | linux | .. _development_advancedtopics:
Advanced topics
===============
At this point, hopefully, you have a handle on how the development process
works. There is still more to learn, however! This section will cover a
number of topics which can be helpful for developers wanting to become a
regular part of the Linux kernel... | Documentation/process/7.AdvancedTopics.rst | null | null | null | null | null |
source | linux | .. _development_conclusion:
For more information
====================
There are numerous sources of information on Linux kernel development and
related topics. First among those will always be the Documentation
directory found in the kernel source distribution. Start with the
top-level :ref:`process/howto.rst <proc... | Documentation/process/8.Conclusion.rst | null | null | null | null | null |
source | linux | .. _addsyscalls:
Adding a New System Call
========================
This document describes what's involved in adding a new system call to the
Linux kernel, over and above the normal submission advice in
:ref:`Documentation/process/submitting-patches.rst <submittingpatches>`.
System Call Alternatives
---------------... | Documentation/process/adding-syscalls.rst | null | null | null | null | null |
source | linux | .. _applying_patches:
Applying Patches To The Linux Kernel
++++++++++++++++++++++++++++++++++++
Original by:
Jesper Juhl, August 2005
.. note::
This document is obsolete. In most cases, rather than using ``patch``
manually, you'll almost certainly want to look at using Git instead.
A frequently asked quest... | Documentation/process/applying-patches.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===================================
Backporting and conflict resolution
===================================
:Author: Vegard Nossum <vegard.nossum@oracle.com>
.. contents::
:local:
:depth: 3
:backlinks: none
Introduction
============
Some developers may never really h... | Documentation/process/backporting.rst | null | null | null | null | null |
source | linux | =================================
(How to avoid) Botching up ioctls
=================================
From: https://blog.ffwll.ch/2013/11/botching-up-ioctls.html
By: Daniel Vetter, Copyright © 2013 Intel Corporation
One clear insight kernel graphics hackers gained in the past few years is that
trying to come up with... | Documentation/process/botching-up-ioctls.rst | null | null | null | null | null |
source | linux | .. _changes:
Minimal requirements to compile the Kernel
++++++++++++++++++++++++++++++++++++++++++
Intro
=====
This document is designed to provide a list of the minimum levels of
software necessary to run the current kernel version.
This document is originally based on my "Changes" file for 2.0.x kernels
and there... | Documentation/process/changes.rst | null | null | null | null | null |
source | linux | .. _code_of_conduct_interpretation:
Linux Kernel Contributor Covenant Code of Conduct Interpretation
================================================================
The :ref:`code_of_conduct` is a general document meant to
provide a set of rules for almost any open source community. Every
open-source community is u... | Documentation/process/code-of-conduct-interpretation.rst | null | null | null | null | null |
source | linux | .. _code_of_conduct:
Contributor Covenant Code of Conduct
++++++++++++++++++++++++++++++++++++
Our Pledge
==========
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for ever... | Documentation/process/code-of-conduct.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. _coding_assistants:
AI Coding Assistants
++++++++++++++++++++
This document provides guidance for AI tools and developers using AI
assistance when contributing to the Linux kernel.
AI tools helping with Linux kernel development should follow the standard
kernel development pro... | Documentation/process/coding-assistants.rst | null | null | null | null | null |
source | linux | .. _codingstyle:
Linux kernel coding style
=========================
This is a short document describing the preferred coding style for the
linux kernel. Coding style is very personal, and I won't **force** my
views on anybody, but this is what goes for anything that I have to be
able to maintain, and I'd prefer it ... | Documentation/process/coding-style.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Linux kernel project continuity
===============================
The Linux kernel development project is widely distributed, with over
100 maintainers each working to keep changes moving through their own
repositories. The final step, though, is a centralized one where changes
are p... | Documentation/process/conclave.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
========================================
Linux Kernel Contribution Maturity Model
========================================
Background
==========
As a part of the 2021 Linux Kernel Maintainers’ Summit, there was a
`discussion <https://lwn.net/Articles/870581/>`_ about the challeng... | Documentation/process/contribution-maturity-model.rst | null | null | null | null | null |
source | linux | ====
CVEs
====
Common Vulnerabilities and Exposure (CVE®) numbers were developed as an
unambiguous way to identify, define, and catalog publicly disclosed
security vulnerabilities. Over time, their usefulness has declined with
regards to the kernel project, and CVE numbers were very often assigned
in inappropriate wa... | Documentation/process/cve.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. _deprecated:
=====================================================================
Deprecated Interfaces, Language Features, Attributes, and Conventions
=====================================================================
In a perfect world, it would be possible to convert all... | Documentation/process/deprecated.rst | null | null | null | null | null |
source | linux | .. _development_process_main:
A guide to the Kernel Development Process
=========================================
The purpose of this document is to help developers (and their managers)
work with the development community with a minimum of frustration. It is
an attempt to document how this community works in a way w... | Documentation/process/development-process.rst | null | null | null | null | null |
source | linux | .. _email_clients:
Email clients info for Linux
============================
Git
---
These days most developers use ``git send-email`` instead of regular
email clients. The man page for this is quite good. On the receiving
end, maintainers use ``git am`` to apply the patches.
If you are new to ``git`` then send y... | Documentation/process/email-clients.rst | null | null | null | null | null |
source | linux | .. _embargoed_hardware_issues:
Embargoed hardware issues
=========================
Scope
-----
Hardware issues which result in security problems are a different category
of security bugs than pure software bugs which only affect the Linux
kernel.
Hardware issues like Meltdown, Spectre, L1TF etc. must be treated
dif... | Documentation/process/embargoed-hardware-issues.rst | null | null | null | null | null |
source | linux | ============================================
Kernel Guidelines for Tool-Generated Content
============================================
Purpose
=======
Kernel contributors have been using tooling to generate contributions
for a long time. These tools can increase the volume of contributions.
At the same time, reviewer... | Documentation/process/generated-content.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: (GPL-2.0+ OR CC-BY-4.0)
.. See the bottom of this file for additional redistribution information.
Handling regressions
++++++++++++++++++++
*We don't cause regressions* -- this document describes what this "first rule of
Linux kernel development" means in practice for developers. It comple... | Documentation/process/handling-regressions.rst | null | null | null | null | null |
source | linux | .. _process_howto:
HOWTO do Linux kernel development
=================================
This is the be-all, end-all document on this topic. It contains
instructions on how to become a Linux kernel developer and how to learn
to work with the Linux kernel development community. It tries to not
contain anything related... | Documentation/process/howto.rst | null | null | null | null | null |
source | linux | .. raw:: latex
\renewcommand\thesection*
\renewcommand\thesubsection*
.. _process_index:
=============================================
Working with the kernel development community
=============================================
So you want to be a Linux kernel developer? Welcome! While there is a lot
to be learn... | Documentation/process/index.rst | null | null | null | null | null |
source | linux | .. _kernel_docs:
Index of Further Kernel Documentation
=====================================
The need for a document like this one became apparent in the linux-kernel
mailing list as the same questions, asking for pointers to information,
appeared again and again.
Fortunately, as more and more people get to GNU/Linu... | Documentation/process/kernel-docs.rst | null | null | null | null | null |
source | linux | .. _process_statement_driver:
Kernel Driver Statement
-----------------------
Position Statement on Linux Kernel Modules
==========================================
We, the undersigned Linux kernel developers, consider any closed-source
Linux kernel module or driver to be harmful and undesirable. We have
repeatedly ... | Documentation/process/kernel-driver-statement.rst | null | null | null | null | null |
source | linux | .. _process_statement_kernel:
Linux Kernel Enforcement Statement
----------------------------------
As developers of the Linux kernel, we have a keen interest in how our software
is used and how the license for our software is enforced. Compliance with the
reciprocal sharing obligations of GPL-2.0 is critical to the... | Documentation/process/kernel-enforcement-statement.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. _kernel_licensing:
Linux kernel licensing rules
============================
The Linux Kernel is provided under the terms of the GNU General Public
License version 2 only (GPL-2.0), as provided in LICENSES/preferred/GPL-2.0,
with an explicit syscall exception described in
LICEN... | Documentation/process/license-rules.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. _maintainer_handbooks_main:
Subsystem and maintainer tree specific development process notes
================================================================
The purpose of this document is to provide subsystem specific information
which is supplementary to the general developm... | Documentation/process/maintainer-handbooks.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
KVM x86
=======
Foreword
--------
KVM strives to be a welcoming community; contributions from newcomers are
valued and encouraged. Please do not be discouraged or intimidated by the
length of this document and the many rules/guidelines it contains. Everyone
makes mistakes, and ev... | Documentation/process/maintainer-kvm-x86.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. _netdev-FAQ:
=============================
Networking subsystem (netdev)
=============================
tl;dr
-----
- designate your patch to a tree - ``[PATCH net]`` or ``[PATCH net-next]``
- for fixes the ``Fixes:`` tag is required, regardless of the tree
- don't post larg... | Documentation/process/maintainer-netdev.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. _pgpguide:
===========================
Kernel Maintainer PGP guide
===========================
:Author: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
This document is aimed at Linux kernel developers, and especially at
subsystem maintainers. It contains a subset of inf... | Documentation/process/maintainer-pgp-guide.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==============================================
SoC Platforms with DTS Compliance Requirements
==============================================
Overview
--------
SoC platforms or subarchitectures should follow all the rules from
Documentation/process/maintainer-soc.rst. This documen... | Documentation/process/maintainer-soc-clean-dts.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=============
SoC Subsystem
=============
Overview
--------
The SoC subsystem is a place of aggregation for SoC-specific code.
The main components of the subsystem are:
* devicetrees (DTS) for 32- & 64-bit ARM and RISC-V
* 32-bit ARM board files (arch/arm/mach*)
* 32- & 64-bit AR... | Documentation/process/maintainer-soc.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
The tip tree handbook
=====================
What is the tip tree?
---------------------
The tip tree is a collection of several subsystems and areas of
development. The tip tree is both a direct development tree and an
aggregation tree for several sub-maintainer trees. The tip tre... | Documentation/process/maintainer-tip.rst | null | null | null | null | null |
source | linux | .. _managementstyle:
Linux kernel management style
=============================
This is a short document describing the preferred (or made up, depending
on who you ask) management style for the linux kernel. It's meant to
mirror the :ref:`process/coding-style.rst <codingstyle>` document to some
degree, and mainly w... | Documentation/process/management-style.rst | null | null | null | null | null |
source | linux | .. _programming_language:
Programming Language
====================
The Linux kernel is written in the C programming language [c-language]_.
More precisely, it is typically compiled with ``gcc`` [gcc]_
under ``-std=gnu11`` [gcc-c-dialect-options]_: the GNU dialect of ISO C11.
``clang`` [clang]_ is also supported; see... | Documentation/process/programming-language.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. _researcher_guidelines:
Researcher Guidelines
+++++++++++++++++++++
The Linux kernel community welcomes transparent research on the Linux
kernel, the activities involved in producing it, and any other byproducts
of its development. Linux benefits greatly from this kind of resea... | Documentation/process/researcher-guidelines.rst | null | null | null | null | null |
source | linux | .. _securitybugs:
Security bugs
=============
Linux kernel developers take security very seriously. As such, we'd
like to know when a security bug is found so that it can be fixed and
disclosed as quickly as possible. Please report security bugs to the
Linux kernel security team.
The security team and maintainers ... | Documentation/process/security-bugs.rst | null | null | null | null | null |
source | linux | .. _stable_api_nonsense:
The Linux Kernel Driver Interface
==================================
(all of your questions answered and then some)
Greg Kroah-Hartman <greg@kroah.com>
This is being written to try to explain why Linux **does not have a binary
kernel interface, nor does it have a stable kernel interface**.
... | Documentation/process/stable-api-nonsense.rst | null | null | null | null | null |
source | linux | .. _stable_kernel_rules:
Everything you ever wanted to know about Linux -stable releases
===============================================================
Rules on what kind of patches are accepted, and which ones are not, into the
"-stable" tree:
- It or an equivalent fix must already exist in Linux mainline (upstrea... | Documentation/process/stable-kernel-rules.rst | null | null | null | null | null |
source | linux | .. _submitchecklist:
=======================================
Linux Kernel patch submission checklist
=======================================
Here are some basic things that developers should do if they want to see their
kernel patch submissions accepted more quickly.
These are all above and beyond the documentation ... | Documentation/process/submit-checklist.rst | null | null | null | null | null |
source | linux | .. _submittingpatches:
Submitting patches: the essential guide to getting your code into the kernel
============================================================================
For a person or company who wishes to submit a change to the Linux
kernel, the process can sometimes be daunting if you're not familiar
with ... | Documentation/process/submitting-patches.rst | null | null | null | null | null |
source | linux | .. _volatile_considered_harmful:
Why the "volatile" type class should not be used
------------------------------------------------
C programmers have often taken volatile to mean that the variable could be
changed outside of the current thread of execution; as a result, they are
sometimes tempted to use it in kernel ... | Documentation/process/volatile-considered-harmful.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
========================================
Debugging advice for driver development
========================================
This document serves as a general starting point and lookup for debugging
device drivers.
While this guide focuses on debugging that requires re-compiling the
m... | Documentation/process/debugging/driver_development_debugging_guide.rst | null | null | null | null | null |
source | linux | .. highlight:: none
Debugging kernel and modules via gdb
====================================
The kernel debugger kgdb, hypervisors like QEMU or JTAG-based hardware
interfaces allow to debug the Linux kernel and its modules during runtime
using gdb. Gdb comes with a powerful scripting interface for python. The
kernel... | Documentation/process/debugging/gdb-kernel-debugging.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
============================================
Debugging advice for Linux Kernel developers
============================================
general guides
--------------
.. toctree::
:maxdepth: 1
driver_development_debugging_guide
gdb-kernel-debugging
kgdb
userspace_deb... | Documentation/process/debugging/index.rst | null | null | null | null | null |
source | linux | =================================================
Using kgdb, kdb and the kernel debugger internals
=================================================
:Author: Jason Wessel
Introduction
============
The kernel has two different debugger front ends (kdb and kgdb) which
interface to the debug core. It is possible to us... | Documentation/process/debugging/kgdb.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
============================================
Debugging and tracing in the media subsystem
============================================
This document serves as a starting point and lookup for debugging device
drivers in the media subsystem and to debug these drivers from userspace.
... | Documentation/process/debugging/media_specific_debugging_guide.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
==========================
Userspace debugging advice
==========================
This document provides a brief overview of common tools to debug the Linux
Kernel from userspace.
For debugging advice aimed at driver developers go :doc:`here
</process/debugging/driver_development_de... | Documentation/process/debugging/userspace_debugging_guide.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Arch Support
============
Currently, the Rust compiler (``rustc``) uses LLVM for code generation,
which limits the supported architectures that can be targeted. In addition,
support for building the kernel with LLVM/Clang varies (please see
Documentation/kbuild/llvm.rst). This supp... | Documentation/rust/arch-support.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Coding Guidelines
=================
This document describes how to write Rust code in the kernel.
Style & formatting
------------------
The code should be formatted using ``rustfmt``. In this way, a person
contributing from time to time to the kernel does not need to learn and
r... | Documentation/rust/coding-guidelines.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
General Information
===================
This document contains useful information to know when working with
the Rust support in the kernel.
``no_std``
----------
The Rust support in the kernel can link only `core <https://doc.rust-lang.org/core/>`_,
but not `std <https://doc.rus... | Documentation/rust/general-information.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Rust
====
Documentation related to Rust within the kernel. To start using Rust
in the kernel, please read the quick-start.rst guide.
Code documentation
------------------
Given a kernel configuration, the kernel may generate Rust code documentation,
i.e. HTML rendered by the ``r... | Documentation/rust/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Quick Start
===========
This document describes how to get started with kernel development in Rust.
There are a few ways to install a Rust toolchain needed for kernel development.
A simple way is to use the packages from your Linux distribution if they are
suitable -- the first se... | Documentation/rust/quick-start.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
Testing
=======
This document contains useful information how to test the Rust code in the
kernel.
There are three sorts of tests:
- The KUnit tests.
- The ``#[test]`` tests.
- The Kselftests.
The KUnit tests
---------------
These are the tests that come from the examples in th... | Documentation/rust/testing.rst | null | null | null | null | null |
source | linux | ================================================
Completions - "wait for completion" barrier APIs
================================================
Introduction:
-------------
If you have one or more threads that must wait for some kernel activity
to have reached a point or a specific state, completions can provide a
... | Documentation/scheduler/completion.rst | null | null | null | null | null |
source | linux | =========
Scheduler
=========
.. toctree::
:maxdepth: 1
completion
membarrier
sched-arch
sched-bwc
sched-deadline
sched-design-CFS
sched-eevdf
sched-domains
sched-capacity
sched-energy
schedutil
sched-util-clamp
sched-nice-design
sched-rt-group
sched-st... | Documentation/scheduler/index.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
========================
membarrier() System Call
========================
MEMBARRIER_CMD_{PRIVATE,GLOBAL}_EXPEDITED - Architecture requirements
=====================================================================
Memory barriers before updating rq->curr
-------------------------... | Documentation/scheduler/membarrier.rst | null | null | null | null | null |
source | linux | =================================================================
CPU Scheduler implementation hints for architecture specific code
=================================================================
Nick Piggin, 2005
Context switch
==============
1. Runqueue locking
By default, the switch_to arch function is called w... | Documentation/scheduler/sched-arch.rst | null | null | null | null | null |
source | linux | =====================
CFS Bandwidth Control
=====================
.. note::
This document only discusses CPU bandwidth control for SCHED_NORMAL.
The SCHED_RT case is covered in Documentation/scheduler/sched-rt-group.rst
CFS bandwidth control is a CONFIG_FAIR_GROUP_SCHED extension which allows the
specification ... | Documentation/scheduler/sched-bwc.rst | null | null | null | null | null |
source | linux | =========================
Capacity Aware Scheduling
=========================
1. CPU Capacity
===============
1.1 Introduction
----------------
Conventional, homogeneous SMP platforms are composed of purely identical
CPUs. Heterogeneous platforms on the other hand are composed of CPUs with
different performance char... | Documentation/scheduler/sched-capacity.rst | null | null | null | null | null |
source | linux | ========================
Deadline Task Scheduling
========================
.. CONTENTS
0. WARNING
1. Overview
2. Scheduling algorithm
2.1 Main algorithm
2.2 Bandwidth reclaiming
3. Scheduling Real-Time Tasks
3.1 Definitions
3.2 Schedulability Analysis for Uniprocessor Systems
... | Documentation/scheduler/sched-deadline.rst | null | null | null | null | null |
source | linux | =================
Scheduler debugfs
=================
Booting a kernel with debugfs enabled will give access to
scheduler specific debug files under /sys/kernel/debug/sched. Some of
those files are described below.
numa_balancing
==============
`numa_balancing` directory is used to hold files to control NUMA
balanci... | Documentation/scheduler/sched-debug.rst | null | null | null | null | null |
source | linux | .. _sched_design_CFS:
=============
CFS Scheduler
=============
1. OVERVIEW
============
CFS stands for "Completely Fair Scheduler," and is the "desktop" process
scheduler implemented by Ingo Molnar and merged in Linux 2.6.23. When
originally merged, it was the replacement for the previous vanilla
scheduler's SCHE... | Documentation/scheduler/sched-design-CFS.rst | null | null | null | null | null |
source | linux | =================
Scheduler Domains
=================
Each CPU has a "base" scheduling domain (struct sched_domain). The domain
hierarchy is built from these base domains via the ->parent pointer. ->parent
MUST be NULL terminated, and domain structures should be per-CPU as they are
locklessly updated.
Each scheduling... | Documentation/scheduler/sched-domains.rst | null | null | null | null | null |
source | linux | ===============
EEVDF Scheduler
===============
The "Earliest Eligible Virtual Deadline First" (EEVDF) was first introduced
in a scientific publication in 1995 [1]. The Linux kernel began
transitioning to EEVDF in version 6.6 (as a new option in 2024), moving
away from the earlier Completely Fair Scheduler (CFS) in fa... | Documentation/scheduler/sched-eevdf.rst | null | null | null | null | null |
source | linux | =======================
Energy Aware Scheduling
=======================
1. Introduction
---------------
Energy Aware Scheduling (or EAS) gives the scheduler the ability to predict
the impact of its decisions on the energy consumed by CPUs. EAS relies on an
Energy Model (EM) of the CPUs to select an energy efficient C... | Documentation/scheduler/sched-energy.rst | null | null | null | null | null |
source | linux | .. _sched-ext:
==========================
Extensible Scheduler Class
==========================
sched_ext is a scheduler class whose behavior can be defined by a set of BPF
programs - the BPF scheduler.
* sched_ext exports a full scheduling interface so that any scheduling
algorithm can be implemented on top.
* T... | Documentation/scheduler/sched-ext.rst | null | null | null | null | null |
source | linux | =====================
Scheduler Nice Design
=====================
This document explains the thinking about the revamped and streamlined
nice-levels implementation in the new Linux scheduler.
Nice levels were always pretty weak under Linux and people continuously
pestered us to make nice +19 tasks use up much less CP... | Documentation/scheduler/sched-nice-design.rst | null | null | null | null | null |
source | linux | /*
* The following program is used to generate the constants for
* computing sched averages.
*
* ==============================================================
* C program (compile with -lm)
* ==============================================================
*/
#include <math.h>
#include <stdio.h>
#define HALFLI... | Documentation/scheduler/sched-pelt.c | null | null | null | null | null |
source | linux | ==========================
Real-Time group scheduling
==========================
.. CONTENTS
0. WARNING
1. Overview
1.1 The problem
1.2 The solution
2. The interface
2.1 System-wide settings
2.2 Default behaviour
2.3 Basis for grouping tasks
3. Future plans
0. WARNING
==========... | Documentation/scheduler/sched-rt-group.rst | null | null | null | null | null |
source | linux | ====================
Scheduler Statistics
====================
Version 17 of schedstats removed 'lb_imbalance' field as it has no
significance anymore and instead added more relevant fields namely
'lb_imbalance_load', 'lb_imbalance_util', 'lb_imbalance_task' and
'lb_imbalance_misfit'. The domain field prints the name ... | Documentation/scheduler/sched-stats.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
====================
Utilization Clamping
====================
1. Introduction
===============
Utilization clamping, also known as util clamp or uclamp, is a scheduler
feature that allows user space to help in managing the performance requirement
of tasks. It was introduced in v5.... | Documentation/scheduler/sched-util-clamp.rst | null | null | null | null | null |
source | linux | =========
Schedutil
=========
.. note::
All this assumes a linear relation between frequency and work capacity,
we know this is flawed, but it is the best workable approximation.
PELT (Per Entity Load Tracking)
===============================
With PELT we track some metrics across the various scheduler entit... | Documentation/scheduler/schedutil.rst | null | null | null | null | null |
source | linux | Scheduler pelt c program
------------------------
.. literalinclude:: sched-pelt.c
:language: c | Documentation/scheduler/text_files.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=======================
The 53c700 Driver Notes
=======================
General Description
===================
This driver supports the 53c700 and 53c700-66 chips. It also supports
the 53c710 but only in 53c700 emulation mode. It is full featured and
does sync (-66 and 710 only... | Documentation/scsi/53c700.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=========================================================
BusLogic MultiMaster and FlashPoint SCSI Driver for Linux
=========================================================
Version 2.0.15 for Linux 2.0
Version 2.1.15 for Linux 2.1
PRODUCTION RELEASE
17 Augu... | Documentation/scsi/BusLogic.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===================================
The BusLogic FlashPoint SCSI Driver
===================================
The BusLogic FlashPoint SCSI Host Adapters are now fully supported on Linux.
The upgrade program described below has been officially terminated effective
31 March 1997 since ... | Documentation/scsi/FlashPoint.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=========================================
WorkBiT NinjaSCSI-3/32Bi driver for Linux
=========================================
1. Comment
==========
This is Workbit corp.'s(http://www.workbit.co.jp/) NinjaSCSI-3
for Linux.
2. My Linux environment
=======================
:Linux ke... | Documentation/scsi/NinjaSCSI.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
===================================
AACRAID Driver for Linux (take two)
===================================
Introduction
============
The aacraid driver adds support for Adaptec (http://www.adaptec.com)
RAID controllers. This is a major rewrite from the original
Adaptec supplied dr... | Documentation/scsi/aacraid.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
=====================
AdvanSys Driver Notes
=====================
AdvanSys (Advanced System Products, Inc.) manufactures the following
RISC-based, Bus-Mastering, Fast (10 Mhz) and Ultra (20 Mhz) Narrow
(8-bit transfer) SCSI Host Adapters for the ISA, EISA, VL, and PCI
buses and RIS... | Documentation/scsi/advansys.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. include:: <isonum.txt>
=====================================================
Adaptec AHA-1520/1522 SCSI driver for Linux (aha152x)
=====================================================
Copyright |copy| 1993-1999 Jürgen Fischer <fischer@norbit.de>
TC1550 patches by Luuk van Dijk... | Documentation/scsi/aha152x.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. include:: <isonum.txt>
===================================
Adaptec Ultra320 Family Manager Set
===================================
README for The Linux Operating System
.. The following information is available in this file:
1. Supported Hardware
2. Version History
3. Co... | Documentation/scsi/aic79xx.rst | null | null | null | null | null |
source | linux | .. SPDX-License-Identifier: GPL-2.0
.. include:: <isonum.txt>
========================================================
Adaptec Aic7xxx Fast -> Ultra160 Family Manager Set v7.0
========================================================
README for The Linux Operating System
The following information is available in this... | Documentation/scsi/aic7xxx.rst | null | null | null | null | null |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.