mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-09-30 12:35:02 +01:00
Richard Smith
bfe5c36bfc
These are used by the AST in lots of ways, and this resolves various layering issues. This means that `AllocationId` also lives in ast/, but is managed by interpreter/. A better layering here would be desirable, but this seems good enough for the time being.
79 lines
2.5 KiB
C++
79 lines
2.5 KiB
C++
// Part of the Carbon Language project, under the Apache License v2.0 with LLVM
|
|
// Exceptions. See /LICENSE for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
|
|
#ifndef CARBON_EXPLORER_INTERPRETER_HEAP_H_
|
|
#define CARBON_EXPLORER_INTERPRETER_HEAP_H_
|
|
|
|
#include <vector>
|
|
|
|
#include "common/ostream.h"
|
|
#include "explorer/ast/address.h"
|
|
#include "explorer/ast/value.h"
|
|
#include "explorer/common/nonnull.h"
|
|
#include "explorer/common/source_location.h"
|
|
#include "explorer/interpreter/heap_allocation_interface.h"
|
|
|
|
namespace Carbon {
|
|
|
|
// A Heap represents the abstract machine's dynamically allocated memory.
|
|
class Heap : public HeapAllocationInterface {
|
|
public:
|
|
enum class ValueState {
|
|
Uninitialized,
|
|
Alive,
|
|
Dead,
|
|
};
|
|
|
|
// Constructs an empty Heap.
|
|
explicit Heap(Nonnull<Arena*> arena) : arena_(arena){};
|
|
|
|
Heap(const Heap&) = delete;
|
|
auto operator=(const Heap&) -> Heap& = delete;
|
|
|
|
// Returns the value at the given address in the heap after
|
|
// checking that it is alive.
|
|
auto Read(const Address& a, SourceLocation source_loc) const
|
|
-> ErrorOr<Nonnull<const Value*>>;
|
|
|
|
// Writes the given value at the address in the heap after
|
|
// checking that the address is alive.
|
|
auto Write(const Address& a, Nonnull<const Value*> v,
|
|
SourceLocation source_loc) -> ErrorOr<Success>;
|
|
|
|
auto GetAllocationId(Nonnull<const Value*> v) const
|
|
-> std::optional<AllocationId> override;
|
|
|
|
// Put the given value on the heap and mark its state.
|
|
// Mark UninitializedValue as uninitialized and other values as alive.
|
|
auto AllocateValue(Nonnull<const Value*> v) -> AllocationId override;
|
|
|
|
// Marks this allocation, and all of its sub-objects, as dead.
|
|
void Deallocate(AllocationId allocation) override;
|
|
void Deallocate(const Address& a);
|
|
|
|
// Print all the values on the heap to the stream `out`.
|
|
void Print(llvm::raw_ostream& out) const;
|
|
|
|
LLVM_DUMP_METHOD void Dump() const { Print(llvm::errs()); }
|
|
|
|
auto arena() const -> Arena& override { return *arena_; }
|
|
|
|
private:
|
|
// Signal an error if the allocation is no longer alive.
|
|
auto CheckAlive(AllocationId allocation, SourceLocation source_loc) const
|
|
-> ErrorOr<Success>;
|
|
|
|
// Signal an error if the allocation has not been initialized.
|
|
auto CheckInit(AllocationId allocation, SourceLocation source_loc) const
|
|
-> ErrorOr<Success>;
|
|
|
|
Nonnull<Arena*> arena_;
|
|
std::vector<Nonnull<const Value*>> values_;
|
|
std::vector<ValueState> states_;
|
|
};
|
|
|
|
} // namespace Carbon
|
|
|
|
#endif // CARBON_EXPLORER_INTERPRETER_HEAP_H_
|