blob: f3f24ae5c8bb430830a45d3e00d785a37ba81af9 [file] [log] [blame]
Chris Lattnerf7e79482002-04-07 22:31:46 +00001//===-- AsmWriter.cpp - Printing LLVM as an assembly file -----------------===//
Misha Brukmanb1c93172005-04-21 23:48:37 +00002//
John Criswell482202a2003-10-20 19:43:21 +00003// 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.
Misha Brukmanb1c93172005-04-21 23:48:37 +00007//
John Criswell482202a2003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner2f7c9632001-06-06 20:29:01 +00009//
10// This library implements the functionality defined in llvm/Assembly/Writer.h
11//
Chris Lattner189088e2002-04-12 18:21:53 +000012// Note that these routines must be extremely tolerant of various errors in the
Chris Lattnerf70da102003-05-08 02:44:12 +000013// LLVM code, because it can be used for debugging transformations.
Chris Lattner189088e2002-04-12 18:21:53 +000014//
Chris Lattner2f7c9632001-06-06 20:29:01 +000015//===----------------------------------------------------------------------===//
16
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +000017#include "llvm/Assembly/Writer.h"
Chris Lattner7f8845a2002-07-23 18:07:49 +000018#include "llvm/Assembly/PrintModulePass.h"
Chris Lattnerad074cb2010-09-02 23:09:42 +000019#include "llvm/Assembly/AssemblyAnnotationWriter.h"
Erick Tryzelaar72a37132010-03-02 05:32:52 +000020#include "llvm/LLVMContext.h"
Chris Lattnerf7b6d312005-05-06 20:26:43 +000021#include "llvm/CallingConv.h"
Chris Lattnerc70b3f62004-01-20 19:50:34 +000022#include "llvm/Constants.h"
Bill Wendling5cb50c52012-06-28 00:41:44 +000023#include "llvm/DebugInfo.h"
Chris Lattner913d18f2002-04-29 18:46:50 +000024#include "llvm/DerivedTypes.h"
Chris Lattner8bbcda22006-01-25 18:57:27 +000025#include "llvm/InlineAsm.h"
Chris Lattner2f2aa2b2009-12-28 23:41:32 +000026#include "llvm/IntrinsicInst.h"
Dan Gohman0ebd6962009-07-20 21:19:07 +000027#include "llvm/Operator.h"
Chris Lattnerc70b3f62004-01-20 19:50:34 +000028#include "llvm/Module.h"
Bill Wendling8555a372012-08-03 00:30:35 +000029#include "llvm/TypeFinder.h"
Reid Spencer3aaaa0b2007-02-05 20:47:22 +000030#include "llvm/ValueSymbolTable.h"
Chris Lattnerb1ed91f2011-07-09 17:41:24 +000031#include "llvm/ADT/DenseMap.h"
Benjamin Kramerb17c5862010-01-29 14:42:22 +000032#include "llvm/ADT/SmallString.h"
Reid Spencer7c16caa2004-09-01 22:55:40 +000033#include "llvm/ADT/StringExtras.h"
34#include "llvm/ADT/STLExtras.h"
Bill Wendlingdfc91892006-11-28 02:09:03 +000035#include "llvm/Support/CFG.h"
David Greenec7f9b122010-01-05 01:29:26 +000036#include "llvm/Support/Debug.h"
Devang Patel711ab5b2009-09-30 20:16:54 +000037#include "llvm/Support/Dwarf.h"
Torok Edwin6dd27302009-07-08 18:01:40 +000038#include "llvm/Support/ErrorHandling.h"
Jim Laskeyb74c6662005-08-17 19:34:49 +000039#include "llvm/Support/MathExtras.h"
Dan Gohmane2745262009-08-12 17:23:50 +000040#include "llvm/Support/FormattedStream.h"
Chris Lattnerfee714f2001-09-07 16:36:04 +000041#include <algorithm>
Reid Spencerbdf03b42007-05-22 19:27:35 +000042#include <cctype>
Chris Lattner189d19f2003-11-21 20:23:48 +000043using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000044
Reid Spencer294715b2005-05-15 16:13:11 +000045// Make virtual table appear in this compilation unit.
46AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
47
Chris Lattner3eee99c2008-08-19 04:36:02 +000048//===----------------------------------------------------------------------===//
49// Helper Functions
50//===----------------------------------------------------------------------===//
51
52static const Module *getModuleFromVal(const Value *V) {
53 if (const Argument *MA = dyn_cast<Argument>(V))
54 return MA->getParent() ? MA->getParent()->getParent() : 0;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +000055
Chris Lattner3eee99c2008-08-19 04:36:02 +000056 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
57 return BB->getParent() ? BB->getParent()->getParent() : 0;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +000058
Chris Lattner3eee99c2008-08-19 04:36:02 +000059 if (const Instruction *I = dyn_cast<Instruction>(V)) {
60 const Function *M = I->getParent() ? I->getParent()->getParent() : 0;
61 return M ? M->getParent() : 0;
62 }
Andrew Trickec4b6e72011-09-30 19:48:58 +000063
Chris Lattner3eee99c2008-08-19 04:36:02 +000064 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
65 return GV->getParent();
66 return 0;
67}
68
Daniel Dunbardb0b70a2008-10-28 19:33:02 +000069// PrintEscapedString - Print each character of the specified string, escaping
70// it if it is not printable or if it is an escape char.
Chris Lattner9380b812010-07-07 23:16:37 +000071static void PrintEscapedString(StringRef Name, raw_ostream &Out) {
Daniel Dunbare03eecb2009-07-25 23:55:21 +000072 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
73 unsigned char C = Name[i];
Nick Lewycky5aa592a2009-03-15 06:39:52 +000074 if (isprint(C) && C != '\\' && C != '"')
Daniel Dunbardb0b70a2008-10-28 19:33:02 +000075 Out << C;
76 else
77 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
78 }
79}
80
Chris Lattner3eee99c2008-08-19 04:36:02 +000081enum PrefixType {
82 GlobalPrefix,
83 LabelPrefix,
Daniel Dunbar389529a2008-10-14 23:28:09 +000084 LocalPrefix,
85 NoPrefix
Chris Lattner3eee99c2008-08-19 04:36:02 +000086};
87
88/// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
89/// prefixed with % (if the string only contains simple characters) or is
90/// surrounded with ""'s (if it has special chars in it). Print it out.
Benjamin Kramer92d89982010-07-14 22:38:02 +000091static void PrintLLVMName(raw_ostream &OS, StringRef Name, PrefixType Prefix) {
Jay Foadf7adb322011-04-24 14:30:00 +000092 assert(!Name.empty() && "Cannot get empty name!");
Chris Lattner3eee99c2008-08-19 04:36:02 +000093 switch (Prefix) {
Daniel Dunbar389529a2008-10-14 23:28:09 +000094 case NoPrefix: break;
Chris Lattner1508d3f2008-08-19 05:16:28 +000095 case GlobalPrefix: OS << '@'; break;
96 case LabelPrefix: break;
97 case LocalPrefix: OS << '%'; break;
Nick Lewycky063699a2009-03-19 06:31:22 +000098 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +000099
Chris Lattner3eee99c2008-08-19 04:36:02 +0000100 // Scan the name to see if it needs quotes first.
Daniel Dunbare03eecb2009-07-25 23:55:21 +0000101 bool NeedsQuotes = isdigit(Name[0]);
Chris Lattner3eee99c2008-08-19 04:36:02 +0000102 if (!NeedsQuotes) {
Daniel Dunbare03eecb2009-07-25 23:55:21 +0000103 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
Aaron Ballmaned9b0a92012-07-16 16:18:18 +0000104 // By making this unsigned, the value passed in to isalnum will always be
105 // in the range 0-255. This is important when building with MSVC because
106 // its implementation will assert. This situation can arise when dealing
107 // with UTF-8 multibyte characters.
108 unsigned char C = Name[i];
Chris Lattner3eee99c2008-08-19 04:36:02 +0000109 if (!isalnum(C) && C != '-' && C != '.' && C != '_') {
110 NeedsQuotes = true;
111 break;
112 }
113 }
114 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000115
Chris Lattner3eee99c2008-08-19 04:36:02 +0000116 // If we didn't need any quotes, just write out the name in one blast.
117 if (!NeedsQuotes) {
Daniel Dunbare03eecb2009-07-25 23:55:21 +0000118 OS << Name;
Chris Lattner3eee99c2008-08-19 04:36:02 +0000119 return;
120 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000121
Chris Lattner3eee99c2008-08-19 04:36:02 +0000122 // Okay, we need quotes. Output the quotes and escape any scary characters as
123 // needed.
124 OS << '"';
Daniel Dunbare03eecb2009-07-25 23:55:21 +0000125 PrintEscapedString(Name, OS);
Chris Lattner3eee99c2008-08-19 04:36:02 +0000126 OS << '"';
127}
128
129/// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
130/// prefixed with % (if the string only contains simple characters) or is
131/// surrounded with ""'s (if it has special chars in it). Print it out.
Dan Gohman12dad632009-08-12 20:56:03 +0000132static void PrintLLVMName(raw_ostream &OS, const Value *V) {
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000133 PrintLLVMName(OS, V->getName(),
Chris Lattner3eee99c2008-08-19 04:36:02 +0000134 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
135}
136
Chris Lattner0f578952009-02-28 20:25:14 +0000137//===----------------------------------------------------------------------===//
138// TypePrinting Class: Type printing machinery
139//===----------------------------------------------------------------------===//
140
Chris Lattner3a16c712011-06-18 21:23:04 +0000141/// TypePrinting - Type printing machinery.
142namespace {
143class TypePrinting {
Chris Lattner3a16c712011-06-18 21:23:04 +0000144 TypePrinting(const TypePrinting &); // DO NOT IMPLEMENT
145 void operator=(const TypePrinting&); // DO NOT IMPLEMENT
146public:
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000147
148 /// NamedTypes - The named types that are used by the current module.
Bill Wendling8555a372012-08-03 00:30:35 +0000149 TypeFinder NamedTypes;
Andrew Trickec4b6e72011-09-30 19:48:58 +0000150
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000151 /// NumberedTypes - The numbered types, along with their value.
152 DenseMap<StructType*, unsigned> NumberedTypes;
Andrew Trickec4b6e72011-09-30 19:48:58 +0000153
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000154
Chris Lattner3a16c712011-06-18 21:23:04 +0000155 TypePrinting() {}
156 ~TypePrinting() {}
Andrew Trickec4b6e72011-09-30 19:48:58 +0000157
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000158 void incorporateTypes(const Module &M);
Andrew Trickec4b6e72011-09-30 19:48:58 +0000159
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000160 void print(Type *Ty, raw_ostream &OS);
Andrew Trickec4b6e72011-09-30 19:48:58 +0000161
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000162 void printStructBody(StructType *Ty, raw_ostream &OS);
Chris Lattner3a16c712011-06-18 21:23:04 +0000163};
164} // end anonymous namespace.
Chris Lattner3ad46822009-02-28 22:34:45 +0000165
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000166
167void TypePrinting::incorporateTypes(const Module &M) {
Bill Wendling8555a372012-08-03 00:30:35 +0000168 NamedTypes.run(M, false);
Andrew Trickec4b6e72011-09-30 19:48:58 +0000169
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000170 // The list of struct types we got back includes all the struct types, split
171 // the unnamed ones out to a numbering and remove the anonymous structs.
172 unsigned NextNumber = 0;
Andrew Trickec4b6e72011-09-30 19:48:58 +0000173
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000174 std::vector<StructType*>::iterator NextToUse = NamedTypes.begin(), I, E;
175 for (I = NamedTypes.begin(), E = NamedTypes.end(); I != E; ++I) {
176 StructType *STy = *I;
Andrew Trickec4b6e72011-09-30 19:48:58 +0000177
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000178 // Ignore anonymous types.
Chris Lattner01beceb2011-08-12 18:07:07 +0000179 if (STy->isLiteral())
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000180 continue;
Andrew Trickec4b6e72011-09-30 19:48:58 +0000181
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000182 if (STy->getName().empty())
183 NumberedTypes[STy] = NextNumber++;
184 else
185 *NextToUse++ = STy;
186 }
Andrew Trickec4b6e72011-09-30 19:48:58 +0000187
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000188 NamedTypes.erase(NextToUse, NamedTypes.end());
189}
190
191
Chris Lattner40959d02009-02-28 20:49:40 +0000192/// CalcTypeName - Write the specified type to the specified raw_ostream, making
193/// use of type names or up references to shorten the type name where possible.
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000194void TypePrinting::print(Type *Ty, raw_ostream &OS) {
Chris Lattner0f578952009-02-28 20:25:14 +0000195 switch (Ty->getTypeID()) {
Chris Lattner06a23212009-02-28 21:27:31 +0000196 case Type::VoidTyID: OS << "void"; break;
Dan Gohman518cda42011-12-17 00:04:22 +0000197 case Type::HalfTyID: OS << "half"; break;
Chris Lattner06a23212009-02-28 21:27:31 +0000198 case Type::FloatTyID: OS << "float"; break;
199 case Type::DoubleTyID: OS << "double"; break;
200 case Type::X86_FP80TyID: OS << "x86_fp80"; break;
201 case Type::FP128TyID: OS << "fp128"; break;
202 case Type::PPC_FP128TyID: OS << "ppc_fp128"; break;
203 case Type::LabelTyID: OS << "label"; break;
Nick Lewyckyadbc2842009-05-30 05:06:04 +0000204 case Type::MetadataTyID: OS << "metadata"; break;
Dale Johannesenbaa5d042010-09-10 20:55:01 +0000205 case Type::X86_MMXTyID: OS << "x86_mmx"; break;
Chris Lattner68318b12009-02-28 21:18:43 +0000206 case Type::IntegerTyID:
Chris Lattner06a23212009-02-28 21:27:31 +0000207 OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000208 return;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000209
Chris Lattner07d88292009-02-28 20:35:42 +0000210 case Type::FunctionTyID: {
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000211 FunctionType *FTy = cast<FunctionType>(Ty);
212 print(FTy->getReturnType(), OS);
Chris Lattner06a23212009-02-28 21:27:31 +0000213 OS << " (";
Chris Lattner07d88292009-02-28 20:35:42 +0000214 for (FunctionType::param_iterator I = FTy->param_begin(),
215 E = FTy->param_end(); I != E; ++I) {
216 if (I != FTy->param_begin())
Chris Lattner06a23212009-02-28 21:27:31 +0000217 OS << ", ";
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000218 print(*I, OS);
Chris Lattner0f578952009-02-28 20:25:14 +0000219 }
Chris Lattner07d88292009-02-28 20:35:42 +0000220 if (FTy->isVarArg()) {
Chris Lattner06a23212009-02-28 21:27:31 +0000221 if (FTy->getNumParams()) OS << ", ";
222 OS << "...";
Chris Lattner0f578952009-02-28 20:25:14 +0000223 }
Chris Lattner06a23212009-02-28 21:27:31 +0000224 OS << ')';
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000225 return;
Chris Lattner07d88292009-02-28 20:35:42 +0000226 }
227 case Type::StructTyID: {
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000228 StructType *STy = cast<StructType>(Ty);
Andrew Trickec4b6e72011-09-30 19:48:58 +0000229
Chris Lattner01beceb2011-08-12 18:07:07 +0000230 if (STy->isLiteral())
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000231 return printStructBody(STy, OS);
232
233 if (!STy->getName().empty())
234 return PrintLLVMName(OS, STy->getName(), LocalPrefix);
Andrew Trickec4b6e72011-09-30 19:48:58 +0000235
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000236 DenseMap<StructType*, unsigned>::iterator I = NumberedTypes.find(STy);
237 if (I != NumberedTypes.end())
238 OS << '%' << I->second;
239 else // Not enumerated, print the hex address.
Benjamin Kramer4e8b4632011-11-02 17:24:36 +0000240 OS << "%\"type " << STy << '\"';
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000241 return;
Chris Lattner07d88292009-02-28 20:35:42 +0000242 }
243 case Type::PointerTyID: {
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000244 PointerType *PTy = cast<PointerType>(Ty);
245 print(PTy->getElementType(), OS);
Chris Lattner07d88292009-02-28 20:35:42 +0000246 if (unsigned AddressSpace = PTy->getAddressSpace())
Chris Lattner06a23212009-02-28 21:27:31 +0000247 OS << " addrspace(" << AddressSpace << ')';
248 OS << '*';
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000249 return;
Chris Lattner07d88292009-02-28 20:35:42 +0000250 }
251 case Type::ArrayTyID: {
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000252 ArrayType *ATy = cast<ArrayType>(Ty);
Chris Lattner06a23212009-02-28 21:27:31 +0000253 OS << '[' << ATy->getNumElements() << " x ";
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000254 print(ATy->getElementType(), OS);
Chris Lattner06a23212009-02-28 21:27:31 +0000255 OS << ']';
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000256 return;
Chris Lattner07d88292009-02-28 20:35:42 +0000257 }
258 case Type::VectorTyID: {
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000259 VectorType *PTy = cast<VectorType>(Ty);
Chris Lattner06a23212009-02-28 21:27:31 +0000260 OS << "<" << PTy->getNumElements() << " x ";
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000261 print(PTy->getElementType(), OS);
Chris Lattner06a23212009-02-28 21:27:31 +0000262 OS << '>';
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000263 return;
Chris Lattner07d88292009-02-28 20:35:42 +0000264 }
Chris Lattner07d88292009-02-28 20:35:42 +0000265 default:
Chris Lattner06a23212009-02-28 21:27:31 +0000266 OS << "<unrecognized-type>";
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000267 return;
Chris Lattner0f578952009-02-28 20:25:14 +0000268 }
Chris Lattner0f578952009-02-28 20:25:14 +0000269}
270
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000271void TypePrinting::printStructBody(StructType *STy, raw_ostream &OS) {
272 if (STy->isOpaque()) {
273 OS << "opaque";
274 return;
Chris Lattner0f578952009-02-28 20:25:14 +0000275 }
Andrew Trickec4b6e72011-09-30 19:48:58 +0000276
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000277 if (STy->isPacked())
278 OS << '<';
Andrew Trickec4b6e72011-09-30 19:48:58 +0000279
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000280 if (STy->getNumElements() == 0) {
281 OS << "{}";
282 } else {
283 StructType::element_iterator I = STy->element_begin();
284 OS << "{ ";
285 print(*I++, OS);
286 for (StructType::element_iterator E = STy->element_end(); I != E; ++I) {
287 OS << ", ";
288 print(*I, OS);
Chris Lattner3243ea12009-03-01 00:03:38 +0000289 }
Andrew Trickec4b6e72011-09-30 19:48:58 +0000290
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000291 OS << " }";
Chris Lattner92c5c122009-02-28 23:20:19 +0000292 }
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000293 if (STy->isPacked())
294 OS << '>';
Chris Lattner92c5c122009-02-28 23:20:19 +0000295}
296
Chris Lattner0f578952009-02-28 20:25:14 +0000297
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000298
Chris Lattner3eee99c2008-08-19 04:36:02 +0000299//===----------------------------------------------------------------------===//
300// SlotTracker Class: Enumerate slot numbers for unnamed values
301//===----------------------------------------------------------------------===//
302
Chris Lattner3ee58762008-08-19 04:28:07 +0000303namespace {
304
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000305/// This class provides computation of slot numbers for LLVM Assembly writing.
Chris Lattner393b7cd2008-08-17 04:17:45 +0000306///
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000307class SlotTracker {
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000308public:
Devang Patel983c6b12009-07-08 21:44:25 +0000309 /// ValueMap - A mapping of Values to slot numbers.
Chris Lattnera204d412008-08-17 17:25:25 +0000310 typedef DenseMap<const Value*, unsigned> ValueMap;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000311
312private:
Devang Patel983c6b12009-07-08 21:44:25 +0000313 /// TheModule - The module for which we are holding slot numbers.
Chris Lattner393b7cd2008-08-17 04:17:45 +0000314 const Module* TheModule;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000315
Devang Patel983c6b12009-07-08 21:44:25 +0000316 /// TheFunction - The function for which we are holding slot numbers.
Chris Lattner393b7cd2008-08-17 04:17:45 +0000317 const Function* TheFunction;
318 bool FunctionProcessed;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000319
Jay Foaddbb221d2011-07-11 07:28:49 +0000320 /// mMap - The slot map for the module level data.
Chris Lattner393b7cd2008-08-17 04:17:45 +0000321 ValueMap mMap;
322 unsigned mNext;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000323
Jay Foaddbb221d2011-07-11 07:28:49 +0000324 /// fMap - The slot map for the function level data.
Chris Lattner393b7cd2008-08-17 04:17:45 +0000325 ValueMap fMap;
326 unsigned fNext;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000327
Devang Patel983c6b12009-07-08 21:44:25 +0000328 /// mdnMap - Map for MDNodes.
Chris Lattnercf4a76e2009-12-31 02:20:11 +0000329 DenseMap<const MDNode*, unsigned> mdnMap;
Devang Patel983c6b12009-07-08 21:44:25 +0000330 unsigned mdnNext;
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000331public:
Chris Lattner393b7cd2008-08-17 04:17:45 +0000332 /// Construct from a module
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000333 explicit SlotTracker(const Module *M);
Chris Lattner393b7cd2008-08-17 04:17:45 +0000334 /// Construct from a function, starting out in incorp state.
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000335 explicit SlotTracker(const Function *F);
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000336
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000337 /// Return the slot number of the specified value in it's type
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000338 /// plane. If something is not in the SlotTracker, return -1.
Chris Lattner5e043322007-01-11 03:54:27 +0000339 int getLocalSlot(const Value *V);
340 int getGlobalSlot(const GlobalValue *V);
Devang Patel983c6b12009-07-08 21:44:25 +0000341 int getMetadataSlot(const MDNode *N);
Reid Spencer8beac692004-06-09 15:26:53 +0000342
Misha Brukmanb1c93172005-04-21 23:48:37 +0000343 /// If you'd like to deal with a function instead of just a module, use
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000344 /// this method to get its data into the SlotTracker.
Misha Brukmanb1c93172005-04-21 23:48:37 +0000345 void incorporateFunction(const Function *F) {
346 TheFunction = F;
Reid Spencerb0ac8c42004-08-16 07:46:33 +0000347 FunctionProcessed = false;
348 }
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000349
Misha Brukmanb1c93172005-04-21 23:48:37 +0000350 /// After calling incorporateFunction, use this method to remove the
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000351 /// most recently incorporated function from the SlotTracker. This
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000352 /// will reset the state of the machine back to just the module contents.
353 void purgeFunction();
354
Devang Patel983c6b12009-07-08 21:44:25 +0000355 /// MDNode map iterators.
Chris Lattnercf4a76e2009-12-31 02:20:11 +0000356 typedef DenseMap<const MDNode*, unsigned>::iterator mdn_iterator;
357 mdn_iterator mdn_begin() { return mdnMap.begin(); }
358 mdn_iterator mdn_end() { return mdnMap.end(); }
359 unsigned mdn_size() const { return mdnMap.size(); }
360 bool mdn_empty() const { return mdnMap.empty(); }
Devang Patel983c6b12009-07-08 21:44:25 +0000361
Reid Spencer56010e42004-05-26 21:56:09 +0000362 /// This function does the actual initialization.
363 inline void initialize();
364
Devang Patel983c6b12009-07-08 21:44:25 +0000365 // Implementation Details
366private:
Chris Lattnerea862a32007-01-09 07:55:49 +0000367 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
368 void CreateModuleSlot(const GlobalValue *V);
Devang Patel983c6b12009-07-08 21:44:25 +0000369
370 /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
371 void CreateMetadataSlot(const MDNode *N);
372
Chris Lattnerea862a32007-01-09 07:55:49 +0000373 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
374 void CreateFunctionSlot(const Value *V);
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000375
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000376 /// Add all of the module level global variables (and their initializers)
377 /// and function declarations, but not the contents of those functions.
378 void processModule();
379
Devang Patel983c6b12009-07-08 21:44:25 +0000380 /// Add all of the functions arguments, basic blocks, and instructions.
Reid Spencer56010e42004-05-26 21:56:09 +0000381 void processFunction();
382
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000383 SlotTracker(const SlotTracker &); // DO NOT IMPLEMENT
384 void operator=(const SlotTracker &); // DO NOT IMPLEMENT
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000385};
386
Chris Lattner3ee58762008-08-19 04:28:07 +0000387} // end anonymous namespace
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000388
Chris Lattner3eee99c2008-08-19 04:36:02 +0000389
390static SlotTracker *createSlotTracker(const Value *V) {
391 if (const Argument *FA = dyn_cast<Argument>(V))
392 return new SlotTracker(FA->getParent());
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000393
Chris Lattner3eee99c2008-08-19 04:36:02 +0000394 if (const Instruction *I = dyn_cast<Instruction>(V))
Andrew Trick2f0cbf62011-09-30 19:50:40 +0000395 if (I->getParent())
396 return new SlotTracker(I->getParent()->getParent());
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000397
Chris Lattner3eee99c2008-08-19 04:36:02 +0000398 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
399 return new SlotTracker(BB->getParent());
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000400
Chris Lattner3eee99c2008-08-19 04:36:02 +0000401 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
402 return new SlotTracker(GV->getParent());
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000403
Chris Lattner3eee99c2008-08-19 04:36:02 +0000404 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000405 return new SlotTracker(GA->getParent());
406
Chris Lattner3eee99c2008-08-19 04:36:02 +0000407 if (const Function *Func = dyn_cast<Function>(V))
408 return new SlotTracker(Func);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000409
Dan Gohmana2489d12010-07-20 23:55:01 +0000410 if (const MDNode *MD = dyn_cast<MDNode>(V)) {
411 if (!MD->isFunctionLocal())
412 return new SlotTracker(MD->getFunction());
413
Dale Johannesen7b1a7ed2010-01-13 00:00:24 +0000414 return new SlotTracker((Function *)0);
Dan Gohmana2489d12010-07-20 23:55:01 +0000415 }
Dale Johannesen7b1a7ed2010-01-13 00:00:24 +0000416
Chris Lattner3eee99c2008-08-19 04:36:02 +0000417 return 0;
418}
419
420#if 0
David Greenec7f9b122010-01-05 01:29:26 +0000421#define ST_DEBUG(X) dbgs() << X
Chris Lattner3eee99c2008-08-19 04:36:02 +0000422#else
Chris Lattner604e3512008-08-19 04:47:09 +0000423#define ST_DEBUG(X)
Chris Lattner3eee99c2008-08-19 04:36:02 +0000424#endif
425
426// Module level constructor. Causes the contents of the Module (sans functions)
427// to be added to the slot table.
428SlotTracker::SlotTracker(const Module *M)
Andrew Trickec4b6e72011-09-30 19:48:58 +0000429 : TheModule(M), TheFunction(0), FunctionProcessed(false),
Chris Lattnerbe2de792009-12-31 01:36:50 +0000430 mNext(0), fNext(0), mdnNext(0) {
Chris Lattner3eee99c2008-08-19 04:36:02 +0000431}
432
433// Function level constructor. Causes the contents of the Module and the one
434// function provided to be added to the slot table.
435SlotTracker::SlotTracker(const Function *F)
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000436 : TheModule(F ? F->getParent() : 0), TheFunction(F), FunctionProcessed(false),
Chris Lattnerbddea6a2009-12-31 02:13:35 +0000437 mNext(0), fNext(0), mdnNext(0) {
Chris Lattner3eee99c2008-08-19 04:36:02 +0000438}
439
440inline void SlotTracker::initialize() {
441 if (TheModule) {
442 processModule();
443 TheModule = 0; ///< Prevent re-processing next time we're called.
444 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000445
Chris Lattner3eee99c2008-08-19 04:36:02 +0000446 if (TheFunction && !FunctionProcessed)
447 processFunction();
448}
449
450// Iterate through all the global variables, functions, and global
451// variable initializers and create slots for them.
452void SlotTracker::processModule() {
Chris Lattner604e3512008-08-19 04:47:09 +0000453 ST_DEBUG("begin processModule!\n");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000454
Chris Lattner3eee99c2008-08-19 04:36:02 +0000455 // Add all of the unnamed global variables to the value table.
456 for (Module::const_global_iterator I = TheModule->global_begin(),
Devang Patel983c6b12009-07-08 21:44:25 +0000457 E = TheModule->global_end(); I != E; ++I) {
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000458 if (!I->hasName())
Chris Lattner3eee99c2008-08-19 04:36:02 +0000459 CreateModuleSlot(I);
Devang Patel983c6b12009-07-08 21:44:25 +0000460 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000461
Devang Patel23e68302009-07-29 22:04:47 +0000462 // Add metadata used by named metadata.
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000463 for (Module::const_named_metadata_iterator
Devang Patel23e68302009-07-29 22:04:47 +0000464 I = TheModule->named_metadata_begin(),
465 E = TheModule->named_metadata_end(); I != E; ++I) {
466 const NamedMDNode *NMD = I;
Dan Gohman093cb792010-07-21 18:54:18 +0000467 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
468 CreateMetadataSlot(NMD->getOperand(i));
Devang Patel23e68302009-07-29 22:04:47 +0000469 }
470
Chris Lattner3eee99c2008-08-19 04:36:02 +0000471 // Add all the unnamed functions to the table.
472 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
473 I != E; ++I)
474 if (!I->hasName())
475 CreateModuleSlot(I);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000476
Chris Lattner604e3512008-08-19 04:47:09 +0000477 ST_DEBUG("end processModule!\n");
Chris Lattner3eee99c2008-08-19 04:36:02 +0000478}
479
Chris Lattner3eee99c2008-08-19 04:36:02 +0000480// Process the arguments, basic blocks, and instructions of a function.
481void SlotTracker::processFunction() {
Chris Lattner604e3512008-08-19 04:47:09 +0000482 ST_DEBUG("begin processFunction!\n");
Chris Lattner3eee99c2008-08-19 04:36:02 +0000483 fNext = 0;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000484
Chris Lattner3eee99c2008-08-19 04:36:02 +0000485 // Add all the function arguments with no names.
486 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
487 AE = TheFunction->arg_end(); AI != AE; ++AI)
488 if (!AI->hasName())
489 CreateFunctionSlot(AI);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000490
Chris Lattner604e3512008-08-19 04:47:09 +0000491 ST_DEBUG("Inserting Instructions:\n");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000492
Chris Lattnerbddea6a2009-12-31 02:13:35 +0000493 SmallVector<std::pair<unsigned, MDNode*>, 4> MDForInst;
Devang Pateldec23fd2009-09-16 20:21:17 +0000494
Chris Lattner3eee99c2008-08-19 04:36:02 +0000495 // Add all of the basic blocks and instructions with no names.
496 for (Function::const_iterator BB = TheFunction->begin(),
497 E = TheFunction->end(); BB != E; ++BB) {
498 if (!BB->hasName())
499 CreateFunctionSlot(BB);
Andrew Trickec4b6e72011-09-30 19:48:58 +0000500
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000501 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E;
Devang Patel983c6b12009-07-08 21:44:25 +0000502 ++I) {
Chris Lattner2f2aa2b2009-12-28 23:41:32 +0000503 if (!I->getType()->isVoidTy() && !I->hasName())
Chris Lattner3eee99c2008-08-19 04:36:02 +0000504 CreateFunctionSlot(I);
Andrew Trickec4b6e72011-09-30 19:48:58 +0000505
Chris Lattner58aff8f2010-05-10 20:53:17 +0000506 // Intrinsics can directly use metadata. We allow direct calls to any
507 // llvm.foo function here, because the target may not be linked into the
508 // optimizer.
509 if (const CallInst *CI = dyn_cast<CallInst>(I)) {
510 if (Function *F = CI->getCalledFunction())
511 if (F->getName().startswith("llvm."))
512 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
513 if (MDNode *N = dyn_cast_or_null<MDNode>(I->getOperand(i)))
514 CreateMetadataSlot(N);
515 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000516
Devang Pateldec23fd2009-09-16 20:21:17 +0000517 // Process metadata attached with this instruction.
Chris Lattner2f2aa2b2009-12-28 23:41:32 +0000518 I->getAllMetadata(MDForInst);
519 for (unsigned i = 0, e = MDForInst.size(); i != e; ++i)
520 CreateMetadataSlot(MDForInst[i].second);
Chris Lattnerbddea6a2009-12-31 02:13:35 +0000521 MDForInst.clear();
Devang Patel983c6b12009-07-08 21:44:25 +0000522 }
Chris Lattner3eee99c2008-08-19 04:36:02 +0000523 }
Devang Pateldec23fd2009-09-16 20:21:17 +0000524
Chris Lattner3eee99c2008-08-19 04:36:02 +0000525 FunctionProcessed = true;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000526
Chris Lattner604e3512008-08-19 04:47:09 +0000527 ST_DEBUG("end processFunction!\n");
Chris Lattner3eee99c2008-08-19 04:36:02 +0000528}
529
530/// Clean up after incorporating a function. This is the only way to get out of
531/// the function incorporation state that affects get*Slot/Create*Slot. Function
532/// incorporation state is indicated by TheFunction != 0.
533void SlotTracker::purgeFunction() {
Chris Lattner604e3512008-08-19 04:47:09 +0000534 ST_DEBUG("begin purgeFunction!\n");
Chris Lattner3eee99c2008-08-19 04:36:02 +0000535 fMap.clear(); // Simply discard the function level map
536 TheFunction = 0;
537 FunctionProcessed = false;
Chris Lattner604e3512008-08-19 04:47:09 +0000538 ST_DEBUG("end purgeFunction!\n");
Chris Lattner3eee99c2008-08-19 04:36:02 +0000539}
540
541/// getGlobalSlot - Get the slot number of a global value.
542int SlotTracker::getGlobalSlot(const GlobalValue *V) {
543 // Check for uninitialized state and do lazy initialization.
544 initialize();
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000545
Jay Foaddbb221d2011-07-11 07:28:49 +0000546 // Find the value in the module map
Chris Lattner3eee99c2008-08-19 04:36:02 +0000547 ValueMap::iterator MI = mMap.find(V);
Dan Gohman1dd27572008-10-01 19:58:59 +0000548 return MI == mMap.end() ? -1 : (int)MI->second;
Chris Lattner3eee99c2008-08-19 04:36:02 +0000549}
550
Chris Lattnercf4a76e2009-12-31 02:20:11 +0000551/// getMetadataSlot - Get the slot number of a MDNode.
Devang Patel983c6b12009-07-08 21:44:25 +0000552int SlotTracker::getMetadataSlot(const MDNode *N) {
553 // Check for uninitialized state and do lazy initialization.
554 initialize();
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000555
Jay Foaddbb221d2011-07-11 07:28:49 +0000556 // Find the MDNode in the module map
Chris Lattnercf4a76e2009-12-31 02:20:11 +0000557 mdn_iterator MI = mdnMap.find(N);
Devang Patel983c6b12009-07-08 21:44:25 +0000558 return MI == mdnMap.end() ? -1 : (int)MI->second;
559}
560
Chris Lattner3eee99c2008-08-19 04:36:02 +0000561
562/// getLocalSlot - Get the slot number for a value that is local to a function.
563int SlotTracker::getLocalSlot(const Value *V) {
564 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000565
Chris Lattner3eee99c2008-08-19 04:36:02 +0000566 // Check for uninitialized state and do lazy initialization.
567 initialize();
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000568
Chris Lattner3eee99c2008-08-19 04:36:02 +0000569 ValueMap::iterator FI = fMap.find(V);
Dan Gohman1dd27572008-10-01 19:58:59 +0000570 return FI == fMap.end() ? -1 : (int)FI->second;
Chris Lattner3eee99c2008-08-19 04:36:02 +0000571}
572
573
574/// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
575void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
576 assert(V && "Can't insert a null Value into SlotTracker!");
Chris Lattner031560c2009-12-29 07:25:48 +0000577 assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
Chris Lattner3eee99c2008-08-19 04:36:02 +0000578 assert(!V->hasName() && "Doesn't need a slot!");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000579
Chris Lattner3eee99c2008-08-19 04:36:02 +0000580 unsigned DestSlot = mNext++;
581 mMap[V] = DestSlot;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000582
Chris Lattner604e3512008-08-19 04:47:09 +0000583 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
Chris Lattner3eee99c2008-08-19 04:36:02 +0000584 DestSlot << " [");
585 // G = Global, F = Function, A = Alias, o = other
Chris Lattner604e3512008-08-19 04:47:09 +0000586 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
Chris Lattner3eee99c2008-08-19 04:36:02 +0000587 (isa<Function>(V) ? 'F' :
588 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
589}
590
Chris Lattner3eee99c2008-08-19 04:36:02 +0000591/// CreateSlot - Create a new slot for the specified value if it has no name.
592void SlotTracker::CreateFunctionSlot(const Value *V) {
Chris Lattner031560c2009-12-29 07:25:48 +0000593 assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000594
Chris Lattner3eee99c2008-08-19 04:36:02 +0000595 unsigned DestSlot = fNext++;
596 fMap[V] = DestSlot;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000597
Chris Lattner3eee99c2008-08-19 04:36:02 +0000598 // G = Global, F = Function, o = other
Chris Lattner604e3512008-08-19 04:47:09 +0000599 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
Chris Lattner3eee99c2008-08-19 04:36:02 +0000600 DestSlot << " [o]\n");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000601}
Chris Lattner3eee99c2008-08-19 04:36:02 +0000602
Devang Patel983c6b12009-07-08 21:44:25 +0000603/// CreateModuleSlot - Insert the specified MDNode* into the slot table.
604void SlotTracker::CreateMetadataSlot(const MDNode *N) {
605 assert(N && "Can't insert a null Value into SlotTracker!");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000606
Chris Lattner0d50bdd2009-12-31 02:27:30 +0000607 // Don't insert if N is a function-local metadata, these are always printed
608 // inline.
Dan Gohmana2489d12010-07-20 23:55:01 +0000609 if (!N->isFunctionLocal()) {
610 mdn_iterator I = mdnMap.find(N);
611 if (I != mdnMap.end())
612 return;
Victor Hernandez4d633542009-12-04 20:07:10 +0000613
Dan Gohmana2489d12010-07-20 23:55:01 +0000614 unsigned DestSlot = mdnNext++;
615 mdnMap[N] = DestSlot;
616 }
Devang Patel983c6b12009-07-08 21:44:25 +0000617
Chris Lattner0d50bdd2009-12-31 02:27:30 +0000618 // Recursively add any MDNodes referenced by operands.
619 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i)
620 if (const MDNode *Op = dyn_cast_or_null<MDNode>(N->getOperand(i)))
621 CreateMetadataSlot(Op);
Devang Patel983c6b12009-07-08 21:44:25 +0000622}
Chris Lattner3eee99c2008-08-19 04:36:02 +0000623
624//===----------------------------------------------------------------------===//
625// AsmWriter Implementation
626//===----------------------------------------------------------------------===//
Chris Lattner7f8845a2002-07-23 18:07:49 +0000627
Dan Gohman12dad632009-08-12 20:56:03 +0000628static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
Dan Gohman8061d9e2009-08-13 15:27:57 +0000629 TypePrinting *TypePrinter,
Dan Gohmana2489d12010-07-20 23:55:01 +0000630 SlotTracker *Machine,
631 const Module *Context);
Reid Spencer58d30f22004-07-04 11:50:43 +0000632
Chris Lattner033935d2008-08-17 04:40:13 +0000633
Chris Lattnerb86620e2001-10-29 16:37:48 +0000634
Chris Lattnerfc9f1c92006-12-06 06:40:49 +0000635static const char *getPredicateText(unsigned predicate) {
Reid Spencer812a1be2006-12-04 05:19:18 +0000636 const char * pred = "unknown";
637 switch (predicate) {
Chris Lattnerbddea6a2009-12-31 02:13:35 +0000638 case FCmpInst::FCMP_FALSE: pred = "false"; break;
639 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
640 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
641 case FCmpInst::FCMP_OGE: pred = "oge"; break;
642 case FCmpInst::FCMP_OLT: pred = "olt"; break;
643 case FCmpInst::FCMP_OLE: pred = "ole"; break;
644 case FCmpInst::FCMP_ONE: pred = "one"; break;
645 case FCmpInst::FCMP_ORD: pred = "ord"; break;
646 case FCmpInst::FCMP_UNO: pred = "uno"; break;
647 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
648 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
649 case FCmpInst::FCMP_UGE: pred = "uge"; break;
650 case FCmpInst::FCMP_ULT: pred = "ult"; break;
651 case FCmpInst::FCMP_ULE: pred = "ule"; break;
652 case FCmpInst::FCMP_UNE: pred = "une"; break;
653 case FCmpInst::FCMP_TRUE: pred = "true"; break;
654 case ICmpInst::ICMP_EQ: pred = "eq"; break;
655 case ICmpInst::ICMP_NE: pred = "ne"; break;
656 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
657 case ICmpInst::ICMP_SGE: pred = "sge"; break;
658 case ICmpInst::ICMP_SLT: pred = "slt"; break;
659 case ICmpInst::ICMP_SLE: pred = "sle"; break;
660 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
661 case ICmpInst::ICMP_UGE: pred = "uge"; break;
662 case ICmpInst::ICMP_ULT: pred = "ult"; break;
663 case ICmpInst::ICMP_ULE: pred = "ule"; break;
Reid Spencer812a1be2006-12-04 05:19:18 +0000664 }
665 return pred;
666}
667
Eli Friedmanc9a551e2011-07-28 21:48:00 +0000668static void writeAtomicRMWOperation(raw_ostream &Out,
669 AtomicRMWInst::BinOp Op) {
670 switch (Op) {
671 default: Out << " <unknown operation " << Op << ">"; break;
672 case AtomicRMWInst::Xchg: Out << " xchg"; break;
673 case AtomicRMWInst::Add: Out << " add"; break;
674 case AtomicRMWInst::Sub: Out << " sub"; break;
675 case AtomicRMWInst::And: Out << " and"; break;
676 case AtomicRMWInst::Nand: Out << " nand"; break;
677 case AtomicRMWInst::Or: Out << " or"; break;
678 case AtomicRMWInst::Xor: Out << " xor"; break;
679 case AtomicRMWInst::Max: Out << " max"; break;
680 case AtomicRMWInst::Min: Out << " min"; break;
681 case AtomicRMWInst::UMax: Out << " umax"; break;
682 case AtomicRMWInst::UMin: Out << " umin"; break;
683 }
684}
Devang Patel983c6b12009-07-08 21:44:25 +0000685
Dan Gohman12dad632009-08-12 20:56:03 +0000686static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
Dan Gohman0ebd6962009-07-20 21:19:07 +0000687 if (const OverflowingBinaryOperator *OBO =
688 dyn_cast<OverflowingBinaryOperator>(U)) {
Dan Gohman16f54152009-08-20 17:11:38 +0000689 if (OBO->hasNoUnsignedWrap())
Dan Gohman9c7f8082009-07-27 16:11:46 +0000690 Out << " nuw";
Dan Gohman16f54152009-08-20 17:11:38 +0000691 if (OBO->hasNoSignedWrap())
Dan Gohman9c7f8082009-07-27 16:11:46 +0000692 Out << " nsw";
Chris Lattner35315d02011-02-06 21:44:57 +0000693 } else if (const PossiblyExactOperator *Div =
694 dyn_cast<PossiblyExactOperator>(U)) {
Dan Gohman0ebd6962009-07-20 21:19:07 +0000695 if (Div->isExact())
Dan Gohman9c7f8082009-07-27 16:11:46 +0000696 Out << " exact";
Dan Gohman1639c392009-07-27 21:53:46 +0000697 } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
698 if (GEP->isInBounds())
699 Out << " inbounds";
Dan Gohman0ebd6962009-07-20 21:19:07 +0000700 }
701}
702
Dan Gohmanefb8dbb2010-07-14 20:57:55 +0000703static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
704 TypePrinting &TypePrinter,
Dan Gohmana2489d12010-07-20 23:55:01 +0000705 SlotTracker *Machine,
706 const Module *Context) {
Zhou Sheng75b871f2007-01-11 12:24:14 +0000707 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
Duncan Sands9dff9be2010-02-15 16:12:20 +0000708 if (CI->getType()->isIntegerTy(1)) {
Reid Spencercddc9df2007-01-12 04:24:46 +0000709 Out << (CI->getZExtValue() ? "true" : "false");
Chris Lattner17f71652008-08-17 07:19:36 +0000710 return;
711 }
712 Out << CI->getValue();
713 return;
714 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000715
Chris Lattner17f71652008-08-17 07:19:36 +0000716 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
Tobias Grosser6b31d172012-05-24 15:59:06 +0000717 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle ||
Dan Gohman518cda42011-12-17 00:04:22 +0000718 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble) {
Dale Johannesen028084e2007-09-12 03:30:33 +0000719 // We would like to output the FP constant value in exponential notation,
720 // but we cannot do this if doing so will lose precision. Check here to
721 // make sure that we only output it in exponential format if we can parse
722 // the value back and get the same value.
723 //
Dale Johannesen1f864982009-01-21 20:32:55 +0000724 bool ignored;
Dan Gohman518cda42011-12-17 00:04:22 +0000725 bool isHalf = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEhalf;
Dale Johannesen028084e2007-09-12 03:30:33 +0000726 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
NAKAMURA Takumi35d19c02012-02-16 08:12:24 +0000727 bool isInf = CFP->getValueAPF().isInfinity();
728 bool isNaN = CFP->getValueAPF().isNaN();
729 if (!isHalf && !isInf && !isNaN) {
Dan Gohman518cda42011-12-17 00:04:22 +0000730 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
731 CFP->getValueAPF().convertToFloat();
732 SmallString<128> StrVal;
733 raw_svector_ostream(StrVal) << Val;
Chris Lattner1e194682002-04-18 18:53:13 +0000734
Dan Gohman518cda42011-12-17 00:04:22 +0000735 // Check to make sure that the stringized number is not some string like
736 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
737 // that the string matches the "[-+]?[0-9]" regex.
738 //
739 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
740 ((StrVal[0] == '-' || StrVal[0] == '+') &&
741 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
742 // Reparse stringized version!
NAKAMURA Takumiaec41232012-02-16 04:19:15 +0000743 if (APFloat(APFloat::IEEEdouble, StrVal).convertToDouble() == Val) {
Dan Gohman518cda42011-12-17 00:04:22 +0000744 Out << StrVal.str();
745 return;
746 }
Dale Johannesen028084e2007-09-12 03:30:33 +0000747 }
Chris Lattner1e194682002-04-18 18:53:13 +0000748 }
Dale Johannesen028084e2007-09-12 03:30:33 +0000749 // Otherwise we could not reparse it to exactly the same value, so we must
Dale Johannesen1f864982009-01-21 20:32:55 +0000750 // output the string in hexadecimal format! Note that loading and storing
751 // floating point types changes the bits of NaNs on some hosts, notably
752 // x86, so we must not use these types.
Dale Johannesen028084e2007-09-12 03:30:33 +0000753 assert(sizeof(double) == sizeof(uint64_t) &&
754 "assuming that double is 64 bits!");
Chris Lattner5505eed2008-11-10 04:30:26 +0000755 char Buffer[40];
Dale Johannesen1f864982009-01-21 20:32:55 +0000756 APFloat apf = CFP->getValueAPF();
Dan Gohman518cda42011-12-17 00:04:22 +0000757 // Halves and floats are represented in ASCII IR as double, convert.
Dale Johannesen1f864982009-01-21 20:32:55 +0000758 if (!isDouble)
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000759 apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
Dale Johannesen1f864982009-01-21 20:32:55 +0000760 &ignored);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000761 Out << "0x" <<
762 utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
Dale Johannesen1f864982009-01-21 20:32:55 +0000763 Buffer+40);
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000764 return;
765 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000766
Tobias Grosser6b31d172012-05-24 15:59:06 +0000767 // Either half, or some form of long double.
768 // These appear as a magic letter identifying the type, then a
769 // fixed number of hex digits.
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000770 Out << "0x";
Tobias Grosser6b31d172012-05-24 15:59:06 +0000771 // Bit position, in the current word, of the next nibble to print.
772 int shiftcount;
773
Dale Johannesen93eefa02009-03-23 21:16:53 +0000774 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000775 Out << 'K';
Dale Johannesen93eefa02009-03-23 21:16:53 +0000776 // api needed to prevent premature destruction
777 APInt api = CFP->getValueAPF().bitcastToAPInt();
778 const uint64_t* p = api.getRawData();
779 uint64_t word = p[1];
Tobias Grosser6b31d172012-05-24 15:59:06 +0000780 shiftcount = 12;
Dale Johannesen93eefa02009-03-23 21:16:53 +0000781 int width = api.getBitWidth();
782 for (int j=0; j<width; j+=4, shiftcount-=4) {
783 unsigned int nibble = (word>>shiftcount) & 15;
784 if (nibble < 10)
785 Out << (unsigned char)(nibble + '0');
786 else
787 Out << (unsigned char)(nibble - 10 + 'A');
788 if (shiftcount == 0 && j+4 < width) {
789 word = *p;
790 shiftcount = 64;
791 if (width-j-4 < 64)
792 shiftcount = width-j-4;
793 }
794 }
795 return;
Tobias Grosser6b31d172012-05-24 15:59:06 +0000796 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad) {
797 shiftcount = 60;
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000798 Out << 'L';
Tobias Grosser6b31d172012-05-24 15:59:06 +0000799 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble) {
800 shiftcount = 60;
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000801 Out << 'M';
Tobias Grosser6b31d172012-05-24 15:59:06 +0000802 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEhalf) {
803 shiftcount = 12;
804 Out << 'H';
805 } else
Torok Edwinfbcc6632009-07-14 16:55:14 +0000806 llvm_unreachable("Unsupported floating point type");
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000807 // api needed to prevent premature destruction
Dale Johannesen54306fe2008-10-09 18:53:47 +0000808 APInt api = CFP->getValueAPF().bitcastToAPInt();
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000809 const uint64_t* p = api.getRawData();
810 uint64_t word = *p;
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000811 int width = api.getBitWidth();
812 for (int j=0; j<width; j+=4, shiftcount-=4) {
813 unsigned int nibble = (word>>shiftcount) & 15;
814 if (nibble < 10)
815 Out << (unsigned char)(nibble + '0');
Dale Johannesen028084e2007-09-12 03:30:33 +0000816 else
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000817 Out << (unsigned char)(nibble - 10 + 'A');
818 if (shiftcount == 0 && j+4 < width) {
819 word = *(++p);
820 shiftcount = 64;
821 if (width-j-4 < 64)
822 shiftcount = width-j-4;
Dale Johannesen028084e2007-09-12 03:30:33 +0000823 }
824 }
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000825 return;
826 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000827
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000828 if (isa<ConstantAggregateZero>(CV)) {
Chris Lattner76b2ff42004-02-15 05:55:15 +0000829 Out << "zeroinitializer";
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000830 return;
831 }
Andrew Trickec4b6e72011-09-30 19:48:58 +0000832
Chris Lattner214cc702009-10-28 03:38:12 +0000833 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
834 Out << "blockaddress(";
Dan Gohmana2489d12010-07-20 23:55:01 +0000835 WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine,
836 Context);
Chris Lattner214cc702009-10-28 03:38:12 +0000837 Out << ", ";
Dan Gohmana2489d12010-07-20 23:55:01 +0000838 WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine,
839 Context);
Chris Lattner214cc702009-10-28 03:38:12 +0000840 Out << ")";
841 return;
842 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000843
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000844 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
Chris Lattnerb1ed91f2011-07-09 17:41:24 +0000845 Type *ETy = CA->getType()->getElementType();
Chris Lattnercf9e8f62012-02-05 02:29:43 +0000846 Out << '[';
847 TypePrinter.print(ETy, Out);
848 Out << ' ';
849 WriteAsOperandInternal(Out, CA->getOperand(0),
850 &TypePrinter, Machine,
851 Context);
852 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
853 Out << ", ";
Chris Lattner9c181f62012-01-31 03:15:40 +0000854 TypePrinter.print(ETy, Out);
855 Out << ' ';
Chris Lattnercf9e8f62012-02-05 02:29:43 +0000856 WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine,
Chris Lattner9c181f62012-01-31 03:15:40 +0000857 Context);
Chris Lattnerd84bb632002-04-16 21:36:08 +0000858 }
Chris Lattnercf9e8f62012-02-05 02:29:43 +0000859 Out << ']';
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000860 return;
861 }
Chris Lattnerfa775002012-01-26 02:32:04 +0000862
863 if (const ConstantDataArray *CA = dyn_cast<ConstantDataArray>(CV)) {
864 // As a special case, print the array as a string if it is an array of
865 // i8 with ConstantInt values.
866 if (CA->isString()) {
867 Out << "c\"";
868 PrintEscapedString(CA->getAsString(), Out);
869 Out << '"';
870 return;
871 }
872
873 Type *ETy = CA->getType()->getElementType();
874 Out << '[';
Chris Lattner9c181f62012-01-31 03:15:40 +0000875 TypePrinter.print(ETy, Out);
876 Out << ' ';
877 WriteAsOperandInternal(Out, CA->getElementAsConstant(0),
878 &TypePrinter, Machine,
879 Context);
880 for (unsigned i = 1, e = CA->getNumElements(); i != e; ++i) {
881 Out << ", ";
Chris Lattnerfa775002012-01-26 02:32:04 +0000882 TypePrinter.print(ETy, Out);
883 Out << ' ';
Chris Lattner9c181f62012-01-31 03:15:40 +0000884 WriteAsOperandInternal(Out, CA->getElementAsConstant(i), &TypePrinter,
885 Machine, Context);
Chris Lattnerfa775002012-01-26 02:32:04 +0000886 }
Chris Lattner9c181f62012-01-31 03:15:40 +0000887 Out << ']';
Chris Lattnerfa775002012-01-26 02:32:04 +0000888 return;
889 }
890
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000891
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000892 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
Andrew Lenharth0d124b82007-01-08 18:21:30 +0000893 if (CS->getType()->isPacked())
894 Out << '<';
Misha Brukman21bbdb92004-06-04 21:11:51 +0000895 Out << '{';
Jim Laskey3bb78742006-02-25 12:27:03 +0000896 unsigned N = CS->getNumOperands();
897 if (N) {
Chris Lattner604e3512008-08-19 04:47:09 +0000898 Out << ' ';
Chris Lattnere101c442009-02-28 21:26:53 +0000899 TypePrinter.print(CS->getOperand(0)->getType(), Out);
Dan Gohman81313fd2008-09-14 17:21:12 +0000900 Out << ' ';
Chris Lattnerd84bb632002-04-16 21:36:08 +0000901
Dan Gohmana2489d12010-07-20 23:55:01 +0000902 WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine,
903 Context);
Chris Lattnerd84bb632002-04-16 21:36:08 +0000904
Jim Laskey3bb78742006-02-25 12:27:03 +0000905 for (unsigned i = 1; i < N; i++) {
Chris Lattnerd84bb632002-04-16 21:36:08 +0000906 Out << ", ";
Chris Lattnere101c442009-02-28 21:26:53 +0000907 TypePrinter.print(CS->getOperand(i)->getType(), Out);
Dan Gohman81313fd2008-09-14 17:21:12 +0000908 Out << ' ';
Chris Lattnerd84bb632002-04-16 21:36:08 +0000909
Dan Gohmana2489d12010-07-20 23:55:01 +0000910 WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine,
911 Context);
Chris Lattnerd84bb632002-04-16 21:36:08 +0000912 }
Dan Gohman81313fd2008-09-14 17:21:12 +0000913 Out << ' ';
Chris Lattnerd84bb632002-04-16 21:36:08 +0000914 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000915
Dan Gohman81313fd2008-09-14 17:21:12 +0000916 Out << '}';
Andrew Lenharth0d124b82007-01-08 18:21:30 +0000917 if (CS->getType()->isPacked())
918 Out << '>';
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000919 return;
920 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000921
Chris Lattnerfa775002012-01-26 02:32:04 +0000922 if (isa<ConstantVector>(CV) || isa<ConstantDataVector>(CV)) {
923 Type *ETy = CV->getType()->getVectorElementType();
Dan Gohman1262a252009-02-11 00:25:25 +0000924 Out << '<';
Chris Lattnere101c442009-02-28 21:26:53 +0000925 TypePrinter.print(ETy, Out);
Dan Gohman81313fd2008-09-14 17:21:12 +0000926 Out << ' ';
Chris Lattnerfa775002012-01-26 02:32:04 +0000927 WriteAsOperandInternal(Out, CV->getAggregateElement(0U), &TypePrinter,
928 Machine, Context);
929 for (unsigned i = 1, e = CV->getType()->getVectorNumElements(); i != e;++i){
Chris Lattner585297e82008-08-19 05:26:17 +0000930 Out << ", ";
Chris Lattnere101c442009-02-28 21:26:53 +0000931 TypePrinter.print(ETy, Out);
Dan Gohman81313fd2008-09-14 17:21:12 +0000932 Out << ' ';
Chris Lattnerfa775002012-01-26 02:32:04 +0000933 WriteAsOperandInternal(Out, CV->getAggregateElement(i), &TypePrinter,
934 Machine, Context);
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000935 }
Dan Gohman1262a252009-02-11 00:25:25 +0000936 Out << '>';
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000937 return;
938 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000939
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000940 if (isa<ConstantPointerNull>(CV)) {
Chris Lattnerd84bb632002-04-16 21:36:08 +0000941 Out << "null";
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000942 return;
943 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000944
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000945 if (isa<UndefValue>(CV)) {
Chris Lattner5e0b9f22004-10-16 18:08:06 +0000946 Out << "undef";
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000947 return;
948 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000949
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000950 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
Reid Spencer812a1be2006-12-04 05:19:18 +0000951 Out << CE->getOpcodeName();
Dan Gohman9c7f8082009-07-27 16:11:46 +0000952 WriteOptimizationInfo(Out, CE);
Reid Spencer812a1be2006-12-04 05:19:18 +0000953 if (CE->isCompare())
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000954 Out << ' ' << getPredicateText(CE->getPredicate());
Reid Spencer812a1be2006-12-04 05:19:18 +0000955 Out << " (";
Misha Brukmanb1c93172005-04-21 23:48:37 +0000956
Vikram S. Adveb952b542002-07-14 23:14:45 +0000957 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
Chris Lattnere101c442009-02-28 21:26:53 +0000958 TypePrinter.print((*OI)->getType(), Out);
Dan Gohman81313fd2008-09-14 17:21:12 +0000959 Out << ' ';
Dan Gohmana2489d12010-07-20 23:55:01 +0000960 WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine, Context);
Vikram S. Adveb952b542002-07-14 23:14:45 +0000961 if (OI+1 != CE->op_end())
Chris Lattner3cd8c562002-07-30 18:54:25 +0000962 Out << ", ";
Vikram S. Adveb952b542002-07-14 23:14:45 +0000963 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000964
Dan Gohmana76f0f72008-05-31 19:12:39 +0000965 if (CE->hasIndices()) {
Jay Foad0091fe82011-04-13 15:22:40 +0000966 ArrayRef<unsigned> Indices = CE->getIndices();
Dan Gohmana76f0f72008-05-31 19:12:39 +0000967 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
968 Out << ", " << Indices[i];
969 }
970
Reid Spencer6c38f0b2006-11-27 01:05:10 +0000971 if (CE->isCast()) {
Chris Lattner83b396b2002-08-15 19:37:43 +0000972 Out << " to ";
Chris Lattnere101c442009-02-28 21:26:53 +0000973 TypePrinter.print(CE->getType(), Out);
Chris Lattner83b396b2002-08-15 19:37:43 +0000974 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +0000975
Misha Brukman21bbdb92004-06-04 21:11:51 +0000976 Out << ')';
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000977 return;
Chris Lattnerd84bb632002-04-16 21:36:08 +0000978 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000979
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000980 Out << "<placeholder or erroneous Constant>";
Chris Lattnerd84bb632002-04-16 21:36:08 +0000981}
982
Chris Lattnercdec5812009-12-31 02:31:59 +0000983static void WriteMDNodeBodyInternal(raw_ostream &Out, const MDNode *Node,
984 TypePrinting *TypePrinter,
Dan Gohmana2489d12010-07-20 23:55:01 +0000985 SlotTracker *Machine,
986 const Module *Context) {
Chris Lattnercdec5812009-12-31 02:31:59 +0000987 Out << "!{";
988 for (unsigned mi = 0, me = Node->getNumOperands(); mi != me; ++mi) {
989 const Value *V = Node->getOperand(mi);
990 if (V == 0)
991 Out << "null";
992 else {
993 TypePrinter->print(V->getType(), Out);
994 Out << ' ';
Andrew Trickec4b6e72011-09-30 19:48:58 +0000995 WriteAsOperandInternal(Out, Node->getOperand(mi),
Dan Gohmana2489d12010-07-20 23:55:01 +0000996 TypePrinter, Machine, Context);
Chris Lattnercdec5812009-12-31 02:31:59 +0000997 }
998 if (mi + 1 != me)
999 Out << ", ";
1000 }
Andrew Trickec4b6e72011-09-30 19:48:58 +00001001
Chris Lattnercdec5812009-12-31 02:31:59 +00001002 Out << "}";
1003}
1004
Chris Lattnerd84bb632002-04-16 21:36:08 +00001005
Misha Brukmanc566ca362004-03-02 00:22:19 +00001006/// WriteAsOperand - Write the name of the specified value out to the specified
1007/// ostream. This can be useful when you just want to print int %reg126, not
1008/// the whole instruction that generated it.
1009///
Dan Gohman12dad632009-08-12 20:56:03 +00001010static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
Dan Gohman8061d9e2009-08-13 15:27:57 +00001011 TypePrinting *TypePrinter,
Dan Gohmana2489d12010-07-20 23:55:01 +00001012 SlotTracker *Machine,
1013 const Module *Context) {
Chris Lattner033935d2008-08-17 04:40:13 +00001014 if (V->hasName()) {
1015 PrintLLVMName(Out, V);
1016 return;
1017 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001018
Chris Lattner033935d2008-08-17 04:40:13 +00001019 const Constant *CV = dyn_cast<Constant>(V);
1020 if (CV && !isa<GlobalValue>(CV)) {
Dan Gohman8061d9e2009-08-13 15:27:57 +00001021 assert(TypePrinter && "Constants require TypePrinting!");
Dan Gohmana2489d12010-07-20 23:55:01 +00001022 WriteConstantInternal(Out, CV, *TypePrinter, Machine, Context);
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001023 return;
1024 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001025
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001026 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
Chris Lattner033935d2008-08-17 04:40:13 +00001027 Out << "asm ";
1028 if (IA->hasSideEffects())
1029 Out << "sideeffect ";
Dale Johannesen1cfb9582009-10-21 23:28:00 +00001030 if (IA->isAlignStack())
1031 Out << "alignstack ";
Chad Rosierd8c76102012-09-05 19:00:49 +00001032 // We don't emit the AD_ATT dialect as it's the assumed default.
1033 if (IA->getDialect() == InlineAsm::AD_Intel)
1034 Out << "inteldialect ";
Chris Lattner033935d2008-08-17 04:40:13 +00001035 Out << '"';
1036 PrintEscapedString(IA->getAsmString(), Out);
1037 Out << "\", \"";
1038 PrintEscapedString(IA->getConstraintString(), Out);
1039 Out << '"';
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001040 return;
1041 }
Devang Patel7428d8a2009-07-22 17:43:22 +00001042
Devang Patele059ba6e2009-07-23 01:07:34 +00001043 if (const MDNode *N = dyn_cast<MDNode>(V)) {
Victor Hernandez0471abd2009-12-18 20:09:14 +00001044 if (N->isFunctionLocal()) {
Victor Hernandezb7176a12009-12-04 01:35:02 +00001045 // Print metadata inline, not via slot reference number.
Dan Gohmana2489d12010-07-20 23:55:01 +00001046 WriteMDNodeBodyInternal(Out, N, TypePrinter, Machine, Context);
Victor Hernandezb7176a12009-12-04 01:35:02 +00001047 return;
1048 }
Andrew Trickec4b6e72011-09-30 19:48:58 +00001049
Dan Gohmana2489d12010-07-20 23:55:01 +00001050 if (!Machine) {
1051 if (N->isFunctionLocal())
1052 Machine = new SlotTracker(N->getFunction());
1053 else
1054 Machine = new SlotTracker(Context);
1055 }
Dan Gohman0a54da22010-09-09 20:53:58 +00001056 int Slot = Machine->getMetadataSlot(N);
1057 if (Slot == -1)
1058 Out << "<badref>";
1059 else
1060 Out << '!' << Slot;
Devang Patele059ba6e2009-07-23 01:07:34 +00001061 return;
1062 }
1063
Devang Patel7428d8a2009-07-22 17:43:22 +00001064 if (const MDString *MDS = dyn_cast<MDString>(V)) {
Devang Patel7428d8a2009-07-22 17:43:22 +00001065 Out << "!\"";
Daniel Dunbare03eecb2009-07-25 23:55:21 +00001066 PrintEscapedString(MDS->getString(), Out);
Devang Patel7428d8a2009-07-22 17:43:22 +00001067 Out << '"';
1068 return;
1069 }
1070
Evan Cheng00e87d12009-11-16 07:10:36 +00001071 if (V->getValueID() == Value::PseudoSourceValueVal ||
1072 V->getValueID() == Value::FixedStackPseudoSourceValueVal) {
Dan Gohmanc0353bf2009-09-23 01:33:16 +00001073 V->print(Out);
1074 return;
1075 }
1076
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001077 char Prefix = '%';
1078 int Slot;
Chris Lattner5b82a0a2011-08-03 06:15:41 +00001079 // If we have a SlotTracker, use it.
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001080 if (Machine) {
1081 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1082 Slot = Machine->getGlobalSlot(GV);
1083 Prefix = '@';
1084 } else {
1085 Slot = Machine->getLocalSlot(V);
Andrew Trickec4b6e72011-09-30 19:48:58 +00001086
Chris Lattner5b82a0a2011-08-03 06:15:41 +00001087 // If the local value didn't succeed, then we may be referring to a value
1088 // from a different function. Translate it, as this can happen when using
1089 // address of blocks.
1090 if (Slot == -1)
1091 if ((Machine = createSlotTracker(V))) {
1092 Slot = Machine->getLocalSlot(V);
1093 delete Machine;
1094 }
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001095 }
Chris Lattner5b82a0a2011-08-03 06:15:41 +00001096 } else if ((Machine = createSlotTracker(V))) {
1097 // Otherwise, create one to get the # and then destroy it.
1098 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1099 Slot = Machine->getGlobalSlot(GV);
1100 Prefix = '@';
Chris Lattnera2d810d2006-01-25 22:26:05 +00001101 } else {
Chris Lattner5b82a0a2011-08-03 06:15:41 +00001102 Slot = Machine->getLocalSlot(V);
Chris Lattnerd84bb632002-04-16 21:36:08 +00001103 }
Chris Lattner5b82a0a2011-08-03 06:15:41 +00001104 delete Machine;
1105 Machine = 0;
1106 } else {
1107 Slot = -1;
Chris Lattnerd84bb632002-04-16 21:36:08 +00001108 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001109
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001110 if (Slot != -1)
1111 Out << Prefix << Slot;
1112 else
1113 Out << "<badref>";
Chris Lattnerd84bb632002-04-16 21:36:08 +00001114}
1115
Dan Gohman12dad632009-08-12 20:56:03 +00001116void llvm::WriteAsOperand(raw_ostream &Out, const Value *V,
1117 bool PrintType, const Module *Context) {
Dan Gohman8061d9e2009-08-13 15:27:57 +00001118
1119 // Fast path: Don't construct and populate a TypePrinting object if we
1120 // won't be needing any types printed.
Dan Gohman08097122009-08-13 23:07:11 +00001121 if (!PrintType &&
Dan Gohmana2489d12010-07-20 23:55:01 +00001122 ((!isa<Constant>(V) && !isa<MDNode>(V)) ||
1123 V->hasName() || isa<GlobalValue>(V))) {
1124 WriteAsOperandInternal(Out, V, 0, 0, Context);
Dan Gohman8061d9e2009-08-13 15:27:57 +00001125 return;
1126 }
1127
Chris Lattner5a9f63e2002-07-10 16:48:17 +00001128 if (Context == 0) Context = getModuleFromVal(V);
Chris Lattnerb86620e2001-10-29 16:37:48 +00001129
Chris Lattner92c5c122009-02-28 23:20:19 +00001130 TypePrinting TypePrinter;
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001131 if (Context)
1132 TypePrinter.incorporateTypes(*Context);
Dan Gohman81313fd2008-09-14 17:21:12 +00001133 if (PrintType) {
Chris Lattnere101c442009-02-28 21:26:53 +00001134 TypePrinter.print(V->getType(), Out);
Dan Gohman81313fd2008-09-14 17:21:12 +00001135 Out << ' ';
1136 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00001137
Dan Gohmana2489d12010-07-20 23:55:01 +00001138 WriteAsOperandInternal(Out, V, &TypePrinter, 0, Context);
Chris Lattner5e5abe32001-07-20 19:15:21 +00001139}
1140
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001141namespace {
Chris Lattner2e9fee42001-07-12 23:35:26 +00001142
Chris Lattnerfee714f2001-09-07 16:36:04 +00001143class AssemblyWriter {
Dan Gohmane2745262009-08-12 17:23:50 +00001144 formatted_raw_ostream &Out;
Chris Lattnere36fd8a2008-08-19 04:26:57 +00001145 SlotTracker &Machine;
Chris Lattner7bfee412001-10-29 16:05:51 +00001146 const Module *TheModule;
Chris Lattner0f578952009-02-28 20:25:14 +00001147 TypePrinting TypePrinter;
Chris Lattner8339f7d2003-10-30 23:41:03 +00001148 AssemblyAnnotationWriter *AnnotationWriter;
Andrew Trickec4b6e72011-09-30 19:48:58 +00001149
Chris Lattner2f7c9632001-06-06 20:29:01 +00001150public:
Dan Gohmane2745262009-08-12 17:23:50 +00001151 inline AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
1152 const Module *M,
Chris Lattner8339f7d2003-10-30 23:41:03 +00001153 AssemblyAnnotationWriter *AAW)
Devang Patel59c0c132009-09-28 18:31:56 +00001154 : Out(o), Machine(Mac), TheModule(M), AnnotationWriter(AAW) {
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001155 if (M)
1156 TypePrinter.incorporateTypes(*M);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001157 }
1158
Chris Lattnerbddea6a2009-12-31 02:13:35 +00001159 void printMDNodeBody(const MDNode *MD);
Chris Lattner2c48c642009-12-31 01:54:05 +00001160 void printNamedMDNode(const NamedMDNode *NMD);
Andrew Trickec4b6e72011-09-30 19:48:58 +00001161
Chris Lattnerefb5e392009-12-31 02:23:35 +00001162 void printModule(const Module *M);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001163
Chris Lattner78e2e8b2006-12-06 06:24:27 +00001164 void writeOperand(const Value *Op, bool PrintType);
Devang Patelba3fa6c2008-09-23 23:03:40 +00001165 void writeParamOperand(const Value *Operand, Attributes Attrs);
Eli Friedmanfee02c62011-07-25 23:16:38 +00001166 void writeAtomic(AtomicOrdering Ordering, SynchronizationScope SynchScope);
Chris Lattner1e194682002-04-18 18:53:13 +00001167
Chris Lattnerbddea6a2009-12-31 02:13:35 +00001168 void writeAllMDNodes();
1169
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001170 void printTypeIdentities();
Chris Lattner7bfee412001-10-29 16:05:51 +00001171 void printGlobal(const GlobalVariable *GV);
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001172 void printAlias(const GlobalAlias *GV);
Chris Lattner57698e22002-03-26 18:01:55 +00001173 void printFunction(const Function *F);
Devang Patelba3fa6c2008-09-23 23:03:40 +00001174 void printArgument(const Argument *FA, Attributes Attrs);
Chris Lattner7bfee412001-10-29 16:05:51 +00001175 void printBasicBlock(const BasicBlock *BB);
Chris Lattner113f4f42002-06-25 16:13:24 +00001176 void printInstruction(const Instruction &I);
Chris Lattnerd816b532002-04-13 20:53:41 +00001177
Dan Gohmanbd11c412010-02-10 20:42:57 +00001178private:
Chris Lattner862e3382001-10-13 06:42:36 +00001179 // printInfoComment - Print a little comment after the instruction indicating
1180 // which slot it occupies.
Chris Lattner113f4f42002-06-25 16:13:24 +00001181 void printInfoComment(const Value &V);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001182};
Chris Lattner3243ea12009-03-01 00:03:38 +00001183} // end of anonymous namespace
Chris Lattner2f7c9632001-06-06 20:29:01 +00001184
Chris Lattner78e2e8b2006-12-06 06:24:27 +00001185void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
1186 if (Operand == 0) {
Chris Lattner08f7d0c2005-02-24 16:58:29 +00001187 Out << "<null operand!>";
Chris Lattnerb419a1e2009-12-31 02:33:14 +00001188 return;
Chris Lattner08f7d0c2005-02-24 16:58:29 +00001189 }
Chris Lattnerb419a1e2009-12-31 02:33:14 +00001190 if (PrintType) {
1191 TypePrinter.print(Operand->getType(), Out);
1192 Out << ' ';
1193 }
Dan Gohmana2489d12010-07-20 23:55:01 +00001194 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001195}
1196
Eli Friedmanfee02c62011-07-25 23:16:38 +00001197void AssemblyWriter::writeAtomic(AtomicOrdering Ordering,
1198 SynchronizationScope SynchScope) {
1199 if (Ordering == NotAtomic)
1200 return;
1201
1202 switch (SynchScope) {
Eli Friedmanfee02c62011-07-25 23:16:38 +00001203 case SingleThread: Out << " singlethread"; break;
1204 case CrossThread: break;
1205 }
1206
1207 switch (Ordering) {
1208 default: Out << " <bad ordering " << int(Ordering) << ">"; break;
1209 case Unordered: Out << " unordered"; break;
1210 case Monotonic: Out << " monotonic"; break;
1211 case Acquire: Out << " acquire"; break;
1212 case Release: Out << " release"; break;
1213 case AcquireRelease: Out << " acq_rel"; break;
1214 case SequentiallyConsistent: Out << " seq_cst"; break;
1215 }
1216}
1217
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001218void AssemblyWriter::writeParamOperand(const Value *Operand,
Devang Patelba3fa6c2008-09-23 23:03:40 +00001219 Attributes Attrs) {
Duncan Sandsad0ea2d2007-11-27 13:23:08 +00001220 if (Operand == 0) {
1221 Out << "<null operand!>";
Chris Lattnerb419a1e2009-12-31 02:33:14 +00001222 return;
Duncan Sandsad0ea2d2007-11-27 13:23:08 +00001223 }
Chris Lattnerb419a1e2009-12-31 02:33:14 +00001224
1225 // Print the type
1226 TypePrinter.print(Operand->getType(), Out);
1227 // Print parameter attributes list
1228 if (Attrs != Attribute::None)
1229 Out << ' ' << Attribute::getAsString(Attrs);
1230 Out << ' ';
1231 // Print the operand
Dan Gohmana2489d12010-07-20 23:55:01 +00001232 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine, TheModule);
Duncan Sandsad0ea2d2007-11-27 13:23:08 +00001233}
Chris Lattner2f7c9632001-06-06 20:29:01 +00001234
Chris Lattner7bfee412001-10-29 16:05:51 +00001235void AssemblyWriter::printModule(const Module *M) {
Chris Lattner4d8689e2005-03-02 23:12:40 +00001236 if (!M->getModuleIdentifier().empty() &&
Misha Brukmanb1c93172005-04-21 23:48:37 +00001237 // Don't print the ID if it will start a new line (which would
Chris Lattner4d8689e2005-03-02 23:12:40 +00001238 // require a comment char before it).
1239 M->getModuleIdentifier().find('\n') == std::string::npos)
1240 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
1241
Owen Andersone2237542006-10-18 02:21:12 +00001242 if (!M->getDataLayout().empty())
Chris Lattner04897162006-10-22 06:06:56 +00001243 Out << "target datalayout = \"" << M->getDataLayout() << "\"\n";
Reid Spencer48f98c82004-07-25 21:44:54 +00001244 if (!M->getTargetTriple().empty())
Reid Spencerffec7df2004-07-25 21:29:43 +00001245 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
Misha Brukmanb1c93172005-04-21 23:48:37 +00001246
Chris Lattnereef2fe72006-01-24 04:13:11 +00001247 if (!M->getModuleInlineAsm().empty()) {
Chris Lattnerefaf35d2006-01-24 00:45:30 +00001248 // Split the string into lines, to make it easier to read the .ll file.
Chris Lattnereef2fe72006-01-24 04:13:11 +00001249 std::string Asm = M->getModuleInlineAsm();
Chris Lattnerefaf35d2006-01-24 00:45:30 +00001250 size_t CurPos = 0;
1251 size_t NewLine = Asm.find_first_of('\n', CurPos);
Dan Gohman69273e62009-08-12 23:54:22 +00001252 Out << '\n';
Chris Lattnerefaf35d2006-01-24 00:45:30 +00001253 while (NewLine != std::string::npos) {
1254 // We found a newline, print the portion of the asm string from the
1255 // last newline up to this newline.
1256 Out << "module asm \"";
1257 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
1258 Out);
1259 Out << "\"\n";
1260 CurPos = NewLine+1;
1261 NewLine = Asm.find_first_of('\n', CurPos);
1262 }
Rafael Espindola1e49a6d2011-03-02 04:14:42 +00001263 std::string rest(Asm.begin()+CurPos, Asm.end());
1264 if (!rest.empty()) {
1265 Out << "module asm \"";
1266 PrintEscapedString(rest, Out);
1267 Out << "\"\n";
1268 }
Chris Lattner6ed87bd2006-01-23 23:03:36 +00001269 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001270
Chris Lattner2cdd49d2004-09-14 05:06:58 +00001271 // Loop over the dependent libraries and emit them.
Chris Lattner730cfe42004-09-14 04:51:44 +00001272 Module::lib_iterator LI = M->lib_begin();
1273 Module::lib_iterator LE = M->lib_end();
Reid Spencer48f98c82004-07-25 21:44:54 +00001274 if (LI != LE) {
Dan Gohman69273e62009-08-12 23:54:22 +00001275 Out << '\n';
Chris Lattner730cfe42004-09-14 04:51:44 +00001276 Out << "deplibs = [ ";
1277 while (LI != LE) {
Chris Lattner2cdd49d2004-09-14 05:06:58 +00001278 Out << '"' << *LI << '"';
Reid Spencerffec7df2004-07-25 21:29:43 +00001279 ++LI;
Chris Lattner730cfe42004-09-14 04:51:44 +00001280 if (LI != LE)
1281 Out << ", ";
Reid Spencerffec7df2004-07-25 21:29:43 +00001282 }
Dan Gohman69273e62009-08-12 23:54:22 +00001283 Out << " ]";
Reid Spencercc5ff642004-07-25 18:08:18 +00001284 }
Reid Spencerb9e08772004-09-13 23:44:23 +00001285
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001286 printTypeIdentities();
Misha Brukmanb1c93172005-04-21 23:48:37 +00001287
Dan Gohman69273e62009-08-12 23:54:22 +00001288 // Output all globals.
1289 if (!M->global_empty()) Out << '\n';
Chris Lattner54932b02006-12-06 04:41:52 +00001290 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
1291 I != E; ++I)
Chris Lattner113f4f42002-06-25 16:13:24 +00001292 printGlobal(I);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001293
Chris Lattnerd2747052007-04-26 02:24:10 +00001294 // Output all aliases.
1295 if (!M->alias_empty()) Out << "\n";
1296 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
1297 I != E; ++I)
1298 printAlias(I);
Chris Lattnerfee714f2001-09-07 16:36:04 +00001299
Chris Lattner2cdd49d2004-09-14 05:06:58 +00001300 // Output all of the functions.
Chris Lattner113f4f42002-06-25 16:13:24 +00001301 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
1302 printFunction(I);
Devang Patel983c6b12009-07-08 21:44:25 +00001303
Devang Patel23e68302009-07-29 22:04:47 +00001304 // Output named metadata.
Dan Gohman69273e62009-08-12 23:54:22 +00001305 if (!M->named_metadata_empty()) Out << '\n';
Andrew Trickec4b6e72011-09-30 19:48:58 +00001306
Devang Patel23e68302009-07-29 22:04:47 +00001307 for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
Chris Lattnerbddea6a2009-12-31 02:13:35 +00001308 E = M->named_metadata_end(); I != E; ++I)
Chris Lattner2c48c642009-12-31 01:54:05 +00001309 printNamedMDNode(I);
Devang Patel23e68302009-07-29 22:04:47 +00001310
1311 // Output metadata.
Chris Lattnercf4a76e2009-12-31 02:20:11 +00001312 if (!Machine.mdn_empty()) {
Chris Lattnerbddea6a2009-12-31 02:13:35 +00001313 Out << '\n';
1314 writeAllMDNodes();
1315 }
Chris Lattnerfee714f2001-09-07 16:36:04 +00001316}
1317
Chris Lattner2c48c642009-12-31 01:54:05 +00001318void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
Nick Lewycky5bcbd732011-06-15 06:37:58 +00001319 Out << '!';
1320 StringRef Name = NMD->getName();
1321 if (Name.empty()) {
1322 Out << "<empty name> ";
1323 } else {
1324 if (isalpha(Name[0]) || Name[0] == '-' || Name[0] == '$' ||
1325 Name[0] == '.' || Name[0] == '_')
1326 Out << Name[0];
1327 else
1328 Out << '\\' << hexdigit(Name[0] >> 4) << hexdigit(Name[0] & 0x0F);
1329 for (unsigned i = 1, e = Name.size(); i != e; ++i) {
1330 unsigned char C = Name[i];
1331 if (isalnum(C) || C == '-' || C == '$' || C == '.' || C == '_')
1332 Out << C;
1333 else
1334 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
1335 }
1336 }
1337 Out << " = !{";
Chris Lattner2c48c642009-12-31 01:54:05 +00001338 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1339 if (i) Out << ", ";
Dan Gohman0a54da22010-09-09 20:53:58 +00001340 int Slot = Machine.getMetadataSlot(NMD->getOperand(i));
1341 if (Slot == -1)
1342 Out << "<badref>";
1343 else
1344 Out << '!' << Slot;
Chris Lattner2c48c642009-12-31 01:54:05 +00001345 }
1346 Out << "}\n";
1347}
1348
1349
Dan Gohmane2745262009-08-12 17:23:50 +00001350static void PrintLinkage(GlobalValue::LinkageTypes LT,
1351 formatted_raw_ostream &Out) {
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001352 switch (LT) {
Bill Wendlinga3c6f6b2009-07-20 01:03:30 +00001353 case GlobalValue::ExternalLinkage: break;
1354 case GlobalValue::PrivateLinkage: Out << "private "; break;
1355 case GlobalValue::LinkerPrivateLinkage: Out << "linker_private "; break;
Bill Wendling03bcd6e2010-07-01 21:55:59 +00001356 case GlobalValue::LinkerPrivateWeakLinkage:
1357 Out << "linker_private_weak ";
1358 break;
Bill Wendlinga3c6f6b2009-07-20 01:03:30 +00001359 case GlobalValue::InternalLinkage: Out << "internal "; break;
1360 case GlobalValue::LinkOnceAnyLinkage: Out << "linkonce "; break;
1361 case GlobalValue::LinkOnceODRLinkage: Out << "linkonce_odr "; break;
Bill Wendling34bc34e2012-08-17 18:33:14 +00001362 case GlobalValue::LinkOnceODRAutoHideLinkage:
1363 Out << "linkonce_odr_auto_hide ";
1364 break;
Bill Wendlinga3c6f6b2009-07-20 01:03:30 +00001365 case GlobalValue::WeakAnyLinkage: Out << "weak "; break;
1366 case GlobalValue::WeakODRLinkage: Out << "weak_odr "; break;
1367 case GlobalValue::CommonLinkage: Out << "common "; break;
1368 case GlobalValue::AppendingLinkage: Out << "appending "; break;
1369 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
1370 case GlobalValue::DLLExportLinkage: Out << "dllexport "; break;
1371 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
Chris Lattner184f1be2009-04-13 05:44:34 +00001372 case GlobalValue::AvailableExternallyLinkage:
1373 Out << "available_externally ";
1374 break;
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001375 }
1376}
Duncan Sands12da8ce2009-03-07 15:45:40 +00001377
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001378
1379static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
Dan Gohmane2745262009-08-12 17:23:50 +00001380 formatted_raw_ostream &Out) {
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001381 switch (Vis) {
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001382 case GlobalValue::DefaultVisibility: break;
1383 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
1384 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
1385 }
1386}
1387
Hans Wennborgcbe34b42012-06-23 11:37:03 +00001388static void PrintThreadLocalModel(GlobalVariable::ThreadLocalMode TLM,
1389 formatted_raw_ostream &Out) {
1390 switch (TLM) {
1391 case GlobalVariable::NotThreadLocal:
1392 break;
1393 case GlobalVariable::GeneralDynamicTLSModel:
1394 Out << "thread_local ";
1395 break;
1396 case GlobalVariable::LocalDynamicTLSModel:
1397 Out << "thread_local(localdynamic) ";
1398 break;
1399 case GlobalVariable::InitialExecTLSModel:
1400 Out << "thread_local(initialexec) ";
1401 break;
1402 case GlobalVariable::LocalExecTLSModel:
1403 Out << "thread_local(localexec) ";
1404 break;
1405 }
1406}
1407
Chris Lattner7bfee412001-10-29 16:05:51 +00001408void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
Dan Gohman5ded1422010-01-29 23:12:36 +00001409 if (GV->isMaterializable())
1410 Out << "; Materializable\n";
1411
Dan Gohmana2489d12010-07-20 23:55:01 +00001412 WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine, GV->getParent());
Dan Gohman466876b2009-08-12 23:32:33 +00001413 Out << " = ";
Chris Lattner37798642001-09-18 04:01:05 +00001414
Chris Lattner1508d3f2008-08-19 05:16:28 +00001415 if (!GV->hasInitializer() && GV->hasExternalLinkage())
1416 Out << "external ";
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001417
Chris Lattner1508d3f2008-08-19 05:16:28 +00001418 PrintLinkage(GV->getLinkage(), Out);
1419 PrintVisibility(GV->getVisibility(), Out);
Hans Wennborgcbe34b42012-06-23 11:37:03 +00001420 PrintThreadLocalModel(GV->getThreadLocalMode(), Out);
Lauro Ramos Venancio749e4662007-04-12 18:32:50 +00001421
Chris Lattnerac161bf2009-01-02 07:01:27 +00001422 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
1423 Out << "addrspace(" << AddressSpace << ") ";
Rafael Espindola45e6c192011-01-08 16:42:36 +00001424 if (GV->hasUnnamedAddr()) Out << "unnamed_addr ";
Misha Brukmana6619a92004-06-21 21:53:56 +00001425 Out << (GV->isConstant() ? "constant " : "global ");
Chris Lattnere101c442009-02-28 21:26:53 +00001426 TypePrinter.print(GV->getType()->getElementType(), Out);
Chris Lattner37798642001-09-18 04:01:05 +00001427
Dan Gohman81313fd2008-09-14 17:21:12 +00001428 if (GV->hasInitializer()) {
1429 Out << ' ';
Devang Patel983c6b12009-07-08 21:44:25 +00001430 writeOperand(GV->getInitializer(), false);
Dan Gohman81313fd2008-09-14 17:21:12 +00001431 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001432
Chris Lattner9380b812010-07-07 23:16:37 +00001433 if (GV->hasSection()) {
1434 Out << ", section \"";
1435 PrintEscapedString(GV->getSection(), Out);
1436 Out << '"';
1437 }
Chris Lattner4b96c542005-11-12 00:10:19 +00001438 if (GV->getAlignment())
Chris Lattnerf8a974d2005-11-06 06:48:53 +00001439 Out << ", align " << GV->getAlignment();
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001440
Chris Lattner113f4f42002-06-25 16:13:24 +00001441 printInfoComment(*GV);
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001442 Out << '\n';
Chris Lattnerda975502001-09-10 07:58:01 +00001443}
1444
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001445void AssemblyWriter::printAlias(const GlobalAlias *GA) {
Dan Gohman5ded1422010-01-29 23:12:36 +00001446 if (GA->isMaterializable())
1447 Out << "; Materializable\n";
1448
Dale Johannesen83e468a2008-06-03 18:14:29 +00001449 // Don't crash when dumping partially built GA
1450 if (!GA->hasName())
1451 Out << "<<nameless>> = ";
Chris Lattner033935d2008-08-17 04:40:13 +00001452 else {
1453 PrintLLVMName(Out, GA);
1454 Out << " = ";
1455 }
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001456 PrintVisibility(GA->getVisibility(), Out);
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001457
1458 Out << "alias ";
1459
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001460 PrintLinkage(GA->getLinkage(), Out);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001461
Anton Korobeynikov546ea7e2007-04-29 18:02:48 +00001462 const Constant *Aliasee = GA->getAliasee();
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001463
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001464 if (Aliasee == 0) {
1465 TypePrinter.print(GA->getType(), Out);
1466 Out << " <<NULL ALIASEE>>";
Jay Foad92c19132011-08-01 12:48:54 +00001467 } else {
Jay Foad26db79d2011-08-01 12:29:14 +00001468 writeOperand(Aliasee, !isa<ConstantExpr>(Aliasee));
Jay Foad92c19132011-08-01 12:48:54 +00001469 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001470
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001471 printInfoComment(*GA);
Chris Lattner1508d3f2008-08-19 05:16:28 +00001472 Out << '\n';
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001473}
1474
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001475void AssemblyWriter::printTypeIdentities() {
1476 if (TypePrinter.NumberedTypes.empty() &&
1477 TypePrinter.NamedTypes.empty())
1478 return;
Andrew Trickec4b6e72011-09-30 19:48:58 +00001479
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001480 Out << '\n';
Andrew Trickec4b6e72011-09-30 19:48:58 +00001481
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001482 // We know all the numbers that each type is used and we know that it is a
1483 // dense assignment. Convert the map to an index table.
1484 std::vector<StructType*> NumberedTypes(TypePrinter.NumberedTypes.size());
Andrew Trickec4b6e72011-09-30 19:48:58 +00001485 for (DenseMap<StructType*, unsigned>::iterator I =
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001486 TypePrinter.NumberedTypes.begin(), E = TypePrinter.NumberedTypes.end();
1487 I != E; ++I) {
1488 assert(I->second < NumberedTypes.size() && "Didn't get a dense numbering?");
1489 NumberedTypes[I->second] = I->first;
1490 }
Andrew Trickec4b6e72011-09-30 19:48:58 +00001491
Chris Lattner3243ea12009-03-01 00:03:38 +00001492 // Emit all numbered types.
1493 for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
Dan Gohman466876b2009-08-12 23:32:33 +00001494 Out << '%' << i << " = type ";
Andrew Trickec4b6e72011-09-30 19:48:58 +00001495
Chris Lattner3243ea12009-03-01 00:03:38 +00001496 // Make sure we print out at least one level of the type structure, so
1497 // that we do not get %2 = type %2
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001498 TypePrinter.printStructBody(NumberedTypes[i], Out);
Dan Gohman69273e62009-08-12 23:54:22 +00001499 Out << '\n';
Chris Lattner3243ea12009-03-01 00:03:38 +00001500 }
Andrew Trickec4b6e72011-09-30 19:48:58 +00001501
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001502 for (unsigned i = 0, e = TypePrinter.NamedTypes.size(); i != e; ++i) {
1503 PrintLLVMName(Out, TypePrinter.NamedTypes[i]->getName(), LocalPrefix);
Chris Lattner1508d3f2008-08-19 05:16:28 +00001504 Out << " = type ";
Reid Spencere7e96712004-05-25 08:53:40 +00001505
1506 // Make sure we print out at least one level of the type structure, so
1507 // that we do not get %FILE = type %FILE
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001508 TypePrinter.printStructBody(TypePrinter.NamedTypes[i], Out);
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001509 Out << '\n';
Reid Spencere7e96712004-05-25 08:53:40 +00001510 }
Reid Spencer32af9e82007-01-06 07:24:44 +00001511}
1512
Misha Brukmanc566ca362004-03-02 00:22:19 +00001513/// printFunction - Print all aspects of a function.
1514///
Chris Lattner113f4f42002-06-25 16:13:24 +00001515void AssemblyWriter::printFunction(const Function *F) {
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001516 // Print out the return type and name.
1517 Out << '\n';
Chris Lattner379a8d22003-04-16 20:28:45 +00001518
Misha Brukmana6619a92004-06-21 21:53:56 +00001519 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
Chris Lattner8339f7d2003-10-30 23:41:03 +00001520
Dan Gohman5ded1422010-01-29 23:12:36 +00001521 if (F->isMaterializable())
1522 Out << "; Materializable\n";
1523
Reid Spencer5301e7c2007-01-30 20:08:39 +00001524 if (F->isDeclaration())
Chris Lattner10f03a62007-08-19 22:15:26 +00001525 Out << "declare ";
1526 else
Reid Spencer7ce2d2a2006-12-29 20:29:48 +00001527 Out << "define ";
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001528
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001529 PrintLinkage(F->getLinkage(), Out);
1530 PrintVisibility(F->getVisibility(), Out);
Chris Lattner379a8d22003-04-16 20:28:45 +00001531
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001532 // Print the calling convention.
1533 switch (F->getCallingConv()) {
1534 case CallingConv::C: break; // default
Anton Korobeynikov3c5b3df2006-09-20 22:03:51 +00001535 case CallingConv::Fast: Out << "fastcc "; break;
1536 case CallingConv::Cold: Out << "coldcc "; break;
1537 case CallingConv::X86_StdCall: Out << "x86_stdcallcc "; break;
Anton Korobeynikova8fd40b2009-06-16 18:50:49 +00001538 case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
Anton Korobeynikov8f35fab2010-05-16 09:08:45 +00001539 case CallingConv::X86_ThisCall: Out << "x86_thiscallcc "; break;
Anton Korobeynikova8fd40b2009-06-16 18:50:49 +00001540 case CallingConv::ARM_APCS: Out << "arm_apcscc "; break;
1541 case CallingConv::ARM_AAPCS: Out << "arm_aapcscc "; break;
1542 case CallingConv::ARM_AAPCS_VFP:Out << "arm_aapcs_vfpcc "; break;
Anton Korobeynikov27a0ecf2009-12-07 02:27:35 +00001543 case CallingConv::MSP430_INTR: Out << "msp430_intrcc "; break;
Justin Holewinski0cfa7372011-03-07 14:32:30 +00001544 case CallingConv::PTX_Kernel: Out << "ptx_kernel "; break;
1545 case CallingConv::PTX_Device: Out << "ptx_device "; break;
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001546 default: Out << "cc" << F->getCallingConv() << " "; break;
1547 }
1548
Chris Lattner229907c2011-07-18 04:54:35 +00001549 FunctionType *FT = F->getFunctionType();
Devang Patel4c758ea2008-09-25 21:00:45 +00001550 const AttrListPtr &Attrs = F->getAttributes();
Devang Patel221fe422008-09-29 20:49:50 +00001551 Attributes RetAttrs = Attrs.getRetAttributes();
1552 if (RetAttrs != Attribute::None)
1553 Out << Attribute::getAsString(Attrs.getRetAttributes()) << ' ';
Chris Lattnere101c442009-02-28 21:26:53 +00001554 TypePrinter.print(F->getReturnType(), Out);
Chris Lattner585297e82008-08-19 05:26:17 +00001555 Out << ' ';
Dan Gohmana2489d12010-07-20 23:55:01 +00001556 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine, F->getParent());
Misha Brukmana6619a92004-06-21 21:53:56 +00001557 Out << '(';
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001558 Machine.incorporateFunction(F);
Chris Lattnerfee714f2001-09-07 16:36:04 +00001559
Chris Lattner7bfee412001-10-29 16:05:51 +00001560 // Loop over the arguments, printing them...
Chris Lattnerfee714f2001-09-07 16:36:04 +00001561
Reid Spencer8c4914c2006-12-31 05:24:50 +00001562 unsigned Idx = 1;
Chris Lattner82738fe2007-04-18 00:57:22 +00001563 if (!F->isDeclaration()) {
1564 // If this isn't a declaration, print the argument names as well.
1565 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1566 I != E; ++I) {
1567 // Insert commas as we go... the first arg doesn't get a comma
1568 if (I != F->arg_begin()) Out << ", ";
Devang Patela05633e2008-09-26 22:53:05 +00001569 printArgument(I, Attrs.getParamAttributes(Idx));
Chris Lattner82738fe2007-04-18 00:57:22 +00001570 Idx++;
1571 }
1572 } else {
1573 // Otherwise, print the types from the function type.
1574 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1575 // Insert commas as we go... the first arg doesn't get a comma
1576 if (i) Out << ", ";
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001577
Chris Lattner82738fe2007-04-18 00:57:22 +00001578 // Output type...
Chris Lattnere101c442009-02-28 21:26:53 +00001579 TypePrinter.print(FT->getParamType(i), Out);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001580
Devang Patela05633e2008-09-26 22:53:05 +00001581 Attributes ArgAttrs = Attrs.getParamAttributes(i+1);
Devang Patel4c758ea2008-09-25 21:00:45 +00001582 if (ArgAttrs != Attribute::None)
1583 Out << ' ' << Attribute::getAsString(ArgAttrs);
Chris Lattner82738fe2007-04-18 00:57:22 +00001584 }
Reid Spencer8c4914c2006-12-31 05:24:50 +00001585 }
Chris Lattnerfee714f2001-09-07 16:36:04 +00001586
1587 // Finish printing arguments...
Chris Lattner113f4f42002-06-25 16:13:24 +00001588 if (FT->isVarArg()) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001589 if (FT->getNumParams()) Out << ", ";
1590 Out << "..."; // Output varargs portion of signature!
Chris Lattnerfee714f2001-09-07 16:36:04 +00001591 }
Misha Brukmana6619a92004-06-21 21:53:56 +00001592 Out << ')';
Rafael Espindola563eb4b2011-01-25 19:09:56 +00001593 if (F->hasUnnamedAddr())
1594 Out << " unnamed_addr";
Devang Patela05633e2008-09-26 22:53:05 +00001595 Attributes FnAttrs = Attrs.getFnAttributes();
1596 if (FnAttrs != Attribute::None)
1597 Out << ' ' << Attribute::getAsString(Attrs.getFnAttributes());
Chris Lattner9380b812010-07-07 23:16:37 +00001598 if (F->hasSection()) {
1599 Out << " section \"";
1600 PrintEscapedString(F->getSection(), Out);
1601 Out << '"';
1602 }
Chris Lattnerf8a974d2005-11-06 06:48:53 +00001603 if (F->getAlignment())
1604 Out << " align " << F->getAlignment();
Gordon Henriksend930f912008-08-17 18:44:35 +00001605 if (F->hasGC())
1606 Out << " gc \"" << F->getGC() << '"';
Reid Spencer5301e7c2007-01-30 20:08:39 +00001607 if (F->isDeclaration()) {
Chris Lattnerfb483622010-09-02 22:52:10 +00001608 Out << '\n';
Chris Lattnerb2f02e52002-05-06 03:00:40 +00001609 } else {
Chris Lattnerfb483622010-09-02 22:52:10 +00001610 Out << " {";
1611 // Output all of the function's basic blocks.
Chris Lattner113f4f42002-06-25 16:13:24 +00001612 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1613 printBasicBlock(I);
Chris Lattnerfee714f2001-09-07 16:36:04 +00001614
Misha Brukmana6619a92004-06-21 21:53:56 +00001615 Out << "}\n";
Chris Lattnerfee714f2001-09-07 16:36:04 +00001616 }
1617
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001618 Machine.purgeFunction();
Chris Lattner2f7c9632001-06-06 20:29:01 +00001619}
1620
Misha Brukmanc566ca362004-03-02 00:22:19 +00001621/// printArgument - This member is called for every argument that is passed into
1622/// the function. Simply print it out
1623///
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001624void AssemblyWriter::printArgument(const Argument *Arg,
Devang Patelba3fa6c2008-09-23 23:03:40 +00001625 Attributes Attrs) {
Chris Lattner2f7c9632001-06-06 20:29:01 +00001626 // Output type...
Chris Lattnere101c442009-02-28 21:26:53 +00001627 TypePrinter.print(Arg->getType(), Out);
Misha Brukmanb1c93172005-04-21 23:48:37 +00001628
Duncan Sandsad0ea2d2007-11-27 13:23:08 +00001629 // Output parameter attributes list
Devang Patel4c758ea2008-09-25 21:00:45 +00001630 if (Attrs != Attribute::None)
1631 Out << ' ' << Attribute::getAsString(Attrs);
Reid Spencer8c4914c2006-12-31 05:24:50 +00001632
Chris Lattner2f7c9632001-06-06 20:29:01 +00001633 // Output name, if available...
Chris Lattner033935d2008-08-17 04:40:13 +00001634 if (Arg->hasName()) {
1635 Out << ' ';
1636 PrintLLVMName(Out, Arg);
1637 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001638}
1639
Misha Brukmanc566ca362004-03-02 00:22:19 +00001640/// printBasicBlock - This member is called for each basic block in a method.
1641///
Chris Lattner7bfee412001-10-29 16:05:51 +00001642void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
Nick Lewycky4d43d3c2008-04-25 16:53:59 +00001643 if (BB->hasName()) { // Print out the label if it exists...
Chris Lattner033935d2008-08-17 04:40:13 +00001644 Out << "\n";
Daniel Dunbare03eecb2009-07-25 23:55:21 +00001645 PrintLLVMName(Out, BB->getName(), LabelPrefix);
Chris Lattner033935d2008-08-17 04:40:13 +00001646 Out << ':';
Nick Lewycky4d43d3c2008-04-25 16:53:59 +00001647 } else if (!BB->use_empty()) { // Don't print block # of no uses...
Bill Wendling35a9c3c2011-04-10 23:18:04 +00001648 Out << "\n; <label>:";
Chris Lattner5e043322007-01-11 03:54:27 +00001649 int Slot = Machine.getLocalSlot(BB);
Chris Lattner757ee0b2004-06-09 19:41:19 +00001650 if (Slot != -1)
Misha Brukmana6619a92004-06-21 21:53:56 +00001651 Out << Slot;
Chris Lattner757ee0b2004-06-09 19:41:19 +00001652 else
Misha Brukmana6619a92004-06-21 21:53:56 +00001653 Out << "<badref>";
Chris Lattner58185f22002-10-02 19:38:55 +00001654 }
Chris Lattner2447ef52003-11-20 00:09:43 +00001655
Dan Gohmane2745262009-08-12 17:23:50 +00001656 if (BB->getParent() == 0) {
Chris Lattneree97b8b2009-08-17 15:48:08 +00001657 Out.PadToColumn(50);
Dan Gohmane2745262009-08-12 17:23:50 +00001658 Out << "; Error: Block without parent!";
1659 } else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
Chris Lattnerfb483622010-09-02 22:52:10 +00001660 // Output predecessors for the block.
Chris Lattneree97b8b2009-08-17 15:48:08 +00001661 Out.PadToColumn(50);
Dan Gohmane2745262009-08-12 17:23:50 +00001662 Out << ";";
Gabor Greif6c6b2fd2010-03-25 23:25:28 +00001663 const_pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001664
Chris Lattnerff834c02008-04-22 02:45:44 +00001665 if (PI == PE) {
1666 Out << " No predecessors!";
1667 } else {
Dan Gohman81313fd2008-09-14 17:21:12 +00001668 Out << " preds = ";
Chris Lattnerff834c02008-04-22 02:45:44 +00001669 writeOperand(*PI, false);
1670 for (++PI; PI != PE; ++PI) {
Dan Gohman81313fd2008-09-14 17:21:12 +00001671 Out << ", ";
Chris Lattner78e2e8b2006-12-06 06:24:27 +00001672 writeOperand(*PI, false);
Chris Lattner00211f12003-11-16 22:59:57 +00001673 }
Chris Lattner58185f22002-10-02 19:38:55 +00001674 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001675 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00001676
Chris Lattnerff834c02008-04-22 02:45:44 +00001677 Out << "\n";
Chris Lattner2f7c9632001-06-06 20:29:01 +00001678
Misha Brukmana6619a92004-06-21 21:53:56 +00001679 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
Chris Lattner8339f7d2003-10-30 23:41:03 +00001680
Chris Lattnerfee714f2001-09-07 16:36:04 +00001681 // Output all of the instructions in the basic block...
Dan Gohmana4f709e2009-07-13 18:27:59 +00001682 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
Chris Lattner113f4f42002-06-25 16:13:24 +00001683 printInstruction(*I);
Dan Gohmana4f709e2009-07-13 18:27:59 +00001684 Out << '\n';
1685 }
Chris Lattner96cdd272004-03-08 18:51:45 +00001686
Misha Brukmana6619a92004-06-21 21:53:56 +00001687 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001688}
1689
Misha Brukmanc566ca362004-03-02 00:22:19 +00001690/// printInfoComment - Print a little comment after the instruction indicating
1691/// which slot it occupies.
1692///
Chris Lattner113f4f42002-06-25 16:13:24 +00001693void AssemblyWriter::printInfoComment(const Value &V) {
Dan Gohmane34890f2010-02-10 20:41:46 +00001694 if (AnnotationWriter) {
1695 AnnotationWriter->printInfoComment(V, Out);
1696 return;
1697 }
Chris Lattner862e3382001-10-13 06:42:36 +00001698}
1699
Reid Spencere7141c82006-08-28 01:02:49 +00001700// This member is called for each Instruction in a function..
Chris Lattner113f4f42002-06-25 16:13:24 +00001701void AssemblyWriter::printInstruction(const Instruction &I) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001702 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
Chris Lattner8339f7d2003-10-30 23:41:03 +00001703
Dan Gohman466876b2009-08-12 23:32:33 +00001704 // Print out indentation for an instruction.
Dan Gohmanb4583b12009-08-13 01:41:52 +00001705 Out << " ";
Chris Lattner2f7c9632001-06-06 20:29:01 +00001706
1707 // Print out name if it exists...
Chris Lattner033935d2008-08-17 04:40:13 +00001708 if (I.hasName()) {
1709 PrintLLVMName(Out, &I);
1710 Out << " = ";
Chris Lattner031560c2009-12-29 07:25:48 +00001711 } else if (!I.getType()->isVoidTy()) {
Chris Lattnerb25e5ea2008-08-29 17:19:30 +00001712 // Print out the def slot taken.
1713 int SlotNum = Machine.getLocalSlot(&I);
1714 if (SlotNum == -1)
1715 Out << "<badref> = ";
1716 else
1717 Out << '%' << SlotNum << " = ";
Chris Lattner033935d2008-08-17 04:40:13 +00001718 }
Andrew Trickec4b6e72011-09-30 19:48:58 +00001719
Eli Friedman59b66882011-08-09 23:02:53 +00001720 if (isa<CallInst>(I) && cast<CallInst>(I).isTailCall())
Chris Lattner06038452005-05-06 05:51:46 +00001721 Out << "tail ";
Chris Lattner504f9242003-09-08 17:45:59 +00001722
Chris Lattner2f7c9632001-06-06 20:29:01 +00001723 // Print out the opcode...
Misha Brukmana6619a92004-06-21 21:53:56 +00001724 Out << I.getOpcodeName();
Chris Lattner2f7c9632001-06-06 20:29:01 +00001725
Eli Friedman02e737b2011-08-12 22:50:01 +00001726 // If this is an atomic load or store, print out the atomic marker.
1727 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isAtomic()) ||
1728 (isa<StoreInst>(I) && cast<StoreInst>(I).isAtomic()))
1729 Out << " atomic";
1730
1731 // If this is a volatile operation, print out the volatile marker.
1732 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
1733 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()) ||
1734 (isa<AtomicCmpXchgInst>(I) && cast<AtomicCmpXchgInst>(I).isVolatile()) ||
1735 (isa<AtomicRMWInst>(I) && cast<AtomicRMWInst>(I).isVolatile()))
1736 Out << " volatile";
1737
Dan Gohman9c7f8082009-07-27 16:11:46 +00001738 // Print out optimization information.
1739 WriteOptimizationInfo(Out, &I);
1740
Reid Spencer45e52392006-12-03 06:27:29 +00001741 // Print out the compare instruction predicates
Nate Begemand2195702008-05-12 19:01:56 +00001742 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
Chris Lattner82ff9232008-08-23 22:52:27 +00001743 Out << ' ' << getPredicateText(CI->getPredicate());
Reid Spencer45e52392006-12-03 06:27:29 +00001744
Eli Friedmanc9a551e2011-07-28 21:48:00 +00001745 // Print out the atomicrmw operation
1746 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I))
1747 writeAtomicRMWOperation(Out, RMWI->getOperation());
1748
Chris Lattner2f7c9632001-06-06 20:29:01 +00001749 // Print out the type of the operands...
Chris Lattner113f4f42002-06-25 16:13:24 +00001750 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
Chris Lattner2f7c9632001-06-06 20:29:01 +00001751
1752 // Special case conditional branches to swizzle the condition out to the front
Gabor Greifcab008f2009-02-09 15:45:06 +00001753 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
1754 BranchInst &BI(cast<BranchInst>(I));
Dan Gohman81313fd2008-09-14 17:21:12 +00001755 Out << ' ';
Gabor Greifcab008f2009-02-09 15:45:06 +00001756 writeOperand(BI.getCondition(), true);
Dan Gohman81313fd2008-09-14 17:21:12 +00001757 Out << ", ";
Gabor Greifcab008f2009-02-09 15:45:06 +00001758 writeOperand(BI.getSuccessor(0), true);
Dan Gohman81313fd2008-09-14 17:21:12 +00001759 Out << ", ";
Gabor Greifcab008f2009-02-09 15:45:06 +00001760 writeOperand(BI.getSuccessor(1), true);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001761
Chris Lattner8d48df22002-04-13 18:34:38 +00001762 } else if (isa<SwitchInst>(I)) {
Eli Friedman95031ed2011-09-29 20:21:17 +00001763 SwitchInst& SI(cast<SwitchInst>(I));
Chris Lattner3ed871f2009-10-27 19:13:16 +00001764 // Special case switch instruction to get formatting nice and correct.
Dan Gohman81313fd2008-09-14 17:21:12 +00001765 Out << ' ';
Eli Friedman95031ed2011-09-29 20:21:17 +00001766 writeOperand(SI.getCondition(), true);
Dan Gohman81313fd2008-09-14 17:21:12 +00001767 Out << ", ";
Eli Friedman95031ed2011-09-29 20:21:17 +00001768 writeOperand(SI.getDefaultDest(), true);
Chris Lattner82ff9232008-08-23 22:52:27 +00001769 Out << " [";
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +00001770 for (SwitchInst::CaseIt i = SI.case_begin(), e = SI.case_end();
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00001771 i != e; ++i) {
Dan Gohmanb4583b12009-08-13 01:41:52 +00001772 Out << "\n ";
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00001773 writeOperand(i.getCaseValue(), true);
Dan Gohman81313fd2008-09-14 17:21:12 +00001774 Out << ", ";
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00001775 writeOperand(i.getCaseSuccessor(), true);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001776 }
Dan Gohmanb4583b12009-08-13 01:41:52 +00001777 Out << "\n ]";
Chris Lattnerd04cb6d2009-10-28 00:19:10 +00001778 } else if (isa<IndirectBrInst>(I)) {
1779 // Special case indirectbr instruction to get formatting nice and correct.
Chris Lattner3ed871f2009-10-27 19:13:16 +00001780 Out << ' ';
1781 writeOperand(Operand, true);
Dan Gohman43c57402009-10-30 02:01:10 +00001782 Out << ", [";
Andrew Trickec4b6e72011-09-30 19:48:58 +00001783
Chris Lattner3ed871f2009-10-27 19:13:16 +00001784 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
1785 if (i != 1)
1786 Out << ", ";
1787 writeOperand(I.getOperand(i), true);
1788 }
1789 Out << ']';
Jay Foad372ad642011-06-20 14:18:48 +00001790 } else if (const PHINode *PN = dyn_cast<PHINode>(&I)) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001791 Out << ' ';
Chris Lattnere101c442009-02-28 21:26:53 +00001792 TypePrinter.print(I.getType(), Out);
Misha Brukmana6619a92004-06-21 21:53:56 +00001793 Out << ' ';
Chris Lattner2f7c9632001-06-06 20:29:01 +00001794
Jay Foad372ad642011-06-20 14:18:48 +00001795 for (unsigned op = 0, Eop = PN->getNumIncomingValues(); op < Eop; ++op) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001796 if (op) Out << ", ";
Dan Gohman81313fd2008-09-14 17:21:12 +00001797 Out << "[ ";
Jay Foad372ad642011-06-20 14:18:48 +00001798 writeOperand(PN->getIncomingValue(op), false); Out << ", ";
1799 writeOperand(PN->getIncomingBlock(op), false); Out << " ]";
Chris Lattner931ef3b2001-06-11 15:04:20 +00001800 }
Dan Gohmana76f0f72008-05-31 19:12:39 +00001801 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
Dan Gohman81313fd2008-09-14 17:21:12 +00001802 Out << ' ';
Dan Gohmana76f0f72008-05-31 19:12:39 +00001803 writeOperand(I.getOperand(0), true);
1804 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
1805 Out << ", " << *i;
1806 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
Dan Gohman81313fd2008-09-14 17:21:12 +00001807 Out << ' ';
1808 writeOperand(I.getOperand(0), true); Out << ", ";
Dan Gohmana76f0f72008-05-31 19:12:39 +00001809 writeOperand(I.getOperand(1), true);
1810 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
1811 Out << ", " << *i;
Bill Wendlingfae14752011-08-12 20:24:12 +00001812 } else if (const LandingPadInst *LPI = dyn_cast<LandingPadInst>(&I)) {
1813 Out << ' ';
1814 TypePrinter.print(I.getType(), Out);
1815 Out << " personality ";
1816 writeOperand(I.getOperand(0), true); Out << '\n';
1817
1818 if (LPI->isCleanup())
1819 Out << " cleanup";
1820
1821 for (unsigned i = 0, e = LPI->getNumClauses(); i != e; ++i) {
1822 if (i != 0 || LPI->isCleanup()) Out << "\n";
1823 if (LPI->isCatch(i))
1824 Out << " catch ";
1825 else
1826 Out << " filter ";
1827
1828 writeOperand(LPI->getClause(i), true);
1829 }
Devang Patel59643e52008-02-23 00:35:18 +00001830 } else if (isa<ReturnInst>(I) && !Operand) {
1831 Out << " void";
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001832 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
1833 // Print the calling convention being used.
1834 switch (CI->getCallingConv()) {
1835 case CallingConv::C: break; // default
Chris Lattner29d20852006-05-19 21:58:52 +00001836 case CallingConv::Fast: Out << " fastcc"; break;
1837 case CallingConv::Cold: Out << " coldcc"; break;
Chris Lattnerf5270372007-11-18 18:32:16 +00001838 case CallingConv::X86_StdCall: Out << " x86_stdcallcc"; break;
Anton Korobeynikova8fd40b2009-06-16 18:50:49 +00001839 case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
Anton Korobeynikov8f35fab2010-05-16 09:08:45 +00001840 case CallingConv::X86_ThisCall: Out << " x86_thiscallcc"; break;
Anton Korobeynikova8fd40b2009-06-16 18:50:49 +00001841 case CallingConv::ARM_APCS: Out << " arm_apcscc "; break;
1842 case CallingConv::ARM_AAPCS: Out << " arm_aapcscc "; break;
1843 case CallingConv::ARM_AAPCS_VFP:Out << " arm_aapcs_vfpcc "; break;
Anton Korobeynikov27a0ecf2009-12-07 02:27:35 +00001844 case CallingConv::MSP430_INTR: Out << " msp430_intrcc "; break;
Che-Liang Chiou29947902010-09-25 07:46:17 +00001845 case CallingConv::PTX_Kernel: Out << " ptx_kernel"; break;
1846 case CallingConv::PTX_Device: Out << " ptx_device"; break;
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001847 default: Out << " cc" << CI->getCallingConv(); break;
1848 }
1849
Gabor Greifc9a92512010-06-23 13:09:06 +00001850 Operand = CI->getCalledValue();
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001851 PointerType *PTy = cast<PointerType>(Operand->getType());
1852 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1853 Type *RetTy = FTy->getReturnType();
Devang Patel4c758ea2008-09-25 21:00:45 +00001854 const AttrListPtr &PAL = CI->getAttributes();
Chris Lattner2f2d9472001-11-06 21:28:12 +00001855
Devang Patel221fe422008-09-29 20:49:50 +00001856 if (PAL.getRetAttributes() != Attribute::None)
1857 Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1858
Chris Lattner463d6a52003-08-05 15:34:45 +00001859 // If possible, print out the short form of the call instruction. We can
Chris Lattner6915f8f2002-04-07 22:49:37 +00001860 // only do this if the first argument is a pointer to a nonvararg function,
Chris Lattner463d6a52003-08-05 15:34:45 +00001861 // and if the return type is not a pointer to a function.
Chris Lattner2f2d9472001-11-06 21:28:12 +00001862 //
Dan Gohman81313fd2008-09-14 17:21:12 +00001863 Out << ' ';
Chris Lattner463d6a52003-08-05 15:34:45 +00001864 if (!FTy->isVarArg() &&
Duncan Sands19d0b472010-02-16 11:11:14 +00001865 (!RetTy->isPointerTy() ||
1866 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
Chris Lattnere101c442009-02-28 21:26:53 +00001867 TypePrinter.print(RetTy, Out);
Dan Gohman81313fd2008-09-14 17:21:12 +00001868 Out << ' ';
Chris Lattner2f2d9472001-11-06 21:28:12 +00001869 writeOperand(Operand, false);
1870 } else {
1871 writeOperand(Operand, true);
1872 }
Misha Brukmana6619a92004-06-21 21:53:56 +00001873 Out << '(';
Gabor Greifc9a92512010-06-23 13:09:06 +00001874 for (unsigned op = 0, Eop = CI->getNumArgOperands(); op < Eop; ++op) {
1875 if (op > 0)
Dan Gohman81313fd2008-09-14 17:21:12 +00001876 Out << ", ";
Gabor Greifc9a92512010-06-23 13:09:06 +00001877 writeParamOperand(CI->getArgOperand(op), PAL.getParamAttributes(op + 1));
Chris Lattner2f7c9632001-06-06 20:29:01 +00001878 }
Dan Gohman81313fd2008-09-14 17:21:12 +00001879 Out << ')';
Devang Patela05633e2008-09-26 22:53:05 +00001880 if (PAL.getFnAttributes() != Attribute::None)
1881 Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
Chris Lattner113f4f42002-06-25 16:13:24 +00001882 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00001883 Operand = II->getCalledValue();
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001884 PointerType *PTy = cast<PointerType>(Operand->getType());
1885 FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1886 Type *RetTy = FTy->getReturnType();
Devang Patel4c758ea2008-09-25 21:00:45 +00001887 const AttrListPtr &PAL = II->getAttributes();
Chris Lattner463d6a52003-08-05 15:34:45 +00001888
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001889 // Print the calling convention being used.
1890 switch (II->getCallingConv()) {
1891 case CallingConv::C: break; // default
Chris Lattner29d20852006-05-19 21:58:52 +00001892 case CallingConv::Fast: Out << " fastcc"; break;
1893 case CallingConv::Cold: Out << " coldcc"; break;
Dan Gohman81313fd2008-09-14 17:21:12 +00001894 case CallingConv::X86_StdCall: Out << " x86_stdcallcc"; break;
1895 case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
Anton Korobeynikov8f35fab2010-05-16 09:08:45 +00001896 case CallingConv::X86_ThisCall: Out << " x86_thiscallcc"; break;
Anton Korobeynikova8fd40b2009-06-16 18:50:49 +00001897 case CallingConv::ARM_APCS: Out << " arm_apcscc "; break;
1898 case CallingConv::ARM_AAPCS: Out << " arm_aapcscc "; break;
1899 case CallingConv::ARM_AAPCS_VFP:Out << " arm_aapcs_vfpcc "; break;
Anton Korobeynikov27a0ecf2009-12-07 02:27:35 +00001900 case CallingConv::MSP430_INTR: Out << " msp430_intrcc "; break;
Che-Liang Chiou29947902010-09-25 07:46:17 +00001901 case CallingConv::PTX_Kernel: Out << " ptx_kernel"; break;
1902 case CallingConv::PTX_Device: Out << " ptx_device"; break;
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001903 default: Out << " cc" << II->getCallingConv(); break;
1904 }
1905
Devang Patel221fe422008-09-29 20:49:50 +00001906 if (PAL.getRetAttributes() != Attribute::None)
1907 Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1908
Chris Lattner463d6a52003-08-05 15:34:45 +00001909 // If possible, print out the short form of the invoke instruction. We can
1910 // only do this if the first argument is a pointer to a nonvararg function,
1911 // and if the return type is not a pointer to a function.
1912 //
Dan Gohmanc7e00ba2008-10-15 18:02:08 +00001913 Out << ' ';
Chris Lattner463d6a52003-08-05 15:34:45 +00001914 if (!FTy->isVarArg() &&
Duncan Sands19d0b472010-02-16 11:11:14 +00001915 (!RetTy->isPointerTy() ||
1916 !cast<PointerType>(RetTy)->getElementType()->isFunctionTy())) {
Chris Lattnere101c442009-02-28 21:26:53 +00001917 TypePrinter.print(RetTy, Out);
Dan Gohmanc7e00ba2008-10-15 18:02:08 +00001918 Out << ' ';
Chris Lattner463d6a52003-08-05 15:34:45 +00001919 writeOperand(Operand, false);
1920 } else {
1921 writeOperand(Operand, true);
1922 }
Misha Brukmana6619a92004-06-21 21:53:56 +00001923 Out << '(';
Gabor Greifc9a92512010-06-23 13:09:06 +00001924 for (unsigned op = 0, Eop = II->getNumArgOperands(); op < Eop; ++op) {
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00001925 if (op)
Dan Gohman81313fd2008-09-14 17:21:12 +00001926 Out << ", ";
Gabor Greifc9a92512010-06-23 13:09:06 +00001927 writeParamOperand(II->getArgOperand(op), PAL.getParamAttributes(op + 1));
Chris Lattner862e3382001-10-13 06:42:36 +00001928 }
1929
Dan Gohman81313fd2008-09-14 17:21:12 +00001930 Out << ')';
Devang Patela05633e2008-09-26 22:53:05 +00001931 if (PAL.getFnAttributes() != Attribute::None)
1932 Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
1933
Dan Gohmanb4583b12009-08-13 01:41:52 +00001934 Out << "\n to ";
Chris Lattner862e3382001-10-13 06:42:36 +00001935 writeOperand(II->getNormalDest(), true);
Dan Gohman81313fd2008-09-14 17:21:12 +00001936 Out << " unwind ";
Chris Lattnerfae8ab32004-02-08 21:44:31 +00001937 writeOperand(II->getUnwindDest(), true);
Chris Lattner862e3382001-10-13 06:42:36 +00001938
Victor Hernandez8acf2952009-10-23 21:09:37 +00001939 } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001940 Out << ' ';
Chris Lattnere101c442009-02-28 21:26:53 +00001941 TypePrinter.print(AI->getType()->getElementType(), Out);
Dan Gohmanb53e26c2009-07-31 18:23:24 +00001942 if (!AI->getArraySize() || AI->isArrayAllocation()) {
Dan Gohman81313fd2008-09-14 17:21:12 +00001943 Out << ", ";
Chris Lattner8d48df22002-04-13 18:34:38 +00001944 writeOperand(AI->getArraySize(), true);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001945 }
Nate Begeman848622f2005-11-05 09:21:28 +00001946 if (AI->getAlignment()) {
Chris Lattner7aeee3a2005-11-05 21:20:34 +00001947 Out << ", align " << AI->getAlignment();
Nate Begeman848622f2005-11-05 09:21:28 +00001948 }
Chris Lattner862e3382001-10-13 06:42:36 +00001949 } else if (isa<CastInst>(I)) {
Dan Gohman81313fd2008-09-14 17:21:12 +00001950 if (Operand) {
1951 Out << ' ';
1952 writeOperand(Operand, true); // Work with broken code
1953 }
Misha Brukmana6619a92004-06-21 21:53:56 +00001954 Out << " to ";
Chris Lattnere101c442009-02-28 21:26:53 +00001955 TypePrinter.print(I.getType(), Out);
Chris Lattner5b337482003-10-18 05:57:43 +00001956 } else if (isa<VAArgInst>(I)) {
Dan Gohman81313fd2008-09-14 17:21:12 +00001957 if (Operand) {
1958 Out << ' ';
1959 writeOperand(Operand, true); // Work with broken code
1960 }
Misha Brukmana6619a92004-06-21 21:53:56 +00001961 Out << ", ";
Chris Lattnere101c442009-02-28 21:26:53 +00001962 TypePrinter.print(I.getType(), Out);
1963 } else if (Operand) { // Print the normal way.
Chris Lattner2f7c9632001-06-06 20:29:01 +00001964
Misha Brukmanb1c93172005-04-21 23:48:37 +00001965 // PrintAllTypes - Instructions who have operands of all the same type
Chris Lattner2f7c9632001-06-06 20:29:01 +00001966 // omit the type from all but the first operand. If the instruction has
1967 // different type operands (for example br), then they are all printed.
1968 bool PrintAllTypes = false;
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00001969 Type *TheType = Operand->getType();
Chris Lattner2f7c9632001-06-06 20:29:01 +00001970
Reid Spencer0cdd04f2007-02-02 13:54:55 +00001971 // Select, Store and ShuffleVector always print all types.
Devang Patelce556d92008-03-04 22:05:14 +00001972 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
1973 || isa<ReturnInst>(I)) {
Chris Lattnerdeccfaf2003-04-16 20:20:02 +00001974 PrintAllTypes = true;
1975 } else {
1976 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
1977 Operand = I.getOperand(i);
Nuno Lopes04fe2f02009-01-15 18:40:57 +00001978 // note that Operand shouldn't be null, but the test helps make dump()
1979 // more tolerant of malformed IR
Nuno Lopes0971e772009-01-14 17:51:41 +00001980 if (Operand && Operand->getType() != TheType) {
Chris Lattnerdeccfaf2003-04-16 20:20:02 +00001981 PrintAllTypes = true; // We have differing types! Print them all!
1982 break;
1983 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001984 }
1985 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00001986
Chris Lattner7bfee412001-10-29 16:05:51 +00001987 if (!PrintAllTypes) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001988 Out << ' ';
Chris Lattnere101c442009-02-28 21:26:53 +00001989 TypePrinter.print(TheType, Out);
Chris Lattner7bfee412001-10-29 16:05:51 +00001990 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001991
Dan Gohman81313fd2008-09-14 17:21:12 +00001992 Out << ' ';
Chris Lattner113f4f42002-06-25 16:13:24 +00001993 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
Dan Gohman81313fd2008-09-14 17:21:12 +00001994 if (i) Out << ", ";
Chris Lattner113f4f42002-06-25 16:13:24 +00001995 writeOperand(I.getOperand(i), PrintAllTypes);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001996 }
1997 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001998
Eli Friedman59b66882011-08-09 23:02:53 +00001999 // Print atomic ordering/alignment for memory operations
2000 if (const LoadInst *LI = dyn_cast<LoadInst>(&I)) {
2001 if (LI->isAtomic())
2002 writeAtomic(LI->getOrdering(), LI->getSynchScope());
2003 if (LI->getAlignment())
2004 Out << ", align " << LI->getAlignment();
2005 } else if (const StoreInst *SI = dyn_cast<StoreInst>(&I)) {
2006 if (SI->isAtomic())
2007 writeAtomic(SI->getOrdering(), SI->getSynchScope());
2008 if (SI->getAlignment())
2009 Out << ", align " << SI->getAlignment();
Eli Friedmanc9a551e2011-07-28 21:48:00 +00002010 } else if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(&I)) {
2011 writeAtomic(CXI->getOrdering(), CXI->getSynchScope());
2012 } else if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(&I)) {
2013 writeAtomic(RMWI->getOrdering(), RMWI->getSynchScope());
Eli Friedmanfee02c62011-07-25 23:16:38 +00002014 } else if (const FenceInst *FI = dyn_cast<FenceInst>(&I)) {
2015 writeAtomic(FI->getOrdering(), FI->getSynchScope());
Christopher Lamb84485702007-04-22 19:24:39 +00002016 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00002017
Chris Lattnerc9558df2009-12-28 20:10:43 +00002018 // Print Metadata info.
Nick Lewyckyba8ec9a2010-02-25 06:53:04 +00002019 SmallVector<std::pair<unsigned, MDNode*>, 4> InstMD;
2020 I.getAllMetadata(InstMD);
Erick Tryzelaar72a37132010-03-02 05:32:52 +00002021 if (!InstMD.empty()) {
2022 SmallVector<StringRef, 8> MDNames;
2023 I.getType()->getContext().getMDKindNames(MDNames);
2024 for (unsigned i = 0, e = InstMD.size(); i != e; ++i) {
2025 unsigned Kind = InstMD[i].first;
2026 if (Kind < MDNames.size()) {
2027 Out << ", !" << MDNames[Kind];
2028 } else {
2029 Out << ", !<unknown kind #" << Kind << ">";
2030 }
Dan Gohmana2489d12010-07-20 23:55:01 +00002031 Out << ' ';
2032 WriteAsOperandInternal(Out, InstMD[i].second, &TypePrinter, &Machine,
2033 TheModule);
Nick Lewyckyba8ec9a2010-02-25 06:53:04 +00002034 }
Devang Patelbcdb0252009-10-07 16:37:55 +00002035 }
Chris Lattner862e3382001-10-13 06:42:36 +00002036 printInfoComment(I);
Chris Lattner2f7c9632001-06-06 20:29:01 +00002037}
2038
Chris Lattnerbddea6a2009-12-31 02:13:35 +00002039static void WriteMDNodeComment(const MDNode *Node,
Duncan Sands41b4a6b2010-07-12 08:16:59 +00002040 formatted_raw_ostream &Out) {
Chris Lattnerbddea6a2009-12-31 02:13:35 +00002041 if (Node->getNumOperands() < 1)
2042 return;
Bill Wendling5cb50c52012-06-28 00:41:44 +00002043
2044 Value *Op = Node->getOperand(0);
2045 if (!Op || !isa<ConstantInt>(Op) || cast<ConstantInt>(Op)->getBitWidth() < 32)
Chris Lattnerbddea6a2009-12-31 02:13:35 +00002046 return;
Andrew Trickec4b6e72011-09-30 19:48:58 +00002047
Bill Wendling5cb50c52012-06-28 00:41:44 +00002048 DIDescriptor Desc(Node);
2049 if (Desc.getVersion() < LLVMDebugVersion11)
2050 return;
2051
2052 unsigned Tag = Desc.getTag();
Chris Lattnerbddea6a2009-12-31 02:13:35 +00002053 Out.PadToColumn(50);
Bill Wendlinga0bc1082012-07-03 20:01:02 +00002054 if (dwarf::TagString(Tag)) {
2055 Out << "; ";
2056 Desc.print(Out);
2057 } else if (Tag == dwarf::DW_TAG_user_base) {
Chris Lattnerbddea6a2009-12-31 02:13:35 +00002058 Out << "; [ DW_TAG_user_base ]";
Bill Wendlinga0bc1082012-07-03 20:01:02 +00002059 }
Chris Lattnerbddea6a2009-12-31 02:13:35 +00002060}
2061
2062void AssemblyWriter::writeAllMDNodes() {
2063 SmallVector<const MDNode *, 16> Nodes;
Chris Lattnercf4a76e2009-12-31 02:20:11 +00002064 Nodes.resize(Machine.mdn_size());
2065 for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
2066 I != E; ++I)
Chris Lattnerbddea6a2009-12-31 02:13:35 +00002067 Nodes[I->second] = cast<MDNode>(I->first);
Andrew Trickec4b6e72011-09-30 19:48:58 +00002068
Chris Lattnerbddea6a2009-12-31 02:13:35 +00002069 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
2070 Out << '!' << i << " = metadata ";
Chris Lattner0d50bdd2009-12-31 02:27:30 +00002071 printMDNodeBody(Nodes[i]);
Chris Lattnerbddea6a2009-12-31 02:13:35 +00002072 }
2073}
2074
2075void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
Dan Gohmana2489d12010-07-20 23:55:01 +00002076 WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
Chris Lattnerbddea6a2009-12-31 02:13:35 +00002077 WriteMDNodeComment(Node, Out);
2078 Out << "\n";
2079}
Chris Lattner2f7c9632001-06-06 20:29:01 +00002080
2081//===----------------------------------------------------------------------===//
2082// External Interface declarations
2083//===----------------------------------------------------------------------===//
2084
Dan Gohmane2745262009-08-12 17:23:50 +00002085void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
Chris Lattnere36fd8a2008-08-19 04:26:57 +00002086 SlotTracker SlotTable(this);
Dan Gohmane2745262009-08-12 17:23:50 +00002087 formatted_raw_ostream OS(ROS);
Chris Lattner0c19df42008-08-23 22:23:09 +00002088 AssemblyWriter W(OS, SlotTable, this, AAW);
Chris Lattnerefb5e392009-12-31 02:23:35 +00002089 W.printModule(this);
Chris Lattner2f7c9632001-06-06 20:29:01 +00002090}
2091
Dan Gohman2637cc12010-07-21 23:38:33 +00002092void NamedMDNode::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
2093 SlotTracker SlotTable(getParent());
2094 formatted_raw_ostream OS(ROS);
2095 AssemblyWriter W(OS, SlotTable, getParent(), AAW);
2096 W.printNamedMDNode(this);
2097}
2098
Chris Lattner2ee62d22009-02-28 21:11:05 +00002099void Type::print(raw_ostream &OS) const {
2100 if (this == 0) {
2101 OS << "<null Type>";
2102 return;
2103 }
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00002104 TypePrinting TP;
2105 TP.print(const_cast<Type*>(this), OS);
Andrew Trickec4b6e72011-09-30 19:48:58 +00002106
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00002107 // If the type is a named struct type, print the body as well.
2108 if (StructType *STy = dyn_cast<StructType>(const_cast<Type*>(this)))
Chris Lattner01beceb2011-08-12 18:07:07 +00002109 if (!STy->isLiteral()) {
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00002110 OS << " = type ";
2111 TP.printStructBody(STy, OS);
2112 }
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +00002113}
2114
Dan Gohmane2745262009-08-12 17:23:50 +00002115void Value::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
Chris Lattner0c19df42008-08-23 22:23:09 +00002116 if (this == 0) {
Dan Gohman12dad632009-08-12 20:56:03 +00002117 ROS << "printing a <null> value\n";
Chris Lattner0c19df42008-08-23 22:23:09 +00002118 return;
2119 }
Dan Gohman12dad632009-08-12 20:56:03 +00002120 formatted_raw_ostream OS(ROS);
Chris Lattner0c19df42008-08-23 22:23:09 +00002121 if (const Instruction *I = dyn_cast<Instruction>(this)) {
2122 const Function *F = I->getParent() ? I->getParent()->getParent() : 0;
2123 SlotTracker SlotTable(F);
Chris Lattnerd5bace72009-12-31 08:23:09 +00002124 AssemblyWriter W(OS, SlotTable, getModuleFromVal(I), AAW);
Chris Lattnerefb5e392009-12-31 02:23:35 +00002125 W.printInstruction(*I);
Chris Lattner0c19df42008-08-23 22:23:09 +00002126 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
2127 SlotTracker SlotTable(BB->getParent());
Chris Lattnerbddea6a2009-12-31 02:13:35 +00002128 AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), AAW);
Chris Lattnerefb5e392009-12-31 02:23:35 +00002129 W.printBasicBlock(BB);
Chris Lattner0c19df42008-08-23 22:23:09 +00002130 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
2131 SlotTracker SlotTable(GV->getParent());
Dan Gohman6c7a4852009-04-20 16:10:33 +00002132 AssemblyWriter W(OS, SlotTable, GV->getParent(), AAW);
Chris Lattnerefb5e392009-12-31 02:23:35 +00002133 if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
2134 W.printGlobal(V);
2135 else if (const Function *F = dyn_cast<Function>(GV))
2136 W.printFunction(F);
2137 else
2138 W.printAlias(cast<GlobalAlias>(GV));
Devang Patel5546b982009-07-01 20:59:15 +00002139 } else if (const MDNode *N = dyn_cast<MDNode>(this)) {
Victor Hernandeze5f2af72010-01-20 04:45:57 +00002140 const Function *F = N->getFunction();
Victor Hernandez61e6e822010-01-14 01:47:37 +00002141 SlotTracker SlotTable(F);
Dan Gohman15132172010-07-14 21:12:44 +00002142 AssemblyWriter W(OS, SlotTable, F ? F->getParent() : 0, AAW);
Chris Lattnerbddea6a2009-12-31 02:13:35 +00002143 W.printMDNodeBody(N);
Chris Lattner0c19df42008-08-23 22:23:09 +00002144 } else if (const Constant *C = dyn_cast<Constant>(this)) {
Chris Lattner92c5c122009-02-28 23:20:19 +00002145 TypePrinting TypePrinter;
Chris Lattnere101c442009-02-28 21:26:53 +00002146 TypePrinter.print(C->getType(), OS);
Chris Lattner2ee62d22009-02-28 21:11:05 +00002147 OS << ' ';
Dan Gohmana2489d12010-07-20 23:55:01 +00002148 WriteConstantInternal(OS, C, TypePrinter, 0, 0);
Chris Lattner31fcc282009-12-31 01:41:14 +00002149 } else if (isa<InlineAsm>(this) || isa<MDString>(this) ||
2150 isa<Argument>(this)) {
Chris Lattner0c19df42008-08-23 22:23:09 +00002151 WriteAsOperand(OS, this, true, 0);
2152 } else {
Dan Gohmanc0353bf2009-09-23 01:33:16 +00002153 // Otherwise we don't know what it is. Call the virtual function to
2154 // allow a subclass to print itself.
2155 printCustom(OS);
Chris Lattner0c19df42008-08-23 22:23:09 +00002156 }
2157}
2158
Dan Gohmanc0353bf2009-09-23 01:33:16 +00002159// Value::printCustom - subclasses should override this to implement printing.
2160void Value::printCustom(raw_ostream &OS) const {
2161 llvm_unreachable("Unknown value to print out!");
2162}
2163
Chris Lattnerdab942552008-08-25 17:03:15 +00002164// Value::dump - allow easy printing of Values from the debugger.
David Greenec7f9b122010-01-05 01:29:26 +00002165void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
Reid Spencer52641832004-05-25 18:14:38 +00002166
Chris Lattnerdab942552008-08-25 17:03:15 +00002167// Type::dump - allow easy printing of Types from the debugger.
Chris Lattnerb1ed91f2011-07-09 17:41:24 +00002168void Type::dump() const { print(dbgs()); }
Chris Lattner24025262009-02-28 21:05:51 +00002169
Chris Lattnerdab942552008-08-25 17:03:15 +00002170// Module::dump() - Allow printing of Modules from the debugger.
David Greenec7f9b122010-01-05 01:29:26 +00002171void Module::dump() const { print(dbgs(), 0); }
Bill Wendling3681d112011-12-09 23:18:34 +00002172
2173// NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
2174void NamedMDNode::dump() const { print(dbgs(), 0); }