Skip to content

Commit 06404d8

Browse files
committed
Add missing QLDoc
1 parent 8d844e8 commit 06404d8

File tree

1 file changed

+12
-0
lines changed
  • go/ql/lib/semmle/go/dataflow

1 file changed

+12
-0
lines changed

go/ql/lib/semmle/go/dataflow/SSA.qll

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,11 @@ class SsaExplicitDefinition extends SsaDefinition, TExplicitDef {
198198

199199
override Location getLocation() { result = this.getInstruction().getLocation() }
200200

201+
/**
202+
* Gets the first instruction that the value of this `SsaDefinition` can
203+
* reach without passing through any other instructions, but possibly through
204+
* phi nodes.
205+
*/
201206
IR::Instruction getAFirstUse() { firstUse(this, result) }
202207
}
203208

@@ -413,4 +418,11 @@ DataFlow::Node getASimilarReadNode(DataFlow::Node node) {
413418
)
414419
}
415420

421+
/**
422+
* Gets an instruction such that `pred` and `result` form an adjacent
423+
* use-use-pair of the same`SsaSourceVariable`, that is, the value read in
424+
* `pred` can reach `result` without passing through any other use or any SSA
425+
* definition of the variable except for phi nodes and uncertain implicit
426+
* updates.
427+
*/
416428
IR::Instruction getAnAdjacentUse(IR::Instruction pred) { adjacentUseUse(pred, result) }

0 commit comments

Comments
 (0)