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