1a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer//===- yaml2obj - Convert YAML to a binary object file --------------------===// 2a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer// 3a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer// The LLVM Compiler Infrastructure 4a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer// 5a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer// This file is distributed under the University of Illinois Open Source 6a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer// License. See LICENSE.TXT for details. 7a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer// 8a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer//===----------------------------------------------------------------------===// 9a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer// 10a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer// This program takes a YAML description of an object file and outputs the 11a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer// binary equivalent. 12a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer// 13a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer// This is used for writing tests that require binary files. 14a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer// 15a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer//===----------------------------------------------------------------------===// 16a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer 176ed30e0f0c3876df8b77c44fd3196b40903fb47dSean Silva#include "yaml2obj.h" 18cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines#include "llvm/ADT/StringExtras.h" 19a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer#include "llvm/Support/CommandLine.h" 20dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines#include "llvm/Support/FileSystem.h" 21a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer#include "llvm/Support/ManagedStatic.h" 22a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer#include "llvm/Support/MemoryBuffer.h" 23a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer#include "llvm/Support/PrettyStackTrace.h" 24a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer#include "llvm/Support/Signals.h" 25dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines#include "llvm/Support/ToolOutputFile.h" 26cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines#include "llvm/Support/YAMLTraits.h" 27cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines#include "llvm/Support/raw_ostream.h" 28cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines#include <system_error> 29a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer 30a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencerusing namespace llvm; 31a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer 32a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencerstatic cl::opt<std::string> 33a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer Input(cl::Positional, cl::desc("<input>"), cl::init("-")); 34a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer 35db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva// TODO: The "right" way to tell what kind of object file a given YAML file 36db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva// corresponds to is to look at YAML "tags" (e.g. `!Foo`). Then, different 37db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva// tags (`!ELF`, `!COFF`, etc.) would be used to discriminate between them. 38db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva// Interpreting the tags is needed eventually for when writing test cases, 39db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva// so that we can e.g. have `!Archive` contain a sequence of `!ELF`, and 40db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva// just Do The Right Thing. However, interpreting these tags and acting on 41db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva// them appropriately requires some work in the YAML parser and the YAMLIO 42db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva// library. 43db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silvaenum YAMLObjectFormat { 445918b7a03d4d6a52e18f7c102250c9cfd6ae52ddSean Silva YOF_COFF, 455918b7a03d4d6a52e18f7c102250c9cfd6ae52ddSean Silva YOF_ELF 46db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva}; 47db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva 48db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silvacl::opt<YAMLObjectFormat> Format( 49db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva "format", 50db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva cl::desc("Interpret input as this type of object file"), 51db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva cl::values( 52db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva clEnumValN(YOF_COFF, "coff", "COFF object file format"), 535918b7a03d4d6a52e18f7c102250c9cfd6ae52ddSean Silva clEnumValN(YOF_ELF, "elf", "ELF object file format"), 54db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva clEnumValEnd)); 55db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva 56cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hinescl::opt<unsigned> 57cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen HinesDocNum("docnum", cl::init(1), 58cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines cl::desc("Read specified document from input (default = 1)")); 59cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines 60dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hinesstatic cl::opt<std::string> OutputFilename("o", cl::desc("Output filename"), 61dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines cl::value_desc("filename")); 62db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva 63cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hinestypedef int (*ConvertFuncPtr)(yaml::Input & YIn, raw_ostream &Out); 64cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines 65cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hinesint convertYAML(yaml::Input & YIn, raw_ostream &Out, ConvertFuncPtr Convert) { 66cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines unsigned CurDocNum = 0; 67cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines do { 68cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines if (++CurDocNum == DocNum) 69cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines return Convert(YIn, Out); 70cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines } while (YIn.nextDocument()); 71cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines 72cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines errs() << "yaml2obj: Cannot find the " << DocNum 73cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines << llvm::getOrdinalSuffix(DocNum) << " document\n"; 74cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines return 1; 75cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines} 76cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines 77db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silvaint main(int argc, char **argv) { 78db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva cl::ParseCommandLineOptions(argc, argv); 79db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva sys::PrintStackTraceOnErrorSignal(); 80db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva PrettyStackTraceProgram X(argc, argv); 81db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva llvm_shutdown_obj Y; // Call llvm_shutdown() on exit. 82db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva 83dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines if (OutputFilename.empty()) 84dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines OutputFilename = "-"; 85dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 86dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines std::string ErrorInfo; 87dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines std::unique_ptr<tool_output_file> Out( 88dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines new tool_output_file(OutputFilename.c_str(), ErrorInfo, sys::fs::F_None)); 89dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines if (!ErrorInfo.empty()) { 90dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines errs() << ErrorInfo << '\n'; 91dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines return 1; 92dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines } 93dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 94cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines ErrorOr<std::unique_ptr<MemoryBuffer>> Buf = 95cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines MemoryBuffer::getFileOrSTDIN(Input); 96cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines if (!Buf) 97db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva return 1; 98dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 99cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines ConvertFuncPtr Convert = nullptr; 100dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines if (Format == YOF_COFF) 101cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines Convert = yaml2coff; 102dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines else if (Format == YOF_ELF) 103cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines Convert = yaml2elf; 104cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines else { 105db9dc53871af4e501bdb5dfcb604c90425cd3859Sean Silva errs() << "Not yet implemented\n"; 106cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines return 1; 107cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines } 108cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines 109cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines yaml::Input YIn(Buf.get()->getBuffer()); 110dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 111cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines int Res = convertYAML(YIn, Out->os(), Convert); 112dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines if (Res == 0) 113dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines Out->keep(); 114dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines 115dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines return Res; 116a915f247f72570a994d55cd0d2961cd2d7bbd0e1Michael J. Spencer} 117