Swift Module Interfaces

2020-10-26 15:21:46 浏览数 (1)

前言

今天看到一篇讲 Swift Crash 的文章一个 Swift Crash 引发的讨论...原文作者从Swift源码和UIKitCore -[UIView(UIKitManual) autorelease] 汇编代码的角度对 crash 的原因进行了分析。

如下所示，下面是根据原文梳理的调用链：

但是，我们通过观察作者贴出来的汇编和源码会发现一些问题。

  • 测试环境是 x86_64 模拟器（从汇编代码反推）
  • __VaListBuilder.append { appendWords(arg._cVarArgEncoding) } 是 iOS 源码

但是，在 x86_64 架构下，上述appendWords(arg._cVarArgEncoding) 并不会被执行。

本文会通过两种方式对此进行证明。

本文只是完善 x86_64 场景的调用逻辑，不影响原文的结论。

方案一：根据宏定义区分

受宏定义[1]影响，原始的 Swift 代码会针对不同的架构&系统被编译为不同代码。

代码语言：javascript复制
#if (arch(x86_64) && !os(Windows)) || arch(s390x) || (arch(arm64) && !(os(macOS) || os(iOS) || os(tvOS) || os(watchOS) || os(Windows)))

第一种，就是原文提到的 iPhone 设备使用的 __VaListBuilder.append { appendWords(arg._cVarArgEncoding) } 。

因为模拟器属于 x86_64 架构，所以，它会产生另外一套代码。(具体的代码，可以根据方案二获取)。

方案二：根据 Swift Module Interfaces 区分

考虑到宏定义的逻辑梳理比较复杂，我们下面讲讲第二种验证方案。

首先，我们需要先了解一下 .swiftinferface 文件。

通过下面的命令，我们可以手动构建 Swift Module Interfaces 文件。

代码语言：javascript复制
 xcrun swiftc -enable-library-evolution -emit-module-interface-path Manger.swiftinferface -module-name Manager ./Manager.swift

输入文件：

代码语言：javascript复制
import Foundation
public class Manager: NSObject {
    public func mode() {
        print("mode")
    }

    @inlinable func mode1() {
        print("mode1")
    }

    deinit {
        let _ = String(format:"%P", self)
    }
}

class MY {
    func test() {
        let _ = Manager()
    }
}

autoreleasepool {
    MY().test()
}

编译器构建的 Manger.swiftinferface 文件内容如下所示：

代码语言：javascript复制
// swift-interface-format-version: 1.0
// swift-compiler-version: Apple Swift version 5.2.4 (swiftlang-1103.0.32.9 clang-1103.0.32.53)
// swift-module-flags: -target x86_64-apple-darwin19.6.0 -enable-objc-interop -enable-library-evolution -module-name test
import Foundation
import Swift
@objc @_inheritsConvenienceInitializers public class Manager : ObjectiveC.NSObject {
  public func mode()
  @inlinable internal func mode1() {
        print("mode1")
    }
  @objc deinit
  @objc override dynamic public init()
}

从上面的Manger.swiftinferface 文件，我们可以发现公共API 和 内联代码都会被保留构建产物中。

实际上，Swift Module Interfaces 文件具有以下特征：

  • 包含文本格式的公共 API
  • 包含可内联的代码
  • 不同CPU架构架构可以具有不同的版本
  • 跨编译器版本兼容性

通过打开 Xcode 的 “Build Libraries for Distribution” 开关，可以自动构建 .swiftinferface 文件

Swift.swiftinterface

根据 ABIStabilityManifesto.md#standard-library [2]文档，标准库必须保证二进制兼容性。

考虑到本文讨论的 appendWords(arg._cVarArgEncoding) 所在文件路径是 stdlib/public/core/VarArgs.swift。

所以，我们可以尝试通过 Swift.swiftinterface 查看不同宏定义下对应的代码。

arm64

以 arm64 为例，func append(_ arg: Swift.CVarArg) 的源码比较简单，它会直接调用 appendWords(arg._cVarArgEncoding)。

Arm64 对应的路径是 /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/usr/lib/swift/Swift.swiftmodule/arm64.swiftinterface

代码语言：javascript复制
@_fixed_layout final internal class __VaListBuilder {
  @inlinable internal init() {}
  @inlinable final internal func append(_ arg: Swift.CVarArg) {
    // Write alignment padding if necessary.
    // This is needed on architectures where the ABI alignment of some
    // supported vararg type is greater than the alignment of Int, such
    // as non-iOS ARM. Note that we can't use alignof because it
    // differs from ABI alignment on some architectures.

    // Write the argument's value itself.
    appendWords(arg._cVarArgEncoding)
  }

iPhone 模拟器（x86_64）

而 iPhone 模拟器（x86_64） 却会出现不同的结果：

iPhone 模拟器（x86_64） 对应的路径是 /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator.sdk/usr/lib/swift/Swift.swiftmodule/x86_64.swiftinterface

下面是 iPhone 模拟器（x86_64） func append(_ arg: Swift.CVarArg) 对应的源码。

代码语言：javascript复制
@usableFromInline
@_fixed_layout final internal class __VaListBuilder {
  ...
  
  @inlinable final internal func append(_ arg: Swift.CVarArg) {
    var encoded = arg._cVarArgEncoding

    let isDouble = arg is _CVarArgPassedAsDouble

    if isDouble && fpRegistersUsed < _countFPRegisters {
        var startIndex = _countGPRegisters
               (fpRegistersUsed * _fpRegisterWords)
      for w in encoded {
        storage[startIndex] = w
        startIndex  = 1
      }
      fpRegistersUsed  = 1
    }
    else if encoded.count == 1
      && !isDouble
      && gpRegistersUsed < _countGPRegisters {
        let startIndex = gpRegistersUsed
      storage[startIndex] = encoded[0]
      gpRegistersUsed  = 1
    }
    else {
      for w in encoded {
        storage.append(w)
      }
    }
  }
    ...
}

从源码文中，我们并没有看到 appendWords(arg._cVarArgEncoding) 相关的代码。

综上，我们可以梳理到以下的依赖关系：

func append(_ arg: Swift.CVarArg) 不同实现版本统计

下表是作者根据 /Applications/Xcode.app/Contents/Developer/Platforms 路径下面的Swift.swiftinterface整理的表格。

appendWords(arg._cVarArgEncoding)

var encoded = arg._cVarArgEncoding

arm 系列（armv7s arm64 arm64e armv7k 等）

x86_64

i386

参考文章

  • [1] https://github.com/apple/swift/blob/55e7050ffc35489398246671e4029efcdd527c55/stdlib/public/core/VarArgs.swift#L433
  • [2]https://github.com/apple/swift/blob/269d306b9d275aab5bd10f380a999e51901c5832/docs/ABIStabilityManifesto.md
  • https://medium.com/swiftify/swift-5-1-module-format-stability-best-time-migrate-objective-c-frameworks-a0434f5352a3
  • https://developer.apple.com/videos/play/wwdc2019/416/
swift jquery iphone ios xcode

0 人点赞