1 //===-- AsmPrinterInlineAsm.cpp - AsmPrinter Inline Asm Handling ----------===//
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 file implements the inline assembler pieces of the AsmPrinter class.
12 //===----------------------------------------------------------------------===//
14 #define DEBUG_TYPE "asm-printer"
15 #include "llvm/CodeGen/AsmPrinter.h"
16 #include "llvm/Constants.h"
17 #include "llvm/InlineAsm.h"
18 #include "llvm/LLVMContext.h"
19 #include "llvm/Module.h"
20 #include "llvm/CodeGen/MachineBasicBlock.h"
21 #include "llvm/CodeGen/MachineModuleInfo.h"
22 #include "llvm/MC/MCAsmInfo.h"
23 #include "llvm/MC/MCStreamer.h"
24 #include "llvm/MC/MCSubtargetInfo.h"
25 #include "llvm/MC/MCSymbol.h"
26 #include "llvm/MC/MCTargetAsmParser.h"
27 #include "llvm/Target/TargetMachine.h"
28 #include "llvm/ADT/OwningPtr.h"
29 #include "llvm/ADT/SmallString.h"
30 #include "llvm/ADT/Twine.h"
31 #include "llvm/Support/ErrorHandling.h"
32 #include "llvm/Support/MemoryBuffer.h"
33 #include "llvm/Support/SourceMgr.h"
34 #include "llvm/Support/TargetRegistry.h"
35 #include "llvm/Support/raw_ostream.h"
39 struct SrcMgrDiagInfo {
40 const MDNode *LocInfo;
41 LLVMContext::InlineAsmDiagHandlerTy DiagHandler;
46 /// srcMgrDiagHandler - This callback is invoked when the SourceMgr for an
47 /// inline asm has an error in it. diagInfo is a pointer to the SrcMgrDiagInfo
49 static void srcMgrDiagHandler(const SMDiagnostic &Diag, void *diagInfo) {
50 SrcMgrDiagInfo *DiagInfo = static_cast<SrcMgrDiagInfo *>(diagInfo);
51 assert(DiagInfo && "Diagnostic context not passed down?");
53 // If the inline asm had metadata associated with it, pull out a location
54 // cookie corresponding to which line the error occurred on.
55 unsigned LocCookie = 0;
56 if (const MDNode *LocInfo = DiagInfo->LocInfo) {
57 unsigned ErrorLine = Diag.getLineNo()-1;
58 if (ErrorLine >= LocInfo->getNumOperands())
61 if (LocInfo->getNumOperands() != 0)
62 if (const ConstantInt *CI =
63 dyn_cast<ConstantInt>(LocInfo->getOperand(ErrorLine)))
64 LocCookie = CI->getZExtValue();
67 DiagInfo->DiagHandler(Diag, DiagInfo->DiagContext, LocCookie);
70 /// EmitInlineAsm - Emit a blob of inline asm to the output streamer.
71 void AsmPrinter::EmitInlineAsm(StringRef Str, const MDNode *LocMDNode,
72 InlineAsm::AsmDialect Dialect) const {
73 assert(!Str.empty() && "Can't emit empty inline asm block");
75 // Remember if the buffer is nul terminated or not so we can avoid a copy.
76 bool isNullTerminated = Str.back() == 0;
78 Str = Str.substr(0, Str.size()-1);
80 // If the output streamer is actually a .s file, just emit the blob textually.
81 // This is useful in case the asm parser doesn't handle something but the
82 // system assembler does.
83 if (OutStreamer.hasRawTextSupport()) {
84 OutStreamer.EmitRawText(Str);
89 SrcMgrDiagInfo DiagInfo;
91 // If the current LLVMContext has an inline asm handler, set it in SourceMgr.
92 LLVMContext &LLVMCtx = MMI->getModule()->getContext();
93 bool HasDiagHandler = false;
94 if (LLVMCtx.getInlineAsmDiagnosticHandler() != 0) {
95 // If the source manager has an issue, we arrange for srcMgrDiagHandler
96 // to be invoked, getting DiagInfo passed into it.
97 DiagInfo.LocInfo = LocMDNode;
98 DiagInfo.DiagHandler = LLVMCtx.getInlineAsmDiagnosticHandler();
99 DiagInfo.DiagContext = LLVMCtx.getInlineAsmDiagnosticContext();
100 SrcMgr.setDiagHandler(srcMgrDiagHandler, &DiagInfo);
101 HasDiagHandler = true;
104 MemoryBuffer *Buffer;
105 if (isNullTerminated)
106 Buffer = MemoryBuffer::getMemBuffer(Str, "<inline asm>");
108 Buffer = MemoryBuffer::getMemBufferCopy(Str, "<inline asm>");
110 // Tell SrcMgr about this buffer, it takes ownership of the buffer.
111 SrcMgr.AddNewSourceBuffer(Buffer, SMLoc());
113 OwningPtr<MCAsmParser> Parser(createMCAsmParser(SrcMgr,
114 OutContext, OutStreamer,
117 // FIXME: It would be nice if we can avoid createing a new instance of
118 // MCSubtargetInfo here given TargetSubtargetInfo is available. However,
119 // we have to watch out for asm directives which can change subtarget
120 // state. e.g. .code 16, .code 32.
121 OwningPtr<MCSubtargetInfo>
122 STI(TM.getTarget().createMCSubtargetInfo(TM.getTargetTriple(),
124 TM.getTargetFeatureString()));
125 OwningPtr<MCTargetAsmParser>
126 TAP(TM.getTarget().createMCAsmParser(*STI, *Parser));
128 report_fatal_error("Inline asm not supported by this streamer because"
129 " we don't have an asm parser for this target\n");
130 Parser->setAssemblerDialect(Dialect);
131 Parser->setTargetParser(*TAP.get());
133 // Don't implicitly switch to the text section before the asm.
134 int Res = Parser->Run(/*NoInitialTextSection*/ true,
135 /*NoFinalize*/ true);
136 if (Res && !HasDiagHandler)
137 report_fatal_error("Error parsing inline asm\n");
141 /// EmitInlineAsm - This method formats and emits the specified machine
142 /// instruction that is an inline asm.
143 void AsmPrinter::EmitInlineAsm(const MachineInstr *MI) const {
144 assert(MI->isInlineAsm() && "printInlineAsm only works on inline asms");
146 unsigned NumOperands = MI->getNumOperands();
148 // Count the number of register definitions to find the asm string.
149 unsigned NumDefs = 0;
150 for (; MI->getOperand(NumDefs).isReg() && MI->getOperand(NumDefs).isDef();
152 assert(NumDefs != NumOperands-2 && "No asm string?");
154 assert(MI->getOperand(NumDefs).isSymbol() && "No asm string?");
156 // Disassemble the AsmStr, printing out the literal pieces, the operands, etc.
157 const char *AsmStr = MI->getOperand(NumDefs).getSymbolName();
159 // If this asmstr is empty, just print the #APP/#NOAPP markers.
160 // These are useful to see where empty asm's wound up.
161 if (AsmStr[0] == 0) {
162 // Don't emit the comments if writing to a .o file.
163 if (!OutStreamer.hasRawTextSupport()) return;
165 OutStreamer.EmitRawText(Twine("\t")+MAI->getCommentString()+
166 MAI->getInlineAsmStart());
167 OutStreamer.EmitRawText(Twine("\t")+MAI->getCommentString()+
168 MAI->getInlineAsmEnd());
172 // Emit the #APP start marker. This has to happen even if verbose-asm isn't
173 // enabled, so we use EmitRawText.
174 if (OutStreamer.hasRawTextSupport())
175 OutStreamer.EmitRawText(Twine("\t")+MAI->getCommentString()+
176 MAI->getInlineAsmStart());
178 // Get the !srcloc metadata node if we have it, and decode the loc cookie from
180 unsigned LocCookie = 0;
181 const MDNode *LocMD = 0;
182 for (unsigned i = MI->getNumOperands(); i != 0; --i) {
183 if (MI->getOperand(i-1).isMetadata() &&
184 (LocMD = MI->getOperand(i-1).getMetadata()) &&
185 LocMD->getNumOperands() != 0) {
186 if (const ConstantInt *CI = dyn_cast<ConstantInt>(LocMD->getOperand(0))) {
187 LocCookie = CI->getZExtValue();
193 // Emit the inline asm to a temporary string so we can emit it through
195 SmallString<256> StringData;
196 raw_svector_ostream OS(StringData);
200 // The variant of the current asmprinter.
201 int AsmPrinterVariant = MAI->getAssemblerDialect();
202 int InlineAsmVariant = MI->getInlineAsmDialect();
204 int CurVariant = -1; // The number of the {.|.|.} region we are in.
205 const char *LastEmitted = AsmStr; // One past the last character emitted.
207 while (*LastEmitted) {
208 switch (*LastEmitted) {
210 // Not a special case, emit the string section literally.
211 const char *LiteralEnd = LastEmitted+1;
212 while (*LiteralEnd && *LiteralEnd != '{' && *LiteralEnd != '|' &&
213 *LiteralEnd != '}' && *LiteralEnd != '$' && *LiteralEnd != '\n')
215 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
216 OS.write(LastEmitted, LiteralEnd-LastEmitted);
217 LastEmitted = LiteralEnd;
221 ++LastEmitted; // Consume newline character.
222 OS << '\n'; // Indent code with newline.
225 ++LastEmitted; // Consume '$' character.
229 switch (*LastEmitted) {
230 default: Done = false; break;
232 if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
234 ++LastEmitted; // Consume second '$' character.
236 case '(': // $( -> same as GCC's { character.
237 ++LastEmitted; // Consume '(' character.
238 if (CurVariant != -1)
239 report_fatal_error("Nested variants found in inline asm string: '" +
240 Twine(AsmStr) + "'");
241 CurVariant = 0; // We're in the first variant now.
244 ++LastEmitted; // consume '|' character.
245 if (CurVariant == -1)
246 OS << '|'; // this is gcc's behavior for | outside a variant
248 ++CurVariant; // We're in the next variant.
250 case ')': // $) -> same as GCC's } char.
251 ++LastEmitted; // consume ')' character.
252 if (CurVariant == -1)
253 OS << '}'; // this is gcc's behavior for } outside a variant
260 bool HasCurlyBraces = false;
261 if (*LastEmitted == '{') { // ${variable}
262 ++LastEmitted; // Consume '{' character.
263 HasCurlyBraces = true;
266 // If we have ${:foo}, then this is not a real operand reference, it is a
267 // "magic" string reference, just like in .td files. Arrange to call
269 if (HasCurlyBraces && *LastEmitted == ':') {
271 const char *StrStart = LastEmitted;
272 const char *StrEnd = strchr(StrStart, '}');
274 report_fatal_error("Unterminated ${:foo} operand in inline asm"
275 " string: '" + Twine(AsmStr) + "'");
277 std::string Val(StrStart, StrEnd);
278 PrintSpecial(MI, OS, Val.c_str());
279 LastEmitted = StrEnd+1;
283 const char *IDStart = LastEmitted;
284 const char *IDEnd = IDStart;
285 while (*IDEnd >= '0' && *IDEnd <= '9') ++IDEnd;
288 if (StringRef(IDStart, IDEnd-IDStart).getAsInteger(10, Val))
289 report_fatal_error("Bad $ operand number in inline asm string: '" +
290 Twine(AsmStr) + "'");
293 char Modifier[2] = { 0, 0 };
295 if (HasCurlyBraces) {
296 // If we have curly braces, check for a modifier character. This
297 // supports syntax like ${0:u}, which correspond to "%u0" in GCC asm.
298 if (*LastEmitted == ':') {
299 ++LastEmitted; // Consume ':' character.
300 if (*LastEmitted == 0)
301 report_fatal_error("Bad ${:} expression in inline asm string: '" +
302 Twine(AsmStr) + "'");
304 Modifier[0] = *LastEmitted;
305 ++LastEmitted; // Consume modifier character.
308 if (*LastEmitted != '}')
309 report_fatal_error("Bad ${} expression in inline asm string: '" +
310 Twine(AsmStr) + "'");
311 ++LastEmitted; // Consume '}' character.
314 if (Val >= NumOperands-1)
315 report_fatal_error("Invalid $ operand number in inline asm string: '" +
316 Twine(AsmStr) + "'");
318 // Okay, we finally have a value number. Ask the target to print this
320 if (CurVariant == -1 || CurVariant == AsmPrinterVariant) {
321 unsigned OpNo = InlineAsm::MIOp_FirstOperand;
325 // Scan to find the machine operand number for the operand.
327 if (OpNo >= MI->getNumOperands()) break;
328 unsigned OpFlags = MI->getOperand(OpNo).getImm();
329 OpNo += InlineAsm::getNumOperandRegisters(OpFlags) + 1;
332 // We may have a location metadata attached to the end of the
333 // instruction, and at no point should see metadata at any
334 // other point while processing. It's an error if so.
335 if (OpNo >= MI->getNumOperands() ||
336 MI->getOperand(OpNo).isMetadata()) {
339 unsigned OpFlags = MI->getOperand(OpNo).getImm();
340 ++OpNo; // Skip over the ID number.
342 if (Modifier[0] == 'l') // labels are target independent
343 // FIXME: What if the operand isn't an MBB, report error?
344 OS << *MI->getOperand(OpNo).getMBB()->getSymbol();
346 AsmPrinter *AP = const_cast<AsmPrinter*>(this);
347 if (InlineAsm::isMemKind(OpFlags)) {
348 Error = AP->PrintAsmMemoryOperand(MI, OpNo, InlineAsmVariant,
349 Modifier[0] ? Modifier : 0,
352 Error = AP->PrintAsmOperand(MI, OpNo, InlineAsmVariant,
353 Modifier[0] ? Modifier : 0, OS);
359 raw_string_ostream Msg(msg);
360 Msg << "invalid operand in inline asm: '" << AsmStr << "'";
361 MMI->getModule()->getContext().emitError(LocCookie, Msg.str());
368 OS << '\n' << (char)0; // null terminate string.
369 EmitInlineAsm(OS.str(), LocMD, MI->getInlineAsmDialect());
371 // Emit the #NOAPP end marker. This has to happen even if verbose-asm isn't
372 // enabled, so we use EmitRawText.
373 if (OutStreamer.hasRawTextSupport())
374 OutStreamer.EmitRawText(Twine("\t")+MAI->getCommentString()+
375 MAI->getInlineAsmEnd());
379 /// PrintSpecial - Print information related to the specified machine instr
380 /// that is independent of the operand, and may be independent of the instr
381 /// itself. This can be useful for portably encoding the comment character
382 /// or other bits of target-specific knowledge into the asmstrings. The
383 /// syntax used is ${:comment}. Targets can override this to add support
384 /// for their own strange codes.
385 void AsmPrinter::PrintSpecial(const MachineInstr *MI, raw_ostream &OS,
386 const char *Code) const {
387 if (!strcmp(Code, "private")) {
388 OS << MAI->getPrivateGlobalPrefix();
389 } else if (!strcmp(Code, "comment")) {
390 OS << MAI->getCommentString();
391 } else if (!strcmp(Code, "uid")) {
392 // Comparing the address of MI isn't sufficient, because machineinstrs may
393 // be allocated to the same address across functions.
395 // If this is a new LastFn instruction, bump the counter.
396 if (LastMI != MI || LastFn != getFunctionNumber()) {
399 LastFn = getFunctionNumber();
404 raw_string_ostream Msg(msg);
405 Msg << "Unknown special formatter '" << Code
406 << "' for machine instr: " << *MI;
407 report_fatal_error(Msg.str());
411 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
412 /// instruction, using the specified assembler variant. Targets should
413 /// override this to format as appropriate.
414 bool AsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
415 unsigned AsmVariant, const char *ExtraCode,
417 // Does this asm operand have a single letter operand modifier?
418 if (ExtraCode && ExtraCode[0]) {
419 if (ExtraCode[1] != 0) return true; // Unknown modifier.
421 const MachineOperand &MO = MI->getOperand(OpNo);
422 switch (ExtraCode[0]) {
424 return true; // Unknown modifier.
425 case 'c': // Substitute immediate value without immediate syntax
426 if (MO.getType() != MachineOperand::MO_Immediate)
430 case 'n': // Negate the immediate constant.
431 if (MO.getType() != MachineOperand::MO_Immediate)
440 bool AsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
442 const char *ExtraCode, raw_ostream &O) {
443 // Target doesn't support this yet!