sched.7: Add a subsection listing all APIs.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2014-04-28 12:27:56 +02:00
parent 720a5280de
commit b16695a316
1 changed files with 47 additions and 0 deletions

View File

@ -31,6 +31,53 @@
.SH NAME
sched \- overview of scheduling APIs
.SH DESCRIPTION
.SS API summary
The Linux scheduling APIs are as follows:
.TP
.BR sched_setscheduler (2)
Set the scheduling policy and parameters of a specified thread.
.TP
.BR sched_getscheduler (2)
Return the scheduling policy of a specified thread.
.TP
.BR sched_setparam (2)
Set the scheduling parameters of a specified thread.
.TP
.BR sched_getparam (2)
Fetch the scheduling parameters of a specified thread.
.TP
.BR sched_get_priority_max (2)
Return the minimum priority available in a specified scheduling policy.
.TP
.BR sched_get_priority_min (2)
Return the maximum priority available in a specified scheduling policy.
.TP
.BR sched_rr_getinterval (2)
Fetch the quantum used for threads that are scheduled under
the "round-robin" scheduling policy.
.TP
.BR sched_yield (2)
Cause the caller to relinquish the CPU,
so that some other thread be executed.
.TP
.BR sched_setaffinity (2)
(Linux-specific)
Set the CPU affinity of a specified thread.
.TP
.BR sched_getaffinity (2)
(Linux-specific)
Set the CPU affinity of a specified thread.
.TP
.BR sched_setattr (2)
(Linux-specific)
A generaized API for setting the scheduling policy and parameters
of a specified thread.
.TP
.BR sched_getattr (2)
(Linux-specific)
A generaized API for fetching the scheduling policy and parameters
of a specified thread.
.\"
.SS Scheduling policies
The scheduler is the kernel component that decides which runnable thread
will be executed by the CPU next.