Home | History | Annotate | Download | only in priv 
      1 
      2 /*---------------------------------------------------------------*/
      3 /*--- begin                                        ir_match.h ---*/
      4 /*---------------------------------------------------------------*/
      5 
      6 /*
      7    This file is part of Valgrind, a dynamic binary instrumentation
      8    framework.
      9 
     10    Copyright (C) 2004-2013 OpenWorks LLP
     11       info (at) open-works.net
     12 
     13    This program is free software; you can redistribute it and/or
     14    modify it under the terms of the GNU General Public License as
     15    published by the Free Software Foundation; either version 2 of the
     16    License, or (at your option) any later version.
     17 
     18    This program is distributed in the hope that it will be useful, but
     19    WITHOUT ANY WARRANTY; without even the implied warranty of
     20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     21    General Public License for more details.
     22 
     23    You should have received a copy of the GNU General Public License
     24    along with this program; if not, write to the Free Software
     25    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
     26    02110-1301, USA.
     27 
     28    The GNU General Public License is contained in the file COPYING.
     29 
     30    Neither the names of the U.S. Department of Energy nor the
     31    University of California nor the names of its contributors may be
     32    used to endorse or promote products derived from this software
     33    without prior written permission.
     34 */
     35 
     36 /* Provides a facility for doing IR tree matching. */
     37 
     38 #ifndef __VEX_IR_MATCH_H
     39 #define __VEX_IR_MATCH_H
     40 
     41 #include "libvex_basictypes.h"
     42 #include "libvex_ir.h"
     43 
     44 
     45 /* Patterns are simply IRExpr* trees, with IRExpr_Binder nodes at the
     46    leaves, indicating binding points.  Use these magic macros to
     47    declare and define patterns. */
     48 
     49 #define DECLARE_PATTERN(_patt) \
     50    static IRExpr* _patt = NULL
     51 
     52 #define DEFINE_PATTERN(_patt,_expr)                            \
     53    do {                                                        \
     54       if (!(_patt)) {                                          \
     55          vassert(vexGetAllocMode() == VexAllocModeTEMP);       \
     56          vexSetAllocMode(VexAllocModePERM);                    \
     57          _patt = (_expr);                                      \
     58          vexSetAllocMode(VexAllocModeTEMP);                    \
     59          vassert(vexGetAllocMode() == VexAllocModeTEMP);       \
     60       }                                                        \
     61    } while (0)
     62 
     63 
     64 /* This type returns the result of a match -- it records what
     65    the binders got instantiated to. */
     66 
     67 #define N_IRMATCH_BINDERS 4
     68 
     69 typedef
     70    struct {
     71       IRExpr* bindee[N_IRMATCH_BINDERS];
     72    }
     73    MatchInfo;
     74 
     75 
     76 /* The matching function.  p is expected to have zero or more
     77    IRExpr_Binds in it, numbered 0, 1, 2 ... Returns True if a match
     78    succeeded. */
     79 
     80 extern
     81 Bool matchIRExpr ( MatchInfo* mi, IRExpr* p/*attern*/, IRExpr* e/*xpr*/ );
     82 
     83 
     84 #endif /* ndef __VEX_IR_MATCH_H */
     85 
     86 
     87 
     88 /*---------------------------------------------------------------*/
     89 /*--- end                                          ir_match.h ---*/
     90 /*---------------------------------------------------------------*/
     91