Sanitizer という英単語はあまり聞き慣れないですよね。辞書的には以下のような意味です。

sanitizerの意味 - 英和辞典 Weblio辞書

清浄剤、清浄薬、消毒剤、消毒薬、殺菌剤、殺菌薬、サニタイザー

Xcode で扱う際の「Address/Thread Sanitizer」の和訳は、「メモリアドレス・スレッドへの不正アクセスの検知機構」といったところでしょうか。

Thread SanitizerはXcode 8で、Address SanitizerはXcode 7で導入された仕組みです。ただ、Address SanitizerはXcode 7時点ではObjective-Cのみの対応で、Swift対応はXcode 8からです。なので、Swiftで扱うという観点だと、どちらもXcode 8からの機能とみなせます。

どちらもプロジェクトのスキーム設定のDiagnosticsタブで設定できますが、両方オンにはできなかったり他の設定と両立できないものがあります。

それでは、それぞれ見ていきましょう。

Address Sanitizer

不正なメモリアクセスを起こすために、UnsafePointerという、いかにも危険そうなstructを使ってみます。
第1・2引数を単純に足し合わせるadd(_:_:)関数を定義してみます。

まず、こちらは以下の例では正しく使っているので、問題無く動きます。Unsafeといえども、必要な箇所で正しい使い方をする分にはまったく問題無いです。

func add(_ x: UnsafePointer<Int>, _ y: UnsafePointer<Int>) -> Int {
    return x.pointee + y.pointee
}

var x = 1
var y = 2
let r = add(&x, &y) // → 3

(もちろん、このadd(_:_:)メソッドは例のためであって、普通UnsafePointerなんて使う必要はまったく無いですが。)

関数定義をこう変えても結果は同じです。

func add(_ x: UnsafePointer<Int>, _ y: UnsafePointer<Int>) -> Int {
    return x[0] + y[0]
}

一方、次のように変えると、rは2に変わります。

func add(_ x: UnsafePointer<Int>, _ y: UnsafePointer<Int>) -> Int {
    return x.pointee + y[1]
}

var x = 1
var y = 2
let r = add(&x, &y) // → 2

何が起こっているかというと、スタックのメモリの不正アクセスをしており、この時の場合y[1]が直前行のxの値の1となってしまっていました。

同様に次のようにすると、rは2018になりました。

var x = 1
var 🐶🎍 = 2017
var y = 2
let r = add(&x, &y) // → 2018

このまましれっと動いてしまうため、ヤバいバグに繋がりそうです(　´･‿･｀)

というわけで、Address Sanitizer機能をオンにしてみます。すると、このようにブレークし、

次のログが出力されます。

特に次のログに、Intのサイズを超えたメモリアクセスがなされたことが示されています。

This frame has 4 object(s):
    [32, 40) ''
    [64, 72) ''
    [96, 104) '' <== Memory access at offset 104 overflows this variable
    [128, 144) ''

通常のアプリ開発では、そもそもUnsafePointerなど扱うことは稀ですが、それらをよく扱うライブラリ作っている場合などは、ミス・バグの発見に役立ちそうですね。

Thread Sanitizer

続いて、Thread Sanitizer機能を使ってみます。

次のように、Monoクラスの単一インスタンスmのvalue書き換えを、async(group:qos:flags:execute:)メソッドを使って別スレッドからほぼ同時に行います。

class Mono {
    var value: Int = 0
}

let m = Mono()
DispatchQueue.global().async {
    m.value = 1
}
DispatchQueue.global().async {
    m.value = 2
}

Thread Sanitizer機能オフでは何も起こらず、m.valueは最終的には1か2になります(大抵2になりそうですが不定)。

一方、Thread Sanitizer機能をオンにすると次のようにブレークし(Pause on issuesもオンにした時のみ)、

次の警告ログが出力されます。

また、Xcodeの左ペインにも表示されます。

また、次のようにロック処理を挟むと、同じキューつまり同じスレッドで処理されるので、Thread Sanitizerで引っかからなくなることも確認できました👀

class Mono {
    private let lockQueue = DispatchQueue(label: "lock serial queue")
    var _value: Int = 0
    var value: Int {
        get { return lockQueue.sync { _value } }
        set { lockQueue.sync { _value = newValue } }
    }
}

参考: Swift 3での同期処理(排他制御)の基本 - Qiita

スレッドセーフになってないオブジェクトに、意図せず複数スレッドでアクセスしてしまった時の検知に良い感じに使えそうですね👀

その他の参考リンク

• Advanced Debugging and the Address Sanitizer - WWDC 2015 - Videos - Apple Developer
• Thread Sanitizer and Static Analysis - WWDC 2016 - Videos - Apple Developer
• Practical Swift | Eric Downey | Apress
  • 大いに参考にさせていただきました
• 🌨Swiftレター #9🌨 – Swift・iOSコラム – Medium
  • Understanding Data Race Detection by Implementing it in Swift · [Thinking inside a large box];の記事を紹介しました
• mookmook radio » Blog Archive » 熊谷と繪面がプログラミングコードの内から聴こえてくる声に耳を傾けて楽しむラジオ #9
  • unsafe系 APIの話してます(　´･‿･｀)