Clang Project

clang_source_code/test/CodeGenCoroutines/coro-await-resume-eh.cpp
1// Test the behavior of http://wg21.link/P0664, a proposal to catch any
2// exceptions thrown after the initial suspend point of a coroutine by
3// executing the handler specified by the promise type's 'unhandled_exception'
4// member function.
5//
6// RUN: %clang_cc1 -std=c++14 -fcoroutines-ts \
7// RUN:   -triple=x86_64-unknown-linux-gnu -emit-llvm -o - %s \
8// RUN:   -fexceptions -fcxx-exceptions -disable-llvm-passes \
9// RUN:   | FileCheck %s
10
11#include "Inputs/coroutine.h"
12
13namespace coro = std::experimental::coroutines_v1;
14
15struct throwing_awaitable {
16  bool await_ready() { return true; }
17  void await_suspend(coro::coroutine_handle<>) {}
18  void await_resume() { throw 42; }
19};
20
21struct throwing_task {
22  struct promise_type {
23    auto get_return_object() { return throwing_task{}; }
24    auto initial_suspend() { return throwing_awaitable{}; }
25    auto final_suspend() { return coro::suspend_never{}; }
26    void return_void() {}
27    void unhandled_exception() {}
28  };
29};
30
31// CHECK-LABEL: define void @_Z1fv()
32throwing_task f() {
33  // A variable RESUMETHREW is used to keep track of whether the body
34  // of 'await_resume' threw an exception. Exceptions thrown in
35  // 'await_resume' are unwound to RESUMELPAD.
36  // CHECK: init.ready:
37  // CHECK-NEXT: store i1 true, i1* %[[RESUMETHREW:.+]], align 1
38  // CHECK-NEXT: invoke void @_ZN18throwing_awaitable12await_resumeEv
39  // CHECK-NEXT: to label %[[RESUMECONT:.+]] unwind label %[[RESUMELPAD:.+]]
40
41  // If 'await_resume' does not throw an exception, 'false' is stored in
42  // variable RESUMETHREW.
43  // CHECK: [[RESUMECONT]]:
44  // CHECK-NEXT: store i1 false, i1* %[[RESUMETHREW]]
45  // CHECK-NEXT: br label %[[RESUMETRYCONT:.+]]
46
47  // 'unhandled_exception' is called for the exception thrown in
48  // 'await_resume'. The variable RESUMETHREW is never set to false,
49  // and a jump is made to RESUMETRYCONT.
50  // CHECK: [[RESUMELPAD]]:
51  // CHECK: br label %[[RESUMECATCH:.+]]
52  // CHECK: [[RESUMECATCH]]:
53  // CHECK: invoke void @_ZN13throwing_task12promise_type19unhandled_exceptionEv
54  // CHECK-NEXT: to label %[[RESUMEENDCATCH:.+]] unwind label
55  // CHECK: [[RESUMEENDCATCH]]:
56  // CHECK-NEXT: invoke void @__cxa_end_catch()
57  // CHECK-NEXT: to label %[[RESUMEENDCATCHCONT:.+]] unwind label
58  // CHECK: [[RESUMEENDCATCHCONT]]:
59  // CHECK-NEXT: br label %[[RESUMETRYCONT]]
60
61  // The variable RESUMETHREW is loaded and if true, then 'await_resume'
62  // threw an exception and the coroutine body is skipped, and the final
63  // suspend is executed immediately. Otherwise, the coroutine body is
64  // executed, and then the final suspend.
65  // CHECK: [[RESUMETRYCONT]]:
66  // CHECK-NEXT: %[[RESUMETHREWLOAD:.+]] = load i1, i1* %[[RESUMETHREW]]
67  // CHECK-NEXT: br i1 %[[RESUMETHREWLOAD]], label %[[RESUMEDCONT:.+]], label %[[RESUMEDBODY:.+]]
68
69  // CHECK: [[RESUMEDBODY]]:
70  // CHECK: invoke void @_ZN13throwing_task12promise_type11return_voidEv
71  // CHECK-NEXT: to label %[[REDUMEDBODYCONT:.+]] unwind label
72  // CHECK: [[REDUMEDBODYCONT]]:
73  // CHECK-NEXT: br label %[[COROFINAL:.+]]
74
75  // CHECK: [[RESUMEDCONT]]:
76  // CHECK-NEXT: br label %[[COROFINAL]]
77
78  // CHECK: [[COROFINAL]]:
79  // CHECK-NEXT: invoke void @_ZN13throwing_task12promise_type13final_suspendEv
80  co_return;
81}
82
83struct noexcept_awaitable {
84  bool await_ready() { return true; }
85  void await_suspend(coro::coroutine_handle<>) {}
86  void await_resume() noexcept {}
87};
88
89struct noexcept_task {
90  struct promise_type {
91    auto get_return_object() { return noexcept_task{}; }
92    auto initial_suspend() { return noexcept_awaitable{}; }
93    auto final_suspend() { return coro::suspend_never{}; }
94    void return_void() {}
95    void unhandled_exception() {}
96  };
97};
98
99// CHECK-LABEL: define void @_Z1gv()
100noexcept_task g() {
101  // If the await_resume function is marked as noexcept, none of the additional
102  // conditions that are present in f() above are added to the IR.
103  // This means that no i1 are stored before or after calling await_resume:
104  // CHECK: init.ready:
105  // CHECK-NEXT: call void @_ZN18noexcept_awaitable12await_resumeEv
106  // CHECK-NOT: store i1 false, i1*
107  co_return;
108}
109