From b16695a3160a3ac97f37abf2666f665d3f8e08af Mon Sep 17 00:00:00 2001 From: Michael Kerrisk Date: Mon, 28 Apr 2014 12:27:56 +0200 Subject: [PATCH] sched.7: Add a subsection listing all APIs. Signed-off-by: Michael Kerrisk --- man7/sched.7 | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) diff --git a/man7/sched.7 b/man7/sched.7 index f64112408..9ad6677ac 100644 --- a/man7/sched.7 +++ b/man7/sched.7 @@ -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.