Skip to content

stable/21.x: [Coro] RetconOnceDynamic: Add type id. #11719

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 4, 2025
Merged

stable/21.x: [Coro] RetconOnceDynamic: Add type id. #11719

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions llvm/include/llvm/IR/Intrinsics.td
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1771,7 +1771,7 @@ def int_coro_id_retcon_once : Intrinsic<[llvm_token_ty],
[]>;
def int_coro_id_retcon_once_dynamic : Intrinsic<[llvm_token_ty],
[llvm_i32_ty, llvm_i32_ty, llvm_ptr_ty, llvm_ptr_ty, llvm_ptr_ty,
llvm_ptr_ty, llvm_ptr_ty, llvm_ptr_ty, llvm_ptr_ty, llvm_ptr_ty],
llvm_ptr_ty, llvm_ptr_ty, llvm_ptr_ty, llvm_ptr_ty, llvm_ptr_ty, llvm_i64_ty],
[]>;
def int_coro_alloc : Intrinsic<[llvm_i1_ty], [llvm_token_ty], []>;
def int_coro_id_async : Intrinsic<[llvm_token_ty],
Expand Down Expand Up @@ -1819,7 +1819,7 @@ def int_coro_prepare_retcon : Intrinsic<[llvm_ptr_ty], [llvm_ptr_ty],
def int_coro_alloca_alloc : Intrinsic<[llvm_token_ty],
[llvm_anyint_ty, llvm_i32_ty], []>;
def int_coro_alloca_alloc_frame : Intrinsic<[llvm_token_ty],
[llvm_anyint_ty, llvm_i32_ty], []>;
[llvm_anyint_ty, llvm_i32_ty, llvm_i64_ty], []>;
def int_coro_alloca_get : Intrinsic<[llvm_ptr_ty], [llvm_token_ty], []>;
def int_coro_alloca_free : Intrinsic<[], [llvm_token_ty], []>;
def int_coro_alloca_free_frame : Intrinsic<[], [llvm_token_ty], []>;
Expand Down
17 changes: 17 additions & 0 deletions llvm/include/llvm/Transforms/Coroutines/CoroInstr.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,7 @@ class LLVM_LIBRARY_VISIBILITY CoroIdRetconOnceDynamicInst
DeallocArg,
AllocFrameArg,
DeallocFrameArg,
TypeIdArg,
};

public:
Expand Down Expand Up @@ -385,6 +386,13 @@ class LLVM_LIBRARY_VISIBILITY CoroIdRetconOnceDynamicInst

Value *getAllocator() const { return getArgOperand(AllocatorArg); }

/// The TypeId to be used for allocating memory.
ConstantInt *getTypeId() const {
if (arg_size() <= TypeIdArg)
return nullptr;
return cast<ConstantInt>(getArgOperand(TypeIdArg));
}

// Methods to support type inquiry through isa, cast, and dyn_cast:
static bool classof(const IntrinsicInst *I) {
return I->getIntrinsicID() == Intrinsic::coro_id_retcon_once_dynamic;
Expand Down Expand Up @@ -869,7 +877,16 @@ class CoroAllocaAllocInst : public AnyCoroAllocaAllocInst {

/// This represents the llvm.coro.alloca.alloc.frame instruction.
class CoroAllocaAllocFrameInst : public AnyCoroAllocaAllocInst {
enum { TypeIdArg = 2 };

public:
/// Return the TypeId to be used for allocating typed memory
Value *getTypeId() const {
if (arg_size() <= TypeIdArg)
return nullptr;
return getArgOperand(TypeIdArg);
}

// Methods to support type inquiry through isa, cast, and dyn_cast:
static bool classof(const IntrinsicInst *I) {
return I->getIntrinsicID() == Intrinsic::coro_alloca_alloc_frame;
Expand Down
6 changes: 4 additions & 2 deletions llvm/lib/Transforms/Coroutines/CoroSplit.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1186,8 +1186,10 @@ static void updateCoroFuncPointerContextSize(coro::Shape &Shape) {
auto *OrigContextSize = FuncPtrStruct->getOperand(1);
auto *NewContextSize = ConstantInt::get(OrigContextSize->getType(),
Shape.RetconLowering.ContextSize);
auto *NewFuncPtrStruct = ConstantStruct::get(
FuncPtrStruct->getType(), OrigRelativeFunOffset, NewContextSize);
auto *OrigTypeID = FuncPtrStruct->getOperand(2);
auto *NewFuncPtrStruct =
ConstantStruct::get(FuncPtrStruct->getType(), OrigRelativeFunOffset,
NewContextSize, OrigTypeID);

Shape.RetconLowering.CoroFuncPointer->setInitializer(NewFuncPtrStruct);
}
Expand Down
22 changes: 16 additions & 6 deletions llvm/lib/Transforms/Coroutines/Coroutines.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,7 @@ void coro::Shape::analyze(Function &F,
RetconLowering.StorageSize = ContinuationId->getStorageSize();
RetconLowering.StorageAlignment = ContinuationId->getStorageAlignment();
RetconLowering.CoroFuncPointer = ContinuationId->getCoroFunctionPointer();
RetconLowering.TypeId = ContinuationId->getTypeId();
break;
}
case Intrinsic::coro_id_retcon:
Expand Down Expand Up @@ -535,8 +536,8 @@ Value *coro::Shape::emitAlloc(IRBuilder<> &Builder, Value *Size,
case coro::ABI::RetconOnceDynamic: {
unsigned sizeParamIndex = 0;
Function *Alloc = nullptr;
if (isa_and_nonnull<CoroAllocaAllocFrameInst>(AI)) {
assert(ABI == coro::ABI::RetconOnceDynamic);
if ((ABI == coro::ABI::RetconOnceDynamic) &&
isa<CoroAllocaAllocFrameInst>(AI)) {
Alloc = RetconLowering.AllocFrame;
} else {
Alloc = RetconLowering.Alloc;
Expand All @@ -553,10 +554,18 @@ Value *coro::Shape::emitAlloc(IRBuilder<> &Builder, Value *Size,
Size, Alloc->getFunctionType()->getParamType(sizeParamIndex),
/*is signed*/ false);
Args.push_back(Size);
if (ABI == coro::ABI::RetconOnce) {
ConstantInt *TypeId = RetconLowering.TypeId;
if (TypeId != nullptr)
if (ABI == coro::ABI::RetconOnce || ABI == coro::ABI::RetconOnceDynamic) {
Value *TypeId = nullptr;
if (RetconLowering.TypeId) {
if (auto *CAAFI = dyn_cast_or_null<CoroAllocaAllocFrameInst>(AI)) {
// If malloc type ids are being used, use the callee's type id when
// allocating the callee's frame.
TypeId = CAAFI->getTypeId();
} else {
TypeId = RetconLowering.TypeId;
}
Args.push_back(TypeId);
}
}
auto *Call = Builder.CreateCall(Alloc, Args);
if (ABI == coro::ABI::RetconOnceDynamic) {
Expand All @@ -583,7 +592,6 @@ void coro::Shape::emitDealloc(IRBuilder<> &Builder, Value *Ptr,
case coro::ABI::RetconOnceDynamic: {
Function *Dealloc = nullptr;
if (isa_and_nonnull<CoroAllocaAllocFrameInst>(AI)) {
assert(ABI == coro::ABI::RetconOnceDynamic);
Dealloc = RetconLowering.DeallocFrame;
} else {
Dealloc = RetconLowering.Dealloc;
Expand Down Expand Up @@ -737,6 +745,8 @@ void CoroIdRetconOnceDynamicInst::checkWellFormed() const {
checkWFRetconPrototype(this, getArgOperand(PrototypeArg));
checkWFAlloc(this, getArgOperand(AllocArg));
checkWFDealloc(this, getArgOperand(DeallocArg));
checkWFAlloc(this, getArgOperand(AllocFrameArg));
checkWFDealloc(this, getArgOperand(DeallocFrameArg));
}

static void checkAsyncFuncPointer(const Instruction *I, Value *V) {
Expand Down
8 changes: 5 additions & 3 deletions llvm/test/Transforms/Coroutines/coro-retcon-once-dynamic-nocleanup.ll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@ target datalayout = "e-m:o-i64:64-f80:128-n8:16:32:64-S128"
target triple = "arm64-apple-macos99.99"


@func_cfp = constant <{ i32, i32 }>
@func_cfp = constant <{ i32, i32, i64 }>
<{ i32 trunc (
i64 sub (
i64 ptrtoint (ptr @func to i64),
i64 ptrtoint (ptr getelementptr inbounds (<{ i32, i32 }>, ptr @func_cfp, i32 0, i32 1) to i64)
)
to i32),
i32 64
i32 64, ; frame size
i64 1010101010 ; type_id
}>


Expand Down Expand Up @@ -45,7 +46,8 @@ entry:
ptr nonnull @allocate,
ptr nonnull @deallocate,
ptr nonnull @allocate_frame,
ptr nonnull @deallocate_frame
ptr nonnull @deallocate_frame,
i64 1010101010
)
%handle = call ptr @llvm.coro.begin(token %3, ptr null)
%yielded = getelementptr inbounds %func_self, ptr %2, i32 0, i32 0
Expand Down
39 changes: 23 additions & 16 deletions llvm/test/Transforms/Coroutines/coro-retcon-once-dynamic.ll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,36 @@
target datalayout = "e-m:o-i64:64-f80:128-n8:16:32:64-S128"
target triple = "arm64-apple-macos99.99"

%coro_func_pointer = type <{ i32, i32 }>
%coro_func_pointer = type <{ i32, i32, i64 }>

; CHECK-LABEL: %func.Frame = type { ptr }
; CHECK-LABEL: %big_types.Frame = type { <32 x i8>, [16 x i8], i64, ptr, %Integer8 }

; CHECK-LABEL: @func_cfp = constant <{ i32, i32 }>
; CHECK-LABEL: @func_cfp = constant <{ i32, i32, i64 }>
; CHECK-SAME: <{
; CHECK-SAME: i32 trunc
; CHECK-SAME: i32 16
; CHECK-SAME: }>
@func_cfp = constant <{ i32, i32 }>
@func_cfp = constant <{ i32, i32, i64 }>
<{ i32 trunc ( ; offset to @func from @func_cfp
i64 sub (
i64 ptrtoint (ptr @func to i64),
i64 ptrtoint (ptr getelementptr inbounds (<{ i32, i32 }>, ptr @func_cfp, i32 0, i32 1) to i64)
)
to i32),
i32 64 ; frame size
i32 64, ; frame size
i64 1010101010 ; type_id
}>

@big_types_cfp = constant <{ i32, i32 }>
@big_types_cfp = constant <{ i32, i32, i64 }>
<{ i32 trunc ( ; offset to @func from @big_types_cfp
i64 sub (
i64 ptrtoint (ptr @big_types to i64),
i64 ptrtoint (ptr getelementptr inbounds (<{ i32, i32 }>, ptr @big_types_cfp, i32 0, i32 1) to i64)
)
to i32),
i32 64 ; frame size
i32 64, ; frame size
i64 1010101010 ; type_id
}>


Expand Down Expand Up @@ -90,7 +92,8 @@ entry:
ptr nonnull @allocate,
ptr nonnull @deallocate,
ptr nonnull @allocate_frame,
ptr nonnull @deallocate_frame
ptr nonnull @deallocate_frame,
i64 1010101010
)
%handle = call ptr @llvm.coro.begin(token %id, ptr null)
%load = load i32, ptr %array
Expand All @@ -114,9 +117,9 @@ cleanup:

declare void @continuation_prototype(ptr, ptr)

declare swiftcorocc noalias ptr @allocate(ptr %frame, ptr swiftcoro %cator, i32 %size)
declare swiftcorocc noalias ptr @allocate(ptr %frame, ptr swiftcoro %cator, i32 %size, i64 %typeid)
declare void @deallocate(ptr %frame, ptr swiftcoro %cator, ptr %ptr)
declare swiftcorocc noalias ptr @allocate_frame(ptr %frame, ptr swiftcoro %cator, i32 %size)
declare swiftcorocc noalias ptr @allocate_frame(ptr %frame, ptr swiftcoro %cator, i32 %size, i64 %typeid)
declare void @deallocate_frame(ptr %frame, ptr swiftcoro %cator, ptr %ptr)

declare void @use(ptr %ptr)
Expand Down Expand Up @@ -146,7 +149,8 @@ define swiftcorocc { ptr, ptr } @big_types(ptr noalias %frame, ptr swiftcoro %al
ptr nonnull @allocate,
ptr nonnull @deallocate,
ptr nonnull @allocate_frame,
ptr nonnull @deallocate_frame
ptr nonnull @deallocate_frame,
i64 1010101010
)
%handle = tail call ptr @llvm.coro.begin(token %id, ptr null)
call void @llvm.lifetime.start.p0(i64 1, ptr nonnull %element_addr)
Expand All @@ -168,14 +172,15 @@ define swiftcorocc { ptr, ptr } @big_types(ptr noalias %frame, ptr swiftcoro %al
}

declare i32 @getSize()
@allocating_something_else_cfp = constant <{ i32, i32 }>
@allocating_something_else_cfp = constant <{ i32, i32, i64 }>
<{ i32 trunc ( ; offset to @func from @allocating_something_else_cfp
i64 sub (
i64 ptrtoint (ptr @allocating_something_else to i64),
i64 ptrtoint (ptr getelementptr inbounds (<{ i32, i32 }>, ptr @allocating_something_else_cfp, i32 0, i32 1) to i64)
)
to i32),
i32 64 ; frame size
i32 64, ; frame size
i64 1010101010 ; type_id
}>
declare { ptr, ptr } @allocating_something_else(ptr noalias %frame, ptr swiftcoro %allocator)

Expand Down Expand Up @@ -210,14 +215,15 @@ declare { ptr, ptr } @allocating_something_else(ptr noalias %frame, ptr swiftcor
; CHECK-SAME: ptr swiftcoro %1,
; CHECK-SAME: ptr
; CHECK-SAME: )
@allocating_something_cfp = constant <{ i32, i32 }>
@allocating_something_cfp = constant <{ i32, i32, i64 }>
<{ i32 trunc ( ; offset to @func from @allocating_something_cfp
i64 sub (
i64 ptrtoint (ptr @allocating_something to i64),
i64 ptrtoint (ptr getelementptr inbounds (<{ i32, i32 }>, ptr @allocating_something_cfp, i32 0, i32 1) to i64)
)
to i32),
i32 64 ; frame size
i32 64, ; frame size
i64 1010101010 ; type_id
}>
define { ptr, ptr } @allocating_something(ptr noalias %frame, ptr swiftcoro %allocator) {
entry:
Expand All @@ -231,7 +237,8 @@ entry:
ptr nonnull @allocate,
ptr nonnull @deallocate,
ptr nonnull @allocate_frame,
ptr nonnull @deallocate_frame
ptr nonnull @deallocate_frame,
i64 1010101010
)
%hdl = call ptr @llvm.coro.begin(token %id, ptr null)
%size = call i32 @getSize()
Expand All @@ -240,7 +247,7 @@ entry:

%callee_frame_size = load i32, ptr getelementptr inbounds nuw (%coro_func_pointer, ptr @allocating_something_else_cfp, i32 0, i32 1), align 8
%callee_frame_size_64 = zext i32 %callee_frame_size to i64
%callee_frame_token = call token @llvm.coro.alloca.alloc.frame.i64(i64 %callee_frame_size_64, i32 16)
%callee_frame_token = call token @llvm.coro.alloca.alloc.frame.i64(i64 %callee_frame_size_64, i32 16, i64 1010101010)
%callee_frame = call ptr @llvm.coro.alloca.get(token %callee_frame_token)
call void @llvm.lifetime.start.p0(i64 -1, ptr %callee_frame)
%allocating_something_else = call ptr @llvm.coro.prepare.retcon(ptr @allocating_something_else)
Expand Down