2 * Copyright (c) 2000-2012 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
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.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
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.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
32 * Mach Operating System
33 * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
34 * All Rights Reserved.
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.
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.
46 * Carnegie Mellon requests users of this software to return to
48 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
49 * School of Computer Science
50 * Carnegie Mellon University
51 * Pittsburgh PA 15213-3890
53 * any improvements or extensions that they make and grant Carnegie Mellon
54 * the rights to redistribute these changes.
60 * Author: Avadis Tevanian, Jr.
63 * Machine address mapping definitions -- machine-independent
64 * section. [For machine-dependent section, see "machine/pmap.h".]
70 #include <mach/kern_return.h>
71 #include <mach/vm_param.h>
72 #include <mach/vm_types.h>
73 #include <mach/vm_attributes.h>
74 #include <mach/boolean.h>
75 #include <mach/vm_prot.h>
80 * The following is a description of the interface to the
81 * machine-dependent "physical map" data structure. The module
82 * must provide a "pmap_t" data type that represents the
83 * set of valid virtual-to-physical addresses for one user
84 * address space. [The kernel address space is represented
85 * by a distinguished "pmap_t".] The routines described manage
86 * this type, install and update virtual-to-physical mappings,
87 * and perform operations on physical addresses common to
88 * many address spaces.
91 /* Copy between a physical page and a virtual address */
92 /* LP64todo - switch to vm_map_offset_t when it grows */
93 extern kern_return_t
copypv(
106 #define cppvNoModSnk 16
107 #define cppvNoModSnkb 27
108 #define cppvNoRefSrc 32
109 #define cppvNoRefSrcb 26
110 #define cppvKmap 64 /* Use the kernel's vm_map */
113 #ifdef MACH_KERNEL_PRIVATE
115 #include <machine/pmap.h>
118 * Routines used for initialization.
119 * There is traditionally also a pmap_bootstrap,
120 * used very early by machine-dependent code,
121 * but it is not part of the interface.
124 * These interfaces are tied to the size of the
125 * kernel pmap - and therefore use the "local"
126 * vm_offset_t, etc... types.
129 extern void *pmap_steal_memory(vm_size_t size
);
130 /* During VM initialization,
131 * steal a chunk of memory.
133 extern unsigned int pmap_free_pages(void); /* During VM initialization,
134 * report remaining unused
137 extern void pmap_startup(
140 /* During VM initialization,
141 * use remaining physical pages
142 * to allocate page frames.
144 extern void pmap_init(void);
150 extern void mapping_adjust(void); /* Adjust free mapping count */
152 extern void mapping_free_prime(void); /* Primes the mapping block release list */
154 #ifndef MACHINE_PAGES
156 * If machine/pmap.h defines MACHINE_PAGES, it must implement
157 * the above functions. The pmap module has complete control.
158 * Otherwise, it must implement
163 * and vm/vm_resident.c implements pmap_steal_memory and pmap_startup
164 * using pmap_free_pages, pmap_next_page, pmap_virtual_space,
165 * and pmap_enter. pmap_free_pages may over-estimate the number
166 * of unused physical pages, and pmap_next_page may return FALSE
167 * to indicate that there are no more unused pages to return.
168 * However, for best performance pmap_free_pages should be accurate.
171 extern boolean_t
pmap_next_page(ppnum_t
*pnum
);
172 extern boolean_t
pmap_next_page_hi(ppnum_t
*pnum
);
173 /* During VM initialization,
174 * return the next unused
177 extern void pmap_virtual_space(
178 vm_offset_t
*virtual_start
,
179 vm_offset_t
*virtual_end
);
180 /* During VM initialization,
181 * report virtual space
182 * available for the kernel.
184 #endif /* MACHINE_PAGES */
187 * Routines to manage the physical map data structure.
189 extern pmap_t
pmap_create( /* Create a pmap_t. */
192 __unused boolean_t is_64bit
);
193 extern pmap_t (pmap_kernel
)(void); /* Return the kernel's pmap */
194 extern void pmap_reference(pmap_t pmap
); /* Gain a reference. */
195 extern void pmap_destroy(pmap_t pmap
); /* Release a reference. */
196 extern void pmap_switch(pmap_t
);
199 extern void pmap_enter( /* Enter a mapping */
204 vm_prot_t fault_type
,
208 extern kern_return_t
pmap_enter_options(
213 vm_prot_t fault_type
,
216 unsigned int options
,
219 extern void pmap_remove_some_phys(
225 * Routines that operate on physical addresses.
228 extern void pmap_page_protect( /* Restrict access to page. */
232 extern void pmap_page_protect_options( /* Restrict access to page. */
235 unsigned int options
,
238 extern void (pmap_zero_page
)(
241 extern void (pmap_zero_part_page
)(
246 extern void (pmap_copy_page
)(
250 extern void (pmap_copy_part_page
)(
252 vm_offset_t src_offset
,
254 vm_offset_t dst_offset
,
257 extern void (pmap_copy_part_lpage
)(
260 vm_offset_t dst_offset
,
263 extern void (pmap_copy_part_rpage
)(
265 vm_offset_t src_offset
,
269 extern unsigned int (pmap_disconnect
)( /* disconnect mappings and return reference and change */
272 extern unsigned int (pmap_disconnect_options
)( /* disconnect mappings and return reference and change */
274 unsigned int options
,
277 extern kern_return_t (pmap_attribute_cache_sync
)( /* Flush appropriate
279 * page number sent */
282 vm_machine_attribute_t attribute
,
283 vm_machine_attribute_val_t
* value
);
285 extern unsigned int (pmap_cache_attributes
)(
289 * Set (override) cache attributes for the specified physical page
291 extern void pmap_set_cache_attributes(
294 extern void pmap_sync_page_data_phys(ppnum_t pa
);
295 extern void pmap_sync_page_attributes_phys(ppnum_t pa
);
298 * debug/assertions. pmap_verify_free returns true iff
299 * the given physical page is mapped into no pmap.
301 extern boolean_t
pmap_verify_free(ppnum_t pn
);
304 * Statistics routines
306 extern int (pmap_resident_count
)(pmap_t pmap
);
307 extern int (pmap_resident_max
)(pmap_t pmap
);
310 * Sundry required (internal) routines
312 #ifdef CURRENTLY_UNUSED_AND_UNTESTED
313 extern void pmap_collect(pmap_t pmap
);/* Perform garbage
314 * collection, if any */
319 extern void (pmap_copy
)( /* Copy range of mappings,
323 vm_map_offset_t dest_va
,
325 vm_map_offset_t source_va
);
327 extern kern_return_t (pmap_attribute
)( /* Get/Set special memory
332 vm_machine_attribute_t attribute
,
333 vm_machine_attribute_val_t
* value
);
336 * Routines defined as macros.
338 #ifndef PMAP_ACTIVATE_USER
339 #ifndef PMAP_ACTIVATE
340 #define PMAP_ACTIVATE_USER(thr, cpu)
341 #else /* PMAP_ACTIVATE */
342 #define PMAP_ACTIVATE_USER(thr, cpu) { \
345 pmap = (thr)->map->pmap; \
346 if (pmap != pmap_kernel()) \
347 PMAP_ACTIVATE(pmap, (thr), (cpu)); \
349 #endif /* PMAP_ACTIVATE */
350 #endif /* PMAP_ACTIVATE_USER */
352 #ifndef PMAP_DEACTIVATE_USER
353 #ifndef PMAP_DEACTIVATE
354 #define PMAP_DEACTIVATE_USER(thr, cpu)
355 #else /* PMAP_DEACTIVATE */
356 #define PMAP_DEACTIVATE_USER(thr, cpu) { \
359 pmap = (thr)->map->pmap; \
360 if ((pmap) != pmap_kernel()) \
361 PMAP_DEACTIVATE(pmap, (thr), (cpu)); \
363 #endif /* PMAP_DEACTIVATE */
364 #endif /* PMAP_DEACTIVATE_USER */
366 #ifndef PMAP_ACTIVATE_KERNEL
367 #ifndef PMAP_ACTIVATE
368 #define PMAP_ACTIVATE_KERNEL(cpu)
369 #else /* PMAP_ACTIVATE */
370 #define PMAP_ACTIVATE_KERNEL(cpu) \
371 PMAP_ACTIVATE(pmap_kernel(), THREAD_NULL, cpu)
372 #endif /* PMAP_ACTIVATE */
373 #endif /* PMAP_ACTIVATE_KERNEL */
375 #ifndef PMAP_DEACTIVATE_KERNEL
376 #ifndef PMAP_DEACTIVATE
377 #define PMAP_DEACTIVATE_KERNEL(cpu)
378 #else /* PMAP_DEACTIVATE */
379 #define PMAP_DEACTIVATE_KERNEL(cpu) \
380 PMAP_DEACTIVATE(pmap_kernel(), THREAD_NULL, cpu)
381 #endif /* PMAP_DEACTIVATE */
382 #endif /* PMAP_DEACTIVATE_KERNEL */
386 * Macro to be used in place of pmap_enter()
388 #define PMAP_ENTER(pmap, virtual_address, page, protection, fault_type, flags, wired) \
390 pmap_t __pmap = (pmap); \
391 vm_page_t __page = (page); \
394 PMAP_ENTER_CHECK(__pmap, __page) \
395 if (__page->object->internal) { \
396 __options |= PMAP_OPTIONS_INTERNAL; \
398 if (__page->reusable || __page->object->all_reusable) { \
399 __options |= PMAP_OPTIONS_REUSABLE; \
401 (void) pmap_enter_options(__pmap, \
411 #endif /* !PMAP_ENTER */
413 #ifndef PMAP_ENTER_OPTIONS
414 #define PMAP_ENTER_OPTIONS(pmap, virtual_address, page, protection, \
415 fault_type, flags, wired, options, result) \
417 pmap_t __pmap = (pmap); \
418 vm_page_t __page = (page); \
419 int __extra_options = 0; \
421 PMAP_ENTER_CHECK(__pmap, __page) \
422 if (__page->object->internal) { \
423 __extra_options |= PMAP_OPTIONS_INTERNAL; \
425 if (__page->reusable || __page->object->all_reusable) { \
426 __extra_options |= PMAP_OPTIONS_REUSABLE; \
428 result = pmap_enter_options(__pmap, \
435 (options) | __extra_options, \
438 #endif /* !PMAP_ENTER_OPTIONS */
440 #ifndef PMAP_SET_CACHE_ATTR
441 #define PMAP_SET_CACHE_ATTR(mem, object, cache_attr, batch_pmap_op) \
443 if (!batch_pmap_op) { \
444 pmap_set_cache_attributes(mem->phys_page, cache_attr); \
445 object->set_cache_attr = TRUE; \
448 #endif /* PMAP_SET_CACHE_ATTR */
450 #ifndef PMAP_BATCH_SET_CACHE_ATTR
451 #define PMAP_BATCH_SET_CACHE_ATTR(object, user_page_list, \
452 cache_attr, num_pages, batch_pmap_op) \
454 if ((batch_pmap_op)) { \
455 unsigned int __page_idx=0; \
456 while (__page_idx < (num_pages)) { \
457 pmap_set_cache_attributes( \
458 user_page_list[__page_idx].phys_addr, \
462 (object)->set_cache_attr = TRUE; \
465 #endif /* PMAP_BATCH_SET_CACHE_ATTR */
467 #define PMAP_ENTER_CHECK(pmap, page) \
469 if ((pmap) != kernel_pmap) { \
470 ASSERT_PAGE_DECRYPTED(page); \
472 if ((page)->error) { \
473 panic("VM page %p should not have an error\n", \
479 * Routines to manage reference/modify bits based on
480 * physical addresses, simulating them if not provided
485 long pfc_invalid_global
;
488 typedef struct pfc pmap_flush_context
;
490 /* Clear reference bit */
491 extern void pmap_clear_reference(ppnum_t pn
);
492 /* Return reference bit */
493 extern boolean_t (pmap_is_referenced
)(ppnum_t pn
);
495 extern void pmap_set_modify(ppnum_t pn
);
496 /* Clear modify bit */
497 extern void pmap_clear_modify(ppnum_t pn
);
498 /* Return modify bit */
499 extern boolean_t
pmap_is_modified(ppnum_t pn
);
500 /* Return modified and referenced bits */
501 extern unsigned int pmap_get_refmod(ppnum_t pn
);
502 /* Clear modified and referenced bits */
503 extern void pmap_clear_refmod(ppnum_t pn
, unsigned int mask
);
504 #define VM_MEM_MODIFIED 0x01 /* Modified bit */
505 #define VM_MEM_REFERENCED 0x02 /* Referenced bit */
506 extern void pmap_clear_refmod_options(ppnum_t pn
, unsigned int mask
, unsigned int options
, void *);
509 extern void pmap_flush_context_init(pmap_flush_context
*);
510 extern void pmap_flush(pmap_flush_context
*);
513 * Routines that operate on ranges of virtual addresses.
515 extern void pmap_protect( /* Change protections. */
521 extern void pmap_protect_options( /* Change protections. */
526 unsigned int options
,
529 extern void (pmap_pageable
)(
531 vm_map_offset_t start
,
536 extern uint64_t pmap_nesting_size_min
;
537 extern uint64_t pmap_nesting_size_max
;
539 extern kern_return_t
pmap_nest(pmap_t
,
544 extern kern_return_t
pmap_unnest(pmap_t
,
547 extern boolean_t
pmap_adjust_unnest_parameters(pmap_t
, vm_map_offset_t
*, vm_map_offset_t
*);
548 #endif /* MACH_KERNEL_PRIVATE */
550 extern boolean_t
pmap_is_noencrypt(ppnum_t
);
551 extern void pmap_set_noencrypt(ppnum_t pn
);
552 extern void pmap_clear_noencrypt(ppnum_t pn
);
555 * JMM - This portion is exported to other kernel components right now,
556 * but will be pulled back in the future when the needed functionality
557 * is provided in a cleaner manner.
560 extern pmap_t kernel_pmap
; /* The kernel's map */
561 #define pmap_kernel() (kernel_pmap)
563 /* machine independent WIMG bits */
565 #define VM_MEM_GUARDED 0x1 /* (G) Guarded Storage */
566 #define VM_MEM_COHERENT 0x2 /* (M) Memory Coherency */
567 #define VM_MEM_NOT_CACHEABLE 0x4 /* (I) Cache Inhibit */
568 #define VM_MEM_WRITE_THROUGH 0x8 /* (W) Write-Through */
570 #define VM_WIMG_USE_DEFAULT 0x80
571 #define VM_WIMG_MASK 0xFF
573 #define VM_MEM_SUPERPAGE 0x100 /* map a superpage instead of a base page */
574 #define VM_MEM_STACK 0x200
576 #define PMAP_OPTIONS_NOWAIT 0x1 /* don't block, return
577 * KERN_RESOURCE_SHORTAGE
579 #define PMAP_OPTIONS_NOENTER 0x2 /* expand pmap if needed
580 * but don't enter mapping
582 #define PMAP_OPTIONS_COMPRESSOR 0x4 /* credit the compressor for
584 #define PMAP_OPTIONS_INTERNAL 0x8 /* page from internal object */
585 #define PMAP_OPTIONS_REUSABLE 0x10 /* page is "reusable" */
586 #define PMAP_OPTIONS_NOFLUSH 0x20 /* delay flushing of pmap */
587 #define PMAP_OPTIONS_NOREFMOD 0x40 /* don't need ref/mod on disconnect */
588 #define PMAP_OPTIONS_REMOVE 0x100 /* removing a mapping */
590 #if !defined(__LP64__)
591 extern vm_offset_t
pmap_extract(pmap_t pmap
,
594 extern void pmap_change_wiring( /* Specify pageability */
599 /* LP64todo - switch to vm_map_offset_t when it grows */
600 extern void pmap_remove( /* Remove mappings. */
605 extern void pmap_remove_options( /* Remove mappings. */
611 extern void pmap_reusable(
617 extern void fillPage(ppnum_t pa
, unsigned int fill
);
619 extern void pmap_map_sharedpage(task_t task
, pmap_t pmap
);
620 extern void pmap_unmap_sharedpage(pmap_t pmap
);
622 #if defined(__LP64__)
623 void pmap_pre_expand(pmap_t pmap
, vm_map_offset_t vaddr
);
626 unsigned int pmap_query_resident(pmap_t pmap
,
630 #endif /* KERNEL_PRIVATE */
632 #endif /* _VM_PMAP_H_ */