share/man/man3/pthread_key_create.3

   1 .\" Copyright (c) 1996 John Birrell <jb@cimlogic.com.au>.
   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 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by John Birrell.
  15 .\" 4. Neither the name of the author nor the names of any co-contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .Dd April 4, 1996
  32 .Dt PTHREAD_KEY_CREATE 3
  33 .Os BSD 4
  34 .Sh NAME
  35 .Nm pthread_key_create
  36 .Nd thread-specific data key creation
  37 .Sh SYNOPSIS
  38 .Fd #include <pthread.h>
  39 .Ft int
  40 .Fn pthread_key_create "pthread_key_t *key" "void (*destructor)(void *)"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn pthread_key_create
  44 function creates a thread-specific data key visible to all threads in the
  45 process. Key values provided by
  46 .Fn pthread_key_create
  47 are opaque objects used to locate thread-specific data. Although the same
  48 key value may be used by different threads, the values bound to the key
  49 by
  50 .Fn pthread_setspecific
  51 are maintained on a per-thread basis and persist for the life of the calling
  52 thread.
  53 .Pp
  54 Upon key creation, the value NULL is associated with the new key in all
  55 active threads. Upon thread creation, the value NULL is associated with all
  56 defined keys in the new thread.
  57 .Pp
  58 An optional destructor function may be associated with each key value. At
  59 thread exit, if a key value has a non-NULL destructor pointer, and the
  60 thread has a non-NULL value associated with the key, the function pointed
  61 to is called with the current associated value as its sole argument. The
  62 order of destructor calls is unspecified if more than one destructor exists
  63 for a thread when it exits.
  64 .Pp
  65 If, after all the destructors have been called for all non-NULL values
  66 with associated destructors, there are still some non-NULL values with
  67 associated destructors, then the process is repeated. If, after at least
  68 [PTHREAD_DESTRUCTOR_ITERATIONS] iterations of destructor calls for
  69 outstanding non-NULL values, there are still some non-NULL values with
  70 associated destructors, the implementation stops calling destructors.
  71 .Sh RETURN VALUES
  72 If successful, the
  73 .Fn pthread_key_create
  74 function will store the newly created key value at the location specified by
  75 .Fa key
  76 and returns zero. Otherwise an error number will be returned to indicate
  77 the error.
  78 .Sh ERRORS
  79 .Fn pthread_key_create
  80 will fail if:
  81 .Bl -tag -width Er
  82 .It Bq Er EAGAIN
  83 The system lacked the necessary resources to create another thread-specific
  84 data key, or the system-imposed limit on the total number of keys per process
  85 [PTHREAD_KEYS_MAX] would be exceeded.
  86 .It Bq Er ENOMEM
  87 Insufficient memory exists to create the key.
  88 .El
  89 .Pp
  90 .Sh SEE ALSO
  91 .Xr pthread_getspecific 3 ,
  92 .Xr pthread_key_delete 3 ,
  93 .Xr pthread_setspecific 3
  94 .Sh STANDARDS
  95 .Fn pthread_key_create
  96 conforms to ISO/IEC 9945-1 ANSI/IEEE
  97 .Pq Dq Tn POSIX
  98 Std 1003.1 Second Edition 1996-07-12.