Coverage Report

Created: 2022-01-18 06:27

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/lib/CodeGen/CGCoroutine.cpp
Line
Count
Source (jump to first uncovered line)
1
//===----- CGCoroutine.cpp - Emit LLVM Code for C++ coroutines ------------===//
2
//
3
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4
// See https://llvm.org/LICENSE.txt for license information.
5
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6
//
7
//===----------------------------------------------------------------------===//
8
//
9
// This contains code dealing with C++ code generation of coroutines.
10
//
11
//===----------------------------------------------------------------------===//
12
13
#include "CGCleanup.h"
14
#include "CodeGenFunction.h"
15
#include "llvm/ADT/ScopeExit.h"
16
#include "clang/AST/StmtCXX.h"
17
#include "clang/AST/StmtVisitor.h"
18
19
using namespace clang;
20
using namespace CodeGen;
21
22
using llvm::Value;
23
using llvm::BasicBlock;
24
25
namespace {
26
enum class AwaitKind { Init, Normal, Yield, Final };
27
static constexpr llvm::StringLiteral AwaitKindStr[] = {"init", "await", "yield",
28
                                                       "final"};
29
}
30
31
struct clang::CodeGen::CGCoroData {
32
  // What is the current await expression kind and how many
33
  // await/yield expressions were encountered so far.
34
  // These are used to generate pretty labels for await expressions in LLVM IR.
35
  AwaitKind CurrentAwaitKind = AwaitKind::Init;
36
  unsigned AwaitNum = 0;
37
  unsigned YieldNum = 0;
38
39
  // How many co_return statements are in the coroutine. Used to decide whether
40
  // we need to add co_return; equivalent at the end of the user authored body.
41
  unsigned CoreturnCount = 0;
42
43
  // A branch to this block is emitted when coroutine needs to suspend.
44
  llvm::BasicBlock *SuspendBB = nullptr;
45
46
  // The promise type's 'unhandled_exception' handler, if it defines one.
47
  Stmt *ExceptionHandler = nullptr;
48
49
  // A temporary i1 alloca that stores whether 'await_resume' threw an
50
  // exception. If it did, 'true' is stored in this variable, and the coroutine
51
  // body must be skipped. If the promise type does not define an exception
52
  // handler, this is null.
53
  llvm::Value *ResumeEHVar = nullptr;
54
55
  // Stores the jump destination just before the coroutine memory is freed.
56
  // This is the destination that every suspend point jumps to for the cleanup
57
  // branch.
58
  CodeGenFunction::JumpDest CleanupJD;
59
60
  // Stores the jump destination just before the final suspend. The co_return
61
  // statements jumps to this point after calling return_xxx promise member.
62
  CodeGenFunction::JumpDest FinalJD;
63
64
  // Stores the llvm.coro.id emitted in the function so that we can supply it
65
  // as the first argument to coro.begin, coro.alloc and coro.free intrinsics.
66
  // Note: llvm.coro.id returns a token that cannot be directly expressed in a
67
  // builtin.
68
  llvm::CallInst *CoroId = nullptr;
69
70
  // Stores the llvm.coro.begin emitted in the function so that we can replace
71
  // all coro.frame intrinsics with direct SSA value of coro.begin that returns
72
  // the address of the coroutine frame of the current coroutine.
73
  llvm::CallInst *CoroBegin = nullptr;
74
75
  // Stores the last emitted coro.free for the deallocate expressions, we use it
76
  // to wrap dealloc code with if(auto mem = coro.free) dealloc(mem).
77
  llvm::CallInst *LastCoroFree = nullptr;
78
79
  // If coro.id came from the builtin, remember the expression to give better
80
  // diagnostic. If CoroIdExpr is nullptr, the coro.id was created by
81
  // EmitCoroutineBody.
82
  CallExpr const *CoroIdExpr = nullptr;
83
};
84
85
// Defining these here allows to keep CGCoroData private to this file.
86
313k
clang::CodeGen::CodeGenFunction::CGCoroInfo::CGCoroInfo() {}
87
313k
CodeGenFunction::CGCoroInfo::~CGCoroInfo() {}
88
89
static void createCoroData(CodeGenFunction &CGF,
90
                           CodeGenFunction::CGCoroInfo &CurCoro,
91
                           llvm::CallInst *CoroId,
92
123
                           CallExpr const *CoroIdExpr = nullptr) {
93
123
  if (CurCoro.Data) {
94
1
    if (CurCoro.Data->CoroIdExpr)
95
1
      CGF.CGM.Error(CoroIdExpr->getBeginLoc(),
96
1
                    "only one __builtin_coro_id can be used in a function");
97
0
    else if (CoroIdExpr)
98
0
      CGF.CGM.Error(CoroIdExpr->getBeginLoc(),
99
0
                    "__builtin_coro_id shall not be used in a C++ coroutine");
100
0
    else
101
0
      llvm_unreachable("EmitCoroutineBodyStatement called twice?");
102
103
1
    return;
104
1
  }
105
106
122
  CurCoro.Data = std::unique_ptr<CGCoroData>(new CGCoroData);
107
122
  CurCoro.Data->CoroId = CoroId;
108
122
  CurCoro.Data->CoroIdExpr = CoroIdExpr;
109
122
}
110
111
// Synthesize a pretty name for a suspend point.
112
291
static SmallString<32> buildSuspendPrefixStr(CGCoroData &Coro, AwaitKind Kind) {
113
291
  unsigned No = 0;
114
291
  switch (Kind) {
115
120
  case AwaitKind::Init:
116
236
  case AwaitKind::Final:
117
236
    break;
118
51
  case AwaitKind::Normal:
119
51
    No = ++Coro.AwaitNum;
120
51
    break;
121
4
  case AwaitKind::Yield:
122
4
    No = ++Coro.YieldNum;
123
4
    break;
124
291
  }
125
291
  SmallString<32> Prefix(AwaitKindStr[static_cast<unsigned>(Kind)]);
126
291
  if (No > 1) {
127
18
    Twine(No).toVector(Prefix);
128
18
  }
129
291
  return Prefix;
130
291
}
131
132
22
static bool memberCallExpressionCanThrow(const Expr *E) {
133
22
  if (const auto *CE = dyn_cast<CXXMemberCallExpr>(E))
134
22
    if (const auto *Proto =
135
22
            CE->getMethodDecl()->getType()->getAs<FunctionProtoType>())
136
22
      if (isNoexceptExceptionSpec(Proto->getExceptionSpecType()) &&
137
22
          
Proto->canThrow() == CT_Cannot19
)
138
19
        return false;
139
3
  return true;
140
22
}
141
142
// Emit suspend expression which roughly looks like:
143
//
144
//   auto && x = CommonExpr();
145
//   if (!x.await_ready()) {
146
//      llvm_coro_save();
147
//      x.await_suspend(...);     (*)
148
//      llvm_coro_suspend(); (**)
149
//   }
150
//   x.await_resume();
151
//
152
// where the result of the entire expression is the result of x.await_resume()
153
//
154
//   (*) If x.await_suspend return type is bool, it allows to veto a suspend:
155
//      if (x.await_suspend(...))
156
//        llvm_coro_suspend();
157
//
158
//  (**) llvm_coro_suspend() encodes three possible continuations as
159
//       a switch instruction:
160
//
161
//  %where-to = call i8 @llvm.coro.suspend(...)
162
//  switch i8 %where-to, label %coro.ret [ ; jump to epilogue to suspend
163
//    i8 0, label %yield.ready   ; go here when resumed
164
//    i8 1, label %yield.cleanup ; go here when destroyed
165
//  ]
166
//
167
//  See llvm's docs/Coroutines.rst for more details.
168
//
169
namespace {
170
  struct LValueOrRValue {
171
    LValue LV;
172
    RValue RV;
173
  };
174
}
175
static LValueOrRValue emitSuspendExpression(CodeGenFunction &CGF, CGCoroData &Coro,
176
                                    CoroutineSuspendExpr const &S,
177
                                    AwaitKind Kind, AggValueSlot aggSlot,
178
291
                                    bool ignoreResult, bool forLValue) {
179
291
  auto *E = S.getCommonExpr();
180
181
291
  auto Binder =
182
291
      CodeGenFunction::OpaqueValueMappingData::bind(CGF, S.getOpaqueValue(), E);
183
291
  auto UnbindOnExit = llvm::make_scope_exit([&] { Binder.unbind(CGF); });
184
185
291
  auto Prefix = buildSuspendPrefixStr(Coro, Kind);
186
291
  BasicBlock *ReadyBlock = CGF.createBasicBlock(Prefix + Twine(".ready"));
187
291
  BasicBlock *SuspendBlock = CGF.createBasicBlock(Prefix + Twine(".suspend"));
188
291
  BasicBlock *CleanupBlock = CGF.createBasicBlock(Prefix + Twine(".cleanup"));
189
190
  // If expression is ready, no need to suspend.
191
291
  CGF.EmitBranchOnBoolExpr(S.getReadyExpr(), ReadyBlock, SuspendBlock, 0);
192
193
  // Otherwise, emit suspend logic.
194
291
  CGF.EmitBlock(SuspendBlock);
195
196
291
  auto &Builder = CGF.Builder;
197
291
  llvm::Function *CoroSave = CGF.CGM.getIntrinsic(llvm::Intrinsic::coro_save);
198
291
  auto *NullPtr = llvm::ConstantPointerNull::get(CGF.CGM.Int8PtrTy);
199
291
  auto *SaveCall = Builder.CreateCall(CoroSave, {NullPtr});
200
201
291
  auto *SuspendRet = CGF.EmitScalarExpr(S.getSuspendExpr());
202
291
  if (SuspendRet != nullptr && 
SuspendRet->getType()->isIntegerTy(1)20
) {
203
    // Veto suspension if requested by bool returning await_suspend.
204
3
    BasicBlock *RealSuspendBlock =
205
3
        CGF.createBasicBlock(Prefix + Twine(".suspend.bool"));
206
3
    CGF.Builder.CreateCondBr(SuspendRet, RealSuspendBlock, ReadyBlock);
207
3
    CGF.EmitBlock(RealSuspendBlock);
208
3
  }
209
210
  // Emit the suspend point.
211
291
  const bool IsFinalSuspend = (Kind == AwaitKind::Final);
212
291
  llvm::Function *CoroSuspend =
213
291
      CGF.CGM.getIntrinsic(llvm::Intrinsic::coro_suspend);
214
291
  auto *SuspendResult = Builder.CreateCall(
215
291
      CoroSuspend, {SaveCall, Builder.getInt1(IsFinalSuspend)});
216
217
  // Create a switch capturing three possible continuations.
218
291
  auto *Switch = Builder.CreateSwitch(SuspendResult, Coro.SuspendBB, 2);
219
291
  Switch->addCase(Builder.getInt8(0), ReadyBlock);
220
291
  Switch->addCase(Builder.getInt8(1), CleanupBlock);
221
222
  // Emit cleanup for this suspend point.
223
291
  CGF.EmitBlock(CleanupBlock);
224
291
  CGF.EmitBranchThroughCleanup(Coro.CleanupJD);
225
226
  // Emit await_resume expression.
227
291
  CGF.EmitBlock(ReadyBlock);
228
229
  // Exception handling requires additional IR. If the 'await_resume' function
230
  // is marked as 'noexcept', we avoid generating this additional IR.
231
291
  CXXTryStmt *TryStmt = nullptr;
232
291
  if (Coro.ExceptionHandler && 
Kind == AwaitKind::Init46
&&
233
291
      
memberCallExpressionCanThrow(S.getResumeExpr())22
) {
234
3
    Coro.ResumeEHVar =
235
3
        CGF.CreateTempAlloca(Builder.getInt1Ty(), Prefix + Twine("resume.eh"));
236
3
    Builder.CreateFlagStore(true, Coro.ResumeEHVar);
237
238
3
    auto Loc = S.getResumeExpr()->getExprLoc();
239
3
    auto *Catch = new (CGF.getContext())
240
3
        CXXCatchStmt(Loc, /*exDecl=*/nullptr, Coro.ExceptionHandler);
241
3
    auto *TryBody =
242
3
        CompoundStmt::Create(CGF.getContext(), S.getResumeExpr(), Loc, Loc);
243
3
    TryStmt = CXXTryStmt::Create(CGF.getContext(), Loc, TryBody, Catch);
244
3
    CGF.EnterCXXTryStmt(*TryStmt);
245
3
  }
246
247
291
  LValueOrRValue Res;
248
291
  if (forLValue)
249
6
    Res.LV = CGF.EmitLValue(S.getResumeExpr());
250
285
  else
251
285
    Res.RV = CGF.EmitAnyExpr(S.getResumeExpr(), aggSlot, ignoreResult);
252
253
291
  if (TryStmt) {
254
3
    Builder.CreateFlagStore(false, Coro.ResumeEHVar);
255
3
    CGF.ExitCXXTryStmt(*TryStmt);
256
3
  }
257
258
291
  return Res;
259
291
}
260
261
RValue CodeGenFunction::EmitCoawaitExpr(const CoawaitExpr &E,
262
                                        AggValueSlot aggSlot,
263
283
                                        bool ignoreResult) {
264
283
  return emitSuspendExpression(*this, *CurCoro.Data, E,
265
283
                               CurCoro.Data->CurrentAwaitKind, aggSlot,
266
283
                               ignoreResult, /*forLValue*/false).RV;
267
283
}
268
RValue CodeGenFunction::EmitCoyieldExpr(const CoyieldExpr &E,
269
                                        AggValueSlot aggSlot,
270
2
                                        bool ignoreResult) {
271
2
  return emitSuspendExpression(*this, *CurCoro.Data, E, AwaitKind::Yield,
272
2
                               aggSlot, ignoreResult, /*forLValue*/false).RV;
273
2
}
274
275
117
void CodeGenFunction::EmitCoreturnStmt(CoreturnStmt const &S) {
276
117
  ++CurCoro.Data->CoreturnCount;
277
117
  const Expr *RV = S.getOperand();
278
117
  if (RV && 
RV->getType()->isVoidType()13
&&
!isa<InitListExpr>(RV)4
) {
279
    // Make sure to evaluate the non initlist expression of a co_return
280
    // with a void expression for side effects.
281
2
    RunCleanupsScope cleanupScope(*this);
282
2
    EmitIgnoredExpr(RV);
283
2
  }
284
117
  EmitStmt(S.getPromiseCall());
285
117
  EmitBranchThroughCleanup(CurCoro.Data->FinalJD);
286
117
}
287
288
289
#ifndef NDEBUG
290
static QualType getCoroutineSuspendExprReturnType(const ASTContext &Ctx,
291
6
  const CoroutineSuspendExpr *E) {
292
6
  const auto *RE = E->getResumeExpr();
293
  // Is it possible for RE to be a CXXBindTemporaryExpr wrapping
294
  // a MemberCallExpr?
295
6
  assert(isa<CallExpr>(RE) && "unexpected suspend expression type");
296
0
  return cast<CallExpr>(RE)->getCallReturnType(Ctx);
297
6
}
298
#endif
299
300
LValue
301
4
CodeGenFunction::EmitCoawaitLValue(const CoawaitExpr *E) {
302
4
  assert(getCoroutineSuspendExprReturnType(getContext(), E)->isReferenceType() &&
303
4
         "Can't have a scalar return unless the return type is a "
304
4
         "reference type!");
305
0
  return emitSuspendExpression(*this, *CurCoro.Data, *E,
306
4
                               CurCoro.Data->CurrentAwaitKind, AggValueSlot::ignored(),
307
4
                               /*ignoreResult*/false, /*forLValue*/true).LV;
308
4
}
309
310
LValue
311
2
CodeGenFunction::EmitCoyieldLValue(const CoyieldExpr *E) {
312
2
  assert(getCoroutineSuspendExprReturnType(getContext(), E)->isReferenceType() &&
313
2
         "Can't have a scalar return unless the return type is a "
314
2
         "reference type!");
315
0
  return emitSuspendExpression(*this, *CurCoro.Data, *E,
316
2
                               AwaitKind::Yield, AggValueSlot::ignored(),
317
2
                               /*ignoreResult*/false, /*forLValue*/true).LV;
318
2
}
319
320
// Hunts for the parameter reference in the parameter copy/move declaration.
321
namespace {
322
struct GetParamRef : public StmtVisitor<GetParamRef> {
323
public:
324
  DeclRefExpr *Expr = nullptr;
325
63
  GetParamRef() {}
326
63
  void VisitDeclRefExpr(DeclRefExpr *E) {
327
63
    assert(Expr == nullptr && "multilple declref in param move");
328
0
    Expr = E;
329
63
  }
330
95
  void VisitStmt(Stmt *S) {
331
95
    for (auto *C : S->children()) {
332
95
      if (C)
333
95
        Visit(C);
334
95
    }
335
95
  }
336
};
337
}
338
339
// This class replaces references to parameters to their copies by changing
340
// the addresses in CGF.LocalDeclMap and restoring back the original values in
341
// its destructor.
342
343
namespace {
344
  struct ParamReferenceReplacerRAII {
345
    CodeGenFunction::DeclMapTy SavedLocals;
346
    CodeGenFunction::DeclMapTy& LocalDeclMap;
347
348
    ParamReferenceReplacerRAII(CodeGenFunction::DeclMapTy &LocalDeclMap)
349
120
        : LocalDeclMap(LocalDeclMap) {}
350
351
63
    void addCopy(DeclStmt const *PM) {
352
      // Figure out what param it refers to.
353
354
63
      assert(PM->isSingleDecl());
355
0
      VarDecl const*VD = static_cast<VarDecl const*>(PM->getSingleDecl());
356
63
      Expr const *InitExpr = VD->getInit();
357
63
      GetParamRef Visitor;
358
63
      Visitor.Visit(const_cast<Expr*>(InitExpr));
359
63
      assert(Visitor.Expr);
360
0
      DeclRefExpr *DREOrig = Visitor.Expr;
361
63
      auto *PD = DREOrig->getDecl();
362
363
63
      auto it = LocalDeclMap.find(PD);
364
63
      assert(it != LocalDeclMap.end() && "parameter is not found");
365
0
      SavedLocals.insert({ PD, it->second });
366
367
63
      auto copyIt = LocalDeclMap.find(VD);
368
63
      assert(copyIt != LocalDeclMap.end() && "parameter copy is not found");
369
0
      it->second = copyIt->getSecond();
370
63
    }
371
372
120
    ~ParamReferenceReplacerRAII() {
373
120
      for (auto&& SavedLocal : SavedLocals) {
374
63
        LocalDeclMap.insert({SavedLocal.first, SavedLocal.second});
375
63
      }
376
120
    }
377
  };
378
}
379
380
// For WinEH exception representation backend needs to know what funclet coro.end
381
// belongs to. That information is passed in a funclet bundle.
382
static SmallVector<llvm::OperandBundleDef, 1>
383
23
getBundlesForCoroEnd(CodeGenFunction &CGF) {
384
23
  SmallVector<llvm::OperandBundleDef, 1> BundleList;
385
386
23
  if (llvm::Instruction *EHPad = CGF.CurrentFuncletPad)
387
6
    BundleList.emplace_back("funclet", EHPad);
388
389
23
  return BundleList;
390
23
}
391
392
namespace {
393
// We will insert coro.end to cut any of the destructors for objects that
394
// do not need to be destroyed once the coroutine is resumed.
395
// See llvm/docs/Coroutines.rst for more details about coro.end.
396
struct CallCoroEnd final : public EHScopeStack::Cleanup {
397
23
  void Emit(CodeGenFunction &CGF, Flags flags) override {
398
23
    auto &CGM = CGF.CGM;
399
23
    auto *NullPtr = llvm::ConstantPointerNull::get(CGF.Int8PtrTy);
400
23
    llvm::Function *CoroEndFn = CGM.getIntrinsic(llvm::Intrinsic::coro_end);
401
    // See if we have a funclet bundle to associate coro.end with. (WinEH)
402
23
    auto Bundles = getBundlesForCoroEnd(CGF);
403
23
    auto *CoroEnd = CGF.Builder.CreateCall(
404
23
        CoroEndFn, {NullPtr, CGF.Builder.getTrue()}, Bundles);
405
23
    if (Bundles.empty()) {
406
      // Otherwise, (landingpad model), create a conditional branch that leads
407
      // either to a cleanup block or a block with EH resume instruction.
408
17
      auto *ResumeBB = CGF.getEHResumeBlock(/*isCleanup=*/true);
409
17
      auto *CleanupContBB = CGF.createBasicBlock("cleanup.cont");
410
17
      CGF.Builder.CreateCondBr(CoroEnd, ResumeBB, CleanupContBB);
411
17
      CGF.EmitBlock(CleanupContBB);
412
17
    }
413
23
  }
414
};
415
}
416
417
namespace {
418
// Make sure to call coro.delete on scope exit.
419
struct CallCoroDelete final : public EHScopeStack::Cleanup {
420
  Stmt *Deallocate;
421
422
  // Emit "if (coro.free(CoroId, CoroBegin)) Deallocate;"
423
424
  // Note: That deallocation will be emitted twice: once for a normal exit and
425
  // once for exceptional exit. This usage is safe because Deallocate does not
426
  // contain any declarations. The SubStmtBuilder::makeNewAndDeleteExpr()
427
  // builds a single call to a deallocation function which is safe to emit
428
  // multiple times.
429
149
  void Emit(CodeGenFunction &CGF, Flags) override {
430
    // Remember the current point, as we are going to emit deallocation code
431
    // first to get to coro.free instruction that is an argument to a delete
432
    // call.
433
149
    BasicBlock *SaveInsertBlock = CGF.Builder.GetInsertBlock();
434
435
149
    auto *FreeBB = CGF.createBasicBlock("coro.free");
436
149
    CGF.EmitBlock(FreeBB);
437
149
    CGF.EmitStmt(Deallocate);
438
439
149
    auto *AfterFreeBB = CGF.createBasicBlock("after.coro.free");
440
149
    CGF.EmitBlock(AfterFreeBB);
441
442
    // We should have captured coro.free from the emission of deallocate.
443
149
    auto *CoroFree = CGF.CurCoro.Data->LastCoroFree;
444
149
    if (!CoroFree) {
445
0
      CGF.CGM.Error(Deallocate->getBeginLoc(),
446
0
                    "Deallocation expressoin does not refer to coro.free");
447
0
      return;
448
0
    }
449
450
    // Get back to the block we were originally and move coro.free there.
451
149
    auto *InsertPt = SaveInsertBlock->getTerminator();
452
149
    CoroFree->moveBefore(InsertPt);
453
149
    CGF.Builder.SetInsertPoint(InsertPt);
454
455
    // Add if (auto *mem = coro.free) Deallocate;
456
149
    auto *NullPtr = llvm::ConstantPointerNull::get(CGF.Int8PtrTy);
457
149
    auto *Cond = CGF.Builder.CreateICmpNE(CoroFree, NullPtr);
458
149
    CGF.Builder.CreateCondBr(Cond, FreeBB, AfterFreeBB);
459
460
    // No longer need old terminator.
461
149
    InsertPt->eraseFromParent();
462
149
    CGF.Builder.SetInsertPoint(AfterFreeBB);
463
149
  }
464
120
  explicit CallCoroDelete(Stmt *DeallocStmt) : Deallocate(DeallocStmt) {}
465
};
466
}
467
468
namespace {
469
struct GetReturnObjectManager {
470
  CodeGenFunction &CGF;
471
  CGBuilderTy &Builder;
472
  const CoroutineBodyStmt &S;
473
474
  Address GroActiveFlag;
475
  CodeGenFunction::AutoVarEmission GroEmission;
476
477
  GetReturnObjectManager(CodeGenFunction &CGF, const CoroutineBodyStmt &S)
478
      : CGF(CGF), Builder(CGF.Builder), S(S), GroActiveFlag(Address::invalid()),
479
120
        GroEmission(CodeGenFunction::AutoVarEmission::invalid()) {}
480
481
  // The gro variable has to outlive coroutine frame and coroutine promise, but,
482
  // it can only be initialized after coroutine promise was created, thus, we
483
  // split its emission in two parts. EmitGroAlloca emits an alloca and sets up
484
  // cleanups. Later when coroutine promise is available we initialize the gro
485
  // and sets the flag that the cleanup is now active.
486
487
120
  void EmitGroAlloca() {
488
120
    auto *GroDeclStmt = dyn_cast<DeclStmt>(S.getResultDecl());
489
120
    if (!GroDeclStmt) {
490
      // If get_return_object returns void, no need to do an alloca.
491
66
      return;
492
66
    }
493
494
54
    auto *GroVarDecl = cast<VarDecl>(GroDeclStmt->getSingleDecl());
495
496
    // Set GRO flag that it is not initialized yet
497
54
    GroActiveFlag =
498
54
      CGF.CreateTempAlloca(Builder.getInt1Ty(), CharUnits::One(), "gro.active");
499
54
    Builder.CreateStore(Builder.getFalse(), GroActiveFlag);
500
501
54
    GroEmission = CGF.EmitAutoVarAlloca(*GroVarDecl);
502
503
    // Remember the top of EHStack before emitting the cleanup.
504
54
    auto old_top = CGF.EHStack.stable_begin();
505
54
    CGF.EmitAutoVarCleanups(GroEmission);
506
54
    auto top = CGF.EHStack.stable_begin();
507
508
    // Make the cleanup conditional on gro.active
509
54
    for (auto b = CGF.EHStack.find(top), e = CGF.EHStack.find(old_top);
510
69
      b != e; 
b++15
) {
511
15
      if (auto *Cleanup = dyn_cast<EHCleanupScope>(&*b)) {
512
15
        assert(!Cleanup->hasActiveFlag() && "cleanup already has active flag?");
513
0
        Cleanup->setActiveFlag(GroActiveFlag);
514
15
        Cleanup->setTestFlagInEHCleanup();
515
15
        Cleanup->setTestFlagInNormalCleanup();
516
15
      }
517
15
    }
518
54
  }
519
520
120
  void EmitGroInit() {
521
120
    if (!GroActiveFlag.isValid()) {
522
      // No Gro variable was allocated. Simply emit the call to
523
      // get_return_object.
524
66
      CGF.EmitStmt(S.getResultDecl());
525
66
      return;
526
66
    }
527
528
54
    CGF.EmitAutoVarInit(GroEmission);
529
54
    Builder.CreateStore(Builder.getTrue(), GroActiveFlag);
530
54
  }
531
};
532
}
533
534
static void emitBodyAndFallthrough(CodeGenFunction &CGF,
535
120
                                   const CoroutineBodyStmt &S, Stmt *Body) {
536
120
  CGF.EmitStmt(Body);
537
120
  const bool CanFallthrough = CGF.Builder.GetInsertBlock();
538
120
  if (CanFallthrough)
539
28
    if (Stmt *OnFallthrough = S.getFallthroughHandler())
540
28
      CGF.EmitStmt(OnFallthrough);
541
120
}
542
543
120
void CodeGenFunction::EmitCoroutineBody(const CoroutineBodyStmt &S) {
544
120
  auto *NullPtr = llvm::ConstantPointerNull::get(Builder.getInt8PtrTy());
545
120
  auto &TI = CGM.getContext().getTargetInfo();
546
120
  unsigned NewAlign = TI.getNewAlign() / TI.getCharWidth();
547
548
120
  auto *EntryBB = Builder.GetInsertBlock();
549
120
  auto *AllocBB = createBasicBlock("coro.alloc");
550
120
  auto *InitBB = createBasicBlock("coro.init");
551
120
  auto *FinalBB = createBasicBlock("coro.final");
552
120
  auto *RetBB = createBasicBlock("coro.ret");
553
554
120
  auto *CoroId = Builder.CreateCall(
555
120
      CGM.getIntrinsic(llvm::Intrinsic::coro_id),
556
120
      {Builder.getInt32(NewAlign), NullPtr, NullPtr, NullPtr});
557
120
  createCoroData(*this, CurCoro, CoroId);
558
120
  CurCoro.Data->SuspendBB = RetBB;
559
120
  assert(ShouldEmitLifetimeMarkers &&
560
120
         "Must emit lifetime intrinsics for coroutines");
561
562
  // Backend is allowed to elide memory allocations, to help it, emit
563
  // auto mem = coro.alloc() ? 0 : ... allocation code ...;
564
0
  auto *CoroAlloc = Builder.CreateCall(
565
120
      CGM.getIntrinsic(llvm::Intrinsic::coro_alloc), {CoroId});
566
567
120
  Builder.CreateCondBr(CoroAlloc, AllocBB, InitBB);
568
569
120
  EmitBlock(AllocBB);
570
120
  auto *AllocateCall = EmitScalarExpr(S.getAllocate());
571
120
  auto *AllocOrInvokeContBB = Builder.GetInsertBlock();
572
573
  // Handle allocation failure if 'ReturnStmtOnAllocFailure' was provided.
574
120
  if (auto *RetOnAllocFailure = S.getReturnStmtOnAllocFailure()) {
575
4
    auto *RetOnFailureBB = createBasicBlock("coro.ret.on.failure");
576
577
    // See if allocation was successful.
578
4
    auto *NullPtr = llvm::ConstantPointerNull::get(Int8PtrTy);
579
4
    auto *Cond = Builder.CreateICmpNE(AllocateCall, NullPtr);
580
4
    Builder.CreateCondBr(Cond, InitBB, RetOnFailureBB);
581
582
    // If not, return OnAllocFailure object.
583
4
    EmitBlock(RetOnFailureBB);
584
4
    EmitStmt(RetOnAllocFailure);
585
4
  }
586
116
  else {
587
116
    Builder.CreateBr(InitBB);
588
116
  }
589
590
120
  EmitBlock(InitBB);
591
592
  // Pass the result of the allocation to coro.begin.
593
120
  auto *Phi = Builder.CreatePHI(VoidPtrTy, 2);
594
120
  Phi->addIncoming(NullPtr, EntryBB);
595
120
  Phi->addIncoming(AllocateCall, AllocOrInvokeContBB);
596
120
  auto *CoroBegin = Builder.CreateCall(
597
120
      CGM.getIntrinsic(llvm::Intrinsic::coro_begin), {CoroId, Phi});
598
120
  CurCoro.Data->CoroBegin = CoroBegin;
599
600
  // We need to emit `get_­return_­object` first. According to:
601
  // [dcl.fct.def.coroutine]p7
602
  // The call to get_­return_­object is sequenced before the call to
603
  // initial_­suspend and is invoked at most once.
604
120
  GetReturnObjectManager GroManager(*this, S);
605
120
  GroManager.EmitGroAlloca();
606
607
120
  CurCoro.Data->CleanupJD = getJumpDestInCurrentScope(RetBB);
608
120
  {
609
120
    CGDebugInfo *DI = getDebugInfo();
610
120
    ParamReferenceReplacerRAII ParamReplacer(LocalDeclMap);
611
120
    CodeGenFunction::RunCleanupsScope ResumeScope(*this);
612
120
    EHStack.pushCleanup<CallCoroDelete>(NormalAndEHCleanup, S.getDeallocate());
613
614
    // Create mapping between parameters and copy-params for coroutine function.
615
120
    auto ParamMoves = S.getParamMoves();
616
120
    assert(
617
120
        (ParamMoves.size() == 0 || (ParamMoves.size() == FnArgs.size())) &&
618
120
        "ParamMoves and FnArgs should be the same size for coroutine function");
619
120
    if (ParamMoves.size() == FnArgs.size() && DI)
620
2
      for (const auto Pair : llvm::zip(FnArgs, ParamMoves))
621
6
        DI->getCoroutineParameterMappings().insert(
622
6
            {std::get<0>(Pair), std::get<1>(Pair)});
623
624
    // Create parameter copies. We do it before creating a promise, since an
625
    // evolution of coroutine TS may allow promise constructor to observe
626
    // parameter copies.
627
120
    for (auto *PM : S.getParamMoves()) {
628
63
      EmitStmt(PM);
629
63
      ParamReplacer.addCopy(cast<DeclStmt>(PM));
630
      // TODO: if(CoroParam(...)) need to surround ctor and dtor
631
      // for the copy, so that llvm can elide it if the copy is
632
      // not needed.
633
63
    }
634
635
120
    EmitStmt(S.getPromiseDeclStmt());
636
637
120
    Address PromiseAddr = GetAddrOfLocalVar(S.getPromiseDecl());
638
120
    auto *PromiseAddrVoidPtr =
639
120
        new llvm::BitCastInst(PromiseAddr.getPointer(), VoidPtrTy, "", CoroId);
640
    // Update CoroId to refer to the promise. We could not do it earlier because
641
    // promise local variable was not emitted yet.
642
120
    CoroId->setArgOperand(1, PromiseAddrVoidPtr);
643
644
    // Now we have the promise, initialize the GRO
645
120
    GroManager.EmitGroInit();
646
647
120
    EHStack.pushCleanup<CallCoroEnd>(EHCleanup);
648
649
120
    CurCoro.Data->CurrentAwaitKind = AwaitKind::Init;
650
120
    CurCoro.Data->ExceptionHandler = S.getExceptionHandler();
651
120
    EmitStmt(S.getInitSuspendStmt());
652
120
    CurCoro.Data->FinalJD = getJumpDestInCurrentScope(FinalBB);
653
654
120
    CurCoro.Data->CurrentAwaitKind = AwaitKind::Normal;
655
656
120
    if (CurCoro.Data->ExceptionHandler) {
657
      // If we generated IR to record whether an exception was thrown from
658
      // 'await_resume', then use that IR to determine whether the coroutine
659
      // body should be skipped.
660
      // If we didn't generate the IR (perhaps because 'await_resume' was marked
661
      // as 'noexcept'), then we skip this check.
662
22
      BasicBlock *ContBB = nullptr;
663
22
      if (CurCoro.Data->ResumeEHVar) {
664
3
        BasicBlock *BodyBB = createBasicBlock("coro.resumed.body");
665
3
        ContBB = createBasicBlock("coro.resumed.cont");
666
3
        Value *SkipBody = Builder.CreateFlagLoad(CurCoro.Data->ResumeEHVar,
667
3
                                                 "coro.resumed.eh");
668
3
        Builder.CreateCondBr(SkipBody, ContBB, BodyBB);
669
3
        EmitBlock(BodyBB);
670
3
      }
671
672
22
      auto Loc = S.getBeginLoc();
673
22
      CXXCatchStmt Catch(Loc, /*exDecl=*/nullptr,
674
22
                         CurCoro.Data->ExceptionHandler);
675
22
      auto *TryStmt =
676
22
          CXXTryStmt::Create(getContext(), Loc, S.getBody(), &Catch);
677
678
22
      EnterCXXTryStmt(*TryStmt);
679
22
      emitBodyAndFallthrough(*this, S, TryStmt->getTryBlock());
680
22
      ExitCXXTryStmt(*TryStmt);
681
682
22
      if (ContBB)
683
3
        EmitBlock(ContBB);
684
22
    }
685
98
    else {
686
98
      emitBodyAndFallthrough(*this, S, S.getBody());
687
98
    }
688
689
    // See if we need to generate final suspend.
690
120
    const bool CanFallthrough = Builder.GetInsertBlock();
691
120
    const bool HasCoreturns = CurCoro.Data->CoreturnCount > 0;
692
120
    if (CanFallthrough || 
HasCoreturns101
) {
693
116
      EmitBlock(FinalBB);
694
116
      CurCoro.Data->CurrentAwaitKind = AwaitKind::Final;
695
116
      EmitStmt(S.getFinalSuspendStmt());
696
116
    } else {
697
      // We don't need FinalBB. Emit it to make sure the block is deleted.
698
4
      EmitBlock(FinalBB, /*IsFinished=*/true);
699
4
    }
700
120
  }
701
702
0
  EmitBlock(RetBB);
703
  // Emit coro.end before getReturnStmt (and parameter destructors), since
704
  // resume and destroy parts of the coroutine should not include them.
705
120
  llvm::Function *CoroEnd = CGM.getIntrinsic(llvm::Intrinsic::coro_end);
706
120
  Builder.CreateCall(CoroEnd, {NullPtr, Builder.getFalse()});
707
708
120
  if (Stmt *Ret = S.getReturnStmt())
709
54
    EmitStmt(Ret);
710
711
  // LLVM require the frontend to add the function attribute. See
712
  // Coroutines.rst.
713
120
  CurFn->addFnAttr("coroutine.presplit", "0");
714
120
}
715
716
// Emit coroutine intrinsic and patch up arguments of the token type.
717
RValue CodeGenFunction::EmitCoroutineIntrinsic(const CallExpr *E,
718
647
                                               unsigned int IID) {
719
647
  SmallVector<llvm::Value *, 8> Args;
720
647
  switch (IID) {
721
45
  default:
722
45
    break;
723
  // The coro.frame builtin is replaced with an SSA value of the coro.begin
724
  // intrinsic.
725
446
  case llvm::Intrinsic::coro_frame: {
726
446
    if (CurCoro.Data && CurCoro.Data->CoroBegin) {
727
446
      return RValue::get(CurCoro.Data->CoroBegin);
728
446
    }
729
0
    CGM.Error(E->getBeginLoc(), "this builtin expect that __builtin_coro_begin "
730
0
                                "has been used earlier in this function");
731
0
    auto NullPtr = llvm::ConstantPointerNull::get(Builder.getInt8PtrTy());
732
0
    return RValue::get(NullPtr);
733
446
  }
734
  // The following three intrinsics take a token parameter referring to a token
735
  // returned by earlier call to @llvm.coro.id. Since we cannot represent it in
736
  // builtins, we patch it up here.
737
2
  case llvm::Intrinsic::coro_alloc:
738
4
  case llvm::Intrinsic::coro_begin:
739
155
  case llvm::Intrinsic::coro_free: {
740
155
    if (CurCoro.Data && 
CurCoro.Data->CoroId152
) {
741
152
      Args.push_back(CurCoro.Data->CoroId);
742
152
      break;
743
152
    }
744
3
    CGM.Error(E->getBeginLoc(), "this builtin expect that __builtin_coro_id has"
745
3
                                " been used earlier in this function");
746
    // Fallthrough to the next case to add TokenNone as the first argument.
747
3
    LLVM_FALLTHROUGH;
748
3
  }
749
  // @llvm.coro.suspend takes a token parameter. Add token 'none' as the first
750
  // argument.
751
4
  case llvm::Intrinsic::coro_suspend:
752
4
    Args.push_back(llvm::ConstantTokenNone::get(getLLVMContext()));
753
4
    break;
754
647
  }
755
201
  for (const Expr *Arg : E->arguments())
756
229
    Args.push_back(EmitScalarExpr(Arg));
757
758
201
  llvm::Function *F = CGM.getIntrinsic(IID);
759
201
  llvm::CallInst *Call = Builder.CreateCall(F, Args);
760
761
  // Note: The following code is to enable to emit coro.id and coro.begin by
762
  // hand to experiment with coroutines in C.
763
  // If we see @llvm.coro.id remember it in the CoroData. We will update
764
  // coro.alloc, coro.begin and coro.free intrinsics to refer to it.
765
201
  if (IID == llvm::Intrinsic::coro_id) {
766
3
    createCoroData(*this, CurCoro, Call, E);
767
3
  }
768
198
  else if (IID == llvm::Intrinsic::coro_begin) {
769
2
    if (CurCoro.Data)
770
1
      CurCoro.Data->CoroBegin = Call;
771
2
  }
772
196
  else if (IID == llvm::Intrinsic::coro_free) {
773
    // Remember the last coro_free as we need it to build the conditional
774
    // deletion of the coroutine frame.
775
151
    if (CurCoro.Data)
776
150
      CurCoro.Data->LastCoroFree = Call;
777
151
  }
778
201
  return RValue::get(Call);
779
647
}