2008-11-05 04:39:33 +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.
|
|
|
|
.\"
|
2009-01-31 11:23:40 +00:00
|
|
|
.TH PTHREAD_ATTR_SETAFFINITY_NP 3 2009-02-01 "Linux" "Linux Programmer's Manual"
|
2008-11-05 04:39:33 +00:00
|
|
|
.SH NAME
|
|
|
|
pthread_attr_setaffinity_np, pthread_attr_getaffinity_np \- set/get
|
2008-11-14 16:40:32 +00:00
|
|
|
CPU affinity attribute in thread attributes object
|
2008-11-05 04:39:33 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #define _GNU_SOURCE
|
|
|
|
.B #include <pthread.h>
|
|
|
|
|
2009-01-31 11:23:40 +00:00
|
|
|
.BI "int pthread_attr_setaffinity_np(pthread_attr_t *" attr ,
|
2008-11-05 04:39:33 +00:00
|
|
|
.BI " size_t " cpusetsize ", const cpu_set_t *" cpuset );
|
2009-01-31 11:23:40 +00:00
|
|
|
.BI "int pthread_attr_getaffinity_np(pthread_attr_t *" attr ,
|
2008-11-05 04:39:33 +00:00
|
|
|
.BI " size_t " cpusetsize ", cpu_set_t *" cpuset );
|
|
|
|
.sp
|
|
|
|
Compile and link with \fI\-pthread\fP.
|
|
|
|
.SH DESCRIPTION
|
|
|
|
The
|
|
|
|
.BR pthread_attr_setaffinity_np ()
|
2009-09-27 06:58:35 +00:00
|
|
|
function
|
2008-11-05 04:39:33 +00:00
|
|
|
sets the CPU affinity mask attribute of the
|
|
|
|
thread attributes object referred to by
|
|
|
|
.I attr
|
|
|
|
to the value specified in
|
|
|
|
.IR cpuset .
|
|
|
|
This attribute determines the CPU affinity mask
|
|
|
|
of a thread created using the thread attributes object
|
|
|
|
.IR attr .
|
|
|
|
|
|
|
|
The
|
|
|
|
.BR pthread_attr_getaffinity_np ()
|
2009-09-27 06:58:35 +00:00
|
|
|
function
|
2008-11-05 04:39:33 +00:00
|
|
|
returns the CPU affinity mask attribute of the thread attributes object
|
|
|
|
referred to by
|
|
|
|
.IR attr
|
|
|
|
in the buffer pointed to by
|
|
|
|
.IR cpuset .
|
|
|
|
|
|
|
|
The argument
|
|
|
|
.I cpusetsize
|
|
|
|
is the length (in bytes) of the buffer pointed to by
|
|
|
|
.IR cpuset .
|
2008-11-12 18:51:51 +00:00
|
|
|
Typically, this argument would be specified as
|
2008-11-05 04:39:33 +00:00
|
|
|
.IR sizeof(cpu_set_t) .
|
|
|
|
|
2008-11-12 18:47:08 +00:00
|
|
|
For more details on CPU affinity masks, see
|
|
|
|
.BR sched_setaffinity (2).
|
|
|
|
For a description of a set of macros
|
2008-11-05 04:39:33 +00:00
|
|
|
that can be used to manipulate and inspect CPU sets, see
|
2008-11-12 18:47:08 +00:00
|
|
|
.BR CPU_SET (3).
|
2008-11-05 04:39:33 +00:00
|
|
|
.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 04:39:33 +00:00
|
|
|
.SH ERRORS
|
|
|
|
.TP
|
|
|
|
.BR EINVAL
|
|
|
|
.RB ( pthread_attr_setaffinity_np ())
|
|
|
|
.I cpuset
|
2008-11-14 16:40:32 +00:00
|
|
|
specified a CPU that was outside the set supported by the kernel.
|
|
|
|
(The kernel configuration option
|
|
|
|
.BR CONFIG_NR_CPUS
|
|
|
|
defines the range of the set supported by the kernel data type
|
2008-11-05 04:39:33 +00:00
|
|
|
.\" cpumask_t
|
2008-11-14 16:40:32 +00:00
|
|
|
used to represent CPU sets.)
|
2008-11-05 04:39:33 +00:00
|
|
|
.\" The raw sched_getaffinity() system call returns the size (in bytes)
|
|
|
|
.\" of the cpumask_t type.
|
|
|
|
.TP
|
|
|
|
.B EINVAL
|
2008-11-14 16:40:32 +00:00
|
|
|
.RB ( pthread_attr_getaffinity_np ())
|
2008-11-05 04:39:33 +00:00
|
|
|
A CPU in the affinity mask of the thread attributes object referred to by
|
|
|
|
.I attr
|
|
|
|
lies outside the range specified by
|
2008-11-26 02:44:53 +00:00
|
|
|
.IR cpusetsize
|
2008-11-14 16:40:32 +00:00
|
|
|
(i.e.,
|
|
|
|
.IR cpuset / cpusetsize
|
|
|
|
is too small).
|
2008-11-05 04:39:33 +00:00
|
|
|
.TP
|
|
|
|
.B ENOMEM
|
|
|
|
.RB ( pthread_attr_setaffinity_np ())
|
|
|
|
Could not allocate memory.
|
|
|
|
.SH VERSIONS
|
|
|
|
These functions are provided by glibc since version 2.3.4.
|
|
|
|
.SH CONFORMING TO
|
accept.2, execve.2, futimesat.2, getresuid.2, getrlimit.2, madvise.2, mq_getsetattr.2, msgctl.2, nice.2, open.2, poll.2, setresuid.2, shmctl.2, sigaction.2, times.2, utimensat.2, __setfpucw.3, atoi.3, endian.3, err.3, euidaccess.3, fenv.3, fopencookie.3, fpurge.3, getgrouplist.3, getutmp.3, j0.3, lgamma.3, netlink.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_cleanup_push_defer_np.3, pthread_getattr_np.3, pthread_kill_other_threads_np.3, pthread_setaffinity_np.3, pthread_tryjoin_np.3, pthread_yield.3, random_r.3, readdir.3, rtnetlink.3, scanf.3, setenv.3, significand.3, sigsetops.3, strerror.3, strstr.3, sysv_signal.3, termios.3, timegm.3, unlocked_stdio.3, y0.3, locale.5, bootparam.7, feature_test_macros.7, ip.7, locale.7, pthreads.7, rtld-audit.7, nscd.8: Global fix: s/non-standard/nonstandard/
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:37:52 +00:00
|
|
|
These functions are nonstandard GNU extensions;
|
execve.2, fallocate.2, futex.2, sched_rr_get_interval.2, select_tut.2, shmget.2, timer_getoverrun.2, times.2, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_cleanup_push_defer_np.3, pthread_getattr_np.3, pthread_self.3, pthread_setaffinity_np.3, pthread_tryjoin_np.3, sem_open.3, stdin.3, rtc.4, tty_ioctl.4, unix.7: Global fix: s/non-portable/nonportable/
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:46:09 +00:00
|
|
|
hence the suffix "_np" (nonportable) in the names.
|
2008-11-05 04:39:33 +00:00
|
|
|
.SH NOTES
|
|
|
|
In glibc 2.3.3 only,
|
|
|
|
versions of these functions were provided that did not have a
|
|
|
|
.I cpusetsize
|
|
|
|
argument.
|
|
|
|
Instead the CPU set size given to the underlying system calls was always
|
|
|
|
.IR sizeof(cpu_set_t) .
|
|
|
|
.SH SEE ALSO
|
|
|
|
.BR sched_setaffinity (2),
|
|
|
|
.BR pthread_attr_init (3),
|
|
|
|
.BR pthread_setaffinity_np (3),
|
|
|
|
.BR cpuset (7),
|
|
|
|
.BR pthreads (7)
|