aboutsummaryrefslogtreecommitdiff
path: root/linuxthreads/man/pthread_setschedparam.man
diff options
context:
space:
mode:
Diffstat (limited to 'linuxthreads/man/pthread_setschedparam.man')
-rw-r--r--linuxthreads/man/pthread_setschedparam.man79
1 files changed, 79 insertions, 0 deletions
diff --git a/linuxthreads/man/pthread_setschedparam.man b/linuxthreads/man/pthread_setschedparam.man
new file mode 100644
index 0000000000..3992927837
--- /dev/null
+++ b/linuxthreads/man/pthread_setschedparam.man
@@ -0,0 +1,79 @@
+.TH PTHREAD_SETSCHEDPARAM 3 LinuxThreads
+
+.XREF pthread_getschedparam
+
+.SH NAME
+pthread_setschedparam, pthread_getschedparam \- control thread scheduling parameters
+
+.SH SYNOPSIS
+#include <pthread.h>
+
+int pthread_setschedparam(pthread_t target_thread, int policy, const struct sched_param *param);
+
+int pthread_getschedparam(pthread_t target_thread, int *policy, struct sched_param *param);
+
+.SH DESCRIPTION
+
+!pthread_setschedparam! sets the scheduling parameters for the thread
+|target_thread| as indicated by |policy| and |param|. |policy| can be
+either !SCHED_OTHER! (regular, non-realtime scheduling), !SCHED_RR!
+(realtime, round-robin) or !SCHED_FIFO! (realtime, first-in
+first-out). |param| specifies the scheduling priority for the two
+realtime policies. See !sched_setpolicy!(2) for more information on
+scheduling policies.
+
+The realtime scheduling policies !SCHED_RR! and !SCHED_FIFO! are
+available only to processes with superuser privileges.
+
+!pthread_getschedparam! retrieves the scheduling policy and scheduling
+parameters for the thread |target_thread| and store them in the
+locations pointed to by |policy| and |param|, respectively.
+
+.SH "RETURN VALUE"
+!pthread_setschedparam! and !pthread_getschedparam! return 0 on
+success and a non-zero error code on error.
+
+.SH ERRORS
+On error, !pthread_setschedparam! returns the following error codes:
+.RS
+.TP
+!EINVAL!
+|policy| is not one of !SCHED_OTHER!, !SCHED_RR!, !SCHED_FIFO!
+
+.TP
+!EINVAL!
+the priority value specified by |param| is not valid for the specified policy
+
+.TP
+!EPERM!
+the calling process does not have superuser permissions
+
+.TP
+!ESRCH!
+the |target_thread| is invalid or has already terminated
+
+.TP
+!EFAULT!
+|param| points outside the process memory space
+.RE
+
+On error, !pthread_getschedparam! returns the following error codes:
+.RS
+.TP
+!ESRCH!
+the |target_thread| is invalid or has already terminated
+
+.TP
+!EFAULT!
+|policy| or |param| point outside the process memory space
+.RE
+
+.SH AUTHOR
+Xavier Leroy <Xavier.Leroy@inria.fr>
+
+.SH "SEE ALSO"
+!sched_setscheduler!(2),
+!sched_getscheduler!(2),
+!sched_getparam!(2),
+!pthread_attr_setschedpolicy!(3),
+!pthread_attr_setschedparam!(3).