xref: /netbsd-src/share/man/man3/param.3 (revision 42c705227acae0f59136f6b94a3c516e4d4831b8)
1*42c70522Sjruoho.\" $NetBSD: param.3,v 1.4 2011/04/10 10:02:34 jruoho Exp $
25ae9d524Sjruoho.\"
35ae9d524Sjruoho.\" Copyright (c) 2011 Jukka Ruohonen <jruohonen@iki.fi>
45ae9d524Sjruoho.\" All rights reserved.
55ae9d524Sjruoho.\"
65ae9d524Sjruoho.\" Redistribution and use in source and binary forms, with or without
75ae9d524Sjruoho.\" modification, are permitted provided that the following conditions
85ae9d524Sjruoho.\" are met:
95ae9d524Sjruoho.\" 1. Redistributions of source code must retain the above copyright
105ae9d524Sjruoho.\"    notice, this list of conditions and the following disclaimer.
115ae9d524Sjruoho.\" 2. Redistributions in binary form must reproduce the above copyright
125ae9d524Sjruoho.\"    notice, this list of conditions and the following disclaimer in the
135ae9d524Sjruoho.\"    documentation and/or other materials provided with the distribution.
145ae9d524Sjruoho.\"
155ae9d524Sjruoho.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
165ae9d524Sjruoho.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
175ae9d524Sjruoho.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
185ae9d524Sjruoho.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
195ae9d524Sjruoho.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
205ae9d524Sjruoho.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
215ae9d524Sjruoho.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
225ae9d524Sjruoho.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
235ae9d524Sjruoho.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
245ae9d524Sjruoho.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
255ae9d524Sjruoho.\" POSSIBILITY OF SUCH DAMAGE.
265ae9d524Sjruoho.\"
27*42c70522Sjruoho.Dd April 10, 2011
285ae9d524Sjruoho.Dt PARAM 3
295ae9d524Sjruoho.Os
305ae9d524Sjruoho.Sh NAME
315ae9d524Sjruoho.Nm param
325ae9d524Sjruoho.Nd common parameters
335ae9d524Sjruoho.Sh SYNOPSIS
345ae9d524Sjruoho.In sys/param.h
355ae9d524Sjruoho.Ft size
365ae9d524Sjruoho.Fn MAX "size a" "size b"
375ae9d524Sjruoho.Ft size
385ae9d524Sjruoho.Fn MIN "size a" "size b"
395ae9d524Sjruoho.Sh DESCRIPTION
405ae9d524SjruohoThe
415ae9d524Sjruoho.In sys/param.h
425ae9d524Sjruohoheader includes some common definitions and macros specific to
435ae9d524Sjruoho.Nx .
445ae9d524SjruohoThe header is perhaps best characterized as a kernel equivalent of
455ae9d524Sjruoho.In sys/types.h .
465ae9d524SjruohoThe following list summarizes the provided definitions and macros.
475ae9d524Sjruoho.Bl -bullet -offset indent
485ae9d524Sjruoho.It
495ae9d524SjruohoFirst and foremost, the header defines the version of
505ae9d524Sjruoho.Nx .
515ae9d524SjruohoThis is defined as
525ae9d524Sjruoho.Bd -literal -offset indent
535ae9d524Sjruoho#define __NetBSD_Version__    599004800   /* 5.99.48 */
545ae9d524Sjruoho.Ed
555ae9d524Sjruoho.Pp
565ae9d524SjruohoThe general format is
575ae9d524Sjruoho.Dq MMmmrrpp00 ,
585ae9d524Sjruohowhere
595ae9d524Sjruoho.Sq MM
605ae9d524Sjruohoand
615ae9d524Sjruoho.Sq mm
625ae9d524Sjruohodenote the major and minor version, respectively,
635ae9d524Sjruoho.Sq rr
645ae9d524Sjruohois provided for compatibility, and
655ae9d524Sjruoho.Sq pp
665ae9d524Sjruohodefines the patch level.
675ae9d524Sjruoho.It
685ae9d524SjruohoCommon utility macros such as
695ae9d524Sjruoho.Fn MAX
705ae9d524Sjruohoand
715ae9d524Sjruoho.Fn MIN
725ae9d524Sjruohoas well as more specific macros such as
735ae9d524Sjruoho.Xr STACK 9 ,
745ae9d524Sjruoho.Xr ctod 9 ,
755ae9d524Sjruoho.Xr mstohz 9 ,
765ae9d524Sjruoho.Xr roundup 9 ,
775ae9d524Sjruohoand
785ae9d524Sjruoho.Xr setbit 9 .
795ae9d524Sjruoho.It
805ae9d524SjruohoNumerous miscellaneous definitions such as limits,
815ae9d524Sjruohoconstants for the kernel
825ae9d524Sjruoho.Xr memoryallocators 9 ,
835ae9d524Sjruohoscale factors used by the scheduler,
845ae9d524Sjruoho.Xr kthread 9
855ae9d524Sjruohopriorities, and many others.
865ae9d524Sjruoho.It
875ae9d524SjruohoDefinitions provided for historical and compatibility reasons.
885ae9d524SjruohoExamples range from definitions such as
895ae9d524Sjruoho.Dq #define BSD
905ae9d524Sjruohoto old priority levels used in the kernel.
915ae9d524Sjruoho.El
925ae9d524Sjruoho.Sh SEE ALSO
93e5c4609fSjruoho.Xr bitops 3 ,
945ae9d524Sjruoho.Xr cdefs 3 ,
95*42c70522Sjruoho.Xr types 3 ,
96*42c70522Sjruoho.Xr unistd 3
975ae9d524Sjruoho.Sh HISTORY
985ae9d524SjruohoA
995ae9d524Sjruoho.In param.h
1005ae9d524Sjruohoheader appeared already in the
1015ae9d524Sjruoho.At v4 .
102