#include <machine/amd64.h>

Include dependency graph for pmap.h:

Data Structures
struct	AS

Macros
#define	MEM_USERSPACE_BASE 0x0000000000000000ULL

#define	MEM_USERSPACE_LEN 0x0000800000000000ULL

#define	MEM_USERSPACE_TOP (MEM_USERSPACE_BASE + MEM_USERSPACE_LEN)

#define	MEM_USERSPACE_STKBASE 0x0000000070000000ULL

#define	MEM_USERSPACE_STKLEN 0x0000000000010000ULL

#define	MEM_USERSPACE_STKTOP (MEM_USERSPACE_STKBASE + MEM_USERSPACE_STKLEN)

#define	MEM_DIRECTMAP_BASE 0xFFFF800000000000ULL

#define	MEM_DIRECTMAP_LEN 0x0000010000000000ULL

#define	MEM_XMAP_BASE 0xFFFF810000000000ULL

#define	MEM_XMAP_LEN 0x0000002000000000ULL

#define	PPN2DMVA(ppn) (((ppn) << PGSIZE) + MEM_DIRECTMAP_BASE)

#define	DMVA2PPN(dmva) (((dmva) - MEM_DIRECTMAP_BASE) >> PGSIZE)

#define	DMVA2PA(dmva) ((dmva) - MEM_DIRECTMAP_BASE)

#define	DMPA2VA(pa) ((pa) + MEM_DIRECTMAP_BASE)

#define	VA2PA(va) PMap_Translate(PMap_CurrentAS(), va)

Typedefs
typedef struct AS	AS

Functions
void	PMap_Init ()

void	PMap_InitAP ()

AS *	PMap_NewAS ()

void	PMap_DestroyAS (AS *space)

AS *	PMap_CurrentAS ()

void	PMap_LoadAS (AS *space)

void	PMap_Dump (AS *space)

uintptr_t	PMap_Translate (AS *space, uintptr_t va)

bool	PMap_Map (AS *as, uint64_t phys, uint64_t virt, uint64_t pages, uint64_t flags)

bool	PMap_AllocMap (AS *as, uint64_t virt, uint64_t len, uint64_t flags)

bool	PMap_Unmap (AS *as, uint64_t virt, uint64_t pages)

void	PMap_SystemLookup (uint64_t va, PageEntry **entry, int size)

bool	PMap_SystemLMap (uint64_t phys, uint64_t virt, uint64_t lpages, uint64_t flags)

bool	PMap_SystemMap (uint64_t phys, uint64_t virt, uint64_t pages, uint64_t flags)

bool	PMap_SystemUnmap (uint64_t virt, uint64_t pages)

Data Structure Documentation

◆ AS

struct AS

Definition at line 51 of file pmap.h.

Collaboration diagram for AS:

[legend]

Data Fields
uint64_t	mappings
PageTable *	root
uint64_t	tables

Macro Definition Documentation

◆ DMPA2VA

#define DMPA2VA ( pa ) ((pa) + MEM_DIRECTMAP_BASE)

Definition at line 48 of file pmap.h.

◆ DMVA2PA

#define DMVA2PA ( dmva ) ((dmva) - MEM_DIRECTMAP_BASE)

Definition at line 47 of file pmap.h.

◆ DMVA2PPN

#define DMVA2PPN ( dmva ) (((dmva) - MEM_DIRECTMAP_BASE) >> PGSIZE)

Definition at line 46 of file pmap.h.

◆ MEM_DIRECTMAP_BASE

#define MEM_DIRECTMAP_BASE 0xFFFF800000000000ULL

Definition at line 40 of file pmap.h.

◆ MEM_DIRECTMAP_LEN

#define MEM_DIRECTMAP_LEN 0x0000010000000000ULL

Definition at line 41 of file pmap.h.

◆ MEM_USERSPACE_BASE

#define MEM_USERSPACE_BASE 0x0000000000000000ULL

Definition at line 32 of file pmap.h.

◆ MEM_USERSPACE_LEN

#define MEM_USERSPACE_LEN 0x0000800000000000ULL

Definition at line 33 of file pmap.h.

◆ MEM_USERSPACE_STKBASE

#define MEM_USERSPACE_STKBASE 0x0000000070000000ULL

Definition at line 36 of file pmap.h.

◆ MEM_USERSPACE_STKLEN

#define MEM_USERSPACE_STKLEN 0x0000000000010000ULL

Definition at line 37 of file pmap.h.

◆ MEM_USERSPACE_STKTOP

#define MEM_USERSPACE_STKTOP (MEM_USERSPACE_STKBASE + MEM_USERSPACE_STKLEN)

Definition at line 38 of file pmap.h.

◆ MEM_USERSPACE_TOP

#define MEM_USERSPACE_TOP (MEM_USERSPACE_BASE + MEM_USERSPACE_LEN)

Definition at line 34 of file pmap.h.

◆ MEM_XMAP_BASE

#define MEM_XMAP_BASE 0xFFFF810000000000ULL

Definition at line 42 of file pmap.h.

◆ MEM_XMAP_LEN

#define MEM_XMAP_LEN 0x0000002000000000ULL

Definition at line 43 of file pmap.h.

◆ PPN2DMVA

#define PPN2DMVA ( ppn ) (((ppn) << PGSIZE) + MEM_DIRECTMAP_BASE)

Definition at line 45 of file pmap.h.

◆ VA2PA

#define VA2PA ( va ) PMap_Translate(PMap_CurrentAS(), va)

Definition at line 49 of file pmap.h.

Typedef Documentation

◆ AS

typedef struct AS AS

Function Documentation

◆ PMap_AllocMap()

bool PMap_AllocMap	(	AS *	as,
		uint64_t	virt,
		uint64_t	len,
		uint64_t	flags
	)

PMap_AllocMap –

Map a virtual mapping in an address space and back it by newly allocated memory.

Parameters

[in]	as	Address space.
[in]	virt	Virtual address.
[in]	pages	Pages to map in.
[in]	flags	Flags to apply to the mapping.

Return values

true	On success
false	On failure

Definition at line 423 of file pmap.c.

{
    int i;
    uint64_t pages = (len + PGSIZE - 1) / PGSIZE;
    PageEntry *entry;
 
    ASSERT((virt & PGMASK) == 0);
 
    for (i = 0; i < pages; i++) {
        uint64_t va = virt + PGSIZE * i;
        PMapLookupEntry(as, va, &entry, PGSIZE);
        if (!entry) {
            kprintf("Map failed to allocate memory!\n");
            return false;
        }
 
        if ((*entry & PTE_P) != PTE_P) {
            void *pg = PAlloc_AllocPage();
            *entry = (uint64_t)DMVA2PA(pg) | PTE_P | PTE_U | flags;
        }
    }
 
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PMap_CurrentAS()

AS * PMap_CurrentAS ( )

PMap_CurrentAS –

Get the current address space on this CPU.

Returns: Current address space.

Definition at line 168 of file pmap.c.

{
    return currentAS[THISCPU()];
}

◆ PMap_DestroyAS()

void PMap_DestroyAS ( AS * space )

PMap_DestroyAS –

Destroys an address space and releases the physical pages.

Parameters

[in] space Address space to destroy.

Definition at line 116 of file pmap.c.

{
    // Only free the userspace portion (bottom half)
    for (int i = 0; i < PAGETABLE_ENTRIES / 2; i++)
    {
        PageEntry pte = space->root->entries[i];
        if (pte & PTE_P) {
            // Remove sub-pages
            PageTable *tbl2 = (PageTable *)DMPA2VA(pte & PGNUMMASK);
            for (int j = 0; j < PAGETABLE_ENTRIES; j++) {
                PageEntry pte2 = tbl2->entries[j];
                if (pte2 & PTE_P) {
                    PageTable *tbl3 = (PageTable *)DMPA2VA(pte2 & PGNUMMASK);
                    for (int k = 0; k < PAGETABLE_ENTRIES; k++) {
                        PageEntry pte3 = tbl3->entries[k];
                        if (pte3 & PTE_P) {
                            ASSERT((pte3 & PTE_PS) == 0); // XXX: Large pages not supported
                            PageTable *tbl4 = (PageTable *)DMPA2VA(pte3 & PGNUMMASK);
                            for (int l = 0; l < PAGETABLE_ENTRIES; l++) {
                                PageEntry pte4 = tbl4->entries[l];
                                if (pte4 & PTE_P) {
                                    // Free userspace page
                                    PAlloc_Release((void *)DMPA2VA(pte4 & PGNUMMASK));
                                }
                            }
 
                            // Free 3rd level page table page
                            PAlloc_Release((void *)DMPA2VA(pte3 & PGNUMMASK));
                        }
                    }
 
                    // Free 2nd level page table page
                    PAlloc_Release((void *)DMPA2VA(pte2 & PGNUMMASK));
                }
            }
 
            // Free page table page
            PAlloc_Release((void *)DMPA2VA(pte & PGNUMMASK));
        }
    }
 
    PAlloc_Release(space);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PMap_Dump()

void PMap_Dump ( AS * space )

Definition at line 616 of file pmap.c.

{
    int i = 0;
    int j = 0;
    int k = 0;
    int l = 0;
    PageTable *root = space->root;
 
    kprintf("%-18s  %-18s %-5s\n", "Virtual", "Physical PTE", "Flags");
    for (i = 0; i < PAGETABLE_ENTRIES/2; i++) {
        PageEntry pte = root->entries[i];
        PageTable *l1 = (PageTable *)DMPA2VA(pte & PGNUMMASK);
 
        if (!(pte & PTE_P))
            continue;
 
        for (j = 0; j < PAGETABLE_ENTRIES; j++) {
            PageEntry pte2 = l1->entries[j];
            PageTable *l2 = (PageTable *)DMPA2VA(pte2 & PGNUMMASK);
 
            if (!(pte2 & PTE_P))
                continue;
 
            for (k = 0; k < PAGETABLE_ENTRIES; k++) {
                PageEntry pte3 = l2->entries[k];
                PageTable *l3 = (PageTable *)DMPA2VA(pte3 & PGNUMMASK);
 
                if (!(pte3 & PTE_P))
                    continue;
 
                if ((pte3 & PTE_PS) == 0) {
                    for (l = 0; l < PAGETABLE_ENTRIES; l++) {
                        PageEntry pte4 = l3->entries[l];
 
                        if (pte4 & PTE_P)
                            kprintf("0x%016llx: 0x%016llx P%c%c%c%c%c\n",
                                    AddrFromIJKL(i, j, k, l),
                                    (uint64_t)pte4,
                                    (pte4 & PTE_W) ? 'W' : ' ',
                                    (pte4 & PTE_NX) ? ' ' : 'X',
                                    (pte4 & PTE_U) ? 'U' : ' ',
                                    (pte4 & PTE_A) ? 'A' : ' ',
                                    (pte4 & PTE_D) ? 'D' : ' ');
                    }
                }
            }
        }
    }
 
    return;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PMap_Init()

void PMap_Init ( )

Definition at line 19 of file pmap.c.

{
    int i, j;
 
    kprintf("Initializing PMAP ... ");
 
    // Setup global state
    for (i = 0; i < MAX_CPUS; i++) {
        currentAS[i] = 0;
    }
 
    // Allocate system page table
    systemAS.root = PAlloc_AllocPage();
    systemAS.tables = PAGETABLE_ENTRIES / 2 + 1;
    systemAS.mappings = 0;
    if (!systemAS.root)
        PANIC("Cannot allocate system page table");
 
    for (i = 0; i < PAGETABLE_ENTRIES / 2; i++)
        systemAS.root->entries[i] = 0;
 
    for (i = PAGETABLE_ENTRIES / 2; i < PAGETABLE_ENTRIES; i++) {
        PageTable *pgtbl = PAlloc_AllocPage();
        PageEntry pte = DMVA2PA((uint64_t)pgtbl) | PTE_W | PTE_P;
        if (!pgtbl)
            PANIC("Not enough memory!");
 
        systemAS.root->entries[i] = pte;
 
        for (j = 0; j < PAGETABLE_ENTRIES; j++) {
            pgtbl->entries[j] = 0;
        }
    }
 
    // Setup system mappings
    PMap_SystemLMap(0x0, MEM_DIRECTMAP_BASE + 0x0,
                    3*512, 0); // 3GB RWX
    PMap_SystemLMap(0xC0000000, MEM_DIRECTMAP_BASE + 0xC0000000,
                    512, PTE_NX|PTE_PCD); // 1GB RW + PCD
    PMap_SystemLMap(0x100000000, MEM_DIRECTMAP_BASE + 0x100000000,
                    60*512, 0); // 60GB RWX
 
    PMap_LoadAS(&systemAS);
 
    kprintf("Done!\n");
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PMap_InitAP()

void PMap_InitAP ( )

Definition at line 67 of file pmap.c.

{
    PMap_LoadAS(&systemAS);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PMap_LoadAS()

void PMap_LoadAS ( AS * space )

PMap_LoadAS –

Load an address space into the CPU. Reloads the CR3 register in x86-64 that points the physical page tables and flushes the TLB entries.

Parameters

[in] space Address space to load.

Definition at line 182 of file pmap.c.

{
    write_cr3(DMVA2PA((uint64_t)space->root));
    currentAS[THISCPU()] = space;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PMap_Map()

bool PMap_Map	(	AS *	as,
		uint64_t	phys,
		uint64_t	virt,
		uint64_t	pages,
		uint64_t	flags
	)

PMap_Map –

Map a physical to virtual mapping in an address space.

Parameters

[in]	as	Address space.
[in]	phys	Physical address.
[in]	virt	Virtual address.
[in]	pages	Pages to map in.
[in]	flags	Flags to apply to the mapping.

Return values

true	On success
false	On failure

Definition at line 355 of file pmap.c.

{
    int i;
    PageEntry *entry;
 
    for (i = 0; i < pages; i++) {
        uint64_t va = virt + PGSIZE * i;
        PMapLookupEntry(as, va, &entry, PGSIZE);
        if (!entry) {
            kprintf("Map failed to allocate memory!\n");
            return false;
        }
 
        *entry = (phys + PGSIZE * i) | PTE_P | PTE_W | PTE_U | flags;
    }
 
    return true;
}

Here is the call graph for this function:

◆ PMap_NewAS()

AS * PMap_NewAS ( )

PMap_NewAS –

Create a new address space.

Returns: Newly created address space.

Definition at line 80 of file pmap.c.

{
    int i;
    AS *as = PAlloc_AllocPage();
 
    if (!as)
        return NULL;
 
    as->root = PAlloc_AllocPage();
    as->tables = 1;
    as->mappings = 0;
 
    if (!as->root) {
        PAlloc_Release(as);
        return NULL;
    }
 
    for (i = 0; i < PAGETABLE_ENTRIES / 2; i++)
    {
        as->root->entries[i] = 0;
    }
    for (i = PAGETABLE_ENTRIES / 2; i < PAGETABLE_ENTRIES; i++) {
        as->root->entries[i] = systemAS.root->entries[i];
    }
 
    return as;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PMap_SystemLMap()

bool PMap_SystemLMap	(	uint64_t	phys,
		uint64_t	virt,
		uint64_t	lpages,
		uint64_t	flags
	)

PMap_SystemLMap –

Map a range of large (2MB) physical pages to virtual pages in the kernel address space that is shared by all processes.

Parameters

[in]	phys	Physical address.
[in]	virt	Virtual address.
[in]	lpages	Large pages to map in.
[in]	flags	Flags to apply to the mapping.

Return values

true	On success
false	On failure

Definition at line 480 of file pmap.c.

{
    int i;
    PageEntry *entry;
 
    for (i = 0; i < lpages; i++) {
        uint64_t va = virt + LARGE_PGSIZE * i;
        PMapLookupEntry(&systemAS, va, &entry, LARGE_PGSIZE);
        if (!entry) {
            kprintf("SystemLMap failed to allocate memory!\n");
            return false;
        }
 
        *entry = (phys + LARGE_PGSIZE * i) | PTE_P | PTE_W | PTE_PS | flags;
    }
 
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PMap_SystemLookup()

void PMap_SystemLookup	(	uint64_t	va,
		PageEntry **	entry,
		int	size
	)

PMap_SystemLookup –

Lookup a kernel virtual address in a page table and return a pointer to the page entry. This function allocates page tables as necessary to fill in the 4-level heirarchy.

Parameters

[in]	va	Virtual address to lookup.
[out]	entry	Pointer will point to the PageEntry.
[in]	size	Page size we want to use.

Definition at line 460 of file pmap.c.

{
    PMapLookupEntry(&systemAS, va, entry, size);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PMap_SystemMap()

bool PMap_SystemMap	(	uint64_t	phys,
		uint64_t	virt,
		uint64_t	pages,
		uint64_t	flags
	)

PMap_SystemLMap –

Map a range of physical pages to virtual pages in the kernel address space that is shared by all processes.

Parameters

[in]	phys	Physical address.
[in]	virt	Virtual address.
[in]	pages	Pages to map in.
[in]	flags	Flags to apply to the mapping.

Return values

true	On success
false	On failure

Definition at line 514 of file pmap.c.

{
    int i;
    PageEntry *entry;
 
    for (i = 0; i < pages; i++) {
        uint64_t va = virt + PGSIZE * i;
        PMapLookupEntry(&systemAS, va, &entry, PGSIZE);
        if (!entry) {
            kprintf("SystemMap failed to allocate memory!\n");
            return false;
        }
 
        *entry = (phys + PGSIZE * i) | PTE_P | PTE_W | flags;
    }
 
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PMap_SystemUnmap()

bool PMap_SystemUnmap	(	uint64_t	virt,
		uint64_t	pages
	)

PMap_SystemUnmap –

We do not currently use this!

Definition at line 539 of file pmap.c.

{
    NOT_IMPLEMENTED();
    return false;
}

◆ PMap_Translate()

uintptr_t PMap_Translate	(	AS *	space,
		uintptr_t	va
	)

PMap_Translate –

Translates a virtual address to physical address for a given address space.

Parameters

[in]	space	Address space we wish to lookup a mapping in.
[in]	va	Virtual address we wish to translate.

Definition at line 220 of file pmap.c.

{
    int i,j,k,l;
    PageTable *table = space->root;
    PageEntry pte;
    PageEntry *entry;
 
    i = (va >> (HUGE_PGSHIFT + PGIDXSHIFT)) & PGIDXMASK;
    j = (va >> HUGE_PGSHIFT) & PGIDXMASK;
    k = (va >> LARGE_PGSHIFT) & PGIDXMASK;
    l = (va >> PGSHIFT) & PGIDXMASK;
 
    pte = table->entries[i];
    if (pte == 0) {
        ASSERT(pte);
        return 0;
    }
    table = (PageTable *)DMPA2VA(pte & PGNUMMASK);
 
    pte = table->entries[j];
    // XXX: Support 1GB pages
    if (pte == 0) {
        ASSERT(pte);
        return 0;
    }
    table = (PageTable *)DMPA2VA(pte & PGNUMMASK);
 
    pte = table->entries[k];
    if ((pte & PTE_PS) == PTE_PS) {
        // Handle 2MB pages
        entry = &table->entries[k];
        return (*entry & ~(LARGE_PGMASK | PTE_NX)) + (va & LARGE_PGMASK);
    }
    if (pte == 0) {
        ASSERT(pte);
        return 0;
    }
    table = (PageTable *)DMPA2VA(pte & PGNUMMASK);
 
    // Handle 4KB pages
    entry = &table->entries[l];
 
    return (*entry & ~(PGMASK | PTE_NX)) + (va & PGMASK);
}

Here is the caller graph for this function:

◆ PMap_Unmap()

bool PMap_Unmap	(	AS *	as,
		uint64_t	va,
		uint64_t	pages
	)

PMap_Unmap –

Unmap a range of addresses.

Parameters

[in]	as	Address space.
[in]	va	Virtual address.
[in]	pages	Pages to map in.

Return values

true	On success
false	On failure

Definition at line 387 of file pmap.c.

{
    int i;
    PageEntry *entry;
 
    for (i = 0; i < pages; i++) {
        uint64_t vai = va + PGSIZE * i;
        PMapLookupEntry(as, vai, &entry, PGSIZE);
        if (!entry) {
            kprintf("Unmap tried to allocate memory!\n");
            return false;
        }
 
        NOT_IMPLEMENTED();
 
        *entry = 0;
    }
 
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Data Structures

Macros

Typedefs

Functions

Data Structure Documentation

◆ AS

Macro Definition Documentation

◆ DMPA2VA

◆ DMVA2PA

◆ DMVA2PPN

◆ MEM_DIRECTMAP_BASE

◆ MEM_DIRECTMAP_LEN

◆ MEM_USERSPACE_BASE

◆ MEM_USERSPACE_LEN

◆ MEM_USERSPACE_STKBASE

◆ MEM_USERSPACE_STKLEN

◆ MEM_USERSPACE_STKTOP

◆ MEM_USERSPACE_TOP

◆ MEM_XMAP_BASE

◆ MEM_XMAP_LEN

◆ PPN2DMVA

◆ VA2PA

Typedef Documentation

◆ AS

Function Documentation

◆ PMap_AllocMap()

◆ PMap_CurrentAS()

◆ PMap_DestroyAS()

◆ PMap_Dump()

◆ PMap_Init()

◆ PMap_InitAP()

◆ PMap_LoadAS()

◆ PMap_Map()

◆ PMap_NewAS()

◆ PMap_SystemLMap()

◆ PMap_SystemLookup()

◆ PMap_SystemMap()

◆ PMap_SystemUnmap()

◆ PMap_Translate()

◆ PMap_Unmap()