osfmk/vm/vm_kern.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,1990,1989,1988,1987 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 "AS IS"
  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 Mellon
  56  * the rights to redistribute these changes.
  57  */
  58 /*
  59  */
  60 /*
  61  *      File:   vm/vm_kern.h
  62  *      Author: Avadis Tevanian, Jr., Michael Wayne Young
  63  *      Date:   1985
  64  *
  65  *      Kernel memory management definitions.
  66  */
  67
  68 #ifndef _VM_VM_KERN_H_
  69 #define _VM_VM_KERN_H_
  70
  71 #include <mach/mach_types.h>
  72 #include <mach/boolean.h>
  73 #include <mach/kern_return.h>
  74
  75 #ifdef  KERNEL_PRIVATE
  76
  77 extern kern_return_t    kernel_memory_allocate(
  78                                 vm_map_t        map,
  79                                 vm_offset_t     *addrp,
  80                                 vm_size_t       size,
  81                                 vm_offset_t     mask,
  82                                 int             flags);
  83
  84 /* flags for kernel_memory_allocate */
  85 #define KMA_HERE        0x01
  86 #define KMA_NOPAGEWAIT  0x02
  87 #define KMA_KOBJECT     0x04
  88
  89 extern kern_return_t kmem_alloc_contig(
  90                                 vm_map_t        map,
  91                                 vm_offset_t     *addrp,
  92                                 vm_size_t       size,
  93                                 vm_offset_t     mask,
  94                                 int             flags);
  95
  96 extern kern_return_t    kmem_alloc(
  97                                 vm_map_t        map,
  98                                 vm_offset_t     *addrp,
  99                                 vm_size_t       size);
 100
 101 extern kern_return_t    kmem_alloc_pageable(
 102                                 vm_map_t        map,
 103                                 vm_offset_t     *addrp,
 104                                 vm_size_t       size);
 105
 106 extern kern_return_t    kmem_alloc_aligned(
 107                                 vm_map_t        map,
 108                                 vm_offset_t     *addrp,
 109                                 vm_size_t       size);
 110
 111 extern kern_return_t    kmem_realloc(
 112                                 vm_map_t        map,
 113                                 vm_offset_t     oldaddr,
 114                                 vm_size_t       oldsize,
 115                                 vm_offset_t     *newaddrp,
 116                                 vm_size_t       newsize);
 117
 118 extern void             kmem_free(
 119                                 vm_map_t        map,
 120                                 vm_offset_t     addr,
 121                                 vm_size_t       size);
 122
 123 #ifdef  MACH_KERNEL_PRIVATE
 124
 125 extern void             kmem_init(
 126                                         vm_offset_t     start,
 127                                         vm_offset_t     end);
 128
 129 extern kern_return_t    kmem_alloc_wired(
 130                                 vm_map_t        map,
 131                                 vm_offset_t     *addrp,
 132                                 vm_size_t       size);
 133
 134 extern kern_return_t    kmem_suballoc(
 135                                 vm_map_t        parent,
 136                                 vm_offset_t     *addr,
 137                                 vm_size_t       size,
 138                                 boolean_t       pageable,
 139                                 boolean_t       anywhere,
 140                                 vm_map_t        *new_map);
 141
 142 extern kern_return_t    copyinmap(
 143                                 vm_map_t        map,
 144                                 vm_map_offset_t fromaddr,
 145                                 void            *todata,
 146                                 vm_size_t       length);
 147
 148 extern kern_return_t    copyoutmap(
 149                                 vm_map_t        map,
 150                                 void            *fromdata,
 151                                 vm_map_offset_t toaddr,
 152                                 vm_size_t       length);
 153
 154 extern kern_return_t    vm_conflict_check(
 155                                 vm_map_t                map,
 156                                 vm_map_offset_t         off,
 157                                 vm_map_size_t           len,
 158                                 memory_object_t         pager,
 159                                 vm_object_offset_t      file_off);
 160
 161 #endif  /* MACH_KERNEL_PRIVATE */
 162
 163 extern vm_map_t kernel_map;
 164 extern vm_map_t kernel_pageable_map;
 165 extern vm_map_t ipc_kernel_map;
 166
 167 #endif  /* KERNEL_PRIVATE */
 168
 169 #endif  /* _VM_VM_KERN_H_ */