lib/libc_r/man/sem_init.3

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