/*	$OpenBSD: pmap.h,v 1.7 1998/03/02 17:07:12 niklas Exp $	*/
/*	$NetBSD: pmap.h,v 1.16 1996/03/31 22:15:32 pk Exp $	*/

/* 
 * Copyright (c) 1991, 1993
 *	The 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.
 *
 * 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. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. 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.
 *
 *	@(#)pmap.h	8.1 (Berkeley) 6/11/93
 *
 *
 * Copyright (c) 1987, 1990 Carnegie-Mellon University.
 * All rights reserved.
 *
 * Author: Avadis Tevanian, Jr.
 * 
 * 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 address mapping definitions -- machine-independent
 *	section.  [For machine-dependent section, see "machine/pmap.h".]
 */

#ifndef	_PMAP_VM_
#define	_PMAP_VM_

/*
 * Each machine dependent implementation is expected to
 * keep certain statistics.  They may do this anyway they
 * so choose, but are expected to return the statistics
 * in the following structure.
 */
struct pmap_statistics {
	long		resident_count;	/* # of pages mapped (total)*/
	long		wired_count;	/* # of pages wired */
};
typedef struct pmap_statistics	*pmap_statistics_t;

#include <machine/pmap.h>

/*
 * PMAP_PGARG hack
 *
 * operations that take place on managed pages used to take PAs.
 * this caused us to translate the PA back to a page (or pv_head).
 * PMAP_NEW avoids this by passing the vm_page in (pv_head should be
 * pointed to by vm_page (or be a part of it)).
 *
 * applies to: pmap_page_protect, pmap_is_referenced, pmap_is_modified,
 * pmap_clear_reference, pmap_clear_modify.
 *
 * the latter two functions are boolean_t in PMAP_NEW.  they return
 * TRUE if something was cleared.
 */
#if defined(PMAP_NEW)
#define PMAP_PGARG(PG) (PG)
#else
#define PMAP_PGARG(PG) (VM_PAGE_TO_PHYS(PG))
#endif

#ifndef PMAP_EXCLUDE_DECLS	/* Used in Sparc port to virtualize pmap mod */
#ifdef _KERNEL
__BEGIN_DECLS
void		*pmap_bootstrap_alloc __P((int));
#if 0
/* Does not belong here! */
void		 pmap_bootstrap( /* machine dependent */ );
#endif
void		 pmap_change_wiring __P((pmap_t, vm_offset_t, boolean_t));

#if defined(PMAP_NEW)
#if !defined(pmap_clear_modify)
boolean_t	 pmap_clear_modify __P((struct vm_page *));
#endif
#if !defined(pmap_clear_reference)
boolean_t	 pmap_clear_reference __P((struct vm_page *));
#endif
#else	/* PMAP_NEW */
void		 pmap_clear_modify __P((vm_offset_t pa));
void		 pmap_clear_reference __P((vm_offset_t pa));
#endif	/* PMAP_NEW */

void		 pmap_collect __P((pmap_t));
void		 pmap_copy __P((pmap_t,
		    pmap_t, vm_offset_t, vm_size_t, vm_offset_t));
void		 pmap_copy_page __P((vm_offset_t, vm_offset_t));
#if defined(PMAP_NEW)
struct pmap 	 *pmap_create __P((void));
#else
pmap_t		 pmap_create __P((vm_size_t));
#endif
void		 pmap_destroy __P((pmap_t));
void		 pmap_enter __P((pmap_t,
		    vm_offset_t, vm_offset_t, vm_prot_t, boolean_t));
vm_offset_t	 pmap_extract __P((pmap_t, vm_offset_t));
#if defined(PMAP_NEW) && defined(PMAP_GROWKERNEL)
void		 pmap_growkernel __P((vm_offset_t));
#endif

#if !defined(MACHINE_NONCONTIG) && !defined(MACHINE_NEW_NONCONTIG)
void		 pmap_init __P((vm_offset_t, vm_offset_t));
#else
void		 pmap_init __P((void));
#endif

#if defined(PMAP_NEW)
void		 pmap_kenter_pa __P((vm_offset_t, vm_offset_t, vm_prot_t));
void		 pmap_kenter_pgs __P((vm_offset_t, struct vm_page **, int));
void		 pmap_kremove __P((vm_offset_t, vm_size_t));
#if !defined(pmap_is_modified)
boolean_t	 pmap_is_modified __P((struct vm_page *));
#endif
#if !defined(pmap_is_referenced)
boolean_t	 pmap_is_referenced __P((struct vm_page *));
#endif
#else	/* PMAP_NEW */
boolean_t	 pmap_is_modified __P((vm_offset_t pa));
boolean_t	 pmap_is_referenced __P((vm_offset_t pa));
#endif	/* PMAP_NEW */

#if !defined(MACHINE_NEW_NONCONTIG)
#ifndef pmap_page_index
int		 pmap_page_index __P((vm_offset_t));
#endif
#endif /* ! MACHINE_NEW_NONCONTIG */

#if defined(PMAP_NEW)
void		 pmap_page_protect __P((struct vm_page *, vm_prot_t));
#else
void		 pmap_page_protect __P((vm_offset_t, vm_prot_t));
#endif

void		 pmap_pageable __P((pmap_t,
		    vm_offset_t, vm_offset_t, boolean_t));
#if !defined(pmap_phys_address)
vm_offset_t	 pmap_phys_address __P((int));
#endif
void		 pmap_pinit __P((pmap_t));
void		 pmap_protect __P((pmap_t,
		    vm_offset_t, vm_offset_t, vm_prot_t));
void		 pmap_reference __P((pmap_t));
void		 pmap_release __P((pmap_t));
void		 pmap_remove __P((pmap_t, vm_offset_t, vm_offset_t));
void		 pmap_update __P((void));
void		 pmap_zero_page __P((vm_offset_t));

#ifdef MACHINE_NONCONTIG
u_int		 pmap_free_pages __P((void));
boolean_t	 pmap_next_page __P((vm_offset_t *));
#endif
#if defined(MACHINE_NEW_NONCONTIG) && defined(PMAP_STEAL_MEMORY)
vm_offset_t	 pmap_steal_memory __P((vm_size_t, vm_offset_t *,
		    vm_offset_t *));
#else
void		 pmap_virtual_space __P((vm_offset_t *, vm_offset_t *));
#endif
__END_DECLS
#endif	/* kernel*/
#endif  /* PMAP_EXCLUDE_DECLS */

/* XXX these are about to disappear real soon */
void		 pmap_startup __P((vm_offset_t *, vm_offset_t *));
vm_offset_t	 pmap_steal_memory __P((vm_size_t));

#endif /* _PMAP_VM_ */