Source to osfmk/mach/upl.defs

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This Original Code and all software distributed under the License are
 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 */
/* 
 * Mach Operating System
 * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
 * All Rights Reserved.
 * 
 * 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  [email protected]
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 * 
 * any improvements or extensions that they make and grant Carnegie Mellon
 * the rights to redistribute these changes.
 */
/*
 */
/*
 * File:	mach/upl.defs
 *
 * Abstract:
 *	Basic Mach external memory management interface declaration.
 */

subsystem
#if	KERNEL_USER
	  KernelUser
#endif	KERNEL_USER
#if	KERNEL_SERVER
	  KernelServer
#endif	KERNEL_SERVER
		     upl 2050;

#ifdef	MACH_KERNEL
#include <advisory_pageout.h>
#endif	/* MACH_KERNEL */

#include <mach/std_types.defs>
#include <mach/mach_types.defs>


routine vm_object_upl_request(
		object		:vm_object_entry_t;
	in	offset		:memory_object_offset_t;
	in	size		:vm_size_t;
	out	upl		:mach_port_move_send_t;
	out	page_list	:upl_page_list_ptr_t, CountInOut;
	in	cntrl_flags	:integer_t);

routine vm_pager_upl_request(
		object		:vm_object_entry_t;
	in	offset		:memory_object_offset_t;
	in	size		:vm_size_t;
	in	super_size	:vm_size_t;
	out	upl		:mach_port_move_send_t;
	out	page_list	:upl_page_list_ptr_t, CountInOut;
	in	cntrl_flags	:integer_t);

routine vm_upl_abort(
		upl_object	:upl_object_entry_t;
	in	abort_cond	:integer_t);

routine vm_upl_abort_range(
		upl_object	:upl_object_entry_t;
		offset		:vm_offset_t;
		size		:vm_size_t;
	in	abort_cond	:integer_t);
 
routine vm_upl_commit(
		upl_object	:upl_object_entry_t;
	in	page_list	:upl_page_list_ptr_t);

routine vm_upl_commit_range(
		upl_object	:upl_object_entry_t;
		offset		:vm_offset_t;
		size		:vm_size_t;
		free_on_empty	:boolean_t;
	in	page_list	:upl_page_list_ptr_t);