|
| 1 | +signature module DataFlowParameter { |
| 2 | + class Node { |
| 3 | + /** Gets a textual representation of this element. */ |
| 4 | + string toString(); |
| 5 | + |
| 6 | + /** |
| 7 | + * Holds if this element is at the specified location. |
| 8 | + * The location spans column `startcolumn` of line `startline` to |
| 9 | + * column `endcolumn` of line `endline` in file `filepath`. |
| 10 | + * For more information, see |
| 11 | + * [Locations](https://codeql.github.com/docs/writing-codeql-queries/providing-locations-in-codeql-queries/). |
| 12 | + */ |
| 13 | + predicate hasLocationInfo( |
| 14 | + string filepath, int startline, int startcolumn, int endline, int endcolumn |
| 15 | + ); |
| 16 | + } |
| 17 | + |
| 18 | + class ParameterNode extends Node; |
| 19 | + |
| 20 | + class ArgumentNode extends Node; |
| 21 | + |
| 22 | + class ReturnNode extends Node { |
| 23 | + ReturnKind getKind(); |
| 24 | + } |
| 25 | + |
| 26 | + class OutNode extends Node; |
| 27 | + |
| 28 | + class PostUpdateNode extends Node { |
| 29 | + Node getPreUpdateNode(); |
| 30 | + } |
| 31 | + |
| 32 | + class CastNode extends Node; |
| 33 | + |
| 34 | + predicate isParameterNode(ParameterNode p, DataFlowCallable c, ParameterPosition pos); |
| 35 | + |
| 36 | + predicate isArgumentNode(ArgumentNode n, DataFlowCall call, ArgumentPosition pos); |
| 37 | + |
| 38 | + DataFlowCallable nodeGetEnclosingCallable(Node node); |
| 39 | + |
| 40 | + DataFlowType getNodeType(Node node); |
| 41 | + |
| 42 | + predicate nodeIsHidden(Node node); |
| 43 | + |
| 44 | + class DataFlowExpr; |
| 45 | + |
| 46 | + /** Gets the node corresponding to `e`. */ |
| 47 | + Node exprNode(DataFlowExpr e); |
| 48 | + |
| 49 | + class DataFlowCall { |
| 50 | + /** Gets a textual representation of this element. */ |
| 51 | + string toString(); |
| 52 | + |
| 53 | + DataFlowCallable getEnclosingCallable(); |
| 54 | + } |
| 55 | + |
| 56 | + class DataFlowCallable { |
| 57 | + /** Gets a textual representation of this element. */ |
| 58 | + string toString(); |
| 59 | + } |
| 60 | + |
| 61 | + class ReturnKind { |
| 62 | + /** Gets a textual representation of this element. */ |
| 63 | + string toString(); |
| 64 | + } |
| 65 | + |
| 66 | + /** Gets a viable implementation of the target of the given `Call`. */ |
| 67 | + DataFlowCallable viableCallable(DataFlowCall c); |
| 68 | + |
| 69 | + /** |
| 70 | + * Holds if the set of viable implementations that can be called by `call` |
| 71 | + * might be improved by knowing the call context. |
| 72 | + */ |
| 73 | + predicate mayBenefitFromCallContext(DataFlowCall call, DataFlowCallable c); |
| 74 | + |
| 75 | + /** |
| 76 | + * Gets a viable dispatch target of `call` in the context `ctx`. This is |
| 77 | + * restricted to those `call`s for which a context might make a difference. |
| 78 | + */ |
| 79 | + DataFlowCallable viableImplInCallContext(DataFlowCall call, DataFlowCall ctx); |
| 80 | + |
| 81 | + /** |
| 82 | + * Gets a node that can read the value returned from `call` with return kind |
| 83 | + * `kind`. |
| 84 | + */ |
| 85 | + OutNode getAnOutNode(DataFlowCall call, ReturnKind kind); |
| 86 | + |
| 87 | + class DataFlowType { |
| 88 | + /** Gets a textual representation of this element. */ |
| 89 | + string toString(); |
| 90 | + } |
| 91 | + |
| 92 | + string ppReprType(DataFlowType t); |
| 93 | + |
| 94 | + bindingset[t1, t2] |
| 95 | + predicate compatibleTypes(DataFlowType t1, DataFlowType t2); |
| 96 | + |
| 97 | + predicate typeStrongerThan(DataFlowType t1, DataFlowType t2); |
| 98 | + |
| 99 | + class Content { |
| 100 | + /** Gets a textual representation of this element. */ |
| 101 | + string toString(); |
| 102 | + } |
| 103 | + |
| 104 | + predicate forceHighPrecision(Content c); |
| 105 | + |
| 106 | + /** |
| 107 | + * An entity that represents a set of `Content`s. |
| 108 | + * |
| 109 | + * The set may be interpreted differently depending on whether it is |
| 110 | + * stored into (`getAStoreContent`) or read from (`getAReadContent`). |
| 111 | + */ |
| 112 | + class ContentSet { |
| 113 | + /** Gets a content that may be stored into when storing into this set. */ |
| 114 | + Content getAStoreContent(); |
| 115 | + |
| 116 | + /** Gets a content that may be read from when reading from this set. */ |
| 117 | + Content getAReadContent(); |
| 118 | + } |
| 119 | + |
| 120 | + class ContentApprox { |
| 121 | + /** Gets a textual representation of this element. */ |
| 122 | + string toString(); |
| 123 | + } |
| 124 | + |
| 125 | + ContentApprox getContentApprox(Content c); |
| 126 | + |
| 127 | + class ParameterPosition { |
| 128 | + /** Gets a textual representation of this element. */ |
| 129 | + bindingset[this] |
| 130 | + string toString(); |
| 131 | + } |
| 132 | + |
| 133 | + class ArgumentPosition { |
| 134 | + /** Gets a textual representation of this element. */ |
| 135 | + bindingset[this] |
| 136 | + string toString(); |
| 137 | + } |
| 138 | + |
| 139 | + predicate parameterMatch(ParameterPosition ppos, ArgumentPosition apos); |
| 140 | + |
| 141 | + predicate simpleLocalFlowStep(Node node1, Node node2); |
| 142 | + |
| 143 | + /** |
| 144 | + * Holds if data can flow from `node1` to `node2` through a non-local step |
| 145 | + * that does not follow a call edge. For example, a step through a global |
| 146 | + * variable. |
| 147 | + */ |
| 148 | + predicate jumpStep(Node node1, Node node2); |
| 149 | + |
| 150 | + /** |
| 151 | + * Holds if data can flow from `node1` to `node2` via a read of `c`. Thus, |
| 152 | + * `node1` references an object with a content `c.getAReadContent()` whose |
| 153 | + * value ends up in `node2`. |
| 154 | + */ |
| 155 | + predicate readStep(Node node1, ContentSet c, Node node2); |
| 156 | + |
| 157 | + /** |
| 158 | + * Holds if data can flow from `node1` to `node2` via a store into `c`. Thus, |
| 159 | + * `node2` references an object with a content `c.getAStoreContent()` that |
| 160 | + * contains the value of `node1`. |
| 161 | + */ |
| 162 | + predicate storeStep(Node node1, ContentSet c, Node node2); |
| 163 | + |
| 164 | + /** |
| 165 | + * Holds if values stored inside content `c` are cleared at node `n`. For example, |
| 166 | + * any value stored inside `f` is cleared at the pre-update node associated with `x` |
| 167 | + * in `x.f = newValue`. |
| 168 | + */ |
| 169 | + predicate clearsContent(Node n, ContentSet c); |
| 170 | + |
| 171 | + /** |
| 172 | + * Holds if the value that is being tracked is expected to be stored inside content `c` |
| 173 | + * at node `n`. |
| 174 | + */ |
| 175 | + predicate expectsContent(Node n, ContentSet c); |
| 176 | + |
| 177 | + /** |
| 178 | + * Holds if the node `n` is unreachable when the call context is `call`. |
| 179 | + */ |
| 180 | + predicate isUnreachableInCall(Node n, DataFlowCall call); |
| 181 | + |
| 182 | + default int accessPathLimit() { result = 5 } |
| 183 | + |
| 184 | + /** |
| 185 | + * Holds if flow is allowed to pass from parameter `p` and back to itself as a |
| 186 | + * side-effect, resulting in a summary from `p` to itself. |
| 187 | + * |
| 188 | + * One example would be to allow flow like `p.foo = p.bar;`, which is disallowed |
| 189 | + * by default as a heuristic. |
| 190 | + */ |
| 191 | + predicate allowParameterReturnInSelf(ParameterNode p); |
| 192 | + |
| 193 | + class LambdaCallKind; |
| 194 | + |
| 195 | + /** Holds if `creation` is an expression that creates a lambda of kind `kind` for `c`. */ |
| 196 | + predicate lambdaCreation(Node creation, LambdaCallKind kind, DataFlowCallable c); |
| 197 | + |
| 198 | + /** Holds if `call` is a lambda call of kind `kind` where `receiver` is the lambda expression. */ |
| 199 | + predicate lambdaCall(DataFlowCall call, LambdaCallKind kind, Node receiver); |
| 200 | + |
| 201 | + /** Extra data-flow steps needed for lambda flow analysis. */ |
| 202 | + predicate additionalLambdaFlowStep(Node nodeFrom, Node nodeTo, boolean preservesValue); |
| 203 | + |
| 204 | + /** |
| 205 | + * Holds if `n` should never be skipped over in the `PathGraph` and in path |
| 206 | + * explanations. |
| 207 | + */ |
| 208 | + default predicate neverSkipInPathGraph(Node n) { none() } |
| 209 | + |
| 210 | + /** |
| 211 | + * Gets an additional term that is added to the `join` and `branch` computations to reflect |
| 212 | + * an additional forward or backwards branching factor that is not taken into account |
| 213 | + * when calculating the (virtual) dispatch cost. |
| 214 | + * |
| 215 | + * Argument `arg` is part of a path from a source to a sink, and `p` is the target parameter. |
| 216 | + */ |
| 217 | + int getAdditionalFlowIntoCallNodeTerm(ArgumentNode arg, ParameterNode p); |
| 218 | + |
| 219 | + predicate golangSpecificParamArgFilter(DataFlowCall call, ParameterNode p, ArgumentNode arg); |
| 220 | +} |
0 commit comments