Skip to content

Commit e366600

Browse files
committed
Python: add some links to readme
1 parent a9e0288 commit e366600

File tree

1 file changed

+3
-2
lines changed
  • python/ql/src/experimental/dataflow/internal

1 file changed

+3
-2
lines changed

python/ql/src/experimental/dataflow/internal/readme.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,14 +124,15 @@ Try recovering an existing taint tracking query by implementing sources, sinks,
124124

125125
- Implementation has largely been done by finding a plausibly-sounding predicate in the python library to refer to. We should review that we actually have the intended semantics in all places.
126126
- Comprehensive testing.
127-
- The regression tests track the value of guards in order to eliminate impossible data flow. We currently have regressions because of this. We cannot readily replicate the existing method, as it uses the interdefinedness of data flow and taint tracking (there is a boolean taint kind). C++ does something similar for eliminating impossible control flow, which we might be able to replicate (they infer values of "interesting" control flow nodes, which are those needed to determine values of guards).
127+
- The regression tests track the value of guards in order to eliminate impossible data flow. We currently have regressions because of this. We cannot readily replicate the existing method, as it uses the interdefinedness of data flow and taint tracking (there is a boolean taint kind). C++ [does something similar](https://github.com/github/codeql/blob/master/cpp/ql/src/semmle/code/cpp/controlflow/internal/ConstantExprs.qll#L27-L36) for eliminating impossible control flow, which we might be able to replicate (they infer values of "interesting" control flow nodes, which are those needed to determine values of guards).
128128
- Flow for some syntactic constructs are done via extra taint steps in the existing implementation, we should find a way to get data flow for it. Some of this should be covered by field flow.
129129
- A document is being written about proper use of the shared data flow library, this should be adhered to. In particular, we should consider replacing def-use with def-to-first-use and use-to-next-use in local flow.
130130
- We seem to get duplicated results for global flow, as well as flow with and without type (so four times the "unique" results).
131131
- We currently consider control flow nodes like exit nodes for functions, we should probably filter down which ones are of interest.
132132
- We should probably override ToString for a number of data flow nodes.
133133
- Test flow through classes, constructors and methods.
134134
- What happens with named arguments? What does C# do?
135-
- What should the enclosable callable for global variables be? C++ makes it the variable itself, C# seems to not have nodes for these but only for their reads and writes.
135+
- What should the enclosable callable for global variables be? C++ [makes it the variable itself](https://github.com/github/codeql/blob/master/cpp/ql/src/semmle/code/cpp/ir/dataflow/internal/DataFlowUtil.qll#L417), C# seems to not have nodes for these but only for their reads and writes.
136136
- Is `yield` another return type? If not, how is it handled?
137137
- Should `OutNode` include magic function calls?
138+
- Consider creating an internal abstract class for nodes as C# does. Among other things, this can help the optimizer by stating that `getEnclosingCallable` [is functional](https://github.com/github/codeql/blob/master/csharp/ql/src/semmle/code/csharp/dataflow/internal/DataFlowPublic.qll#L62).

0 commit comments

Comments
 (0)