AST: add predicated property to branch statement

Author: sipma

chb/ast/ASTApplicationInterface.py

@@ -4,7 +4,7 @@
 # ------------------------------------------------------------------------------
 # The MIT License (MIT)
 #
-# Copyright (c) 2022-2023  Aarno Labs, LLC
+# Copyright (c) 2022-2025  Aarno Labs, LLC
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -42,7 +42,7 @@
 from chb.ast.CustomASTSupport import CustomASTSupport
 
 
-pirversion: str = "0.1.0-20240703"
+pirversion: str = "0.1.0-202507024"
 
 
 class ASTApplicationInterface:

chb/ast/ASTDeserializer.py

@@ -751,13 +751,15 @@ def arg(ix: int) -> Dict[str, Any]:
                 thenbranch = cast(AST.ASTStmt, mk_node(arg(1)))
                 elsebranch = cast(AST.ASTStmt, mk_node(arg(2)))
                 targetaddr = r["destination-addr"]
+                predicated = r.get("predicated", None)
                 nodes[id] = astree.mk_branch(
                     condition,
                     thenbranch,
                     elsebranch,
                     targetaddr,
                     optstmtid=stmtid,
-                    optlocationid=locationid)
+                    optlocationid=locationid,
+                    predicated=predicated)
 
             elif tag == "block":
                 stmtid = r["stmtid"]

chb/ast/ASTNode.py

@@ -595,13 +595,15 @@ def __init__(
             elsestmt: "ASTStmt",
             tgtaddress: str,
             mergeaddress: Optional[str],
-            labels: List["ASTStmtLabel"] = []) -> None:
+            labels: List["ASTStmtLabel"] = [],
+            predicated: Optional[int] = None) -> None:
         ASTStmt.__init__(self, stmtid, locationid, labels, "if")
         self._cond = cond
         self._ifstmt = ifstmt
         self._elsestmt = elsestmt
         self._tgtaddress = tgtaddress
         self._mergeaddress = mergeaddress
+        self._predicated = predicated
 
     @property
     def is_ast_branch(self) -> bool:
@@ -627,6 +629,10 @@ def target_address(self) -> str:
     def merge_address(self) -> Optional[str]:
         return self._mergeaddress
 
+    @property
+    def predicated(self) -> Optional[int]:
+        return self._predicated
+
     def accept(self, visitor: "ASTVisitor") -> None:
         visitor.visit_branch_stmt(self)
 

chb/ast/ASTSerializer.py

@@ -4,7 +4,7 @@
 # ------------------------------------------------------------------------------
 # The MIT License (MIT)
 #
-# Copyright (c) 2022-2024  Aarno Labs LLC
+# Copyright (c) 2022-2025  Aarno Labs LLC
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -373,6 +373,8 @@ def index_branch_stmt(self, stmt: AST.ASTBranch) -> int:
             stmt.elsestmt.index(self)])
         node["destination-addr"] = stmt.target_address
         node["merge-addr"] = stmt.merge_address
+        if stmt.predicated is not None:
+            node["predicated"] = stmt.predicated
         return self.add(tags, args, node)
 
     def index_instruction_sequence_stmt(self, stmt: AST.ASTInstrSequence) -> int:

chb/ast/ASTViewer.py

@@ -170,8 +170,10 @@ def visit_loop_stmt(self, stmt: AST.ASTLoop) -> None:
 
     def visit_branch_stmt(self, stmt: AST.ASTBranch) -> None:
         name = self.stmt_name(stmt)
-        self.add_node(
-            name, labeltxt="if:" + str(stmt.stmtid), color=nodecolors["stmt"])
+        labeltxt = "if:" + str(stmt.stmtid)
+        if stmt.predicated is not None:
+            labeltxt += "\\npredicated:" + str(stmt.predicated)
+        self.add_node(name, labeltxt=labeltxt, color=nodecolors["stmt"])
         self.add_edge(name, self.stmt_name(stmt.ifstmt), labeltxt="then")
         self.add_edge(name, self.stmt_name(stmt.elsestmt), labeltxt="else")
         self.add_edge(name, self.expr_name(stmt.condition), labeltxt="condition")

chb/ast/AbstractSyntaxTree.py

@@ -421,15 +421,16 @@ def mk_branch(
             mergeaddr: Optional[str] = None,
             optstmtid: Optional[int] = None,
             optlocationid: Optional[int] = None,
-            labels: List[AST.ASTStmtLabel] = []) -> AST.ASTBranch:
+            labels: List[AST.ASTStmtLabel] = [],
+            predicated: Optional[int] = None) -> AST.ASTBranch:
         stmtid = self.get_stmtid(optstmtid)
         locationid = self.get_locationid(optlocationid)
         if condition is None:
             # create a new unknown (uninitialized) variable
             condition = self.mk_tmp_lval_expression()
         return AST.ASTBranch(
             stmtid, locationid, condition, ifbranch, elsebranch,
-            targetaddr, mergeaddr)
+            targetaddr, mergeaddr, predicated=predicated)
 
     def mk_goto_stmt(
             self,

chb/ast/doc/CHANGELOG.md

@@ -6,6 +6,12 @@ The format is based on
 [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 	and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+### version 0.1.0-2025-07-24
+
+- Add property predicated to branch stmt to indicate its origin from a predicated instruction
+- Add option to pir inspector to view a single statement
+
+
 ### version 0.1.0-2024-07-03
 
 - Add printing of structs to ASTCPrettyPrinter

chb/astinterface/ASTICodeTransformer.py

@@ -123,7 +123,8 @@ def transform_branch_stmt(self, stmt: AST.ASTBranch) -> AST.ASTStmt:
             newelse,
             stmt.target_address,
             mergeaddr=stmt.merge_address,
-            optlocationid=stmt.locationid)
+            optlocationid=stmt.locationid,
+            predicated=stmt.predicated)
 
     def transform_switch_stmt(self, stmt: AST.ASTSwitchStmt) -> AST.ASTStmt:
         newcases = stmt.cases.transform(self)

chb/astinterface/ASTInterface.py

@@ -699,14 +699,16 @@ def mk_branch(
             elsebranch: AST.ASTStmt,
             targetaddr: str,
             mergeaddr: Optional[str] = None,
-            optlocationid: Optional[int] = None) -> AST.ASTStmt:
+            optlocationid: Optional[int] = None,
+            predicated: Optional[int] = None) -> AST.ASTStmt:
         return self.astree.mk_branch(
             condition,
             ifbranch,
             elsebranch,
             targetaddr,
             mergeaddr=mergeaddr,
-            optlocationid=optlocationid)
+            optlocationid=optlocationid,
+            predicated=predicated)
 
     def mk_instr_sequence(
             self,

chb/astinterface/ASTInterfaceBasicBlock.py

@@ -215,7 +215,9 @@ def ast_fragment(
             else:
                 astree.astree.add_expr_span(
                     brcond.exprid, cinstr.iaddr, cinstr.bytestring)
-            ifstmt = astree.mk_branch(brcond, thenstmt, elsestmt, cinstr.iaddr)
+            instrcount = len(theninstrs) + len(elseinstrs)
+            ifstmt = astree.mk_branch(
+                brcond, thenstmt, elsestmt, cinstr.iaddr, predicated=instrcount)
             astree.add_stmt_span(ifstmt.locationid, spans)
             return ifstmt
         else: