/**
 * INTERNAL: Do not use.
 *
 * Provides an implementation of global (interprocedural) data flow.
 */

private import DataFlowImplCommon
private import DataFlowImplSpecific::Private
private import DataFlowImplSpecific::Public
private import DataFlowImplCommonPublic
private import codeql.util.Unit
private import codeql.util.Option
import DataFlow

/**
 * An input configuration for data flow using flow state. This signature equals
 * `StateConfigSig`, but requires explicit implementation of all predicates.
 */
signature module FullStateConfigSig {
  bindingset[this]
  class FlowState;

  /**
   * Holds if `source` is a relevant data flow source with the given initial
   * `state`.
   */
  predicate isSource(Node source, FlowState state);

  /**
   * Holds if `sink` is a relevant data flow sink accepting `state`.
   */
  predicate isSink(Node sink, FlowState state);

  /**
   * Holds if data flow through `node` is prohibited. This completely removes
   * `node` from the data flow graph.
   */
  predicate isBarrier(Node node);

  /**
   * Holds if data flow through `node` is prohibited when the flow state is
   * `state`.
   */
  predicate isBarrier(Node node, FlowState state);

  /** Holds if data flow into `node` is prohibited. */
  predicate isBarrierIn(Node node);

  /** Holds if data flow out of `node` is prohibited. */
  predicate isBarrierOut(Node node);

  /**
   * Holds if data may flow from `node1` to `node2` in addition to the normal data-flow steps.
   */
  predicate isAdditionalFlowStep(Node node1, Node node2);

  /**
   * Holds if data may flow from `node1` to `node2` in addition to the normal data-flow steps.
   * This step is only applicable in `state1` and updates the flow state to `state2`.
   */
  predicate isAdditionalFlowStep(Node node1, FlowState state1, Node node2, FlowState state2);

  /**
   * Holds if an arbitrary number of implicit read steps of content `c` may be
   * taken at `node`.
   */
  predicate allowImplicitRead(Node node, ContentSet c);

  /**
   * Gets the virtual dispatch branching limit when calculating field flow.
   * This can be overridden to a smaller value to improve performance (a
   * value of 0 disables field flow), or a larger value to get more results.
   */
  int fieldFlowBranchLimit();

  /**
   * Gets a data flow configuration feature to add restrictions to the set of
   * valid flow paths.
   *
   * - `FeatureHasSourceCallContext`:
   *    Assume that sources have some existing call context to disallow
   *    conflicting return-flow directly following the source.
   * - `FeatureHasSinkCallContext`:
   *    Assume that sinks have some existing call context to disallow
   *    conflicting argument-to-parameter flow directly preceding the sink.
   * - `FeatureEqualSourceSinkCallContext`:
   *    Implies both of the above and additionally ensures that the entire flow
   *    path preserves the call context.
   *
   * These features are generally not relevant for typical end-to-end data flow
   * queries, but should only be used for constructing paths that need to
   * somehow be pluggable in another path context.
   */
  FlowFeature getAFeature();

  /** Holds if sources should be grouped in the result of `flowPath`. */
  predicate sourceGrouping(Node source, string sourceGroup);

  /** Holds if sinks should be grouped in the result of `flowPath`. */
  predicate sinkGrouping(Node sink, string sinkGroup);

  /**
   * Holds if hidden nodes should be included in the data flow graph.
   *
   * This feature should only be used for debugging or when the data flow graph
   * is not visualized (as it is in a `path-problem` query).
   */
  predicate includeHiddenNodes();
}

/**
 * Provides default `FlowState` implementations given a `StateConfigSig`.
 */
module DefaultState<ConfigSig Config> {
  class FlowState = Unit;

  predicate isSource(Node source, FlowState state) { Config::isSource(source) and exists(state) }

  predicate isSink(Node sink, FlowState state) { Config::isSink(sink) and exists(state) }

  predicate isBarrier(Node node, FlowState state) { none() }

  predicate isAdditionalFlowStep(Node node1, FlowState state1, Node node2, FlowState state2) {
    none()
  }
}

/**
 * Constructs a data flow computation given a full input configuration.
 */
module Impl<FullStateConfigSig Config> {
  private class FlowState = Config::FlowState;

  private newtype TNodeEx =
    TNodeNormal(Node n) or
    TNodeImplicitRead(Node n, boolean hasRead) {
      Config::allowImplicitRead(n, _) and hasRead = [false, true]
    }

  private class NodeEx extends TNodeEx {
    string toString() {
      result = this.asNode().toString()
      or
      exists(Node n | this.isImplicitReadNode(n, _) | result = n.toString() + " [Ext]")
    }

    Node asNode() { this = TNodeNormal(result) }

    predicate isImplicitReadNode(Node n, boolean hasRead) { this = TNodeImplicitRead(n, hasRead) }

    Node projectToNode() { this = TNodeNormal(result) or this = TNodeImplicitRead(result, _) }

    pragma[nomagic]
    private DataFlowCallable getEnclosingCallable0() {
      nodeEnclosingCallable(this.projectToNode(), result)
    }

    pragma[inline]
    DataFlowCallable getEnclosingCallable() {
      pragma[only_bind_out](this).getEnclosingCallable0() = pragma[only_bind_into](result)
    }

    pragma[nomagic]
    private DataFlowType getDataFlowType0() { nodeDataFlowType(this.asNode(), result) }

    pragma[inline]
    DataFlowType getDataFlowType() {
      pragma[only_bind_out](this).getDataFlowType0() = pragma[only_bind_into](result)
    }

    predicate hasLocationInfo(
      string filepath, int startline, int startcolumn, int endline, int endcolumn
    ) {
      this.projectToNode().hasLocationInfo(filepath, startline, startcolumn, endline, endcolumn)
    }
  }

  private class ArgNodeEx extends NodeEx {
    ArgNodeEx() { this.asNode() instanceof ArgNode }
  }

  private class ParamNodeEx extends NodeEx {
    ParamNodeEx() { this.asNode() instanceof ParamNode }

    predicate isParameterOf(DataFlowCallable c, ParameterPosition pos) {
      this.asNode().(ParamNode).isParameterOf(c, pos)
    }

    ParameterPosition getPosition() { this.isParameterOf(_, result) }
  }

  private class RetNodeEx extends NodeEx {
    RetNodeEx() { this.asNode() instanceof ReturnNodeExt }

    ReturnPosition getReturnPosition() { result = getReturnPosition(this.asNode()) }

    ReturnKindExt getKind() { result = this.asNode().(ReturnNodeExt).getKind() }
  }

  private predicate inBarrier(NodeEx node) {
    exists(Node n |
      node.asNode() = n and
      Config::isBarrierIn(n) and
      Config::isSource(n, _)
    )
  }

  private predicate outBarrier(NodeEx node) {
    exists(Node n |
      node.asNode() = n and
      Config::isBarrierOut(n) and
      Config::isSink(n, _)
    )
  }

  pragma[nomagic]
  private predicate fullBarrier(NodeEx node) {
    exists(Node n | node.asNode() = n |
      Config::isBarrier(n)
      or
      Config::isBarrierIn(n) and
      not Config::isSource(n, _)
      or
      Config::isBarrierOut(n) and
      not Config::isSink(n, _)
    )
  }

  pragma[nomagic]
  private predicate stateBarrier(NodeEx node, FlowState state) {
    exists(Node n | node.asNode() = n | Config::isBarrier(n, state))
  }

  pragma[nomagic]
  private predicate sourceNode(NodeEx node, FlowState state) {
    Config::isSource(node.asNode(), state) and
    not fullBarrier(node) and
    not stateBarrier(node, state)
  }

  pragma[nomagic]
  private predicate sinkNode(NodeEx node, FlowState state) {
    Config::isSink(node.asNode(), state) and
    not fullBarrier(node) and
    not stateBarrier(node, state)
  }

  /** Provides the relevant barriers for a step from `node1` to `node2`. */
  pragma[inline]
  private predicate stepFilter(NodeEx node1, NodeEx node2) {
    not outBarrier(node1) and
    not inBarrier(node2) and
    not fullBarrier(node1) and
    not fullBarrier(node2)
  }

  /**
   * Holds if data can flow in one local step from `node1` to `node2`.
   */
  private predicate localFlowStepEx(NodeEx node1, NodeEx node2) {
    exists(Node n1, Node n2 |
      node1.asNode() = n1 and
      node2.asNode() = n2 and
      simpleLocalFlowStepExt(pragma[only_bind_into](n1), pragma[only_bind_into](n2)) and
      stepFilter(node1, node2)
    )
    or
    exists(Node n |
      Config::allowImplicitRead(n, _) and
      node1.asNode() = n and
      node2.isImplicitReadNode(n, false) and
      not fullBarrier(node1)
    )
  }

  /**
   * Holds if the additional step from `node1` to `node2` does not jump between callables.
   */
  private predicate additionalLocalFlowStep(NodeEx node1, NodeEx node2) {
    exists(Node n1, Node n2 |
      node1.asNode() = n1 and
      node2.asNode() = n2 and
      Config::isAdditionalFlowStep(pragma[only_bind_into](n1), pragma[only_bind_into](n2)) and
      getNodeEnclosingCallable(n1) = getNodeEnclosingCallable(n2) and
      stepFilter(node1, node2)
    )
    or
    exists(Node n |
      Config::allowImplicitRead(n, _) and
      node1.isImplicitReadNode(n, true) and
      node2.asNode() = n and
      not fullBarrier(node2)
    )
  }

  private predicate additionalLocalStateStep(NodeEx node1, FlowState s1, NodeEx node2, FlowState s2) {
    exists(Node n1, Node n2 |
      node1.asNode() = n1 and
      node2.asNode() = n2 and
      Config::isAdditionalFlowStep(pragma[only_bind_into](n1), s1, pragma[only_bind_into](n2), s2) and
      getNodeEnclosingCallable(n1) = getNodeEnclosingCallable(n2) and
      stepFilter(node1, node2) and
      not stateBarrier(node1, s1) and
      not stateBarrier(node2, s2)
    )
  }

  /**
   * Holds if data can flow from `node1` to `node2` in a way that discards call contexts.
   */
  private predicate jumpStepEx(NodeEx node1, NodeEx node2) {
    exists(Node n1, Node n2 |
      node1.asNode() = n1 and
      node2.asNode() = n2 and
      jumpStepCached(pragma[only_bind_into](n1), pragma[only_bind_into](n2)) and
      stepFilter(node1, node2) and
      not Config::getAFeature() instanceof FeatureEqualSourceSinkCallContext
    )
  }

  /**
   * Holds if the additional step from `node1` to `node2` jumps between callables.
   */
  private predicate additionalJumpStep(NodeEx node1, NodeEx node2) {
    exists(Node n1, Node n2 |
      node1.asNode() = n1 and
      node2.asNode() = n2 and
      Config::isAdditionalFlowStep(pragma[only_bind_into](n1), pragma[only_bind_into](n2)) and
      getNodeEnclosingCallable(n1) != getNodeEnclosingCallable(n2) and
      stepFilter(node1, node2) and
      not Config::getAFeature() instanceof FeatureEqualSourceSinkCallContext
    )
  }

  private predicate additionalJumpStateStep(NodeEx node1, FlowState s1, NodeEx node2, FlowState s2) {
    exists(Node n1, Node n2 |
      node1.asNode() = n1 and
      node2.asNode() = n2 and
      Config::isAdditionalFlowStep(pragma[only_bind_into](n1), s1, pragma[only_bind_into](n2), s2) and
      getNodeEnclosingCallable(n1) != getNodeEnclosingCallable(n2) and
      stepFilter(node1, node2) and
      not stateBarrier(node1, s1) and
      not stateBarrier(node2, s2) and
      not Config::getAFeature() instanceof FeatureEqualSourceSinkCallContext
    )
  }

  pragma[nomagic]
  private predicate readSetEx(NodeEx node1, ContentSet c, NodeEx node2) {
    readSet(pragma[only_bind_into](node1.asNode()), c, pragma[only_bind_into](node2.asNode())) and
    stepFilter(node1, node2)
    or
    exists(Node n |
      node2.isImplicitReadNode(n, true) and
      node1.isImplicitReadNode(n, _) and
      Config::allowImplicitRead(n, c)
    )
  }

  // inline to reduce fan-out via `getAReadContent`
  bindingset[c]
  private predicate read(NodeEx node1, Content c, NodeEx node2) {
    exists(ContentSet cs |
      readSetEx(node1, cs, node2) and
      pragma[only_bind_out](c) = pragma[only_bind_into](cs).getAReadContent()
    )
  }

  // inline to reduce fan-out via `getAReadContent`
  bindingset[c]
  private predicate clearsContentEx(NodeEx n, Content c) {
    exists(ContentSet cs |
      clearsContentCached(n.asNode(), cs) and
      pragma[only_bind_out](c) = pragma[only_bind_into](cs).getAReadContent()
    )
  }

  // inline to reduce fan-out via `getAReadContent`
  bindingset[c]
  private predicate expectsContentEx(NodeEx n, Content c) {
    exists(ContentSet cs |
      expectsContentCached(n.asNode(), cs) and
      pragma[only_bind_out](c) = pragma[only_bind_into](cs).getAReadContent()
    )
  }

  pragma[nomagic]
  private predicate notExpectsContent(NodeEx n) { not expectsContentCached(n.asNode(), _) }

  pragma[nomagic]
  private predicate hasReadStep(Content c) { read(_, c, _) }

  pragma[nomagic]
  private predicate storeEx(
    NodeEx node1, Content c, NodeEx node2, DataFlowType contentType, DataFlowType containerType
  ) {
    store(pragma[only_bind_into](node1.asNode()), c, pragma[only_bind_into](node2.asNode()),
      contentType, containerType) and
    hasReadStep(c) and
    stepFilter(node1, node2)
  }

  pragma[nomagic]
  private predicate viableReturnPosOutEx(DataFlowCall call, ReturnPosition pos, NodeEx out) {
    viableReturnPosOut(call, pos, out.asNode())
  }

  pragma[nomagic]
  private predicate viableParamArgEx(DataFlowCall call, ParamNodeEx p, ArgNodeEx arg) {
    viableParamArg(call, p.asNode(), arg.asNode())
  }

  /**
   * Holds if field flow should be used for the given configuration.
   */
  private predicate useFieldFlow() { Config::fieldFlowBranchLimit() >= 1 }

  private predicate hasSourceCallCtx() {
    exists(FlowFeature feature | feature = Config::getAFeature() |
      feature instanceof FeatureHasSourceCallContext or
      feature instanceof FeatureEqualSourceSinkCallContext
    )
  }

  private predicate sourceCallCtx(CallContext cc) {
    if hasSourceCallCtx() then cc instanceof CallContextSomeCall else cc instanceof CallContextAny
  }

  private predicate hasSinkCallCtx() {
    exists(FlowFeature feature | feature = Config::getAFeature() |
      feature instanceof FeatureHasSinkCallContext or
      feature instanceof FeatureEqualSourceSinkCallContext
    )
  }

  /**
   * Holds if flow from `p` to a return node of kind `kind` is allowed.
   *
   * We don't expect a parameter to return stored in itself, unless
   * explicitly allowed
   */
  bindingset[p, kind]
  private predicate parameterFlowThroughAllowed(ParamNodeEx p, ReturnKindExt kind) {
    exists(ParameterPosition pos | p.isParameterOf(_, pos) |
      not kind.(ParamUpdateReturnKind).getPosition() = pos
      or
      allowParameterReturnInSelfCached(p.asNode())
    )
  }

  private module Stage1 implements StageSig {
    class Ap = Unit;

    private class Cc = boolean;

    /* Begin: Stage 1 logic. */
    /**
     * Holds if `node` is reachable from a source.
     *
     * The Boolean `cc` records whether the node is reached through an
     * argument in a call.
     */
    pragma[assume_small_delta]
    private predicate fwdFlow(NodeEx node, Cc cc) {
      sourceNode(node, _) and
      if hasSourceCallCtx() then cc = true else cc = false
      or
      exists(NodeEx mid | fwdFlow(mid, cc) |
        localFlowStepEx(mid, node) or
        additionalLocalFlowStep(mid, node) or
        additionalLocalStateStep(mid, _, node, _)
      )
      or
      exists(NodeEx mid | fwdFlow(mid, _) and cc = false |
        jumpStepEx(mid, node) or
        additionalJumpStep(mid, node) or
        additionalJumpStateStep(mid, _, node, _)
      )
      or
      // store
      exists(NodeEx mid |
        useFieldFlow() and
        fwdFlow(mid, cc) and
        storeEx(mid, _, node, _, _)
      )
      or
      // read
      exists(ContentSet c |
        fwdFlowReadSet(c, node, cc) and
        fwdFlowConsCandSet(c, _)
      )
      or
      // flow into a callable
      fwdFlowIn(_, _, _, node) and
      cc = true
      or
      // flow out of a callable
      fwdFlowOut(_, node, false) and
      cc = false
      or
      // flow through a callable
      exists(DataFlowCall call |
        fwdFlowOutFromArg(call, node) and
        fwdFlowIsEntered(call, cc)
      )
    }

    // inline to reduce the number of iterations
    pragma[inline]
    private predicate fwdFlowIn(DataFlowCall call, NodeEx arg, Cc cc, ParamNodeEx p) {
      // call context cannot help reduce virtual dispatch
      fwdFlow(arg, cc) and
      viableParamArgEx(call, p, arg) and
      not fullBarrier(p) and
      (
        cc = false
        or
        cc = true and
        not reducedViableImplInCallContext(call, _, _)
      )
      or
      // call context may help reduce virtual dispatch
      exists(DataFlowCallable target |
        fwdFlowInReducedViableImplInSomeCallContext(call, arg, p, target) and
        target = viableImplInSomeFwdFlowCallContextExt(call) and
        cc = true
      )
    }

    /**
     * Holds if an argument to `call` is reached in the flow covered by `fwdFlow`.
     */
    pragma[nomagic]
    private predicate fwdFlowIsEntered(DataFlowCall call, Cc cc) { fwdFlowIn(call, _, cc, _) }

    pragma[nomagic]
    private predicate fwdFlowInReducedViableImplInSomeCallContext(
      DataFlowCall call, NodeEx arg, ParamNodeEx p, DataFlowCallable target
    ) {
      fwdFlow(arg, true) and
      viableParamArgEx(call, p, arg) and
      reducedViableImplInCallContext(call, _, _) and
      target = p.getEnclosingCallable() and
      not fullBarrier(p)
    }

    /**
     * Gets a viable dispatch target of `call` in the context `ctx`. This is
     * restricted to those `call`s for which a context might make a difference,
     * and to `ctx`s that are reachable in `fwdFlow`.
     */
    pragma[nomagic]
    private DataFlowCallable viableImplInSomeFwdFlowCallContextExt(DataFlowCall call) {
      exists(DataFlowCall ctx |
        fwdFlowIsEntered(ctx, _) and
        result = viableImplInCallContextExt(call, ctx)
      )
    }

    private predicate fwdFlow(NodeEx node) { fwdFlow(node, _) }

    pragma[nomagic]
    private predicate fwdFlowReadSet(ContentSet c, NodeEx node, Cc cc) {
      exists(NodeEx mid |
        fwdFlow(mid, cc) and
        readSetEx(mid, c, node)
      )
    }

    /**
     * Holds if `c` is the target of a store in the flow covered by `fwdFlow`.
     */
    pragma[assume_small_delta]
    pragma[nomagic]
    private predicate fwdFlowConsCand(Content c) {
      exists(NodeEx mid, NodeEx node |
        not fullBarrier(node) and
        useFieldFlow() and
        fwdFlow(mid, _) and
        storeEx(mid, c, node, _, _)
      )
    }

    /**
     * Holds if `cs` may be interpreted in a read as the target of some store
     * into `c`, in the flow covered by `fwdFlow`.
     */
    pragma[nomagic]
    private predicate fwdFlowConsCandSet(ContentSet cs, Content c) {
      fwdFlowConsCand(c) and
      c = cs.getAReadContent()
    }

    pragma[nomagic]
    private predicate fwdFlowReturnPosition(ReturnPosition pos, Cc cc) {
      exists(RetNodeEx ret |
        fwdFlow(ret, cc) and
        ret.getReturnPosition() = pos
      )
    }

    // inline to reduce the number of iterations
    pragma[inline]
    private predicate fwdFlowOut(DataFlowCall call, NodeEx out, Cc cc) {
      exists(ReturnPosition pos |
        fwdFlowReturnPosition(pos, cc) and
        viableReturnPosOutEx(call, pos, out) and
        not fullBarrier(out)
      )
    }

    pragma[nomagic]
    private predicate fwdFlowOutFromArg(DataFlowCall call, NodeEx out) {
      fwdFlowOut(call, out, true)
    }

    private predicate stateStepFwd(FlowState state1, FlowState state2) {
      exists(NodeEx node1 |
        additionalLocalStateStep(node1, state1, _, state2) or
        additionalJumpStateStep(node1, state1, _, state2)
      |
        fwdFlow(node1)
      )
    }

    private predicate fwdFlowState(FlowState state) {
      sourceNode(_, state)
      or
      exists(FlowState state0 |
        fwdFlowState(state0) and
        stateStepFwd(state0, state)
      )
    }

    /**
     * Holds if `node` is part of a path from a source to a sink.
     *
     * The Boolean `toReturn` records whether the node must be returned from
     * the enclosing callable in order to reach a sink.
     */
    pragma[nomagic]
    private predicate revFlow(NodeEx node, boolean toReturn) {
      revFlow0(node, toReturn) and
      fwdFlow(node)
    }

    pragma[nomagic]
    private predicate revFlow0(NodeEx node, boolean toReturn) {
      exists(FlowState state |
        fwdFlow(node) and
        sinkNode(node, state) and
        fwdFlowState(state) and
        if hasSinkCallCtx() then toReturn = true else toReturn = false
      )
      or
      exists(NodeEx mid | revFlow(mid, toReturn) |
        localFlowStepEx(node, mid) or
        additionalLocalFlowStep(node, mid) or
        additionalLocalStateStep(node, _, mid, _)
      )
      or
      exists(NodeEx mid | revFlow(mid, _) and toReturn = false |
        jumpStepEx(node, mid) or
        additionalJumpStep(node, mid) or
        additionalJumpStateStep(node, _, mid, _)
      )
      or
      // store
      exists(Content c |
        revFlowStore(c, node, toReturn) and
        revFlowConsCand(c)
      )
      or
      // read
      exists(NodeEx mid, ContentSet c |
        readSetEx(node, c, mid) and
        fwdFlowConsCandSet(c, _) and
        revFlow(mid, toReturn)
      )
      or
      // flow into a callable
      revFlowIn(_, node, false) and
      toReturn = false
      or
      // flow out of a callable
      exists(ReturnPosition pos |
        revFlowOut(pos) and
        node.(RetNodeEx).getReturnPosition() = pos and
        toReturn = true
      )
      or
      // flow through a callable
      exists(DataFlowCall call |
        revFlowInToReturn(call, node) and
        revFlowIsReturned(call, toReturn)
      )
    }

    /**
     * Holds if `c` is the target of a read in the flow covered by `revFlow`.
     */
    pragma[nomagic]
    private predicate revFlowConsCand(Content c) {
      exists(NodeEx mid, NodeEx node, ContentSet cs |
        fwdFlow(node) and
        readSetEx(node, cs, mid) and
        fwdFlowConsCandSet(cs, c) and
        revFlow(pragma[only_bind_into](mid), _)
      )
    }

    pragma[nomagic]
    private predicate revFlowStore(Content c, NodeEx node, boolean toReturn) {
      exists(NodeEx mid |
        revFlow(mid, toReturn) and
        fwdFlowConsCand(c) and
        storeEx(node, c, mid, _, _)
      )
    }

    /**
     * Holds if `c` is the target of both a read and a store in the flow covered
     * by `revFlow`.
     */
    pragma[nomagic]
    additional predicate revFlowIsReadAndStored(Content c) {
      revFlowConsCand(c) and
      revFlowStore(c, _, _)
    }

    pragma[nomagic]
    additional predicate viableReturnPosOutNodeCandFwd1(
      DataFlowCall call, ReturnPosition pos, NodeEx out
    ) {
      fwdFlowReturnPosition(pos, _) and
      viableReturnPosOutEx(call, pos, out)
    }

    pragma[nomagic]
    private predicate revFlowOut(ReturnPosition pos) {
      exists(NodeEx out |
        revFlow(out, _) and
        viableReturnPosOutNodeCandFwd1(_, pos, out)
      )
    }

    pragma[nomagic]
    additional predicate viableParamArgNodeCandFwd1(DataFlowCall call, ParamNodeEx p, ArgNodeEx arg) {
      fwdFlowIn(call, arg, _, p)
    }

    // inline to reduce the number of iterations
    pragma[inline]
    private predicate revFlowIn(DataFlowCall call, ArgNodeEx arg, boolean toReturn) {
      exists(ParamNodeEx p |
        revFlow(p, toReturn) and
        viableParamArgNodeCandFwd1(call, p, arg)
      )
    }

    pragma[nomagic]
    private predicate revFlowInToReturn(DataFlowCall call, ArgNodeEx arg) {
      revFlowIn(call, arg, true)
    }

    /**
     * Holds if an output from `call` is reached in the flow covered by `revFlow`
     * and data might flow through the target callable resulting in reverse flow
     * reaching an argument of `call`.
     */
    pragma[nomagic]
    private predicate revFlowIsReturned(DataFlowCall call, boolean toReturn) {
      exists(NodeEx out |
        revFlow(out, toReturn) and
        fwdFlowOutFromArg(call, out)
      )
    }

    private predicate stateStepRev(FlowState state1, FlowState state2) {
      exists(NodeEx node1, NodeEx node2 |
        additionalLocalStateStep(node1, state1, node2, state2) or
        additionalJumpStateStep(node1, state1, node2, state2)
      |
        revFlow(node1, _) and
        revFlow(node2, _) and
        fwdFlowState(state1) and
        fwdFlowState(state2)
      )
    }

    pragma[nomagic]
    additional predicate revFlowState(FlowState state) {
      exists(NodeEx node |
        sinkNode(node, state) and
        revFlow(node, _) and
        fwdFlowState(state)
      )
      or
      exists(FlowState state0 |
        revFlowState(state0) and
        stateStepRev(state, state0)
      )
    }

    pragma[nomagic]
    predicate storeStepCand(
      NodeEx node1, Ap ap1, Content c, NodeEx node2, DataFlowType contentType,
      DataFlowType containerType
    ) {
      revFlowIsReadAndStored(c) and
      revFlow(node2) and
      storeEx(node1, c, node2, contentType, containerType) and
      exists(ap1)
    }

    pragma[nomagic]
    predicate readStepCand(NodeEx n1, Content c, NodeEx n2) {
      revFlowIsReadAndStored(c) and
      read(n1, c, n2) and
      revFlow(n2)
    }

    pragma[nomagic]
    predicate revFlow(NodeEx node) { revFlow(node, _) }

    pragma[nomagic]
    predicate revFlowAp(NodeEx node, Ap ap) {
      revFlow(node) and
      exists(ap)
    }

    bindingset[node, state]
    predicate revFlow(NodeEx node, FlowState state, Ap ap) {
      revFlow(node, _) and
      exists(state) and
      exists(ap)
    }

    private predicate throughFlowNodeCand(NodeEx node) {
      revFlow(node, true) and
      fwdFlow(node, true) and
      not inBarrier(node) and
      not outBarrier(node)
    }

    /** Holds if flow may return from `callable`. */
    pragma[nomagic]
    private predicate returnFlowCallableNodeCand(DataFlowCallable callable, ReturnKindExt kind) {
      exists(RetNodeEx ret |
        throughFlowNodeCand(ret) and
        callable = ret.getEnclosingCallable() and
        kind = ret.getKind()
      )
    }

    /**
     * Holds if flow may enter through `p` and reach a return node making `p` a
     * candidate for the origin of a summary.
     */
    pragma[nomagic]
    predicate parameterMayFlowThrough(ParamNodeEx p, Ap ap) {
      exists(DataFlowCallable c, ReturnKindExt kind |
        throughFlowNodeCand(p) and
        returnFlowCallableNodeCand(c, kind) and
        p.getEnclosingCallable() = c and
        exists(ap) and
        parameterFlowThroughAllowed(p, kind)
      )
    }

    pragma[nomagic]
    predicate returnMayFlowThrough(RetNodeEx ret, Ap argAp, Ap ap, ReturnKindExt kind) {
      throughFlowNodeCand(ret) and
      kind = ret.getKind() and
      exists(argAp) and
      exists(ap)
    }

    pragma[nomagic]
    predicate callMayFlowThroughRev(DataFlowCall call) {
      exists(ArgNodeEx arg, boolean toReturn |
        revFlow(arg, toReturn) and
        revFlowInToReturn(call, arg) and
        revFlowIsReturned(call, toReturn)
      )
    }

    additional predicate stats(
      boolean fwd, int nodes, int fields, int conscand, int states, int tuples
    ) {
      fwd = true and
      nodes = count(NodeEx node | fwdFlow(node)) and
      fields = count(Content f0 | fwdFlowConsCand(f0)) and
      conscand = -1 and
      states = count(FlowState state | fwdFlowState(state)) and
      tuples = count(NodeEx n, boolean b | fwdFlow(n, b))
      or
      fwd = false and
      nodes = count(NodeEx node | revFlow(node, _)) and
      fields = count(Content f0 | revFlowConsCand(f0)) and
      conscand = -1 and
      states = count(FlowState state | revFlowState(state)) and
      tuples = count(NodeEx n, boolean b | revFlow(n, b))
    }
    /* End: Stage 1 logic. */
  }

  pragma[noinline]
  private predicate localFlowStepNodeCand1(NodeEx node1, NodeEx node2) {
    Stage1::revFlow(node2) and
    localFlowStepEx(node1, node2)
  }

  pragma[noinline]
  private predicate additionalLocalFlowStepNodeCand1(NodeEx node1, NodeEx node2) {
    Stage1::revFlow(node2) and
    additionalLocalFlowStep(node1, node2)
  }

  pragma[nomagic]
  private predicate viableReturnPosOutNodeCand1(DataFlowCall call, ReturnPosition pos, NodeEx out) {
    Stage1::revFlow(out) and
    Stage1::viableReturnPosOutNodeCandFwd1(call, pos, out)
  }

  /**
   * Holds if data can flow out of `call` from `ret` to `out`, either
   * through a `ReturnNode` or through an argument that has been mutated, and
   * that this step is part of a path from a source to a sink.
   */
  pragma[nomagic]
  private predicate flowOutOfCallNodeCand1(
    DataFlowCall call, RetNodeEx ret, ReturnKindExt kind, NodeEx out
  ) {
    exists(ReturnPosition pos |
      viableReturnPosOutNodeCand1(call, pos, out) and
      pos = ret.getReturnPosition() and
      kind = pos.getKind() and
      Stage1::revFlow(ret) and
      not outBarrier(ret) and
      not inBarrier(out)
    )
  }

  pragma[nomagic]
  private predicate viableParamArgNodeCand1(DataFlowCall call, ParamNodeEx p, ArgNodeEx arg) {
    Stage1::viableParamArgNodeCandFwd1(call, p, arg) and
    Stage1::revFlow(arg)
  }

  /**
   * Holds if data can flow into `call` and that this step is part of a
   * path from a source to a sink.
   */
  pragma[nomagic]
  private predicate flowIntoCallNodeCand1(DataFlowCall call, ArgNodeEx arg, ParamNodeEx p) {
    viableParamArgNodeCand1(call, p, arg) and
    Stage1::revFlow(p) and
    not outBarrier(arg) and
    not inBarrier(p)
  }

  /**
   * Gets an additional term that is added to `branch` and `join` when deciding whether
   * the amount of forward or backward branching is within the limit specified by the
   * configuration.
   */
  pragma[nomagic]
  private int getLanguageSpecificFlowIntoCallNodeCand1(ArgNodeEx arg, ParamNodeEx p) {
    flowIntoCallNodeCand1(_, arg, p) and
    result = getAdditionalFlowIntoCallNodeTerm(arg.projectToNode(), p.projectToNode())
  }

  /**
   * Gets the amount of forward branching on the origin of a cross-call path
   * edge in the graph of paths between sources and sinks that ignores call
   * contexts.
   */
  pragma[nomagic]
  private int branch(NodeEx n1) {
    result =
      strictcount(NodeEx n | flowOutOfCallNodeCand1(_, n1, _, n) or flowIntoCallNodeCand1(_, n1, n))
        + sum(ParamNodeEx p1 | | getLanguageSpecificFlowIntoCallNodeCand1(n1, p1))
  }

  /**
   * Gets the amount of backward branching on the target of a cross-call path
   * edge in the graph of paths between sources and sinks that ignores call
   * contexts.
   */
  pragma[nomagic]
  private int join(NodeEx n2) {
    result =
      strictcount(NodeEx n | flowOutOfCallNodeCand1(_, n, _, n2) or flowIntoCallNodeCand1(_, n, n2))
        + sum(ArgNodeEx arg2 | | getLanguageSpecificFlowIntoCallNodeCand1(arg2, n2))
  }

  /**
   * Holds if data can flow out of `call` from `ret` to `out`, either
   * through a `ReturnNode` or through an argument that has been mutated, and
   * that this step is part of a path from a source to a sink. The
   * `allowsFieldFlow` flag indicates whether the branching is within the limit
   * specified by the configuration.
   */
  pragma[nomagic]
  private predicate flowOutOfCallNodeCand1(
    DataFlowCall call, RetNodeEx ret, ReturnKindExt kind, NodeEx out, boolean allowsFieldFlow
  ) {
    flowOutOfCallNodeCand1(call, ret, kind, out) and
    exists(int b, int j |
      b = branch(ret) and
      j = join(out) and
      if b.minimum(j) <= Config::fieldFlowBranchLimit()
      then allowsFieldFlow = true
      else allowsFieldFlow = false
    )
  }

  /**
   * Holds if data can flow into `call` and that this step is part of a
   * path from a source to a sink. The `allowsFieldFlow` flag indicates whether
   * the branching is within the limit specified by the configuration.
   */
  pragma[nomagic]
  private predicate flowIntoCallNodeCand1(
    DataFlowCall call, ArgNodeEx arg, ParamNodeEx p, boolean allowsFieldFlow
  ) {
    flowIntoCallNodeCand1(call, arg, p) and
    exists(int b, int j |
      b = branch(arg) and
      j = join(p) and
      if b.minimum(j) <= Config::fieldFlowBranchLimit()
      then allowsFieldFlow = true
      else allowsFieldFlow = false
    )
  }

  private signature module StageSig {
    class Ap;

    predicate revFlow(NodeEx node);

    predicate revFlowAp(NodeEx node, Ap ap);

    bindingset[node, state]
    predicate revFlow(NodeEx node, FlowState state, Ap ap);

    predicate callMayFlowThroughRev(DataFlowCall call);

    predicate parameterMayFlowThrough(ParamNodeEx p, Ap ap);

    predicate returnMayFlowThrough(RetNodeEx ret, Ap argAp, Ap ap, ReturnKindExt kind);

    predicate storeStepCand(
      NodeEx node1, Ap ap1, Content c, NodeEx node2, DataFlowType contentType,
      DataFlowType containerType
    );

    predicate readStepCand(NodeEx n1, Content c, NodeEx n2);
  }

  private module MkStage<StageSig PrevStage> {
    class ApApprox = PrevStage::Ap;

    signature module StageParam {
      class Typ {
        string toString();
      }

      class Ap;

      class ApNil extends Ap;

      bindingset[result, ap]
      ApApprox getApprox(Ap ap);

      Typ getTyp(DataFlowType t);

      bindingset[c, t, tail]
      Ap apCons(Content c, Typ t, Ap tail);

      /**
       * An approximation of `Content` that corresponds to the precision level of
       * `Ap`, such that the mappings from both `Ap` and `Content` to this type
       * are functional.
       */
      class ApHeadContent;

      ApHeadContent getHeadContent(Ap ap);

      ApHeadContent projectToHeadContent(Content c);

      class ApOption;

      ApOption apNone();

      ApOption apSome(Ap ap);

      class Cc;

      class CcCall extends Cc;

      // TODO: member predicate on CcCall
      predicate matchesCall(CcCall cc, DataFlowCall call);

      class CcNoCall extends Cc;

      Cc ccNone();

      CcCall ccSomeCall();

      class LocalCc;

      bindingset[call, c, outercc]
      CcCall getCallContextCall(DataFlowCall call, DataFlowCallable c, Cc outercc);

      bindingset[call, c, innercc]
      CcNoCall getCallContextReturn(DataFlowCallable c, DataFlowCall call, Cc innercc);

      bindingset[node, cc]
      LocalCc getLocalCc(NodeEx node, Cc cc);

      bindingset[node1, state1]
      bindingset[node2, state2]
      predicate localStep(
        NodeEx node1, FlowState state1, NodeEx node2, FlowState state2, boolean preservesValue,
        Typ t, LocalCc lcc
      );

      predicate flowOutOfCall(
        DataFlowCall call, RetNodeEx ret, ReturnKindExt kind, NodeEx out, boolean allowsFieldFlow
      );

      predicate flowIntoCall(
        DataFlowCall call, ArgNodeEx arg, ParamNodeEx p, boolean allowsFieldFlow
      );

      bindingset[node, state, t0, ap]
      predicate filter(NodeEx node, FlowState state, Typ t0, Ap ap, Typ t);

      bindingset[typ, contentType]
      predicate typecheckStore(Typ typ, DataFlowType contentType);
    }

    module Stage<StageParam Param> implements StageSig {
      import Param

      /* Begin: Stage logic. */
      private module TypOption = Option<Typ>;

      private class TypOption = TypOption::Option;

      pragma[nomagic]
      private Typ getNodeTyp(NodeEx node) {
        PrevStage::revFlow(node) and result = getTyp(node.getDataFlowType())
      }

      pragma[nomagic]
      private predicate flowIntoCallApa(
        DataFlowCall call, ArgNodeEx arg, ParamNodeEx p, boolean allowsFieldFlow, ApApprox apa
      ) {
        flowIntoCall(call, arg, p, allowsFieldFlow) and
        PrevStage::revFlowAp(p, pragma[only_bind_into](apa)) and
        PrevStage::revFlowAp(arg, pragma[only_bind_into](apa))
      }

      pragma[nomagic]
      private predicate flowOutOfCallApa(
        DataFlowCall call, RetNodeEx ret, ReturnKindExt kind, NodeEx out, boolean allowsFieldFlow,
        ApApprox apa
      ) {
        flowOutOfCall(call, ret, kind, out, allowsFieldFlow) and
        PrevStage::revFlowAp(out, pragma[only_bind_into](apa)) and
        PrevStage::revFlowAp(ret, pragma[only_bind_into](apa))
      }

      pragma[nomagic]
      private predicate flowThroughOutOfCall(
        DataFlowCall call, CcCall ccc, RetNodeEx ret, NodeEx out, boolean allowsFieldFlow,
        ApApprox argApa, ApApprox apa
      ) {
        exists(ReturnKindExt kind |
          flowOutOfCallApa(call, ret, kind, out, allowsFieldFlow, apa) and
          PrevStage::callMayFlowThroughRev(call) and
          PrevStage::returnMayFlowThrough(ret, argApa, apa, kind) and
          matchesCall(ccc, call)
        )
      }

      /**
       * Holds if `node` is reachable with access path `ap` from a source.
       *
       * The call context `cc` records whether the node is reached through an
       * argument in a call, and if so, `summaryCtx` and `argAp` record the
       * corresponding parameter position and access path of that argument, respectively.
       */
      pragma[nomagic]
      additional predicate fwdFlow(
        NodeEx node, FlowState state, Cc cc, ParamNodeOption summaryCtx, TypOption argT,
        ApOption argAp, Typ t, Ap ap, ApApprox apa
      ) {
        fwdFlow1(node, state, cc, summaryCtx, argT, argAp, _, t, ap, apa)
      }

      private predicate fwdFlow1(
        NodeEx node, FlowState state, Cc cc, ParamNodeOption summaryCtx, TypOption argT,
        ApOption argAp, Typ t0, Typ t, Ap ap, ApApprox apa
      ) {
        fwdFlow0(node, state, cc, summaryCtx, argT, argAp, t0, ap, apa) and
        PrevStage::revFlow(node, state, apa) and
        filter(node, state, t0, ap, t)
      }

      pragma[nomagic]
      private predicate typeStrengthen(Typ t0, Ap ap, Typ t) {
        fwdFlow1(_, _, _, _, _, _, t0, t, ap, _) and t0 != t
      }

      pragma[assume_small_delta]
      pragma[nomagic]
      private predicate fwdFlow0(
        NodeEx node, FlowState state, Cc cc, ParamNodeOption summaryCtx, TypOption argT,
        ApOption argAp, Typ t, Ap ap, ApApprox apa
      ) {
        sourceNode(node, state) and
        (if hasSourceCallCtx() then cc = ccSomeCall() else cc = ccNone()) and
        argT instanceof TypOption::None and
        argAp = apNone() and
        summaryCtx = TParamNodeNone() and
        t = getNodeTyp(node) and
        ap instanceof ApNil and
        apa = getApprox(ap)
        or
        exists(NodeEx mid, FlowState state0, Typ t0, LocalCc localCc |
          fwdFlow(mid, state0, cc, summaryCtx, argT, argAp, t0, ap, apa) and
          localCc = getLocalCc(mid, cc)
        |
          localStep(mid, state0, node, state, true, _, localCc) and
          t = t0
          or
          localStep(mid, state0, node, state, false, t, localCc) and
          ap instanceof ApNil
        )
        or
        exists(NodeEx mid |
          fwdFlow(mid, state, _, _, _, _, t, ap, apa) and
          jumpStepEx(mid, node) and
          cc = ccNone() and
          summaryCtx = TParamNodeNone() and
          argT instanceof TypOption::None and
          argAp = apNone()
        )
        or
        exists(NodeEx mid |
          fwdFlow(mid, state, _, _, _, _, _, ap, apa) and
          additionalJumpStep(mid, node) and
          cc = ccNone() and
          summaryCtx = TParamNodeNone() and
          argT instanceof TypOption::None and
          argAp = apNone() and
          t = getNodeTyp(node) and
          ap instanceof ApNil
        )
        or
        exists(NodeEx mid, FlowState state0 |
          fwdFlow(mid, state0, _, _, _, _, _, ap, apa) and
          additionalJumpStateStep(mid, state0, node, state) and
          cc = ccNone() and
          summaryCtx = TParamNodeNone() and
          argT instanceof TypOption::None and
          argAp = apNone() and
          t = getNodeTyp(node) and
          ap instanceof ApNil
        )
        or
        // store
        exists(Content c, Typ t0, Ap ap0 |
          fwdFlowStore(_, t0, ap0, c, t, node, state, cc, summaryCtx, argT, argAp) and
          ap = apCons(c, t0, ap0) and
          apa = getApprox(ap)
        )
        or
        // read
        exists(Typ t0, Ap ap0, Content c |
          fwdFlowRead(t0, ap0, c, _, node, state, cc, summaryCtx, argT, argAp) and
          fwdFlowConsCand(t0, ap0, c, t, ap) and
          apa = getApprox(ap)
        )
        or
        // flow into a callable
        fwdFlowIn(_, node, state, _, cc, _, _, _, t, ap, apa) and
        if PrevStage::parameterMayFlowThrough(node, apa)
        then (
          summaryCtx = TParamNodeSome(node.asNode()) and
          argT = TypOption::some(t) and
          argAp = apSome(ap)
        ) else (
          summaryCtx = TParamNodeNone() and argT instanceof TypOption::None and argAp = apNone()
        )
        or
        // flow out of a callable
        exists(
          DataFlowCall call, RetNodeEx ret, boolean allowsFieldFlow, CcNoCall innercc,
          DataFlowCallable inner
        |
          fwdFlow(ret, state, innercc, summaryCtx, argT, argAp, t, ap, apa) and
          flowOutOfCallApa(call, ret, _, node, allowsFieldFlow, apa) and
          inner = ret.getEnclosingCallable() and
          cc = getCallContextReturn(inner, call, innercc) and
          if allowsFieldFlow = false then ap instanceof ApNil else any()
        )
        or
        // flow through a callable
        exists(
          DataFlowCall call, CcCall ccc, RetNodeEx ret, boolean allowsFieldFlow,
          ApApprox innerArgApa
        |
          fwdFlowThrough(call, cc, state, ccc, summaryCtx, argT, argAp, t, ap, apa, ret, innerArgApa) and
          flowThroughOutOfCall(call, ccc, ret, node, allowsFieldFlow, innerArgApa, apa) and
          if allowsFieldFlow = false then ap instanceof ApNil else any()
        )
      }

      pragma[nomagic]
      private predicate fwdFlowStore(
        NodeEx node1, Typ t1, Ap ap1, Content c, Typ t2, NodeEx node2, FlowState state, Cc cc,
        ParamNodeOption summaryCtx, TypOption argT, ApOption argAp
      ) {
        exists(DataFlowType contentType, DataFlowType containerType, ApApprox apa1 |
          fwdFlow(node1, state, cc, summaryCtx, argT, argAp, t1, ap1, apa1) and
          PrevStage::storeStepCand(node1, apa1, c, node2, contentType, containerType) and
          t2 = getTyp(containerType) and
          typecheckStore(t1, contentType)
        )
      }

      /**
       * Holds if forward flow with access path `tail` and type `t1` reaches a
       * store of `c` on a container of type `t2` resulting in access path
       * `cons`.
       */
      pragma[nomagic]
      private predicate fwdFlowConsCand(Typ t2, Ap cons, Content c, Typ t1, Ap tail) {
        fwdFlowStore(_, t1, tail, c, t2, _, _, _, _, _, _) and
        cons = apCons(c, t1, tail)
        or
        exists(Typ t0 |
          typeStrengthen(t0, cons, t2) and
          fwdFlowConsCand(t0, cons, c, t1, tail)
        )
      }

      pragma[nomagic]
      private predicate readStepCand(NodeEx node1, ApHeadContent apc, Content c, NodeEx node2) {
        PrevStage::readStepCand(node1, c, node2) and
        apc = projectToHeadContent(c)
      }

      bindingset[node1, apc]
      pragma[inline_late]
      private predicate readStepCand0(NodeEx node1, ApHeadContent apc, Content c, NodeEx node2) {
        readStepCand(node1, apc, c, node2)
      }

      pragma[nomagic]
      private predicate fwdFlowRead(
        Typ t, Ap ap, Content c, NodeEx node1, NodeEx node2, FlowState state, Cc cc,
        ParamNodeOption summaryCtx, TypOption argT, ApOption argAp
      ) {
        exists(ApHeadContent apc |
          fwdFlow(node1, state, cc, summaryCtx, argT, argAp, t, ap, _) and
          apc = getHeadContent(ap) and
          readStepCand0(node1, apc, c, node2)
        )
      }

      pragma[nomagic]
      private predicate fwdFlowIn(
        DataFlowCall call, ParamNodeEx p, FlowState state, Cc outercc, CcCall innercc,
        ParamNodeOption summaryCtx, TypOption argT, ApOption argAp, Typ t, Ap ap, ApApprox apa
      ) {
        exists(ArgNodeEx arg, boolean allowsFieldFlow |
          fwdFlow(arg, state, outercc, summaryCtx, argT, argAp, t, ap, apa) and
          flowIntoCallApa(call, arg, p, allowsFieldFlow, apa) and
          innercc = getCallContextCall(call, p.getEnclosingCallable(), outercc) and
          if allowsFieldFlow = false then ap instanceof ApNil else any()
        )
      }

      pragma[nomagic]
      private predicate fwdFlowRetFromArg(
        RetNodeEx ret, FlowState state, CcCall ccc, ParamNodeEx summaryCtx, Typ argT, Ap argAp,
        ApApprox argApa, Typ t, Ap ap, ApApprox apa
      ) {
        exists(ReturnKindExt kind |
          fwdFlow(pragma[only_bind_into](ret), state, ccc,
            TParamNodeSome(pragma[only_bind_into](summaryCtx.asNode())), TypOption::some(argT),
            pragma[only_bind_into](apSome(argAp)), t, ap, pragma[only_bind_into](apa)) and
          kind = ret.getKind() and
          parameterFlowThroughAllowed(summaryCtx, kind) and
          argApa = getApprox(argAp) and
          PrevStage::returnMayFlowThrough(ret, argApa, apa, kind)
        )
      }

      pragma[inline]
      private predicate fwdFlowThrough0(
        DataFlowCall call, Cc cc, FlowState state, CcCall ccc, ParamNodeOption summaryCtx,
        TypOption argT, ApOption argAp, Typ t, Ap ap, ApApprox apa, RetNodeEx ret,
        ParamNodeEx innerSummaryCtx, Typ innerArgT, Ap innerArgAp, ApApprox innerArgApa
      ) {
        fwdFlowRetFromArg(ret, state, ccc, innerSummaryCtx, innerArgT, innerArgAp, innerArgApa, t,
          ap, apa) and
        fwdFlowIsEntered(call, cc, ccc, summaryCtx, argT, argAp, innerSummaryCtx, innerArgT,
          innerArgAp)
      }

      pragma[nomagic]
      private predicate fwdFlowThrough(
        DataFlowCall call, Cc cc, FlowState state, CcCall ccc, ParamNodeOption summaryCtx,
        TypOption argT, ApOption argAp, Typ t, Ap ap, ApApprox apa, RetNodeEx ret,
        ApApprox innerArgApa
      ) {
        fwdFlowThrough0(call, cc, state, ccc, summaryCtx, argT, argAp, t, ap, apa, ret, _, _, _,
          innerArgApa)
      }

      /**
       * Holds if an argument to `call` is reached in the flow covered by `fwdFlow`
       * and data might flow through the target callable and back out at `call`.
       */
      pragma[nomagic]
      private predicate fwdFlowIsEntered(
        DataFlowCall call, Cc cc, CcCall innerCc, ParamNodeOption summaryCtx, TypOption argT,
        ApOption argAp, ParamNodeEx p, Typ t, Ap ap
      ) {
        exists(ApApprox apa |
          fwdFlowIn(call, pragma[only_bind_into](p), _, cc, innerCc, summaryCtx, argT, argAp, t, ap,
            pragma[only_bind_into](apa)) and
          PrevStage::parameterMayFlowThrough(p, apa) and
          PrevStage::callMayFlowThroughRev(call)
        )
      }

      pragma[nomagic]
      private predicate storeStepFwd(NodeEx node1, Typ t1, Ap ap1, Content c, NodeEx node2, Ap ap2) {
        fwdFlowStore(node1, t1, ap1, c, _, node2, _, _, _, _, _) and
        ap2 = apCons(c, t1, ap1) and
        readStepFwd(_, ap2, c, _, _)
      }

      pragma[nomagic]
      private predicate readStepFwd(NodeEx n1, Ap ap1, Content c, NodeEx n2, Ap ap2) {
        exists(Typ t1 |
          fwdFlowRead(t1, ap1, c, n1, n2, _, _, _, _, _) and
          fwdFlowConsCand(t1, ap1, c, _, ap2)
        )
      }

      pragma[nomagic]
      private predicate returnFlowsThrough0(
        DataFlowCall call, FlowState state, CcCall ccc, Ap ap, ApApprox apa, RetNodeEx ret,
        ParamNodeEx innerSummaryCtx, Typ innerArgT, Ap innerArgAp, ApApprox innerArgApa
      ) {
        fwdFlowThrough0(call, _, state, ccc, _, _, _, _, ap, apa, ret, innerSummaryCtx, innerArgT,
          innerArgAp, innerArgApa)
      }

      pragma[nomagic]
      private predicate returnFlowsThrough(
        RetNodeEx ret, ReturnPosition pos, FlowState state, CcCall ccc, ParamNodeEx p, Typ argT,
        Ap argAp, Ap ap
      ) {
        exists(DataFlowCall call, ApApprox apa, boolean allowsFieldFlow, ApApprox innerArgApa |
          returnFlowsThrough0(call, state, ccc, ap, apa, ret, p, argT, argAp, innerArgApa) and
          flowThroughOutOfCall(call, ccc, ret, _, allowsFieldFlow, innerArgApa, apa) and
          pos = ret.getReturnPosition() and
          if allowsFieldFlow = false then ap instanceof ApNil else any()
        )
      }

      pragma[nomagic]
      private predicate flowThroughIntoCall(
        DataFlowCall call, ArgNodeEx arg, ParamNodeEx p, boolean allowsFieldFlow, Ap argAp, Ap ap
      ) {
        exists(ApApprox argApa, Typ argT |
          flowIntoCallApa(call, pragma[only_bind_into](arg), pragma[only_bind_into](p),
            allowsFieldFlow, argApa) and
          fwdFlow(arg, _, _, _, _, _, pragma[only_bind_into](argT), pragma[only_bind_into](argAp),
            argApa) and
          returnFlowsThrough(_, _, _, _, p, pragma[only_bind_into](argT),
            pragma[only_bind_into](argAp), ap) and
          if allowsFieldFlow = false then argAp instanceof ApNil else any()
        )
      }

      pragma[nomagic]
      private predicate flowIntoCallAp(
        DataFlowCall call, ArgNodeEx arg, ParamNodeEx p, boolean allowsFieldFlow, Ap ap
      ) {
        exists(ApApprox apa |
          flowIntoCallApa(call, arg, p, allowsFieldFlow, apa) and
          fwdFlow(arg, _, _, _, _, _, _, ap, apa)
        )
      }

      pragma[nomagic]
      private predicate flowOutOfCallAp(
        DataFlowCall call, RetNodeEx ret, ReturnPosition pos, NodeEx out, boolean allowsFieldFlow,
        Ap ap
      ) {
        exists(ApApprox apa |
          flowOutOfCallApa(call, ret, _, out, allowsFieldFlow, apa) and
          fwdFlow(ret, _, _, _, _, _, _, ap, apa) and
          pos = ret.getReturnPosition()
        )
      }

      /**
       * Holds if `node` with access path `ap` is part of a path from a source to a
       * sink.
       *
       * The parameter `returnCtx` records whether (and how) the node must be returned
       * from the enclosing callable in order to reach a sink, and if so, `returnAp`
       * records the access path of the returned value.
       */
      pragma[nomagic]
      additional predicate revFlow(
        NodeEx node, FlowState state, ReturnCtx returnCtx, ApOption returnAp, Ap ap
      ) {
        revFlow0(node, state, returnCtx, returnAp, ap) and
        fwdFlow(node, state, _, _, _, _, _, ap, _)
      }

      pragma[nomagic]
      private predicate revFlow0(
        NodeEx node, FlowState state, ReturnCtx returnCtx, ApOption returnAp, Ap ap
      ) {
        fwdFlow(node, state, _, _, _, _, _, ap, _) and
        sinkNode(node, state) and
        (
          if hasSinkCallCtx()
          then returnCtx = TReturnCtxNoFlowThrough()
          else returnCtx = TReturnCtxNone()
        ) and
        returnAp = apNone() and
        ap instanceof ApNil
        or
        exists(NodeEx mid, FlowState state0 |
          localStep(node, state, mid, state0, true, _, _) and
          revFlow(mid, state0, returnCtx, returnAp, ap)
        )
        or
        exists(NodeEx mid, FlowState state0 |
          localStep(node, pragma[only_bind_into](state), mid, state0, false, _, _) and
          revFlow(mid, state0, returnCtx, returnAp, ap) and
          ap instanceof ApNil
        )
        or
        exists(NodeEx mid |
          jumpStepEx(node, mid) and
          revFlow(mid, state, _, _, ap) and
          returnCtx = TReturnCtxNone() and
          returnAp = apNone()
        )
        or
        exists(NodeEx mid |
          additionalJumpStep(node, mid) and
          revFlow(pragma[only_bind_into](mid), state, _, _, ap) and
          returnCtx = TReturnCtxNone() and
          returnAp = apNone() and
          ap instanceof ApNil
        )
        or
        exists(NodeEx mid, FlowState state0 |
          additionalJumpStateStep(node, state, mid, state0) and
          revFlow(pragma[only_bind_into](mid), pragma[only_bind_into](state0), _, _, ap) and
          returnCtx = TReturnCtxNone() and
          returnAp = apNone() and
          ap instanceof ApNil
        )
        or
        // store
        exists(Ap ap0, Content c |
          revFlowStore(ap0, c, ap, _, node, state, _, returnCtx, returnAp) and
          revFlowConsCand(ap0, c, ap)
        )
        or
        // read
        exists(NodeEx mid, Ap ap0 |
          revFlow(mid, state, returnCtx, returnAp, ap0) and
          readStepFwd(node, ap, _, mid, ap0)
        )
        or
        // flow into a callable
        exists(ParamNodeEx p, boolean allowsFieldFlow |
          revFlow(p, state, TReturnCtxNone(), returnAp, ap) and
          flowIntoCallAp(_, node, p, allowsFieldFlow, ap) and
          (if allowsFieldFlow = false then ap instanceof ApNil else any()) and
          returnCtx = TReturnCtxNone()
        )
        or
        // flow through a callable
        exists(DataFlowCall call, ParamNodeEx p, Ap innerReturnAp |
          revFlowThrough(call, returnCtx, p, state, _, returnAp, ap, innerReturnAp) and
          flowThroughIntoCall(call, node, p, _, ap, innerReturnAp)
        )
        or
        // flow out of a callable
        exists(ReturnPosition pos |
          revFlowOut(_, node, pos, state, _, _, ap) and
          if returnFlowsThrough(node, pos, state, _, _, _, _, ap)
          then (
            returnCtx = TReturnCtxMaybeFlowThrough(pos) and
            returnAp = apSome(ap)
          ) else (
            returnCtx = TReturnCtxNoFlowThrough() and returnAp = apNone()
          )
        )
      }

      pragma[nomagic]
      private predicate revFlowStore(
        Ap ap0, Content c, Ap ap, Typ t, NodeEx node, FlowState state, NodeEx mid,
        ReturnCtx returnCtx, ApOption returnAp
      ) {
        revFlow(mid, state, returnCtx, returnAp, ap0) and
        storeStepFwd(node, t, ap, c, mid, ap0)
      }

      /**
       * Holds if reverse flow with access path `tail` reaches a read of `c`
       * resulting in access path `cons`.
       */
      pragma[nomagic]
      private predicate revFlowConsCand(Ap cons, Content c, Ap tail) {
        exists(NodeEx mid, Ap tail0 |
          revFlow(mid, _, _, _, tail) and
          tail = pragma[only_bind_into](tail0) and
          readStepFwd(_, cons, c, mid, tail0)
        )
      }

      pragma[nomagic]
      private predicate revFlowOut(
        DataFlowCall call, RetNodeEx ret, ReturnPosition pos, FlowState state, ReturnCtx returnCtx,
        ApOption returnAp, Ap ap
      ) {
        exists(NodeEx out, boolean allowsFieldFlow |
          revFlow(out, state, returnCtx, returnAp, ap) and
          flowOutOfCallAp(call, ret, pos, out, allowsFieldFlow, ap) and
          if allowsFieldFlow = false then ap instanceof ApNil else any()
        )
      }

      pragma[nomagic]
      private predicate revFlowParamToReturn(
        ParamNodeEx p, FlowState state, ReturnPosition pos, Ap returnAp, Ap ap
      ) {
        revFlow(pragma[only_bind_into](p), state, TReturnCtxMaybeFlowThrough(pos), apSome(returnAp),
          pragma[only_bind_into](ap)) and
        parameterFlowThroughAllowed(p, pos.getKind()) and
        PrevStage::parameterMayFlowThrough(p, getApprox(ap))
      }

      pragma[nomagic]
      private predicate revFlowThrough(
        DataFlowCall call, ReturnCtx returnCtx, ParamNodeEx p, FlowState state, ReturnPosition pos,
        ApOption returnAp, Ap ap, Ap innerReturnAp
      ) {
        revFlowParamToReturn(p, state, pos, innerReturnAp, ap) and
        revFlowIsReturned(call, returnCtx, returnAp, pos, innerReturnAp)
      }

      /**
       * Holds if an output from `call` is reached in the flow covered by `revFlow`
       * and data might flow through the target callable resulting in reverse flow
       * reaching an argument of `call`.
       */
      pragma[nomagic]
      private predicate revFlowIsReturned(
        DataFlowCall call, ReturnCtx returnCtx, ApOption returnAp, ReturnPosition pos, Ap ap
      ) {
        exists(RetNodeEx ret, FlowState state, CcCall ccc |
          revFlowOut(call, ret, pos, state, returnCtx, returnAp, ap) and
          returnFlowsThrough(ret, pos, state, ccc, _, _, _, ap) and
          matchesCall(ccc, call)
        )
      }

      pragma[nomagic]
      predicate storeStepCand(
        NodeEx node1, Ap ap1, Content c, NodeEx node2, DataFlowType contentType,
        DataFlowType containerType
      ) {
        exists(Ap ap2 |
          PrevStage::storeStepCand(node1, _, c, node2, contentType, containerType) and
          revFlowStore(ap2, c, ap1, _, node1, _, node2, _, _) and
          revFlowConsCand(ap2, c, ap1)
        )
      }

      predicate readStepCand(NodeEx node1, Content c, NodeEx node2) {
        exists(Ap ap1, Ap ap2 |
          revFlow(node2, _, _, _, pragma[only_bind_into](ap2)) and
          readStepFwd(node1, ap1, c, node2, ap2) and
          revFlowStore(ap1, c, pragma[only_bind_into](ap2), _, _, _, _, _, _)
        )
      }

      additional predicate revFlow(NodeEx node, FlowState state) { revFlow(node, state, _, _, _) }

      predicate revFlow(NodeEx node, FlowState state, Ap ap) { revFlow(node, state, _, _, ap) }

      pragma[nomagic]
      predicate revFlow(NodeEx node) { revFlow(node, _, _, _, _) }

      pragma[nomagic]
      predicate revFlowAp(NodeEx node, Ap ap) { revFlow(node, _, _, _, ap) }

      private predicate fwdConsCand(Content c, Typ t, Ap ap) { storeStepFwd(_, t, ap, c, _, _) }

      private predicate revConsCand(Content c, Typ t, Ap ap) {
        exists(Ap ap2 |
          revFlowStore(ap2, c, ap, t, _, _, _, _, _) and
          revFlowConsCand(ap2, c, ap)
        )
      }

      private predicate validAp(Ap ap) {
        revFlow(_, _, _, _, ap) and ap instanceof ApNil
        or
        exists(Content head, Typ t, Ap tail |
          consCand(head, t, tail) and
          ap = apCons(head, t, tail)
        )
      }

      additional predicate consCand(Content c, Typ t, Ap ap) {
        revConsCand(c, t, ap) and
        validAp(ap)
      }

      pragma[nomagic]
      private predicate parameterFlowsThroughRev(
        ParamNodeEx p, Ap ap, ReturnPosition pos, Ap returnAp
      ) {
        revFlow(p, _, TReturnCtxMaybeFlowThrough(pos), apSome(returnAp), ap) and
        parameterFlowThroughAllowed(p, pos.getKind())
      }

      pragma[nomagic]
      predicate parameterMayFlowThrough(ParamNodeEx p, Ap ap) {
        exists(ReturnPosition pos |
          returnFlowsThrough(_, pos, _, _, p, _, ap, _) and
          parameterFlowsThroughRev(p, ap, pos, _)
        )
      }

      pragma[nomagic]
      predicate returnMayFlowThrough(RetNodeEx ret, Ap argAp, Ap ap, ReturnKindExt kind) {
        exists(ParamNodeEx p, ReturnPosition pos |
          returnFlowsThrough(ret, pos, _, _, p, _, argAp, ap) and
          parameterFlowsThroughRev(p, argAp, pos, ap) and
          kind = pos.getKind()
        )
      }

      pragma[nomagic]
      private predicate revFlowThroughArg(
        DataFlowCall call, ArgNodeEx arg, FlowState state, ReturnCtx returnCtx, ApOption returnAp,
        Ap ap
      ) {
        exists(ParamNodeEx p, Ap innerReturnAp |
          revFlowThrough(call, returnCtx, p, state, _, returnAp, ap, innerReturnAp) and
          flowThroughIntoCall(call, arg, p, _, ap, innerReturnAp)
        )
      }

      pragma[nomagic]
      predicate callMayFlowThroughRev(DataFlowCall call) {
        exists(ArgNodeEx arg, FlowState state, ReturnCtx returnCtx, ApOption returnAp, Ap ap |
          revFlow(arg, state, returnCtx, returnAp, ap) and
          revFlowThroughArg(call, arg, state, returnCtx, returnAp, ap)
        )
      }

      additional predicate stats(
        boolean fwd, int nodes, int fields, int conscand, int states, int tuples
      ) {
        fwd = true and
        nodes = count(NodeEx node | fwdFlow(node, _, _, _, _, _, _, _, _)) and
        fields = count(Content f0 | fwdConsCand(f0, _, _)) and
        conscand = count(Content f0, Typ t, Ap ap | fwdConsCand(f0, t, ap)) and
        states = count(FlowState state | fwdFlow(_, state, _, _, _, _, _, _, _)) and
        tuples =
          count(NodeEx n, FlowState state, Cc cc, ParamNodeOption summaryCtx, TypOption argT,
            ApOption argAp, Typ t, Ap ap | fwdFlow(n, state, cc, summaryCtx, argT, argAp, t, ap, _))
        or
        fwd = false and
        nodes = count(NodeEx node | revFlow(node, _, _, _, _)) and
        fields = count(Content f0 | consCand(f0, _, _)) and
        conscand = count(Content f0, Typ t, Ap ap | consCand(f0, t, ap)) and
        states = count(FlowState state | revFlow(_, state, _, _, _)) and
        tuples =
          count(NodeEx n, FlowState state, ReturnCtx returnCtx, ApOption retAp, Ap ap |
            revFlow(n, state, returnCtx, retAp, ap)
          )
      }
      /* End: Stage logic. */
    }
  }

  private module BooleanCallContext {
    class Cc extends boolean {
      Cc() { this in [true, false] }
    }

    class CcCall extends Cc {
      CcCall() { this = true }
    }

    /** Holds if the call context may be `call`. */
    predicate matchesCall(CcCall cc, DataFlowCall call) { any() }

    class CcNoCall extends Cc {
      CcNoCall() { this = false }
    }

    Cc ccNone() { result = false }

    CcCall ccSomeCall() { result = true }

    class LocalCc = Unit;

    bindingset[node, cc]
    LocalCc getLocalCc(NodeEx node, Cc cc) { any() }

    bindingset[call, c, outercc]
    CcCall getCallContextCall(DataFlowCall call, DataFlowCallable c, Cc outercc) { any() }

    bindingset[call, c, innercc]
    CcNoCall getCallContextReturn(DataFlowCallable c, DataFlowCall call, Cc innercc) { any() }
  }

  private module Level1CallContext {
    class Cc = CallContext;

    class CcCall = CallContextCall;

    pragma[inline]
    predicate matchesCall(CcCall cc, DataFlowCall call) { cc.matchesCall(call) }

    class CcNoCall = CallContextNoCall;

    Cc ccNone() { result instanceof CallContextAny }

    CcCall ccSomeCall() { result instanceof CallContextSomeCall }

    module NoLocalCallContext {
      class LocalCc = Unit;

      bindingset[node, cc]
      LocalCc getLocalCc(NodeEx node, Cc cc) { any() }

      bindingset[call, c, outercc]
      CcCall getCallContextCall(DataFlowCall call, DataFlowCallable c, Cc outercc) {
        checkCallContextCall(outercc, call, c) and
        if recordDataFlowCallSiteDispatch(call, c)
        then result = TSpecificCall(call)
        else result = TSomeCall()
      }
    }

    module LocalCallContext {
      class LocalCc = LocalCallContext;

      bindingset[node, cc]
      LocalCc getLocalCc(NodeEx node, Cc cc) {
        result =
          getLocalCallContext(pragma[only_bind_into](pragma[only_bind_out](cc)),
            node.getEnclosingCallable())
      }

      bindingset[call, c, outercc]
      CcCall getCallContextCall(DataFlowCall call, DataFlowCallable c, Cc outercc) {
        checkCallContextCall(outercc, call, c) and
        if recordDataFlowCallSite(call, c)
        then result = TSpecificCall(call)
        else result = TSomeCall()
      }
    }

    bindingset[call, c, innercc]
    CcNoCall getCallContextReturn(DataFlowCallable c, DataFlowCall call, Cc innercc) {
      checkCallContextReturn(innercc, c, call) and
      if reducedViableImplInReturn(c, call) then result = TReturn(c, call) else result = ccNone()
    }
  }

  private module Stage2Param implements MkStage<Stage1>::StageParam {
    private module PrevStage = Stage1;

    class Typ = Unit;

    class Ap extends boolean {
      Ap() { this in [true, false] }
    }

    class ApNil extends Ap {
      ApNil() { this = false }
    }

    bindingset[result, ap]
    PrevStage::Ap getApprox(Ap ap) { any() }

    Typ getTyp(DataFlowType t) { any() }

    bindingset[c, t, tail]
    Ap apCons(Content c, Typ t, Ap tail) {
      result = true and exists(c) and exists(t) and exists(tail)
    }

    class ApHeadContent = Unit;

    pragma[inline]
    ApHeadContent getHeadContent(Ap ap) { exists(result) and ap = true }

    ApHeadContent projectToHeadContent(Content c) { any() }

    class ApOption = BooleanOption;

    ApOption apNone() { result = TBooleanNone() }

    ApOption apSome(Ap ap) { result = TBooleanSome(ap) }

    import Level1CallContext
    import NoLocalCallContext

    bindingset[node1, state1]
    bindingset[node2, state2]
    predicate localStep(
      NodeEx node1, FlowState state1, NodeEx node2, FlowState state2, boolean preservesValue, Typ t,
      LocalCc lcc
    ) {
      (
        preservesValue = true and
        localFlowStepNodeCand1(node1, node2) and
        state1 = state2
        or
        preservesValue = false and
        additionalLocalFlowStepNodeCand1(node1, node2) and
        state1 = state2
        or
        preservesValue = false and
        additionalLocalStateStep(node1, state1, node2, state2)
      ) and
      exists(t) and
      exists(lcc)
    }

    predicate flowOutOfCall = flowOutOfCallNodeCand1/5;

    predicate flowIntoCall = flowIntoCallNodeCand1/4;

    pragma[nomagic]
    private predicate expectsContentCand(NodeEx node) {
      exists(Content c |
        PrevStage::revFlow(node) and
        PrevStage::revFlowIsReadAndStored(c) and
        expectsContentEx(node, c)
      )
    }

    bindingset[node, state, t0, ap]
    predicate filter(NodeEx node, FlowState state, Typ t0, Ap ap, Typ t) {
      PrevStage::revFlowState(state) and
      t0 = t and
      exists(ap) and
      not stateBarrier(node, state) and
      (
        notExpectsContent(node)
        or
        ap = true and
        expectsContentCand(node)
      )
    }

    bindingset[typ, contentType]
    predicate typecheckStore(Typ typ, DataFlowType contentType) { any() }
  }

  private module Stage2 implements StageSig {
    import MkStage<Stage1>::Stage<Stage2Param>
  }

  pragma[nomagic]
  private predicate flowOutOfCallNodeCand2(
    DataFlowCall call, RetNodeEx node1, ReturnKindExt kind, NodeEx node2, boolean allowsFieldFlow
  ) {
    flowOutOfCallNodeCand1(call, node1, kind, node2, allowsFieldFlow) and
    Stage2::revFlow(node2) and
    Stage2::revFlow(node1)
  }

  pragma[nomagic]
  private predicate flowIntoCallNodeCand2(
    DataFlowCall call, ArgNodeEx node1, ParamNodeEx node2, boolean allowsFieldFlow
  ) {
    flowIntoCallNodeCand1(call, node1, node2, allowsFieldFlow) and
    Stage2::revFlow(node2) and
    Stage2::revFlow(node1)
  }

  private module LocalFlowBigStep {
    /**
     * A node where some checking is required, and hence the big-step relation
     * is not allowed to step over.
     */
    private class FlowCheckNode extends NodeEx {
      FlowCheckNode() {
        castNode(this.asNode()) or
        clearsContentCached(this.asNode(), _) or
        expectsContentCached(this.asNode(), _) or
        neverSkipInPathGraph(this.asNode())
      }
    }

    /**
     * Holds if `node` can be the first node in a maximal subsequence of local
     * flow steps in a dataflow path.
     */
    private predicate localFlowEntry(NodeEx node, FlowState state) {
      Stage2::revFlow(node, state) and
      (
        sourceNode(node, state)
        or
        jumpStepEx(_, node)
        or
        additionalJumpStep(_, node)
        or
        additionalJumpStateStep(_, _, node, state)
        or
        node instanceof ParamNodeEx
        or
        node.asNode() instanceof OutNodeExt
        or
        Stage2::storeStepCand(_, _, _, node, _, _)
        or
        Stage2::readStepCand(_, _, node)
        or
        node instanceof FlowCheckNode
        or
        exists(FlowState s |
          additionalLocalStateStep(_, s, node, state) and
          s != state
        )
      )
    }

    /**
     * Holds if `node` can be the last node in a maximal subsequence of local
     * flow steps in a dataflow path.
     */
    private predicate localFlowExit(NodeEx node, FlowState state) {
      exists(NodeEx next | Stage2::revFlow(next, state) |
        jumpStepEx(node, next) or
        additionalJumpStep(node, next) or
        flowIntoCallNodeCand2(_, node, next, _) or
        flowOutOfCallNodeCand2(_, node, _, next, _) or
        Stage2::storeStepCand(node, _, _, next, _, _) or
        Stage2::readStepCand(node, _, next)
      )
      or
      exists(NodeEx next, FlowState s | Stage2::revFlow(next, s) |
        additionalJumpStateStep(node, state, next, s)
        or
        additionalLocalStateStep(node, state, next, s) and
        s != state
      )
      or
      Stage2::revFlow(node, state) and
      node instanceof FlowCheckNode
      or
      sinkNode(node, state)
    }

    pragma[noinline]
    private predicate additionalLocalFlowStepNodeCand2(
      NodeEx node1, FlowState state1, NodeEx node2, FlowState state2
    ) {
      additionalLocalFlowStepNodeCand1(node1, node2) and
      state1 = state2 and
      Stage2::revFlow(node1, pragma[only_bind_into](state1), false) and
      Stage2::revFlow(node2, pragma[only_bind_into](state2), false)
      or
      additionalLocalStateStep(node1, state1, node2, state2) and
      Stage2::revFlow(node1, state1, false) and
      Stage2::revFlow(node2, state2, false)
    }

    /**
     * Holds if the local path from `node1` to `node2` is a prefix of a maximal
     * subsequence of local flow steps in a dataflow path.
     *
     * This is the transitive closure of `[additional]localFlowStep` beginning
     * at `localFlowEntry`.
     */
    pragma[nomagic]
    private predicate localFlowStepPlus(
      NodeEx node1, FlowState state, NodeEx node2, boolean preservesValue, DataFlowType t,
      LocalCallContext cc
    ) {
      not isUnreachableInCallCached(node2.asNode(), cc.(LocalCallContextSpecificCall).getCall()) and
      (
        localFlowEntry(node1, pragma[only_bind_into](state)) and
        (
          localFlowStepNodeCand1(node1, node2) and
          preservesValue = true and
          t = node1.getDataFlowType() and // irrelevant dummy value
          Stage2::revFlow(node2, pragma[only_bind_into](state))
          or
          additionalLocalFlowStepNodeCand2(node1, state, node2, state) and
          preservesValue = false and
          t = node2.getDataFlowType()
        ) and
        node1 != node2 and
        cc.relevantFor(node1.getEnclosingCallable()) and
        not isUnreachableInCallCached(node1.asNode(), cc.(LocalCallContextSpecificCall).getCall())
        or
        exists(NodeEx mid |
          localFlowStepPlus(node1, pragma[only_bind_into](state), mid, preservesValue, t, cc) and
          localFlowStepNodeCand1(mid, node2) and
          not mid instanceof FlowCheckNode and
          Stage2::revFlow(node2, pragma[only_bind_into](state))
        )
        or
        exists(NodeEx mid |
          localFlowStepPlus(node1, state, mid, _, _, cc) and
          additionalLocalFlowStepNodeCand2(mid, state, node2, state) and
          not mid instanceof FlowCheckNode and
          preservesValue = false and
          t = node2.getDataFlowType()
        )
      )
    }

    /**
     * Holds if `node1` can step to `node2` in one or more local steps and this
     * path can occur as a maximal subsequence of local steps in a dataflow path.
     */
    pragma[nomagic]
    predicate localFlowBigStep(
      NodeEx node1, FlowState state1, NodeEx node2, FlowState state2, boolean preservesValue,
      DataFlowType t, LocalCallContext callContext
    ) {
      localFlowStepPlus(node1, state1, node2, preservesValue, t, callContext) and
      localFlowExit(node2, state1) and
      state1 = state2
      or
      additionalLocalFlowStepNodeCand2(node1, state1, node2, state2) and
      state1 != state2 and
      preservesValue = false and
      t = node2.getDataFlowType() and
      callContext.relevantFor(node1.getEnclosingCallable()) and
      not exists(DataFlowCall call | call = callContext.(LocalCallContextSpecificCall).getCall() |
        isUnreachableInCallCached(node1.asNode(), call) or
        isUnreachableInCallCached(node2.asNode(), call)
      )
    }
  }

  private import LocalFlowBigStep

  pragma[nomagic]
  private predicate castingNodeEx(NodeEx node) { node.asNode() instanceof CastingNode }

  private module Stage3Param implements MkStage<Stage2>::StageParam {
    private module PrevStage = Stage2;

    class Typ = DataFlowType;

    class Ap = ApproxAccessPathFront;

    class ApNil = ApproxAccessPathFrontNil;

    PrevStage::Ap getApprox(Ap ap) { result = ap.toBoolNonEmpty() }

    Typ getTyp(DataFlowType t) { result = t }

    bindingset[c, t, tail]
    Ap apCons(Content c, Typ t, Ap tail) { result.getAHead() = c and exists(t) and exists(tail) }

    class ApHeadContent = ContentApprox;

    pragma[noinline]
    ApHeadContent getHeadContent(Ap ap) { result = ap.getHead() }

    predicate projectToHeadContent = getContentApprox/1;

    class ApOption = ApproxAccessPathFrontOption;

    ApOption apNone() { result = TApproxAccessPathFrontNone() }

    ApOption apSome(Ap ap) { result = TApproxAccessPathFrontSome(ap) }

    import BooleanCallContext

    predicate localStep(
      NodeEx node1, FlowState state1, NodeEx node2, FlowState state2, boolean preservesValue, Typ t,
      LocalCc lcc
    ) {
      localFlowBigStep(node1, state1, node2, state2, preservesValue, t, _) and
      exists(lcc)
    }

    predicate flowOutOfCall = flowOutOfCallNodeCand2/5;

    predicate flowIntoCall = flowIntoCallNodeCand2/4;

    pragma[nomagic]
    private predicate expectsContentCand(NodeEx node, Ap ap) {
      exists(Content c |
        PrevStage::revFlow(node) and
        PrevStage::readStepCand(_, c, _) and
        expectsContentEx(node, c) and
        c = ap.getAHead()
      )
    }

    bindingset[node, state, t0, ap]
    predicate filter(NodeEx node, FlowState state, Typ t0, Ap ap, Typ t) {
      exists(state) and
      // We can get away with not using type strengthening here, since we aren't
      // going to use the tracked types in the construction of Stage 4 access
      // paths. For Stage 4 and onwards, the tracked types must be consistent as
      // the cons candidates including types are used to construct subsequent
      // access path approximations.
      t0 = t and
      (if castingNodeEx(node) then compatibleTypes(node.getDataFlowType(), t0) else any()) and
      (
        notExpectsContent(node)
        or
        expectsContentCand(node, ap)
      )
    }

    bindingset[typ, contentType]
    predicate typecheckStore(Typ typ, DataFlowType contentType) {
      // We need to typecheck stores here, since reverse flow through a getter
      // might have a different type here compared to inside the getter.
      compatibleTypes(typ, contentType)
    }
  }

  private module Stage3 implements StageSig {
    import MkStage<Stage2>::Stage<Stage3Param>
  }

  bindingset[node, t0]
  private predicate strengthenType(NodeEx node, DataFlowType t0, DataFlowType t) {
    if castingNodeEx(node)
    then
      exists(DataFlowType nt | nt = node.getDataFlowType() |
        if typeStrongerThan(nt, t0) then t = nt else (compatibleTypes(nt, t0) and t = t0)
      )
    else t = t0
  }

  private module Stage4Param implements MkStage<Stage3>::StageParam {
    private module PrevStage = Stage3;

    class Typ = DataFlowType;

    class Ap = AccessPathFront;

    class ApNil = AccessPathFrontNil;

    PrevStage::Ap getApprox(Ap ap) { result = ap.toApprox() }

    Typ getTyp(DataFlowType t) { result = t }

    bindingset[c, t, tail]
    Ap apCons(Content c, Typ t, Ap tail) { result.getHead() = c and exists(t) and exists(tail) }

    class ApHeadContent = Content;

    pragma[noinline]
    ApHeadContent getHeadContent(Ap ap) { result = ap.getHead() }

    ApHeadContent projectToHeadContent(Content c) { result = c }

    class ApOption = AccessPathFrontOption;

    ApOption apNone() { result = TAccessPathFrontNone() }

    ApOption apSome(Ap ap) { result = TAccessPathFrontSome(ap) }

    import BooleanCallContext

    pragma[nomagic]
    predicate localStep(
      NodeEx node1, FlowState state1, NodeEx node2, FlowState state2, boolean preservesValue, Typ t,
      LocalCc lcc
    ) {
      localFlowBigStep(node1, state1, node2, state2, preservesValue, t, _) and
      PrevStage::revFlow(node1, pragma[only_bind_into](state1), _) and
      PrevStage::revFlow(node2, pragma[only_bind_into](state2), _) and
      exists(lcc)
    }

    pragma[nomagic]
    predicate flowOutOfCall(
      DataFlowCall call, RetNodeEx node1, ReturnKindExt kind, NodeEx node2, boolean allowsFieldFlow
    ) {
      exists(FlowState state |
        flowOutOfCallNodeCand2(call, node1, kind, node2, allowsFieldFlow) and
        PrevStage::revFlow(node2, pragma[only_bind_into](state), _) and
        PrevStage::revFlow(node1, pragma[only_bind_into](state), _)
      )
    }

    pragma[nomagic]
    predicate flowIntoCall(
      DataFlowCall call, ArgNodeEx node1, ParamNodeEx node2, boolean allowsFieldFlow
    ) {
      exists(FlowState state |
        flowIntoCallNodeCand2(call, node1, node2, allowsFieldFlow) and
        PrevStage::revFlow(node2, pragma[only_bind_into](state), _) and
        PrevStage::revFlow(node1, pragma[only_bind_into](state), _)
      )
    }

    pragma[nomagic]
    private predicate clearSet(NodeEx node, ContentSet c) {
      PrevStage::revFlow(node) and
      clearsContentCached(node.asNode(), c)
    }

    pragma[nomagic]
    private predicate clearContent(NodeEx node, Content c) {
      exists(ContentSet cs |
        PrevStage::readStepCand(_, pragma[only_bind_into](c), _) and
        c = cs.getAReadContent() and
        clearSet(node, cs)
      )
    }

    pragma[nomagic]
    private predicate clear(NodeEx node, Ap ap) { clearContent(node, ap.getHead()) }

    pragma[nomagic]
    private predicate expectsContentCand(NodeEx node, Ap ap) {
      exists(Content c |
        PrevStage::revFlow(node) and
        PrevStage::readStepCand(_, c, _) and
        expectsContentEx(node, c) and
        c = ap.getHead()
      )
    }

    bindingset[node, state, t0, ap]
    predicate filter(NodeEx node, FlowState state, Typ t0, Ap ap, Typ t) {
      exists(state) and
      not clear(node, ap) and
      strengthenType(node, t0, t) and
      (
        notExpectsContent(node)
        or
        expectsContentCand(node, ap)
      )
    }

    bindingset[typ, contentType]
    predicate typecheckStore(Typ typ, DataFlowType contentType) {
      // We need to typecheck stores here, since reverse flow through a getter
      // might have a different type here compared to inside the getter.
      compatibleTypes(typ, contentType)
    }
  }

  private module Stage4 implements StageSig {
    import MkStage<Stage3>::Stage<Stage4Param>
  }

  /**
   * Holds if `argApf` is recorded as the summary context for flow reaching `node`
   * and remains relevant for the following pruning stage.
   */
  private predicate flowCandSummaryCtx(NodeEx node, FlowState state, AccessPathFront argApf) {
    exists(AccessPathFront apf |
      Stage4::revFlow(node, state, TReturnCtxMaybeFlowThrough(_), _, apf) and
      Stage4::fwdFlow(node, state, any(Stage4::CcCall ccc), _, _, TAccessPathFrontSome(argApf), _,
        apf, _)
    )
  }

  /**
   * Holds if a length 2 access path approximation with the head `c` is expected
   * to be expensive.
   */
  private predicate expensiveLen2unfolding(Content c) {
    exists(int tails, int nodes, int apLimit, int tupleLimit |
      tails = strictcount(DataFlowType t, AccessPathFront apf | Stage4::consCand(c, t, apf)) and
      nodes =
        strictcount(NodeEx n, FlowState state |
          Stage4::revFlow(n, state, any(AccessPathFrontHead apf | apf.getHead() = c))
          or
          flowCandSummaryCtx(n, state, any(AccessPathFrontHead apf | apf.getHead() = c))
        ) and
      accessPathApproxCostLimits(apLimit, tupleLimit) and
      apLimit < tails and
      tupleLimit < (tails - 1) * nodes and
      not forceHighPrecision(c)
    )
  }

  private newtype TAccessPathApprox =
    TNil() or
    TConsNil(Content c, DataFlowType t) {
      Stage4::consCand(c, t, TFrontNil()) and
      not expensiveLen2unfolding(c)
    } or
    TConsCons(Content c1, DataFlowType t, Content c2, int len) {
      Stage4::consCand(c1, t, TFrontHead(c2)) and
      len in [2 .. accessPathLimit()] and
      not expensiveLen2unfolding(c1)
    } or
    TCons1(Content c, int len) {
      len in [1 .. accessPathLimit()] and
      expensiveLen2unfolding(c)
    }

  /**
   * Conceptually a list of `Content`s where nested tails are also paired with a
   * `DataFlowType`, but only the first two elements of the list and its length
   * are tracked. If data flows from a source to a given node with a given
   * `AccessPathApprox`, this indicates the sequence of dereference operations
   * needed to get from the value in the node to the tracked object. The
   * `DataFlowType`s indicate the types of the stored values.
   */
  abstract private class AccessPathApprox extends TAccessPathApprox {
    abstract string toString();

    abstract Content getHead();

    abstract int len();

    abstract AccessPathFront getFront();

    /** Holds if this is a representation of `head` followed by the `typ,tail` pair. */
    abstract predicate isCons(Content head, DataFlowType typ, AccessPathApprox tail);
  }

  private class AccessPathApproxNil extends AccessPathApprox, TNil {
    override string toString() { result = "" }

    override Content getHead() { none() }

    override int len() { result = 0 }

    override AccessPathFront getFront() { result = TFrontNil() }

    override predicate isCons(Content head, DataFlowType typ, AccessPathApprox tail) { none() }
  }

  abstract private class AccessPathApproxCons extends AccessPathApprox { }

  private class AccessPathApproxConsNil extends AccessPathApproxCons, TConsNil {
    private Content c;
    private DataFlowType t;

    AccessPathApproxConsNil() { this = TConsNil(c, t) }

    override string toString() {
      // The `concat` becomes "" if `ppReprType` has no result.
      result = "[" + c.toString() + "]" + concat(" : " + ppReprType(t))
    }

    override Content getHead() { result = c }

    override int len() { result = 1 }

    override AccessPathFront getFront() { result = TFrontHead(c) }

    override predicate isCons(Content head, DataFlowType typ, AccessPathApprox tail) {
      head = c and typ = t and tail = TNil()
    }
  }

  private class AccessPathApproxConsCons extends AccessPathApproxCons, TConsCons {
    private Content c1;
    private DataFlowType t;
    private Content c2;
    private int len;

    AccessPathApproxConsCons() { this = TConsCons(c1, t, c2, len) }

    override string toString() {
      if len = 2
      then result = "[" + c1.toString() + ", " + c2.toString() + "]"
      else result = "[" + c1.toString() + ", " + c2.toString() + ", ... (" + len.toString() + ")]"
    }

    override Content getHead() { result = c1 }

    override int len() { result = len }

    override AccessPathFront getFront() { result = TFrontHead(c1) }

    override predicate isCons(Content head, DataFlowType typ, AccessPathApprox tail) {
      head = c1 and
      typ = t and
      (
        tail = TConsCons(c2, _, _, len - 1)
        or
        len = 2 and
        tail = TConsNil(c2, _)
        or
        tail = TCons1(c2, len - 1)
      )
    }
  }

  private class AccessPathApproxCons1 extends AccessPathApproxCons, TCons1 {
    private Content c;
    private int len;

    AccessPathApproxCons1() { this = TCons1(c, len) }

    override string toString() {
      if len = 1
      then result = "[" + c.toString() + "]"
      else result = "[" + c.toString() + ", ... (" + len.toString() + ")]"
    }

    override Content getHead() { result = c }

    override int len() { result = len }

    override AccessPathFront getFront() { result = TFrontHead(c) }

    override predicate isCons(Content head, DataFlowType typ, AccessPathApprox tail) {
      head = c and
      (
        exists(Content c2 | Stage4::consCand(c, typ, TFrontHead(c2)) |
          tail = TConsCons(c2, _, _, len - 1)
          or
          len = 2 and
          tail = TConsNil(c2, _)
          or
          tail = TCons1(c2, len - 1)
        )
        or
        len = 1 and
        Stage4::consCand(c, typ, TFrontNil()) and
        tail = TNil()
      )
    }
  }

  private newtype TAccessPathApproxOption =
    TAccessPathApproxNone() or
    TAccessPathApproxSome(AccessPathApprox apa)

  private class AccessPathApproxOption extends TAccessPathApproxOption {
    string toString() {
      this = TAccessPathApproxNone() and result = "<none>"
      or
      this = TAccessPathApproxSome(any(AccessPathApprox apa | result = apa.toString()))
    }
  }

  private module Stage5Param implements MkStage<Stage4>::StageParam {
    private module PrevStage = Stage4;

    class Typ = DataFlowType;

    class Ap = AccessPathApprox;

    class ApNil = AccessPathApproxNil;

    pragma[nomagic]
    PrevStage::Ap getApprox(Ap ap) { result = ap.getFront() }

    Typ getTyp(DataFlowType t) { result = t }

    bindingset[c, t, tail]
    Ap apCons(Content c, Typ t, Ap tail) { result.isCons(c, t, tail) }

    class ApHeadContent = Content;

    pragma[noinline]
    ApHeadContent getHeadContent(Ap ap) { result = ap.getHead() }

    ApHeadContent projectToHeadContent(Content c) { result = c }

    class ApOption = AccessPathApproxOption;

    ApOption apNone() { result = TAccessPathApproxNone() }

    ApOption apSome(Ap ap) { result = TAccessPathApproxSome(ap) }

    import Level1CallContext
    import LocalCallContext

    predicate localStep(
      NodeEx node1, FlowState state1, NodeEx node2, FlowState state2, boolean preservesValue, Typ t,
      LocalCc lcc
    ) {
      localFlowBigStep(node1, state1, node2, state2, preservesValue, t, lcc) and
      PrevStage::revFlow(node1, pragma[only_bind_into](state1), _) and
      PrevStage::revFlow(node2, pragma[only_bind_into](state2), _)
    }

    pragma[nomagic]
    predicate flowOutOfCall(
      DataFlowCall call, RetNodeEx node1, ReturnKindExt kind, NodeEx node2, boolean allowsFieldFlow
    ) {
      exists(FlowState state |
        flowOutOfCallNodeCand2(call, node1, kind, node2, allowsFieldFlow) and
        PrevStage::revFlow(node2, pragma[only_bind_into](state), _) and
        PrevStage::revFlow(node1, pragma[only_bind_into](state), _)
      )
    }

    pragma[nomagic]
    predicate flowIntoCall(
      DataFlowCall call, ArgNodeEx node1, ParamNodeEx node2, boolean allowsFieldFlow
    ) {
      exists(FlowState state |
        flowIntoCallNodeCand2(call, node1, node2, allowsFieldFlow) and
        PrevStage::revFlow(node2, pragma[only_bind_into](state), _) and
        PrevStage::revFlow(node1, pragma[only_bind_into](state), _)
      )
    }

    bindingset[node, state, t0, ap]
    predicate filter(NodeEx node, FlowState state, Typ t0, Ap ap, Typ t) {
      strengthenType(node, t0, t) and
      exists(state) and
      exists(ap)
    }

    bindingset[typ, contentType]
    predicate typecheckStore(Typ typ, DataFlowType contentType) {
      compatibleTypes(typ, contentType)
    }
  }

  private module Stage5 = MkStage<Stage4>::Stage<Stage5Param>;

  pragma[nomagic]
  private predicate nodeMayUseSummary0(
    NodeEx n, ParamNodeEx p, FlowState state, AccessPathApprox apa
  ) {
    exists(AccessPathApprox apa0 |
      Stage5::parameterMayFlowThrough(p, _) and
      Stage5::revFlow(n, state, TReturnCtxMaybeFlowThrough(_), _, apa0) and
      Stage5::fwdFlow(n, state, any(CallContextCall ccc), TParamNodeSome(p.asNode()), _,
        TAccessPathApproxSome(apa), _, apa0, _)
    )
  }

  pragma[nomagic]
  private predicate nodeMayUseSummary(NodeEx n, FlowState state, AccessPathApprox apa) {
    exists(ParamNodeEx p |
      Stage5::parameterMayFlowThrough(p, apa) and
      nodeMayUseSummary0(n, p, state, apa)
    )
  }

  private newtype TSummaryCtx =
    TSummaryCtxNone() or
    TSummaryCtxSome(ParamNodeEx p, FlowState state, DataFlowType t, AccessPath ap) {
      exists(AccessPathApprox apa | ap.getApprox() = apa |
        Stage5::parameterMayFlowThrough(p, apa) and
        Stage5::fwdFlow(p, state, _, _, Option<DataFlowType>::some(t), _, _, apa, _) and
        Stage5::revFlow(p, state, _)
      )
    }

  /**
   * A context for generating flow summaries. This represents flow entry through
   * a specific parameter with an access path of a specific shape.
   *
   * Summaries are only created for parameters that may flow through.
   */
  abstract private class SummaryCtx extends TSummaryCtx {
    abstract string toString();
  }

  /** A summary context from which no flow summary can be generated. */
  private class SummaryCtxNone extends SummaryCtx, TSummaryCtxNone {
    override string toString() { result = "<none>" }
  }

  /** A summary context from which a flow summary can be generated. */
  private class SummaryCtxSome extends SummaryCtx, TSummaryCtxSome {
    private ParamNodeEx p;
    private FlowState s;
    private DataFlowType t;
    private AccessPath ap;

    SummaryCtxSome() { this = TSummaryCtxSome(p, s, t, ap) }

    ParamNodeEx getParamNode() { result = p }

    override string toString() { result = p + ": " + ap }

    predicate hasLocationInfo(
      string filepath, int startline, int startcolumn, int endline, int endcolumn
    ) {
      p.hasLocationInfo(filepath, startline, startcolumn, endline, endcolumn)
    }
  }

  /**
   * Gets the number of length 2 access path approximations that correspond to `apa`.
   */
  private int count1to2unfold(AccessPathApproxCons1 apa) {
    exists(Content c, int len |
      c = apa.getHead() and
      len = apa.len() and
      result =
        strictcount(DataFlowType t, AccessPathFront apf |
          Stage5::consCand(c, t,
            any(AccessPathApprox ap | ap.getFront() = apf and ap.len() = len - 1))
        )
    )
  }

  private int countNodesUsingAccessPath(AccessPathApprox apa) {
    result =
      strictcount(NodeEx n, FlowState state |
        Stage5::revFlow(n, state, apa) or nodeMayUseSummary(n, state, apa)
      )
  }

  /**
   * Holds if a length 2 access path approximation matching `apa` is expected
   * to be expensive.
   */
  private predicate expensiveLen1to2unfolding(AccessPathApproxCons1 apa) {
    exists(int aps, int nodes, int apLimit, int tupleLimit |
      aps = count1to2unfold(apa) and
      nodes = countNodesUsingAccessPath(apa) and
      accessPathCostLimits(apLimit, tupleLimit) and
      apLimit < aps and
      tupleLimit < (aps - 1) * nodes
    )
  }

  private predicate hasTail(AccessPathApprox apa, DataFlowType t, AccessPathApprox tail) {
    exists(Content head |
      apa.isCons(head, t, tail) and
      Stage5::consCand(head, t, tail)
    )
  }

  /**
   * Holds with `unfold = false` if a precise head-tail representation of `apa` is
   * expected to be expensive. Holds with `unfold = true` otherwise.
   */
  private predicate evalUnfold(AccessPathApprox apa, boolean unfold) {
    if forceHighPrecision(apa.getHead())
    then unfold = true
    else
      exists(int aps, int nodes, int apLimit, int tupleLimit |
        aps = countPotentialAps(apa) and
        nodes = countNodesUsingAccessPath(apa) and
        accessPathCostLimits(apLimit, tupleLimit) and
        if apLimit < aps and tupleLimit < (aps - 1) * nodes then unfold = false else unfold = true
      )
  }

  /**
   * Gets the number of `AccessPath`s that correspond to `apa`.
   */
  pragma[assume_small_delta]
  private int countAps(AccessPathApprox apa) {
    evalUnfold(apa, false) and
    result = 1 and
    (not apa instanceof AccessPathApproxCons1 or expensiveLen1to2unfolding(apa))
    or
    evalUnfold(apa, false) and
    result = count1to2unfold(apa) and
    not expensiveLen1to2unfolding(apa)
    or
    evalUnfold(apa, true) and
    result = countPotentialAps(apa)
  }

  /**
   * Gets the number of `AccessPath`s that would correspond to `apa` assuming
   * that it is expanded to a precise head-tail representation.
   */
  language[monotonicAggregates]
  pragma[assume_small_delta]
  private int countPotentialAps(AccessPathApprox apa) {
    apa instanceof AccessPathApproxNil and result = 1
    or
    result =
      strictsum(DataFlowType t, AccessPathApprox tail | hasTail(apa, t, tail) | countAps(tail))
  }

  private newtype TAccessPath =
    TAccessPathNil() or
    TAccessPathCons(Content head, DataFlowType t, AccessPath tail) {
      exists(AccessPathApproxCons apa |
        not evalUnfold(apa, false) and
        head = apa.getHead() and
        hasTail(apa, t, tail.getApprox())
      )
    } or
    TAccessPathCons2(Content head1, DataFlowType t, Content head2, int len) {
      exists(AccessPathApproxCons apa, AccessPathApprox tail |
        evalUnfold(apa, false) and
        not expensiveLen1to2unfolding(apa) and
        apa.len() = len and
        hasTail(apa, t, tail) and
        head1 = apa.getHead() and
        head2 = tail.getHead()
      )
    } or
    TAccessPathCons1(Content head, int len) {
      exists(AccessPathApproxCons apa |
        evalUnfold(apa, false) and
        expensiveLen1to2unfolding(apa) and
        apa.len() = len and
        head = apa.getHead()
      )
    }

  private newtype TPathNode =
    pragma[assume_small_delta]
    TPathNodeMid(
      NodeEx node, FlowState state, CallContext cc, SummaryCtx sc, DataFlowType t, AccessPath ap
    ) {
      // A PathNode is introduced by a source ...
      Stage5::revFlow(node, state) and
      sourceNode(node, state) and
      sourceCallCtx(cc) and
      sc instanceof SummaryCtxNone and
      t = node.getDataFlowType() and
      ap = TAccessPathNil()
      or
      // ... or a step from an existing PathNode to another node.
      pathStep(_, node, state, cc, sc, t, ap)
    } or
    TPathNodeSink(NodeEx node, FlowState state) {
      exists(PathNodeMid sink |
        sink.isAtSink() and
        node = sink.getNodeEx() and
        state = sink.getState()
      )
    } or
    TPathNodeSourceGroup(string sourceGroup) {
      exists(PathNodeImpl source | sourceGroup = source.getSourceGroup())
    } or
    TPathNodeSinkGroup(string sinkGroup) {
      exists(PathNodeSink sink | sinkGroup = sink.getSinkGroup())
    }

  /**
   * A list of `Content`s where nested tails are also paired with a
   * `DataFlowType`. If data flows from a source to a given node with a given
   * `AccessPath`, this indicates the sequence of dereference operations needed
   * to get from the value in the node to the tracked object. The
   * `DataFlowType`s indicate the types of the stored values.
   */
  private class AccessPath extends TAccessPath {
    /** Gets the head of this access path, if any. */
    abstract Content getHead();

    /** Holds if this is a representation of `head` followed by the `typ,tail` pair. */
    abstract predicate isCons(Content head, DataFlowType typ, AccessPath tail);

    /** Gets the front of this access path. */
    abstract AccessPathFront getFront();

    /** Gets the approximation of this access path. */
    abstract AccessPathApprox getApprox();

    /** Gets the length of this access path. */
    abstract int length();

    /** Gets a textual representation of this access path. */
    abstract string toString();
  }

  private class AccessPathNil extends AccessPath, TAccessPathNil {
    override Content getHead() { none() }

    override predicate isCons(Content head, DataFlowType typ, AccessPath tail) { none() }

    override AccessPathFrontNil getFront() { result = TFrontNil() }

    override AccessPathApproxNil getApprox() { result = TNil() }

    override int length() { result = 0 }

    override string toString() { result = "" }
  }

  private class AccessPathCons extends AccessPath, TAccessPathCons {
    private Content head_;
    private DataFlowType t;
    private AccessPath tail_;

    AccessPathCons() { this = TAccessPathCons(head_, t, tail_) }

    override Content getHead() { result = head_ }

    override predicate isCons(Content head, DataFlowType typ, AccessPath tail) {
      head = head_ and typ = t and tail = tail_
    }

    override AccessPathFrontHead getFront() { result = TFrontHead(head_) }

    pragma[assume_small_delta]
    override AccessPathApproxCons getApprox() {
      result = TConsNil(head_, t) and tail_ = TAccessPathNil()
      or
      result = TConsCons(head_, t, tail_.getHead(), this.length())
      or
      result = TCons1(head_, this.length())
    }

    pragma[assume_small_delta]
    override int length() { result = 1 + tail_.length() }

    private string toStringImpl(boolean needsSuffix) {
      tail_ = TAccessPathNil() and
      needsSuffix = false and
      result = head_.toString() + "]" + concat(" : " + ppReprType(t))
      or
      result = head_ + ", " + tail_.(AccessPathCons).toStringImpl(needsSuffix)
      or
      exists(Content c2, Content c3, int len | tail_ = TAccessPathCons2(c2, _, c3, len) |
        result = head_ + ", " + c2 + ", " + c3 + ", ... (" and len > 2 and needsSuffix = true
        or
        result = head_ + ", " + c2 + ", " + c3 + "]" and len = 2 and needsSuffix = false
      )
      or
      exists(Content c2, int len | tail_ = TAccessPathCons1(c2, len) |
        result = head_ + ", " + c2 + ", ... (" and len > 1 and needsSuffix = true
        or
        result = head_ + ", " + c2 + "]" and len = 1 and needsSuffix = false
      )
    }

    override string toString() {
      result = "[" + this.toStringImpl(true) + this.length().toString() + ")]"
      or
      result = "[" + this.toStringImpl(false)
    }
  }

  private class AccessPathCons2 extends AccessPath, TAccessPathCons2 {
    private Content head1;
    private DataFlowType t;
    private Content head2;
    private int len;

    AccessPathCons2() { this = TAccessPathCons2(head1, t, head2, len) }

    override Content getHead() { result = head1 }

    override predicate isCons(Content head, DataFlowType typ, AccessPath tail) {
      head = head1 and
      typ = t and
      Stage5::consCand(head1, t, tail.getApprox()) and
      tail.getHead() = head2 and
      tail.length() = len - 1
    }

    override AccessPathFrontHead getFront() { result = TFrontHead(head1) }

    override AccessPathApproxCons getApprox() {
      result = TConsCons(head1, t, head2, len) or
      result = TCons1(head1, len)
    }

    override int length() { result = len }

    override string toString() {
      if len = 2
      then result = "[" + head1.toString() + ", " + head2.toString() + "]"
      else
        result =
          "[" + head1.toString() + ", " + head2.toString() + ", ... (" + len.toString() + ")]"
    }
  }

  private class AccessPathCons1 extends AccessPath, TAccessPathCons1 {
    private Content head_;
    private int len;

    AccessPathCons1() { this = TAccessPathCons1(head_, len) }

    override Content getHead() { result = head_ }

    override predicate isCons(Content head, DataFlowType typ, AccessPath tail) {
      head = head_ and
      Stage5::consCand(head_, typ, tail.getApprox()) and
      tail.length() = len - 1
    }

    override AccessPathFrontHead getFront() { result = TFrontHead(head_) }

    override AccessPathApproxCons getApprox() { result = TCons1(head_, len) }

    override int length() { result = len }

    override string toString() {
      if len = 1
      then result = "[" + head_.toString() + "]"
      else result = "[" + head_.toString() + ", ... (" + len.toString() + ")]"
    }
  }

  abstract private class PathNodeImpl extends TPathNode {
    /** Gets the `FlowState` of this node. */
    abstract FlowState getState();

    /** Holds if this node is a source. */
    abstract predicate isSource();

    abstract PathNodeImpl getASuccessorImpl();

    private PathNodeImpl getASuccessorIfHidden() {
      this.isHidden() and
      result = this.getASuccessorImpl()
    }

    pragma[nomagic]
    private PathNodeImpl getANonHiddenSuccessor0() {
      result = this.getASuccessorIfHidden*() and
      not result.isHidden()
    }

    final PathNodeImpl getANonHiddenSuccessor() {
      result = this.getASuccessorImpl().getANonHiddenSuccessor0() and
      not this.isHidden()
    }

    abstract NodeEx getNodeEx();

    predicate isHidden() {
      not Config::includeHiddenNodes() and
      (
        hiddenNode(this.getNodeEx().asNode()) and
        not this.isSource() and
        not this instanceof PathNodeSink
        or
        this.getNodeEx() instanceof TNodeImplicitRead
      )
    }

    string getSourceGroup() {
      this.isSource() and
      Config::sourceGrouping(this.getNodeEx().asNode(), result)
    }

    predicate isFlowSource() {
      this.isSource() and not exists(this.getSourceGroup())
      or
      this instanceof PathNodeSourceGroup
    }

    predicate isFlowSink() {
      this = any(PathNodeSink sink | not exists(sink.getSinkGroup())) or
      this instanceof PathNodeSinkGroup
    }

    private string ppType() {
      this instanceof PathNodeSink and result = ""
      or
      exists(DataFlowType t | t = this.(PathNodeMid).getType() |
        // The `concat` becomes "" if `ppReprType` has no result.
        result = concat(" : " + ppReprType(t))
      )
    }

    private string ppAp() {
      this instanceof PathNodeSink and result = ""
      or
      exists(string s | s = this.(PathNodeMid).getAp().toString() |
        if s = "" then result = "" else result = " " + s
      )
    }

    private string ppCtx() {
      this instanceof PathNodeSink and result = ""
      or
      result = " <" + this.(PathNodeMid).getCallContext().toString() + ">"
    }

    /** Gets a textual representation of this element. */
    string toString() { result = this.getNodeEx().toString() + this.ppType() + this.ppAp() }

    /**
     * Gets a textual representation of this element, including a textual
     * representation of the call context.
     */
    string toStringWithContext() {
      result = this.getNodeEx().toString() + this.ppType() + this.ppAp() + this.ppCtx()
    }

    /**
     * Holds if this element is at the specified location.
     * The location spans column `startcolumn` of line `startline` to
     * column `endcolumn` of line `endline` in file `filepath`.
     * For more information, see
     * [Locations](https://codeql.github.com/docs/writing-codeql-queries/providing-locations-in-codeql-queries/).
     */
    predicate hasLocationInfo(
      string filepath, int startline, int startcolumn, int endline, int endcolumn
    ) {
      this.getNodeEx().hasLocationInfo(filepath, startline, startcolumn, endline, endcolumn)
    }
  }

  /** Holds if `n` can reach a sink. */
  private predicate directReach(PathNodeImpl n) {
    n instanceof PathNodeSink or
    n instanceof PathNodeSinkGroup or
    directReach(n.getANonHiddenSuccessor())
  }

  /** Holds if `n` can reach a sink or is used in a subpath that can reach a sink. */
  private predicate reach(PathNodeImpl n) { directReach(n) or Subpaths::retReach(n) }

  /** Holds if `n1.getASuccessor() = n2` and `n2` can reach a sink. */
  private predicate pathSucc(PathNodeImpl n1, PathNodeImpl n2) {
    n1.getANonHiddenSuccessor() = n2 and directReach(n2)
  }

  private predicate pathSuccPlus(PathNodeImpl n1, PathNodeImpl n2) = fastTC(pathSucc/2)(n1, n2)

  /**
   * A `Node` augmented with a call context (except for sinks) and an access path.
   * Only those `PathNode`s that are reachable from a source, and which can reach a sink, are generated.
   */
  class PathNode instanceof PathNodeImpl {
    PathNode() { reach(this) }

    /** Gets a textual representation of this element. */
    final string toString() { result = super.toString() }

    /**
     * Gets a textual representation of this element, including a textual
     * representation of the call context.
     */
    final string toStringWithContext() { result = super.toStringWithContext() }

    /**
     * Holds if this element is at the specified location.
     * The location spans column `startcolumn` of line `startline` to
     * column `endcolumn` of line `endline` in file `filepath`.
     * For more information, see
     * [Locations](https://codeql.github.com/docs/writing-codeql-queries/providing-locations-in-codeql-queries/).
     */
    final predicate hasLocationInfo(
      string filepath, int startline, int startcolumn, int endline, int endcolumn
    ) {
      super.hasLocationInfo(filepath, startline, startcolumn, endline, endcolumn)
    }

    /** Gets the underlying `Node`. */
    final Node getNode() { super.getNodeEx().projectToNode() = result }

    /** Gets the `FlowState` of this node. */
    final FlowState getState() { result = super.getState() }

    /** Gets a successor of this node, if any. */
    final PathNode getASuccessor() { result = super.getANonHiddenSuccessor() }

    /** Holds if this node is a source. */
    final predicate isSource() { super.isSource() }

    /** Holds if this node is a grouping of source nodes. */
    final predicate isSourceGroup(string group) { this = TPathNodeSourceGroup(group) }

    /** Holds if this node is a grouping of sink nodes. */
    final predicate isSinkGroup(string group) { this = TPathNodeSinkGroup(group) }
  }

  /**
   * Provides the query predicates needed to include a graph in a path-problem query.
   */
  module PathGraph implements PathGraphSig<PathNode> {
    /** Holds if `(a,b)` is an edge in the graph of data flow path explanations. */
    query predicate edges(PathNode a, PathNode b) { a.getASuccessor() = b }

    /** Holds if `n` is a node in the graph of data flow path explanations. */
    query predicate nodes(PathNode n, string key, string val) {
      key = "semmle.label" and val = n.toString()
    }

    /**
     * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
     * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
     * `ret -> out` is summarized as the edge `arg -> out`.
     */
    query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
      Subpaths::subpaths(arg, par, ret, out)
    }
  }

  /**
   * An intermediate flow graph node. This is a tuple consisting of a `Node`,
   * a `FlowState`, a `CallContext`, a `SummaryCtx`, and an `AccessPath`.
   */
  private class PathNodeMid extends PathNodeImpl, TPathNodeMid {
    NodeEx node;
    FlowState state;
    CallContext cc;
    SummaryCtx sc;
    DataFlowType t;
    AccessPath ap;

    PathNodeMid() { this = TPathNodeMid(node, state, cc, sc, t, ap) }

    override NodeEx getNodeEx() { result = node }

    override FlowState getState() { result = state }

    CallContext getCallContext() { result = cc }

    SummaryCtx getSummaryCtx() { result = sc }

    DataFlowType getType() { result = t }

    AccessPath getAp() { result = ap }

    private PathNodeMid getSuccMid() {
      pathStep(this, result.getNodeEx(), result.getState(), result.getCallContext(),
        result.getSummaryCtx(), result.getType(), result.getAp())
    }

    override PathNodeImpl getASuccessorImpl() {
      // an intermediate step to another intermediate node
      result = this.getSuccMid()
      or
      // a final step to a sink
      result = this.getSuccMid().projectToSink()
    }

    override predicate isSource() {
      sourceNode(node, state) and
      sourceCallCtx(cc) and
      sc instanceof SummaryCtxNone and
      t = node.getDataFlowType() and
      ap = TAccessPathNil()
    }

    predicate isAtSink() {
      sinkNode(node, state) and
      ap instanceof AccessPathNil and
      if hasSinkCallCtx()
      then
        // For `FeatureHasSinkCallContext` the condition `cc instanceof CallContextNoCall`
        // is exactly what we need to check. This also implies
        // `sc instanceof SummaryCtxNone`.
        // For `FeatureEqualSourceSinkCallContext` the initial call context was
        // set to `CallContextSomeCall` and jumps are disallowed, so
        // `cc instanceof CallContextNoCall` never holds. On the other hand,
        // in this case there's never any need to enter a call except to identify
        // a summary, so the condition in `pathIntoCallable` enforces this, which
        // means that `sc instanceof SummaryCtxNone` holds if and only if we are
        // in the call context of the source.
        sc instanceof SummaryCtxNone or
        cc instanceof CallContextNoCall
      else any()
    }

    PathNodeSink projectToSink() {
      this.isAtSink() and
      result.getNodeEx() = node and
      result.getState() = state
    }
  }

  /**
   * A flow graph node corresponding to a sink. This is disjoint from the
   * intermediate nodes in order to uniquely correspond to a given sink by
   * excluding the `CallContext`.
   */
  private class PathNodeSink extends PathNodeImpl, TPathNodeSink {
    NodeEx node;
    FlowState state;

    PathNodeSink() { this = TPathNodeSink(node, state) }

    override NodeEx getNodeEx() { result = node }

    override FlowState getState() { result = state }

    override PathNodeImpl getASuccessorImpl() { result = TPathNodeSinkGroup(this.getSinkGroup()) }

    override predicate isSource() { sourceNode(node, state) }

    string getSinkGroup() { Config::sinkGrouping(node.asNode(), result) }
  }

  private class PathNodeSourceGroup extends PathNodeImpl, TPathNodeSourceGroup {
    string sourceGroup;

    PathNodeSourceGroup() { this = TPathNodeSourceGroup(sourceGroup) }

    override NodeEx getNodeEx() { none() }

    override FlowState getState() { none() }

    override PathNodeImpl getASuccessorImpl() { result.getSourceGroup() = sourceGroup }

    override predicate isSource() { none() }

    override string toString() { result = sourceGroup }

    override predicate hasLocationInfo(
      string filepath, int startline, int startcolumn, int endline, int endcolumn
    ) {
      filepath = "" and startline = 0 and startcolumn = 0 and endline = 0 and endcolumn = 0
    }
  }

  private class PathNodeSinkGroup extends PathNodeImpl, TPathNodeSinkGroup {
    string sinkGroup;

    PathNodeSinkGroup() { this = TPathNodeSinkGroup(sinkGroup) }

    override NodeEx getNodeEx() { none() }

    override FlowState getState() { none() }

    override PathNodeImpl getASuccessorImpl() { none() }

    override predicate isSource() { none() }

    override string toString() { result = sinkGroup }

    override predicate hasLocationInfo(
      string filepath, int startline, int startcolumn, int endline, int endcolumn
    ) {
      filepath = "" and startline = 0 and startcolumn = 0 and endline = 0 and endcolumn = 0
    }
  }

  private predicate pathNode(
    PathNodeMid mid, NodeEx midnode, FlowState state, CallContext cc, SummaryCtx sc, DataFlowType t,
    AccessPath ap, LocalCallContext localCC
  ) {
    midnode = mid.getNodeEx() and
    state = mid.getState() and
    cc = mid.getCallContext() and
    sc = mid.getSummaryCtx() and
    localCC =
      getLocalCallContext(pragma[only_bind_into](pragma[only_bind_out](cc)),
        midnode.getEnclosingCallable()) and
    t = mid.getType() and
    ap = mid.getAp()
  }

  private predicate pathStep(
    PathNodeMid mid, NodeEx node, FlowState state, CallContext cc, SummaryCtx sc, DataFlowType t,
    AccessPath ap
  ) {
    exists(DataFlowType t0 |
      pathStep0(mid, node, state, cc, sc, t0, ap) and
      Stage5::revFlow(node, state, ap.getApprox()) and
      strengthenType(node, t0, t)
    )
  }

  /**
   * Holds if data may flow from `mid` to `node`. The last step in or out of
   * a callable is recorded by `cc`.
   */
  pragma[assume_small_delta]
  pragma[nomagic]
  private predicate pathStep0(
    PathNodeMid mid, NodeEx node, FlowState state, CallContext cc, SummaryCtx sc, DataFlowType t,
    AccessPath ap
  ) {
    exists(NodeEx midnode, FlowState state0, LocalCallContext localCC |
      pathNode(mid, midnode, state0, cc, sc, t, ap, localCC) and
      localFlowBigStep(midnode, state0, node, state, true, _, localCC)
    )
    or
    exists(NodeEx midnode, FlowState state0, LocalCallContext localCC |
      pathNode(mid, midnode, state0, cc, sc, _, ap, localCC) and
      localFlowBigStep(midnode, state0, node, state, false, t, localCC) and
      ap instanceof AccessPathNil
    )
    or
    jumpStepEx(mid.getNodeEx(), node) and
    state = mid.getState() and
    cc instanceof CallContextAny and
    sc instanceof SummaryCtxNone and
    t = mid.getType() and
    ap = mid.getAp()
    or
    additionalJumpStep(mid.getNodeEx(), node) and
    state = mid.getState() and
    cc instanceof CallContextAny and
    sc instanceof SummaryCtxNone and
    mid.getAp() instanceof AccessPathNil and
    t = node.getDataFlowType() and
    ap = TAccessPathNil()
    or
    additionalJumpStateStep(mid.getNodeEx(), mid.getState(), node, state) and
    cc instanceof CallContextAny and
    sc instanceof SummaryCtxNone and
    mid.getAp() instanceof AccessPathNil and
    t = node.getDataFlowType() and
    ap = TAccessPathNil()
    or
    exists(Content c, DataFlowType t0, AccessPath ap0 |
      pathStoreStep(mid, node, state, t0, ap0, c, t, cc) and
      ap.isCons(c, t0, ap0) and
      sc = mid.getSummaryCtx()
    )
    or
    exists(Content c, AccessPath ap0 |
      pathReadStep(mid, node, state, ap0, c, cc) and
      ap0.isCons(c, t, ap) and
      sc = mid.getSummaryCtx()
    )
    or
    pathIntoCallable(mid, node, state, _, cc, sc, _) and t = mid.getType() and ap = mid.getAp()
    or
    pathOutOfCallable(mid, node, state, cc) and
    t = mid.getType() and
    ap = mid.getAp() and
    sc instanceof SummaryCtxNone
    or
    pathThroughCallable(mid, node, state, cc, t, ap) and sc = mid.getSummaryCtx()
  }

  pragma[nomagic]
  private predicate pathReadStep(
    PathNodeMid mid, NodeEx node, FlowState state, AccessPath ap0, Content c, CallContext cc
  ) {
    ap0 = mid.getAp() and
    c = ap0.getHead() and
    Stage5::readStepCand(mid.getNodeEx(), c, node) and
    state = mid.getState() and
    cc = mid.getCallContext()
  }

  pragma[nomagic]
  private predicate pathStoreStep(
    PathNodeMid mid, NodeEx node, FlowState state, DataFlowType t0, AccessPath ap0, Content c,
    DataFlowType t, CallContext cc
  ) {
    exists(DataFlowType contentType |
      t0 = mid.getType() and
      ap0 = mid.getAp() and
      Stage5::storeStepCand(mid.getNodeEx(), _, c, node, contentType, t) and
      state = mid.getState() and
      cc = mid.getCallContext() and
      compatibleTypes(t0, contentType)
    )
  }

  private predicate pathOutOfCallable0(
    PathNodeMid mid, ReturnPosition pos, FlowState state, CallContext innercc, AccessPathApprox apa
  ) {
    pos = mid.getNodeEx().(RetNodeEx).getReturnPosition() and
    state = mid.getState() and
    innercc = mid.getCallContext() and
    innercc instanceof CallContextNoCall and
    apa = mid.getAp().getApprox()
  }

  pragma[nomagic]
  private predicate pathOutOfCallable1(
    PathNodeMid mid, DataFlowCall call, ReturnKindExt kind, FlowState state, CallContext cc,
    AccessPathApprox apa
  ) {
    exists(ReturnPosition pos, DataFlowCallable c, CallContext innercc |
      pathOutOfCallable0(mid, pos, state, innercc, apa) and
      c = pos.getCallable() and
      kind = pos.getKind() and
      resolveReturn(innercc, c, call)
    |
      if reducedViableImplInReturn(c, call) then cc = TReturn(c, call) else cc = TAnyCallContext()
    )
  }

  pragma[noinline]
  private NodeEx getAnOutNodeFlow(ReturnKindExt kind, DataFlowCall call, AccessPathApprox apa) {
    result.asNode() = kind.getAnOutNode(call) and
    Stage5::revFlow(result, _, apa)
  }

  /**
   * Holds if data may flow from `mid` to `out`. The last step of this path
   * is a return from a callable and is recorded by `cc`, if needed.
   */
  pragma[noinline]
  private predicate pathOutOfCallable(PathNodeMid mid, NodeEx out, FlowState state, CallContext cc) {
    exists(ReturnKindExt kind, DataFlowCall call, AccessPathApprox apa |
      pathOutOfCallable1(mid, call, kind, state, cc, apa) and
      out = getAnOutNodeFlow(kind, call, apa)
    )
  }

  /**
   * Holds if data may flow from `mid` to the `i`th argument of `call` in `cc`.
   */
  pragma[noinline]
  private predicate pathIntoArg(
    PathNodeMid mid, ParameterPosition ppos, FlowState state, CallContext cc, DataFlowCall call,
    DataFlowType t, AccessPath ap, AccessPathApprox apa
  ) {
    exists(ArgNodeEx arg, ArgumentPosition apos |
      pathNode(mid, arg, state, cc, _, t, ap, _) and
      arg.asNode().(ArgNode).argumentOf(call, apos) and
      apa = ap.getApprox() and
      parameterMatch(ppos, apos)
    )
  }

  pragma[nomagic]
  private predicate parameterCand(
    DataFlowCallable callable, ParameterPosition pos, AccessPathApprox apa
  ) {
    exists(ParamNodeEx p |
      Stage5::revFlow(p, _, apa) and
      p.isParameterOf(callable, pos)
    )
  }

  pragma[nomagic]
  private predicate pathIntoCallable0(
    PathNodeMid mid, DataFlowCallable callable, ParameterPosition pos, FlowState state,
    CallContext outercc, DataFlowCall call, DataFlowType t, AccessPath ap
  ) {
    exists(AccessPathApprox apa |
      pathIntoArg(mid, pragma[only_bind_into](pos), state, outercc, call, t, ap,
        pragma[only_bind_into](apa)) and
      callable = resolveCall(call, outercc) and
      parameterCand(callable, pragma[only_bind_into](pos), pragma[only_bind_into](apa))
    )
  }

  /**
   * Holds if data may flow from `mid` to `p` through `call`. The contexts
   * before and after entering the callable are `outercc` and `innercc`,
   * respectively.
   */
  pragma[nomagic]
  private predicate pathIntoCallable(
    PathNodeMid mid, ParamNodeEx p, FlowState state, CallContext outercc, CallContextCall innercc,
    SummaryCtx sc, DataFlowCall call
  ) {
    exists(ParameterPosition pos, DataFlowCallable callable, DataFlowType t, AccessPath ap |
      pathIntoCallable0(mid, callable, pos, state, outercc, call, t, ap) and
      p.isParameterOf(callable, pos) and
      (
        sc = TSummaryCtxSome(p, state, t, ap)
        or
        not exists(TSummaryCtxSome(p, state, t, ap)) and
        sc = TSummaryCtxNone() and
        // When the call contexts of source and sink needs to match then there's
        // never any reason to enter a callable except to find a summary. See also
        // the comment in `PathNodeMid::isAtSink`.
        not Config::getAFeature() instanceof FeatureEqualSourceSinkCallContext
      )
    |
      if recordDataFlowCallSite(call, callable)
      then innercc = TSpecificCall(call)
      else innercc = TSomeCall()
    )
  }

  /** Holds if data may flow from a parameter given by `sc` to a return of kind `kind`. */
  pragma[nomagic]
  private predicate paramFlowsThrough(
    ReturnKindExt kind, FlowState state, CallContextCall cc, SummaryCtxSome sc, DataFlowType t,
    AccessPath ap, AccessPathApprox apa
  ) {
    exists(RetNodeEx ret |
      pathNode(_, ret, state, cc, sc, t, ap, _) and
      kind = ret.getKind() and
      apa = ap.getApprox() and
      parameterFlowThroughAllowed(sc.getParamNode(), kind)
    )
  }

  pragma[assume_small_delta]
  pragma[nomagic]
  private predicate pathThroughCallable0(
    DataFlowCall call, PathNodeMid mid, ReturnKindExt kind, FlowState state, CallContext cc,
    DataFlowType t, AccessPath ap, AccessPathApprox apa
  ) {
    exists(CallContext innercc, SummaryCtx sc |
      pathIntoCallable(mid, _, _, cc, innercc, sc, call) and
      paramFlowsThrough(kind, state, innercc, sc, t, ap, apa)
    )
  }

  /**
   * Holds if data may flow from `mid` through a callable to the node `out`.
   * The context `cc` is restored to its value prior to entering the callable.
   */
  pragma[noinline]
  private predicate pathThroughCallable(
    PathNodeMid mid, NodeEx out, FlowState state, CallContext cc, DataFlowType t, AccessPath ap
  ) {
    exists(DataFlowCall call, ReturnKindExt kind, AccessPathApprox apa |
      pathThroughCallable0(call, mid, kind, state, cc, t, ap, apa) and
      out = getAnOutNodeFlow(kind, call, apa)
    )
  }

  private module Subpaths {
    /**
     * Holds if `(arg, par, ret, out)` forms a subpath-tuple and `ret` is determined by
     * `kind`, `sc`, `apout`, and `innercc`.
     */
    pragma[nomagic]
    private predicate subpaths01(
      PathNodeImpl arg, ParamNodeEx par, SummaryCtxSome sc, CallContext innercc, ReturnKindExt kind,
      NodeEx out, FlowState sout, DataFlowType t, AccessPath apout
    ) {
      pathThroughCallable(arg, out, pragma[only_bind_into](sout), _, pragma[only_bind_into](t),
        pragma[only_bind_into](apout)) and
      pathIntoCallable(arg, par, _, _, innercc, sc, _) and
      paramFlowsThrough(kind, pragma[only_bind_into](sout), innercc, sc, pragma[only_bind_into](t),
        pragma[only_bind_into](apout), _) and
      not arg.isHidden()
    }

    /**
     * Holds if `(arg, par, ret, out)` forms a subpath-tuple and `ret` is determined by
     * `kind`, `sc`, `sout`, `apout`, and `innercc`.
     */
    pragma[nomagic]
    private predicate subpaths02(
      PathNodeImpl arg, ParamNodeEx par, SummaryCtxSome sc, CallContext innercc, ReturnKindExt kind,
      NodeEx out, FlowState sout, DataFlowType t, AccessPath apout
    ) {
      subpaths01(arg, par, sc, innercc, kind, out, sout, t, apout) and
      out.asNode() = kind.getAnOutNode(_)
    }

    /**
     * Holds if `(arg, par, ret, out)` forms a subpath-tuple.
     */
    pragma[nomagic]
    private predicate subpaths03(
      PathNodeImpl arg, ParamNodeEx par, PathNodeMid ret, NodeEx out, FlowState sout,
      DataFlowType t, AccessPath apout
    ) {
      exists(SummaryCtxSome sc, CallContext innercc, ReturnKindExt kind, RetNodeEx retnode |
        subpaths02(arg, par, sc, innercc, kind, out, sout, t, apout) and
        pathNode(ret, retnode, sout, innercc, sc, t, apout, _) and
        kind = retnode.getKind()
      )
    }

    private PathNodeImpl localStepToHidden(PathNodeImpl n) {
      n.getASuccessorImpl() = result and
      result.isHidden() and
      exists(NodeEx n1, NodeEx n2 | n1 = n.getNodeEx() and n2 = result.getNodeEx() |
        localFlowBigStep(n1, _, n2, _, _, _, _) or
        storeEx(n1, _, n2, _, _) or
        readSetEx(n1, _, n2)
      )
    }

    pragma[nomagic]
    private predicate hasSuccessor(PathNodeImpl pred, PathNodeMid succ, NodeEx succNode) {
      succ = pred.getANonHiddenSuccessor() and
      succNode = succ.getNodeEx()
    }

    /**
     * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
     * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
     * `ret -> out` is summarized as the edge `arg -> out`.
     */
    predicate subpaths(PathNodeImpl arg, PathNodeImpl par, PathNodeImpl ret, PathNodeImpl out) {
      exists(
        ParamNodeEx p, NodeEx o, FlowState sout, DataFlowType t, AccessPath apout, PathNodeMid out0
      |
        pragma[only_bind_into](arg).getANonHiddenSuccessor() = pragma[only_bind_into](out0) and
        subpaths03(pragma[only_bind_into](arg), p, localStepToHidden*(ret), o, sout, t, apout) and
        hasSuccessor(pragma[only_bind_into](arg), par, p) and
        not ret.isHidden() and
        pathNode(out0, o, sout, _, _, t, apout, _)
      |
        out = out0 or out = out0.projectToSink()
      )
    }

    /**
     * Holds if `n` can reach a return node in a summarized subpath that can reach a sink.
     */
    predicate retReach(PathNodeImpl n) {
      exists(PathNodeImpl out | subpaths(_, _, n, out) | directReach(out) or retReach(out))
      or
      exists(PathNodeImpl mid |
        retReach(mid) and
        n.getANonHiddenSuccessor() = mid and
        not subpaths(_, mid, _, _)
      )
    }
  }

  /**
   * Holds if data can flow from `source` to `sink`.
   *
   * The corresponding paths are generated from the end-points and the graph
   * included in the module `PathGraph`.
   */
  predicate flowPath(PathNode source, PathNode sink) {
    exists(PathNodeImpl flowsource, PathNodeImpl flowsink |
      source = flowsource and sink = flowsink
    |
      flowsource.isFlowSource() and
      (flowsource = flowsink or pathSuccPlus(flowsource, flowsink)) and
      flowsink.isFlowSink()
    )
  }

  /** DEPRECATED: Use `flowPath` instead. */
  deprecated predicate hasFlowPath = flowPath/2;

  private predicate flowsTo(PathNodeImpl flowsource, PathNodeSink flowsink, Node source, Node sink) {
    flowsource.isSource() and
    flowsource.getNodeEx().asNode() = source and
    (flowsource = flowsink or pathSuccPlus(flowsource, flowsink)) and
    flowsink.getNodeEx().asNode() = sink
  }

  /**
   * Holds if data can flow from `source` to `sink`.
   */
  predicate flow(Node source, Node sink) { flowsTo(_, _, source, sink) }

  /** DEPRECATED: Use `flow` instead. */
  deprecated predicate hasFlow = flow/2;

  /**
   * Holds if data can flow from some source to `sink`.
   */
  predicate flowTo(Node sink) { sink = any(PathNodeSink n).getNodeEx().asNode() }

  /** DEPRECATED: Use `flowTo` instead. */
  deprecated predicate hasFlowTo = flowTo/1;

  /**
   * Holds if data can flow from some source to `sink`.
   */
  predicate flowToExpr(DataFlowExpr sink) { flowTo(exprNode(sink)) }

  /** DEPRECATED: Use `flowToExpr` instead. */
  deprecated predicate hasFlowToExpr = flowToExpr/1;

  private predicate finalStats(
    boolean fwd, int nodes, int fields, int conscand, int states, int tuples
  ) {
    fwd = true and
    nodes = count(NodeEx n0 | exists(PathNodeImpl pn | pn.getNodeEx() = n0)) and
    fields = count(Content f0 | exists(PathNodeMid pn | pn.getAp().getHead() = f0)) and
    conscand = count(AccessPath ap | exists(PathNodeMid pn | pn.getAp() = ap)) and
    states = count(FlowState state | exists(PathNodeMid pn | pn.getState() = state)) and
    tuples = count(PathNodeImpl pn)
    or
    fwd = false and
    nodes = count(NodeEx n0 | exists(PathNodeImpl pn | pn.getNodeEx() = n0 and reach(pn))) and
    fields = count(Content f0 | exists(PathNodeMid pn | pn.getAp().getHead() = f0 and reach(pn))) and
    conscand = count(AccessPath ap | exists(PathNodeMid pn | pn.getAp() = ap and reach(pn))) and
    states = count(FlowState state | exists(PathNodeMid pn | pn.getState() = state and reach(pn))) and
    tuples = count(PathNode pn)
  }

  /**
   * INTERNAL: Only for debugging.
   *
   * Calculates per-stage metrics for data flow.
   */
  predicate stageStats(
    int n, string stage, int nodes, int fields, int conscand, int states, int tuples
  ) {
    stage = "1 Fwd" and
    n = 10 and
    Stage1::stats(true, nodes, fields, conscand, states, tuples)
    or
    stage = "1 Rev" and
    n = 15 and
    Stage1::stats(false, nodes, fields, conscand, states, tuples)
    or
    stage = "2 Fwd" and
    n = 20 and
    Stage2::stats(true, nodes, fields, conscand, states, tuples)
    or
    stage = "2 Rev" and
    n = 25 and
    Stage2::stats(false, nodes, fields, conscand, states, tuples)
    or
    stage = "3 Fwd" and
    n = 30 and
    Stage3::stats(true, nodes, fields, conscand, states, tuples)
    or
    stage = "3 Rev" and
    n = 35 and
    Stage3::stats(false, nodes, fields, conscand, states, tuples)
    or
    stage = "4 Fwd" and
    n = 40 and
    Stage4::stats(true, nodes, fields, conscand, states, tuples)
    or
    stage = "4 Rev" and
    n = 45 and
    Stage4::stats(false, nodes, fields, conscand, states, tuples)
    or
    stage = "5 Fwd" and
    n = 50 and
    Stage5::stats(true, nodes, fields, conscand, states, tuples)
    or
    stage = "5 Rev" and
    n = 55 and
    Stage5::stats(false, nodes, fields, conscand, states, tuples)
    or
    stage = "6 Fwd" and n = 60 and finalStats(true, nodes, fields, conscand, states, tuples)
    or
    stage = "6 Rev" and n = 65 and finalStats(false, nodes, fields, conscand, states, tuples)
  }

  module FlowExploration<explorationLimitSig/0 explorationLimit> {
    private predicate callableStep(DataFlowCallable c1, DataFlowCallable c2) {
      exists(NodeEx node1, NodeEx node2 |
        jumpStepEx(node1, node2)
        or
        additionalJumpStep(node1, node2)
        or
        additionalJumpStateStep(node1, _, node2, _)
        or
        // flow into callable
        viableParamArgEx(_, node2, node1)
        or
        // flow out of a callable
        viableReturnPosOutEx(_, node1.(RetNodeEx).getReturnPosition(), node2)
      |
        c1 = node1.getEnclosingCallable() and
        c2 = node2.getEnclosingCallable() and
        c1 != c2
      )
    }

    private predicate interestingCallableSrc(DataFlowCallable c) {
      exists(Node n | Config::isSource(n, _) and c = getNodeEnclosingCallable(n))
      or
      exists(DataFlowCallable mid | interestingCallableSrc(mid) and callableStep(mid, c))
    }

    private predicate interestingCallableSink(DataFlowCallable c) {
      exists(Node n | Config::isSink(n, _) and c = getNodeEnclosingCallable(n))
      or
      exists(DataFlowCallable mid | interestingCallableSink(mid) and callableStep(c, mid))
    }

    private newtype TCallableExt =
      TCallable(DataFlowCallable c) {
        interestingCallableSrc(c) or
        interestingCallableSink(c)
      } or
      TCallableSrc() or
      TCallableSink()

    private predicate callableExtSrc(TCallableSrc src) { any() }

    private predicate callableExtSink(TCallableSink sink) { any() }

    private predicate callableExtStepFwd(TCallableExt ce1, TCallableExt ce2) {
      exists(DataFlowCallable c1, DataFlowCallable c2 |
        callableStep(c1, c2) and
        ce1 = TCallable(c1) and
        ce2 = TCallable(c2)
      )
      or
      exists(Node n |
        ce1 = TCallableSrc() and
        Config::isSource(n, _) and
        ce2 = TCallable(getNodeEnclosingCallable(n))
      )
      or
      exists(Node n |
        ce2 = TCallableSink() and
        Config::isSink(n, _) and
        ce1 = TCallable(getNodeEnclosingCallable(n))
      )
    }

    private predicate callableExtStepRev(TCallableExt ce1, TCallableExt ce2) {
      callableExtStepFwd(ce2, ce1)
    }

    private int distSrcExt(TCallableExt c) =
      shortestDistances(callableExtSrc/1, callableExtStepFwd/2)(_, c, result)

    private int distSinkExt(TCallableExt c) =
      shortestDistances(callableExtSink/1, callableExtStepRev/2)(_, c, result)

    private int distSrc(DataFlowCallable c) { result = distSrcExt(TCallable(c)) - 1 }

    private int distSink(DataFlowCallable c) { result = distSinkExt(TCallable(c)) - 1 }

    private newtype TPartialAccessPath =
      TPartialNil() or
      TPartialCons(Content c, int len) { len in [1 .. accessPathLimit()] }

    /**
     * Conceptually a list of `Content`s, but only the first
     * element of the list and its length are tracked.
     */
    private class PartialAccessPath extends TPartialAccessPath {
      abstract string toString();

      Content getHead() { this = TPartialCons(result, _) }

      int len() {
        this = TPartialNil() and result = 0
        or
        this = TPartialCons(_, result)
      }
    }

    private class PartialAccessPathNil extends PartialAccessPath, TPartialNil {
      override string toString() { result = "" }
    }

    private class PartialAccessPathCons extends PartialAccessPath, TPartialCons {
      override string toString() {
        exists(Content c, int len | this = TPartialCons(c, len) |
          if len = 1
          then result = "[" + c.toString() + "]"
          else result = "[" + c.toString() + ", ... (" + len.toString() + ")]"
        )
      }
    }

    private predicate relevantState(FlowState state) {
      sourceNode(_, state) or
      sinkNode(_, state) or
      additionalLocalStateStep(_, state, _, _) or
      additionalLocalStateStep(_, _, _, state) or
      additionalJumpStateStep(_, state, _, _) or
      additionalJumpStateStep(_, _, _, state)
    }

    private newtype TSummaryCtx1 =
      TSummaryCtx1None() or
      TSummaryCtx1Param(ParamNodeEx p)

    private newtype TSummaryCtx2 =
      TSummaryCtx2None() or
      TSummaryCtx2Some(FlowState s) { relevantState(s) }

    private newtype TSummaryCtx3 =
      TSummaryCtx3None() or
      TSummaryCtx3Some(DataFlowType t)

    private newtype TSummaryCtx4 =
      TSummaryCtx4None() or
      TSummaryCtx4Some(PartialAccessPath ap)

    private newtype TRevSummaryCtx1 =
      TRevSummaryCtx1None() or
      TRevSummaryCtx1Some(ReturnPosition pos)

    private newtype TRevSummaryCtx2 =
      TRevSummaryCtx2None() or
      TRevSummaryCtx2Some(FlowState s) { relevantState(s) }

    private newtype TRevSummaryCtx3 =
      TRevSummaryCtx3None() or
      TRevSummaryCtx3Some(PartialAccessPath ap)

    private newtype TPartialPathNode =
      TPartialPathNodeFwd(
        NodeEx node, FlowState state, CallContext cc, TSummaryCtx1 sc1, TSummaryCtx2 sc2,
        TSummaryCtx3 sc3, TSummaryCtx4 sc4, DataFlowType t, PartialAccessPath ap
      ) {
        sourceNode(node, state) and
        cc instanceof CallContextAny and
        sc1 = TSummaryCtx1None() and
        sc2 = TSummaryCtx2None() and
        sc3 = TSummaryCtx3None() and
        sc4 = TSummaryCtx4None() and
        t = node.getDataFlowType() and
        ap = TPartialNil() and
        exists(explorationLimit())
        or
        partialPathStep(_, node, state, cc, sc1, sc2, sc3, sc4, t, ap) and
        distSrc(node.getEnclosingCallable()) <= explorationLimit()
      } or
      TPartialPathNodeRev(
        NodeEx node, FlowState state, TRevSummaryCtx1 sc1, TRevSummaryCtx2 sc2, TRevSummaryCtx3 sc3,
        PartialAccessPath ap
      ) {
        sinkNode(node, state) and
        sc1 = TRevSummaryCtx1None() and
        sc2 = TRevSummaryCtx2None() and
        sc3 = TRevSummaryCtx3None() and
        ap = TPartialNil() and
        exists(explorationLimit())
        or
        revPartialPathStep(_, node, state, sc1, sc2, sc3, ap) and
        not clearsContentEx(node, ap.getHead()) and
        (
          notExpectsContent(node) or
          expectsContentEx(node, ap.getHead())
        ) and
        not fullBarrier(node) and
        not stateBarrier(node, state) and
        distSink(node.getEnclosingCallable()) <= explorationLimit()
      }

    pragma[nomagic]
    private predicate partialPathStep(
      PartialPathNodeFwd mid, NodeEx node, FlowState state, CallContext cc, TSummaryCtx1 sc1,
      TSummaryCtx2 sc2, TSummaryCtx3 sc3, TSummaryCtx4 sc4, DataFlowType t, PartialAccessPath ap
    ) {
      partialPathStep1(mid, node, state, cc, sc1, sc2, sc3, sc4, _, t, ap)
    }

    pragma[nomagic]
    private predicate partialPathStep1(
      PartialPathNodeFwd mid, NodeEx node, FlowState state, CallContext cc, TSummaryCtx1 sc1,
      TSummaryCtx2 sc2, TSummaryCtx3 sc3, TSummaryCtx4 sc4, DataFlowType t0, DataFlowType t,
      PartialAccessPath ap
    ) {
      partialPathStep0(mid, node, state, cc, sc1, sc2, sc3, sc4, t0, ap) and
      not fullBarrier(node) and
      not stateBarrier(node, state) and
      not clearsContentEx(node, ap.getHead()) and
      (
        notExpectsContent(node) or
        expectsContentEx(node, ap.getHead())
      ) and
      strengthenType(node, t0, t)
    }

    pragma[nomagic]
    private predicate partialPathTypeStrengthen(
      DataFlowType t0, PartialAccessPath ap, DataFlowType t
    ) {
      partialPathStep1(_, _, _, _, _, _, _, _, t0, t, ap) and t0 != t
    }

    /**
     * A `Node` augmented with a call context, an access path, and a configuration.
     */
    class PartialPathNode extends TPartialPathNode {
      /** Gets a textual representation of this element. */
      string toString() { result = this.getNodeEx().toString() + this.ppType() + this.ppAp() }

      /**
       * Gets a textual representation of this element, including a textual
       * representation of the call context.
       */
      string toStringWithContext() {
        result = this.getNodeEx().toString() + this.ppType() + this.ppAp() + this.ppCtx()
      }

      /**
       * Holds if this element is at the specified location.
       * The location spans column `startcolumn` of line `startline` to
       * column `endcolumn` of line `endline` in file `filepath`.
       * For more information, see
       * [Locations](https://codeql.github.com/docs/writing-codeql-queries/providing-locations-in-codeql-queries/).
       */
      predicate hasLocationInfo(
        string filepath, int startline, int startcolumn, int endline, int endcolumn
      ) {
        this.getNodeEx().hasLocationInfo(filepath, startline, startcolumn, endline, endcolumn)
      }

      /** Gets the underlying `Node`. */
      final Node getNode() { this.getNodeEx().projectToNode() = result }

      FlowState getState() { none() }

      private NodeEx getNodeEx() {
        result = this.(PartialPathNodeFwd).getNodeEx() or
        result = this.(PartialPathNodeRev).getNodeEx()
      }

      /** Gets a successor of this node, if any. */
      PartialPathNode getASuccessor() { none() }

      /**
       * Gets the approximate distance to the nearest source measured in number
       * of interprocedural steps.
       */
      int getSourceDistance() { result = distSrc(this.getNodeEx().getEnclosingCallable()) }

      /**
       * Gets the approximate distance to the nearest sink measured in number
       * of interprocedural steps.
       */
      int getSinkDistance() { result = distSink(this.getNodeEx().getEnclosingCallable()) }

      private string ppType() {
        this instanceof PartialPathNodeRev and result = ""
        or
        exists(DataFlowType t | t = this.(PartialPathNodeFwd).getType() |
          // The `concat` becomes "" if `ppReprType` has no result.
          result = concat(" : " + ppReprType(t))
        )
      }

      private string ppAp() {
        exists(string s |
          s = this.(PartialPathNodeFwd).getAp().toString() or
          s = this.(PartialPathNodeRev).getAp().toString()
        |
          if s = "" then result = "" else result = " " + s
        )
      }

      private string ppCtx() {
        result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"
      }

      /** Holds if this is a source in a forward-flow path. */
      predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }

      /** Holds if this is a sink in a reverse-flow path. */
      predicate isRevSink() { this.(PartialPathNodeRev).isSink() }
    }

    /**
     * Provides the query predicates needed to include a graph in a path-problem query.
     */
    module PartialPathGraph {
      /** Holds if `(a,b)` is an edge in the graph of data flow path explanations. */
      query predicate edges(PartialPathNode a, PartialPathNode b) { a.getASuccessor() = b }
    }

    private class PartialPathNodeFwd extends PartialPathNode, TPartialPathNodeFwd {
      NodeEx node;
      FlowState state;
      CallContext cc;
      TSummaryCtx1 sc1;
      TSummaryCtx2 sc2;
      TSummaryCtx3 sc3;
      TSummaryCtx4 sc4;
      DataFlowType t;
      PartialAccessPath ap;

      PartialPathNodeFwd() {
        this = TPartialPathNodeFwd(node, state, cc, sc1, sc2, sc3, sc4, t, ap)
      }

      NodeEx getNodeEx() { result = node }

      override FlowState getState() { result = state }

      CallContext getCallContext() { result = cc }

      TSummaryCtx1 getSummaryCtx1() { result = sc1 }

      TSummaryCtx2 getSummaryCtx2() { result = sc2 }

      TSummaryCtx3 getSummaryCtx3() { result = sc3 }

      TSummaryCtx4 getSummaryCtx4() { result = sc4 }

      DataFlowType getType() { result = t }

      PartialAccessPath getAp() { result = ap }

      override PartialPathNodeFwd getASuccessor() {
        partialPathStep(this, result.getNodeEx(), result.getState(), result.getCallContext(),
          result.getSummaryCtx1(), result.getSummaryCtx2(), result.getSummaryCtx3(),
          result.getSummaryCtx4(), result.getType(), result.getAp())
      }

      predicate isSource() {
        sourceNode(node, state) and
        cc instanceof CallContextAny and
        sc1 = TSummaryCtx1None() and
        sc2 = TSummaryCtx2None() and
        sc3 = TSummaryCtx3None() and
        sc4 = TSummaryCtx4None() and
        ap instanceof TPartialNil
      }
    }

    private class PartialPathNodeRev extends PartialPathNode, TPartialPathNodeRev {
      NodeEx node;
      FlowState state;
      TRevSummaryCtx1 sc1;
      TRevSummaryCtx2 sc2;
      TRevSummaryCtx3 sc3;
      PartialAccessPath ap;

      PartialPathNodeRev() { this = TPartialPathNodeRev(node, state, sc1, sc2, sc3, ap) }

      NodeEx getNodeEx() { result = node }

      override FlowState getState() { result = state }

      TRevSummaryCtx1 getSummaryCtx1() { result = sc1 }

      TRevSummaryCtx2 getSummaryCtx2() { result = sc2 }

      TRevSummaryCtx3 getSummaryCtx3() { result = sc3 }

      PartialAccessPath getAp() { result = ap }

      override PartialPathNodeRev getASuccessor() {
        revPartialPathStep(result, this.getNodeEx(), this.getState(), this.getSummaryCtx1(),
          this.getSummaryCtx2(), this.getSummaryCtx3(), this.getAp())
      }

      predicate isSink() {
        sinkNode(node, state) and
        sc1 = TRevSummaryCtx1None() and
        sc2 = TRevSummaryCtx2None() and
        sc3 = TRevSummaryCtx3None() and
        ap = TPartialNil()
      }
    }

    pragma[nomagic]
    private predicate partialPathStep0(
      PartialPathNodeFwd mid, NodeEx node, FlowState state, CallContext cc, TSummaryCtx1 sc1,
      TSummaryCtx2 sc2, TSummaryCtx3 sc3, TSummaryCtx4 sc4, DataFlowType t, PartialAccessPath ap
    ) {
      not isUnreachableInCallCached(node.asNode(), cc.(CallContextSpecificCall).getCall()) and
      (
        localFlowStepEx(mid.getNodeEx(), node) and
        state = mid.getState() and
        cc = mid.getCallContext() and
        sc1 = mid.getSummaryCtx1() and
        sc2 = mid.getSummaryCtx2() and
        sc3 = mid.getSummaryCtx3() and
        sc4 = mid.getSummaryCtx4() and
        t = mid.getType() and
        ap = mid.getAp()
        or
        additionalLocalFlowStep(mid.getNodeEx(), node) and
        state = mid.getState() and
        cc = mid.getCallContext() and
        sc1 = mid.getSummaryCtx1() and
        sc2 = mid.getSummaryCtx2() and
        sc3 = mid.getSummaryCtx3() and
        sc4 = mid.getSummaryCtx4() and
        mid.getAp() instanceof PartialAccessPathNil and
        t = node.getDataFlowType() and
        ap = TPartialNil()
        or
        additionalLocalStateStep(mid.getNodeEx(), mid.getState(), node, state) and
        cc = mid.getCallContext() and
        sc1 = mid.getSummaryCtx1() and
        sc2 = mid.getSummaryCtx2() and
        sc3 = mid.getSummaryCtx3() and
        sc4 = mid.getSummaryCtx4() and
        mid.getAp() instanceof PartialAccessPathNil and
        t = node.getDataFlowType() and
        ap = TPartialNil()
      )
      or
      jumpStepEx(mid.getNodeEx(), node) and
      state = mid.getState() and
      cc instanceof CallContextAny and
      sc1 = TSummaryCtx1None() and
      sc2 = TSummaryCtx2None() and
      sc3 = TSummaryCtx3None() and
      sc4 = TSummaryCtx4None() and
      t = mid.getType() and
      ap = mid.getAp()
      or
      additionalJumpStep(mid.getNodeEx(), node) and
      state = mid.getState() and
      cc instanceof CallContextAny and
      sc1 = TSummaryCtx1None() and
      sc2 = TSummaryCtx2None() and
      sc3 = TSummaryCtx3None() and
      sc4 = TSummaryCtx4None() and
      mid.getAp() instanceof PartialAccessPathNil and
      t = node.getDataFlowType() and
      ap = TPartialNil()
      or
      additionalJumpStateStep(mid.getNodeEx(), mid.getState(), node, state) and
      cc instanceof CallContextAny and
      sc1 = TSummaryCtx1None() and
      sc2 = TSummaryCtx2None() and
      sc3 = TSummaryCtx3None() and
      sc4 = TSummaryCtx4None() and
      mid.getAp() instanceof PartialAccessPathNil and
      t = node.getDataFlowType() and
      ap = TPartialNil()
      or
      partialPathStoreStep(mid, _, _, _, node, t, ap) and
      state = mid.getState() and
      cc = mid.getCallContext() and
      sc1 = mid.getSummaryCtx1() and
      sc2 = mid.getSummaryCtx2() and
      sc3 = mid.getSummaryCtx3() and
      sc4 = mid.getSummaryCtx4()
      or
      exists(DataFlowType t0, PartialAccessPath ap0, Content c |
        partialPathReadStep(mid, t0, ap0, c, node, cc) and
        state = mid.getState() and
        sc1 = mid.getSummaryCtx1() and
        sc2 = mid.getSummaryCtx2() and
        sc3 = mid.getSummaryCtx3() and
        sc4 = mid.getSummaryCtx4() and
        apConsFwd(t, ap, c, t0, ap0)
      )
      or
      partialPathIntoCallable(mid, node, state, _, cc, sc1, sc2, sc3, sc4, _, t, ap)
      or
      partialPathOutOfCallable(mid, node, state, cc, t, ap) and
      sc1 = TSummaryCtx1None() and
      sc2 = TSummaryCtx2None() and
      sc3 = TSummaryCtx3None() and
      sc4 = TSummaryCtx4None()
      or
      partialPathThroughCallable(mid, node, state, cc, t, ap) and
      sc1 = mid.getSummaryCtx1() and
      sc2 = mid.getSummaryCtx2() and
      sc3 = mid.getSummaryCtx3() and
      sc4 = mid.getSummaryCtx4()
    }

    bindingset[result, i]
    private int unbindInt(int i) { pragma[only_bind_out](i) = pragma[only_bind_out](result) }

    pragma[inline]
    private predicate partialPathStoreStep(
      PartialPathNodeFwd mid, DataFlowType t1, PartialAccessPath ap1, Content c, NodeEx node,
      DataFlowType t2, PartialAccessPath ap2
    ) {
      exists(NodeEx midNode, DataFlowType contentType |
        midNode = mid.getNodeEx() and
        t1 = mid.getType() and
        ap1 = mid.getAp() and
        storeEx(midNode, c, node, contentType, t2) and
        ap2.getHead() = c and
        ap2.len() = unbindInt(ap1.len() + 1) and
        compatibleTypes(t1, contentType)
      )
    }

    pragma[nomagic]
    private predicate apConsFwd(
      DataFlowType t1, PartialAccessPath ap1, Content c, DataFlowType t2, PartialAccessPath ap2
    ) {
      partialPathStoreStep(_, t1, ap1, c, _, t2, ap2)
      or
      exists(DataFlowType t0 |
        partialPathTypeStrengthen(t0, ap2, t2) and
        apConsFwd(t1, ap1, c, t0, ap2)
      )
    }

    pragma[nomagic]
    private predicate partialPathReadStep(
      PartialPathNodeFwd mid, DataFlowType t, PartialAccessPath ap, Content c, NodeEx node,
      CallContext cc
    ) {
      exists(NodeEx midNode |
        midNode = mid.getNodeEx() and
        t = mid.getType() and
        ap = mid.getAp() and
        read(midNode, c, node) and
        ap.getHead() = c and
        cc = mid.getCallContext()
      )
    }

    private predicate partialPathOutOfCallable0(
      PartialPathNodeFwd mid, ReturnPosition pos, FlowState state, CallContext innercc,
      DataFlowType t, PartialAccessPath ap
    ) {
      pos = mid.getNodeEx().(RetNodeEx).getReturnPosition() and
      state = mid.getState() and
      innercc = mid.getCallContext() and
      innercc instanceof CallContextNoCall and
      t = mid.getType() and
      ap = mid.getAp()
    }

    pragma[nomagic]
    private predicate partialPathOutOfCallable1(
      PartialPathNodeFwd mid, DataFlowCall call, ReturnKindExt kind, FlowState state,
      CallContext cc, DataFlowType t, PartialAccessPath ap
    ) {
      exists(ReturnPosition pos, DataFlowCallable c, CallContext innercc |
        partialPathOutOfCallable0(mid, pos, state, innercc, t, ap) and
        c = pos.getCallable() and
        kind = pos.getKind() and
        resolveReturn(innercc, c, call)
      |
        if reducedViableImplInReturn(c, call) then cc = TReturn(c, call) else cc = TAnyCallContext()
      )
    }

    private predicate partialPathOutOfCallable(
      PartialPathNodeFwd mid, NodeEx out, FlowState state, CallContext cc, DataFlowType t,
      PartialAccessPath ap
    ) {
      exists(ReturnKindExt kind, DataFlowCall call |
        partialPathOutOfCallable1(mid, call, kind, state, cc, t, ap)
      |
        out.asNode() = kind.getAnOutNode(call)
      )
    }

    pragma[noinline]
    private predicate partialPathIntoArg(
      PartialPathNodeFwd mid, ParameterPosition ppos, FlowState state, CallContext cc,
      DataFlowCall call, DataFlowType t, PartialAccessPath ap
    ) {
      exists(ArgNode arg, ArgumentPosition apos |
        arg = mid.getNodeEx().asNode() and
        state = mid.getState() and
        cc = mid.getCallContext() and
        arg.argumentOf(call, apos) and
        t = mid.getType() and
        ap = mid.getAp() and
        parameterMatch(ppos, apos)
      )
    }

    pragma[nomagic]
    private predicate partialPathIntoCallable0(
      PartialPathNodeFwd mid, DataFlowCallable callable, ParameterPosition pos, FlowState state,
      CallContext outercc, DataFlowCall call, DataFlowType t, PartialAccessPath ap
    ) {
      partialPathIntoArg(mid, pos, state, outercc, call, t, ap) and
      callable = resolveCall(call, outercc)
    }

    private predicate partialPathIntoCallable(
      PartialPathNodeFwd mid, ParamNodeEx p, FlowState state, CallContext outercc,
      CallContextCall innercc, TSummaryCtx1 sc1, TSummaryCtx2 sc2, TSummaryCtx3 sc3,
      TSummaryCtx4 sc4, DataFlowCall call, DataFlowType t, PartialAccessPath ap
    ) {
      exists(ParameterPosition pos, DataFlowCallable callable |
        partialPathIntoCallable0(mid, callable, pos, state, outercc, call, t, ap) and
        p.isParameterOf(callable, pos) and
        sc1 = TSummaryCtx1Param(p) and
        sc2 = TSummaryCtx2Some(state) and
        sc3 = TSummaryCtx3Some(t) and
        sc4 = TSummaryCtx4Some(ap)
      |
        if recordDataFlowCallSite(call, callable)
        then innercc = TSpecificCall(call)
        else innercc = TSomeCall()
      )
    }

    pragma[nomagic]
    private predicate paramFlowsThroughInPartialPath(
      ReturnKindExt kind, FlowState state, CallContextCall cc, TSummaryCtx1 sc1, TSummaryCtx2 sc2,
      TSummaryCtx3 sc3, TSummaryCtx4 sc4, DataFlowType t, PartialAccessPath ap
    ) {
      exists(PartialPathNodeFwd mid, RetNodeEx ret |
        mid.getNodeEx() = ret and
        kind = ret.getKind() and
        state = mid.getState() and
        cc = mid.getCallContext() and
        sc1 = mid.getSummaryCtx1() and
        sc2 = mid.getSummaryCtx2() and
        sc3 = mid.getSummaryCtx3() and
        sc4 = mid.getSummaryCtx4() and
        t = mid.getType() and
        ap = mid.getAp()
      )
    }

    pragma[noinline]
    private predicate partialPathThroughCallable0(
      DataFlowCall call, PartialPathNodeFwd mid, ReturnKindExt kind, FlowState state,
      CallContext cc, DataFlowType t, PartialAccessPath ap
    ) {
      exists(
        CallContext innercc, TSummaryCtx1 sc1, TSummaryCtx2 sc2, TSummaryCtx3 sc3, TSummaryCtx4 sc4
      |
        partialPathIntoCallable(mid, _, _, cc, innercc, sc1, sc2, sc3, sc4, call, _, _) and
        paramFlowsThroughInPartialPath(kind, state, innercc, sc1, sc2, sc3, sc4, t, ap)
      )
    }

    private predicate partialPathThroughCallable(
      PartialPathNodeFwd mid, NodeEx out, FlowState state, CallContext cc, DataFlowType t,
      PartialAccessPath ap
    ) {
      exists(DataFlowCall call, ReturnKindExt kind |
        partialPathThroughCallable0(call, mid, kind, state, cc, t, ap) and
        out.asNode() = kind.getAnOutNode(call)
      )
    }

    pragma[nomagic]
    private predicate revPartialPathStep(
      PartialPathNodeRev mid, NodeEx node, FlowState state, TRevSummaryCtx1 sc1,
      TRevSummaryCtx2 sc2, TRevSummaryCtx3 sc3, PartialAccessPath ap
    ) {
      localFlowStepEx(node, mid.getNodeEx()) and
      state = mid.getState() and
      sc1 = mid.getSummaryCtx1() and
      sc2 = mid.getSummaryCtx2() and
      sc3 = mid.getSummaryCtx3() and
      ap = mid.getAp()
      or
      additionalLocalFlowStep(node, mid.getNodeEx()) and
      state = mid.getState() and
      sc1 = mid.getSummaryCtx1() and
      sc2 = mid.getSummaryCtx2() and
      sc3 = mid.getSummaryCtx3() and
      mid.getAp() instanceof PartialAccessPathNil and
      ap = TPartialNil()
      or
      additionalLocalStateStep(node, state, mid.getNodeEx(), mid.getState()) and
      sc1 = mid.getSummaryCtx1() and
      sc2 = mid.getSummaryCtx2() and
      sc3 = mid.getSummaryCtx3() and
      mid.getAp() instanceof PartialAccessPathNil and
      ap = TPartialNil()
      or
      jumpStepEx(node, mid.getNodeEx()) and
      state = mid.getState() and
      sc1 = TRevSummaryCtx1None() and
      sc2 = TRevSummaryCtx2None() and
      sc3 = TRevSummaryCtx3None() and
      ap = mid.getAp()
      or
      additionalJumpStep(node, mid.getNodeEx()) and
      state = mid.getState() and
      sc1 = TRevSummaryCtx1None() and
      sc2 = TRevSummaryCtx2None() and
      sc3 = TRevSummaryCtx3None() and
      mid.getAp() instanceof PartialAccessPathNil and
      ap = TPartialNil()
      or
      additionalJumpStateStep(node, state, mid.getNodeEx(), mid.getState()) and
      sc1 = TRevSummaryCtx1None() and
      sc2 = TRevSummaryCtx2None() and
      sc3 = TRevSummaryCtx3None() and
      mid.getAp() instanceof PartialAccessPathNil and
      ap = TPartialNil()
      or
      revPartialPathReadStep(mid, _, _, node, ap) and
      state = mid.getState() and
      sc1 = mid.getSummaryCtx1() and
      sc2 = mid.getSummaryCtx2() and
      sc3 = mid.getSummaryCtx3()
      or
      exists(PartialAccessPath ap0, Content c |
        revPartialPathStoreStep(mid, ap0, c, node) and
        state = mid.getState() and
        sc1 = mid.getSummaryCtx1() and
        sc2 = mid.getSummaryCtx2() and
        sc3 = mid.getSummaryCtx3() and
        apConsRev(ap, c, ap0)
      )
      or
      exists(ParamNodeEx p |
        mid.getNodeEx() = p and
        viableParamArgEx(_, p, node) and
        state = mid.getState() and
        sc1 = mid.getSummaryCtx1() and
        sc2 = mid.getSummaryCtx2() and
        sc3 = mid.getSummaryCtx3() and
        sc1 = TRevSummaryCtx1None() and
        sc2 = TRevSummaryCtx2None() and
        sc3 = TRevSummaryCtx3None() and
        ap = mid.getAp()
      )
      or
      exists(ReturnPosition pos |
        revPartialPathIntoReturn(mid, pos, state, sc1, sc2, sc3, _, ap) and
        pos = getReturnPosition(node.asNode())
      )
      or
      revPartialPathThroughCallable(mid, node, state, ap) and
      sc1 = mid.getSummaryCtx1() and
      sc2 = mid.getSummaryCtx2() and
      sc3 = mid.getSummaryCtx3()
    }

    pragma[inline]
    private predicate revPartialPathReadStep(
      PartialPathNodeRev mid, PartialAccessPath ap1, Content c, NodeEx node, PartialAccessPath ap2
    ) {
      exists(NodeEx midNode |
        midNode = mid.getNodeEx() and
        ap1 = mid.getAp() and
        read(node, c, midNode) and
        ap2.getHead() = c and
        ap2.len() = unbindInt(ap1.len() + 1)
      )
    }

    pragma[nomagic]
    private predicate apConsRev(PartialAccessPath ap1, Content c, PartialAccessPath ap2) {
      revPartialPathReadStep(_, ap1, c, _, ap2)
    }

    pragma[nomagic]
    private predicate revPartialPathStoreStep(
      PartialPathNodeRev mid, PartialAccessPath ap, Content c, NodeEx node
    ) {
      exists(NodeEx midNode |
        midNode = mid.getNodeEx() and
        ap = mid.getAp() and
        storeEx(node, c, midNode, _, _) and
        ap.getHead() = c
      )
    }

    pragma[nomagic]
    private predicate revPartialPathIntoReturn(
      PartialPathNodeRev mid, ReturnPosition pos, FlowState state, TRevSummaryCtx1Some sc1,
      TRevSummaryCtx2Some sc2, TRevSummaryCtx3Some sc3, DataFlowCall call, PartialAccessPath ap
    ) {
      exists(NodeEx out |
        mid.getNodeEx() = out and
        mid.getState() = state and
        viableReturnPosOutEx(call, pos, out) and
        sc1 = TRevSummaryCtx1Some(pos) and
        sc2 = TRevSummaryCtx2Some(state) and
        sc3 = TRevSummaryCtx3Some(ap) and
        ap = mid.getAp()
      )
    }

    pragma[nomagic]
    private predicate revPartialPathFlowsThrough(
      ArgumentPosition apos, FlowState state, TRevSummaryCtx1Some sc1, TRevSummaryCtx2Some sc2,
      TRevSummaryCtx3Some sc3, PartialAccessPath ap
    ) {
      exists(PartialPathNodeRev mid, ParamNodeEx p, ParameterPosition ppos |
        mid.getNodeEx() = p and
        mid.getState() = state and
        p.getPosition() = ppos and
        sc1 = mid.getSummaryCtx1() and
        sc2 = mid.getSummaryCtx2() and
        sc3 = mid.getSummaryCtx3() and
        ap = mid.getAp() and
        parameterMatch(ppos, apos)
      )
    }

    pragma[nomagic]
    private predicate revPartialPathThroughCallable0(
      DataFlowCall call, PartialPathNodeRev mid, ArgumentPosition pos, FlowState state,
      PartialAccessPath ap
    ) {
      exists(TRevSummaryCtx1Some sc1, TRevSummaryCtx2Some sc2, TRevSummaryCtx3Some sc3 |
        revPartialPathIntoReturn(mid, _, _, sc1, sc2, sc3, call, _) and
        revPartialPathFlowsThrough(pos, state, sc1, sc2, sc3, ap)
      )
    }

    pragma[nomagic]
    private predicate revPartialPathThroughCallable(
      PartialPathNodeRev mid, ArgNodeEx node, FlowState state, PartialAccessPath ap
    ) {
      exists(DataFlowCall call, ArgumentPosition pos |
        revPartialPathThroughCallable0(call, mid, pos, state, ap) and
        node.asNode().(ArgNode).argumentOf(call, pos)
      )
    }

    private predicate partialFlow(PartialPathNode source, PartialPathNode node) {
      source.isFwdSource() and
      node = source.getASuccessor+()
    }

    private predicate revPartialFlow(PartialPathNode node, PartialPathNode sink) {
      sink.isRevSink() and
      node.getASuccessor+() = sink
    }

    /**
     * Holds if there is a partial data flow path from `source` to `node`. The
     * approximate distance between `node` and the closest source is `dist` and
     * is restricted to be less than or equal to `explorationLimit()`. This
     * predicate completely disregards sink definitions.
     *
     * This predicate is intended for data-flow exploration and debugging and may
     * perform poorly if the number of sources is too big and/or the exploration
     * limit is set too high without using barriers.
     *
     * To use this in a `path-problem` query, import the module `PartialPathGraph`.
     */
    predicate partialFlow(PartialPathNode source, PartialPathNode node, int dist) {
      partialFlow(source, node) and
      dist = node.getSourceDistance()
    }

    /**
     * Holds if there is a partial data flow path from `node` to `sink`. The
     * approximate distance between `node` and the closest sink is `dist` and
     * is restricted to be less than or equal to `explorationLimit()`. This
     * predicate completely disregards source definitions.
     *
     * This predicate is intended for data-flow exploration and debugging and may
     * perform poorly if the number of sinks is too big and/or the exploration
     * limit is set too high without using barriers.
     *
     * To use this in a `path-problem` query, import the module `PartialPathGraph`.
     *
     * Note that reverse flow has slightly lower precision than the corresponding
     * forward flow, as reverse flow disregards type pruning among other features.
     */
    predicate partialFlowRev(PartialPathNode node, PartialPathNode sink, int dist) {
      revPartialFlow(node, sink) and
      dist = node.getSinkDistance()
    }
  }
}