include/llvm/Support/PatternMatch.h

   1 //===-- llvm/Support/PatternMatch.h - Match on the LLVM IR ------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file provides a simple and efficient mechanism for performing general
  11 // tree-based pattern matches on the LLVM IR.  The power of these routines is
  12 // that it allows you to write concise patterns that are expressive and easy to
  13 // understand.  The other major advantage of this is that it allows you to
  14 // trivially capture/bind elements in the pattern to variables.  For example,
  15 // you can do something like this:
  16 //
  17 //  Value *Exp = ...
  18 //  Value *X, *Y;  ConstantInt *C1, *C2;      // (X & C1) | (Y & C2)
  19 //  if (match(Exp, m_Or(m_And(m_Value(X), m_ConstantInt(C1)),
  20 //                      m_And(m_Value(Y), m_ConstantInt(C2))))) {
  21 //    ... Pattern is matched and variables are bound ...
  22 //  }
  23 //
  24 // This is primarily useful to things like the instruction combiner, but can
  25 // also be useful for static analysis tools or code generators.
  26 //
  27 //===----------------------------------------------------------------------===//
  28
  29 #ifndef LLVM_SUPPORT_PATTERNMATCH_H
  30 #define LLVM_SUPPORT_PATTERNMATCH_H
  31
  32 #include "llvm/Constants.h"
  33 #include "llvm/Instructions.h"
  34
  35 namespace llvm {
  36 namespace PatternMatch {
  37
  38 template<typename Val, typename Pattern>
  39 bool match(Val *V, const Pattern &P) {
  40   return const_cast<Pattern&>(P).match(V);
  41 }
  42
  43 template<typename Class>
  44 struct leaf_ty {
  45   template<typename ITy>
  46   bool match(ITy *V) { return isa<Class>(V); }
  47 };
  48
  49 /// m_Value() - Match an arbitrary value and ignore it.
  50 inline leaf_ty<Value> m_Value() { return leaf_ty<Value>(); }
  51 /// m_ConstantInt() - Match an arbitrary ConstantInt and ignore it.
  52 inline leaf_ty<ConstantInt> m_ConstantInt() { return leaf_ty<ConstantInt>(); }
  53
  54 template<int64_t Val>
  55 struct constantint_ty {
  56   template<typename ITy>
  57   bool match(ITy *V) {
  58     if (const ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
  59       const APInt &CIV = CI->getValue();
  60       if (Val >= 0)
  61         return CIV == Val;
  62       // If Val is negative, and CI is shorter than it, truncate to the right
  63       // number of bits.  If it is larger, then we have to sign extend.  Just
  64       // compare their negated values.
  65       return -CIV == -Val;
  66     }
  67     return false;
  68   }
  69 };
  70
  71 /// m_ConstantInt(int64_t) - Match a ConstantInt with a specific value
  72 /// and ignore it.
  73 template<int64_t Val>
  74 inline constantint_ty<Val> m_ConstantInt() {
  75   return constantint_ty<Val>();
  76 }
  77
  78 struct zero_ty {
  79   template<typename ITy>
  80   bool match(ITy *V) {
  81     if (const Constant *C = dyn_cast<Constant>(V))
  82       return C->isNullValue();
  83     return false;
  84   }
  85 };
  86
  87 /// m_Zero() - Match an arbitrary zero/null constant.
  88 inline zero_ty m_Zero() { return zero_ty(); }
  89
  90
  91 template<typename Class>
  92 struct bind_ty {
  93   Class *&VR;
  94   bind_ty(Class *&V) : VR(V) {}
  95
  96   template<typename ITy>
  97   bool match(ITy *V) {
  98     if (Class *CV = dyn_cast<Class>(V)) {
  99       VR = CV;
 100       return true;
 101     }
 102     return false;
 103   }
 104 };
 105
 106 /// m_Value - Match a value, capturing it if we match.
 107 inline bind_ty<Value> m_Value(Value *&V) { return V; }
 108
 109 /// m_ConstantInt - Match a ConstantInt, capturing the value if we match.
 110 inline bind_ty<ConstantInt> m_ConstantInt(ConstantInt *&CI) { return CI; }
 111
 112 /// specificval_ty - Match a specified Value*.
 113 struct specificval_ty {
 114   const Value *Val;
 115   specificval_ty(const Value *V) : Val(V) {}
 116
 117   template<typename ITy>
 118   bool match(ITy *V) {
 119     return V == Val;
 120   }
 121 };
 122
 123 /// m_Specific - Match if we have a specific specified value.
 124 inline specificval_ty m_Specific(const Value *V) { return V; }
 125
 126
 127 //===----------------------------------------------------------------------===//
 128 // Matchers for specific binary operators.
 129 //
 130
 131 template<typename LHS_t, typename RHS_t,
 132          unsigned Opcode, typename ConcreteTy = BinaryOperator>
 133 struct BinaryOp_match {
 134   LHS_t L;
 135   RHS_t R;
 136
 137   BinaryOp_match(const LHS_t &LHS, const RHS_t &RHS) : L(LHS), R(RHS) {}
 138
 139   template<typename OpTy>
 140   bool match(OpTy *V) {
 141     if (V->getValueID() == Value::InstructionVal + Opcode) {
 142       ConcreteTy *I = cast<ConcreteTy>(V);
 143       return I->getOpcode() == Opcode && L.match(I->getOperand(0)) &&
 144              R.match(I->getOperand(1));
 145     }
 146     if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
 147       return CE->getOpcode() == Opcode && L.match(CE->getOperand(0)) &&
 148              R.match(CE->getOperand(1));
 149     return false;
 150   }
 151 };
 152
 153 template<typename LHS, typename RHS>
 154 inline BinaryOp_match<LHS, RHS, Instruction::Add> m_Add(const LHS &L,
 155                                                         const RHS &R) {
 156   return BinaryOp_match<LHS, RHS, Instruction::Add>(L, R);
 157 }
 158
 159 template<typename LHS, typename RHS>
 160 inline BinaryOp_match<LHS, RHS, Instruction::FAdd> m_FAdd(const LHS &L,
 161                                                           const RHS &R) {
 162   return BinaryOp_match<LHS, RHS, Instruction::FAdd>(L, R);
 163 }
 164
 165 template<typename LHS, typename RHS>
 166 inline BinaryOp_match<LHS, RHS, Instruction::Sub> m_Sub(const LHS &L,
 167                                                         const RHS &R) {
 168   return BinaryOp_match<LHS, RHS, Instruction::Sub>(L, R);
 169 }
 170
 171 template<typename LHS, typename RHS>
 172 inline BinaryOp_match<LHS, RHS, Instruction::FSub> m_FSub(const LHS &L,
 173                                                           const RHS &R) {
 174   return BinaryOp_match<LHS, RHS, Instruction::FSub>(L, R);
 175 }
 176
 177 template<typename LHS, typename RHS>
 178 inline BinaryOp_match<LHS, RHS, Instruction::Mul> m_Mul(const LHS &L,
 179                                                         const RHS &R) {
 180   return BinaryOp_match<LHS, RHS, Instruction::Mul>(L, R);
 181 }
 182
 183 template<typename LHS, typename RHS>
 184 inline BinaryOp_match<LHS, RHS, Instruction::FMul> m_FMul(const LHS &L,
 185                                                           const RHS &R) {
 186   return BinaryOp_match<LHS, RHS, Instruction::FMul>(L, R);
 187 }
 188
 189 template<typename LHS, typename RHS>
 190 inline BinaryOp_match<LHS, RHS, Instruction::UDiv> m_UDiv(const LHS &L,
 191                                                         const RHS &R) {
 192   return BinaryOp_match<LHS, RHS, Instruction::UDiv>(L, R);
 193 }
 194
 195 template<typename LHS, typename RHS>
 196 inline BinaryOp_match<LHS, RHS, Instruction::SDiv> m_SDiv(const LHS &L,
 197                                                         const RHS &R) {
 198   return BinaryOp_match<LHS, RHS, Instruction::SDiv>(L, R);
 199 }
 200
 201 template<typename LHS, typename RHS>
 202 inline BinaryOp_match<LHS, RHS, Instruction::FDiv> m_FDiv(const LHS &L,
 203                                                         const RHS &R) {
 204   return BinaryOp_match<LHS, RHS, Instruction::FDiv>(L, R);
 205 }
 206
 207 template<typename LHS, typename RHS>
 208 inline BinaryOp_match<LHS, RHS, Instruction::URem> m_URem(const LHS &L,
 209                                                           const RHS &R) {
 210   return BinaryOp_match<LHS, RHS, Instruction::URem>(L, R);
 211 }
 212
 213 template<typename LHS, typename RHS>
 214 inline BinaryOp_match<LHS, RHS, Instruction::SRem> m_SRem(const LHS &L,
 215                                                           const RHS &R) {
 216   return BinaryOp_match<LHS, RHS, Instruction::SRem>(L, R);
 217 }
 218
 219 template<typename LHS, typename RHS>
 220 inline BinaryOp_match<LHS, RHS, Instruction::FRem> m_FRem(const LHS &L,
 221                                                         const RHS &R) {
 222   return BinaryOp_match<LHS, RHS, Instruction::FRem>(L, R);
 223 }
 224
 225 template<typename LHS, typename RHS>
 226 inline BinaryOp_match<LHS, RHS, Instruction::And> m_And(const LHS &L,
 227                                                         const RHS &R) {
 228   return BinaryOp_match<LHS, RHS, Instruction::And>(L, R);
 229 }
 230
 231 template<typename LHS, typename RHS>
 232 inline BinaryOp_match<LHS, RHS, Instruction::Or> m_Or(const LHS &L,
 233                                                       const RHS &R) {
 234   return BinaryOp_match<LHS, RHS, Instruction::Or>(L, R);
 235 }
 236
 237 template<typename LHS, typename RHS>
 238 inline BinaryOp_match<LHS, RHS, Instruction::Xor> m_Xor(const LHS &L,
 239                                                         const RHS &R) {
 240   return BinaryOp_match<LHS, RHS, Instruction::Xor>(L, R);
 241 }
 242
 243 template<typename LHS, typename RHS>
 244 inline BinaryOp_match<LHS, RHS, Instruction::Shl> m_Shl(const LHS &L,
 245                                                         const RHS &R) {
 246   return BinaryOp_match<LHS, RHS, Instruction::Shl>(L, R);
 247 }
 248
 249 template<typename LHS, typename RHS>
 250 inline BinaryOp_match<LHS, RHS, Instruction::LShr> m_LShr(const LHS &L,
 251                                                           const RHS &R) {
 252   return BinaryOp_match<LHS, RHS, Instruction::LShr>(L, R);
 253 }
 254
 255 template<typename LHS, typename RHS>
 256 inline BinaryOp_match<LHS, RHS, Instruction::AShr> m_AShr(const LHS &L,
 257                                                           const RHS &R) {
 258   return BinaryOp_match<LHS, RHS, Instruction::AShr>(L, R);
 259 }
 260
 261 //===----------------------------------------------------------------------===//
 262 // Matchers for either AShr or LShr .. for convenience
 263 //
 264 template<typename LHS_t, typename RHS_t, typename ConcreteTy = BinaryOperator>
 265 struct Shr_match {
 266   LHS_t L;
 267   RHS_t R;
 268
 269   Shr_match(const LHS_t &LHS, const RHS_t &RHS) : L(LHS), R(RHS) {}
 270
 271   template<typename OpTy>
 272   bool match(OpTy *V) {
 273     if (V->getValueID() == Value::InstructionVal + Instruction::LShr ||
 274         V->getValueID() == Value::InstructionVal + Instruction::AShr) {
 275       ConcreteTy *I = cast<ConcreteTy>(V);
 276       return (I->getOpcode() == Instruction::AShr ||
 277               I->getOpcode() == Instruction::LShr) &&
 278              L.match(I->getOperand(0)) &&
 279              R.match(I->getOperand(1));
 280     }
 281     if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
 282       return (CE->getOpcode() == Instruction::LShr ||
 283               CE->getOpcode() == Instruction::AShr) &&
 284              L.match(CE->getOperand(0)) &&
 285              R.match(CE->getOperand(1));
 286     return false;
 287   }
 288 };
 289
 290 template<typename LHS, typename RHS>
 291 inline Shr_match<LHS, RHS> m_Shr(const LHS &L, const RHS &R) {
 292   return Shr_match<LHS, RHS>(L, R);
 293 }
 294
 295 //===----------------------------------------------------------------------===//
 296 // Matchers for binary classes
 297 //
 298
 299 template<typename LHS_t, typename RHS_t, typename Class, typename OpcType>
 300 struct BinaryOpClass_match {
 301   OpcType *Opcode;
 302   LHS_t L;
 303   RHS_t R;
 304
 305   BinaryOpClass_match(OpcType &Op, const LHS_t &LHS,
 306                       const RHS_t &RHS)
 307     : Opcode(&Op), L(LHS), R(RHS) {}
 308   BinaryOpClass_match(const LHS_t &LHS, const RHS_t &RHS)
 309     : Opcode(0), L(LHS), R(RHS) {}
 310
 311   template<typename OpTy>
 312   bool match(OpTy *V) {
 313     if (Class *I = dyn_cast<Class>(V))
 314       if (L.match(I->getOperand(0)) && R.match(I->getOperand(1))) {
 315         if (Opcode)
 316           *Opcode = I->getOpcode();
 317         return true;
 318       }
 319 #if 0  // Doesn't handle constantexprs yet!
 320     if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
 321       return CE->getOpcode() == Opcode && L.match(CE->getOperand(0)) &&
 322              R.match(CE->getOperand(1));
 323 #endif
 324     return false;
 325   }
 326 };
 327
 328 template<typename LHS, typename RHS>
 329 inline BinaryOpClass_match<LHS, RHS, BinaryOperator, Instruction::BinaryOps>
 330 m_Shift(Instruction::BinaryOps &Op, const LHS &L, const RHS &R) {
 331   return BinaryOpClass_match<LHS, RHS,
 332                              BinaryOperator, Instruction::BinaryOps>(Op, L, R);
 333 }
 334
 335 template<typename LHS, typename RHS>
 336 inline BinaryOpClass_match<LHS, RHS, BinaryOperator, Instruction::BinaryOps>
 337 m_Shift(const LHS &L, const RHS &R) {
 338   return BinaryOpClass_match<LHS, RHS,
 339                              BinaryOperator, Instruction::BinaryOps>(L, R);
 340 }
 341
 342 //===----------------------------------------------------------------------===//
 343 // Matchers for CmpInst classes
 344 //
 345
 346 template<typename LHS_t, typename RHS_t, typename Class, typename PredicateTy>
 347 struct CmpClass_match {
 348   PredicateTy &Predicate;
 349   LHS_t L;
 350   RHS_t R;
 351
 352   CmpClass_match(PredicateTy &Pred, const LHS_t &LHS,
 353                  const RHS_t &RHS)
 354     : Predicate(Pred), L(LHS), R(RHS) {}
 355
 356   template<typename OpTy>
 357   bool match(OpTy *V) {
 358     if (Class *I = dyn_cast<Class>(V))
 359       if (L.match(I->getOperand(0)) && R.match(I->getOperand(1))) {
 360         Predicate = I->getPredicate();
 361         return true;
 362       }
 363     return false;
 364   }
 365 };
 366
 367 template<typename LHS, typename RHS>
 368 inline CmpClass_match<LHS, RHS, ICmpInst, ICmpInst::Predicate>
 369 m_ICmp(ICmpInst::Predicate &Pred, const LHS &L, const RHS &R) {
 370   return CmpClass_match<LHS, RHS,
 371                         ICmpInst, ICmpInst::Predicate>(Pred, L, R);
 372 }
 373
 374 template<typename LHS, typename RHS>
 375 inline CmpClass_match<LHS, RHS, FCmpInst, FCmpInst::Predicate>
 376 m_FCmp(FCmpInst::Predicate &Pred, const LHS &L, const RHS &R) {
 377   return CmpClass_match<LHS, RHS,
 378                         FCmpInst, FCmpInst::Predicate>(Pred, L, R);
 379 }
 380
 381 //===----------------------------------------------------------------------===//
 382 // Matchers for SelectInst classes
 383 //
 384
 385 template<typename Cond_t, typename LHS_t, typename RHS_t>
 386 struct SelectClass_match {
 387   Cond_t C;
 388   LHS_t L;
 389   RHS_t R;
 390
 391   SelectClass_match(const Cond_t &Cond, const LHS_t &LHS,
 392                     const RHS_t &RHS)
 393     : C(Cond), L(LHS), R(RHS) {}
 394
 395   template<typename OpTy>
 396   bool match(OpTy *V) {
 397     if (SelectInst *I = dyn_cast<SelectInst>(V))
 398       return C.match(I->getOperand(0)) &&
 399              L.match(I->getOperand(1)) &&
 400              R.match(I->getOperand(2));
 401     return false;
 402   }
 403 };
 404
 405 template<typename Cond, typename LHS, typename RHS>
 406 inline SelectClass_match<Cond, RHS, LHS>
 407 m_Select(const Cond &C, const LHS &L, const RHS &R) {
 408   return SelectClass_match<Cond, LHS, RHS>(C, L, R);
 409 }
 410
 411 /// m_SelectCst - This matches a select of two constants, e.g.:
 412 ///    m_SelectCst(m_Value(V), -1, 0)
 413 template<int64_t L, int64_t R, typename Cond>
 414 inline SelectClass_match<Cond, constantint_ty<L>, constantint_ty<R> >
 415 m_SelectCst(const Cond &C) {
 416   return SelectClass_match<Cond, constantint_ty<L>,
 417                            constantint_ty<R> >(C, m_ConstantInt<L>(),
 418                                            m_ConstantInt<R>());
 419 }
 420
 421
 422 //===----------------------------------------------------------------------===//
 423 // Matchers for CastInst classes
 424 //
 425
 426 template<typename Op_t, typename Class>
 427 struct CastClass_match {
 428   Op_t Op;
 429
 430   CastClass_match(const Op_t &OpMatch) : Op(OpMatch) {}
 431
 432   template<typename OpTy>
 433   bool match(OpTy *V) {
 434     if (Class *I = dyn_cast<Class>(V))
 435       return Op.match(I->getOperand(0));
 436     return false;
 437   }
 438 };
 439
 440 template<typename Class, typename OpTy>
 441 inline CastClass_match<OpTy, Class> m_Cast(const OpTy &Op) {
 442   return CastClass_match<OpTy, Class>(Op);
 443 }
 444
 445
 446 //===----------------------------------------------------------------------===//
 447 // Matchers for unary operators
 448 //
 449
 450 template<typename LHS_t>
 451 struct not_match {
 452   LHS_t L;
 453
 454   not_match(const LHS_t &LHS) : L(LHS) {}
 455
 456   template<typename OpTy>
 457   bool match(OpTy *V) {
 458     if (Instruction *I = dyn_cast<Instruction>(V))
 459       if (I->getOpcode() == Instruction::Xor)
 460         return matchIfNot(I->getOperand(0), I->getOperand(1));
 461     if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
 462       if (CE->getOpcode() == Instruction::Xor)
 463         return matchIfNot(CE->getOperand(0), CE->getOperand(1));
 464     if (ConstantInt *CI = dyn_cast<ConstantInt>(V))
 465       return L.match(ConstantExpr::getNot(CI));
 466     return false;
 467   }
 468 private:
 469   bool matchIfNot(Value *LHS, Value *RHS) {
 470     if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS))
 471       return CI->isAllOnesValue() && L.match(LHS);
 472     if (ConstantInt *CI = dyn_cast<ConstantInt>(LHS))
 473       return CI->isAllOnesValue() && L.match(RHS);
 474     if (ConstantVector *CV = dyn_cast<ConstantVector>(RHS))
 475       return CV->isAllOnesValue() && L.match(LHS);
 476     if (ConstantVector *CV = dyn_cast<ConstantVector>(LHS))
 477       return CV->isAllOnesValue() && L.match(RHS);
 478     return false;
 479   }
 480 };
 481
 482 template<typename LHS>
 483 inline not_match<LHS> m_Not(const LHS &L) { return L; }
 484
 485
 486 template<typename LHS_t>
 487 struct neg_match {
 488   LHS_t L;
 489
 490   neg_match(const LHS_t &LHS) : L(LHS) {}
 491
 492   template<typename OpTy>
 493   bool match(OpTy *V) {
 494     if (Instruction *I = dyn_cast<Instruction>(V))
 495       if (I->getOpcode() == Instruction::Sub)
 496         return matchIfNeg(I->getOperand(0), I->getOperand(1));
 497     if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
 498       if (CE->getOpcode() == Instruction::Sub)
 499         return matchIfNeg(CE->getOperand(0), CE->getOperand(1));
 500     if (ConstantInt *CI = dyn_cast<ConstantInt>(V))
 501       return L.match(ConstantExpr::getNeg(CI));
 502     return false;
 503   }
 504 private:
 505   bool matchIfNeg(Value *LHS, Value *RHS) {
 506     return LHS == ConstantExpr::getZeroValueForNegationExpr(LHS->getType()) &&
 507            L.match(RHS);
 508   }
 509 };
 510
 511 template<typename LHS>
 512 inline neg_match<LHS> m_Neg(const LHS &L) { return L; }
 513
 514
 515 template<typename LHS_t>
 516 struct fneg_match {
 517   LHS_t L;
 518
 519   fneg_match(const LHS_t &LHS) : L(LHS) {}
 520
 521   template<typename OpTy>
 522   bool match(OpTy *V) {
 523     if (Instruction *I = dyn_cast<Instruction>(V))
 524       if (I->getOpcode() == Instruction::FSub)
 525         return matchIfFNeg(I->getOperand(0), I->getOperand(1));
 526     if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
 527       if (CE->getOpcode() == Instruction::FSub)
 528         return matchIfFNeg(CE->getOperand(0), CE->getOperand(1));
 529     if (ConstantFP *CF = dyn_cast<ConstantFP>(V))
 530       return L.match(ConstantExpr::getFNeg(CF));
 531     return false;
 532   }
 533 private:
 534   bool matchIfFNeg(Value *LHS, Value *RHS) {
 535     return LHS == ConstantExpr::getZeroValueForNegationExpr(LHS->getType()) &&
 536            L.match(RHS);
 537   }
 538 };
 539
 540 template<typename LHS>
 541 inline fneg_match<LHS> m_FNeg(const LHS &L) { return L; }
 542
 543
 544 //===----------------------------------------------------------------------===//
 545 // Matchers for control flow
 546 //
 547
 548 template<typename Cond_t>
 549 struct brc_match {
 550   Cond_t Cond;
 551   BasicBlock *&T, *&F;
 552   brc_match(const Cond_t &C, BasicBlock *&t, BasicBlock *&f)
 553     : Cond(C), T(t), F(f) {
 554   }
 555
 556   template<typename OpTy>
 557   bool match(OpTy *V) {
 558     if (BranchInst *BI = dyn_cast<BranchInst>(V))
 559       if (BI->isConditional()) {
 560         if (Cond.match(BI->getCondition())) {
 561           T = BI->getSuccessor(0);
 562           F = BI->getSuccessor(1);
 563           return true;
 564         }
 565       }
 566     return false;
 567   }
 568 };
 569
 570 template<typename Cond_t>
 571 inline brc_match<Cond_t> m_Br(const Cond_t &C, BasicBlock *&T, BasicBlock *&F) {
 572   return brc_match<Cond_t>(C, T, F);
 573 }
 574
 575 } // end namespace PatternMatch
 576 } // end namespace llvm
 577
 578 #endif