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/Support/CFG.h"
30 #include "llvm/ADT/StringExtras.h"
31 #include "llvm/ADT/STLExtras.h"
32 #include "llvm/Support/MathExtras.h"
38 // Make virtual table appear in this compilation unit.
39 AssemblyAnnotationWriter::~AssemblyAnnotationWriter() {}
41 /// This class provides computation of slot numbers for LLVM Assembly writing.
42 /// @brief LLVM Assembly Writing Slot Computation.
49 /// @brief A mapping of Values to slot numbers
50 typedef std::map<const Value*, unsigned> ValueMap;
51 typedef std::map<const Type*, unsigned> TypeMap;
53 /// @brief A plane with next slot number and ValueMap
55 unsigned next_slot; ///< The next slot number to use
56 ValueMap map; ///< The map of Value* -> unsigned
57 ValuePlane() { next_slot = 0; } ///< Make sure we start at 0
63 TypePlane() { next_slot = 0; }
64 void clear() { map.clear(); next_slot = 0; }
67 /// @brief The map of planes by Type
68 typedef std::map<const Type*, ValuePlane> TypedPlanes;
71 /// @name Constructors
74 /// @brief Construct from a module
75 SlotMachine(const Module *M );
77 /// @brief Construct from a function, starting out in incorp state.
78 SlotMachine(const Function *F );
84 /// Return the slot number of the specified value in it's type
85 /// plane. Its an error to ask for something not in the SlotMachine.
86 /// Its an error to ask for a Type*
87 int getSlot(const Value *V);
88 int getSlot(const Type*Ty);
90 /// Determine if a Value has a slot or not
91 bool hasSlot(const Value* V);
92 bool hasSlot(const Type* Ty);
98 /// If you'd like to deal with a function instead of just a module, use
99 /// this method to get its data into the SlotMachine.
100 void incorporateFunction(const Function *F) {
102 FunctionProcessed = false;
105 /// After calling incorporateFunction, use this method to remove the
106 /// most recently incorporated function from the SlotMachine. This
107 /// will reset the state of the machine back to just the module contents.
108 void purgeFunction();
111 /// @name Implementation Details
114 /// This function does the actual initialization.
115 inline void initialize();
117 /// Values can be crammed into here at will. If they haven't
118 /// been inserted already, they get inserted, otherwise they are ignored.
119 /// Either way, the slot number for the Value* is returned.
120 unsigned createSlot(const Value *V);
121 unsigned createSlot(const Type* Ty);
123 /// Insert a value into the value table. Return the slot number
124 /// that it now occupies. BadThings(TM) will happen if you insert a
125 /// Value that's already been inserted.
126 unsigned insertValue( const Value *V );
127 unsigned insertValue( const Type* Ty);
129 /// Add all of the module level global variables (and their initializers)
130 /// and function declarations, but not the contents of those functions.
131 void processModule();
133 /// Add all of the functions arguments, basic blocks, and instructions
134 void processFunction();
136 SlotMachine(const SlotMachine &); // DO NOT IMPLEMENT
137 void operator=(const SlotMachine &); // DO NOT IMPLEMENT
144 /// @brief The module for which we are holding slot numbers
145 const Module* TheModule;
147 /// @brief The function for which we are holding slot numbers
148 const Function* TheFunction;
149 bool FunctionProcessed;
151 /// @brief The TypePlanes map for the module level data
155 /// @brief The TypePlanes map for the function level data
163 } // end namespace llvm
165 static RegisterPass<PrintModulePass>
166 X("printm", "Print module to stderr");
167 static RegisterPass<PrintFunctionPass>
168 Y("print","Print function to stderr");
170 static void WriteAsOperandInternal(std::ostream &Out, const Value *V,
172 std::map<const Type *, std::string> &TypeTable,
173 SlotMachine *Machine);
175 static void WriteAsOperandInternal(std::ostream &Out, const Type *T,
177 std::map<const Type *, std::string> &TypeTable,
178 SlotMachine *Machine);
180 static const Module *getModuleFromVal(const Value *V) {
181 if (const Argument *MA = dyn_cast<Argument>(V))
182 return MA->getParent() ? MA->getParent()->getParent() : 0;
183 else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
184 return BB->getParent() ? BB->getParent()->getParent() : 0;
185 else if (const Instruction *I = dyn_cast<Instruction>(V)) {
186 const Function *M = I->getParent() ? I->getParent()->getParent() : 0;
187 return M ? M->getParent() : 0;
188 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
189 return GV->getParent();
193 static SlotMachine *createSlotMachine(const Value *V) {
194 if (const Argument *FA = dyn_cast<Argument>(V)) {
195 return new SlotMachine(FA->getParent());
196 } else if (const Instruction *I = dyn_cast<Instruction>(V)) {
197 return new SlotMachine(I->getParent()->getParent());
198 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V)) {
199 return new SlotMachine(BB->getParent());
200 } else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V)){
201 return new SlotMachine(GV->getParent());
202 } else if (const Function *Func = dyn_cast<Function>(V)) {
203 return new SlotMachine(Func);
208 // getLLVMName - Turn the specified string into an 'LLVM name', which is either
209 // prefixed with % (if the string only contains simple characters) or is
210 // surrounded with ""'s (if it has special chars in it).
211 static std::string getLLVMName(const std::string &Name,
212 bool prefixName = true) {
213 assert(!Name.empty() && "Cannot get empty name!");
215 // First character cannot start with a number...
216 if (Name[0] >= '0' && Name[0] <= '9')
217 return "\"" + Name + "\"";
219 // Scan to see if we have any characters that are not on the "white list"
220 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
222 assert(C != '"' && "Illegal character in LLVM value name!");
223 if ((C < 'a' || C > 'z') && (C < 'A' || C > 'Z') && (C < '0' || C > '9') &&
224 C != '-' && C != '.' && C != '_')
225 return "\"" + Name + "\"";
228 // If we get here, then the identifier is legal to use as a "VarID".
236 /// fillTypeNameTable - If the module has a symbol table, take all global types
237 /// and stuff their names into the TypeNames map.
239 static void fillTypeNameTable(const Module *M,
240 std::map<const Type *, std::string> &TypeNames) {
242 const SymbolTable &ST = M->getSymbolTable();
243 SymbolTable::type_const_iterator TI = ST.type_begin();
244 for (; TI != ST.type_end(); ++TI ) {
245 // As a heuristic, don't insert pointer to primitive types, because
246 // they are used too often to have a single useful name.
248 const Type *Ty = cast<Type>(TI->second);
249 if (!isa<PointerType>(Ty) ||
250 !cast<PointerType>(Ty)->getElementType()->isPrimitiveType() ||
251 isa<OpaqueType>(cast<PointerType>(Ty)->getElementType()))
252 TypeNames.insert(std::make_pair(Ty, getLLVMName(TI->first)));
258 static void calcTypeName(const Type *Ty,
259 std::vector<const Type *> &TypeStack,
260 std::map<const Type *, std::string> &TypeNames,
261 std::string & Result){
262 if (Ty->isPrimitiveType() && !isa<OpaqueType>(Ty)) {
263 Result += Ty->getDescription(); // Base case
267 // Check to see if the type is named.
268 std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
269 if (I != TypeNames.end()) {
274 if (isa<OpaqueType>(Ty)) {
279 // Check to see if the Type is already on the stack...
280 unsigned Slot = 0, CurSize = TypeStack.size();
281 while (Slot < CurSize && TypeStack[Slot] != Ty) ++Slot; // Scan for type
283 // This is another base case for the recursion. In this case, we know
284 // that we have looped back to a type that we have previously visited.
285 // Generate the appropriate upreference to handle this.
286 if (Slot < CurSize) {
287 Result += "\\" + utostr(CurSize-Slot); // Here's the upreference
291 TypeStack.push_back(Ty); // Recursive case: Add us to the stack..
293 switch (Ty->getTypeID()) {
294 case Type::FunctionTyID: {
295 const FunctionType *FTy = cast<FunctionType>(Ty);
296 calcTypeName(FTy->getReturnType(), TypeStack, TypeNames, Result);
298 for (FunctionType::param_iterator I = FTy->param_begin(),
299 E = FTy->param_end(); I != E; ++I) {
300 if (I != FTy->param_begin())
302 calcTypeName(*I, TypeStack, TypeNames, Result);
304 if (FTy->isVarArg()) {
305 if (FTy->getNumParams()) Result += ", ";
311 case Type::StructTyID: {
312 const StructType *STy = cast<StructType>(Ty);
314 for (StructType::element_iterator I = STy->element_begin(),
315 E = STy->element_end(); I != E; ++I) {
316 if (I != STy->element_begin())
318 calcTypeName(*I, TypeStack, TypeNames, Result);
323 case Type::PointerTyID:
324 calcTypeName(cast<PointerType>(Ty)->getElementType(),
325 TypeStack, TypeNames, Result);
328 case Type::ArrayTyID: {
329 const ArrayType *ATy = cast<ArrayType>(Ty);
330 Result += "[" + utostr(ATy->getNumElements()) + " x ";
331 calcTypeName(ATy->getElementType(), TypeStack, TypeNames, Result);
335 case Type::PackedTyID: {
336 const PackedType *PTy = cast<PackedType>(Ty);
337 Result += "<" + utostr(PTy->getNumElements()) + " x ";
338 calcTypeName(PTy->getElementType(), TypeStack, TypeNames, Result);
342 case Type::OpaqueTyID:
346 Result += "<unrecognized-type>";
349 TypeStack.pop_back(); // Remove self from stack...
354 /// printTypeInt - The internal guts of printing out a type that has a
355 /// potentially named portion.
357 static std::ostream &printTypeInt(std::ostream &Out, const Type *Ty,
358 std::map<const Type *, std::string> &TypeNames) {
359 // Primitive types always print out their description, regardless of whether
360 // they have been named or not.
362 if (Ty->isPrimitiveType() && !isa<OpaqueType>(Ty))
363 return Out << Ty->getDescription();
365 // Check to see if the type is named.
366 std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
367 if (I != TypeNames.end()) return Out << I->second;
369 // Otherwise we have a type that has not been named but is a derived type.
370 // Carefully recurse the type hierarchy to print out any contained symbolic
373 std::vector<const Type *> TypeStack;
374 std::string TypeName;
375 calcTypeName(Ty, TypeStack, TypeNames, TypeName);
376 TypeNames.insert(std::make_pair(Ty, TypeName));//Cache type name for later use
377 return (Out << TypeName);
381 /// WriteTypeSymbolic - This attempts to write the specified type as a symbolic
382 /// type, iff there is an entry in the modules symbol table for the specified
383 /// type or one of it's component types. This is slower than a simple x << Type
385 std::ostream &llvm::WriteTypeSymbolic(std::ostream &Out, const Type *Ty,
389 // If they want us to print out a type, attempt to make it symbolic if there
390 // is a symbol table in the module...
392 std::map<const Type *, std::string> TypeNames;
393 fillTypeNameTable(M, TypeNames);
395 return printTypeInt(Out, Ty, TypeNames);
397 return Out << Ty->getDescription();
401 // PrintEscapedString - Print each character of the specified string, escaping
402 // it if it is not printable or if it is an escape char.
403 static void PrintEscapedString(const std::string &Str, std::ostream &Out) {
404 for (unsigned i = 0, e = Str.size(); i != e; ++i) {
405 unsigned char C = Str[i];
406 if (isprint(C) && C != '"' && C != '\\') {
410 << (char) ((C/16 < 10) ? ( C/16 +'0') : ( C/16 -10+'A'))
411 << (char)(((C&15) < 10) ? ((C&15)+'0') : ((C&15)-10+'A'));
416 /// @brief Internal constant writer.
417 static void WriteConstantInt(std::ostream &Out, const Constant *CV,
419 std::map<const Type *, std::string> &TypeTable,
420 SlotMachine *Machine) {
421 const int IndentSize = 4;
422 static std::string Indent = "\n";
423 if (const ConstantBool *CB = dyn_cast<ConstantBool>(CV)) {
424 Out << (CB == ConstantBool::True ? "true" : "false");
425 } else if (const ConstantSInt *CI = dyn_cast<ConstantSInt>(CV)) {
426 Out << CI->getValue();
427 } else if (const ConstantUInt *CI = dyn_cast<ConstantUInt>(CV)) {
428 Out << CI->getValue();
429 } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
430 // We would like to output the FP constant value in exponential notation,
431 // but we cannot do this if doing so will lose precision. Check here to
432 // make sure that we only output it in exponential format if we can parse
433 // the value back and get the same value.
435 std::string StrVal = ftostr(CFP->getValue());
437 // Check to make sure that the stringized number is not some string like
438 // "Inf" or NaN, that atof will accept, but the lexer will not. Check that
439 // the string matches the "[-+]?[0-9]" regex.
441 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
442 ((StrVal[0] == '-' || StrVal[0] == '+') &&
443 (StrVal[1] >= '0' && StrVal[1] <= '9')))
444 // Reparse stringized version!
445 if (atof(StrVal.c_str()) == CFP->getValue()) {
450 // Otherwise we could not reparse it to exactly the same value, so we must
451 // output the string in hexadecimal format!
452 assert(sizeof(double) == sizeof(uint64_t) &&
453 "assuming that double is 64 bits!");
454 Out << "0x" << utohexstr(DoubleToBits(CFP->getValue()));
456 } else if (isa<ConstantAggregateZero>(CV)) {
457 Out << "zeroinitializer";
458 } else if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
459 // As a special case, print the array as a string if it is an array of
460 // ubytes or an array of sbytes with positive values.
462 const Type *ETy = CA->getType()->getElementType();
463 if (CA->isString()) {
465 PrintEscapedString(CA->getAsString(), Out);
468 } else { // Cannot output in string format...
470 if (CA->getNumOperands()) {
472 printTypeInt(Out, ETy, TypeTable);
473 WriteAsOperandInternal(Out, CA->getOperand(0),
474 PrintName, TypeTable, Machine);
475 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
477 printTypeInt(Out, ETy, TypeTable);
478 WriteAsOperandInternal(Out, CA->getOperand(i), PrintName,
484 } else if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
486 unsigned N = CS->getNumOperands();
489 Indent += std::string(IndentSize, ' ');
494 printTypeInt(Out, CS->getOperand(0)->getType(), TypeTable);
496 WriteAsOperandInternal(Out, CS->getOperand(0),
497 PrintName, TypeTable, Machine);
499 for (unsigned i = 1; i < N; i++) {
501 if (N > 2) Out << Indent;
502 printTypeInt(Out, CS->getOperand(i)->getType(), TypeTable);
504 WriteAsOperandInternal(Out, CS->getOperand(i),
505 PrintName, TypeTable, Machine);
507 if (N > 2) Indent.resize(Indent.size() - IndentSize);
511 } else if (const ConstantPacked *CP = dyn_cast<ConstantPacked>(CV)) {
512 const Type *ETy = CP->getType()->getElementType();
513 assert(CP->getNumOperands() > 0 &&
514 "Number of operands for a PackedConst must be > 0");
517 printTypeInt(Out, ETy, TypeTable);
518 WriteAsOperandInternal(Out, CP->getOperand(0),
519 PrintName, TypeTable, Machine);
520 for (unsigned i = 1, e = CP->getNumOperands(); i != e; ++i) {
522 printTypeInt(Out, ETy, TypeTable);
523 WriteAsOperandInternal(Out, CP->getOperand(i), PrintName,
527 } else if (isa<ConstantPointerNull>(CV)) {
530 } else if (isa<UndefValue>(CV)) {
533 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
534 Out << CE->getOpcodeName() << " (";
536 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
537 printTypeInt(Out, (*OI)->getType(), TypeTable);
538 WriteAsOperandInternal(Out, *OI, PrintName, TypeTable, Machine);
539 if (OI+1 != CE->op_end())
543 if (CE->getOpcode() == Instruction::Cast) {
545 printTypeInt(Out, CE->getType(), TypeTable);
550 Out << "<placeholder or erroneous Constant>";
555 /// WriteAsOperand - Write the name of the specified value out to the specified
556 /// ostream. This can be useful when you just want to print int %reg126, not
557 /// the whole instruction that generated it.
559 static void WriteAsOperandInternal(std::ostream &Out, const Value *V,
561 std::map<const Type*, std::string> &TypeTable,
562 SlotMachine *Machine) {
564 if ((PrintName || isa<GlobalValue>(V)) && V->hasName())
565 Out << getLLVMName(V->getName());
567 const Constant *CV = dyn_cast<Constant>(V);
568 if (CV && !isa<GlobalValue>(CV)) {
569 WriteConstantInt(Out, CV, PrintName, TypeTable, Machine);
570 } else if (const InlineAsm *IA = dyn_cast<InlineAsm>(V)) {
572 if (IA->hasSideEffects())
573 Out << "sideeffect ";
575 PrintEscapedString(IA->getAsmString(), Out);
577 PrintEscapedString(IA->getConstraintString(), Out);
582 Slot = Machine->getSlot(V);
584 Machine = createSlotMachine(V);
586 Slot = Machine->getSlot(V);
599 /// WriteAsOperand - Write the name of the specified value out to the specified
600 /// ostream. This can be useful when you just want to print int %reg126, not
601 /// the whole instruction that generated it.
603 std::ostream &llvm::WriteAsOperand(std::ostream &Out, const Value *V,
604 bool PrintType, bool PrintName,
605 const Module *Context) {
606 std::map<const Type *, std::string> TypeNames;
607 if (Context == 0) Context = getModuleFromVal(V);
610 fillTypeNameTable(Context, TypeNames);
613 printTypeInt(Out, V->getType(), TypeNames);
615 WriteAsOperandInternal(Out, V, PrintName, TypeNames, 0);
619 /// WriteAsOperandInternal - Write the name of the specified value out to
620 /// the specified ostream. This can be useful when you just want to print
621 /// int %reg126, not the whole instruction that generated it.
623 static void WriteAsOperandInternal(std::ostream &Out, const Type *T,
625 std::map<const Type*, std::string> &TypeTable,
626 SlotMachine *Machine) {
630 Slot = Machine->getSlot(T);
636 Out << T->getDescription();
640 /// WriteAsOperand - Write the name of the specified value out to the specified
641 /// ostream. This can be useful when you just want to print int %reg126, not
642 /// the whole instruction that generated it.
644 std::ostream &llvm::WriteAsOperand(std::ostream &Out, const Type *Ty,
645 bool PrintType, bool PrintName,
646 const Module *Context) {
647 std::map<const Type *, std::string> TypeNames;
648 assert(Context != 0 && "Can't write types as operand without module context");
650 fillTypeNameTable(Context, TypeNames);
653 // printTypeInt(Out, V->getType(), TypeNames);
655 printTypeInt(Out, Ty, TypeNames);
657 WriteAsOperandInternal(Out, Ty, PrintName, TypeNames, 0);
663 class AssemblyWriter {
665 SlotMachine &Machine;
666 const Module *TheModule;
667 std::map<const Type *, std::string> TypeNames;
668 AssemblyAnnotationWriter *AnnotationWriter;
670 inline AssemblyWriter(std::ostream &o, SlotMachine &Mac, const Module *M,
671 AssemblyAnnotationWriter *AAW)
672 : Out(o), Machine(Mac), TheModule(M), AnnotationWriter(AAW) {
674 // If the module has a symbol table, take all global types and stuff their
675 // names into the TypeNames map.
677 fillTypeNameTable(M, TypeNames);
680 inline void write(const Module *M) { printModule(M); }
681 inline void write(const GlobalVariable *G) { printGlobal(G); }
682 inline void write(const Function *F) { printFunction(F); }
683 inline void write(const BasicBlock *BB) { printBasicBlock(BB); }
684 inline void write(const Instruction *I) { printInstruction(*I); }
685 inline void write(const Constant *CPV) { printConstant(CPV); }
686 inline void write(const Type *Ty) { printType(Ty); }
688 void writeOperand(const Value *Op, bool PrintType, bool PrintName = true);
690 const Module* getModule() { return TheModule; }
693 void printModule(const Module *M);
694 void printSymbolTable(const SymbolTable &ST);
695 void printConstant(const Constant *CPV);
696 void printGlobal(const GlobalVariable *GV);
697 void printFunction(const Function *F);
698 void printArgument(const Argument *FA);
699 void printBasicBlock(const BasicBlock *BB);
700 void printInstruction(const Instruction &I);
702 // printType - Go to extreme measures to attempt to print out a short,
703 // symbolic version of a type name.
705 std::ostream &printType(const Type *Ty) {
706 return printTypeInt(Out, Ty, TypeNames);
709 // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
710 // without considering any symbolic types that we may have equal to it.
712 std::ostream &printTypeAtLeastOneLevel(const Type *Ty);
714 // printInfoComment - Print a little comment after the instruction indicating
715 // which slot it occupies.
716 void printInfoComment(const Value &V);
718 } // end of llvm namespace
720 /// printTypeAtLeastOneLevel - Print out one level of the possibly complex type
721 /// without considering any symbolic types that we may have equal to it.
723 std::ostream &AssemblyWriter::printTypeAtLeastOneLevel(const Type *Ty) {
724 if (const FunctionType *FTy = dyn_cast<FunctionType>(Ty)) {
725 printType(FTy->getReturnType()) << " (";
726 for (FunctionType::param_iterator I = FTy->param_begin(),
727 E = FTy->param_end(); I != E; ++I) {
728 if (I != FTy->param_begin())
732 if (FTy->isVarArg()) {
733 if (FTy->getNumParams()) Out << ", ";
737 } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
739 for (StructType::element_iterator I = STy->element_begin(),
740 E = STy->element_end(); I != E; ++I) {
741 if (I != STy->element_begin())
746 } else if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
747 printType(PTy->getElementType()) << '*';
748 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
749 Out << '[' << ATy->getNumElements() << " x ";
750 printType(ATy->getElementType()) << ']';
751 } else if (const PackedType *PTy = dyn_cast<PackedType>(Ty)) {
752 Out << '<' << PTy->getNumElements() << " x ";
753 printType(PTy->getElementType()) << '>';
755 else if (const OpaqueType *OTy = dyn_cast<OpaqueType>(Ty)) {
758 if (!Ty->isPrimitiveType())
759 Out << "<unknown derived type>";
766 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType,
769 if (PrintType) { Out << ' '; printType(Operand->getType()); }
770 WriteAsOperandInternal(Out, Operand, PrintName, TypeNames, &Machine);
772 Out << "<null operand!>";
777 void AssemblyWriter::printModule(const Module *M) {
778 if (!M->getModuleIdentifier().empty() &&
779 // Don't print the ID if it will start a new line (which would
780 // require a comment char before it).
781 M->getModuleIdentifier().find('\n') == std::string::npos)
782 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
784 switch (M->getEndianness()) {
785 case Module::LittleEndian: Out << "target endian = little\n"; break;
786 case Module::BigEndian: Out << "target endian = big\n"; break;
787 case Module::AnyEndianness: break;
789 switch (M->getPointerSize()) {
790 case Module::Pointer32: Out << "target pointersize = 32\n"; break;
791 case Module::Pointer64: Out << "target pointersize = 64\n"; break;
792 case Module::AnyPointerSize: break;
794 if (!M->getTargetTriple().empty())
795 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
797 if (!M->getModuleInlineAsm().empty()) {
798 // Split the string into lines, to make it easier to read the .ll file.
799 std::string Asm = M->getModuleInlineAsm();
801 size_t NewLine = Asm.find_first_of('\n', CurPos);
802 while (NewLine != std::string::npos) {
803 // We found a newline, print the portion of the asm string from the
804 // last newline up to this newline.
805 Out << "module asm \"";
806 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
810 NewLine = Asm.find_first_of('\n', CurPos);
812 Out << "module asm \"";
813 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.end()), Out);
817 // Loop over the dependent libraries and emit them.
818 Module::lib_iterator LI = M->lib_begin();
819 Module::lib_iterator LE = M->lib_end();
821 Out << "deplibs = [ ";
823 Out << '"' << *LI << '"';
831 // Loop over the symbol table, emitting all named constants.
832 printSymbolTable(M->getSymbolTable());
834 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end(); I != E; ++I)
837 Out << "\nimplementation ; Functions:\n";
839 // Output all of the functions.
840 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
844 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
845 if (GV->hasName()) Out << getLLVMName(GV->getName()) << " = ";
847 if (!GV->hasInitializer())
850 switch (GV->getLinkage()) {
851 case GlobalValue::InternalLinkage: Out << "internal "; break;
852 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
853 case GlobalValue::WeakLinkage: Out << "weak "; break;
854 case GlobalValue::AppendingLinkage: Out << "appending "; break;
855 case GlobalValue::ExternalLinkage: break;
856 case GlobalValue::GhostLinkage:
857 std::cerr << "GhostLinkage not allowed in AsmWriter!\n";
861 Out << (GV->isConstant() ? "constant " : "global ");
862 printType(GV->getType()->getElementType());
864 if (GV->hasInitializer()) {
865 Constant* C = cast<Constant>(GV->getInitializer());
866 assert(C && "GlobalVar initializer isn't constant?");
867 writeOperand(GV->getInitializer(), false, isa<GlobalValue>(C));
870 if (GV->hasSection())
871 Out << ", section \"" << GV->getSection() << '"';
872 if (GV->getAlignment())
873 Out << ", align " << GV->getAlignment();
875 printInfoComment(*GV);
880 // printSymbolTable - Run through symbol table looking for constants
881 // and types. Emit their declarations.
882 void AssemblyWriter::printSymbolTable(const SymbolTable &ST) {
885 for (SymbolTable::type_const_iterator TI = ST.type_begin();
886 TI != ST.type_end(); ++TI ) {
887 Out << "\t" << getLLVMName(TI->first) << " = type ";
889 // Make sure we print out at least one level of the type structure, so
890 // that we do not get %FILE = type %FILE
892 printTypeAtLeastOneLevel(TI->second) << "\n";
895 // Print the constants, in type plane order.
896 for (SymbolTable::plane_const_iterator PI = ST.plane_begin();
897 PI != ST.plane_end(); ++PI ) {
898 SymbolTable::value_const_iterator VI = ST.value_begin(PI->first);
899 SymbolTable::value_const_iterator VE = ST.value_end(PI->first);
901 for (; VI != VE; ++VI) {
902 const Value* V = VI->second;
903 const Constant *CPV = dyn_cast<Constant>(V) ;
904 if (CPV && !isa<GlobalValue>(V)) {
912 /// printConstant - Print out a constant pool entry...
914 void AssemblyWriter::printConstant(const Constant *CPV) {
915 // Don't print out unnamed constants, they will be inlined
916 if (!CPV->hasName()) return;
919 Out << "\t" << getLLVMName(CPV->getName()) << " =";
921 // Write the value out now...
922 writeOperand(CPV, true, false);
924 printInfoComment(*CPV);
928 /// printFunction - Print all aspects of a function.
930 void AssemblyWriter::printFunction(const Function *F) {
931 // Print out the return type and name...
934 // Ensure that no local symbols conflict with global symbols.
935 const_cast<Function*>(F)->renameLocalSymbols();
937 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
942 switch (F->getLinkage()) {
943 case GlobalValue::InternalLinkage: Out << "internal "; break;
944 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
945 case GlobalValue::WeakLinkage: Out << "weak "; break;
946 case GlobalValue::AppendingLinkage: Out << "appending "; break;
947 case GlobalValue::ExternalLinkage: break;
948 case GlobalValue::GhostLinkage:
949 std::cerr << "GhostLinkage not allowed in AsmWriter!\n";
953 // Print the calling convention.
954 switch (F->getCallingConv()) {
955 case CallingConv::C: break; // default
956 case CallingConv::CSRet: Out << "csretcc "; break;
957 case CallingConv::Fast: Out << "fastcc "; break;
958 case CallingConv::Cold: Out << "coldcc "; break;
959 default: Out << "cc" << F->getCallingConv() << " "; break;
962 printType(F->getReturnType()) << ' ';
963 if (!F->getName().empty())
964 Out << getLLVMName(F->getName());
968 Machine.incorporateFunction(F);
970 // Loop over the arguments, printing them...
971 const FunctionType *FT = F->getFunctionType();
973 for(Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
976 // Finish printing arguments...
977 if (FT->isVarArg()) {
978 if (FT->getNumParams()) Out << ", ";
979 Out << "..."; // Output varargs portion of signature!
984 Out << " section \"" << F->getSection() << '"';
985 if (F->getAlignment())
986 Out << " align " << F->getAlignment();
988 if (F->isExternal()) {
993 // Output all of its basic blocks... for the function
994 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1000 Machine.purgeFunction();
1003 /// printArgument - This member is called for every argument that is passed into
1004 /// the function. Simply print it out
1006 void AssemblyWriter::printArgument(const Argument *Arg) {
1007 // Insert commas as we go... the first arg doesn't get a comma
1008 if (Arg != Arg->getParent()->arg_begin()) Out << ", ";
1011 printType(Arg->getType());
1013 // Output name, if available...
1015 Out << ' ' << getLLVMName(Arg->getName());
1018 /// printBasicBlock - This member is called for each basic block in a method.
1020 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
1021 if (BB->hasName()) { // Print out the label if it exists...
1022 Out << "\n" << getLLVMName(BB->getName(), false) << ':';
1023 } else if (!BB->use_empty()) { // Don't print block # of no uses...
1024 Out << "\n; <label>:";
1025 int Slot = Machine.getSlot(BB);
1032 if (BB->getParent() == 0)
1033 Out << "\t\t; Error: Block without parent!";
1035 if (BB != &BB->getParent()->front()) { // Not the entry block?
1036 // Output predecessors for the block...
1038 pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
1041 Out << " No predecessors!";
1044 writeOperand(*PI, false, true);
1045 for (++PI; PI != PE; ++PI) {
1047 writeOperand(*PI, false, true);
1055 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
1057 // Output all of the instructions in the basic block...
1058 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1059 printInstruction(*I);
1061 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
1065 /// printInfoComment - Print a little comment after the instruction indicating
1066 /// which slot it occupies.
1068 void AssemblyWriter::printInfoComment(const Value &V) {
1069 if (V.getType() != Type::VoidTy) {
1071 printType(V.getType()) << '>';
1074 int SlotNum = Machine.getSlot(&V);
1078 Out << ':' << SlotNum; // Print out the def slot taken.
1080 Out << " [#uses=" << V.getNumUses() << ']'; // Output # uses
1084 // This member is called for each Instruction in a function..
1085 void AssemblyWriter::printInstruction(const Instruction &I) {
1086 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
1090 // Print out name if it exists...
1092 Out << getLLVMName(I.getName()) << " = ";
1094 // If this is a volatile load or store, print out the volatile marker.
1095 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
1096 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile())) {
1098 } else if (isa<CallInst>(I) && cast<CallInst>(I).isTailCall()) {
1099 // If this is a call, check if it's a tail call.
1103 // Print out the opcode...
1104 Out << I.getOpcodeName();
1106 // Print out the type of the operands...
1107 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
1109 // Special case conditional branches to swizzle the condition out to the front
1110 if (isa<BranchInst>(I) && I.getNumOperands() > 1) {
1111 writeOperand(I.getOperand(2), true);
1113 writeOperand(Operand, true);
1115 writeOperand(I.getOperand(1), true);
1117 } else if (isa<SwitchInst>(I)) {
1118 // Special case switch statement to get formatting nice and correct...
1119 writeOperand(Operand , true); Out << ',';
1120 writeOperand(I.getOperand(1), true); Out << " [";
1122 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
1124 writeOperand(I.getOperand(op ), true); Out << ',';
1125 writeOperand(I.getOperand(op+1), true);
1128 } else if (isa<PHINode>(I)) {
1130 printType(I.getType());
1133 for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
1134 if (op) Out << ", ";
1136 writeOperand(I.getOperand(op ), false); Out << ',';
1137 writeOperand(I.getOperand(op+1), false); Out << " ]";
1139 } else if (isa<ReturnInst>(I) && !Operand) {
1141 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
1142 // Print the calling convention being used.
1143 switch (CI->getCallingConv()) {
1144 case CallingConv::C: break; // default
1145 case CallingConv::CSRet: Out << " csretcc"; break;
1146 case CallingConv::Fast: Out << " fastcc"; break;
1147 case CallingConv::Cold: Out << " coldcc"; break;
1148 default: Out << " cc" << CI->getCallingConv(); break;
1151 const PointerType *PTy = cast<PointerType>(Operand->getType());
1152 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1153 const Type *RetTy = FTy->getReturnType();
1155 // If possible, print out the short form of the call instruction. We can
1156 // only do this if the first argument is a pointer to a nonvararg function,
1157 // and if the return type is not a pointer to a function.
1159 if (!FTy->isVarArg() &&
1160 (!isa<PointerType>(RetTy) ||
1161 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1162 Out << ' '; printType(RetTy);
1163 writeOperand(Operand, false);
1165 writeOperand(Operand, true);
1168 if (CI->getNumOperands() > 1) writeOperand(CI->getOperand(1), true);
1169 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; ++op) {
1171 writeOperand(I.getOperand(op), true);
1175 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
1176 const PointerType *PTy = cast<PointerType>(Operand->getType());
1177 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1178 const Type *RetTy = FTy->getReturnType();
1180 // Print the calling convention being used.
1181 switch (II->getCallingConv()) {
1182 case CallingConv::C: break; // default
1183 case CallingConv::CSRet: Out << " csretcc"; break;
1184 case CallingConv::Fast: Out << " fastcc"; break;
1185 case CallingConv::Cold: Out << " coldcc"; break;
1186 default: Out << " cc" << II->getCallingConv(); break;
1189 // If possible, print out the short form of the invoke instruction. We can
1190 // only do this if the first argument is a pointer to a nonvararg function,
1191 // and if the return type is not a pointer to a function.
1193 if (!FTy->isVarArg() &&
1194 (!isa<PointerType>(RetTy) ||
1195 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1196 Out << ' '; printType(RetTy);
1197 writeOperand(Operand, false);
1199 writeOperand(Operand, true);
1203 if (I.getNumOperands() > 3) writeOperand(I.getOperand(3), true);
1204 for (unsigned op = 4, Eop = I.getNumOperands(); op < Eop; ++op) {
1206 writeOperand(I.getOperand(op), true);
1209 Out << " )\n\t\t\tto";
1210 writeOperand(II->getNormalDest(), true);
1212 writeOperand(II->getUnwindDest(), true);
1214 } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
1216 printType(AI->getType()->getElementType());
1217 if (AI->isArrayAllocation()) {
1219 writeOperand(AI->getArraySize(), true);
1221 if (AI->getAlignment()) {
1222 Out << ", align " << AI->getAlignment();
1224 } else if (isa<CastInst>(I)) {
1225 if (Operand) writeOperand(Operand, true); // Work with broken code
1227 printType(I.getType());
1228 } else if (isa<VAArgInst>(I)) {
1229 if (Operand) writeOperand(Operand, true); // Work with broken code
1231 printType(I.getType());
1232 } else if (Operand) { // Print the normal way...
1234 // PrintAllTypes - Instructions who have operands of all the same type
1235 // omit the type from all but the first operand. If the instruction has
1236 // different type operands (for example br), then they are all printed.
1237 bool PrintAllTypes = false;
1238 const Type *TheType = Operand->getType();
1240 // Shift Left & Right print both types even for Ubyte LHS, and select prints
1241 // types even if all operands are bools.
1242 if (isa<ShiftInst>(I) || isa<SelectInst>(I) || isa<StoreInst>(I) ||
1243 isa<ShuffleVectorInst>(I)) {
1244 PrintAllTypes = true;
1246 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
1247 Operand = I.getOperand(i);
1248 if (Operand->getType() != TheType) {
1249 PrintAllTypes = true; // We have differing types! Print them all!
1255 if (!PrintAllTypes) {
1260 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
1262 writeOperand(I.getOperand(i), PrintAllTypes);
1266 printInfoComment(I);
1271 //===----------------------------------------------------------------------===//
1272 // External Interface declarations
1273 //===----------------------------------------------------------------------===//
1275 void Module::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1276 SlotMachine SlotTable(this);
1277 AssemblyWriter W(o, SlotTable, this, AAW);
1281 void GlobalVariable::print(std::ostream &o) const {
1282 SlotMachine SlotTable(getParent());
1283 AssemblyWriter W(o, SlotTable, getParent(), 0);
1287 void Function::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1288 SlotMachine SlotTable(getParent());
1289 AssemblyWriter W(o, SlotTable, getParent(), AAW);
1294 void InlineAsm::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1295 WriteAsOperand(o, this, true, true, 0);
1298 void BasicBlock::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1299 SlotMachine SlotTable(getParent());
1300 AssemblyWriter W(o, SlotTable,
1301 getParent() ? getParent()->getParent() : 0, AAW);
1305 void Instruction::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1306 const Function *F = getParent() ? getParent()->getParent() : 0;
1307 SlotMachine SlotTable(F);
1308 AssemblyWriter W(o, SlotTable, F ? F->getParent() : 0, AAW);
1313 void Constant::print(std::ostream &o) const {
1314 if (this == 0) { o << "<null> constant value\n"; return; }
1316 o << ' ' << getType()->getDescription() << ' ';
1318 std::map<const Type *, std::string> TypeTable;
1319 WriteConstantInt(o, this, false, TypeTable, 0);
1322 void Type::print(std::ostream &o) const {
1326 o << getDescription();
1329 void Argument::print(std::ostream &o) const {
1330 WriteAsOperand(o, this, true, true,
1331 getParent() ? getParent()->getParent() : 0);
1334 // Value::dump - allow easy printing of Values from the debugger.
1335 // Located here because so much of the needed functionality is here.
1336 void Value::dump() const { print(std::cerr); }
1338 // Type::dump - allow easy printing of Values from the debugger.
1339 // Located here because so much of the needed functionality is here.
1340 void Type::dump() const { print(std::cerr); }
1342 //===----------------------------------------------------------------------===//
1343 // CachedWriter Class Implementation
1344 //===----------------------------------------------------------------------===//
1346 void CachedWriter::setModule(const Module *M) {
1347 delete SC; delete AW;
1349 SC = new SlotMachine(M );
1350 AW = new AssemblyWriter(Out, *SC, M, 0);
1356 CachedWriter::~CachedWriter() {
1361 CachedWriter &CachedWriter::operator<<(const Value &V) {
1362 assert(AW && SC && "CachedWriter does not have a current module!");
1363 if (const Instruction *I = dyn_cast<Instruction>(&V))
1365 else if (const BasicBlock *BB = dyn_cast<BasicBlock>(&V))
1367 else if (const Function *F = dyn_cast<Function>(&V))
1369 else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(&V))
1372 AW->writeOperand(&V, true, true);
1376 CachedWriter& CachedWriter::operator<<(const Type &Ty) {
1377 if (SymbolicTypes) {
1378 const Module *M = AW->getModule();
1379 if (M) WriteTypeSymbolic(Out, &Ty, M);
1386 //===----------------------------------------------------------------------===//
1387 //===-- SlotMachine Implementation
1388 //===----------------------------------------------------------------------===//
1391 #define SC_DEBUG(X) std::cerr << X
1396 // Module level constructor. Causes the contents of the Module (sans functions)
1397 // to be added to the slot table.
1398 SlotMachine::SlotMachine(const Module *M)
1399 : TheModule(M) ///< Saved for lazy initialization.
1401 , FunctionProcessed(false)
1409 // Function level constructor. Causes the contents of the Module and the one
1410 // function provided to be added to the slot table.
1411 SlotMachine::SlotMachine(const Function *F )
1412 : TheModule( F ? F->getParent() : 0 ) ///< Saved for lazy initialization
1413 , TheFunction(F) ///< Saved for lazy initialization
1414 , FunctionProcessed(false)
1422 inline void SlotMachine::initialize(void) {
1425 TheModule = 0; ///< Prevent re-processing next time we're called.
1427 if ( TheFunction && ! FunctionProcessed) {
1432 // Iterate through all the global variables, functions, and global
1433 // variable initializers and create slots for them.
1434 void SlotMachine::processModule() {
1435 SC_DEBUG("begin processModule!\n");
1437 // Add all of the global variables to the value table...
1438 for (Module::const_global_iterator I = TheModule->global_begin(), E = TheModule->global_end();
1442 // Add all the functions to the table
1443 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
1447 SC_DEBUG("end processModule!\n");
1451 // Process the arguments, basic blocks, and instructions of a function.
1452 void SlotMachine::processFunction() {
1453 SC_DEBUG("begin processFunction!\n");
1455 // Add all the function arguments
1456 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
1457 AE = TheFunction->arg_end(); AI != AE; ++AI)
1460 SC_DEBUG("Inserting Instructions:\n");
1462 // Add all of the basic blocks and instructions
1463 for (Function::const_iterator BB = TheFunction->begin(),
1464 E = TheFunction->end(); BB != E; ++BB) {
1466 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I!=E; ++I) {
1471 FunctionProcessed = true;
1473 SC_DEBUG("end processFunction!\n");
1476 // Clean up after incorporating a function. This is the only way
1477 // to get out of the function incorporation state that affects the
1478 // getSlot/createSlot lock. Function incorporation state is indicated
1479 // by TheFunction != 0.
1480 void SlotMachine::purgeFunction() {
1481 SC_DEBUG("begin purgeFunction!\n");
1482 fMap.clear(); // Simply discard the function level map
1485 FunctionProcessed = false;
1486 SC_DEBUG("end purgeFunction!\n");
1489 /// Get the slot number for a value. This function will assert if you
1490 /// ask for a Value that hasn't previously been inserted with createSlot.
1491 /// Types are forbidden because Type does not inherit from Value (any more).
1492 int SlotMachine::getSlot(const Value *V) {
1493 assert( V && "Can't get slot for null Value" );
1494 assert(!isa<Constant>(V) || isa<GlobalValue>(V) &&
1495 "Can't insert a non-GlobalValue Constant into SlotMachine");
1497 // Check for uninitialized state and do lazy initialization
1500 // Get the type of the value
1501 const Type* VTy = V->getType();
1503 // Find the type plane in the module map
1504 TypedPlanes::const_iterator MI = mMap.find(VTy);
1506 if ( TheFunction ) {
1507 // Lookup the type in the function map too
1508 TypedPlanes::const_iterator FI = fMap.find(VTy);
1509 // If there is a corresponding type plane in the function map
1510 if ( FI != fMap.end() ) {
1511 // Lookup the Value in the function map
1512 ValueMap::const_iterator FVI = FI->second.map.find(V);
1513 // If the value doesn't exist in the function map
1514 if ( FVI == FI->second.map.end() ) {
1515 // Look up the value in the module map.
1516 if (MI == mMap.end()) return -1;
1517 ValueMap::const_iterator MVI = MI->second.map.find(V);
1518 // If we didn't find it, it wasn't inserted
1519 if (MVI == MI->second.map.end()) return -1;
1520 assert( MVI != MI->second.map.end() && "Value not found");
1521 // We found it only at the module level
1524 // else the value exists in the function map
1526 // Return the slot number as the module's contribution to
1527 // the type plane plus the index in the function's contribution
1528 // to the type plane.
1529 if (MI != mMap.end())
1530 return MI->second.next_slot + FVI->second;
1537 // N.B. Can get here only if either !TheFunction or the function doesn't
1538 // have a corresponding type plane for the Value
1540 // Make sure the type plane exists
1541 if (MI == mMap.end()) return -1;
1542 // Lookup the value in the module's map
1543 ValueMap::const_iterator MVI = MI->second.map.find(V);
1544 // Make sure we found it.
1545 if (MVI == MI->second.map.end()) return -1;
1550 /// Get the slot number for a value. This function will assert if you
1551 /// ask for a Value that hasn't previously been inserted with createSlot.
1552 /// Types are forbidden because Type does not inherit from Value (any more).
1553 int SlotMachine::getSlot(const Type *Ty) {
1554 assert( Ty && "Can't get slot for null Type" );
1556 // Check for uninitialized state and do lazy initialization
1559 if ( TheFunction ) {
1560 // Lookup the Type in the function map
1561 TypeMap::const_iterator FTI = fTypes.map.find(Ty);
1562 // If the Type doesn't exist in the function map
1563 if ( FTI == fTypes.map.end() ) {
1564 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1565 // If we didn't find it, it wasn't inserted
1566 if (MTI == mTypes.map.end())
1568 // We found it only at the module level
1571 // else the value exists in the function map
1573 // Return the slot number as the module's contribution to
1574 // the type plane plus the index in the function's contribution
1575 // to the type plane.
1576 return mTypes.next_slot + FTI->second;
1580 // N.B. Can get here only if either !TheFunction
1582 // Lookup the value in the module's map
1583 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1584 // Make sure we found it.
1585 if (MTI == mTypes.map.end()) return -1;
1590 // Create a new slot, or return the existing slot if it is already
1591 // inserted. Note that the logic here parallels getSlot but instead
1592 // of asserting when the Value* isn't found, it inserts the value.
1593 unsigned SlotMachine::createSlot(const Value *V) {
1594 assert( V && "Can't insert a null Value to SlotMachine");
1595 assert(!isa<Constant>(V) || isa<GlobalValue>(V) &&
1596 "Can't insert a non-GlobalValue Constant into SlotMachine");
1598 const Type* VTy = V->getType();
1600 // Just ignore void typed things
1601 if (VTy == Type::VoidTy) return 0; // FIXME: Wrong return value!
1603 // Look up the type plane for the Value's type from the module map
1604 TypedPlanes::const_iterator MI = mMap.find(VTy);
1606 if ( TheFunction ) {
1607 // Get the type plane for the Value's type from the function map
1608 TypedPlanes::const_iterator FI = fMap.find(VTy);
1609 // If there is a corresponding type plane in the function map
1610 if ( FI != fMap.end() ) {
1611 // Lookup the Value in the function map
1612 ValueMap::const_iterator FVI = FI->second.map.find(V);
1613 // If the value doesn't exist in the function map
1614 if ( FVI == FI->second.map.end() ) {
1615 // If there is no corresponding type plane in the module map
1616 if ( MI == mMap.end() )
1617 return insertValue(V);
1618 // Look up the value in the module map
1619 ValueMap::const_iterator MVI = MI->second.map.find(V);
1620 // If we didn't find it, it wasn't inserted
1621 if ( MVI == MI->second.map.end() )
1622 return insertValue(V);
1624 // We found it only at the module level
1627 // else the value exists in the function map
1629 if ( MI == mMap.end() )
1632 // Return the slot number as the module's contribution to
1633 // the type plane plus the index in the function's contribution
1634 // to the type plane.
1635 return MI->second.next_slot + FVI->second;
1638 // else there is not a corresponding type plane in the function map
1640 // If the type plane doesn't exists at the module level
1641 if ( MI == mMap.end() ) {
1642 return insertValue(V);
1643 // else type plane exists at the module level, examine it
1645 // Look up the value in the module's map
1646 ValueMap::const_iterator MVI = MI->second.map.find(V);
1647 // If we didn't find it there either
1648 if ( MVI == MI->second.map.end() )
1649 // Return the slot number as the module's contribution to
1650 // the type plane plus the index of the function map insertion.
1651 return MI->second.next_slot + insertValue(V);
1658 // N.B. Can only get here if !TheFunction
1660 // If the module map's type plane is not for the Value's type
1661 if ( MI != mMap.end() ) {
1662 // Lookup the value in the module's map
1663 ValueMap::const_iterator MVI = MI->second.map.find(V);
1664 if ( MVI != MI->second.map.end() )
1668 return insertValue(V);
1671 // Create a new slot, or return the existing slot if it is already
1672 // inserted. Note that the logic here parallels getSlot but instead
1673 // of asserting when the Value* isn't found, it inserts the value.
1674 unsigned SlotMachine::createSlot(const Type *Ty) {
1675 assert( Ty && "Can't insert a null Type to SlotMachine");
1677 if ( TheFunction ) {
1678 // Lookup the Type in the function map
1679 TypeMap::const_iterator FTI = fTypes.map.find(Ty);
1680 // If the type doesn't exist in the function map
1681 if ( FTI == fTypes.map.end() ) {
1682 // Look up the type in the module map
1683 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1684 // If we didn't find it, it wasn't inserted
1685 if ( MTI == mTypes.map.end() )
1686 return insertValue(Ty);
1688 // We found it only at the module level
1691 // else the value exists in the function map
1693 // Return the slot number as the module's contribution to
1694 // the type plane plus the index in the function's contribution
1695 // to the type plane.
1696 return mTypes.next_slot + FTI->second;
1700 // N.B. Can only get here if !TheFunction
1702 // Lookup the type in the module's map
1703 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1704 if ( MTI != mTypes.map.end() )
1707 return insertValue(Ty);
1710 // Low level insert function. Minimal checking is done. This
1711 // function is just for the convenience of createSlot (above).
1712 unsigned SlotMachine::insertValue(const Value *V ) {
1713 assert(V && "Can't insert a null Value into SlotMachine!");
1714 assert(!isa<Constant>(V) || isa<GlobalValue>(V) &&
1715 "Can't insert a non-GlobalValue Constant into SlotMachine");
1717 // If this value does not contribute to a plane (is void)
1718 // or if the value already has a name then ignore it.
1719 if (V->getType() == Type::VoidTy || V->hasName() ) {
1720 SC_DEBUG("ignored value " << *V << "\n");
1721 return 0; // FIXME: Wrong return value
1724 const Type *VTy = V->getType();
1725 unsigned DestSlot = 0;
1727 if ( TheFunction ) {
1728 TypedPlanes::iterator I = fMap.find( VTy );
1729 if ( I == fMap.end() )
1730 I = fMap.insert(std::make_pair(VTy,ValuePlane())).first;
1731 DestSlot = I->second.map[V] = I->second.next_slot++;
1733 TypedPlanes::iterator I = mMap.find( VTy );
1734 if ( I == mMap.end() )
1735 I = mMap.insert(std::make_pair(VTy,ValuePlane())).first;
1736 DestSlot = I->second.map[V] = I->second.next_slot++;
1739 SC_DEBUG(" Inserting value [" << VTy << "] = " << V << " slot=" <<
1741 // G = Global, C = Constant, T = Type, F = Function, o = other
1742 SC_DEBUG((isa<GlobalVariable>(V) ? 'G' : (isa<Function>(V) ? 'F' :
1743 (isa<Constant>(V) ? 'C' : 'o'))));
1748 // Low level insert function. Minimal checking is done. This
1749 // function is just for the convenience of createSlot (above).
1750 unsigned SlotMachine::insertValue(const Type *Ty ) {
1751 assert(Ty && "Can't insert a null Type into SlotMachine!");
1753 unsigned DestSlot = 0;
1755 if ( TheFunction ) {
1756 DestSlot = fTypes.map[Ty] = fTypes.next_slot++;
1758 DestSlot = fTypes.map[Ty] = fTypes.next_slot++;
1760 SC_DEBUG(" Inserting type [" << DestSlot << "] = " << Ty << "\n");