1 /*
2 * CDDL HEADER START
3 *
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License, Version 1.0 only
6 * (the "License"). You may not use this file except in compliance
7 * with the License.
8 *
9 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10 * or http://www.opensolaris.org/os/licensing.
11 * See the License for the specific language governing permissions
12 * and limitations under the License.
13 *
14 * When distributing Covered Code, include this CDDL HEADER in each
15 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16 * If applicable, add the following below this CDDL HEADER, with the
17 * fields enclosed by brackets "[]" replaced with your own identifying
18 * information: Portions Copyright [yyyy] [name of copyright owner]
19 *
20 * CDDL HEADER END
21 */
22 /*
23 * Copyright 2014 Garrett D'Amore <garrett@damore.org>
24 * Copyright 2016 Joyent, Inc.
25 *
26 * Copyright 2003 Sun Microsystems, Inc. All rights reserved.
27 * Use is subject to license terms.
28 */
29
30 /* Copyright (c) 1983, 1984, 1985, 1986, 1987, 1988, 1989 AT&T */
31 /* All Rights Reserved */
32
33 /*
34 * Portions of this source code were derived from Berkeley 4.3 BSD
35 * under license from the Regents of the University of California.
36 */
37
38 #ifndef _SYS_SHM_H
39 #define _SYS_SHM_H
40
41 #include <sys/ipc.h>
42
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46
47 /*
48 * IPC Shared Memory Facility.
49 */
50
51 /*
52 * Implementation Constants.
53 */
54 #if (defined(_KERNEL) || defined(_KMEMUSER))
55
56 #define SHMLBA PAGESIZE /* segment low boundary address multiple */
57 /* (SHMLBA must be a power of 2) */
58 #else
59 #include <sys/unistd.h> /* needed for _SC_PAGESIZE */
60 extern long _sysconf(int); /* System Private interface to sysconf() */
61 #define SHMLBA (_sysconf(_SC_PAGESIZE))
62 #endif /* defined(_KERNEL) || defined(_KMEMUSER)) */
63
64 /*
65 * Permission Definitions.
66 */
67 #define SHM_R 0400 /* read permission */
68 #define SHM_W 0200 /* write permission */
69
70 /*
71 * Message Operation Flags.
72 */
73 #define SHM_RDONLY 010000 /* attach read-only (else read-write) */
74 #define SHM_RND 020000 /* round attach address to SHMLBA */
75 #define SHM_SHARE_MMU 040000 /* share VM resources such as page table */
76 #define SHM_PAGEABLE 0100000 /* pageable ISM */
77
78 /*
79 * Valid flags bits for shmat shmflag argument.
80 */
81 #define SHMAT_VALID_FLAGS_MASK \
82 (SHM_R | SHM_W | SHM_RDONLY | SHM_RND | SHM_SHARE_MMU | SHM_PAGEABLE)
83
84 typedef unsigned long shmatt_t;
85
86 /*
87 * Structure Definitions.
88 */
89 struct shmid_ds {
90 struct ipc_perm shm_perm; /* operation permission struct */
91 size_t shm_segsz; /* size of segment in bytes */
92 #if defined(_LP64) || defined(_XOPEN_SOURCE)
93 void *shm_amp;
94 #else
95 struct anon_map *shm_amp; /* segment anon_map pointer */
96 #endif
97 ushort_t shm_lkcnt; /* number of times it is being locked */
98 pid_t shm_lpid; /* pid of last shmop */
99 pid_t shm_cpid; /* pid of creator */
100 shmatt_t shm_nattch; /* number of attaches */
101 ulong_t shm_cnattch; /* number of ISM attaches */
102 #if defined(_LP64)
103 time_t shm_atime; /* last shmat time */
104 time_t shm_dtime; /* last shmdt time */
105 time_t shm_ctime; /* last change time */
106 int64_t shm_pad4[4]; /* reserve area */
107 #else /* _LP64 */
108 time_t shm_atime; /* last shmat time */
109 int32_t shm_pad1; /* reserved for time_t expansion */
110 time_t shm_dtime; /* last shmdt time */
111 int32_t shm_pad2; /* reserved for time_t expansion */
112 time_t shm_ctime; /* last change time */
113 int32_t shm_pad3; /* reserved for time_t expansion */
114 int32_t shm_pad4[4]; /* reserve area */
115 #endif /* _LP64 */
116 };
117
118 /*
119 * Shared memory control operations
120 */
121 #define SHM_LOCK 3 /* Lock segment in core */
122 #define SHM_UNLOCK 4 /* Unlock segment */
123
124 #if defined(_KERNEL)
125 #define SHM_RMID 5 /* Private RMID for lx support */
126 #endif
127
128 #if !defined(_KERNEL)
129 int shmget(key_t, size_t, int);
130 int shmids(int *, uint_t, uint_t *);
131 int shmctl(int, int, struct shmid_ds *);
132 void *shmat(int, const void *, int);
133 #if defined(_XPG4)
134 int shmdt(const void *);
135 #else
136 int shmdt(char *);
137 #endif /* defined(_XPG4) */
138 #endif /* !defined(_KERNEL) */
139
140 #ifdef __cplusplus
141 }
142 #endif
143
144 #endif /* _SYS_SHM_H */