man3/sem_destroy.3

   1 .\" Copyright (C) 2006 Michael Kerrisk <mtk.manpages@gmail.com>
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .TH SEM_DESTROY 3 2021-03-22 "Linux" "Linux Programmer's Manual"
  26 .SH NAME
  27 sem_destroy \- destroy an unnamed semaphore
  28 .SH SYNOPSIS
  29 .nf
  30 .B #include <semaphore.h>
  31 .PP
  32 .BI "int sem_destroy(sem_t *" sem );
  33 .fi
  34 .PP
  35 Link with \fI\-pthread\fP.
  36 .SH DESCRIPTION
  37 .BR sem_destroy ()
  38 destroys the unnamed semaphore at the address pointed to by
  39 .IR sem .
  40 .PP
  41 Only a semaphore that has been initialized by
  42 .BR sem_init (3)
  43 should be destroyed using
  44 .BR sem_destroy ().
  45 .PP
  46 Destroying a semaphore that other processes or threads are
  47 currently blocked on (in
  48 .BR sem_wait (3))
  49 produces undefined behavior.
  50 .PP
  51 Using a semaphore that has been destroyed produces undefined results,
  52 until the semaphore has been reinitialized using
  53 .BR sem_init (3).
  54 .SH RETURN VALUE
  55 .BR sem_destroy ()
  56 returns 0 on success;
  57 on error, \-1 is returned, and
  58 .I errno
  59 is set to indicate the error.
  60 .SH ERRORS
  61 .TP
  62 .B EINVAL
  63 .I sem
  64 is not a valid semaphore.
  65 .SH ATTRIBUTES
  66 For an explanation of the terms used in this section, see
  67 .BR attributes (7).
  68 .ad l
  69 .nh
  70 .TS
  71 allbox;
  72 lbx lb lb
  73 l l l.
  74 Interface       Attribute       Value
  75 T{
  76 .BR sem_destroy ()
  77 T}      Thread safety   MT-Safe
  78 .TE
  79 .hy
  80 .ad
  81 .sp 1
  82 .SH CONFORMING TO
  83 POSIX.1-2001, POSIX.1-2008.
  84 .SH NOTES
  85 An unnamed semaphore should be destroyed with
  86 .BR sem_destroy ()
  87 before the memory in which it is located is deallocated.
  88 Failure to do this can result in resource leaks on some implementations.
  89 .\" But not on NPTL, where sem_destroy () is a no-op..
  90 .SH SEE ALSO
  91 .BR sem_init (3),
  92 .BR sem_post (3),
  93 .BR sem_wait (3),
  94 .BR sem_overview (7)