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 (isa<UndefValue>(CV)) {
524 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
525 Out << CE->getOpcodeName() << " (";
527 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
528 printTypeInt(Out, (*OI)->getType(), TypeTable);
529 WriteAsOperandInternal(Out, *OI, PrintName, TypeTable, Machine);
530 if (OI+1 != CE->op_end())
534 if (CE->getOpcode() == Instruction::Cast) {
536 printTypeInt(Out, CE->getType(), TypeTable);
541 Out << "<placeholder or erroneous Constant>";
546 /// WriteAsOperand - Write the name of the specified value out to the specified
547 /// ostream. This can be useful when you just want to print int %reg126, not
548 /// the whole instruction that generated it.
550 static void WriteAsOperandInternal(std::ostream &Out, const Value *V,
552 std::map<const Type*, std::string> &TypeTable,
553 SlotMachine *Machine) {
555 if ((PrintName || isa<GlobalValue>(V)) && V->hasName())
556 Out << getLLVMName(V->getName());
558 const Constant *CV = dyn_cast<Constant>(V);
559 if (CV && !isa<GlobalValue>(CV))
560 WriteConstantInt(Out, CV, PrintName, TypeTable, Machine);
564 Slot = Machine->getSlot(V);
566 Machine = createSlotMachine(V);
568 Slot = Machine->getSlot(V);
581 /// WriteAsOperand - Write the name of the specified value out to the specified
582 /// ostream. This can be useful when you just want to print int %reg126, not
583 /// the whole instruction that generated it.
585 std::ostream &llvm::WriteAsOperand(std::ostream &Out, const Value *V,
586 bool PrintType, bool PrintName,
587 const Module *Context) {
588 std::map<const Type *, std::string> TypeNames;
589 if (Context == 0) Context = getModuleFromVal(V);
592 fillTypeNameTable(Context, TypeNames);
595 printTypeInt(Out, V->getType(), TypeNames);
597 WriteAsOperandInternal(Out, V, PrintName, TypeNames, 0);
601 /// WriteAsOperandInternal - Write the name of the specified value out to
602 /// the specified ostream. This can be useful when you just want to print
603 /// int %reg126, not the whole instruction that generated it.
605 static void WriteAsOperandInternal(std::ostream &Out, const Type *T,
607 std::map<const Type*, std::string> &TypeTable,
608 SlotMachine *Machine) {
612 Slot = Machine->getSlot(T);
618 Out << T->getDescription();
622 /// WriteAsOperand - Write the name of the specified value out to the specified
623 /// ostream. This can be useful when you just want to print int %reg126, not
624 /// the whole instruction that generated it.
626 std::ostream &llvm::WriteAsOperand(std::ostream &Out, const Type *Ty,
627 bool PrintType, bool PrintName,
628 const Module *Context) {
629 std::map<const Type *, std::string> TypeNames;
630 assert(Context != 0 && "Can't write types as operand without module context");
632 fillTypeNameTable(Context, TypeNames);
635 // printTypeInt(Out, V->getType(), TypeNames);
637 printTypeInt(Out, Ty, TypeNames);
639 WriteAsOperandInternal(Out, Ty, PrintName, TypeNames, 0);
645 class AssemblyWriter {
647 SlotMachine &Machine;
648 const Module *TheModule;
649 std::map<const Type *, std::string> TypeNames;
650 AssemblyAnnotationWriter *AnnotationWriter;
652 inline AssemblyWriter(std::ostream &o, SlotMachine &Mac, const Module *M,
653 AssemblyAnnotationWriter *AAW)
654 : Out(o), Machine(Mac), TheModule(M), AnnotationWriter(AAW) {
656 // If the module has a symbol table, take all global types and stuff their
657 // names into the TypeNames map.
659 fillTypeNameTable(M, TypeNames);
662 inline void write(const Module *M) { printModule(M); }
663 inline void write(const GlobalVariable *G) { printGlobal(G); }
664 inline void write(const Function *F) { printFunction(F); }
665 inline void write(const BasicBlock *BB) { printBasicBlock(BB); }
666 inline void write(const Instruction *I) { printInstruction(*I); }
667 inline void write(const Constant *CPV) { printConstant(CPV); }
668 inline void write(const Type *Ty) { printType(Ty); }
670 void writeOperand(const Value *Op, bool PrintType, bool PrintName = true);
672 const Module* getModule() { return TheModule; }
675 void printModule(const Module *M);
676 void printSymbolTable(const SymbolTable &ST);
677 void printConstant(const Constant *CPV);
678 void printGlobal(const GlobalVariable *GV);
679 void printFunction(const Function *F);
680 void printArgument(const Argument *FA);
681 void printBasicBlock(const BasicBlock *BB);
682 void printInstruction(const Instruction &I);
684 // printType - Go to extreme measures to attempt to print out a short,
685 // symbolic version of a type name.
687 std::ostream &printType(const Type *Ty) {
688 return printTypeInt(Out, Ty, TypeNames);
691 // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
692 // without considering any symbolic types that we may have equal to it.
694 std::ostream &printTypeAtLeastOneLevel(const Type *Ty);
696 // printInfoComment - Print a little comment after the instruction indicating
697 // which slot it occupies.
698 void printInfoComment(const Value &V);
700 } // end of llvm namespace
702 /// printTypeAtLeastOneLevel - Print out one level of the possibly complex type
703 /// without considering any symbolic types that we may have equal to it.
705 std::ostream &AssemblyWriter::printTypeAtLeastOneLevel(const Type *Ty) {
706 if (const FunctionType *FTy = dyn_cast<FunctionType>(Ty)) {
707 printType(FTy->getReturnType()) << " (";
708 for (FunctionType::param_iterator I = FTy->param_begin(),
709 E = FTy->param_end(); I != E; ++I) {
710 if (I != FTy->param_begin())
714 if (FTy->isVarArg()) {
715 if (FTy->getNumParams()) Out << ", ";
719 } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
721 for (StructType::element_iterator I = STy->element_begin(),
722 E = STy->element_end(); I != E; ++I) {
723 if (I != STy->element_begin())
728 } else if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
729 printType(PTy->getElementType()) << '*';
730 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
731 Out << '[' << ATy->getNumElements() << " x ";
732 printType(ATy->getElementType()) << ']';
733 } else if (const PackedType *PTy = dyn_cast<PackedType>(Ty)) {
734 Out << '<' << PTy->getNumElements() << " x ";
735 printType(PTy->getElementType()) << '>';
737 else if (const OpaqueType *OTy = dyn_cast<OpaqueType>(Ty)) {
740 if (!Ty->isPrimitiveType())
741 Out << "<unknown derived type>";
748 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType,
750 assert(Operand != 0 && "Illegal Operand");
751 if (PrintType) { Out << ' '; printType(Operand->getType()); }
752 WriteAsOperandInternal(Out, Operand, PrintName, TypeNames, &Machine);
756 void AssemblyWriter::printModule(const Module *M) {
757 switch (M->getEndianness()) {
758 case Module::LittleEndian: Out << "target endian = little\n"; break;
759 case Module::BigEndian: Out << "target endian = big\n"; break;
760 case Module::AnyEndianness: break;
762 switch (M->getPointerSize()) {
763 case Module::Pointer32: Out << "target pointersize = 32\n"; break;
764 case Module::Pointer64: Out << "target pointersize = 64\n"; break;
765 case Module::AnyPointerSize: break;
767 if (!M->getTargetTriple().empty())
768 Out << "target triple = \"" << M->getTargetTriple() << "\"\n";
770 // Loop over the dependent libraries and emit them.
771 Module::lib_iterator LI = M->lib_begin();
772 Module::lib_iterator LE = M->lib_end();
774 Out << "deplibs = [ ";
776 Out << '"' << *LI << '"';
784 // Loop over the symbol table, emitting all named constants.
785 printSymbolTable(M->getSymbolTable());
787 for (Module::const_giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
790 Out << "\nimplementation ; Functions:\n";
792 // Output all of the functions.
793 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
797 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
798 if (GV->hasName()) Out << getLLVMName(GV->getName()) << " = ";
800 if (!GV->hasInitializer())
803 switch (GV->getLinkage()) {
804 case GlobalValue::InternalLinkage: Out << "internal "; break;
805 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
806 case GlobalValue::WeakLinkage: Out << "weak "; break;
807 case GlobalValue::AppendingLinkage: Out << "appending "; break;
808 case GlobalValue::ExternalLinkage: break;
809 case GlobalValue::GhostLinkage:
810 std::cerr << "GhostLinkage not allowed in AsmWriter!\n";
814 Out << (GV->isConstant() ? "constant " : "global ");
815 printType(GV->getType()->getElementType());
817 if (GV->hasInitializer()) {
818 Constant* C = cast<Constant>(GV->getInitializer());
819 assert(C && "GlobalVar initializer isn't constant?");
820 writeOperand(GV->getInitializer(), false, isa<GlobalValue>(C));
823 printInfoComment(*GV);
828 // printSymbolTable - Run through symbol table looking for constants
829 // and types. Emit their declarations.
830 void AssemblyWriter::printSymbolTable(const SymbolTable &ST) {
833 for (SymbolTable::type_const_iterator TI = ST.type_begin();
834 TI != ST.type_end(); ++TI ) {
835 Out << "\t" << getLLVMName(TI->first) << " = type ";
837 // Make sure we print out at least one level of the type structure, so
838 // that we do not get %FILE = type %FILE
840 printTypeAtLeastOneLevel(TI->second) << "\n";
843 // Print the constants, in type plane order.
844 for (SymbolTable::plane_const_iterator PI = ST.plane_begin();
845 PI != ST.plane_end(); ++PI ) {
846 SymbolTable::value_const_iterator VI = ST.value_begin(PI->first);
847 SymbolTable::value_const_iterator VE = ST.value_end(PI->first);
849 for (; VI != VE; ++VI) {
850 const Value* V = VI->second;
851 const Constant *CPV = dyn_cast<Constant>(V) ;
852 if (CPV && !isa<GlobalValue>(V)) {
860 /// printConstant - Print out a constant pool entry...
862 void AssemblyWriter::printConstant(const Constant *CPV) {
863 // Don't print out unnamed constants, they will be inlined
864 if (!CPV->hasName()) return;
867 Out << "\t" << getLLVMName(CPV->getName()) << " =";
869 // Write the value out now...
870 writeOperand(CPV, true, false);
872 printInfoComment(*CPV);
876 /// printFunction - Print all aspects of a function.
878 void AssemblyWriter::printFunction(const Function *F) {
879 // Print out the return type and name...
882 if (AnnotationWriter) AnnotationWriter->emitFunctionAnnot(F, Out);
887 switch (F->getLinkage()) {
888 case GlobalValue::InternalLinkage: Out << "internal "; break;
889 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
890 case GlobalValue::WeakLinkage: Out << "weak "; break;
891 case GlobalValue::AppendingLinkage: Out << "appending "; break;
892 case GlobalValue::ExternalLinkage: break;
893 case GlobalValue::GhostLinkage:
894 std::cerr << "GhostLinkage not allowed in AsmWriter!\n";
898 printType(F->getReturnType()) << ' ';
899 if (!F->getName().empty())
900 Out << getLLVMName(F->getName());
904 Machine.incorporateFunction(F);
906 // Loop over the arguments, printing them...
907 const FunctionType *FT = F->getFunctionType();
909 for(Function::const_aiterator I = F->abegin(), E = F->aend(); I != E; ++I)
912 // Finish printing arguments...
913 if (FT->isVarArg()) {
914 if (FT->getNumParams()) Out << ", ";
915 Out << "..."; // Output varargs portion of signature!
919 if (F->isExternal()) {
924 // Output all of its basic blocks... for the function
925 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
931 Machine.purgeFunction();
934 /// printArgument - This member is called for every argument that is passed into
935 /// the function. Simply print it out
937 void AssemblyWriter::printArgument(const Argument *Arg) {
938 // Insert commas as we go... the first arg doesn't get a comma
939 if (Arg != &Arg->getParent()->afront()) Out << ", ";
942 printType(Arg->getType());
944 // Output name, if available...
946 Out << ' ' << getLLVMName(Arg->getName());
949 /// printBasicBlock - This member is called for each basic block in a method.
951 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
952 if (BB->hasName()) { // Print out the label if it exists...
953 Out << "\n" << BB->getName() << ':';
954 } else if (!BB->use_empty()) { // Don't print block # of no uses...
955 Out << "\n; <label>:";
956 int Slot = Machine.getSlot(BB);
963 if (BB->getParent() == 0)
964 Out << "\t\t; Error: Block without parent!";
966 if (BB != &BB->getParent()->front()) { // Not the entry block?
967 // Output predecessors for the block...
969 pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
972 Out << " No predecessors!";
975 writeOperand(*PI, false, true);
976 for (++PI; PI != PE; ++PI) {
978 writeOperand(*PI, false, true);
986 if (AnnotationWriter) AnnotationWriter->emitBasicBlockStartAnnot(BB, Out);
988 // Output all of the instructions in the basic block...
989 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
990 printInstruction(*I);
992 if (AnnotationWriter) AnnotationWriter->emitBasicBlockEndAnnot(BB, Out);
996 /// printInfoComment - Print a little comment after the instruction indicating
997 /// which slot it occupies.
999 void AssemblyWriter::printInfoComment(const Value &V) {
1000 if (V.getType() != Type::VoidTy) {
1002 printType(V.getType()) << '>';
1005 int SlotNum = Machine.getSlot(&V);
1009 Out << ':' << SlotNum; // Print out the def slot taken.
1011 Out << " [#uses=" << V.use_size() << ']'; // Output # uses
1015 /// printInstruction - This member is called for each Instruction in a function..
1017 void AssemblyWriter::printInstruction(const Instruction &I) {
1018 if (AnnotationWriter) AnnotationWriter->emitInstructionAnnot(&I, Out);
1022 // Print out name if it exists...
1024 Out << getLLVMName(I.getName()) << " = ";
1026 // If this is a volatile load or store, print out the volatile marker
1027 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
1028 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()))
1031 // Print out the opcode...
1032 Out << I.getOpcodeName();
1034 // Print out the type of the operands...
1035 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
1037 // Special case conditional branches to swizzle the condition out to the front
1038 if (isa<BranchInst>(I) && I.getNumOperands() > 1) {
1039 writeOperand(I.getOperand(2), true);
1041 writeOperand(Operand, true);
1043 writeOperand(I.getOperand(1), true);
1045 } else if (isa<SwitchInst>(I)) {
1046 // Special case switch statement to get formatting nice and correct...
1047 writeOperand(Operand , true); Out << ',';
1048 writeOperand(I.getOperand(1), true); Out << " [";
1050 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
1052 writeOperand(I.getOperand(op ), true); Out << ',';
1053 writeOperand(I.getOperand(op+1), true);
1056 } else if (isa<PHINode>(I)) {
1058 printType(I.getType());
1061 for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
1062 if (op) Out << ", ";
1064 writeOperand(I.getOperand(op ), false); Out << ',';
1065 writeOperand(I.getOperand(op+1), false); Out << " ]";
1067 } else if (isa<ReturnInst>(I) && !Operand) {
1069 } else if (isa<CallInst>(I)) {
1070 const PointerType *PTy = cast<PointerType>(Operand->getType());
1071 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1072 const Type *RetTy = FTy->getReturnType();
1074 // If possible, print out the short form of the call instruction. We can
1075 // only do this if the first argument is a pointer to a nonvararg function,
1076 // and if the return type is not a pointer to a function.
1078 if (!FTy->isVarArg() &&
1079 (!isa<PointerType>(RetTy) ||
1080 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1081 Out << ' '; printType(RetTy);
1082 writeOperand(Operand, false);
1084 writeOperand(Operand, true);
1087 if (I.getNumOperands() > 1) writeOperand(I.getOperand(1), true);
1088 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; ++op) {
1090 writeOperand(I.getOperand(op), true);
1094 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
1095 const PointerType *PTy = cast<PointerType>(Operand->getType());
1096 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
1097 const Type *RetTy = FTy->getReturnType();
1099 // If possible, print out the short form of the invoke instruction. We can
1100 // only do this if the first argument is a pointer to a nonvararg function,
1101 // and if the return type is not a pointer to a function.
1103 if (!FTy->isVarArg() &&
1104 (!isa<PointerType>(RetTy) ||
1105 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
1106 Out << ' '; printType(RetTy);
1107 writeOperand(Operand, false);
1109 writeOperand(Operand, true);
1113 if (I.getNumOperands() > 3) writeOperand(I.getOperand(3), true);
1114 for (unsigned op = 4, Eop = I.getNumOperands(); op < Eop; ++op) {
1116 writeOperand(I.getOperand(op), true);
1119 Out << " )\n\t\t\tto";
1120 writeOperand(II->getNormalDest(), true);
1122 writeOperand(II->getUnwindDest(), true);
1124 } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
1126 printType(AI->getType()->getElementType());
1127 if (AI->isArrayAllocation()) {
1129 writeOperand(AI->getArraySize(), true);
1131 } else if (isa<CastInst>(I)) {
1132 if (Operand) writeOperand(Operand, true); // Work with broken code
1134 printType(I.getType());
1135 } else if (isa<VAArgInst>(I)) {
1136 if (Operand) writeOperand(Operand, true); // Work with broken code
1138 printType(I.getType());
1139 } else if (const VANextInst *VAN = dyn_cast<VANextInst>(&I)) {
1140 if (Operand) writeOperand(Operand, true); // Work with broken code
1142 printType(VAN->getArgType());
1143 } else if (Operand) { // Print the normal way...
1145 // PrintAllTypes - Instructions who have operands of all the same type
1146 // omit the type from all but the first operand. If the instruction has
1147 // different type operands (for example br), then they are all printed.
1148 bool PrintAllTypes = false;
1149 const Type *TheType = Operand->getType();
1151 // Shift Left & Right print both types even for Ubyte LHS, and select prints
1152 // types even if all operands are bools.
1153 if (isa<ShiftInst>(I) || isa<SelectInst>(I)) {
1154 PrintAllTypes = true;
1156 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
1157 Operand = I.getOperand(i);
1158 if (Operand->getType() != TheType) {
1159 PrintAllTypes = true; // We have differing types! Print them all!
1165 if (!PrintAllTypes) {
1170 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
1172 writeOperand(I.getOperand(i), PrintAllTypes);
1176 printInfoComment(I);
1181 //===----------------------------------------------------------------------===//
1182 // External Interface declarations
1183 //===----------------------------------------------------------------------===//
1185 void Module::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1186 SlotMachine SlotTable(this);
1187 AssemblyWriter W(o, SlotTable, this, AAW);
1191 void GlobalVariable::print(std::ostream &o) const {
1192 SlotMachine SlotTable(getParent());
1193 AssemblyWriter W(o, SlotTable, getParent(), 0);
1197 void Function::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1198 SlotMachine SlotTable(getParent());
1199 AssemblyWriter W(o, SlotTable, getParent(), AAW);
1204 void BasicBlock::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1205 SlotMachine SlotTable(getParent());
1206 AssemblyWriter W(o, SlotTable,
1207 getParent() ? getParent()->getParent() : 0, AAW);
1211 void Instruction::print(std::ostream &o, AssemblyAnnotationWriter *AAW) const {
1212 const Function *F = getParent() ? getParent()->getParent() : 0;
1213 SlotMachine SlotTable(F);
1214 AssemblyWriter W(o, SlotTable, F ? F->getParent() : 0, AAW);
1219 void Constant::print(std::ostream &o) const {
1220 if (this == 0) { o << "<null> constant value\n"; return; }
1222 o << ' ' << getType()->getDescription() << ' ';
1224 std::map<const Type *, std::string> TypeTable;
1225 WriteConstantInt(o, this, false, TypeTable, 0);
1228 void Type::print(std::ostream &o) const {
1232 o << getDescription();
1235 void Argument::print(std::ostream &o) const {
1236 WriteAsOperand(o, this, true, true,
1237 getParent() ? getParent()->getParent() : 0);
1240 // Value::dump - allow easy printing of Values from the debugger.
1241 // Located here because so much of the needed functionality is here.
1242 void Value::dump() const { print(std::cerr); }
1244 // Type::dump - allow easy printing of Values from the debugger.
1245 // Located here because so much of the needed functionality is here.
1246 void Type::dump() const { print(std::cerr); }
1248 //===----------------------------------------------------------------------===//
1249 // CachedWriter Class Implementation
1250 //===----------------------------------------------------------------------===//
1252 void CachedWriter::setModule(const Module *M) {
1253 delete SC; delete AW;
1255 SC = new SlotMachine(M );
1256 AW = new AssemblyWriter(Out, *SC, M, 0);
1262 CachedWriter::~CachedWriter() {
1267 CachedWriter &CachedWriter::operator<<(const Value &V) {
1268 assert(AW && SC && "CachedWriter does not have a current module!");
1269 if (const Instruction *I = dyn_cast<Instruction>(&V))
1271 else if (const BasicBlock *BB = dyn_cast<BasicBlock>(&V))
1273 else if (const Function *F = dyn_cast<Function>(&V))
1275 else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(&V))
1278 AW->writeOperand(&V, true, true);
1282 CachedWriter& CachedWriter::operator<<(const Type &Ty) {
1283 if (SymbolicTypes) {
1284 const Module *M = AW->getModule();
1285 if (M) WriteTypeSymbolic(Out, &Ty, M);
1292 //===----------------------------------------------------------------------===//
1293 //===-- SlotMachine Implementation
1294 //===----------------------------------------------------------------------===//
1297 #define SC_DEBUG(X) std::cerr << X
1302 // Module level constructor. Causes the contents of the Module (sans functions)
1303 // to be added to the slot table.
1304 SlotMachine::SlotMachine(const Module *M)
1305 : TheModule(M) ///< Saved for lazy initialization.
1307 , FunctionProcessed(false)
1315 // Function level constructor. Causes the contents of the Module and the one
1316 // function provided to be added to the slot table.
1317 SlotMachine::SlotMachine(const Function *F )
1318 : TheModule( F ? F->getParent() : 0 ) ///< Saved for lazy initialization
1319 , TheFunction(F) ///< Saved for lazy initialization
1320 , FunctionProcessed(false)
1328 inline void SlotMachine::initialize(void) {
1331 TheModule = 0; ///< Prevent re-processing next time we're called.
1333 if ( TheFunction && ! FunctionProcessed) {
1338 // Iterate through all the global variables, functions, and global
1339 // variable initializers and create slots for them.
1340 void SlotMachine::processModule() {
1341 SC_DEBUG("begin processModule!\n");
1343 // Add all of the global variables to the value table...
1344 for (Module::const_giterator I = TheModule->gbegin(), E = TheModule->gend();
1348 // Add all the functions to the table
1349 for (Module::const_iterator I = TheModule->begin(), E = TheModule->end();
1353 SC_DEBUG("end processModule!\n");
1357 // Process the arguments, basic blocks, and instructions of a function.
1358 void SlotMachine::processFunction() {
1359 SC_DEBUG("begin processFunction!\n");
1361 // Add all the function arguments
1362 for(Function::const_aiterator AI = TheFunction->abegin(),
1363 AE = TheFunction->aend(); AI != AE; ++AI)
1366 SC_DEBUG("Inserting Instructions:\n");
1368 // Add all of the basic blocks and instructions
1369 for (Function::const_iterator BB = TheFunction->begin(),
1370 E = TheFunction->end(); BB != E; ++BB) {
1372 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I!=E; ++I) {
1377 FunctionProcessed = true;
1379 SC_DEBUG("end processFunction!\n");
1382 // Clean up after incorporating a function. This is the only way
1383 // to get out of the function incorporation state that affects the
1384 // getSlot/createSlot lock. Function incorporation state is indicated
1385 // by TheFunction != 0.
1386 void SlotMachine::purgeFunction() {
1387 SC_DEBUG("begin purgeFunction!\n");
1388 fMap.clear(); // Simply discard the function level map
1391 FunctionProcessed = false;
1392 SC_DEBUG("end purgeFunction!\n");
1395 /// Get the slot number for a value. This function will assert if you
1396 /// ask for a Value that hasn't previously been inserted with createSlot.
1397 /// Types are forbidden because Type does not inherit from Value (any more).
1398 int SlotMachine::getSlot(const Value *V) {
1399 assert( V && "Can't get slot for null Value" );
1400 assert(!isa<Constant>(V) || isa<GlobalValue>(V) &&
1401 "Can't insert a non-GlobalValue Constant into SlotMachine");
1403 // Check for uninitialized state and do lazy initialization
1406 // Get the type of the value
1407 const Type* VTy = V->getType();
1409 // Find the type plane in the module map
1410 TypedPlanes::const_iterator MI = mMap.find(VTy);
1412 if ( TheFunction ) {
1413 // Lookup the type in the function map too
1414 TypedPlanes::const_iterator FI = fMap.find(VTy);
1415 // If there is a corresponding type plane in the function map
1416 if ( FI != fMap.end() ) {
1417 // Lookup the Value in the function map
1418 ValueMap::const_iterator FVI = FI->second.map.find(V);
1419 // If the value doesn't exist in the function map
1420 if ( FVI == FI->second.map.end() ) {
1421 // Look up the value in the module map.
1422 if (MI == mMap.end()) return -1;
1423 ValueMap::const_iterator MVI = MI->second.map.find(V);
1424 // If we didn't find it, it wasn't inserted
1425 if (MVI == MI->second.map.end()) return -1;
1426 assert( MVI != MI->second.map.end() && "Value not found");
1427 // We found it only at the module level
1430 // else the value exists in the function map
1432 // Return the slot number as the module's contribution to
1433 // the type plane plus the index in the function's contribution
1434 // to the type plane.
1435 if (MI != mMap.end())
1436 return MI->second.next_slot + FVI->second;
1443 // N.B. Can get here only if either !TheFunction or the function doesn't
1444 // have a corresponding type plane for the Value
1446 // Make sure the type plane exists
1447 if (MI == mMap.end()) return -1;
1448 // Lookup the value in the module's map
1449 ValueMap::const_iterator MVI = MI->second.map.find(V);
1450 // Make sure we found it.
1451 if (MVI == MI->second.map.end()) return -1;
1456 /// Get the slot number for a value. This function will assert if you
1457 /// ask for a Value that hasn't previously been inserted with createSlot.
1458 /// Types are forbidden because Type does not inherit from Value (any more).
1459 int SlotMachine::getSlot(const Type *Ty) {
1460 assert( Ty && "Can't get slot for null Type" );
1462 // Check for uninitialized state and do lazy initialization
1465 if ( TheFunction ) {
1466 // Lookup the Type in the function map
1467 TypeMap::const_iterator FTI = fTypes.map.find(Ty);
1468 // If the Type doesn't exist in the function map
1469 if ( FTI == fTypes.map.end() ) {
1470 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1471 // If we didn't find it, it wasn't inserted
1472 if (MTI == mTypes.map.end())
1474 // We found it only at the module level
1477 // else the value exists in the function map
1479 // Return the slot number as the module's contribution to
1480 // the type plane plus the index in the function's contribution
1481 // to the type plane.
1482 return mTypes.next_slot + FTI->second;
1486 // N.B. Can get here only if either !TheFunction
1488 // Lookup the value in the module's map
1489 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1490 // Make sure we found it.
1491 if (MTI == mTypes.map.end()) return -1;
1496 // Create a new slot, or return the existing slot if it is already
1497 // inserted. Note that the logic here parallels getSlot but instead
1498 // of asserting when the Value* isn't found, it inserts the value.
1499 unsigned SlotMachine::createSlot(const Value *V) {
1500 assert( V && "Can't insert a null Value to SlotMachine");
1501 assert(!isa<Constant>(V) || isa<GlobalValue>(V) &&
1502 "Can't insert a non-GlobalValue Constant into SlotMachine");
1504 const Type* VTy = V->getType();
1506 // Just ignore void typed things
1507 if (VTy == Type::VoidTy) return 0; // FIXME: Wrong return value!
1509 // Look up the type plane for the Value's type from the module map
1510 TypedPlanes::const_iterator MI = mMap.find(VTy);
1512 if ( TheFunction ) {
1513 // Get the type plane for the Value's type from the function map
1514 TypedPlanes::const_iterator FI = fMap.find(VTy);
1515 // If there is a corresponding type plane in the function map
1516 if ( FI != fMap.end() ) {
1517 // Lookup the Value in the function map
1518 ValueMap::const_iterator FVI = FI->second.map.find(V);
1519 // If the value doesn't exist in the function map
1520 if ( FVI == FI->second.map.end() ) {
1521 // If there is no corresponding type plane in the module map
1522 if ( MI == mMap.end() )
1523 return insertValue(V);
1524 // Look up the value in the module map
1525 ValueMap::const_iterator MVI = MI->second.map.find(V);
1526 // If we didn't find it, it wasn't inserted
1527 if ( MVI == MI->second.map.end() )
1528 return insertValue(V);
1530 // We found it only at the module level
1533 // else the value exists in the function map
1535 if ( MI == mMap.end() )
1538 // Return the slot number as the module's contribution to
1539 // the type plane plus the index in the function's contribution
1540 // to the type plane.
1541 return MI->second.next_slot + FVI->second;
1544 // else there is not a corresponding type plane in the function map
1546 // If the type plane doesn't exists at the module level
1547 if ( MI == mMap.end() ) {
1548 return insertValue(V);
1549 // else type plane exists at the module level, examine it
1551 // Look up the value in the module's map
1552 ValueMap::const_iterator MVI = MI->second.map.find(V);
1553 // If we didn't find it there either
1554 if ( MVI == MI->second.map.end() )
1555 // Return the slot number as the module's contribution to
1556 // the type plane plus the index of the function map insertion.
1557 return MI->second.next_slot + insertValue(V);
1564 // N.B. Can only get here if !TheFunction
1566 // If the module map's type plane is not for the Value's type
1567 if ( MI != mMap.end() ) {
1568 // Lookup the value in the module's map
1569 ValueMap::const_iterator MVI = MI->second.map.find(V);
1570 if ( MVI != MI->second.map.end() )
1574 return insertValue(V);
1577 // Create a new slot, or return the existing slot if it is already
1578 // inserted. Note that the logic here parallels getSlot but instead
1579 // of asserting when the Value* isn't found, it inserts the value.
1580 unsigned SlotMachine::createSlot(const Type *Ty) {
1581 assert( Ty && "Can't insert a null Type to SlotMachine");
1583 if ( TheFunction ) {
1584 // Lookup the Type in the function map
1585 TypeMap::const_iterator FTI = fTypes.map.find(Ty);
1586 // If the type doesn't exist in the function map
1587 if ( FTI == fTypes.map.end() ) {
1588 // Look up the type in the module map
1589 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1590 // If we didn't find it, it wasn't inserted
1591 if ( MTI == mTypes.map.end() )
1592 return insertValue(Ty);
1594 // We found it only at the module level
1597 // else the value exists in the function map
1599 // Return the slot number as the module's contribution to
1600 // the type plane plus the index in the function's contribution
1601 // to the type plane.
1602 return mTypes.next_slot + FTI->second;
1606 // N.B. Can only get here if !TheFunction
1608 // Lookup the type in the module's map
1609 TypeMap::const_iterator MTI = mTypes.map.find(Ty);
1610 if ( MTI != mTypes.map.end() )
1613 return insertValue(Ty);
1616 // Low level insert function. Minimal checking is done. This
1617 // function is just for the convenience of createSlot (above).
1618 unsigned SlotMachine::insertValue(const Value *V ) {
1619 assert(V && "Can't insert a null Value into SlotMachine!");
1620 assert(!isa<Constant>(V) || isa<GlobalValue>(V) &&
1621 "Can't insert a non-GlobalValue Constant into SlotMachine");
1623 // If this value does not contribute to a plane (is void)
1624 // or if the value already has a name then ignore it.
1625 if (V->getType() == Type::VoidTy || V->hasName() ) {
1626 SC_DEBUG("ignored value " << *V << "\n");
1627 return 0; // FIXME: Wrong return value
1630 const Type *VTy = V->getType();
1631 unsigned DestSlot = 0;
1633 if ( TheFunction ) {
1634 TypedPlanes::iterator I = fMap.find( VTy );
1635 if ( I == fMap.end() )
1636 I = fMap.insert(std::make_pair(VTy,ValuePlane())).first;
1637 DestSlot = I->second.map[V] = I->second.next_slot++;
1639 TypedPlanes::iterator I = mMap.find( VTy );
1640 if ( I == mMap.end() )
1641 I = mMap.insert(std::make_pair(VTy,ValuePlane())).first;
1642 DestSlot = I->second.map[V] = I->second.next_slot++;
1645 SC_DEBUG(" Inserting value [" << VTy << "] = " << V << " slot=" <<
1647 // G = Global, C = Constant, T = Type, F = Function, o = other
1648 SC_DEBUG((isa<GlobalVariable>(V) ? 'G' : (isa<Function>(V) ? 'F' :
1649 (isa<Constant>(V) ? 'C' : 'o'))));
1654 // Low level insert function. Minimal checking is done. This
1655 // function is just for the convenience of createSlot (above).
1656 unsigned SlotMachine::insertValue(const Type *Ty ) {
1657 assert(Ty && "Can't insert a null Type into SlotMachine!");
1659 unsigned DestSlot = 0;
1661 if ( TheFunction ) {
1662 DestSlot = fTypes.map[Ty] = fTypes.next_slot++;
1664 DestSlot = fTypes.map[Ty] = fTypes.next_slot++;
1666 SC_DEBUG(" Inserting type [" << DestSlot << "] = " << Ty << "\n");