blob: 3b80146a2780c14b28215ca642bd3d8a04952ab6 [file] [log] [blame]
Chris Lattnercf3056d2003-10-13 03:32:08 +00001//===-- TransformInternals.h - Shared functions for Transforms --*- C++ -*-===//
John Criswell856ba762003-10-21 15:17:13 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file was developed by the LLVM research group and is distributed under
6// the University of Illinois Open Source License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
Chris Lattner59cd9f12001-11-04 23:24:06 +00009//
10// This header file declares shared functions used by the different components
11// of the Transforms library.
12//
13//===----------------------------------------------------------------------===//
14
15#ifndef TRANSFORM_INTERNALS_H
16#define TRANSFORM_INTERNALS_H
17
18#include "llvm/BasicBlock.h"
19#include "llvm/Target/TargetData.h"
Chris Lattnerc0b90e72001-11-08 20:19:56 +000020#include "llvm/DerivedTypes.h"
Chris Lattner31bcdb82002-04-28 19:55:58 +000021#include "llvm/Constants.h"
Chris Lattner59cd9f12001-11-04 23:24:06 +000022#include <map>
Chris Lattnere4f4d8c2001-11-05 18:30:53 +000023#include <set>
Chris Lattner59cd9f12001-11-04 23:24:06 +000024
Brian Gaeked0fde302003-11-11 22:41:34 +000025namespace llvm {
26
Chris Lattner8e2e5f72002-09-16 18:32:33 +000027static inline int64_t getConstantValue(const ConstantInt *CPI) {
Chris Lattnerc07736a2003-07-23 15:22:26 +000028 return (int64_t)cast<ConstantInt>(CPI)->getRawValue();
Chris Lattner491b29f2001-11-26 17:00:13 +000029}
Chris Lattner59cd9f12001-11-04 23:24:06 +000030
31
Chris Lattner491b29f2001-11-26 17:00:13 +000032// getPointedToComposite - If the argument is a pointer type, and the pointed to
33// value is a composite type, return the composite type, else return null.
Chris Lattnerc0b90e72001-11-08 20:19:56 +000034//
Chris Lattner491b29f2001-11-26 17:00:13 +000035static inline const CompositeType *getPointedToComposite(const Type *Ty) {
Chris Lattnerc0b90e72001-11-08 20:19:56 +000036 const PointerType *PT = dyn_cast<PointerType>(Ty);
Chris Lattner7a176752001-12-04 00:03:30 +000037 return PT ? dyn_cast<CompositeType>(PT->getElementType()) : 0;
Chris Lattnerc0b90e72001-11-08 20:19:56 +000038}
39
Misha Brukmanf117cc92003-05-20 18:45:36 +000040// ConvertibleToGEP - This function returns true if the specified value V is
Chris Lattner491b29f2001-11-26 17:00:13 +000041// a valid index into a pointer of type Ty. If it is valid, Idx is filled in
42// with the values that would be appropriate to make this a getelementptr
43// instruction. The type returned is the root type that the GEP would point
44// to if it were synthesized with this operands.
45//
46// If BI is nonnull, cast instructions are inserted as appropriate for the
47// arguments of the getelementptr.
48//
Misha Brukmanf117cc92003-05-20 18:45:36 +000049const Type *ConvertibleToGEP(const Type *Ty, Value *V,
Chris Lattner697954c2002-01-20 22:54:45 +000050 std::vector<Value*> &Indices,
Chris Lattner16125fb2003-04-24 18:25:27 +000051 const TargetData &TD,
Chris Lattner491b29f2001-11-26 17:00:13 +000052 BasicBlock::iterator *BI = 0);
53
54
Chris Lattnerb1b42622002-07-17 17:11:33 +000055//===----------------------------------------------------------------------===//
56// ValueHandle Class - Smart pointer that occupies a slot on the users USE list
57// that prevents it from being destroyed. This "looks" like an Instruction
58// with Opcode UserOp1.
59//
60class ValueMapCache;
61class ValueHandle : public Instruction {
62 ValueMapCache &Cache;
63public:
64 ValueHandle(ValueMapCache &VMC, Value *V);
65 ValueHandle(const ValueHandle &);
66 ~ValueHandle();
67
68 virtual Instruction *clone() const { abort(); return 0; }
69
70 virtual const char *getOpcodeName() const {
71 return "ValueHandle";
72 }
73
74 inline bool operator<(const ValueHandle &VH) const {
75 return getOperand(0) < VH.getOperand(0);
76 }
77
78 // Methods for support type inquiry through isa, cast, and dyn_cast:
79 static inline bool classof(const ValueHandle *) { return true; }
80 static inline bool classof(const Instruction *I) {
81 return (I->getOpcode() == Instruction::UserOp1);
82 }
83 static inline bool classof(const Value *V) {
84 return isa<Instruction>(V) && classof(cast<Instruction>(V));
85 }
86};
87
88
Chris Lattner59cd9f12001-11-04 23:24:06 +000089// ------------- Expression Conversion ---------------------
90
Chris Lattnerb1b42622002-07-17 17:11:33 +000091typedef std::map<const Value*, const Type*> ValueTypeCache;
Chris Lattnere4f4d8c2001-11-05 18:30:53 +000092
93struct ValueMapCache {
94 // Operands mapped - Contains an entry if the first value (the user) has had
95 // the second value (the operand) mapped already.
96 //
Chris Lattner697954c2002-01-20 22:54:45 +000097 std::set<const User*> OperandsMapped;
Chris Lattnere4f4d8c2001-11-05 18:30:53 +000098
99 // Expression Map - Contains an entry from the old value to the new value of
100 // an expression that has been converted over.
101 //
Chris Lattner697954c2002-01-20 22:54:45 +0000102 std::map<const Value *, Value *> ExprMap;
103 typedef std::map<const Value *, Value *> ExprMapTy;
Chris Lattnerb1b42622002-07-17 17:11:33 +0000104
105 // Cast Map - Cast instructions can have their source and destination values
Misha Brukmanef6a6a62003-08-21 22:14:26 +0000106 // changed independently for each part. Because of this, our old naive
Chris Lattnerb1b42622002-07-17 17:11:33 +0000107 // implementation would create a TWO new cast instructions, which would cause
108 // all kinds of problems. Here we keep track of the newly allocated casts, so
109 // that we only create one for a particular instruction.
110 //
111 std::set<ValueHandle> NewCasts;
Chris Lattnere4f4d8c2001-11-05 18:30:53 +0000112};
Chris Lattner59cd9f12001-11-04 23:24:06 +0000113
Chris Lattnerc0b90e72001-11-08 20:19:56 +0000114
Misha Brukmanf117cc92003-05-20 18:45:36 +0000115bool ExpressionConvertibleToType(Value *V, const Type *Ty, ValueTypeCache &Map,
Chris Lattner16125fb2003-04-24 18:25:27 +0000116 const TargetData &TD);
117Value *ConvertExpressionToType(Value *V, const Type *Ty, ValueMapCache &VMC,
118 const TargetData &TD);
Chris Lattnerc0b90e72001-11-08 20:19:56 +0000119
Misha Brukmanf117cc92003-05-20 18:45:36 +0000120// ValueConvertibleToType - Return true if it is possible
121bool ValueConvertibleToType(Value *V, const Type *Ty,
Chris Lattner16125fb2003-04-24 18:25:27 +0000122 ValueTypeCache &ConvertedTypes,
123 const TargetData &TD);
Chris Lattner59cd9f12001-11-04 23:24:06 +0000124
Chris Lattner16125fb2003-04-24 18:25:27 +0000125void ConvertValueToNewType(Value *V, Value *NewVal, ValueMapCache &VMC,
126 const TargetData &TD);
Chris Lattner59cd9f12001-11-04 23:24:06 +0000127
128
Chris Lattnerc0b90e72001-11-08 20:19:56 +0000129// getStructOffsetType - Return a vector of offsets that are to be used to index
130// into the specified struct type to get as close as possible to index as we
131// can. Note that it is possible that we cannot get exactly to Offset, in which
132// case we update offset to be the offset we actually obtained. The resultant
133// leaf type is returned.
134//
135// If StopEarly is set to true (the default), the first object with the
136// specified type is returned, even if it is a struct type itself. In this
137// case, this routine will not drill down to the leaf type. Set StopEarly to
138// false if you want a leaf
139//
140const Type *getStructOffsetType(const Type *Ty, unsigned &Offset,
Chris Lattner697954c2002-01-20 22:54:45 +0000141 std::vector<Value*> &Offsets,
Chris Lattner16125fb2003-04-24 18:25:27 +0000142 const TargetData &TD, bool StopEarly = true);
Chris Lattnerc0b90e72001-11-08 20:19:56 +0000143
Brian Gaeked0fde302003-11-11 22:41:34 +0000144} // End llvm namespace
145
Chris Lattner59cd9f12001-11-04 23:24:06 +0000146#endif