Skip to content

Commit f8d6836

Browse files
committedAug 13, 2019
[CodeGen] Disable UBSan for coroutine functions
Summary: As explained in http://lists.llvm.org/pipermail/llvm-dev/2018-March/121924.html, the LLVM coroutines transforms are not yet able to move the instructions for UBSan null checking past coroutine suspend boundaries. For now, disable all UBSan checks when generating code for coroutines functions. I also considered an approach where only '-fsanitize=null' would be disabled, However in practice this led to other LLVM errors when writing object files: "Cannot represent a difference across sections". For now, disable all UBSan checks until coroutine transforms are updated to handle them. Test Plan: 1. check-clang 2. Compile the program in https://gist.github.com/modocache/54a036c3bf9c06882fe85122e105d153 using the '-fsanitize=null' option and confirm it does not crash during LLVM IR generation. Reviewers: GorNishanov, vsk, eric_niebler, lewissbaker Reviewed By: vsk Subscribers: cfe-commits Tags: #clang Differential Revision: https://reviews.llvm.org/D44672 llvm-svn: 368675
1 parent 5065e78 commit f8d6836

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-0
lines changed
 

‎clang/lib/CodeGen/CodeGenFunction.cpp

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -732,6 +732,15 @@ void CodeGenFunction::StartFunction(GlobalDecl GD,
732732
SanOpts.Mask &= ~SanitizerKind::CFIUnrelatedCast;
733733
}
734734

735+
// Ignore null checks in coroutine functions since the coroutines passes
736+
// are not aware of how to move the extra UBSan instructions across the split
737+
// coroutine boundaries.
738+
if (D && SanOpts.has(SanitizerKind::Null))
739+
if (const auto *FD = dyn_cast<FunctionDecl>(D))
740+
if (FD->getBody() &&
741+
FD->getBody()->getStmtClass() == Stmt::CoroutineBodyStmtClass)
742+
SanOpts.Mask &= ~SanitizerKind::Null;
743+
735744
// Apply xray attributes to the function (as a string, for now)
736745
if (D) {
737746
if (const auto *XRayAttr = D->getAttr<XRayInstrumentAttr>()) {
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
// This test merely verifies that emitting the object file does not cause a
2+
// crash when the LLVM coroutines passes are run.
3+
// RUN: %clang_cc1 -emit-obj -std=c++2a -fsanitize=null %s -o %t.o
4+
5+
namespace std::experimental {
6+
template <typename R, typename... T> struct coroutine_traits {
7+
using promise_type = typename R::promise_type;
8+
};
9+
10+
template <class Promise = void> struct coroutine_handle;
11+
template <> struct coroutine_handle<void> {
12+
static coroutine_handle from_address(void *) noexcept;
13+
coroutine_handle() = default;
14+
template <class PromiseType>
15+
coroutine_handle(coroutine_handle<PromiseType>) noexcept;
16+
};
17+
template <class Promise> struct coroutine_handle : coroutine_handle<void> {
18+
coroutine_handle() = default;
19+
static coroutine_handle from_address(void *) noexcept;
20+
};
21+
}
22+
23+
struct suspend_always {
24+
bool await_ready() noexcept;
25+
void await_suspend(std::experimental::coroutine_handle<>) noexcept;
26+
void await_resume() noexcept;
27+
};
28+
29+
struct task {
30+
struct promise_type {
31+
task get_return_object() { return task(); }
32+
suspend_always initial_suspend() { return {}; }
33+
suspend_always final_suspend() { return {}; }
34+
void return_void() {}
35+
void unhandled_exception() {}
36+
};
37+
};
38+
39+
struct awaitable {
40+
task await() { (void)co_await *this; }
41+
bool await_ready() { return false; }
42+
bool await_suspend(std::experimental::coroutine_handle<> awaiter) { return false; }
43+
bool await_resume() { return false; }
44+
};
45+
46+
int main() {
47+
awaitable a;
48+
a.await();
49+
}

0 commit comments

Comments
 (0)
Please sign in to comment.