analyzer: support "bifurcation"; reimplement realloc [PR99260]

[thirdparty/gcc.git] / gcc / analyzer / call-info.h

diff --git a/gcc/analyzer/call-info.h b/gcc/analyzer/call-info.h
new file mode 100644 (file)
index 0000000..369d217
--- /dev/null
+++ b/gcc/analyzer/call-info.h
@@ -0,0 +1,83 @@
+/* Subclasses of custom_edge_info for describing outcomes of function calls.
+   Copyright (C) 2021 Free Software Foundation, Inc.
+   Contributed by David Malcolm <dmalcolm@redhat.com>.
+
+This file is part of GCC.
+
+GCC is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3, or (at your option)
+any later version.
+
+GCC is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with GCC; see the file COPYING3.  If not see
+<http://www.gnu.org/licenses/>.  */
+
+#ifndef GCC_ANALYZER_CALL_INFO_H
+#define GCC_ANALYZER_CALL_INFO_H
+
+namespace ana {
+
+/* Subclass of custom_edge_info for an outcome of a call.
+   This is still abstract; the update_model and get_desc vfuncs must be
+   implemented.  */
+
+class call_info : public custom_edge_info
+{
+public:
+  void print (pretty_printer *pp) const FINAL OVERRIDE;
+  void add_events_to_path (checker_path *emission_path,
+                          const exploded_edge &eedge) const FINAL OVERRIDE;
+
+  const gcall *get_call_stmt () const { return m_call_stmt; }
+  tree get_fndecl () const { return m_fndecl; }
+
+  virtual label_text get_desc (bool can_colorize) const = 0;
+
+  call_details get_call_details (region_model *model,
+                                region_model_context *ctxt) const;
+
+protected:
+  call_info (const call_details &cd);
+
+private:
+  const gcall *m_call_stmt;
+  tree m_fndecl;
+};
+
+/* Subclass of call_info for a "success" outcome of a call,
+   adding a "when `FNDECL' succeeds" message.
+   This is still abstract: the custom_edge_info::update_model vfunc
+   must be implemented.  */
+
+class success_call_info : public call_info
+{
+public:
+  label_text get_desc (bool can_colorize) const FINAL OVERRIDE;
+
+protected:
+  success_call_info (const call_details &cd) : call_info (cd) {}
+};
+
+/* Subclass of call_info for a "failure" outcome of a call,
+   adding a "when `FNDECL' fails" message.
+   This is still abstract: the custom_edge_info::update_model vfunc
+   must be implemented.  */
+
+class failed_call_info : public call_info
+{
+public:
+  label_text get_desc (bool can_colorize) const FINAL OVERRIDE;
+
+protected:
+  failed_call_info (const call_details &cd) : call_info (cd) {}
+};
+
+} // namespace ana
+
+#endif /* GCC_ANALYZER_CALL_INFO_H */