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