1 /* 2 * This file and its contents are supplied under the terms of the 3 * Common Development and Distribution License ("CDDL"), version 1.0. 4 * You may only use this file in accordance with the terms of version 5 * 1.0 of the CDDL. 6 * 7 * A full copy of the text of the CDDL should have accompanied this 8 * source. A copy of the CDDL is also available via the Internet at 9 * http://www.illumos.org/license/CDDL. 10 */ 11 12 /* 13 * Copyright 2019 Joyent, Inc. 14 * Copyright 2023 Oxide Computer Company 15 */ 16 17 #ifndef _VMM_GPT_H 18 #define _VMM_GPT_H 19 20 #include <sys/types.h> 21 22 /* 23 * Constants for the nodes in the GPT radix tree. Note 24 * that, in accordance with hardware page table descriptions, 25 * the root of the tree is referred to as "LEVEL4" while the 26 * leaf level is "LEVEL1". 27 */ 28 typedef enum vmm_gpt_node_level { 29 LEVEL4 = 0, 30 LEVEL3, 31 LEVEL2, 32 LEVEL1, 33 MAX_GPT_LEVEL, 34 } vmm_gpt_node_level_t; 35 36 typedef enum vmm_gpt_query { 37 VGQ_ACCESSED, 38 VGQ_DIRTY, 39 } vmm_gpt_query_t; 40 41 /* 42 * The vmm_pte_ops structure contains function pointers for format-specific 43 * operations on page table entries. The operations are as follows: 44 * 45 * vpeo_map_table: Creates a PTE that maps an inner node in the page table. 46 * vpeo_map_page: Creates a leaf entry PTE that maps a page of physical memory. 47 * vpeo_pte_pfn: Returns the PFN contained in the given PTE. 48 * vpeo_pte_is_present: Returns true IFF the PTE maps a present page. 49 * vpeo_pte_prot: Returns a bitmask of protection bits for the PTE. 50 * The bits correspond to the standard mmap(2) bits: PROT_READ, PROT_WRITE, 51 * PROT_EXEC. 52 * vpeo_reset_dirty: Resets the dirty bit on the given PTE. If the second 53 * argument is `true`, the bit will be set, otherwise it will be cleared. 54 * Returns non-zero if the previous value of the bit was set. 55 * vpeo_reset_accessed: Resets the accessed bit on the given PTE. If the 56 * second argument is `true`, the bit will be set, otherwise it will be 57 * cleared. Returns non-zero if the previous value of the bit was set. 58 * vpeo_get_pmtp: Generate a properly formatted PML4 (EPTP/nCR3), given the root 59 * PFN for the GPT. 60 * vpeo_hw_ad_supported: Returns true IFF hardware A/D tracking is supported. 61 */ 62 typedef struct vmm_pte_ops vmm_pte_ops_t; 63 struct vmm_pte_ops { 64 uint64_t (*vpeo_map_table)(pfn_t); 65 uint64_t (*vpeo_map_page)(pfn_t, uint_t, uint8_t); 66 pfn_t (*vpeo_pte_pfn)(uint64_t); 67 bool (*vpeo_pte_is_present)(uint64_t); 68 uint_t (*vpeo_pte_prot)(uint64_t); 69 uint_t (*vpeo_reset_dirty)(uint64_t *, bool); 70 uint_t (*vpeo_reset_accessed)(uint64_t *, bool); 71 uint64_t (*vpeo_get_pmtp)(pfn_t, bool); 72 bool (*vpeo_hw_ad_supported)(void); 73 bool (*vpeo_query)(uint64_t *, vmm_gpt_query_t); 74 }; 75 76 extern vmm_pte_ops_t ept_pte_ops; 77 extern vmm_pte_ops_t rvi_pte_ops; 78 79 struct vmm_gpt; 80 typedef struct vmm_gpt vmm_gpt_t; 81 82 vmm_gpt_t *vmm_gpt_alloc(vmm_pte_ops_t *); 83 void vmm_gpt_free(vmm_gpt_t *); 84 85 uint64_t *vmm_gpt_lookup(vmm_gpt_t *, uint64_t); 86 void vmm_gpt_walk(vmm_gpt_t *, uint64_t, uint64_t **, vmm_gpt_node_level_t); 87 void vmm_gpt_populate_region(vmm_gpt_t *, uint64_t, uint64_t); 88 bool vmm_gpt_map_at(vmm_gpt_t *, uint64_t *, pfn_t, uint_t, uint8_t); 89 void vmm_gpt_vacate_region(vmm_gpt_t *, uint64_t, uint64_t); 90 bool vmm_gpt_map(vmm_gpt_t *, uint64_t, pfn_t, uint_t, uint8_t); 91 bool vmm_gpt_unmap(vmm_gpt_t *, uint64_t); 92 size_t vmm_gpt_unmap_region(vmm_gpt_t *, uint64_t, uint64_t); 93 uint64_t vmm_gpt_get_pmtp(vmm_gpt_t *, bool); 94 95 bool vmm_gpt_is_mapped(vmm_gpt_t *, uint64_t *, pfn_t *, uint_t *); 96 uint_t vmm_gpt_reset_accessed(vmm_gpt_t *, uint64_t *, bool); 97 uint_t vmm_gpt_reset_dirty(vmm_gpt_t *, uint64_t *, bool); 98 bool vmm_gpt_query(vmm_gpt_t *, uint64_t *, vmm_gpt_query_t); 99 bool vmm_gpt_can_track_dirty(vmm_gpt_t *); 100 101 #endif /* _VMM_GPT_H */ 102