Swift: extract UnresolvedSpecializeExpr

Author: redsun82

swift/extractor/translators/ExprTranslator.cpp

@@ -557,5 +557,11 @@ codeql::DynamicSubscriptExpr ExprTranslator::translateDynamicSubscriptExpr(
   fillLookupExpr(expr, entry);
   return entry;
 }
+codeql::UnresolvedSpecializeExpr ExprTranslator::translateUnresolvedSpecializeExpr(
+    const swift::UnresolvedSpecializeExpr& expr) {
+  auto entry = createExprEntry(expr);
+  entry.sub_expr = dispatcher.fetchLabel(expr.getSubExpr());
+  return entry;
+}
 
 }  // namespace codeql

swift/extractor/translators/ExprTranslator.h

@@ -109,6 +109,8 @@ class ExprTranslator : public AstTranslatorBase<ExprTranslator> {
       const swift::DynamicMemberRefExpr& expr);
   codeql::DynamicSubscriptExpr translateDynamicSubscriptExpr(
       const swift::DynamicSubscriptExpr& expr);
+  codeql::UnresolvedSpecializeExpr translateUnresolvedSpecializeExpr(
+      const swift::UnresolvedSpecializeExpr& expr);
 
  private:
   void fillAbstractClosureExpr(const swift::AbstractClosureExpr& expr,

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

@@ -68,21 +68,6 @@ private module Impl {
     )
   }
 
-  private Element getImmediateChildOfUnresolvedElement(
-    UnresolvedElement e, int index, string partialPredicateCall
-  ) {
-    exists(int b, int bElement, int n |
-      b = 0 and
-      bElement = b + 1 + max(int i | i = -1 or exists(getImmediateChildOfElement(e, i, _)) | i) and
-      n = bElement and
-      (
-        none()
-        or
-        result = getImmediateChildOfElement(e, index - b, partialPredicateCall)
-      )
-    )
-  }
-
   private Element getImmediateChildOfAstNode(AstNode e, int index, string partialPredicateCall) {
     exists(int b, int bLocatable, int n |
       b = 0 and
@@ -180,6 +165,21 @@ private module Impl {
     )
   }
 
+  private Element getImmediateChildOfUnresolvedElement(
+    UnresolvedElement e, int index, string partialPredicateCall
+  ) {
+    exists(int b, int bLocatable, int n |
+      b = 0 and
+      bLocatable = b + 1 + max(int i | i = -1 or exists(getImmediateChildOfLocatable(e, i, _)) | i) and
+      n = bLocatable and
+      (
+        none()
+        or
+        result = getImmediateChildOfLocatable(e, index - b, partialPredicateCall)
+      )
+    )
+  }
+
   private Element getImmediateChildOfUnspecifiedElement(
     UnspecifiedElement e, int index, string partialPredicateCall
   ) {
@@ -1842,18 +1842,21 @@ private module Impl {
   private Element getImmediateChildOfUnresolvedSpecializeExpr(
     UnresolvedSpecializeExpr e, int index, string partialPredicateCall
   ) {
-    exists(int b, int bExpr, int bUnresolvedElement, int n |
+    exists(int b, int bExpr, int bUnresolvedElement, int n, int nSubExpr |
       b = 0 and
       bExpr = b + 1 + max(int i | i = -1 or exists(getImmediateChildOfExpr(e, i, _)) | i) and
       bUnresolvedElement =
         bExpr + 1 + max(int i | i = -1 or exists(getImmediateChildOfUnresolvedElement(e, i, _)) | i) and
       n = bUnresolvedElement and
+      nSubExpr = n + 1 and
       (
         none()
         or
         result = getImmediateChildOfExpr(e, index - b, partialPredicateCall)
         or
         result = getImmediateChildOfUnresolvedElement(e, index - bExpr, partialPredicateCall)
+        or
+        index = n and result = e.getImmediateSubExpr() and partialPredicateCall = "SubExpr()"
       )
     )
   }

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

@@ -33,8 +33,6 @@ module Raw {
     int getEndColumn() { locations(this, _, _, _, _, result) }
   }
 
-  class UnresolvedElement extends @unresolved_element, Element { }
-
   class AstNode extends @ast_node, Locatable { }
 
   class Comment extends @comment, Locatable {
@@ -59,6 +57,8 @@ module Raw {
     int getKind() { diagnostics(this, _, result) }
   }
 
+  class UnresolvedElement extends @unresolved_element, Locatable { }
+
   class UnspecifiedElement extends @unspecified_element, Locatable {
     override string toString() { result = "UnspecifiedElement" }
 
@@ -641,6 +641,8 @@ module Raw {
 
   class UnresolvedSpecializeExpr extends @unresolved_specialize_expr, Expr, UnresolvedElement {
     override string toString() { result = "UnresolvedSpecializeExpr" }
+
+    Expr getSubExpr() { unresolved_specialize_exprs(this, result) }
   }
 
   class VarargExpansionExpr extends @vararg_expansion_expr, Expr {

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

@@ -323,7 +323,8 @@ module Synth {
 
   class TFile = TDbFile or TUnknownFile;
 
-  class TLocatable = TArgument or TAstNode or TComment or TDiagnostics or TUnspecifiedElement;
+  class TLocatable =
+    TArgument or TAstNode or TComment or TDiagnostics or TUnresolvedElement or TUnspecifiedElement;
 
   class TLocation = TDbLocation or TUnknownLocation;
 
@@ -1454,8 +1455,6 @@ module Synth {
     result = convertLocationFromRaw(e)
     or
     result = convertTypeFromRaw(e)
-    or
-    result = convertUnresolvedElementFromRaw(e)
   }
 
   cached
@@ -1475,6 +1474,8 @@ module Synth {
     or
     result = convertDiagnosticsFromRaw(e)
     or
+    result = convertUnresolvedElementFromRaw(e)
+    or
     result = convertUnspecifiedElementFromRaw(e)
   }
 
@@ -3159,8 +3160,6 @@ module Synth {
     result = convertLocationToRaw(e)
     or
     result = convertTypeToRaw(e)
-    or
-    result = convertUnresolvedElementToRaw(e)
   }
 
   cached
@@ -3180,6 +3179,8 @@ module Synth {
     or
     result = convertDiagnosticsToRaw(e)
     or
+    result = convertUnresolvedElementToRaw(e)
+    or
     result = convertUnspecifiedElementToRaw(e)
   }
 

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

@@ -1,8 +1,8 @@
 // generated by codegen/codegen.py
 private import codeql.swift.generated.Synth
 private import codeql.swift.generated.Raw
-import codeql.swift.elements.Element
+import codeql.swift.elements.Locatable
 
 module Generated {
-  class UnresolvedElement extends Synth::TUnresolvedElement, Element { }
+  class UnresolvedElement extends Synth::TUnresolvedElement, Locatable { }
 }

swift/ql/lib/codeql/swift/generated/expr/UnresolvedSpecializeExpr.qll

@@ -7,5 +7,23 @@ import codeql.swift.elements.UnresolvedElement
 module Generated {
   class UnresolvedSpecializeExpr extends Synth::TUnresolvedSpecializeExpr, Expr, UnresolvedElement {
     override string getAPrimaryQlClass() { result = "UnresolvedSpecializeExpr" }
+
+    /**
+     * Gets the sub expression of this unresolved specialize expression.
+     *
+     * This includes nodes from the "hidden" AST. It can be overridden in subclasses to change the
+     * behavior of both the `Immediate` and non-`Immediate` versions.
+     */
+    Expr getImmediateSubExpr() {
+      result =
+        Synth::convertExprFromRaw(Synth::convertUnresolvedSpecializeExprToRaw(this)
+              .(Raw::UnresolvedSpecializeExpr)
+              .getSubExpr())
+    }
+
+    /**
+     * Gets the sub expression of this unresolved specialize expression.
+     */
+    final Expr getSubExpr() { result = getImmediateSubExpr().resolve() }
   }
 }

swift/ql/lib/swift.dbscheme

@@ -19,7 +19,6 @@ sourceLocationPrefix(
 | @locatable
 | @location
 | @type
-| @unresolved_element
 ;
 
 #keyset[id]
@@ -67,6 +66,7 @@ files(
 | @ast_node
 | @comment
 | @diagnostics
+| @unresolved_element
 | @unspecified_element
 ;
 
@@ -91,17 +91,6 @@ locations(
   int end_column: int ref
 );
 
-@unresolved_element =
-  @unresolved_decl_ref_expr
-| @unresolved_dot_expr
-| @unresolved_member_chain_result_expr
-| @unresolved_member_expr
-| @unresolved_pattern_expr
-| @unresolved_specialize_expr
-| @unresolved_type
-| @unresolved_type_conversion_expr
-;
-
 @ast_node =
   @case_label_item
 | @condition_element
@@ -140,6 +129,17 @@ unknown_locations(
   unique int id: @unknown_location
 );
 
+@unresolved_element =
+  @unresolved_decl_ref_expr
+| @unresolved_dot_expr
+| @unresolved_member_chain_result_expr
+| @unresolved_member_expr
+| @unresolved_pattern_expr
+| @unresolved_specialize_expr
+| @unresolved_type
+| @unresolved_type_conversion_expr
+;
+
 unspecified_elements(
   unique int id: @unspecified_element,
   string property: string ref,
@@ -1078,7 +1078,8 @@ unresolved_pattern_exprs(  //dir=expr
 );
 
 unresolved_specialize_exprs(  //dir=expr
-  unique int id: @unresolved_specialize_expr
+  unique int id: @unresolved_specialize_expr,
+  int sub_expr: @expr_or_none ref
 );
 
 vararg_expansion_exprs(  //dir=expr

swift/ql/test/extractor-tests/generated/UnresolvedElement/UnresolvedElement.expected

@@ -0,0 +1 @@
+| unresolved.swift:5:1:5:14 | UnresolvedSpecializeExpr | UnresolvedSpecializeExpr |

swift/ql/test/extractor-tests/generated/UnresolvedElement/UnresolvedElement.ql

@@ -0,0 +1,7 @@
+// generated by codegen/codegen.py
+import codeql.swift.elements
+import TestUtils
+
+from UnresolvedElement x
+where toBeTested(x) and not x.isUnknown()
+select x, x.getPrimaryQlClasses()