gcc/analyzer/analysis-plan.h

   1 /* A class to encapsulate decisions about how the analysis should happen.
   2    Copyright (C) 2019-2024 Free Software Foundation, Inc.
   3    Contributed by David Malcolm <dmalcolm@redhat.com>.
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify it
   8 under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 3, or (at your option)
  10 any later version.
  11
  12 GCC is distributed in the hope that it will be useful, but
  13 WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GCC; see the file COPYING3.  If not see
  19 <http://www.gnu.org/licenses/>.  */
  20
  21 #ifndef GCC_ANALYZER_ANALYSIS_PLAN_H
  22 #define GCC_ANALYZER_ANALYSIS_PLAN_H
  23
  24 namespace ana {
  25
  26 /* A class to encapsulate decisions about how the analysis should happen.
  27    Examples:
  28    - the order in which functions should be analyzed, so that function
  29      summaries are created before analysis of call sites that might use
  30      them
  31    - which callgraph edges should use call summaries
  32    TODO: the above is a work-in-progress.  */
  33
  34 class analysis_plan : public log_user
  35 {
  36 public:
  37   analysis_plan (const supergraph &sg, logger *logger);
  38   ~analysis_plan ();
  39
  40   int cmp_function (function *fun_a, function *fun_b) const;
  41
  42   bool use_summary_p (const cgraph_edge *edge) const;
  43
  44 private:
  45   DISABLE_COPY_AND_ASSIGN (analysis_plan);
  46
  47   const supergraph &m_sg;
  48
  49   /* Result of ipa_reverse_postorder.  */
  50   cgraph_node **m_cgraph_node_postorder;
  51   int m_num_cgraph_nodes;
  52
  53   /* Index of each node within the postorder ordering,
  54      accessed via the "m_uid" field.  */
  55   auto_vec<int> m_index_by_uid;
  56 };
  57
  58 } // namespace ana
  59
  60 #endif /* GCC_ANALYZER_ANALYSIS_PLAN_H */