hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-16 16:53:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

Data flow: Document Node::getEnclosingCallable()

Browse Source
This commit is contained in:
Tom Hvitved
2020-08-18 15:16:00 +02:00
parent 129e528e1c
commit 13577967f3
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/ql-libraries/dataflow/dataflow.md
View File

@@ -98,6 +98,10 @@ Recommendations:
also work, but the upside of `use-use` steps is that sources defined in terms
of variable reads just work out of the box. It also makes certain
barrier-implementations simpler.
* A predicate `DataFlowCallable Node::getEnclosingCallable()` is required, and in
order to ensure appropriate join-orders, it is important that the QL compiler knows
that this predicate is functional. It can therefore be necessary to enclose the body
of this predicate in a `unique` aggregate.
The shared library does not use `localFlowStep` nor `localFlow` but users of
`DataFlow.qll` may expect the existence of `DataFlow::localFlowStep` and