SHMDT(3P)

πŸ’– SHMDT(3P) β€” POSIX Programmer's Manual πŸ’–

okay bestie, welcome to the shmdt page, straight out of the POSIX Programmer's Manual (that's the 3P right there in the name, iykyk). let's get into it 🫢


✨ PROLOG ✨

so like, real talk first: this manual page is part of the POSIX Programmer's Manual. the Linux implementation of this interface may differ β€” so if you're on Linux, go consult the corresponding Linux manual page for the deets on Linux behavior. and honestly? the interface may not even be implemented on Linux at all. vibe check accordingly πŸ’…


🌸 NAME 🌸

shmdt β€” XSI shared memory detach operation. that's it, that's the whole name, and she's iconic for it.


πŸŽ€ SYNOPSIS πŸŽ€

#include <sys/shm.h>

int shmdt(const void *shmaddr);

πŸ¦‹ DESCRIPTION πŸ¦‹

so the shmdt() function operates on XSI shared memory β€” and if you wanna be all official about it, that's the Base Definitions volume of POSIX.1‐2017, Section 3.346, Shared Memory Object. and here's a lil spicy caveat: it is unspecified whether this function interoperates with the realtime interprocess communication facilities defined in Section 2.8, Realtime. so like, don't count on it, bestie πŸ™ˆ

and what does she actually do? the shmdt() function detaches the shared memory segment located at the address specified by shmaddr from the address space of the calling process. bye-bye segment, you were so real πŸ’œ


πŸ”₯ RETURN VALUE πŸ”₯

upon successful completion, shmdt() shall decrement the value of shm_nattch in the data structure associated with the shared memory ID of the attached shared memory segment, and return 0. also, the shm_dtime timestamp shall be set to the current time, as described in Section 2.7.1, IPC General Description. cute little bookkeeping moment, love that for her ✨

otherwise? the shared memory segment shall not be detached, shmdt() shall return -1, and errno shall be set to indicate the error. sad girl hours 😭


πŸ’€ ERRORS πŸ’€

the shmdt() function shall fail if:

  • EINVAL β€” the value of shmaddr is not the data segment start address of a shared memory segment.
the following sections are informative. (translation: the important bits are done, everything after this is lore 🧚)

🌈 EXAMPLES 🌈

None.

yeah. nothing. empty. the void. moving on bestie 😭


πŸ’… APPLICATION USAGE πŸ’…

so the POSIX Realtime Extension defines alternative interfaces for interprocess communication. if you're an application developer who needs to use IPC, the move is to design your applications so that modules using the IPC routines described in Section 2.7, XSI Interprocess Communication can be easily modified to use the alternative interfaces. future-proofing, periodt πŸ‘‘


πŸ“ RATIONALE πŸ“

None.

she said no thoughts, head empty πŸ’–


⭐ FUTURE DIRECTIONS ⭐

None.

the future is, apparently, uneventful. slay.


πŸ‘‘ SEE ALSO πŸ‘‘

go read these too, bestie, they're all in the family:

  • Section 2.7, XSI Interprocess Communication
  • Section 2.8, Realtime
  • exec
  • exit()
  • fork()
  • shmat()
  • shmctl()
  • shmget()
  • shm_open()
  • shm_unlink()
  • The Base Definitions volume of POSIX.1‐2017, Section 3.346, Shared Memory Object
  • <sys_shm.h>

okay legal moment, but make it cute:

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 .

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 .


and that's the whole page, bestie!! this little masterpiece was brought to you by IEEE/The Open Group, 2017 β€” yes, SHMDT(3P) herself, 2017 edition, no cap. mwah πŸ’‹ detach safely out there 🫢✨

πŸ“¦ where this page comes from