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