gcc/analyzer/sm-pattern-test.cc

   1 /* A state machine for use in DejaGnu tests, to check that
   2    pattern-matching works as expected.
   3
   4    Copyright (C) 2019-2021 Free Software Foundation, Inc.
   5    Contributed by David Malcolm <dmalcolm@redhat.com>.
   6
   7 This file is part of GCC.
   8
   9 GCC is free software; you can redistribute it and/or modify it
  10 under the terms of the GNU General Public License as published by
  11 the Free Software Foundation; either version 3, or (at your option)
  12 any later version.
  13
  14 GCC is distributed in the hope that it will be useful, but
  15 WITHOUT ANY WARRANTY; without even the implied warranty of
  16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 General Public License for more details.
  18
  19 You should have received a copy of the GNU General Public License
  20 along with GCC; see the file COPYING3.  If not see
  21 <http://www.gnu.org/licenses/>.  */
  22
  23 #include "config.h"
  24 #include "system.h"
  25 #include "coretypes.h"
  26 #include "tree.h"
  27 #include "function.h"
  28 #include "basic-block.h"
  29 #include "gimple.h"
  30 #include "tree-pretty-print.h"
  31 #include "diagnostic-path.h"
  32 #include "diagnostic-metadata.h"
  33 #include "function.h"
  34 #include "json.h"
  35 #include "analyzer/analyzer.h"
  36 #include "diagnostic-event-id.h"
  37 #include "analyzer/analyzer-logging.h"
  38 #include "analyzer/sm.h"
  39 #include "analyzer/pending-diagnostic.h"
  40 #include "tristate.h"
  41 #include "selftest.h"
  42 #include "analyzer/call-string.h"
  43 #include "analyzer/program-point.h"
  44 #include "analyzer/store.h"
  45 #include "analyzer/region-model.h"
  46
  47 #if ENABLE_ANALYZER
  48
  49 namespace ana {
  50
  51 namespace {
  52
  53 /* A state machine for use in DejaGnu tests, to check that
  54    pattern-matching works as expected.  */
  55
  56 class pattern_test_state_machine : public state_machine
  57 {
  58 public:
  59   pattern_test_state_machine (logger *logger);
  60
  61   bool inherited_state_p () const FINAL OVERRIDE { return false; }
  62
  63   bool on_stmt (sm_context *sm_ctxt,
  64                 const supernode *node,
  65                 const gimple *stmt) const FINAL OVERRIDE;
  66
  67   void on_condition (sm_context *sm_ctxt,
  68                      const supernode *node,
  69                      const gimple *stmt,
  70                      const svalue *lhs,
  71                      enum tree_code op,
  72                      const svalue *rhs) const FINAL OVERRIDE;
  73
  74   bool can_purge_p (state_t s) const FINAL OVERRIDE;
  75 };
  76
  77 class pattern_match : public pending_diagnostic_subclass<pattern_match>
  78 {
  79 public:
  80   pattern_match (tree lhs, enum tree_code op, tree rhs)
  81   : m_lhs (lhs), m_op (op), m_rhs (rhs) {}
  82
  83   const char *get_kind () const FINAL OVERRIDE { return "pattern_match"; }
  84
  85   bool operator== (const pattern_match &other) const
  86   {
  87     return (same_tree_p (m_lhs, other.m_lhs)
  88             && m_op == other.m_op
  89             && same_tree_p (m_rhs, other.m_rhs));
  90   }
  91
  92   bool emit (rich_location *rich_loc) FINAL OVERRIDE
  93   {
  94     return warning_at (rich_loc, 0, "pattern match on %<%E %s %E%>",
  95                        m_lhs, op_symbol_code (m_op), m_rhs);
  96   }
  97
  98 private:
  99   tree m_lhs;
 100   enum tree_code m_op;
 101   tree m_rhs;
 102 };
 103
 104 pattern_test_state_machine::pattern_test_state_machine (logger *logger)
 105 : state_machine ("pattern-test", logger)
 106 {
 107 }
 108
 109 bool
 110 pattern_test_state_machine::on_stmt (sm_context *sm_ctxt ATTRIBUTE_UNUSED,
 111                                      const supernode *node ATTRIBUTE_UNUSED,
 112                                      const gimple *stmt ATTRIBUTE_UNUSED) const
 113 {
 114   return false;
 115 }
 116
 117 /* Implementation of state_machine::on_condition vfunc for
 118    pattern_test_state_machine.
 119
 120    Queue a pattern_match diagnostic for any comparison against a
 121    constant.  */
 122
 123 void
 124 pattern_test_state_machine::on_condition (sm_context *sm_ctxt,
 125                                           const supernode *node,
 126                                           const gimple *stmt,
 127                                           const svalue *lhs,
 128                                           enum tree_code op,
 129                                           const svalue *rhs) const
 130 {
 131   if (stmt == NULL)
 132     return;
 133
 134   tree rhs_cst = rhs->maybe_get_constant ();
 135   if (!rhs_cst)
 136     return;
 137
 138   if (tree lhs_expr = sm_ctxt->get_diagnostic_tree (lhs))
 139     {
 140       pending_diagnostic *diag = new pattern_match (lhs_expr, op, rhs_cst);
 141       sm_ctxt->warn (node, stmt, lhs_expr, diag);
 142     }
 143 }
 144
 145 bool
 146 pattern_test_state_machine::can_purge_p (state_t s ATTRIBUTE_UNUSED) const
 147 {
 148   return true;
 149 }
 150
 151 } // anonymous namespace
 152
 153 /* Internal interface to this file. */
 154
 155 state_machine *
 156 make_pattern_test_state_machine (logger *logger)
 157 {
 158   return new pattern_test_state_machine (logger);
 159 }
 160
 161 } // namespace ana
 162
 163 #endif /* #if ENABLE_ANALYZER */