1 //===-- AsmPrinterInlineAsm.cpp - AsmPrinter Inline Asm Handling ----------===//
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 inline assembler pieces of the AsmPrinter class.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "llvm/ADT/SmallString.h"
15 #include "llvm/ADT/Twine.h"
16 #include "llvm/CodeGen/AsmPrinter.h"
17 #include "llvm/CodeGen/MachineBasicBlock.h"
18 #include "llvm/CodeGen/MachineFunction.h"
19 #include "llvm/CodeGen/MachineModuleInfo.h"
20 #include "llvm/CodeGen/TargetInstrInfo.h"
21 #include "llvm/CodeGen/TargetRegisterInfo.h"
22 #include "llvm/CodeGen/TargetSubtargetInfo.h"
23 #include "llvm/IR/Constants.h"
24 #include "llvm/IR/DataLayout.h"
25 #include "llvm/IR/InlineAsm.h"
26 #include "llvm/IR/LLVMContext.h"
27 #include "llvm/IR/Module.h"
28 #include "llvm/MC/MCAsmInfo.h"
29 #include "llvm/MC/MCParser/MCTargetAsmParser.h"
30 #include "llvm/MC/MCStreamer.h"
31 #include "llvm/MC/MCSubtargetInfo.h"
32 #include "llvm/MC/MCSymbol.h"
33 #include "llvm/Support/ErrorHandling.h"
34 #include "llvm/Support/MemoryBuffer.h"
35 #include "llvm/Support/SourceMgr.h"
36 #include "llvm/Support/TargetRegistry.h"
37 #include "llvm/Support/raw_ostream.h"
38 #include "llvm/Target/TargetMachine.h"
39 using namespace llvm;
40 
41 #define DEBUG_TYPE "asm-printer"
42 
43 /// srcMgrDiagHandler - This callback is invoked when the SourceMgr for an
44 /// inline asm has an error in it.  diagInfo is a pointer to the SrcMgrDiagInfo
45 /// struct above.
46 static void srcMgrDiagHandler(const SMDiagnostic &Diag, void *diagInfo) {
47   AsmPrinter::SrcMgrDiagInfo *DiagInfo =
48       static_cast<AsmPrinter::SrcMgrDiagInfo *>(diagInfo);
49   assert(DiagInfo && "Diagnostic context not passed down?");
50 
51   // Look up a LocInfo for the buffer this diagnostic is coming from.
52   unsigned BufNum = DiagInfo->SrcMgr.FindBufferContainingLoc(Diag.getLoc());
53   const MDNode *LocInfo = nullptr;
54   if (BufNum > 0 && BufNum <= DiagInfo->LocInfos.size())
55     LocInfo = DiagInfo->LocInfos[BufNum-1];
56 
57   // If the inline asm had metadata associated with it, pull out a location
58   // cookie corresponding to which line the error occurred on.
59   unsigned LocCookie = 0;
60   if (LocInfo) {
61     unsigned ErrorLine = Diag.getLineNo()-1;
62     if (ErrorLine >= LocInfo->getNumOperands())
63       ErrorLine = 0;
64 
65     if (LocInfo->getNumOperands() != 0)
66       if (const ConstantInt *CI =
67               mdconst::dyn_extract<ConstantInt>(LocInfo->getOperand(ErrorLine)))
68         LocCookie = CI->getZExtValue();
69   }
70 
71   DiagInfo->DiagHandler(Diag, DiagInfo->DiagContext, LocCookie);
72 }
73 
74 unsigned AsmPrinter::addInlineAsmDiagBuffer(StringRef AsmStr,
75                                             const MDNode *LocMDNode) const {
76   if (!DiagInfo) {
77     DiagInfo = make_unique<SrcMgrDiagInfo>();
78 
79     MCContext &Context = MMI->getContext();
80     Context.setInlineSourceManager(&DiagInfo->SrcMgr);
81 
82     LLVMContext &LLVMCtx = MMI->getModule()->getContext();
83     if (LLVMCtx.getInlineAsmDiagnosticHandler()) {
84       DiagInfo->DiagHandler = LLVMCtx.getInlineAsmDiagnosticHandler();
85       DiagInfo->DiagContext = LLVMCtx.getInlineAsmDiagnosticContext();
86       DiagInfo->SrcMgr.setDiagHandler(srcMgrDiagHandler, DiagInfo.get());
87     }
88   }
89 
90   SourceMgr &SrcMgr = DiagInfo->SrcMgr;
91 
92   std::unique_ptr<MemoryBuffer> Buffer;
93   // The inline asm source manager will outlive AsmStr, so make a copy of the
94   // string for SourceMgr to own.
95   Buffer = MemoryBuffer::getMemBufferCopy(AsmStr, "<inline asm>");
96 
97   // Tell SrcMgr about this buffer, it takes ownership of the buffer.
98   unsigned BufNum = SrcMgr.AddNewSourceBuffer(std::move(Buffer), SMLoc());
99 
100   // Store LocMDNode in DiagInfo, using BufNum as an identifier.
101   if (LocMDNode) {
102     DiagInfo->LocInfos.resize(BufNum);
103     DiagInfo->LocInfos[BufNum - 1] = LocMDNode;
104   }
105 
106   return BufNum;
107 }
108 
109 
110 /// EmitInlineAsm - Emit a blob of inline asm to the output streamer.
111 void AsmPrinter::EmitInlineAsm(StringRef Str, const MCSubtargetInfo &STI,
112                                const MCTargetOptions &MCOptions,
113                                const MDNode *LocMDNode,
114                                InlineAsm::AsmDialect Dialect) const {
115   assert(!Str.empty() && "Can't emit empty inline asm block");
116 
117   // Remember if the buffer is nul terminated or not so we can avoid a copy.
118   bool isNullTerminated = Str.back() == 0;
119   if (isNullTerminated)
120     Str = Str.substr(0, Str.size()-1);
121 
122   // If the output streamer does not have mature MC support or the integrated
123   // assembler has been disabled, just emit the blob textually.
124   // Otherwise parse the asm and emit it via MC support.
125   // This is useful in case the asm parser doesn't handle something but the
126   // system assembler does.
127   const MCAsmInfo *MCAI = TM.getMCAsmInfo();
128   assert(MCAI && "No MCAsmInfo");
129   if (!MCAI->useIntegratedAssembler() &&
130       !OutStreamer->isIntegratedAssemblerRequired()) {
131     emitInlineAsmStart();
132     OutStreamer->EmitRawText(Str);
133     emitInlineAsmEnd(STI, nullptr);
134     return;
135   }
136 
137   unsigned BufNum = addInlineAsmDiagBuffer(Str, LocMDNode);
138   DiagInfo->SrcMgr.setIncludeDirs(MCOptions.IASSearchPaths);
139 
140   std::unique_ptr<MCAsmParser> Parser(createMCAsmParser(
141           DiagInfo->SrcMgr, OutContext, *OutStreamer, *MAI, BufNum));
142 
143   // Do not use assembler-level information for parsing inline assembly.
144   OutStreamer->setUseAssemblerInfoForParsing(false);
145 
146   // We create a new MCInstrInfo here since we might be at the module level
147   // and not have a MachineFunction to initialize the TargetInstrInfo from and
148   // we only need MCInstrInfo for asm parsing. We create one unconditionally
149   // because it's not subtarget dependent.
150   std::unique_ptr<MCInstrInfo> MII(TM.getTarget().createMCInstrInfo());
151   std::unique_ptr<MCTargetAsmParser> TAP(TM.getTarget().createMCAsmParser(
152       STI, *Parser, *MII, MCOptions));
153   if (!TAP)
154     report_fatal_error("Inline asm not supported by this streamer because"
155                        " we don't have an asm parser for this target\n");
156   Parser->setAssemblerDialect(Dialect);
157   Parser->setTargetParser(*TAP.get());
158   Parser->setEnablePrintSchedInfo(EnablePrintSchedInfo);
159   if (Dialect == InlineAsm::AD_Intel)
160     // We need this flag to be able to parse numbers like "0bH"
161     Parser->setParsingInlineAsm(true);
162   if (MF) {
163     const TargetRegisterInfo *TRI = MF->getSubtarget().getRegisterInfo();
164     TAP->SetFrameRegister(TRI->getFrameRegister(*MF));
165   }
166 
167   emitInlineAsmStart();
168   // Don't implicitly switch to the text section before the asm.
169   int Res = Parser->Run(/*NoInitialTextSection*/ true,
170                         /*NoFinalize*/ true);
171   emitInlineAsmEnd(STI, &TAP->getSTI());
172 
173   if (Res && !DiagInfo->DiagHandler)
174     report_fatal_error("Error parsing inline asm\n");
175 }
176 
177 static void EmitMSInlineAsmStr(const char *AsmStr, const MachineInstr *MI,
178                                MachineModuleInfo *MMI, int InlineAsmVariant,
179                                AsmPrinter *AP, unsigned LocCookie,
180                                raw_ostream &OS) {
181   // Switch to the inline assembly variant.
182   OS << "\t.intel_syntax\n\t";
183 
184   const char *LastEmitted = AsmStr; // One past the last character emitted.
185   unsigned NumOperands = MI->getNumOperands();
186 
187   while (*LastEmitted) {
188     switch (*LastEmitted) {
189     default: {
190       // Not a special case, emit the string section literally.
191       const char *LiteralEnd = LastEmitted+1;
192       while (*LiteralEnd && *LiteralEnd != '{' && *LiteralEnd != '|' &&
193              *LiteralEnd != '}' && *LiteralEnd != '$' && *LiteralEnd != '\n')
194         ++LiteralEnd;
195 
196       OS.write(LastEmitted, LiteralEnd-LastEmitted);
197       LastEmitted = LiteralEnd;
198       break;
199     }
200     case '\n':
201       ++LastEmitted;   // Consume newline character.
202       OS << '\n';      // Indent code with newline.
203       break;
204     case '$': {
205       ++LastEmitted;   // Consume '$' character.
206       bool Done = true;
207 
208       // Handle escapes.
209       switch (*LastEmitted) {
210       default: Done = false; break;
211       case '$':
212         ++LastEmitted;  // Consume second '$' character.
213         break;
214       }
215       if (Done) break;
216 
217       // If we have ${:foo}, then this is not a real operand reference, it is a
218       // "magic" string reference, just like in .td files.  Arrange to call
219       // PrintSpecial.
220       if (LastEmitted[0] == '{' && LastEmitted[1] == ':') {
221         LastEmitted += 2;
222         const char *StrStart = LastEmitted;
223         const char *StrEnd = strchr(StrStart, '}');
224         if (!StrEnd)
225           report_fatal_error("Unterminated ${:foo} operand in inline asm"
226                              " string: '" + Twine(AsmStr) + "'");
227 
228         std::string Val(StrStart, StrEnd);
229         AP->PrintSpecial(MI, OS, Val.c_str());
230         LastEmitted = StrEnd+1;
231         break;
232       }
233 
234       const char *IDStart = LastEmitted;
235       const char *IDEnd = IDStart;
236       while (*IDEnd >= '0' && *IDEnd <= '9') ++IDEnd;
237 
238       unsigned Val;
239       if (StringRef(IDStart, IDEnd-IDStart).getAsInteger(10, Val))
240         report_fatal_error("Bad $ operand number in inline asm string: '" +
241                            Twine(AsmStr) + "'");
242       LastEmitted = IDEnd;
243 
244       if (Val >= NumOperands-1)
245         report_fatal_error("Invalid $ operand number in inline asm string: '" +
246                            Twine(AsmStr) + "'");
247 
248       // Okay, we finally have a value number.  Ask the target to print this
249       // operand!
250       unsigned OpNo = InlineAsm::MIOp_FirstOperand;
251 
252       bool Error = false;
253 
254       // Scan to find the machine operand number for the operand.
255       for (; Val; --Val) {
256         if (OpNo >= MI->getNumOperands()) break;
257         unsigned OpFlags = MI->getOperand(OpNo).getImm();
258         OpNo += InlineAsm::getNumOperandRegisters(OpFlags) + 1;
259       }
260 
261       // We may have a location metadata attached to the end of the
262       // instruction, and at no point should see metadata at any
263       // other point while processing. It's an error if so.
264       if (OpNo >= MI->getNumOperands() ||
265           MI->getOperand(OpNo).isMetadata()) {
266         Error = true;
267       } else {
268         unsigned OpFlags = MI->getOperand(OpNo).getImm();
269         ++OpNo;  // Skip over the ID number.
270 
271         if (InlineAsm::isMemKind(OpFlags)) {
272           Error = AP->PrintAsmMemoryOperand(MI, OpNo, InlineAsmVariant,
273                                             /*Modifier*/ nullptr, OS);
274         } else {
275           Error = AP->PrintAsmOperand(MI, OpNo, InlineAsmVariant,
276                                       /*Modifier*/ nullptr, OS);
277         }
278       }
279       if (Error) {
280         std::string msg;
281         raw_string_ostream Msg(msg);
282         Msg << "invalid operand in inline asm: '" << AsmStr << "'";
283         MMI->getModule()->getContext().emitError(LocCookie, Msg.str());
284       }
285       break;
286     }
287     }
288   }
289   OS << "\n\t.att_syntax\n" << (char)0;  // null terminate string.
290 }
291 
292 static void EmitGCCInlineAsmStr(const char *AsmStr, const MachineInstr *MI,
293                                 MachineModuleInfo *MMI, int InlineAsmVariant,
294                                 int AsmPrinterVariant, AsmPrinter *AP,
295                                 unsigned LocCookie, raw_ostream &OS) {
296   int CurVariant = -1;            // The number of the {.|.|.} region we are in.
297   const char *LastEmitted = AsmStr; // One past the last character emitted.
298   unsigned NumOperands = MI->getNumOperands();
299 
300   OS << '\t';
301 
302   while (*LastEmitted) {
303     switch (*LastEmitted) {
304     default: {
305       // Not a special case, emit the string section literally.
306       const char *LiteralEnd = LastEmitted+1;
307       while (*LiteralEnd && *LiteralEnd != '{' && *LiteralEnd != '|' &&
308              *LiteralEnd != '}' && *LiteralEnd != '$' && *LiteralEnd != '\n')
309         ++LiteralEnd;
310       if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
311         OS.write(LastEmitted, LiteralEnd-LastEmitted);
312       LastEmitted = LiteralEnd;
313       break;
314     }
315     case '\n':
316       ++LastEmitted;   // Consume newline character.
317       OS << '\n';      // Indent code with newline.
318       break;
319     case '$': {
320       ++LastEmitted;   // Consume '$' character.
321       bool Done = true;
322 
323       // Handle escapes.
324       switch (*LastEmitted) {
325       default: Done = false; break;
326       case '$':     // $$ -> $
327         if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
328           OS << '$';
329         ++LastEmitted;  // Consume second '$' character.
330         break;
331       case '(':             // $( -> same as GCC's { character.
332         ++LastEmitted;      // Consume '(' character.
333         if (CurVariant != -1)
334           report_fatal_error("Nested variants found in inline asm string: '" +
335                              Twine(AsmStr) + "'");
336         CurVariant = 0;     // We're in the first variant now.
337         break;
338       case '|':
339         ++LastEmitted;  // consume '|' character.
340         if (CurVariant == -1)
341           OS << '|';       // this is gcc's behavior for | outside a variant
342         else
343           ++CurVariant;   // We're in the next variant.
344         break;
345       case ')':         // $) -> same as GCC's } char.
346         ++LastEmitted;  // consume ')' character.
347         if (CurVariant == -1)
348           OS << '}';     // this is gcc's behavior for } outside a variant
349         else
350           CurVariant = -1;
351         break;
352       }
353       if (Done) break;
354 
355       bool HasCurlyBraces = false;
356       if (*LastEmitted == '{') {     // ${variable}
357         ++LastEmitted;               // Consume '{' character.
358         HasCurlyBraces = true;
359       }
360 
361       // If we have ${:foo}, then this is not a real operand reference, it is a
362       // "magic" string reference, just like in .td files.  Arrange to call
363       // PrintSpecial.
364       if (HasCurlyBraces && *LastEmitted == ':') {
365         ++LastEmitted;
366         const char *StrStart = LastEmitted;
367         const char *StrEnd = strchr(StrStart, '}');
368         if (!StrEnd)
369           report_fatal_error("Unterminated ${:foo} operand in inline asm"
370                              " string: '" + Twine(AsmStr) + "'");
371 
372         std::string Val(StrStart, StrEnd);
373         AP->PrintSpecial(MI, OS, Val.c_str());
374         LastEmitted = StrEnd+1;
375         break;
376       }
377 
378       const char *IDStart = LastEmitted;
379       const char *IDEnd = IDStart;
380       while (*IDEnd >= '0' && *IDEnd <= '9') ++IDEnd;
381 
382       unsigned Val;
383       if (StringRef(IDStart, IDEnd-IDStart).getAsInteger(10, Val))
384         report_fatal_error("Bad $ operand number in inline asm string: '" +
385                            Twine(AsmStr) + "'");
386       LastEmitted = IDEnd;
387 
388       char Modifier[2] = { 0, 0 };
389 
390       if (HasCurlyBraces) {
391         // If we have curly braces, check for a modifier character.  This
392         // supports syntax like ${0:u}, which correspond to "%u0" in GCC asm.
393         if (*LastEmitted == ':') {
394           ++LastEmitted;    // Consume ':' character.
395           if (*LastEmitted == 0)
396             report_fatal_error("Bad ${:} expression in inline asm string: '" +
397                                Twine(AsmStr) + "'");
398 
399           Modifier[0] = *LastEmitted;
400           ++LastEmitted;    // Consume modifier character.
401         }
402 
403         if (*LastEmitted != '}')
404           report_fatal_error("Bad ${} expression in inline asm string: '" +
405                              Twine(AsmStr) + "'");
406         ++LastEmitted;    // Consume '}' character.
407       }
408 
409       if (Val >= NumOperands-1)
410         report_fatal_error("Invalid $ operand number in inline asm string: '" +
411                            Twine(AsmStr) + "'");
412 
413       // Okay, we finally have a value number.  Ask the target to print this
414       // operand!
415       if (CurVariant == -1 || CurVariant == AsmPrinterVariant) {
416         unsigned OpNo = InlineAsm::MIOp_FirstOperand;
417 
418         bool Error = false;
419 
420         // Scan to find the machine operand number for the operand.
421         for (; Val; --Val) {
422           if (OpNo >= MI->getNumOperands()) break;
423           unsigned OpFlags = MI->getOperand(OpNo).getImm();
424           OpNo += InlineAsm::getNumOperandRegisters(OpFlags) + 1;
425         }
426 
427         // We may have a location metadata attached to the end of the
428         // instruction, and at no point should see metadata at any
429         // other point while processing. It's an error if so.
430         if (OpNo >= MI->getNumOperands() ||
431             MI->getOperand(OpNo).isMetadata()) {
432           Error = true;
433         } else {
434           unsigned OpFlags = MI->getOperand(OpNo).getImm();
435           ++OpNo;  // Skip over the ID number.
436 
437           if (Modifier[0] == 'l') { // Labels are target independent.
438             // FIXME: What if the operand isn't an MBB, report error?
439             const MCSymbol *Sym = MI->getOperand(OpNo).getMBB()->getSymbol();
440             Sym->print(OS, AP->MAI);
441           } else {
442             if (InlineAsm::isMemKind(OpFlags)) {
443               Error = AP->PrintAsmMemoryOperand(MI, OpNo, InlineAsmVariant,
444                                                 Modifier[0] ? Modifier : nullptr,
445                                                 OS);
446             } else {
447               Error = AP->PrintAsmOperand(MI, OpNo, InlineAsmVariant,
448                                           Modifier[0] ? Modifier : nullptr, OS);
449             }
450           }
451         }
452         if (Error) {
453           std::string msg;
454           raw_string_ostream Msg(msg);
455           Msg << "invalid operand in inline asm: '" << AsmStr << "'";
456           MMI->getModule()->getContext().emitError(LocCookie, Msg.str());
457         }
458       }
459       break;
460     }
461     }
462   }
463   OS << '\n' << (char)0;  // null terminate string.
464 }
465 
466 /// EmitInlineAsm - This method formats and emits the specified machine
467 /// instruction that is an inline asm.
468 void AsmPrinter::EmitInlineAsm(const MachineInstr *MI) const {
469   assert(MI->isInlineAsm() && "printInlineAsm only works on inline asms");
470 
471   // Count the number of register definitions to find the asm string.
472   unsigned NumDefs = 0;
473   for (; MI->getOperand(NumDefs).isReg() && MI->getOperand(NumDefs).isDef();
474        ++NumDefs)
475     assert(NumDefs != MI->getNumOperands()-2 && "No asm string?");
476 
477   assert(MI->getOperand(NumDefs).isSymbol() && "No asm string?");
478 
479   // Disassemble the AsmStr, printing out the literal pieces, the operands, etc.
480   const char *AsmStr = MI->getOperand(NumDefs).getSymbolName();
481 
482   // If this asmstr is empty, just print the #APP/#NOAPP markers.
483   // These are useful to see where empty asm's wound up.
484   if (AsmStr[0] == 0) {
485     OutStreamer->emitRawComment(MAI->getInlineAsmStart());
486     OutStreamer->emitRawComment(MAI->getInlineAsmEnd());
487     return;
488   }
489 
490   // Emit the #APP start marker.  This has to happen even if verbose-asm isn't
491   // enabled, so we use emitRawComment.
492   OutStreamer->emitRawComment(MAI->getInlineAsmStart());
493 
494   // Get the !srcloc metadata node if we have it, and decode the loc cookie from
495   // it.
496   unsigned LocCookie = 0;
497   const MDNode *LocMD = nullptr;
498   for (unsigned i = MI->getNumOperands(); i != 0; --i) {
499     if (MI->getOperand(i-1).isMetadata() &&
500         (LocMD = MI->getOperand(i-1).getMetadata()) &&
501         LocMD->getNumOperands() != 0) {
502       if (const ConstantInt *CI =
503               mdconst::dyn_extract<ConstantInt>(LocMD->getOperand(0))) {
504         LocCookie = CI->getZExtValue();
505         break;
506       }
507     }
508   }
509 
510   // Emit the inline asm to a temporary string so we can emit it through
511   // EmitInlineAsm.
512   SmallString<256> StringData;
513   raw_svector_ostream OS(StringData);
514 
515   // The variant of the current asmprinter.
516   int AsmPrinterVariant = MAI->getAssemblerDialect();
517   InlineAsm::AsmDialect InlineAsmVariant = MI->getInlineAsmDialect();
518   AsmPrinter *AP = const_cast<AsmPrinter*>(this);
519   if (InlineAsmVariant == InlineAsm::AD_ATT)
520     EmitGCCInlineAsmStr(AsmStr, MI, MMI, InlineAsmVariant, AsmPrinterVariant,
521                         AP, LocCookie, OS);
522   else
523     EmitMSInlineAsmStr(AsmStr, MI, MMI, InlineAsmVariant, AP, LocCookie, OS);
524 
525   // Reset SanitizeAddress based on the function's attribute.
526   MCTargetOptions MCOptions = TM.Options.MCOptions;
527   MCOptions.SanitizeAddress =
528       MF->getFunction().hasFnAttribute(Attribute::SanitizeAddress);
529 
530   // Emit warnings if we use reserved registers on the clobber list, as
531   // that might give surprising results.
532   std::vector<std::string> RestrRegs;
533   // Start with the first operand descriptor, and iterate over them.
534   for (unsigned I = InlineAsm::MIOp_FirstOperand, NumOps = MI->getNumOperands();
535        I < NumOps; ++I) {
536     const MachineOperand &MO = MI->getOperand(I);
537     if (MO.isImm()) {
538       unsigned Flags = MO.getImm();
539       const TargetRegisterInfo *TRI = MF->getSubtarget().getRegisterInfo();
540       if (InlineAsm::getKind(Flags) == InlineAsm::Kind_Clobber &&
541           !TRI->isAsmClobberable(*MF, MI->getOperand(I + 1).getReg())) {
542         RestrRegs.push_back(TRI->getName(MI->getOperand(I + 1).getReg()));
543       }
544       // Skip to one before the next operand descriptor, if it exists.
545       I += InlineAsm::getNumOperandRegisters(Flags);
546     }
547   }
548 
549   if (!RestrRegs.empty()) {
550     unsigned BufNum = addInlineAsmDiagBuffer(OS.str(), LocMD);
551     auto &SrcMgr = DiagInfo->SrcMgr;
552     SMLoc Loc = SMLoc::getFromPointer(
553         SrcMgr.getMemoryBuffer(BufNum)->getBuffer().begin());
554 
555     std::string Msg = "inline asm clobber list contains reserved registers: ";
556     for (auto I = RestrRegs.begin(), E = RestrRegs.end(); I != E; I++) {
557       if(I != RestrRegs.begin())
558         Msg += ", ";
559       Msg += *I;
560     }
561     std::string Note = "Reserved registers on the clobber list may not be "
562                 "preserved across the asm statement, and clobbering them may "
563                 "lead to undefined behaviour.";
564     SrcMgr.PrintMessage(Loc, SourceMgr::DK_Warning, Msg);
565     SrcMgr.PrintMessage(Loc, SourceMgr::DK_Note, Note);
566   }
567 
568   EmitInlineAsm(OS.str(), getSubtargetInfo(), MCOptions, LocMD,
569                 MI->getInlineAsmDialect());
570 
571   // Emit the #NOAPP end marker.  This has to happen even if verbose-asm isn't
572   // enabled, so we use emitRawComment.
573   OutStreamer->emitRawComment(MAI->getInlineAsmEnd());
574 }
575 
576 
577 /// PrintSpecial - Print information related to the specified machine instr
578 /// that is independent of the operand, and may be independent of the instr
579 /// itself.  This can be useful for portably encoding the comment character
580 /// or other bits of target-specific knowledge into the asmstrings.  The
581 /// syntax used is ${:comment}.  Targets can override this to add support
582 /// for their own strange codes.
583 void AsmPrinter::PrintSpecial(const MachineInstr *MI, raw_ostream &OS,
584                               const char *Code) const {
585   if (!strcmp(Code, "private")) {
586     const DataLayout &DL = MF->getDataLayout();
587     OS << DL.getPrivateGlobalPrefix();
588   } else if (!strcmp(Code, "comment")) {
589     OS << MAI->getCommentString();
590   } else if (!strcmp(Code, "uid")) {
591     // Comparing the address of MI isn't sufficient, because machineinstrs may
592     // be allocated to the same address across functions.
593 
594     // If this is a new LastFn instruction, bump the counter.
595     if (LastMI != MI || LastFn != getFunctionNumber()) {
596       ++Counter;
597       LastMI = MI;
598       LastFn = getFunctionNumber();
599     }
600     OS << Counter;
601   } else {
602     std::string msg;
603     raw_string_ostream Msg(msg);
604     Msg << "Unknown special formatter '" << Code
605          << "' for machine instr: " << *MI;
606     report_fatal_error(Msg.str());
607   }
608 }
609 
610 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
611 /// instruction, using the specified assembler variant.  Targets should
612 /// override this to format as appropriate.
613 bool AsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
614                                  unsigned AsmVariant, const char *ExtraCode,
615                                  raw_ostream &O) {
616   // Does this asm operand have a single letter operand modifier?
617   if (ExtraCode && ExtraCode[0]) {
618     if (ExtraCode[1] != 0) return true; // Unknown modifier.
619 
620     const MachineOperand &MO = MI->getOperand(OpNo);
621     switch (ExtraCode[0]) {
622     default:
623       return true;  // Unknown modifier.
624     case 'c': // Substitute immediate value without immediate syntax
625       if (MO.getType() != MachineOperand::MO_Immediate)
626         return true;
627       O << MO.getImm();
628       return false;
629     case 'n':  // Negate the immediate constant.
630       if (MO.getType() != MachineOperand::MO_Immediate)
631         return true;
632       O << -MO.getImm();
633       return false;
634     case 's':  // The GCC deprecated s modifier
635       if (MO.getType() != MachineOperand::MO_Immediate)
636         return true;
637       O << ((32 - MO.getImm()) & 31);
638       return false;
639     }
640   }
641   return true;
642 }
643 
644 bool AsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
645                                        unsigned AsmVariant,
646                                        const char *ExtraCode, raw_ostream &O) {
647   // Target doesn't support this yet!
648   return true;
649 }
650 
651 void AsmPrinter::emitInlineAsmStart() const {}
652 
653 void AsmPrinter::emitInlineAsmEnd(const MCSubtargetInfo &StartInfo,
654                                   const MCSubtargetInfo *EndInfo) const {}
655