1 //===-- llvm/InstrTypes.h - Important Instruction subclasses ----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines various meta classes of instructions that exist in the VM
11 // representation. Specific concrete subclasses of these may be found in the
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_INSTRUCTION_TYPES_H
17 #define LLVM_INSTRUCTION_TYPES_H
19 #include "llvm/Instruction.h"
23 //===----------------------------------------------------------------------===//
24 // TerminatorInst Class
25 //===----------------------------------------------------------------------===//
27 /// TerminatorInst - Subclasses of this class are all able to terminate a basic
28 /// block. Thus, these are all the flow control type of operations.
30 class TerminatorInst : public Instruction {
32 TerminatorInst(Instruction::TermOps iType, Use *Ops, unsigned NumOps,
33 Instruction *InsertBefore = 0);
34 TerminatorInst(const Type *Ty, Instruction::TermOps iType,
35 Use *Ops, unsigned NumOps,
36 const std::string &Name = "", Instruction *InsertBefore = 0)
37 : Instruction(Ty, iType, Ops, NumOps, Name, InsertBefore) {}
39 TerminatorInst(Instruction::TermOps iType, Use *Ops, unsigned NumOps,
40 BasicBlock *InsertAtEnd);
41 TerminatorInst(const Type *Ty, Instruction::TermOps iType,
42 Use *Ops, unsigned NumOps,
43 const std::string &Name, BasicBlock *InsertAtEnd)
44 : Instruction(Ty, iType, Ops, NumOps, Name, InsertAtEnd) {}
46 // Out of line virtual method, so the vtable, etc has a home.
49 /// Virtual methods - Terminators should overload these and provide inline
50 /// overrides of non-V methods.
51 virtual BasicBlock *getSuccessorV(unsigned idx) const = 0;
52 virtual unsigned getNumSuccessorsV() const = 0;
53 virtual void setSuccessorV(unsigned idx, BasicBlock *B) = 0;
56 virtual Instruction *clone() const = 0;
58 /// getNumSuccessors - Return the number of successors that this terminator
60 unsigned getNumSuccessors() const {
61 return getNumSuccessorsV();
64 /// getSuccessor - Return the specified successor.
66 BasicBlock *getSuccessor(unsigned idx) const {
67 return getSuccessorV(idx);
70 /// setSuccessor - Update the specified successor to point at the provided
72 void setSuccessor(unsigned idx, BasicBlock *B) {
73 setSuccessorV(idx, B);
76 // Methods for support type inquiry through isa, cast, and dyn_cast:
77 static inline bool classof(const TerminatorInst *) { return true; }
78 static inline bool classof(const Instruction *I) {
79 return I->getOpcode() >= TermOpsBegin && I->getOpcode() < TermOpsEnd;
81 static inline bool classof(const Value *V) {
82 return isa<Instruction>(V) && classof(cast<Instruction>(V));
86 //===----------------------------------------------------------------------===//
87 // UnaryInstruction Class
88 //===----------------------------------------------------------------------===//
90 class UnaryInstruction : public Instruction {
93 UnaryInstruction(const Type *Ty, unsigned iType, Value *V,
94 const std::string &Name = "", Instruction *IB = 0)
95 : Instruction(Ty, iType, &Op, 1, Name, IB), Op(V, this) {
97 UnaryInstruction(const Type *Ty, unsigned iType, Value *V,
98 const std::string &Name, BasicBlock *IAE)
99 : Instruction(Ty, iType, &Op, 1, Name, IAE), Op(V, this) {
102 // Out of line virtual method, so the vtable, etc has a home.
105 // Transparently provide more efficient getOperand methods.
106 Value *getOperand(unsigned i) const {
107 assert(i == 0 && "getOperand() out of range!");
110 void setOperand(unsigned i, Value *Val) {
111 assert(i == 0 && "setOperand() out of range!");
114 unsigned getNumOperands() const { return 1; }
117 //===----------------------------------------------------------------------===//
118 // BinaryOperator Class
119 //===----------------------------------------------------------------------===//
121 class BinaryOperator : public Instruction {
124 void init(BinaryOps iType);
125 BinaryOperator(BinaryOps iType, Value *S1, Value *S2, const Type *Ty,
126 const std::string &Name, Instruction *InsertBefore)
127 : Instruction(Ty, iType, Ops, 2, Name, InsertBefore) {
128 Ops[0].init(S1, this);
129 Ops[1].init(S2, this);
132 BinaryOperator(BinaryOps iType, Value *S1, Value *S2, const Type *Ty,
133 const std::string &Name, BasicBlock *InsertAtEnd)
134 : Instruction(Ty, iType, Ops, 2, Name, InsertAtEnd) {
135 Ops[0].init(S1, this);
136 Ops[1].init(S2, this);
142 /// Transparently provide more efficient getOperand methods.
143 Value *getOperand(unsigned i) const {
144 assert(i < 2 && "getOperand() out of range!");
147 void setOperand(unsigned i, Value *Val) {
148 assert(i < 2 && "setOperand() out of range!");
151 unsigned getNumOperands() const { return 2; }
153 /// create() - Construct a binary instruction, given the opcode and the two
154 /// operands. Optionally (if InstBefore is specified) insert the instruction
155 /// into a BasicBlock right before the specified instruction. The specified
156 /// Instruction is allowed to be a dereferenced end iterator.
158 static BinaryOperator *create(BinaryOps Op, Value *S1, Value *S2,
159 const std::string &Name = "",
160 Instruction *InsertBefore = 0);
162 /// create() - Construct a binary instruction, given the opcode and the two
163 /// operands. Also automatically insert this instruction to the end of the
164 /// BasicBlock specified.
166 static BinaryOperator *create(BinaryOps Op, Value *S1, Value *S2,
167 const std::string &Name,
168 BasicBlock *InsertAtEnd);
170 /// create* - These methods just forward to create, and are useful when you
171 /// statically know what type of instruction you're going to create. These
172 /// helpers just save some typing.
173 #define HANDLE_BINARY_INST(N, OPC, CLASS) \
174 static BinaryOperator *create##OPC(Value *V1, Value *V2, \
175 const std::string &Name = "") {\
176 return create(Instruction::OPC, V1, V2, Name);\
178 #include "llvm/Instruction.def"
179 #define HANDLE_BINARY_INST(N, OPC, CLASS) \
180 static BinaryOperator *create##OPC(Value *V1, Value *V2, \
181 const std::string &Name, BasicBlock *BB) {\
182 return create(Instruction::OPC, V1, V2, Name, BB);\
184 #include "llvm/Instruction.def"
185 #define HANDLE_BINARY_INST(N, OPC, CLASS) \
186 static BinaryOperator *create##OPC(Value *V1, Value *V2, \
187 const std::string &Name, Instruction *I) {\
188 return create(Instruction::OPC, V1, V2, Name, I);\
190 #include "llvm/Instruction.def"
193 /// Helper functions to construct and inspect unary operations (NEG and NOT)
194 /// via binary operators SUB and XOR:
196 /// createNeg, createNot - Create the NEG and NOT
197 /// instructions out of SUB and XOR instructions.
199 static BinaryOperator *createNeg(Value *Op, const std::string &Name = "",
200 Instruction *InsertBefore = 0);
201 static BinaryOperator *createNeg(Value *Op, const std::string &Name,
202 BasicBlock *InsertAtEnd);
203 static BinaryOperator *createNot(Value *Op, const std::string &Name = "",
204 Instruction *InsertBefore = 0);
205 static BinaryOperator *createNot(Value *Op, const std::string &Name,
206 BasicBlock *InsertAtEnd);
208 /// isNeg, isNot - Check if the given Value is a NEG or NOT instruction.
210 static bool isNeg(const Value *V);
211 static bool isNot(const Value *V);
213 /// getNegArgument, getNotArgument - Helper functions to extract the
214 /// unary argument of a NEG or NOT operation implemented via Sub or Xor.
216 static const Value *getNegArgument(const Value *BinOp);
217 static Value *getNegArgument( Value *BinOp);
218 static const Value *getNotArgument(const Value *BinOp);
219 static Value *getNotArgument( Value *BinOp);
221 BinaryOps getOpcode() const {
222 return static_cast<BinaryOps>(Instruction::getOpcode());
225 virtual BinaryOperator *clone() const;
227 /// swapOperands - Exchange the two operands to this instruction.
228 /// This instruction is safe to use on any binary instruction and
229 /// does not modify the semantics of the instruction. If the
230 /// instruction is order dependent (SetLT f.e.) the opcode is
231 /// changed. If the instruction cannot be reversed (ie, it's a Div),
232 /// then return true.
236 // Methods for support type inquiry through isa, cast, and dyn_cast:
237 static inline bool classof(const BinaryOperator *) { return true; }
238 static inline bool classof(const Instruction *I) {
239 return I->getOpcode() >= BinaryOpsBegin && I->getOpcode() < BinaryOpsEnd;
241 static inline bool classof(const Value *V) {
242 return isa<Instruction>(V) && classof(cast<Instruction>(V));
246 //===----------------------------------------------------------------------===//
248 //===----------------------------------------------------------------------===//
250 /// CastInst - This is the base class for all instructions that perform data
251 /// casts. It is simply provided so that instruction category testing
252 /// can be performed with code like:
254 /// if (isa<CastInst>(Instr)) { ... }
255 /// @brief Base class of casting instructions.
256 class CastInst : public UnaryInstruction {
257 /// @brief Copy constructor
258 CastInst(const CastInst &CI)
259 : UnaryInstruction(CI.getType(), CI.getOpcode(), CI.getOperand(0)) {
261 /// @brief Do not allow default construction
264 /// @brief Constructor with insert-before-instruction semantics for subclasses
265 CastInst(const Type *Ty, unsigned iType, Value *S,
266 const std::string &Name = "", Instruction *InsertBefore = 0)
267 : UnaryInstruction(Ty, iType, S, Name, InsertBefore) {
269 /// @brief Constructor with insert-at-end-of-block semantics for subclasses
270 CastInst(const Type *Ty, unsigned iType, Value *S,
271 const std::string &Name, BasicBlock *InsertAtEnd)
272 : UnaryInstruction(Ty, iType, S, Name, InsertAtEnd) {
275 /// Provides a way to construct any of the CastInst subclasses using an
276 /// opcode instead of the subclass's constructor. The opcode must be in the
277 /// CastOps category (Instruction::isCast(opcode) returns true). This
278 /// constructor has insert-before-instruction semantics to automatically
279 /// insert the new CastInst before InsertBefore (if it is non-null).
280 /// @brief Construct any of the CastInst subclasses
281 static CastInst *create(
282 Instruction::CastOps, ///< The opcode of the cast instruction
283 Value *S, ///< The value to be casted (operand 0)
284 const Type *Ty, ///< The type to which cast should be made
285 const std::string &Name = "", ///< Name for the instruction
286 Instruction *InsertBefore = 0 ///< Place to insert the instruction
288 /// Provides a way to construct any of the CastInst subclasses using an
289 /// opcode instead of the subclass's constructor. The opcode must be in the
290 /// CastOps category. This constructor has insert-at-end-of-block semantics
291 /// to automatically insert the new CastInst at the end of InsertAtEnd (if
293 /// @brief Construct any of the CastInst subclasses
294 static CastInst *create(
295 Instruction::CastOps, ///< The opcode for the cast instruction
296 Value *S, ///< The value to be casted (operand 0)
297 const Type *Ty, ///< The type to which operand is casted
298 const std::string &Name, ///< The name for the instruction
299 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
302 /// @brief Create a ZExt or BitCast cast instruction
303 static CastInst *createZExtOrBitCast(
304 Value *S, ///< The value to be casted (operand 0)
305 const Type *Ty, ///< The type to which cast should be made
306 const std::string &Name = "", ///< Name for the instruction
307 Instruction *InsertBefore = 0 ///< Place to insert the instruction
310 /// @brief Create a ZExt or BitCast cast instruction
311 static CastInst *createZExtOrBitCast(
312 Value *S, ///< The value to be casted (operand 0)
313 const Type *Ty, ///< The type to which operand is casted
314 const std::string &Name, ///< The name for the instruction
315 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
318 /// @brief Create a SExt or BitCast cast instruction
319 static CastInst *createSExtOrBitCast(
320 Value *S, ///< The value to be casted (operand 0)
321 const Type *Ty, ///< The type to which cast should be made
322 const std::string &Name = "", ///< Name for the instruction
323 Instruction *InsertBefore = 0 ///< Place to insert the instruction
326 /// @brief Create a BitCast or a PtrToInt cast instruction
327 static CastInst *createPointerCast(
328 Value *S, ///< The pointer value to be casted (operand 0)
329 const Type *Ty, ///< The type to which operand is casted
330 const std::string &Name, ///< The name for the instruction
331 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
334 /// @brief Create a BitCast or a PtrToInt cast instruction
335 static CastInst *createPointerCast(
336 Value *S, ///< The pointer value to be casted (operand 0)
337 const Type *Ty, ///< The type to which cast should be made
338 const std::string &Name = "", ///< Name for the instruction
339 Instruction *InsertBefore = 0 ///< Place to insert the instruction
342 /// @brief Create a ZExt, BitCast, or Trunc for int -> int casts.
343 static CastInst *createIntegerCast(
344 Value *S, ///< The pointer value to be casted (operand 0)
345 const Type *Ty, ///< The type to which cast should be made
346 bool isSigned, ///< Whether to regard S as signed or not
347 const std::string &Name = "", ///< Name for the instruction
348 Instruction *InsertBefore = 0 ///< Place to insert the instruction
351 /// @brief Create a ZExt, BitCast, or Trunc for int -> int casts.
352 static CastInst *createIntegerCast(
353 Value *S, ///< The integer value to be casted (operand 0)
354 const Type *Ty, ///< The integer type to which operand is casted
355 bool isSigned, ///< Whether to regard S as signed or not
356 const std::string &Name, ///< The name for the instruction
357 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
360 /// @brief Create an FPExt, BitCast, or FPTrunc for fp -> fp casts
361 static CastInst *createFPCast(
362 Value *S, ///< The floating point value to be casted
363 const Type *Ty, ///< The floating point type to cast to
364 const std::string &Name = "", ///< Name for the instruction
365 Instruction *InsertBefore = 0 ///< Place to insert the instruction
368 /// @brief Create an FPExt, BitCast, or FPTrunc for fp -> fp casts
369 static CastInst *createFPCast(
370 Value *S, ///< The floating point value to be casted
371 const Type *Ty, ///< The floating point type to cast to
372 const std::string &Name, ///< The name for the instruction
373 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
376 /// @brief Create a SExt or BitCast cast instruction
377 static CastInst *createSExtOrBitCast(
378 Value *S, ///< The value to be casted (operand 0)
379 const Type *Ty, ///< The type to which operand is casted
380 const std::string &Name, ///< The name for the instruction
381 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
384 /// @brief Create a Trunc or BitCast cast instruction
385 static CastInst *createTruncOrBitCast(
386 Value *S, ///< The value to be casted (operand 0)
387 const Type *Ty, ///< The type to which cast should be made
388 const std::string &Name = "", ///< Name for the instruction
389 Instruction *InsertBefore = 0 ///< Place to insert the instruction
392 /// @brief Create a Trunc or BitCast cast instruction
393 static CastInst *createTruncOrBitCast(
394 Value *S, ///< The value to be casted (operand 0)
395 const Type *Ty, ///< The type to which operand is casted
396 const std::string &Name, ///< The name for the instruction
397 BasicBlock *InsertAtEnd ///< The block to insert the instruction into
400 /// Returns the opcode necessary to cast Val into Ty using usual casting
402 /// @brief Infer the opcode for cast operand and type
403 static Instruction::CastOps getCastOpcode(
404 const Value *Val, ///< The value to cast
405 bool SrcIsSigned, ///< Whether to treat the source as signed
406 const Type *Ty, ///< The Type to which the value should be casted
407 bool DstIsSigned ///< Whether to treate the dest. as signed
410 /// There are several places where we need to know if a cast instruction
411 /// only deals with integer source and destination types. To simplify that
412 /// logic, this method is provided.
413 /// @returns true iff the cast has only integral typed operand and dest type.
414 /// @brief Determine if this is an integer-only cast.
415 bool isIntegerCast() const;
417 /// A lossless cast is one that does not alter the basic value. It implies
418 /// a no-op cast but is more stringent, preventing things like int->float,
419 /// long->double, int->ptr, or packed->anything.
420 /// @returns true iff the cast is lossless.
421 /// @brief Determine if this is a lossless cast.
422 bool isLosslessCast() const;
424 /// A no-op cast is one that can be effected without changing any bits.
425 /// It implies that the source and destination types are the same size. The
426 /// IntPtrTy argument is used to make accurate determinations for casts
427 /// involving Integer and Pointer types. They are no-op casts if the integer
428 /// is the same size as the pointer. However, pointer size varies with
429 /// platform. Generally, the result of TargetData::getIntPtrType() should be
430 /// passed in. If that's not available, use Type::Int64Ty, which will make
431 /// the isNoopCast call conservative.
432 /// @brief Determine if this cast is a no-op cast.
434 const Type *IntPtrTy ///< Integer type corresponding to pointer
437 /// Determine how a pair of casts can be eliminated, if they can be at all.
438 /// This is a helper function for both CastInst and ConstantExpr.
439 /// @returns 0 if the CastInst pair can't be eliminated
440 /// @returns Instruction::CastOps value for a cast that can replace
441 /// the pair, casting SrcTy to DstTy.
442 /// @brief Determine if a cast pair is eliminable
443 static unsigned isEliminableCastPair(
444 Instruction::CastOps firstOpcode, ///< Opcode of first cast
445 Instruction::CastOps secondOpcode, ///< Opcode of second cast
446 const Type *SrcTy, ///< SrcTy of 1st cast
447 const Type *MidTy, ///< DstTy of 1st cast & SrcTy of 2nd cast
448 const Type *DstTy, ///< DstTy of 2nd cast
449 const Type *IntPtrTy ///< Integer type corresponding to Ptr types
452 /// @brief Return the opcode of this CastInst
453 Instruction::CastOps getOpcode() const {
454 return Instruction::CastOps(Instruction::getOpcode());
457 /// @brief Return the source type, as a convenience
458 const Type* getSrcTy() const { return getOperand(0)->getType(); }
459 /// @brief Return the destination type, as a convenience
460 const Type* getDestTy() const { return getType(); }
462 /// This method can be used to determine if a cast from S to DstTy using
463 /// Opcode op is valid or not.
464 /// @returns true iff the proposed cast is valid.
465 /// @brief Determine if a cast is valid without creating one.
466 static bool castIsValid(Instruction::CastOps op, Value *S, const Type *DstTy);
468 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
469 static inline bool classof(const CastInst *) { return true; }
470 static inline bool classof(const Instruction *I) {
471 return I->getOpcode() >= CastOpsBegin && I->getOpcode() < CastOpsEnd;
473 static inline bool classof(const Value *V) {
474 return isa<Instruction>(V) && classof(cast<Instruction>(V));
478 //===----------------------------------------------------------------------===//
480 //===----------------------------------------------------------------------===//
482 /// This class is the base class for the comparison instructions.
483 /// @brief Abstract base class of comparison instructions.
484 class CmpInst: public Instruction {
485 CmpInst(); // do not implement
487 CmpInst(Instruction::OtherOps op, unsigned short pred, Value *LHS, Value *RHS,
488 const std::string &Name = "", Instruction *InsertBefore = 0);
490 CmpInst(Instruction::OtherOps op, unsigned short pred, Value *LHS, Value *RHS,
491 const std::string &Name, BasicBlock *InsertAtEnd);
493 Use Ops[2]; // CmpInst instructions always have 2 operands, optimize
496 /// Construct a compare instruction, given the opcode, the predicate and
497 /// the two operands. Optionally (if InstBefore is specified) insert the
498 /// instruction into a BasicBlock right before the specified instruction.
499 /// The specified Instruction is allowed to be a dereferenced end iterator.
500 /// @brief Create a CmpInst
501 static CmpInst *create(OtherOps Op, unsigned short predicate, Value *S1,
502 Value *S2, const std::string &Name = "",
503 Instruction *InsertBefore = 0);
505 /// Construct a compare instruction, given the opcode, the predicate and the
506 /// two operands. Also automatically insert this instruction to the end of
507 /// the BasicBlock specified.
508 /// @brief Create a CmpInst
509 static CmpInst *create(OtherOps Op, unsigned short predicate, Value *S1,
510 Value *S2, const std::string &Name,
511 BasicBlock *InsertAtEnd);
513 /// @brief Implement superclass method.
514 virtual CmpInst *clone() const;
516 /// @brief Get the opcode casted to the right type
517 OtherOps getOpcode() const {
518 return static_cast<OtherOps>(Instruction::getOpcode());
521 /// The predicate for CmpInst is defined by the subclasses but stored in
522 /// the SubclassData field (see Value.h). We allow it to be fetched here
523 /// as the predicate but there is no enum type for it, just the raw unsigned
524 /// short. This facilitates comparison of CmpInst instances without delving
525 /// into the subclasses since predicate values are distinct between the
526 /// CmpInst subclasses.
527 /// @brief Return the predicate for this instruction.
528 unsigned short getPredicate() const {
532 /// @brief Provide more efficient getOperand methods.
533 Value *getOperand(unsigned i) const {
534 assert(i < 2 && "getOperand() out of range!");
537 void setOperand(unsigned i, Value *Val) {
538 assert(i < 2 && "setOperand() out of range!");
542 /// @brief CmpInst instructions always have 2 operands.
543 unsigned getNumOperands() const { return 2; }
545 /// This is just a convenience that dispatches to the subclasses.
546 /// @brief Swap the operands and adjust predicate accordingly to retain
547 /// the same comparison.
550 /// This is just a convenience that dispatches to the subclasses.
551 /// @brief Determine if this CmpInst is commutative.
552 bool isCommutative();
554 /// This is just a convenience that dispatches to the subclasses.
555 /// @brief Determine if this is an equals/not equals predicate.
558 /// @returns true if the predicate is unsigned, false otherwise.
559 /// @brief Determine if the predicate is an unsigned operation.
560 static bool isUnsigned(unsigned short predicate);
562 /// @returns true if the predicate is signed, false otherwise.
563 /// @brief Determine if the predicate is an signed operation.
564 static bool isSigned(unsigned short predicate);
566 /// @brief Determine if the predicate is an ordered operation.
567 static bool isOrdered(unsigned short predicate);
569 /// @brief Determine if the predicate is an unordered operation.
570 static bool isUnordered(unsigned short predicate);
572 /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
573 static inline bool classof(const CmpInst *) { return true; }
574 static inline bool classof(const Instruction *I) {
575 return I->getOpcode() == Instruction::ICmp ||
576 I->getOpcode() == Instruction::FCmp;
578 static inline bool classof(const Value *V) {
579 return isa<Instruction>(V) && classof(cast<Instruction>(V));
583 } // End llvm namespace