printf() and stdio in the Julia runtime

Libuv wrappers for stdio

julia.h は、stdio.h ストリーム用の libuv ラッパーを定義します。

uv_stream_t *JL_STDIN;
uv_stream_t *JL_STDOUT;
uv_stream_t *JL_STDERR;

また、対応する出力関数も定義します。

int jl_printf(uv_stream_t *s, const char *format, ...);
int jl_vprintf(uv_stream_t *s, const char *format, va_list args);

これらの printf 関数は、stdio が必要な箇所で、src/ ディレクトリおよび cli/ ディレクトリ内の .c ファイルから使用されます。これにより、出力バッファリングを統一的に処理できます。

シグナルハンドラーなど、libuv の全機能を使うには負荷が大きすぎる特殊なケースでは、jl_safe_printf() を使って、STDERR_FILENO に write(2) できます。

void jl_safe_printf(const char *str, ...);

Interface between JL_STD* and Julia code

Base.stdin、Base.stdout、Base.stderr は、ランタイムで定義される JL_STD* libuv ストリームにバインドされています。

Julia の __init__() 関数(base/sysimg.jl 内)は、reinit_stdio()(base/stream.jl 内)を呼び出し、Base.stdin、Base.stdout、Base.stderr に対応する Julia オブジェクトを作成します。

reinit_stdio() は ccall を使って JL_STD* へのポインターを取得し、jl_uv_handle_type() を呼び出して各ストリームの型を調べます。その後、各ストリームを表す Julia の Base.IOStream、Base.TTY、または Base.PipeEndpoint オブジェクトを作成します。例:

$ julia -e 'println(typeof((stdin, stdout, stderr)))'
Tuple{Base.TTY,Base.TTY,Base.TTY}

$ julia -e 'println(typeof((stdin, stdout, stderr)))' < /dev/null 2>/dev/null
Tuple{IOStream,Base.TTY,IOStream}

$ echo hello | julia -e 'println(typeof((stdin, stdout, stderr)))' | cat
Tuple{Base.PipeEndpoint,Base.PipeEndpoint,Base.TTY}

これらのストリームに対する Base.read および Base.write メソッドは、ccall を使って src/jl_uv.c 内の libuv ラッパーを呼び出します。例:

stream.jl: function write(s::IO, p::Ptr, nb::Integer)
               -> ccall(:jl_uv_write, ...)
  jl_uv.c:          -> int jl_uv_write(uv_stream_t *stream, ...)
                        -> uv_write(uvw, stream, buf, ...)

printf() during initialization

jl_printf() などが利用する libuv ストリームは、ランタイムの初期化が途中まで進むまでは使用できません(init.c、init_stdio() を参照)。それ以前に出力する必要があるエラーメッセージや警告は、次の仕組みによって標準 C ライブラリの fwrite() 関数に送られます。

sys.c では、JL_STD* ストリームポインターが整数定数 STD*_FILENO (0, 1 and 2) で静的に初期化されています。jl_uv.c では、jl_uv_puts() 関数が uv_stream_t* stream 引数を確認し、ストリームが STDOUT_FILENO または STDERR_FILENO に設定されている場合は fwrite() を呼び出します。

これにより、初期化完了前に特定のコードへ到達する可能性の有無にかかわらず、ランタイム全体で jl_printf() を一貫して使用できます。

Legacy ios.c library

src/support/ios.c ライブラリは femtolisp から継承されたものです。クロスプラットフォームのバッファー付きファイル I/O と、メモリー上の一時バッファーを提供します。

ios.c は、現在も次の箇所で使用されています。

  • src/flisp/*.c
  • src/dump.c – シリアライズ用のファイル I/O とメモリーバッファーに使用。
  • src/staticdata.c – シリアライズ用のファイル I/O とメモリーバッファーに使用。
  • base/iostream.jl – ファイル I/O に使用(libuv による同等機能については base/fs.jl を参照)。

これらのモジュールでの ios.c の使用は、ほぼ自己完結しており、libuv I/O システムとは分離されています。ただし、femtolisp がレガシーな ios_t ストリームを使って jl_printf() を呼び出す one place があります。

ios.h には、ios_t.bm フィールドを uv_stream_t.type に揃え、ios_t.bm に使われる値が有効な UV_HANDLE_TYPE の値と重ならないようにするハックがあります。これにより、uv_stream_t ポインターで ios_t ストリームを指せるようになります。

これは、jl_printf() の呼び出し元である jl_static_show() に、femtolisp の fl_print() 関数から ios_t ストリームが渡されるために必要です。Julia の jl_uv_puts() 関数では、これを特別に処理します。

if (stream->type > UV_HANDLE_TYPE_MAX) {
    return ios_write((ios_t*)stream, str, n);
}