]> git.ipfire.org Git - thirdparty/man-pages.git/blobdiff - man3/sched_getcpu.3
Revert "src.mk, All pages: Move man* to man/"
[thirdparty/man-pages.git] / man3 / sched_getcpu.3
diff --git a/man3/sched_getcpu.3 b/man3/sched_getcpu.3
new file mode 100644 (file)
index 0000000..9e4fa90
--- /dev/null
@@ -0,0 +1,92 @@
+.\" Copyright (c) 2008, Linux Foundation, written by Michael Kerrisk
+.\"     <mtk.manpages@gmail.com>
+.\"
+.\" SPDX-License-Identifier: Linux-man-pages-copyleft
+.\"
+.TH SCHED_GETCPU 3 2021-03-22 "Linux man-pages (unreleased)"
+.SH NAME
+sched_getcpu \- determine CPU on which the calling thread is running
+.SH LIBRARY
+Standard C library
+.RI ( libc ", " \-lc )
+.SH SYNOPSIS
+.nf
+.B #include <sched.h>
+.PP
+.B int sched_getcpu(void);
+.fi
+.PP
+.RS -4
+Feature Test Macro Requirements for glibc (see
+.BR feature_test_macros (7)):
+.RE
+.PP
+.BR sched_getcpu ():
+.nf
+    Since glibc 2.14:
+        _GNU_SOURCE
+    Before glibc 2.14:
+        _BSD_SOURCE || _SVID_SOURCE
+            /* _GNU_SOURCE also suffices */
+.fi
+.SH DESCRIPTION
+.BR sched_getcpu ()
+returns the number of the CPU
+on which the calling thread is currently executing.
+.SH RETURN VALUE
+On success,
+.BR sched_getcpu ()
+returns a nonnegative CPU number.
+On error, \-1 is returned and
+.I errno
+is set to indicate the error.
+.SH ERRORS
+.TP
+.B ENOSYS
+This kernel does not implement
+.BR getcpu (2).
+.SH VERSIONS
+This function is available since glibc 2.6.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.ad l
+.nh
+.TS
+allbox;
+lbx lb lb
+l l l.
+Interface      Attribute       Value
+T{
+.BR sched_getcpu ()
+T}     Thread safety   MT-Safe
+.TE
+.hy
+.ad
+.sp 1
+.SH STANDARDS
+.BR sched_getcpu ()
+is glibc-specific.
+.SH NOTES
+The call
+.PP
+.in +4n
+.EX
+cpu = sched_getcpu();
+.EE
+.in
+.PP
+is equivalent to the following
+.BR getcpu (2)
+call:
+.PP
+.in +4n
+.EX
+int c, s;
+s = getcpu(&c, NULL, NULL);
+cpu = (s == \-1) ? s : c;
+.EE
+.in
+.SH SEE ALSO
+.BR getcpu (2),
+.BR sched (7)