Rust: Expose SuccessorType and sub classes

Author: hvitved

rust/ql/lib/codeql/rust/controlflow/ControlFlowGraph.qll

@@ -9,6 +9,20 @@ private import BasicBlocks
 
 final class CfgScope = Scope::CfgScope;
 
+final class SuccessorType = SuccessorTypeImpl;
+
+final class NormalSuccessor = NormalSuccessorImpl;
+
+final class ConditionalSuccessor = ConditionalSuccessorImpl;
+
+final class BooleanSuccessor = BooleanSuccessorImpl;
+
+final class MatchSuccessor = MatchSuccessorImpl;
+
+final class LoopJumpSuccessor = LoopJumpSuccessorImpl;
+
+final class ReturnSuccessor = ReturnSuccessorImpl;
+
 /**
  * A control flow node.
  *

rust/ql/lib/codeql/rust/controlflow/internal/Completion.qll

@@ -3,7 +3,7 @@ private import codeql.rust.controlflow.ControlFlowGraph
 private import rust
 private import SuccessorType
 
-private newtype TCompletion =
+newtype TCompletion =
   TSimpleCompletion() or
   TBooleanCompletion(Boolean b) or
   TMatchCompletion(Boolean isMatch) or

rust/ql/lib/codeql/rust/controlflow/internal/ControlFlowGraphImpl.qll

@@ -1,9 +1,8 @@
 private import rust
 import codeql.controlflow.Cfg
 import Completion
-import codeql.controlflow.Cfg
-private import SuccessorType as ST
 private import Scope as Scope
+private import codeql.rust.controlflow.ControlFlowGraph as Cfg
 
 private module CfgInput implements InputSig<Location> {
   private import rust as Rust
@@ -29,21 +28,21 @@ private module CfgInput implements InputSig<Location> {
 
   class Split = S::Split;
 
-  class SuccessorType = ST::SuccessorType;
+  class SuccessorType = Cfg::SuccessorType;
 
   /** Gets a successor type that matches completion `c`. */
   SuccessorType getAMatchingSuccessorType(Completion c) { result = c.getAMatchingSuccessorType() }
 
   /**
    * Hold if `c` represents simple (normal) evaluation of a statement or an expression.
    */
-  predicate successorTypeIsSimple(SuccessorType t) { t instanceof ST::NormalSuccessor }
+  predicate successorTypeIsSimple(SuccessorType t) { t instanceof Cfg::NormalSuccessor }
 
   /** Holds if `t` is an abnormal exit type out of a CFG scope. */
   predicate isAbnormalExitType(SuccessorType t) { none() }
 
   /** Hold if `t` represents a conditional successor type. */
-  predicate successorTypeIsCondition(SuccessorType t) { t instanceof ST::BooleanSuccessor }
+  predicate successorTypeIsCondition(SuccessorType t) { t instanceof Cfg::BooleanSuccessor }
 
   /** Gets the maximum number of splits allowed for a given node. */
   int maxSplits() { result = 0 }

rust/ql/lib/codeql/rust/controlflow/internal/SuccessorType.qll

@@ -1,5 +1,6 @@
 private import rust
 private import codeql.util.Boolean
+private import Completion
 
 newtype TLoopJumpType =
   TContinueJump() or
@@ -14,45 +15,43 @@ newtype TSuccessorType =
   TSuccessorSuccessor() or
   TBooleanSuccessor(Boolean b) or
   TMatchSuccessor(Boolean b) or
-  TLoopSuccessor(TLoopJumpType kind, TLabelType label) or
+  TLoopSuccessor(TLoopJumpType kind, TLabelType label) { exists(TLoopCompletion(kind, label)) } or
   TReturnSuccessor()
 
 /** The type of a control flow successor. */
-abstract private class SuccessorTypeImpl extends TSuccessorType {
+abstract class SuccessorTypeImpl extends TSuccessorType {
   /** Gets a textual representation of successor type. */
   abstract string toString();
 }
 
-final class SuccessorType = SuccessorTypeImpl;
-
 /** A normal control flow successor. */
-final class NormalSuccessor extends SuccessorTypeImpl, TSuccessorSuccessor {
-  final override string toString() { result = "successor" }
+class NormalSuccessorImpl extends SuccessorTypeImpl, TSuccessorSuccessor {
+  override string toString() { result = "successor" }
 }
 
 /** A conditional control flow successor. */
-abstract private class ConditionalSuccessor extends SuccessorTypeImpl {
+abstract class ConditionalSuccessorImpl extends SuccessorTypeImpl {
   boolean value;
 
   bindingset[value]
-  ConditionalSuccessor() { any() }
+  ConditionalSuccessorImpl() { any() }
 
   /** Gets the Boolean value of this successor. */
-  final boolean getValue() { result = value }
+  boolean getValue() { result = value }
 }
 
 /** A Boolean control flow successor for a boolean conditon. */
-final class BooleanSuccessor extends ConditionalSuccessor, TBooleanSuccessor {
-  BooleanSuccessor() { this = TBooleanSuccessor(value) }
+class BooleanSuccessorImpl extends ConditionalSuccessorImpl, TBooleanSuccessor {
+  BooleanSuccessorImpl() { this = TBooleanSuccessor(value) }
 
   override string toString() { result = this.getValue().toString() }
 }
 
 /**
  * A control flow successor of a pattern match.
  */
-final class MatchSuccessor extends ConditionalSuccessor, TMatchSuccessor {
-  MatchSuccessor() { this = TMatchSuccessor(value) }
+class MatchSuccessorImpl extends ConditionalSuccessorImpl, TMatchSuccessor {
+  MatchSuccessorImpl() { this = TMatchSuccessor(value) }
 
   override string toString() {
     if this.getValue() = true then result = "match" else result = "no-match"
@@ -62,20 +61,20 @@ final class MatchSuccessor extends ConditionalSuccessor, TMatchSuccessor {
 /**
  * A control flow successor of a loop control flow expression, `continue` or `break`.
  */
-final class LoopJumpSuccessor extends SuccessorTypeImpl, TLoopSuccessor {
-  final private TLoopJumpType getKind() { this = TLoopSuccessor(result, _) }
+class LoopJumpSuccessorImpl extends SuccessorTypeImpl, TLoopSuccessor {
+  private TLoopJumpType getKind() { this = TLoopSuccessor(result, _) }
 
-  final private TLabelType getLabelType() { this = TLoopSuccessor(_, result) }
+  private TLabelType getLabelType() { this = TLoopSuccessor(_, result) }
 
-  final predicate hasLabel() { this.getLabelType() = TLabel(_) }
+  predicate hasLabel() { this.getLabelType() = TLabel(_) }
 
-  final string getLabelName() { this = TLoopSuccessor(_, TLabel(result)) }
+  string getLabelName() { this = TLoopSuccessor(_, TLabel(result)) }
 
-  final predicate isContinue() { this.getKind() = TContinueJump() }
+  predicate isContinue() { this.getKind() = TContinueJump() }
 
-  final predicate isBreak() { this.getKind() = TBreakJump() }
+  predicate isBreak() { this.getKind() = TBreakJump() }
 
-  final override string toString() {
+  override string toString() {
     exists(string kind, string label |
       (if this.isContinue() then kind = "continue" else kind = "break") and
       (if this.hasLabel() then label = "(" + this.getLabelName() + ")" else label = "") and
@@ -87,6 +86,6 @@ final class LoopJumpSuccessor extends SuccessorTypeImpl, TLoopSuccessor {
 /**
  * A `return` control flow successor.
  */
-final class ReturnSuccessor extends SuccessorTypeImpl, TReturnSuccessor {
-  final override string toString() { result = "return" }
+class ReturnSuccessorImpl extends SuccessorTypeImpl, TReturnSuccessor {
+  override string toString() { result = "return" }
 }