1 //===-- llvm/Support/PatternMatch.h - Match on the LLVM IR ------*- 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 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:
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 ...
24 // This is primarily useful to things like the instruction combiner, but can
25 // also be useful for static analysis tools or code generators.
27 //===----------------------------------------------------------------------===//
29 #ifndef LLVM_SUPPORT_PATTERNMATCH_H
30 #define LLVM_SUPPORT_PATTERNMATCH_H
32 #include "llvm/Constants.h"
33 #include "llvm/Instructions.h"
36 namespace PatternMatch {
38 template<typename Val, typename Pattern>
39 bool match(Val *V, const Pattern &P) {
40 return const_cast<Pattern&>(P).match(V);
43 template<typename Class>
45 template<typename ITy>
46 bool match(ITy *V) { return isa<Class>(V); }
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>(); }
55 struct constantint_ty {
56 template<typename ITy>
58 if (const ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
59 const APInt &CIV = CI->getValue();
61 return CIV == static_cast<uint64_t>(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.
71 /// m_ConstantInt(int64_t) - Match a ConstantInt with a specific value
74 inline constantint_ty<Val> m_ConstantInt() {
75 return constantint_ty<Val>();
79 template<typename ITy>
81 if (const Constant *C = dyn_cast<Constant>(V))
82 return C->isNullValue();
87 /// m_Zero() - Match an arbitrary zero/null constant.
88 inline zero_ty m_Zero() { return zero_ty(); }
91 template<typename ITy>
93 if (const ConstantInt *C = dyn_cast<ConstantInt>(V))
99 /// m_One() - Match a an integer 1.
100 inline one_ty m_One() { return one_ty(); }
103 template<typename Class>
106 bind_ty(Class *&V) : VR(V) {}
108 template<typename ITy>
110 if (Class *CV = dyn_cast<Class>(V)) {
118 /// m_Value - Match a value, capturing it if we match.
119 inline bind_ty<Value> m_Value(Value *&V) { return V; }
121 /// m_ConstantInt - Match a ConstantInt, capturing the value if we match.
122 inline bind_ty<ConstantInt> m_ConstantInt(ConstantInt *&CI) { return CI; }
124 /// specificval_ty - Match a specified Value*.
125 struct specificval_ty {
127 specificval_ty(const Value *V) : Val(V) {}
129 template<typename ITy>
135 /// m_Specific - Match if we have a specific specified value.
136 inline specificval_ty m_Specific(const Value *V) { return V; }
139 //===----------------------------------------------------------------------===//
140 // Matchers for specific binary operators.
143 template<typename LHS_t, typename RHS_t,
144 unsigned Opcode, typename ConcreteTy = BinaryOperator>
145 struct BinaryOp_match {
149 BinaryOp_match(const LHS_t &LHS, const RHS_t &RHS) : L(LHS), R(RHS) {}
151 template<typename OpTy>
152 bool match(OpTy *V) {
153 if (V->getValueID() == Value::InstructionVal + Opcode) {
154 ConcreteTy *I = cast<ConcreteTy>(V);
155 return I->getOpcode() == Opcode && L.match(I->getOperand(0)) &&
156 R.match(I->getOperand(1));
158 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
159 return CE->getOpcode() == Opcode && L.match(CE->getOperand(0)) &&
160 R.match(CE->getOperand(1));
165 template<typename LHS, typename RHS>
166 inline BinaryOp_match<LHS, RHS, Instruction::Add> m_Add(const LHS &L,
168 return BinaryOp_match<LHS, RHS, Instruction::Add>(L, R);
171 template<typename LHS, typename RHS>
172 inline BinaryOp_match<LHS, RHS, Instruction::FAdd> m_FAdd(const LHS &L,
174 return BinaryOp_match<LHS, RHS, Instruction::FAdd>(L, R);
177 template<typename LHS, typename RHS>
178 inline BinaryOp_match<LHS, RHS, Instruction::Sub> m_Sub(const LHS &L,
180 return BinaryOp_match<LHS, RHS, Instruction::Sub>(L, R);
183 template<typename LHS, typename RHS>
184 inline BinaryOp_match<LHS, RHS, Instruction::FSub> m_FSub(const LHS &L,
186 return BinaryOp_match<LHS, RHS, Instruction::FSub>(L, R);
189 template<typename LHS, typename RHS>
190 inline BinaryOp_match<LHS, RHS, Instruction::Mul> m_Mul(const LHS &L,
192 return BinaryOp_match<LHS, RHS, Instruction::Mul>(L, R);
195 template<typename LHS, typename RHS>
196 inline BinaryOp_match<LHS, RHS, Instruction::FMul> m_FMul(const LHS &L,
198 return BinaryOp_match<LHS, RHS, Instruction::FMul>(L, R);
201 template<typename LHS, typename RHS>
202 inline BinaryOp_match<LHS, RHS, Instruction::UDiv> m_UDiv(const LHS &L,
204 return BinaryOp_match<LHS, RHS, Instruction::UDiv>(L, R);
207 template<typename LHS, typename RHS>
208 inline BinaryOp_match<LHS, RHS, Instruction::SDiv> m_SDiv(const LHS &L,
210 return BinaryOp_match<LHS, RHS, Instruction::SDiv>(L, R);
213 template<typename LHS, typename RHS>
214 inline BinaryOp_match<LHS, RHS, Instruction::FDiv> m_FDiv(const LHS &L,
216 return BinaryOp_match<LHS, RHS, Instruction::FDiv>(L, R);
219 template<typename LHS, typename RHS>
220 inline BinaryOp_match<LHS, RHS, Instruction::URem> m_URem(const LHS &L,
222 return BinaryOp_match<LHS, RHS, Instruction::URem>(L, R);
225 template<typename LHS, typename RHS>
226 inline BinaryOp_match<LHS, RHS, Instruction::SRem> m_SRem(const LHS &L,
228 return BinaryOp_match<LHS, RHS, Instruction::SRem>(L, R);
231 template<typename LHS, typename RHS>
232 inline BinaryOp_match<LHS, RHS, Instruction::FRem> m_FRem(const LHS &L,
234 return BinaryOp_match<LHS, RHS, Instruction::FRem>(L, R);
237 template<typename LHS, typename RHS>
238 inline BinaryOp_match<LHS, RHS, Instruction::And> m_And(const LHS &L,
240 return BinaryOp_match<LHS, RHS, Instruction::And>(L, R);
243 template<typename LHS, typename RHS>
244 inline BinaryOp_match<LHS, RHS, Instruction::Or> m_Or(const LHS &L,
246 return BinaryOp_match<LHS, RHS, Instruction::Or>(L, R);
249 template<typename LHS, typename RHS>
250 inline BinaryOp_match<LHS, RHS, Instruction::Xor> m_Xor(const LHS &L,
252 return BinaryOp_match<LHS, RHS, Instruction::Xor>(L, R);
255 template<typename LHS, typename RHS>
256 inline BinaryOp_match<LHS, RHS, Instruction::Shl> m_Shl(const LHS &L,
258 return BinaryOp_match<LHS, RHS, Instruction::Shl>(L, R);
261 template<typename LHS, typename RHS>
262 inline BinaryOp_match<LHS, RHS, Instruction::LShr> m_LShr(const LHS &L,
264 return BinaryOp_match<LHS, RHS, Instruction::LShr>(L, R);
267 template<typename LHS, typename RHS>
268 inline BinaryOp_match<LHS, RHS, Instruction::AShr> m_AShr(const LHS &L,
270 return BinaryOp_match<LHS, RHS, Instruction::AShr>(L, R);
273 //===----------------------------------------------------------------------===//
274 // Matchers for either AShr or LShr .. for convenience
276 template<typename LHS_t, typename RHS_t, typename ConcreteTy = BinaryOperator>
281 Shr_match(const LHS_t &LHS, const RHS_t &RHS) : L(LHS), R(RHS) {}
283 template<typename OpTy>
284 bool match(OpTy *V) {
285 if (V->getValueID() == Value::InstructionVal + Instruction::LShr ||
286 V->getValueID() == Value::InstructionVal + Instruction::AShr) {
287 ConcreteTy *I = cast<ConcreteTy>(V);
288 return (I->getOpcode() == Instruction::AShr ||
289 I->getOpcode() == Instruction::LShr) &&
290 L.match(I->getOperand(0)) &&
291 R.match(I->getOperand(1));
293 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
294 return (CE->getOpcode() == Instruction::LShr ||
295 CE->getOpcode() == Instruction::AShr) &&
296 L.match(CE->getOperand(0)) &&
297 R.match(CE->getOperand(1));
302 template<typename LHS, typename RHS>
303 inline Shr_match<LHS, RHS> m_Shr(const LHS &L, const RHS &R) {
304 return Shr_match<LHS, RHS>(L, R);
307 //===----------------------------------------------------------------------===//
308 // Matchers for binary classes
311 template<typename LHS_t, typename RHS_t, typename Class, typename OpcType>
312 struct BinaryOpClass_match {
317 BinaryOpClass_match(OpcType &Op, const LHS_t &LHS,
319 : Opcode(&Op), L(LHS), R(RHS) {}
320 BinaryOpClass_match(const LHS_t &LHS, const RHS_t &RHS)
321 : Opcode(0), L(LHS), R(RHS) {}
323 template<typename OpTy>
324 bool match(OpTy *V) {
325 if (Class *I = dyn_cast<Class>(V))
326 if (L.match(I->getOperand(0)) &&
327 R.match(I->getOperand(1))) {
329 *Opcode = I->getOpcode();
332 #if 0 // Doesn't handle constantexprs yet!
333 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
334 return CE->getOpcode() == Opcode && L.match(CE->getOperand(0)) &&
335 R.match(CE->getOperand(1));
341 template<typename LHS, typename RHS>
342 inline BinaryOpClass_match<LHS, RHS, BinaryOperator, Instruction::BinaryOps>
343 m_Shift(Instruction::BinaryOps &Op, const LHS &L, const RHS &R) {
344 return BinaryOpClass_match<LHS, RHS,
345 BinaryOperator, Instruction::BinaryOps>(Op, L, R);
348 template<typename LHS, typename RHS>
349 inline BinaryOpClass_match<LHS, RHS, BinaryOperator, Instruction::BinaryOps>
350 m_Shift(const LHS &L, const RHS &R) {
351 return BinaryOpClass_match<LHS, RHS,
352 BinaryOperator, Instruction::BinaryOps>(L, R);
355 //===----------------------------------------------------------------------===//
356 // Matchers for CmpInst classes
359 template<typename LHS_t, typename RHS_t, typename Class, typename PredicateTy>
360 struct CmpClass_match {
361 PredicateTy &Predicate;
365 CmpClass_match(PredicateTy &Pred, const LHS_t &LHS,
367 : Predicate(Pred), L(LHS), R(RHS) {}
369 template<typename OpTy>
370 bool match(OpTy *V) {
371 if (Class *I = dyn_cast<Class>(V))
372 if (L.match(I->getOperand(0)) &&
373 R.match(I->getOperand(1))) {
374 Predicate = I->getPredicate();
381 template<typename LHS, typename RHS>
382 inline CmpClass_match<LHS, RHS, ICmpInst, ICmpInst::Predicate>
383 m_ICmp(ICmpInst::Predicate &Pred, const LHS &L, const RHS &R) {
384 return CmpClass_match<LHS, RHS,
385 ICmpInst, ICmpInst::Predicate>(Pred, L, R);
388 template<typename LHS, typename RHS>
389 inline CmpClass_match<LHS, RHS, FCmpInst, FCmpInst::Predicate>
390 m_FCmp(FCmpInst::Predicate &Pred, const LHS &L, const RHS &R) {
391 return CmpClass_match<LHS, RHS,
392 FCmpInst, FCmpInst::Predicate>(Pred, L, R);
395 //===----------------------------------------------------------------------===//
396 // Matchers for SelectInst classes
399 template<typename Cond_t, typename LHS_t, typename RHS_t>
400 struct SelectClass_match {
405 SelectClass_match(const Cond_t &Cond, const LHS_t &LHS,
407 : C(Cond), L(LHS), R(RHS) {}
409 template<typename OpTy>
410 bool match(OpTy *V) {
411 if (SelectInst *I = dyn_cast<SelectInst>(V))
412 return C.match(I->getOperand(0)) &&
413 L.match(I->getOperand(1)) &&
414 R.match(I->getOperand(2));
419 template<typename Cond, typename LHS, typename RHS>
420 inline SelectClass_match<Cond, LHS, RHS>
421 m_Select(const Cond &C, const LHS &L, const RHS &R) {
422 return SelectClass_match<Cond, LHS, RHS>(C, L, R);
425 /// m_SelectCst - This matches a select of two constants, e.g.:
426 /// m_SelectCst<-1, 0>(m_Value(V))
427 template<int64_t L, int64_t R, typename Cond>
428 inline SelectClass_match<Cond, constantint_ty<L>, constantint_ty<R> >
429 m_SelectCst(const Cond &C) {
430 return SelectClass_match<Cond, constantint_ty<L>,
431 constantint_ty<R> >(C, m_ConstantInt<L>(),
436 //===----------------------------------------------------------------------===//
437 // Matchers for CastInst classes
440 template<typename Op_t, unsigned Opcode>
441 struct CastClass_match {
444 CastClass_match(const Op_t &OpMatch) : Op(OpMatch) {}
446 template<typename OpTy>
447 bool match(OpTy *V) {
448 if (CastInst *I = dyn_cast<CastInst>(V))
449 return I->getOpcode() == Opcode && Op.match(I->getOperand(0));
450 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
451 return CE->getOpcode() == Opcode && Op.match(CE->getOperand(0));
457 template<typename OpTy>
458 inline CastClass_match<OpTy, Instruction::PtrToInt>
459 m_PtrToInt(const OpTy &Op) {
460 return CastClass_match<OpTy, Instruction::PtrToInt>(Op);
464 template<typename OpTy>
465 inline CastClass_match<OpTy, Instruction::Trunc>
466 m_Trunc(const OpTy &Op) {
467 return CastClass_match<OpTy, Instruction::Trunc>(Op);
471 template<typename OpTy>
472 inline CastClass_match<OpTy, Instruction::SExt>
473 m_SExt(const OpTy &Op) {
474 return CastClass_match<OpTy, Instruction::SExt>(Op);
478 template<typename OpTy>
479 inline CastClass_match<OpTy, Instruction::ZExt>
480 m_ZExt(const OpTy &Op) {
481 return CastClass_match<OpTy, Instruction::ZExt>(Op);
485 //===----------------------------------------------------------------------===//
486 // Matchers for unary operators
489 template<typename LHS_t>
493 not_match(const LHS_t &LHS) : L(LHS) {}
495 template<typename OpTy>
496 bool match(OpTy *V) {
497 if (Instruction *I = dyn_cast<Instruction>(V))
498 if (I->getOpcode() == Instruction::Xor)
499 return matchIfNot(I->getOperand(0), I->getOperand(1));
500 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
501 if (CE->getOpcode() == Instruction::Xor)
502 return matchIfNot(CE->getOperand(0), CE->getOperand(1));
503 if (ConstantInt *CI = dyn_cast<ConstantInt>(V))
504 return L.match(ConstantExpr::getNot(CI));
508 bool matchIfNot(Value *LHS, Value *RHS) {
509 if (ConstantInt *CI = dyn_cast<ConstantInt>(RHS))
510 return CI->isAllOnesValue() && L.match(LHS);
511 if (ConstantInt *CI = dyn_cast<ConstantInt>(LHS))
512 return CI->isAllOnesValue() && L.match(RHS);
513 if (ConstantVector *CV = dyn_cast<ConstantVector>(RHS))
514 return CV->isAllOnesValue() && L.match(LHS);
515 if (ConstantVector *CV = dyn_cast<ConstantVector>(LHS))
516 return CV->isAllOnesValue() && L.match(RHS);
521 template<typename LHS>
522 inline not_match<LHS> m_Not(const LHS &L) { return L; }
525 template<typename LHS_t>
529 neg_match(const LHS_t &LHS) : L(LHS) {}
531 template<typename OpTy>
532 bool match(OpTy *V) {
533 if (Instruction *I = dyn_cast<Instruction>(V))
534 if (I->getOpcode() == Instruction::Sub)
535 return matchIfNeg(I->getOperand(0), I->getOperand(1));
536 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
537 if (CE->getOpcode() == Instruction::Sub)
538 return matchIfNeg(CE->getOperand(0), CE->getOperand(1));
539 if (ConstantInt *CI = dyn_cast<ConstantInt>(V))
540 return L.match(ConstantExpr::getNeg(CI));
544 bool matchIfNeg(Value *LHS, Value *RHS) {
545 return LHS == ConstantFP::getZeroValueForNegation(LHS->getType()) &&
550 template<typename LHS>
551 inline neg_match<LHS> m_Neg(const LHS &L) { return L; }
554 template<typename LHS_t>
558 fneg_match(const LHS_t &LHS) : L(LHS) {}
560 template<typename OpTy>
561 bool match(OpTy *V) {
562 if (Instruction *I = dyn_cast<Instruction>(V))
563 if (I->getOpcode() == Instruction::FSub)
564 return matchIfFNeg(I->getOperand(0), I->getOperand(1));
565 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
566 if (CE->getOpcode() == Instruction::FSub)
567 return matchIfFNeg(CE->getOperand(0), CE->getOperand(1));
568 if (ConstantFP *CF = dyn_cast<ConstantFP>(V))
569 return L.match(ConstantExpr::getFNeg(CF));
573 bool matchIfFNeg(Value *LHS, Value *RHS) {
574 return LHS == ConstantFP::getZeroValueForNegation(LHS->getType()) &&
579 template<typename LHS>
580 inline fneg_match<LHS> m_FNeg(const LHS &L) { return L; }
583 //===----------------------------------------------------------------------===//
584 // Matchers for control flow
587 template<typename Cond_t>
591 brc_match(const Cond_t &C, BasicBlock *&t, BasicBlock *&f)
592 : Cond(C), T(t), F(f) {
595 template<typename OpTy>
596 bool match(OpTy *V) {
597 if (BranchInst *BI = dyn_cast<BranchInst>(V))
598 if (BI->isConditional()) {
599 if (Cond.match(BI->getCondition())) {
600 T = BI->getSuccessor(0);
601 F = BI->getSuccessor(1);
609 template<typename Cond_t>
610 inline brc_match<Cond_t> m_Br(const Cond_t &C, BasicBlock *&T, BasicBlock *&F) {
611 return brc_match<Cond_t>(C, T, F);
614 } // end namespace PatternMatch
615 } // end namespace llvm