GCC Middle and Back End API Reference
ana::symbolic::symbolic_bit_overlay Class Reference

#include <symbolic-bit-contents.h>

Inheritance diagram for ana::symbolic::symbolic_bit_overlay:
Collaboration diagram for ana::symbolic::symbolic_bit_overlay:

Data Structures

struct  key

Public Types

enum class  kind {
  uninit , untracked , zero , baseline ,
  conjured , named_test , concrete_overlay , symbolic_overlay ,
  offset
}
using id_t = unsigned

Public Member Functions

const symbolic_bit_overlay * dyn_cast_symbolic_bit_overlay () const final override
 symbolic_bit_overlay (const key &k)
enum kind get_kind () const final override
size_t size () const
const bit_vector & get_bits (const symbolic_bit_range &bit_range) const final override
void print_dump_widget_label (pretty_printer *pp) const final override
void add_dump_widget_children (text_art::tree_widget &, node_dump_state &nds) const final override
void accept_node_visitor (node_visitor &v) const final override
std::unique_ptr< json::object > to_json () const final override
std::unique_ptr< diagnostics::markup::node > make_markup_node (markup_context &markup_ctxt) const final override
string_scan scan_for_first_zero_byte (string_scan::byte_offset_type start_byte_offset) const final override
void get_representative_path_vars (const region_model *model, value_set *visited, const region *base_reg, const svalue *sval, tree desired_type, logger *logger, auto_vec< path_var > *out_pvs) const final override
const bit_contents & poison_any_pointers_to_descendents (const region *reg, enum poison_kind pkind) const final override
const bit_contents & purge_state_involving (const symbolic::node &node) const final override
bool bits_live_p (const bit_vector_from_ubc &bv_from_ubc) const final override
iter_result for_each_value (iter_result(*cb)(const symbolic::value_node &val, void *user_data), void *user_data) const final override
const bit_contents & get_baseline () const
node_manager & get_node_mgr () const
bit_contents_manager & get_bit_contents_manager () const
bit_vector_manager & get_bit_vector_manager () const
virtual const uniform_bit_contents * dyn_cast_uniform_bit_contents () const
virtual const baseline_bit_contents * dyn_cast_baseline_bit_contents () const
virtual const conjured_bit_contents * dyn_cast_conjured_bit_contents () const
virtual const concrete_bit_overlay * dyn_cast_concrete_bit_overlay () const
virtual const offset_bit_contents * dyn_cast_offset_bit_contents () const
const char * get_any_dump_color () const override
const bit_vector & get_bits (const concrete_bit_range &bit_range) const
const bit_vector & get_bytes (const concrete_byte_range &byte_range) const
const bit_vector & get_bytes (const symbolic_byte_range &byte_range) const
const bit_vector & get_byte (integer_with_unit< units::byte > byte_offset) const
const bit_contents & set_bits (const symbolic_bit_range &bit_range, const bit_vector &bv, uncertainty_t *uncertainty) const
const bit_contents & set_bits (const concrete_bit_range &bit_range, const bit_vector &bv, uncertainty_t *uncertainty) const
const bit_contents & set_bytes (const symbolic_byte_range &byte_range, const bit_vector &bv, uncertainty_t *uncertainty) const
const bit_contents & set_bytes (const concrete_byte_range &byte_range, const bit_vector &bv, uncertainty_t *uncertainty) const
const bit_contents & set_byte (integer_with_unit< units::byte > byte_offset, uint8_t value, uncertainty_t *uncertainty) const
virtual const bit_contents * maybe_fold_offset (const symbolic_bit_offset &) const
virtual bool conjured_p () const
value_set get_maybe_live_values () const
const complexity & get_complexity () const
id_t get_id () const
void dump_to_pp (pretty_printer *pp, bool show_ids=true, bool elide_repeated_nodes=true) const
void dump_to_logger (logger &) const
void dump () const
std::unique_ptr< text_art::tree_widget > make_dump_widget (node_dump_state &nds, const char *prefix=nullptr) const
bool involves_p (const symbolic::node &other) const
void start_any_dump_color (pretty_printer *pp) const
void end_any_dump_color (pretty_printer *pp) const
text_art::style get_text_art_tree_style () const

Static Public Member Functions

static const bit_contents * can_merge_p (const bit_contents &bit_contents_a, const bit_contents &bit_contents_b, tree type, model_merger *merger)
static int cmp_ids (const symbolic::node *s1, const symbolic::node *s2)
static int cmp (const symbolic::node &s1, const symbolic::node &s2)
static int cmp_ptr_ptr (const void *, const void *)

Data Fields

std::map< symbolic_bit_range, const bit_vector & > m_symbolic_range_map

Protected Member Functions

std::unique_ptr< json::object > make_json_obj (const char *type_name) const

Private Attributes

const bit_contents & m_baseline
node_manager & m_node_mgr
complexity m_complexity
id_t m_id

Detailed Description

A sparse mapping from symbolic bit ranges to symbolic bit vectors,
overlaid on an underlying baseline bit_contents.

Has no size; bounds-checking must happen at a higher level.

Consolidation/canonicalization:
- must have exactly one entry in the map (attempts to create more than
  one symbolic key ought to be folded into the baseline)
  TODO(can probably use this to greatly simplify this implementation,
  and possibly merge it with concrete_bit_overlay).
- no nesting of overlays: the baseline must not itself be a bit_overlay.
- bit ranges in the map are not allowed to have "unknown" start offset
  TODO(design): are they allowed to have "unknown" size?
- bit ranges in the map are not allowed to be fully concrete
- no redundant bindings: the bit_vector bound to RANGE must not equal
  BASELINE.get_bits(RANGE).
- the size of each bit_vector must match that of the bit
  range it is bound to (this size may be either concrete or symbolic).   

Member Typedef Documentation

◆ id_t

using ana::symbolic::node::id_t = unsigned
inherited

Member Enumeration Documentation

◆ kind

enum class ana::symbolic::bit_contents::kind
stronginherited
Enumerator
uninit 
untracked 
zero 
baseline 
conjured 
named_test 
concrete_overlay 
symbolic_overlay 
offset 

Constructor & Destructor Documentation

◆ symbolic_bit_overlay()

ana::symbolic::symbolic_bit_overlay::symbolic_bit_overlay ( const key & k)

Member Function Documentation

◆ accept_node_visitor()

void ana::symbolic::symbolic_bit_overlay::accept_node_visitor ( node_visitor & v) const
finaloverridevirtual

Implements ana::symbolic::node.

◆ add_dump_widget_children()

void ana::symbolic::symbolic_bit_overlay::add_dump_widget_children ( text_art::tree_widget & ,
node_dump_state & nds ) const
finaloverridevirtual

Implements ana::symbolic::node.

◆ bits_live_p()

bool ana::symbolic::symbolic_bit_overlay::bits_live_p ( const bit_vector_from_ubc & bv_from_ubc) const
finaloverridevirtual

Implements ana::symbolic::bit_contents.

References bits_live_p(), and final().

Referenced by bits_live_p().

◆ can_merge_p()

const bit_contents * ana::symbolic::bit_contents::can_merge_p ( const bit_contents & bit_contents_a,
const bit_contents & bit_contents_b,
tree type,
model_merger * merger )
staticinherited

References bit_contents().

◆ cmp()

int ana::symbolic::node::cmp ( const symbolic::node & s1,
const symbolic::node & s2 )
inlinestaticinherited

References get_id().

◆ cmp_ids()

int ana::symbolic::node::cmp_ids ( const symbolic::node * s1,
const symbolic::node * s2 )
staticinherited

◆ cmp_ptr_ptr()

int ana::symbolic::node::cmp_ptr_ptr ( const void * ,
const void *  )
staticinherited

◆ conjured_p()

virtual bool ana::symbolic::bit_contents::conjured_p ( ) const
inlinevirtualinherited

◆ dump()

void ana::symbolic::node::dump ( ) const
inherited

◆ dump_to_logger()

void ana::symbolic::node::dump_to_logger ( logger & ) const
inherited

◆ dump_to_pp()

void ana::symbolic::node::dump_to_pp ( pretty_printer * pp,
bool show_ids = true,
bool elide_repeated_nodes = true ) const
inherited

◆ dyn_cast_baseline_bit_contents()

virtual const baseline_bit_contents * ana::symbolic::bit_contents::dyn_cast_baseline_bit_contents ( ) const
inlinevirtualinherited

◆ dyn_cast_concrete_bit_overlay()

virtual const concrete_bit_overlay * ana::symbolic::bit_contents::dyn_cast_concrete_bit_overlay ( ) const
inlinevirtualinherited

◆ dyn_cast_conjured_bit_contents()

virtual const conjured_bit_contents * ana::symbolic::bit_contents::dyn_cast_conjured_bit_contents ( ) const
inlinevirtualinherited

◆ dyn_cast_offset_bit_contents()

virtual const offset_bit_contents * ana::symbolic::bit_contents::dyn_cast_offset_bit_contents ( ) const
inlinevirtualinherited

◆ dyn_cast_symbolic_bit_overlay()

const symbolic_bit_overlay * ana::symbolic::symbolic_bit_overlay::dyn_cast_symbolic_bit_overlay ( ) const
inlinefinaloverridevirtual

Reimplemented from ana::symbolic::bit_contents.

References final().

◆ dyn_cast_uniform_bit_contents()

virtual const uniform_bit_contents * ana::symbolic::bit_contents::dyn_cast_uniform_bit_contents ( ) const
inlinevirtualinherited

◆ end_any_dump_color()

void ana::symbolic::node::end_any_dump_color ( pretty_printer * pp) const
inherited

◆ for_each_value()

iter_result ana::symbolic::symbolic_bit_overlay::for_each_value ( iter_result(* cb )(const symbolic::value_node &val, void *user_data),
void * user_data ) const
finaloverridevirtual

Implements ana::symbolic::bit_contents.

References final(), and for_each_value().

Referenced by for_each_value().

◆ get_any_dump_color()

const char * ana::symbolic::bit_contents::get_any_dump_color ( ) const
inlineoverridevirtualinherited

Reimplemented from ana::symbolic::node.

◆ get_baseline()

const bit_contents & ana::symbolic::bit_overlay::get_baseline ( ) const
inlineinherited

References m_baseline.

◆ get_bit_contents_manager()

bit_contents_manager & ana::symbolic::bit_contents::get_bit_contents_manager ( ) const
inlineinherited

◆ get_bit_vector_manager()

bit_vector_manager & ana::symbolic::bit_contents::get_bit_vector_manager ( ) const
inlineinherited

◆ get_bits() [1/2]

const bit_vector & ana::symbolic::bit_contents::get_bits ( const concrete_bit_range & bit_range) const
inherited

◆ get_bits() [2/2]

const bit_vector & ana::symbolic::symbolic_bit_overlay::get_bits ( const symbolic_bit_range & bit_range) const
finaloverridevirtual

◆ get_byte()

const bit_vector & ana::symbolic::bit_contents::get_byte ( integer_with_unit< units::byte > byte_offset) const
inlineinherited

References get_bytes().

◆ get_bytes() [1/2]

const bit_vector & ana::symbolic::bit_contents::get_bytes ( const concrete_byte_range & byte_range) const
inherited

Referenced by get_byte().

◆ get_bytes() [2/2]

const bit_vector & ana::symbolic::bit_contents::get_bytes ( const symbolic_byte_range & byte_range) const
inherited

◆ get_complexity()

const complexity & ana::symbolic::node::get_complexity ( ) const
inlineinherited

◆ get_id()

id_t ana::symbolic::node::get_id ( ) const
inlineinherited

References m_id.

Referenced by cmp().

◆ get_kind()

enum kind ana::symbolic::symbolic_bit_overlay::get_kind ( ) const
inlinefinaloverridevirtual

◆ get_maybe_live_values()

value_set ana::symbolic::bit_contents::get_maybe_live_values ( ) const
inherited

◆ get_node_mgr()

node_manager & ana::symbolic::bit_contents::get_node_mgr ( ) const
inlineinherited

◆ get_representative_path_vars()

void ana::symbolic::symbolic_bit_overlay::get_representative_path_vars ( const region_model * model,
value_set * visited,
const region * base_reg,
const svalue * sval,
tree desired_type,
logger * logger,
auto_vec< path_var > * out_pvs ) const
finaloverridevirtual

◆ get_text_art_tree_style()

text_art::style ana::symbolic::node::get_text_art_tree_style ( ) const
inherited

◆ involves_p()

bool ana::symbolic::node::involves_p ( const symbolic::node & other) const
inherited

◆ make_dump_widget()

std::unique_ptr< text_art::tree_widget > ana::symbolic::node::make_dump_widget ( node_dump_state & nds,
const char * prefix = nullptr ) const
inherited

◆ make_json_obj()

std::unique_ptr< json::object > ana::symbolic::node::make_json_obj ( const char * type_name) const
protectedinherited

◆ make_markup_node()

std::unique_ptr< diagnostics::markup::node > ana::symbolic::symbolic_bit_overlay::make_markup_node ( markup_context & markup_ctxt) const
finaloverridevirtual

Implements ana::symbolic::node.

References final(), and make_markup_node().

Referenced by make_markup_node().

◆ maybe_fold_offset()

virtual const bit_contents * ana::symbolic::bit_contents::maybe_fold_offset ( const symbolic_bit_offset & ) const
inlinevirtualinherited

◆ poison_any_pointers_to_descendents()

const bit_contents & ana::symbolic::symbolic_bit_overlay::poison_any_pointers_to_descendents ( const region * reg,
enum poison_kind pkind ) const
finaloverridevirtual

◆ print_dump_widget_label()

void ana::symbolic::symbolic_bit_overlay::print_dump_widget_label ( pretty_printer * pp) const
finaloverridevirtual

Implements ana::symbolic::node.

◆ purge_state_involving()

const bit_contents & ana::symbolic::symbolic_bit_overlay::purge_state_involving ( const symbolic::node & node) const
finaloverridevirtual

◆ scan_for_first_zero_byte()

string_scan ana::symbolic::symbolic_bit_overlay::scan_for_first_zero_byte ( string_scan::byte_offset_type start_byte_offset) const
finaloverridevirtual

◆ set_bits() [1/2]

const bit_contents & ana::symbolic::bit_contents::set_bits ( const concrete_bit_range & bit_range,
const bit_vector & bv,
uncertainty_t * uncertainty ) const
inherited

References bit_contents().

◆ set_bits() [2/2]

const bit_contents & ana::symbolic::bit_contents::set_bits ( const symbolic_bit_range & bit_range,
const bit_vector & bv,
uncertainty_t * uncertainty ) const
inherited

References bit_contents().

◆ set_byte()

const bit_contents & ana::symbolic::bit_contents::set_byte ( integer_with_unit< units::byte > byte_offset,
uint8_t value,
uncertainty_t * uncertainty ) const
inherited

◆ set_bytes() [1/2]

const bit_contents & ana::symbolic::bit_contents::set_bytes ( const concrete_byte_range & byte_range,
const bit_vector & bv,
uncertainty_t * uncertainty ) const
inherited

References bit_contents().

◆ set_bytes() [2/2]

const bit_contents & ana::symbolic::bit_contents::set_bytes ( const symbolic_byte_range & byte_range,
const bit_vector & bv,
uncertainty_t * uncertainty ) const
inherited

References bit_contents().

◆ size()

size_t ana::symbolic::symbolic_bit_overlay::size ( ) const
inline

References m_symbolic_range_map.

◆ start_any_dump_color()

void ana::symbolic::node::start_any_dump_color ( pretty_printer * pp) const
inherited

◆ to_json()

std::unique_ptr< json::object > ana::symbolic::symbolic_bit_overlay::to_json ( ) const
finaloverridevirtual

Implements ana::symbolic::node.

References final().

Field Documentation

◆ m_baseline

const bit_contents& ana::symbolic::bit_overlay::m_baseline
privateinherited

Referenced by bit_overlay(), and get_baseline().

◆ m_complexity

complexity ana::symbolic::node::m_complexity
privateinherited

Referenced by get_complexity(), and node().

◆ m_id

id_t ana::symbolic::node::m_id
privateinherited

Referenced by get_id(), and node().

◆ m_node_mgr

node_manager& ana::symbolic::bit_contents::m_node_mgr
privateinherited

◆ m_symbolic_range_map

std::map<symbolic_bit_range, const bit_vector &> ana::symbolic::symbolic_bit_overlay::m_symbolic_range_map

Referenced by size().


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