usr/src/sys/vm/vm_param.h

/*
 * Copyright (c) 1991 Regents of the University of California.
 * All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * The Mach Operating System project at Carnegie-Mellon University.
 *
 * %sccs.include.redist.c%
 *
 *      @(#)vm_param.h  7.9 (Berkeley) %G%
 *
 *
 * Copyright (c) 1987, 1990 Carnegie-Mellon University.
 * All rights reserved.
 *
 * Authors: Avadis Tevanian, Jr., Michael Wayne Young
 *
 * Permission to use, copy, modify and distribute this software and
 * its documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 *
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 *
 * Carnegie Mellon requests users of this software to return to
 *
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 *
 * any improvements or extensions that they make and grant Carnegie the
 * rights to redistribute these changes.
 */

/*
 *      Machine independent virtual memory parameters.
 */

#ifndef _VM_PARAM_
#define _VM_PARAM_

#include <machine/vmparam.h>

/*
 * This belongs in types.h, but breaks too many existing programs.
 */
typedef int     boolean_t;
#define TRUE    1
#define FALSE   0

/*
 *      The machine independent pages are refered to as PAGES.  A page
 *      is some number of hardware pages, depending on the target machine.
 */
#define DEFAULT_PAGE_SIZE       4096

/*
 *      All references to the size of a page should be done with PAGE_SIZE
 *      or PAGE_SHIFT.  The fact they are variables is hidden here so that
 *      we can easily make them constant if we so desire.
 */
#define PAGE_SIZE       cnt.v_page_size         /* size of page */
#define PAGE_MASK       page_mask               /* size of page - 1 */
#define PAGE_SHIFT      page_shift              /* bits to shift for pages */
#ifdef KERNEL
extern vm_size_t        page_mask;
extern int              page_shift;
#endif

/*
 * CTL_VM identifiers
 */
#define VM_METER         1              /* struct vmmeter */
#define VM_LOADAVG       2              /* struct loadavg */
#define VM_MAXID         3              /* number of valid vm ids */

#define CTL_VM_NAMES { \
        { 0, 0 }, \
        { "vmmeter", CTLTYPE_STRUCT }, \
        { "loadavg", CTLTYPE_STRUCT }, \
}

/*
 *      Return values from the VM routines.
 */
#define KERN_SUCCESS            0
#define KERN_INVALID_ADDRESS    1
#define KERN_PROTECTION_FAILURE 2
#define KERN_NO_SPACE           3
#define KERN_INVALID_ARGUMENT   4
#define KERN_FAILURE            5
#define KERN_RESOURCE_SHORTAGE  6
#define KERN_NOT_RECEIVER       7
#define KERN_NO_ACCESS          8

#ifndef ASSEMBLER
/*
 *      Convert addresses to pages and vice versa.
 *      No rounding is used.
 */
#ifdef KERNEL
#define atop(x)         (((unsigned)(x)) >> PAGE_SHIFT)
#define ptoa(x)         ((vm_offset_t)((x) << PAGE_SHIFT))

/*
 * Round off or truncate to the nearest page.  These will work
 * for either addresses or counts (i.e., 1 byte rounds to 1 page).
 */
#define round_page(x) \
        ((vm_offset_t)((((vm_offset_t)(x)) + PAGE_MASK) & ~PAGE_MASK))
#define trunc_page(x) \
        ((vm_offset_t)(((vm_offset_t)(x)) & ~PAGE_MASK))
#define num_pages(x) \
        ((vm_offset_t)((((vm_offset_t)(x)) + PAGE_MASK) >> PAGE_SHIFT))

extern vm_size_t        mem_size;       /* size of physical memory (bytes) */
extern vm_offset_t      first_addr;     /* first physical page */
extern vm_offset_t      last_addr;      /* last physical page */

#else
/* out-of-kernel versions of round_page and trunc_page */
#define round_page(x) \
       ((((vm_offset_t)(x) + (vm_page_size - 1)) / vm_page_size) * vm_page_size)
#define trunc_page(x) \
        ((((vm_offset_t)(x)) / vm_page_size) * vm_page_size)

#endif /* KERNEL */
#endif /* ASSEMBLER */
#endif /* _VM_PARAM_ */