lib/libpthread/pthread_attr_get_np.3

   1 .\" Copyright (c) 2002,2003 Alexey Zelkin <phantom@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/share/man/man3/pthread_attr_get_np.3,v 1.14 2007/10/22 10:08:00 ru Exp $
  26 .\" $DragonFly: src/lib/libc_r/man/pthread_attr_get_np.3,v 1.3 2006/02/17 19:35:07 swildner Exp $
  27 .\"
  28 .Dd July 10, 2009
  29 .Dt PTHREAD_ATTR_GET_NP 3
  30 .Os
  31 .Sh NAME
  32 .Nm pthread_attr_get_np
  33 .Nd get attributes of existent thread
  34 .Sh LIBRARY
  35 .Lb libpthread
  36 .Sh SYNOPSIS
  37 .In pthread.h
  38 .In pthread_np.h
  39 .Ft int
  40 .Fn pthread_attr_get_np "pthread_t pid" "pthread_attr_t *dst"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn pthread_attr_get_np
  44 function is used to get existent thread's attributes.
  45 Most fields of
  46 .Vt pthread_attr_t
  47 structure are exact values of attributes provided at thread creation
  48 time (as parameter to
  49 .Xr pthread_create 3
  50 function), except for the stack address.
  51 .Pp
  52 Value returned as
  53 .Fa dst
  54 is supposed to be used in conjunction with
  55 .Fn pthread_attr_get*
  56 functions to retrieve individual values from
  57 .Vt pthread_attr_t
  58 structure.
  59 Parameter
  60 .Fa dst
  61 should point to allocated memory area big enough to fit this structure.
  62 .Pp
  63 It is HIGHLY RECOMMENDED to use
  64 .Xr pthread_attr_init 3
  65 function to allocate attribute storage.
  66 .Sh IMPLEMENTATION NOTES
  67 The
  68 .Fn pthread_attr_get_np
  69 function will always return a pointer to the thread's real stack address,
  70 regardless of its value in the original attributes structure.
  71 .Sh RETURN VALUES
  72 If successful,
  73 .Fn pthread_attr_get_np
  74 function returns 0.
  75 Otherwise, an error number is returned to indicate the error.
  76 .Sh EXAMPLES
  77 .Bd -literal
  78 size_t
  79 my_thread_stack_size(pthread_t pid)
  80 {
  81     pthread_attr_t attr;
  82     size_t size;
  83
  84     pthread_attr_init(&attr);
  85     pthread_attr_get_np(pid, &attr);
  86     pthread_attr_getstacksize(&attr, &size);
  87     pthread_attr_destroy(&attr);
  88     return(size);
  89 }
  90 .Ed
  91 .Sh ERRORS
  92 The
  93 .Fn pthread_attr_get_np
  94 function will fail if:
  95 .Bl -tag -width Er
  96 .It Bq Er EINVAL
  97 Invalid value for one of given parameters.
  98 .It Bq Er ESRC
  99 No thread could be found corresponding to that specified by the given
 100 thread ID.
 101 .El
 102 .Sh SEE ALSO
 103 .Xr pthread_attr_destroy 3 ,
 104 .Xr pthread_attr_getdetachstate 3 ,
 105 .Xr pthread_attr_getinheritsched 3 ,
 106 .Xr pthread_attr_getschedparam 3 ,
 107 .Xr pthread_attr_getschedpolicy 3 ,
 108 .Xr pthread_attr_getscope 3 ,
 109 .Xr pthread_attr_getstack 3 ,
 110 .Xr pthread_attr_getstackaddr 3 ,
 111 .Xr pthread_attr_getstacksize 3 ,
 112 .Xr pthread_attr_init 3
 113 .Sh AUTHORS
 114 The
 115 .Fn pthread_attr_get_np
 116 function and this manual page were written by
 117 .An Alexey Zelkin
 118 .Aq phantom@FreeBSD.org .