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 (the "License").
6 * You may not use this file except in compliance with the License.
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 */
21 /*
22 * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
24 * Copyright 2016 Joyent, Inc.
25 */
26
27 #ifndef _SYS_SHM_IMPL_H
28 #define _SYS_SHM_IMPL_H
29
30 #include <sys/ipc_impl.h>
31 #if defined(_KERNEL) || defined(_KMEMUSER)
32 #include <sys/shm.h>
33 #include <sys/avl.h>
34 #include <sys/t_lock.h>
35 #endif
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 /*
42 * shmsys system call subcodes
43 */
44 #define SHMAT 0
45 #define SHMCTL 1
46 #define SHMDT 2
47 #define SHMGET 3
48 #define SHMIDS 4
49
50 /*
51 * There is a shared mem id data structure (shmid_ds) for each
52 * segment in the system.
53 */
54 #if defined(_KERNEL) || defined(_KMEMUSER)
55 typedef struct kshmid {
56 kipc_perm_t shm_perm; /* operation permission struct */
57 size_t shm_segsz; /* size of segment in bytes */
58 struct anon_map *shm_amp; /* segment anon_map pointer */
59 ushort_t shm_lkcnt; /* number of times it is being locked */
60 pgcnt_t shm_lkpages; /* number of pages locked by shmctl */
61 kmutex_t shm_mlock; /* held when locking physical pages */
62 /* Therefore, protects p_lckcnt for */
63 /* pages that back shm */
64 pid_t shm_lpid; /* pid of last shmop */
65 pid_t shm_cpid; /* pid of creator */
66 ulong_t shm_ismattch; /* number of ISM attaches */
67 time_t shm_atime; /* last shmat time */
68 time_t shm_dtime; /* last shmdt time */
69 time_t shm_ctime; /* last change time */
70 struct sptinfo *shm_sptinfo; /* info about ISM segment */
71 struct seg *shm_sptseg; /* pointer to ISM segment */
72 ulong_t shm_opts;
73 /*
74 * Composed of: sptprot (uchar_t) and
75 * RM_PENDING flag (1 bit).
76 */
77 } kshmid_t;
78
79 /*
80 * Segacct Flags.
81 */
82 #define SHMSA_ISM 1 /* uses shared page table */
83
84 /*
85 * shm_opts definitions
86 * Low byte in shm_opts is used for sptprot (see PROT_ALL). The upper bits are
87 * used for additional options.
88 */
89 #define SHM_PROT_MASK 0xff
90 #define SHM_RM_PENDING 0x100
91
92 typedef struct sptinfo {
93 struct as *sptas; /* dummy as ptr. for spt segment */
94 } sptinfo_t;
95
96 /*
97 * Protected by p->p_lock
98 */
99 typedef struct segacct {
100 avl_node_t sa_tree;
101 caddr_t sa_addr;
102 size_t sa_len;
103 ulong_t sa_flags;
104 kshmid_t *sa_id;
105 } segacct_t;
106
107 /*
108 * Error codes for shmgetid().
109 */
110 #define SHMID_NONE (-1)
111 #define SHMID_FREE (-2)
112
113 extern void shminit(void);
114 extern void shmfork(struct proc *, struct proc *);
115 extern void shmexit(struct proc *);
116 extern int shmgetid(struct proc *, caddr_t);
117
118 #endif /* _KERNEL */
119
120 #if defined(_SYSCALL32)
121 /*
122 * LP64 view of the ILP32 shmid_ds structure
123 */
124 struct shmid_ds32 {
125 struct ipc_perm32 shm_perm; /* operation permission struct */
126 size32_t shm_segsz; /* size of segment in bytes */
127 caddr32_t shm_amp; /* segment anon_map pointer */
128 uint16_t shm_lkcnt; /* number of times it is being locked */
129 pid32_t shm_lpid; /* pid of last shmop */
130 pid32_t shm_cpid; /* pid of creator */
131 uint32_t shm_nattch; /* number of attaches */
132 uint32_t shm_cnattch; /* number of ISM attaches */
133 time32_t shm_atime; /* last shmat time */
134 int32_t shm_pad1; /* reserved for time_t expansion */
135 time32_t shm_dtime; /* last shmdt time */
136 int32_t shm_pad2; /* reserved for time_t expansion */
137 time32_t shm_ctime; /* last change time */
138 int32_t shm_pad3; /* reserved for time_t expansion */
139 int32_t shm_pad4[4]; /* reserve area */
140 };
141 #endif
142
143 #ifdef __cplusplus
144 }
145 #endif
146
147 #endif /* _SYS_SHM_IMPL_H */