C++: Deprecate DataFlow::definitionByReferenceNode

jbj · jbj · commit 36373fce9bb1 · 2020-08-13T15:27:35.000+02:00
This predicate name was only used in IR data flow, not in AST data flow.
diff --git a/cpp/ql/src/semmle/code/cpp/ir/dataflow/DefaultTaintTracking.qll b/cpp/ql/src/semmle/code/cpp/ir/dataflow/DefaultTaintTracking.qll
@@ -70,7 +70,7 @@ private DataFlow::Node getNodeForSource(Expr source) {
     //
     // This case goes together with the similar (but not identical) rule in
     // `nodeIsBarrierIn`.
-    result = DataFlow::definitionByReferenceNode(source) and
+    result = DataFlow::definitionByReferenceNodeFromArgument(source) and
     not argv(source.(VariableAccess).getTarget())
   )
 }
@@ -210,7 +210,7 @@ private predicate nodeIsBarrierIn(DataFlow::Node node) {
     or
     // This case goes together with the similar (but not identical) rule in
     // `getNodeForSource`.
-    node = DataFlow::definitionByReferenceNode(source)
+    node = DataFlow::definitionByReferenceNodeFromArgument(source)
   )
 }
 
diff --git a/cpp/ql/src/semmle/code/cpp/ir/dataflow/internal/DataFlowUtil.qll b/cpp/ql/src/semmle/code/cpp/ir/dataflow/internal/DataFlowUtil.qll
@@ -473,10 +473,12 @@ class VariableNode extends Node, TVariableNode {
 InstructionNode instructionNode(Instruction instr) { result.getInstruction() = instr }
 
 /**
+ * DEPRECATED: use `definitionByReferenceNodeFromArgument` instead.
+ *
  * Gets the `Node` corresponding to a definition by reference of the variable
  * that is passed as `argument` of a call.
  */
-DefinitionByReferenceNode definitionByReferenceNode(Expr e) { result.getArgument() = e }
+deprecated DefinitionByReferenceNode definitionByReferenceNode(Expr e) { result.getArgument() = e }
 
 /**
  * Gets the `Node` corresponding to the value of evaluating `e` or any of its

Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ private DataFlow::Node getNodeForSource(Expr source) {`
`70`	`70`	`//`
`71`	`71`	`// This case goes together with the similar (but not identical) rule in`
`72`	`72`	// `nodeIsBarrierIn`.
`73`		`- result = DataFlow::definitionByReferenceNode(source) and`
	`73`	`+ result = DataFlow::definitionByReferenceNodeFromArgument(source) and`
`74`	`74`	`not argv(source.(VariableAccess).getTarget())`
`75`	`75`	`)`
`76`	`76`	`}`
`@@ -210,7 +210,7 @@ private predicate nodeIsBarrierIn(DataFlow::Node node) {`
`210`	`210`	`or`
`211`	`211`	`// This case goes together with the similar (but not identical) rule in`
`212`	`212`	// `getNodeForSource`.
`213`		`- node = DataFlow::definitionByReferenceNode(source)`
	`213`	`+ node = DataFlow::definitionByReferenceNodeFromArgument(source)`
`214`	`214`	`)`
`215`	`215`	`}`
`216`	`216`