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 "Disassembler.h"
16 #include "llvm/MC/MCAsmBackend.h"
17 #include "llvm/MC/MCAsmInfo.h"
18 #include "llvm/MC/MCContext.h"
19 #include "llvm/MC/MCInstPrinter.h"
20 #include "llvm/MC/MCInstrInfo.h"
21 #include "llvm/MC/MCObjectFileInfo.h"
22 #include "llvm/MC/MCParser/AsmLexer.h"
23 #include "llvm/MC/MCRegisterInfo.h"
24 #include "llvm/MC/MCSectionMachO.h"
25 #include "llvm/MC/MCStreamer.h"
26 #include "llvm/MC/MCSubtargetInfo.h"
27 #include "llvm/MC/MCTargetAsmParser.h"
28 #include "llvm/MC/MCTargetOptionsCommandFlags.h"
29 #include "llvm/Support/CommandLine.h"
30 #include "llvm/Support/Compression.h"
31 #include "llvm/Support/FileUtilities.h"
32 #include "llvm/Support/FormattedStream.h"
33 #include "llvm/Support/Host.h"
34 #include "llvm/Support/ManagedStatic.h"
35 #include "llvm/Support/MemoryBuffer.h"
36 #include "llvm/Support/PrettyStackTrace.h"
37 #include "llvm/Support/Signals.h"
38 #include "llvm/Support/SourceMgr.h"
39 #include "llvm/Support/TargetRegistry.h"
40 #include "llvm/Support/TargetSelect.h"
41 #include "llvm/Support/ToolOutputFile.h"
44 static cl::opt<std::string>
45 InputFilename(cl::Positional, cl::desc("<input file>"), cl::init("-"));
47 static cl::opt<std::string>
48 OutputFilename("o", cl::desc("Output filename"),
49 cl::value_desc("filename"));
52 ShowEncoding("show-encoding", cl::desc("Show instruction encodings"));
55 CompressDebugSections("compress-debug-sections",
56 cl::desc("Compress DWARF debug sections"));
59 ShowInst("show-inst", cl::desc("Show internal instruction representation"));
62 ShowInstOperands("show-inst-operands",
63 cl::desc("Show instructions operands as parsed"));
65 static cl::opt<unsigned>
66 OutputAsmVariant("output-asm-variant",
67 cl::desc("Syntax variant to use for output printing"));
70 PrintImmHex("print-imm-hex", cl::init(false),
71 cl::desc("Prefer hex format for immediate values"));
78 static cl::opt<OutputFileType>
79 FileType("filetype", cl::init(OFT_AssemblyFile),
80 cl::desc("Choose an output file type:"),
82 clEnumValN(OFT_AssemblyFile, "asm",
83 "Emit an assembly ('.s') file"),
84 clEnumValN(OFT_Null, "null",
85 "Don't emit anything (for timing purposes)"),
86 clEnumValN(OFT_ObjectFile, "obj",
87 "Emit a native object ('.o') file"),
90 static cl::list<std::string>
91 IncludeDirs("I", cl::desc("Directory of include files"),
92 cl::value_desc("directory"), cl::Prefix);
94 static cl::opt<std::string>
95 ArchName("arch", cl::desc("Target arch to assemble for, "
96 "see -version for available targets"));
98 static cl::opt<std::string>
99 TripleName("triple", cl::desc("Target triple to assemble for, "
100 "see -version for available targets"));
102 static cl::opt<std::string>
104 cl::desc("Target a specific cpu type (-mcpu=help for details)"),
105 cl::value_desc("cpu-name"),
108 static cl::list<std::string>
111 cl::desc("Target specific attributes (-mattr=help for details)"),
112 cl::value_desc("a1,+a2,-a3,..."));
114 static cl::opt<Reloc::Model>
115 RelocModel("relocation-model",
116 cl::desc("Choose relocation model"),
117 cl::init(Reloc::Default),
119 clEnumValN(Reloc::Default, "default",
120 "Target default relocation model"),
121 clEnumValN(Reloc::Static, "static",
122 "Non-relocatable code"),
123 clEnumValN(Reloc::PIC_, "pic",
124 "Fully relocatable, position independent code"),
125 clEnumValN(Reloc::DynamicNoPIC, "dynamic-no-pic",
126 "Relocatable external references, non-relocatable code"),
129 static cl::opt<llvm::CodeModel::Model>
130 CMModel("code-model",
131 cl::desc("Choose code model"),
132 cl::init(CodeModel::Default),
133 cl::values(clEnumValN(CodeModel::Default, "default",
134 "Target default code model"),
135 clEnumValN(CodeModel::Small, "small",
137 clEnumValN(CodeModel::Kernel, "kernel",
138 "Kernel code model"),
139 clEnumValN(CodeModel::Medium, "medium",
140 "Medium code model"),
141 clEnumValN(CodeModel::Large, "large",
146 NoInitialTextSection("n", cl::desc("Don't assume assembly file starts "
147 "in the text section"));
150 GenDwarfForAssembly("g", cl::desc("Generate dwarf debugging info for assembly "
153 static cl::opt<std::string>
154 DebugCompilationDir("fdebug-compilation-dir",
155 cl::desc("Specifies the debug info's compilation dir"));
157 static cl::opt<std::string>
158 MainFileName("main-file-name",
159 cl::desc("Specifies the name we should consider the input file"));
161 static cl::opt<bool> SaveTempLabels("save-temp-labels",
162 cl::desc("Don't discard temporary labels"));
164 static cl::opt<bool> NoExecStack("no-exec-stack",
165 cl::desc("File doesn't need an exec stack"));
174 static cl::opt<ActionType>
175 Action(cl::desc("Action to perform:"),
176 cl::init(AC_Assemble),
177 cl::values(clEnumValN(AC_AsLex, "as-lex",
178 "Lex tokens from a .s file"),
179 clEnumValN(AC_Assemble, "assemble",
180 "Assemble a .s file (default)"),
181 clEnumValN(AC_Disassemble, "disassemble",
182 "Disassemble strings of hex bytes"),
183 clEnumValN(AC_MDisassemble, "mdis",
184 "Marked up disassembly of strings of hex bytes"),
187 static const Target *GetTarget(const char *ProgName) {
188 // Figure out the target triple.
189 if (TripleName.empty())
190 TripleName = sys::getDefaultTargetTriple();
191 Triple TheTriple(Triple::normalize(TripleName));
193 // Get the target specific parser.
195 const Target *TheTarget = TargetRegistry::lookupTarget(ArchName, TheTriple,
198 errs() << ProgName << ": " << Error;
202 // Update the triple name and return the found target.
203 TripleName = TheTriple.getTriple();
207 static tool_output_file *GetOutputStream() {
208 if (OutputFilename == "")
209 OutputFilename = "-";
212 tool_output_file *Out =
213 new tool_output_file(OutputFilename.c_str(), Err, sys::fs::F_None);
215 errs() << Err << '\n';
223 static std::string DwarfDebugFlags;
224 static void setDwarfDebugFlags(int argc, char **argv) {
225 if (!getenv("RC_DEBUG_OPTIONS"))
227 for (int i = 0; i < argc; i++) {
228 DwarfDebugFlags += argv[i];
230 DwarfDebugFlags += " ";
234 static std::string DwarfDebugProducer;
235 static void setDwarfDebugProducer(void) {
236 if(!getenv("DEBUG_PRODUCER"))
238 DwarfDebugProducer += getenv("DEBUG_PRODUCER");
241 static int AsLexInput(SourceMgr &SrcMgr, MCAsmInfo &MAI,
242 tool_output_file *Out) {
245 Lexer.setBuffer(SrcMgr.getMemoryBuffer(SrcMgr.getMainFileID())->getBuffer());
248 while (Lexer.Lex().isNot(AsmToken::Eof)) {
249 AsmToken Tok = Lexer.getTok();
251 switch (Tok.getKind()) {
253 SrcMgr.PrintMessage(Lexer.getLoc(), SourceMgr::DK_Warning,
257 case AsmToken::Error:
258 Error = true; // error already printed.
260 case AsmToken::Identifier:
261 Out->os() << "identifier: " << Lexer.getTok().getString();
263 case AsmToken::Integer:
264 Out->os() << "int: " << Lexer.getTok().getString();
267 Out->os() << "real: " << Lexer.getTok().getString();
269 case AsmToken::String:
270 Out->os() << "string: " << Lexer.getTok().getString();
273 case AsmToken::Amp: Out->os() << "Amp"; break;
274 case AsmToken::AmpAmp: Out->os() << "AmpAmp"; break;
275 case AsmToken::At: Out->os() << "At"; break;
276 case AsmToken::Caret: Out->os() << "Caret"; break;
277 case AsmToken::Colon: Out->os() << "Colon"; break;
278 case AsmToken::Comma: Out->os() << "Comma"; break;
279 case AsmToken::Dollar: Out->os() << "Dollar"; break;
280 case AsmToken::Dot: Out->os() << "Dot"; break;
281 case AsmToken::EndOfStatement: Out->os() << "EndOfStatement"; break;
282 case AsmToken::Eof: Out->os() << "Eof"; break;
283 case AsmToken::Equal: Out->os() << "Equal"; break;
284 case AsmToken::EqualEqual: Out->os() << "EqualEqual"; break;
285 case AsmToken::Exclaim: Out->os() << "Exclaim"; break;
286 case AsmToken::ExclaimEqual: Out->os() << "ExclaimEqual"; break;
287 case AsmToken::Greater: Out->os() << "Greater"; break;
288 case AsmToken::GreaterEqual: Out->os() << "GreaterEqual"; break;
289 case AsmToken::GreaterGreater: Out->os() << "GreaterGreater"; break;
290 case AsmToken::Hash: Out->os() << "Hash"; break;
291 case AsmToken::LBrac: Out->os() << "LBrac"; break;
292 case AsmToken::LCurly: Out->os() << "LCurly"; break;
293 case AsmToken::LParen: Out->os() << "LParen"; break;
294 case AsmToken::Less: Out->os() << "Less"; break;
295 case AsmToken::LessEqual: Out->os() << "LessEqual"; break;
296 case AsmToken::LessGreater: Out->os() << "LessGreater"; break;
297 case AsmToken::LessLess: Out->os() << "LessLess"; break;
298 case AsmToken::Minus: Out->os() << "Minus"; break;
299 case AsmToken::Percent: Out->os() << "Percent"; break;
300 case AsmToken::Pipe: Out->os() << "Pipe"; break;
301 case AsmToken::PipePipe: Out->os() << "PipePipe"; break;
302 case AsmToken::Plus: Out->os() << "Plus"; break;
303 case AsmToken::RBrac: Out->os() << "RBrac"; break;
304 case AsmToken::RCurly: Out->os() << "RCurly"; break;
305 case AsmToken::RParen: Out->os() << "RParen"; break;
306 case AsmToken::Slash: Out->os() << "Slash"; break;
307 case AsmToken::Star: Out->os() << "Star"; break;
308 case AsmToken::Tilde: Out->os() << "Tilde"; break;
311 // Print the token string.
313 Out->os().write_escaped(Tok.getString());
314 Out->os() << "\")\n";
320 static int AssembleInput(const char *ProgName, const Target *TheTarget,
321 SourceMgr &SrcMgr, MCContext &Ctx, MCStreamer &Str,
322 MCAsmInfo &MAI, MCSubtargetInfo &STI,
323 MCInstrInfo &MCII, MCTargetOptions &MCOptions) {
324 std::unique_ptr<MCAsmParser> Parser(
325 createMCAsmParser(SrcMgr, Ctx, Str, MAI));
326 std::unique_ptr<MCTargetAsmParser> TAP(
327 TheTarget->createMCAsmParser(STI, *Parser, MCII, MCOptions));
331 << ": error: this target does not support assembly parsing.\n";
335 Parser->setShowParsedOperands(ShowInstOperands);
336 Parser->setTargetParser(*TAP.get());
338 int Res = Parser->Run(NoInitialTextSection);
343 int main(int argc, char **argv) {
344 // Print a stack trace if we signal out.
345 sys::PrintStackTraceOnErrorSignal();
346 PrettyStackTraceProgram X(argc, argv);
347 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
349 // Initialize targets and assembly printers/parsers.
350 llvm::InitializeAllTargetInfos();
351 llvm::InitializeAllTargetMCs();
352 llvm::InitializeAllAsmParsers();
353 llvm::InitializeAllDisassemblers();
355 // Register the target printer for --version.
356 cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
358 cl::ParseCommandLineOptions(argc, argv, "llvm machine code playground\n");
359 MCTargetOptions MCOptions = InitMCTargetOptionsFromFlags();
360 TripleName = Triple::normalize(TripleName);
361 setDwarfDebugFlags(argc, argv);
363 setDwarfDebugProducer();
365 const char *ProgName = argv[0];
366 const Target *TheTarget = GetTarget(ProgName);
370 std::unique_ptr<MemoryBuffer> BufferPtr;
371 if (std::error_code ec =
372 MemoryBuffer::getFileOrSTDIN(InputFilename, BufferPtr)) {
373 errs() << ProgName << ": " << ec.message() << '\n';
376 MemoryBuffer *Buffer = BufferPtr.release();
380 // Tell SrcMgr about this buffer, which is what the parser will pick up.
381 SrcMgr.AddNewSourceBuffer(Buffer, SMLoc());
383 // Record the location of the include directories so that the lexer can find
385 SrcMgr.setIncludeDirs(IncludeDirs);
387 std::unique_ptr<MCRegisterInfo> MRI(TheTarget->createMCRegInfo(TripleName));
388 assert(MRI && "Unable to create target register info!");
390 std::unique_ptr<MCAsmInfo> MAI(TheTarget->createMCAsmInfo(*MRI, TripleName));
391 assert(MAI && "Unable to create target asm info!");
393 if (CompressDebugSections) {
394 if (!zlib::isAvailable()) {
396 << ": build tools with zlib to enable -compress-debug-sections";
399 MAI->setCompressDebugSections(true);
402 // FIXME: This is not pretty. MCContext has a ptr to MCObjectFileInfo and
403 // MCObjectFileInfo needs a MCContext reference in order to initialize itself.
404 MCObjectFileInfo MOFI;
405 MCContext Ctx(MAI.get(), MRI.get(), &MOFI, &SrcMgr);
406 MOFI.InitMCObjectFileInfo(TripleName, RelocModel, CMModel, Ctx);
409 Ctx.setAllowTemporaryLabels(false);
411 Ctx.setGenDwarfForAssembly(GenDwarfForAssembly);
412 // Default to 4 for dwarf version.
413 unsigned DwarfVersion = MCOptions.DwarfVersion ? MCOptions.DwarfVersion : 4;
414 if (DwarfVersion < 2 || DwarfVersion > 4) {
415 errs() << ProgName << ": Dwarf version " << DwarfVersion
416 << " is not supported." << '\n';
419 Ctx.setDwarfVersion(DwarfVersion);
420 if (!DwarfDebugFlags.empty())
421 Ctx.setDwarfDebugFlags(StringRef(DwarfDebugFlags));
422 if (!DwarfDebugProducer.empty())
423 Ctx.setDwarfDebugProducer(StringRef(DwarfDebugProducer));
424 if (!DebugCompilationDir.empty())
425 Ctx.setCompilationDir(DebugCompilationDir);
426 if (!MainFileName.empty())
427 Ctx.setMainFileName(MainFileName);
429 // Package up features to be passed to target/subtarget
430 std::string FeaturesStr;
432 SubtargetFeatures Features;
433 for (unsigned i = 0; i != MAttrs.size(); ++i)
434 Features.AddFeature(MAttrs[i]);
435 FeaturesStr = Features.getString();
438 std::unique_ptr<tool_output_file> Out(GetOutputStream());
442 formatted_raw_ostream FOS(Out->os());
443 std::unique_ptr<MCStreamer> Str;
445 std::unique_ptr<MCInstrInfo> MCII(TheTarget->createMCInstrInfo());
446 std::unique_ptr<MCSubtargetInfo> STI(
447 TheTarget->createMCSubtargetInfo(TripleName, MCPU, FeaturesStr));
449 MCInstPrinter *IP = nullptr;
450 if (FileType == OFT_AssemblyFile) {
452 TheTarget->createMCInstPrinter(OutputAsmVariant, *MAI, *MCII, *MRI, *STI);
454 // Set the display preference for hex vs. decimal immediates.
455 IP->setPrintImmHex(PrintImmHex);
457 // Set up the AsmStreamer.
458 MCCodeEmitter *CE = nullptr;
459 MCAsmBackend *MAB = nullptr;
461 CE = TheTarget->createMCCodeEmitter(*MCII, *MRI, *STI, Ctx);
462 MAB = TheTarget->createMCAsmBackend(*MRI, TripleName, MCPU);
464 Str.reset(TheTarget->createAsmStreamer(Ctx, FOS, /*asmverbose*/ true,
465 /*useDwarfDirectory*/ true, IP, CE,
468 } else if (FileType == OFT_Null) {
469 Str.reset(createNullStreamer(Ctx));
471 assert(FileType == OFT_ObjectFile && "Invalid file type!");
472 MCCodeEmitter *CE = TheTarget->createMCCodeEmitter(*MCII, *MRI, *STI, Ctx);
473 MCAsmBackend *MAB = TheTarget->createMCAsmBackend(*MRI, TripleName, MCPU);
474 Str.reset(TheTarget->createMCObjectStreamer(TripleName, Ctx, *MAB,
475 FOS, CE, *STI, RelaxAll,
480 bool disassemble = false;
483 Res = AsLexInput(SrcMgr, *MAI, Out.get());
486 Res = AssembleInput(ProgName, TheTarget, SrcMgr, Ctx, *Str, *MAI, *STI,
489 case AC_MDisassemble:
490 assert(IP && "Expected assembly output");
499 Res = Disassembler::disassemble(*TheTarget, TripleName, *STI, *Str,
500 *Buffer, SrcMgr, Out->os());
502 // Keep output if no errors.
503 if (Res == 0) Out->keep();