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/Instruction.h"
25 #include "llvm/Instructions.h"
26 #include "llvm/Module.h"
27 #include "llvm/SymbolTable.h"
28 #include "llvm/Assembly/Writer.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",PassInfo::Analysis|PassInfo::Optimization);
167 static RegisterPass<PrintFunctionPass>
168 Y("print","Print function to stderr",PassInfo::Analysis|PassInfo::Optimization);
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 /// @brief Internal constant writer.
402 static void WriteConstantInt(std::ostream &Out, const Constant *CV,
404 std::map<const Type *, std::string> &TypeTable,
405 SlotMachine *Machine) {
406 if (const ConstantBool *CB = dyn_cast<ConstantBool>(CV)) {
407 Out << (CB == ConstantBool::True ? "true" : "false");
408 } else if (const ConstantSInt *CI = dyn_cast<ConstantSInt>(CV)) {
409 Out << CI->getValue();
410 } else if (const ConstantUInt *CI = dyn_cast<ConstantUInt>(CV)) {
411 Out << CI->getValue();
412 } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
413 // We would like to output the FP constant value in exponential notation,
414 // but we cannot do this if doing so will lose precision. Check here to
415 // make sure that we only output it in exponential format if we can parse
416 // the value back and get the same value.
418 std::string StrVal = ftostr(CFP->getValue());
420 // Check to make sure that the stringized number is not some string like
421 // "Inf" or NaN, that atof will accept, but the lexer will not. Check that
422 // the string matches the "[-+]?[0-9]" regex.
424 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
425 ((StrVal[0] == '-' || StrVal[0] == '+') &&
426 (StrVal[1] >= '0' && StrVal[1] <= '9')))
427 // Reparse stringized version!
428 if (atof(StrVal.c_str()) == CFP->getValue()) {
433 // Otherwise we could not reparse it to exactly the same value, so we must
434 // output the string in hexadecimal format!
435 assert(sizeof(double) == sizeof(uint64_t) &&
436 "assuming that double is 64 bits!");
437 Out << "0x" << utohexstr(DoubleToBits(CFP->getValue()));
439 } else if (isa<ConstantAggregateZero>(CV)) {
440 Out << "zeroinitializer";
441 } else if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
442 // As a special case, print the array as a string if it is an array of
443 // ubytes or an array of sbytes with positive values.
445 const Type *ETy = CA->getType()->getElementType();
446 bool isString = (ETy == Type::SByteTy || ETy == Type::UByteTy);
448 if (ETy == Type::SByteTy)
449 for (unsigned i = 0; i < CA->getNumOperands(); ++i)
450 if (cast<ConstantSInt>(CA->getOperand(i))->getValue() < 0) {
457 for (unsigned i = 0; i < CA->getNumOperands(); ++i) {
459 (unsigned char)cast<ConstantInt>(CA->getOperand(i))->getRawValue();
461 if (isprint(C) && C != '"' && C != '\\') {
465 << (char) ((C/16 < 10) ? ( C/16 +'0') : ( C/16 -10+'A'))
466 << (char)(((C&15) < 10) ? ((C&15)+'0') : ((C&15)-10+'A'));
471 } else { // Cannot output in string format...
473 if (CA->getNumOperands()) {
475 printTypeInt(Out, ETy, TypeTable);
476 WriteAsOperandInternal(Out, CA->getOperand(0),
477 PrintName, TypeTable, Machine);
478 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
480 printTypeInt(Out, ETy, TypeTable);
481 WriteAsOperandInternal(Out, CA->getOperand(i), PrintName,
487 } else if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
489 if (CS->getNumOperands()) {
491 printTypeInt(Out, CS->getOperand(0)->getType(), TypeTable);
493 WriteAsOperandInternal(Out, CS->getOperand(0),
494 PrintName, TypeTable, Machine);
496 for (unsigned i = 1; i < CS->getNumOperands(); i++) {
498 printTypeInt(Out, CS->getOperand(i)->getType(), TypeTable);
500 WriteAsOperandInternal(Out, CS->getOperand(i),
501 PrintName, TypeTable, Machine);
506 } else if (const ConstantPacked *CP = dyn_cast<ConstantPacked>(CV)) {
507 const Type *ETy = CP->getType()->getElementType();
508 assert(CP->getNumOperands() > 0 &&
509 "Number of operands for a PackedConst must be > 0");
512 printTypeInt(Out, ETy, TypeTable);
513 WriteAsOperandInternal(Out, CP->getOperand(0),
514 PrintName, TypeTable, Machine);
515 for (unsigned i = 1, e = CP->getNumOperands(); i != e; ++i) {
517 printTypeInt(Out, ETy, TypeTable);
518 WriteAsOperandInternal(Out, CP->getOperand(i), PrintName,
522 } else if (isa<ConstantPointerNull>(CV)) {
525 } else if (isa<UndefValue>(CV)) {
528 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
529 Out << CE->getOpcodeName() << " (";
531 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
532 printTypeInt(Out, (*OI)->getType(), TypeTable);
533 WriteAsOperandInternal(Out, *OI, PrintName, TypeTable, Machine);
534 if (OI+1 != CE->op_end())
538 if (CE->getOpcode() == Instruction::Cast) {
540 printTypeInt(Out, CE->getType(), TypeTable);
545 Out << "<placeholder or erroneous Constant>";
550 /// WriteAsOperand - Write the name of the specified value out to the specified
551 /// ostream. This can be useful when you just want to print int %reg126, not
552 /// the whole instruction that generated it.
554 static void WriteAsOperandInternal(std::ostream &Out, const Value *V,
556 std::map<const Type*, std::string> &TypeTable,
557 SlotMachine *Machine) {
559 if ((PrintName || isa<GlobalValue>(V)) && V->hasName())
560 Out << getLLVMName(V->getName());
562 const Constant *CV = dyn_cast<Constant>(V);
563 if (CV && !isa<GlobalValue>(CV))
564 WriteConstantInt(Out, CV, PrintName, TypeTable, Machine);
568 Slot = Machine->getSlot(V);
570 Machine = createSlotMachine(V);
572 Slot = Machine->getSlot(V);
585 /// WriteAsOperand - Write the name of the specified value out to the specified
586 /// ostream. This can be useful when you just want to print int %reg126, not
587 /// the whole instruction that generated it.
589 std::ostream &llvm::WriteAsOperand(std::ostream &Out, const Value *V,
590 bool PrintType, bool PrintName,
591 const Module *Context) {
592 std::map<const Type *, std::string> TypeNames;
593 if (Context == 0) Context = getModuleFromVal(V);
596 fillTypeNameTable(Context, TypeNames);
599 printTypeInt(Out, V->getType(), TypeNames);
601 WriteAsOperandInternal(Out, V, PrintName, TypeNames, 0);
605 /// WriteAsOperandInternal - Write the name of the specified value out to
606 /// the specified ostream. This can be useful when you just want to print
607 /// int %reg126, not the whole instruction that generated it.
609 static void WriteAsOperandInternal(std::ostream &Out, const Type *T,
611 std::map<const Type*, std::string> &TypeTable,
612 SlotMachine *Machine) {
616 Slot = Machine->getSlot(T);
622 Out << T->getDescription();
626 /// WriteAsOperand - Write the name of the specified value out to the specified
627 /// ostream. This can be useful when you just want to print int %reg126, not
628 /// the whole instruction that generated it.
630 std::ostream &llvm::WriteAsOperand(std::ostream &Out, const Type *Ty,
631 bool PrintType, bool PrintName,
632 const Module *Context) {
633 std::map<const Type *, std::string> TypeNames;
634 assert(Context != 0 && "Can't write types as operand without module context");
636 fillTypeNameTable(Context, TypeNames);
639 // printTypeInt(Out, V->getType(), TypeNames);
641 printTypeInt(Out, Ty, TypeNames);
643 WriteAsOperandInternal(Out, Ty, PrintName, TypeNames, 0);
649 class AssemblyWriter {
651 SlotMachine &Machine;
652 const Module *TheModule;
653 std::map<const Type *, std::string> TypeNames;
654 AssemblyAnnotationWriter *AnnotationWriter;
656 inline AssemblyWriter(std::ostream &o, SlotMachine &Mac, const Module *M,
657 AssemblyAnnotationWriter *AAW)
658 : Out(o), Machine(Mac), TheModule(M), AnnotationWriter(AAW) {
660 // If the module has a symbol table, take all global types and stuff their
661 // names into the TypeNames map.
663 fillTypeNameTable(M, TypeNames);
666 inline void write(const Module *M) { printModule(M); }
667 inline void write(const GlobalVariable *G) { printGlobal(G); }
668 inline void write(const Function *F) { printFunction(F); }
669 inline void write(const BasicBlock *BB) { printBasicBlock(BB); }
670 inline void write(const Instruction *I) { printInstruction(*I); }
671 inline void write(const Constant *CPV) { printConstant(CPV); }
672 inline void write(const Type *Ty) { printType(Ty); }
674 void writeOperand(const Value *Op, bool PrintType, bool PrintName = true);
676 const Module* getModule() { return TheModule; }
679 void printModule(const Module *M);
680 void printSymbolTable(const SymbolTable &ST);
681 void printConstant(const Constant *CPV);
682 void printGlobal(const GlobalVariable *GV);
683 void printFunction(const Function *F);
684 void printArgument(const Argument *FA);
685 void printBasicBlock(const BasicBlock *BB);
686 void printInstruction(const Instruction &I);
688 // printType - Go to extreme measures to attempt to print out a short,
689 // symbolic version of a type name.
691 std::ostream &printType(const Type *Ty) {
692 return printTypeInt(Out, Ty, TypeNames);
695 // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
696 // without considering any symbolic types that we may have equal to it.
698 std::ostream &printTypeAtLeastOneLevel(const Type *Ty);
700 // printInfoComment - Print a little comment after the instruction indicating
701 // which slot it occupies.
702 void printInfoComment(const Value &V);
704 } // end of llvm namespace
706 /// printTypeAtLeastOneLevel - Print out one level of the possibly complex type
707 /// without considering any symbolic types that we may have equal to it.
709 std::ostream &AssemblyWriter::printTypeAtLeastOneLevel(const Type *Ty) {
710 if (const FunctionType *FTy = dyn_cast<FunctionType>(Ty)) {
711 printType(FTy->getReturnType()) << " (";
712 for (FunctionType::param_iterator I = FTy->param_begin(),
713 E = FTy->param_end(); I != E; ++I) {
714 if (I != FTy->param_begin())
718 if (FTy->isVarArg()) {
719 if (FTy->getNumParams()) Out << ", ";
723 } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
725 for (StructType::element_iterator I = STy->element_begin(),
726 E = STy->element_end(); I != E; ++I) {
727 if (I != STy->element_begin())
732 } else if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
733 printType(PTy->getElementType()) << '*';
734 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
735 Out << '[' << ATy->getNumElements() << " x ";
736 printType(ATy->getElementType()) << ']';
737 } else if (const PackedType *PTy = dyn_cast<PackedType>(Ty)) {
738 Out << '<' << PTy->getNumElements() << " x ";
739 printType(PTy->getElementType()) << '>';
741 else if (const OpaqueType *OTy = dyn_cast<OpaqueType>(Ty)) {
744 if (!Ty->isPrimitiveType())
745 Out << "<unknown derived type>";
752 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType,
755 if (PrintType) { Out << ' '; printType(Operand->getType()); }
756 WriteAsOperandInternal(Out, Operand, PrintName, TypeNames, &Machine);
758 Out << "<null operand!>";
763 void AssemblyWriter::printModule(const Module *M) {
764 if (!M->getModuleIdentifier().empty() &&
765 // Don't print the ID if it will start a new line (which would
766 // require a comment char before it).
767 M->getModuleIdentifier().find('\n') == std::string::npos)
768 Out << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
770 switch (M->getEndianness()) {
771 case Module::LittleEndian: Out << "target endian = little\n"; break;
772 case Module::BigEndian: Out << "target endian = big\n"; break;
773 case Module::AnyEndianness: break;
775 switch (M->getPointerSize()) {
776 case Module::Pointer32: Out << "target pointersize = 32\n"; break;
777 case Module::Pointer64: Out << "target pointersize = 64\n"; break;
778 case Module::AnyPointerSize: break;
780 if (!M->getTargetTriple().empty())
781 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
783 // Loop over the dependent libraries and emit them.
784 Module::lib_iterator LI = M->lib_begin();
785 Module::lib_iterator LE = M->lib_end();
787 Out << "deplibs = [ ";
789 Out << '"' << *LI << '"';
797 // Loop over the symbol table, emitting all named constants.
798 printSymbolTable(M->getSymbolTable());
800 for (Module::const_global_iterator I = M->global_begin(), E = M->global_end(); I != E; ++I)
803 Out << "\nimplementation ; Functions:\n";
805 // Output all of the functions.
806 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
810 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
811 if (GV->hasName()) Out << getLLVMName(GV->getName()) << " = ";
813 if (!GV->hasInitializer())
816 switch (GV->getLinkage()) {
817 case GlobalValue::InternalLinkage: Out << "internal "; break;
818 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
819 case GlobalValue::WeakLinkage: Out << "weak "; break;
820 case GlobalValue::AppendingLinkage: Out << "appending "; break;
821 case GlobalValue::ExternalLinkage: break;
822 case GlobalValue::GhostLinkage:
823 std::cerr << "GhostLinkage not allowed in AsmWriter!\n";
827 Out << (GV->isConstant() ? "constant " : "global ");
828 printType(GV->getType()->getElementType());
830 if (GV->hasInitializer()) {
831 Constant* C = cast<Constant>(GV->getInitializer());
832 assert(C && "GlobalVar initializer isn't constant?");
833 writeOperand(GV->getInitializer(), false, isa<GlobalValue>(C));
836 if (GV->hasSection())
837 Out << ", section \"" << GV->getSection() << '"';
838 if (GV->getAlignment())
839 Out << ", align " << GV->getAlignment();
841 printInfoComment(*GV);
846 // printSymbolTable - Run through symbol table looking for constants
847 // and types. Emit their declarations.
848 void AssemblyWriter::printSymbolTable(const SymbolTable &ST) {
851 for (SymbolTable::type_const_iterator TI = ST.type_begin();
852 TI != ST.type_end(); ++TI ) {
853 Out << "\t" << getLLVMName(TI->first) << " = type ";
855 // Make sure we print out at least one level of the type structure, so
856 // that we do not get %FILE = type %FILE
858 printTypeAtLeastOneLevel(TI->second) << "\n";
861 // Print the constants, in type plane order.
862 for (SymbolTable::plane_const_iterator PI = ST.plane_begin();
863 PI != ST.plane_end(); ++PI ) {
864 SymbolTable::value_const_iterator VI = ST.value_begin(PI->first);
865 SymbolTable::value_const_iterator VE = ST.value_end(PI->first);
867 for (; VI != VE; ++VI) {
868 const Value* V = VI->second;
869 const Constant *CPV = dyn_cast<Constant>(V) ;
870 if (CPV && !isa<GlobalValue>(V)) {
878 /// printConstant - Print out a constant pool entry...
880 void AssemblyWriter::printConstant(const Constant *CPV) {
881 // Don't print out unnamed constants, they will be inlined
882 if (!CPV->hasName()) return;
885 Out << "\t" << getLLVMName(CPV->getName()) << " =";
887 // Write the value out now...
888 writeOperand(CPV, true, false);
890 printInfoComment(*CPV);
894 /// printFunction - Print all aspects of a function.
896 void AssemblyWriter::printFunction(const Function *F) {
897 // Print out the return type and name...
900 // Ensure that no local symbols conflict with global symbols.
901 const_cast<Function*>(F)->renameLocalSymbols();
903 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
908 switch (F->getLinkage()) {
909 case GlobalValue::InternalLinkage: Out << "internal "; break;
910 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
911 case GlobalValue::WeakLinkage: Out << "weak "; break;
912 case GlobalValue::AppendingLinkage: Out << "appending "; break;
913 case GlobalValue::ExternalLinkage: break;
914 case GlobalValue::GhostLinkage:
915 std::cerr << "GhostLinkage not allowed in AsmWriter!\n";
919 // Print the calling convention.
920 switch (F->getCallingConv()) {
921 case CallingConv::C: break; // default
922 case CallingConv::Fast: Out << "fastcc "; break;
923 case CallingConv::Cold: Out << "coldcc "; break;
924 default: Out << "cc" << F->getCallingConv() << " "; break;
927 printType(F->getReturnType()) << ' ';
928 if (!F->getName().empty())
929 Out << getLLVMName(F->getName());
933 Machine.incorporateFunction(F);
935 // Loop over the arguments, printing them...
936 const FunctionType *FT = F->getFunctionType();
938 for(Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
941 // Finish printing arguments...
942 if (FT->isVarArg()) {
943 if (FT->getNumParams()) Out << ", ";
944 Out << "..."; // Output varargs portion of signature!
949 Out << " section \"" << F->getSection() << '"';
950 if (F->getAlignment())
951 Out << " align " << F->getAlignment();
953 if (F->isExternal()) {
958 // Output all of its basic blocks... for the function
959 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
965 Machine.purgeFunction();
968 /// printArgument - This member is called for every argument that is passed into
969 /// the function. Simply print it out
971 void AssemblyWriter::printArgument(const Argument *Arg) {
972 // Insert commas as we go... the first arg doesn't get a comma
973 if (Arg != Arg->getParent()->arg_begin()) Out << ", ";
976 printType(Arg->getType());
978 // Output name, if available...
980 Out << ' ' << getLLVMName(Arg->getName());
983 /// printBasicBlock - This member is called for each basic block in a method.
985 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
986 if (BB->hasName()) { // Print out the label if it exists...
987 Out << "\n" << getLLVMName(BB->getName(), false) << ':';
988 } else if (!BB->use_empty()) { // Don't print block # of no uses...
989 Out << "\n; <label>:";
990 int Slot = Machine.getSlot(BB);
997 if (BB->getParent() == 0)
998 Out << "\t\t; Error: Block without parent!";
1000 if (BB != &BB->getParent()->front()) { // Not the entry block?
1001 // Output predecessors for the block...
1003 pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
1006 Out << " No predecessors!";
1009 writeOperand(*PI, false, true);
1010 for (++PI; PI != PE; ++PI) {
1012 writeOperand(*PI, false, true);
1020 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
1022 // Output all of the instructions in the basic block...
1023 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1024 printInstruction(*I);
1026 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
1030 /// printInfoComment - Print a little comment after the instruction indicating
1031 /// which slot it occupies.
1033 void AssemblyWriter::printInfoComment(const Value &V) {
1034 if (V.getType() != Type::VoidTy) {
1036 printType(V.getType()) << '>';
1039 int SlotNum = Machine.getSlot(&V);
1043 Out << ':' << SlotNum; // Print out the def slot taken.
1045 Out << " [#uses=" << V.getNumUses() << ']'; // Output # uses
1049 /// printInstruction - This member is called for each Instruction in a function..
1051 void AssemblyWriter::printInstruction(const Instruction &I) {
1052 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
1056 // Print out name if it exists...
1058 Out << getLLVMName(I.getName()) << " = ";
1060 // If this is a volatile load or store, print out the volatile marker.
1061 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
1062 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile())) {
1064 } else if (isa<CallInst>(I) && cast<CallInst>(I).isTailCall()) {
1065 // If this is a call, check if it's a tail call.
1069 // Print out the opcode...
1070 Out << I.getOpcodeName();
1072 // Print out the type of the operands...
1073 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
1075 // Special case conditional branches to swizzle the condition out to the front
1076 if (isa<BranchInst>(I) && I.getNumOperands() > 1) {
1077 writeOperand(I.getOperand(2), true);
1079 writeOperand(Operand, true);
1081 writeOperand(I.getOperand(1), true);
1083 } else if (isa<SwitchInst>(I)) {
1084 // Special case switch statement to get formatting nice and correct...
1085 writeOperand(Operand , true); Out << ',';
1086 writeOperand(I.getOperand(1), true); Out << " [";
1088 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
1090 writeOperand(I.getOperand(op ), true); Out << ',';
1091 writeOperand(I.getOperand(op+1), true);
1094 } else if (isa<PHINode>(I)) {
1096 printType(I.getType());
1099 for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
1100 if (op) Out << ", ";
1102 writeOperand(I.getOperand(op ), false); Out << ',';
1103 writeOperand(I.getOperand(op+1), false); Out << " ]";
1105 } else if (isa<ReturnInst>(I) && !Operand) {
1107 } else if (const CallInst *CI = dyn_cast<CallInst>(&I)) {
1108 // Print the calling convention being used.
1109 switch (CI->getCallingConv()) {
1110 case CallingConv::C: break; // default
1111 case CallingConv::Fast: Out << " fastcc"; break;
1112 case CallingConv::Cold: Out << " coldcc"; break;
1113 default: Out << " cc" << CI->getCallingConv(); break;
1116 const PointerType *PTy = cast<PointerType>(Operand->getType());
1117 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1118 const Type *RetTy = FTy->getReturnType();
1120 // If possible, print out the short form of the call instruction. We can
1121 // only do this if the first argument is a pointer to a nonvararg function,
1122 // and if the return type is not a pointer to a function.
1124 if (!FTy->isVarArg() &&
1125 (!isa<PointerType>(RetTy) ||
1126 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1127 Out << ' '; printType(RetTy);
1128 writeOperand(Operand, false);
1130 writeOperand(Operand, true);
1133 if (CI->getNumOperands() > 1) writeOperand(CI->getOperand(1), true);
1134 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; ++op) {
1136 writeOperand(I.getOperand(op), true);
1140 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
1141 const PointerType *PTy = cast<PointerType>(Operand->getType());
1142 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1143 const Type *RetTy = FTy->getReturnType();
1145 // Print the calling convention being used.
1146 switch (II->getCallingConv()) {
1147 case CallingConv::C: break; // default
1148 case CallingConv::Fast: Out << " fastcc"; break;
1149 case CallingConv::Cold: Out << " coldcc"; break;
1150 default: Out << " cc" << II->getCallingConv(); break;
1153 // If possible, print out the short form of the invoke instruction. We can
1154 // only do this if the first argument is a pointer to a nonvararg function,
1155 // and if the return type is not a pointer to a function.
1157 if (!FTy->isVarArg() &&
1158 (!isa<PointerType>(RetTy) ||
1159 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1160 Out << ' '; printType(RetTy);
1161 writeOperand(Operand, false);
1163 writeOperand(Operand, true);
1167 if (I.getNumOperands() > 3) writeOperand(I.getOperand(3), true);
1168 for (unsigned op = 4, Eop = I.getNumOperands(); op < Eop; ++op) {
1170 writeOperand(I.getOperand(op), true);
1173 Out << " )\n\t\t\tto";
1174 writeOperand(II->getNormalDest(), true);
1176 writeOperand(II->getUnwindDest(), true);
1178 } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
1180 printType(AI->getType()->getElementType());
1181 if (AI->isArrayAllocation()) {
1183 writeOperand(AI->getArraySize(), true);
1185 if (AI->getAlignment()) {
1186 Out << ", align " << AI->getAlignment();
1188 } else if (isa<CastInst>(I)) {
1189 if (Operand) writeOperand(Operand, true); // Work with broken code
1191 printType(I.getType());
1192 } else if (isa<VAArgInst>(I)) {
1193 if (Operand) writeOperand(Operand, true); // Work with broken code
1195 printType(I.getType());
1196 } else if (Operand) { // Print the normal way...
1198 // PrintAllTypes - Instructions who have operands of all the same type
1199 // omit the type from all but the first operand. If the instruction has
1200 // different type operands (for example br), then they are all printed.
1201 bool PrintAllTypes = false;
1202 const Type *TheType = Operand->getType();
1204 // Shift Left & Right print both types even for Ubyte LHS, and select prints
1205 // types even if all operands are bools.
1206 if (isa<ShiftInst>(I) || isa<SelectInst>(I) || isa<StoreInst>(I)) {
1207 PrintAllTypes = true;
1209 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
1210 Operand = I.getOperand(i);
1211 if (Operand->getType() != TheType) {
1212 PrintAllTypes = true; // We have differing types! Print them all!
1218 if (!PrintAllTypes) {
1223 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
1225 writeOperand(I.getOperand(i), PrintAllTypes);
1229 printInfoComment(I);
1234 //===----------------------------------------------------------------------===//
1235 // External Interface declarations
1236 //===----------------------------------------------------------------------===//
1238 void Module::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1239 SlotMachine SlotTable(this);
1240 AssemblyWriter W(o, SlotTable, this, AAW);
1244 void GlobalVariable::print(std::ostream &o) const {
1245 SlotMachine SlotTable(getParent());
1246 AssemblyWriter W(o, SlotTable, getParent(), 0);
1250 void Function::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1251 SlotMachine SlotTable(getParent());
1252 AssemblyWriter W(o, SlotTable, getParent(), AAW);
1257 void BasicBlock::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1258 SlotMachine SlotTable(getParent());
1259 AssemblyWriter W(o, SlotTable,
1260 getParent() ? getParent()->getParent() : 0, AAW);
1264 void Instruction::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1265 const Function *F = getParent() ? getParent()->getParent() : 0;
1266 SlotMachine SlotTable(F);
1267 AssemblyWriter W(o, SlotTable, F ? F->getParent() : 0, AAW);
1272 void Constant::print(std::ostream &o) const {
1273 if (this == 0) { o << "<null> constant value\n"; return; }
1275 o << ' ' << getType()->getDescription() << ' ';
1277 std::map<const Type *, std::string> TypeTable;
1278 WriteConstantInt(o, this, false, TypeTable, 0);
1281 void Type::print(std::ostream &o) const {
1285 o << getDescription();
1288 void Argument::print(std::ostream &o) const {
1289 WriteAsOperand(o, this, true, true,
1290 getParent() ? getParent()->getParent() : 0);
1293 // Value::dump - allow easy printing of Values from the debugger.
1294 // Located here because so much of the needed functionality is here.
1295 void Value::dump() const { print(std::cerr); }
1297 // Type::dump - allow easy printing of Values from the debugger.
1298 // Located here because so much of the needed functionality is here.
1299 void Type::dump() const { print(std::cerr); }
1301 //===----------------------------------------------------------------------===//
1302 // CachedWriter Class Implementation
1303 //===----------------------------------------------------------------------===//
1305 void CachedWriter::setModule(const Module *M) {
1306 delete SC; delete AW;
1308 SC = new SlotMachine(M );
1309 AW = new AssemblyWriter(Out, *SC, M, 0);
1315 CachedWriter::~CachedWriter() {
1320 CachedWriter &CachedWriter::operator<<(const Value &V) {
1321 assert(AW && SC && "CachedWriter does not have a current module!");
1322 if (const Instruction *I = dyn_cast<Instruction>(&V))
1324 else if (const BasicBlock *BB = dyn_cast<BasicBlock>(&V))
1326 else if (const Function *F = dyn_cast<Function>(&V))
1328 else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(&V))
1331 AW->writeOperand(&V, true, true);
1335 CachedWriter& CachedWriter::operator<<(const Type &Ty) {
1336 if (SymbolicTypes) {
1337 const Module *M = AW->getModule();
1338 if (M) WriteTypeSymbolic(Out, &Ty, M);
1345 //===----------------------------------------------------------------------===//
1346 //===-- SlotMachine Implementation
1347 //===----------------------------------------------------------------------===//
1350 #define SC_DEBUG(X) std::cerr << X
1355 // Module level constructor. Causes the contents of the Module (sans functions)
1356 // to be added to the slot table.
1357 SlotMachine::SlotMachine(const Module *M)
1358 : TheModule(M) ///< Saved for lazy initialization.
1360 , FunctionProcessed(false)
1368 // Function level constructor. Causes the contents of the Module and the one
1369 // function provided to be added to the slot table.
1370 SlotMachine::SlotMachine(const Function *F )
1371 : TheModule( F ? F->getParent() : 0 ) ///< Saved for lazy initialization
1372 , TheFunction(F) ///< Saved for lazy initialization
1373 , FunctionProcessed(false)
1381 inline void SlotMachine::initialize(void) {
1384 TheModule = 0; ///< Prevent re-processing next time we're called.
1386 if ( TheFunction && ! FunctionProcessed) {
1391 // Iterate through all the global variables, functions, and global
1392 // variable initializers and create slots for them.
1393 void SlotMachine::processModule() {
1394 SC_DEBUG("begin processModule!\n");
1396 // Add all of the global variables to the value table...
1397 for (Module::const_global_iterator I = TheModule->global_begin(), E = TheModule->global_end();
1401 // Add all the functions to the table
1402 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
1406 SC_DEBUG("end processModule!\n");
1410 // Process the arguments, basic blocks, and instructions of a function.
1411 void SlotMachine::processFunction() {
1412 SC_DEBUG("begin processFunction!\n");
1414 // Add all the function arguments
1415 for(Function::const_arg_iterator AI = TheFunction->arg_begin(),
1416 AE = TheFunction->arg_end(); AI != AE; ++AI)
1419 SC_DEBUG("Inserting Instructions:\n");
1421 // Add all of the basic blocks and instructions
1422 for (Function::const_iterator BB = TheFunction->begin(),
1423 E = TheFunction->end(); BB != E; ++BB) {
1425 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I!=E; ++I) {
1430 FunctionProcessed = true;
1432 SC_DEBUG("end processFunction!\n");
1435 // Clean up after incorporating a function. This is the only way
1436 // to get out of the function incorporation state that affects the
1437 // getSlot/createSlot lock. Function incorporation state is indicated
1438 // by TheFunction != 0.
1439 void SlotMachine::purgeFunction() {
1440 SC_DEBUG("begin purgeFunction!\n");
1441 fMap.clear(); // Simply discard the function level map
1444 FunctionProcessed = false;
1445 SC_DEBUG("end purgeFunction!\n");
1448 /// Get the slot number for a value. This function will assert if you
1449 /// ask for a Value that hasn't previously been inserted with createSlot.
1450 /// Types are forbidden because Type does not inherit from Value (any more).
1451 int SlotMachine::getSlot(const Value *V) {
1452 assert( V && "Can't get slot for null Value" );
1453 assert(!isa<Constant>(V) || isa<GlobalValue>(V) &&
1454 "Can't insert a non-GlobalValue Constant into SlotMachine");
1456 // Check for uninitialized state and do lazy initialization
1459 // Get the type of the value
1460 const Type* VTy = V->getType();
1462 // Find the type plane in the module map
1463 TypedPlanes::const_iterator MI = mMap.find(VTy);
1465 if ( TheFunction ) {
1466 // Lookup the type in the function map too
1467 TypedPlanes::const_iterator FI = fMap.find(VTy);
1468 // If there is a corresponding type plane in the function map
1469 if ( FI != fMap.end() ) {
1470 // Lookup the Value in the function map
1471 ValueMap::const_iterator FVI = FI->second.map.find(V);
1472 // If the value doesn't exist in the function map
1473 if ( FVI == FI->second.map.end() ) {
1474 // Look up the value in the module map.
1475 if (MI == mMap.end()) return -1;
1476 ValueMap::const_iterator MVI = MI->second.map.find(V);
1477 // If we didn't find it, it wasn't inserted
1478 if (MVI == MI->second.map.end()) return -1;
1479 assert( MVI != MI->second.map.end() && "Value not found");
1480 // We found it only at the module level
1483 // else the value exists in the function map
1485 // Return the slot number as the module's contribution to
1486 // the type plane plus the index in the function's contribution
1487 // to the type plane.
1488 if (MI != mMap.end())
1489 return MI->second.next_slot + FVI->second;
1496 // N.B. Can get here only if either !TheFunction or the function doesn't
1497 // have a corresponding type plane for the Value
1499 // Make sure the type plane exists
1500 if (MI == mMap.end()) return -1;
1501 // Lookup the value in the module's map
1502 ValueMap::const_iterator MVI = MI->second.map.find(V);
1503 // Make sure we found it.
1504 if (MVI == MI->second.map.end()) return -1;
1509 /// Get the slot number for a value. This function will assert if you
1510 /// ask for a Value that hasn't previously been inserted with createSlot.
1511 /// Types are forbidden because Type does not inherit from Value (any more).
1512 int SlotMachine::getSlot(const Type *Ty) {
1513 assert( Ty && "Can't get slot for null Type" );
1515 // Check for uninitialized state and do lazy initialization
1518 if ( TheFunction ) {
1519 // Lookup the Type in the function map
1520 TypeMap::const_iterator FTI = fTypes.map.find(Ty);
1521 // If the Type doesn't exist in the function map
1522 if ( FTI == fTypes.map.end() ) {
1523 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1524 // If we didn't find it, it wasn't inserted
1525 if (MTI == mTypes.map.end())
1527 // We found it only at the module level
1530 // else the value exists in the function map
1532 // Return the slot number as the module's contribution to
1533 // the type plane plus the index in the function's contribution
1534 // to the type plane.
1535 return mTypes.next_slot + FTI->second;
1539 // N.B. Can get here only if either !TheFunction
1541 // Lookup the value in the module's map
1542 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1543 // Make sure we found it.
1544 if (MTI == mTypes.map.end()) return -1;
1549 // Create a new slot, or return the existing slot if it is already
1550 // inserted. Note that the logic here parallels getSlot but instead
1551 // of asserting when the Value* isn't found, it inserts the value.
1552 unsigned SlotMachine::createSlot(const Value *V) {
1553 assert( V && "Can't insert a null Value to SlotMachine");
1554 assert(!isa<Constant>(V) || isa<GlobalValue>(V) &&
1555 "Can't insert a non-GlobalValue Constant into SlotMachine");
1557 const Type* VTy = V->getType();
1559 // Just ignore void typed things
1560 if (VTy == Type::VoidTy) return 0; // FIXME: Wrong return value!
1562 // Look up the type plane for the Value's type from the module map
1563 TypedPlanes::const_iterator MI = mMap.find(VTy);
1565 if ( TheFunction ) {
1566 // Get the type plane for the Value's type from the function map
1567 TypedPlanes::const_iterator FI = fMap.find(VTy);
1568 // If there is a corresponding type plane in the function map
1569 if ( FI != fMap.end() ) {
1570 // Lookup the Value in the function map
1571 ValueMap::const_iterator FVI = FI->second.map.find(V);
1572 // If the value doesn't exist in the function map
1573 if ( FVI == FI->second.map.end() ) {
1574 // If there is no corresponding type plane in the module map
1575 if ( MI == mMap.end() )
1576 return insertValue(V);
1577 // Look up the value in the module map
1578 ValueMap::const_iterator MVI = MI->second.map.find(V);
1579 // If we didn't find it, it wasn't inserted
1580 if ( MVI == MI->second.map.end() )
1581 return insertValue(V);
1583 // We found it only at the module level
1586 // else the value exists in the function map
1588 if ( MI == mMap.end() )
1591 // Return the slot number as the module's contribution to
1592 // the type plane plus the index in the function's contribution
1593 // to the type plane.
1594 return MI->second.next_slot + FVI->second;
1597 // else there is not a corresponding type plane in the function map
1599 // If the type plane doesn't exists at the module level
1600 if ( MI == mMap.end() ) {
1601 return insertValue(V);
1602 // else type plane exists at the module level, examine it
1604 // Look up the value in the module's map
1605 ValueMap::const_iterator MVI = MI->second.map.find(V);
1606 // If we didn't find it there either
1607 if ( MVI == MI->second.map.end() )
1608 // Return the slot number as the module's contribution to
1609 // the type plane plus the index of the function map insertion.
1610 return MI->second.next_slot + insertValue(V);
1617 // N.B. Can only get here if !TheFunction
1619 // If the module map's type plane is not for the Value's type
1620 if ( MI != mMap.end() ) {
1621 // Lookup the value in the module's map
1622 ValueMap::const_iterator MVI = MI->second.map.find(V);
1623 if ( MVI != MI->second.map.end() )
1627 return insertValue(V);
1630 // Create a new slot, or return the existing slot if it is already
1631 // inserted. Note that the logic here parallels getSlot but instead
1632 // of asserting when the Value* isn't found, it inserts the value.
1633 unsigned SlotMachine::createSlot(const Type *Ty) {
1634 assert( Ty && "Can't insert a null Type to SlotMachine");
1636 if ( TheFunction ) {
1637 // Lookup the Type in the function map
1638 TypeMap::const_iterator FTI = fTypes.map.find(Ty);
1639 // If the type doesn't exist in the function map
1640 if ( FTI == fTypes.map.end() ) {
1641 // Look up the type in the module map
1642 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1643 // If we didn't find it, it wasn't inserted
1644 if ( MTI == mTypes.map.end() )
1645 return insertValue(Ty);
1647 // We found it only at the module level
1650 // else the value exists in the function map
1652 // Return the slot number as the module's contribution to
1653 // the type plane plus the index in the function's contribution
1654 // to the type plane.
1655 return mTypes.next_slot + FTI->second;
1659 // N.B. Can only get here if !TheFunction
1661 // Lookup the type in the module's map
1662 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1663 if ( MTI != mTypes.map.end() )
1666 return insertValue(Ty);
1669 // Low level insert function. Minimal checking is done. This
1670 // function is just for the convenience of createSlot (above).
1671 unsigned SlotMachine::insertValue(const Value *V ) {
1672 assert(V && "Can't insert a null Value into SlotMachine!");
1673 assert(!isa<Constant>(V) || isa<GlobalValue>(V) &&
1674 "Can't insert a non-GlobalValue Constant into SlotMachine");
1676 // If this value does not contribute to a plane (is void)
1677 // or if the value already has a name then ignore it.
1678 if (V->getType() == Type::VoidTy || V->hasName() ) {
1679 SC_DEBUG("ignored value " << *V << "\n");
1680 return 0; // FIXME: Wrong return value
1683 const Type *VTy = V->getType();
1684 unsigned DestSlot = 0;
1686 if ( TheFunction ) {
1687 TypedPlanes::iterator I = fMap.find( VTy );
1688 if ( I == fMap.end() )
1689 I = fMap.insert(std::make_pair(VTy,ValuePlane())).first;
1690 DestSlot = I->second.map[V] = I->second.next_slot++;
1692 TypedPlanes::iterator I = mMap.find( VTy );
1693 if ( I == mMap.end() )
1694 I = mMap.insert(std::make_pair(VTy,ValuePlane())).first;
1695 DestSlot = I->second.map[V] = I->second.next_slot++;
1698 SC_DEBUG(" Inserting value [" << VTy << "] = " << V << " slot=" <<
1700 // G = Global, C = Constant, T = Type, F = Function, o = other
1701 SC_DEBUG((isa<GlobalVariable>(V) ? 'G' : (isa<Function>(V) ? 'F' :
1702 (isa<Constant>(V) ? 'C' : 'o'))));
1707 // Low level insert function. Minimal checking is done. This
1708 // function is just for the convenience of createSlot (above).
1709 unsigned SlotMachine::insertValue(const Type *Ty ) {
1710 assert(Ty && "Can't insert a null Type into SlotMachine!");
1712 unsigned DestSlot = 0;
1714 if ( TheFunction ) {
1715 DestSlot = fTypes.map[Ty] = fTypes.next_slot++;
1717 DestSlot = fTypes.map[Ty] = fTypes.next_slot++;
1719 SC_DEBUG(" Inserting type [" << DestSlot << "] = " << Ty << "\n");