ELFObjcopy.cpp File Reference

#include "llvm/ObjCopy/ELF/ELFObjcopy.h"
#include "ELFObject.h"
#include "llvm/ADT/BitmaskEnum.h"
#include "llvm/ADT/DenseSet.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/ADT/Twine.h"
#include "llvm/BinaryFormat/ELF.h"
#include "llvm/MC/MCTargetOptions.h"
#include "llvm/ObjCopy/CommonConfig.h"
#include "llvm/ObjCopy/ELF/ELFConfig.h"
#include "llvm/Object/Binary.h"
#include "llvm/Object/ELFObjectFile.h"
#include "llvm/Object/ELFTypes.h"
#include "llvm/Object/Error.h"
#include "llvm/Option/Option.h"
#include "llvm/Support/Casting.h"
#include "llvm/Support/Compression.h"
#include "llvm/Support/Errc.h"
#include "llvm/Support/Error.h"
#include "llvm/Support/ErrorHandling.h"
#include "llvm/Support/Memory.h"
#include "llvm/Support/raw_ostream.h"
#include <algorithm>
#include <cassert>
#include <cstdlib>
#include <functional>
#include <memory>
#include <string>
#include <system_error>
#include <utility>

Go to the source code of this file.

Typedefs
using	SectionPred = std::function< bool(const SectionBase &Sec)>

Functions
static bool	isDebugSection (const SectionBase &Sec)
static bool	isDWOSection (const SectionBase &Sec)
static bool	onlyKeepDWOPred (const Object &Obj, const SectionBase &Sec)
static Expected< uint64_t >	getNewShfFlags (SectionFlag AllFlags, uint16_t EMachine)
static uint64_t	getSectionFlagsPreserveMask (uint64_t OldFlags, uint64_t NewFlags, uint16_t EMachine)
static void	setSectionType (SectionBase &Sec, uint64_t Type)
static Error	setSectionFlagsAndType (SectionBase &Sec, SectionFlag Flags, uint16_t EMachine)
static ElfType	getOutputElfType (const Binary &Bin)
static ElfType	getOutputElfType (const MachineInfo &MI)
static std::unique_ptr< Writer >	createELFWriter (const CommonConfig &Config, Object &Obj, raw_ostream &Out, ElfType OutputElfType)
static std::unique_ptr< Writer >	createWriter (const CommonConfig &Config, Object &Obj, raw_ostream &Out, ElfType OutputElfType)
static Error	dumpSectionToFile (StringRef SecName, StringRef Filename, Object &Obj)
static bool	isAArch64MappingSymbol (const Symbol &Sym)
static bool	isArmMappingSymbol (const Symbol &Sym)
static bool	isRequiredByABISymbol (const Object &Obj, const Symbol &Sym)
static bool	isUnneededSymbol (const Symbol &Sym)
static Error	updateAndRemoveSymbols (const CommonConfig &Config, const ELFConfig &ELFConfig, Object &Obj)
static Error	replaceAndRemoveSections (const CommonConfig &Config, const ELFConfig &ELFConfig, Object &Obj)
static void	addSymbol (Object &Obj, const NewSymbolInfo &SymInfo, uint8_t DefaultVisibility)
static Error	handleUserSection (const NewSectionInfo &NewSection, function_ref< Error(StringRef, ArrayRef< uint8_t >)> F)
static Error	verifyNoteSection (StringRef Name, endianness Endianness, ArrayRef< uint8_t > Data)
static Error	handleArgs (const CommonConfig &Config, const ELFConfig &ELFConfig, ElfType OutputElfType, Object &Obj)
static Error	writeOutput (const CommonConfig &Config, Object &Obj, raw_ostream &Out, ElfType OutputElfType)

Typedef Documentation

SectionPred

using SectionPred = std::function<bool(const SectionBase &Sec)>

Definition at line 47 of file ELFObjcopy.cpp.

Function Documentation

addSymbol()

static void addSymbol ( Object &  Obj, const NewSymbolInfo &  SymInfo, uint8_t  DefaultVisibility  )

static

Definition at line 559 of file ELFObjcopy.cpp.

References llvm::objcopy::elf::SectionBase::Addr, llvm::objcopy::elf::SymbolTableSection::addSymbol(), llvm::objcopy::Default, llvm::objcopy::File, llvm::objcopy::elf::Object::findSection(), llvm::objcopy::Function, llvm::objcopy::Global, llvm::objcopy::Hidden, llvm::objcopy::IndirectFunction, llvm::objcopy::Local, llvm::objcopy::Object, llvm::objcopy::Protected, llvm::objcopy::Section, llvm::ELF::SHN_ABS, llvm::ELF::STB_GLOBAL, llvm::ELF::STB_LOCAL, llvm::ELF::STB_WEAK, llvm::ELF::STT_FILE, llvm::ELF::STT_FUNC, llvm::ELF::STT_GNU_IFUNC, llvm::ELF::STT_NOTYPE, llvm::ELF::STT_OBJECT, llvm::ELF::STT_SECTION, llvm::ELF::STV_DEFAULT, llvm::ELF::STV_HIDDEN, llvm::ELF::STV_PROTECTED, llvm::objcopy::elf::SYMBOL_SIMPLE_INDEX, llvm::objcopy::elf::Object::SymbolTable, and llvm::objcopy::Weak.

Referenced by llvm::jitlink::SymbolAddressMap::addSymbols(), and handleArgs().

createELFWriter()

static std::unique_ptr< Writer > createELFWriter ( const CommonConfig &  Config, Object &  Obj, raw_ostream &  Out, ElfType  OutputElfType  )

static

Definition at line 152 of file ELFObjcopy.cpp.

References Config, llvm::objcopy::elf::ELFT_ELF32BE, llvm::objcopy::elf::ELFT_ELF32LE, llvm::objcopy::elf::ELFT_ELF64BE, llvm::objcopy::elf::ELFT_ELF64LE, and llvm_unreachable.

Referenced by createWriter().

createWriter()

static std::unique_ptr< Writer > createWriter ( const CommonConfig &  Config, Object &  Obj, raw_ostream &  Out, ElfType  OutputElfType  )

static

Definition at line 173 of file ELFObjcopy.cpp.

References Config, and createELFWriter().

Referenced by writeOutput().

dumpSectionToFile()

static Error dumpSectionToFile ( StringRef  SecName, StringRef  Filename, Object &  Obj  )

static

Definition at line 188 of file ELFObjcopy.cpp.

References llvm::FileOutputBuffer::create(), llvm::createStringError(), llvm::objcopy::elf::Object::sections(), llvm::ELF::SHT_NOBITS, llvm::StringRef::str(), llvm::Error::success(), and llvm::Expected< T >::takeError().

Referenced by handleArgs().

getNewShfFlags()

static Expected< uint64_t > getNewShfFlags ( SectionFlag  AllFlags, uint16_t  EMachine  )

static

Definition at line 66 of file ELFObjcopy.cpp.

References llvm::createStringError(), llvm::ELF::EM_X86_64, llvm::ELF::SHF_ALLOC, llvm::ELF::SHF_EXCLUDE, llvm::ELF::SHF_EXECINSTR, llvm::ELF::SHF_MERGE, llvm::ELF::SHF_STRINGS, llvm::ELF::SHF_WRITE, and llvm::ELF::SHF_X86_64_LARGE.

Referenced by setSectionFlagsAndType().

getOutputElfType() [1/2]

static ElfType getOutputElfType ( const Binary &  Bin )

static

Definition at line 131 of file ELFObjcopy.cpp.

References llvm::Bin, llvm::objcopy::elf::ELFT_ELF32BE, llvm::objcopy::elf::ELFT_ELF32LE, llvm::objcopy::elf::ELFT_ELF64BE, llvm::objcopy::elf::ELFT_ELF64LE, llvm::isa(), and llvm_unreachable.

Referenced by llvm::objcopy::elf::executeObjcopyOnBinary(), llvm::objcopy::elf::executeObjcopyOnIHex(), and llvm::objcopy::elf::executeObjcopyOnRawBinary().

getOutputElfType() [2/2]

static ElfType getOutputElfType ( const MachineInfo &  MI )

static

Definition at line 144 of file ELFObjcopy.cpp.

References llvm::objcopy::elf::ELFT_ELF32BE, llvm::objcopy::elf::ELFT_ELF32LE, llvm::objcopy::elf::ELFT_ELF64BE, llvm::objcopy::elf::ELFT_ELF64LE, and MI.

getSectionFlagsPreserveMask()

static uint64_t getSectionFlagsPreserveMask ( uint64_t  OldFlags, uint64_t  NewFlags, uint16_t  EMachine  )

static

Definition at line 91 of file ELFObjcopy.cpp.

References llvm::ELF::EM_X86_64, llvm::ELF::SHF_COMPRESSED, llvm::ELF::SHF_EXCLUDE, llvm::ELF::SHF_GROUP, llvm::ELF::SHF_INFO_LINK, llvm::ELF::SHF_LINK_ORDER, llvm::ELF::SHF_MASKOS, llvm::ELF::SHF_MASKPROC, llvm::ELF::SHF_TLS, and llvm::ELF::SHF_X86_64_LARGE.

Referenced by setSectionFlagsAndType().

handleArgs()

static Error handleArgs ( const CommonConfig &  Config, const ELFConfig &  ELFConfig, ElfType  OutputElfType, Object &  Obj  )

static

Definition at line 676 of file ELFObjcopy.cpp.

References llvm::objcopy::Add, llvm::objcopy::elf::Object::addNewSymbolTable(), llvm::objcopy::elf::Object::addSection(), addSymbol(), llvm::objcopy::ELFConfig::AllowBrokenLinks, llvm::big, Config, llvm::detail::DenseSetImpl< ValueT, MapTy, ValueInfoT >::count(), llvm::createStringError(), llvm::Data, dumpSectionToFile(), llvm::objcopy::elf::ELFT_ELF32LE, llvm::objcopy::elf::ELFT_ELF64LE, llvm::detail::DenseSetImpl< ValueT, MapTy, ValueInfoT >::end(), llvm::objcopy::elf::Object::Entry, llvm::objcopy::ELFConfig::EntryExpr, llvm::ELF::ET_REL, llvm::detail::DenseSetImpl< ValueT, MapTy, ValueInfoT >::find(), llvm::objcopy::elf::SectionBase::Flags, handleUserSection(), I, llvm::detail::DenseSetImpl< ValueT, MapTy, ValueInfoT >::insert(), llvm::invalid_argument, llvm::little, llvm::objcopy::elf::Object::Machine, llvm::make_range(), Name, llvm::objcopy::elf::SectionBase::Name, llvm::objcopy::SectionRename::NewFlags, llvm::objcopy::SectionFlagsUpdate::NewFlags, llvm::objcopy::SectionRename::NewName, llvm::objcopy::ELFConfig::NewSymbolVisibility, llvm::objcopy::elf::Object::OSABI, llvm::objcopy::elf::Object::removeSections(), replaceAndRemoveSections(), llvm::objcopy::elf::Object::sections(), llvm::objcopy::elf::Object::segments(), llvm::objcopy::Set, setSectionFlagsAndType(), setSectionType(), llvm::ELF::SHF_ALLOC, llvm::ELF::SHT_NOBITS, llvm::ELF::SHT_NOTE, llvm::objcopy::Subtract, llvm::Error::success(), llvm::objcopy::elf::Object::SymbolTable, llvm::StringMap< ValueTy, AllocatorTy >::try_emplace(), llvm::objcopy::elf::SectionBase::Type, llvm::objcopy::elf::Object::Type, updateAndRemoveSymbols(), llvm::objcopy::elf::Object::updateSection(), llvm::Twine::utohexstr(), verifyNoteSection(), and llvm::objcopy::ELFConfig::VerifyNoteSections.

Referenced by llvm::objcopy::elf::executeObjcopyOnBinary(), llvm::objcopy::elf::executeObjcopyOnIHex(), and llvm::objcopy::elf::executeObjcopyOnRawBinary().

handleUserSection()

static Error handleUserSection ( const NewSectionInfo &  NewSection, function_ref< Error(StringRef, ArrayRef< uint8_t >)>  F  )

static

Definition at line 613 of file ELFObjcopy.cpp.

References llvm::Data, F, llvm::objcopy::NewSectionInfo::SectionData, and llvm::objcopy::NewSectionInfo::SectionName.

Referenced by handleArgs().

isAArch64MappingSymbol()

static bool isAArch64MappingSymbol ( const Symbol &  Sym )

static

Definition at line 258 of file ELFObjcopy.cpp.

References llvm::objcopy::elf::Symbol::Binding, llvm::objcopy::elf::Symbol::getShndx(), Name, llvm::objcopy::elf::Symbol::Name, llvm::ELF::SHN_UNDEF, llvm::ELF::STB_LOCAL, llvm::ELF::STT_NOTYPE, Sym, and llvm::objcopy::elf::Symbol::Type.

Referenced by isRequiredByABISymbol().

isArmMappingSymbol()

static bool isArmMappingSymbol ( const Symbol &  Sym )

static

Definition at line 268 of file ELFObjcopy.cpp.

References llvm::objcopy::elf::Symbol::Binding, llvm::objcopy::elf::Symbol::getShndx(), Name, llvm::objcopy::elf::Symbol::Name, llvm::ELF::SHN_UNDEF, llvm::ELF::STB_LOCAL, llvm::ELF::STT_NOTYPE, Sym, and llvm::objcopy::elf::Symbol::Type.

Referenced by isRequiredByABISymbol().

isDebugSection()

static bool isDebugSection ( const SectionBase &  Sec )

static

Definition at line 49 of file ELFObjcopy.cpp.

References llvm::objcopy::elf::SectionBase::Name, and llvm::StringRef::starts_with().

Referenced by replaceAndRemoveSections().

isDWOSection()

static bool isDWOSection ( const SectionBase &  Sec )

static

Definition at line 53 of file ELFObjcopy.cpp.

References llvm::StringRef::ends_with(), and llvm::objcopy::elf::SectionBase::Name.

Referenced by onlyKeepDWOPred(), and replaceAndRemoveSections().

isRequiredByABISymbol()

static bool isRequiredByABISymbol ( const Object &  Obj, const Symbol &  Sym  )

static

Definition at line 280 of file ELFObjcopy.cpp.

References llvm::ELF::EM_AARCH64, llvm::ELF::EM_ARM, isAArch64MappingSymbol(), isArmMappingSymbol(), llvm::objcopy::elf::Object::isRelocatable(), llvm::objcopy::elf::Object::Machine, and Sym.

Referenced by updateAndRemoveSymbols().

isUnneededSymbol()

static bool isUnneededSymbol ( const Symbol &  Sym )

static

Definition at line 293 of file ELFObjcopy.cpp.

References llvm::objcopy::elf::Symbol::Binding, llvm::objcopy::elf::Symbol::getShndx(), llvm::objcopy::elf::Symbol::Referenced, llvm::ELF::SHN_UNDEF, llvm::ELF::STB_LOCAL, llvm::ELF::STT_SECTION, Sym, and llvm::objcopy::elf::Symbol::Type.

Referenced by updateAndRemoveSymbols().

onlyKeepDWOPred()

static bool onlyKeepDWOPred ( const Object &  Obj, const SectionBase &  Sec  )

static

Definition at line 57 of file ELFObjcopy.cpp.

References isDWOSection(), and llvm::objcopy::elf::Object::SectionNames.

Referenced by replaceAndRemoveSections().

replaceAndRemoveSections()

static Error replaceAndRemoveSections ( const CommonConfig &  Config, const ELFConfig &  ELFConfig, Object &  Obj  )

static

Definition at line 411 of file ELFObjcopy.cpp.

References llvm::objcopy::ELFConfig::AllowBrokenLinks, llvm::objcopy::elf::Object::compressOrDecompressSections(), Config, llvm::objcopy::elf::SymbolTableSection::empty(), llvm::objcopy::elf::SymbolTableSection::getStrTab(), isDebugSection(), isDWOSection(), llvm::objcopy::ELFConfig::KeepFileSymbols, onlyKeepDWOPred(), llvm::objcopy::elf::Object::removeSections(), llvm::objcopy::elf::Object::SectionNames, llvm::ELF::SHF_ALLOC, llvm::ELF::SHT_ARM_ATTRIBUTES, llvm::ELF::SHT_LLVM_PART_EHDR, llvm::ELF::SHT_LLVM_PART_PHDR, llvm::ELF::SHT_REL, llvm::ELF::SHT_RELA, llvm::ELF::SHT_STRTAB, llvm::ELF::SHT_SYMTAB, llvm::StringRef::starts_with(), llvm::Error::success(), and llvm::objcopy::elf::Object::SymbolTable.

Referenced by handleArgs().

setSectionFlagsAndType()

static Error setSectionFlagsAndType ( SectionBase &  Sec, SectionFlag  Flags, uint16_t  EMachine  )

static

Definition at line 113 of file ELFObjcopy.cpp.

References llvm::objcopy::elf::SectionBase::Flags, getNewShfFlags(), getSectionFlagsPreserveMask(), setSectionType(), llvm::ELF::SHF_ALLOC, llvm::ELF::SHT_NOBITS, llvm::ELF::SHT_PROGBITS, llvm::Error::success(), llvm::Expected< T >::takeError(), and llvm::objcopy::elf::SectionBase::Type.

Referenced by handleArgs().

setSectionType()

static void setSectionType ( SectionBase &  Sec, uint64_t  Type  )

static

Definition at line 105 of file ELFObjcopy.cpp.

References llvm::objcopy::elf::SectionBase::Align, llvm::alignTo(), llvm::objcopy::elf::SectionBase::Offset, llvm::ELF::SHT_NOBITS, and llvm::objcopy::elf::SectionBase::Type.

Referenced by handleArgs(), and setSectionFlagsAndType().

updateAndRemoveSymbols()

static Error updateAndRemoveSymbols ( const CommonConfig &  Config, const ELFConfig &  ELFConfig, Object &  Obj  )

static

Definition at line 299 of file ELFObjcopy.cpp.

References llvm::objcopy::All, llvm::objcopy::elf::Symbol::Binding, Config, for(), llvm::objcopy::elf::Symbol::getShndx(), I, if(), llvm::objcopy::elf::Symbol::isCommon(), llvm::objcopy::elf::Object::isRelocatable(), isRequiredByABISymbol(), isUnneededSymbol(), llvm::objcopy::ELFConfig::KeepFileSymbols, llvm::objcopy::ELFConfig::LocalizeHidden, llvm::objcopy::Locals, llvm::objcopy::elf::Symbol::Name, llvm::objcopy::elf::Symbol::Referenced, llvm::objcopy::elf::Object::removeSymbols(), llvm::objcopy::elf::Object::sections(), llvm::ELF::SHN_UNDEF, llvm::StringRef::starts_with(), llvm::ELF::STB_GLOBAL, llvm::ELF::STB_LOCAL, llvm::ELF::STB_WEAK, llvm::ELF::STT_FILE, llvm::ELF::STT_SECTION, llvm::ELF::STV_HIDDEN, llvm::ELF::STV_INTERNAL, llvm::Error::success(), Sym, llvm::objcopy::ELFConfig::SymbolsToSetVisibility, llvm::objcopy::elf::Object::SymbolTable, llvm::objcopy::elf::Symbol::Type, llvm::objcopy::elf::SymbolTableSection::updateSymbols(), and llvm::objcopy::elf::Symbol::Visibility.

Referenced by handleArgs().

verifyNoteSection()

static Error verifyNoteSection ( StringRef  Name, endianness  Endianness, ArrayRef< uint8_t >  Data  )

static

Definition at line 621 of file ELFObjcopy.cpp.

References llvm::alignTo(), llvm::createStringError(), llvm::ArrayRef< T >::data(), llvm::Data, llvm::invalid_argument, Name, llvm::XCOFF::NameSize, llvm::support::endian::read32(), and llvm::Error::success().

Referenced by handleArgs().

writeOutput()

static Error writeOutput ( const CommonConfig &  Config, Object &  Obj, raw_ostream &  Out, ElfType  OutputElfType  )

static

Definition at line 924 of file ELFObjcopy.cpp.

References Config, createWriter(), llvm::objcopy::elf::Writer::finalize(), and llvm::objcopy::elf::Writer::write().

Referenced by llvm::objcopy::elf::executeObjcopyOnBinary(), llvm::objcopy::elf::executeObjcopyOnIHex(), and llvm::objcopy::elf::executeObjcopyOnRawBinary().