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