Relocation is now a class.

Author: paschalis-mpeis

bolt/include/bolt/Core/BinarySection.h

@@ -361,15 +361,13 @@ class BinarySection {
   void addRelocation(uint64_t Offset, MCSymbol *Symbol, uint32_t Type,
                      uint64_t Addend, uint64_t Value = 0) {
     assert(Offset < getSize() && "offset not within section bounds");
-    Relocations.emplace(
-        Relocation{Offset, Symbol, Type, /* Optional */ false, Addend, Value});
+    Relocations.emplace(Relocation{Offset, Symbol, Type, Addend, Value});
   }
 
   /// Add a dynamic relocation at the given /p Offset.
   void addDynamicRelocation(uint64_t Offset, MCSymbol *Symbol, uint32_t Type,
                             uint64_t Addend, uint64_t Value = 0) {
-    addDynamicRelocation(
-        Relocation{Offset, Symbol, Type, /*Optional*/ false, Addend, Value});
+    addDynamicRelocation(Relocation{Offset, Symbol, Type, Addend, Value});
   }
 
   void addDynamicRelocation(const Relocation &Reloc) {
@@ -403,13 +401,13 @@ class BinarySection {
 
   /// Lookup the relocation (if any) at the given /p Offset.
   const Relocation *getDynamicRelocationAt(uint64_t Offset) const {
-    Relocation Key{Offset, 0, 0, 0, 0, 0};
+    Relocation Key{Offset, 0, 0, 0, 0};
     auto Itr = DynamicRelocations.find(Key);
     return Itr != DynamicRelocations.end() ? &*Itr : nullptr;
   }
 
   std::optional<Relocation> takeDynamicRelocationAt(uint64_t Offset) {
-    Relocation Key{Offset, 0, 0, 0, 0, 0};
+    Relocation Key{Offset, 0, 0, 0, 0};
     auto Itr = DynamicRelocations.find(Key);
 
     if (Itr == DynamicRelocations.end())

bolt/include/bolt/Core/Relocation.h

@@ -35,7 +35,16 @@ enum { R_X86_64_converted_reloc_bit = 0x80 };
 namespace bolt {
 
 /// Relocation class.
-struct Relocation {
+class Relocation {
+public:
+  Relocation(uint64_t Offset, MCSymbol *Symbol, uint32_t Type, uint64_t Addend,
+             uint64_t Value)
+      : Offset(Offset), Symbol(Symbol), Type(Type), Optional(false),
+        Addend(Addend), Value(Value) {}
+
+  Relocation()
+      : Offset(0), Symbol(0), Type(0), Optional(0), Addend(0), Value(0) {}
+
   static Triple::ArchType Arch; /// set by BinaryContext ctor.
 
   /// The offset of this relocation in the object it is contained in.
@@ -47,9 +56,11 @@ struct Relocation {
   /// Relocation type.
   uint32_t Type;
 
+private:
   /// Relocations added by optimizations can be optional.
   bool Optional = false;
 
+public:
   /// The offset from the \p Symbol base used to compute the final
   /// value of this relocation.
   uint64_t Addend;

bolt/lib/Core/BinaryFunction.cpp

@@ -4635,8 +4635,7 @@ void BinaryFunction::addRelocation(uint64_t Address, MCSymbol *Symbol,
   std::map<uint64_t, Relocation> &Rels =
       IsCI ? Islands->Relocations : Relocations;
   if (BC.MIB->shouldRecordCodeRelocation(RelType))
-    Rels[Offset] =
-        Relocation{Offset, Symbol, RelType, /*Optional*/ false, Addend, Value};
+    Rels[Offset] = Relocation{Offset, Symbol, RelType, Addend, Value};
 }
 
 } // namespace bolt

bolt/lib/Core/BinarySection.cpp

@@ -49,8 +49,8 @@ BinarySection::hash(const BinaryData &BD,
 
   uint64_t Offset = BD.getAddress() - getAddress();
   const uint64_t EndOffset = BD.getEndAddress() - getAddress();
-  auto Begin = Relocations.lower_bound(Relocation{Offset, 0, 0, 0, 0, 0});
-  auto End = Relocations.upper_bound(Relocation{EndOffset, 0, 0, 0, 0, 0});
+  auto Begin = Relocations.lower_bound(Relocation{Offset, 0, 0, 0, 0});
+  auto End = Relocations.upper_bound(Relocation{EndOffset, 0, 0, 0, 0});
   const StringRef Contents = getContents();
 
   while (Begin != End) {

bolt/lib/Rewrite/RewriteInstance.cpp

@@ -1420,7 +1420,7 @@ void RewriteInstance::updateRtFiniReloc() {
   // desired value.
   FiniArraySection->addPendingRelocation(Relocation{
       /*Offset*/ 0, /*Symbol*/ nullptr, /*Type*/ Relocation::getAbs64(),
-      /*Optional*/ false, /*Addend*/ RT->getRuntimeFiniAddress(), /*Value*/ 0});
+      /*Addend*/ RT->getRuntimeFiniAddress(), /*Value*/ 0});
 }
 
 void RewriteInstance::registerFragments() {

bolt/lib/Target/AArch64/AArch64MCPlusBuilder.cpp

@@ -2291,8 +2291,7 @@ class AArch64MCPlusBuilder : public MCPlusBuilder {
 
     auto [RelSymbol, RelAddend] = extractFixupExpr(Fixup);
 
-    return Relocation(
-        {RelOffset, RelSymbol, RelType, /*Optional*/ false, RelAddend, 0});
+    return Relocation({RelOffset, RelSymbol, RelType, RelAddend, 0});
   }
 
   uint16_t getMinFunctionAlignment() const override { return 4; }

bolt/lib/Target/X86/X86MCPlusBuilder.cpp

@@ -2467,8 +2467,7 @@ class X86MCPlusBuilder : public MCPlusBuilder {
 
     auto [RelSymbol, RelAddend] = extractFixupExpr(Fixup);
 
-    return Relocation(
-        {RelOffset, RelSymbol, RelType, /*Optional*/ false, RelAddend, 0});
+    return Relocation({RelOffset, RelSymbol, RelType, RelAddend, 0});
   }
 
   bool replaceImmWithSymbolRef(MCInst &Inst, const MCSymbol *Symbol,

bolt/unittests/Core/BinaryContext.cpp

@@ -96,12 +96,12 @@ TEST_P(BinaryContextTester, FlushPendingRelocCALL26) {
       DataSize, 4);
   MCSymbol *RelSymbol1 = BC->getOrCreateGlobalSymbol(4, "Func1");
   ASSERT_TRUE(RelSymbol1);
-  BS.addPendingRelocation(Relocation{8, RelSymbol1, ELF::R_AARCH64_CALL26,
-                                     /*Optional*/ false, 0, 0});
+  BS.addPendingRelocation(
+      Relocation{8, RelSymbol1, ELF::R_AARCH64_CALL26, 0, 0});
   MCSymbol *RelSymbol2 = BC->getOrCreateGlobalSymbol(16, "Func2");
   ASSERT_TRUE(RelSymbol2);
-  BS.addPendingRelocation(Relocation{12, RelSymbol2, ELF::R_AARCH64_CALL26,
-                                     /*Optional*/ false, 0, 0});
+  BS.addPendingRelocation(
+      Relocation{12, RelSymbol2, ELF::R_AARCH64_CALL26, 0, 0});
 
   SmallVector<char> Vect(DataSize);
   raw_svector_ostream OS(Vect);
@@ -138,12 +138,12 @@ TEST_P(BinaryContextTester, FlushPendingRelocJUMP26) {
       (uint8_t *)Data, Size, 4);
   MCSymbol *RelSymbol1 = BC->getOrCreateGlobalSymbol(4, "Func1");
   ASSERT_TRUE(RelSymbol1);
-  BS.addPendingRelocation(Relocation{8, RelSymbol1, ELF::R_AARCH64_JUMP26,
-                                     /*Optional*/ false, 0, 0});
+  BS.addPendingRelocation(
+      Relocation{8, RelSymbol1, ELF::R_AARCH64_JUMP26, 0, 0});
   MCSymbol *RelSymbol2 = BC->getOrCreateGlobalSymbol(16, "Func2");
   ASSERT_TRUE(RelSymbol2);
-  BS.addPendingRelocation(Relocation{12, RelSymbol2, ELF::R_AARCH64_JUMP26,
-                                     /*Optional*/ false, 0, 0});
+  BS.addPendingRelocation(
+      Relocation{12, RelSymbol2, ELF::R_AARCH64_JUMP26, 0, 0});
 
   SmallVector<char> Vect(Size);
   raw_svector_ostream OS(Vect);