osfmk/vm/memory_object.h

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