pmmngr.h File Reference

#include <aurora.h>

Include dependency graph for pmmngr.h:

Go to the source code of this file.

Classes
struct	_au_page_desc_

Macros
#define	AURORA_PAGE_KERNEL   (1ULL<<0)
#define	AURORA_PAGE_SHM   (1ULL<<1)
#define	AURORA_PAGE_DMA   (1ULL<<2)
#define	AURORA_PAGE_NORMAL   (1ULL << 3)

Typedefs
typedef struct _au_page_desc_	AuPageDesc

Functions
void	AuPmmngrInitialize (KERNEL_BOOT_INFO *info)
	AuPmmngrInitialise – initialise the physical memory manager.
AU_EXTERN AU_EXPORT void *	AuPmmngrAlloc ()
	AuPmmngrAlloc – Allocate a single physical page frame and return it to the caller.
AU_EXTERN AU_EXPORT void *	AuPmmngrAllocBlocks (int num)
	AuPmmngrAllocBlocks – Allocate multiple physical page frames and return the first page pointer to the caller.
AU_EXTERN AU_EXPORT void	AuPmmngrFree (void *Address)
	AuPmmngrFree – Free a physical page frame.
AU_EXTERN AU_EXPORT void	AuPmmngrFreeBlocks (void *Addr, int Count)
	AuPmmngrFreeBlocks – Free multiple page frames.
AU_EXTERN AU_EXPORT uint64_t	P2V (uint64_t addr)
	P2V – Physical to Virtual conversion.
AU_EXTERN AU_EXPORT uint64_t	V2P (uint64_t vaddr)
	V2P – Virtual to Physical conversion.
void	AuPmmngrMoveHigher ()
	AuPmmngrMoveHigher – moves the kernel to higher half of memory.
uint64_t	AuPmmngrGetFreeMem ()
	AuPmmngrGetFreeMem – returns the total free amount of RAM.
uint64_t	AuPmmngrGetTotalMem ()
	AuPmmngrGetTotalMem – returns the total amount of RAM.
void	AuPmmngrAddRefcount (uint64_t physaddr, uint16_t count)
	AuPmmngrAddRefcount – increment reference count of given page.
uint16_t	AuPmmngrGetRefcount (uint64_t physaddr)
	AuPmmngrGetRefcount – returns the number of reference count for given physical address.
AuPageDesc *	AuPmmngrGetPageDesc (uint64_t physaddr)
	AuPmmngrGetPageDesc – return the correct page descriptor of given physical address.
void	AuPmmngrSetPageType (uint64_t physaddr, uint8_t flags)
	AuPmmngrSetPageType – set page type.

Detailed Description

BSD 2-Clause License

Copyright (c) 2022, Manas Kamal Choudhury All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Macro Definition Documentation

AURORA_PAGE_DMA

#define AURORA_PAGE_DMA   (1ULL<<2)

AURORA_PAGE_KERNEL

#define AURORA_PAGE_KERNEL   (1ULL<<0)

AURORA_PAGE_NORMAL

#define AURORA_PAGE_NORMAL   (1ULL << 3)

AURORA_PAGE_SHM

#define AURORA_PAGE_SHM   (1ULL<<1)

Typedef Documentation

AuPageDesc

typedef struct _au_page_desc_ AuPageDesc

AuPageDesc – stores metadata about each physical page

Function Documentation

AuPmmngrAddRefcount()

void AuPmmngrAddRefcount ( uint64_t  physaddr, uint16_t  count  )

extern

AuPmmngrAddRefcount – increment reference count of given page.

Parameters

physaddr	– Physical address to increase reference count of
count	– number of count to increase

AuPmmngrAlloc()

AU_EXTERN AU_EXPORT void * AuPmmngrAlloc

(

)

AuPmmngrAlloc – Allocate a single physical page frame and return it to the caller.

AuPmmngrAllocBlocks()

AU_EXTERN AU_EXPORT void * AuPmmngrAllocBlocks

(

int

num

)

AuPmmngrAllocBlocks – Allocate multiple physical page frames and return the first page pointer to the caller.

Parameters

size	– Number of blocks to allocate

AuPmmngrFree()

AU_EXTERN AU_EXPORT void AuPmmngrFree

(

void *

Address

)

AuPmmngrFree – Free a physical page frame.

Parameters

Address

– Pointer to physical page

AuPmmngrFreeBlocks()

AU_EXTERN AU_EXPORT void AuPmmngrFreeBlocks	(	void *	Addr,
		int	Count
	)

AuPmmngrFreeBlocks – Free multiple page frames.

Parameters

Addr	– Address of the first page frame
Count	– Number of blocks to be freed

AuPmmngrGetFreeMem()

uint64_t AuPmmngrGetFreeMem ( )

extern

AuPmmngrGetFreeMem – returns the total free amount of RAM.

AuPmmngrGetPageDesc()

AuPageDesc * AuPmmngrGetPageDesc ( uint64_t  physaddr )

extern

AuPmmngrGetPageDesc – return the correct page descriptor of given physical address.

Parameters

physaddr

– physical address number

AuPmmngrGetRefcount()

uint16_t AuPmmngrGetRefcount ( uint64_t  physaddr )

extern

AuPmmngrGetRefcount – returns the number of reference count for given physical address.

Parameters

physaddr

– physical address to check for reference count

Returns

number of reference count

AuPmmngrGetTotalMem()

uint64_t AuPmmngrGetTotalMem ( )

extern

AuPmmngrGetTotalMem – returns the total amount of RAM.

AuPmmngrInitialize()

void AuPmmngrInitialize ( KERNEL_BOOT_INFO *  info )

extern

AuPmmngrInitialise – initialise the physical memory manager.

Parameters

info	– Pointer to kernel boot info structure

AuPmmngrMoveHigher()

void AuPmmngrMoveHigher ( )

extern

AuPmmngrMoveHigher – moves the kernel to higher half of memory.

AuPmmngrSetPageType()

void AuPmmngrSetPageType ( uint64_t  physaddr, uint8_t  flags  )

extern

AuPmmngrSetPageType – set page type.

Parameters

physaddr	– Physical address to treat
flags	– type flags

check if page is kernel or dma, if yes then normal bit should be removed, because kernel will treat kernel or dma pages differently

P2V()

AU_EXTERN AU_EXPORT uint64_t P2V

(

uint64_t

addr

)

P2V – Physical to Virtual conversion.

Parameters

addr	– Address to convert

V2P()

AU_EXTERN AU_EXPORT uint64_t V2P

(

uint64_t

vaddr

)

V2P – Virtual to Physical conversion.

Parameters

vaddr

– Address to convert