Skip to content

Fix Windows EH IP2State tables (remove +1 bias) #144745

New issue

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

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

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 180 additions & 0 deletions clang/test/CodeGenCXX/microsoft-abi-eh-async.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
// RUN: %clang_cl -c --target=x86_64-windows-msvc /EHa -O2 /GS- \
// RUN: -Xclang=-import-call-optimization \
// RUN: /clang:-S /clang:-o- %s 2>&1 \
// RUN: | FileCheck %s
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

// REQUIRES: x86-registered-target


#ifdef __clang__
#define NO_TAIL __attribute((disable_tail_calls))
#else
#define NO_TAIL
#endif

void might_throw();
void other_func(int x);

void does_not_throw() noexcept(true);

extern "C" void __declspec(dllimport) some_dll_import();

class HasDtor {
int x;
char foo[40];

public:
explicit HasDtor(int x);
~HasDtor();
};

class BadError {
public:
int errorCode;
};

void normal_has_regions() {
// CHECK-LABEL: .def "?normal_has_regions@@YAXXZ"
// CHECK: .seh_endprologue

// <-- state -1 (none)
{
HasDtor hd{42};

// <-- state goes from -1 to 0
// because state changes, we expect the HasDtor::HasDtor() call to have a NOP
// CHECK: call "??0HasDtor@@QEAA@H@Z"
// CHECK-NEXT: nop

might_throw();
// CHECK: call "?might_throw@@YAXXZ"
// CHECK-NEXT: nop

// <-- state goes from 0 to -1 because we're about to call HasDtor::~HasDtor()
// CHECK: call "??1HasDtor@@QEAA@XZ"
// <-- state -1
}

// <-- state -1
other_func(10);
// CHECK: call "?other_func@@YAXH@Z"
// CHECK-NEXT: nop
// CHECK: .seh_startepilogue

// <-- state -1
}

// This tests a tail call to a destructor.
void case_dtor_arg_empty_body(HasDtor x)
{
// CHECK-LABEL: .def "?case_dtor_arg_empty_body@@YAXVHasDtor@@@Z"
// CHECK: jmp "??1HasDtor@@QEAA@XZ"
}

int case_dtor_arg_empty_with_ret(HasDtor x)
{
// CHECK-LABEL: .def "?case_dtor_arg_empty_with_ret@@YAHVHasDtor@@@Z"
// CHECK: .seh_endprologue

// CHECK: call "??1HasDtor@@QEAA@XZ"
// CHECK-NOT: nop

// The call to HasDtor::~HasDtor() should NOT have a NOP because the
// following "mov eax, 100" instruction is in the same EH state.

return 100;

// CHECK: mov eax, 100
// CHECK: .seh_startepilogue
// CHECK: .seh_endepilogue
// CHECK: .seh_endproc
}

int case_noexcept_dtor(HasDtor x) noexcept(true)
{
// CHECK: .def "?case_noexcept_dtor@@YAHVHasDtor@@@Z"
// CHECK: call "??1HasDtor@@QEAA@XZ"
// CHECK-NEXT: mov eax, 100
// CHECK: .seh_startepilogue
return 100;
}

void case_except_simple_call() NO_TAIL
{
does_not_throw();
}

void case_noexcept_simple_call() noexcept(true) NO_TAIL
{
does_not_throw();
}

// This tests that the destructor is called right before SEH_BeginEpilogue,
// but in a function that has a return value.
int case_dtor_arg_calls_no_throw(HasDtor x)
{
does_not_throw(); // no NOP expected
return 100;
}

// Check the behavior of CALLs that are at the end of MBBs. If a CALL is within
// a non-null EH state (state -1) and is at the end of an MBB, then we expect
// to find an EH_LABEL after the CALL. This causes us to insert a NOP, which
// is the desired result.
void case_dtor_runs_after_join(int x) {
// CHECK-LABEL: .def "?case_dtor_runs_after_join@@YAXH@Z"
// CHECK: .seh_endprologue

// <-- EH state -1

// ctor call does not need a NOP, because it has real instructions after it
HasDtor hd{42};
// CHECK: call "??0HasDtor@@QEAA@H@Z"
// CHECK-NEXT: nop
// CHECK: test

// <-- EH state transition from -1 0
if (x) {
might_throw(); // <-- NOP expected (at end of BB w/ EH_LABEL)
// CHECK: call "?might_throw@@YAXXZ"
// CHECK-NEXT: nop
} else {
other_func(10); // <-- NOP expected (at end of BB w/ EH_LABEL)
// CHECK: call "?other_func@@YAXH@Z"
// CHECK-NEXT: nop
}
does_not_throw();
// <-- EH state transition 0 to -1
// ~HasDtor() runs

// CHECK: .seh_endproc

// CHECK: "$ip2state$?case_dtor_runs_after_join@@YAXH@Z":
// CHECK-NEXT: .long [[func_begin:.Lfunc_begin([0-9]+)@IMGREL]]
// CHECK-NEXT: .long -1
// CHECK-NEXT: .long [[tmp1:.Ltmp([0-9]+)]]@IMGREL
// CHECK-NEXT: .long 0
// CHECK-NEXT: .long [[tmp2:.Ltmp([0-9]+)]]@IMGREL
// CHECK-NEXT: .long -1
}


// Check the behavior of NOP padding around tail calls.
// We do not expect to insert NOPs around tail calls.
// However, the first call (to other_func()) does get a NOP
// because it comes before .seh_startepilogue.
void case_tail_call_no_eh() {
// CHECK-LABEL: .def "?case_tail_call_no_eh@@YAXXZ"
// CHECK: .seh_endprologue

// ordinary call
other_func(10);
// CHECK: call "?other_func@@YAXH@Z"
// CHECK-NEXT: nop

// tail call; no NOP padding after JMP
does_not_throw();

// CHECK: .seh_startepilogue
// CHECK: .seh_endepilogue
// CHECK: jmp "?does_not_throw@@YAXXZ"
// CHECK-NOT: nop
// CHECK: .seh_endproc
}
139 changes: 139 additions & 0 deletions clang/test/CodeGenCXX/microsoft-abi-eh-disabled.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
// RUN: %clang_cl -c --target=x86_64-windows-msvc /EHs-c- -O2 /GS- \
// RUN: -Xclang=-import-call-optimization \
// RUN: /clang:-S /clang:-o- %s 2>&1 \
// RUN: | FileCheck %s

#ifdef __clang__
#define NO_TAIL __attribute((disable_tail_calls))
#else
#define NO_TAIL
#endif

void might_throw();
void other_func(int x);

void does_not_throw() noexcept(true);

extern "C" void __declspec(dllimport) some_dll_import();

class HasDtor {
int x;
char foo[40];

public:
explicit HasDtor(int x);
~HasDtor();
};

void normal_has_regions() {
{
HasDtor hd{42};

// because state changes, we expect the HasDtor::HasDtor() call to have a NOP
might_throw();
}

other_func(10);
}
// CHECK-LABEL: .def "?normal_has_regions@@YAXXZ"
// CHECK: .seh_endprologue
// CHECK: call "??0HasDtor@@QEAA@H@Z"
// CHECK-NEXT: call "?might_throw@@YAXXZ"
// CHECK-NEXT: mov
// CHECK: call "??1HasDtor@@QEAA@XZ"
// CHECK-NEXT: mov ecx, 10
// CHECK-NEXT: call "?other_func@@YAXH@Z"
// CHECK-NEXT: nop
// CHECK-NEXT: .seh_startepilogue
// CHECK-NOT: "$ip2state$?normal_has_regions@@YAXXZ"

// This tests a tail call to a destructor.
void case_dtor_arg_empty_body(HasDtor x)
{
}
// CHECK-LABEL: .def "?case_dtor_arg_empty_body@@YAXVHasDtor@@@Z"
// CHECK: jmp "??1HasDtor@@QEAA@XZ"

int case_dtor_arg_empty_with_ret(HasDtor x)
{
// The call to HasDtor::~HasDtor() should NOT have a NOP because the
// following "mov eax, 100" instruction is in the same EH state.
return 100;
}
// CHECK-LABEL: .def "?case_dtor_arg_empty_with_ret@@YAHVHasDtor@@@Z"
// CHECK: .seh_endprologue
// CHECK: call "??1HasDtor@@QEAA@XZ"
// CHECK-NOT: nop
// CHECK: mov eax, 100
// CHECK: .seh_startepilogue
// CHECK: .seh_endepilogue
// CHECK: .seh_endproc

void case_except_simple_call() NO_TAIL
{
does_not_throw();
}

// This tests that the destructor is called right before SEH_BeginEpilogue,
// but in a function that has a return value.
int case_dtor_arg_calls_no_throw(HasDtor x)
{
does_not_throw(); // no NOP expected
return 100;
}

// Check the behavior of CALLs that are at the end of MBBs. If a CALL is within
// a non-null EH state (state -1) and is at the end of an MBB, then we expect
// to find an EH_LABEL after the CALL. This causes us to insert a NOP, which
// is the desired result.
void case_dtor_runs_after_join(int x) {

// ctor call does not need a NOP, because it has real instructions after it
HasDtor hd{42};

if (x) {
might_throw();
} else {
other_func(10);
}
does_not_throw();
// ~HasDtor() runs
}

// CHECK-LABEL: .def "?case_dtor_runs_after_join@@YAXH@Z"
// CHECK: .seh_endprologue
// CHECK: call "??0HasDtor@@QEAA@H@Z"
// CHECK-NEXT: test
// CHECK: call "?might_throw@@YAXXZ"
// CHECK-NEXT: jmp
// CHECK: call "?other_func@@YAXH@Z"
// CHECK-NEXT: .LBB
// CHECK: call "?does_not_throw@@YAXXZ"
// CHECK-NEXT: lea
// CHECK-NEXT: call "??1HasDtor@@QEAA@XZ"
// CHECK-NEXT: nop
// CHECK-NEXT: .seh_startepilogue
// CHECK-NOT: "$ip2state$?case_dtor_runs_after_join@@YAXH@Z":


// Check the behavior of NOP padding around tail calls.
// We do not expect to insert NOPs around tail calls.
// However, the first call (to other_func()) does get a NOP
// because it comes before .seh_startepilogue.
void case_tail_call_no_eh() {
// ordinary call
other_func(10);

// tail call; no NOP padding after JMP
does_not_throw();
}

// CHECK-LABEL: .def "?case_tail_call_no_eh@@YAXXZ"
// CHECK: .seh_endprologue
// CHECK: call "?other_func@@YAXH@Z"
// CHECK-NEXT: nop
// CHECK-NEXT: .seh_startepilogue
// CHECK: .seh_endepilogue
// CHECK: jmp "?does_not_throw@@YAXXZ"
// CHECK-NOT: nop
// CHECK: .seh_endproc
Loading