Download to read offline
![SwiftでCライブラリを呼ぶ方法
❷ヘッダファイルを参照できるようにする
ClangのModule機能を用いるとC言語の#includeをSwiftのimportに変換することができ
ます。
module.modulemapファイルの例
（uv.hをswiftでimport Cuvとして呼び出し、ビルド時は-luvオプションでリンクしてくれます)
module Cuv [system] {
header "/usr/local/include/uv.h"
link "uv"
export *
}
このような宣言をSwift Packageとしてgitのリポジトリに登録し、
Package.swiftでパッケージとして読み込めばヘッダの読み込み、ライブラリ
のリンクができるようになります。libuvなら実際にそのようなパッケージを
作っている人がいるので、それをPackage.swiftに記載すれば使えます。
package.swiftファイルの例
import PackageDescription
let package = Package(
name: "NetLib",
dependencies: [
.Package(url: "https://github.com/bontoJR/libCuv.git", majorVersion: 1)
]
)](https://image.slidesharecdn.com/20160627tokyoserversideswiftmeetup-160628152505/85/Swift-libuv-TIPS-10-320.jpg)
![Tips⬛︎対策
・呼び出せるタイプのクロージャから、本来呼び出したいクロージャを呼び出してあげる。
let calBackBag = unsafeBitCast(handle_addr, to: UnsafeMutablePointer<uv_stream_t>.self)
calBackBag.pointee.data = retainedVoidPointer { [unowned self]
(bytesRead:Int ,buffer:UVBuffer)->Void in
let uvData = UVData(lenBytes:bytesRead ,buffer: buffer)
callBack(self ,data: uvData)
}
uv_read_start(calBackBag, _alloc_buffer){ stream, bytesRead, buffer in
if let callback = unsafeFromVoidPointer(x: stream.pointee.data) as
((Int,UVBuffer) -> Void)? {
defer {
releaseRetainedPointer(x: callback)
buffer.pointee.base.deallocateCapacity(bytesRead)
}
呼び出せるタイプのクロージャ
呼び出せないタイプのクロージャ
（Selfをキャプチャしているため）
ここで本来呼び出したいクロージャを呼び出してい
る
Cから呼べないクロージャ
Cから呼べるクロージャ C関数
CallBack登録
呼び出し](https://image.slidesharecdn.com/20160627tokyoserversideswiftmeetup-160628152505/85/Swift-libuv-TIPS-18-320.jpg)
![Tips
⬛︎対策
・自分で変数のretain、release、バッファ領域の確保(allocate)、解放(deallocate)します
手動でのretain,releaseはSwiftのUnmanaged(struct)を用います。
let calBackBag = unsafeBitCast(handle_addr, to:UnsafeMutablePointer<uv_stream_t>.self)
calBackBag.pointee.data = retainedVoidPointer { [unowned self]
(bytesRead:Int ,buffer:UVBuffer)->Void in
let uvData = UVData(lenBytes:bytesRead ,buffer: buffer)
callBack(self ,data: uvData)
}
uv_read_start(calBackBag, _alloc_buffer){ stream, bytesRead, buffer in
if let callback = unsafeFromVoidPointer(x: stream.pointee.data) as
((Int,UVBuffer) -> Void)? {
defer {
releaseRetainedPointer(x: callback)
buffer.pointee.base.deallocateCapacity(bytesRead)
}
callback(bytesRead, UVBuffer(buffer))
}
}
retain
alloc
releaseとdealloc](https://image.slidesharecdn.com/20160627tokyoserversideswiftmeetup-160628152505/85/Swift-libuv-TIPS-20-320.jpg)
![Tips
⬛︎対策（もっといい方法があるかもしれませんが。。）
循環参照をローカル変数を使って制御する。
private func doReadPhase(){
var _selfKeeper:HttpProcessor? = self
do {
try client.read { [unowned self] result in
switch result {
case .success(let data):
self.doParsePhase(data: data)
case let .error(error) where error is Closed:
self.client.close()
_selfKeeper = nil
case .error(let error):
self.errorRespond(error: error)
}
}
} catch (let error) {
self.errorRespond(error: error)
}
}
クラス内でSelfを保持する（ローカル変数を介して
循環参照させる）
終わったらSelfを開放する。
このクラスごとARCが回収する。
クロージャはSelfを保持させないが、ローカル変数の
_selfKeeperはキャプチャーさせる](https://image.slidesharecdn.com/20160627tokyoserversideswiftmeetup-160628152505/85/Swift-libuv-TIPS-22-320.jpg)
Swiftからlibuvを呼び出すTIPS
- 1. libuvをつかうTIPS S w if はじめての @TokyoYoshida t か ら
- 2.
- 3.
- 4. とは 1日おくれ ・非同期I/Oを実現するためのC言語ライブラリ ・Node.jsで使用されている ・ノンブロッキングI/O ・・・ I/O時にブロックせず次の処理ができる ・イベント駆動・・・ I/O発生時に処理を動作させる ・シングルスレッド ・・・ 接続数に対してメモリを消費を抑えられる (Node.jsの説明より抜粋)
- 5.
- 6.
- 7. Swift Packageマネージャを使う 今回、プロジェクト作成はSwift Packageマネージャを使いました。 SwiftPackageマネージャはコマンドラインから使います。 ⬛︎プロジェクトの作成 swift build —— init ・・・ パッケージマネージャのプロジェクトを作成 swift build —X ・・・ Xcodeのプロジェクトを作成 Swiftで「Hello World」を出力するコマンドラインコマンドの プロジェクトが作成されます。 ⬛︎コーディング Sourceフォルダ以下にコードを書いていきます。XCodeを使って編集できます。 ⬛︎ビルド swift build ⬛︎実行ファイルを実行する .build/debug/パッケージ名
- 8.
- 9.
- 10. SwiftでCライブラリを呼ぶ方法 ❷ヘッダファイルを参照できるようにする ClangのModule機能を用いるとC言語の#includeをSwiftのimportに変換することができ ます。 module.modulemapファイルの例 （uv.hをswiftでimport Cuvとして呼び出し、ビルド時は-luvオプションでリンクしてくれます) module Cuv[system] { header "/usr/local/include/uv.h" link "uv" export * } このような宣言をSwift Packageとしてgitのリポジトリに登録し、 Package.swiftでパッケージとして読み込めばヘッダの読み込み、ライブラリ のリンクができるようになります。libuvなら実際にそのようなパッケージを 作っている人がいるので、それをPackage.swiftに記載すれば使えます。 package.swiftファイルの例 import PackageDescription let package = Package( name: "NetLib", dependencies: [ .Package(url: "https://github.com/bontoJR/libCuv.git", majorVersion: 1) ] )
- 11. SwiftでCライブラリを呼ぶ方法 ❸コードを書く Cの関数がいたって普通に呼び出すことができます。 （詳しくは後述） main.swiftの例 import Cuv var loop= uv_loop_new() uv_run(loop, UV_RUN_DEFAULT) uv.hを読み込む C関数の戻り値を受け取ったり、引数を渡す こともそのままできる
- 12. SwiftでCライブラリを呼ぶ方法 ❹ビルドする swift build でビルドすると、Cのライブラリもリンクしてくれます。 Swiftのバージョンによっては、なぜかlibuvのリンクエラーが出ます。 <エラーの内容> ld: librarynot found for -luv for architecture x86_64 <unknown>:0: error: link command failed with exit code 1 (use -v to see invocation) <unknown>:0: error: build had 1 command failures そんな時は、リンカーにパスを指定してあげれば良い。 swift build -Xlinker -L/usr/local/lib
- 13. コードの書き方 変数の型は読み替える必要があります。 //コメントはc言語の型 var a:CChar =1 // = char var b:CInt = 1 // = Int var c:CLong = 1 // = long var d:CFloat = 1.1 // = float var e:CDouble = 1.1 // = double //ポインタ var f:UnsafePointer<CChar> // const char * var g:UnsafePointer<CInt> // const int * var h:UnsafeMutablePointer<CChar> // char * var i:UnsafeMutablePointer<CInt> // int * //構造体 var j:sockaddr_in = sockaddr_in() // struct sockaddr_in { ... }
- 14. コードの書き方 C関数を呼ぶための書き方いろいろ。 // swift変数をポインタの引数として渡す場合は、&をつける var sock_addr_in= sockaddr_in() if uv_ip4_addr(host, Int32(port), &sock_addr_in) != UVResult.Success { print("Socket address init failed!") } // swift変数のアドレスをUnsafePointerに変換するにはwithUnsafePointerを使う var a:Int8 = 1 // = char var h:UnsafeMutablePointer<Int8> = withUnsafePointer(&a) { UnsafeMutablePointer<Int8>($0) } var x = h.pointee // ポインタから取り出すときはpointeeを使う。 // （Swift 3より。Swift 2まではmemory) print("value = (x)") // UnsafePointer同士は自由にキャストできる var i:UnsafeMutablePointer<Int32> = UnsafeMutablePointer<Int32>(h)
- 15. コードの書き方 C関数を呼ぶための書き方いろいろ。 // StringをC言語の文字列に変換するにはwithCStringを使う string.withCString { letcString = $0 var wbuf = uv_buf_init( UnsafeMutablePointer<Int8>(cString), UInt32(strlen(cString))) } //引数が関数ポインタをとる場合、クロージャをそのまま渡すことができる let ret = uv_listen(calBackBag, backLog){ server ,status in print(“dummy”) } // （補足）uv_listenのシグニチャは // int uv_listen(uv_stream_t* stream, int backlog, uv_connection_cb cb) // となっている。このうち、uv_connection_cbの宣言は // void (*uv_connection_cb)(uv_stream_t* server, int status) という関数ポインタである。
- 16.
- 17. Tips ⬛︎関数ポインタを渡す場合はいろいろと制約がある ・クロージャをC関数に渡そうとするとき、変数のキャプチャはできません。 <エラーの内容> error: a Cfunction pointer cannot be formed from a closure that captures context ・関数ポインタにはリテラククロジャーかトップレベルファンクションしか呼べません。 When calling a function that takes a function pointer argument, you can pass a top-level Swift function, a closure literal, or nil. （Apple The Swift Programming Languageより） ・他にもErrorをthrowするクロージャを渡せないという制約がありますが、このTips では扱いません。
- 18. Tips⬛︎対策 ・呼び出せるタイプのクロージャから、本来呼び出したいクロージャを呼び出してあげる。 let calBackBag =unsafeBitCast(handle_addr, to: UnsafeMutablePointer<uv_stream_t>.self) calBackBag.pointee.data = retainedVoidPointer { [unowned self] (bytesRead:Int ,buffer:UVBuffer)->Void in let uvData = UVData(lenBytes:bytesRead ,buffer: buffer) callBack(self ,data: uvData) } uv_read_start(calBackBag, _alloc_buffer){ stream, bytesRead, buffer in if let callback = unsafeFromVoidPointer(x: stream.pointee.data) as ((Int,UVBuffer) -> Void)? { defer { releaseRetainedPointer(x: callback) buffer.pointee.base.deallocateCapacity(bytesRead) } 呼び出せるタイプのクロージャ 呼び出せないタイプのクロージャ （Selfをキャプチャしているため） ここで本来呼び出したいクロージャを呼び出してい る Cから呼べないクロージャ Cから呼べるクロージャ C関数 CallBack登録 呼び出し
- 19.
- 20. Tips ⬛︎対策 ・自分で変数のretain、release、バッファ領域の確保(allocate)、解放(deallocate)します 手動でのretain,releaseはSwiftのUnmanaged(struct)を用います。 let calBackBag =unsafeBitCast(handle_addr, to:UnsafeMutablePointer<uv_stream_t>.self) calBackBag.pointee.data = retainedVoidPointer { [unowned self] (bytesRead:Int ,buffer:UVBuffer)->Void in let uvData = UVData(lenBytes:bytesRead ,buffer: buffer) callBack(self ,data: uvData) } uv_read_start(calBackBag, _alloc_buffer){ stream, bytesRead, buffer in if let callback = unsafeFromVoidPointer(x: stream.pointee.data) as ((Int,UVBuffer) -> Void)? { defer { releaseRetainedPointer(x: callback) buffer.pointee.base.deallocateCapacity(bytesRead) } callback(bytesRead, UVBuffer(buffer)) } } retain alloc releaseとdealloc
- 21.
- 22. Tips ⬛︎対策（もっといい方法があるかもしれませんが。。） 循環参照をローカル変数を使って制御する。 private func doReadPhase(){ var_selfKeeper:HttpProcessor? = self do { try client.read { [unowned self] result in switch result { case .success(let data): self.doParsePhase(data: data) case let .error(error) where error is Closed: self.client.close() _selfKeeper = nil case .error(let error): self.errorRespond(error: error) } } } catch (let error) { self.errorRespond(error: error) } } クラス内でSelfを保持する（ローカル変数を介して 循環参照させる） 終わったらSelfを開放する。 このクラスごとARCが回収する。 クロージャはSelfを保持させないが、ローカル変数の _selfKeeperはキャプチャーさせる
- 23. 今回作ったlibuvのラッパーライブラリを使ってHTTPのリクエスを受けてみました。 main.swiftの内容 func exampleOfWebServer(){ print("Now webstarting.") let framework = WebFrameWork() { error in return Response(body: Data("error page.")) } framework.add(responder: StaticWebPage(uri: URI(byPath:"/"), filePath: "public_html/test.html")) framework.run() } exampleOfWebServer() 実際にLibuvを呼び出してみる
- 24.
- 25. 参考文献 ⬛︎使用ライブラリ libuv https://github.com/libuv/libuv Zewo https://github.com/Zewo/Zewo OpenSwift https://github.com/open-swift ⬛︎先人たち bontoJR/Wing (https://github.com/bontoJR/Wing) thisweek in Swiftに記事がリンクされた方 noppoMan/Suv (https://github.com/noppoMan/Suv) Tokyo Serverside Meetupで登壇された方 chriseidhof/libuv-test(https://github.com/chriseidhof/libuv-test) try! Swiftで登壇された方 ⬛︎Cライブラリを呼ぶ時に参考になる資料 Apple The Swift Programming LanguageのC言語呼び出し関連の記述 https://developer.apple.com/library/ios/documentation/Swift/Conceptual/BuildingCocoaApps/InteractingWithCAPIs.html 詳解Swift SwiftでC言語のライブラリを使おう https://speakerdeck.com/yusukeito/swiftdecyan-yu-falseraiburariwoshi-ou