1 //===-- X86IntelAsmPrinter.cpp - Convert X86 LLVM code to Intel assembly --===//
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 contains a printer that converts from our internal representation
11 // of machine-dependent LLVM code to Intel format assembly language.
12 // This printer is the output mechanism used by `llc'.
14 //===----------------------------------------------------------------------===//
16 #define DEBUG_TYPE "asm-printer"
17 #include "X86IntelAsmPrinter.h"
18 #include "X86InstrInfo.h"
19 #include "X86TargetAsmInfo.h"
21 #include "llvm/CallingConv.h"
22 #include "llvm/Constants.h"
23 #include "llvm/DerivedTypes.h"
24 #include "llvm/Module.h"
25 #include "llvm/ADT/Statistic.h"
26 #include "llvm/ADT/StringExtras.h"
27 #include "llvm/Assembly/Writer.h"
28 #include "llvm/CodeGen/DwarfWriter.h"
29 #include "llvm/Support/Mangler.h"
30 #include "llvm/Target/TargetAsmInfo.h"
31 #include "llvm/Target/TargetOptions.h"
34 STATISTIC(EmittedInsts, "Number of machine instrs printed");
36 static X86MachineFunctionInfo calculateFunctionInfo(const Function *F,
37 const TargetData *TD) {
38 X86MachineFunctionInfo Info;
41 switch (F->getCallingConv()) {
42 case CallingConv::X86_StdCall:
43 Info.setDecorationStyle(StdCall);
45 case CallingConv::X86_FastCall:
46 Info.setDecorationStyle(FastCall);
53 for (Function::const_arg_iterator AI = F->arg_begin(), AE = F->arg_end();
54 AI != AE; ++AI, ++argNum) {
55 const Type* Ty = AI->getType();
57 // 'Dereference' type in case of byval parameter attribute
58 if (F->paramHasAttr(argNum, Attribute::ByVal))
59 Ty = cast<PointerType>(Ty)->getElementType();
61 // Size should be aligned to DWORD boundary
62 Size += ((TD->getTypePaddedSize(Ty) + 3)/4)*4;
65 // We're not supporting tooooo huge arguments :)
66 Info.setBytesToPopOnReturn((unsigned int)Size);
71 /// decorateName - Query FunctionInfoMap and use this information for various
73 void X86IntelAsmPrinter::decorateName(std::string &Name,
74 const GlobalValue *GV) {
75 const Function *F = dyn_cast<Function>(GV);
78 // We don't want to decorate non-stdcall or non-fastcall functions right now
79 unsigned CC = F->getCallingConv();
80 if (CC != CallingConv::X86_StdCall && CC != CallingConv::X86_FastCall)
83 FMFInfoMap::const_iterator info_item = FunctionInfoMap.find(F);
85 const X86MachineFunctionInfo *Info;
86 if (info_item == FunctionInfoMap.end()) {
87 // Calculate apropriate function info and populate map
88 FunctionInfoMap[F] = calculateFunctionInfo(F, TM.getTargetData());
89 Info = &FunctionInfoMap[F];
91 Info = &info_item->second;
94 const FunctionType *FT = F->getFunctionType();
95 switch (Info->getDecorationStyle()) {
99 // "Pure" variadic functions do not receive @0 suffix.
100 if (!FT->isVarArg() || (FT->getNumParams() == 0) ||
101 (FT->getNumParams() == 1 && F->hasStructRetAttr()))
102 Name += '@' + utostr_32(Info->getBytesToPopOnReturn());
105 // "Pure" variadic functions do not receive @0 suffix.
106 if (!FT->isVarArg() || (FT->getNumParams() == 0) ||
107 (FT->getNumParams() == 1 && F->hasStructRetAttr()))
108 Name += '@' + utostr_32(Info->getBytesToPopOnReturn());
117 assert(0 && "Unsupported DecorationStyle");
121 /// runOnMachineFunction - This uses the printMachineInstruction()
122 /// method to print assembly for each instruction.
124 bool X86IntelAsmPrinter::runOnMachineFunction(MachineFunction &MF) {
125 SetupMachineFunction(MF);
128 // Print out constants referenced by the function
129 EmitConstantPool(MF.getConstantPool());
131 // Print out labels for the function.
132 const Function *F = MF.getFunction();
133 unsigned CC = F->getCallingConv();
135 // Populate function information map. Actually, We don't want to populate
136 // non-stdcall or non-fastcall functions' information right now.
137 if (CC == CallingConv::X86_StdCall || CC == CallingConv::X86_FastCall)
138 FunctionInfoMap[F] = *MF.getInfo<X86MachineFunctionInfo>();
140 decorateName(CurrentFnName, F);
142 SwitchToTextSection("_text", F);
144 unsigned FnAlign = 4;
145 if (F->hasFnAttr(Attribute::OptimizeForSize))
147 switch (F->getLinkage()) {
148 default: assert(0 && "Unsupported linkage type!");
149 case Function::PrivateLinkage:
150 case Function::InternalLinkage:
151 EmitAlignment(FnAlign);
153 case Function::DLLExportLinkage:
154 DLLExportedFns.insert(CurrentFnName);
156 case Function::ExternalLinkage:
157 O << "\tpublic " << CurrentFnName << "\n";
158 EmitAlignment(FnAlign);
162 O << CurrentFnName << "\tproc near\n";
164 // Print out code for the function.
165 for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
167 // Print a label for the basic block if there are any predecessors.
168 if (!I->pred_empty()) {
169 printBasicBlockLabel(I, true, true);
172 for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
174 // Print the assembly for the instruction.
175 printMachineInstruction(II);
179 // Print out jump tables referenced by the function.
180 EmitJumpTableInfo(MF.getJumpTableInfo(), MF);
182 O << CurrentFnName << "\tendp\n";
186 // We didn't modify anything.
190 void X86IntelAsmPrinter::printSSECC(const MachineInstr *MI, unsigned Op) {
191 unsigned char value = MI->getOperand(Op).getImm();
192 assert(value <= 7 && "Invalid ssecc argument!");
194 case 0: O << "eq"; break;
195 case 1: O << "lt"; break;
196 case 2: O << "le"; break;
197 case 3: O << "unord"; break;
198 case 4: O << "neq"; break;
199 case 5: O << "nlt"; break;
200 case 6: O << "nle"; break;
201 case 7: O << "ord"; break;
205 void X86IntelAsmPrinter::printOp(const MachineOperand &MO,
206 const char *Modifier) {
207 switch (MO.getType()) {
208 case MachineOperand::MO_Register: {
209 if (TargetRegisterInfo::isPhysicalRegister(MO.getReg())) {
210 unsigned Reg = MO.getReg();
211 if (Modifier && strncmp(Modifier, "subreg", strlen("subreg")) == 0) {
212 MVT VT = (strcmp(Modifier,"subreg64") == 0) ?
213 MVT::i64 : ((strcmp(Modifier, "subreg32") == 0) ? MVT::i32 :
214 ((strcmp(Modifier,"subreg16") == 0) ? MVT::i16 :MVT::i8));
215 Reg = getX86SubSuperRegister(Reg, VT);
217 O << TRI->getName(Reg);
219 O << "reg" << MO.getReg();
222 case MachineOperand::MO_Immediate:
225 case MachineOperand::MO_MachineBasicBlock:
226 printBasicBlockLabel(MO.getMBB());
228 case MachineOperand::MO_JumpTableIndex: {
229 bool isMemOp = Modifier && !strcmp(Modifier, "mem");
230 if (!isMemOp) O << "OFFSET ";
231 O << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
232 << "_" << MO.getIndex();
235 case MachineOperand::MO_ConstantPoolIndex: {
236 bool isMemOp = Modifier && !strcmp(Modifier, "mem");
237 if (!isMemOp) O << "OFFSET ";
238 O << "[" << TAI->getPrivateGlobalPrefix() << "CPI"
239 << getFunctionNumber() << "_" << MO.getIndex();
240 printOffset(MO.getOffset());
244 case MachineOperand::MO_GlobalAddress: {
245 bool isCallOp = Modifier && !strcmp(Modifier, "call");
246 bool isMemOp = Modifier && !strcmp(Modifier, "mem");
247 GlobalValue *GV = MO.getGlobal();
248 std::string Name = Mang->getValueName(GV);
250 decorateName(Name, GV);
252 if (!isMemOp && !isCallOp) O << "OFFSET ";
253 if (GV->hasDLLImportLinkage()) {
254 // FIXME: This should be fixed with full support of stdcall & fastcall
259 printOffset(MO.getOffset());
262 case MachineOperand::MO_ExternalSymbol: {
263 bool isCallOp = Modifier && !strcmp(Modifier, "call");
264 if (!isCallOp) O << "OFFSET ";
265 O << TAI->getGlobalPrefix() << MO.getSymbolName();
269 O << "<unknown operand type>"; return;
273 void X86IntelAsmPrinter::printMemReference(const MachineInstr *MI, unsigned Op,
274 const char *Modifier) {
275 assert(isMem(MI, Op) && "Invalid memory reference!");
277 const MachineOperand &BaseReg = MI->getOperand(Op);
278 int ScaleVal = MI->getOperand(Op+1).getImm();
279 const MachineOperand &IndexReg = MI->getOperand(Op+2);
280 const MachineOperand &DispSpec = MI->getOperand(Op+3);
283 bool NeedPlus = false;
284 if (BaseReg.getReg()) {
285 printOp(BaseReg, Modifier);
289 if (IndexReg.getReg()) {
290 if (NeedPlus) O << " + ";
292 O << ScaleVal << "*";
293 printOp(IndexReg, Modifier);
297 if (DispSpec.isGlobal() || DispSpec.isCPI() ||
301 printOp(DispSpec, "mem");
303 int DispVal = DispSpec.getImm();
304 if (DispVal || (!BaseReg.getReg() && !IndexReg.getReg())) {
319 void X86IntelAsmPrinter::printPICJumpTableSetLabel(unsigned uid,
320 const MachineBasicBlock *MBB) const {
321 if (!TAI->getSetDirective())
324 O << TAI->getSetDirective() << ' ' << TAI->getPrivateGlobalPrefix()
325 << getFunctionNumber() << '_' << uid << "_set_" << MBB->getNumber() << ',';
326 printBasicBlockLabel(MBB, false, false, false);
327 O << '-' << "\"L" << getFunctionNumber() << "$pb\"'\n";
330 void X86IntelAsmPrinter::printPICLabel(const MachineInstr *MI, unsigned Op) {
331 O << "\"L" << getFunctionNumber() << "$pb\"\n";
332 O << "\"L" << getFunctionNumber() << "$pb\":";
335 bool X86IntelAsmPrinter::printAsmMRegister(const MachineOperand &MO,
337 unsigned Reg = MO.getReg();
339 default: return true; // Unknown mode.
340 case 'b': // Print QImode register
341 Reg = getX86SubSuperRegister(Reg, MVT::i8);
343 case 'h': // Print QImode high register
344 Reg = getX86SubSuperRegister(Reg, MVT::i8, true);
346 case 'w': // Print HImode register
347 Reg = getX86SubSuperRegister(Reg, MVT::i16);
349 case 'k': // Print SImode register
350 Reg = getX86SubSuperRegister(Reg, MVT::i32);
354 O << '%' << TRI->getName(Reg);
358 /// PrintAsmOperand - Print out an operand for an inline asm expression.
360 bool X86IntelAsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
362 const char *ExtraCode) {
363 // Does this asm operand have a single letter operand modifier?
364 if (ExtraCode && ExtraCode[0]) {
365 if (ExtraCode[1] != 0) return true; // Unknown modifier.
367 switch (ExtraCode[0]) {
368 default: return true; // Unknown modifier.
369 case 'b': // Print QImode register
370 case 'h': // Print QImode high register
371 case 'w': // Print HImode register
372 case 'k': // Print SImode register
373 return printAsmMRegister(MI->getOperand(OpNo), ExtraCode[0]);
377 printOperand(MI, OpNo);
381 bool X86IntelAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
384 const char *ExtraCode) {
385 if (ExtraCode && ExtraCode[0])
386 return true; // Unknown modifier.
387 printMemReference(MI, OpNo);
391 /// printMachineInstruction -- Print out a single X86 LLVM instruction
392 /// MI in Intel syntax to the current output stream.
394 void X86IntelAsmPrinter::printMachineInstruction(const MachineInstr *MI) {
397 // Call the autogenerated instruction printer routines.
398 printInstruction(MI);
401 bool X86IntelAsmPrinter::doInitialization(Module &M) {
402 bool Result = AsmPrinter::doInitialization(M);
404 Mang->markCharUnacceptable('.');
406 O << "\t.686\n\t.model flat\n\n";
408 // Emit declarations for external functions.
409 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
410 if (I->isDeclaration()) {
411 std::string Name = Mang->getValueName(I);
412 decorateName(Name, I);
415 if (I->hasDLLImportLinkage()) {
418 O << Name << ":near\n";
421 // Emit declarations for external globals. Note that VC++ always declares
422 // external globals to have type byte, and if that's good enough for VC++...
423 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
425 if (I->isDeclaration()) {
426 std::string Name = Mang->getValueName(I);
429 if (I->hasDLLImportLinkage()) {
432 O << Name << ":byte\n";
439 bool X86IntelAsmPrinter::doFinalization(Module &M) {
440 const TargetData *TD = TM.getTargetData();
442 // Print out module-level global variables here.
443 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
445 if (I->isDeclaration()) continue; // External global require no code
447 // Check to see if this is a special global used by LLVM, if so, emit it.
448 if (EmitSpecialLLVMGlobal(I))
451 std::string name = Mang->getValueName(I);
452 Constant *C = I->getInitializer();
453 unsigned Align = TD->getPreferredAlignmentLog(I);
454 bool bCustomSegment = false;
456 switch (I->getLinkage()) {
457 case GlobalValue::CommonLinkage:
458 case GlobalValue::LinkOnceLinkage:
459 case GlobalValue::WeakLinkage:
460 SwitchToDataSection("");
461 O << name << "?\tsegment common 'COMMON'\n";
462 bCustomSegment = true;
463 // FIXME: the default alignment is 16 bytes, but 1, 2, 4, and 256
464 // are also available.
466 case GlobalValue::AppendingLinkage:
467 SwitchToDataSection("");
468 O << name << "?\tsegment public 'DATA'\n";
469 bCustomSegment = true;
470 // FIXME: the default alignment is 16 bytes, but 1, 2, 4, and 256
471 // are also available.
473 case GlobalValue::DLLExportLinkage:
474 DLLExportedGVs.insert(name);
476 case GlobalValue::ExternalLinkage:
477 O << "\tpublic " << name << "\n";
479 case GlobalValue::InternalLinkage:
480 SwitchToSection(TAI->getDataSection());
483 assert(0 && "Unknown linkage type!");
487 EmitAlignment(Align, I);
489 O << name << ":\t\t\t\t" << TAI->getCommentString()
490 << " " << I->getName() << '\n';
492 EmitGlobalConstant(C);
495 O << name << "?\tends\n";
498 // Output linker support code for dllexported globals
499 if (!DLLExportedGVs.empty() || !DLLExportedFns.empty()) {
500 SwitchToDataSection("");
501 O << "; WARNING: The following code is valid only with MASM v8.x"
502 << "and (possible) higher\n"
503 << "; This version of MASM is usually shipped with Microsoft "
504 << "Visual Studio 2005\n"
505 << "; or (possible) further versions. Unfortunately, there is no "
506 << "way to support\n"
507 << "; dllexported symbols in the earlier versions of MASM in fully "
508 << "automatic way\n\n";
509 O << "_drectve\t segment info alias('.drectve')\n";
512 for (StringSet<>::iterator i = DLLExportedGVs.begin(),
513 e = DLLExportedGVs.end();
515 O << "\t db ' /EXPORT:" << i->getKeyData() << ",data'\n";
517 for (StringSet<>::iterator i = DLLExportedFns.begin(),
518 e = DLLExportedFns.end();
520 O << "\t db ' /EXPORT:" << i->getKeyData() << "'\n";
522 if (!DLLExportedGVs.empty() || !DLLExportedFns.empty())
523 O << "_drectve\t ends\n";
525 // Bypass X86SharedAsmPrinter::doFinalization().
526 bool Result = AsmPrinter::doFinalization(M);
527 SwitchToDataSection("");
532 void X86IntelAsmPrinter::EmitString(const ConstantArray *CVA) const {
533 unsigned NumElts = CVA->getNumOperands();
535 // ML does not have escape sequences except '' for '. It also has a maximum
536 // string length of 255.
538 bool inString = false;
539 for (unsigned i = 0; i < NumElts; i++) {
540 int n = cast<ConstantInt>(CVA->getOperand(i))->getZExtValue() & 255;
544 if (n >= 32 && n <= 127) {
571 len += 1 + (n > 9) + (n > 99);
592 // Include the auto-generated portion of the assembly writer.
593 #include "X86GenAsmWriter1.inc"