Use MachineBasicBlock::transferSuccessors.
[oota-llvm.git] / include / llvm / CodeGen / MachineRelocation.h
index c23b999e2ec916755576b6a1c3bac6c39670aaea..fa23a4d1c4b0f0d602d5eb0c72859964cf3cf063 100644 (file)
@@ -2,8 +2,8 @@
 //
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by the LLVM research group and is distributed under
-// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
@@ -19,6 +19,7 @@
 
 namespace llvm {
 class GlobalValue;
+class MachineBasicBlock;
 
 /// MachineRelocation - This represents a target-specific relocation value,
 /// produced by the code emitter.  This relocation is resolved after the has
@@ -38,8 +39,11 @@ class MachineRelocation {
   enum AddressType {
     isResult,         // Relocation has be transformed into its result pointer.
     isGV,             // The Target.GV field is valid.
+    isGVLazyPtr,      // Relocation of a lazily resolved GV address.
+    isBB,             // Relocation of BB address.
     isExtSym,         // The Target.ExtSym field is valid.
-    isConstPool,      // The Target.ConstPool field is valid.
+    isConstPool,      // Relocation of constant pool address.
+    isJumpTable,      // Relocation of jump table address.
     isGOTIndex        // The Target.GOTIndex field is valid.
   };
   
@@ -51,24 +55,32 @@ class MachineRelocation {
   intptr_t ConstantVal;
 
   union {
-    void *Result;        // If this has been resolved to a resolved pointer
-    GlobalValue *GV;     // If this is a pointer to an LLVM global
-    const char *ExtSym;  // If this is a pointer to a named symbol
-    unsigned ConstPool;  // In this is a pointer to a constant pool entry
-    unsigned GOTIndex;   // Index in the GOT of this symbol/global
+    void *Result;           // If this has been resolved to a resolved pointer
+    GlobalValue *GV;        // If this is a pointer to a GV or a GV lazy ptr
+    MachineBasicBlock *MBB; // If this is a pointer to a LLVM BB
+    const char *ExtSym;     // If this is a pointer to a named symbol
+    unsigned Index;         // Constant pool / jump table index
+    unsigned GOTIndex;      // Index in the GOT of this symbol/global
   } Target;
 
   unsigned TargetReloType : 6; // The target relocation ID.
-  AddressType AddrType    : 3; // The field of Target to use.
-  bool DoesntNeedFnStub   : 1; // True if we don't need a fn stub.
+  AddressType AddrType    : 4; // The field of Target to use.
+  bool NeedStub           : 1; // True if this relocation requires a stub.
   bool GOTRelative        : 1; // Should this relocation be relative to the GOT?
 
 public:
+ // Relocation types used in a generic implementation.  Currently, relocation
+ // entries for all things use the generic VANILLA type until they are refined
+ // into target relocation types.
+  enum RelocationType {
+    VANILLA
+  };
+  
   /// MachineRelocation::getGV - Return a relocation entry for a GlobalValue.
   ///
   static MachineRelocation getGV(intptr_t offset, unsigned RelocationType, 
                                  GlobalValue *GV, intptr_t cst = 0,
-                                 bool DoesntNeedFunctionStub = 0,
+                                 bool NeedStub = 0,
                                  bool GOTrelative = 0) {
     assert((RelocationType & ~63) == 0 && "Relocation type too large!");
     MachineRelocation Result;
@@ -76,12 +88,47 @@ public:
     Result.ConstantVal = cst;
     Result.TargetReloType = RelocationType;
     Result.AddrType = isGV;
-    Result.DoesntNeedFnStub = DoesntNeedFunctionStub;
+    Result.NeedStub = NeedStub;
     Result.GOTRelative = GOTrelative;
     Result.Target.GV = GV;
     return Result;
   }
 
+  /// MachineRelocation::getGVLazyPtr - Return a relocation entry for a
+  /// lazily resolved GlobalValue address.
+  static MachineRelocation getGVLazyPtr(intptr_t offset,
+                                 unsigned RelocationType, 
+                                 GlobalValue *GV, intptr_t cst = 0,
+                                 bool NeedStub = 0,
+                                 bool GOTrelative = 0) {
+    assert((RelocationType & ~63) == 0 && "Relocation type too large!");
+    MachineRelocation Result;
+    Result.Offset = offset;
+    Result.ConstantVal = cst;
+    Result.TargetReloType = RelocationType;
+    Result.AddrType = isGVLazyPtr;
+    Result.NeedStub = NeedStub;
+    Result.GOTRelative = GOTrelative;
+    Result.Target.GV = GV;
+    return Result;
+  }
+
+  /// MachineRelocation::getBB - Return a relocation entry for a BB.
+  ///
+  static MachineRelocation getBB(intptr_t offset,unsigned RelocationType,
+                                 MachineBasicBlock *MBB, intptr_t cst = 0) {
+    assert((RelocationType & ~63) == 0 && "Relocation type too large!");
+    MachineRelocation Result;
+    Result.Offset = offset;
+    Result.ConstantVal = cst;
+    Result.TargetReloType = RelocationType;
+    Result.AddrType = isBB;
+    Result.NeedStub = false;
+    Result.GOTRelative = false;
+    Result.Target.MBB = MBB;
+    return Result;
+  }
+
   /// MachineRelocation::getExtSym - Return a relocation entry for an external
   /// symbol, like "free".
   ///
@@ -94,7 +141,7 @@ public:
     Result.ConstantVal = cst;
     Result.TargetReloType = RelocationType;
     Result.AddrType = isExtSym;
-    Result.DoesntNeedFnStub = false;
+    Result.NeedStub = true;
     Result.GOTRelative = GOTrelative;
     Result.Target.ExtSym = ES;
     return Result;
@@ -111,9 +158,26 @@ public:
     Result.ConstantVal = cst;
     Result.TargetReloType = RelocationType;
     Result.AddrType = isConstPool;
-    Result.DoesntNeedFnStub = false;
+    Result.NeedStub = false;
+    Result.GOTRelative = false;
+    Result.Target.Index = CPI;
+    return Result;
+  }
+
+  /// MachineRelocation::getJumpTable - Return a relocation entry for a jump
+  /// table entry.
+  ///
+  static MachineRelocation getJumpTable(intptr_t offset,unsigned RelocationType,
+                                        unsigned JTI, intptr_t cst = 0) {
+    assert((RelocationType & ~63) == 0 && "Relocation type too large!");
+    MachineRelocation Result;
+    Result.Offset = offset;
+    Result.ConstantVal = cst;
+    Result.TargetReloType = RelocationType;
+    Result.AddrType = isJumpTable;
+    Result.NeedStub = false;
     Result.GOTRelative = false;
-    Result.Target.ConstPool = CPI;
+    Result.Target.Index = JTI;
     return Result;
   }
 
@@ -136,12 +200,31 @@ public:
     return ConstantVal;
   }
 
+  /// setConstantVal - Set the constant value associated with this relocation.
+  /// This is often an offset from the symbol.
+  ///
+  void setConstantVal(intptr_t val) {
+    ConstantVal = val;
+  }
+
   /// isGlobalValue - Return true if this relocation is a GlobalValue, as
   /// opposed to a constant string.
   bool isGlobalValue() const {
     return AddrType == isGV;
   }
 
+  /// isGlobalValueVLazyPtr - Return true if this relocation is the address
+  /// of a lazily resolved GlobalValue.
+  bool isGlobalValueLazyPtr() const {
+    return AddrType == isGVLazyPtr;
+  }
+
+  /// isBasicBlock - Return true if this relocation is a basic block reference.
+  ///
+  bool isBasicBlock() const {
+    return AddrType == isBB;
+  }
+
   /// isString - Return true if this is a constant string.
   ///
   bool isString() const {
@@ -154,28 +237,39 @@ public:
     return AddrType == isConstPool;
   }
 
+  /// isJumpTableIndex - Return true if this is a jump table reference.
+  ///
+  bool isJumpTableIndex() const {
+    return AddrType == isJumpTable;
+  }
+
   /// isGOTRelative - Return true the target wants the index into the GOT of
   /// the symbol rather than the address of the symbol.
   bool isGOTRelative() const {
     return GOTRelative;
   }
 
-  /// doesntNeedFunctionStub - This function returns true if the JIT for this
-  /// target is capable of directly handling the relocated instruction without
-  /// using a stub function.  It is always conservatively correct for this flag
-  /// to be false, but targets can improve their compilation callback functions
-  /// to handle more general cases if they want improved performance.
-  bool doesntNeedFunctionStub() const {
-    return DoesntNeedFnStub;
+  /// doesntNeedStub - This function returns true if the JIT for this target
+  /// target is capable of directly handling the relocated GlobalValue reference
+  /// without using either a stub function or issuing an extra load to get the
+  /// GV address.
+  bool doesntNeedStub() const {
+    return !NeedStub;
   }
 
   /// getGlobalValue - If this is a global value reference, return the
   /// referenced global.
   GlobalValue *getGlobalValue() const {
-    assert(isGlobalValue() && "This is not a global value reference!");
+    assert((isGlobalValue() || isGlobalValueLazyPtr()) &&
+           "This is not a global value reference!");
     return Target.GV;
   }
 
+  MachineBasicBlock *getBasicBlock() const {
+    assert(isBasicBlock() && "This is not a basic block reference!");
+    return Target.MBB;
+  }
+
   /// getString - If this is a string value, return the string reference.
   ///
   const char *getString() const {
@@ -187,7 +281,14 @@ public:
   /// the index into the constant pool.
   unsigned getConstantPoolIndex() const {
     assert(isConstantPoolIndex() && "This is not a constant pool reference!");
-    return Target.ConstPool;
+    return Target.Index;
+  }
+
+  /// getJumpTableIndex - If this is a jump table reference, return
+  /// the index into the jump table.
+  unsigned getJumpTableIndex() const {
+    assert(isJumpTableIndex() && "This is not a jump table reference!");
+    return Target.Index;
   }
 
   /// getResultPointer - Once this has been resolved to point to an actual