Visitor.hpp

Go to the documentation of this file.

/* Copyright 2017 - 2024 R. Thomas
* Copyright 2017 - 2024 Quarkslab
* Copyright 2017 - 2021 K. Nakagawa
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef LIEF_VISITOR_H
#define LIEF_VISITOR_H
#include <set>
#include <utility>
#include <cstddef>
 
#include "LIEF/visibility.h"
#include "LIEF/visitor_macros.hpp"
 
 
namespace LIEF {
// Forward declarations
// ====================
class Object;
LIEF_ABSTRACT_FORWARD(Binary)
LIEF_ABSTRACT_FORWARD(Header)
LIEF_ABSTRACT_FORWARD(Section)
LIEF_ABSTRACT_FORWARD(Symbol)
LIEF_ABSTRACT_FORWARD(Relocation)
LIEF_ABSTRACT_FORWARD(Function)
 
// PE
// ===============================
LIEF_PE_FORWARD(Binary)
LIEF_PE_FORWARD(DelayImport)
LIEF_PE_FORWARD(DelayImportEntry)
LIEF_PE_FORWARD(DosHeader)
LIEF_PE_FORWARD(Header)
LIEF_PE_FORWARD(OptionalHeader)
LIEF_PE_FORWARD(RichHeader)
LIEF_PE_FORWARD(RichEntry)
LIEF_PE_FORWARD(DataDirectory)
LIEF_PE_FORWARD(Section)
LIEF_PE_FORWARD(Relocation)
LIEF_PE_FORWARD(RelocationEntry)
LIEF_PE_FORWARD(Export)
LIEF_PE_FORWARD(ExportEntry)
LIEF_PE_FORWARD(TLS)
LIEF_PE_FORWARD(Symbol)
LIEF_PE_FORWARD(Debug)
LIEF_PE_FORWARD(CodeView)
LIEF_PE_FORWARD(CodeViewPDB)
LIEF_PE_FORWARD(Import)
LIEF_PE_FORWARD(ImportEntry)
LIEF_PE_FORWARD(ResourceNode)
LIEF_PE_FORWARD(ResourceData)
LIEF_PE_FORWARD(ResourceDirectory)
LIEF_PE_FORWARD(ResourcesManager)
LIEF_PE_FORWARD(ResourceVersion)
LIEF_PE_FORWARD(ResourceStringFileInfo)
LIEF_PE_FORWARD(ResourceFixedFileInfo)
LIEF_PE_FORWARD(ResourceVarFileInfo)
LIEF_PE_FORWARD(LangCodeItem)
LIEF_PE_FORWARD(ResourceIcon)
LIEF_PE_FORWARD(ResourceDialog)
LIEF_PE_FORWARD(ResourceDialogItem)
LIEF_PE_FORWARD(ResourceStringTable)
LIEF_PE_FORWARD(ResourceAccelerator)
 
LIEF_PE_FORWARD(Signature)
LIEF_PE_FORWARD(x509)
LIEF_PE_FORWARD(SignerInfo)
LIEF_PE_FORWARD(ContentInfo)
LIEF_PE_FORWARD(GenericContent)
LIEF_PE_FORWARD(SpcIndirectData)
LIEF_PE_FORWARD(Attribute)
LIEF_PE_FORWARD(ContentType)
LIEF_PE_FORWARD(GenericType)
LIEF_PE_FORWARD(MsCounterSign)
LIEF_PE_FORWARD(MsSpcNestedSignature)
LIEF_PE_FORWARD(MsSpcStatementType)
LIEF_PE_FORWARD(MsManifestBinaryID)
LIEF_PE_FORWARD(PKCS9AtSequenceNumber)
LIEF_PE_FORWARD(PKCS9CounterSignature)
LIEF_PE_FORWARD(PKCS9MessageDigest)
LIEF_PE_FORWARD(PKCS9SigningTime)
LIEF_PE_FORWARD(SpcSpOpusInfo)
LIEF_PE_FORWARD(SigningCertificateV2)
LIEF_PE_FORWARD(SpcRelaxedPeMarkerCheck)
 
LIEF_PE_FORWARD(CodeIntegrity)
LIEF_PE_FORWARD(LoadConfiguration)
LIEF_PE_FORWARD(LoadConfigurationV0)
LIEF_PE_FORWARD(LoadConfigurationV1)
LIEF_PE_FORWARD(LoadConfigurationV10)
LIEF_PE_FORWARD(LoadConfigurationV11)
LIEF_PE_FORWARD(LoadConfigurationV2)
LIEF_PE_FORWARD(LoadConfigurationV3)
LIEF_PE_FORWARD(LoadConfigurationV4)
LIEF_PE_FORWARD(LoadConfigurationV5)
LIEF_PE_FORWARD(LoadConfigurationV6)
LIEF_PE_FORWARD(LoadConfigurationV7)
LIEF_PE_FORWARD(LoadConfigurationV8)
LIEF_PE_FORWARD(LoadConfigurationV9)
LIEF_PE_FORWARD(Pogo)
LIEF_PE_FORWARD(PogoEntry)
LIEF_PE_FORWARD(Repro)
 
// ELF
// ==================================
LIEF_ELF_FORWARD(Binary)
LIEF_ELF_FORWARD(Header)
LIEF_ELF_FORWARD(Section)
LIEF_ELF_FORWARD(Segment)
LIEF_ELF_FORWARD(DynamicEntry)
LIEF_ELF_FORWARD(DynamicEntryArray)
LIEF_ELF_FORWARD(DynamicEntryLibrary)
LIEF_ELF_FORWARD(DynamicSharedObject)
LIEF_ELF_FORWARD(DynamicEntryRunPath)
LIEF_ELF_FORWARD(DynamicEntryRpath)
LIEF_ELF_FORWARD(DynamicEntryFlags)
LIEF_ELF_FORWARD(Symbol)
LIEF_ELF_FORWARD(Relocation)
LIEF_ELF_FORWARD(SymbolVersion)
LIEF_ELF_FORWARD(SymbolVersionRequirement)
LIEF_ELF_FORWARD(SymbolVersionDefinition)
LIEF_ELF_FORWARD(SymbolVersionAux)
LIEF_ELF_FORWARD(SymbolVersionAuxRequirement)
LIEF_ELF_FORWARD(Note)
LIEF_ELF_FORWARD(AndroidIdent)
LIEF_ELF_FORWARD(QNXStack)
LIEF_ELF_FORWARD(NoteAbi)
LIEF_ELF_FORWARD(NoteGnuProperty)
LIEF_ELF_FORWARD(CorePrPsInfo)
LIEF_ELF_FORWARD(CorePrStatus)
LIEF_ELF_FORWARD(CoreAuxv)
LIEF_ELF_FORWARD(CoreSigInfo)
LIEF_ELF_FORWARD(CoreFile)
LIEF_ELF_FORWARD(GnuHash)
LIEF_ELF_FORWARD(SysvHash)
 
 
// MACHO
// ===============================
LIEF_MACHO_FORWARD(Binary)
LIEF_MACHO_FORWARD(Header)
LIEF_MACHO_FORWARD(LoadCommand)
LIEF_MACHO_FORWARD(UUIDCommand)
LIEF_MACHO_FORWARD(SymbolCommand)
LIEF_MACHO_FORWARD(SegmentCommand)
LIEF_MACHO_FORWARD(Section)
LIEF_MACHO_FORWARD(MainCommand)
LIEF_MACHO_FORWARD(DynamicSymbolCommand)
LIEF_MACHO_FORWARD(DylinkerCommand)
LIEF_MACHO_FORWARD(DylibCommand)
LIEF_MACHO_FORWARD(ThreadCommand)
LIEF_MACHO_FORWARD(RPathCommand)
LIEF_MACHO_FORWARD(Symbol)
LIEF_MACHO_FORWARD(Relocation)
LIEF_MACHO_FORWARD(RelocationObject)
LIEF_MACHO_FORWARD(RelocationDyld)
LIEF_MACHO_FORWARD(RelocationFixup)
LIEF_MACHO_FORWARD(BindingInfo)
LIEF_MACHO_FORWARD(DyldBindingInfo)
LIEF_MACHO_FORWARD(DyldExportsTrie)
LIEF_MACHO_FORWARD(ChainedBindingInfo)
LIEF_MACHO_FORWARD(ExportInfo)
LIEF_MACHO_FORWARD(FunctionStarts)
LIEF_MACHO_FORWARD(CodeSignature)
LIEF_MACHO_FORWARD(DataInCode)
LIEF_MACHO_FORWARD(DataCodeEntry)
LIEF_MACHO_FORWARD(SourceVersion)
LIEF_MACHO_FORWARD(VersionMin)
LIEF_MACHO_FORWARD(SegmentSplitInfo)
LIEF_MACHO_FORWARD(SubFramework)
LIEF_MACHO_FORWARD(DyldEnvironment)
LIEF_MACHO_FORWARD(EncryptionInfo)
LIEF_MACHO_FORWARD(BuildVersion)
LIEF_MACHO_FORWARD(BuildToolVersion)
LIEF_MACHO_FORWARD(FilesetCommand)
LIEF_MACHO_FORWARD(TwoLevelHints)
LIEF_MACHO_FORWARD(CodeSignatureDir)
LIEF_MACHO_FORWARD(LinkerOptHint)
LIEF_MACHO_FORWARD(UnknownCommand)
 
// OAT
// ===============================
LIEF_OAT_FORWARD(Binary)
LIEF_OAT_FORWARD(Header)
LIEF_OAT_FORWARD(DexFile)
LIEF_OAT_FORWARD(Method)
LIEF_OAT_FORWARD(Class)
 
// DEX
// ===============================
LIEF_DEX_FORWARD(File)
LIEF_DEX_FORWARD(Field)
LIEF_DEX_FORWARD(Method)
LIEF_DEX_FORWARD(Header)
LIEF_DEX_FORWARD(Class)
LIEF_DEX_FORWARD(CodeInfo)
LIEF_DEX_FORWARD(Type)
LIEF_DEX_FORWARD(Prototype)
LIEF_DEX_FORWARD(MapItem)
LIEF_DEX_FORWARD(MapList)
 
// VDEX
// ===============================
LIEF_VDEX_FORWARD(File)
LIEF_VDEX_FORWARD(Header)
 
// ART
// ===============================
LIEF_ART_FORWARD(File)
LIEF_ART_FORWARD(Header)
 
 
class LIEF_API Visitor {
  public:
  Visitor();
  virtual ~Visitor();
 
  virtual void operator()();
 
  template<typename Arg1, typename... Args>
  void operator()(Arg1&& arg1, Args&&... args);
 
  virtual void visit(const Object&);
 
  // Abstract Part
  // =============
 
  LIEF_ABSTRACT_VISITABLE(Binary)
 
  
  LIEF_ABSTRACT_VISITABLE(Header)
 
  LIEF_ABSTRACT_VISITABLE(Section)
 
  LIEF_ABSTRACT_VISITABLE(Symbol)
 
  LIEF_ABSTRACT_VISITABLE(Relocation)
 
  LIEF_ABSTRACT_VISITABLE(Function)
 
  LIEF_ELF_VISITABLE(Binary)
  LIEF_ELF_VISITABLE(Header)
  LIEF_ELF_VISITABLE(Section)
  LIEF_ELF_VISITABLE(Segment)
  LIEF_ELF_VISITABLE(DynamicEntry)
  LIEF_ELF_VISITABLE(DynamicEntryArray)
  LIEF_ELF_VISITABLE(DynamicEntryLibrary)
  LIEF_ELF_VISITABLE(DynamicSharedObject)
  LIEF_ELF_VISITABLE(DynamicEntryRunPath)
  LIEF_ELF_VISITABLE(DynamicEntryRpath)
  LIEF_ELF_VISITABLE(DynamicEntryFlags)
  LIEF_ELF_VISITABLE(Symbol)
  LIEF_ELF_VISITABLE(Relocation)
  LIEF_ELF_VISITABLE(SymbolVersion)
  LIEF_ELF_VISITABLE(SymbolVersionRequirement)
  LIEF_ELF_VISITABLE(SymbolVersionDefinition)
  LIEF_ELF_VISITABLE(SymbolVersionAux)
  LIEF_ELF_VISITABLE(SymbolVersionAuxRequirement)
  LIEF_ELF_VISITABLE(Note)
  LIEF_ELF_VISITABLE(AndroidIdent)
  LIEF_ELF_VISITABLE(QNXStack)
  LIEF_ELF_VISITABLE(NoteAbi)
  LIEF_ELF_VISITABLE(NoteGnuProperty)
  LIEF_ELF_VISITABLE(CorePrPsInfo)
  LIEF_ELF_VISITABLE(CorePrStatus)
  LIEF_ELF_VISITABLE(CoreAuxv)
  LIEF_ELF_VISITABLE(CoreSigInfo)
  LIEF_ELF_VISITABLE(CoreFile)
  LIEF_ELF_VISITABLE(GnuHash)
  LIEF_ELF_VISITABLE(SysvHash)
 
  // PE Part
  // =======
  LIEF_PE_VISITABLE(Binary)
 
  LIEF_PE_VISITABLE(DosHeader)
 
  LIEF_PE_VISITABLE(RichHeader)
 
  LIEF_PE_VISITABLE(RichEntry)
 
  LIEF_PE_VISITABLE(Header)
 
  LIEF_PE_VISITABLE(OptionalHeader)
 
  LIEF_PE_VISITABLE(DataDirectory)
 
  LIEF_PE_VISITABLE(TLS)
 
  LIEF_PE_VISITABLE(Symbol)
 
  LIEF_PE_VISITABLE(Section)
 
  LIEF_PE_VISITABLE(Relocation)
 
  LIEF_PE_VISITABLE(RelocationEntry)
 
  LIEF_PE_VISITABLE(Export)
 
  LIEF_PE_VISITABLE(ExportEntry)
 
  LIEF_PE_VISITABLE(Debug)
 
  LIEF_PE_VISITABLE(CodeView)
 
  LIEF_PE_VISITABLE(CodeViewPDB)
 
  LIEF_PE_VISITABLE(Import)
 
  LIEF_PE_VISITABLE(ImportEntry)
 
  LIEF_PE_VISITABLE(DelayImport)
 
  LIEF_PE_VISITABLE(DelayImportEntry)
 
  LIEF_PE_VISITABLE(ResourceNode)
 
  LIEF_PE_VISITABLE(ResourceData)
 
  LIEF_PE_VISITABLE(ResourceDirectory)
 
  LIEF_PE_VISITABLE(ResourcesManager)
 
  LIEF_PE_VISITABLE(ResourceVersion)
 
  LIEF_PE_VISITABLE(ResourceStringFileInfo)
 
  LIEF_PE_VISITABLE(ResourceFixedFileInfo)
 
  LIEF_PE_VISITABLE(ResourceVarFileInfo)
 
  LIEF_PE_VISITABLE(ResourceStringTable)
 
  LIEF_PE_VISITABLE(ResourceAccelerator)
 
  LIEF_PE_VISITABLE(LangCodeItem)
 
  LIEF_PE_VISITABLE(ResourceIcon)
 
  LIEF_PE_VISITABLE(ResourceDialog)
 
  LIEF_PE_VISITABLE(ResourceDialogItem)
 
  LIEF_PE_VISITABLE(Signature)
 
  LIEF_PE_VISITABLE(x509)
 
  LIEF_PE_VISITABLE(SignerInfo)
 
  LIEF_PE_VISITABLE(ContentInfo)
 
  LIEF_PE_VISITABLE(Attribute)
 
  LIEF_PE_VISITABLE(ContentType)
 
  LIEF_PE_VISITABLE(GenericContent)
 
  LIEF_PE_VISITABLE(SpcIndirectData)
 
  LIEF_PE_VISITABLE(GenericType)
 
  LIEF_PE_VISITABLE(MsCounterSign)
 
  LIEF_PE_VISITABLE(MsManifestBinaryID)
 
  LIEF_PE_VISITABLE(MsSpcNestedSignature)
 
  LIEF_PE_VISITABLE(MsSpcStatementType)
 
  LIEF_PE_VISITABLE(PKCS9AtSequenceNumber)
 
  LIEF_PE_VISITABLE(PKCS9CounterSignature)
 
  LIEF_PE_VISITABLE(PKCS9MessageDigest)
 
  LIEF_PE_VISITABLE(PKCS9SigningTime)
 
  LIEF_PE_VISITABLE(SpcSpOpusInfo)
 
  LIEF_PE_VISITABLE(SpcRelaxedPeMarkerCheck)
 
  LIEF_PE_VISITABLE(SigningCertificateV2)
 
  LIEF_PE_VISITABLE(LoadConfiguration)
 
  LIEF_PE_VISITABLE(LoadConfigurationV0)
 
  LIEF_PE_VISITABLE(LoadConfigurationV1)
 
  LIEF_PE_VISITABLE(LoadConfigurationV2)
 
  LIEF_PE_VISITABLE(LoadConfigurationV3)
 
  LIEF_PE_VISITABLE(LoadConfigurationV4)
 
  LIEF_PE_VISITABLE(LoadConfigurationV5)
 
  LIEF_PE_VISITABLE(LoadConfigurationV6)
 
  LIEF_PE_VISITABLE(LoadConfigurationV7)
 
  LIEF_PE_VISITABLE(LoadConfigurationV8)
 
  LIEF_PE_VISITABLE(LoadConfigurationV9)
 
  LIEF_PE_VISITABLE(LoadConfigurationV10)
 
  LIEF_PE_VISITABLE(LoadConfigurationV11)
 
  LIEF_PE_VISITABLE(CodeIntegrity)
 
  LIEF_PE_VISITABLE(Pogo)
 
  LIEF_PE_VISITABLE(PogoEntry)
 
  LIEF_PE_VISITABLE(Repro)
 
  // MachO part
  // ==========
  LIEF_MACHO_VISITABLE(Binary)
 
  LIEF_MACHO_VISITABLE(Header)
 
  LIEF_MACHO_VISITABLE(LoadCommand)
 
  LIEF_MACHO_VISITABLE(UUIDCommand)
 
  LIEF_MACHO_VISITABLE(SymbolCommand)
 
  LIEF_MACHO_VISITABLE(SegmentCommand)
 
  LIEF_MACHO_VISITABLE(Section)
 
  LIEF_MACHO_VISITABLE(MainCommand)
 
  LIEF_MACHO_VISITABLE(DynamicSymbolCommand)
 
  LIEF_MACHO_VISITABLE(DylinkerCommand)
 
  LIEF_MACHO_VISITABLE(DylibCommand)
 
  LIEF_MACHO_VISITABLE(ThreadCommand)
 
  LIEF_MACHO_VISITABLE(RPathCommand)
 
  LIEF_MACHO_VISITABLE(Symbol)
 
  LIEF_MACHO_VISITABLE(Relocation)
 
  LIEF_MACHO_VISITABLE(RelocationObject)
 
  LIEF_MACHO_VISITABLE(RelocationDyld)
 
  LIEF_MACHO_VISITABLE(RelocationFixup)
 
  LIEF_MACHO_VISITABLE(BindingInfo)
 
  LIEF_MACHO_VISITABLE(DyldBindingInfo)
 
  LIEF_MACHO_VISITABLE(ChainedBindingInfo)
 
  LIEF_MACHO_VISITABLE(DyldExportsTrie)
 
  LIEF_MACHO_VISITABLE(ExportInfo)
 
  LIEF_MACHO_VISITABLE(FunctionStarts)
 
  LIEF_MACHO_VISITABLE(CodeSignature)
 
  LIEF_MACHO_VISITABLE(DataInCode)
 
  LIEF_MACHO_VISITABLE(DataCodeEntry)
 
  LIEF_MACHO_VISITABLE(SourceVersion)
 
  LIEF_MACHO_VISITABLE(VersionMin)
 
  LIEF_MACHO_VISITABLE(SegmentSplitInfo)
 
  LIEF_MACHO_VISITABLE(SubFramework)
 
  LIEF_MACHO_VISITABLE(DyldEnvironment)
 
  LIEF_MACHO_VISITABLE(EncryptionInfo)
 
  LIEF_MACHO_VISITABLE(BuildVersion)
 
  LIEF_MACHO_VISITABLE(BuildToolVersion)
 
  LIEF_MACHO_VISITABLE(FilesetCommand)
 
  LIEF_MACHO_VISITABLE(CodeSignatureDir)
 
  LIEF_MACHO_VISITABLE(TwoLevelHints)
 
  LIEF_MACHO_VISITABLE(LinkerOptHint)
 
  LIEF_MACHO_VISITABLE(UnknownCommand)
 
  // OAT part
  // ========
 
  LIEF_OAT_VISITABLE(Binary)
 
  LIEF_OAT_VISITABLE(Header)
 
  LIEF_OAT_VISITABLE(DexFile)
 
  LIEF_OAT_VISITABLE(Class)
 
  LIEF_OAT_VISITABLE(Method)
 
 
  // DEX part
  // ========
 
  LIEF_DEX_VISITABLE(File)
 
  LIEF_DEX_VISITABLE(Field)
 
  LIEF_DEX_VISITABLE(Method)
 
  LIEF_DEX_VISITABLE(Header)
 
  LIEF_DEX_VISITABLE(Class)
 
  LIEF_DEX_VISITABLE(CodeInfo)
 
  LIEF_DEX_VISITABLE(Type)
 
  LIEF_DEX_VISITABLE(Prototype)
 
  LIEF_DEX_VISITABLE(MapList)
 
  LIEF_DEX_VISITABLE(MapItem)
 
  // VDEX part
  // =========
 
  LIEF_VDEX_VISITABLE(File)
 
  LIEF_VDEX_VISITABLE(Header)
 
  // ART part
  // =========
 
  LIEF_ART_VISITABLE(File)
 
  LIEF_ART_VISITABLE(Header)
 
  template<class T>
  void dispatch(const T& obj);
 
 
  private:
  std::set<size_t> visited_;
};
 
 
 
template<typename Arg1, typename... Args>
void Visitor::operator()(Arg1&& arg1, Args&&... args) {
  dispatch(std::forward<Arg1>(arg1));
  operator()(std::forward<Args>(args)... );
}
 
template<class T>
void Visitor::dispatch(const T& obj) {
  auto hash = reinterpret_cast<size_t>(&obj);
  if (visited_.find(hash) != std::end(visited_)) {
    // Already visited
    return;
  }
 
  visited_.insert(hash);
  visit(obj);
}
 
}
#endif