osfmk/vm/vm_kern.h

   1 /*
   2  * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_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. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * @OSF_COPYRIGHT@
  30  */
  31 /*
  32  * Mach Operating System
  33  * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
  34  * All Rights Reserved.
  35  *
  36  * Permission to use, copy, modify and distribute this software and its
  37  * documentation is hereby granted, provided that both the copyright
  38  * notice and this permission notice appear in all copies of the
  39  * software, derivative works or modified versions, and any portions
  40  * thereof, and that both notices appear in supporting documentation.
  41  *
  42  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  43  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  44  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  45  *
  46  * Carnegie Mellon requests users of this software to return to
  47  *
  48  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  49  *  School of Computer Science
  50  *  Carnegie Mellon University
  51  *  Pittsburgh PA 15213-3890
  52  *
  53  * any improvements or extensions that they make and grant Carnegie Mellon
  54  * the rights to redistribute these changes.
  55  */
  56 /*
  57  */
  58 /*
  59  *      File:   vm/vm_kern.h
  60  *      Author: Avadis Tevanian, Jr., Michael Wayne Young
  61  *      Date:   1985
  62  *
  63  *      Kernel memory management definitions.
  64  */
  65
  66 #ifndef _VM_VM_KERN_H_
  67 #define _VM_VM_KERN_H_
  68
  69 #include <mach/mach_types.h>
  70 #include <mach/boolean.h>
  71 #include <mach/kern_return.h>
  72
  73 #ifdef  KERNEL_PRIVATE
  74
  75 extern kern_return_t    kernel_memory_allocate(
  76                                 vm_map_t        map,
  77                                 vm_offset_t     *addrp,
  78                                 vm_size_t       size,
  79                                 vm_offset_t     mask,
  80                                 int             flags);
  81
  82 /* flags for kernel_memory_allocate */
  83 #define KMA_HERE        0x01
  84 #define KMA_NOPAGEWAIT  0x02
  85 #define KMA_KOBJECT     0x04
  86 #define KMA_LOMEM       0x08
  87 #define KMA_GUARD_FIRST 0x10
  88 #define KMA_GUARD_LAST  0x20
  89 #define KMA_PERMANENT   0x40
  90 #define KMA_NOENCRYPT   0x80
  91 #define KMA_KSTACK      0x100
  92 #define KMA_VAONLY      0x200
  93 #define KMA_COMPRESSOR  0x400   /* Pages belonging to the compressor are not on the paging queues, nor are they counted as wired. */
  94
  95 extern kern_return_t kmem_alloc_contig(
  96                                 vm_map_t        map,
  97                                 vm_offset_t     *addrp,
  98                                 vm_size_t       size,
  99                                 vm_offset_t     mask,
 100                                 ppnum_t         max_pnum,
 101                                 ppnum_t         pnum_mask,
 102                                 int             flags);
 103
 104 extern kern_return_t    kmem_alloc(
 105                                 vm_map_t        map,
 106                                 vm_offset_t     *addrp,
 107                                 vm_size_t       size);
 108
 109 extern kern_return_t    kmem_alloc_pageable(
 110                                 vm_map_t        map,
 111                                 vm_offset_t     *addrp,
 112                                 vm_size_t       size);
 113
 114 extern kern_return_t    kmem_alloc_aligned(
 115                                 vm_map_t        map,
 116                                 vm_offset_t     *addrp,
 117                                 vm_size_t       size);
 118
 119 extern kern_return_t    kmem_realloc(
 120                                 vm_map_t        map,
 121                                 vm_offset_t     oldaddr,
 122                                 vm_size_t       oldsize,
 123                                 vm_offset_t     *newaddrp,
 124                                 vm_size_t       newsize);
 125
 126 extern void             kmem_free(
 127                                 vm_map_t        map,
 128                                 vm_offset_t     addr,
 129                                 vm_size_t       size);
 130
 131 extern kern_return_t    kmem_suballoc(
 132                                 vm_map_t        parent,
 133                                 vm_offset_t     *addr,
 134                                 vm_size_t       size,
 135                                 boolean_t       pageable,
 136                                 int             flags,
 137                                 vm_map_t        *new_map);
 138
 139
 140 extern kern_return_t    kmem_alloc_kobject(
 141                                 vm_map_t        map,
 142                                 vm_offset_t     *addrp,
 143                                 vm_size_t       size);
 144
 145 extern kern_return_t kernel_memory_populate(
 146         vm_map_t        map,
 147         vm_offset_t     addr,
 148         vm_size_t       size,
 149         int             flags);
 150 extern void kernel_memory_depopulate(
 151         vm_map_t        map,
 152         vm_offset_t     addr,
 153         vm_size_t       size,
 154         int             flags);
 155
 156 #ifdef  MACH_KERNEL_PRIVATE
 157
 158 extern void             kmem_init(
 159                                         vm_offset_t     start,
 160                                         vm_offset_t     end);
 161
 162
 163 extern kern_return_t    copyinmap(
 164                                 vm_map_t        map,
 165                                 vm_map_offset_t fromaddr,
 166                                 void            *todata,
 167                                 vm_size_t       length);
 168
 169 extern kern_return_t    copyoutmap(
 170                                 vm_map_t        map,
 171                                 void            *fromdata,
 172                                 vm_map_offset_t toaddr,
 173                                 vm_size_t       length);
 174
 175 extern kern_return_t    vm_conflict_check(
 176                                 vm_map_t                map,
 177                                 vm_map_offset_t         off,
 178                                 vm_map_size_t           len,
 179                                 memory_object_t         pager,
 180                                 vm_object_offset_t      file_off);
 181
 182 #endif  /* MACH_KERNEL_PRIVATE */
 183
 184 extern vm_map_t kernel_map;
 185 extern vm_map_t kernel_pageable_map;
 186 extern vm_map_t ipc_kernel_map;
 187
 188 #endif  /* KERNEL_PRIVATE */
 189
 190 #endif  /* _VM_VM_KERN_H_ */