carbon-lang/explorer/interpreter/action.cpp

// 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/action.h"

#include <iterator>
#include <map>
#include <optional>
#include <utility>
#include <vector>

#include "common/check.h"
#include "common/error.h"
#include "explorer/ast/declaration.h"
#include "explorer/ast/expression.h"
#include "explorer/ast/value.h"
#include "explorer/base/arena.h"
#include "explorer/base/print_as_id.h"
#include "explorer/base/source_location.h"
#include "explorer/interpreter/stack.h"
#include "llvm/ADT/StringExtras.h"
#include "llvm/Support/Casting.h"

namespace Carbon {

using llvm::cast;

RuntimeScope::RuntimeScope(RuntimeScope&& other) noexcept
    : locals_(std::move(other.locals_)),
      bound_values_(std::move(other.bound_values_)),
      // To transfer ownership of other.allocations_, we have to empty it out.
      allocations_(std::exchange(other.allocations_, {})),
      heap_(other.heap_) {}

auto RuntimeScope::operator=(RuntimeScope&& rhs) noexcept -> RuntimeScope& {
  locals_ = std::move(rhs.locals_);
  bound_values_ = std::move(rhs.bound_values_);
  // To transfer ownership of rhs.allocations_, we have to empty it out.
  allocations_ = std::exchange(rhs.allocations_, {});
  heap_ = rhs.heap_;
  return *this;
}

void RuntimeScope::Print(llvm::raw_ostream& out) const {
  out << "scope: [";
  llvm::ListSeparator sep;
  for (const auto& [value_node, value] : locals_) {
    out << sep << "`" << value_node.base() << "`: `" << *value << "`";
  }
  out << "]";
}

void RuntimeScope::Bind(ValueNodeView value_node, Address address) {
  CARBON_CHECK(!value_node.constant_value().has_value());
  bool success =
      locals_.insert({value_node, heap_->arena().New<LocationValue>(address)})
          .second;
  CARBON_CHECK(success) << "Duplicate definition of " << value_node.base();
}

void RuntimeScope::BindAndPin(ValueNodeView value_node, Address address) {
  Bind(value_node, address);
  bool success = bound_values_.insert(&value_node.base()).second;
  CARBON_CHECK(success) << "Duplicate pinned node for " << value_node.base();
  heap_->BindValueToReference(value_node, address);
}

void RuntimeScope::BindLifetimeToScope(Address address) {
  CARBON_CHECK(address.element_path_.IsEmpty())
      << "Cannot extend lifetime of a specific sub-element";
  allocations_.push_back(address.allocation_);
}

void RuntimeScope::BindValue(ValueNodeView value_node,
                             Nonnull<const Value*> value) {
  CARBON_CHECK(!value_node.constant_value().has_value());
  CARBON_CHECK(value->kind() != Value::Kind::LocationValue);
  bool success = locals_.insert({value_node, value}).second;
  CARBON_CHECK(success) << "Duplicate definition of " << value_node.base();
}

auto RuntimeScope::Initialize(ValueNodeView value_node,
                              Nonnull<const Value*> value)
    -> Nonnull<const LocationValue*> {
  CARBON_CHECK(!value_node.constant_value().has_value());
  CARBON_CHECK(value->kind() != Value::Kind::LocationValue);
  allocations_.push_back(heap_->AllocateValue(value));
  const auto* location =
      heap_->arena().New<LocationValue>(Address(allocations_.back()));
  bool success = locals_.insert({value_node, location}).second;
  CARBON_CHECK(success) << "Duplicate definition of " << value_node.base();
  return location;
}

void RuntimeScope::Merge(RuntimeScope other) {
  CARBON_CHECK(heap_ == other.heap_);
  for (auto& element : other.locals_) {
    bool success = locals_.insert(element).second;
    CARBON_CHECK(success) << "Duplicate definition of " << element.first;
  }
  for (const auto* element : other.bound_values_) {
    bool success = bound_values_.insert(element).second;
    CARBON_CHECK(success) << "Duplicate bound value.";
  }
  allocations_.insert(allocations_.end(), other.allocations_.begin(),
                      other.allocations_.end());
  other.allocations_.clear();
}

auto RuntimeScope::Get(ValueNodeView value_node,
                       SourceLocation source_loc) const
    -> ErrorOr<std::optional<Nonnull<const Value*>>> {
  auto it = locals_.find(value_node);
  if (it == locals_.end()) {
    return {std::nullopt};
  }
  if (bound_values_.contains(&value_node.base())) {
    // Check if the bound value is still alive.
    CARBON_CHECK(it->second->kind() == Value::Kind::LocationValue);
    if (!heap_->is_bound_value_alive(
            value_node, cast<LocationValue>(it->second)->address())) {
      return ProgramError(source_loc)
             << "Reference has changed since this value was bound.";
    }
  }
  return {it->second};
}

auto RuntimeScope::Capture(
    const std::vector<Nonnull<const RuntimeScope*>>& scopes) -> RuntimeScope {
  CARBON_CHECK(!scopes.empty());
  RuntimeScope result(scopes.front()->heap_);
  for (Nonnull<const RuntimeScope*> scope : scopes) {
    CARBON_CHECK(scope->heap_ == result.heap_);
    for (const auto& entry : scope->locals_) {
      // Intentionally disregards duplicates later in the vector.
      result.locals_.insert(entry);
    }
  }
  return result;
}

void Action::Print(llvm::raw_ostream& out) const {
  out << kind_string() << " pos: " << pos_ << " ";
  switch (kind()) {
    case Action::Kind::LocationAction:
      out << "`" << cast<LocationAction>(*this).expression() << "`";
      break;
    case Action::Kind::ValueExpressionAction:
      out << "`" << cast<ValueExpressionAction>(*this).expression() << "`";
      break;
    case Action::Kind::ExpressionAction:
      out << "`" << cast<ExpressionAction>(*this).expression() << "`";
      break;
    case Action::Kind::WitnessAction:
      out << "`" << *cast<WitnessAction>(*this).witness() << "`";
      break;
    case Action::Kind::StatementAction:
      out << "`" << PrintAsID(cast<StatementAction>(*this).statement()) << "`";
      break;
    case Action::Kind::DeclarationAction:
      out << "`" << PrintAsID(cast<DeclarationAction>(*this).declaration())
          << "`";
      break;
    case Action::Kind::TypeInstantiationAction:
      out << "`" << *cast<TypeInstantiationAction>(*this).type() << "`";
      break;
    default:
      break;
  }
  if (!results_.empty()) {
    out << " results: [";
    llvm::ListSeparator sep;
    for (const auto& result : results_) {
      out << sep << "`" << *result << "`";
    }
    out << "] ";
  }
  if (scope_.has_value()) {
    out << " " << *scope_;
  }
}

auto Action::kind_string() const -> std::string_view {
  switch (kind()) {
    case Action::Kind::LocationAction:
      return "LocationAction";
    case Action::Kind::ValueExpressionAction:
      return "ValueExpressionAction";
    case Action::Kind::ExpressionAction:
      return "ExpressionAction";
    case Action::Kind::WitnessAction:
      return "WitnessAction";
    case Action::Kind::StatementAction:
      return "StatementAction";
    case Action::Kind::DeclarationAction:
      return "DeclarationAction";
    case Action::Kind::TypeInstantiationAction:
      return "TypeInstantiationAction";
    case Action::Kind::ScopeAction:
      return "ScopeAction";
    case Action::Kind::RecursiveAction:
      return "RecursiveAction";
    case Action::Kind::CleanUpAction:
      return "CleanUpAction";
    case Action::Kind::DestroyAction:
      return "DestroyAction";
  }
}

}  // namespace Carbon