osfmk/vm/memory_object.h

   1 /*
   2  * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License.  The rights granted to you under the
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 /*
  31  * @OSF_COPYRIGHT@
  32  */
  33 /*
  34  * Mach Operating System
  35  * Copyright (c) 1991 Carnegie Mellon University
  36  * All Rights Reserved.
  37  *
  38  * Permission to use, copy, modify and distribute this software and its
  39  * documentation is hereby granted, provided that both the copyright
  40  * notice and this permission notice appear in all copies of the
  41  * software, derivative works or modified versions, and any portions
  42  * thereof, and that both notices appear in supporting documentation.
  43  *
  44  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS
  45  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  46  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  47  *
  48  * Carnegie Mellon requests users of this software to return to
  49  *
  50  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  51  *  School of Computer Science
  52  *  Carnegie Mellon University
  53  *  Pittsburgh PA 15213-3890
  54  *
  55  * any improvements or extensions that they make and grant Carnegie the
  56  * rights to redistribute these changes.
  57  */
  58 /*
  59  */
  60
  61 #ifndef _VM_MEMORY_OBJECT_H_
  62 #define _VM_MEMORY_OBJECT_H_
  63
  64 #include <mach_pagemap.h>
  65
  66 #include <mach/boolean.h>
  67 #include <mach/mach_types.h>
  68 #include <mach/memory_object_types.h>
  69 #include <ipc/ipc_types.h>
  70
  71 __private_extern__
  72 memory_object_default_t memory_manager_default_reference(
  73                                 vm_size_t               *cluster_size);
  74
  75 __private_extern__
  76 kern_return_t           memory_manager_default_check(void);
  77
  78 __private_extern__
  79 void                    memory_manager_default_init(void);
  80
  81 __private_extern__
  82 void                    memory_object_control_bootstrap(void);
  83 __private_extern__
  84 memory_object_control_t memory_object_control_allocate(
  85                                 vm_object_t             object);
  86
  87 __private_extern__
  88 void                    memory_object_control_collapse(
  89                                 memory_object_control_t control,
  90                                 vm_object_t             object);
  91
  92 __private_extern__
  93 vm_object_t             memory_object_control_to_vm_object(
  94                                 memory_object_control_t control);
  95
  96 extern
  97 mach_port_t             convert_mo_control_to_port(
  98                                 memory_object_control_t control);
  99
 100 extern void memory_object_control_disable(
 101         memory_object_control_t control);
 102
 103 extern
 104 memory_object_control_t convert_port_to_mo_control(
 105                                 mach_port_t             port);
 106
 107 extern
 108 mach_port_t             convert_memory_object_to_port(
 109                                 memory_object_t         object);
 110
 111 extern
 112 memory_object_t         convert_port_to_memory_object(
 113                                 mach_port_t             port);
 114
 115 extern upl_t convert_port_to_upl(
 116                                 ipc_port_t      port);
 117
 118 extern ipc_port_t convert_upl_to_port( upl_t );
 119
 120 __private_extern__ void upl_no_senders(ipc_port_t, mach_port_mscount_t);
 121
 122 extern kern_return_t    memory_object_free_from_cache(
 123                                 host_t          host,
 124                                 int             *pager_id,
 125                                 int             *count);
 126
 127 extern kern_return_t    memory_object_iopl_request(
 128         ipc_port_t              port,
 129         memory_object_offset_t  offset,
 130         vm_size_t               *upl_size,
 131         upl_t                   *upl_ptr,
 132         upl_page_info_array_t   user_page_list,
 133         unsigned int            *page_list_count,
 134         int                     *flags);
 135
 136
 137 extern kern_return_t    memory_object_pages_resident(
 138         memory_object_control_t         control,
 139         boolean_t                       *               has_pages_resident);
 140
 141 #endif  /* _VM_MEMORY_OBJECT_H_ */