1/* $NetBSD: param.h,v 1.599 2019/07/17 03:30:31 msaitoh Exp $ */
2
3/*-
4 * Copyright (c) 1982, 1986, 1989, 1993
5 * The Regents of the University of California. All rights reserved.
6 * (c) UNIX System Laboratories, Inc.
7 * All or some portions of this file are derived from material licensed
8 * to the University of California by American Telephone and Telegraph
9 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
10 * the permission of UNIX System Laboratories, Inc.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 *
36 * @(#)param.h 8.3 (Berkeley) 4/4/95
37 */
38
39#ifndef _SYS_PARAM_H_
40#define _SYS_PARAM_H_
41
42#ifdef _KERNEL_OPT
43#include "opt_param.h"
44#endif
45
46/*
47 * Historic BSD #defines -- probably will remain untouched for all time.
48 */
49#define BSD 199506 /* System version (year & month). */
50#define BSD4_3 1
51#define BSD4_4 1
52
53/*
54 * #define __NetBSD_Version__ MMmmrrpp00
55 *
56 * M = major version
57 * m = minor version; a minor number of 99 indicates current.
58 * r = 0 (*)
59 * p = patchlevel
60 *
61 * When new releases are made, src/gnu/usr.bin/groff/tmac/mdoc.local
62 * needs to be updated and the changes sent back to the groff maintainers.
63 *
64 * (*) Up to 2.0I "release" used to be "",A-Z,Z[A-Z] but numeric
65 * e.g. NetBSD-1.2D = 102040000 ('D' == 4)
66 * NetBSD-2.0H (200080000) was changed on 20041001 to:
67 * 2.99.9 (299000900)
68 */
69
70#define __NetBSD_Version__ 899005100 /* NetBSD 8.99.51 */
71
72#define __NetBSD_Prereq__(M,m,p) (((((M) * 100000000) + \
73 (m) * 1000000) + (p) * 100) <= __NetBSD_Version__)
74
75/*
76 * Historical NetBSD #define
77 *
78 * NetBSD 1.4 was the last release for which this value was incremented.
79 * The value is now permanently fixed at 199905. It will never be
80 * changed again.
81 *
82 * New code must use __NetBSD_Version__ instead, and should not even
83 * count on NetBSD being defined.
84 *
85 */
86
87#define NetBSD 199905 /* NetBSD version (year & month). */
88
89/*
90 * These macros determine if we are running in protected mode or not.
91 * _HARDKERNEL: code uses kernel namespace and runs in hw priviledged mode
92 * _SOFTKERNEL: code uses kernel namespace but runs without hw priviledges
93 */
94#if defined(_KERNEL) && !defined(_RUMPKERNEL)
95#define _HARDKERNEL
96#endif
97#if defined(_KERNEL) && defined(_RUMPKERNEL)
98#define _SOFTKERNEL
99#endif
100
101#include <sys/null.h>
102
103#ifndef __ASSEMBLER__
104#include <sys/inttypes.h>
105#include <sys/types.h>
106
107/*
108 * Machine-independent constants (some used in following include files).
109 * Redefined constants are from POSIX 1003.1 limits file.
110 *
111 * MAXCOMLEN should be >= sizeof(ac_comm) (see <acct.h>)
112 * MAXHOSTNAMELEN should be >= (_POSIX_HOST_NAME_MAX + 1) (see <limits.h>)
113 * MAXLOGNAME should be >= UT_NAMESIZE (see <utmp.h>)
114 */
115#include <sys/syslimits.h>
116
117#define MAXCOMLEN 16 /* max command name remembered */
118#define MAXINTERP PATH_MAX /* max interpreter file name length */
119/* DEPRECATED: use LOGIN_NAME_MAX instead. */
120#define MAXLOGNAME (LOGIN_NAME_MAX - 1) /* max login name length */
121#define NCARGS ARG_MAX /* max bytes for an exec function */
122#define NGROUPS NGROUPS_MAX /* max number groups */
123#define NOGROUP 65535 /* marker for empty group set member */
124#define MAXHOSTNAMELEN 256 /* max hostname size */
125
126#ifndef NOFILE
127#define NOFILE OPEN_MAX /* max open files per process */
128#endif
129#ifndef MAXUPRC /* max simultaneous processes */
130#define MAXUPRC CHILD_MAX /* POSIX 1003.1-compliant default */
131#else
132#if (MAXUPRC - 0) < CHILD_MAX
133#error MAXUPRC less than CHILD_MAX. See options(4) for details.
134#endif /* (MAXUPRC - 0) < CHILD_MAX */
135#endif /* !defined(MAXUPRC) */
136
137/* Macros for min/max. */
138#define MIN(a,b) ((/*CONSTCOND*/(a)<(b))?(a):(b))
139#define MAX(a,b) ((/*CONSTCOND*/(a)>(b))?(a):(b))
140
141/* More types and definitions used throughout the kernel. */
142#ifdef _KERNEL
143#include <sys/cdefs.h>
144#include <sys/errno.h>
145#include <sys/time.h>
146#include <sys/resource.h>
147#include <sys/ucred.h>
148#include <sys/uio.h>
149#include <uvm/uvm_param.h>
150#ifndef NPROC
151#define NPROC (20 + 16 * MAXUSERS)
152#endif
153#ifndef NTEXT
154#define NTEXT (80 + NPROC / 8) /* actually the object cache */
155#endif
156#ifndef NVNODE
157#define NVNODE (NPROC + NTEXT + 100)
158#define NVNODE_IMPLICIT
159#endif
160#ifndef VNODE_KMEM_MAXPCT
161#define VNODE_KMEM_MAXPCT 60
162#endif
163#ifndef BUFCACHE_VA_MAXPCT
164#define BUFCACHE_VA_MAXPCT 20
165#endif
166#define VNODE_COST 2048 /* assumed space in bytes */
167#endif /* _KERNEL */
168
169/* Signals. */
170#include <sys/signal.h>
171
172/* Machine type dependent parameters. */
173#include <machine/param.h>
174#include <machine/limits.h>
175
176#define DEV_BSHIFT 9 /* log2(DEV_BSIZE) */
177#define DEV_BSIZE (1 << DEV_BSHIFT) /* 512 */
178
179#ifndef BLKDEV_IOSIZE
180#define BLKDEV_IOSIZE 2048
181#endif
182
183#ifndef MAXPHYS
184#define MAXPHYS (64 * 1024) /* max raw I/O transfer size */
185#endif
186
187/* pages ("clicks") to disk blocks */
188#define ctod(x) ((x) << (PGSHIFT - DEV_BSHIFT))
189#define dtoc(x) ((x) >> (PGSHIFT - DEV_BSHIFT))
190
191/* bytes to pages */
192#define ctob(x) ((x) << PGSHIFT)
193#define btoc(x) (((x) + PGOFSET) >> PGSHIFT)
194
195/* bytes to disk blocks */
196#define dbtob(x) ((x) << DEV_BSHIFT)
197#define btodb(x) ((x) >> DEV_BSHIFT)
198
199#ifndef COHERENCY_UNIT
200#define COHERENCY_UNIT 64
201#endif
202#ifndef CACHE_LINE_SIZE
203#define CACHE_LINE_SIZE 64
204#endif
205#ifndef MAXCPUS
206#define MAXCPUS 32
207#endif
208#ifndef MAX_LWP_PER_PROC
209#define MAX_LWP_PER_PROC 8000
210#endif
211
212/*
213 * Stack macros. On most architectures, the stack grows down,
214 * towards lower addresses; it is the rare architecture where
215 * it grows up, towards higher addresses.
216 *
217 * STACK_GROW and STACK_SHRINK adjust a stack pointer by some
218 * size, no questions asked. STACK_ALIGN aligns a stack pointer.
219 *
220 * STACK_ALLOC returns a pointer to allocated stack space of
221 * some size; given such a pointer and a size, STACK_MAX gives
222 * the maximum (in the "maxsaddr" sense) stack address of the
223 * allocated memory.
224 */
225#if defined(_KERNEL) || defined(__EXPOSE_STACK)
226
227#ifndef STACK_ALIGNBYTES
228#define STACK_ALIGNBYTES __ALIGNBYTES
229#endif
230
231#ifdef __MACHINE_STACK_GROWS_UP
232#define STACK_GROW(sp, _size) (((char *)(void *)(sp)) + (_size))
233#define STACK_SHRINK(sp, _size) (((char *)(void *)(sp)) - (_size))
234#define STACK_ALIGN(sp, bytes) \
235 ((char *)((((unsigned long)(sp)) + (bytes)) & ~(bytes)))
236#define STACK_ALLOC(sp, _size) ((char *)(void *)(sp))
237#define STACK_MAX(p, _size) (((char *)(void *)(p)) + (_size))
238#else
239#define STACK_GROW(sp, _size) (((char *)(void *)(sp)) - (_size))
240#define STACK_SHRINK(sp, _size) (((char *)(void *)(sp)) + (_size))
241#define STACK_ALIGN(sp, bytes) \
242 ((char *)(((unsigned long)(sp)) & ~(bytes)))
243#define STACK_ALLOC(sp, _size) (((char *)(void *)(sp)) - (_size))
244#define STACK_MAX(p, _size) ((char *)(void *)(p))
245#endif
246#define STACK_LEN_ALIGN(len, bytes) (((len) + (bytes)) & ~(bytes))
247
248#endif /* defined(_KERNEL) || defined(__EXPOSE_STACK) */
249
250/*
251 * Round p (pointer or byte index) up to a correctly-aligned value for all
252 * data types (int, long, ...). The result is u_int and must be cast to
253 * any desired pointer type.
254 *
255 * ALIGNED_POINTER is a boolean macro that checks whether an address
256 * is valid to fetch data elements of type t from on this architecture.
257 * This does not reflect the optimal alignment, just the possibility
258 * (within reasonable limits).
259 *
260 */
261#define ALIGNBYTES __ALIGNBYTES
262#ifndef ALIGN
263#define ALIGN(p) (((uintptr_t)(p) + ALIGNBYTES) & ~ALIGNBYTES)
264#endif
265#ifndef ALIGNED_POINTER
266#define ALIGNED_POINTER(p,t) ((((uintptr_t)(p)) & (sizeof(t) - 1)) == 0)
267#endif
268
269/*
270 * Historic priority levels. These are meaningless and remain only
271 * for source compatibility. Do not use in new code.
272 */
273#define PSWP 0
274#define PVM 4
275#define PINOD 8
276#define PRIBIO 16
277#define PVFS 20
278#define PZERO 22
279#define PSOCK 24
280#define PWAIT 32
281#define PLOCK 36
282#define PPAUSE 40
283#define PUSER 50
284#define MAXPRI 127
285
286#define PCATCH 0x100 /* OR'd with pri for tsleep to check signals */
287#define PNORELOCK 0x200 /* OR'd with pri for tsleep to not relock */
288
289/*
290 * New priority levels.
291 */
292#define PRI_COUNT 224
293#define PRI_NONE (-1)
294
295#define PRI_KERNEL_RT 192
296#define NPRI_KERNEL_RT 32
297#define MAXPRI_KERNEL_RT (PRI_KERNEL_RT + NPRI_KERNEL_RT - 1)
298
299#define PRI_USER_RT 128
300#define NPRI_USER_RT 64
301#define MAXPRI_USER_RT (PRI_USER_RT + NPRI_USER_RT - 1)
302
303#define PRI_KTHREAD 96
304#define NPRI_KTHREAD 32
305#define MAXPRI_KTHREAD (PRI_KTHREAD + NPRI_KTHREAD - 1)
306
307#define PRI_KERNEL 64
308#define NPRI_KERNEL 32
309#define MAXPRI_KERNEL (PRI_KERNEL + NPRI_KERNEL - 1)
310
311#define PRI_USER 0
312#define NPRI_USER 64
313#define MAXPRI_USER (PRI_USER + NPRI_USER - 1)
314
315/* Priority range used by POSIX real-time features */
316#define SCHED_PRI_MIN 0
317#define SCHED_PRI_MAX 63
318
319/*
320 * Kernel thread priorities.
321 */
322#define PRI_SOFTSERIAL MAXPRI_KERNEL_RT
323#define PRI_SOFTNET (MAXPRI_KERNEL_RT - schedppq * 1)
324#define PRI_SOFTBIO (MAXPRI_KERNEL_RT - schedppq * 2)
325#define PRI_SOFTCLOCK (MAXPRI_KERNEL_RT - schedppq * 3)
326
327#define PRI_XCALL MAXPRI_KTHREAD
328#define PRI_PGDAEMON (MAXPRI_KTHREAD - schedppq * 1)
329#define PRI_VM (MAXPRI_KTHREAD - schedppq * 2)
330#define PRI_IOFLUSH (MAXPRI_KTHREAD - schedppq * 3)
331#define PRI_BIO (MAXPRI_KTHREAD - schedppq * 4)
332
333#define PRI_IDLE PRI_USER
334
335/*
336 * Miscellaneous.
337 */
338#define NBPW sizeof(int) /* number of bytes per word (integer) */
339
340#define CMASK 022 /* default file mask: S_IWGRP|S_IWOTH */
341#define NODEV (dev_t)(-1) /* non-existent device */
342
343/*
344 * File system parameters and macros.
345 *
346 * The file system is made out of blocks of at most MAXBSIZE units, with
347 * smaller units (fragments) only in the last direct block. MAXBSIZE
348 * primarily determines the size of buffers in the buffer pool. It may be
349 * made larger without any effect on existing file systems; however making
350 * it smaller may make some file systems unmountable.
351 */
352#ifndef MAXBSIZE /* XXX */
353#define MAXBSIZE MAXPHYS
354#endif
355#define MAXFRAG 8
356
357/*
358 * MAXPATHLEN defines the longest permissible path length after expanding
359 * symbolic links. It is used to allocate a temporary buffer from the buffer
360 * pool in which to do the name expansion, hence should be a power of two,
361 * and must be less than or equal to MAXBSIZE. MAXSYMLINKS defines the
362 * maximum number of symbolic links that may be expanded in a path name.
363 * It should be set high enough to allow all legitimate uses, but halt
364 * infinite loops reasonably quickly.
365 *
366 * MAXSYMLINKS should be >= _POSIX_SYMLOOP_MAX (see <limits.h>)
367 */
368#define MAXPATHLEN PATH_MAX
369#define MAXSYMLINKS 32
370
371/*
372 * This is the maximum individual filename component length enforced by
373 * namei. Filesystems cannot exceed this limit. The upper bound for that
374 * limit is NAME_MAX. We don't bump it for now, for compatibility with
375 * old binaries during the time where MAXNAMLEN was 511 and NAME_MAX was
376 * 255
377 */
378#define KERNEL_NAME_MAX 255
379
380/* Bit map related macros. */
381#define setbit(a,i) ((a)[(i)/NBBY] |= 1<<((i)%NBBY))
382#define clrbit(a,i) ((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
383#define isset(a,i) ((a)[(i)/NBBY] & (1<<((i)%NBBY)))
384#define isclr(a,i) (((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
385
386/* Macros for counting and rounding. */
387#ifndef howmany
388#define howmany(x, y) (((x)+((y)-1))/(y))
389#endif
390#define roundup(x, y) ((((x)+((y)-1))/(y))*(y))
391#define rounddown(x,y) (((x)/(y))*(y))
392
393/*
394 * Rounding to powers of two. The naive definitions of roundup2 and
395 * rounddown2,
396 *
397 * #define roundup2(x,m) (((x) + ((m) - 1)) & ~((m) - 1))
398 * #define rounddown2(x,m) ((x) & ~((m) - 1)),
399 *
400 * exhibit a quirk of integer arithmetic in C because the complement
401 * happens in the type of m, not in the type of x. So if unsigned int
402 * is 32-bit, and m is an unsigned int while x is a uint64_t, then
403 * roundup2 and rounddown2 would have the unintended effect of clearing
404 * the upper 32 bits of the result(!). These definitions avoid the
405 * pitfalls of C arithmetic depending on the types of x and m, and
406 * additionally avoid multiply evaluating their arguments.
407 */
408#define roundup2(x,m) ((((x) - 1) | ((m) - 1)) + 1)
409#define rounddown2(x,m) ((x) & ~((__typeof__(x))((m) - 1)))
410
411#define powerof2(x) ((((x)-1)&(x))==0)
412
413/*
414 * Constants for setting the parameters of the kernel memory allocator.
415 *
416 * 2 ** MINBUCKET is the smallest unit of memory that will be
417 * allocated. It must be at least large enough to hold a pointer.
418 *
419 * Units of memory less or equal to MAXALLOCSAVE will permanently
420 * allocate physical memory; requests for these size pieces of
421 * memory are quite fast. Allocations greater than MAXALLOCSAVE must
422 * always allocate and free physical memory; requests for these
423 * size allocations should be done infrequently as they will be slow.
424 *
425 * Constraints: NBPG <= MAXALLOCSAVE <= 2 ** (MINBUCKET + 14), and
426 * MAXALLOCSAVE must be a power of two.
427 */
428#ifdef _LP64
429#define MINBUCKET 5 /* 5 => min allocation of 32 bytes */
430#else
431#define MINBUCKET 4 /* 4 => min allocation of 16 bytes */
432#endif
433#define MAXALLOCSAVE (2 * NBPG)
434
435/*
436 * Scale factor for scaled integers used to count %cpu time and load avgs.
437 *
438 * The number of CPU `tick's that map to a unique `%age' can be expressed
439 * by the formula (1 / (2 ^ (FSHIFT - 11))). The maximum load average that
440 * can be calculated (assuming 32 bits) can be closely approximated using
441 * the formula (2 ^ (2 * (16 - FSHIFT))) for (FSHIFT < 15).
442 *
443 * For the scheduler to maintain a 1:1 mapping of CPU `tick' to `%age',
444 * FSHIFT must be at least 11; this gives us a maximum load avg of ~1024.
445 */
446#define FSHIFT 11 /* bits to right of fixed binary point */
447#define FSCALE (1<<FSHIFT)
448
449/*
450 * The time for a process to be blocked before being very swappable.
451 * This is a number of seconds which the system takes as being a non-trivial
452 * amount of real time. You probably shouldn't change this;
453 * it is used in subtle ways (fractions and multiples of it are, that is, like
454 * half of a ``long time'', almost a long time, etc.)
455 * It is related to human patience and other factors which don't really
456 * change over time.
457 */
458#define MAXSLP 20
459
460/*
461 * Defaults for Unified Buffer Cache parameters.
462 * These may be overridden in <machine/param.h>.
463 */
464
465#ifndef UBC_WINSHIFT
466#define UBC_WINSHIFT 13
467#endif
468#ifndef UBC_NWINS
469#define UBC_NWINS 1024
470#endif
471
472#ifdef _KERNEL
473/*
474 * macro to convert from milliseconds to hz without integer overflow
475 * Default version using only 32bits arithmetics.
476 * 64bit port can define 64bit version in their <machine/param.h>
477 * 0x20000 is safe for hz < 20000
478 */
479#ifndef mstohz
480#define mstohz(ms) \
481 (__predict_false((ms) >= 0x20000) ? \
482 ((ms +0u) / 1000u) * hz : \
483 ((ms +0u) * hz) / 1000u)
484#endif
485#ifndef hztoms
486#define hztoms(t) \
487 (__predict_false((t) >= 0x20000) ? \
488 ((t +0u) / hz) * 1000u : \
489 ((t +0u) * 1000u) / hz)
490#endif
491
492#define hz2bintime(t) (ms2bintime(hztoms(t)))
493
494extern const int schedppq;
495extern size_t coherency_unit;
496
497#endif /* _KERNEL */
498
499/*
500 * Minimum alignment of "struct lwp" needed by the architecture.
501 * This counts when packing a lock byte into a word alongside a
502 * pointer to an LWP.
503 */
504#ifndef MIN_LWP_ALIGNMENT
505#define MIN_LWP_ALIGNMENT 32
506#endif
507#endif /* !__ASSEMBLER__ */
508
509#endif /* !_SYS_PARAM_H_ */
510