kalloc.h

Go to the documentation of this file.

#ifndef KALLOC_H
#define KALLOC_H
 
#include <stddef.h>
#include <stdint.h>
 
/**
 * @brief Aligns the given value `x` up to the nearest multiple of `a`.
 * 
 * @param x The value to align.
 * @param a The alignment boundary.
 * @return The aligned value.
 */
#define ALIGNMENT_MASK(x, a) ((typeof(x))(a) - 1)
/**
 * @brief Aligns the given value `x` up to the nearest multiple of `a`.
 * 
 * @param x The value to align.
 * @param a The alignment boundary.
 * @return The aligned value.
 */
#define ALIGN_UP(x, a) (((x) + ALIGNMENT_MASK(x, a)) & ~ALIGNMENT_MASK(x, a))
/**
 * @brief Aligns the given value `x` down to the nearest multiple of `a`.
 * 
 * @param x The value to align.
 * @param a The alignment boundary.
 * @return The aligned value.
 */
#define ALIGN_DOWN(x, a) ((x) & ~ALIGNMENT_MASK(x, a))
 
/**
 * @brief The size of a memory page in bytes.
 */
#define PAGE_SIZE 4096
 
/**
 * @brief Rounds up the given address to the nearest page boundary
 * 
 * @param addr The address to align.
 * @return The aligned address.
 */
size_t page_align_up(size_t addr);
/**
 * @brief Rounds down the given address to the nearest page boundary
 * 
 * @param addr The address to align.
 * @return The aligned address.
 */
size_t page_align_down(size_t addr);
 
/**
 * @brief Initializes the kernel memory allocator.
 */
void kalloc_init(void);
 
/**
 * @brief Converts a physical address to a virtual address according to the Higher Half
 * Direct Mapping (HHDM) scheme
 * 
 * @param phys The physical address to convert.
 * @return The virtual address.
 */
void *hhdm_physical_to_virtual(size_t phys);
/**
 * @brief Converts a virtual address to a physical address according to the Higher Half
 * Direct Mapping (HHDM) scheme
 * 
 * @param virt The virtual address to convert.
 * @return The physical address.
 */
size_t hhdm_virtual_to_physical(void *virt);
 
#endif