Files
nunuhara_xsystem4/include/vm/heap.h
T
Nunuhara Cabbage 851a19acc1 Work around for FFI heap reallocation bugs
ref types are currently passed to HLL functions as pointers into the
heap. If the HLL function itself needs to allocate memory from the heap,
it can cause the heap to be reallocated, rendering these heap pointers
invalid.

In order to work around this, hll_call now guarantees 64 slots are
available on the heap before calling any HLL function. This is not a
great solution, but it should work to the extent that HLL functions only
allocate a fixed number of heap slots < 64.

This bug could be easily triggered by scrolling up on the message log in
Sengoku Rance.
2021-02-20 20:41:05 -08:00

83 lines
2.0 KiB
C

/* Copyright (C) 2019 Nunuhara Cabbage <nunuhara@haniwa.technology>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <http://gnu.org/licenses/>.
*/
#ifndef SYSTEM4_HEAP_H
#define SYSTEM4_HEAP_H
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
struct string;
struct page;
enum vm_pointer_type {
VM_PAGE,
VM_STRING
};
#define NR_VM_POINTER_TYPES (VM_STRING+1)
// Heap-backed objects. Reference counted.
struct vm_pointer {
int ref;
enum vm_pointer_type type;
union {
struct string *s;
struct page *page;
};
#ifdef DEBUG_HEAP
size_t alloc_addr;
size_t ref_addr;
size_t free_addr;
#endif
};
extern struct vm_pointer *heap;
extern size_t heap_size;
void heap_init(void);
void heap_delete(void);
int32_t heap_alloc_slot(enum vm_pointer_type type);
void heap_ref(int slot);
void heap_unref(int slot);
void exit_unref(int slot);
bool heap_index_valid(int index);
bool page_index_valid(int index);
bool string_index_valid(int index);
struct page *heap_get_page(int index);
struct string *heap_get_string(int index);
void heap_set_page(int slot, struct page *page);
/*
* Guarantee `headroom` free slots are available on the heap.
*
* XXX: this is a hack to fix an issue with HLL calls where a pointer into the
* heap can be made invalid by a heap reallocation triggered within the
* body of the HLL function.
*/
void heap_guarantee(unsigned headroom);
#ifdef VM_PRIVATE
extern int32_t *heap_free_stack;
extern size_t heap_free_ptr;
#endif /* VM_PRIVATE */
#endif /* SYSTEM4_HEAP_H */