Rust: Calculate a total of CFG inconsistencies.

Author: geoffw0

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

@@ -45,3 +45,50 @@ query predicate deadEnd(CfgImpl::Node node) {
   Consistency::deadEnd(node) and
   not letElsePanic(node.getAstNode())
 }
+
+/**
+ * Gets counts of control flow graph inconsistencies of each type.
+ */
+int getCfgInconsistencyCounts(string type) {
+  // total results from all the CFG consistency query predicates in:
+  //  - `codeql.rust.controlflow.internal.CfgConsistency` (this file)
+  //  - `shared.controlflow.codeql.controlflow.Cfg`
+  type = "Non-unique set representation" and
+  result = count(CfgImpl::Splits ss | Consistency::nonUniqueSetRepresentation(ss, _) | ss)
+  or
+  type = "Splitting invariant 2" and
+  result = count(AstNode n | Consistency::breakInvariant2(n, _, _, _, _, _) | n)
+  or
+  type = "Splitting invariant 3" and
+  result = count(AstNode n | Consistency::breakInvariant3(n, _, _, _, _, _) | n)
+  or
+  type = "Splitting invariant 4" and
+  result = count(AstNode n | Consistency::breakInvariant4(n, _, _, _, _, _) | n)
+  or
+  type = "Splitting invariant 5" and
+  result = count(AstNode n | Consistency::breakInvariant5(n, _, _, _, _, _) | n)
+  or
+  type = "Multiple successors of the same type" and
+  result = count(CfgNode n | Consistency::multipleSuccessors(n, _, _) | n)
+  or
+  type = "Simple and normal successors" and
+  result = count(CfgNode n | Consistency::simpleAndNormalSuccessors(n, _, _, _, _) | n)
+  or
+  type = "Dead end" and
+  result = count(CfgNode n | Consistency::deadEnd(n) | n)
+  or
+  type = "Non-unique split kind" and
+  result = count(CfgImpl::SplitImpl si | Consistency::nonUniqueSplitKind(si, _) | si)
+  or
+  type = "Non-unique list order" and
+  result = count(CfgImpl::SplitKind sk | Consistency::nonUniqueListOrder(sk, _) | sk)
+  or
+  type = "Multiple toStrings" and
+  result = count(CfgNode n | Consistency::multipleToString(n, _) | n)
+  or
+  type = "CFG scope lacks initial AST node" and
+  result = count(CfgScope s | Consistency::scopeNoFirst(s) | s)
+  or
+  type = "Non-PostOrderTree Expr node" and
+  result = count(Expr e | nonPostOrderExpr(e, _) | e)
+}

rust/ql/src/queries/summary/Stats.qll

@@ -3,9 +3,21 @@
  */
 
 import rust
+private import codeql.rust.controlflow.internal.CfgConsistency as CfgConsistency
 
+/**
+ * Gets a count of the total number of lines of code in the database.
+ */
 int getLinesOfCode() { result = sum(File f | | f.getNumberOfLinesOfCode()) }
 
+/**
+ * Gets a count of the total number of lines of code from the source code directory in the database.
+ */
 int getLinesOfUserCode() {
   result = sum(File f | exists(f.getRelativePath()) | f.getNumberOfLinesOfCode())
 }
+
+/**
+ * Gets a count of the total number of control flow graph inconsistencies in the database.
+ */
+int getTotalCfgInconsistencies() { result = sum(CfgConsistency::getCfgInconsistencyCounts(_)) }

rust/ql/src/queries/summary/SummaryStats.ql

@@ -33,4 +33,6 @@ where
   key = "Lines of code extracted" and value = getLinesOfCode().toString()
   or
   key = "Lines of user code extracted" and value = getLinesOfUserCode().toString()
+  or
+  key = "Inconsistencies - CFG" and value = getTotalCfgInconsistencies().toString()
 select key, value

rust/ql/test/query-tests/diagnostics/SummaryStats.expected

@@ -5,5 +5,6 @@
 | Files extracted - total | 7 |
 | Files extracted - with errors | 2 |
 | Files extracted - without errors | 5 |
+| Inconsistencies - CFG | 0 |
 | Lines of code extracted | 59 |
 | Lines of user code extracted | 59 |