xref: /freebsd-src/contrib/llvm-project/llvm/include/llvm/BinaryFormat/Magic.h (revision 7a6dacaca14b62ca4b74406814becb87a3fefac0)
10b57cec5SDimitry Andric //===- llvm/BinaryFormat/Magic.h - File magic identification ----*- C++ -*-===//
20b57cec5SDimitry Andric //
30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
60b57cec5SDimitry Andric //
70b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
80b57cec5SDimitry Andric 
90b57cec5SDimitry Andric #ifndef LLVM_BINARYFORMAT_MAGIC_H
100b57cec5SDimitry Andric #define LLVM_BINARYFORMAT_MAGIC_H
110b57cec5SDimitry Andric 
120b57cec5SDimitry Andric #include <system_error>
130b57cec5SDimitry Andric 
140b57cec5SDimitry Andric namespace llvm {
155ffd83dbSDimitry Andric class StringRef;
165ffd83dbSDimitry Andric class Twine;
175ffd83dbSDimitry Andric 
180b57cec5SDimitry Andric /// file_magic - An "enum class" enumeration of file types based on magic (the
190b57cec5SDimitry Andric /// first N bytes of the file).
200b57cec5SDimitry Andric struct file_magic {
210b57cec5SDimitry Andric   enum Impl {
220b57cec5SDimitry Andric     unknown = 0,       ///< Unrecognized file
230b57cec5SDimitry Andric     bitcode,           ///< Bitcode file
24*7a6dacacSDimitry Andric     clang_ast,         ///< Clang PCH or PCM
250b57cec5SDimitry Andric     archive,           ///< ar style archive file
260b57cec5SDimitry Andric     elf,               ///< ELF Unknown type
270b57cec5SDimitry Andric     elf_relocatable,   ///< ELF Relocatable object file
280b57cec5SDimitry Andric     elf_executable,    ///< ELF Executable image
290b57cec5SDimitry Andric     elf_shared_object, ///< ELF dynamically linked shared lib
300b57cec5SDimitry Andric     elf_core,          ///< ELF core image
31fe6060f1SDimitry Andric     goff_object,       ///< GOFF object file
320b57cec5SDimitry Andric     macho_object,      ///< Mach-O Object file
330b57cec5SDimitry Andric     macho_executable,  ///< Mach-O Executable
340b57cec5SDimitry Andric     macho_fixed_virtual_memory_shared_lib,    ///< Mach-O Shared Lib, FVM
350b57cec5SDimitry Andric     macho_core,                               ///< Mach-O Core File
360b57cec5SDimitry Andric     macho_preload_executable,                 ///< Mach-O Preloaded Executable
370b57cec5SDimitry Andric     macho_dynamically_linked_shared_lib,      ///< Mach-O dynlinked shared lib
380b57cec5SDimitry Andric     macho_dynamic_linker,                     ///< The Mach-O dynamic linker
390b57cec5SDimitry Andric     macho_bundle,                             ///< Mach-O Bundle file
400b57cec5SDimitry Andric     macho_dynamically_linked_shared_lib_stub, ///< Mach-O Shared lib stub
410b57cec5SDimitry Andric     macho_dsym_companion,                     ///< Mach-O dSYM companion file
420b57cec5SDimitry Andric     macho_kext_bundle,                        ///< Mach-O kext bundle file
430b57cec5SDimitry Andric     macho_universal_binary,                   ///< Mach-O universal binary
44bdd1243dSDimitry Andric     macho_file_set,                           ///< Mach-O file set binary
450b57cec5SDimitry Andric     minidump,                                 ///< Windows minidump file
460b57cec5SDimitry Andric     coff_cl_gl_object,         ///< Microsoft cl.exe's intermediate code file
470b57cec5SDimitry Andric     coff_object,               ///< COFF object file
480b57cec5SDimitry Andric     coff_import_library,       ///< COFF import library
490b57cec5SDimitry Andric     pecoff_executable,         ///< PECOFF executable file
500b57cec5SDimitry Andric     windows_resource,          ///< Windows compiled resource file (.res)
510b57cec5SDimitry Andric     xcoff_object_32,           ///< 32-bit XCOFF object file
520b57cec5SDimitry Andric     xcoff_object_64,           ///< 64-bit XCOFF object file
530b57cec5SDimitry Andric     wasm_object,               ///< WebAssembly Object file
540b57cec5SDimitry Andric     pdb,                       ///< Windows PDB debug info file
558bcb0991SDimitry Andric     tapi_file,                 ///< Text-based Dynamic Library Stub file
5681ad6265SDimitry Andric     cuda_fatbinary,            ///< CUDA Fatbinary object file
5781ad6265SDimitry Andric     offload_binary,            ///< LLVM offload object file
5881ad6265SDimitry Andric     dxcontainer_object,        ///< DirectX container file
595f757f3fSDimitry Andric     offload_bundle,            ///< Clang offload bundle file
605f757f3fSDimitry Andric     offload_bundle_compressed, ///< Compressed clang offload bundle file
615f757f3fSDimitry Andric     spirv_object,              ///< A binary SPIR-V file
620b57cec5SDimitry Andric   };
630b57cec5SDimitry Andric 
is_objectfile_magic640b57cec5SDimitry Andric   bool is_object() const { return V != unknown; }
650b57cec5SDimitry Andric 
660b57cec5SDimitry Andric   file_magic() = default;
file_magicfile_magic670b57cec5SDimitry Andric   file_magic(Impl V) : V(V) {}
Implfile_magic680b57cec5SDimitry Andric   operator Impl() const { return V; }
690b57cec5SDimitry Andric 
700b57cec5SDimitry Andric private:
710b57cec5SDimitry Andric   Impl V = unknown;
720b57cec5SDimitry Andric };
730b57cec5SDimitry Andric 
740b57cec5SDimitry Andric /// Identify the type of a binary file based on how magical it is.
750b57cec5SDimitry Andric file_magic identify_magic(StringRef magic);
760b57cec5SDimitry Andric 
770b57cec5SDimitry Andric /// Get and identify \a path's type based on its content.
780b57cec5SDimitry Andric ///
790b57cec5SDimitry Andric /// @param path Input path.
800b57cec5SDimitry Andric /// @param result Set to the type of file, or file_magic::unknown.
810b57cec5SDimitry Andric /// @returns errc::success if result has been successfully set, otherwise a
820b57cec5SDimitry Andric ///          platform-specific error_code.
830b57cec5SDimitry Andric std::error_code identify_magic(const Twine &path, file_magic &result);
840b57cec5SDimitry Andric } // namespace llvm
850b57cec5SDimitry Andric 
860b57cec5SDimitry Andric #endif
87