1 //===- Binary.cpp - A generic binary file ---------------------------------===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 // This file defines the Binary class.
11 //===----------------------------------------------------------------------===//
13 #include "llvm/Object/Binary.h"
14 #include "llvm/ADT/StringRef.h"
15 #include "llvm/BinaryFormat/Magic.h"
16 #include "llvm/Object/Archive.h"
17 #include "llvm/Object/Error.h"
18 #include "llvm/Object/MachOUniversal.h"
19 #include "llvm/Object/Minidump.h"
20 #include "llvm/Object/ObjectFile.h"
21 #include "llvm/Object/TapiUniversal.h"
22 #include "llvm/Object/WindowsResource.h"
23 #include "llvm/Support/Error.h"
24 #include "llvm/Support/ErrorHandling.h"
25 #include "llvm/Support/ErrorOr.h"
26 #include "llvm/Support/FileSystem.h"
27 #include "llvm/Support/MemoryBuffer.h"
30 #include <system_error>
33 using namespace object
;
35 Binary::~Binary() = default;
37 Binary::Binary(unsigned int Type
, MemoryBufferRef Source
)
38 : TypeID(Type
), Data(Source
) {}
40 StringRef
Binary::getData() const { return Data
.getBuffer(); }
42 StringRef
Binary::getFileName() const { return Data
.getBufferIdentifier(); }
44 MemoryBufferRef
Binary::getMemoryBufferRef() const { return Data
; }
46 Expected
<std::unique_ptr
<Binary
>> object::createBinary(MemoryBufferRef Buffer
,
47 LLVMContext
*Context
) {
48 file_magic Type
= identify_magic(Buffer
.getBuffer());
51 case file_magic::archive
:
52 return Archive::create(Buffer
);
54 case file_magic::elf_relocatable
:
55 case file_magic::elf_executable
:
56 case file_magic::elf_shared_object
:
57 case file_magic::elf_core
:
58 case file_magic::macho_object
:
59 case file_magic::macho_executable
:
60 case file_magic::macho_fixed_virtual_memory_shared_lib
:
61 case file_magic::macho_core
:
62 case file_magic::macho_preload_executable
:
63 case file_magic::macho_dynamically_linked_shared_lib
:
64 case file_magic::macho_dynamic_linker
:
65 case file_magic::macho_bundle
:
66 case file_magic::macho_dynamically_linked_shared_lib_stub
:
67 case file_magic::macho_dsym_companion
:
68 case file_magic::macho_kext_bundle
:
69 case file_magic::coff_object
:
70 case file_magic::coff_import_library
:
71 case file_magic::pecoff_executable
:
72 case file_magic::bitcode
:
73 case file_magic::xcoff_object_32
:
74 case file_magic::xcoff_object_64
:
75 case file_magic::wasm_object
:
76 return ObjectFile::createSymbolicFile(Buffer
, Type
, Context
);
77 case file_magic::macho_universal_binary
:
78 return MachOUniversalBinary::create(Buffer
);
79 case file_magic::windows_resource
:
80 return WindowsResource::createWindowsResource(Buffer
);
82 // PDB does not support the Binary interface.
83 return errorCodeToError(object_error::invalid_file_type
);
84 case file_magic::unknown
:
85 case file_magic::coff_cl_gl_object
:
86 // Unrecognized object file format.
87 return errorCodeToError(object_error::invalid_file_type
);
88 case file_magic::minidump
:
89 return MinidumpFile::create(Buffer
);
90 case file_magic::tapi_file
:
91 return TapiUniversal::create(Buffer
);
93 llvm_unreachable("Unexpected Binary File Type");
96 Expected
<OwningBinary
<Binary
>> object::createBinary(StringRef Path
) {
97 ErrorOr
<std::unique_ptr
<MemoryBuffer
>> FileOrErr
=
98 MemoryBuffer::getFileOrSTDIN(Path
, /*FileSize=*/-1,
99 /*RequiresNullTerminator=*/false);
100 if (std::error_code EC
= FileOrErr
.getError())
101 return errorCodeToError(EC
);
102 std::unique_ptr
<MemoryBuffer
> &Buffer
= FileOrErr
.get();
104 Expected
<std::unique_ptr
<Binary
>> BinOrErr
=
105 createBinary(Buffer
->getMemBufferRef());
107 return BinOrErr
.takeError();
108 std::unique_ptr
<Binary
> &Bin
= BinOrErr
.get();
110 return OwningBinary
<Binary
>(std::move(Bin
), std::move(Buffer
));