4324d9b9206161ddfef4aa2fd251e5c0f2c6ec1b
[dragonfly.git] / sys / cpu / i386 / include / param.h
1 /*-
2  * Copyright (c) 1990 The Regents of the University of California.
3  * All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * William Jolitz.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *      This product includes software developed by the University of
19  *      California, Berkeley and its contributors.
20  * 4. 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  *      from: @(#)param.h       5.8 (Berkeley) 6/28/91
37  * $FreeBSD: src/sys/i386/include/param.h,v 1.54.2.8 2002/08/31 21:15:55 dillon Exp $
38  * $DragonFly: src/sys/cpu/i386/include/param.h,v 1.10 2006/11/07 06:43:22 dillon Exp $
39  */
40
41 #ifndef _CPU_PARAM_H_
42
43 /*
44  * Do not prevent re-includes of <machine/param.h> if the file was included
45  * with NO_NAMESPACE_POLLUTION, or expected macros will not exist.
46  */
47 #ifndef _NO_NAMESPACE_POLLUTION
48 #define _CPU_PARAM_H_
49 #endif
50
51 /*
52  * Machine dependent constants for Intel 386.
53  */
54 #ifndef _CPU_PARAM_H1_
55 #define _CPU_PARAM_H1_
56
57 /*
58  * Round p (pointer or byte index) up to a correctly-aligned value
59  * for all data types (int, long, ...).   The result is unsigned int
60  * and must be cast to any desired pointer type.
61  */
62 #ifndef _ALIGNBYTES
63 #define _ALIGNBYTES     (sizeof(int) - 1)
64 #endif
65 #ifndef _ALIGN
66 #define _ALIGN(p)       (((unsigned)(p) + _ALIGNBYTES) & ~_ALIGNBYTES)
67 #endif
68
69 #ifndef _MACHINE_ARCH
70 #define _MACHINE_ARCH   i386    /* cpu architecture */
71 #endif
72 #ifndef _MACHINE_CPU
73 #define _MACHINE_CPU    i386    /* minimum supported cpu rev */
74 #endif
75
76 #endif  /* _CPU_PARAM_H1_ */
77
78 #ifndef _NO_NAMESPACE_POLLUTION
79
80 #ifndef MACHINE_ARCH
81 #define MACHINE_ARCH    "i386"  /* cpu architecture */
82 #endif
83
84 #ifndef MACHINE_CPU
85 #define MACHINE_CPU     "i386"  /* minimum supported cpu rev */
86 #endif
87
88 #define MID_MACHINE     MID_I386
89
90 /*
91  * Use SMP_MAXCPU instead of MAXCPU for structures that are intended to
92  * remain compatible between UP and SMP builds.
93  */
94 #define SMP_MAXCPU      16
95 #ifdef SMP
96 #define MAXCPU          SMP_MAXCPU
97 #else
98 #define MAXCPU          1
99 #endif /* SMP */
100
101 #define ALIGNBYTES      _ALIGNBYTES
102 #define ALIGN(p)        _ALIGN(p)
103
104 #define PAGE_SHIFT      12              /* LOG2(PAGE_SIZE) */
105 #define PAGE_SIZE       (1<<PAGE_SHIFT) /* bytes/page */
106 #define PAGE_MASK       (PAGE_SIZE-1)
107 #define NPTEPG          (PAGE_SIZE/(sizeof (pt_entry_t)))
108
109 #define NPDEPG          (PAGE_SIZE/(sizeof (pd_entry_t)))
110 #define PDRSHIFT        22              /* LOG2(NBPDR) */
111 #define NBPDR           (1<<PDRSHIFT)   /* bytes/page dir */
112 #define PDRMASK         (NBPDR-1)
113
114 #define DEV_BSHIFT      9               /* log2(DEV_BSIZE) */
115 #define DEV_BSIZE       (1 << DEV_BSHIFT)
116 #define DEV_BMASK       (DEV_BSIZE - 1)
117
118 #ifndef BLKDEV_IOSIZE
119 #define BLKDEV_IOSIZE   PAGE_SIZE       /* default block device I/O size */
120 #endif
121 #define DFLTPHYS        (64 * 1024)     /* default max raw I/O transfer size */
122 #define MAXPHYS         (128 * 1024)    /* max raw I/O transfer size */
123 #define MAXDUMPPGS      (DFLTPHYS/PAGE_SIZE)
124
125 #define IOPAGES 2               /* pages of i/o permission bitmap */
126 #define UPAGES  3               /* pages of u-area */
127
128 /*
129  * Ceiling on amount of swblock kva space, can be changed via
130  * kern.maxswzone /boot/loader.conf variable.
131  */
132 #ifndef VM_SWZONE_SIZE_MAX
133 #define VM_SWZONE_SIZE_MAX      (32 * 1024 * 1024)
134 #endif
135
136 /*
137  * Ceiling on size of buffer cache (really only effects write queueing,
138  * the VM page cache is not effected), can be changed via
139  * kern.maxbcache /boot/loader.conf variable.
140  */
141 #ifndef VM_BCACHE_SIZE_MAX
142 #define VM_BCACHE_SIZE_MAX      (200 * 1024 * 1024)
143 #endif
144
145
146 /*
147  * Constants related to network buffer management.
148  * MCLBYTES must be no larger than CLBYTES (the software page size), and,
149  * on machines that exchange pages of input or output buffers with mbuf
150  * clusters (MAPPED_MBUFS), MCLBYTES must also be an integral multiple
151  * of the hardware page size.
152  */
153 #ifndef MSIZE
154 #define MSIZE           256             /* size of an mbuf */
155 #endif  /* MSIZE */
156
157 #ifndef MCLSHIFT
158 #define MCLSHIFT        11              /* convert bytes to m_buf clusters */
159 #endif  /* MCLSHIFT */
160 #define MCLBYTES        (1 << MCLSHIFT) /* size of an m_buf cluster */
161 #define MCLOFSET        (MCLBYTES - 1)  /* offset within an m_buf cluster */
162
163 /*
164  * Some macros for units conversion
165  */
166
167 /* clicks to bytes */
168 #define ctob(x) ((x)<<PAGE_SHIFT)
169
170 /* bytes to clicks */
171 #define btoc(x) (((unsigned)(x)+PAGE_MASK)>>PAGE_SHIFT)
172
173 /*
174  * btodb() is messy and perhaps slow because `bytes' may be an off_t.  We
175  * want to shift an unsigned type to avoid sign extension and we don't
176  * want to widen `bytes' unnecessarily.  Assume that the result fits in
177  * a daddr_t.
178  */
179 #define btodb(bytes)                    /* calculates (bytes / DEV_BSIZE) */ \
180         (sizeof (bytes) > sizeof(long) \
181          ? (daddr_t)((unsigned long long)(bytes) >> DEV_BSHIFT) \
182          : (daddr_t)((unsigned long)(bytes) >> DEV_BSHIFT))
183
184 #define dbtob(db)                       /* calculates (db * DEV_BSIZE) */ \
185         ((off_t)(db) << DEV_BSHIFT)
186
187 /*
188  * Mach derived conversion macros
189  */
190 #define trunc_page(x)           ((x) & ~PAGE_MASK)
191 #define round_page(x)           (((x) + PAGE_MASK) & ~PAGE_MASK)
192 #define trunc_4mpage(x)         ((x) & ~PDRMASK)
193 #define round_4mpage(x)         ((((x)) + PDRMASK) & ~PDRMASK)
194
195 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
196 #define atop(x)                 ((x) >> PAGE_SHIFT)
197 #endif
198 #define ptoa(x)                 ((x) << PAGE_SHIFT)
199
200 #define i386_btop(x)            ((x) >> PAGE_SHIFT)
201 #define i386_ptob(x)            ((x) << PAGE_SHIFT)
202
203 #define pgtok(x)                ((x) * (PAGE_SIZE / 1024))
204
205 #ifdef _KERNEL
206
207 /*
208  * We put here the definition of two debugging macros/function which
209  * are very convenient to have available.
210  * The macro is called TSTMP() and is used to timestamp events in the
211  * kernel using the TSC register, and export them to userland through
212  * the sysctl variable debug.timestamp, which is a circular buffer
213  * holding pairs of u_int32_t variables <timestamp, argument> .
214  * They can be retrieved with something like
215  *
216  *      sysctl -b debug.timestamp | hexdump -e '"%15u %15u\n"'
217  *
218  * The function _TSTMP() is defined in i386/isa/clock.c. It does not
219  * try to grab any locks or block interrupts or identify which CPU it
220  * is running on. You are supposed to know what to do if you use it.
221  *
222  * The macros must be enabled with "options KERN_TIMESTAMP" in the kernel
223  * config file, otherwise they default to an empty block.
224  */
225
226 #ifdef KERN_TIMESTAMP
227 extern void _TSTMP(u_int32_t argument);
228 #define TSTMP(class, unit, event, par)  _TSTMP( \
229         (((class) &   0x0f) << 28 ) |           \
230         (((unit)  &   0x0f) << 24 ) |           \
231         (((event) &   0xff) << 16 ) |           \
232         (((par)   & 0xffff)       )   )
233
234 #else /* !KERN_TIMESTAMP */
235 #define        _TSTMP(x)                       {}
236 #define        TSTMP(class, unit, event, par)  _TSTMP(0)
237 #endif /* !KERN_TIMESTAMP */
238 #endif /* _KERNEL */
239
240 #endif /* !_NO_NAMESPACE_POLLUTION */
241 #endif /* !_CPU_PARAM_H_ */