xref: /aosp_15_r20/external/llvm/lib/Object/ObjectFile.cpp (revision 9880d6810fe72a1726cb53787c6711e909410d58)
1*9880d681SAndroid Build Coastguard Worker //===- ObjectFile.cpp - File format independent object file -----*- C++ -*-===//
2*9880d681SAndroid Build Coastguard Worker //
3*9880d681SAndroid Build Coastguard Worker //                     The LLVM Compiler Infrastructure
4*9880d681SAndroid Build Coastguard Worker //
5*9880d681SAndroid Build Coastguard Worker // This file is distributed under the University of Illinois Open Source
6*9880d681SAndroid Build Coastguard Worker // License. See LICENSE.TXT for details.
7*9880d681SAndroid Build Coastguard Worker //
8*9880d681SAndroid Build Coastguard Worker //===----------------------------------------------------------------------===//
9*9880d681SAndroid Build Coastguard Worker //
10*9880d681SAndroid Build Coastguard Worker // This file defines a file format independent ObjectFile class.
11*9880d681SAndroid Build Coastguard Worker //
12*9880d681SAndroid Build Coastguard Worker //===----------------------------------------------------------------------===//
13*9880d681SAndroid Build Coastguard Worker 
14*9880d681SAndroid Build Coastguard Worker #include "llvm/Object/COFF.h"
15*9880d681SAndroid Build Coastguard Worker #include "llvm/Object/MachO.h"
16*9880d681SAndroid Build Coastguard Worker #include "llvm/Object/ObjectFile.h"
17*9880d681SAndroid Build Coastguard Worker #include "llvm/Support/ErrorHandling.h"
18*9880d681SAndroid Build Coastguard Worker #include "llvm/Support/FileSystem.h"
19*9880d681SAndroid Build Coastguard Worker #include "llvm/Support/MemoryBuffer.h"
20*9880d681SAndroid Build Coastguard Worker #include "llvm/Support/raw_ostream.h"
21*9880d681SAndroid Build Coastguard Worker #include <system_error>
22*9880d681SAndroid Build Coastguard Worker 
23*9880d681SAndroid Build Coastguard Worker using namespace llvm;
24*9880d681SAndroid Build Coastguard Worker using namespace object;
25*9880d681SAndroid Build Coastguard Worker 
anchor()26*9880d681SAndroid Build Coastguard Worker void ObjectFile::anchor() { }
27*9880d681SAndroid Build Coastguard Worker 
ObjectFile(unsigned int Type,MemoryBufferRef Source)28*9880d681SAndroid Build Coastguard Worker ObjectFile::ObjectFile(unsigned int Type, MemoryBufferRef Source)
29*9880d681SAndroid Build Coastguard Worker     : SymbolicFile(Type, Source) {}
30*9880d681SAndroid Build Coastguard Worker 
containsSymbol(SymbolRef S) const31*9880d681SAndroid Build Coastguard Worker bool SectionRef::containsSymbol(SymbolRef S) const {
32*9880d681SAndroid Build Coastguard Worker   Expected<section_iterator> SymSec = S.getSection();
33*9880d681SAndroid Build Coastguard Worker   if (!SymSec) {
34*9880d681SAndroid Build Coastguard Worker     // TODO: Actually report errors helpfully.
35*9880d681SAndroid Build Coastguard Worker     consumeError(SymSec.takeError());
36*9880d681SAndroid Build Coastguard Worker     return false;
37*9880d681SAndroid Build Coastguard Worker   }
38*9880d681SAndroid Build Coastguard Worker   return *this == **SymSec;
39*9880d681SAndroid Build Coastguard Worker }
40*9880d681SAndroid Build Coastguard Worker 
getSymbolValue(DataRefImpl Ref) const41*9880d681SAndroid Build Coastguard Worker uint64_t ObjectFile::getSymbolValue(DataRefImpl Ref) const {
42*9880d681SAndroid Build Coastguard Worker   uint32_t Flags = getSymbolFlags(Ref);
43*9880d681SAndroid Build Coastguard Worker   if (Flags & SymbolRef::SF_Undefined)
44*9880d681SAndroid Build Coastguard Worker     return 0;
45*9880d681SAndroid Build Coastguard Worker   if (Flags & SymbolRef::SF_Common)
46*9880d681SAndroid Build Coastguard Worker     return getCommonSymbolSize(Ref);
47*9880d681SAndroid Build Coastguard Worker   return getSymbolValueImpl(Ref);
48*9880d681SAndroid Build Coastguard Worker }
49*9880d681SAndroid Build Coastguard Worker 
printSymbolName(raw_ostream & OS,DataRefImpl Symb) const50*9880d681SAndroid Build Coastguard Worker std::error_code ObjectFile::printSymbolName(raw_ostream &OS,
51*9880d681SAndroid Build Coastguard Worker                                             DataRefImpl Symb) const {
52*9880d681SAndroid Build Coastguard Worker   Expected<StringRef> Name = getSymbolName(Symb);
53*9880d681SAndroid Build Coastguard Worker   if (!Name)
54*9880d681SAndroid Build Coastguard Worker     return errorToErrorCode(Name.takeError());
55*9880d681SAndroid Build Coastguard Worker   OS << *Name;
56*9880d681SAndroid Build Coastguard Worker   return std::error_code();
57*9880d681SAndroid Build Coastguard Worker }
58*9880d681SAndroid Build Coastguard Worker 
getSymbolAlignment(DataRefImpl DRI) const59*9880d681SAndroid Build Coastguard Worker uint32_t ObjectFile::getSymbolAlignment(DataRefImpl DRI) const { return 0; }
60*9880d681SAndroid Build Coastguard Worker 
isSectionBitcode(DataRefImpl Sec) const61*9880d681SAndroid Build Coastguard Worker bool ObjectFile::isSectionBitcode(DataRefImpl Sec) const {
62*9880d681SAndroid Build Coastguard Worker   StringRef SectName;
63*9880d681SAndroid Build Coastguard Worker   if (!getSectionName(Sec, SectName))
64*9880d681SAndroid Build Coastguard Worker     return SectName == ".llvmbc";
65*9880d681SAndroid Build Coastguard Worker   return false;
66*9880d681SAndroid Build Coastguard Worker }
67*9880d681SAndroid Build Coastguard Worker 
getRelocatedSection(DataRefImpl Sec) const68*9880d681SAndroid Build Coastguard Worker section_iterator ObjectFile::getRelocatedSection(DataRefImpl Sec) const {
69*9880d681SAndroid Build Coastguard Worker   return section_iterator(SectionRef(Sec, this));
70*9880d681SAndroid Build Coastguard Worker }
71*9880d681SAndroid Build Coastguard Worker 
72*9880d681SAndroid Build Coastguard Worker Expected<std::unique_ptr<ObjectFile>>
createObjectFile(MemoryBufferRef Object,sys::fs::file_magic Type)73*9880d681SAndroid Build Coastguard Worker ObjectFile::createObjectFile(MemoryBufferRef Object, sys::fs::file_magic Type) {
74*9880d681SAndroid Build Coastguard Worker   StringRef Data = Object.getBuffer();
75*9880d681SAndroid Build Coastguard Worker   if (Type == sys::fs::file_magic::unknown)
76*9880d681SAndroid Build Coastguard Worker     Type = sys::fs::identify_magic(Data);
77*9880d681SAndroid Build Coastguard Worker 
78*9880d681SAndroid Build Coastguard Worker   switch (Type) {
79*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::unknown:
80*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::bitcode:
81*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::archive:
82*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::macho_universal_binary:
83*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::windows_resource:
84*9880d681SAndroid Build Coastguard Worker     return errorCodeToError(object_error::invalid_file_type);
85*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::elf:
86*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::elf_relocatable:
87*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::elf_executable:
88*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::elf_shared_object:
89*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::elf_core:
90*9880d681SAndroid Build Coastguard Worker     return errorOrToExpected(createELFObjectFile(Object));
91*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::macho_object:
92*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::macho_executable:
93*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::macho_fixed_virtual_memory_shared_lib:
94*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::macho_core:
95*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::macho_preload_executable:
96*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::macho_dynamically_linked_shared_lib:
97*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::macho_dynamic_linker:
98*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::macho_bundle:
99*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::macho_dynamically_linked_shared_lib_stub:
100*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::macho_dsym_companion:
101*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::macho_kext_bundle:
102*9880d681SAndroid Build Coastguard Worker     return createMachOObjectFile(Object);
103*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::coff_object:
104*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::coff_import_library:
105*9880d681SAndroid Build Coastguard Worker   case sys::fs::file_magic::pecoff_executable:
106*9880d681SAndroid Build Coastguard Worker     return errorOrToExpected(createCOFFObjectFile(Object));
107*9880d681SAndroid Build Coastguard Worker   }
108*9880d681SAndroid Build Coastguard Worker   llvm_unreachable("Unexpected Object File Type");
109*9880d681SAndroid Build Coastguard Worker }
110*9880d681SAndroid Build Coastguard Worker 
111*9880d681SAndroid Build Coastguard Worker Expected<OwningBinary<ObjectFile>>
createObjectFile(StringRef ObjectPath)112*9880d681SAndroid Build Coastguard Worker ObjectFile::createObjectFile(StringRef ObjectPath) {
113*9880d681SAndroid Build Coastguard Worker   ErrorOr<std::unique_ptr<MemoryBuffer>> FileOrErr =
114*9880d681SAndroid Build Coastguard Worker       MemoryBuffer::getFile(ObjectPath);
115*9880d681SAndroid Build Coastguard Worker   if (std::error_code EC = FileOrErr.getError())
116*9880d681SAndroid Build Coastguard Worker     return errorCodeToError(EC);
117*9880d681SAndroid Build Coastguard Worker   std::unique_ptr<MemoryBuffer> Buffer = std::move(FileOrErr.get());
118*9880d681SAndroid Build Coastguard Worker 
119*9880d681SAndroid Build Coastguard Worker   Expected<std::unique_ptr<ObjectFile>> ObjOrErr =
120*9880d681SAndroid Build Coastguard Worker       createObjectFile(Buffer->getMemBufferRef());
121*9880d681SAndroid Build Coastguard Worker   if (!ObjOrErr)
122*9880d681SAndroid Build Coastguard Worker     ObjOrErr.takeError();
123*9880d681SAndroid Build Coastguard Worker   std::unique_ptr<ObjectFile> Obj = std::move(ObjOrErr.get());
124*9880d681SAndroid Build Coastguard Worker 
125*9880d681SAndroid Build Coastguard Worker   return OwningBinary<ObjectFile>(std::move(Obj), std::move(Buffer));
126*9880d681SAndroid Build Coastguard Worker }
127