osfmk/mach/upl.defs

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*
  23  * @OSF_COPYRIGHT@
  24  */
  25 /*
  26  * Mach Operating System
  27  * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
  28  * All Rights Reserved.
  29  *
  30  * Permission to use, copy, modify and distribute this software and its
  31  * documentation is hereby granted, provided that both the copyright
  32  * notice and this permission notice appear in all copies of the
  33  * software, derivative works or modified versions, and any portions
  34  * thereof, and that both notices appear in supporting documentation.
  35  *
  36  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  37  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  38  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  39  *
  40  * Carnegie Mellon requests users of this software to return to
  41  *
  42  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  43  *  School of Computer Science
  44  *  Carnegie Mellon University
  45  *  Pittsburgh PA 15213-3890
  46  *
  47  * any improvements or extensions that they make and grant Carnegie Mellon
  48  * the rights to redistribute these changes.
  49  */
  50 /*
  51  */
  52 /*
  53  * File:        mach/upl.defs
  54  *
  55  * Abstract:
  56  *      Basic Mach external memory management interface declaration.
  57  */
  58
  59 subsystem
  60 #if     KERNEL_USER
  61           KernelUser
  62 #endif  KERNEL_USER
  63 #if     KERNEL_SERVER
  64           KernelServer
  65 #endif  KERNEL_SERVER
  66                      upl 2050;
  67
  68 #ifdef  MACH_KERNEL
  69 #include <advisory_pageout.h>
  70 #endif  /* MACH_KERNEL */
  71
  72 #include <mach/std_types.defs>
  73 #include <mach/mach_types.defs>
  74
  75
  76 routine vm_object_upl_request(
  77                 object          :vm_object_entry_t;
  78         in      offset          :memory_object_offset_t;
  79         in      size            :vm_size_t;
  80         out     upl             :mach_port_move_send_t;
  81         out     page_list       :upl_page_list_ptr_t, CountInOut;
  82         in      cntrl_flags     :integer_t);
  83
  84 routine vm_pager_upl_request(
  85                 object          :vm_object_entry_t;
  86         in      offset          :memory_object_offset_t;
  87         in      size            :vm_size_t;
  88         in      super_size      :vm_size_t;
  89         out     upl             :mach_port_move_send_t;
  90         out     page_list       :upl_page_list_ptr_t, CountInOut;
  91         in      cntrl_flags     :integer_t);
  92
  93 routine vm_upl_abort(
  94                 upl_object      :upl_object_entry_t;
  95         in      abort_cond      :integer_t);
  96
  97 routine vm_upl_abort_range(
  98                 upl_object      :upl_object_entry_t;
  99                 offset          :vm_offset_t;
 100                 size            :vm_size_t;
 101         in      abort_cond      :integer_t);
 102
 103 routine vm_upl_commit(
 104                 upl_object      :upl_object_entry_t;
 105         in      page_list       :upl_page_list_ptr_t);
 106
 107 routine vm_upl_commit_range(
 108                 upl_object      :upl_object_entry_t;
 109                 offset          :vm_offset_t;
 110                 size            :vm_size_t;
 111         in      cntrl_flags     :integer_t;
 112         in      page_list       :upl_page_list_ptr_t);