lib/CodeGen/AsmPrinter/AsmPrinterInlineAsm.cpp

   1 //===-- AsmPrinter.cpp - Common AsmPrinter code ---------------------------===//
   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 file implements the AsmPrinter class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #define DEBUG_TYPE "asm-printer"
  15 #include "llvm/InlineAsm.h"
  16 #include "llvm/CodeGen/AsmPrinter.h"
  17 #include "llvm/CodeGen/MachineBasicBlock.h"
  18 #include "llvm/MC/MCAsmInfo.h"
  19 #include "llvm/MC/MCStreamer.h"
  20 #include "llvm/MC/MCSymbol.h"
  21 #include "llvm/ADT/SmallString.h"
  22 #include "llvm/ADT/Twine.h"
  23 #include "llvm/Support/ErrorHandling.h"
  24 #include "llvm/Support/raw_ostream.h"
  25 #include <cerrno>  // FIXME: Stop using this.
  26 using namespace llvm;
  27
  28 /// EmitInlineAsm - Emit a blob of inline asm to the output streamer.
  29 void AsmPrinter::EmitInlineAsm(StringRef Str) const {
  30   assert(!Str.empty() && "Can't emit empty inline asm block");
  31
  32   // If the output streamer is actually a .s file, just emit the blob textually.
  33   // This is useful in case the asm parser doesn't handle something but the
  34   // system assembler does.
  35   if (OutStreamer.hasRawTextSupport()) {
  36     OutStreamer.EmitRawText(Str);
  37     return;
  38   }
  39
  40   errs() << "Inline asm not supported by this streamer!\n";
  41 }
  42
  43
  44 /// EmitInlineAsm - This method formats and emits the specified machine
  45 /// instruction that is an inline asm.
  46 void AsmPrinter::EmitInlineAsm(const MachineInstr *MI) const {
  47   assert(MI->isInlineAsm() && "printInlineAsm only works on inline asms");
  48
  49   unsigned NumOperands = MI->getNumOperands();
  50
  51   // Count the number of register definitions to find the asm string.
  52   unsigned NumDefs = 0;
  53   for (; MI->getOperand(NumDefs).isReg() && MI->getOperand(NumDefs).isDef();
  54        ++NumDefs)
  55     assert(NumDefs != NumOperands-1 && "No asm string?");
  56
  57   assert(MI->getOperand(NumDefs).isSymbol() && "No asm string?");
  58
  59   // Disassemble the AsmStr, printing out the literal pieces, the operands, etc.
  60   const char *AsmStr = MI->getOperand(NumDefs).getSymbolName();
  61
  62   // If this asmstr is empty, just print the #APP/#NOAPP markers.
  63   // These are useful to see where empty asm's wound up.
  64   if (AsmStr[0] == 0) {
  65     if (!OutStreamer.hasRawTextSupport()) return;
  66
  67     OutStreamer.EmitRawText(Twine("\t")+MAI->getCommentString()+
  68                             MAI->getInlineAsmStart());
  69     OutStreamer.EmitRawText(Twine("\t")+MAI->getCommentString()+
  70                             MAI->getInlineAsmEnd());
  71     return;
  72   }
  73
  74   // Emit the #APP start marker.  This has to happen even if verbose-asm isn't
  75   // enabled, so we use EmitRawText.
  76   if (OutStreamer.hasRawTextSupport())
  77     OutStreamer.EmitRawText(Twine("\t")+MAI->getCommentString()+
  78                             MAI->getInlineAsmStart());
  79
  80   // Emit the inline asm to a temporary string so we can emit it through
  81   // EmitInlineAsm.
  82   SmallString<256> StringData;
  83   raw_svector_ostream OS(StringData);
  84
  85   OS << '\t';
  86
  87   // The variant of the current asmprinter.
  88   int AsmPrinterVariant = MAI->getAssemblerDialect();
  89
  90   int CurVariant = -1;            // The number of the {.|.|.} region we are in.
  91   const char *LastEmitted = AsmStr; // One past the last character emitted.
  92
  93   while (*LastEmitted) {
  94     switch (*LastEmitted) {
  95     default: {
  96       // Not a special case, emit the string section literally.
  97       const char *LiteralEnd = LastEmitted+1;
  98       while (*LiteralEnd && *LiteralEnd != '{' && *LiteralEnd != '|' &&
  99              *LiteralEnd != '}' && *LiteralEnd != '$' && *LiteralEnd != '\n')
 100         ++LiteralEnd;
 101       if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
 102         OS.write(LastEmitted, LiteralEnd-LastEmitted);
 103       LastEmitted = LiteralEnd;
 104       break;
 105     }
 106     case '\n':
 107       ++LastEmitted;   // Consume newline character.
 108       OS << '\n';       // Indent code with newline.
 109       break;
 110     case '$': {
 111       ++LastEmitted;   // Consume '$' character.
 112       bool Done = true;
 113
 114       // Handle escapes.
 115       switch (*LastEmitted) {
 116       default: Done = false; break;
 117       case '$':     // $$ -> $
 118         if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
 119           OS << '$';
 120         ++LastEmitted;  // Consume second '$' character.
 121         break;
 122       case '(':             // $( -> same as GCC's { character.
 123         ++LastEmitted;      // Consume '(' character.
 124         if (CurVariant != -1) {
 125           llvm_report_error("Nested variants found in inline asm string: '"
 126                             + std::string(AsmStr) + "'");
 127         }
 128         CurVariant = 0;     // We're in the first variant now.
 129         break;
 130       case '|':
 131         ++LastEmitted;  // consume '|' character.
 132         if (CurVariant == -1)
 133           OS << '|';       // this is gcc's behavior for | outside a variant
 134         else
 135           ++CurVariant;   // We're in the next variant.
 136         break;
 137       case ')':         // $) -> same as GCC's } char.
 138         ++LastEmitted;  // consume ')' character.
 139         if (CurVariant == -1)
 140           OS << '}';     // this is gcc's behavior for } outside a variant
 141         else
 142           CurVariant = -1;
 143         break;
 144       }
 145       if (Done) break;
 146
 147       bool HasCurlyBraces = false;
 148       if (*LastEmitted == '{') {     // ${variable}
 149         ++LastEmitted;               // Consume '{' character.
 150         HasCurlyBraces = true;
 151       }
 152
 153       // If we have ${:foo}, then this is not a real operand reference, it is a
 154       // "magic" string reference, just like in .td files.  Arrange to call
 155       // PrintSpecial.
 156       if (HasCurlyBraces && *LastEmitted == ':') {
 157         ++LastEmitted;
 158         const char *StrStart = LastEmitted;
 159         const char *StrEnd = strchr(StrStart, '}');
 160         if (StrEnd == 0)
 161           llvm_report_error(Twine("Unterminated ${:foo} operand in inline asm"
 162                                   " string: '") + Twine(AsmStr) + "'");
 163
 164         std::string Val(StrStart, StrEnd);
 165         PrintSpecial(MI, OS, Val.c_str());
 166         LastEmitted = StrEnd+1;
 167         break;
 168       }
 169
 170       const char *IDStart = LastEmitted;
 171       char *IDEnd;
 172       errno = 0;
 173       long Val = strtol(IDStart, &IDEnd, 10); // We only accept numbers for IDs.
 174       if (!isdigit(*IDStart) || (Val == 0 && errno == EINVAL)) {
 175         llvm_report_error("Bad $ operand number in inline asm string: '"
 176                           + std::string(AsmStr) + "'");
 177       }
 178       LastEmitted = IDEnd;
 179
 180       char Modifier[2] = { 0, 0 };
 181
 182       if (HasCurlyBraces) {
 183         // If we have curly braces, check for a modifier character.  This
 184         // supports syntax like ${0:u}, which correspond to "%u0" in GCC asm.
 185         if (*LastEmitted == ':') {
 186           ++LastEmitted;    // Consume ':' character.
 187           if (*LastEmitted == 0) {
 188             llvm_report_error("Bad ${:} expression in inline asm string: '"
 189                               + std::string(AsmStr) + "'");
 190           }
 191
 192           Modifier[0] = *LastEmitted;
 193           ++LastEmitted;    // Consume modifier character.
 194         }
 195
 196         if (*LastEmitted != '}') {
 197           llvm_report_error("Bad ${} expression in inline asm string: '"
 198                             + std::string(AsmStr) + "'");
 199         }
 200         ++LastEmitted;    // Consume '}' character.
 201       }
 202
 203       if ((unsigned)Val >= NumOperands-1) {
 204         llvm_report_error("Invalid $ operand number in inline asm string: '"
 205                           + std::string(AsmStr) + "'");
 206       }
 207
 208       // Okay, we finally have a value number.  Ask the target to print this
 209       // operand!
 210       if (CurVariant == -1 || CurVariant == AsmPrinterVariant) {
 211         unsigned OpNo = 1;
 212
 213         bool Error = false;
 214
 215         // Scan to find the machine operand number for the operand.
 216         for (; Val; --Val) {
 217           if (OpNo >= MI->getNumOperands()) break;
 218           unsigned OpFlags = MI->getOperand(OpNo).getImm();
 219           OpNo += InlineAsm::getNumOperandRegisters(OpFlags) + 1;
 220         }
 221
 222         if (OpNo >= MI->getNumOperands()) {
 223           Error = true;
 224         } else {
 225           unsigned OpFlags = MI->getOperand(OpNo).getImm();
 226           ++OpNo;  // Skip over the ID number.
 227
 228           if (Modifier[0] == 'l')  // labels are target independent
 229             // FIXME: What if the operand isn't an MBB, report error?
 230             OS << *MI->getOperand(OpNo).getMBB()->getSymbol();
 231           else {
 232             AsmPrinter *AP = const_cast<AsmPrinter*>(this);
 233             if ((OpFlags & 7) == 4) {
 234               Error = AP->PrintAsmMemoryOperand(MI, OpNo, AsmPrinterVariant,
 235                                                 Modifier[0] ? Modifier : 0,
 236                                                 OS);
 237             } else {
 238               Error = AP->PrintAsmOperand(MI, OpNo, AsmPrinterVariant,
 239                                           Modifier[0] ? Modifier : 0, OS);
 240             }
 241           }
 242         }
 243         if (Error) {
 244           std::string msg;
 245           raw_string_ostream Msg(msg);
 246           Msg << "Invalid operand found in inline asm: '" << AsmStr << "'\n";
 247           MI->print(Msg);
 248           llvm_report_error(Msg.str());
 249         }
 250       }
 251       break;
 252     }
 253     }
 254   }
 255   OS << "\n";
 256
 257   EmitInlineAsm(OS.str());
 258
 259   // Emit the #NOAPP end marker.  This has to happen even if verbose-asm isn't
 260   // enabled, so we use EmitRawText.
 261   if (OutStreamer.hasRawTextSupport())
 262     OutStreamer.EmitRawText(Twine("\t")+MAI->getCommentString()+
 263                             MAI->getInlineAsmEnd());
 264 }
 265
 266
 267 /// PrintSpecial - Print information related to the specified machine instr
 268 /// that is independent of the operand, and may be independent of the instr
 269 /// itself.  This can be useful for portably encoding the comment character
 270 /// or other bits of target-specific knowledge into the asmstrings.  The
 271 /// syntax used is ${:comment}.  Targets can override this to add support
 272 /// for their own strange codes.
 273 void AsmPrinter::PrintSpecial(const MachineInstr *MI, raw_ostream &OS,
 274                               const char *Code) const {
 275   if (!strcmp(Code, "private")) {
 276     OS << MAI->getPrivateGlobalPrefix();
 277   } else if (!strcmp(Code, "comment")) {
 278     OS << MAI->getCommentString();
 279   } else if (!strcmp(Code, "uid")) {
 280     // Comparing the address of MI isn't sufficient, because machineinstrs may
 281     // be allocated to the same address across functions.
 282
 283     // If this is a new LastFn instruction, bump the counter.
 284     if (LastMI != MI || LastFn != getFunctionNumber()) {
 285       ++Counter;
 286       LastMI = MI;
 287       LastFn = getFunctionNumber();
 288     }
 289     OS << Counter;
 290   } else {
 291     std::string msg;
 292     raw_string_ostream Msg(msg);
 293     Msg << "Unknown special formatter '" << Code
 294          << "' for machine instr: " << *MI;
 295     llvm_report_error(Msg.str());
 296   }
 297 }
 298
 299 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
 300 /// instruction, using the specified assembler variant.  Targets should
 301 /// override this to format as appropriate.
 302 bool AsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
 303                                  unsigned AsmVariant, const char *ExtraCode,
 304                                  raw_ostream &O) {
 305   // Target doesn't support this yet!
 306   return true;
 307 }
 308
 309 bool AsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
 310                                        unsigned AsmVariant,
 311                                        const char *ExtraCode, raw_ostream &O) {
 312   // Target doesn't support this yet!
 313   return true;
 314 }
 315