include/sys/types.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 /*      Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */
  22 /*        All Rights Reserved   */
  23
  24
  25 /*
  26  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
  27  * Use is subject to license terms.
  28  *
  29  * Copyright 2013 Nexenta Systems, Inc.  All rights reserved.
  30  * Copyright 2016 Joyent, Inc.
  31  */
  32
  33 #ifndef _SYS_TYPES_H
  34 #define _SYS_TYPES_H
  35
  36 #include <sys/feature_tests.h>
  37 #include <sys/isa_defs.h>
  38
  39 /*
  40  * Machine dependent definitions moved to <sys/machtypes.h>.
  41  */
  42 #include <sys/machtypes.h>
  43
  44 /*
  45  * Include fixed width type declarations proposed by the ISO/JTC1/SC22/WG14 C
  46  * committee's working draft for the revision of the current ISO C standard,
  47  * ISO/IEC 9899:1990 Programming language - C.  These are not currently
  48  * required by any standard but constitute a useful, general purpose set
  49  * of type definitions which is namespace clean with respect to all standards.
  50  */
  51 #ifdef  _KERNEL
  52 #include <sys/inttypes.h>
  53 #else   /* _KERNEL */
  54 #include <sys/int_types.h>
  55 #endif  /* _KERNEL */
  56
  57 #if defined(_KERNEL) || defined(_SYSCALL32)
  58 #include <sys/types32.h>
  59 #endif
  60
  61 #ifdef  __cplusplus
  62 extern "C" {
  63 #endif
  64
  65 typedef long long               longlong_t;
  66 typedef unsigned long long      u_longlong_t;
  67
  68 /*
  69  * These types (t_{u}scalar_t) exist because the XTI/TPI/DLPI standards had
  70  * to use them instead of int32_t and uint32_t because DEC had
  71  * shipped 64-bit wide.
  72  */
  73 typedef int32_t         t_scalar_t;
  74 typedef uint32_t        t_uscalar_t;
  75
  76 /*
  77  * POSIX Extensions
  78  */
  79 typedef unsigned char   uchar_t;
  80 typedef unsigned short  ushort_t;
  81 typedef unsigned int    uint_t;
  82 typedef unsigned long   ulong_t;
  83
  84 typedef char            *caddr_t;       /* ?<core address> type */
  85 typedef long            daddr_t;        /* <disk address> type */
  86 typedef short           cnt_t;          /* ?<count> type */
  87
  88 #if !defined(_PTRDIFF_T) || __cplusplus >= 199711L
  89 #define _PTRDIFF_T
  90 #if defined(_LP64) || defined(_I32LPx)
  91 typedef long    ptrdiff_t;              /* pointer difference */
  92 #else
  93 typedef int     ptrdiff_t;              /* (historical version) */
  94 #endif
  95 #endif
  96
  97 /*
  98  * VM-related types
  99  */
 100 typedef ulong_t         pfn_t;          /* page frame number */
 101 typedef ulong_t         pgcnt_t;        /* number of pages */
 102 typedef long            spgcnt_t;       /* signed number of pages */
 103
 104 typedef uchar_t         use_t;          /* use count for swap.  */
 105 typedef short           sysid_t;
 106 typedef short           index_t;
 107 typedef void            *timeout_id_t;  /* opaque handle from timeout(9F) */
 108 typedef void            *bufcall_id_t;  /* opaque handle from bufcall(9F) */
 109
 110 #ifndef _OFF_T
 111 #define _OFF_T
 112 typedef int64_t         off_t;          /* offsets within files */
 113 typedef off_t           off64_t;        /* compat alias */
 114 #endif /* _OFF_T */
 115
 116 typedef uint64_t        ino_t;          /* expanded inode type  */
 117 typedef int64_t         blkcnt_t;       /* count of file blocks */
 118 typedef uint64_t        fsblkcnt_t;     /* count of file system blocks */
 119 typedef uint64_t        fsfilcnt_t;     /* count of files */
 120
 121 /* compat aliases */
 122 typedef ino_t           ino64_t;
 123 typedef blkcnt_t        blkcnt64_t;
 124 typedef fsblkcnt_t      fsblkcnt64_t;
 125 typedef fsfilcnt_t      fsfilcnt64_t;
 126
 127 typedef int32_t         blksize_t;      /* used for block sizes */
 128
 129 typedef enum { B_FALSE, B_TRUE } boolean_t;
 130
 131 /*
 132  * The {u,}pad64_t types can be used in structures such that those structures
 133  * may be accessed by code produced by compilation environments which don't
 134  * support a 64 bit integral datatype.  The intention is not to allow
 135  * use of these fields in such environments, but to maintain the alignment
 136  * and offsets of the structure.
 137  *
 138  * Similar comments for {u,}pad128_t.
 139  *
 140  * Note that these types do NOT generate any stronger alignment constraints
 141  * than those available in the underlying ABI.  See <sys/isa_defs.h>
 142  */
 143 #if defined(_INT64_TYPE)
 144 typedef int64_t         pad64_t;
 145 typedef uint64_t        upad64_t;
 146 #else
 147 typedef union {
 148         double   _d;
 149         int32_t  _l[2];
 150 } pad64_t;
 151
 152 typedef union {
 153         double   _d;
 154         uint32_t _l[2];
 155 } upad64_t;
 156 #endif
 157
 158 typedef union {
 159         long double     _q;
 160         int32_t         _l[4];
 161 } pad128_t;
 162
 163 typedef union {
 164         long double     _q;
 165         uint32_t        _l[4];
 166 } upad128_t;
 167
 168 typedef off_t           offset_t;
 169 typedef uint64_t        uoff_t;
 170 typedef uint64_t        len_t;
 171 typedef uint64_t        diskaddr_t;
 172 #if (defined(_KERNEL) || defined(_KMEMUSER) || defined(_BOOT))
 173 typedef uint64_t        paddr_t;
 174 #endif
 175
 176 /*
 177  * Definitions remaining from previous partial support for 64-bit file
 178  * offsets.  This partial support for devices greater than 2gb requires
 179  * compiler support for long long.
 180  */
 181 #ifdef _LONG_LONG_LTOH
 182 typedef union {
 183         offset_t        _f;     /* Full 64 bit offset value */
 184         struct {
 185                 int32_t _l;     /* lower 32 bits of offset value */
 186                 int32_t _u;     /* upper 32 bits of offset value */
 187         } _p;
 188 } lloff_t;
 189 #endif
 190
 191 #ifdef _LONG_LONG_HTOL
 192 typedef union {
 193         offset_t        _f;     /* Full 64 bit offset value */
 194         struct {
 195                 int32_t _u;     /* upper 32 bits of offset value */
 196                 int32_t _l;     /* lower 32 bits of offset value */
 197         } _p;
 198 } lloff_t;
 199 #endif
 200
 201 #ifdef _LONG_LONG_LTOH
 202 typedef union {
 203         longlong_t      _f;     /* Full 64 bit disk address value */
 204         struct {
 205                 int32_t _l;     /* lower 32 bits of disk address value */
 206                 int32_t _u;     /* upper 32 bits of disk address value */
 207         } _p;
 208 } lldaddr_t;
 209 #endif
 210
 211 #ifdef _LONG_LONG_HTOL
 212 typedef union {
 213         longlong_t      _f;     /* Full 64 bit disk address value */
 214         struct {
 215                 int32_t _u;     /* upper 32 bits of disk address value */
 216                 int32_t _l;     /* lower 32 bits of disk address value */
 217         } _p;
 218 } lldaddr_t;
 219 #endif
 220
 221 typedef uint_t k_fltset_t;      /* kernel fault set type */
 222
 223 /*
 224  * The following type is for various kinds of identifiers.  The
 225  * actual type must be the same for all since some system calls
 226  * (such as sigsend) take arguments that may be any of these
 227  * types.  The enumeration type idtype_t defined in sys/procset.h
 228  * is used to indicate what type of id is being specified --
 229  * a process id, process group id, session id, scheduling class id,
 230  * user id, group id, project id, task id or zone id.
 231  */
 232 typedef int             id_t;
 233
 234 typedef id_t            lgrp_id_t;      /* lgroup ID */
 235
 236 /*
 237  * Type useconds_t is an unsigned integral type capable of storing
 238  * values at least in the range of zero to 1,000,000.
 239  */
 240 typedef uint_t          useconds_t;     /* Time, in microseconds */
 241
 242 #ifndef _SUSECONDS_T
 243 #define _SUSECONDS_T
 244 typedef long    suseconds_t;    /* signed # of microseconds */
 245 #endif  /* _SUSECONDS_T */
 246
 247 /*
 248  * Typedefs for dev_t components.
 249  */
 250 typedef unsigned int    major_t;        /* major part of device number */
 251 typedef unsigned int    minor_t;        /* minor part of device number */
 252
 253 /*
 254  * The data type of a thread priority.
 255  */
 256 typedef short   pri_t;
 257
 258 /*
 259  * The data type for a CPU flags field.  (Can be extended to larger unsigned
 260  * types, if needed, limited by ability to update atomically.)
 261  */
 262 typedef ushort_t        cpu_flag_t;
 263
 264 /*
 265  * For compatibility reasons the following typedefs (prefixed o_)
 266  * can't grow regardless of the EFT definition. Although,
 267  * applications should not explicitly use these typedefs
 268  * they may be included via a system header definition.
 269  * WARNING: These typedefs may be removed in a future
 270  * release.
 271  *              ex. the definitions in s5inode.h (now obsoleted)
 272  *                      remained small to preserve compatibility
 273  *                      in the S5 file system type.
 274  */
 275 typedef ushort_t o_mode_t;              /* old file attribute type */
 276 typedef short   o_dev_t;                /* old device type      */
 277 typedef ushort_t o_uid_t;               /* old UID type         */
 278 typedef o_uid_t o_gid_t;                /* old GID type         */
 279 typedef short   o_nlink_t;              /* old file link type   */
 280 typedef short   o_pid_t;                /* old process id type  */
 281 typedef ushort_t o_ino_t;               /* old inode type       */
 282
 283
 284 /*
 285  * POSIX and XOPEN Declarations
 286  */
 287 typedef int             key_t;          /* IPC key type         */
 288 typedef uint32_t        mode_t;         /* file attribute type  */
 289
 290 #ifndef _UID_T
 291 #define _UID_T
 292 typedef uint32_t uid_t;                 /* UID type             */
 293 #endif  /* _UID_T */
 294
 295 typedef uid_t   gid_t;                  /* GID type             */
 296
 297 typedef uint32_t        datalink_id_t;
 298 typedef uint32_t        vrid_t;
 299
 300 typedef id_t    taskid_t;
 301 typedef id_t    projid_t;
 302 typedef id_t    poolid_t;
 303 typedef id_t    zoneid_t;
 304 typedef id_t    ctid_t;
 305
 306 /*
 307  * POSIX definitions are same as defined in thread.h and synch.h.
 308  * Any changes made to here should be reflected in corresponding
 309  * files as described in comments.
 310  */
 311 typedef uint_t  pthread_t;      /* = thread_t in thread.h */
 312 typedef uint_t  pthread_key_t;  /* = thread_key_t in thread.h */
 313
 314 /* "Magic numbers" tagging synchronization object types */
 315 #define _MUTEX_MAGIC    0x4d58          /* "MX" */
 316 #define _SEMA_MAGIC     0x534d          /* "SM" */
 317 #define _COND_MAGIC     0x4356          /* "CV" */
 318 #define _RWL_MAGIC      0x5257          /* "RW" */
 319
 320 typedef struct _pthread_mutex {         /* = mutex_t in synch.h */
 321         struct {
 322                 uint16_t        __pthread_mutex_flag1;
 323                 uint8_t         __pthread_mutex_flag2;
 324                 uint8_t         __pthread_mutex_ceiling;
 325                 uint16_t        __pthread_mutex_type;
 326                 uint16_t        __pthread_mutex_magic;
 327         } __pthread_mutex_flags;
 328         union {
 329                 struct {
 330                         uint8_t __pthread_mutex_pad[8];
 331                 } __pthread_mutex_lock64;
 332                 struct {
 333                         uint32_t __pthread_ownerpid;
 334                         uint32_t __pthread_lockword;
 335                 } __pthread_mutex_lock32;
 336                 upad64_t __pthread_mutex_owner64;
 337         } __pthread_mutex_lock;
 338         upad64_t __pthread_mutex_data;
 339 } pthread_mutex_t;
 340
 341 typedef struct _pthread_cond {          /* = cond_t in synch.h */
 342         struct {
 343                 uint8_t         __pthread_cond_flag[4];
 344                 uint16_t        __pthread_cond_type;
 345                 uint16_t        __pthread_cond_magic;
 346         } __pthread_cond_flags;
 347         upad64_t __pthread_cond_data;
 348 } pthread_cond_t;
 349
 350 /*
 351  * UNIX 98 Extension
 352  */
 353 typedef struct _pthread_rwlock {        /* = rwlock_t in synch.h */
 354         int32_t         __pthread_rwlock_readers;
 355         uint16_t        __pthread_rwlock_type;
 356         uint16_t        __pthread_rwlock_magic;
 357         pthread_mutex_t __pthread_rwlock_mutex;
 358         pthread_cond_t  __pthread_rwlock_readercv;
 359         pthread_cond_t  __pthread_rwlock_writercv;
 360 } pthread_rwlock_t;
 361
 362 /*
 363  * SUSV3
 364  */
 365 typedef struct {
 366         uint32_t        __pthread_barrier_count;
 367         uint32_t        __pthread_barrier_current;
 368         upad64_t        __pthread_barrier_cycle;
 369         upad64_t        __pthread_barrier_reserved;
 370         pthread_mutex_t __pthread_barrier_lock;
 371         pthread_cond_t  __pthread_barrier_cond;
 372 } pthread_barrier_t;
 373
 374 typedef pthread_mutex_t pthread_spinlock_t;
 375
 376 /*
 377  * attributes for threads, dynamically allocated by library
 378  */
 379 typedef struct _pthread_attr {
 380         void    *__pthread_attrp;
 381 } pthread_attr_t;
 382
 383 /*
 384  * attributes for mutex, dynamically allocated by library
 385  */
 386 typedef struct _pthread_mutexattr {
 387         void    *__pthread_mutexattrp;
 388 } pthread_mutexattr_t;
 389
 390 /*
 391  * attributes for cond, dynamically allocated by library
 392  */
 393 typedef struct _pthread_condattr {
 394         void    *__pthread_condattrp;
 395 } pthread_condattr_t;
 396
 397 /*
 398  * pthread_once
 399  */
 400 typedef struct _once {
 401         upad64_t        __pthread_once_pad[4];
 402 } pthread_once_t;
 403
 404 /*
 405  * UNIX 98 Extensions
 406  * attributes for rwlock, dynamically allocated by library
 407  */
 408 typedef struct _pthread_rwlockattr {
 409         void    *__pthread_rwlockattrp;
 410 } pthread_rwlockattr_t;
 411
 412 /*
 413  * SUSV3
 414  * attributes for pthread_barrier_t, dynamically allocated by library
 415  */
 416 typedef struct {
 417         void    *__pthread_barrierattrp;
 418 } pthread_barrierattr_t;
 419
 420 typedef ulong_t dev_t;                  /* expanded device type */
 421
 422 typedef uint32_t nlink_t;               /* file link type       */
 423 typedef int pid_t;                      /* process id type      */
 424
 425 #if !defined(_SIZE_T) || __cplusplus >= 199711L
 426 #define _SIZE_T
 427 #if defined(_LP64) || defined(_I32LPx)
 428 typedef ulong_t size_t;         /* size of something in bytes */
 429 #else
 430 typedef uint_t  size_t;         /* (historical version) */
 431 #endif
 432 #endif  /* _SIZE_T */
 433
 434 #ifndef _SSIZE_T
 435 #define _SSIZE_T
 436 #if defined(_LP64) || defined(_I32LPx)
 437 typedef long    ssize_t;        /* size of something in bytes or -1 */
 438 #else
 439 typedef int     ssize_t;        /* (historical version) */
 440 #endif
 441 #endif  /* _SSIZE_T */
 442
 443 #if !defined(_TIME_T) || __cplusplus >= 199711L
 444 #define _TIME_T
 445 typedef long            time_t; /* time of day in seconds */
 446 #endif  /* _TIME_T */
 447
 448 #if !defined(_CLOCK_T) || __cplusplus >= 199711L
 449 #define _CLOCK_T
 450 typedef long            clock_t; /* relative time in a specified resolution */
 451 #endif  /* ifndef _CLOCK_T */
 452
 453 #ifndef _CLOCKID_T
 454 #define _CLOCKID_T
 455 typedef int     clockid_t;      /* clock identifier type */
 456 #endif  /* ifndef _CLOCKID_T */
 457
 458 #ifndef _TIMER_T
 459 #define _TIMER_T
 460 typedef int     timer_t;        /* timer identifier type */
 461 #endif  /* ifndef _TIMER_T */
 462
 463 #if !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__)
 464
 465 /* BEGIN CSTYLED */
 466 typedef unsigned char   unchar;
 467 typedef unsigned short  ushort;
 468 typedef unsigned int    uint;
 469 typedef unsigned long   ulong;
 470 /* END CSTYLED */
 471
 472 #if defined(_KERNEL)
 473
 474 #define SHRT_MIN        (-32768)        /* min value of a "short int" */
 475 #define SHRT_MAX        32767           /* max value of a "short int" */
 476 #define USHRT_MAX       65535           /* max of "unsigned short int" */
 477 #define INT_MIN         (-2147483647-1) /* min value of an "int" */
 478 #define INT_MAX         2147483647      /* max value of an "int" */
 479 #define UINT_MAX        4294967295U     /* max value of an "unsigned int" */
 480 #if defined(_LP64)
 481 #define LONG_MIN        (-9223372036854775807L-1L)
 482                                         /* min value of a "long int" */
 483 #define LONG_MAX        9223372036854775807L
 484                                         /* max value of a "long int" */
 485 #define ULONG_MAX       18446744073709551615UL
 486                                         /* max of "unsigned long int" */
 487 #else /* _ILP32 */
 488 #define LONG_MIN        (-2147483647L-1L)
 489                                         /* min value of a "long int" */
 490 #define LONG_MAX        2147483647L     /* max value of a "long int" */
 491 #define ULONG_MAX       4294967295UL    /* max of "unsigned long int" */
 492 #endif
 493
 494 #define LLONG_MIN       (-9223372036854775807LL-1LL)
 495                                         /* min of "long long int" */
 496 #define LLONG_MAX       9223372036854775807LL
 497                                         /* max of "long long int" */
 498 #define ULLONG_MAX      18446744073709551615ULL
 499                                         /* max of "unsigned long long int" */
 500
 501 #define OFF_MIN         LLONG_MIN
 502 #define OFF_MAX         LLONG_MAX
 503
 504 #endif  /* defined(_KERNEL) */
 505
 506 #define P_MYPID ((pid_t)0)
 507
 508 /*
 509  * The following is the value of type id_t to use to indicate the
 510  * caller's current id.  See procset.h for the type idtype_t
 511  * which defines which kind of id is being specified.
 512  */
 513 #define P_MYID  (-1)
 514 #define NOPID (pid_t)(-1)
 515
 516 #ifndef NODEV
 517 #define NODEV   (dev_t)(-1l)
 518 #ifdef _SYSCALL32
 519 #define NODEV32 (dev32_t)(-1)
 520 #endif  /* _SYSCALL32 */
 521 #endif  /* NODEV */
 522
 523 /*
 524  * The following value of type pfn_t is used to indicate
 525  * invalid page frame number.
 526  */
 527 #define PFN_INVALID     ((pfn_t)-1)
 528 #define PFN_SUSPENDED   ((pfn_t)-2)
 529
 530 /* BEGIN CSTYLED */
 531 typedef unsigned char   u_char;
 532 typedef unsigned short  u_short;
 533 typedef unsigned int    u_int;
 534 typedef unsigned long   u_long;
 535 typedef struct _quad { int val[2]; } quad_t;    /* used by UFS */
 536 typedef quad_t          quad;                   /* used by UFS */
 537 /* END CSTYLED */
 538
 539 /*
 540  * Nested include for BSD/sockets source compatibility.
 541  * (The select macros used to be defined here).
 542  */
 543 #include <sys/select.h>
 544
 545 #endif  /* !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__) */
 546
 547 /*
 548  * _VOID was defined to be either void or char but this is not
 549  * required because previous SunOS compilers have accepted the void
 550  * type. However, because many system header and source files use the
 551  * void keyword, the volatile keyword, and ANSI C function prototypes,
 552  * non-ANSI compilers cannot compile the system anyway. The _VOID macro
 553  * should therefore not be used and remains for source compatibility
 554  * only.
 555  */
 556 /* CSTYLED */
 557 #define _VOID   void
 558
 559 #ifdef  __cplusplus
 560 }
 561 #endif
 562
 563 #endif  /* _SYS_TYPES_H */