1 //===--- SemaCoroutines.cpp - Semantic Analysis for Coroutines ------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 //  This file implements semantic analysis for C++ Coroutines.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "CoroutineStmtBuilder.h"
15 #include "clang/AST/Decl.h"
16 #include "clang/AST/ExprCXX.h"
17 #include "clang/AST/StmtCXX.h"
18 #include "clang/Lex/Preprocessor.h"
19 #include "clang/Sema/Initialization.h"
20 #include "clang/Sema/Overload.h"
21 #include "clang/Sema/SemaInternal.h"
22 
23 using namespace clang;
24 using namespace sema;
25 
26 static LookupResult lookupMember(Sema &S, const char *Name, CXXRecordDecl *RD,
27                                  SourceLocation Loc, bool &Res) {
28   DeclarationName DN = S.PP.getIdentifierInfo(Name);
29   LookupResult LR(S, DN, Loc, Sema::LookupMemberName);
30   // Suppress diagnostics when a private member is selected. The same warnings
31   // will be produced again when building the call.
32   LR.suppressDiagnostics();
33   Res = S.LookupQualifiedName(LR, RD);
34   return LR;
35 }
36 
37 static bool lookupMember(Sema &S, const char *Name, CXXRecordDecl *RD,
38                          SourceLocation Loc) {
39   bool Res;
40   lookupMember(S, Name, RD, Loc, Res);
41   return Res;
42 }
43 
44 /// Look up the std::coroutine_traits<...>::promise_type for the given
45 /// function type.
46 static QualType lookupPromiseType(Sema &S, const FunctionProtoType *FnType,
47                                   SourceLocation KwLoc,
48                                   SourceLocation FuncLoc) {
49   // FIXME: Cache std::coroutine_traits once we've found it.
50   NamespaceDecl *StdExp = S.lookupStdExperimentalNamespace();
51   if (!StdExp) {
52     S.Diag(KwLoc, diag::err_implied_coroutine_type_not_found)
53         << "std::experimental::coroutine_traits";
54     return QualType();
55   }
56 
57   LookupResult Result(S, &S.PP.getIdentifierTable().get("coroutine_traits"),
58                       FuncLoc, Sema::LookupOrdinaryName);
59   if (!S.LookupQualifiedName(Result, StdExp)) {
60     S.Diag(KwLoc, diag::err_implied_coroutine_type_not_found)
61         << "std::experimental::coroutine_traits";
62     return QualType();
63   }
64 
65   ClassTemplateDecl *CoroTraits = Result.getAsSingle<ClassTemplateDecl>();
66   if (!CoroTraits) {
67     Result.suppressDiagnostics();
68     // We found something weird. Complain about the first thing we found.
69     NamedDecl *Found = *Result.begin();
70     S.Diag(Found->getLocation(), diag::err_malformed_std_coroutine_traits);
71     return QualType();
72   }
73 
74   // Form template argument list for coroutine_traits<R, P1, P2, ...>.
75   TemplateArgumentListInfo Args(KwLoc, KwLoc);
76   Args.addArgument(TemplateArgumentLoc(
77       TemplateArgument(FnType->getReturnType()),
78       S.Context.getTrivialTypeSourceInfo(FnType->getReturnType(), KwLoc)));
79   // FIXME: If the function is a non-static member function, add the type
80   // of the implicit object parameter before the formal parameters.
81   for (QualType T : FnType->getParamTypes())
82     Args.addArgument(TemplateArgumentLoc(
83         TemplateArgument(T), S.Context.getTrivialTypeSourceInfo(T, KwLoc)));
84 
85   // Build the template-id.
86   QualType CoroTrait =
87       S.CheckTemplateIdType(TemplateName(CoroTraits), KwLoc, Args);
88   if (CoroTrait.isNull())
89     return QualType();
90   if (S.RequireCompleteType(KwLoc, CoroTrait,
91                             diag::err_coroutine_type_missing_specialization))
92     return QualType();
93 
94   auto *RD = CoroTrait->getAsCXXRecordDecl();
95   assert(RD && "specialization of class template is not a class?");
96 
97   // Look up the ::promise_type member.
98   LookupResult R(S, &S.PP.getIdentifierTable().get("promise_type"), KwLoc,
99                  Sema::LookupOrdinaryName);
100   S.LookupQualifiedName(R, RD);
101   auto *Promise = R.getAsSingle<TypeDecl>();
102   if (!Promise) {
103     S.Diag(FuncLoc,
104            diag::err_implied_std_coroutine_traits_promise_type_not_found)
105         << RD;
106     return QualType();
107   }
108   // The promise type is required to be a class type.
109   QualType PromiseType = S.Context.getTypeDeclType(Promise);
110 
111   auto buildElaboratedType = [&]() {
112     auto *NNS = NestedNameSpecifier::Create(S.Context, nullptr, StdExp);
113     NNS = NestedNameSpecifier::Create(S.Context, NNS, false,
114                                       CoroTrait.getTypePtr());
115     return S.Context.getElaboratedType(ETK_None, NNS, PromiseType);
116   };
117 
118   if (!PromiseType->getAsCXXRecordDecl()) {
119     S.Diag(FuncLoc,
120            diag::err_implied_std_coroutine_traits_promise_type_not_class)
121         << buildElaboratedType();
122     return QualType();
123   }
124   if (S.RequireCompleteType(FuncLoc, buildElaboratedType(),
125                             diag::err_coroutine_promise_type_incomplete))
126     return QualType();
127 
128   return PromiseType;
129 }
130 
131 /// Look up the std::experimental::coroutine_handle<PromiseType>.
132 static QualType lookupCoroutineHandleType(Sema &S, QualType PromiseType,
133                                           SourceLocation Loc) {
134   if (PromiseType.isNull())
135     return QualType();
136 
137   NamespaceDecl *StdExp = S.lookupStdExperimentalNamespace();
138   assert(StdExp && "Should already be diagnosed");
139 
140   LookupResult Result(S, &S.PP.getIdentifierTable().get("coroutine_handle"),
141                       Loc, Sema::LookupOrdinaryName);
142   if (!S.LookupQualifiedName(Result, StdExp)) {
143     S.Diag(Loc, diag::err_implied_coroutine_type_not_found)
144         << "std::experimental::coroutine_handle";
145     return QualType();
146   }
147 
148   ClassTemplateDecl *CoroHandle = Result.getAsSingle<ClassTemplateDecl>();
149   if (!CoroHandle) {
150     Result.suppressDiagnostics();
151     // We found something weird. Complain about the first thing we found.
152     NamedDecl *Found = *Result.begin();
153     S.Diag(Found->getLocation(), diag::err_malformed_std_coroutine_handle);
154     return QualType();
155   }
156 
157   // Form template argument list for coroutine_handle<Promise>.
158   TemplateArgumentListInfo Args(Loc, Loc);
159   Args.addArgument(TemplateArgumentLoc(
160       TemplateArgument(PromiseType),
161       S.Context.getTrivialTypeSourceInfo(PromiseType, Loc)));
162 
163   // Build the template-id.
164   QualType CoroHandleType =
165       S.CheckTemplateIdType(TemplateName(CoroHandle), Loc, Args);
166   if (CoroHandleType.isNull())
167     return QualType();
168   if (S.RequireCompleteType(Loc, CoroHandleType,
169                             diag::err_coroutine_type_missing_specialization))
170     return QualType();
171 
172   return CoroHandleType;
173 }
174 
175 static bool isValidCoroutineContext(Sema &S, SourceLocation Loc,
176                                     StringRef Keyword) {
177   // 'co_await' and 'co_yield' are not permitted in unevaluated operands.
178   if (S.isUnevaluatedContext()) {
179     S.Diag(Loc, diag::err_coroutine_unevaluated_context) << Keyword;
180     return false;
181   }
182 
183   // Any other usage must be within a function.
184   auto *FD = dyn_cast<FunctionDecl>(S.CurContext);
185   if (!FD) {
186     S.Diag(Loc, isa<ObjCMethodDecl>(S.CurContext)
187                     ? diag::err_coroutine_objc_method
188                     : diag::err_coroutine_outside_function) << Keyword;
189     return false;
190   }
191 
192   // An enumeration for mapping the diagnostic type to the correct diagnostic
193   // selection index.
194   enum InvalidFuncDiag {
195     DiagCtor = 0,
196     DiagDtor,
197     DiagCopyAssign,
198     DiagMoveAssign,
199     DiagMain,
200     DiagConstexpr,
201     DiagAutoRet,
202     DiagVarargs,
203   };
204   bool Diagnosed = false;
205   auto DiagInvalid = [&](InvalidFuncDiag ID) {
206     S.Diag(Loc, diag::err_coroutine_invalid_func_context) << ID << Keyword;
207     Diagnosed = true;
208     return false;
209   };
210 
211   // Diagnose when a constructor, destructor, copy/move assignment operator,
212   // or the function 'main' are declared as a coroutine.
213   auto *MD = dyn_cast<CXXMethodDecl>(FD);
214   if (MD && isa<CXXConstructorDecl>(MD))
215     return DiagInvalid(DiagCtor);
216   else if (MD && isa<CXXDestructorDecl>(MD))
217     return DiagInvalid(DiagDtor);
218   else if (MD && MD->isCopyAssignmentOperator())
219     return DiagInvalid(DiagCopyAssign);
220   else if (MD && MD->isMoveAssignmentOperator())
221     return DiagInvalid(DiagMoveAssign);
222   else if (FD->isMain())
223     return DiagInvalid(DiagMain);
224 
225   // Emit a diagnostics for each of the following conditions which is not met.
226   if (FD->isConstexpr())
227     DiagInvalid(DiagConstexpr);
228   if (FD->getReturnType()->isUndeducedType())
229     DiagInvalid(DiagAutoRet);
230   if (FD->isVariadic())
231     DiagInvalid(DiagVarargs);
232 
233   return !Diagnosed;
234 }
235 
236 static ExprResult buildOperatorCoawaitLookupExpr(Sema &SemaRef, Scope *S,
237                                                  SourceLocation Loc) {
238   DeclarationName OpName =
239       SemaRef.Context.DeclarationNames.getCXXOperatorName(OO_Coawait);
240   LookupResult Operators(SemaRef, OpName, SourceLocation(),
241                          Sema::LookupOperatorName);
242   SemaRef.LookupName(Operators, S);
243 
244   assert(!Operators.isAmbiguous() && "Operator lookup cannot be ambiguous");
245   const auto &Functions = Operators.asUnresolvedSet();
246   bool IsOverloaded =
247       Functions.size() > 1 ||
248       (Functions.size() == 1 && isa<FunctionTemplateDecl>(*Functions.begin()));
249   Expr *CoawaitOp = UnresolvedLookupExpr::Create(
250       SemaRef.Context, /*NamingClass*/ nullptr, NestedNameSpecifierLoc(),
251       DeclarationNameInfo(OpName, Loc), /*RequiresADL*/ true, IsOverloaded,
252       Functions.begin(), Functions.end());
253   assert(CoawaitOp);
254   return CoawaitOp;
255 }
256 
257 /// Build a call to 'operator co_await' if there is a suitable operator for
258 /// the given expression.
259 static ExprResult buildOperatorCoawaitCall(Sema &SemaRef, SourceLocation Loc,
260                                            Expr *E,
261                                            UnresolvedLookupExpr *Lookup) {
262   UnresolvedSet<16> Functions;
263   Functions.append(Lookup->decls_begin(), Lookup->decls_end());
264   return SemaRef.CreateOverloadedUnaryOp(Loc, UO_Coawait, Functions, E);
265 }
266 
267 static ExprResult buildOperatorCoawaitCall(Sema &SemaRef, Scope *S,
268                                            SourceLocation Loc, Expr *E) {
269   ExprResult R = buildOperatorCoawaitLookupExpr(SemaRef, S, Loc);
270   if (R.isInvalid())
271     return ExprError();
272   return buildOperatorCoawaitCall(SemaRef, Loc, E,
273                                   cast<UnresolvedLookupExpr>(R.get()));
274 }
275 
276 static Expr *buildBuiltinCall(Sema &S, SourceLocation Loc, Builtin::ID Id,
277                               MultiExprArg CallArgs) {
278   StringRef Name = S.Context.BuiltinInfo.getName(Id);
279   LookupResult R(S, &S.Context.Idents.get(Name), Loc, Sema::LookupOrdinaryName);
280   S.LookupName(R, S.TUScope, /*AllowBuiltinCreation=*/true);
281 
282   auto *BuiltInDecl = R.getAsSingle<FunctionDecl>();
283   assert(BuiltInDecl && "failed to find builtin declaration");
284 
285   ExprResult DeclRef =
286       S.BuildDeclRefExpr(BuiltInDecl, BuiltInDecl->getType(), VK_LValue, Loc);
287   assert(DeclRef.isUsable() && "Builtin reference cannot fail");
288 
289   ExprResult Call =
290       S.ActOnCallExpr(/*Scope=*/nullptr, DeclRef.get(), Loc, CallArgs, Loc);
291 
292   assert(!Call.isInvalid() && "Call to builtin cannot fail!");
293   return Call.get();
294 }
295 
296 static ExprResult buildCoroutineHandle(Sema &S, QualType PromiseType,
297                                        SourceLocation Loc) {
298   QualType CoroHandleType = lookupCoroutineHandleType(S, PromiseType, Loc);
299   if (CoroHandleType.isNull())
300     return ExprError();
301 
302   DeclContext *LookupCtx = S.computeDeclContext(CoroHandleType);
303   LookupResult Found(S, &S.PP.getIdentifierTable().get("from_address"), Loc,
304                      Sema::LookupOrdinaryName);
305   if (!S.LookupQualifiedName(Found, LookupCtx)) {
306     S.Diag(Loc, diag::err_coroutine_handle_missing_member)
307         << "from_address";
308     return ExprError();
309   }
310 
311   Expr *FramePtr =
312       buildBuiltinCall(S, Loc, Builtin::BI__builtin_coro_frame, {});
313 
314   CXXScopeSpec SS;
315   ExprResult FromAddr =
316       S.BuildDeclarationNameExpr(SS, Found, /*NeedsADL=*/false);
317   if (FromAddr.isInvalid())
318     return ExprError();
319 
320   return S.ActOnCallExpr(nullptr, FromAddr.get(), Loc, FramePtr, Loc);
321 }
322 
323 struct ReadySuspendResumeResult {
324   enum AwaitCallType { ACT_Ready, ACT_Suspend, ACT_Resume };
325   Expr *Results[3];
326   OpaqueValueExpr *OpaqueValue;
327   bool IsInvalid;
328 };
329 
330 static ExprResult buildMemberCall(Sema &S, Expr *Base, SourceLocation Loc,
331                                   StringRef Name, MultiExprArg Args) {
332   DeclarationNameInfo NameInfo(&S.PP.getIdentifierTable().get(Name), Loc);
333 
334   // FIXME: Fix BuildMemberReferenceExpr to take a const CXXScopeSpec&.
335   CXXScopeSpec SS;
336   ExprResult Result = S.BuildMemberReferenceExpr(
337       Base, Base->getType(), Loc, /*IsPtr=*/false, SS,
338       SourceLocation(), nullptr, NameInfo, /*TemplateArgs=*/nullptr,
339       /*Scope=*/nullptr);
340   if (Result.isInvalid())
341     return ExprError();
342 
343   return S.ActOnCallExpr(nullptr, Result.get(), Loc, Args, Loc, nullptr);
344 }
345 
346 /// Build calls to await_ready, await_suspend, and await_resume for a co_await
347 /// expression.
348 static ReadySuspendResumeResult buildCoawaitCalls(Sema &S, VarDecl *CoroPromise,
349                                                   SourceLocation Loc, Expr *E) {
350   OpaqueValueExpr *Operand = new (S.Context)
351       OpaqueValueExpr(Loc, E->getType(), VK_LValue, E->getObjectKind(), E);
352 
353   // Assume invalid until we see otherwise.
354   ReadySuspendResumeResult Calls = {{}, Operand, /*IsInvalid=*/true};
355 
356   ExprResult CoroHandleRes = buildCoroutineHandle(S, CoroPromise->getType(), Loc);
357   if (CoroHandleRes.isInvalid())
358     return Calls;
359   Expr *CoroHandle = CoroHandleRes.get();
360 
361   const StringRef Funcs[] = {"await_ready", "await_suspend", "await_resume"};
362   MultiExprArg Args[] = {None, CoroHandle, None};
363   for (size_t I = 0, N = llvm::array_lengthof(Funcs); I != N; ++I) {
364     ExprResult Result = buildMemberCall(S, Operand, Loc, Funcs[I], Args[I]);
365     if (Result.isInvalid())
366       return Calls;
367     Calls.Results[I] = Result.get();
368   }
369 
370   // Assume the calls are valid; all further checking should make them invalid.
371   Calls.IsInvalid = false;
372 
373   using ACT = ReadySuspendResumeResult::AwaitCallType;
374   CallExpr *AwaitReady = cast<CallExpr>(Calls.Results[ACT::ACT_Ready]);
375   if (!AwaitReady->getType()->isDependentType()) {
376     // [expr.await]p3 [...]
377     // — await-ready is the expression e.await_ready(), contextually converted
378     // to bool.
379     ExprResult Conv = S.PerformContextuallyConvertToBool(AwaitReady);
380     if (Conv.isInvalid()) {
381       S.Diag(AwaitReady->getDirectCallee()->getLocStart(),
382              diag::note_await_ready_no_bool_conversion);
383       S.Diag(Loc, diag::note_coroutine_promise_call_implicitly_required)
384           << AwaitReady->getDirectCallee() << E->getSourceRange();
385       Calls.IsInvalid = true;
386     }
387     Calls.Results[ACT::ACT_Ready] = Conv.get();
388   }
389   CallExpr *AwaitSuspend = cast<CallExpr>(Calls.Results[ACT::ACT_Suspend]);
390   if (!AwaitSuspend->getType()->isDependentType()) {
391     // [expr.await]p3 [...]
392     //   - await-suspend is the expression e.await_suspend(h), which shall be
393     //     a prvalue of type void or bool.
394     QualType RetType = AwaitSuspend->getCallReturnType(S.Context);
395     // non-class prvalues always have cv-unqualified types
396     QualType AdjRetType = RetType.getUnqualifiedType();
397     if (RetType->isReferenceType() ||
398         (AdjRetType != S.Context.BoolTy && AdjRetType != S.Context.VoidTy)) {
399       S.Diag(AwaitSuspend->getCalleeDecl()->getLocation(),
400              diag::err_await_suspend_invalid_return_type)
401           << RetType;
402       S.Diag(Loc, diag::note_coroutine_promise_call_implicitly_required)
403           << AwaitSuspend->getDirectCallee();
404       Calls.IsInvalid = true;
405     }
406   }
407 
408   return Calls;
409 }
410 
411 static ExprResult buildPromiseCall(Sema &S, VarDecl *Promise,
412                                    SourceLocation Loc, StringRef Name,
413                                    MultiExprArg Args) {
414 
415   // Form a reference to the promise.
416   ExprResult PromiseRef = S.BuildDeclRefExpr(
417       Promise, Promise->getType().getNonReferenceType(), VK_LValue, Loc);
418   if (PromiseRef.isInvalid())
419     return ExprError();
420 
421   return buildMemberCall(S, PromiseRef.get(), Loc, Name, Args);
422 }
423 
424 VarDecl *Sema::buildCoroutinePromise(SourceLocation Loc) {
425   assert(isa<FunctionDecl>(CurContext) && "not in a function scope");
426   auto *FD = cast<FunctionDecl>(CurContext);
427 
428   QualType T =
429       FD->getType()->isDependentType()
430           ? Context.DependentTy
431           : lookupPromiseType(*this, FD->getType()->castAs<FunctionProtoType>(),
432                               Loc, FD->getLocation());
433   if (T.isNull())
434     return nullptr;
435 
436   auto *VD = VarDecl::Create(Context, FD, FD->getLocation(), FD->getLocation(),
437                              &PP.getIdentifierTable().get("__promise"), T,
438                              Context.getTrivialTypeSourceInfo(T, Loc), SC_None);
439   CheckVariableDeclarationType(VD);
440   if (VD->isInvalidDecl())
441     return nullptr;
442   ActOnUninitializedDecl(VD);
443   FD->addDecl(VD);
444   assert(!VD->isInvalidDecl());
445   return VD;
446 }
447 
448 /// Check that this is a context in which a coroutine suspension can appear.
449 static FunctionScopeInfo *checkCoroutineContext(Sema &S, SourceLocation Loc,
450                                                 StringRef Keyword,
451                                                 bool IsImplicit = false) {
452   if (!isValidCoroutineContext(S, Loc, Keyword))
453     return nullptr;
454 
455   assert(isa<FunctionDecl>(S.CurContext) && "not in a function scope");
456 
457   auto *ScopeInfo = S.getCurFunction();
458   assert(ScopeInfo && "missing function scope for function");
459 
460   if (ScopeInfo->FirstCoroutineStmtLoc.isInvalid() && !IsImplicit)
461     ScopeInfo->setFirstCoroutineStmt(Loc, Keyword);
462 
463   if (ScopeInfo->CoroutinePromise)
464     return ScopeInfo;
465 
466   ScopeInfo->CoroutinePromise = S.buildCoroutinePromise(Loc);
467   if (!ScopeInfo->CoroutinePromise)
468     return nullptr;
469 
470   return ScopeInfo;
471 }
472 
473 static bool actOnCoroutineBodyStart(Sema &S, Scope *SC, SourceLocation KWLoc,
474                                     StringRef Keyword) {
475   if (!checkCoroutineContext(S, KWLoc, Keyword))
476     return false;
477   auto *ScopeInfo = S.getCurFunction();
478   assert(ScopeInfo->CoroutinePromise);
479 
480   // If we have existing coroutine statements then we have already built
481   // the initial and final suspend points.
482   if (!ScopeInfo->NeedsCoroutineSuspends)
483     return true;
484 
485   ScopeInfo->setNeedsCoroutineSuspends(false);
486 
487   auto *Fn = cast<FunctionDecl>(S.CurContext);
488   SourceLocation Loc = Fn->getLocation();
489   // Build the initial suspend point
490   auto buildSuspends = [&](StringRef Name) mutable -> StmtResult {
491     ExprResult Suspend =
492         buildPromiseCall(S, ScopeInfo->CoroutinePromise, Loc, Name, None);
493     if (Suspend.isInvalid())
494       return StmtError();
495     Suspend = buildOperatorCoawaitCall(S, SC, Loc, Suspend.get());
496     if (Suspend.isInvalid())
497       return StmtError();
498     Suspend = S.BuildResolvedCoawaitExpr(Loc, Suspend.get(),
499                                          /*IsImplicit*/ true);
500     Suspend = S.ActOnFinishFullExpr(Suspend.get());
501     if (Suspend.isInvalid()) {
502       S.Diag(Loc, diag::note_coroutine_promise_suspend_implicitly_required)
503           << ((Name == "initial_suspend") ? 0 : 1);
504       S.Diag(KWLoc, diag::note_declared_coroutine_here) << Keyword;
505       return StmtError();
506     }
507     return cast<Stmt>(Suspend.get());
508   };
509 
510   StmtResult InitSuspend = buildSuspends("initial_suspend");
511   if (InitSuspend.isInvalid())
512     return true;
513 
514   StmtResult FinalSuspend = buildSuspends("final_suspend");
515   if (FinalSuspend.isInvalid())
516     return true;
517 
518   ScopeInfo->setCoroutineSuspends(InitSuspend.get(), FinalSuspend.get());
519 
520   return true;
521 }
522 
523 ExprResult Sema::ActOnCoawaitExpr(Scope *S, SourceLocation Loc, Expr *E) {
524   if (!actOnCoroutineBodyStart(*this, S, Loc, "co_await")) {
525     CorrectDelayedTyposInExpr(E);
526     return ExprError();
527   }
528 
529   if (E->getType()->isPlaceholderType()) {
530     ExprResult R = CheckPlaceholderExpr(E);
531     if (R.isInvalid()) return ExprError();
532     E = R.get();
533   }
534   ExprResult Lookup = buildOperatorCoawaitLookupExpr(*this, S, Loc);
535   if (Lookup.isInvalid())
536     return ExprError();
537   return BuildUnresolvedCoawaitExpr(Loc, E,
538                                    cast<UnresolvedLookupExpr>(Lookup.get()));
539 }
540 
541 ExprResult Sema::BuildUnresolvedCoawaitExpr(SourceLocation Loc, Expr *E,
542                                             UnresolvedLookupExpr *Lookup) {
543   auto *FSI = checkCoroutineContext(*this, Loc, "co_await");
544   if (!FSI)
545     return ExprError();
546 
547   if (E->getType()->isPlaceholderType()) {
548     ExprResult R = CheckPlaceholderExpr(E);
549     if (R.isInvalid())
550       return ExprError();
551     E = R.get();
552   }
553 
554   auto *Promise = FSI->CoroutinePromise;
555   if (Promise->getType()->isDependentType()) {
556     Expr *Res =
557         new (Context) DependentCoawaitExpr(Loc, Context.DependentTy, E, Lookup);
558     return Res;
559   }
560 
561   auto *RD = Promise->getType()->getAsCXXRecordDecl();
562   if (lookupMember(*this, "await_transform", RD, Loc)) {
563     ExprResult R = buildPromiseCall(*this, Promise, Loc, "await_transform", E);
564     if (R.isInvalid()) {
565       Diag(Loc,
566            diag::note_coroutine_promise_implicit_await_transform_required_here)
567           << E->getSourceRange();
568       return ExprError();
569     }
570     E = R.get();
571   }
572   ExprResult Awaitable = buildOperatorCoawaitCall(*this, Loc, E, Lookup);
573   if (Awaitable.isInvalid())
574     return ExprError();
575 
576   return BuildResolvedCoawaitExpr(Loc, Awaitable.get());
577 }
578 
579 ExprResult Sema::BuildResolvedCoawaitExpr(SourceLocation Loc, Expr *E,
580                                   bool IsImplicit) {
581   auto *Coroutine = checkCoroutineContext(*this, Loc, "co_await", IsImplicit);
582   if (!Coroutine)
583     return ExprError();
584 
585   if (E->getType()->isPlaceholderType()) {
586     ExprResult R = CheckPlaceholderExpr(E);
587     if (R.isInvalid()) return ExprError();
588     E = R.get();
589   }
590 
591   if (E->getType()->isDependentType()) {
592     Expr *Res = new (Context)
593         CoawaitExpr(Loc, Context.DependentTy, E, IsImplicit);
594     return Res;
595   }
596 
597   // If the expression is a temporary, materialize it as an lvalue so that we
598   // can use it multiple times.
599   if (E->getValueKind() == VK_RValue)
600     E = CreateMaterializeTemporaryExpr(E->getType(), E, true);
601 
602   // Build the await_ready, await_suspend, await_resume calls.
603   ReadySuspendResumeResult RSS =
604       buildCoawaitCalls(*this, Coroutine->CoroutinePromise, Loc, E);
605   if (RSS.IsInvalid)
606     return ExprError();
607 
608   Expr *Res =
609       new (Context) CoawaitExpr(Loc, E, RSS.Results[0], RSS.Results[1],
610                                 RSS.Results[2], RSS.OpaqueValue, IsImplicit);
611 
612   return Res;
613 }
614 
615 ExprResult Sema::ActOnCoyieldExpr(Scope *S, SourceLocation Loc, Expr *E) {
616   if (!actOnCoroutineBodyStart(*this, S, Loc, "co_yield")) {
617     CorrectDelayedTyposInExpr(E);
618     return ExprError();
619   }
620 
621   // Build yield_value call.
622   ExprResult Awaitable = buildPromiseCall(
623       *this, getCurFunction()->CoroutinePromise, Loc, "yield_value", E);
624   if (Awaitable.isInvalid())
625     return ExprError();
626 
627   // Build 'operator co_await' call.
628   Awaitable = buildOperatorCoawaitCall(*this, S, Loc, Awaitable.get());
629   if (Awaitable.isInvalid())
630     return ExprError();
631 
632   return BuildCoyieldExpr(Loc, Awaitable.get());
633 }
634 ExprResult Sema::BuildCoyieldExpr(SourceLocation Loc, Expr *E) {
635   auto *Coroutine = checkCoroutineContext(*this, Loc, "co_yield");
636   if (!Coroutine)
637     return ExprError();
638 
639   if (E->getType()->isPlaceholderType()) {
640     ExprResult R = CheckPlaceholderExpr(E);
641     if (R.isInvalid()) return ExprError();
642     E = R.get();
643   }
644 
645   if (E->getType()->isDependentType()) {
646     Expr *Res = new (Context) CoyieldExpr(Loc, Context.DependentTy, E);
647     return Res;
648   }
649 
650   // If the expression is a temporary, materialize it as an lvalue so that we
651   // can use it multiple times.
652   if (E->getValueKind() == VK_RValue)
653     E = CreateMaterializeTemporaryExpr(E->getType(), E, true);
654 
655   // Build the await_ready, await_suspend, await_resume calls.
656   ReadySuspendResumeResult RSS =
657       buildCoawaitCalls(*this, Coroutine->CoroutinePromise, Loc, E);
658   if (RSS.IsInvalid)
659     return ExprError();
660 
661   Expr *Res = new (Context) CoyieldExpr(Loc, E, RSS.Results[0], RSS.Results[1],
662                                         RSS.Results[2], RSS.OpaqueValue);
663 
664   return Res;
665 }
666 
667 StmtResult Sema::ActOnCoreturnStmt(Scope *S, SourceLocation Loc, Expr *E) {
668   if (!actOnCoroutineBodyStart(*this, S, Loc, "co_return")) {
669     CorrectDelayedTyposInExpr(E);
670     return StmtError();
671   }
672   return BuildCoreturnStmt(Loc, E);
673 }
674 
675 StmtResult Sema::BuildCoreturnStmt(SourceLocation Loc, Expr *E,
676                                    bool IsImplicit) {
677   auto *FSI = checkCoroutineContext(*this, Loc, "co_return", IsImplicit);
678   if (!FSI)
679     return StmtError();
680 
681   if (E && E->getType()->isPlaceholderType() &&
682       !E->getType()->isSpecificPlaceholderType(BuiltinType::Overload)) {
683     ExprResult R = CheckPlaceholderExpr(E);
684     if (R.isInvalid()) return StmtError();
685     E = R.get();
686   }
687 
688   // FIXME: If the operand is a reference to a variable that's about to go out
689   // of scope, we should treat the operand as an xvalue for this overload
690   // resolution.
691   VarDecl *Promise = FSI->CoroutinePromise;
692   ExprResult PC;
693   if (E && (isa<InitListExpr>(E) || !E->getType()->isVoidType())) {
694     PC = buildPromiseCall(*this, Promise, Loc, "return_value", E);
695   } else {
696     E = MakeFullDiscardedValueExpr(E).get();
697     PC = buildPromiseCall(*this, Promise, Loc, "return_void", None);
698   }
699   if (PC.isInvalid())
700     return StmtError();
701 
702   Expr *PCE = ActOnFinishFullExpr(PC.get()).get();
703 
704   Stmt *Res = new (Context) CoreturnStmt(Loc, E, PCE, IsImplicit);
705   return Res;
706 }
707 
708 /// Look up the std::nothrow object.
709 static Expr *buildStdNoThrowDeclRef(Sema &S, SourceLocation Loc) {
710   NamespaceDecl *Std = S.getStdNamespace();
711   assert(Std && "Should already be diagnosed");
712 
713   LookupResult Result(S, &S.PP.getIdentifierTable().get("nothrow"), Loc,
714                       Sema::LookupOrdinaryName);
715   if (!S.LookupQualifiedName(Result, Std)) {
716     // FIXME: <experimental/coroutine> should have been included already.
717     // If we require it to include <new> then this diagnostic is no longer
718     // needed.
719     S.Diag(Loc, diag::err_implicit_coroutine_std_nothrow_type_not_found);
720     return nullptr;
721   }
722 
723   // FIXME: Mark the variable as ODR used. This currently does not work
724   // likely due to the scope at in which this function is called.
725   auto *VD = Result.getAsSingle<VarDecl>();
726   if (!VD) {
727     Result.suppressDiagnostics();
728     // We found something weird. Complain about the first thing we found.
729     NamedDecl *Found = *Result.begin();
730     S.Diag(Found->getLocation(), diag::err_malformed_std_nothrow);
731     return nullptr;
732   }
733 
734   ExprResult DR = S.BuildDeclRefExpr(VD, VD->getType(), VK_LValue, Loc);
735   if (DR.isInvalid())
736     return nullptr;
737 
738   return DR.get();
739 }
740 
741 // Find an appropriate delete for the promise.
742 static FunctionDecl *findDeleteForPromise(Sema &S, SourceLocation Loc,
743                                           QualType PromiseType) {
744   FunctionDecl *OperatorDelete = nullptr;
745 
746   DeclarationName DeleteName =
747       S.Context.DeclarationNames.getCXXOperatorName(OO_Delete);
748 
749   auto *PointeeRD = PromiseType->getAsCXXRecordDecl();
750   assert(PointeeRD && "PromiseType must be a CxxRecordDecl type");
751 
752   if (S.FindDeallocationFunction(Loc, PointeeRD, DeleteName, OperatorDelete))
753     return nullptr;
754 
755   if (!OperatorDelete) {
756     // Look for a global declaration.
757     const bool CanProvideSize = S.isCompleteType(Loc, PromiseType);
758     const bool Overaligned = false;
759     OperatorDelete = S.FindUsualDeallocationFunction(Loc, CanProvideSize,
760                                                      Overaligned, DeleteName);
761   }
762   S.MarkFunctionReferenced(Loc, OperatorDelete);
763   return OperatorDelete;
764 }
765 
766 
767 void Sema::CheckCompletedCoroutineBody(FunctionDecl *FD, Stmt *&Body) {
768   FunctionScopeInfo *Fn = getCurFunction();
769   assert(Fn && Fn->isCoroutine() && "not a coroutine");
770   if (!Body) {
771     assert(FD->isInvalidDecl() &&
772            "a null body is only allowed for invalid declarations");
773     return;
774   }
775   // We have a function that uses coroutine keywords, but we failed to build
776   // the promise type.
777   if (!Fn->CoroutinePromise)
778     return FD->setInvalidDecl();
779 
780   if (isa<CoroutineBodyStmt>(Body)) {
781     // Nothing todo. the body is already a transformed coroutine body statement.
782     return;
783   }
784 
785   // Coroutines [stmt.return]p1:
786   //   A return statement shall not appear in a coroutine.
787   if (Fn->FirstReturnLoc.isValid()) {
788     assert(Fn->FirstCoroutineStmtLoc.isValid() &&
789                    "first coroutine location not set");
790     Diag(Fn->FirstReturnLoc, diag::err_return_in_coroutine);
791     Diag(Fn->FirstCoroutineStmtLoc, diag::note_declared_coroutine_here)
792             << Fn->getFirstCoroutineStmtKeyword();
793   }
794   CoroutineStmtBuilder Builder(*this, *FD, *Fn, Body);
795   if (Builder.isInvalid() || !Builder.buildStatements())
796     return FD->setInvalidDecl();
797 
798   // Build body for the coroutine wrapper statement.
799   Body = CoroutineBodyStmt::Create(Context, Builder);
800 }
801 
802 CoroutineStmtBuilder::CoroutineStmtBuilder(Sema &S, FunctionDecl &FD,
803                                            sema::FunctionScopeInfo &Fn,
804                                            Stmt *Body)
805     : S(S), FD(FD), Fn(Fn), Loc(FD.getLocation()),
806       IsPromiseDependentType(
807           !Fn.CoroutinePromise ||
808           Fn.CoroutinePromise->getType()->isDependentType()) {
809   this->Body = Body;
810   if (!IsPromiseDependentType) {
811     PromiseRecordDecl = Fn.CoroutinePromise->getType()->getAsCXXRecordDecl();
812     assert(PromiseRecordDecl && "Type should have already been checked");
813   }
814   this->IsValid = makePromiseStmt() && makeInitialAndFinalSuspend();
815 }
816 
817 bool CoroutineStmtBuilder::buildStatements() {
818   assert(this->IsValid && "coroutine already invalid");
819   this->IsValid = makeReturnObject() && makeParamMoves();
820   if (this->IsValid && !IsPromiseDependentType)
821     buildDependentStatements();
822   return this->IsValid;
823 }
824 
825 bool CoroutineStmtBuilder::buildDependentStatements() {
826   assert(this->IsValid && "coroutine already invalid");
827   assert(!this->IsPromiseDependentType &&
828          "coroutine cannot have a dependent promise type");
829   this->IsValid = makeOnException() && makeOnFallthrough() &&
830                   makeGroDeclAndReturnStmt() && makeReturnOnAllocFailure() &&
831                   makeNewAndDeleteExpr();
832   return this->IsValid;
833 }
834 
835 bool CoroutineStmtBuilder::makePromiseStmt() {
836   // Form a declaration statement for the promise declaration, so that AST
837   // visitors can more easily find it.
838   StmtResult PromiseStmt =
839       S.ActOnDeclStmt(S.ConvertDeclToDeclGroup(Fn.CoroutinePromise), Loc, Loc);
840   if (PromiseStmt.isInvalid())
841     return false;
842 
843   this->Promise = PromiseStmt.get();
844   return true;
845 }
846 
847 bool CoroutineStmtBuilder::makeInitialAndFinalSuspend() {
848   if (Fn.hasInvalidCoroutineSuspends())
849     return false;
850   this->InitialSuspend = cast<Expr>(Fn.CoroutineSuspends.first);
851   this->FinalSuspend = cast<Expr>(Fn.CoroutineSuspends.second);
852   return true;
853 }
854 
855 static bool diagReturnOnAllocFailure(Sema &S, Expr *E,
856                                      CXXRecordDecl *PromiseRecordDecl,
857                                      FunctionScopeInfo &Fn) {
858   auto Loc = E->getExprLoc();
859   if (auto *DeclRef = dyn_cast_or_null<DeclRefExpr>(E)) {
860     auto *Decl = DeclRef->getDecl();
861     if (CXXMethodDecl *Method = dyn_cast_or_null<CXXMethodDecl>(Decl)) {
862       if (Method->isStatic())
863         return true;
864       else
865         Loc = Decl->getLocation();
866     }
867   }
868 
869   S.Diag(
870       Loc,
871       diag::err_coroutine_promise_get_return_object_on_allocation_failure)
872       << PromiseRecordDecl;
873   S.Diag(Fn.FirstCoroutineStmtLoc, diag::note_declared_coroutine_here)
874       << Fn.getFirstCoroutineStmtKeyword();
875   return false;
876 }
877 
878 bool CoroutineStmtBuilder::makeReturnOnAllocFailure() {
879   assert(!IsPromiseDependentType &&
880          "cannot make statement while the promise type is dependent");
881 
882   // [dcl.fct.def.coroutine]/8
883   // The unqualified-id get_return_object_on_allocation_failure is looked up in
884   // the scope of class P by class member access lookup (3.4.5). ...
885   // If an allocation function returns nullptr, ... the coroutine return value
886   // is obtained by a call to ... get_return_object_on_allocation_failure().
887 
888   DeclarationName DN =
889       S.PP.getIdentifierInfo("get_return_object_on_allocation_failure");
890   LookupResult Found(S, DN, Loc, Sema::LookupMemberName);
891   if (!S.LookupQualifiedName(Found, PromiseRecordDecl))
892     return true;
893 
894   CXXScopeSpec SS;
895   ExprResult DeclNameExpr =
896       S.BuildDeclarationNameExpr(SS, Found, /*NeedsADL=*/false);
897   if (DeclNameExpr.isInvalid())
898     return false;
899 
900   if (!diagReturnOnAllocFailure(S, DeclNameExpr.get(), PromiseRecordDecl, Fn))
901     return false;
902 
903   ExprResult ReturnObjectOnAllocationFailure =
904       S.ActOnCallExpr(nullptr, DeclNameExpr.get(), Loc, {}, Loc);
905   if (ReturnObjectOnAllocationFailure.isInvalid())
906     return false;
907 
908   StmtResult ReturnStmt =
909       S.BuildReturnStmt(Loc, ReturnObjectOnAllocationFailure.get());
910   if (ReturnStmt.isInvalid()) {
911     S.Diag(Found.getFoundDecl()->getLocation(), diag::note_member_declared_here)
912         << DN;
913     S.Diag(Fn.FirstCoroutineStmtLoc, diag::note_declared_coroutine_here)
914         << Fn.getFirstCoroutineStmtKeyword();
915     return false;
916   }
917 
918   this->ReturnStmtOnAllocFailure = ReturnStmt.get();
919   return true;
920 }
921 
922 bool CoroutineStmtBuilder::makeNewAndDeleteExpr() {
923   // Form and check allocation and deallocation calls.
924   assert(!IsPromiseDependentType &&
925          "cannot make statement while the promise type is dependent");
926   QualType PromiseType = Fn.CoroutinePromise->getType();
927 
928   if (S.RequireCompleteType(Loc, PromiseType, diag::err_incomplete_type))
929     return false;
930 
931   const bool RequiresNoThrowAlloc = ReturnStmtOnAllocFailure != nullptr;
932 
933   // FIXME: Add support for stateful allocators.
934 
935   FunctionDecl *OperatorNew = nullptr;
936   FunctionDecl *OperatorDelete = nullptr;
937   FunctionDecl *UnusedResult = nullptr;
938   bool PassAlignment = false;
939   SmallVector<Expr *, 1> PlacementArgs;
940 
941   S.FindAllocationFunctions(Loc, SourceRange(),
942                             /*UseGlobal*/ false, PromiseType,
943                             /*isArray*/ false, PassAlignment, PlacementArgs,
944                             OperatorNew, UnusedResult);
945 
946   bool IsGlobalOverload =
947       OperatorNew && !isa<CXXRecordDecl>(OperatorNew->getDeclContext());
948   // If we didn't find a class-local new declaration and non-throwing new
949   // was is required then we need to lookup the non-throwing global operator
950   // instead.
951   if (RequiresNoThrowAlloc && (!OperatorNew || IsGlobalOverload)) {
952     auto *StdNoThrow = buildStdNoThrowDeclRef(S, Loc);
953     if (!StdNoThrow)
954       return false;
955     PlacementArgs = {StdNoThrow};
956     OperatorNew = nullptr;
957     S.FindAllocationFunctions(Loc, SourceRange(),
958                               /*UseGlobal*/ true, PromiseType,
959                               /*isArray*/ false, PassAlignment, PlacementArgs,
960                               OperatorNew, UnusedResult);
961   }
962 
963   assert(OperatorNew && "expected definition of operator new to be found");
964 
965   if (RequiresNoThrowAlloc) {
966     const auto *FT = OperatorNew->getType()->getAs<FunctionProtoType>();
967     if (!FT->isNothrow(S.Context, /*ResultIfDependent*/ false)) {
968       S.Diag(OperatorNew->getLocation(),
969              diag::err_coroutine_promise_new_requires_nothrow)
970           << OperatorNew;
971       S.Diag(Loc, diag::note_coroutine_promise_call_implicitly_required)
972           << OperatorNew;
973       return false;
974     }
975   }
976 
977   if ((OperatorDelete = findDeleteForPromise(S, Loc, PromiseType)) == nullptr)
978     return false;
979 
980   Expr *FramePtr =
981       buildBuiltinCall(S, Loc, Builtin::BI__builtin_coro_frame, {});
982 
983   Expr *FrameSize =
984       buildBuiltinCall(S, Loc, Builtin::BI__builtin_coro_size, {});
985 
986   // Make new call.
987 
988   ExprResult NewRef =
989       S.BuildDeclRefExpr(OperatorNew, OperatorNew->getType(), VK_LValue, Loc);
990   if (NewRef.isInvalid())
991     return false;
992 
993   SmallVector<Expr *, 2> NewArgs(1, FrameSize);
994   for (auto Arg : PlacementArgs)
995     NewArgs.push_back(Arg);
996 
997   ExprResult NewExpr =
998       S.ActOnCallExpr(S.getCurScope(), NewRef.get(), Loc, NewArgs, Loc);
999   NewExpr = S.ActOnFinishFullExpr(NewExpr.get());
1000   if (NewExpr.isInvalid())
1001     return false;
1002 
1003   // Make delete call.
1004 
1005   QualType OpDeleteQualType = OperatorDelete->getType();
1006 
1007   ExprResult DeleteRef =
1008       S.BuildDeclRefExpr(OperatorDelete, OpDeleteQualType, VK_LValue, Loc);
1009   if (DeleteRef.isInvalid())
1010     return false;
1011 
1012   Expr *CoroFree =
1013       buildBuiltinCall(S, Loc, Builtin::BI__builtin_coro_free, {FramePtr});
1014 
1015   SmallVector<Expr *, 2> DeleteArgs{CoroFree};
1016 
1017   // Check if we need to pass the size.
1018   const auto *OpDeleteType =
1019       OpDeleteQualType.getTypePtr()->getAs<FunctionProtoType>();
1020   if (OpDeleteType->getNumParams() > 1)
1021     DeleteArgs.push_back(FrameSize);
1022 
1023   ExprResult DeleteExpr =
1024       S.ActOnCallExpr(S.getCurScope(), DeleteRef.get(), Loc, DeleteArgs, Loc);
1025   DeleteExpr = S.ActOnFinishFullExpr(DeleteExpr.get());
1026   if (DeleteExpr.isInvalid())
1027     return false;
1028 
1029   this->Allocate = NewExpr.get();
1030   this->Deallocate = DeleteExpr.get();
1031 
1032   return true;
1033 }
1034 
1035 bool CoroutineStmtBuilder::makeOnFallthrough() {
1036   assert(!IsPromiseDependentType &&
1037          "cannot make statement while the promise type is dependent");
1038 
1039   // [dcl.fct.def.coroutine]/4
1040   // The unqualified-ids 'return_void' and 'return_value' are looked up in
1041   // the scope of class P. If both are found, the program is ill-formed.
1042   bool HasRVoid, HasRValue;
1043   LookupResult LRVoid =
1044       lookupMember(S, "return_void", PromiseRecordDecl, Loc, HasRVoid);
1045   LookupResult LRValue =
1046       lookupMember(S, "return_value", PromiseRecordDecl, Loc, HasRValue);
1047 
1048   StmtResult Fallthrough;
1049   if (HasRVoid && HasRValue) {
1050     // FIXME Improve this diagnostic
1051     S.Diag(FD.getLocation(),
1052            diag::err_coroutine_promise_incompatible_return_functions)
1053         << PromiseRecordDecl;
1054     S.Diag(LRVoid.getRepresentativeDecl()->getLocation(),
1055            diag::note_member_first_declared_here)
1056         << LRVoid.getLookupName();
1057     S.Diag(LRValue.getRepresentativeDecl()->getLocation(),
1058            diag::note_member_first_declared_here)
1059         << LRValue.getLookupName();
1060     return false;
1061   } else if (!HasRVoid && !HasRValue) {
1062     // FIXME: The PDTS currently specifies this case as UB, not ill-formed.
1063     // However we still diagnose this as an error since until the PDTS is fixed.
1064     S.Diag(FD.getLocation(),
1065            diag::err_coroutine_promise_requires_return_function)
1066         << PromiseRecordDecl;
1067     S.Diag(PromiseRecordDecl->getLocation(), diag::note_defined_here)
1068         << PromiseRecordDecl;
1069     return false;
1070   } else if (HasRVoid) {
1071     // If the unqualified-id return_void is found, flowing off the end of a
1072     // coroutine is equivalent to a co_return with no operand. Otherwise,
1073     // flowing off the end of a coroutine results in undefined behavior.
1074     Fallthrough = S.BuildCoreturnStmt(FD.getLocation(), nullptr,
1075                                       /*IsImplicit*/false);
1076     Fallthrough = S.ActOnFinishFullStmt(Fallthrough.get());
1077     if (Fallthrough.isInvalid())
1078       return false;
1079   }
1080 
1081   this->OnFallthrough = Fallthrough.get();
1082   return true;
1083 }
1084 
1085 bool CoroutineStmtBuilder::makeOnException() {
1086   // Try to form 'p.unhandled_exception();'
1087   assert(!IsPromiseDependentType &&
1088          "cannot make statement while the promise type is dependent");
1089 
1090   const bool RequireUnhandledException = S.getLangOpts().CXXExceptions;
1091 
1092   if (!lookupMember(S, "unhandled_exception", PromiseRecordDecl, Loc)) {
1093     auto DiagID =
1094         RequireUnhandledException
1095             ? diag::err_coroutine_promise_unhandled_exception_required
1096             : diag::
1097                   warn_coroutine_promise_unhandled_exception_required_with_exceptions;
1098     S.Diag(Loc, DiagID) << PromiseRecordDecl;
1099     S.Diag(PromiseRecordDecl->getLocation(), diag::note_defined_here)
1100         << PromiseRecordDecl;
1101     return !RequireUnhandledException;
1102   }
1103 
1104   // If exceptions are disabled, don't try to build OnException.
1105   if (!S.getLangOpts().CXXExceptions)
1106     return true;
1107 
1108   ExprResult UnhandledException = buildPromiseCall(S, Fn.CoroutinePromise, Loc,
1109                                                    "unhandled_exception", None);
1110   UnhandledException = S.ActOnFinishFullExpr(UnhandledException.get(), Loc);
1111   if (UnhandledException.isInvalid())
1112     return false;
1113 
1114   // Since the body of the coroutine will be wrapped in try-catch, it will
1115   // be incompatible with SEH __try if present in a function.
1116   if (!S.getLangOpts().Borland && Fn.FirstSEHTryLoc.isValid()) {
1117     S.Diag(Fn.FirstSEHTryLoc, diag::err_seh_in_a_coroutine_with_cxx_exceptions);
1118     S.Diag(Fn.FirstCoroutineStmtLoc, diag::note_declared_coroutine_here)
1119         << Fn.getFirstCoroutineStmtKeyword();
1120     return false;
1121   }
1122 
1123   this->OnException = UnhandledException.get();
1124   return true;
1125 }
1126 
1127 bool CoroutineStmtBuilder::makeReturnObject() {
1128   // Build implicit 'p.get_return_object()' expression and form initialization
1129   // of return type from it.
1130   ExprResult ReturnObject =
1131       buildPromiseCall(S, Fn.CoroutinePromise, Loc, "get_return_object", None);
1132   if (ReturnObject.isInvalid())
1133     return false;
1134 
1135   this->ReturnValue = ReturnObject.get();
1136   return true;
1137 }
1138 
1139 static void noteMemberDeclaredHere(Sema &S, Expr *E, FunctionScopeInfo &Fn) {
1140   if (auto *MbrRef = dyn_cast<CXXMemberCallExpr>(E)) {
1141     auto *MethodDecl = MbrRef->getMethodDecl();
1142     S.Diag(MethodDecl->getLocation(), diag::note_member_declared_here)
1143         << MethodDecl;
1144   }
1145   S.Diag(Fn.FirstCoroutineStmtLoc, diag::note_declared_coroutine_here)
1146       << Fn.getFirstCoroutineStmtKeyword();
1147 }
1148 
1149 bool CoroutineStmtBuilder::makeGroDeclAndReturnStmt() {
1150   assert(!IsPromiseDependentType &&
1151          "cannot make statement while the promise type is dependent");
1152   assert(this->ReturnValue && "ReturnValue must be already formed");
1153 
1154   QualType const GroType = this->ReturnValue->getType();
1155   assert(!GroType->isDependentType() &&
1156          "get_return_object type must no longer be dependent");
1157 
1158   QualType const FnRetType = FD.getReturnType();
1159   assert(!FnRetType->isDependentType() &&
1160          "get_return_object type must no longer be dependent");
1161 
1162   if (FnRetType->isVoidType()) {
1163     ExprResult Res = S.ActOnFinishFullExpr(this->ReturnValue, Loc);
1164     if (Res.isInvalid())
1165       return false;
1166 
1167     this->ResultDecl = Res.get();
1168     return true;
1169   }
1170 
1171   if (GroType->isVoidType()) {
1172     // Trigger a nice error message.
1173     InitializedEntity Entity =
1174         InitializedEntity::InitializeResult(Loc, FnRetType, false);
1175     S.PerformMoveOrCopyInitialization(Entity, nullptr, FnRetType, ReturnValue);
1176     noteMemberDeclaredHere(S, ReturnValue, Fn);
1177     return false;
1178   }
1179 
1180   auto *GroDecl = VarDecl::Create(
1181       S.Context, &FD, FD.getLocation(), FD.getLocation(),
1182       &S.PP.getIdentifierTable().get("__coro_gro"), GroType,
1183       S.Context.getTrivialTypeSourceInfo(GroType, Loc), SC_None);
1184 
1185   S.CheckVariableDeclarationType(GroDecl);
1186   if (GroDecl->isInvalidDecl())
1187     return false;
1188 
1189   InitializedEntity Entity = InitializedEntity::InitializeVariable(GroDecl);
1190   ExprResult Res = S.PerformMoveOrCopyInitialization(Entity, nullptr, GroType,
1191                                                      this->ReturnValue);
1192   if (Res.isInvalid())
1193     return false;
1194 
1195   Res = S.ActOnFinishFullExpr(Res.get());
1196   if (Res.isInvalid())
1197     return false;
1198 
1199   if (GroType == FnRetType) {
1200     GroDecl->setNRVOVariable(true);
1201   }
1202 
1203   S.AddInitializerToDecl(GroDecl, Res.get(),
1204                          /*DirectInit=*/false);
1205 
1206   S.FinalizeDeclaration(GroDecl);
1207 
1208   // Form a declaration statement for the return declaration, so that AST
1209   // visitors can more easily find it.
1210   StmtResult GroDeclStmt =
1211       S.ActOnDeclStmt(S.ConvertDeclToDeclGroup(GroDecl), Loc, Loc);
1212   if (GroDeclStmt.isInvalid())
1213     return false;
1214 
1215   this->ResultDecl = GroDeclStmt.get();
1216 
1217   ExprResult declRef = S.BuildDeclRefExpr(GroDecl, GroType, VK_LValue, Loc);
1218   if (declRef.isInvalid())
1219     return false;
1220 
1221   StmtResult ReturnStmt = S.BuildReturnStmt(Loc, declRef.get());
1222   if (ReturnStmt.isInvalid()) {
1223     noteMemberDeclaredHere(S, ReturnValue, Fn);
1224     return false;
1225   }
1226 
1227   this->ReturnStmt = ReturnStmt.get();
1228   return true;
1229 }
1230 
1231 // Create a static_cast\<T&&>(expr).
1232 static Expr *castForMoving(Sema &S, Expr *E, QualType T = QualType()) {
1233   if (T.isNull())
1234     T = E->getType();
1235   QualType TargetType = S.BuildReferenceType(
1236       T, /*SpelledAsLValue*/ false, SourceLocation(), DeclarationName());
1237   SourceLocation ExprLoc = E->getLocStart();
1238   TypeSourceInfo *TargetLoc =
1239       S.Context.getTrivialTypeSourceInfo(TargetType, ExprLoc);
1240 
1241   return S
1242       .BuildCXXNamedCast(ExprLoc, tok::kw_static_cast, TargetLoc, E,
1243                          SourceRange(ExprLoc, ExprLoc), E->getSourceRange())
1244       .get();
1245 }
1246 
1247 /// \brief Build a variable declaration for move parameter.
1248 static VarDecl *buildVarDecl(Sema &S, SourceLocation Loc, QualType Type,
1249                              StringRef Name) {
1250   DeclContext *DC = S.CurContext;
1251   IdentifierInfo *II = &S.PP.getIdentifierTable().get(Name);
1252   TypeSourceInfo *TInfo = S.Context.getTrivialTypeSourceInfo(Type, Loc);
1253   VarDecl *Decl =
1254       VarDecl::Create(S.Context, DC, Loc, Loc, II, Type, TInfo, SC_None);
1255   Decl->setImplicit();
1256   return Decl;
1257 }
1258 
1259 bool CoroutineStmtBuilder::makeParamMoves() {
1260   for (auto *paramDecl : FD.parameters()) {
1261     auto Ty = paramDecl->getType();
1262     if (Ty->isDependentType())
1263       continue;
1264 
1265     // No need to copy scalars, llvm will take care of them.
1266     if (Ty->getAsCXXRecordDecl()) {
1267       if (!paramDecl->getIdentifier())
1268         continue;
1269 
1270       ExprResult ParamRef =
1271           S.BuildDeclRefExpr(paramDecl, paramDecl->getType(),
1272                              ExprValueKind::VK_LValue, Loc); // FIXME: scope?
1273       if (ParamRef.isInvalid())
1274         return false;
1275 
1276       Expr *RCast = castForMoving(S, ParamRef.get());
1277 
1278       auto D = buildVarDecl(S, Loc, Ty, paramDecl->getIdentifier()->getName());
1279 
1280       S.AddInitializerToDecl(D, RCast, /*DirectInit=*/true);
1281 
1282       // Convert decl to a statement.
1283       StmtResult Stmt = S.ActOnDeclStmt(S.ConvertDeclToDeclGroup(D), Loc, Loc);
1284       if (Stmt.isInvalid())
1285         return false;
1286 
1287       ParamMovesVector.push_back(Stmt.get());
1288     }
1289   }
1290 
1291   // Convert to ArrayRef in CtorArgs structure that builder inherits from.
1292   ParamMoves = ParamMovesVector;
1293   return true;
1294 }
1295 
1296 StmtResult Sema::BuildCoroutineBodyStmt(CoroutineBodyStmt::CtorArgs Args) {
1297   CoroutineBodyStmt *Res = CoroutineBodyStmt::Create(Context, Args);
1298   if (!Res)
1299     return StmtError();
1300   return Res;
1301 }
1302