xref: /xnu-11215.41.3/bsd/arm/types.h (revision 33de042d024d46de5ff4e89f2471de6608e37fa4)
1 /*
2  * Copyright (c) 2000-2008 Apple Inc. All rights reserved.
3  */
4 /*
5  * Copyright 1995 NeXT Computer, Inc. All rights reserved.
6  */
7 /*
8  * Copyright (c) 1990, 1993
9  *	The Regents of the University of California.  All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *	This product includes software developed by the University of
22  *	California, Berkeley and its contributors.
23  * 4. Neither the name of the University nor the names of its contributors
24  *    may be used to endorse or promote products derived from this software
25  *    without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37  * SUCH DAMAGE.
38  *
39  *	@(#)types.h	8.3 (Berkeley) 1/5/94
40  */
41 
42 #ifndef _ARM_MACHTYPES_H_
43 #define _ARM_MACHTYPES_H_
44 #define _MACHTYPES_H_
45 
46 #if defined (__arm__) || defined (__arm64__)
47 
48 #ifndef __ASSEMBLER__
49 #include <arm/_types.h>
50 #include <sys/cdefs.h>
51 /*
52  * Basic integral types.  Omit the typedef if
53  * not possible for a machine/compiler combination.
54  */
55 #include <sys/_types/_int8_t.h>
56 #include <sys/_types/_int16_t.h>
57 #include <sys/_types/_int32_t.h>
58 #include <sys/_types/_int64_t.h>
59 
60 #include <sys/_types/_u_int8_t.h>
61 #include <sys/_types/_u_int16_t.h>
62 #include <sys/_types/_u_int32_t.h>
63 #include <sys/_types/_u_int64_t.h>
64 
65 #if __LP64__
66 typedef int64_t                 register_t;
67 #else
68 typedef int32_t                 register_t;
69 #endif
70 
71 #include <sys/_types/_intptr_t.h>
72 #include <sys/_types/_uintptr_t.h>
73 
74 #if !defined(_ANSI_SOURCE) && (!defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE))
75 /* These types are used for reserving the largest possible size. */
76 #ifdef __arm64__
77 typedef u_int64_t               user_addr_t;
78 typedef u_int64_t               user_size_t;
79 typedef int64_t                 user_ssize_t;
80 typedef int64_t                 user_long_t;
81 typedef u_int64_t               user_ulong_t;
82 typedef int64_t                 user_time_t;
83 typedef int64_t                 user_off_t;
84 #else
85 typedef u_int32_t               user_addr_t;
86 typedef u_int32_t               user_size_t;
87 typedef int32_t                 user_ssize_t;
88 typedef int32_t                 user_long_t;
89 typedef u_int32_t               user_ulong_t;
90 typedef int32_t                 user_time_t;
91 typedef int64_t                 user_off_t;
92 #endif
93 
94 #if KERNEL
95 #ifndef VM_UNSAFE_TYPES
96 typedef user_addr_t             user_addr_ut;
97 typedef user_size_t             user_size_ut;
98 #endif /* VM_SAFE_TYPES */
99 #endif /* KERNEL */
100 
101 #define USER_ADDR_NULL  ((user_addr_t) 0)
102 #define CAST_USER_ADDR_T(a_ptr)   ((user_addr_t)((uintptr_t)(a_ptr)))
103 
104 #ifdef KERNEL
105 
106 /*
107  * These types are used when you know the word size of the target
108  * user process. They can be used to create struct layouts independent
109  * of the types and alignment requirements of the current running
110  * kernel.
111  */
112 
113 /*
114  * The user64_ types are not used on the ARM platform, but exist
115  * so that APIs that conditionalize their behavior based on the
116  * size of an input structure (like many ioctl(2) implementations)
117  * can differentiate those structures without a duplicate case
118  * value.
119  */
120 
121 /*
122  * The default ABI for the ARM platform aligns fundamental integral
123  * data types to their natural boundaries, with a maximum alignment
124  * of 4, even for 8-byte quantites.
125  */
126 
127 typedef __uint64_t              user64_addr_t;
128 typedef __uint64_t              user64_size_t;
129 typedef __int64_t               user64_ssize_t;
130 typedef __int64_t               user64_long_t;
131 typedef __uint64_t              user64_ulong_t;
132 typedef __int64_t               user64_time_t;
133 typedef __int64_t               user64_off_t;
134 
135 typedef __uint32_t              user32_addr_t;
136 typedef __uint32_t              user32_size_t;
137 typedef __int32_t               user32_ssize_t;
138 typedef __int32_t               user32_long_t;
139 typedef __uint32_t              user32_ulong_t;
140 typedef __int32_t               user32_time_t;
141 
142 /*
143  * This alignment is required to ensure symmetry between userspace and kernelspace
144  * when the kernel is 64-bit and the user application is 32-bit. All currently
145  * supported ARM slices (arm64/armv7k/arm64_32) contain the same type alignment
146  * ABI so this alignment isn't needed for ARM.
147  */
148 #if defined(__x86_64__)
149 typedef __int64_t               user32_off_t __attribute__((aligned(4)));
150 #else
151 typedef __int64_t               user32_off_t;
152 #endif
153 
154 #endif /* KERNEL */
155 
156 #endif /* !_ANSI_SOURCE && (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
157 
158 /* This defines the size of syscall arguments after copying into the kernel: */
159 #if defined(__arm__)
160 typedef u_int32_t               syscall_arg_t;
161 #elif defined(__arm64__)
162 typedef u_int64_t               syscall_arg_t;
163 #else
164 #error Unknown architecture.
165 #endif
166 
167 #endif /* __ASSEMBLER__ */
168 #endif /* defined (__arm__) || defined (__arm64__) */
169 #endif  /* _ARM_MACHTYPES_H_ */
170