Swift: extract ProtocolComposition- and BuiltinType

Author: redsun82

swift/codegen/schema.yml

@@ -14,22 +14,22 @@ _directories:
 
 Element:
   is_unknown: predicate
-  _pragma: skip_qltest
+  _pragma: qltest_skip
 
 File:
   name: string
 
 Locatable:
   location: Location?
-  _pragma: skip_qltest
+  _pragma: qltest_skip
 
 Location:
   file: File
   start_line: int
   start_column: int
   end_line: int
   end_column: int
-  _pragma: skip_qltest
+  _pragma: qltest_skip
 
 Type:
   diagnostics_name: string
@@ -85,6 +85,7 @@ AnyMetatypeType:
 
 BuiltinType:
   _extends: Type
+  _pragma: qltest_collapse_hierarchy
 
 DependentMemberType:
   _extends: Type
@@ -114,6 +115,7 @@ PlaceholderType:
 
 ProtocolCompositionType:
   _extends: Type
+  members: Type*
 
 ExistentialType:
   _extends: Type
@@ -393,7 +395,7 @@ EnumIsCaseExpr:
 
 ErrorExpr:
   _extends: Expr
-  _pragma: skip_qltest  # unexpected emission
+  _pragma: qltest_skip  # unexpected emission
 
 ExplicitCastExpr:
   _extends: Expr
@@ -468,7 +470,7 @@ ObjCSelectorExpr:
   _children:
     sub_expr: Expr
   method: AbstractFunctionDecl
-  _pragma: skip_qltest  # to be tested in integration tests
+  _pragma: qltest_skip  # to be tested in integration tests
 
 OneWayExpr:
   _extends: Expr
@@ -510,7 +512,7 @@ SequenceExpr:
   _extends: Expr
   _children:
     elements: Expr*
-  _pragma: skip_qltest  # we should really never extract these, as these should be resolved to trees of operations
+  _pragma: qltest_skip  # we should really never extract these, as these should be resolved to trees of operations
 
 SuperRefExpr:
   _extends: Expr
@@ -542,7 +544,7 @@ TypeExpr:
 UnresolvedDeclRefExpr:
   _extends: Expr
   name: string?
-  _pragma: skip_qltest  # we should really never extract these
+  _pragma: qltest_skip  # we should really never extract these
 
 UnresolvedDotExpr:
   _extends: Expr
@@ -553,15 +555,15 @@ UnresolvedDotExpr:
 UnresolvedMemberExpr:
   _extends: Expr
   name: string
-  _pragma: skip_qltest  # we should really never extract these
+  _pragma: qltest_skip  # we should really never extract these
 
 UnresolvedPatternExpr:
   _extends: Expr
-  _pragma: skip_qltest  # we should really never extract these
+  _pragma: qltest_skip  # we should really never extract these
 
 UnresolvedSpecializeExpr:
   _extends: Expr
-  _pragma: skip_qltest  # we should really never extract these
+  _pragma: qltest_skip  # we should really never extract these
 
 VarargExpansionExpr:
   _extends: Expr
@@ -698,6 +700,7 @@ BuiltinIntegerLiteralType:
 
 BuiltinIntegerType:
   _extends: AnyBuiltinIntegerType
+  _pragma: qltest_uncollapse_hierarchy
   width: int?
 
 NestedArchetypeType:
@@ -830,11 +833,11 @@ ArrayToPointerExpr:
 
 BridgeFromObjCExpr:
   _extends: ImplicitConversionExpr
-  _pragma: skip_qltest  # to be tested in integration tests
+  _pragma: qltest_skip  # to be tested in integration tests
 
 BridgeToObjCExpr:
   _extends: ImplicitConversionExpr
-  _pragma: skip_qltest  # to be tested in integration tests
+  _pragma: qltest_skip  # to be tested in integration tests
 
 ClassMetatypeToObjectExpr:
   _extends: ImplicitConversionExpr
@@ -844,7 +847,7 @@ CollectionUpcastConversionExpr:
 
 ConditionalBridgeFromObjCExpr:
   _extends: ImplicitConversionExpr
-  _pragma: skip_qltest  # to be tested in integration tests
+  _pragma: qltest_skip  # to be tested in integration tests
 
 CovariantFunctionConversionExpr:
   _extends: ImplicitConversionExpr

swift/extractor/visitors/TypeVisitor.cpp

@@ -304,4 +304,74 @@ void TypeVisitor::fillReferenceStorageType(const swift::ReferenceStorageType& ty
   fillType(type, entry);
 }
 
+codeql::ProtocolCompositionType TypeVisitor::translateProtocolCompositionType(
+    const swift::ProtocolCompositionType& type) {
+  auto entry = createEntry(type);
+  entry.members = dispatcher_.fetchRepeatedLabels(type.getMembers());
+  return entry;
+}
+
+codeql::BuiltinIntegerLiteralType TypeVisitor::translateBuiltinIntegerLiteralType(
+    const swift::BuiltinIntegerLiteralType& type) {
+  return createEntry(type);
+}
+
+codeql::BuiltinIntegerType TypeVisitor::translateBuiltinIntegerType(
+    const swift::BuiltinIntegerType& type) {
+  auto entry = createEntry(type);
+  if (type.isFixedWidth()) {
+    entry.width = type.getFixedWidth();
+  }
+  return entry;
+}
+
+codeql::BuiltinBridgeObjectType TypeVisitor::translateBuiltinBridgeObjectType(
+    const swift::BuiltinBridgeObjectType& type) {
+  return createEntry(type);
+}
+
+codeql::BuiltinDefaultActorStorageType TypeVisitor::translateBuiltinDefaultActorStorageType(
+    const swift::BuiltinDefaultActorStorageType& type) {
+  return createEntry(type);
+}
+
+codeql::BuiltinExecutorType TypeVisitor::translateBuiltinExecutorType(
+    const swift::BuiltinExecutorType& type) {
+  return createEntry(type);
+}
+
+codeql::BuiltinFloatType TypeVisitor::translateBuiltinFloatType(
+    const swift::BuiltinFloatType& type) {
+  return createEntry(type);
+}
+
+codeql::BuiltinJobType TypeVisitor::translateBuiltinJobType(const swift::BuiltinJobType& type) {
+  return createEntry(type);
+}
+
+codeql::BuiltinNativeObjectType TypeVisitor::translateBuiltinNativeObjectType(
+    const swift::BuiltinNativeObjectType& type) {
+  return createEntry(type);
+}
+
+codeql::BuiltinRawPointerType TypeVisitor::translateBuiltinRawPointerType(
+    const swift::BuiltinRawPointerType& type) {
+  return createEntry(type);
+}
+
+codeql::BuiltinRawUnsafeContinuationType TypeVisitor::translateBuiltinRawUnsafeContinuationType(
+    const swift::BuiltinRawUnsafeContinuationType& type) {
+  return createEntry(type);
+}
+
+codeql::BuiltinUnsafeValueBufferType TypeVisitor::translateBuiltinUnsafeValueBufferType(
+    const swift::BuiltinUnsafeValueBufferType& type) {
+  return createEntry(type);
+}
+
+codeql::BuiltinVectorType TypeVisitor::translateBuiltinVectorType(
+    const swift::BuiltinVectorType& type) {
+  return createEntry(type);
+}
+
 }  // namespace codeql

swift/extractor/visitors/TypeVisitor.h

@@ -47,6 +47,27 @@ class TypeVisitor : public TypeVisitorBase<TypeVisitor> {
       const swift::UnmanagedStorageType& type);
   codeql::WeakStorageType translateWeakStorageType(const swift::WeakStorageType& type);
   codeql::UnownedStorageType translateUnownedStorageType(const swift::UnownedStorageType& type);
+  codeql::ProtocolCompositionType translateProtocolCompositionType(
+      const swift::ProtocolCompositionType& type);
+  codeql::BuiltinIntegerLiteralType translateBuiltinIntegerLiteralType(
+      const swift::BuiltinIntegerLiteralType& type);
+  codeql::BuiltinIntegerType translateBuiltinIntegerType(const swift::BuiltinIntegerType& type);
+  codeql::BuiltinBridgeObjectType translateBuiltinBridgeObjectType(
+      const swift::BuiltinBridgeObjectType& type);
+  codeql::BuiltinDefaultActorStorageType translateBuiltinDefaultActorStorageType(
+      const swift::BuiltinDefaultActorStorageType& type);
+  codeql::BuiltinExecutorType translateBuiltinExecutorType(const swift::BuiltinExecutorType& type);
+  codeql::BuiltinFloatType translateBuiltinFloatType(const swift::BuiltinFloatType& type);
+  codeql::BuiltinJobType translateBuiltinJobType(const swift::BuiltinJobType& type);
+  codeql::BuiltinNativeObjectType translateBuiltinNativeObjectType(
+      const swift::BuiltinNativeObjectType& type);
+  codeql::BuiltinRawPointerType translateBuiltinRawPointerType(
+      const swift::BuiltinRawPointerType& type);
+  codeql::BuiltinRawUnsafeContinuationType translateBuiltinRawUnsafeContinuationType(
+      const swift::BuiltinRawUnsafeContinuationType& type);
+  codeql::BuiltinUnsafeValueBufferType translateBuiltinUnsafeValueBufferType(
+      const swift::BuiltinUnsafeValueBufferType& type);
+  codeql::BuiltinVectorType translateBuiltinVectorType(const swift::BuiltinVectorType& type);
 
  private:
   void fillType(const swift::TypeBase& type, codeql::Type& entry);
@@ -58,6 +79,13 @@ class TypeVisitor : public TypeVisitorBase<TypeVisitor> {
   void emitAnyFunctionType(const swift::AnyFunctionType* type, TrapLabel<AnyFunctionTypeTag> label);
   void emitBoundGenericType(swift::BoundGenericType* type, TrapLabel<BoundGenericTypeTag> label);
   void emitAnyGenericType(swift::AnyGenericType* type, TrapLabel<AnyGenericTypeTag> label);
+
+  template <typename T>
+  auto createEntry(const T& type) {
+    TrapClassOf<T> entry{dispatcher_.assignNewLabel(type)};
+    fillType(type, entry);
+    return entry;
+  }
 };
 
 }  // namespace codeql

swift/ql/lib/codeql/swift/elements/type/ExistentialType.qll

@@ -1,6 +1,4 @@
+// generated by codegen/codegen.py, remove this comment if you wish to edit this file
 private import codeql.swift.generated.type.ExistentialType
-private import codeql.swift.elements.type.ProtocolType
 
-class ExistentialType extends ExistentialTypeBase {
-  override ProtocolType getConstraint() { result = super.getConstraint() }
-}
+class ExistentialType extends ExistentialTypeBase { }

swift/ql/lib/codeql/swift/generated/type/ProtocolCompositionType.qll

@@ -3,4 +3,15 @@ import codeql.swift.elements.type.Type
 
 class ProtocolCompositionTypeBase extends @protocol_composition_type, Type {
   override string getAPrimaryQlClass() { result = "ProtocolCompositionType" }
+
+  Type getMember(int index) {
+    exists(Type x |
+      protocol_composition_type_members(this, index, x) and
+      result = x.resolve()
+    )
+  }
+
+  Type getAMember() { result = getMember(_) }
+
+  int getNumberOfMembers() { result = count(getAMember()) }
 }

swift/ql/lib/swift.dbscheme

@@ -274,6 +274,13 @@ protocol_composition_types(  //dir=type
   unique int id: @protocol_composition_type
 );
 
+#keyset[id, index]
+protocol_composition_type_members(  //dir=type
+  int id: @protocol_composition_type ref,
+  int index: int ref,
+  int member: @type ref
+);
+
 existential_types(  //dir=type
   unique int id: @existential_type,
   int constraint: @type ref

swift/ql/test/TestUtils.qll

@@ -9,13 +9,18 @@ predicate toBeTested(Element e) {
     (
       e = loc
       or
-      e = loc.(ValueDecl).getInterfaceType()
-      or
-      e = loc.(NominalTypeDecl).getType()
-      or
-      e = loc.(VarDecl).getType()
-      or
-      e = loc.(Expr).getType()
+      exists(Type t |
+        (e = t or e = t.(ExistentialType).getConstraint() or e = t.getCanonicalType()) and
+        (
+          t = loc.(ValueDecl).getInterfaceType()
+          or
+          t = loc.(NominalTypeDecl).getType()
+          or
+          t = loc.(VarDecl).getType()
+          or
+          t = loc.(Expr).getType()
+        )
+      )
     )
   )
 }

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

@@ -2,10 +2,9 @@
 import codeql.swift.elements
 import TestUtils
 
-from File x, string isUnknown, string getName
+from File x, string getName
 where
   toBeTested(x) and
   not x.isUnknown() and
-  (if x.isUnknown() then isUnknown = "yes" else isUnknown = "no") and
   getName = x.getName()
-select x, "isUnknown:", isUnknown, "getName:", getName
+select x, "getName:", getName

swift/ql/test/extractor-tests/generated/Location/MISSING_SOURCE.txt

@@ -3,17 +3,16 @@ import codeql.swift.elements
 import TestUtils
 
 from
-  AccessorDecl x, string isUnknown, Type getInterfaceType, string getName, string isGetter,
-  string isSetter, string isWillSet, string isDidSet
+  AccessorDecl x, Type getInterfaceType, string getName, string isGetter, string isSetter,
+  string isWillSet, string isDidSet
 where
   toBeTested(x) and
   not x.isUnknown() and
-  (if x.isUnknown() then isUnknown = "yes" else isUnknown = "no") and
   getInterfaceType = x.getInterfaceType() and
   getName = x.getName() and
   (if x.isGetter() then isGetter = "yes" else isGetter = "no") and
   (if x.isSetter() then isSetter = "yes" else isSetter = "no") and
   (if x.isWillSet() then isWillSet = "yes" else isWillSet = "no") and
   if x.isDidSet() then isDidSet = "yes" else isDidSet = "no"
-select x, "isUnknown:", isUnknown, "getInterfaceType:", getInterfaceType, "getName:", getName,
-  "isGetter:", isGetter, "isSetter:", isSetter, "isWillSet:", isWillSet, "isDidSet:", isDidSet
+select x, "getInterfaceType:", getInterfaceType, "getName:", getName, "isGetter:", isGetter,
+  "isSetter:", isSetter, "isWillSet:", isWillSet, "isDidSet:", isDidSet