Home | History | Annotate | Download | only in AsmPrinter 
      1 //===-- WinException.h - Windows Exception Handling ----------*- C++ -*--===//
      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 windows exception info into asm files.
     11 //
     12 //===----------------------------------------------------------------------===//
     13 
     14 #ifndef LLVM_LIB_CODEGEN_ASMPRINTER_WIN64EXCEPTION_H
     15 #define LLVM_LIB_CODEGEN_ASMPRINTER_WIN64EXCEPTION_H
     16 
     17 #include "EHStreamer.h"
     18 
     19 namespace llvm {
     20 class Function;
     21 class GlobalValue;
     22 class MachineFunction;
     23 class MCExpr;
     24 class MCSection;
     25 class Value;
     26 struct WinEHFuncInfo;
     27 
     28 class LLVM_LIBRARY_VISIBILITY WinException : public EHStreamer {
     29   /// Per-function flag to indicate if personality info should be emitted.
     30   bool shouldEmitPersonality = false;
     31 
     32   /// Per-function flag to indicate if the LSDA should be emitted.
     33   bool shouldEmitLSDA = false;
     34 
     35   /// Per-function flag to indicate if frame moves info should be emitted.
     36   bool shouldEmitMoves = false;
     37 
     38   /// True if this is a 64-bit target and we should use image relative offsets.
     39   bool useImageRel32 = false;
     40 
     41   /// Pointer to the current funclet entry BB.
     42   const MachineBasicBlock *CurrentFuncletEntry = nullptr;
     43 
     44   /// The section of the last funclet start.
     45   MCSection *CurrentFuncletTextSection = nullptr;
     46 
     47   void emitCSpecificHandlerTable(const MachineFunction *MF);
     48 
     49   void emitSEHActionsForRange(const WinEHFuncInfo &FuncInfo,
     50                               const MCSymbol *BeginLabel,
     51                               const MCSymbol *EndLabel, int State);
     52 
     53   /// Emit the EH table data for 32-bit and 64-bit functions using
     54   /// the __CxxFrameHandler3 personality.
     55   void emitCXXFrameHandler3Table(const MachineFunction *MF);
     56 
     57   /// Emit the EH table data for _except_handler3 and _except_handler4
     58   /// personality functions. These are only used on 32-bit and do not use CFI
     59   /// tables.
     60   void emitExceptHandlerTable(const MachineFunction *MF);
     61 
     62   void emitCLRExceptionTable(const MachineFunction *MF);
     63 
     64   void computeIP2StateTable(
     65       const MachineFunction *MF, const WinEHFuncInfo &FuncInfo,
     66       SmallVectorImpl<std::pair<const MCExpr *, int>> &IPToStateTable);
     67 
     68   /// Emits the label used with llvm.x86.seh.recoverfp, which is used by
     69   /// outlined funclets.
     70   void emitEHRegistrationOffsetLabel(const WinEHFuncInfo &FuncInfo,
     71                                      StringRef FLinkageName);
     72 
     73   const MCExpr *create32bitRef(const MCSymbol *Value);
     74   const MCExpr *create32bitRef(const GlobalValue *GV);
     75   const MCExpr *getLabelPlusOne(const MCSymbol *Label);
     76   const MCExpr *getOffset(const MCSymbol *OffsetOf, const MCSymbol *OffsetFrom);
     77   const MCExpr *getOffsetPlusOne(const MCSymbol *OffsetOf,
     78                                  const MCSymbol *OffsetFrom);
     79 
     80   /// Gets the offset that we should use in a table for a stack object with the
     81   /// given index. For targets using CFI (Win64, etc), this is relative to the
     82   /// established SP at the end of the prologue. For targets without CFI (Win32
     83   /// only), it is relative to the frame pointer.
     84   int getFrameIndexOffset(int FrameIndex, const WinEHFuncInfo &FuncInfo);
     85 
     86 public:
     87   //===--------------------------------------------------------------------===//
     88   // Main entry points.
     89   //
     90   WinException(AsmPrinter *A);
     91   ~WinException() override;
     92 
     93   /// Emit all exception information that should come after the content.
     94   void endModule() override;
     95 
     96   /// Gather pre-function exception information.  Assumes being emitted
     97   /// immediately after the function entry point.
     98   void beginFunction(const MachineFunction *MF) override;
     99 
    100   /// Gather and emit post-function exception information.
    101   void endFunction(const MachineFunction *) override;
    102 
    103   /// Emit target-specific EH funclet machinery.
    104   void beginFunclet(const MachineBasicBlock &MBB, MCSymbol *Sym) override;
    105   void endFunclet() override;
    106 };
    107 }
    108 
    109 #endif
    110 
    111