1 //===-- CBackend.cpp - Library for converting LLVM code to C --------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This library converts LLVM code to C code, compilable by GCC and other C
13 //===----------------------------------------------------------------------===//
15 #include "CTargetMachine.h"
16 #include "llvm/CallingConv.h"
17 #include "llvm/Constants.h"
18 #include "llvm/DerivedTypes.h"
19 #include "llvm/Module.h"
20 #include "llvm/Instructions.h"
21 #include "llvm/Pass.h"
22 #include "llvm/PassManager.h"
23 #include "llvm/TypeSymbolTable.h"
24 #include "llvm/Intrinsics.h"
25 #include "llvm/IntrinsicInst.h"
26 #include "llvm/InlineAsm.h"
27 #include "llvm/ADT/StringExtras.h"
28 #include "llvm/ADT/SmallString.h"
29 #include "llvm/ADT/STLExtras.h"
30 #include "llvm/Analysis/ConstantsScanner.h"
31 #include "llvm/Analysis/FindUsedTypes.h"
32 #include "llvm/Analysis/LoopInfo.h"
33 #include "llvm/Analysis/ValueTracking.h"
34 #include "llvm/CodeGen/Passes.h"
35 #include "llvm/CodeGen/IntrinsicLowering.h"
36 #include "llvm/Target/Mangler.h"
37 #include "llvm/Transforms/Scalar.h"
38 #include "llvm/MC/MCAsmInfo.h"
39 #include "llvm/MC/MCContext.h"
40 #include "llvm/MC/MCSymbol.h"
41 #include "llvm/Target/TargetData.h"
42 #include "llvm/Target/TargetRegistry.h"
43 #include "llvm/Support/CallSite.h"
44 #include "llvm/Support/CFG.h"
45 #include "llvm/Support/ErrorHandling.h"
46 #include "llvm/Support/FormattedStream.h"
47 #include "llvm/Support/GetElementPtrTypeIterator.h"
48 #include "llvm/Support/InstVisitor.h"
49 #include "llvm/Support/MathExtras.h"
50 #include "llvm/System/Host.h"
51 #include "llvm/Config/config.h"
55 extern "C" void LLVMInitializeCBackendTarget() {
56 // Register the target.
57 RegisterTargetMachine<CTargetMachine> X(TheCBackendTarget);
61 class CBEMCAsmInfo : public MCAsmInfo {
65 PrivateGlobalPrefix = "";
68 /// CBackendNameAllUsedStructsAndMergeFunctions - This pass inserts names for
69 /// any unnamed structure types that are used by the program, and merges
70 /// external functions with the same name.
72 class CBackendNameAllUsedStructsAndMergeFunctions : public ModulePass {
75 CBackendNameAllUsedStructsAndMergeFunctions()
77 void getAnalysisUsage(AnalysisUsage &AU) const {
78 AU.addRequired<FindUsedTypes>();
81 virtual const char *getPassName() const {
82 return "C backend type canonicalizer";
85 virtual bool runOnModule(Module &M);
88 char CBackendNameAllUsedStructsAndMergeFunctions::ID = 0;
90 /// CWriter - This class is the main chunk of code that converts an LLVM
91 /// module to a C translation unit.
92 class CWriter : public FunctionPass, public InstVisitor<CWriter> {
93 formatted_raw_ostream &Out;
94 IntrinsicLowering *IL;
97 const Module *TheModule;
98 const MCAsmInfo* TAsm;
100 const TargetData* TD;
101 std::map<const Type *, std::string> TypeNames;
102 std::map<const ConstantFP *, unsigned> FPConstantMap;
103 std::set<Function*> intrinsicPrototypesAlreadyGenerated;
104 std::set<const Argument*> ByValParams;
106 unsigned OpaqueCounter;
107 DenseMap<const Value*, unsigned> AnonValueNumbers;
108 unsigned NextAnonValueNumber;
112 explicit CWriter(formatted_raw_ostream &o)
113 : FunctionPass(&ID), Out(o), IL(0), Mang(0), LI(0),
114 TheModule(0), TAsm(0), TCtx(0), TD(0), OpaqueCounter(0),
115 NextAnonValueNumber(0) {
119 virtual const char *getPassName() const { return "C backend"; }
121 void getAnalysisUsage(AnalysisUsage &AU) const {
122 AU.addRequired<LoopInfo>();
123 AU.setPreservesAll();
126 virtual bool doInitialization(Module &M);
128 bool runOnFunction(Function &F) {
129 // Do not codegen any 'available_externally' functions at all, they have
130 // definitions outside the translation unit.
131 if (F.hasAvailableExternallyLinkage())
134 LI = &getAnalysis<LoopInfo>();
136 // Get rid of intrinsics we can't handle.
139 // Output all floating point constants that cannot be printed accurately.
140 printFloatingPointConstants(F);
146 virtual bool doFinalization(Module &M) {
153 FPConstantMap.clear();
156 intrinsicPrototypesAlreadyGenerated.clear();
160 raw_ostream &printType(raw_ostream &Out, const Type *Ty,
161 bool isSigned = false,
162 const std::string &VariableName = "",
163 bool IgnoreName = false,
164 const AttrListPtr &PAL = AttrListPtr());
165 raw_ostream &printSimpleType(raw_ostream &Out, const Type *Ty,
167 const std::string &NameSoFar = "");
169 void printStructReturnPointerFunctionType(raw_ostream &Out,
170 const AttrListPtr &PAL,
171 const PointerType *Ty);
173 /// writeOperandDeref - Print the result of dereferencing the specified
174 /// operand with '*'. This is equivalent to printing '*' then using
175 /// writeOperand, but avoids excess syntax in some cases.
176 void writeOperandDeref(Value *Operand) {
177 if (isAddressExposed(Operand)) {
178 // Already something with an address exposed.
179 writeOperandInternal(Operand);
182 writeOperand(Operand);
187 void writeOperand(Value *Operand, bool Static = false);
188 void writeInstComputationInline(Instruction &I);
189 void writeOperandInternal(Value *Operand, bool Static = false);
190 void writeOperandWithCast(Value* Operand, unsigned Opcode);
191 void writeOperandWithCast(Value* Operand, const ICmpInst &I);
192 bool writeInstructionCast(const Instruction &I);
194 void writeMemoryAccess(Value *Operand, const Type *OperandType,
195 bool IsVolatile, unsigned Alignment);
198 std::string InterpretASMConstraint(InlineAsm::ConstraintInfo& c);
200 void lowerIntrinsics(Function &F);
202 void printModule(Module *M);
203 void printModuleTypes(const TypeSymbolTable &ST);
204 void printContainedStructs(const Type *Ty, std::set<const Type *> &);
205 void printFloatingPointConstants(Function &F);
206 void printFloatingPointConstants(const Constant *C);
207 void printFunctionSignature(const Function *F, bool Prototype);
209 void printFunction(Function &);
210 void printBasicBlock(BasicBlock *BB);
211 void printLoop(Loop *L);
213 void printCast(unsigned opcode, const Type *SrcTy, const Type *DstTy);
214 void printConstant(Constant *CPV, bool Static);
215 void printConstantWithCast(Constant *CPV, unsigned Opcode);
216 bool printConstExprCast(const ConstantExpr *CE, bool Static);
217 void printConstantArray(ConstantArray *CPA, bool Static);
218 void printConstantVector(ConstantVector *CV, bool Static);
220 /// isAddressExposed - Return true if the specified value's name needs to
221 /// have its address taken in order to get a C value of the correct type.
222 /// This happens for global variables, byval parameters, and direct allocas.
223 bool isAddressExposed(const Value *V) const {
224 if (const Argument *A = dyn_cast<Argument>(V))
225 return ByValParams.count(A);
226 return isa<GlobalVariable>(V) || isDirectAlloca(V);
229 // isInlinableInst - Attempt to inline instructions into their uses to build
230 // trees as much as possible. To do this, we have to consistently decide
231 // what is acceptable to inline, so that variable declarations don't get
232 // printed and an extra copy of the expr is not emitted.
234 static bool isInlinableInst(const Instruction &I) {
235 // Always inline cmp instructions, even if they are shared by multiple
236 // expressions. GCC generates horrible code if we don't.
240 // Must be an expression, must be used exactly once. If it is dead, we
241 // emit it inline where it would go.
242 if (I.getType() == Type::getVoidTy(I.getContext()) || !I.hasOneUse() ||
243 isa<TerminatorInst>(I) || isa<CallInst>(I) || isa<PHINode>(I) ||
244 isa<LoadInst>(I) || isa<VAArgInst>(I) || isa<InsertElementInst>(I) ||
245 isa<InsertValueInst>(I))
246 // Don't inline a load across a store or other bad things!
249 // Must not be used in inline asm, extractelement, or shufflevector.
251 const Instruction &User = cast<Instruction>(*I.use_back());
252 if (isInlineAsm(User) || isa<ExtractElementInst>(User) ||
253 isa<ShuffleVectorInst>(User))
257 // Only inline instruction it if it's use is in the same BB as the inst.
258 return I.getParent() == cast<Instruction>(I.use_back())->getParent();
261 // isDirectAlloca - Define fixed sized allocas in the entry block as direct
262 // variables which are accessed with the & operator. This causes GCC to
263 // generate significantly better code than to emit alloca calls directly.
265 static const AllocaInst *isDirectAlloca(const Value *V) {
266 const AllocaInst *AI = dyn_cast<AllocaInst>(V);
267 if (!AI) return false;
268 if (AI->isArrayAllocation())
269 return 0; // FIXME: we can also inline fixed size array allocas!
270 if (AI->getParent() != &AI->getParent()->getParent()->getEntryBlock())
275 // isInlineAsm - Check if the instruction is a call to an inline asm chunk
276 static bool isInlineAsm(const Instruction& I) {
277 if (isa<CallInst>(&I) && isa<InlineAsm>(I.getOperand(0)))
282 // Instruction visitation functions
283 friend class InstVisitor<CWriter>;
285 void visitReturnInst(ReturnInst &I);
286 void visitBranchInst(BranchInst &I);
287 void visitSwitchInst(SwitchInst &I);
288 void visitIndirectBrInst(IndirectBrInst &I);
289 void visitInvokeInst(InvokeInst &I) {
290 llvm_unreachable("Lowerinvoke pass didn't work!");
293 void visitUnwindInst(UnwindInst &I) {
294 llvm_unreachable("Lowerinvoke pass didn't work!");
296 void visitUnreachableInst(UnreachableInst &I);
298 void visitPHINode(PHINode &I);
299 void visitBinaryOperator(Instruction &I);
300 void visitICmpInst(ICmpInst &I);
301 void visitFCmpInst(FCmpInst &I);
303 void visitCastInst (CastInst &I);
304 void visitSelectInst(SelectInst &I);
305 void visitCallInst (CallInst &I);
306 void visitInlineAsm(CallInst &I);
307 bool visitBuiltinCall(CallInst &I, Intrinsic::ID ID, bool &WroteCallee);
309 void visitAllocaInst(AllocaInst &I);
310 void visitLoadInst (LoadInst &I);
311 void visitStoreInst (StoreInst &I);
312 void visitGetElementPtrInst(GetElementPtrInst &I);
313 void visitVAArgInst (VAArgInst &I);
315 void visitInsertElementInst(InsertElementInst &I);
316 void visitExtractElementInst(ExtractElementInst &I);
317 void visitShuffleVectorInst(ShuffleVectorInst &SVI);
319 void visitInsertValueInst(InsertValueInst &I);
320 void visitExtractValueInst(ExtractValueInst &I);
322 void visitInstruction(Instruction &I) {
324 errs() << "C Writer does not know about " << I;
329 void outputLValue(Instruction *I) {
330 Out << " " << GetValueName(I) << " = ";
333 bool isGotoCodeNecessary(BasicBlock *From, BasicBlock *To);
334 void printPHICopiesForSuccessor(BasicBlock *CurBlock,
335 BasicBlock *Successor, unsigned Indent);
336 void printBranchToBlock(BasicBlock *CurBlock, BasicBlock *SuccBlock,
338 void printGEPExpression(Value *Ptr, gep_type_iterator I,
339 gep_type_iterator E, bool Static);
341 std::string GetValueName(const Value *Operand);
345 char CWriter::ID = 0;
348 static std::string CBEMangle(const std::string &S) {
351 for (unsigned i = 0, e = S.size(); i != e; ++i)
352 if (isalnum(S[i]) || S[i] == '_') {
356 Result += 'A'+(S[i]&15);
357 Result += 'A'+((S[i]>>4)&15);
364 /// This method inserts names for any unnamed structure types that are used by
365 /// the program, and removes names from structure types that are not used by the
368 bool CBackendNameAllUsedStructsAndMergeFunctions::runOnModule(Module &M) {
369 // Get a set of types that are used by the program...
370 std::set<const Type *> UT = getAnalysis<FindUsedTypes>().getTypes();
372 // Loop over the module symbol table, removing types from UT that are
373 // already named, and removing names for types that are not used.
375 TypeSymbolTable &TST = M.getTypeSymbolTable();
376 for (TypeSymbolTable::iterator TI = TST.begin(), TE = TST.end();
378 TypeSymbolTable::iterator I = TI++;
380 // If this isn't a struct or array type, remove it from our set of types
381 // to name. This simplifies emission later.
382 if (!I->second->isStructTy() && !I->second->isOpaqueTy() &&
383 !I->second->isArrayTy()) {
386 // If this is not used, remove it from the symbol table.
387 std::set<const Type *>::iterator UTI = UT.find(I->second);
391 UT.erase(UTI); // Only keep one name for this type.
395 // UT now contains types that are not named. Loop over it, naming
398 bool Changed = false;
399 unsigned RenameCounter = 0;
400 for (std::set<const Type *>::const_iterator I = UT.begin(), E = UT.end();
402 if ((*I)->isStructTy() || (*I)->isArrayTy()) {
403 while (M.addTypeName("unnamed"+utostr(RenameCounter), *I))
409 // Loop over all external functions and globals. If we have two with
410 // identical names, merge them.
411 // FIXME: This code should disappear when we don't allow values with the same
412 // names when they have different types!
413 std::map<std::string, GlobalValue*> ExtSymbols;
414 for (Module::iterator I = M.begin(), E = M.end(); I != E;) {
416 if (GV->isDeclaration() && GV->hasName()) {
417 std::pair<std::map<std::string, GlobalValue*>::iterator, bool> X
418 = ExtSymbols.insert(std::make_pair(GV->getName(), GV));
420 // Found a conflict, replace this global with the previous one.
421 GlobalValue *OldGV = X.first->second;
422 GV->replaceAllUsesWith(ConstantExpr::getBitCast(OldGV, GV->getType()));
423 GV->eraseFromParent();
428 // Do the same for globals.
429 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
431 GlobalVariable *GV = I++;
432 if (GV->isDeclaration() && GV->hasName()) {
433 std::pair<std::map<std::string, GlobalValue*>::iterator, bool> X
434 = ExtSymbols.insert(std::make_pair(GV->getName(), GV));
436 // Found a conflict, replace this global with the previous one.
437 GlobalValue *OldGV = X.first->second;
438 GV->replaceAllUsesWith(ConstantExpr::getBitCast(OldGV, GV->getType()));
439 GV->eraseFromParent();
448 /// printStructReturnPointerFunctionType - This is like printType for a struct
449 /// return type, except, instead of printing the type as void (*)(Struct*, ...)
450 /// print it as "Struct (*)(...)", for struct return functions.
451 void CWriter::printStructReturnPointerFunctionType(raw_ostream &Out,
452 const AttrListPtr &PAL,
453 const PointerType *TheTy) {
454 const FunctionType *FTy = cast<FunctionType>(TheTy->getElementType());
456 raw_string_ostream FunctionInnards(tstr);
457 FunctionInnards << " (*) (";
458 bool PrintedType = false;
460 FunctionType::param_iterator I = FTy->param_begin(), E = FTy->param_end();
461 const Type *RetTy = cast<PointerType>(I->get())->getElementType();
463 for (++I, ++Idx; I != E; ++I, ++Idx) {
465 FunctionInnards << ", ";
466 const Type *ArgTy = *I;
467 if (PAL.paramHasAttr(Idx, Attribute::ByVal)) {
468 assert(ArgTy->isPointerTy());
469 ArgTy = cast<PointerType>(ArgTy)->getElementType();
471 printType(FunctionInnards, ArgTy,
472 /*isSigned=*/PAL.paramHasAttr(Idx, Attribute::SExt), "");
475 if (FTy->isVarArg()) {
477 FunctionInnards << ", ...";
478 } else if (!PrintedType) {
479 FunctionInnards << "void";
481 FunctionInnards << ')';
482 printType(Out, RetTy,
483 /*isSigned=*/PAL.paramHasAttr(0, Attribute::SExt), FunctionInnards.str());
487 CWriter::printSimpleType(raw_ostream &Out, const Type *Ty, bool isSigned,
488 const std::string &NameSoFar) {
489 assert((Ty->isPrimitiveType() || Ty->isIntegerTy() || Ty->isVectorTy()) &&
490 "Invalid type for printSimpleType");
491 switch (Ty->getTypeID()) {
492 case Type::VoidTyID: return Out << "void " << NameSoFar;
493 case Type::IntegerTyID: {
494 unsigned NumBits = cast<IntegerType>(Ty)->getBitWidth();
496 return Out << "bool " << NameSoFar;
497 else if (NumBits <= 8)
498 return Out << (isSigned?"signed":"unsigned") << " char " << NameSoFar;
499 else if (NumBits <= 16)
500 return Out << (isSigned?"signed":"unsigned") << " short " << NameSoFar;
501 else if (NumBits <= 32)
502 return Out << (isSigned?"signed":"unsigned") << " int " << NameSoFar;
503 else if (NumBits <= 64)
504 return Out << (isSigned?"signed":"unsigned") << " long long "<< NameSoFar;
506 assert(NumBits <= 128 && "Bit widths > 128 not implemented yet");
507 return Out << (isSigned?"llvmInt128":"llvmUInt128") << " " << NameSoFar;
510 case Type::FloatTyID: return Out << "float " << NameSoFar;
511 case Type::DoubleTyID: return Out << "double " << NameSoFar;
512 // Lacking emulation of FP80 on PPC, etc., we assume whichever of these is
513 // present matches host 'long double'.
514 case Type::X86_FP80TyID:
515 case Type::PPC_FP128TyID:
516 case Type::FP128TyID: return Out << "long double " << NameSoFar;
518 case Type::VectorTyID: {
519 const VectorType *VTy = cast<VectorType>(Ty);
520 return printSimpleType(Out, VTy->getElementType(), isSigned,
521 " __attribute__((vector_size(" +
522 utostr(TD->getTypeAllocSize(VTy)) + " ))) " + NameSoFar);
527 errs() << "Unknown primitive type: " << *Ty << "\n";
533 // Pass the Type* and the variable name and this prints out the variable
536 raw_ostream &CWriter::printType(raw_ostream &Out, const Type *Ty,
537 bool isSigned, const std::string &NameSoFar,
538 bool IgnoreName, const AttrListPtr &PAL) {
539 if (Ty->isPrimitiveType() || Ty->isIntegerTy() || Ty->isVectorTy()) {
540 printSimpleType(Out, Ty, isSigned, NameSoFar);
544 // Check to see if the type is named.
545 if (!IgnoreName || Ty->isOpaqueTy()) {
546 std::map<const Type *, std::string>::iterator I = TypeNames.find(Ty);
547 if (I != TypeNames.end()) return Out << I->second << ' ' << NameSoFar;
550 switch (Ty->getTypeID()) {
551 case Type::FunctionTyID: {
552 const FunctionType *FTy = cast<FunctionType>(Ty);
554 raw_string_ostream FunctionInnards(tstr);
555 FunctionInnards << " (" << NameSoFar << ") (";
557 for (FunctionType::param_iterator I = FTy->param_begin(),
558 E = FTy->param_end(); I != E; ++I) {
559 const Type *ArgTy = *I;
560 if (PAL.paramHasAttr(Idx, Attribute::ByVal)) {
561 assert(ArgTy->isPointerTy());
562 ArgTy = cast<PointerType>(ArgTy)->getElementType();
564 if (I != FTy->param_begin())
565 FunctionInnards << ", ";
566 printType(FunctionInnards, ArgTy,
567 /*isSigned=*/PAL.paramHasAttr(Idx, Attribute::SExt), "");
570 if (FTy->isVarArg()) {
571 if (FTy->getNumParams())
572 FunctionInnards << ", ...";
573 } else if (!FTy->getNumParams()) {
574 FunctionInnards << "void";
576 FunctionInnards << ')';
577 printType(Out, FTy->getReturnType(),
578 /*isSigned=*/PAL.paramHasAttr(0, Attribute::SExt), FunctionInnards.str());
581 case Type::StructTyID: {
582 const StructType *STy = cast<StructType>(Ty);
583 Out << NameSoFar + " {\n";
585 for (StructType::element_iterator I = STy->element_begin(),
586 E = STy->element_end(); I != E; ++I) {
588 printType(Out, *I, false, "field" + utostr(Idx++));
593 Out << " __attribute__ ((packed))";
597 case Type::PointerTyID: {
598 const PointerType *PTy = cast<PointerType>(Ty);
599 std::string ptrName = "*" + NameSoFar;
601 if (PTy->getElementType()->isArrayTy() ||
602 PTy->getElementType()->isVectorTy())
603 ptrName = "(" + ptrName + ")";
606 // Must be a function ptr cast!
607 return printType(Out, PTy->getElementType(), false, ptrName, true, PAL);
608 return printType(Out, PTy->getElementType(), false, ptrName);
611 case Type::ArrayTyID: {
612 const ArrayType *ATy = cast<ArrayType>(Ty);
613 unsigned NumElements = ATy->getNumElements();
614 if (NumElements == 0) NumElements = 1;
615 // Arrays are wrapped in structs to allow them to have normal
616 // value semantics (avoiding the array "decay").
617 Out << NameSoFar << " { ";
618 printType(Out, ATy->getElementType(), false,
619 "array[" + utostr(NumElements) + "]");
623 case Type::OpaqueTyID: {
624 std::string TyName = "struct opaque_" + itostr(OpaqueCounter++);
625 assert(TypeNames.find(Ty) == TypeNames.end());
626 TypeNames[Ty] = TyName;
627 return Out << TyName << ' ' << NameSoFar;
630 llvm_unreachable("Unhandled case in getTypeProps!");
636 void CWriter::printConstantArray(ConstantArray *CPA, bool Static) {
638 // As a special case, print the array as a string if it is an array of
639 // ubytes or an array of sbytes with positive values.
641 const Type *ETy = CPA->getType()->getElementType();
642 bool isString = (ETy == Type::getInt8Ty(CPA->getContext()) ||
643 ETy == Type::getInt8Ty(CPA->getContext()));
645 // Make sure the last character is a null char, as automatically added by C
646 if (isString && (CPA->getNumOperands() == 0 ||
647 !cast<Constant>(*(CPA->op_end()-1))->isNullValue()))
652 // Keep track of whether the last number was a hexadecimal escape
653 bool LastWasHex = false;
655 // Do not include the last character, which we know is null
656 for (unsigned i = 0, e = CPA->getNumOperands()-1; i != e; ++i) {
657 unsigned char C = cast<ConstantInt>(CPA->getOperand(i))->getZExtValue();
659 // Print it out literally if it is a printable character. The only thing
660 // to be careful about is when the last letter output was a hex escape
661 // code, in which case we have to be careful not to print out hex digits
662 // explicitly (the C compiler thinks it is a continuation of the previous
663 // character, sheesh...)
665 if (isprint(C) && (!LastWasHex || !isxdigit(C))) {
667 if (C == '"' || C == '\\')
668 Out << "\\" << (char)C;
674 case '\n': Out << "\\n"; break;
675 case '\t': Out << "\\t"; break;
676 case '\r': Out << "\\r"; break;
677 case '\v': Out << "\\v"; break;
678 case '\a': Out << "\\a"; break;
679 case '\"': Out << "\\\""; break;
680 case '\'': Out << "\\\'"; break;
683 Out << (char)(( C/16 < 10) ? ( C/16 +'0') : ( C/16 -10+'A'));
684 Out << (char)(((C&15) < 10) ? ((C&15)+'0') : ((C&15)-10+'A'));
693 if (CPA->getNumOperands()) {
695 printConstant(cast<Constant>(CPA->getOperand(0)), Static);
696 for (unsigned i = 1, e = CPA->getNumOperands(); i != e; ++i) {
698 printConstant(cast<Constant>(CPA->getOperand(i)), Static);
705 void CWriter::printConstantVector(ConstantVector *CP, bool Static) {
707 if (CP->getNumOperands()) {
709 printConstant(cast<Constant>(CP->getOperand(0)), Static);
710 for (unsigned i = 1, e = CP->getNumOperands(); i != e; ++i) {
712 printConstant(cast<Constant>(CP->getOperand(i)), Static);
718 // isFPCSafeToPrint - Returns true if we may assume that CFP may be written out
719 // textually as a double (rather than as a reference to a stack-allocated
720 // variable). We decide this by converting CFP to a string and back into a
721 // double, and then checking whether the conversion results in a bit-equal
722 // double to the original value of CFP. This depends on us and the target C
723 // compiler agreeing on the conversion process (which is pretty likely since we
724 // only deal in IEEE FP).
726 static bool isFPCSafeToPrint(const ConstantFP *CFP) {
728 // Do long doubles in hex for now.
729 if (CFP->getType() != Type::getFloatTy(CFP->getContext()) &&
730 CFP->getType() != Type::getDoubleTy(CFP->getContext()))
732 APFloat APF = APFloat(CFP->getValueAPF()); // copy
733 if (CFP->getType() == Type::getFloatTy(CFP->getContext()))
734 APF.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven, &ignored);
735 #if HAVE_PRINTF_A && ENABLE_CBE_PRINTF_A
737 sprintf(Buffer, "%a", APF.convertToDouble());
738 if (!strncmp(Buffer, "0x", 2) ||
739 !strncmp(Buffer, "-0x", 3) ||
740 !strncmp(Buffer, "+0x", 3))
741 return APF.bitwiseIsEqual(APFloat(atof(Buffer)));
744 std::string StrVal = ftostr(APF);
746 while (StrVal[0] == ' ')
747 StrVal.erase(StrVal.begin());
749 // Check to make sure that the stringized number is not some string like "Inf"
750 // or NaN. Check that the string matches the "[-+]?[0-9]" regex.
751 if ((StrVal[0] >= '0' && StrVal[0] <= '9') ||
752 ((StrVal[0] == '-' || StrVal[0] == '+') &&
753 (StrVal[1] >= '0' && StrVal[1] <= '9')))
754 // Reparse stringized version!
755 return APF.bitwiseIsEqual(APFloat(atof(StrVal.c_str())));
760 /// Print out the casting for a cast operation. This does the double casting
761 /// necessary for conversion to the destination type, if necessary.
762 /// @brief Print a cast
763 void CWriter::printCast(unsigned opc, const Type *SrcTy, const Type *DstTy) {
764 // Print the destination type cast
766 case Instruction::UIToFP:
767 case Instruction::SIToFP:
768 case Instruction::IntToPtr:
769 case Instruction::Trunc:
770 case Instruction::BitCast:
771 case Instruction::FPExt:
772 case Instruction::FPTrunc: // For these the DstTy sign doesn't matter
774 printType(Out, DstTy);
777 case Instruction::ZExt:
778 case Instruction::PtrToInt:
779 case Instruction::FPToUI: // For these, make sure we get an unsigned dest
781 printSimpleType(Out, DstTy, false);
784 case Instruction::SExt:
785 case Instruction::FPToSI: // For these, make sure we get a signed dest
787 printSimpleType(Out, DstTy, true);
791 llvm_unreachable("Invalid cast opcode");
794 // Print the source type cast
796 case Instruction::UIToFP:
797 case Instruction::ZExt:
799 printSimpleType(Out, SrcTy, false);
802 case Instruction::SIToFP:
803 case Instruction::SExt:
805 printSimpleType(Out, SrcTy, true);
808 case Instruction::IntToPtr:
809 case Instruction::PtrToInt:
810 // Avoid "cast to pointer from integer of different size" warnings
811 Out << "(unsigned long)";
813 case Instruction::Trunc:
814 case Instruction::BitCast:
815 case Instruction::FPExt:
816 case Instruction::FPTrunc:
817 case Instruction::FPToSI:
818 case Instruction::FPToUI:
819 break; // These don't need a source cast.
821 llvm_unreachable("Invalid cast opcode");
826 // printConstant - The LLVM Constant to C Constant converter.
827 void CWriter::printConstant(Constant *CPV, bool Static) {
828 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CPV)) {
829 switch (CE->getOpcode()) {
830 case Instruction::Trunc:
831 case Instruction::ZExt:
832 case Instruction::SExt:
833 case Instruction::FPTrunc:
834 case Instruction::FPExt:
835 case Instruction::UIToFP:
836 case Instruction::SIToFP:
837 case Instruction::FPToUI:
838 case Instruction::FPToSI:
839 case Instruction::PtrToInt:
840 case Instruction::IntToPtr:
841 case Instruction::BitCast:
843 printCast(CE->getOpcode(), CE->getOperand(0)->getType(), CE->getType());
844 if (CE->getOpcode() == Instruction::SExt &&
845 CE->getOperand(0)->getType() == Type::getInt1Ty(CPV->getContext())) {
846 // Make sure we really sext from bool here by subtracting from 0
849 printConstant(CE->getOperand(0), Static);
850 if (CE->getType() == Type::getInt1Ty(CPV->getContext()) &&
851 (CE->getOpcode() == Instruction::Trunc ||
852 CE->getOpcode() == Instruction::FPToUI ||
853 CE->getOpcode() == Instruction::FPToSI ||
854 CE->getOpcode() == Instruction::PtrToInt)) {
855 // Make sure we really truncate to bool here by anding with 1
861 case Instruction::GetElementPtr:
863 printGEPExpression(CE->getOperand(0), gep_type_begin(CPV),
864 gep_type_end(CPV), Static);
867 case Instruction::Select:
869 printConstant(CE->getOperand(0), Static);
871 printConstant(CE->getOperand(1), Static);
873 printConstant(CE->getOperand(2), Static);
876 case Instruction::Add:
877 case Instruction::FAdd:
878 case Instruction::Sub:
879 case Instruction::FSub:
880 case Instruction::Mul:
881 case Instruction::FMul:
882 case Instruction::SDiv:
883 case Instruction::UDiv:
884 case Instruction::FDiv:
885 case Instruction::URem:
886 case Instruction::SRem:
887 case Instruction::FRem:
888 case Instruction::And:
889 case Instruction::Or:
890 case Instruction::Xor:
891 case Instruction::ICmp:
892 case Instruction::Shl:
893 case Instruction::LShr:
894 case Instruction::AShr:
897 bool NeedsClosingParens = printConstExprCast(CE, Static);
898 printConstantWithCast(CE->getOperand(0), CE->getOpcode());
899 switch (CE->getOpcode()) {
900 case Instruction::Add:
901 case Instruction::FAdd: Out << " + "; break;
902 case Instruction::Sub:
903 case Instruction::FSub: Out << " - "; break;
904 case Instruction::Mul:
905 case Instruction::FMul: Out << " * "; break;
906 case Instruction::URem:
907 case Instruction::SRem:
908 case Instruction::FRem: Out << " % "; break;
909 case Instruction::UDiv:
910 case Instruction::SDiv:
911 case Instruction::FDiv: Out << " / "; break;
912 case Instruction::And: Out << " & "; break;
913 case Instruction::Or: Out << " | "; break;
914 case Instruction::Xor: Out << " ^ "; break;
915 case Instruction::Shl: Out << " << "; break;
916 case Instruction::LShr:
917 case Instruction::AShr: Out << " >> "; break;
918 case Instruction::ICmp:
919 switch (CE->getPredicate()) {
920 case ICmpInst::ICMP_EQ: Out << " == "; break;
921 case ICmpInst::ICMP_NE: Out << " != "; break;
922 case ICmpInst::ICMP_SLT:
923 case ICmpInst::ICMP_ULT: Out << " < "; break;
924 case ICmpInst::ICMP_SLE:
925 case ICmpInst::ICMP_ULE: Out << " <= "; break;
926 case ICmpInst::ICMP_SGT:
927 case ICmpInst::ICMP_UGT: Out << " > "; break;
928 case ICmpInst::ICMP_SGE:
929 case ICmpInst::ICMP_UGE: Out << " >= "; break;
930 default: llvm_unreachable("Illegal ICmp predicate");
933 default: llvm_unreachable("Illegal opcode here!");
935 printConstantWithCast(CE->getOperand(1), CE->getOpcode());
936 if (NeedsClosingParens)
941 case Instruction::FCmp: {
943 bool NeedsClosingParens = printConstExprCast(CE, Static);
944 if (CE->getPredicate() == FCmpInst::FCMP_FALSE)
946 else if (CE->getPredicate() == FCmpInst::FCMP_TRUE)
950 switch (CE->getPredicate()) {
951 default: llvm_unreachable("Illegal FCmp predicate");
952 case FCmpInst::FCMP_ORD: op = "ord"; break;
953 case FCmpInst::FCMP_UNO: op = "uno"; break;
954 case FCmpInst::FCMP_UEQ: op = "ueq"; break;
955 case FCmpInst::FCMP_UNE: op = "une"; break;
956 case FCmpInst::FCMP_ULT: op = "ult"; break;
957 case FCmpInst::FCMP_ULE: op = "ule"; break;
958 case FCmpInst::FCMP_UGT: op = "ugt"; break;
959 case FCmpInst::FCMP_UGE: op = "uge"; break;
960 case FCmpInst::FCMP_OEQ: op = "oeq"; break;
961 case FCmpInst::FCMP_ONE: op = "one"; break;
962 case FCmpInst::FCMP_OLT: op = "olt"; break;
963 case FCmpInst::FCMP_OLE: op = "ole"; break;
964 case FCmpInst::FCMP_OGT: op = "ogt"; break;
965 case FCmpInst::FCMP_OGE: op = "oge"; break;
967 Out << "llvm_fcmp_" << op << "(";
968 printConstantWithCast(CE->getOperand(0), CE->getOpcode());
970 printConstantWithCast(CE->getOperand(1), CE->getOpcode());
973 if (NeedsClosingParens)
980 errs() << "CWriter Error: Unhandled constant expression: "
985 } else if (isa<UndefValue>(CPV) && CPV->getType()->isSingleValueType()) {
987 printType(Out, CPV->getType()); // sign doesn't matter
989 if (!CPV->getType()->isVectorTy()) {
997 if (ConstantInt *CI = dyn_cast<ConstantInt>(CPV)) {
998 const Type* Ty = CI->getType();
999 if (Ty == Type::getInt1Ty(CPV->getContext()))
1000 Out << (CI->getZExtValue() ? '1' : '0');
1001 else if (Ty == Type::getInt32Ty(CPV->getContext()))
1002 Out << CI->getZExtValue() << 'u';
1003 else if (Ty->getPrimitiveSizeInBits() > 32)
1004 Out << CI->getZExtValue() << "ull";
1007 printSimpleType(Out, Ty, false) << ')';
1008 if (CI->isMinValue(true))
1009 Out << CI->getZExtValue() << 'u';
1011 Out << CI->getSExtValue();
1017 switch (CPV->getType()->getTypeID()) {
1018 case Type::FloatTyID:
1019 case Type::DoubleTyID:
1020 case Type::X86_FP80TyID:
1021 case Type::PPC_FP128TyID:
1022 case Type::FP128TyID: {
1023 ConstantFP *FPC = cast<ConstantFP>(CPV);
1024 std::map<const ConstantFP*, unsigned>::iterator I = FPConstantMap.find(FPC);
1025 if (I != FPConstantMap.end()) {
1026 // Because of FP precision problems we must load from a stack allocated
1027 // value that holds the value in hex.
1028 Out << "(*(" << (FPC->getType() == Type::getFloatTy(CPV->getContext()) ?
1030 FPC->getType() == Type::getDoubleTy(CPV->getContext()) ?
1033 << "*)&FPConstant" << I->second << ')';
1036 if (FPC->getType() == Type::getFloatTy(CPV->getContext()))
1037 V = FPC->getValueAPF().convertToFloat();
1038 else if (FPC->getType() == Type::getDoubleTy(CPV->getContext()))
1039 V = FPC->getValueAPF().convertToDouble();
1041 // Long double. Convert the number to double, discarding precision.
1042 // This is not awesome, but it at least makes the CBE output somewhat
1044 APFloat Tmp = FPC->getValueAPF();
1046 Tmp.convert(APFloat::IEEEdouble, APFloat::rmTowardZero, &LosesInfo);
1047 V = Tmp.convertToDouble();
1053 // FIXME the actual NaN bits should be emitted.
1054 // The prefix for a quiet NaN is 0x7FF8. For a signalling NaN,
1056 const unsigned long QuietNaN = 0x7ff8UL;
1057 //const unsigned long SignalNaN = 0x7ff4UL;
1059 // We need to grab the first part of the FP #
1062 uint64_t ll = DoubleToBits(V);
1063 sprintf(Buffer, "0x%llx", static_cast<long long>(ll));
1065 std::string Num(&Buffer[0], &Buffer[6]);
1066 unsigned long Val = strtoul(Num.c_str(), 0, 16);
1068 if (FPC->getType() == Type::getFloatTy(FPC->getContext()))
1069 Out << "LLVM_NAN" << (Val == QuietNaN ? "" : "S") << "F(\""
1070 << Buffer << "\") /*nan*/ ";
1072 Out << "LLVM_NAN" << (Val == QuietNaN ? "" : "S") << "(\""
1073 << Buffer << "\") /*nan*/ ";
1074 } else if (IsInf(V)) {
1076 if (V < 0) Out << '-';
1077 Out << "LLVM_INF" <<
1078 (FPC->getType() == Type::getFloatTy(FPC->getContext()) ? "F" : "")
1082 #if HAVE_PRINTF_A && ENABLE_CBE_PRINTF_A
1083 // Print out the constant as a floating point number.
1085 sprintf(Buffer, "%a", V);
1088 Num = ftostr(FPC->getValueAPF());
1096 case Type::ArrayTyID:
1097 // Use C99 compound expression literal initializer syntax.
1100 printType(Out, CPV->getType());
1103 Out << "{ "; // Arrays are wrapped in struct types.
1104 if (ConstantArray *CA = dyn_cast<ConstantArray>(CPV)) {
1105 printConstantArray(CA, Static);
1107 assert(isa<ConstantAggregateZero>(CPV) || isa<UndefValue>(CPV));
1108 const ArrayType *AT = cast<ArrayType>(CPV->getType());
1110 if (AT->getNumElements()) {
1112 Constant *CZ = Constant::getNullValue(AT->getElementType());
1113 printConstant(CZ, Static);
1114 for (unsigned i = 1, e = AT->getNumElements(); i != e; ++i) {
1116 printConstant(CZ, Static);
1121 Out << " }"; // Arrays are wrapped in struct types.
1124 case Type::VectorTyID:
1125 // Use C99 compound expression literal initializer syntax.
1128 printType(Out, CPV->getType());
1131 if (ConstantVector *CV = dyn_cast<ConstantVector>(CPV)) {
1132 printConstantVector(CV, Static);
1134 assert(isa<ConstantAggregateZero>(CPV) || isa<UndefValue>(CPV));
1135 const VectorType *VT = cast<VectorType>(CPV->getType());
1137 Constant *CZ = Constant::getNullValue(VT->getElementType());
1138 printConstant(CZ, Static);
1139 for (unsigned i = 1, e = VT->getNumElements(); i != e; ++i) {
1141 printConstant(CZ, Static);
1147 case Type::StructTyID:
1148 // Use C99 compound expression literal initializer syntax.
1151 printType(Out, CPV->getType());
1154 if (isa<ConstantAggregateZero>(CPV) || isa<UndefValue>(CPV)) {
1155 const StructType *ST = cast<StructType>(CPV->getType());
1157 if (ST->getNumElements()) {
1159 printConstant(Constant::getNullValue(ST->getElementType(0)), Static);
1160 for (unsigned i = 1, e = ST->getNumElements(); i != e; ++i) {
1162 printConstant(Constant::getNullValue(ST->getElementType(i)), Static);
1168 if (CPV->getNumOperands()) {
1170 printConstant(cast<Constant>(CPV->getOperand(0)), Static);
1171 for (unsigned i = 1, e = CPV->getNumOperands(); i != e; ++i) {
1173 printConstant(cast<Constant>(CPV->getOperand(i)), Static);
1180 case Type::PointerTyID:
1181 if (isa<ConstantPointerNull>(CPV)) {
1183 printType(Out, CPV->getType()); // sign doesn't matter
1184 Out << ")/*NULL*/0)";
1186 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(CPV)) {
1187 writeOperand(GV, Static);
1193 errs() << "Unknown constant type: " << *CPV << "\n";
1195 llvm_unreachable(0);
1199 // Some constant expressions need to be casted back to the original types
1200 // because their operands were casted to the expected type. This function takes
1201 // care of detecting that case and printing the cast for the ConstantExpr.
1202 bool CWriter::printConstExprCast(const ConstantExpr* CE, bool Static) {
1203 bool NeedsExplicitCast = false;
1204 const Type *Ty = CE->getOperand(0)->getType();
1205 bool TypeIsSigned = false;
1206 switch (CE->getOpcode()) {
1207 case Instruction::Add:
1208 case Instruction::Sub:
1209 case Instruction::Mul:
1210 // We need to cast integer arithmetic so that it is always performed
1211 // as unsigned, to avoid undefined behavior on overflow.
1212 case Instruction::LShr:
1213 case Instruction::URem:
1214 case Instruction::UDiv: NeedsExplicitCast = true; break;
1215 case Instruction::AShr:
1216 case Instruction::SRem:
1217 case Instruction::SDiv: NeedsExplicitCast = true; TypeIsSigned = true; break;
1218 case Instruction::SExt:
1220 NeedsExplicitCast = true;
1221 TypeIsSigned = true;
1223 case Instruction::ZExt:
1224 case Instruction::Trunc:
1225 case Instruction::FPTrunc:
1226 case Instruction::FPExt:
1227 case Instruction::UIToFP:
1228 case Instruction::SIToFP:
1229 case Instruction::FPToUI:
1230 case Instruction::FPToSI:
1231 case Instruction::PtrToInt:
1232 case Instruction::IntToPtr:
1233 case Instruction::BitCast:
1235 NeedsExplicitCast = true;
1239 if (NeedsExplicitCast) {
1241 if (Ty->isIntegerTy() && Ty != Type::getInt1Ty(Ty->getContext()))
1242 printSimpleType(Out, Ty, TypeIsSigned);
1244 printType(Out, Ty); // not integer, sign doesn't matter
1247 return NeedsExplicitCast;
1250 // Print a constant assuming that it is the operand for a given Opcode. The
1251 // opcodes that care about sign need to cast their operands to the expected
1252 // type before the operation proceeds. This function does the casting.
1253 void CWriter::printConstantWithCast(Constant* CPV, unsigned Opcode) {
1255 // Extract the operand's type, we'll need it.
1256 const Type* OpTy = CPV->getType();
1258 // Indicate whether to do the cast or not.
1259 bool shouldCast = false;
1260 bool typeIsSigned = false;
1262 // Based on the Opcode for which this Constant is being written, determine
1263 // the new type to which the operand should be casted by setting the value
1264 // of OpTy. If we change OpTy, also set shouldCast to true so it gets
1268 // for most instructions, it doesn't matter
1270 case Instruction::Add:
1271 case Instruction::Sub:
1272 case Instruction::Mul:
1273 // We need to cast integer arithmetic so that it is always performed
1274 // as unsigned, to avoid undefined behavior on overflow.
1275 case Instruction::LShr:
1276 case Instruction::UDiv:
1277 case Instruction::URem:
1280 case Instruction::AShr:
1281 case Instruction::SDiv:
1282 case Instruction::SRem:
1284 typeIsSigned = true;
1288 // Write out the casted constant if we should, otherwise just write the
1292 printSimpleType(Out, OpTy, typeIsSigned);
1294 printConstant(CPV, false);
1297 printConstant(CPV, false);
1300 std::string CWriter::GetValueName(const Value *Operand) {
1301 // Mangle globals with the standard mangler interface for LLC compatibility.
1302 if (const GlobalValue *GV = dyn_cast<GlobalValue>(Operand)) {
1303 SmallString<128> Str;
1304 Mang->getNameWithPrefix(Str, GV, false);
1305 return CBEMangle(Str.str().str());
1308 std::string Name = Operand->getName();
1310 if (Name.empty()) { // Assign unique names to local temporaries.
1311 unsigned &No = AnonValueNumbers[Operand];
1313 No = ++NextAnonValueNumber;
1314 Name = "tmp__" + utostr(No);
1317 std::string VarName;
1318 VarName.reserve(Name.capacity());
1320 for (std::string::iterator I = Name.begin(), E = Name.end();
1324 if (!((ch >= 'a' && ch <= 'z') || (ch >= 'A' && ch <= 'Z') ||
1325 (ch >= '0' && ch <= '9') || ch == '_')) {
1327 sprintf(buffer, "_%x_", ch);
1333 return "llvm_cbe_" + VarName;
1336 /// writeInstComputationInline - Emit the computation for the specified
1337 /// instruction inline, with no destination provided.
1338 void CWriter::writeInstComputationInline(Instruction &I) {
1339 // We can't currently support integer types other than 1, 8, 16, 32, 64.
1341 const Type *Ty = I.getType();
1342 if (Ty->isIntegerTy() && (Ty!=Type::getInt1Ty(I.getContext()) &&
1343 Ty!=Type::getInt8Ty(I.getContext()) &&
1344 Ty!=Type::getInt16Ty(I.getContext()) &&
1345 Ty!=Type::getInt32Ty(I.getContext()) &&
1346 Ty!=Type::getInt64Ty(I.getContext()))) {
1347 report_fatal_error("The C backend does not currently support integer "
1348 "types of widths other than 1, 8, 16, 32, 64.\n"
1349 "This is being tracked as PR 4158.");
1352 // If this is a non-trivial bool computation, make sure to truncate down to
1353 // a 1 bit value. This is important because we want "add i1 x, y" to return
1354 // "0" when x and y are true, not "2" for example.
1355 bool NeedBoolTrunc = false;
1356 if (I.getType() == Type::getInt1Ty(I.getContext()) &&
1357 !isa<ICmpInst>(I) && !isa<FCmpInst>(I))
1358 NeedBoolTrunc = true;
1370 void CWriter::writeOperandInternal(Value *Operand, bool Static) {
1371 if (Instruction *I = dyn_cast<Instruction>(Operand))
1372 // Should we inline this instruction to build a tree?
1373 if (isInlinableInst(*I) && !isDirectAlloca(I)) {
1375 writeInstComputationInline(*I);
1380 Constant* CPV = dyn_cast<Constant>(Operand);
1382 if (CPV && !isa<GlobalValue>(CPV))
1383 printConstant(CPV, Static);
1385 Out << GetValueName(Operand);
1388 void CWriter::writeOperand(Value *Operand, bool Static) {
1389 bool isAddressImplicit = isAddressExposed(Operand);
1390 if (isAddressImplicit)
1391 Out << "(&"; // Global variables are referenced as their addresses by llvm
1393 writeOperandInternal(Operand, Static);
1395 if (isAddressImplicit)
1399 // Some instructions need to have their result value casted back to the
1400 // original types because their operands were casted to the expected type.
1401 // This function takes care of detecting that case and printing the cast
1402 // for the Instruction.
1403 bool CWriter::writeInstructionCast(const Instruction &I) {
1404 const Type *Ty = I.getOperand(0)->getType();
1405 switch (I.getOpcode()) {
1406 case Instruction::Add:
1407 case Instruction::Sub:
1408 case Instruction::Mul:
1409 // We need to cast integer arithmetic so that it is always performed
1410 // as unsigned, to avoid undefined behavior on overflow.
1411 case Instruction::LShr:
1412 case Instruction::URem:
1413 case Instruction::UDiv:
1415 printSimpleType(Out, Ty, false);
1418 case Instruction::AShr:
1419 case Instruction::SRem:
1420 case Instruction::SDiv:
1422 printSimpleType(Out, Ty, true);
1430 // Write the operand with a cast to another type based on the Opcode being used.
1431 // This will be used in cases where an instruction has specific type
1432 // requirements (usually signedness) for its operands.
1433 void CWriter::writeOperandWithCast(Value* Operand, unsigned Opcode) {
1435 // Extract the operand's type, we'll need it.
1436 const Type* OpTy = Operand->getType();
1438 // Indicate whether to do the cast or not.
1439 bool shouldCast = false;
1441 // Indicate whether the cast should be to a signed type or not.
1442 bool castIsSigned = false;
1444 // Based on the Opcode for which this Operand is being written, determine
1445 // the new type to which the operand should be casted by setting the value
1446 // of OpTy. If we change OpTy, also set shouldCast to true.
1449 // for most instructions, it doesn't matter
1451 case Instruction::Add:
1452 case Instruction::Sub:
1453 case Instruction::Mul:
1454 // We need to cast integer arithmetic so that it is always performed
1455 // as unsigned, to avoid undefined behavior on overflow.
1456 case Instruction::LShr:
1457 case Instruction::UDiv:
1458 case Instruction::URem: // Cast to unsigned first
1460 castIsSigned = false;
1462 case Instruction::GetElementPtr:
1463 case Instruction::AShr:
1464 case Instruction::SDiv:
1465 case Instruction::SRem: // Cast to signed first
1467 castIsSigned = true;
1471 // Write out the casted operand if we should, otherwise just write the
1475 printSimpleType(Out, OpTy, castIsSigned);
1477 writeOperand(Operand);
1480 writeOperand(Operand);
1483 // Write the operand with a cast to another type based on the icmp predicate
1485 void CWriter::writeOperandWithCast(Value* Operand, const ICmpInst &Cmp) {
1486 // This has to do a cast to ensure the operand has the right signedness.
1487 // Also, if the operand is a pointer, we make sure to cast to an integer when
1488 // doing the comparison both for signedness and so that the C compiler doesn't
1489 // optimize things like "p < NULL" to false (p may contain an integer value
1491 bool shouldCast = Cmp.isRelational();
1493 // Write out the casted operand if we should, otherwise just write the
1496 writeOperand(Operand);
1500 // Should this be a signed comparison? If so, convert to signed.
1501 bool castIsSigned = Cmp.isSigned();
1503 // If the operand was a pointer, convert to a large integer type.
1504 const Type* OpTy = Operand->getType();
1505 if (OpTy->isPointerTy())
1506 OpTy = TD->getIntPtrType(Operand->getContext());
1509 printSimpleType(Out, OpTy, castIsSigned);
1511 writeOperand(Operand);
1515 // generateCompilerSpecificCode - This is where we add conditional compilation
1516 // directives to cater to specific compilers as need be.
1518 static void generateCompilerSpecificCode(formatted_raw_ostream& Out,
1519 const TargetData *TD) {
1520 // Alloca is hard to get, and we don't want to include stdlib.h here.
1521 Out << "/* get a declaration for alloca */\n"
1522 << "#if defined(__CYGWIN__) || defined(__MINGW32__)\n"
1523 << "#define alloca(x) __builtin_alloca((x))\n"
1524 << "#define _alloca(x) __builtin_alloca((x))\n"
1525 << "#elif defined(__APPLE__)\n"
1526 << "extern void *__builtin_alloca(unsigned long);\n"
1527 << "#define alloca(x) __builtin_alloca(x)\n"
1528 << "#define longjmp _longjmp\n"
1529 << "#define setjmp _setjmp\n"
1530 << "#elif defined(__sun__)\n"
1531 << "#if defined(__sparcv9)\n"
1532 << "extern void *__builtin_alloca(unsigned long);\n"
1534 << "extern void *__builtin_alloca(unsigned int);\n"
1536 << "#define alloca(x) __builtin_alloca(x)\n"
1537 << "#elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) || defined(__arm__)\n"
1538 << "#define alloca(x) __builtin_alloca(x)\n"
1539 << "#elif defined(_MSC_VER)\n"
1540 << "#define inline _inline\n"
1541 << "#define alloca(x) _alloca(x)\n"
1543 << "#include <alloca.h>\n"
1546 // We output GCC specific attributes to preserve 'linkonce'ness on globals.
1547 // If we aren't being compiled with GCC, just drop these attributes.
1548 Out << "#ifndef __GNUC__ /* Can only support \"linkonce\" vars with GCC */\n"
1549 << "#define __attribute__(X)\n"
1552 // On Mac OS X, "external weak" is spelled "__attribute__((weak_import))".
1553 Out << "#if defined(__GNUC__) && defined(__APPLE_CC__)\n"
1554 << "#define __EXTERNAL_WEAK__ __attribute__((weak_import))\n"
1555 << "#elif defined(__GNUC__)\n"
1556 << "#define __EXTERNAL_WEAK__ __attribute__((weak))\n"
1558 << "#define __EXTERNAL_WEAK__\n"
1561 // For now, turn off the weak linkage attribute on Mac OS X. (See above.)
1562 Out << "#if defined(__GNUC__) && defined(__APPLE_CC__)\n"
1563 << "#define __ATTRIBUTE_WEAK__\n"
1564 << "#elif defined(__GNUC__)\n"
1565 << "#define __ATTRIBUTE_WEAK__ __attribute__((weak))\n"
1567 << "#define __ATTRIBUTE_WEAK__\n"
1570 // Add hidden visibility support. FIXME: APPLE_CC?
1571 Out << "#if defined(__GNUC__)\n"
1572 << "#define __HIDDEN__ __attribute__((visibility(\"hidden\")))\n"
1575 // Define NaN and Inf as GCC builtins if using GCC, as 0 otherwise
1576 // From the GCC documentation:
1578 // double __builtin_nan (const char *str)
1580 // This is an implementation of the ISO C99 function nan.
1582 // Since ISO C99 defines this function in terms of strtod, which we do
1583 // not implement, a description of the parsing is in order. The string is
1584 // parsed as by strtol; that is, the base is recognized by leading 0 or
1585 // 0x prefixes. The number parsed is placed in the significand such that
1586 // the least significant bit of the number is at the least significant
1587 // bit of the significand. The number is truncated to fit the significand
1588 // field provided. The significand is forced to be a quiet NaN.
1590 // This function, if given a string literal, is evaluated early enough
1591 // that it is considered a compile-time constant.
1593 // float __builtin_nanf (const char *str)
1595 // Similar to __builtin_nan, except the return type is float.
1597 // double __builtin_inf (void)
1599 // Similar to __builtin_huge_val, except a warning is generated if the
1600 // target floating-point format does not support infinities. This
1601 // function is suitable for implementing the ISO C99 macro INFINITY.
1603 // float __builtin_inff (void)
1605 // Similar to __builtin_inf, except the return type is float.
1606 Out << "#ifdef __GNUC__\n"
1607 << "#define LLVM_NAN(NanStr) __builtin_nan(NanStr) /* Double */\n"
1608 << "#define LLVM_NANF(NanStr) __builtin_nanf(NanStr) /* Float */\n"
1609 << "#define LLVM_NANS(NanStr) __builtin_nans(NanStr) /* Double */\n"
1610 << "#define LLVM_NANSF(NanStr) __builtin_nansf(NanStr) /* Float */\n"
1611 << "#define LLVM_INF __builtin_inf() /* Double */\n"
1612 << "#define LLVM_INFF __builtin_inff() /* Float */\n"
1613 << "#define LLVM_PREFETCH(addr,rw,locality) "
1614 "__builtin_prefetch(addr,rw,locality)\n"
1615 << "#define __ATTRIBUTE_CTOR__ __attribute__((constructor))\n"
1616 << "#define __ATTRIBUTE_DTOR__ __attribute__((destructor))\n"
1617 << "#define LLVM_ASM __asm__\n"
1619 << "#define LLVM_NAN(NanStr) ((double)0.0) /* Double */\n"
1620 << "#define LLVM_NANF(NanStr) 0.0F /* Float */\n"
1621 << "#define LLVM_NANS(NanStr) ((double)0.0) /* Double */\n"
1622 << "#define LLVM_NANSF(NanStr) 0.0F /* Float */\n"
1623 << "#define LLVM_INF ((double)0.0) /* Double */\n"
1624 << "#define LLVM_INFF 0.0F /* Float */\n"
1625 << "#define LLVM_PREFETCH(addr,rw,locality) /* PREFETCH */\n"
1626 << "#define __ATTRIBUTE_CTOR__\n"
1627 << "#define __ATTRIBUTE_DTOR__\n"
1628 << "#define LLVM_ASM(X)\n"
1631 Out << "#if __GNUC__ < 4 /* Old GCC's, or compilers not GCC */ \n"
1632 << "#define __builtin_stack_save() 0 /* not implemented */\n"
1633 << "#define __builtin_stack_restore(X) /* noop */\n"
1636 // Output typedefs for 128-bit integers. If these are needed with a
1637 // 32-bit target or with a C compiler that doesn't support mode(TI),
1638 // more drastic measures will be needed.
1639 Out << "#if __GNUC__ && __LP64__ /* 128-bit integer types */\n"
1640 << "typedef int __attribute__((mode(TI))) llvmInt128;\n"
1641 << "typedef unsigned __attribute__((mode(TI))) llvmUInt128;\n"
1644 // Output target-specific code that should be inserted into main.
1645 Out << "#define CODE_FOR_MAIN() /* Any target-specific code for main()*/\n";
1648 /// FindStaticTors - Given a static ctor/dtor list, unpack its contents into
1649 /// the StaticTors set.
1650 static void FindStaticTors(GlobalVariable *GV, std::set<Function*> &StaticTors){
1651 ConstantArray *InitList = dyn_cast<ConstantArray>(GV->getInitializer());
1652 if (!InitList) return;
1654 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
1655 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(i))){
1656 if (CS->getNumOperands() != 2) return; // Not array of 2-element structs.
1658 if (CS->getOperand(1)->isNullValue())
1659 return; // Found a null terminator, exit printing.
1660 Constant *FP = CS->getOperand(1);
1661 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(FP))
1663 FP = CE->getOperand(0);
1664 if (Function *F = dyn_cast<Function>(FP))
1665 StaticTors.insert(F);
1669 enum SpecialGlobalClass {
1671 GlobalCtors, GlobalDtors,
1675 /// getGlobalVariableClass - If this is a global that is specially recognized
1676 /// by LLVM, return a code that indicates how we should handle it.
1677 static SpecialGlobalClass getGlobalVariableClass(const GlobalVariable *GV) {
1678 // If this is a global ctors/dtors list, handle it now.
1679 if (GV->hasAppendingLinkage() && GV->use_empty()) {
1680 if (GV->getName() == "llvm.global_ctors")
1682 else if (GV->getName() == "llvm.global_dtors")
1686 // Otherwise, if it is other metadata, don't print it. This catches things
1687 // like debug information.
1688 if (GV->getSection() == "llvm.metadata")
1694 // PrintEscapedString - Print each character of the specified string, escaping
1695 // it if it is not printable or if it is an escape char.
1696 static void PrintEscapedString(const char *Str, unsigned Length,
1698 for (unsigned i = 0; i != Length; ++i) {
1699 unsigned char C = Str[i];
1700 if (isprint(C) && C != '\\' && C != '"')
1709 Out << "\\x" << hexdigit(C >> 4) << hexdigit(C & 0x0F);
1713 // PrintEscapedString - Print each character of the specified string, escaping
1714 // it if it is not printable or if it is an escape char.
1715 static void PrintEscapedString(const std::string &Str, raw_ostream &Out) {
1716 PrintEscapedString(Str.c_str(), Str.size(), Out);
1719 bool CWriter::doInitialization(Module &M) {
1720 FunctionPass::doInitialization(M);
1725 TD = new TargetData(&M);
1726 IL = new IntrinsicLowering(*TD);
1727 IL->AddPrototypes(M);
1730 std::string Triple = TheModule->getTargetTriple();
1732 Triple = llvm::sys::getHostTriple();
1735 if (const Target *Match = TargetRegistry::lookupTarget(Triple, E))
1736 TAsm = Match->createAsmInfo(Triple);
1738 TAsm = new CBEMCAsmInfo();
1739 TCtx = new MCContext(*TAsm);
1740 Mang = new Mangler(*TCtx, *TD);
1742 // Keep track of which functions are static ctors/dtors so they can have
1743 // an attribute added to their prototypes.
1744 std::set<Function*> StaticCtors, StaticDtors;
1745 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
1747 switch (getGlobalVariableClass(I)) {
1750 FindStaticTors(I, StaticCtors);
1753 FindStaticTors(I, StaticDtors);
1758 // get declaration for alloca
1759 Out << "/* Provide Declarations */\n";
1760 Out << "#include <stdarg.h>\n"; // Varargs support
1761 Out << "#include <setjmp.h>\n"; // Unwind support
1762 generateCompilerSpecificCode(Out, TD);
1764 // Provide a definition for `bool' if not compiling with a C++ compiler.
1766 << "#ifndef __cplusplus\ntypedef unsigned char bool;\n#endif\n"
1768 << "\n\n/* Support for floating point constants */\n"
1769 << "typedef unsigned long long ConstantDoubleTy;\n"
1770 << "typedef unsigned int ConstantFloatTy;\n"
1771 << "typedef struct { unsigned long long f1; unsigned short f2; "
1772 "unsigned short pad[3]; } ConstantFP80Ty;\n"
1773 // This is used for both kinds of 128-bit long double; meaning differs.
1774 << "typedef struct { unsigned long long f1; unsigned long long f2; }"
1775 " ConstantFP128Ty;\n"
1776 << "\n\n/* Global Declarations */\n";
1778 // First output all the declarations for the program, because C requires
1779 // Functions & globals to be declared before they are used.
1781 if (!M.getModuleInlineAsm().empty()) {
1782 Out << "/* Module asm statements */\n"
1785 // Split the string into lines, to make it easier to read the .ll file.
1786 std::string Asm = M.getModuleInlineAsm();
1788 size_t NewLine = Asm.find_first_of('\n', CurPos);
1789 while (NewLine != std::string::npos) {
1790 // We found a newline, print the portion of the asm string from the
1791 // last newline up to this newline.
1793 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.begin()+NewLine),
1797 NewLine = Asm.find_first_of('\n', CurPos);
1800 PrintEscapedString(std::string(Asm.begin()+CurPos, Asm.end()), Out);
1802 << "/* End Module asm statements */\n";
1805 // Loop over the symbol table, emitting all named constants...
1806 printModuleTypes(M.getTypeSymbolTable());
1808 // Global variable declarations...
1809 if (!M.global_empty()) {
1810 Out << "\n/* External Global Variable Declarations */\n";
1811 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
1814 if (I->hasExternalLinkage() || I->hasExternalWeakLinkage() ||
1815 I->hasCommonLinkage())
1817 else if (I->hasDLLImportLinkage())
1818 Out << "__declspec(dllimport) ";
1820 continue; // Internal Global
1822 // Thread Local Storage
1823 if (I->isThreadLocal())
1826 printType(Out, I->getType()->getElementType(), false, GetValueName(I));
1828 if (I->hasExternalWeakLinkage())
1829 Out << " __EXTERNAL_WEAK__";
1834 // Function declarations
1835 Out << "\n/* Function Declarations */\n";
1836 Out << "double fmod(double, double);\n"; // Support for FP rem
1837 Out << "float fmodf(float, float);\n";
1838 Out << "long double fmodl(long double, long double);\n";
1840 for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I) {
1841 // Don't print declarations for intrinsic functions.
1842 if (!I->isIntrinsic() && I->getName() != "setjmp" &&
1843 I->getName() != "longjmp" && I->getName() != "_setjmp") {
1844 if (I->hasExternalWeakLinkage())
1846 printFunctionSignature(I, true);
1847 if (I->hasWeakLinkage() || I->hasLinkOnceLinkage())
1848 Out << " __ATTRIBUTE_WEAK__";
1849 if (I->hasExternalWeakLinkage())
1850 Out << " __EXTERNAL_WEAK__";
1851 if (StaticCtors.count(I))
1852 Out << " __ATTRIBUTE_CTOR__";
1853 if (StaticDtors.count(I))
1854 Out << " __ATTRIBUTE_DTOR__";
1855 if (I->hasHiddenVisibility())
1856 Out << " __HIDDEN__";
1858 if (I->hasName() && I->getName()[0] == 1)
1859 Out << " LLVM_ASM(\"" << I->getName().substr(1) << "\")";
1865 // Output the global variable declarations
1866 if (!M.global_empty()) {
1867 Out << "\n\n/* Global Variable Declarations */\n";
1868 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
1870 if (!I->isDeclaration()) {
1871 // Ignore special globals, such as debug info.
1872 if (getGlobalVariableClass(I))
1875 if (I->hasLocalLinkage())
1880 // Thread Local Storage
1881 if (I->isThreadLocal())
1884 printType(Out, I->getType()->getElementType(), false,
1887 if (I->hasLinkOnceLinkage())
1888 Out << " __attribute__((common))";
1889 else if (I->hasCommonLinkage()) // FIXME is this right?
1890 Out << " __ATTRIBUTE_WEAK__";
1891 else if (I->hasWeakLinkage())
1892 Out << " __ATTRIBUTE_WEAK__";
1893 else if (I->hasExternalWeakLinkage())
1894 Out << " __EXTERNAL_WEAK__";
1895 if (I->hasHiddenVisibility())
1896 Out << " __HIDDEN__";
1901 // Output the global variable definitions and contents...
1902 if (!M.global_empty()) {
1903 Out << "\n\n/* Global Variable Definitions and Initialization */\n";
1904 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
1906 if (!I->isDeclaration()) {
1907 // Ignore special globals, such as debug info.
1908 if (getGlobalVariableClass(I))
1911 if (I->hasLocalLinkage())
1913 else if (I->hasDLLImportLinkage())
1914 Out << "__declspec(dllimport) ";
1915 else if (I->hasDLLExportLinkage())
1916 Out << "__declspec(dllexport) ";
1918 // Thread Local Storage
1919 if (I->isThreadLocal())
1922 printType(Out, I->getType()->getElementType(), false,
1924 if (I->hasLinkOnceLinkage())
1925 Out << " __attribute__((common))";
1926 else if (I->hasWeakLinkage())
1927 Out << " __ATTRIBUTE_WEAK__";
1928 else if (I->hasCommonLinkage())
1929 Out << " __ATTRIBUTE_WEAK__";
1931 if (I->hasHiddenVisibility())
1932 Out << " __HIDDEN__";
1934 // If the initializer is not null, emit the initializer. If it is null,
1935 // we try to avoid emitting large amounts of zeros. The problem with
1936 // this, however, occurs when the variable has weak linkage. In this
1937 // case, the assembler will complain about the variable being both weak
1938 // and common, so we disable this optimization.
1939 // FIXME common linkage should avoid this problem.
1940 if (!I->getInitializer()->isNullValue()) {
1942 writeOperand(I->getInitializer(), true);
1943 } else if (I->hasWeakLinkage()) {
1944 // We have to specify an initializer, but it doesn't have to be
1945 // complete. If the value is an aggregate, print out { 0 }, and let
1946 // the compiler figure out the rest of the zeros.
1948 if (I->getInitializer()->getType()->isStructTy() ||
1949 I->getInitializer()->getType()->isVectorTy()) {
1951 } else if (I->getInitializer()->getType()->isArrayTy()) {
1952 // As with structs and vectors, but with an extra set of braces
1953 // because arrays are wrapped in structs.
1956 // Just print it out normally.
1957 writeOperand(I->getInitializer(), true);
1965 Out << "\n\n/* Function Bodies */\n";
1967 // Emit some helper functions for dealing with FCMP instruction's
1969 Out << "static inline int llvm_fcmp_ord(double X, double Y) { ";
1970 Out << "return X == X && Y == Y; }\n";
1971 Out << "static inline int llvm_fcmp_uno(double X, double Y) { ";
1972 Out << "return X != X || Y != Y; }\n";
1973 Out << "static inline int llvm_fcmp_ueq(double X, double Y) { ";
1974 Out << "return X == Y || llvm_fcmp_uno(X, Y); }\n";
1975 Out << "static inline int llvm_fcmp_une(double X, double Y) { ";
1976 Out << "return X != Y; }\n";
1977 Out << "static inline int llvm_fcmp_ult(double X, double Y) { ";
1978 Out << "return X < Y || llvm_fcmp_uno(X, Y); }\n";
1979 Out << "static inline int llvm_fcmp_ugt(double X, double Y) { ";
1980 Out << "return X > Y || llvm_fcmp_uno(X, Y); }\n";
1981 Out << "static inline int llvm_fcmp_ule(double X, double Y) { ";
1982 Out << "return X <= Y || llvm_fcmp_uno(X, Y); }\n";
1983 Out << "static inline int llvm_fcmp_uge(double X, double Y) { ";
1984 Out << "return X >= Y || llvm_fcmp_uno(X, Y); }\n";
1985 Out << "static inline int llvm_fcmp_oeq(double X, double Y) { ";
1986 Out << "return X == Y ; }\n";
1987 Out << "static inline int llvm_fcmp_one(double X, double Y) { ";
1988 Out << "return X != Y && llvm_fcmp_ord(X, Y); }\n";
1989 Out << "static inline int llvm_fcmp_olt(double X, double Y) { ";
1990 Out << "return X < Y ; }\n";
1991 Out << "static inline int llvm_fcmp_ogt(double X, double Y) { ";
1992 Out << "return X > Y ; }\n";
1993 Out << "static inline int llvm_fcmp_ole(double X, double Y) { ";
1994 Out << "return X <= Y ; }\n";
1995 Out << "static inline int llvm_fcmp_oge(double X, double Y) { ";
1996 Out << "return X >= Y ; }\n";
2001 /// Output all floating point constants that cannot be printed accurately...
2002 void CWriter::printFloatingPointConstants(Function &F) {
2003 // Scan the module for floating point constants. If any FP constant is used
2004 // in the function, we want to redirect it here so that we do not depend on
2005 // the precision of the printed form, unless the printed form preserves
2008 for (constant_iterator I = constant_begin(&F), E = constant_end(&F);
2010 printFloatingPointConstants(*I);
2015 void CWriter::printFloatingPointConstants(const Constant *C) {
2016 // If this is a constant expression, recursively check for constant fp values.
2017 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
2018 for (unsigned i = 0, e = CE->getNumOperands(); i != e; ++i)
2019 printFloatingPointConstants(CE->getOperand(i));
2023 // Otherwise, check for a FP constant that we need to print.
2024 const ConstantFP *FPC = dyn_cast<ConstantFP>(C);
2026 // Do not put in FPConstantMap if safe.
2027 isFPCSafeToPrint(FPC) ||
2028 // Already printed this constant?
2029 FPConstantMap.count(FPC))
2032 FPConstantMap[FPC] = FPCounter; // Number the FP constants
2034 if (FPC->getType() == Type::getDoubleTy(FPC->getContext())) {
2035 double Val = FPC->getValueAPF().convertToDouble();
2036 uint64_t i = FPC->getValueAPF().bitcastToAPInt().getZExtValue();
2037 Out << "static const ConstantDoubleTy FPConstant" << FPCounter++
2038 << " = 0x" << utohexstr(i)
2039 << "ULL; /* " << Val << " */\n";
2040 } else if (FPC->getType() == Type::getFloatTy(FPC->getContext())) {
2041 float Val = FPC->getValueAPF().convertToFloat();
2042 uint32_t i = (uint32_t)FPC->getValueAPF().bitcastToAPInt().
2044 Out << "static const ConstantFloatTy FPConstant" << FPCounter++
2045 << " = 0x" << utohexstr(i)
2046 << "U; /* " << Val << " */\n";
2047 } else if (FPC->getType() == Type::getX86_FP80Ty(FPC->getContext())) {
2048 // api needed to prevent premature destruction
2049 APInt api = FPC->getValueAPF().bitcastToAPInt();
2050 const uint64_t *p = api.getRawData();
2051 Out << "static const ConstantFP80Ty FPConstant" << FPCounter++
2052 << " = { 0x" << utohexstr(p[0])
2053 << "ULL, 0x" << utohexstr((uint16_t)p[1]) << ",{0,0,0}"
2054 << "}; /* Long double constant */\n";
2055 } else if (FPC->getType() == Type::getPPC_FP128Ty(FPC->getContext()) ||
2056 FPC->getType() == Type::getFP128Ty(FPC->getContext())) {
2057 APInt api = FPC->getValueAPF().bitcastToAPInt();
2058 const uint64_t *p = api.getRawData();
2059 Out << "static const ConstantFP128Ty FPConstant" << FPCounter++
2061 << utohexstr(p[0]) << ", 0x" << utohexstr(p[1])
2062 << "}; /* Long double constant */\n";
2065 llvm_unreachable("Unknown float type!");
2071 /// printSymbolTable - Run through symbol table looking for type names. If a
2072 /// type name is found, emit its declaration...
2074 void CWriter::printModuleTypes(const TypeSymbolTable &TST) {
2075 Out << "/* Helper union for bitcasts */\n";
2076 Out << "typedef union {\n";
2077 Out << " unsigned int Int32;\n";
2078 Out << " unsigned long long Int64;\n";
2079 Out << " float Float;\n";
2080 Out << " double Double;\n";
2081 Out << "} llvmBitCastUnion;\n";
2083 // We are only interested in the type plane of the symbol table.
2084 TypeSymbolTable::const_iterator I = TST.begin();
2085 TypeSymbolTable::const_iterator End = TST.end();
2087 // If there are no type names, exit early.
2088 if (I == End) return;
2090 // Print out forward declarations for structure types before anything else!
2091 Out << "/* Structure forward decls */\n";
2092 for (; I != End; ++I) {
2093 std::string Name = "struct " + CBEMangle("l_"+I->first);
2094 Out << Name << ";\n";
2095 TypeNames.insert(std::make_pair(I->second, Name));
2100 // Now we can print out typedefs. Above, we guaranteed that this can only be
2101 // for struct or opaque types.
2102 Out << "/* Typedefs */\n";
2103 for (I = TST.begin(); I != End; ++I) {
2104 std::string Name = CBEMangle("l_"+I->first);
2106 printType(Out, I->second, false, Name);
2112 // Keep track of which structures have been printed so far...
2113 std::set<const Type *> StructPrinted;
2115 // Loop over all structures then push them into the stack so they are
2116 // printed in the correct order.
2118 Out << "/* Structure contents */\n";
2119 for (I = TST.begin(); I != End; ++I)
2120 if (I->second->isStructTy() || I->second->isArrayTy())
2121 // Only print out used types!
2122 printContainedStructs(I->second, StructPrinted);
2125 // Push the struct onto the stack and recursively push all structs
2126 // this one depends on.
2128 // TODO: Make this work properly with vector types
2130 void CWriter::printContainedStructs(const Type *Ty,
2131 std::set<const Type*> &StructPrinted) {
2132 // Don't walk through pointers.
2133 if (Ty->isPointerTy() || Ty->isPrimitiveType() || Ty->isIntegerTy())
2136 // Print all contained types first.
2137 for (Type::subtype_iterator I = Ty->subtype_begin(),
2138 E = Ty->subtype_end(); I != E; ++I)
2139 printContainedStructs(*I, StructPrinted);
2141 if (Ty->isStructTy() || Ty->isArrayTy()) {
2142 // Check to see if we have already printed this struct.
2143 if (StructPrinted.insert(Ty).second) {
2144 // Print structure type out.
2145 std::string Name = TypeNames[Ty];
2146 printType(Out, Ty, false, Name, true);
2152 void CWriter::printFunctionSignature(const Function *F, bool Prototype) {
2153 /// isStructReturn - Should this function actually return a struct by-value?
2154 bool isStructReturn = F->hasStructRetAttr();
2156 if (F->hasLocalLinkage()) Out << "static ";
2157 if (F->hasDLLImportLinkage()) Out << "__declspec(dllimport) ";
2158 if (F->hasDLLExportLinkage()) Out << "__declspec(dllexport) ";
2159 switch (F->getCallingConv()) {
2160 case CallingConv::X86_StdCall:
2161 Out << "__attribute__((stdcall)) ";
2163 case CallingConv::X86_FastCall:
2164 Out << "__attribute__((fastcall)) ";
2170 // Loop over the arguments, printing them...
2171 const FunctionType *FT = cast<FunctionType>(F->getFunctionType());
2172 const AttrListPtr &PAL = F->getAttributes();
2175 raw_string_ostream FunctionInnards(tstr);
2177 // Print out the name...
2178 FunctionInnards << GetValueName(F) << '(';
2180 bool PrintedArg = false;
2181 if (!F->isDeclaration()) {
2182 if (!F->arg_empty()) {
2183 Function::const_arg_iterator I = F->arg_begin(), E = F->arg_end();
2186 // If this is a struct-return function, don't print the hidden
2187 // struct-return argument.
2188 if (isStructReturn) {
2189 assert(I != E && "Invalid struct return function!");
2194 std::string ArgName;
2195 for (; I != E; ++I) {
2196 if (PrintedArg) FunctionInnards << ", ";
2197 if (I->hasName() || !Prototype)
2198 ArgName = GetValueName(I);
2201 const Type *ArgTy = I->getType();
2202 if (PAL.paramHasAttr(Idx, Attribute::ByVal)) {
2203 ArgTy = cast<PointerType>(ArgTy)->getElementType();
2204 ByValParams.insert(I);
2206 printType(FunctionInnards, ArgTy,
2207 /*isSigned=*/PAL.paramHasAttr(Idx, Attribute::SExt),
2214 // Loop over the arguments, printing them.
2215 FunctionType::param_iterator I = FT->param_begin(), E = FT->param_end();
2218 // If this is a struct-return function, don't print the hidden
2219 // struct-return argument.
2220 if (isStructReturn) {
2221 assert(I != E && "Invalid struct return function!");
2226 for (; I != E; ++I) {
2227 if (PrintedArg) FunctionInnards << ", ";
2228 const Type *ArgTy = *I;
2229 if (PAL.paramHasAttr(Idx, Attribute::ByVal)) {
2230 assert(ArgTy->isPointerTy());
2231 ArgTy = cast<PointerType>(ArgTy)->getElementType();
2233 printType(FunctionInnards, ArgTy,
2234 /*isSigned=*/PAL.paramHasAttr(Idx, Attribute::SExt));
2240 // Finish printing arguments... if this is a vararg function, print the ...,
2241 // unless there are no known types, in which case, we just emit ().
2243 if (FT->isVarArg() && PrintedArg) {
2244 if (PrintedArg) FunctionInnards << ", ";
2245 FunctionInnards << "..."; // Output varargs portion of signature!
2246 } else if (!FT->isVarArg() && !PrintedArg) {
2247 FunctionInnards << "void"; // ret() -> ret(void) in C.
2249 FunctionInnards << ')';
2251 // Get the return tpe for the function.
2253 if (!isStructReturn)
2254 RetTy = F->getReturnType();
2256 // If this is a struct-return function, print the struct-return type.
2257 RetTy = cast<PointerType>(FT->getParamType(0))->getElementType();
2260 // Print out the return type and the signature built above.
2261 printType(Out, RetTy,
2262 /*isSigned=*/PAL.paramHasAttr(0, Attribute::SExt),
2263 FunctionInnards.str());
2266 static inline bool isFPIntBitCast(const Instruction &I) {
2267 if (!isa<BitCastInst>(I))
2269 const Type *SrcTy = I.getOperand(0)->getType();
2270 const Type *DstTy = I.getType();
2271 return (SrcTy->isFloatingPointTy() && DstTy->isIntegerTy()) ||
2272 (DstTy->isFloatingPointTy() && SrcTy->isIntegerTy());
2275 void CWriter::printFunction(Function &F) {
2276 /// isStructReturn - Should this function actually return a struct by-value?
2277 bool isStructReturn = F.hasStructRetAttr();
2279 printFunctionSignature(&F, false);
2282 // If this is a struct return function, handle the result with magic.
2283 if (isStructReturn) {
2284 const Type *StructTy =
2285 cast<PointerType>(F.arg_begin()->getType())->getElementType();
2287 printType(Out, StructTy, false, "StructReturn");
2288 Out << "; /* Struct return temporary */\n";
2291 printType(Out, F.arg_begin()->getType(), false,
2292 GetValueName(F.arg_begin()));
2293 Out << " = &StructReturn;\n";
2296 bool PrintedVar = false;
2298 // print local variable information for the function
2299 for (inst_iterator I = inst_begin(&F), E = inst_end(&F); I != E; ++I) {
2300 if (const AllocaInst *AI = isDirectAlloca(&*I)) {
2302 printType(Out, AI->getAllocatedType(), false, GetValueName(AI));
2303 Out << "; /* Address-exposed local */\n";
2305 } else if (I->getType() != Type::getVoidTy(F.getContext()) &&
2306 !isInlinableInst(*I)) {
2308 printType(Out, I->getType(), false, GetValueName(&*I));
2311 if (isa<PHINode>(*I)) { // Print out PHI node temporaries as well...
2313 printType(Out, I->getType(), false,
2314 GetValueName(&*I)+"__PHI_TEMPORARY");
2319 // We need a temporary for the BitCast to use so it can pluck a value out
2320 // of a union to do the BitCast. This is separate from the need for a
2321 // variable to hold the result of the BitCast.
2322 if (isFPIntBitCast(*I)) {
2323 Out << " llvmBitCastUnion " << GetValueName(&*I)
2324 << "__BITCAST_TEMPORARY;\n";
2332 if (F.hasExternalLinkage() && F.getName() == "main")
2333 Out << " CODE_FOR_MAIN();\n";
2335 // print the basic blocks
2336 for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
2337 if (Loop *L = LI->getLoopFor(BB)) {
2338 if (L->getHeader() == BB && L->getParentLoop() == 0)
2341 printBasicBlock(BB);
2348 void CWriter::printLoop(Loop *L) {
2349 Out << " do { /* Syntactic loop '" << L->getHeader()->getName()
2350 << "' to make GCC happy */\n";
2351 for (unsigned i = 0, e = L->getBlocks().size(); i != e; ++i) {
2352 BasicBlock *BB = L->getBlocks()[i];
2353 Loop *BBLoop = LI->getLoopFor(BB);
2355 printBasicBlock(BB);
2356 else if (BB == BBLoop->getHeader() && BBLoop->getParentLoop() == L)
2359 Out << " } while (1); /* end of syntactic loop '"
2360 << L->getHeader()->getName() << "' */\n";
2363 void CWriter::printBasicBlock(BasicBlock *BB) {
2365 // Don't print the label for the basic block if there are no uses, or if
2366 // the only terminator use is the predecessor basic block's terminator.
2367 // We have to scan the use list because PHI nodes use basic blocks too but
2368 // do not require a label to be generated.
2370 bool NeedsLabel = false;
2371 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
2372 if (isGotoCodeNecessary(*PI, BB)) {
2377 if (NeedsLabel) Out << GetValueName(BB) << ":\n";
2379 // Output all of the instructions in the basic block...
2380 for (BasicBlock::iterator II = BB->begin(), E = --BB->end(); II != E;
2382 if (!isInlinableInst(*II) && !isDirectAlloca(II)) {
2383 if (II->getType() != Type::getVoidTy(BB->getContext()) &&
2388 writeInstComputationInline(*II);
2393 // Don't emit prefix or suffix for the terminator.
2394 visit(*BB->getTerminator());
2398 // Specific Instruction type classes... note that all of the casts are
2399 // necessary because we use the instruction classes as opaque types...
2401 void CWriter::visitReturnInst(ReturnInst &I) {
2402 // If this is a struct return function, return the temporary struct.
2403 bool isStructReturn = I.getParent()->getParent()->hasStructRetAttr();
2405 if (isStructReturn) {
2406 Out << " return StructReturn;\n";
2410 // Don't output a void return if this is the last basic block in the function
2411 if (I.getNumOperands() == 0 &&
2412 &*--I.getParent()->getParent()->end() == I.getParent() &&
2413 !I.getParent()->size() == 1) {
2417 if (I.getNumOperands() > 1) {
2420 printType(Out, I.getParent()->getParent()->getReturnType());
2421 Out << " llvm_cbe_mrv_temp = {\n";
2422 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
2424 writeOperand(I.getOperand(i));
2430 Out << " return llvm_cbe_mrv_temp;\n";
2436 if (I.getNumOperands()) {
2438 writeOperand(I.getOperand(0));
2443 void CWriter::visitSwitchInst(SwitchInst &SI) {
2446 writeOperand(SI.getOperand(0));
2447 Out << ") {\n default:\n";
2448 printPHICopiesForSuccessor (SI.getParent(), SI.getDefaultDest(), 2);
2449 printBranchToBlock(SI.getParent(), SI.getDefaultDest(), 2);
2451 for (unsigned i = 2, e = SI.getNumOperands(); i != e; i += 2) {
2453 writeOperand(SI.getOperand(i));
2455 BasicBlock *Succ = cast<BasicBlock>(SI.getOperand(i+1));
2456 printPHICopiesForSuccessor (SI.getParent(), Succ, 2);
2457 printBranchToBlock(SI.getParent(), Succ, 2);
2458 if (Function::iterator(Succ) == llvm::next(Function::iterator(SI.getParent())))
2464 void CWriter::visitIndirectBrInst(IndirectBrInst &IBI) {
2465 Out << " goto *(void*)(";
2466 writeOperand(IBI.getOperand(0));
2470 void CWriter::visitUnreachableInst(UnreachableInst &I) {
2471 Out << " /*UNREACHABLE*/;\n";
2474 bool CWriter::isGotoCodeNecessary(BasicBlock *From, BasicBlock *To) {
2475 /// FIXME: This should be reenabled, but loop reordering safe!!
2478 if (llvm::next(Function::iterator(From)) != Function::iterator(To))
2479 return true; // Not the direct successor, we need a goto.
2481 //isa<SwitchInst>(From->getTerminator())
2483 if (LI->getLoopFor(From) != LI->getLoopFor(To))
2488 void CWriter::printPHICopiesForSuccessor (BasicBlock *CurBlock,
2489 BasicBlock *Successor,
2491 for (BasicBlock::iterator I = Successor->begin(); isa<PHINode>(I); ++I) {
2492 PHINode *PN = cast<PHINode>(I);
2493 // Now we have to do the printing.
2494 Value *IV = PN->getIncomingValueForBlock(CurBlock);
2495 if (!isa<UndefValue>(IV)) {
2496 Out << std::string(Indent, ' ');
2497 Out << " " << GetValueName(I) << "__PHI_TEMPORARY = ";
2499 Out << "; /* for PHI node */\n";
2504 void CWriter::printBranchToBlock(BasicBlock *CurBB, BasicBlock *Succ,
2506 if (isGotoCodeNecessary(CurBB, Succ)) {
2507 Out << std::string(Indent, ' ') << " goto ";
2513 // Branch instruction printing - Avoid printing out a branch to a basic block
2514 // that immediately succeeds the current one.
2516 void CWriter::visitBranchInst(BranchInst &I) {
2518 if (I.isConditional()) {
2519 if (isGotoCodeNecessary(I.getParent(), I.getSuccessor(0))) {
2521 writeOperand(I.getCondition());
2524 printPHICopiesForSuccessor (I.getParent(), I.getSuccessor(0), 2);
2525 printBranchToBlock(I.getParent(), I.getSuccessor(0), 2);
2527 if (isGotoCodeNecessary(I.getParent(), I.getSuccessor(1))) {
2528 Out << " } else {\n";
2529 printPHICopiesForSuccessor (I.getParent(), I.getSuccessor(1), 2);
2530 printBranchToBlock(I.getParent(), I.getSuccessor(1), 2);
2533 // First goto not necessary, assume second one is...
2535 writeOperand(I.getCondition());
2538 printPHICopiesForSuccessor (I.getParent(), I.getSuccessor(1), 2);
2539 printBranchToBlock(I.getParent(), I.getSuccessor(1), 2);
2544 printPHICopiesForSuccessor (I.getParent(), I.getSuccessor(0), 0);
2545 printBranchToBlock(I.getParent(), I.getSuccessor(0), 0);
2550 // PHI nodes get copied into temporary values at the end of predecessor basic
2551 // blocks. We now need to copy these temporary values into the REAL value for
2553 void CWriter::visitPHINode(PHINode &I) {
2555 Out << "__PHI_TEMPORARY";
2559 void CWriter::visitBinaryOperator(Instruction &I) {
2560 // binary instructions, shift instructions, setCond instructions.
2561 assert(!I.getType()->isPointerTy());
2563 // We must cast the results of binary operations which might be promoted.
2564 bool needsCast = false;
2565 if ((I.getType() == Type::getInt8Ty(I.getContext())) ||
2566 (I.getType() == Type::getInt16Ty(I.getContext()))
2567 || (I.getType() == Type::getFloatTy(I.getContext()))) {
2570 printType(Out, I.getType(), false);
2574 // If this is a negation operation, print it out as such. For FP, we don't
2575 // want to print "-0.0 - X".
2576 if (BinaryOperator::isNeg(&I)) {
2578 writeOperand(BinaryOperator::getNegArgument(cast<BinaryOperator>(&I)));
2580 } else if (BinaryOperator::isFNeg(&I)) {
2582 writeOperand(BinaryOperator::getFNegArgument(cast<BinaryOperator>(&I)));
2584 } else if (I.getOpcode() == Instruction::FRem) {
2585 // Output a call to fmod/fmodf instead of emitting a%b
2586 if (I.getType() == Type::getFloatTy(I.getContext()))
2588 else if (I.getType() == Type::getDoubleTy(I.getContext()))
2590 else // all 3 flavors of long double
2592 writeOperand(I.getOperand(0));
2594 writeOperand(I.getOperand(1));
2598 // Write out the cast of the instruction's value back to the proper type
2600 bool NeedsClosingParens = writeInstructionCast(I);
2602 // Certain instructions require the operand to be forced to a specific type
2603 // so we use writeOperandWithCast here instead of writeOperand. Similarly
2604 // below for operand 1
2605 writeOperandWithCast(I.getOperand(0), I.getOpcode());
2607 switch (I.getOpcode()) {
2608 case Instruction::Add:
2609 case Instruction::FAdd: Out << " + "; break;
2610 case Instruction::Sub:
2611 case Instruction::FSub: Out << " - "; break;
2612 case Instruction::Mul:
2613 case Instruction::FMul: Out << " * "; break;
2614 case Instruction::URem:
2615 case Instruction::SRem:
2616 case Instruction::FRem: Out << " % "; break;
2617 case Instruction::UDiv:
2618 case Instruction::SDiv:
2619 case Instruction::FDiv: Out << " / "; break;
2620 case Instruction::And: Out << " & "; break;
2621 case Instruction::Or: Out << " | "; break;
2622 case Instruction::Xor: Out << " ^ "; break;
2623 case Instruction::Shl : Out << " << "; break;
2624 case Instruction::LShr:
2625 case Instruction::AShr: Out << " >> "; break;
2628 errs() << "Invalid operator type!" << I;
2630 llvm_unreachable(0);
2633 writeOperandWithCast(I.getOperand(1), I.getOpcode());
2634 if (NeedsClosingParens)
2643 void CWriter::visitICmpInst(ICmpInst &I) {
2644 // We must cast the results of icmp which might be promoted.
2645 bool needsCast = false;
2647 // Write out the cast of the instruction's value back to the proper type
2649 bool NeedsClosingParens = writeInstructionCast(I);
2651 // Certain icmp predicate require the operand to be forced to a specific type
2652 // so we use writeOperandWithCast here instead of writeOperand. Similarly
2653 // below for operand 1
2654 writeOperandWithCast(I.getOperand(0), I);
2656 switch (I.getPredicate()) {
2657 case ICmpInst::ICMP_EQ: Out << " == "; break;
2658 case ICmpInst::ICMP_NE: Out << " != "; break;
2659 case ICmpInst::ICMP_ULE:
2660 case ICmpInst::ICMP_SLE: Out << " <= "; break;
2661 case ICmpInst::ICMP_UGE:
2662 case ICmpInst::ICMP_SGE: Out << " >= "; break;
2663 case ICmpInst::ICMP_ULT:
2664 case ICmpInst::ICMP_SLT: Out << " < "; break;
2665 case ICmpInst::ICMP_UGT:
2666 case ICmpInst::ICMP_SGT: Out << " > "; break;
2669 errs() << "Invalid icmp predicate!" << I;
2671 llvm_unreachable(0);
2674 writeOperandWithCast(I.getOperand(1), I);
2675 if (NeedsClosingParens)
2683 void CWriter::visitFCmpInst(FCmpInst &I) {
2684 if (I.getPredicate() == FCmpInst::FCMP_FALSE) {
2688 if (I.getPredicate() == FCmpInst::FCMP_TRUE) {
2694 switch (I.getPredicate()) {
2695 default: llvm_unreachable("Illegal FCmp predicate");
2696 case FCmpInst::FCMP_ORD: op = "ord"; break;
2697 case FCmpInst::FCMP_UNO: op = "uno"; break;
2698 case FCmpInst::FCMP_UEQ: op = "ueq"; break;
2699 case FCmpInst::FCMP_UNE: op = "une"; break;
2700 case FCmpInst::FCMP_ULT: op = "ult"; break;
2701 case FCmpInst::FCMP_ULE: op = "ule"; break;
2702 case FCmpInst::FCMP_UGT: op = "ugt"; break;
2703 case FCmpInst::FCMP_UGE: op = "uge"; break;
2704 case FCmpInst::FCMP_OEQ: op = "oeq"; break;
2705 case FCmpInst::FCMP_ONE: op = "one"; break;
2706 case FCmpInst::FCMP_OLT: op = "olt"; break;
2707 case FCmpInst::FCMP_OLE: op = "ole"; break;
2708 case FCmpInst::FCMP_OGT: op = "ogt"; break;
2709 case FCmpInst::FCMP_OGE: op = "oge"; break;
2712 Out << "llvm_fcmp_" << op << "(";
2713 // Write the first operand
2714 writeOperand(I.getOperand(0));
2716 // Write the second operand
2717 writeOperand(I.getOperand(1));
2721 static const char * getFloatBitCastField(const Type *Ty) {
2722 switch (Ty->getTypeID()) {
2723 default: llvm_unreachable("Invalid Type");
2724 case Type::FloatTyID: return "Float";
2725 case Type::DoubleTyID: return "Double";
2726 case Type::IntegerTyID: {
2727 unsigned NumBits = cast<IntegerType>(Ty)->getBitWidth();
2736 void CWriter::visitCastInst(CastInst &I) {
2737 const Type *DstTy = I.getType();
2738 const Type *SrcTy = I.getOperand(0)->getType();
2739 if (isFPIntBitCast(I)) {
2741 // These int<->float and long<->double casts need to be handled specially
2742 Out << GetValueName(&I) << "__BITCAST_TEMPORARY."
2743 << getFloatBitCastField(I.getOperand(0)->getType()) << " = ";
2744 writeOperand(I.getOperand(0));
2745 Out << ", " << GetValueName(&I) << "__BITCAST_TEMPORARY."
2746 << getFloatBitCastField(I.getType());
2752 printCast(I.getOpcode(), SrcTy, DstTy);
2754 // Make a sext from i1 work by subtracting the i1 from 0 (an int).
2755 if (SrcTy == Type::getInt1Ty(I.getContext()) &&
2756 I.getOpcode() == Instruction::SExt)
2759 writeOperand(I.getOperand(0));
2761 if (DstTy == Type::getInt1Ty(I.getContext()) &&
2762 (I.getOpcode() == Instruction::Trunc ||
2763 I.getOpcode() == Instruction::FPToUI ||
2764 I.getOpcode() == Instruction::FPToSI ||
2765 I.getOpcode() == Instruction::PtrToInt)) {
2766 // Make sure we really get a trunc to bool by anding the operand with 1
2772 void CWriter::visitSelectInst(SelectInst &I) {
2774 writeOperand(I.getCondition());
2776 writeOperand(I.getTrueValue());
2778 writeOperand(I.getFalseValue());
2783 void CWriter::lowerIntrinsics(Function &F) {
2784 // This is used to keep track of intrinsics that get generated to a lowered
2785 // function. We must generate the prototypes before the function body which
2786 // will only be expanded on first use (by the loop below).
2787 std::vector<Function*> prototypesToGen;
2789 // Examine all the instructions in this function to find the intrinsics that
2790 // need to be lowered.
2791 for (Function::iterator BB = F.begin(), EE = F.end(); BB != EE; ++BB)
2792 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; )
2793 if (CallInst *CI = dyn_cast<CallInst>(I++))
2794 if (Function *F = CI->getCalledFunction())
2795 switch (F->getIntrinsicID()) {
2796 case Intrinsic::not_intrinsic:
2797 case Intrinsic::memory_barrier:
2798 case Intrinsic::vastart:
2799 case Intrinsic::vacopy:
2800 case Intrinsic::vaend:
2801 case Intrinsic::returnaddress:
2802 case Intrinsic::frameaddress:
2803 case Intrinsic::setjmp:
2804 case Intrinsic::longjmp:
2805 case Intrinsic::prefetch:
2806 case Intrinsic::powi:
2807 case Intrinsic::x86_sse_cmp_ss:
2808 case Intrinsic::x86_sse_cmp_ps:
2809 case Intrinsic::x86_sse2_cmp_sd:
2810 case Intrinsic::x86_sse2_cmp_pd:
2811 case Intrinsic::ppc_altivec_lvsl:
2812 // We directly implement these intrinsics
2815 // If this is an intrinsic that directly corresponds to a GCC
2816 // builtin, we handle it.
2817 const char *BuiltinName = "";
2818 #define GET_GCC_BUILTIN_NAME
2819 #include "llvm/Intrinsics.gen"
2820 #undef GET_GCC_BUILTIN_NAME
2821 // If we handle it, don't lower it.
2822 if (BuiltinName[0]) break;
2824 // All other intrinsic calls we must lower.
2825 Instruction *Before = 0;
2826 if (CI != &BB->front())
2827 Before = prior(BasicBlock::iterator(CI));
2829 IL->LowerIntrinsicCall(CI);
2830 if (Before) { // Move iterator to instruction after call
2835 // If the intrinsic got lowered to another call, and that call has
2836 // a definition then we need to make sure its prototype is emitted
2837 // before any calls to it.
2838 if (CallInst *Call = dyn_cast<CallInst>(I))
2839 if (Function *NewF = Call->getCalledFunction())
2840 if (!NewF->isDeclaration())
2841 prototypesToGen.push_back(NewF);
2846 // We may have collected some prototypes to emit in the loop above.
2847 // Emit them now, before the function that uses them is emitted. But,
2848 // be careful not to emit them twice.
2849 std::vector<Function*>::iterator I = prototypesToGen.begin();
2850 std::vector<Function*>::iterator E = prototypesToGen.end();
2851 for ( ; I != E; ++I) {
2852 if (intrinsicPrototypesAlreadyGenerated.insert(*I).second) {
2854 printFunctionSignature(*I, true);
2860 void CWriter::visitCallInst(CallInst &I) {
2861 if (isa<InlineAsm>(I.getOperand(0)))
2862 return visitInlineAsm(I);
2864 bool WroteCallee = false;
2866 // Handle intrinsic function calls first...
2867 if (Function *F = I.getCalledFunction())
2868 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
2869 if (visitBuiltinCall(I, ID, WroteCallee))
2872 Value *Callee = I.getCalledValue();
2874 const PointerType *PTy = cast<PointerType>(Callee->getType());
2875 const FunctionType *FTy = cast<FunctionType>(PTy->getElementType());
2877 // If this is a call to a struct-return function, assign to the first
2878 // parameter instead of passing it to the call.
2879 const AttrListPtr &PAL = I.getAttributes();
2880 bool hasByVal = I.hasByValArgument();
2881 bool isStructRet = I.hasStructRetAttr();
2883 writeOperandDeref(I.getOperand(1));
2887 if (I.isTailCall()) Out << " /*tail*/ ";
2890 // If this is an indirect call to a struct return function, we need to cast
2891 // the pointer. Ditto for indirect calls with byval arguments.
2892 bool NeedsCast = (hasByVal || isStructRet) && !isa<Function>(Callee);
2894 // GCC is a real PITA. It does not permit codegening casts of functions to
2895 // function pointers if they are in a call (it generates a trap instruction
2896 // instead!). We work around this by inserting a cast to void* in between
2897 // the function and the function pointer cast. Unfortunately, we can't just
2898 // form the constant expression here, because the folder will immediately
2901 // Note finally, that this is completely unsafe. ANSI C does not guarantee
2902 // that void* and function pointers have the same size. :( To deal with this
2903 // in the common case, we handle casts where the number of arguments passed
2906 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Callee))
2908 if (Function *RF = dyn_cast<Function>(CE->getOperand(0))) {
2914 // Ok, just cast the pointer type.
2917 printStructReturnPointerFunctionType(Out, PAL,
2918 cast<PointerType>(I.getCalledValue()->getType()));
2920 printType(Out, I.getCalledValue()->getType(), false, "", true, PAL);
2922 printType(Out, I.getCalledValue()->getType());
2925 writeOperand(Callee);
2926 if (NeedsCast) Out << ')';
2931 unsigned NumDeclaredParams = FTy->getNumParams();
2933 CallSite::arg_iterator AI = I.op_begin()+1, AE = I.op_end();
2935 if (isStructRet) { // Skip struct return argument.
2940 bool PrintedArg = false;
2941 for (; AI != AE; ++AI, ++ArgNo) {
2942 if (PrintedArg) Out << ", ";
2943 if (ArgNo < NumDeclaredParams &&
2944 (*AI)->getType() != FTy->getParamType(ArgNo)) {
2946 printType(Out, FTy->getParamType(ArgNo),
2947 /*isSigned=*/PAL.paramHasAttr(ArgNo+1, Attribute::SExt));
2950 // Check if the argument is expected to be passed by value.
2951 if (I.paramHasAttr(ArgNo+1, Attribute::ByVal))
2952 writeOperandDeref(*AI);
2960 /// visitBuiltinCall - Handle the call to the specified builtin. Returns true
2961 /// if the entire call is handled, return false if it wasn't handled, and
2962 /// optionally set 'WroteCallee' if the callee has already been printed out.
2963 bool CWriter::visitBuiltinCall(CallInst &I, Intrinsic::ID ID,
2964 bool &WroteCallee) {
2967 // If this is an intrinsic that directly corresponds to a GCC
2968 // builtin, we emit it here.
2969 const char *BuiltinName = "";
2970 Function *F = I.getCalledFunction();
2971 #define GET_GCC_BUILTIN_NAME
2972 #include "llvm/Intrinsics.gen"
2973 #undef GET_GCC_BUILTIN_NAME
2974 assert(BuiltinName[0] && "Unknown LLVM intrinsic!");
2980 case Intrinsic::memory_barrier:
2981 Out << "__sync_synchronize()";
2983 case Intrinsic::vastart:
2986 Out << "va_start(*(va_list*)";
2987 writeOperand(I.getOperand(1));
2989 // Output the last argument to the enclosing function.
2990 if (I.getParent()->getParent()->arg_empty()) {
2992 raw_string_ostream Msg(msg);
2993 Msg << "The C backend does not currently support zero "
2994 << "argument varargs functions, such as '"
2995 << I.getParent()->getParent()->getName() << "'!";
2996 report_fatal_error(Msg.str());
2998 writeOperand(--I.getParent()->getParent()->arg_end());
3001 case Intrinsic::vaend:
3002 if (!isa<ConstantPointerNull>(I.getOperand(1))) {
3003 Out << "0; va_end(*(va_list*)";
3004 writeOperand(I.getOperand(1));
3007 Out << "va_end(*(va_list*)0)";
3010 case Intrinsic::vacopy:
3012 Out << "va_copy(*(va_list*)";
3013 writeOperand(I.getOperand(1));
3014 Out << ", *(va_list*)";
3015 writeOperand(I.getOperand(2));
3018 case Intrinsic::returnaddress:
3019 Out << "__builtin_return_address(";
3020 writeOperand(I.getOperand(1));
3023 case Intrinsic::frameaddress:
3024 Out << "__builtin_frame_address(";
3025 writeOperand(I.getOperand(1));
3028 case Intrinsic::powi:
3029 Out << "__builtin_powi(";
3030 writeOperand(I.getOperand(1));
3032 writeOperand(I.getOperand(2));
3035 case Intrinsic::setjmp:
3036 Out << "setjmp(*(jmp_buf*)";
3037 writeOperand(I.getOperand(1));
3040 case Intrinsic::longjmp:
3041 Out << "longjmp(*(jmp_buf*)";
3042 writeOperand(I.getOperand(1));
3044 writeOperand(I.getOperand(2));
3047 case Intrinsic::prefetch:
3048 Out << "LLVM_PREFETCH((const void *)";
3049 writeOperand(I.getOperand(1));
3051 writeOperand(I.getOperand(2));
3053 writeOperand(I.getOperand(3));
3056 case Intrinsic::stacksave:
3057 // Emit this as: Val = 0; *((void**)&Val) = __builtin_stack_save()
3058 // to work around GCC bugs (see PR1809).
3059 Out << "0; *((void**)&" << GetValueName(&I)
3060 << ") = __builtin_stack_save()";
3062 case Intrinsic::x86_sse_cmp_ss:
3063 case Intrinsic::x86_sse_cmp_ps:
3064 case Intrinsic::x86_sse2_cmp_sd:
3065 case Intrinsic::x86_sse2_cmp_pd:
3067 printType(Out, I.getType());
3069 // Multiple GCC builtins multiplex onto this intrinsic.
3070 switch (cast<ConstantInt>(I.getOperand(3))->getZExtValue()) {
3071 default: llvm_unreachable("Invalid llvm.x86.sse.cmp!");
3072 case 0: Out << "__builtin_ia32_cmpeq"; break;
3073 case 1: Out << "__builtin_ia32_cmplt"; break;
3074 case 2: Out << "__builtin_ia32_cmple"; break;
3075 case 3: Out << "__builtin_ia32_cmpunord"; break;
3076 case 4: Out << "__builtin_ia32_cmpneq"; break;
3077 case 5: Out << "__builtin_ia32_cmpnlt"; break;
3078 case 6: Out << "__builtin_ia32_cmpnle"; break;
3079 case 7: Out << "__builtin_ia32_cmpord"; break;
3081 if (ID == Intrinsic::x86_sse_cmp_ps || ID == Intrinsic::x86_sse2_cmp_pd)
3085 if (ID == Intrinsic::x86_sse_cmp_ss || ID == Intrinsic::x86_sse_cmp_ps)
3091 writeOperand(I.getOperand(1));
3093 writeOperand(I.getOperand(2));
3096 case Intrinsic::ppc_altivec_lvsl:
3098 printType(Out, I.getType());
3100 Out << "__builtin_altivec_lvsl(0, (void*)";
3101 writeOperand(I.getOperand(1));
3107 //This converts the llvm constraint string to something gcc is expecting.
3108 //TODO: work out platform independent constraints and factor those out
3109 // of the per target tables
3110 // handle multiple constraint codes
3111 std::string CWriter::InterpretASMConstraint(InlineAsm::ConstraintInfo& c) {
3112 assert(c.Codes.size() == 1 && "Too many asm constraint codes to handle");
3114 // Grab the translation table from MCAsmInfo if it exists.
3115 const MCAsmInfo *TargetAsm;
3116 std::string Triple = TheModule->getTargetTriple();
3118 Triple = llvm::sys::getHostTriple();
3121 if (const Target *Match = TargetRegistry::lookupTarget(Triple, E))
3122 TargetAsm = Match->createAsmInfo(Triple);
3126 const char *const *table = TargetAsm->getAsmCBE();
3128 // Search the translation table if it exists.
3129 for (int i = 0; table && table[i]; i += 2)
3130 if (c.Codes[0] == table[i]) {
3135 // Default is identity.
3140 //TODO: import logic from AsmPrinter.cpp
3141 static std::string gccifyAsm(std::string asmstr) {
3142 for (std::string::size_type i = 0; i != asmstr.size(); ++i)
3143 if (asmstr[i] == '\n')
3144 asmstr.replace(i, 1, "\\n");
3145 else if (asmstr[i] == '\t')
3146 asmstr.replace(i, 1, "\\t");
3147 else if (asmstr[i] == '$') {
3148 if (asmstr[i + 1] == '{') {
3149 std::string::size_type a = asmstr.find_first_of(':', i + 1);
3150 std::string::size_type b = asmstr.find_first_of('}', i + 1);
3151 std::string n = "%" +
3152 asmstr.substr(a + 1, b - a - 1) +
3153 asmstr.substr(i + 2, a - i - 2);
3154 asmstr.replace(i, b - i + 1, n);
3157 asmstr.replace(i, 1, "%");
3159 else if (asmstr[i] == '%')//grr
3160 { asmstr.replace(i, 1, "%%"); ++i;}
3165 //TODO: assumptions about what consume arguments from the call are likely wrong
3166 // handle communitivity
3167 void CWriter::visitInlineAsm(CallInst &CI) {
3168 InlineAsm* as = cast<InlineAsm>(CI.getOperand(0));
3169 std::vector<InlineAsm::ConstraintInfo> Constraints = as->ParseConstraints();
3171 std::vector<std::pair<Value*, int> > ResultVals;
3172 if (CI.getType() == Type::getVoidTy(CI.getContext()))
3174 else if (const StructType *ST = dyn_cast<StructType>(CI.getType())) {
3175 for (unsigned i = 0, e = ST->getNumElements(); i != e; ++i)
3176 ResultVals.push_back(std::make_pair(&CI, (int)i));
3178 ResultVals.push_back(std::make_pair(&CI, -1));
3181 // Fix up the asm string for gcc and emit it.
3182 Out << "__asm__ volatile (\"" << gccifyAsm(as->getAsmString()) << "\"\n";
3185 unsigned ValueCount = 0;
3186 bool IsFirst = true;
3188 // Convert over all the output constraints.
3189 for (std::vector<InlineAsm::ConstraintInfo>::iterator I = Constraints.begin(),
3190 E = Constraints.end(); I != E; ++I) {
3192 if (I->Type != InlineAsm::isOutput) {
3194 continue; // Ignore non-output constraints.
3197 assert(I->Codes.size() == 1 && "Too many asm constraint codes to handle");
3198 std::string C = InterpretASMConstraint(*I);
3199 if (C.empty()) continue;
3210 if (ValueCount < ResultVals.size()) {
3211 DestVal = ResultVals[ValueCount].first;
3212 DestValNo = ResultVals[ValueCount].second;
3214 DestVal = CI.getOperand(ValueCount-ResultVals.size()+1);
3216 if (I->isEarlyClobber)
3219 Out << "\"=" << C << "\"(" << GetValueName(DestVal);
3220 if (DestValNo != -1)
3221 Out << ".field" << DestValNo; // Multiple retvals.
3227 // Convert over all the input constraints.
3231 for (std::vector<InlineAsm::ConstraintInfo>::iterator I = Constraints.begin(),
3232 E = Constraints.end(); I != E; ++I) {
3233 if (I->Type != InlineAsm::isInput) {
3235 continue; // Ignore non-input constraints.
3238 assert(I->Codes.size() == 1 && "Too many asm constraint codes to handle");
3239 std::string C = InterpretASMConstraint(*I);
3240 if (C.empty()) continue;
3247 assert(ValueCount >= ResultVals.size() && "Input can't refer to result");
3248 Value *SrcVal = CI.getOperand(ValueCount-ResultVals.size()+1);
3250 Out << "\"" << C << "\"(";
3252 writeOperand(SrcVal);
3254 writeOperandDeref(SrcVal);
3258 // Convert over the clobber constraints.
3260 for (std::vector<InlineAsm::ConstraintInfo>::iterator I = Constraints.begin(),
3261 E = Constraints.end(); I != E; ++I) {
3262 if (I->Type != InlineAsm::isClobber)
3263 continue; // Ignore non-input constraints.
3265 assert(I->Codes.size() == 1 && "Too many asm constraint codes to handle");
3266 std::string C = InterpretASMConstraint(*I);
3267 if (C.empty()) continue;
3274 Out << '\"' << C << '"';
3280 void CWriter::visitAllocaInst(AllocaInst &I) {
3282 printType(Out, I.getType());
3283 Out << ") alloca(sizeof(";
3284 printType(Out, I.getType()->getElementType());
3286 if (I.isArrayAllocation()) {
3288 writeOperand(I.getOperand(0));
3293 void CWriter::printGEPExpression(Value *Ptr, gep_type_iterator I,
3294 gep_type_iterator E, bool Static) {
3296 // If there are no indices, just print out the pointer.
3302 // Find out if the last index is into a vector. If so, we have to print this
3303 // specially. Since vectors can't have elements of indexable type, only the
3304 // last index could possibly be of a vector element.
3305 const VectorType *LastIndexIsVector = 0;
3307 for (gep_type_iterator TmpI = I; TmpI != E; ++TmpI)
3308 LastIndexIsVector = dyn_cast<VectorType>(*TmpI);
3313 // If the last index is into a vector, we can't print it as &a[i][j] because
3314 // we can't index into a vector with j in GCC. Instead, emit this as
3315 // (((float*)&a[i])+j)
3316 if (LastIndexIsVector) {
3318 printType(Out, PointerType::getUnqual(LastIndexIsVector->getElementType()));
3324 // If the first index is 0 (very typical) we can do a number of
3325 // simplifications to clean up the code.
3326 Value *FirstOp = I.getOperand();
3327 if (!isa<Constant>(FirstOp) || !cast<Constant>(FirstOp)->isNullValue()) {
3328 // First index isn't simple, print it the hard way.
3331 ++I; // Skip the zero index.
3333 // Okay, emit the first operand. If Ptr is something that is already address
3334 // exposed, like a global, avoid emitting (&foo)[0], just emit foo instead.
3335 if (isAddressExposed(Ptr)) {
3336 writeOperandInternal(Ptr, Static);
3337 } else if (I != E && (*I)->isStructTy()) {
3338 // If we didn't already emit the first operand, see if we can print it as
3339 // P->f instead of "P[0].f"
3341 Out << "->field" << cast<ConstantInt>(I.getOperand())->getZExtValue();
3342 ++I; // eat the struct index as well.
3344 // Instead of emitting P[0][1], emit (*P)[1], which is more idiomatic.
3351 for (; I != E; ++I) {
3352 if ((*I)->isStructTy()) {
3353 Out << ".field" << cast<ConstantInt>(I.getOperand())->getZExtValue();
3354 } else if ((*I)->isArrayTy()) {
3356 writeOperandWithCast(I.getOperand(), Instruction::GetElementPtr);
3358 } else if (!(*I)->isVectorTy()) {
3360 writeOperandWithCast(I.getOperand(), Instruction::GetElementPtr);
3363 // If the last index is into a vector, then print it out as "+j)". This
3364 // works with the 'LastIndexIsVector' code above.
3365 if (isa<Constant>(I.getOperand()) &&
3366 cast<Constant>(I.getOperand())->isNullValue()) {
3367 Out << "))"; // avoid "+0".
3370 writeOperandWithCast(I.getOperand(), Instruction::GetElementPtr);
3378 void CWriter::writeMemoryAccess(Value *Operand, const Type *OperandType,
3379 bool IsVolatile, unsigned Alignment) {
3381 bool IsUnaligned = Alignment &&
3382 Alignment < TD->getABITypeAlignment(OperandType);
3386 if (IsVolatile || IsUnaligned) {
3389 Out << "struct __attribute__ ((packed, aligned(" << Alignment << "))) {";
3390 printType(Out, OperandType, false, IsUnaligned ? "data" : "volatile*");
3393 if (IsVolatile) Out << "volatile ";
3399 writeOperand(Operand);
3401 if (IsVolatile || IsUnaligned) {
3408 void CWriter::visitLoadInst(LoadInst &I) {
3409 writeMemoryAccess(I.getOperand(0), I.getType(), I.isVolatile(),
3414 void CWriter::visitStoreInst(StoreInst &I) {
3415 writeMemoryAccess(I.getPointerOperand(), I.getOperand(0)->getType(),
3416 I.isVolatile(), I.getAlignment());
3418 Value *Operand = I.getOperand(0);
3419 Constant *BitMask = 0;
3420 if (const IntegerType* ITy = dyn_cast<IntegerType>(Operand->getType()))
3421 if (!ITy->isPowerOf2ByteWidth())
3422 // We have a bit width that doesn't match an even power-of-2 byte
3423 // size. Consequently we must & the value with the type's bit mask
3424 BitMask = ConstantInt::get(ITy, ITy->getBitMask());
3427 writeOperand(Operand);
3430 printConstant(BitMask, false);
3435 void CWriter::visitGetElementPtrInst(GetElementPtrInst &I) {
3436 printGEPExpression(I.getPointerOperand(), gep_type_begin(I),
3437 gep_type_end(I), false);
3440 void CWriter::visitVAArgInst(VAArgInst &I) {
3441 Out << "va_arg(*(va_list*)";
3442 writeOperand(I.getOperand(0));
3444 printType(Out, I.getType());
3448 void CWriter::visitInsertElementInst(InsertElementInst &I) {
3449 const Type *EltTy = I.getType()->getElementType();
3450 writeOperand(I.getOperand(0));
3453 printType(Out, PointerType::getUnqual(EltTy));
3454 Out << ")(&" << GetValueName(&I) << "))[";
3455 writeOperand(I.getOperand(2));
3457 writeOperand(I.getOperand(1));
3461 void CWriter::visitExtractElementInst(ExtractElementInst &I) {
3462 // We know that our operand is not inlined.
3465 cast<VectorType>(I.getOperand(0)->getType())->getElementType();
3466 printType(Out, PointerType::getUnqual(EltTy));
3467 Out << ")(&" << GetValueName(I.getOperand(0)) << "))[";
3468 writeOperand(I.getOperand(1));
3472 void CWriter::visitShuffleVectorInst(ShuffleVectorInst &SVI) {
3474 printType(Out, SVI.getType());
3476 const VectorType *VT = SVI.getType();
3477 unsigned NumElts = VT->getNumElements();
3478 const Type *EltTy = VT->getElementType();
3480 for (unsigned i = 0; i != NumElts; ++i) {
3482 int SrcVal = SVI.getMaskValue(i);
3483 if ((unsigned)SrcVal >= NumElts*2) {
3484 Out << " 0/*undef*/ ";
3486 Value *Op = SVI.getOperand((unsigned)SrcVal >= NumElts);
3487 if (isa<Instruction>(Op)) {
3488 // Do an extractelement of this value from the appropriate input.
3490 printType(Out, PointerType::getUnqual(EltTy));
3491 Out << ")(&" << GetValueName(Op)
3492 << "))[" << (SrcVal & (NumElts-1)) << "]";
3493 } else if (isa<ConstantAggregateZero>(Op) || isa<UndefValue>(Op)) {
3496 printConstant(cast<ConstantVector>(Op)->getOperand(SrcVal &
3505 void CWriter::visitInsertValueInst(InsertValueInst &IVI) {
3506 // Start by copying the entire aggregate value into the result variable.
3507 writeOperand(IVI.getOperand(0));
3510 // Then do the insert to update the field.
3511 Out << GetValueName(&IVI);
3512 for (const unsigned *b = IVI.idx_begin(), *i = b, *e = IVI.idx_end();
3514 const Type *IndexedTy =
3515 ExtractValueInst::getIndexedType(IVI.getOperand(0)->getType(), b, i+1);
3516 if (IndexedTy->isArrayTy())
3517 Out << ".array[" << *i << "]";
3519 Out << ".field" << *i;
3522 writeOperand(IVI.getOperand(1));
3525 void CWriter::visitExtractValueInst(ExtractValueInst &EVI) {
3527 if (isa<UndefValue>(EVI.getOperand(0))) {
3529 printType(Out, EVI.getType());
3530 Out << ") 0/*UNDEF*/";
3532 Out << GetValueName(EVI.getOperand(0));
3533 for (const unsigned *b = EVI.idx_begin(), *i = b, *e = EVI.idx_end();
3535 const Type *IndexedTy =
3536 ExtractValueInst::getIndexedType(EVI.getOperand(0)->getType(), b, i+1);
3537 if (IndexedTy->isArrayTy())
3538 Out << ".array[" << *i << "]";
3540 Out << ".field" << *i;
3546 //===----------------------------------------------------------------------===//
3547 // External Interface declaration
3548 //===----------------------------------------------------------------------===//
3550 bool CTargetMachine::addPassesToEmitWholeFile(PassManager &PM,
3551 formatted_raw_ostream &o,
3552 CodeGenFileType FileType,
3553 CodeGenOpt::Level OptLevel,
3554 bool DisableVerify) {
3555 if (FileType != TargetMachine::CGFT_AssemblyFile) return true;
3557 PM.add(createGCLoweringPass());
3558 PM.add(createLowerInvokePass());
3559 PM.add(createCFGSimplificationPass()); // clean up after lower invoke.
3560 PM.add(new CBackendNameAllUsedStructsAndMergeFunctions());
3561 PM.add(new CWriter(o));
3562 PM.add(createGCInfoDeleter());