sys/sys/types.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1982, 1986, 1991, 1993, 1994
   5  *      The Regents of the University of California.  All rights reserved.
   6  * (c) UNIX System Laboratories, Inc.
   7  * All or some portions of this file are derived from material licensed
   8  * to the University of California by American Telephone and Telegraph
   9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
  10  * the permission of UNIX System Laboratories, Inc.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)types.h     8.6 (Berkeley) 2/19/95
  37  */
  38
  39 #ifndef _SYS_TYPES_H_
  40 #define _SYS_TYPES_H_
  41
  42 #include <sys/cdefs.h>
  43
  44 /* Machine type dependent parameters. */
  45 #include <machine/endian.h>
  46 #include <sys/_types.h>
  47
  48 #include <sys/_pthreadtypes.h>
  49
  50 #if __BSD_VISIBLE
  51 typedef unsigned char   u_char;
  52 typedef unsigned short  u_short;
  53 typedef unsigned int    u_int;
  54 typedef unsigned long   u_long;
  55 #ifndef _KERNEL
  56 typedef unsigned short  ushort;         /* Sys V compatibility */
  57 typedef unsigned int    uint;           /* Sys V compatibility */
  58 #endif
  59 #endif
  60
  61 /*
  62  * XXX POSIX sized integrals that should appear only in <sys/stdint.h>.
  63  */
  64 #include <sys/_stdint.h>
  65
  66 typedef __uint8_t       u_int8_t;       /* unsigned integrals (deprecated) */
  67 typedef __uint16_t      u_int16_t;
  68 typedef __uint32_t      u_int32_t;
  69 typedef __uint64_t      u_int64_t;
  70
  71 typedef __uint64_t      u_quad_t;       /* quads (deprecated) */
  72 typedef __int64_t       quad_t;
  73 typedef quad_t *        qaddr_t;
  74
  75 typedef char *          caddr_t;        /* core address */
  76 typedef const char *    c_caddr_t;      /* core address, pointer to const */
  77
  78 #ifndef _BLKSIZE_T_DECLARED
  79 typedef __blksize_t     blksize_t;
  80 #define _BLKSIZE_T_DECLARED
  81 #endif
  82
  83 typedef __cpuwhich_t    cpuwhich_t;
  84 typedef __cpulevel_t    cpulevel_t;
  85 typedef __cpusetid_t    cpusetid_t;
  86
  87 #ifndef _BLKCNT_T_DECLARED
  88 typedef __blkcnt_t      blkcnt_t;
  89 #define _BLKCNT_T_DECLARED
  90 #endif
  91
  92 #ifndef _CLOCK_T_DECLARED
  93 typedef __clock_t       clock_t;
  94 #define _CLOCK_T_DECLARED
  95 #endif
  96
  97 #ifndef _CLOCKID_T_DECLARED
  98 typedef __clockid_t     clockid_t;
  99 #define _CLOCKID_T_DECLARED
 100 #endif
 101
 102 typedef __critical_t    critical_t;     /* Critical section value */
 103 typedef __daddr_t       daddr_t;        /* disk address */
 104
 105 #ifndef _DEV_T_DECLARED
 106 typedef __dev_t         dev_t;          /* device number or struct cdev */
 107 #define _DEV_T_DECLARED
 108 #endif
 109
 110 #ifndef _FFLAGS_T_DECLARED
 111 typedef __fflags_t      fflags_t;       /* file flags */
 112 #define _FFLAGS_T_DECLARED
 113 #endif
 114
 115 typedef __fixpt_t       fixpt_t;        /* fixed point number */
 116
 117 #ifndef _FSBLKCNT_T_DECLARED            /* for statvfs() */
 118 typedef __fsblkcnt_t    fsblkcnt_t;
 119 typedef __fsfilcnt_t    fsfilcnt_t;
 120 #define _FSBLKCNT_T_DECLARED
 121 #endif
 122
 123 #ifndef _GID_T_DECLARED
 124 typedef __gid_t         gid_t;          /* group id */
 125 #define _GID_T_DECLARED
 126 #endif
 127
 128 #ifndef _IN_ADDR_T_DECLARED
 129 typedef __uint32_t      in_addr_t;      /* base type for internet address */
 130 #define _IN_ADDR_T_DECLARED
 131 #endif
 132
 133 #ifndef _IN_PORT_T_DECLARED
 134 typedef __uint16_t      in_port_t;
 135 #define _IN_PORT_T_DECLARED
 136 #endif
 137
 138 #ifndef _ID_T_DECLARED
 139 typedef __id_t          id_t;           /* can hold a uid_t or pid_t */
 140 #define _ID_T_DECLARED
 141 #endif
 142
 143 #ifndef _INO_T_DECLARED
 144 typedef __ino_t         ino_t;          /* inode number */
 145 #define _INO_T_DECLARED
 146 #endif
 147
 148 #ifndef _KEY_T_DECLARED
 149 typedef __key_t         key_t;          /* IPC key (for Sys V IPC) */
 150 #define _KEY_T_DECLARED
 151 #endif
 152
 153 #ifndef _LWPID_T_DECLARED
 154 typedef __lwpid_t       lwpid_t;        /* Thread ID (a.k.a. LWP) */
 155 #define _LWPID_T_DECLARED
 156 #endif
 157
 158 #ifndef _MODE_T_DECLARED
 159 typedef __mode_t        mode_t;         /* permissions */
 160 #define _MODE_T_DECLARED
 161 #endif
 162
 163 #ifndef _ACCMODE_T_DECLARED
 164 typedef __accmode_t     accmode_t;      /* access permissions */
 165 #define _ACCMODE_T_DECLARED
 166 #endif
 167
 168 #ifndef _NLINK_T_DECLARED
 169 typedef __nlink_t       nlink_t;        /* link count */
 170 #define _NLINK_T_DECLARED
 171 #endif
 172
 173 #ifndef _OFF_T_DECLARED
 174 typedef __off_t         off_t;          /* file offset */
 175 #define _OFF_T_DECLARED
 176 #endif
 177
 178 #ifndef _OFF64_T_DECLARED
 179 typedef __off64_t       off64_t;        /* file offset (alias) */
 180 #define _OFF64_T_DECLARED
 181 #endif
 182
 183 #ifndef _PID_T_DECLARED
 184 typedef __pid_t         pid_t;          /* process id */
 185 #define _PID_T_DECLARED
 186 #endif
 187
 188 typedef __register_t    register_t;
 189
 190 #ifndef _RLIM_T_DECLARED
 191 typedef __rlim_t        rlim_t;         /* resource limit */
 192 #define _RLIM_T_DECLARED
 193 #endif
 194
 195 typedef __sbintime_t    sbintime_t;
 196
 197 typedef __segsz_t       segsz_t;        /* segment size (in pages) */
 198
 199 #ifndef _SIZE_T_DECLARED
 200 typedef __size_t        size_t;
 201 #define _SIZE_T_DECLARED
 202 #endif
 203
 204 #ifndef _SSIZE_T_DECLARED
 205 typedef __ssize_t       ssize_t;
 206 #define _SSIZE_T_DECLARED
 207 #endif
 208
 209 #ifndef _SUSECONDS_T_DECLARED
 210 typedef __suseconds_t   suseconds_t;    /* microseconds (signed) */
 211 #define _SUSECONDS_T_DECLARED
 212 #endif
 213
 214 #ifndef _TIME_T_DECLARED
 215 typedef __time_t        time_t;
 216 #define _TIME_T_DECLARED
 217 #endif
 218
 219 #ifndef _TIMER_T_DECLARED
 220 typedef __timer_t       timer_t;
 221 #define _TIMER_T_DECLARED
 222 #endif
 223
 224 #ifndef _MQD_T_DECLARED
 225 typedef __mqd_t mqd_t;
 226 #define _MQD_T_DECLARED
 227 #endif
 228
 229 typedef __u_register_t  u_register_t;
 230
 231 #ifndef _UID_T_DECLARED
 232 typedef __uid_t         uid_t;          /* user id */
 233 #define _UID_T_DECLARED
 234 #endif
 235
 236 #ifndef _USECONDS_T_DECLARED
 237 typedef __useconds_t    useconds_t;     /* microseconds (unsigned) */
 238 #define _USECONDS_T_DECLARED
 239 #endif
 240
 241 #ifndef _CAP_IOCTL_T_DECLARED
 242 #define _CAP_IOCTL_T_DECLARED
 243 typedef unsigned long   cap_ioctl_t;
 244 #endif
 245
 246 #ifndef _CAP_RIGHTS_T_DECLARED
 247 #define _CAP_RIGHTS_T_DECLARED
 248 struct cap_rights;
 249
 250 typedef struct cap_rights       cap_rights_t;
 251 #endif
 252
 253 /*
 254  * Types suitable for exporting physical addresses, virtual addresses
 255  * (pointers), and memory object sizes from the kernel independent of native
 256  * word size.  These should be used in place of vm_paddr_t, (u)intptr_t, and
 257  * size_t in structs which contain such types that are shared with userspace.
 258  */
 259 typedef __uint64_t      kpaddr_t;
 260 typedef __uint64_t      kvaddr_t;
 261 typedef __uint64_t      ksize_t;
 262 typedef __int64_t       kssize_t;
 263
 264 typedef __vm_offset_t   vm_offset_t;
 265 typedef __uint64_t      vm_ooffset_t;
 266 typedef __vm_paddr_t    vm_paddr_t;
 267 typedef __uint64_t      vm_pindex_t;
 268 typedef __vm_size_t     vm_size_t;
 269
 270 typedef __rman_res_t    rman_res_t;
 271
 272 typedef __register_t    syscallarg_t;
 273
 274 #ifdef _KERNEL
 275 typedef unsigned int    boolean_t;
 276 typedef struct _device  *device_t;
 277 typedef __intfptr_t     intfptr_t;
 278
 279 /*
 280  * XXX this is fixed width for historical reasons.  It should have had type
 281  * __int_fast32_t.  Fixed-width types should not be used unless binary
 282  * compatibility is essential.  Least-width types should be used even less
 283  * since they provide smaller benefits.
 284  *
 285  * XXX should be MD.
 286  *
 287  * XXX this is bogus in -current, but still used for spl*().
 288  */
 289 typedef __uint32_t      intrmask_t;     /* Interrupt mask (spl, xxx_imask...) */
 290
 291 typedef __uintfptr_t    uintfptr_t;
 292 typedef __uint64_t      uoff_t;
 293 typedef char            vm_memattr_t;   /* memory attribute codes */
 294 typedef struct vm_page  *vm_page_t;
 295
 296 #define offsetof(type, field) __offsetof(type, field)
 297 #endif /* _KERNEL */
 298
 299 #if     defined(_KERNEL) || defined(_STANDALONE)
 300 #if !defined(__bool_true_false_are_defined) && !defined(__cplusplus)
 301 #define __bool_true_false_are_defined   1
 302 #define false   0
 303 #define true    1
 304 typedef _Bool   bool;
 305 #endif /* !__bool_true_false_are_defined && !__cplusplus */
 306 #endif /* KERNEL || _STANDALONE */
 307
 308 /*
 309  * The following are all things that really shouldn't exist in this header,
 310  * since its purpose is to provide typedefs, not miscellaneous doodads.
 311  */
 312 #include <sys/bitcount.h>
 313
 314 #if __BSD_VISIBLE
 315
 316 #include <sys/select.h>
 317
 318 /*
 319  * The major and minor numbers are encoded in dev_t as MMMmmmMm (where
 320  * letters correspond to bytes).  The encoding of the lower 4 bytes is
 321  * constrained by compatibility with 16-bit and 32-bit dev_t's.  The
 322  * encoding of of the upper 4 bytes is the least unnatural one consistent
 323  * with this and other constraints.  Also, the decoding of the m bytes by
 324  * minor() is unnatural to maximize compatibility subject to not discarding
 325  * bits.  The upper m byte is shifted into the position of the lower M byte
 326  * instead of shifting 3 upper m bytes to close the gap.  Compatibility for
 327  * minor() is achieved iff the upper m byte is 0.
 328  */
 329 #define major(d)        __major(d)
 330 static __inline int
 331 __major(dev_t _d)
 332 {
 333         return (((_d >> 32) & 0xffffff00) | ((_d >> 8) & 0xff));
 334 }
 335 #define minor(d)        __minor(d)
 336 static __inline int
 337 __minor(dev_t _d)
 338 {
 339         return (((_d >> 24) & 0xff00) | (_d & 0xffff00ff));
 340 }
 341 #define makedev(M, m)   __makedev((M), (m))
 342 static __inline dev_t
 343 __makedev(int _Major, int _Minor)
 344 {
 345         return (((dev_t)(_Major & 0xffffff00) << 32) | ((_Major & 0xff) << 8) |
 346             ((dev_t)(_Minor & 0xff00) << 24) | (_Minor & 0xffff00ff));
 347 }
 348
 349 #if (defined(__clang__) || (defined(__GNUC__) && __GNUC__ >= 13))
 350 #define __enum_uint8_decl(name) enum enum_ ## name ## _uint8 : uint8_t
 351 #define __enum_uint8(name)      enum enum_ ## name ## _uint8
 352 #else
 353 /*
 354  * Note: there is no real size checking here, but the code below can be
 355  * removed once we require GCC 13.
 356  */
 357 #define __enum_uint8_decl(name) enum __attribute__((packed)) enum_ ## name ## _uint8
 358 #define __enum_uint8(name)      enum __attribute__((packed)) enum_ ## name ## _uint8
 359 #endif
 360
 361 /*
 362  * These declarations belong elsewhere, but are repeated here and in
 363  * <stdio.h> to give broken programs a better chance of working with
 364  * 64-bit off_t's.
 365  */
 366 #ifndef _KERNEL
 367 __BEGIN_DECLS
 368 #ifndef _FTRUNCATE_DECLARED
 369 #define _FTRUNCATE_DECLARED
 370 int      ftruncate(int, off_t);
 371 #endif
 372 #ifndef _LSEEK_DECLARED
 373 #define _LSEEK_DECLARED
 374 off_t    lseek(int, off_t, int);
 375 #endif
 376 #ifndef _MMAP_DECLARED
 377 #define _MMAP_DECLARED
 378 void *   mmap(void *, size_t, int, int, int, off_t);
 379 #endif
 380 #ifndef _TRUNCATE_DECLARED
 381 #define _TRUNCATE_DECLARED
 382 int      truncate(const char *, off_t);
 383 #endif
 384 __END_DECLS
 385 #endif /* !_KERNEL */
 386
 387 #endif /* __BSD_VISIBLE */
 388
 389 #endif /* !_SYS_TYPES_H_ */