blob: 8e0efd0e55158c4a9f38466345e654e03a854d79 [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"
Vikram S. Adveb952b542002-07-14 23:14:45 +000024#include "llvm/Instruction.h"
Misha Brukman2d3fa9e2004-07-29 16:53:53 +000025#include "llvm/Instructions.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 Lattnera204d412008-08-17 17:25:25 +000029#include "llvm/ADT/DenseMap.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"
Jim Laskeyb74c6662005-08-17 19:34:49 +000033#include "llvm/Support/MathExtras.h"
Chris Lattner393b7cd2008-08-17 04:17:45 +000034#include "llvm/Support/raw_ostream.h"
Chris Lattnerfee714f2001-09-07 16:36:04 +000035#include <algorithm>
Reid Spencerbdf03b42007-05-22 19:27:35 +000036#include <cctype>
Chris Lattner189d19f2003-11-21 20:23:48 +000037using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000038
Reid Spencer294715b2005-05-15 16:13:11 +000039// Make virtual table appear in this compilation unit.
40AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
41
Chris Lattner3eee99c2008-08-19 04:36:02 +000042//===----------------------------------------------------------------------===//
43// Helper Functions
44//===----------------------------------------------------------------------===//
45
46static const Module *getModuleFromVal(const Value *V) {
47 if (const Argument *MA = dyn_cast<Argument>(V))
48 return MA->getParent() ? MA->getParent()->getParent() : 0;
49
50 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
51 return BB->getParent() ? BB->getParent()->getParent() : 0;
52
53 if (const Instruction *I = dyn_cast<Instruction>(V)) {
54 const Function *M = I->getParent() ? I->getParent()->getParent() : 0;
55 return M ? M->getParent() : 0;
56 }
57
58 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
59 return GV->getParent();
60 return 0;
61}
62
Daniel Dunbardb0b70a2008-10-28 19:33:02 +000063// PrintEscapedString - Print each character of the specified string, escaping
64// it if it is not printable or if it is an escape char.
65static void PrintEscapedString(const char *Str, unsigned Length,
66 raw_ostream &Out) {
67 for (unsigned i = 0; i != Length; ++i) {
68 unsigned char C = Str[i];
69 if (isprint(C) && C != '\\' && C != '"' && isprint(C))
70 Out << C;
71 else
72 Out << '\\' << hexdigit(C >> 4) << hexdigit(C & 0x0F);
73 }
74}
75
76// PrintEscapedString - Print each character of the specified string, escaping
77// it if it is not printable or if it is an escape char.
78static void PrintEscapedString(const std::string &Str, raw_ostream &Out) {
79 PrintEscapedString(Str.c_str(), Str.size(), Out);
80}
81
Chris Lattner3eee99c2008-08-19 04:36:02 +000082enum PrefixType {
83 GlobalPrefix,
84 LabelPrefix,
Daniel Dunbar389529a2008-10-14 23:28:09 +000085 LocalPrefix,
86 NoPrefix
Chris Lattner3eee99c2008-08-19 04:36:02 +000087};
88
89/// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
90/// prefixed with % (if the string only contains simple characters) or is
91/// surrounded with ""'s (if it has special chars in it). Print it out.
Chris Lattner0c19df42008-08-23 22:23:09 +000092static void PrintLLVMName(raw_ostream &OS, const char *NameStr,
Chris Lattner1508d3f2008-08-19 05:16:28 +000093 unsigned NameLen, PrefixType Prefix) {
94 assert(NameStr && "Cannot get empty name!");
Chris Lattner3eee99c2008-08-19 04:36:02 +000095 switch (Prefix) {
Chris Lattner1508d3f2008-08-19 05:16:28 +000096 default: assert(0 && "Bad prefix!");
Daniel Dunbar389529a2008-10-14 23:28:09 +000097 case NoPrefix: break;
Chris Lattner1508d3f2008-08-19 05:16:28 +000098 case GlobalPrefix: OS << '@'; break;
99 case LabelPrefix: break;
100 case LocalPrefix: OS << '%'; break;
Chris Lattner3eee99c2008-08-19 04:36:02 +0000101 }
102
103 // Scan the name to see if it needs quotes first.
Daniel Dunbardb0b70a2008-10-28 19:33:02 +0000104 bool NeedsQuotes = isdigit(NameStr[0]);
Chris Lattner3eee99c2008-08-19 04:36:02 +0000105 if (!NeedsQuotes) {
106 for (unsigned i = 0; i != NameLen; ++i) {
107 char C = NameStr[i];
108 if (!isalnum(C) && C != '-' && C != '.' && C != '_') {
109 NeedsQuotes = true;
110 break;
111 }
112 }
113 }
114
115 // If we didn't need any quotes, just write out the name in one blast.
116 if (!NeedsQuotes) {
117 OS.write(NameStr, NameLen);
118 return;
119 }
120
121 // Okay, we need quotes. Output the quotes and escape any scary characters as
122 // needed.
123 OS << '"';
Daniel Dunbardb0b70a2008-10-28 19:33:02 +0000124 PrintEscapedString(NameStr, NameLen, OS);
Chris Lattner3eee99c2008-08-19 04:36:02 +0000125 OS << '"';
126}
127
128/// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
129/// prefixed with % (if the string only contains simple characters) or is
130/// surrounded with ""'s (if it has special chars in it). Print it out.
Chris Lattner0c19df42008-08-23 22:23:09 +0000131static void PrintLLVMName(raw_ostream &OS, const Value *V) {
Chris Lattner1508d3f2008-08-19 05:16:28 +0000132 PrintLLVMName(OS, V->getNameStart(), V->getNameLen(),
Chris Lattner3eee99c2008-08-19 04:36:02 +0000133 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
134}
135
Chris Lattner0f578952009-02-28 20:25:14 +0000136//===----------------------------------------------------------------------===//
137// TypePrinting Class: Type printing machinery
138//===----------------------------------------------------------------------===//
139
140namespace {
141 /// TypePrinting - Type printing machinery.
142 class TypePrinting {
143 std::map<const Type *, std::string> TypeNames;
144 raw_ostream &OS;
145 public:
146 TypePrinting(const Module *M, raw_ostream &os);
147
148 void print(const Type *Ty);
149 void printAtLeastOneLevel(const Type *Ty);
Chris Lattner765338d2009-02-28 20:34:19 +0000150
151 private:
Chris Lattner40959d02009-02-28 20:49:40 +0000152 void CalcTypeName(const Type *Ty, SmallVectorImpl<const Type *> &TypeStack,
153 raw_ostream &Result);
Chris Lattner0f578952009-02-28 20:25:14 +0000154 };
155} // end anonymous namespace.
156
157TypePrinting::TypePrinting(const Module *M, raw_ostream &os) : OS(os) {
158 if (M == 0) return;
159
160 // If the module has a symbol table, take all global types and stuff their
161 // names into the TypeNames map.
162 const TypeSymbolTable &ST = M->getTypeSymbolTable();
163 for (TypeSymbolTable::const_iterator TI = ST.begin(), E = ST.end();
164 TI != E; ++TI) {
Chris Lattner12734712009-02-28 20:28:50 +0000165 const Type *Ty = cast<Type>(TI->second);
166
Chris Lattner0f578952009-02-28 20:25:14 +0000167 // As a heuristic, don't insert pointer to primitive types, because
168 // they are used too often to have a single useful name.
Chris Lattner12734712009-02-28 20:28:50 +0000169 if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
170 const Type *PETy = PTy->getElementType();
171 if ((PETy->isPrimitiveType() || PETy->isInteger()) &&
172 !isa<OpaqueType>(PETy))
173 continue;
174 }
175
Chris Lattner765338d2009-02-28 20:34:19 +0000176 // Get the name as a string and insert it into TypeNames.
Chris Lattner7b394e82009-02-28 20:31:14 +0000177 std::string NameStr;
178 raw_string_ostream NameOS(NameStr);
179 PrintLLVMName(NameOS, TI->first.c_str(), TI->first.length(), LocalPrefix);
180 TypeNames.insert(std::make_pair(Ty, NameOS.str()));
Chris Lattner0f578952009-02-28 20:25:14 +0000181 }
182}
183
Chris Lattner40959d02009-02-28 20:49:40 +0000184/// CalcTypeName - Write the specified type to the specified raw_ostream, making
185/// use of type names or up references to shorten the type name where possible.
186void TypePrinting::CalcTypeName(const Type *Ty,
Chris Lattner765338d2009-02-28 20:34:19 +0000187 SmallVectorImpl<const Type *> &TypeStack,
Chris Lattner40959d02009-02-28 20:49:40 +0000188 raw_ostream &Result) {
Chris Lattner0f578952009-02-28 20:25:14 +0000189 if (Ty->isInteger() || (Ty->isPrimitiveType() && !isa<OpaqueType>(Ty))) {
Chris Lattner40959d02009-02-28 20:49:40 +0000190 Result << Ty->getDescription(); // Base case
Chris Lattner0f578952009-02-28 20:25:14 +0000191 return;
192 }
193
194 // Check to see if the type is named.
195 std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
Chris Lattnereb23f872009-02-28 20:40:29 +0000196 if (I != TypeNames.end() &&
197 // If the name wasn't temporarily removed use it.
198 !I->second.empty()) {
Chris Lattner40959d02009-02-28 20:49:40 +0000199 Result << I->second;
Chris Lattner0f578952009-02-28 20:25:14 +0000200 return;
201 }
202
203 // Check to see if the Type is already on the stack...
204 unsigned Slot = 0, CurSize = TypeStack.size();
205 while (Slot < CurSize && TypeStack[Slot] != Ty) ++Slot; // Scan for type
206
207 // This is another base case for the recursion. In this case, we know
208 // that we have looped back to a type that we have previously visited.
209 // Generate the appropriate upreference to handle this.
210 if (Slot < CurSize) {
Chris Lattner40959d02009-02-28 20:49:40 +0000211 Result << '\\' << unsigned(CurSize-Slot); // Here's the upreference
Chris Lattner0f578952009-02-28 20:25:14 +0000212 return;
213 }
214
215 TypeStack.push_back(Ty); // Recursive case: Add us to the stack..
216
217 switch (Ty->getTypeID()) {
Chris Lattner07d88292009-02-28 20:35:42 +0000218 case Type::FunctionTyID: {
219 const FunctionType *FTy = cast<FunctionType>(Ty);
Chris Lattner40959d02009-02-28 20:49:40 +0000220 CalcTypeName(FTy->getReturnType(), TypeStack, Result);
221 Result << " (";
Chris Lattner07d88292009-02-28 20:35:42 +0000222 for (FunctionType::param_iterator I = FTy->param_begin(),
223 E = FTy->param_end(); I != E; ++I) {
224 if (I != FTy->param_begin())
Chris Lattner40959d02009-02-28 20:49:40 +0000225 Result << ", ";
226 CalcTypeName(*I, TypeStack, Result);
Chris Lattner0f578952009-02-28 20:25:14 +0000227 }
Chris Lattner07d88292009-02-28 20:35:42 +0000228 if (FTy->isVarArg()) {
Chris Lattner40959d02009-02-28 20:49:40 +0000229 if (FTy->getNumParams()) Result << ", ";
230 Result << "...";
Chris Lattner0f578952009-02-28 20:25:14 +0000231 }
Chris Lattner40959d02009-02-28 20:49:40 +0000232 Result << ')';
Chris Lattner07d88292009-02-28 20:35:42 +0000233 break;
234 }
235 case Type::StructTyID: {
236 const StructType *STy = cast<StructType>(Ty);
237 if (STy->isPacked())
Chris Lattner40959d02009-02-28 20:49:40 +0000238 Result << '<';
239 Result << "{ ";
Chris Lattner07d88292009-02-28 20:35:42 +0000240 for (StructType::element_iterator I = STy->element_begin(),
241 E = STy->element_end(); I != E; ++I) {
Chris Lattner40959d02009-02-28 20:49:40 +0000242 CalcTypeName(*I, TypeStack, Result);
Chris Lattner07d88292009-02-28 20:35:42 +0000243 if (next(I) != STy->element_end())
Chris Lattner40959d02009-02-28 20:49:40 +0000244 Result << ',';
245 Result << ' ';
Chris Lattner0f578952009-02-28 20:25:14 +0000246 }
Chris Lattner40959d02009-02-28 20:49:40 +0000247 Result << '}';
Chris Lattner07d88292009-02-28 20:35:42 +0000248 if (STy->isPacked())
Chris Lattner40959d02009-02-28 20:49:40 +0000249 Result << '>';
Chris Lattner07d88292009-02-28 20:35:42 +0000250 break;
251 }
252 case Type::PointerTyID: {
253 const PointerType *PTy = cast<PointerType>(Ty);
Chris Lattner40959d02009-02-28 20:49:40 +0000254 CalcTypeName(PTy->getElementType(), TypeStack, Result);
Chris Lattner07d88292009-02-28 20:35:42 +0000255 if (unsigned AddressSpace = PTy->getAddressSpace())
Chris Lattner40959d02009-02-28 20:49:40 +0000256 Result << " addrspace(" << AddressSpace << ')';
257 Result << '*';
Chris Lattner07d88292009-02-28 20:35:42 +0000258 break;
259 }
260 case Type::ArrayTyID: {
261 const ArrayType *ATy = cast<ArrayType>(Ty);
Chris Lattner24025262009-02-28 21:05:51 +0000262 Result << '[' << ATy->getNumElements() << " x ";
Chris Lattner40959d02009-02-28 20:49:40 +0000263 CalcTypeName(ATy->getElementType(), TypeStack, Result);
264 Result << ']';
Chris Lattner07d88292009-02-28 20:35:42 +0000265 break;
266 }
267 case Type::VectorTyID: {
268 const VectorType *PTy = cast<VectorType>(Ty);
Chris Lattner40959d02009-02-28 20:49:40 +0000269 Result << "<" << PTy->getNumElements() << " x ";
270 CalcTypeName(PTy->getElementType(), TypeStack, Result);
271 Result << '>';
Chris Lattner07d88292009-02-28 20:35:42 +0000272 break;
273 }
274 case Type::OpaqueTyID:
Chris Lattner40959d02009-02-28 20:49:40 +0000275 Result << "opaque";
Chris Lattner07d88292009-02-28 20:35:42 +0000276 break;
277 default:
Chris Lattner40959d02009-02-28 20:49:40 +0000278 Result << "<unrecognized-type>";
Chris Lattner07d88292009-02-28 20:35:42 +0000279 break;
Chris Lattner0f578952009-02-28 20:25:14 +0000280 }
281
Chris Lattner40959d02009-02-28 20:49:40 +0000282 TypeStack.pop_back(); // Remove self from stack.
Chris Lattner0f578952009-02-28 20:25:14 +0000283}
284
285/// printTypeInt - The internal guts of printing out a type that has a
286/// potentially named portion.
287///
288void TypePrinting::print(const Type *Ty) {
289 // Primitive types always print out their description, regardless of whether
290 // they have been named or not.
291 if (Ty->isInteger() || (Ty->isPrimitiveType() && !isa<OpaqueType>(Ty))) {
292 OS << Ty->getDescription();
293 return;
294 }
295
296 // Check to see if the type is named.
297 std::map<const Type*, std::string>::iterator I = TypeNames.find(Ty);
298 if (I != TypeNames.end()) {
299 OS << I->second;
300 return;
301 }
302
303 // Otherwise we have a type that has not been named but is a derived type.
304 // Carefully recurse the type hierarchy to print out any contained symbolic
305 // names.
Chris Lattner765338d2009-02-28 20:34:19 +0000306 SmallVector<const Type *, 16> TypeStack;
Chris Lattner0f578952009-02-28 20:25:14 +0000307 std::string TypeName;
Chris Lattner40959d02009-02-28 20:49:40 +0000308
309 raw_string_ostream TypeOS(TypeName);
Chris Lattner40959d02009-02-28 20:49:40 +0000310 CalcTypeName(Ty, TypeStack, TypeOS);
311 OS << TypeOS.str();
312
313 // Cache type name for later use.
314 TypeNames.insert(std::make_pair(Ty, TypeOS.str()));
Chris Lattner0f578952009-02-28 20:25:14 +0000315}
316
317/// printAtLeastOneLevel - Print out one level of the possibly complex type
318/// without considering any symbolic types that we may have equal to it.
319void TypePrinting::printAtLeastOneLevel(const Type *Ty) {
Chris Lattnereb23f872009-02-28 20:40:29 +0000320 // If the type does not have a name, then it is already guaranteed to print at
321 // least one level.
Chris Lattner40959d02009-02-28 20:49:40 +0000322 std::map<const Type*, std::string>::iterator I = TypeNames.find(Ty);
Chris Lattnereb23f872009-02-28 20:40:29 +0000323 if (I == TypeNames.end())
324 return print(Ty);
Chris Lattner0f578952009-02-28 20:25:14 +0000325
Chris Lattnereb23f872009-02-28 20:40:29 +0000326 // Otherwise, temporarily remove the name and print it.
327 std::string OldName;
328 std::swap(OldName, I->second);
Chris Lattner40959d02009-02-28 20:49:40 +0000329
330 // Print the type without the name.
Chris Lattnereb23f872009-02-28 20:40:29 +0000331 SmallVector<const Type *, 16> TypeStack;
Chris Lattner40959d02009-02-28 20:49:40 +0000332 CalcTypeName(Ty, TypeStack, OS);
Chris Lattnereb23f872009-02-28 20:40:29 +0000333
334 // Restore the name.
335 std::swap(OldName, I->second);
Chris Lattner0f578952009-02-28 20:25:14 +0000336}
337
338
Chris Lattner0f578952009-02-28 20:25:14 +0000339/// WriteTypeSymbolic - This attempts to write the specified type as a symbolic
340/// type, iff there is an entry in the modules symbol table for the specified
Chris Lattner24025262009-02-28 21:05:51 +0000341/// type or one of it's component types.
Chris Lattner0f578952009-02-28 20:25:14 +0000342///
343void llvm::WriteTypeSymbolic(raw_ostream &Out, const Type *Ty, const Module *M){
Chris Lattner40959d02009-02-28 20:49:40 +0000344 TypePrinting(M, Out).print(Ty);
Chris Lattner0f578952009-02-28 20:25:14 +0000345}
346
Chris Lattner3eee99c2008-08-19 04:36:02 +0000347//===----------------------------------------------------------------------===//
348// SlotTracker Class: Enumerate slot numbers for unnamed values
349//===----------------------------------------------------------------------===//
350
Chris Lattner3ee58762008-08-19 04:28:07 +0000351namespace {
352
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000353/// This class provides computation of slot numbers for LLVM Assembly writing.
Chris Lattner393b7cd2008-08-17 04:17:45 +0000354///
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000355class SlotTracker {
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000356public:
Chris Lattner393b7cd2008-08-17 04:17:45 +0000357 /// ValueMap - A mapping of Values to slot numbers
Chris Lattnera204d412008-08-17 17:25:25 +0000358 typedef DenseMap<const Value*, unsigned> ValueMap;
Chris Lattner393b7cd2008-08-17 04:17:45 +0000359
360private:
361 /// TheModule - The module for which we are holding slot numbers
362 const Module* TheModule;
363
364 /// TheFunction - The function for which we are holding slot numbers
365 const Function* TheFunction;
366 bool FunctionProcessed;
367
368 /// mMap - The TypePlanes map for the module level data
369 ValueMap mMap;
370 unsigned mNext;
371
372 /// fMap - The TypePlanes map for the function level data
373 ValueMap fMap;
374 unsigned fNext;
375
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000376public:
Chris Lattner393b7cd2008-08-17 04:17:45 +0000377 /// Construct from a module
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000378 explicit SlotTracker(const Module *M);
Chris Lattner393b7cd2008-08-17 04:17:45 +0000379 /// Construct from a function, starting out in incorp state.
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000380 explicit SlotTracker(const Function *F);
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000381
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000382 /// Return the slot number of the specified value in it's type
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000383 /// plane. If something is not in the SlotTracker, return -1.
Chris Lattner5e043322007-01-11 03:54:27 +0000384 int getLocalSlot(const Value *V);
385 int getGlobalSlot(const GlobalValue *V);
Reid Spencer8beac692004-06-09 15:26:53 +0000386
Misha Brukmanb1c93172005-04-21 23:48:37 +0000387 /// If you'd like to deal with a function instead of just a module, use
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000388 /// this method to get its data into the SlotTracker.
Misha Brukmanb1c93172005-04-21 23:48:37 +0000389 void incorporateFunction(const Function *F) {
390 TheFunction = F;
Reid Spencerb0ac8c42004-08-16 07:46:33 +0000391 FunctionProcessed = false;
392 }
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000393
Misha Brukmanb1c93172005-04-21 23:48:37 +0000394 /// After calling incorporateFunction, use this method to remove the
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000395 /// most recently incorporated function from the SlotTracker. This
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000396 /// will reset the state of the machine back to just the module contents.
397 void purgeFunction();
398
Chris Lattner393b7cd2008-08-17 04:17:45 +0000399 // Implementation Details
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000400private:
Reid Spencer56010e42004-05-26 21:56:09 +0000401 /// This function does the actual initialization.
402 inline void initialize();
403
Chris Lattnerea862a32007-01-09 07:55:49 +0000404 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
405 void CreateModuleSlot(const GlobalValue *V);
406
407 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
408 void CreateFunctionSlot(const Value *V);
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000409
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000410 /// Add all of the module level global variables (and their initializers)
411 /// and function declarations, but not the contents of those functions.
412 void processModule();
413
Reid Spencer56010e42004-05-26 21:56:09 +0000414 /// Add all of the functions arguments, basic blocks, and instructions
415 void processFunction();
416
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000417 SlotTracker(const SlotTracker &); // DO NOT IMPLEMENT
418 void operator=(const SlotTracker &); // DO NOT IMPLEMENT
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000419};
420
Chris Lattner3ee58762008-08-19 04:28:07 +0000421} // end anonymous namespace
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000422
Chris Lattner3eee99c2008-08-19 04:36:02 +0000423
424static SlotTracker *createSlotTracker(const Value *V) {
425 if (const Argument *FA = dyn_cast<Argument>(V))
426 return new SlotTracker(FA->getParent());
427
428 if (const Instruction *I = dyn_cast<Instruction>(V))
429 return new SlotTracker(I->getParent()->getParent());
430
431 if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
432 return new SlotTracker(BB->getParent());
433
434 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
435 return new SlotTracker(GV->getParent());
436
437 if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
438 return new SlotTracker(GA->getParent());
439
440 if (const Function *Func = dyn_cast<Function>(V))
441 return new SlotTracker(Func);
442
443 return 0;
444}
445
446#if 0
Chris Lattner604e3512008-08-19 04:47:09 +0000447#define ST_DEBUG(X) cerr << X
Chris Lattner3eee99c2008-08-19 04:36:02 +0000448#else
Chris Lattner604e3512008-08-19 04:47:09 +0000449#define ST_DEBUG(X)
Chris Lattner3eee99c2008-08-19 04:36:02 +0000450#endif
451
452// Module level constructor. Causes the contents of the Module (sans functions)
453// to be added to the slot table.
454SlotTracker::SlotTracker(const Module *M)
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000455 : TheModule(M), TheFunction(0), FunctionProcessed(false), mNext(0), fNext(0) {
Chris Lattner3eee99c2008-08-19 04:36:02 +0000456}
457
458// Function level constructor. Causes the contents of the Module and the one
459// function provided to be added to the slot table.
460SlotTracker::SlotTracker(const Function *F)
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000461 : TheModule(F ? F->getParent() : 0), TheFunction(F), FunctionProcessed(false),
462 mNext(0), fNext(0) {
Chris Lattner3eee99c2008-08-19 04:36:02 +0000463}
464
465inline void SlotTracker::initialize() {
466 if (TheModule) {
467 processModule();
468 TheModule = 0; ///< Prevent re-processing next time we're called.
469 }
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000470
Chris Lattner3eee99c2008-08-19 04:36:02 +0000471 if (TheFunction && !FunctionProcessed)
472 processFunction();
473}
474
475// Iterate through all the global variables, functions, and global
476// variable initializers and create slots for them.
477void SlotTracker::processModule() {
Chris Lattner604e3512008-08-19 04:47:09 +0000478 ST_DEBUG("begin processModule!\n");
Chris Lattner3eee99c2008-08-19 04:36:02 +0000479
480 // Add all of the unnamed global variables to the value table.
481 for (Module::const_global_iterator I = TheModule->global_begin(),
482 E = TheModule->global_end(); I != E; ++I)
483 if (!I->hasName())
484 CreateModuleSlot(I);
485
486 // Add all the unnamed functions to the table.
487 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
488 I != E; ++I)
489 if (!I->hasName())
490 CreateModuleSlot(I);
491
Chris Lattner604e3512008-08-19 04:47:09 +0000492 ST_DEBUG("end processModule!\n");
Chris Lattner3eee99c2008-08-19 04:36:02 +0000493}
494
495
496// Process the arguments, basic blocks, and instructions of a function.
497void SlotTracker::processFunction() {
Chris Lattner604e3512008-08-19 04:47:09 +0000498 ST_DEBUG("begin processFunction!\n");
Chris Lattner3eee99c2008-08-19 04:36:02 +0000499 fNext = 0;
500
501 // Add all the function arguments with no names.
502 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
503 AE = TheFunction->arg_end(); AI != AE; ++AI)
504 if (!AI->hasName())
505 CreateFunctionSlot(AI);
506
Chris Lattner604e3512008-08-19 04:47:09 +0000507 ST_DEBUG("Inserting Instructions:\n");
Chris Lattner3eee99c2008-08-19 04:36:02 +0000508
509 // Add all of the basic blocks and instructions with no names.
510 for (Function::const_iterator BB = TheFunction->begin(),
511 E = TheFunction->end(); BB != E; ++BB) {
512 if (!BB->hasName())
513 CreateFunctionSlot(BB);
514 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
515 if (I->getType() != Type::VoidTy && !I->hasName())
516 CreateFunctionSlot(I);
517 }
518
519 FunctionProcessed = true;
520
Chris Lattner604e3512008-08-19 04:47:09 +0000521 ST_DEBUG("end processFunction!\n");
Chris Lattner3eee99c2008-08-19 04:36:02 +0000522}
523
524/// Clean up after incorporating a function. This is the only way to get out of
525/// the function incorporation state that affects get*Slot/Create*Slot. Function
526/// incorporation state is indicated by TheFunction != 0.
527void SlotTracker::purgeFunction() {
Chris Lattner604e3512008-08-19 04:47:09 +0000528 ST_DEBUG("begin purgeFunction!\n");
Chris Lattner3eee99c2008-08-19 04:36:02 +0000529 fMap.clear(); // Simply discard the function level map
530 TheFunction = 0;
531 FunctionProcessed = false;
Chris Lattner604e3512008-08-19 04:47:09 +0000532 ST_DEBUG("end purgeFunction!\n");
Chris Lattner3eee99c2008-08-19 04:36:02 +0000533}
534
535/// getGlobalSlot - Get the slot number of a global value.
536int SlotTracker::getGlobalSlot(const GlobalValue *V) {
537 // Check for uninitialized state and do lazy initialization.
538 initialize();
539
540 // Find the type plane in the module map
541 ValueMap::iterator MI = mMap.find(V);
Dan Gohman1dd27572008-10-01 19:58:59 +0000542 return MI == mMap.end() ? -1 : (int)MI->second;
Chris Lattner3eee99c2008-08-19 04:36:02 +0000543}
544
545
546/// getLocalSlot - Get the slot number for a value that is local to a function.
547int SlotTracker::getLocalSlot(const Value *V) {
548 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
549
550 // Check for uninitialized state and do lazy initialization.
551 initialize();
552
553 ValueMap::iterator FI = fMap.find(V);
Dan Gohman1dd27572008-10-01 19:58:59 +0000554 return FI == fMap.end() ? -1 : (int)FI->second;
Chris Lattner3eee99c2008-08-19 04:36:02 +0000555}
556
557
558/// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
559void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
560 assert(V && "Can't insert a null Value into SlotTracker!");
561 assert(V->getType() != Type::VoidTy && "Doesn't need a slot!");
562 assert(!V->hasName() && "Doesn't need a slot!");
563
564 unsigned DestSlot = mNext++;
565 mMap[V] = DestSlot;
566
Chris Lattner604e3512008-08-19 04:47:09 +0000567 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
Chris Lattner3eee99c2008-08-19 04:36:02 +0000568 DestSlot << " [");
569 // G = Global, F = Function, A = Alias, o = other
Chris Lattner604e3512008-08-19 04:47:09 +0000570 ST_DEBUG((isa<GlobalVariable>(V) ? 'G' :
Chris Lattner3eee99c2008-08-19 04:36:02 +0000571 (isa<Function>(V) ? 'F' :
572 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
573}
574
575
576/// CreateSlot - Create a new slot for the specified value if it has no name.
577void SlotTracker::CreateFunctionSlot(const Value *V) {
578 assert(V->getType() != Type::VoidTy && !V->hasName() &&
579 "Doesn't need a slot!");
580
581 unsigned DestSlot = fNext++;
582 fMap[V] = DestSlot;
583
584 // G = Global, F = Function, o = other
Chris Lattner604e3512008-08-19 04:47:09 +0000585 ST_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
Chris Lattner3eee99c2008-08-19 04:36:02 +0000586 DestSlot << " [o]\n");
587}
588
589
590
591//===----------------------------------------------------------------------===//
592// AsmWriter Implementation
593//===----------------------------------------------------------------------===//
Chris Lattner7f8845a2002-07-23 18:07:49 +0000594
Chris Lattner0c19df42008-08-23 22:23:09 +0000595static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
Chris Lattner0f578952009-02-28 20:25:14 +0000596 TypePrinting &TypePrinter,
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000597 SlotTracker *Machine);
Reid Spencer58d30f22004-07-04 11:50:43 +0000598
Chris Lattner033935d2008-08-17 04:40:13 +0000599
Chris Lattnerb86620e2001-10-29 16:37:48 +0000600
Chris Lattnerfc9f1c92006-12-06 06:40:49 +0000601static const char *getPredicateText(unsigned predicate) {
Reid Spencer812a1be2006-12-04 05:19:18 +0000602 const char * pred = "unknown";
603 switch (predicate) {
604 case FCmpInst::FCMP_FALSE: pred = "false"; break;
605 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
606 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
607 case FCmpInst::FCMP_OGE: pred = "oge"; break;
608 case FCmpInst::FCMP_OLT: pred = "olt"; break;
609 case FCmpInst::FCMP_OLE: pred = "ole"; break;
610 case FCmpInst::FCMP_ONE: pred = "one"; break;
611 case FCmpInst::FCMP_ORD: pred = "ord"; break;
612 case FCmpInst::FCMP_UNO: pred = "uno"; break;
613 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
614 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
615 case FCmpInst::FCMP_UGE: pred = "uge"; break;
616 case FCmpInst::FCMP_ULT: pred = "ult"; break;
617 case FCmpInst::FCMP_ULE: pred = "ule"; break;
618 case FCmpInst::FCMP_UNE: pred = "une"; break;
619 case FCmpInst::FCMP_TRUE: pred = "true"; break;
620 case ICmpInst::ICMP_EQ: pred = "eq"; break;
621 case ICmpInst::ICMP_NE: pred = "ne"; break;
622 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
623 case ICmpInst::ICMP_SGE: pred = "sge"; break;
624 case ICmpInst::ICMP_SLT: pred = "slt"; break;
625 case ICmpInst::ICMP_SLE: pred = "sle"; break;
626 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
627 case ICmpInst::ICMP_UGE: pred = "uge"; break;
628 case ICmpInst::ICMP_ULT: pred = "ult"; break;
629 case ICmpInst::ICMP_ULE: pred = "ule"; break;
630 }
631 return pred;
632}
633
Chris Lattner0c19df42008-08-23 22:23:09 +0000634static void WriteConstantInt(raw_ostream &Out, const Constant *CV,
Chris Lattner0f578952009-02-28 20:25:14 +0000635 TypePrinting &TypePrinter, SlotTracker *Machine) {
Zhou Sheng75b871f2007-01-11 12:24:14 +0000636 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
Chris Lattner17f71652008-08-17 07:19:36 +0000637 if (CI->getType() == Type::Int1Ty) {
Reid Spencercddc9df2007-01-12 04:24:46 +0000638 Out << (CI->getZExtValue() ? "true" : "false");
Chris Lattner17f71652008-08-17 07:19:36 +0000639 return;
640 }
641 Out << CI->getValue();
642 return;
643 }
644
645 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
Dale Johannesen028084e2007-09-12 03:30:33 +0000646 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble ||
647 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle) {
648 // We would like to output the FP constant value in exponential notation,
649 // but we cannot do this if doing so will lose precision. Check here to
650 // make sure that we only output it in exponential format if we can parse
651 // the value back and get the same value.
652 //
Dale Johannesen1f864982009-01-21 20:32:55 +0000653 bool ignored;
Dale Johannesen028084e2007-09-12 03:30:33 +0000654 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
Chris Lattner17f71652008-08-17 07:19:36 +0000655 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
656 CFP->getValueAPF().convertToFloat();
Dale Johannesen028084e2007-09-12 03:30:33 +0000657 std::string StrVal = ftostr(CFP->getValueAPF());
Chris Lattner1e194682002-04-18 18:53:13 +0000658
Dale Johannesen028084e2007-09-12 03:30:33 +0000659 // Check to make sure that the stringized number is not some string like
660 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
661 // that the string matches the "[-+]?[0-9]" regex.
662 //
663 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
664 ((StrVal[0] == '-' || StrVal[0] == '+') &&
665 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
666 // Reparse stringized version!
667 if (atof(StrVal.c_str()) == Val) {
668 Out << StrVal;
669 return;
670 }
Chris Lattner1e194682002-04-18 18:53:13 +0000671 }
Dale Johannesen028084e2007-09-12 03:30:33 +0000672 // Otherwise we could not reparse it to exactly the same value, so we must
Dale Johannesen1f864982009-01-21 20:32:55 +0000673 // output the string in hexadecimal format! Note that loading and storing
674 // floating point types changes the bits of NaNs on some hosts, notably
675 // x86, so we must not use these types.
Dale Johannesen028084e2007-09-12 03:30:33 +0000676 assert(sizeof(double) == sizeof(uint64_t) &&
677 "assuming that double is 64 bits!");
Chris Lattner5505eed2008-11-10 04:30:26 +0000678 char Buffer[40];
Dale Johannesen1f864982009-01-21 20:32:55 +0000679 APFloat apf = CFP->getValueAPF();
680 // Floats are represented in ASCII IR as double, convert.
681 if (!isDouble)
682 apf.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
683 &ignored);
684 Out << "0x" <<
685 utohex_buffer(uint64_t(apf.bitcastToAPInt().getZExtValue()),
686 Buffer+40);
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000687 return;
688 }
689
690 // Some form of long double. These appear as a magic letter identifying
691 // the type, then a fixed number of hex digits.
692 Out << "0x";
693 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended)
694 Out << 'K';
695 else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad)
696 Out << 'L';
697 else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble)
698 Out << 'M';
699 else
700 assert(0 && "Unsupported floating point type");
701 // api needed to prevent premature destruction
Dale Johannesen54306fe2008-10-09 18:53:47 +0000702 APInt api = CFP->getValueAPF().bitcastToAPInt();
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000703 const uint64_t* p = api.getRawData();
704 uint64_t word = *p;
705 int shiftcount=60;
706 int width = api.getBitWidth();
707 for (int j=0; j<width; j+=4, shiftcount-=4) {
708 unsigned int nibble = (word>>shiftcount) & 15;
709 if (nibble < 10)
710 Out << (unsigned char)(nibble + '0');
Dale Johannesen028084e2007-09-12 03:30:33 +0000711 else
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000712 Out << (unsigned char)(nibble - 10 + 'A');
713 if (shiftcount == 0 && j+4 < width) {
714 word = *(++p);
715 shiftcount = 64;
716 if (width-j-4 < 64)
717 shiftcount = width-j-4;
Dale Johannesen028084e2007-09-12 03:30:33 +0000718 }
719 }
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000720 return;
721 }
722
723 if (isa<ConstantAggregateZero>(CV)) {
Chris Lattner76b2ff42004-02-15 05:55:15 +0000724 Out << "zeroinitializer";
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000725 return;
726 }
727
728 if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
Chris Lattner1e194682002-04-18 18:53:13 +0000729 // As a special case, print the array as a string if it is an array of
Dan Gohmane9bc2ba2008-05-12 16:34:30 +0000730 // i8 with ConstantInt values.
Misha Brukmanb1c93172005-04-21 23:48:37 +0000731 //
Chris Lattner1e194682002-04-18 18:53:13 +0000732 const Type *ETy = CA->getType()->getElementType();
Chris Lattner6ed87bd2006-01-23 23:03:36 +0000733 if (CA->isString()) {
Chris Lattner1e194682002-04-18 18:53:13 +0000734 Out << "c\"";
Chris Lattner6ed87bd2006-01-23 23:03:36 +0000735 PrintEscapedString(CA->getAsString(), Out);
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000736 Out << '"';
Chris Lattner1e194682002-04-18 18:53:13 +0000737 } else { // Cannot output in string format...
Misha Brukman21bbdb92004-06-04 21:11:51 +0000738 Out << '[';
Chris Lattnerd84bb632002-04-16 21:36:08 +0000739 if (CA->getNumOperands()) {
Chris Lattner0f578952009-02-28 20:25:14 +0000740 TypePrinter.print(ETy);
Dan Gohman81313fd2008-09-14 17:21:12 +0000741 Out << ' ';
Chris Lattnerd84bb632002-04-16 21:36:08 +0000742 WriteAsOperandInternal(Out, CA->getOperand(0),
Chris Lattner0f578952009-02-28 20:25:14 +0000743 TypePrinter, Machine);
Chris Lattnerd84bb632002-04-16 21:36:08 +0000744 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
745 Out << ", ";
Chris Lattner0f578952009-02-28 20:25:14 +0000746 TypePrinter.print(ETy);
Dan Gohman81313fd2008-09-14 17:21:12 +0000747 Out << ' ';
Chris Lattner0f578952009-02-28 20:25:14 +0000748 WriteAsOperandInternal(Out, CA->getOperand(i), TypePrinter, Machine);
Chris Lattnerd84bb632002-04-16 21:36:08 +0000749 }
750 }
Dan Gohman81313fd2008-09-14 17:21:12 +0000751 Out << ']';
Chris Lattnerd84bb632002-04-16 21:36:08 +0000752 }
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000753 return;
754 }
755
756 if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
Andrew Lenharth0d124b82007-01-08 18:21:30 +0000757 if (CS->getType()->isPacked())
758 Out << '<';
Misha Brukman21bbdb92004-06-04 21:11:51 +0000759 Out << '{';
Jim Laskey3bb78742006-02-25 12:27:03 +0000760 unsigned N = CS->getNumOperands();
761 if (N) {
Chris Lattner604e3512008-08-19 04:47:09 +0000762 Out << ' ';
Chris Lattner0f578952009-02-28 20:25:14 +0000763 TypePrinter.print(CS->getOperand(0)->getType());
Dan Gohman81313fd2008-09-14 17:21:12 +0000764 Out << ' ';
Chris Lattnerd84bb632002-04-16 21:36:08 +0000765
Chris Lattner0f578952009-02-28 20:25:14 +0000766 WriteAsOperandInternal(Out, CS->getOperand(0), TypePrinter, Machine);
Chris Lattnerd84bb632002-04-16 21:36:08 +0000767
Jim Laskey3bb78742006-02-25 12:27:03 +0000768 for (unsigned i = 1; i < N; i++) {
Chris Lattnerd84bb632002-04-16 21:36:08 +0000769 Out << ", ";
Chris Lattner0f578952009-02-28 20:25:14 +0000770 TypePrinter.print(CS->getOperand(i)->getType());
Dan Gohman81313fd2008-09-14 17:21:12 +0000771 Out << ' ';
Chris Lattnerd84bb632002-04-16 21:36:08 +0000772
Chris Lattner0f578952009-02-28 20:25:14 +0000773 WriteAsOperandInternal(Out, CS->getOperand(i), TypePrinter, Machine);
Chris Lattnerd84bb632002-04-16 21:36:08 +0000774 }
Dan Gohman81313fd2008-09-14 17:21:12 +0000775 Out << ' ';
Chris Lattnerd84bb632002-04-16 21:36:08 +0000776 }
Jim Laskey3bb78742006-02-25 12:27:03 +0000777
Dan Gohman81313fd2008-09-14 17:21:12 +0000778 Out << '}';
Andrew Lenharth0d124b82007-01-08 18:21:30 +0000779 if (CS->getType()->isPacked())
780 Out << '>';
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000781 return;
782 }
783
784 if (const ConstantVector *CP = dyn_cast<ConstantVector>(CV)) {
785 const Type *ETy = CP->getType()->getElementType();
786 assert(CP->getNumOperands() > 0 &&
787 "Number of operands for a PackedConst must be > 0");
Dan Gohman1262a252009-02-11 00:25:25 +0000788 Out << '<';
Chris Lattner0f578952009-02-28 20:25:14 +0000789 TypePrinter.print(ETy);
Dan Gohman81313fd2008-09-14 17:21:12 +0000790 Out << ' ';
Chris Lattner0f578952009-02-28 20:25:14 +0000791 WriteAsOperandInternal(Out, CP->getOperand(0), TypePrinter, Machine);
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000792 for (unsigned i = 1, e = CP->getNumOperands(); i != e; ++i) {
Chris Lattner585297e82008-08-19 05:26:17 +0000793 Out << ", ";
Chris Lattner0f578952009-02-28 20:25:14 +0000794 TypePrinter.print(ETy);
Dan Gohman81313fd2008-09-14 17:21:12 +0000795 Out << ' ';
Chris Lattner0f578952009-02-28 20:25:14 +0000796 WriteAsOperandInternal(Out, CP->getOperand(i), TypePrinter, Machine);
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000797 }
Dan Gohman1262a252009-02-11 00:25:25 +0000798 Out << '>';
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000799 return;
800 }
801
802 if (isa<ConstantPointerNull>(CV)) {
Chris Lattnerd84bb632002-04-16 21:36:08 +0000803 Out << "null";
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000804 return;
805 }
806
807 if (isa<UndefValue>(CV)) {
Chris Lattner5e0b9f22004-10-16 18:08:06 +0000808 Out << "undef";
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000809 return;
810 }
Chris Lattner5e0b9f22004-10-16 18:08:06 +0000811
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000812 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
Reid Spencer812a1be2006-12-04 05:19:18 +0000813 Out << CE->getOpcodeName();
814 if (CE->isCompare())
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000815 Out << ' ' << getPredicateText(CE->getPredicate());
Reid Spencer812a1be2006-12-04 05:19:18 +0000816 Out << " (";
Misha Brukmanb1c93172005-04-21 23:48:37 +0000817
Vikram S. Adveb952b542002-07-14 23:14:45 +0000818 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
Chris Lattner0f578952009-02-28 20:25:14 +0000819 TypePrinter.print((*OI)->getType());
Dan Gohman81313fd2008-09-14 17:21:12 +0000820 Out << ' ';
Chris Lattner0f578952009-02-28 20:25:14 +0000821 WriteAsOperandInternal(Out, *OI, TypePrinter, Machine);
Vikram S. Adveb952b542002-07-14 23:14:45 +0000822 if (OI+1 != CE->op_end())
Chris Lattner3cd8c562002-07-30 18:54:25 +0000823 Out << ", ";
Vikram S. Adveb952b542002-07-14 23:14:45 +0000824 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000825
Dan Gohmana76f0f72008-05-31 19:12:39 +0000826 if (CE->hasIndices()) {
827 const SmallVector<unsigned, 4> &Indices = CE->getIndices();
828 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
829 Out << ", " << Indices[i];
830 }
831
Reid Spencer6c38f0b2006-11-27 01:05:10 +0000832 if (CE->isCast()) {
Chris Lattner83b396b2002-08-15 19:37:43 +0000833 Out << " to ";
Chris Lattner0f578952009-02-28 20:25:14 +0000834 TypePrinter.print(CE->getType());
Chris Lattner83b396b2002-08-15 19:37:43 +0000835 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +0000836
Misha Brukman21bbdb92004-06-04 21:11:51 +0000837 Out << ')';
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000838 return;
Chris Lattnerd84bb632002-04-16 21:36:08 +0000839 }
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000840
841 Out << "<placeholder or erroneous Constant>";
Chris Lattnerd84bb632002-04-16 21:36:08 +0000842}
843
844
Misha Brukmanc566ca362004-03-02 00:22:19 +0000845/// WriteAsOperand - Write the name of the specified value out to the specified
846/// ostream. This can be useful when you just want to print int %reg126, not
847/// the whole instruction that generated it.
848///
Chris Lattner0c19df42008-08-23 22:23:09 +0000849static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
Chris Lattner0f578952009-02-28 20:25:14 +0000850 TypePrinting &TypePrinter,
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000851 SlotTracker *Machine) {
Chris Lattner033935d2008-08-17 04:40:13 +0000852 if (V->hasName()) {
853 PrintLLVMName(Out, V);
854 return;
855 }
856
857 const Constant *CV = dyn_cast<Constant>(V);
858 if (CV && !isa<GlobalValue>(CV)) {
Chris Lattner0f578952009-02-28 20:25:14 +0000859 WriteConstantInt(Out, CV, TypePrinter, Machine);
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000860 return;
861 }
862
863 if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
Chris Lattner033935d2008-08-17 04:40:13 +0000864 Out << "asm ";
865 if (IA->hasSideEffects())
866 Out << "sideeffect ";
867 Out << '"';
868 PrintEscapedString(IA->getAsmString(), Out);
869 Out << "\", \"";
870 PrintEscapedString(IA->getConstraintString(), Out);
871 Out << '"';
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000872 return;
873 }
874
875 char Prefix = '%';
876 int Slot;
877 if (Machine) {
878 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
879 Slot = Machine->getGlobalSlot(GV);
880 Prefix = '@';
881 } else {
882 Slot = Machine->getLocalSlot(V);
883 }
Chris Lattner033935d2008-08-17 04:40:13 +0000884 } else {
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000885 Machine = createSlotTracker(V);
Chris Lattner033935d2008-08-17 04:40:13 +0000886 if (Machine) {
887 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
888 Slot = Machine->getGlobalSlot(GV);
889 Prefix = '@';
890 } else {
891 Slot = Machine->getLocalSlot(V);
892 }
Chris Lattnera2d810d2006-01-25 22:26:05 +0000893 } else {
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000894 Slot = -1;
Chris Lattnerd84bb632002-04-16 21:36:08 +0000895 }
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000896 delete Machine;
Chris Lattnerd84bb632002-04-16 21:36:08 +0000897 }
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000898
899 if (Slot != -1)
900 Out << Prefix << Slot;
901 else
902 Out << "<badref>";
Chris Lattnerd84bb632002-04-16 21:36:08 +0000903}
904
Misha Brukmanb22d09c2004-03-01 19:48:13 +0000905/// WriteAsOperand - Write the name of the specified value out to the specified
906/// ostream. This can be useful when you just want to print int %reg126, not
907/// the whole instruction that generated it.
908///
Chris Lattner604e3512008-08-19 04:47:09 +0000909void llvm::WriteAsOperand(std::ostream &Out, const Value *V, bool PrintType,
910 const Module *Context) {
Chris Lattner0c19df42008-08-23 22:23:09 +0000911 raw_os_ostream OS(Out);
912 WriteAsOperand(OS, V, PrintType, Context);
913}
914
915void llvm::WriteAsOperand(raw_ostream &Out, const Value *V, bool PrintType,
916 const Module *Context) {
Chris Lattner5a9f63e2002-07-10 16:48:17 +0000917 if (Context == 0) Context = getModuleFromVal(V);
Chris Lattnerb86620e2001-10-29 16:37:48 +0000918
Chris Lattner0f578952009-02-28 20:25:14 +0000919 TypePrinting TypePrinter(Context, Out);
Dan Gohman81313fd2008-09-14 17:21:12 +0000920 if (PrintType) {
Chris Lattner0f578952009-02-28 20:25:14 +0000921 TypePrinter.print(V->getType());
Dan Gohman81313fd2008-09-14 17:21:12 +0000922 Out << ' ';
923 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000924
Chris Lattner0f578952009-02-28 20:25:14 +0000925 WriteAsOperandInternal(Out, V, TypePrinter, 0);
Chris Lattner5e5abe32001-07-20 19:15:21 +0000926}
927
Reid Spencer58d30f22004-07-04 11:50:43 +0000928
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000929namespace {
Chris Lattner2e9fee42001-07-12 23:35:26 +0000930
Chris Lattnerfee714f2001-09-07 16:36:04 +0000931class AssemblyWriter {
Chris Lattner0c19df42008-08-23 22:23:09 +0000932 raw_ostream &Out;
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000933 SlotTracker &Machine;
Chris Lattner7bfee412001-10-29 16:05:51 +0000934 const Module *TheModule;
Chris Lattner0f578952009-02-28 20:25:14 +0000935 TypePrinting TypePrinter;
Chris Lattner8339f7d2003-10-30 23:41:03 +0000936 AssemblyAnnotationWriter *AnnotationWriter;
Chris Lattner2f7c9632001-06-06 20:29:01 +0000937public:
Chris Lattner0c19df42008-08-23 22:23:09 +0000938 inline AssemblyWriter(raw_ostream &o, SlotTracker &Mac, const Module *M,
Chris Lattner8339f7d2003-10-30 23:41:03 +0000939 AssemblyAnnotationWriter *AAW)
Chris Lattner0f578952009-02-28 20:25:14 +0000940 : Out(o), Machine(Mac), TheModule(M), TypePrinter(M, Out),
941 AnnotationWriter(AAW) {
Chris Lattner2f7c9632001-06-06 20:29:01 +0000942 }
943
Chris Lattner0c19df42008-08-23 22:23:09 +0000944 void write(const Module *M) { printModule(M); }
945
946 void write(const GlobalValue *G) {
947 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(G))
948 printGlobal(GV);
949 else if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(G))
950 printAlias(GA);
951 else if (const Function *F = dyn_cast<Function>(G))
952 printFunction(F);
953 else
954 assert(0 && "Unknown global");
955 }
956
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000957 void write(const BasicBlock *BB) { printBasicBlock(BB); }
958 void write(const Instruction *I) { printInstruction(*I); }
Chris Lattner0f578952009-02-28 20:25:14 +0000959// void write(const Type *Ty) { printType(Ty); }
Chris Lattner2f7c9632001-06-06 20:29:01 +0000960
Chris Lattner78e2e8b2006-12-06 06:24:27 +0000961 void writeOperand(const Value *Op, bool PrintType);
Devang Patelba3fa6c2008-09-23 23:03:40 +0000962 void writeParamOperand(const Value *Operand, Attributes Attrs);
Chris Lattner1e194682002-04-18 18:53:13 +0000963
Misha Brukman4685e262004-04-28 15:31:21 +0000964 const Module* getModule() { return TheModule; }
965
Misha Brukmand92f54a2004-11-15 19:30:05 +0000966private:
Chris Lattner7bfee412001-10-29 16:05:51 +0000967 void printModule(const Module *M);
Reid Spencer32af9e82007-01-06 07:24:44 +0000968 void printTypeSymbolTable(const TypeSymbolTable &ST);
Chris Lattner7bfee412001-10-29 16:05:51 +0000969 void printGlobal(const GlobalVariable *GV);
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000970 void printAlias(const GlobalAlias *GV);
Chris Lattner57698e22002-03-26 18:01:55 +0000971 void printFunction(const Function *F);
Devang Patelba3fa6c2008-09-23 23:03:40 +0000972 void printArgument(const Argument *FA, Attributes Attrs);
Chris Lattner7bfee412001-10-29 16:05:51 +0000973 void printBasicBlock(const BasicBlock *BB);
Chris Lattner113f4f42002-06-25 16:13:24 +0000974 void printInstruction(const Instruction &I);
Chris Lattnerd816b532002-04-13 20:53:41 +0000975
976 // printType - Go to extreme measures to attempt to print out a short,
977 // symbolic version of a type name.
978 //
Chris Lattner585297e82008-08-19 05:26:17 +0000979 void printType(const Type *Ty) {
Chris Lattner0f578952009-02-28 20:25:14 +0000980 TypePrinter.print(Ty);
Chris Lattnerd816b532002-04-13 20:53:41 +0000981 }
982
Chris Lattner862e3382001-10-13 06:42:36 +0000983 // printInfoComment - Print a little comment after the instruction indicating
984 // which slot it occupies.
Chris Lattner113f4f42002-06-25 16:13:24 +0000985 void printInfoComment(const Value &V);
Chris Lattner2f7c9632001-06-06 20:29:01 +0000986};
Reid Spencerf43ac622004-05-27 22:04:46 +0000987} // end of llvm namespace
Chris Lattner2f7c9632001-06-06 20:29:01 +0000988
Chris Lattnerd816b532002-04-13 20:53:41 +0000989
Chris Lattner78e2e8b2006-12-06 06:24:27 +0000990void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
991 if (Operand == 0) {
Chris Lattner08f7d0c2005-02-24 16:58:29 +0000992 Out << "<null operand!>";
Chris Lattner78e2e8b2006-12-06 06:24:27 +0000993 } else {
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000994 if (PrintType) {
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000995 printType(Operand->getType());
Dan Gohman81313fd2008-09-14 17:21:12 +0000996 Out << ' ';
Chris Lattner3a36d2c2008-08-19 05:06:27 +0000997 }
Chris Lattner0f578952009-02-28 20:25:14 +0000998 WriteAsOperandInternal(Out, Operand, TypePrinter, &Machine);
Chris Lattner08f7d0c2005-02-24 16:58:29 +0000999 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001000}
1001
Dale Johannesen89268bc2008-02-19 21:38:47 +00001002void AssemblyWriter::writeParamOperand(const Value *Operand,
Devang Patelba3fa6c2008-09-23 23:03:40 +00001003 Attributes Attrs) {
Duncan Sandsad0ea2d2007-11-27 13:23:08 +00001004 if (Operand == 0) {
1005 Out << "<null operand!>";
1006 } else {
Duncan Sandsad0ea2d2007-11-27 13:23:08 +00001007 // Print the type
1008 printType(Operand->getType());
1009 // Print parameter attributes list
Devang Patel4c758ea2008-09-25 21:00:45 +00001010 if (Attrs != Attribute::None)
1011 Out << ' ' << Attribute::getAsString(Attrs);
Dan Gohman81313fd2008-09-14 17:21:12 +00001012 Out << ' ';
Duncan Sandsad0ea2d2007-11-27 13:23:08 +00001013 // Print the operand
Chris Lattner0f578952009-02-28 20:25:14 +00001014 WriteAsOperandInternal(Out, Operand, TypePrinter, &Machine);
Duncan Sandsad0ea2d2007-11-27 13:23:08 +00001015 }
1016}
Chris Lattner2f7c9632001-06-06 20:29:01 +00001017
Chris Lattner7bfee412001-10-29 16:05:51 +00001018void AssemblyWriter::printModule(const Module *M) {
Chris Lattner4d8689e2005-03-02 23:12:40 +00001019 if (!M->getModuleIdentifier().empty() &&
Misha Brukmanb1c93172005-04-21 23:48:37 +00001020 // Don't print the ID if it will start a new line (which would
Chris Lattner4d8689e2005-03-02 23:12:40 +00001021 // require a comment char before it).
1022 M->getModuleIdentifier().find('\n') == std::string::npos)
1023 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
1024
Owen Andersone2237542006-10-18 02:21:12 +00001025 if (!M->getDataLayout().empty())
Chris Lattner04897162006-10-22 06:06:56 +00001026 Out << "target datalayout = \"" << M->getDataLayout() << "\"\n";
Reid Spencer48f98c82004-07-25 21:44:54 +00001027 if (!M->getTargetTriple().empty())
Reid Spencerffec7df2004-07-25 21:29:43 +00001028 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
Misha Brukmanb1c93172005-04-21 23:48:37 +00001029
Chris Lattnereef2fe72006-01-24 04:13:11 +00001030 if (!M->getModuleInlineAsm().empty()) {
Chris Lattnerefaf35d2006-01-24 00:45:30 +00001031 // Split the string into lines, to make it easier to read the .ll file.
Chris Lattnereef2fe72006-01-24 04:13:11 +00001032 std::string Asm = M->getModuleInlineAsm();
Chris Lattnerefaf35d2006-01-24 00:45:30 +00001033 size_t CurPos = 0;
1034 size_t NewLine = Asm.find_first_of('\n', CurPos);
1035 while (NewLine != std::string::npos) {
1036 // We found a newline, print the portion of the asm string from the
1037 // last newline up to this newline.
1038 Out << "module asm \"";
1039 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
1040 Out);
1041 Out << "\"\n";
1042 CurPos = NewLine+1;
1043 NewLine = Asm.find_first_of('\n', CurPos);
1044 }
Chris Lattner3acaf5c2006-01-24 00:40:17 +00001045 Out << "module asm \"";
Chris Lattnerefaf35d2006-01-24 00:45:30 +00001046 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.end()), Out);
Chris Lattner6ed87bd2006-01-23 23:03:36 +00001047 Out << "\"\n";
1048 }
1049
Chris Lattner2cdd49d2004-09-14 05:06:58 +00001050 // Loop over the dependent libraries and emit them.
Chris Lattner730cfe42004-09-14 04:51:44 +00001051 Module::lib_iterator LI = M->lib_begin();
1052 Module::lib_iterator LE = M->lib_end();
Reid Spencer48f98c82004-07-25 21:44:54 +00001053 if (LI != LE) {
Chris Lattner730cfe42004-09-14 04:51:44 +00001054 Out << "deplibs = [ ";
1055 while (LI != LE) {
Chris Lattner2cdd49d2004-09-14 05:06:58 +00001056 Out << '"' << *LI << '"';
Reid Spencerffec7df2004-07-25 21:29:43 +00001057 ++LI;
Chris Lattner730cfe42004-09-14 04:51:44 +00001058 if (LI != LE)
1059 Out << ", ";
Reid Spencerffec7df2004-07-25 21:29:43 +00001060 }
1061 Out << " ]\n";
Reid Spencercc5ff642004-07-25 18:08:18 +00001062 }
Reid Spencerb9e08772004-09-13 23:44:23 +00001063
Chris Lattner2cdd49d2004-09-14 05:06:58 +00001064 // Loop over the symbol table, emitting all named constants.
Reid Spencer32af9e82007-01-06 07:24:44 +00001065 printTypeSymbolTable(M->getTypeSymbolTable());
Misha Brukmanb1c93172005-04-21 23:48:37 +00001066
Chris Lattner54932b02006-12-06 04:41:52 +00001067 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
1068 I != E; ++I)
Chris Lattner113f4f42002-06-25 16:13:24 +00001069 printGlobal(I);
Chris Lattnerd2747052007-04-26 02:24:10 +00001070
1071 // Output all aliases.
1072 if (!M->alias_empty()) Out << "\n";
1073 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
1074 I != E; ++I)
1075 printAlias(I);
Chris Lattnerfee714f2001-09-07 16:36:04 +00001076
Chris Lattner2cdd49d2004-09-14 05:06:58 +00001077 // Output all of the functions.
Chris Lattner113f4f42002-06-25 16:13:24 +00001078 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
1079 printFunction(I);
Chris Lattnerfee714f2001-09-07 16:36:04 +00001080}
1081
Chris Lattner0c19df42008-08-23 22:23:09 +00001082static void PrintLinkage(GlobalValue::LinkageTypes LT, raw_ostream &Out) {
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001083 switch (LT) {
Rafael Espindola6de96a12009-01-15 20:18:42 +00001084 case GlobalValue::PrivateLinkage: Out << "private "; break;
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001085 case GlobalValue::InternalLinkage: Out << "internal "; break;
1086 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
1087 case GlobalValue::WeakLinkage: Out << "weak "; break;
1088 case GlobalValue::CommonLinkage: Out << "common "; break;
1089 case GlobalValue::AppendingLinkage: Out << "appending "; break;
1090 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
1091 case GlobalValue::DLLExportLinkage: Out << "dllexport "; break;
1092 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
1093 case GlobalValue::ExternalLinkage: break;
1094 case GlobalValue::GhostLinkage:
1095 Out << "GhostLinkage not allowed in AsmWriter!\n";
1096 abort();
1097 }
1098}
1099
1100
1101static void PrintVisibility(GlobalValue::VisibilityTypes Vis,
Chris Lattner0c19df42008-08-23 22:23:09 +00001102 raw_ostream &Out) {
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001103 switch (Vis) {
1104 default: assert(0 && "Invalid visibility style!");
1105 case GlobalValue::DefaultVisibility: break;
1106 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
1107 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
1108 }
1109}
1110
Chris Lattner7bfee412001-10-29 16:05:51 +00001111void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
Chris Lattner033935d2008-08-17 04:40:13 +00001112 if (GV->hasName()) {
1113 PrintLLVMName(Out, GV);
1114 Out << " = ";
1115 }
Chris Lattner37798642001-09-18 04:01:05 +00001116
Chris Lattner1508d3f2008-08-19 05:16:28 +00001117 if (!GV->hasInitializer() && GV->hasExternalLinkage())
1118 Out << "external ";
1119
1120 PrintLinkage(GV->getLinkage(), Out);
1121 PrintVisibility(GV->getVisibility(), Out);
Lauro Ramos Venancio749e4662007-04-12 18:32:50 +00001122
1123 if (GV->isThreadLocal()) Out << "thread_local ";
Chris Lattnerac161bf2009-01-02 07:01:27 +00001124 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
1125 Out << "addrspace(" << AddressSpace << ") ";
Misha Brukmana6619a92004-06-21 21:53:56 +00001126 Out << (GV->isConstant() ? "constant " : "global ");
Chris Lattner2413b162001-12-04 00:03:30 +00001127 printType(GV->getType()->getElementType());
Chris Lattner37798642001-09-18 04:01:05 +00001128
Dan Gohman81313fd2008-09-14 17:21:12 +00001129 if (GV->hasInitializer()) {
1130 Out << ' ';
Chris Lattner78e2e8b2006-12-06 06:24:27 +00001131 writeOperand(GV->getInitializer(), false);
Dan Gohman81313fd2008-09-14 17:21:12 +00001132 }
Christopher Lamb54dd24c2007-12-11 08:59:05 +00001133
Chris Lattner4b96c542005-11-12 00:10:19 +00001134 if (GV->hasSection())
1135 Out << ", section \"" << GV->getSection() << '"';
1136 if (GV->getAlignment())
Chris Lattnerf8a974d2005-11-06 06:48:53 +00001137 Out << ", align " << GV->getAlignment();
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001138
Chris Lattner113f4f42002-06-25 16:13:24 +00001139 printInfoComment(*GV);
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001140 Out << '\n';
Chris Lattnerda975502001-09-10 07:58:01 +00001141}
1142
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001143void AssemblyWriter::printAlias(const GlobalAlias *GA) {
Dale Johannesen83e468a2008-06-03 18:14:29 +00001144 // Don't crash when dumping partially built GA
1145 if (!GA->hasName())
1146 Out << "<<nameless>> = ";
Chris Lattner033935d2008-08-17 04:40:13 +00001147 else {
1148 PrintLLVMName(Out, GA);
1149 Out << " = ";
1150 }
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001151 PrintVisibility(GA->getVisibility(), Out);
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001152
1153 Out << "alias ";
1154
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001155 PrintLinkage(GA->getLinkage(), Out);
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001156
Anton Korobeynikov546ea7e2007-04-29 18:02:48 +00001157 const Constant *Aliasee = GA->getAliasee();
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001158
1159 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(Aliasee)) {
1160 printType(GV->getType());
Chris Lattner033935d2008-08-17 04:40:13 +00001161 Out << ' ';
1162 PrintLLVMName(Out, GV);
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001163 } else if (const Function *F = dyn_cast<Function>(Aliasee)) {
1164 printType(F->getFunctionType());
1165 Out << "* ";
1166
Chris Lattner0f578952009-02-28 20:25:14 +00001167 WriteAsOperandInternal(Out, F, TypePrinter, &Machine);
Anton Korobeynikov72d5d422008-03-22 08:17:17 +00001168 } else if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(Aliasee)) {
1169 printType(GA->getType());
Chris Lattner033935d2008-08-17 04:40:13 +00001170 Out << " ";
1171 PrintLLVMName(Out, GA);
Anton Korobeynikovb18f8f82007-04-28 13:45:00 +00001172 } else {
1173 const ConstantExpr *CE = 0;
1174 if ((CE = dyn_cast<ConstantExpr>(Aliasee)) &&
1175 (CE->getOpcode() == Instruction::BitCast)) {
1176 writeOperand(CE, false);
1177 } else
1178 assert(0 && "Unsupported aliasee");
1179 }
1180
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001181 printInfoComment(*GA);
Chris Lattner1508d3f2008-08-19 05:16:28 +00001182 Out << '\n';
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001183}
1184
Reid Spencer32af9e82007-01-06 07:24:44 +00001185void AssemblyWriter::printTypeSymbolTable(const TypeSymbolTable &ST) {
Reid Spencere7e96712004-05-25 08:53:40 +00001186 // Print the types.
Reid Spencer32af9e82007-01-06 07:24:44 +00001187 for (TypeSymbolTable::const_iterator TI = ST.begin(), TE = ST.end();
1188 TI != TE; ++TI) {
Chris Lattner1508d3f2008-08-19 05:16:28 +00001189 Out << '\t';
1190 PrintLLVMName(Out, &TI->first[0], TI->first.size(), LocalPrefix);
1191 Out << " = type ";
Reid Spencere7e96712004-05-25 08:53:40 +00001192
1193 // Make sure we print out at least one level of the type structure, so
1194 // that we do not get %FILE = type %FILE
Chris Lattner0f578952009-02-28 20:25:14 +00001195 TypePrinter.printAtLeastOneLevel(TI->second);
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001196 Out << '\n';
Reid Spencere7e96712004-05-25 08:53:40 +00001197 }
Reid Spencer32af9e82007-01-06 07:24:44 +00001198}
1199
Misha Brukmanc566ca362004-03-02 00:22:19 +00001200/// printFunction - Print all aspects of a function.
1201///
Chris Lattner113f4f42002-06-25 16:13:24 +00001202void AssemblyWriter::printFunction(const Function *F) {
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001203 // Print out the return type and name.
1204 Out << '\n';
Chris Lattner379a8d22003-04-16 20:28:45 +00001205
Misha Brukmana6619a92004-06-21 21:53:56 +00001206 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
Chris Lattner8339f7d2003-10-30 23:41:03 +00001207
Reid Spencer5301e7c2007-01-30 20:08:39 +00001208 if (F->isDeclaration())
Chris Lattner10f03a62007-08-19 22:15:26 +00001209 Out << "declare ";
1210 else
Reid Spencer7ce2d2a2006-12-29 20:29:48 +00001211 Out << "define ";
Chris Lattner3a36d2c2008-08-19 05:06:27 +00001212
1213 PrintLinkage(F->getLinkage(), Out);
1214 PrintVisibility(F->getVisibility(), Out);
Chris Lattner379a8d22003-04-16 20:28:45 +00001215
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001216 // Print the calling convention.
1217 switch (F->getCallingConv()) {
1218 case CallingConv::C: break; // default
Anton Korobeynikov3c5b3df2006-09-20 22:03:51 +00001219 case CallingConv::Fast: Out << "fastcc "; break;
1220 case CallingConv::Cold: Out << "coldcc "; break;
1221 case CallingConv::X86_StdCall: Out << "x86_stdcallcc "; break;
1222 case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001223 default: Out << "cc" << F->getCallingConv() << " "; break;
1224 }
1225
Reid Spencer8c4914c2006-12-31 05:24:50 +00001226 const FunctionType *FT = F->getFunctionType();
Devang Patel4c758ea2008-09-25 21:00:45 +00001227 const AttrListPtr &Attrs = F->getAttributes();
Devang Patel221fe422008-09-29 20:49:50 +00001228 Attributes RetAttrs = Attrs.getRetAttributes();
1229 if (RetAttrs != Attribute::None)
1230 Out << Attribute::getAsString(Attrs.getRetAttributes()) << ' ';
Chris Lattner585297e82008-08-19 05:26:17 +00001231 printType(F->getReturnType());
1232 Out << ' ';
Chris Lattner0f578952009-02-28 20:25:14 +00001233 WriteAsOperandInternal(Out, F, TypePrinter, &Machine);
Misha Brukmana6619a92004-06-21 21:53:56 +00001234 Out << '(';
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001235 Machine.incorporateFunction(F);
Chris Lattnerfee714f2001-09-07 16:36:04 +00001236
Chris Lattner7bfee412001-10-29 16:05:51 +00001237 // Loop over the arguments, printing them...
Chris Lattnerfee714f2001-09-07 16:36:04 +00001238
Reid Spencer8c4914c2006-12-31 05:24:50 +00001239 unsigned Idx = 1;
Chris Lattner82738fe2007-04-18 00:57:22 +00001240 if (!F->isDeclaration()) {
1241 // If this isn't a declaration, print the argument names as well.
1242 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1243 I != E; ++I) {
1244 // Insert commas as we go... the first arg doesn't get a comma
1245 if (I != F->arg_begin()) Out << ", ";
Devang Patela05633e2008-09-26 22:53:05 +00001246 printArgument(I, Attrs.getParamAttributes(Idx));
Chris Lattner82738fe2007-04-18 00:57:22 +00001247 Idx++;
1248 }
1249 } else {
1250 // Otherwise, print the types from the function type.
1251 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1252 // Insert commas as we go... the first arg doesn't get a comma
1253 if (i) Out << ", ";
1254
1255 // Output type...
1256 printType(FT->getParamType(i));
1257
Devang Patela05633e2008-09-26 22:53:05 +00001258 Attributes ArgAttrs = Attrs.getParamAttributes(i+1);
Devang Patel4c758ea2008-09-25 21:00:45 +00001259 if (ArgAttrs != Attribute::None)
1260 Out << ' ' << Attribute::getAsString(ArgAttrs);
Chris Lattner82738fe2007-04-18 00:57:22 +00001261 }
Reid Spencer8c4914c2006-12-31 05:24:50 +00001262 }
Chris Lattnerfee714f2001-09-07 16:36:04 +00001263
1264 // Finish printing arguments...
Chris Lattner113f4f42002-06-25 16:13:24 +00001265 if (FT->isVarArg()) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001266 if (FT->getNumParams()) Out << ", ";
1267 Out << "..."; // Output varargs portion of signature!
Chris Lattnerfee714f2001-09-07 16:36:04 +00001268 }
Misha Brukmana6619a92004-06-21 21:53:56 +00001269 Out << ')';
Devang Patela05633e2008-09-26 22:53:05 +00001270 Attributes FnAttrs = Attrs.getFnAttributes();
1271 if (FnAttrs != Attribute::None)
1272 Out << ' ' << Attribute::getAsString(Attrs.getFnAttributes());
Chris Lattner4b96c542005-11-12 00:10:19 +00001273 if (F->hasSection())
1274 Out << " section \"" << F->getSection() << '"';
Chris Lattnerf8a974d2005-11-06 06:48:53 +00001275 if (F->getAlignment())
1276 Out << " align " << F->getAlignment();
Gordon Henriksend930f912008-08-17 18:44:35 +00001277 if (F->hasGC())
1278 Out << " gc \"" << F->getGC() << '"';
Reid Spencer5301e7c2007-01-30 20:08:39 +00001279 if (F->isDeclaration()) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001280 Out << "\n";
Chris Lattnerb2f02e52002-05-06 03:00:40 +00001281 } else {
Chris Lattnerd5fbc8f2008-04-21 06:12:55 +00001282 Out << " {";
Misha Brukmanb1c93172005-04-21 23:48:37 +00001283
Chris Lattner6915f8f2002-04-07 22:49:37 +00001284 // Output all of its basic blocks... for the function
Chris Lattner113f4f42002-06-25 16:13:24 +00001285 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1286 printBasicBlock(I);
Chris Lattnerfee714f2001-09-07 16:36:04 +00001287
Misha Brukmana6619a92004-06-21 21:53:56 +00001288 Out << "}\n";
Chris Lattnerfee714f2001-09-07 16:36:04 +00001289 }
1290
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001291 Machine.purgeFunction();
Chris Lattner2f7c9632001-06-06 20:29:01 +00001292}
1293
Misha Brukmanc566ca362004-03-02 00:22:19 +00001294/// printArgument - This member is called for every argument that is passed into
1295/// the function. Simply print it out
1296///
Dale Johannesen89268bc2008-02-19 21:38:47 +00001297void AssemblyWriter::printArgument(const Argument *Arg,
Devang Patelba3fa6c2008-09-23 23:03:40 +00001298 Attributes Attrs) {
Chris Lattner2f7c9632001-06-06 20:29:01 +00001299 // Output type...
Chris Lattner7bfee412001-10-29 16:05:51 +00001300 printType(Arg->getType());
Misha Brukmanb1c93172005-04-21 23:48:37 +00001301
Duncan Sandsad0ea2d2007-11-27 13:23:08 +00001302 // Output parameter attributes list
Devang Patel4c758ea2008-09-25 21:00:45 +00001303 if (Attrs != Attribute::None)
1304 Out << ' ' << Attribute::getAsString(Attrs);
Reid Spencer8c4914c2006-12-31 05:24:50 +00001305
Chris Lattner2f7c9632001-06-06 20:29:01 +00001306 // Output name, if available...
Chris Lattner033935d2008-08-17 04:40:13 +00001307 if (Arg->hasName()) {
1308 Out << ' ';
1309 PrintLLVMName(Out, Arg);
1310 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001311}
1312
Misha Brukmanc566ca362004-03-02 00:22:19 +00001313/// printBasicBlock - This member is called for each basic block in a method.
1314///
Chris Lattner7bfee412001-10-29 16:05:51 +00001315void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
Nick Lewycky4d43d3c2008-04-25 16:53:59 +00001316 if (BB->hasName()) { // Print out the label if it exists...
Chris Lattner033935d2008-08-17 04:40:13 +00001317 Out << "\n";
Chris Lattner1508d3f2008-08-19 05:16:28 +00001318 PrintLLVMName(Out, BB->getNameStart(), BB->getNameLen(), LabelPrefix);
Chris Lattner033935d2008-08-17 04:40:13 +00001319 Out << ':';
Nick Lewycky4d43d3c2008-04-25 16:53:59 +00001320 } else if (!BB->use_empty()) { // Don't print block # of no uses...
Chris Lattner67bec132008-04-21 04:20:33 +00001321 Out << "\n; <label>:";
Chris Lattner5e043322007-01-11 03:54:27 +00001322 int Slot = Machine.getLocalSlot(BB);
Chris Lattner757ee0b2004-06-09 19:41:19 +00001323 if (Slot != -1)
Misha Brukmana6619a92004-06-21 21:53:56 +00001324 Out << Slot;
Chris Lattner757ee0b2004-06-09 19:41:19 +00001325 else
Misha Brukmana6619a92004-06-21 21:53:56 +00001326 Out << "<badref>";
Chris Lattner58185f22002-10-02 19:38:55 +00001327 }
Chris Lattner2447ef52003-11-20 00:09:43 +00001328
1329 if (BB->getParent() == 0)
Misha Brukmana6619a92004-06-21 21:53:56 +00001330 Out << "\t\t; Error: Block without parent!";
Chris Lattnerff834c02008-04-22 02:45:44 +00001331 else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
1332 // Output predecessors for the block...
1333 Out << "\t\t;";
1334 pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
1335
1336 if (PI == PE) {
1337 Out << " No predecessors!";
1338 } else {
Dan Gohman81313fd2008-09-14 17:21:12 +00001339 Out << " preds = ";
Chris Lattnerff834c02008-04-22 02:45:44 +00001340 writeOperand(*PI, false);
1341 for (++PI; PI != PE; ++PI) {
Dan Gohman81313fd2008-09-14 17:21:12 +00001342 Out << ", ";
Chris Lattner78e2e8b2006-12-06 06:24:27 +00001343 writeOperand(*PI, false);
Chris Lattner00211f12003-11-16 22:59:57 +00001344 }
Chris Lattner58185f22002-10-02 19:38:55 +00001345 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001346 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00001347
Chris Lattnerff834c02008-04-22 02:45:44 +00001348 Out << "\n";
Chris Lattner2f7c9632001-06-06 20:29:01 +00001349
Misha Brukmana6619a92004-06-21 21:53:56 +00001350 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
Chris Lattner8339f7d2003-10-30 23:41:03 +00001351
Chris Lattnerfee714f2001-09-07 16:36:04 +00001352 // Output all of the instructions in the basic block...
Chris Lattner113f4f42002-06-25 16:13:24 +00001353 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1354 printInstruction(*I);
Chris Lattner96cdd272004-03-08 18:51:45 +00001355
Misha Brukmana6619a92004-06-21 21:53:56 +00001356 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001357}
1358
Chris Lattner862e3382001-10-13 06:42:36 +00001359
Misha Brukmanc566ca362004-03-02 00:22:19 +00001360/// printInfoComment - Print a little comment after the instruction indicating
1361/// which slot it occupies.
1362///
Chris Lattner113f4f42002-06-25 16:13:24 +00001363void AssemblyWriter::printInfoComment(const Value &V) {
1364 if (V.getType() != Type::VoidTy) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001365 Out << "\t\t; <";
Chris Lattner585297e82008-08-19 05:26:17 +00001366 printType(V.getType());
1367 Out << '>';
Chris Lattner862e3382001-10-13 06:42:36 +00001368
Chris Lattnerb25e5ea2008-08-29 17:19:30 +00001369 if (!V.hasName() && !isa<Instruction>(V)) {
Chris Lattner5e043322007-01-11 03:54:27 +00001370 int SlotNum;
1371 if (const GlobalValue *GV = dyn_cast<GlobalValue>(&V))
1372 SlotNum = Machine.getGlobalSlot(GV);
1373 else
1374 SlotNum = Machine.getLocalSlot(&V);
Chris Lattner757ee0b2004-06-09 19:41:19 +00001375 if (SlotNum == -1)
Misha Brukmana6619a92004-06-21 21:53:56 +00001376 Out << ":<badref>";
Reid Spencer8beac692004-06-09 15:26:53 +00001377 else
Misha Brukmana6619a92004-06-21 21:53:56 +00001378 Out << ':' << SlotNum; // Print out the def slot taken.
Chris Lattner862e3382001-10-13 06:42:36 +00001379 }
Chris Lattnerb6c21db2005-02-01 01:24:01 +00001380 Out << " [#uses=" << V.getNumUses() << ']'; // Output # uses
Chris Lattner862e3382001-10-13 06:42:36 +00001381 }
1382}
1383
Reid Spencere7141c82006-08-28 01:02:49 +00001384// This member is called for each Instruction in a function..
Chris Lattner113f4f42002-06-25 16:13:24 +00001385void AssemblyWriter::printInstruction(const Instruction &I) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001386 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
Chris Lattner8339f7d2003-10-30 23:41:03 +00001387
Chris Lattner82ff9232008-08-23 22:52:27 +00001388 Out << '\t';
Chris Lattner2f7c9632001-06-06 20:29:01 +00001389
1390 // Print out name if it exists...
Chris Lattner033935d2008-08-17 04:40:13 +00001391 if (I.hasName()) {
1392 PrintLLVMName(Out, &I);
1393 Out << " = ";
Chris Lattnerb25e5ea2008-08-29 17:19:30 +00001394 } else if (I.getType() != Type::VoidTy) {
1395 // Print out the def slot taken.
1396 int SlotNum = Machine.getLocalSlot(&I);
1397 if (SlotNum == -1)
1398 Out << "<badref> = ";
1399 else
1400 Out << '%' << SlotNum << " = ";
Chris Lattner033935d2008-08-17 04:40:13 +00001401 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001402
Chris Lattner06038452005-05-06 05:51:46 +00001403 // If this is a volatile load or store, print out the volatile marker.
Chris Lattner504f9242003-09-08 17:45:59 +00001404 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
Chris Lattner06038452005-05-06 05:51:46 +00001405 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile())) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001406 Out << "volatile ";
Chris Lattner06038452005-05-06 05:51:46 +00001407 } else if (isa<CallInst>(I) && cast<CallInst>(I).isTailCall()) {
1408 // If this is a call, check if it's a tail call.
1409 Out << "tail ";
1410 }
Chris Lattner504f9242003-09-08 17:45:59 +00001411
Chris Lattner2f7c9632001-06-06 20:29:01 +00001412 // Print out the opcode...
Misha Brukmana6619a92004-06-21 21:53:56 +00001413 Out << I.getOpcodeName();
Chris Lattner2f7c9632001-06-06 20:29:01 +00001414
Reid Spencer45e52392006-12-03 06:27:29 +00001415 // Print out the compare instruction predicates
Nate Begemand2195702008-05-12 19:01:56 +00001416 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
Chris Lattner82ff9232008-08-23 22:52:27 +00001417 Out << ' ' << getPredicateText(CI->getPredicate());
Reid Spencer45e52392006-12-03 06:27:29 +00001418
Chris Lattner2f7c9632001-06-06 20:29:01 +00001419 // Print out the type of the operands...
Chris Lattner113f4f42002-06-25 16:13:24 +00001420 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
Chris Lattner2f7c9632001-06-06 20:29:01 +00001421
1422 // Special case conditional branches to swizzle the condition out to the front
Gabor Greifcab008f2009-02-09 15:45:06 +00001423 if (isa<BranchInst>(I) && cast<BranchInst>(I).isConditional()) {
1424 BranchInst &BI(cast<BranchInst>(I));
Dan Gohman81313fd2008-09-14 17:21:12 +00001425 Out << ' ';
Gabor Greifcab008f2009-02-09 15:45:06 +00001426 writeOperand(BI.getCondition(), true);
Dan Gohman81313fd2008-09-14 17:21:12 +00001427 Out << ", ";
Gabor Greifcab008f2009-02-09 15:45:06 +00001428 writeOperand(BI.getSuccessor(0), true);
Dan Gohman81313fd2008-09-14 17:21:12 +00001429 Out << ", ";
Gabor Greifcab008f2009-02-09 15:45:06 +00001430 writeOperand(BI.getSuccessor(1), true);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001431
Chris Lattner8d48df22002-04-13 18:34:38 +00001432 } else if (isa<SwitchInst>(I)) {
Chris Lattner2f7c9632001-06-06 20:29:01 +00001433 // Special case switch statement to get formatting nice and correct...
Dan Gohman81313fd2008-09-14 17:21:12 +00001434 Out << ' ';
Chris Lattner82ff9232008-08-23 22:52:27 +00001435 writeOperand(Operand , true);
Dan Gohman81313fd2008-09-14 17:21:12 +00001436 Out << ", ";
Chris Lattner82ff9232008-08-23 22:52:27 +00001437 writeOperand(I.getOperand(1), true);
1438 Out << " [";
Chris Lattner2f7c9632001-06-06 20:29:01 +00001439
Chris Lattner113f4f42002-06-25 16:13:24 +00001440 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001441 Out << "\n\t\t";
Chris Lattner82ff9232008-08-23 22:52:27 +00001442 writeOperand(I.getOperand(op ), true);
Dan Gohman81313fd2008-09-14 17:21:12 +00001443 Out << ", ";
Chris Lattner113f4f42002-06-25 16:13:24 +00001444 writeOperand(I.getOperand(op+1), true);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001445 }
Misha Brukmana6619a92004-06-21 21:53:56 +00001446 Out << "\n\t]";
Chris Lattnerda558102001-10-02 03:41:24 +00001447 } else if (isa<PHINode>(I)) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001448 Out << ' ';
Chris Lattner113f4f42002-06-25 16:13:24 +00001449 printType(I.getType());
Misha Brukmana6619a92004-06-21 21:53:56 +00001450 Out << ' ';
Chris Lattner2f7c9632001-06-06 20:29:01 +00001451
Chris Lattner113f4f42002-06-25 16:13:24 +00001452 for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001453 if (op) Out << ", ";
Dan Gohman81313fd2008-09-14 17:21:12 +00001454 Out << "[ ";
1455 writeOperand(I.getOperand(op ), false); Out << ", ";
Misha Brukmana6619a92004-06-21 21:53:56 +00001456 writeOperand(I.getOperand(op+1), false); Out << " ]";
Chris Lattner931ef3b2001-06-11 15:04:20 +00001457 }
Dan Gohmana76f0f72008-05-31 19:12:39 +00001458 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
Dan Gohman81313fd2008-09-14 17:21:12 +00001459 Out << ' ';
Dan Gohmana76f0f72008-05-31 19:12:39 +00001460 writeOperand(I.getOperand(0), true);
1461 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
1462 Out << ", " << *i;
1463 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
Dan Gohman81313fd2008-09-14 17:21:12 +00001464 Out << ' ';
1465 writeOperand(I.getOperand(0), true); Out << ", ";
Dan Gohmana76f0f72008-05-31 19:12:39 +00001466 writeOperand(I.getOperand(1), true);
1467 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
1468 Out << ", " << *i;
Devang Patel59643e52008-02-23 00:35:18 +00001469 } else if (isa<ReturnInst>(I) && !Operand) {
1470 Out << " void";
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001471 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
1472 // Print the calling convention being used.
1473 switch (CI->getCallingConv()) {
1474 case CallingConv::C: break; // default
Chris Lattner29d20852006-05-19 21:58:52 +00001475 case CallingConv::Fast: Out << " fastcc"; break;
1476 case CallingConv::Cold: Out << " coldcc"; break;
Chris Lattnerf5270372007-11-18 18:32:16 +00001477 case CallingConv::X86_StdCall: Out << " x86_stdcallcc"; break;
1478 case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001479 default: Out << " cc" << CI->getCallingConv(); break;
1480 }
1481
Reid Spencer1517de32007-04-09 06:10:42 +00001482 const PointerType *PTy = cast<PointerType>(Operand->getType());
1483 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1484 const Type *RetTy = FTy->getReturnType();
Devang Patel4c758ea2008-09-25 21:00:45 +00001485 const AttrListPtr &PAL = CI->getAttributes();
Chris Lattner2f2d9472001-11-06 21:28:12 +00001486
Devang Patel221fe422008-09-29 20:49:50 +00001487 if (PAL.getRetAttributes() != Attribute::None)
1488 Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1489
Chris Lattner463d6a52003-08-05 15:34:45 +00001490 // If possible, print out the short form of the call instruction. We can
Chris Lattner6915f8f2002-04-07 22:49:37 +00001491 // only do this if the first argument is a pointer to a nonvararg function,
Chris Lattner463d6a52003-08-05 15:34:45 +00001492 // and if the return type is not a pointer to a function.
Chris Lattner2f2d9472001-11-06 21:28:12 +00001493 //
Dan Gohman81313fd2008-09-14 17:21:12 +00001494 Out << ' ';
Chris Lattner463d6a52003-08-05 15:34:45 +00001495 if (!FTy->isVarArg() &&
Misha Brukmanb1c93172005-04-21 23:48:37 +00001496 (!isa<PointerType>(RetTy) ||
Chris Lattnerd9a36a62002-07-25 20:58:51 +00001497 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
Dan Gohman81313fd2008-09-14 17:21:12 +00001498 printType(RetTy);
1499 Out << ' ';
Chris Lattner2f2d9472001-11-06 21:28:12 +00001500 writeOperand(Operand, false);
1501 } else {
1502 writeOperand(Operand, true);
1503 }
Misha Brukmana6619a92004-06-21 21:53:56 +00001504 Out << '(';
Reid Spencer8c4914c2006-12-31 05:24:50 +00001505 for (unsigned op = 1, Eop = I.getNumOperands(); op < Eop; ++op) {
1506 if (op > 1)
Dan Gohman81313fd2008-09-14 17:21:12 +00001507 Out << ", ";
Devang Patela05633e2008-09-26 22:53:05 +00001508 writeParamOperand(I.getOperand(op), PAL.getParamAttributes(op));
Chris Lattner2f7c9632001-06-06 20:29:01 +00001509 }
Dan Gohman81313fd2008-09-14 17:21:12 +00001510 Out << ')';
Devang Patela05633e2008-09-26 22:53:05 +00001511 if (PAL.getFnAttributes() != Attribute::None)
1512 Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
Chris Lattner113f4f42002-06-25 16:13:24 +00001513 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
Reid Spencer1517de32007-04-09 06:10:42 +00001514 const PointerType *PTy = cast<PointerType>(Operand->getType());
1515 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1516 const Type *RetTy = FTy->getReturnType();
Devang Patel4c758ea2008-09-25 21:00:45 +00001517 const AttrListPtr &PAL = II->getAttributes();
Chris Lattner463d6a52003-08-05 15:34:45 +00001518
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001519 // Print the calling convention being used.
1520 switch (II->getCallingConv()) {
1521 case CallingConv::C: break; // default
Chris Lattner29d20852006-05-19 21:58:52 +00001522 case CallingConv::Fast: Out << " fastcc"; break;
1523 case CallingConv::Cold: Out << " coldcc"; break;
Dan Gohman81313fd2008-09-14 17:21:12 +00001524 case CallingConv::X86_StdCall: Out << " x86_stdcallcc"; break;
1525 case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001526 default: Out << " cc" << II->getCallingConv(); break;
1527 }
1528
Devang Patel221fe422008-09-29 20:49:50 +00001529 if (PAL.getRetAttributes() != Attribute::None)
1530 Out << ' ' << Attribute::getAsString(PAL.getRetAttributes());
1531
Chris Lattner463d6a52003-08-05 15:34:45 +00001532 // If possible, print out the short form of the invoke instruction. We can
1533 // only do this if the first argument is a pointer to a nonvararg function,
1534 // and if the return type is not a pointer to a function.
1535 //
Dan Gohmanc7e00ba2008-10-15 18:02:08 +00001536 Out << ' ';
Chris Lattner463d6a52003-08-05 15:34:45 +00001537 if (!FTy->isVarArg() &&
Misha Brukmanb1c93172005-04-21 23:48:37 +00001538 (!isa<PointerType>(RetTy) ||
Chris Lattner463d6a52003-08-05 15:34:45 +00001539 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
Dan Gohmanc7e00ba2008-10-15 18:02:08 +00001540 printType(RetTy);
1541 Out << ' ';
Chris Lattner463d6a52003-08-05 15:34:45 +00001542 writeOperand(Operand, false);
1543 } else {
1544 writeOperand(Operand, true);
1545 }
Misha Brukmana6619a92004-06-21 21:53:56 +00001546 Out << '(';
Reid Spencer8c4914c2006-12-31 05:24:50 +00001547 for (unsigned op = 3, Eop = I.getNumOperands(); op < Eop; ++op) {
1548 if (op > 3)
Dan Gohman81313fd2008-09-14 17:21:12 +00001549 Out << ", ";
Devang Patela05633e2008-09-26 22:53:05 +00001550 writeParamOperand(I.getOperand(op), PAL.getParamAttributes(op-2));
Chris Lattner862e3382001-10-13 06:42:36 +00001551 }
1552
Dan Gohman81313fd2008-09-14 17:21:12 +00001553 Out << ')';
Devang Patela05633e2008-09-26 22:53:05 +00001554 if (PAL.getFnAttributes() != Attribute::None)
1555 Out << ' ' << Attribute::getAsString(PAL.getFnAttributes());
1556
Dan Gohman81313fd2008-09-14 17:21:12 +00001557 Out << "\n\t\t\tto ";
Chris Lattner862e3382001-10-13 06:42:36 +00001558 writeOperand(II->getNormalDest(), true);
Dan Gohman81313fd2008-09-14 17:21:12 +00001559 Out << " unwind ";
Chris Lattnerfae8ab32004-02-08 21:44:31 +00001560 writeOperand(II->getUnwindDest(), true);
Chris Lattner862e3382001-10-13 06:42:36 +00001561
Chris Lattner113f4f42002-06-25 16:13:24 +00001562 } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001563 Out << ' ';
Chris Lattner8d48df22002-04-13 18:34:38 +00001564 printType(AI->getType()->getElementType());
1565 if (AI->isArrayAllocation()) {
Dan Gohman81313fd2008-09-14 17:21:12 +00001566 Out << ", ";
Chris Lattner8d48df22002-04-13 18:34:38 +00001567 writeOperand(AI->getArraySize(), true);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001568 }
Nate Begeman848622f2005-11-05 09:21:28 +00001569 if (AI->getAlignment()) {
Chris Lattner7aeee3a2005-11-05 21:20:34 +00001570 Out << ", align " << AI->getAlignment();
Nate Begeman848622f2005-11-05 09:21:28 +00001571 }
Chris Lattner862e3382001-10-13 06:42:36 +00001572 } else if (isa<CastInst>(I)) {
Dan Gohman81313fd2008-09-14 17:21:12 +00001573 if (Operand) {
1574 Out << ' ';
1575 writeOperand(Operand, true); // Work with broken code
1576 }
Misha Brukmana6619a92004-06-21 21:53:56 +00001577 Out << " to ";
Chris Lattner113f4f42002-06-25 16:13:24 +00001578 printType(I.getType());
Chris Lattner5b337482003-10-18 05:57:43 +00001579 } else if (isa<VAArgInst>(I)) {
Dan Gohman81313fd2008-09-14 17:21:12 +00001580 if (Operand) {
1581 Out << ' ';
1582 writeOperand(Operand, true); // Work with broken code
1583 }
Misha Brukmana6619a92004-06-21 21:53:56 +00001584 Out << ", ";
Chris Lattnerf70da102003-05-08 02:44:12 +00001585 printType(I.getType());
Chris Lattner2f7c9632001-06-06 20:29:01 +00001586 } else if (Operand) { // Print the normal way...
1587
Misha Brukmanb1c93172005-04-21 23:48:37 +00001588 // PrintAllTypes - Instructions who have operands of all the same type
Chris Lattner2f7c9632001-06-06 20:29:01 +00001589 // omit the type from all but the first operand. If the instruction has
1590 // different type operands (for example br), then they are all printed.
1591 bool PrintAllTypes = false;
1592 const Type *TheType = Operand->getType();
Chris Lattner2f7c9632001-06-06 20:29:01 +00001593
Reid Spencer0cdd04f2007-02-02 13:54:55 +00001594 // Select, Store and ShuffleVector always print all types.
Devang Patelce556d92008-03-04 22:05:14 +00001595 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
1596 || isa<ReturnInst>(I)) {
Chris Lattnerdeccfaf2003-04-16 20:20:02 +00001597 PrintAllTypes = true;
1598 } else {
1599 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
1600 Operand = I.getOperand(i);
Nuno Lopes04fe2f02009-01-15 18:40:57 +00001601 // note that Operand shouldn't be null, but the test helps make dump()
1602 // more tolerant of malformed IR
Nuno Lopes0971e772009-01-14 17:51:41 +00001603 if (Operand && Operand->getType() != TheType) {
Chris Lattnerdeccfaf2003-04-16 20:20:02 +00001604 PrintAllTypes = true; // We have differing types! Print them all!
1605 break;
1606 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001607 }
1608 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00001609
Chris Lattner7bfee412001-10-29 16:05:51 +00001610 if (!PrintAllTypes) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001611 Out << ' ';
Chris Lattnerdeccfaf2003-04-16 20:20:02 +00001612 printType(TheType);
Chris Lattner7bfee412001-10-29 16:05:51 +00001613 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001614
Dan Gohman81313fd2008-09-14 17:21:12 +00001615 Out << ' ';
Chris Lattner113f4f42002-06-25 16:13:24 +00001616 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
Dan Gohman81313fd2008-09-14 17:21:12 +00001617 if (i) Out << ", ";
Chris Lattner113f4f42002-06-25 16:13:24 +00001618 writeOperand(I.getOperand(i), PrintAllTypes);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001619 }
1620 }
Christopher Lamb84485702007-04-22 19:24:39 +00001621
1622 // Print post operand alignment for load/store
1623 if (isa<LoadInst>(I) && cast<LoadInst>(I).getAlignment()) {
1624 Out << ", align " << cast<LoadInst>(I).getAlignment();
1625 } else if (isa<StoreInst>(I) && cast<StoreInst>(I).getAlignment()) {
1626 Out << ", align " << cast<StoreInst>(I).getAlignment();
1627 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001628
Chris Lattner862e3382001-10-13 06:42:36 +00001629 printInfoComment(I);
Chris Lattner82ff9232008-08-23 22:52:27 +00001630 Out << '\n';
Chris Lattner2f7c9632001-06-06 20:29:01 +00001631}
1632
1633
1634//===----------------------------------------------------------------------===//
1635// External Interface declarations
1636//===----------------------------------------------------------------------===//
1637
Chris Lattner8339f7d2003-10-30 23:41:03 +00001638void Module::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
Chris Lattner0c19df42008-08-23 22:23:09 +00001639 raw_os_ostream OS(o);
1640 print(OS, AAW);
1641}
1642void Module::print(raw_ostream &OS, AssemblyAnnotationWriter *AAW) const {
Chris Lattnere36fd8a2008-08-19 04:26:57 +00001643 SlotTracker SlotTable(this);
Chris Lattner0c19df42008-08-23 22:23:09 +00001644 AssemblyWriter W(OS, SlotTable, this, AAW);
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +00001645 W.write(this);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001646}
1647
Misha Brukmanb1c93172005-04-21 23:48:37 +00001648void Type::print(std::ostream &o) const {
Chris Lattner0c19df42008-08-23 22:23:09 +00001649 raw_os_ostream OS(o);
1650 print(OS);
1651}
1652
Chris Lattner2ee62d22009-02-28 21:11:05 +00001653void Type::print(raw_ostream &OS) const {
1654 if (this == 0) {
1655 OS << "<null Type>";
1656 return;
1657 }
1658 TypePrinting(0, OS).print(this);
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +00001659}
1660
Chris Lattner0c19df42008-08-23 22:23:09 +00001661void Value::print(raw_ostream &OS, AssemblyAnnotationWriter *AAW) const {
1662 if (this == 0) {
1663 OS << "printing a <null> value\n";
1664 return;
1665 }
1666
1667 if (const Instruction *I = dyn_cast<Instruction>(this)) {
1668 const Function *F = I->getParent() ? I->getParent()->getParent() : 0;
1669 SlotTracker SlotTable(F);
1670 AssemblyWriter W(OS, SlotTable, F ? F->getParent() : 0, AAW);
1671 W.write(I);
1672 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(this)) {
1673 SlotTracker SlotTable(BB->getParent());
1674 AssemblyWriter W(OS, SlotTable,
1675 BB->getParent() ? BB->getParent()->getParent() : 0, AAW);
1676 W.write(BB);
1677 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(this)) {
1678 SlotTracker SlotTable(GV->getParent());
1679 AssemblyWriter W(OS, SlotTable, GV->getParent(), 0);
1680 W.write(GV);
1681 } else if (const Constant *C = dyn_cast<Constant>(this)) {
Chris Lattner0f578952009-02-28 20:25:14 +00001682 TypePrinting TypePrinter(0, OS);
Chris Lattner2ee62d22009-02-28 21:11:05 +00001683 TypePrinter.print(C->getType());
1684 OS << ' ';
Chris Lattner0f578952009-02-28 20:25:14 +00001685 WriteConstantInt(OS, C, TypePrinter, 0);
Chris Lattner0c19df42008-08-23 22:23:09 +00001686 } else if (const Argument *A = dyn_cast<Argument>(this)) {
1687 WriteAsOperand(OS, this, true,
1688 A->getParent() ? A->getParent()->getParent() : 0);
1689 } else if (isa<InlineAsm>(this)) {
1690 WriteAsOperand(OS, this, true, 0);
1691 } else {
Dan Gohmanee1cd172008-12-03 21:37:21 +00001692 assert(0 && "Unknown value to print out!");
Chris Lattner0c19df42008-08-23 22:23:09 +00001693 }
1694}
1695
1696void Value::print(std::ostream &O, AssemblyAnnotationWriter *AAW) const {
1697 raw_os_ostream OS(O);
1698 print(OS, AAW);
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +00001699}
1700
Chris Lattnerdab942552008-08-25 17:03:15 +00001701// Value::dump - allow easy printing of Values from the debugger.
Chris Lattner820eebc2008-08-25 04:55:46 +00001702void Value::dump() const { print(errs()); errs() << '\n'; errs().flush(); }
Reid Spencer52641832004-05-25 18:14:38 +00001703
Chris Lattnerdab942552008-08-25 17:03:15 +00001704// Type::dump - allow easy printing of Types from the debugger.
Chris Lattner41a83d92008-10-01 20:16:19 +00001705// This one uses type names from the given context module
1706void Type::dump(const Module *Context) const {
1707 WriteTypeSymbolic(errs(), this, Context);
1708 errs() << '\n';
1709 errs().flush();
1710}
1711
Chris Lattner24025262009-02-28 21:05:51 +00001712// Type::dump - allow easy printing of Types from the debugger.
1713void Type::dump() const { dump(0); }
1714
1715
Chris Lattnerdab942552008-08-25 17:03:15 +00001716// Module::dump() - Allow printing of Modules from the debugger.
Chris Lattner820eebc2008-08-25 04:55:46 +00001717void Module::dump() const { print(errs(), 0); errs().flush(); }
Chris Lattner0c19df42008-08-23 22:23:09 +00001718
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +00001719