hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-05-05 13:45:19 +02:00
Code Issues Packages Projects Releases Wiki Activity

Dataflow: Adjust documentation.

Browse Source
This commit is contained in:
Anders Schack-Mulligen
2021-10-29 11:20:19 +02:00
parent 5951ae79b9
commit bfacd23573
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -150,14 +150,19 @@ call-graph should be defined as a predicate:
```ql
DataFlowCallable viableCallable(DataFlowCall c)
```
Furthermore, each `Node` must be associated with exactly one callable and this
relation should be defined as:
```ql
DataFlowCallable nodeGetEnclosingCallable(Node n)
```
In order to connect data-flow across calls, the 4 `Node` subclasses
`ArgumentNode`, `ParameterNode`, `ReturnNode`, and `OutNode` are used.
Flow into callables from arguments to parameters are matched up using an
integer position, so these two classes must define:
integer position, so these two predicates must be defined:
```ql
ArgumentNode::argumentOf(DataFlowCall call, int pos)
ParameterNode::isParameterOf(DataFlowCallable c, int pos)
predicate isParameterNode(ParameterNode p, DataFlowCallable c, int pos)
```
It is typical to use `pos = -1` for an implicit `this`-parameter.