Rename all LayoutPrinter class to LayoutInfo

Update `LayoutPrinter` class name to `LayoutInfo` to better reflect their current usage and purpose.

Closes #76

Signed-off-by: Muhammad Sulthan Mazaya <[email protected]>

Author: MSMazaya

include/eld/Core/LinkerScript.h

@@ -45,7 +45,7 @@ class ChangeOutputSectionOp;
 class DiagnosticEngine;
 class ELFSection;
 class GeneralOptions;
-class LayoutPrinter;
+class LayoutInfo;
 class LDSymbol;
 class OutputTarWriter;
 class RuleContainer;
@@ -96,7 +96,7 @@ class LinkerScript {
   PhdrSpecList &phdrList() { return PhdrList; }
 
   void createSectionMap(LinkerScript &L, const LinkerConfig &Config,
-                        LayoutPrinter *LayoutPrinter);
+                        LayoutInfo *LayoutInfo);
 
   SectionMap &sectionMap() const { return *OutputSectionMap; }
 

include/eld/Core/Module.h

@@ -20,7 +20,7 @@
 #include "eld/Config/GeneralOptions.h"
 #include "eld/Core/Linker.h"
 #include "eld/Input/InputFile.h"
-#include "eld/LayoutMap/LayoutPrinter.h"
+#include "eld/LayoutMap/LayoutInfo.h"
 #include "eld/Plugin/PluginManager.h"
 #include "eld/PluginAPI/LinkerWrapper.h"
 #include "eld/Script/StrToken.h"
@@ -140,10 +140,10 @@ class Module {
 
 public:
   explicit Module(LinkerScript &CurScript, LinkerConfig &Config,
-                  LayoutPrinter *LayoutPrinter);
+                  LayoutInfo *LayoutInfo);
 
   Module(const std::string &Name, LinkerScript &CurScript, LinkerConfig &Config,
-         LayoutPrinter *LayoutPrinter);
+         LayoutInfo *LayoutInfo);
 
   ~Module();
 
@@ -319,7 +319,7 @@ class Module {
                                              std::string Name, uint32_t Type,
                                              uint32_t PFlag, uint32_t PAlign);
 
-  LayoutPrinter *getLayoutPrinter() { return ThisLayoutPrinter; }
+  LayoutInfo *getLayoutInfo() { return ThisLayoutInfo; }
 
   // Section symbols and all other symbols that live in the output.
   void recordSectionSymbol(ELFSection *S, ResolveInfo *R) {
@@ -660,7 +660,7 @@ class Module {
   LDSymbol *DotSymbol = nullptr;
   Linker *Linker = nullptr;
   GNULDBackend *Backend = nullptr;
-  LayoutPrinter *ThisLayoutPrinter = nullptr;
+  LayoutInfo *ThisLayoutInfo = nullptr;
   bool Failure = false;
   bool UsesLto = false;
   plugin::LinkerWrapper::State State = plugin::LinkerWrapper::Unknown;

include/eld/LayoutMap/LayoutPrinter.h renamed to include/eld/LayoutMap/LayoutInfo.h

@@ -1,4 +1,4 @@
-//===- LayoutPrinter.h-----------------------------------------------------===//
+//===- LayoutInfo.h-----------------------------------------------------===//
 // Part of the eld Project, under the BSD License
 // See https://github.com/qualcomm/eld/LICENSE.txt for license information.
 // SPDX-License-Identifier: BSD-3-Clause
@@ -69,7 +69,7 @@ struct LayoutFragmentInfo {
   std::vector<LDSymbol *> Symbols;
 };
 
-class LayoutPrinter {
+class LayoutInfo {
   static uint32_t LayoutDetail;
 
 public:
@@ -182,7 +182,7 @@ class LayoutPrinter {
 
   // -------------------End Typedefs ---------------------------------
 
-  LayoutPrinter(LinkerConfig &PConfig);
+  LayoutInfo(LinkerConfig &PConfig);
 
   bool showStrings() const { return LayoutDetail & ShowStrings; }
 
@@ -230,7 +230,7 @@ class LayoutPrinter {
   void recordOutputFileSize(uint32_t Sz) { LinkStats.OutputFileSize = Sz; }
 
   // FIXME: Destructor is redundant here.
-  ~LayoutPrinter() { destroy(); }
+  ~LayoutInfo() { destroy(); }
 
   // FIXME: This function is not required.
   void destroy() {
@@ -450,7 +450,7 @@ class LayoutPrinter {
   LinkerConfig &ThisConfig;
   /// It is required to compute relative path when -MapDetail
   /// 'show-relative-path=...' is used.
-  // It needs to be 'static' because LayoutPrinter::setLayoutDetail member
+  // It needs to be 'static' because LayoutInfo::setLayoutDetail member
   // function is static.
   static std::optional<std::string> ThisBasepath;
   std::optional<uint32_t> OutputFileSize;

include/eld/LayoutMap/TextLayoutPrinter.h

@@ -8,7 +8,7 @@
 #define ELD_LAYOUTMAP_TEXTLAYOUTPRINTER_H
 #include "eld/Diagnostics/DiagnosticPrinter.h"
 #include "eld/Input/Input.h"
-#include "eld/LayoutMap/LayoutPrinter.h"
+#include "eld/LayoutMap/LayoutInfo.h"
 #include "eld/Readers/ELFSection.h"
 #include "eld/Support/MemoryArea.h"
 #include "eld/Support/MemoryRegion.h"
@@ -25,7 +25,7 @@ class LinkerConfig;
 
 class TextLayoutPrinter {
 public:
-  TextLayoutPrinter(LayoutPrinter *ThisLayoutPrinter);
+  TextLayoutPrinter(LayoutInfo *ThisLayoutInfo);
 
   eld::Expected<void> init();
 
@@ -115,7 +115,7 @@ class TextLayoutPrinter {
                               int64_t FillValue, bool IsAlign,
                               bool UseColor = false) const;
 
-  void printStats(LayoutPrinter::Stats &L, const Module &Module);
+  void printStats(LayoutInfo::Stats &L, const Module &Module);
 
   void printStat(llvm::StringRef S, uint64_t Stats);
 
@@ -160,7 +160,7 @@ class TextLayoutPrinter {
   std::string Storage;
   std::unique_ptr<llvm::raw_string_ostream> Buffer = nullptr;
   std::unique_ptr<llvm::raw_fd_ostream> LayoutFile = nullptr;
-  LayoutPrinter *ThisLayoutPrinter = nullptr;
+  LayoutInfo *ThisLayoutInfo = nullptr;
 };
 
 } // namespace eld

include/eld/LayoutMap/YamlLayoutPrinter.h

@@ -8,7 +8,7 @@
 #define ELD_LAYOUTMAP_YAMLLAYOUTPRINTER_H
 
 #include "eld/LayoutMap/LDYAML.h"
-#include "eld/LayoutMap/LayoutPrinter.h"
+#include "eld/LayoutMap/LayoutInfo.h"
 #include "eld/Support/MemoryArea.h"
 #include "eld/Support/MemoryRegion.h"
 #include "eld/Target/GNULDBackend.h"
@@ -26,7 +26,7 @@ struct CommandLineDefault {
 class YamlLayoutPrinter {
 
 public:
-  YamlLayoutPrinter(LayoutPrinter *P);
+  YamlLayoutPrinter(LayoutInfo *layoutInfo);
 
   eld::Expected<void> init();
 
@@ -50,7 +50,7 @@ class YamlLayoutPrinter {
 
   eld::LDYAML::LinkStats addStat(std::string S, uint64_t Count);
 
-  void addStats(LayoutPrinter::Stats &L,
+  void addStats(LayoutInfo::Stats &L,
                 std::vector<eld::LDYAML::LinkStats> &S);
 
   void insertCommons(std::vector<eld::LDYAML::Common> &Commons,
@@ -64,7 +64,7 @@ class YamlLayoutPrinter {
   std::string CommandLine;
   llvm::raw_fd_ostream *LayoutFile;
   llvm::raw_fd_ostream *TrampolineLayoutFile;
-  LayoutPrinter *ThisLayoutPrinter = nullptr;
+  LayoutInfo *ThisLayoutInfo = nullptr;
 };
 
 } // namespace eld

include/eld/Object/SectionMap.h

@@ -25,7 +25,7 @@
 namespace eld {
 
 class ELFSection;
-class LayoutPrinter;
+class LayoutInfo;
 class LinkerScript;
 class LinkerConfig;
 class EhFrameHdrSection;
@@ -48,7 +48,7 @@ class SectionMap {
 
 public:
   SectionMap(LinkerScript &L, const LinkerConfig &Config,
-             LayoutPrinter *LayoutPrinter);
+             LayoutInfo *LayoutInfo);
 
   ~SectionMap();
 
@@ -182,7 +182,7 @@ class SectionMap {
       SpecialSections;
   std::vector<ELFSection *> MEntrySections;
   const DiagnosticPrinter *MPrinter;
-  LayoutPrinter *MLayoutPrinter = nullptr;
+  LayoutInfo *MLayoutInfo = nullptr;
 };
 
 } // namespace eld

include/eld/SymbolResolver/IRBuilder.h

@@ -33,7 +33,7 @@ class Module;
 class LinkerConfig;
 class InputTree;
 class InputFile;
-class LayoutPrinter;
+class LayoutInfo;
 
 class IRBuilder {
 public:

include/eld/SymbolResolver/NamePool.h

@@ -29,7 +29,7 @@
 
 namespace eld {
 
-class LayoutPrinter;
+class LayoutInfo;
 class LDSymbol;
 class Module;
 class PluginManager;
@@ -84,7 +84,7 @@ class NamePool {
 
   LDSymbol *createPluginSymbol(InputFile *Input, std::string SymbolName,
                                Fragment *CurFragment, uint64_t Val,
-                               LayoutPrinter *LP);
+                               LayoutInfo *layoutInfo);
 
   size_t getNumGlobalSize() const { return GlobalSymbols.size(); }
 

include/eld/Target/GNULDBackend.h

@@ -13,7 +13,7 @@
 #ifndef ELD_TARGET_GNULDBACKEND_H
 #define ELD_TARGET_GNULDBACKEND_H
 #include "eld/GarbageCollection/GarbageCollection.h"
-#include "eld/LayoutMap/LayoutPrinter.h"
+#include "eld/LayoutMap/LayoutInfo.h"
 #include "eld/Object/ObjectBuilder.h"
 #include "eld/Readers/CommonELFSection.h"
 #include "eld/Readers/ELFExecObjParser.h"

lib/BranchIsland/BranchIslandFactory.cpp

@@ -15,7 +15,7 @@
 #include "eld/Config/LinkerConfig.h"
 #include "eld/Core/Module.h"
 #include "eld/Fragment/Fragment.h"
-#include "eld/LayoutMap/LayoutPrinter.h"
+#include "eld/LayoutMap/LayoutInfo.h"
 #include "eld/Object/ObjectLinker.h"
 #include "eld/Readers/ELFSection.h"
 #include "eld/Support/Memory.h"
@@ -83,7 +83,7 @@ BranchIslandFactory::createBranchIsland(Relocation &PReloc, Stub *S,
                                         eld::IRBuilder &PBuilder,
                                         const Relocator *PRelocator) {
   Module &PModule = PBuilder.getModule();
-  LayoutPrinter *LayoutPrinter = PBuilder.getModule().getLayoutPrinter();
+  LayoutInfo *LayoutInfo = PBuilder.getModule().getLayoutInfo();
 
   bool CloneFrag = false;
 
@@ -331,12 +331,12 @@ BranchIslandFactory::createBranchIsland(Relocation &PReloc, Stub *S,
     MatchedSection->splice(CurNodeIter, ToBeInsertedFrags);
     Symbol->resolveInfo()->setResolvedOrigin(TrampolineInput);
 
-    if (LayoutPrinter && !LayoutPrinter->showOnlyLayout()) {
+    if (LayoutInfo && !LayoutInfo->showOnlyLayout()) {
       std::lock_guard<std::mutex> Guard(Mutex);
-      LayoutPrinter->recordFragment(TrampolineInput, TrampolineInputSection,
+      LayoutInfo->recordFragment(TrampolineInput, TrampolineInputSection,
                                     Clone);
-      LayoutPrinter->recordSymbol(Clone, Symbol);
-      LayoutPrinter->recordTrampolines();
+      LayoutInfo->recordSymbol(Clone, Symbol);
+      LayoutInfo->recordTrampolines();
     }
 
     OutputElfSection->getOutputSection()->addBranchIsland(PReloc.symInfo(),