xref: /freebsd/contrib/llvm-project/llvm/lib/Target/X86/X86AsmPrinter.cpp (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1 //===-- X86AsmPrinter.cpp - Convert X86 LLVM code to AT&T assembly --------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file contains a printer that converts from our internal representation
10 // of machine-dependent LLVM code to X86 machine code.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "X86AsmPrinter.h"
15 #include "MCTargetDesc/X86ATTInstPrinter.h"
16 #include "MCTargetDesc/X86BaseInfo.h"
17 #include "MCTargetDesc/X86TargetStreamer.h"
18 #include "TargetInfo/X86TargetInfo.h"
19 #include "X86InstrInfo.h"
20 #include "X86MachineFunctionInfo.h"
21 #include "X86Subtarget.h"
22 #include "llvm/BinaryFormat/COFF.h"
23 #include "llvm/BinaryFormat/ELF.h"
24 #include "llvm/CodeGen/MachineConstantPool.h"
25 #include "llvm/CodeGen/MachineModuleInfoImpls.h"
26 #include "llvm/CodeGen/TargetLoweringObjectFileImpl.h"
27 #include "llvm/IR/DerivedTypes.h"
28 #include "llvm/IR/InlineAsm.h"
29 #include "llvm/IR/Mangler.h"
30 #include "llvm/IR/Module.h"
31 #include "llvm/IR/Type.h"
32 #include "llvm/MC/MCCodeEmitter.h"
33 #include "llvm/MC/MCContext.h"
34 #include "llvm/MC/MCExpr.h"
35 #include "llvm/MC/MCSectionCOFF.h"
36 #include "llvm/MC/MCSectionELF.h"
37 #include "llvm/MC/MCSectionMachO.h"
38 #include "llvm/MC/MCStreamer.h"
39 #include "llvm/MC/MCSymbol.h"
40 #include "llvm/MC/TargetRegistry.h"
41 #include "llvm/Support/Debug.h"
42 #include "llvm/Support/ErrorHandling.h"
43 #include "llvm/Support/MachineValueType.h"
44 #include "llvm/Target/TargetMachine.h"
45 
46 using namespace llvm;
47 
48 X86AsmPrinter::X86AsmPrinter(TargetMachine &TM,
49                              std::unique_ptr<MCStreamer> Streamer)
50     : AsmPrinter(TM, std::move(Streamer)), SM(*this), FM(*this) {}
51 
52 //===----------------------------------------------------------------------===//
53 // Primitive Helper Functions.
54 //===----------------------------------------------------------------------===//
55 
56 /// runOnMachineFunction - Emit the function body.
57 ///
58 bool X86AsmPrinter::runOnMachineFunction(MachineFunction &MF) {
59   Subtarget = &MF.getSubtarget<X86Subtarget>();
60 
61   SMShadowTracker.startFunction(MF);
62   CodeEmitter.reset(TM.getTarget().createMCCodeEmitter(
63       *Subtarget->getInstrInfo(), *Subtarget->getRegisterInfo(),
64       MF.getContext()));
65 
66   EmitFPOData =
67       Subtarget->isTargetWin32() && MF.getMMI().getModule()->getCodeViewFlag();
68 
69   SetupMachineFunction(MF);
70 
71   if (Subtarget->isTargetCOFF()) {
72     bool Local = MF.getFunction().hasLocalLinkage();
73     OutStreamer->BeginCOFFSymbolDef(CurrentFnSym);
74     OutStreamer->EmitCOFFSymbolStorageClass(
75         Local ? COFF::IMAGE_SYM_CLASS_STATIC : COFF::IMAGE_SYM_CLASS_EXTERNAL);
76     OutStreamer->EmitCOFFSymbolType(COFF::IMAGE_SYM_DTYPE_FUNCTION
77                                                << COFF::SCT_COMPLEX_TYPE_SHIFT);
78     OutStreamer->EndCOFFSymbolDef();
79   }
80 
81   // Emit the rest of the function body.
82   emitFunctionBody();
83 
84   // Emit the XRay table for this function.
85   emitXRayTable();
86 
87   EmitFPOData = false;
88 
89   // We didn't modify anything.
90   return false;
91 }
92 
93 void X86AsmPrinter::emitFunctionBodyStart() {
94   if (EmitFPOData) {
95     if (auto *XTS =
96         static_cast<X86TargetStreamer *>(OutStreamer->getTargetStreamer()))
97       XTS->emitFPOProc(
98           CurrentFnSym,
99           MF->getInfo<X86MachineFunctionInfo>()->getArgumentStackSize());
100   }
101 }
102 
103 void X86AsmPrinter::emitFunctionBodyEnd() {
104   if (EmitFPOData) {
105     if (auto *XTS =
106             static_cast<X86TargetStreamer *>(OutStreamer->getTargetStreamer()))
107       XTS->emitFPOEndProc();
108   }
109 }
110 
111 /// PrintSymbolOperand - Print a raw symbol reference operand.  This handles
112 /// jump tables, constant pools, global address and external symbols, all of
113 /// which print to a label with various suffixes for relocation types etc.
114 void X86AsmPrinter::PrintSymbolOperand(const MachineOperand &MO,
115                                        raw_ostream &O) {
116   switch (MO.getType()) {
117   default: llvm_unreachable("unknown symbol type!");
118   case MachineOperand::MO_ConstantPoolIndex:
119     GetCPISymbol(MO.getIndex())->print(O, MAI);
120     printOffset(MO.getOffset(), O);
121     break;
122   case MachineOperand::MO_GlobalAddress: {
123     const GlobalValue *GV = MO.getGlobal();
124 
125     MCSymbol *GVSym;
126     if (MO.getTargetFlags() == X86II::MO_DARWIN_NONLAZY ||
127         MO.getTargetFlags() == X86II::MO_DARWIN_NONLAZY_PIC_BASE)
128       GVSym = getSymbolWithGlobalValueBase(GV, "$non_lazy_ptr");
129     else
130       GVSym = getSymbolPreferLocal(*GV);
131 
132     // Handle dllimport linkage.
133     if (MO.getTargetFlags() == X86II::MO_DLLIMPORT)
134       GVSym = OutContext.getOrCreateSymbol(Twine("__imp_") + GVSym->getName());
135     else if (MO.getTargetFlags() == X86II::MO_COFFSTUB)
136       GVSym =
137           OutContext.getOrCreateSymbol(Twine(".refptr.") + GVSym->getName());
138 
139     if (MO.getTargetFlags() == X86II::MO_DARWIN_NONLAZY ||
140         MO.getTargetFlags() == X86II::MO_DARWIN_NONLAZY_PIC_BASE) {
141       MCSymbol *Sym = getSymbolWithGlobalValueBase(GV, "$non_lazy_ptr");
142       MachineModuleInfoImpl::StubValueTy &StubSym =
143           MMI->getObjFileInfo<MachineModuleInfoMachO>().getGVStubEntry(Sym);
144       if (!StubSym.getPointer())
145         StubSym = MachineModuleInfoImpl::StubValueTy(getSymbol(GV),
146                                                      !GV->hasInternalLinkage());
147     }
148 
149     // If the name begins with a dollar-sign, enclose it in parens.  We do this
150     // to avoid having it look like an integer immediate to the assembler.
151     if (GVSym->getName()[0] != '$')
152       GVSym->print(O, MAI);
153     else {
154       O << '(';
155       GVSym->print(O, MAI);
156       O << ')';
157     }
158     printOffset(MO.getOffset(), O);
159     break;
160   }
161   }
162 
163   switch (MO.getTargetFlags()) {
164   default:
165     llvm_unreachable("Unknown target flag on GV operand");
166   case X86II::MO_NO_FLAG:    // No flag.
167     break;
168   case X86II::MO_DARWIN_NONLAZY:
169   case X86II::MO_DLLIMPORT:
170   case X86II::MO_COFFSTUB:
171     // These affect the name of the symbol, not any suffix.
172     break;
173   case X86II::MO_GOT_ABSOLUTE_ADDRESS:
174     O << " + [.-";
175     MF->getPICBaseSymbol()->print(O, MAI);
176     O << ']';
177     break;
178   case X86II::MO_PIC_BASE_OFFSET:
179   case X86II::MO_DARWIN_NONLAZY_PIC_BASE:
180     O << '-';
181     MF->getPICBaseSymbol()->print(O, MAI);
182     break;
183   case X86II::MO_TLSGD:     O << "@TLSGD";     break;
184   case X86II::MO_TLSLD:     O << "@TLSLD";     break;
185   case X86II::MO_TLSLDM:    O << "@TLSLDM";    break;
186   case X86II::MO_GOTTPOFF:  O << "@GOTTPOFF";  break;
187   case X86II::MO_INDNTPOFF: O << "@INDNTPOFF"; break;
188   case X86II::MO_TPOFF:     O << "@TPOFF";     break;
189   case X86II::MO_DTPOFF:    O << "@DTPOFF";    break;
190   case X86II::MO_NTPOFF:    O << "@NTPOFF";    break;
191   case X86II::MO_GOTNTPOFF: O << "@GOTNTPOFF"; break;
192   case X86II::MO_GOTPCREL:  O << "@GOTPCREL";  break;
193   case X86II::MO_GOTPCREL_NORELAX: O << "@GOTPCREL_NORELAX"; break;
194   case X86II::MO_GOT:       O << "@GOT";       break;
195   case X86II::MO_GOTOFF:    O << "@GOTOFF";    break;
196   case X86II::MO_PLT:       O << "@PLT";       break;
197   case X86II::MO_TLVP:      O << "@TLVP";      break;
198   case X86II::MO_TLVP_PIC_BASE:
199     O << "@TLVP" << '-';
200     MF->getPICBaseSymbol()->print(O, MAI);
201     break;
202   case X86II::MO_SECREL:    O << "@SECREL32";  break;
203   }
204 }
205 
206 void X86AsmPrinter::PrintOperand(const MachineInstr *MI, unsigned OpNo,
207                                  raw_ostream &O) {
208   const MachineOperand &MO = MI->getOperand(OpNo);
209   const bool IsATT = MI->getInlineAsmDialect() == InlineAsm::AD_ATT;
210   switch (MO.getType()) {
211   default: llvm_unreachable("unknown operand type!");
212   case MachineOperand::MO_Register: {
213     if (IsATT)
214       O << '%';
215     O << X86ATTInstPrinter::getRegisterName(MO.getReg());
216     return;
217   }
218 
219   case MachineOperand::MO_Immediate:
220     if (IsATT)
221       O << '$';
222     O << MO.getImm();
223     return;
224 
225   case MachineOperand::MO_ConstantPoolIndex:
226   case MachineOperand::MO_GlobalAddress: {
227     switch (MI->getInlineAsmDialect()) {
228     case InlineAsm::AD_ATT:
229       O << '$';
230       break;
231     case InlineAsm::AD_Intel:
232       O << "offset ";
233       break;
234     }
235     PrintSymbolOperand(MO, O);
236     break;
237   }
238   case MachineOperand::MO_BlockAddress: {
239     MCSymbol *Sym = GetBlockAddressSymbol(MO.getBlockAddress());
240     Sym->print(O, MAI);
241     break;
242   }
243   }
244 }
245 
246 /// PrintModifiedOperand - Print subregisters based on supplied modifier,
247 /// deferring to PrintOperand() if no modifier was supplied or if operand is not
248 /// a register.
249 void X86AsmPrinter::PrintModifiedOperand(const MachineInstr *MI, unsigned OpNo,
250                                          raw_ostream &O, const char *Modifier) {
251   const MachineOperand &MO = MI->getOperand(OpNo);
252   if (!Modifier || MO.getType() != MachineOperand::MO_Register)
253     return PrintOperand(MI, OpNo, O);
254   if (MI->getInlineAsmDialect() == InlineAsm::AD_ATT)
255     O << '%';
256   Register Reg = MO.getReg();
257   if (strncmp(Modifier, "subreg", strlen("subreg")) == 0) {
258     unsigned Size = (strcmp(Modifier+6,"64") == 0) ? 64 :
259         (strcmp(Modifier+6,"32") == 0) ? 32 :
260         (strcmp(Modifier+6,"16") == 0) ? 16 : 8;
261     Reg = getX86SubSuperRegister(Reg, Size);
262   }
263   O << X86ATTInstPrinter::getRegisterName(Reg);
264 }
265 
266 /// PrintPCRelImm - This is used to print an immediate value that ends up
267 /// being encoded as a pc-relative value.  These print slightly differently, for
268 /// example, a $ is not emitted.
269 void X86AsmPrinter::PrintPCRelImm(const MachineInstr *MI, unsigned OpNo,
270                                   raw_ostream &O) {
271   const MachineOperand &MO = MI->getOperand(OpNo);
272   switch (MO.getType()) {
273   default: llvm_unreachable("Unknown pcrel immediate operand");
274   case MachineOperand::MO_Register:
275     // pc-relativeness was handled when computing the value in the reg.
276     PrintOperand(MI, OpNo, O);
277     return;
278   case MachineOperand::MO_Immediate:
279     O << MO.getImm();
280     return;
281   case MachineOperand::MO_GlobalAddress:
282     PrintSymbolOperand(MO, O);
283     return;
284   }
285 }
286 
287 void X86AsmPrinter::PrintLeaMemReference(const MachineInstr *MI, unsigned OpNo,
288                                          raw_ostream &O, const char *Modifier) {
289   const MachineOperand &BaseReg = MI->getOperand(OpNo + X86::AddrBaseReg);
290   const MachineOperand &IndexReg = MI->getOperand(OpNo + X86::AddrIndexReg);
291   const MachineOperand &DispSpec = MI->getOperand(OpNo + X86::AddrDisp);
292 
293   // If we really don't want to print out (rip), don't.
294   bool HasBaseReg = BaseReg.getReg() != 0;
295   if (HasBaseReg && Modifier && !strcmp(Modifier, "no-rip") &&
296       BaseReg.getReg() == X86::RIP)
297     HasBaseReg = false;
298 
299   // HasParenPart - True if we will print out the () part of the mem ref.
300   bool HasParenPart = IndexReg.getReg() || HasBaseReg;
301 
302   switch (DispSpec.getType()) {
303   default:
304     llvm_unreachable("unknown operand type!");
305   case MachineOperand::MO_Immediate: {
306     int DispVal = DispSpec.getImm();
307     if (DispVal || !HasParenPart)
308       O << DispVal;
309     break;
310   }
311   case MachineOperand::MO_GlobalAddress:
312   case MachineOperand::MO_ConstantPoolIndex:
313     PrintSymbolOperand(DispSpec, O);
314     break;
315   }
316 
317   if (Modifier && strcmp(Modifier, "H") == 0)
318     O << "+8";
319 
320   if (HasParenPart) {
321     assert(IndexReg.getReg() != X86::ESP &&
322            "X86 doesn't allow scaling by ESP");
323 
324     O << '(';
325     if (HasBaseReg)
326       PrintModifiedOperand(MI, OpNo + X86::AddrBaseReg, O, Modifier);
327 
328     if (IndexReg.getReg()) {
329       O << ',';
330       PrintModifiedOperand(MI, OpNo + X86::AddrIndexReg, O, Modifier);
331       unsigned ScaleVal = MI->getOperand(OpNo + X86::AddrScaleAmt).getImm();
332       if (ScaleVal != 1)
333         O << ',' << ScaleVal;
334     }
335     O << ')';
336   }
337 }
338 
339 void X86AsmPrinter::PrintMemReference(const MachineInstr *MI, unsigned OpNo,
340                                       raw_ostream &O, const char *Modifier) {
341   assert(isMem(*MI, OpNo) && "Invalid memory reference!");
342   const MachineOperand &Segment = MI->getOperand(OpNo + X86::AddrSegmentReg);
343   if (Segment.getReg()) {
344     PrintModifiedOperand(MI, OpNo + X86::AddrSegmentReg, O, Modifier);
345     O << ':';
346   }
347   PrintLeaMemReference(MI, OpNo, O, Modifier);
348 }
349 
350 
351 void X86AsmPrinter::PrintIntelMemReference(const MachineInstr *MI,
352                                            unsigned OpNo, raw_ostream &O,
353                                            const char *Modifier) {
354   const MachineOperand &BaseReg = MI->getOperand(OpNo + X86::AddrBaseReg);
355   unsigned ScaleVal = MI->getOperand(OpNo + X86::AddrScaleAmt).getImm();
356   const MachineOperand &IndexReg = MI->getOperand(OpNo + X86::AddrIndexReg);
357   const MachineOperand &DispSpec = MI->getOperand(OpNo + X86::AddrDisp);
358   const MachineOperand &SegReg = MI->getOperand(OpNo + X86::AddrSegmentReg);
359 
360   // If we really don't want to print out (rip), don't.
361   bool HasBaseReg = BaseReg.getReg() != 0;
362   if (HasBaseReg && Modifier && !strcmp(Modifier, "no-rip") &&
363       BaseReg.getReg() == X86::RIP)
364     HasBaseReg = false;
365 
366   // If this has a segment register, print it.
367   if (SegReg.getReg()) {
368     PrintOperand(MI, OpNo + X86::AddrSegmentReg, O);
369     O << ':';
370   }
371 
372   O << '[';
373 
374   bool NeedPlus = false;
375   if (HasBaseReg) {
376     PrintOperand(MI, OpNo + X86::AddrBaseReg, O);
377     NeedPlus = true;
378   }
379 
380   if (IndexReg.getReg()) {
381     if (NeedPlus) O << " + ";
382     if (ScaleVal != 1)
383       O << ScaleVal << '*';
384     PrintOperand(MI, OpNo + X86::AddrIndexReg, O);
385     NeedPlus = true;
386   }
387 
388   if (!DispSpec.isImm()) {
389     if (NeedPlus) O << " + ";
390     PrintOperand(MI, OpNo + X86::AddrDisp, O);
391   } else {
392     int64_t DispVal = DispSpec.getImm();
393     if (DispVal || (!IndexReg.getReg() && !HasBaseReg)) {
394       if (NeedPlus) {
395         if (DispVal > 0)
396           O << " + ";
397         else {
398           O << " - ";
399           DispVal = -DispVal;
400         }
401       }
402       O << DispVal;
403     }
404   }
405   O << ']';
406 }
407 
408 static bool printAsmMRegister(const X86AsmPrinter &P, const MachineOperand &MO,
409                               char Mode, raw_ostream &O) {
410   Register Reg = MO.getReg();
411   bool EmitPercent = MO.getParent()->getInlineAsmDialect() == InlineAsm::AD_ATT;
412 
413   if (!X86::GR8RegClass.contains(Reg) &&
414       !X86::GR16RegClass.contains(Reg) &&
415       !X86::GR32RegClass.contains(Reg) &&
416       !X86::GR64RegClass.contains(Reg))
417     return true;
418 
419   switch (Mode) {
420   default: return true;  // Unknown mode.
421   case 'b': // Print QImode register
422     Reg = getX86SubSuperRegister(Reg, 8);
423     break;
424   case 'h': // Print QImode high register
425     Reg = getX86SubSuperRegister(Reg, 8, true);
426     break;
427   case 'w': // Print HImode register
428     Reg = getX86SubSuperRegister(Reg, 16);
429     break;
430   case 'k': // Print SImode register
431     Reg = getX86SubSuperRegister(Reg, 32);
432     break;
433   case 'V':
434     EmitPercent = false;
435     LLVM_FALLTHROUGH;
436   case 'q':
437     // Print 64-bit register names if 64-bit integer registers are available.
438     // Otherwise, print 32-bit register names.
439     Reg = getX86SubSuperRegister(Reg, P.getSubtarget().is64Bit() ? 64 : 32);
440     break;
441   }
442 
443   if (EmitPercent)
444     O << '%';
445 
446   O << X86ATTInstPrinter::getRegisterName(Reg);
447   return false;
448 }
449 
450 static bool printAsmVRegister(const MachineOperand &MO, char Mode,
451                               raw_ostream &O) {
452   Register Reg = MO.getReg();
453   bool EmitPercent = MO.getParent()->getInlineAsmDialect() == InlineAsm::AD_ATT;
454 
455   unsigned Index;
456   if (X86::VR128XRegClass.contains(Reg))
457     Index = Reg - X86::XMM0;
458   else if (X86::VR256XRegClass.contains(Reg))
459     Index = Reg - X86::YMM0;
460   else if (X86::VR512RegClass.contains(Reg))
461     Index = Reg - X86::ZMM0;
462   else
463     return true;
464 
465   switch (Mode) {
466   default: // Unknown mode.
467     return true;
468   case 'x': // Print V4SFmode register
469     Reg = X86::XMM0 + Index;
470     break;
471   case 't': // Print V8SFmode register
472     Reg = X86::YMM0 + Index;
473     break;
474   case 'g': // Print V16SFmode register
475     Reg = X86::ZMM0 + Index;
476     break;
477   }
478 
479   if (EmitPercent)
480     O << '%';
481 
482   O << X86ATTInstPrinter::getRegisterName(Reg);
483   return false;
484 }
485 
486 /// PrintAsmOperand - Print out an operand for an inline asm expression.
487 ///
488 bool X86AsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
489                                     const char *ExtraCode, raw_ostream &O) {
490   // Does this asm operand have a single letter operand modifier?
491   if (ExtraCode && ExtraCode[0]) {
492     if (ExtraCode[1] != 0) return true; // Unknown modifier.
493 
494     const MachineOperand &MO = MI->getOperand(OpNo);
495 
496     switch (ExtraCode[0]) {
497     default:
498       // See if this is a generic print operand
499       return AsmPrinter::PrintAsmOperand(MI, OpNo, ExtraCode, O);
500     case 'a': // This is an address.  Currently only 'i' and 'r' are expected.
501       switch (MO.getType()) {
502       default:
503         return true;
504       case MachineOperand::MO_Immediate:
505         O << MO.getImm();
506         return false;
507       case MachineOperand::MO_ConstantPoolIndex:
508       case MachineOperand::MO_JumpTableIndex:
509       case MachineOperand::MO_ExternalSymbol:
510         llvm_unreachable("unexpected operand type!");
511       case MachineOperand::MO_GlobalAddress:
512         PrintSymbolOperand(MO, O);
513         if (Subtarget->isPICStyleRIPRel())
514           O << "(%rip)";
515         return false;
516       case MachineOperand::MO_Register:
517         O << '(';
518         PrintOperand(MI, OpNo, O);
519         O << ')';
520         return false;
521       }
522 
523     case 'c': // Don't print "$" before a global var name or constant.
524       switch (MO.getType()) {
525       default:
526         PrintOperand(MI, OpNo, O);
527         break;
528       case MachineOperand::MO_Immediate:
529         O << MO.getImm();
530         break;
531       case MachineOperand::MO_ConstantPoolIndex:
532       case MachineOperand::MO_JumpTableIndex:
533       case MachineOperand::MO_ExternalSymbol:
534         llvm_unreachable("unexpected operand type!");
535       case MachineOperand::MO_GlobalAddress:
536         PrintSymbolOperand(MO, O);
537         break;
538       }
539       return false;
540 
541     case 'A': // Print '*' before a register (it must be a register)
542       if (MO.isReg()) {
543         O << '*';
544         PrintOperand(MI, OpNo, O);
545         return false;
546       }
547       return true;
548 
549     case 'b': // Print QImode register
550     case 'h': // Print QImode high register
551     case 'w': // Print HImode register
552     case 'k': // Print SImode register
553     case 'q': // Print DImode register
554     case 'V': // Print native register without '%'
555       if (MO.isReg())
556         return printAsmMRegister(*this, MO, ExtraCode[0], O);
557       PrintOperand(MI, OpNo, O);
558       return false;
559 
560     case 'x': // Print V4SFmode register
561     case 't': // Print V8SFmode register
562     case 'g': // Print V16SFmode register
563       if (MO.isReg())
564         return printAsmVRegister(MO, ExtraCode[0], O);
565       PrintOperand(MI, OpNo, O);
566       return false;
567 
568     case 'P': // This is the operand of a call, treat specially.
569       PrintPCRelImm(MI, OpNo, O);
570       return false;
571 
572     case 'n': // Negate the immediate or print a '-' before the operand.
573       // Note: this is a temporary solution. It should be handled target
574       // independently as part of the 'MC' work.
575       if (MO.isImm()) {
576         O << -MO.getImm();
577         return false;
578       }
579       O << '-';
580     }
581   }
582 
583   PrintOperand(MI, OpNo, O);
584   return false;
585 }
586 
587 bool X86AsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
588                                           const char *ExtraCode,
589                                           raw_ostream &O) {
590   if (ExtraCode && ExtraCode[0]) {
591     if (ExtraCode[1] != 0) return true; // Unknown modifier.
592 
593     switch (ExtraCode[0]) {
594     default: return true;  // Unknown modifier.
595     case 'b': // Print QImode register
596     case 'h': // Print QImode high register
597     case 'w': // Print HImode register
598     case 'k': // Print SImode register
599     case 'q': // Print SImode register
600       // These only apply to registers, ignore on mem.
601       break;
602     case 'H':
603       if (MI->getInlineAsmDialect() == InlineAsm::AD_Intel) {
604         return true;  // Unsupported modifier in Intel inline assembly.
605       } else {
606         PrintMemReference(MI, OpNo, O, "H");
607       }
608       return false;
609     case 'P': // Don't print @PLT, but do print as memory.
610       if (MI->getInlineAsmDialect() == InlineAsm::AD_Intel) {
611         PrintIntelMemReference(MI, OpNo, O, "no-rip");
612       } else {
613         PrintMemReference(MI, OpNo, O, "no-rip");
614       }
615       return false;
616     }
617   }
618   if (MI->getInlineAsmDialect() == InlineAsm::AD_Intel) {
619     PrintIntelMemReference(MI, OpNo, O, nullptr);
620   } else {
621     PrintMemReference(MI, OpNo, O, nullptr);
622   }
623   return false;
624 }
625 
626 void X86AsmPrinter::emitStartOfAsmFile(Module &M) {
627   const Triple &TT = TM.getTargetTriple();
628 
629   if (TT.isOSBinFormatELF()) {
630     // Assemble feature flags that may require creation of a note section.
631     unsigned FeatureFlagsAnd = 0;
632     if (M.getModuleFlag("cf-protection-branch"))
633       FeatureFlagsAnd |= ELF::GNU_PROPERTY_X86_FEATURE_1_IBT;
634     if (M.getModuleFlag("cf-protection-return"))
635       FeatureFlagsAnd |= ELF::GNU_PROPERTY_X86_FEATURE_1_SHSTK;
636 
637     if (FeatureFlagsAnd) {
638       // Emit a .note.gnu.property section with the flags.
639       if (!TT.isArch32Bit() && !TT.isArch64Bit())
640         llvm_unreachable("CFProtection used on invalid architecture!");
641       MCSection *Cur = OutStreamer->getCurrentSectionOnly();
642       MCSection *Nt = MMI->getContext().getELFSection(
643           ".note.gnu.property", ELF::SHT_NOTE, ELF::SHF_ALLOC);
644       OutStreamer->SwitchSection(Nt);
645 
646       // Emitting note header.
647       const int WordSize = TT.isArch64Bit() && !TT.isX32() ? 8 : 4;
648       emitAlignment(WordSize == 4 ? Align(4) : Align(8));
649       OutStreamer->emitIntValue(4, 4 /*size*/); // data size for "GNU\0"
650       OutStreamer->emitIntValue(8 + WordSize, 4 /*size*/); // Elf_Prop size
651       OutStreamer->emitIntValue(ELF::NT_GNU_PROPERTY_TYPE_0, 4 /*size*/);
652       OutStreamer->emitBytes(StringRef("GNU", 4)); // note name
653 
654       // Emitting an Elf_Prop for the CET properties.
655       OutStreamer->emitInt32(ELF::GNU_PROPERTY_X86_FEATURE_1_AND);
656       OutStreamer->emitInt32(4);                          // data size
657       OutStreamer->emitInt32(FeatureFlagsAnd);            // data
658       emitAlignment(WordSize == 4 ? Align(4) : Align(8)); // padding
659 
660       OutStreamer->endSection(Nt);
661       OutStreamer->SwitchSection(Cur);
662     }
663   }
664 
665   if (TT.isOSBinFormatMachO())
666     OutStreamer->SwitchSection(getObjFileLowering().getTextSection());
667 
668   if (TT.isOSBinFormatCOFF()) {
669     // Emit an absolute @feat.00 symbol.  This appears to be some kind of
670     // compiler features bitfield read by link.exe.
671     MCSymbol *S = MMI->getContext().getOrCreateSymbol(StringRef("@feat.00"));
672     OutStreamer->BeginCOFFSymbolDef(S);
673     OutStreamer->EmitCOFFSymbolStorageClass(COFF::IMAGE_SYM_CLASS_STATIC);
674     OutStreamer->EmitCOFFSymbolType(COFF::IMAGE_SYM_DTYPE_NULL);
675     OutStreamer->EndCOFFSymbolDef();
676     int64_t Feat00Flags = 0;
677 
678     if (TT.getArch() == Triple::x86) {
679       // According to the PE-COFF spec, the LSB of this value marks the object
680       // for "registered SEH".  This means that all SEH handler entry points
681       // must be registered in .sxdata.  Use of any unregistered handlers will
682       // cause the process to terminate immediately.  LLVM does not know how to
683       // register any SEH handlers, so its object files should be safe.
684       Feat00Flags |= 1;
685     }
686 
687     if (M.getModuleFlag("cfguard")) {
688       Feat00Flags |= 0x800; // Object is CFG-aware.
689     }
690 
691     if (M.getModuleFlag("ehcontguard")) {
692       Feat00Flags |= 0x4000; // Object also has EHCont.
693     }
694 
695     OutStreamer->emitSymbolAttribute(S, MCSA_Global);
696     OutStreamer->emitAssignment(
697         S, MCConstantExpr::create(Feat00Flags, MMI->getContext()));
698   }
699   OutStreamer->emitSyntaxDirective();
700 
701   // If this is not inline asm and we're in 16-bit
702   // mode prefix assembly with .code16.
703   bool is16 = TT.getEnvironment() == Triple::CODE16;
704   if (M.getModuleInlineAsm().empty() && is16)
705     OutStreamer->emitAssemblerFlag(MCAF_Code16);
706 }
707 
708 static void
709 emitNonLazySymbolPointer(MCStreamer &OutStreamer, MCSymbol *StubLabel,
710                          MachineModuleInfoImpl::StubValueTy &MCSym) {
711   // L_foo$stub:
712   OutStreamer.emitLabel(StubLabel);
713   //   .indirect_symbol _foo
714   OutStreamer.emitSymbolAttribute(MCSym.getPointer(), MCSA_IndirectSymbol);
715 
716   if (MCSym.getInt())
717     // External to current translation unit.
718     OutStreamer.emitIntValue(0, 4/*size*/);
719   else
720     // Internal to current translation unit.
721     //
722     // When we place the LSDA into the TEXT section, the type info
723     // pointers need to be indirect and pc-rel. We accomplish this by
724     // using NLPs; however, sometimes the types are local to the file.
725     // We need to fill in the value for the NLP in those cases.
726     OutStreamer.emitValue(
727         MCSymbolRefExpr::create(MCSym.getPointer(), OutStreamer.getContext()),
728         4 /*size*/);
729 }
730 
731 static void emitNonLazyStubs(MachineModuleInfo *MMI, MCStreamer &OutStreamer) {
732 
733   MachineModuleInfoMachO &MMIMacho =
734       MMI->getObjFileInfo<MachineModuleInfoMachO>();
735 
736   // Output stubs for dynamically-linked functions.
737   MachineModuleInfoMachO::SymbolListTy Stubs;
738 
739   // Output stubs for external and common global variables.
740   Stubs = MMIMacho.GetGVStubList();
741   if (!Stubs.empty()) {
742     OutStreamer.SwitchSection(MMI->getContext().getMachOSection(
743         "__IMPORT", "__pointers", MachO::S_NON_LAZY_SYMBOL_POINTERS,
744         SectionKind::getMetadata()));
745 
746     for (auto &Stub : Stubs)
747       emitNonLazySymbolPointer(OutStreamer, Stub.first, Stub.second);
748 
749     Stubs.clear();
750     OutStreamer.AddBlankLine();
751   }
752 }
753 
754 void X86AsmPrinter::emitEndOfAsmFile(Module &M) {
755   const Triple &TT = TM.getTargetTriple();
756 
757   if (TT.isOSBinFormatMachO()) {
758     // Mach-O uses non-lazy symbol stubs to encode per-TU information into
759     // global table for symbol lookup.
760     emitNonLazyStubs(MMI, *OutStreamer);
761 
762     // Emit stack and fault map information.
763     emitStackMaps(SM);
764     FM.serializeToFaultMapSection();
765 
766     // This flag tells the linker that no global symbols contain code that fall
767     // through to other global symbols (e.g. an implementation of multiple entry
768     // points). If this doesn't occur, the linker can safely perform dead code
769     // stripping. Since LLVM never generates code that does this, it is always
770     // safe to set.
771     OutStreamer->emitAssemblerFlag(MCAF_SubsectionsViaSymbols);
772   } else if (TT.isOSBinFormatCOFF()) {
773     if (MMI->usesMSVCFloatingPoint()) {
774       // In Windows' libcmt.lib, there is a file which is linked in only if the
775       // symbol _fltused is referenced. Linking this in causes some
776       // side-effects:
777       //
778       // 1. For x86-32, it will set the x87 rounding mode to 53-bit instead of
779       // 64-bit mantissas at program start.
780       //
781       // 2. It links in support routines for floating-point in scanf and printf.
782       //
783       // MSVC emits an undefined reference to _fltused when there are any
784       // floating point operations in the program (including calls). A program
785       // that only has: `scanf("%f", &global_float);` may fail to trigger this,
786       // but oh well...that's a documented issue.
787       StringRef SymbolName =
788           (TT.getArch() == Triple::x86) ? "__fltused" : "_fltused";
789       MCSymbol *S = MMI->getContext().getOrCreateSymbol(SymbolName);
790       OutStreamer->emitSymbolAttribute(S, MCSA_Global);
791       return;
792     }
793     emitStackMaps(SM);
794   } else if (TT.isOSBinFormatELF()) {
795     emitStackMaps(SM);
796     FM.serializeToFaultMapSection();
797   }
798 }
799 
800 //===----------------------------------------------------------------------===//
801 // Target Registry Stuff
802 //===----------------------------------------------------------------------===//
803 
804 // Force static initialization.
805 extern "C" LLVM_EXTERNAL_VISIBILITY void LLVMInitializeX86AsmPrinter() {
806   RegisterAsmPrinter<X86AsmPrinter> X(getTheX86_32Target());
807   RegisterAsmPrinter<X86AsmPrinter> Y(getTheX86_64Target());
808 }
809