1//===- Binary.cpp - A generic binary file ---------------------------------===//
2//
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
6//
7//===----------------------------------------------------------------------===//
8//
9// This file defines the Binary class.
10//
11//===----------------------------------------------------------------------===//
12
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"
28#include <algorithm>
29#include <memory>
30#include <system_error>
31
32using namespace llvm;
33using namespace object;
34
35Binary::~Binary() = default;
36
37Binary::Binary(unsigned int Type, MemoryBufferRef Source)
38 : TypeID(Type), Data(Source) {}
39
40StringRef Binary::getData() const { return Data.getBuffer(); }
41
42StringRef Binary::getFileName() const { return Data.getBufferIdentifier(); }
43
44MemoryBufferRef Binary::getMemoryBufferRef() const { return Data; }
45
46Expected<std::unique_ptr<Binary>> object::createBinary(MemoryBufferRef Buffer,
47 LLVMContext *Context,
48 bool InitContent) {
49 file_magic Type = identify_magic(Buffer.getBuffer());
50
51 switch (Type) {
52 case file_magic::archive:
53 return Archive::create(Buffer);
54 case file_magic::elf:
55 case file_magic::elf_relocatable:
56 case file_magic::elf_executable:
57 case file_magic::elf_shared_object:
58 case file_magic::elf_core:
59 case file_magic::macho_object:
60 case file_magic::macho_executable:
61 case file_magic::macho_fixed_virtual_memory_shared_lib:
62 case file_magic::macho_core:
63 case file_magic::macho_preload_executable:
64 case file_magic::macho_dynamically_linked_shared_lib:
65 case file_magic::macho_dynamic_linker:
66 case file_magic::macho_bundle:
67 case file_magic::macho_dynamically_linked_shared_lib_stub:
68 case file_magic::macho_dsym_companion:
69 case file_magic::macho_kext_bundle:
70 case file_magic::coff_object:
71 case file_magic::coff_import_library:
72 case file_magic::pecoff_executable:
73 case file_magic::bitcode:
74 case file_magic::xcoff_object_32:
75 case file_magic::xcoff_object_64:
76 case file_magic::wasm_object:
77 return ObjectFile::createSymbolicFile(Buffer, Type, Context, InitContent);
78 case file_magic::macho_universal_binary:
79 return MachOUniversalBinary::create(Buffer);
80 case file_magic::windows_resource:
81 return WindowsResource::createWindowsResource(Buffer);
82 case file_magic::pdb:
83 // PDB does not support the Binary interface.
84 return errorCodeToError(object_error::invalid_file_type);
85 case file_magic::unknown:
86 case file_magic::coff_cl_gl_object:
87 // Unrecognized object file format.
88 return errorCodeToError(object_error::invalid_file_type);
89 case file_magic::minidump:
90 return MinidumpFile::create(Buffer);
91 case file_magic::tapi_file:
92 return TapiUniversal::create(Buffer);
93 }
94 llvm_unreachable("Unexpected Binary File Type");
95}
96
97Expected<OwningBinary<Binary>>
98object::createBinary(StringRef Path, LLVMContext *Context, bool InitContent) {
99 ErrorOr<std::unique_ptr<MemoryBuffer>> FileOrErr =
100 MemoryBuffer::getFileOrSTDIN(Path, /*IsText=*/false,
101 /*RequiresNullTerminator=*/false);
102 if (std::error_code EC = FileOrErr.getError())
103 return errorCodeToError(EC);
104 std::unique_ptr<MemoryBuffer> &Buffer = FileOrErr.get();
105
106 Expected<std::unique_ptr<Binary>> BinOrErr =
107 createBinary(Buffer->getMemBufferRef(), Context, InitContent);
108 if (!BinOrErr)
109 return BinOrErr.takeError();
110 std::unique_ptr<Binary> &Bin = BinOrErr.get();
111
112 return OwningBinary<Binary>(std::move(Bin), std::move(Buffer));
113}
114