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