xref: /freebsd/sys/sys/_types.h (revision 55513a1b6e4b46cc5f19bbf35980ff0db874a93b)
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 #include <sys/cdefs.h>
33 
34 /*
35  * Basic types upon which most other types are built.
36  *
37  * Note: It would be nice to simply use the compiler-provided __FOO_TYPE__
38  * macros. However, in order to do so we have to check that those match the
39  * previous typedefs exactly (not just that they have the same size) since any
40  * change would be an ABI break. For example, changing `long` to `long long`
41  * results in different C++ name mangling.
42  */
43 typedef	signed char		__int8_t;
44 typedef	unsigned char		__uint8_t;
45 typedef	short			__int16_t;
46 typedef	unsigned short		__uint16_t;
47 typedef	int			__int32_t;
48 typedef	unsigned int		__uint32_t;
49 #if __SIZEOF_LONG__ == 8
50 typedef	long			__int64_t;
51 typedef	unsigned long		__uint64_t;
52 #elif __SIZEOF_LONG__ == 4
53 __extension__
54 typedef	long long		__int64_t;
55 __extension__
56 typedef	unsigned long long	__uint64_t;
57 #else
58 #error unsupported long size
59 #endif
60 
61 typedef	__int8_t	__int_least8_t;
62 typedef	__int16_t	__int_least16_t;
63 typedef	__int32_t	__int_least32_t;
64 typedef	__int64_t	__int_least64_t;
65 typedef	__int64_t	__intmax_t;
66 typedef	__uint8_t	__uint_least8_t;
67 typedef	__uint16_t	__uint_least16_t;
68 typedef	__uint32_t	__uint_least32_t;
69 typedef	__uint64_t	__uint_least64_t;
70 typedef	__uint64_t	__uintmax_t;
71 
72 #if __SIZEOF_POINTER__ == 8
73 typedef	__int64_t	__intptr_t;
74 typedef	__int64_t	__intfptr_t;
75 typedef	__uint64_t	__uintptr_t;
76 typedef	__uint64_t	__uintfptr_t;
77 typedef	__uint64_t	__vm_offset_t;
78 typedef	__uint64_t	__vm_size_t;
79 #elif __SIZEOF_POINTER__ == 4
80 typedef	__int32_t	__intptr_t;
81 typedef	__int32_t	__intfptr_t;
82 typedef	__uint32_t	__uintptr_t;
83 typedef	__uint32_t	__uintfptr_t;
84 typedef	__uint32_t	__vm_offset_t;
85 typedef	__uint32_t	__vm_size_t;
86 #else
87 #error unsupported pointer size
88 #endif
89 
90 #if __SIZEOF_SIZE_T__ == 8
91 typedef	__uint64_t	__size_t;	/* sizeof() */
92 typedef	__int64_t	__ssize_t;	/* byte count or error */
93 #elif __SIZEOF_SIZE_T__ == 4
94 typedef	__uint32_t	__size_t;	/* sizeof() */
95 typedef	__int32_t	__ssize_t;	/* byte count or error */
96 #else
97 #error unsupported size_t size
98 #endif
99 
100 #if __SIZEOF_PTRDIFF_T__ == 8
101 typedef	__int64_t	__ptrdiff_t;	/* ptr1 - ptr2 */
102 #elif __SIZEOF_PTRDIFF_T__ == 4
103 typedef	__int32_t	__ptrdiff_t;	/* ptr1 - ptr2 */
104 #else
105 #error unsupported ptrdiff_t size
106 #endif
107 
108 /*
109  * Target-dependent type definitions.
110  */
111 #include <machine/_types.h>
112 
113 /*
114  * Standard type definitions.
115  */
116 typedef	__int32_t	__blksize_t;	/* file block size */
117 typedef	__int64_t	__blkcnt_t;	/* file block count */
118 typedef	__int32_t	__clockid_t;	/* clock_gettime()... */
119 typedef	__uint32_t	__fflags_t;	/* file flags */
120 typedef	__uint64_t	__fsblkcnt_t;
121 typedef	__uint64_t	__fsfilcnt_t;
122 typedef	__uint32_t	__gid_t;
123 typedef	__int64_t	__id_t;		/* can hold a gid_t, pid_t, or uid_t */
124 typedef	__uint64_t	__ino_t;	/* inode number */
125 typedef	long		__key_t;	/* IPC key (for Sys V IPC) */
126 typedef	__int32_t	__lwpid_t;	/* Thread ID (a.k.a. LWP) */
127 typedef	__uint16_t	__mode_t;	/* permissions */
128 typedef	int		__accmode_t;	/* access permissions */
129 typedef	int		__nl_item;
130 typedef	__uint64_t	__nlink_t;	/* link count */
131 typedef	__int64_t	__off_t;	/* file offset */
132 typedef	__int64_t	__off64_t;	/* file offset (alias) */
133 typedef	__int32_t	__pid_t;	/* process [group] */
134 typedef	__int64_t	__sbintime_t;
135 typedef	__int64_t	__rlim_t;	/* resource limit - intentionally */
136 					/* signed, because of legacy code */
137 					/* that uses -1 for RLIM_INFINITY */
138 typedef	__uint8_t	__sa_family_t;
139 typedef	__uint32_t	__socklen_t;
140 typedef	long		__suseconds_t;	/* microseconds (signed) */
141 typedef	struct __timer	*__timer_t;	/* timer_gettime()... */
142 typedef	struct __mq	*__mqd_t;	/* mq_open()... */
143 typedef	__uint32_t	__uid_t;
144 typedef	unsigned int	__useconds_t;	/* microseconds (unsigned) */
145 typedef	int		__cpuwhich_t;	/* which parameter for cpuset. */
146 typedef	int		__cpulevel_t;	/* level parameter for cpuset. */
147 typedef int		__cpusetid_t;	/* cpuset identifier. */
148 typedef __int64_t	__daddr_t;	/* bwrite(3), FIOBMAP2, etc */
149 
150 /*
151  * Unusual type definitions.
152  */
153 /*
154  * rune_t is declared to be an ``int'' instead of the more natural
155  * ``unsigned long'' or ``long''.  Two things are happening here.  It is not
156  * unsigned so that EOF (-1) can be naturally assigned to it and used.  Also,
157  * it looks like 10646 will be a 31 bit standard.  This means that if your
158  * ints cannot hold 32 bits, you will be in trouble.  The reason an int was
159  * chosen over a long is that the is*() and to*() routines take ints (says
160  * ANSI C), but they use __ct_rune_t instead of int.
161  *
162  * NOTE: rune_t is not covered by ANSI nor other standards, and should not
163  * be instantiated outside of lib/libc/locale.  Use wchar_t.  wint_t and
164  * rune_t must be the same type.  Also, wint_t should be able to hold all
165  * members of the largest character set plus one extra value (WEOF), and
166  * must be at least 16 bits.
167  */
168 typedef	int		__ct_rune_t;	/* arg type for ctype funcs */
169 typedef	__ct_rune_t	__rune_t;	/* rune_t (see above) */
170 typedef	__ct_rune_t	__wint_t;	/* wint_t (see above) */
171 
172 /* Clang already provides these types as built-ins, but only in C++ mode. */
173 #if !defined(__clang__) || !defined(__cplusplus)
174 typedef	__uint_least16_t __char16_t;
175 typedef	__uint_least32_t __char32_t;
176 #endif
177 /* In C++11, char16_t and char32_t are built-in types. */
178 #if defined(__cplusplus) && __cplusplus >= 201103L
179 #define	_CHAR16_T_DECLARED
180 #define	_CHAR32_T_DECLARED
181 #endif
182 
183 typedef struct {
184 	long long __max_align1 __aligned(_Alignof(long long));
185 #ifndef _STANDALONE
186 	long double __max_align2 __aligned(_Alignof(long double));
187 #endif
188 } __max_align_t;
189 
190 /* Types for sys/acl.h */
191 typedef __uint32_t	__acl_tag_t;
192 typedef __uint32_t	__acl_perm_t;
193 typedef __uint16_t	__acl_entry_type_t;
194 typedef __uint16_t	__acl_flag_t;
195 typedef __uint32_t	__acl_type_t;
196 typedef __uint32_t	*__acl_permset_t;
197 typedef __uint16_t	*__acl_flagset_t;
198 
199 typedef	__uint64_t	__dev_t;	/* device number */
200 
201 typedef	__uint32_t	__fixpt_t;	/* fixed point number */
202 
203 /*
204  * mbstate_t is an opaque object to keep conversion state during multibyte
205  * stream conversions.
206  */
207 typedef union {
208 	char		__mbstate8[128];
209 	__int64_t	_mbstateL;	/* for alignment */
210 } __mbstate_t;
211 
212 typedef __uintmax_t     __rman_res_t;
213 
214 /*
215  * Types for varargs. These are all provided by builtin types these
216  * days, so centralize their definition.
217  */
218 typedef	__builtin_va_list	__va_list;	/* internally known to gcc */
219 #if !defined(__GNUC_VA_LIST) && !defined(__NO_GNUC_VA_LIST)
220 #define __GNUC_VA_LIST
221 typedef __va_list		__gnuc_va_list;	/* compatibility w/GNU headers*/
222 #endif
223 
224 /*
225  * When the following macro is defined, the system uses 64-bit inode numbers.
226  * Programs can use this to avoid including <sys/param.h>, with its associated
227  * namespace pollution.
228  */
229 #define	__INO64
230 
231 #endif /* !_SYS__TYPES_H_ */
232