1//===- llvm/BinaryFormat/Magic.h - File magic identification ----*- C++ -*-===//
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#ifndef LLVM_BINARYFORMAT_MAGIC_H
10#define LLVM_BINARYFORMAT_MAGIC_H
11
12#include <system_error>
13
14namespace llvm {
15class StringRef;
16class Twine;
17
18/// file_magic - An "enum class" enumeration of file types based on magic (the
19/// first N bytes of the file).
20struct file_magic {
21 enum Impl {
22 unknown = 0, ///< Unrecognized file
23 bitcode, ///< Bitcode file
24 clang_ast, ///< Clang PCH or PCM
25 archive, ///< ar style archive file
26 elf, ///< ELF Unknown type
27 elf_relocatable, ///< ELF Relocatable object file
28 elf_executable, ///< ELF Executable image
29 elf_shared_object, ///< ELF dynamically linked shared lib
30 elf_core, ///< ELF core image
31 goff_object, ///< GOFF object file
32 macho_object, ///< Mach-O Object file
33 macho_executable, ///< Mach-O Executable
34 macho_fixed_virtual_memory_shared_lib, ///< Mach-O Shared Lib, FVM
35 macho_core, ///< Mach-O Core File
36 macho_preload_executable, ///< Mach-O Preloaded Executable
37 macho_dynamically_linked_shared_lib, ///< Mach-O dynlinked shared lib
38 macho_dynamic_linker, ///< The Mach-O dynamic linker
39 macho_bundle, ///< Mach-O Bundle file
40 macho_dynamically_linked_shared_lib_stub, ///< Mach-O Shared lib stub
41 macho_dsym_companion, ///< Mach-O dSYM companion file
42 macho_kext_bundle, ///< Mach-O kext bundle file
43 macho_universal_binary, ///< Mach-O universal binary
44 macho_file_set, ///< Mach-O file set binary
45 minidump, ///< Windows minidump file
46 coff_cl_gl_object, ///< Microsoft cl.exe's intermediate code file
47 coff_object, ///< COFF object file
48 coff_import_library, ///< COFF import library
49 pecoff_executable, ///< PECOFF executable file
50 windows_resource, ///< Windows compiled resource file (.res)
51 xcoff_object_32, ///< 32-bit XCOFF object file
52 xcoff_object_64, ///< 64-bit XCOFF object file
53 wasm_object, ///< WebAssembly Object file
54 pdb, ///< Windows PDB debug info file
55 tapi_file, ///< Text-based Dynamic Library Stub file
56 cuda_fatbinary, ///< CUDA Fatbinary object file
57 offload_binary, ///< LLVM offload object file
58 dxcontainer_object, ///< DirectX container file
59 offload_bundle, ///< Clang offload bundle file
60 offload_bundle_compressed, ///< Compressed clang offload bundle file
61 spirv_object, ///< A binary SPIR-V file
62 };
63
64 bool is_object() const { return V != unknown; }
65
66 file_magic() = default;
67 file_magic(Impl V) : V(V) {}
68 operator Impl() const { return V; }
69
70private:
71 Impl V = unknown;
72};
73
74/// Identify the type of a binary file based on how magical it is.
75file_magic identify_magic(StringRef magic);
76
77/// Get and identify \a path's type based on its content.
78///
79/// @param path Input path.
80/// @param result Set to the type of file, or file_magic::unknown.
81/// @returns errc::success if result has been successfully set, otherwise a
82/// platform-specific error_code.
83std::error_code identify_magic(const Twine &path, file_magic &result);
84} // namespace llvm
85
86#endif
87

source code of llvm/include/llvm/BinaryFormat/Magic.h