blob: d1a9d8ac6a5da8f151c991d627fa6ef060f9df4d [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 Lattner8339f7d2003-10-30 23:41:03 +000019#include "llvm/Assembly/AsmAnnotationWriter.h"
Chris Lattnerf7b6d312005-05-06 20:26:43 +000020#include "llvm/CallingConv.h"
Chris Lattnerc70b3f62004-01-20 19:50:34 +000021#include "llvm/Constants.h"
Chris Lattner913d18f2002-04-29 18:46:50 +000022#include "llvm/DerivedTypes.h"
Chris Lattner8bbcda22006-01-25 18:57:27 +000023#include "llvm/InlineAsm.h"
Chris Lattner2f2aa2b2009-12-28 23:41:32 +000024#include "llvm/IntrinsicInst.h"
Dan Gohman0ebd6962009-07-20 21:19:07 +000025#include "llvm/Operator.h"
Chris Lattnerc70b3f62004-01-20 19:50:34 +000026#include "llvm/Module.h"
Reid Spencer3aaaa0b2007-02-05 20:47:22 +000027#include "llvm/ValueSymbolTable.h"
Reid Spencer32af9e82007-01-06 07:24:44 +000028#include "llvm/TypeSymbolTable.h"
Chris Lattner3243ea12009-03-01 00:03:38 +000029#include "llvm/ADT/DenseSet.h"
Reid Spencer7c16caa2004-09-01 22:55:40 +000030#include "llvm/ADT/StringExtras.h"
31#include "llvm/ADT/STLExtras.h"
Bill Wendlingdfc91892006-11-28 02:09:03 +000032#include "llvm/Support/CFG.h"
Devang Patel711ab5b2009-09-30 20:16:54 +000033#include "llvm/Support/Dwarf.h"
Torok Edwin6dd27302009-07-08 18:01:40 +000034#include "llvm/Support/ErrorHandling.h"
Jim Laskeyb74c6662005-08-17 19:34:49 +000035#include "llvm/Support/MathExtras.h"
Dan Gohmane2745262009-08-12 17:23:50 +000036#include "llvm/Support/FormattedStream.h"
Chris Lattnerfee714f2001-09-07 16:36:04 +000037#include <algorithm>
Reid Spencerbdf03b42007-05-22 19:27:35 +000038#include <cctype>
Devang Patel39e64d42009-07-01 19:21:12 +000039#include <map>
Chris Lattner189d19f2003-11-21 20:23:48 +000040using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000041
Reid Spencer294715b2005-05-15 16:13:11 +000042// Make virtual table appear in this compilation unit.
43AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
44
Chris Lattner3eee99c2008-08-19 04:36:02 +000045//===----------------------------------------------------------------------===//
46// Helper Functions
47//===----------------------------------------------------------------------===//
48
49static const Module *getModuleFromVal(const Value *V) {
50 if (const Argument *MA = dyn_cast<Argument>(V))
51 return MA->getParent() ? MA->getParent()->getParent() : 0;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +000052
Chris Lattner3eee99c2008-08-19 04:36:02 +000053 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
54 return BB->getParent() ? BB->getParent()->getParent() : 0;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +000055
Chris Lattner3eee99c2008-08-19 04:36:02 +000056 if (const Instruction *I = dyn_cast<Instruction>(V)) {
57 const Function *M = I->getParent() ? I->getParent()->getParent() : 0;
58 return M ? M->getParent() : 0;
59 }
Chris Lattner31fcc282009-12-31 01:41:14 +000060
Chris Lattner3eee99c2008-08-19 04:36:02 +000061 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
62 return GV->getParent();
Chris Lattner31fcc282009-12-31 01:41:14 +000063 if (const NamedMDNode *NMD = dyn_cast<NamedMDNode>(V))
64 return NMD->getParent();
Chris Lattner3eee99c2008-08-19 04:36:02 +000065 return 0;
66}
67
Daniel Dunbardb0b70a2008-10-28 19:33:02 +000068// PrintEscapedString - Print each character of the specified string, escaping
69// it if it is not printable or if it is an escape char.
Dan Gohmane2745262009-08-12 17:23:50 +000070static void PrintEscapedString(const StringRef &Name,
Dan Gohman12dad632009-08-12 20:56:03 +000071 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.
Dan Gohman12dad632009-08-12 20:56:03 +000091static void PrintLLVMName(raw_ostream &OS, const StringRef &Name,
Daniel Dunbare03eecb2009-07-25 23:55:21 +000092 PrefixType Prefix) {
93 assert(Name.data() && "Cannot get empty name!");
Chris Lattner3eee99c2008-08-19 04:36:02 +000094 switch (Prefix) {
Torok Edwinfbcc6632009-07-14 16:55:14 +000095 default: llvm_unreachable("Bad prefix!");
Daniel Dunbar389529a2008-10-14 23:28:09 +000096 case NoPrefix: break;
Chris Lattner1508d3f2008-08-19 05:16:28 +000097 case GlobalPrefix: OS << '@'; break;
98 case LabelPrefix: break;
99 case LocalPrefix: OS << '%'; break;
Nick Lewycky063699a2009-03-19 06:31:22 +0000100 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000101
Chris Lattner3eee99c2008-08-19 04:36:02 +0000102 // Scan the name to see if it needs quotes first.
Daniel Dunbare03eecb2009-07-25 23:55:21 +0000103 bool NeedsQuotes = isdigit(Name[0]);
Chris Lattner3eee99c2008-08-19 04:36:02 +0000104 if (!NeedsQuotes) {
Daniel Dunbare03eecb2009-07-25 23:55:21 +0000105 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
106 char C = Name[i];
Chris Lattner3eee99c2008-08-19 04:36:02 +0000107 if (!isalnum(C) && C != '-' && C != '.' && C != '_') {
108 NeedsQuotes = true;
109 break;
110 }
111 }
112 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000113
Chris Lattner3eee99c2008-08-19 04:36:02 +0000114 // If we didn't need any quotes, just write out the name in one blast.
115 if (!NeedsQuotes) {
Daniel Dunbare03eecb2009-07-25 23:55:21 +0000116 OS << Name;
Chris Lattner3eee99c2008-08-19 04:36:02 +0000117 return;
118 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000119
Chris Lattner3eee99c2008-08-19 04:36:02 +0000120 // Okay, we need quotes. Output the quotes and escape any scary characters as
121 // needed.
122 OS << '"';
Daniel Dunbare03eecb2009-07-25 23:55:21 +0000123 PrintEscapedString(Name, OS);
Chris Lattner3eee99c2008-08-19 04:36:02 +0000124 OS << '"';
125}
126
127/// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
128/// prefixed with % (if the string only contains simple characters) or is
129/// surrounded with ""'s (if it has special chars in it). Print it out.
Dan Gohman12dad632009-08-12 20:56:03 +0000130static void PrintLLVMName(raw_ostream &OS, const Value *V) {
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000131 PrintLLVMName(OS, V->getName(),
Chris Lattner3eee99c2008-08-19 04:36:02 +0000132 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
133}
134
Chris Lattner0f578952009-02-28 20:25:14 +0000135//===----------------------------------------------------------------------===//
136// TypePrinting Class: Type printing machinery
137//===----------------------------------------------------------------------===//
138
Chris Lattner3339d7f2009-02-28 23:03:55 +0000139static DenseMap<const Type *, std::string> &getTypeNamesMap(void *M) {
140 return *static_cast<DenseMap<const Type *, std::string>*>(M);
Chris Lattner3ad46822009-02-28 22:34:45 +0000141}
142
143void TypePrinting::clear() {
144 getTypeNamesMap(TypeNames).clear();
145}
Chris Lattner0f578952009-02-28 20:25:14 +0000146
Chris Lattner92c5c122009-02-28 23:20:19 +0000147bool TypePrinting::hasTypeName(const Type *Ty) const {
148 return getTypeNamesMap(TypeNames).count(Ty);
149}
150
151void TypePrinting::addTypeName(const Type *Ty, const std::string &N) {
152 getTypeNamesMap(TypeNames).insert(std::make_pair(Ty, N));
153}
154
155
156TypePrinting::TypePrinting() {
Chris Lattner3339d7f2009-02-28 23:03:55 +0000157 TypeNames = new DenseMap<const Type *, std::string>();
Chris Lattner0f578952009-02-28 20:25:14 +0000158}
159
Chris Lattner3ad46822009-02-28 22:34:45 +0000160TypePrinting::~TypePrinting() {
161 delete &getTypeNamesMap(TypeNames);
162}
163
Chris Lattner40959d02009-02-28 20:49:40 +0000164/// CalcTypeName - Write the specified type to the specified raw_ostream, making
165/// use of type names or up references to shorten the type name where possible.
166void TypePrinting::CalcTypeName(const Type *Ty,
Chris Lattner765338d2009-02-28 20:34:19 +0000167 SmallVectorImpl<const Type *> &TypeStack,
Chris Lattner242d91a2009-03-01 01:16:21 +0000168 raw_ostream &OS, bool IgnoreTopLevelName) {
Chris Lattner0f578952009-02-28 20:25:14 +0000169 // Check to see if the type is named.
Chris Lattner242d91a2009-03-01 01:16:21 +0000170 if (!IgnoreTopLevelName) {
Nick Lewycky063699a2009-03-19 06:31:22 +0000171 DenseMap<const Type *, std::string> &TM = getTypeNamesMap(TypeNames);
Chris Lattner242d91a2009-03-01 01:16:21 +0000172 DenseMap<const Type *, std::string>::iterator I = TM.find(Ty);
173 if (I != TM.end()) {
174 OS << I->second;
175 return;
176 }
Chris Lattner0f578952009-02-28 20:25:14 +0000177 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000178
Chris Lattner0f578952009-02-28 20:25:14 +0000179 // Check to see if the Type is already on the stack...
180 unsigned Slot = 0, CurSize = TypeStack.size();
181 while (Slot < CurSize && TypeStack[Slot] != Ty) ++Slot; // Scan for type
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000182
Chris Lattner0f578952009-02-28 20:25:14 +0000183 // This is another base case for the recursion. In this case, we know
184 // that we have looped back to a type that we have previously visited.
185 // Generate the appropriate upreference to handle this.
186 if (Slot < CurSize) {
Chris Lattner06a23212009-02-28 21:27:31 +0000187 OS << '\\' << unsigned(CurSize-Slot); // Here's the upreference
Chris Lattner0f578952009-02-28 20:25:14 +0000188 return;
189 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000190
Chris Lattner0f578952009-02-28 20:25:14 +0000191 TypeStack.push_back(Ty); // Recursive case: Add us to the stack..
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000192
Chris Lattner0f578952009-02-28 20:25:14 +0000193 switch (Ty->getTypeID()) {
Chris Lattner06a23212009-02-28 21:27:31 +0000194 case Type::VoidTyID: OS << "void"; break;
195 case Type::FloatTyID: OS << "float"; break;
196 case Type::DoubleTyID: OS << "double"; break;
197 case Type::X86_FP80TyID: OS << "x86_fp80"; break;
198 case Type::FP128TyID: OS << "fp128"; break;
199 case Type::PPC_FP128TyID: OS << "ppc_fp128"; break;
200 case Type::LabelTyID: OS << "label"; break;
Nick Lewyckyadbc2842009-05-30 05:06:04 +0000201 case Type::MetadataTyID: OS << "metadata"; break;
Chris Lattner68318b12009-02-28 21:18:43 +0000202 case Type::IntegerTyID:
Chris Lattner06a23212009-02-28 21:27:31 +0000203 OS << 'i' << cast<IntegerType>(Ty)->getBitWidth();
Chris Lattner68318b12009-02-28 21:18:43 +0000204 break;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000205
Chris Lattner07d88292009-02-28 20:35:42 +0000206 case Type::FunctionTyID: {
207 const FunctionType *FTy = cast<FunctionType>(Ty);
Chris Lattner06a23212009-02-28 21:27:31 +0000208 CalcTypeName(FTy->getReturnType(), TypeStack, OS);
209 OS << " (";
Chris Lattner07d88292009-02-28 20:35:42 +0000210 for (FunctionType::param_iterator I = FTy->param_begin(),
211 E = FTy->param_end(); I != E; ++I) {
212 if (I != FTy->param_begin())
Chris Lattner06a23212009-02-28 21:27:31 +0000213 OS << ", ";
214 CalcTypeName(*I, TypeStack, OS);
Chris Lattner0f578952009-02-28 20:25:14 +0000215 }
Chris Lattner07d88292009-02-28 20:35:42 +0000216 if (FTy->isVarArg()) {
Chris Lattner06a23212009-02-28 21:27:31 +0000217 if (FTy->getNumParams()) OS << ", ";
218 OS << "...";
Chris Lattner0f578952009-02-28 20:25:14 +0000219 }
Chris Lattner06a23212009-02-28 21:27:31 +0000220 OS << ')';
Chris Lattner07d88292009-02-28 20:35:42 +0000221 break;
222 }
223 case Type::StructTyID: {
224 const StructType *STy = cast<StructType>(Ty);
225 if (STy->isPacked())
Chris Lattner06a23212009-02-28 21:27:31 +0000226 OS << '<';
227 OS << "{ ";
Chris Lattner07d88292009-02-28 20:35:42 +0000228 for (StructType::element_iterator I = STy->element_begin(),
229 E = STy->element_end(); I != E; ++I) {
Chris Lattner06a23212009-02-28 21:27:31 +0000230 CalcTypeName(*I, TypeStack, OS);
Chris Lattner07d88292009-02-28 20:35:42 +0000231 if (next(I) != STy->element_end())
Chris Lattner06a23212009-02-28 21:27:31 +0000232 OS << ',';
233 OS << ' ';
Chris Lattner0f578952009-02-28 20:25:14 +0000234 }
Chris Lattner06a23212009-02-28 21:27:31 +0000235 OS << '}';
Chris Lattner07d88292009-02-28 20:35:42 +0000236 if (STy->isPacked())
Chris Lattner06a23212009-02-28 21:27:31 +0000237 OS << '>';
Chris Lattner07d88292009-02-28 20:35:42 +0000238 break;
239 }
240 case Type::PointerTyID: {
241 const PointerType *PTy = cast<PointerType>(Ty);
Chris Lattner06a23212009-02-28 21:27:31 +0000242 CalcTypeName(PTy->getElementType(), TypeStack, OS);
Chris Lattner07d88292009-02-28 20:35:42 +0000243 if (unsigned AddressSpace = PTy->getAddressSpace())
Chris Lattner06a23212009-02-28 21:27:31 +0000244 OS << " addrspace(" << AddressSpace << ')';
245 OS << '*';
Chris Lattner07d88292009-02-28 20:35:42 +0000246 break;
247 }
248 case Type::ArrayTyID: {
249 const ArrayType *ATy = cast<ArrayType>(Ty);
Chris Lattner06a23212009-02-28 21:27:31 +0000250 OS << '[' << ATy->getNumElements() << " x ";
251 CalcTypeName(ATy->getElementType(), TypeStack, OS);
252 OS << ']';
Chris Lattner07d88292009-02-28 20:35:42 +0000253 break;
254 }
255 case Type::VectorTyID: {
256 const VectorType *PTy = cast<VectorType>(Ty);
Chris Lattner06a23212009-02-28 21:27:31 +0000257 OS << "<" << PTy->getNumElements() << " x ";
258 CalcTypeName(PTy->getElementType(), TypeStack, OS);
259 OS << '>';
Chris Lattner07d88292009-02-28 20:35:42 +0000260 break;
261 }
262 case Type::OpaqueTyID:
Chris Lattner06a23212009-02-28 21:27:31 +0000263 OS << "opaque";
Chris Lattner07d88292009-02-28 20:35:42 +0000264 break;
265 default:
Chris Lattner06a23212009-02-28 21:27:31 +0000266 OS << "<unrecognized-type>";
Chris Lattner07d88292009-02-28 20:35:42 +0000267 break;
Chris Lattner0f578952009-02-28 20:25:14 +0000268 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000269
Chris Lattner40959d02009-02-28 20:49:40 +0000270 TypeStack.pop_back(); // Remove self from stack.
Chris Lattner0f578952009-02-28 20:25:14 +0000271}
272
273/// printTypeInt - The internal guts of printing out a type that has a
274/// potentially named portion.
275///
Chris Lattner242d91a2009-03-01 01:16:21 +0000276void TypePrinting::print(const Type *Ty, raw_ostream &OS,
277 bool IgnoreTopLevelName) {
Chris Lattner0f578952009-02-28 20:25:14 +0000278 // Check to see if the type is named.
Chris Lattner3339d7f2009-02-28 23:03:55 +0000279 DenseMap<const Type*, std::string> &TM = getTypeNamesMap(TypeNames);
Chris Lattner242d91a2009-03-01 01:16:21 +0000280 if (!IgnoreTopLevelName) {
281 DenseMap<const Type*, std::string>::iterator I = TM.find(Ty);
282 if (I != TM.end()) {
283 OS << I->second;
284 return;
285 }
Chris Lattner0f578952009-02-28 20:25:14 +0000286 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000287
Chris Lattner0f578952009-02-28 20:25:14 +0000288 // Otherwise we have a type that has not been named but is a derived type.
289 // Carefully recurse the type hierarchy to print out any contained symbolic
290 // names.
Chris Lattner765338d2009-02-28 20:34:19 +0000291 SmallVector<const Type *, 16> TypeStack;
Chris Lattner0f578952009-02-28 20:25:14 +0000292 std::string TypeName;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000293
Chris Lattner40959d02009-02-28 20:49:40 +0000294 raw_string_ostream TypeOS(TypeName);
Chris Lattner242d91a2009-03-01 01:16:21 +0000295 CalcTypeName(Ty, TypeStack, TypeOS, IgnoreTopLevelName);
Chris Lattner40959d02009-02-28 20:49:40 +0000296 OS << TypeOS.str();
297
298 // Cache type name for later use.
Chris Lattner242d91a2009-03-01 01:16:21 +0000299 if (!IgnoreTopLevelName)
300 TM.insert(std::make_pair(Ty, TypeOS.str()));
Chris Lattner0f578952009-02-28 20:25:14 +0000301}
302
Chris Lattner3243ea12009-03-01 00:03:38 +0000303namespace {
304 class TypeFinder {
305 // To avoid walking constant expressions multiple times and other IR
306 // objects, we keep several helper maps.
307 DenseSet<const Value*> VisitedConstants;
308 DenseSet<const Type*> VisitedTypes;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000309
Chris Lattner3243ea12009-03-01 00:03:38 +0000310 TypePrinting &TP;
311 std::vector<const Type*> &NumberedTypes;
312 public:
313 TypeFinder(TypePrinting &tp, std::vector<const Type*> &numberedTypes)
314 : TP(tp), NumberedTypes(numberedTypes) {}
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000315
Chris Lattner3243ea12009-03-01 00:03:38 +0000316 void Run(const Module &M) {
Chris Lattner84516482009-03-01 00:32:33 +0000317 // Get types from the type symbol table. This gets opaque types referened
318 // only through derived named types.
319 const TypeSymbolTable &ST = M.getTypeSymbolTable();
320 for (TypeSymbolTable::const_iterator TI = ST.begin(), E = ST.end();
321 TI != E; ++TI)
322 IncorporateType(TI->second);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000323
Chris Lattner3243ea12009-03-01 00:03:38 +0000324 // Get types from global variables.
325 for (Module::const_global_iterator I = M.global_begin(),
326 E = M.global_end(); I != E; ++I) {
327 IncorporateType(I->getType());
328 if (I->hasInitializer())
329 IncorporateValue(I->getInitializer());
330 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000331
Chris Lattner3243ea12009-03-01 00:03:38 +0000332 // Get types from aliases.
333 for (Module::const_alias_iterator I = M.alias_begin(),
334 E = M.alias_end(); I != E; ++I) {
335 IncorporateType(I->getType());
336 IncorporateValue(I->getAliasee());
337 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000338
Chris Lattner3243ea12009-03-01 00:03:38 +0000339 // Get types from functions.
340 for (Module::const_iterator FI = M.begin(), E = M.end(); FI != E; ++FI) {
341 IncorporateType(FI->getType());
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000342
Chris Lattner3243ea12009-03-01 00:03:38 +0000343 for (Function::const_iterator BB = FI->begin(), E = FI->end();
344 BB != E;++BB)
345 for (BasicBlock::const_iterator II = BB->begin(),
346 E = BB->end(); II != E; ++II) {
347 const Instruction &I = *II;
348 // Incorporate the type of the instruction and all its operands.
349 IncorporateType(I.getType());
350 for (User::const_op_iterator OI = I.op_begin(), OE = I.op_end();
351 OI != OE; ++OI)
352 IncorporateValue(*OI);
353 }
354 }
355 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000356
Chris Lattner3243ea12009-03-01 00:03:38 +0000357 private:
358 void IncorporateType(const Type *Ty) {
359 // Check to see if we're already visited this type.
Chris Lattner84516482009-03-01 00:32:33 +0000360 if (!VisitedTypes.insert(Ty).second)
Chris Lattner3243ea12009-03-01 00:03:38 +0000361 return;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000362
Chris Lattner3243ea12009-03-01 00:03:38 +0000363 // If this is a structure or opaque type, add a name for the type.
Nick Lewycky49f89192009-04-04 07:22:01 +0000364 if (((isa<StructType>(Ty) && cast<StructType>(Ty)->getNumElements())
365 || isa<OpaqueType>(Ty)) && !TP.hasTypeName(Ty)) {
Chris Lattner3243ea12009-03-01 00:03:38 +0000366 TP.addTypeName(Ty, "%"+utostr(unsigned(NumberedTypes.size())));
367 NumberedTypes.push_back(Ty);
368 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000369
Chris Lattner3243ea12009-03-01 00:03:38 +0000370 // Recursively walk all contained types.
371 for (Type::subtype_iterator I = Ty->subtype_begin(),
372 E = Ty->subtype_end(); I != E; ++I)
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000373 IncorporateType(*I);
Chris Lattner3243ea12009-03-01 00:03:38 +0000374 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000375
Chris Lattner3243ea12009-03-01 00:03:38 +0000376 /// IncorporateValue - This method is used to walk operand lists finding
377 /// types hiding in constant expressions and other operands that won't be
378 /// walked in other ways. GlobalValues, basic blocks, instructions, and
379 /// inst operands are all explicitly enumerated.
380 void IncorporateValue(const Value *V) {
381 if (V == 0 || !isa<Constant>(V) || isa<GlobalValue>(V)) return;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000382
Chris Lattner3243ea12009-03-01 00:03:38 +0000383 // Already visited?
384 if (!VisitedConstants.insert(V).second)
385 return;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000386
Chris Lattner3243ea12009-03-01 00:03:38 +0000387 // Check this type.
388 IncorporateType(V->getType());
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000389
Chris Lattner3243ea12009-03-01 00:03:38 +0000390 // Look in operands for types.
391 const Constant *C = cast<Constant>(V);
392 for (Constant::const_op_iterator I = C->op_begin(),
393 E = C->op_end(); I != E;++I)
394 IncorporateValue(*I);
395 }
396 };
397} // end anonymous namespace
398
399
400/// AddModuleTypesToPrinter - Add all of the symbolic type names for types in
401/// the specified module to the TypePrinter and all numbered types to it and the
402/// NumberedTypes table.
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000403static void AddModuleTypesToPrinter(TypePrinting &TP,
Chris Lattner3243ea12009-03-01 00:03:38 +0000404 std::vector<const Type*> &NumberedTypes,
405 const Module *M) {
Chris Lattner92c5c122009-02-28 23:20:19 +0000406 if (M == 0) return;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000407
Chris Lattner92c5c122009-02-28 23:20:19 +0000408 // If the module has a symbol table, take all global types and stuff their
409 // names into the TypeNames map.
410 const TypeSymbolTable &ST = M->getTypeSymbolTable();
411 for (TypeSymbolTable::const_iterator TI = ST.begin(), E = ST.end();
412 TI != E; ++TI) {
413 const Type *Ty = cast<Type>(TI->second);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000414
Chris Lattner92c5c122009-02-28 23:20:19 +0000415 // As a heuristic, don't insert pointer to primitive types, because
416 // they are used too often to have a single useful name.
417 if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
418 const Type *PETy = PTy->getElementType();
419 if ((PETy->isPrimitiveType() || PETy->isInteger()) &&
420 !isa<OpaqueType>(PETy))
421 continue;
422 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000423
Chris Lattner92c5c122009-02-28 23:20:19 +0000424 // Likewise don't insert primitives either.
425 if (Ty->isInteger() || Ty->isPrimitiveType())
426 continue;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000427
Chris Lattner92c5c122009-02-28 23:20:19 +0000428 // Get the name as a string and insert it into TypeNames.
429 std::string NameStr;
Dan Gohmane2745262009-08-12 17:23:50 +0000430 raw_string_ostream NameROS(NameStr);
431 formatted_raw_ostream NameOS(NameROS);
Daniel Dunbare03eecb2009-07-25 23:55:21 +0000432 PrintLLVMName(NameOS, TI->first, LocalPrefix);
Dan Gohmane2745262009-08-12 17:23:50 +0000433 NameOS.flush();
434 TP.addTypeName(Ty, NameStr);
Chris Lattner92c5c122009-02-28 23:20:19 +0000435 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000436
Chris Lattner3243ea12009-03-01 00:03:38 +0000437 // Walk the entire module to find references to unnamed structure and opaque
438 // types. This is required for correctness by opaque types (because multiple
439 // uses of an unnamed opaque type needs to be referred to by the same ID) and
440 // it shrinks complex recursive structure types substantially in some cases.
441 TypeFinder(TP, NumberedTypes).Run(*M);
Chris Lattner92c5c122009-02-28 23:20:19 +0000442}
443
Chris Lattner0f578952009-02-28 20:25:14 +0000444
Chris Lattner0f578952009-02-28 20:25:14 +0000445/// WriteTypeSymbolic - This attempts to write the specified type as a symbolic
446/// type, iff there is an entry in the modules symbol table for the specified
Chris Lattner24025262009-02-28 21:05:51 +0000447/// type or one of it's component types.
Chris Lattner0f578952009-02-28 20:25:14 +0000448///
Chris Lattner92c5c122009-02-28 23:20:19 +0000449void llvm::WriteTypeSymbolic(raw_ostream &OS, const Type *Ty, const Module *M) {
450 TypePrinting Printer;
Chris Lattner3243ea12009-03-01 00:03:38 +0000451 std::vector<const Type*> NumberedTypes;
452 AddModuleTypesToPrinter(Printer, NumberedTypes, M);
Chris Lattner92c5c122009-02-28 23:20:19 +0000453 Printer.print(Ty, OS);
Chris Lattner0f578952009-02-28 20:25:14 +0000454}
455
Chris Lattner3eee99c2008-08-19 04:36:02 +0000456//===----------------------------------------------------------------------===//
457// SlotTracker Class: Enumerate slot numbers for unnamed values
458//===----------------------------------------------------------------------===//
459
Chris Lattner3ee58762008-08-19 04:28:07 +0000460namespace {
461
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000462/// This class provides computation of slot numbers for LLVM Assembly writing.
Chris Lattner393b7cd2008-08-17 04:17:45 +0000463///
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000464class SlotTracker {
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000465public:
Devang Patel983c6b12009-07-08 21:44:25 +0000466 /// ValueMap - A mapping of Values to slot numbers.
Chris Lattnera204d412008-08-17 17:25:25 +0000467 typedef DenseMap<const Value*, unsigned> ValueMap;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000468
469private:
Devang Patel983c6b12009-07-08 21:44:25 +0000470 /// TheModule - The module for which we are holding slot numbers.
Chris Lattner393b7cd2008-08-17 04:17:45 +0000471 const Module* TheModule;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000472
Devang Patel983c6b12009-07-08 21:44:25 +0000473 /// TheFunction - The function for which we are holding slot numbers.
Chris Lattner393b7cd2008-08-17 04:17:45 +0000474 const Function* TheFunction;
475 bool FunctionProcessed;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000476
Devang Patel983c6b12009-07-08 21:44:25 +0000477 /// mMap - The TypePlanes map for the module level data.
Chris Lattner393b7cd2008-08-17 04:17:45 +0000478 ValueMap mMap;
479 unsigned mNext;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000480
Devang Patel983c6b12009-07-08 21:44:25 +0000481 /// fMap - The TypePlanes map for the function level data.
Chris Lattner393b7cd2008-08-17 04:17:45 +0000482 ValueMap fMap;
483 unsigned fNext;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000484
Devang Patel983c6b12009-07-08 21:44:25 +0000485 /// mdnMap - Map for MDNodes.
Chris Lattnercf4a76e2009-12-31 02:20:11 +0000486 DenseMap<const MDNode*, unsigned> mdnMap;
Devang Patel983c6b12009-07-08 21:44:25 +0000487 unsigned mdnNext;
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000488public:
Chris Lattner393b7cd2008-08-17 04:17:45 +0000489 /// Construct from a module
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000490 explicit SlotTracker(const Module *M);
Chris Lattner393b7cd2008-08-17 04:17:45 +0000491 /// Construct from a function, starting out in incorp state.
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000492 explicit SlotTracker(const Function *F);
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000493
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000494 /// Return the slot number of the specified value in it's type
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000495 /// plane. If something is not in the SlotTracker, return -1.
Chris Lattner5e043322007-01-11 03:54:27 +0000496 int getLocalSlot(const Value *V);
497 int getGlobalSlot(const GlobalValue *V);
Devang Patel983c6b12009-07-08 21:44:25 +0000498 int getMetadataSlot(const MDNode *N);
Reid Spencer8beac692004-06-09 15:26:53 +0000499
Misha Brukmanb1c93172005-04-21 23:48:37 +0000500 /// If you'd like to deal with a function instead of just a module, use
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000501 /// this method to get its data into the SlotTracker.
Misha Brukmanb1c93172005-04-21 23:48:37 +0000502 void incorporateFunction(const Function *F) {
503 TheFunction = F;
Reid Spencerb0ac8c42004-08-16 07:46:33 +0000504 FunctionProcessed = false;
505 }
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000506
Misha Brukmanb1c93172005-04-21 23:48:37 +0000507 /// After calling incorporateFunction, use this method to remove the
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000508 /// most recently incorporated function from the SlotTracker. This
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000509 /// will reset the state of the machine back to just the module contents.
510 void purgeFunction();
511
Devang Patel983c6b12009-07-08 21:44:25 +0000512 /// MDNode map iterators.
Chris Lattnercf4a76e2009-12-31 02:20:11 +0000513 typedef DenseMap<const MDNode*, unsigned>::iterator mdn_iterator;
514 mdn_iterator mdn_begin() { return mdnMap.begin(); }
515 mdn_iterator mdn_end() { return mdnMap.end(); }
516 unsigned mdn_size() const { return mdnMap.size(); }
517 bool mdn_empty() const { return mdnMap.empty(); }
Devang Patel983c6b12009-07-08 21:44:25 +0000518
Reid Spencer56010e42004-05-26 21:56:09 +0000519 /// This function does the actual initialization.
520 inline void initialize();
521
Devang Patel983c6b12009-07-08 21:44:25 +0000522 // Implementation Details
523private:
Chris Lattnerea862a32007-01-09 07:55:49 +0000524 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
525 void CreateModuleSlot(const GlobalValue *V);
Devang Patel983c6b12009-07-08 21:44:25 +0000526
527 /// CreateMetadataSlot - Insert the specified MDNode* into the slot table.
528 void CreateMetadataSlot(const MDNode *N);
529
Chris Lattnerea862a32007-01-09 07:55:49 +0000530 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
531 void CreateFunctionSlot(const Value *V);
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000532
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000533 /// Add all of the module level global variables (and their initializers)
534 /// and function declarations, but not the contents of those functions.
535 void processModule();
536
Devang Patel983c6b12009-07-08 21:44:25 +0000537 /// Add all of the functions arguments, basic blocks, and instructions.
Reid Spencer56010e42004-05-26 21:56:09 +0000538 void processFunction();
539
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000540 SlotTracker(const SlotTracker &); // DO NOT IMPLEMENT
541 void operator=(const SlotTracker &); // DO NOT IMPLEMENT
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000542};
543
Chris Lattner3ee58762008-08-19 04:28:07 +0000544} // end anonymous namespace
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000545
Chris Lattner3eee99c2008-08-19 04:36:02 +0000546
547static SlotTracker *createSlotTracker(const Value *V) {
548 if (const Argument *FA = dyn_cast<Argument>(V))
549 return new SlotTracker(FA->getParent());
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000550
Chris Lattner3eee99c2008-08-19 04:36:02 +0000551 if (const Instruction *I = dyn_cast<Instruction>(V))
552 return new SlotTracker(I->getParent()->getParent());
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000553
Chris Lattner3eee99c2008-08-19 04:36:02 +0000554 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
555 return new SlotTracker(BB->getParent());
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000556
Chris Lattner3eee99c2008-08-19 04:36:02 +0000557 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
558 return new SlotTracker(GV->getParent());
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000559
Chris Lattner3eee99c2008-08-19 04:36:02 +0000560 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000561 return new SlotTracker(GA->getParent());
562
Chris Lattner3eee99c2008-08-19 04:36:02 +0000563 if (const Function *Func = dyn_cast<Function>(V))
564 return new SlotTracker(Func);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000565
Chris Lattner3eee99c2008-08-19 04:36:02 +0000566 return 0;
567}
568
569#if 0
Dan Gohman1ddf98a2009-07-25 01:43:01 +0000570#define ST_DEBUG(X) errs() << X
Chris Lattner3eee99c2008-08-19 04:36:02 +0000571#else
Chris Lattner604e3512008-08-19 04:47:09 +0000572#define ST_DEBUG(X)
Chris Lattner3eee99c2008-08-19 04:36:02 +0000573#endif
574
575// Module level constructor. Causes the contents of the Module (sans functions)
576// to be added to the slot table.
577SlotTracker::SlotTracker(const Module *M)
Chris Lattnerbddea6a2009-12-31 02:13:35 +0000578 : TheModule(M), TheFunction(0), FunctionProcessed(false),
Chris Lattnerbe2de792009-12-31 01:36:50 +0000579 mNext(0), fNext(0), mdnNext(0) {
Chris Lattner3eee99c2008-08-19 04:36:02 +0000580}
581
582// Function level constructor. Causes the contents of the Module and the one
583// function provided to be added to the slot table.
584SlotTracker::SlotTracker(const Function *F)
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000585 : TheModule(F ? F->getParent() : 0), TheFunction(F), FunctionProcessed(false),
Chris Lattnerbddea6a2009-12-31 02:13:35 +0000586 mNext(0), fNext(0), mdnNext(0) {
Chris Lattner3eee99c2008-08-19 04:36:02 +0000587}
588
589inline void SlotTracker::initialize() {
590 if (TheModule) {
591 processModule();
592 TheModule = 0; ///< Prevent re-processing next time we're called.
593 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000594
Chris Lattner3eee99c2008-08-19 04:36:02 +0000595 if (TheFunction && !FunctionProcessed)
596 processFunction();
597}
598
599// Iterate through all the global variables, functions, and global
600// variable initializers and create slots for them.
601void SlotTracker::processModule() {
Chris Lattner604e3512008-08-19 04:47:09 +0000602 ST_DEBUG("begin processModule!\n");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000603
Chris Lattner3eee99c2008-08-19 04:36:02 +0000604 // Add all of the unnamed global variables to the value table.
605 for (Module::const_global_iterator I = TheModule->global_begin(),
Devang Patel983c6b12009-07-08 21:44:25 +0000606 E = TheModule->global_end(); I != E; ++I) {
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000607 if (!I->hasName())
Chris Lattner3eee99c2008-08-19 04:36:02 +0000608 CreateModuleSlot(I);
Devang Patel983c6b12009-07-08 21:44:25 +0000609 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000610
Devang Patel23e68302009-07-29 22:04:47 +0000611 // Add metadata used by named metadata.
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000612 for (Module::const_named_metadata_iterator
Devang Patel23e68302009-07-29 22:04:47 +0000613 I = TheModule->named_metadata_begin(),
614 E = TheModule->named_metadata_end(); I != E; ++I) {
615 const NamedMDNode *NMD = I;
Chris Lattner9b493022009-12-31 01:22:29 +0000616 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
Chris Lattner2c48c642009-12-31 01:54:05 +0000617 // FIXME: Change accessor to be type safe.
618 if (MDNode *MD = cast_or_null<MDNode>(NMD->getOperand(i)))
Devang Patel847fcac2009-07-30 01:02:04 +0000619 CreateMetadataSlot(MD);
Devang Patel23e68302009-07-29 22:04:47 +0000620 }
621 }
622
Chris Lattner3eee99c2008-08-19 04:36:02 +0000623 // Add all the unnamed functions to the table.
624 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
625 I != E; ++I)
626 if (!I->hasName())
627 CreateModuleSlot(I);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000628
Chris Lattner604e3512008-08-19 04:47:09 +0000629 ST_DEBUG("end processModule!\n");
Chris Lattner3eee99c2008-08-19 04:36:02 +0000630}
631
Chris Lattner3eee99c2008-08-19 04:36:02 +0000632// Process the arguments, basic blocks, and instructions of a function.
633void SlotTracker::processFunction() {
Chris Lattner604e3512008-08-19 04:47:09 +0000634 ST_DEBUG("begin processFunction!\n");
Chris Lattner3eee99c2008-08-19 04:36:02 +0000635 fNext = 0;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000636
Chris Lattner3eee99c2008-08-19 04:36:02 +0000637 // Add all the function arguments with no names.
638 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
639 AE = TheFunction->arg_end(); AI != AE; ++AI)
640 if (!AI->hasName())
641 CreateFunctionSlot(AI);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000642
Chris Lattner604e3512008-08-19 04:47:09 +0000643 ST_DEBUG("Inserting Instructions:\n");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000644
Chris Lattnerbddea6a2009-12-31 02:13:35 +0000645 SmallVector<std::pair<unsigned, MDNode*>, 4> MDForInst;
Devang Pateldec23fd2009-09-16 20:21:17 +0000646
Chris Lattner3eee99c2008-08-19 04:36:02 +0000647 // Add all of the basic blocks and instructions with no names.
648 for (Function::const_iterator BB = TheFunction->begin(),
649 E = TheFunction->end(); BB != E; ++BB) {
650 if (!BB->hasName())
651 CreateFunctionSlot(BB);
Chris Lattner2f2aa2b2009-12-28 23:41:32 +0000652
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000653 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E;
Devang Patel983c6b12009-07-08 21:44:25 +0000654 ++I) {
Chris Lattner2f2aa2b2009-12-28 23:41:32 +0000655 if (!I->getType()->isVoidTy() && !I->hasName())
Chris Lattner3eee99c2008-08-19 04:36:02 +0000656 CreateFunctionSlot(I);
Chris Lattner2f2aa2b2009-12-28 23:41:32 +0000657
658 // Intrinsics can directly use metadata.
659 if (isa<IntrinsicInst>(I))
660 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
661 if (MDNode *N = dyn_cast_or_null<MDNode>(I->getOperand(i)))
662 CreateMetadataSlot(N);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000663
Devang Pateldec23fd2009-09-16 20:21:17 +0000664 // Process metadata attached with this instruction.
Chris Lattner2f2aa2b2009-12-28 23:41:32 +0000665 I->getAllMetadata(MDForInst);
666 for (unsigned i = 0, e = MDForInst.size(); i != e; ++i)
667 CreateMetadataSlot(MDForInst[i].second);
Chris Lattnerbddea6a2009-12-31 02:13:35 +0000668 MDForInst.clear();
Devang Patel983c6b12009-07-08 21:44:25 +0000669 }
Chris Lattner3eee99c2008-08-19 04:36:02 +0000670 }
Devang Pateldec23fd2009-09-16 20:21:17 +0000671
Chris Lattner3eee99c2008-08-19 04:36:02 +0000672 FunctionProcessed = true;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000673
Chris Lattner604e3512008-08-19 04:47:09 +0000674 ST_DEBUG("end processFunction!\n");
Chris Lattner3eee99c2008-08-19 04:36:02 +0000675}
676
677/// Clean up after incorporating a function. This is the only way to get out of
678/// the function incorporation state that affects get*Slot/Create*Slot. Function
679/// incorporation state is indicated by TheFunction != 0.
680void SlotTracker::purgeFunction() {
Chris Lattner604e3512008-08-19 04:47:09 +0000681 ST_DEBUG("begin purgeFunction!\n");
Chris Lattner3eee99c2008-08-19 04:36:02 +0000682 fMap.clear(); // Simply discard the function level map
683 TheFunction = 0;
684 FunctionProcessed = false;
Chris Lattner604e3512008-08-19 04:47:09 +0000685 ST_DEBUG("end purgeFunction!\n");
Chris Lattner3eee99c2008-08-19 04:36:02 +0000686}
687
688/// getGlobalSlot - Get the slot number of a global value.
689int SlotTracker::getGlobalSlot(const GlobalValue *V) {
690 // Check for uninitialized state and do lazy initialization.
691 initialize();
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000692
Chris Lattner3eee99c2008-08-19 04:36:02 +0000693 // Find the type plane in the module map
694 ValueMap::iterator MI = mMap.find(V);
Dan Gohman1dd27572008-10-01 19:58:59 +0000695 return MI == mMap.end() ? -1 : (int)MI->second;
Chris Lattner3eee99c2008-08-19 04:36:02 +0000696}
697
Chris Lattnercf4a76e2009-12-31 02:20:11 +0000698/// getMetadataSlot - Get the slot number of a MDNode.
Devang Patel983c6b12009-07-08 21:44:25 +0000699int SlotTracker::getMetadataSlot(const MDNode *N) {
700 // Check for uninitialized state and do lazy initialization.
701 initialize();
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000702
Devang Patel983c6b12009-07-08 21:44:25 +0000703 // Find the type plane in the module map
Chris Lattnercf4a76e2009-12-31 02:20:11 +0000704 mdn_iterator MI = mdnMap.find(N);
Devang Patel983c6b12009-07-08 21:44:25 +0000705 return MI == mdnMap.end() ? -1 : (int)MI->second;
706}
707
Chris Lattner3eee99c2008-08-19 04:36:02 +0000708
709/// getLocalSlot - Get the slot number for a value that is local to a function.
710int SlotTracker::getLocalSlot(const Value *V) {
711 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000712
Chris Lattner3eee99c2008-08-19 04:36:02 +0000713 // Check for uninitialized state and do lazy initialization.
714 initialize();
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000715
Chris Lattner3eee99c2008-08-19 04:36:02 +0000716 ValueMap::iterator FI = fMap.find(V);
Dan Gohman1dd27572008-10-01 19:58:59 +0000717 return FI == fMap.end() ? -1 : (int)FI->second;
Chris Lattner3eee99c2008-08-19 04:36:02 +0000718}
719
720
721/// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
722void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
723 assert(V && "Can't insert a null Value into SlotTracker!");
Chris Lattner031560c2009-12-29 07:25:48 +0000724 assert(!V->getType()->isVoidTy() && "Doesn't need a slot!");
Chris Lattner3eee99c2008-08-19 04:36:02 +0000725 assert(!V->hasName() && "Doesn't need a slot!");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000726
Chris Lattner3eee99c2008-08-19 04:36:02 +0000727 unsigned DestSlot = mNext++;
728 mMap[V] = DestSlot;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000729
Chris Lattner604e3512008-08-19 04:47:09 +0000730 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
Chris Lattner3eee99c2008-08-19 04:36:02 +0000731 DestSlot << " [");
732 // G = Global, F = Function, A = Alias, o = other
Chris Lattner604e3512008-08-19 04:47:09 +0000733 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
Chris Lattner3eee99c2008-08-19 04:36:02 +0000734 (isa<Function>(V) ? 'F' :
735 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
736}
737
Chris Lattner3eee99c2008-08-19 04:36:02 +0000738/// CreateSlot - Create a new slot for the specified value if it has no name.
739void SlotTracker::CreateFunctionSlot(const Value *V) {
Chris Lattner031560c2009-12-29 07:25:48 +0000740 assert(!V->getType()->isVoidTy() && !V->hasName() && "Doesn't need a slot!");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000741
Chris Lattner3eee99c2008-08-19 04:36:02 +0000742 unsigned DestSlot = fNext++;
743 fMap[V] = DestSlot;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000744
Chris Lattner3eee99c2008-08-19 04:36:02 +0000745 // G = Global, F = Function, o = other
Chris Lattner604e3512008-08-19 04:47:09 +0000746 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
Chris Lattner3eee99c2008-08-19 04:36:02 +0000747 DestSlot << " [o]\n");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000748}
Chris Lattner3eee99c2008-08-19 04:36:02 +0000749
Devang Patel983c6b12009-07-08 21:44:25 +0000750/// CreateModuleSlot - Insert the specified MDNode* into the slot table.
751void SlotTracker::CreateMetadataSlot(const MDNode *N) {
752 assert(N && "Can't insert a null Value into SlotTracker!");
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000753
Victor Hernandez0471abd2009-12-18 20:09:14 +0000754 // Don't insert if N is a function-local metadata.
755 if (N->isFunctionLocal())
756 return;
Victor Hernandez4d633542009-12-04 20:07:10 +0000757
Chris Lattnercf4a76e2009-12-31 02:20:11 +0000758 mdn_iterator I = mdnMap.find(N);
Devang Patel983c6b12009-07-08 21:44:25 +0000759 if (I != mdnMap.end())
760 return;
Chris Lattner3eee99c2008-08-19 04:36:02 +0000761
Devang Patel983c6b12009-07-08 21:44:25 +0000762 unsigned DestSlot = mdnNext++;
763 mdnMap[N] = DestSlot;
764
Chris Lattner9b493022009-12-31 01:22:29 +0000765 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
766 const Value *TV = N->getOperand(i);
Devang Patel983c6b12009-07-08 21:44:25 +0000767 if (TV)
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000768 if (const MDNode *N2 = dyn_cast<MDNode>(TV))
Devang Patel983c6b12009-07-08 21:44:25 +0000769 CreateMetadataSlot(N2);
770 }
771}
Chris Lattner3eee99c2008-08-19 04:36:02 +0000772
773//===----------------------------------------------------------------------===//
774// AsmWriter Implementation
775//===----------------------------------------------------------------------===//
Chris Lattner7f8845a2002-07-23 18:07:49 +0000776
Dan Gohman12dad632009-08-12 20:56:03 +0000777static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
Dan Gohman8061d9e2009-08-13 15:27:57 +0000778 TypePrinting *TypePrinter,
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000779 SlotTracker *Machine);
Reid Spencer58d30f22004-07-04 11:50:43 +0000780
Chris Lattner033935d2008-08-17 04:40:13 +0000781
Chris Lattnerb86620e2001-10-29 16:37:48 +0000782
Chris Lattnerfc9f1c92006-12-06 06:40:49 +0000783static const char *getPredicateText(unsigned predicate) {
Reid Spencer812a1be2006-12-04 05:19:18 +0000784 const char * pred = "unknown";
785 switch (predicate) {
Chris Lattnerbddea6a2009-12-31 02:13:35 +0000786 case FCmpInst::FCMP_FALSE: pred = "false"; break;
787 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
788 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
789 case FCmpInst::FCMP_OGE: pred = "oge"; break;
790 case FCmpInst::FCMP_OLT: pred = "olt"; break;
791 case FCmpInst::FCMP_OLE: pred = "ole"; break;
792 case FCmpInst::FCMP_ONE: pred = "one"; break;
793 case FCmpInst::FCMP_ORD: pred = "ord"; break;
794 case FCmpInst::FCMP_UNO: pred = "uno"; break;
795 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
796 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
797 case FCmpInst::FCMP_UGE: pred = "uge"; break;
798 case FCmpInst::FCMP_ULT: pred = "ult"; break;
799 case FCmpInst::FCMP_ULE: pred = "ule"; break;
800 case FCmpInst::FCMP_UNE: pred = "une"; break;
801 case FCmpInst::FCMP_TRUE: pred = "true"; break;
802 case ICmpInst::ICMP_EQ: pred = "eq"; break;
803 case ICmpInst::ICMP_NE: pred = "ne"; break;
804 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
805 case ICmpInst::ICMP_SGE: pred = "sge"; break;
806 case ICmpInst::ICMP_SLT: pred = "slt"; break;
807 case ICmpInst::ICMP_SLE: pred = "sle"; break;
808 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
809 case ICmpInst::ICMP_UGE: pred = "uge"; break;
810 case ICmpInst::ICMP_ULT: pred = "ult"; break;
811 case ICmpInst::ICMP_ULE: pred = "ule"; break;
Reid Spencer812a1be2006-12-04 05:19:18 +0000812 }
813 return pred;
814}
815
Devang Patel983c6b12009-07-08 21:44:25 +0000816
Dan Gohman12dad632009-08-12 20:56:03 +0000817static void WriteOptimizationInfo(raw_ostream &Out, const User *U) {
Dan Gohman0ebd6962009-07-20 21:19:07 +0000818 if (const OverflowingBinaryOperator *OBO =
819 dyn_cast<OverflowingBinaryOperator>(U)) {
Dan Gohman16f54152009-08-20 17:11:38 +0000820 if (OBO->hasNoUnsignedWrap())
Dan Gohman9c7f8082009-07-27 16:11:46 +0000821 Out << " nuw";
Dan Gohman16f54152009-08-20 17:11:38 +0000822 if (OBO->hasNoSignedWrap())
Dan Gohman9c7f8082009-07-27 16:11:46 +0000823 Out << " nsw";
Dan Gohman0ebd6962009-07-20 21:19:07 +0000824 } else if (const SDivOperator *Div = dyn_cast<SDivOperator>(U)) {
825 if (Div->isExact())
Dan Gohman9c7f8082009-07-27 16:11:46 +0000826 Out << " exact";
Dan Gohman1639c392009-07-27 21:53:46 +0000827 } else if (const GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
828 if (GEP->isInBounds())
829 Out << " inbounds";
Dan Gohman0ebd6962009-07-20 21:19:07 +0000830 }
831}
832
Dan Gohman12dad632009-08-12 20:56:03 +0000833static void WriteConstantInt(raw_ostream &Out, const Constant *CV,
Chris Lattner0f578952009-02-28 20:25:14 +0000834 TypePrinting &TypePrinter, SlotTracker *Machine) {
Zhou Sheng75b871f2007-01-11 12:24:14 +0000835 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
Owen Anderson55f1c092009-08-13 21:58:54 +0000836 if (CI->getType() == Type::getInt1Ty(CV->getContext())) {
Reid Spencercddc9df2007-01-12 04:24:46 +0000837 Out << (CI->getZExtValue() ? "true" : "false");
Chris Lattner17f71652008-08-17 07:19:36 +0000838 return;
839 }
840 Out << CI->getValue();
841 return;
842 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000843
Chris Lattner17f71652008-08-17 07:19:36 +0000844 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
Dale Johannesen028084e2007-09-12 03:30:33 +0000845 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble ||
846 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle) {
847 // We would like to output the FP constant value in exponential notation,
848 // but we cannot do this if doing so will lose precision. Check here to
849 // make sure that we only output it in exponential format if we can parse
850 // the value back and get the same value.
851 //
Dale Johannesen1f864982009-01-21 20:32:55 +0000852 bool ignored;
Dale Johannesen028084e2007-09-12 03:30:33 +0000853 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
Chris Lattner17f71652008-08-17 07:19:36 +0000854 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
855 CFP->getValueAPF().convertToFloat();
Dale Johannesen028084e2007-09-12 03:30:33 +0000856 std::string StrVal = ftostr(CFP->getValueAPF());
Chris Lattner1e194682002-04-18 18:53:13 +0000857
Dale Johannesen028084e2007-09-12 03:30:33 +0000858 // Check to make sure that the stringized number is not some string like
859 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
860 // that the string matches the "[-+]?[0-9]" regex.
861 //
862 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
863 ((StrVal[0] == '-' || StrVal[0] == '+') &&
864 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
865 // Reparse stringized version!
866 if (atof(StrVal.c_str()) == Val) {
867 Out << StrVal;
868 return;
869 }
Chris Lattner1e194682002-04-18 18:53:13 +0000870 }
Dale Johannesen028084e2007-09-12 03:30:33 +0000871 // Otherwise we could not reparse it to exactly the same value, so we must
Dale Johannesen1f864982009-01-21 20:32:55 +0000872 // output the string in hexadecimal format! Note that loading and storing
873 // floating point types changes the bits of NaNs on some hosts, notably
874 // x86, so we must not use these types.
Dale Johannesen028084e2007-09-12 03:30:33 +0000875 assert(sizeof(double) == sizeof(uint64_t) &&
876 "assuming that double is 64 bits!");
Chris Lattner5505eed2008-11-10 04:30:26 +0000877 char Buffer[40];
Dale Johannesen1f864982009-01-21 20:32:55 +0000878 APFloat apf = CFP->getValueAPF();
879 // Floats are represented in ASCII IR as double, convert.
880 if (!isDouble)
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000881 apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
Dale Johannesen1f864982009-01-21 20:32:55 +0000882 &ignored);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000883 Out << "0x" <<
884 utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
Dale Johannesen1f864982009-01-21 20:32:55 +0000885 Buffer+40);
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000886 return;
887 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000888
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000889 // Some form of long double. These appear as a magic letter identifying
890 // the type, then a fixed number of hex digits.
891 Out << "0x";
Dale Johannesen93eefa02009-03-23 21:16:53 +0000892 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended) {
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000893 Out << 'K';
Dale Johannesen93eefa02009-03-23 21:16:53 +0000894 // api needed to prevent premature destruction
895 APInt api = CFP->getValueAPF().bitcastToAPInt();
896 const uint64_t* p = api.getRawData();
897 uint64_t word = p[1];
898 int shiftcount=12;
899 int width = api.getBitWidth();
900 for (int j=0; j<width; j+=4, shiftcount-=4) {
901 unsigned int nibble = (word>>shiftcount) & 15;
902 if (nibble < 10)
903 Out << (unsigned char)(nibble + '0');
904 else
905 Out << (unsigned char)(nibble - 10 + 'A');
906 if (shiftcount == 0 && j+4 < width) {
907 word = *p;
908 shiftcount = 64;
909 if (width-j-4 < 64)
910 shiftcount = width-j-4;
911 }
912 }
913 return;
914 } else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad)
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000915 Out << 'L';
916 else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble)
917 Out << 'M';
918 else
Torok Edwinfbcc6632009-07-14 16:55:14 +0000919 llvm_unreachable("Unsupported floating point type");
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000920 // api needed to prevent premature destruction
Dale Johannesen54306fe2008-10-09 18:53:47 +0000921 APInt api = CFP->getValueAPF().bitcastToAPInt();
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000922 const uint64_t* p = api.getRawData();
923 uint64_t word = *p;
924 int shiftcount=60;
925 int width = api.getBitWidth();
926 for (int j=0; j<width; j+=4, shiftcount-=4) {
927 unsigned int nibble = (word>>shiftcount) & 15;
928 if (nibble < 10)
929 Out << (unsigned char)(nibble + '0');
Dale Johannesen028084e2007-09-12 03:30:33 +0000930 else
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000931 Out << (unsigned char)(nibble - 10 + 'A');
932 if (shiftcount == 0 && j+4 < width) {
933 word = *(++p);
934 shiftcount = 64;
935 if (width-j-4 < 64)
936 shiftcount = width-j-4;
Dale Johannesen028084e2007-09-12 03:30:33 +0000937 }
938 }
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000939 return;
940 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000941
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000942 if (isa<ConstantAggregateZero>(CV)) {
Chris Lattner76b2ff42004-02-15 05:55:15 +0000943 Out << "zeroinitializer";
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000944 return;
945 }
Chris Lattner214cc702009-10-28 03:38:12 +0000946
947 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV)) {
948 Out << "blockaddress(";
949 WriteAsOperandInternal(Out, BA->getFunction(), &TypePrinter, Machine);
950 Out << ", ";
Chris Lattneraa99c942009-11-01 01:27:45 +0000951 WriteAsOperandInternal(Out, BA->getBasicBlock(), &TypePrinter, Machine);
Chris Lattner214cc702009-10-28 03:38:12 +0000952 Out << ")";
953 return;
954 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000955
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000956 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
Chris Lattner1e194682002-04-18 18:53:13 +0000957 // As a special case, print the array as a string if it is an array of
Dan Gohmane9bc2ba2008-05-12 16:34:30 +0000958 // i8 with ConstantInt values.
Misha Brukmanb1c93172005-04-21 23:48:37 +0000959 //
Chris Lattner1e194682002-04-18 18:53:13 +0000960 const Type *ETy = CA->getType()->getElementType();
Chris Lattner6ed87bd2006-01-23 23:03:36 +0000961 if (CA->isString()) {
Chris Lattner1e194682002-04-18 18:53:13 +0000962 Out << "c\"";
Chris Lattner6ed87bd2006-01-23 23:03:36 +0000963 PrintEscapedString(CA->getAsString(), Out);
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000964 Out << '"';
Chris Lattner1e194682002-04-18 18:53:13 +0000965 } else { // Cannot output in string format...
Misha Brukman21bbdb92004-06-04 21:11:51 +0000966 Out << '[';
Chris Lattnerd84bb632002-04-16 21:36:08 +0000967 if (CA->getNumOperands()) {
Chris Lattnere101c442009-02-28 21:26:53 +0000968 TypePrinter.print(ETy, Out);
Dan Gohman81313fd2008-09-14 17:21:12 +0000969 Out << ' ';
Chris Lattnerd84bb632002-04-16 21:36:08 +0000970 WriteAsOperandInternal(Out, CA->getOperand(0),
Dan Gohman8061d9e2009-08-13 15:27:57 +0000971 &TypePrinter, Machine);
Chris Lattnerd84bb632002-04-16 21:36:08 +0000972 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
973 Out << ", ";
Chris Lattnere101c442009-02-28 21:26:53 +0000974 TypePrinter.print(ETy, Out);
Dan Gohman81313fd2008-09-14 17:21:12 +0000975 Out << ' ';
Dan Gohman8061d9e2009-08-13 15:27:57 +0000976 WriteAsOperandInternal(Out, CA->getOperand(i), &TypePrinter, Machine);
Chris Lattnerd84bb632002-04-16 21:36:08 +0000977 }
978 }
Dan Gohman81313fd2008-09-14 17:21:12 +0000979 Out << ']';
Chris Lattnerd84bb632002-04-16 21:36:08 +0000980 }
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000981 return;
982 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000983
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000984 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
Andrew Lenharth0d124b82007-01-08 18:21:30 +0000985 if (CS->getType()->isPacked())
986 Out << '<';
Misha Brukman21bbdb92004-06-04 21:11:51 +0000987 Out << '{';
Jim Laskey3bb78742006-02-25 12:27:03 +0000988 unsigned N = CS->getNumOperands();
989 if (N) {
Chris Lattner604e3512008-08-19 04:47:09 +0000990 Out << ' ';
Chris Lattnere101c442009-02-28 21:26:53 +0000991 TypePrinter.print(CS->getOperand(0)->getType(), Out);
Dan Gohman81313fd2008-09-14 17:21:12 +0000992 Out << ' ';
Chris Lattnerd84bb632002-04-16 21:36:08 +0000993
Dan Gohman8061d9e2009-08-13 15:27:57 +0000994 WriteAsOperandInternal(Out, CS->getOperand(0), &TypePrinter, Machine);
Chris Lattnerd84bb632002-04-16 21:36:08 +0000995
Jim Laskey3bb78742006-02-25 12:27:03 +0000996 for (unsigned i = 1; i < N; i++) {
Chris Lattnerd84bb632002-04-16 21:36:08 +0000997 Out << ", ";
Chris Lattnere101c442009-02-28 21:26:53 +0000998 TypePrinter.print(CS->getOperand(i)->getType(), Out);
Dan Gohman81313fd2008-09-14 17:21:12 +0000999 Out << ' ';
Chris Lattnerd84bb632002-04-16 21:36:08 +00001000
Dan Gohman8061d9e2009-08-13 15:27:57 +00001001 WriteAsOperandInternal(Out, CS->getOperand(i), &TypePrinter, Machine);
Chris Lattnerd84bb632002-04-16 21:36:08 +00001002 }
Dan Gohman81313fd2008-09-14 17:21:12 +00001003 Out << ' ';
Chris Lattnerd84bb632002-04-16 21:36:08 +00001004 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001005
Dan Gohman81313fd2008-09-14 17:21:12 +00001006 Out << '}';
Andrew Lenharth0d124b82007-01-08 18:21:30 +00001007 if (CS->getType()->isPacked())
1008 Out << '>';
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001009 return;
1010 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001011
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001012 if (const ConstantVector *CP = dyn_cast<ConstantVector>(CV)) {
1013 const Type *ETy = CP->getType()->getElementType();
1014 assert(CP->getNumOperands() > 0 &&
1015 "Number of operands for a PackedConst must be > 0");
Dan Gohman1262a252009-02-11 00:25:25 +00001016 Out << '<';
Chris Lattnere101c442009-02-28 21:26:53 +00001017 TypePrinter.print(ETy, Out);
Dan Gohman81313fd2008-09-14 17:21:12 +00001018 Out << ' ';
Dan Gohman8061d9e2009-08-13 15:27:57 +00001019 WriteAsOperandInternal(Out, CP->getOperand(0), &TypePrinter, Machine);
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001020 for (unsigned i = 1, e = CP->getNumOperands(); i != e; ++i) {
Chris Lattner585297e82008-08-19 05:26:17 +00001021 Out << ", ";
Chris Lattnere101c442009-02-28 21:26:53 +00001022 TypePrinter.print(ETy, Out);
Dan Gohman81313fd2008-09-14 17:21:12 +00001023 Out << ' ';
Dan Gohman8061d9e2009-08-13 15:27:57 +00001024 WriteAsOperandInternal(Out, CP->getOperand(i), &TypePrinter, Machine);
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001025 }
Dan Gohman1262a252009-02-11 00:25:25 +00001026 Out << '>';
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001027 return;
1028 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001029
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001030 if (isa<ConstantPointerNull>(CV)) {
Chris Lattnerd84bb632002-04-16 21:36:08 +00001031 Out << "null";
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001032 return;
1033 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001034
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001035 if (isa<UndefValue>(CV)) {
Chris Lattner5e0b9f22004-10-16 18:08:06 +00001036 Out << "undef";
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001037 return;
1038 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001039
Devang Patel983c6b12009-07-08 21:44:25 +00001040 if (const MDNode *Node = dyn_cast<MDNode>(CV)) {
1041 Out << "!" << Machine->getMetadataSlot(Node);
1042 return;
1043 }
1044
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001045 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
Reid Spencer812a1be2006-12-04 05:19:18 +00001046 Out << CE->getOpcodeName();
Dan Gohman9c7f8082009-07-27 16:11:46 +00001047 WriteOptimizationInfo(Out, CE);
Reid Spencer812a1be2006-12-04 05:19:18 +00001048 if (CE->isCompare())
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001049 Out << ' ' << getPredicateText(CE->getPredicate());
Reid Spencer812a1be2006-12-04 05:19:18 +00001050 Out << " (";
Misha Brukmanb1c93172005-04-21 23:48:37 +00001051
Vikram S. Adveb952b542002-07-14 23:14:45 +00001052 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
Chris Lattnere101c442009-02-28 21:26:53 +00001053 TypePrinter.print((*OI)->getType(), Out);
Dan Gohman81313fd2008-09-14 17:21:12 +00001054 Out << ' ';
Dan Gohman8061d9e2009-08-13 15:27:57 +00001055 WriteAsOperandInternal(Out, *OI, &TypePrinter, Machine);
Vikram S. Adveb952b542002-07-14 23:14:45 +00001056 if (OI+1 != CE->op_end())
Chris Lattner3cd8c562002-07-30 18:54:25 +00001057 Out << ", ";
Vikram S. Adveb952b542002-07-14 23:14:45 +00001058 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00001059
Dan Gohmana76f0f72008-05-31 19:12:39 +00001060 if (CE->hasIndices()) {
1061 const SmallVector<unsigned, 4> &Indices = CE->getIndices();
1062 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
1063 Out << ", " << Indices[i];
1064 }
1065
Reid Spencer6c38f0b2006-11-27 01:05:10 +00001066 if (CE->isCast()) {
Chris Lattner83b396b2002-08-15 19:37:43 +00001067 Out << " to ";
Chris Lattnere101c442009-02-28 21:26:53 +00001068 TypePrinter.print(CE->getType(), Out);
Chris Lattner83b396b2002-08-15 19:37:43 +00001069 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00001070
Misha Brukman21bbdb92004-06-04 21:11:51 +00001071 Out << ')';
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001072 return;
Chris Lattnerd84bb632002-04-16 21:36:08 +00001073 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001074
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001075 Out << "<placeholder or erroneous Constant>";
Chris Lattnerd84bb632002-04-16 21:36:08 +00001076}
1077
1078
Misha Brukmanc566ca362004-03-02 00:22:19 +00001079/// WriteAsOperand - Write the name of the specified value out to the specified
1080/// ostream. This can be useful when you just want to print int %reg126, not
1081/// the whole instruction that generated it.
1082///
Dan Gohman12dad632009-08-12 20:56:03 +00001083static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
Dan Gohman8061d9e2009-08-13 15:27:57 +00001084 TypePrinting *TypePrinter,
Chris Lattnere36fd8a2008-08-19 04:26:57 +00001085 SlotTracker *Machine) {
Chris Lattner033935d2008-08-17 04:40:13 +00001086 if (V->hasName()) {
1087 PrintLLVMName(Out, V);
1088 return;
1089 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001090
Chris Lattner033935d2008-08-17 04:40:13 +00001091 const Constant *CV = dyn_cast<Constant>(V);
1092 if (CV && !isa<GlobalValue>(CV)) {
Dan Gohman8061d9e2009-08-13 15:27:57 +00001093 assert(TypePrinter && "Constants require TypePrinting!");
1094 WriteConstantInt(Out, CV, *TypePrinter, Machine);
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001095 return;
1096 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001097
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001098 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
Chris Lattner033935d2008-08-17 04:40:13 +00001099 Out << "asm ";
1100 if (IA->hasSideEffects())
1101 Out << "sideeffect ";
Dale Johannesen1cfb9582009-10-21 23:28:00 +00001102 if (IA->isAlignStack())
1103 Out << "alignstack ";
Chris Lattner033935d2008-08-17 04:40:13 +00001104 Out << '"';
1105 PrintEscapedString(IA->getAsmString(), Out);
1106 Out << "\", \"";
1107 PrintEscapedString(IA->getConstraintString(), Out);
1108 Out << '"';
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001109 return;
1110 }
Devang Patel7428d8a2009-07-22 17:43:22 +00001111
Devang Patele059ba6e2009-07-23 01:07:34 +00001112 if (const MDNode *N = dyn_cast<MDNode>(V)) {
Victor Hernandez0471abd2009-12-18 20:09:14 +00001113 if (N->isFunctionLocal()) {
Victor Hernandezb7176a12009-12-04 01:35:02 +00001114 // Print metadata inline, not via slot reference number.
1115 Out << "!{";
Chris Lattner9b493022009-12-31 01:22:29 +00001116 for (unsigned mi = 0, me = N->getNumOperands(); mi != me; ++mi) {
1117 const Value *Val = N->getOperand(mi);
Victor Hernandezb7176a12009-12-04 01:35:02 +00001118 if (!Val)
1119 Out << "null";
1120 else {
Chris Lattnerb9196672009-12-31 01:44:44 +00001121 TypePrinter->print(N->getOperand(mi)->getType(), Out);
Victor Hernandezb7176a12009-12-04 01:35:02 +00001122 Out << ' ';
Chris Lattnerb9196672009-12-31 01:44:44 +00001123 WriteAsOperandInternal(Out, N->getOperand(mi), TypePrinter, Machine);
Victor Hernandezb7176a12009-12-04 01:35:02 +00001124 }
1125 if (mi + 1 != me)
1126 Out << ", ";
1127 }
1128 Out << '}';
1129 return;
1130 }
1131
Devang Patele059ba6e2009-07-23 01:07:34 +00001132 Out << '!' << Machine->getMetadataSlot(N);
1133 return;
1134 }
1135
Devang Patel7428d8a2009-07-22 17:43:22 +00001136 if (const MDString *MDS = dyn_cast<MDString>(V)) {
Devang Patel7428d8a2009-07-22 17:43:22 +00001137 Out << "!\"";
Daniel Dunbare03eecb2009-07-25 23:55:21 +00001138 PrintEscapedString(MDS->getString(), Out);
Devang Patel7428d8a2009-07-22 17:43:22 +00001139 Out << '"';
1140 return;
1141 }
1142
Evan Cheng00e87d12009-11-16 07:10:36 +00001143 if (V->getValueID() == Value::PseudoSourceValueVal ||
1144 V->getValueID() == Value::FixedStackPseudoSourceValueVal) {
Dan Gohmanc0353bf2009-09-23 01:33:16 +00001145 V->print(Out);
1146 return;
1147 }
1148
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001149 char Prefix = '%';
1150 int Slot;
1151 if (Machine) {
1152 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1153 Slot = Machine->getGlobalSlot(GV);
1154 Prefix = '@';
1155 } else {
1156 Slot = Machine->getLocalSlot(V);
1157 }
Chris Lattner033935d2008-08-17 04:40:13 +00001158 } else {
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001159 Machine = createSlotTracker(V);
Chris Lattner033935d2008-08-17 04:40:13 +00001160 if (Machine) {
1161 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
1162 Slot = Machine->getGlobalSlot(GV);
1163 Prefix = '@';
1164 } else {
1165 Slot = Machine->getLocalSlot(V);
1166 }
Dan Gohman8061d9e2009-08-13 15:27:57 +00001167 delete Machine;
Chris Lattnera2d810d2006-01-25 22:26:05 +00001168 } else {
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001169 Slot = -1;
Chris Lattnerd84bb632002-04-16 21:36:08 +00001170 }
1171 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001172
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001173 if (Slot != -1)
1174 Out << Prefix << Slot;
1175 else
1176 Out << "<badref>";
Chris Lattnerd84bb632002-04-16 21:36:08 +00001177}
1178
Dan Gohman12dad632009-08-12 20:56:03 +00001179void llvm::WriteAsOperand(raw_ostream &Out, const Value *V,
1180 bool PrintType, const Module *Context) {
Dan Gohman8061d9e2009-08-13 15:27:57 +00001181
1182 // Fast path: Don't construct and populate a TypePrinting object if we
1183 // won't be needing any types printed.
Dan Gohman08097122009-08-13 23:07:11 +00001184 if (!PrintType &&
1185 (!isa<Constant>(V) || V->hasName() || isa<GlobalValue>(V))) {
Dan Gohman8061d9e2009-08-13 15:27:57 +00001186 WriteAsOperandInternal(Out, V, 0, 0);
1187 return;
1188 }
1189
Chris Lattner5a9f63e2002-07-10 16:48:17 +00001190 if (Context == 0) Context = getModuleFromVal(V);
Chris Lattnerb86620e2001-10-29 16:37:48 +00001191
Chris Lattner92c5c122009-02-28 23:20:19 +00001192 TypePrinting TypePrinter;
Chris Lattner3243ea12009-03-01 00:03:38 +00001193 std::vector<const Type*> NumberedTypes;
1194 AddModuleTypesToPrinter(TypePrinter, NumberedTypes, Context);
Dan Gohman81313fd2008-09-14 17:21:12 +00001195 if (PrintType) {
Chris Lattnere101c442009-02-28 21:26:53 +00001196 TypePrinter.print(V->getType(), Out);
Dan Gohman81313fd2008-09-14 17:21:12 +00001197 Out << ' ';
1198 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00001199
Dan Gohman8061d9e2009-08-13 15:27:57 +00001200 WriteAsOperandInternal(Out, V, &TypePrinter, 0);
Chris Lattner5e5abe32001-07-20 19:15:21 +00001201}
1202
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001203namespace {
Chris Lattner2e9fee42001-07-12 23:35:26 +00001204
Chris Lattnerfee714f2001-09-07 16:36:04 +00001205class AssemblyWriter {
Dan Gohmane2745262009-08-12 17:23:50 +00001206 formatted_raw_ostream &Out;
Chris Lattnere36fd8a2008-08-19 04:26:57 +00001207 SlotTracker &Machine;
Chris Lattner7bfee412001-10-29 16:05:51 +00001208 const Module *TheModule;
Chris Lattner0f578952009-02-28 20:25:14 +00001209 TypePrinting TypePrinter;
Chris Lattner8339f7d2003-10-30 23:41:03 +00001210 AssemblyAnnotationWriter *AnnotationWriter;
Chris Lattner3243ea12009-03-01 00:03:38 +00001211 std::vector<const Type*> NumberedTypes;
Chris Lattnerc9558df2009-12-28 20:10:43 +00001212 SmallVector<StringRef, 8> MDNames;
1213
Chris Lattner2f7c9632001-06-06 20:29:01 +00001214public:
Dan Gohmane2745262009-08-12 17:23:50 +00001215 inline AssemblyWriter(formatted_raw_ostream &o, SlotTracker &Mac,
1216 const Module *M,
Chris Lattner8339f7d2003-10-30 23:41:03 +00001217 AssemblyAnnotationWriter *AAW)
Devang Patel59c0c132009-09-28 18:31:56 +00001218 : Out(o), Machine(Mac), TheModule(M), AnnotationWriter(AAW) {
Chris Lattner3243ea12009-03-01 00:03:38 +00001219 AddModuleTypesToPrinter(TypePrinter, NumberedTypes, M);
Devang Patel565371b2009-09-28 20:56:00 +00001220 // FIXME: Provide MDPrinter
Chris Lattnerc9558df2009-12-28 20:10:43 +00001221 if (M)
Chris Lattnera0566972009-12-29 09:01:33 +00001222 M->getMDKindNames(MDNames);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001223 }
1224
Chris Lattnerbddea6a2009-12-31 02:13:35 +00001225 void printMDNodeBody(const MDNode *MD);
Chris Lattner2c48c642009-12-31 01:54:05 +00001226 void printNamedMDNode(const NamedMDNode *NMD);
1227
Chris Lattner3243ea12009-03-01 00:03:38 +00001228 void write(const Module *M) { printModule(M); }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001229
Chris Lattner0c19df42008-08-23 22:23:09 +00001230 void write(const GlobalValue *G) {
1231 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(G))
1232 printGlobal(GV);
1233 else if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(G))
1234 printAlias(GA);
1235 else if (const Function *F = dyn_cast<Function>(G))
1236 printFunction(F);
1237 else
Torok Edwinfbcc6632009-07-14 16:55:14 +00001238 llvm_unreachable("Unknown global");
Chris Lattner0c19df42008-08-23 22:23:09 +00001239 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001240
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001241 void write(const BasicBlock *BB) { printBasicBlock(BB); }
1242 void write(const Instruction *I) { printInstruction(*I); }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001243
Chris Lattner78e2e8b2006-12-06 06:24:27 +00001244 void writeOperand(const Value *Op, bool PrintType);
Devang Patelba3fa6c2008-09-23 23:03:40 +00001245 void writeParamOperand(const Value *Operand, Attributes Attrs);
Chris Lattner1e194682002-04-18 18:53:13 +00001246
Chris Lattnerbddea6a2009-12-31 02:13:35 +00001247 void writeAllMDNodes();
1248
Misha Brukmand92f54a2004-11-15 19:30:05 +00001249private:
Chris Lattner7bfee412001-10-29 16:05:51 +00001250 void printModule(const Module *M);
Reid Spencer32af9e82007-01-06 07:24:44 +00001251 void printTypeSymbolTable(const TypeSymbolTable &ST);
Chris Lattner7bfee412001-10-29 16:05:51 +00001252 void printGlobal(const GlobalVariable *GV);
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001253 void printAlias(const GlobalAlias *GV);
Chris Lattner57698e22002-03-26 18:01:55 +00001254 void printFunction(const Function *F);
Devang Patelba3fa6c2008-09-23 23:03:40 +00001255 void printArgument(const Argument *FA, Attributes Attrs);
Chris Lattner7bfee412001-10-29 16:05:51 +00001256 void printBasicBlock(const BasicBlock *BB);
Chris Lattner113f4f42002-06-25 16:13:24 +00001257 void printInstruction(const Instruction &I);
Chris Lattnerd816b532002-04-13 20:53:41 +00001258
Chris Lattner862e3382001-10-13 06:42:36 +00001259 // printInfoComment - Print a little comment after the instruction indicating
1260 // which slot it occupies.
Chris Lattner113f4f42002-06-25 16:13:24 +00001261 void printInfoComment(const Value &V);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001262};
Chris Lattner3243ea12009-03-01 00:03:38 +00001263} // end of anonymous namespace
Chris Lattner2f7c9632001-06-06 20:29:01 +00001264
Chris Lattnerd816b532002-04-13 20:53:41 +00001265
Chris Lattner78e2e8b2006-12-06 06:24:27 +00001266void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
1267 if (Operand == 0) {
Chris Lattner08f7d0c2005-02-24 16:58:29 +00001268 Out << "<null operand!>";
Chris Lattner78e2e8b2006-12-06 06:24:27 +00001269 } else {
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001270 if (PrintType) {
Chris Lattnere101c442009-02-28 21:26:53 +00001271 TypePrinter.print(Operand->getType(), Out);
Dan Gohman81313fd2008-09-14 17:21:12 +00001272 Out << ' ';
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001273 }
Dan Gohman8061d9e2009-08-13 15:27:57 +00001274 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine);
Chris Lattner08f7d0c2005-02-24 16:58:29 +00001275 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001276}
1277
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001278void AssemblyWriter::writeParamOperand(const Value *Operand,
Devang Patelba3fa6c2008-09-23 23:03:40 +00001279 Attributes Attrs) {
Duncan Sandsad0ea2d2007-11-27 13:23:08 +00001280 if (Operand == 0) {
1281 Out << "<null operand!>";
1282 } else {
Duncan Sandsad0ea2d2007-11-27 13:23:08 +00001283 // Print the type
Chris Lattnere101c442009-02-28 21:26:53 +00001284 TypePrinter.print(Operand->getType(), Out);
Duncan Sandsad0ea2d2007-11-27 13:23:08 +00001285 // Print parameter attributes list
Devang Patel4c758ea2008-09-25 21:00:45 +00001286 if (Attrs != Attribute::None)
1287 Out << ' ' << Attribute::getAsString(Attrs);
Dan Gohman81313fd2008-09-14 17:21:12 +00001288 Out << ' ';
Duncan Sandsad0ea2d2007-11-27 13:23:08 +00001289 // Print the operand
Dan Gohman8061d9e2009-08-13 15:27:57 +00001290 WriteAsOperandInternal(Out, Operand, &TypePrinter, &Machine);
Duncan Sandsad0ea2d2007-11-27 13:23:08 +00001291 }
1292}
Chris Lattner2f7c9632001-06-06 20:29:01 +00001293
Chris Lattner7bfee412001-10-29 16:05:51 +00001294void AssemblyWriter::printModule(const Module *M) {
Chris Lattner4d8689e2005-03-02 23:12:40 +00001295 if (!M->getModuleIdentifier().empty() &&
Misha Brukmanb1c93172005-04-21 23:48:37 +00001296 // Don't print the ID if it will start a new line (which would
Chris Lattner4d8689e2005-03-02 23:12:40 +00001297 // require a comment char before it).
1298 M->getModuleIdentifier().find('\n') == std::string::npos)
1299 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
1300
Owen Andersone2237542006-10-18 02:21:12 +00001301 if (!M->getDataLayout().empty())
Chris Lattner04897162006-10-22 06:06:56 +00001302 Out << "target datalayout = \"" << M->getDataLayout() << "\"\n";
Reid Spencer48f98c82004-07-25 21:44:54 +00001303 if (!M->getTargetTriple().empty())
Reid Spencerffec7df2004-07-25 21:29:43 +00001304 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
Misha Brukmanb1c93172005-04-21 23:48:37 +00001305
Chris Lattnereef2fe72006-01-24 04:13:11 +00001306 if (!M->getModuleInlineAsm().empty()) {
Chris Lattnerefaf35d2006-01-24 00:45:30 +00001307 // Split the string into lines, to make it easier to read the .ll file.
Chris Lattnereef2fe72006-01-24 04:13:11 +00001308 std::string Asm = M->getModuleInlineAsm();
Chris Lattnerefaf35d2006-01-24 00:45:30 +00001309 size_t CurPos = 0;
1310 size_t NewLine = Asm.find_first_of('\n', CurPos);
Dan Gohman69273e62009-08-12 23:54:22 +00001311 Out << '\n';
Chris Lattnerefaf35d2006-01-24 00:45:30 +00001312 while (NewLine != std::string::npos) {
1313 // We found a newline, print the portion of the asm string from the
1314 // last newline up to this newline.
1315 Out << "module asm \"";
1316 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
1317 Out);
1318 Out << "\"\n";
1319 CurPos = NewLine+1;
1320 NewLine = Asm.find_first_of('\n', CurPos);
1321 }
Chris Lattner3acaf5c2006-01-24 00:40:17 +00001322 Out << "module asm \"";
Chris Lattnerefaf35d2006-01-24 00:45:30 +00001323 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.end()), Out);
Chris Lattner6ed87bd2006-01-23 23:03:36 +00001324 Out << "\"\n";
1325 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001326
Chris Lattner2cdd49d2004-09-14 05:06:58 +00001327 // Loop over the dependent libraries and emit them.
Chris Lattner730cfe42004-09-14 04:51:44 +00001328 Module::lib_iterator LI = M->lib_begin();
1329 Module::lib_iterator LE = M->lib_end();
Reid Spencer48f98c82004-07-25 21:44:54 +00001330 if (LI != LE) {
Dan Gohman69273e62009-08-12 23:54:22 +00001331 Out << '\n';
Chris Lattner730cfe42004-09-14 04:51:44 +00001332 Out << "deplibs = [ ";
1333 while (LI != LE) {
Chris Lattner2cdd49d2004-09-14 05:06:58 +00001334 Out << '"' << *LI << '"';
Reid Spencerffec7df2004-07-25 21:29:43 +00001335 ++LI;
Chris Lattner730cfe42004-09-14 04:51:44 +00001336 if (LI != LE)
1337 Out << ", ";
Reid Spencerffec7df2004-07-25 21:29:43 +00001338 }
Dan Gohman69273e62009-08-12 23:54:22 +00001339 Out << " ]";
Reid Spencercc5ff642004-07-25 18:08:18 +00001340 }
Reid Spencerb9e08772004-09-13 23:44:23 +00001341
Chris Lattner3243ea12009-03-01 00:03:38 +00001342 // Loop over the symbol table, emitting all id'd types.
Dan Gohman69273e62009-08-12 23:54:22 +00001343 if (!M->getTypeSymbolTable().empty() || !NumberedTypes.empty()) Out << '\n';
Reid Spencer32af9e82007-01-06 07:24:44 +00001344 printTypeSymbolTable(M->getTypeSymbolTable());
Misha Brukmanb1c93172005-04-21 23:48:37 +00001345
Dan Gohman69273e62009-08-12 23:54:22 +00001346 // Output all globals.
1347 if (!M->global_empty()) Out << '\n';
Chris Lattner54932b02006-12-06 04:41:52 +00001348 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
1349 I != E; ++I)
Chris Lattner113f4f42002-06-25 16:13:24 +00001350 printGlobal(I);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001351
Chris Lattnerd2747052007-04-26 02:24:10 +00001352 // Output all aliases.
1353 if (!M->alias_empty()) Out << "\n";
1354 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
1355 I != E; ++I)
1356 printAlias(I);
Chris Lattnerfee714f2001-09-07 16:36:04 +00001357
Chris Lattner2cdd49d2004-09-14 05:06:58 +00001358 // Output all of the functions.
Chris Lattner113f4f42002-06-25 16:13:24 +00001359 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
1360 printFunction(I);
Devang Patel983c6b12009-07-08 21:44:25 +00001361
Devang Patel23e68302009-07-29 22:04:47 +00001362 // Output named metadata.
Dan Gohman69273e62009-08-12 23:54:22 +00001363 if (!M->named_metadata_empty()) Out << '\n';
Chris Lattner2c48c642009-12-31 01:54:05 +00001364
Devang Patel23e68302009-07-29 22:04:47 +00001365 for (Module::const_named_metadata_iterator I = M->named_metadata_begin(),
Chris Lattnerbddea6a2009-12-31 02:13:35 +00001366 E = M->named_metadata_end(); I != E; ++I)
Chris Lattner2c48c642009-12-31 01:54:05 +00001367 printNamedMDNode(I);
Devang Patel23e68302009-07-29 22:04:47 +00001368
1369 // Output metadata.
Chris Lattnercf4a76e2009-12-31 02:20:11 +00001370 if (!Machine.mdn_empty()) {
Chris Lattnerbddea6a2009-12-31 02:13:35 +00001371 Out << '\n';
1372 writeAllMDNodes();
1373 }
Chris Lattnerfee714f2001-09-07 16:36:04 +00001374}
1375
Chris Lattner2c48c642009-12-31 01:54:05 +00001376void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
1377 Out << "!" << NMD->getName() << " = !{";
1378 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1379 if (i) Out << ", ";
1380 // FIXME: Change accessor to be typesafe.
1381 // FIXME: This doesn't handle null??
1382 MDNode *MD = cast_or_null<MDNode>(NMD->getOperand(i));
1383 Out << '!' << Machine.getMetadataSlot(MD);
1384 }
1385 Out << "}\n";
1386}
1387
1388
Dan Gohmane2745262009-08-12 17:23:50 +00001389static void PrintLinkage(GlobalValue::LinkageTypes LT,
1390 formatted_raw_ostream &Out) {
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001391 switch (LT) {
Bill Wendlinga3c6f6b2009-07-20 01:03:30 +00001392 case GlobalValue::ExternalLinkage: break;
1393 case GlobalValue::PrivateLinkage: Out << "private "; break;
1394 case GlobalValue::LinkerPrivateLinkage: Out << "linker_private "; break;
1395 case GlobalValue::InternalLinkage: Out << "internal "; break;
1396 case GlobalValue::LinkOnceAnyLinkage: Out << "linkonce "; break;
1397 case GlobalValue::LinkOnceODRLinkage: Out << "linkonce_odr "; break;
1398 case GlobalValue::WeakAnyLinkage: Out << "weak "; break;
1399 case GlobalValue::WeakODRLinkage: Out << "weak_odr "; break;
1400 case GlobalValue::CommonLinkage: Out << "common "; break;
1401 case GlobalValue::AppendingLinkage: Out << "appending "; break;
1402 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
1403 case GlobalValue::DLLExportLinkage: Out << "dllexport "; break;
1404 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
Chris Lattner184f1be2009-04-13 05:44:34 +00001405 case GlobalValue::AvailableExternallyLinkage:
1406 Out << "available_externally ";
1407 break;
Eric Christopher0cabd302009-11-13 23:00:14 +00001408 // This is invalid syntax and just a debugging aid.
1409 case GlobalValue::GhostLinkage: Out << "ghost "; break;
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001410 }
1411}
Duncan Sands12da8ce2009-03-07 15:45:40 +00001412
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001413
1414static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
Dan Gohmane2745262009-08-12 17:23:50 +00001415 formatted_raw_ostream &Out) {
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001416 switch (Vis) {
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001417 case GlobalValue::DefaultVisibility: break;
1418 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
1419 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
1420 }
1421}
1422
Chris Lattner7bfee412001-10-29 16:05:51 +00001423void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
Dan Gohman8061d9e2009-08-13 15:27:57 +00001424 WriteAsOperandInternal(Out, GV, &TypePrinter, &Machine);
Dan Gohman466876b2009-08-12 23:32:33 +00001425 Out << " = ";
Chris Lattner37798642001-09-18 04:01:05 +00001426
Chris Lattner1508d3f2008-08-19 05:16:28 +00001427 if (!GV->hasInitializer() && GV->hasExternalLinkage())
1428 Out << "external ";
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001429
Chris Lattner1508d3f2008-08-19 05:16:28 +00001430 PrintLinkage(GV->getLinkage(), Out);
1431 PrintVisibility(GV->getVisibility(), Out);
Lauro Ramos Venancio749e4662007-04-12 18:32:50 +00001432
1433 if (GV->isThreadLocal()) Out << "thread_local ";
Chris Lattnerac161bf2009-01-02 07:01:27 +00001434 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
1435 Out << "addrspace(" << AddressSpace << ") ";
Misha Brukmana6619a92004-06-21 21:53:56 +00001436 Out << (GV->isConstant() ? "constant " : "global ");
Chris Lattnere101c442009-02-28 21:26:53 +00001437 TypePrinter.print(GV->getType()->getElementType(), Out);
Chris Lattner37798642001-09-18 04:01:05 +00001438
Dan Gohman81313fd2008-09-14 17:21:12 +00001439 if (GV->hasInitializer()) {
1440 Out << ' ';
Devang Patel983c6b12009-07-08 21:44:25 +00001441 writeOperand(GV->getInitializer(), false);
Dan Gohman81313fd2008-09-14 17:21:12 +00001442 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001443
Chris Lattner4b96c542005-11-12 00:10:19 +00001444 if (GV->hasSection())
1445 Out << ", section \"" << GV->getSection() << '"';
1446 if (GV->getAlignment())
Chris Lattnerf8a974d2005-11-06 06:48:53 +00001447 Out << ", align " << GV->getAlignment();
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001448
Chris Lattner113f4f42002-06-25 16:13:24 +00001449 printInfoComment(*GV);
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001450 Out << '\n';
Chris Lattnerda975502001-09-10 07:58:01 +00001451}
1452
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001453void AssemblyWriter::printAlias(const GlobalAlias *GA) {
Dale Johannesen83e468a2008-06-03 18:14:29 +00001454 // Don't crash when dumping partially built GA
1455 if (!GA->hasName())
1456 Out << "<<nameless>> = ";
Chris Lattner033935d2008-08-17 04:40:13 +00001457 else {
1458 PrintLLVMName(Out, GA);
1459 Out << " = ";
1460 }
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001461 PrintVisibility(GA->getVisibility(), Out);
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001462
1463 Out << "alias ";
1464
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001465 PrintLinkage(GA->getLinkage(), Out);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001466
Anton Korobeynikov546ea7e2007-04-29 18:02:48 +00001467 const Constant *Aliasee = GA->getAliasee();
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001468
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001469 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(Aliasee)) {
Chris Lattnere101c442009-02-28 21:26:53 +00001470 TypePrinter.print(GV->getType(), Out);
Chris Lattner033935d2008-08-17 04:40:13 +00001471 Out << ' ';
1472 PrintLLVMName(Out, GV);
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001473 } else if (const Function *F = dyn_cast<Function>(Aliasee)) {
Chris Lattnere101c442009-02-28 21:26:53 +00001474 TypePrinter.print(F->getFunctionType(), Out);
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001475 Out << "* ";
1476
Dan Gohman8061d9e2009-08-13 15:27:57 +00001477 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine);
Anton Korobeynikov72d5d422008-03-22 08:17:17 +00001478 } else if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(Aliasee)) {
Chris Lattnere101c442009-02-28 21:26:53 +00001479 TypePrinter.print(GA->getType(), Out);
1480 Out << ' ';
Chris Lattner033935d2008-08-17 04:40:13 +00001481 PrintLLVMName(Out, GA);
Anton Korobeynikovb18f8f82007-04-28 13:45:00 +00001482 } else {
Chris Lattnercde89e42009-04-25 21:23:19 +00001483 const ConstantExpr *CE = cast<ConstantExpr>(Aliasee);
1484 // The only valid GEP is an all zero GEP.
1485 assert((CE->getOpcode() == Instruction::BitCast ||
1486 CE->getOpcode() == Instruction::GetElementPtr) &&
1487 "Unsupported aliasee");
1488 writeOperand(CE, false);
Anton Korobeynikovb18f8f82007-04-28 13:45:00 +00001489 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001490
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001491 printInfoComment(*GA);
Chris Lattner1508d3f2008-08-19 05:16:28 +00001492 Out << '\n';
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001493}
1494
Reid Spencer32af9e82007-01-06 07:24:44 +00001495void AssemblyWriter::printTypeSymbolTable(const TypeSymbolTable &ST) {
Chris Lattner3243ea12009-03-01 00:03:38 +00001496 // Emit all numbered types.
1497 for (unsigned i = 0, e = NumberedTypes.size(); i != e; ++i) {
Dan Gohman466876b2009-08-12 23:32:33 +00001498 Out << '%' << i << " = type ";
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001499
Chris Lattner3243ea12009-03-01 00:03:38 +00001500 // Make sure we print out at least one level of the type structure, so
1501 // that we do not get %2 = type %2
1502 TypePrinter.printAtLeastOneLevel(NumberedTypes[i], Out);
Dan Gohman69273e62009-08-12 23:54:22 +00001503 Out << '\n';
Chris Lattner3243ea12009-03-01 00:03:38 +00001504 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001505
Chris Lattner3243ea12009-03-01 00:03:38 +00001506 // Print the named types.
Reid Spencer32af9e82007-01-06 07:24:44 +00001507 for (TypeSymbolTable::const_iterator TI = ST.begin(), TE = ST.end();
1508 TI != TE; ++TI) {
Daniel Dunbare03eecb2009-07-25 23:55:21 +00001509 PrintLLVMName(Out, TI->first, LocalPrefix);
Chris Lattner1508d3f2008-08-19 05:16:28 +00001510 Out << " = type ";
Reid Spencere7e96712004-05-25 08:53:40 +00001511
1512 // Make sure we print out at least one level of the type structure, so
1513 // that we do not get %FILE = type %FILE
Chris Lattnere101c442009-02-28 21:26:53 +00001514 TypePrinter.printAtLeastOneLevel(TI->second, Out);
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001515 Out << '\n';
Reid Spencere7e96712004-05-25 08:53:40 +00001516 }
Reid Spencer32af9e82007-01-06 07:24:44 +00001517}
1518
Misha Brukmanc566ca362004-03-02 00:22:19 +00001519/// printFunction - Print all aspects of a function.
1520///
Chris Lattner113f4f42002-06-25 16:13:24 +00001521void AssemblyWriter::printFunction(const Function *F) {
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001522 // Print out the return type and name.
1523 Out << '\n';
Chris Lattner379a8d22003-04-16 20:28:45 +00001524
Misha Brukmana6619a92004-06-21 21:53:56 +00001525 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
Chris Lattner8339f7d2003-10-30 23:41:03 +00001526
Reid Spencer5301e7c2007-01-30 20:08:39 +00001527 if (F->isDeclaration())
Chris Lattner10f03a62007-08-19 22:15:26 +00001528 Out << "declare ";
1529 else
Reid Spencer7ce2d2a2006-12-29 20:29:48 +00001530 Out << "define ";
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001531
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001532 PrintLinkage(F->getLinkage(), Out);
1533 PrintVisibility(F->getVisibility(), Out);
Chris Lattner379a8d22003-04-16 20:28:45 +00001534
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001535 // Print the calling convention.
1536 switch (F->getCallingConv()) {
1537 case CallingConv::C: break; // default
Anton Korobeynikov3c5b3df2006-09-20 22:03:51 +00001538 case CallingConv::Fast: Out << "fastcc "; break;
1539 case CallingConv::Cold: Out << "coldcc "; break;
1540 case CallingConv::X86_StdCall: Out << "x86_stdcallcc "; break;
Anton Korobeynikova8fd40b2009-06-16 18:50:49 +00001541 case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
1542 case CallingConv::ARM_APCS: Out << "arm_apcscc "; break;
1543 case CallingConv::ARM_AAPCS: Out << "arm_aapcscc "; break;
1544 case CallingConv::ARM_AAPCS_VFP:Out << "arm_aapcs_vfpcc "; break;
Anton Korobeynikov27a0ecf2009-12-07 02:27:35 +00001545 case CallingConv::MSP430_INTR: Out << "msp430_intrcc "; break;
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001546 default: Out << "cc" << F->getCallingConv() << " "; break;
1547 }
1548
Reid Spencer8c4914c2006-12-31 05:24:50 +00001549 const 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 Gohman8061d9e2009-08-13 15:27:57 +00001556 WriteAsOperandInternal(Out, F, &TypePrinter, &Machine);
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 << ')';
Devang Patela05633e2008-09-26 22:53:05 +00001593 Attributes FnAttrs = Attrs.getFnAttributes();
1594 if (FnAttrs != Attribute::None)
1595 Out << ' ' << Attribute::getAsString(Attrs.getFnAttributes());
Chris Lattner4b96c542005-11-12 00:10:19 +00001596 if (F->hasSection())
1597 Out << " section \"" << F->getSection() << '"';
Chris Lattnerf8a974d2005-11-06 06:48:53 +00001598 if (F->getAlignment())
1599 Out << " align " << F->getAlignment();
Gordon Henriksend930f912008-08-17 18:44:35 +00001600 if (F->hasGC())
1601 Out << " gc \"" << F->getGC() << '"';
Reid Spencer5301e7c2007-01-30 20:08:39 +00001602 if (F->isDeclaration()) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001603 Out << "\n";
Chris Lattnerb2f02e52002-05-06 03:00:40 +00001604 } else {
Chris Lattnerd5fbc8f2008-04-21 06:12:55 +00001605 Out << " {";
Misha Brukmanb1c93172005-04-21 23:48:37 +00001606
Chris Lattner6915f8f2002-04-07 22:49:37 +00001607 // Output all of its basic blocks... for the function
Chris Lattner113f4f42002-06-25 16:13:24 +00001608 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1609 printBasicBlock(I);
Chris Lattnerfee714f2001-09-07 16:36:04 +00001610
Misha Brukmana6619a92004-06-21 21:53:56 +00001611 Out << "}\n";
Chris Lattnerfee714f2001-09-07 16:36:04 +00001612 }
1613
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001614 Machine.purgeFunction();
Chris Lattner2f7c9632001-06-06 20:29:01 +00001615}
1616
Misha Brukmanc566ca362004-03-02 00:22:19 +00001617/// printArgument - This member is called for every argument that is passed into
1618/// the function. Simply print it out
1619///
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001620void AssemblyWriter::printArgument(const Argument *Arg,
Devang Patelba3fa6c2008-09-23 23:03:40 +00001621 Attributes Attrs) {
Chris Lattner2f7c9632001-06-06 20:29:01 +00001622 // Output type...
Chris Lattnere101c442009-02-28 21:26:53 +00001623 TypePrinter.print(Arg->getType(), Out);
Misha Brukmanb1c93172005-04-21 23:48:37 +00001624
Duncan Sandsad0ea2d2007-11-27 13:23:08 +00001625 // Output parameter attributes list
Devang Patel4c758ea2008-09-25 21:00:45 +00001626 if (Attrs != Attribute::None)
1627 Out << ' ' << Attribute::getAsString(Attrs);
Reid Spencer8c4914c2006-12-31 05:24:50 +00001628
Chris Lattner2f7c9632001-06-06 20:29:01 +00001629 // Output name, if available...
Chris Lattner033935d2008-08-17 04:40:13 +00001630 if (Arg->hasName()) {
1631 Out << ' ';
1632 PrintLLVMName(Out, Arg);
1633 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001634}
1635
Misha Brukmanc566ca362004-03-02 00:22:19 +00001636/// printBasicBlock - This member is called for each basic block in a method.
1637///
Chris Lattner7bfee412001-10-29 16:05:51 +00001638void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
Nick Lewycky4d43d3c2008-04-25 16:53:59 +00001639 if (BB->hasName()) { // Print out the label if it exists...
Chris Lattner033935d2008-08-17 04:40:13 +00001640 Out << "\n";
Daniel Dunbare03eecb2009-07-25 23:55:21 +00001641 PrintLLVMName(Out, BB->getName(), LabelPrefix);
Chris Lattner033935d2008-08-17 04:40:13 +00001642 Out << ':';
Nick Lewycky4d43d3c2008-04-25 16:53:59 +00001643 } else if (!BB->use_empty()) { // Don't print block # of no uses...
Chris Lattner67bec132008-04-21 04:20:33 +00001644 Out << "\n; <label>:";
Chris Lattner5e043322007-01-11 03:54:27 +00001645 int Slot = Machine.getLocalSlot(BB);
Chris Lattner757ee0b2004-06-09 19:41:19 +00001646 if (Slot != -1)
Misha Brukmana6619a92004-06-21 21:53:56 +00001647 Out << Slot;
Chris Lattner757ee0b2004-06-09 19:41:19 +00001648 else
Misha Brukmana6619a92004-06-21 21:53:56 +00001649 Out << "<badref>";
Chris Lattner58185f22002-10-02 19:38:55 +00001650 }
Chris Lattner2447ef52003-11-20 00:09:43 +00001651
Dan Gohmane2745262009-08-12 17:23:50 +00001652 if (BB->getParent() == 0) {
Chris Lattneree97b8b2009-08-17 15:48:08 +00001653 Out.PadToColumn(50);
Dan Gohmane2745262009-08-12 17:23:50 +00001654 Out << "; Error: Block without parent!";
1655 } else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
Chris Lattnerff834c02008-04-22 02:45:44 +00001656 // Output predecessors for the block...
Chris Lattneree97b8b2009-08-17 15:48:08 +00001657 Out.PadToColumn(50);
Dan Gohmane2745262009-08-12 17:23:50 +00001658 Out << ";";
Chris Lattnerff834c02008-04-22 02:45:44 +00001659 pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001660
Chris Lattnerff834c02008-04-22 02:45:44 +00001661 if (PI == PE) {
1662 Out << " No predecessors!";
1663 } else {
Dan Gohman81313fd2008-09-14 17:21:12 +00001664 Out << " preds = ";
Chris Lattnerff834c02008-04-22 02:45:44 +00001665 writeOperand(*PI, false);
1666 for (++PI; PI != PE; ++PI) {
Dan Gohman81313fd2008-09-14 17:21:12 +00001667 Out << ", ";
Chris Lattner78e2e8b2006-12-06 06:24:27 +00001668 writeOperand(*PI, false);
Chris Lattner00211f12003-11-16 22:59:57 +00001669 }
Chris Lattner58185f22002-10-02 19:38:55 +00001670 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001671 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00001672
Chris Lattnerff834c02008-04-22 02:45:44 +00001673 Out << "\n";
Chris Lattner2f7c9632001-06-06 20:29:01 +00001674
Misha Brukmana6619a92004-06-21 21:53:56 +00001675 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
Chris Lattner8339f7d2003-10-30 23:41:03 +00001676
Chris Lattnerfee714f2001-09-07 16:36:04 +00001677 // Output all of the instructions in the basic block...
Dan Gohmana4f709e2009-07-13 18:27:59 +00001678 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
Chris Lattner113f4f42002-06-25 16:13:24 +00001679 printInstruction(*I);
Dan Gohmana4f709e2009-07-13 18:27:59 +00001680 Out << '\n';
1681 }
Chris Lattner96cdd272004-03-08 18:51:45 +00001682
Misha Brukmana6619a92004-06-21 21:53:56 +00001683 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001684}
1685
Chris Lattner862e3382001-10-13 06:42:36 +00001686
Misha Brukmanc566ca362004-03-02 00:22:19 +00001687/// printInfoComment - Print a little comment after the instruction indicating
1688/// which slot it occupies.
1689///
Chris Lattner113f4f42002-06-25 16:13:24 +00001690void AssemblyWriter::printInfoComment(const Value &V) {
Chris Lattner031560c2009-12-29 07:25:48 +00001691 if (V.getType()->isVoidTy()) return;
1692
1693 Out.PadToColumn(50);
1694 Out << "; <";
1695 TypePrinter.print(V.getType(), Out);
1696 Out << "> [#uses=" << V.getNumUses() << ']'; // Output # uses
Chris Lattner862e3382001-10-13 06:42:36 +00001697}
1698
Reid Spencere7141c82006-08-28 01:02:49 +00001699// This member is called for each Instruction in a function..
Chris Lattner113f4f42002-06-25 16:13:24 +00001700void AssemblyWriter::printInstruction(const Instruction &I) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001701 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
Chris Lattner8339f7d2003-10-30 23:41:03 +00001702
Dan Gohman466876b2009-08-12 23:32:33 +00001703 // Print out indentation for an instruction.
Dan Gohmanb4583b12009-08-13 01:41:52 +00001704 Out << " ";
Chris Lattner2f7c9632001-06-06 20:29:01 +00001705
1706 // Print out name if it exists...
Chris Lattner033935d2008-08-17 04:40:13 +00001707 if (I.hasName()) {
1708 PrintLLVMName(Out, &I);
1709 Out << " = ";
Chris Lattner031560c2009-12-29 07:25:48 +00001710 } else if (!I.getType()->isVoidTy()) {
Chris Lattnerb25e5ea2008-08-29 17:19:30 +00001711 // Print out the def slot taken.
1712 int SlotNum = Machine.getLocalSlot(&I);
1713 if (SlotNum == -1)
1714 Out << "<badref> = ";
1715 else
1716 Out << '%' << SlotNum << " = ";
Chris Lattner033935d2008-08-17 04:40:13 +00001717 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001718
Chris Lattner06038452005-05-06 05:51:46 +00001719 // If this is a volatile load or store, print out the volatile marker.
Chris Lattner504f9242003-09-08 17:45:59 +00001720 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
Chris Lattner06038452005-05-06 05:51:46 +00001721 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile())) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001722 Out << "volatile ";
Chris Lattner06038452005-05-06 05:51:46 +00001723 } else if (isa<CallInst>(I) && cast<CallInst>(I).isTailCall()) {
1724 // If this is a call, check if it's a tail call.
1725 Out << "tail ";
1726 }
Chris Lattner504f9242003-09-08 17:45:59 +00001727
Chris Lattner2f7c9632001-06-06 20:29:01 +00001728 // Print out the opcode...
Misha Brukmana6619a92004-06-21 21:53:56 +00001729 Out << I.getOpcodeName();
Chris Lattner2f7c9632001-06-06 20:29:01 +00001730
Dan Gohman9c7f8082009-07-27 16:11:46 +00001731 // Print out optimization information.
1732 WriteOptimizationInfo(Out, &I);
1733
Reid Spencer45e52392006-12-03 06:27:29 +00001734 // Print out the compare instruction predicates
Nate Begemand2195702008-05-12 19:01:56 +00001735 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
Chris Lattner82ff9232008-08-23 22:52:27 +00001736 Out << ' ' << getPredicateText(CI->getPredicate());
Reid Spencer45e52392006-12-03 06:27:29 +00001737
Chris Lattner2f7c9632001-06-06 20:29:01 +00001738 // Print out the type of the operands...
Chris Lattner113f4f42002-06-25 16:13:24 +00001739 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
Chris Lattner2f7c9632001-06-06 20:29:01 +00001740
1741 // Special case conditional branches to swizzle the condition out to the front
Gabor Greifcab008f2009-02-09 15:45:06 +00001742 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
1743 BranchInst &BI(cast<BranchInst>(I));
Dan Gohman81313fd2008-09-14 17:21:12 +00001744 Out << ' ';
Gabor Greifcab008f2009-02-09 15:45:06 +00001745 writeOperand(BI.getCondition(), true);
Dan Gohman81313fd2008-09-14 17:21:12 +00001746 Out << ", ";
Gabor Greifcab008f2009-02-09 15:45:06 +00001747 writeOperand(BI.getSuccessor(0), true);
Dan Gohman81313fd2008-09-14 17:21:12 +00001748 Out << ", ";
Gabor Greifcab008f2009-02-09 15:45:06 +00001749 writeOperand(BI.getSuccessor(1), true);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001750
Chris Lattner8d48df22002-04-13 18:34:38 +00001751 } else if (isa<SwitchInst>(I)) {
Chris Lattner3ed871f2009-10-27 19:13:16 +00001752 // Special case switch instruction to get formatting nice and correct.
Dan Gohman81313fd2008-09-14 17:21:12 +00001753 Out << ' ';
Chris Lattner82ff9232008-08-23 22:52:27 +00001754 writeOperand(Operand , true);
Dan Gohman81313fd2008-09-14 17:21:12 +00001755 Out << ", ";
Chris Lattner82ff9232008-08-23 22:52:27 +00001756 writeOperand(I.getOperand(1), true);
1757 Out << " [";
Chris Lattner2f7c9632001-06-06 20:29:01 +00001758
Chris Lattner113f4f42002-06-25 16:13:24 +00001759 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
Dan Gohmanb4583b12009-08-13 01:41:52 +00001760 Out << "\n ";
Chris Lattner82ff9232008-08-23 22:52:27 +00001761 writeOperand(I.getOperand(op ), true);
Dan Gohman81313fd2008-09-14 17:21:12 +00001762 Out << ", ";
Chris Lattner113f4f42002-06-25 16:13:24 +00001763 writeOperand(I.getOperand(op+1), true);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001764 }
Dan Gohmanb4583b12009-08-13 01:41:52 +00001765 Out << "\n ]";
Chris Lattnerd04cb6d2009-10-28 00:19:10 +00001766 } else if (isa<IndirectBrInst>(I)) {
1767 // Special case indirectbr instruction to get formatting nice and correct.
Chris Lattner3ed871f2009-10-27 19:13:16 +00001768 Out << ' ';
1769 writeOperand(Operand, true);
Dan Gohman43c57402009-10-30 02:01:10 +00001770 Out << ", [";
Chris Lattner3ed871f2009-10-27 19:13:16 +00001771
1772 for (unsigned i = 1, e = I.getNumOperands(); i != e; ++i) {
1773 if (i != 1)
1774 Out << ", ";
1775 writeOperand(I.getOperand(i), true);
1776 }
1777 Out << ']';
Chris Lattnerda558102001-10-02 03:41:24 +00001778 } else if (isa<PHINode>(I)) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001779 Out << ' ';
Chris Lattnere101c442009-02-28 21:26:53 +00001780 TypePrinter.print(I.getType(), Out);
Misha Brukmana6619a92004-06-21 21:53:56 +00001781 Out << ' ';
Chris Lattner2f7c9632001-06-06 20:29:01 +00001782
Chris Lattner113f4f42002-06-25 16:13:24 +00001783 for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001784 if (op) Out << ", ";
Dan Gohman81313fd2008-09-14 17:21:12 +00001785 Out << "[ ";
1786 writeOperand(I.getOperand(op ), false); Out << ", ";
Misha Brukmana6619a92004-06-21 21:53:56 +00001787 writeOperand(I.getOperand(op+1), false); Out << " ]";
Chris Lattner931ef3b2001-06-11 15:04:20 +00001788 }
Dan Gohmana76f0f72008-05-31 19:12:39 +00001789 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
Dan Gohman81313fd2008-09-14 17:21:12 +00001790 Out << ' ';
Dan Gohmana76f0f72008-05-31 19:12:39 +00001791 writeOperand(I.getOperand(0), true);
1792 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
1793 Out << ", " << *i;
1794 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
Dan Gohman81313fd2008-09-14 17:21:12 +00001795 Out << ' ';
1796 writeOperand(I.getOperand(0), true); Out << ", ";
Dan Gohmana76f0f72008-05-31 19:12:39 +00001797 writeOperand(I.getOperand(1), true);
1798 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
1799 Out << ", " << *i;
Devang Patel59643e52008-02-23 00:35:18 +00001800 } else if (isa<ReturnInst>(I) && !Operand) {
1801 Out << " void";
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001802 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
1803 // Print the calling convention being used.
1804 switch (CI->getCallingConv()) {
1805 case CallingConv::C: break; // default
Chris Lattner29d20852006-05-19 21:58:52 +00001806 case CallingConv::Fast: Out << " fastcc"; break;
1807 case CallingConv::Cold: Out << " coldcc"; break;
Chris Lattnerf5270372007-11-18 18:32:16 +00001808 case CallingConv::X86_StdCall: Out << " x86_stdcallcc"; break;
Anton Korobeynikova8fd40b2009-06-16 18:50:49 +00001809 case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
1810 case CallingConv::ARM_APCS: Out << " arm_apcscc "; break;
1811 case CallingConv::ARM_AAPCS: Out << " arm_aapcscc "; break;
1812 case CallingConv::ARM_AAPCS_VFP:Out << " arm_aapcs_vfpcc "; break;
Anton Korobeynikov27a0ecf2009-12-07 02:27:35 +00001813 case CallingConv::MSP430_INTR: Out << " msp430_intrcc "; break;
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001814 default: Out << " cc" << CI->getCallingConv(); break;
1815 }
1816
Reid Spencer1517de32007-04-09 06:10:42 +00001817 const PointerType *PTy = cast<PointerType>(Operand->getType());
1818 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1819 const Type *RetTy = FTy->getReturnType();
Devang Patel4c758ea2008-09-25 21:00:45 +00001820 const AttrListPtr &PAL = CI->getAttributes();
Chris Lattner2f2d9472001-11-06 21:28:12 +00001821
Devang Patel221fe422008-09-29 20:49:50 +00001822 if (PAL.getRetAttributes() != Attribute::None)
1823 Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1824
Chris Lattner463d6a52003-08-05 15:34:45 +00001825 // If possible, print out the short form of the call instruction. We can
Chris Lattner6915f8f2002-04-07 22:49:37 +00001826 // only do this if the first argument is a pointer to a nonvararg function,
Chris Lattner463d6a52003-08-05 15:34:45 +00001827 // and if the return type is not a pointer to a function.
Chris Lattner2f2d9472001-11-06 21:28:12 +00001828 //
Dan Gohman81313fd2008-09-14 17:21:12 +00001829 Out << ' ';
Chris Lattner463d6a52003-08-05 15:34:45 +00001830 if (!FTy->isVarArg() &&
Misha Brukmanb1c93172005-04-21 23:48:37 +00001831 (!isa<PointerType>(RetTy) ||
Chris Lattnerd9a36a62002-07-25 20:58:51 +00001832 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
Chris Lattnere101c442009-02-28 21:26:53 +00001833 TypePrinter.print(RetTy, Out);
Dan Gohman81313fd2008-09-14 17:21:12 +00001834 Out << ' ';
Chris Lattner2f2d9472001-11-06 21:28:12 +00001835 writeOperand(Operand, false);
1836 } else {
1837 writeOperand(Operand, true);
1838 }
Misha Brukmana6619a92004-06-21 21:53:56 +00001839 Out << '(';
Reid Spencer8c4914c2006-12-31 05:24:50 +00001840 for (unsigned op = 1, Eop = I.getNumOperands(); op < Eop; ++op) {
1841 if (op > 1)
Dan Gohman81313fd2008-09-14 17:21:12 +00001842 Out << ", ";
Devang Patela05633e2008-09-26 22:53:05 +00001843 writeParamOperand(I.getOperand(op), PAL.getParamAttributes(op));
Chris Lattner2f7c9632001-06-06 20:29:01 +00001844 }
Dan Gohman81313fd2008-09-14 17:21:12 +00001845 Out << ')';
Devang Patela05633e2008-09-26 22:53:05 +00001846 if (PAL.getFnAttributes() != Attribute::None)
1847 Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
Chris Lattner113f4f42002-06-25 16:13:24 +00001848 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
Reid Spencer1517de32007-04-09 06:10:42 +00001849 const PointerType *PTy = cast<PointerType>(Operand->getType());
1850 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1851 const Type *RetTy = FTy->getReturnType();
Devang Patel4c758ea2008-09-25 21:00:45 +00001852 const AttrListPtr &PAL = II->getAttributes();
Chris Lattner463d6a52003-08-05 15:34:45 +00001853
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001854 // Print the calling convention being used.
1855 switch (II->getCallingConv()) {
1856 case CallingConv::C: break; // default
Chris Lattner29d20852006-05-19 21:58:52 +00001857 case CallingConv::Fast: Out << " fastcc"; break;
1858 case CallingConv::Cold: Out << " coldcc"; break;
Dan Gohman81313fd2008-09-14 17:21:12 +00001859 case CallingConv::X86_StdCall: Out << " x86_stdcallcc"; break;
1860 case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
Anton Korobeynikova8fd40b2009-06-16 18:50:49 +00001861 case CallingConv::ARM_APCS: Out << " arm_apcscc "; break;
1862 case CallingConv::ARM_AAPCS: Out << " arm_aapcscc "; break;
1863 case CallingConv::ARM_AAPCS_VFP:Out << " arm_aapcs_vfpcc "; break;
Anton Korobeynikov27a0ecf2009-12-07 02:27:35 +00001864 case CallingConv::MSP430_INTR: Out << " msp430_intrcc "; break;
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001865 default: Out << " cc" << II->getCallingConv(); break;
1866 }
1867
Devang Patel221fe422008-09-29 20:49:50 +00001868 if (PAL.getRetAttributes() != Attribute::None)
1869 Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1870
Chris Lattner463d6a52003-08-05 15:34:45 +00001871 // If possible, print out the short form of the invoke instruction. We can
1872 // only do this if the first argument is a pointer to a nonvararg function,
1873 // and if the return type is not a pointer to a function.
1874 //
Dan Gohmanc7e00ba2008-10-15 18:02:08 +00001875 Out << ' ';
Chris Lattner463d6a52003-08-05 15:34:45 +00001876 if (!FTy->isVarArg() &&
Misha Brukmanb1c93172005-04-21 23:48:37 +00001877 (!isa<PointerType>(RetTy) ||
Chris Lattner463d6a52003-08-05 15:34:45 +00001878 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
Chris Lattnere101c442009-02-28 21:26:53 +00001879 TypePrinter.print(RetTy, Out);
Dan Gohmanc7e00ba2008-10-15 18:02:08 +00001880 Out << ' ';
Chris Lattner463d6a52003-08-05 15:34:45 +00001881 writeOperand(Operand, false);
1882 } else {
1883 writeOperand(Operand, true);
1884 }
Misha Brukmana6619a92004-06-21 21:53:56 +00001885 Out << '(';
Gabor Greif2d60e1e2009-09-03 02:02:59 +00001886 for (unsigned op = 3, Eop = I.getNumOperands(); op < Eop; ++op) {
1887 if (op > 3)
Dan Gohman81313fd2008-09-14 17:21:12 +00001888 Out << ", ";
Gabor Greif2d60e1e2009-09-03 02:02:59 +00001889 writeParamOperand(I.getOperand(op), PAL.getParamAttributes(op-2));
Chris Lattner862e3382001-10-13 06:42:36 +00001890 }
1891
Dan Gohman81313fd2008-09-14 17:21:12 +00001892 Out << ')';
Devang Patela05633e2008-09-26 22:53:05 +00001893 if (PAL.getFnAttributes() != Attribute::None)
1894 Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
1895
Dan Gohmanb4583b12009-08-13 01:41:52 +00001896 Out << "\n to ";
Chris Lattner862e3382001-10-13 06:42:36 +00001897 writeOperand(II->getNormalDest(), true);
Dan Gohman81313fd2008-09-14 17:21:12 +00001898 Out << " unwind ";
Chris Lattnerfae8ab32004-02-08 21:44:31 +00001899 writeOperand(II->getUnwindDest(), true);
Chris Lattner862e3382001-10-13 06:42:36 +00001900
Victor Hernandez8acf2952009-10-23 21:09:37 +00001901 } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001902 Out << ' ';
Chris Lattnere101c442009-02-28 21:26:53 +00001903 TypePrinter.print(AI->getType()->getElementType(), Out);
Dan Gohmanb53e26c2009-07-31 18:23:24 +00001904 if (!AI->getArraySize() || AI->isArrayAllocation()) {
Dan Gohman81313fd2008-09-14 17:21:12 +00001905 Out << ", ";
Chris Lattner8d48df22002-04-13 18:34:38 +00001906 writeOperand(AI->getArraySize(), true);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001907 }
Nate Begeman848622f2005-11-05 09:21:28 +00001908 if (AI->getAlignment()) {
Chris Lattner7aeee3a2005-11-05 21:20:34 +00001909 Out << ", align " << AI->getAlignment();
Nate Begeman848622f2005-11-05 09:21:28 +00001910 }
Chris Lattner862e3382001-10-13 06:42:36 +00001911 } else if (isa<CastInst>(I)) {
Dan Gohman81313fd2008-09-14 17:21:12 +00001912 if (Operand) {
1913 Out << ' ';
1914 writeOperand(Operand, true); // Work with broken code
1915 }
Misha Brukmana6619a92004-06-21 21:53:56 +00001916 Out << " to ";
Chris Lattnere101c442009-02-28 21:26:53 +00001917 TypePrinter.print(I.getType(), Out);
Chris Lattner5b337482003-10-18 05:57:43 +00001918 } else if (isa<VAArgInst>(I)) {
Dan Gohman81313fd2008-09-14 17:21:12 +00001919 if (Operand) {
1920 Out << ' ';
1921 writeOperand(Operand, true); // Work with broken code
1922 }
Misha Brukmana6619a92004-06-21 21:53:56 +00001923 Out << ", ";
Chris Lattnere101c442009-02-28 21:26:53 +00001924 TypePrinter.print(I.getType(), Out);
1925 } else if (Operand) { // Print the normal way.
Chris Lattner2f7c9632001-06-06 20:29:01 +00001926
Misha Brukmanb1c93172005-04-21 23:48:37 +00001927 // PrintAllTypes - Instructions who have operands of all the same type
Chris Lattner2f7c9632001-06-06 20:29:01 +00001928 // omit the type from all but the first operand. If the instruction has
1929 // different type operands (for example br), then they are all printed.
1930 bool PrintAllTypes = false;
1931 const Type *TheType = Operand->getType();
Chris Lattner2f7c9632001-06-06 20:29:01 +00001932
Reid Spencer0cdd04f2007-02-02 13:54:55 +00001933 // Select, Store and ShuffleVector always print all types.
Devang Patelce556d92008-03-04 22:05:14 +00001934 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
1935 || isa<ReturnInst>(I)) {
Chris Lattnerdeccfaf2003-04-16 20:20:02 +00001936 PrintAllTypes = true;
1937 } else {
1938 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
1939 Operand = I.getOperand(i);
Nuno Lopes04fe2f02009-01-15 18:40:57 +00001940 // note that Operand shouldn't be null, but the test helps make dump()
1941 // more tolerant of malformed IR
Nuno Lopes0971e772009-01-14 17:51:41 +00001942 if (Operand && Operand->getType() != TheType) {
Chris Lattnerdeccfaf2003-04-16 20:20:02 +00001943 PrintAllTypes = true; // We have differing types! Print them all!
1944 break;
1945 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001946 }
1947 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00001948
Chris Lattner7bfee412001-10-29 16:05:51 +00001949 if (!PrintAllTypes) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001950 Out << ' ';
Chris Lattnere101c442009-02-28 21:26:53 +00001951 TypePrinter.print(TheType, Out);
Chris Lattner7bfee412001-10-29 16:05:51 +00001952 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001953
Dan Gohman81313fd2008-09-14 17:21:12 +00001954 Out << ' ';
Chris Lattner113f4f42002-06-25 16:13:24 +00001955 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
Dan Gohman81313fd2008-09-14 17:21:12 +00001956 if (i) Out << ", ";
Chris Lattner113f4f42002-06-25 16:13:24 +00001957 writeOperand(I.getOperand(i), PrintAllTypes);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001958 }
1959 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001960
Chris Lattnerc9558df2009-12-28 20:10:43 +00001961 // Print post operand alignment for load/store.
Christopher Lamb84485702007-04-22 19:24:39 +00001962 if (isa<LoadInst>(I) && cast<LoadInst>(I).getAlignment()) {
1963 Out << ", align " << cast<LoadInst>(I).getAlignment();
1964 } else if (isa<StoreInst>(I) && cast<StoreInst>(I).getAlignment()) {
1965 Out << ", align " << cast<StoreInst>(I).getAlignment();
1966 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001967
Chris Lattnerc9558df2009-12-28 20:10:43 +00001968 // Print Metadata info.
Devang Patelbcdb0252009-10-07 16:37:55 +00001969 if (!MDNames.empty()) {
Chris Lattner2f2aa2b2009-12-28 23:41:32 +00001970 SmallVector<std::pair<unsigned, MDNode*>, 4> InstMD;
1971 I.getAllMetadata(InstMD);
1972 for (unsigned i = 0, e = InstMD.size(); i != e; ++i)
1973 Out << ", !" << MDNames[InstMD[i].first]
1974 << " !" << Machine.getMetadataSlot(InstMD[i].second);
Devang Patelbcdb0252009-10-07 16:37:55 +00001975 }
Chris Lattner862e3382001-10-13 06:42:36 +00001976 printInfoComment(I);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001977}
1978
Chris Lattnerbddea6a2009-12-31 02:13:35 +00001979static void WriteMDNodeComment(const MDNode *Node,
1980 formatted_raw_ostream &Out) {
1981 if (Node->getNumOperands() < 1)
1982 return;
1983 ConstantInt *CI = dyn_cast_or_null<ConstantInt>(Node->getOperand(0));
1984 if (!CI) return;
1985 unsigned Val = CI->getZExtValue();
1986 unsigned Tag = Val & ~LLVMDebugVersionMask;
1987 if (Val < LLVMDebugVersion)
1988 return;
1989
1990 Out.PadToColumn(50);
1991 if (Tag == dwarf::DW_TAG_auto_variable)
1992 Out << "; [ DW_TAG_auto_variable ]";
1993 else if (Tag == dwarf::DW_TAG_arg_variable)
1994 Out << "; [ DW_TAG_arg_variable ]";
1995 else if (Tag == dwarf::DW_TAG_return_variable)
1996 Out << "; [ DW_TAG_return_variable ]";
1997 else if (Tag == dwarf::DW_TAG_vector_type)
1998 Out << "; [ DW_TAG_vector_type ]";
1999 else if (Tag == dwarf::DW_TAG_user_base)
2000 Out << "; [ DW_TAG_user_base ]";
2001 else if (const char *TagName = dwarf::TagString(Tag))
2002 Out << "; [ " << TagName << " ]";
2003}
2004
2005void AssemblyWriter::writeAllMDNodes() {
2006 SmallVector<const MDNode *, 16> Nodes;
Chris Lattnercf4a76e2009-12-31 02:20:11 +00002007 Nodes.resize(Machine.mdn_size());
2008 for (SlotTracker::mdn_iterator I = Machine.mdn_begin(), E = Machine.mdn_end();
2009 I != E; ++I)
Chris Lattnerbddea6a2009-12-31 02:13:35 +00002010 Nodes[I->second] = cast<MDNode>(I->first);
2011
2012 for (unsigned i = 0, e = Nodes.size(); i != e; ++i) {
2013 Out << '!' << i << " = metadata ";
2014 const MDNode *Node = Nodes[i];
2015 printMDNodeBody(Node);
2016 }
2017}
2018
2019void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
2020 Out << "!{";
2021 for (unsigned mi = 0, me = Node->getNumOperands(); mi != me; ++mi) {
2022 const Value *V = Node->getOperand(mi);
2023 if (V == 0)
2024 Out << "null";
2025 else if (const MDNode *N = dyn_cast<MDNode>(V)) {
2026 Out << "metadata !" << Machine.getMetadataSlot(N);
2027 } else {
2028 TypePrinter.print(V->getType(), Out);
2029 Out << ' ';
2030 WriteAsOperandInternal(Out, Node->getOperand(mi),
2031 &TypePrinter, &Machine);
2032 }
2033 if (mi + 1 != me)
2034 Out << ", ";
2035 }
2036
2037 Out << "}";
2038 WriteMDNodeComment(Node, Out);
2039 Out << "\n";
2040}
Chris Lattner2f7c9632001-06-06 20:29:01 +00002041
2042//===----------------------------------------------------------------------===//
2043// External Interface declarations
2044//===----------------------------------------------------------------------===//
2045
Dan Gohmane2745262009-08-12 17:23:50 +00002046void Module::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
Chris Lattnere36fd8a2008-08-19 04:26:57 +00002047 SlotTracker SlotTable(this);
Dan Gohmane2745262009-08-12 17:23:50 +00002048 formatted_raw_ostream OS(ROS);
Chris Lattner0c19df42008-08-23 22:23:09 +00002049 AssemblyWriter W(OS, SlotTable, this, AAW);
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +00002050 W.write(this);
Chris Lattner2f7c9632001-06-06 20:29:01 +00002051}
2052
Chris Lattner2ee62d22009-02-28 21:11:05 +00002053void Type::print(raw_ostream &OS) const {
2054 if (this == 0) {
2055 OS << "<null Type>";
2056 return;
2057 }
Chris Lattner92c5c122009-02-28 23:20:19 +00002058 TypePrinting().print(this, OS);
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +00002059}
2060
Dan Gohmane2745262009-08-12 17:23:50 +00002061void Value::print(raw_ostream &ROS, AssemblyAnnotationWriter *AAW) const {
Chris Lattner0c19df42008-08-23 22:23:09 +00002062 if (this == 0) {
Dan Gohman12dad632009-08-12 20:56:03 +00002063 ROS << "printing a <null> value\n";
Chris Lattner0c19df42008-08-23 22:23:09 +00002064 return;
2065 }
Dan Gohman12dad632009-08-12 20:56:03 +00002066 formatted_raw_ostream OS(ROS);
Chris Lattner0c19df42008-08-23 22:23:09 +00002067 if (const Instruction *I = dyn_cast<Instruction>(this)) {
2068 const Function *F = I->getParent() ? I->getParent()->getParent() : 0;
2069 SlotTracker SlotTable(F);
Chris Lattnerbddea6a2009-12-31 02:13:35 +00002070 AssemblyWriter W(OS, SlotTable, getModuleFromVal(F), AAW);
Chris Lattner0c19df42008-08-23 22:23:09 +00002071 W.write(I);
2072 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
2073 SlotTracker SlotTable(BB->getParent());
Chris Lattnerbddea6a2009-12-31 02:13:35 +00002074 AssemblyWriter W(OS, SlotTable, getModuleFromVal(BB), AAW);
Chris Lattner0c19df42008-08-23 22:23:09 +00002075 W.write(BB);
2076 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
2077 SlotTracker SlotTable(GV->getParent());
Dan Gohman6c7a4852009-04-20 16:10:33 +00002078 AssemblyWriter W(OS, SlotTable, GV->getParent(), AAW);
Chris Lattner0c19df42008-08-23 22:23:09 +00002079 W.write(GV);
Devang Patel5546b982009-07-01 20:59:15 +00002080 } else if (const MDNode *N = dyn_cast<MDNode>(this)) {
Chris Lattnerbddea6a2009-12-31 02:13:35 +00002081 SlotTracker SlotTable((Function*)0);
2082 AssemblyWriter W(OS, SlotTable, 0, AAW);
2083 W.printMDNodeBody(N);
Devang Patelb4a4e772009-07-30 00:02:57 +00002084 } else if (const NamedMDNode *N = dyn_cast<NamedMDNode>(this)) {
Chris Lattnerbe2de792009-12-31 01:36:50 +00002085 SlotTracker SlotTable(N->getParent());
Chris Lattner2c48c642009-12-31 01:54:05 +00002086 AssemblyWriter W(OS, SlotTable, N->getParent(), AAW);
2087 W.printNamedMDNode(N);
Chris Lattner0c19df42008-08-23 22:23:09 +00002088 } else if (const Constant *C = dyn_cast<Constant>(this)) {
Chris Lattner92c5c122009-02-28 23:20:19 +00002089 TypePrinting TypePrinter;
Chris Lattnere101c442009-02-28 21:26:53 +00002090 TypePrinter.print(C->getType(), OS);
Chris Lattner2ee62d22009-02-28 21:11:05 +00002091 OS << ' ';
Chris Lattner0f578952009-02-28 20:25:14 +00002092 WriteConstantInt(OS, C, TypePrinter, 0);
Chris Lattner31fcc282009-12-31 01:41:14 +00002093 } else if (isa<InlineAsm>(this) || isa<MDString>(this) ||
2094 isa<Argument>(this)) {
Chris Lattner0c19df42008-08-23 22:23:09 +00002095 WriteAsOperand(OS, this, true, 0);
2096 } else {
Dan Gohmanc0353bf2009-09-23 01:33:16 +00002097 // Otherwise we don't know what it is. Call the virtual function to
2098 // allow a subclass to print itself.
2099 printCustom(OS);
Chris Lattner0c19df42008-08-23 22:23:09 +00002100 }
2101}
2102
Dan Gohmanc0353bf2009-09-23 01:33:16 +00002103// Value::printCustom - subclasses should override this to implement printing.
2104void Value::printCustom(raw_ostream &OS) const {
2105 llvm_unreachable("Unknown value to print out!");
2106}
2107
Chris Lattnerdab942552008-08-25 17:03:15 +00002108// Value::dump - allow easy printing of Values from the debugger.
Dan Gohman4f2fea12009-03-23 15:57:19 +00002109void Value::dump() const { print(errs()); errs() << '\n'; }
Reid Spencer52641832004-05-25 18:14:38 +00002110
Chris Lattnerdab942552008-08-25 17:03:15 +00002111// Type::dump - allow easy printing of Types from the debugger.
Chris Lattner41a83d92008-10-01 20:16:19 +00002112// This one uses type names from the given context module
2113void Type::dump(const Module *Context) const {
2114 WriteTypeSymbolic(errs(), this, Context);
2115 errs() << '\n';
Chris Lattner41a83d92008-10-01 20:16:19 +00002116}
2117
Chris Lattner24025262009-02-28 21:05:51 +00002118// Type::dump - allow easy printing of Types from the debugger.
2119void Type::dump() const { dump(0); }
2120
Chris Lattnerdab942552008-08-25 17:03:15 +00002121// Module::dump() - Allow printing of Modules from the debugger.
Dan Gohman4f2fea12009-03-23 15:57:19 +00002122void Module::dump() const { print(errs(), 0); }