Swift: IPA layer tweaks

Author: redsun82

swift/codegen/generators/qlgen.py

@@ -84,7 +84,7 @@ def get_ql_class(cls: schema.Class, lookup: typing.Dict[str, schema.Class]):
 
 def _to_db_type(x: str) -> str:
     if x[0].isupper():
-        return "@" + inflection.underscore(x)
+        return "Db::" + x
     return x
 
 
@@ -93,14 +93,15 @@ def _to_db_type(x: str) -> str:
 
 def get_ql_ipa_class(cls: schema.Class):
     if cls.derived:
-        return ql.Ipa.NonFinalClass(name=cls.name, derived=sorted(cls.derived), root=(cls.name == schema.root_class_name))
+        return ql.Ipa.NonFinalClass(name=cls.name, derived=sorted(cls.derived),
+                                    root=(cls.name == schema.root_class_name))
     if cls.ipa and cls.ipa.from_class is not None:
         source = cls.ipa.from_class
         _final_db_class_lookup.setdefault(source, ql.Ipa.FinalClassDb(source)).subtract_type(cls.name)
-        return ql.Ipa.FinalClassIpaFrom(name=cls.name, type=_to_db_type(source))
+        return ql.Ipa.FinalClassDerivedIpa(name=cls.name, params=[ql.Ipa.Param("id", _to_db_type(source))])
     if cls.ipa and cls.ipa.on_arguments is not None:
-        return ql.Ipa.FinalClassIpaOn(name=cls.name,
-                                      params=[ql.Ipa.Param(k, _to_db_type(v)) for k, v in cls.ipa.on_arguments.items()])
+        return ql.Ipa.FinalClassFreshIpa(name=cls.name, params=[ql.Ipa.Param(k, _to_db_type(v)) for k, v in
+                                                                cls.ipa.on_arguments.items()])
     return _final_db_class_lookup.setdefault(cls.name, ql.Ipa.FinalClassDb(cls.name))
 
 
@@ -120,9 +121,11 @@ def get_classes_used_by(cls: ql.Class):
     return sorted(set(t for t in get_types_used_by(cls) if t[0].isupper()))
 
 
-_generated_stub_re = re.compile(r"\n*private import .*\n+class \w+ extends \w+ \{[ \n]?\}"
+_generated_stub_re = re.compile(r"\n*private import .*\n+("
+                                r"class \w+ extends \w+ \{[ \n]?\}"
                                 "|"
-                                r"\n*predicate construct\w+\(.*?\) \{ none\(\) \}", re.MULTILINE)
+                                r"predicate construct\w+\(.*?\) \{ none\(\) \}"
+                                ")", re.MULTILINE)
 
 
 def _is_generated_stub(file):
@@ -271,7 +274,7 @@ def generate(opts, renderer):
         ipa_type = get_ql_ipa_class(cls)
         if ipa_type.is_final:
             final_ipa_types.append(ipa_type)
-            if ipa_type.is_ipa_from or (ipa_type.is_ipa_on and ipa_type.has_params):
+            if ipa_type.is_ipa and ipa_type.has_params:
                 stub_file = stub_out / cls.dir / f"{cls.name}Constructor.qll"
                 if not stub_file.is_file() or _is_generated_stub(stub_file):
                     renderer.render(ql.Ipa.ConstructorStub(ipa_type), stub_file)

swift/codegen/lib/ql.py

@@ -171,13 +171,13 @@ class Class:
     @dataclass
     class FinalClass(Class):
         is_final: ClassVar = True
-        is_ipa_from: ClassVar = False
-        is_ipa_on: ClassVar = False
+        is_derived_ipa: ClassVar = False
+        is_fresh_ipa: ClassVar = False
         is_db: ClassVar = False
 
         @property
         def is_ipa(self):
-            return self.is_ipa_on or self.is_ipa_from
+            return self.is_fresh_ipa or self.is_derived_ipa
 
     @dataclass
     class Param:
@@ -186,19 +186,7 @@ class Param:
         first: bool = False
 
     @dataclass
-    class FinalClassIpaFrom(FinalClass):
-        is_ipa_from: ClassVar = True
-
-        type: str = None
-
-        @property
-        def params(self):
-            return [Ipa.Param("id", self.type, first=True)]
-
-    @dataclass
-    class FinalClassIpaOn(FinalClass):
-        is_ipa_on: ClassVar = True
-
+    class FinalClassIpa(FinalClass):
         params: List["Ipa.Param"] = field(default_factory=list)
 
         def __post_init__(self):
@@ -209,6 +197,14 @@ def __post_init__(self):
         def has_params(self) -> bool:
             return bool(self.params)
 
+    @dataclass
+    class FinalClassDerivedIpa(FinalClassIpa):
+        is_derived_ipa: ClassVar = True
+
+    @dataclass
+    class FinalClassFreshIpa(FinalClassIpa):
+        is_fresh_ipa: ClassVar = True
+
     @dataclass
     class FinalClassDb(FinalClass):
         is_db: ClassVar = True
@@ -219,11 +215,11 @@ def subtract_type(self, type: str):
             self.subtracted_ipa_types.append(Ipa.Class(type, first=not self.subtracted_ipa_types))
 
         @property
-        def has_subtracted_ipa_types(self):
+        def has_subtracted_ipa_types(self) -> bool:
             return bool(self.subtracted_ipa_types)
 
         @property
-        def db_id(self):
+        def db_id(self) -> str:
             return "@" + inflection.underscore(self.name)
 
     @dataclass
@@ -252,4 +248,4 @@ def __post_init__(self):
     class ConstructorStub:
         template: ClassVar = "ql_ipa_constructor_stub"
 
-        cls: Union["Ipa.FinalClassIpaFrom", "Ipa.FinalClassIpaOn"]
+        cls: Union["Ipa.FinalClassDerivedIpa", "Ipa.FinalClassFreshIpa"]

swift/codegen/schema.yml

@@ -423,7 +423,7 @@ EnumIsCaseExpr:
   _extends: Expr
   _children:
     sub_expr: Expr
-    element: EnumElementDecl
+  element: EnumElementDecl
 
 ErrorExpr:
   _extends: Expr

swift/codegen/templates/ql_ipa_constructor_stub.mustache

@@ -1,2 +1,4 @@
 // generated by {{generator}}, remove this comment if you wish to edit this file
+import codeql.swift.generated.Db
+
 predicate construct{{cls.name}}({{#cls.params}}{{^first}}, {{/first}}{{type}} {{param}}{{/cls.params}}) { none() }

swift/codegen/templates/ql_ipa_types.mustache

@@ -7,12 +7,9 @@ cached module Ipa {
     {{^first}}
     or
     {{/first}}
-    {{#is_ipa_from}}
-    T{{name}}(Db::{{type}} id) { construct{{name}}(id) }
-    {{/is_ipa_from}}
-    {{#is_ipa_on}}
+    {{#is_ipa}}
     T{{name}}({{#params}}{{^first}}, {{/first}}{{type}} {{param}}{{/params}}){{#has_params}} { construct{{name}}({{#params}}{{^first}}, {{/first}}{{param}}{{/params}}) }{{/has_params}}
-    {{/is_ipa_on}}
+    {{/is_ipa}}
     {{#is_db}}
     T{{name}}(Db::{{name}} id){{#has_subtracted_ipa_types}} { {{#subtracted_ipa_types}}{{^first}} and {{/first}}not construct{{name}}(id){{/subtracted_ipa_types}} }{{/has_subtracted_ipa_types}}
     {{/is_db}}
@@ -26,12 +23,12 @@ cached module Ipa {
 
   {{#final_classes}}
   cached T{{name}} convert{{name}}FromDb(Db::Element e) {
-    {{^is_ipa_on}}
+    {{^is_fresh_ipa}}
     result = T{{name}}(e)
-    {{/is_ipa_on}}
-    {{#is_ipa_on}}
+    {{/is_fresh_ipa}}
+    {{#is_fresh_ipa}}
     none()
-    {{/is_ipa_on}}
+    {{/is_fresh_ipa}}
   }
   {{/final_classes}}
 
@@ -48,12 +45,12 @@ cached module Ipa {
 
   {{#final_classes}}
   cached Db::Element convert{{name}}ToDb(T{{name}} e) {
-    {{^is_ipa_on}}
+    {{^is_fresh_ipa}}
     e = T{{name}}(result)
-    {{/is_ipa_on}}
-    {{#is_ipa_on}}
+    {{/is_fresh_ipa}}
+    {{#is_fresh_ipa}}
     none()
-    {{/is_ipa_on}}
+    {{/is_fresh_ipa}}
   }
   {{/final_classes}}
 

swift/ql/lib/codeql/swift/controlflow/BasicBlocks.qll

@@ -201,10 +201,10 @@ private module JoinBlockPredecessors {
 
   private predicate idOfDbAstNode(Db::AstNode x, int y) = equivalenceRelation(id/2)(x, y)
 
-  // TODO does not work if we use "ipa on" entities...
+  // TODO does not work if fresh ipa entities (`ipa: on:`) turn out to be first of the block
   private predicate idOf(AstNode x, int y) { idOfDbAstNode(Ipa::convertAstNodeToDb(x), y) }
 
-  private AstNode projctToAst(ControlFlowElement n) {
+  private AstNode projectToAst(ControlFlowElement n) {
     result = n.asAstNode()
     or
     isPropertyGetterElement(n, _, result)
@@ -219,7 +219,7 @@ private module JoinBlockPredecessors {
   }
 
   int getId(JoinBlockPredecessor jbp) {
-    idOf(projctToAst(jbp.getFirstNode().(CfgNode).getNode()), result)
+    idOf(projectToAst(jbp.getFirstNode().(CfgNode).getNode()), result)
     or
     idOf(jbp.(EntryBasicBlock).getScope(), result)
   }

swift/ql/lib/codeql/swift/elements/expr/ExplicitCastExpr.qll

@@ -1,7 +1,7 @@
 private import codeql.swift.generated.expr.ExplicitCastExpr
 
 class ExplicitCastExpr extends ExplicitCastExprBase {
-  override predicate convertsFrom(Expr e) { e = getImmediateSubExpr() }
+  override predicate convertsFrom(Expr e) { e = this.getImmediateSubExpr() }
 
   override string toString() { result = "(" + this.getType() + ") ..." }
 }

swift/ql/lib/codeql/swift/generated/GetImmediateParent.qll

@@ -67,8 +67,6 @@ Element getAnImmediateChild(Element e) {
   or
   result = e.(EnumIsCaseExpr).getImmediateSubExpr()
   or
-  result = e.(EnumIsCaseExpr).getImmediateElement()
-  or
   result = e.(ExplicitCastExpr).getImmediateSubExpr()
   or
   result = e.(ForceValueExpr).getImmediateSubExpr()

swift/ql/test/library-tests/controlflow/graph/Cfg.expected

@@ -1514,18 +1514,15 @@ cfg.swift:
 #  141| case ...
 #-----|  -> 0
 
-#  141| 0
-#-----|  -> 0
-
 #  141| 0
 #-----| no-match -> 1
 #-----| match -> true
 
 #  141| 0
 #-----|  -> 0
 
-#  141| 1
-#-----|  -> 1
+#  141| 0
+#-----|  -> 0
 
 #  141| 1
 #-----| match -> true
@@ -1534,6 +1531,9 @@ cfg.swift:
 #  141| 1
 #-----|  -> 1
 
+#  141| 1
+#-----|  -> 1
+
 #  142| return ...
 #-----| return -> exit patterns(x:) (normal)