Modernize libdispatch for Swift 3 naming conventions

libdispatch の API 全体を、Swift 3 のネーミング規約とオブジェクト指向的なスタイルに沿って作り直します。Swift 3.0 で実装されています。ランタイムのオーバーヘッドを増やさずに、Swift から見たインターフェースだけを刷新する、という位置づけです。

導入部で示される書き換えのイメージは次のとおりです。

// 従来
let queue = dispatch_queue_create("com.test.myqueue", nil)
dispatch_async(queue) {
    print("Hello World")
}

// Swift 3 以降
let queue = DispatchQueue(label: "com.test.myqueue")
queue.asynchronously {
    print("Hello World")
}

型名を Swift 流に揃える

C の dispatch_*_t 型を、Swift のネーミングに合わせた型名にリネームします。主要な対応は次のとおりです。

また、C では説明用に使われていた dispatch_fd_t（ファイル記述子）や dispatch_block_t（ブロック）、dispatch_queue_attr_t（キューの属性）のような typealias は、Swift 側ではそれぞれ Int32、() -> ()、DispatchQueueAttributes のように「実体の型」あるいは OptionSet に置き換えられ、意味のない中間型として見えないようにします。

キューの作成とタスク投入をメソッドに寄せる

dispatch_queue_create はイニシャライザに、メインキューとグローバルキューの取得は DispatchQueue のクラスプロパティ／クラスメソッドに置き換わります。

let queue = DispatchQueue(label: "com.test.myqueue")
let main = DispatchQueue.main
let background = DispatchQueue.global(attributes: .qosBackground)

dispatch_sync / dispatch_async / dispatch_group_async のように「キューに対してブロックを投入する」系の関数は、DispatchQueue のメソッドとして synchronously(execute:) / asynchronously(group:qos:flags:execute:) にまとめられます。グループ、QoS、ワークアイテムのフラグはデフォルト引数として asynchronously 側に受け取り、1 つのメソッドで幅広い使い方をカバーします。

queue.asynchronously {
    print("Hello World")
}

queue.asynchronously(group: group, qos: .userInitiated) {
    print("Hello World")
}

queue.synchronously {
    print("Hello World")
}

dispatch_after 相当は after(when:execute:) / after(walltime:execute:)、グループ全体を待つ dispatch_group_wait は DispatchGroup.wait(timeout:)、通知用の dispatch_group_notify は DispatchGroup.notify(queue:exeute:) として、それぞれ対応する型のメソッドに移されます。

キュー固有データを型安全にする

dispatch_get_specific 系の API は、DispatchSpecificKey<Value> というジェネリックなキーを介して読み書きする形に置き換わります。キーに値の型情報が紐付くため、キャストなしで安全に取り出せるようになります。

let countKey = DispatchSpecificKey<Int>()
queue.setSpecific(key: countKey, value: 42)

let value: Int? = queue.getSpecific(key: countKey)            // 特定のキューから
let current: Int? = DispatchQueue.getSpecific(key: countKey)  // 現在のキュー階層から

ブロックへのメタデータ付与を専用クラスに切り出す

C の dispatch_block_* 系が作っていた「メタデータ付きブロック」は、DispatchWorkItem という明示的なクラスに置き換わります。通常のクロージャと型で区別できるため、誤って別物を渡してしまう事故を防げます。

let item = DispatchWorkItem(qos: .userInitiated) {
    print("Hello World")
}

queue.asynchronously(execute: item)

item.notify(queue: .main) {
    print("done on main")
}

item.cancel()
if item.isCancelled { /* ... */ }

DispatchWorkItem は asynchronously(execute:) / synchronously(execute:) の両方に渡せるため、同じ作業を複数の方法で実行したい場合にも扱いやすくなっています。

時間とインターバルを表す専用の型

dispatch_time_t は DispatchTime と DispatchWalltime の 2 つに分かれ、これらに対して足し引きする相対時間として DispatchTimeInterval（秒・ミリ秒・マイクロ秒・ナノ秒の enum）を導入します。Double による秒指定もサポートされるため、小数点付きの秒数でもサブ秒の整数値でも自然に書けます。

enum DispatchTimeInterval {
    case seconds(Int)
    case milliseconds(Int)
    case microseconds(Int)
    case nanoseconds(Int)
}

let a = DispatchTime.now() + 3.5             // 3.5 秒後
let b = DispatchTime.now() + .microseconds(350)

timer.setTimer(start: .now(), interval: .milliseconds(500))

DispatchTime は起動時からのモノトニックな時刻、DispatchWalltime はシステムの実時間（timespec から初期化可能）を表す、という役割分担になっています。

DispatchData を値型にする

dispatch_data_t は、もともとイミュータブルなバイト列を表すオブジェクトでした。これを Swift 上では RandomAccessCollection に適合する struct DispatchData として定義し直し、値型として扱えるようにします。Array<UInt8> のように添字アクセスや for-in でのイテレーションが可能になり、append、subdata(in:)、copyBytes(to:count:) のようなメソッドでデータの組み立てやコピーも自然に書けます。

var data = DispatchData.empty
data.append(buffer)       // UnsafeBufferPointer<UInt8> から追加
data.append(other)        // 別の DispatchData を追加

data.withUnsafeBytes { (ptr: UnsafePointer<UInt8>) in
    // 生バイト列にアクセス
}

data.enumerateBytes { buffer, byteIndex, stop in
    // 連続する領域ごとに走査
}

解放方法を指定する DispatchData.Deallocator として、.free（free を使う）、.unmap（munmap を使う）、.custom(DispatchQueue?, () -> Void)（独自の処理）が用意されています。

ディスパッチソースに型を付ける

C では単一の dispatch_source_t だったディスパッチソースに対して、種類ごとのプロトコルを導入して戻り値の型を強く型付けします。たとえば次のように、ソースの種類別のファクトリメソッドが、種類に対応したプロトコル型を返します。

let timer: DispatchSourceTimer =
    DispatchSource.timer(queue: queue)

let fileObserver: DispatchSourceFileSystemObject =
    DispatchSource.fileSystemObject(
        fileDescriptor: fd,
        eventMask: [.write, .delete],
        queue: queue)

let memoryPressure: DispatchSourceMemoryPressure =
    DispatchSource.memoryPressure(
        eventMask: [.warning, .critical],
        queue: queue)

種類別のプロトコルには次のようなものがあります。

また、イベントマスクやプロセスイベントのビットフラグは DispatchSource.ProcessEvent や DispatchSource.MemoryPressureEvent、DispatchSource.FileSystemEvent のような OptionSet 型としてネストされ、[.write, .delete] のように集合リテラルで組み立てられます。種類別のプロトコル経由でアクセスできるプロパティも、そのソースに意味のあるものだけに絞られるため、タイマー用のプロパティをプロセス監視ソースから触るといった誤用は型で弾かれます。

既存コードへの影響

libdispatch を使っている Swift コードはすべて影響を受けます。古い dispatch_queue_create や dispatch_async、dispatch_source_create、dispatch_data_create などの呼び出しは、新しい DispatchQueue / DispatchGroup / DispatchSource / DispatchData といった型のイニシャライザやメソッドに書き換わります。今日の Swift で当たり前に目にする DispatchQueue.main.asynchronously { ... } や DispatchQueue.global(qos: .background)、DispatchTime.now() + .milliseconds(500) といった書き方は、この提案による整理の結果として成立しています。