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

196 lines
5.2 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of PTHREAD_ATTR_SETSTACKADDR</TITLE>
</HEAD><BODY>
<H1>PTHREAD_ATTR_SETSTACKADDR</H1>
Section: Linux Programmer's Manual (3)<BR>Updated: 2017-09-15<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>
pthread_attr_setstackaddr, pthread_attr_getstackaddr -
set/get stack address attribute in thread attributes object
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
<B>#include &lt;<A HREF="file:///usr/include/pthread.h">pthread.h</A>&gt;</B>
<B>int pthread_attr_setstackaddr(pthread_attr_t *</B><I>attr</I><B>, void *</B><I>stackaddr</I><B>);</B>
<B>int pthread_attr_getstackaddr(const pthread_attr_t *</B><I>attr</I><B>, void **</B><I>stackaddr</I><B>);</B>
Compile and link with <I>-pthread</I>.
</PRE>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
These functions are obsolete:
<B>do not use them.</B>
Use
<B><A HREF="/cgi-bin/man/man2html?3+pthread_attr_setstack">pthread_attr_setstack</A></B>(3)
and
<B><A HREF="/cgi-bin/man/man2html?3+pthread_attr_getstack">pthread_attr_getstack</A></B>(3)
instead.
<P>
The
<B>pthread_attr_setstackaddr</B>()
function sets the stack address attribute of the
thread attributes object referred to by
<I>attr</I>
to the value specified in
<I>stackaddr</I>.
This attribute specifies the location of the stack that should
be used by a thread that is created using the thread attributes object
<I>attr</I>.
<P>
<I>stackaddr</I>
should point to a buffer of at least
<B>PTHREAD_STACK_MIN</B>
bytes that was allocated by the caller.
The pages of the allocated buffer should be both readable and writable.
<P>
The
<B>pthread_attr_getstackaddr</B>()
function returns the stack address attribute of the
thread attributes object referred to by
<I>attr</I>
in the buffer pointed to by
<I>stackaddr</I>.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
On success, these functions return 0;
on error, they return a nonzero error number.
<A NAME="lbAF">&nbsp;</A>
<H2>ERRORS</H2>
No errors are defined
(but applications should nevertheless
handle a possible error return).
<A NAME="lbAG">&nbsp;</A>
<H2>VERSIONS</H2>
These functions are provided by glibc since version 2.1.
<A NAME="lbAH">&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>pthread_attr_setstackaddr</B>(),
<B>pthread_attr_getstackaddr</B>()
</TD><TD>Thread safety</TD><TD>MT-Safe<BR></TD></TR>
</TABLE>
<A NAME="lbAI">&nbsp;</A>
<H2>CONFORMING TO</H2>
POSIX.1-2001 specifies these functions but marks them as obsolete.
POSIX.1-2008 removes the specification of these functions.
<A NAME="lbAJ">&nbsp;</A>
<H2>NOTES</H2>
<I>Do not use these functions!</I>
They cannot be portably used, since they provide no way of specifying
the direction of growth or the range of the stack.
For example, on architectures with a stack that grows downward,
<I>stackaddr</I>
specifies the next address past the
<I>highest</I>
address of the allocated stack area.
However, on architectures with a stack that grows upward,
<I>stackaddr</I>
specifies the
<I>lowest</I>
address in the allocated stack area.
By contrast, the
<I>stackaddr</I>
used by
<B><A HREF="/cgi-bin/man/man2html?3+pthread_attr_setstack">pthread_attr_setstack</A></B>(3)
and
<B><A HREF="/cgi-bin/man/man2html?3+pthread_attr_getstack">pthread_attr_getstack</A></B>(3),
is always a pointer to the lowest address in the allocated stack area
(and the
<I>stacksize</I>
argument specifies the range of the stack).
<A NAME="lbAK">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?3+pthread_attr_init">pthread_attr_init</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+pthread_attr_setstack">pthread_attr_setstack</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+pthread_attr_setstacksize">pthread_attr_setstacksize</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+pthread_create">pthread_create</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?7+pthreads">pthreads</A></B>(7)
<A NAME="lbAL">&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">ERRORS</A><DD>
<DT id="6"><A HREF="#lbAG">VERSIONS</A><DD>
<DT id="7"><A HREF="#lbAH">ATTRIBUTES</A><DD>
<DT id="8"><A HREF="#lbAI">CONFORMING TO</A><DD>
<DT id="9"><A HREF="#lbAJ">NOTES</A><DD>
<DT id="10"><A HREF="#lbAK">SEE ALSO</A><DD>
<DT id="11"><A HREF="#lbAL">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:53 GMT, March 31, 2021
</BODY>
</HTML>