SE-0193: Rename @_inlineable to @inlinable, @_versioned to @usableFromInline

Author: slavapestov

benchmark/single-source/PopFrontGeneric.swift

@@ -22,7 +22,7 @@ let arrayCount = 1024
 
 // This test case exposes rdar://17440222 which caused rdar://17974483 (popFront
 // being really slow).
-@_versioned
+@usableFromInline
 protocol MyArrayBufferProtocol : MutableCollection, RandomAccessCollection {
   mutating func myReplace<C>(
     _ subRange: Range<Int>,

benchmark/single-source/Queue.swift

@@ -28,7 +28,7 @@ public let QueueConcrete = BenchmarkInfo(
 
 // TODO: remove when there is a native equivalent in the std lib
 extension RangeReplaceableCollection where Self: BidirectionalCollection {
-  @_inlineable
+  @inlinable
   public mutating func popLast() -> Element? {
     if isEmpty { return nil}
     else { return removeLast() }

docs/StandardLibraryProgrammersManual.md

@@ -24,7 +24,7 @@ TODO: Should this subsume or link to [AccessControlInStdlib.rst](https://github.
         1. Customization hooks
     1. Use of classes, COW implementation, buffers, etc
     1. Compatibility, `@available`, etc.
-    1. Resilience, ABI stability, `@_inlineable`, `@_versioned`, etc
+    1. Resilience, ABI stability, `@inlinable`, `@usableFromInline`, etc
     1. Strings and ICU
     1. Lifetimes
         1. withExtendedLifetime, withUnsafe...,

include/swift/AST/Attr.def

@@ -166,7 +166,7 @@ SIMPLE_DECL_ATTR(nonobjc, NonObjC,
 SIMPLE_DECL_ATTR(_fixed_layout, FixedLayout,
                  OnVar | OnClass | OnStruct | UserInaccessible, 31)
 
-SIMPLE_DECL_ATTR(_inlineable, Inlineable,
+SIMPLE_DECL_ATTR(inlinable, Inlinable,
                  OnVar | OnSubscript | OnFunc | OnConstructor | OnDestructor |
                  UserInaccessible, 32)
 
@@ -259,9 +259,7 @@ SIMPLE_DECL_ATTR(_show_in_interface, ShowInInterface,
 DECL_ATTR(_cdecl, CDecl,
           OnFunc | LongAttribute | UserInaccessible, 63)
 
-// A testing attribute for Library Evolution ("resilience").
-// FIXME: Replace with improved @available attribute.
-SIMPLE_DECL_ATTR(_versioned, Versioned,
+SIMPLE_DECL_ATTR(usableFromInline, UsableFromInline,
                  OnFunc | OnVar | OnSubscript | OnConstructor |
                  OnDestructor | OnStruct | OnEnum | OnClass |
                  OnProtocol | LongAttribute | UserInaccessible,

include/swift/AST/Decl.h

@@ -2147,6 +2147,9 @@ class ValueDecl : public Decl {
   SourceLoc NameLoc;
   llvm::PointerIntPair<Type, 3, OptionalEnum<AccessLevel>> TypeAndAccess;
 
+private:
+    bool isUsableFromInline() const;
+
 protected:
   ValueDecl(DeclKind K,
             llvm::PointerUnion<DeclContext *, ASTContext *> context,
@@ -2232,8 +2235,6 @@ class ValueDecl : public Decl {
   /// \see getFormalAccess
   AccessLevel getFormalAccessImpl(const DeclContext *useDC) const;
 
-  bool isVersionedInternalDecl() const;
-
   /// Returns the access level specified explicitly by the user, or provided by
   /// default according to language rules.
   ///
@@ -2242,14 +2243,19 @@ class ValueDecl : public Decl {
   /// being used), features that affect formal access such as \c \@testable are
   /// taken into account.
   ///
+  /// If \p isUsageFromInline is true, the presence of the \c @usableFromInline
+  /// attribute will treat internal declarations as public. This is normally
+  /// false for name lookup and other source language concerns, but true when
+  /// computing the linkage of generated functions.
+  ///
   /// \sa getFormalAccessScope
   AccessLevel getFormalAccess(const DeclContext *useDC = nullptr,
-                              bool respectVersionedAttr = false) const {
+                              bool isUsageFromInline = false) const {
     assert(hasAccess() && "access not computed yet");
     AccessLevel result = TypeAndAccess.getInt().getValue();
-    if (respectVersionedAttr &&
+    if (isUsageFromInline &&
         result == AccessLevel::Internal &&
-        isVersionedInternalDecl()) {
+        isUsableFromInline()) {
       assert(!useDC);
       return AccessLevel::Public;
     }
@@ -2280,8 +2286,8 @@ class ValueDecl : public Decl {
                        bool respectVersionedAttr = false) const;
 
 
-  /// Copy the formal access level and @_versioned attribute from source.
-  void copyFormalAccessAndVersionedAttrFrom(ValueDecl *source);
+  /// Copy the formal access level and @usableFromInline attribute from source.
+  void copyFormalAccessFrom(ValueDecl *source);
 
   /// Returns the access level that actually controls how a declaration should
   /// be emitted and may be used.
@@ -5283,7 +5289,7 @@ class AbstractFunctionDecl : public GenericContext, public ValueDecl {
   /// The ResilienceExpansion for default arguments.
   ///
   /// In Swift 4 mode, default argument expressions are serialized, and must
-  /// obey the restrictions imposed upon inlineable function bodies.
+  /// obey the restrictions imposed upon inlinable function bodies.
   ResilienceExpansion getDefaultArgumentResilienceExpansion() const {
     return ResilienceExpansion(
         Bits.AbstractFunctionDecl.DefaultArgumentResilienceExpansion);
@@ -5835,7 +5841,7 @@ class EnumElementDecl : public ValueDecl {
   /// The ResilienceExpansion for default arguments.
   ///
   /// In Swift 4 mode, default argument expressions are serialized, and must
-  /// obey the restrictions imposed upon inlineable function bodies.
+  /// obey the restrictions imposed upon inlinable function bodies.
   ResilienceExpansion getDefaultArgumentResilienceExpansion() const {
     return ResilienceExpansion(
         Bits.EnumElementDecl.DefaultArgumentResilienceExpansion);

include/swift/AST/DiagnosticsSema.def

@@ -3712,30 +3712,30 @@ WARNING(discardable_result_on_void_never_function, none,
 //------------------------------------------------------------------------------
 
 ERROR(fixed_layout_attr_on_internal_type,
-      none, "'@_fixed_layout' attribute can only be applied to '@_versioned' "
+      none, "'@_fixed_layout' attribute can only be applied to '@usableFromInline' "
       "or public declarations, but %0 is "
       "%select{private|fileprivate|internal|%error|%error}1",
       (DeclName, AccessLevel))
 
 ERROR(versioned_attr_with_explicit_access,
-      none, "'@_versioned' attribute can only be applied to internal "
+      none, "'@usableFromInline' attribute can only be applied to internal "
       "declarations, but %0 is %select{private|fileprivate|%error|public|open}1",
       (DeclName, AccessLevel))
 
 ERROR(versioned_attr_in_protocol,none,
-      "'@_versioned' attribute cannot be used in protocols", ())
+      "'@usableFromInline' attribute cannot be used in protocols", ())
 
 ERROR(versioned_dynamic_not_supported,none,
-      "'@_versioned' attribute cannot be applied to 'dynamic' declarations", ())
+      "'@usableFromInline' attribute cannot be applied to 'dynamic' declarations", ())
 
 #define FRAGILE_FUNC_KIND \
   "%select{a '@_transparent' function|" \
   "an '@inline(__always)' function|" \
-  "an '@_inlineable' function|" \
+  "an '@inlinable' function|" \
   "a default argument value|" \
   "a property initializer in a '@_fixed_layout' type}"
 
-ERROR(local_type_in_inlineable_function,
+ERROR(local_type_in_inlinable_function,
       none, "type %0 cannot be nested inside " FRAGILE_FUNC_KIND "1",
       (DeclName, unsigned))
 
@@ -3750,21 +3750,21 @@ NOTE(resilience_decl_declared_here,
      none, "%0 %1 is not public", (DescriptiveDeclKind, DeclName))
 
 NOTE(resilience_decl_declared_here_versioned,
-     none, "%0 %1 is not '@_versioned' or public", (DescriptiveDeclKind, DeclName))
+     none, "%0 %1 is not '@usableFromInline' or public", (DescriptiveDeclKind, DeclName))
 
-ERROR(class_designated_init_inlineable_resilient,none,
+ERROR(class_designated_init_inlinable_resilient,none,
       "initializer for class %0 is "
-      "'%select{@_transparent|@inline(__always)|@_inlineable|%error}1' and must "
+      "'%select{@_transparent|@inline(__always)|@inlinable|%error}1' and must "
       "delegate to another initializer", (Type, unsigned))
 
 ERROR(attribute_invalid_on_stored_property,
       none, "'@%0' attribute cannot be applied to stored properties", (StringRef))
 
-ERROR(inlineable_dynamic_not_supported,
-      none, "'@_inlineable' attribute cannot be applied to 'dynamic' declarations", ())
+ERROR(inlinable_dynamic_not_supported,
+      none, "'@inlinable' attribute cannot be applied to 'dynamic' declarations", ())
 
-ERROR(inlineable_decl_not_public,
-      none, "'@_inlineable' attribute can only be applied to public declarations, "
+ERROR(inlinable_decl_not_public,
+      none, "'@inlinable' attribute can only be applied to public declarations, "
       "but %0 is %select{private|fileprivate|internal|%error|%error}1",
       (DeclBaseName, AccessLevel))
 

include/swift/AST/Module.h

@@ -107,13 +107,13 @@ enum class SourceFileKind {
 /// Discriminator for resilience strategy.
 enum class ResilienceStrategy : unsigned {
   /// Public nominal types: fragile
-  /// Non-inlineable function bodies: resilient
+  /// Non-inlinable function bodies: resilient
   ///
   /// This is the default behavior without any flags.
   Default,
 
   /// Public nominal types: resilient
-  /// Non-inlineable function bodies: resilient
+  /// Non-inlinable function bodies: resilient
   ///
   /// This is the behavior with -enable-resilience.
   Resilient

include/swift/SILOptimizer/Utils/PerformanceInlinerUtils.h

@@ -37,7 +37,7 @@ enum class InlineSelection {
   NoSemanticsAndGlobalInit
 };
 
-// Returns the callee of an apply_inst if it is basically inlineable.
+// Returns the callee of an apply_inst if it is basically inlinable.
 SILFunction *getEligibleFunction(FullApplySite AI,
                                  InlineSelection WhatToInline);
 

lib/AST/Decl.cpp

@@ -2102,19 +2102,19 @@ SourceLoc ValueDecl::getAttributeInsertionLoc(bool forModifier) const {
 }
 
 /// Returns true if \p VD needs to be treated as publicly-accessible
-/// at the SIL, LLVM, and machine levels due to being versioned.
-bool ValueDecl::isVersionedInternalDecl() const {
+/// at the SIL, LLVM, and machine levels due to being @usableFromInline.
+bool ValueDecl::isUsableFromInline() const {
   assert(getFormalAccess() == AccessLevel::Internal);
 
-  if (getAttrs().hasAttribute<VersionedAttr>())
+  if (getAttrs().hasAttribute<UsableFromInlineAttr>())
     return true;
 
   if (auto *accessor = dyn_cast<AccessorDecl>(this))
-    if (accessor->getStorage()->getAttrs().hasAttribute<VersionedAttr>())
+    if (accessor->getStorage()->getAttrs().hasAttribute<UsableFromInlineAttr>())
       return true;
 
   if (auto *EED = dyn_cast<EnumElementDecl>(this))
-    if (EED->getParentEnum()->getAttrs().hasAttribute<VersionedAttr>())
+    if (EED->getParentEnum()->getAttrs().hasAttribute<UsableFromInlineAttr>())
       return true;
 
   return false;
@@ -2251,15 +2251,15 @@ AccessScope ValueDecl::getFormalAccessScope(const DeclContext *useDC,
   llvm_unreachable("unknown access level");
 }
 
-void ValueDecl::copyFormalAccessAndVersionedAttrFrom(ValueDecl *source) {
+void ValueDecl::copyFormalAccessFrom(ValueDecl *source) {
   if (!hasAccess()) {
     setAccess(source->getFormalAccess());
   }
 
-  // Inherit the @_versioned attribute.
-  if (source->getAttrs().hasAttribute<VersionedAttr>()) {
+  // Inherit the @usableFromInline attribute.
+  if (source->getAttrs().hasAttribute<UsableFromInlineAttr>()) {
     auto &ctx = getASTContext();
-    auto *clonedAttr = new (ctx) VersionedAttr(/*implicit=*/true);
+    auto *clonedAttr = new (ctx) UsableFromInlineAttr(/*implicit=*/true);
     getAttrs().add(clonedAttr);
   }
 }
@@ -2806,7 +2806,7 @@ void ClassDecl::addImplicitDestructor() {
   setHasDestructor();
 
   // Propagate access control and versioned-ness.
-  DD->copyFormalAccessAndVersionedAttrFrom(this);
+  DD->copyFormalAccessFrom(this);
 
   // Wire up generic environment of DD.
   DD->setGenericEnvironment(getGenericEnvironmentOfContext());

lib/AST/DeclContext.cpp

@@ -397,17 +397,17 @@ ResilienceExpansion DeclContext::getResilienceExpansion() const {
       if (AFD->isTransparent())
         return ResilienceExpansion::Minimal;
 
-      if (AFD->getAttrs().hasAttribute<InlineableAttr>())
+      if (AFD->getAttrs().hasAttribute<InlinableAttr>())
         return ResilienceExpansion::Minimal;
 
       if (auto attr = AFD->getAttrs().getAttribute<InlineAttr>())
         if (attr->getKind() == InlineKind::Always)
           return ResilienceExpansion::Minimal;
 
-      // If a property or subscript is @_inlineable, the accessors are
-      // @_inlineable also.
+      // If a property or subscript is @inlinable, the accessors are
+      // @inlinable also.
       if (auto accessor = dyn_cast<AccessorDecl>(AFD))
-        if (accessor->getStorage()->getAttrs().getAttribute<InlineableAttr>())
+        if (accessor->getStorage()->getAttrs().getAttribute<InlinableAttr>())
           return ResilienceExpansion::Minimal;
     }
   }

lib/Demangling/OldDemangler.cpp

@@ -675,7 +675,7 @@ class OldDemangler {
                               Node::Kind::GenericSpecializationNotReAbstracted :
                               Node::Kind::GenericSpecialization);
 
-      // Create a node if the specialization is externally inlineable.
+      // Create a node if the specialization is externally inlinable.
       if (Mangled.nextIf("q")) {
         auto kind = Node::Kind::SpecializationIsFragile;
         spec->addChild(Factory.createNode(kind), Factory);
@@ -692,7 +692,7 @@ class OldDemangler {
       auto spec =
           Factory.createNode(Node::Kind::FunctionSignatureSpecialization);
 
-      // Create a node if the specialization is externally inlineable.
+      // Create a node if the specialization is externally inlinable.
       if (Mangled.nextIf("q")) {
         auto kind = Node::Kind::SpecializationIsFragile;
         spec->addChild(Factory.createNode(kind), Factory);

lib/SIL/SILDeclRef.cpp

@@ -288,15 +288,15 @@ SILLinkage SILDeclRef::getLinkage(ForDefinition_t forDefinition) const {
     // Three cases:
     //
     // 1) Type is formally @_fixed_layout. Root initializers can be declared
-    //    @_inlineable. The property initializer must only reference
+    //    @inlinable. The property initializer must only reference
     //    public symbols, and is serialized, so we give it PublicNonABI linkage.
     //
     // 2) Type is not formally @_fixed_layout and the module is not resilient.
-    //    Root initializers can be declared @_inlineable. This is the annoying
+    //    Root initializers can be declared @inlinable. This is the annoying
     //    case. We give the initializer public linkage if the type is public.
     //
     // 3) Type is resilient. The property initializer is never public because
-    //    root initializers cannot be @_inlineable.
+    //    root initializers cannot be @inlinable.
     //
     // FIXME: Get rid of case 2 somehow.
     if (isSerialized())
@@ -424,7 +424,7 @@ IsSerialized_t SILDeclRef::isSerialized() const {
     dc = getDecl()->getInnermostDeclContext();
 
     // Enum element constructors are serialized if the enum is
-    // @_versioned or public.
+    // @usableFromInline or public.
     if (isEnumElement())
       if (d->getEffectiveAccess() >= AccessLevel::Public)
         return IsSerialized;
@@ -441,7 +441,7 @@ IsSerialized_t SILDeclRef::isSerialized() const {
       return IsSerializable;
 
     // The allocating entry point for designated initializers are serialized
-    // if the class is @_versioned or public.
+    // if the class is @usableFromInline or public.
     if (kind == SILDeclRef::Kind::Allocator) {
       auto *ctor = cast<ConstructorDecl>(d);
       if (ctor->isDesignatedInit() &&
@@ -467,11 +467,11 @@ IsSerialized_t SILDeclRef::isSerialized() const {
   }
 
   // Declarations imported from Clang modules are serialized if
-  // referenced from an inlineable context.
+  // referenced from an inlinable context.
   if (isClangImported())
     return IsSerializable;
 
-  // Otherwise, ask the AST if we're inside an @_inlineable context.
+  // Otherwise, ask the AST if we're inside an @inlinable context.
   if (dc->getResilienceExpansion() == ResilienceExpansion::Minimal)
     return IsSerialized;
 

lib/SILOptimizer/LoopTransforms/LoopUnroll.cpp

@@ -198,7 +198,7 @@ static bool canAndShouldUnrollLoop(SILLoop *Loop, uint64_t TripCount) {
       if (auto AI = FullApplySite::isa(&Inst)) {
         auto Callee = AI.getCalleeFunction();
         if (Callee && getEligibleFunction(AI, InlineSelection::Everything)) {
-          // If callee is rather big and potentialy inlineable, it may be better
+          // If callee is rather big and potentialy inlinable, it may be better
           // not to unroll, so that the body of the calle can be inlined later.
           Cost += Callee->size() * InsnsPerBB;
         }

lib/SILOptimizer/Utils/PerformanceInlinerUtils.cpp

@@ -657,7 +657,7 @@ static bool isCallerAndCalleeLayoutConstraintsCompatible(FullApplySite AI) {
   return true;
 }
 
-// Returns the callee of an apply_inst if it is basically inlineable.
+// Returns the callee of an apply_inst if it is basically inlinable.
 SILFunction *swift::getEligibleFunction(FullApplySite AI,
                                         InlineSelection WhatToInline) {
   // For now, we cannot inline begin_apply at all.

lib/Sema/CodeSynthesis.cpp

@@ -2105,15 +2105,15 @@ swift::createDesignatedInitOverride(TypeChecker &tc,
   access = std::min(access, superclassCtor->getFormalAccess());
   ctor->setAccess(access);
 
-  // Inherit the @_versioned attribute.
-  if (superclassCtor->getAttrs().hasAttribute<VersionedAttr>()) {
-    auto *clonedAttr = new (ctx) VersionedAttr(/*implicit=*/true);
+  // Inherit the @usableFromInline attribute.
+  if (superclassCtor->getAttrs().hasAttribute<UsableFromInlineAttr>()) {
+    auto *clonedAttr = new (ctx) UsableFromInlineAttr(/*implicit=*/true);
     ctor->getAttrs().add(clonedAttr);
   }
 
-  // Inherit the @_inlineable attribute.
-  if (superclassCtor->getAttrs().hasAttribute<InlineableAttr>()) {
-    auto *clonedAttr = new (ctx) InlineableAttr(/*implicit=*/true);
+  // Inherit the @inlinable attribute.
+  if (superclassCtor->getAttrs().hasAttribute<InlinableAttr>()) {
+    auto *clonedAttr = new (ctx) InlinableAttr(/*implicit=*/true);
     ctor->getAttrs().add(clonedAttr);
   }