xref: /freebsd/sys/sys/_types.h (revision 9768746b)
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	__sbintime_t;
137 typedef	__int64_t	__rlim_t;	/* resource limit - intentionally */
138 					/* signed, because of legacy code */
139 					/* that uses -1 for RLIM_INFINITY */
140 typedef	__uint8_t	__sa_family_t;
141 typedef	__uint32_t	__socklen_t;
142 typedef	long		__suseconds_t;	/* microseconds (signed) */
143 typedef	struct __timer	*__timer_t;	/* timer_gettime()... */
144 typedef	struct __mq	*__mqd_t;	/* mq_open()... */
145 typedef	__uint32_t	__uid_t;
146 typedef	unsigned int	__useconds_t;	/* microseconds (unsigned) */
147 typedef	int		__cpuwhich_t;	/* which parameter for cpuset. */
148 typedef	int		__cpulevel_t;	/* level parameter for cpuset. */
149 typedef int		__cpusetid_t;	/* cpuset identifier. */
150 typedef __int64_t	__daddr_t;	/* bwrite(3), FIOBMAP2, etc */
151 
152 /*
153  * Unusual type definitions.
154  */
155 /*
156  * rune_t is declared to be an ``int'' instead of the more natural
157  * ``unsigned long'' or ``long''.  Two things are happening here.  It is not
158  * unsigned so that EOF (-1) can be naturally assigned to it and used.  Also,
159  * it looks like 10646 will be a 31 bit standard.  This means that if your
160  * ints cannot hold 32 bits, you will be in trouble.  The reason an int was
161  * chosen over a long is that the is*() and to*() routines take ints (says
162  * ANSI C), but they use __ct_rune_t instead of int.
163  *
164  * NOTE: rune_t is not covered by ANSI nor other standards, and should not
165  * be instantiated outside of lib/libc/locale.  Use wchar_t.  wint_t and
166  * rune_t must be the same type.  Also, wint_t should be able to hold all
167  * members of the largest character set plus one extra value (WEOF), and
168  * must be at least 16 bits.
169  */
170 typedef	int		__ct_rune_t;	/* arg type for ctype funcs */
171 typedef	__ct_rune_t	__rune_t;	/* rune_t (see above) */
172 typedef	__ct_rune_t	__wint_t;	/* wint_t (see above) */
173 
174 /* Clang already provides these types as built-ins, but only in C++ mode. */
175 #if !defined(__clang__) || !defined(__cplusplus)
176 typedef	__uint_least16_t __char16_t;
177 typedef	__uint_least32_t __char32_t;
178 #endif
179 /* In C++11, char16_t and char32_t are built-in types. */
180 #if defined(__cplusplus) && __cplusplus >= 201103L
181 #define	_CHAR16_T_DECLARED
182 #define	_CHAR32_T_DECLARED
183 #endif
184 
185 typedef struct {
186 	long long __max_align1 __aligned(_Alignof(long long));
187 #ifndef _STANDALONE
188 	long double __max_align2 __aligned(_Alignof(long double));
189 #endif
190 } __max_align_t;
191 
192 typedef	__uint64_t	__dev_t;	/* device number */
193 
194 typedef	__uint32_t	__fixpt_t;	/* fixed point number */
195 
196 /*
197  * mbstate_t is an opaque object to keep conversion state during multibyte
198  * stream conversions.
199  */
200 typedef union {
201 	char		__mbstate8[128];
202 	__int64_t	_mbstateL;	/* for alignment */
203 } __mbstate_t;
204 
205 typedef __uintmax_t     __rman_res_t;
206 
207 /*
208  * Types for varargs. These are all provided by builtin types these
209  * days, so centralize their definition.
210  */
211 typedef	__builtin_va_list	__va_list;	/* internally known to gcc */
212 #if !defined(__GNUC_VA_LIST) && !defined(__NO_GNUC_VA_LIST)
213 #define __GNUC_VA_LIST
214 typedef __va_list		__gnuc_va_list;	/* compatibility w/GNU headers*/
215 #endif
216 
217 /*
218  * When the following macro is defined, the system uses 64-bit inode numbers.
219  * Programs can use this to avoid including <sys/param.h>, with its associated
220  * namespace pollution.
221  */
222 #define	__INO64
223 
224 #endif /* !_SYS__TYPES_H_ */
225