man-pages/man3/get_nprocs_conf.3.html
2021-03-31 01:06:50 +01:00

161 lines
3.9 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of GET_NPROCS</TITLE>
</HEAD><BODY>
<H1>GET_NPROCS</H1>
Section: Linux Programmer's Manual (3)<BR>Updated: 2019-03-06<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
get_nprocs, get_nprocs_conf - get number of processors
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>#include &lt;<A HREF="file:///usr/include/sys/sysinfo.h">sys/sysinfo.h</A>&gt;</B>
<P>
<B>int get_nprocs(void);</B>
<BR>
<B>int get_nprocs_conf(void);</B>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
The function
<B>get_nprocs_conf</B>()
returns the number of processors configured by the operating system.
<P>
The function
<B>get_nprocs</B>()
returns the number of processors currently available in the system.
This may be less than the number returned by
<B>get_nprocs_conf</B>()
because processors may be offline (e.g., on hotpluggable systems).
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
As given in DESCRIPTION.
<A NAME="lbAF">&nbsp;</A>
<H2>ATTRIBUTES</H2>
For an explanation of the terms used in this section, see
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
<TABLE BORDER>
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
<TR VALIGN=top><TD>
<B>get_nprocs</B>(),
<BR>
<B>get_nprocs_conf</B>()
</TD><TD>Thread safety</TD><TD>MT-Safe<BR></TD></TR>
</TABLE>
<P>
<A NAME="lbAG">&nbsp;</A>
<H2>CONFORMING TO</H2>
These functions are GNU extensions.
<A NAME="lbAH">&nbsp;</A>
<H2>NOTES</H2>
The current
implementation of these functions is rather expensive,
since they open and parse files in the
<I>/sys</I>
filesystem each time they are called.
<P>
The following
<B><A HREF="/cgi-bin/man/man2html?3+sysconf">sysconf</A></B>(3)
calls make use of the functions documented on this page
to return the same information.
<P>
np = sysconf(_SC_NPROCESSORS_CONF); /* processors configured */
np = sysconf(_SC_NPROCESSORS_ONLN); /* processors available */
<A NAME="lbAI">&nbsp;</A>
<H2>EXAMPLE</H2>
The following example shows how
<B>get_nprocs</B>()
and
<B>get_nprocs_conf</B>()
can be used.
<P>
#include &lt;<A HREF="file:///usr/include/stdlib.h">stdlib.h</A>&gt;
#include &lt;<A HREF="file:///usr/include/stdio.h">stdio.h</A>&gt;
#include &lt;<A HREF="file:///usr/include/sys/sysinfo.h">sys/sysinfo.h</A>&gt;
<P>
int
main(int argc, char *argv[])
{
<BR>&nbsp;&nbsp;&nbsp;&nbsp;printf(&quot;This&nbsp;system&nbsp;has&nbsp;%d&nbsp;processors&nbsp;configured&nbsp;and&nbsp;&quot;
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&quot;%d&nbsp;processors&nbsp;available.\n&quot;,
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;get_nprocs_conf(),&nbsp;get_nprocs());
<BR>&nbsp;&nbsp;&nbsp;&nbsp;exit(EXIT_SUCCESS);
}
<A NAME="lbAJ">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?1+nproc">nproc</A></B>(1)
<A NAME="lbAK">&nbsp;</A>
<H2>COLOPHON</H2>
This page is part of release 5.05 of the Linux
<I>man-pages</I>
project.
A description of the project,
information about reporting bugs,
and the latest version of this page,
can be found at
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
<DT id="2"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="3"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="4"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT id="5"><A HREF="#lbAF">ATTRIBUTES</A><DD>
<DT id="6"><A HREF="#lbAG">CONFORMING TO</A><DD>
<DT id="7"><A HREF="#lbAH">NOTES</A><DD>
<DT id="8"><A HREF="#lbAI">EXAMPLE</A><DD>
<DT id="9"><A HREF="#lbAJ">SEE ALSO</A><DD>
<DT id="10"><A HREF="#lbAK">COLOPHON</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:44 GMT, March 31, 2021
</BODY>
</HTML>