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 #ifdef __cplusplus
  70 extern "C" {
  71 #endif
  72
  73 #include <mach/mach_types.h>
  74 #include <mach/boolean.h>
  75 #include <mach/kern_return.h>
  76
  77 #ifdef  KERNEL_PRIVATE
  78
  79 #ifdef XNU_KERNEL_PRIVATE
  80
  81 #include <kern/locks.h>
  82
  83 extern kern_return_t    kernel_memory_allocate(
  84         vm_map_t        map,
  85         vm_offset_t     *addrp,
  86         vm_size_t       size,
  87         vm_offset_t     mask,
  88         int             flags,
  89         vm_tag_t        tag);
  90
  91 /* flags for kernel_memory_allocate */
  92 #define KMA_HERE        0x01
  93 #define KMA_NOPAGEWAIT  0x02
  94 #define KMA_KOBJECT     0x04
  95 #define KMA_LOMEM       0x08
  96 #define KMA_GUARD_FIRST 0x10
  97 #define KMA_GUARD_LAST  0x20
  98 #define KMA_PERMANENT   0x40
  99 #define KMA_NOENCRYPT   0x80
 100 #define KMA_KSTACK      0x100
 101 #define KMA_VAONLY      0x200
 102 #define KMA_COMPRESSOR  0x400   /* Pages belonging to the compressor are not on the paging queues, nor are they counted as wired. */
 103 #define KMA_ATOMIC      0x800
 104 #define KMA_ZERO        0x1000
 105 #define KMA_PAGEABLE    0x2000
 106 #define KMA_KHEAP       0x4000  /* Pages belonging to zones backing one of kalloc_heap. */
 107
 108 extern kern_return_t kmem_alloc(
 109         vm_map_t        map,
 110         vm_offset_t     *addrp,
 111         vm_size_t       size,
 112         vm_tag_t        tag) __XNU_INTERNAL(kmem_alloc);
 113
 114 extern kern_return_t kmem_alloc_contig(
 115         vm_map_t        map,
 116         vm_offset_t     *addrp,
 117         vm_size_t       size,
 118         vm_offset_t     mask,
 119         ppnum_t         max_pnum,
 120         ppnum_t         pnum_mask,
 121         int             flags,
 122         vm_tag_t        tag);
 123
 124 extern kern_return_t    kmem_alloc_flags(
 125         vm_map_t        map,
 126         vm_offset_t     *addrp,
 127         vm_size_t       size,
 128         vm_tag_t        tag,
 129         int             flags);
 130
 131 extern kern_return_t    kmem_alloc_pageable(
 132         vm_map_t        map,
 133         vm_offset_t     *addrp,
 134         vm_size_t       size,
 135         vm_tag_t        tag) __XNU_INTERNAL(kmem_alloc_pageable);
 136
 137 extern kern_return_t    kmem_alloc_aligned(
 138         vm_map_t        map,
 139         vm_offset_t     *addrp,
 140         vm_size_t       size,
 141         vm_tag_t        tag);
 142
 143 extern kern_return_t    kmem_realloc(
 144         vm_map_t        map,
 145         vm_offset_t     oldaddr,
 146         vm_size_t       oldsize,
 147         vm_offset_t     *newaddrp,
 148         vm_size_t       newsize,
 149         vm_tag_t        tag);
 150
 151 extern void             kmem_free(
 152         vm_map_t        map,
 153         vm_offset_t     addr,
 154         vm_size_t       size);
 155
 156 extern kern_return_t    kmem_suballoc(
 157         vm_map_t        parent,
 158         vm_offset_t     *addr,
 159         vm_size_t       size,
 160         boolean_t       pageable,
 161         int             flags,
 162         vm_map_kernel_flags_t vmk_flags,
 163         vm_tag_t        tag,
 164         vm_map_t        *new_map);
 165
 166 extern kern_return_t    kmem_alloc_kobject(
 167         vm_map_t        map,
 168         vm_offset_t     *addrp,
 169         vm_size_t       size,
 170         vm_tag_t        tag) __XNU_INTERNAL(kmem_alloc_kobject);
 171
 172 extern kern_return_t kernel_memory_populate(
 173         vm_map_t        map,
 174         vm_offset_t     addr,
 175         vm_size_t       size,
 176         int             flags,
 177         vm_tag_t        tag);
 178
 179 extern void kernel_memory_depopulate(
 180         vm_map_t        map,
 181         vm_offset_t     addr,
 182         vm_size_t       size,
 183         int             flags,
 184         vm_tag_t        tag);
 185
 186 extern kern_return_t    memory_object_iopl_request(
 187         ipc_port_t              port,
 188         memory_object_offset_t  offset,
 189         upl_size_t              *upl_size,
 190         upl_t                   *upl_ptr,
 191         upl_page_info_array_t   user_page_list,
 192         unsigned int            *page_list_count,
 193         upl_control_flags_t     *flags,
 194         vm_tag_t                tag);
 195
 196 struct mach_memory_info;
 197 extern kern_return_t    vm_page_diagnose(
 198         struct mach_memory_info *info,
 199         unsigned int            num_info,
 200         uint64_t                zones_collectable_bytes);
 201
 202 extern uint32_t         vm_page_diagnose_estimate(void);
 203
 204 #if DEBUG || DEVELOPMENT
 205
 206 extern kern_return_t    mach_memory_info_check(void);
 207
 208 extern kern_return_t    vm_kern_allocation_info(uintptr_t addr, vm_size_t * size, vm_tag_t * tag, vm_size_t * zone_size);
 209
 210 #endif /* DEBUG || DEVELOPMENT */
 211
 212 #if HIBERNATION
 213 extern void             hibernate_rebuild_vm_structs(void);
 214 #endif /* HIBERNATION */
 215
 216 extern vm_tag_t         vm_tag_bt(void);
 217
 218 extern vm_tag_t         vm_tag_alloc(vm_allocation_site_t * site);
 219
 220 extern void             vm_tag_alloc_locked(vm_allocation_site_t * site, vm_allocation_site_t ** releasesiteP);
 221
 222 extern void             vm_tag_update_size(vm_tag_t tag, int64_t size);
 223
 224 #if VM_MAX_TAG_ZONES
 225
 226 extern void             vm_allocation_zones_init(void);
 227 extern void             vm_tag_will_update_zone(vm_tag_t tag, uint32_t zidx);
 228 extern void             vm_tag_update_zone_size(vm_tag_t tag, uint32_t zidx, int64_t delta, int64_t dwaste);
 229
 230 extern vm_allocation_zone_total_t **   vm_allocation_zone_totals;
 231
 232 #endif /* VM_MAX_TAG_ZONES */
 233
 234 extern vm_tag_t         vm_tag_bt_debug(void);
 235
 236 extern uint32_t         vm_tag_get_kext(vm_tag_t tag, char * name, vm_size_t namelen);
 237
 238 extern boolean_t        vm_kernel_map_is_kernel(vm_map_t map);
 239
 240 extern ppnum_t          kernel_pmap_present_mapping(uint64_t vaddr, uint64_t * pvincr, uintptr_t * pvphysaddr);
 241
 242 #else /* XNU_KERNEL_PRIVATE */
 243
 244 extern kern_return_t    kmem_alloc(
 245         vm_map_t        map,
 246         vm_offset_t     *addrp,
 247         vm_size_t       size);
 248
 249 extern kern_return_t    kmem_alloc_pageable(
 250         vm_map_t        map,
 251         vm_offset_t     *addrp,
 252         vm_size_t       size);
 253
 254 extern kern_return_t    kmem_alloc_kobject(
 255         vm_map_t        map,
 256         vm_offset_t     *addrp,
 257         vm_size_t       size);
 258
 259 extern void             kmem_free(
 260         vm_map_t        map,
 261         vm_offset_t     addr,
 262         vm_size_t       size);
 263
 264 #endif /* !XNU_KERNEL_PRIVATE */
 265
 266
 267 #ifdef XNU_KERNEL_PRIVATE
 268 typedef struct vm_allocation_site kern_allocation_name;
 269 typedef kern_allocation_name * kern_allocation_name_t;
 270 #else /* XNU_KERNEL_PRIVATE */
 271 struct kern_allocation_name;
 272 typedef struct kern_allocation_name * kern_allocation_name_t;
 273 #endif /* !XNU_KERNEL_PRIVATE */
 274
 275 extern kern_allocation_name_t   kern_allocation_name_allocate(const char * name, uint16_t suballocs);
 276 extern void                     kern_allocation_name_release(kern_allocation_name_t allocation);
 277 extern const char *             kern_allocation_get_name(kern_allocation_name_t allocation);
 278 #ifdef XNU_KERNEL_PRIVATE
 279 extern void                     kern_allocation_update_size(kern_allocation_name_t allocation, int64_t delta);
 280 extern void                     kern_allocation_update_subtotal(kern_allocation_name_t allocation, uint32_t subtag, int64_t delta);
 281 extern vm_tag_t                 kern_allocation_name_get_vm_tag(kern_allocation_name_t allocation);
 282 #endif /* XNU_KERNEL_PRIVATE */
 283
 284 #ifdef  MACH_KERNEL_PRIVATE
 285
 286 extern void             kmem_init(
 287         vm_offset_t     start,
 288         vm_offset_t     end);
 289
 290 extern kern_return_t    copyinmap(
 291         vm_map_t        map,
 292         vm_map_offset_t fromaddr,
 293         void            *todata,
 294         vm_size_t       length);
 295
 296 extern kern_return_t    copyoutmap(
 297         vm_map_t        map,
 298         void            *fromdata,
 299         vm_map_offset_t toaddr,
 300         vm_size_t       length);
 301
 302 extern kern_return_t    kmem_alloc_external(
 303         vm_map_t        map,
 304         vm_offset_t     *addrp,
 305         vm_size_t       size);
 306
 307 extern kern_return_t    kmem_alloc_kobject_external(
 308         vm_map_t        map,
 309         vm_offset_t     *addrp,
 310         vm_size_t       size);
 311
 312 extern kern_return_t    kmem_alloc_pageable_external(
 313         vm_map_t        map,
 314         vm_offset_t     *addrp,
 315         vm_size_t       size);
 316
 317 #endif  /* MACH_KERNEL_PRIVATE */
 318
 319 #ifdef XNU_KERNEL_PRIVATE
 320
 321 extern kern_return_t    mach_vm_allocate_kernel(
 322         vm_map_t                map,
 323         mach_vm_offset_t        *addr,
 324         mach_vm_size_t          size,
 325         int                     flags,
 326         vm_tag_t                tag);
 327
 328 extern kern_return_t    vm_allocate_kernel(
 329         vm_map_t                map,
 330         vm_offset_t             *addr,
 331         vm_size_t               size,
 332         int                     flags,
 333         vm_tag_t                tag);
 334
 335
 336 extern kern_return_t mach_vm_map_kernel(
 337         vm_map_t                target_map,
 338         mach_vm_offset_t        *address,
 339         mach_vm_size_t          initial_size,
 340         mach_vm_offset_t        mask,
 341         int                     flags,
 342         vm_map_kernel_flags_t   vmk_flags,
 343         vm_tag_t                tag,
 344         ipc_port_t              port,
 345         vm_object_offset_t      offset,
 346         boolean_t               copy,
 347         vm_prot_t               cur_protection,
 348         vm_prot_t               max_protection,
 349         vm_inherit_t            inheritance);
 350
 351
 352 extern kern_return_t vm_map_kernel(
 353         vm_map_t                target_map,
 354         vm_offset_t             *address,
 355         vm_size_t               size,
 356         vm_offset_t             mask,
 357         int                     flags,
 358         vm_map_kernel_flags_t   vmk_flags,
 359         vm_tag_t                tag,
 360         ipc_port_t              port,
 361         vm_offset_t             offset,
 362         boolean_t               copy,
 363         vm_prot_t               cur_protection,
 364         vm_prot_t               max_protection,
 365         vm_inherit_t            inheritance);
 366
 367 extern kern_return_t mach_vm_remap_kernel(
 368         vm_map_t                target_map,
 369         mach_vm_offset_t        *address,
 370         mach_vm_size_t          size,
 371         mach_vm_offset_t        mask,
 372         int                     flags,
 373         vm_tag_t                tag,
 374         vm_map_t                src_map,
 375         mach_vm_offset_t        memory_address,
 376         boolean_t               copy,
 377         vm_prot_t               *cur_protection,
 378         vm_prot_t               *max_protection,
 379         vm_inherit_t            inheritance);
 380
 381 extern kern_return_t vm_remap_kernel(
 382         vm_map_t                target_map,
 383         vm_offset_t             *address,
 384         vm_size_t               size,
 385         vm_offset_t             mask,
 386         int                     flags,
 387         vm_tag_t                tag,
 388         vm_map_t                src_map,
 389         vm_offset_t             memory_address,
 390         boolean_t               copy,
 391         vm_prot_t               *cur_protection,
 392         vm_prot_t               *max_protection,
 393         vm_inherit_t            inheritance);
 394
 395 extern kern_return_t vm_map_64_kernel(
 396         vm_map_t                target_map,
 397         vm_offset_t             *address,
 398         vm_size_t               size,
 399         vm_offset_t             mask,
 400         int                     flags,
 401         vm_map_kernel_flags_t   vmk_flags,
 402         vm_tag_t                tag,
 403         ipc_port_t              port,
 404         vm_object_offset_t      offset,
 405         boolean_t               copy,
 406         vm_prot_t               cur_protection,
 407         vm_prot_t               max_protection,
 408         vm_inherit_t            inheritance);
 409
 410 extern kern_return_t mach_vm_wire_kernel(
 411         host_priv_t             host_priv,
 412         vm_map_t                map,
 413         mach_vm_offset_t        start,
 414         mach_vm_size_t          size,
 415         vm_prot_t               access,
 416         vm_tag_t                tag);
 417
 418 extern kern_return_t vm_map_wire_kernel(
 419         vm_map_t                map,
 420         vm_map_offset_t         start,
 421         vm_map_offset_t         end,
 422         vm_prot_t               caller_prot,
 423         vm_tag_t                tag,
 424         boolean_t               user_wire);
 425
 426 extern kern_return_t vm_map_wire_and_extract_kernel(
 427         vm_map_t        map,
 428         vm_map_offset_t start,
 429         vm_prot_t       caller_prot,
 430         vm_tag_t        tag,
 431         boolean_t       user_wire,
 432         ppnum_t         *physpage_p);
 433
 434 #endif  /* XNU_KERNEL_PRIVATE */
 435
 436 extern vm_map_t kernel_map;
 437 extern vm_map_t kernel_pageable_map;
 438 extern vm_map_t ipc_kernel_map;
 439 extern vm_map_t g_kext_map;
 440
 441 #endif  /* KERNEL_PRIVATE */
 442
 443 #ifdef KERNEL
 444
 445 __BEGIN_DECLS
 446 #if MACH_KERNEL_PRIVATE
 447 extern vm_offset_t vm_kernel_addrhash(vm_offset_t addr)
 448 __XNU_INTERNAL(vm_kernel_addrhash);
 449 #else
 450 extern vm_offset_t vm_kernel_addrhash(vm_offset_t addr);
 451 #endif
 452 __END_DECLS
 453
 454 extern void vm_kernel_addrhide(
 455         vm_offset_t addr,
 456         vm_offset_t *hide_addr);
 457
 458 extern vm_offset_t vm_kernel_addrperm_ext;
 459
 460 extern void     vm_kernel_addrperm_external(
 461         vm_offset_t addr,
 462         vm_offset_t *perm_addr);
 463
 464 extern void     vm_kernel_unslide_or_perm_external(
 465         vm_offset_t addr,
 466         vm_offset_t *up_addr);
 467
 468 #if MACH_KERNEL_PRIVATE
 469 extern uint64_t vm_kernel_addrhash_salt;
 470 extern uint64_t vm_kernel_addrhash_salt_ext;
 471
 472 extern void vm_kernel_addrhash_external(
 473         vm_offset_t addr,
 474         vm_offset_t *perm_addr);
 475 #endif /* MACH_KERNEL_PRIVATE */
 476
 477 extern void vm_init_before_launchd(void);
 478
 479 #endif /* KERNEL */
 480
 481 #ifdef __cplusplus
 482 }
 483 #endif
 484
 485 #endif  /* _VM_VM_KERN_H_ */