xref: /illumos-gate/usr/src/man/man3c/get_nprocs.3c (revision bbf215553c7233fbab8a0afdf1fac74c44781867)
1d2b9ba29SRobert Mustacchi.\"
2d2b9ba29SRobert Mustacchi.\" This file and its contents are supplied under the terms of the
3d2b9ba29SRobert Mustacchi.\" Common Development and Distribution License ("CDDL"), version 1.0.
4d2b9ba29SRobert Mustacchi.\" You may only use this file in accordance with the terms of version
5d2b9ba29SRobert Mustacchi.\" 1.0 of the CDDL.
6d2b9ba29SRobert Mustacchi.\"
7d2b9ba29SRobert Mustacchi.\" A full copy of the text of the CDDL should have accompanied this
8d2b9ba29SRobert Mustacchi.\" source.  A copy of the CDDL is also available via the Internet at
9d2b9ba29SRobert Mustacchi.\" http://www.illumos.org/license/CDDL.
10d2b9ba29SRobert Mustacchi.\"
11d2b9ba29SRobert Mustacchi.\"
12d2b9ba29SRobert Mustacchi.\" Copyright (c) 2014 Joyent, Inc.
13d2b9ba29SRobert Mustacchi.\"
14d2b9ba29SRobert Mustacchi.Dd "Dec 21, 2014"
15d2b9ba29SRobert Mustacchi.Dt GET_NPROCS 3C
16d2b9ba29SRobert Mustacchi.Os
17d2b9ba29SRobert Mustacchi.Sh NAME
18d2b9ba29SRobert Mustacchi.Nm get_nprocs ,
19d2b9ba29SRobert Mustacchi.Nm get_nprocs_conf
20d2b9ba29SRobert Mustacchi.Nd get number of processors
21d2b9ba29SRobert Mustacchi.Sh SYNOPSIS
22d2b9ba29SRobert Mustacchi.In unistd.h
23d2b9ba29SRobert Mustacchi.Ft int
24d2b9ba29SRobert Mustacchi.Fo get_nprocs
25d2b9ba29SRobert Mustacchi.Fa void
26d2b9ba29SRobert Mustacchi.Fc
27d2b9ba29SRobert Mustacchi.Ft int
28d2b9ba29SRobert Mustacchi.Fo get_nprocs_conf
29d2b9ba29SRobert Mustacchi.Fa void
30d2b9ba29SRobert Mustacchi.Fc
31d2b9ba29SRobert Mustacchi.Sh DESCRIPTION
32d2b9ba29SRobert MustacchiThe
33d2b9ba29SRobert Mustacchi.Fn get_nprocs
34d2b9ba29SRobert Mustacchiand
35d2b9ba29SRobert Mustacchi.Fn get_nprocs_conf
36d2b9ba29SRobert Mustacchifunctions are provided for compatibility with other systems and are
37d2b9ba29SRobert Mustacchiequivalent to calling
38d2b9ba29SRobert Mustacchi.Fn sysconf _SC_NPROCESSORS_ONLN
39d2b9ba29SRobert Mustacchiand
40d2b9ba29SRobert Mustacchi.Fn sysconf _SC_NPROCESSORS_CONF
41d2b9ba29SRobert Mustacchirespectively.
42d2b9ba29SRobert Mustacchi.Sh RETURN VALUES
43d2b9ba29SRobert MustacchiThe
44d2b9ba29SRobert Mustacchi.Fn get_nprocs
4572d3dbb9SYuri Pankovfunction returns the number of processors that are currently online.
4672d3dbb9SYuri PankovThe
47d2b9ba29SRobert Mustacchi.Fn get_nprocs_conf
48d2b9ba29SRobert Mustacchifunction returns the number of processors that the operating system has
49d2b9ba29SRobert Mustacchiconfigured.
50d2b9ba29SRobert Mustacchi.Sh INTERFACE STABILITY
51d2b9ba29SRobert Mustacchi.Sy Committed .
52d2b9ba29SRobert Mustacchi.Sh MT-LEVEL
53d2b9ba29SRobert Mustacchi.Sy MT-Safe ,
54d2b9ba29SRobert Mustacchi.Sy Async-Signal-Safe
55d2b9ba29SRobert Mustacchi.Sh SEE ALSO
56d2b9ba29SRobert Mustacchi.Xr processor_info 2 ,
57d2b9ba29SRobert Mustacchi.Xr sysconf 3C ,
58*bbf21555SRichard Lowe.Xr attributes 7 ,
59*bbf21555SRichard Lowe.Xr standards 7 ,
60*bbf21555SRichard Lowe.Xr psrinfo 8
61