swift - 当 Swift 中的函数签名不同时，为什么 UnsafeRawPointer 显示不同的结果？

Question

下面的代码可以在 Swift Playground 中运行:

import UIKit

func aaa(_ key: UnsafeRawPointer!, _ value: Any! = nil) {
    print(key)
}
func bbb(_ key: UnsafeRawPointer!) {
    print(key)
}
class A {
    var key = "aaa"
}
let a = A()
aaa(&a.key)
bbb(&a.key)

这是打印在我的 mac 上的结果:

0x00007fff5dce9248
0x00007fff5dce9220

为什么两次打印的结果不同？更有趣的是，当我更改 的函数签名时bbb 使其与 相同aaa ，两次打印的结果是一样的。如果我使用 全局变量 而不是 a.key 在这两个函数调用中，两次打印的结果是相同的。有谁知道为什么会发生这种奇怪的行为？

Answer 1

Why the results of two prints differs?

因为对于每个函数调用， Swift is creating a temporary variable初始化为 a.key 返回的值 setter/getter 。每个函数被调用时带有一个指向它们给定临时变量的指针。因此，指针值可能会不同——因为它们指的是不同的变量。

这里之所以使用临时变量，是因为 A是一个非 final 类，因此可以有它的 getter 和 setter key被子类覆盖(可以很好地将其重新实现为计算属性)。

因此，在未优化的构建中，编译器不能只传递 key 的地址。直接调用函数，而是必须依赖于调用 getter(尽管在优化的构建中，这种行为可以完全改变)。

你会注意到，如果你标记 key如 final ，您现在应该在两个函数中获得一致的指针值:

class A {
    final var key = "aaa"
}

var a = A()
aaa(&a.key) // 0x0000000100a0abe0
bbb(&a.key) // 0x0000000100a0abe0

因为现在地址是 key可以只是 directly passed to the functions ，完全绕过它的 setter/getter 。

但值得注意的是，一般来说，您 不应该依赖这种行为。您在函数中获得的指针的值是纯粹的实现细节，不能保证稳定。编译器可以随意调用函数，只向你保证你得到的指针在调用期间是有效的，并且将指针初始化为预期值(如果是可变的，你对调用者将看到指针)。

此规则的唯一异常(exception)是传递指向全局和静态存储变量的指针。 Swift 确实保证您获得的指针值对于该特定变量将是稳定且唯一的。来自 Swift 团队的 blog post on Interacting with C Pointers (强调我的):

However, interaction with C pointers is inherently unsafe compared to your other Swift code, so care must be taken. In particular:

• These conversions cannot safely be used if the callee saves the pointer value for use after it returns. The pointer that results from these conversions is only guaranteed to be valid for the duration of a call. Even if you pass the same variable, array, or string as multiple pointer arguments, you could receive a different pointer each time. An exception to this is global or static stored variables. You can safely use the address of a global variable as a persistent unique pointer value, e.g.: as a KVO context parameter.

因此，如果您制作了 key A 的静态存储属性或者只是一个全局存储变量，您可以保证在两个函数调用中获得相同的指针值。

更改函数签名

When I change the function signature of bbb to make it the same with aaa, the result of two prints are the same

这似乎是一个优化的事情，因为我只能在 -O 构建和游乐场中重现它。在未优化的构建中，添加或删除额外参数不起作用。

(尽管值得注意的是，您不应该在 Playgrounds 中测试 Swift 行为，因为它们不是真正的 Swift 环境，并且可以表现出与使用 swiftc 编译的代码不同的运行时行为)

这种行为的原因只是一个巧合——第二个临时变量能够驻留在与第一个相同的地址(在第一个被释放之后)。当您向 aaa 添加额外参数时，将在它们之间分配一个新变量以保存要传递的参数的值，从而防止它们共享相同的地址。

由于 a 的中间负载，在未优化的构建中无法观察到相同的地址。为了调用 getter 的值 a.key .作为优化，编译器能够内联 a.key 的值。如果它有一个带有常量表达式的属性初始化器，则到调用站点，消除对这种中间负载的需要。

因此，如果你给 a.key一个不确定的值，例如 var key = arc4random() ，那么你应该再次观察不同的指针值，如 a.key的值不能再内联。

但不管原因如何，这是一个完美的例子，说明变量(不是全局或静态存储变量)的指针值是 不是 值得依赖——因为您获得的值可能会根据优化级别和参数计数等因素完全改变。
inout & UnsafeMutable(Raw)Pointer
关于 your comment :

But since withUnsafePointer(to:_:) always has the correct behavior I want (in fact it should, otherwise this function is of no use), and it also has an inout parameter. So I assume there are implementation difference between these functions with inout parameters.

编译器处理 inout参数的方式与 UnsafeRawPointer 略有不同范围。这是因为您可以改变 inout 的值函数调用中的参数，但您不能改变 pointee的 UnsafeRawPointer .

为了对 inout 的值进行任何更改参数对调用者可见，编译器通常有两个选项:

将临时变量初始化为变量的 getter 返回的值。使用指向此变量的指针调用函数，一旦函数返回，就使用临时变量的(可能已更改的)值调用变量的 setter。

如果它是可寻址的，只需使用指向该变量的直接指针调用该函数。

如上所述，编译器不能对未知为 final 的存储属性使用第二个选项。 (但这可以随着优化而改变)。但是，总是依赖第一个选项对于大值可能会很昂贵，因为它们必须被复制。这对于具有写时复制行为的值类型尤其有害，因为它们依赖于唯一性才能对其底层缓冲区执行直接突变——临时副本违反了这一点。

为了解决这个问题，Swift 实现了一个特殊的访问器——叫做 materializeForSet .这个访问器允许被调用者要么向调用者提供一个指向给定变量的直接指针(如果它是可寻址的)，要么返回一个指向包含变量副本的临时缓冲区的指针，在此之后需要将其写回 setter 它已被使用。

前者是您在 inout 中看到的行为– you're getting a direct pointer至 a.key返回 materializeForSet ，因此您在两个函数调用中获得的指针值是相同的。

然而， materializeForSet仅用于需要回写的函数参数，这就解释了为什么它不用于 UnsafeRawPointer .如果让 aaa的函数参数和 bbb取 UnsafeMutable(Raw)Pointer s(确实需要回写)，您应该再次观察相同的指针值。

func aaa(_ key: UnsafeMutableRawPointer) {
    print(key)
}

func bbb(_ key: UnsafeMutableRawPointer) {
    print(key)
}

class A {
    var key = "aaa"
}

var a = A()

// will use materializeForSet to get a direct pointer to a.key
aaa(&a.key) // 0x0000000100b00580
bbb(&a.key) // 0x0000000100b00580

但同样，如上所述，这种行为是 不是 依赖于非全局或静态的变量。