lib/librt/sem_init.3

   1 .\" $NetBSD$
   2 .\"
   3 .\" Copyright (C) 2000 Jason Evans <jasone@FreeBSD.org>.
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice(s), this list of conditions and the following disclaimer as
  11 .\"    the first lines of this file unmodified other than the possible
  12 .\"    addition of one or more copyright notices.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice(s), this list of conditions and the following disclaimer in
  15 .\"    the documentation and/or other materials provided with the
  16 .\"    distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
  19 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
  22 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  25 .\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  26 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  27 .\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  28 .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd January 22, 2003
  31 .Dt SEM_INIT 3
  32 .Os
  33 .Sh NAME
  34 .Nm sem_init
  35 .Nd initialize an unnamed semaphore
  36 .Sh LIBRARY
  37 .Lb librt
  38 .Sh SYNOPSIS
  39 .In semaphore.h
  40 .Ft int
  41 .Fn sem_init "sem_t *sem" "int pshared" "unsigned int value"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn sem_init
  45 function initializes the unnamed semaphore pointed to by
  46 .Fa sem
  47 to have the value
  48 .Fa value .
  49 A non-zero value for
  50 .Fa pshared
  51 specifies a shared semaphore that can be used by multiple processes, which this
  52 implementation is not capable of.
  53 .Pp
  54 Following a successful call to
  55 .Fn sem_init ,
  56 .Fa sem
  57 can be used as an argument in subsequent calls to
  58 .Fa sem_wait ,
  59 .Fa sem_trywait ,
  60 .Fa sem_post ,
  61 and
  62 .Fa sem_destroy .
  63 .Fa sem
  64 is no longer valid after a successful call to
  65 .Fa sem_destroy .
  66 .Sh RETURN VALUES
  67 .Rv -std sem_init
  68 .Sh ERRORS
  69 .Fn sem_init
  70 will fail if:
  71 .Bl -tag -width Er
  72 .It Bq Er EINVAL
  73 .Fa value
  74 exceeds SEM_VALUE_MAX.
  75 .It Bq Er ENOSPC
  76 Memory allocation error.
  77 .It Bq Er EPERM
  78 Unable to initialize a shared semaphore.
  79 .El
  80 .Sh SEE ALSO
  81 .Xr sem_destroy 3 ,
  82 .Xr sem_post 3 ,
  83 .Xr sem_trywait 3 ,
  84 .Xr sem_wait 3
  85 .Sh STANDARDS
  86 .Fn sem_init
  87 conforms to
  88 .St -p1003.1-96 .
  89 .Pp
  90 This implementation does not support shared semaphores, and reports this fact
  91 by setting
  92 .Va errno
  93 to
  94 .Er EPERM .
  95 This is perhaps a stretch of the intention of POSIX, but is
  96 compliant, with the caveat that
  97 .Fn sem_init
  98 always reports a permissions error when an attempt to create a shared semaphore
  99 is made.