xref: /dragonfly/sys/cpu/x86_64/include/param.h (revision 31524921)
1 /*-
2  * Copyright (c) 1990 The Regents of the University of California.
3  * Copyright (c) 2008 The DragonFly Project.
4  * All rights reserved.
5  *
6  * This code is derived from software contributed to Berkeley by
7  * William Jolitz.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *	This product includes software developed by the University of
20  *	California, Berkeley and its contributors.
21  * 4. Neither the name of the University nor the names of its contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  *	from: @(#)param.h	5.8 (Berkeley) 6/28/91
38  * $FreeBSD: src/sys/i386/include/param.h,v 1.54.2.8 2002/08/31 21:15:55 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 x86_64.
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(long) - 1)
64 #endif
65 #ifndef _ALIGN
66 #define _ALIGN(p)	(((unsigned long)(p) + _ALIGNBYTES) & ~_ALIGNBYTES)
67 #endif
68 
69 #ifndef _MACHINE
70 #define	_MACHINE	x86_64
71 #endif
72 #ifndef _MACHINE_ARCH
73 #define	_MACHINE_ARCH	x86_64
74 #endif
75 
76 #endif	/* _CPU_PARAM_H1_ */
77 
78 #ifndef _NO_NAMESPACE_POLLUTION
79 
80 #ifndef MACHINE
81 #define MACHINE		"x86_64"
82 #endif
83 #ifndef MACHINE_ARCH
84 #define	MACHINE_ARCH	"x86_64"
85 #endif
86 
87 /*
88  * Use SMP_MAXCPU instead of MAXCPU for structures that are intended to
89  * remain compatible between UP and SMP builds.
90  *
91  * WARNING!  CPUMASK macros in include/types.h must also be adjusted,
92  *	     as well as any assembly.  Be sure that CPUMASK_ELEMENTS
93  *	     is always correct so incompatible assembly #error's out
94  *	     during the kernel compile.
95  *
96  * WARNING!  To raise SMP_MAXCPU further we probably need to reserve
97  *	     more KVM space via MPPTDI (platform/pc64/include/pmap.h),
98  *	     depends on SMP_MAXCPU * sizeof(struct privatedata).
99  */
100 #define SMP_MAXCPU	256
101 #define MAXCPU		SMP_MAXCPU
102 
103 #define ALIGNBYTES	_ALIGNBYTES
104 #define ALIGN(p)	_ALIGN(p)
105 
106 /* JG license? from fbsd/src/sys/amd64/include/param.h */
107 /* level 1 == page table */
108 #define	NPTEPGSHIFT	9		/* LOG2(NPTEPG) */
109 #define PAGE_SHIFT	12		/* LOG2(PAGE_SIZE) */
110 #define PAGE_SIZE	(1<<PAGE_SHIFT)	/* bytes/page */
111 #define PAGE_MASK	(PAGE_SIZE-1)
112 #define NPTEPG		(PAGE_SIZE/(sizeof (pt_entry_t)))
113 
114 /* level 2 == page directory */
115 #define	NPDEPGSHIFT	9		/* LOG2(NPDEPG) */
116 #define PDRSHIFT	21		/* LOG2(NBPDR) */
117 #define NBPDR		(1<<PDRSHIFT)	/* bytes/page dir */
118 #define PDRMASK		(NBPDR-1)
119 #define NPDEPG		(PAGE_SIZE/(sizeof (pd_entry_t)))
120 
121 /* level 3 == page directory pointer table */
122 #define	NPDPEPGSHIFT	9		/* LOG2(NPDPEPG) */
123 #define PDPSHIFT	30		/* LOG2(NBPDP) */
124 #define NBPDP		(1<<PDPSHIFT)	/* bytes/page dir ptr table */
125 #define PDPMASK		(NBPDP-1)
126 #define NPDPEPG		(PAGE_SIZE/(sizeof (pdp_entry_t)))
127 
128 /* level 4 */
129 #define	NPML4EPGSHIFT	9		/* LOG2(NPML4EPG) */
130 #define PML4SHIFT	39		/* LOG2(NPML4) */
131 #define NPML4		(1UL<<PML4SHIFT)/* bytes/page map level4 table */
132 #define	NBPML4		(1ul<<PML4SHIFT)/* bytes/page map lev4 table */
133 #define PML4MASK	(NPML4-1)
134 #define NPML4EPG	(PAGE_SIZE/(sizeof (pml4_entry_t)))
135 
136 /*
137  * Virtual address sign-extension and mask.  If bit 47 is set then
138  * set all higher bits.
139  */
140 #define PML4_SIGNMASK  0xFFFF800000000000LU
141 
142 /* for vkernel */
143 #define SEG_SHIFT	21
144 #define SEG_SIZE	(1<<SEG_SHIFT)	/* bytes per mmu segment (level 1) */
145 #define SEG_MASK	(SEG_SIZE-1)
146 
147 #define DEV_BSHIFT	9		/* log2(DEV_BSIZE) */
148 #define DEV_BSIZE	(1<<DEV_BSHIFT)
149 #define DEV_BMASK	(DEV_BSIZE - 1)
150 
151 #ifndef BLKDEV_IOSIZE
152 #define BLKDEV_IOSIZE	PAGE_SIZE	/* default block device I/O size */
153 #endif
154 #define DFLTPHYS	(64 * 1024)	/* default max raw I/O transfer size */
155 #define MAXPHYS		(128 * 1024)	/* max raw I/O transfer size */
156 #define MAXDUMPPGS	(MAXPHYS/PAGE_SIZE)
157 
158 #define IOPAGES		2		/* pages of i/o permission bitmap */
159 #define UPAGES		4		/* pages of u-area */
160 
161 /*
162  * Ceiling on amount of swblock kva space, can be changed via
163  * kern.maxswzone /boot/loader.conf variable.  On 64 bit machines
164  * the kernel has a 512G address space so reserving 512M of KVM
165  * is not a big deal.
166  *
167  * Approximately (size / 160 x 32 x PAGE_SIZE) bytes of swap.  This
168  * comes to approximately 1GB of swap space per 1MB of kernel memory.
169  * Actually using 512G of swap will tie up a big chunk (512M) of physical
170  * memory.
171  */
172 #ifndef VM_SWZONE_SIZE_MAX
173 #define VM_SWZONE_SIZE_MAX	(512L * 1024 * 1024)
174 #endif
175 
176 /*
177  * Ceiling on size of buffer cache (really only effects write queueing,
178  * the VM page cache is not effected), can be changed via
179  * kern.maxbcache /boot/loader.conf variable.
180  *
181  * This value is unbounded on 64-bit boxes, boot code will limit the
182  * buffer cache size to a portion of available physical memory.
183  */
184 #ifndef VM_BCACHE_SIZE_MAX
185 #define VM_BCACHE_SIZE_MAX	0
186 #endif
187 
188 /*
189  * Some macros for units conversion
190  */
191 
192 /* clicks to bytes */
193 #define ctob(x)	((x)<<PAGE_SHIFT)
194 
195 /* bytes to clicks */
196 #define btoc(x)	(((unsigned)(x)+PAGE_MASK)>>PAGE_SHIFT)
197 
198 /*
199  * btodb() is messy and perhaps slow because `bytes' may be an off_t.  We
200  * want to shift an unsigned type to avoid sign extension and we don't
201  * want to widen `bytes' unnecessarily.  Assume that the result fits in
202  * a daddr_t.
203  */
204 #define btodb(bytes)	 		/* calculates (bytes / DEV_BSIZE) */ \
205 	(sizeof (bytes) > sizeof(long) \
206 	 ? (daddr_t)((unsigned long long)(bytes) >> DEV_BSHIFT) \
207 	 : (daddr_t)((unsigned long)(bytes) >> DEV_BSHIFT))
208 
209 #define dbtob(db)			/* calculates (db * DEV_BSIZE) */ \
210 	((off_t)(db) << DEV_BSHIFT)
211 
212 /*
213  * Mach derived conversion macros
214  */
215 #define	round_page(x)	((((unsigned long)(x)) + PAGE_MASK) & ~(unsigned long)(PAGE_MASK))
216 #define	trunc_page(x)	((unsigned long)(x) & ~(unsigned long)(PAGE_MASK))
217 #define trunc_2mpage(x)	((unsigned long)(x) & ~(unsigned long)PDRMASK)
218 #define round_2mpage(x)	((((unsigned long)(x)) + PDRMASK) & ~(unsigned long)PDRMASK)
219 
220 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
221 #define	atop(x)		((vm_pindex_t)((x) >> PAGE_SHIFT))
222 #endif
223 #define	ptoa(x)		((vm_paddr_t)(x) << PAGE_SHIFT)
224 
225 #define	x86_64_btop(x)	((vm_pindex_t)((x) >> PAGE_SHIFT))
226 #define	x86_64_ptob(x)	((vm_paddr_t)(x) << PAGE_SHIFT)
227 
228 #define	pgtok(x)		((x) * (PAGE_SIZE / 1024))
229 
230 #ifdef _KERNEL
231 
232 /*
233  * We put here the definition of two debugging macros/function which
234  * are very convenient to have available.
235  * The macro is called TSTMP() and is used to timestamp events in the
236  * kernel using the TSC register, and export them to userland through
237  * the sysctl variable debug.timestamp, which is a circular buffer
238  * holding pairs of u_int32_t variables <timestamp, argument> .
239  * They can be retrieved with something like
240  *
241  *	sysctl -b debug.timestamp | hexdump -e '"%15u %15u\n"'
242  *
243  * The function _TSTMP() is defined in i386/isa/clock.c. It does not
244  * try to grab any locks or block interrupts or identify which CPU it
245  * is running on. You are supposed to know what to do if you use it.
246  *
247  * The macros must be enabled with "options KERN_TIMESTAMP" in the kernel
248  * config file, otherwise they default to an empty block.
249  */
250 
251 #ifdef KERN_TIMESTAMP
252 extern void _TSTMP(u_int32_t argument);
253 #define TSTMP(class, unit, event, par)	_TSTMP(	\
254 	(((class) &   0x0f) << 28 ) |		\
255 	(((unit)  &   0x0f) << 24 ) |		\
256 	(((event) &   0xff) << 16 ) |		\
257 	(((par)   & 0xffff)       )   )
258 
259 #else /* !KERN_TIMESTAMP */
260 #define        _TSTMP(x)                       {}
261 #define        TSTMP(class, unit, event, par)  _TSTMP(0)
262 #endif /* !KERN_TIMESTAMP */
263 #endif /* _KERNEL */
264 
265 #endif /* !_NO_NAMESPACE_POLLUTION */
266 #endif /* !_CPU_PARAM_H_ */
267