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())
848 switch (GV->getLinkage()) {
849 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
850 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
851 default: Out << "external "; break;
854 switch (GV->getLinkage()) {
855 case GlobalValue::InternalLinkage: Out << "internal "; break;
856 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
857 case GlobalValue::WeakLinkage: Out << "weak "; break;
858 case GlobalValue::AppendingLinkage: Out << "appending "; break;
859 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
860 case GlobalValue::DLLExportLinkage: Out << "dllexport "; break;
861 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
862 case GlobalValue::ExternalLinkage: break;
863 case GlobalValue::GhostLinkage:
864 std::cerr << "GhostLinkage not allowed in AsmWriter!\n";
868 Out << (GV->isConstant() ? "constant " : "global ");
869 printType(GV->getType()->getElementType());
871 if (GV->hasInitializer()) {
872 Constant* C = cast<Constant>(GV->getInitializer());
873 assert(C && "GlobalVar initializer isn't constant?");
874 writeOperand(GV->getInitializer(), false, isa<GlobalValue>(C));
877 if (GV->hasSection())
878 Out << ", section \"" << GV->getSection() << '"';
879 if (GV->getAlignment())
880 Out << ", align " << GV->getAlignment();
882 printInfoComment(*GV);
887 // printSymbolTable - Run through symbol table looking for constants
888 // and types. Emit their declarations.
889 void AssemblyWriter::printSymbolTable(const SymbolTable &ST) {
892 for (SymbolTable::type_const_iterator TI = ST.type_begin();
893 TI != ST.type_end(); ++TI ) {
894 Out << "\t" << getLLVMName(TI->first) << " = type ";
896 // Make sure we print out at least one level of the type structure, so
897 // that we do not get %FILE = type %FILE
899 printTypeAtLeastOneLevel(TI->second) << "\n";
902 // Print the constants, in type plane order.
903 for (SymbolTable::plane_const_iterator PI = ST.plane_begin();
904 PI != ST.plane_end(); ++PI ) {
905 SymbolTable::value_const_iterator VI = ST.value_begin(PI->first);
906 SymbolTable::value_const_iterator VE = ST.value_end(PI->first);
908 for (; VI != VE; ++VI) {
909 const Value* V = VI->second;
910 const Constant *CPV = dyn_cast<Constant>(V) ;
911 if (CPV && !isa<GlobalValue>(V)) {
919 /// printConstant - Print out a constant pool entry...
921 void AssemblyWriter::printConstant(const Constant *CPV) {
922 // Don't print out unnamed constants, they will be inlined
923 if (!CPV->hasName()) return;
926 Out << "\t" << getLLVMName(CPV->getName()) << " =";
928 // Write the value out now...
929 writeOperand(CPV, true, false);
931 printInfoComment(*CPV);
935 /// printFunction - Print all aspects of a function.
937 void AssemblyWriter::printFunction(const Function *F) {
938 // Print out the return type and name...
941 // Ensure that no local symbols conflict with global symbols.
942 const_cast<Function*>(F)->renameLocalSymbols();
944 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
947 switch (F->getLinkage()) {
948 case GlobalValue::DLLImportLinkage: Out << "declare dllimport "; break;
949 case GlobalValue::ExternalWeakLinkage: Out << "declare extern_weak "; break;
950 default: Out << "declare ";
953 switch (F->getLinkage()) {
954 case GlobalValue::InternalLinkage: Out << "internal "; break;
955 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
956 case GlobalValue::WeakLinkage: Out << "weak "; break;
957 case GlobalValue::AppendingLinkage: Out << "appending "; break;
958 case GlobalValue::DLLImportLinkage: Out << "dllimport "; break;
959 case GlobalValue::DLLExportLinkage: Out << "dllexport "; break;
960 case GlobalValue::ExternalWeakLinkage: Out << "extern_weak "; break;
961 case GlobalValue::ExternalLinkage: break;
962 case GlobalValue::GhostLinkage:
963 std::cerr << "GhostLinkage not allowed in AsmWriter!\n";
967 // Print the calling convention.
968 switch (F->getCallingConv()) {
969 case CallingConv::C: break; // default
970 case CallingConv::CSRet: Out << "csretcc "; break;
971 case CallingConv::Fast: Out << "fastcc "; break;
972 case CallingConv::Cold: Out << "coldcc "; break;
973 default: Out << "cc" << F->getCallingConv() << " "; break;
976 printType(F->getReturnType()) << ' ';
977 if (!F->getName().empty())
978 Out << getLLVMName(F->getName());
982 Machine.incorporateFunction(F);
984 // Loop over the arguments, printing them...
985 const FunctionType *FT = F->getFunctionType();
987 for(Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
990 // Finish printing arguments...
991 if (FT->isVarArg()) {
992 if (FT->getNumParams()) Out << ", ";
993 Out << "..."; // Output varargs portion of signature!
998 Out << " section \"" << F->getSection() << '"';
999 if (F->getAlignment())
1000 Out << " align " << F->getAlignment();
1002 if (F->isExternal()) {
1007 // Output all of its basic blocks... for the function
1008 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
1014 Machine.purgeFunction();
1017 /// printArgument - This member is called for every argument that is passed into
1018 /// the function. Simply print it out
1020 void AssemblyWriter::printArgument(const Argument *Arg) {
1021 // Insert commas as we go... the first arg doesn't get a comma
1022 if (Arg != Arg->getParent()->arg_begin()) Out << ", ";
1025 printType(Arg->getType());
1027 // Output name, if available...
1029 Out << ' ' << getLLVMName(Arg->getName());
1032 /// printBasicBlock - This member is called for each basic block in a method.
1034 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
1035 if (BB->hasName()) { // Print out the label if it exists...
1036 Out << "\n" << getLLVMName(BB->getName(), false) << ':';
1037 } else if (!BB->use_empty()) { // Don't print block # of no uses...
1038 Out << "\n; <label>:";
1039 int Slot = Machine.getSlot(BB);
1046 if (BB->getParent() == 0)
1047 Out << "\t\t; Error: Block without parent!";
1049 if (BB != &BB->getParent()->front()) { // Not the entry block?
1050 // Output predecessors for the block...
1052 pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
1055 Out << " No predecessors!";
1058 writeOperand(*PI, false, true);
1059 for (++PI; PI != PE; ++PI) {
1061 writeOperand(*PI, false, true);
1069 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
1071 // Output all of the instructions in the basic block...
1072 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1073 printInstruction(*I);
1075 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
1079 /// printInfoComment - Print a little comment after the instruction indicating
1080 /// which slot it occupies.
1082 void AssemblyWriter::printInfoComment(const Value &V) {
1083 if (V.getType() != Type::VoidTy) {
1085 printType(V.getType()) << '>';
1088 int SlotNum = Machine.getSlot(&V);
1092 Out << ':' << SlotNum; // Print out the def slot taken.
1094 Out << " [#uses=" << V.getNumUses() << ']'; // Output # uses
1098 // This member is called for each Instruction in a function..
1099 void AssemblyWriter::printInstruction(const Instruction &I) {
1100 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
1104 // Print out name if it exists...
1106 Out << getLLVMName(I.getName()) << " = ";
1108 // If this is a volatile load or store, print out the volatile marker.
1109 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
1110 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile())) {
1112 } else if (isa<CallInst>(I) && cast<CallInst>(I).isTailCall()) {
1113 // If this is a call, check if it's a tail call.
1117 // Print out the opcode...
1118 Out << I.getOpcodeName();
1120 // Print out the type of the operands...
1121 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
1123 // Special case conditional branches to swizzle the condition out to the front
1124 if (isa<BranchInst>(I) && I.getNumOperands() > 1) {
1125 writeOperand(I.getOperand(2), true);
1127 writeOperand(Operand, true);
1129 writeOperand(I.getOperand(1), true);
1131 } else if (isa<SwitchInst>(I)) {
1132 // Special case switch statement to get formatting nice and correct...
1133 writeOperand(Operand , true); Out << ',';
1134 writeOperand(I.getOperand(1), true); Out << " [";
1136 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
1138 writeOperand(I.getOperand(op ), true); Out << ',';
1139 writeOperand(I.getOperand(op+1), true);
1142 } else if (isa<PHINode>(I)) {
1144 printType(I.getType());
1147 for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
1148 if (op) Out << ", ";
1150 writeOperand(I.getOperand(op ), false); Out << ',';
1151 writeOperand(I.getOperand(op+1), false); Out << " ]";
1153 } else if (isa<ReturnInst>(I) && !Operand) {
1155 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
1156 // Print the calling convention being used.
1157 switch (CI->getCallingConv()) {
1158 case CallingConv::C: break; // default
1159 case CallingConv::CSRet: Out << " csretcc"; break;
1160 case CallingConv::Fast: Out << " fastcc"; break;
1161 case CallingConv::Cold: Out << " coldcc"; break;
1162 default: Out << " cc" << CI->getCallingConv(); break;
1165 const PointerType *PTy = cast<PointerType>(Operand->getType());
1166 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1167 const Type *RetTy = FTy->getReturnType();
1169 // If possible, print out the short form of the call instruction. We can
1170 // only do this if the first argument is a pointer to a nonvararg function,
1171 // and if the return type is not a pointer to a function.
1173 if (!FTy->isVarArg() &&
1174 (!isa<PointerType>(RetTy) ||
1175 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1176 Out << ' '; printType(RetTy);
1177 writeOperand(Operand, false);
1179 writeOperand(Operand, true);
1182 if (CI->getNumOperands() > 1) writeOperand(CI->getOperand(1), true);
1183 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; ++op) {
1185 writeOperand(I.getOperand(op), true);
1189 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
1190 const PointerType *PTy = cast<PointerType>(Operand->getType());
1191 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1192 const Type *RetTy = FTy->getReturnType();
1194 // Print the calling convention being used.
1195 switch (II->getCallingConv()) {
1196 case CallingConv::C: break; // default
1197 case CallingConv::CSRet: Out << " csretcc"; break;
1198 case CallingConv::Fast: Out << " fastcc"; break;
1199 case CallingConv::Cold: Out << " coldcc"; break;
1200 default: Out << " cc" << II->getCallingConv(); break;
1203 // If possible, print out the short form of the invoke instruction. We can
1204 // only do this if the first argument is a pointer to a nonvararg function,
1205 // and if the return type is not a pointer to a function.
1207 if (!FTy->isVarArg() &&
1208 (!isa<PointerType>(RetTy) ||
1209 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1210 Out << ' '; printType(RetTy);
1211 writeOperand(Operand, false);
1213 writeOperand(Operand, true);
1217 if (I.getNumOperands() > 3) writeOperand(I.getOperand(3), true);
1218 for (unsigned op = 4, Eop = I.getNumOperands(); op < Eop; ++op) {
1220 writeOperand(I.getOperand(op), true);
1223 Out << " )\n\t\t\tto";
1224 writeOperand(II->getNormalDest(), true);
1226 writeOperand(II->getUnwindDest(), true);
1228 } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
1230 printType(AI->getType()->getElementType());
1231 if (AI->isArrayAllocation()) {
1233 writeOperand(AI->getArraySize(), true);
1235 if (AI->getAlignment()) {
1236 Out << ", align " << AI->getAlignment();
1238 } else if (isa<CastInst>(I)) {
1239 if (Operand) writeOperand(Operand, true); // Work with broken code
1241 printType(I.getType());
1242 } else if (isa<VAArgInst>(I)) {
1243 if (Operand) writeOperand(Operand, true); // Work with broken code
1245 printType(I.getType());
1246 } else if (Operand) { // Print the normal way...
1248 // PrintAllTypes - Instructions who have operands of all the same type
1249 // omit the type from all but the first operand. If the instruction has
1250 // different type operands (for example br), then they are all printed.
1251 bool PrintAllTypes = false;
1252 const Type *TheType = Operand->getType();
1254 // Shift Left & Right print both types even for Ubyte LHS, and select prints
1255 // types even if all operands are bools.
1256 if (isa<ShiftInst>(I) || isa<SelectInst>(I) || isa<StoreInst>(I) ||
1257 isa<ShuffleVectorInst>(I)) {
1258 PrintAllTypes = true;
1260 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
1261 Operand = I.getOperand(i);
1262 if (Operand->getType() != TheType) {
1263 PrintAllTypes = true; // We have differing types! Print them all!
1269 if (!PrintAllTypes) {
1274 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
1276 writeOperand(I.getOperand(i), PrintAllTypes);
1280 printInfoComment(I);
1285 //===----------------------------------------------------------------------===//
1286 // External Interface declarations
1287 //===----------------------------------------------------------------------===//
1289 void Module::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1290 SlotMachine SlotTable(this);
1291 AssemblyWriter W(o, SlotTable, this, AAW);
1295 void GlobalVariable::print(std::ostream &o) const {
1296 SlotMachine SlotTable(getParent());
1297 AssemblyWriter W(o, SlotTable, getParent(), 0);
1301 void Function::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1302 SlotMachine SlotTable(getParent());
1303 AssemblyWriter W(o, SlotTable, getParent(), AAW);
1308 void InlineAsm::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1309 WriteAsOperand(o, this, true, true, 0);
1312 void BasicBlock::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1313 SlotMachine SlotTable(getParent());
1314 AssemblyWriter W(o, SlotTable,
1315 getParent() ? getParent()->getParent() : 0, AAW);
1319 void Instruction::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1320 const Function *F = getParent() ? getParent()->getParent() : 0;
1321 SlotMachine SlotTable(F);
1322 AssemblyWriter W(o, SlotTable, F ? F->getParent() : 0, AAW);
1327 void Constant::print(std::ostream &o) const {
1328 if (this == 0) { o << "<null> constant value\n"; return; }
1330 o << ' ' << getType()->getDescription() << ' ';
1332 std::map<const Type *, std::string> TypeTable;
1333 WriteConstantInt(o, this, false, TypeTable, 0);
1336 void Type::print(std::ostream &o) const {
1340 o << getDescription();
1343 void Argument::print(std::ostream &o) const {
1344 WriteAsOperand(o, this, true, true,
1345 getParent() ? getParent()->getParent() : 0);
1348 // Value::dump - allow easy printing of Values from the debugger.
1349 // Located here because so much of the needed functionality is here.
1350 void Value::dump() const { print(std::cerr); }
1352 // Type::dump - allow easy printing of Values from the debugger.
1353 // Located here because so much of the needed functionality is here.
1354 void Type::dump() const { print(std::cerr); }
1356 //===----------------------------------------------------------------------===//
1357 // CachedWriter Class Implementation
1358 //===----------------------------------------------------------------------===//
1360 void CachedWriter::setModule(const Module *M) {
1361 delete SC; delete AW;
1363 SC = new SlotMachine(M );
1364 AW = new AssemblyWriter(Out, *SC, M, 0);
1370 CachedWriter::~CachedWriter() {
1375 CachedWriter &CachedWriter::operator<<(const Value &V) {
1376 assert(AW && SC && "CachedWriter does not have a current module!");
1377 if (const Instruction *I = dyn_cast<Instruction>(&V))
1379 else if (const BasicBlock *BB = dyn_cast<BasicBlock>(&V))
1381 else if (const Function *F = dyn_cast<Function>(&V))
1383 else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(&V))
1386 AW->writeOperand(&V, true, true);
1390 CachedWriter& CachedWriter::operator<<(const Type &Ty) {
1391 if (SymbolicTypes) {
1392 const Module *M = AW->getModule();
1393 if (M) WriteTypeSymbolic(Out, &Ty, M);
1400 //===----------------------------------------------------------------------===//
1401 //===-- SlotMachine Implementation
1402 //===----------------------------------------------------------------------===//
1405 #define SC_DEBUG(X) std::cerr << X
1410 // Module level constructor. Causes the contents of the Module (sans functions)
1411 // to be added to the slot table.
1412 SlotMachine::SlotMachine(const Module *M)
1413 : TheModule(M) ///< Saved for lazy initialization.
1415 , FunctionProcessed(false)
1423 // Function level constructor. Causes the contents of the Module and the one
1424 // function provided to be added to the slot table.
1425 SlotMachine::SlotMachine(const Function *F )
1426 : TheModule( F ? F->getParent() : 0 ) ///< Saved for lazy initialization
1427 , TheFunction(F) ///< Saved for lazy initialization
1428 , FunctionProcessed(false)
1436 inline void SlotMachine::initialize(void) {
1439 TheModule = 0; ///< Prevent re-processing next time we're called.
1441 if ( TheFunction && ! FunctionProcessed) {
1446 // Iterate through all the global variables, functions, and global
1447 // variable initializers and create slots for them.
1448 void SlotMachine::processModule() {
1449 SC_DEBUG("begin processModule!\n");
1451 // Add all of the global variables to the value table...
1452 for (Module::const_global_iterator I = TheModule->global_begin(), E = TheModule->global_end();
1456 // Add all the functions to the table
1457 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
1461 SC_DEBUG("end processModule!\n");
1465 // Process the arguments, basic blocks, and instructions of a function.
1466 void SlotMachine::processFunction() {
1467 SC_DEBUG("begin processFunction!\n");
1469 // Add all the function arguments
1470 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
1471 AE = TheFunction->arg_end(); AI != AE; ++AI)
1474 SC_DEBUG("Inserting Instructions:\n");
1476 // Add all of the basic blocks and instructions
1477 for (Function::const_iterator BB = TheFunction->begin(),
1478 E = TheFunction->end(); BB != E; ++BB) {
1480 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I!=E; ++I) {
1485 FunctionProcessed = true;
1487 SC_DEBUG("end processFunction!\n");
1490 // Clean up after incorporating a function. This is the only way
1491 // to get out of the function incorporation state that affects the
1492 // getSlot/createSlot lock. Function incorporation state is indicated
1493 // by TheFunction != 0.
1494 void SlotMachine::purgeFunction() {
1495 SC_DEBUG("begin purgeFunction!\n");
1496 fMap.clear(); // Simply discard the function level map
1499 FunctionProcessed = false;
1500 SC_DEBUG("end purgeFunction!\n");
1503 /// Get the slot number for a value. This function will assert if you
1504 /// ask for a Value that hasn't previously been inserted with createSlot.
1505 /// Types are forbidden because Type does not inherit from Value (any more).
1506 int SlotMachine::getSlot(const Value *V) {
1507 assert( V && "Can't get slot for null Value" );
1508 assert(!isa<Constant>(V) || isa<GlobalValue>(V) &&
1509 "Can't insert a non-GlobalValue Constant into SlotMachine");
1511 // Check for uninitialized state and do lazy initialization
1514 // Get the type of the value
1515 const Type* VTy = V->getType();
1517 // Find the type plane in the module map
1518 TypedPlanes::const_iterator MI = mMap.find(VTy);
1520 if ( TheFunction ) {
1521 // Lookup the type in the function map too
1522 TypedPlanes::const_iterator FI = fMap.find(VTy);
1523 // If there is a corresponding type plane in the function map
1524 if ( FI != fMap.end() ) {
1525 // Lookup the Value in the function map
1526 ValueMap::const_iterator FVI = FI->second.map.find(V);
1527 // If the value doesn't exist in the function map
1528 if ( FVI == FI->second.map.end() ) {
1529 // Look up the value in the module map.
1530 if (MI == mMap.end()) return -1;
1531 ValueMap::const_iterator MVI = MI->second.map.find(V);
1532 // If we didn't find it, it wasn't inserted
1533 if (MVI == MI->second.map.end()) return -1;
1534 assert( MVI != MI->second.map.end() && "Value not found");
1535 // We found it only at the module level
1538 // else the value exists in the function map
1540 // Return the slot number as the module's contribution to
1541 // the type plane plus the index in the function's contribution
1542 // to the type plane.
1543 if (MI != mMap.end())
1544 return MI->second.next_slot + FVI->second;
1551 // N.B. Can get here only if either !TheFunction or the function doesn't
1552 // have a corresponding type plane for the Value
1554 // Make sure the type plane exists
1555 if (MI == mMap.end()) return -1;
1556 // Lookup the value in the module's map
1557 ValueMap::const_iterator MVI = MI->second.map.find(V);
1558 // Make sure we found it.
1559 if (MVI == MI->second.map.end()) return -1;
1564 /// Get the slot number for a value. This function will assert if you
1565 /// ask for a Value that hasn't previously been inserted with createSlot.
1566 /// Types are forbidden because Type does not inherit from Value (any more).
1567 int SlotMachine::getSlot(const Type *Ty) {
1568 assert( Ty && "Can't get slot for null Type" );
1570 // Check for uninitialized state and do lazy initialization
1573 if ( TheFunction ) {
1574 // Lookup the Type in the function map
1575 TypeMap::const_iterator FTI = fTypes.map.find(Ty);
1576 // If the Type doesn't exist in the function map
1577 if ( FTI == fTypes.map.end() ) {
1578 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1579 // If we didn't find it, it wasn't inserted
1580 if (MTI == mTypes.map.end())
1582 // We found it only at the module level
1585 // else the value exists in the function map
1587 // Return the slot number as the module's contribution to
1588 // the type plane plus the index in the function's contribution
1589 // to the type plane.
1590 return mTypes.next_slot + FTI->second;
1594 // N.B. Can get here only if either !TheFunction
1596 // Lookup the value in the module's map
1597 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1598 // Make sure we found it.
1599 if (MTI == mTypes.map.end()) return -1;
1604 // Create a new slot, or return the existing slot if it is already
1605 // inserted. Note that the logic here parallels getSlot but instead
1606 // of asserting when the Value* isn't found, it inserts the value.
1607 unsigned SlotMachine::createSlot(const Value *V) {
1608 assert( V && "Can't insert a null Value to SlotMachine");
1609 assert(!isa<Constant>(V) || isa<GlobalValue>(V) &&
1610 "Can't insert a non-GlobalValue Constant into SlotMachine");
1612 const Type* VTy = V->getType();
1614 // Just ignore void typed things
1615 if (VTy == Type::VoidTy) return 0; // FIXME: Wrong return value!
1617 // Look up the type plane for the Value's type from the module map
1618 TypedPlanes::const_iterator MI = mMap.find(VTy);
1620 if ( TheFunction ) {
1621 // Get the type plane for the Value's type from the function map
1622 TypedPlanes::const_iterator FI = fMap.find(VTy);
1623 // If there is a corresponding type plane in the function map
1624 if ( FI != fMap.end() ) {
1625 // Lookup the Value in the function map
1626 ValueMap::const_iterator FVI = FI->second.map.find(V);
1627 // If the value doesn't exist in the function map
1628 if ( FVI == FI->second.map.end() ) {
1629 // If there is no corresponding type plane in the module map
1630 if ( MI == mMap.end() )
1631 return insertValue(V);
1632 // Look up the value in the module map
1633 ValueMap::const_iterator MVI = MI->second.map.find(V);
1634 // If we didn't find it, it wasn't inserted
1635 if ( MVI == MI->second.map.end() )
1636 return insertValue(V);
1638 // We found it only at the module level
1641 // else the value exists in the function map
1643 if ( MI == mMap.end() )
1646 // Return the slot number as the module's contribution to
1647 // the type plane plus the index in the function's contribution
1648 // to the type plane.
1649 return MI->second.next_slot + FVI->second;
1652 // else there is not a corresponding type plane in the function map
1654 // If the type plane doesn't exists at the module level
1655 if ( MI == mMap.end() ) {
1656 return insertValue(V);
1657 // else type plane exists at the module level, examine it
1659 // Look up the value in the module's map
1660 ValueMap::const_iterator MVI = MI->second.map.find(V);
1661 // If we didn't find it there either
1662 if ( MVI == MI->second.map.end() )
1663 // Return the slot number as the module's contribution to
1664 // the type plane plus the index of the function map insertion.
1665 return MI->second.next_slot + insertValue(V);
1672 // N.B. Can only get here if !TheFunction
1674 // If the module map's type plane is not for the Value's type
1675 if ( MI != mMap.end() ) {
1676 // Lookup the value in the module's map
1677 ValueMap::const_iterator MVI = MI->second.map.find(V);
1678 if ( MVI != MI->second.map.end() )
1682 return insertValue(V);
1685 // Create a new slot, or return the existing slot if it is already
1686 // inserted. Note that the logic here parallels getSlot but instead
1687 // of asserting when the Value* isn't found, it inserts the value.
1688 unsigned SlotMachine::createSlot(const Type *Ty) {
1689 assert( Ty && "Can't insert a null Type to SlotMachine");
1691 if ( TheFunction ) {
1692 // Lookup the Type in the function map
1693 TypeMap::const_iterator FTI = fTypes.map.find(Ty);
1694 // If the type doesn't exist in the function map
1695 if ( FTI == fTypes.map.end() ) {
1696 // Look up the type in the module map
1697 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1698 // If we didn't find it, it wasn't inserted
1699 if ( MTI == mTypes.map.end() )
1700 return insertValue(Ty);
1702 // We found it only at the module level
1705 // else the value exists in the function map
1707 // Return the slot number as the module's contribution to
1708 // the type plane plus the index in the function's contribution
1709 // to the type plane.
1710 return mTypes.next_slot + FTI->second;
1714 // N.B. Can only get here if !TheFunction
1716 // Lookup the type in the module's map
1717 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1718 if ( MTI != mTypes.map.end() )
1721 return insertValue(Ty);
1724 // Low level insert function. Minimal checking is done. This
1725 // function is just for the convenience of createSlot (above).
1726 unsigned SlotMachine::insertValue(const Value *V ) {
1727 assert(V && "Can't insert a null Value into SlotMachine!");
1728 assert(!isa<Constant>(V) || isa<GlobalValue>(V) &&
1729 "Can't insert a non-GlobalValue Constant into SlotMachine");
1731 // If this value does not contribute to a plane (is void)
1732 // or if the value already has a name then ignore it.
1733 if (V->getType() == Type::VoidTy || V->hasName() ) {
1734 SC_DEBUG("ignored value " << *V << "\n");
1735 return 0; // FIXME: Wrong return value
1738 const Type *VTy = V->getType();
1739 unsigned DestSlot = 0;
1741 if ( TheFunction ) {
1742 TypedPlanes::iterator I = fMap.find( VTy );
1743 if ( I == fMap.end() )
1744 I = fMap.insert(std::make_pair(VTy,ValuePlane())).first;
1745 DestSlot = I->second.map[V] = I->second.next_slot++;
1747 TypedPlanes::iterator I = mMap.find( VTy );
1748 if ( I == mMap.end() )
1749 I = mMap.insert(std::make_pair(VTy,ValuePlane())).first;
1750 DestSlot = I->second.map[V] = I->second.next_slot++;
1753 SC_DEBUG(" Inserting value [" << VTy << "] = " << V << " slot=" <<
1755 // G = Global, C = Constant, T = Type, F = Function, o = other
1756 SC_DEBUG((isa<GlobalVariable>(V) ? 'G' : (isa<Function>(V) ? 'F' :
1757 (isa<Constant>(V) ? 'C' : 'o'))));
1762 // Low level insert function. Minimal checking is done. This
1763 // function is just for the convenience of createSlot (above).
1764 unsigned SlotMachine::insertValue(const Type *Ty ) {
1765 assert(Ty && "Can't insert a null Type into SlotMachine!");
1767 unsigned DestSlot = 0;
1769 if ( TheFunction ) {
1770 DestSlot = fTypes.map[Ty] = fTypes.next_slot++;
1772 DestSlot = fTypes.map[Ty] = fTypes.next_slot++;
1774 SC_DEBUG(" Inserting type [" << DestSlot << "] = " << Ty << "\n");