Line data    Source code

       1              : /* Subclasses of custom_edge_info for describing outcomes of function calls.
       2              :    Copyright (C) 2021-2026 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_CALL_INFO_H
      22              : #define GCC_ANALYZER_CALL_INFO_H
      23              : 
      24              : namespace ana {
      25              : 
      26              : /* Subclass of custom_edge_info for an outcome of a call.
      27              :    This is still abstract; the update_model and print_desc vfuncs must be
      28              :    implemented.  */
      29              : 
      30            0 : class call_info : public custom_edge_info
      31              : {
      32              : public:
      33              :   void print (pretty_printer *pp) const override;
      34              :   void add_events_to_path (checker_path *emission_path,
      35              :                            const exploded_edge &eedge,
      36              :                            pending_diagnostic &pd,
      37              :                            const state_transition *state_trans) const override;
      38              : 
      39          433 :   const gcall &get_call_stmt () const { return m_call_stmt; }
      40          649 :   tree get_fndecl () const { return m_fndecl; }
      41              : 
      42              :   virtual void print_desc (pretty_printer &pp) const = 0;
      43              : 
      44              :   call_details get_call_details (region_model *model,
      45              :                                  region_model_context *ctxt) const;
      46              : 
      47              : protected:
      48              :   call_info (const call_details &cd);
      49              :   call_info (const call_details &cd, const function &called_fn);
      50              : 
      51              : private:
      52              :   const gcall &m_call_stmt;
      53              :   tree m_fndecl;
      54              : };
      55              : 
      56              : /* Subclass of call_info for a "success" outcome of a call,
      57              :    adding either a
      58              :      "when `FNDECL' succeeds" message (when 'success' is true)
      59              :    or a
      60              :      "when `FNDECL' fails" message    (when 'success' is false).
      61              :    This is still abstract: the custom_edge_info::update_model vfunc
      62              :    must be implemented.  */
      63              : 
      64            0 : class succeed_or_fail_call_info : public call_info
      65              : {
      66              : public:
      67              :   void print_desc (pretty_printer &pp) const final override;
      68              : 
      69              : protected:
      70         1346 :   succeed_or_fail_call_info (const call_details &cd, bool success)
      71         1808 :    : call_info (cd), m_success (success) {}
      72              : 
      73              :   bool m_success;
      74              : };
      75              : 
      76              : /* Subclass of call_info for a "success" outcome of a call,
      77              :    adding a "when `FNDECL' succeeds" message.
      78              :    This is still abstract: the custom_edge_info::update_model vfunc
      79              :    must be implemented.  */
      80              : 
      81              : class success_call_info : public succeed_or_fail_call_info
      82              : {
      83              : protected:
      84           77 :   success_call_info (const call_details &cd)
      85           77 :   : succeed_or_fail_call_info (cd, true)
      86              :   {}
      87              : };
      88              : 
      89              : /* Subclass of call_info for a "failure" outcome of a call,
      90              :    adding a "when `FNDECL' fails" message.
      91              :    This is still abstract: the custom_edge_info::update_model vfunc
      92              :    must be implemented.  */
      93              : 
      94            0 : class failed_call_info : public succeed_or_fail_call_info
      95              : {
      96              : protected:
      97          421 :   failed_call_info (const call_details &cd)
      98          421 :   : succeed_or_fail_call_info (cd, false)
      99              :   {}
     100              : };
     101              : 
     102              : } // namespace ana
     103              : 
     104              : #endif /* GCC_ANALYZER_CALL_INFO_H */