Skip to content

Commit

Permalink
Parser: Support class intervals
Browse files Browse the repository at this point in the history 
Summary:
Support parsing class intervals.

In the analysis, intervals are represented as: LocalTaint -> Kind -> Interval -> Frame

In the json output, it is: LocalTaint -> Frame, where Frame contains the kind and interval. It's not as nice from a "reflect the underlying representation" perspective, but it reduces nesting and improves readability. I'm inclined to stick with the current representation.

In SAPP, a trace_frame is uniquely identified by "caller, callee, caller port, callee port, interval". Therefore, the parser has to do some interval deduplication (see `Kind.partition_by_interval(...)`). A similar deduplication logic already exists for callees in origin frames. This diff adds "intervals" to the mix.

Reviewed By: anwesht

Differential Revision: D51931277

fbshipit-source-id: 75a8629682dc41e5884287e0eb29807e21aad438
  • Loading branch information
@facebook-github-bot
Yuh Shin Ong authored and facebook-github-bot committed Dec 15, 2023
1 parent 876a467 commit a719e8d
Show file tree
Hide file tree
Showing 2 changed files with 469 additions and 65 deletions.
192 changes: 127 additions & 65 deletions sapp/pipeline/mariana_trench_parser.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
import logging
import re
import sys

from collections import defaultdict
from typing import (
Any,
Dict,
Expand Down Expand Up @@ -320,6 +322,8 @@ class Kind(NamedTuple):
distance: int
origins: List[Origin]
extra_traces: List[ExtraTrace]
callee_interval: Optional[Tuple[int, int]]
preserves_type_context: bool

@staticmethod
def from_json(
Expand All @@ -331,13 +335,29 @@ def from_json(
extra_traces = []
for extra_trace in kind.get("extra_traces", []):
extra_traces.append(ExtraTrace.from_json(extra_trace, caller_position))
interval = kind.get("callee_interval")
return Kind(
name=kind["kind"],
distance=kind.get("distance", 0),
origins=origins,
extra_traces=extra_traces,
callee_interval=(interval[0], interval[1]) if interval else None,
preserves_type_context=kind.get("preserves_type_context", False),
)

@staticmethod
def partition_by_interval(
kinds: List["Kind"],
) -> Dict[Optional["ConditionTypeInterval"], List["Kind"]]:
kinds_by_interval = defaultdict(list)
for kind in kinds:
if kind.callee_interval is None:
kinds_by_interval[None].append(kind)
else:
interval = ConditionTypeInterval.from_kind(kind)
kinds_by_interval[interval].append(kind)
return kinds_by_interval


class ConditionLeaf(NamedTuple):
kind: str
Expand Down Expand Up @@ -375,13 +395,37 @@ def from_origin(origin: Origin, call_info: CallInfo) -> "ConditionCall":
)


class ConditionTypeInterval(NamedTuple):
start: int
finish: int
preserves_type_context: bool

@staticmethod
def from_kind(kind: Kind) -> "ConditionTypeInterval":
if kind.callee_interval is None:
raise sapp.ParseError(f"Callee interval expected in {kind}")
return ConditionTypeInterval(
start=kind.callee_interval[0],
finish=kind.callee_interval[1],
preserves_type_context=kind.preserves_type_context,
)

def to_sapp(self) -> sapp.ParseTypeInterval:
return sapp.ParseTypeInterval(
start=self.start,
finish=self.finish,
preserves_type_context=self.preserves_type_context,
)


class Condition(NamedTuple):
caller: ConditionCall
callee: ConditionCall
leaves: List[ConditionLeaf]
local_positions: LocalPositions
features: Features
extra_traces: Set[ExtraTrace]
type_interval: Optional[ConditionTypeInterval]

def convert_to_sapp(
self, kind: Literal[sapp.ParseType.PRECONDITION, sapp.ParseType.POSTCONDITION]
Expand All @@ -394,7 +438,9 @@ def convert_to_sapp(
callee=self.callee.method.name,
callee_port=self.callee.port.value,
callee_location=self.callee.position.to_sapp(),
type_interval=None,
type_interval=(
self.type_interval.to_sapp() if self.type_interval else None
),
features=self.features.to_sapp_as_parsetracefeature(),
titos=self.local_positions.to_sapp(),
leaves=[leaf.to_sapp() for leaf in self.leaves],
Expand Down Expand Up @@ -426,6 +472,7 @@ class IssueCondition(NamedTuple):
local_positions: LocalPositions
features: Features
extra_traces: Set[ExtraTrace]
type_interval: Optional[ConditionTypeInterval]

def to_sapp(self) -> sapp.ParseIssueConditionTuple:
return sapp.ParseIssueConditionTuple(
Expand All @@ -435,7 +482,9 @@ def to_sapp(self) -> sapp.ParseIssueConditionTuple:
leaves=[leaf.to_sapp() for leaf in self.leaves],
titos=self.local_positions.to_sapp(),
features=self.features.to_sapp_as_parsetracefeature(),
type_interval=None,
type_interval=(
self.type_interval.to_sapp() if self.type_interval else None
),
annotations=[extra_trace.to_sapp() for extra_trace in self.extra_traces],
)

Expand Down Expand Up @@ -652,10 +701,12 @@ def _parse_issue_conditions(
condition_taint["call_info"], leaf_kind, callable_position
)

kinds = [
Kind.from_json(kind_json, leaf_kind, callable_position)
for kind_json in condition_taint["kinds"]
]
kinds_by_interval = Kind.partition_by_interval(
[
Kind.from_json(kind_json, leaf_kind, callable_position)
for kind_json in condition_taint["kinds"]
]
)

issue_leaves.update(
{
Expand All @@ -664,6 +715,7 @@ def _parse_issue_conditions(
kind=kind.name,
distance=kind.distance,
)
for _, kinds in kinds_by_interval.items()
for kind in kinds
for origin in kind.origins
}
Expand All @@ -675,32 +727,37 @@ def _parse_issue_conditions(
)

if call_info.is_origin():
for kind in kinds:
condition_leaves = [ConditionLeaf.from_kind(kind)]
for origin in kind.origins:
conditions.append(
IssueCondition(
callee=ConditionCall.from_origin(origin, call_info),
leaves=condition_leaves,
local_positions=local_positions,
features=features,
extra_traces=set(kind.extra_traces),
for interval, kinds in kinds_by_interval.items():
for kind in kinds:
condition_leaves = [ConditionLeaf.from_kind(kind)]
for origin in kind.origins:
conditions.append(
IssueCondition(
callee=ConditionCall.from_origin(origin, call_info),
leaves=condition_leaves,
local_positions=local_positions,
features=features,
extra_traces=set(kind.extra_traces),
type_interval=interval,
)
)
)
else:
condition_leaves = [ConditionLeaf.from_kind(kind) for kind in kinds]
extra_traces = set()
for kind in kinds:
extra_traces.update(kind.extra_traces)
conditions.append(
IssueCondition(
callee=ConditionCall.from_call_info(call_info),
leaves=condition_leaves,
local_positions=local_positions,
features=features,
extra_traces=extra_traces,
for interval, kinds in kinds_by_interval.items():
condition_leaves = []
extra_traces = set()
for kind in kinds:
condition_leaves.append(ConditionLeaf.from_kind(kind))
extra_traces.update(kind.extra_traces)
conditions.append(
IssueCondition(
callee=ConditionCall.from_call_info(call_info),
leaves=condition_leaves,
local_positions=local_positions,
features=features,
extra_traces=extra_traces,
type_interval=interval,
)
)
)

return conditions, issue_leaves

Expand Down Expand Up @@ -783,42 +840,47 @@ def _parse_condition(
local_features = Features.from_taint_json(leaf_taint)

kinds_json = leaf_taint["kinds"]
kinds = [
Kind.from_json(kind_json, leaf_kind, caller_position)
for kind_json in kinds_json
]
kinds_by_interval = Kind.partition_by_interval(
[
Kind.from_json(kind_json, leaf_kind, caller_position)
for kind_json in kinds_json
]
)

if call_info.is_origin():
condition_by_callee = {}
for kind in kinds:
for origin in kind.origins:
callee = ConditionCall.from_origin(origin, call_info)
condition = condition_by_callee.get(
callee,
condition_class(
caller=caller,
callee=callee,
leaves=[],
local_positions=local_positions,
features=local_features,
extra_traces=set(),
),
)
condition.leaves.append(ConditionLeaf.from_kind(kind))
condition.extra_traces.update(kind.extra_traces)
condition_by_callee[callee] = condition
for condition in condition_by_callee.values():
yield condition
for interval, kinds in kinds_by_interval.items():
condition_by_callee = {}
for kind in kinds:
for origin in kind.origins:
callee = ConditionCall.from_origin(origin, call_info)
condition = condition_by_callee.get(
callee,
condition_class(
caller=caller,
callee=callee,
leaves=[],
local_positions=local_positions,
features=local_features,
extra_traces=set(),
type_interval=interval,
),
)
condition.leaves.append(ConditionLeaf.from_kind(kind))
condition.extra_traces.update(kind.extra_traces)
condition_by_callee[callee] = condition
for condition in condition_by_callee.values():
yield condition
else:
extra_traces = set()
for kind in kinds:
extra_traces.update(kind.extra_traces)

yield condition_class(
caller=caller,
callee=ConditionCall.from_call_info(call_info),
leaves=[ConditionLeaf.from_kind(kind) for kind in kinds],
local_positions=local_positions,
features=local_features,
extra_traces=extra_traces,
)
for interval, kinds in kinds_by_interval.items():
extra_traces = set()
for kind in kinds:
extra_traces.update(kind.extra_traces)
yield condition_class(
caller=caller,
callee=ConditionCall.from_call_info(call_info),
leaves=[ConditionLeaf.from_kind(kind) for kind in kinds],
local_positions=local_positions,
features=local_features,
extra_traces=extra_traces,
type_interval=interval,
)
Loading

0 comments on commit a719e8d

Please sign in to comment.