Skip to content

Commit 7ee431f

Browse files
committed
Rust: Model early Err returns in ? expressions
1 parent 12a1fdd commit 7ee431f

5 files changed

Lines changed: 46 additions & 3 deletions

File tree

‎rust/ql/lib/codeql/rust/dataflow/internal/DataFlowImpl.qll‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,8 @@ module LocalFlow {
242242
or
243243
nodeTo.(PostUpdateNode).getPreUpdateNode().asExpr() =
244244
getPostUpdateReverseStep(nodeFrom.(PostUpdateNode).getPreUpdateNode().asExpr(), true)
245+
or
246+
nodeTo.(TryEarlyReturnNode).getTryExpr().getExpr() = nodeFrom.asExpr()
245247
}
246248
}
247249

@@ -483,6 +485,7 @@ module RustDataFlowGen<RustDataFlowInputSig Input> implements InputSig<Location>
483485
node instanceof ImplicitBorrowNode or
484486
node instanceof DerefOutNode or
485487
node instanceof IndexOutNode or
488+
node instanceof TryEarlyReturnNode or
486489
nodeIsHidden(node.(PostUpdateNode).getPreUpdateNode())
487490
}
488491

@@ -930,6 +933,12 @@ module RustDataFlowGen<RustDataFlowInputSig Input> implements InputSig<Location>
930933
*/
931934
predicate expectsContent(Node n, ContentSet cs) {
932935
FlowSummaryImpl::Private::Steps::summaryExpectsContent(n.(FlowSummaryNode).getSummaryNode(), cs)
936+
or
937+
n instanceof TryEarlyReturnNode and
938+
cs.(SingletonContentSet)
939+
.getContent()
940+
.(TupleFieldContent)
941+
.isVariantField(any(ResultEnum r).getErr(), 0)
933942
}
934943

935944
class NodeRegion instanceof Void {

‎rust/ql/lib/codeql/rust/dataflow/internal/Node.qll‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -495,6 +495,25 @@ final class SummaryReturnNode extends FlowSummaryNode, ReturnNode {
495495
override ReturnKind getKind() { result = rk }
496496
}
497497

498+
/**
499+
* A node that represents an `Err` value returned early in a `?` expression.
500+
*/
501+
class TryEarlyReturnNode extends ReturnNode, TTryEarlyReturnNode {
502+
private TryExpr try;
503+
504+
TryEarlyReturnNode() { this = TTryEarlyReturnNode(try) }
505+
506+
TryExpr getTryExpr() { result = try }
507+
508+
final override ReturnKind getKind() { result = TNormalReturnKind() }
509+
510+
final override CfgScope getCfgScope() { result = try.getEnclosingCfgScope() }
511+
512+
final override Location getLocation() { result = try.getLocation() }
513+
514+
final override string toString() { result = try.toString() + " (early return)" }
515+
}
516+
498517
/** A data flow node that represents the output of a call. */
499518
abstract class OutNode extends Node {
500519
/** Gets the underlying call for this node. */
@@ -737,6 +756,7 @@ class StaticNode extends AstNodeNode, TStaticNode {
737756
cached
738757
newtype TNode =
739758
TExprNode(Expr e) { e.hasEnclosingCfgScope() and Stages::DataFlowStage::ref() } or
759+
TTryEarlyReturnNode(TryExpr te) or
740760
TSourceParameterNode(ParamBase p) { p.hasEnclosingCfgScope() } or
741761
TPatNode(Pat p) { p.hasEnclosingCfgScope() } or
742762
TNameNode(Name n) { n = any(Variable v).getName() and n.hasEnclosingCfgScope() } or

‎rust/ql/test/library-tests/dataflow/global/inline-flow.expected‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ models
22
| 1 | Summary: <& as core::ops::deref::Deref>::deref; Argument[self].Reference; ReturnValue; value |
33
| 2 | Summary: <core::ops::arith::Mul>::mul; Argument[self,0]; ReturnValue; taint |
44
| 3 | Summary: <core::result::Result>::unwrap; Argument[self].Field[core::result::Result::Ok(0)]; ReturnValue; value |
5-
| 4 | Summary: futures_executor::local_pool::block_on; Argument[0]; ReturnValue; value |
5+
| 4 | Summary: <core::result::Result>::unwrap_err; Argument[self].Field[core::result::Result::Err(0)]; ReturnValue; value |
6+
| 5 | Summary: futures_executor::local_pool::block_on; Argument[0]; ReturnValue; value |
67
edges
78
| main.rs:12:28:14:1 | { ... } | main.rs:17:13:17:23 | get_data(...) | provenance | |
89
| main.rs:13:5:13:13 | source(...) | main.rs:12:28:14:1 | { ... } | provenance | |
@@ -203,7 +204,7 @@ edges
203204
| main.rs:348:9:348:9 | c | main.rs:350:10:350:16 | await b | provenance | |
204205
| main.rs:354:9:354:9 | a | main.rs:355:10:355:10 | a | provenance | |
205206
| main.rs:354:13:354:55 | ...::block_on(...) | main.rs:354:9:354:9 | a | provenance | |
206-
| main.rs:354:41:354:54 | async_source(...) | main.rs:354:13:354:55 | ...::block_on(...) | provenance | MaD:4 |
207+
| main.rs:354:41:354:54 | async_source(...) | main.rs:354:13:354:55 | ...::block_on(...) | provenance | MaD:5 |
207208
| main.rs:366:44:368:9 | { ... } | main.rs:403:18:403:38 | t.get_double_number() | provenance | |
208209
| main.rs:366:44:368:9 | { ... } | main.rs:407:18:407:50 | ...::get_double_number(...) | provenance | |
209210
| main.rs:367:13:367:29 | self.get_number() | main.rs:367:13:367:33 | ... * ... | provenance | MaD:2 |
@@ -242,7 +243,10 @@ edges
242243
| main.rs:467:54:467:63 | source(...) | main.rs:467:51:467:64 | Ok(...) [Ok] | provenance | |
243244
| main.rs:468:9:468:9 | a [Ok, Ok] | main.rs:468:9:468:10 | TryExpr [Ok] | provenance | |
244245
| main.rs:468:9:468:10 | TryExpr [Ok] | main.rs:466:55:469:5 | { ... } [Ok] | provenance | |
246+
| main.rs:472:19:472:33 | Err(...) [Err] | main.rs:479:14:479:27 | err_returned(...) [Err] | provenance | |
247+
| main.rs:472:23:472:32 | source(...) | main.rs:472:19:472:33 | Err(...) [Err] | provenance | |
245248
| main.rs:478:14:478:39 | unwrapped_value_returned(...) [Ok] | main.rs:478:14:478:48 | ... .unwrap() | provenance | MaD:3 |
249+
| main.rs:479:14:479:27 | err_returned(...) [Err] | main.rs:479:14:479:40 | ... .unwrap_err() | provenance | MaD:4 |
246250
nodes
247251
| main.rs:12:28:14:1 | { ... } | semmle.label | { ... } |
248252
| main.rs:13:5:13:13 | source(...) | semmle.label | source(...) |
@@ -506,8 +510,12 @@ nodes
506510
| main.rs:467:54:467:63 | source(...) | semmle.label | source(...) |
507511
| main.rs:468:9:468:9 | a [Ok, Ok] | semmle.label | a [Ok, Ok] |
508512
| main.rs:468:9:468:10 | TryExpr [Ok] | semmle.label | TryExpr [Ok] |
513+
| main.rs:472:19:472:33 | Err(...) [Err] | semmle.label | Err(...) [Err] |
514+
| main.rs:472:23:472:32 | source(...) | semmle.label | source(...) |
509515
| main.rs:478:14:478:39 | unwrapped_value_returned(...) [Ok] | semmle.label | unwrapped_value_returned(...) [Ok] |
510516
| main.rs:478:14:478:48 | ... .unwrap() | semmle.label | ... .unwrap() |
517+
| main.rs:479:14:479:27 | err_returned(...) [Err] | semmle.label | err_returned(...) [Err] |
518+
| main.rs:479:14:479:40 | ... .unwrap_err() | semmle.label | ... .unwrap_err() |
511519
subpaths
512520
| main.rs:38:16:38:24 | source(...) | main.rs:26:28:26:33 | ...: i64 | main.rs:26:17:26:25 | SelfParam [Return] [&ref, MyStruct] | main.rs:38:5:38:5 | [post] a [MyStruct] |
513521
| main.rs:39:10:39:10 | a [MyStruct] | main.rs:30:17:30:21 | SelfParam [&ref, MyStruct] | main.rs:30:31:32:5 | { ... } | main.rs:39:10:39:21 | a.get_data() |
@@ -576,3 +584,4 @@ testFailures
576584
| main.rs:437:18:437:29 | STATIC_VALUE | main.rs:427:36:427:45 | source(...) | main.rs:437:18:437:29 | STATIC_VALUE | $@ | main.rs:427:36:427:45 | source(...) | source(...) |
577585
| main.rs:437:18:437:29 | STATIC_VALUE | main.rs:436:28:436:37 | source(...) | main.rs:437:18:437:29 | STATIC_VALUE | $@ | main.rs:436:28:436:37 | source(...) | source(...) |
578586
| main.rs:478:14:478:48 | ... .unwrap() | main.rs:467:54:467:63 | source(...) | main.rs:478:14:478:48 | ... .unwrap() | $@ | main.rs:467:54:467:63 | source(...) | source(...) |
587+
| main.rs:479:14:479:40 | ... .unwrap_err() | main.rs:472:23:472:32 | source(...) | main.rs:479:14:479:40 | ... .unwrap_err() | $@ | main.rs:472:23:472:32 | source(...) | source(...) |

‎rust/ql/test/library-tests/dataflow/global/main.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -476,6 +476,6 @@ mod try_operator {
476476
fn test_try_operator() {
477477
sink(unwrapped_value_not_returned().unwrap());
478478
sink(unwrapped_value_returned().unwrap()); // $ hasValueFlow=51
479-
sink(err_returned().unwrap_err()); // $ MISSING: hasValueFlow=52
479+
sink(err_returned().unwrap_err()); // $ hasValueFlow=52
480480
}
481481
}

‎rust/ql/test/library-tests/dataflow/local/DataFlowStep.expected‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,9 @@ localStep
365365
| main.rs:301:9:301:10 | [SSA] i1 | main.rs:302:10:302:11 | i1 |
366366
| main.rs:301:9:301:10 | i1 | main.rs:301:9:301:10 | [SSA] i1 |
367367
| main.rs:301:9:301:10 | i1 | main.rs:301:9:301:10 | i1 |
368+
| main.rs:301:14:301:15 | s1 | main.rs:301:14:301:16 | TryExpr (early return) |
368369
| main.rs:301:14:301:16 | TryExpr | main.rs:301:9:301:10 | i1 |
370+
| main.rs:303:10:303:11 | s2 | main.rs:303:10:303:12 | TryExpr (early return) |
369371
| main.rs:304:5:304:11 | Some(...) | main.rs:298:41:305:1 | { ... } |
370372
| main.rs:308:9:308:10 | [SSA] r1 | main.rs:309:28:309:29 | r1 |
371373
| main.rs:308:9:308:10 | r1 | main.rs:308:9:308:10 | [SSA] r1 |
@@ -410,14 +412,17 @@ localStep
410412
| main.rs:325:9:325:10 | [SSA] i1 | main.rs:327:10:327:11 | i1 |
411413
| main.rs:325:9:325:10 | i1 | main.rs:325:9:325:10 | [SSA] i1 |
412414
| main.rs:325:9:325:10 | i1 | main.rs:325:9:325:10 | i1 |
415+
| main.rs:325:14:325:15 | s1 | main.rs:325:14:325:16 | TryExpr (early return) |
413416
| main.rs:325:14:325:16 | TryExpr | main.rs:325:9:325:10 | i1 |
414417
| main.rs:326:9:326:10 | [SSA] i2 | main.rs:328:10:328:11 | i2 |
415418
| main.rs:326:9:326:10 | i2 | main.rs:326:9:326:10 | [SSA] i2 |
416419
| main.rs:326:9:326:10 | i2 | main.rs:326:9:326:10 | i2 |
420+
| main.rs:326:14:326:15 | s2 | main.rs:326:14:326:16 | TryExpr (early return) |
417421
| main.rs:326:14:326:16 | TryExpr | main.rs:326:9:326:10 | i2 |
418422
| main.rs:329:9:329:10 | [SSA] i3 | main.rs:330:10:330:11 | i3 |
419423
| main.rs:329:9:329:10 | i3 | main.rs:329:9:329:10 | [SSA] i3 |
420424
| main.rs:329:9:329:10 | i3 | main.rs:329:9:329:10 | i3 |
425+
| main.rs:329:14:329:15 | s3 | main.rs:329:14:329:16 | TryExpr (early return) |
421426
| main.rs:329:14:329:16 | TryExpr | main.rs:329:9:329:10 | i3 |
422427
| main.rs:331:5:331:9 | Ok(...) | main.rs:321:46:332:1 | { ... } |
423428
| main.rs:335:9:335:10 | [SSA] s1 | main.rs:336:10:336:11 | s1 |

0 commit comments

Comments
 (0)