/*-
 * Copyright (c) 1990 The Regents of the University of California.
 * Copyright (c) 2008 The DragonFly Project.
 * All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * William Jolitz.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	from: @(#)param.h	5.8 (Berkeley) 6/28/91
 * $FreeBSD: src/sys/i386/include/param.h,v 1.54.2.8 2002/08/31 21:15:55 dillon Exp $
 */

#ifndef _CPU_PARAM_H_
#define _CPU_PARAM_H_

/*
 * Machine dependent constants for x86_64.
 */

#ifndef _MACHINE
#define	_MACHINE	x86_64
#endif
#ifndef _MACHINE_ARCH
#define	_MACHINE_ARCH	x86_64
#endif

#ifndef MACHINE
#define MACHINE		"x86_64"
#endif
#ifndef MACHINE_ARCH
#define	MACHINE_ARCH	"x86_64"
#endif

/*
 * Use SMP_MAXCPU instead of MAXCPU for structures that are intended to
 * remain compatible between UP and SMP builds.
 *
 * WARNING!  CPUMASK macros in include/cpumask.h must also be adjusted,
 *	     as well as any assembly.  Be sure that _CPUMASK_ELEMENTS
 *	     is always correct so incompatible assembly #error's out
 *	     during the kernel compile.
 *
 * WARNING!  To raise SMP_MAXCPU further we probably need to reserve
 *	     more KVM space via MPPTDI (platform/pc64/include/pmap.h),
 *	     depends on SMP_MAXCPU * sizeof(struct privatedata).
 */
#define SMP_MAXCPU	256
#define MAXCPU		SMP_MAXCPU

/* Constants derived from sizeof() that need recalculation. */
/* level 1 == page table */
#define NPTEPGSHIFT	9		/* LOG2(NPTEPG) */
#define PAGE_SHIFT	12		/* LOG2(PAGE_SIZE) */
#define PAGE_SIZE	(1<<PAGE_SHIFT)	/* bytes/page */
#define PAGE_MASK	(PAGE_SIZE-1)
#define NPTEPG		(PAGE_SIZE/8LU)	/* PAGE_SIZE/sizeof(pt_entry_t) */

/* level 2 == page directory */
#define NPDEPGSHIFT	9		/* LOG2(NPDEPG) */
#define PDRSHIFT	21		/* LOG2(NBPDR) */
#define NBPDR		(1<<PDRSHIFT)	/* bytes/page dir */
#define PDRMASK		(NBPDR-1)
#define NPDEPG		(PAGE_SIZE/8LU)	/* PAGE_SIZE/sizeof(pd_entry_t) */

/* level 3 == page directory pointer table */
#define NPDPEPGSHIFT	9		/* LOG2(NPDPEPG) */
#define PDPSHIFT	30		/* LOG2(NBPDP) */
#define NBPDP		(1<<PDPSHIFT)	/* bytes/page dir ptr table */
#define PDPMASK		(NBPDP-1)
#define NPDPEPG		(PAGE_SIZE/8LU)	/* PAGE_SIZE/sizeof(pdp_entry_t) */

/* level 4 */
#define NPML4EPGSHIFT	9		/* LOG2(NPML4EPG) */
#define PML4SHIFT	39		/* LOG2(NBPML4) */
#define NBPML4		(1UL<<PML4SHIFT)/* bytes/page map level4 table */
#define PML4MASK	(NBPML4-1)
#define NPML4EPG	(PAGE_SIZE/8LU)	/* PAGE_SIZE/sizeof(pml4_entry_t) */

/*
 * Virtual address sign-extension and mask.  If bit 47 is set then
 * set all higher bits.
 */
#define PML4_SIGNMASK  0xFFFF800000000000LU

/* for vkernel */
#define SEG_SHIFT	21
#define SEG_SIZE	(1<<SEG_SHIFT)	/* bytes per mmu segment (level 1) */
#define SEG_MASK	(SEG_SIZE-1)

#define DEV_BSHIFT	9		/* log2(DEV_BSIZE) */
#define DEV_BSIZE	(1<<DEV_BSHIFT)
#define DEV_BMASK	(DEV_BSIZE - 1)

#ifndef BLKDEV_IOSIZE
#define BLKDEV_IOSIZE	PAGE_SIZE	/* default block device I/O size */
#endif
#define DFLTPHYS	(64 * 1024)	/* default max raw I/O transfer size */
#define MAXPHYS		(128 * 1024)	/* max raw I/O transfer size */
#define MAXDUMPPGS	(MAXPHYS/PAGE_SIZE)

#define IOPAGES		2		/* pages of i/o permission bitmap */
#define UPAGES		4		/* pages of u-area */

/*
 * Ceiling on amount of swblock kva space, can be changed via
 * kern.maxswzone /boot/loader.conf variable.  On 64 bit machines
 * the kernel has a 512G address space, and we do not want to allow
 * more than half of that to be used for this purpose.
 *
 * Approximately (size / 192 x 16 x PAGE_SIZE) bytes of swap.  This
 * comes to approximately 1GB of swap space per 1MB of kernel memory.
 * Actually using 512G of swap will tie up a big chunk (512M) of physical
 * memory.
 */
#ifndef VM_SWZONE_SIZE_MAX
#define VM_SWZONE_SIZE_MAX	(256L * 1024L * 1024 * 1024)
#endif

/*
 * Ceiling on size of buffer cache (really only effects write queueing,
 * the VM page cache is not effected), can be changed via
 * kern.maxbcache /boot/loader.conf variable.
 *
 * This value is unbounded on 64-bit boxes, boot code will limit the
 * buffer cache size to a portion of available physical memory.
 */
#ifndef VM_BCACHE_SIZE_MAX
#define VM_BCACHE_SIZE_MAX	0
#endif

/*
 * Some macros for units conversion
 */

/* clicks to bytes */
#define ctob(x)	((x)<<PAGE_SHIFT)

/* bytes to clicks */
#define btoc(x)	(((unsigned)(x)+PAGE_MASK)>>PAGE_SHIFT)

/*
 * btodb() is messy and perhaps slow because `bytes' may be an off_t.  We
 * want to shift an unsigned type to avoid sign extension and we don't
 * want to widen `bytes' unnecessarily.  Assume that the result fits in
 * a daddr_t.
 */
#define btodb(bytes)	 		/* calculates (bytes / DEV_BSIZE) */ \
	(sizeof (bytes) > sizeof(long) \
	 ? (daddr_t)((unsigned long long)(bytes) >> DEV_BSHIFT) \
	 : (daddr_t)((unsigned long)(bytes) >> DEV_BSHIFT))

#define dbtob(db)			/* calculates (db * DEV_BSIZE) */ \
	((off_t)(db) << DEV_BSHIFT)

/*
 * Mach derived conversion macros
 */
#define	round_page(x)	((((unsigned long)(x)) + PAGE_MASK) & ~(unsigned long)(PAGE_MASK))
#define	trunc_page(x)	((unsigned long)(x) & ~(unsigned long)(PAGE_MASK))

#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
#define	atop(x)		((vm_pindex_t)((x) >> PAGE_SHIFT))
#define	ptoa(x)		((vm_paddr_t)(x) << PAGE_SHIFT)

#define	x86_64_btop(x)	((vm_pindex_t)((x) >> PAGE_SHIFT))
#define	x86_64_ptob(x)	((vm_paddr_t)(x) << PAGE_SHIFT)

#define	pgtok(x)		((x) * (PAGE_SIZE / 1024))
#endif	/* _KERNEL || _KERNEL_STRUCTURES */

#ifdef _KERNEL

/*
 * We put here the definition of two debugging macros/function which
 * are very convenient to have available.
 * The macro is called TSTMP() and is used to timestamp events in the
 * kernel using the TSC register, and export them to userland through
 * the sysctl variable debug.timestamp, which is a circular buffer
 * holding pairs of u_int32_t variables <timestamp, argument> .
 * They can be retrieved with something like
 *
 *	sysctl -b debug.timestamp | hexdump -e '"%15u %15u\n"'
 *
 * The function _TSTMP() is defined in i386/isa/clock.c. It does not
 * try to grab any locks or block interrupts or identify which CPU it
 * is running on. You are supposed to know what to do if you use it.
 *
 * The macros must be enabled with "options KERN_TIMESTAMP" in the kernel
 * config file, otherwise they default to an empty block.
 */

#ifdef KERN_TIMESTAMP
void _TSTMP(u_int32_t);
#define TSTMP(class, unit, event, par)	_TSTMP(	\
	(((class) &   0x0f) << 28 ) |		\
	(((unit)  &   0x0f) << 24 ) |		\
	(((event) &   0xff) << 16 ) |		\
	(((par)   & 0xffff)       )   )

#else /* !KERN_TIMESTAMP */
#define        _TSTMP(x)                       {}
#define        TSTMP(class, unit, event, par)  _TSTMP(0)
#endif /* !KERN_TIMESTAMP */
#endif /* _KERNEL */

#endif /* !_CPU_PARAM_H_ */