1 //===-- AsmWriter.cpp - Printing LLVM as an assembly file -----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This library implements the functionality defined in llvm/Assembly/Writer.h
12 // Note that these routines must be extremely tolerant of various errors in the
13 // LLVM code, because it can be used for debugging transformations.
15 //===----------------------------------------------------------------------===//
17 #include "llvm/Assembly/CachedWriter.h"
18 #include "llvm/Assembly/Writer.h"
19 #include "llvm/Assembly/PrintModulePass.h"
20 #include "llvm/Assembly/AsmAnnotationWriter.h"
21 #include "llvm/CallingConv.h"
22 #include "llvm/Constants.h"
23 #include "llvm/DerivedTypes.h"
24 #include "llvm/InlineAsm.h"
25 #include "llvm/Instruction.h"
26 #include "llvm/Instructions.h"
27 #include "llvm/Module.h"
28 #include "llvm/SymbolTable.h"
29 #include "llvm/ADT/StringExtras.h"
30 #include "llvm/ADT/STLExtras.h"
31 #include "llvm/Support/CFG.h"
32 #include "llvm/Support/MathExtras.h"
33 #include "llvm/Support/Streams.h"
39 // Make virtual table appear in this compilation unit.
40 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
42 /// This class provides computation of slot numbers for LLVM Assembly writing.
43 /// @brief LLVM Assembly Writing Slot Computation.
50 /// @brief A mapping of Values to slot numbers
51 typedef std::map<const Value*, unsigned> ValueMap;
52 typedef std::map<const Type*, unsigned> TypeMap;
54 /// @brief A plane with next slot number and ValueMap
56 unsigned next_slot; ///< The next slot number to use
57 ValueMap map; ///< The map of Value* -> unsigned
58 ValuePlane() { next_slot = 0; } ///< Make sure we start at 0
64 TypePlane() { next_slot = 0; }
65 void clear() { map.clear(); next_slot = 0; }
68 /// @brief The map of planes by Type
69 typedef std::map<const Type*, ValuePlane> TypedPlanes;
72 /// @name Constructors
75 /// @brief Construct from a module
76 SlotMachine(const Module *M );
78 /// @brief Construct from a function, starting out in incorp state.
79 SlotMachine(const Function *F );
85 /// Return the slot number of the specified value in it's type
86 /// plane. Its an error to ask for something not in the SlotMachine.
87 /// Its an error to ask for a Type*
88 int getSlot(const Value *V);
89 int getSlot(const Type*Ty);
91 /// Determine if a Value has a slot or not
92 bool hasSlot(const Value* V);
93 bool hasSlot(const Type* Ty);
99 /// If you'd like to deal with a function instead of just a module, use
100 /// this method to get its data into the SlotMachine.
101 void incorporateFunction(const Function *F) {
103 FunctionProcessed = false;
106 /// After calling incorporateFunction, use this method to remove the
107 /// most recently incorporated function from the SlotMachine. This
108 /// will reset the state of the machine back to just the module contents.
109 void purgeFunction();
112 /// @name Implementation Details
115 /// This function does the actual initialization.
116 inline void initialize();
118 /// Values can be crammed into here at will. If they haven't
119 /// been inserted already, they get inserted, otherwise they are ignored.
120 /// Either way, the slot number for the Value* is returned.
121 unsigned createSlot(const Value *V);
122 unsigned createSlot(const Type* Ty);
124 /// Insert a value into the value table. Return the slot number
125 /// that it now occupies. BadThings(TM) will happen if you insert a
126 /// Value that's already been inserted.
127 unsigned insertValue( const Value *V );
128 unsigned insertValue( const Type* Ty);
130 /// Add all of the module level global variables (and their initializers)
131 /// and function declarations, but not the contents of those functions.
132 void processModule();
134 /// Add all of the functions arguments, basic blocks, and instructions
135 void processFunction();
137 SlotMachine(const SlotMachine &); // DO NOT IMPLEMENT
138 void operator=(const SlotMachine &); // DO NOT IMPLEMENT
145 /// @brief The module for which we are holding slot numbers
146 const Module* TheModule;
148 /// @brief The function for which we are holding slot numbers
149 const Function* TheFunction;
150 bool FunctionProcessed;
152 /// @brief The TypePlanes map for the module level data
156 /// @brief The TypePlanes map for the function level data
164 } // end namespace llvm
166 static RegisterPass<PrintModulePass>
167 X("printm", "Print module to stderr");
168 static RegisterPass<PrintFunctionPass>
169 Y("print","Print function to stderr");
171 static void WriteAsOperandInternal(std::ostream &Out, const Value *V,
173 std::map<const Type *, std::string> &TypeTable,
174 SlotMachine *Machine);
176 static void WriteAsOperandInternal(std::ostream &Out, const Type *T,
178 std::map<const Type *, std::string> &TypeTable,
179 SlotMachine *Machine);
181 static const Module *getModuleFromVal(const Value *V) {
182 if (const Argument *MA = dyn_cast<Argument>(V))
183 return MA->getParent() ? MA->getParent()->getParent() : 0;
184 else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
185 return BB->getParent() ? BB->getParent()->getParent() : 0;
186 else if (const Instruction *I = dyn_cast<Instruction>(V)) {
187 const Function *M = I->getParent() ? I->getParent()->getParent() : 0;
188 return M ? M->getParent() : 0;
189 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
190 return GV->getParent();
194 static SlotMachine *createSlotMachine(const Value *V) {
195 if (const Argument *FA = dyn_cast<Argument>(V)) {
196 return new SlotMachine(FA->getParent());
197 } else if (const Instruction *I = dyn_cast<Instruction>(V)) {
198 return new SlotMachine(I->getParent()->getParent());
199 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V)) {
200 return new SlotMachine(BB->getParent());
201 } else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V)){
202 return new SlotMachine(GV->getParent());
203 } else if (const Function *Func = dyn_cast<Function>(V)) {
204 return new SlotMachine(Func);
209 // getLLVMName - Turn the specified string into an 'LLVM name', which is either
210 // prefixed with % (if the string only contains simple characters) or is
211 // surrounded with ""'s (if it has special chars in it).
212 static std::string getLLVMName(const std::string &Name,
213 bool prefixName = true) {
214 assert(!Name.empty() && "Cannot get empty name!");
216 // First character cannot start with a number...
217 if (Name[0] >= '0' && Name[0] <= '9')
218 return "\"" + Name + "\"";
220 // Scan to see if we have any characters that are not on the "white list"
221 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
223 assert(C != '"' && "Illegal character in LLVM value name!");
224 if ((C < 'a' || C > 'z') && (C < 'A' || C > 'Z') && (C < '0' || C > '9') &&
225 C != '-' && C != '.' && C != '_')
226 return "\"" + Name + "\"";
229 // If we get here, then the identifier is legal to use as a "VarID".
237 /// fillTypeNameTable - If the module has a symbol table, take all global types
238 /// and stuff their names into the TypeNames map.
240 static void fillTypeNameTable(const Module *M,
241 std::map<const Type *, std::string> &TypeNames) {
243 const SymbolTable &ST = M->getSymbolTable();
244 SymbolTable::type_const_iterator TI = ST.type_begin();
245 for (; TI != ST.type_end(); ++TI ) {
246 // As a heuristic, don't insert pointer to primitive types, because
247 // they are used too often to have a single useful name.
249 const Type *Ty = cast<Type>(TI->second);
250 if (!isa<PointerType>(Ty) ||
251 !cast<PointerType>(Ty)->getElementType()->isPrimitiveType() ||
252 isa<OpaqueType>(cast<PointerType>(Ty)->getElementType()))
253 TypeNames.insert(std::make_pair(Ty, getLLVMName(TI->first)));
259 static void calcTypeName(const Type *Ty,
260 std::vector<const Type *> &TypeStack,
261 std::map<const Type *, std::string> &TypeNames,
262 std::string & Result){
263 if (Ty->isPrimitiveType() && !isa<OpaqueType>(Ty)) {
264 Result += Ty->getDescription(); // Base case
268 // Check to see if the type is named.
269 std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
270 if (I != TypeNames.end()) {
275 if (isa<OpaqueType>(Ty)) {
280 // Check to see if the Type is already on the stack...
281 unsigned Slot = 0, CurSize = TypeStack.size();
282 while (Slot < CurSize && TypeStack[Slot] != Ty) ++Slot; // Scan for type
284 // This is another base case for the recursion. In this case, we know
285 // that we have looped back to a type that we have previously visited.
286 // Generate the appropriate upreference to handle this.
287 if (Slot < CurSize) {
288 Result += "\\" + utostr(CurSize-Slot); // Here's the upreference
292 TypeStack.push_back(Ty); // Recursive case: Add us to the stack..
294 switch (Ty->getTypeID()) {
295 case Type::FunctionTyID: {
296 const FunctionType *FTy = cast<FunctionType>(Ty);
297 calcTypeName(FTy->getReturnType(), TypeStack, TypeNames, Result);
299 for (FunctionType::param_iterator I = FTy->param_begin(),
300 E = FTy->param_end(); I != E; ++I) {
301 if (I != FTy->param_begin())
303 calcTypeName(*I, TypeStack, TypeNames, Result);
305 if (FTy->isVarArg()) {
306 if (FTy->getNumParams()) Result += ", ";
312 case Type::StructTyID: {
313 const StructType *STy = cast<StructType>(Ty);
315 for (StructType::element_iterator I = STy->element_begin(),
316 E = STy->element_end(); I != E; ++I) {
317 if (I != STy->element_begin())
319 calcTypeName(*I, TypeStack, TypeNames, Result);
324 case Type::PointerTyID:
325 calcTypeName(cast<PointerType>(Ty)->getElementType(),
326 TypeStack, TypeNames, Result);
329 case Type::ArrayTyID: {
330 const ArrayType *ATy = cast<ArrayType>(Ty);
331 Result += "[" + utostr(ATy->getNumElements()) + " x ";
332 calcTypeName(ATy->getElementType(), TypeStack, TypeNames, Result);
336 case Type::PackedTyID: {
337 const PackedType *PTy = cast<PackedType>(Ty);
338 Result += "<" + utostr(PTy->getNumElements()) + " x ";
339 calcTypeName(PTy->getElementType(), TypeStack, TypeNames, Result);
343 case Type::OpaqueTyID:
347 Result += "<unrecognized-type>";
350 TypeStack.pop_back(); // Remove self from stack...
355 /// printTypeInt - The internal guts of printing out a type that has a
356 /// potentially named portion.
358 static std::ostream &printTypeInt(std::ostream &Out, const Type *Ty,
359 std::map<const Type *, std::string> &TypeNames) {
360 // Primitive types always print out their description, regardless of whether
361 // they have been named or not.
363 if (Ty->isPrimitiveType() && !isa<OpaqueType>(Ty))
364 return Out << Ty->getDescription();
366 // Check to see if the type is named.
367 std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
368 if (I != TypeNames.end()) return Out << I->second;
370 // Otherwise we have a type that has not been named but is a derived type.
371 // Carefully recurse the type hierarchy to print out any contained symbolic
374 std::vector<const Type *> TypeStack;
375 std::string TypeName;
376 calcTypeName(Ty, TypeStack, TypeNames, TypeName);
377 TypeNames.insert(std::make_pair(Ty, TypeName));//Cache type name for later use
378 return (Out << TypeName);
382 /// WriteTypeSymbolic - This attempts to write the specified type as a symbolic
383 /// type, iff there is an entry in the modules symbol table for the specified
384 /// type or one of it's component types. This is slower than a simple x << Type
386 std::ostream &llvm::WriteTypeSymbolic(std::ostream &Out, const Type *Ty,
390 // If they want us to print out a type, attempt to make it symbolic if there
391 // is a symbol table in the module...
393 std::map<const Type *, std::string> TypeNames;
394 fillTypeNameTable(M, TypeNames);
396 return printTypeInt(Out, Ty, TypeNames);
398 return Out << Ty->getDescription();
402 // PrintEscapedString - Print each character of the specified string, escaping
403 // it if it is not printable or if it is an escape char.
404 static void PrintEscapedString(const std::string &Str, std::ostream &Out) {
405 for (unsigned i = 0, e = Str.size(); i != e; ++i) {
406 unsigned char C = Str[i];
407 if (isprint(C) && C != '"' && C != '\\') {
411 << (char) ((C/16 < 10) ? ( C/16 +'0') : ( C/16 -10+'A'))
412 << (char)(((C&15) < 10) ? ((C&15)+'0') : ((C&15)-10+'A'));
417 static const char * getPredicateText(unsigned predicate) {
418 const char * pred = "unknown";
420 case FCmpInst::FCMP_FALSE: pred = "false"; break;
421 case FCmpInst::FCMP_OEQ: pred = "oeq"; break;
422 case FCmpInst::FCMP_OGT: pred = "ogt"; break;
423 case FCmpInst::FCMP_OGE: pred = "oge"; break;
424 case FCmpInst::FCMP_OLT: pred = "olt"; break;
425 case FCmpInst::FCMP_OLE: pred = "ole"; break;
426 case FCmpInst::FCMP_ONE: pred = "one"; break;
427 case FCmpInst::FCMP_ORD: pred = "ord"; break;
428 case FCmpInst::FCMP_UNO: pred = "uno"; break;
429 case FCmpInst::FCMP_UEQ: pred = "ueq"; break;
430 case FCmpInst::FCMP_UGT: pred = "ugt"; break;
431 case FCmpInst::FCMP_UGE: pred = "uge"; break;
432 case FCmpInst::FCMP_ULT: pred = "ult"; break;
433 case FCmpInst::FCMP_ULE: pred = "ule"; break;
434 case FCmpInst::FCMP_UNE: pred = "une"; break;
435 case FCmpInst::FCMP_TRUE: pred = "true"; break;
436 case ICmpInst::ICMP_EQ: pred = "eq"; break;
437 case ICmpInst::ICMP_NE: pred = "ne"; break;
438 case ICmpInst::ICMP_SGT: pred = "sgt"; break;
439 case ICmpInst::ICMP_SGE: pred = "sge"; break;
440 case ICmpInst::ICMP_SLT: pred = "slt"; break;
441 case ICmpInst::ICMP_SLE: pred = "sle"; break;
442 case ICmpInst::ICMP_UGT: pred = "ugt"; break;
443 case ICmpInst::ICMP_UGE: pred = "uge"; break;
444 case ICmpInst::ICMP_ULT: pred = "ult"; break;
445 case ICmpInst::ICMP_ULE: pred = "ule"; break;
450 /// @brief Internal constant writer.
451 static void WriteConstantInt(std::ostream &Out, const Constant *CV,
453 std::map<const Type *, std::string> &TypeTable,
454 SlotMachine *Machine) {
455 const int IndentSize = 4;
456 static std::string Indent = "\n";
457 if (const ConstantBool *CB = dyn_cast<ConstantBool>(CV)) {
458 Out << (CB->getValue() ? "true" : "false");
459 } else if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
460 if (CI->getType()->isSigned())
461 Out << CI->getSExtValue();
463 Out << CI->getZExtValue();
464 } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
465 // We would like to output the FP constant value in exponential notation,
466 // but we cannot do this if doing so will lose precision. Check here to
467 // make sure that we only output it in exponential format if we can parse
468 // the value back and get the same value.
470 std::string StrVal = ftostr(CFP->getValue());
472 // Check to make sure that the stringized number is not some string like
473 // "Inf" or NaN, that atof will accept, but the lexer will not. Check that
474 // the string matches the "[-+]?[0-9]" regex.
476 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
477 ((StrVal[0] == '-' || StrVal[0] == '+') &&
478 (StrVal[1] >= '0' && StrVal[1] <= '9')))
479 // Reparse stringized version!
480 if (atof(StrVal.c_str()) == CFP->getValue()) {
485 // Otherwise we could not reparse it to exactly the same value, so we must
486 // output the string in hexadecimal format!
487 assert(sizeof(double) == sizeof(uint64_t) &&
488 "assuming that double is 64 bits!");
489 Out << "0x" << utohexstr(DoubleToBits(CFP->getValue()));
491 } else if (isa<ConstantAggregateZero>(CV)) {
492 Out << "zeroinitializer";
493 } else if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
494 // As a special case, print the array as a string if it is an array of
495 // ubytes or an array of sbytes with positive values.
497 const Type *ETy = CA->getType()->getElementType();
498 if (CA->isString()) {
500 PrintEscapedString(CA->getAsString(), Out);
503 } else { // Cannot output in string format...
505 if (CA->getNumOperands()) {
507 printTypeInt(Out, ETy, TypeTable);
508 WriteAsOperandInternal(Out, CA->getOperand(0),
509 PrintName, TypeTable, Machine);
510 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
512 printTypeInt(Out, ETy, TypeTable);
513 WriteAsOperandInternal(Out, CA->getOperand(i), PrintName,
519 } else if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
521 unsigned N = CS->getNumOperands();
524 Indent += std::string(IndentSize, ' ');
529 printTypeInt(Out, CS->getOperand(0)->getType(), TypeTable);
531 WriteAsOperandInternal(Out, CS->getOperand(0),
532 PrintName, TypeTable, Machine);
534 for (unsigned i = 1; i < N; i++) {
536 if (N > 2) Out << Indent;
537 printTypeInt(Out, CS->getOperand(i)->getType(), TypeTable);
539 WriteAsOperandInternal(Out, CS->getOperand(i),
540 PrintName, TypeTable, Machine);
542 if (N > 2) Indent.resize(Indent.size() - IndentSize);
546 } else if (const ConstantPacked *CP = dyn_cast<ConstantPacked>(CV)) {
547 const Type *ETy = CP->getType()->getElementType();
548 assert(CP->getNumOperands() > 0 &&
549 "Number of operands for a PackedConst must be > 0");
552 printTypeInt(Out, ETy, TypeTable);
553 WriteAsOperandInternal(Out, CP->getOperand(0),
554 PrintName, TypeTable, Machine);
555 for (unsigned i = 1, e = CP->getNumOperands(); i != e; ++i) {
557 printTypeInt(Out, ETy, TypeTable);
558 WriteAsOperandInternal(Out, CP->getOperand(i), PrintName,
562 } else if (isa<ConstantPointerNull>(CV)) {
565 } else if (isa<UndefValue>(CV)) {
568 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
569 Out << CE->getOpcodeName();
571 Out << " " << getPredicateText(CE->getPredicate());
574 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
575 printTypeInt(Out, (*OI)->getType(), TypeTable);
576 WriteAsOperandInternal(Out, *OI, PrintName, TypeTable, Machine);
577 if (OI+1 != CE->op_end())
583 printTypeInt(Out, CE->getType(), TypeTable);
589 Out << "<placeholder or erroneous Constant>";
594 /// WriteAsOperand - Write the name of the specified value out to the specified
595 /// ostream. This can be useful when you just want to print int %reg126, not
596 /// the whole instruction that generated it.
598 static void WriteAsOperandInternal(std::ostream &Out, const Value *V,
600 std::map<const Type*, std::string> &TypeTable,
601 SlotMachine *Machine) {
603 if ((PrintName || isa<GlobalValue>(V)) && V->hasName())
604 Out << getLLVMName(V->getName());
606 const Constant *CV = dyn_cast<Constant>(V);
607 if (CV && !isa<GlobalValue>(CV)) {
608 WriteConstantInt(Out, CV, PrintName, TypeTable, Machine);
609 } else if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
611 if (IA->hasSideEffects())
612 Out << "sideeffect ";
614 PrintEscapedString(IA->getAsmString(), Out);
616 PrintEscapedString(IA->getConstraintString(), Out);
621 Slot = Machine->getSlot(V);
623 Machine = createSlotMachine(V);
625 Slot = Machine->getSlot(V);
638 /// WriteAsOperand - Write the name of the specified value out to the specified
639 /// ostream. This can be useful when you just want to print int %reg126, not
640 /// the whole instruction that generated it.
642 std::ostream &llvm::WriteAsOperand(std::ostream &Out, const Value *V,
643 bool PrintType, bool PrintName,
644 const Module *Context) {
645 std::map<const Type *, std::string> TypeNames;
646 if (Context == 0) Context = getModuleFromVal(V);
649 fillTypeNameTable(Context, TypeNames);
652 printTypeInt(Out, V->getType(), TypeNames);
654 WriteAsOperandInternal(Out, V, PrintName, TypeNames, 0);
658 /// WriteAsOperandInternal - Write the name of the specified value out to
659 /// the specified ostream. This can be useful when you just want to print
660 /// int %reg126, not the whole instruction that generated it.
662 static void WriteAsOperandInternal(std::ostream &Out, const Type *T,
664 std::map<const Type*, std::string> &TypeTable,
665 SlotMachine *Machine) {
669 Slot = Machine->getSlot(T);
675 Out << T->getDescription();
679 /// WriteAsOperand - Write the name of the specified value out to the specified
680 /// ostream. This can be useful when you just want to print int %reg126, not
681 /// the whole instruction that generated it.
683 std::ostream &llvm::WriteAsOperand(std::ostream &Out, const Type *Ty,
684 bool PrintType, bool PrintName,
685 const Module *Context) {
686 std::map<const Type *, std::string> TypeNames;
687 assert(Context != 0 && "Can't write types as operand without module context");
689 fillTypeNameTable(Context, TypeNames);
692 // printTypeInt(Out, V->getType(), TypeNames);
694 printTypeInt(Out, Ty, TypeNames);
696 WriteAsOperandInternal(Out, Ty, PrintName, TypeNames, 0);
702 class AssemblyWriter {
704 SlotMachine &Machine;
705 const Module *TheModule;
706 std::map<const Type *, std::string> TypeNames;
707 AssemblyAnnotationWriter *AnnotationWriter;
709 inline AssemblyWriter(std::ostream &o, SlotMachine &Mac, const Module *M,
710 AssemblyAnnotationWriter *AAW)
711 : Out(o), Machine(Mac), TheModule(M), AnnotationWriter(AAW) {
713 // If the module has a symbol table, take all global types and stuff their
714 // names into the TypeNames map.
716 fillTypeNameTable(M, TypeNames);
719 inline void write(const Module *M) { printModule(M); }
720 inline void write(const GlobalVariable *G) { printGlobal(G); }
721 inline void write(const Function *F) { printFunction(F); }
722 inline void write(const BasicBlock *BB) { printBasicBlock(BB); }
723 inline void write(const Instruction *I) { printInstruction(*I); }
724 inline void write(const Constant *CPV) { printConstant(CPV); }
725 inline void write(const Type *Ty) { printType(Ty); }
727 void writeOperand(const Value *Op, bool PrintType, bool PrintName = true);
729 const Module* getModule() { return TheModule; }
732 void printModule(const Module *M);
733 void printSymbolTable(const SymbolTable &ST);
734 void printConstant(const Constant *CPV);
735 void printGlobal(const GlobalVariable *GV);
736 void printFunction(const Function *F);
737 void printArgument(const Argument *FA);
738 void printBasicBlock(const BasicBlock *BB);
739 void printInstruction(const Instruction &I);
741 // printType - Go to extreme measures to attempt to print out a short,
742 // symbolic version of a type name.
744 std::ostream &printType(const Type *Ty) {
745 return printTypeInt(Out, Ty, TypeNames);
748 // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
749 // without considering any symbolic types that we may have equal to it.
751 std::ostream &printTypeAtLeastOneLevel(const Type *Ty);
753 // printInfoComment - Print a little comment after the instruction indicating
754 // which slot it occupies.
755 void printInfoComment(const Value &V);
757 } // end of llvm namespace
759 /// printTypeAtLeastOneLevel - Print out one level of the possibly complex type
760 /// without considering any symbolic types that we may have equal to it.
762 std::ostream &AssemblyWriter::printTypeAtLeastOneLevel(const Type *Ty) {
763 if (const FunctionType *FTy = dyn_cast<FunctionType>(Ty)) {
764 printType(FTy->getReturnType()) << " (";
765 for (FunctionType::param_iterator I = FTy->param_begin(),
766 E = FTy->param_end(); I != E; ++I) {
767 if (I != FTy->param_begin())
771 if (FTy->isVarArg()) {
772 if (FTy->getNumParams()) Out << ", ";
776 } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
778 for (StructType::element_iterator I = STy->element_begin(),
779 E = STy->element_end(); I != E; ++I) {
780 if (I != STy->element_begin())
785 } else if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
786 printType(PTy->getElementType()) << '*';
787 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
788 Out << '[' << ATy->getNumElements() << " x ";
789 printType(ATy->getElementType()) << ']';
790 } else if (const PackedType *PTy = dyn_cast<PackedType>(Ty)) {
791 Out << '<' << PTy->getNumElements() << " x ";
792 printType(PTy->getElementType()) << '>';
794 else if (isa<OpaqueType>(Ty)) {
797 if (!Ty->isPrimitiveType())
798 Out << "<unknown derived type>";
805 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType,
808 if (PrintType) { Out << ' '; printType(Operand->getType()); }
809 WriteAsOperandInternal(Out, Operand, PrintName, TypeNames, &Machine);
811 Out << "<null operand!>";
816 void AssemblyWriter::printModule(const Module *M) {
817 if (!M->getModuleIdentifier().empty() &&
818 // Don't print the ID if it will start a new line (which would
819 // require a comment char before it).
820 M->getModuleIdentifier().find('\n') == std::string::npos)
821 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
823 if (!M->getDataLayout().empty())
824 Out << "target datalayout = \"" << M->getDataLayout() << "\"\n";
826 switch (M->getEndianness()) {
827 case Module::LittleEndian: Out << "target endian = little\n"; break;
828 case Module::BigEndian: Out << "target endian = big\n"; break;
829 case Module::AnyEndianness: break;
831 switch (M->getPointerSize()) {
832 case Module::Pointer32: Out << "target pointersize = 32\n"; break;
833 case Module::Pointer64: Out << "target pointersize = 64\n"; break;
834 case Module::AnyPointerSize: break;
836 if (!M->getTargetTriple().empty())
837 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
839 if (!M->getModuleInlineAsm().empty()) {
840 // Split the string into lines, to make it easier to read the .ll file.
841 std::string Asm = M->getModuleInlineAsm();
843 size_t NewLine = Asm.find_first_of('\n', CurPos);
844 while (NewLine != std::string::npos) {
845 // We found a newline, print the portion of the asm string from the
846 // last newline up to this newline.
847 Out << "module asm \"";
848 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
852 NewLine = Asm.find_first_of('\n', CurPos);
854 Out << "module asm \"";
855 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.end()), Out);
859 // Loop over the dependent libraries and emit them.
860 Module::lib_iterator LI = M->lib_begin();
861 Module::lib_iterator LE = M->lib_end();
863 Out << "deplibs = [ ";
865 Out << '"' << *LI << '"';
873 // Loop over the symbol table, emitting all named constants.
874 printSymbolTable(M->getSymbolTable());
876 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end(); I != E; ++I)
879 Out << "\nimplementation ; Functions:\n";
881 // Output all of the functions.
882 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
886 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
887 if (GV->hasName()) Out << getLLVMName(GV->getName()) << " = ";
889 if (!GV->hasInitializer())
890 switch (GV->getLinkage()) {
891 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
892 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
893 default: Out << "external "; break;
896 switch (GV->getLinkage()) {
897 case GlobalValue::InternalLinkage: Out << "internal "; break;
898 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
899 case GlobalValue::WeakLinkage: Out << "weak "; break;
900 case GlobalValue::AppendingLinkage: Out << "appending "; break;
901 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
902 case GlobalValue::DLLExportLinkage: Out << "dllexport "; break;
903 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
904 case GlobalValue::ExternalLinkage: break;
905 case GlobalValue::GhostLinkage:
906 llvm_cerr << "GhostLinkage not allowed in AsmWriter!\n";
910 Out << (GV->isConstant() ? "constant " : "global ");
911 printType(GV->getType()->getElementType());
913 if (GV->hasInitializer()) {
914 Constant* C = cast<Constant>(GV->getInitializer());
915 assert(C && "GlobalVar initializer isn't constant?");
916 writeOperand(GV->getInitializer(), false, isa<GlobalValue>(C));
919 if (GV->hasSection())
920 Out << ", section \"" << GV->getSection() << '"';
921 if (GV->getAlignment())
922 Out << ", align " << GV->getAlignment();
924 printInfoComment(*GV);
929 // printSymbolTable - Run through symbol table looking for constants
930 // and types. Emit their declarations.
931 void AssemblyWriter::printSymbolTable(const SymbolTable &ST) {
934 for (SymbolTable::type_const_iterator TI = ST.type_begin();
935 TI != ST.type_end(); ++TI ) {
936 Out << "\t" << getLLVMName(TI->first) << " = type ";
938 // Make sure we print out at least one level of the type structure, so
939 // that we do not get %FILE = type %FILE
941 printTypeAtLeastOneLevel(TI->second) << "\n";
944 // Print the constants, in type plane order.
945 for (SymbolTable::plane_const_iterator PI = ST.plane_begin();
946 PI != ST.plane_end(); ++PI ) {
947 SymbolTable::value_const_iterator VI = ST.value_begin(PI->first);
948 SymbolTable::value_const_iterator VE = ST.value_end(PI->first);
950 for (; VI != VE; ++VI) {
951 const Value* V = VI->second;
952 const Constant *CPV = dyn_cast<Constant>(V) ;
953 if (CPV && !isa<GlobalValue>(V)) {
961 /// printConstant - Print out a constant pool entry...
963 void AssemblyWriter::printConstant(const Constant *CPV) {
964 // Don't print out unnamed constants, they will be inlined
965 if (!CPV->hasName()) return;
968 Out << "\t" << getLLVMName(CPV->getName()) << " =";
970 // Write the value out now...
971 writeOperand(CPV, true, false);
973 printInfoComment(*CPV);
977 /// printFunction - Print all aspects of a function.
979 void AssemblyWriter::printFunction(const Function *F) {
980 // Print out the return type and name...
983 // Ensure that no local symbols conflict with global symbols.
984 const_cast<Function*>(F)->renameLocalSymbols();
986 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
989 switch (F->getLinkage()) {
990 case GlobalValue::DLLImportLinkage: Out << "declare dllimport "; break;
991 case GlobalValue::ExternalWeakLinkage: Out << "declare extern_weak "; break;
992 default: Out << "declare ";
995 switch (F->getLinkage()) {
996 case GlobalValue::InternalLinkage: Out << "internal "; break;
997 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
998 case GlobalValue::WeakLinkage: Out << "weak "; break;
999 case GlobalValue::AppendingLinkage: Out << "appending "; break;
1000 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
1001 case GlobalValue::DLLExportLinkage: Out << "dllexport "; break;
1002 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
1003 case GlobalValue::ExternalLinkage: break;
1004 case GlobalValue::GhostLinkage:
1005 llvm_cerr << "GhostLinkage not allowed in AsmWriter!\n";
1009 // Print the calling convention.
1010 switch (F->getCallingConv()) {
1011 case CallingConv::C: break; // default
1012 case CallingConv::CSRet: Out << "csretcc "; break;
1013 case CallingConv::Fast: Out << "fastcc "; break;
1014 case CallingConv::Cold: Out << "coldcc "; break;
1015 case CallingConv::X86_StdCall: Out << "x86_stdcallcc "; break;
1016 case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
1017 default: Out << "cc" << F->getCallingConv() << " "; break;
1020 printType(F->getReturnType()) << ' ';
1021 if (!F->getName().empty())
1022 Out << getLLVMName(F->getName());
1026 Machine.incorporateFunction(F);
1028 // Loop over the arguments, printing them...
1029 const FunctionType *FT = F->getFunctionType();
1031 for(Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
1034 // Finish printing arguments...
1035 if (FT->isVarArg()) {
1036 if (FT->getNumParams()) Out << ", ";
1037 Out << "..."; // Output varargs portion of signature!
1041 if (F->hasSection())
1042 Out << " section \"" << F->getSection() << '"';
1043 if (F->getAlignment())
1044 Out << " align " << F->getAlignment();
1046 if (F->isExternal()) {
1051 // Output all of its basic blocks... for the function
1052 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1058 Machine.purgeFunction();
1061 /// printArgument - This member is called for every argument that is passed into
1062 /// the function. Simply print it out
1064 void AssemblyWriter::printArgument(const Argument *Arg) {
1065 // Insert commas as we go... the first arg doesn't get a comma
1066 if (Arg != Arg->getParent()->arg_begin()) Out << ", ";
1069 printType(Arg->getType());
1071 // Output name, if available...
1073 Out << ' ' << getLLVMName(Arg->getName());
1076 /// printBasicBlock - This member is called for each basic block in a method.
1078 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
1079 if (BB->hasName()) { // Print out the label if it exists...
1080 Out << "\n" << getLLVMName(BB->getName(), false) << ':';
1081 } else if (!BB->use_empty()) { // Don't print block # of no uses...
1082 Out << "\n; <label>:";
1083 int Slot = Machine.getSlot(BB);
1090 if (BB->getParent() == 0)
1091 Out << "\t\t; Error: Block without parent!";
1093 if (BB != &BB->getParent()->front()) { // Not the entry block?
1094 // Output predecessors for the block...
1096 pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
1099 Out << " No predecessors!";
1102 writeOperand(*PI, false, true);
1103 for (++PI; PI != PE; ++PI) {
1105 writeOperand(*PI, false, true);
1113 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
1115 // Output all of the instructions in the basic block...
1116 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1117 printInstruction(*I);
1119 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
1123 /// printInfoComment - Print a little comment after the instruction indicating
1124 /// which slot it occupies.
1126 void AssemblyWriter::printInfoComment(const Value &V) {
1127 if (V.getType() != Type::VoidTy) {
1129 printType(V.getType()) << '>';
1132 int SlotNum = Machine.getSlot(&V);
1136 Out << ':' << SlotNum; // Print out the def slot taken.
1138 Out << " [#uses=" << V.getNumUses() << ']'; // Output # uses
1142 // This member is called for each Instruction in a function..
1143 void AssemblyWriter::printInstruction(const Instruction &I) {
1144 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
1148 // Print out name if it exists...
1150 Out << getLLVMName(I.getName()) << " = ";
1152 // If this is a volatile load or store, print out the volatile marker.
1153 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
1154 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile())) {
1156 } else if (isa<CallInst>(I) && cast<CallInst>(I).isTailCall()) {
1157 // If this is a call, check if it's a tail call.
1161 // Print out the opcode...
1162 Out << I.getOpcodeName();
1164 // Print out the compare instruction predicates
1165 if (const FCmpInst *FCI = dyn_cast<FCmpInst>(&I)) {
1166 Out << " " << getPredicateText(FCI->getPredicate());
1167 } else if (const ICmpInst *ICI = dyn_cast<ICmpInst>(&I)) {
1168 Out << " " << getPredicateText(ICI->getPredicate());
1171 // Print out the type of the operands...
1172 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
1174 // Special case conditional branches to swizzle the condition out to the front
1175 if (isa<BranchInst>(I) && I.getNumOperands() > 1) {
1176 writeOperand(I.getOperand(2), true);
1178 writeOperand(Operand, true);
1180 writeOperand(I.getOperand(1), true);
1182 } else if (isa<SwitchInst>(I)) {
1183 // Special case switch statement to get formatting nice and correct...
1184 writeOperand(Operand , true); Out << ',';
1185 writeOperand(I.getOperand(1), true); Out << " [";
1187 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
1189 writeOperand(I.getOperand(op ), true); Out << ',';
1190 writeOperand(I.getOperand(op+1), true);
1193 } else if (isa<PHINode>(I)) {
1195 printType(I.getType());
1198 for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
1199 if (op) Out << ", ";
1201 writeOperand(I.getOperand(op ), false); Out << ',';
1202 writeOperand(I.getOperand(op+1), false); Out << " ]";
1204 } else if (isa<ReturnInst>(I) && !Operand) {
1206 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
1207 // Print the calling convention being used.
1208 switch (CI->getCallingConv()) {
1209 case CallingConv::C: break; // default
1210 case CallingConv::CSRet: Out << " csretcc"; break;
1211 case CallingConv::Fast: Out << " fastcc"; break;
1212 case CallingConv::Cold: Out << " coldcc"; break;
1213 case CallingConv::X86_StdCall: Out << "x86_stdcallcc "; break;
1214 case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
1215 default: Out << " cc" << CI->getCallingConv(); break;
1218 const PointerType *PTy = cast<PointerType>(Operand->getType());
1219 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1220 const Type *RetTy = FTy->getReturnType();
1222 // If possible, print out the short form of the call instruction. We can
1223 // only do this if the first argument is a pointer to a nonvararg function,
1224 // and if the return type is not a pointer to a function.
1226 if (!FTy->isVarArg() &&
1227 (!isa<PointerType>(RetTy) ||
1228 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1229 Out << ' '; printType(RetTy);
1230 writeOperand(Operand, false);
1232 writeOperand(Operand, true);
1235 if (CI->getNumOperands() > 1) writeOperand(CI->getOperand(1), true);
1236 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; ++op) {
1238 writeOperand(I.getOperand(op), true);
1242 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
1243 const PointerType *PTy = cast<PointerType>(Operand->getType());
1244 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1245 const Type *RetTy = FTy->getReturnType();
1247 // Print the calling convention being used.
1248 switch (II->getCallingConv()) {
1249 case CallingConv::C: break; // default
1250 case CallingConv::CSRet: Out << " csretcc"; break;
1251 case CallingConv::Fast: Out << " fastcc"; break;
1252 case CallingConv::Cold: Out << " coldcc"; break;
1253 case CallingConv::X86_StdCall: Out << "x86_stdcallcc "; break;
1254 case CallingConv::X86_FastCall: Out << "x86_fastcallcc "; break;
1255 default: Out << " cc" << II->getCallingConv(); break;
1258 // If possible, print out the short form of the invoke instruction. We can
1259 // only do this if the first argument is a pointer to a nonvararg function,
1260 // and if the return type is not a pointer to a function.
1262 if (!FTy->isVarArg() &&
1263 (!isa<PointerType>(RetTy) ||
1264 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1265 Out << ' '; printType(RetTy);
1266 writeOperand(Operand, false);
1268 writeOperand(Operand, true);
1272 if (I.getNumOperands() > 3) writeOperand(I.getOperand(3), true);
1273 for (unsigned op = 4, Eop = I.getNumOperands(); op < Eop; ++op) {
1275 writeOperand(I.getOperand(op), true);
1278 Out << " )\n\t\t\tto";
1279 writeOperand(II->getNormalDest(), true);
1281 writeOperand(II->getUnwindDest(), true);
1283 } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
1285 printType(AI->getType()->getElementType());
1286 if (AI->isArrayAllocation()) {
1288 writeOperand(AI->getArraySize(), true);
1290 if (AI->getAlignment()) {
1291 Out << ", align " << AI->getAlignment();
1293 } else if (isa<CastInst>(I)) {
1294 if (Operand) writeOperand(Operand, true); // Work with broken code
1296 printType(I.getType());
1297 } else if (isa<VAArgInst>(I)) {
1298 if (Operand) writeOperand(Operand, true); // Work with broken code
1300 printType(I.getType());
1301 } else if (Operand) { // Print the normal way...
1303 // PrintAllTypes - Instructions who have operands of all the same type
1304 // omit the type from all but the first operand. If the instruction has
1305 // different type operands (for example br), then they are all printed.
1306 bool PrintAllTypes = false;
1307 const Type *TheType = Operand->getType();
1309 // Shift Left & Right print both types even for Ubyte LHS, and select prints
1310 // types even if all operands are bools.
1311 if (isa<ShiftInst>(I) || isa<SelectInst>(I) || isa<StoreInst>(I) ||
1312 isa<ShuffleVectorInst>(I)) {
1313 PrintAllTypes = true;
1315 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
1316 Operand = I.getOperand(i);
1317 if (Operand->getType() != TheType) {
1318 PrintAllTypes = true; // We have differing types! Print them all!
1324 if (!PrintAllTypes) {
1329 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
1331 writeOperand(I.getOperand(i), PrintAllTypes);
1335 printInfoComment(I);
1340 //===----------------------------------------------------------------------===//
1341 // External Interface declarations
1342 //===----------------------------------------------------------------------===//
1344 void Module::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1345 SlotMachine SlotTable(this);
1346 AssemblyWriter W(o, SlotTable, this, AAW);
1350 void GlobalVariable::print(std::ostream &o) const {
1351 SlotMachine SlotTable(getParent());
1352 AssemblyWriter W(o, SlotTable, getParent(), 0);
1356 void Function::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1357 SlotMachine SlotTable(getParent());
1358 AssemblyWriter W(o, SlotTable, getParent(), AAW);
1363 void InlineAsm::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1364 WriteAsOperand(o, this, true, true, 0);
1367 void BasicBlock::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1368 SlotMachine SlotTable(getParent());
1369 AssemblyWriter W(o, SlotTable,
1370 getParent() ? getParent()->getParent() : 0, AAW);
1374 void Instruction::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1375 const Function *F = getParent() ? getParent()->getParent() : 0;
1376 SlotMachine SlotTable(F);
1377 AssemblyWriter W(o, SlotTable, F ? F->getParent() : 0, AAW);
1382 void Constant::print(std::ostream &o) const {
1383 if (this == 0) { o << "<null> constant value\n"; return; }
1385 o << ' ' << getType()->getDescription() << ' ';
1387 std::map<const Type *, std::string> TypeTable;
1388 WriteConstantInt(o, this, false, TypeTable, 0);
1391 void Type::print(std::ostream &o) const {
1395 o << getDescription();
1398 void Argument::print(std::ostream &o) const {
1399 WriteAsOperand(o, this, true, true,
1400 getParent() ? getParent()->getParent() : 0);
1403 // Value::dump - allow easy printing of Values from the debugger.
1404 // Located here because so much of the needed functionality is here.
1405 void Value::dump() const { print(std::cerr); llvm_cerr << '\n'; }
1407 // Type::dump - allow easy printing of Values from the debugger.
1408 // Located here because so much of the needed functionality is here.
1409 void Type::dump() const { print(std::cerr); llvm_cerr << '\n'; }
1411 //===----------------------------------------------------------------------===//
1412 // CachedWriter Class Implementation
1413 //===----------------------------------------------------------------------===//
1415 void CachedWriter::setModule(const Module *M) {
1416 delete SC; delete AW;
1418 SC = new SlotMachine(M );
1419 AW = new AssemblyWriter(Out, *SC, M, 0);
1425 CachedWriter::~CachedWriter() {
1430 CachedWriter &CachedWriter::operator<<(const Value &V) {
1431 assert(AW && SC && "CachedWriter does not have a current module!");
1432 if (const Instruction *I = dyn_cast<Instruction>(&V))
1434 else if (const BasicBlock *BB = dyn_cast<BasicBlock>(&V))
1436 else if (const Function *F = dyn_cast<Function>(&V))
1438 else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(&V))
1441 AW->writeOperand(&V, true, true);
1445 CachedWriter& CachedWriter::operator<<(const Type &Ty) {
1446 if (SymbolicTypes) {
1447 const Module *M = AW->getModule();
1448 if (M) WriteTypeSymbolic(Out, &Ty, M);
1455 //===----------------------------------------------------------------------===//
1456 //===-- SlotMachine Implementation
1457 //===----------------------------------------------------------------------===//
1460 #define SC_DEBUG(X) llvm_cerr << X
1465 // Module level constructor. Causes the contents of the Module (sans functions)
1466 // to be added to the slot table.
1467 SlotMachine::SlotMachine(const Module *M)
1468 : TheModule(M) ///< Saved for lazy initialization.
1470 , FunctionProcessed(false)
1478 // Function level constructor. Causes the contents of the Module and the one
1479 // function provided to be added to the slot table.
1480 SlotMachine::SlotMachine(const Function *F )
1481 : TheModule( F ? F->getParent() : 0 ) ///< Saved for lazy initialization
1482 , TheFunction(F) ///< Saved for lazy initialization
1483 , FunctionProcessed(false)
1491 inline void SlotMachine::initialize(void) {
1494 TheModule = 0; ///< Prevent re-processing next time we're called.
1496 if ( TheFunction && ! FunctionProcessed) {
1501 // Iterate through all the global variables, functions, and global
1502 // variable initializers and create slots for them.
1503 void SlotMachine::processModule() {
1504 SC_DEBUG("begin processModule!\n");
1506 // Add all of the global variables to the value table...
1507 for (Module::const_global_iterator I = TheModule->global_begin(), E = TheModule->global_end();
1511 // Add all the functions to the table
1512 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
1516 SC_DEBUG("end processModule!\n");
1520 // Process the arguments, basic blocks, and instructions of a function.
1521 void SlotMachine::processFunction() {
1522 SC_DEBUG("begin processFunction!\n");
1524 // Add all the function arguments
1525 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
1526 AE = TheFunction->arg_end(); AI != AE; ++AI)
1529 SC_DEBUG("Inserting Instructions:\n");
1531 // Add all of the basic blocks and instructions
1532 for (Function::const_iterator BB = TheFunction->begin(),
1533 E = TheFunction->end(); BB != E; ++BB) {
1535 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I!=E; ++I) {
1540 FunctionProcessed = true;
1542 SC_DEBUG("end processFunction!\n");
1545 // Clean up after incorporating a function. This is the only way
1546 // to get out of the function incorporation state that affects the
1547 // getSlot/createSlot lock. Function incorporation state is indicated
1548 // by TheFunction != 0.
1549 void SlotMachine::purgeFunction() {
1550 SC_DEBUG("begin purgeFunction!\n");
1551 fMap.clear(); // Simply discard the function level map
1554 FunctionProcessed = false;
1555 SC_DEBUG("end purgeFunction!\n");
1558 /// Get the slot number for a value. This function will assert if you
1559 /// ask for a Value that hasn't previously been inserted with createSlot.
1560 /// Types are forbidden because Type does not inherit from Value (any more).
1561 int SlotMachine::getSlot(const Value *V) {
1562 assert( V && "Can't get slot for null Value" );
1563 assert(!isa<Constant>(V) || isa<GlobalValue>(V) &&
1564 "Can't insert a non-GlobalValue Constant into SlotMachine");
1566 // Check for uninitialized state and do lazy initialization
1569 // Get the type of the value
1570 const Type* VTy = V->getType();
1572 // Find the type plane in the module map
1573 TypedPlanes::const_iterator MI = mMap.find(VTy);
1575 if ( TheFunction ) {
1576 // Lookup the type in the function map too
1577 TypedPlanes::const_iterator FI = fMap.find(VTy);
1578 // If there is a corresponding type plane in the function map
1579 if ( FI != fMap.end() ) {
1580 // Lookup the Value in the function map
1581 ValueMap::const_iterator FVI = FI->second.map.find(V);
1582 // If the value doesn't exist in the function map
1583 if ( FVI == FI->second.map.end() ) {
1584 // Look up the value in the module map.
1585 if (MI == mMap.end()) return -1;
1586 ValueMap::const_iterator MVI = MI->second.map.find(V);
1587 // If we didn't find it, it wasn't inserted
1588 if (MVI == MI->second.map.end()) return -1;
1589 assert( MVI != MI->second.map.end() && "Value not found");
1590 // We found it only at the module level
1593 // else the value exists in the function map
1595 // Return the slot number as the module's contribution to
1596 // the type plane plus the index in the function's contribution
1597 // to the type plane.
1598 if (MI != mMap.end())
1599 return MI->second.next_slot + FVI->second;
1606 // N.B. Can get here only if either !TheFunction or the function doesn't
1607 // have a corresponding type plane for the Value
1609 // Make sure the type plane exists
1610 if (MI == mMap.end()) return -1;
1611 // Lookup the value in the module's map
1612 ValueMap::const_iterator MVI = MI->second.map.find(V);
1613 // Make sure we found it.
1614 if (MVI == MI->second.map.end()) return -1;
1619 /// Get the slot number for a value. This function will assert if you
1620 /// ask for a Value that hasn't previously been inserted with createSlot.
1621 /// Types are forbidden because Type does not inherit from Value (any more).
1622 int SlotMachine::getSlot(const Type *Ty) {
1623 assert( Ty && "Can't get slot for null Type" );
1625 // Check for uninitialized state and do lazy initialization
1628 if ( TheFunction ) {
1629 // Lookup the Type in the function map
1630 TypeMap::const_iterator FTI = fTypes.map.find(Ty);
1631 // If the Type doesn't exist in the function map
1632 if ( FTI == fTypes.map.end() ) {
1633 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1634 // If we didn't find it, it wasn't inserted
1635 if (MTI == mTypes.map.end())
1637 // We found it only at the module level
1640 // else the value exists in the function map
1642 // Return the slot number as the module's contribution to
1643 // the type plane plus the index in the function's contribution
1644 // to the type plane.
1645 return mTypes.next_slot + FTI->second;
1649 // N.B. Can get here only if either !TheFunction
1651 // Lookup the value in the module's map
1652 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1653 // Make sure we found it.
1654 if (MTI == mTypes.map.end()) return -1;
1659 // Create a new slot, or return the existing slot if it is already
1660 // inserted. Note that the logic here parallels getSlot but instead
1661 // of asserting when the Value* isn't found, it inserts the value.
1662 unsigned SlotMachine::createSlot(const Value *V) {
1663 assert( V && "Can't insert a null Value to SlotMachine");
1664 assert(!isa<Constant>(V) || isa<GlobalValue>(V) &&
1665 "Can't insert a non-GlobalValue Constant into SlotMachine");
1667 const Type* VTy = V->getType();
1669 // Just ignore void typed things
1670 if (VTy == Type::VoidTy) return 0; // FIXME: Wrong return value!
1672 // Look up the type plane for the Value's type from the module map
1673 TypedPlanes::const_iterator MI = mMap.find(VTy);
1675 if ( TheFunction ) {
1676 // Get the type plane for the Value's type from the function map
1677 TypedPlanes::const_iterator FI = fMap.find(VTy);
1678 // If there is a corresponding type plane in the function map
1679 if ( FI != fMap.end() ) {
1680 // Lookup the Value in the function map
1681 ValueMap::const_iterator FVI = FI->second.map.find(V);
1682 // If the value doesn't exist in the function map
1683 if ( FVI == FI->second.map.end() ) {
1684 // If there is no corresponding type plane in the module map
1685 if ( MI == mMap.end() )
1686 return insertValue(V);
1687 // Look up the value in the module map
1688 ValueMap::const_iterator MVI = MI->second.map.find(V);
1689 // If we didn't find it, it wasn't inserted
1690 if ( MVI == MI->second.map.end() )
1691 return insertValue(V);
1693 // We found it only at the module level
1696 // else the value exists in the function map
1698 if ( MI == mMap.end() )
1701 // Return the slot number as the module's contribution to
1702 // the type plane plus the index in the function's contribution
1703 // to the type plane.
1704 return MI->second.next_slot + FVI->second;
1707 // else there is not a corresponding type plane in the function map
1709 // If the type plane doesn't exists at the module level
1710 if ( MI == mMap.end() ) {
1711 return insertValue(V);
1712 // else type plane exists at the module level, examine it
1714 // Look up the value in the module's map
1715 ValueMap::const_iterator MVI = MI->second.map.find(V);
1716 // If we didn't find it there either
1717 if ( MVI == MI->second.map.end() )
1718 // Return the slot number as the module's contribution to
1719 // the type plane plus the index of the function map insertion.
1720 return MI->second.next_slot + insertValue(V);
1727 // N.B. Can only get here if !TheFunction
1729 // If the module map's type plane is not for the Value's type
1730 if ( MI != mMap.end() ) {
1731 // Lookup the value in the module's map
1732 ValueMap::const_iterator MVI = MI->second.map.find(V);
1733 if ( MVI != MI->second.map.end() )
1737 return insertValue(V);
1740 // Create a new slot, or return the existing slot if it is already
1741 // inserted. Note that the logic here parallels getSlot but instead
1742 // of asserting when the Value* isn't found, it inserts the value.
1743 unsigned SlotMachine::createSlot(const Type *Ty) {
1744 assert( Ty && "Can't insert a null Type to SlotMachine");
1746 if ( TheFunction ) {
1747 // Lookup the Type in the function map
1748 TypeMap::const_iterator FTI = fTypes.map.find(Ty);
1749 // If the type doesn't exist in the function map
1750 if ( FTI == fTypes.map.end() ) {
1751 // Look up the type in the module map
1752 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1753 // If we didn't find it, it wasn't inserted
1754 if ( MTI == mTypes.map.end() )
1755 return insertValue(Ty);
1757 // We found it only at the module level
1760 // else the value exists in the function map
1762 // Return the slot number as the module's contribution to
1763 // the type plane plus the index in the function's contribution
1764 // to the type plane.
1765 return mTypes.next_slot + FTI->second;
1769 // N.B. Can only get here if !TheFunction
1771 // Lookup the type in the module's map
1772 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1773 if ( MTI != mTypes.map.end() )
1776 return insertValue(Ty);
1779 // Low level insert function. Minimal checking is done. This
1780 // function is just for the convenience of createSlot (above).
1781 unsigned SlotMachine::insertValue(const Value *V ) {
1782 assert(V && "Can't insert a null Value into SlotMachine!");
1783 assert(!isa<Constant>(V) || isa<GlobalValue>(V) &&
1784 "Can't insert a non-GlobalValue Constant into SlotMachine");
1786 // If this value does not contribute to a plane (is void)
1787 // or if the value already has a name then ignore it.
1788 if (V->getType() == Type::VoidTy || V->hasName() ) {
1789 SC_DEBUG("ignored value " << *V << "\n");
1790 return 0; // FIXME: Wrong return value
1793 const Type *VTy = V->getType();
1794 unsigned DestSlot = 0;
1796 if ( TheFunction ) {
1797 TypedPlanes::iterator I = fMap.find( VTy );
1798 if ( I == fMap.end() )
1799 I = fMap.insert(std::make_pair(VTy,ValuePlane())).first;
1800 DestSlot = I->second.map[V] = I->second.next_slot++;
1802 TypedPlanes::iterator I = mMap.find( VTy );
1803 if ( I == mMap.end() )
1804 I = mMap.insert(std::make_pair(VTy,ValuePlane())).first;
1805 DestSlot = I->second.map[V] = I->second.next_slot++;
1808 SC_DEBUG(" Inserting value [" << VTy << "] = " << V << " slot=" <<
1810 // G = Global, C = Constant, T = Type, F = Function, o = other
1811 SC_DEBUG((isa<GlobalVariable>(V) ? 'G' : (isa<Function>(V) ? 'F' :
1812 (isa<Constant>(V) ? 'C' : 'o'))));
1817 // Low level insert function. Minimal checking is done. This
1818 // function is just for the convenience of createSlot (above).
1819 unsigned SlotMachine::insertValue(const Type *Ty ) {
1820 assert(Ty && "Can't insert a null Type into SlotMachine!");
1822 unsigned DestSlot = 0;
1824 if ( TheFunction ) {
1825 DestSlot = fTypes.map[Ty] = fTypes.next_slot++;
1827 DestSlot = fTypes.map[Ty] = fTypes.next_slot++;
1829 SC_DEBUG(" Inserting type [" << DestSlot << "] = " << Ty << "\n");