xref: /freebsd-13-stable/sys/sys/_types.h (revision f8167e0404dab9ffeaca95853dd237ab7c587f82)
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 #include <machine/_types.h>
34 
35 /*
36  * Standard type definitions.
37  */
38 typedef	__int32_t	__blksize_t;	/* file block size */
39 typedef	__int64_t	__blkcnt_t;	/* file block count */
40 typedef	__int32_t	__clockid_t;	/* clock_gettime()... */
41 typedef	__uint32_t	__fflags_t;	/* file flags */
42 typedef	__uint64_t	__fsblkcnt_t;
43 typedef	__uint64_t	__fsfilcnt_t;
44 typedef	__uint32_t	__gid_t;
45 typedef	__int64_t	__id_t;		/* can hold a gid_t, pid_t, or uid_t */
46 typedef	__uint64_t	__ino_t;	/* inode number */
47 typedef	long		__key_t;	/* IPC key (for Sys V IPC) */
48 typedef	__int32_t	__lwpid_t;	/* Thread ID (a.k.a. LWP) */
49 typedef	__uint16_t	__mode_t;	/* permissions */
50 typedef	int		__accmode_t;	/* access permissions */
51 typedef	int		__nl_item;
52 typedef	__uint64_t	__nlink_t;	/* link count */
53 typedef	__int64_t	__off_t;	/* file offset */
54 typedef	__int64_t	__off64_t;	/* file offset (alias) */
55 typedef	__int32_t	__pid_t;	/* process [group] */
56 typedef	__int64_t	__rlim_t;	/* resource limit - intentionally */
57 					/* signed, because of legacy code */
58 					/* that uses -1 for RLIM_INFINITY */
59 typedef	__uint8_t	__sa_family_t;
60 typedef	__uint32_t	__socklen_t;
61 typedef	long		__suseconds_t;	/* microseconds (signed) */
62 typedef	struct __timer	*__timer_t;	/* timer_gettime()... */
63 typedef	struct __mq	*__mqd_t;	/* mq_open()... */
64 typedef	__uint32_t	__uid_t;
65 typedef	unsigned int	__useconds_t;	/* microseconds (unsigned) */
66 typedef	int		__cpuwhich_t;	/* which parameter for cpuset. */
67 typedef	int		__cpulevel_t;	/* level parameter for cpuset. */
68 typedef int		__cpusetid_t;	/* cpuset identifier. */
69 typedef __int64_t	__daddr_t;	/* bwrite(3), FIOBMAP2, etc */
70 
71 /*
72  * Unusual type definitions.
73  */
74 /*
75  * rune_t is declared to be an ``int'' instead of the more natural
76  * ``unsigned long'' or ``long''.  Two things are happening here.  It is not
77  * unsigned so that EOF (-1) can be naturally assigned to it and used.  Also,
78  * it looks like 10646 will be a 31 bit standard.  This means that if your
79  * ints cannot hold 32 bits, you will be in trouble.  The reason an int was
80  * chosen over a long is that the is*() and to*() routines take ints (says
81  * ANSI C), but they use __ct_rune_t instead of int.
82  *
83  * NOTE: rune_t is not covered by ANSI nor other standards, and should not
84  * be instantiated outside of lib/libc/locale.  Use wchar_t.  wint_t and
85  * rune_t must be the same type.  Also, wint_t should be able to hold all
86  * members of the largest character set plus one extra value (WEOF), and
87  * must be at least 16 bits.
88  */
89 typedef	int		__ct_rune_t;	/* arg type for ctype funcs */
90 typedef	__ct_rune_t	__rune_t;	/* rune_t (see above) */
91 typedef	__ct_rune_t	__wint_t;	/* wint_t (see above) */
92 
93 /* Clang already provides these types as built-ins, but only in C++ mode. */
94 #if !defined(__clang__) || !defined(__cplusplus)
95 typedef	__uint_least16_t __char16_t;
96 typedef	__uint_least32_t __char32_t;
97 #endif
98 /* In C++11, char16_t and char32_t are built-in types. */
99 #if defined(__cplusplus) && __cplusplus >= 201103L
100 #define	_CHAR16_T_DECLARED
101 #define	_CHAR32_T_DECLARED
102 #endif
103 
104 typedef struct {
105 	long long __max_align1 __aligned(_Alignof(long long));
106 #ifndef _STANDALONE
107 	long double __max_align2 __aligned(_Alignof(long double));
108 #endif
109 } __max_align_t;
110 
111 typedef	__uint64_t	__dev_t;	/* device number */
112 
113 typedef	__uint32_t	__fixpt_t;	/* fixed point number */
114 
115 /*
116  * mbstate_t is an opaque object to keep conversion state during multibyte
117  * stream conversions.
118  */
119 typedef union {
120 	char		__mbstate8[128];
121 	__int64_t	_mbstateL;	/* for alignment */
122 } __mbstate_t;
123 
124 typedef __uintmax_t     __rman_res_t;
125 
126 /*
127  * Types for varargs. These are all provided by builtin types these
128  * days, so centralize their definition.
129  */
130 #ifdef __GNUCLIKE_BUILTIN_VARARGS
131 typedef	__builtin_va_list	__va_list;	/* internally known to gcc */
132 #else
133 #error "No support for your compiler for stdargs"
134 #endif
135 #if defined(__GNUC_VA_LIST_COMPATIBILITY) && !defined(__GNUC_VA_LIST) \
136     && !defined(__NO_GNUC_VA_LIST)
137 #define __GNUC_VA_LIST
138 typedef __va_list		__gnuc_va_list;	/* compatibility w/GNU headers*/
139 #endif
140 
141 /*
142  * When the following macro is defined, the system uses 64-bit inode numbers.
143  * Programs can use this to avoid including <sys/param.h>, with its associated
144  * namespace pollution.
145  */
146 #define	__INO64
147 
148 #endif /* !_SYS__TYPES_H_ */
149