osfmk/vm/memory_object.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 /*
  26  * @OSF_COPYRIGHT@
  27  */
  28 /*
  29  * Mach Operating System
  30  * Copyright (c) 1991 Carnegie Mellon University
  31  * All Rights Reserved.
  32  *
  33  * Permission to use, copy, modify and distribute this software and its
  34  * documentation is hereby granted, provided that both the copyright
  35  * notice and this permission notice appear in all copies of the
  36  * software, derivative works or modified versions, and any portions
  37  * thereof, and that both notices appear in supporting documentation.
  38  *
  39  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS
  40  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  41  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  42  *
  43  * Carnegie Mellon requests users of this software to return to
  44  *
  45  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  46  *  School of Computer Science
  47  *  Carnegie Mellon University
  48  *  Pittsburgh PA 15213-3890
  49  *
  50  * any improvements or extensions that they make and grant Carnegie the
  51  * rights to redistribute these changes.
  52  */
  53 /*
  54  */
  55
  56 #ifndef _VM_MEMORY_OBJECT_H_
  57 #define _VM_MEMORY_OBJECT_H_
  58
  59 #include <mach_pagemap.h>
  60
  61 #include <mach/boolean.h>
  62 #include <mach/mach_types.h>
  63 #include <mach/memory_object_types.h>
  64 #include <ipc/ipc_types.h>
  65
  66 __private_extern__
  67 memory_object_default_t memory_manager_default_reference(
  68                                 vm_size_t               *cluster_size);
  69
  70 __private_extern__
  71 kern_return_t           memory_manager_default_check(void);
  72
  73 __private_extern__
  74 void                    memory_manager_default_init(void);
  75
  76 __private_extern__
  77 void                    memory_object_control_bootstrap(void);
  78 __private_extern__
  79 memory_object_control_t memory_object_control_allocate(
  80                                 vm_object_t             object);
  81
  82 __private_extern__
  83 void                    memory_object_control_collapse(
  84                                 memory_object_control_t control,
  85                                 vm_object_t             object);
  86
  87 __private_extern__
  88 vm_object_t             memory_object_control_to_vm_object(
  89                                 memory_object_control_t control);
  90
  91 extern
  92 mach_port_t             convert_mo_control_to_port(
  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 kern_return_t    memory_object_free_from_cache(
 108                                 host_t          host,
 109                                 int             *pager_id,
 110                                 int             *count);
 111
 112 #endif  /* _VM_MEMORY_OBJECT_H_ */