xref: /freebsd/sys/sys/_types.h (revision 029a09f18032353a9ae874590b879322efc6e53a)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2002 Mike Barcroft <mike@FreeBSD.org>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef _SYS__TYPES_H_
30 #define _SYS__TYPES_H_
31 
32 /*
33  * Basic types upon which most other types are built.
34  *
35  * Note: It would be nice to simply use the compiler-provided __FOO_TYPE__
36  * macros. However, in order to do so we have to check that those match the
37  * previous typedefs exactly (not just that they have the same size) since any
38  * change would be an ABI break. For example, changing `long` to `long long`
39  * results in different C++ name mangling.
40  */
41 typedef	signed char		__int8_t;
42 typedef	unsigned char		__uint8_t;
43 typedef	short			__int16_t;
44 typedef	unsigned short		__uint16_t;
45 typedef	int			__int32_t;
46 typedef	unsigned int		__uint32_t;
47 #if __SIZEOF_LONG__ == 8
48 typedef	long			__int64_t;
49 typedef	unsigned long		__uint64_t;
50 #elif __SIZEOF_LONG__ == 4
51 __extension__
52 typedef	long long		__int64_t;
53 __extension__
54 typedef	unsigned long long	__uint64_t;
55 #else
56 #error unsupported long size
57 #endif
58 
59 typedef	__int8_t	__int_least8_t;
60 typedef	__int16_t	__int_least16_t;
61 typedef	__int32_t	__int_least32_t;
62 typedef	__int64_t	__int_least64_t;
63 typedef	__int64_t	__intmax_t;
64 typedef	__uint8_t	__uint_least8_t;
65 typedef	__uint16_t	__uint_least16_t;
66 typedef	__uint32_t	__uint_least32_t;
67 typedef	__uint64_t	__uint_least64_t;
68 typedef	__uint64_t	__uintmax_t;
69 
70 #ifdef __CHERI__
71 typedef	__intcap_t	__intptr_t;
72 typedef	__intcap_t	__intfptr_t;
73 typedef	__intptr_t	__int64ptr_t;
74 typedef	__uintcap_t	__uintptr_t;
75 typedef	__uintcap_t	__uintfptr_t;
76 typedef	__uintptr_t	__uint64ptr_t;
77 #elif __SIZEOF_POINTER__ == 8
78 typedef	__int64_t	__intptr_t;
79 typedef	__int64_t	__intfptr_t;
80 typedef	__int64_t	__int64ptr_t;
81 typedef	__uint64_t	__uintptr_t;
82 typedef	__uint64_t	__uintfptr_t;
83 typedef	__uint64_t	__uint64ptr_t;
84 #elif __SIZEOF_POINTER__ == 4
85 typedef	__int32_t	__intptr_t;
86 typedef	__int32_t	__intfptr_t;
87 typedef	__int64_t	__int64ptr_t;
88 typedef	__uint32_t	__uintptr_t;
89 typedef	__uint32_t	__uintfptr_t;
90 typedef	__uint64_t	__uint64ptr_t;
91 #else
92 #error unsupported pointer size
93 #endif
94 
95 #if __SIZEOF_SIZE_T__ == 8
96 typedef	__uint64_t	__size_t;	/* sizeof() */
97 typedef	__int64_t	__ssize_t;	/* byte count or error */
98 #elif __SIZEOF_SIZE_T__ == 4
99 typedef	__uint32_t	__size_t;	/* sizeof() */
100 typedef	__int32_t	__ssize_t;	/* byte count or error */
101 #else
102 #error unsupported size_t size
103 #endif
104 
105 #if __SIZEOF_PTRDIFF_T__ == 8
106 typedef	__int64_t	__ptrdiff_t;	/* ptr1 - ptr2 */
107 #elif __SIZEOF_PTRDIFF_T__ == 4
108 typedef	__int32_t	__ptrdiff_t;	/* ptr1 - ptr2 */
109 #else
110 #error unsupported ptrdiff_t size
111 #endif
112 
113 #ifdef __PTRADDR_TYPE__
114 typedef	__PTRADDR_TYPE__	__ptraddr_t;
115 #else
116 typedef	__size_t		__ptraddr_t;
117 #endif
118 
119 typedef	__ptraddr_t	__vm_offset_t;
120 typedef	__size_t	__vm_size_t;
121 
122 /*
123  * Target-dependent type definitions.
124  */
125 #include <machine/_types.h>
126 
127 /*
128  * Standard type definitions.
129  */
130 typedef	__int32_t	__blksize_t;	/* file block size */
131 typedef	__int64_t	__blkcnt_t;	/* file block count */
132 typedef	__int32_t	__clockid_t;	/* clock_gettime()... */
133 typedef	__uint32_t	__fflags_t;	/* file flags */
134 typedef	__uint64_t	__fsblkcnt_t;
135 typedef	__uint64_t	__fsfilcnt_t;
136 typedef	__uint32_t	__gid_t;
137 typedef	__int64_t	__id_t;		/* can hold a gid_t, pid_t, or uid_t */
138 typedef	__uint64_t	__ino_t;	/* inode number */
139 typedef	long		__key_t;	/* IPC key (for Sys V IPC) */
140 typedef	__int32_t	__lwpid_t;	/* Thread ID (a.k.a. LWP) */
141 typedef	__uint16_t	__mode_t;	/* permissions */
142 typedef	int		__accmode_t;	/* access permissions */
143 typedef	int		__nl_item;
144 typedef	__uint64_t	__nlink_t;	/* link count */
145 typedef	__int64_t	__off_t;	/* file offset */
146 typedef	__int64_t	__off64_t;	/* file offset (alias) */
147 typedef	__int32_t	__pid_t;	/* process [group] */
148 typedef	__int64_t	__sbintime_t;
149 typedef	__int64_t	__rlim_t;	/* resource limit - intentionally */
150 					/* signed, because of legacy code */
151 					/* that uses -1 for RLIM_INFINITY */
152 typedef	__uint8_t	__sa_family_t;
153 typedef	__uint32_t	__socklen_t;
154 typedef	long		__suseconds_t;	/* microseconds (signed) */
155 typedef	struct __timer	*__timer_t;	/* timer_gettime()... */
156 typedef	struct __mq	*__mqd_t;	/* mq_open()... */
157 typedef	__uint32_t	__uid_t;
158 typedef	unsigned int	__useconds_t;	/* microseconds (unsigned) */
159 typedef	int		__cpuwhich_t;	/* which parameter for cpuset. */
160 typedef	int		__cpulevel_t;	/* level parameter for cpuset. */
161 typedef int		__cpusetid_t;	/* cpuset identifier. */
162 typedef __int64_t	__daddr_t;	/* bwrite(3), FIOBMAP2, etc */
163 
164 #ifndef __has_feature
165 #define __has_feature(x)        0
166 #endif
167 #if !__has_feature(capabilities)
168 /*
169  * On non-CHERI systems, define __(u)intcap_t to __(u)intptr_t so that
170  * hybrid-C code which needs to be explicitly aware of capabilities can
171  * use it.  These types may be present in some third-party code and
172  * should not generally be used in FreeBSD code.
173  */
174 typedef	__intptr_t	__intcap_t;
175 typedef	__uintptr_t	__uintcap_t;
176 #endif
177 
178 /*
179  * Unusual type definitions.
180  */
181 /*
182  * rune_t is declared to be an ``int'' instead of the more natural
183  * ``unsigned long'' or ``long''.  Two things are happening here.  It is not
184  * unsigned so that EOF (-1) can be naturally assigned to it and used.  Also,
185  * it looks like 10646 will be a 31 bit standard.  This means that if your
186  * ints cannot hold 32 bits, you will be in trouble.  The reason an int was
187  * chosen over a long is that the is*() and to*() routines take ints (says
188  * ANSI C), but they use __ct_rune_t instead of int.
189  *
190  * NOTE: rune_t is not covered by ANSI nor other standards, and should not
191  * be instantiated outside of lib/libc/locale.  Use wchar_t.  wint_t and
192  * rune_t must be the same type.  Also, wint_t should be able to hold all
193  * members of the largest character set plus one extra value (WEOF), and
194  * must be at least 16 bits.
195  */
196 typedef	int		__ct_rune_t;	/* arg type for ctype funcs */
197 typedef	__ct_rune_t	__rune_t;	/* rune_t (see above) */
198 typedef	__ct_rune_t	__wint_t;	/* wint_t (see above) */
199 
200 /* Clang already provides these types as built-ins, but only in C++ mode. */
201 #if !defined(__clang__) || !defined(__cplusplus)
202 typedef	__uint_least16_t __char16_t;
203 typedef	__uint_least32_t __char32_t;
204 #endif
205 /* In C++11, char16_t and char32_t are built-in types. */
206 #if defined(__cplusplus) && __cplusplus >= 201103L
207 #define	_CHAR16_T_DECLARED
208 #define	_CHAR32_T_DECLARED
209 #endif
210 
211 typedef struct {
212 	long long __max_align1
213 	    __attribute__((__aligned__(__alignof__(long long))));
214 #ifndef _STANDALONE
215 	long double __max_align2
216 	    __attribute__((__aligned__(__alignof__(long double))));
217 #endif
218 	void *__max_align3 __attribute__((__aligned__(__alignof__(void *))));
219 } __max_align_t;
220 
221 /* Types for sys/acl.h */
222 typedef __uint32_t	__acl_tag_t;
223 typedef __uint32_t	__acl_perm_t;
224 typedef __uint16_t	__acl_entry_type_t;
225 typedef __uint16_t	__acl_flag_t;
226 typedef __uint32_t	__acl_type_t;
227 typedef __uint32_t	*__acl_permset_t;
228 typedef __uint16_t	*__acl_flagset_t;
229 
230 typedef	__uint64_t	__dev_t;	/* device number */
231 
232 typedef	__uint32_t	__fixpt_t;	/* fixed point number */
233 
234 /*
235  * mbstate_t is an opaque object to keep conversion state during multibyte
236  * stream conversions.
237  */
238 typedef union {
239 	char		__mbstate8[128];
240 	__int64_t	_mbstateL;	/* for alignment */
241 	__intptr_t	_mbstateP;	/* for alignment */
242 } __mbstate_t;
243 
244 typedef __uintmax_t     __rman_res_t;
245 
246 /*
247  * Types for varargs. These are all provided by builtin types these
248  * days, so centralize their definition.
249  */
250 typedef	__builtin_va_list	__va_list;	/* internally known to gcc */
251 #if !defined(__GNUC_VA_LIST) && !defined(__NO_GNUC_VA_LIST)
252 #define __GNUC_VA_LIST
253 typedef __va_list		__gnuc_va_list;	/* compatibility w/GNU headers*/
254 #endif
255 
256 /*
257  * When the following macro is defined, the system uses 64-bit inode numbers.
258  * Programs can use this to avoid including <sys/param.h>, with its associated
259  * namespace pollution.
260  */
261 #define	__INO64
262 
263 #endif /* !_SYS__TYPES_H_ */
264