blob: 9a74917b05ef20e323cd09d38f9cfa00e2c2eb5a [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 Rimar6d448da12018-06-22 10:27:33 +0000992 MCSection *StackSizeSection = getObjFileLowering().getStackSizesSection();
Sean Evesona6bcd532017-11-30 13:05:14 +0000993 if (!StackSizeSection)
994 return;
995
996 const MachineFrameInfo &FrameInfo = MF.getFrameInfo();
997 // Don't emit functions with dynamic stack allocations.
998 if (FrameInfo.hasVarSizedObjects())
999 return;
1000
1001 OutStreamer->PushSection();
1002 OutStreamer->SwitchSection(StackSizeSection);
1003
Rafael Espindola78fdca32018-03-26 20:40:22 +00001004 const MCSymbol *FunctionSymbol = getFunctionBegin();
Sean Evesona6bcd532017-11-30 13:05:14 +00001005 uint64_t StackSize = FrameInfo.getStackSize();
Matt Arsenault41e5ac42018-03-14 00:36:23 +00001006 OutStreamer->EmitSymbolValue(FunctionSymbol, TM.getProgramPointerSize());
Sean Evesona6bcd532017-11-30 13:05:14 +00001007 OutStreamer->EmitULEB128IntValue(StackSize);
1008
1009 OutStreamer->PopSection();
1010}
1011
Reid Klecknerc2f1bbf2017-05-31 22:18:49 +00001012static bool needFuncLabelsForEHOrDebugInfo(const MachineFunction &MF,
1013 MachineModuleInfo *MMI) {
1014 if (!MF.getLandingPads().empty() || MF.hasEHFunclets() || MMI->hasDebugInfo())
1015 return true;
1016
Reid Kleckner57ac61e2017-05-31 22:21:20 +00001017 // We might emit an EH table that uses function begin and end labels even if
1018 // we don't have any landingpads.
Matthias Braunf1caa282017-12-15 22:22:58 +00001019 if (!MF.getFunction().hasPersonalityFn())
Reid Klecknerc2f1bbf2017-05-31 22:18:49 +00001020 return false;
Reid Kleckner57ac61e2017-05-31 22:21:20 +00001021 return !isNoOpWithoutInvoke(
Matthias Braunf1caa282017-12-15 22:22:58 +00001022 classifyEHPersonality(MF.getFunction().getPersonalityFn()));
Reid Klecknerc2f1bbf2017-05-31 22:18:49 +00001023}
1024
Chris Lattner94a946c2010-01-28 01:02:27 +00001025/// EmitFunctionBody - This method emits the body and trailer for a
1026/// function.
1027void AsmPrinter::EmitFunctionBody() {
Rafael Espindola8dc4e102015-03-17 14:38:30 +00001028 EmitFunctionHeader();
1029
Chris Lattnerc968f442010-01-28 01:58:58 +00001030 // Emit target-specific gunk before the function body.
1031 EmitFunctionBodyStart();
Jim Grosbach1900c732011-03-29 23:20:22 +00001032
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001033 bool ShouldPrintDebugScopes = MMI->hasDebugInfo();
Jim Grosbach1900c732011-03-29 23:20:22 +00001034
Michael Zolotukhin8d052a02018-04-09 00:54:47 +00001035 if (isVerbose()) {
1036 // Get MachineDominatorTree or compute it on the fly if it's unavailable
1037 MDT = getAnalysisIfAvailable<MachineDominatorTree>();
1038 if (!MDT) {
1039 OwnedMDT = make_unique<MachineDominatorTree>();
1040 OwnedMDT->getBase().recalculate(*MF);
1041 MDT = OwnedMDT.get();
1042 }
1043
1044 // Get MachineLoopInfo or compute it on the fly if it's unavailable
1045 MLI = getAnalysisIfAvailable<MachineLoopInfo>();
1046 if (!MLI) {
1047 OwnedMLI = make_unique<MachineLoopInfo>();
1048 OwnedMLI->getBase().analyze(MDT->getBase());
1049 MLI = OwnedMLI.get();
1050 }
1051 }
1052
Chris Lattner94a946c2010-01-28 01:02:27 +00001053 // Print out code for the function.
1054 bool HasAnyRealCode = false;
Justin Bogner369ba752017-02-24 00:19:22 +00001055 int NumInstsInFunction = 0;
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001056 for (auto &MBB : *MF) {
Chris Lattner94a946c2010-01-28 01:02:27 +00001057 // Print a label for the basic block.
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001058 EmitBasicBlockStart(MBB);
1059 for (auto &MI : MBB) {
Chris Lattner94a946c2010-01-28 01:02:27 +00001060 // Print the assembly for the instruction.
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001061 if (!MI.isPosition() && !MI.isImplicitDef() && !MI.isKill() &&
Shiva Chen801bf7e2018-05-09 02:42:00 +00001062 !MI.isDebugInstr()) {
Chris Lattner94a946c2010-01-28 01:02:27 +00001063 HasAnyRealCode = true;
Justin Bogner369ba752017-02-24 00:19:22 +00001064 ++NumInstsInFunction;
Evan Chengeb828b62010-04-27 19:38:45 +00001065 }
1066
Torok Edwinf8dba242010-04-07 10:44:46 +00001067 if (ShouldPrintDebugScopes) {
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001068 for (const HandlerInfo &HI : Handlers) {
Matthias Braun9f15a792016-11-18 19:43:18 +00001069 NamedRegionTimer T(HI.TimerName, HI.TimerDescription,
1070 HI.TimerGroupName, HI.TimerGroupDescription,
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001071 TimePassesIsEnabled);
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001072 HI.Handler->beginInstruction(&MI);
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001073 }
Torok Edwinf8dba242010-04-07 10:44:46 +00001074 }
Jim Grosbach1900c732011-03-29 23:20:22 +00001075
Andrew V. Tischenko22f07422017-12-15 18:13:05 +00001076 if (isVerbose() && emitComments(MI, OutStreamer->GetCommentOS(), this)) {
1077 MachineInstr *MIP = const_cast<MachineInstr *>(&MI);
1078 MIP->setAsmPrinterFlag(MachineInstr::NoSchedComment);
1079 }
Chris Lattner74e68522010-02-10 00:47:53 +00001080
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001081 switch (MI.getOpcode()) {
Rafael Espindolab1f25f12014-03-07 06:08:31 +00001082 case TargetOpcode::CFI_INSTRUCTION:
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001083 emitCFIInstruction(MI);
Rafael Espindolaa01cdb02011-04-15 15:11:06 +00001084 break;
Reid Kleckner60381792015-07-07 22:25:32 +00001085 case TargetOpcode::LOCAL_ESCAPE:
Reid Klecknere9b89312015-01-13 00:48:10 +00001086 emitFrameAlloc(MI);
1087 break;
Chris Lattnerb06015a2010-02-09 19:54:29 +00001088 case TargetOpcode::EH_LABEL:
1089 case TargetOpcode::GC_LABEL:
Lang Hames9ff69c82015-04-24 19:11:51 +00001090 OutStreamer->EmitLabel(MI.getOperand(0).getMCSymbol());
Chris Lattner41ad1902010-02-03 01:00:52 +00001091 break;
Chris Lattnerb06015a2010-02-09 19:54:29 +00001092 case TargetOpcode::INLINEASM:
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001093 EmitInlineAsm(&MI);
Chris Lattner41ad1902010-02-03 01:00:52 +00001094 break;
Dale Johannesen5d7f0a02010-04-07 01:15:14 +00001095 case TargetOpcode::DBG_VALUE:
1096 if (isVerbose()) {
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001097 if (!emitDebugValueComment(&MI, *this))
1098 EmitInstruction(&MI);
Dale Johannesen5d7f0a02010-04-07 01:15:14 +00001099 }
1100 break;
Shiva Chencd070cd2018-05-09 02:41:08 +00001101 case TargetOpcode::DBG_LABEL:
1102 if (isVerbose()) {
1103 if (!emitDebugLabelComment(&MI, *this))
1104 EmitInstruction(&MI);
1105 }
1106 break;
Chris Lattnerb06015a2010-02-09 19:54:29 +00001107 case TargetOpcode::IMPLICIT_DEF:
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001108 if (isVerbose()) emitImplicitDef(&MI);
Chris Lattner41ad1902010-02-03 01:00:52 +00001109 break;
Chris Lattnerb06015a2010-02-09 19:54:29 +00001110 case TargetOpcode::KILL:
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001111 if (isVerbose()) emitKill(&MI, *this);
Chris Lattner41ad1902010-02-03 01:00:52 +00001112 break;
1113 default:
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001114 EmitInstruction(&MI);
Chris Lattner41ad1902010-02-03 01:00:52 +00001115 break;
1116 }
Jim Grosbach1900c732011-03-29 23:20:22 +00001117
Torok Edwinf8dba242010-04-07 10:44:46 +00001118 if (ShouldPrintDebugScopes) {
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001119 for (const HandlerInfo &HI : Handlers) {
Matthias Braun9f15a792016-11-18 19:43:18 +00001120 NamedRegionTimer T(HI.TimerName, HI.TimerDescription,
1121 HI.TimerGroupName, HI.TimerGroupDescription,
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001122 TimePassesIsEnabled);
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001123 HI.Handler->endInstruction();
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001124 }
Torok Edwinf8dba242010-04-07 10:44:46 +00001125 }
Chris Lattner94a946c2010-01-28 01:02:27 +00001126 }
Lang Hamesf49bc3f2014-07-24 20:40:55 +00001127
1128 EmitBasicBlockEnd(MBB);
Chris Lattner94a946c2010-01-28 01:02:27 +00001129 }
Bill Wendlingbf8370f2010-07-16 22:51:10 +00001130
Justin Bogner369ba752017-02-24 00:19:22 +00001131 EmittedInsts += NumInstsInFunction;
1132 MachineOptimizationRemarkAnalysis R(DEBUG_TYPE, "InstructionCount",
Matthias Braunf1caa282017-12-15 22:22:58 +00001133 MF->getFunction().getSubprogram(),
Justin Bogner369ba752017-02-24 00:19:22 +00001134 &MF->front());
1135 R << ore::NV("NumInstructions", NumInstsInFunction)
1136 << " instructions in function";
1137 ORE->emit(R);
1138
Chris Lattner94a946c2010-01-28 01:02:27 +00001139 // If the function is empty and the object file uses .subsections_via_symbols,
Chris Lattner73de5fb2010-01-28 01:28:58 +00001140 // then we need to emit *something* to the function body to prevent the
Chris Lattner6a5e7062010-04-26 23:37:21 +00001141 // labels from collapsing together. Just emit a noop.
Hans Wennborg9b9a5352017-04-21 21:48:41 +00001142 // Similarly, don't emit empty functions on Windows either. It can lead to
1143 // duplicate entries (two functions with the same RVA) in the Guard CF Table
1144 // after linking, causing the kernel not to load the binary:
1145 // https://developercommunity.visualstudio.com/content/problem/45366/vc-linker-creates-invalid-dll-with-clang-cl.html
1146 // FIXME: Hide this behind some API in e.g. MCAsmInfo or MCTargetStreamer.
1147 const Triple &TT = TM.getTargetTriple();
1148 if (!HasAnyRealCode && (MAI->hasSubsectionsViaSymbols() ||
1149 (TT.isOSWindows() && TT.isOSBinFormatCOFF()))) {
Chris Lattner6a5e7062010-04-26 23:37:21 +00001150 MCInst Noop;
Hans Wennborg9b9a5352017-04-21 21:48:41 +00001151 MF->getSubtarget().getInstrInfo()->getNoop(Noop);
Daniel Sanders11e78c22017-04-25 14:27:27 +00001152
1153 // Targets can opt-out of emitting the noop here by leaving the opcode
1154 // unspecified.
1155 if (Noop.getOpcode()) {
1156 OutStreamer->AddComment("avoids zero-length function");
1157 OutStreamer->EmitInstruction(Noop, getSubtargetInfo());
1158 }
Chris Lattner6a5e7062010-04-26 23:37:21 +00001159 }
Jim Grosbach1900c732011-03-29 23:20:22 +00001160
Matthias Braunf1caa282017-12-15 22:22:58 +00001161 const Function &F = MF->getFunction();
1162 for (const auto &BB : F) {
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001163 if (!BB.hasAddressTaken())
Rafael Espindolaf11e7f12011-11-15 19:08:46 +00001164 continue;
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001165 MCSymbol *Sym = GetBlockAddressSymbol(&BB);
Rafael Espindolaf11e7f12011-11-15 19:08:46 +00001166 if (Sym->isDefined())
1167 continue;
Lang Hames9ff69c82015-04-24 19:11:51 +00001168 OutStreamer->AddComment("Address of block that was removed by CodeGen");
1169 OutStreamer->EmitLabel(Sym);
Rafael Espindolaf11e7f12011-11-15 19:08:46 +00001170 }
1171
Chris Lattnerc968f442010-01-28 01:58:58 +00001172 // Emit target-specific gunk after the function body.
1173 EmitFunctionBodyEnd();
Jim Grosbach1900c732011-03-29 23:20:22 +00001174
Reid Klecknerc2f1bbf2017-05-31 22:18:49 +00001175 if (needFuncLabelsForEHOrDebugInfo(*MF, MMI) ||
1176 MAI->hasDotTypeDotSizeDirective()) {
Rafael Espindola629cdba2015-02-27 18:18:39 +00001177 // Create a symbol for the end of function.
Rafael Espindola9ab09232015-03-17 20:07:06 +00001178 CurrentFnEnd = createTempSymbol("func_end");
Lang Hames9ff69c82015-04-24 19:11:51 +00001179 OutStreamer->EmitLabel(CurrentFnEnd);
Rafael Espindola629cdba2015-02-27 18:18:39 +00001180 }
1181
Chris Lattnerc6d67d42010-04-03 22:19:41 +00001182 // If the target wants a .size directive for the size of the function, emit
1183 // it.
1184 if (MAI->hasDotTypeDotSizeDirective()) {
Rafael Espindola310e4b52015-03-04 01:35:23 +00001185 // We can get the size as difference between the function label and the
1186 // temp label.
NAKAMURA Takumibf6ad022015-06-14 00:23:33 +00001187 const MCExpr *SizeExp = MCBinaryExpr::createSub(
1188 MCSymbolRefExpr::create(CurrentFnEnd, OutContext),
1189 MCSymbolRefExpr::create(CurrentFnSymForSize, OutContext), OutContext);
Dan Gohman734c59d2016-12-01 23:39:08 +00001190 OutStreamer->emitELFSize(CurrentFnSym, SizeExp);
Chris Lattnerc6d67d42010-04-03 22:19:41 +00001191 }
Jim Grosbach1900c732011-03-29 23:20:22 +00001192
Rafael Espindolaa6001792015-03-09 18:29:12 +00001193 for (const HandlerInfo &HI : Handlers) {
Matthias Braun9f15a792016-11-18 19:43:18 +00001194 NamedRegionTimer T(HI.TimerName, HI.TimerDescription, HI.TimerGroupName,
1195 HI.TimerGroupDescription, TimePassesIsEnabled);
Rafael Espindolaa6001792015-03-09 18:29:12 +00001196 HI.Handler->markFunctionEnd();
1197 }
1198
1199 // Print out jump tables referenced by the function.
1200 EmitJumpTableInfo();
1201
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001202 // Emit post-function debug and/or EH information.
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001203 for (const HandlerInfo &HI : Handlers) {
Matthias Braun9f15a792016-11-18 19:43:18 +00001204 NamedRegionTimer T(HI.TimerName, HI.TimerDescription, HI.TimerGroupName,
1205 HI.TimerGroupDescription, TimePassesIsEnabled);
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001206 HI.Handler->endFunction(MF);
Torok Edwinf8dba242010-04-07 10:44:46 +00001207 }
Jim Grosbach1900c732011-03-29 23:20:22 +00001208
Sean Evesona6bcd532017-11-30 13:05:14 +00001209 // Emit section containing stack size metadata.
1210 emitStackSizeSection(*MF);
1211
Francis Visoiu Mistrih1c987012017-05-23 21:22:16 +00001212 if (isVerbose())
1213 OutStreamer->GetCommentOS() << "-- End function\n";
1214
Lang Hames9ff69c82015-04-24 19:11:51 +00001215 OutStreamer->AddBlankLine();
Chris Lattner94a946c2010-01-28 01:02:27 +00001216}
1217
Adrian Prantl5f8f34e42018-05-01 15:54:18 +00001218/// Compute the number of Global Variables that uses a Constant.
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00001219static unsigned getNumGlobalVariableUses(const Constant *C) {
1220 if (!C)
1221 return 0;
1222
1223 if (isa<GlobalVariable>(C))
1224 return 1;
1225
1226 unsigned NumUses = 0;
1227 for (auto *CU : C->users())
1228 NumUses += getNumGlobalVariableUses(dyn_cast<Constant>(CU));
1229
1230 return NumUses;
1231}
1232
Adrian Prantl5f8f34e42018-05-01 15:54:18 +00001233/// Only consider global GOT equivalents if at least one user is a
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00001234/// cstexpr inside an initializer of another global variables. Also, don't
1235/// handle cstexpr inside instructions. During global variable emission,
1236/// candidates are skipped and are emitted later in case at least one cstexpr
1237/// isn't replaced by a PC relative GOT entry access.
1238static bool isGOTEquivalentCandidate(const GlobalVariable *GV,
1239 unsigned &NumGOTEquivUsers) {
1240 // Global GOT equivalents are unnamed private globals with a constant
1241 // pointer initializer to another global symbol. They must point to a
1242 // GlobalVariable or Function, i.e., as GlobalValue.
Eric Christopher0b6537e2016-07-01 06:07:31 +00001243 if (!GV->hasGlobalUnnamedAddr() || !GV->hasInitializer() ||
1244 !GV->isConstant() || !GV->isDiscardableIfUnused() ||
1245 !dyn_cast<GlobalValue>(GV->getOperand(0)))
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00001246 return false;
1247
1248 // To be a got equivalent, at least one of its users need to be a constant
1249 // expression used by another global variable.
1250 for (auto *U : GV->users())
Ahmed Bougacha821880a2015-03-27 01:40:54 +00001251 NumGOTEquivUsers += getNumGlobalVariableUses(dyn_cast<Constant>(U));
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00001252
1253 return NumGOTEquivUsers > 0;
1254}
1255
Adrian Prantl5f8f34e42018-05-01 15:54:18 +00001256/// Unnamed constant global variables solely contaning a pointer to
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00001257/// another globals variable is equivalent to a GOT table entry; it contains the
1258/// the address of another symbol. Optimize it and replace accesses to these
1259/// "GOT equivalents" by using the GOT entry for the final global instead.
1260/// Compute GOT equivalent candidates among all global variables to avoid
1261/// emitting them if possible later on, after it use is replaced by a GOT entry
1262/// access.
1263void AsmPrinter::computeGlobalGOTEquivs(Module &M) {
1264 if (!getObjFileLowering().supportIndirectSymViaGOTPCRel())
1265 return;
1266
1267 for (const auto &G : M.globals()) {
1268 unsigned NumGOTEquivUsers = 0;
1269 if (!isGOTEquivalentCandidate(&G, NumGOTEquivUsers))
1270 continue;
1271
1272 const MCSymbol *GOTEquivSym = getSymbol(&G);
1273 GlobalGOTEquivs[GOTEquivSym] = std::make_pair(&G, NumGOTEquivUsers);
1274 }
1275}
1276
Adrian Prantl5f8f34e42018-05-01 15:54:18 +00001277/// Constant expressions using GOT equivalent globals may not be eligible
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00001278/// for PC relative GOT entry conversion, in such cases we need to emit such
1279/// globals we previously omitted in EmitGlobalVariable.
1280void AsmPrinter::emitGlobalGOTEquivs() {
1281 if (!getObjFileLowering().supportIndirectSymViaGOTPCRel())
1282 return;
1283
Bruno Cardoso Lopesb3a58b42015-03-10 20:05:23 +00001284 SmallVector<const GlobalVariable *, 8> FailedCandidates;
1285 for (auto &I : GlobalGOTEquivs) {
1286 const GlobalVariable *GV = I.second.first;
1287 unsigned Cnt = I.second.second;
1288 if (Cnt)
1289 FailedCandidates.push_back(GV);
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00001290 }
Bruno Cardoso Lopesb3a58b42015-03-10 20:05:23 +00001291 GlobalGOTEquivs.clear();
1292
1293 for (auto *GV : FailedCandidates)
1294 EmitGlobalVariable(GV);
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00001295}
1296
Dmitry Polukhina3d5b0b2016-04-05 08:47:51 +00001297void AsmPrinter::emitGlobalIndirectSymbol(Module &M,
1298 const GlobalIndirectSymbol& GIS) {
1299 MCSymbol *Name = getSymbol(&GIS);
1300
1301 if (GIS.hasExternalLinkage() || !MAI->getWeakRefDirective())
1302 OutStreamer->EmitSymbolAttribute(Name, MCSA_Global);
1303 else if (GIS.hasWeakLinkage() || GIS.hasLinkOnceLinkage())
1304 OutStreamer->EmitSymbolAttribute(Name, MCSA_WeakReference);
1305 else
Dmitry Polukhina1feff72016-04-07 12:32:19 +00001306 assert(GIS.hasLocalLinkage() && "Invalid alias or ifunc linkage");
Dmitry Polukhina3d5b0b2016-04-05 08:47:51 +00001307
1308 // Set the symbol type to function if the alias has a function type.
1309 // This affects codegen when the aliasee is not a function.
Dmitry Polukhina1feff72016-04-07 12:32:19 +00001310 if (GIS.getType()->getPointerElementType()->isFunctionTy()) {
Dmitry Polukhina3d5b0b2016-04-05 08:47:51 +00001311 OutStreamer->EmitSymbolAttribute(Name, MCSA_ELF_TypeFunction);
Dmitry Polukhina1feff72016-04-07 12:32:19 +00001312 if (isa<GlobalIFunc>(GIS))
1313 OutStreamer->EmitSymbolAttribute(Name, MCSA_ELF_TypeIndFunction);
1314 }
Dmitry Polukhina3d5b0b2016-04-05 08:47:51 +00001315
1316 EmitVisibility(Name, GIS.getVisibility());
1317
1318 const MCExpr *Expr = lowerConstant(GIS.getIndirectSymbol());
1319
1320 if (isa<GlobalAlias>(&GIS) && MAI->hasAltEntry() && isa<MCBinaryExpr>(Expr))
1321 OutStreamer->EmitSymbolAttribute(Name, MCSA_AltEntry);
1322
1323 // Emit the directives as assignments aka .set:
1324 OutStreamer->EmitAssignment(Name, Expr);
1325
1326 if (auto *GA = dyn_cast<GlobalAlias>(&GIS)) {
1327 // If the aliasee does not correspond to a symbol in the output, i.e. the
1328 // alias is not of an object or the aliased object is private, then set the
1329 // size of the alias symbol from the type of the alias. We don't do this in
1330 // other situations as the alias and aliasee having differing types but same
1331 // size may be intentional.
1332 const GlobalObject *BaseObject = GA->getBaseObject();
1333 if (MAI->hasDotTypeDotSizeDirective() && GA->getValueType()->isSized() &&
1334 (!BaseObject || BaseObject->hasPrivateLinkage())) {
1335 const DataLayout &DL = M.getDataLayout();
1336 uint64_t Size = DL.getTypeAllocSize(GA->getValueType());
Dan Gohman734c59d2016-12-01 23:39:08 +00001337 OutStreamer->emitELFSize(Name, MCConstantExpr::create(Size, OutContext));
Dmitry Polukhina3d5b0b2016-04-05 08:47:51 +00001338 }
1339 }
1340}
1341
Chris Lattner6a8e0f52004-08-16 23:15:22 +00001342bool AsmPrinter::doFinalization(Module &M) {
Eric Christopherd43c5c72015-03-20 16:03:39 +00001343 // Set the MachineFunction to nullptr so that we can catch attempted
1344 // accesses to MF specific features at the module level and so that
1345 // we can conditionalize accesses based on whether or not it is nullptr.
1346 MF = nullptr;
1347
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00001348 // Gather all GOT equivalent globals in the module. We really need two
1349 // passes over the globals: one to compute and another to avoid its emission
1350 // in EmitGlobalVariable, otherwise we would not be able to handle cases
1351 // where the got equivalent shows up before its use.
1352 computeGlobalGOTEquivs(M);
1353
Chris Lattner100865e2009-07-21 18:38:57 +00001354 // Emit global variables.
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001355 for (const auto &G : M.globals())
1356 EmitGlobalVariable(&G);
Rafael Espindola6c17d542011-01-28 03:20:10 +00001357
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00001358 // Emit remaining GOT equivalent globals.
1359 emitGlobalGOTEquivs();
1360
Rafael Espindola6c17d542011-01-28 03:20:10 +00001361 // Emit visibility info for declarations
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001362 for (const Function &F : M) {
Rafael Espindola7068cbb2015-07-13 13:55:18 +00001363 if (!F.isDeclarationForLinker())
Rafael Espindola6c17d542011-01-28 03:20:10 +00001364 continue;
1365 GlobalValue::VisibilityTypes V = F.getVisibility();
1366 if (V == GlobalValue::DefaultVisibility)
1367 continue;
1368
Rafael Espindola79858aa2013-10-29 17:07:16 +00001369 MCSymbol *Name = getSymbol(&F);
Stuart Hastingsbf836592011-02-23 02:27:05 +00001370 EmitVisibility(Name, V, false);
Rafael Espindola6c17d542011-01-28 03:20:10 +00001371 }
1372
Rafael Espindolab91455b2015-04-07 13:42:44 +00001373 const TargetLoweringObjectFile &TLOF = getObjFileLowering();
1374
Eric Christopheraadbabc2018-04-20 19:07:57 +00001375 TLOF.emitModuleMetadata(*OutStreamer, M);
Rafael Espindolab91455b2015-04-07 13:42:44 +00001376
Daniel Sanders335487a2015-06-16 13:15:50 +00001377 if (TM.getTargetTriple().isOSBinFormatELF()) {
Rafael Espindolab91455b2015-04-07 13:42:44 +00001378 MachineModuleInfoELF &MMIELF = MMI->getObjFileInfo<MachineModuleInfoELF>();
1379
1380 // Output stubs for external and common global variables.
1381 MachineModuleInfoELF::SymbolListTy Stubs = MMIELF.GetGVStubList();
1382 if (!Stubs.empty()) {
Rafael Espindola449711c2015-11-18 06:02:15 +00001383 OutStreamer->SwitchSection(TLOF.getDataSection());
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001384 const DataLayout &DL = M.getDataLayout();
Rafael Espindolab91455b2015-04-07 13:42:44 +00001385
Rafael Espindola8c587502018-04-02 23:20:30 +00001386 EmitAlignment(Log2_32(DL.getPointerSize()));
Rafael Espindolab91455b2015-04-07 13:42:44 +00001387 for (const auto &Stub : Stubs) {
Lang Hames9ff69c82015-04-24 19:11:51 +00001388 OutStreamer->EmitLabel(Stub.first);
1389 OutStreamer->EmitSymbolValue(Stub.second.getPointer(),
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001390 DL.getPointerSize());
Rafael Espindolab91455b2015-04-07 13:42:44 +00001391 }
1392 }
1393 }
Bill Wendling06df7722012-02-14 21:28:13 +00001394
Chris Lattnerf0d6bd32010-04-05 05:11:15 +00001395 // Finalize debug and EH information.
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001396 for (const HandlerInfo &HI : Handlers) {
Matthias Braun9f15a792016-11-18 19:43:18 +00001397 NamedRegionTimer T(HI.TimerName, HI.TimerDescription, HI.TimerGroupName,
1398 HI.TimerGroupDescription, TimePassesIsEnabled);
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001399 HI.Handler->endModule();
1400 delete HI.Handler;
Chris Lattnerf0d6bd32010-04-05 05:11:15 +00001401 }
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +00001402 Handlers.clear();
Craig Topper353eda42014-04-24 06:44:33 +00001403 DD = nullptr;
Jim Grosbach1900c732011-03-29 23:20:22 +00001404
Chris Lattner2981dc12009-06-24 18:52:01 +00001405 // If the target wants to know about weak references, print them all.
Chris Lattnere9a75a62009-08-22 21:43:10 +00001406 if (MAI->getWeakRefDirective()) {
Chris Lattner2981dc12009-06-24 18:52:01 +00001407 // FIXME: This is not lazy, it would be nice to only print weak references
1408 // to stuff that is actually used. Note that doing so would require targets
1409 // to notice uses in operands (due to constant exprs etc). This should
1410 // happen with the MC stuff eventually.
Rafael Espindolad7998d02006-12-18 03:37:18 +00001411
Peter Collingbourne6d88fde2016-06-22 20:29:42 +00001412 // Print out module-level global objects here.
1413 for (const auto &GO : M.global_objects()) {
1414 if (!GO.hasExternalWeakLinkage())
Jim Grosbach6623e7f2014-04-16 22:38:02 +00001415 continue;
Peter Collingbourne6d88fde2016-06-22 20:29:42 +00001416 OutStreamer->EmitSymbolAttribute(getSymbol(&GO), MCSA_WeakReference);
Chris Lattner2981dc12009-06-24 18:52:01 +00001417 }
Rafael Espindolad7998d02006-12-18 03:37:18 +00001418 }
1419
Lang Hames9ff69c82015-04-24 19:11:51 +00001420 OutStreamer->AddBlankLine();
Anton Korobeynikova07765b2007-09-06 17:21:48 +00001421
Tim Shen800ed432016-03-31 22:08:19 +00001422 // Print aliases in topological order, that is, for each alias a = b,
1423 // b must be printed before a.
1424 // This is because on some targets (e.g. PowerPC) linker expects aliases in
1425 // such an order to generate correct TOC information.
1426 SmallVector<const GlobalAlias *, 16> AliasStack;
1427 SmallPtrSet<const GlobalAlias *, 16> AliasVisited;
1428 for (const auto &Alias : M.aliases()) {
1429 for (const GlobalAlias *Cur = &Alias; Cur;
1430 Cur = dyn_cast<GlobalAlias>(Cur->getAliasee())) {
1431 if (!AliasVisited.insert(Cur).second)
1432 break;
1433 AliasStack.push_back(Cur);
1434 }
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001435 for (const GlobalAlias *AncestorAlias : llvm::reverse(AliasStack))
Dmitry Polukhina3d5b0b2016-04-05 08:47:51 +00001436 emitGlobalIndirectSymbol(M, *AncestorAlias);
Tim Shen800ed432016-03-31 22:08:19 +00001437 AliasStack.clear();
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001438 }
Dmitry Polukhina1feff72016-04-07 12:32:19 +00001439 for (const auto &IFunc : M.ifuncs())
1440 emitGlobalIndirectSymbol(M, IFunc);
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001441
Duncan Sands5a913d62009-01-28 13:14:17 +00001442 GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
Gordon Henriksend930f912008-08-17 18:44:35 +00001443 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
1444 for (GCModuleInfo::iterator I = MI->end(), E = MI->begin(); I != E; )
David Blaikie88368ba2014-04-15 05:34:49 +00001445 if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(**--I))
Philip Reames1e308972014-12-11 01:47:23 +00001446 MP->finishAssembly(M, *MI, *this);
Gordon Henriksen5180e852008-01-07 01:30:38 +00001447
Rafael Espindola0018a592013-10-16 01:49:05 +00001448 // Emit llvm.ident metadata in an '.ident' directive.
1449 EmitModuleIdents(M);
1450
Peter Collingbourne7ef497b2014-12-30 20:05:19 +00001451 // Emit __morestack address if needed for indirect calls.
1452 if (MMI->usesMorestackAddr()) {
David Majnemera3ea4072016-02-21 01:30:30 +00001453 unsigned Align = 1;
Mehdi Amini5c0fa582015-07-16 06:04:17 +00001454 MCSection *ReadOnlySection = getObjFileLowering().getSectionForConstant(
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001455 getDataLayout(), SectionKind::getReadOnly(),
David Majnemera3ea4072016-02-21 01:30:30 +00001456 /*C=*/nullptr, Align);
Lang Hames9ff69c82015-04-24 19:11:51 +00001457 OutStreamer->SwitchSection(ReadOnlySection);
Peter Collingbourne7ef497b2014-12-30 20:05:19 +00001458
1459 MCSymbol *AddrSymbol =
Jim Grosbach6f482002015-05-18 18:43:14 +00001460 OutContext.getOrCreateSymbol(StringRef("__morestack_addr"));
Lang Hames9ff69c82015-04-24 19:11:51 +00001461 OutStreamer->EmitLabel(AddrSymbol);
Peter Collingbourne7ef497b2014-12-30 20:05:19 +00001462
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +00001463 unsigned PtrSize = MAI->getCodePointerSize();
Lang Hames9ff69c82015-04-24 19:11:51 +00001464 OutStreamer->EmitSymbolValue(GetExternalSymbolSymbol("__morestack"),
1465 PtrSize);
Peter Collingbourne7ef497b2014-12-30 20:05:19 +00001466 }
1467
Than McIntoshdee2cf62017-09-27 19:34:00 +00001468 // Emit .note.GNU-split-stack and .note.GNU-no-split-stack sections if
1469 // split-stack is used.
1470 if (TM.getTargetTriple().isOSBinFormatELF() && MMI->hasSplitStack()) {
1471 OutStreamer->SwitchSection(
1472 OutContext.getELFSection(".note.GNU-split-stack", ELF::SHT_PROGBITS, 0));
1473 if (MMI->hasNosplitStack())
1474 OutStreamer->SwitchSection(
1475 OutContext.getELFSection(".note.GNU-no-split-stack", ELF::SHT_PROGBITS, 0));
1476 }
1477
Dan Gohmanbcde1722008-05-05 00:28:39 +00001478 // If we don't have any trampolines, then we don't require stack memory
1479 // to be executable. Some targets have a directive to declare this.
Chris Lattner2981dc12009-06-24 18:52:01 +00001480 Function *InitTrampolineIntrinsic = M.getFunction("llvm.init.trampoline");
Dan Gohmanbcde1722008-05-05 00:28:39 +00001481 if (!InitTrampolineIntrinsic || InitTrampolineIntrinsic->use_empty())
Rafael Espindola0709a7b2015-05-21 19:20:38 +00001482 if (MCSection *S = MAI->getNonexecutableStackSection(OutContext))
Lang Hames9ff69c82015-04-24 19:11:51 +00001483 OutStreamer->SwitchSection(S);
Jim Grosbach1900c732011-03-29 23:20:22 +00001484
Reid Kleckner1aa90612018-01-17 23:55:23 +00001485 if (TM.getTargetTriple().isOSBinFormatCOFF()) {
1486 // Emit /EXPORT: flags for each exported global as necessary.
1487 const auto &TLOF = getObjFileLowering();
1488 std::string Flags;
Saleem Abdulrasool99f479a2018-01-20 00:28:02 +00001489
Reid Kleckner1aa90612018-01-17 23:55:23 +00001490 for (const GlobalValue &GV : M.global_values()) {
1491 raw_string_ostream OS(Flags);
1492 TLOF.emitLinkerFlagsForGlobal(OS, &GV);
1493 OS.flush();
1494 if (!Flags.empty()) {
1495 OutStreamer->SwitchSection(TLOF.getDrectveSection());
1496 OutStreamer->EmitBytes(Flags);
1497 }
1498 Flags.clear();
1499 }
Saleem Abdulrasool99f479a2018-01-20 00:28:02 +00001500
1501 // Emit /INCLUDE: flags for each used global as necessary.
1502 if (const auto *LU = M.getNamedGlobal("llvm.used")) {
1503 assert(LU->hasInitializer() &&
1504 "expected llvm.used to have an initializer");
1505 assert(isa<ArrayType>(LU->getValueType()) &&
1506 "expected llvm.used to be an array type");
1507 if (const auto *A = cast<ConstantArray>(LU->getInitializer())) {
1508 for (const Value *Op : A->operands()) {
1509 const auto *GV =
1510 cast<GlobalValue>(Op->stripPointerCastsNoFollowAliases());
Shoaib Meenaid8fd16b2018-01-26 00:15:25 +00001511 // Global symbols with internal or private linkage are not visible to
1512 // the linker, and thus would cause an error when the linker tried to
1513 // preserve the symbol due to the `/include:` directive.
Shoaib Meenai63b6a0e2018-01-29 20:28:04 +00001514 if (GV->hasLocalLinkage())
Saleem Abdulrasool99f479a2018-01-20 00:28:02 +00001515 continue;
1516
1517 raw_string_ostream OS(Flags);
1518 TLOF.emitLinkerFlagsForUsed(OS, GV);
1519 OS.flush();
1520
1521 if (!Flags.empty()) {
1522 OutStreamer->SwitchSection(TLOF.getDrectveSection());
1523 OutStreamer->EmitBytes(Flags);
1524 }
1525 Flags.clear();
1526 }
1527 }
1528 }
Reid Kleckner1aa90612018-01-17 23:55:23 +00001529 }
1530
Chris Lattner71a15b12009-09-18 20:17:03 +00001531 // Allow the target to emit any magic that it wants at the end of the file,
1532 // after everything else has gone out.
1533 EmitEndOfAsmFile(M);
Jim Grosbach1900c732011-03-29 23:20:22 +00001534
Craig Topper353eda42014-04-24 06:44:33 +00001535 MMI = nullptr;
Jim Grosbach1900c732011-03-29 23:20:22 +00001536
Lang Hames9ff69c82015-04-24 19:11:51 +00001537 OutStreamer->Finish();
1538 OutStreamer->reset();
Michael Zolotukhin8d052a02018-04-09 00:54:47 +00001539 OwnedMLI.reset();
1540 OwnedMDT.reset();
Pedro Artigas7212ee42012-12-12 22:59:46 +00001541
Chris Lattner6a8e0f52004-08-16 23:15:22 +00001542 return false;
1543}
1544
Rafael Espindoladc4263c2015-03-17 13:57:48 +00001545MCSymbol *AsmPrinter::getCurExceptionSym() {
1546 if (!CurExceptionSym)
Rafael Espindola9ab09232015-03-17 20:07:06 +00001547 CurExceptionSym = createTempSymbol("exception");
Rafael Espindoladc4263c2015-03-17 13:57:48 +00001548 return CurExceptionSym;
1549}
1550
Chris Lattnerbb644e32005-11-21 07:51:36 +00001551void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
Chris Lattner67159522010-01-26 04:35:26 +00001552 this->MF = &MF;
Chris Lattnera0911792010-01-16 01:24:10 +00001553 // Get the function symbol.
Matthias Braunf1caa282017-12-15 22:22:58 +00001554 CurrentFnSym = getSymbol(&MF.getFunction());
Hal Finkelad4d9f52012-02-22 21:11:47 +00001555 CurrentFnSymForSize = CurrentFnSym;
Rafael Espindola092b6192015-03-05 19:47:50 +00001556 CurrentFnBegin = nullptr;
Rafael Espindoladc4263c2015-03-17 13:57:48 +00001557 CurExceptionSym = nullptr;
Rafael Espindola092b6192015-03-05 19:47:50 +00001558 bool NeedsLocalForSize = MAI->needsLocalForSize();
Rafael Espindola78fdca32018-03-26 20:40:22 +00001559 if (needFuncLabelsForEHOrDebugInfo(MF, MMI) || NeedsLocalForSize ||
1560 MF.getTarget().Options.EmitStackSizeSection) {
Rafael Espindola9ab09232015-03-17 20:07:06 +00001561 CurrentFnBegin = createTempSymbol("func_begin");
Rafael Espindola092b6192015-03-05 19:47:50 +00001562 if (NeedsLocalForSize)
1563 CurrentFnSymForSize = CurrentFnBegin;
1564 }
David Greenef354b6e2009-08-10 16:38:07 +00001565
Justin Bogner369ba752017-02-24 00:19:22 +00001566 ORE = &getAnalysis<MachineOptimizationRemarkEmitterPass>().getORE();
Andrew V. Tischenko75745d02017-04-14 07:44:23 +00001567
1568 const TargetSubtargetInfo &STI = MF.getSubtarget();
1569 EnablePrintSchedInfo = PrintSchedule.getNumOccurrences()
1570 ? PrintSchedule
1571 : STI.supportPrintSchedInfo();
Chris Lattner6a8e0f52004-08-16 23:15:22 +00001572}
1573
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001574namespace {
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001575
Rafael Espindola0709a7b2015-05-21 19:20:38 +00001576// Keep track the alignment, constpool entries per Section.
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001577 struct SectionCPs {
Rafael Espindola0709a7b2015-05-21 19:20:38 +00001578 MCSection *S;
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001579 unsigned Alignment;
1580 SmallVector<unsigned, 4> CPEs;
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001581
Rafael Espindola0709a7b2015-05-21 19:20:38 +00001582 SectionCPs(MCSection *s, unsigned a) : S(s), Alignment(a) {}
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001583 };
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001584
1585} // end anonymous namespace
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001586
Chris Lattnerf2991ce2005-11-21 08:25:09 +00001587/// EmitConstantPool - Print to the current output stream assembly
1588/// representations of the constants in the constant pool MCP. This is
1589/// used to print out constants which have been "spilled to memory" by
1590/// the code generator.
Chris Lattner2b796242010-01-28 00:19:24 +00001591void AsmPrinter::EmitConstantPool() {
1592 const MachineConstantPool *MCP = MF->getConstantPool();
Chris Lattnerba972642006-02-09 04:22:52 +00001593 const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
Chris Lattnerf2991ce2005-11-21 08:25:09 +00001594 if (CP.empty()) return;
Evan Chengec1d60b2006-06-29 00:26:09 +00001595
Anton Korobeynikov123afb82008-09-24 22:17:59 +00001596 // Calculate sections for constant pool entries. We collect entries to go into
1597 // the same section together to reduce amount of section switch statements.
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001598 SmallVector<SectionCPs, 4> CPSections;
Chris Lattnerf2991ce2005-11-21 08:25:09 +00001599 for (unsigned i = 0, e = CP.size(); i != e; ++i) {
Chris Lattnerb300a4f2009-07-22 00:28:43 +00001600 const MachineConstantPoolEntry &CPE = CP[i];
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001601 unsigned Align = CPE.getAlignment();
Jim Grosbach1900c732011-03-29 23:20:22 +00001602
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001603 SectionKind Kind = CPE.getSectionKind(&getDataLayout());
Chris Lattnerfb6867c2009-07-26 06:26:55 +00001604
David Majnemer8bce66b2014-07-14 22:57:27 +00001605 const Constant *C = nullptr;
1606 if (!CPE.isMachineConstantPoolEntry())
1607 C = CPE.Val.ConstVal;
1608
David Majnemera3ea4072016-02-21 01:30:30 +00001609 MCSection *S = getObjFileLowering().getSectionForConstant(getDataLayout(),
1610 Kind, C, Align);
Jim Grosbach1900c732011-03-29 23:20:22 +00001611
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001612 // The number of sections are small, just do a linear search from the
1613 // last section to the first.
1614 bool Found = false;
1615 unsigned SecIdx = CPSections.size();
1616 while (SecIdx != 0) {
1617 if (CPSections[--SecIdx].S == S) {
1618 Found = true;
1619 break;
1620 }
1621 }
1622 if (!Found) {
1623 SecIdx = CPSections.size();
1624 CPSections.push_back(SectionCPs(S, Align));
1625 }
1626
1627 if (Align > CPSections[SecIdx].Alignment)
1628 CPSections[SecIdx].Alignment = Align;
1629 CPSections[SecIdx].CPEs.push_back(i);
Evan Chengec1d60b2006-06-29 00:26:09 +00001630 }
1631
Anton Korobeynikov123afb82008-09-24 22:17:59 +00001632 // Now print stuff into the calculated sections.
David Majnemer8bce66b2014-07-14 22:57:27 +00001633 const MCSection *CurSection = nullptr;
1634 unsigned Offset = 0;
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001635 for (unsigned i = 0, e = CPSections.size(); i != e; ++i) {
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001636 for (unsigned j = 0, ee = CPSections[i].CPEs.size(); j != ee; ++j) {
1637 unsigned CPI = CPSections[i].CPEs[j];
David Majnemer8bce66b2014-07-14 22:57:27 +00001638 MCSymbol *Sym = GetCPISymbol(CPI);
1639 if (!Sym->isUndefined())
1640 continue;
1641
1642 if (CurSection != CPSections[i].S) {
Lang Hames9ff69c82015-04-24 19:11:51 +00001643 OutStreamer->SwitchSection(CPSections[i].S);
David Majnemer8bce66b2014-07-14 22:57:27 +00001644 EmitAlignment(Log2_32(CPSections[i].Alignment));
1645 CurSection = CPSections[i].S;
1646 Offset = 0;
1647 }
1648
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001649 MachineConstantPoolEntry CPE = CP[CPI];
Anton Korobeynikov123afb82008-09-24 22:17:59 +00001650
Chris Lattnerf6190822006-02-09 04:46:04 +00001651 // Emit inter-object padding for alignment.
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001652 unsigned AlignMask = CPE.getAlignment() - 1;
1653 unsigned NewOffset = (Offset + AlignMask) & ~AlignMask;
Lang Hames9ff69c82015-04-24 19:11:51 +00001654 OutStreamer->EmitZeros(NewOffset - Offset);
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001655
Chris Lattner229907c2011-07-18 04:54:35 +00001656 Type *Ty = CPE.getType();
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001657 Offset = NewOffset + getDataLayout().getTypeAllocSize(Ty);
Chris Lattner4225a7b2010-01-23 05:19:23 +00001658
Lang Hames9ff69c82015-04-24 19:11:51 +00001659 OutStreamer->EmitLabel(Sym);
Evan Cheng1fb8aed2009-03-13 07:51:59 +00001660 if (CPE.isMachineConstantPoolEntry())
1661 EmitMachineConstantPoolValue(CPE.Val.MachineCPVal);
1662 else
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001663 EmitGlobalConstant(getDataLayout(), CPE.Val.ConstVal);
Chris Lattnerf6190822006-02-09 04:46:04 +00001664 }
Chris Lattnerf2991ce2005-11-21 08:25:09 +00001665 }
1666}
1667
Nate Begeman4ca2ea52006-04-22 18:53:45 +00001668/// EmitJumpTableInfo - Print assembly representations of the jump tables used
Jim Grosbach1900c732011-03-29 23:20:22 +00001669/// by the current function to the current output stream.
Chris Lattner94a946c2010-01-28 01:02:27 +00001670void AsmPrinter::EmitJumpTableInfo() {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001671 const DataLayout &DL = MF->getDataLayout();
Chris Lattner94a946c2010-01-28 01:02:27 +00001672 const MachineJumpTableInfo *MJTI = MF->getJumpTableInfo();
Craig Topper353eda42014-04-24 06:44:33 +00001673 if (!MJTI) return;
Richard Osborne6d3e92d2010-03-11 14:58:16 +00001674 if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_Inline) return;
Nate Begeman4ca2ea52006-04-22 18:53:45 +00001675 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
1676 if (JT.empty()) return;
Anton Korobeynikov2c638782007-11-14 09:18:41 +00001677
Jim Grosbach1900c732011-03-29 23:20:22 +00001678 // Pick the directive to use to print the jump table entries, and switch to
Nate Begeman78756502006-07-27 01:13:04 +00001679 // the appropriate section.
Matthias Braunf1caa282017-12-15 22:22:58 +00001680 const Function &F = MF->getFunction();
Rafael Espindola29786d42015-02-12 17:16:46 +00001681 const TargetLoweringObjectFile &TLOF = getObjFileLowering();
Rafael Espindoladf195192015-02-17 23:34:51 +00001682 bool JTInDiffSection = !TLOF.shouldPutJumpTableInFunctionSection(
1683 MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32,
Matthias Braunf1caa282017-12-15 22:22:58 +00001684 F);
Rafael Espindolaa6001792015-03-09 18:29:12 +00001685 if (JTInDiffSection) {
1686 // Drop it in the readonly section.
Matthias Braunf1caa282017-12-15 22:22:58 +00001687 MCSection *ReadOnlySection = TLOF.getSectionForJumpTable(F, TM);
Lang Hames9ff69c82015-04-24 19:11:51 +00001688 OutStreamer->SwitchSection(ReadOnlySection);
Nate Begeman78756502006-07-27 01:13:04 +00001689 }
Chris Lattnerb6db2c62010-01-25 23:26:13 +00001690
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001691 EmitAlignment(Log2_32(MJTI->getEntryAlignment(DL)));
Jim Grosbach1900c732011-03-29 23:20:22 +00001692
Jim Grosbach361ca342012-09-24 23:06:27 +00001693 // Jump tables in code sections are marked with a data_region directive
1694 // where that's supported.
1695 if (!JTInDiffSection)
Lang Hames9ff69c82015-04-24 19:11:51 +00001696 OutStreamer->EmitDataRegion(MCDR_DataRegionJT32);
Jim Grosbach361ca342012-09-24 23:06:27 +00001697
Chris Lattner4db603f2010-01-26 06:42:44 +00001698 for (unsigned JTI = 0, e = JT.size(); JTI != e; ++JTI) {
1699 const std::vector<MachineBasicBlock*> &JTBBs = JT[JTI].MBBs;
Jim Grosbach1900c732011-03-29 23:20:22 +00001700
1701 // If this jump table was deleted, ignore it.
Chris Lattner28bfe382006-10-28 18:10:06 +00001702 if (JTBBs.empty()) continue;
Nate Begeman984c1a42006-08-12 21:29:52 +00001703
Rafael Espindolac606bfe2014-10-21 01:17:30 +00001704 // For the EK_LabelDifference32 entry, if using .set avoids a relocation,
1705 /// emit a .set directive for each unique entry.
Chris Lattnercc0f7342010-01-26 05:15:20 +00001706 if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 &&
Joerg Sonnenberger22982032016-06-18 23:25:37 +00001707 MAI->doesSetDirectiveSuppressReloc()) {
Chris Lattner4db603f2010-01-26 06:42:44 +00001708 SmallPtrSet<const MachineBasicBlock*, 16> EmittedSets;
Eric Christopher504f3882015-02-19 18:46:23 +00001709 const TargetLowering *TLI = MF->getSubtarget().getTargetLowering();
Chris Lattner94a946c2010-01-28 01:02:27 +00001710 const MCExpr *Base = TLI->getPICJumpTableRelocBaseExpr(MF,JTI,OutContext);
Chris Lattner4db603f2010-01-26 06:42:44 +00001711 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
1712 const MachineBasicBlock *MBB = JTBBs[ii];
David Blaikie70573dc2014-11-19 07:49:26 +00001713 if (!EmittedSets.insert(MBB).second)
1714 continue;
Jim Grosbach1900c732011-03-29 23:20:22 +00001715
Chris Lattnerb657c4c2010-01-26 21:53:08 +00001716 // .set LJTSet, LBB32-base
1717 const MCExpr *LHS =
Jim Grosbach13760bd2015-05-30 01:25:56 +00001718 MCSymbolRefExpr::create(MBB->getSymbol(), OutContext);
Lang Hames9ff69c82015-04-24 19:11:51 +00001719 OutStreamer->EmitAssignment(GetJTSetSymbol(JTI, MBB->getNumber()),
Jim Grosbach13760bd2015-05-30 01:25:56 +00001720 MCBinaryExpr::createSub(LHS, Base,
Lang Hames9ff69c82015-04-24 19:11:51 +00001721 OutContext));
Chris Lattner4db603f2010-01-26 06:42:44 +00001722 }
Jim Grosbach1900c732011-03-29 23:20:22 +00001723 }
1724
Duncan Sands75b5d272011-02-15 09:23:02 +00001725 // On some targets (e.g. Darwin) we want to emit two consecutive labels
Chris Lattner0ee2d462007-01-18 01:12:56 +00001726 // before each jump table. The first label is never referenced, but tells
1727 // the assembler and linker the extents of the jump table object. The
1728 // second label is actually referenced by the code.
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001729 if (JTInDiffSection && DL.hasLinkerPrivateGlobalPrefix())
Chris Lattner273735b2010-01-26 05:58:28 +00001730 // FIXME: This doesn't have to have any specific name, just any randomly
1731 // named and numbered 'l' label would work. Simplify GetJTISymbol.
Lang Hames9ff69c82015-04-24 19:11:51 +00001732 OutStreamer->EmitLabel(GetJTISymbol(JTI, true));
Chris Lattner4225a7b2010-01-23 05:19:23 +00001733
Lang Hames9ff69c82015-04-24 19:11:51 +00001734 OutStreamer->EmitLabel(GetJTISymbol(JTI));
Chris Lattner4225a7b2010-01-23 05:19:23 +00001735
Chris Lattner279de3e2010-01-26 05:10:10 +00001736 for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
Chris Lattner4db603f2010-01-26 06:42:44 +00001737 EmitJumpTableEntry(MJTI, JTBBs[ii], JTI);
Nate Begeman4ca2ea52006-04-22 18:53:45 +00001738 }
Jim Grosbach361ca342012-09-24 23:06:27 +00001739 if (!JTInDiffSection)
Lang Hames9ff69c82015-04-24 19:11:51 +00001740 OutStreamer->EmitDataRegion(MCDR_DataRegionEnd);
Nate Begeman4ca2ea52006-04-22 18:53:45 +00001741}
1742
Chris Lattner279de3e2010-01-26 05:10:10 +00001743/// EmitJumpTableEntry - Emit a jump table entry for the specified MBB to the
1744/// current stream.
1745void AsmPrinter::EmitJumpTableEntry(const MachineJumpTableInfo *MJTI,
1746 const MachineBasicBlock *MBB,
1747 unsigned UID) const {
Jakob Stoklund Olesen6d4d8582011-02-09 21:52:06 +00001748 assert(MBB && MBB->getNumber() >= 0 && "Invalid basic block");
Craig Topper353eda42014-04-24 06:44:33 +00001749 const MCExpr *Value = nullptr;
Chris Lattnera7c11602010-01-26 03:43:22 +00001750 switch (MJTI->getEntryKind()) {
Richard Osborne6d3e92d2010-03-11 14:58:16 +00001751 case MachineJumpTableInfo::EK_Inline:
David Blaikie46a9f012012-01-20 21:51:11 +00001752 llvm_unreachable("Cannot emit EK_Inline jump table entry");
Chris Lattner5fc41602010-01-26 04:05:28 +00001753 case MachineJumpTableInfo::EK_Custom32:
Eric Christopher504f3882015-02-19 18:46:23 +00001754 Value = MF->getSubtarget().getTargetLowering()->LowerCustomJumpTableEntry(
1755 MJTI, MBB, UID, OutContext);
Chris Lattner5fc41602010-01-26 04:05:28 +00001756 break;
Chris Lattnera7c11602010-01-26 03:43:22 +00001757 case MachineJumpTableInfo::EK_BlockAddress:
1758 // EK_BlockAddress - Each entry is a plain address of block, e.g.:
1759 // .word LBB123
Jim Grosbach13760bd2015-05-30 01:25:56 +00001760 Value = MCSymbolRefExpr::create(MBB->getSymbol(), OutContext);
Chris Lattnera7c11602010-01-26 03:43:22 +00001761 break;
Chris Lattnera7c11602010-01-26 03:43:22 +00001762 case MachineJumpTableInfo::EK_GPRel32BlockAddress: {
1763 // EK_GPRel32BlockAddress - Each entry is an address of block, encoded
1764 // with a relocation as gp-relative, e.g.:
1765 // .gprel32 LBB123
Chris Lattner29bdac42010-03-13 21:04:28 +00001766 MCSymbol *MBBSym = MBB->getSymbol();
Jim Grosbach13760bd2015-05-30 01:25:56 +00001767 OutStreamer->EmitGPRel32Value(MCSymbolRefExpr::create(MBBSym, OutContext));
Chris Lattner19bd0392010-01-25 21:10:10 +00001768 return;
Anton Korobeynikov2c638782007-11-14 09:18:41 +00001769 }
Chris Lattner5fc41602010-01-26 04:05:28 +00001770
Akira Hatanakaf0b08442012-02-03 04:33:00 +00001771 case MachineJumpTableInfo::EK_GPRel64BlockAddress: {
1772 // EK_GPRel64BlockAddress - Each entry is an address of block, encoded
1773 // with a relocation as gp-relative, e.g.:
1774 // .gpdword LBB123
1775 MCSymbol *MBBSym = MBB->getSymbol();
Jim Grosbach13760bd2015-05-30 01:25:56 +00001776 OutStreamer->EmitGPRel64Value(MCSymbolRefExpr::create(MBBSym, OutContext));
Akira Hatanakaf0b08442012-02-03 04:33:00 +00001777 return;
1778 }
1779
Chris Lattnera7c11602010-01-26 03:43:22 +00001780 case MachineJumpTableInfo::EK_LabelDifference32: {
Rafael Espindolac606bfe2014-10-21 01:17:30 +00001781 // Each entry is the address of the block minus the address of the jump
1782 // table. This is used for PIC jump tables where gprel32 is not supported.
1783 // e.g.:
Chris Lattnera7c11602010-01-26 03:43:22 +00001784 // .word LBB123 - LJTI1_2
Rafael Espindolac606bfe2014-10-21 01:17:30 +00001785 // If the .set directive avoids relocations, this is emitted as:
Chris Lattnera7c11602010-01-26 03:43:22 +00001786 // .set L4_5_set_123, LBB123 - LJTI1_2
1787 // .word L4_5_set_123
Joerg Sonnenberger22982032016-06-18 23:25:37 +00001788 if (MAI->doesSetDirectiveSuppressReloc()) {
Jim Grosbach13760bd2015-05-30 01:25:56 +00001789 Value = MCSymbolRefExpr::create(GetJTSetSymbol(UID, MBB->getNumber()),
Chris Lattnera7c11602010-01-26 03:43:22 +00001790 OutContext);
1791 break;
1792 }
Jim Grosbach13760bd2015-05-30 01:25:56 +00001793 Value = MCSymbolRefExpr::create(MBB->getSymbol(), OutContext);
Eric Christophera7249ec2015-02-20 07:16:19 +00001794 const TargetLowering *TLI = MF->getSubtarget().getTargetLowering();
Rafael Espindola26cfbea2014-11-06 14:39:49 +00001795 const MCExpr *Base = TLI->getPICJumpTableRelocBaseExpr(MF, UID, OutContext);
Jim Grosbach13760bd2015-05-30 01:25:56 +00001796 Value = MCBinaryExpr::createSub(Value, Base, OutContext);
Chris Lattnera7c11602010-01-26 03:43:22 +00001797 break;
1798 }
Anton Korobeynikov2c638782007-11-14 09:18:41 +00001799 }
Jim Grosbach1900c732011-03-29 23:20:22 +00001800
Chris Lattnera7c11602010-01-26 03:43:22 +00001801 assert(Value && "Unknown entry kind!");
Jim Grosbach1900c732011-03-29 23:20:22 +00001802
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001803 unsigned EntrySize = MJTI->getEntrySize(getDataLayout());
Lang Hames9ff69c82015-04-24 19:11:51 +00001804 OutStreamer->EmitValue(Value, EntrySize);
Anton Korobeynikov2c638782007-11-14 09:18:41 +00001805}
1806
Chris Lattnerf0e9aef2005-12-13 06:32:10 +00001807/// EmitSpecialLLVMGlobal - Check to see if the specified global is a
1808/// special global used by LLVM. If so, emit it and return true, otherwise
1809/// do nothing and return false.
1810bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
Daniel Dunbare03eecb2009-07-25 23:55:21 +00001811 if (GV->getName() == "llvm.used") {
Chris Lattner1deb09c2010-01-23 05:51:36 +00001812 if (MAI->hasNoDeadStrip()) // No need to emit this at all.
Rafael Espindola74f2e462013-04-22 14:58:02 +00001813 EmitLLVMUsedList(cast<ConstantArray>(GV->getInitializer()));
Andrew Lenharthbeb80a92007-08-22 19:33:11 +00001814 return true;
1815 }
1816
Chris Lattner58f9bb22009-07-20 06:14:25 +00001817 // Ignore debug and non-emitted data. This handles llvm.compiler.used.
Rafael Espindola83658d62016-05-11 18:21:59 +00001818 if (GV->getSection() == "llvm.metadata" ||
Chris Lattner184f1be2009-04-13 05:44:34 +00001819 GV->hasAvailableExternallyLinkage())
1820 return true;
Jim Grosbach1900c732011-03-29 23:20:22 +00001821
Jim Laskey313570f2006-03-07 22:00:35 +00001822 if (!GV->hasAppendingLinkage()) return false;
1823
1824 assert(GV->hasInitializer() && "Not a special LLVM global!");
Jim Grosbach1900c732011-03-29 23:20:22 +00001825
Chris Lattner317293b2009-03-09 05:52:15 +00001826 if (GV->getName() == "llvm.global_ctors") {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001827 EmitXXStructorList(GV->getParent()->getDataLayout(), GV->getInitializer(),
1828 /* isCtor */ true);
Jim Grosbach1900c732011-03-29 23:20:22 +00001829
Chris Lattner126dab22009-03-09 08:18:48 +00001830 return true;
Jim Grosbach1900c732011-03-29 23:20:22 +00001831 }
1832
Chris Lattner317293b2009-03-09 05:52:15 +00001833 if (GV->getName() == "llvm.global_dtors") {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001834 EmitXXStructorList(GV->getParent()->getDataLayout(), GV->getInitializer(),
1835 /* isCtor */ false);
Chris Lattnere9d28b12010-01-19 04:34:02 +00001836
Chris Lattner126dab22009-03-09 08:18:48 +00001837 return true;
Chris Lattnerf0e9aef2005-12-13 06:32:10 +00001838 }
Jim Grosbach1900c732011-03-29 23:20:22 +00001839
Rafael Espindolae64619c2016-05-16 21:14:24 +00001840 report_fatal_error("unknown special variable");
Chris Lattnerf0e9aef2005-12-13 06:32:10 +00001841}
1842
Chris Lattnere9a75a62009-08-22 21:43:10 +00001843/// EmitLLVMUsedList - For targets that define a MAI::UsedDirective, mark each
Dale Johannesenabb1e772008-09-09 22:29:13 +00001844/// global in the specified llvm.used list for which emitUsedDirectiveFor
1845/// is true, as being used with this directive.
Rafael Espindola74f2e462013-04-22 14:58:02 +00001846void AsmPrinter::EmitLLVMUsedList(const ConstantArray *InitList) {
Dan Gohman4fe64de2009-06-14 23:30:43 +00001847 // Should be an array of 'i8*'.
Chris Lattner66af3902006-09-26 03:38:18 +00001848 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
Chris Lattner1fcac9f2009-07-17 22:00:23 +00001849 const GlobalValue *GV =
1850 dyn_cast<GlobalValue>(InitList->getOperand(i)->stripPointerCasts());
Rafael Espindola3b30cb42014-03-06 22:47:08 +00001851 if (GV)
Lang Hames9ff69c82015-04-24 19:11:51 +00001852 OutStreamer->EmitSymbolAttribute(getSymbol(GV), MCSA_NoDeadStrip);
Chris Lattner66af3902006-09-26 03:38:18 +00001853 }
1854}
1855
Reid Klecknerfceb76f2014-05-16 20:39:27 +00001856namespace {
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001857
Reid Klecknerfceb76f2014-05-16 20:39:27 +00001858struct Structor {
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001859 int Priority = 0;
1860 Constant *Func = nullptr;
1861 GlobalValue *ComdatKey = nullptr;
1862
1863 Structor() = default;
Reid Klecknerfceb76f2014-05-16 20:39:27 +00001864};
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001865
Eugene Zelenko149178d2017-10-10 22:33:29 +00001866} // end anonymous namespace
Reid Klecknerfceb76f2014-05-16 20:39:27 +00001867
Duncan Sands4d635422011-08-28 13:17:22 +00001868/// EmitXXStructorList - Emit the ctor or dtor list taking into account the init
1869/// priority.
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001870void AsmPrinter::EmitXXStructorList(const DataLayout &DL, const Constant *List,
1871 bool isCtor) {
Chris Lattnerf0e9aef2005-12-13 06:32:10 +00001872 // Should be an array of '{ int, void ()* }' structs. The first value is the
Duncan Sands4d635422011-08-28 13:17:22 +00001873 // init priority.
Chris Lattnerf0e9aef2005-12-13 06:32:10 +00001874 if (!isa<ConstantArray>(List)) return;
Chris Lattner434ffe42005-12-21 01:17:37 +00001875
Duncan Sands4d635422011-08-28 13:17:22 +00001876 // Sanity check the structors list.
1877 const ConstantArray *InitList = dyn_cast<ConstantArray>(List);
1878 if (!InitList) return; // Not an array!
1879 StructType *ETy = dyn_cast<StructType>(InitList->getType()->getElementType());
Reid Klecknerfceb76f2014-05-16 20:39:27 +00001880 // FIXME: Only allow the 3-field form in LLVM 4.0.
1881 if (!ETy || ETy->getNumElements() < 2 || ETy->getNumElements() > 3)
1882 return; // Not an array of two or three elements!
Duncan Sands4d635422011-08-28 13:17:22 +00001883 if (!isa<IntegerType>(ETy->getTypeAtIndex(0U)) ||
1884 !isa<PointerType>(ETy->getTypeAtIndex(1U))) return; // Not (int, ptr).
Reid Klecknerfceb76f2014-05-16 20:39:27 +00001885 if (ETy->getNumElements() == 3 && !isa<PointerType>(ETy->getTypeAtIndex(2U)))
1886 return; // Not (int, ptr, ptr).
Duncan Sands4d635422011-08-28 13:17:22 +00001887
1888 // Gather the structors in a form that's convenient for sorting by priority.
1889 SmallVector<Structor, 8> Structors;
Reid Klecknerfceb76f2014-05-16 20:39:27 +00001890 for (Value *O : InitList->operands()) {
1891 ConstantStruct *CS = dyn_cast<ConstantStruct>(O);
Duncan Sands4d635422011-08-28 13:17:22 +00001892 if (!CS) continue; // Malformed.
1893 if (CS->getOperand(1)->isNullValue())
1894 break; // Found a null terminator, skip the rest.
1895 ConstantInt *Priority = dyn_cast<ConstantInt>(CS->getOperand(0));
1896 if (!Priority) continue; // Malformed.
Reid Klecknerfceb76f2014-05-16 20:39:27 +00001897 Structors.push_back(Structor());
1898 Structor &S = Structors.back();
1899 S.Priority = Priority->getLimitedValue(65535);
1900 S.Func = CS->getOperand(1);
1901 if (ETy->getNumElements() == 3 && !CS->getOperand(2)->isNullValue())
Eric Christopher0b6537e2016-07-01 06:07:31 +00001902 S.ComdatKey =
1903 dyn_cast<GlobalValue>(CS->getOperand(2)->stripPointerCasts());
Duncan Sands4d635422011-08-28 13:17:22 +00001904 }
1905
Anton Korobeynikov7722a2d2012-01-25 22:24:19 +00001906 // Emit the function pointers in the target-specific order
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001907 unsigned Align = Log2_32(DL.getPointerPrefAlignment());
Reid Klecknerfceb76f2014-05-16 20:39:27 +00001908 std::stable_sort(Structors.begin(), Structors.end(),
1909 [](const Structor &L,
1910 const Structor &R) { return L.Priority < R.Priority; });
1911 for (Structor &S : Structors) {
1912 const TargetLoweringObjectFile &Obj = getObjFileLowering();
1913 const MCSymbol *KeySym = nullptr;
Hans Wennborg8e873322014-06-04 21:04:54 +00001914 if (GlobalValue *GV = S.ComdatKey) {
Teresa Johnson2d384ac2017-01-18 16:58:43 +00001915 if (GV->isDeclarationForLinker())
1916 // If the associated variable is not defined in this module
1917 // (it might be available_externally, or have been an
1918 // available_externally definition that was dropped by the
1919 // EliminateAvailableExternally pass), some other TU
Hans Wennborg8e873322014-06-04 21:04:54 +00001920 // will provide its dynamic initializer.
1921 continue;
1922
1923 KeySym = getSymbol(GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +00001924 }
Rafael Espindola0709a7b2015-05-21 19:20:38 +00001925 MCSection *OutputSection =
Rafael Espindola0766ae02014-06-06 19:26:12 +00001926 (isCtor ? Obj.getStaticCtorSection(S.Priority, KeySym)
1927 : Obj.getStaticDtorSection(S.Priority, KeySym));
Lang Hames9ff69c82015-04-24 19:11:51 +00001928 OutStreamer->SwitchSection(OutputSection);
1929 if (OutStreamer->getCurrentSection() != OutStreamer->getPreviousSection())
Anton Korobeynikov7722a2d2012-01-25 22:24:19 +00001930 EmitAlignment(Align);
Mehdi Aminibd7287e2015-07-16 06:11:10 +00001931 EmitXXStructor(DL, S.Func);
Anton Korobeynikov7722a2d2012-01-25 22:24:19 +00001932 }
Chris Lattnerf0e9aef2005-12-13 06:32:10 +00001933}
Chris Lattnerf2991ce2005-11-21 08:25:09 +00001934
Rafael Espindola0018a592013-10-16 01:49:05 +00001935void AsmPrinter::EmitModuleIdents(Module &M) {
1936 if (!MAI->hasIdentDirective())
1937 return;
1938
1939 if (const NamedMDNode *NMD = M.getNamedMetadata("llvm.ident")) {
1940 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00001941 const MDNode *N = NMD->getOperand(i);
Adrian Prantlc4fd6b72014-02-11 21:23:02 +00001942 assert(N->getNumOperands() == 1 &&
Rafael Espindola0018a592013-10-16 01:49:05 +00001943 "llvm.ident metadata entry can have only one operand");
1944 const MDString *S = cast<MDString>(N->getOperand(0));
Lang Hames9ff69c82015-04-24 19:11:51 +00001945 OutStreamer->EmitIdent(S->getString());
Rafael Espindola0018a592013-10-16 01:49:05 +00001946 }
1947 }
1948}
1949
Jim Laskey1c055e82007-01-25 15:12:02 +00001950//===--------------------------------------------------------------------===//
1951// Emission and print routines
1952//
1953
Rafael Espindola4b4d85f2018-03-29 23:32:54 +00001954/// Emit a byte directive and value.
Jim Laskey1c055e82007-01-25 15:12:02 +00001955///
Rafael Espindola4b4d85f2018-03-29 23:32:54 +00001956void AsmPrinter::emitInt8(int Value) const {
Lang Hames9ff69c82015-04-24 19:11:51 +00001957 OutStreamer->EmitIntValue(Value, 1);
Jim Laskey1c055e82007-01-25 15:12:02 +00001958}
1959
Rafael Espindola4b4d85f2018-03-29 23:32:54 +00001960/// Emit a short directive and value.
1961void AsmPrinter::emitInt16(int Value) const {
Lang Hames9ff69c82015-04-24 19:11:51 +00001962 OutStreamer->EmitIntValue(Value, 2);
Jim Laskey1c055e82007-01-25 15:12:02 +00001963}
1964
Rafael Espindola4b4d85f2018-03-29 23:32:54 +00001965/// Emit a long directive and value.
1966void AsmPrinter::emitInt32(int Value) const {
Lang Hames9ff69c82015-04-24 19:11:51 +00001967 OutStreamer->EmitIntValue(Value, 4);
Jim Laskey1c055e82007-01-25 15:12:02 +00001968}
1969
James Hendersona3acf992018-05-10 10:51:33 +00001970/// Emit a long long directive and value.
1971void AsmPrinter::emitInt64(uint64_t Value) const {
1972 OutStreamer->EmitIntValue(Value, 8);
1973}
1974
Rafael Espindolac606bfe2014-10-21 01:17:30 +00001975/// Emit something like ".long Hi-Lo" where the size in bytes of the directive
1976/// is specified by Size and Hi/Lo specify the labels. This implicitly uses
1977/// .set if it avoids relocations.
Chris Lattner9889c1e2010-03-08 23:58:37 +00001978void AsmPrinter::EmitLabelDifference(const MCSymbol *Hi, const MCSymbol *Lo,
1979 unsigned Size) const {
Rafael Espindola7c6e6e42015-06-11 18:58:08 +00001980 OutStreamer->emitAbsoluteSymbolDiff(Hi, Lo, Size);
Chris Lattner9889c1e2010-03-08 23:58:37 +00001981}
1982
Jim Grosbach1900c732011-03-29 23:20:22 +00001983/// EmitLabelPlusOffset - Emit something like ".long Label+Offset"
Devang Patelda3ef852010-09-02 16:43:44 +00001984/// where the size in bytes of the directive is specified by Size and Label
1985/// specifies the label. This implicitly uses .set if it is available.
1986void AsmPrinter::EmitLabelPlusOffset(const MCSymbol *Label, uint64_t Offset,
Eric Christopherf8da6aa2013-11-23 00:05:06 +00001987 unsigned Size,
1988 bool IsSectionRelative) const {
Matt Arsenault40dddd72013-10-03 19:50:01 +00001989 if (MAI->needsDwarfSectionOffsetDirective() && IsSectionRelative) {
Keno Fischerf7d84ee2017-01-02 03:00:19 +00001990 OutStreamer->EmitCOFFSecRel32(Label, Offset);
1991 if (Size > 4)
1992 OutStreamer->EmitZeros(Size - 4);
Carlo Kok4382da92013-08-02 16:14:15 +00001993 return;
1994 }
Jim Grosbach1900c732011-03-29 23:20:22 +00001995
Nick Lewycky33da3362012-06-22 01:25:12 +00001996 // Emit Label+Offset (or just Label if Offset is zero)
Jim Grosbach13760bd2015-05-30 01:25:56 +00001997 const MCExpr *Expr = MCSymbolRefExpr::create(Label, OutContext);
Nick Lewycky33da3362012-06-22 01:25:12 +00001998 if (Offset)
Jim Grosbach13760bd2015-05-30 01:25:56 +00001999 Expr = MCBinaryExpr::createAdd(
2000 Expr, MCConstantExpr::create(Offset, OutContext), OutContext);
Jim Grosbach1900c732011-03-29 23:20:22 +00002001
Lang Hames9ff69c82015-04-24 19:11:51 +00002002 OutStreamer->EmitValue(Expr, Size);
Devang Patelda3ef852010-09-02 16:43:44 +00002003}
Jim Grosbach1900c732011-03-29 23:20:22 +00002004
Jim Laskey1c055e82007-01-25 15:12:02 +00002005//===----------------------------------------------------------------------===//
2006
Chris Lattner3e3ff302007-05-31 18:57:45 +00002007// EmitAlignment - Emit an alignment directive to the specified power of
2008// two boundary. For example, if you pass in 3 here, you will get an 8
2009// byte alignment. If a global value is specified, and if that global has
Chris Lattner08e9e722010-04-28 19:58:07 +00002010// an explicit alignment requested, it will override the alignment request
2011// if required for correctness.
Rafael Espindola99e05cf2014-05-13 18:45:48 +00002012void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalObject *GV) const {
Eric Christopherd9134482014-08-04 21:25:23 +00002013 if (GV)
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002014 NumBits = getGVAlignmentLog2(GV, GV->getParent()->getDataLayout(), NumBits);
Jim Grosbach1900c732011-03-29 23:20:22 +00002015
Chris Lattner08e9e722010-04-28 19:58:07 +00002016 if (NumBits == 0) return; // 1-byte aligned: no need to emit alignment.
Jim Grosbach1900c732011-03-29 23:20:22 +00002017
Aaron Ballman0d6a0102014-12-16 14:04:11 +00002018 assert(NumBits <
2019 static_cast<unsigned>(std::numeric_limits<unsigned>::digits) &&
Michael Ilsemanaddddc42014-12-15 18:48:43 +00002020 "undefined behavior");
Chris Lattner0adae252009-08-18 06:15:16 +00002021 if (getCurrentSection()->getKind().isText())
Lang Hames9ff69c82015-04-24 19:11:51 +00002022 OutStreamer->EmitCodeAlignment(1u << NumBits);
Chris Lattnere4f249b2010-02-23 18:46:22 +00002023 else
Lang Hames9ff69c82015-04-24 19:11:51 +00002024 OutStreamer->EmitValueToAlignment(1u << NumBits);
Chris Lattner1d35c162004-08-17 19:14:29 +00002025}
David Greenefdd25192009-08-05 21:00:52 +00002026
Chris Lattner51003672010-04-20 06:20:21 +00002027//===----------------------------------------------------------------------===//
2028// Constant emission.
2029//===----------------------------------------------------------------------===//
2030
Matt Arsenaultdd3b77d2014-12-16 19:16:14 +00002031const MCExpr *AsmPrinter::lowerConstant(const Constant *CV) {
2032 MCContext &Ctx = OutContext;
Jim Grosbach1900c732011-03-29 23:20:22 +00002033
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002034 if (CV->isNullValue() || isa<UndefValue>(CV))
Jim Grosbach13760bd2015-05-30 01:25:56 +00002035 return MCConstantExpr::create(0, Ctx);
Chris Lattner7e0c1642010-01-13 04:29:19 +00002036
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002037 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV))
Jim Grosbach13760bd2015-05-30 01:25:56 +00002038 return MCConstantExpr::create(CI->getZExtValue(), Ctx);
Jim Grosbach1900c732011-03-29 23:20:22 +00002039
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002040 if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV))
Jim Grosbach13760bd2015-05-30 01:25:56 +00002041 return MCSymbolRefExpr::create(getSymbol(GV), Ctx);
Bill Wendling0d323ae2010-08-18 18:41:13 +00002042
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002043 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV))
Jim Grosbach13760bd2015-05-30 01:25:56 +00002044 return MCSymbolRefExpr::create(GetBlockAddressSymbol(BA), Ctx);
Jim Grosbach1900c732011-03-29 23:20:22 +00002045
Chris Lattner7e0c1642010-01-13 04:29:19 +00002046 const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV);
Craig Topper353eda42014-04-24 06:44:33 +00002047 if (!CE) {
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002048 llvm_unreachable("Unknown constant value to lower!");
Chris Lattner7e0c1642010-01-13 04:29:19 +00002049 }
Jim Grosbach1900c732011-03-29 23:20:22 +00002050
Chris Lattner7e0c1642010-01-13 04:29:19 +00002051 switch (CE->getOpcode()) {
Dan Gohman4268d6a2010-02-08 22:02:38 +00002052 default:
2053 // If the code isn't optimized, there may be outstanding folding
Micah Villmowcdfe20b2012-10-08 16:38:25 +00002054 // opportunities. Attempt to fold the expression using DataLayout as a
Dan Gohman4268d6a2010-02-08 22:02:38 +00002055 // last resort before giving up.
David Majnemerd536f232016-07-29 03:27:26 +00002056 if (Constant *C = ConstantFoldConstant(CE, getDataLayout()))
Dan Gohmane51b57b2010-02-08 22:19:11 +00002057 if (C != CE)
Matt Arsenaultdd3b77d2014-12-16 19:16:14 +00002058 return lowerConstant(C);
Dan Gohman23922872010-08-04 18:51:09 +00002059
2060 // Otherwise report the problem to the user.
2061 {
Alp Tokere69170a2014-06-26 22:52:05 +00002062 std::string S;
2063 raw_string_ostream OS(S);
Dan Gohman23922872010-08-04 18:51:09 +00002064 OS << "Unsupported expression in static initializer: ";
Chandler Carruthd48cdbf2014-01-09 02:29:41 +00002065 CE->printAsOperand(OS, /*PrintType=*/false,
Matthias Braunf1caa282017-12-15 22:22:58 +00002066 !MF ? nullptr : MF->getFunction().getParent());
Dan Gohman23922872010-08-04 18:51:09 +00002067 report_fatal_error(OS.str());
2068 }
Chris Lattner7e0c1642010-01-13 04:29:19 +00002069 case Instruction::GetElementPtr: {
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002070 // Generate a symbolic expression for the byte address
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002071 APInt OffsetAI(getDataLayout().getPointerTypeSizeInBits(CE->getType()), 0);
2072 cast<GEPOperator>(CE)->accumulateConstantOffset(getDataLayout(), OffsetAI);
Jim Grosbach1900c732011-03-29 23:20:22 +00002073
Matt Arsenaultdd3b77d2014-12-16 19:16:14 +00002074 const MCExpr *Base = lowerConstant(CE->getOperand(0));
Nuno Lopesb6ad9822012-12-30 16:25:48 +00002075 if (!OffsetAI)
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002076 return Base;
Jim Grosbach1900c732011-03-29 23:20:22 +00002077
Nuno Lopesb6ad9822012-12-30 16:25:48 +00002078 int64_t Offset = OffsetAI.getSExtValue();
Jim Grosbach13760bd2015-05-30 01:25:56 +00002079 return MCBinaryExpr::createAdd(Base, MCConstantExpr::create(Offset, Ctx),
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002080 Ctx);
Chris Lattner7e0c1642010-01-13 04:29:19 +00002081 }
Jim Grosbach1900c732011-03-29 23:20:22 +00002082
Chris Lattner7e0c1642010-01-13 04:29:19 +00002083 case Instruction::Trunc:
2084 // We emit the value and depend on the assembler to truncate the generated
2085 // expression properly. This is important for differences between
2086 // blockaddress labels. Since the two labels are in the same function, it
2087 // is reasonable to treat their delta as a 32-bit value.
Justin Bognercd1d5aa2016-08-17 20:30:52 +00002088 LLVM_FALLTHROUGH;
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002089 case Instruction::BitCast:
Matt Arsenaultdd3b77d2014-12-16 19:16:14 +00002090 return lowerConstant(CE->getOperand(0));
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002091
2092 case Instruction::IntToPtr: {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002093 const DataLayout &DL = getDataLayout();
Eric Christopher8b770652015-01-26 19:03:15 +00002094
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002095 // Handle casts to pointers by changing them into casts to the appropriate
2096 // integer type. This promotes constant folding and simplifies this code.
2097 Constant *Op = CE->getOperand(0);
Matt Arsenaultb7689122013-10-21 20:03:54 +00002098 Op = ConstantExpr::getIntegerCast(Op, DL.getIntPtrType(CV->getType()),
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002099 false/*ZExt*/);
Matt Arsenaultdd3b77d2014-12-16 19:16:14 +00002100 return lowerConstant(Op);
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002101 }
Jim Grosbach1900c732011-03-29 23:20:22 +00002102
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002103 case Instruction::PtrToInt: {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002104 const DataLayout &DL = getDataLayout();
Eric Christopher8b770652015-01-26 19:03:15 +00002105
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002106 // Support only foldable casts to/from pointers that can be eliminated by
2107 // changing the pointer to the appropriately sized integer type.
2108 Constant *Op = CE->getOperand(0);
Chris Lattner229907c2011-07-18 04:54:35 +00002109 Type *Ty = CE->getType();
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002110
Matt Arsenaultdd3b77d2014-12-16 19:16:14 +00002111 const MCExpr *OpExpr = lowerConstant(Op);
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002112
2113 // We can emit the pointer value into this slot if the slot is an
2114 // integer slot equal to the size of the pointer.
Matt Arsenault40dddd72013-10-03 19:50:01 +00002115 if (DL.getTypeAllocSize(Ty) == DL.getTypeAllocSize(Op->getType()))
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002116 return OpExpr;
2117
2118 // Otherwise the pointer is smaller than the resultant integer, mask off
2119 // the high bits so we are sure to get a proper truncation if the input is
2120 // a constant expr.
Matt Arsenault40dddd72013-10-03 19:50:01 +00002121 unsigned InBits = DL.getTypeAllocSizeInBits(Op->getType());
Jim Grosbach13760bd2015-05-30 01:25:56 +00002122 const MCExpr *MaskExpr = MCConstantExpr::create(~0ULL >> (64-InBits), Ctx);
2123 return MCBinaryExpr::createAnd(OpExpr, MaskExpr, Ctx);
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002124 }
Jim Grosbach1900c732011-03-29 23:20:22 +00002125
Peter Collingbourne265ebd72016-04-22 20:40:10 +00002126 case Instruction::Sub: {
2127 GlobalValue *LHSGV;
2128 APInt LHSOffset;
2129 if (IsConstantOffsetFromGlobal(CE->getOperand(0), LHSGV, LHSOffset,
2130 getDataLayout())) {
2131 GlobalValue *RHSGV;
2132 APInt RHSOffset;
2133 if (IsConstantOffsetFromGlobal(CE->getOperand(1), RHSGV, RHSOffset,
2134 getDataLayout())) {
Eric Christopher4367c7f2016-09-16 07:33:15 +00002135 const MCExpr *RelocExpr =
2136 getObjFileLowering().lowerRelativeReference(LHSGV, RHSGV, TM);
Peter Collingbourne265ebd72016-04-22 20:40:10 +00002137 if (!RelocExpr)
2138 RelocExpr = MCBinaryExpr::createSub(
2139 MCSymbolRefExpr::create(getSymbol(LHSGV), Ctx),
2140 MCSymbolRefExpr::create(getSymbol(RHSGV), Ctx), Ctx);
2141 int64_t Addend = (LHSOffset - RHSOffset).getSExtValue();
2142 if (Addend != 0)
2143 RelocExpr = MCBinaryExpr::createAdd(
2144 RelocExpr, MCConstantExpr::create(Addend, Ctx), Ctx);
2145 return RelocExpr;
2146 }
2147 }
2148 }
2149 // else fallthrough
Adrian Prantl0e6694d2017-12-19 22:05:25 +00002150 LLVM_FALLTHROUGH;
Peter Collingbourne265ebd72016-04-22 20:40:10 +00002151
Dan Gohman227077d2010-02-09 00:02:37 +00002152 // The MC library also has a right-shift operator, but it isn't consistently
2153 // signed or unsigned between different targets.
Chris Lattner7e0c1642010-01-13 04:29:19 +00002154 case Instruction::Add:
Dan Gohman227077d2010-02-09 00:02:37 +00002155 case Instruction::Mul:
2156 case Instruction::SDiv:
2157 case Instruction::SRem:
2158 case Instruction::Shl:
Chris Lattner7e0c1642010-01-13 04:29:19 +00002159 case Instruction::And:
2160 case Instruction::Or:
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002161 case Instruction::Xor: {
Matt Arsenaultdd3b77d2014-12-16 19:16:14 +00002162 const MCExpr *LHS = lowerConstant(CE->getOperand(0));
2163 const MCExpr *RHS = lowerConstant(CE->getOperand(1));
Chris Lattner7e0c1642010-01-13 04:29:19 +00002164 switch (CE->getOpcode()) {
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002165 default: llvm_unreachable("Unknown binary operator constant cast expr");
Jim Grosbach13760bd2015-05-30 01:25:56 +00002166 case Instruction::Add: return MCBinaryExpr::createAdd(LHS, RHS, Ctx);
2167 case Instruction::Sub: return MCBinaryExpr::createSub(LHS, RHS, Ctx);
2168 case Instruction::Mul: return MCBinaryExpr::createMul(LHS, RHS, Ctx);
2169 case Instruction::SDiv: return MCBinaryExpr::createDiv(LHS, RHS, Ctx);
2170 case Instruction::SRem: return MCBinaryExpr::createMod(LHS, RHS, Ctx);
2171 case Instruction::Shl: return MCBinaryExpr::createShl(LHS, RHS, Ctx);
2172 case Instruction::And: return MCBinaryExpr::createAnd(LHS, RHS, Ctx);
2173 case Instruction::Or: return MCBinaryExpr::createOr (LHS, RHS, Ctx);
2174 case Instruction::Xor: return MCBinaryExpr::createXor(LHS, RHS, Ctx);
Chris Lattner7e0c1642010-01-13 04:29:19 +00002175 }
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002176 }
Chris Lattner6a8e0f52004-08-16 23:15:22 +00002177 }
2178}
Chris Lattner8452a1f2004-08-17 06:36:49 +00002179
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002180static void emitGlobalConstantImpl(const DataLayout &DL, const Constant *C,
2181 AsmPrinter &AP,
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002182 const Constant *BaseCV = nullptr,
2183 uint64_t Offset = 0);
Chris Lattner51003672010-04-20 06:20:21 +00002184
Justin Bogner3135ba92015-12-08 02:37:48 +00002185static void emitGlobalConstantFP(const ConstantFP *CFP, AsmPrinter &AP);
Alina Sbirlea08fa5942018-03-09 18:48:20 +00002186static void emitGlobalConstantFP(APFloat APF, Type *ET, AsmPrinter &AP);
Justin Bogner3135ba92015-12-08 02:37:48 +00002187
David Greenecdef71f2011-08-31 17:30:56 +00002188/// isRepeatedByteSequence - Determine whether the given value is
2189/// composed of a repeated sequence of identical bytes and return the
2190/// byte value. If it is not a repeated sequence, return -1.
Chris Lattner5d4497b2012-01-24 09:31:43 +00002191static int isRepeatedByteSequence(const ConstantDataSequential *V) {
2192 StringRef Data = V->getRawDataValues();
2193 assert(!Data.empty() && "Empty aggregates should be CAZ node");
2194 char C = Data[0];
2195 for (unsigned i = 1, e = Data.size(); i != e; ++i)
2196 if (Data[i] != C) return -1;
Chandler Carruth2c469ff2012-01-30 23:47:44 +00002197 return static_cast<uint8_t>(C); // Ensure 255 is not returned as -1.
Chris Lattner5d4497b2012-01-24 09:31:43 +00002198}
2199
Chris Lattner5d4497b2012-01-24 09:31:43 +00002200/// isRepeatedByteSequence - Determine whether the given value is
2201/// composed of a repeated sequence of identical bytes and return the
2202/// byte value. If it is not a repeated sequence, return -1.
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002203static int isRepeatedByteSequence(const Value *V, const DataLayout &DL) {
David Greenecdef71f2011-08-31 17:30:56 +00002204 if (const ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002205 uint64_t Size = DL.getTypeAllocSizeInBits(V->getType());
Benjamin Kramerc6e8bfc2015-06-17 23:55:17 +00002206 assert(Size % 8 == 0);
David Greenecdef71f2011-08-31 17:30:56 +00002207
Benjamin Kramerc6e8bfc2015-06-17 23:55:17 +00002208 // Extend the element to take zero padding into account.
2209 APInt Value = CI->getValue().zextOrSelf(Size);
2210 if (!Value.isSplat(8))
2211 return -1;
David Greenecdef71f2011-08-31 17:30:56 +00002212
Benjamin Kramerc6e8bfc2015-06-17 23:55:17 +00002213 return Value.zextOrTrunc(8).getZExtValue();
David Greenecdef71f2011-08-31 17:30:56 +00002214 }
2215 if (const ConstantArray *CA = dyn_cast<ConstantArray>(V)) {
2216 // Make sure all array elements are sequences of the same repeated
2217 // byte.
Chris Lattner5d4497b2012-01-24 09:31:43 +00002218 assert(CA->getNumOperands() != 0 && "Should be a CAZ");
Benjamin Kramerc6e8bfc2015-06-17 23:55:17 +00002219 Constant *Op0 = CA->getOperand(0);
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002220 int Byte = isRepeatedByteSequence(Op0, DL);
Benjamin Kramerc6e8bfc2015-06-17 23:55:17 +00002221 if (Byte == -1)
2222 return -1;
David Greenecdef71f2011-08-31 17:30:56 +00002223
Benjamin Kramerc6e8bfc2015-06-17 23:55:17 +00002224 // All array elements must be equal.
2225 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i)
2226 if (CA->getOperand(i) != Op0)
2227 return -1;
David Greenecdef71f2011-08-31 17:30:56 +00002228 return Byte;
2229 }
Eric Christopher7c718e42012-11-20 20:34:44 +00002230
Chris Lattner5d4497b2012-01-24 09:31:43 +00002231 if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(V))
2232 return isRepeatedByteSequence(CDS);
David Greenecdef71f2011-08-31 17:30:56 +00002233
2234 return -1;
2235}
2236
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002237static void emitGlobalConstantDataSequential(const DataLayout &DL,
2238 const ConstantDataSequential *CDS,
2239 AsmPrinter &AP) {
Chris Lattner5d4497b2012-01-24 09:31:43 +00002240 // See if we can aggregate this into a .fill, if so, emit it as such.
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002241 int Value = isRepeatedByteSequence(CDS, DL);
Chris Lattner5d4497b2012-01-24 09:31:43 +00002242 if (Value != -1) {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002243 uint64_t Bytes = DL.getTypeAllocSize(CDS->getType());
Chris Lattner0d3785e2012-01-31 03:39:24 +00002244 // Don't emit a 1-byte object as a .fill.
2245 if (Bytes > 1)
Petr Hosekfaef3202016-06-01 01:59:58 +00002246 return AP.OutStreamer->emitFill(Bytes, Value);
Chris Lattner5d4497b2012-01-24 09:31:43 +00002247 }
Eric Christopher7c718e42012-11-20 20:34:44 +00002248
Chris Lattner5d4497b2012-01-24 09:31:43 +00002249 // If this can be emitted with .ascii/.asciz, emit it as such.
2250 if (CDS->isString())
Lang Hames9ff69c82015-04-24 19:11:51 +00002251 return AP.OutStreamer->EmitBytes(CDS->getAsString());
Chris Lattner5d4497b2012-01-24 09:31:43 +00002252
2253 // Otherwise, emit the values in successive locations.
2254 unsigned ElementByteSize = CDS->getElementByteSize();
2255 if (isa<IntegerType>(CDS->getElementType())) {
Chris Lattner9be59592012-01-25 01:27:20 +00002256 for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
Chris Lattner829400b2012-01-30 05:55:11 +00002257 if (AP.isVerbose())
Lang Hames9ff69c82015-04-24 19:11:51 +00002258 AP.OutStreamer->GetCommentOS() << format("0x%" PRIx64 "\n",
2259 CDS->getElementAsInteger(i));
2260 AP.OutStreamer->EmitIntValue(CDS->getElementAsInteger(i),
2261 ElementByteSize);
Chris Lattner5d4497b2012-01-24 09:31:43 +00002262 }
Chris Lattner51ebe142012-01-30 05:49:43 +00002263 } else {
Alina Sbirlea08fa5942018-03-09 18:48:20 +00002264 Type *ET = CDS->getElementType();
Justin Bogner3135ba92015-12-08 02:37:48 +00002265 for (unsigned I = 0, E = CDS->getNumElements(); I != E; ++I)
Alina Sbirlea08fa5942018-03-09 18:48:20 +00002266 emitGlobalConstantFP(CDS->getElementAsAPFloat(I), ET, AP);
Chris Lattner5d4497b2012-01-24 09:31:43 +00002267 }
2268
Matt Arsenault40dddd72013-10-03 19:50:01 +00002269 unsigned Size = DL.getTypeAllocSize(CDS->getType());
2270 unsigned EmittedSize = DL.getTypeAllocSize(CDS->getType()->getElementType()) *
Chris Lattner51ebe142012-01-30 05:49:43 +00002271 CDS->getNumElements();
Krzysztof Parzyszek5e3aba82018-05-02 17:20:22 +00002272 assert(EmittedSize <= Size && "Size cannot be less than EmittedSize!");
Chris Lattner51ebe142012-01-30 05:49:43 +00002273 if (unsigned Padding = Size - EmittedSize)
Lang Hames9ff69c82015-04-24 19:11:51 +00002274 AP.OutStreamer->EmitZeros(Padding);
Chris Lattner5d4497b2012-01-24 09:31:43 +00002275}
2276
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002277static void emitGlobalConstantArray(const DataLayout &DL,
2278 const ConstantArray *CA, AsmPrinter &AP,
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002279 const Constant *BaseCV, uint64_t Offset) {
Chris Lattnercf9e8f62012-02-05 02:29:43 +00002280 // See if we can aggregate some values. Make sure it can be
2281 // represented as a series of bytes of the constant value.
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002282 int Value = isRepeatedByteSequence(CA, DL);
David Greenecdef71f2011-08-31 17:30:56 +00002283
Chris Lattnercf9e8f62012-02-05 02:29:43 +00002284 if (Value != -1) {
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002285 uint64_t Bytes = DL.getTypeAllocSize(CA->getType());
Petr Hosekfaef3202016-06-01 01:59:58 +00002286 AP.OutStreamer->emitFill(Bytes, Value);
Dan Gohman014caa42008-12-22 21:14:27 +00002287 }
Chris Lattnercf9e8f62012-02-05 02:29:43 +00002288 else {
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002289 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i) {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002290 emitGlobalConstantImpl(DL, CA->getOperand(i), AP, BaseCV, Offset);
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002291 Offset += DL.getTypeAllocSize(CA->getOperand(i)->getType());
2292 }
Chris Lattnercf9e8f62012-02-05 02:29:43 +00002293 }
Dan Gohman014caa42008-12-22 21:14:27 +00002294}
2295
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002296static void emitGlobalConstantVector(const DataLayout &DL,
2297 const ConstantVector *CV, AsmPrinter &AP) {
Chris Lattner71601e82010-01-20 07:41:15 +00002298 for (unsigned i = 0, e = CV->getType()->getNumElements(); i != e; ++i)
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002299 emitGlobalConstantImpl(DL, CV->getOperand(i), AP);
Nick Lewycky6208a2f2011-06-22 18:55:03 +00002300
Matt Arsenault40dddd72013-10-03 19:50:01 +00002301 unsigned Size = DL.getTypeAllocSize(CV->getType());
2302 unsigned EmittedSize = DL.getTypeAllocSize(CV->getType()->getElementType()) *
Nick Lewycky6208a2f2011-06-22 18:55:03 +00002303 CV->getType()->getNumElements();
2304 if (unsigned Padding = Size - EmittedSize)
Lang Hames9ff69c82015-04-24 19:11:51 +00002305 AP.OutStreamer->EmitZeros(Padding);
Dan Gohman014caa42008-12-22 21:14:27 +00002306}
2307
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002308static void emitGlobalConstantStruct(const DataLayout &DL,
2309 const ConstantStruct *CS, AsmPrinter &AP,
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002310 const Constant *BaseCV, uint64_t Offset) {
Dan Gohman014caa42008-12-22 21:14:27 +00002311 // Print the fields in successive locations. Pad to align if needed!
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002312 unsigned Size = DL.getTypeAllocSize(CS->getType());
2313 const StructLayout *Layout = DL.getStructLayout(CS->getType());
Chris Lattnerfefcb152010-01-19 19:10:44 +00002314 uint64_t SizeSoFar = 0;
2315 for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i) {
Chris Lattner71601e82010-01-20 07:41:15 +00002316 const Constant *Field = CS->getOperand(i);
Dan Gohman014caa42008-12-22 21:14:27 +00002317
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002318 // Print the actual field value.
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002319 emitGlobalConstantImpl(DL, Field, AP, BaseCV, Offset + SizeSoFar);
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002320
Dan Gohman014caa42008-12-22 21:14:27 +00002321 // Check if padding is needed and insert one or more 0s.
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002322 uint64_t FieldSize = DL.getTypeAllocSize(Field->getType());
Chris Lattner03cb2a302010-01-20 07:11:32 +00002323 uint64_t PadSize = ((i == e-1 ? Size : Layout->getElementOffset(i+1))
2324 - Layout->getElementOffset(i)) - FieldSize;
2325 SizeSoFar += FieldSize + PadSize;
Dan Gohman014caa42008-12-22 21:14:27 +00002326
Dan Gohman014caa42008-12-22 21:14:27 +00002327 // Insert padding - this may include padding to increase the size of the
2328 // current field up to the ABI size (if the struct is not packed) as well
2329 // as padding to ensure that the next field starts at the right offset.
Lang Hames9ff69c82015-04-24 19:11:51 +00002330 AP.OutStreamer->EmitZeros(PadSize);
Dan Gohman014caa42008-12-22 21:14:27 +00002331 }
Chris Lattner03cb2a302010-01-20 07:11:32 +00002332 assert(SizeSoFar == Layout->getSizeInBytes() &&
Dan Gohman014caa42008-12-22 21:14:27 +00002333 "Layout of constant struct may be incorrect!");
2334}
2335
Alina Sbirlea08fa5942018-03-09 18:48:20 +00002336static void emitGlobalConstantFP(APFloat APF, Type *ET, AsmPrinter &AP) {
2337 APInt API = APF.bitcastToAPInt();
Tim Northover3a51aab2013-01-11 10:36:13 +00002338
2339 // First print a comment with what we think the original floating-point value
2340 // should have been.
2341 if (AP.isVerbose()) {
2342 SmallString<8> StrVal;
Alina Sbirlea08fa5942018-03-09 18:48:20 +00002343 APF.toString(StrVal);
Tim Northover3a51aab2013-01-11 10:36:13 +00002344
Alina Sbirlea08fa5942018-03-09 18:48:20 +00002345 if (ET)
2346 ET->print(AP.OutStreamer->GetCommentOS());
Richard Trieuc1485222014-06-21 02:43:02 +00002347 else
Lang Hames9ff69c82015-04-24 19:11:51 +00002348 AP.OutStreamer->GetCommentOS() << "Printing <null> Type";
2349 AP.OutStreamer->GetCommentOS() << ' ' << StrVal << '\n';
Chris Lattnereaef5e12010-01-19 22:16:33 +00002350 }
Tim Northover3a51aab2013-01-11 10:36:13 +00002351
2352 // Now iterate through the APInt chunks, emitting them in endian-correct
2353 // order, possibly with a smaller chunk at beginning/end (e.g. for x87 80-bit
2354 // floats).
2355 unsigned NumBytes = API.getBitWidth() / 8;
2356 unsigned TrailingBytes = NumBytes % sizeof(uint64_t);
2357 const uint64_t *p = API.getRawData();
2358
2359 // PPC's long double has odd notions of endianness compared to how LLVM
2360 // handles it: p[0] goes first for *big* endian on PPC.
Alina Sbirlea08fa5942018-03-09 18:48:20 +00002361 if (AP.getDataLayout().isBigEndian() && !ET->isPPC_FP128Ty()) {
Tim Northover3a51aab2013-01-11 10:36:13 +00002362 int Chunk = API.getNumWords() - 1;
2363
2364 if (TrailingBytes)
Lang Hames9ff69c82015-04-24 19:11:51 +00002365 AP.OutStreamer->EmitIntValue(p[Chunk--], TrailingBytes);
Tim Northover3a51aab2013-01-11 10:36:13 +00002366
2367 for (; Chunk >= 0; --Chunk)
Lang Hames9ff69c82015-04-24 19:11:51 +00002368 AP.OutStreamer->EmitIntValue(p[Chunk], sizeof(uint64_t));
Tim Northover3a51aab2013-01-11 10:36:13 +00002369 } else {
2370 unsigned Chunk;
2371 for (Chunk = 0; Chunk < NumBytes / sizeof(uint64_t); ++Chunk)
Lang Hames9ff69c82015-04-24 19:11:51 +00002372 AP.OutStreamer->EmitIntValue(p[Chunk], sizeof(uint64_t));
Tim Northover3a51aab2013-01-11 10:36:13 +00002373
2374 if (TrailingBytes)
Lang Hames9ff69c82015-04-24 19:11:51 +00002375 AP.OutStreamer->EmitIntValue(p[Chunk], TrailingBytes);
Tim Northover3a51aab2013-01-11 10:36:13 +00002376 }
2377
2378 // Emit the tail padding for the long double.
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002379 const DataLayout &DL = AP.getDataLayout();
Alina Sbirlea08fa5942018-03-09 18:48:20 +00002380 AP.OutStreamer->EmitZeros(DL.getTypeAllocSize(ET) - DL.getTypeStoreSize(ET));
2381}
2382
2383static void emitGlobalConstantFP(const ConstantFP *CFP, AsmPrinter &AP) {
2384 emitGlobalConstantFP(CFP->getValueAPF(), CFP->getType(), AP);
Dan Gohman014caa42008-12-22 21:14:27 +00002385}
2386
Rafael Espindola64e1af82013-07-02 15:49:13 +00002387static void emitGlobalConstantLargeInt(const ConstantInt *CI, AsmPrinter &AP) {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002388 const DataLayout &DL = AP.getDataLayout();
Dan Gohman014caa42008-12-22 21:14:27 +00002389 unsigned BitWidth = CI->getBitWidth();
Quentin Colombetba366012013-06-07 18:36:03 +00002390
2391 // Copy the value as we may massage the layout for constants whose bit width
2392 // is not a multiple of 64-bits.
2393 APInt Realigned(CI->getValue());
2394 uint64_t ExtraBits = 0;
2395 unsigned ExtraBitsSize = BitWidth & 63;
2396
2397 if (ExtraBitsSize) {
2398 // The bit width of the data is not a multiple of 64-bits.
2399 // The extra bits are expected to be at the end of the chunk of the memory.
2400 // Little endian:
2401 // * Nothing to be done, just record the extra bits to emit.
2402 // Big endian:
2403 // * Record the extra bits to emit.
2404 // * Realign the raw data to emit the chunks of 64-bits.
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002405 if (DL.isBigEndian()) {
Quentin Colombetba366012013-06-07 18:36:03 +00002406 // Basically the structure of the raw data is a chunk of 64-bits cells:
2407 // 0 1 BitWidth / 64
2408 // [chunk1][chunk2] ... [chunkN].
2409 // The most significant chunk is chunkN and it should be emitted first.
2410 // However, due to the alignment issue chunkN contains useless bits.
2411 // Realign the chunks so that they contain only useless information:
2412 // ExtraBits 0 1 (BitWidth / 64) - 1
2413 // chu[nk1 chu][nk2 chu] ... [nkN-1 chunkN]
2414 ExtraBits = Realigned.getRawData()[0] &
2415 (((uint64_t)-1) >> (64 - ExtraBitsSize));
Craig Topperfc947bc2017-04-18 17:14:21 +00002416 Realigned.lshrInPlace(ExtraBitsSize);
Quentin Colombetba366012013-06-07 18:36:03 +00002417 } else
2418 ExtraBits = Realigned.getRawData()[BitWidth / 64];
2419 }
Dan Gohman014caa42008-12-22 21:14:27 +00002420
2421 // We don't expect assemblers to support integer data directives
2422 // for more than 64 bits, so we emit the data in at most 64-bit
2423 // quantities at a time.
Quentin Colombetba366012013-06-07 18:36:03 +00002424 const uint64_t *RawData = Realigned.getRawData();
Dan Gohman014caa42008-12-22 21:14:27 +00002425 for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002426 uint64_t Val = DL.isBigEndian() ? RawData[e - i - 1] : RawData[i];
Lang Hames9ff69c82015-04-24 19:11:51 +00002427 AP.OutStreamer->EmitIntValue(Val, 8);
Dan Gohman014caa42008-12-22 21:14:27 +00002428 }
Quentin Colombetba366012013-06-07 18:36:03 +00002429
2430 if (ExtraBitsSize) {
2431 // Emit the extra bits after the 64-bits chunks.
2432
2433 // Emit a directive that fills the expected size.
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002434 uint64_t Size = AP.getDataLayout().getTypeAllocSize(CI->getType());
Quentin Colombetba366012013-06-07 18:36:03 +00002435 Size -= (BitWidth / 64) * 8;
2436 assert(Size && Size * 8 >= ExtraBitsSize &&
2437 (ExtraBits & (((uint64_t)-1) >> (64 - ExtraBitsSize)))
2438 == ExtraBits && "Directive too small for extra bits.");
Lang Hames9ff69c82015-04-24 19:11:51 +00002439 AP.OutStreamer->EmitIntValue(ExtraBits, Size);
Quentin Colombetba366012013-06-07 18:36:03 +00002440 }
Dan Gohman014caa42008-12-22 21:14:27 +00002441}
2442
Adrian Prantl5f8f34e42018-05-01 15:54:18 +00002443/// Transform a not absolute MCExpr containing a reference to a GOT
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002444/// equivalent global, by a target specific GOT pc relative access to the
2445/// final symbol.
2446static void handleIndirectSymViaGOTPCRel(AsmPrinter &AP, const MCExpr **ME,
2447 const Constant *BaseCst,
2448 uint64_t Offset) {
2449 // The global @foo below illustrates a global that uses a got equivalent.
2450 //
2451 // @bar = global i32 42
2452 // @gotequiv = private unnamed_addr constant i32* @bar
2453 // @foo = i32 trunc (i64 sub (i64 ptrtoint (i32** @gotequiv to i64),
2454 // i64 ptrtoint (i32* @foo to i64))
2455 // to i32)
2456 //
2457 // The cstexpr in @foo is converted into the MCExpr `ME`, where we actually
2458 // check whether @foo is suitable to use a GOTPCREL. `ME` is usually in the
2459 // form:
2460 //
2461 // foo = cstexpr, where
2462 // cstexpr := <gotequiv> - "." + <cst>
2463 // cstexpr := <gotequiv> - (<foo> - <offset from @foo base>) + <cst>
2464 //
Jim Grosbach13760bd2015-05-30 01:25:56 +00002465 // After canonicalization by evaluateAsRelocatable `ME` turns into:
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002466 //
2467 // cstexpr := <gotequiv> - <foo> + gotpcrelcst, where
2468 // gotpcrelcst := <offset from @foo base> + <cst>
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002469 MCValue MV;
Jim Grosbach13760bd2015-05-30 01:25:56 +00002470 if (!(*ME)->evaluateAsRelocatable(MV, nullptr, nullptr) || MV.isAbsolute())
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002471 return;
Bruno Cardoso Lopesedb876d2015-06-25 15:17:23 +00002472 const MCSymbolRefExpr *SymA = MV.getSymA();
2473 if (!SymA)
2474 return;
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002475
Bruno Cardoso Lopesedb876d2015-06-25 15:17:23 +00002476 // Check that GOT equivalent symbol is cached.
2477 const MCSymbol *GOTEquivSym = &SymA->getSymbol();
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002478 if (!AP.GlobalGOTEquivs.count(GOTEquivSym))
2479 return;
2480
Bruno Cardoso Lopese8640512015-07-21 21:45:42 +00002481 const GlobalValue *BaseGV = dyn_cast_or_null<GlobalValue>(BaseCst);
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002482 if (!BaseGV)
2483 return;
2484
Bruno Cardoso Lopesedb876d2015-06-25 15:17:23 +00002485 // Check for a valid base symbol
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002486 const MCSymbol *BaseSym = AP.getSymbol(BaseGV);
Bruno Cardoso Lopesedb876d2015-06-25 15:17:23 +00002487 const MCSymbolRefExpr *SymB = MV.getSymB();
2488
2489 if (!SymB || BaseSym != &SymB->getSymbol())
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002490 return;
2491
2492 // Make sure to match:
2493 //
2494 // gotpcrelcst := <offset from @foo base> + <cst>
2495 //
Bruno Cardoso Lopes618c67a2015-03-06 13:49:05 +00002496 // If gotpcrelcst is positive it means that we can safely fold the pc rel
2497 // displacement into the GOTPCREL. We can also can have an extra offset <cst>
2498 // if the target knows how to encode it.
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002499 int64_t GOTPCRelCst = Offset + MV.getConstant();
2500 if (GOTPCRelCst < 0)
2501 return;
Bruno Cardoso Lopes52b13912015-03-06 13:48:45 +00002502 if (!AP.getObjFileLowering().supportGOTPCRelWithOffset() && GOTPCRelCst != 0)
2503 return;
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002504
2505 // Emit the GOT PC relative to replace the got equivalent global, i.e.:
2506 //
2507 // bar:
2508 // .long 42
2509 // gotequiv:
2510 // .quad bar
2511 // foo:
2512 // .long gotequiv - "." + <cst>
2513 //
2514 // is replaced by the target specific equivalent to:
2515 //
2516 // bar:
2517 // .long 42
2518 // foo:
2519 // .long bar@GOTPCREL+<gotpcrelcst>
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002520 AsmPrinter::GOTEquivUsePair Result = AP.GlobalGOTEquivs[GOTEquivSym];
2521 const GlobalVariable *GV = Result.first;
Bruno Cardoso Lopesb3a58b42015-03-10 20:05:23 +00002522 int NumUses = (int)Result.second;
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002523 const GlobalValue *FinalGV = dyn_cast<GlobalValue>(GV->getOperand(0));
2524 const MCSymbol *FinalSym = AP.getSymbol(FinalGV);
Bruno Cardoso Lopes618c67a2015-03-06 13:49:05 +00002525 *ME = AP.getObjFileLowering().getIndirectSymViaGOTPCRel(
Lang Hames9ff69c82015-04-24 19:11:51 +00002526 FinalSym, MV, Offset, AP.MMI, *AP.OutStreamer);
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002527
2528 // Update GOT equivalent usage information
2529 --NumUses;
Bruno Cardoso Lopesb3a58b42015-03-10 20:05:23 +00002530 if (NumUses >= 0)
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002531 AP.GlobalGOTEquivs[GOTEquivSym] = std::make_pair(GV, NumUses);
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002532}
2533
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002534static void emitGlobalConstantImpl(const DataLayout &DL, const Constant *CV,
2535 AsmPrinter &AP, const Constant *BaseCV,
2536 uint64_t Offset) {
2537 uint64_t Size = DL.getTypeAllocSize(CV->getType());
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002538
2539 // Globals with sub-elements such as combinations of arrays and structs
2540 // are handled recursively by emitGlobalConstantImpl. Keep track of the
2541 // constant symbol base and the current position with BaseCV and Offset.
2542 if (!BaseCV && CV->hasOneUse())
2543 BaseCV = dyn_cast<Constant>(CV->user_back());
2544
Bill Wendling7315c4b2012-03-20 08:56:43 +00002545 if (isa<ConstantAggregateZero>(CV) || isa<UndefValue>(CV))
Lang Hames9ff69c82015-04-24 19:11:51 +00002546 return AP.OutStreamer->EmitZeros(Size);
Chris Lattner03cb2a302010-01-20 07:11:32 +00002547
2548 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
Chris Lattner03cb2a302010-01-20 07:11:32 +00002549 switch (Size) {
2550 case 1:
2551 case 2:
2552 case 4:
2553 case 8:
Chris Lattner51003672010-04-20 06:20:21 +00002554 if (AP.isVerbose())
Lang Hames9ff69c82015-04-24 19:11:51 +00002555 AP.OutStreamer->GetCommentOS() << format("0x%" PRIx64 "\n",
2556 CI->getZExtValue());
2557 AP.OutStreamer->EmitIntValue(CI->getZExtValue(), Size);
Chris Lattner03cb2a302010-01-20 07:11:32 +00002558 return;
2559 default:
Rafael Espindola64e1af82013-07-02 15:49:13 +00002560 emitGlobalConstantLargeInt(CI, AP);
Chris Lattner03cb2a302010-01-20 07:11:32 +00002561 return;
2562 }
2563 }
Jim Grosbach1900c732011-03-29 23:20:22 +00002564
Chris Lattnerfefcb152010-01-19 19:10:44 +00002565 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV))
Rafael Espindola64e1af82013-07-02 15:49:13 +00002566 return emitGlobalConstantFP(CFP, AP);
Chris Lattner8452a1f2004-08-17 06:36:49 +00002567
Chris Lattnerc47ece52010-01-20 17:57:50 +00002568 if (isa<ConstantPointerNull>(CV)) {
Lang Hames9ff69c82015-04-24 19:11:51 +00002569 AP.OutStreamer->EmitIntValue(0, Size);
Chris Lattnerc47ece52010-01-20 17:57:50 +00002570 return;
2571 }
Jim Grosbach1900c732011-03-29 23:20:22 +00002572
Chris Lattner5d4497b2012-01-24 09:31:43 +00002573 if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(CV))
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002574 return emitGlobalConstantDataSequential(DL, CDS, AP);
Eric Christopher7c718e42012-11-20 20:34:44 +00002575
Chris Lattner5d4497b2012-01-24 09:31:43 +00002576 if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV))
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002577 return emitGlobalConstantArray(DL, CVA, AP, BaseCV, Offset);
Jim Grosbach1900c732011-03-29 23:20:22 +00002578
Chris Lattner5d4497b2012-01-24 09:31:43 +00002579 if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV))
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002580 return emitGlobalConstantStruct(DL, CVS, AP, BaseCV, Offset);
Chris Lattner5d4497b2012-01-24 09:31:43 +00002581
Bill Wendling7315c4b2012-03-20 08:56:43 +00002582 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
2583 // Look through bitcasts, which might not be able to be MCExpr'ized (e.g. of
2584 // vectors).
Chris Lattner5d4497b2012-01-24 09:31:43 +00002585 if (CE->getOpcode() == Instruction::BitCast)
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002586 return emitGlobalConstantImpl(DL, CE->getOperand(0), AP);
Bill Wendling7315c4b2012-03-20 08:56:43 +00002587
2588 if (Size > 8) {
2589 // If the constant expression's size is greater than 64-bits, then we have
2590 // to emit the value in chunks. Try to constant fold the value and emit it
2591 // that way.
David Majnemerd536f232016-07-29 03:27:26 +00002592 Constant *New = ConstantFoldConstant(CE, DL);
Bill Wendling7315c4b2012-03-20 08:56:43 +00002593 if (New && New != CE)
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002594 return emitGlobalConstantImpl(DL, New, AP);
Bill Wendling7315c4b2012-03-20 08:56:43 +00002595 }
2596 }
Eric Christopher7c718e42012-11-20 20:34:44 +00002597
Chris Lattner5d4497b2012-01-24 09:31:43 +00002598 if (const ConstantVector *V = dyn_cast<ConstantVector>(CV))
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002599 return emitGlobalConstantVector(DL, V, AP);
Eric Christopher7c718e42012-11-20 20:34:44 +00002600
Chris Lattnerd1acffc2010-01-23 06:17:14 +00002601 // Otherwise, it must be a ConstantExpr. Lower it to an MCExpr, then emit it
2602 // thread the streamer with EmitValue.
Bruno Cardoso Lopes24492b02015-02-23 21:26:18 +00002603 const MCExpr *ME = AP.lowerConstant(CV);
2604
2605 // Since lowerConstant already folded and got rid of all IR pointer and
2606 // integer casts, detect GOT equivalent accesses by looking into the MCExpr
2607 // directly.
2608 if (AP.getObjFileLowering().supportIndirectSymViaGOTPCRel())
2609 handleIndirectSymViaGOTPCRel(AP, &ME, BaseCV, Offset);
2610
Lang Hames9ff69c82015-04-24 19:11:51 +00002611 AP.OutStreamer->EmitValue(ME, Size);
Chris Lattner51003672010-04-20 06:20:21 +00002612}
2613
2614/// EmitGlobalConstant - Print a general LLVM constant to the .s file.
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002615void AsmPrinter::EmitGlobalConstant(const DataLayout &DL, const Constant *CV) {
2616 uint64_t Size = DL.getTypeAllocSize(CV->getType());
Chris Lattner51003672010-04-20 06:20:21 +00002617 if (Size)
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002618 emitGlobalConstantImpl(DL, CV, *this);
Chris Lattner51003672010-04-20 06:20:21 +00002619 else if (MAI->hasSubsectionsViaSymbols()) {
2620 // If the global has zero size, emit a single byte so that two labels don't
2621 // look like they are at the same location.
Lang Hames9ff69c82015-04-24 19:11:51 +00002622 OutStreamer->EmitIntValue(0, 1);
Chris Lattner51003672010-04-20 06:20:21 +00002623 }
Chris Lattner8452a1f2004-08-17 06:36:49 +00002624}
Chris Lattner061d9e22006-01-27 02:10:10 +00002625
Chris Lattner17f71652008-08-17 07:19:36 +00002626void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
Evan Cheng45fe3bc2006-09-12 21:00:35 +00002627 // Target doesn't support this yet!
Torok Edwinfbcc6632009-07-14 16:55:14 +00002628 llvm_unreachable("Target does not support EmitMachineConstantPoolValue");
Evan Cheng45fe3bc2006-09-12 21:00:35 +00002629}
2630
Chris Lattnerc334d802010-04-04 18:16:38 +00002631void AsmPrinter::printOffset(int64_t Offset, raw_ostream &OS) const {
2632 if (Offset > 0)
2633 OS << '+' << Offset;
2634 else if (Offset < 0)
2635 OS << Offset;
2636}
2637
Chris Lattnera179b522010-04-04 19:25:43 +00002638//===----------------------------------------------------------------------===//
2639// Symbol Lowering Routines.
2640//===----------------------------------------------------------------------===//
2641
Rafael Espindola9ab09232015-03-17 20:07:06 +00002642MCSymbol *AsmPrinter::createTempSymbol(const Twine &Name) const {
2643 return OutContext.createTempSymbol(Name, true);
Rafael Espindola629cdba2015-02-27 18:18:39 +00002644}
Chris Lattneraa23fa92006-02-01 22:41:11 +00002645
Chris Lattnerebc970e2010-02-08 23:10:08 +00002646MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BlockAddress *BA) const {
Chris Lattner9efbbcb2010-03-14 17:53:23 +00002647 return MMI->getAddrLabelSymbol(BA->getBasicBlock());
Dan Gohman6c938802009-10-30 01:27:03 +00002648}
2649
Chris Lattner9efbbcb2010-03-14 17:53:23 +00002650MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BasicBlock *BB) const {
2651 return MMI->getAddrLabelSymbol(BB);
Dan Gohman6c938802009-10-30 01:27:03 +00002652}
2653
Chris Lattner4225a7b2010-01-23 05:19:23 +00002654/// GetCPISymbol - Return the symbol for the specified constant pool entry.
2655MCSymbol *AsmPrinter::GetCPISymbol(unsigned CPID) const {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002656 const DataLayout &DL = getDataLayout();
2657 return OutContext.getOrCreateSymbol(Twine(DL.getPrivateGlobalPrefix()) +
2658 "CPI" + Twine(getFunctionNumber()) + "_" +
2659 Twine(CPID));
Chris Lattner4225a7b2010-01-23 05:19:23 +00002660}
2661
2662/// GetJTISymbol - Return the symbol for the specified jump table entry.
Bill Wendling36321712010-06-29 22:34:52 +00002663MCSymbol *AsmPrinter::GetJTISymbol(unsigned JTID, bool isLinkerPrivate) const {
2664 return MF->getJTISymbol(JTID, OutContext, isLinkerPrivate);
Chris Lattnera602beb2009-09-12 23:02:08 +00002665}
2666
Chris Lattner00d188f2010-01-25 21:17:10 +00002667/// GetJTSetSymbol - Return the symbol for the specified jump table .set
2668/// FIXME: privatize to AsmPrinter.
2669MCSymbol *AsmPrinter::GetJTSetSymbol(unsigned UID, unsigned MBBID) const {
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002670 const DataLayout &DL = getDataLayout();
2671 return OutContext.getOrCreateSymbol(Twine(DL.getPrivateGlobalPrefix()) +
2672 Twine(getFunctionNumber()) + "_" +
2673 Twine(UID) + "_set_" + Twine(MBBID));
Chris Lattner00d188f2010-01-25 21:17:10 +00002674}
2675
Rafael Espindolaf4e6b292013-12-02 16:25:47 +00002676MCSymbol *AsmPrinter::getSymbolWithGlobalValueBase(const GlobalValue *GV,
Rafael Espindola61b3d0c2013-11-28 19:35:07 +00002677 StringRef Suffix) const {
Eric Christopher4367c7f2016-09-16 07:33:15 +00002678 return getObjFileLowering().getSymbolWithGlobalValueBase(GV, Suffix, TM);
Chris Lattner0dca0a92010-01-15 23:25:11 +00002679}
2680
Rafael Espindolac233f742015-06-23 13:59:29 +00002681/// Return the MCSymbol for the specified ExternalSymbol.
Chris Lattner91687f62010-01-15 23:18:17 +00002682MCSymbol *AsmPrinter::GetExternalSymbolSymbol(StringRef Sym) const {
2683 SmallString<60> NameStr;
Mehdi Aminibd7287e2015-07-16 06:11:10 +00002684 Mangler::getNameWithPrefix(NameStr, Sym, getDataLayout());
Jim Grosbach6f482002015-05-18 18:43:14 +00002685 return OutContext.getOrCreateSymbol(NameStr);
Jim Grosbach1900c732011-03-29 23:20:22 +00002686}
Chris Lattner91687f62010-01-15 23:18:17 +00002687
Chris Lattner978e2f02010-01-22 21:50:41 +00002688/// PrintParentLoopComment - Print comments about parent loops of this one.
2689static void PrintParentLoopComment(raw_ostream &OS, const MachineLoop *Loop,
2690 unsigned FunctionNumber) {
Craig Topper353eda42014-04-24 06:44:33 +00002691 if (!Loop) return;
Chris Lattner978e2f02010-01-22 21:50:41 +00002692 PrintParentLoopComment(OS, Loop->getParentLoop(), FunctionNumber);
2693 OS.indent(Loop->getLoopDepth()*2)
2694 << "Parent Loop BB" << FunctionNumber << "_"
2695 << Loop->getHeader()->getNumber()
2696 << " Depth=" << Loop->getLoopDepth() << '\n';
2697}
2698
Chris Lattner978e2f02010-01-22 21:50:41 +00002699/// PrintChildLoopComment - Print comments about child loops within
2700/// the loop for this basic block, with nesting.
2701static void PrintChildLoopComment(raw_ostream &OS, const MachineLoop *Loop,
2702 unsigned FunctionNumber) {
2703 // Add child loop information
Jim Grosbach6623e7f2014-04-16 22:38:02 +00002704 for (const MachineLoop *CL : *Loop) {
2705 OS.indent(CL->getLoopDepth()*2)
Chris Lattner978e2f02010-01-22 21:50:41 +00002706 << "Child Loop BB" << FunctionNumber << "_"
Jim Grosbach6623e7f2014-04-16 22:38:02 +00002707 << CL->getHeader()->getNumber() << " Depth " << CL->getLoopDepth()
Chris Lattner978e2f02010-01-22 21:50:41 +00002708 << '\n';
Jim Grosbach6623e7f2014-04-16 22:38:02 +00002709 PrintChildLoopComment(OS, CL, FunctionNumber);
Chris Lattner978e2f02010-01-22 21:50:41 +00002710 }
2711}
2712
Chad Rosierb759ede2012-09-07 18:16:38 +00002713/// emitBasicBlockLoopComments - Pretty-print comments for basic blocks.
2714static void emitBasicBlockLoopComments(const MachineBasicBlock &MBB,
Chris Lattnerc334d802010-04-04 18:16:38 +00002715 const MachineLoopInfo *LI,
2716 const AsmPrinter &AP) {
Chris Lattner978e2f02010-01-22 21:50:41 +00002717 // Add loop depth information
2718 const MachineLoop *Loop = LI->getLoopFor(&MBB);
Craig Topper353eda42014-04-24 06:44:33 +00002719 if (!Loop) return;
Jim Grosbach1900c732011-03-29 23:20:22 +00002720
Chris Lattner978e2f02010-01-22 21:50:41 +00002721 MachineBasicBlock *Header = Loop->getHeader();
2722 assert(Header && "No header for loop");
Jim Grosbach1900c732011-03-29 23:20:22 +00002723
Chris Lattner978e2f02010-01-22 21:50:41 +00002724 // If this block is not a loop header, just print out what is the loop header
2725 // and return.
2726 if (Header != &MBB) {
Lang Hames9ff69c82015-04-24 19:11:51 +00002727 AP.OutStreamer->AddComment(" in Loop: Header=BB" +
2728 Twine(AP.getFunctionNumber())+"_" +
2729 Twine(Loop->getHeader()->getNumber())+
2730 " Depth="+Twine(Loop->getLoopDepth()));
Chris Lattner978e2f02010-01-22 21:50:41 +00002731 return;
2732 }
Jim Grosbach1900c732011-03-29 23:20:22 +00002733
Chris Lattner978e2f02010-01-22 21:50:41 +00002734 // Otherwise, it is a loop header. Print out information about child and
2735 // parent loops.
Lang Hames9ff69c82015-04-24 19:11:51 +00002736 raw_ostream &OS = AP.OutStreamer->GetCommentOS();
Jim Grosbach1900c732011-03-29 23:20:22 +00002737
2738 PrintParentLoopComment(OS, Loop->getParentLoop(), AP.getFunctionNumber());
2739
Chris Lattner978e2f02010-01-22 21:50:41 +00002740 OS << "=>";
2741 OS.indent(Loop->getLoopDepth()*2-2);
Jim Grosbach1900c732011-03-29 23:20:22 +00002742
Chris Lattner978e2f02010-01-22 21:50:41 +00002743 OS << "This ";
2744 if (Loop->empty())
2745 OS << "Inner ";
2746 OS << "Loop Header: Depth=" + Twine(Loop->getLoopDepth()) << '\n';
Jim Grosbach1900c732011-03-29 23:20:22 +00002747
Chris Lattner978e2f02010-01-22 21:50:41 +00002748 PrintChildLoopComment(OS, Loop, AP.getFunctionNumber());
2749}
2750
Omer Paparo Bivas2251c792017-10-24 06:16:03 +00002751void AsmPrinter::setupCodePaddingContext(const MachineBasicBlock &MBB,
2752 MCCodePaddingContext &Context) const {
2753 assert(MF != nullptr && "Machine function must be valid");
Omer Paparo Bivas2251c792017-10-24 06:16:03 +00002754 Context.IsPaddingActive = !MF->hasInlineAsm() &&
Matthias Braunf1caa282017-12-15 22:22:58 +00002755 !MF->getFunction().optForSize() &&
Omer Paparo Bivas2251c792017-10-24 06:16:03 +00002756 TM.getOptLevel() != CodeGenOpt::None;
Omer Paparo Bivas2251c792017-10-24 06:16:03 +00002757 Context.IsBasicBlockReachableViaFallthrough =
2758 std::find(MBB.pred_begin(), MBB.pred_end(), MBB.getPrevNode()) !=
2759 MBB.pred_end();
2760 Context.IsBasicBlockReachableViaBranch =
2761 MBB.pred_size() > 0 && !isBlockOnlyReachableByFallthrough(&MBB);
2762}
2763
Chris Lattner1d04aa72009-09-13 18:25:37 +00002764/// EmitBasicBlockStart - This method prints the label for the specified
2765/// MachineBasicBlock, an alignment (if present) and a comment describing
2766/// it if appropriate.
Jim Grosbach6623e7f2014-04-16 22:38:02 +00002767void AsmPrinter::EmitBasicBlockStart(const MachineBasicBlock &MBB) const {
David Majnemera80c1512015-09-29 20:12:33 +00002768 // End the previous funclet and start a new one.
2769 if (MBB.isEHFuncletEntry()) {
2770 for (const HandlerInfo &HI : Handlers) {
2771 HI.Handler->endFunclet();
2772 HI.Handler->beginFunclet(MBB);
2773 }
2774 }
2775
Dan Gohmanc83dc4b2009-10-30 01:34:35 +00002776 // Emit an alignment directive for this block, if needed.
Jim Grosbach6623e7f2014-04-16 22:38:02 +00002777 if (unsigned Align = MBB.getAlignment())
Jakob Stoklund Olesen10e12522011-12-06 01:26:19 +00002778 EmitAlignment(Align);
Omer Paparo Bivas2251c792017-10-24 06:16:03 +00002779 MCCodePaddingContext Context;
2780 setupCodePaddingContext(MBB, Context);
2781 OutStreamer->EmitCodePaddingBasicBlockStart(Context);
Evan Chengc7990652008-02-28 00:43:03 +00002782
Chris Lattnerdb035a02010-03-16 00:29:39 +00002783 // If the block has its address taken, emit any labels that were used to
2784 // reference the block. It is possible that there is more than one label
2785 // here, because multiple LLVM BB's may have been RAUW'd to this block after
2786 // the references were generated.
Jim Grosbach6623e7f2014-04-16 22:38:02 +00002787 if (MBB.hasAddressTaken()) {
2788 const BasicBlock *BB = MBB.getBasicBlock();
Chris Lattner7bde8c02010-04-04 18:52:31 +00002789 if (isVerbose())
Lang Hames9ff69c82015-04-24 19:11:51 +00002790 OutStreamer->AddComment("Block address taken");
Jim Grosbach1900c732011-03-29 23:20:22 +00002791
Joseph Tremoulet3d0fbf12015-10-23 15:06:05 +00002792 // MBBs can have their address taken as part of CodeGen without having
2793 // their corresponding BB's address taken in IR
2794 if (BB->hasAddressTaken())
2795 for (MCSymbol *Sym : MMI->getAddrLabelSymbolToEmit(BB))
2796 OutStreamer->EmitLabel(Sym);
Dan Gohman6c938802009-10-30 01:27:03 +00002797 }
2798
Jakob Stoklund Olesen936656b2012-03-06 22:27:13 +00002799 // Print some verbose block comments.
2800 if (isVerbose()) {
David Majnemer11234ed2015-12-25 09:37:26 +00002801 if (const BasicBlock *BB = MBB.getBasicBlock()) {
2802 if (BB->hasName()) {
2803 BB->printAsOperand(OutStreamer->GetCommentOS(),
2804 /*PrintType=*/false, BB->getModule());
2805 OutStreamer->GetCommentOS() << '\n';
2806 }
2807 }
Michael Zolotukhin8d052a02018-04-09 00:54:47 +00002808
2809 assert(MLI != nullptr && "MachineLoopInfo should has been computed");
2810 emitBasicBlockLoopComments(MBB, MLI, *this);
Jakob Stoklund Olesen936656b2012-03-06 22:27:13 +00002811 }
2812
Dan Gohmanc83dc4b2009-10-30 01:34:35 +00002813 // Print the main label for the block.
Reid Kleckner0e288232015-08-27 23:27:47 +00002814 if (MBB.pred_empty() ||
2815 (isBlockOnlyReachableByFallthrough(&MBB) && !MBB.isEHFuncletEntry())) {
Rafael Espindola499a7482014-01-31 23:14:01 +00002816 if (isVerbose()) {
Chris Lattner17167212010-04-03 22:12:35 +00002817 // NOTE: Want this comment at start of line, don't emit with AddComment.
Francis Visoiu Mistrih25528d62017-12-04 17:18:51 +00002818 OutStreamer->emitRawComment(" %bb." + Twine(MBB.getNumber()) + ":",
2819 false);
Chris Lattnera3eee3c2010-01-22 19:52:01 +00002820 }
Dan Gohman10d3dc52009-10-06 17:38:38 +00002821 } else {
Lang Hames9ff69c82015-04-24 19:11:51 +00002822 OutStreamer->EmitLabel(MBB.getSymbol());
Dan Gohman10d3dc52009-10-06 17:38:38 +00002823 }
Nate Begeman4ca2ea52006-04-22 18:53:45 +00002824}
Nate Begeman984c1a42006-08-12 21:29:52 +00002825
Omer Paparo Bivas2251c792017-10-24 06:16:03 +00002826void AsmPrinter::EmitBasicBlockEnd(const MachineBasicBlock &MBB) {
2827 MCCodePaddingContext Context;
2828 setupCodePaddingContext(MBB, Context);
2829 OutStreamer->EmitCodePaddingBasicBlockEnd(Context);
2830}
2831
Stuart Hastingsbf836592011-02-23 02:27:05 +00002832void AsmPrinter::EmitVisibility(MCSymbol *Sym, unsigned Visibility,
2833 bool IsDefinition) const {
Chris Lattner0bfd2792010-01-23 06:53:23 +00002834 MCSymbolAttr Attr = MCSA_Invalid;
Jim Grosbach1900c732011-03-29 23:20:22 +00002835
Chris Lattner0bfd2792010-01-23 06:53:23 +00002836 switch (Visibility) {
2837 default: break;
2838 case GlobalValue::HiddenVisibility:
Stuart Hastingsbf836592011-02-23 02:27:05 +00002839 if (IsDefinition)
2840 Attr = MAI->getHiddenVisibilityAttr();
2841 else
2842 Attr = MAI->getHiddenDeclarationVisibilityAttr();
Chris Lattner0bfd2792010-01-23 06:53:23 +00002843 break;
2844 case GlobalValue::ProtectedVisibility:
2845 Attr = MAI->getProtectedVisibilityAttr();
2846 break;
Chris Lattner7fec1802010-01-15 23:38:51 +00002847 }
Chris Lattner0bfd2792010-01-23 06:53:23 +00002848
2849 if (Attr != MCSA_Invalid)
Lang Hames9ff69c82015-04-24 19:11:51 +00002850 OutStreamer->EmitSymbolAttribute(Sym, Attr);
Chris Lattner7fec1802010-01-15 23:38:51 +00002851}
2852
Chris Lattner1fa9c2cc2010-02-17 18:52:56 +00002853/// isBlockOnlyReachableByFallthough - Return true if the basic block has
2854/// exactly one predecessor and the control transfer mechanism between
2855/// the predecessor and this block is a fall-through.
Chris Lattner2cf5f9e2010-04-04 17:57:56 +00002856bool AsmPrinter::
2857isBlockOnlyReachableByFallthrough(const MachineBasicBlock *MBB) const {
Chris Lattner1fa9c2cc2010-02-17 18:52:56 +00002858 // If this is a landing pad, it isn't a fall through. If it has no preds,
2859 // then nothing falls through to it.
Reid Kleckner0e288232015-08-27 23:27:47 +00002860 if (MBB->isEHPad() || MBB->pred_empty())
Chris Lattner1fa9c2cc2010-02-17 18:52:56 +00002861 return false;
Jim Grosbach1900c732011-03-29 23:20:22 +00002862
Chris Lattner1fa9c2cc2010-02-17 18:52:56 +00002863 // If there isn't exactly one predecessor, it can't be a fall through.
Jim Grosbach6623e7f2014-04-16 22:38:02 +00002864 if (MBB->pred_size() > 1)
Chris Lattner1fa9c2cc2010-02-17 18:52:56 +00002865 return false;
Jim Grosbach1900c732011-03-29 23:20:22 +00002866
Chris Lattner1fa9c2cc2010-02-17 18:52:56 +00002867 // The predecessor has to be immediately before this block.
Jim Grosbach6623e7f2014-04-16 22:38:02 +00002868 MachineBasicBlock *Pred = *MBB->pred_begin();
Chris Lattner1fa9c2cc2010-02-17 18:52:56 +00002869 if (!Pred->isLayoutSuccessor(MBB))
2870 return false;
Jim Grosbach1900c732011-03-29 23:20:22 +00002871
Chris Lattner1fa9c2cc2010-02-17 18:52:56 +00002872 // If the block is completely empty, then it definitely does fall through.
2873 if (Pred->empty())
2874 return true;
Jim Grosbach1900c732011-03-29 23:20:22 +00002875
Eli Friedman8a3264a2011-06-14 19:30:33 +00002876 // Check the terminators in the previous blocks
Jim Grosbach6623e7f2014-04-16 22:38:02 +00002877 for (const auto &MI : Pred->terminators()) {
Eli Friedman8a3264a2011-06-14 19:30:33 +00002878 // If it is not a simple branch, we are in a table somewhere.
Evan Cheng7f8e5632011-12-07 07:15:52 +00002879 if (!MI.isBranch() || MI.isIndirectBranch())
Eli Friedman8a3264a2011-06-14 19:30:33 +00002880 return false;
2881
Jakob Stoklund Olesen1995b9f2014-01-12 19:24:08 +00002882 // If we are the operands of one of the branches, this is not a fall
2883 // through. Note that targets with delay slots will usually bundle
2884 // terminators with the delay slot instruction.
Duncan P. N. Exon Smithf9ab4162016-02-27 17:05:33 +00002885 for (ConstMIBundleOperands OP(MI); OP.isValid(); ++OP) {
Jakob Stoklund Olesen1995b9f2014-01-12 19:24:08 +00002886 if (OP->isJTI())
Rafael Espindolaab205672011-06-15 21:00:28 +00002887 return false;
Jakob Stoklund Olesen1995b9f2014-01-12 19:24:08 +00002888 if (OP->isMBB() && OP->getMBB() == MBB)
Eli Friedman8a3264a2011-06-14 19:30:33 +00002889 return false;
2890 }
2891 }
2892
2893 return true;
Chris Lattner1fa9c2cc2010-02-17 18:52:56 +00002894}
2895
David Blaikie88368ba2014-04-15 05:34:49 +00002896GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy &S) {
2897 if (!S.usesMetadata())
Craig Topper353eda42014-04-24 06:44:33 +00002898 return nullptr;
Chris Lattner2cf5f9e2010-04-04 17:57:56 +00002899
Philip Reames4ac17a32015-01-07 19:07:50 +00002900 assert(!S.useStatepoints() && "statepoints do not currently support custom"
2901 " stackmap formats, please see the documentation for a description of"
2902 " the default format. If you really need a custom serialized format,"
2903 " please file a bug");
2904
Chris Lattner2cf5f9e2010-04-04 17:57:56 +00002905 gcp_map_type &GCMap = getGCMap(GCMetadataPrinters);
David Blaikie88368ba2014-04-15 05:34:49 +00002906 gcp_map_type::iterator GCPI = GCMap.find(&S);
Chris Lattner2cf5f9e2010-04-04 17:57:56 +00002907 if (GCPI != GCMap.end())
David Blaikieec528ee2014-04-15 05:53:26 +00002908 return GCPI->second.get();
Jim Grosbach1900c732011-03-29 23:20:22 +00002909
Mehdi Amini74107172016-10-01 15:44:54 +00002910 auto Name = S.getName();
Jim Grosbach1900c732011-03-29 23:20:22 +00002911
Gordon Henriksendbe06d32008-08-17 12:08:44 +00002912 for (GCMetadataPrinterRegistry::iterator
2913 I = GCMetadataPrinterRegistry::begin(),
2914 E = GCMetadataPrinterRegistry::end(); I != E; ++I)
Mehdi Amini74107172016-10-01 15:44:54 +00002915 if (Name == I->getName()) {
David Blaikieec528ee2014-04-15 05:53:26 +00002916 std::unique_ptr<GCMetadataPrinter> GMP = I->instantiate();
David Blaikie88368ba2014-04-15 05:34:49 +00002917 GMP->S = &S;
David Blaikieec528ee2014-04-15 05:53:26 +00002918 auto IterBool = GCMap.insert(std::make_pair(&S, std::move(GMP)));
2919 return IterBool.first->second.get();
Gordon Henriksendbe06d32008-08-17 12:08:44 +00002920 }
Jim Grosbach1900c732011-03-29 23:20:22 +00002921
Chris Lattner2104b8d2010-04-07 22:58:41 +00002922 report_fatal_error("no GCMetadataPrinter registered for GC: " + Twine(Name));
Gordon Henriksendbe06d32008-08-17 12:08:44 +00002923}
Juergen Ributzkadb9ee002013-12-14 12:23:14 +00002924
2925/// Pin vtable to this file.
Eugene Zelenkod96089b2017-02-14 00:33:36 +00002926AsmPrinterHandler::~AsmPrinterHandler() = default;
Rafael Espindolaa6001792015-03-09 18:29:12 +00002927
2928void AsmPrinterHandler::markFunctionEnd() {}
Dean Michael Berris464015442016-09-19 00:54:35 +00002929
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +00002930// In the binary's "xray_instr_map" section, an array of these function entries
2931// describes each instrumentation point. When XRay patches your code, the index
2932// into this table will be given to your handler as a patch point identifier.
2933void AsmPrinter::XRayFunctionEntry::emit(int Bytes, MCStreamer *Out,
2934 const MCSymbol *CurrentFnSym) const {
2935 Out->EmitSymbolValue(Sled, Bytes);
2936 Out->EmitSymbolValue(CurrentFnSym, Bytes);
2937 auto Kind8 = static_cast<uint8_t>(Kind);
Dean Michael Berrisebc16592017-09-04 05:34:58 +00002938 Out->EmitBinaryData(StringRef(reinterpret_cast<const char *>(&Kind8), 1));
2939 Out->EmitBinaryData(
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +00002940 StringRef(reinterpret_cast<const char *>(&AlwaysInstrument), 1));
Dean Michael Berrisebc16592017-09-04 05:34:58 +00002941 Out->EmitBinaryData(StringRef(reinterpret_cast<const char *>(&Version), 1));
2942 auto Padding = (4 * Bytes) - ((2 * Bytes) + 3);
2943 assert(Padding >= 0 && "Instrumentation map entry > 4 * Word Size");
2944 Out->EmitZeros(Padding);
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +00002945}
2946
2947void AsmPrinter::emitXRayTable() {
2948 if (Sleds.empty())
2949 return;
2950
2951 auto PrevSection = OutStreamer->getCurrentSectionOnly();
Matthias Braunf1caa282017-12-15 22:22:58 +00002952 const Function &F = MF->getFunction();
Dean Michael Berrisbdfe9002017-05-04 03:37:57 +00002953 MCSection *InstMap = nullptr;
2954 MCSection *FnSledIndex = nullptr;
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +00002955 if (MF->getSubtarget().getTargetTriple().isOSBinFormatELF()) {
Dean Michael Berris01fd7c82017-09-14 07:08:23 +00002956 auto Associated = dyn_cast<MCSymbolELF>(CurrentFnSym);
Dean Michael Berrisebc16592017-09-04 05:34:58 +00002957 assert(Associated != nullptr);
2958 auto Flags = ELF::SHF_WRITE | ELF::SHF_ALLOC | ELF::SHF_LINK_ORDER;
2959 std::string GroupName;
Matthias Braunf1caa282017-12-15 22:22:58 +00002960 if (F.hasComdat()) {
Dean Michael Berrisebc16592017-09-04 05:34:58 +00002961 Flags |= ELF::SHF_GROUP;
Matthias Braunf1caa282017-12-15 22:22:58 +00002962 GroupName = F.getComdat()->getName();
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +00002963 }
Dean Michael Berrisebc16592017-09-04 05:34:58 +00002964
2965 auto UniqueID = ++XRayFnUniqueID;
2966 InstMap =
2967 OutContext.getELFSection("xray_instr_map", ELF::SHT_PROGBITS, Flags, 0,
2968 GroupName, UniqueID, Associated);
2969 FnSledIndex =
2970 OutContext.getELFSection("xray_fn_idx", ELF::SHT_PROGBITS, Flags, 0,
2971 GroupName, UniqueID, Associated);
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +00002972 } else if (MF->getSubtarget().getTargetTriple().isOSBinFormatMachO()) {
Dean Michael Berrisbdfe9002017-05-04 03:37:57 +00002973 InstMap = OutContext.getMachOSection("__DATA", "xray_instr_map", 0,
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +00002974 SectionKind::getReadOnlyWithRel());
Dean Michael Berrisbdfe9002017-05-04 03:37:57 +00002975 FnSledIndex = OutContext.getMachOSection("__DATA", "xray_fn_idx", 0,
2976 SectionKind::getReadOnlyWithRel());
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +00002977 } else {
2978 llvm_unreachable("Unsupported target");
2979 }
2980
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +00002981 auto WordSizeBytes = MAI->getCodePointerSize();
Dean Michael Berrisbdfe9002017-05-04 03:37:57 +00002982
2983 // Now we switch to the instrumentation map section. Because this is done
2984 // per-function, we are able to create an index entry that will represent the
2985 // range of sleds associated with a function.
Dean Michael Berris28ecff52017-06-21 06:39:42 +00002986 MCSymbol *SledsStart = OutContext.createTempSymbol("xray_sleds_start", true);
Dean Michael Berrisbdfe9002017-05-04 03:37:57 +00002987 OutStreamer->SwitchSection(InstMap);
2988 OutStreamer->EmitLabel(SledsStart);
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +00002989 for (const auto &Sled : Sleds)
2990 Sled.emit(WordSizeBytes, OutStreamer.get(), CurrentFnSym);
Dean Michael Berris28ecff52017-06-21 06:39:42 +00002991 MCSymbol *SledsEnd = OutContext.createTempSymbol("xray_sleds_end", true);
Dean Michael Berrisbdfe9002017-05-04 03:37:57 +00002992 OutStreamer->EmitLabel(SledsEnd);
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +00002993
Dean Michael Berrisbdfe9002017-05-04 03:37:57 +00002994 // We then emit a single entry in the index per function. We use the symbols
2995 // that bound the instrumentation map as the range for a specific function.
Dean Michael Berrisebdccd02017-05-04 04:55:46 +00002996 // Each entry here will be 2 * word size aligned, as we're writing down two
2997 // pointers. This should work for both 32-bit and 64-bit platforms.
Dean Michael Berrisbdfe9002017-05-04 03:37:57 +00002998 OutStreamer->SwitchSection(FnSledIndex);
Dean Michael Berrisebdccd02017-05-04 04:55:46 +00002999 OutStreamer->EmitCodeAlignment(2 * WordSizeBytes);
Dean Michael Berrisebc16592017-09-04 05:34:58 +00003000 OutStreamer->EmitSymbolValue(SledsStart, WordSizeBytes, false);
3001 OutStreamer->EmitSymbolValue(SledsEnd, WordSizeBytes, false);
Dean Michael Berrisf7e7b932017-01-03 04:30:21 +00003002 OutStreamer->SwitchSection(PrevSection);
3003 Sleds.clear();
3004}
3005
Dean Michael Berris464015442016-09-19 00:54:35 +00003006void AsmPrinter::recordSled(MCSymbol *Sled, const MachineInstr &MI,
Dean Michael Berrisebc16592017-09-04 05:34:58 +00003007 SledKind Kind, uint8_t Version) {
Matthias Braunf1caa282017-12-15 22:22:58 +00003008 const Function &F = MI.getMF()->getFunction();
3009 auto Attr = F.getFnAttribute("function-instrument");
3010 bool LogArgs = F.hasFnAttribute("xray-log-args");
Dean Michael Berris464015442016-09-19 00:54:35 +00003011 bool AlwaysInstrument =
3012 Attr.isStringAttribute() && Attr.getValueAsString() == "xray-always";
Dean Michael Berris7e8eea42017-03-06 06:48:56 +00003013 if (Kind == SledKind::FUNCTION_ENTER && LogArgs)
3014 Kind = SledKind::LOG_ARGS_ENTER;
Dean Michael Berrisebc16592017-09-04 05:34:58 +00003015 Sleds.emplace_back(XRayFunctionEntry{Sled, CurrentFnSym, Kind,
Matthias Braunf1caa282017-12-15 22:22:58 +00003016 AlwaysInstrument, &F, Version});
Dean Michael Berris464015442016-09-19 00:54:35 +00003017}
Greg Claytone6543972016-11-23 23:30:37 +00003018
3019uint16_t AsmPrinter::getDwarfVersion() const {
3020 return OutStreamer->getContext().getDwarfVersion();
3021}
3022
3023void AsmPrinter::setDwarfVersion(uint16_t Version) {
3024 OutStreamer->getContext().setDwarfVersion(Version);
3025}