summaryrefslogtreecommitdiff
path: root/usr/src/uts/common/sys/model.h
blob: 0569c086f59b98d530c95935b219c01deb66d8bd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#ifndef	_SYS_MODEL_H
#define	_SYS_MODEL_H

#ifdef	__cplusplus
extern "C" {
#endif

#if defined(_KERNEL) && !defined(_ASM)
#include <sys/debug.h>
#endif /* _KERNEL && !_ASM */

#include <sys/isa_defs.h>

#if defined(_KERNEL) || defined(_FAKE_KERNEL) || defined(_KMEMUSER)

/*
 * These bits are used in various places to specify the data model
 * of the originator (and/or consumer) of data items.  See <sys/conf.h>
 * <sys/file.h>, <sys/stream.h> and <sys/sunddi.h>.
 *
 * This state should only be known to the kernel implementation.
 */
#define	DATAMODEL_MASK	0x0FF00000

#define	DATAMODEL_ILP32	0x00100000
#define	DATAMODEL_LP64	0x00200000

#define	DATAMODEL_NONE	0

#if	defined(_LP64)
#define	DATAMODEL_NATIVE	DATAMODEL_LP64
#elif	defined(_ILP32)
#define	DATAMODEL_NATIVE	DATAMODEL_ILP32
#else
#error	"No DATAMODEL_NATIVE specified"
#endif	/* _LP64 || _ILP32 */

#endif	/* _KERNEL || _KMEMUSER */

#ifndef _ASM
/*
 * XXX	Ick.  This type needs to be visible outside the above guard because
 * the proc structure is visible outside the _KERNEL | _KMEMUSER guard.
 * If we can make proc internals less visible, (which we obviously should)
 * then this can be invisible too.
 */
typedef unsigned int model_t;

#endif	/* _ASM */

#if defined(_KERNEL) && !defined(_ASM)
/*
 * These macros allow two views of the same piece of memory depending
 * on the originating user-mode program's data model.  See the STRUCT_DECL(9F)
 * man page.
 */
#if defined(_LP64)

#define	STRUCT_HANDLE(struct_type, handle)				\
	struct {							\
		union {							\
			struct struct_type##32	*m32;			\
			struct struct_type	*m64;			\
		}	ptr;						\
		model_t	model;						\
	} handle = { NULL, DATAMODEL_ILP32 }

#define	STRUCT_DECL(struct_type, handle)				\
	struct struct_type __##handle##_buf;				\
	STRUCT_HANDLE(struct_type, handle)

#define	STRUCT_SET_HANDLE(handle, umodel, addr)				\
	(handle).model = (model_t)(umodel) & DATAMODEL_MASK;		\
	ASSERT(((umodel) & DATAMODEL_MASK) != DATAMODEL_NONE);		\
	((handle).ptr.m64) = (addr)

#define	STRUCT_INIT(handle, umodel)					\
	STRUCT_SET_HANDLE(handle, umodel, &__##handle##_buf)

#define	STRUCT_SIZE(handle)						\
	((handle).model == DATAMODEL_ILP32 ?				\
	    sizeof (*(handle).ptr.m32) :				\
	    sizeof (*(handle).ptr.m64))

/*
 * In STRUCT_FADDR and STRUCT_FGETP a sleight of hand is employed to make
 * the compiler cope with having two different pointer types within ?:.
 * The (void *) case on the ILP32 case makes it a pointer which can be
 * converted to the pointer on the LP64 case, thus quieting the compiler.
 */
#define	STRUCT_FADDR(handle, field)					\
	((handle).model == DATAMODEL_ILP32 ?				\
	    (void *)&(handle).ptr.m32->field :				\
	    &(handle).ptr.m64->field)

#define	STRUCT_FGET(handle, field)					\
	(((handle).model == DATAMODEL_ILP32) ?				\
	    (handle).ptr.m32->field :					\
	    (handle).ptr.m64->field)

#define	STRUCT_FGETP(handle, field)					\
	((handle).model == DATAMODEL_ILP32 ?				\
	    (void *)(uintptr_t)(handle).ptr.m32->field :		\
	    (handle).ptr.m64->field)

#define	STRUCT_FSET(handle, field, val)					\
	((handle).model == DATAMODEL_ILP32 ?				\
	    ((handle).ptr.m32->field = (val)) :				\
	    ((handle).ptr.m64->field = (val)))

#define	STRUCT_FSETP(handle, field, val)				\
	((handle).model == DATAMODEL_ILP32 ?				\
	    (void) ((handle).ptr.m32->field = (caddr32_t)(uintptr_t)(val)) : \
	    (void) ((handle).ptr.m64->field = (val)))

#define	STRUCT_BUF(handle)	((handle).ptr.m64)

#define	SIZEOF_PTR(umodel)						\
	(((umodel) & DATAMODEL_MASK) == DATAMODEL_ILP32 ?		\
	    sizeof (caddr32_t) :					\
	    sizeof (caddr_t))

#define	SIZEOF_STRUCT(struct_type, umodel)				\
	(((umodel) & DATAMODEL_MASK) == DATAMODEL_ILP32 ?		\
	    sizeof (struct struct_type##32) :				\
	    sizeof (struct struct_type))

#else	/*  _LP64 */

#define	STRUCT_HANDLE(struct_type, handle)				\
	struct {							\
		struct struct_type *ptr;				\
		model_t	model;						\
	} handle = { NULL, DATAMODEL_ILP32 }

#define	STRUCT_DECL(struct_type, handle)				\
	struct struct_type __##handle##_buf;				\
	STRUCT_HANDLE(struct_type, handle)

#define	STRUCT_SET_HANDLE(handle, umodel, addr)				\
	(handle).model = (model_t)(umodel) & DATAMODEL_MASK;		\
	ASSERT(((umodel) & DATAMODEL_MASK) == DATAMODEL_ILP32);		\
	(handle).ptr = (addr)

#define	STRUCT_INIT(handle, umodel)					\
	STRUCT_SET_HANDLE(handle, umodel, &__##handle##_buf)

#define	STRUCT_SIZE(handle)		(sizeof (*(handle).ptr))

#define	STRUCT_FADDR(handle, field)	(&(handle).ptr->field)

#define	STRUCT_FGET(handle, field)	((handle).ptr->field)

#define	STRUCT_FGETP			STRUCT_FGET

#define	STRUCT_FSET(handle, field, val)	((handle).ptr->field = (val))

#define	STRUCT_FSETP			STRUCT_FSET

#define	STRUCT_BUF(handle)		((handle).ptr)

#define	SIZEOF_PTR(umodel)		sizeof (caddr_t)

#define	SIZEOF_STRUCT(struct_type, umodel)	sizeof (struct struct_type)

#endif	/* _LP64 */

#if defined(_LP64) || defined(__lint)

struct _klwp;

extern	model_t lwp_getdatamodel(struct _klwp *);
extern	model_t get_udatamodel(void);

#else

/*
 * If we're the 32-bit kernel, the result of these function
 * calls is completely predictable, so let's just cheat.  A
 * good compiler should be able to elide all the unreachable code
 * that results.  Optimism about optimization reigns supreme ;-)
 */
#define	lwp_getdatamodel(t)		DATAMODEL_ILP32
#define	get_udatamodel()		DATAMODEL_ILP32

#endif	/* _LP64 || __lint */

#endif	/* _KERNEL && !_ASM */

#ifdef	__cplusplus
}
#endif

#endif	/* _SYS_MODEL_H */