New file, for use by the pool allocator project
[oota-llvm.git] / include / llvm / iOther.h
index 118241fdc281a846c72454b44d8500858b29adda..4e23afdc89879482e9ac5f707334180ff8460113 100644 (file)
@@ -1,7 +1,14 @@
-//===-- llvm/iOther.h - "Other" instruction node definitions -----*- C++ -*--=//
+//===-- llvm/iOther.h - "Other" instruction node definitions ----*- C++ -*-===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
 //
 // This file contains the declarations for instructions that fall into the 
-// grandios 'other' catagory...
+// grandiose 'other' catagory...
 //
 //===----------------------------------------------------------------------===//
 
 #define LLVM_IOTHER_H
 
 #include "llvm/InstrTypes.h"
-#include "llvm/Method.h"
-#include <vector>
 
 //===----------------------------------------------------------------------===//
-//                               PHINode Class
+//                                 CastInst Class
 //===----------------------------------------------------------------------===//
 
-// PHINode - The PHINode class is used to represent the magical mystical PHI
-// node, that can not exist in nature, but can be synthesized in a computer
-// scientist's overactive imagination.
-//
-class PHINode : public Instruction {
-  typedef pair<Use,BasicBlockUse> PairTy;
-  vector<PairTy> IncomingValues;
-
-  PHINode(const PHINode &PN);
+/// CastInst - This class represents a cast from Operand[0] to the type of
+/// the instruction (i->getType()).
+///
+class CastInst : public Instruction {
+  CastInst(const CastInst &CI) : Instruction(CI.getType(), Cast) {
+    Operands.reserve(1);
+    Operands.push_back(Use(CI.Operands[0], this));
+  }
 public:
-  PHINode(const Type *Ty, const string &Name = "");
-  inline ~PHINode() { dropAllReferences(); }
+  CastInst(Value *S, const Type *Ty, const std::string &Name = "",
+           Instruction *InsertBefore = 0)
+    : Instruction(Ty, Cast, Name, InsertBefore) {
+    Operands.reserve(1);
+    Operands.push_back(Use(S, this));
+  }
 
-  virtual Instruction *clone() const { return new PHINode(*this); }
+  virtual Instruction *clone() const { return new CastInst(*this); }
 
-  // Implement all of the functionality required by User...
-  //
-  virtual void dropAllReferences();
-  virtual const Value *getOperand(unsigned i) const {
-    if (i >= IncomingValues.size()*2) return 0;
-    if (i & 1) return IncomingValues[i/2].second;
-    else       return IncomingValues[i/2].first;
+  // Methods for support type inquiry through isa, cast, and dyn_cast:
+  static inline bool classof(const CastInst *) { return true; }
+  static inline bool classof(const Instruction *I) {
+    return I->getOpcode() == Cast;
   }
-  inline Value *getOperand(unsigned i) {
-    return (Value*)((const PHINode*)this)->getOperand(i);
+  static inline bool classof(const Value *V) {
+    return isa<Instruction>(V) && classof(cast<Instruction>(V));
   }
-  virtual unsigned getNumOperands() const { return IncomingValues.size()*2; }
-  virtual bool setOperand(unsigned i, Value *Val);
-  virtual string getOpcode() const { return "phi"; }
-
-  // addIncoming - Add an incoming value to the end of the PHI list
-  void addIncoming(Value *D, BasicBlock *BB);
-
-  // removeIncomingValue - Remove an incoming value.  This is useful if a
-  // predecessor basic block is deleted.  The value removed is returned.
-  Value *removeIncomingValue(const BasicBlock *BB);
 };
 
 
 //===----------------------------------------------------------------------===//
-//                           MethodArgument Class
+//                                 CallInst Class
 //===----------------------------------------------------------------------===//
 
-class MethodArgument : public Value {  // Defined in the InstrType.cpp file
-  Method *Parent;
+class CallInst : public Instruction {
+  CallInst(const CallInst &CI);
+public:
+  CallInst(Value *F, const std::vector<Value*> &Par,
+           const std::string &Name = "", Instruction *InsertBefore = 0);
+
+  // Alternate CallInst ctors w/ no actuals & one actual, respectively.
+  CallInst(Value *F, const std::string &Name = "",
+           Instruction  *InsertBefore = 0);
+  CallInst(Value *F, Value *Actual, const std::string& Name = "",
+           Instruction* InsertBefore = 0);
+
+  virtual Instruction *clone() const { return new CallInst(*this); }
+  bool mayWriteToMemory() const { return true; }
+
+  // FIXME: These methods should be inline once we eliminate
+  // ConstantPointerRefs!
+  const Function *getCalledFunction() const;
+  Function *getCalledFunction();
+
+  // getCalledValue - Get a pointer to a method that is invoked by this inst.
+  inline const Value *getCalledValue() const { return Operands[0]; }
+  inline       Value *getCalledValue()       { return Operands[0]; }
+
+  // Methods for support type inquiry through isa, cast, and dyn_cast:
+  static inline bool classof(const CallInst *) { return true; }
+  static inline bool classof(const Instruction *I) {
+    return I->getOpcode() == Instruction::Call; 
+  }
+  static inline bool classof(const Value *V) {
+    return isa<Instruction>(V) && classof(cast<Instruction>(V));
+  }
+};
+
 
-  friend class ValueHolder<MethodArgument,Method>;
-  inline void setParent(Method *parent) { Parent = parent; }
+//===----------------------------------------------------------------------===//
+//                                 ShiftInst Class
+//===----------------------------------------------------------------------===//
 
+// ShiftInst - This class represents left and right shift instructions.
+//
+class ShiftInst : public Instruction {
+  ShiftInst(const ShiftInst &SI) : Instruction(SI.getType(), SI.getOpcode()) {
+    Operands.reserve(2);
+    Operands.push_back(Use(SI.Operands[0], this));
+    Operands.push_back(Use(SI.Operands[1], this));
+  }
 public:
-  MethodArgument(const Type *Ty, const string &Name = "") 
-    : Value(Ty, Value::MethodArgumentVal, Name) {
-    Parent = 0;
+  ShiftInst(OtherOps Opcode, Value *S, Value *SA, const std::string &Name = "",
+            Instruction *InsertBefore = 0)
+    : Instruction(S->getType(), Opcode, Name, InsertBefore) {
+    assert((Opcode == Shl || Opcode == Shr) && "ShiftInst Opcode invalid!");
+    Operands.reserve(2);
+    Operands.push_back(Use(S, this));
+    Operands.push_back(Use(SA, this));
   }
 
-  // Specialize setName to handle symbol table majik...
-  virtual void setName(const string &name);
+  OtherOps getOpcode() const { return (OtherOps)Instruction::getOpcode(); }
+
+  virtual Instruction *clone() const { return new ShiftInst(*this); }
 
-  inline const Method *getParent() const { return Parent; }
-  inline       Method *getParent()       { return Parent; }
+  // Methods for support type inquiry through isa, cast, and dyn_cast:
+  static inline bool classof(const ShiftInst *) { return true; }
+  static inline bool classof(const Instruction *I) {
+    return (I->getOpcode() == Instruction::Shr) | 
+           (I->getOpcode() == Instruction::Shl);
+  }
+  static inline bool classof(const Value *V) {
+    return isa<Instruction>(V) && classof(cast<Instruction>(V));
+  }
 };
 
 
 //===----------------------------------------------------------------------===//
-//             Classes to function calls and method invocations
+//                                VANextInst Class
 //===----------------------------------------------------------------------===//
 
-class CallInst : public Instruction {
-  MethodUse M;
-  vector<Use> Params;
-  CallInst(const CallInst &CI);
+/// VANextInst - This class represents the va_next llvm instruction, which
+/// advances a vararg list passed an argument of the specified type, returning
+/// the resultant list.
+///
+class VANextInst : public Instruction {
+  PATypeHolder ArgTy;
+  VANextInst(const VANextInst &VAN)
+    : Instruction(VAN.getType(), VANext), ArgTy(VAN.getArgType()) {
+    Operands.reserve(1);
+    Operands.push_back(Use(VAN.Operands[0], this));
+  }
 public:
-  CallInst(Method *M, vector<Value*> &params, const string &Name = "");
-  inline ~CallInst() { dropAllReferences(); }
-
-  virtual string getOpcode() const { return "call"; }
+  VANextInst(Value *List, const Type *Ty, const std::string &Name = "",
+             Instruction *InsertBefore = 0)
+    : Instruction(List->getType(), VANext, Name, InsertBefore), ArgTy(Ty) {
+    Operands.reserve(1);
+    Operands.push_back(Use(List, this));
+  }
 
-  virtual Instruction *clone() const { return new CallInst(*this); }
-  bool hasSideEffects() const { return true; }
+  const Type *getArgType() const { return ArgTy; }
 
+  virtual Instruction *clone() const { return new VANextInst(*this); }
 
-  const Method *getCalledMethod() const { return M; }
-        Method *getCalledMethod()       { return M; }
+  // Methods for support type inquiry through isa, cast, and dyn_cast:
+  static inline bool classof(const VANextInst *) { return true; }
+  static inline bool classof(const Instruction *I) {
+    return I->getOpcode() == VANext;
+  }
+  static inline bool classof(const Value *V) {
+    return isa<Instruction>(V) && classof(cast<Instruction>(V));
+  }
+};
 
-  // Implement all of the functionality required by Instruction...
-  //
-  virtual void dropAllReferences();
-  virtual const Value *getOperand(unsigned i) const { 
-    return i == 0 ? M : ((i <= Params.size()) ? Params[i-1] : 0);
+/// VAArgInst - This class represents the va_arg llvm instruction, which returns
+/// an argument of the specified type given a va_list.
+///
+class VAArgInst : public Instruction {
+  VAArgInst(const VAArgInst &VAA)
+    : Instruction(VAA.getType(), VAArg) {
+    Operands.reserve(1);
+    Operands.push_back(Use(VAA.Operands[0], this));
   }
-  inline Value *getOperand(unsigned i) {
-    return (Value*)((const CallInst*)this)->getOperand(i);
+public:
+  VAArgInst(Value *List, const Type *Ty, const std::string &Name = "",
+             Instruction *InsertBefore = 0)
+    : Instruction(Ty, VAArg, Name, InsertBefore) {
+    Operands.reserve(1);
+    Operands.push_back(Use(List, this));
   }
-  virtual unsigned getNumOperands() const { return Params.size()+1; }
 
-  virtual bool setOperand(unsigned i, Value *Val);
+  virtual Instruction *clone() const { return new VAArgInst(*this); }
+
+  bool mayWriteToMemory() const { return true; }
+
+  // Methods for support type inquiry through isa, cast, and dyn_cast:
+  static inline bool classof(const VAArgInst *) { return true; }
+  static inline bool classof(const Instruction *I) {
+    return I->getOpcode() == VAArg;
+  }
+  static inline bool classof(const Value *V) {
+    return isa<Instruction>(V) && classof(cast<Instruction>(V));
+  }
 };
 
 #endif