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