diff options
Diffstat (limited to 'upstream/archlinux/man3p/sem_init.3p')
-rw-r--r-- | upstream/archlinux/man3p/sem_init.3p | 137 |
1 files changed, 137 insertions, 0 deletions
diff --git a/upstream/archlinux/man3p/sem_init.3p b/upstream/archlinux/man3p/sem_init.3p new file mode 100644 index 00000000..75a08299 --- /dev/null +++ b/upstream/archlinux/man3p/sem_init.3p @@ -0,0 +1,137 @@ +'\" et +.TH SEM_INIT "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual" +.\" +.SH PROLOG +This manual page is part of the POSIX Programmer's Manual. +The Linux implementation of this interface may differ (consult +the corresponding Linux manual page for details of Linux behavior), +or the interface may not be implemented on Linux. +.\" +.SH NAME +sem_init +\(em initialize an unnamed semaphore +.SH SYNOPSIS +.LP +.nf +#include <semaphore.h> +.P +int sem_init(sem_t *\fIsem\fP, int \fIpshared\fP, unsigned \fIvalue\fP); +.fi +.SH DESCRIPTION +The +\fIsem_init\fR() +function shall initialize the unnamed semaphore referred to by +.IR sem . +The value of the initialized semaphore shall be +.IR value . +Following a successful call to +\fIsem_init\fR(), +the semaphore may be used in subsequent calls to +\fIsem_wait\fR(), +\fIsem_timedwait\fR(), +\fIsem_trywait\fR(), +\fIsem_post\fR(), +and +\fIsem_destroy\fR(). +This semaphore shall remain usable until the semaphore is destroyed. +.P +If the +.IR pshared +argument has a non-zero value, then the semaphore is shared between +processes; in this case, any process that can access the semaphore +.IR sem +can use +.IR sem +for performing +\fIsem_wait\fR(), +\fIsem_timedwait\fR(), +\fIsem_trywait\fR(), +\fIsem_post\fR(), +and +\fIsem_destroy\fR() +operations. +.P +If the +.IR pshared +argument is zero, then the semaphore is shared between threads of the +process; any thread in this process can use +.IR sem +for performing +\fIsem_wait\fR(), +\fIsem_timedwait\fR(), +\fIsem_trywait\fR(), +\fIsem_post\fR(), +and +\fIsem_destroy\fR() +operations. +.P +See +.IR "Section 2.9.9" ", " "Synchronization Object Copies and Alternative Mappings" +for further requirements. +.P +Attempting to initialize an already initialized semaphore results in +undefined behavior. +.SH "RETURN VALUE" +Upon successful completion, the +\fIsem_init\fR() +function shall initialize the semaphore in +.IR sem +and return 0. Otherwise, it shall return \-1 and set +.IR errno +to indicate the error. +.SH ERRORS +The +\fIsem_init\fR() +function shall fail if: +.TP +.BR EINVAL +The +.IR value +argument exceeds +{SEM_VALUE_MAX}. +.TP +.BR ENOSPC +A resource required to initialize the semaphore has been exhausted, or +the limit on semaphores (\c +{SEM_NSEMS_MAX}) +has been reached. +.TP +.BR EPERM +The process lacks appropriate privileges to initialize the +semaphore. +.LP +.IR "The following sections are informative." +.SH EXAMPLES +None. +.SH "APPLICATION USAGE" +None. +.SH RATIONALE +None. +.SH "FUTURE DIRECTIONS" +None. +.SH "SEE ALSO" +.IR "\fIsem_destroy\fR\^(\|)", +.IR "\fIsem_post\fR\^(\|)", +.IR "\fIsem_timedwait\fR\^(\|)", +.IR "\fIsem_trywait\fR\^(\|)" +.P +The Base Definitions volume of POSIX.1\(hy2017, +.IR "\fB<semaphore.h>\fP" +.\" +.SH COPYRIGHT +Portions of this text are reprinted and reproduced in electronic form +from IEEE Std 1003.1-2017, Standard for Information Technology +-- Portable Operating System Interface (POSIX), The Open Group Base +Specifications Issue 7, 2018 Edition, +Copyright (C) 2018 by the Institute of +Electrical and Electronics Engineers, Inc and The Open Group. +In the event of any discrepancy between this version and the original IEEE and +The Open Group Standard, the original IEEE and The Open Group Standard +is the referee document. The original Standard can be obtained online at +http://www.opengroup.org/unix/online.html . +.PP +Any typographical or formatting errors that appear +in this page are most likely +to have been introduced during the conversion of the source files to +man page format. To report such errors, see +https://www.kernel.org/doc/man-pages/reporting_bugs.html . |