[APINotes] Add support for handling Clang modules carrying all versions of APINotes

Controlled from Swift with '-version-independent-apinotes', which, for the underlying Clang invocation enables '-fswift-version-independent-apinotes', results in PCMs which aggregate all versioned APINotes wrapped in a 'SwiftVersionedAttr', with the intent to have the client pick and apply only those that match its current Swift version, discarding the rest.

Author: artemcm

include/swift/Basic/LangOptions.h

@@ -1108,6 +1108,11 @@ namespace swift {
     /// invocations directly from clang cc1 args.
     bool ClangImporterDirectCC1Scan = false;
 
+    /// Whether the importer should expect all APINotes to be wrapped
+    /// in versioned attributes, where the importer must select the appropriate
+    /// ones to apply.
+    bool LoadVersionIndependentAPINotes = false;
+
     /// Return a hash code of any components from these options that should
     /// contribute to a Swift Bridging PCH hash.
     llvm::hash_code getPCHHashComponents() const {

include/swift/Option/FrontendOptions.td

@@ -669,6 +669,9 @@ def emit_pch : Flag<["-"], "emit-pch">,
 def pch_disable_validation : Flag<["-"], "pch-disable-validation">,
   HelpText<"Disable validating the persistent PCH">;
 
+def version_independent_apinotes : Flag<["-"], "version-independent-apinotes">,
+  HelpText<"Input clang modules carry all versioned APINotes">;
+
 def disable_sil_ownership_verifier : Flag<["-"], "disable-sil-ownership-verifier">,
   HelpText<"Do not verify ownership invariants during SIL Verification ">;
 

lib/ClangImporter/ClangImporter.cpp

@@ -781,6 +781,10 @@ void importer::getNormalInvocationArguments(
     invocationArgStrs.push_back("-iapinotes-modules");
     invocationArgStrs.push_back(path.str().str());
   }
+
+  if (importerOpts.LoadVersionIndependentAPINotes)
+    invocationArgStrs.insert(invocationArgStrs.end(),
+                             {"-fswift-version-independent-apinotes"});
 }
 
 static void

lib/ClangImporter/ImportDecl.cpp

@@ -68,6 +68,7 @@
 #include "clang/AST/Type.h"
 #include "clang/Basic/Specifiers.h"
 #include "clang/Basic/TargetInfo.h"
+#include "clang/Sema/SemaDiagnostic.h"
 #include "clang/Lex/Preprocessor.h"
 #include "clang/Sema/Lookup.h"
 
@@ -172,6 +173,9 @@ bool importer::recordHasReferenceSemantics(
       !importerImpl->SwiftContext.LangOpts.CForeignReferenceTypes)
     return false;
 
+  // ACTODO: Check versioned attrs in case of
+  // captureSwiftVersionIndependentAPINotes
+
   // At this point decl might not be fully imported into Swift yet, which
   // means we might not have asked Clang to generate its implicit members, such
   // as copy or move constructors. This would cause CxxRecordSemanticsRequest to
@@ -9339,6 +9343,67 @@ static bool isUsingMacroName(clang::SourceManager &SM,
   return content == MacroName;
 }
 
+static void filterUsableVersionedAttrs(const clang::NamedDecl *clangDecl,
+                                       llvm::VersionTuple currentVersion,
+                                       std::unordered_set<clang::Attr*> &discardVersionedAttrSet) {
+  // Scan through Swift-Versioned clang attributes and select which one to apply
+  // if multiple candidates exist.
+  SmallVector<clang::SwiftVersionedAdditionAttr*, 4> swiftVersionedAttributes;
+  for (auto attr : clangDecl->attrs())
+    if (auto versionedAttr = dyn_cast<clang::SwiftVersionedAdditionAttr>(attr))
+      swiftVersionedAttributes.push_back(versionedAttr);
+
+  // An attribute version is valid to apply if it is greater than the current version
+  // or is unversioned
+  auto applicableVersion = [currentVersion] (clang::VersionTuple attrVersion) -> bool {
+    return attrVersion.empty() || attrVersion >= currentVersion;
+  };
+
+  // We have a better attribute option if there exists another versioned attr
+  // wrapper for this attribute kind with a valid version that is lower than the
+  // one of the attribute we are considering
+  auto haveBetterAttr = [swiftVersionedAttributes, applicableVersion]
+      (clang::VersionTuple attrVersion, clang::attr::Kind attrKind) -> bool {
+    for (auto VAI = swiftVersionedAttributes.begin(),
+         VAE = swiftVersionedAttributes.end(); VAI != VAE; ++VAI) {
+      auto otherVersionedAttr = *VAI;
+      auto otherAttrKind = otherVersionedAttr->getAdditionalAttr()->getKind();
+      auto otherAttrVersion = otherVersionedAttr->getVersion();
+      // Same exact attribute, ignore
+      if (otherAttrKind == attrKind && otherAttrVersion == attrVersion)
+        continue;
+
+      // For a matching attribute kind, an un-versioned attribute
+      // never takes precedence over an exsiting valid versioned one.
+      if (otherAttrKind == attrKind && !attrVersion.empty() && otherAttrVersion.empty())
+        continue;
+      if (otherAttrKind == attrKind && applicableVersion(otherAttrVersion) && attrVersion.empty())
+        return true;
+
+      // For two versioned attributes of the same kind, the one with the lower applicable
+      // version takes precedence.
+      if (otherAttrKind == attrKind &&
+          applicableVersion(otherAttrVersion) &&
+          otherAttrVersion < attrVersion)
+        return true;
+    }
+    return false;
+  };
+
+  for (auto VAI = swiftVersionedAttributes.begin(),
+       VAE = swiftVersionedAttributes.end(); VAI != VAE; ++VAI) {
+    auto versionedAttr = *VAI;
+    auto attrKind = versionedAttr->getAdditionalAttr()->getKind();
+    auto attrVersion = versionedAttr->getVersion();
+    if (!applicableVersion(attrVersion))
+      discardVersionedAttrSet.insert(versionedAttr);
+    else if (haveBetterAttr(attrVersion, attrKind))
+      discardVersionedAttrSet.insert(versionedAttr);
+    else
+      continue;
+  }
+}
+
 void ClangImporter::Implementation::importAttributesFromClangDeclToSynthesizedSwiftDecl(Decl *sourceDecl, Decl* synthesizedDecl)
 {
   // sourceDecl->getClangDecl() can be null because some lazily instantiated cases like C++ members that were instantiated from using-shadow-decls have no corresponding Clang decl.
@@ -9372,17 +9437,40 @@ void ClangImporter::Implementation::importAttributes(
   if (auto func = dyn_cast<AbstractFunctionDecl>(MappedDecl))
     isAsync = func->hasAsync();
 
+  // Determine which versioned attributes are applicable
+  std::unordered_set<clang::Attr*> discardVersionedAttrSet;
+  if (SwiftContext.ClangImporterOpts.LoadVersionIndependentAPINotes)
+    filterUsableVersionedAttrs(ClangDecl, CurrentVersion.asClangVersionTuple(),
+                               discardVersionedAttrSet);
+
   // Scan through Clang attributes and map them onto Swift
   // equivalents.
   bool AnyUnavailable = MappedDecl->isUnavailable();
   for (clang::NamedDecl::attr_iterator AI = ClangDecl->attr_begin(),
        AE = ClangDecl->attr_end(); AI != AE; ++AI) {
+    clang::Attr *consideringAttr = *AI;
+    if (SwiftContext.ClangImporterOpts.LoadVersionIndependentAPINotes) {
+      if (auto versionedAttr = dyn_cast<clang::SwiftVersionedAdditionAttr>(consideringAttr)) {
+        // "type" and "nullability" attributes are handled earlier since they change
+        // the decl's type.
+        auto additionalAttr = versionedAttr->getAdditionalAttr();
+        if (isa<clang::SwiftTypeAttr>(additionalAttr) ||
+            isa<clang::SwiftNullabilityAttr>(additionalAttr))
+          continue;
+
+        if (discardVersionedAttrSet.count(versionedAttr))
+          continue;
+
+        consideringAttr = additionalAttr;
+      }
+    }
+
     //
     // __attribute__((unavailable))
     //
     // Mapping: @available(*,unavailable)
     //
-    if (auto unavailable = dyn_cast<clang::UnavailableAttr>(*AI)) {
+    if (auto unavailable = dyn_cast<clang::UnavailableAttr>(consideringAttr)) {
       auto Message = unavailable->getMessage();
       auto attr = AvailableAttr::createUniversallyUnavailable(C, Message);
       MappedDecl->getAttrs().add(attr);
@@ -9395,7 +9483,7 @@ void ClangImporter::Implementation::importAttributes(
     //
     // Mapping: @available(*, unavailable)
     //
-    if (auto unavailable_annot = dyn_cast<clang::AnnotateAttr>(*AI))
+    if (auto unavailable_annot = dyn_cast<clang::AnnotateAttr>(consideringAttr))
       if (unavailable_annot->getAnnotation() == "swift1_unavailable") {
         auto attr = AvailableAttr::createUnavailableInSwift(C, "", "");
         MappedDecl->getAttrs().add(attr);
@@ -9408,7 +9496,7 @@ void ClangImporter::Implementation::importAttributes(
     //
     // Mapping: @available(*,deprecated)
     //
-    if (auto deprecated = dyn_cast<clang::DeprecatedAttr>(*AI)) {
+    if (auto deprecated = dyn_cast<clang::DeprecatedAttr>(consideringAttr)) {
       auto Message = deprecated->getMessage();
       auto attr = AvailableAttr::createUniversallyDeprecated(C, Message, "");
       MappedDecl->getAttrs().add(attr);
@@ -9417,7 +9505,7 @@ void ClangImporter::Implementation::importAttributes(
 
     // __attribute__((availability))
     //
-    if (auto avail = dyn_cast<clang::AvailabilityAttr>(*AI)) {
+    if (auto avail = dyn_cast<clang::AvailabilityAttr>(consideringAttr)) {
       StringRef Platform = avail->getPlatform()->getName();
 
       // Is this our special "availability(swift, unavailable)" attribute?
@@ -9649,6 +9737,62 @@ void ClangImporter::Implementation::importAttributes(
   }
 }
 
+static void applyTypeAndNullabilityAPINotes(const clang::NamedDecl *ClangDecl,
+                                            clang::Sema &Sema,
+                                            const ImportNameVersion CurrentImporterVersion) {
+  // Determine which versioned attributes are applicable
+  std::unordered_set<clang::Attr*> discardVersionedAttrSet;
+  filterUsableVersionedAttrs(ClangDecl,
+                             CurrentImporterVersion.asClangVersionTuple(),
+                             discardVersionedAttrSet);
+
+  // When importing from a module built with version-independent APINotes payload,
+  // the decl will carry all possible versioned notes, without directly applying any
+  // of them. For "type" and "nullability" notes, we must apply them first, here,
+  // since they change the actual type of the decl as seen downstream.
+  //
+  // Other kinds of notes will be handled in `importAttributes`.
+  for (clang::NamedDecl::attr_iterator AI = ClangDecl->attr_begin(),
+       AE = ClangDecl->attr_end(); AI != AE; ++AI) {
+    if (auto versionedAttr = dyn_cast<clang::SwiftVersionedAdditionAttr>(*AI)) {
+      if (!isa<clang::SwiftTypeAttr>(versionedAttr->getAdditionalAttr()) &&
+          !isa<clang::SwiftNullabilityAttr>(versionedAttr->getAdditionalAttr())) {
+        continue;
+      }
+
+      if (discardVersionedAttrSet.count(versionedAttr))
+        continue;
+
+      // Apply Type APINotes
+      if (auto typeRenameAttr = dyn_cast<clang::SwiftTypeAttr>(versionedAttr->getAdditionalAttr())) {
+        Sema.ApplyAPINotesType(const_cast<clang::NamedDecl*>(ClangDecl),
+                               typeRenameAttr->getTypeString());
+      }
+
+      // Apply Nullability APINotes
+      if (auto nullabilityAttr = dyn_cast<clang::SwiftNullabilityAttr>(versionedAttr->getAdditionalAttr())) {
+        clang::NullabilityKind nullability;
+        switch (nullabilityAttr->getKind()) {
+          case clang::SwiftNullabilityAttr::Kind::NonNull:
+            nullability = clang::NullabilityKind::NonNull;
+            break;
+          case clang::SwiftNullabilityAttr::Kind::Nullable:
+            nullability = clang::NullabilityKind::Nullable;
+            break;
+          case clang::SwiftNullabilityAttr::Kind::Unspecified:
+            nullability = clang::NullabilityKind::Unspecified;
+            break;
+          case clang::SwiftNullabilityAttr::Kind::NullableResult:
+            nullability = clang::NullabilityKind::NullableResult;
+            break;
+        }
+
+        Sema.ApplyNullability(const_cast<clang::NamedDecl*>(ClangDecl), nullability);
+      }
+    }
+  }
+}
+
 Decl *
 ClangImporter::Implementation::importDeclImpl(const clang::NamedDecl *ClangDecl,
                                               ImportNameVersion version,
@@ -9660,6 +9804,24 @@ ClangImporter::Implementation::importDeclImpl(const clang::NamedDecl *ClangDecl,
   if (ClangDecl->isInvalidDecl())
     return nullptr;
 
+  // Private and protected C++ class members should never be used from Swift,
+  // however, parts of the Swift typechecker rely on being able to iterate over
+  // all of the stored fields of a particular struct. This means we still need
+  // to add private fields to the Swift AST.
+  // 
+  // Other kinds of private and protected C++ decls are not relevant for Swift.
+  clang::AccessSpecifier access = ClangDecl->getAccess();
+  if ((access == clang::AS_protected || access == clang::AS_private) &&
+      !isa<clang::FieldDecl>(ClangDecl))
+    return nullptr;
+
+  // If '-version-independent-apinotes' is used, then "type" and "nullability"
+  // notes are applied by the client (Importer) instead of the producer of the
+  // Clang module we are consuming. Do so now, early, since these notes
+  // affect the decl's type.
+  if (SwiftContext.ClangImporterOpts.LoadVersionIndependentAPINotes)
+    applyTypeAndNullabilityAPINotes(ClangDecl, getClangSema(), CurrentVersion);
+
   bool SkippedOverTypedef = false;
   Decl *Result = nullptr;
   if (auto *UnderlyingDecl = canSkipOverTypedef(*this, ClangDecl,

lib/Frontend/CompilerInvocation.cpp

@@ -2149,6 +2149,8 @@ static bool ParseClangImporterArgs(ClangImporterOptions &Opts, ArgList &Args,
     Opts.PCHDisableValidation |= Args.hasArg(OPT_pch_disable_validation);
   }
 
+  Opts.LoadVersionIndependentAPINotes |= Args.hasArg(OPT_version_independent_apinotes);
+
   if (FrontendOpts.DisableImplicitModules)
     Opts.DisableImplicitClangModules = true;
 

lib/Frontend/ModuleInterfaceLoader.cpp

@@ -2018,6 +2018,12 @@ InterfaceSubContextDelegateImpl::InterfaceSubContextDelegateImpl(
     GenericArgs.push_back(blocklist);
   }
 
+  // Inherit APINotes processing method
+  if (clangImporterOpts.LoadVersionIndependentAPINotes) {
+    GenericArgs.push_back("-version-independent-apinotes");
+    genericSubInvocation.getClangImporterOptions().LoadVersionIndependentAPINotes = true;
+  }  
+
   // Inherit the C++ interoperability mode.
   if (langOpts.EnableCXXInterop) {
     // Modelled after a reverse of validateCxxInteropCompatibilityMode