1 //===-- llvm-mc.cpp - Machine Code Hacking Driver -------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This utility is a simple driver that allows command line hacking on machine
13 //===----------------------------------------------------------------------===//
15 #include "llvm/MC/MCParser/AsmLexer.h"
16 #include "llvm/MC/MCParser/MCAsmLexer.h"
17 #include "llvm/MC/MCContext.h"
18 #include "llvm/MC/MCCodeEmitter.h"
19 #include "llvm/MC/MCInstPrinter.h"
20 #include "llvm/MC/MCSectionMachO.h"
21 #include "llvm/MC/MCStreamer.h"
22 #include "llvm/Target/TargetAsmBackend.h"
23 #include "llvm/Target/TargetAsmParser.h"
24 #include "llvm/Target/TargetData.h"
25 #include "llvm/Target/TargetRegistry.h"
26 #include "llvm/Target/TargetMachine.h" // FIXME.
27 #include "llvm/Target/TargetSelect.h"
28 #include "llvm/ADT/OwningPtr.h"
29 #include "llvm/Support/CommandLine.h"
30 #include "llvm/Support/FileUtilities.h"
31 #include "llvm/Support/FormattedStream.h"
32 #include "llvm/Support/ManagedStatic.h"
33 #include "llvm/Support/MemoryBuffer.h"
34 #include "llvm/Support/PrettyStackTrace.h"
35 #include "llvm/Support/SourceMgr.h"
36 #include "llvm/Support/raw_ostream.h"
37 #include "llvm/System/Host.h"
38 #include "llvm/System/Signals.h"
39 #include "Disassembler.h"
42 static cl::opt<std::string>
43 InputFilename(cl::Positional, cl::desc("<input file>"), cl::init("-"));
45 static cl::opt<std::string>
46 OutputFilename("o", cl::desc("Output filename"),
47 cl::value_desc("filename"));
50 ShowEncoding("show-encoding", cl::desc("Show instruction encodings"));
53 ShowInst("show-inst", cl::desc("Show internal instruction representation"));
56 ShowInstOperands("show-inst-operands",
57 cl::desc("Show instructions operands as parsed"));
59 static cl::opt<unsigned>
60 OutputAsmVariant("output-asm-variant",
61 cl::desc("Syntax variant to use for output printing"));
64 RelaxAll("mc-relax-all", cl::desc("Relax all fixups"));
67 EnableLogging("enable-api-logging", cl::desc("Enable MC API logging"));
74 static cl::opt<OutputFileType>
75 FileType("filetype", cl::init(OFT_AssemblyFile),
76 cl::desc("Choose an output file type:"),
78 clEnumValN(OFT_AssemblyFile, "asm",
79 "Emit an assembly ('.s') file"),
80 clEnumValN(OFT_Null, "null",
81 "Don't emit anything (for timing purposes)"),
82 clEnumValN(OFT_ObjectFile, "obj",
83 "Emit a native object ('.o') file"),
86 static cl::list<std::string>
87 IncludeDirs("I", cl::desc("Directory of include files"),
88 cl::value_desc("directory"), cl::Prefix);
90 static cl::opt<std::string>
91 ArchName("arch", cl::desc("Target arch to assemble for, "
92 "see -version for available targets"));
94 static cl::opt<std::string>
95 TripleName("triple", cl::desc("Target triple to assemble for, "
96 "see -version for available targets"));
99 NoInitialTextSection("n", cl::desc(
100 "Don't assume assembly file starts in the text section"));
109 static cl::opt<ActionType>
110 Action(cl::desc("Action to perform:"),
111 cl::init(AC_Assemble),
112 cl::values(clEnumValN(AC_AsLex, "as-lex",
113 "Lex tokens from a .s file"),
114 clEnumValN(AC_Assemble, "assemble",
115 "Assemble a .s file (default)"),
116 clEnumValN(AC_Disassemble, "disassemble",
117 "Disassemble strings of hex bytes"),
118 clEnumValN(AC_EDisassemble, "edis",
119 "Enhanced disassembly of strings of hex bytes"),
122 static const Target *GetTarget(const char *ProgName) {
123 // Figure out the target triple.
124 if (TripleName.empty())
125 TripleName = sys::getHostTriple();
126 if (!ArchName.empty()) {
127 llvm::Triple TT(TripleName);
128 TT.setArchName(ArchName);
129 TripleName = TT.str();
132 // Get the target specific parser.
134 const Target *TheTarget = TargetRegistry::lookupTarget(TripleName, Error);
138 errs() << ProgName << ": error: unable to get target for '" << TripleName
139 << "', see --version and --triple.\n";
143 static formatted_tool_output_file *GetOutputStream() {
144 if (OutputFilename == "")
145 OutputFilename = "-";
148 tool_output_file *Out = new tool_output_file(OutputFilename.c_str(), Err,
149 raw_fd_ostream::F_Binary);
151 errs() << Err << '\n';
156 return new formatted_tool_output_file(*Out,
157 formatted_raw_ostream::DELETE_STREAM);
160 static int AsLexInput(const char *ProgName) {
161 std::string ErrorMessage;
162 MemoryBuffer *Buffer = MemoryBuffer::getFileOrSTDIN(InputFilename,
165 errs() << ProgName << ": ";
166 if (ErrorMessage.size())
167 errs() << ErrorMessage << "\n";
169 errs() << "input file didn't read correctly.\n";
175 // Tell SrcMgr about this buffer, which is what TGParser will pick up.
176 SrcMgr.AddNewSourceBuffer(Buffer, SMLoc());
178 // Record the location of the include directories so that the lexer can find
180 SrcMgr.setIncludeDirs(IncludeDirs);
182 const Target *TheTarget = GetTarget(ProgName);
186 llvm::OwningPtr<MCAsmInfo> MAI(TheTarget->createAsmInfo(TripleName));
187 assert(MAI && "Unable to create target asm info!");
189 AsmLexer Lexer(*MAI);
190 Lexer.setBuffer(SrcMgr.getMemoryBuffer(0));
192 OwningPtr<formatted_tool_output_file> Out(GetOutputStream());
197 while (Lexer.Lex().isNot(AsmToken::Eof)) {
198 switch (Lexer.getKind()) {
200 SrcMgr.PrintMessage(Lexer.getLoc(), "unknown token", "warning");
203 case AsmToken::Error:
204 Error = true; // error already printed.
206 case AsmToken::Identifier:
207 *Out << "identifier: " << Lexer.getTok().getString() << '\n';
209 case AsmToken::String:
210 *Out << "string: " << Lexer.getTok().getString() << '\n';
212 case AsmToken::Integer:
213 *Out << "int: " << Lexer.getTok().getString() << '\n';
216 case AsmToken::Amp: *Out << "Amp\n"; break;
217 case AsmToken::AmpAmp: *Out << "AmpAmp\n"; break;
218 case AsmToken::Caret: *Out << "Caret\n"; break;
219 case AsmToken::Colon: *Out << "Colon\n"; break;
220 case AsmToken::Comma: *Out << "Comma\n"; break;
221 case AsmToken::Dollar: *Out << "Dollar\n"; break;
222 case AsmToken::EndOfStatement: *Out << "EndOfStatement\n"; break;
223 case AsmToken::Eof: *Out << "Eof\n"; break;
224 case AsmToken::Equal: *Out << "Equal\n"; break;
225 case AsmToken::EqualEqual: *Out << "EqualEqual\n"; break;
226 case AsmToken::Exclaim: *Out << "Exclaim\n"; break;
227 case AsmToken::ExclaimEqual: *Out << "ExclaimEqual\n"; break;
228 case AsmToken::Greater: *Out << "Greater\n"; break;
229 case AsmToken::GreaterEqual: *Out << "GreaterEqual\n"; break;
230 case AsmToken::GreaterGreater: *Out << "GreaterGreater\n"; break;
231 case AsmToken::LParen: *Out << "LParen\n"; break;
232 case AsmToken::Less: *Out << "Less\n"; break;
233 case AsmToken::LessEqual: *Out << "LessEqual\n"; break;
234 case AsmToken::LessGreater: *Out << "LessGreater\n"; break;
235 case AsmToken::LessLess: *Out << "LessLess\n"; break;
236 case AsmToken::Minus: *Out << "Minus\n"; break;
237 case AsmToken::Percent: *Out << "Percent\n"; break;
238 case AsmToken::Pipe: *Out << "Pipe\n"; break;
239 case AsmToken::PipePipe: *Out << "PipePipe\n"; break;
240 case AsmToken::Plus: *Out << "Plus\n"; break;
241 case AsmToken::RParen: *Out << "RParen\n"; break;
242 case AsmToken::Slash: *Out << "Slash\n"; break;
243 case AsmToken::Star: *Out << "Star\n"; break;
244 case AsmToken::Tilde: *Out << "Tilde\n"; break;
248 // Keep output if no errors.
249 if (Error == 0) Out->keep();
254 static int AssembleInput(const char *ProgName) {
255 const Target *TheTarget = GetTarget(ProgName);
260 MemoryBuffer *Buffer = MemoryBuffer::getFileOrSTDIN(InputFilename, &Error);
262 errs() << ProgName << ": ";
264 errs() << Error << "\n";
266 errs() << "input file didn't read correctly.\n";
272 // Tell SrcMgr about this buffer, which is what the parser will pick up.
273 SrcMgr.AddNewSourceBuffer(Buffer, SMLoc());
275 // Record the location of the include directories so that the lexer can find
277 SrcMgr.setIncludeDirs(IncludeDirs);
280 llvm::OwningPtr<MCAsmInfo> MAI(TheTarget->createAsmInfo(TripleName));
281 assert(MAI && "Unable to create target asm info!");
285 // FIXME: We shouldn't need to do this (and link in codegen).
286 OwningPtr<TargetMachine> TM(TheTarget->createTargetMachine(TripleName, ""));
289 errs() << ProgName << ": error: could not create target for triple '"
290 << TripleName << "'.\n";
294 OwningPtr<formatted_tool_output_file> Out(GetOutputStream());
298 OwningPtr<MCStreamer> Str;
300 if (FileType == OFT_AssemblyFile) {
302 TheTarget->createMCInstPrinter(OutputAsmVariant, *MAI);
303 MCCodeEmitter *CE = 0;
305 CE = TheTarget->createCodeEmitter(*TM, Ctx);
306 Str.reset(createAsmStreamer(Ctx, *Out,TM->getTargetData()->isLittleEndian(),
307 /*asmverbose*/true, IP, CE, ShowInst));
308 } else if (FileType == OFT_Null) {
309 Str.reset(createNullStreamer(Ctx));
311 assert(FileType == OFT_ObjectFile && "Invalid file type!");
312 MCCodeEmitter *CE = TheTarget->createCodeEmitter(*TM, Ctx);
313 TargetAsmBackend *TAB = TheTarget->createAsmBackend(TripleName);
314 Str.reset(TheTarget->createObjectStreamer(TripleName, Ctx, *TAB,
315 *Out, CE, RelaxAll));
319 Str.reset(createLoggingStreamer(Str.take(), errs()));
322 OwningPtr<MCAsmParser> Parser(createMCAsmParser(*TheTarget, SrcMgr, Ctx,
324 OwningPtr<TargetAsmParser> TAP(TheTarget->createAsmParser(*Parser, *TM));
327 << ": error: this target does not support assembly parsing.\n";
331 Parser->setShowParsedOperands(ShowInstOperands);
332 Parser->setTargetParser(*TAP.get());
334 int Res = Parser->Run(NoInitialTextSection);
336 // Keep output if no errors.
337 if (Res == 0) Out->keep();
342 static int DisassembleInput(const char *ProgName, bool Enhanced) {
343 const Target *TheTarget = GetTarget(ProgName);
347 std::string ErrorMessage;
349 MemoryBuffer *Buffer = MemoryBuffer::getFileOrSTDIN(InputFilename,
353 errs() << ProgName << ": ";
354 if (ErrorMessage.size())
355 errs() << ErrorMessage << "\n";
357 errs() << "input file didn't read correctly.\n";
361 OwningPtr<formatted_tool_output_file> Out(GetOutputStream());
367 Res = Disassembler::disassembleEnhanced(TripleName, *Buffer, *Out);
369 Res = Disassembler::disassemble(*TheTarget, TripleName, *Buffer, *Out);
371 // Keep output if no errors.
372 if (Res == 0) Out->keep();
378 int main(int argc, char **argv) {
379 // Print a stack trace if we signal out.
380 sys::PrintStackTraceOnErrorSignal();
381 PrettyStackTraceProgram X(argc, argv);
382 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
384 // Initialize targets and assembly printers/parsers.
385 llvm::InitializeAllTargetInfos();
386 // FIXME: We shouldn't need to initialize the Target(Machine)s.
387 llvm::InitializeAllTargets();
388 llvm::InitializeAllAsmPrinters();
389 llvm::InitializeAllAsmParsers();
390 llvm::InitializeAllDisassemblers();
392 cl::ParseCommandLineOptions(argc, argv, "llvm machine code playground\n");
393 TripleName = Triple::normalize(TripleName);
398 return AsLexInput(argv[0]);
400 return AssembleInput(argv[0]);
402 return DisassembleInput(argv[0], false);
403 case AC_EDisassemble:
404 return DisassembleInput(argv[0], true);