lib/libpthread/pthread_once.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 .\" $FreeBSD: src/share/man/man3/pthread_once.3,v 1.21 2007/10/22 10:08:00 ru Exp $
  32 .\" $DragonFly: src/lib/libc_r/man/pthread_once.3,v 1.4 2008/02/09 09:32:05 swildner Exp $
  33 .\"
  34 .Dd July 10, 2009
  35 .Dt PTHREAD_ONCE 3
  36 .Os
  37 .Sh NAME
  38 .Nm pthread_once
  39 .Nd dynamic package initialization
  40 .Sh LIBRARY
  41 .Lb libpthread
  42 .Sh SYNOPSIS
  43 .In pthread.h
  44 .Pp
  45 pthread_once_t
  46 .Fa once_control
  47 = PTHREAD_ONCE_INIT;
  48 .Ft int
  49 .Fn pthread_once "pthread_once_t *once_control" "void (*init_routine)(void)"
  50 .Sh DESCRIPTION
  51 The first call to
  52 .Fn pthread_once
  53 by any thread in a process, with a given
  54 .Fa once_control ,
  55 will call the
  56 .Fn init_routine
  57 with no arguments.
  58 Subsequent calls to
  59 .Fn pthread_once
  60 with the same
  61 .Fa once_control
  62 will not call the
  63 .Fn init_routine .
  64 On return from
  65 .Fn pthread_once ,
  66 it is guaranteed that
  67 .Fn init_routine
  68 has completed.
  69 The
  70 .Fa once_control
  71 parameter is used to determine whether the associated initialization
  72 routine has been called.
  73 .Pp
  74 The function
  75 .Fn pthread_once
  76 is not a cancellation point.
  77 However, if
  78 .Fn init_routine
  79 is a cancellation point and is cancelled, the effect on
  80 .Fa once_control
  81 is as if
  82 .Fn pthread_once
  83 was never called.
  84 .Pp
  85 The constant
  86 .Fa PTHREAD_ONCE_INIT
  87 is defined by header
  88 .In pthread.h .
  89 .Pp
  90 The behavior of
  91 .Fn pthread_once
  92 is undefined if
  93 .Fa once_control
  94 has automatic storage duration or is not initialized by
  95 .Fa PTHREAD_ONCE_INIT .
  96 .Sh RETURN VALUES
  97 If successful, the
  98 .Fn pthread_once
  99 function will return zero.
 100 Otherwise an error number will be returned to
 101 indicate the error.
 102 .Sh ERRORS
 103 None.
 104 .Sh STANDARDS
 105 The
 106 .Fn pthread_once
 107 function conforms to
 108 .St -p1003.1-96 .