WinEH for unnamed functions

[• pbrunet]

Summary

dtor and catch symbol are required for windows exception handling. These symboles were defined based on function name which is incorrect in the case of unnamed functions as we may have multiple functions with the same empty name.
It leads to assert if they are available or crash on the exception path.

[paquette]

I feel like the test here could use some simplification to make it clearer what you're testing. If there's any IR in there that you don't *absolutely* need, it'd be good to remove it. This makes it easier for others to debug failures in the future.

test/CodeGen/WinEH/wineh-unnamed.ll

1

Spelling and grammar could use some fixing here.

102

You can remove the ; Function Attrs... comments. Basically any comment that you didn't write for your test can go.

116

You don't need comments like the ; preds... lines in tests

152

Do you need all of these attributes for your test? If you don't, it would simplify it a lot to remove some of them.

[paquette]

I also suggest adding some reviewers to your patch! If you look at the blamelist of WinException.cpp you'll probably find some people that know the code well that can look at your stuff. I'm not a Windows expert, but if I was I'd give you a proper review. :)

[• pbrunet]

Thanks for the review and sorry for the delay.

I Updated this patch with :

• handle new API : replace getRealLinkageName by dropLLVMManglingEscape
• Reduce test case.

[rnk]

The same logic would need to be applied to the X86ISelLowering call site of MCContext::getOrCreateParentFrameOffsetSymbol. I think it would be preferable to manually number and provide names for nameless functions that use funclet personalities in WinEHPrepare.

[majnemer]

In D37434#978881, @rnk wrote:

The same logic would need to be applied to the X86ISelLowering call site of MCContext::getOrCreateParentFrameOffsetSymbol. I think it would be preferable to manually number and provide names for nameless functions that use funclet personalities in WinEHPrepare.

Heh, I was just about to recommend using something like Mangler::getNameWithPrefix (with CannotUsePrivateLabel set to true) into a raw_svector_ostream. This way we get a name which will correspond to what we get in the object file. We would only use Mangler::getNameWithPrefix if the GV had no name.

[rnk]

In D37434#978885, @majnemer wrote:

In D37434#978881, @rnk wrote:

The same logic would need to be applied to the X86ISelLowering call site of MCContext::getOrCreateParentFrameOffsetSymbol. I think it would be preferable to manually number and provide names for nameless functions that use funclet personalities in WinEHPrepare.

Heh, I was just about to recommend using something like Mangler::getNameWithPrefix (with CannotUsePrivateLabel set to true) into a raw_svector_ostream. This way we get a name which will correspond to what we get in the object file. We would only use Mangler::getNameWithPrefix if the GV had no name.

I think part of the trouble here is that I put the logic for computing the label name in MCContext, which cannot use IR constructs. Having this in the Mangler would work better.

lib/CodeGen/AsmPrinter/WinException.cpp

 #include "llvm/Target/TargetSubtargetInfo.h"
 using namespace llvm;
 
+static std::string GetNameFromFunction(llvm::Function const& F) {
+  std::string name;
+  if(F.hasName())
+    name = F.getName();
+  else 
+    name = std::to_string(
+        std::distance(
+          F.getParent()->begin(),
+          std::find_if(
+            F.getParent()->begin(),
+            F.getParent()->end(),
+            [&F](Function const& Fun){return &Fun == &F;})
+          )
+        );
+  return GlobalValue::getRealLinkageName(name);
+}
+
 WinException::WinException(AsmPrinter *A) : EHStreamer(A) {
   // MSVC's EH tables are always composed of 32-bit words.  All known 64-bit
   // platforms use an imagerel32 relocation to refer to symbols.

       // make sure we emit the parent offset label. Some unreferenced filter
       // functions may still refer to it.
       const WinEHFuncInfo &FuncInfo = *MF->getWinEHFuncInfo();
-      StringRef FLinkageName =
-          GlobalValue::getRealLinkageName(MF->getFunction()->getName());
+      std::string FLinkageName = GetNameFromFunction(*MF->getFunction());
       emitEHRegistrationOffsetLabel(FuncInfo, FLinkageName);
     }
     shouldEmitLSDA = hasEHFunclets;

   // their funclet entry block's number.
   const MachineFunction *MF = MBB->getParent();
   const Function *F = MF->getFunction();
-  StringRef FuncLinkageName = GlobalValue::getRealLinkageName(F->getName());
+  std::string FuncLinkageName = GetNameFromFunction(*F);
   MCContext &Ctx = MF->getContext();
   StringRef HandlerPrefix = MBB->isCleanupFuncletEntry() ? "dtor" : "catch";
   return Ctx.getOrCreateSymbol("?" + HandlerPrefix + "$" +

         !CurrentFuncletEntry->isCleanupFuncletEntry()) {
       // If this is a C++ catch funclet (or the parent function),
       // emit a reference to the LSDA for the parent function.
-      StringRef FuncLinkageName = GlobalValue::getRealLinkageName(F->getName());
+      std::string FuncLinkageName = GetNameFromFunction(*F);
       MCSymbol *FuncInfoXData = Asm->OutContext.getOrCreateSymbol(
           Twine("$cppxdata$", FuncLinkageName));
       Asm->OutStreamer->EmitValue(create32bitRef(FuncInfoXData), 4);

 
   // Emit a label assignment with the SEH frame offset so we can use it for
   // llvm.x86.seh.recoverfp.
-  StringRef FLinkageName =
-      GlobalValue::getRealLinkageName(MF->getFunction()->getName());
+  std::string FLinkageName = GetNameFromFunction(*MF->getFunction());
   MCSymbol *ParentFrameOffset =
       Ctx.getOrCreateParentFrameOffsetSymbol(FLinkageName);
   const MCExpr *MCOffset =

   auto &OS = *Asm->OutStreamer;
   const WinEHFuncInfo &FuncInfo = *MF->getWinEHFuncInfo();
 
-  StringRef FuncLinkageName = GlobalValue::getRealLinkageName(F->getName());
+  std::string FuncLinkageName = GetNameFromFunction(*F);
 
   SmallVector<std::pair<const MCExpr *, int>, 4> IPToStateTable;
   MCSymbol *FuncInfoXData = nullptr;

 void WinException::emitExceptHandlerTable(const MachineFunction *MF) {
   MCStreamer &OS = *Asm->OutStreamer;
   const Function *F = MF->getFunction();
-  StringRef FLinkageName = GlobalValue::getRealLinkageName(F->getName());
+  std::string FLinkageName = GetNameFromFunction(*F);
 
   bool VerboseAsm = OS.isVerboseAsm();
   auto AddComment = [&](const Twine &Comment) {

test/CodeGen/WinEH/wineh-unnamed.ll

+; Check we can compilte wineh file with unnamed function without colision on 
+; funclet symbole name.
+; We can improve this test and run it to see that generated program crashed but
+; it will only work on windows targets
+; RUN: llc < %s
+
+; ModuleID = 'test.cpp'
+source_filename = "test.cpp"
+target datalayout = "e-m:w-i64:64-f80:128-n8:16:32:64-S128"
+target triple = "x86_64-pc-windows-msvc19.0.24215"
+
+%rtti.TypeDescriptor5 = type { i8**, i8*, [6 x i8] }
+%eh.CatchableType = type { i32, i32, i32, i32, i32, i32, i32 }
+%eh.CatchableTypeArray.2 = type { i32, [2 x i32] }
+%eh.ThrowInfo = type { i32, i32, i32, i32 }
+
+$"\01??_C@_03JIDPIAJI@err?$AA@" = comdat any
+
+$"\01??_R0PEAD@8" = comdat any
+
+$"_CT??_R0PEAD@88" = comdat any
+
+$"\01??_R0PEAX@8" = comdat any
+
+$"_CT??_R0PEAX@88" = comdat any
+
+$_CTA2PEAD = comdat any
+
+$_TIC2PEAD = comdat any
+
+@"\01??_C@_03JIDPIAJI@err?$AA@" = linkonce_odr unnamed_addr constant [4 x i8] c"err\00", comdat, align 1
+@"\01??_7type_info@@6B@" = external constant i8*
+@"\01??_R0PEAD@8" = linkonce_odr global %rtti.TypeDescriptor5 { i8** @"\01??_7type_info@@6B@", i8* null, [6 x i8] c".PEAD\00" }, comdat
+@__ImageBase = external constant i8
+@"_CT??_R0PEAD@88" = linkonce_odr unnamed_addr constant %eh.CatchableType { i32 1, i32 trunc (i64 sub nuw nsw (i64 ptrtoint (%rtti.TypeDescriptor5* @"\01??_R0PEAD@8" to i64), i64 ptrtoint (i8* @__ImageBase to i64)) to i32), i32 0, i32 -1, i32 0, i32 8, i32 0 }, section ".xdata", comdat
+@"\01??_R0PEAX@8" = linkonce_odr global %rtti.TypeDescriptor5 { i8** @"\01??_7type_info@@6B@", i8* null, [6 x i8] c".PEAX\00" }, comdat
+@"_CT??_R0PEAX@88" = linkonce_odr unnamed_addr constant %eh.CatchableType { i32 1, i32 trunc (i64 sub nuw nsw (i64 ptrtoint (%rtti.TypeDescriptor5* @"\01??_R0PEAX@8" to i64), i64 ptrtoint (i8* @__ImageBase to i64)) to i32), i32 0, i32 -1, i32 0, i32 8, i32 0 }, section ".xdata", comdat
+@_CTA2PEAD = linkonce_odr unnamed_addr constant %eh.CatchableTypeArray.2 { i32 2, [2 x i32] [i32 trunc (i64 sub nuw nsw (i64 ptrtoint (%eh.CatchableType* @"_CT??_R0PEAD@88" to i64), i64 ptrtoint (i8* @__ImageBase to i64)) to i32), i32 trunc (i64 sub nuw nsw (i64 ptrtoint (%eh.CatchableType* @"_CT??_R0PEAX@88" to i64), i64 ptrtoint (i8* @__ImageBase to i64)) to i32)] }, section ".xdata", comdat
+@_TIC2PEAD = linkonce_odr unnamed_addr constant %eh.ThrowInfo { i32 1, i32 0, i32 0, i32 trunc (i64 sub nuw nsw (i64 ptrtoint (%eh.CatchableTypeArray.2* @_CTA2PEAD to i64), i64 ptrtoint (i8* @__ImageBase to i64)) to i32) }, section ".xdata", comdat
+
+; Function Attrs: noinline uwtable
+define void @"\01?raise@@YAXH@Z"(i32 %i) #0 {
+entry:
+  %i.addr = alloca i32, align 4
+  %tmp = alloca i8*, align 8
+  store i32 %i, i32* %i.addr, align 4
+  %0 = load i32, i32* %i.addr, align 4
+  %cmp = icmp eq i32 %0, 1
+  br i1 %cmp, label %if.then, label %if.end
+
+if.then:                                          ; preds = %entry
+  store i8* getelementptr inbounds ([4 x i8], [4 x i8]* @"\01??_C@_03JIDPIAJI@err?$AA@", i32 0, i32 0), i8** %tmp, align 8
+  %1 = bitcast i8** %tmp to i8*
+  call void @_CxxThrowException(i8* %1, %eh.ThrowInfo* @_TIC2PEAD) #3
+  unreachable
+
+if.end:                                           ; preds = %entry
+  ret void
+}
+
+declare dllimport void @_CxxThrowException(i8*, %eh.ThrowInfo*)
+
+; Function Attrs: noinline uwtable
+define i32 @0(i32 %i) #0 personality i8* bitcast (i32 (...)* @__CxxFrameHandler3 to i8*) {
+entry:
+  %retval = alloca i32, align 4
+  %i.addr = alloca i32, align 4
+  store i32 %i, i32* %i.addr, align 4
+  %0 = load i32, i32* %i.addr, align 4
+  invoke void @"\01?raise@@YAXH@Z"(i32 %0)
+          to label %invoke.cont unwind label %catch.dispatch
+
+catch.dispatch:                                   ; preds = %entry
+  %1 = catchswitch within none [label %catch] unwind to caller
+
+catch:                                            ; preds = %catch.dispatch
+  %2 = catchpad within %1 [i8* null, i32 64, i8* null]
+  store i32 1, i32* %retval, align 4
+  catchret from %2 to label %catchret.dest
+
+invoke.cont:                                      ; preds = %entry
+  store i32 0, i32* %retval, align 4
+  br label %return
+
+catchret.dest:                                    ; preds = %catch
+  br label %return
+
+try.cont:                                         ; No predecessors!
+  call void @llvm.trap()
+  unreachable
+
+return:                                           ; preds = %catchret.dest, %invoke.cont
+  %3 = load i32, i32* %retval, align 4
+  ret i32 %3
+}
+
+declare i32 @__CxxFrameHandler3(...)
+
+; Function Attrs: noreturn nounwind
+declare void @llvm.trap() #1
+
+; Function Attrs: noinline uwtable
+define i32 @1(i32 %i) #0 personality i8* bitcast (i32 (...)* @__CxxFrameHandler3 to i8*) {
+entry:
+  %retval = alloca i32, align 4
+  %i.addr = alloca i32, align 4
+  store i32 %i, i32* %i.addr, align 4
+  %0 = load i32, i32* %i.addr, align 4
+  %add = sub nsw i32 %0, 1
+  invoke void @"\01?raise@@YAXH@Z"(i32 %add)
+          to label %invoke.cont unwind label %catch.dispatch
+
+catch.dispatch:                                   ; preds = %entry
+  %1 = catchswitch within none [label %catch] unwind to caller
+
+catch:                                            ; preds = %catch.dispatch
+  %2 = catchpad within %1 [i8* null, i32 64, i8* null]
+  store i32 4, i32* %retval, align 4
+  catchret from %2 to label %catchret.dest
+
+invoke.cont:                                      ; preds = %entry
+  store i32 2, i32* %retval, align 4
+  br label %return
+
+catchret.dest:                                    ; preds = %catch
+  br label %return
+
+try.cont:                                         ; No predecessors!
+  call void @llvm.trap()
+  unreachable
+
+return:                                           ; preds = %catchret.dest, %invoke.cont
+  %3 = load i32, i32* %retval, align 4
+  ret i32 %3
+}
+
+; Function Attrs: noinline norecurse uwtable
+define i32 @main(i32 %argc) #2 {
+entry:
+  %retval = alloca i32, align 4
+  %argc.addr = alloca i32, align 4
+  store i32 0, i32* %retval, align 4
+  store i32 %argc, i32* %argc.addr, align 4
+  %0 = load i32, i32* %argc.addr, align 4
+  %call = call i32 @0(i32 %0)
+  %1 = load i32, i32* %argc.addr, align 4
+  %call1 = call i32 @1(i32 %1)
+  %add = add nsw i32 %call, %call1
+  ret i32 %add
+}
+
+attributes #0 = { noinline uwtable "correctly-rounded-divide-sqrt-fp-math"="false" "disable-tail-calls"="false" "less-precise-fpmad"="false" "no-frame-pointer-elim"="false" "no-infs-fp-math"="false" "no-jump-tables"="false" "no-nans-fp-math"="false" "no-signed-zeros-fp-math"="false" "no-trapping-math"="false" "stack-protector-buffer-size"="8" "target-cpu"="x86-64" "target-features"="+fxsr,+mmx,+sse,+sse2,+x87" "unsafe-fp-math"="false" "use-soft-float"="false" }
+attributes #1 = { noreturn nounwind }
+attributes #2 = { noinline norecurse uwtable "correctly-rounded-divide-sqrt-fp-math"="false" "disable-tail-calls"="false" "less-precise-fpmad"="false" "no-frame-pointer-elim"="false" "no-infs-fp-math"="false" "no-jump-tables"="false" "no-nans-fp-math"="false" "no-signed-zeros-fp-math"="false" "no-trapping-math"="false" "stack-protector-buffer-size"="8" "target-cpu"="x86-64" "target-features"="+fxsr,+mmx,+sse,+sse2,+x87" "unsafe-fp-math"="false" "use-soft-float"="false" }
+attributes #3 = { noreturn }
+
+!llvm.module.flags = !{!0}
+
+!0 = !{i32 1, !"PIC Level", i32 2}