読者です 読者をやめる 読者になる 読者になる

自由課題

学んだり、考えたり、試したりしたこと。

node.jsを支えるlibuvのチュートリアル"uvbook" :基礎

C node.js

この文書はuvbookの日本語翻訳の一部となります。文書そのものの説明その他については目次をご覧ください。

libuvの基礎

libuvは 非同期イベント駆動 のプログラミングスタイルを強制します。 libuvの中心的な機能はイベントループとI/Oと他の活動(activity)の通知をベースにしたコールバックを提供することです。libuvはタイマのようなユーティリティ、ノンブロッキングのネットワークのサポート、非同期のファイルシステムへのアクセス、子プロセス等を提供します。

イベントループ

イベント駆動のプログラミングにおいては、アプリケーションは特定のイベントに対する興味を表明し、そのイベントが発生した時にこれらに反応します。OSか他の発生源からイベントを収集する責任はlibuvによって取り扱われ、ユーザはイベントが発生した時に実行されるコールバックを登録することができます。イベントループは通常 永久に 実行され続けます。擬似コードは以下のようになります:

    while there are still events to process:
        e = get the next event
        if there is a callback associated with e:
            call the callback

イベントの例には以下のようなものがあります

  • ファイルの書き込み準備ができている
  • ソケットが読み取り可能なデータを持っている
  • タイマが設定したタイミングに達した

このイベントループは uv_run() -- libuvを用いたときに結局実行される関数 -- によって隠蔽されています。

システムプログラミングのもっとも共通な処理は、複雑な計算というよりもむしろ入力と出力を取り扱うことです。一般的な入力/出力関数(read, fprintf, etc.)を用いる問題点は、これらが ブロッキング であるということです。ハードディスクに対する実際の書き込み、もしくはネットワークからのデータ読み出しは、プロセッサのスピードに比較して絶望的に長い時間を必要とします。これらの関数は処理が完了するまで制御が戻らないため、その間プログラムは何も行うことができません。高いパフォーマンスを必要とするプログラムにとって、これは他の処理や他のI/O操作が待たされ続けるため重要な障害となります。

標準的な解決策の一つはスレッドを用いることです。各ブロッキングI/O操作は分離されたスレッド(もしくはスレッドプール)の中で開始されます。スレッド内でブロッキング関数が実行されたとき、プロセッサは実際にCPU処理を必要としている実行すべき他のスレッドをスケジューリングすることができます。

libuvで採用されているアプローチはこれとは違うもので、非同期、ノンブロッキングなスタイルを用いています。ほとんどのモダンなOSはイベント通知のためのサブシステムを提供しています。例えば、ソケットに対する通常の read 呼び出しは送信側が何かを送信するまでブロックする可能性があります。それに対して、アプリケーションはOSにソケットを監視することを要求し、キューにイベントの通知を投入してもらうことができます。アプリケーションは都合の良い時(おそらくプロセッサを最大限に使う前にいくつかをガリガリ処理する)にイベントを解析しデータを把握します。これはアプリケーションがある時点で興味を示し、(時間的/空間的に)別の時点でデータを利用するために非同期です。また、これはアプリケーションは他の処理を行うことが自由であるためにノンブロッキングです。これはOSのイベントが単にlibuvイベントの別種として扱えるために、libuvのイベントループによるアプローチとよく合っていると言えます。ノンブロッキングはイベントが到着しても可能な限り早く他のイベントに対する処理を再開できることを可能にします*1

Note
どうI/Oがバックグラウンドで処理されるかというのは我々の感心事ではありませんが、コンピュータのハードウェアの処理方法と、プロセッサの基本単位としてのスレッドの関係のために、libuvと各種のOSは通常バックグラウンド/ワーカスレッドと、処理を行うためのノンブロックキングなポーリングを選択もしくは併用しています。

libuvのコア開発者の一人であるBert Belderはlibuvのアーキテクチャとその背景を短い動画にしている。もしlibuvもしくはlibevに関する経験がなければ、素早く理解するために有用なものになります。

Hello World

基本はさておき、最初のlibuvプログラムを書いてみましょう。すぐにexitするループを開始する以外には何もありません。

helloworld/main.c

    #include <stdio.h>
    #include <uv.h>

    int main() {
        uv_loop_t *loop = uv_loop_new();

        printf("Now quitting.\n");
        uv_run(loop, UV_RUN_DEFAULT);

        return 0;
    }

プログラムは処理すべきイベントがないため即座に終了します。libuvのイベントループは様々な関数を用いることによって、イベントを監視するように指示される必要があります。

デフォルトループ

デフォルトループはlibuvによって提供され、 uv_default_loop() を用いてアクセスすることができます。ループを一つだけ欲しい場合はこのループを用いるべきです。。

Note
node.jsはメインループとしてこのデフォルトループを用います。もしバインディングを作成する場合はこのことを気に留めておく必要があります。

エラーハンドリング

失敗する可能性があるlibuvの関数はエラー時に -1 を返却します。エラーコードそのものはイベントループ上で last_err としてセットされます。エラーコードとして code メンバを持つ uv_err_t 構造体を取得するために uv_last_error(loop) を使いましょう。 code はここに定義されるように UV_* の列挙です。

libuvのエラーコード

    XX( -1, UNKNOWN, "unknown error")                                           \
    XX(  0, OK, "success")                                                      \
    XX(  1, EOF, "end of file")                                                 \
    XX(  2, EADDRINFO, "getaddrinfo error")                                     \  
    XX(  3, EACCES, "permission denied")                                        \
    XX(  4, EAGAIN, "resource temporarily unavailable")                         \
    XX(  5, EADDRINUSE, "address already in use")                               \
    XX(  6, EADDRNOTAVAIL, "address not available")                             \
    XX(  7, EAFNOSUPPORT, "address family not supported")                       \
    XX(  8, EALREADY, "connection already in progress")                         \
    XX(  9, EBADF, "bad file descriptor")                                       \
    XX( 10, EBUSY, "resource busy or locked")                                   \
    XX( 11, ECONNABORTED, "software caused connection abort")                   \
    XX( 12, ECONNREFUSED, "connection refused")                                 \
    XX( 13, ECONNRESET, "connection reset by peer")                             \
    XX( 14, EDESTADDRREQ, "destination address required")                       \
    XX( 15, EFAULT, "bad address in system call argument")                      \
    XX( 16, EHOSTUNREACH, "host is unreachable")                                \
    XX( 17, EINTR, "interrupted system call")                                   \
    XX( 18, EINVAL, "invalid argument")                                         \
    XX( 19, EISCONN, "socket is already connected")                             \
    XX( 20, EMFILE, "too many open files")                                      \
    XX( 21, EMSGSIZE, "message too long")                                       \
    XX( 22, ENETDOWN, "network is down")                                        \
    XX( 23, ENETUNREACH, "network is unreachable")                              \
    XX( 24, ENFILE, "file table overflow")                                      \
    XX( 25, ENOBUFS, "no buffer space available")                               \
    XX( 26, ENOMEM, "not enough memory")                                        \
    XX( 27, ENOTDIR, "not a directory")                                         \
    XX( 28, EISDIR, "illegal operation on a directory")                         \
    XX( 29, ENONET, "machine is not on the network")                            \
    XX( 31, ENOTCONN, "socket is not connected")                                \
    XX( 32, ENOTSOCK, "socket operation on non-socket")                         \
    XX( 33, ENOTSUP, "operation not supported on socket")                       \
    XX( 34, ENOENT, "no such file or directory")                                \
    XX( 35, ENOSYS, "function not implemented")                                 \
    XX( 36, EPIPE, "broken pipe")                                               \
    XX( 37, EPROTO, "protocol error")                                           \
    XX( 38, EPROTONOSUPPORT, "protocol not supported")                          \
    XX( 39, EPROTOTYPE, "protocol wrong type for socket")                       \
    XX( 40, ETIMEDOUT, "connection timed out")                                  \
    XX( 41, ECHARSET, "invalid Unicode character")                              \
    XX( 42, EAIFAMNOSUPPORT, "address family for hostname not supported")       \
    XX( 44, EAISERVICE, "servname not supported for ai_socktype")               \
    XX( 45, EAISOCKTYPE, "ai_socktype not supported")                           \
    XX( 46, ESHUTDOWN, "cannot send after transport endpoint shutdown")         \
    XX( 47, EEXIST, "file already exists")                                      \
    XX( 48, ESRCH, "no such process")                                           \
    XX( 49, ENAMETOOLONG, "name too long")                                      \
    XX( 50, EPERM, "operation not permitted")                                   \
    XX( 51, ELOOP, "too many symbolic links encountered")                       \
    XX( 52, EXDEV, "cross-device link not permitted")                           \
    XX( 53, ENOTEMPTY, "directory not empty")                                   \
    XX( 54, ENOSPC, "no space left on device")                                  \
    XX( 55, EIO, "i/o error")                                                   \
    XX( 56, EROFS, "read-only file system")                                     \
    XX( 57, ENODEV, "no such device")                                           \
    XX( 58, ESPIPE, "invalid seek")                                             \
    XX( 59, ECANCELED, "operation canceled")                                    \

uv_strerror(uv_err_t)uv_err_name(uv_err_t) 関数を用いると、エラーやエラーの名前が格納された const char* を取得することができます。

非同期コールバックは最後の引数として status 引数を持ちます。これを戻り値の代わりに使ってください。

ウォッチャ

ウォッチャはlibuvのユーザが特定のイベントに対する興味を表明する方法です。ウォッチャはtypeがウォッチャがなんのためのものであるかを表明する uv_TYPE_t という名前の不透明(opaque)な構造体です。libuvによってサポートされているウォッチャの完全なリストは以下です:

libuvのウォッチャ

    typedef struct uv_loop_s uv_loop_t;
    typedef struct uv_err_s uv_err_t;
    typedef struct uv_handle_s uv_handle_t;
    typedef struct uv_stream_s uv_stream_t;
    typedef struct uv_tcp_s uv_tcp_t;
    typedef struct uv_udp_s uv_udp_t;
    typedef struct uv_pipe_s uv_pipe_t;
    typedef struct uv_tty_s uv_tty_t;
    typedef struct uv_poll_s uv_poll_t;
    typedef struct uv_timer_s uv_timer_t;
    typedef struct uv_prepare_s uv_prepare_t;
    typedef struct uv_check_s uv_check_t;
    typedef struct uv_idle_s uv_idle_t;
    typedef struct uv_async_s uv_async_t;
    typedef struct uv_process_s uv_process_t;
    typedef struct uv_fs_event_s uv_fs_event_t;
    typedef struct uv_fs_poll_s uv_fs_poll_t;
    typedef struct uv_signal_s uv_signal_t;

Note
全てのウォッチャの構造体は uv_handle_t のサブクラスであり、しばしば ハンドル と呼ばれます。このテキストでもこれに従います。

ウォッチャは各々下記の関数によってセットアップされます。

    uv_TYPE_init(uv_TYPE_t*)

Note
いくつかのウォッチャの初期化関数はループを第一引数として受け取ります。

ウォッチャは下記の関数をコールすることによりイベントを待ち受けるように設定され

    uv_TYPE_start(uv_TYPE_t*, callback)

下記の関数をコールすることによって待ち受けが停止されます

    uv_TYPE_stop(uv_TYPE_t*)

コールバックはウォッチャが興味を持ったイベントが発生したときにいつでもlibuvによってコールされる関数です。アプリケーション特有のロジックは通常コールバック内に実装されます。例えば、I/Oののコールバックはファイルから読み取ったデータを受け取り、タイマのコールバックはタイムアウトによって起動する、などです。

アイドリング

ウォッチャを用いた例です。アイドルのウォッチャは繰り返しコールされます。後に :doc:utilities で触れるいくつかの難解な意味の部分がありますが、今は無視しておきましょう。ウォッチャののライフサイクルを観察するためにアイドルのウォッチャを使い、 uv_run() はウォッチャが存在するためブロックされます。アイドルのウォッチャはカウントが規定の値に達すると停止し、 uv_run() は有効なウォッチャが存在しないため終了します。

idle-basic/main.c

    #include <stdio.h>
    #include <uv.h>
    
    int64_t counter = 0;
    
    void wait_for_a_while(uv_idle_t* handle, int status) {
        counter++;

        if (counter >= 10e6)
            uv_idle_stop(handle);
    }

    int main() {
        uv_idle_t idler;

        uv_idle_init(uv_default_loop(), &idler);
        uv_idle_start(&idler, wait_for_a_while);

        printf("Idling...\n");
        uv_run(uv_default_loop(), UV_RUN_DEFAULT);

        return 0;
    }

なお、スタック上にuv_TYPE_t構造体を割り当てる必要はありません。

*1:もちろん、ハードウェアの能力に依存します。