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  * 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 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
  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 the
  48  * rights to redistribute these changes.
  49  */
  50 /*
  51  */
  52
  53 #ifndef _VM_MEMORY_OBJECT_H_
  54 #define _VM_MEMORY_OBJECT_H_
  55
  56 #include <mach_pagemap.h>
  57
  58 #include <mach/boolean.h>
  59 #include <mach/mach_types.h>
  60 #include <mach/memory_object_types.h>
  61 #include <ipc/ipc_types.h>
  62
  63 __private_extern__
  64 memory_object_default_t memory_manager_default_reference(
  65                                 vm_size_t               *cluster_size);
  66
  67 __private_extern__
  68 kern_return_t           memory_manager_default_check(void);
  69
  70 __private_extern__
  71 void                    memory_manager_default_init(void);
  72
  73 __private_extern__
  74 void                    memory_object_control_bootstrap(void);
  75 __private_extern__
  76 memory_object_control_t memory_object_control_allocate(
  77                                 vm_object_t             object);
  78
  79 __private_extern__
  80 void                    memory_object_control_collapse(
  81                                 memory_object_control_t control,
  82                                 vm_object_t             object);
  83
  84 __private_extern__
  85 vm_object_t             memory_object_control_to_vm_object(
  86                                 memory_object_control_t control);
  87
  88 extern
  89 mach_port_t             convert_mo_control_to_port(
  90                                 memory_object_control_t control);
  91
  92 extern void memory_object_control_disable(
  93         memory_object_control_t control);
  94
  95 extern
  96 memory_object_control_t convert_port_to_mo_control(
  97                                 mach_port_t             port);
  98
  99 extern
 100 mach_port_t             convert_memory_object_to_port(
 101                                 memory_object_t         object);
 102
 103 extern
 104 memory_object_t         convert_port_to_memory_object(
 105                                 mach_port_t             port);
 106
 107 extern upl_t convert_port_to_upl(
 108                                 ipc_port_t      port);
 109
 110 extern ipc_port_t convert_upl_to_port( upl_t );
 111
 112 __private_extern__ void upl_no_senders(ipc_port_t, mach_port_mscount_t);
 113
 114 extern kern_return_t    memory_object_free_from_cache(
 115                                 host_t          host,
 116                                 int             *pager_id,
 117                                 int             *count);
 118
 119 extern kern_return_t    memory_object_iopl_request(
 120         ipc_port_t              port,
 121         memory_object_offset_t  offset,
 122         vm_size_t               *upl_size,
 123         upl_t                   *upl_ptr,
 124         upl_page_info_array_t   user_page_list,
 125         unsigned int            *page_list_count,
 126         int                     *flags);
 127
 128
 129 extern kern_return_t    memory_object_pages_resident(
 130         memory_object_control_t         control,
 131         boolean_t                       *               has_pages_resident);
 132
 133 #endif  /* _VM_MEMORY_OBJECT_H_ */