blob: ccc793f36e08091c98b34fa9cce657bc95d53908 [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"
Bill Wendlingdfc91892006-11-28 02:09:03 +000034#include "llvm/Support/Streams.h"
Chris Lattner393b7cd2008-08-17 04:17:45 +000035#include "llvm/Support/raw_ostream.h"
Chris Lattnerfee714f2001-09-07 16:36:04 +000036#include <algorithm>
Reid Spencerbdf03b42007-05-22 19:27:35 +000037#include <cctype>
Chris Lattner189d19f2003-11-21 20:23:48 +000038using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000039
Chris Lattner60a7dd12004-07-15 02:51:31 +000040namespace llvm {
Reid Spencer16f2f7f2004-05-26 07:18:52 +000041
Reid Spencer294715b2005-05-15 16:13:11 +000042// Make virtual table appear in this compilation unit.
43AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
44
Reid Spencer16f2f7f2004-05-26 07:18:52 +000045/// This class provides computation of slot numbers for LLVM Assembly writing.
Chris Lattner393b7cd2008-08-17 04:17:45 +000046///
Chris Lattnere36fd8a2008-08-19 04:26:57 +000047class SlotTracker {
Reid Spencer16f2f7f2004-05-26 07:18:52 +000048public:
Chris Lattner393b7cd2008-08-17 04:17:45 +000049 /// ValueMap - A mapping of Values to slot numbers
Chris Lattnera204d412008-08-17 17:25:25 +000050 typedef DenseMap<const Value*, unsigned> ValueMap;
Chris Lattner393b7cd2008-08-17 04:17:45 +000051
52private:
53 /// TheModule - The module for which we are holding slot numbers
54 const Module* TheModule;
55
56 /// TheFunction - The function for which we are holding slot numbers
57 const Function* TheFunction;
58 bool FunctionProcessed;
59
60 /// mMap - The TypePlanes map for the module level data
61 ValueMap mMap;
62 unsigned mNext;
63
64 /// fMap - The TypePlanes map for the function level data
65 ValueMap fMap;
66 unsigned fNext;
67
Reid Spencer16f2f7f2004-05-26 07:18:52 +000068public:
Chris Lattner393b7cd2008-08-17 04:17:45 +000069 /// Construct from a module
Chris Lattnere36fd8a2008-08-19 04:26:57 +000070 explicit SlotTracker(const Module *M);
Chris Lattner393b7cd2008-08-17 04:17:45 +000071 /// Construct from a function, starting out in incorp state.
Chris Lattnere36fd8a2008-08-19 04:26:57 +000072 explicit SlotTracker(const Function *F);
Reid Spencer16f2f7f2004-05-26 07:18:52 +000073
Reid Spencer16f2f7f2004-05-26 07:18:52 +000074 /// Return the slot number of the specified value in it's type
Chris Lattnere36fd8a2008-08-19 04:26:57 +000075 /// plane. If something is not in the SlotTracker, return -1.
Chris Lattner5e043322007-01-11 03:54:27 +000076 int getLocalSlot(const Value *V);
77 int getGlobalSlot(const GlobalValue *V);
Reid Spencer8beac692004-06-09 15:26:53 +000078
Misha Brukmanb1c93172005-04-21 23:48:37 +000079 /// If you'd like to deal with a function instead of just a module, use
Chris Lattnere36fd8a2008-08-19 04:26:57 +000080 /// this method to get its data into the SlotTracker.
Misha Brukmanb1c93172005-04-21 23:48:37 +000081 void incorporateFunction(const Function *F) {
82 TheFunction = F;
Reid Spencerb0ac8c42004-08-16 07:46:33 +000083 FunctionProcessed = false;
84 }
Reid Spencer16f2f7f2004-05-26 07:18:52 +000085
Misha Brukmanb1c93172005-04-21 23:48:37 +000086 /// After calling incorporateFunction, use this method to remove the
Chris Lattnere36fd8a2008-08-19 04:26:57 +000087 /// most recently incorporated function from the SlotTracker. This
Reid Spencer16f2f7f2004-05-26 07:18:52 +000088 /// will reset the state of the machine back to just the module contents.
89 void purgeFunction();
90
Chris Lattner393b7cd2008-08-17 04:17:45 +000091 // Implementation Details
Reid Spencer16f2f7f2004-05-26 07:18:52 +000092private:
Reid Spencer56010e42004-05-26 21:56:09 +000093 /// This function does the actual initialization.
94 inline void initialize();
95
Chris Lattnerea862a32007-01-09 07:55:49 +000096 /// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
97 void CreateModuleSlot(const GlobalValue *V);
98
99 /// CreateFunctionSlot - Insert the specified Value* into the slot table.
100 void CreateFunctionSlot(const Value *V);
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000101
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000102 /// Add all of the module level global variables (and their initializers)
103 /// and function declarations, but not the contents of those functions.
104 void processModule();
105
Reid Spencer56010e42004-05-26 21:56:09 +0000106 /// Add all of the functions arguments, basic blocks, and instructions
107 void processFunction();
108
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000109 SlotTracker(const SlotTracker &); // DO NOT IMPLEMENT
110 void operator=(const SlotTracker &); // DO NOT IMPLEMENT
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000111};
112
Chris Lattner60a7dd12004-07-15 02:51:31 +0000113} // end namespace llvm
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000114
Devang Patel8c78a0b2007-05-03 01:11:54 +0000115char PrintModulePass::ID = 0;
Chris Lattnerc2d3d312006-08-27 22:42:52 +0000116static RegisterPass<PrintModulePass>
Chris Lattnere7134c52006-08-21 17:20:01 +0000117X("printm", "Print module to stderr");
Devang Patel8c78a0b2007-05-03 01:11:54 +0000118char PrintFunctionPass::ID = 0;
Chris Lattnerc2d3d312006-08-27 22:42:52 +0000119static RegisterPass<PrintFunctionPass>
Chris Lattnere7134c52006-08-21 17:20:01 +0000120Y("print","Print function to stderr");
Chris Lattner7f8845a2002-07-23 18:07:49 +0000121
Misha Brukmanb1c93172005-04-21 23:48:37 +0000122static void WriteAsOperandInternal(std::ostream &Out, const Value *V,
Chris Lattnera9f0a112006-12-06 05:50:41 +0000123 std::map<const Type *, std::string> &TypeTable,
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000124 SlotTracker *Machine);
Reid Spencer58d30f22004-07-04 11:50:43 +0000125
Chris Lattnerb86620e2001-10-29 16:37:48 +0000126static const Module *getModuleFromVal(const Value *V) {
Chris Lattnerf26a8ee2003-07-23 15:30:06 +0000127 if (const Argument *MA = dyn_cast<Argument>(V))
Chris Lattnerb86620e2001-10-29 16:37:48 +0000128 return MA->getParent() ? MA->getParent()->getParent() : 0;
Chris Lattnerf26a8ee2003-07-23 15:30:06 +0000129 else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
Chris Lattnerb86620e2001-10-29 16:37:48 +0000130 return BB->getParent() ? BB->getParent()->getParent() : 0;
Chris Lattnerf26a8ee2003-07-23 15:30:06 +0000131 else if (const Instruction *I = dyn_cast<Instruction>(V)) {
Chris Lattner57698e22002-03-26 18:01:55 +0000132 const Function *M = I->getParent() ? I->getParent()->getParent() : 0;
Chris Lattnerb86620e2001-10-29 16:37:48 +0000133 return M ? M->getParent() : 0;
Chris Lattnerf26a8ee2003-07-23 15:30:06 +0000134 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
Chris Lattnerb86620e2001-10-29 16:37:48 +0000135 return GV->getParent();
Chris Lattnerb86620e2001-10-29 16:37:48 +0000136 return 0;
137}
138
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000139static SlotTracker *createSlotTracker(const Value *V) {
Chris Lattnerf26a8ee2003-07-23 15:30:06 +0000140 if (const Argument *FA = dyn_cast<Argument>(V)) {
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000141 return new SlotTracker(FA->getParent());
Chris Lattnerf26a8ee2003-07-23 15:30:06 +0000142 } else if (const Instruction *I = dyn_cast<Instruction>(V)) {
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000143 return new SlotTracker(I->getParent()->getParent());
Chris Lattnerf26a8ee2003-07-23 15:30:06 +0000144 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V)) {
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000145 return new SlotTracker(BB->getParent());
Chris Lattnerf26a8ee2003-07-23 15:30:06 +0000146 } else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V)){
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000147 return new SlotTracker(GV->getParent());
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000148 } else if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V)){
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000149 return new SlotTracker(GA->getParent());
Chris Lattnerf26a8ee2003-07-23 15:30:06 +0000150 } else if (const Function *Func = dyn_cast<Function>(V)) {
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000151 return new SlotTracker(Func);
Chris Lattner7bfee412001-10-29 16:05:51 +0000152 }
153 return 0;
154}
Chris Lattner2f7c9632001-06-06 20:29:01 +0000155
Reid Spencer788e3172007-01-26 08:02:52 +0000156/// NameNeedsQuotes - Return true if the specified llvm name should be wrapped
157/// with ""'s.
Reid Spencerbdf03b42007-05-22 19:27:35 +0000158static std::string QuoteNameIfNeeded(const std::string &Name) {
159 std::string result;
160 bool needsQuotes = Name[0] >= '0' && Name[0] <= '9';
161 // Scan the name to see if it needs quotes and to replace funky chars with
162 // their octal equivalent.
Chris Lattner1c343042003-08-22 05:40:38 +0000163 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
164 char C = Name[i];
165 assert(C != '"' && "Illegal character in LLVM value name!");
Reid Spencerbdf03b42007-05-22 19:27:35 +0000166 if (isalnum(C) || C == '-' || C == '.' || C == '_')
167 result += C;
168 else if (C == '\\') {
169 needsQuotes = true;
170 result += "\\\\";
171 } else if (isprint(C)) {
172 needsQuotes = true;
173 result += C;
174 } else {
175 needsQuotes = true;
176 result += "\\";
177 char hex1 = (C >> 4) & 0x0F;
178 if (hex1 < 10)
179 result += hex1 + '0';
180 else
181 result += hex1 - 10 + 'A';
182 char hex2 = C & 0x0F;
183 if (hex2 < 10)
184 result += hex2 + '0';
185 else
186 result += hex2 - 10 + 'A';
187 }
Reid Spencer788e3172007-01-26 08:02:52 +0000188 }
Reid Spencerbdf03b42007-05-22 19:27:35 +0000189 if (needsQuotes) {
190 result.insert(0,"\"");
191 result += '"';
192 }
193 return result;
Reid Spencer788e3172007-01-26 08:02:52 +0000194}
195
Chris Lattner663d2922008-08-17 17:28:37 +0000196/// getLLVMName - Turn the specified string into an 'LLVM name', which is either
197/// prefixed with % (if the string only contains simple characters) or is
198/// surrounded with ""'s (if it has special chars in it).
199static std::string getLLVMName(const std::string &Name) {
200 assert(!Name.empty() && "Cannot get empty name!");
201 return '%' + QuoteNameIfNeeded(Name);
202}
203
Reid Spencer788e3172007-01-26 08:02:52 +0000204enum PrefixType {
205 GlobalPrefix,
206 LabelPrefix,
207 LocalPrefix
208};
209
Chris Lattner033935d2008-08-17 04:40:13 +0000210/// PrintLLVMName - Turn the specified name into an 'LLVM name', which is either
211/// prefixed with % (if the string only contains simple characters) or is
212/// surrounded with ""'s (if it has special chars in it). Print it out.
213static void PrintLLVMName(std::ostream &OS, const ValueName *Name,
214 PrefixType Prefix) {
215 assert(Name && "Cannot get empty name!");
216 switch (Prefix) {
217 default: assert(0 && "Bad prefix!");
218 case GlobalPrefix: OS << '@'; break;
219 case LabelPrefix: break;
220 case LocalPrefix: OS << '%'; break;
221 }
222
223 // Scan the name to see if it needs quotes first.
224 const char *NameStr = Name->getKeyData();
225 unsigned NameLen = Name->getKeyLength();
226
227 bool NeedsQuotes = NameStr[0] >= '0' && NameStr[0] <= '9';
228 if (!NeedsQuotes) {
229 for (unsigned i = 0; i != NameLen; ++i) {
230 char C = NameStr[i];
231 if (!isalnum(C) && C != '-' && C != '.' && C != '_') {
232 NeedsQuotes = true;
233 break;
234 }
235 }
236 }
237
238 // If we didn't need any quotes, just write out the name in one blast.
239 if (!NeedsQuotes) {
240 OS.write(NameStr, NameLen);
241 return;
242 }
243
244 // Okay, we need quotes. Output the quotes and escape any scary characters as
245 // needed.
246 OS << '"';
247 for (unsigned i = 0; i != NameLen; ++i) {
248 char C = NameStr[i];
249 assert(C != '"' && "Illegal character in LLVM value name!");
250 if (C == '\\') {
251 OS << "\\\\";
252 } else if (isprint(C)) {
253 OS << C;
254 } else {
Chris Lattner30fc0582008-08-18 19:41:26 +0000255 OS << '\\';
Chris Lattner033935d2008-08-17 04:40:13 +0000256 char hex1 = (C >> 4) & 0x0F;
257 if (hex1 < 10)
Chris Lattner30fc0582008-08-18 19:41:26 +0000258 OS << (char)(hex1 + '0');
Chris Lattner033935d2008-08-17 04:40:13 +0000259 else
Chris Lattner30fc0582008-08-18 19:41:26 +0000260 OS << (char)(hex1 - 10 + 'A');
Chris Lattner033935d2008-08-17 04:40:13 +0000261 char hex2 = C & 0x0F;
262 if (hex2 < 10)
Chris Lattner30fc0582008-08-18 19:41:26 +0000263 OS << (char)(hex2 + '0');
Chris Lattner033935d2008-08-17 04:40:13 +0000264 else
Chris Lattner30fc0582008-08-18 19:41:26 +0000265 OS << (char)(hex2 - 10 + 'A');
Chris Lattner033935d2008-08-17 04:40:13 +0000266 }
267 }
268 OS << '"';
269}
270
271static void PrintLLVMName(std::ostream &OS, const Value *V) {
272 PrintLLVMName(OS, V->getValueName(),
273 isa<GlobalValue>(V) ? GlobalPrefix : LocalPrefix);
274}
275
Chris Lattnerb86620e2001-10-29 16:37:48 +0000276
Misha Brukmanc566ca362004-03-02 00:22:19 +0000277/// fillTypeNameTable - If the module has a symbol table, take all global types
278/// and stuff their names into the TypeNames map.
279///
Chris Lattnerb86620e2001-10-29 16:37:48 +0000280static void fillTypeNameTable(const Module *M,
Chris Lattnerab7d1ab2003-05-08 02:08:14 +0000281 std::map<const Type *, std::string> &TypeNames) {
Chris Lattner98cf1f52002-11-20 18:36:02 +0000282 if (!M) return;
Reid Spencer32af9e82007-01-06 07:24:44 +0000283 const TypeSymbolTable &ST = M->getTypeSymbolTable();
284 TypeSymbolTable::const_iterator TI = ST.begin();
285 for (; TI != ST.end(); ++TI) {
Reid Spencere7e96712004-05-25 08:53:40 +0000286 // As a heuristic, don't insert pointer to primitive types, because
287 // they are used too often to have a single useful name.
288 //
289 const Type *Ty = cast<Type>(TI->second);
290 if (!isa<PointerType>(Ty) ||
Reid Spencer56010e42004-05-26 21:56:09 +0000291 !cast<PointerType>(Ty)->getElementType()->isPrimitiveType() ||
Chris Lattner03c49532007-01-15 02:27:26 +0000292 !cast<PointerType>(Ty)->getElementType()->isInteger() ||
Reid Spencer56010e42004-05-26 21:56:09 +0000293 isa<OpaqueType>(cast<PointerType>(Ty)->getElementType()))
Chris Lattner663d2922008-08-17 17:28:37 +0000294 TypeNames.insert(std::make_pair(Ty, getLLVMName(TI->first)));
Chris Lattnerb86620e2001-10-29 16:37:48 +0000295 }
296}
297
298
299
Misha Brukmanb1c93172005-04-21 23:48:37 +0000300static void calcTypeName(const Type *Ty,
John Criswellcd116ba2004-06-01 14:54:08 +0000301 std::vector<const Type *> &TypeStack,
302 std::map<const Type *, std::string> &TypeNames,
303 std::string & Result){
Chris Lattner03c49532007-01-15 02:27:26 +0000304 if (Ty->isInteger() || (Ty->isPrimitiveType() && !isa<OpaqueType>(Ty))) {
John Criswellcd116ba2004-06-01 14:54:08 +0000305 Result += Ty->getDescription(); // Base case
306 return;
307 }
Chris Lattnerb86620e2001-10-29 16:37:48 +0000308
309 // Check to see if the type is named.
Chris Lattnerab7d1ab2003-05-08 02:08:14 +0000310 std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
John Criswellcd116ba2004-06-01 14:54:08 +0000311 if (I != TypeNames.end()) {
312 Result += I->second;
313 return;
314 }
Chris Lattnerb86620e2001-10-29 16:37:48 +0000315
John Criswellcd116ba2004-06-01 14:54:08 +0000316 if (isa<OpaqueType>(Ty)) {
317 Result += "opaque";
318 return;
319 }
Chris Lattnerf14ead92003-10-30 00:22:33 +0000320
Chris Lattnerb86620e2001-10-29 16:37:48 +0000321 // Check to see if the Type is already on the stack...
322 unsigned Slot = 0, CurSize = TypeStack.size();
323 while (Slot < CurSize && TypeStack[Slot] != Ty) ++Slot; // Scan for type
324
Misha Brukmanb1c93172005-04-21 23:48:37 +0000325 // This is another base case for the recursion. In this case, we know
Chris Lattnerb86620e2001-10-29 16:37:48 +0000326 // that we have looped back to a type that we have previously visited.
327 // Generate the appropriate upreference to handle this.
John Criswellcd116ba2004-06-01 14:54:08 +0000328 if (Slot < CurSize) {
329 Result += "\\" + utostr(CurSize-Slot); // Here's the upreference
330 return;
331 }
Chris Lattnerb86620e2001-10-29 16:37:48 +0000332
333 TypeStack.push_back(Ty); // Recursive case: Add us to the stack..
Misha Brukmanb1c93172005-04-21 23:48:37 +0000334
Chris Lattner6b727592004-06-17 18:19:28 +0000335 switch (Ty->getTypeID()) {
Reid Spencer7a9c62b2007-01-12 07:05:14 +0000336 case Type::IntegerTyID: {
337 unsigned BitWidth = cast<IntegerType>(Ty)->getBitWidth();
Reid Spencerc8721592007-01-12 07:25:20 +0000338 Result += "i" + utostr(BitWidth);
Reid Spencer7a9c62b2007-01-12 07:05:14 +0000339 break;
340 }
Chris Lattner91db5822002-03-29 03:44:36 +0000341 case Type::FunctionTyID: {
Chris Lattnerf26a8ee2003-07-23 15:30:06 +0000342 const FunctionType *FTy = cast<FunctionType>(Ty);
John Criswellcd116ba2004-06-01 14:54:08 +0000343 calcTypeName(FTy->getReturnType(), TypeStack, TypeNames, Result);
344 Result += " (";
Chris Lattnerfa829be2004-02-09 04:14:01 +0000345 for (FunctionType::param_iterator I = FTy->param_begin(),
Duncan Sandsad0ea2d2007-11-27 13:23:08 +0000346 E = FTy->param_end(); I != E; ++I) {
Chris Lattnerfa829be2004-02-09 04:14:01 +0000347 if (I != FTy->param_begin())
Chris Lattnerb86620e2001-10-29 16:37:48 +0000348 Result += ", ";
John Criswellcd116ba2004-06-01 14:54:08 +0000349 calcTypeName(*I, TypeStack, TypeNames, Result);
Chris Lattnerb86620e2001-10-29 16:37:48 +0000350 }
Chris Lattnerd816b532002-04-13 20:53:41 +0000351 if (FTy->isVarArg()) {
Chris Lattnerfa829be2004-02-09 04:14:01 +0000352 if (FTy->getNumParams()) Result += ", ";
Chris Lattnerb86620e2001-10-29 16:37:48 +0000353 Result += "...";
354 }
355 Result += ")";
356 break;
357 }
358 case Type::StructTyID: {
Chris Lattnerf26a8ee2003-07-23 15:30:06 +0000359 const StructType *STy = cast<StructType>(Ty);
Andrew Lenharthdcb3c972006-12-08 18:06:16 +0000360 if (STy->isPacked())
361 Result += '<';
John Criswellcd116ba2004-06-01 14:54:08 +0000362 Result += "{ ";
Chris Lattnerac6db752004-02-09 04:37:31 +0000363 for (StructType::element_iterator I = STy->element_begin(),
364 E = STy->element_end(); I != E; ++I) {
365 if (I != STy->element_begin())
Chris Lattnerb86620e2001-10-29 16:37:48 +0000366 Result += ", ";
John Criswellcd116ba2004-06-01 14:54:08 +0000367 calcTypeName(*I, TypeStack, TypeNames, Result);
Chris Lattnerb86620e2001-10-29 16:37:48 +0000368 }
369 Result += " }";
Andrew Lenharthdcb3c972006-12-08 18:06:16 +0000370 if (STy->isPacked())
371 Result += '>';
Chris Lattnerb86620e2001-10-29 16:37:48 +0000372 break;
373 }
Christopher Lamb54dd24c2007-12-11 08:59:05 +0000374 case Type::PointerTyID: {
375 const PointerType *PTy = cast<PointerType>(Ty);
376 calcTypeName(PTy->getElementType(),
John Criswellcd116ba2004-06-01 14:54:08 +0000377 TypeStack, TypeNames, Result);
Christopher Lamb54dd24c2007-12-11 08:59:05 +0000378 if (unsigned AddressSpace = PTy->getAddressSpace())
379 Result += " addrspace(" + utostr(AddressSpace) + ")";
John Criswellcd116ba2004-06-01 14:54:08 +0000380 Result += "*";
Chris Lattnerb86620e2001-10-29 16:37:48 +0000381 break;
Christopher Lamb54dd24c2007-12-11 08:59:05 +0000382 }
Chris Lattnerb86620e2001-10-29 16:37:48 +0000383 case Type::ArrayTyID: {
Chris Lattnerf26a8ee2003-07-23 15:30:06 +0000384 const ArrayType *ATy = cast<ArrayType>(Ty);
John Criswellcd116ba2004-06-01 14:54:08 +0000385 Result += "[" + utostr(ATy->getNumElements()) + " x ";
386 calcTypeName(ATy->getElementType(), TypeStack, TypeNames, Result);
387 Result += "]";
Chris Lattnerb86620e2001-10-29 16:37:48 +0000388 break;
389 }
Reid Spencerd84d35b2007-02-15 02:26:10 +0000390 case Type::VectorTyID: {
391 const VectorType *PTy = cast<VectorType>(Ty);
Brian Gaeke02209042004-08-20 06:00:58 +0000392 Result += "<" + utostr(PTy->getNumElements()) + " x ";
393 calcTypeName(PTy->getElementType(), TypeStack, TypeNames, Result);
394 Result += ">";
395 break;
396 }
Chris Lattner15285ab2003-05-14 17:50:47 +0000397 case Type::OpaqueTyID:
John Criswellcd116ba2004-06-01 14:54:08 +0000398 Result += "opaque";
Chris Lattner15285ab2003-05-14 17:50:47 +0000399 break;
Chris Lattnerb86620e2001-10-29 16:37:48 +0000400 default:
John Criswellcd116ba2004-06-01 14:54:08 +0000401 Result += "<unrecognized-type>";
Chris Lattnerfc9f1c92006-12-06 06:40:49 +0000402 break;
Chris Lattnerb86620e2001-10-29 16:37:48 +0000403 }
404
405 TypeStack.pop_back(); // Remove self from stack...
Chris Lattnerb86620e2001-10-29 16:37:48 +0000406}
407
408
Misha Brukmanb22d09c2004-03-01 19:48:13 +0000409/// printTypeInt - The internal guts of printing out a type that has a
410/// potentially named portion.
411///
Chris Lattnerab7d1ab2003-05-08 02:08:14 +0000412static std::ostream &printTypeInt(std::ostream &Out, const Type *Ty,
413 std::map<const Type *, std::string> &TypeNames) {
Chris Lattnerb86620e2001-10-29 16:37:48 +0000414 // Primitive types always print out their description, regardless of whether
415 // they have been named or not.
416 //
Chris Lattner03c49532007-01-15 02:27:26 +0000417 if (Ty->isInteger() || (Ty->isPrimitiveType() && !isa<OpaqueType>(Ty)))
Chris Lattner92d60532003-10-30 00:12:51 +0000418 return Out << Ty->getDescription();
Chris Lattnerb86620e2001-10-29 16:37:48 +0000419
420 // Check to see if the type is named.
Chris Lattnerab7d1ab2003-05-08 02:08:14 +0000421 std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
Chris Lattnerb86620e2001-10-29 16:37:48 +0000422 if (I != TypeNames.end()) return Out << I->second;
423
424 // Otherwise we have a type that has not been named but is a derived type.
425 // Carefully recurse the type hierarchy to print out any contained symbolic
426 // names.
427 //
Chris Lattnerab7d1ab2003-05-08 02:08:14 +0000428 std::vector<const Type *> TypeStack;
John Criswellcd116ba2004-06-01 14:54:08 +0000429 std::string TypeName;
430 calcTypeName(Ty, TypeStack, TypeNames, TypeName);
Chris Lattner7f74a562002-01-20 22:54:45 +0000431 TypeNames.insert(std::make_pair(Ty, TypeName));//Cache type name for later use
John Criswellcd116ba2004-06-01 14:54:08 +0000432 return (Out << TypeName);
Chris Lattnerb86620e2001-10-29 16:37:48 +0000433}
434
Chris Lattner34b95182001-10-31 04:33:19 +0000435
Misha Brukmanb22d09c2004-03-01 19:48:13 +0000436/// WriteTypeSymbolic - This attempts to write the specified type as a symbolic
437/// type, iff there is an entry in the modules symbol table for the specified
438/// type or one of it's component types. This is slower than a simple x << Type
439///
Chris Lattner189d19f2003-11-21 20:23:48 +0000440std::ostream &llvm::WriteTypeSymbolic(std::ostream &Out, const Type *Ty,
441 const Module *M) {
Misha Brukmanb1c93172005-04-21 23:48:37 +0000442 Out << ' ';
Chris Lattnerb86620e2001-10-29 16:37:48 +0000443
Chris Lattnerfc9f1c92006-12-06 06:40:49 +0000444 // If they want us to print out a type, but there is no context, we can't
445 // print it symbolically.
446 if (!M)
Chris Lattner72f866e2001-10-29 16:40:32 +0000447 return Out << Ty->getDescription();
Chris Lattnerfc9f1c92006-12-06 06:40:49 +0000448
449 std::map<const Type *, std::string> TypeNames;
450 fillTypeNameTable(M, TypeNames);
451 return printTypeInt(Out, Ty, TypeNames);
Chris Lattnerb86620e2001-10-29 16:37:48 +0000452}
453
Chris Lattner6ed87bd2006-01-23 23:03:36 +0000454// PrintEscapedString - Print each character of the specified string, escaping
455// it if it is not printable or if it is an escape char.
456static void PrintEscapedString(const std::string &Str, std::ostream &Out) {
457 for (unsigned i = 0, e = Str.size(); i != e; ++i) {
458 unsigned char C = Str[i];
459 if (isprint(C) && C != '"' && C != '\\') {
460 Out << C;
461 } else {
462 Out << '\\'
463 << (char) ((C/16 < 10) ? ( C/16 +'0') : ( C/16 -10+'A'))
464 << (char)(((C&15) < 10) ? ((C&15)+'0') : ((C&15)-10+'A'));
465 }
466 }
467}
468
Chris Lattnerfc9f1c92006-12-06 06:40:49 +0000469static const char *getPredicateText(unsigned predicate) {
Reid Spencer812a1be2006-12-04 05:19:18 +0000470 const char * pred = "unknown";
471 switch (predicate) {
472 case FCmpInst::FCMP_FALSE: pred = "false"; break;
473 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
474 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
475 case FCmpInst::FCMP_OGE: pred = "oge"; break;
476 case FCmpInst::FCMP_OLT: pred = "olt"; break;
477 case FCmpInst::FCMP_OLE: pred = "ole"; break;
478 case FCmpInst::FCMP_ONE: pred = "one"; break;
479 case FCmpInst::FCMP_ORD: pred = "ord"; break;
480 case FCmpInst::FCMP_UNO: pred = "uno"; break;
481 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
482 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
483 case FCmpInst::FCMP_UGE: pred = "uge"; break;
484 case FCmpInst::FCMP_ULT: pred = "ult"; break;
485 case FCmpInst::FCMP_ULE: pred = "ule"; break;
486 case FCmpInst::FCMP_UNE: pred = "une"; break;
487 case FCmpInst::FCMP_TRUE: pred = "true"; break;
488 case ICmpInst::ICMP_EQ: pred = "eq"; break;
489 case ICmpInst::ICMP_NE: pred = "ne"; break;
490 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
491 case ICmpInst::ICMP_SGE: pred = "sge"; break;
492 case ICmpInst::ICMP_SLT: pred = "slt"; break;
493 case ICmpInst::ICMP_SLE: pred = "sle"; break;
494 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
495 case ICmpInst::ICMP_UGE: pred = "uge"; break;
496 case ICmpInst::ICMP_ULT: pred = "ult"; break;
497 case ICmpInst::ICMP_ULE: pred = "ule"; break;
498 }
499 return pred;
500}
501
Misha Brukmanb1c93172005-04-21 23:48:37 +0000502static void WriteConstantInt(std::ostream &Out, const Constant *CV,
Chris Lattnerab7d1ab2003-05-08 02:08:14 +0000503 std::map<const Type *, std::string> &TypeTable,
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000504 SlotTracker *Machine) {
Jim Laskey6be3d8e2006-02-27 10:33:53 +0000505 const int IndentSize = 4;
Chris Lattner17f71652008-08-17 07:19:36 +0000506 // FIXME: WHY IS INDENT STATIC??
Jim Laskey6be3d8e2006-02-27 10:33:53 +0000507 static std::string Indent = "\n";
Zhou Sheng75b871f2007-01-11 12:24:14 +0000508 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
Chris Lattner17f71652008-08-17 07:19:36 +0000509 if (CI->getType() == Type::Int1Ty) {
Reid Spencercddc9df2007-01-12 04:24:46 +0000510 Out << (CI->getZExtValue() ? "true" : "false");
Chris Lattner17f71652008-08-17 07:19:36 +0000511 return;
512 }
513 Out << CI->getValue();
514 return;
515 }
516
517 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
Dale Johannesen028084e2007-09-12 03:30:33 +0000518 if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEdouble ||
519 &CFP->getValueAPF().getSemantics() == &APFloat::IEEEsingle) {
520 // We would like to output the FP constant value in exponential notation,
521 // but we cannot do this if doing so will lose precision. Check here to
522 // make sure that we only output it in exponential format if we can parse
523 // the value back and get the same value.
524 //
525 bool isDouble = &CFP->getValueAPF().getSemantics()==&APFloat::IEEEdouble;
Chris Lattner17f71652008-08-17 07:19:36 +0000526 double Val = isDouble ? CFP->getValueAPF().convertToDouble() :
527 CFP->getValueAPF().convertToFloat();
Dale Johannesen028084e2007-09-12 03:30:33 +0000528 std::string StrVal = ftostr(CFP->getValueAPF());
Chris Lattner1e194682002-04-18 18:53:13 +0000529
Dale Johannesen028084e2007-09-12 03:30:33 +0000530 // Check to make sure that the stringized number is not some string like
531 // "Inf" or NaN, that atof will accept, but the lexer will not. Check
532 // that the string matches the "[-+]?[0-9]" regex.
533 //
534 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
535 ((StrVal[0] == '-' || StrVal[0] == '+') &&
536 (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
537 // Reparse stringized version!
538 if (atof(StrVal.c_str()) == Val) {
539 Out << StrVal;
540 return;
541 }
Chris Lattner1e194682002-04-18 18:53:13 +0000542 }
Dale Johannesen028084e2007-09-12 03:30:33 +0000543 // Otherwise we could not reparse it to exactly the same value, so we must
544 // output the string in hexadecimal format!
545 assert(sizeof(double) == sizeof(uint64_t) &&
546 "assuming that double is 64 bits!");
547 Out << "0x" << utohexstr(DoubleToBits(Val));
548 } else {
549 // Some form of long double. These appear as a magic letter identifying
550 // the type, then a fixed number of hex digits.
551 Out << "0x";
552 if (&CFP->getValueAPF().getSemantics() == &APFloat::x87DoubleExtended)
553 Out << 'K';
554 else if (&CFP->getValueAPF().getSemantics() == &APFloat::IEEEquad)
555 Out << 'L';
Dale Johannesen007aa372007-10-11 18:07:22 +0000556 else if (&CFP->getValueAPF().getSemantics() == &APFloat::PPCDoubleDouble)
557 Out << 'M';
Dale Johannesen028084e2007-09-12 03:30:33 +0000558 else
559 assert(0 && "Unsupported floating point type");
Dale Johannesen34aa41c2007-09-26 23:20:33 +0000560 // api needed to prevent premature destruction
561 APInt api = CFP->getValueAPF().convertToAPInt();
562 const uint64_t* p = api.getRawData();
Dale Johannesen028084e2007-09-12 03:30:33 +0000563 uint64_t word = *p;
564 int shiftcount=60;
Dale Johannesen007aa372007-10-11 18:07:22 +0000565 int width = api.getBitWidth();
Dale Johannesen028084e2007-09-12 03:30:33 +0000566 for (int j=0; j<width; j+=4, shiftcount-=4) {
567 unsigned int nibble = (word>>shiftcount) & 15;
568 if (nibble < 10)
569 Out << (unsigned char)(nibble + '0');
570 else
571 Out << (unsigned char)(nibble - 10 + 'A');
Dale Johannesen4675c4e2008-04-16 17:31:41 +0000572 if (shiftcount == 0 && j+4 < width) {
Dale Johannesen028084e2007-09-12 03:30:33 +0000573 word = *(++p);
Dale Johannesen007aa372007-10-11 18:07:22 +0000574 shiftcount = 64;
Dale Johannesen028084e2007-09-12 03:30:33 +0000575 if (width-j-4 < 64)
576 shiftcount = width-j-4;
577 }
578 }
579 }
Chris Lattner76b2ff42004-02-15 05:55:15 +0000580 } else if (isa<ConstantAggregateZero>(CV)) {
581 Out << "zeroinitializer";
Chris Lattner1e194682002-04-18 18:53:13 +0000582 } else if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
583 // As a special case, print the array as a string if it is an array of
Dan Gohmane9bc2ba2008-05-12 16:34:30 +0000584 // i8 with ConstantInt values.
Misha Brukmanb1c93172005-04-21 23:48:37 +0000585 //
Chris Lattner1e194682002-04-18 18:53:13 +0000586 const Type *ETy = CA->getType()->getElementType();
Chris Lattner6ed87bd2006-01-23 23:03:36 +0000587 if (CA->isString()) {
Chris Lattner1e194682002-04-18 18:53:13 +0000588 Out << "c\"";
Chris Lattner6ed87bd2006-01-23 23:03:36 +0000589 PrintEscapedString(CA->getAsString(), Out);
Chris Lattner1e194682002-04-18 18:53:13 +0000590 Out << "\"";
591
592 } else { // Cannot output in string format...
Misha Brukman21bbdb92004-06-04 21:11:51 +0000593 Out << '[';
Chris Lattnerd84bb632002-04-16 21:36:08 +0000594 if (CA->getNumOperands()) {
Misha Brukman21bbdb92004-06-04 21:11:51 +0000595 Out << ' ';
Chris Lattner1e194682002-04-18 18:53:13 +0000596 printTypeInt(Out, ETy, TypeTable);
Chris Lattnerd84bb632002-04-16 21:36:08 +0000597 WriteAsOperandInternal(Out, CA->getOperand(0),
Chris Lattner78e2e8b2006-12-06 06:24:27 +0000598 TypeTable, Machine);
Chris Lattnerd84bb632002-04-16 21:36:08 +0000599 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
600 Out << ", ";
Chris Lattner1e194682002-04-18 18:53:13 +0000601 printTypeInt(Out, ETy, TypeTable);
Chris Lattner78e2e8b2006-12-06 06:24:27 +0000602 WriteAsOperandInternal(Out, CA->getOperand(i), TypeTable, Machine);
Chris Lattnerd84bb632002-04-16 21:36:08 +0000603 }
604 }
605 Out << " ]";
606 }
607 } else if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
Andrew Lenharth0d124b82007-01-08 18:21:30 +0000608 if (CS->getType()->isPacked())
609 Out << '<';
Misha Brukman21bbdb92004-06-04 21:11:51 +0000610 Out << '{';
Jim Laskey3bb78742006-02-25 12:27:03 +0000611 unsigned N = CS->getNumOperands();
612 if (N) {
Jim Laskey6be3d8e2006-02-27 10:33:53 +0000613 if (N > 2) {
614 Indent += std::string(IndentSize, ' ');
615 Out << Indent;
616 } else {
617 Out << ' ';
618 }
Chris Lattnerd84bb632002-04-16 21:36:08 +0000619 printTypeInt(Out, CS->getOperand(0)->getType(), TypeTable);
620
Chris Lattner78e2e8b2006-12-06 06:24:27 +0000621 WriteAsOperandInternal(Out, CS->getOperand(0), TypeTable, Machine);
Chris Lattnerd84bb632002-04-16 21:36:08 +0000622
Jim Laskey3bb78742006-02-25 12:27:03 +0000623 for (unsigned i = 1; i < N; i++) {
Chris Lattnerd84bb632002-04-16 21:36:08 +0000624 Out << ", ";
Jim Laskey6be3d8e2006-02-27 10:33:53 +0000625 if (N > 2) Out << Indent;
Chris Lattnerd84bb632002-04-16 21:36:08 +0000626 printTypeInt(Out, CS->getOperand(i)->getType(), TypeTable);
627
Chris Lattner78e2e8b2006-12-06 06:24:27 +0000628 WriteAsOperandInternal(Out, CS->getOperand(i), TypeTable, Machine);
Chris Lattnerd84bb632002-04-16 21:36:08 +0000629 }
Jim Laskey6be3d8e2006-02-27 10:33:53 +0000630 if (N > 2) Indent.resize(Indent.size() - IndentSize);
Chris Lattnerd84bb632002-04-16 21:36:08 +0000631 }
Jim Laskey3bb78742006-02-25 12:27:03 +0000632
Chris Lattnerd84bb632002-04-16 21:36:08 +0000633 Out << " }";
Andrew Lenharth0d124b82007-01-08 18:21:30 +0000634 if (CS->getType()->isPacked())
635 Out << '>';
Reid Spencerd84d35b2007-02-15 02:26:10 +0000636 } else if (const ConstantVector *CP = dyn_cast<ConstantVector>(CV)) {
Brian Gaeke02209042004-08-20 06:00:58 +0000637 const Type *ETy = CP->getType()->getElementType();
Misha Brukmanb1c93172005-04-21 23:48:37 +0000638 assert(CP->getNumOperands() > 0 &&
Brian Gaeke02209042004-08-20 06:00:58 +0000639 "Number of operands for a PackedConst must be > 0");
640 Out << '<';
641 Out << ' ';
642 printTypeInt(Out, ETy, TypeTable);
Chris Lattner78e2e8b2006-12-06 06:24:27 +0000643 WriteAsOperandInternal(Out, CP->getOperand(0), TypeTable, Machine);
Brian Gaeke02209042004-08-20 06:00:58 +0000644 for (unsigned i = 1, e = CP->getNumOperands(); i != e; ++i) {
645 Out << ", ";
646 printTypeInt(Out, ETy, TypeTable);
Chris Lattner78e2e8b2006-12-06 06:24:27 +0000647 WriteAsOperandInternal(Out, CP->getOperand(i), TypeTable, Machine);
Brian Gaeke02209042004-08-20 06:00:58 +0000648 }
649 Out << " >";
Chris Lattnerd84bb632002-04-16 21:36:08 +0000650 } else if (isa<ConstantPointerNull>(CV)) {
651 Out << "null";
652
Chris Lattner5e0b9f22004-10-16 18:08:06 +0000653 } else if (isa<UndefValue>(CV)) {
654 Out << "undef";
655
Chris Lattner3cd8c562002-07-30 18:54:25 +0000656 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
Reid Spencer812a1be2006-12-04 05:19:18 +0000657 Out << CE->getOpcodeName();
658 if (CE->isCompare())
659 Out << " " << getPredicateText(CE->getPredicate());
660 Out << " (";
Misha Brukmanb1c93172005-04-21 23:48:37 +0000661
Vikram S. Adveb952b542002-07-14 23:14:45 +0000662 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
663 printTypeInt(Out, (*OI)->getType(), TypeTable);
Chris Lattner78e2e8b2006-12-06 06:24:27 +0000664 WriteAsOperandInternal(Out, *OI, TypeTable, Machine);
Vikram S. Adveb952b542002-07-14 23:14:45 +0000665 if (OI+1 != CE->op_end())
Chris Lattner3cd8c562002-07-30 18:54:25 +0000666 Out << ", ";
Vikram S. Adveb952b542002-07-14 23:14:45 +0000667 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000668
Dan Gohmana76f0f72008-05-31 19:12:39 +0000669 if (CE->hasIndices()) {
670 const SmallVector<unsigned, 4> &Indices = CE->getIndices();
671 for (unsigned i = 0, e = Indices.size(); i != e; ++i)
672 Out << ", " << Indices[i];
673 }
674
Reid Spencer6c38f0b2006-11-27 01:05:10 +0000675 if (CE->isCast()) {
Chris Lattner83b396b2002-08-15 19:37:43 +0000676 Out << " to ";
677 printTypeInt(Out, CE->getType(), TypeTable);
678 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +0000679
Misha Brukman21bbdb92004-06-04 21:11:51 +0000680 Out << ')';
Chris Lattner83b396b2002-08-15 19:37:43 +0000681
Chris Lattnerd84bb632002-04-16 21:36:08 +0000682 } else {
Vikram S. Adveb952b542002-07-14 23:14:45 +0000683 Out << "<placeholder or erroneous Constant>";
Chris Lattnerd84bb632002-04-16 21:36:08 +0000684 }
685}
686
687
Misha Brukmanc566ca362004-03-02 00:22:19 +0000688/// WriteAsOperand - Write the name of the specified value out to the specified
689/// ostream. This can be useful when you just want to print int %reg126, not
690/// the whole instruction that generated it.
691///
Misha Brukmanb1c93172005-04-21 23:48:37 +0000692static void WriteAsOperandInternal(std::ostream &Out, const Value *V,
Chris Lattnerab7d1ab2003-05-08 02:08:14 +0000693 std::map<const Type*, std::string> &TypeTable,
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000694 SlotTracker *Machine) {
Misha Brukman21bbdb92004-06-04 21:11:51 +0000695 Out << ' ';
Chris Lattner033935d2008-08-17 04:40:13 +0000696 if (V->hasName()) {
697 PrintLLVMName(Out, V);
698 return;
699 }
700
701 const Constant *CV = dyn_cast<Constant>(V);
702 if (CV && !isa<GlobalValue>(CV)) {
703 WriteConstantInt(Out, CV, TypeTable, Machine);
704 } else if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
705 Out << "asm ";
706 if (IA->hasSideEffects())
707 Out << "sideeffect ";
708 Out << '"';
709 PrintEscapedString(IA->getAsmString(), Out);
710 Out << "\", \"";
711 PrintEscapedString(IA->getConstraintString(), Out);
712 Out << '"';
713 } else {
714 char Prefix = '%';
715 int Slot;
716 if (Machine) {
717 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
718 Slot = Machine->getGlobalSlot(GV);
719 Prefix = '@';
720 } else {
721 Slot = Machine->getLocalSlot(V);
722 }
Chris Lattnera2d810d2006-01-25 22:26:05 +0000723 } else {
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000724 Machine = createSlotTracker(V);
Reid Spencer16f2f7f2004-05-26 07:18:52 +0000725 if (Machine) {
Reid Spencer788e3172007-01-26 08:02:52 +0000726 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
Chris Lattner5e043322007-01-11 03:54:27 +0000727 Slot = Machine->getGlobalSlot(GV);
Reid Spencer788e3172007-01-26 08:02:52 +0000728 Prefix = '@';
729 } else {
Chris Lattner5e043322007-01-11 03:54:27 +0000730 Slot = Machine->getLocalSlot(V);
Reid Spencer788e3172007-01-26 08:02:52 +0000731 }
Chris Lattnerd84bb632002-04-16 21:36:08 +0000732 } else {
Chris Lattner033935d2008-08-17 04:40:13 +0000733 Slot = -1;
Chris Lattnerd84bb632002-04-16 21:36:08 +0000734 }
Chris Lattner033935d2008-08-17 04:40:13 +0000735 delete Machine;
Chris Lattnerd84bb632002-04-16 21:36:08 +0000736 }
Chris Lattner033935d2008-08-17 04:40:13 +0000737 if (Slot != -1)
738 Out << Prefix << Slot;
739 else
740 Out << "<badref>";
Chris Lattnerd84bb632002-04-16 21:36:08 +0000741 }
742}
743
Misha Brukmanb22d09c2004-03-01 19:48:13 +0000744/// WriteAsOperand - Write the name of the specified value out to the specified
745/// ostream. This can be useful when you just want to print int %reg126, not
746/// the whole instruction that generated it.
747///
Chris Lattner189d19f2003-11-21 20:23:48 +0000748std::ostream &llvm::WriteAsOperand(std::ostream &Out, const Value *V,
Chris Lattner0dda8612006-12-06 06:15:43 +0000749 bool PrintType, const Module *Context) {
Chris Lattnerab7d1ab2003-05-08 02:08:14 +0000750 std::map<const Type *, std::string> TypeNames;
Chris Lattner5a9f63e2002-07-10 16:48:17 +0000751 if (Context == 0) Context = getModuleFromVal(V);
Chris Lattnerb86620e2001-10-29 16:37:48 +0000752
Chris Lattner98cf1f52002-11-20 18:36:02 +0000753 if (Context)
Chris Lattner5a9f63e2002-07-10 16:48:17 +0000754 fillTypeNameTable(Context, TypeNames);
Chris Lattnerd84bb632002-04-16 21:36:08 +0000755
756 if (PrintType)
757 printTypeInt(Out, V->getType(), TypeNames);
Misha Brukmanb1c93172005-04-21 23:48:37 +0000758
Chris Lattner78e2e8b2006-12-06 06:24:27 +0000759 WriteAsOperandInternal(Out, V, TypeNames, 0);
Chris Lattner5e5abe32001-07-20 19:15:21 +0000760 return Out;
761}
762
Reid Spencer58d30f22004-07-04 11:50:43 +0000763
Chris Lattner189d19f2003-11-21 20:23:48 +0000764namespace llvm {
Chris Lattner2e9fee42001-07-12 23:35:26 +0000765
Chris Lattnerfee714f2001-09-07 16:36:04 +0000766class AssemblyWriter {
Misha Brukmana6619a92004-06-21 21:53:56 +0000767 std::ostream &Out;
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000768 SlotTracker &Machine;
Chris Lattner7bfee412001-10-29 16:05:51 +0000769 const Module *TheModule;
Chris Lattnerab7d1ab2003-05-08 02:08:14 +0000770 std::map<const Type *, std::string> TypeNames;
Chris Lattner8339f7d2003-10-30 23:41:03 +0000771 AssemblyAnnotationWriter *AnnotationWriter;
Chris Lattner2f7c9632001-06-06 20:29:01 +0000772public:
Chris Lattnere36fd8a2008-08-19 04:26:57 +0000773 inline AssemblyWriter(std::ostream &o, SlotTracker &Mac, const Module *M,
Chris Lattner8339f7d2003-10-30 23:41:03 +0000774 AssemblyAnnotationWriter *AAW)
Misha Brukmana6619a92004-06-21 21:53:56 +0000775 : Out(o), Machine(Mac), TheModule(M), AnnotationWriter(AAW) {
Chris Lattner7bfee412001-10-29 16:05:51 +0000776
777 // If the module has a symbol table, take all global types and stuff their
778 // names into the TypeNames map.
779 //
Chris Lattnerb86620e2001-10-29 16:37:48 +0000780 fillTypeNameTable(M, TypeNames);
Chris Lattner2f7c9632001-06-06 20:29:01 +0000781 }
782
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000783 inline void write(const Module *M) { printModule(M); }
784 inline void write(const GlobalVariable *G) { printGlobal(G); }
785 inline void write(const GlobalAlias *G) { printAlias(G); }
786 inline void write(const Function *F) { printFunction(F); }
787 inline void write(const BasicBlock *BB) { printBasicBlock(BB); }
Chris Lattner113f4f42002-06-25 16:13:24 +0000788 inline void write(const Instruction *I) { printInstruction(*I); }
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000789 inline void write(const Type *Ty) { printType(Ty); }
Chris Lattner2f7c9632001-06-06 20:29:01 +0000790
Chris Lattner78e2e8b2006-12-06 06:24:27 +0000791 void writeOperand(const Value *Op, bool PrintType);
Dale Johannesen89268bc2008-02-19 21:38:47 +0000792 void writeParamOperand(const Value *Operand, ParameterAttributes Attrs);
Chris Lattner1e194682002-04-18 18:53:13 +0000793
Misha Brukman4685e262004-04-28 15:31:21 +0000794 const Module* getModule() { return TheModule; }
795
Misha Brukmand92f54a2004-11-15 19:30:05 +0000796private:
Chris Lattner7bfee412001-10-29 16:05:51 +0000797 void printModule(const Module *M);
Reid Spencer32af9e82007-01-06 07:24:44 +0000798 void printTypeSymbolTable(const TypeSymbolTable &ST);
Chris Lattner7bfee412001-10-29 16:05:51 +0000799 void printGlobal(const GlobalVariable *GV);
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000800 void printAlias(const GlobalAlias *GV);
Chris Lattner57698e22002-03-26 18:01:55 +0000801 void printFunction(const Function *F);
Dale Johannesen89268bc2008-02-19 21:38:47 +0000802 void printArgument(const Argument *FA, ParameterAttributes Attrs);
Chris Lattner7bfee412001-10-29 16:05:51 +0000803 void printBasicBlock(const BasicBlock *BB);
Chris Lattner113f4f42002-06-25 16:13:24 +0000804 void printInstruction(const Instruction &I);
Chris Lattnerd816b532002-04-13 20:53:41 +0000805
806 // printType - Go to extreme measures to attempt to print out a short,
807 // symbolic version of a type name.
808 //
Chris Lattnerab7d1ab2003-05-08 02:08:14 +0000809 std::ostream &printType(const Type *Ty) {
Misha Brukmana6619a92004-06-21 21:53:56 +0000810 return printTypeInt(Out, Ty, TypeNames);
Chris Lattnerd816b532002-04-13 20:53:41 +0000811 }
812
813 // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
814 // without considering any symbolic types that we may have equal to it.
815 //
Chris Lattnerab7d1ab2003-05-08 02:08:14 +0000816 std::ostream &printTypeAtLeastOneLevel(const Type *Ty);
Chris Lattner7bfee412001-10-29 16:05:51 +0000817
Chris Lattner862e3382001-10-13 06:42:36 +0000818 // printInfoComment - Print a little comment after the instruction indicating
819 // which slot it occupies.
Chris Lattner113f4f42002-06-25 16:13:24 +0000820 void printInfoComment(const Value &V);
Chris Lattner2f7c9632001-06-06 20:29:01 +0000821};
Reid Spencerf43ac622004-05-27 22:04:46 +0000822} // end of llvm namespace
Chris Lattner2f7c9632001-06-06 20:29:01 +0000823
Misha Brukmanc566ca362004-03-02 00:22:19 +0000824/// printTypeAtLeastOneLevel - Print out one level of the possibly complex type
825/// without considering any symbolic types that we may have equal to it.
826///
Chris Lattnerab7d1ab2003-05-08 02:08:14 +0000827std::ostream &AssemblyWriter::printTypeAtLeastOneLevel(const Type *Ty) {
Reid Spencer7a9c62b2007-01-12 07:05:14 +0000828 if (const IntegerType *ITy = dyn_cast<IntegerType>(Ty))
829 Out << "i" << utostr(ITy->getBitWidth());
830 else if (const FunctionType *FTy = dyn_cast<FunctionType>(Ty)) {
Reid Spencer8c4914c2006-12-31 05:24:50 +0000831 printType(FTy->getReturnType());
Reid Spencer8c4914c2006-12-31 05:24:50 +0000832 Out << " (";
Chris Lattnerfa829be2004-02-09 04:14:01 +0000833 for (FunctionType::param_iterator I = FTy->param_begin(),
834 E = FTy->param_end(); I != E; ++I) {
835 if (I != FTy->param_begin())
Misha Brukmana6619a92004-06-21 21:53:56 +0000836 Out << ", ";
Chris Lattnerd84bb632002-04-16 21:36:08 +0000837 printType(*I);
Chris Lattnerd816b532002-04-13 20:53:41 +0000838 }
839 if (FTy->isVarArg()) {
Misha Brukmana6619a92004-06-21 21:53:56 +0000840 if (FTy->getNumParams()) Out << ", ";
841 Out << "...";
Chris Lattnerd816b532002-04-13 20:53:41 +0000842 }
Misha Brukmana6619a92004-06-21 21:53:56 +0000843 Out << ')';
Chris Lattner113f4f42002-06-25 16:13:24 +0000844 } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
Andrew Lenharthdcb3c972006-12-08 18:06:16 +0000845 if (STy->isPacked())
846 Out << '<';
Misha Brukmana6619a92004-06-21 21:53:56 +0000847 Out << "{ ";
Chris Lattnerac6db752004-02-09 04:37:31 +0000848 for (StructType::element_iterator I = STy->element_begin(),
849 E = STy->element_end(); I != E; ++I) {
850 if (I != STy->element_begin())
Misha Brukmana6619a92004-06-21 21:53:56 +0000851 Out << ", ";
Chris Lattnerd816b532002-04-13 20:53:41 +0000852 printType(*I);
853 }
Misha Brukmana6619a92004-06-21 21:53:56 +0000854 Out << " }";
Andrew Lenharthdcb3c972006-12-08 18:06:16 +0000855 if (STy->isPacked())
856 Out << '>';
Chris Lattner113f4f42002-06-25 16:13:24 +0000857 } else if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
Christopher Lambac7d6312007-12-18 03:49:35 +0000858 printType(PTy->getElementType());
859 if (unsigned AddressSpace = PTy->getAddressSpace())
860 Out << " addrspace(" << AddressSpace << ")";
861 Out << '*';
Chris Lattner113f4f42002-06-25 16:13:24 +0000862 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
Misha Brukmana6619a92004-06-21 21:53:56 +0000863 Out << '[' << ATy->getNumElements() << " x ";
Misha Brukman21bbdb92004-06-04 21:11:51 +0000864 printType(ATy->getElementType()) << ']';
Reid Spencerd84d35b2007-02-15 02:26:10 +0000865 } else if (const VectorType *PTy = dyn_cast<VectorType>(Ty)) {
Reid Spencere203d352004-08-20 15:37:30 +0000866 Out << '<' << PTy->getNumElements() << " x ";
867 printType(PTy->getElementType()) << '>';
868 }
Reid Spencerde46e482006-11-02 20:25:50 +0000869 else if (isa<OpaqueType>(Ty)) {
Misha Brukmana6619a92004-06-21 21:53:56 +0000870 Out << "opaque";
Chris Lattnerd816b532002-04-13 20:53:41 +0000871 } else {
Vikram S. Adveb952b542002-07-14 23:14:45 +0000872 if (!Ty->isPrimitiveType())
Misha Brukmana6619a92004-06-21 21:53:56 +0000873 Out << "<unknown derived type>";
Chris Lattnerd816b532002-04-13 20:53:41 +0000874 printType(Ty);
875 }
Misha Brukmana6619a92004-06-21 21:53:56 +0000876 return Out;
Chris Lattnerd816b532002-04-13 20:53:41 +0000877}
878
879
Chris Lattner78e2e8b2006-12-06 06:24:27 +0000880void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType) {
881 if (Operand == 0) {
Chris Lattner08f7d0c2005-02-24 16:58:29 +0000882 Out << "<null operand!>";
Chris Lattner78e2e8b2006-12-06 06:24:27 +0000883 } else {
884 if (PrintType) { Out << ' '; printType(Operand->getType()); }
885 WriteAsOperandInternal(Out, Operand, TypeNames, &Machine);
Chris Lattner08f7d0c2005-02-24 16:58:29 +0000886 }
Chris Lattner2f7c9632001-06-06 20:29:01 +0000887}
888
Dale Johannesen89268bc2008-02-19 21:38:47 +0000889void AssemblyWriter::writeParamOperand(const Value *Operand,
890 ParameterAttributes Attrs) {
Duncan Sandsad0ea2d2007-11-27 13:23:08 +0000891 if (Operand == 0) {
892 Out << "<null operand!>";
893 } else {
894 Out << ' ';
895 // Print the type
896 printType(Operand->getType());
897 // Print parameter attributes list
898 if (Attrs != ParamAttr::None)
Chris Lattner8a923e72008-03-12 17:45:29 +0000899 Out << ' ' << ParamAttr::getAsString(Attrs);
Duncan Sandsad0ea2d2007-11-27 13:23:08 +0000900 // Print the operand
901 WriteAsOperandInternal(Out, Operand, TypeNames, &Machine);
902 }
903}
Chris Lattner2f7c9632001-06-06 20:29:01 +0000904
Chris Lattner7bfee412001-10-29 16:05:51 +0000905void AssemblyWriter::printModule(const Module *M) {
Chris Lattner4d8689e2005-03-02 23:12:40 +0000906 if (!M->getModuleIdentifier().empty() &&
Misha Brukmanb1c93172005-04-21 23:48:37 +0000907 // Don't print the ID if it will start a new line (which would
Chris Lattner4d8689e2005-03-02 23:12:40 +0000908 // require a comment char before it).
909 M->getModuleIdentifier().find('\n') == std::string::npos)
910 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
911
Owen Andersone2237542006-10-18 02:21:12 +0000912 if (!M->getDataLayout().empty())
Chris Lattner04897162006-10-22 06:06:56 +0000913 Out << "target datalayout = \"" << M->getDataLayout() << "\"\n";
Reid Spencer48f98c82004-07-25 21:44:54 +0000914 if (!M->getTargetTriple().empty())
Reid Spencerffec7df2004-07-25 21:29:43 +0000915 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
Misha Brukmanb1c93172005-04-21 23:48:37 +0000916
Chris Lattnereef2fe72006-01-24 04:13:11 +0000917 if (!M->getModuleInlineAsm().empty()) {
Chris Lattnerefaf35d2006-01-24 00:45:30 +0000918 // Split the string into lines, to make it easier to read the .ll file.
Chris Lattnereef2fe72006-01-24 04:13:11 +0000919 std::string Asm = M->getModuleInlineAsm();
Chris Lattnerefaf35d2006-01-24 00:45:30 +0000920 size_t CurPos = 0;
921 size_t NewLine = Asm.find_first_of('\n', CurPos);
922 while (NewLine != std::string::npos) {
923 // We found a newline, print the portion of the asm string from the
924 // last newline up to this newline.
925 Out << "module asm \"";
926 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
927 Out);
928 Out << "\"\n";
929 CurPos = NewLine+1;
930 NewLine = Asm.find_first_of('\n', CurPos);
931 }
Chris Lattner3acaf5c2006-01-24 00:40:17 +0000932 Out << "module asm \"";
Chris Lattnerefaf35d2006-01-24 00:45:30 +0000933 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.end()), Out);
Chris Lattner6ed87bd2006-01-23 23:03:36 +0000934 Out << "\"\n";
935 }
936
Chris Lattner2cdd49d2004-09-14 05:06:58 +0000937 // Loop over the dependent libraries and emit them.
Chris Lattner730cfe42004-09-14 04:51:44 +0000938 Module::lib_iterator LI = M->lib_begin();
939 Module::lib_iterator LE = M->lib_end();
Reid Spencer48f98c82004-07-25 21:44:54 +0000940 if (LI != LE) {
Chris Lattner730cfe42004-09-14 04:51:44 +0000941 Out << "deplibs = [ ";
942 while (LI != LE) {
Chris Lattner2cdd49d2004-09-14 05:06:58 +0000943 Out << '"' << *LI << '"';
Reid Spencerffec7df2004-07-25 21:29:43 +0000944 ++LI;
Chris Lattner730cfe42004-09-14 04:51:44 +0000945 if (LI != LE)
946 Out << ", ";
Reid Spencerffec7df2004-07-25 21:29:43 +0000947 }
948 Out << " ]\n";
Reid Spencercc5ff642004-07-25 18:08:18 +0000949 }
Reid Spencerb9e08772004-09-13 23:44:23 +0000950
Chris Lattner2cdd49d2004-09-14 05:06:58 +0000951 // Loop over the symbol table, emitting all named constants.
Reid Spencer32af9e82007-01-06 07:24:44 +0000952 printTypeSymbolTable(M->getTypeSymbolTable());
Misha Brukmanb1c93172005-04-21 23:48:37 +0000953
Chris Lattner54932b02006-12-06 04:41:52 +0000954 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end();
955 I != E; ++I)
Chris Lattner113f4f42002-06-25 16:13:24 +0000956 printGlobal(I);
Chris Lattnerd2747052007-04-26 02:24:10 +0000957
958 // Output all aliases.
959 if (!M->alias_empty()) Out << "\n";
960 for (Module::const_alias_iterator I = M->alias_begin(), E = M->alias_end();
961 I != E; ++I)
962 printAlias(I);
Chris Lattnerfee714f2001-09-07 16:36:04 +0000963
Chris Lattner2cdd49d2004-09-14 05:06:58 +0000964 // Output all of the functions.
Chris Lattner113f4f42002-06-25 16:13:24 +0000965 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
966 printFunction(I);
Chris Lattnerfee714f2001-09-07 16:36:04 +0000967}
968
Chris Lattner7bfee412001-10-29 16:05:51 +0000969void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
Chris Lattner033935d2008-08-17 04:40:13 +0000970 if (GV->hasName()) {
971 PrintLLVMName(Out, GV);
972 Out << " = ";
973 }
Chris Lattner37798642001-09-18 04:01:05 +0000974
Bill Wendlingd21d90c2008-01-15 21:16:32 +0000975 if (!GV->hasInitializer()) {
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +0000976 switch (GV->getLinkage()) {
977 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
978 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
979 default: Out << "external "; break;
Bill Wendlingd21d90c2008-01-15 21:16:32 +0000980 }
981 } else {
Chris Lattner379a8d22003-04-16 20:28:45 +0000982 switch (GV->getLinkage()) {
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +0000983 case GlobalValue::InternalLinkage: Out << "internal "; break;
Dale Johannesence4396b2008-05-14 20:12:51 +0000984 case GlobalValue::CommonLinkage: Out << "common "; break;
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +0000985 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
986 case GlobalValue::WeakLinkage: Out << "weak "; break;
987 case GlobalValue::AppendingLinkage: Out << "appending "; break;
988 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
989 case GlobalValue::DLLExportLinkage: Out << "dllexport "; break;
990 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
991 case GlobalValue::ExternalLinkage: break;
Misha Brukman70457632004-11-14 21:04:34 +0000992 case GlobalValue::GhostLinkage:
Bill Wendlingf3baad32006-12-07 01:30:32 +0000993 cerr << "GhostLinkage not allowed in AsmWriter!\n";
Misha Brukman70457632004-11-14 21:04:34 +0000994 abort();
Chris Lattner379a8d22003-04-16 20:28:45 +0000995 }
Anton Korobeynikova0554d92007-01-12 19:20:47 +0000996 switch (GV->getVisibility()) {
Chris Lattner90d2e422007-01-15 18:28:18 +0000997 default: assert(0 && "Invalid visibility style!");
Anton Korobeynikova0554d92007-01-12 19:20:47 +0000998 case GlobalValue::DefaultVisibility: break;
999 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
Anton Korobeynikov39f3cff2007-04-29 18:35:00 +00001000 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
Anton Korobeynikova0554d92007-01-12 19:20:47 +00001001 }
1002 }
Lauro Ramos Venancio749e4662007-04-12 18:32:50 +00001003
1004 if (GV->isThreadLocal()) Out << "thread_local ";
Misha Brukmana6619a92004-06-21 21:53:56 +00001005 Out << (GV->isConstant() ? "constant " : "global ");
Chris Lattner2413b162001-12-04 00:03:30 +00001006 printType(GV->getType()->getElementType());
Chris Lattner37798642001-09-18 04:01:05 +00001007
Chris Lattner033935d2008-08-17 04:40:13 +00001008 if (GV->hasInitializer())
Chris Lattner78e2e8b2006-12-06 06:24:27 +00001009 writeOperand(GV->getInitializer(), false);
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001010
Christopher Lamb54dd24c2007-12-11 08:59:05 +00001011 if (unsigned AddressSpace = GV->getType()->getAddressSpace())
1012 Out << " addrspace(" << AddressSpace << ") ";
1013
Chris Lattner4b96c542005-11-12 00:10:19 +00001014 if (GV->hasSection())
1015 Out << ", section \"" << GV->getSection() << '"';
1016 if (GV->getAlignment())
Chris Lattnerf8a974d2005-11-06 06:48:53 +00001017 Out << ", align " << GV->getAlignment();
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001018
Chris Lattner113f4f42002-06-25 16:13:24 +00001019 printInfoComment(*GV);
Misha Brukmana6619a92004-06-21 21:53:56 +00001020 Out << "\n";
Chris Lattnerda975502001-09-10 07:58:01 +00001021}
1022
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001023void AssemblyWriter::printAlias(const GlobalAlias *GA) {
Dale Johannesen83e468a2008-06-03 18:14:29 +00001024 // Don't crash when dumping partially built GA
1025 if (!GA->hasName())
1026 Out << "<<nameless>> = ";
Chris Lattner033935d2008-08-17 04:40:13 +00001027 else {
1028 PrintLLVMName(Out, GA);
1029 Out << " = ";
1030 }
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001031 switch (GA->getVisibility()) {
1032 default: assert(0 && "Invalid visibility style!");
1033 case GlobalValue::DefaultVisibility: break;
1034 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
Anton Korobeynikov39f3cff2007-04-29 18:35:00 +00001035 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001036 }
1037
1038 Out << "alias ";
1039
1040 switch (GA->getLinkage()) {
1041 case GlobalValue::WeakLinkage: Out << "weak "; break;
1042 case GlobalValue::InternalLinkage: Out << "internal "; break;
1043 case GlobalValue::ExternalLinkage: break;
1044 default:
1045 assert(0 && "Invalid alias linkage");
1046 }
1047
Anton Korobeynikov546ea7e2007-04-29 18:02:48 +00001048 const Constant *Aliasee = GA->getAliasee();
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001049
1050 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(Aliasee)) {
1051 printType(GV->getType());
Chris Lattner033935d2008-08-17 04:40:13 +00001052 Out << ' ';
1053 PrintLLVMName(Out, GV);
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001054 } else if (const Function *F = dyn_cast<Function>(Aliasee)) {
1055 printType(F->getFunctionType());
1056 Out << "* ";
1057
Chris Lattner17f71652008-08-17 07:19:36 +00001058 if (F->hasName())
Chris Lattner033935d2008-08-17 04:40:13 +00001059 PrintLLVMName(Out, F);
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001060 else
1061 Out << "@\"\"";
Anton Korobeynikov72d5d422008-03-22 08:17:17 +00001062 } else if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(Aliasee)) {
1063 printType(GA->getType());
Chris Lattner033935d2008-08-17 04:40:13 +00001064 Out << " ";
1065 PrintLLVMName(Out, GA);
Anton Korobeynikovb18f8f82007-04-28 13:45:00 +00001066 } else {
1067 const ConstantExpr *CE = 0;
1068 if ((CE = dyn_cast<ConstantExpr>(Aliasee)) &&
1069 (CE->getOpcode() == Instruction::BitCast)) {
1070 writeOperand(CE, false);
1071 } else
1072 assert(0 && "Unsupported aliasee");
1073 }
1074
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001075 printInfoComment(*GA);
1076 Out << "\n";
1077}
1078
Reid Spencer32af9e82007-01-06 07:24:44 +00001079void AssemblyWriter::printTypeSymbolTable(const TypeSymbolTable &ST) {
Reid Spencere7e96712004-05-25 08:53:40 +00001080 // Print the types.
Reid Spencer32af9e82007-01-06 07:24:44 +00001081 for (TypeSymbolTable::const_iterator TI = ST.begin(), TE = ST.end();
1082 TI != TE; ++TI) {
Chris Lattner663d2922008-08-17 17:28:37 +00001083 Out << "\t" << getLLVMName(TI->first) << " = type ";
Reid Spencere7e96712004-05-25 08:53:40 +00001084
1085 // Make sure we print out at least one level of the type structure, so
1086 // that we do not get %FILE = type %FILE
1087 //
1088 printTypeAtLeastOneLevel(TI->second) << "\n";
1089 }
Reid Spencer32af9e82007-01-06 07:24:44 +00001090}
1091
Misha Brukmanc566ca362004-03-02 00:22:19 +00001092/// printFunction - Print all aspects of a function.
1093///
Chris Lattner113f4f42002-06-25 16:13:24 +00001094void AssemblyWriter::printFunction(const Function *F) {
Chris Lattner2f7c9632001-06-06 20:29:01 +00001095 // Print out the return type and name...
Misha Brukmana6619a92004-06-21 21:53:56 +00001096 Out << "\n";
Chris Lattner379a8d22003-04-16 20:28:45 +00001097
Misha Brukmana6619a92004-06-21 21:53:56 +00001098 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
Chris Lattner8339f7d2003-10-30 23:41:03 +00001099
Reid Spencer5301e7c2007-01-30 20:08:39 +00001100 if (F->isDeclaration())
Chris Lattner10f03a62007-08-19 22:15:26 +00001101 Out << "declare ";
1102 else
Reid Spencer7ce2d2a2006-12-29 20:29:48 +00001103 Out << "define ";
Chris Lattner10f03a62007-08-19 22:15:26 +00001104
1105 switch (F->getLinkage()) {
1106 case GlobalValue::InternalLinkage: Out << "internal "; break;
1107 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
1108 case GlobalValue::WeakLinkage: Out << "weak "; break;
Dale Johannesence4396b2008-05-14 20:12:51 +00001109 case GlobalValue::CommonLinkage: Out << "common "; break;
Chris Lattner10f03a62007-08-19 22:15:26 +00001110 case GlobalValue::AppendingLinkage: Out << "appending "; break;
1111 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
1112 case GlobalValue::DLLExportLinkage: Out << "dllexport "; break;
1113 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
1114 case GlobalValue::ExternalLinkage: break;
1115 case GlobalValue::GhostLinkage:
1116 cerr << "GhostLinkage not allowed in AsmWriter!\n";
1117 abort();
1118 }
1119 switch (F->getVisibility()) {
1120 default: assert(0 && "Invalid visibility style!");
1121 case GlobalValue::DefaultVisibility: break;
1122 case GlobalValue::HiddenVisibility: Out << "hidden "; break;
1123 case GlobalValue::ProtectedVisibility: Out << "protected "; break;
Reid Spencer7ce2d2a2006-12-29 20:29:48 +00001124 }
Chris Lattner379a8d22003-04-16 20:28:45 +00001125
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001126 // Print the calling convention.
1127 switch (F->getCallingConv()) {
1128 case CallingConv::C: break; // default
Anton Korobeynikov3c5b3df2006-09-20 22:03:51 +00001129 case CallingConv::Fast: Out << "fastcc "; break;
1130 case CallingConv::Cold: Out << "coldcc "; break;
1131 case CallingConv::X86_StdCall: Out << "x86_stdcallcc "; break;
1132 case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
Dale Johannesen332dd532008-08-13 18:40:23 +00001133 case CallingConv::X86_SSECall: Out << "x86_ssecallcc "; break;
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001134 default: Out << "cc" << F->getCallingConv() << " "; break;
1135 }
1136
Reid Spencer8c4914c2006-12-31 05:24:50 +00001137 const FunctionType *FT = F->getFunctionType();
Chris Lattner8a923e72008-03-12 17:45:29 +00001138 const PAListPtr &Attrs = F->getParamAttrs();
Misha Brukman21bbdb92004-06-04 21:11:51 +00001139 printType(F->getReturnType()) << ' ';
Chris Lattneredceac32008-08-17 07:24:08 +00001140 if (F->hasName())
Chris Lattner033935d2008-08-17 04:40:13 +00001141 PrintLLVMName(Out, F);
Chris Lattner5b337482003-10-18 05:57:43 +00001142 else
Reid Spencer788e3172007-01-26 08:02:52 +00001143 Out << "@\"\"";
Misha Brukmana6619a92004-06-21 21:53:56 +00001144 Out << '(';
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001145 Machine.incorporateFunction(F);
Chris Lattnerfee714f2001-09-07 16:36:04 +00001146
Chris Lattner7bfee412001-10-29 16:05:51 +00001147 // Loop over the arguments, printing them...
Chris Lattnerfee714f2001-09-07 16:36:04 +00001148
Reid Spencer8c4914c2006-12-31 05:24:50 +00001149 unsigned Idx = 1;
Chris Lattner82738fe2007-04-18 00:57:22 +00001150 if (!F->isDeclaration()) {
1151 // If this isn't a declaration, print the argument names as well.
1152 for (Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
1153 I != E; ++I) {
1154 // Insert commas as we go... the first arg doesn't get a comma
1155 if (I != F->arg_begin()) Out << ", ";
Chris Lattner8a923e72008-03-12 17:45:29 +00001156 printArgument(I, Attrs.getParamAttrs(Idx));
Chris Lattner82738fe2007-04-18 00:57:22 +00001157 Idx++;
1158 }
1159 } else {
1160 // Otherwise, print the types from the function type.
1161 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1162 // Insert commas as we go... the first arg doesn't get a comma
1163 if (i) Out << ", ";
1164
1165 // Output type...
1166 printType(FT->getParamType(i));
1167
Chris Lattner8a923e72008-03-12 17:45:29 +00001168 ParameterAttributes ArgAttrs = Attrs.getParamAttrs(i+1);
Chris Lattner82738fe2007-04-18 00:57:22 +00001169 if (ArgAttrs != ParamAttr::None)
Chris Lattner8a923e72008-03-12 17:45:29 +00001170 Out << ' ' << ParamAttr::getAsString(ArgAttrs);
Chris Lattner82738fe2007-04-18 00:57:22 +00001171 }
Reid Spencer8c4914c2006-12-31 05:24:50 +00001172 }
Chris Lattnerfee714f2001-09-07 16:36:04 +00001173
1174 // Finish printing arguments...
Chris Lattner113f4f42002-06-25 16:13:24 +00001175 if (FT->isVarArg()) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001176 if (FT->getNumParams()) Out << ", ";
1177 Out << "..."; // Output varargs portion of signature!
Chris Lattnerfee714f2001-09-07 16:36:04 +00001178 }
Misha Brukmana6619a92004-06-21 21:53:56 +00001179 Out << ')';
Chris Lattner8a923e72008-03-12 17:45:29 +00001180 ParameterAttributes RetAttrs = Attrs.getParamAttrs(0);
1181 if (RetAttrs != ParamAttr::None)
1182 Out << ' ' << ParamAttr::getAsString(Attrs.getParamAttrs(0));
Chris Lattner4b96c542005-11-12 00:10:19 +00001183 if (F->hasSection())
1184 Out << " section \"" << F->getSection() << '"';
Chris Lattnerf8a974d2005-11-06 06:48:53 +00001185 if (F->getAlignment())
1186 Out << " align " << F->getAlignment();
Gordon Henriksend930f912008-08-17 18:44:35 +00001187 if (F->hasGC())
1188 Out << " gc \"" << F->getGC() << '"';
Chris Lattner4b96c542005-11-12 00:10:19 +00001189
Reid Spencer5301e7c2007-01-30 20:08:39 +00001190 if (F->isDeclaration()) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001191 Out << "\n";
Chris Lattnerb2f02e52002-05-06 03:00:40 +00001192 } else {
Chris Lattnerd5fbc8f2008-04-21 06:12:55 +00001193 Out << " {";
Misha Brukmanb1c93172005-04-21 23:48:37 +00001194
Chris Lattner6915f8f2002-04-07 22:49:37 +00001195 // Output all of its basic blocks... for the function
Chris Lattner113f4f42002-06-25 16:13:24 +00001196 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1197 printBasicBlock(I);
Chris Lattnerfee714f2001-09-07 16:36:04 +00001198
Misha Brukmana6619a92004-06-21 21:53:56 +00001199 Out << "}\n";
Chris Lattnerfee714f2001-09-07 16:36:04 +00001200 }
1201
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001202 Machine.purgeFunction();
Chris Lattner2f7c9632001-06-06 20:29:01 +00001203}
1204
Misha Brukmanc566ca362004-03-02 00:22:19 +00001205/// printArgument - This member is called for every argument that is passed into
1206/// the function. Simply print it out
1207///
Dale Johannesen89268bc2008-02-19 21:38:47 +00001208void AssemblyWriter::printArgument(const Argument *Arg,
1209 ParameterAttributes Attrs) {
Chris Lattner2f7c9632001-06-06 20:29:01 +00001210 // Output type...
Chris Lattner7bfee412001-10-29 16:05:51 +00001211 printType(Arg->getType());
Misha Brukmanb1c93172005-04-21 23:48:37 +00001212
Duncan Sandsad0ea2d2007-11-27 13:23:08 +00001213 // Output parameter attributes list
Reid Spencera472f662007-04-11 02:44:20 +00001214 if (Attrs != ParamAttr::None)
Chris Lattner8a923e72008-03-12 17:45:29 +00001215 Out << ' ' << ParamAttr::getAsString(Attrs);
Reid Spencer8c4914c2006-12-31 05:24:50 +00001216
Chris Lattner2f7c9632001-06-06 20:29:01 +00001217 // Output name, if available...
Chris Lattner033935d2008-08-17 04:40:13 +00001218 if (Arg->hasName()) {
1219 Out << ' ';
1220 PrintLLVMName(Out, Arg);
1221 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001222}
1223
Misha Brukmanc566ca362004-03-02 00:22:19 +00001224/// printBasicBlock - This member is called for each basic block in a method.
1225///
Chris Lattner7bfee412001-10-29 16:05:51 +00001226void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
Nick Lewycky4d43d3c2008-04-25 16:53:59 +00001227 if (BB->hasName()) { // Print out the label if it exists...
Chris Lattner033935d2008-08-17 04:40:13 +00001228 Out << "\n";
1229 PrintLLVMName(Out, BB->getValueName(), LabelPrefix);
1230 Out << ':';
Nick Lewycky4d43d3c2008-04-25 16:53:59 +00001231 } else if (!BB->use_empty()) { // Don't print block # of no uses...
Chris Lattner67bec132008-04-21 04:20:33 +00001232 Out << "\n; <label>:";
Chris Lattner5e043322007-01-11 03:54:27 +00001233 int Slot = Machine.getLocalSlot(BB);
Chris Lattner757ee0b2004-06-09 19:41:19 +00001234 if (Slot != -1)
Misha Brukmana6619a92004-06-21 21:53:56 +00001235 Out << Slot;
Chris Lattner757ee0b2004-06-09 19:41:19 +00001236 else
Misha Brukmana6619a92004-06-21 21:53:56 +00001237 Out << "<badref>";
Chris Lattner58185f22002-10-02 19:38:55 +00001238 }
Chris Lattner2447ef52003-11-20 00:09:43 +00001239
1240 if (BB->getParent() == 0)
Misha Brukmana6619a92004-06-21 21:53:56 +00001241 Out << "\t\t; Error: Block without parent!";
Chris Lattnerff834c02008-04-22 02:45:44 +00001242 else if (BB != &BB->getParent()->getEntryBlock()) { // Not the entry block?
1243 // Output predecessors for the block...
1244 Out << "\t\t;";
1245 pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
1246
1247 if (PI == PE) {
1248 Out << " No predecessors!";
1249 } else {
1250 Out << " preds =";
1251 writeOperand(*PI, false);
1252 for (++PI; PI != PE; ++PI) {
1253 Out << ',';
Chris Lattner78e2e8b2006-12-06 06:24:27 +00001254 writeOperand(*PI, false);
Chris Lattner00211f12003-11-16 22:59:57 +00001255 }
Chris Lattner58185f22002-10-02 19:38:55 +00001256 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001257 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00001258
Chris Lattnerff834c02008-04-22 02:45:44 +00001259 Out << "\n";
Chris Lattner2f7c9632001-06-06 20:29:01 +00001260
Misha Brukmana6619a92004-06-21 21:53:56 +00001261 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
Chris Lattner8339f7d2003-10-30 23:41:03 +00001262
Chris Lattnerfee714f2001-09-07 16:36:04 +00001263 // Output all of the instructions in the basic block...
Chris Lattner113f4f42002-06-25 16:13:24 +00001264 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1265 printInstruction(*I);
Chris Lattner96cdd272004-03-08 18:51:45 +00001266
Misha Brukmana6619a92004-06-21 21:53:56 +00001267 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001268}
1269
Chris Lattner862e3382001-10-13 06:42:36 +00001270
Misha Brukmanc566ca362004-03-02 00:22:19 +00001271/// printInfoComment - Print a little comment after the instruction indicating
1272/// which slot it occupies.
1273///
Chris Lattner113f4f42002-06-25 16:13:24 +00001274void AssemblyWriter::printInfoComment(const Value &V) {
1275 if (V.getType() != Type::VoidTy) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001276 Out << "\t\t; <";
Misha Brukman21bbdb92004-06-04 21:11:51 +00001277 printType(V.getType()) << '>';
Chris Lattner862e3382001-10-13 06:42:36 +00001278
Chris Lattner113f4f42002-06-25 16:13:24 +00001279 if (!V.hasName()) {
Chris Lattner5e043322007-01-11 03:54:27 +00001280 int SlotNum;
1281 if (const GlobalValue *GV = dyn_cast<GlobalValue>(&V))
1282 SlotNum = Machine.getGlobalSlot(GV);
1283 else
1284 SlotNum = Machine.getLocalSlot(&V);
Chris Lattner757ee0b2004-06-09 19:41:19 +00001285 if (SlotNum == -1)
Misha Brukmana6619a92004-06-21 21:53:56 +00001286 Out << ":<badref>";
Reid Spencer8beac692004-06-09 15:26:53 +00001287 else
Misha Brukmana6619a92004-06-21 21:53:56 +00001288 Out << ':' << SlotNum; // Print out the def slot taken.
Chris Lattner862e3382001-10-13 06:42:36 +00001289 }
Chris Lattnerb6c21db2005-02-01 01:24:01 +00001290 Out << " [#uses=" << V.getNumUses() << ']'; // Output # uses
Chris Lattner862e3382001-10-13 06:42:36 +00001291 }
1292}
1293
Reid Spencere7141c82006-08-28 01:02:49 +00001294// This member is called for each Instruction in a function..
Chris Lattner113f4f42002-06-25 16:13:24 +00001295void AssemblyWriter::printInstruction(const Instruction &I) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001296 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
Chris Lattner8339f7d2003-10-30 23:41:03 +00001297
Misha Brukmana6619a92004-06-21 21:53:56 +00001298 Out << "\t";
Chris Lattner2f7c9632001-06-06 20:29:01 +00001299
1300 // Print out name if it exists...
Chris Lattner033935d2008-08-17 04:40:13 +00001301 if (I.hasName()) {
1302 PrintLLVMName(Out, &I);
1303 Out << " = ";
1304 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001305
Chris Lattner06038452005-05-06 05:51:46 +00001306 // If this is a volatile load or store, print out the volatile marker.
Chris Lattner504f9242003-09-08 17:45:59 +00001307 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
Chris Lattner06038452005-05-06 05:51:46 +00001308 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile())) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001309 Out << "volatile ";
Chris Lattner06038452005-05-06 05:51:46 +00001310 } else if (isa<CallInst>(I) && cast<CallInst>(I).isTailCall()) {
1311 // If this is a call, check if it's a tail call.
1312 Out << "tail ";
1313 }
Chris Lattner504f9242003-09-08 17:45:59 +00001314
Chris Lattner2f7c9632001-06-06 20:29:01 +00001315 // Print out the opcode...
Misha Brukmana6619a92004-06-21 21:53:56 +00001316 Out << I.getOpcodeName();
Chris Lattner2f7c9632001-06-06 20:29:01 +00001317
Reid Spencer45e52392006-12-03 06:27:29 +00001318 // Print out the compare instruction predicates
Nate Begemand2195702008-05-12 19:01:56 +00001319 if (const CmpInst *CI = dyn_cast<CmpInst>(&I))
1320 Out << " " << getPredicateText(CI->getPredicate());
Reid Spencer45e52392006-12-03 06:27:29 +00001321
Chris Lattner2f7c9632001-06-06 20:29:01 +00001322 // Print out the type of the operands...
Chris Lattner113f4f42002-06-25 16:13:24 +00001323 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
Chris Lattner2f7c9632001-06-06 20:29:01 +00001324
1325 // Special case conditional branches to swizzle the condition out to the front
Chris Lattner113f4f42002-06-25 16:13:24 +00001326 if (isa<BranchInst>(I) && I.getNumOperands() > 1) {
1327 writeOperand(I.getOperand(2), true);
Misha Brukmana6619a92004-06-21 21:53:56 +00001328 Out << ',';
Chris Lattner2f7c9632001-06-06 20:29:01 +00001329 writeOperand(Operand, true);
Misha Brukmana6619a92004-06-21 21:53:56 +00001330 Out << ',';
Chris Lattner113f4f42002-06-25 16:13:24 +00001331 writeOperand(I.getOperand(1), true);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001332
Chris Lattner8d48df22002-04-13 18:34:38 +00001333 } else if (isa<SwitchInst>(I)) {
Chris Lattner2f7c9632001-06-06 20:29:01 +00001334 // Special case switch statement to get formatting nice and correct...
Misha Brukmana6619a92004-06-21 21:53:56 +00001335 writeOperand(Operand , true); Out << ',';
1336 writeOperand(I.getOperand(1), true); Out << " [";
Chris Lattner2f7c9632001-06-06 20:29:01 +00001337
Chris Lattner113f4f42002-06-25 16:13:24 +00001338 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001339 Out << "\n\t\t";
1340 writeOperand(I.getOperand(op ), true); Out << ',';
Chris Lattner113f4f42002-06-25 16:13:24 +00001341 writeOperand(I.getOperand(op+1), true);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001342 }
Misha Brukmana6619a92004-06-21 21:53:56 +00001343 Out << "\n\t]";
Chris Lattnerda558102001-10-02 03:41:24 +00001344 } else if (isa<PHINode>(I)) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001345 Out << ' ';
Chris Lattner113f4f42002-06-25 16:13:24 +00001346 printType(I.getType());
Misha Brukmana6619a92004-06-21 21:53:56 +00001347 Out << ' ';
Chris Lattner2f7c9632001-06-06 20:29:01 +00001348
Chris Lattner113f4f42002-06-25 16:13:24 +00001349 for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001350 if (op) Out << ", ";
Misha Brukmanb1c93172005-04-21 23:48:37 +00001351 Out << '[';
Misha Brukmana6619a92004-06-21 21:53:56 +00001352 writeOperand(I.getOperand(op ), false); Out << ',';
1353 writeOperand(I.getOperand(op+1), false); Out << " ]";
Chris Lattner931ef3b2001-06-11 15:04:20 +00001354 }
Dan Gohmana76f0f72008-05-31 19:12:39 +00001355 } else if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(&I)) {
1356 writeOperand(I.getOperand(0), true);
1357 for (const unsigned *i = EVI->idx_begin(), *e = EVI->idx_end(); i != e; ++i)
1358 Out << ", " << *i;
1359 } else if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(&I)) {
1360 writeOperand(I.getOperand(0), true); Out << ',';
1361 writeOperand(I.getOperand(1), true);
1362 for (const unsigned *i = IVI->idx_begin(), *e = IVI->idx_end(); i != e; ++i)
1363 Out << ", " << *i;
Devang Patel59643e52008-02-23 00:35:18 +00001364 } else if (isa<ReturnInst>(I) && !Operand) {
1365 Out << " void";
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001366 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
1367 // Print the calling convention being used.
1368 switch (CI->getCallingConv()) {
1369 case CallingConv::C: break; // default
Chris Lattner29d20852006-05-19 21:58:52 +00001370 case CallingConv::Fast: Out << " fastcc"; break;
1371 case CallingConv::Cold: Out << " coldcc"; break;
Chris Lattnerf5270372007-11-18 18:32:16 +00001372 case CallingConv::X86_StdCall: Out << " x86_stdcallcc"; break;
1373 case CallingConv::X86_FastCall: Out << " x86_fastcallcc"; break;
Dale Johannesen332dd532008-08-13 18:40:23 +00001374 case CallingConv::X86_SSECall: Out << " x86_ssecallcc"; break;
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001375 default: Out << " cc" << CI->getCallingConv(); break;
1376 }
1377
Reid Spencer1517de32007-04-09 06:10:42 +00001378 const PointerType *PTy = cast<PointerType>(Operand->getType());
1379 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1380 const Type *RetTy = FTy->getReturnType();
Chris Lattner8a923e72008-03-12 17:45:29 +00001381 const PAListPtr &PAL = CI->getParamAttrs();
Chris Lattner2f2d9472001-11-06 21:28:12 +00001382
Chris Lattner463d6a52003-08-05 15:34:45 +00001383 // If possible, print out the short form of the call instruction. We can
Chris Lattner6915f8f2002-04-07 22:49:37 +00001384 // only do this if the first argument is a pointer to a nonvararg function,
Chris Lattner463d6a52003-08-05 15:34:45 +00001385 // and if the return type is not a pointer to a function.
Chris Lattner2f2d9472001-11-06 21:28:12 +00001386 //
Chris Lattner463d6a52003-08-05 15:34:45 +00001387 if (!FTy->isVarArg() &&
Misha Brukmanb1c93172005-04-21 23:48:37 +00001388 (!isa<PointerType>(RetTy) ||
Chris Lattnerd9a36a62002-07-25 20:58:51 +00001389 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001390 Out << ' '; printType(RetTy);
Chris Lattner2f2d9472001-11-06 21:28:12 +00001391 writeOperand(Operand, false);
1392 } else {
1393 writeOperand(Operand, true);
1394 }
Misha Brukmana6619a92004-06-21 21:53:56 +00001395 Out << '(';
Reid Spencer8c4914c2006-12-31 05:24:50 +00001396 for (unsigned op = 1, Eop = I.getNumOperands(); op < Eop; ++op) {
1397 if (op > 1)
1398 Out << ',';
Chris Lattner8a923e72008-03-12 17:45:29 +00001399 writeParamOperand(I.getOperand(op), PAL.getParamAttrs(op));
Chris Lattner2f7c9632001-06-06 20:29:01 +00001400 }
Misha Brukmana6619a92004-06-21 21:53:56 +00001401 Out << " )";
Chris Lattner8a923e72008-03-12 17:45:29 +00001402 if (PAL.getParamAttrs(0) != ParamAttr::None)
1403 Out << ' ' << ParamAttr::getAsString(PAL.getParamAttrs(0));
Chris Lattner113f4f42002-06-25 16:13:24 +00001404 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
Reid Spencer1517de32007-04-09 06:10:42 +00001405 const PointerType *PTy = cast<PointerType>(Operand->getType());
1406 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1407 const Type *RetTy = FTy->getReturnType();
Chris Lattner8a923e72008-03-12 17:45:29 +00001408 const PAListPtr &PAL = II->getParamAttrs();
Chris Lattner463d6a52003-08-05 15:34:45 +00001409
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001410 // Print the calling convention being used.
1411 switch (II->getCallingConv()) {
1412 case CallingConv::C: break; // default
Chris Lattner29d20852006-05-19 21:58:52 +00001413 case CallingConv::Fast: Out << " fastcc"; break;
1414 case CallingConv::Cold: Out << " coldcc"; break;
Anton Korobeynikov3c5b3df2006-09-20 22:03:51 +00001415 case CallingConv::X86_StdCall: Out << "x86_stdcallcc "; break;
1416 case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
Dale Johannesen332dd532008-08-13 18:40:23 +00001417 case CallingConv::X86_SSECall: Out << "x86_ssecallcc "; break;
Chris Lattnerf7b6d312005-05-06 20:26:43 +00001418 default: Out << " cc" << II->getCallingConv(); break;
1419 }
1420
Chris Lattner463d6a52003-08-05 15:34:45 +00001421 // If possible, print out the short form of the invoke instruction. We can
1422 // only do this if the first argument is a pointer to a nonvararg function,
1423 // and if the return type is not a pointer to a function.
1424 //
1425 if (!FTy->isVarArg() &&
Misha Brukmanb1c93172005-04-21 23:48:37 +00001426 (!isa<PointerType>(RetTy) ||
Chris Lattner463d6a52003-08-05 15:34:45 +00001427 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001428 Out << ' '; printType(RetTy);
Chris Lattner463d6a52003-08-05 15:34:45 +00001429 writeOperand(Operand, false);
1430 } else {
1431 writeOperand(Operand, true);
1432 }
1433
Misha Brukmana6619a92004-06-21 21:53:56 +00001434 Out << '(';
Reid Spencer8c4914c2006-12-31 05:24:50 +00001435 for (unsigned op = 3, Eop = I.getNumOperands(); op < Eop; ++op) {
1436 if (op > 3)
1437 Out << ',';
Chris Lattner8a923e72008-03-12 17:45:29 +00001438 writeParamOperand(I.getOperand(op), PAL.getParamAttrs(op-2));
Chris Lattner862e3382001-10-13 06:42:36 +00001439 }
1440
Reid Spencer136a91c2007-01-05 17:06:19 +00001441 Out << " )";
Chris Lattner8a923e72008-03-12 17:45:29 +00001442 if (PAL.getParamAttrs(0) != ParamAttr::None)
Dan Gohman1a70bcc2008-08-05 15:51:44 +00001443 Out << ' ' << ParamAttr::getAsString(PAL.getParamAttrs(0));
Reid Spencer136a91c2007-01-05 17:06:19 +00001444 Out << "\n\t\t\tto";
Chris Lattner862e3382001-10-13 06:42:36 +00001445 writeOperand(II->getNormalDest(), true);
Misha Brukmana6619a92004-06-21 21:53:56 +00001446 Out << " unwind";
Chris Lattnerfae8ab32004-02-08 21:44:31 +00001447 writeOperand(II->getUnwindDest(), true);
Chris Lattner862e3382001-10-13 06:42:36 +00001448
Chris Lattner113f4f42002-06-25 16:13:24 +00001449 } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001450 Out << ' ';
Chris Lattner8d48df22002-04-13 18:34:38 +00001451 printType(AI->getType()->getElementType());
1452 if (AI->isArrayAllocation()) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001453 Out << ',';
Chris Lattner8d48df22002-04-13 18:34:38 +00001454 writeOperand(AI->getArraySize(), true);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001455 }
Nate Begeman848622f2005-11-05 09:21:28 +00001456 if (AI->getAlignment()) {
Chris Lattner7aeee3a2005-11-05 21:20:34 +00001457 Out << ", align " << AI->getAlignment();
Nate Begeman848622f2005-11-05 09:21:28 +00001458 }
Chris Lattner862e3382001-10-13 06:42:36 +00001459 } else if (isa<CastInst>(I)) {
Chris Lattnerc96e96b2003-11-17 01:17:04 +00001460 if (Operand) writeOperand(Operand, true); // Work with broken code
Misha Brukmana6619a92004-06-21 21:53:56 +00001461 Out << " to ";
Chris Lattner113f4f42002-06-25 16:13:24 +00001462 printType(I.getType());
Chris Lattner5b337482003-10-18 05:57:43 +00001463 } else if (isa<VAArgInst>(I)) {
Chris Lattnerc96e96b2003-11-17 01:17:04 +00001464 if (Operand) writeOperand(Operand, true); // Work with broken code
Misha Brukmana6619a92004-06-21 21:53:56 +00001465 Out << ", ";
Chris Lattnerf70da102003-05-08 02:44:12 +00001466 printType(I.getType());
Chris Lattner2f7c9632001-06-06 20:29:01 +00001467 } else if (Operand) { // Print the normal way...
1468
Misha Brukmanb1c93172005-04-21 23:48:37 +00001469 // PrintAllTypes - Instructions who have operands of all the same type
Chris Lattner2f7c9632001-06-06 20:29:01 +00001470 // omit the type from all but the first operand. If the instruction has
1471 // different type operands (for example br), then they are all printed.
1472 bool PrintAllTypes = false;
1473 const Type *TheType = Operand->getType();
Chris Lattner2f7c9632001-06-06 20:29:01 +00001474
Reid Spencer0cdd04f2007-02-02 13:54:55 +00001475 // Select, Store and ShuffleVector always print all types.
Devang Patelce556d92008-03-04 22:05:14 +00001476 if (isa<SelectInst>(I) || isa<StoreInst>(I) || isa<ShuffleVectorInst>(I)
1477 || isa<ReturnInst>(I)) {
Chris Lattnerdeccfaf2003-04-16 20:20:02 +00001478 PrintAllTypes = true;
1479 } else {
1480 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
1481 Operand = I.getOperand(i);
1482 if (Operand->getType() != TheType) {
1483 PrintAllTypes = true; // We have differing types! Print them all!
1484 break;
1485 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001486 }
1487 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00001488
Chris Lattner7bfee412001-10-29 16:05:51 +00001489 if (!PrintAllTypes) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001490 Out << ' ';
Chris Lattnerdeccfaf2003-04-16 20:20:02 +00001491 printType(TheType);
Chris Lattner7bfee412001-10-29 16:05:51 +00001492 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001493
Chris Lattner113f4f42002-06-25 16:13:24 +00001494 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
Misha Brukmana6619a92004-06-21 21:53:56 +00001495 if (i) Out << ',';
Chris Lattner113f4f42002-06-25 16:13:24 +00001496 writeOperand(I.getOperand(i), PrintAllTypes);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001497 }
1498 }
Christopher Lamb84485702007-04-22 19:24:39 +00001499
1500 // Print post operand alignment for load/store
1501 if (isa<LoadInst>(I) && cast<LoadInst>(I).getAlignment()) {
1502 Out << ", align " << cast<LoadInst>(I).getAlignment();
1503 } else if (isa<StoreInst>(I) && cast<StoreInst>(I).getAlignment()) {
1504 Out << ", align " << cast<StoreInst>(I).getAlignment();
1505 }
Chris Lattner2f7c9632001-06-06 20:29:01 +00001506
Chris Lattner862e3382001-10-13 06:42:36 +00001507 printInfoComment(I);
Misha Brukmana6619a92004-06-21 21:53:56 +00001508 Out << "\n";
Chris Lattner2f7c9632001-06-06 20:29:01 +00001509}
1510
1511
1512//===----------------------------------------------------------------------===//
1513// External Interface declarations
1514//===----------------------------------------------------------------------===//
1515
Chris Lattner8339f7d2003-10-30 23:41:03 +00001516void Module::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
Chris Lattnere36fd8a2008-08-19 04:26:57 +00001517 SlotTracker SlotTable(this);
Chris Lattner8339f7d2003-10-30 23:41:03 +00001518 AssemblyWriter W(o, SlotTable, this, AAW);
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +00001519 W.write(this);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001520}
1521
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +00001522void GlobalVariable::print(std::ostream &o) const {
Chris Lattnere36fd8a2008-08-19 04:26:57 +00001523 SlotTracker SlotTable(getParent());
Chris Lattner8339f7d2003-10-30 23:41:03 +00001524 AssemblyWriter W(o, SlotTable, getParent(), 0);
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +00001525 W.write(this);
Chris Lattneradfe0d12001-09-10 20:08:19 +00001526}
1527
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001528void GlobalAlias::print(std::ostream &o) const {
Chris Lattnere36fd8a2008-08-19 04:26:57 +00001529 SlotTracker SlotTable(getParent());
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001530 AssemblyWriter W(o, SlotTable, getParent(), 0);
1531 W.write(this);
1532}
1533
Chris Lattner8339f7d2003-10-30 23:41:03 +00001534void Function::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
Chris Lattnere36fd8a2008-08-19 04:26:57 +00001535 SlotTracker SlotTable(getParent());
Chris Lattner8339f7d2003-10-30 23:41:03 +00001536 AssemblyWriter W(o, SlotTable, getParent(), AAW);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001537
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +00001538 W.write(this);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001539}
1540
Chris Lattnereef2fe72006-01-24 04:13:11 +00001541void InlineAsm::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
Chris Lattner78e2e8b2006-12-06 06:24:27 +00001542 WriteAsOperand(o, this, true, 0);
Chris Lattnereef2fe72006-01-24 04:13:11 +00001543}
1544
Chris Lattner8339f7d2003-10-30 23:41:03 +00001545void BasicBlock::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
Chris Lattnere36fd8a2008-08-19 04:26:57 +00001546 SlotTracker SlotTable(getParent());
Misha Brukmanb1c93172005-04-21 23:48:37 +00001547 AssemblyWriter W(o, SlotTable,
Chris Lattner8339f7d2003-10-30 23:41:03 +00001548 getParent() ? getParent()->getParent() : 0, AAW);
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +00001549 W.write(this);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001550}
1551
Chris Lattner8339f7d2003-10-30 23:41:03 +00001552void Instruction::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +00001553 const Function *F = getParent() ? getParent()->getParent() : 0;
Chris Lattnere36fd8a2008-08-19 04:26:57 +00001554 SlotTracker SlotTable(F);
Chris Lattner8339f7d2003-10-30 23:41:03 +00001555 AssemblyWriter W(o, SlotTable, F ? F->getParent() : 0, AAW);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001556
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +00001557 W.write(this);
Chris Lattner2f7c9632001-06-06 20:29:01 +00001558}
Chris Lattner7db79582001-11-07 04:21:57 +00001559
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +00001560void Constant::print(std::ostream &o) const {
1561 if (this == 0) { o << "<null> constant value\n"; return; }
Chris Lattner7d734802002-09-10 15:53:49 +00001562
Misha Brukman21bbdb92004-06-04 21:11:51 +00001563 o << ' ' << getType()->getDescription() << ' ';
Evan Cheng5b19a802006-03-01 22:17:00 +00001564
1565 std::map<const Type *, std::string> TypeTable;
Chris Lattner78e2e8b2006-12-06 06:24:27 +00001566 WriteConstantInt(o, this, TypeTable, 0);
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +00001567}
1568
Misha Brukmanb1c93172005-04-21 23:48:37 +00001569void Type::print(std::ostream &o) const {
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +00001570 if (this == 0)
1571 o << "<null Type>";
1572 else
1573 o << getDescription();
1574}
1575
Chris Lattner2e9fa6d2002-04-09 19:48:49 +00001576void Argument::print(std::ostream &o) const {
Chris Lattner78e2e8b2006-12-06 06:24:27 +00001577 WriteAsOperand(o, this, true, getParent() ? getParent()->getParent() : 0);
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +00001578}
1579
Reid Spencer52641832004-05-25 18:14:38 +00001580// Value::dump - allow easy printing of Values from the debugger.
1581// Located here because so much of the needed functionality is here.
Bill Wendling22e978a2006-12-07 20:04:42 +00001582void Value::dump() const { print(*cerr.stream()); cerr << '\n'; }
Reid Spencer52641832004-05-25 18:14:38 +00001583
1584// Type::dump - allow easy printing of Values from the debugger.
1585// Located here because so much of the needed functionality is here.
Bill Wendling22e978a2006-12-07 20:04:42 +00001586void Type::dump() const { print(*cerr.stream()); cerr << '\n'; }
Chris Lattnerc0b4c7b2002-04-08 22:03:40 +00001587
1588//===----------------------------------------------------------------------===//
Chris Lattnere36fd8a2008-08-19 04:26:57 +00001589// SlotTracker Implementation
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001590//===----------------------------------------------------------------------===//
1591
1592#if 0
Bill Wendlingf3baad32006-12-07 01:30:32 +00001593#define SC_DEBUG(X) cerr << X
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001594#else
1595#define SC_DEBUG(X)
1596#endif
1597
1598// Module level constructor. Causes the contents of the Module (sans functions)
1599// to be added to the slot table.
Chris Lattnere36fd8a2008-08-19 04:26:57 +00001600SlotTracker::SlotTracker(const Module *M)
Reid Spencer56010e42004-05-26 21:56:09 +00001601 : TheModule(M) ///< Saved for lazy initialization.
1602 , TheFunction(0)
Reid Spencerb0ac8c42004-08-16 07:46:33 +00001603 , FunctionProcessed(false)
Chris Lattnera204d412008-08-17 17:25:25 +00001604 , mNext(0), fNext(0)
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001605{
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001606}
1607
1608// Function level constructor. Causes the contents of the Module and the one
1609// function provided to be added to the slot table.
Chris Lattnere36fd8a2008-08-19 04:26:57 +00001610SlotTracker::SlotTracker(const Function *F)
Chris Lattner23e829a2006-12-06 05:12:21 +00001611 : TheModule(F ? F->getParent() : 0) ///< Saved for lazy initialization
Reid Spencer56010e42004-05-26 21:56:09 +00001612 , TheFunction(F) ///< Saved for lazy initialization
Reid Spencerb0ac8c42004-08-16 07:46:33 +00001613 , FunctionProcessed(false)
Chris Lattnera204d412008-08-17 17:25:25 +00001614 , mNext(0), fNext(0)
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001615{
Reid Spencer56010e42004-05-26 21:56:09 +00001616}
1617
Chris Lattnere36fd8a2008-08-19 04:26:57 +00001618inline void SlotTracker::initialize() {
Chris Lattner23e829a2006-12-06 05:12:21 +00001619 if (TheModule) {
Misha Brukmanb1c93172005-04-21 23:48:37 +00001620 processModule();
Reid Spencer56010e42004-05-26 21:56:09 +00001621 TheModule = 0; ///< Prevent re-processing next time we're called.
1622 }
Chris Lattner193de902006-12-06 05:27:40 +00001623 if (TheFunction && !FunctionProcessed)
Misha Brukmanb1c93172005-04-21 23:48:37 +00001624 processFunction();
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001625}
1626
1627// Iterate through all the global variables, functions, and global
Misha Brukmanb1c93172005-04-21 23:48:37 +00001628// variable initializers and create slots for them.
Chris Lattnere36fd8a2008-08-19 04:26:57 +00001629void SlotTracker::processModule() {
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001630 SC_DEBUG("begin processModule!\n");
1631
Chris Lattner0dda8612006-12-06 06:15:43 +00001632 // Add all of the unnamed global variables to the value table.
Chris Lattner54932b02006-12-06 04:41:52 +00001633 for (Module::const_global_iterator I = TheModule->global_begin(),
1634 E = TheModule->global_end(); I != E; ++I)
Chris Lattner0dda8612006-12-06 06:15:43 +00001635 if (!I->hasName())
Chris Lattnerea862a32007-01-09 07:55:49 +00001636 CreateModuleSlot(I);
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001637
Chris Lattner0dda8612006-12-06 06:15:43 +00001638 // Add all the unnamed functions to the table.
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001639 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
1640 I != E; ++I)
Chris Lattner0dda8612006-12-06 06:15:43 +00001641 if (!I->hasName())
Chris Lattnerea862a32007-01-09 07:55:49 +00001642 CreateModuleSlot(I);
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001643
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001644 SC_DEBUG("end processModule!\n");
1645}
1646
1647
Reid Spencer56010e42004-05-26 21:56:09 +00001648// Process the arguments, basic blocks, and instructions of a function.
Chris Lattnere36fd8a2008-08-19 04:26:57 +00001649void SlotTracker::processFunction() {
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001650 SC_DEBUG("begin processFunction!\n");
Reid Spencer50816782007-03-19 18:32:53 +00001651 fNext = 0;
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001652
Chris Lattner0dda8612006-12-06 06:15:43 +00001653 // Add all the function arguments with no names.
Misha Brukmanb1c93172005-04-21 23:48:37 +00001654 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
Chris Lattner531f9e92005-03-15 04:54:21 +00001655 AE = TheFunction->arg_end(); AI != AE; ++AI)
Chris Lattner0dda8612006-12-06 06:15:43 +00001656 if (!AI->hasName())
Chris Lattnerea862a32007-01-09 07:55:49 +00001657 CreateFunctionSlot(AI);
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001658
1659 SC_DEBUG("Inserting Instructions:\n");
1660
Chris Lattner0dda8612006-12-06 06:15:43 +00001661 // Add all of the basic blocks and instructions with no names.
Misha Brukmanb1c93172005-04-21 23:48:37 +00001662 for (Function::const_iterator BB = TheFunction->begin(),
Reid Spencer56010e42004-05-26 21:56:09 +00001663 E = TheFunction->end(); BB != E; ++BB) {
Chris Lattner0dda8612006-12-06 06:15:43 +00001664 if (!BB->hasName())
Chris Lattnerea862a32007-01-09 07:55:49 +00001665 CreateFunctionSlot(BB);
Chris Lattner0dda8612006-12-06 06:15:43 +00001666 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1667 if (I->getType() != Type::VoidTy && !I->hasName())
Chris Lattnerea862a32007-01-09 07:55:49 +00001668 CreateFunctionSlot(I);
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001669 }
1670
Reid Spencerb0ac8c42004-08-16 07:46:33 +00001671 FunctionProcessed = true;
1672
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001673 SC_DEBUG("end processFunction!\n");
1674}
1675
Chris Lattner193de902006-12-06 05:27:40 +00001676/// Clean up after incorporating a function. This is the only way to get out of
Chris Lattner5e043322007-01-11 03:54:27 +00001677/// the function incorporation state that affects get*Slot/Create*Slot. Function
Chris Lattner89e774e2007-01-09 07:46:21 +00001678/// incorporation state is indicated by TheFunction != 0.
Chris Lattnere36fd8a2008-08-19 04:26:57 +00001679void SlotTracker::purgeFunction() {
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001680 SC_DEBUG("begin purgeFunction!\n");
1681 fMap.clear(); // Simply discard the function level map
Reid Spencer56010e42004-05-26 21:56:09 +00001682 TheFunction = 0;
Reid Spencerb0ac8c42004-08-16 07:46:33 +00001683 FunctionProcessed = false;
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001684 SC_DEBUG("end purgeFunction!\n");
1685}
1686
Chris Lattner5e043322007-01-11 03:54:27 +00001687/// getGlobalSlot - Get the slot number of a global value.
Chris Lattnere36fd8a2008-08-19 04:26:57 +00001688int SlotTracker::getGlobalSlot(const GlobalValue *V) {
Chris Lattner5e043322007-01-11 03:54:27 +00001689 // Check for uninitialized state and do lazy initialization.
1690 initialize();
1691
1692 // Find the type plane in the module map
Chris Lattnera204d412008-08-17 17:25:25 +00001693 ValueMap::iterator MI = mMap.find(V);
1694 return MI == mMap.end() ? -1 : MI->second;
Chris Lattner5e043322007-01-11 03:54:27 +00001695}
Reid Spencer56010e42004-05-26 21:56:09 +00001696
Chris Lattner5e043322007-01-11 03:54:27 +00001697
1698/// getLocalSlot - Get the slot number for a value that is local to a function.
Chris Lattnere36fd8a2008-08-19 04:26:57 +00001699int SlotTracker::getLocalSlot(const Value *V) {
Chris Lattner5e043322007-01-11 03:54:27 +00001700 assert(!isa<Constant>(V) && "Can't get a constant or global slot with this!");
1701
1702 // Check for uninitialized state and do lazy initialization.
1703 initialize();
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001704
Chris Lattnera204d412008-08-17 17:25:25 +00001705 ValueMap::iterator FI = fMap.find(V);
1706 return FI == fMap.end() ? -1 : FI->second;
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001707}
1708
Reid Spencer58d30f22004-07-04 11:50:43 +00001709
Chris Lattnerea862a32007-01-09 07:55:49 +00001710/// CreateModuleSlot - Insert the specified GlobalValue* into the slot table.
Chris Lattnere36fd8a2008-08-19 04:26:57 +00001711void SlotTracker::CreateModuleSlot(const GlobalValue *V) {
1712 assert(V && "Can't insert a null Value into SlotTracker!");
Reid Spencer50816782007-03-19 18:32:53 +00001713 assert(V->getType() != Type::VoidTy && "Doesn't need a slot!");
1714 assert(!V->hasName() && "Doesn't need a slot!");
Chris Lattner04398e82007-01-09 08:04:59 +00001715
Reid Spencer50816782007-03-19 18:32:53 +00001716 unsigned DestSlot = mNext++;
1717 mMap[V] = DestSlot;
Chris Lattner04398e82007-01-09 08:04:59 +00001718
Reid Spencer50816782007-03-19 18:32:53 +00001719 SC_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
Chris Lattner04398e82007-01-09 08:04:59 +00001720 DestSlot << " [");
Anton Korobeynikova97b6942007-04-25 14:27:10 +00001721 // G = Global, F = Function, A = Alias, o = other
1722 SC_DEBUG((isa<GlobalVariable>(V) ? 'G' :
Chris Lattner393b7cd2008-08-17 04:17:45 +00001723 (isa<Function>(V) ? 'F' :
1724 (isa<GlobalAlias>(V) ? 'A' : 'o'))) << "]\n");
Reid Spencer16f2f7f2004-05-26 07:18:52 +00001725}
1726
1727
Chris Lattnerea862a32007-01-09 07:55:49 +00001728/// CreateSlot - Create a new slot for the specified value if it has no name.
Chris Lattnere36fd8a2008-08-19 04:26:57 +00001729void SlotTracker::CreateFunctionSlot(const Value *V) {
Chris Lattner033935d2008-08-17 04:40:13 +00001730 assert(V->getType() != Type::VoidTy && !V->hasName() &&
1731 "Doesn't need a slot!");
Chris Lattner04398e82007-01-09 08:04:59 +00001732
Reid Spencer50816782007-03-19 18:32:53 +00001733 unsigned DestSlot = fNext++;
1734 fMap[V] = DestSlot;
Chris Lattner04398e82007-01-09 08:04:59 +00001735
Chris Lattnerf8090cb2006-12-06 05:55:41 +00001736 // G = Global, F = Function, o = other
Chris Lattner033935d2008-08-17 04:40:13 +00001737 SC_DEBUG(" Inserting value [" << V->getType() << "] = " << V << " slot=" <<
Chris Lattner04398e82007-01-09 08:04:59 +00001738 DestSlot << " [o]\n");
1739}