Skip to content

Commit 698dc3a

Browse files
authored
Merge pull request #22980 from github/hvitved-unified-field-resolution
Unified: use type-inferred field resolution in data flow
2 parents 9a66ef1 + 3a89ca5 commit 698dc3a

6 files changed

Lines changed: 297 additions & 9 deletions

File tree

‎unified/ql/lib/codeql/unified/internal/dataflow/Content.qll‎

Lines changed: 59 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
private import unified
22
private import AllDataFlow
3+
private import codeql.unified.internal.typeinference.TypeInference as T
4+
private import codeql.unified.internal.typeinference.TypeInferencePlugin as TP
35

46
/**
57
* Holds if a MaD access path token of form `name[arg]` exists.
@@ -8,8 +10,20 @@ predicate isAccessPathTokenPresent(string name, string arg) {
810
arg = any(FlowSummaryOutput::Private::AccessPathToken tok).getAnArgument(name)
911
}
1012

13+
private class ResolvedField extends VariableDeclaration {
14+
ResolvedField() { this = T::resolveFieldAccess(_) }
15+
16+
string getName() {
17+
result = super.getName() and
18+
not this = any(TP::TupleType tt).getField(_)
19+
or
20+
this = any(TP::TupleType tt).getField(result)
21+
}
22+
}
23+
1124
private newtype TContent =
1225
TArrayElement() or
26+
TFieldContent(ResolvedField field) or
1327
TNamedMember(string name) {
1428
name = any(Identifier id).getValue()
1529
or
@@ -24,23 +38,35 @@ private newtype TContent =
2438
TCapturedVariable(CaptureSsaInput::CapturedVariable v)
2539

2640
class Content extends TContent {
41+
ResolvedField asField() { this = TFieldContent(result) }
42+
2743
string asNamedMember() { this = TNamedMember(result) }
2844

2945
predicate isArrayElement() { this = TArrayElement() }
3046

3147
string toString() {
3248
result = this.asNamedMember()
3349
or
50+
result = this.asField().getName()
51+
or
3452
this.isArrayElement() and result = "ArrayElement"
3553
or
3654
result = this.asCapturedVariable().toString()
3755
}
3856

3957
LocalVariable asCapturedVariable() { this = TCapturedVariable(result) }
4058

41-
Location getLocation() { result = this.asCapturedVariable().getLocation() }
59+
Location getLocation() {
60+
result = this.asCapturedVariable().getLocation()
61+
or
62+
result = this.asField().getLocation()
63+
}
4264
}
4365

66+
private class TContentApprox = TArrayElement or TNamedMember or TCapturedVariable;
67+
68+
class ContentApprox extends Content, TContentApprox { }
69+
4470
private newtype TContentSet = TSingleton(Content content)
4571

4672
class ContentSet extends TContentSet {
@@ -52,10 +78,41 @@ class ContentSet extends TContentSet {
5278

5379
Content getAStoreContent() { result = this.asSingleton() }
5480

55-
Content getAReadContent() { result = this.asSingleton() }
81+
Content getAReadContent() {
82+
result = this.asSingleton()
83+
or
84+
result.asNamedMember() = this.asSingleton().asField().getName()
85+
or
86+
result.asField().getName() = this.asSingleton().asNamedMember()
87+
}
5688
}
5789

5890
module ContentSet {
91+
/**
92+
* Gets the member name to use for `access`, if any.
93+
*
94+
* Only returns a member name if it cannot be resolved uniquely to a field.
95+
*/
96+
private string getMemberName(Expr access) {
97+
access =
98+
any(MemberAccessExpr mae |
99+
result = mae.getMemberName() and
100+
if exists(T::inferTypeUnique(mae.getBase()))
101+
then not exists(T::resolveFieldAccess(mae))
102+
else any()
103+
)
104+
or
105+
result = access.(UnqualifiedMemberAccess).getMemberName() and
106+
not exists(T::resolveFieldAccess(access))
107+
}
108+
109+
ContentSet member(Expr access) {
110+
result.asSingleton().asField() = T::resolveFieldAccess(access) and
111+
not exists(getMemberName(access))
112+
or
113+
result = namedMember(getMemberName(access))
114+
}
115+
59116
ContentSet namedMember(string name) { result.asSingleton().asNamedMember() = name }
60117

61118
ContentSet arrayElement() { result.asSingleton().isArrayElement() }

‎unified/ql/lib/codeql/unified/internal/dataflow/DataFlowGraph.qll‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,11 @@ predicate step(BuilderNode node1, Step step, BuilderNode node2) {
9292
or
9393
exists(UnqualifiedMemberAccess access | access.isInstanceAccess() |
9494
node1.isLocalVariableRead(access, access.getImplicitQualifierVariable()) and
95-
step.readName(access.getMemberName()) and
95+
step.read(ContentSet::member(access)) and
9696
node2.isResultValue(access)
9797
or
9898
(node1.isIncomingValue(access) or node1.isPostUpdate(access)) and
99-
step.storeName(access.getMemberName()) and
99+
step.store(ContentSet::member(access)) and
100100
node2.isLocalVariablePostUpdate(access, access.getImplicitQualifierVariable())
101101
or
102102
// Pass the receiver along to the getter/setter invoked by this expression
@@ -129,11 +129,11 @@ predicate step(BuilderNode node1, Step step, BuilderNode node2) {
129129
or
130130
exists(MemberAccessExpr expr |
131131
node1.isResultValue(expr.getBase()) and
132-
step.readName(expr.getMemberName()) and
132+
step.read(ContentSet::member(expr)) and
133133
node2.isResultValue(expr)
134134
or
135135
(node1.isIncomingValue(expr) or node1.isPostUpdate(expr)) and
136-
step.storeName(expr.getMemberName()) and
136+
step.store(ContentSet::member(expr)) and
137137
node2.isPostUpdate(expr.getBase())
138138
or
139139
// Pass the receiver along to the getter/setter invoked by this expression

‎unified/ql/lib/codeql/unified/internal/dataflow/DataFlowInstantiation.qll‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,13 @@ module DataFlowInput implements InputSig<Location> {
1515

1616
class ContentSet = D::ContentSet;
1717

18-
class ContentApprox = Content; // TODO
18+
class ContentApprox = D::ContentApprox;
1919

20-
ContentApprox getContentApprox(Content c) { result = c } // TODO
20+
ContentApprox getContentApprox(Content c) {
21+
result = c
22+
or
23+
result.asNamedMember() = c.asField().getName()
24+
}
2125

2226
//
2327
// Parameter, argument, return, and out nodes and their positions/kinds
Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
func source(_ s: String) -> String { return s }
2+
3+
@discardableResult
4+
func sink(_ s: Any) -> String { return "" }
5+
6+
class FieldBox {
7+
var field: String = ""
8+
}
9+
10+
class OtherFieldBox {
11+
var field: String = ""
12+
}
13+
14+
class InheritedFieldBox: FieldBox {}
15+
16+
func resolvedFields() {
17+
let box = FieldBox()
18+
box.field = source("fields.resolved")
19+
sink(box.field) // $ hasValueFlow=fields.resolved
20+
sink((box as! OtherFieldBox).field)
21+
}
22+
23+
func inheritedFields() {
24+
let box = InheritedFieldBox()
25+
box.field = source("fields.inherited")
26+
sink((box as! FieldBox).field) // $ hasValueFlow=fields.inherited
27+
}
28+
29+
func unresolvedFieldRead() {
30+
let box = FieldBox()
31+
box.field = source("fields.unresolved-read")
32+
sink((box as! UnknownFieldBox).field) // $ hasValueFlow=fields.unresolved-read
33+
}
34+
35+
func unresolvedFieldStore() {
36+
let box = FieldBox()
37+
(box as! UnknownFieldBox).field = source("fields.unresolved-store")
38+
sink(box.field) // $ hasValueFlow=fields.unresolved-store
39+
}
40+
41+
func summarizedFieldRead() {
42+
let box = FieldBox()
43+
box.field = source("fields.summary")
44+
sink(TestType.readField(box)) // $ hasValueFlow=fields.summary
45+
}
46+
47+
class BaseBox {
48+
var field: String = ""
49+
}
50+
51+
class OverridingBox: BaseBox {
52+
override var field: String {
53+
get { super.field }
54+
set { super.field = newValue }
55+
}
56+
}
57+
58+
func overriddenFieldRead() {
59+
let base: BaseBox = OverridingBox()
60+
base.field = source("fields.override-read")
61+
let sub = base as! OverridingBox
62+
sink(sub.field) // $ hasValueFlow=fields.override-read
63+
}
64+
65+
protocol FieldProtocol {
66+
var field: String { get set }
67+
}
68+
69+
class ProtocolBox: FieldProtocol {
70+
var field: String = ""
71+
}
72+
73+
class ProtocolBox2: FieldProtocol {
74+
var field: String = ""
75+
}
76+
77+
func protocolFieldRead() {
78+
let box = ProtocolBox()
79+
box.field = source("fields.protocol")
80+
sink(box.field) // $ hasValueFlow=fields.protocol
81+
let p = box as FieldProtocol
82+
sink(p.field) // $ hasValueFlow=fields.protocol
83+
let box2 = box as! ProtocolBox2
84+
sink(box2.field)
85+
let box1or2 = 2 > 3 ? box as FieldProtocol : box2
86+
sink(box1or2.field) // $ hasValueFlow=fields.protocol
87+
}
88+
89+
func protocolFieldWrite() {
90+
let box = ProtocolBox()
91+
var p = box as FieldProtocol
92+
p.field = source("fields.protocol")
93+
sink(p.field) // $ hasValueFlow=fields.protocol
94+
sink(box.field) // $ MISSING: hasValueFlow=fields.protocol (aliasing)
95+
let box2 = p as! OtherFieldBox
96+
sink(box2.field) // $ SPURIOUS: hasValueFlow=fields.protocol
97+
}

0 commit comments

Comments
 (0)