llvm-mc.cpp revision 6af228a92a7b8414fa3c1b3c37ee659d32e66e1b
1//===-- llvm-mc.cpp - Machine Code Hacking Driver -------------------------===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9// 10// This utility is a simple driver that allows command line hacking on machine 11// code. 12// 13//===----------------------------------------------------------------------===// 14 15#include "Disassembler.h" 16#include "llvm/ADT/OwningPtr.h" 17#include "llvm/MC/MCAsmBackend.h" 18#include "llvm/MC/MCAsmInfo.h" 19#include "llvm/MC/MCCodeEmitter.h" 20#include "llvm/MC/MCContext.h" 21#include "llvm/MC/MCInstPrinter.h" 22#include "llvm/MC/MCInstrInfo.h" 23#include "llvm/MC/MCObjectFileInfo.h" 24#include "llvm/MC/MCParser/AsmLexer.h" 25#include "llvm/MC/MCParser/MCAsmLexer.h" 26#include "llvm/MC/MCRegisterInfo.h" 27#include "llvm/MC/MCSectionMachO.h" 28#include "llvm/MC/MCStreamer.h" 29#include "llvm/MC/MCSubtargetInfo.h" 30#include "llvm/MC/MCTargetAsmParser.h" 31#include "llvm/MC/SubtargetFeature.h" 32#include "llvm/Support/CommandLine.h" 33#include "llvm/Support/FileUtilities.h" 34#include "llvm/Support/FormattedStream.h" 35#include "llvm/Support/Host.h" 36#include "llvm/Support/ManagedStatic.h" 37#include "llvm/Support/MemoryBuffer.h" 38#include "llvm/Support/PrettyStackTrace.h" 39#include "llvm/Support/Signals.h" 40#include "llvm/Support/SourceMgr.h" 41#include "llvm/Support/TargetRegistry.h" 42#include "llvm/Support/TargetSelect.h" 43#include "llvm/Support/ToolOutputFile.h" 44#include "llvm/Support/system_error.h" 45using namespace llvm; 46 47static cl::opt<std::string> 48InputFilename(cl::Positional, cl::desc("<input file>"), cl::init("-")); 49 50static cl::opt<std::string> 51OutputFilename("o", cl::desc("Output filename"), 52 cl::value_desc("filename")); 53 54static cl::opt<bool> 55ShowEncoding("show-encoding", cl::desc("Show instruction encodings")); 56 57static cl::opt<bool> 58ShowInst("show-inst", cl::desc("Show internal instruction representation")); 59 60static cl::opt<bool> 61ShowInstOperands("show-inst-operands", 62 cl::desc("Show instructions operands as parsed")); 63 64static cl::opt<unsigned> 65OutputAsmVariant("output-asm-variant", 66 cl::desc("Syntax variant to use for output printing")); 67 68static cl::opt<bool> 69RelaxAll("mc-relax-all", cl::desc("Relax all fixups")); 70 71static cl::opt<bool> 72DisableCFI("disable-cfi", cl::desc("Do not use .cfi_* directives")); 73 74static cl::opt<bool> 75NoExecStack("mc-no-exec-stack", cl::desc("File doesn't need an exec stack")); 76 77enum OutputFileType { 78 OFT_Null, 79 OFT_AssemblyFile, 80 OFT_ObjectFile 81}; 82static cl::opt<OutputFileType> 83FileType("filetype", cl::init(OFT_AssemblyFile), 84 cl::desc("Choose an output file type:"), 85 cl::values( 86 clEnumValN(OFT_AssemblyFile, "asm", 87 "Emit an assembly ('.s') file"), 88 clEnumValN(OFT_Null, "null", 89 "Don't emit anything (for timing purposes)"), 90 clEnumValN(OFT_ObjectFile, "obj", 91 "Emit a native object ('.o') file"), 92 clEnumValEnd)); 93 94static cl::list<std::string> 95IncludeDirs("I", cl::desc("Directory of include files"), 96 cl::value_desc("directory"), cl::Prefix); 97 98static cl::opt<std::string> 99ArchName("arch", cl::desc("Target arch to assemble for, " 100 "see -version for available targets")); 101 102static cl::opt<std::string> 103TripleName("triple", cl::desc("Target triple to assemble for, " 104 "see -version for available targets")); 105 106static cl::opt<std::string> 107MCPU("mcpu", 108 cl::desc("Target a specific cpu type (-mcpu=help for details)"), 109 cl::value_desc("cpu-name"), 110 cl::init("")); 111 112static cl::list<std::string> 113MAttrs("mattr", 114 cl::CommaSeparated, 115 cl::desc("Target specific attributes (-mattr=help for details)"), 116 cl::value_desc("a1,+a2,-a3,...")); 117 118static cl::opt<Reloc::Model> 119RelocModel("relocation-model", 120 cl::desc("Choose relocation model"), 121 cl::init(Reloc::Default), 122 cl::values( 123 clEnumValN(Reloc::Default, "default", 124 "Target default relocation model"), 125 clEnumValN(Reloc::Static, "static", 126 "Non-relocatable code"), 127 clEnumValN(Reloc::PIC_, "pic", 128 "Fully relocatable, position independent code"), 129 clEnumValN(Reloc::DynamicNoPIC, "dynamic-no-pic", 130 "Relocatable external references, non-relocatable code"), 131 clEnumValEnd)); 132 133static cl::opt<llvm::CodeModel::Model> 134CMModel("code-model", 135 cl::desc("Choose code model"), 136 cl::init(CodeModel::Default), 137 cl::values(clEnumValN(CodeModel::Default, "default", 138 "Target default code model"), 139 clEnumValN(CodeModel::Small, "small", 140 "Small code model"), 141 clEnumValN(CodeModel::Kernel, "kernel", 142 "Kernel code model"), 143 clEnumValN(CodeModel::Medium, "medium", 144 "Medium code model"), 145 clEnumValN(CodeModel::Large, "large", 146 "Large code model"), 147 clEnumValEnd)); 148 149static cl::opt<bool> 150NoInitialTextSection("n", cl::desc("Don't assume assembly file starts " 151 "in the text section")); 152 153static cl::opt<bool> 154SaveTempLabels("L", cl::desc("Don't discard temporary labels")); 155 156static cl::opt<bool> 157GenDwarfForAssembly("g", cl::desc("Generate dwarf debugging info for assembly " 158 "source files")); 159 160static cl::opt<std::string> 161DebugCompilationDir("fdebug-compilation-dir", 162 cl::desc("Specifies the debug info's compilation dir")); 163 164static cl::opt<std::string> 165MainFileName("main-file-name", 166 cl::desc("Specifies the name we should consider the input file")); 167 168enum ActionType { 169 AC_AsLex, 170 AC_Assemble, 171 AC_Disassemble, 172 AC_MDisassemble, 173 AC_HDisassemble 174}; 175 176static cl::opt<ActionType> 177Action(cl::desc("Action to perform:"), 178 cl::init(AC_Assemble), 179 cl::values(clEnumValN(AC_AsLex, "as-lex", 180 "Lex tokens from a .s file"), 181 clEnumValN(AC_Assemble, "assemble", 182 "Assemble a .s file (default)"), 183 clEnumValN(AC_Disassemble, "disassemble", 184 "Disassemble strings of hex bytes"), 185 clEnumValN(AC_MDisassemble, "mdis", 186 "Marked up disassembly of strings of hex bytes"), 187 clEnumValN(AC_HDisassemble, "hdis", 188 "Disassemble strings of hex bytes printing " 189 "immediates as hex"), 190 clEnumValEnd)); 191 192static const Target *GetTarget(const char *ProgName) { 193 // Figure out the target triple. 194 if (TripleName.empty()) 195 TripleName = sys::getDefaultTargetTriple(); 196 Triple TheTriple(Triple::normalize(TripleName)); 197 198 // Get the target specific parser. 199 std::string Error; 200 const Target *TheTarget = TargetRegistry::lookupTarget(ArchName, TheTriple, 201 Error); 202 if (!TheTarget) { 203 errs() << ProgName << ": " << Error; 204 return 0; 205 } 206 207 // Update the triple name and return the found target. 208 TripleName = TheTriple.getTriple(); 209 return TheTarget; 210} 211 212static tool_output_file *GetOutputStream() { 213 if (OutputFilename == "") 214 OutputFilename = "-"; 215 216 std::string Err; 217 tool_output_file *Out = new tool_output_file(OutputFilename.c_str(), Err, 218 raw_fd_ostream::F_Binary); 219 if (!Err.empty()) { 220 errs() << Err << '\n'; 221 delete Out; 222 return 0; 223 } 224 225 return Out; 226} 227 228static std::string DwarfDebugFlags; 229static void setDwarfDebugFlags(int argc, char **argv) { 230 if (!getenv("RC_DEBUG_OPTIONS")) 231 return; 232 for (int i = 0; i < argc; i++) { 233 DwarfDebugFlags += argv[i]; 234 if (i + 1 < argc) 235 DwarfDebugFlags += " "; 236 } 237} 238 239static int AsLexInput(SourceMgr &SrcMgr, MCAsmInfo &MAI, tool_output_file *Out) { 240 241 AsmLexer Lexer(MAI); 242 Lexer.setBuffer(SrcMgr.getMemoryBuffer(0)); 243 244 bool Error = false; 245 while (Lexer.Lex().isNot(AsmToken::Eof)) { 246 AsmToken Tok = Lexer.getTok(); 247 248 switch (Tok.getKind()) { 249 default: 250 SrcMgr.PrintMessage(Lexer.getLoc(), SourceMgr::DK_Warning, 251 "unknown token"); 252 Error = true; 253 break; 254 case AsmToken::Error: 255 Error = true; // error already printed. 256 break; 257 case AsmToken::Identifier: 258 Out->os() << "identifier: " << Lexer.getTok().getString(); 259 break; 260 case AsmToken::Integer: 261 Out->os() << "int: " << Lexer.getTok().getString(); 262 break; 263 case AsmToken::Real: 264 Out->os() << "real: " << Lexer.getTok().getString(); 265 break; 266 case AsmToken::String: 267 Out->os() << "string: " << Lexer.getTok().getString(); 268 break; 269 270 case AsmToken::Amp: Out->os() << "Amp"; break; 271 case AsmToken::AmpAmp: Out->os() << "AmpAmp"; break; 272 case AsmToken::At: Out->os() << "At"; break; 273 case AsmToken::Caret: Out->os() << "Caret"; break; 274 case AsmToken::Colon: Out->os() << "Colon"; break; 275 case AsmToken::Comma: Out->os() << "Comma"; break; 276 case AsmToken::Dollar: Out->os() << "Dollar"; break; 277 case AsmToken::Dot: Out->os() << "Dot"; break; 278 case AsmToken::EndOfStatement: Out->os() << "EndOfStatement"; break; 279 case AsmToken::Eof: Out->os() << "Eof"; break; 280 case AsmToken::Equal: Out->os() << "Equal"; break; 281 case AsmToken::EqualEqual: Out->os() << "EqualEqual"; break; 282 case AsmToken::Exclaim: Out->os() << "Exclaim"; break; 283 case AsmToken::ExclaimEqual: Out->os() << "ExclaimEqual"; break; 284 case AsmToken::Greater: Out->os() << "Greater"; break; 285 case AsmToken::GreaterEqual: Out->os() << "GreaterEqual"; break; 286 case AsmToken::GreaterGreater: Out->os() << "GreaterGreater"; break; 287 case AsmToken::Hash: Out->os() << "Hash"; break; 288 case AsmToken::LBrac: Out->os() << "LBrac"; break; 289 case AsmToken::LCurly: Out->os() << "LCurly"; break; 290 case AsmToken::LParen: Out->os() << "LParen"; break; 291 case AsmToken::Less: Out->os() << "Less"; break; 292 case AsmToken::LessEqual: Out->os() << "LessEqual"; break; 293 case AsmToken::LessGreater: Out->os() << "LessGreater"; break; 294 case AsmToken::LessLess: Out->os() << "LessLess"; break; 295 case AsmToken::Minus: Out->os() << "Minus"; break; 296 case AsmToken::Percent: Out->os() << "Percent"; break; 297 case AsmToken::Pipe: Out->os() << "Pipe"; break; 298 case AsmToken::PipePipe: Out->os() << "PipePipe"; break; 299 case AsmToken::Plus: Out->os() << "Plus"; break; 300 case AsmToken::RBrac: Out->os() << "RBrac"; break; 301 case AsmToken::RCurly: Out->os() << "RCurly"; break; 302 case AsmToken::RParen: Out->os() << "RParen"; break; 303 case AsmToken::Slash: Out->os() << "Slash"; break; 304 case AsmToken::Star: Out->os() << "Star"; break; 305 case AsmToken::Tilde: Out->os() << "Tilde"; break; 306 } 307 308 // Print the token string. 309 Out->os() << " (\""; 310 Out->os().write_escaped(Tok.getString()); 311 Out->os() << "\")\n"; 312 } 313 314 return Error; 315} 316 317static int AssembleInput(const char *ProgName, const Target *TheTarget, 318 SourceMgr &SrcMgr, MCContext &Ctx, MCStreamer &Str, 319 MCAsmInfo &MAI, MCSubtargetInfo &STI) { 320 OwningPtr<MCAsmParser> Parser(createMCAsmParser(SrcMgr, Ctx, 321 Str, MAI)); 322 OwningPtr<MCTargetAsmParser> TAP(TheTarget->createMCAsmParser(STI, *Parser)); 323 if (!TAP) { 324 errs() << ProgName 325 << ": error: this target does not support assembly parsing.\n"; 326 return 1; 327 } 328 329 Parser->setShowParsedOperands(ShowInstOperands); 330 Parser->setTargetParser(*TAP.get()); 331 332 int Res = Parser->Run(NoInitialTextSection); 333 334 return Res; 335} 336 337int main(int argc, char **argv) { 338 // Print a stack trace if we signal out. 339 sys::PrintStackTraceOnErrorSignal(); 340 PrettyStackTraceProgram X(argc, argv); 341 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit. 342 343 // Initialize targets and assembly printers/parsers. 344 llvm::InitializeAllTargetInfos(); 345 llvm::InitializeAllTargetMCs(); 346 llvm::InitializeAllAsmParsers(); 347 llvm::InitializeAllDisassemblers(); 348 349 // Register the target printer for --version. 350 cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion); 351 352 cl::ParseCommandLineOptions(argc, argv, "llvm machine code playground\n"); 353 TripleName = Triple::normalize(TripleName); 354 setDwarfDebugFlags(argc, argv); 355 356 const char *ProgName = argv[0]; 357 const Target *TheTarget = GetTarget(ProgName); 358 if (!TheTarget) 359 return 1; 360 361 OwningPtr<MemoryBuffer> BufferPtr; 362 if (error_code ec = MemoryBuffer::getFileOrSTDIN(InputFilename, BufferPtr)) { 363 errs() << ProgName << ": " << ec.message() << '\n'; 364 return 1; 365 } 366 MemoryBuffer *Buffer = BufferPtr.take(); 367 368 SourceMgr SrcMgr; 369 370 // Tell SrcMgr about this buffer, which is what the parser will pick up. 371 SrcMgr.AddNewSourceBuffer(Buffer, SMLoc()); 372 373 // Record the location of the include directories so that the lexer can find 374 // it later. 375 SrcMgr.setIncludeDirs(IncludeDirs); 376 377 378 llvm::OwningPtr<MCAsmInfo> MAI(TheTarget->createMCAsmInfo(TripleName)); 379 assert(MAI && "Unable to create target asm info!"); 380 381 llvm::OwningPtr<MCRegisterInfo> MRI(TheTarget->createMCRegInfo(TripleName)); 382 assert(MRI && "Unable to create target register info!"); 383 384 // FIXME: This is not pretty. MCContext has a ptr to MCObjectFileInfo and 385 // MCObjectFileInfo needs a MCContext reference in order to initialize itself. 386 OwningPtr<MCObjectFileInfo> MOFI(new MCObjectFileInfo()); 387 MCContext Ctx(*MAI, *MRI, MOFI.get(), &SrcMgr); 388 MOFI->InitMCObjectFileInfo(TripleName, RelocModel, CMModel, Ctx); 389 390 if (SaveTempLabels) 391 Ctx.setAllowTemporaryLabels(false); 392 393 Ctx.setGenDwarfForAssembly(GenDwarfForAssembly); 394 if (!DwarfDebugFlags.empty()) 395 Ctx.setDwarfDebugFlags(StringRef(DwarfDebugFlags)); 396 if (!DebugCompilationDir.empty()) 397 Ctx.setCompilationDir(DebugCompilationDir); 398 if (!MainFileName.empty()) 399 Ctx.setMainFileName(MainFileName); 400 401 // Package up features to be passed to target/subtarget 402 std::string FeaturesStr; 403 if (MAttrs.size()) { 404 SubtargetFeatures Features; 405 for (unsigned i = 0; i != MAttrs.size(); ++i) 406 Features.AddFeature(MAttrs[i]); 407 FeaturesStr = Features.getString(); 408 } 409 410 OwningPtr<tool_output_file> Out(GetOutputStream()); 411 if (!Out) 412 return 1; 413 414 formatted_raw_ostream FOS(Out->os()); 415 OwningPtr<MCStreamer> Str; 416 417 OwningPtr<MCInstrInfo> MCII(TheTarget->createMCInstrInfo()); 418 OwningPtr<MCSubtargetInfo> 419 STI(TheTarget->createMCSubtargetInfo(TripleName, MCPU, FeaturesStr)); 420 421 MCInstPrinter *IP; 422 if (FileType == OFT_AssemblyFile) { 423 IP = 424 TheTarget->createMCInstPrinter(OutputAsmVariant, *MAI, *MCII, *MRI, *STI); 425 MCCodeEmitter *CE = 0; 426 MCAsmBackend *MAB = 0; 427 if (ShowEncoding) { 428 CE = TheTarget->createMCCodeEmitter(*MCII, *MRI, *STI, Ctx); 429 MAB = TheTarget->createMCAsmBackend(TripleName, MCPU); 430 } 431 bool UseCFI = !DisableCFI; 432 Str.reset(TheTarget->createAsmStreamer(Ctx, FOS, /*asmverbose*/true, 433 /*useLoc*/ true, 434 UseCFI, 435 /*useDwarfDirectory*/ true, 436 IP, CE, MAB, ShowInst)); 437 438 } else if (FileType == OFT_Null) { 439 Str.reset(createNullStreamer(Ctx)); 440 } else { 441 assert(FileType == OFT_ObjectFile && "Invalid file type!"); 442 MCCodeEmitter *CE = TheTarget->createMCCodeEmitter(*MCII, *MRI, *STI, Ctx); 443 MCAsmBackend *MAB = TheTarget->createMCAsmBackend(TripleName, MCPU); 444 Str.reset(TheTarget->createMCObjectStreamer(TripleName, Ctx, *MAB, 445 FOS, CE, RelaxAll, 446 NoExecStack)); 447 } 448 449 int Res = 1; 450 bool disassemble = false; 451 switch (Action) { 452 case AC_AsLex: 453 Res = AsLexInput(SrcMgr, *MAI, Out.get()); 454 break; 455 case AC_Assemble: 456 Res = AssembleInput(ProgName, TheTarget, SrcMgr, Ctx, *Str, *MAI, *STI); 457 break; 458 case AC_MDisassemble: 459 IP->setUseMarkup(1); 460 disassemble = true; 461 break; 462 case AC_HDisassemble: 463 IP->setPrintImmHex(1); 464 disassemble = true; 465 break; 466 case AC_Disassemble: 467 disassemble = true; 468 break; 469 } 470 if (disassemble) 471 Res = Disassembler::disassemble(*TheTarget, TripleName, *STI, *Str, 472 *Buffer, SrcMgr, Out->os()); 473 474 // Keep output if no errors. 475 if (Res == 0) Out->keep(); 476 return Res; 477} 478