[unix-history] / sys / sys / param.h

/*-
 * Copyright (c) 1982, 1986, 1989 The Regents of the University of California.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	from: @(#)param.h	7.23 (Berkeley) 5/6/91
 *	$Id: param.h,v 1.2 1993/10/08 20:59:38 rgrimes Exp $
 */

#ifndef _SYS_PARAM_H_
#define _SYS_PARAM_H_

#define	BSD	199103	 /* CSRG: March, 1991 system version (year & month) */
#define BSD4_3	1
#define BSD4_4	0.5

#ifndef NULL
#define	NULL	0
#endif

#ifndef LOCORE
#include <sys/types.h>
#endif

/*
 * Machine-independent constants (some used in following include files).
 * Redefined constants are from POSIX 1003.1 limits file.
 *
 * MAXCOMLEN should be >= sizeof(ac_comm) (see <acct.h>)
 * MAXLOGNAME should be >= UT_NAMESIZE (see <utmp.h>)
 */
#include <sys/syslimits.h>

#define	MAXCOMLEN	16		/* max command name remembered */
#define	MAXINTERP	64		/* max interpreter file name length */
#define	MAXLOGNAME	12		/* max login name length */
#define	MAXUPRC		CHILD_MAX	/* max simultaneous processes */
#define	NCARGS		ARG_MAX		/* max bytes for an exec function */
#define	NGROUPS		NGROUPS_MAX	/* max number groups */
#define	NOFILE		OPEN_MAX	/* max open files per process */
#define	NOGROUP		65535		/* marker for empty group set member */
#define MAXHOSTNAMELEN	256		/* max hostname size */

/* More types and definitions used throughout the kernel. */
#ifdef KERNEL
#include <sys/cdefs.h>
#include <sys/errno.h>
#include <sys/time.h>
#include <sys/resource.h>
#include <sys/ucred.h>
#include <sys/uio.h>
#endif

/* Signals. */
#include <sys/signal.h>

/* Machine type dependent parameters. */
#include <machine/param.h>
#include <machine/endian.h>
#include <machine/limits.h>

/*
 * Priorities.  Note that with 32 run queues, differences less than 4 are
 * insignificant.
 */
#define	PSWP	0
#define	PVM	4
#define	PINOD	8
#define	PRIBIO	16
#define	PVFS	20
#define	PZERO	22		/* No longer magic, shouldn't be here.  XXX */
#define	PSOCK	24
#define	PWAIT	32
#define	PLOCK	36
#define	PPAUSE	40
#define	PUSER	50
#define	MAXPRI	127		/* Priorities range from 0 through MAXPRI. */

#define	PRIMASK	0x0ff
#define	PCATCH	0x100		/* OR'd with pri for tsleep to check signals */

#define	NZERO	0		/* default "nice" */

#define	NBPW	sizeof(int)	/* number of bytes per word (integer) */

#define	CMASK	022		/* default file mask: S_IWGRP|S_IWOTH */
#define	NODEV	(dev_t)(-1)	/* non-existent device */

/*
 * Clustering of hardware pages on machines with ridiculously small
 * page sizes is done here.  The paging subsystem deals with units of
 * CLSIZE pte's describing NBPG (from machine/machparam.h) pages each.
 */
#define	CLBYTES		(CLSIZE*NBPG)
#define	CLOFSET		(CLSIZE*NBPG-1)	/* for clusters, like PGOFSET */
#define	claligned(x)	((((int)(x))&CLOFSET)==0)
#define	CLOFF		CLOFSET
#define	CLSHIFT		(PGSHIFT+CLSIZELOG2)

#if CLSIZE==1
#define	clbase(i)	(i)
#define	clrnd(i)	(i)
#else
/* Give the base virtual address (first of CLSIZE). */
#define	clbase(i)	((i) &~ (CLSIZE-1))
/* Round a number of clicks up to a whole cluster. */
#define	clrnd(i)	(((i) + (CLSIZE-1)) &~ (CLSIZE-1))
#endif

#define	CBLOCK	64		/* Clist block size, must be a power of 2. */
#define CBQSIZE	(CBLOCK/NBBY)	/* Quote bytes/cblock - can do better. */
				/* Data chars/clist. */
#define	CBSIZE	(CBLOCK - sizeof(struct cblock *) - CBQSIZE)
#define	CROUND	(CBLOCK - 1)	/* Clist rounding. */

/*
 * 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.
 */
#define	MAXBSIZE	8192
#define MAXFRAG 	8

/*
 * MAXPATHLEN defines the longest permissable path length after expanding
 * symbolic links. It is used to allocate a temporary buffer from the buffer
 * pool in which to do the name expansion, hence should be a power of two,
 * and must be less than or equal to MAXBSIZE.  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.
 */
#define	MAXPATHLEN	PATH_MAX
#define MAXSYMLINKS	8

/* Bit map related macros. */
#define	setbit(a,i)	((a)[(i)/NBBY] |= 1<<((i)%NBBY))
#define	clrbit(a,i)	((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
#define	isset(a,i)	((a)[(i)/NBBY] & (1<<((i)%NBBY)))
#define	isclr(a,i)	(((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)

/* Macros for counting and rounding. */
#ifndef howmany
#define	howmany(x, y)	(((x)+((y)-1))/(y))
#endif
#define	roundup(x, y)	((((x)+((y)-1))/(y))*(y))
#define powerof2(x)	((((x)-1)&(x))==0)

/* Macros for fast min/max: with inline expansion, the "function" is faster. */
#ifdef KERNEL
#define	MIN(a,b) min((a), (b))
#define	MAX(a,b) max((a), (b))
#else
#define	MIN(a,b) (((a)<(b))?(a):(b))
#define	MAX(a,b) (((a)>(b))?(a):(b))
#endif

/*
 * Constants for setting the parameters of the kernel memory allocator.
 *
 * 2 ** MINBUCKET is the smallest unit of memory that will be
 * allocated. It must be at least large enough to hold a pointer.
 *
 * Units of memory less or equal to MAXALLOCSAVE will permanently
 * allocate physical memory; requests for these size pieces of
 * memory are quite fast. Allocations greater than MAXALLOCSAVE must
 * always allocate and free physical memory; requests for these
 * size allocations should be done infrequently as they will be slow.
 *
 * Constraints: CLBYTES <= MAXALLOCSAVE <= 2 ** (MINBUCKET + 14), and
 * MAXALLOCSIZE must be a power of two.
 */
#define MINBUCKET	4		/* 4 => min allocation of 16 bytes */
#define MAXALLOCSAVE	(CLBYTES-1)

/*
 * Scale factor for scaled integers used to count %cpu time and load avgs.
 *
 * The number of CPU `tick's that map to a unique `%age' can be expressed
 * by the formula (1 / (2 ^ (FSHIFT - 11))).  The maximum load average that
 * can be calculated (assuming 32 bits) can be closely approximated using
 * the formula (2 ^ (2 * (16 - FSHIFT))) for (FSHIFT < 15).
 *
 * For the scheduler to maintain a 1:1 mapping of CPU `tick' to `%age',
 * FSHIFT must be at least 11; this gives us a maximum load avg of ~1024.
 */
#define	FSHIFT	11		/* bits to right of fixed binary point */
#define FSCALE	(1<<FSHIFT)

#endif /* !_SYS_PARAM_H_ */
Commit	Line	Data
15637ed4 RG	1	/*-
	2	* Copyright (c) 1982, 1986, 1989 The Regents of the University of California.
	3	* All rights reserved.
	4	*
	5	* Redistribution and use in source and binary forms, with or without
	6	* modification, are permitted provided that the following conditions
	7	* are met:
	8	* 1. Redistributions of source code must retain the above copyright
	9	* notice, this list of conditions and the following disclaimer.
	10	* 2. Redistributions in binary form must reproduce the above copyright
	11	* notice, this list of conditions and the following disclaimer in the
	12	* documentation and/or other materials provided with the distribution.
	13	* 3. All advertising materials mentioning features or use of this software
	14	* must display the following acknowledgement:
	15	* This product includes software developed by the University of
	16	* California, Berkeley and its contributors.
	17	* 4. Neither the name of the University nor the names of its contributors
	18	* may be used to endorse or promote products derived from this software
	19	* without specific prior written permission.
	20	*
	21	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	22	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	23	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	24	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	25	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	26	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	27	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	28	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	29	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	30	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	31	* SUCH DAMAGE.
	32	*
78ed81a3	33	* from: @(#)param.h 7.23 (Berkeley) 5/6/91
78ed81a3	34	* $Id: param.h,v 1.2 1993/10/08 20:59:38 rgrimes Exp $
15637ed4 RG	35	*/
15637ed4 RG	36
78ed81a3	37	#ifndef _SYS_PARAM_H_
	38	#define _SYS_PARAM_H_
	39
15637ed4 RG	40	#define BSD 199103 /* CSRG: March, 1991 system version (year & month) */
	41	#define BSD4_3 1
	42	#define BSD4_4 0.5
	43
	44	#ifndef NULL
	45	#define NULL 0
	46	#endif
	47
	48	#ifndef LOCORE
	49	#include <sys/types.h>
	50	#endif
	51
	52	/*
	53	* Machine-independent constants (some used in following include files).
	54	* Redefined constants are from POSIX 1003.1 limits file.
	55	*
	56	* MAXCOMLEN should be >= sizeof(ac_comm) (see <acct.h>)
	57	* MAXLOGNAME should be >= UT_NAMESIZE (see <utmp.h>)
	58	*/
	59	#include <sys/syslimits.h>
	60
	61	#define MAXCOMLEN 16 /* max command name remembered */
78ed81a3	62	#define MAXINTERP 64 /* max interpreter file name length */
15637ed4 RG	63	#define MAXLOGNAME 12 /* max login name length */
	64	#define MAXUPRC CHILD_MAX /* max simultaneous processes */
	65	#define NCARGS ARG_MAX /* max bytes for an exec function */
	66	#define NGROUPS NGROUPS_MAX /* max number groups */
	67	#define NOFILE OPEN_MAX /* max open files per process */
	68	#define NOGROUP 65535 /* marker for empty group set member */
	69	#define MAXHOSTNAMELEN 256 /* max hostname size */
	70
	71	/* More types and definitions used throughout the kernel. */
	72	#ifdef KERNEL
	73	#include <sys/cdefs.h>
	74	#include <sys/errno.h>
	75	#include <sys/time.h>
	76	#include <sys/resource.h>
	77	#include <sys/ucred.h>
	78	#include <sys/uio.h>
	79	#endif
	80
	81	/* Signals. */
	82	#include <sys/signal.h>
	83
	84	/* Machine type dependent parameters. */
	85	#include <machine/param.h>
	86	#include <machine/endian.h>
	87	#include <machine/limits.h>
	88
	89	/*
	90	* Priorities. Note that with 32 run queues, differences less than 4 are
	91	* insignificant.
	92	*/
	93	#define PSWP 0
	94	#define PVM 4
	95	#define PINOD 8
	96	#define PRIBIO 16
	97	#define PVFS 20
	98	#define PZERO 22 /* No longer magic, shouldn't be here. XXX */
	99	#define PSOCK 24
	100	#define PWAIT 32
	101	#define PLOCK 36
	102	#define PPAUSE 40
	103	#define PUSER 50
	104	#define MAXPRI 127 /* Priorities range from 0 through MAXPRI. */
	105
	106	#define PRIMASK 0x0ff
	107	#define PCATCH 0x100 /* OR'd with pri for tsleep to check signals */
	108
	109	#define NZERO 0 /* default "nice" */
	110
	111	#define NBPW sizeof(int) /* number of bytes per word (integer) */
	112
	113	#define CMASK 022 /* default file mask: S_IWGRP\|S_IWOTH */
	114	#define NODEV (dev_t)(-1) /* non-existent device */
	115
	116	/*
	117	* Clustering of hardware pages on machines with ridiculously small
	118	* page sizes is done here. The paging subsystem deals with units of
	119	* CLSIZE pte's describing NBPG (from machine/machparam.h) pages each.
	120	*/
	121	#define CLBYTES (CLSIZE*NBPG)
	122	#define CLOFSET (CLSIZENBPG-1) / for clusters, like PGOFSET */
	123	#define claligned(x) ((((int)(x))&CLOFSET)==0)
	124	#define CLOFF CLOFSET
	125	#define CLSHIFT (PGSHIFT+CLSIZELOG2)
	126
127	#if CLSIZE==1
128	#define clbase(i) (i)
129	#define clrnd(i) (i)
130	#else
131	/* Give the base virtual address (first of CLSIZE). */
132	#define clbase(i) ((i) &~ (CLSIZE-1))
133	/* Round a number of clicks up to a whole cluster. */
134	#define clrnd(i) (((i) + (CLSIZE-1)) &~ (CLSIZE-1))
135	#endif
136
137	#define CBLOCK 64 /* Clist block size, must be a power of 2. */
138	#define CBQSIZE (CBLOCK/NBBY) /* Quote bytes/cblock - can do better. */
139	/* Data chars/clist. */
140	#define CBSIZE (CBLOCK - sizeof(struct cblock *) - CBQSIZE)
141	#define CROUND (CBLOCK - 1) /* Clist rounding. */
142
143	/*
144	* File system parameters and macros.
145	*
146	* The file system is made out of blocks of at most MAXBSIZE units, with
147	* smaller units (fragments) only in the last direct block. MAXBSIZE
148	* primarily determines the size of buffers in the buffer pool. It may be
149	* made larger without any effect on existing file systems; however making
150	* it smaller make make some file systems unmountable.
151	*/
152	#define MAXBSIZE 8192
153	#define MAXFRAG 8
154
155	/*
156	* MAXPATHLEN defines the longest permissable path length after expanding
157	* symbolic links. It is used to allocate a temporary buffer from the buffer
158	* pool in which to do the name expansion, hence should be a power of two,
159	* and must be less than or equal to MAXBSIZE. MAXSYMLINKS defines the
160	* maximum number of symbolic links that may be expanded in a path name.
161	* It should be set high enough to allow all legitimate uses, but halt
162	* infinite loops reasonably quickly.
163	*/
164	#define MAXPATHLEN PATH_MAX
165	#define MAXSYMLINKS 8
166
167	/* Bit map related macros. */
168	#define setbit(a,i) ((a)[(i)/NBBY] \|= 1<<((i)%NBBY))
169	#define clrbit(a,i) ((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
170	#define isset(a,i) ((a)[(i)/NBBY] & (1<<((i)%NBBY)))
171	#define isclr(a,i) (((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
172
173	/* Macros for counting and rounding. */
174	#ifndef howmany
175	#define howmany(x, y) (((x)+((y)-1))/(y))
176	#endif
177	#define roundup(x, y) ((((x)+((y)-1))/(y))*(y))
178	#define powerof2(x) ((((x)-1)&(x))==0)
179
180	/* Macros for fast min/max: with inline expansion, the "function" is faster. */
181	#ifdef KERNEL
182	#define MIN(a,b) min((a), (b))
183	#define MAX(a,b) max((a), (b))
184	#else
185	#define MIN(a,b) (((a)<(b))?(a):(b))
186	#define MAX(a,b) (((a)>(b))?(a):(b))
187	#endif
188
189	/*
190	* Constants for setting the parameters of the kernel memory allocator.
191	*
192	* 2 ** MINBUCKET is the smallest unit of memory that will be
193	* allocated. It must be at least large enough to hold a pointer.
194	*
195	* Units of memory less or equal to MAXALLOCSAVE will permanently
196	* allocate physical memory; requests for these size pieces of
197	* memory are quite fast. Allocations greater than MAXALLOCSAVE must
198	* always allocate and free physical memory; requests for these
199	* size allocations should be done infrequently as they will be slow.
200	*
201	* Constraints: CLBYTES <= MAXALLOCSAVE <= 2 ** (MINBUCKET + 14), and
202	* MAXALLOCSIZE must be a power of two.
203	*/
204	#define MINBUCKET 4 /* 4 => min allocation of 16 bytes */
78ed81a3	205	#define MAXALLOCSAVE (CLBYTES-1)
15637ed4 RG	206
	207	/*
	208	* Scale factor for scaled integers used to count %cpu time and load avgs.
	209	*
	210	* The number of CPU `tick's that map to a unique `%age' can be expressed
	211	* by the formula (1 / (2 ^ (FSHIFT - 11))). The maximum load average that
	212	* can be calculated (assuming 32 bits) can be closely approximated using
	213	* the formula (2 ^ (2 * (16 - FSHIFT))) for (FSHIFT < 15).
	214	*
	215	* For the scheduler to maintain a 1:1 mapping of CPU `tick' to `%age',
	216	* FSHIFT must be at least 11; this gives us a maximum load avg of ~1024.
	217	*/
	218	#define FSHIFT 11 /* bits to right of fixed binary point */
	219	#define FSCALE (1<<FSHIFT)
78ed81a3	220
78ed81a3	221	#endif /* !_SYS_PARAM_H_ */