Reid Kleckner | 60b640b | 2015-05-28 22:47:01 +0000 | [diff] [blame] | 1 | //===-- CodeGen/AsmPrinter/WinException.cpp - Dwarf Exception Impl ------===// |
Charles Davis | 91ed799 | 2011-05-27 23:47:32 +0000 | [diff] [blame] | 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 contains support for writing Win64 exception info into asm files. |
| 11 | // |
| 12 | //===----------------------------------------------------------------------===// |
| 13 | |
Reid Kleckner | 60b640b | 2015-05-28 22:47:01 +0000 | [diff] [blame] | 14 | #include "WinException.h" |
Chandler Carruth | ed0881b | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 15 | #include "llvm/ADT/SmallString.h" |
| 16 | #include "llvm/ADT/StringExtras.h" |
| 17 | #include "llvm/ADT/Twine.h" |
Charles Davis | 91ed799 | 2011-05-27 23:47:32 +0000 | [diff] [blame] | 18 | #include "llvm/CodeGen/AsmPrinter.h" |
Charles Davis | 91ed799 | 2011-05-27 23:47:32 +0000 | [diff] [blame] | 19 | #include "llvm/CodeGen/MachineFrameInfo.h" |
| 20 | #include "llvm/CodeGen/MachineFunction.h" |
Chandler Carruth | ed0881b | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 21 | #include "llvm/CodeGen/MachineModuleInfo.h" |
David Majnemer | cde3303 | 2015-03-30 22:58:10 +0000 | [diff] [blame] | 22 | #include "llvm/CodeGen/WinEHFuncInfo.h" |
Chandler Carruth | 9fb823b | 2013-01-02 11:36:10 +0000 | [diff] [blame] | 23 | #include "llvm/IR/DataLayout.h" |
Rafael Espindola | 894843c | 2014-01-07 21:19:40 +0000 | [diff] [blame] | 24 | #include "llvm/IR/Mangler.h" |
Chandler Carruth | 9fb823b | 2013-01-02 11:36:10 +0000 | [diff] [blame] | 25 | #include "llvm/IR/Module.h" |
Charles Davis | 91ed799 | 2011-05-27 23:47:32 +0000 | [diff] [blame] | 26 | #include "llvm/MC/MCAsmInfo.h" |
| 27 | #include "llvm/MC/MCContext.h" |
| 28 | #include "llvm/MC/MCExpr.h" |
| 29 | #include "llvm/MC/MCSection.h" |
| 30 | #include "llvm/MC/MCStreamer.h" |
| 31 | #include "llvm/MC/MCSymbol.h" |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 32 | #include "llvm/MC/MCWin64EH.h" |
David Majnemer | a80c151 | 2015-09-29 20:12:33 +0000 | [diff] [blame] | 33 | #include "llvm/Support/COFF.h" |
Chandler Carruth | ed0881b | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 34 | #include "llvm/Support/Dwarf.h" |
| 35 | #include "llvm/Support/ErrorHandling.h" |
| 36 | #include "llvm/Support/FormattedStream.h" |
Charles Davis | 91ed799 | 2011-05-27 23:47:32 +0000 | [diff] [blame] | 37 | #include "llvm/Target/TargetFrameLowering.h" |
| 38 | #include "llvm/Target/TargetLoweringObjectFile.h" |
Charles Davis | 91ed799 | 2011-05-27 23:47:32 +0000 | [diff] [blame] | 39 | #include "llvm/Target/TargetOptions.h" |
| 40 | #include "llvm/Target/TargetRegisterInfo.h" |
Reid Kleckner | 70bf6bb | 2015-10-07 21:13:15 +0000 | [diff] [blame] | 41 | #include "llvm/Target/TargetSubtargetInfo.h" |
Charles Davis | 91ed799 | 2011-05-27 23:47:32 +0000 | [diff] [blame] | 42 | using namespace llvm; |
| 43 | |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 44 | WinException::WinException(AsmPrinter *A) : EHStreamer(A) { |
| 45 | // MSVC's EH tables are always composed of 32-bit words. All known 64-bit |
| 46 | // platforms use an imagerel32 relocation to refer to symbols. |
| 47 | useImageRel32 = (A->getDataLayout().getPointerSizeInBits() == 64); |
| 48 | } |
Charles Davis | 91ed799 | 2011-05-27 23:47:32 +0000 | [diff] [blame] | 49 | |
Reid Kleckner | 60b640b | 2015-05-28 22:47:01 +0000 | [diff] [blame] | 50 | WinException::~WinException() {} |
Charles Davis | 91ed799 | 2011-05-27 23:47:32 +0000 | [diff] [blame] | 51 | |
Timur Iskhodzhanov | 119f307 | 2013-11-26 13:34:55 +0000 | [diff] [blame] | 52 | /// endModule - Emit all exception information that should come after the |
Charles Davis | 91ed799 | 2011-05-27 23:47:32 +0000 | [diff] [blame] | 53 | /// content. |
Reid Kleckner | 60b640b | 2015-05-28 22:47:01 +0000 | [diff] [blame] | 54 | void WinException::endModule() { |
Reid Kleckner | 2bc93ca | 2015-06-10 01:02:30 +0000 | [diff] [blame] | 55 | auto &OS = *Asm->OutStreamer; |
| 56 | const Module *M = MMI->getModule(); |
Reid Kleckner | ca6ef66 | 2015-06-10 01:13:44 +0000 | [diff] [blame] | 57 | for (const Function &F : *M) |
| 58 | if (F.hasFnAttribute("safeseh")) |
Reid Kleckner | 2bc93ca | 2015-06-10 01:02:30 +0000 | [diff] [blame] | 59 | OS.EmitCOFFSafeSEH(Asm->getSymbol(&F)); |
Charles Davis | 91ed799 | 2011-05-27 23:47:32 +0000 | [diff] [blame] | 60 | } |
| 61 | |
Reid Kleckner | 60b640b | 2015-05-28 22:47:01 +0000 | [diff] [blame] | 62 | void WinException::beginFunction(const MachineFunction *MF) { |
Charles Davis | 5638b9f | 2011-05-28 04:21:04 +0000 | [diff] [blame] | 63 | shouldEmitMoves = shouldEmitPersonality = shouldEmitLSDA = false; |
| 64 | |
| 65 | // If any landing pads survive, we need an EH table. |
| 66 | bool hasLandingPads = !MMI->getLandingPads().empty(); |
Reid Kleckner | 0e28823 | 2015-08-27 23:27:47 +0000 | [diff] [blame] | 67 | bool hasEHFunclets = MMI->hasEHFunclets(); |
Charles Davis | 5638b9f | 2011-05-28 04:21:04 +0000 | [diff] [blame] | 68 | |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 69 | const Function *F = MF->getFunction(); |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 70 | |
Charles Davis | 5638b9f | 2011-05-28 04:21:04 +0000 | [diff] [blame] | 71 | shouldEmitMoves = Asm->needsSEHMoves(); |
| 72 | |
| 73 | const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering(); |
| 74 | unsigned PerEncoding = TLOF.getPersonalityEncoding(); |
Reid Kleckner | 9a1a919 | 2015-07-13 20:41:46 +0000 | [diff] [blame] | 75 | const Function *Per = nullptr; |
| 76 | if (F->hasPersonalityFn()) |
| 77 | Per = dyn_cast<Function>(F->getPersonalityFn()->stripPointerCasts()); |
Charles Davis | 5638b9f | 2011-05-28 04:21:04 +0000 | [diff] [blame] | 78 | |
Keno Fischer | aff703a | 2015-07-14 19:22:51 +0000 | [diff] [blame] | 79 | bool forceEmitPersonality = |
| 80 | F->hasPersonalityFn() && !isNoOpWithoutInvoke(classifyEHPersonality(Per)) && |
| 81 | F->needsUnwindTableEntry(); |
| 82 | |
Reid Kleckner | 0e28823 | 2015-08-27 23:27:47 +0000 | [diff] [blame] | 83 | shouldEmitPersonality = |
| 84 | forceEmitPersonality || ((hasLandingPads || hasEHFunclets) && |
| 85 | PerEncoding != dwarf::DW_EH_PE_omit && Per); |
Charles Davis | 5638b9f | 2011-05-28 04:21:04 +0000 | [diff] [blame] | 86 | |
| 87 | unsigned LSDAEncoding = TLOF.getLSDAEncoding(); |
| 88 | shouldEmitLSDA = shouldEmitPersonality && |
| 89 | LSDAEncoding != dwarf::DW_EH_PE_omit; |
| 90 | |
Reid Kleckner | 0e28823 | 2015-08-27 23:27:47 +0000 | [diff] [blame] | 91 | // If we're not using CFI, we don't want the CFI or the personality, but we |
| 92 | // might want EH tables if we had EH pads. |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 93 | if (!Asm->MAI->usesWindowsCFI()) { |
David Majnemer | bfa5b98 | 2015-10-10 00:04:29 +0000 | [diff] [blame] | 94 | shouldEmitLSDA = hasEHFunclets; |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 95 | shouldEmitPersonality = false; |
| 96 | return; |
| 97 | } |
David Majnemer | a225a19 | 2015-03-31 22:35:44 +0000 | [diff] [blame] | 98 | |
David Majnemer | a80c151 | 2015-09-29 20:12:33 +0000 | [diff] [blame] | 99 | beginFunclet(MF->front(), Asm->CurrentFnSym); |
Charles Davis | 91ed799 | 2011-05-27 23:47:32 +0000 | [diff] [blame] | 100 | } |
| 101 | |
Timur Iskhodzhanov | 119f307 | 2013-11-26 13:34:55 +0000 | [diff] [blame] | 102 | /// endFunction - Gather and emit post-function exception information. |
Charles Davis | 91ed799 | 2011-05-27 23:47:32 +0000 | [diff] [blame] | 103 | /// |
Reid Kleckner | 60b640b | 2015-05-28 22:47:01 +0000 | [diff] [blame] | 104 | void WinException::endFunction(const MachineFunction *MF) { |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 105 | if (!shouldEmitPersonality && !shouldEmitMoves && !shouldEmitLSDA) |
Charles Davis | 5638b9f | 2011-05-28 04:21:04 +0000 | [diff] [blame] | 106 | return; |
| 107 | |
Reid Kleckner | 9a1a919 | 2015-07-13 20:41:46 +0000 | [diff] [blame] | 108 | const Function *F = MF->getFunction(); |
| 109 | EHPersonality Per = EHPersonality::Unknown; |
| 110 | if (F->hasPersonalityFn()) |
| 111 | Per = classifyEHPersonality(F->getPersonalityFn()); |
Reid Kleckner | 3e9fadf | 2015-04-15 18:48:15 +0000 | [diff] [blame] | 112 | |
Joseph Tremoulet | 2afea54 | 2015-10-06 20:28:16 +0000 | [diff] [blame] | 113 | // Get rid of any dead landing pads if we're not using funclets. In funclet |
| 114 | // schemes, the landing pad is not actually reachable. It only exists so |
| 115 | // that we can emit the right table data. |
| 116 | if (!isFuncletEHPersonality(Per)) |
Reid Kleckner | 3e9fadf | 2015-04-15 18:48:15 +0000 | [diff] [blame] | 117 | MMI->TidyLandingPads(); |
Charles Davis | a575226 | 2011-05-30 00:13:34 +0000 | [diff] [blame] | 118 | |
David Majnemer | a80c151 | 2015-09-29 20:12:33 +0000 | [diff] [blame] | 119 | endFunclet(); |
| 120 | |
Reid Kleckner | fc64fae | 2015-10-01 21:38:24 +0000 | [diff] [blame] | 121 | // endFunclet will emit the necessary .xdata tables for x64 SEH. |
| 122 | if (Per == EHPersonality::MSVC_Win64SEH && MMI->hasEHFunclets()) |
| 123 | return; |
| 124 | |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 125 | if (shouldEmitPersonality || shouldEmitLSDA) { |
Lang Hames | 9ff69c8 | 2015-04-24 19:11:51 +0000 | [diff] [blame] | 126 | Asm->OutStreamer->PushSection(); |
Reid Kleckner | 0a57f65 | 2015-01-14 01:05:27 +0000 | [diff] [blame] | 127 | |
David Majnemer | a80c151 | 2015-09-29 20:12:33 +0000 | [diff] [blame] | 128 | // Just switch sections to the right xdata section. This use of CurrentFnSym |
| 129 | // assumes that we only emit the LSDA when ending the parent function. |
| 130 | MCSection *XData = WinEH::UnwindEmitter::getXDataSection(Asm->CurrentFnSym, |
| 131 | Asm->OutContext); |
| 132 | Asm->OutStreamer->SwitchSection(XData); |
Reid Kleckner | 0a57f65 | 2015-01-14 01:05:27 +0000 | [diff] [blame] | 133 | |
Reid Kleckner | 9b5eaf0 | 2015-01-14 18:50:10 +0000 | [diff] [blame] | 134 | // Emit the tables appropriate to the personality function in use. If we |
| 135 | // don't recognize the personality, assume it uses an Itanium-style LSDA. |
Reid Kleckner | 2d5fb68 | 2015-02-14 00:21:02 +0000 | [diff] [blame] | 136 | if (Per == EHPersonality::MSVC_Win64SEH) |
Reid Kleckner | 94b704c | 2015-09-09 21:10:03 +0000 | [diff] [blame] | 137 | emitCSpecificHandlerTable(MF); |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 138 | else if (Per == EHPersonality::MSVC_X86SEH) |
Reid Kleckner | f12c030 | 2015-06-09 21:42:19 +0000 | [diff] [blame] | 139 | emitExceptHandlerTable(MF); |
David Majnemer | cde3303 | 2015-03-30 22:58:10 +0000 | [diff] [blame] | 140 | else if (Per == EHPersonality::MSVC_CXX) |
| 141 | emitCXXFrameHandler3Table(MF); |
Joseph Tremoulet | 28c89bb | 2015-10-13 20:18:27 +0000 | [diff] [blame] | 142 | else if (Per == EHPersonality::CoreCLR) |
| 143 | emitCLRExceptionTable(MF); |
Reid Kleckner | 9b5eaf0 | 2015-01-14 18:50:10 +0000 | [diff] [blame] | 144 | else |
Reid Kleckner | 0a57f65 | 2015-01-14 01:05:27 +0000 | [diff] [blame] | 145 | emitExceptionTable(); |
Reid Kleckner | 0a57f65 | 2015-01-14 01:05:27 +0000 | [diff] [blame] | 146 | |
Lang Hames | 9ff69c8 | 2015-04-24 19:11:51 +0000 | [diff] [blame] | 147 | Asm->OutStreamer->PopSection(); |
Charles Davis | a575226 | 2011-05-30 00:13:34 +0000 | [diff] [blame] | 148 | } |
David Majnemer | a80c151 | 2015-09-29 20:12:33 +0000 | [diff] [blame] | 149 | } |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 150 | |
David Majnemer | 99c1d13 | 2015-10-12 16:44:22 +0000 | [diff] [blame] | 151 | /// Retreive the MCSymbol for a GlobalValue or MachineBasicBlock. |
David Majnemer | bfa5b98 | 2015-10-10 00:04:29 +0000 | [diff] [blame] | 152 | static MCSymbol *getMCSymbolForMBB(AsmPrinter *Asm, |
| 153 | const MachineBasicBlock *MBB) { |
| 154 | if (!MBB) |
David Majnemer | a80c151 | 2015-09-29 20:12:33 +0000 | [diff] [blame] | 155 | return nullptr; |
David Majnemer | a80c151 | 2015-09-29 20:12:33 +0000 | [diff] [blame] | 156 | |
David Majnemer | bfa5b98 | 2015-10-10 00:04:29 +0000 | [diff] [blame] | 157 | assert(MBB->isEHFuncletEntry()); |
| 158 | |
| 159 | // Give catches and cleanups a name based off of their parent function and |
| 160 | // their funclet entry block's number. |
| 161 | const MachineFunction *MF = MBB->getParent(); |
| 162 | const Function *F = MF->getFunction(); |
| 163 | StringRef FuncLinkageName = GlobalValue::getRealLinkageName(F->getName()); |
| 164 | MCContext &Ctx = MF->getContext(); |
| 165 | StringRef HandlerPrefix = MBB->isCleanupFuncletEntry() ? "dtor" : "catch"; |
| 166 | return Ctx.getOrCreateSymbol("?" + HandlerPrefix + "$" + |
| 167 | Twine(MBB->getNumber()) + "@?0?" + |
| 168 | FuncLinkageName + "@4HA"); |
David Majnemer | a80c151 | 2015-09-29 20:12:33 +0000 | [diff] [blame] | 169 | } |
| 170 | |
| 171 | void WinException::beginFunclet(const MachineBasicBlock &MBB, |
| 172 | MCSymbol *Sym) { |
| 173 | CurrentFuncletEntry = &MBB; |
| 174 | |
| 175 | const Function *F = Asm->MF->getFunction(); |
| 176 | // If a symbol was not provided for the funclet, invent one. |
| 177 | if (!Sym) { |
David Majnemer | bfa5b98 | 2015-10-10 00:04:29 +0000 | [diff] [blame] | 178 | Sym = getMCSymbolForMBB(Asm, &MBB); |
David Majnemer | a80c151 | 2015-09-29 20:12:33 +0000 | [diff] [blame] | 179 | |
| 180 | // Describe our funclet symbol as a function with internal linkage. |
| 181 | Asm->OutStreamer->BeginCOFFSymbolDef(Sym); |
| 182 | Asm->OutStreamer->EmitCOFFSymbolStorageClass(COFF::IMAGE_SYM_CLASS_STATIC); |
| 183 | Asm->OutStreamer->EmitCOFFSymbolType(COFF::IMAGE_SYM_DTYPE_FUNCTION |
| 184 | << COFF::SCT_COMPLEX_TYPE_SHIFT); |
| 185 | Asm->OutStreamer->EndCOFFSymbolDef(); |
| 186 | |
| 187 | // We want our funclet's entry point to be aligned such that no nops will be |
| 188 | // present after the label. |
| 189 | Asm->EmitAlignment(std::max(Asm->MF->getAlignment(), MBB.getAlignment()), |
| 190 | F); |
| 191 | |
| 192 | // Now that we've emitted the alignment directive, point at our funclet. |
| 193 | Asm->OutStreamer->EmitLabel(Sym); |
| 194 | } |
| 195 | |
| 196 | // Mark 'Sym' as starting our funclet. |
David Majnemer | 0e70598 | 2015-09-11 17:34:34 +0000 | [diff] [blame] | 197 | if (shouldEmitMoves || shouldEmitPersonality) |
David Majnemer | a80c151 | 2015-09-29 20:12:33 +0000 | [diff] [blame] | 198 | Asm->OutStreamer->EmitWinCFIStartProc(Sym); |
| 199 | |
| 200 | if (shouldEmitPersonality) { |
| 201 | const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering(); |
| 202 | const Function *PerFn = nullptr; |
| 203 | |
| 204 | // Determine which personality routine we are using for this funclet. |
| 205 | if (F->hasPersonalityFn()) |
| 206 | PerFn = dyn_cast<Function>(F->getPersonalityFn()->stripPointerCasts()); |
| 207 | const MCSymbol *PersHandlerSym = |
| 208 | TLOF.getCFIPersonalitySymbol(PerFn, *Asm->Mang, Asm->TM, MMI); |
| 209 | |
| 210 | // Classify the personality routine so that we may reason about it. |
| 211 | EHPersonality Per = EHPersonality::Unknown; |
| 212 | if (F->hasPersonalityFn()) |
| 213 | Per = classifyEHPersonality(F->getPersonalityFn()); |
| 214 | |
| 215 | // Do not emit a .seh_handler directive if it is a C++ cleanup funclet. |
| 216 | if (Per != EHPersonality::MSVC_CXX || |
| 217 | !CurrentFuncletEntry->isCleanupFuncletEntry()) |
| 218 | Asm->OutStreamer->EmitWinEHHandler(PersHandlerSym, true, true); |
| 219 | } |
| 220 | } |
| 221 | |
| 222 | void WinException::endFunclet() { |
| 223 | // No funclet to process? Great, we have nothing to do. |
| 224 | if (!CurrentFuncletEntry) |
| 225 | return; |
| 226 | |
| 227 | if (shouldEmitMoves || shouldEmitPersonality) { |
| 228 | const Function *F = Asm->MF->getFunction(); |
| 229 | EHPersonality Per = EHPersonality::Unknown; |
| 230 | if (F->hasPersonalityFn()) |
| 231 | Per = classifyEHPersonality(F->getPersonalityFn()); |
| 232 | |
| 233 | // The .seh_handlerdata directive implicitly switches section, push the |
| 234 | // current section so that we may return to it. |
| 235 | Asm->OutStreamer->PushSection(); |
| 236 | |
| 237 | // Emit an UNWIND_INFO struct describing the prologue. |
| 238 | Asm->OutStreamer->EmitWinEHHandlerData(); |
| 239 | |
David Majnemer | a80c151 | 2015-09-29 20:12:33 +0000 | [diff] [blame] | 240 | if (Per == EHPersonality::MSVC_CXX && shouldEmitPersonality && |
| 241 | !CurrentFuncletEntry->isCleanupFuncletEntry()) { |
Reid Kleckner | fc64fae | 2015-10-01 21:38:24 +0000 | [diff] [blame] | 242 | // If this is a C++ catch funclet (or the parent function), |
| 243 | // emit a reference to the LSDA for the parent function. |
David Majnemer | a80c151 | 2015-09-29 20:12:33 +0000 | [diff] [blame] | 244 | StringRef FuncLinkageName = GlobalValue::getRealLinkageName(F->getName()); |
| 245 | MCSymbol *FuncInfoXData = Asm->OutContext.getOrCreateSymbol( |
| 246 | Twine("$cppxdata$", FuncLinkageName)); |
| 247 | Asm->OutStreamer->EmitValue(create32bitRef(FuncInfoXData), 4); |
Reid Kleckner | fc64fae | 2015-10-01 21:38:24 +0000 | [diff] [blame] | 248 | } else if (Per == EHPersonality::MSVC_Win64SEH && MMI->hasEHFunclets() && |
| 249 | !CurrentFuncletEntry->isEHFuncletEntry()) { |
| 250 | // If this is the parent function in Win64 SEH, emit the LSDA immediately |
| 251 | // following .seh_handlerdata. |
| 252 | emitCSpecificHandlerTable(Asm->MF); |
David Majnemer | a80c151 | 2015-09-29 20:12:33 +0000 | [diff] [blame] | 253 | } |
| 254 | |
| 255 | // Switch back to the previous section now that we are done writing to |
| 256 | // .xdata. |
| 257 | Asm->OutStreamer->PopSection(); |
| 258 | |
| 259 | // Emit a .seh_endproc directive to mark the end of the function. |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 260 | Asm->OutStreamer->EmitWinCFIEndProc(); |
David Majnemer | a80c151 | 2015-09-29 20:12:33 +0000 | [diff] [blame] | 261 | } |
| 262 | |
| 263 | // Let's make sure we don't try to end the same funclet twice. |
| 264 | CurrentFuncletEntry = nullptr; |
Charles Davis | 91ed799 | 2011-05-27 23:47:32 +0000 | [diff] [blame] | 265 | } |
Reid Kleckner | 0a57f65 | 2015-01-14 01:05:27 +0000 | [diff] [blame] | 266 | |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 267 | const MCExpr *WinException::create32bitRef(const MCSymbol *Value) { |
David Majnemer | cde3303 | 2015-03-30 22:58:10 +0000 | [diff] [blame] | 268 | if (!Value) |
Jim Grosbach | 13760bd | 2015-05-30 01:25:56 +0000 | [diff] [blame] | 269 | return MCConstantExpr::create(0, Asm->OutContext); |
| 270 | return MCSymbolRefExpr::create(Value, useImageRel32 |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 271 | ? MCSymbolRefExpr::VK_COFF_IMGREL32 |
| 272 | : MCSymbolRefExpr::VK_None, |
Reid Kleckner | 0a57f65 | 2015-01-14 01:05:27 +0000 | [diff] [blame] | 273 | Asm->OutContext); |
| 274 | } |
| 275 | |
Joseph Tremoulet | 3d0fbf1 | 2015-10-23 15:06:05 +0000 | [diff] [blame] | 276 | const MCExpr *WinException::create32bitRef(const GlobalValue *GV) { |
| 277 | if (!GV) |
Jim Grosbach | 13760bd | 2015-05-30 01:25:56 +0000 | [diff] [blame] | 278 | return MCConstantExpr::create(0, Asm->OutContext); |
Joseph Tremoulet | 3d0fbf1 | 2015-10-23 15:06:05 +0000 | [diff] [blame] | 279 | return create32bitRef(Asm->getSymbol(GV)); |
David Majnemer | cde3303 | 2015-03-30 22:58:10 +0000 | [diff] [blame] | 280 | } |
| 281 | |
Joseph Tremoulet | 1e2f062 | 2015-10-13 16:44:30 +0000 | [diff] [blame] | 282 | const MCExpr *WinException::getLabelPlusOne(const MCSymbol *Label) { |
Reid Kleckner | c71d627 | 2015-09-28 23:56:30 +0000 | [diff] [blame] | 283 | return MCBinaryExpr::createAdd(create32bitRef(Label), |
| 284 | MCConstantExpr::create(1, Asm->OutContext), |
| 285 | Asm->OutContext); |
| 286 | } |
| 287 | |
Joseph Tremoulet | 28c89bb | 2015-10-13 20:18:27 +0000 | [diff] [blame] | 288 | const MCExpr *WinException::getOffset(const MCSymbol *OffsetOf, |
| 289 | const MCSymbol *OffsetFrom) { |
| 290 | return MCBinaryExpr::createSub( |
| 291 | MCSymbolRefExpr::create(OffsetOf, Asm->OutContext), |
| 292 | MCSymbolRefExpr::create(OffsetFrom, Asm->OutContext), Asm->OutContext); |
| 293 | } |
| 294 | |
| 295 | const MCExpr *WinException::getOffsetPlusOne(const MCSymbol *OffsetOf, |
| 296 | const MCSymbol *OffsetFrom) { |
| 297 | return MCBinaryExpr::createAdd(getOffset(OffsetOf, OffsetFrom), |
| 298 | MCConstantExpr::create(1, Asm->OutContext), |
| 299 | Asm->OutContext); |
| 300 | } |
| 301 | |
Reid Kleckner | c20276d | 2015-11-17 21:10:25 +0000 | [diff] [blame] | 302 | int WinException::getFrameIndexOffset(int FrameIndex, |
| 303 | const WinEHFuncInfo &FuncInfo) { |
Reid Kleckner | 70bf6bb | 2015-10-07 21:13:15 +0000 | [diff] [blame] | 304 | const TargetFrameLowering &TFI = *Asm->MF->getSubtarget().getFrameLowering(); |
| 305 | unsigned UnusedReg; |
| 306 | if (Asm->MAI->usesWindowsCFI()) |
| 307 | return TFI.getFrameIndexReferenceFromSP(*Asm->MF, FrameIndex, UnusedReg); |
Reid Kleckner | 6ddae31 | 2015-11-05 21:09:49 +0000 | [diff] [blame] | 308 | // For 32-bit, offsets should be relative to the end of the EH registration |
| 309 | // node. For 64-bit, it's relative to SP at the end of the prologue. |
| 310 | assert(FuncInfo.EHRegNodeEndOffset != INT_MAX); |
| 311 | int Offset = TFI.getFrameIndexReference(*Asm->MF, FrameIndex, UnusedReg); |
| 312 | Offset += FuncInfo.EHRegNodeEndOffset; |
| 313 | return Offset; |
Reid Kleckner | 70bf6bb | 2015-10-07 21:13:15 +0000 | [diff] [blame] | 314 | } |
| 315 | |
Benjamin Kramer | 808d2a0 | 2015-10-05 21:20:26 +0000 | [diff] [blame] | 316 | namespace { |
Reid Kleckner | fc64fae | 2015-10-01 21:38:24 +0000 | [diff] [blame] | 317 | |
Joseph Tremoulet | 1e2f062 | 2015-10-13 16:44:30 +0000 | [diff] [blame] | 318 | /// Top-level state used to represent unwind to caller |
| 319 | const int NullState = -1; |
| 320 | |
| 321 | struct InvokeStateChange { |
| 322 | /// EH Label immediately after the last invoke in the previous state, or |
| 323 | /// nullptr if the previous state was the null state. |
| 324 | const MCSymbol *PreviousEndLabel; |
| 325 | |
| 326 | /// EH label immediately before the first invoke in the new state, or nullptr |
| 327 | /// if the new state is the null state. |
| 328 | const MCSymbol *NewStartLabel; |
| 329 | |
| 330 | /// State of the invoke following NewStartLabel, or NullState to indicate |
| 331 | /// the presence of calls which may unwind to caller. |
| 332 | int NewState; |
Reid Kleckner | fc64fae | 2015-10-01 21:38:24 +0000 | [diff] [blame] | 333 | }; |
| 334 | |
Joseph Tremoulet | 1e2f062 | 2015-10-13 16:44:30 +0000 | [diff] [blame] | 335 | /// Iterator that reports all the invoke state changes in a range of machine |
| 336 | /// basic blocks. Changes to the null state are reported whenever a call that |
| 337 | /// may unwind to caller is encountered. The MBB range is expected to be an |
| 338 | /// entire function or funclet, and the start and end of the range are treated |
| 339 | /// as being in the NullState even if there's not an unwind-to-caller call |
| 340 | /// before the first invoke or after the last one (i.e., the first state change |
| 341 | /// reported is the first change to something other than NullState, and a |
| 342 | /// change back to NullState is always reported at the end of iteration). |
| 343 | class InvokeStateChangeIterator { |
Reid Kleckner | c20276d | 2015-11-17 21:10:25 +0000 | [diff] [blame] | 344 | InvokeStateChangeIterator(const WinEHFuncInfo &EHInfo, |
Joseph Tremoulet | 1e2f062 | 2015-10-13 16:44:30 +0000 | [diff] [blame] | 345 | MachineFunction::const_iterator MFI, |
| 346 | MachineFunction::const_iterator MFE, |
| 347 | MachineBasicBlock::const_iterator MBBI) |
| 348 | : EHInfo(EHInfo), MFI(MFI), MFE(MFE), MBBI(MBBI) { |
| 349 | LastStateChange.PreviousEndLabel = nullptr; |
| 350 | LastStateChange.NewStartLabel = nullptr; |
| 351 | LastStateChange.NewState = NullState; |
Reid Kleckner | fc64fae | 2015-10-01 21:38:24 +0000 | [diff] [blame] | 352 | scan(); |
| 353 | } |
| 354 | |
Joseph Tremoulet | 1e2f062 | 2015-10-13 16:44:30 +0000 | [diff] [blame] | 355 | public: |
| 356 | static iterator_range<InvokeStateChangeIterator> |
Reid Kleckner | c20276d | 2015-11-17 21:10:25 +0000 | [diff] [blame] | 357 | range(const WinEHFuncInfo &EHInfo, const MachineFunction &MF) { |
Joseph Tremoulet | 1e2f062 | 2015-10-13 16:44:30 +0000 | [diff] [blame] | 358 | // Reject empty MFs to simplify bookkeeping by ensuring that we can get the |
| 359 | // end of the last block. |
| 360 | assert(!MF.empty()); |
| 361 | auto FuncBegin = MF.begin(); |
| 362 | auto FuncEnd = MF.end(); |
| 363 | auto BlockBegin = FuncBegin->begin(); |
| 364 | auto BlockEnd = MF.back().end(); |
| 365 | return make_range( |
| 366 | InvokeStateChangeIterator(EHInfo, FuncBegin, FuncEnd, BlockBegin), |
| 367 | InvokeStateChangeIterator(EHInfo, FuncEnd, FuncEnd, BlockEnd)); |
| 368 | } |
| 369 | static iterator_range<InvokeStateChangeIterator> |
Reid Kleckner | c20276d | 2015-11-17 21:10:25 +0000 | [diff] [blame] | 370 | range(const WinEHFuncInfo &EHInfo, MachineFunction::const_iterator Begin, |
Joseph Tremoulet | 1e2f062 | 2015-10-13 16:44:30 +0000 | [diff] [blame] | 371 | MachineFunction::const_iterator End) { |
| 372 | // Reject empty ranges to simplify bookkeeping by ensuring that we can get |
| 373 | // the end of the last block. |
| 374 | assert(Begin != End); |
| 375 | auto BlockBegin = Begin->begin(); |
| 376 | auto BlockEnd = std::prev(End)->end(); |
| 377 | return make_range(InvokeStateChangeIterator(EHInfo, Begin, End, BlockBegin), |
| 378 | InvokeStateChangeIterator(EHInfo, End, End, BlockEnd)); |
| 379 | } |
| 380 | |
Reid Kleckner | fc64fae | 2015-10-01 21:38:24 +0000 | [diff] [blame] | 381 | // Iterator methods. |
Joseph Tremoulet | 1e2f062 | 2015-10-13 16:44:30 +0000 | [diff] [blame] | 382 | bool operator==(const InvokeStateChangeIterator &O) const { |
| 383 | // Must be visiting same block. |
| 384 | if (MFI != O.MFI) |
| 385 | return false; |
| 386 | // Must be visiting same isntr. |
| 387 | if (MBBI != O.MBBI) |
| 388 | return false; |
| 389 | // At end of block/instr iteration, we can still have two distinct states: |
| 390 | // one to report the final EndLabel, and another indicating the end of the |
| 391 | // state change iteration. Check for CurrentEndLabel equality to |
| 392 | // distinguish these. |
| 393 | return CurrentEndLabel == O.CurrentEndLabel; |
| 394 | } |
| 395 | |
| 396 | bool operator!=(const InvokeStateChangeIterator &O) const { |
| 397 | return !operator==(O); |
| 398 | } |
| 399 | InvokeStateChange &operator*() { return LastStateChange; } |
| 400 | InvokeStateChange *operator->() { return &LastStateChange; } |
| 401 | InvokeStateChangeIterator &operator++() { return scan(); } |
Reid Kleckner | fc64fae | 2015-10-01 21:38:24 +0000 | [diff] [blame] | 402 | |
| 403 | private: |
Joseph Tremoulet | 1e2f062 | 2015-10-13 16:44:30 +0000 | [diff] [blame] | 404 | InvokeStateChangeIterator &scan(); |
Reid Kleckner | fc64fae | 2015-10-01 21:38:24 +0000 | [diff] [blame] | 405 | |
Reid Kleckner | c20276d | 2015-11-17 21:10:25 +0000 | [diff] [blame] | 406 | const WinEHFuncInfo &EHInfo; |
Joseph Tremoulet | 1e2f062 | 2015-10-13 16:44:30 +0000 | [diff] [blame] | 407 | const MCSymbol *CurrentEndLabel = nullptr; |
| 408 | MachineFunction::const_iterator MFI; |
| 409 | MachineFunction::const_iterator MFE; |
Reid Kleckner | fc64fae | 2015-10-01 21:38:24 +0000 | [diff] [blame] | 410 | MachineBasicBlock::const_iterator MBBI; |
Joseph Tremoulet | 1e2f062 | 2015-10-13 16:44:30 +0000 | [diff] [blame] | 411 | InvokeStateChange LastStateChange; |
| 412 | bool VisitingInvoke = false; |
Reid Kleckner | fc64fae | 2015-10-01 21:38:24 +0000 | [diff] [blame] | 413 | }; |
Joseph Tremoulet | 1e2f062 | 2015-10-13 16:44:30 +0000 | [diff] [blame] | 414 | |
Benjamin Kramer | 808d2a0 | 2015-10-05 21:20:26 +0000 | [diff] [blame] | 415 | } // end anonymous namespace |
Reid Kleckner | fc64fae | 2015-10-01 21:38:24 +0000 | [diff] [blame] | 416 | |
Joseph Tremoulet | 1e2f062 | 2015-10-13 16:44:30 +0000 | [diff] [blame] | 417 | InvokeStateChangeIterator &InvokeStateChangeIterator::scan() { |
| 418 | bool IsNewBlock = false; |
| 419 | for (; MFI != MFE; ++MFI, IsNewBlock = true) { |
| 420 | if (IsNewBlock) |
| 421 | MBBI = MFI->begin(); |
| 422 | for (auto MBBE = MFI->end(); MBBI != MBBE; ++MBBI) { |
| 423 | const MachineInstr &MI = *MBBI; |
| 424 | if (!VisitingInvoke && LastStateChange.NewState != NullState && |
| 425 | MI.isCall() && !EHStreamer::callToNoUnwindFunction(&MI)) { |
| 426 | // Indicate a change of state to the null state. We don't have |
| 427 | // start/end EH labels handy but the caller won't expect them for |
| 428 | // null state regions. |
| 429 | LastStateChange.PreviousEndLabel = CurrentEndLabel; |
| 430 | LastStateChange.NewStartLabel = nullptr; |
| 431 | LastStateChange.NewState = NullState; |
| 432 | CurrentEndLabel = nullptr; |
| 433 | // Don't re-visit this instr on the next scan |
| 434 | ++MBBI; |
| 435 | return *this; |
| 436 | } |
Reid Kleckner | fc64fae | 2015-10-01 21:38:24 +0000 | [diff] [blame] | 437 | |
Joseph Tremoulet | 1e2f062 | 2015-10-13 16:44:30 +0000 | [diff] [blame] | 438 | // All other state changes are at EH labels before/after invokes. |
| 439 | if (!MI.isEHLabel()) |
| 440 | continue; |
| 441 | MCSymbol *Label = MI.getOperand(0).getMCSymbol(); |
| 442 | if (Label == CurrentEndLabel) { |
| 443 | VisitingInvoke = false; |
| 444 | continue; |
| 445 | } |
| 446 | auto InvokeMapIter = EHInfo.InvokeToStateMap.find(Label); |
| 447 | // Ignore EH labels that aren't the ones inserted before an invoke |
| 448 | if (InvokeMapIter == EHInfo.InvokeToStateMap.end()) |
| 449 | continue; |
| 450 | auto &StateAndEnd = InvokeMapIter->second; |
| 451 | int NewState = StateAndEnd.first; |
| 452 | // Ignore EH labels explicitly annotated with the null state (which |
| 453 | // can happen for invokes that unwind to a chain of endpads the last |
| 454 | // of which unwinds to caller). We'll see the subsequent invoke and |
| 455 | // report a transition to the null state same as we do for calls. |
| 456 | if (NewState == NullState) |
| 457 | continue; |
| 458 | // Keep track of the fact that we're between EH start/end labels so |
| 459 | // we know not to treat the inoke we'll see as unwinding to caller. |
| 460 | VisitingInvoke = true; |
| 461 | if (NewState == LastStateChange.NewState) { |
| 462 | // The state isn't actually changing here. Record the new end and |
| 463 | // keep going. |
| 464 | CurrentEndLabel = StateAndEnd.second; |
| 465 | continue; |
| 466 | } |
| 467 | // Found a state change to report |
| 468 | LastStateChange.PreviousEndLabel = CurrentEndLabel; |
| 469 | LastStateChange.NewStartLabel = Label; |
| 470 | LastStateChange.NewState = NewState; |
| 471 | // Start keeping track of the new current end |
| 472 | CurrentEndLabel = StateAndEnd.second; |
| 473 | // Don't re-visit this instr on the next scan |
| 474 | ++MBBI; |
| 475 | return *this; |
Reid Kleckner | fc64fae | 2015-10-01 21:38:24 +0000 | [diff] [blame] | 476 | } |
Reid Kleckner | fc64fae | 2015-10-01 21:38:24 +0000 | [diff] [blame] | 477 | } |
Joseph Tremoulet | 1e2f062 | 2015-10-13 16:44:30 +0000 | [diff] [blame] | 478 | // Iteration hit the end of the block range. |
| 479 | if (LastStateChange.NewState != NullState) { |
| 480 | // Report the end of the last new state |
| 481 | LastStateChange.PreviousEndLabel = CurrentEndLabel; |
| 482 | LastStateChange.NewStartLabel = nullptr; |
| 483 | LastStateChange.NewState = NullState; |
| 484 | // Leave CurrentEndLabel non-null to distinguish this state from end. |
| 485 | assert(CurrentEndLabel != nullptr); |
Reid Kleckner | fc64fae | 2015-10-01 21:38:24 +0000 | [diff] [blame] | 486 | return *this; |
| 487 | } |
Joseph Tremoulet | 1e2f062 | 2015-10-13 16:44:30 +0000 | [diff] [blame] | 488 | // We've reported all state changes and hit the end state. |
| 489 | CurrentEndLabel = nullptr; |
Reid Kleckner | fc64fae | 2015-10-01 21:38:24 +0000 | [diff] [blame] | 490 | return *this; |
| 491 | } |
| 492 | |
Reid Kleckner | 0a57f65 | 2015-01-14 01:05:27 +0000 | [diff] [blame] | 493 | /// Emit the language-specific data that __C_specific_handler expects. This |
| 494 | /// handler lives in the x64 Microsoft C runtime and allows catching or cleaning |
| 495 | /// up after faults with __try, __except, and __finally. The typeinfo values |
| 496 | /// are not really RTTI data, but pointers to filter functions that return an |
| 497 | /// integer (1, 0, or -1) indicating how to handle the exception. For __finally |
| 498 | /// blocks and other cleanups, the landing pad label is zero, and the filter |
| 499 | /// function is actually a cleanup handler with the same prototype. A catch-all |
| 500 | /// entry is modeled with a null filter function field and a non-zero landing |
| 501 | /// pad label. |
| 502 | /// |
| 503 | /// Possible filter function return values: |
| 504 | /// EXCEPTION_EXECUTE_HANDLER (1): |
| 505 | /// Jump to the landing pad label after cleanups. |
| 506 | /// EXCEPTION_CONTINUE_SEARCH (0): |
| 507 | /// Continue searching this table or continue unwinding. |
| 508 | /// EXCEPTION_CONTINUE_EXECUTION (-1): |
| 509 | /// Resume execution at the trapping PC. |
| 510 | /// |
| 511 | /// Inferred table structure: |
| 512 | /// struct Table { |
| 513 | /// int NumEntries; |
| 514 | /// struct Entry { |
| 515 | /// imagerel32 LabelStart; |
| 516 | /// imagerel32 LabelEnd; |
Reid Kleckner | f690f50 | 2015-01-22 02:27:44 +0000 | [diff] [blame] | 517 | /// imagerel32 FilterOrFinally; // One means catch-all. |
Reid Kleckner | 14e7735 | 2015-10-09 23:34:53 +0000 | [diff] [blame] | 518 | /// imagerel32 LabelLPad; // Zero means __finally. |
Reid Kleckner | 0a57f65 | 2015-01-14 01:05:27 +0000 | [diff] [blame] | 519 | /// } Entries[NumEntries]; |
| 520 | /// }; |
Reid Kleckner | 94b704c | 2015-09-09 21:10:03 +0000 | [diff] [blame] | 521 | void WinException::emitCSpecificHandlerTable(const MachineFunction *MF) { |
Reid Kleckner | fc64fae | 2015-10-01 21:38:24 +0000 | [diff] [blame] | 522 | auto &OS = *Asm->OutStreamer; |
| 523 | MCContext &Ctx = Asm->OutContext; |
Reid Kleckner | 0a57f65 | 2015-01-14 01:05:27 +0000 | [diff] [blame] | 524 | |
Reid Kleckner | c20276d | 2015-11-17 21:10:25 +0000 | [diff] [blame] | 525 | const WinEHFuncInfo &FuncInfo = *MF->getWinEHFuncInfo(); |
Reid Kleckner | 14e7735 | 2015-10-09 23:34:53 +0000 | [diff] [blame] | 526 | // Use the assembler to compute the number of table entries through label |
| 527 | // difference and division. |
| 528 | MCSymbol *TableBegin = |
| 529 | Ctx.createTempSymbol("lsda_begin", /*AlwaysAddSuffix=*/true); |
| 530 | MCSymbol *TableEnd = |
| 531 | Ctx.createTempSymbol("lsda_end", /*AlwaysAddSuffix=*/true); |
Joseph Tremoulet | 28c89bb | 2015-10-13 20:18:27 +0000 | [diff] [blame] | 532 | const MCExpr *LabelDiff = getOffset(TableEnd, TableBegin); |
Reid Kleckner | 14e7735 | 2015-10-09 23:34:53 +0000 | [diff] [blame] | 533 | const MCExpr *EntrySize = MCConstantExpr::create(16, Ctx); |
| 534 | const MCExpr *EntryCount = MCBinaryExpr::createDiv(LabelDiff, EntrySize, Ctx); |
| 535 | OS.EmitValue(EntryCount, 4); |
Reid Kleckner | fc64fae | 2015-10-01 21:38:24 +0000 | [diff] [blame] | 536 | |
Reid Kleckner | 14e7735 | 2015-10-09 23:34:53 +0000 | [diff] [blame] | 537 | OS.EmitLabel(TableBegin); |
Reid Kleckner | eb7cd6c | 2015-10-09 23:05:54 +0000 | [diff] [blame] | 538 | |
Reid Kleckner | 14e7735 | 2015-10-09 23:34:53 +0000 | [diff] [blame] | 539 | // Iterate over all the invoke try ranges. Unlike MSVC, LLVM currently only |
| 540 | // models exceptions from invokes. LLVM also allows arbitrary reordering of |
| 541 | // the code, so our tables end up looking a bit different. Rather than |
| 542 | // trying to match MSVC's tables exactly, we emit a denormalized table. For |
| 543 | // each range of invokes in the same state, we emit table entries for all |
| 544 | // the actions that would be taken in that state. This means our tables are |
| 545 | // slightly bigger, which is OK. |
Joseph Tremoulet | 1e2f062 | 2015-10-13 16:44:30 +0000 | [diff] [blame] | 546 | const MCSymbol *LastStartLabel = nullptr; |
| 547 | int LastEHState = -1; |
| 548 | // Break out before we enter into a finally funclet. |
| 549 | // FIXME: We need to emit separate EH tables for cleanups. |
| 550 | MachineFunction::const_iterator End = MF->end(); |
| 551 | MachineFunction::const_iterator Stop = std::next(MF->begin()); |
| 552 | while (Stop != End && !Stop->isEHFuncletEntry()) |
| 553 | ++Stop; |
| 554 | for (const auto &StateChange : |
| 555 | InvokeStateChangeIterator::range(FuncInfo, MF->begin(), Stop)) { |
| 556 | // Emit all the actions for the state we just transitioned out of |
| 557 | // if it was not the null state |
| 558 | if (LastEHState != -1) |
| 559 | emitSEHActionsForRange(FuncInfo, LastStartLabel, |
| 560 | StateChange.PreviousEndLabel, LastEHState); |
| 561 | LastStartLabel = StateChange.NewStartLabel; |
| 562 | LastEHState = StateChange.NewState; |
Reid Kleckner | 0a57f65 | 2015-01-14 01:05:27 +0000 | [diff] [blame] | 563 | } |
Reid Kleckner | 14e7735 | 2015-10-09 23:34:53 +0000 | [diff] [blame] | 564 | |
Reid Kleckner | 14e7735 | 2015-10-09 23:34:53 +0000 | [diff] [blame] | 565 | OS.EmitLabel(TableEnd); |
Reid Kleckner | 0a57f65 | 2015-01-14 01:05:27 +0000 | [diff] [blame] | 566 | } |
David Majnemer | cde3303 | 2015-03-30 22:58:10 +0000 | [diff] [blame] | 567 | |
Reid Kleckner | c20276d | 2015-11-17 21:10:25 +0000 | [diff] [blame] | 568 | void WinException::emitSEHActionsForRange(const WinEHFuncInfo &FuncInfo, |
Joseph Tremoulet | 1e2f062 | 2015-10-13 16:44:30 +0000 | [diff] [blame] | 569 | const MCSymbol *BeginLabel, |
| 570 | const MCSymbol *EndLabel, int State) { |
Reid Kleckner | d880dc7 | 2015-10-09 20:39:39 +0000 | [diff] [blame] | 571 | auto &OS = *Asm->OutStreamer; |
| 572 | MCContext &Ctx = Asm->OutContext; |
| 573 | |
| 574 | assert(BeginLabel && EndLabel); |
| 575 | while (State != -1) { |
Reid Kleckner | c20276d | 2015-11-17 21:10:25 +0000 | [diff] [blame] | 576 | const SEHUnwindMapEntry &UME = FuncInfo.SEHUnwindMap[State]; |
Reid Kleckner | d880dc7 | 2015-10-09 20:39:39 +0000 | [diff] [blame] | 577 | const MCExpr *FilterOrFinally; |
| 578 | const MCExpr *ExceptOrNull; |
| 579 | auto *Handler = UME.Handler.get<MachineBasicBlock *>(); |
| 580 | if (UME.IsFinally) { |
David Majnemer | bfa5b98 | 2015-10-10 00:04:29 +0000 | [diff] [blame] | 581 | FilterOrFinally = create32bitRef(getMCSymbolForMBB(Asm, Handler)); |
Reid Kleckner | d880dc7 | 2015-10-09 20:39:39 +0000 | [diff] [blame] | 582 | ExceptOrNull = MCConstantExpr::create(0, Ctx); |
| 583 | } else { |
| 584 | // For an except, the filter can be 1 (catch-all) or a function |
| 585 | // label. |
| 586 | FilterOrFinally = UME.Filter ? create32bitRef(UME.Filter) |
| 587 | : MCConstantExpr::create(1, Ctx); |
| 588 | ExceptOrNull = create32bitRef(Handler->getSymbol()); |
| 589 | } |
| 590 | |
| 591 | OS.EmitValue(getLabelPlusOne(BeginLabel), 4); |
| 592 | OS.EmitValue(getLabelPlusOne(EndLabel), 4); |
| 593 | OS.EmitValue(FilterOrFinally, 4); |
| 594 | OS.EmitValue(ExceptOrNull, 4); |
| 595 | |
| 596 | assert(UME.ToState < State && "states should decrease"); |
| 597 | State = UME.ToState; |
| 598 | } |
| 599 | } |
| 600 | |
Reid Kleckner | 60b640b | 2015-05-28 22:47:01 +0000 | [diff] [blame] | 601 | void WinException::emitCXXFrameHandler3Table(const MachineFunction *MF) { |
David Majnemer | cde3303 | 2015-03-30 22:58:10 +0000 | [diff] [blame] | 602 | const Function *F = MF->getFunction(); |
Lang Hames | 9ff69c8 | 2015-04-24 19:11:51 +0000 | [diff] [blame] | 603 | auto &OS = *Asm->OutStreamer; |
Reid Kleckner | c20276d | 2015-11-17 21:10:25 +0000 | [diff] [blame] | 604 | const WinEHFuncInfo &FuncInfo = *MF->getWinEHFuncInfo(); |
David Majnemer | cde3303 | 2015-03-30 22:58:10 +0000 | [diff] [blame] | 605 | |
Reid Kleckner | 813f1b6 | 2015-09-16 22:14:46 +0000 | [diff] [blame] | 606 | StringRef FuncLinkageName = GlobalValue::getRealLinkageName(F->getName()); |
David Majnemer | cde3303 | 2015-03-30 22:58:10 +0000 | [diff] [blame] | 607 | |
Reid Kleckner | c71d627 | 2015-09-28 23:56:30 +0000 | [diff] [blame] | 608 | SmallVector<std::pair<const MCExpr *, int>, 4> IPToStateTable; |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 609 | MCSymbol *FuncInfoXData = nullptr; |
| 610 | if (shouldEmitPersonality) { |
Reid Kleckner | c71d627 | 2015-09-28 23:56:30 +0000 | [diff] [blame] | 611 | // If we're 64-bit, emit a pointer to the C++ EH data, and build a map from |
| 612 | // IPs to state numbers. |
Reid Kleckner | 813f1b6 | 2015-09-16 22:14:46 +0000 | [diff] [blame] | 613 | FuncInfoXData = |
| 614 | Asm->OutContext.getOrCreateSymbol(Twine("$cppxdata$", FuncLinkageName)); |
Reid Kleckner | c71d627 | 2015-09-28 23:56:30 +0000 | [diff] [blame] | 615 | computeIP2StateTable(MF, FuncInfo, IPToStateTable); |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 616 | } else { |
Reid Kleckner | 813f1b6 | 2015-09-16 22:14:46 +0000 | [diff] [blame] | 617 | FuncInfoXData = Asm->OutContext.getOrCreateLSDASymbol(FuncLinkageName); |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 618 | } |
| 619 | |
Reid Kleckner | 70bf6bb | 2015-10-07 21:13:15 +0000 | [diff] [blame] | 620 | int UnwindHelpOffset = 0; |
| 621 | if (Asm->MAI->usesWindowsCFI()) |
Reid Kleckner | 6ddae31 | 2015-11-05 21:09:49 +0000 | [diff] [blame] | 622 | UnwindHelpOffset = |
| 623 | getFrameIndexOffset(FuncInfo.UnwindHelpFrameIdx, FuncInfo); |
Reid Kleckner | 70bf6bb | 2015-10-07 21:13:15 +0000 | [diff] [blame] | 624 | |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 625 | MCSymbol *UnwindMapXData = nullptr; |
| 626 | MCSymbol *TryBlockMapXData = nullptr; |
| 627 | MCSymbol *IPToStateXData = nullptr; |
Reid Kleckner | 14e7735 | 2015-10-09 23:34:53 +0000 | [diff] [blame] | 628 | if (!FuncInfo.CxxUnwindMap.empty()) |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 629 | UnwindMapXData = Asm->OutContext.getOrCreateSymbol( |
Reid Kleckner | 813f1b6 | 2015-09-16 22:14:46 +0000 | [diff] [blame] | 630 | Twine("$stateUnwindMap$", FuncLinkageName)); |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 631 | if (!FuncInfo.TryBlockMap.empty()) |
Reid Kleckner | 813f1b6 | 2015-09-16 22:14:46 +0000 | [diff] [blame] | 632 | TryBlockMapXData = |
| 633 | Asm->OutContext.getOrCreateSymbol(Twine("$tryMap$", FuncLinkageName)); |
Reid Kleckner | c71d627 | 2015-09-28 23:56:30 +0000 | [diff] [blame] | 634 | if (!IPToStateTable.empty()) |
Reid Kleckner | 813f1b6 | 2015-09-16 22:14:46 +0000 | [diff] [blame] | 635 | IPToStateXData = |
| 636 | Asm->OutContext.getOrCreateSymbol(Twine("$ip2state$", FuncLinkageName)); |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 637 | |
| 638 | // FuncInfo { |
| 639 | // uint32_t MagicNumber |
| 640 | // int32_t MaxState; |
| 641 | // UnwindMapEntry *UnwindMap; |
| 642 | // uint32_t NumTryBlocks; |
| 643 | // TryBlockMapEntry *TryBlockMap; |
| 644 | // uint32_t IPMapEntries; // always 0 for x86 |
| 645 | // IPToStateMapEntry *IPToStateMap; // always 0 for x86 |
| 646 | // uint32_t UnwindHelp; // non-x86 only |
| 647 | // ESTypeList *ESTypeList; |
| 648 | // int32_t EHFlags; |
| 649 | // } |
| 650 | // EHFlags & 1 -> Synchronous exceptions only, no async exceptions. |
| 651 | // EHFlags & 2 -> ??? |
| 652 | // EHFlags & 4 -> The function is noexcept(true), unwinding can't continue. |
Reid Kleckner | 85a2450 | 2015-07-10 00:08:49 +0000 | [diff] [blame] | 653 | OS.EmitValueToAlignment(4); |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 654 | OS.EmitLabel(FuncInfoXData); |
| 655 | OS.EmitIntValue(0x19930522, 4); // MagicNumber |
Reid Kleckner | 14e7735 | 2015-10-09 23:34:53 +0000 | [diff] [blame] | 656 | OS.EmitIntValue(FuncInfo.CxxUnwindMap.size(), 4); // MaxState |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 657 | OS.EmitValue(create32bitRef(UnwindMapXData), 4); // UnwindMap |
| 658 | OS.EmitIntValue(FuncInfo.TryBlockMap.size(), 4); // NumTryBlocks |
| 659 | OS.EmitValue(create32bitRef(TryBlockMapXData), 4); // TryBlockMap |
Reid Kleckner | c71d627 | 2015-09-28 23:56:30 +0000 | [diff] [blame] | 660 | OS.EmitIntValue(IPToStateTable.size(), 4); // IPMapEntries |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 661 | OS.EmitValue(create32bitRef(IPToStateXData), 4); // IPToStateMap |
| 662 | if (Asm->MAI->usesWindowsCFI()) |
Reid Kleckner | 70bf6bb | 2015-10-07 21:13:15 +0000 | [diff] [blame] | 663 | OS.EmitIntValue(UnwindHelpOffset, 4); // UnwindHelp |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 664 | OS.EmitIntValue(0, 4); // ESTypeList |
| 665 | OS.EmitIntValue(1, 4); // EHFlags |
| 666 | |
| 667 | // UnwindMapEntry { |
| 668 | // int32_t ToState; |
| 669 | // void (*Action)(); |
| 670 | // }; |
| 671 | if (UnwindMapXData) { |
| 672 | OS.EmitLabel(UnwindMapXData); |
Reid Kleckner | 14e7735 | 2015-10-09 23:34:53 +0000 | [diff] [blame] | 673 | for (const CxxUnwindMapEntry &UME : FuncInfo.CxxUnwindMap) { |
David Majnemer | bfa5b98 | 2015-10-10 00:04:29 +0000 | [diff] [blame] | 674 | MCSymbol *CleanupSym = |
| 675 | getMCSymbolForMBB(Asm, UME.Cleanup.dyn_cast<MachineBasicBlock *>()); |
Reid Kleckner | 7878391 | 2015-09-10 00:25:23 +0000 | [diff] [blame] | 676 | OS.EmitIntValue(UME.ToState, 4); // ToState |
| 677 | OS.EmitValue(create32bitRef(CleanupSym), 4); // Action |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 678 | } |
| 679 | } |
| 680 | |
| 681 | // TryBlockMap { |
| 682 | // int32_t TryLow; |
| 683 | // int32_t TryHigh; |
| 684 | // int32_t CatchHigh; |
| 685 | // int32_t NumCatches; |
| 686 | // HandlerType *HandlerArray; |
| 687 | // }; |
| 688 | if (TryBlockMapXData) { |
| 689 | OS.EmitLabel(TryBlockMapXData); |
| 690 | SmallVector<MCSymbol *, 1> HandlerMaps; |
| 691 | for (size_t I = 0, E = FuncInfo.TryBlockMap.size(); I != E; ++I) { |
Reid Kleckner | c20276d | 2015-11-17 21:10:25 +0000 | [diff] [blame] | 692 | const WinEHTryBlockMapEntry &TBME = FuncInfo.TryBlockMap[I]; |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 693 | |
Reid Kleckner | 813f1b6 | 2015-09-16 22:14:46 +0000 | [diff] [blame] | 694 | MCSymbol *HandlerMapXData = nullptr; |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 695 | if (!TBME.HandlerArray.empty()) |
| 696 | HandlerMapXData = |
| 697 | Asm->OutContext.getOrCreateSymbol(Twine("$handlerMap$") |
| 698 | .concat(Twine(I)) |
| 699 | .concat("$") |
Reid Kleckner | 813f1b6 | 2015-09-16 22:14:46 +0000 | [diff] [blame] | 700 | .concat(FuncLinkageName)); |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 701 | HandlerMaps.push_back(HandlerMapXData); |
| 702 | |
Reid Kleckner | 813f1b6 | 2015-09-16 22:14:46 +0000 | [diff] [blame] | 703 | // TBMEs should form intervals. |
| 704 | assert(0 <= TBME.TryLow && "bad trymap interval"); |
| 705 | assert(TBME.TryLow <= TBME.TryHigh && "bad trymap interval"); |
| 706 | assert(TBME.TryHigh < TBME.CatchHigh && "bad trymap interval"); |
Reid Kleckner | 14e7735 | 2015-10-09 23:34:53 +0000 | [diff] [blame] | 707 | assert(TBME.CatchHigh < int(FuncInfo.CxxUnwindMap.size()) && |
Reid Kleckner | 813f1b6 | 2015-09-16 22:14:46 +0000 | [diff] [blame] | 708 | "bad trymap interval"); |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 709 | |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 710 | OS.EmitIntValue(TBME.TryLow, 4); // TryLow |
| 711 | OS.EmitIntValue(TBME.TryHigh, 4); // TryHigh |
Reid Kleckner | 813f1b6 | 2015-09-16 22:14:46 +0000 | [diff] [blame] | 712 | OS.EmitIntValue(TBME.CatchHigh, 4); // CatchHigh |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 713 | OS.EmitIntValue(TBME.HandlerArray.size(), 4); // NumCatches |
| 714 | OS.EmitValue(create32bitRef(HandlerMapXData), 4); // HandlerArray |
| 715 | } |
| 716 | |
Reid Kleckner | 28e4903 | 2015-10-16 23:43:27 +0000 | [diff] [blame] | 717 | // All funclets use the same parent frame offset currently. |
| 718 | unsigned ParentFrameOffset = 0; |
| 719 | if (shouldEmitPersonality) { |
| 720 | const TargetFrameLowering *TFI = MF->getSubtarget().getFrameLowering(); |
| 721 | ParentFrameOffset = TFI->getWinEHParentFrameOffset(*MF); |
| 722 | } |
| 723 | |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 724 | for (size_t I = 0, E = FuncInfo.TryBlockMap.size(); I != E; ++I) { |
Reid Kleckner | c20276d | 2015-11-17 21:10:25 +0000 | [diff] [blame] | 725 | const WinEHTryBlockMapEntry &TBME = FuncInfo.TryBlockMap[I]; |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 726 | MCSymbol *HandlerMapXData = HandlerMaps[I]; |
| 727 | if (!HandlerMapXData) |
| 728 | continue; |
| 729 | // HandlerType { |
| 730 | // int32_t Adjectives; |
| 731 | // TypeDescriptor *Type; |
| 732 | // int32_t CatchObjOffset; |
| 733 | // void (*Handler)(); |
| 734 | // int32_t ParentFrameOffset; // x64 only |
| 735 | // }; |
| 736 | OS.EmitLabel(HandlerMapXData); |
| 737 | for (const WinEHHandlerType &HT : TBME.HandlerArray) { |
| 738 | // Get the frame escape label with the offset of the catch object. If |
David Majnemer | 99c1d13 | 2015-10-12 16:44:22 +0000 | [diff] [blame] | 739 | // the index is INT_MAX, then there is no catch object, and we should |
| 740 | // emit an offset of zero, indicating that no copy will occur. |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 741 | const MCExpr *FrameAllocOffsetRef = nullptr; |
David Majnemer | 99c1d13 | 2015-10-12 16:44:22 +0000 | [diff] [blame] | 742 | if (HT.CatchObj.FrameIndex != INT_MAX) { |
Reid Kleckner | 6ddae31 | 2015-11-05 21:09:49 +0000 | [diff] [blame] | 743 | int Offset = getFrameIndexOffset(HT.CatchObj.FrameIndex, FuncInfo); |
Reid Kleckner | b005d28 | 2015-09-16 20:16:27 +0000 | [diff] [blame] | 744 | FrameAllocOffsetRef = MCConstantExpr::create(Offset, Asm->OutContext); |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 745 | } else { |
Jim Grosbach | 13760bd | 2015-05-30 01:25:56 +0000 | [diff] [blame] | 746 | FrameAllocOffsetRef = MCConstantExpr::create(0, Asm->OutContext); |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 747 | } |
| 748 | |
David Majnemer | bfa5b98 | 2015-10-10 00:04:29 +0000 | [diff] [blame] | 749 | MCSymbol *HandlerSym = |
| 750 | getMCSymbolForMBB(Asm, HT.Handler.dyn_cast<MachineBasicBlock *>()); |
Reid Kleckner | 94b704c | 2015-09-09 21:10:03 +0000 | [diff] [blame] | 751 | |
| 752 | OS.EmitIntValue(HT.Adjectives, 4); // Adjectives |
| 753 | OS.EmitValue(create32bitRef(HT.TypeDescriptor), 4); // Type |
| 754 | OS.EmitValue(FrameAllocOffsetRef, 4); // CatchObjOffset |
| 755 | OS.EmitValue(create32bitRef(HandlerSym), 4); // Handler |
Reid Kleckner | 28e4903 | 2015-10-16 23:43:27 +0000 | [diff] [blame] | 756 | if (shouldEmitPersonality) |
Reid Kleckner | 813f1b6 | 2015-09-16 22:14:46 +0000 | [diff] [blame] | 757 | OS.EmitIntValue(ParentFrameOffset, 4); // ParentFrameOffset |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 758 | } |
| 759 | } |
| 760 | } |
| 761 | |
| 762 | // IPToStateMapEntry { |
| 763 | // void *IP; |
| 764 | // int32_t State; |
| 765 | // }; |
| 766 | if (IPToStateXData) { |
| 767 | OS.EmitLabel(IPToStateXData); |
Reid Kleckner | c71d627 | 2015-09-28 23:56:30 +0000 | [diff] [blame] | 768 | for (auto &IPStatePair : IPToStateTable) { |
| 769 | OS.EmitValue(IPStatePair.first, 4); // IP |
| 770 | OS.EmitIntValue(IPStatePair.second, 4); // State |
Reid Kleckner | 1d3d4ad | 2015-05-29 17:00:57 +0000 | [diff] [blame] | 771 | } |
| 772 | } |
| 773 | } |
| 774 | |
Reid Kleckner | c71d627 | 2015-09-28 23:56:30 +0000 | [diff] [blame] | 775 | void WinException::computeIP2StateTable( |
Reid Kleckner | c20276d | 2015-11-17 21:10:25 +0000 | [diff] [blame] | 776 | const MachineFunction *MF, const WinEHFuncInfo &FuncInfo, |
Reid Kleckner | c71d627 | 2015-09-28 23:56:30 +0000 | [diff] [blame] | 777 | SmallVectorImpl<std::pair<const MCExpr *, int>> &IPToStateTable) { |
Reid Kleckner | c71d627 | 2015-09-28 23:56:30 +0000 | [diff] [blame] | 778 | // Indicate that all calls from the prologue to the first invoke unwind to |
| 779 | // caller. We handle this as a special case since other ranges starting at end |
| 780 | // labels need to use LtmpN+1. |
Joseph Tremoulet | 1e2f062 | 2015-10-13 16:44:30 +0000 | [diff] [blame] | 781 | MCSymbol *StartLabel = Asm->getFunctionBegin(); |
| 782 | assert(StartLabel && "need local function start label"); |
| 783 | IPToStateTable.push_back(std::make_pair(create32bitRef(StartLabel), -1)); |
Andrew Kaylor | 762a6be | 2015-05-11 19:41:19 +0000 | [diff] [blame] | 784 | |
Joseph Tremoulet | 1e2f062 | 2015-10-13 16:44:30 +0000 | [diff] [blame] | 785 | // FIXME: Do we need to emit entries for funclet base states? |
| 786 | for (const auto &StateChange : |
| 787 | InvokeStateChangeIterator::range(FuncInfo, *MF)) { |
| 788 | // Compute the label to report as the start of this entry; use the EH start |
| 789 | // label for the invoke if we have one, otherwise (this is a call which may |
| 790 | // unwind to our caller and does not have an EH start label, so) use the |
| 791 | // previous end label. |
| 792 | const MCSymbol *ChangeLabel = StateChange.NewStartLabel; |
| 793 | if (!ChangeLabel) |
| 794 | ChangeLabel = StateChange.PreviousEndLabel; |
| 795 | // Emit an entry indicating that PCs after 'Label' have this EH state. |
| 796 | IPToStateTable.push_back( |
| 797 | std::make_pair(getLabelPlusOne(ChangeLabel), StateChange.NewState)); |
Reid Kleckner | c71d627 | 2015-09-28 23:56:30 +0000 | [diff] [blame] | 798 | } |
David Majnemer | cde3303 | 2015-03-30 22:58:10 +0000 | [diff] [blame] | 799 | } |
Reid Kleckner | f12c030 | 2015-06-09 21:42:19 +0000 | [diff] [blame] | 800 | |
Reid Kleckner | 399a2fe | 2015-06-30 22:46:59 +0000 | [diff] [blame] | 801 | void WinException::emitEHRegistrationOffsetLabel(const WinEHFuncInfo &FuncInfo, |
| 802 | StringRef FLinkageName) { |
| 803 | // Outlined helpers called by the EH runtime need to know the offset of the EH |
| 804 | // registration in order to recover the parent frame pointer. Now that we know |
| 805 | // we've code generated the parent, we can emit the label assignment that |
| 806 | // those helpers use to get the offset of the registration node. |
Reid Kleckner | c20276d | 2015-11-17 21:10:25 +0000 | [diff] [blame] | 807 | MCContext &Ctx = Asm->OutContext; |
Reid Kleckner | 399a2fe | 2015-06-30 22:46:59 +0000 | [diff] [blame] | 808 | MCSymbol *ParentFrameOffset = |
Reid Kleckner | c20276d | 2015-11-17 21:10:25 +0000 | [diff] [blame] | 809 | Ctx.getOrCreateParentFrameOffsetSymbol(FLinkageName); |
| 810 | unsigned UnusedReg; |
| 811 | const TargetFrameLowering *TFI = Asm->MF->getSubtarget().getFrameLowering(); |
| 812 | int64_t Offset = TFI->getFrameIndexReference( |
| 813 | *Asm->MF, FuncInfo.EHRegNodeFrameIndex, UnusedReg); |
| 814 | const MCExpr *MCOffset = MCConstantExpr::create(Offset, Ctx); |
| 815 | Asm->OutStreamer->EmitAssignment(ParentFrameOffset, MCOffset); |
Reid Kleckner | 399a2fe | 2015-06-30 22:46:59 +0000 | [diff] [blame] | 816 | } |
| 817 | |
Reid Kleckner | f12c030 | 2015-06-09 21:42:19 +0000 | [diff] [blame] | 818 | /// Emit the language-specific data that _except_handler3 and 4 expect. This is |
| 819 | /// functionally equivalent to the __C_specific_handler table, except it is |
| 820 | /// indexed by state number instead of IP. |
| 821 | void WinException::emitExceptHandlerTable(const MachineFunction *MF) { |
Reid Kleckner | a9d6253 | 2015-06-11 22:32:23 +0000 | [diff] [blame] | 822 | MCStreamer &OS = *Asm->OutStreamer; |
Reid Kleckner | a9d6253 | 2015-06-11 22:32:23 +0000 | [diff] [blame] | 823 | const Function *F = MF->getFunction(); |
Reid Kleckner | a9d6253 | 2015-06-11 22:32:23 +0000 | [diff] [blame] | 824 | StringRef FLinkageName = GlobalValue::getRealLinkageName(F->getName()); |
Reid Kleckner | 399a2fe | 2015-06-30 22:46:59 +0000 | [diff] [blame] | 825 | |
Reid Kleckner | c20276d | 2015-11-17 21:10:25 +0000 | [diff] [blame] | 826 | const WinEHFuncInfo &FuncInfo = *MF->getWinEHFuncInfo(); |
Reid Kleckner | 399a2fe | 2015-06-30 22:46:59 +0000 | [diff] [blame] | 827 | emitEHRegistrationOffsetLabel(FuncInfo, FLinkageName); |
Reid Kleckner | f12c030 | 2015-06-09 21:42:19 +0000 | [diff] [blame] | 828 | |
| 829 | // Emit the __ehtable label that we use for llvm.x86.seh.lsda. |
Reid Kleckner | f12c030 | 2015-06-09 21:42:19 +0000 | [diff] [blame] | 830 | MCSymbol *LSDALabel = Asm->OutContext.getOrCreateLSDASymbol(FLinkageName); |
Reid Kleckner | 85a2450 | 2015-07-10 00:08:49 +0000 | [diff] [blame] | 831 | OS.EmitValueToAlignment(4); |
Reid Kleckner | f12c030 | 2015-06-09 21:42:19 +0000 | [diff] [blame] | 832 | OS.EmitLabel(LSDALabel); |
| 833 | |
Reid Kleckner | 9a1a919 | 2015-07-13 20:41:46 +0000 | [diff] [blame] | 834 | const Function *Per = |
| 835 | dyn_cast<Function>(F->getPersonalityFn()->stripPointerCasts()); |
Reid Kleckner | f12c030 | 2015-06-09 21:42:19 +0000 | [diff] [blame] | 836 | StringRef PerName = Per->getName(); |
| 837 | int BaseState = -1; |
| 838 | if (PerName == "_except_handler4") { |
| 839 | // The LSDA for _except_handler4 starts with this struct, followed by the |
| 840 | // scope table: |
| 841 | // |
| 842 | // struct EH4ScopeTable { |
| 843 | // int32_t GSCookieOffset; |
| 844 | // int32_t GSCookieXOROffset; |
| 845 | // int32_t EHCookieOffset; |
| 846 | // int32_t EHCookieXOROffset; |
| 847 | // ScopeTableEntry ScopeRecord[]; |
| 848 | // }; |
| 849 | // |
| 850 | // Only the EHCookieOffset field appears to vary, and it appears to be the |
| 851 | // offset from the final saved SP value to the retaddr. |
| 852 | OS.EmitIntValue(-2, 4); |
| 853 | OS.EmitIntValue(0, 4); |
| 854 | // FIXME: Calculate. |
| 855 | OS.EmitIntValue(9999, 4); |
| 856 | OS.EmitIntValue(0, 4); |
| 857 | BaseState = -2; |
| 858 | } |
| 859 | |
Reid Kleckner | 14e7735 | 2015-10-09 23:34:53 +0000 | [diff] [blame] | 860 | assert(!FuncInfo.SEHUnwindMap.empty()); |
Reid Kleckner | c20276d | 2015-11-17 21:10:25 +0000 | [diff] [blame] | 861 | for (const SEHUnwindMapEntry &UME : FuncInfo.SEHUnwindMap) { |
Reid Kleckner | 14e7735 | 2015-10-09 23:34:53 +0000 | [diff] [blame] | 862 | MCSymbol *ExceptOrFinally = |
| 863 | UME.Handler.get<MachineBasicBlock *>()->getSymbol(); |
| 864 | // -1 is usually the base state for "unwind to caller", but for |
| 865 | // _except_handler4 it's -2. Do that replacement here if necessary. |
| 866 | int ToState = UME.ToState == -1 ? BaseState : UME.ToState; |
| 867 | OS.EmitIntValue(ToState, 4); // ToState |
| 868 | OS.EmitValue(create32bitRef(UME.Filter), 4); // Filter |
| 869 | OS.EmitValue(create32bitRef(ExceptOrFinally), 4); // Except/Finally |
Reid Kleckner | f12c030 | 2015-06-09 21:42:19 +0000 | [diff] [blame] | 870 | } |
| 871 | } |
Joseph Tremoulet | 28c89bb | 2015-10-13 20:18:27 +0000 | [diff] [blame] | 872 | |
Reid Kleckner | c20276d | 2015-11-17 21:10:25 +0000 | [diff] [blame] | 873 | static int getRank(const WinEHFuncInfo &FuncInfo, int State) { |
Joseph Tremoulet | 28c89bb | 2015-10-13 20:18:27 +0000 | [diff] [blame] | 874 | int Rank = 0; |
| 875 | while (State != -1) { |
| 876 | ++Rank; |
| 877 | State = FuncInfo.ClrEHUnwindMap[State].Parent; |
| 878 | } |
| 879 | return Rank; |
| 880 | } |
| 881 | |
Reid Kleckner | c20276d | 2015-11-17 21:10:25 +0000 | [diff] [blame] | 882 | static int getAncestor(const WinEHFuncInfo &FuncInfo, int Left, int Right) { |
Joseph Tremoulet | 28c89bb | 2015-10-13 20:18:27 +0000 | [diff] [blame] | 883 | int LeftRank = getRank(FuncInfo, Left); |
| 884 | int RightRank = getRank(FuncInfo, Right); |
| 885 | |
| 886 | while (LeftRank < RightRank) { |
| 887 | Right = FuncInfo.ClrEHUnwindMap[Right].Parent; |
| 888 | --RightRank; |
| 889 | } |
| 890 | |
| 891 | while (RightRank < LeftRank) { |
| 892 | Left = FuncInfo.ClrEHUnwindMap[Left].Parent; |
| 893 | --LeftRank; |
| 894 | } |
| 895 | |
| 896 | while (Left != Right) { |
| 897 | Left = FuncInfo.ClrEHUnwindMap[Left].Parent; |
| 898 | Right = FuncInfo.ClrEHUnwindMap[Right].Parent; |
| 899 | } |
| 900 | |
| 901 | return Left; |
| 902 | } |
| 903 | |
| 904 | void WinException::emitCLRExceptionTable(const MachineFunction *MF) { |
| 905 | // CLR EH "states" are really just IDs that identify handlers/funclets; |
| 906 | // states, handlers, and funclets all have 1:1 mappings between them, and a |
| 907 | // handler/funclet's "state" is its index in the ClrEHUnwindMap. |
| 908 | MCStreamer &OS = *Asm->OutStreamer; |
Reid Kleckner | c20276d | 2015-11-17 21:10:25 +0000 | [diff] [blame] | 909 | const WinEHFuncInfo &FuncInfo = *MF->getWinEHFuncInfo(); |
Joseph Tremoulet | 28c89bb | 2015-10-13 20:18:27 +0000 | [diff] [blame] | 910 | MCSymbol *FuncBeginSym = Asm->getFunctionBegin(); |
| 911 | MCSymbol *FuncEndSym = Asm->getFunctionEnd(); |
| 912 | |
| 913 | // A ClrClause describes a protected region. |
| 914 | struct ClrClause { |
| 915 | const MCSymbol *StartLabel; // Start of protected region |
| 916 | const MCSymbol *EndLabel; // End of protected region |
| 917 | int State; // Index of handler protecting the protected region |
| 918 | int EnclosingState; // Index of funclet enclosing the protected region |
| 919 | }; |
| 920 | SmallVector<ClrClause, 8> Clauses; |
| 921 | |
| 922 | // Build a map from handler MBBs to their corresponding states (i.e. their |
| 923 | // indices in the ClrEHUnwindMap). |
| 924 | int NumStates = FuncInfo.ClrEHUnwindMap.size(); |
| 925 | assert(NumStates > 0 && "Don't need exception table!"); |
| 926 | DenseMap<const MachineBasicBlock *, int> HandlerStates; |
| 927 | for (int State = 0; State < NumStates; ++State) { |
| 928 | MachineBasicBlock *HandlerBlock = |
| 929 | FuncInfo.ClrEHUnwindMap[State].Handler.get<MachineBasicBlock *>(); |
| 930 | HandlerStates[HandlerBlock] = State; |
| 931 | // Use this loop through all handlers to verify our assumption (used in |
| 932 | // the MinEnclosingState computation) that ancestors have lower state |
| 933 | // numbers than their descendants. |
| 934 | assert(FuncInfo.ClrEHUnwindMap[State].Parent < State && |
| 935 | "ill-formed state numbering"); |
| 936 | } |
| 937 | // Map the main function to the NullState. |
Duncan P. N. Exon Smith | a25ad06 | 2015-10-20 00:36:08 +0000 | [diff] [blame] | 938 | HandlerStates[&MF->front()] = NullState; |
Joseph Tremoulet | 28c89bb | 2015-10-13 20:18:27 +0000 | [diff] [blame] | 939 | |
| 940 | // Write out a sentinel indicating the end of the standard (Windows) xdata |
| 941 | // and the start of the additional (CLR) info. |
| 942 | OS.EmitIntValue(0xffffffff, 4); |
| 943 | // Write out the number of funclets |
| 944 | OS.EmitIntValue(NumStates, 4); |
| 945 | |
| 946 | // Walk the machine blocks/instrs, computing and emitting a few things: |
| 947 | // 1. Emit a list of the offsets to each handler entry, in lexical order. |
| 948 | // 2. Compute a map (EndSymbolMap) from each funclet to the symbol at its end. |
| 949 | // 3. Compute the list of ClrClauses, in the required order (inner before |
| 950 | // outer, earlier before later; the order by which a forward scan with |
| 951 | // early termination will find the innermost enclosing clause covering |
| 952 | // a given address). |
| 953 | // 4. A map (MinClauseMap) from each handler index to the index of the |
| 954 | // outermost funclet/function which contains a try clause targeting the |
| 955 | // key handler. This will be used to determine IsDuplicate-ness when |
| 956 | // emitting ClrClauses. The NullState value is used to indicate that the |
| 957 | // top-level function contains a try clause targeting the key handler. |
| 958 | // HandlerStack is a stack of (PendingStartLabel, PendingState) pairs for |
| 959 | // try regions we entered before entering the PendingState try but which |
| 960 | // we haven't yet exited. |
| 961 | SmallVector<std::pair<const MCSymbol *, int>, 4> HandlerStack; |
| 962 | // EndSymbolMap and MinClauseMap are maps described above. |
| 963 | std::unique_ptr<MCSymbol *[]> EndSymbolMap(new MCSymbol *[NumStates]); |
| 964 | SmallVector<int, 4> MinClauseMap((size_t)NumStates, NumStates); |
| 965 | |
| 966 | // Visit the root function and each funclet. |
| 967 | |
| 968 | for (MachineFunction::const_iterator FuncletStart = MF->begin(), |
| 969 | FuncletEnd = MF->begin(), |
| 970 | End = MF->end(); |
| 971 | FuncletStart != End; FuncletStart = FuncletEnd) { |
Duncan P. N. Exon Smith | a25ad06 | 2015-10-20 00:36:08 +0000 | [diff] [blame] | 972 | int FuncletState = HandlerStates[&*FuncletStart]; |
Joseph Tremoulet | 28c89bb | 2015-10-13 20:18:27 +0000 | [diff] [blame] | 973 | // Find the end of the funclet |
| 974 | MCSymbol *EndSymbol = FuncEndSym; |
| 975 | while (++FuncletEnd != End) { |
| 976 | if (FuncletEnd->isEHFuncletEntry()) { |
Duncan P. N. Exon Smith | a25ad06 | 2015-10-20 00:36:08 +0000 | [diff] [blame] | 977 | EndSymbol = getMCSymbolForMBB(Asm, &*FuncletEnd); |
Joseph Tremoulet | 28c89bb | 2015-10-13 20:18:27 +0000 | [diff] [blame] | 978 | break; |
| 979 | } |
| 980 | } |
| 981 | // Emit the function/funclet end and, if this is a funclet (and not the |
| 982 | // root function), record it in the EndSymbolMap. |
| 983 | OS.EmitValue(getOffset(EndSymbol, FuncBeginSym), 4); |
| 984 | if (FuncletState != NullState) { |
| 985 | // Record the end of the handler. |
| 986 | EndSymbolMap[FuncletState] = EndSymbol; |
| 987 | } |
| 988 | |
| 989 | // Walk the state changes in this function/funclet and compute its clauses. |
| 990 | // Funclets always start in the null state. |
| 991 | const MCSymbol *CurrentStartLabel = nullptr; |
| 992 | int CurrentState = NullState; |
| 993 | assert(HandlerStack.empty()); |
| 994 | for (const auto &StateChange : |
| 995 | InvokeStateChangeIterator::range(FuncInfo, FuncletStart, FuncletEnd)) { |
| 996 | // Close any try regions we're not still under |
| 997 | int AncestorState = |
| 998 | getAncestor(FuncInfo, CurrentState, StateChange.NewState); |
| 999 | while (CurrentState != AncestorState) { |
| 1000 | assert(CurrentState != NullState && "Failed to find ancestor!"); |
| 1001 | // Close the pending clause |
| 1002 | Clauses.push_back({CurrentStartLabel, StateChange.PreviousEndLabel, |
| 1003 | CurrentState, FuncletState}); |
| 1004 | // Now the parent handler is current |
| 1005 | CurrentState = FuncInfo.ClrEHUnwindMap[CurrentState].Parent; |
| 1006 | // Pop the new start label from the handler stack if we've exited all |
| 1007 | // descendants of the corresponding handler. |
| 1008 | if (HandlerStack.back().second == CurrentState) |
| 1009 | CurrentStartLabel = HandlerStack.pop_back_val().first; |
| 1010 | } |
| 1011 | |
| 1012 | if (StateChange.NewState != CurrentState) { |
| 1013 | // For each clause we're starting, update the MinClauseMap so we can |
| 1014 | // know which is the topmost funclet containing a clause targeting |
| 1015 | // it. |
| 1016 | for (int EnteredState = StateChange.NewState; |
| 1017 | EnteredState != CurrentState; |
| 1018 | EnteredState = FuncInfo.ClrEHUnwindMap[EnteredState].Parent) { |
| 1019 | int &MinEnclosingState = MinClauseMap[EnteredState]; |
| 1020 | if (FuncletState < MinEnclosingState) |
| 1021 | MinEnclosingState = FuncletState; |
| 1022 | } |
| 1023 | // Save the previous current start/label on the stack and update to |
| 1024 | // the newly-current start/state. |
| 1025 | HandlerStack.emplace_back(CurrentStartLabel, CurrentState); |
| 1026 | CurrentStartLabel = StateChange.NewStartLabel; |
| 1027 | CurrentState = StateChange.NewState; |
| 1028 | } |
| 1029 | } |
| 1030 | assert(HandlerStack.empty()); |
| 1031 | } |
| 1032 | |
| 1033 | // Now emit the clause info, starting with the number of clauses. |
| 1034 | OS.EmitIntValue(Clauses.size(), 4); |
| 1035 | for (ClrClause &Clause : Clauses) { |
| 1036 | // Emit a CORINFO_EH_CLAUSE : |
| 1037 | /* |
| 1038 | struct CORINFO_EH_CLAUSE |
| 1039 | { |
| 1040 | CORINFO_EH_CLAUSE_FLAGS Flags; // actually a CorExceptionFlag |
| 1041 | DWORD TryOffset; |
| 1042 | DWORD TryLength; // actually TryEndOffset |
| 1043 | DWORD HandlerOffset; |
| 1044 | DWORD HandlerLength; // actually HandlerEndOffset |
| 1045 | union |
| 1046 | { |
| 1047 | DWORD ClassToken; // use for catch clauses |
| 1048 | DWORD FilterOffset; // use for filter clauses |
| 1049 | }; |
| 1050 | }; |
| 1051 | |
| 1052 | enum CORINFO_EH_CLAUSE_FLAGS |
| 1053 | { |
| 1054 | CORINFO_EH_CLAUSE_NONE = 0, |
| 1055 | CORINFO_EH_CLAUSE_FILTER = 0x0001, // This clause is for a filter |
| 1056 | CORINFO_EH_CLAUSE_FINALLY = 0x0002, // This clause is a finally clause |
| 1057 | CORINFO_EH_CLAUSE_FAULT = 0x0004, // This clause is a fault clause |
| 1058 | }; |
| 1059 | typedef enum CorExceptionFlag |
| 1060 | { |
| 1061 | COR_ILEXCEPTION_CLAUSE_NONE, |
| 1062 | COR_ILEXCEPTION_CLAUSE_FILTER = 0x0001, // This is a filter clause |
| 1063 | COR_ILEXCEPTION_CLAUSE_FINALLY = 0x0002, // This is a finally clause |
| 1064 | COR_ILEXCEPTION_CLAUSE_FAULT = 0x0004, // This is a fault clause |
| 1065 | COR_ILEXCEPTION_CLAUSE_DUPLICATED = 0x0008, // duplicated clause. This |
| 1066 | // clause was duplicated |
| 1067 | // to a funclet which was |
| 1068 | // pulled out of line |
| 1069 | } CorExceptionFlag; |
| 1070 | */ |
| 1071 | // Add 1 to the start/end of the EH clause; the IP associated with a |
| 1072 | // call when the runtime does its scan is the IP of the next instruction |
| 1073 | // (the one to which control will return after the call), so we need |
| 1074 | // to add 1 to the end of the clause to cover that offset. We also add |
| 1075 | // 1 to the start of the clause to make sure that the ranges reported |
| 1076 | // for all clauses are disjoint. Note that we'll need some additional |
| 1077 | // logic when machine traps are supported, since in that case the IP |
| 1078 | // that the runtime uses is the offset of the faulting instruction |
| 1079 | // itself; if such an instruction immediately follows a call but the |
| 1080 | // two belong to different clauses, we'll need to insert a nop between |
| 1081 | // them so the runtime can distinguish the point to which the call will |
| 1082 | // return from the point at which the fault occurs. |
| 1083 | |
| 1084 | const MCExpr *ClauseBegin = |
| 1085 | getOffsetPlusOne(Clause.StartLabel, FuncBeginSym); |
| 1086 | const MCExpr *ClauseEnd = getOffsetPlusOne(Clause.EndLabel, FuncBeginSym); |
| 1087 | |
Reid Kleckner | c20276d | 2015-11-17 21:10:25 +0000 | [diff] [blame] | 1088 | const ClrEHUnwindMapEntry &Entry = FuncInfo.ClrEHUnwindMap[Clause.State]; |
Joseph Tremoulet | 28c89bb | 2015-10-13 20:18:27 +0000 | [diff] [blame] | 1089 | MachineBasicBlock *HandlerBlock = Entry.Handler.get<MachineBasicBlock *>(); |
| 1090 | MCSymbol *BeginSym = getMCSymbolForMBB(Asm, HandlerBlock); |
| 1091 | const MCExpr *HandlerBegin = getOffset(BeginSym, FuncBeginSym); |
| 1092 | MCSymbol *EndSym = EndSymbolMap[Clause.State]; |
| 1093 | const MCExpr *HandlerEnd = getOffset(EndSym, FuncBeginSym); |
| 1094 | |
| 1095 | uint32_t Flags = 0; |
| 1096 | switch (Entry.HandlerType) { |
| 1097 | case ClrHandlerType::Catch: |
| 1098 | // Leaving bits 0-2 clear indicates catch. |
| 1099 | break; |
| 1100 | case ClrHandlerType::Filter: |
| 1101 | Flags |= 1; |
| 1102 | break; |
| 1103 | case ClrHandlerType::Finally: |
| 1104 | Flags |= 2; |
| 1105 | break; |
| 1106 | case ClrHandlerType::Fault: |
| 1107 | Flags |= 4; |
| 1108 | break; |
| 1109 | } |
| 1110 | if (Clause.EnclosingState != MinClauseMap[Clause.State]) { |
| 1111 | // This is a "duplicate" clause; the handler needs to be entered from a |
| 1112 | // frame above the one holding the invoke. |
| 1113 | assert(Clause.EnclosingState > MinClauseMap[Clause.State]); |
| 1114 | Flags |= 8; |
| 1115 | } |
| 1116 | OS.EmitIntValue(Flags, 4); |
| 1117 | |
| 1118 | // Write the clause start/end |
| 1119 | OS.EmitValue(ClauseBegin, 4); |
| 1120 | OS.EmitValue(ClauseEnd, 4); |
| 1121 | |
| 1122 | // Write out the handler start/end |
| 1123 | OS.EmitValue(HandlerBegin, 4); |
| 1124 | OS.EmitValue(HandlerEnd, 4); |
| 1125 | |
| 1126 | // Write out the type token or filter offset |
| 1127 | assert(Entry.HandlerType != ClrHandlerType::Filter && "NYI: filters"); |
| 1128 | OS.EmitIntValue(Entry.TypeToken, 4); |
| 1129 | } |
| 1130 | } |