2008-11-05 21:31:22 +00:00
|
|
|
.\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
|
|
|
|
.\" <mtk.manpages@gmail.com>
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
|
|
|
.\"
|
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
|
|
|
.\"
|
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
2010-02-03 03:48:15 +00:00
|
|
|
.TH PTHREAD_ATTR_SETSCHEDPARAM 3 2010-02-03 "Linux" "Linux Programmer's Manual"
|
2008-11-05 21:31:22 +00:00
|
|
|
.SH NAME
|
|
|
|
pthread_attr_setschedparam, pthread_attr_getschedparam \- set/get
|
|
|
|
scheduling parameter attributes in thread attributes object
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <pthread.h>
|
|
|
|
|
|
|
|
.BI "int pthread_attr_setschedparam(pthread_attr_t *" attr ,
|
|
|
|
.BI " const struct sched_param *" param );
|
|
|
|
.BI "int pthread_attr_getschedparam(pthread_attr_t *" attr ,
|
|
|
|
.BI " struct sched_param *" param );
|
|
|
|
.sp
|
|
|
|
Compile and link with \fI\-pthread\fP.
|
|
|
|
.SH DESCRIPTION
|
|
|
|
The
|
|
|
|
.BR pthread_attr_setschedparam ()
|
|
|
|
function sets the scheduling parameter attributes of the
|
|
|
|
thread attributes object referred to by
|
2010-02-03 03:48:15 +00:00
|
|
|
.IR attr
|
2008-11-05 21:31:22 +00:00
|
|
|
to the values specified in the buffer pointed to by
|
|
|
|
.IR param .
|
|
|
|
These attributes determine the scheduling parameters of
|
|
|
|
a thread created using the thread attributes object
|
|
|
|
.IR attr .
|
|
|
|
|
|
|
|
The
|
|
|
|
.BR pthread_attr_getschedparam ()
|
|
|
|
returns the scheduling parameter attributes of the thread attributes object
|
|
|
|
.IR attr
|
|
|
|
in the buffer pointed to by
|
|
|
|
.IR param .
|
|
|
|
|
|
|
|
Scheduling parameters are maintained in the following structure:
|
|
|
|
|
|
|
|
.in +4n
|
|
|
|
.nf
|
|
|
|
struct sched_param {
|
|
|
|
int sched_priority; /* Scheduling priority */
|
|
|
|
};
|
|
|
|
.fi
|
|
|
|
.in
|
|
|
|
|
2008-11-17 17:41:16 +00:00
|
|
|
As can be seen, only one scheduling parameter is supported.
|
2008-11-05 21:31:22 +00:00
|
|
|
For details of the permitted ranges for scheduling priorities
|
|
|
|
in each scheduling policy, see
|
|
|
|
.BR sched_setscheduler (2).
|
|
|
|
.SH RETURN VALUE
|
|
|
|
On success, these functions return 0;
|
intro.1, time.1, adjtimex.2, capget.2, eventfd.2, fcntl.2, getrlimit.2, getsockopt.2, gettimeofday.2, intro.2, ioctl_list.2, ioperm.2, mlock.2, pivot_root.2, poll.2, prctl.2, ptrace.2, sched_setscheduler.2, select_tut.2, semget.2, sigaltstack.2, signalfd.2, sysctl.2, timer_settime.2, timerfd_create.2, wait.2, CPU_SET.3, argz_add.3, assert_perror.3, atexit.3, backtrace.3, bcmp.3, clearenv.3, ctime.3, dl_iterate_phdr.3, dlopen.3, ecvt.3, errno.3, error.3, ether_aton.3, exit.3, fenv.3, ferror.3, finite.3, flockfile.3, fnmatch.3, fpathconf.3, fpclassify.3, ftime.3, ftok.3, ftw.3, fwide.3, getaddrinfo.3, gethostbyname.3, getlogin.3, getnameinfo.3, getnetent.3, getopt.3, getprotoent.3, getrpcent.3, getservent.3, glob.3, hsearch.3, inet.3, isalpha.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, longjmp.3, lsearch.3, malloc.3, matherr.3, mblen.3, mbsinit.3, mbtowc.3, on_exit.3, printf.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_attr_setdetachstate.3, pthread_attr_setguardsize.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstack.3, pthread_attr_setstackaddr.3, pthread_attr_setstacksize.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_equal.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setschedparam.3, pthread_setschedprio.3, ptsname.3, putenv.3, putgrent.3, raise.3, rcmd.3, regex.3, rexec.3, rpc.3, rpmatch.3, rtnetlink.3, scandir.3, sem_init.3, setaliasent.3, setbuf.3, setenv.3, setjmp.3, signbit.3, stdio_ext.3, strtod.3, strtol.3, strtoul.3, system.3, termios.3, timeradd.3, tzset.3, ualarm.3, wctomb.3, xdr.3, st.4, tty_ioctl.4, core.5, elf.5, proc.5, bootparam.7, capabilities.7, icmp.7, ip.7, ipv6.7, math_error.7, mdoc.samples.7, mq_overview.7, pthreads.7, raw.7, regex.7, socket.7, tcp.7, tzselect.8: Global fix: s/non-zero/nonzero/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:40:55 +00:00
|
|
|
on error, they return a nonzero error number.
|
2008-11-05 21:31:22 +00:00
|
|
|
.SH ERRORS
|
|
|
|
POSIX.1 documents
|
|
|
|
.B EINVAL
|
|
|
|
and
|
|
|
|
.B ENOTSUP
|
|
|
|
errors for
|
|
|
|
.BR pthread_attr_setschedparam ().
|
|
|
|
On Linux these functions always succeed
|
|
|
|
(but portable and future-proof applications should nevertheless
|
|
|
|
handle a possible error return).
|
|
|
|
.\" .SH VERSIONS
|
|
|
|
.\" Available since glibc 2.0.
|
|
|
|
.SH CONFORMING TO
|
|
|
|
POSIX.1-2001.
|
2008-11-06 17:41:35 +00:00
|
|
|
.SH EXAMPLE
|
|
|
|
See
|
|
|
|
.BR pthread_setschedparam (3).
|
2008-11-05 21:31:22 +00:00
|
|
|
.SH NOTES
|
|
|
|
See
|
|
|
|
.BR pthread_attr_setschedpolicy (3)
|
|
|
|
for a list of the thread scheduling policies supported on Linux.
|
|
|
|
.SH SEE ALSO
|
|
|
|
.BR sched_get_priority_min (2),
|
|
|
|
.BR sched_setscheduler (2),
|
|
|
|
.BR pthread_attr_init (3),
|
|
|
|
.BR pthread_attr_setinheritsched (3),
|
|
|
|
.BR pthread_attr_setschedpolicy (3),
|
|
|
|
.BR pthread_create (3),
|
|
|
|
.BR pthread_setschedparam (3),
|
|
|
|
.BR pthread_setschedprio (3),
|
|
|
|
.BR pthreads (7)
|