root/usr/src/uts/common/sys/param.h
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright 2014 Nexenta Systems, Inc.  All rights reserved.
 * Copyright (c) 1998, 2010, Oracle and/or its affiliates. All rights reserved.
 */

/*      Copyright (c) 1983, 1984, 1985, 1986, 1987, 1988, 1989 AT&T     */
/*        All Rights Reserved   */

/*
 * University Copyright- Copyright (c) 1982, 1986, 1988
 * The Regents of the University of California
 * All Rights Reserved
 *
 * University Acknowledgment- Portions of this document are derived from
 * software developed by the University of California, Berkeley, and its
 * contributors.
 */

#ifndef _SYS_PARAM_H
#define _SYS_PARAM_H

#ifndef _ASM            /* Avoid typedef headaches for assembly files */
#include <sys/types.h>
#include <sys/isa_defs.h>
#endif /* _ASM */

#include <sys/null.h>

#ifdef  __cplusplus
extern "C" {
#endif

/*
 * Fundamental variables; don't change too often.
 */

/*
 * _POSIX_VDISABLE has historically been defined in <sys/param.h> since
 * an early merge with AT&T source.  It has also historically been defined
 * in <sys/termios.h>. The POSIX standard, IEEE Std. 1003.1-1988 initially
 * required the existence of _POSIX_VDISABLE in <sys/termios.h>.
 * Subsequent versions of the IEEE Standard as well as the X/Open
 * specifications required that _POSIX_VDISABLE be defined in <unistd.h>
 * while still allowing for it's existence in other headers.  With the
 * introduction of XPG6, _POSIX_VDISABLE can only be defined in <unistd.h>.
 */
#if !defined(_XPG6) || defined(__EXTENSIONS__)
#ifndef _POSIX_VDISABLE
#define _POSIX_VDISABLE 0       /* Disable special character functions */
#endif
#endif /* !defined(_XPG6) || defined(__EXTENSIONS__) */

/* The actual size of the TTY input queue */
#define _TTY_BUFSIZ     2048

/*
 * These defines all have their historical value.  The actual size of the tty
 * buffer both for the line-editor in ldterm, and in general, is above as
 * _TTY_BUFSIZ.
 *
 * We leave these defines at their historical value to match the behaviour of
 * BSD and Linux.
 */
#ifndef MAX_INPUT
#define MAX_INPUT       512     /* Maximum bytes stored in the input queue */
#endif
#ifndef MAX_CANON
#define MAX_CANON       256     /* Maximum bytes for canonical processing */
#endif
#define CANBSIZ         256     /* max size of typewriter line  */


#define UID_NOBODY      60001   /* user ID no body */
#define GID_NOBODY      UID_NOBODY
#define UID_UNKNOWN     96
#define GID_UNKNOWN     UID_UNKNOWN
#define UID_DLADM       15
#define UID_NETADM      16
#define GID_NETADM      65
#define UID_NOACCESS    60002   /* user ID no access */

#ifdef _KERNEL
#define MAX_TASKID      999999
#define MAX_MAXPID      999999
#define MAXEPHUID       0xfffffffcu     /* max ephemeral user id */

#define FAMOUS_PID_SCHED        0
#define FAMOUS_PID_INIT         1
#define FAMOUS_PID_PAGEOUT      2
#define FAMOUS_PID_FSFLUSH      3
#define FAMOUS_PIDS             4
#endif

#ifdef DEBUG
#define DEFAULT_MAXPID  999999
#define DEFAULT_JUMPPID 100000
#else
#define DEFAULT_MAXPID  30000
#define DEFAULT_JUMPPID 0
#endif

#define MAXUID          2147483647      /* max user id */

#define MAXPROJID       MAXUID          /* max project id */
#define MAXLINK         32767   /* max links */

#define MINEPHUID       0x80000000u     /* min ephemeral user id */

#define NMOUNT          40      /* est. of # mountable fs for quota calc */

#define NOFILE          20      /* this define is here for      */
                                /* compatibility purposes only  */
                                /* and will be removed in a     */
                                /* later release                */

/*
 * These define the maximum and minimum allowable values of the
 * configurable parameter NGROUPS_MAX.
 */
#define NGROUPS_UMIN    0
#define NGROUPS_UMAX    1024
#define NGROUPS_OLDMAX  32

/*
 * NGROUPS_MAX_DEFAULT: *MUST* match NGROUPS_MAX value in limits.h.
 */
#define NGROUPS_MAX_DEFAULT     16

/*
 * Default process priority.  Keep it in sync with limits.h.
 */
#define NZERO   20

/*
 * Fundamental constants of the implementation--cannot be changed easily.
 */

#if !defined(_ASM)
#define NBPW    sizeof (int)    /* number of bytes in an integer */
#endif  /* _ASM */

#define CMASK   022             /* default mask for file creation */
#define CDLIMIT (1L<<11)        /* default max write address */
#define NBPS            0x20000 /* Number of bytes per segment */
#define NBPSCTR         512     /* Bytes per disk sector.       */
#define UBSIZE          512     /* unix block size.             */
#define SCTRSHFT        9       /* Shift for BPSECT.            */

#ifdef _LITTLE_ENDIAN
#define lobyte(X)       (((unsigned char *)&(X))[0])
#define hibyte(X)       (((unsigned char *)&(X))[1])
#define loword(X)       (((ushort_t *)&(X))[0])
#define hiword(X)       (((ushort_t *)&(X))[1])
#endif
#ifdef _BIG_ENDIAN
#define lobyte(X)       (((unsigned char *)&(X))[1])
#define hibyte(X)       (((unsigned char *)&(X))[0])
#define loword(X)       (((ushort_t *)&(X))[1])
#define hiword(X)       (((ushort_t *)&(X))[0])
#endif

/* REMOTE -- whether machine is primary, secondary, or regular */
#define SYSNAME 9               /* # chars in system name */
#define PREMOTE 39

/*
 * MAXPATHLEN defines the longest permissible path length,
 * including the terminating null, after expanding symbolic links.
 * TYPICALMAXPATHLEN is used in a few places as an optimization
 * with a local buffer on the stack to avoid kmem_alloc().
 * MAXSYMLINKS defines the maximum number of symbolic links
 * that may be expanded in a path name. It should be set high
 * enough to allow all legitimate uses, but halt infinite loops
 * reasonably quickly.
 * MAXNAMELEN is the length (including the terminating null) of
 * the longest permissible file (component) name.
 */
#define MAXPATHLEN      1024
#define TYPICALMAXPATHLEN       64
#define MAXSYMLINKS     20
#define MAXNAMELEN      256

/*
 * MAXLINKNAMELEN defines the longest possible permitted datalink name,
 * including the terminating NUL.  Note that this must not be larger
 * than related networking constants such as LIFNAMSIZ.
 */
#define MAXLINKNAMELEN  32

#ifndef NADDR
#define NADDR 13
#endif

/*
 * The following are defined to be the same as
 * defined in /usr/include/limits.h.  They are
 * needed for pipe and FIFO compatibility.
 */
#ifndef PIPE_BUF        /* max # bytes atomic in write to a pipe */
#define PIPE_BUF        5120
#endif  /* PIPE_BUF */

#ifndef PIPE_MAX        /* max # bytes written to a pipe in a write */
#define PIPE_MAX        5120
#endif  /* PIPE_MAX */

#ifndef NBBY
#define NBBY    8                       /* number of bits per byte */
#endif

/* macros replacing interleaving functions */
#define dkblock(bp)     ((bp)->b_blkno)
#define dkunit(bp)      (minor((bp)->b_dev) >> 3)

/*
 * File system parameters and macros.
 *
 * The file system is made out of blocks of at most MAXBSIZE units,
 * with smaller units (fragments) only in the last direct block.
 * MAXBSIZE primarily determines the size of buffers in the buffer
 * pool. It may be made larger without any effect on existing
 * file systems; however making it smaller make make some file
 * systems unmountable.
 *
 * Note that the blocked devices are assumed to have DEV_BSIZE
 * "sectors" and that fragments must be some multiple of this size.
 */
#define MAXBSIZE        8192
#define DEV_BSIZE       512
#define DEV_BSHIFT      9               /* log2(DEV_BSIZE) */
#define MAXFRAG         8
#ifdef  _SYSCALL32
#define MAXOFF32_T      0x7fffffff
#endif
#ifdef  _LP64
#define MAXOFF_T        0x7fffffffffffffffl
#define MAXOFFSET_T     0x7fffffffffffffffl
#else
#define MAXOFF_T        0x7fffffffl
#ifdef _LONGLONG_TYPE
#define MAXOFFSET_T     0x7fffffffffffffffLL
#else
#define MAXOFFSET_T     0x7fffffff
#endif
#endif  /* _LP64 */

#define btodb(bytes)                    /* calculates (bytes / DEV_BSIZE) */ \
        ((unsigned long)(bytes) >> DEV_BSHIFT)
#define dbtob(db)                       /* calculates (db * DEV_BSIZE) */ \
        ((unsigned long)(db) << DEV_BSHIFT)

/*      64 bit versions of btodb and dbtob */
#define lbtodb(bytes)                   /* calculates (bytes / DEV_BSIZE) */ \
        ((u_offset_t)(bytes) >> DEV_BSHIFT)
#define ldbtob(db)                      /* calculates (db * DEV_BSIZE) */ \
        ((u_offset_t)(db) << DEV_BSHIFT)

#ifndef _ASM    /* Avoid typedef headaches for assembly files */
#ifndef NODEV
#define NODEV   (dev_t)(-1l)
#ifdef _SYSCALL32
#define NODEV32 (dev32_t)(-1)
#endif  /* _SYSCALL32 */
#endif  /* NODEV */
#endif  /* _ASM */

/*
 * Size of arg list passed in by user.
 */
#define NCARGS32        0x100000
#define NCARGS64        0x200000
#ifdef  _LP64
#define NCARGS          NCARGS64
#else   /* _LP64 */
#define NCARGS          NCARGS32
#endif  /* _LP64 */

/*
 * Scale factor for scaled integers used to count
 * %cpu time and load averages.
 */
#define FSHIFT  8               /* bits to right of fixed binary point */
#define FSCALE  (1<<FSHIFT)

/*
 * Delay units are in microseconds.
 *
 * XXX  These macros are not part of the DDI!
 */
#if defined(_KERNEL) && !defined(_ASM)
extern void drv_usecwait(clock_t);
#define DELAY(n)        drv_usecwait(n)
#define CDELAY(c, n)    \
{ \
        register int N = n; \
        while (--N > 0) { \
                if (c) \
                        break; \
                drv_usecwait(1); \
        } \
}
#endif  /* defined(_KERNEL) && !defined(_ASM) */

#ifdef  __cplusplus
}
#endif

/*
 * The following is to free utilities from machine dependencies within
 * an architecture. Must be included after definition of DEV_BSIZE.
 */

#if defined(_KERNEL) || defined(_KMEMUSER) || defined(_BOOT)

#if defined(_MACHDEP)
#include <sys/machparam.h>
#endif

#ifdef  __cplusplus
extern "C" {
#endif

#if defined(_KERNEL) && !defined(_ASM)
extern int cpu_decay_factor;
extern pid_t maxpid;
extern pid_t jump_pid;

extern uintptr_t _kernelbase;
extern uintptr_t _userlimit;
extern uintptr_t _userlimit32;
#endif  /* defined(_KERNEL) && !defined(_ASM) */

/*
 * These three variables have been added within the #if defined(lint)
 * below to ensure visibility to lint. This is a short term workaround
 * to handle poor interaction between SS12 lint and these variables.
 * CR 6742611 has been logged to address these issues.
 */
#if defined(lint)
extern int snooping;
extern uint_t snoop_interval;
extern const unsigned int _pageshift;
#endif  /* lint */

#if !defined(_MACHDEP)

/*
 * Implementation architecture independent sections of the kernel use
 * this section.
 */
#if defined(_KERNEL) && !defined(_ASM)
extern int hz;
extern int snooping;
extern uint_t snoop_interval;
extern const unsigned long _pagesize;
extern const unsigned int _pageshift;
extern const unsigned long _pageoffset;
extern const unsigned long long _pagemask;
extern const unsigned long _mmu_pagesize;
extern const unsigned int _mmu_pageshift;
extern const unsigned long _mmu_pageoffset;
extern const unsigned long _mmu_pagemask;
extern const unsigned long _defaultstksz;
extern const unsigned int _nbpg;
extern const int _ncpu;
extern const int _ncpu_log2;
extern const int _ncpu_p2;
extern const int _clsize;
#endif  /* defined(_KERNEL) && !defined(_ASM) */

/* Any additions to these #defines must be reflected in mdb_param.h+mdb_ks.c */
#define PAGESIZE        _pagesize
#define PAGESHIFT       _pageshift
#define PAGEOFFSET      _pageoffset
#define PAGEMASK        _pagemask
#define MMU_PAGESIZE    _mmu_pagesize
#define MMU_PAGESHIFT   _mmu_pageshift
#define MMU_PAGEOFFSET  _mmu_pageoffset
#define MMU_PAGEMASK    _mmu_pagemask

#define KERNELBASE      _kernelbase
#define USERLIMIT       _userlimit
#define USERLIMIT32     _userlimit32
#define DEFAULTSTKSZ    _defaultstksz
#define NCPU            _ncpu
#define NCPU_LOG2       _ncpu_log2
#define NCPU_P2         _ncpu_p2

#endif  /* defined(_MACHDEP) */

/*
 * Some random macros for units conversion.
 *
 * These are machine independent but contain constants (*PAGESHIFT) which
 * are only defined in the machine dependent file.
 */

/*
 * MMU pages to bytes, and back (with and without rounding)
 */
#define mmu_ptob(x)     ((x) << MMU_PAGESHIFT)
#define mmu_btop(x)     (((x)) >> MMU_PAGESHIFT)
#define mmu_btopr(x)    ((((x) + MMU_PAGEOFFSET) >> MMU_PAGESHIFT))

/*
 * 2 versions of pages to disk blocks
 */
#define mmu_ptod(x)     ((x) << (MMU_PAGESHIFT - DEV_BSHIFT))
#define ptod(x)         ((x) << (PAGESHIFT - DEV_BSHIFT))

/*
 * pages to bytes, and back (with and without rounding)
 * Large Files: The explicit cast of x to unsigned int is deliberately
 * removed as part of large files work. We pass longlong values to
 * theses macros.
 *
 * Cast the input to ptob() to be a page count. This enforces 64-bit
 * math on 64-bit kernels. For 32-bit kernels, callers must explicitly
 * cast the input to be a 64-bit type if values greater than 4GB/PAGESIZE
 * are possible.
 */

#ifdef _LP64
#define ptob(x)         (((pgcnt_t)(x)) << PAGESHIFT)
#else
#define ptob(x)         ((x) << PAGESHIFT)
#endif /* _LP64 */
#define btop(x)         (((x) >> PAGESHIFT))
#define btopr(x)        ((((x) + PAGEOFFSET) >> PAGESHIFT))

/*
 * disk blocks to pages, rounded and truncated
 */
#define NDPP            (PAGESIZE/DEV_BSIZE)    /* # of disk blocks per page */
#define dtop(DD)        (((DD) + NDPP - 1) >> (PAGESHIFT - DEV_BSHIFT))
#define dtopt(DD)       ((DD) >> (PAGESHIFT - DEV_BSHIFT))

/*
 * kB to pages and back
 */
#define kbtop(x)        ((x) >> (PAGESHIFT - 10))
#define ptokb(x)        ((x) << (PAGESHIFT - 10))

/*
 * POSIX.4 related configuration parameters
 */
#define _AIO_LISTIO_MAX         (4096)
#define _AIO_MAX                (-1)
#define _MQ_OPEN_MAX            (-1)
#define _MQ_PRIO_MAX            (32)
#define _SEM_NSEMS_MAX          INT_MAX
#define _SEM_VALUE_MAX          INT_MAX

#ifdef  __cplusplus
}
#endif

#else   /* defined(_KERNEL) || defined(_KMEMUSER) || defined(_BOOT) */

/*
 * The following are assorted machine dependent values which can be
 * obtained in a machine independent manner through sysconf(2) or
 * sysinfo(2). In order to guarantee that these provide the expected
 * value at all times, the System Private interface (leading underscore)
 * is used.
 */

#include <sys/unistd.h>

#ifdef  __cplusplus
extern "C" {
#endif

#if !defined(_ASM)
extern long _sysconf(int);      /* System Private interface to sysconf() */
#endif  /* !defined(_ASM) */

#define HZ              ((clock_t)_sysconf(_SC_CLK_TCK))
#define TICK            (1000000000/((clock_t)_sysconf(_SC_CLK_TCK)))
#define PAGESIZE        (_sysconf(_SC_PAGESIZE))
#define PAGEOFFSET      (PAGESIZE - 1)
#define PAGEMASK        (~PAGEOFFSET)
#define MAXPID          ((pid_t)_sysconf(_SC_MAXPID))
#define MAXEPHUID       ((uid_t)_sysconf(_SC_EPHID_MAX))

#ifdef  __cplusplus
}
#endif

#endif  /* defined(_KERNEL) || defined(_KMEMUSER) || defined(_BOOT) */

#endif  /* _SYS_PARAM_H */