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/Constants.h"
22 #include "llvm/DerivedTypes.h"
23 #include "llvm/Instruction.h"
24 #include "llvm/Instructions.h"
25 #include "llvm/Module.h"
26 #include "llvm/SymbolTable.h"
27 #include "llvm/Assembly/Writer.h"
28 #include "llvm/Support/CFG.h"
29 #include "llvm/ADT/StringExtras.h"
30 #include "llvm/ADT/STLExtras.h"
36 /// This class provides computation of slot numbers for LLVM Assembly writing.
37 /// @brief LLVM Assembly Writing Slot Computation.
44 /// @brief A mapping of Values to slot numbers
45 typedef std::map<const Value*, unsigned> ValueMap;
46 typedef std::map<const Type*, unsigned> TypeMap;
48 /// @brief A plane with next slot number and ValueMap
50 unsigned next_slot; ///< The next slot number to use
51 ValueMap map; ///< The map of Value* -> unsigned
52 ValuePlane() { next_slot = 0; } ///< Make sure we start at 0
58 TypePlane() { next_slot = 0; }
59 void clear() { map.clear(); next_slot = 0; }
62 /// @brief The map of planes by Type
63 typedef std::map<const Type*, ValuePlane> TypedPlanes;
66 /// @name Constructors
69 /// @brief Construct from a module
70 SlotMachine(const Module *M );
72 /// @brief Construct from a function, starting out in incorp state.
73 SlotMachine(const Function *F );
79 /// Return the slot number of the specified value in it's type
80 /// plane. Its an error to ask for something not in the SlotMachine.
81 /// Its an error to ask for a Type*
82 int getSlot(const Value *V);
83 int getSlot(const Type*Ty);
85 /// Determine if a Value has a slot or not
86 bool hasSlot(const Value* V);
87 bool hasSlot(const Type* Ty);
93 /// If you'd like to deal with a function instead of just a module, use
94 /// this method to get its data into the SlotMachine.
95 void incorporateFunction(const Function *F) {
97 FunctionProcessed = false;
100 /// After calling incorporateFunction, use this method to remove the
101 /// most recently incorporated function from the SlotMachine. This
102 /// will reset the state of the machine back to just the module contents.
103 void purgeFunction();
106 /// @name Implementation Details
109 /// This function does the actual initialization.
110 inline void initialize();
112 /// Values can be crammed into here at will. If they haven't
113 /// been inserted already, they get inserted, otherwise they are ignored.
114 /// Either way, the slot number for the Value* is returned.
115 unsigned createSlot(const Value *V);
116 unsigned createSlot(const Type* Ty);
118 /// Insert a value into the value table. Return the slot number
119 /// that it now occupies. BadThings(TM) will happen if you insert a
120 /// Value that's already been inserted.
121 unsigned insertValue( const Value *V );
122 unsigned insertValue( const Type* Ty);
124 /// Add all of the module level global variables (and their initializers)
125 /// and function declarations, but not the contents of those functions.
126 void processModule();
128 /// Add all of the functions arguments, basic blocks, and instructions
129 void processFunction();
131 SlotMachine(const SlotMachine &); // DO NOT IMPLEMENT
132 void operator=(const SlotMachine &); // DO NOT IMPLEMENT
139 /// @brief The module for which we are holding slot numbers
140 const Module* TheModule;
142 /// @brief The function for which we are holding slot numbers
143 const Function* TheFunction;
144 bool FunctionProcessed;
146 /// @brief The TypePlanes map for the module level data
150 /// @brief The TypePlanes map for the function level data
158 } // end namespace llvm
160 static RegisterPass<PrintModulePass>
161 X("printm", "Print module to stderr",PassInfo::Analysis|PassInfo::Optimization);
162 static RegisterPass<PrintFunctionPass>
163 Y("print","Print function to stderr",PassInfo::Analysis|PassInfo::Optimization);
165 static void WriteAsOperandInternal(std::ostream &Out, const Value *V,
167 std::map<const Type *, std::string> &TypeTable,
168 SlotMachine *Machine);
170 static void WriteAsOperandInternal(std::ostream &Out, const Type *T,
172 std::map<const Type *, std::string> &TypeTable,
173 SlotMachine *Machine);
175 static const Module *getModuleFromVal(const Value *V) {
176 if (const Argument *MA = dyn_cast<Argument>(V))
177 return MA->getParent() ? MA->getParent()->getParent() : 0;
178 else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
179 return BB->getParent() ? BB->getParent()->getParent() : 0;
180 else if (const Instruction *I = dyn_cast<Instruction>(V)) {
181 const Function *M = I->getParent() ? I->getParent()->getParent() : 0;
182 return M ? M->getParent() : 0;
183 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
184 return GV->getParent();
188 static SlotMachine *createSlotMachine(const Value *V) {
189 if (const Argument *FA = dyn_cast<Argument>(V)) {
190 return new SlotMachine(FA->getParent());
191 } else if (const Instruction *I = dyn_cast<Instruction>(V)) {
192 return new SlotMachine(I->getParent()->getParent());
193 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V)) {
194 return new SlotMachine(BB->getParent());
195 } else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V)){
196 return new SlotMachine(GV->getParent());
197 } else if (const Function *Func = dyn_cast<Function>(V)) {
198 return new SlotMachine(Func);
203 // getLLVMName - Turn the specified string into an 'LLVM name', which is either
204 // prefixed with % (if the string only contains simple characters) or is
205 // surrounded with ""'s (if it has special chars in it).
206 static std::string getLLVMName(const std::string &Name) {
207 assert(!Name.empty() && "Cannot get empty name!");
209 // First character cannot start with a number...
210 if (Name[0] >= '0' && Name[0] <= '9')
211 return "\"" + Name + "\"";
213 // Scan to see if we have any characters that are not on the "white list"
214 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
216 assert(C != '"' && "Illegal character in LLVM value name!");
217 if ((C < 'a' || C > 'z') && (C < 'A' || C > 'Z') && (C < '0' || C > '9') &&
218 C != '-' && C != '.' && C != '_')
219 return "\"" + Name + "\"";
222 // If we get here, then the identifier is legal to use as a "VarID".
227 /// fillTypeNameTable - If the module has a symbol table, take all global types
228 /// and stuff their names into the TypeNames map.
230 static void fillTypeNameTable(const Module *M,
231 std::map<const Type *, std::string> &TypeNames) {
233 const SymbolTable &ST = M->getSymbolTable();
234 SymbolTable::type_const_iterator TI = ST.type_begin();
235 for (; TI != ST.type_end(); ++TI ) {
236 // As a heuristic, don't insert pointer to primitive types, because
237 // they are used too often to have a single useful name.
239 const Type *Ty = cast<Type>(TI->second);
240 if (!isa<PointerType>(Ty) ||
241 !cast<PointerType>(Ty)->getElementType()->isPrimitiveType() ||
242 isa<OpaqueType>(cast<PointerType>(Ty)->getElementType()))
243 TypeNames.insert(std::make_pair(Ty, getLLVMName(TI->first)));
249 static void calcTypeName(const Type *Ty,
250 std::vector<const Type *> &TypeStack,
251 std::map<const Type *, std::string> &TypeNames,
252 std::string & Result){
253 if (Ty->isPrimitiveType() && !isa<OpaqueType>(Ty)) {
254 Result += Ty->getDescription(); // Base case
258 // Check to see if the type is named.
259 std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
260 if (I != TypeNames.end()) {
265 if (isa<OpaqueType>(Ty)) {
270 // Check to see if the Type is already on the stack...
271 unsigned Slot = 0, CurSize = TypeStack.size();
272 while (Slot < CurSize && TypeStack[Slot] != Ty) ++Slot; // Scan for type
274 // This is another base case for the recursion. In this case, we know
275 // that we have looped back to a type that we have previously visited.
276 // Generate the appropriate upreference to handle this.
277 if (Slot < CurSize) {
278 Result += "\\" + utostr(CurSize-Slot); // Here's the upreference
282 TypeStack.push_back(Ty); // Recursive case: Add us to the stack..
284 switch (Ty->getTypeID()) {
285 case Type::FunctionTyID: {
286 const FunctionType *FTy = cast<FunctionType>(Ty);
287 calcTypeName(FTy->getReturnType(), TypeStack, TypeNames, Result);
289 for (FunctionType::param_iterator I = FTy->param_begin(),
290 E = FTy->param_end(); I != E; ++I) {
291 if (I != FTy->param_begin())
293 calcTypeName(*I, TypeStack, TypeNames, Result);
295 if (FTy->isVarArg()) {
296 if (FTy->getNumParams()) Result += ", ";
302 case Type::StructTyID: {
303 const StructType *STy = cast<StructType>(Ty);
305 for (StructType::element_iterator I = STy->element_begin(),
306 E = STy->element_end(); I != E; ++I) {
307 if (I != STy->element_begin())
309 calcTypeName(*I, TypeStack, TypeNames, Result);
314 case Type::PointerTyID:
315 calcTypeName(cast<PointerType>(Ty)->getElementType(),
316 TypeStack, TypeNames, Result);
319 case Type::ArrayTyID: {
320 const ArrayType *ATy = cast<ArrayType>(Ty);
321 Result += "[" + utostr(ATy->getNumElements()) + " x ";
322 calcTypeName(ATy->getElementType(), TypeStack, TypeNames, Result);
326 case Type::PackedTyID: {
327 const PackedType *PTy = cast<PackedType>(Ty);
328 Result += "<" + utostr(PTy->getNumElements()) + " x ";
329 calcTypeName(PTy->getElementType(), TypeStack, TypeNames, Result);
333 case Type::OpaqueTyID:
337 Result += "<unrecognized-type>";
340 TypeStack.pop_back(); // Remove self from stack...
345 /// printTypeInt - The internal guts of printing out a type that has a
346 /// potentially named portion.
348 static std::ostream &printTypeInt(std::ostream &Out, const Type *Ty,
349 std::map<const Type *, std::string> &TypeNames) {
350 // Primitive types always print out their description, regardless of whether
351 // they have been named or not.
353 if (Ty->isPrimitiveType() && !isa<OpaqueType>(Ty))
354 return Out << Ty->getDescription();
356 // Check to see if the type is named.
357 std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
358 if (I != TypeNames.end()) return Out << I->second;
360 // Otherwise we have a type that has not been named but is a derived type.
361 // Carefully recurse the type hierarchy to print out any contained symbolic
364 std::vector<const Type *> TypeStack;
365 std::string TypeName;
366 calcTypeName(Ty, TypeStack, TypeNames, TypeName);
367 TypeNames.insert(std::make_pair(Ty, TypeName));//Cache type name for later use
368 return (Out << TypeName);
372 /// WriteTypeSymbolic - This attempts to write the specified type as a symbolic
373 /// type, iff there is an entry in the modules symbol table for the specified
374 /// type or one of it's component types. This is slower than a simple x << Type
376 std::ostream &llvm::WriteTypeSymbolic(std::ostream &Out, const Type *Ty,
380 // If they want us to print out a type, attempt to make it symbolic if there
381 // is a symbol table in the module...
383 std::map<const Type *, std::string> TypeNames;
384 fillTypeNameTable(M, TypeNames);
386 return printTypeInt(Out, Ty, TypeNames);
388 return Out << Ty->getDescription();
392 /// @brief Internal constant writer.
393 static void WriteConstantInt(std::ostream &Out, const Constant *CV,
395 std::map<const Type *, std::string> &TypeTable,
396 SlotMachine *Machine) {
397 if (const ConstantBool *CB = dyn_cast<ConstantBool>(CV)) {
398 Out << (CB == ConstantBool::True ? "true" : "false");
399 } else if (const ConstantSInt *CI = dyn_cast<ConstantSInt>(CV)) {
400 Out << CI->getValue();
401 } else if (const ConstantUInt *CI = dyn_cast<ConstantUInt>(CV)) {
402 Out << CI->getValue();
403 } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
404 // We would like to output the FP constant value in exponential notation,
405 // but we cannot do this if doing so will lose precision. Check here to
406 // make sure that we only output it in exponential format if we can parse
407 // the value back and get the same value.
409 std::string StrVal = ftostr(CFP->getValue());
411 // Check to make sure that the stringized number is not some string like
412 // "Inf" or NaN, that atof will accept, but the lexer will not. Check that
413 // the string matches the "[-+]?[0-9]" regex.
415 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
416 ((StrVal[0] == '-' || StrVal[0] == '+') &&
417 (StrVal[1] >= '0' && StrVal[1] <= '9')))
418 // Reparse stringized version!
419 if (atof(StrVal.c_str()) == CFP->getValue()) {
420 Out << StrVal; return;
423 // Otherwise we could not reparse it to exactly the same value, so we must
424 // output the string in hexadecimal format!
426 // Behave nicely in the face of C TBAA rules... see:
427 // http://www.nullstone.com/htmls/category/aliastyp.htm
429 double Val = CFP->getValue();
430 char *Ptr = (char*)&Val;
431 assert(sizeof(double) == sizeof(uint64_t) && sizeof(double) == 8 &&
432 "assuming that double is 64 bits!");
433 Out << "0x" << utohexstr(*(uint64_t*)Ptr);
435 } else if (isa<ConstantAggregateZero>(CV)) {
436 Out << "zeroinitializer";
437 } else if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
438 // As a special case, print the array as a string if it is an array of
439 // ubytes or an array of sbytes with positive values.
441 const Type *ETy = CA->getType()->getElementType();
442 bool isString = (ETy == Type::SByteTy || ETy == Type::UByteTy);
444 if (ETy == Type::SByteTy)
445 for (unsigned i = 0; i < CA->getNumOperands(); ++i)
446 if (cast<ConstantSInt>(CA->getOperand(i))->getValue() < 0) {
453 for (unsigned i = 0; i < CA->getNumOperands(); ++i) {
455 (unsigned char)cast<ConstantInt>(CA->getOperand(i))->getRawValue();
457 if (isprint(C) && C != '"' && C != '\\') {
461 << (char) ((C/16 < 10) ? ( C/16 +'0') : ( C/16 -10+'A'))
462 << (char)(((C&15) < 10) ? ((C&15)+'0') : ((C&15)-10+'A'));
467 } else { // Cannot output in string format...
469 if (CA->getNumOperands()) {
471 printTypeInt(Out, ETy, TypeTable);
472 WriteAsOperandInternal(Out, CA->getOperand(0),
473 PrintName, TypeTable, Machine);
474 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
476 printTypeInt(Out, ETy, TypeTable);
477 WriteAsOperandInternal(Out, CA->getOperand(i), PrintName,
483 } else if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
485 if (CS->getNumOperands()) {
487 printTypeInt(Out, CS->getOperand(0)->getType(), TypeTable);
489 WriteAsOperandInternal(Out, CS->getOperand(0),
490 PrintName, TypeTable, Machine);
492 for (unsigned i = 1; i < CS->getNumOperands(); i++) {
494 printTypeInt(Out, CS->getOperand(i)->getType(), TypeTable);
496 WriteAsOperandInternal(Out, CS->getOperand(i),
497 PrintName, TypeTable, Machine);
502 } else if (const ConstantPacked *CP = dyn_cast<ConstantPacked>(CV)) {
503 const Type *ETy = CP->getType()->getElementType();
504 assert(CP->getNumOperands() > 0 &&
505 "Number of operands for a PackedConst must be > 0");
508 printTypeInt(Out, ETy, TypeTable);
509 WriteAsOperandInternal(Out, CP->getOperand(0),
510 PrintName, TypeTable, Machine);
511 for (unsigned i = 1, e = CP->getNumOperands(); i != e; ++i) {
513 printTypeInt(Out, ETy, TypeTable);
514 WriteAsOperandInternal(Out, CP->getOperand(i), PrintName,
518 } else if (isa<ConstantPointerNull>(CV)) {
521 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
522 Out << CE->getOpcodeName() << " (";
524 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
525 printTypeInt(Out, (*OI)->getType(), TypeTable);
526 WriteAsOperandInternal(Out, *OI, PrintName, TypeTable, Machine);
527 if (OI+1 != CE->op_end())
531 if (CE->getOpcode() == Instruction::Cast) {
533 printTypeInt(Out, CE->getType(), TypeTable);
538 Out << "<placeholder or erroneous Constant>";
543 /// WriteAsOperand - Write the name of the specified value out to the specified
544 /// ostream. This can be useful when you just want to print int %reg126, not
545 /// the whole instruction that generated it.
547 static void WriteAsOperandInternal(std::ostream &Out, const Value *V,
549 std::map<const Type*, std::string> &TypeTable,
550 SlotMachine *Machine) {
552 if ((PrintName || isa<GlobalValue>(V)) && V->hasName())
553 Out << getLLVMName(V->getName());
555 const Constant *CV = dyn_cast<Constant>(V);
556 if (CV && !isa<GlobalValue>(CV))
557 WriteConstantInt(Out, CV, PrintName, TypeTable, Machine);
561 Slot = Machine->getSlot(V);
563 Machine = createSlotMachine(V);
565 Slot = Machine->getSlot(V);
578 /// WriteAsOperand - Write the name of the specified value out to the specified
579 /// ostream. This can be useful when you just want to print int %reg126, not
580 /// the whole instruction that generated it.
582 std::ostream &llvm::WriteAsOperand(std::ostream &Out, const Value *V,
583 bool PrintType, bool PrintName,
584 const Module *Context) {
585 std::map<const Type *, std::string> TypeNames;
586 if (Context == 0) Context = getModuleFromVal(V);
589 fillTypeNameTable(Context, TypeNames);
592 printTypeInt(Out, V->getType(), TypeNames);
594 WriteAsOperandInternal(Out, V, PrintName, TypeNames, 0);
598 /// WriteAsOperandInternal - Write the name of the specified value out to
599 /// the specified ostream. This can be useful when you just want to print
600 /// int %reg126, not the whole instruction that generated it.
602 static void WriteAsOperandInternal(std::ostream &Out, const Type *T,
604 std::map<const Type*, std::string> &TypeTable,
605 SlotMachine *Machine) {
609 Slot = Machine->getSlot(T);
615 Out << T->getDescription();
619 /// WriteAsOperand - Write the name of the specified value out to the specified
620 /// ostream. This can be useful when you just want to print int %reg126, not
621 /// the whole instruction that generated it.
623 std::ostream &llvm::WriteAsOperand(std::ostream &Out, const Type *Ty,
624 bool PrintType, bool PrintName,
625 const Module *Context) {
626 std::map<const Type *, std::string> TypeNames;
627 assert(Context != 0 && "Can't write types as operand without module context");
629 fillTypeNameTable(Context, TypeNames);
632 // printTypeInt(Out, V->getType(), TypeNames);
634 printTypeInt(Out, Ty, TypeNames);
636 WriteAsOperandInternal(Out, Ty, PrintName, TypeNames, 0);
642 class AssemblyWriter {
644 SlotMachine &Machine;
645 const Module *TheModule;
646 std::map<const Type *, std::string> TypeNames;
647 AssemblyAnnotationWriter *AnnotationWriter;
649 inline AssemblyWriter(std::ostream &o, SlotMachine &Mac, const Module *M,
650 AssemblyAnnotationWriter *AAW)
651 : Out(o), Machine(Mac), TheModule(M), AnnotationWriter(AAW) {
653 // If the module has a symbol table, take all global types and stuff their
654 // names into the TypeNames map.
656 fillTypeNameTable(M, TypeNames);
659 inline void write(const Module *M) { printModule(M); }
660 inline void write(const GlobalVariable *G) { printGlobal(G); }
661 inline void write(const Function *F) { printFunction(F); }
662 inline void write(const BasicBlock *BB) { printBasicBlock(BB); }
663 inline void write(const Instruction *I) { printInstruction(*I); }
664 inline void write(const Constant *CPV) { printConstant(CPV); }
665 inline void write(const Type *Ty) { printType(Ty); }
667 void writeOperand(const Value *Op, bool PrintType, bool PrintName = true);
669 const Module* getModule() { return TheModule; }
672 void printModule(const Module *M);
673 void printSymbolTable(const SymbolTable &ST);
674 void printConstant(const Constant *CPV);
675 void printGlobal(const GlobalVariable *GV);
676 void printFunction(const Function *F);
677 void printArgument(const Argument *FA);
678 void printBasicBlock(const BasicBlock *BB);
679 void printInstruction(const Instruction &I);
681 // printType - Go to extreme measures to attempt to print out a short,
682 // symbolic version of a type name.
684 std::ostream &printType(const Type *Ty) {
685 return printTypeInt(Out, Ty, TypeNames);
688 // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
689 // without considering any symbolic types that we may have equal to it.
691 std::ostream &printTypeAtLeastOneLevel(const Type *Ty);
693 // printInfoComment - Print a little comment after the instruction indicating
694 // which slot it occupies.
695 void printInfoComment(const Value &V);
697 } // end of llvm namespace
699 /// printTypeAtLeastOneLevel - Print out one level of the possibly complex type
700 /// without considering any symbolic types that we may have equal to it.
702 std::ostream &AssemblyWriter::printTypeAtLeastOneLevel(const Type *Ty) {
703 if (const FunctionType *FTy = dyn_cast<FunctionType>(Ty)) {
704 printType(FTy->getReturnType()) << " (";
705 for (FunctionType::param_iterator I = FTy->param_begin(),
706 E = FTy->param_end(); I != E; ++I) {
707 if (I != FTy->param_begin())
711 if (FTy->isVarArg()) {
712 if (FTy->getNumParams()) Out << ", ";
716 } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
718 for (StructType::element_iterator I = STy->element_begin(),
719 E = STy->element_end(); I != E; ++I) {
720 if (I != STy->element_begin())
725 } else if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
726 printType(PTy->getElementType()) << '*';
727 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
728 Out << '[' << ATy->getNumElements() << " x ";
729 printType(ATy->getElementType()) << ']';
730 } else if (const PackedType *PTy = dyn_cast<PackedType>(Ty)) {
731 Out << '<' << PTy->getNumElements() << " x ";
732 printType(PTy->getElementType()) << '>';
734 else if (const OpaqueType *OTy = dyn_cast<OpaqueType>(Ty)) {
737 if (!Ty->isPrimitiveType())
738 Out << "<unknown derived type>";
745 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType,
747 assert(Operand != 0 && "Illegal Operand");
748 if (PrintType) { Out << ' '; printType(Operand->getType()); }
749 WriteAsOperandInternal(Out, Operand, PrintName, TypeNames, &Machine);
753 void AssemblyWriter::printModule(const Module *M) {
754 switch (M->getEndianness()) {
755 case Module::LittleEndian: Out << "target endian = little\n"; break;
756 case Module::BigEndian: Out << "target endian = big\n"; break;
757 case Module::AnyEndianness: break;
759 switch (M->getPointerSize()) {
760 case Module::Pointer32: Out << "target pointersize = 32\n"; break;
761 case Module::Pointer64: Out << "target pointersize = 64\n"; break;
762 case Module::AnyPointerSize: break;
764 if (!M->getTargetTriple().empty())
765 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
767 // Loop over the dependent libraries and emit them
768 Module::lib_iterator LI= M->lib_begin();
769 Module::lib_iterator LE= M->lib_end();
771 Out << "deplibs = [\n";
773 Out << "\"" << *LI << "\"";
781 // Loop over the link time pass list and emit them
782 Module::pass_iterator PI = M->pass_begin();
783 Module::pass_iterator PE = M->pass_end();
785 Out << "passes = [\n";
787 Out << "\"" << *LI << "\"";
795 // Loop over the symbol table, emitting all named constants...
796 printSymbolTable(M->getSymbolTable());
798 for (Module::const_giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
801 Out << "\nimplementation ; Functions:\n";
803 // Output all of the functions...
804 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
808 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
809 if (GV->hasName()) Out << getLLVMName(GV->getName()) << " = ";
811 if (!GV->hasInitializer())
814 switch (GV->getLinkage()) {
815 case GlobalValue::InternalLinkage: Out << "internal "; break;
816 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
817 case GlobalValue::WeakLinkage: Out << "weak "; break;
818 case GlobalValue::AppendingLinkage: Out << "appending "; break;
819 case GlobalValue::ExternalLinkage: break;
822 Out << (GV->isConstant() ? "constant " : "global ");
823 printType(GV->getType()->getElementType());
825 if (GV->hasInitializer()) {
826 Constant* C = cast<Constant>(GV->getInitializer());
827 assert(C && "GlobalVar initializer isn't constant?");
828 writeOperand(GV->getInitializer(), false, isa<GlobalValue>(C));
831 printInfoComment(*GV);
836 // printSymbolTable - Run through symbol table looking for constants
837 // and types. Emit their declarations.
838 void AssemblyWriter::printSymbolTable(const SymbolTable &ST) {
841 for (SymbolTable::type_const_iterator TI = ST.type_begin();
842 TI != ST.type_end(); ++TI ) {
843 Out << "\t" << getLLVMName(TI->first) << " = type ";
845 // Make sure we print out at least one level of the type structure, so
846 // that we do not get %FILE = type %FILE
848 printTypeAtLeastOneLevel(TI->second) << "\n";
851 // Print the constants, in type plane order.
852 for (SymbolTable::plane_const_iterator PI = ST.plane_begin();
853 PI != ST.plane_end(); ++PI ) {
854 SymbolTable::value_const_iterator VI = ST.value_begin(PI->first);
855 SymbolTable::value_const_iterator VE = ST.value_end(PI->first);
857 for (; VI != VE; ++VI) {
858 const Value* V = VI->second;
859 const Constant *CPV = dyn_cast<Constant>(V) ;
860 if (CPV && !isa<GlobalValue>(V)) {
868 /// printConstant - Print out a constant pool entry...
870 void AssemblyWriter::printConstant(const Constant *CPV) {
871 // Don't print out unnamed constants, they will be inlined
872 if (!CPV->hasName()) return;
875 Out << "\t" << getLLVMName(CPV->getName()) << " =";
877 // Write the value out now...
878 writeOperand(CPV, true, false);
880 printInfoComment(*CPV);
884 /// printFunction - Print all aspects of a function.
886 void AssemblyWriter::printFunction(const Function *F) {
887 // Print out the return type and name...
890 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
895 switch (F->getLinkage()) {
896 case GlobalValue::InternalLinkage: Out << "internal "; break;
897 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
898 case GlobalValue::WeakLinkage: Out << "weak "; break;
899 case GlobalValue::AppendingLinkage: Out << "appending "; break;
900 case GlobalValue::ExternalLinkage: break;
903 printType(F->getReturnType()) << ' ';
904 if (!F->getName().empty())
905 Out << getLLVMName(F->getName());
909 Machine.incorporateFunction(F);
911 // Loop over the arguments, printing them...
912 const FunctionType *FT = F->getFunctionType();
914 for(Function::const_aiterator I = F->abegin(), E = F->aend(); I != E; ++I)
917 // Finish printing arguments...
918 if (FT->isVarArg()) {
919 if (FT->getNumParams()) Out << ", ";
920 Out << "..."; // Output varargs portion of signature!
924 if (F->isExternal()) {
929 // Output all of its basic blocks... for the function
930 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
936 Machine.purgeFunction();
939 /// printArgument - This member is called for every argument that is passed into
940 /// the function. Simply print it out
942 void AssemblyWriter::printArgument(const Argument *Arg) {
943 // Insert commas as we go... the first arg doesn't get a comma
944 if (Arg != &Arg->getParent()->afront()) Out << ", ";
947 printType(Arg->getType());
949 // Output name, if available...
951 Out << ' ' << getLLVMName(Arg->getName());
954 /// printBasicBlock - This member is called for each basic block in a method.
956 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
957 if (BB->hasName()) { // Print out the label if it exists...
958 Out << "\n" << BB->getName() << ':';
959 } else if (!BB->use_empty()) { // Don't print block # of no uses...
960 Out << "\n; <label>:";
961 int Slot = Machine.getSlot(BB);
968 if (BB->getParent() == 0)
969 Out << "\t\t; Error: Block without parent!";
971 if (BB != &BB->getParent()->front()) { // Not the entry block?
972 // Output predecessors for the block...
974 pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
977 Out << " No predecessors!";
980 writeOperand(*PI, false, true);
981 for (++PI; PI != PE; ++PI) {
983 writeOperand(*PI, false, true);
991 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
993 // Output all of the instructions in the basic block...
994 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
995 printInstruction(*I);
997 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
1001 /// printInfoComment - Print a little comment after the instruction indicating
1002 /// which slot it occupies.
1004 void AssemblyWriter::printInfoComment(const Value &V) {
1005 if (V.getType() != Type::VoidTy) {
1007 printType(V.getType()) << '>';
1010 int SlotNum = Machine.getSlot(&V);
1014 Out << ':' << SlotNum; // Print out the def slot taken.
1016 Out << " [#uses=" << V.use_size() << ']'; // Output # uses
1020 /// printInstruction - This member is called for each Instruction in a function..
1022 void AssemblyWriter::printInstruction(const Instruction &I) {
1023 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
1027 // Print out name if it exists...
1029 Out << getLLVMName(I.getName()) << " = ";
1031 // If this is a volatile load or store, print out the volatile marker
1032 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
1033 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()))
1036 // Print out the opcode...
1037 Out << I.getOpcodeName();
1039 // Print out the type of the operands...
1040 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
1042 // Special case conditional branches to swizzle the condition out to the front
1043 if (isa<BranchInst>(I) && I.getNumOperands() > 1) {
1044 writeOperand(I.getOperand(2), true);
1046 writeOperand(Operand, true);
1048 writeOperand(I.getOperand(1), true);
1050 } else if (isa<SwitchInst>(I)) {
1051 // Special case switch statement to get formatting nice and correct...
1052 writeOperand(Operand , true); Out << ',';
1053 writeOperand(I.getOperand(1), true); Out << " [";
1055 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
1057 writeOperand(I.getOperand(op ), true); Out << ',';
1058 writeOperand(I.getOperand(op+1), true);
1061 } else if (isa<PHINode>(I)) {
1063 printType(I.getType());
1066 for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
1067 if (op) Out << ", ";
1069 writeOperand(I.getOperand(op ), false); Out << ',';
1070 writeOperand(I.getOperand(op+1), false); Out << " ]";
1072 } else if (isa<ReturnInst>(I) && !Operand) {
1074 } else if (isa<CallInst>(I)) {
1075 const PointerType *PTy = cast<PointerType>(Operand->getType());
1076 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1077 const Type *RetTy = FTy->getReturnType();
1079 // If possible, print out the short form of the call instruction. We can
1080 // only do this if the first argument is a pointer to a nonvararg function,
1081 // and if the return type is not a pointer to a function.
1083 if (!FTy->isVarArg() &&
1084 (!isa<PointerType>(RetTy) ||
1085 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1086 Out << ' '; printType(RetTy);
1087 writeOperand(Operand, false);
1089 writeOperand(Operand, true);
1092 if (I.getNumOperands() > 1) writeOperand(I.getOperand(1), true);
1093 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; ++op) {
1095 writeOperand(I.getOperand(op), true);
1099 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
1100 const PointerType *PTy = cast<PointerType>(Operand->getType());
1101 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1102 const Type *RetTy = FTy->getReturnType();
1104 // If possible, print out the short form of the invoke instruction. We can
1105 // only do this if the first argument is a pointer to a nonvararg function,
1106 // and if the return type is not a pointer to a function.
1108 if (!FTy->isVarArg() &&
1109 (!isa<PointerType>(RetTy) ||
1110 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1111 Out << ' '; printType(RetTy);
1112 writeOperand(Operand, false);
1114 writeOperand(Operand, true);
1118 if (I.getNumOperands() > 3) writeOperand(I.getOperand(3), true);
1119 for (unsigned op = 4, Eop = I.getNumOperands(); op < Eop; ++op) {
1121 writeOperand(I.getOperand(op), true);
1124 Out << " )\n\t\t\tto";
1125 writeOperand(II->getNormalDest(), true);
1127 writeOperand(II->getUnwindDest(), true);
1129 } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
1131 printType(AI->getType()->getElementType());
1132 if (AI->isArrayAllocation()) {
1134 writeOperand(AI->getArraySize(), true);
1136 } else if (isa<CastInst>(I)) {
1137 if (Operand) writeOperand(Operand, true); // Work with broken code
1139 printType(I.getType());
1140 } else if (isa<VAArgInst>(I)) {
1141 if (Operand) writeOperand(Operand, true); // Work with broken code
1143 printType(I.getType());
1144 } else if (const VANextInst *VAN = dyn_cast<VANextInst>(&I)) {
1145 if (Operand) writeOperand(Operand, true); // Work with broken code
1147 printType(VAN->getArgType());
1148 } else if (Operand) { // Print the normal way...
1150 // PrintAllTypes - Instructions who have operands of all the same type
1151 // omit the type from all but the first operand. If the instruction has
1152 // different type operands (for example br), then they are all printed.
1153 bool PrintAllTypes = false;
1154 const Type *TheType = Operand->getType();
1156 // Shift Left & Right print both types even for Ubyte LHS, and select prints
1157 // types even if all operands are bools.
1158 if (isa<ShiftInst>(I) || isa<SelectInst>(I)) {
1159 PrintAllTypes = true;
1161 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
1162 Operand = I.getOperand(i);
1163 if (Operand->getType() != TheType) {
1164 PrintAllTypes = true; // We have differing types! Print them all!
1170 if (!PrintAllTypes) {
1175 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
1177 writeOperand(I.getOperand(i), PrintAllTypes);
1181 printInfoComment(I);
1186 //===----------------------------------------------------------------------===//
1187 // External Interface declarations
1188 //===----------------------------------------------------------------------===//
1190 void Module::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1191 SlotMachine SlotTable(this);
1192 AssemblyWriter W(o, SlotTable, this, AAW);
1196 void GlobalVariable::print(std::ostream &o) const {
1197 SlotMachine SlotTable(getParent());
1198 AssemblyWriter W(o, SlotTable, getParent(), 0);
1202 void Function::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1203 SlotMachine SlotTable(getParent());
1204 AssemblyWriter W(o, SlotTable, getParent(), AAW);
1209 void BasicBlock::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1210 SlotMachine SlotTable(getParent());
1211 AssemblyWriter W(o, SlotTable,
1212 getParent() ? getParent()->getParent() : 0, AAW);
1216 void Instruction::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1217 const Function *F = getParent() ? getParent()->getParent() : 0;
1218 SlotMachine SlotTable(F);
1219 AssemblyWriter W(o, SlotTable, F ? F->getParent() : 0, AAW);
1224 void Constant::print(std::ostream &o) const {
1225 if (this == 0) { o << "<null> constant value\n"; return; }
1227 o << ' ' << getType()->getDescription() << ' ';
1229 std::map<const Type *, std::string> TypeTable;
1230 WriteConstantInt(o, this, false, TypeTable, 0);
1233 void Type::print(std::ostream &o) const {
1237 o << getDescription();
1240 void Argument::print(std::ostream &o) const {
1241 WriteAsOperand(o, this, true, true,
1242 getParent() ? getParent()->getParent() : 0);
1245 // Value::dump - allow easy printing of Values from the debugger.
1246 // Located here because so much of the needed functionality is here.
1247 void Value::dump() const { print(std::cerr); }
1249 // Type::dump - allow easy printing of Values from the debugger.
1250 // Located here because so much of the needed functionality is here.
1251 void Type::dump() const { print(std::cerr); }
1253 //===----------------------------------------------------------------------===//
1254 // CachedWriter Class Implementation
1255 //===----------------------------------------------------------------------===//
1257 void CachedWriter::setModule(const Module *M) {
1258 delete SC; delete AW;
1260 SC = new SlotMachine(M );
1261 AW = new AssemblyWriter(Out, *SC, M, 0);
1267 CachedWriter::~CachedWriter() {
1272 CachedWriter &CachedWriter::operator<<(const Value &V) {
1273 assert(AW && SC && "CachedWriter does not have a current module!");
1274 if (const Instruction *I = dyn_cast<Instruction>(&V))
1276 else if (const BasicBlock *BB = dyn_cast<BasicBlock>(&V))
1278 else if (const Function *F = dyn_cast<Function>(&V))
1280 else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(&V))
1283 AW->writeOperand(&V, true, true);
1287 CachedWriter& CachedWriter::operator<<(const Type &Ty) {
1288 if (SymbolicTypes) {
1289 const Module *M = AW->getModule();
1290 if (M) WriteTypeSymbolic(Out, &Ty, M);
1297 //===----------------------------------------------------------------------===//
1298 //===-- SlotMachine Implementation
1299 //===----------------------------------------------------------------------===//
1302 #define SC_DEBUG(X) std::cerr << X
1307 // Module level constructor. Causes the contents of the Module (sans functions)
1308 // to be added to the slot table.
1309 SlotMachine::SlotMachine(const Module *M)
1310 : TheModule(M) ///< Saved for lazy initialization.
1312 , FunctionProcessed(false)
1320 // Function level constructor. Causes the contents of the Module and the one
1321 // function provided to be added to the slot table.
1322 SlotMachine::SlotMachine(const Function *F )
1323 : TheModule( F ? F->getParent() : 0 ) ///< Saved for lazy initialization
1324 , TheFunction(F) ///< Saved for lazy initialization
1325 , FunctionProcessed(false)
1333 inline void SlotMachine::initialize(void) {
1336 TheModule = 0; ///< Prevent re-processing next time we're called.
1338 if ( TheFunction && ! FunctionProcessed) {
1343 // Iterate through all the global variables, functions, and global
1344 // variable initializers and create slots for them.
1345 void SlotMachine::processModule() {
1346 SC_DEBUG("begin processModule!\n");
1348 // Add all of the global variables to the value table...
1349 for (Module::const_giterator I = TheModule->gbegin(), E = TheModule->gend();
1353 // Add all the functions to the table
1354 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
1358 SC_DEBUG("end processModule!\n");
1362 // Process the arguments, basic blocks, and instructions of a function.
1363 void SlotMachine::processFunction() {
1364 SC_DEBUG("begin processFunction!\n");
1366 // Add all the function arguments
1367 for(Function::const_aiterator AI = TheFunction->abegin(),
1368 AE = TheFunction->aend(); AI != AE; ++AI)
1371 SC_DEBUG("Inserting Instructions:\n");
1373 // Add all of the basic blocks and instructions
1374 for (Function::const_iterator BB = TheFunction->begin(),
1375 E = TheFunction->end(); BB != E; ++BB) {
1377 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I!=E; ++I) {
1382 FunctionProcessed = true;
1384 SC_DEBUG("end processFunction!\n");
1387 // Clean up after incorporating a function. This is the only way
1388 // to get out of the function incorporation state that affects the
1389 // getSlot/createSlot lock. Function incorporation state is indicated
1390 // by TheFunction != 0.
1391 void SlotMachine::purgeFunction() {
1392 SC_DEBUG("begin purgeFunction!\n");
1393 fMap.clear(); // Simply discard the function level map
1396 FunctionProcessed = false;
1397 SC_DEBUG("end purgeFunction!\n");
1400 /// Get the slot number for a value. This function will assert if you
1401 /// ask for a Value that hasn't previously been inserted with createSlot.
1402 /// Types are forbidden because Type does not inherit from Value (any more).
1403 int SlotMachine::getSlot(const Value *V) {
1404 assert( V && "Can't get slot for null Value" );
1405 assert(!isa<Constant>(V) || isa<GlobalValue>(V) &&
1406 "Can't insert a non-GlobalValue Constant into SlotMachine");
1408 // Check for uninitialized state and do lazy initialization
1411 // Get the type of the value
1412 const Type* VTy = V->getType();
1414 // Find the type plane in the module map
1415 TypedPlanes::const_iterator MI = mMap.find(VTy);
1417 if ( TheFunction ) {
1418 // Lookup the type in the function map too
1419 TypedPlanes::const_iterator FI = fMap.find(VTy);
1420 // If there is a corresponding type plane in the function map
1421 if ( FI != fMap.end() ) {
1422 // Lookup the Value in the function map
1423 ValueMap::const_iterator FVI = FI->second.map.find(V);
1424 // If the value doesn't exist in the function map
1425 if ( FVI == FI->second.map.end() ) {
1426 // Look up the value in the module map.
1427 if (MI == mMap.end()) return -1;
1428 ValueMap::const_iterator MVI = MI->second.map.find(V);
1429 // If we didn't find it, it wasn't inserted
1430 if (MVI == MI->second.map.end()) return -1;
1431 assert( MVI != MI->second.map.end() && "Value not found");
1432 // We found it only at the module level
1435 // else the value exists in the function map
1437 // Return the slot number as the module's contribution to
1438 // the type plane plus the index in the function's contribution
1439 // to the type plane.
1440 if (MI != mMap.end())
1441 return MI->second.next_slot + FVI->second;
1448 // N.B. Can get here only if either !TheFunction or the function doesn't
1449 // have a corresponding type plane for the Value
1451 // Make sure the type plane exists
1452 if (MI == mMap.end()) return -1;
1453 // Lookup the value in the module's map
1454 ValueMap::const_iterator MVI = MI->second.map.find(V);
1455 // Make sure we found it.
1456 if (MVI == MI->second.map.end()) return -1;
1461 /// Get the slot number for a value. This function will assert if you
1462 /// ask for a Value that hasn't previously been inserted with createSlot.
1463 /// Types are forbidden because Type does not inherit from Value (any more).
1464 int SlotMachine::getSlot(const Type *Ty) {
1465 assert( Ty && "Can't get slot for null Type" );
1467 // Check for uninitialized state and do lazy initialization
1470 if ( TheFunction ) {
1471 // Lookup the Type in the function map
1472 TypeMap::const_iterator FTI = fTypes.map.find(Ty);
1473 // If the Type doesn't exist in the function map
1474 if ( FTI == fTypes.map.end() ) {
1475 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1476 // If we didn't find it, it wasn't inserted
1477 if (MTI == mTypes.map.end())
1479 // We found it only at the module level
1482 // else the value exists in the function map
1484 // Return the slot number as the module's contribution to
1485 // the type plane plus the index in the function's contribution
1486 // to the type plane.
1487 return mTypes.next_slot + FTI->second;
1491 // N.B. Can get here only if either !TheFunction
1493 // Lookup the value in the module's map
1494 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1495 // Make sure we found it.
1496 if (MTI == mTypes.map.end()) return -1;
1501 // Create a new slot, or return the existing slot if it is already
1502 // inserted. Note that the logic here parallels getSlot but instead
1503 // of asserting when the Value* isn't found, it inserts the value.
1504 unsigned SlotMachine::createSlot(const Value *V) {
1505 assert( V && "Can't insert a null Value to SlotMachine");
1506 assert(!isa<Constant>(V) || isa<GlobalValue>(V) &&
1507 "Can't insert a non-GlobalValue Constant into SlotMachine");
1509 const Type* VTy = V->getType();
1511 // Just ignore void typed things
1512 if (VTy == Type::VoidTy) return 0; // FIXME: Wrong return value!
1514 // Look up the type plane for the Value's type from the module map
1515 TypedPlanes::const_iterator MI = mMap.find(VTy);
1517 if ( TheFunction ) {
1518 // Get the type plane for the Value's type from the function map
1519 TypedPlanes::const_iterator FI = fMap.find(VTy);
1520 // If there is a corresponding type plane in the function map
1521 if ( FI != fMap.end() ) {
1522 // Lookup the Value in the function map
1523 ValueMap::const_iterator FVI = FI->second.map.find(V);
1524 // If the value doesn't exist in the function map
1525 if ( FVI == FI->second.map.end() ) {
1526 // If there is no corresponding type plane in the module map
1527 if ( MI == mMap.end() )
1528 return insertValue(V);
1529 // Look up the value in the module map
1530 ValueMap::const_iterator MVI = MI->second.map.find(V);
1531 // If we didn't find it, it wasn't inserted
1532 if ( MVI == MI->second.map.end() )
1533 return insertValue(V);
1535 // We found it only at the module level
1538 // else the value exists in the function map
1540 if ( MI == mMap.end() )
1543 // Return the slot number as the module's contribution to
1544 // the type plane plus the index in the function's contribution
1545 // to the type plane.
1546 return MI->second.next_slot + FVI->second;
1549 // else there is not a corresponding type plane in the function map
1551 // If the type plane doesn't exists at the module level
1552 if ( MI == mMap.end() ) {
1553 return insertValue(V);
1554 // else type plane exists at the module level, examine it
1556 // Look up the value in the module's map
1557 ValueMap::const_iterator MVI = MI->second.map.find(V);
1558 // If we didn't find it there either
1559 if ( MVI == MI->second.map.end() )
1560 // Return the slot number as the module's contribution to
1561 // the type plane plus the index of the function map insertion.
1562 return MI->second.next_slot + insertValue(V);
1569 // N.B. Can only get here if !TheFunction
1571 // If the module map's type plane is not for the Value's type
1572 if ( MI != mMap.end() ) {
1573 // Lookup the value in the module's map
1574 ValueMap::const_iterator MVI = MI->second.map.find(V);
1575 if ( MVI != MI->second.map.end() )
1579 return insertValue(V);
1582 // Create a new slot, or return the existing slot if it is already
1583 // inserted. Note that the logic here parallels getSlot but instead
1584 // of asserting when the Value* isn't found, it inserts the value.
1585 unsigned SlotMachine::createSlot(const Type *Ty) {
1586 assert( Ty && "Can't insert a null Type to SlotMachine");
1588 if ( TheFunction ) {
1589 // Lookup the Type in the function map
1590 TypeMap::const_iterator FTI = fTypes.map.find(Ty);
1591 // If the type doesn't exist in the function map
1592 if ( FTI == fTypes.map.end() ) {
1593 // Look up the type in the module map
1594 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1595 // If we didn't find it, it wasn't inserted
1596 if ( MTI == mTypes.map.end() )
1597 return insertValue(Ty);
1599 // We found it only at the module level
1602 // else the value exists in the function map
1604 // Return the slot number as the module's contribution to
1605 // the type plane plus the index in the function's contribution
1606 // to the type plane.
1607 return mTypes.next_slot + FTI->second;
1611 // N.B. Can only get here if !TheFunction
1613 // Lookup the type in the module's map
1614 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1615 if ( MTI != mTypes.map.end() )
1618 return insertValue(Ty);
1621 // Low level insert function. Minimal checking is done. This
1622 // function is just for the convenience of createSlot (above).
1623 unsigned SlotMachine::insertValue(const Value *V ) {
1624 assert(V && "Can't insert a null Value into SlotMachine!");
1625 assert(!isa<Constant>(V) || isa<GlobalValue>(V) &&
1626 "Can't insert a non-GlobalValue Constant into SlotMachine");
1628 // If this value does not contribute to a plane (is void)
1629 // or if the value already has a name then ignore it.
1630 if (V->getType() == Type::VoidTy || V->hasName() ) {
1631 SC_DEBUG("ignored value " << *V << "\n");
1632 return 0; // FIXME: Wrong return value
1635 const Type *VTy = V->getType();
1636 unsigned DestSlot = 0;
1638 if ( TheFunction ) {
1639 TypedPlanes::iterator I = fMap.find( VTy );
1640 if ( I == fMap.end() )
1641 I = fMap.insert(std::make_pair(VTy,ValuePlane())).first;
1642 DestSlot = I->second.map[V] = I->second.next_slot++;
1644 TypedPlanes::iterator I = mMap.find( VTy );
1645 if ( I == mMap.end() )
1646 I = mMap.insert(std::make_pair(VTy,ValuePlane())).first;
1647 DestSlot = I->second.map[V] = I->second.next_slot++;
1650 SC_DEBUG(" Inserting value [" << VTy << "] = " << V << " slot=" <<
1652 // G = Global, C = Constant, T = Type, F = Function, o = other
1653 SC_DEBUG((isa<GlobalVariable>(V) ? 'G' : (isa<Function>(V) ? 'F' :
1654 (isa<Constant>(V) ? 'C' : 'o'))));
1659 // Low level insert function. Minimal checking is done. This
1660 // function is just for the convenience of createSlot (above).
1661 unsigned SlotMachine::insertValue(const Type *Ty ) {
1662 assert(Ty && "Can't insert a null Type into SlotMachine!");
1664 unsigned DestSlot = 0;
1666 if ( TheFunction ) {
1667 DestSlot = fTypes.map[Ty] = fTypes.next_slot++;
1669 DestSlot = fTypes.map[Ty] = fTypes.next_slot++;
1671 SC_DEBUG(" Inserting type [" << DestSlot << "] = " << Ty << "\n");