logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

sys_shm.h.0p (3340B)

    

  1. '\" et
  2. .TH sys_shm.h "0P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. sys/shm.h
  12. \(em XSI shared memory facility
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <sys/shm.h>
  17. .fi
  18. .SH DESCRIPTION
  19. The
  20. .IR <sys/shm.h> 
  21. header shall define the following symbolic constants:
  22. .IP SHM_RDONLY 12
  23. Attach read-only (else read-write).
  24. .IP SHM_RND 12
  25. Round attach address to SHMLBA.
  26. .IP SHMLBA 12
  27. Segment low boundary address multiple.
  28. .P
  29. The
  30. .IR <sys/shm.h> 
  31. header shall define the following data types through
  32. .BR typedef :
  33. .IP "\fBshmatt_t\fP" 12
  34. Unsigned integer used for the number of current attaches that must be
  35. able to store values at least as large as a type
  36. .BR "unsigned short" .
  37. .P
  38. The
  39. .IR <sys/shm.h> 
  40. header shall define the
  41. .BR shmid_ds
  42. structure, which shall include the following members:
  43. .sp
  44. .RS 4
  45. .nf
  47. struct ipc_perm shm_perm   \fROperation permission structure.\fR
  48. size_t          shm_segsz  \fRSize of segment in bytes.\fR
  49. pid_t           shm_lpid   \fRProcess ID of last shared memory operation.\fR
  50. pid_t           shm_cpid   \fRProcess ID of creator.\fR
  51. shmatt_t        shm_nattch \fRNumber of current attaches.\fR
  52. time_t          shm_atime  \fRTime of last \fIshmat\fP\^(\|).\fR
  53. time_t          shm_dtime  \fRTime of last \fIshmdt\fP\^(\|).\fR
  54. time_t          shm_ctime  \fRTime of last change by \fIshmctl\fP\^(\|).\fR
  55. .fi
  56. .P
  57. .RE
  58. .P
  59. The
  60. .IR <sys/shm.h> 
  61. header shall define the
  62. .BR pid_t ,
  63. .BR size_t ,
  64. and
  65. .BR time_t
  66. types as described in
  67. .IR <sys/types.h> .
  68. .P
  69. The following shall be declared as functions and may also be defined
  70. as macros. Function prototypes shall be provided.
  71. .sp
  72. .RS 4
  73. .nf
  75. void *shmat(int, const void *, int);
  76. int   shmctl(int, int, struct shmid_ds *);
  77. int   shmdt(const void *);
  78. int   shmget(key_t, size_t, int);
  79. .fi
  80. .P
  81. .RE
  82. .P
  83. In addition, the
  84. .IR <sys/shm.h> 
  85. header shall include the
  86. .IR <sys/ipc.h> 
  87. header.
  88. .LP
  89. .IR "The following sections are informative."
  90. .SH "APPLICATION USAGE"
  91. None.
  92. .SH RATIONALE
  93. None.
  94. .SH "FUTURE DIRECTIONS"
  95. None.
  96. .SH "SEE ALSO"
  97. .IR "\fB<sys_ipc.h>\fP",
  98. .IR "\fB<sys_types.h>\fP"
  99. .P
  100. The System Interfaces volume of POSIX.1\(hy2017,
  101. .IR "\fIshmat\fR\^(\|)",
  102. .IR "\fIshmctl\fR\^(\|)",
  103. .IR "\fIshmdt\fR\^(\|)",
  104. .IR "\fIshmget\fR\^(\|)"
  105. .\"
  106. .SH COPYRIGHT
  107. Portions of this text are reprinted and reproduced in electronic form
  108. from IEEE Std 1003.1-2017, Standard for Information Technology
  109. -- Portable Operating System Interface (POSIX), The Open Group Base
  110. Specifications Issue 7, 2018 Edition,
  111. Copyright (C) 2018 by the Institute of
  112. Electrical and Electronics Engineers, Inc and The Open Group.
  113. In the event of any discrepancy between this version and the original IEEE and
  114. The Open Group Standard, the original IEEE and The Open Group Standard
  115. is the referee document. The original Standard can be obtained online at
  116. http://www.opengroup.org/unix/online.html .
  117. .PP
  118. Any typographical or formatting errors that appear
  119. in this page are most likely
  120. to have been introduced during the conversion of the source files to
  121. man page format. To report such errors, see
  122. https://www.kernel.org/doc/man-pages/reporting_bugs.html .