Java: Replace SsaPhiNode with SsaPhiDefinition.

Author: aschackmull

java/ql/lib/semmle/code/java/dataflow/Nullness.qll

@@ -142,7 +142,7 @@ private predicate varMaybeNull(SsaVariable v, ControlFlowNode node, string msg,
     msg = "as suggested by $@ null guard" and
     guardSuggestsVarMaybeNull(e, v) and
     node = v.getCfgNode() and
-    not v instanceof SsaPhiNode and
+    not v instanceof SsaPhiDefinition and
     not clearlyNotNull(v) and
     // Comparisons in finally blocks are excluded since missing exception edges in the CFG could otherwise yield FPs.
     not exists(TryStmt try | try.getFinally() = e.getEnclosingStmt().getEnclosingStmt*()) and

java/ql/lib/semmle/code/java/dataflow/RangeAnalysis.qll

@@ -248,7 +248,7 @@ module Sem implements Semantic<Location> {
     Expr getAUse() { result = super.getAUse() }
   }
 
-  class SsaPhiNode extends SsaVariable instanceof SSA::SsaPhiNode {
+  class SsaPhiNode extends SsaVariable instanceof SSA::SsaPhiDefinition {
     predicate hasInputFromBlock(SsaVariable inp, BasicBlock bb) { super.hasInputFromBlock(inp, bb) }
   }
 

java/ql/lib/semmle/code/java/dataflow/RangeUtils.qll

@@ -30,14 +30,14 @@ predicate eqFlowCond = U::eqFlowCond/5;
  * only other input to `phi` is a `null` value.
  *
  * Note that the declared type of `phi` is `SsaVariable` instead of
- * `SsaPhiNode` in order for the reflexive case of `nonNullSsaFwdStep*(..)` to
- * have non-`SsaPhiNode` results.
+ * `SsaPhiDefinition` in order for the reflexive case of `nonNullSsaFwdStep*(..)` to
+ * have non-`SsaPhiDefinition` results.
  */
 private predicate nonNullSsaFwdStep(SsaVariable v, SsaVariable phi) {
-  exists(SsaExplicitWrite vnull, SsaPhiNode phi0 | phi0 = phi |
-    2 = strictcount(phi0.getAPhiInput()) and
-    vnull = phi0.getAPhiInput() and
-    v = phi0.getAPhiInput() and
+  exists(SsaExplicitWrite vnull, SsaPhiDefinition phi0 | phi0 = phi |
+    2 = strictcount(phi0.getAnInput()) and
+    vnull = phi0.getAnInput() and
+    v = phi0.getAnInput() and
     not backEdge(phi0, v, _) and
     vnull != v and
     vnull.getValue() instanceof NullLiteral

java/ql/lib/semmle/code/java/dataflow/SSA.qll

@@ -381,12 +381,20 @@ class SsaImplicitInit extends SsaVariable instanceof WriteDefinition {
   }
 }
 
-/** An SSA phi node. */
-class SsaPhiNode extends SsaVariable instanceof PhiNode {
+/**
+ * DEPRECATED: Use `SsaPhiDefinition` instead.
+ *
+ * An SSA phi node.
+ */
+deprecated class SsaPhiNode extends SsaVariable instanceof PhiNode {
   override string toString() { result = "SSA phi(" + this.getSourceVariable() + ")" }
 
-  /** Gets an input to the phi node defining the SSA variable. */
-  SsaVariable getAPhiInput() { this.hasInputFromBlock(result, _) }
+  /**
+   * DEPRECATED: Use `getAnInput()` instead.
+   *
+   * Gets an input to the phi node defining the SSA variable.
+   */
+  deprecated SsaVariable getAPhiInput() { this.hasInputFromBlock(result, _) }
 
   /** Gets an input to the phi node defining the SSA variable. */
   SsaVariable getAnInput() { this.hasInputFromBlock(result, _) }

java/ql/lib/semmle/code/java/dataflow/internal/rangeanalysis/ModulusAnalysisSpecific.qll

@@ -13,7 +13,7 @@ module Private {
 
   class SsaVariable = Ssa::SsaVariable;
 
-  class SsaPhiNode = Ssa::SsaPhiNode;
+  class SsaPhiNode = Ssa::SsaPhiDefinition;
 
   class Expr = J::Expr;
 

java/ql/lib/semmle/code/java/dataflow/internal/rangeanalysis/SignAnalysisSpecific.qll

@@ -19,7 +19,7 @@ module Private {
 
   class SsaVariable = Ssa::SsaVariable;
 
-  class SsaPhiNode = Ssa::SsaPhiNode;
+  class SsaPhiNode = Ssa::SsaPhiDefinition;
 
   class VarAccess = J::VarAccess;
 

java/ql/lib/semmle/code/java/dataflow/internal/rangeanalysis/SsaReadPositionSpecific.qll

@@ -10,7 +10,7 @@ private import SsaReadPositionCommon
 
 class SsaVariable = Ssa::SsaVariable;
 
-class SsaPhiNode = Ssa::SsaPhiNode;
+class SsaPhiNode = Ssa::SsaPhiDefinition;
 
 class BasicBlock = BB::BasicBlock;
 

java/ql/test/library-tests/ssa/ssaPhi.ql

@@ -1,6 +1,6 @@
 import java
 import semmle.code.java.dataflow.SSA
 
-from SsaPhiNode ssa, SsaSourceVariable v, SsaVariable phiInput
-where ssa.getAPhiInput() = phiInput and ssa.getSourceVariable() = v
-select v, ssa.getCfgNode(), phiInput.getCfgNode()
+from SsaPhiDefinition ssa, SsaSourceVariable v, SsaDefinition phiInput
+where ssa.getAnInput() = phiInput and ssa.getSourceVariable() = v
+select v, ssa.getControlFlowNode(), phiInput.getControlFlowNode()