epoc32/include/stdapis/sys/param.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
equal deleted inserted replaced
1:666f914201fb 2:2fe1408b6811
     1 param.h
     1 /*-
       
     2  * Copyright (c) 1982, 1986, 1989, 1993
       
     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  * 4. 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  *	@(#)param.h	8.3 (Berkeley) 4/4/95
       
    35  * $FreeBSD: src/sys/sys/param.h,v 1.244.2.2 2005/08/13 21:27:58 rwatson Exp $
       
    36  */
       
    37 
       
    38 #ifndef _SYS_PARAM_H_
       
    39 #define _SYS_PARAM_H_
       
    40 
       
    41 #include <sys/_null.h>
       
    42 
       
    43 #define	BSD	199506		/* System version (year & month). */
       
    44 #define BSD4_3	1
       
    45 #define BSD4_4	1
       
    46 
       
    47 /* 
       
    48  * __FreeBSD_version numbers are documented in the Porter's Handbook.
       
    49  * If you bump the version for any reason, you should update the documentation
       
    50  * there.
       
    51  * Currently this lives here:
       
    52  *
       
    53  *	doc/en_US.ISO8859-1/books/porters-handbook/book.sgml
       
    54  *
       
    55  * scheme is:  <major><two digit minor>Rxx
       
    56  *		'R' is 0 if release branch or x.0-CURRENT before RELENG_*_0
       
    57  *		is created, otherwise 1.
       
    58  */
       
    59 #undef __FreeBSD_version
       
    60 #define __FreeBSD_version 600034	/* Master, propagated to newvers */
       
    61 
       
    62 #ifndef LOCORE
       
    63 #include <sys/types.h>
       
    64 #endif
       
    65 
       
    66 /*
       
    67  * Machine-independent constants (some used in following include files).
       
    68  * Redefined constants are from POSIX 1003.1 limits file.
       
    69  *
       
    70  * MAXCOMLEN should be >= sizeof(ac_comm) (see <acct.h>)
       
    71  * MAXLOGNAME should be == UT_NAMESIZE+1 (see <utmp.h>)
       
    72  */
       
    73 #include <sys/syslimits.h>
       
    74 
       
    75 #define	MAXCOMLEN	19		/* max command name remembered */
       
    76 #define	MAXINTERP	32		/* max interpreter file name length */
       
    77 #define	MAXLOGNAME	17		/* max login name length (incl. NUL) */
       
    78 #define	MAXUPRC		CHILD_MAX	/* max simultaneous processes */
       
    79 #define	NCARGS		ARG_MAX		/* max bytes for an exec function */
       
    80 #define	NGROUPS		NGROUPS_MAX	/* max number groups */
       
    81 #define	NOFILE		OPEN_MAX	/* max open files per process */
       
    82 #define	NOGROUP		65535		/* marker for empty group set member */
       
    83 #define MAXHOSTNAMELEN	256		/* max hostname size */
       
    84 #define SPECNAMELEN	63		/* max length of devicename */
       
    85 
       
    86 /* More types and definitions used throughout the kernel. */
       
    87 #ifdef _KERNEL
       
    88 #if 0
       
    89 #if (defined(BURN_BRIDGES) || __FreeBSD_version >= 600000) \
       
    90 	&& defined(OBSOLETE_IN_6)
       
    91 #error "This file contains obsolete code to be removed in 6.0-current"
       
    92 #endif
       
    93 #endif
       
    94 #include <sys/cdefs.h>
       
    95 #include <sys/errno.h>
       
    96 #include <sys/time.h>
       
    97 
       
    98 #ifndef __SYMBIAN32__
       
    99 #include <sys/priority.h>
       
   100 #endif //__SYMBIAN32__
       
   101 
       
   102 #define	FALSE	0
       
   103 #define	TRUE	1
       
   104 #endif
       
   105 
       
   106 #ifndef _KERNEL
       
   107 /* Signals. */
       
   108 #ifndef __SYMBIAN32__
       
   109 #include <sys/signal.h>
       
   110 #endif //__SYMBIAN32__
       
   111 #endif
       
   112 
       
   113 /* Machine type dependent parameters. */
       
   114 #include <machine/param.h>
       
   115 #ifndef _KERNEL
       
   116 #include <sys/limits.h>
       
   117 #endif
       
   118 
       
   119 #ifndef _NO_NAMESPACE_POLLUTION
       
   120 
       
   121 #ifndef DEV_BSHIFT
       
   122 #define	DEV_BSHIFT	9		/* log2(DEV_BSIZE) */
       
   123 #endif
       
   124 #define	DEV_BSIZE	(1<<DEV_BSHIFT)
       
   125 
       
   126 #ifndef BLKDEV_IOSIZE
       
   127 #define BLKDEV_IOSIZE  PAGE_SIZE	/* default block device I/O size */
       
   128 #endif
       
   129 #ifndef DFLTPHYS
       
   130 #define DFLTPHYS	(64 * 1024)	/* default max raw I/O transfer size */
       
   131 #endif
       
   132 #ifndef MAXPHYS
       
   133 #define MAXPHYS		(128 * 1024)	/* max raw I/O transfer size */
       
   134 #endif
       
   135 #ifndef MAXDUMPPGS
       
   136 #define MAXDUMPPGS	(DFLTPHYS/PAGE_SIZE)
       
   137 #endif
       
   138 
       
   139 /*
       
   140  * Constants related to network buffer management.
       
   141  * MCLBYTES must be no larger than PAGE_SIZE.
       
   142  */
       
   143 #ifndef	MSIZE
       
   144 #define MSIZE		256		/* size of an mbuf */
       
   145 #endif	/* MSIZE */
       
   146 
       
   147 #ifndef	MCLSHIFT
       
   148 #define MCLSHIFT	11		/* convert bytes to mbuf clusters */
       
   149 #endif	/* MCLSHIFT */
       
   150 
       
   151 #define MCLBYTES	(1 << MCLSHIFT)	/* size of an mbuf cluster */
       
   152 
       
   153 /*
       
   154  * Some macros for units conversion
       
   155  */
       
   156 
       
   157 /* clicks to bytes */
       
   158 #ifndef ctob
       
   159 #define ctob(x)	((x)<<PAGE_SHIFT)
       
   160 #endif
       
   161 
       
   162 /* bytes to clicks */
       
   163 #ifndef btoc
       
   164 #define btoc(x)	(((vm_offset_t)(x)+PAGE_MASK)>>PAGE_SHIFT)
       
   165 #endif
       
   166 
       
   167 /*
       
   168  * btodb() is messy and perhaps slow because `bytes' may be an off_t.  We
       
   169  * want to shift an unsigned type to avoid sign extension and we don't
       
   170  * want to widen `bytes' unnecessarily.  Assume that the result fits in
       
   171  * a daddr_t.
       
   172  */
       
   173 #ifndef btodb
       
   174 #define btodb(bytes)	 		/* calculates (bytes / DEV_BSIZE) */ \
       
   175 	(sizeof (bytes) > sizeof(long) \
       
   176 	 ? (daddr_t)((unsigned long long)(bytes) >> DEV_BSHIFT) \
       
   177 	 : (daddr_t)((unsigned long)(bytes) >> DEV_BSHIFT))
       
   178 #endif
       
   179 
       
   180 #ifndef dbtob
       
   181 #define dbtob(db)			/* calculates (db * DEV_BSIZE) */ \
       
   182 	((off_t)(db) << DEV_BSHIFT)
       
   183 #endif
       
   184 
       
   185 #endif /* _NO_NAMESPACE_POLLUTION */
       
   186 
       
   187 #define	PRIMASK	0x0ff
       
   188 #define	PCATCH	0x100		/* OR'd with pri for tsleep to check signals */
       
   189 #define	PDROP	0x200	/* OR'd with pri to stop re-entry of interlock mutex */
       
   190 
       
   191 #define	NZERO	0		/* default "nice" */
       
   192 
       
   193 #define	NBBY	8		/* number of bits in a byte */
       
   194 #define	NBPW	sizeof(int)	/* number of bytes per word (integer) */
       
   195 
       
   196 #define	CMASK	022		/* default file mask: S_IWGRP|S_IWOTH */
       
   197 
       
   198 #define	NODEV	(dev_t)(-1)	/* non-existent device */
       
   199 
       
   200 #define	CBLOCK	128		/* Clist block size, must be a power of 2. */
       
   201 #define CBQSIZE	(CBLOCK/NBBY)	/* Quote bytes/cblock - can do better. */
       
   202 				/* Data chars/clist. */
       
   203 #define	CBSIZE	(CBLOCK - sizeof(struct cblock *) - CBQSIZE)
       
   204 #define	CROUND	(CBLOCK - 1)	/* Clist rounding. */
       
   205 
       
   206 /*
       
   207  * File system parameters and macros.
       
   208  *
       
   209  * MAXBSIZE -	Filesystems are made out of blocks of at most MAXBSIZE bytes
       
   210  *		per block.  MAXBSIZE may be made larger without effecting
       
   211  *		any existing filesystems as long as it does not exceed MAXPHYS,
       
   212  *		and may be made smaller at the risk of not being able to use
       
   213  *		filesystems which require a block size exceeding MAXBSIZE.
       
   214  *
       
   215  * BKVASIZE -	Nominal buffer space per buffer, in bytes.  BKVASIZE is the
       
   216  *		minimum KVM memory reservation the kernel is willing to make.
       
   217  *		Filesystems can of course request smaller chunks.  Actual 
       
   218  *		backing memory uses a chunk size of a page (PAGE_SIZE).
       
   219  *
       
   220  *		If you make BKVASIZE too small you risk seriously fragmenting
       
   221  *		the buffer KVM map which may slow things down a bit.  If you
       
   222  *		make it too big the kernel will not be able to optimally use 
       
   223  *		the KVM memory reserved for the buffer cache and will wind 
       
   224  *		up with too-few buffers.
       
   225  *
       
   226  *		The default is 16384, roughly 2x the block size used by a
       
   227  *		normal UFS filesystem.
       
   228  */
       
   229 #define MAXBSIZE	65536	/* must be power of 2 */
       
   230 #define BKVASIZE	16384	/* must be power of 2 */
       
   231 #define BKVAMASK	(BKVASIZE-1)
       
   232 
       
   233 /*
       
   234  * MAXPATHLEN defines the longest permissible path length after expanding
       
   235  * symbolic links. It is used to allocate a temporary buffer from the buffer
       
   236  * pool in which to do the name expansion, hence should be a power of two,
       
   237  * and must be less than or equal to MAXBSIZE.  MAXSYMLINKS defines the
       
   238  * maximum number of symbolic links that may be expanded in a path name.
       
   239  * It should be set high enough to allow all legitimate uses, but halt
       
   240  * infinite loops reasonably quickly.
       
   241  */
       
   242 #define	MAXPATHLEN	PATH_MAX
       
   243 #define MAXSYMLINKS	32
       
   244 
       
   245 /* Bit map related macros. */
       
   246 #define	setbit(a,i)	((a)[(i)/NBBY] |= 1<<((i)%NBBY))
       
   247 #define	clrbit(a,i)	((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
       
   248 #define	isset(a,i)	((a)[(i)/NBBY] & (1<<((i)%NBBY)))
       
   249 #define	isclr(a,i)	(((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
       
   250 
       
   251 /* Macros for counting and rounding. */
       
   252 #ifndef howmany
       
   253 #define	howmany(x, y)	(((x)+((y)-1))/(y))
       
   254 #endif
       
   255 #define	rounddown(x, y)	(((x)/(y))*(y))
       
   256 #define	roundup(x, y)	((((x)+((y)-1))/(y))*(y))  /* to any y */
       
   257 #define	roundup2(x, y)	(((x)+((y)-1))&(~((y)-1))) /* if y is powers of two */
       
   258 #define powerof2(x)	((((x)-1)&(x))==0)
       
   259 
       
   260 /* Macros for min/max. */
       
   261 #define	MIN(a,b) (((a)<(b))?(a):(b))
       
   262 #define	MAX(a,b) (((a)>(b))?(a):(b))
       
   263 
       
   264 #ifdef _KERNEL
       
   265 /*
       
   266  * Basic byte order function prototypes for non-inline functions.
       
   267  */
       
   268 #ifndef _BYTEORDER_PROTOTYPED
       
   269 #define	_BYTEORDER_PROTOTYPED
       
   270 __BEGIN_DECLS
       
   271 __uint32_t	 htonl(__uint32_t);
       
   272 __uint16_t	 htons(__uint16_t);
       
   273 __uint32_t	 ntohl(__uint32_t);
       
   274 __uint16_t	 ntohs(__uint16_t);
       
   275 __END_DECLS
       
   276 #endif
       
   277 
       
   278 #ifndef lint
       
   279 #ifndef _BYTEORDER_FUNC_DEFINED
       
   280 #define	_BYTEORDER_FUNC_DEFINED
       
   281 #define	htonl(x)	__htonl(x)
       
   282 #define	htons(x)	__htons(x)
       
   283 #define	ntohl(x)	__ntohl(x)
       
   284 #define	ntohs(x)	__ntohs(x)
       
   285 #endif /* !_BYTEORDER_FUNC_DEFINED */
       
   286 #endif /* lint */
       
   287 #endif /* _KERNEL */
       
   288 
       
   289 /*
       
   290  * Constants for setting the parameters of the kernel memory allocator.
       
   291  *
       
   292  * 2 ** MINBUCKET is the smallest unit of memory that will be
       
   293  * allocated. It must be at least large enough to hold a pointer.
       
   294  *
       
   295  * Units of memory less or equal to MAXALLOCSAVE will permanently
       
   296  * allocate physical memory; requests for these size pieces of
       
   297  * memory are quite fast. Allocations greater than MAXALLOCSAVE must
       
   298  * always allocate and free physical memory; requests for these
       
   299  * size allocations should be done infrequently as they will be slow.
       
   300  *
       
   301  * Constraints: PAGE_SIZE <= MAXALLOCSAVE <= 2 ** (MINBUCKET + 14), and
       
   302  * MAXALLOCSIZE must be a power of two.
       
   303  */
       
   304 #if defined(__alpha__) || defined(__ia64__) || defined(__sparc64__)
       
   305 #define MINBUCKET	5		/* 5 => min allocation of 32 bytes */
       
   306 #else
       
   307 #define MINBUCKET	4		/* 4 => min allocation of 16 bytes */
       
   308 #endif
       
   309 #define MAXALLOCSAVE	(2 * PAGE_SIZE)
       
   310 
       
   311 /*
       
   312  * Scale factor for scaled integers used to count %cpu time and load avgs.
       
   313  *
       
   314  * The number of CPU `tick's that map to a unique `%age' can be expressed
       
   315  * by the formula (1 / (2 ^ (FSHIFT - 11))).  The maximum load average that
       
   316  * can be calculated (assuming 32 bits) can be closely approximated using
       
   317  * the formula (2 ^ (2 * (16 - FSHIFT))) for (FSHIFT < 15).
       
   318  *
       
   319  * For the scheduler to maintain a 1:1 mapping of CPU `tick' to `%age',
       
   320  * FSHIFT must be at least 11; this gives us a maximum load avg of ~1024.
       
   321  */
       
   322 #define	FSHIFT	11		/* bits to right of fixed binary point */
       
   323 #define FSCALE	(1<<FSHIFT)
       
   324 
       
   325 #define dbtoc(db)			/* calculates devblks to pages */ \
       
   326 	((db + (ctodb(1) - 1)) >> (PAGE_SHIFT - DEV_BSHIFT))
       
   327  
       
   328 #define ctodb(db)			/* calculates pages to devblks */ \
       
   329 	((db) << (PAGE_SHIFT - DEV_BSHIFT))
       
   330 
       
   331 #endif	/* _SYS_PARAM_H_ */