man3/pthread_attr_setstackaddr.3

   1 .\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
   2 .\"     <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .TH PTHREAD_ATTR_SETSTACKADDR 3 2021-03-22 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 pthread_attr_setstackaddr, pthread_attr_getstackaddr \-
  29 set/get stack address attribute in thread attributes object
  30 .SH SYNOPSIS
  31 .nf
  32 .B #include <pthread.h>
  33 .PP
  34 .BI "int pthread_attr_setstackaddr(pthread_attr_t *" attr \
  35 ", void *" stackaddr );
  36 .BI "int pthread_attr_getstackaddr(const pthread_attr_t *restrict " attr ,
  37 .BI "                              void **restrict " stackaddr );
  38 .PP
  39 Compile and link with \fI\-pthread\fP.
  40 .fi
  41 .SH DESCRIPTION
  42 These functions are obsolete:
  43 .B do not use them.
  44 Use
  45 .BR pthread_attr_setstack (3)
  46 and
  47 .BR pthread_attr_getstack (3)
  48 instead.
  49 .PP
  50 The
  51 .BR pthread_attr_setstackaddr ()
  52 function sets the stack address attribute of the
  53 thread attributes object referred to by
  54 .I attr
  55 to the value specified in
  56 .IR stackaddr .
  57 This attribute specifies the location of the stack that should
  58 be used by a thread that is created using the thread attributes object
  59 .IR attr .
  60 .PP
  61 .I stackaddr
  62 should point to a buffer of at least
  63 .B PTHREAD_STACK_MIN
  64 bytes that was allocated by the caller.
  65 The pages of the allocated buffer should be both readable and writable.
  66 .PP
  67 The
  68 .BR pthread_attr_getstackaddr ()
  69 function returns the stack address attribute of the
  70 thread attributes object referred to by
  71 .I attr
  72 in the buffer pointed to by
  73 .IR stackaddr .
  74 .SH RETURN VALUE
  75 On success, these functions return 0;
  76 on error, they return a nonzero error number.
  77 .SH ERRORS
  78 No errors are defined
  79 (but applications should nevertheless
  80 handle a possible error return).
  81 .SH VERSIONS
  82 These functions are provided by glibc since version 2.1.
  83 .SH ATTRIBUTES
  84 For an explanation of the terms used in this section, see
  85 .BR attributes (7).
  86 .ad l
  87 .nh
  88 .TS
  89 allbox;
  90 lbx lb lb
  91 l l l.
  92 Interface       Attribute       Value
  93 T{
  94 .BR pthread_attr_setstackaddr (),
  95 .BR pthread_attr_getstackaddr ()
  96 T}      Thread safety   MT-Safe
  97 .TE
  98 .hy
  99 .ad
 100 .sp 1
 101 .SH CONFORMING TO
 102 POSIX.1-2001 specifies these functions but marks them as obsolete.
 103 POSIX.1-2008 removes the specification of these functions.
 104 .SH NOTES
 105 .I Do not use these functions!
 106 They cannot be portably used, since they provide no way of specifying
 107 the direction of growth or the range of the stack.
 108 For example, on architectures with a stack that grows downward,
 109 .I stackaddr
 110 specifies the next address past the
 111 .I highest
 112 address of the allocated stack area.
 113 However, on architectures with a stack that grows upward,
 114 .I stackaddr
 115 specifies the
 116 .I lowest
 117 address in the allocated stack area.
 118 By contrast, the
 119 .I stackaddr
 120 used by
 121 .BR pthread_attr_setstack (3)
 122 and
 123 .BR pthread_attr_getstack (3),
 124 is always a pointer to the lowest address in the allocated stack area
 125 (and the
 126 .I stacksize
 127 argument specifies the range of the stack).
 128 .SH SEE ALSO
 129 .BR pthread_attr_init (3),
 130 .BR pthread_attr_setstack (3),
 131 .BR pthread_attr_setstacksize (3),
 132 .BR pthread_create (3),
 133 .BR pthreads (7)