BasicBlock: Replace entryBlock predicate with subclass.

aschackmull · aschackmull · commit 09b2c5abf011 · 2025-09-01T11:48:44.000+02:00
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/implementation/aliased_ssa/IRBlock.qll b/cpp/ql/lib/semmle/code/cpp/ir/implementation/aliased_ssa/IRBlock.qll
@@ -295,14 +295,16 @@ module IRCfg implements BB::CfgSig<Language::Location> {
     predicate postDominates(BasicBlock bb) { super.postDominates(bb) }
   }
 
+  class EntryBasicBlock extends BasicBlock {
+    EntryBasicBlock() { isEntryBlock(this) }
+  }
+
   pragma[nomagic]
   predicate dominatingEdge(BasicBlock bb1, BasicBlock bb2) {
     bb1.getASuccessor() = bb2 and
     bb1 = bb2.getImmediateDominator() and
     forall(BasicBlock pred | pred = bb2.getAPredecessor() and pred != bb1 | bb2.dominates(pred))
   }
-
-  predicate entryBlock(BasicBlock bb) { isEntryBlock(bb) }
 }
 
 cached
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/implementation/raw/IRBlock.qll b/cpp/ql/lib/semmle/code/cpp/ir/implementation/raw/IRBlock.qll
@@ -295,14 +295,16 @@ module IRCfg implements BB::CfgSig<Language::Location> {
     predicate postDominates(BasicBlock bb) { super.postDominates(bb) }
   }
 
+  class EntryBasicBlock extends BasicBlock {
+    EntryBasicBlock() { isEntryBlock(this) }
+  }
+
   pragma[nomagic]
   predicate dominatingEdge(BasicBlock bb1, BasicBlock bb2) {
     bb1.getASuccessor() = bb2 and
     bb1 = bb2.getImmediateDominator() and
     forall(BasicBlock pred | pred = bb2.getAPredecessor() and pred != bb1 | bb2.dominates(pred))
   }
-
-  predicate entryBlock(BasicBlock bb) { isEntryBlock(bb) }
 }
 
 cached
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/implementation/unaliased_ssa/IRBlock.qll b/cpp/ql/lib/semmle/code/cpp/ir/implementation/unaliased_ssa/IRBlock.qll
@@ -295,14 +295,16 @@ module IRCfg implements BB::CfgSig<Language::Location> {
     predicate postDominates(BasicBlock bb) { super.postDominates(bb) }
   }
 
+  class EntryBasicBlock extends BasicBlock {
+    EntryBasicBlock() { isEntryBlock(this) }
+  }
+
   pragma[nomagic]
   predicate dominatingEdge(BasicBlock bb1, BasicBlock bb2) {
     bb1.getASuccessor() = bb2 and
     bb1 = bb2.getImmediateDominator() and
     forall(BasicBlock pred | pred = bb2.getAPredecessor() and pred != bb1 | bb2.dominates(pred))
   }
-
-  predicate entryBlock(BasicBlock bb) { isEntryBlock(bb) }
 }
 
 cached
diff --git a/csharp/ql/lib/semmle/code/csharp/controlflow/BasicBlocks.qll b/csharp/ql/lib/semmle/code/csharp/controlflow/BasicBlocks.qll
@@ -341,16 +341,18 @@ final class ConditionBlock extends BasicBlock, BasicBlocksImpl::ConditionBasicBl
 
 private class BasicBlockAlias = BasicBlock;
 
+private class EntryBasicBlockAlias = EntryBasicBlock;
+
 module Cfg implements BB::CfgSig<Location> {
   class ControlFlowNode = ControlFlow::Node;
 
   class SuccessorType = ControlFlow::SuccessorType;
 
   class BasicBlock = BasicBlockAlias;
 
+  class EntryBasicBlock = EntryBasicBlockAlias;
+
   predicate dominatingEdge(BasicBlock bb1, BasicBlock bb2) {
     BasicBlocksImpl::dominatingEdge(bb1, bb2)
   }
-
-  predicate entryBlock(BasicBlock bb) { bb instanceof EntryBasicBlock }
 }
diff --git a/csharp/ql/lib/semmle/code/csharp/controlflow/internal/PreBasicBlocks.qll b/csharp/ql/lib/semmle/code/csharp/controlflow/internal/PreBasicBlocks.qll
@@ -167,9 +167,11 @@ module PreCfg implements BB::CfgSig<Location> {
 
   class BasicBlock = PreBasicBlock;
 
+  class EntryBasicBlock extends BasicBlock {
+    EntryBasicBlock() { entryBB(this) }
+  }
+
   predicate dominatingEdge(BasicBlock bb1, BasicBlock bb2) {
     conditionBlockImmediatelyControls(bb1, bb2, _)
   }
-
-  predicate entryBlock(BasicBlock bb) { entryBB(bb) }
 }
diff --git a/java/ql/lib/semmle/code/java/controlflow/BasicBlocks.qll b/java/ql/lib/semmle/code/java/controlflow/BasicBlocks.qll
@@ -165,7 +165,7 @@ module Cfg implements BB::CfgSig<Location> {
 
   class BasicBlock = BasicBlockAlias;
 
-  predicate dominatingEdge(BasicBlock bb1, BasicBlock bb2) { BbImpl::dominatingEdge(bb1, bb2) }
+  class EntryBasicBlock extends BasicBlock instanceof BbImpl::EntryBasicBlock { }
 
-  predicate entryBlock(BasicBlock bb) { BbImpl::entryBlock(bb) }
+  predicate dominatingEdge(BasicBlock bb1, BasicBlock bb2) { BbImpl::dominatingEdge(bb1, bb2) }
 }
diff --git a/javascript/ql/lib/semmle/javascript/internal/BasicBlockInternal.qll b/javascript/ql/lib/semmle/javascript/internal/BasicBlockInternal.qll
@@ -402,13 +402,15 @@ module Public {
       predicate postDominates(BasicBlock bb) { this.(ReachableBasicBlock).postDominates(bb) }
     }
 
+    class EntryBasicBlock extends BasicBlock {
+      EntryBasicBlock() { entryBB(this) }
+    }
+
     pragma[nomagic]
     predicate dominatingEdge(BasicBlock bb1, BasicBlock bb2) {
       bb1.getASuccessor() = bb2 and
       bb1 = bb2.getImmediateDominator() and
       forall(BasicBlock pred | pred = bb2.getAPredecessor() and pred != bb1 | bb2.dominates(pred))
     }
-
-    predicate entryBlock(BasicBlock bb) { entryBB(bb) }
   }
 }
diff --git a/python/ql/lib/semmle/python/Flow.qll b/python/ql/lib/semmle/python/Flow.qll
@@ -1295,12 +1295,14 @@ module Cfg implements BB::CfgSig<Location> {
     }
   }
 
+  class EntryBasicBlock extends BasicBlock {
+    EntryBasicBlock() { this.getNode(0).isEntryNode() }
+  }
+
   pragma[nomagic]
   predicate dominatingEdge(BasicBlock bb1, BasicBlock bb2) {
     bb1.getASuccessor() = bb2 and
     bb1 = bb2.getImmediateDominator() and
     forall(BasicBlock pred | pred = bb2.getAPredecessor() and pred != bb1 | bb2.dominates(pred))
   }
-
-  predicate entryBlock(BasicBlock bb) { bb.getNode(0).isEntryNode() }
 }
diff --git a/ruby/ql/lib/codeql/ruby/controlflow/BasicBlocks.qll b/ruby/ql/lib/codeql/ruby/controlflow/BasicBlocks.qll
@@ -300,6 +300,8 @@ final class ConditionBlock extends BasicBlock, BasicBlocksImpl::ConditionBasicBl
 
 private class BasicBlockAlias = BasicBlock;
 
+private class EntryBasicBlockAlias = EntryBasicBlock;
+
 private class SuccessorTypeAlias = SuccessorType;
 
 module Cfg implements BB::CfgSig<Location> {
@@ -309,9 +311,9 @@ module Cfg implements BB::CfgSig<Location> {
 
   class BasicBlock = BasicBlockAlias;
 
+  class EntryBasicBlock = EntryBasicBlockAlias;
+
   predicate dominatingEdge(BasicBlock bb1, BasicBlock bb2) {
     BasicBlocksImpl::dominatingEdge(bb1, bb2)
   }
-
-  predicate entryBlock(BasicBlock bb) { bb instanceof EntryBasicBlock }
 }
diff --git a/rust/ql/lib/codeql/rust/controlflow/BasicBlocks.qll b/rust/ql/lib/codeql/rust/controlflow/BasicBlocks.qll
@@ -25,7 +25,7 @@ module Cfg implements BB::CfgSig<Location> {
 
   class BasicBlock = BasicBlocksImpl::BasicBlock;
 
-  predicate dominatingEdge = BasicBlocksImpl::dominatingEdge/2;
+  class EntryBasicBlock = BasicBlocksImpl::EntryBasicBlock;
 
-  predicate entryBlock(BasicBlock bb) { bb instanceof EntryBasicBlock }
+  predicate dominatingEdge = BasicBlocksImpl::dominatingEdge/2;
 }
diff --git a/shared/controlflow/codeql/controlflow/BasicBlock.qll b/shared/controlflow/codeql/controlflow/BasicBlock.qll
@@ -150,6 +150,12 @@ signature module CfgSig<LocationSig Location> {
     predicate postDominates(BasicBlock bb);
   }
 
+  /**
+   * An entry basic block, that is, a basic block whose first node is
+   * an entry node.
+   */
+  class EntryBasicBlock extends BasicBlock;
+
   /**
    * Holds if `bb1` has `bb2` as a direct successor and the edge between `bb1`
    * and `bb2` is a dominating edge.
@@ -164,9 +170,6 @@ signature module CfgSig<LocationSig Location> {
    * means that the edge `(bb1, bb2)` dominates `bb3`.
    */
   predicate dominatingEdge(BasicBlock bb1, BasicBlock bb2);
-
-  /** Holds if `bb` is an entry basic block. */
-  predicate entryBlock(BasicBlock bb);
 }
 
 /**
@@ -365,6 +368,10 @@ module Make<LocationSig Location, InputSig<Location> Input> implements CfgSig<Lo
     string toString() { result = this.getFirstNode().toString() }
   }
 
+  class EntryBasicBlock extends BasicBlock {
+    EntryBasicBlock() { nodeIsDominanceEntry(this.getFirstNode()) }
+  }
+
   /**
    * Holds if `bb1` has `bb2` as a direct successor and the edge between `bb1`
    * and `bb2` is a dominating edge.
@@ -401,9 +408,6 @@ module Make<LocationSig Location, InputSig<Location> Input> implements CfgSig<Lo
     forall(BasicBlock pred | pred = bb2.getAPredecessor() and pred != bb1 | bb2.dominates(pred))
   }
 
-  /** Holds if `bb` is an entry basic block. */
-  predicate entryBlock(BasicBlock bb) { nodeIsDominanceEntry(bb.getFirstNode()) }
-
   cached
   private module Cached {
     private Node nodeGetAPredecessor(Node node, SuccessorType s) {
@@ -477,6 +481,9 @@ module Make<LocationSig Location, InputSig<Location> Input> implements CfgSig<Lo
       bb2.getFirstNode() = nodeGetASuccessor(bb1.getLastNode(), t)
     }
 
+    /** Holds if `bb` is an entry basic block. */
+    private predicate entryBlock(EntryBasicBlock bb) { any() }
+
     /**
      * Holds if the first node of basic block `succ` is a control flow
      * successor of the last node of basic block `pred`.
diff --git a/shared/dataflow/codeql/dataflow/VariableCapture.qll b/shared/dataflow/codeql/dataflow/VariableCapture.qll
@@ -628,7 +628,7 @@ module Flow<
   /** Holds if `cc` needs a definition at the entry of its callable scope. */
   private predicate entryDef(CaptureContainer cc, BasicBlock bb, int i) {
     exists(Callable c |
-      Cfg::entryBlock(bb) and
+      bb instanceof Cfg::EntryBasicBlock and
       pragma[only_bind_out](bb.getEnclosingCallable()) = c and
       i =
         min(int j |
diff --git a/swift/ql/lib/codeql/swift/controlflow/BasicBlocks.qll b/swift/ql/lib/codeql/swift/controlflow/BasicBlocks.qll
@@ -116,6 +116,8 @@ final class ConditionBlock extends BasicBlock, BasicBlocksImpl::ConditionBasicBl
 
 private class BasicBlockAlias = BasicBlock;
 
+private class EntryBasicBlockAlias = EntryBasicBlock;
+
 private class ControlFlowNodeAlias = ControlFlowNode;
 
 private class SuccessorTypeAlias = SuccessorType;
@@ -127,9 +129,9 @@ module Cfg implements BB::CfgSig<Location> {
 
   class BasicBlock = BasicBlockAlias;
 
+  class EntryBasicBlock = EntryBasicBlockAlias;
+
   predicate dominatingEdge(BasicBlock bb1, BasicBlock bb2) {
     BasicBlocksImpl::dominatingEdge(bb1, bb2)
   }
-
-  predicate entryBlock(BasicBlock bb) { bb instanceof EntryBasicBlock }
 }

Original file line number	Diff line number	Diff line change
`@@ -295,14 +295,16 @@ module IRCfg implements BB::CfgSig<Language::Location> {`
`295`	`295`	`predicate postDominates(BasicBlock bb) { super.postDominates(bb) }`
`296`	`296`	`}`
`297`	`297`
	`298`	`+ class EntryBasicBlock extends BasicBlock {`
	`299`	`+ EntryBasicBlock() { isEntryBlock(this) }`
	`300`	`+ }`
	`301`	`+`
`298`	`302`	`pragma[nomagic]`
`299`	`303`	`predicate dominatingEdge(BasicBlock bb1, BasicBlock bb2) {`
`300`	`304`	`bb1.getASuccessor() = bb2 and`
`301`	`305`	`bb1 = bb2.getImmediateDominator() and`
`302`	`306`	`forall(BasicBlock pred \| pred = bb2.getAPredecessor() and pred != bb1 \| bb2.dominates(pred))`
`303`	`307`	`}`
`304`		`-`
`305`		`- predicate entryBlock(BasicBlock bb) { isEntryBlock(bb) }`
`306`	`308`	`}`
`307`	`309`
`308`	`310`	`cached`
Original file line number	Diff line number	Diff line change
`@@ -167,9 +167,11 @@ module PreCfg implements BB::CfgSig<Location> {`
`167`	`167`
`168`	`168`	`class BasicBlock = PreBasicBlock;`
`169`	`169`
	`170`	`+ class EntryBasicBlock extends BasicBlock {`
	`171`	`+ EntryBasicBlock() { entryBB(this) }`
	`172`	`+ }`
	`173`	`+`
`170`	`174`	`predicate dominatingEdge(BasicBlock bb1, BasicBlock bb2) {`
`171`	`175`	`conditionBlockImmediatelyControls(bb1, bb2, _)`
`172`	`176`	`}`
`173`		`-`
`174`		`- predicate entryBlock(BasicBlock bb) { entryBB(bb) }`
`175`	`177`	`}`
Original file line number	Diff line number	Diff line change
`@@ -165,7 +165,7 @@ module Cfg implements BB::CfgSig<Location> {`
`165`	`165`
`166`	`166`	`class BasicBlock = BasicBlockAlias;`
`167`	`167`
`168`		`- predicate dominatingEdge(BasicBlock bb1, BasicBlock bb2) { BbImpl::dominatingEdge(bb1, bb2) }`
	`168`	`+ class EntryBasicBlock extends BasicBlock instanceof BbImpl::EntryBasicBlock { }`
`169`	`169`
`170`		`- predicate entryBlock(BasicBlock bb) { BbImpl::entryBlock(bb) }`
	`170`	`+ predicate dominatingEdge(BasicBlock bb1, BasicBlock bb2) { BbImpl::dominatingEdge(bb1, bb2) }`
`171`	`171`	`}`
Original file line number	Diff line number	Diff line change
`@@ -402,13 +402,15 @@ module Public {`
`402`	`402`	`predicate postDominates(BasicBlock bb) { this.(ReachableBasicBlock).postDominates(bb) }`
`403`	`403`	`}`
`404`	`404`
	`405`	`+ class EntryBasicBlock extends BasicBlock {`
	`406`	`+ EntryBasicBlock() { entryBB(this) }`
	`407`	`+ }`
	`408`	`+`
`405`	`409`	`pragma[nomagic]`
`406`	`410`	`predicate dominatingEdge(BasicBlock bb1, BasicBlock bb2) {`
`407`	`411`	`bb1.getASuccessor() = bb2 and`
`408`	`412`	`bb1 = bb2.getImmediateDominator() and`
`409`	`413`	`forall(BasicBlock pred \| pred = bb2.getAPredecessor() and pred != bb1 \| bb2.dominates(pred))`
`410`	`414`	`}`
`411`		`-`
`412`		`- predicate entryBlock(BasicBlock bb) { entryBB(bb) }`
`413`	`415`	`}`
`414`	`416`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1295,12 +1295,14 @@ module Cfg implements BB::CfgSig<Location> {`
`1295`	`1295`	`}`
`1296`	`1296`	`}`
`1297`	`1297`
	`1298`	`+ class EntryBasicBlock extends BasicBlock {`
	`1299`	`+ EntryBasicBlock() { this.getNode(0).isEntryNode() }`
	`1300`	`+ }`
	`1301`	`+`
`1298`	`1302`	`pragma[nomagic]`
`1299`	`1303`	`predicate dominatingEdge(BasicBlock bb1, BasicBlock bb2) {`
`1300`	`1304`	`bb1.getASuccessor() = bb2 and`
`1301`	`1305`	`bb1 = bb2.getImmediateDominator() and`
`1302`	`1306`	`forall(BasicBlock pred \| pred = bb2.getAPredecessor() and pred != bb1 \| bb2.dominates(pred))`
`1303`	`1307`	`}`
`1304`		`-`
`1305`		`- predicate entryBlock(BasicBlock bb) { bb.getNode(0).isEntryNode() }`
`1306`	`1308`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ module Cfg implements BB::CfgSig<Location> {`
`25`	`25`
`26`	`26`	`class BasicBlock = BasicBlocksImpl::BasicBlock;`
`27`	`27`
`28`		`- predicate dominatingEdge = BasicBlocksImpl::dominatingEdge/2;`
	`28`	`+ class EntryBasicBlock = BasicBlocksImpl::EntryBasicBlock;`
`29`	`29`
`30`		`- predicate entryBlock(BasicBlock bb) { bb instanceof EntryBasicBlock }`
	`30`	`+ predicate dominatingEdge = BasicBlocksImpl::dominatingEdge/2;`
`31`	`31`	`}`