heap.cpp File Reference

#include <Library/errno.hpp>
#include <Locking/Mutex.hpp>
#include <Memory/heap.hpp>
#include <Memory/paging.hpp>
#include <stddef.h>

Include dependency graph for heap.cpp:

Go to the source code of this file.

Functions
int	liballoc_lock ()
int	liballoc_unlock ()
void *	liballoc_alloc (unsigned int count)
int	liballoc_free (void *page, unsigned int count)

Detailed Description

Liballoc heap implementation.

Author

Keeton Feavel (keeto.nosp@m.nfea.nosp@m.vel@c.nosp@m.edar.nosp@m.ville.nosp@m..edu)

Version

0.1

Date

2021-08-24

Copyright

Copyright the Xyris Contributors (c) 2021

Definition in file heap.cpp.

Function Documentation

liballoc_alloc()

void* liballoc_alloc

(

unsigned int

)

This is the hook into the local system which allocates pages. It accepts an integer parameter which is the number of pages required. The page size was set up in the liballoc_init function.

Returns

NULL if the pages were not allocated.

A pointer to the allocated memory.

Definition at line 31 of file heap.cpp.

{
    return Memory::newPage(count * ARCH_PAGE_SIZE - 1);
}

Here is the call graph for this function:

liballoc_free()

int liballoc_free	(	void *	,
		unsigned int
	)

This frees previously allocated memory. The void* parameter passed to the function is the exact same value returned from a previous liballoc_alloc call.

The integer value is the number of pages to free.

Returns

0 if the memory was successfully freed.

Definition at line 36 of file heap.cpp.

{
    Memory::freePage(page, count * ARCH_PAGE_SIZE - 1);
    return 0;
}

Here is the call graph for this function:

liballoc_lock()

int liballoc_lock

(

)

This function is supposed to lock the memory data structures. It could be as simple as disabling interrupts or acquiring a spinlock. It's up to you to decide.

Returns

0 if the lock was acquired successfully. Anything else is failure.

Definition at line 21 of file heap.cpp.

{
    return (lock.lock() ? 0 : 1);
}

liballoc_unlock()

int liballoc_unlock

(

)

This function unlocks what was previously locked by the liballoc_lock function. If it disabled interrupts, it enables interrupts. If it had acquiried a spinlock, it releases the spinlock. etc.

Returns

0 if the lock was successfully released.

Definition at line 26 of file heap.cpp.

{
    return (lock.unlock() ? 0 : 1);
}