blob: 1b1edfbd154c695aea193b6f56b20868aeedd2f5 [file] [log] [blame]
Eugene Zelenko149178d2017-10-10 22:33:29 +00001//===- AsmPrinter.cpp - Common AsmPrinter code ----------------------------===//
Chris Lattner6a8e0f52004-08-16 23:15:22 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattner6a8e0f52004-08-16 23:15:22 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file implements the AsmPrinter class.
11//
12//===----------------------------------------------------------------------===//
13
Chandler Carruth6bda14b2017-06-06 11:49:48 +000014#include "llvm/CodeGen/AsmPrinter.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000015#include "AsmPrinterHandler.h"
Mehdi Aminib550cb12016-04-18 09:17:29 +000016#include "CodeViewDebug.h"
Chris Lattnerf0d6bd32010-04-05 05:11:15 +000017#include "DwarfDebug.h"
18#include "DwarfException.h"
Adrian McCarthydb2736d2018-01-09 23:49:30 +000019#include "WinCFGuard.h"
Reid Kleckner60b640b2015-05-28 22:47:01 +000020#include "WinException.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000021#include "llvm/ADT/APFloat.h"
22#include "llvm/ADT/APInt.h"
23#include "llvm/ADT/DenseMap.h"
Chandler Carruth6bda14b2017-06-06 11:49:48 +000024#include "llvm/ADT/STLExtras.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000025#include "llvm/ADT/SmallPtrSet.h"
26#include "llvm/ADT/SmallString.h"
27#include "llvm/ADT/SmallVector.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000028#include "llvm/ADT/Statistic.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000029#include "llvm/ADT/StringRef.h"
30#include "llvm/ADT/Triple.h"
31#include "llvm/ADT/Twine.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000032#include "llvm/Analysis/ConstantFolding.h"
Eugene Zelenko149178d2017-10-10 22:33:29 +000033#include "llvm/Analysis/EHPersonalities.h"
Eugene Zelenko149178d2017-10-10 22:33:29 +000034#include "llvm/Analysis/OptimizationRemarkEmitter.h"
Zachary Turner264b5d92017-06-07 03:48:56 +000035#include "llvm/BinaryFormat/Dwarf.h"
36#include "llvm/BinaryFormat/ELF.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000037#include "llvm/CodeGen/GCMetadata.h"
Gordon Henriksend930f912008-08-17 18:44:35 +000038#include "llvm/CodeGen/GCMetadataPrinter.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000039#include "llvm/CodeGen/GCStrategy.h"
40#include "llvm/CodeGen/MachineBasicBlock.h"
Chris Lattnerf2991ce2005-11-21 08:25:09 +000041#include "llvm/CodeGen/MachineConstantPool.h"
Michael Zolotukhin8d052a02018-04-09 00:54:47 +000042#include "llvm/CodeGen/MachineDominators.h"
David Greene659c1a92009-11-13 21:34:57 +000043#include "llvm/CodeGen/MachineFrameInfo.h"
David Greene60eb4732009-08-18 19:22:55 +000044#include "llvm/CodeGen/MachineFunction.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000045#include "llvm/CodeGen/MachineFunctionPass.h"
46#include "llvm/CodeGen/MachineInstr.h"
Jakob Stoklund Olesen1995b9f2014-01-12 19:24:08 +000047#include "llvm/CodeGen/MachineInstrBundle.h"
Nate Begeman4ca2ea52006-04-22 18:53:45 +000048#include "llvm/CodeGen/MachineJumpTableInfo.h"
David Greenef354b6e2009-08-10 16:38:07 +000049#include "llvm/CodeGen/MachineLoopInfo.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000050#include "llvm/CodeGen/MachineMemOperand.h"
Eugene Zelenko149178d2017-10-10 22:33:29 +000051#include "llvm/CodeGen/MachineModuleInfo.h"
Rafael Espindolab91455b2015-04-07 13:42:44 +000052#include "llvm/CodeGen/MachineModuleInfoImpls.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000053#include "llvm/CodeGen/MachineOperand.h"
Justin Bogner369ba752017-02-24 00:19:22 +000054#include "llvm/CodeGen/MachineOptimizationRemarkEmitter.h"
David Blaikie3f833ed2017-11-08 01:01:31 +000055#include "llvm/CodeGen/TargetFrameLowering.h"
56#include "llvm/CodeGen/TargetInstrInfo.h"
David Blaikieb3bde2e2017-11-17 01:07:10 +000057#include "llvm/CodeGen/TargetLowering.h"
David Blaikieb3bde2e2017-11-17 01:07:10 +000058#include "llvm/CodeGen/TargetOpcodes.h"
59#include "llvm/CodeGen/TargetRegisterInfo.h"
60#include "llvm/CodeGen/TargetSubtargetInfo.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000061#include "llvm/IR/BasicBlock.h"
Eugene Zelenko149178d2017-10-10 22:33:29 +000062#include "llvm/IR/Comdat.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000063#include "llvm/IR/Constant.h"
64#include "llvm/IR/Constants.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000065#include "llvm/IR/DataLayout.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000066#include "llvm/IR/DebugInfoMetadata.h"
67#include "llvm/IR/DerivedTypes.h"
68#include "llvm/IR/Function.h"
69#include "llvm/IR/GlobalAlias.h"
70#include "llvm/IR/GlobalIFunc.h"
71#include "llvm/IR/GlobalIndirectSymbol.h"
72#include "llvm/IR/GlobalObject.h"
73#include "llvm/IR/GlobalValue.h"
74#include "llvm/IR/GlobalVariable.h"
Eugene Zelenko149178d2017-10-10 22:33:29 +000075#include "llvm/IR/Instruction.h"
Rafael Espindola894843c2014-01-07 21:19:40 +000076#include "llvm/IR/Mangler.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000077#include "llvm/IR/Metadata.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000078#include "llvm/IR/Module.h"
79#include "llvm/IR/Operator.h"
Eugene Zelenko149178d2017-10-10 22:33:29 +000080#include "llvm/IR/Type.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000081#include "llvm/IR/Value.h"
Chris Lattner1e158692010-04-04 18:34:07 +000082#include "llvm/MC/MCAsmInfo.h"
Omer Paparo Bivas2251c792017-10-24 06:16:03 +000083#include "llvm/MC/MCCodePadder.h"
Chris Lattner9d0e7622009-07-27 21:28:04 +000084#include "llvm/MC/MCContext.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000085#include "llvm/MC/MCDirectives.h"
Eugene Zelenko149178d2017-10-10 22:33:29 +000086#include "llvm/MC/MCDwarf.h"
Chris Lattnerd1acffc2010-01-23 06:17:14 +000087#include "llvm/MC/MCExpr.h"
David Greenede9cd442009-07-16 22:24:20 +000088#include "llvm/MC/MCInst.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000089#include "llvm/MC/MCSection.h"
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +000090#include "llvm/MC/MCSectionELF.h"
91#include "llvm/MC/MCSectionMachO.h"
Chris Lattner4d2c0f92009-07-31 18:48:30 +000092#include "llvm/MC/MCStreamer.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000093#include "llvm/MC/MCSubtargetInfo.h"
94#include "llvm/MC/MCSymbol.h"
Eugene Zelenko149178d2017-10-10 22:33:29 +000095#include "llvm/MC/MCSymbolELF.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000096#include "llvm/MC/MCTargetOptions.h"
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +000097#include "llvm/MC/MCValue.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000098#include "llvm/MC/SectionKind.h"
99#include "llvm/Pass.h"
100#include "llvm/Support/Casting.h"
Eugene Zelenko149178d2017-10-10 22:33:29 +0000101#include "llvm/Support/CommandLine.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +0000102#include "llvm/Support/Compiler.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +0000103#include "llvm/Support/ErrorHandling.h"
104#include "llvm/Support/Format.h"
105#include "llvm/Support/MathExtras.h"
Taewook Ohf5040b92017-08-10 18:17:11 +0000106#include "llvm/Support/Path.h"
Eric Christopher78a3f6c2015-02-20 06:59:48 +0000107#include "llvm/Support/TargetRegistry.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +0000108#include "llvm/Support/Timer.h"
Chandler Carruth6bda14b2017-06-06 11:49:48 +0000109#include "llvm/Support/raw_ostream.h"
David Blaikie6054e652018-03-23 23:58:19 +0000110#include "llvm/Target/TargetLoweringObjectFile.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +0000111#include "llvm/Target/TargetMachine.h"
Eugene Zelenko149178d2017-10-10 22:33:29 +0000112#include "llvm/Target/TargetOptions.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +0000113#include <algorithm>
114#include <cassert>
115#include <cinttypes>
116#include <cstdint>
Eugene Zelenko149178d2017-10-10 22:33:29 +0000117#include <iterator>
Eugene Zelenkod96089b2017-02-14 00:33:36 +0000118#include <limits>
119#include <memory>
120#include <string>
121#include <utility>
122#include <vector>
123
Chris Lattner6a8e0f52004-08-16 23:15:22 +0000124using namespace llvm;
125
Chandler Carruth1b9dde02014-04-22 02:02:50 +0000126#define DEBUG_TYPE "asm-printer"
127
Matthias Braun9f15a792016-11-18 19:43:18 +0000128static const char *const DWARFGroupName = "dwarf";
129static const char *const DWARFGroupDescription = "DWARF Emission";
130static const char *const DbgTimerName = "emit";
131static const char *const DbgTimerDescription = "Debug Info Emission";
132static const char *const EHTimerName = "write_exception";
133static const char *const EHTimerDescription = "DWARF Exception Writer";
Adrian McCarthydb2736d2018-01-09 23:49:30 +0000134static const char *const CFGuardName = "Control Flow Guard";
135static const char *const CFGuardDescription = "Control Flow Guard Tables";
Matthias Braun9f15a792016-11-18 19:43:18 +0000136static const char *const CodeViewLineTablesGroupName = "linetables";
137static const char *const CodeViewLineTablesGroupDescription =
138 "CodeView Line Tables";
Torok Edwinf8dba242010-04-07 10:44:46 +0000139
Chris Lattner94a946c2010-01-28 01:02:27 +0000140STATISTIC(EmittedInsts, "Number of machine instrs printed");
141
Andrew V. Tischenko75745d02017-04-14 07:44:23 +0000142static cl::opt<bool>
143 PrintSchedule("print-schedule", cl::Hidden, cl::init(false),
144 cl::desc("Print 'sched: [latency:throughput]' in .s output"));
145
Devang Patel8c78a0b2007-05-03 01:11:54 +0000146char AsmPrinter::ID = 0;
Chris Lattnere468f882010-03-13 20:55:24 +0000147
Eugene Zelenko149178d2017-10-10 22:33:29 +0000148using gcp_map_type = DenseMap<GCStrategy *, std::unique_ptr<GCMetadataPrinter>>;
149
Chris Lattner2cf5f9e2010-04-04 17:57:56 +0000150static gcp_map_type &getGCMap(void *&P) {
Craig Topper353eda42014-04-24 06:44:33 +0000151 if (!P)
Chris Lattner2cf5f9e2010-04-04 17:57:56 +0000152 P = new gcp_map_type();
153 return *(gcp_map_type*)P;
154}
155
Chris Lattner08e9e722010-04-28 19:58:07 +0000156/// getGVAlignmentLog2 - Return the alignment to use for the specified global
157/// value in log2 form. This rounds up to the preferred alignment if possible
158/// and legal.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000159static unsigned getGVAlignmentLog2(const GlobalValue *GV, const DataLayout &DL,
Chris Lattner08e9e722010-04-28 19:58:07 +0000160 unsigned InBits = 0) {
161 unsigned NumBits = 0;
162 if (const GlobalVariable *GVar = dyn_cast<GlobalVariable>(GV))
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000163 NumBits = DL.getPreferredAlignmentLog(GVar);
Jim Grosbach1900c732011-03-29 23:20:22 +0000164
Chris Lattner08e9e722010-04-28 19:58:07 +0000165 // If InBits is specified, round it to it.
166 if (InBits > NumBits)
167 NumBits = InBits;
Jim Grosbach1900c732011-03-29 23:20:22 +0000168
Chris Lattner08e9e722010-04-28 19:58:07 +0000169 // If the GV has a specified alignment, take it into account.
170 if (GV->getAlignment() == 0)
171 return NumBits;
Jim Grosbach1900c732011-03-29 23:20:22 +0000172
Chris Lattner08e9e722010-04-28 19:58:07 +0000173 unsigned GVAlign = Log2_32(GV->getAlignment());
Jim Grosbach1900c732011-03-29 23:20:22 +0000174
Chris Lattner08e9e722010-04-28 19:58:07 +0000175 // If the GVAlign is larger than NumBits, or if we are required to obey
176 // NumBits because the GV has an assigned section, obey it.
177 if (GVAlign > NumBits || GV->hasSection())
178 NumBits = GVAlign;
179 return NumBits;
180}
181
David Blaikie94598322015-01-18 20:29:04 +0000182AsmPrinter::AsmPrinter(TargetMachine &tm, std::unique_ptr<MCStreamer> Streamer)
Eric Christopherd9134482014-08-04 21:25:23 +0000183 : MachineFunctionPass(ID), TM(tm), MAI(tm.getMCAsmInfo()),
Eugene Zelenkod96089b2017-02-14 00:33:36 +0000184 OutContext(Streamer->getContext()), OutStreamer(std::move(Streamer)) {
Lang Hames9ff69c82015-04-24 19:11:51 +0000185 VerboseAsm = OutStreamer->isVerboseAsm();
Evan Cheng5e5a63c2009-03-25 01:47:28 +0000186}
Chris Lattnerf0e9aef2005-12-13 06:32:10 +0000187
Gordon Henriksendbe06d32008-08-17 12:08:44 +0000188AsmPrinter::~AsmPrinter() {
Craig Toppere73658d2014-04-28 04:05:08 +0000189 assert(!DD && Handlers.empty() && "Debug/EH info didn't get finalized");
Jim Grosbach1900c732011-03-29 23:20:22 +0000190
Craig Topper353eda42014-04-24 06:44:33 +0000191 if (GCMetadataPrinters) {
Chris Lattner2cf5f9e2010-04-04 17:57:56 +0000192 gcp_map_type &GCMap = getGCMap(GCMetadataPrinters);
Jim Grosbach1900c732011-03-29 23:20:22 +0000193
Chris Lattner2cf5f9e2010-04-04 17:57:56 +0000194 delete &GCMap;
Craig Topper353eda42014-04-24 06:44:33 +0000195 GCMetadataPrinters = nullptr;
Chris Lattner2cf5f9e2010-04-04 17:57:56 +0000196 }
Gordon Henriksendbe06d32008-08-17 12:08:44 +0000197}
Chris Lattnerf0e9aef2005-12-13 06:32:10 +0000198
Rafael Espindola0db11db2016-06-27 14:19:45 +0000199bool AsmPrinter::isPositionIndependent() const {
Rafael Espindolab1556c42016-06-28 20:13:36 +0000200 return TM.isPositionIndependent();
Rafael Espindola0db11db2016-06-27 14:19:45 +0000201}
202
Chris Lattner67159522010-01-26 04:35:26 +0000203/// getFunctionNumber - Return a unique ID for the current function.
Chris Lattner67159522010-01-26 04:35:26 +0000204unsigned AsmPrinter::getFunctionNumber() const {
205 return MF->getFunctionNumber();
206}
207
Dan Gohman53d4a082010-04-17 16:44:48 +0000208const TargetLoweringObjectFile &AsmPrinter::getObjFileLowering() const {
Eric Christopher36fe0282015-02-03 07:22:52 +0000209 return *TM.getObjFileLowering();
Chris Lattner5e693ed2009-07-28 03:13:23 +0000210}
211
Micah Villmowcdfe20b2012-10-08 16:38:25 +0000212const DataLayout &AsmPrinter::getDataLayout() const {
Mehdi Amini5c0fa582015-07-16 06:04:17 +0000213 return MMI->getModule()->getDataLayout();
Chris Lattner3a383cb2010-04-05 00:13:49 +0000214}
215
Mehdi Amini26d48132015-07-24 16:04:22 +0000216// Do not use the cached DataLayout because some client use it without a Module
Jonas Devliegherea6ef1ab2018-03-18 11:38:41 +0000217// (dsymutil, llvm-dwarfdump).
Matt Arsenault41e5ac42018-03-14 00:36:23 +0000218unsigned AsmPrinter::getPointerSize() const {
219 return TM.getPointerSize(0); // FIXME: Default address space
220}
Mehdi Amini1660cab2015-07-16 05:59:25 +0000221
David Woodhousee6c13e42014-01-28 23:12:42 +0000222const MCSubtargetInfo &AsmPrinter::getSubtargetInfo() const {
Eric Christophera7249ec2015-02-20 07:16:19 +0000223 assert(MF && "getSubtargetInfo requires a valid MachineFunction!");
224 return MF->getSubtarget<MCSubtargetInfo>();
David Woodhousee6c13e42014-01-28 23:12:42 +0000225}
226
227void AsmPrinter::EmitToStreamer(MCStreamer &S, const MCInst &Inst) {
228 S.EmitInstruction(Inst, getSubtargetInfo());
229}
230
Chris Lattner0adae252009-08-18 06:15:16 +0000231/// getCurrentSection() - Return the current section we are emitting to.
232const MCSection *AsmPrinter::getCurrentSection() const {
Eric Christopher445c9522016-10-14 05:47:37 +0000233 return OutStreamer->getCurrentSectionOnly();
Chris Lattner0adae252009-08-18 06:15:16 +0000234}
235
Gordon Henriksen5180e852008-01-07 01:30:38 +0000236void AsmPrinter::getAnalysisUsage(AnalysisUsage &AU) const {
Dan Gohman04023152009-07-31 23:37:33 +0000237 AU.setPreservesAll();
Gordon Henriksen5180e852008-01-07 01:30:38 +0000238 MachineFunctionPass::getAnalysisUsage(AU);
Chris Lattnere468f882010-03-13 20:55:24 +0000239 AU.addRequired<MachineModuleInfo>();
Justin Bogner369ba752017-02-24 00:19:22 +0000240 AU.addRequired<MachineOptimizationRemarkEmitterPass>();
Gordon Henriksend930f912008-08-17 18:44:35 +0000241 AU.addRequired<GCModuleInfo>();
Gordon Henriksen5180e852008-01-07 01:30:38 +0000242}
243
Chris Lattner6a8e0f52004-08-16 23:15:22 +0000244bool AsmPrinter::doInitialization(Module &M) {
Chris Lattner0124fe32010-04-04 05:09:10 +0000245 MMI = getAnalysisIfAvailable<MachineModuleInfo>();
Chris Lattnere468f882010-03-13 20:55:24 +0000246
Chris Lattner51d5b432009-07-31 17:42:42 +0000247 // Initialize TargetLoweringObjectFile.
248 const_cast<TargetLoweringObjectFile&>(getObjFileLowering())
249 .Initialize(OutContext, TM);
Jim Grosbach1900c732011-03-29 23:20:22 +0000250
Lang Hames9ff69c82015-04-24 19:11:51 +0000251 OutStreamer->InitSections(false);
Nico Rieck316c3742013-07-04 21:37:26 +0000252
Simi Pallipurathad96d9a2018-03-06 14:35:23 +0000253 // Emit the version-min deployment target directive if needed.
Jim Grosbacheaf60362014-03-18 22:09:08 +0000254 //
255 // FIXME: If we end up with a collection of these sorts of Darwin-specific
256 // or ELF-specific things, it may make sense to have a platform helper class
257 // that will work with the target helper class. For now keep it here, as the
258 // alternative is duplicated code in each of the target asm printers that
259 // use the directive, where it would need the same conditionalization
260 // anyway.
Matthias Braun5dd72ad2017-12-14 03:59:24 +0000261 const Triple &Target = TM.getTargetTriple();
262 OutStreamer->EmitVersionForTarget(Target);
Jim Grosbacheaf60362014-03-18 22:09:08 +0000263
Bob Wilsonb633d7a2009-09-30 22:06:26 +0000264 // Allow the target to emit any magic that it wants at the start of the file.
265 EmitStartOfAsmFile(M);
Rafael Espindolacda011b2008-12-03 11:01:37 +0000266
Chris Lattner601ef332010-01-25 18:58:59 +0000267 // Very minimal debug info. It is ignored if we emit actual debug info. If we
268 // don't, this at least helps the user find where a global came from.
Chris Lattnere9a75a62009-08-22 21:43:10 +0000269 if (MAI->hasSingleParameterDotFile()) {
Chris Lattner601ef332010-01-25 18:58:59 +0000270 // .file "foo.c"
Taewook Ohf5040b92017-08-10 18:17:11 +0000271 OutStreamer->EmitFileDirective(
272 llvm::sys::path::filename(M.getSourceFileName()));
Rafael Espindolacda011b2008-12-03 11:01:37 +0000273 }
274
Bob Wilsonb633d7a2009-09-30 22:06:26 +0000275 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
276 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
Jim Grosbach6623e7f2014-04-16 22:38:02 +0000277 for (auto &I : *MI)
278 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*I))
Philip Reames1e308972014-12-11 01:47:23 +0000279 MP->beginAssembly(M, *MI, *this);
Chris Lattner8a87fb72010-04-03 21:35:55 +0000280
281 // Emit module-level inline asm if it exists.
Chris Lattnerfed39fa2010-04-03 21:13:18 +0000282 if (!M.getModuleInlineAsm().empty()) {
Akira Hatanaka322ffce2015-03-16 18:02:16 +0000283 // We're at the module level. Construct MCSubtarget from the default CPU
284 // and target triple.
285 std::unique_ptr<MCSubtargetInfo> STI(TM.getTarget().createMCSubtargetInfo(
Daniel Sanders335487a2015-06-16 13:15:50 +0000286 TM.getTargetTriple().str(), TM.getTargetCPU(),
287 TM.getTargetFeatureString()));
Lang Hames9ff69c82015-04-24 19:11:51 +0000288 OutStreamer->AddComment("Start of file scope inline assembly");
289 OutStreamer->AddBlankLine();
Akira Hatanakab11ef082015-11-14 06:35:56 +0000290 EmitInlineAsm(M.getModuleInlineAsm()+"\n",
291 OutContext.getSubtargetCopy(*STI), TM.Options.MCOptions);
Lang Hames9ff69c82015-04-24 19:11:51 +0000292 OutStreamer->AddComment("End of file scope inline assembly");
293 OutStreamer->AddBlankLine();
Chris Lattnerfed39fa2010-04-03 21:13:18 +0000294 }
Chris Lattnere3a79262006-01-23 23:47:53 +0000295
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +0000296 if (MAI->doesSupportDebugInformation()) {
Reid Kleckner12d2c122015-08-05 22:26:20 +0000297 bool EmitCodeView = MMI->getModule()->getCodeViewFlag();
Martin Storsjo966d3452018-05-08 20:56:04 +0000298 if (EmitCodeView && TM.getTargetTriple().isOSWindows()) {
Reid Kleckner70f5bc92016-01-14 19:25:04 +0000299 Handlers.push_back(HandlerInfo(new CodeViewDebug(this),
Matthias Braun9f15a792016-11-18 19:43:18 +0000300 DbgTimerName, DbgTimerDescription,
301 CodeViewLineTablesGroupName,
302 CodeViewLineTablesGroupDescription));
Timur Iskhodzhanovb6fa52f2014-12-26 17:00:51 +0000303 }
Reid Kleckner12d2c122015-08-05 22:26:20 +0000304 if (!EmitCodeView || MMI->getModule()->getDwarfVersion()) {
Timur Iskhodzhanovb6fa52f2014-12-26 17:00:51 +0000305 DD = new DwarfDebug(this, &M);
Peter Collingbourne5973bc82016-05-20 19:35:35 +0000306 DD->beginModule();
Matthias Braun9f15a792016-11-18 19:43:18 +0000307 Handlers.push_back(HandlerInfo(DD, DbgTimerName, DbgTimerDescription,
308 DWARFGroupName, DWARFGroupDescription));
Timur Iskhodzhanovb6fa52f2014-12-26 17:00:51 +0000309 }
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +0000310 }
Anton Korobeynikov61d167e2011-01-14 21:57:45 +0000311
Joerg Sonnenberger83963992017-01-05 20:55:28 +0000312 switch (MAI->getExceptionHandlingType()) {
313 case ExceptionHandling::SjLj:
314 case ExceptionHandling::DwarfCFI:
315 case ExceptionHandling::ARM:
316 isCFIMoveForDebugging = true;
317 if (MAI->getExceptionHandlingType() != ExceptionHandling::DwarfCFI)
318 break;
319 for (auto &F: M.getFunctionList()) {
320 // If the module contains any function with unwind data,
321 // .eh_frame has to be emitted.
322 // Ignore functions that won't get emitted.
323 if (!F.isDeclarationForLinker() && F.needsUnwindTableEntry()) {
324 isCFIMoveForDebugging = false;
325 break;
326 }
327 }
328 break;
329 default:
330 isCFIMoveForDebugging = false;
331 break;
332 }
333
Saleem Abdulrasool8076cab2014-06-11 01:19:03 +0000334 EHStreamer *ES = nullptr;
Rafael Espindola240c96e2011-05-05 19:48:34 +0000335 switch (MAI->getExceptionHandlingType()) {
336 case ExceptionHandling::None:
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +0000337 break;
Rafael Espindola240c96e2011-05-05 19:48:34 +0000338 case ExceptionHandling::SjLj:
Rafael Espindola240c96e2011-05-05 19:48:34 +0000339 case ExceptionHandling::DwarfCFI:
Saleem Abdulrasool8076cab2014-06-11 01:19:03 +0000340 ES = new DwarfCFIException(this);
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +0000341 break;
Rafael Espindola240c96e2011-05-05 19:48:34 +0000342 case ExceptionHandling::ARM:
Saleem Abdulrasool8076cab2014-06-11 01:19:03 +0000343 ES = new ARMException(this);
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +0000344 break;
Reid Kleckner5cc15692015-01-23 18:49:01 +0000345 case ExceptionHandling::WinEH:
Saleem Abdulrasoold1a4ed62014-09-01 23:48:39 +0000346 switch (MAI->getWinEHEncodingType()) {
347 default: llvm_unreachable("unsupported unwinding information encoding");
Reid Kleckner0738a9c2015-05-05 17:44:16 +0000348 case WinEH::EncodingType::Invalid:
349 break;
Reid Kleckner1d3d4ad2015-05-29 17:00:57 +0000350 case WinEH::EncodingType::X86:
Saleem Abdulrasoold1a4ed62014-09-01 23:48:39 +0000351 case WinEH::EncodingType::Itanium:
Reid Kleckner60b640b2015-05-28 22:47:01 +0000352 ES = new WinException(this);
Saleem Abdulrasoold1a4ed62014-09-01 23:48:39 +0000353 break;
354 }
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +0000355 break;
Heejin Ahn9386bde2018-02-24 00:40:50 +0000356 case ExceptionHandling::Wasm:
357 // TODO to prevent warning
358 break;
Rafael Espindola240c96e2011-05-05 19:48:34 +0000359 }
Saleem Abdulrasool8076cab2014-06-11 01:19:03 +0000360 if (ES)
Matthias Braun9f15a792016-11-18 19:43:18 +0000361 Handlers.push_back(HandlerInfo(ES, EHTimerName, EHTimerDescription,
362 DWARFGroupName, DWARFGroupDescription));
Adrian McCarthydb2736d2018-01-09 23:49:30 +0000363
364 if (mdconst::extract_or_null<ConstantInt>(
365 MMI->getModule()->getModuleFlag("cfguard")))
366 Handlers.push_back(HandlerInfo(new WinCFGuard(this), CFGuardName,
367 CFGuardDescription, DWARFGroupName,
368 DWARFGroupDescription));
369
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +0000370 return false;
Chris Lattner6a8e0f52004-08-16 23:15:22 +0000371}
372
Rafael Espindolaa0053422014-02-07 16:07:11 +0000373static bool canBeHidden(const GlobalValue *GV, const MCAsmInfo &MAI) {
Rafael Espindolaa0053422014-02-07 16:07:11 +0000374 if (!MAI.hasWeakDefCanBeHiddenDirective())
375 return false;
376
David Blaikie88209292018-03-21 19:23:45 +0000377 return GV->canBeOmittedFromSymbolTable();
Rafael Espindolaa0053422014-02-07 16:07:11 +0000378}
379
Rafael Espindola6f1b2852013-10-30 22:08:11 +0000380void AsmPrinter::EmitLinkage(const GlobalValue *GV, MCSymbol *GVSym) const {
381 GlobalValue::LinkageTypes Linkage = GV->getLinkage();
Rafael Espindolab0287742013-10-23 21:24:34 +0000382 switch (Linkage) {
Chris Lattnerdbf5a762010-01-26 23:47:12 +0000383 case GlobalValue::CommonLinkage:
384 case GlobalValue::LinkOnceAnyLinkage:
385 case GlobalValue::LinkOnceODRLinkage:
386 case GlobalValue::WeakAnyLinkage:
387 case GlobalValue::WeakODRLinkage:
Rafael Espindola04867ce2013-12-02 23:04:51 +0000388 if (MAI->hasWeakDefDirective()) {
Chris Lattnerdbf5a762010-01-26 23:47:12 +0000389 // .globl _foo
Lang Hames9ff69c82015-04-24 19:11:51 +0000390 OutStreamer->EmitSymbolAttribute(GVSym, MCSA_Global);
Bill Wendling578ee402010-08-20 22:05:50 +0000391
Rafael Espindolaa0053422014-02-07 16:07:11 +0000392 if (!canBeHidden(GV, *MAI))
Bill Wendling578ee402010-08-20 22:05:50 +0000393 // .weak_definition _foo
Lang Hames9ff69c82015-04-24 19:11:51 +0000394 OutStreamer->EmitSymbolAttribute(GVSym, MCSA_WeakDefinition);
Bill Wendling578ee402010-08-20 22:05:50 +0000395 else
Lang Hames9ff69c82015-04-24 19:11:51 +0000396 OutStreamer->EmitSymbolAttribute(GVSym, MCSA_WeakDefAutoPrivate);
Rafael Espindola04867ce2013-12-02 23:04:51 +0000397 } else if (MAI->hasLinkOnceDirective()) {
Chris Lattnerdbf5a762010-01-26 23:47:12 +0000398 // .globl _foo
Lang Hames9ff69c82015-04-24 19:11:51 +0000399 OutStreamer->EmitSymbolAttribute(GVSym, MCSA_Global);
Duncan Sands2576db72010-05-12 07:11:33 +0000400 //NOTE: linkonce is handled by the section the symbol was assigned to.
Chris Lattnerdbf5a762010-01-26 23:47:12 +0000401 } else {
402 // .weak _foo
Lang Hames9ff69c82015-04-24 19:11:51 +0000403 OutStreamer->EmitSymbolAttribute(GVSym, MCSA_Weak);
Chris Lattnerdbf5a762010-01-26 23:47:12 +0000404 }
Rafael Espindolab0287742013-10-23 21:24:34 +0000405 return;
Chris Lattnerdbf5a762010-01-26 23:47:12 +0000406 case GlobalValue::ExternalLinkage:
Rafael Espindolae64619c2016-05-16 21:14:24 +0000407 // If external, declare as a global symbol: .globl _foo
Lang Hames9ff69c82015-04-24 19:11:51 +0000408 OutStreamer->EmitSymbolAttribute(GVSym, MCSA_Global);
Rafael Espindolab0287742013-10-23 21:24:34 +0000409 return;
Chris Lattnerdbf5a762010-01-26 23:47:12 +0000410 case GlobalValue::PrivateLinkage:
411 case GlobalValue::InternalLinkage:
Rafael Espindolab0287742013-10-23 21:24:34 +0000412 return;
Rafael Espindolae64619c2016-05-16 21:14:24 +0000413 case GlobalValue::AppendingLinkage:
Rafael Espindolab0287742013-10-23 21:24:34 +0000414 case GlobalValue::AvailableExternallyLinkage:
Rafael Espindolab0287742013-10-23 21:24:34 +0000415 case GlobalValue::ExternalWeakLinkage:
Rafael Espindola610a4e92016-05-11 14:41:30 +0000416 llvm_unreachable("Should never emit this");
Chris Lattnerdbf5a762010-01-26 23:47:12 +0000417 }
Rafael Espindolab0287742013-10-23 21:24:34 +0000418 llvm_unreachable("Unknown linkage type!");
Chris Lattnerdbf5a762010-01-26 23:47:12 +0000419}
420
Rafael Espindoladaeafb42014-02-19 17:23:20 +0000421void AsmPrinter::getNameWithPrefix(SmallVectorImpl<char> &Name,
422 const GlobalValue *GV) const {
Eric Christopher4367c7f2016-09-16 07:33:15 +0000423 TM.getNameWithPrefix(Name, GV, getObjFileLowering().getMangler());
Rafael Espindoladaeafb42014-02-19 17:23:20 +0000424}
425
Rafael Espindola79858aa2013-10-29 17:07:16 +0000426MCSymbol *AsmPrinter::getSymbol(const GlobalValue *GV) const {
Tim Northoverb64fb452016-11-22 16:17:20 +0000427 return TM.getSymbol(GV);
Rafael Espindola79858aa2013-10-29 17:07:16 +0000428}
Chris Lattnerdbf5a762010-01-26 23:47:12 +0000429
Chris Lattner6a160512010-01-19 04:39:15 +0000430/// EmitGlobalVariable - Emit the specified global variable to the .s file.
431void AsmPrinter::EmitGlobalVariable(const GlobalVariable *GV) {
Chih-Hung Hsieh9f9e4682018-02-28 17:48:55 +0000432 bool IsEmuTLSVar = TM.useEmulatedTLS() && GV->isThreadLocal();
Chih-Hung Hsieh1e859582015-07-28 16:24:05 +0000433 assert(!(IsEmuTLSVar && GV->hasCommonLinkage()) &&
434 "No emulated TLS variables in the common section");
435
Chih-Hung Hsieh57886402016-01-13 23:56:37 +0000436 // Never emit TLS variable xyz in emulated TLS model.
437 // The initialization value is in __emutls_t.xyz instead of xyz.
438 if (IsEmuTLSVar)
439 return;
440
Rafael Espindola7dd4d6e2011-04-05 15:51:32 +0000441 if (GV->hasInitializer()) {
442 // Check to see if this is a special global used by LLVM, if so, emit it.
443 if (EmitSpecialLLVMGlobal(GV))
444 return;
Jim Grosbach1900c732011-03-29 23:20:22 +0000445
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +0000446 // Skip the emission of global equivalents. The symbol can be emitted later
447 // on by emitGlobalGOTEquivs in case it turns out to be needed.
448 if (GlobalGOTEquivs.count(getSymbol(GV)))
449 return;
450
Chih-Hung Hsieh57886402016-01-13 23:56:37 +0000451 if (isVerbose()) {
Chih-Hung Hsieh1e859582015-07-28 16:24:05 +0000452 // When printing the control variable __emutls_v.*,
453 // we don't need to print the original TLS variable name.
Lang Hames9ff69c82015-04-24 19:11:51 +0000454 GV->printAsOperand(OutStreamer->GetCommentOS(),
Rafael Espindola7dd4d6e2011-04-05 15:51:32 +0000455 /*PrintType=*/false, GV->getParent());
Lang Hames9ff69c82015-04-24 19:11:51 +0000456 OutStreamer->GetCommentOS() << '\n';
Rafael Espindola7dd4d6e2011-04-05 15:51:32 +0000457 }
Eric Christopherf3925432010-05-25 21:49:43 +0000458 }
Jim Grosbach1900c732011-03-29 23:20:22 +0000459
Rafael Espindola79858aa2013-10-29 17:07:16 +0000460 MCSymbol *GVSym = getSymbol(GV);
Chih-Hung Hsieh57886402016-01-13 23:56:37 +0000461 MCSymbol *EmittedSym = GVSym;
Chih-Hung Hsieh1e859582015-07-28 16:24:05 +0000462
Eric Christopher0b6537e2016-07-01 06:07:31 +0000463 // getOrCreateEmuTLSControlSym only creates the symbol with name and default
464 // attributes.
465 // GV's or GVSym's attributes will be used for the EmittedSym.
Chih-Hung Hsieh1e859582015-07-28 16:24:05 +0000466 EmitVisibility(EmittedSym, GV->getVisibility(), !GV->isDeclaration());
Chris Lattnerc7a062d2010-01-19 05:38:33 +0000467
Rafael Espindola7dd4d6e2011-04-05 15:51:32 +0000468 if (!GV->hasInitializer()) // External globals require no extra code.
469 return;
470
David Majnemer8e92dfe2014-12-24 22:44:29 +0000471 GVSym->redefineIfPossible();
David Majnemer2913eca2014-12-24 23:06:55 +0000472 if (GVSym->isDefined() || GVSym->isVariable())
473 report_fatal_error("symbol '" + Twine(GVSym->getName()) +
474 "' is already defined");
David Majnemer8e92dfe2014-12-24 22:44:29 +0000475
Chris Lattnerbc696442010-01-25 18:33:40 +0000476 if (MAI->hasDotTypeDotSizeDirective())
Chih-Hung Hsieh1e859582015-07-28 16:24:05 +0000477 OutStreamer->EmitSymbolAttribute(EmittedSym, MCSA_ELF_TypeObject);
Jim Grosbach1900c732011-03-29 23:20:22 +0000478
Chris Lattnerc7a062d2010-01-19 05:38:33 +0000479 SectionKind GVKind = TargetLoweringObjectFile::getKindForGlobal(GV, TM);
480
Mehdi Amini5c0fa582015-07-16 06:04:17 +0000481 const DataLayout &DL = GV->getParent()->getDataLayout();
482 uint64_t Size = DL.getTypeAllocSize(GV->getType()->getElementType());
Jim Grosbach1900c732011-03-29 23:20:22 +0000483
Chris Lattnerf740a8c2010-04-26 18:46:46 +0000484 // If the alignment is specified, we *must* obey it. Overaligning a global
485 // with a specified alignment is a prompt way to break globals emitted to
486 // sections and expected to be contiguous (e.g. ObjC metadata).
Mehdi Amini5c0fa582015-07-16 06:04:17 +0000487 unsigned AlignLog = getGVAlignmentLog2(GV, DL);
Jim Grosbach1900c732011-03-29 23:20:22 +0000488
Jim Grosbach6623e7f2014-04-16 22:38:02 +0000489 for (const HandlerInfo &HI : Handlers) {
Matthias Braun9f15a792016-11-18 19:43:18 +0000490 NamedRegionTimer T(HI.TimerName, HI.TimerDescription,
491 HI.TimerGroupName, HI.TimerGroupDescription,
492 TimePassesIsEnabled);
Jim Grosbach6623e7f2014-04-16 22:38:02 +0000493 HI.Handler->setSymbolSize(GVSym, Size);
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +0000494 }
Richard Mitton089ed892013-09-23 17:56:20 +0000495
Nirav Davef8d00d52016-06-14 15:09:30 +0000496 // Handle common symbols
497 if (GVKind.isCommon()) {
Chris Lattnerc7a062d2010-01-19 05:38:33 +0000498 if (Size == 0) Size = 1; // .comm Foo, 0 is undefined, avoid it.
Benjamin Kramer63970512011-09-01 23:04:27 +0000499 unsigned Align = 1 << AlignLog;
Nirav Davef8d00d52016-06-14 15:09:30 +0000500 if (!getObjFileLowering().getCommDirectiveSupportsAlignment())
501 Align = 0;
Jim Grosbach1900c732011-03-29 23:20:22 +0000502
Nirav Davef8d00d52016-06-14 15:09:30 +0000503 // .comm _foo, 42, 4
504 OutStreamer->EmitCommonSymbol(GVSym, Size, Align);
505 return;
506 }
Jim Grosbach1900c732011-03-29 23:20:22 +0000507
Nirav Davef8d00d52016-06-14 15:09:30 +0000508 // Determine to which section this global should be emitted.
Eric Christopher4367c7f2016-09-16 07:33:15 +0000509 MCSection *TheSection = getObjFileLowering().SectionForGlobal(GV, GVKind, TM);
Jim Grosbach1900c732011-03-29 23:20:22 +0000510
Nirav Davef8d00d52016-06-14 15:09:30 +0000511 // If we have a bss global going to a section that supports the
512 // zerofill directive, do so here.
513 if (GVKind.isBSS() && MAI->hasMachoZeroFillDirective() &&
514 TheSection->isVirtualSection()) {
515 if (Size == 0)
516 Size = 1; // zerofill of 0 bytes is undefined.
517 unsigned Align = 1 << AlignLog;
518 EmitLinkage(GV, GVSym);
519 // .zerofill __DATA, __bss, _foo, 400, 5
520 OutStreamer->EmitZerofill(TheSection, GVSym, Size, Align);
521 return;
522 }
523
524 // If this is a BSS local symbol and we are emitting in the BSS
525 // section use .lcomm/.comm directive.
526 if (GVKind.isBSSLocal() &&
527 getObjFileLowering().getBSSSection() == TheSection) {
528 if (Size == 0)
529 Size = 1; // .comm Foo, 0 is undefined, avoid it.
530 unsigned Align = 1 << AlignLog;
Jim Grosbach1900c732011-03-29 23:20:22 +0000531
Ulrich Weigande5f94052012-11-27 16:11:16 +0000532 // Use .lcomm only if it supports user-specified alignment.
533 // Otherwise, while it would still be correct to use .lcomm in some
534 // cases (e.g. when Align == 1), the external assembler might enfore
535 // some -unknown- default alignment behavior, which could cause
536 // spurious differences between external and integrated assembler.
537 // Prefer to simply fall back to .local / .comm in this case.
538 if (MAI->getLCOMMDirectiveAlignmentType() != LCOMM::NoAlignment) {
Chris Lattnercd2915e2010-01-19 06:25:51 +0000539 // .lcomm _foo, 42
Lang Hames9ff69c82015-04-24 19:11:51 +0000540 OutStreamer->EmitLocalCommonSymbol(GVSym, Size, Align);
Chris Lattnercd2915e2010-01-19 06:25:51 +0000541 return;
542 }
Chris Lattner9f06f912010-09-27 06:44:54 +0000543
Chris Lattner9f06f912010-09-27 06:44:54 +0000544 if (!getObjFileLowering().getCommDirectiveSupportsAlignment())
545 Align = 0;
Jim Grosbach1900c732011-03-29 23:20:22 +0000546
Chris Lattnercd2915e2010-01-19 06:25:51 +0000547 // .local _foo
Lang Hames9ff69c82015-04-24 19:11:51 +0000548 OutStreamer->EmitSymbolAttribute(GVSym, MCSA_Local);
Chris Lattnercd2915e2010-01-19 06:25:51 +0000549 // .comm _foo, 42, 4
Lang Hames9ff69c82015-04-24 19:11:51 +0000550 OutStreamer->EmitCommonSymbol(GVSym, Size, Align);
Chris Lattnerc7a062d2010-01-19 05:38:33 +0000551 return;
552 }
Jim Grosbach1900c732011-03-29 23:20:22 +0000553
Eric Christopher19a4b842010-05-25 21:28:50 +0000554 // Handle thread local data for mach-o which requires us to output an
555 // additional structure of data and mangle the original symbol so that we
556 // can reference it later.
Chris Lattner419d0aa2010-09-05 20:33:40 +0000557 //
558 // TODO: This should become an "emit thread local global" method on TLOF.
559 // All of this macho specific stuff should be sunk down into TLOFMachO and
560 // stuff like "TLSExtraDataSection" should no longer be part of the parent
561 // TLOF class. This will also make it more obvious that stuff like
562 // MCStreamer::EmitTBSSSymbol is macho specific and only called from macho
563 // specific code.
Chih-Hung Hsieh57886402016-01-13 23:56:37 +0000564 if (GVKind.isThreadLocal() && MAI->hasMachoTBSSDirective()) {
Eric Christopher6fdea1b2010-05-22 00:10:22 +0000565 // Emit the .tbss symbol
Jim Grosbach1900c732011-03-29 23:20:22 +0000566 MCSymbol *MangSym =
Eric Christopher4367c7f2016-09-16 07:33:15 +0000567 OutContext.getOrCreateSymbol(GVSym->getName() + Twine("$tlv$init"));
Jim Grosbach1900c732011-03-29 23:20:22 +0000568
Eric Christopher7af8baf2013-08-07 21:13:06 +0000569 if (GVKind.isThreadBSS()) {
570 TheSection = getObjFileLowering().getTLSBSSSection();
Lang Hames9ff69c82015-04-24 19:11:51 +0000571 OutStreamer->EmitTBSSSymbol(TheSection, MangSym, Size, 1 << AlignLog);
Eric Christopher7af8baf2013-08-07 21:13:06 +0000572 } else if (GVKind.isThreadData()) {
Lang Hames9ff69c82015-04-24 19:11:51 +0000573 OutStreamer->SwitchSection(TheSection);
Eric Christopher19a4b842010-05-25 21:28:50 +0000574
Jim Grosbach1900c732011-03-29 23:20:22 +0000575 EmitAlignment(AlignLog, GV);
Lang Hames9ff69c82015-04-24 19:11:51 +0000576 OutStreamer->EmitLabel(MangSym);
Jim Grosbach1900c732011-03-29 23:20:22 +0000577
Mehdi Aminibd7287e2015-07-16 06:11:10 +0000578 EmitGlobalConstant(GV->getParent()->getDataLayout(),
579 GV->getInitializer());
Eric Christopher19a4b842010-05-25 21:28:50 +0000580 }
Jim Grosbach1900c732011-03-29 23:20:22 +0000581
Lang Hames9ff69c82015-04-24 19:11:51 +0000582 OutStreamer->AddBlankLine();
Jim Grosbach1900c732011-03-29 23:20:22 +0000583
Eric Christopher6fdea1b2010-05-22 00:10:22 +0000584 // Emit the variable struct for the runtime.
Rafael Espindola0709a7b2015-05-21 19:20:38 +0000585 MCSection *TLVSect = getObjFileLowering().getTLSExtraDataSection();
Jim Grosbach1900c732011-03-29 23:20:22 +0000586
Lang Hames9ff69c82015-04-24 19:11:51 +0000587 OutStreamer->SwitchSection(TLVSect);
Eric Christopher6fdea1b2010-05-22 00:10:22 +0000588 // Emit the linkage here.
Rafael Espindola6f1b2852013-10-30 22:08:11 +0000589 EmitLinkage(GV, GVSym);
Lang Hames9ff69c82015-04-24 19:11:51 +0000590 OutStreamer->EmitLabel(GVSym);
Jim Grosbach1900c732011-03-29 23:20:22 +0000591
Eric Christopher6fdea1b2010-05-22 00:10:22 +0000592 // Three pointers in size:
593 // - __tlv_bootstrap - used to make sure support exists
594 // - spare pointer, used when mapped by the runtime
595 // - pointer to mangled symbol above with initializer
Mehdi Amini5c0fa582015-07-16 06:04:17 +0000596 unsigned PtrSize = DL.getPointerTypeSize(GV->getType());
Lang Hames9ff69c82015-04-24 19:11:51 +0000597 OutStreamer->EmitSymbolValue(GetExternalSymbolSymbol("_tlv_bootstrap"),
Eric Christopher5fdd68e2013-06-24 23:20:02 +0000598 PtrSize);
Lang Hames9ff69c82015-04-24 19:11:51 +0000599 OutStreamer->EmitIntValue(0, PtrSize);
600 OutStreamer->EmitSymbolValue(MangSym, PtrSize);
Jim Grosbach1900c732011-03-29 23:20:22 +0000601
Lang Hames9ff69c82015-04-24 19:11:51 +0000602 OutStreamer->AddBlankLine();
Eric Christopher27e7ffc2010-05-20 00:49:07 +0000603 return;
604 }
Chris Lattnerc7a062d2010-01-19 05:38:33 +0000605
Nirav Davef8d00d52016-06-14 15:09:30 +0000606 MCSymbol *EmittedInitSym = GVSym;
607
Lang Hames9ff69c82015-04-24 19:11:51 +0000608 OutStreamer->SwitchSection(TheSection);
Chris Lattnerc7a062d2010-01-19 05:38:33 +0000609
Chih-Hung Hsieh57886402016-01-13 23:56:37 +0000610 EmitLinkage(GV, EmittedInitSym);
Chris Lattnere80442a2010-04-26 18:30:45 +0000611 EmitAlignment(AlignLog, GV);
Chris Lattnerdbf5a762010-01-26 23:47:12 +0000612
Chih-Hung Hsieh1e859582015-07-28 16:24:05 +0000613 OutStreamer->EmitLabel(EmittedInitSym);
Chris Lattnerc7a062d2010-01-19 05:38:33 +0000614
Mehdi Aminibd7287e2015-07-16 06:11:10 +0000615 EmitGlobalConstant(GV->getParent()->getDataLayout(), GV->getInitializer());
Chris Lattnerc7a062d2010-01-19 05:38:33 +0000616
617 if (MAI->hasDotTypeDotSizeDirective())
Chris Lattner866a5392010-01-25 07:53:05 +0000618 // .size foo, 42
Dan Gohman734c59d2016-12-01 23:39:08 +0000619 OutStreamer->emitELFSize(EmittedInitSym,
Rafael Espindolaa8695762015-06-02 00:25:12 +0000620 MCConstantExpr::create(Size, OutContext));
Jim Grosbach1900c732011-03-29 23:20:22 +0000621
Lang Hames9ff69c82015-04-24 19:11:51 +0000622 OutStreamer->AddBlankLine();
Chris Lattner6a160512010-01-19 04:39:15 +0000623}
624
Petar Jovanovicdbb39352017-01-20 17:53:30 +0000625/// Emit the directive and value for debug thread local expression
626///
627/// \p Value - The value to emit.
628/// \p Size - The size of the integer (in bytes) to emit.
Simon Dardis2e8cdbd2017-02-08 19:03:46 +0000629void AsmPrinter::EmitDebugThreadLocal(const MCExpr *Value,
Petar Jovanovicdbb39352017-01-20 17:53:30 +0000630 unsigned Size) const {
631 OutStreamer->EmitValue(Value, Size);
632}
633
Chris Lattnerc7b91152010-01-26 23:18:44 +0000634/// EmitFunctionHeader - This method emits the header for the current
635/// function.
636void AsmPrinter::EmitFunctionHeader() {
Matthias Braunf1caa282017-12-15 22:22:58 +0000637 const Function &F = MF->getFunction();
Francis Visoiu Mistrih1c987012017-05-23 21:22:16 +0000638
639 if (isVerbose())
Reid Kleckner4a4d7262017-06-30 18:22:51 +0000640 OutStreamer->GetCommentOS()
641 << "-- Begin function "
Matthias Braunf1caa282017-12-15 22:22:58 +0000642 << GlobalValue::dropLLVMManglingEscape(F.getName()) << '\n';
Francis Visoiu Mistrih1c987012017-05-23 21:22:16 +0000643
Chris Lattnerc7b91152010-01-26 23:18:44 +0000644 // Print out constants referenced by the function
Chris Lattner2b796242010-01-28 00:19:24 +0000645 EmitConstantPool();
Jim Grosbach1900c732011-03-29 23:20:22 +0000646
Chris Lattnerc7b91152010-01-26 23:18:44 +0000647 // Print the 'header' of function.
Matthias Braunf1caa282017-12-15 22:22:58 +0000648 OutStreamer->SwitchSection(getObjFileLowering().SectionForGlobal(&F, TM));
649 EmitVisibility(CurrentFnSym, F.getVisibility());
Chris Lattnerc7b91152010-01-26 23:18:44 +0000650
Matthias Braunf1caa282017-12-15 22:22:58 +0000651 EmitLinkage(&F, CurrentFnSym);
Jingyue Wue8290f22015-03-12 01:50:30 +0000652 if (MAI->hasFunctionAlignment())
Matthias Braunf1caa282017-12-15 22:22:58 +0000653 EmitAlignment(MF->getAlignment(), &F);
Chris Lattner22fc38d2010-01-26 23:41:48 +0000654
Chris Lattnerc7b91152010-01-26 23:18:44 +0000655 if (MAI->hasDotTypeDotSizeDirective())
Lang Hames9ff69c82015-04-24 19:11:51 +0000656 OutStreamer->EmitSymbolAttribute(CurrentFnSym, MCSA_ELF_TypeFunction);
Chris Lattnerc7b91152010-01-26 23:18:44 +0000657
Chris Lattner7bde8c02010-04-04 18:52:31 +0000658 if (isVerbose()) {
Matthias Braunf1caa282017-12-15 22:22:58 +0000659 F.printAsOperand(OutStreamer->GetCommentOS(),
660 /*PrintType=*/false, F.getParent());
Lang Hames9ff69c82015-04-24 19:11:51 +0000661 OutStreamer->GetCommentOS() << '\n';
Chris Lattnerc7b91152010-01-26 23:18:44 +0000662 }
Chris Lattnerc7b91152010-01-26 23:18:44 +0000663
Peter Collingbourne51d2de72014-12-03 02:08:38 +0000664 // Emit the prefix data.
Matthias Braunf1caa282017-12-15 22:22:58 +0000665 if (F.hasPrefixData()) {
Peter Collingbourne7f6e2c92017-03-15 04:18:16 +0000666 if (MAI->hasSubsectionsViaSymbols()) {
667 // Preserving prefix data on platforms which use subsections-via-symbols
668 // is a bit tricky. Here we introduce a symbol for the prefix data
669 // and use the .alt_entry attribute to mark the function's real entry point
670 // as an alternative entry point to the prefix-data symbol.
671 MCSymbol *PrefixSym = OutContext.createLinkerPrivateTempSymbol();
672 OutStreamer->EmitLabel(PrefixSym);
673
Matthias Braunf1caa282017-12-15 22:22:58 +0000674 EmitGlobalConstant(F.getParent()->getDataLayout(), F.getPrefixData());
Peter Collingbourne7f6e2c92017-03-15 04:18:16 +0000675
676 // Emit an .alt_entry directive for the actual function symbol.
677 OutStreamer->EmitSymbolAttribute(CurrentFnSym, MCSA_AltEntry);
678 } else {
Matthias Braunf1caa282017-12-15 22:22:58 +0000679 EmitGlobalConstant(F.getParent()->getDataLayout(), F.getPrefixData());
Peter Collingbourne7f6e2c92017-03-15 04:18:16 +0000680 }
681 }
Peter Collingbourne51d2de72014-12-03 02:08:38 +0000682
Dan Gohman4a618822010-02-10 16:03:48 +0000683 // Emit the CurrentFnSym. This is a virtual function to allow targets to
Chris Lattnerbc1e6f02010-01-27 07:21:55 +0000684 // do their wild and crazy things as required.
685 EmitFunctionEntryLabel();
Jim Grosbach1900c732011-03-29 23:20:22 +0000686
Chris Lattner561334a2010-03-15 20:39:00 +0000687 // If the function had address-taken blocks that got deleted, then we have
688 // references to the dangling symbols. Emit them at the start of the function
689 // so that we don't get references to undefined symbols.
690 std::vector<MCSymbol*> DeadBlockSyms;
Matthias Braunf1caa282017-12-15 22:22:58 +0000691 MMI->takeDeletedSymbolsForFunction(&F, DeadBlockSyms);
Chris Lattner561334a2010-03-15 20:39:00 +0000692 for (unsigned i = 0, e = DeadBlockSyms.size(); i != e; ++i) {
Lang Hames9ff69c82015-04-24 19:11:51 +0000693 OutStreamer->AddComment("Address taken block that was later removed");
694 OutStreamer->EmitLabel(DeadBlockSyms[i]);
Chris Lattner561334a2010-03-15 20:39:00 +0000695 }
Jim Grosbach1900c732011-03-29 23:20:22 +0000696
Rafael Espindola092b6192015-03-05 19:47:50 +0000697 if (CurrentFnBegin) {
Rafael Espindola629cdba2015-02-27 18:18:39 +0000698 if (MAI->useAssignmentForEHBegin()) {
Jim Grosbach6f482002015-05-18 18:43:14 +0000699 MCSymbol *CurPos = OutContext.createTempSymbol();
Lang Hames9ff69c82015-04-24 19:11:51 +0000700 OutStreamer->EmitLabel(CurPos);
701 OutStreamer->EmitAssignment(CurrentFnBegin,
Jim Grosbach13760bd2015-05-30 01:25:56 +0000702 MCSymbolRefExpr::create(CurPos, OutContext));
Rafael Espindola629cdba2015-02-27 18:18:39 +0000703 } else {
Lang Hames9ff69c82015-04-24 19:11:51 +0000704 OutStreamer->EmitLabel(CurrentFnBegin);
Rafael Espindola629cdba2015-02-27 18:18:39 +0000705 }
706 }
707
Chris Lattnerc7b91152010-01-26 23:18:44 +0000708 // Emit pre-function debug and/or EH information.
Jim Grosbach6623e7f2014-04-16 22:38:02 +0000709 for (const HandlerInfo &HI : Handlers) {
Matthias Braun9f15a792016-11-18 19:43:18 +0000710 NamedRegionTimer T(HI.TimerName, HI.TimerDescription, HI.TimerGroupName,
711 HI.TimerGroupDescription, TimePassesIsEnabled);
Jim Grosbach6623e7f2014-04-16 22:38:02 +0000712 HI.Handler->beginFunction(MF);
Torok Edwinf8dba242010-04-07 10:44:46 +0000713 }
Peter Collingbournee9f45e22013-10-20 02:16:21 +0000714
Peter Collingbourne51d2de72014-12-03 02:08:38 +0000715 // Emit the prologue data.
Matthias Braunf1caa282017-12-15 22:22:58 +0000716 if (F.hasPrologueData())
717 EmitGlobalConstant(F.getParent()->getDataLayout(), F.getPrologueData());
Chris Lattnerc7b91152010-01-26 23:18:44 +0000718}
719
Chris Lattnerbc1e6f02010-01-27 07:21:55 +0000720/// EmitFunctionEntryLabel - Emit the label that is the entrypoint for the
721/// function. This can be overridden by targets as required to do custom stuff.
722void AsmPrinter::EmitFunctionEntryLabel() {
David Majnemer58cb80c2014-12-24 10:27:50 +0000723 CurrentFnSym->redefineIfPossible();
724
Chris Lattner35096e82010-05-06 00:05:37 +0000725 // The function label could have already been emitted if two symbols end up
726 // conflicting due to asm renaming. Detect this and emit an error.
David Majnemer2913eca2014-12-24 23:06:55 +0000727 if (CurrentFnSym->isVariable())
728 report_fatal_error("'" + Twine(CurrentFnSym->getName()) +
729 "' is a protected alias");
730 if (CurrentFnSym->isDefined())
731 report_fatal_error("'" + Twine(CurrentFnSym->getName()) +
732 "' label emitted multiple times to assembly file");
Chris Lattner35096e82010-05-06 00:05:37 +0000733
Lang Hames9ff69c82015-04-24 19:11:51 +0000734 return OutStreamer->EmitLabel(CurrentFnSym);
Chris Lattnerbc1e6f02010-01-27 07:21:55 +0000735}
Chris Lattnerc7b91152010-01-26 23:18:44 +0000736
Chad Rosierb759ede2012-09-07 18:16:38 +0000737/// emitComments - Pretty-print comments for instructions.
Andrew V. Tischenko22f07422017-12-15 18:13:05 +0000738/// It returns true iff the sched comment was emitted.
739/// Otherwise it returns false.
740static bool emitComments(const MachineInstr &MI, raw_ostream &CommentOS,
Andrew V. Tischenko75745d02017-04-14 07:44:23 +0000741 AsmPrinter *AP) {
Justin Bognerfdf9bf42017-10-10 23:50:49 +0000742 const MachineFunction *MF = MI.getMF();
Eric Christopher97ea7622015-02-20 06:35:21 +0000743 const TargetInstrInfo *TII = MF->getSubtarget().getInstrInfo();
Jim Grosbach1900c732011-03-29 23:20:22 +0000744
Chris Lattner74e68522010-02-10 00:47:53 +0000745 // Check for spills and reloads
746 int FI;
Jim Grosbach1900c732011-03-29 23:20:22 +0000747
Matthias Braun941a7052016-07-28 18:40:00 +0000748 const MachineFrameInfo &MFI = MF->getFrameInfo();
Andrew V. Tischenko75745d02017-04-14 07:44:23 +0000749 bool Commented = false;
Jim Grosbach1900c732011-03-29 23:20:22 +0000750
Chris Lattner74e68522010-02-10 00:47:53 +0000751 // We assume a single instruction only has a spill or reload, not
752 // both.
753 const MachineMemOperand *MMO;
Duncan P. N. Exon Smith9cfc75c2016-06-30 00:01:54 +0000754 if (TII->isLoadFromStackSlotPostFE(MI, FI)) {
Matthias Braun941a7052016-07-28 18:40:00 +0000755 if (MFI.isSpillSlotObjectIndex(FI)) {
Chris Lattner74e68522010-02-10 00:47:53 +0000756 MMO = *MI.memoperands_begin();
Andrew V. Tischenko75745d02017-04-14 07:44:23 +0000757 CommentOS << MMO->getSize() << "-byte Reload";
758 Commented = true;
Chris Lattner74e68522010-02-10 00:47:53 +0000759 }
Duncan P. N. Exon Smith9cfc75c2016-06-30 00:01:54 +0000760 } else if (TII->hasLoadFromStackSlot(MI, MMO, FI)) {
Andrew V. Tischenko75745d02017-04-14 07:44:23 +0000761 if (MFI.isSpillSlotObjectIndex(FI)) {
762 CommentOS << MMO->getSize() << "-byte Folded Reload";
763 Commented = true;
764 }
Duncan P. N. Exon Smith9cfc75c2016-06-30 00:01:54 +0000765 } else if (TII->isStoreToStackSlotPostFE(MI, FI)) {
Matthias Braun941a7052016-07-28 18:40:00 +0000766 if (MFI.isSpillSlotObjectIndex(FI)) {
Chris Lattner74e68522010-02-10 00:47:53 +0000767 MMO = *MI.memoperands_begin();
Andrew V. Tischenko75745d02017-04-14 07:44:23 +0000768 CommentOS << MMO->getSize() << "-byte Spill";
769 Commented = true;
Chris Lattner74e68522010-02-10 00:47:53 +0000770 }
Duncan P. N. Exon Smith9cfc75c2016-06-30 00:01:54 +0000771 } else if (TII->hasStoreToStackSlot(MI, MMO, FI)) {
Andrew V. Tischenko75745d02017-04-14 07:44:23 +0000772 if (MFI.isSpillSlotObjectIndex(FI)) {
773 CommentOS << MMO->getSize() << "-byte Folded Spill";
774 Commented = true;
775 }
Chris Lattner74e68522010-02-10 00:47:53 +0000776 }
Jim Grosbach1900c732011-03-29 23:20:22 +0000777
Chris Lattner74e68522010-02-10 00:47:53 +0000778 // Check for spill-induced copies
Andrew V. Tischenko75745d02017-04-14 07:44:23 +0000779 if (MI.getAsmPrinterFlag(MachineInstr::ReloadReuse)) {
780 Commented = true;
781 CommentOS << " Reload Reuse";
782 }
783
Andrew V. Tischenko22f07422017-12-15 18:13:05 +0000784 if (Commented) {
785 if (AP->EnablePrintSchedInfo) {
786 // If any comment was added above and we need sched info comment then add
787 // this new comment just after the above comment w/o "\n" between them.
788 CommentOS << " " << MF->getSubtarget().getSchedInfoStr(MI) << "\n";
789 return true;
790 }
Andrew V. Tischenko75745d02017-04-14 07:44:23 +0000791 CommentOS << "\n";
Andrew V. Tischenko22f07422017-12-15 18:13:05 +0000792 }
793 return false;
Chris Lattner74e68522010-02-10 00:47:53 +0000794}
795
Chad Rosierb759ede2012-09-07 18:16:38 +0000796/// emitImplicitDef - This method emits the specified machine instruction
Chris Lattner2b40a202010-04-04 18:58:53 +0000797/// that is an implicit def.
Justin Holewinski660597d2013-10-11 12:39:36 +0000798void AsmPrinter::emitImplicitDef(const MachineInstr *MI) const {
Chris Lattner2b40a202010-04-04 18:58:53 +0000799 unsigned RegNo = MI->getOperand(0).getReg();
Dan Gohman7aa4aba2015-11-17 16:01:28 +0000800
801 SmallString<128> Str;
802 raw_svector_ostream OS(Str);
803 OS << "implicit-def: "
Francis Visoiu Mistrih9d419d32017-11-28 12:42:37 +0000804 << printReg(RegNo, MF->getSubtarget().getRegisterInfo());
Dan Gohman7aa4aba2015-11-17 16:01:28 +0000805
806 OutStreamer->AddComment(OS.str());
Lang Hames9ff69c82015-04-24 19:11:51 +0000807 OutStreamer->AddBlankLine();
Chris Lattner2b40a202010-04-04 18:58:53 +0000808}
809
Chad Rosierb759ede2012-09-07 18:16:38 +0000810static void emitKill(const MachineInstr *MI, AsmPrinter &AP) {
Dan Gohman7aa4aba2015-11-17 16:01:28 +0000811 std::string Str;
812 raw_string_ostream OS(Str);
813 OS << "kill:";
Chris Lattner2b40a202010-04-04 18:58:53 +0000814 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
815 const MachineOperand &Op = MI->getOperand(i);
816 assert(Op.isReg() && "KILL instruction must have only register operands");
Francis Visoiu Mistriha8a83d12017-12-07 10:40:31 +0000817 OS << ' ' << (Op.isDef() ? "def " : "killed ")
818 << printReg(Op.getReg(), AP.MF->getSubtarget().getRegisterInfo());
Chris Lattner2b40a202010-04-04 18:58:53 +0000819 }
Matthias Braun07985802016-07-09 00:18:43 +0000820 AP.OutStreamer->AddComment(OS.str());
Lang Hames9ff69c82015-04-24 19:11:51 +0000821 AP.OutStreamer->AddBlankLine();
Chris Lattner2b40a202010-04-04 18:58:53 +0000822}
823
Chad Rosierb759ede2012-09-07 18:16:38 +0000824/// emitDebugValueComment - This method handles the target-independent form
Dale Johannesen5d7f0a02010-04-07 01:15:14 +0000825/// of DBG_VALUE, returning true if it was able to do so. A false return
826/// means the target will need to handle MI in EmitInstruction.
Chad Rosierb759ede2012-09-07 18:16:38 +0000827static bool emitDebugValueComment(const MachineInstr *MI, AsmPrinter &AP) {
Adrian Prantl87b7eb92014-10-01 18:55:02 +0000828 // This code handles only the 4-operand target-independent form.
829 if (MI->getNumOperands() != 4)
Dale Johannesen5d7f0a02010-04-07 01:15:14 +0000830 return false;
Chris Lattner74e68522010-02-10 00:47:53 +0000831
Benjamin Kramer43c275f2010-04-07 09:26:51 +0000832 SmallString<128> Str;
833 raw_svector_ostream OS(Str);
Rafael Espindola0b694812014-01-16 16:28:37 +0000834 OS << "DEBUG_VALUE: ";
Benjamin Kramer43c275f2010-04-07 09:26:51 +0000835
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000836 const DILocalVariable *V = MI->getDebugVariable();
837 if (auto *SP = dyn_cast<DISubprogram>(V->getScope())) {
Adrian Prantl9d2f0192017-04-26 23:59:52 +0000838 StringRef Name = SP->getName();
David Blaikie2dbebcf2013-06-15 00:33:47 +0000839 if (!Name.empty())
840 OS << Name << ":";
841 }
Duncan P. N. Exon Smith7348dda2015-04-14 02:22:36 +0000842 OS << V->getName();
Adrian Prantlb1416832014-08-01 22:11:58 +0000843 OS << " <- ";
Dale Johannesen5d7f0a02010-04-07 01:15:14 +0000844
Adrian Prantl418d1d12013-07-09 20:28:37 +0000845 // The second operand is only an offset if it's an immediate.
Adrian Prantl6825fb62017-04-18 01:21:53 +0000846 bool MemLoc = MI->getOperand(0).isReg() && MI->getOperand(1).isImm();
847 int64_t Offset = MemLoc ? MI->getOperand(1).getImm() : 0;
Adrian Prantlde1a8b42017-04-25 17:22:09 +0000848 const DIExpression *Expr = MI->getDebugExpression();
849 if (Expr->getNumElements()) {
850 OS << '[';
851 bool NeedSep = false;
852 for (auto Op : Expr->expr_ops()) {
853 if (NeedSep)
854 OS << ", ";
855 else
856 NeedSep = true;
857 OS << dwarf::OperationEncodingString(Op.getOp());
858 for (unsigned I = 0; I < Op.getNumArgs(); ++I)
859 OS << ' ' << Op.getArg(I);
Keno Fischer00cbf9a2015-12-19 02:02:44 +0000860 }
Adrian Prantlde1a8b42017-04-25 17:22:09 +0000861 OS << "] ";
Keno Fischer00cbf9a2015-12-19 02:02:44 +0000862 }
863
Dale Johannesen5d7f0a02010-04-07 01:15:14 +0000864 // Register or immediate value. Register 0 means undef.
865 if (MI->getOperand(0).isFPImm()) {
866 APFloat APF = APFloat(MI->getOperand(0).getFPImm()->getValueAPF());
867 if (MI->getOperand(0).getFPImm()->getType()->isFloatTy()) {
Benjamin Kramer43c275f2010-04-07 09:26:51 +0000868 OS << (double)APF.convertToFloat();
Dale Johannesen5d7f0a02010-04-07 01:15:14 +0000869 } else if (MI->getOperand(0).getFPImm()->getType()->isDoubleTy()) {
Benjamin Kramer43c275f2010-04-07 09:26:51 +0000870 OS << APF.convertToDouble();
Dale Johannesen5d7f0a02010-04-07 01:15:14 +0000871 } else {
872 // There is no good way to print long double. Convert a copy to
873 // double. Ah well, it's only a comment.
874 bool ignored;
Stephan Bergmann17c7f702016-12-14 11:57:17 +0000875 APF.convert(APFloat::IEEEdouble(), APFloat::rmNearestTiesToEven,
Dale Johannesen5d7f0a02010-04-07 01:15:14 +0000876 &ignored);
Benjamin Kramer43c275f2010-04-07 09:26:51 +0000877 OS << "(long double) " << APF.convertToDouble();
Dale Johannesen5d7f0a02010-04-07 01:15:14 +0000878 }
879 } else if (MI->getOperand(0).isImm()) {
Benjamin Kramer43c275f2010-04-07 09:26:51 +0000880 OS << MI->getOperand(0).getImm();
Devang Patelf071d722011-06-24 20:46:11 +0000881 } else if (MI->getOperand(0).isCImm()) {
882 MI->getOperand(0).getCImm()->getValue().print(OS, false /*isSigned*/);
Chris Lattnerb50e7952010-04-07 22:29:10 +0000883 } else {
David Blaikie0252265b2013-06-16 20:34:15 +0000884 unsigned Reg;
885 if (MI->getOperand(0).isReg()) {
886 Reg = MI->getOperand(0).getReg();
David Blaikie0252265b2013-06-16 20:34:15 +0000887 } else {
888 assert(MI->getOperand(0).isFI() && "Unknown operand type");
Eric Christophera7249ec2015-02-20 07:16:19 +0000889 const TargetFrameLowering *TFI = AP.MF->getSubtarget().getFrameLowering();
Eric Christopher5fdd68e2013-06-24 23:20:02 +0000890 Offset += TFI->getFrameIndexReference(*AP.MF,
891 MI->getOperand(0).getIndex(), Reg);
Adrian Prantlde1a8b42017-04-25 17:22:09 +0000892 MemLoc = true;
David Blaikie0252265b2013-06-16 20:34:15 +0000893 }
David Blaikiec9380db2013-06-15 15:52:58 +0000894 if (Reg == 0) {
Dale Johannesen5d7f0a02010-04-07 01:15:14 +0000895 // Suppress offset, it is not meaningful here.
Benjamin Kramer43c275f2010-04-07 09:26:51 +0000896 OS << "undef";
Dale Johannesen5d7f0a02010-04-07 01:15:14 +0000897 // NOTE: Want this comment at start of line, don't emit with AddComment.
Lang Hames9ff69c82015-04-24 19:11:51 +0000898 AP.OutStreamer->emitRawComment(OS.str());
Dale Johannesen5d7f0a02010-04-07 01:15:14 +0000899 return true;
900 }
Adrian Prantlde1a8b42017-04-25 17:22:09 +0000901 if (MemLoc)
David Blaikiec9380db2013-06-15 15:52:58 +0000902 OS << '[';
Francis Visoiu Mistrih9d419d32017-11-28 12:42:37 +0000903 OS << printReg(Reg, AP.MF->getSubtarget().getRegisterInfo());
Chris Lattnerb50e7952010-04-07 22:29:10 +0000904 }
Jim Grosbach1900c732011-03-29 23:20:22 +0000905
Adrian Prantlde1a8b42017-04-25 17:22:09 +0000906 if (MemLoc)
Adrian Prantl418d1d12013-07-09 20:28:37 +0000907 OS << '+' << Offset << ']';
908
Dale Johannesen5d7f0a02010-04-07 01:15:14 +0000909 // NOTE: Want this comment at start of line, don't emit with AddComment.
Lang Hames9ff69c82015-04-24 19:11:51 +0000910 AP.OutStreamer->emitRawComment(OS.str());
Dale Johannesen5d7f0a02010-04-07 01:15:14 +0000911 return true;
912}
Chris Lattner74e68522010-02-10 00:47:53 +0000913
Shiva Chencd070cd2018-05-09 02:41:08 +0000914/// This method handles the target-independent form of DBG_LABEL, returning
915/// true if it was able to do so. A false return means the target will need
916/// to handle MI in EmitInstruction.
917static bool emitDebugLabelComment(const MachineInstr *MI, AsmPrinter &AP) {
918 if (MI->getNumOperands() != 1)
919 return false;
920
921 SmallString<128> Str;
922 raw_svector_ostream OS(Str);
923 OS << "DEBUG_LABEL: ";
924
925 const DILabel *V = MI->getDebugLabel();
926 if (auto *SP = dyn_cast<DISubprogram>(V->getScope())) {
927 StringRef Name = SP->getName();
928 if (!Name.empty())
929 OS << Name << ":";
930 }
931 OS << V->getName();
932
933 // NOTE: Want this comment at start of line, don't emit with AddComment.
934 AP.OutStreamer->emitRawComment(OS.str());
935 return true;
936}
937
Francis Visoiu Mistrih9b97a312017-07-19 23:47:33 +0000938AsmPrinter::CFIMoveType AsmPrinter::needsCFIMoves() const {
Rafael Espindolafc9bae62011-05-25 03:44:17 +0000939 if (MAI->getExceptionHandlingType() == ExceptionHandling::DwarfCFI &&
Matthias Braunf1caa282017-12-15 22:22:58 +0000940 MF->getFunction().needsUnwindTableEntry())
Rafael Espindolafc9bae62011-05-25 03:44:17 +0000941 return CFI_M_EH;
Rafael Espindolab7a012a2011-04-29 14:14:06 +0000942
Rafael Espindolaa7160962011-05-06 14:56:22 +0000943 if (MMI->hasDebugInfo())
Rafael Espindolafdc3e6f2011-05-10 18:39:09 +0000944 return CFI_M_Debug;
Rafael Espindolab7a012a2011-04-29 14:14:06 +0000945
Rafael Espindolafdc3e6f2011-05-10 18:39:09 +0000946 return CFI_M_None;
Rafael Espindolab7a012a2011-04-29 14:14:06 +0000947}
948
Charles Davis5638b9f2011-05-28 04:21:04 +0000949bool AsmPrinter::needsSEHMoves() {
Matthias Braunf1caa282017-12-15 22:22:58 +0000950 return MAI->usesWindowsCFI() && MF->getFunction().needsUnwindTableEntry();
Charles Davis5638b9f2011-05-28 04:21:04 +0000951}
952
Rafael Espindolab1f25f12014-03-07 06:08:31 +0000953void AsmPrinter::emitCFIInstruction(const MachineInstr &MI) {
Saleem Abdulrasool67b54812014-06-29 21:43:47 +0000954 ExceptionHandling ExceptionHandlingType = MAI->getExceptionHandlingType();
Artyom Skrobovf6830f42014-02-14 17:19:07 +0000955 if (ExceptionHandlingType != ExceptionHandling::DwarfCFI &&
956 ExceptionHandlingType != ExceptionHandling::ARM)
Rafael Espindolaa01cdb02011-04-15 15:11:06 +0000957 return;
Rafael Espindolaa01cdb02011-04-15 15:11:06 +0000958
Rafael Espindolafdc3e6f2011-05-10 18:39:09 +0000959 if (needsCFIMoves() == CFI_M_None)
Rafael Espindolab7a012a2011-04-29 14:14:06 +0000960 return;
961
Adrian Prantl083e6a52017-04-24 18:45:59 +0000962 // If there is no "real" instruction following this CFI instruction, skip
963 // emitting it; it would be beyond the end of the function's FDE range.
964 auto *MBB = MI.getParent();
965 auto I = std::next(MI.getIterator());
966 while (I != MBB->end() && I->isTransient())
967 ++I;
968 if (I == MBB->instr_end() &&
969 MBB->getReverseIterator() == MBB->getParent()->rbegin())
970 return;
971
Matthias Braunf23ef432016-11-30 23:48:42 +0000972 const std::vector<MCCFIInstruction> &Instrs = MF->getFrameInstructions();
Rafael Espindolab1f25f12014-03-07 06:08:31 +0000973 unsigned CFIIndex = MI.getOperand(0).getCFIIndex();
974 const MCCFIInstruction &CFI = Instrs[CFIIndex];
975 emitCFIInstruction(CFI);
Rafael Espindolaa01cdb02011-04-15 15:11:06 +0000976}
977
Reid Klecknere9b89312015-01-13 00:48:10 +0000978void AsmPrinter::emitFrameAlloc(const MachineInstr &MI) {
979 // The operands are the MCSymbol and the frame offset of the allocation.
980 MCSymbol *FrameAllocSym = MI.getOperand(0).getMCSymbol();
981 int FrameOffset = MI.getOperand(1).getImm();
982
983 // Emit a symbol assignment.
Lang Hames9ff69c82015-04-24 19:11:51 +0000984 OutStreamer->EmitAssignment(FrameAllocSym,
Jim Grosbach13760bd2015-05-30 01:25:56 +0000985 MCConstantExpr::create(FrameOffset, OutContext));
Reid Klecknere9b89312015-01-13 00:48:10 +0000986}
987
Sean Evesona6bcd532017-11-30 13:05:14 +0000988void AsmPrinter::emitStackSizeSection(const MachineFunction &MF) {
989 if (!MF.getTarget().Options.EmitStackSizeSection)
990 return;
991
George Rimardcf59c52018-06-22 10:53:47 +0000992 MCSection *StackSizeSection =
993 getObjFileLowering().getStackSizesSection(*getCurrentSection());
Sean Evesona6bcd532017-11-30 13:05:14 +0000994 if (!StackSizeSection)
995 return;
996
997 const MachineFrameInfo &FrameInfo = MF.getFrameInfo();
998 // Don't emit functions with dynamic stack allocations.
999 if (FrameInfo.hasVarSizedObjects())
1000 return;
1001
1002 OutStreamer->PushSection();
1003 OutStreamer->SwitchSection(StackSizeSection);
1004
Rafael Espindola78fdca32018-03-26 20:40:22 +00001005 const MCSymbol *FunctionSymbol = getFunctionBegin();
Sean Evesona6bcd532017-11-30 13:05:14 +00001006 uint64_t StackSize = FrameInfo.getStackSize();
Matt Arsenault41e5ac42018-03-14 00:36:23 +00001007 OutStreamer->EmitSymbolValue(FunctionSymbol, TM.getProgramPointerSize());
Sean Evesona6bcd532017-11-30 13:05:14 +00001008 OutStreamer->EmitULEB128IntValue(StackSize);
1009
1010 OutStreamer->PopSection();
1011}
1012
Reid Klecknerc2f1bbf2017-05-31 22:18:49 +00001013static bool needFuncLabelsForEHOrDebugInfo(const MachineFunction &MF,
1014 MachineModuleInfo *MMI) {
1015 if (!MF.getLandingPads().empty() || MF.hasEHFunclets() || MMI->hasDebugInfo())
1016 return true;
1017
Reid Kleckner57ac61e2017-05-31 22:21:20 +00001018 // We might emit an EH table that uses function begin and end labels even if
1019 // we don't have any landingpads.
Matthias Braunf1caa282017-12-15 22:22:58 +00001020 if (!MF.getFunction().hasPersonalityFn())
Reid Klecknerc2f1bbf2017-05-31 22:18:49 +00001021 return false;
Reid Kleckner57ac61e2017-05-31 22:21:20 +00001022 return !isNoOpWithoutInvoke(
Matthias Braunf1caa282017-12-15 22:22:58 +00001023 classifyEHPersonality(MF.getFunction().getPersonalityFn()));
Reid Klecknerc2f1bbf2017-05-31 22:18:49 +00001024}
1025
Chris Lattner94a946c2010-01-28 01:02:27 +00001026/// EmitFunctionBody - This method emits the body and trailer for a
1027/// function.
1028void AsmPrinter::EmitFunctionBody() {
Rafael Espindola8dc4e102015-03-17 14:38:30 +00001029 EmitFunctionHeader();
1030
Chris Lattnerc968f442010-01-28 01:58:58 +00001031 // Emit target-specific gunk before the function body.
1032 EmitFunctionBodyStart();
Jim Grosbach1900c732011-03-29 23:20:22 +00001033
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001034 bool ShouldPrintDebugScopes = MMI->hasDebugInfo();
Jim Grosbach1900c732011-03-29 23:20:22 +00001035
Michael Zolotukhin8d052a02018-04-09 00:54:47 +00001036 if (isVerbose()) {
1037 // Get MachineDominatorTree or compute it on the fly if it's unavailable
1038 MDT = getAnalysisIfAvailable<MachineDominatorTree>();
1039 if (!MDT) {
1040 OwnedMDT = make_unique<MachineDominatorTree>();
1041 OwnedMDT->getBase().recalculate(*MF);
1042 MDT = OwnedMDT.get();
1043 }
1044
1045 // Get MachineLoopInfo or compute it on the fly if it's unavailable
1046 MLI = getAnalysisIfAvailable<MachineLoopInfo>();
1047 if (!MLI) {
1048 OwnedMLI = make_unique<MachineLoopInfo>();
1049 OwnedMLI->getBase().analyze(MDT->getBase());
1050 MLI = OwnedMLI.get();
1051 }
1052 }
1053
Chris Lattner94a946c2010-01-28 01:02:27 +00001054 // Print out code for the function.
1055 bool HasAnyRealCode = false;
Justin Bogner369ba752017-02-24 00:19:22 +00001056 int NumInstsInFunction = 0;
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001057 for (auto &MBB : *MF) {
Chris Lattner94a946c2010-01-28 01:02:27 +00001058 // Print a label for the basic block.
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001059 EmitBasicBlockStart(MBB);
1060 for (auto &MI : MBB) {
Chris Lattner94a946c2010-01-28 01:02:27 +00001061 // Print the assembly for the instruction.
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001062 if (!MI.isPosition() && !MI.isImplicitDef() && !MI.isKill() &&
Shiva Chen801bf7e2018-05-09 02:42:00 +00001063 !MI.isDebugInstr()) {
Chris Lattner94a946c2010-01-28 01:02:27 +00001064 HasAnyRealCode = true;
Justin Bogner369ba752017-02-24 00:19:22 +00001065 ++NumInstsInFunction;
Evan Chengeb828b62010-04-27 19:38:45 +00001066 }
1067
Torok Edwinf8dba242010-04-07 10:44:46 +00001068 if (ShouldPrintDebugScopes) {
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001069 for (const HandlerInfo &HI : Handlers) {
Matthias Braun9f15a792016-11-18 19:43:18 +00001070 NamedRegionTimer T(HI.TimerName, HI.TimerDescription,
1071 HI.TimerGroupName, HI.TimerGroupDescription,
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001072 TimePassesIsEnabled);
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001073 HI.Handler->beginInstruction(&MI);
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001074 }
Torok Edwinf8dba242010-04-07 10:44:46 +00001075 }
Jim Grosbach1900c732011-03-29 23:20:22 +00001076
Andrew V. Tischenko22f07422017-12-15 18:13:05 +00001077 if (isVerbose() && emitComments(MI, OutStreamer->GetCommentOS(), this)) {
1078 MachineInstr *MIP = const_cast<MachineInstr *>(&MI);
1079 MIP->setAsmPrinterFlag(MachineInstr::NoSchedComment);
1080 }
Chris Lattner74e68522010-02-10 00:47:53 +00001081
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001082 switch (MI.getOpcode()) {
Rafael Espindolab1f25f12014-03-07 06:08:31 +00001083 case TargetOpcode::CFI_INSTRUCTION:
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001084 emitCFIInstruction(MI);
Rafael Espindolaa01cdb02011-04-15 15:11:06 +00001085 break;
Reid Kleckner60381792015-07-07 22:25:32 +00001086 case TargetOpcode::LOCAL_ESCAPE:
Reid Klecknere9b89312015-01-13 00:48:10 +00001087 emitFrameAlloc(MI);
1088 break;
Chris Lattnerb06015a2010-02-09 19:54:29 +00001089 case TargetOpcode::EH_LABEL:
1090 case TargetOpcode::GC_LABEL:
Lang Hames9ff69c82015-04-24 19:11:51 +00001091 OutStreamer->EmitLabel(MI.getOperand(0).getMCSymbol());
Chris Lattner41ad1902010-02-03 01:00:52 +00001092 break;
Chris Lattnerb06015a2010-02-09 19:54:29 +00001093 case TargetOpcode::INLINEASM:
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001094 EmitInlineAsm(&MI);
Chris Lattner41ad1902010-02-03 01:00:52 +00001095 break;
Dale Johannesen5d7f0a02010-04-07 01:15:14 +00001096 case TargetOpcode::DBG_VALUE:
1097 if (isVerbose()) {
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001098 if (!emitDebugValueComment(&MI, *this))
1099 EmitInstruction(&MI);
Dale Johannesen5d7f0a02010-04-07 01:15:14 +00001100 }
1101 break;
Shiva Chencd070cd2018-05-09 02:41:08 +00001102 case TargetOpcode::DBG_LABEL:
1103 if (isVerbose()) {
1104 if (!emitDebugLabelComment(&MI, *this))
1105 EmitInstruction(&MI);
1106 }
1107 break;
Chris Lattnerb06015a2010-02-09 19:54:29 +00001108 case TargetOpcode::IMPLICIT_DEF:
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001109 if (isVerbose()) emitImplicitDef(&MI);
Chris Lattner41ad1902010-02-03 01:00:52 +00001110 break;
Chris Lattnerb06015a2010-02-09 19:54:29 +00001111 case TargetOpcode::KILL:
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001112 if (isVerbose()) emitKill(&MI, *this);
Chris Lattner41ad1902010-02-03 01:00:52 +00001113 break;
1114 default:
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001115 EmitInstruction(&MI);
Chris Lattner41ad1902010-02-03 01:00:52 +00001116 break;
1117 }
Jim Grosbach1900c732011-03-29 23:20:22 +00001118
Torok Edwinf8dba242010-04-07 10:44:46 +00001119 if (ShouldPrintDebugScopes) {
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001120 for (const HandlerInfo &HI : Handlers) {
Matthias Braun9f15a792016-11-18 19:43:18 +00001121 NamedRegionTimer T(HI.TimerName, HI.TimerDescription,
1122 HI.TimerGroupName, HI.TimerGroupDescription,
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001123 TimePassesIsEnabled);
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001124 HI.Handler->endInstruction();
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001125 }
Torok Edwinf8dba242010-04-07 10:44:46 +00001126 }
Chris Lattner94a946c2010-01-28 01:02:27 +00001127 }
Lang Hamesf49bc3f2014-07-24 20:40:55 +00001128
1129 EmitBasicBlockEnd(MBB);
Chris Lattner94a946c2010-01-28 01:02:27 +00001130 }
Bill Wendlingbf8370f2010-07-16 22:51:10 +00001131
Justin Bogner369ba752017-02-24 00:19:22 +00001132 EmittedInsts += NumInstsInFunction;
1133 MachineOptimizationRemarkAnalysis R(DEBUG_TYPE, "InstructionCount",
Matthias Braunf1caa282017-12-15 22:22:58 +00001134 MF->getFunction().getSubprogram(),
Justin Bogner369ba752017-02-24 00:19:22 +00001135 &MF->front());
1136 R << ore::NV("NumInstructions", NumInstsInFunction)
1137 << " instructions in function";
1138 ORE->emit(R);
1139
Chris Lattner94a946c2010-01-28 01:02:27 +00001140 // If the function is empty and the object file uses .subsections_via_symbols,
Chris Lattner73de5fb2010-01-28 01:28:58 +00001141 // then we need to emit *something* to the function body to prevent the
Chris Lattner6a5e7062010-04-26 23:37:21 +00001142 // labels from collapsing together. Just emit a noop.
Hans Wennborg9b9a5352017-04-21 21:48:41 +00001143 // Similarly, don't emit empty functions on Windows either. It can lead to
1144 // duplicate entries (two functions with the same RVA) in the Guard CF Table
1145 // after linking, causing the kernel not to load the binary:
1146 // https://developercommunity.visualstudio.com/content/problem/45366/vc-linker-creates-invalid-dll-with-clang-cl.html
1147 // FIXME: Hide this behind some API in e.g. MCAsmInfo or MCTargetStreamer.
1148 const Triple &TT = TM.getTargetTriple();
1149 if (!HasAnyRealCode && (MAI->hasSubsectionsViaSymbols() ||
1150 (TT.isOSWindows() && TT.isOSBinFormatCOFF()))) {
Chris Lattner6a5e7062010-04-26 23:37:21 +00001151 MCInst Noop;
Hans Wennborg9b9a5352017-04-21 21:48:41 +00001152 MF->getSubtarget().getInstrInfo()->getNoop(Noop);
Daniel Sanders11e78c22017-04-25 14:27:27 +00001153
1154 // Targets can opt-out of emitting the noop here by leaving the opcode
1155 // unspecified.
1156 if (Noop.getOpcode()) {
1157 OutStreamer->AddComment("avoids zero-length function");
1158 OutStreamer->EmitInstruction(Noop, getSubtargetInfo());
1159 }
Chris Lattner6a5e7062010-04-26 23:37:21 +00001160 }
Jim Grosbach1900c732011-03-29 23:20:22 +00001161
Matthias Braunf1caa282017-12-15 22:22:58 +00001162 const Function &F = MF->getFunction();
1163 for (const auto &BB : F) {
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001164 if (!BB.hasAddressTaken())
Rafael Espindolaf11e7f12011-11-15 19:08:46 +00001165 continue;
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001166 MCSymbol *Sym = GetBlockAddressSymbol(&BB);
Rafael Espindolaf11e7f12011-11-15 19:08:46 +00001167 if (Sym->isDefined())
1168 continue;
Lang Hames9ff69c82015-04-24 19:11:51 +00001169 OutStreamer->AddComment("Address of block that was removed by CodeGen");
1170 OutStreamer->EmitLabel(Sym);
Rafael Espindolaf11e7f12011-11-15 19:08:46 +00001171 }
1172
Chris Lattnerc968f442010-01-28 01:58:58 +00001173 // Emit target-specific gunk after the function body.
1174 EmitFunctionBodyEnd();
Jim Grosbach1900c732011-03-29 23:20:22 +00001175
Reid Klecknerc2f1bbf2017-05-31 22:18:49 +00001176 if (needFuncLabelsForEHOrDebugInfo(*MF, MMI) ||
1177 MAI->hasDotTypeDotSizeDirective()) {
Rafael Espindola629cdba2015-02-27 18:18:39 +00001178 // Create a symbol for the end of function.
Rafael Espindola9ab09232015-03-17 20:07:06 +00001179 CurrentFnEnd = createTempSymbol("func_end");
Lang Hames9ff69c82015-04-24 19:11:51 +00001180 OutStreamer->EmitLabel(CurrentFnEnd);
Rafael Espindola629cdba2015-02-27 18:18:39 +00001181 }
1182
Chris Lattnerc6d67d42010-04-03 22:19:41 +00001183 // If the target wants a .size directive for the size of the function, emit
1184 // it.
1185 if (MAI->hasDotTypeDotSizeDirective()) {
Rafael Espindola310e4b52015-03-04 01:35:23 +00001186 // We can get the size as difference between the function label and the
1187 // temp label.
NAKAMURA Takumibf6ad022015-06-14 00:23:33 +00001188 const MCExpr *SizeExp = MCBinaryExpr::createSub(
1189 MCSymbolRefExpr::create(CurrentFnEnd, OutContext),
1190 MCSymbolRefExpr::create(CurrentFnSymForSize, OutContext), OutContext);
Dan Gohman734c59d2016-12-01 23:39:08 +00001191 OutStreamer->emitELFSize(CurrentFnSym, SizeExp);
Chris Lattnerc6d67d42010-04-03 22:19:41 +00001192 }
Jim Grosbach1900c732011-03-29 23:20:22 +00001193
Rafael Espindolaa6001792015-03-09 18:29:12 +00001194 for (const HandlerInfo &HI : Handlers) {
Matthias Braun9f15a792016-11-18 19:43:18 +00001195 NamedRegionTimer T(HI.TimerName, HI.TimerDescription, HI.TimerGroupName,
1196 HI.TimerGroupDescription, TimePassesIsEnabled);
Rafael Espindolaa6001792015-03-09 18:29:12 +00001197 HI.Handler->markFunctionEnd();
1198 }
1199
1200 // Print out jump tables referenced by the function.
1201 EmitJumpTableInfo();
1202
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001203 // Emit post-function debug and/or EH information.
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001204 for (const HandlerInfo &HI : Handlers) {
Matthias Braun9f15a792016-11-18 19:43:18 +00001205 NamedRegionTimer T(HI.TimerName, HI.TimerDescription, HI.TimerGroupName,
1206 HI.TimerGroupDescription, TimePassesIsEnabled);
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001207 HI.Handler->endFunction(MF);
Torok Edwinf8dba242010-04-07 10:44:46 +00001208 }
Jim Grosbach1900c732011-03-29 23:20:22 +00001209
Sean Evesona6bcd532017-11-30 13:05:14 +00001210 // Emit section containing stack size metadata.
1211 emitStackSizeSection(*MF);
1212
Francis Visoiu Mistrih1c987012017-05-23 21:22:16 +00001213 if (isVerbose())
1214 OutStreamer->GetCommentOS() << "-- End function\n";
1215
Lang Hames9ff69c82015-04-24 19:11:51 +00001216 OutStreamer->AddBlankLine();
Chris Lattner94a946c2010-01-28 01:02:27 +00001217}
1218
Adrian Prantl5f8f34e42018-05-01 15:54:18 +00001219/// Compute the number of Global Variables that uses a Constant.
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00001220static unsigned getNumGlobalVariableUses(const Constant *C) {
1221 if (!C)
1222 return 0;
1223
1224 if (isa<GlobalVariable>(C))
1225 return 1;
1226
1227 unsigned NumUses = 0;
1228 for (auto *CU : C->users())
1229 NumUses += getNumGlobalVariableUses(dyn_cast<Constant>(CU));
1230
1231 return NumUses;
1232}
1233
Adrian Prantl5f8f34e42018-05-01 15:54:18 +00001234/// Only consider global GOT equivalents if at least one user is a
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00001235/// cstexpr inside an initializer of another global variables. Also, don't
1236/// handle cstexpr inside instructions. During global variable emission,
1237/// candidates are skipped and are emitted later in case at least one cstexpr
1238/// isn't replaced by a PC relative GOT entry access.
1239static bool isGOTEquivalentCandidate(const GlobalVariable *GV,
1240 unsigned &NumGOTEquivUsers) {
1241 // Global GOT equivalents are unnamed private globals with a constant
1242 // pointer initializer to another global symbol. They must point to a
1243 // GlobalVariable or Function, i.e., as GlobalValue.
Eric Christopher0b6537e2016-07-01 06:07:31 +00001244 if (!GV->hasGlobalUnnamedAddr() || !GV->hasInitializer() ||
1245 !GV->isConstant() || !GV->isDiscardableIfUnused() ||
1246 !dyn_cast<GlobalValue>(GV->getOperand(0)))
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00001247 return false;
1248
1249 // To be a got equivalent, at least one of its users need to be a constant
1250 // expression used by another global variable.
1251 for (auto *U : GV->users())
Ahmed Bougacha821880a2015-03-27 01:40:54 +00001252 NumGOTEquivUsers += getNumGlobalVariableUses(dyn_cast<Constant>(U));
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00001253
1254 return NumGOTEquivUsers > 0;
1255}
1256
Adrian Prantl5f8f34e42018-05-01 15:54:18 +00001257/// Unnamed constant global variables solely contaning a pointer to
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00001258/// another globals variable is equivalent to a GOT table entry; it contains the
1259/// the address of another symbol. Optimize it and replace accesses to these
1260/// "GOT equivalents" by using the GOT entry for the final global instead.
1261/// Compute GOT equivalent candidates among all global variables to avoid
1262/// emitting them if possible later on, after it use is replaced by a GOT entry
1263/// access.
1264void AsmPrinter::computeGlobalGOTEquivs(Module &M) {
1265 if (!getObjFileLowering().supportIndirectSymViaGOTPCRel())
1266 return;
1267
1268 for (const auto &G : M.globals()) {
1269 unsigned NumGOTEquivUsers = 0;
1270 if (!isGOTEquivalentCandidate(&G, NumGOTEquivUsers))
1271 continue;
1272
1273 const MCSymbol *GOTEquivSym = getSymbol(&G);
1274 GlobalGOTEquivs[GOTEquivSym] = std::make_pair(&G, NumGOTEquivUsers);
1275 }
1276}
1277
Adrian Prantl5f8f34e42018-05-01 15:54:18 +00001278/// Constant expressions using GOT equivalent globals may not be eligible
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00001279/// for PC relative GOT entry conversion, in such cases we need to emit such
1280/// globals we previously omitted in EmitGlobalVariable.
1281void AsmPrinter::emitGlobalGOTEquivs() {
1282 if (!getObjFileLowering().supportIndirectSymViaGOTPCRel())
1283 return;
1284
Bruno Cardoso Lopesb3a58b42015-03-10 20:05:23 +00001285 SmallVector<const GlobalVariable *, 8> FailedCandidates;
1286 for (auto &I : GlobalGOTEquivs) {
1287 const GlobalVariable *GV = I.second.first;
1288 unsigned Cnt = I.second.second;
1289 if (Cnt)
1290 FailedCandidates.push_back(GV);
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00001291 }
Bruno Cardoso Lopesb3a58b42015-03-10 20:05:23 +00001292 GlobalGOTEquivs.clear();
1293
1294 for (auto *GV : FailedCandidates)
1295 EmitGlobalVariable(GV);
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00001296}
1297
Dmitry Polukhina3d5b0b2016-04-05 08:47:51 +00001298void AsmPrinter::emitGlobalIndirectSymbol(Module &M,
1299 const GlobalIndirectSymbol& GIS) {
1300 MCSymbol *Name = getSymbol(&GIS);
1301
1302 if (GIS.hasExternalLinkage() || !MAI->getWeakRefDirective())
1303 OutStreamer->EmitSymbolAttribute(Name, MCSA_Global);
1304 else if (GIS.hasWeakLinkage() || GIS.hasLinkOnceLinkage())
1305 OutStreamer->EmitSymbolAttribute(Name, MCSA_WeakReference);
1306 else
Dmitry Polukhina1feff72016-04-07 12:32:19 +00001307 assert(GIS.hasLocalLinkage() && "Invalid alias or ifunc linkage");
Dmitry Polukhina3d5b0b2016-04-05 08:47:51 +00001308
1309 // Set the symbol type to function if the alias has a function type.
1310 // This affects codegen when the aliasee is not a function.
Dmitry Polukhina1feff72016-04-07 12:32:19 +00001311 if (GIS.getType()->getPointerElementType()->isFunctionTy()) {
Dmitry Polukhina3d5b0b2016-04-05 08:47:51 +00001312 OutStreamer->EmitSymbolAttribute(Name, MCSA_ELF_TypeFunction);
Dmitry Polukhina1feff72016-04-07 12:32:19 +00001313 if (isa<GlobalIFunc>(GIS))
1314 OutStreamer->EmitSymbolAttribute(Name, MCSA_ELF_TypeIndFunction);
1315 }
Dmitry Polukhina3d5b0b2016-04-05 08:47:51 +00001316
1317 EmitVisibility(Name, GIS.getVisibility());
1318
1319 const MCExpr *Expr = lowerConstant(GIS.getIndirectSymbol());
1320
1321 if (isa<GlobalAlias>(&GIS) && MAI->hasAltEntry() && isa<MCBinaryExpr>(Expr))
1322 OutStreamer->EmitSymbolAttribute(Name, MCSA_AltEntry);
1323
1324 // Emit the directives as assignments aka .set:
1325 OutStreamer->EmitAssignment(Name, Expr);
1326
1327 if (auto *GA = dyn_cast<GlobalAlias>(&GIS)) {
1328 // If the aliasee does not correspond to a symbol in the output, i.e. the
1329 // alias is not of an object or the aliased object is private, then set the
1330 // size of the alias symbol from the type of the alias. We don't do this in
1331 // other situations as the alias and aliasee having differing types but same
1332 // size may be intentional.
1333 const GlobalObject *BaseObject = GA->getBaseObject();
1334 if (MAI->hasDotTypeDotSizeDirective() && GA->getValueType()->isSized() &&
1335 (!BaseObject || BaseObject->hasPrivateLinkage())) {
1336 const DataLayout &DL = M.getDataLayout();
1337 uint64_t Size = DL.getTypeAllocSize(GA->getValueType());
Dan Gohman734c59d2016-12-01 23:39:08 +00001338 OutStreamer->emitELFSize(Name, MCConstantExpr::create(Size, OutContext));
Dmitry Polukhina3d5b0b2016-04-05 08:47:51 +00001339 }
1340 }
1341}
1342
Chris Lattner6a8e0f52004-08-16 23:15:22 +00001343bool AsmPrinter::doFinalization(Module &M) {
Eric Christopherd43c5c72015-03-20 16:03:39 +00001344 // Set the MachineFunction to nullptr so that we can catch attempted
1345 // accesses to MF specific features at the module level and so that
1346 // we can conditionalize accesses based on whether or not it is nullptr.
1347 MF = nullptr;
1348
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00001349 // Gather all GOT equivalent globals in the module. We really need two
1350 // passes over the globals: one to compute and another to avoid its emission
1351 // in EmitGlobalVariable, otherwise we would not be able to handle cases
1352 // where the got equivalent shows up before its use.
1353 computeGlobalGOTEquivs(M);
1354
Chris Lattner100865e2009-07-21 18:38:57 +00001355 // Emit global variables.
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001356 for (const auto &G : M.globals())
1357 EmitGlobalVariable(&G);
Rafael Espindola6c17d542011-01-28 03:20:10 +00001358
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00001359 // Emit remaining GOT equivalent globals.
1360 emitGlobalGOTEquivs();
1361
Rafael Espindola6c17d542011-01-28 03:20:10 +00001362 // Emit visibility info for declarations
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001363 for (const Function &F : M) {
Rafael Espindola7068cbb2015-07-13 13:55:18 +00001364 if (!F.isDeclarationForLinker())
Rafael Espindola6c17d542011-01-28 03:20:10 +00001365 continue;
1366 GlobalValue::VisibilityTypes V = F.getVisibility();
1367 if (V == GlobalValue::DefaultVisibility)
1368 continue;
1369
Rafael Espindola79858aa2013-10-29 17:07:16 +00001370 MCSymbol *Name = getSymbol(&F);
Stuart Hastingsbf836592011-02-23 02:27:05 +00001371 EmitVisibility(Name, V, false);
Rafael Espindola6c17d542011-01-28 03:20:10 +00001372 }
1373
Rafael Espindolab91455b2015-04-07 13:42:44 +00001374 const TargetLoweringObjectFile &TLOF = getObjFileLowering();
1375
Eric Christopheraadbabc2018-04-20 19:07:57 +00001376 TLOF.emitModuleMetadata(*OutStreamer, M);
Rafael Espindolab91455b2015-04-07 13:42:44 +00001377
Daniel Sanders335487a2015-06-16 13:15:50 +00001378 if (TM.getTargetTriple().isOSBinFormatELF()) {
Rafael Espindolab91455b2015-04-07 13:42:44 +00001379 MachineModuleInfoELF &MMIELF = MMI->getObjFileInfo<MachineModuleInfoELF>();
1380
1381 // Output stubs for external and common global variables.
1382 MachineModuleInfoELF::SymbolListTy Stubs = MMIELF.GetGVStubList();
1383 if (!Stubs.empty()) {
Rafael Espindola449711c2015-11-18 06:02:15 +00001384 OutStreamer->SwitchSection(TLOF.getDataSection());
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001385 const DataLayout &DL = M.getDataLayout();
Rafael Espindolab91455b2015-04-07 13:42:44 +00001386
Rafael Espindola8c587502018-04-02 23:20:30 +00001387 EmitAlignment(Log2_32(DL.getPointerSize()));
Rafael Espindolab91455b2015-04-07 13:42:44 +00001388 for (const auto &Stub : Stubs) {
Lang Hames9ff69c82015-04-24 19:11:51 +00001389 OutStreamer->EmitLabel(Stub.first);
1390 OutStreamer->EmitSymbolValue(Stub.second.getPointer(),
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001391 DL.getPointerSize());
Rafael Espindolab91455b2015-04-07 13:42:44 +00001392 }
1393 }
1394 }
Bill Wendling06df7722012-02-14 21:28:13 +00001395
Chris Lattnerf0d6bd32010-04-05 05:11:15 +00001396 // Finalize debug and EH information.
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001397 for (const HandlerInfo &HI : Handlers) {
Matthias Braun9f15a792016-11-18 19:43:18 +00001398 NamedRegionTimer T(HI.TimerName, HI.TimerDescription, HI.TimerGroupName,
1399 HI.TimerGroupDescription, TimePassesIsEnabled);
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001400 HI.Handler->endModule();
1401 delete HI.Handler;
Chris Lattnerf0d6bd32010-04-05 05:11:15 +00001402 }
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001403 Handlers.clear();
Craig Topper353eda42014-04-24 06:44:33 +00001404 DD = nullptr;
Jim Grosbach1900c732011-03-29 23:20:22 +00001405
Chris Lattner2981dc12009-06-24 18:52:01 +00001406 // If the target wants to know about weak references, print them all.
Chris Lattnere9a75a62009-08-22 21:43:10 +00001407 if (MAI->getWeakRefDirective()) {
Chris Lattner2981dc12009-06-24 18:52:01 +00001408 // FIXME: This is not lazy, it would be nice to only print weak references
1409 // to stuff that is actually used. Note that doing so would require targets
1410 // to notice uses in operands (due to constant exprs etc). This should
1411 // happen with the MC stuff eventually.
Rafael Espindolad7998d02006-12-18 03:37:18 +00001412
Peter Collingbourne6d88fde2016-06-22 20:29:42 +00001413 // Print out module-level global objects here.
1414 for (const auto &GO : M.global_objects()) {
1415 if (!GO.hasExternalWeakLinkage())
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001416 continue;
Peter Collingbourne6d88fde2016-06-22 20:29:42 +00001417 OutStreamer->EmitSymbolAttribute(getSymbol(&GO), MCSA_WeakReference);
Chris Lattner2981dc12009-06-24 18:52:01 +00001418 }
Rafael Espindolad7998d02006-12-18 03:37:18 +00001419 }
1420
Lang Hames9ff69c82015-04-24 19:11:51 +00001421 OutStreamer->AddBlankLine();
Anton Korobeynikova07765b2007-09-06 17:21:48 +00001422
Tim Shen800ed432016-03-31 22:08:19 +00001423 // Print aliases in topological order, that is, for each alias a = b,
1424 // b must be printed before a.
1425 // This is because on some targets (e.g. PowerPC) linker expects aliases in
1426 // such an order to generate correct TOC information.
1427 SmallVector<const GlobalAlias *, 16> AliasStack;
1428 SmallPtrSet<const GlobalAlias *, 16> AliasVisited;
1429 for (const auto &Alias : M.aliases()) {
1430 for (const GlobalAlias *Cur = &Alias; Cur;
1431 Cur = dyn_cast<GlobalAlias>(Cur->getAliasee())) {
1432 if (!AliasVisited.insert(Cur).second)
1433 break;
1434 AliasStack.push_back(Cur);
1435 }
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001436 for (const GlobalAlias *AncestorAlias : llvm::reverse(AliasStack))
Dmitry Polukhina3d5b0b2016-04-05 08:47:51 +00001437 emitGlobalIndirectSymbol(M, *AncestorAlias);
Tim Shen800ed432016-03-31 22:08:19 +00001438 AliasStack.clear();
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001439 }
Dmitry Polukhina1feff72016-04-07 12:32:19 +00001440 for (const auto &IFunc : M.ifuncs())
1441 emitGlobalIndirectSymbol(M, IFunc);
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001442
Duncan Sands5a913d62009-01-28 13:14:17 +00001443 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
Gordon Henriksend930f912008-08-17 18:44:35 +00001444 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
1445 for (GCModuleInfo::iterator I = MI->end(), E = MI->begin(); I != E; )
David Blaikie88368ba2014-04-15 05:34:49 +00001446 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(**--I))
Philip Reames1e308972014-12-11 01:47:23 +00001447 MP->finishAssembly(M, *MI, *this);
Gordon Henriksen5180e852008-01-07 01:30:38 +00001448
Rafael Espindola0018a592013-10-16 01:49:05 +00001449 // Emit llvm.ident metadata in an '.ident' directive.
1450 EmitModuleIdents(M);
1451
Peter Collingbourne7ef497b2014-12-30 20:05:19 +00001452 // Emit __morestack address if needed for indirect calls.
1453 if (MMI->usesMorestackAddr()) {
David Majnemera3ea4072016-02-21 01:30:30 +00001454 unsigned Align = 1;
Mehdi Amini5c0fa582015-07-16 06:04:17 +00001455 MCSection *ReadOnlySection = getObjFileLowering().getSectionForConstant(
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001456 getDataLayout(), SectionKind::getReadOnly(),
David Majnemera3ea4072016-02-21 01:30:30 +00001457 /*C=*/nullptr, Align);
Lang Hames9ff69c82015-04-24 19:11:51 +00001458 OutStreamer->SwitchSection(ReadOnlySection);
Peter Collingbourne7ef497b2014-12-30 20:05:19 +00001459
1460 MCSymbol *AddrSymbol =
Jim Grosbach6f482002015-05-18 18:43:14 +00001461 OutContext.getOrCreateSymbol(StringRef("__morestack_addr"));
Lang Hames9ff69c82015-04-24 19:11:51 +00001462 OutStreamer->EmitLabel(AddrSymbol);
Peter Collingbourne7ef497b2014-12-30 20:05:19 +00001463
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +00001464 unsigned PtrSize = MAI->getCodePointerSize();
Lang Hames9ff69c82015-04-24 19:11:51 +00001465 OutStreamer->EmitSymbolValue(GetExternalSymbolSymbol("__morestack"),
1466 PtrSize);
Peter Collingbourne7ef497b2014-12-30 20:05:19 +00001467 }
1468
Than McIntoshdee2cf62017-09-27 19:34:00 +00001469 // Emit .note.GNU-split-stack and .note.GNU-no-split-stack sections if
1470 // split-stack is used.
1471 if (TM.getTargetTriple().isOSBinFormatELF() && MMI->hasSplitStack()) {
1472 OutStreamer->SwitchSection(
1473 OutContext.getELFSection(".note.GNU-split-stack", ELF::SHT_PROGBITS, 0));
1474 if (MMI->hasNosplitStack())
1475 OutStreamer->SwitchSection(
1476 OutContext.getELFSection(".note.GNU-no-split-stack", ELF::SHT_PROGBITS, 0));
1477 }
1478
Dan Gohmanbcde1722008-05-05 00:28:39 +00001479 // If we don't have any trampolines, then we don't require stack memory
1480 // to be executable. Some targets have a directive to declare this.
Chris Lattner2981dc12009-06-24 18:52:01 +00001481 Function *InitTrampolineIntrinsic = M.getFunction("llvm.init.trampoline");
Dan Gohmanbcde1722008-05-05 00:28:39 +00001482 if (!InitTrampolineIntrinsic || InitTrampolineIntrinsic->use_empty())
Rafael Espindola0709a7b2015-05-21 19:20:38 +00001483 if (MCSection *S = MAI->getNonexecutableStackSection(OutContext))
Lang Hames9ff69c82015-04-24 19:11:51 +00001484 OutStreamer->SwitchSection(S);
Jim Grosbach1900c732011-03-29 23:20:22 +00001485
Reid Kleckner1aa90612018-01-17 23:55:23 +00001486 if (TM.getTargetTriple().isOSBinFormatCOFF()) {
1487 // Emit /EXPORT: flags for each exported global as necessary.
1488 const auto &TLOF = getObjFileLowering();
1489 std::string Flags;
Saleem Abdulrasool99f479a2018-01-20 00:28:02 +00001490
Reid Kleckner1aa90612018-01-17 23:55:23 +00001491 for (const GlobalValue &GV : M.global_values()) {
1492 raw_string_ostream OS(Flags);
1493 TLOF.emitLinkerFlagsForGlobal(OS, &GV);
1494 OS.flush();
1495 if (!Flags.empty()) {
1496 OutStreamer->SwitchSection(TLOF.getDrectveSection());
1497 OutStreamer->EmitBytes(Flags);
1498 }
1499 Flags.clear();
1500 }
Saleem Abdulrasool99f479a2018-01-20 00:28:02 +00001501
1502 // Emit /INCLUDE: flags for each used global as necessary.
1503 if (const auto *LU = M.getNamedGlobal("llvm.used")) {
1504 assert(LU->hasInitializer() &&
1505 "expected llvm.used to have an initializer");
1506 assert(isa<ArrayType>(LU->getValueType()) &&
1507 "expected llvm.used to be an array type");
1508 if (const auto *A = cast<ConstantArray>(LU->getInitializer())) {
1509 for (const Value *Op : A->operands()) {
1510 const auto *GV =
1511 cast<GlobalValue>(Op->stripPointerCastsNoFollowAliases());
Shoaib Meenaid8fd16b2018-01-26 00:15:25 +00001512 // Global symbols with internal or private linkage are not visible to
1513 // the linker, and thus would cause an error when the linker tried to
1514 // preserve the symbol due to the `/include:` directive.
Shoaib Meenai63b6a0e2018-01-29 20:28:04 +00001515 if (GV->hasLocalLinkage())
Saleem Abdulrasool99f479a2018-01-20 00:28:02 +00001516 continue;
1517
1518 raw_string_ostream OS(Flags);
1519 TLOF.emitLinkerFlagsForUsed(OS, GV);
1520 OS.flush();
1521
1522 if (!Flags.empty()) {
1523 OutStreamer->SwitchSection(TLOF.getDrectveSection());
1524 OutStreamer->EmitBytes(Flags);
1525 }
1526 Flags.clear();
1527 }
1528 }
1529 }
Reid Kleckner1aa90612018-01-17 23:55:23 +00001530 }
1531
Chris Lattner71a15b12009-09-18 20:17:03 +00001532 // Allow the target to emit any magic that it wants at the end of the file,
1533 // after everything else has gone out.
1534 EmitEndOfAsmFile(M);
Jim Grosbach1900c732011-03-29 23:20:22 +00001535
Craig Topper353eda42014-04-24 06:44:33 +00001536 MMI = nullptr;
Jim Grosbach1900c732011-03-29 23:20:22 +00001537
Lang Hames9ff69c82015-04-24 19:11:51 +00001538 OutStreamer->Finish();
1539 OutStreamer->reset();
Michael Zolotukhin8d052a02018-04-09 00:54:47 +00001540 OwnedMLI.reset();
1541 OwnedMDT.reset();
Pedro Artigas7212ee42012-12-12 22:59:46 +00001542
Chris Lattner6a8e0f52004-08-16 23:15:22 +00001543 return false;
1544}
1545
Rafael Espindoladc4263c2015-03-17 13:57:48 +00001546MCSymbol *AsmPrinter::getCurExceptionSym() {
1547 if (!CurExceptionSym)
Rafael Espindola9ab09232015-03-17 20:07:06 +00001548 CurExceptionSym = createTempSymbol("exception");
Rafael Espindoladc4263c2015-03-17 13:57:48 +00001549 return CurExceptionSym;
1550}
1551
Chris Lattnerbb644e32005-11-21 07:51:36 +00001552void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
Chris Lattner67159522010-01-26 04:35:26 +00001553 this->MF = &MF;
Chris Lattnera0911792010-01-16 01:24:10 +00001554 // Get the function symbol.
Matthias Braunf1caa282017-12-15 22:22:58 +00001555 CurrentFnSym = getSymbol(&MF.getFunction());
Hal Finkelad4d9f52012-02-22 21:11:47 +00001556 CurrentFnSymForSize = CurrentFnSym;
Rafael Espindola092b6192015-03-05 19:47:50 +00001557 CurrentFnBegin = nullptr;
Rafael Espindoladc4263c2015-03-17 13:57:48 +00001558 CurExceptionSym = nullptr;
Rafael Espindola092b6192015-03-05 19:47:50 +00001559 bool NeedsLocalForSize = MAI->needsLocalForSize();
Rafael Espindola78fdca32018-03-26 20:40:22 +00001560 if (needFuncLabelsForEHOrDebugInfo(MF, MMI) || NeedsLocalForSize ||
1561 MF.getTarget().Options.EmitStackSizeSection) {
Rafael Espindola9ab09232015-03-17 20:07:06 +00001562 CurrentFnBegin = createTempSymbol("func_begin");
Rafael Espindola092b6192015-03-05 19:47:50 +00001563 if (NeedsLocalForSize)
1564 CurrentFnSymForSize = CurrentFnBegin;
1565 }
David Greenef354b6e2009-08-10 16:38:07 +00001566
Justin Bogner369ba752017-02-24 00:19:22 +00001567 ORE = &getAnalysis<MachineOptimizationRemarkEmitterPass>().getORE();
Andrew V. Tischenko75745d02017-04-14 07:44:23 +00001568
1569 const TargetSubtargetInfo &STI = MF.getSubtarget();
1570 EnablePrintSchedInfo = PrintSchedule.getNumOccurrences()
1571 ? PrintSchedule
1572 : STI.supportPrintSchedInfo();
Chris Lattner6a8e0f52004-08-16 23:15:22 +00001573}
1574
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001575namespace {
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001576
Rafael Espindola0709a7b2015-05-21 19:20:38 +00001577// Keep track the alignment, constpool entries per Section.
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001578 struct SectionCPs {
Rafael Espindola0709a7b2015-05-21 19:20:38 +00001579 MCSection *S;
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001580 unsigned Alignment;
1581 SmallVector<unsigned, 4> CPEs;
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001582
Rafael Espindola0709a7b2015-05-21 19:20:38 +00001583 SectionCPs(MCSection *s, unsigned a) : S(s), Alignment(a) {}
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001584 };
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001585
1586} // end anonymous namespace
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001587
Chris Lattnerf2991ce2005-11-21 08:25:09 +00001588/// EmitConstantPool - Print to the current output stream assembly
1589/// representations of the constants in the constant pool MCP. This is
1590/// used to print out constants which have been "spilled to memory" by
1591/// the code generator.
Chris Lattner2b796242010-01-28 00:19:24 +00001592void AsmPrinter::EmitConstantPool() {
1593 const MachineConstantPool *MCP = MF->getConstantPool();
Chris Lattnerba972642006-02-09 04:22:52 +00001594 const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
Chris Lattnerf2991ce2005-11-21 08:25:09 +00001595 if (CP.empty()) return;
Evan Chengec1d60b2006-06-29 00:26:09 +00001596
Anton Korobeynikov123afb82008-09-24 22:17:59 +00001597 // Calculate sections for constant pool entries. We collect entries to go into
1598 // the same section together to reduce amount of section switch statements.
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001599 SmallVector<SectionCPs, 4> CPSections;
Chris Lattnerf2991ce2005-11-21 08:25:09 +00001600 for (unsigned i = 0, e = CP.size(); i != e; ++i) {
Chris Lattnerb300a4f2009-07-22 00:28:43 +00001601 const MachineConstantPoolEntry &CPE = CP[i];
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001602 unsigned Align = CPE.getAlignment();
Jim Grosbach1900c732011-03-29 23:20:22 +00001603
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001604 SectionKind Kind = CPE.getSectionKind(&getDataLayout());
Chris Lattnerfb6867c2009-07-26 06:26:55 +00001605
David Majnemer8bce66b2014-07-14 22:57:27 +00001606 const Constant *C = nullptr;
1607 if (!CPE.isMachineConstantPoolEntry())
1608 C = CPE.Val.ConstVal;
1609
David Majnemera3ea4072016-02-21 01:30:30 +00001610 MCSection *S = getObjFileLowering().getSectionForConstant(getDataLayout(),
1611 Kind, C, Align);
Jim Grosbach1900c732011-03-29 23:20:22 +00001612
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001613 // The number of sections are small, just do a linear search from the
1614 // last section to the first.
1615 bool Found = false;
1616 unsigned SecIdx = CPSections.size();
1617 while (SecIdx != 0) {
1618 if (CPSections[--SecIdx].S == S) {
1619 Found = true;
1620 break;
1621 }
1622 }
1623 if (!Found) {
1624 SecIdx = CPSections.size();
1625 CPSections.push_back(SectionCPs(S, Align));
1626 }
1627
1628 if (Align > CPSections[SecIdx].Alignment)
1629 CPSections[SecIdx].Alignment = Align;
1630 CPSections[SecIdx].CPEs.push_back(i);
Evan Chengec1d60b2006-06-29 00:26:09 +00001631 }
1632
Anton Korobeynikov123afb82008-09-24 22:17:59 +00001633 // Now print stuff into the calculated sections.
David Majnemer8bce66b2014-07-14 22:57:27 +00001634 const MCSection *CurSection = nullptr;
1635 unsigned Offset = 0;
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001636 for (unsigned i = 0, e = CPSections.size(); i != e; ++i) {
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001637 for (unsigned j = 0, ee = CPSections[i].CPEs.size(); j != ee; ++j) {
1638 unsigned CPI = CPSections[i].CPEs[j];
David Majnemer8bce66b2014-07-14 22:57:27 +00001639 MCSymbol *Sym = GetCPISymbol(CPI);
1640 if (!Sym->isUndefined())
1641 continue;
1642
1643 if (CurSection != CPSections[i].S) {
Lang Hames9ff69c82015-04-24 19:11:51 +00001644 OutStreamer->SwitchSection(CPSections[i].S);
David Majnemer8bce66b2014-07-14 22:57:27 +00001645 EmitAlignment(Log2_32(CPSections[i].Alignment));
1646 CurSection = CPSections[i].S;
1647 Offset = 0;
1648 }
1649
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001650 MachineConstantPoolEntry CPE = CP[CPI];
Anton Korobeynikov123afb82008-09-24 22:17:59 +00001651
Chris Lattnerf6190822006-02-09 04:46:04 +00001652 // Emit inter-object padding for alignment.
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001653 unsigned AlignMask = CPE.getAlignment() - 1;
1654 unsigned NewOffset = (Offset + AlignMask) & ~AlignMask;
Lang Hames9ff69c82015-04-24 19:11:51 +00001655 OutStreamer->EmitZeros(NewOffset - Offset);
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001656
Chris Lattner229907c2011-07-18 04:54:35 +00001657 Type *Ty = CPE.getType();
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001658 Offset = NewOffset + getDataLayout().getTypeAllocSize(Ty);
Chris Lattner4225a7b2010-01-23 05:19:23 +00001659
Lang Hames9ff69c82015-04-24 19:11:51 +00001660 OutStreamer->EmitLabel(Sym);
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001661 if (CPE.isMachineConstantPoolEntry())
1662 EmitMachineConstantPoolValue(CPE.Val.MachineCPVal);
1663 else
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001664 EmitGlobalConstant(getDataLayout(), CPE.Val.ConstVal);
Chris Lattnerf6190822006-02-09 04:46:04 +00001665 }
Chris Lattnerf2991ce2005-11-21 08:25:09 +00001666 }
1667}
1668
Nate Begeman4ca2ea52006-04-22 18:53:45 +00001669/// EmitJumpTableInfo - Print assembly representations of the jump tables used
Jim Grosbach1900c732011-03-29 23:20:22 +00001670/// by the current function to the current output stream.
Chris Lattner94a946c2010-01-28 01:02:27 +00001671void AsmPrinter::EmitJumpTableInfo() {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001672 const DataLayout &DL = MF->getDataLayout();
Chris Lattner94a946c2010-01-28 01:02:27 +00001673 const MachineJumpTableInfo *MJTI = MF->getJumpTableInfo();
Craig Topper353eda42014-04-24 06:44:33 +00001674 if (!MJTI) return;
Richard Osborne6d3e92d2010-03-11 14:58:16 +00001675 if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_Inline) return;
Nate Begeman4ca2ea52006-04-22 18:53:45 +00001676 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
1677 if (JT.empty()) return;
Anton Korobeynikov2c638782007-11-14 09:18:41 +00001678
Jim Grosbach1900c732011-03-29 23:20:22 +00001679 // Pick the directive to use to print the jump table entries, and switch to
Nate Begeman78756502006-07-27 01:13:04 +00001680 // the appropriate section.
Matthias Braunf1caa282017-12-15 22:22:58 +00001681 const Function &F = MF->getFunction();
Rafael Espindola29786d42015-02-12 17:16:46 +00001682 const TargetLoweringObjectFile &TLOF = getObjFileLowering();
Rafael Espindoladf195192015-02-17 23:34:51 +00001683 bool JTInDiffSection = !TLOF.shouldPutJumpTableInFunctionSection(
1684 MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32,
Matthias Braunf1caa282017-12-15 22:22:58 +00001685 F);
Rafael Espindolaa6001792015-03-09 18:29:12 +00001686 if (JTInDiffSection) {
1687 // Drop it in the readonly section.
Matthias Braunf1caa282017-12-15 22:22:58 +00001688 MCSection *ReadOnlySection = TLOF.getSectionForJumpTable(F, TM);
Lang Hames9ff69c82015-04-24 19:11:51 +00001689 OutStreamer->SwitchSection(ReadOnlySection);
Nate Begeman78756502006-07-27 01:13:04 +00001690 }
Chris Lattnerb6db2c62010-01-25 23:26:13 +00001691
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001692 EmitAlignment(Log2_32(MJTI->getEntryAlignment(DL)));
Jim Grosbach1900c732011-03-29 23:20:22 +00001693
Jim Grosbach361ca342012-09-24 23:06:27 +00001694 // Jump tables in code sections are marked with a data_region directive
1695 // where that's supported.
1696 if (!JTInDiffSection)
Lang Hames9ff69c82015-04-24 19:11:51 +00001697 OutStreamer->EmitDataRegion(MCDR_DataRegionJT32);
Jim Grosbach361ca342012-09-24 23:06:27 +00001698
Chris Lattner4db603f2010-01-26 06:42:44 +00001699 for (unsigned JTI = 0, e = JT.size(); JTI != e; ++JTI) {
1700 const std::vector<MachineBasicBlock*> &JTBBs = JT[JTI].MBBs;
Jim Grosbach1900c732011-03-29 23:20:22 +00001701
1702 // If this jump table was deleted, ignore it.
Chris Lattner28bfe382006-10-28 18:10:06 +00001703 if (JTBBs.empty()) continue;
Nate Begeman984c1a42006-08-12 21:29:52 +00001704
Rafael Espindolac606bfe2014-10-21 01:17:30 +00001705 // For the EK_LabelDifference32 entry, if using .set avoids a relocation,
1706 /// emit a .set directive for each unique entry.
Chris Lattnercc0f7342010-01-26 05:15:20 +00001707 if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 &&
Joerg Sonnenberger22982032016-06-18 23:25:37 +00001708 MAI->doesSetDirectiveSuppressReloc()) {
Chris Lattner4db603f2010-01-26 06:42:44 +00001709 SmallPtrSet<const MachineBasicBlock*, 16> EmittedSets;
Eric Christopher504f3882015-02-19 18:46:23 +00001710 const TargetLowering *TLI = MF->getSubtarget().getTargetLowering();
Chris Lattner94a946c2010-01-28 01:02:27 +00001711 const MCExpr *Base = TLI->getPICJumpTableRelocBaseExpr(MF,JTI,OutContext);
Chris Lattner4db603f2010-01-26 06:42:44 +00001712 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
1713 const MachineBasicBlock *MBB = JTBBs[ii];
David Blaikie70573dc2014-11-19 07:49:26 +00001714 if (!EmittedSets.insert(MBB).second)
1715 continue;
Jim Grosbach1900c732011-03-29 23:20:22 +00001716
Chris Lattnerb657c4c2010-01-26 21:53:08 +00001717 // .set LJTSet, LBB32-base
1718 const MCExpr *LHS =
Jim Grosbach13760bd2015-05-30 01:25:56 +00001719 MCSymbolRefExpr::create(MBB->getSymbol(), OutContext);
Lang Hames9ff69c82015-04-24 19:11:51 +00001720 OutStreamer->EmitAssignment(GetJTSetSymbol(JTI, MBB->getNumber()),
Jim Grosbach13760bd2015-05-30 01:25:56 +00001721 MCBinaryExpr::createSub(LHS, Base,
Lang Hames9ff69c82015-04-24 19:11:51 +00001722 OutContext));
Chris Lattner4db603f2010-01-26 06:42:44 +00001723 }
Jim Grosbach1900c732011-03-29 23:20:22 +00001724 }
1725
Duncan Sands75b5d272011-02-15 09:23:02 +00001726 // On some targets (e.g. Darwin) we want to emit two consecutive labels
Chris Lattner0ee2d462007-01-18 01:12:56 +00001727 // before each jump table. The first label is never referenced, but tells
1728 // the assembler and linker the extents of the jump table object. The
1729 // second label is actually referenced by the code.
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001730 if (JTInDiffSection && DL.hasLinkerPrivateGlobalPrefix())
Chris Lattner273735b2010-01-26 05:58:28 +00001731 // FIXME: This doesn't have to have any specific name, just any randomly
1732 // named and numbered 'l' label would work. Simplify GetJTISymbol.
Lang Hames9ff69c82015-04-24 19:11:51 +00001733 OutStreamer->EmitLabel(GetJTISymbol(JTI, true));
Chris Lattner4225a7b2010-01-23 05:19:23 +00001734
Lang Hames9ff69c82015-04-24 19:11:51 +00001735 OutStreamer->EmitLabel(GetJTISymbol(JTI));
Chris Lattner4225a7b2010-01-23 05:19:23 +00001736
Chris Lattner279de3e2010-01-26 05:10:10 +00001737 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
Chris Lattner4db603f2010-01-26 06:42:44 +00001738 EmitJumpTableEntry(MJTI, JTBBs[ii], JTI);
Nate Begeman4ca2ea52006-04-22 18:53:45 +00001739 }
Jim Grosbach361ca342012-09-24 23:06:27 +00001740 if (!JTInDiffSection)
Lang Hames9ff69c82015-04-24 19:11:51 +00001741 OutStreamer->EmitDataRegion(MCDR_DataRegionEnd);
Nate Begeman4ca2ea52006-04-22 18:53:45 +00001742}
1743
Chris Lattner279de3e2010-01-26 05:10:10 +00001744/// EmitJumpTableEntry - Emit a jump table entry for the specified MBB to the
1745/// current stream.
1746void AsmPrinter::EmitJumpTableEntry(const MachineJumpTableInfo *MJTI,
1747 const MachineBasicBlock *MBB,
1748 unsigned UID) const {
Jakob Stoklund Olesen6d4d8582011-02-09 21:52:06 +00001749 assert(MBB && MBB->getNumber() >= 0 && "Invalid basic block");
Craig Topper353eda42014-04-24 06:44:33 +00001750 const MCExpr *Value = nullptr;
Chris Lattnera7c11602010-01-26 03:43:22 +00001751 switch (MJTI->getEntryKind()) {
Richard Osborne6d3e92d2010-03-11 14:58:16 +00001752 case MachineJumpTableInfo::EK_Inline:
David Blaikie46a9f012012-01-20 21:51:11 +00001753 llvm_unreachable("Cannot emit EK_Inline jump table entry");
Chris Lattner5fc41602010-01-26 04:05:28 +00001754 case MachineJumpTableInfo::EK_Custom32:
Eric Christopher504f3882015-02-19 18:46:23 +00001755 Value = MF->getSubtarget().getTargetLowering()->LowerCustomJumpTableEntry(
1756 MJTI, MBB, UID, OutContext);
Chris Lattner5fc41602010-01-26 04:05:28 +00001757 break;
Chris Lattnera7c11602010-01-26 03:43:22 +00001758 case MachineJumpTableInfo::EK_BlockAddress:
1759 // EK_BlockAddress - Each entry is a plain address of block, e.g.:
1760 // .word LBB123
Jim Grosbach13760bd2015-05-30 01:25:56 +00001761 Value = MCSymbolRefExpr::create(MBB->getSymbol(), OutContext);
Chris Lattnera7c11602010-01-26 03:43:22 +00001762 break;
Chris Lattnera7c11602010-01-26 03:43:22 +00001763 case MachineJumpTableInfo::EK_GPRel32BlockAddress: {
1764 // EK_GPRel32BlockAddress - Each entry is an address of block, encoded
1765 // with a relocation as gp-relative, e.g.:
1766 // .gprel32 LBB123
Chris Lattner29bdac42010-03-13 21:04:28 +00001767 MCSymbol *MBBSym = MBB->getSymbol();
Jim Grosbach13760bd2015-05-30 01:25:56 +00001768 OutStreamer->EmitGPRel32Value(MCSymbolRefExpr::create(MBBSym, OutContext));
Chris Lattner19bd0392010-01-25 21:10:10 +00001769 return;
Anton Korobeynikov2c638782007-11-14 09:18:41 +00001770 }
Chris Lattner5fc41602010-01-26 04:05:28 +00001771
Akira Hatanakaf0b08442012-02-03 04:33:00 +00001772 case MachineJumpTableInfo::EK_GPRel64BlockAddress: {
1773 // EK_GPRel64BlockAddress - Each entry is an address of block, encoded
1774 // with a relocation as gp-relative, e.g.:
1775 // .gpdword LBB123
1776 MCSymbol *MBBSym = MBB->getSymbol();
Jim Grosbach13760bd2015-05-30 01:25:56 +00001777 OutStreamer->EmitGPRel64Value(MCSymbolRefExpr::create(MBBSym, OutContext));
Akira Hatanakaf0b08442012-02-03 04:33:00 +00001778 return;
1779 }
1780
Chris Lattnera7c11602010-01-26 03:43:22 +00001781 case MachineJumpTableInfo::EK_LabelDifference32: {
Rafael Espindolac606bfe2014-10-21 01:17:30 +00001782 // Each entry is the address of the block minus the address of the jump
1783 // table. This is used for PIC jump tables where gprel32 is not supported.
1784 // e.g.:
Chris Lattnera7c11602010-01-26 03:43:22 +00001785 // .word LBB123 - LJTI1_2
Rafael Espindolac606bfe2014-10-21 01:17:30 +00001786 // If the .set directive avoids relocations, this is emitted as:
Chris Lattnera7c11602010-01-26 03:43:22 +00001787 // .set L4_5_set_123, LBB123 - LJTI1_2
1788 // .word L4_5_set_123
Joerg Sonnenberger22982032016-06-18 23:25:37 +00001789 if (MAI->doesSetDirectiveSuppressReloc()) {
Jim Grosbach13760bd2015-05-30 01:25:56 +00001790 Value = MCSymbolRefExpr::create(GetJTSetSymbol(UID, MBB->getNumber()),
Chris Lattnera7c11602010-01-26 03:43:22 +00001791 OutContext);
1792 break;
1793 }
Jim Grosbach13760bd2015-05-30 01:25:56 +00001794 Value = MCSymbolRefExpr::create(MBB->getSymbol(), OutContext);
Eric Christophera7249ec2015-02-20 07:16:19 +00001795 const TargetLowering *TLI = MF->getSubtarget().getTargetLowering();
Rafael Espindola26cfbea2014-11-06 14:39:49 +00001796 const MCExpr *Base = TLI->getPICJumpTableRelocBaseExpr(MF, UID, OutContext);
Jim Grosbach13760bd2015-05-30 01:25:56 +00001797 Value = MCBinaryExpr::createSub(Value, Base, OutContext);
Chris Lattnera7c11602010-01-26 03:43:22 +00001798 break;
1799 }
Anton Korobeynikov2c638782007-11-14 09:18:41 +00001800 }
Jim Grosbach1900c732011-03-29 23:20:22 +00001801
Chris Lattnera7c11602010-01-26 03:43:22 +00001802 assert(Value && "Unknown entry kind!");
Jim Grosbach1900c732011-03-29 23:20:22 +00001803
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001804 unsigned EntrySize = MJTI->getEntrySize(getDataLayout());
Lang Hames9ff69c82015-04-24 19:11:51 +00001805 OutStreamer->EmitValue(Value, EntrySize);
Anton Korobeynikov2c638782007-11-14 09:18:41 +00001806}
1807
Chris Lattnerf0e9aef2005-12-13 06:32:10 +00001808/// EmitSpecialLLVMGlobal - Check to see if the specified global is a
1809/// special global used by LLVM. If so, emit it and return true, otherwise
1810/// do nothing and return false.
1811bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
Daniel Dunbare03eecb2009-07-25 23:55:21 +00001812 if (GV->getName() == "llvm.used") {
Chris Lattner1deb09c2010-01-23 05:51:36 +00001813 if (MAI->hasNoDeadStrip()) // No need to emit this at all.
Rafael Espindola74f2e462013-04-22 14:58:02 +00001814 EmitLLVMUsedList(cast<ConstantArray>(GV->getInitializer()));
Andrew Lenharthbeb80a92007-08-22 19:33:11 +00001815 return true;
1816 }
1817
Chris Lattner58f9bb22009-07-20 06:14:25 +00001818 // Ignore debug and non-emitted data. This handles llvm.compiler.used.
Rafael Espindola83658d62016-05-11 18:21:59 +00001819 if (GV->getSection() == "llvm.metadata" ||
Chris Lattner184f1be2009-04-13 05:44:34 +00001820 GV->hasAvailableExternallyLinkage())
1821 return true;
Jim Grosbach1900c732011-03-29 23:20:22 +00001822
Jim Laskey313570f2006-03-07 22:00:35 +00001823 if (!GV->hasAppendingLinkage()) return false;
1824
1825 assert(GV->hasInitializer() && "Not a special LLVM global!");
Jim Grosbach1900c732011-03-29 23:20:22 +00001826
Chris Lattner317293b2009-03-09 05:52:15 +00001827 if (GV->getName() == "llvm.global_ctors") {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001828 EmitXXStructorList(GV->getParent()->getDataLayout(), GV->getInitializer(),
1829 /* isCtor */ true);
Jim Grosbach1900c732011-03-29 23:20:22 +00001830
Chris Lattner126dab22009-03-09 08:18:48 +00001831 return true;
Jim Grosbach1900c732011-03-29 23:20:22 +00001832 }
1833
Chris Lattner317293b2009-03-09 05:52:15 +00001834 if (GV->getName() == "llvm.global_dtors") {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001835 EmitXXStructorList(GV->getParent()->getDataLayout(), GV->getInitializer(),
1836 /* isCtor */ false);
Chris Lattnere9d28b12010-01-19 04:34:02 +00001837
Chris Lattner126dab22009-03-09 08:18:48 +00001838 return true;
Chris Lattnerf0e9aef2005-12-13 06:32:10 +00001839 }
Jim Grosbach1900c732011-03-29 23:20:22 +00001840
Rafael Espindolae64619c2016-05-16 21:14:24 +00001841 report_fatal_error("unknown special variable");
Chris Lattnerf0e9aef2005-12-13 06:32:10 +00001842}
1843
Chris Lattnere9a75a62009-08-22 21:43:10 +00001844/// EmitLLVMUsedList - For targets that define a MAI::UsedDirective, mark each
Dale Johannesenabb1e772008-09-09 22:29:13 +00001845/// global in the specified llvm.used list for which emitUsedDirectiveFor
1846/// is true, as being used with this directive.
Rafael Espindola74f2e462013-04-22 14:58:02 +00001847void AsmPrinter::EmitLLVMUsedList(const ConstantArray *InitList) {
Dan Gohman4fe64de2009-06-14 23:30:43 +00001848 // Should be an array of 'i8*'.
Chris Lattner66af3902006-09-26 03:38:18 +00001849 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
Chris Lattner1fcac9f2009-07-17 22:00:23 +00001850 const GlobalValue *GV =
1851 dyn_cast<GlobalValue>(InitList->getOperand(i)->stripPointerCasts());
Rafael Espindola3b30cb42014-03-06 22:47:08 +00001852 if (GV)
Lang Hames9ff69c82015-04-24 19:11:51 +00001853 OutStreamer->EmitSymbolAttribute(getSymbol(GV), MCSA_NoDeadStrip);
Chris Lattner66af3902006-09-26 03:38:18 +00001854 }
1855}
1856
Reid Klecknerfceb76f2014-05-16 20:39:27 +00001857namespace {
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001858
Reid Klecknerfceb76f2014-05-16 20:39:27 +00001859struct Structor {
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001860 int Priority = 0;
1861 Constant *Func = nullptr;
1862 GlobalValue *ComdatKey = nullptr;
1863
1864 Structor() = default;
Reid Klecknerfceb76f2014-05-16 20:39:27 +00001865};
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001866
Eugene Zelenko149178d2017-10-10 22:33:29 +00001867} // end anonymous namespace
Reid Klecknerfceb76f2014-05-16 20:39:27 +00001868
Duncan Sands4d635422011-08-28 13:17:22 +00001869/// EmitXXStructorList - Emit the ctor or dtor list taking into account the init
1870/// priority.
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001871void AsmPrinter::EmitXXStructorList(const DataLayout &DL, const Constant *List,
1872 bool isCtor) {
Chris Lattnerf0e9aef2005-12-13 06:32:10 +00001873 // Should be an array of '{ int, void ()* }' structs. The first value is the
Duncan Sands4d635422011-08-28 13:17:22 +00001874 // init priority.
Chris Lattnerf0e9aef2005-12-13 06:32:10 +00001875 if (!isa<ConstantArray>(List)) return;
Chris Lattner434ffe42005-12-21 01:17:37 +00001876
Duncan Sands4d635422011-08-28 13:17:22 +00001877 // Sanity check the structors list.
1878 const ConstantArray *InitList = dyn_cast<ConstantArray>(List);
1879 if (!InitList) return; // Not an array!
1880 StructType *ETy = dyn_cast<StructType>(InitList->getType()->getElementType());
Reid Klecknerfceb76f2014-05-16 20:39:27 +00001881 // FIXME: Only allow the 3-field form in LLVM 4.0.
1882 if (!ETy || ETy->getNumElements() < 2 || ETy->getNumElements() > 3)
1883 return; // Not an array of two or three elements!
Duncan Sands4d635422011-08-28 13:17:22 +00001884 if (!isa<IntegerType>(ETy->getTypeAtIndex(0U)) ||
1885 !isa<PointerType>(ETy->getTypeAtIndex(1U))) return; // Not (int, ptr).
Reid Klecknerfceb76f2014-05-16 20:39:27 +00001886 if (ETy->getNumElements() == 3 && !isa<PointerType>(ETy->getTypeAtIndex(2U)))
1887 return; // Not (int, ptr, ptr).
Duncan Sands4d635422011-08-28 13:17:22 +00001888
1889 // Gather the structors in a form that's convenient for sorting by priority.
1890 SmallVector<Structor, 8> Structors;
Reid Klecknerfceb76f2014-05-16 20:39:27 +00001891 for (Value *O : InitList->operands()) {
1892 ConstantStruct *CS = dyn_cast<ConstantStruct>(O);
Duncan Sands4d635422011-08-28 13:17:22 +00001893 if (!CS) continue; // Malformed.
1894 if (CS->getOperand(1)->isNullValue())
1895 break; // Found a null terminator, skip the rest.
1896 ConstantInt *Priority = dyn_cast<ConstantInt>(CS->getOperand(0));
1897 if (!Priority) continue; // Malformed.
Reid Klecknerfceb76f2014-05-16 20:39:27 +00001898 Structors.push_back(Structor());
1899 Structor &S = Structors.back();
1900 S.Priority = Priority->getLimitedValue(65535);
1901 S.Func = CS->getOperand(1);
1902 if (ETy->getNumElements() == 3 && !CS->getOperand(2)->isNullValue())
Eric Christopher0b6537e2016-07-01 06:07:31 +00001903 S.ComdatKey =
1904 dyn_cast<GlobalValue>(CS->getOperand(2)->stripPointerCasts());
Duncan Sands4d635422011-08-28 13:17:22 +00001905 }
1906
Anton Korobeynikov7722a2d2012-01-25 22:24:19 +00001907 // Emit the function pointers in the target-specific order
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001908 unsigned Align = Log2_32(DL.getPointerPrefAlignment());
Reid Klecknerfceb76f2014-05-16 20:39:27 +00001909 std::stable_sort(Structors.begin(), Structors.end(),
1910 [](const Structor &L,
1911 const Structor &R) { return L.Priority < R.Priority; });
1912 for (Structor &S : Structors) {
1913 const TargetLoweringObjectFile &Obj = getObjFileLowering();
1914 const MCSymbol *KeySym = nullptr;
Hans Wennborg8e873322014-06-04 21:04:54 +00001915 if (GlobalValue *GV = S.ComdatKey) {
Teresa Johnson2d384ac2017-01-18 16:58:43 +00001916 if (GV->isDeclarationForLinker())
1917 // If the associated variable is not defined in this module
1918 // (it might be available_externally, or have been an
1919 // available_externally definition that was dropped by the
1920 // EliminateAvailableExternally pass), some other TU
Hans Wennborg8e873322014-06-04 21:04:54 +00001921 // will provide its dynamic initializer.
1922 continue;
1923
1924 KeySym = getSymbol(GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +00001925 }
Rafael Espindola0709a7b2015-05-21 19:20:38 +00001926 MCSection *OutputSection =
Rafael Espindola0766ae02014-06-06 19:26:12 +00001927 (isCtor ? Obj.getStaticCtorSection(S.Priority, KeySym)
1928 : Obj.getStaticDtorSection(S.Priority, KeySym));
Lang Hames9ff69c82015-04-24 19:11:51 +00001929 OutStreamer->SwitchSection(OutputSection);
1930 if (OutStreamer->getCurrentSection() != OutStreamer->getPreviousSection())
Anton Korobeynikov7722a2d2012-01-25 22:24:19 +00001931 EmitAlignment(Align);
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001932 EmitXXStructor(DL, S.Func);
Anton Korobeynikov7722a2d2012-01-25 22:24:19 +00001933 }
Chris Lattnerf0e9aef2005-12-13 06:32:10 +00001934}
Chris Lattnerf2991ce2005-11-21 08:25:09 +00001935
Rafael Espindola0018a592013-10-16 01:49:05 +00001936void AsmPrinter::EmitModuleIdents(Module &M) {
1937 if (!MAI->hasIdentDirective())
1938 return;
1939
1940 if (const NamedMDNode *NMD = M.getNamedMetadata("llvm.ident")) {
1941 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00001942 const MDNode *N = NMD->getOperand(i);
Adrian Prantlc4fd6b72014-02-11 21:23:02 +00001943 assert(N->getNumOperands() == 1 &&
Rafael Espindola0018a592013-10-16 01:49:05 +00001944 "llvm.ident metadata entry can have only one operand");
1945 const MDString *S = cast<MDString>(N->getOperand(0));
Lang Hames9ff69c82015-04-24 19:11:51 +00001946 OutStreamer->EmitIdent(S->getString());
Rafael Espindola0018a592013-10-16 01:49:05 +00001947 }
1948 }
1949}
1950
Jim Laskey1c055e82007-01-25 15:12:02 +00001951//===--------------------------------------------------------------------===//
1952// Emission and print routines
1953//
1954
Rafael Espindola4b4d85f2018-03-29 23:32:54 +00001955/// Emit a byte directive and value.
Jim Laskey1c055e82007-01-25 15:12:02 +00001956///
Rafael Espindola4b4d85f2018-03-29 23:32:54 +00001957void AsmPrinter::emitInt8(int Value) const {
Lang Hames9ff69c82015-04-24 19:11:51 +00001958 OutStreamer->EmitIntValue(Value, 1);
Jim Laskey1c055e82007-01-25 15:12:02 +00001959}
1960
Rafael Espindola4b4d85f2018-03-29 23:32:54 +00001961/// Emit a short directive and value.
1962void AsmPrinter::emitInt16(int Value) const {
Lang Hames9ff69c82015-04-24 19:11:51 +00001963 OutStreamer->EmitIntValue(Value, 2);
Jim Laskey1c055e82007-01-25 15:12:02 +00001964}
1965
Rafael Espindola4b4d85f2018-03-29 23:32:54 +00001966/// Emit a long directive and value.
1967void AsmPrinter::emitInt32(int Value) const {
Lang Hames9ff69c82015-04-24 19:11:51 +00001968 OutStreamer->EmitIntValue(Value, 4);
Jim Laskey1c055e82007-01-25 15:12:02 +00001969}
1970
James Hendersona3acf992018-05-10 10:51:33 +00001971/// Emit a long long directive and value.
1972void AsmPrinter::emitInt64(uint64_t Value) const {
1973 OutStreamer->EmitIntValue(Value, 8);
1974}
1975
Rafael Espindolac606bfe2014-10-21 01:17:30 +00001976/// Emit something like ".long Hi-Lo" where the size in bytes of the directive
1977/// is specified by Size and Hi/Lo specify the labels. This implicitly uses
1978/// .set if it avoids relocations.
Chris Lattner9889c1e2010-03-08 23:58:37 +00001979void AsmPrinter::EmitLabelDifference(const MCSymbol *Hi, const MCSymbol *Lo,
1980 unsigned Size) const {
Rafael Espindola7c6e6e42015-06-11 18:58:08 +00001981 OutStreamer->emitAbsoluteSymbolDiff(Hi, Lo, Size);
Chris Lattner9889c1e2010-03-08 23:58:37 +00001982}
1983
Jim Grosbach1900c732011-03-29 23:20:22 +00001984/// EmitLabelPlusOffset - Emit something like ".long Label+Offset"
Devang Patelda3ef852010-09-02 16:43:44 +00001985/// where the size in bytes of the directive is specified by Size and Label
1986/// specifies the label. This implicitly uses .set if it is available.
1987void AsmPrinter::EmitLabelPlusOffset(const MCSymbol *Label, uint64_t Offset,
Eric Christopherf8da6aa2013-11-23 00:05:06 +00001988 unsigned Size,
1989 bool IsSectionRelative) const {
Matt Arsenault40dddd72013-10-03 19:50:01 +00001990 if (MAI->needsDwarfSectionOffsetDirective() && IsSectionRelative) {
Keno Fischerf7d84ee2017-01-02 03:00:19 +00001991 OutStreamer->EmitCOFFSecRel32(Label, Offset);
1992 if (Size > 4)
1993 OutStreamer->EmitZeros(Size - 4);
Carlo Kok4382da92013-08-02 16:14:15 +00001994 return;
1995 }
Jim Grosbach1900c732011-03-29 23:20:22 +00001996
Nick Lewycky33da3362012-06-22 01:25:12 +00001997 // Emit Label+Offset (or just Label if Offset is zero)
Jim Grosbach13760bd2015-05-30 01:25:56 +00001998 const MCExpr *Expr = MCSymbolRefExpr::create(Label, OutContext);
Nick Lewycky33da3362012-06-22 01:25:12 +00001999 if (Offset)
Jim Grosbach13760bd2015-05-30 01:25:56 +00002000 Expr = MCBinaryExpr::createAdd(
2001 Expr, MCConstantExpr::create(Offset, OutContext), OutContext);
Jim Grosbach1900c732011-03-29 23:20:22 +00002002
Lang Hames9ff69c82015-04-24 19:11:51 +00002003 OutStreamer->EmitValue(Expr, Size);
Devang Patelda3ef852010-09-02 16:43:44 +00002004}
Jim Grosbach1900c732011-03-29 23:20:22 +00002005
Jim Laskey1c055e82007-01-25 15:12:02 +00002006//===----------------------------------------------------------------------===//
2007
Chris Lattner3e3ff302007-05-31 18:57:45 +00002008// EmitAlignment - Emit an alignment directive to the specified power of
2009// two boundary. For example, if you pass in 3 here, you will get an 8
2010// byte alignment. If a global value is specified, and if that global has
Chris Lattner08e9e722010-04-28 19:58:07 +00002011// an explicit alignment requested, it will override the alignment request
2012// if required for correctness.
Rafael Espindola99e05cf2014-05-13 18:45:48 +00002013void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalObject *GV) const {
Eric Christopherd9134482014-08-04 21:25:23 +00002014 if (GV)
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002015 NumBits = getGVAlignmentLog2(GV, GV->getParent()->getDataLayout(), NumBits);
Jim Grosbach1900c732011-03-29 23:20:22 +00002016
Chris Lattner08e9e722010-04-28 19:58:07 +00002017 if (NumBits == 0) return; // 1-byte aligned: no need to emit alignment.
Jim Grosbach1900c732011-03-29 23:20:22 +00002018
Aaron Ballman0d6a0102014-12-16 14:04:11 +00002019 assert(NumBits <
2020 static_cast<unsigned>(std::numeric_limits<unsigned>::digits) &&
Michael Ilsemanaddddc42014-12-15 18:48:43 +00002021 "undefined behavior");
Chris Lattner0adae252009-08-18 06:15:16 +00002022 if (getCurrentSection()->getKind().isText())
Lang Hames9ff69c82015-04-24 19:11:51 +00002023 OutStreamer->EmitCodeAlignment(1u << NumBits);
Chris Lattnere4f249b2010-02-23 18:46:22 +00002024 else
Lang Hames9ff69c82015-04-24 19:11:51 +00002025 OutStreamer->EmitValueToAlignment(1u << NumBits);
Chris Lattner1d35c162004-08-17 19:14:29 +00002026}
David Greenefdd25192009-08-05 21:00:52 +00002027
Chris Lattner51003672010-04-20 06:20:21 +00002028//===----------------------------------------------------------------------===//
2029// Constant emission.
2030//===----------------------------------------------------------------------===//
2031
Matt Arsenaultdd3b77d2014-12-16 19:16:14 +00002032const MCExpr *AsmPrinter::lowerConstant(const Constant *CV) {
2033 MCContext &Ctx = OutContext;
Jim Grosbach1900c732011-03-29 23:20:22 +00002034
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002035 if (CV->isNullValue() || isa<UndefValue>(CV))
Jim Grosbach13760bd2015-05-30 01:25:56 +00002036 return MCConstantExpr::create(0, Ctx);
Chris Lattner7e0c1642010-01-13 04:29:19 +00002037
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002038 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV))
Jim Grosbach13760bd2015-05-30 01:25:56 +00002039 return MCConstantExpr::create(CI->getZExtValue(), Ctx);
Jim Grosbach1900c732011-03-29 23:20:22 +00002040
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002041 if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV))
Jim Grosbach13760bd2015-05-30 01:25:56 +00002042 return MCSymbolRefExpr::create(getSymbol(GV), Ctx);
Bill Wendling0d323ae2010-08-18 18:41:13 +00002043
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002044 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV))
Jim Grosbach13760bd2015-05-30 01:25:56 +00002045 return MCSymbolRefExpr::create(GetBlockAddressSymbol(BA), Ctx);
Jim Grosbach1900c732011-03-29 23:20:22 +00002046
Chris Lattner7e0c1642010-01-13 04:29:19 +00002047 const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV);
Craig Topper353eda42014-04-24 06:44:33 +00002048 if (!CE) {
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002049 llvm_unreachable("Unknown constant value to lower!");
Chris Lattner7e0c1642010-01-13 04:29:19 +00002050 }
Jim Grosbach1900c732011-03-29 23:20:22 +00002051
Chris Lattner7e0c1642010-01-13 04:29:19 +00002052 switch (CE->getOpcode()) {
Dan Gohman4268d6a2010-02-08 22:02:38 +00002053 default:
2054 // If the code isn't optimized, there may be outstanding folding
Micah Villmowcdfe20b2012-10-08 16:38:25 +00002055 // opportunities. Attempt to fold the expression using DataLayout as a
Dan Gohman4268d6a2010-02-08 22:02:38 +00002056 // last resort before giving up.
David Majnemerd536f232016-07-29 03:27:26 +00002057 if (Constant *C = ConstantFoldConstant(CE, getDataLayout()))
Dan Gohmane51b57b2010-02-08 22:19:11 +00002058 if (C != CE)
Matt Arsenaultdd3b77d2014-12-16 19:16:14 +00002059 return lowerConstant(C);
Dan Gohman23922872010-08-04 18:51:09 +00002060
2061 // Otherwise report the problem to the user.
2062 {
Alp Tokere69170a2014-06-26 22:52:05 +00002063 std::string S;
2064 raw_string_ostream OS(S);
Dan Gohman23922872010-08-04 18:51:09 +00002065 OS << "Unsupported expression in static initializer: ";
Chandler Carruthd48cdbf2014-01-09 02:29:41 +00002066 CE->printAsOperand(OS, /*PrintType=*/false,
Matthias Braunf1caa282017-12-15 22:22:58 +00002067 !MF ? nullptr : MF->getFunction().getParent());
Dan Gohman23922872010-08-04 18:51:09 +00002068 report_fatal_error(OS.str());
2069 }
Chris Lattner7e0c1642010-01-13 04:29:19 +00002070 case Instruction::GetElementPtr: {
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002071 // Generate a symbolic expression for the byte address
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002072 APInt OffsetAI(getDataLayout().getPointerTypeSizeInBits(CE->getType()), 0);
2073 cast<GEPOperator>(CE)->accumulateConstantOffset(getDataLayout(), OffsetAI);
Jim Grosbach1900c732011-03-29 23:20:22 +00002074
Matt Arsenaultdd3b77d2014-12-16 19:16:14 +00002075 const MCExpr *Base = lowerConstant(CE->getOperand(0));
Nuno Lopesb6ad9822012-12-30 16:25:48 +00002076 if (!OffsetAI)
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002077 return Base;
Jim Grosbach1900c732011-03-29 23:20:22 +00002078
Nuno Lopesb6ad9822012-12-30 16:25:48 +00002079 int64_t Offset = OffsetAI.getSExtValue();
Jim Grosbach13760bd2015-05-30 01:25:56 +00002080 return MCBinaryExpr::createAdd(Base, MCConstantExpr::create(Offset, Ctx),
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002081 Ctx);
Chris Lattner7e0c1642010-01-13 04:29:19 +00002082 }
Jim Grosbach1900c732011-03-29 23:20:22 +00002083
Chris Lattner7e0c1642010-01-13 04:29:19 +00002084 case Instruction::Trunc:
2085 // We emit the value and depend on the assembler to truncate the generated
2086 // expression properly. This is important for differences between
2087 // blockaddress labels. Since the two labels are in the same function, it
2088 // is reasonable to treat their delta as a 32-bit value.
Justin Bognercd1d5aa2016-08-17 20:30:52 +00002089 LLVM_FALLTHROUGH;
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002090 case Instruction::BitCast:
Matt Arsenaultdd3b77d2014-12-16 19:16:14 +00002091 return lowerConstant(CE->getOperand(0));
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002092
2093 case Instruction::IntToPtr: {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002094 const DataLayout &DL = getDataLayout();
Eric Christopher8b770652015-01-26 19:03:15 +00002095
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002096 // Handle casts to pointers by changing them into casts to the appropriate
2097 // integer type. This promotes constant folding and simplifies this code.
2098 Constant *Op = CE->getOperand(0);
Matt Arsenaultb7689122013-10-21 20:03:54 +00002099 Op = ConstantExpr::getIntegerCast(Op, DL.getIntPtrType(CV->getType()),
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002100 false/*ZExt*/);
Matt Arsenaultdd3b77d2014-12-16 19:16:14 +00002101 return lowerConstant(Op);
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002102 }
Jim Grosbach1900c732011-03-29 23:20:22 +00002103
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002104 case Instruction::PtrToInt: {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002105 const DataLayout &DL = getDataLayout();
Eric Christopher8b770652015-01-26 19:03:15 +00002106
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002107 // Support only foldable casts to/from pointers that can be eliminated by
2108 // changing the pointer to the appropriately sized integer type.
2109 Constant *Op = CE->getOperand(0);
Chris Lattner229907c2011-07-18 04:54:35 +00002110 Type *Ty = CE->getType();
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002111
Matt Arsenaultdd3b77d2014-12-16 19:16:14 +00002112 const MCExpr *OpExpr = lowerConstant(Op);
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002113
2114 // We can emit the pointer value into this slot if the slot is an
2115 // integer slot equal to the size of the pointer.
Matt Arsenault40dddd72013-10-03 19:50:01 +00002116 if (DL.getTypeAllocSize(Ty) == DL.getTypeAllocSize(Op->getType()))
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002117 return OpExpr;
2118
2119 // Otherwise the pointer is smaller than the resultant integer, mask off
2120 // the high bits so we are sure to get a proper truncation if the input is
2121 // a constant expr.
Matt Arsenault40dddd72013-10-03 19:50:01 +00002122 unsigned InBits = DL.getTypeAllocSizeInBits(Op->getType());
Jim Grosbach13760bd2015-05-30 01:25:56 +00002123 const MCExpr *MaskExpr = MCConstantExpr::create(~0ULL >> (64-InBits), Ctx);
2124 return MCBinaryExpr::createAnd(OpExpr, MaskExpr, Ctx);
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002125 }
Jim Grosbach1900c732011-03-29 23:20:22 +00002126
Peter Collingbourne265ebd72016-04-22 20:40:10 +00002127 case Instruction::Sub: {
2128 GlobalValue *LHSGV;
2129 APInt LHSOffset;
2130 if (IsConstantOffsetFromGlobal(CE->getOperand(0), LHSGV, LHSOffset,
2131 getDataLayout())) {
2132 GlobalValue *RHSGV;
2133 APInt RHSOffset;
2134 if (IsConstantOffsetFromGlobal(CE->getOperand(1), RHSGV, RHSOffset,
2135 getDataLayout())) {
Eric Christopher4367c7f2016-09-16 07:33:15 +00002136 const MCExpr *RelocExpr =
2137 getObjFileLowering().lowerRelativeReference(LHSGV, RHSGV, TM);
Peter Collingbourne265ebd72016-04-22 20:40:10 +00002138 if (!RelocExpr)
2139 RelocExpr = MCBinaryExpr::createSub(
2140 MCSymbolRefExpr::create(getSymbol(LHSGV), Ctx),
2141 MCSymbolRefExpr::create(getSymbol(RHSGV), Ctx), Ctx);
2142 int64_t Addend = (LHSOffset - RHSOffset).getSExtValue();
2143 if (Addend != 0)
2144 RelocExpr = MCBinaryExpr::createAdd(
2145 RelocExpr, MCConstantExpr::create(Addend, Ctx), Ctx);
2146 return RelocExpr;
2147 }
2148 }
2149 }
2150 // else fallthrough
Adrian Prantl0e6694d2017-12-19 22:05:25 +00002151 LLVM_FALLTHROUGH;
Peter Collingbourne265ebd72016-04-22 20:40:10 +00002152
Dan Gohman227077d2010-02-09 00:02:37 +00002153 // The MC library also has a right-shift operator, but it isn't consistently
2154 // signed or unsigned between different targets.
Chris Lattner7e0c1642010-01-13 04:29:19 +00002155 case Instruction::Add:
Dan Gohman227077d2010-02-09 00:02:37 +00002156 case Instruction::Mul:
2157 case Instruction::SDiv:
2158 case Instruction::SRem:
2159 case Instruction::Shl:
Chris Lattner7e0c1642010-01-13 04:29:19 +00002160 case Instruction::And:
2161 case Instruction::Or:
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002162 case Instruction::Xor: {
Matt Arsenaultdd3b77d2014-12-16 19:16:14 +00002163 const MCExpr *LHS = lowerConstant(CE->getOperand(0));
2164 const MCExpr *RHS = lowerConstant(CE->getOperand(1));
Chris Lattner7e0c1642010-01-13 04:29:19 +00002165 switch (CE->getOpcode()) {
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002166 default: llvm_unreachable("Unknown binary operator constant cast expr");
Jim Grosbach13760bd2015-05-30 01:25:56 +00002167 case Instruction::Add: return MCBinaryExpr::createAdd(LHS, RHS, Ctx);
2168 case Instruction::Sub: return MCBinaryExpr::createSub(LHS, RHS, Ctx);
2169 case Instruction::Mul: return MCBinaryExpr::createMul(LHS, RHS, Ctx);
2170 case Instruction::SDiv: return MCBinaryExpr::createDiv(LHS, RHS, Ctx);
2171 case Instruction::SRem: return MCBinaryExpr::createMod(LHS, RHS, Ctx);
2172 case Instruction::Shl: return MCBinaryExpr::createShl(LHS, RHS, Ctx);
2173 case Instruction::And: return MCBinaryExpr::createAnd(LHS, RHS, Ctx);
2174 case Instruction::Or: return MCBinaryExpr::createOr (LHS, RHS, Ctx);
2175 case Instruction::Xor: return MCBinaryExpr::createXor(LHS, RHS, Ctx);
Chris Lattner7e0c1642010-01-13 04:29:19 +00002176 }
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002177 }
Chris Lattner6a8e0f52004-08-16 23:15:22 +00002178 }
2179}
Chris Lattner8452a1f2004-08-17 06:36:49 +00002180
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002181static void emitGlobalConstantImpl(const DataLayout &DL, const Constant *C,
2182 AsmPrinter &AP,
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002183 const Constant *BaseCV = nullptr,
2184 uint64_t Offset = 0);
Chris Lattner51003672010-04-20 06:20:21 +00002185
Justin Bogner3135ba92015-12-08 02:37:48 +00002186static void emitGlobalConstantFP(const ConstantFP *CFP, AsmPrinter &AP);
Alina Sbirlea08fa5942018-03-09 18:48:20 +00002187static void emitGlobalConstantFP(APFloat APF, Type *ET, AsmPrinter &AP);
Justin Bogner3135ba92015-12-08 02:37:48 +00002188
David Greenecdef71f2011-08-31 17:30:56 +00002189/// isRepeatedByteSequence - Determine whether the given value is
2190/// composed of a repeated sequence of identical bytes and return the
2191/// byte value. If it is not a repeated sequence, return -1.
Chris Lattner5d4497b2012-01-24 09:31:43 +00002192static int isRepeatedByteSequence(const ConstantDataSequential *V) {
2193 StringRef Data = V->getRawDataValues();
2194 assert(!Data.empty() && "Empty aggregates should be CAZ node");
2195 char C = Data[0];
2196 for (unsigned i = 1, e = Data.size(); i != e; ++i)
2197 if (Data[i] != C) return -1;
Chandler Carruth2c469ff2012-01-30 23:47:44 +00002198 return static_cast<uint8_t>(C); // Ensure 255 is not returned as -1.
Chris Lattner5d4497b2012-01-24 09:31:43 +00002199}
2200
Chris Lattner5d4497b2012-01-24 09:31:43 +00002201/// isRepeatedByteSequence - Determine whether the given value is
2202/// composed of a repeated sequence of identical bytes and return the
2203/// byte value. If it is not a repeated sequence, return -1.
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002204static int isRepeatedByteSequence(const Value *V, const DataLayout &DL) {
David Greenecdef71f2011-08-31 17:30:56 +00002205 if (const ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002206 uint64_t Size = DL.getTypeAllocSizeInBits(V->getType());
Benjamin Kramerc6e8bfc2015-06-17 23:55:17 +00002207 assert(Size % 8 == 0);
David Greenecdef71f2011-08-31 17:30:56 +00002208
Benjamin Kramerc6e8bfc2015-06-17 23:55:17 +00002209 // Extend the element to take zero padding into account.
2210 APInt Value = CI->getValue().zextOrSelf(Size);
2211 if (!Value.isSplat(8))
2212 return -1;
David Greenecdef71f2011-08-31 17:30:56 +00002213
Benjamin Kramerc6e8bfc2015-06-17 23:55:17 +00002214 return Value.zextOrTrunc(8).getZExtValue();
David Greenecdef71f2011-08-31 17:30:56 +00002215 }
2216 if (const ConstantArray *CA = dyn_cast<ConstantArray>(V)) {
2217 // Make sure all array elements are sequences of the same repeated
2218 // byte.
Chris Lattner5d4497b2012-01-24 09:31:43 +00002219 assert(CA->getNumOperands() != 0 && "Should be a CAZ");
Benjamin Kramerc6e8bfc2015-06-17 23:55:17 +00002220 Constant *Op0 = CA->getOperand(0);
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002221 int Byte = isRepeatedByteSequence(Op0, DL);
Benjamin Kramerc6e8bfc2015-06-17 23:55:17 +00002222 if (Byte == -1)
2223 return -1;
David Greenecdef71f2011-08-31 17:30:56 +00002224
Benjamin Kramerc6e8bfc2015-06-17 23:55:17 +00002225 // All array elements must be equal.
2226 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i)
2227 if (CA->getOperand(i) != Op0)
2228 return -1;
David Greenecdef71f2011-08-31 17:30:56 +00002229 return Byte;
2230 }
Eric Christopher7c718e42012-11-20 20:34:44 +00002231
Chris Lattner5d4497b2012-01-24 09:31:43 +00002232 if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(V))
2233 return isRepeatedByteSequence(CDS);
David Greenecdef71f2011-08-31 17:30:56 +00002234
2235 return -1;
2236}
2237
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002238static void emitGlobalConstantDataSequential(const DataLayout &DL,
2239 const ConstantDataSequential *CDS,
2240 AsmPrinter &AP) {
Chris Lattner5d4497b2012-01-24 09:31:43 +00002241 // See if we can aggregate this into a .fill, if so, emit it as such.
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002242 int Value = isRepeatedByteSequence(CDS, DL);
Chris Lattner5d4497b2012-01-24 09:31:43 +00002243 if (Value != -1) {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002244 uint64_t Bytes = DL.getTypeAllocSize(CDS->getType());
Chris Lattner0d3785e2012-01-31 03:39:24 +00002245 // Don't emit a 1-byte object as a .fill.
2246 if (Bytes > 1)
Petr Hosekfaef3202016-06-01 01:59:58 +00002247 return AP.OutStreamer->emitFill(Bytes, Value);
Chris Lattner5d4497b2012-01-24 09:31:43 +00002248 }
Eric Christopher7c718e42012-11-20 20:34:44 +00002249
Chris Lattner5d4497b2012-01-24 09:31:43 +00002250 // If this can be emitted with .ascii/.asciz, emit it as such.
2251 if (CDS->isString())
Lang Hames9ff69c82015-04-24 19:11:51 +00002252 return AP.OutStreamer->EmitBytes(CDS->getAsString());
Chris Lattner5d4497b2012-01-24 09:31:43 +00002253
2254 // Otherwise, emit the values in successive locations.
2255 unsigned ElementByteSize = CDS->getElementByteSize();
2256 if (isa<IntegerType>(CDS->getElementType())) {
Chris Lattner9be59592012-01-25 01:27:20 +00002257 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
Chris Lattner829400b2012-01-30 05:55:11 +00002258 if (AP.isVerbose())
Lang Hames9ff69c82015-04-24 19:11:51 +00002259 AP.OutStreamer->GetCommentOS() << format("0x%" PRIx64 "\n",
2260 CDS->getElementAsInteger(i));
2261 AP.OutStreamer->EmitIntValue(CDS->getElementAsInteger(i),
2262 ElementByteSize);
Chris Lattner5d4497b2012-01-24 09:31:43 +00002263 }
Chris Lattner51ebe142012-01-30 05:49:43 +00002264 } else {
Alina Sbirlea08fa5942018-03-09 18:48:20 +00002265 Type *ET = CDS->getElementType();
Justin Bogner3135ba92015-12-08 02:37:48 +00002266 for (unsigned I = 0, E = CDS->getNumElements(); I != E; ++I)
Alina Sbirlea08fa5942018-03-09 18:48:20 +00002267 emitGlobalConstantFP(CDS->getElementAsAPFloat(I), ET, AP);
Chris Lattner5d4497b2012-01-24 09:31:43 +00002268 }
2269
Matt Arsenault40dddd72013-10-03 19:50:01 +00002270 unsigned Size = DL.getTypeAllocSize(CDS->getType());
2271 unsigned EmittedSize = DL.getTypeAllocSize(CDS->getType()->getElementType()) *
Chris Lattner51ebe142012-01-30 05:49:43 +00002272 CDS->getNumElements();
Krzysztof Parzyszek5e3aba82018-05-02 17:20:22 +00002273 assert(EmittedSize <= Size && "Size cannot be less than EmittedSize!");
Chris Lattner51ebe142012-01-30 05:49:43 +00002274 if (unsigned Padding = Size - EmittedSize)
Lang Hames9ff69c82015-04-24 19:11:51 +00002275 AP.OutStreamer->EmitZeros(Padding);
Chris Lattner5d4497b2012-01-24 09:31:43 +00002276}
2277
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002278static void emitGlobalConstantArray(const DataLayout &DL,
2279 const ConstantArray *CA, AsmPrinter &AP,
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002280 const Constant *BaseCV, uint64_t Offset) {
Chris Lattnercf9e8f62012-02-05 02:29:43 +00002281 // See if we can aggregate some values. Make sure it can be
2282 // represented as a series of bytes of the constant value.
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002283 int Value = isRepeatedByteSequence(CA, DL);
David Greenecdef71f2011-08-31 17:30:56 +00002284
Chris Lattnercf9e8f62012-02-05 02:29:43 +00002285 if (Value != -1) {
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002286 uint64_t Bytes = DL.getTypeAllocSize(CA->getType());
Petr Hosekfaef3202016-06-01 01:59:58 +00002287 AP.OutStreamer->emitFill(Bytes, Value);
Dan Gohman014caa42008-12-22 21:14:27 +00002288 }
Chris Lattnercf9e8f62012-02-05 02:29:43 +00002289 else {
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002290 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i) {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002291 emitGlobalConstantImpl(DL, CA->getOperand(i), AP, BaseCV, Offset);
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002292 Offset += DL.getTypeAllocSize(CA->getOperand(i)->getType());
2293 }
Chris Lattnercf9e8f62012-02-05 02:29:43 +00002294 }
Dan Gohman014caa42008-12-22 21:14:27 +00002295}
2296
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002297static void emitGlobalConstantVector(const DataLayout &DL,
2298 const ConstantVector *CV, AsmPrinter &AP) {
Chris Lattner71601e82010-01-20 07:41:15 +00002299 for (unsigned i = 0, e = CV->getType()->getNumElements(); i != e; ++i)
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002300 emitGlobalConstantImpl(DL, CV->getOperand(i), AP);
Nick Lewycky6208a2f2011-06-22 18:55:03 +00002301
Matt Arsenault40dddd72013-10-03 19:50:01 +00002302 unsigned Size = DL.getTypeAllocSize(CV->getType());
2303 unsigned EmittedSize = DL.getTypeAllocSize(CV->getType()->getElementType()) *
Nick Lewycky6208a2f2011-06-22 18:55:03 +00002304 CV->getType()->getNumElements();
2305 if (unsigned Padding = Size - EmittedSize)
Lang Hames9ff69c82015-04-24 19:11:51 +00002306 AP.OutStreamer->EmitZeros(Padding);
Dan Gohman014caa42008-12-22 21:14:27 +00002307}
2308
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002309static void emitGlobalConstantStruct(const DataLayout &DL,
2310 const ConstantStruct *CS, AsmPrinter &AP,
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002311 const Constant *BaseCV, uint64_t Offset) {
Dan Gohman014caa42008-12-22 21:14:27 +00002312 // Print the fields in successive locations. Pad to align if needed!
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002313 unsigned Size = DL.getTypeAllocSize(CS->getType());
2314 const StructLayout *Layout = DL.getStructLayout(CS->getType());
Chris Lattnerfefcb152010-01-19 19:10:44 +00002315 uint64_t SizeSoFar = 0;
2316 for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i) {
Chris Lattner71601e82010-01-20 07:41:15 +00002317 const Constant *Field = CS->getOperand(i);
Dan Gohman014caa42008-12-22 21:14:27 +00002318
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002319 // Print the actual field value.
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002320 emitGlobalConstantImpl(DL, Field, AP, BaseCV, Offset + SizeSoFar);
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002321
Dan Gohman014caa42008-12-22 21:14:27 +00002322 // Check if padding is needed and insert one or more 0s.
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002323 uint64_t FieldSize = DL.getTypeAllocSize(Field->getType());
Chris Lattner03cb2a302010-01-20 07:11:32 +00002324 uint64_t PadSize = ((i == e-1 ? Size : Layout->getElementOffset(i+1))
2325 - Layout->getElementOffset(i)) - FieldSize;
2326 SizeSoFar += FieldSize + PadSize;
Dan Gohman014caa42008-12-22 21:14:27 +00002327
Dan Gohman014caa42008-12-22 21:14:27 +00002328 // Insert padding - this may include padding to increase the size of the
2329 // current field up to the ABI size (if the struct is not packed) as well
2330 // as padding to ensure that the next field starts at the right offset.
Lang Hames9ff69c82015-04-24 19:11:51 +00002331 AP.OutStreamer->EmitZeros(PadSize);
Dan Gohman014caa42008-12-22 21:14:27 +00002332 }
Chris Lattner03cb2a302010-01-20 07:11:32 +00002333 assert(SizeSoFar == Layout->getSizeInBytes() &&
Dan Gohman014caa42008-12-22 21:14:27 +00002334 "Layout of constant struct may be incorrect!");
2335}
2336
Alina Sbirlea08fa5942018-03-09 18:48:20 +00002337static void emitGlobalConstantFP(APFloat APF, Type *ET, AsmPrinter &AP) {
2338 APInt API = APF.bitcastToAPInt();
Tim Northover3a51aab2013-01-11 10:36:13 +00002339
2340 // First print a comment with what we think the original floating-point value
2341 // should have been.
2342 if (AP.isVerbose()) {
2343 SmallString<8> StrVal;
Alina Sbirlea08fa5942018-03-09 18:48:20 +00002344 APF.toString(StrVal);
Tim Northover3a51aab2013-01-11 10:36:13 +00002345
Alina Sbirlea08fa5942018-03-09 18:48:20 +00002346 if (ET)
2347 ET->print(AP.OutStreamer->GetCommentOS());
Richard Trieuc1485222014-06-21 02:43:02 +00002348 else
Lang Hames9ff69c82015-04-24 19:11:51 +00002349 AP.OutStreamer->GetCommentOS() << "Printing <null> Type";
2350 AP.OutStreamer->GetCommentOS() << ' ' << StrVal << '\n';
Chris Lattnereaef5e12010-01-19 22:16:33 +00002351 }
Tim Northover3a51aab2013-01-11 10:36:13 +00002352
2353 // Now iterate through the APInt chunks, emitting them in endian-correct
2354 // order, possibly with a smaller chunk at beginning/end (e.g. for x87 80-bit
2355 // floats).
2356 unsigned NumBytes = API.getBitWidth() / 8;
2357 unsigned TrailingBytes = NumBytes % sizeof(uint64_t);
2358 const uint64_t *p = API.getRawData();
2359
2360 // PPC's long double has odd notions of endianness compared to how LLVM
2361 // handles it: p[0] goes first for *big* endian on PPC.
Alina Sbirlea08fa5942018-03-09 18:48:20 +00002362 if (AP.getDataLayout().isBigEndian() && !ET->isPPC_FP128Ty()) {
Tim Northover3a51aab2013-01-11 10:36:13 +00002363 int Chunk = API.getNumWords() - 1;
2364
2365 if (TrailingBytes)
Lang Hames9ff69c82015-04-24 19:11:51 +00002366 AP.OutStreamer->EmitIntValue(p[Chunk--], TrailingBytes);
Tim Northover3a51aab2013-01-11 10:36:13 +00002367
2368 for (; Chunk >= 0; --Chunk)
Lang Hames9ff69c82015-04-24 19:11:51 +00002369 AP.OutStreamer->EmitIntValue(p[Chunk], sizeof(uint64_t));
Tim Northover3a51aab2013-01-11 10:36:13 +00002370 } else {
2371 unsigned Chunk;
2372 for (Chunk = 0; Chunk < NumBytes / sizeof(uint64_t); ++Chunk)
Lang Hames9ff69c82015-04-24 19:11:51 +00002373 AP.OutStreamer->EmitIntValue(p[Chunk], sizeof(uint64_t));
Tim Northover3a51aab2013-01-11 10:36:13 +00002374
2375 if (TrailingBytes)
Lang Hames9ff69c82015-04-24 19:11:51 +00002376 AP.OutStreamer->EmitIntValue(p[Chunk], TrailingBytes);
Tim Northover3a51aab2013-01-11 10:36:13 +00002377 }
2378
2379 // Emit the tail padding for the long double.
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002380 const DataLayout &DL = AP.getDataLayout();
Alina Sbirlea08fa5942018-03-09 18:48:20 +00002381 AP.OutStreamer->EmitZeros(DL.getTypeAllocSize(ET) - DL.getTypeStoreSize(ET));
2382}
2383
2384static void emitGlobalConstantFP(const ConstantFP *CFP, AsmPrinter &AP) {
2385 emitGlobalConstantFP(CFP->getValueAPF(), CFP->getType(), AP);
Dan Gohman014caa42008-12-22 21:14:27 +00002386}
2387
Rafael Espindola64e1af82013-07-02 15:49:13 +00002388static void emitGlobalConstantLargeInt(const ConstantInt *CI, AsmPrinter &AP) {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002389 const DataLayout &DL = AP.getDataLayout();
Dan Gohman014caa42008-12-22 21:14:27 +00002390 unsigned BitWidth = CI->getBitWidth();
Quentin Colombetba366012013-06-07 18:36:03 +00002391
2392 // Copy the value as we may massage the layout for constants whose bit width
2393 // is not a multiple of 64-bits.
2394 APInt Realigned(CI->getValue());
2395 uint64_t ExtraBits = 0;
2396 unsigned ExtraBitsSize = BitWidth & 63;
2397
2398 if (ExtraBitsSize) {
2399 // The bit width of the data is not a multiple of 64-bits.
2400 // The extra bits are expected to be at the end of the chunk of the memory.
2401 // Little endian:
2402 // * Nothing to be done, just record the extra bits to emit.
2403 // Big endian:
2404 // * Record the extra bits to emit.
2405 // * Realign the raw data to emit the chunks of 64-bits.
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002406 if (DL.isBigEndian()) {
Quentin Colombetba366012013-06-07 18:36:03 +00002407 // Basically the structure of the raw data is a chunk of 64-bits cells:
2408 // 0 1 BitWidth / 64
2409 // [chunk1][chunk2] ... [chunkN].
2410 // The most significant chunk is chunkN and it should be emitted first.
2411 // However, due to the alignment issue chunkN contains useless bits.
2412 // Realign the chunks so that they contain only useless information:
2413 // ExtraBits 0 1 (BitWidth / 64) - 1
2414 // chu[nk1 chu][nk2 chu] ... [nkN-1 chunkN]
2415 ExtraBits = Realigned.getRawData()[0] &
2416 (((uint64_t)-1) >> (64 - ExtraBitsSize));
Craig Topperfc947bc2017-04-18 17:14:21 +00002417 Realigned.lshrInPlace(ExtraBitsSize);
Quentin Colombetba366012013-06-07 18:36:03 +00002418 } else
2419 ExtraBits = Realigned.getRawData()[BitWidth / 64];
2420 }
Dan Gohman014caa42008-12-22 21:14:27 +00002421
2422 // We don't expect assemblers to support integer data directives
2423 // for more than 64 bits, so we emit the data in at most 64-bit
2424 // quantities at a time.
Quentin Colombetba366012013-06-07 18:36:03 +00002425 const uint64_t *RawData = Realigned.getRawData();
Dan Gohman014caa42008-12-22 21:14:27 +00002426 for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002427 uint64_t Val = DL.isBigEndian() ? RawData[e - i - 1] : RawData[i];
Lang Hames9ff69c82015-04-24 19:11:51 +00002428 AP.OutStreamer->EmitIntValue(Val, 8);
Dan Gohman014caa42008-12-22 21:14:27 +00002429 }
Quentin Colombetba366012013-06-07 18:36:03 +00002430
2431 if (ExtraBitsSize) {
2432 // Emit the extra bits after the 64-bits chunks.
2433
2434 // Emit a directive that fills the expected size.
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002435 uint64_t Size = AP.getDataLayout().getTypeAllocSize(CI->getType());
Quentin Colombetba366012013-06-07 18:36:03 +00002436 Size -= (BitWidth / 64) * 8;
2437 assert(Size && Size * 8 >= ExtraBitsSize &&
2438 (ExtraBits & (((uint64_t)-1) >> (64 - ExtraBitsSize)))
2439 == ExtraBits && "Directive too small for extra bits.");
Lang Hames9ff69c82015-04-24 19:11:51 +00002440 AP.OutStreamer->EmitIntValue(ExtraBits, Size);
Quentin Colombetba366012013-06-07 18:36:03 +00002441 }
Dan Gohman014caa42008-12-22 21:14:27 +00002442}
2443
Adrian Prantl5f8f34e42018-05-01 15:54:18 +00002444/// Transform a not absolute MCExpr containing a reference to a GOT
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002445/// equivalent global, by a target specific GOT pc relative access to the
2446/// final symbol.
2447static void handleIndirectSymViaGOTPCRel(AsmPrinter &AP, const MCExpr **ME,
2448 const Constant *BaseCst,
2449 uint64_t Offset) {
2450 // The global @foo below illustrates a global that uses a got equivalent.
2451 //
2452 // @bar = global i32 42
2453 // @gotequiv = private unnamed_addr constant i32* @bar
2454 // @foo = i32 trunc (i64 sub (i64 ptrtoint (i32** @gotequiv to i64),
2455 // i64 ptrtoint (i32* @foo to i64))
2456 // to i32)
2457 //
2458 // The cstexpr in @foo is converted into the MCExpr `ME`, where we actually
2459 // check whether @foo is suitable to use a GOTPCREL. `ME` is usually in the
2460 // form:
2461 //
2462 // foo = cstexpr, where
2463 // cstexpr := <gotequiv> - "." + <cst>
2464 // cstexpr := <gotequiv> - (<foo> - <offset from @foo base>) + <cst>
2465 //
Jim Grosbach13760bd2015-05-30 01:25:56 +00002466 // After canonicalization by evaluateAsRelocatable `ME` turns into:
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002467 //
2468 // cstexpr := <gotequiv> - <foo> + gotpcrelcst, where
2469 // gotpcrelcst := <offset from @foo base> + <cst>
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002470 MCValue MV;
Jim Grosbach13760bd2015-05-30 01:25:56 +00002471 if (!(*ME)->evaluateAsRelocatable(MV, nullptr, nullptr) || MV.isAbsolute())
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002472 return;
Bruno Cardoso Lopesedb876d2015-06-25 15:17:23 +00002473 const MCSymbolRefExpr *SymA = MV.getSymA();
2474 if (!SymA)
2475 return;
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002476
Bruno Cardoso Lopesedb876d2015-06-25 15:17:23 +00002477 // Check that GOT equivalent symbol is cached.
2478 const MCSymbol *GOTEquivSym = &SymA->getSymbol();
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002479 if (!AP.GlobalGOTEquivs.count(GOTEquivSym))
2480 return;
2481
Bruno Cardoso Lopese8640512015-07-21 21:45:42 +00002482 const GlobalValue *BaseGV = dyn_cast_or_null<GlobalValue>(BaseCst);
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002483 if (!BaseGV)
2484 return;
2485
Bruno Cardoso Lopesedb876d2015-06-25 15:17:23 +00002486 // Check for a valid base symbol
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002487 const MCSymbol *BaseSym = AP.getSymbol(BaseGV);
Bruno Cardoso Lopesedb876d2015-06-25 15:17:23 +00002488 const MCSymbolRefExpr *SymB = MV.getSymB();
2489
2490 if (!SymB || BaseSym != &SymB->getSymbol())
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002491 return;
2492
2493 // Make sure to match:
2494 //
2495 // gotpcrelcst := <offset from @foo base> + <cst>
2496 //
Bruno Cardoso Lopes618c67a2015-03-06 13:49:05 +00002497 // If gotpcrelcst is positive it means that we can safely fold the pc rel
2498 // displacement into the GOTPCREL. We can also can have an extra offset <cst>
2499 // if the target knows how to encode it.
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002500 int64_t GOTPCRelCst = Offset + MV.getConstant();
2501 if (GOTPCRelCst < 0)
2502 return;
Bruno Cardoso Lopes52b13912015-03-06 13:48:45 +00002503 if (!AP.getObjFileLowering().supportGOTPCRelWithOffset() && GOTPCRelCst != 0)
2504 return;
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002505
2506 // Emit the GOT PC relative to replace the got equivalent global, i.e.:
2507 //
2508 // bar:
2509 // .long 42
2510 // gotequiv:
2511 // .quad bar
2512 // foo:
2513 // .long gotequiv - "." + <cst>
2514 //
2515 // is replaced by the target specific equivalent to:
2516 //
2517 // bar:
2518 // .long 42
2519 // foo:
2520 // .long bar@GOTPCREL+<gotpcrelcst>
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002521 AsmPrinter::GOTEquivUsePair Result = AP.GlobalGOTEquivs[GOTEquivSym];
2522 const GlobalVariable *GV = Result.first;
Bruno Cardoso Lopesb3a58b42015-03-10 20:05:23 +00002523 int NumUses = (int)Result.second;
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002524 const GlobalValue *FinalGV = dyn_cast<GlobalValue>(GV->getOperand(0));
2525 const MCSymbol *FinalSym = AP.getSymbol(FinalGV);
Bruno Cardoso Lopes618c67a2015-03-06 13:49:05 +00002526 *ME = AP.getObjFileLowering().getIndirectSymViaGOTPCRel(
Lang Hames9ff69c82015-04-24 19:11:51 +00002527 FinalSym, MV, Offset, AP.MMI, *AP.OutStreamer);
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002528
2529 // Update GOT equivalent usage information
2530 --NumUses;
Bruno Cardoso Lopesb3a58b42015-03-10 20:05:23 +00002531 if (NumUses >= 0)
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002532 AP.GlobalGOTEquivs[GOTEquivSym] = std::make_pair(GV, NumUses);
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002533}
2534
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002535static void emitGlobalConstantImpl(const DataLayout &DL, const Constant *CV,
2536 AsmPrinter &AP, const Constant *BaseCV,
2537 uint64_t Offset) {
2538 uint64_t Size = DL.getTypeAllocSize(CV->getType());
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002539
2540 // Globals with sub-elements such as combinations of arrays and structs
2541 // are handled recursively by emitGlobalConstantImpl. Keep track of the
2542 // constant symbol base and the current position with BaseCV and Offset.
2543 if (!BaseCV && CV->hasOneUse())
2544 BaseCV = dyn_cast<Constant>(CV->user_back());
2545
Bill Wendling7315c4b2012-03-20 08:56:43 +00002546 if (isa<ConstantAggregateZero>(CV) || isa<UndefValue>(CV))
Lang Hames9ff69c82015-04-24 19:11:51 +00002547 return AP.OutStreamer->EmitZeros(Size);
Chris Lattner03cb2a302010-01-20 07:11:32 +00002548
2549 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
Chris Lattner03cb2a302010-01-20 07:11:32 +00002550 switch (Size) {
2551 case 1:
2552 case 2:
2553 case 4:
2554 case 8:
Chris Lattner51003672010-04-20 06:20:21 +00002555 if (AP.isVerbose())
Lang Hames9ff69c82015-04-24 19:11:51 +00002556 AP.OutStreamer->GetCommentOS() << format("0x%" PRIx64 "\n",
2557 CI->getZExtValue());
2558 AP.OutStreamer->EmitIntValue(CI->getZExtValue(), Size);
Chris Lattner03cb2a302010-01-20 07:11:32 +00002559 return;
2560 default:
Rafael Espindola64e1af82013-07-02 15:49:13 +00002561 emitGlobalConstantLargeInt(CI, AP);
Chris Lattner03cb2a302010-01-20 07:11:32 +00002562 return;
2563 }
2564 }
Jim Grosbach1900c732011-03-29 23:20:22 +00002565
Chris Lattnerfefcb152010-01-19 19:10:44 +00002566 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV))
Rafael Espindola64e1af82013-07-02 15:49:13 +00002567 return emitGlobalConstantFP(CFP, AP);
Chris Lattner8452a1f2004-08-17 06:36:49 +00002568
Chris Lattnerc47ece52010-01-20 17:57:50 +00002569 if (isa<ConstantPointerNull>(CV)) {
Lang Hames9ff69c82015-04-24 19:11:51 +00002570 AP.OutStreamer->EmitIntValue(0, Size);
Chris Lattnerc47ece52010-01-20 17:57:50 +00002571 return;
2572 }
Jim Grosbach1900c732011-03-29 23:20:22 +00002573
Chris Lattner5d4497b2012-01-24 09:31:43 +00002574 if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(CV))
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002575 return emitGlobalConstantDataSequential(DL, CDS, AP);
Eric Christopher7c718e42012-11-20 20:34:44 +00002576
Chris Lattner5d4497b2012-01-24 09:31:43 +00002577 if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV))
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002578 return emitGlobalConstantArray(DL, CVA, AP, BaseCV, Offset);
Jim Grosbach1900c732011-03-29 23:20:22 +00002579
Chris Lattner5d4497b2012-01-24 09:31:43 +00002580 if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV))
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002581 return emitGlobalConstantStruct(DL, CVS, AP, BaseCV, Offset);
Chris Lattner5d4497b2012-01-24 09:31:43 +00002582
Bill Wendling7315c4b2012-03-20 08:56:43 +00002583 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
2584 // Look through bitcasts, which might not be able to be MCExpr'ized (e.g. of
2585 // vectors).
Chris Lattner5d4497b2012-01-24 09:31:43 +00002586 if (CE->getOpcode() == Instruction::BitCast)
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002587 return emitGlobalConstantImpl(DL, CE->getOperand(0), AP);
Bill Wendling7315c4b2012-03-20 08:56:43 +00002588
2589 if (Size > 8) {
2590 // If the constant expression's size is greater than 64-bits, then we have
2591 // to emit the value in chunks. Try to constant fold the value and emit it
2592 // that way.
David Majnemerd536f232016-07-29 03:27:26 +00002593 Constant *New = ConstantFoldConstant(CE, DL);
Bill Wendling7315c4b2012-03-20 08:56:43 +00002594 if (New && New != CE)
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002595 return emitGlobalConstantImpl(DL, New, AP);
Bill Wendling7315c4b2012-03-20 08:56:43 +00002596 }
2597 }
Eric Christopher7c718e42012-11-20 20:34:44 +00002598
Chris Lattner5d4497b2012-01-24 09:31:43 +00002599 if (const ConstantVector *V = dyn_cast<ConstantVector>(CV))
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002600 return emitGlobalConstantVector(DL, V, AP);
Eric Christopher7c718e42012-11-20 20:34:44 +00002601
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002602 // Otherwise, it must be a ConstantExpr. Lower it to an MCExpr, then emit it
2603 // thread the streamer with EmitValue.
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002604 const MCExpr *ME = AP.lowerConstant(CV);
2605
2606 // Since lowerConstant already folded and got rid of all IR pointer and
2607 // integer casts, detect GOT equivalent accesses by looking into the MCExpr
2608 // directly.
2609 if (AP.getObjFileLowering().supportIndirectSymViaGOTPCRel())
2610 handleIndirectSymViaGOTPCRel(AP, &ME, BaseCV, Offset);
2611
Lang Hames9ff69c82015-04-24 19:11:51 +00002612 AP.OutStreamer->EmitValue(ME, Size);
Chris Lattner51003672010-04-20 06:20:21 +00002613}
2614
2615/// EmitGlobalConstant - Print a general LLVM constant to the .s file.
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002616void AsmPrinter::EmitGlobalConstant(const DataLayout &DL, const Constant *CV) {
2617 uint64_t Size = DL.getTypeAllocSize(CV->getType());
Chris Lattner51003672010-04-20 06:20:21 +00002618 if (Size)
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002619 emitGlobalConstantImpl(DL, CV, *this);
Chris Lattner51003672010-04-20 06:20:21 +00002620 else if (MAI->hasSubsectionsViaSymbols()) {
2621 // If the global has zero size, emit a single byte so that two labels don't
2622 // look like they are at the same location.
Lang Hames9ff69c82015-04-24 19:11:51 +00002623 OutStreamer->EmitIntValue(0, 1);
Chris Lattner51003672010-04-20 06:20:21 +00002624 }
Chris Lattner8452a1f2004-08-17 06:36:49 +00002625}
Chris Lattner061d9e22006-01-27 02:10:10 +00002626
Chris Lattner17f71652008-08-17 07:19:36 +00002627void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
Evan Cheng45fe3bc2006-09-12 21:00:35 +00002628 // Target doesn't support this yet!
Torok Edwinfbcc6632009-07-14 16:55:14 +00002629 llvm_unreachable("Target does not support EmitMachineConstantPoolValue");
Evan Cheng45fe3bc2006-09-12 21:00:35 +00002630}
2631
Chris Lattnerc334d802010-04-04 18:16:38 +00002632void AsmPrinter::printOffset(int64_t Offset, raw_ostream &OS) const {
2633 if (Offset > 0)
2634 OS << '+' << Offset;
2635 else if (Offset < 0)
2636 OS << Offset;
2637}
2638
Chris Lattnera179b522010-04-04 19:25:43 +00002639//===----------------------------------------------------------------------===//
2640// Symbol Lowering Routines.
2641//===----------------------------------------------------------------------===//
2642
Rafael Espindola9ab09232015-03-17 20:07:06 +00002643MCSymbol *AsmPrinter::createTempSymbol(const Twine &Name) const {
2644 return OutContext.createTempSymbol(Name, true);
Rafael Espindola629cdba2015-02-27 18:18:39 +00002645}
Chris Lattneraa23fa92006-02-01 22:41:11 +00002646
Chris Lattnerebc970e2010-02-08 23:10:08 +00002647MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BlockAddress *BA) const {
Chris Lattner9efbbcb2010-03-14 17:53:23 +00002648 return MMI->getAddrLabelSymbol(BA->getBasicBlock());
Dan Gohman6c938802009-10-30 01:27:03 +00002649}
2650
Chris Lattner9efbbcb2010-03-14 17:53:23 +00002651MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BasicBlock *BB) const {
2652 return MMI->getAddrLabelSymbol(BB);
Dan Gohman6c938802009-10-30 01:27:03 +00002653}
2654
Chris Lattner4225a7b2010-01-23 05:19:23 +00002655/// GetCPISymbol - Return the symbol for the specified constant pool entry.
2656MCSymbol *AsmPrinter::GetCPISymbol(unsigned CPID) const {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002657 const DataLayout &DL = getDataLayout();
2658 return OutContext.getOrCreateSymbol(Twine(DL.getPrivateGlobalPrefix()) +
2659 "CPI" + Twine(getFunctionNumber()) + "_" +
2660 Twine(CPID));
Chris Lattner4225a7b2010-01-23 05:19:23 +00002661}
2662
2663/// GetJTISymbol - Return the symbol for the specified jump table entry.
Bill Wendling36321712010-06-29 22:34:52 +00002664MCSymbol *AsmPrinter::GetJTISymbol(unsigned JTID, bool isLinkerPrivate) const {
2665 return MF->getJTISymbol(JTID, OutContext, isLinkerPrivate);
Chris Lattnera602beb2009-09-12 23:02:08 +00002666}
2667
Chris Lattner00d188f2010-01-25 21:17:10 +00002668/// GetJTSetSymbol - Return the symbol for the specified jump table .set
2669/// FIXME: privatize to AsmPrinter.
2670MCSymbol *AsmPrinter::GetJTSetSymbol(unsigned UID, unsigned MBBID) const {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002671 const DataLayout &DL = getDataLayout();
2672 return OutContext.getOrCreateSymbol(Twine(DL.getPrivateGlobalPrefix()) +
2673 Twine(getFunctionNumber()) + "_" +
2674 Twine(UID) + "_set_" + Twine(MBBID));
Chris Lattner00d188f2010-01-25 21:17:10 +00002675}
2676
Rafael Espindolaf4e6b292013-12-02 16:25:47 +00002677MCSymbol *AsmPrinter::getSymbolWithGlobalValueBase(const GlobalValue *GV,
Rafael Espindola61b3d0c2013-11-28 19:35:07 +00002678 StringRef Suffix) const {
Eric Christopher4367c7f2016-09-16 07:33:15 +00002679 return getObjFileLowering().getSymbolWithGlobalValueBase(GV, Suffix, TM);
Chris Lattner0dca0a92010-01-15 23:25:11 +00002680}
2681
Rafael Espindolac233f742015-06-23 13:59:29 +00002682/// Return the MCSymbol for the specified ExternalSymbol.
Chris Lattner91687f62010-01-15 23:18:17 +00002683MCSymbol *AsmPrinter::GetExternalSymbolSymbol(StringRef Sym) const {
2684 SmallString<60> NameStr;
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002685 Mangler::getNameWithPrefix(NameStr, Sym, getDataLayout());
Jim Grosbach6f482002015-05-18 18:43:14 +00002686 return OutContext.getOrCreateSymbol(NameStr);
Jim Grosbach1900c732011-03-29 23:20:22 +00002687}
Chris Lattner91687f62010-01-15 23:18:17 +00002688
Chris Lattner978e2f02010-01-22 21:50:41 +00002689/// PrintParentLoopComment - Print comments about parent loops of this one.
2690static void PrintParentLoopComment(raw_ostream &OS, const MachineLoop *Loop,
2691 unsigned FunctionNumber) {
Craig Topper353eda42014-04-24 06:44:33 +00002692 if (!Loop) return;
Chris Lattner978e2f02010-01-22 21:50:41 +00002693 PrintParentLoopComment(OS, Loop->getParentLoop(), FunctionNumber);
2694 OS.indent(Loop->getLoopDepth()*2)
2695 << "Parent Loop BB" << FunctionNumber << "_"
2696 << Loop->getHeader()->getNumber()
2697 << " Depth=" << Loop->getLoopDepth() << '\n';
2698}
2699
Chris Lattner978e2f02010-01-22 21:50:41 +00002700/// PrintChildLoopComment - Print comments about child loops within
2701/// the loop for this basic block, with nesting.
2702static void PrintChildLoopComment(raw_ostream &OS, const MachineLoop *Loop,
2703 unsigned FunctionNumber) {
2704 // Add child loop information
Jim Grosbach6623e7f2014-04-16 22:38:02 +00002705 for (const MachineLoop *CL : *Loop) {
2706 OS.indent(CL->getLoopDepth()*2)
Chris Lattner978e2f02010-01-22 21:50:41 +00002707 << "Child Loop BB" << FunctionNumber << "_"
Jim Grosbach6623e7f2014-04-16 22:38:02 +00002708 << CL->getHeader()->getNumber() << " Depth " << CL->getLoopDepth()
Chris Lattner978e2f02010-01-22 21:50:41 +00002709 << '\n';
Jim Grosbach6623e7f2014-04-16 22:38:02 +00002710 PrintChildLoopComment(OS, CL, FunctionNumber);
Chris Lattner978e2f02010-01-22 21:50:41 +00002711 }
2712}
2713
Chad Rosierb759ede2012-09-07 18:16:38 +00002714/// emitBasicBlockLoopComments - Pretty-print comments for basic blocks.
2715static void emitBasicBlockLoopComments(const MachineBasicBlock &MBB,
Chris Lattnerc334d802010-04-04 18:16:38 +00002716 const MachineLoopInfo *LI,
2717 const AsmPrinter &AP) {
Chris Lattner978e2f02010-01-22 21:50:41 +00002718 // Add loop depth information
2719 const MachineLoop *Loop = LI->getLoopFor(&MBB);
Craig Topper353eda42014-04-24 06:44:33 +00002720 if (!Loop) return;
Jim Grosbach1900c732011-03-29 23:20:22 +00002721
Chris Lattner978e2f02010-01-22 21:50:41 +00002722 MachineBasicBlock *Header = Loop->getHeader();
2723 assert(Header && "No header for loop");
Jim Grosbach1900c732011-03-29 23:20:22 +00002724
Chris Lattner978e2f02010-01-22 21:50:41 +00002725 // If this block is not a loop header, just print out what is the loop header
2726 // and return.
2727 if (Header != &MBB) {
Lang Hames9ff69c82015-04-24 19:11:51 +00002728 AP.OutStreamer->AddComment(" in Loop: Header=BB" +
2729 Twine(AP.getFunctionNumber())+"_" +
2730 Twine(Loop->getHeader()->getNumber())+
2731 " Depth="+Twine(Loop->getLoopDepth()));
Chris Lattner978e2f02010-01-22 21:50:41 +00002732 return;
2733 }
Jim Grosbach1900c732011-03-29 23:20:22 +00002734
Chris Lattner978e2f02010-01-22 21:50:41 +00002735 // Otherwise, it is a loop header. Print out information about child and
2736 // parent loops.
Lang Hames9ff69c82015-04-24 19:11:51 +00002737 raw_ostream &OS = AP.OutStreamer->GetCommentOS();
Jim Grosbach1900c732011-03-29 23:20:22 +00002738
2739 PrintParentLoopComment(OS, Loop->getParentLoop(), AP.getFunctionNumber());
2740
Chris Lattner978e2f02010-01-22 21:50:41 +00002741 OS << "=>";
2742 OS.indent(Loop->getLoopDepth()*2-2);
Jim Grosbach1900c732011-03-29 23:20:22 +00002743
Chris Lattner978e2f02010-01-22 21:50:41 +00002744 OS << "This ";
2745 if (Loop->empty())
2746 OS << "Inner ";
2747 OS << "Loop Header: Depth=" + Twine(Loop->getLoopDepth()) << '\n';
Jim Grosbach1900c732011-03-29 23:20:22 +00002748
Chris Lattner978e2f02010-01-22 21:50:41 +00002749 PrintChildLoopComment(OS, Loop, AP.getFunctionNumber());
2750}
2751
Omer Paparo Bivas2251c792017-10-24 06:16:03 +00002752void AsmPrinter::setupCodePaddingContext(const MachineBasicBlock &MBB,
2753 MCCodePaddingContext &Context) const {
2754 assert(MF != nullptr && "Machine function must be valid");
Omer Paparo Bivas2251c792017-10-24 06:16:03 +00002755 Context.IsPaddingActive = !MF->hasInlineAsm() &&
Matthias Braunf1caa282017-12-15 22:22:58 +00002756 !MF->getFunction().optForSize() &&
Omer Paparo Bivas2251c792017-10-24 06:16:03 +00002757 TM.getOptLevel() != CodeGenOpt::None;
Omer Paparo Bivas2251c792017-10-24 06:16:03 +00002758 Context.IsBasicBlockReachableViaFallthrough =
2759 std::find(MBB.pred_begin(), MBB.pred_end(), MBB.getPrevNode()) !=
2760 MBB.pred_end();
2761 Context.IsBasicBlockReachableViaBranch =
2762 MBB.pred_size() > 0 && !isBlockOnlyReachableByFallthrough(&MBB);
2763}
2764
Chris Lattner1d04aa72009-09-13 18:25:37 +00002765/// EmitBasicBlockStart - This method prints the label for the specified
2766/// MachineBasicBlock, an alignment (if present) and a comment describing
2767/// it if appropriate.
Jim Grosbach6623e7f2014-04-16 22:38:02 +00002768void AsmPrinter::EmitBasicBlockStart(const MachineBasicBlock &MBB) const {
David Majnemera80c1512015-09-29 20:12:33 +00002769 // End the previous funclet and start a new one.
2770 if (MBB.isEHFuncletEntry()) {
2771 for (const HandlerInfo &HI : Handlers) {
2772 HI.Handler->endFunclet();
2773 HI.Handler->beginFunclet(MBB);
2774 }
2775 }
2776
Dan Gohmanc83dc4b2009-10-30 01:34:35 +00002777 // Emit an alignment directive for this block, if needed.
Jim Grosbach6623e7f2014-04-16 22:38:02 +00002778 if (unsigned Align = MBB.getAlignment())
Jakob Stoklund Olesen10e12522011-12-06 01:26:19 +00002779 EmitAlignment(Align);
Omer Paparo Bivas2251c792017-10-24 06:16:03 +00002780 MCCodePaddingContext Context;
2781 setupCodePaddingContext(MBB, Context);
2782 OutStreamer->EmitCodePaddingBasicBlockStart(Context);
Evan Chengc7990652008-02-28 00:43:03 +00002783
Chris Lattnerdb035a02010-03-16 00:29:39 +00002784 // If the block has its address taken, emit any labels that were used to
2785 // reference the block. It is possible that there is more than one label
2786 // here, because multiple LLVM BB's may have been RAUW'd to this block after
2787 // the references were generated.
Jim Grosbach6623e7f2014-04-16 22:38:02 +00002788 if (MBB.hasAddressTaken()) {
2789 const BasicBlock *BB = MBB.getBasicBlock();
Chris Lattner7bde8c02010-04-04 18:52:31 +00002790 if (isVerbose())
Lang Hames9ff69c82015-04-24 19:11:51 +00002791 OutStreamer->AddComment("Block address taken");
Jim Grosbach1900c732011-03-29 23:20:22 +00002792
Joseph Tremoulet3d0fbf12015-10-23 15:06:05 +00002793 // MBBs can have their address taken as part of CodeGen without having
2794 // their corresponding BB's address taken in IR
2795 if (BB->hasAddressTaken())
2796 for (MCSymbol *Sym : MMI->getAddrLabelSymbolToEmit(BB))
2797 OutStreamer->EmitLabel(Sym);
Dan Gohman6c938802009-10-30 01:27:03 +00002798 }
2799
Jakob Stoklund Olesen936656b2012-03-06 22:27:13 +00002800 // Print some verbose block comments.
2801 if (isVerbose()) {
David Majnemer11234ed2015-12-25 09:37:26 +00002802 if (const BasicBlock *BB = MBB.getBasicBlock()) {
2803 if (BB->hasName()) {
2804 BB->printAsOperand(OutStreamer->GetCommentOS(),
2805 /*PrintType=*/false, BB->getModule());
2806 OutStreamer->GetCommentOS() << '\n';
2807 }
2808 }
Michael Zolotukhin8d052a02018-04-09 00:54:47 +00002809
2810 assert(MLI != nullptr && "MachineLoopInfo should has been computed");
2811 emitBasicBlockLoopComments(MBB, MLI, *this);
Jakob Stoklund Olesen936656b2012-03-06 22:27:13 +00002812 }
2813
Dan Gohmanc83dc4b2009-10-30 01:34:35 +00002814 // Print the main label for the block.
Reid Kleckner0e288232015-08-27 23:27:47 +00002815 if (MBB.pred_empty() ||
2816 (isBlockOnlyReachableByFallthrough(&MBB) && !MBB.isEHFuncletEntry())) {
Rafael Espindola499a7482014-01-31 23:14:01 +00002817 if (isVerbose()) {
Chris Lattner17167212010-04-03 22:12:35 +00002818 // NOTE: Want this comment at start of line, don't emit with AddComment.
Francis Visoiu Mistrih25528d62017-12-04 17:18:51 +00002819 OutStreamer->emitRawComment(" %bb." + Twine(MBB.getNumber()) + ":",
2820 false);
Chris Lattnera3eee3c2010-01-22 19:52:01 +00002821 }
Dan Gohman10d3dc52009-10-06 17:38:38 +00002822 } else {
Lang Hames9ff69c82015-04-24 19:11:51 +00002823 OutStreamer->EmitLabel(MBB.getSymbol());
Dan Gohman10d3dc52009-10-06 17:38:38 +00002824 }
Nate Begeman4ca2ea52006-04-22 18:53:45 +00002825}
Nate Begeman984c1a42006-08-12 21:29:52 +00002826
Omer Paparo Bivas2251c792017-10-24 06:16:03 +00002827void AsmPrinter::EmitBasicBlockEnd(const MachineBasicBlock &MBB) {
2828 MCCodePaddingContext Context;
2829 setupCodePaddingContext(MBB, Context);
2830 OutStreamer->EmitCodePaddingBasicBlockEnd(Context);
2831}
2832
Stuart Hastingsbf836592011-02-23 02:27:05 +00002833void AsmPrinter::EmitVisibility(MCSymbol *Sym, unsigned Visibility,
2834 bool IsDefinition) const {
Chris Lattner0bfd2792010-01-23 06:53:23 +00002835 MCSymbolAttr Attr = MCSA_Invalid;
Jim Grosbach1900c732011-03-29 23:20:22 +00002836
Chris Lattner0bfd2792010-01-23 06:53:23 +00002837 switch (Visibility) {
2838 default: break;
2839 case GlobalValue::HiddenVisibility:
Stuart Hastingsbf836592011-02-23 02:27:05 +00002840 if (IsDefinition)
2841 Attr = MAI->getHiddenVisibilityAttr();
2842 else
2843 Attr = MAI->getHiddenDeclarationVisibilityAttr();
Chris Lattner0bfd2792010-01-23 06:53:23 +00002844 break;
2845 case GlobalValue::ProtectedVisibility:
2846 Attr = MAI->getProtectedVisibilityAttr();
2847 break;
Chris Lattner7fec1802010-01-15 23:38:51 +00002848 }
Chris Lattner0bfd2792010-01-23 06:53:23 +00002849
2850 if (Attr != MCSA_Invalid)
Lang Hames9ff69c82015-04-24 19:11:51 +00002851 OutStreamer->EmitSymbolAttribute(Sym, Attr);
Chris Lattner7fec1802010-01-15 23:38:51 +00002852}
2853
Chris Lattner1fa9c2cc2010-02-17 18:52:56 +00002854/// isBlockOnlyReachableByFallthough - Return true if the basic block has
2855/// exactly one predecessor and the control transfer mechanism between
2856/// the predecessor and this block is a fall-through.
Chris Lattner2cf5f9e2010-04-04 17:57:56 +00002857bool AsmPrinter::
2858isBlockOnlyReachableByFallthrough(const MachineBasicBlock *MBB) const {
Chris Lattner1fa9c2cc2010-02-17 18:52:56 +00002859 // If this is a landing pad, it isn't a fall through. If it has no preds,
2860 // then nothing falls through to it.
Reid Kleckner0e288232015-08-27 23:27:47 +00002861 if (MBB->isEHPad() || MBB->pred_empty())
Chris Lattner1fa9c2cc2010-02-17 18:52:56 +00002862 return false;
Jim Grosbach1900c732011-03-29 23:20:22 +00002863
Chris Lattner1fa9c2cc2010-02-17 18:52:56 +00002864 // If there isn't exactly one predecessor, it can't be a fall through.
Jim Grosbach6623e7f2014-04-16 22:38:02 +00002865 if (MBB->pred_size() > 1)
Chris Lattner1fa9c2cc2010-02-17 18:52:56 +00002866 return false;
Jim Grosbach1900c732011-03-29 23:20:22 +00002867
Chris Lattner1fa9c2cc2010-02-17 18:52:56 +00002868 // The predecessor has to be immediately before this block.
Jim Grosbach6623e7f2014-04-16 22:38:02 +00002869 MachineBasicBlock *Pred = *MBB->pred_begin();
Chris Lattner1fa9c2cc2010-02-17 18:52:56 +00002870 if (!Pred->isLayoutSuccessor(MBB))
2871 return false;
Jim Grosbach1900c732011-03-29 23:20:22 +00002872
Chris Lattner1fa9c2cc2010-02-17 18:52:56 +00002873 // If the block is completely empty, then it definitely does fall through.
2874 if (Pred->empty())
2875 return true;
Jim Grosbach1900c732011-03-29 23:20:22 +00002876
Eli Friedman8a3264a2011-06-14 19:30:33 +00002877 // Check the terminators in the previous blocks
Jim Grosbach6623e7f2014-04-16 22:38:02 +00002878 for (const auto &MI : Pred->terminators()) {
Eli Friedman8a3264a2011-06-14 19:30:33 +00002879 // If it is not a simple branch, we are in a table somewhere.
Evan Cheng7f8e5632011-12-07 07:15:52 +00002880 if (!MI.isBranch() || MI.isIndirectBranch())
Eli Friedman8a3264a2011-06-14 19:30:33 +00002881 return false;
2882
Jakob Stoklund Olesen1995b9f2014-01-12 19:24:08 +00002883 // If we are the operands of one of the branches, this is not a fall
2884 // through. Note that targets with delay slots will usually bundle
2885 // terminators with the delay slot instruction.
Duncan P. N. Exon Smithf9ab4162016-02-27 17:05:33 +00002886 for (ConstMIBundleOperands OP(MI); OP.isValid(); ++OP) {
Jakob Stoklund Olesen1995b9f2014-01-12 19:24:08 +00002887 if (OP->isJTI())
Rafael Espindolaab205672011-06-15 21:00:28 +00002888 return false;
Jakob Stoklund Olesen1995b9f2014-01-12 19:24:08 +00002889 if (OP->isMBB() && OP->getMBB() == MBB)
Eli Friedman8a3264a2011-06-14 19:30:33 +00002890 return false;
2891 }
2892 }
2893
2894 return true;
Chris Lattner1fa9c2cc2010-02-17 18:52:56 +00002895}
2896
David Blaikie88368ba2014-04-15 05:34:49 +00002897GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy &S) {
2898 if (!S.usesMetadata())
Craig Topper353eda42014-04-24 06:44:33 +00002899 return nullptr;
Chris Lattner2cf5f9e2010-04-04 17:57:56 +00002900
Philip Reames4ac17a32015-01-07 19:07:50 +00002901 assert(!S.useStatepoints() && "statepoints do not currently support custom"
2902 " stackmap formats, please see the documentation for a description of"
2903 " the default format. If you really need a custom serialized format,"
2904 " please file a bug");
2905
Chris Lattner2cf5f9e2010-04-04 17:57:56 +00002906 gcp_map_type &GCMap = getGCMap(GCMetadataPrinters);
David Blaikie88368ba2014-04-15 05:34:49 +00002907 gcp_map_type::iterator GCPI = GCMap.find(&S);
Chris Lattner2cf5f9e2010-04-04 17:57:56 +00002908 if (GCPI != GCMap.end())
David Blaikieec528ee2014-04-15 05:53:26 +00002909 return GCPI->second.get();
Jim Grosbach1900c732011-03-29 23:20:22 +00002910
Mehdi Amini74107172016-10-01 15:44:54 +00002911 auto Name = S.getName();
Jim Grosbach1900c732011-03-29 23:20:22 +00002912
Gordon Henriksendbe06d32008-08-17 12:08:44 +00002913 for (GCMetadataPrinterRegistry::iterator
2914 I = GCMetadataPrinterRegistry::begin(),
2915 E = GCMetadataPrinterRegistry::end(); I != E; ++I)
Mehdi Amini74107172016-10-01 15:44:54 +00002916 if (Name == I->getName()) {
David Blaikieec528ee2014-04-15 05:53:26 +00002917 std::unique_ptr<GCMetadataPrinter> GMP = I->instantiate();
David Blaikie88368ba2014-04-15 05:34:49 +00002918 GMP->S = &S;
David Blaikieec528ee2014-04-15 05:53:26 +00002919 auto IterBool = GCMap.insert(std::make_pair(&S, std::move(GMP)));
2920 return IterBool.first->second.get();
Gordon Henriksendbe06d32008-08-17 12:08:44 +00002921 }
Jim Grosbach1900c732011-03-29 23:20:22 +00002922
Chris Lattner2104b8d2010-04-07 22:58:41 +00002923 report_fatal_error("no GCMetadataPrinter registered for GC: " + Twine(Name));
Gordon Henriksendbe06d32008-08-17 12:08:44 +00002924}
Juergen Ributzkadb9ee002013-12-14 12:23:14 +00002925
2926/// Pin vtable to this file.
Eugene Zelenkod96089b2017-02-14 00:33:36 +00002927AsmPrinterHandler::~AsmPrinterHandler() = default;
Rafael Espindolaa6001792015-03-09 18:29:12 +00002928
2929void AsmPrinterHandler::markFunctionEnd() {}
Dean Michael Berris464015442016-09-19 00:54:35 +00002930
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +00002931// In the binary's "xray_instr_map" section, an array of these function entries
2932// describes each instrumentation point. When XRay patches your code, the index
2933// into this table will be given to your handler as a patch point identifier.
2934void AsmPrinter::XRayFunctionEntry::emit(int Bytes, MCStreamer *Out,
2935 const MCSymbol *CurrentFnSym) const {
2936 Out->EmitSymbolValue(Sled, Bytes);
2937 Out->EmitSymbolValue(CurrentFnSym, Bytes);
2938 auto Kind8 = static_cast<uint8_t>(Kind);
Dean Michael Berrisebc16592017-09-04 05:34:58 +00002939 Out->EmitBinaryData(StringRef(reinterpret_cast<const char *>(&Kind8), 1));
2940 Out->EmitBinaryData(
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +00002941 StringRef(reinterpret_cast<const char *>(&AlwaysInstrument), 1));
Dean Michael Berrisebc16592017-09-04 05:34:58 +00002942 Out->EmitBinaryData(StringRef(reinterpret_cast<const char *>(&Version), 1));
2943 auto Padding = (4 * Bytes) - ((2 * Bytes) + 3);
2944 assert(Padding >= 0 && "Instrumentation map entry > 4 * Word Size");
2945 Out->EmitZeros(Padding);
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +00002946}
2947
2948void AsmPrinter::emitXRayTable() {
2949 if (Sleds.empty())
2950 return;
2951
2952 auto PrevSection = OutStreamer->getCurrentSectionOnly();
Matthias Braunf1caa282017-12-15 22:22:58 +00002953 const Function &F = MF->getFunction();
Dean Michael Berrisbdfe9002017-05-04 03:37:57 +00002954 MCSection *InstMap = nullptr;
2955 MCSection *FnSledIndex = nullptr;
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +00002956 if (MF->getSubtarget().getTargetTriple().isOSBinFormatELF()) {
Dean Michael Berris01fd7c82017-09-14 07:08:23 +00002957 auto Associated = dyn_cast<MCSymbolELF>(CurrentFnSym);
Dean Michael Berrisebc16592017-09-04 05:34:58 +00002958 assert(Associated != nullptr);
2959 auto Flags = ELF::SHF_WRITE | ELF::SHF_ALLOC | ELF::SHF_LINK_ORDER;
2960 std::string GroupName;
Matthias Braunf1caa282017-12-15 22:22:58 +00002961 if (F.hasComdat()) {
Dean Michael Berrisebc16592017-09-04 05:34:58 +00002962 Flags |= ELF::SHF_GROUP;
Matthias Braunf1caa282017-12-15 22:22:58 +00002963 GroupName = F.getComdat()->getName();
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +00002964 }
Dean Michael Berrisebc16592017-09-04 05:34:58 +00002965
2966 auto UniqueID = ++XRayFnUniqueID;
2967 InstMap =
2968 OutContext.getELFSection("xray_instr_map", ELF::SHT_PROGBITS, Flags, 0,
2969 GroupName, UniqueID, Associated);
2970 FnSledIndex =
2971 OutContext.getELFSection("xray_fn_idx", ELF::SHT_PROGBITS, Flags, 0,
2972 GroupName, UniqueID, Associated);
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +00002973 } else if (MF->getSubtarget().getTargetTriple().isOSBinFormatMachO()) {
Dean Michael Berrisbdfe9002017-05-04 03:37:57 +00002974 InstMap = OutContext.getMachOSection("__DATA", "xray_instr_map", 0,
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +00002975 SectionKind::getReadOnlyWithRel());
Dean Michael Berrisbdfe9002017-05-04 03:37:57 +00002976 FnSledIndex = OutContext.getMachOSection("__DATA", "xray_fn_idx", 0,
2977 SectionKind::getReadOnlyWithRel());
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +00002978 } else {
2979 llvm_unreachable("Unsupported target");
2980 }
2981
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +00002982 auto WordSizeBytes = MAI->getCodePointerSize();
Dean Michael Berrisbdfe9002017-05-04 03:37:57 +00002983
2984 // Now we switch to the instrumentation map section. Because this is done
2985 // per-function, we are able to create an index entry that will represent the
2986 // range of sleds associated with a function.
Dean Michael Berris28ecff52017-06-21 06:39:42 +00002987 MCSymbol *SledsStart = OutContext.createTempSymbol("xray_sleds_start", true);
Dean Michael Berrisbdfe9002017-05-04 03:37:57 +00002988 OutStreamer->SwitchSection(InstMap);
2989 OutStreamer->EmitLabel(SledsStart);
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +00002990 for (const auto &Sled : Sleds)
2991 Sled.emit(WordSizeBytes, OutStreamer.get(), CurrentFnSym);
Dean Michael Berris28ecff52017-06-21 06:39:42 +00002992 MCSymbol *SledsEnd = OutContext.createTempSymbol("xray_sleds_end", true);
Dean Michael Berrisbdfe9002017-05-04 03:37:57 +00002993 OutStreamer->EmitLabel(SledsEnd);
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +00002994
Dean Michael Berrisbdfe9002017-05-04 03:37:57 +00002995 // We then emit a single entry in the index per function. We use the symbols
2996 // that bound the instrumentation map as the range for a specific function.
Dean Michael Berrisebdccd02017-05-04 04:55:46 +00002997 // Each entry here will be 2 * word size aligned, as we're writing down two
2998 // pointers. This should work for both 32-bit and 64-bit platforms.
Dean Michael Berrisbdfe9002017-05-04 03:37:57 +00002999 OutStreamer->SwitchSection(FnSledIndex);
Dean Michael Berrisebdccd02017-05-04 04:55:46 +00003000 OutStreamer->EmitCodeAlignment(2 * WordSizeBytes);
Dean Michael Berrisebc16592017-09-04 05:34:58 +00003001 OutStreamer->EmitSymbolValue(SledsStart, WordSizeBytes, false);
3002 OutStreamer->EmitSymbolValue(SledsEnd, WordSizeBytes, false);
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +00003003 OutStreamer->SwitchSection(PrevSection);
3004 Sleds.clear();
3005}
3006
Dean Michael Berris464015442016-09-19 00:54:35 +00003007void AsmPrinter::recordSled(MCSymbol *Sled, const MachineInstr &MI,
Dean Michael Berrisebc16592017-09-04 05:34:58 +00003008 SledKind Kind, uint8_t Version) {
Matthias Braunf1caa282017-12-15 22:22:58 +00003009 const Function &F = MI.getMF()->getFunction();
3010 auto Attr = F.getFnAttribute("function-instrument");
3011 bool LogArgs = F.hasFnAttribute("xray-log-args");
Dean Michael Berris464015442016-09-19 00:54:35 +00003012 bool AlwaysInstrument =
3013 Attr.isStringAttribute() && Attr.getValueAsString() == "xray-always";
Dean Michael Berris7e8eea42017-03-06 06:48:56 +00003014 if (Kind == SledKind::FUNCTION_ENTER && LogArgs)
3015 Kind = SledKind::LOG_ARGS_ENTER;
Dean Michael Berrisebc16592017-09-04 05:34:58 +00003016 Sleds.emplace_back(XRayFunctionEntry{Sled, CurrentFnSym, Kind,
Matthias Braunf1caa282017-12-15 22:22:58 +00003017 AlwaysInstrument, &F, Version});
Dean Michael Berris464015442016-09-19 00:54:35 +00003018}
Greg Claytone6543972016-11-23 23:30:37 +00003019
3020uint16_t AsmPrinter::getDwarfVersion() const {
3021 return OutStreamer->getContext().getDwarfVersion();
3022}
3023
3024void AsmPrinter::setDwarfVersion(uint16_t Version) {
3025 OutStreamer->getContext().setDwarfVersion(Version);
3026}