Files
carbon-lang/explorer/interpreter/heap.cpp
T
Adrien Leravat 19c74ead49 Explorer: Add initial initializing expression support for variable declaration (#2907)
Add partial support for initializing expressions for variable declaration. This is based on https://github.com/carbon-language/carbon-lang/pull/2006, which introduces expression categories, and how it is possible to convert to/from those different categories.

## Functional changes

* Initializing expressions initialize directly the provided storage when used to initialize a variable.
   * Allows initializing expressions to avoid a copy when using `[var|let] name: type = call_expression(...)` by initializing `name` in-place.
   * Support `returned var: ...` and `return <expr>`
   * Support nested initializing expressions

## Main implementation changes

* Updated PatternMatch logic to handle expression categories
* Updated `VariableDefinition` interpreter statement to allocate and pass a location to initializing expressions
    * Update statement actions to allow passing an allocation, used by return expr or returned var
* Modified the RuntimeScope API to be one step closer to the memory model we want to have
    * Remove `GetAllocationId` and older `Bind` which don't apply
* New set of tests to highlight those different situations
    * Added a new intrinsic to print the allocation stack (and make sure we behave correctly, beyond visible side effects)

## Next work

* Dedicated `Action` to retrieve expression category information in the interpreter (https://github.com/carbon-language/carbon-lang/pull/2927)
* Avoid copies when initializing value expression from reference expression and prevent mutations for the duration of the "pinning" (https://github.com/carbon-language/carbon-lang/pull/2927)
* Avoid unnecessary copies from value expression to value expression, after ensuring that even value expression temporaries are registered for destruction.
* Avoid unnecessary copies when binding function arguments
2023-06-23 21:42:00 -07:00

115 lines
3.9 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
#include "explorer/interpreter/heap.h"
#include "common/check.h"
#include "explorer/ast/value.h"
#include "explorer/common/error_builders.h"
#include "llvm/ADT/StringExtras.h"
#include "llvm/Support/Error.h"
namespace Carbon {
auto Heap::AllocateValue(Nonnull<const Value*> v) -> AllocationId {
// Putting the following two side effects together in this function
// ensures that we don't do anything else in between, which would be really
// bad! Consider whether to include a copy of the input v in this function or
// to leave it up to the caller.
AllocationId a(values_.size());
values_.push_back(v);
if (v->kind() == Carbon::Value::Kind::UninitializedValue) {
states_.push_back(ValueState::Uninitialized);
} else {
states_.push_back(ValueState::Alive);
}
return a;
}
auto Heap::Read(const Address& a, SourceLocation source_loc) const
-> ErrorOr<Nonnull<const Value*>> {
CARBON_RETURN_IF_ERROR(this->CheckInit(a.allocation_, source_loc));
CARBON_RETURN_IF_ERROR(this->CheckAlive(a.allocation_, source_loc));
Nonnull<const Value*> value = values_[a.allocation_.index_];
return value->GetElement(arena_, a.element_path_, source_loc, value);
}
auto Heap::Write(const Address& a, Nonnull<const Value*> v,
SourceLocation source_loc) -> ErrorOr<Success> {
CARBON_RETURN_IF_ERROR(this->CheckAlive(a.allocation_, source_loc));
if (states_[a.allocation_.index_] == ValueState::Uninitialized) {
if (!a.element_path_.IsEmpty()) {
return ProgramError(source_loc)
<< "undefined behavior: store to subobject of uninitialized value "
<< *values_[a.allocation_.index_];
}
states_[a.allocation_.index_] = ValueState::Alive;
}
CARBON_ASSIGN_OR_RETURN(values_[a.allocation_.index_],
values_[a.allocation_.index_]->SetField(
arena_, a.element_path_, v, source_loc));
return Success();
}
auto Heap::CheckAlive(AllocationId allocation, SourceLocation source_loc) const
-> ErrorOr<Success> {
if (states_[allocation.index_] == ValueState::Dead ||
states_[allocation.index_] == ValueState::Discarded) {
return ProgramError(source_loc)
<< "undefined behavior: access to dead or discarded value "
<< *values_[allocation.index_];
}
return Success();
}
auto Heap::CheckInit(AllocationId allocation, SourceLocation source_loc) const
-> ErrorOr<Success> {
if (states_[allocation.index_] == ValueState::Uninitialized) {
return ProgramError(source_loc)
<< "undefined behavior: access to uninitialized value "
<< *values_[allocation.index_];
}
return Success();
}
void Heap::Deallocate(AllocationId allocation) {
if (states_[allocation.index_] != ValueState::Dead) {
states_[allocation.index_] = ValueState::Dead;
} else {
CARBON_FATAL() << "deallocating an already dead value: "
<< *values_[allocation.index_];
}
}
void Heap::Deallocate(const Address& a) { Deallocate(a.allocation_); }
auto Heap::is_initialized(AllocationId allocation) const -> bool {
return states_[allocation.index_] != ValueState::Uninitialized;
}
auto Heap::is_discarded(AllocationId allocation) const -> bool {
return states_[allocation.index_] == ValueState::Discarded;
}
void Heap::Discard(AllocationId allocation) {
CARBON_CHECK(states_[allocation.index_] == ValueState::Uninitialized);
states_[allocation.index_] = ValueState::Discarded;
}
void Heap::Print(llvm::raw_ostream& out) const {
llvm::ListSeparator sep;
for (size_t i = 0; i < values_.size(); ++i) {
out << sep;
out << i << ": ";
if (states_[i] == ValueState::Uninitialized) {
out << "!";
} else if (states_[i] == ValueState::Dead) {
out << "!!";
}
out << *values_[i];
}
}
} // namespace Carbon