2006-03-25 20:42:27 +00:00
|
|
|
'\" t
|
|
|
|
.\" Hey Emacs! This file is -*- nroff -*- source.
|
|
|
|
.\"
|
2007-09-20 06:52:22 +00:00
|
|
|
.\" Copyright (C) 2006 Michael Kerrisk <mtk.manpages@gmail.com>
|
2006-03-25 20:42:27 +00:00
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2006-03-25 20:42:27 +00:00
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
2008-03-18 14:47:54 +00:00
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2006-03-25 20:42:27 +00:00
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
2012-05-13 11:12:18 +00:00
|
|
|
.TH SEM_INIT 3 2012-05-13 "Linux" "Linux Programmer's Manual"
|
2006-03-25 20:42:27 +00:00
|
|
|
.SH NAME
|
2007-06-08 09:56:56 +00:00
|
|
|
sem_init \- initialize an unnamed semaphore
|
2006-03-25 20:42:27 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <semaphore.h>
|
|
|
|
.sp
|
|
|
|
.BI "int sem_init(sem_t *" sem ", int " pshared ", unsigned int " value );
|
|
|
|
.fi
|
2008-03-10 08:29:29 +00:00
|
|
|
.sp
|
2012-05-13 11:12:18 +00:00
|
|
|
Link with \fI\-pthread\fP.
|
2006-03-25 20:42:27 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
.BR sem_init ()
|
2007-06-08 09:56:56 +00:00
|
|
|
initializes the unnamed semaphore at the address pointed to by
|
2006-03-25 20:42:27 +00:00
|
|
|
.IR sem .
|
|
|
|
The
|
|
|
|
.I value
|
|
|
|
argument specifies the initial value for the semaphore.
|
|
|
|
|
2007-04-12 22:42:49 +00:00
|
|
|
The
|
2006-03-25 20:42:27 +00:00
|
|
|
.I pshared
|
|
|
|
argument indicates whether this semaphore is to be shared
|
|
|
|
between the threads of a process, or between processes.
|
|
|
|
|
|
|
|
If
|
|
|
|
.I pshared
|
2007-04-12 22:42:49 +00:00
|
|
|
has the value 0,
|
|
|
|
then the semaphore is shared between the threads of a process,
|
|
|
|
and should be located at some address that is visible to all threads
|
|
|
|
(e.g., a global variable, or a variable allocated dynamically on
|
2006-03-25 20:42:27 +00:00
|
|
|
the heap).
|
|
|
|
|
|
|
|
If
|
|
|
|
.I pshared
|
intro.1, time.1, adjtimex.2, capget.2, eventfd.2, fcntl.2, getrlimit.2, getsockopt.2, gettimeofday.2, intro.2, ioctl_list.2, ioperm.2, mlock.2, pivot_root.2, poll.2, prctl.2, ptrace.2, sched_setscheduler.2, select_tut.2, semget.2, sigaltstack.2, signalfd.2, sysctl.2, timer_settime.2, timerfd_create.2, wait.2, CPU_SET.3, argz_add.3, assert_perror.3, atexit.3, backtrace.3, bcmp.3, clearenv.3, ctime.3, dl_iterate_phdr.3, dlopen.3, ecvt.3, errno.3, error.3, ether_aton.3, exit.3, fenv.3, ferror.3, finite.3, flockfile.3, fnmatch.3, fpathconf.3, fpclassify.3, ftime.3, ftok.3, ftw.3, fwide.3, getaddrinfo.3, gethostbyname.3, getlogin.3, getnameinfo.3, getnetent.3, getopt.3, getprotoent.3, getrpcent.3, getservent.3, glob.3, hsearch.3, inet.3, isalpha.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, longjmp.3, lsearch.3, malloc.3, matherr.3, mblen.3, mbsinit.3, mbtowc.3, on_exit.3, printf.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_attr_setdetachstate.3, pthread_attr_setguardsize.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstack.3, pthread_attr_setstackaddr.3, pthread_attr_setstacksize.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_equal.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setschedparam.3, pthread_setschedprio.3, ptsname.3, putenv.3, putgrent.3, raise.3, rcmd.3, regex.3, rexec.3, rpc.3, rpmatch.3, rtnetlink.3, scandir.3, sem_init.3, setaliasent.3, setbuf.3, setenv.3, setjmp.3, signbit.3, stdio_ext.3, strtod.3, strtol.3, strtoul.3, system.3, termios.3, timeradd.3, tzset.3, ualarm.3, wctomb.3, xdr.3, st.4, tty_ioctl.4, core.5, elf.5, proc.5, bootparam.7, capabilities.7, icmp.7, ip.7, ipv6.7, math_error.7, mdoc.samples.7, mq_overview.7, pthreads.7, raw.7, regex.7, socket.7, tcp.7, tzselect.8: Global fix: s/non-zero/nonzero/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:40:55 +00:00
|
|
|
is nonzero, then the semaphore is shared between processes,
|
2006-03-25 20:42:27 +00:00
|
|
|
and should be located in a region of shared memory (see
|
|
|
|
.BR shm_open (3),
|
|
|
|
.BR mmap (2),
|
|
|
|
and
|
|
|
|
.BR shmget (2)).
|
|
|
|
(Since a child created by
|
|
|
|
.BR fork (2)
|
|
|
|
inherits its parent's memory mappings, it can also access the semaphore.)
|
2007-04-12 22:42:49 +00:00
|
|
|
Any process that can access the shared memory region
|
2006-03-25 20:42:27 +00:00
|
|
|
can operate on the semaphore using
|
|
|
|
.BR sem_post (3),
|
|
|
|
.BR sem_wait (3),
|
|
|
|
etc.
|
|
|
|
|
2007-06-08 09:56:56 +00:00
|
|
|
Initializing a semaphore that has already been initialized
|
|
|
|
results in undefined behavior.
|
2006-03-25 20:42:27 +00:00
|
|
|
.SH RETURN VALUE
|
|
|
|
.BR sem_init ()
|
2007-04-12 22:42:49 +00:00
|
|
|
returns 0 on success;
|
2006-03-25 20:42:27 +00:00
|
|
|
on error, \-1 is returned, and
|
2007-04-12 22:42:49 +00:00
|
|
|
.I errno
|
2006-03-25 20:42:27 +00:00
|
|
|
is set to indicate the error.
|
|
|
|
.SH ERRORS
|
|
|
|
.TP
|
|
|
|
.B EINVAL
|
|
|
|
.I value
|
|
|
|
exceeds
|
|
|
|
.BR SEM_VALUE_MAX .
|
|
|
|
.TP
|
|
|
|
.B ENOSYS
|
|
|
|
.I pshared
|
intro.1, time.1, adjtimex.2, capget.2, eventfd.2, fcntl.2, getrlimit.2, getsockopt.2, gettimeofday.2, intro.2, ioctl_list.2, ioperm.2, mlock.2, pivot_root.2, poll.2, prctl.2, ptrace.2, sched_setscheduler.2, select_tut.2, semget.2, sigaltstack.2, signalfd.2, sysctl.2, timer_settime.2, timerfd_create.2, wait.2, CPU_SET.3, argz_add.3, assert_perror.3, atexit.3, backtrace.3, bcmp.3, clearenv.3, ctime.3, dl_iterate_phdr.3, dlopen.3, ecvt.3, errno.3, error.3, ether_aton.3, exit.3, fenv.3, ferror.3, finite.3, flockfile.3, fnmatch.3, fpathconf.3, fpclassify.3, ftime.3, ftok.3, ftw.3, fwide.3, getaddrinfo.3, gethostbyname.3, getlogin.3, getnameinfo.3, getnetent.3, getopt.3, getprotoent.3, getrpcent.3, getservent.3, glob.3, hsearch.3, inet.3, isalpha.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, longjmp.3, lsearch.3, malloc.3, matherr.3, mblen.3, mbsinit.3, mbtowc.3, on_exit.3, printf.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_attr_setdetachstate.3, pthread_attr_setguardsize.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstack.3, pthread_attr_setstackaddr.3, pthread_attr_setstacksize.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_equal.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setschedparam.3, pthread_setschedprio.3, ptsname.3, putenv.3, putgrent.3, raise.3, rcmd.3, regex.3, rexec.3, rpc.3, rpmatch.3, rtnetlink.3, scandir.3, sem_init.3, setaliasent.3, setbuf.3, setenv.3, setjmp.3, signbit.3, stdio_ext.3, strtod.3, strtol.3, strtoul.3, system.3, termios.3, timeradd.3, tzset.3, ualarm.3, wctomb.3, xdr.3, st.4, tty_ioctl.4, core.5, elf.5, proc.5, bootparam.7, capabilities.7, icmp.7, ip.7, ipv6.7, math_error.7, mdoc.samples.7, mq_overview.7, pthreads.7, raw.7, regex.7, socket.7, tcp.7, tzselect.8: Global fix: s/non-zero/nonzero/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:40:55 +00:00
|
|
|
is nonzero,
|
2006-03-25 20:42:27 +00:00
|
|
|
but the system does not support process-shared semaphores (see
|
|
|
|
.BR sem_overview (7)).
|
|
|
|
.SH CONFORMING TO
|
|
|
|
POSIX.1-2001.
|
|
|
|
.SH NOTES
|
|
|
|
Bizarrely, POSIX.1-2001 does not specify the value that should
|
|
|
|
be returned by a successful call to
|
|
|
|
.BR sem_init ().
|
2008-08-21 06:48:50 +00:00
|
|
|
POSIX.1-2008 rectifies this, specifying the zero return on success.
|
2006-03-25 20:42:27 +00:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR sem_destroy (3),
|
|
|
|
.BR sem_post (3),
|
|
|
|
.BR sem_wait (3),
|
|
|
|
.BR sem_overview (7)
|