diagnostic_event Class Reference

#include <diagnostic-path.h>

Inheritance diagram for diagnostic_event:

Data Structures
struct	meaning

Public Types
enum	verb {   VERB_unknown , VERB_acquire , VERB_release , VERB_enter ,   VERB_exit , VERB_call , VERB_return , VERB_branch ,   VERB_danger }
enum	noun {   NOUN_unknown , NOUN_taint , NOUN_sensitive , NOUN_function ,   NOUN_lock , NOUN_memory , NOUN_resource }
enum	property { PROPERTY_unknown , PROPERTY_true , PROPERTY_false }

Public Member Functions
virtual	~diagnostic_event ()
virtual location_t	get_location () const =0
virtual int	get_stack_depth () const =0
virtual void	print_desc (pretty_printer &pp) const =0
virtual const logical_location *	get_logical_location () const =0
virtual meaning	get_meaning () const =0
virtual bool	connect_to_next_event_p () const =0
virtual diagnostic_thread_id_t	get_thread_id () const =0
virtual void	maybe_add_sarif_properties (sarif_object &) const
label_text	get_desc (pretty_printer &ref_pp) const

Detailed Description

A diagnostic_path is an optional additional piece of metadata associated
with a diagnostic (via its rich_location).

It describes a sequence of events predicted by the compiler that
lead to the problem occurring, with their locations in the user's source,
and text descriptions.

For example, the following error has a 3-event path:

  test.c: In function 'demo':
  test.c:29:5: error: passing NULL as argument 1 to 'PyList_Append' which
    requires a non-NULL parameter
     29 |     PyList_Append(list, item);
        |     ^~~~~~~~~~~~~~~~~~~~~~~~~
    'demo': events 1-3
     25 |   list = PyList_New(0);
        |          ^~~~~~~~~~~~~
        |          |
        |          (1) when 'PyList_New' fails, returning NULL
     26 |
     27 |   for (i = 0; i < count; i++) {
        |   ~~~
        |   |
        |   (2) when 'i < count'
     28 |     item = PyLong_FromLong(random());
     29 |     PyList_Append(list, item);
        |     ~~~~~~~~~~~~~~~~~~~~~~~~~
        |     |
        |     (3) when calling 'PyList_Append', passing NULL from (1) as argument 1

 The diagnostic-printing code has consolidated the path into a single
 run of events, since all the events are near each other and within the same
 function; more complicated examples (such as interprocedural paths)
 might be printed as multiple runs of events.   

Abstract base classes, describing events within a path, and the paths
themselves.   

One event within a diagnostic_path.   

Member Enumeration Documentation

noun

enum diagnostic_event::noun

Enumerator
NOUN_unknown
NOUN_taint
NOUN_sensitive
NOUN_function
NOUN_lock
NOUN_memory
NOUN_resource

property

enum diagnostic_event::property

Enumerator
PROPERTY_unknown
PROPERTY_true
PROPERTY_false

verb

enum diagnostic_event::verb

Enumerator
VERB_unknown
VERB_acquire
VERB_release
VERB_enter
VERB_exit
VERB_call
VERB_return
VERB_branch
VERB_danger

Constructor & Destructor Documentation

~diagnostic_event()

virtual diagnostic_event::~diagnostic_event ( )

inlinevirtual

Member Function Documentation

connect_to_next_event_p()

virtual bool diagnostic_event::connect_to_next_event_p ( ) const

pure virtual

Implemented in ana::checker_event, ana::start_cfg_edge_event, ana::start_consolidated_cfg_edges_event, libgdiagnostics_path_event, and simple_diagnostic_event.

get_desc()

label_text diagnostic_event::get_desc

(

pretty_printer &

ref_pp

)

const

Generate a label_text containing the description of this event
(for debugging/logging purposes).   

References pretty_printer::clone(), pp_formatted_text(), pp_show_color(), and print_desc().

get_location()

virtual location_t diagnostic_event::get_location ( ) const

pure virtual

Implemented in ana::checker_event, libgdiagnostics_path_event, and simple_diagnostic_event.

get_logical_location()

virtual const logical_location * diagnostic_event::get_logical_location ( ) const

pure virtual

Implemented in ana::checker_event, libgdiagnostics_path_event, and simple_diagnostic_event.

get_meaning()

virtual meaning diagnostic_event::get_meaning ( ) const

pure virtual

Implemented in ana::call_event, ana::cfg_edge_event, ana::checker_event, ana::function_entry_event, ana::inlined_call_event, ana::return_event, ana::start_consolidated_cfg_edges_event, ana::state_change_event, ana::warning_event, libgdiagnostics_path_event, and simple_diagnostic_event.

Referenced by sarif_builder::populate_thread_flow_location_object().

get_stack_depth()

virtual int diagnostic_event::get_stack_depth ( ) const

pure virtual

Implemented in ana::checker_event, libgdiagnostics_path_event, and simple_diagnostic_event.

Referenced by diagnostic_path::interprocedural_p(), and sarif_builder::populate_thread_flow_location_object().

get_thread_id()

virtual diagnostic_thread_id_t diagnostic_event::get_thread_id ( ) const

pure virtual

Implemented in ana::checker_event, libgdiagnostics_path_event, and simple_diagnostic_event.

maybe_add_sarif_properties()

virtual void diagnostic_event::maybe_add_sarif_properties ( sarif_object & ) const

inlinevirtual

Reimplemented in ana::checker_event, and ana::superedge_event.

Referenced by sarif_builder::populate_thread_flow_location_object().

print_desc()

virtual void diagnostic_event::print_desc ( pretty_printer & pp ) const

pure virtual

Implemented in ana::call_event, ana::debug_event, ana::end_cfg_edge_event, ana::end_consolidated_cfg_edges_event, ana::function_entry_event, ana::inlined_call_event, ana::precanned_custom_event, ana::region_creation_event_allocation_size, ana::region_creation_event_capacity, ana::region_creation_event_debug, ana::region_creation_event_memory_space, ana::return_event, ana::rewind_from_longjmp_event, ana::rewind_to_setjmp_event, ana::setjmp_event, ana::start_cfg_edge_event, ana::start_consolidated_cfg_edges_event, ana::state_change_event, ana::statement_event, ana::warning_event, libgdiagnostics_path_event, looping_back_event, perpetual_start_cfg_edge_event, and simple_diagnostic_event.

Referenced by get_desc().

---

The documentation for this class was generated from the following files:

• diagnostic-path.h
• diagnostic-path.cc