Files
carbon-lang/toolchain/lowering/lowering_function_context.cpp
T
Richard SmithandJon Ross-Perkins e41a165359 Retain information about how an initializing expression is used in semantics IR (#3173)
Switch from a fully lowering-oriented approach to initializing
expressions in semantics IR to an approach that retains more information
about the high-level semantics of the program. Specifically:

- Always form an `Assign` node for a variable initialization or
assignment, even for empty types and when the actual initialization is
performed in-place by evaluating the right-hand side.
- Always form a `ReturnExpression` node for a return statement with an
expression, even when the actual initialization is performed in-place
into the return slot and the function doesn't return a value.

This is intended to permit us to more easily write semantic checks over
the IR, and to preserve a use edge from the use of an initializing
expression and its initializer in all cases.

To better support this, `MaterializeTemporary` is also split into two
nodes:

- A `TemporaryStorage` node allocates and provides the storage for a
temporary, and is emitted prior to emitting the initialization of the
temporary.
- A `Temporary` node connects the temporary storage to the initializer,
and is emitted after emitting the initialization.

Example testcase:

```carbon
fn F() -> (i32, i32);

fn G() -> (i32, i32) {
  var v: (i32, i32) = F();
  v = F();
  return F();
}

fn H() -> i32 {
  return G()[0];
}
```

Before:

```carbon-semir
fn @G() -> %return: (i32, i32) {
  // ...
  %v: (i32, i32) = var "v"
  %.loc4_24: (i32, i32) = call @F() to %v
  %.loc5: (i32, i32) = call @F() to %v
  %.loc6: (i32, i32) = call @F() to %return
  return
}

fn @H() -> i32 {
!entry:
  %.loc10_11.1: (i32, i32) = materialize_temporary
  %.loc10_11.2: (i32, i32) = call @G() to %.loc10_11.1
  %.loc10_14: i32 = int_literal 0
  %.loc10_15.1: i32 = tuple_index %.loc10_11.1, %.loc10_14
  %.loc10_15.2: i32 = bind_value %.loc10_15.1
  return %.loc10_15.2
}
```

After:

```carbon-semir
fn @G() -> %return: (i32, i32) {
  // ...
  %v: (i32, i32) = var "v"
  %.loc4_24: (i32, i32) = call @F() to %v
  assign %v, %.loc4_24
  %.loc5: (i32, i32) = call @F() to %v
  assign %v, %.loc5
  %.loc6: (i32, i32) = call @F() to %return
  return %.loc6
}

fn @H() -> i32 {
!entry:
  %.loc10_11.1: (i32, i32) = temporary_storage
  %.loc10_11.2: (i32, i32) = call @G() to %.loc10_11.1
  %.loc10_14: i32 = int_literal 0
  %.loc10_11.3: (i32, i32) = temporary %.loc10_11.1, %.loc10_11.2
  %.loc10_15.1: i32 = tuple_index %.loc10_11.3, %.loc10_14
  %.loc10_15.2: i32 = bind_value %.loc10_15.1
  return %.loc10_15.2
}
```

Note that in the "Before" code, there is no indication in `G()` that we
assigned to `v`, and no path through "use" edges from the tuple indexing
in `H()` to the call to `G()`.

This change results in our not performing `memcpy`s into the destination
for tuple and struct initializers. This is a consequence of those
initializers not yet performing in-place initialization, and will be
fixed in a subsequent change.

---------

Co-authored-by: Jon Ross-Perkins <jperkins@google.com>
2023-08-30 23:29:23 +00:00

114 lines
4.0 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 "toolchain/lowering/lowering_function_context.h"
#include "toolchain/semantics/semantics_ir.h"
namespace Carbon::Lower {
FunctionContext::FunctionContext(FileContext& file_context,
llvm::Function* function)
: file_context_(&file_context),
function_(function),
builder_(file_context.llvm_context()) {}
auto FunctionContext::GetBlock(SemIR::NodeBlockId block_id)
-> llvm::BasicBlock* {
llvm::BasicBlock*& entry = blocks_[block_id];
if (!entry) {
entry = llvm::BasicBlock::Create(llvm_context(), "", function_);
}
return entry;
}
auto FunctionContext::TryToReuseBlock(SemIR::NodeBlockId block_id,
llvm::BasicBlock* block) -> bool {
if (!blocks_.insert({block_id, block}).second) {
return false;
}
if (block == synthetic_block_) {
synthetic_block_ = nullptr;
}
return true;
}
auto FunctionContext::GetBlockArg(SemIR::NodeBlockId block_id,
SemIR::TypeId type_id) -> llvm::PHINode* {
llvm::BasicBlock* block = GetBlock(block_id);
// Find the existing phi, if any.
auto phis = block->phis();
if (!phis.empty()) {
CARBON_CHECK(std::next(phis.begin()) == phis.end())
<< "Expected at most one phi, found "
<< std::distance(phis.begin(), phis.end());
return &*phis.begin();
}
// The number of predecessor slots to reserve.
static constexpr unsigned NumReservedPredecessors = 2;
auto* phi = llvm::PHINode::Create(GetType(type_id), NumReservedPredecessors);
phi->insertInto(block, block->begin());
return phi;
}
auto FunctionContext::CreateSyntheticBlock() -> llvm::BasicBlock* {
synthetic_block_ = llvm::BasicBlock::Create(llvm_context(), "", function_);
return synthetic_block_;
}
auto FunctionContext::FinishInitialization(SemIR::TypeId type_id,
SemIR::NodeId dest_id,
SemIR::NodeId source_id) -> void {
switch (SemIR::GetInitializingRepresentation(semantics_ir(), type_id).kind) {
case SemIR::InitializingRepresentation::None:
case SemIR::InitializingRepresentation::InPlace:
break;
case SemIR::InitializingRepresentation::ByCopy:
CopyValue(type_id, source_id, dest_id);
break;
}
}
auto FunctionContext::CopyValue(SemIR::TypeId type_id, SemIR::NodeId source_id,
SemIR::NodeId dest_id) -> void {
switch (auto rep = SemIR::GetValueRepresentation(semantics_ir(), type_id);
rep.kind) {
case SemIR::ValueRepresentation::None:
break;
case SemIR::ValueRepresentation::Copy:
builder().CreateStore(GetLocalLoaded(source_id), GetLocal(dest_id));
break;
case SemIR::ValueRepresentation::Pointer: {
const auto& layout = llvm_module().getDataLayout();
auto* type = GetType(type_id);
// TODO: Compute known alignment of the source and destination, which may
// be greater than the alignment computed by LLVM.
auto align = layout.getABITypeAlign(type);
// TODO: Attach !tbaa.struct metadata indicating which portions of the
// type we actually need to copy and which are padding.
builder().CreateMemCpy(GetLocal(dest_id), align, GetLocal(source_id),
align, layout.getTypeAllocSize(type));
break;
}
case SemIR::ValueRepresentation::Custom:
CARBON_FATAL() << "TODO: Add support for CopyValue with custom value rep";
}
}
auto FunctionContext::GetLocalLoaded(SemIR::NodeId node_id) -> llvm::Value* {
auto* value = GetLocal(node_id);
if (llvm::isa<llvm::AllocaInst, llvm::GetElementPtrInst>(value)) {
auto* load_type = GetType(semantics_ir().GetNode(node_id).type_id());
return builder().CreateLoad(load_type, value);
} else {
// No load is needed.
return value;
}
}
} // namespace Carbon::Lower