mirror of
https://github.com/freebsd/freebsd-src.git
synced 2026-10-28 11:25:21 +01:00
sched_getcpu: Add man page
Reviewed by: kib Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D47556
This commit is contained in:
1 parent
de7a92756f
commit
36887e0494
2 files changed
+52
No files matched your search
@@ -299,6 +299,7 @@ MAN+= abort2.2 \
|
||||
rmdir.2 \
|
||||
rtprio.2 \
|
||||
sched_get_priority_max.2 \
|
||||
sched_getcpu.3 \
|
||||
sched_setparam.2 \
|
||||
sched_setscheduler.2 \
|
||||
sched_yield.2 \
|
||||
|
||||
@@ -0,0 +1,51 @@
|
||||
.\" SPDX-License-Identifier: BSD-2-Clause
|
||||
.\"
|
||||
.\" Copyright (c) 2024 The FreeBSD Foundation
|
||||
.\"
|
||||
.\" This documentation was written by Ed Maste <[email protected]>
|
||||
.\" under sponsorship from the FreeBSD Foundation.
|
||||
.\"
|
||||
.Dd November 13, 2024
|
||||
.Dt SCHED_GETCPU 3
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm sched_getcpu
|
||||
.Nd get current CPU
|
||||
.Sh LIBRARY
|
||||
.Lb libc
|
||||
.Sh SYNOPSIS
|
||||
.In sched.h
|
||||
.Ft int
|
||||
.Fn sched_getcpu void
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Fn sched_getcpu
|
||||
function returns the current CPU on which the calling thread is running.
|
||||
.Sh RETURN VALUES
|
||||
.Fn sched_getcpu
|
||||
returns the 0-based index of the current CPU at the time of the call.
|
||||
The value may become invalid immediately after return, unless the thread is
|
||||
pinned to a specific CPU.
|
||||
CPU numbering is the same as used by
|
||||
.Xr cpuset 2
|
||||
and CPU affinity calls.
|
||||
.Pp
|
||||
There are no error values as
|
||||
.Fn sched_getcpu
|
||||
does not fail.
|
||||
.Sh SEE ALSO
|
||||
.Xr cpuset 2 ,
|
||||
.Xr cpuset_getaffinity 2 ,
|
||||
.Xr cpuset_setaffinity 2 ,
|
||||
.Xr pthread_getaffinity_np 3 ,
|
||||
.Xr pthread_setaffinity_np
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Nm
|
||||
function originated in Linux.
|
||||
This implementation aims to be source-compatible with the Linux implementation.
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
function was introduced in
|
||||
.Fx 13.1 .
|
||||
Reference in new issue
Block a user