Skip to content

Commit a2a4e82

Browse files
aschackmullaschackmull
committed
C#: Deprecate ControlFlowElement.getAControlFlowNode and remove some splitting quantification.
1 parent 9de02b7 commit a2a4e82

File tree

25 files changed

+69
-79
lines changed

25 files changed

+69
-79
lines changed

‎csharp/ql/campaigns/Solorigate/src/ModifiedFnvFunctionDetection.ql‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ from Variable v, Literal l, LoopStmt loop, Expr additional_xor
1919
where
2020
maybeUsedInFnvFunction(v, _, _, loop) and
2121
exists(BitwiseXorOperation xor2 | xor2.getAnOperand() = l and additional_xor = xor2 |
22-
loopExitNode(loop).getASuccessor*() = xor2.getAControlFlowNode() and
22+
loopExitNode(loop).getASuccessor*() = xor2.getControlFlowNode() and
2323
xor2.getAnOperand() = v.getAnAccess()
2424
)
2525
select l, "This literal is used in an $@ after an FNV-like hash calculation with variable $@.",

‎csharp/ql/lib/experimental/code/csharp/Cryptography/NonCryptographicHashes.qll‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ predicate maybeUsedInFnvFunction(Variable v, Operation xor, Operation mul, LoopS
3030
e2.getAChild*() = v.getAnAccess() and
3131
e1 = xor.getAnOperand() and
3232
e2 = mul.getAnOperand() and
33-
xor.getAControlFlowNode().getASuccessor*() = mul.getAControlFlowNode() and
33+
xor.getControlFlowNode().getASuccessor*() = mul.getControlFlowNode() and
3434
(xor instanceof AssignXorExpr or xor instanceof BitwiseXorExpr) and
3535
(mul instanceof AssignMulExpr or mul instanceof MulExpr)
3636
) and
@@ -55,11 +55,11 @@ private predicate maybeUsedInElfHashFunction(Variable v, Operation xor, Operatio
5555
v = addAssign.getTargetVariable() and
5656
addAssign.getAChild*() = add and
5757
(xor instanceof BitwiseXorExpr or xor instanceof AssignXorExpr) and
58-
addAssign.getAControlFlowNode().getASuccessor*() = xor.getAControlFlowNode() and
58+
addAssign.getControlFlowNode().getASuccessor*() = xor.getControlFlowNode() and
5959
xorAssign.getAChild*() = xor and
6060
v = xorAssign.getTargetVariable() and
6161
(notOp instanceof UnaryBitwiseOperation or notOp instanceof AssignBitwiseOperation) and
62-
xor.getAControlFlowNode().getASuccessor*() = notOp.getAControlFlowNode() and
62+
xor.getControlFlowNode().getASuccessor*() = notOp.getControlFlowNode() and
6363
notAssign.getAChild*() = notOp and
6464
v = notAssign.getTargetVariable() and
6565
loop.getAChild*() = add.getEnclosingStmt() and

‎csharp/ql/lib/semmle/code/csharp/Assignable.qll‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ class AssignableRead extends AssignableAccess {
8686

8787
pragma[noinline]
8888
private ControlFlowNode getAnAdjacentReadSameVar() {
89-
SsaImpl::adjacentReadPairSameVar(_, this.getAControlFlowNode(), result)
89+
SsaImpl::adjacentReadPairSameVar(_, this.getControlFlowNode(), result)
9090
}
9191

9292
/**
@@ -114,11 +114,7 @@ class AssignableRead extends AssignableAccess {
114114
* - The read of `this.Field` on line 11 is next to the read on line 10.
115115
*/
116116
pragma[nomagic]
117-
AssignableRead getANextRead() {
118-
forex(ControlFlowNode cfn | cfn = result.getAControlFlowNode() |
119-
cfn = this.getAnAdjacentReadSameVar()
120-
)
121-
}
117+
AssignableRead getANextRead() { result.getControlFlowNode() = this.getAnAdjacentReadSameVar() }
122118
}
123119

124120
/**
@@ -410,7 +406,7 @@ private import AssignableInternal
410406
*/
411407
class AssignableDefinition extends TAssignableDefinition {
412408
/**
413-
* DEPRECATED: Use `this.getExpr().getAControlFlowNode()` instead.
409+
* DEPRECATED: Use `this.getExpr().getControlFlowNode()` instead.
414410
*
415411
* Gets a control flow node that updates the targeted assignable when
416412
* reached.
@@ -419,7 +415,7 @@ class AssignableDefinition extends TAssignableDefinition {
419415
* the definitions of `x` and `y` in `M(out x, out y)` and `(x, y) = (0, 1)`
420416
* relate to the same call to `M` and assignment node, respectively.
421417
*/
422-
deprecated ControlFlowNode getAControlFlowNode() { result = this.getExpr().getAControlFlowNode() }
418+
deprecated ControlFlowNode getAControlFlowNode() { result = this.getExpr().getControlFlowNode() }
423419

424420
/**
425421
* Gets the underlying expression that updates the targeted assignable when
@@ -492,7 +488,7 @@ class AssignableDefinition extends TAssignableDefinition {
492488
*/
493489
pragma[nomagic]
494490
AssignableRead getAFirstRead() {
495-
forex(ControlFlowNode cfn | cfn = result.getAControlFlowNode() |
491+
exists(ControlFlowNode cfn | cfn = result.getControlFlowNode() |
496492
exists(Ssa::ExplicitDefinition def | result = def.getAFirstReadAtNode(cfn) |
497493
this = def.getADefinition()
498494
)
@@ -572,7 +568,7 @@ module AssignableDefinitions {
572568
/** Holds if a node in basic block `bb` assigns to `ref` parameter `p` via definition `def`. */
573569
private predicate basicBlockRefParamDef(BasicBlock bb, Parameter p, AssignableDefinition def) {
574570
def = any(RefArg arg).getAnAnalyzableRefDef(p) and
575-
bb.getANode() = def.getExpr().getAControlFlowNode()
571+
bb.getANode() = def.getExpr().getControlFlowNode()
576572
}
577573

578574
/**

‎csharp/ql/lib/semmle/code/csharp/controlflow/ControlFlowElement.qll‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,7 @@ class ControlFlowElementOrCallable extends ExprOrStmtParent, TControlFlowElement
1616
* an expression.
1717
*
1818
* A control flow element can be mapped to a control flow node (`ControlFlowNode`)
19-
* via `getAControlFlowNode()`. There is a one-to-many relationship between
20-
* control flow elements and control flow nodes. This allows control flow
21-
* splitting, for example modeling the control flow through `finally` blocks.
19+
* via `getControlFlowNode()`.
2220
*/
2321
class ControlFlowElement extends ControlFlowElementOrCallable, @control_flow_element {
2422
/** Gets the enclosing callable of this element, if any. */
@@ -33,22 +31,26 @@ class ControlFlowElement extends ControlFlowElementOrCallable, @control_flow_ele
3331
}
3432

3533
/**
34+
* DEPRECATED: Use `getControlFlowNode()` instead.
35+
*
3636
* Gets a control flow node for this element. That is, a node in the
3737
* control flow graph that corresponds to this element.
3838
*/
39-
ControlFlowNodes::ElementNode getAControlFlowNode() { result = this.getControlFlowNode() }
39+
deprecated ControlFlowNodes::ElementNode getAControlFlowNode() {
40+
result = this.getControlFlowNode()
41+
}
4042

4143
/** Gets the control flow node for this element, if any. */
4244
ControlFlowNode getControlFlowNode() { result.injects(this) }
4345

4446
/** Gets the basic block in which this element occurs. */
45-
BasicBlock getBasicBlock() { result = this.getAControlFlowNode().getBasicBlock() }
47+
BasicBlock getBasicBlock() { result = this.getControlFlowNode().getBasicBlock() }
4648

4749
/**
4850
* Holds if this element is live, that is this element can be reached
4951
* from the entry point of its enclosing callable.
5052
*/
51-
predicate isLive() { exists(this.getAControlFlowNode()) }
53+
predicate isLive() { exists(this.getControlFlowNode()) }
5254

5355
/** Holds if the current element is reachable from `src`. */
5456
// potentially very large predicate, so must be inlined
@@ -61,13 +63,13 @@ class ControlFlowElement extends ControlFlowElementOrCallable, @control_flow_ele
6163
ControlFlowElement getAReachableElement() {
6264
// Reachable in same basic block
6365
exists(BasicBlock bb, int i, int j |
64-
bb.getNode(i) = this.getAControlFlowNode() and
65-
bb.getNode(j) = result.getAControlFlowNode() and
66+
bb.getNode(i) = this.getControlFlowNode() and
67+
bb.getNode(j) = result.getControlFlowNode() and
6668
i < j
6769
)
6870
or
6971
// Reachable in different basic blocks
70-
this.getAControlFlowNode().getBasicBlock().getASuccessor+().getANode() =
71-
result.getAControlFlowNode()
72+
this.getControlFlowNode().getBasicBlock().getASuccessor+().getANode() =
73+
result.getControlFlowNode()
7274
}
7375
}

‎csharp/ql/lib/semmle/code/csharp/controlflow/Guards.qll‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1073,7 +1073,7 @@ module Internal {
10731073
candidateAux(x, d, bb) and
10741074
y =
10751075
any(AccessOrCallExpr e |
1076-
e.getAControlFlowNode().getBasicBlock() = bb and
1076+
e.getControlFlowNode().getBasicBlock() = bb and
10771077
e.getTarget() = d
10781078
)
10791079
)
@@ -1109,7 +1109,7 @@ module Internal {
11091109
AccessOrCallExpr sub, GuardValue v
11101110
) {
11111111
Stages::GuardsStage::forceCachingInSameStage() and
1112-
guardedCfn = guarded.getAControlFlowNode() and
1112+
guardedCfn = guarded.getControlFlowNode() and
11131113
guardedBB = guardedCfn.getBasicBlock() and
11141114
guardControls(g, guardedBB, v) and
11151115
guardControlsSubSame(g, guardedBB, sub) and
@@ -1152,9 +1152,7 @@ module Internal {
11521152
private predicate isGuardedByExpr0(
11531153
AccessOrCallExpr guarded, Guard g, AccessOrCallExpr sub, GuardValue v
11541154
) {
1155-
forex(ControlFlowNode cfn | cfn = guarded.getAControlFlowNode() |
1156-
nodeIsGuardedBySameSubExpr(cfn, _, guarded, g, sub, v)
1157-
)
1155+
nodeIsGuardedBySameSubExpr(guarded.getControlFlowNode(), _, guarded, g, sub, v)
11581156
}
11591157

11601158
cached

‎csharp/ql/lib/semmle/code/csharp/dataflow/Nullness.qll‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ private predicate defReaches(Ssa::Definition def, ControlFlowNode cfn) {
259259
or
260260
exists(ControlFlowNode mid | defReaches(def, mid) |
261261
SsaImpl::adjacentReadPairSameVar(_, mid, cfn) and
262-
not mid = any(Dereference d | d.isAlwaysNull(def.getSourceVariable())).getAControlFlowNode()
262+
not mid = any(Dereference d | d.isAlwaysNull(def.getSourceVariable())).getControlFlowNode()
263263
)
264264
}
265265

@@ -384,6 +384,6 @@ class Dereference extends G::DereferenceableExpr {
384384
*/
385385
predicate isFirstAlwaysNull(Ssa::SourceVariable v) {
386386
this.isAlwaysNull(v) and
387-
defReaches(v.getAnSsaDefinition(), this.getAControlFlowNode())
387+
defReaches(v.getAnSsaDefinition(), this.getControlFlowNode())
388388
}
389389
}

‎csharp/ql/lib/semmle/code/csharp/dataflow/SSA.qll‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ module Ssa {
308308
*/
309309
final AssignableRead getAFirstReadAtNode(ControlFlowNode cfn) {
310310
SsaImpl::firstReadSameVar(this, cfn) and
311-
result.getAControlFlowNode() = cfn
311+
result.getControlFlowNode() = cfn
312312
}
313313

314314
/**
@@ -371,7 +371,7 @@ module Ssa {
371371
*/
372372
deprecated final AssignableRead getALastReadAtNode(ControlFlowNode cfn) {
373373
SsaImpl::lastReadSameVar(this, cfn) and
374-
result.getAControlFlowNode() = cfn
374+
result.getControlFlowNode() = cfn
375375
}
376376

377377
/**

‎csharp/ql/lib/semmle/code/csharp/dataflow/SignAnalysis.qll‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,27 +11,23 @@ private import semmle.code.csharp.dataflow.internal.rangeanalysis.SignAnalysisCo
1111

1212
/** Holds if `e` can be positive and cannot be negative. */
1313
predicate positiveExpr(Expr e) {
14-
forex(ControlFlowNode cfn | cfn = e.getAControlFlowNode() |
14+
exists(ControlFlowNode cfn | cfn = e.getControlFlowNode() |
1515
positive(cfn) or strictlyPositive(cfn)
1616
)
1717
}
1818

1919
/** Holds if `e` can be negative and cannot be positive. */
2020
predicate negativeExpr(Expr e) {
21-
forex(ControlFlowNode cfn | cfn = e.getAControlFlowNode() |
21+
exists(ControlFlowNode cfn | cfn = e.getControlFlowNode() |
2222
negative(cfn) or strictlyNegative(cfn)
2323
)
2424
}
2525

2626
/** Holds if `e` is strictly positive. */
27-
predicate strictlyPositiveExpr(Expr e) {
28-
forex(ControlFlowNode cfn | cfn = e.getAControlFlowNode() | strictlyPositive(cfn))
29-
}
27+
predicate strictlyPositiveExpr(Expr e) { strictlyPositive(e.getControlFlowNode()) }
3028

3129
/** Holds if `e` is strictly negative. */
32-
predicate strictlyNegativeExpr(Expr e) {
33-
forex(ControlFlowNode cfn | cfn = e.getAControlFlowNode() | strictlyNegative(cfn))
34-
}
30+
predicate strictlyNegativeExpr(Expr e) { strictlyNegative(e.getControlFlowNode()) }
3531

3632
/** Holds if `e` can be positive and cannot be negative. */
3733
predicate positive(ControlFlowNodes::ExprNode e) { Common::positive(e) }

‎csharp/ql/lib/semmle/code/csharp/dataflow/internal/BaseSSA.qll‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ module BaseSsa {
1414
private predicate definitionAt(
1515
AssignableDefinition def, BasicBlock bb, int i, SsaInput::SourceVariable v
1616
) {
17-
bb.getNode(i) = def.getExpr().getAControlFlowNode() and
17+
bb.getNode(i) = def.getExpr().getControlFlowNode() and
1818
v = def.getTarget() and
1919
// In cases like `(x, x) = (0, 1)`, we discard the first (dead) definition of `x`
2020
not exists(TupleAssignmentDefinition first, TupleAssignmentDefinition second | first = def |
@@ -95,7 +95,7 @@ module BaseSsa {
9595

9696
predicate variableRead(BasicBlock bb, int i, SourceVariable v, boolean certain) {
9797
exists(AssignableRead read |
98-
read.getAControlFlowNode() = bb.getNode(i) and
98+
read.getControlFlowNode() = bb.getNode(i) and
9999
read.getTarget() = v and
100100
certain = true
101101
)
@@ -108,7 +108,7 @@ module BaseSsa {
108108
final AssignableRead getARead() {
109109
exists(BasicBlock bb, int i |
110110
SsaImpl::ssaDefReachesRead(_, this, bb, i) and
111-
result.getAControlFlowNode() = bb.getNode(i)
111+
result.getControlFlowNode() = bb.getNode(i)
112112
)
113113
}
114114

‎csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowPrivate.qll‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,10 @@ predicate isArgumentNode(ArgumentNode arg, DataFlowCall c, ArgumentPosition pos)
4444
private ControlFlowNode getAPrimaryConstructorParameterCfn(ParameterAccess pa) {
4545
pa.getTarget().getCallable() instanceof PrimaryConstructor and
4646
(
47-
result = pa.(ParameterRead).getAControlFlowNode()
47+
result = pa.(ParameterRead).getControlFlowNode()
4848
or
4949
pa =
50-
any(AssignableDefinition def | result = def.getExpr().getAControlFlowNode()).getTargetAccess()
50+
any(AssignableDefinition def | result = def.getExpr().getControlFlowNode()).getTargetAccess()
5151
)
5252
}
5353

@@ -339,7 +339,7 @@ module VariableCapture {
339339

340340
VariableWrite() {
341341
def.getTarget() = v.asLocalScopeVariable() and
342-
this = def.getExpr().getAControlFlowNode()
342+
this = def.getExpr().getControlFlowNode()
343343
}
344344

345345
ControlFlowNode getRhs() { LocalFlow::defAssigns(def, this, _, result) }
@@ -552,7 +552,7 @@ module LocalFlow {
552552
) {
553553
def.getSource() = value and
554554
valueCfn = value.getControlFlowNode() and
555-
cfnDef = def.getExpr().getAControlFlowNode()
555+
cfnDef = def.getExpr().getControlFlowNode()
556556
}
557557

558558
private predicate defAssigns(ExprNode value, AssignableDefinitionNode defNode) {
@@ -1012,7 +1012,7 @@ private module Cached {
10121012
TExprNode(ControlFlowNodes::ElementNode cfn) { exists(cfn.asExpr()) } or
10131013
TSsaNode(SsaImpl::DataFlowIntegration::SsaNode node) or
10141014
TAssignableDefinitionNode(AssignableDefinition def, ControlFlowNode cfn) {
1015-
cfn = def.getExpr().getAControlFlowNode()
1015+
cfn = def.getExpr().getControlFlowNode()
10161016
} or
10171017
TExplicitParameterNode(Parameter p, DataFlowCallable c) {
10181018
p = c.asCallable(_).(CallableUsedInSource).getAParameter()
@@ -1055,7 +1055,7 @@ private module Cached {
10551055
// needed for reverse stores; e.g. `x.f1.f2 = y` induces
10561056
// a store step of `f1` into `x`
10571057
exists(TExprPostUpdateNode upd, Expr read |
1058-
upd = TExprPostUpdateNode(read.getAControlFlowNode())
1058+
upd = TExprPostUpdateNode(read.getControlFlowNode())
10591059
|
10601060
fieldOrPropertyRead(e, _, read)
10611061
or
@@ -1071,7 +1071,7 @@ private module Cached {
10711071
sn.getSummarizedCallable() instanceof CallableUsedInSource
10721072
} or
10731073
TParamsArgumentNode(ControlFlowNode callCfn) {
1074-
callCfn = any(Call c | isParamsArg(c, _, _)).getAControlFlowNode()
1074+
callCfn = any(Call c | isParamsArg(c, _, _)).getControlFlowNode()
10751075
} or
10761076
TFlowInsensitiveFieldNode(FieldOrPropertyUsedInSource f) { f.isFieldLike() } or
10771077
TFlowInsensitiveCapturedVariableNode(LocalScopeVariable v) { v.isCaptured() } or
@@ -1533,7 +1533,7 @@ private module ArgumentNodes {
15331533
ParamsArgumentNode() { this = TParamsArgumentNode(callCfn) }
15341534

15351535
private Parameter getParameter() {
1536-
callCfn = any(Call c | isParamsArg(c, _, result)).getAControlFlowNode()
1536+
callCfn = any(Call c | isParamsArg(c, _, result)).getControlFlowNode()
15371537
}
15381538

15391539
override predicate argumentOf(DataFlowCall call, ArgumentPosition pos) {
@@ -1619,7 +1619,7 @@ private module ReturnNodes {
16191619
private ControlFlowNodes::ElementNode cfn;
16201620
private YieldReturnStmt yrs;
16211621

1622-
YieldReturnNode() { this = TYieldReturnNode(cfn) and yrs.getExpr().getAControlFlowNode() = cfn }
1622+
YieldReturnNode() { this = TYieldReturnNode(cfn) and yrs.getExpr().getControlFlowNode() = cfn }
16231623

16241624
YieldReturnStmt getYieldReturnStmt() { result = yrs }
16251625

@@ -2534,7 +2534,7 @@ module PostUpdateNodes {
25342534
class ObjectCreationNode extends SourcePostUpdateNode, ExprNode, TExprNode {
25352535
private ObjectCreation oc;
25362536

2537-
ObjectCreationNode() { this = TExprNode(oc.getAControlFlowNode()) }
2537+
ObjectCreationNode() { this = TExprNode(oc.getControlFlowNode()) }
25382538

25392539
override Node getPreUpdateSourceNode() {
25402540
exists(ControlFlowNodes::ElementNode cfn | this = TExprNode(cfn) |
@@ -2561,7 +2561,7 @@ module PostUpdateNodes {
25612561

25622562
ObjectInitializerNode() {
25632563
this = TObjectInitializerNode(cfn) and
2564-
cfn = oc.getAControlFlowNode()
2564+
cfn = oc.getControlFlowNode()
25652565
}
25662566

25672567
/** Gets the initializer to which this initializer node belongs. */

0 commit comments

Comments
 (0)