#include #include #include #include #include #include #include #include #include "../include/heap.hpp" using namespace std; namespace GC { /** * Initialises the heap singleton and saves the address * of the calling stack frame as the stack_end. Presumeably * this address points to the stack frame of the compiled * LLVM executable after linking. */ void Heap::init() { Heap *heap = Heap::the(); heap->m_stack_end = reinterpret_cast(__builtin_frame_address(1)); } /** * Allocates a given amount of bytes on the heap. * * @param size The amount of bytes to be allocated. * * @return A pointer to the address where the memory * has been allocated. This pointer is supposed * to be casted to and object pointer. */ void *Heap::alloc(size_t size) { // Singleton Heap *heap = Heap::the(); if (size < 0) { cout << "Heap: Cannot alloc less than 0B. No bytes allocated." << endl; return nullptr; } if (heap->m_size + size > HEAP_SIZE) { collect(heap); // If collect failed, crash with OOM error assert(heap->m_size + size <= HEAP_SIZE && "Heap: Out Of Memory"); } // If a chunk was recycled, return the old chunk address uintptr_t *reused_chunk = try_recycle_chunks(heap, size); if (reused_chunk != nullptr) { return (void *)reused_chunk; } // If no free chunks was found (reused_chunk is a nullptr), // then create a new chunk auto new_chunk = new Chunk; new_chunk->size = size; new_chunk->start = (uintptr_t *)(heap->m_heap + m_size); heap->m_size += size; heap->m_allocated_chunks.push_back(new_chunk); // new_chunk should probably be a unique pointer, if that isn't implicit already return new_chunk->start; } /** * Tries to recycle used and freed chunks that are * already allocated objects by the OS but freed * from our Heap. This reduces the amount of GC * objects slightly which saves time from malloc'ing * memory from the OS. * * @param heap Pointer to the singleton Heap instance * * @param size Amount of bytes needed for the object * which is about to be allocated. * * @returns If a chunk is found and recycled, a * pointer to the allocated memory for * the object is returned. If not, a * nullptr is returned to signify no * chunks were found. */ uintptr_t *Heap::try_recycle_chunks(Heap *heap, size_t size) { // Check if there are any freed chunks large enough for current request for (size_t i = 0; i < heap->m_freed_chunks.size(); i++) { auto cp = heap->m_freed_chunks.at(i); if (cp->size > size) { // Split the chunk, use one part and add the remaining part to // the list of freed chunks size_t diff = cp->size - size; auto chunk_complement = new Chunk; chunk_complement->size = diff; chunk_complement->start = cp->start + cp->size; heap->m_freed_chunks.erase(m_freed_chunks.begin() + i); heap->m_freed_chunks.push_back(chunk_complement); heap->m_allocated_chunks.push_back(cp); return cp->start; } else if (cp->size == size) { // Reuse the whole chunk heap->m_freed_chunks.erase(m_freed_chunks.begin() + i); heap->m_allocated_chunks.push_back(cp); return cp->start; } } return nullptr; } /** * Collection phase of the garbage collector. When * an allocation is requested and there is no space * left on the heap, a collection is triggered. This * function is private so that the user cannot trigger * a collection unneccessarily. * * @param heap Heap singleton instance, only for avoiding * redundant calls to the singleton get */ void Heap::collect(Heap *heap) { // get current stack auto stack_start = reinterpret_cast(__builtin_frame_address(0)); // fix this block, it's nästy uintptr_t *stack_end; if (heap->m_stack_end != nullptr) stack_end = heap->m_stack_end; else stack_end = (uintptr_t *)0; // temporary auto work_list = heap->m_allocated_chunks; mark(stack_start, stack_end, work_list); sweep(heap); free(heap); } /** * Iterates through the stack, if an element on the stack points to a chunk * that chunk is marked (i.e. reachable). It only marks element which are directly * reachable from the chunk, so no chain of pointers from the stack are detected. * If a chunk is marked it is removed from the worklist, since it's no longer of * concern for this method. * * @param start Pointer to the start of the stack frame. * @param end Pointer to the end of the stack frame. * @param worklist The currently allocated chunks. */ void Heap::mark(uintptr_t *start, const uintptr_t *end, vector worklist) { int counter = 0; // To find adresses thats in the worklist for (; start < end; start++) { counter++; // all pointers must be aligned as double words for (auto it = worklist.begin(); it != worklist.end();) { Chunk *chunk = *it; auto c_start = reinterpret_cast(chunk->start); auto c_size = reinterpret_cast(chunk->size); auto c_end = reinterpret_cast(c_start + c_size); cout << "Start points to:\t" << hex << *start << endl; cout << "Chunk start:\t\t" << hex << c_start << endl; cout << "Chunk end:\t\t" << hex << c_end << "\n" << endl; // Check if the stack pointer aligns with the chunk if (c_start <= *start && *start < c_end) { if (!chunk->marked) { chunk->marked = true; it = worklist.erase(it); mark((uintptr_t*) c_start, (uintptr_t*) c_end, worklist); } else { ++it; } } else { ++it; } } } cout << "Counter: " << counter << endl; } /** * Sweeps the heap, unmarks the marked chunks for the next cycle, * adds the unmarked nodes to the vector of freed chunks; to be freed. * * @param heap Pointer to the heap to oporate on. */ void Heap::sweep(Heap *heap) { for (auto it = heap->m_allocated_chunks.begin(); it != heap->m_allocated_chunks.end();) { Chunk *chunk = *it; // Unmark the marked chunks for the next iteration. if (chunk->marked) { chunk->marked = false; ++it; } else { // Add the unmarked chunks to freed chunks and remove from // the list of allocated chunks heap->m_freed_chunks.push_back(chunk); it = heap->m_allocated_chunks.erase(it); } } } /** * Frees chunks that was moved to the list m_freed_chunks * by the sweep phase. If there are more than a certain * amount of free chunks, delete the free chunks to * avoid cluttering. * * @param heap Heap singleton instance, only for avoiding * redundant calls to the singleton get */ void Heap::free(Heap *heap) { if (heap->m_freed_chunks.size() > FREE_THRESH) { while (heap->m_freed_chunks.size()) { auto chunk = heap->m_freed_chunks.back(); heap->m_freed_chunks.pop_back(); delete chunk; } } // if there are chunks but not more than FREE_THRESH else if (heap->m_freed_chunks.size()) { // essentially, always check for overlap between // chunks before finishing the allocation free_overlap(heap); } } /** * Checks for overlaps between freed chunks of memory * and removes overlapping chunks while prioritizing * the chunks at lower addresses. * * @param heap Heap singleton instance, only for avoiding * redundant calls to the singleton get * * @note Maybe this should be changed to prioritizing * larger chunks. */ void Heap::free_overlap(Heap *heap) { std::vector filtered; size_t i = 0; filtered.push_back(heap->m_freed_chunks.at(i++)); cout << filtered.back()->start << endl; for (; i < heap->m_freed_chunks.size(); i++) { auto prev = filtered.back(); auto next = heap->m_freed_chunks.at(i); auto p_start = (uintptr_t)(prev->start); auto p_size = (uintptr_t)(prev->size); auto n_start = (uintptr_t)(next->start); if (n_start >= (p_start + p_size)) { filtered.push_back(next); } } heap->m_freed_chunks.swap(filtered); } // ----- ONLY DEBUGGING ----------------------------------------------------------------------- /** * Prints the result of Heap::init() and a dummy value * for the current stack frame for reference. */ void Heap::check_init() { auto heap = Heap::the(); cout << "Heap addr:\t" << heap << endl; cout << "GC m_stack_end:\t" << heap->m_stack_end << endl; auto stack_start = reinterpret_cast(__builtin_frame_address(0)); cout << "GC stack_start:\t" << stack_start << endl; } /** * Conditional collection, only to be used in debugging * * @param flags Bitmap of flags */ void Heap::collect(uint flags) { cout << "DEBUG COLLECT\nFLAGS: "; if (flags & MARK) cout << "\n - MARK"; if (flags & SWEEP) cout << "\n - SWEEP"; if (flags & FREE) cout << "\n - FREE"; cout << endl; auto heap = Heap::the(); // get the frame adress, whwere local variables and saved registers are located auto stack_start = reinterpret_cast(__builtin_frame_address(0)); cout << "Stack start in collect:\t" << stack_start << endl; uintptr_t *stack_end; if (heap->m_stack_end != nullptr) stack_end = heap->m_stack_end; else stack_end = (uintptr_t *) stack_start - 80; // dummy value cout << "Stack end in collect:\t " << stack_end << endl; auto work_list = heap->m_allocated_chunks; if (flags & MARK) { mark(stack_start, stack_end, work_list); } if (flags & SWEEP) { sweep(heap); } if (flags & FREE) { free(heap); } } // Mark child references from the root references void mark_test(vector worklist) { while (worklist.size() > 0) { Chunk *ref = worklist.back(); worklist.pop_back(); Chunk *child = (Chunk*) ref; // this is probably not correct if (child != nullptr && !child->marked) { child->marked = true; worklist.push_back(child); mark_test(worklist); } } } // Mark the root references and look for child references to them void mark_from_roots(uintptr_t *start, const uintptr_t *end) { vector worklist; for (;start > end; start --) { if (*start % 8 == 0) { // all pointers must be aligned as double words Chunk *ref = (Chunk*) *start; if (ref != nullptr && !ref->marked) { ref->marked = true; worklist.push_back(ref); mark_test(worklist); } } } } // For testing purposes void Heap::print_line(Chunk *chunk) { cout << "Marked: " << chunk->marked << "\nStart adr: " << chunk->start << "\nSize: " << chunk->size << " B\n" << endl; } void Heap::print_worklist(std::vector list) { for (auto cp : list) { cout << "Chunk at:\t" << cp->start << "\nSize:\t\t" << cp->size << endl; } } void Heap::print_contents() { auto heap = Heap::the(); if (heap->m_allocated_chunks.size()) { cout << "\nALLOCATED CHUNKS #" << dec << heap->m_allocated_chunks.size() << endl; for (auto chunk : heap->m_allocated_chunks) { print_line(chunk); } } else { cout << "NO ALLOCATIONS\n" << endl; } if (heap->m_freed_chunks.size()) { cout << "\nFREED CHUNKS #" << dec << heap->m_freed_chunks.size() << endl; for (auto fchunk : heap->m_freed_chunks) { print_line(fchunk); } } else { cout << "NO FREED CHUNKS" << endl; } } }