kernel - Add lock debugging
[dragonfly.git] / sys / sys / types.h
1 /*-
2  * Copyright (c) 1982, 1986, 1991, 1993, 1994
3  *      The Regents of the University of California.  All rights reserved.
4  * (c) UNIX System Laboratories, Inc.
5  * All or some portions of this file are derived from material licensed
6  * to the University of California by American Telephone and Telegraph
7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8  * the permission of UNIX System Laboratories, Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *      @(#)types.h     8.6 (Berkeley) 2/19/95
35  * $FreeBSD: src/sys/sys/types.h,v 1.40.2.2 2001/04/21 14:53:06 ume Exp $
36  */
37
38 #ifndef _SYS_TYPES_H_
39 #define _SYS_TYPES_H_
40
41 #ifndef _SYS_CDEFS_H_
42 #include <sys/cdefs.h>
43 #endif
44 #ifndef _STDINT_H_
45 #include <stdint.h>
46 #endif
47 #include <machine/stdarg.h>
48 #include <machine/endian.h>
49 #ifndef _MACHINE_TYPES_H_
50 #include <machine/types.h>
51 #endif
52 #ifndef _SYS_STDINT_H_
53 #include <sys/stdint.h>
54 #endif
55 #ifndef _SYS__PTHREADTYPES_H_
56 #include <sys/_pthreadtypes.h>
57 #endif
58
59 #if __BSD_VISIBLE
60 typedef unsigned char   u_char;
61 typedef unsigned short  u_short;
62 typedef unsigned int    u_int;
63 typedef unsigned long   u_long;
64
65 typedef unsigned char   unchar;         /* Sys V compatibility */
66 typedef unsigned short  ushort;         /* Sys V compatibility */
67 typedef unsigned int    uint;           /* Sys V compatibility */
68 typedef unsigned long   ulong;          /* Sys V compatibility */
69 #endif
70
71 typedef __uint8_t       u_int8_t;
72 typedef __uint16_t      u_int16_t;
73 typedef __uint32_t      u_int32_t;
74 typedef __uint64_t      u_int64_t;
75 typedef __uint64_t      u_quad_t;       /* quads */
76 typedef __int64_t       quad_t;
77 typedef quad_t *        qaddr_t;
78
79 typedef __int64_t       blkcnt_t;       /* file block count */
80 typedef __int64_t       blksize_t;      /* block size */
81 typedef char *          caddr_t;        /* core address */
82 typedef const char *    c_caddr_t;      /* core address, pointer to const */
83 typedef volatile char * v_caddr_t;      /* core address, pointer to volatile */
84 typedef __int32_t       daddr_t;        /* disk address */
85 typedef __uint32_t      u_daddr_t;      /* unsigned disk address */
86 typedef __uint32_t      fixpt_t;        /* fixed point number */
87 typedef __uint64_t      fsblkcnt_t;     /* filesystem block count */
88 typedef __uint64_t      fsfilcnt_t;     /* filesystem file count */
89 #ifndef _GID_T_DECLARED
90 typedef __uint32_t      gid_t;          /* group id */
91 #define _GID_T_DECLARED
92 #endif
93 #ifndef _ID_T_DECLARED
94 typedef __int64_t       id_t;           /* general id, can hold gid/pid/uid_t */
95 #define _ID_T_DECLARED
96 #endif
97 typedef __uint32_t      in_addr_t;      /* base type for internet address */
98 typedef __uint16_t      in_port_t;
99 typedef __uint64_t      ino_t;          /* inode number */
100 typedef long            key_t;          /* IPC key (for Sys V IPC) */
101 #ifndef _MODE_T_DECLARED
102 typedef __uint16_t      mode_t;         /* permissions */
103 #define _MODE_T_DECLARED
104 #endif
105 typedef __uint32_t      nlink_t;        /* link count */
106 #ifndef _OFF_T_DECLARED
107 typedef __off_t         off_t;          /* file offset */
108 #define _OFF_T_DECLARED
109 #endif
110 #ifndef _PID_T_DECLARED
111 typedef __pid_t         pid_t;          /* process id */
112 #define _PID_T_DECLARED
113 #endif
114 #ifndef _RLIM_T_DECLARED
115 typedef __rlim_t        rlim_t;         /* resource limit */
116 #define _RLIM_T_DECLARED
117 #endif
118 typedef __segsz_t       segsz_t;        /* segment size */
119 #ifndef _SUSECONDS_T_DECLARED
120 typedef __suseconds_t   suseconds_t;    /* microseconds (signed) */
121 #define _SUSECONDS_T_DECLARED
122 #endif
123 #ifndef _UID_T_DECLARED
124 typedef __uint32_t      uid_t;          /* user id */
125 #define _UID_T_DECLARED
126 #endif
127 typedef __uint32_t      useconds_t;     /* microseconds (unsigned) */
128 typedef int             mqd_t;          /* message queue descriptor */
129
130 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
131
132 #ifndef __BOOLEAN_T_DEFINED__
133 #define __BOOLEAN_T_DEFINED__
134 typedef __boolean_t     boolean_t;
135 #endif
136
137 typedef u_int64_t       uoff_t;
138
139 #ifdef _KERNEL
140 #if !defined(__bool_true_false_are_defined) && !defined(__cplusplus)
141 #define __bool_true_false_are_defined   1
142 #define false   0
143 #define true    1
144 #if __STDC_VERSION__ < 199901L && __GNUC__ < 3
145 typedef int     _Bool;
146 #endif
147 typedef _Bool   bool;
148 #endif /* !__bool_true_false_are_defined && !__cplusplus */
149 #endif /* _KERNEL */
150
151 #endif /* _KERNEL || _KERNEL_STRUCTURES */
152
153 /*
154  * XXX cdev_t has different meanings for userland vs kernel compiles.  What
155  * do we do for _KERNEL_STRUCTURES ?  For the moment stick with the userland
156  * meaning as being the more compatible solution.
157  */
158
159 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
160
161 struct cdev;
162
163 typedef u_int32_t       udev_t;         /* device number */
164 typedef struct cdev     *cdev_t;
165
166 #endif
167
168 /*
169  * The kernel now uses only udev_t or cdev_t.  Userland uses dev_t.
170  * Virtual kernel builds needs dev_t in order to include userland header
171  * files.
172  */
173 #ifdef _KERNEL
174
175 #define offsetof(type, field) __offsetof(type, field)
176 typedef udev_t          dev_t;          /* device number */
177
178 #else
179
180 typedef u_int32_t       dev_t;          /* device number */
181 #define udev_t dev_t
182
183 #if __BSD_VISIBLE
184
185 /*
186  * minor() gives a cookie instead of an index since we don't want to
187  * change the meanings of bits 0-15 or waste time and space shifting
188  * bits 16-31 for devices that don't use them.
189  */
190 #define major(x)        ((int)(((u_int)(x) >> 8)&0xff)) /* major number */
191 #define minor(x)        ((int)((x)&0xffff00ff))         /* minor number */
192 #define makedev(x,y)    ((dev_t)(((x) << 8) | (y)))     /* create dev_t */
193
194 #endif /* __BSD_VISIBLE */
195
196 #endif /* !_KERNEL */
197
198 #ifndef _CLOCK_T_DECLARED
199 #define _CLOCK_T_DECLARED
200 typedef __clock_t       clock_t;
201 #endif
202
203 #ifndef _CLOCKID_T_DECLARED
204 #define _CLOCKID_T_DECLARED
205 typedef __clockid_t     clockid_t;
206 #endif
207
208 #if __BSD_VISIBLE
209 #ifndef _LWPID_T_DECLARED
210 #define _LWPID_T_DECLARED
211 typedef __pid_t         lwpid_t;        /* light weight process id */
212 #endif
213 #endif
214
215 #ifndef _SIZE_T_DECLARED
216 #define _SIZE_T_DECLARED
217 typedef __size_t        size_t;         /* _GCC_SIZE_T OK */
218 #endif
219
220 #ifndef _SSIZE_T_DECLARED
221 #define _SSIZE_T_DECLARED
222 typedef __ssize_t       ssize_t;
223 #endif
224
225 #ifndef _TIME_T_DECLARED
226 #define _TIME_T_DECLARED
227 typedef __time_t        time_t;
228 #endif
229
230 #ifndef _TIMER_T_DECLARED
231 #define _TIMER_T_DECLARED
232 typedef __timer_t       timer_t;
233 #endif
234
235 #if __BSD_VISIBLE
236
237 #include <sys/fd_set.h>
238 #include <sys/_timeval.h>
239
240 #define NBBY 8          /* number of bits in a byte */
241 /*
242  * These declarations belong elsewhere, but are repeated here and in
243  * <stdio.h> to give broken programs a better chance of working with
244  * 64-bit off_t's.
245  */
246 #ifndef _KERNEL
247 __BEGIN_DECLS
248 #ifndef _FTRUNCATE_DECLARED
249 #define _FTRUNCATE_DECLARED
250 int      ftruncate(int, off_t);
251 #endif
252 #ifndef _LSEEK_DECLARED
253 #define _LSEEK_DECLARED
254 off_t    lseek(int, off_t, int);
255 #endif
256 #ifndef _MMAP_DECLARED
257 #define _MMAP_DECLARED
258 void *   mmap(void *, size_t, int, int, int, off_t);
259 #endif
260 #ifndef _TRUNCATE_DECLARED
261 #define _TRUNCATE_DECLARED
262 int      truncate(const char *, off_t);
263 #endif
264 __END_DECLS
265 #endif /* !_KERNEL */
266
267 #endif /* __BSD_VISIBLE */
268
269 /*
270  * rune_t is declared to be an ``int'' instead of the more natural
271  * ``unsigned long'' or ``long''.  Two things are happening here.  It is not
272  * unsigned so that EOF (-1) can be naturally assigned to it and used.  Also,
273  * it looks like 10646 will be a 31 bit standard.  This means that if your
274  * ints cannot hold 32 bits, you will be in trouble.  The reason an int was
275  * chosen over a long is that the is*() and to*() routines take ints (says
276  * ANSI C), but they use __ct_rune_t instead of int.
277  *
278  * NOTE: rune_t is not covered by ANSI nor other standards, and should not
279  * be instantiated outside of lib/libc/locale.  Use wchar_t.  wint_t and
280  * rune_t must be the same type.  Also, wint_t should be able to hold all
281  * members of the largest character set plus one extra value (WEOF), and
282  * must be at least 16 bits.
283  */
284 typedef int             __ct_rune_t;    /* arg type for ctype funcs */
285 #ifndef ___RUNE_T_DECLARED
286 typedef __ct_rune_t     __rune_t;       /* rune_t (see above) */
287 #define ___RUNE_T_DECLARED
288 #endif
289 #ifndef ___WINT_T_DECLARED
290 typedef __ct_rune_t     __wint_t;       /* wint_t (see above) */
291 #define ___WINT_T_DECLARED
292 #endif
293
294 /*
295  * Also required for locale support
296  */
297 typedef int             __nl_item;
298
299 /* Clang already provides these types as built-ins, but only in c++ mode. */
300 #if !defined(__clang__) || !defined(__cplusplus)
301 typedef __uint_least16_t        __char16_t;
302 typedef __uint_least32_t        __char32_t;
303 #endif
304
305 #endif /* !_SYS_TYPES_H_ */