Struct paralegal_spdg::ProgramDescription

pub struct ProgramDescription {
    pub controllers: ControllerMap,
    pub type_info: TypeInfoMap,
    pub instruction_info: HashMap<GlobalLocation, InstructionInfo>,
    pub def_info: HashMap<DefId, DefInfo>,
    pub marker_annotation_count: u32,
    pub rustc_time: Duration,
    pub dedup_functions: u32,
    pub dedup_locs: u32,
    pub seen_functions: u32,
    pub seen_locs: u32,
    /* private fields */
}

The annotated program dependence graph.

Fields

controllers: ControllerMap

Entry points we analyzed and their PDGs

type_info: TypeInfoMap

Metadata about types

instruction_info: HashMap<GlobalLocation, InstructionInfo>

Metadata about the instructions that are executed at all program locations we know about.

def_info: HashMap<DefId, DefInfo>

Metadata about the DefIds

marker_annotation_count: u32

How many marker annotations were found

rustc_time: Duration

How long rustc ran before out plugin executed

dedup_functions: u32

The number of functions we produced a PDG for

dedup_locs: u32

The lines of code corresponding to the functions from Self::dedup_functions.

seen_functions: u32

The number of functions we produced PDGs for or we inspected to check for markers.

seen_locs: u32

The lines of code corresponding to the functions from Self::seen_functions. This is the sum of all analyzed_locs of the controllers but deduplicated.

Implementations

impl ProgramDescription

pub fn canonical_write(&self, path: impl AsRef<Path>) -> Result<()>

Write self using the configured serialization format

pub fn canonical_read(path: impl AsRef<Path>) -> Result<Self>

Read self using the configured serialization format

impl ProgramDescription

pub fn all_nodes(&self) -> HashSet<GlobalNode>

Gather all data sources that are mentioned in this program description.

Essentially just self.controllers.flat_map(|c| c.keys())

pub fn all_call_sites(&self) -> HashSet<CallString>

Gather all CallStrings that are mentioned in this program description.

Trait Implementations

impl Debug for ProgramDescription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProgramDescription

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ProgramDescription

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.