1 //===-- AsmWriter.cpp - Printing LLVM as an assembly file -----------------===//
3 // This library implements the functionality defined in llvm/Assembly/Writer.h
5 // Note that these routines must be extremely tolerant of various errors in the
6 // LLVM code, because it can be used for debugging transformations.
8 //===----------------------------------------------------------------------===//
10 #include "llvm/Assembly/CachedWriter.h"
11 #include "llvm/Assembly/Writer.h"
12 #include "llvm/Assembly/PrintModulePass.h"
13 #include "llvm/SlotCalculator.h"
14 #include "llvm/DerivedTypes.h"
15 #include "llvm/Instruction.h"
16 #include "llvm/Module.h"
17 #include "llvm/Constants.h"
18 #include "llvm/iMemory.h"
19 #include "llvm/iTerminators.h"
20 #include "llvm/iPHINode.h"
21 #include "llvm/iOther.h"
22 #include "llvm/SymbolTable.h"
23 #include "llvm/Support/CFG.h"
24 #include "Support/StringExtras.h"
25 #include "Support/STLExtras.h"
28 static RegisterPass<PrintModulePass>
29 X("printm", "Print module to stderr",PassInfo::Analysis|PassInfo::Optimization);
30 static RegisterPass<PrintFunctionPass>
31 Y("print","Print function to stderr",PassInfo::Analysis|PassInfo::Optimization);
33 static void WriteAsOperandInternal(std::ostream &Out, const Value *V,
35 std::map<const Type *, std::string> &TypeTable,
36 SlotCalculator *Table);
38 static const Module *getModuleFromVal(const Value *V) {
39 if (const Argument *MA = dyn_cast<Argument>(V))
40 return MA->getParent() ? MA->getParent()->getParent() : 0;
41 else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V))
42 return BB->getParent() ? BB->getParent()->getParent() : 0;
43 else if (const Instruction *I = dyn_cast<Instruction>(V)) {
44 const Function *M = I->getParent() ? I->getParent()->getParent() : 0;
45 return M ? M->getParent() : 0;
46 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
47 return GV->getParent();
51 static SlotCalculator *createSlotCalculator(const Value *V) {
52 assert(!isa<Type>(V) && "Can't create an SC for a type!");
53 if (const Argument *FA = dyn_cast<Argument>(V)) {
54 return new SlotCalculator(FA->getParent(), true);
55 } else if (const Instruction *I = dyn_cast<Instruction>(V)) {
56 return new SlotCalculator(I->getParent()->getParent(), true);
57 } else if (const BasicBlock *BB = dyn_cast<BasicBlock>(V)) {
58 return new SlotCalculator(BB->getParent(), true);
59 } else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V)){
60 return new SlotCalculator(GV->getParent(), true);
61 } else if (const Function *Func = dyn_cast<Function>(V)) {
62 return new SlotCalculator(Func, true);
67 // getLLVMName - Turn the specified string into an 'LLVM name', which is either
68 // prefixed with % (if the string only contains simple characters) or is
69 // surrounded with ""'s (if it has special chars in it).
70 static std::string getLLVMName(const std::string &Name) {
71 assert(!Name.empty() && "Cannot get empty name!");
73 // First character cannot start with a number...
74 if (Name[0] >= '0' && Name[0] <= '9')
75 return "\"" + Name + "\"";
77 // Scan to see if we have any characters that are not on the "white list"
78 for (unsigned i = 0, e = Name.size(); i != e; ++i) {
80 assert(C != '"' && "Illegal character in LLVM value name!");
81 if ((C < 'a' || C > 'z') && (C < 'A' || C > 'Z') && (C < '0' || C > '9') &&
82 C != '-' && C != '.' && C != '_')
83 return "\"" + Name + "\"";
86 // If we get here, then the identifier is legal to use as a "VarID".
91 // If the module has a symbol table, take all global types and stuff their
92 // names into the TypeNames map.
94 static void fillTypeNameTable(const Module *M,
95 std::map<const Type *, std::string> &TypeNames) {
97 const SymbolTable &ST = M->getSymbolTable();
98 SymbolTable::const_iterator PI = ST.find(Type::TypeTy);
100 SymbolTable::type_const_iterator I = PI->second.begin();
101 for (; I != PI->second.end(); ++I) {
102 // As a heuristic, don't insert pointer to primitive types, because
103 // they are used too often to have a single useful name.
105 const Type *Ty = cast<Type>(I->second);
106 if (!isa<PointerType>(Ty) ||
107 !cast<PointerType>(Ty)->getElementType()->isPrimitiveType())
108 TypeNames.insert(std::make_pair(Ty, getLLVMName(I->first)));
115 static std::string calcTypeName(const Type *Ty,
116 std::vector<const Type *> &TypeStack,
117 std::map<const Type *, std::string> &TypeNames){
118 if (Ty->isPrimitiveType()) return Ty->getDescription(); // Base case
120 // Check to see if the type is named.
121 std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
122 if (I != TypeNames.end()) return I->second;
124 // Check to see if the Type is already on the stack...
125 unsigned Slot = 0, CurSize = TypeStack.size();
126 while (Slot < CurSize && TypeStack[Slot] != Ty) ++Slot; // Scan for type
128 // This is another base case for the recursion. In this case, we know
129 // that we have looped back to a type that we have previously visited.
130 // Generate the appropriate upreference to handle this.
133 return "\\" + utostr(CurSize-Slot); // Here's the upreference
135 TypeStack.push_back(Ty); // Recursive case: Add us to the stack..
138 switch (Ty->getPrimitiveID()) {
139 case Type::FunctionTyID: {
140 const FunctionType *FTy = cast<FunctionType>(Ty);
141 Result = calcTypeName(FTy->getReturnType(), TypeStack, TypeNames) + " (";
142 for (FunctionType::ParamTypes::const_iterator
143 I = FTy->getParamTypes().begin(),
144 E = FTy->getParamTypes().end(); I != E; ++I) {
145 if (I != FTy->getParamTypes().begin())
147 Result += calcTypeName(*I, TypeStack, TypeNames);
149 if (FTy->isVarArg()) {
150 if (!FTy->getParamTypes().empty()) Result += ", ";
156 case Type::StructTyID: {
157 const StructType *STy = cast<StructType>(Ty);
159 for (StructType::ElementTypes::const_iterator
160 I = STy->getElementTypes().begin(),
161 E = STy->getElementTypes().end(); I != E; ++I) {
162 if (I != STy->getElementTypes().begin())
164 Result += calcTypeName(*I, TypeStack, TypeNames);
169 case Type::PointerTyID:
170 Result = calcTypeName(cast<PointerType>(Ty)->getElementType(),
171 TypeStack, TypeNames) + "*";
173 case Type::ArrayTyID: {
174 const ArrayType *ATy = cast<ArrayType>(Ty);
175 Result = "[" + utostr(ATy->getNumElements()) + " x ";
176 Result += calcTypeName(ATy->getElementType(), TypeStack, TypeNames) + "]";
179 case Type::OpaqueTyID:
183 Result = "<unrecognized-type>";
186 TypeStack.pop_back(); // Remove self from stack...
191 // printTypeInt - The internal guts of printing out a type that has a
192 // potentially named portion.
194 static std::ostream &printTypeInt(std::ostream &Out, const Type *Ty,
195 std::map<const Type *, std::string> &TypeNames) {
196 // Primitive types always print out their description, regardless of whether
197 // they have been named or not.
199 if (Ty->isPrimitiveType()) return Out << Ty->getDescription();
201 // Check to see if the type is named.
202 std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
203 if (I != TypeNames.end()) return Out << I->second;
205 // Otherwise we have a type that has not been named but is a derived type.
206 // Carefully recurse the type hierarchy to print out any contained symbolic
209 std::vector<const Type *> TypeStack;
210 std::string TypeName = calcTypeName(Ty, TypeStack, TypeNames);
211 TypeNames.insert(std::make_pair(Ty, TypeName));//Cache type name for later use
212 return Out << TypeName;
216 // WriteTypeSymbolic - This attempts to write the specified type as a symbolic
217 // type, iff there is an entry in the modules symbol table for the specified
218 // type or one of it's component types. This is slower than a simple x << Type;
220 std::ostream &WriteTypeSymbolic(std::ostream &Out, const Type *Ty,
224 // If they want us to print out a type, attempt to make it symbolic if there
225 // is a symbol table in the module...
227 std::map<const Type *, std::string> TypeNames;
228 fillTypeNameTable(M, TypeNames);
230 return printTypeInt(Out, Ty, TypeNames);
232 return Out << Ty->getDescription();
236 static void WriteConstantInt(std::ostream &Out, const Constant *CV,
238 std::map<const Type *, std::string> &TypeTable,
239 SlotCalculator *Table) {
240 if (const ConstantBool *CB = dyn_cast<ConstantBool>(CV)) {
241 Out << (CB == ConstantBool::True ? "true" : "false");
242 } else if (const ConstantSInt *CI = dyn_cast<ConstantSInt>(CV)) {
243 Out << CI->getValue();
244 } else if (const ConstantUInt *CI = dyn_cast<ConstantUInt>(CV)) {
245 Out << CI->getValue();
246 } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
247 // We would like to output the FP constant value in exponential notation,
248 // but we cannot do this if doing so will lose precision. Check here to
249 // make sure that we only output it in exponential format if we can parse
250 // the value back and get the same value.
252 std::string StrVal = ftostr(CFP->getValue());
254 // Check to make sure that the stringized number is not some string like
255 // "Inf" or NaN, that atof will accept, but the lexer will not. Check that
256 // the string matches the "[-+]?[0-9]" regex.
258 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
259 ((StrVal[0] == '-' || StrVal[0] == '+') &&
260 (StrVal[1] >= '0' && StrVal[1] <= '9')))
261 // Reparse stringized version!
262 if (atof(StrVal.c_str()) == CFP->getValue()) {
263 Out << StrVal; return;
266 // Otherwise we could not reparse it to exactly the same value, so we must
267 // output the string in hexadecimal format!
269 // Behave nicely in the face of C TBAA rules... see:
270 // http://www.nullstone.com/htmls/category/aliastyp.htm
272 double Val = CFP->getValue();
273 char *Ptr = (char*)&Val;
274 assert(sizeof(double) == sizeof(uint64_t) && sizeof(double) == 8 &&
275 "assuming that double is 64 bits!");
276 Out << "0x" << utohexstr(*(uint64_t*)Ptr);
278 } else if (const ConstantArray *CA = dyn_cast<ConstantArray>(CV)) {
279 if (CA->getNumOperands() > 5 && CA->isNullValue()) {
280 Out << "zeroinitializer";
284 // As a special case, print the array as a string if it is an array of
285 // ubytes or an array of sbytes with positive values.
287 const Type *ETy = CA->getType()->getElementType();
288 bool isString = (ETy == Type::SByteTy || ETy == Type::UByteTy);
290 if (ETy == Type::SByteTy)
291 for (unsigned i = 0; i < CA->getNumOperands(); ++i)
292 if (cast<ConstantSInt>(CA->getOperand(i))->getValue() < 0) {
299 for (unsigned i = 0; i < CA->getNumOperands(); ++i) {
300 unsigned char C = cast<ConstantInt>(CA->getOperand(i))->getRawValue();
302 if (isprint(C) && C != '"' && C != '\\') {
306 << (char) ((C/16 < 10) ? ( C/16 +'0') : ( C/16 -10+'A'))
307 << (char)(((C&15) < 10) ? ((C&15)+'0') : ((C&15)-10+'A'));
312 } else { // Cannot output in string format...
314 if (CA->getNumOperands()) {
316 printTypeInt(Out, ETy, TypeTable);
317 WriteAsOperandInternal(Out, CA->getOperand(0),
318 PrintName, TypeTable, Table);
319 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
321 printTypeInt(Out, ETy, TypeTable);
322 WriteAsOperandInternal(Out, CA->getOperand(i), PrintName,
328 } else if (const ConstantStruct *CS = dyn_cast<ConstantStruct>(CV)) {
329 if (CS->getNumOperands() > 5 && CS->isNullValue()) {
330 Out << "zeroinitializer";
335 if (CS->getNumOperands()) {
337 printTypeInt(Out, CS->getOperand(0)->getType(), TypeTable);
339 WriteAsOperandInternal(Out, CS->getOperand(0),
340 PrintName, TypeTable, Table);
342 for (unsigned i = 1; i < CS->getNumOperands(); i++) {
344 printTypeInt(Out, CS->getOperand(i)->getType(), TypeTable);
346 WriteAsOperandInternal(Out, CS->getOperand(i),
347 PrintName, TypeTable, Table);
352 } else if (isa<ConstantPointerNull>(CV)) {
355 } else if (const ConstantPointerRef *PR = dyn_cast<ConstantPointerRef>(CV)) {
356 const GlobalValue *V = PR->getValue();
358 Out << getLLVMName(V->getName());
360 int Slot = Table->getValSlot(V);
364 Out << "<pointer reference badref>";
366 Out << "<pointer reference without context info>";
369 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
370 Out << CE->getOpcodeName() << " (";
372 for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
373 printTypeInt(Out, (*OI)->getType(), TypeTable);
374 WriteAsOperandInternal(Out, *OI, PrintName, TypeTable, Table);
375 if (OI+1 != CE->op_end())
379 if (CE->getOpcode() == Instruction::Cast) {
381 printTypeInt(Out, CE->getType(), TypeTable);
386 Out << "<placeholder or erroneous Constant>";
391 // WriteAsOperand - Write the name of the specified value out to the specified
392 // ostream. This can be useful when you just want to print int %reg126, not the
393 // whole instruction that generated it.
395 static void WriteAsOperandInternal(std::ostream &Out, const Value *V,
397 std::map<const Type*, std::string> &TypeTable,
398 SlotCalculator *Table) {
400 if (PrintName && V->hasName()) {
401 Out << getLLVMName(V->getName());
403 if (const Constant *CV = dyn_cast<Constant>(V)) {
404 WriteConstantInt(Out, CV, PrintName, TypeTable, Table);
408 Slot = Table->getValSlot(V);
410 if (const Type *Ty = dyn_cast<Type>(V)) {
411 Out << Ty->getDescription();
415 Table = createSlotCalculator(V);
416 if (Table == 0) { Out << "BAD VALUE TYPE!"; return; }
418 Slot = Table->getValSlot(V);
421 if (Slot >= 0) Out << "%" << Slot;
423 Out << "<badref>"; // Not embedded into a location?
430 // WriteAsOperand - Write the name of the specified value out to the specified
431 // ostream. This can be useful when you just want to print int %reg126, not the
432 // whole instruction that generated it.
434 std::ostream &WriteAsOperand(std::ostream &Out, const Value *V, bool PrintType,
435 bool PrintName, const Module *Context) {
436 std::map<const Type *, std::string> TypeNames;
437 if (Context == 0) Context = getModuleFromVal(V);
440 fillTypeNameTable(Context, TypeNames);
443 printTypeInt(Out, V->getType(), TypeNames);
445 WriteAsOperandInternal(Out, V, PrintName, TypeNames, 0);
451 class AssemblyWriter {
453 SlotCalculator &Table;
454 const Module *TheModule;
455 std::map<const Type *, std::string> TypeNames;
457 inline AssemblyWriter(std::ostream &o, SlotCalculator &Tab, const Module *M)
458 : Out(o), Table(Tab), TheModule(M) {
460 // If the module has a symbol table, take all global types and stuff their
461 // names into the TypeNames map.
463 fillTypeNameTable(M, TypeNames);
466 inline void write(const Module *M) { printModule(M); }
467 inline void write(const GlobalVariable *G) { printGlobal(G); }
468 inline void write(const Function *F) { printFunction(F); }
469 inline void write(const BasicBlock *BB) { printBasicBlock(BB); }
470 inline void write(const Instruction *I) { printInstruction(*I); }
471 inline void write(const Constant *CPV) { printConstant(CPV); }
472 inline void write(const Type *Ty) { printType(Ty); }
474 void writeOperand(const Value *Op, bool PrintType, bool PrintName = true);
477 void printModule(const Module *M);
478 void printSymbolTable(const SymbolTable &ST);
479 void printConstant(const Constant *CPV);
480 void printGlobal(const GlobalVariable *GV);
481 void printFunction(const Function *F);
482 void printArgument(const Argument *FA);
483 void printBasicBlock(const BasicBlock *BB);
484 void printInstruction(const Instruction &I);
486 // printType - Go to extreme measures to attempt to print out a short,
487 // symbolic version of a type name.
489 std::ostream &printType(const Type *Ty) {
490 return printTypeInt(Out, Ty, TypeNames);
493 // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
494 // without considering any symbolic types that we may have equal to it.
496 std::ostream &printTypeAtLeastOneLevel(const Type *Ty);
498 // printInfoComment - Print a little comment after the instruction indicating
499 // which slot it occupies.
500 void printInfoComment(const Value &V);
504 // printTypeAtLeastOneLevel - Print out one level of the possibly complex type
505 // without considering any symbolic types that we may have equal to it.
507 std::ostream &AssemblyWriter::printTypeAtLeastOneLevel(const Type *Ty) {
508 if (const FunctionType *FTy = dyn_cast<FunctionType>(Ty)) {
509 printType(FTy->getReturnType()) << " (";
510 for (FunctionType::ParamTypes::const_iterator
511 I = FTy->getParamTypes().begin(),
512 E = FTy->getParamTypes().end(); I != E; ++I) {
513 if (I != FTy->getParamTypes().begin())
517 if (FTy->isVarArg()) {
518 if (!FTy->getParamTypes().empty()) Out << ", ";
522 } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
524 for (StructType::ElementTypes::const_iterator
525 I = STy->getElementTypes().begin(),
526 E = STy->getElementTypes().end(); I != E; ++I) {
527 if (I != STy->getElementTypes().begin())
532 } else if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
533 printType(PTy->getElementType()) << "*";
534 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
535 Out << "[" << ATy->getNumElements() << " x ";
536 printType(ATy->getElementType()) << "]";
537 } else if (const OpaqueType *OTy = dyn_cast<OpaqueType>(Ty)) {
540 if (!Ty->isPrimitiveType())
541 Out << "<unknown derived type>";
548 void AssemblyWriter::writeOperand(const Value *Operand, bool PrintType,
550 if (PrintType) { Out << " "; printType(Operand->getType()); }
551 WriteAsOperandInternal(Out, Operand, PrintName, TypeNames, &Table);
555 void AssemblyWriter::printModule(const Module *M) {
556 switch (M->getEndianness()) {
557 case Module::LittleEndian: Out << "target endian = little\n"; break;
558 case Module::BigEndian: Out << "target endian = big\n"; break;
559 case Module::AnyEndianness: break;
561 switch (M->getPointerSize()) {
562 case Module::Pointer32: Out << "target pointersize = 32\n"; break;
563 case Module::Pointer64: Out << "target pointersize = 64\n"; break;
564 case Module::AnyPointerSize: break;
567 // Loop over the symbol table, emitting all named constants...
568 printSymbolTable(M->getSymbolTable());
570 for (Module::const_giterator I = M->gbegin(), E = M->gend(); I != E; ++I)
573 Out << "\nimplementation ; Functions:\n";
575 // Output all of the functions...
576 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
580 void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
581 if (GV->hasName()) Out << getLLVMName(GV->getName()) << " = ";
583 if (!GV->hasInitializer())
586 switch (GV->getLinkage()) {
587 case GlobalValue::InternalLinkage: Out << "internal "; break;
588 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
589 case GlobalValue::AppendingLinkage: Out << "appending "; break;
590 case GlobalValue::ExternalLinkage: break;
593 Out << (GV->isConstant() ? "constant " : "global ");
594 printType(GV->getType()->getElementType());
596 if (GV->hasInitializer())
597 writeOperand(GV->getInitializer(), false, false);
599 printInfoComment(*GV);
604 // printSymbolTable - Run through symbol table looking for named constants
605 // if a named constant is found, emit it's declaration...
607 void AssemblyWriter::printSymbolTable(const SymbolTable &ST) {
608 for (SymbolTable::const_iterator TI = ST.begin(); TI != ST.end(); ++TI) {
609 SymbolTable::type_const_iterator I = ST.type_begin(TI->first);
610 SymbolTable::type_const_iterator End = ST.type_end(TI->first);
612 for (; I != End; ++I) {
613 const Value *V = I->second;
614 if (const Constant *CPV = dyn_cast<Constant>(V)) {
616 } else if (const Type *Ty = dyn_cast<Type>(V)) {
617 Out << "\t" << getLLVMName(I->first) << " = type ";
619 // Make sure we print out at least one level of the type structure, so
620 // that we do not get %FILE = type %FILE
622 printTypeAtLeastOneLevel(Ty) << "\n";
629 // printConstant - Print out a constant pool entry...
631 void AssemblyWriter::printConstant(const Constant *CPV) {
632 // Don't print out unnamed constants, they will be inlined
633 if (!CPV->hasName()) return;
636 Out << "\t" << getLLVMName(CPV->getName()) << " =";
638 // Write the value out now...
639 writeOperand(CPV, true, false);
641 printInfoComment(*CPV);
645 // printFunction - Print all aspects of a function.
647 void AssemblyWriter::printFunction(const Function *F) {
648 // Print out the return type and name...
654 switch (F->getLinkage()) {
655 case GlobalValue::InternalLinkage: Out << "internal "; break;
656 case GlobalValue::LinkOnceLinkage: Out << "linkonce "; break;
657 case GlobalValue::AppendingLinkage: Out << "appending "; break;
658 case GlobalValue::ExternalLinkage: break;
661 printType(F->getReturnType()) << " ";
662 if (!F->getName().empty()) Out << getLLVMName(F->getName());
664 Table.incorporateFunction(F);
666 // Loop over the arguments, printing them...
667 const FunctionType *FT = F->getFunctionType();
669 for(Function::const_aiterator I = F->abegin(), E = F->aend(); I != E; ++I)
672 // Finish printing arguments...
673 if (FT->isVarArg()) {
674 if (FT->getParamTypes().size()) Out << ", ";
675 Out << "..."; // Output varargs portion of signature!
679 if (F->isExternal()) {
684 // Output all of its basic blocks... for the function
685 for (Function::const_iterator I = F->begin(), E = F->end(); I != E; ++I)
691 Table.purgeFunction();
694 // printArgument - This member is called for every argument that
695 // is passed into the function. Simply print it out
697 void AssemblyWriter::printArgument(const Argument *Arg) {
698 // Insert commas as we go... the first arg doesn't get a comma
699 if (Arg != &Arg->getParent()->afront()) Out << ", ";
702 printType(Arg->getType());
704 // Output name, if available...
706 Out << " " << getLLVMName(Arg->getName());
707 else if (Table.getValSlot(Arg) < 0)
711 // printBasicBlock - This member is called for each basic block in a method.
713 void AssemblyWriter::printBasicBlock(const BasicBlock *BB) {
714 if (BB->hasName()) { // Print out the label if it exists...
715 Out << "\n" << BB->getName() << ":";
716 } else if (!BB->use_empty()) { // Don't print block # of no uses...
717 int Slot = Table.getValSlot(BB);
718 Out << "\n; <label>:";
720 Out << Slot; // Extra newline separates out label's
725 // Output predecessors for the block...
727 pred_const_iterator PI = pred_begin(BB), PE = pred_end(BB);
730 Out << " No predecessors!";
733 writeOperand(*PI, false, true);
734 for (++PI; PI != PE; ++PI) {
736 writeOperand(*PI, false, true);
742 // Output all of the instructions in the basic block...
743 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
744 printInstruction(*I);
748 // printInfoComment - Print a little comment after the instruction indicating
749 // which slot it occupies.
751 void AssemblyWriter::printInfoComment(const Value &V) {
752 if (V.getType() != Type::VoidTy) {
754 printType(V.getType()) << ">";
757 int Slot = Table.getValSlot(&V); // Print out the def slot taken...
758 if (Slot >= 0) Out << ":" << Slot;
759 else Out << ":<badref>";
761 Out << " [#uses=" << V.use_size() << "]"; // Output # uses
765 // printInstruction - This member is called for each Instruction in a method.
767 void AssemblyWriter::printInstruction(const Instruction &I) {
770 // Print out name if it exists...
772 Out << getLLVMName(I.getName()) << " = ";
774 // If this is a volatile load or store, print out the volatile marker
775 if ((isa<LoadInst>(I) && cast<LoadInst>(I).isVolatile()) ||
776 (isa<StoreInst>(I) && cast<StoreInst>(I).isVolatile()))
779 // Print out the opcode...
780 Out << I.getOpcodeName();
782 // Print out the type of the operands...
783 const Value *Operand = I.getNumOperands() ? I.getOperand(0) : 0;
785 // Special case conditional branches to swizzle the condition out to the front
786 if (isa<BranchInst>(I) && I.getNumOperands() > 1) {
787 writeOperand(I.getOperand(2), true);
789 writeOperand(Operand, true);
791 writeOperand(I.getOperand(1), true);
793 } else if (isa<SwitchInst>(I)) {
794 // Special case switch statement to get formatting nice and correct...
795 writeOperand(Operand , true); Out << ",";
796 writeOperand(I.getOperand(1), true); Out << " [";
798 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; op += 2) {
800 writeOperand(I.getOperand(op ), true); Out << ",";
801 writeOperand(I.getOperand(op+1), true);
804 } else if (isa<PHINode>(I)) {
806 printType(I.getType());
809 for (unsigned op = 0, Eop = I.getNumOperands(); op < Eop; op += 2) {
812 writeOperand(I.getOperand(op ), false); Out << ",";
813 writeOperand(I.getOperand(op+1), false); Out << " ]";
815 } else if (isa<ReturnInst>(I) && !Operand) {
817 } else if (isa<CallInst>(I)) {
818 const PointerType *PTy = cast<PointerType>(Operand->getType());
819 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
820 const Type *RetTy = FTy->getReturnType();
822 // If possible, print out the short form of the call instruction. We can
823 // only do this if the first argument is a pointer to a nonvararg function,
824 // and if the return type is not a pointer to a function.
826 if (!FTy->isVarArg() &&
827 (!isa<PointerType>(RetTy) ||
828 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
829 Out << " "; printType(RetTy);
830 writeOperand(Operand, false);
832 writeOperand(Operand, true);
835 if (I.getNumOperands() > 1) writeOperand(I.getOperand(1), true);
836 for (unsigned op = 2, Eop = I.getNumOperands(); op < Eop; ++op) {
838 writeOperand(I.getOperand(op), true);
842 } else if (const InvokeInst *II = dyn_cast<InvokeInst>(&I)) {
843 const PointerType *PTy = cast<PointerType>(Operand->getType());
844 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
845 const Type *RetTy = FTy->getReturnType();
847 // If possible, print out the short form of the invoke instruction. We can
848 // only do this if the first argument is a pointer to a nonvararg function,
849 // and if the return type is not a pointer to a function.
851 if (!FTy->isVarArg() &&
852 (!isa<PointerType>(RetTy) ||
853 !isa<FunctionType>(cast<PointerType>(RetTy)->getElementType()))) {
854 Out << " "; printType(RetTy);
855 writeOperand(Operand, false);
857 writeOperand(Operand, true);
861 if (I.getNumOperands() > 3) writeOperand(I.getOperand(3), true);
862 for (unsigned op = 4, Eop = I.getNumOperands(); op < Eop; ++op) {
864 writeOperand(I.getOperand(op), true);
867 Out << " )\n\t\t\tto";
868 writeOperand(II->getNormalDest(), true);
870 writeOperand(II->getExceptionalDest(), true);
872 } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(&I)) {
874 printType(AI->getType()->getElementType());
875 if (AI->isArrayAllocation()) {
877 writeOperand(AI->getArraySize(), true);
879 } else if (isa<CastInst>(I)) {
880 writeOperand(Operand, true);
882 printType(I.getType());
883 } else if (isa<VarArgInst>(I)) {
884 writeOperand(Operand, true);
886 printType(I.getType());
887 } else if (Operand) { // Print the normal way...
889 // PrintAllTypes - Instructions who have operands of all the same type
890 // omit the type from all but the first operand. If the instruction has
891 // different type operands (for example br), then they are all printed.
892 bool PrintAllTypes = false;
893 const Type *TheType = Operand->getType();
895 // Shift Left & Right print both types even for Ubyte LHS
896 if (isa<ShiftInst>(I)) {
897 PrintAllTypes = true;
899 for (unsigned i = 1, E = I.getNumOperands(); i != E; ++i) {
900 Operand = I.getOperand(i);
901 if (Operand->getType() != TheType) {
902 PrintAllTypes = true; // We have differing types! Print them all!
908 if (!PrintAllTypes) {
913 for (unsigned i = 0, E = I.getNumOperands(); i != E; ++i) {
915 writeOperand(I.getOperand(i), PrintAllTypes);
924 //===----------------------------------------------------------------------===//
925 // External Interface declarations
926 //===----------------------------------------------------------------------===//
929 void Module::print(std::ostream &o) const {
930 SlotCalculator SlotTable(this, true);
931 AssemblyWriter W(o, SlotTable, this);
935 void GlobalVariable::print(std::ostream &o) const {
936 SlotCalculator SlotTable(getParent(), true);
937 AssemblyWriter W(o, SlotTable, getParent());
941 void Function::print(std::ostream &o) const {
942 SlotCalculator SlotTable(getParent(), true);
943 AssemblyWriter W(o, SlotTable, getParent());
948 void BasicBlock::print(std::ostream &o) const {
949 SlotCalculator SlotTable(getParent(), true);
950 AssemblyWriter W(o, SlotTable,
951 getParent() ? getParent()->getParent() : 0);
955 void Instruction::print(std::ostream &o) const {
956 const Function *F = getParent() ? getParent()->getParent() : 0;
957 SlotCalculator SlotTable(F, true);
958 AssemblyWriter W(o, SlotTable, F ? F->getParent() : 0);
963 void Constant::print(std::ostream &o) const {
964 if (this == 0) { o << "<null> constant value\n"; return; }
966 // Handle CPR's special, because they have context information...
967 if (const ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(this)) {
968 CPR->getValue()->print(o); // Print as a global value, with context info.
972 o << " " << getType()->getDescription() << " ";
974 std::map<const Type *, std::string> TypeTable;
975 WriteConstantInt(o, this, false, TypeTable, 0);
978 void Type::print(std::ostream &o) const {
982 o << getDescription();
985 void Argument::print(std::ostream &o) const {
986 o << getType() << " " << getName();
989 void Value::dump() const { print(std::cerr); }
991 //===----------------------------------------------------------------------===//
992 // CachedWriter Class Implementation
993 //===----------------------------------------------------------------------===//
995 void CachedWriter::setModule(const Module *M) {
996 delete SC; delete AW;
998 SC = new SlotCalculator(M, true);
999 AW = new AssemblyWriter(Out, *SC, M);
1005 CachedWriter::~CachedWriter() {
1010 CachedWriter &CachedWriter::operator<<(const Value *V) {
1011 assert(AW && SC && "CachedWriter does not have a current module!");
1012 switch (V->getValueType()) {
1013 case Value::ConstantVal:
1014 case Value::ArgumentVal: AW->writeOperand(V, true, true); break;
1015 case Value::TypeVal: AW->write(cast<Type>(V)); break;
1016 case Value::InstructionVal: AW->write(cast<Instruction>(V)); break;
1017 case Value::BasicBlockVal: AW->write(cast<BasicBlock>(V)); break;
1018 case Value::FunctionVal: AW->write(cast<Function>(V)); break;
1019 case Value::GlobalVariableVal: AW->write(cast<GlobalVariable>(V)); break;
1020 default: Out << "<unknown value type: " << V->getValueType() << ">"; break;