The World Age mechanism

Note

ワールドエイジは高度な概念です。大多数のJuliaユーザーにとって、ワールドエイジ機構はバックグラウンドで動作し、意識することはありません。このドキュメントは、ワールドエイジに関連する問題やエラーメッセージに遭遇する可能性のある、ごく一部のユーザーを対象としています。

Julia 1.12

Julia 1.12より前は、ワールドエイジ機構はグローバルバインディングテーブルへの変更には適用されませんでした。この章のドキュメントはJulia 1.12以降を対象としています。

Warning

このマニュアルの章では、説明の補助として、ワールドエイジやランタイムのデータ構造を調べる内部関数を使用します。特に断りのない限り、ワールドエイジ機構は安定したインターフェースではありません。パッケージから利用する場合は、安定したAPI(例:invokelatest)のみを通じて操作してください。特に、ワールドエイジが常に整数である、あるいは線形順序を持つと仮定しないでください。

World age in general

「ワールドエイジカウンター」は単調増加するカウンターで、グローバルメソッドテーブルまたはグローバルバインディングテーブルに変更があるたびに増加します(たとえば、メソッド定義、型定義、import/using宣言、(型付き)グローバル変数の作成、定数の定義など)。

グローバルなワールドエイジカウンターの現在値は、(内部)関数Base.get_world_counterで取得できます。

julia> Base.get_world_counter()
0x0000000000009632

julia> const x = 1

julia> Base.get_world_counter()
0x0000000000009633

さらに、各Taskはローカルワールドエイジを保持しており、実行中のタスクからグローバルバインディングテーブルおよびメソッドテーブルへのどの変更が見えるかを決定します。実行中のタスクのワールドエイジがグローバルワールドエイジカウンターを超えることはありませんが、そこから任意に遅れることがあります。一般に「現在のワールドエイジ」とは、現在実行中のタスクのローカルワールドエイジを指します。現在のワールドエイジは、(内部)関数Base.tls_world_ageで取得できます。

julia> function f end
f (generic function with 0 methods)

julia> begin
           @show (Int(Base.get_world_counter()), Int(Base.tls_world_age()))
           Core.eval(@__MODULE__, :(f() = 1))
           @show (Int(Base.get_world_counter()), Int(Base.tls_world_age()))
           f()
       end
(Int(Base.get_world_counter()), Int(Base.tls_world_age())) = (38452, 38452)
(Int(Base.get_world_counter()), Int(Base.tls_world_age())) = (38453, 38452)
ERROR: MethodError: no method matching f()
The applicable method may be too new: running in current world age 38452, while global world is 38453.

Closest candidates are:
  f() (method too new to be called from this world context.)
   @ Main REPL[2]:3

Stacktrace:
 [1] top-level scope
   @ REPL[2]:5

julia> (f(), Int(Base.tls_world_age()))
(1, 38453)

ここでは、メソッドfの定義によってグローバルワールドカウンターは増加しましたが、現在のワールドエイジは変化しませんでした。その結果、fの定義は実行中のタスクから見えず、MethodErrorが発生しました。

Note

メソッドエラーの表示には、f()がより新しいワールドエイジで利用可能であるという追加情報が含まれていました。この情報を追加するのはエラー表示であり、MethodErrorをスローしたタスクではありません。より新しいワールドエイジにf()の一致する定義が存在するかどうかにかかわらず、スローされるMethodErrorは同一です。

ただし、次のREPLプロンプトではf()の定義が利用可能になっていたことに注意してください。現在のタスクのワールドエイジが引き上げられていたためです。一般に、特定の構文(特にほとんどの定義)は、現在のタスクのワールドエイジを最新のグローバルワールドエイジまで引き上げます。これにより、現在のタスクおよび同時に実行中の他のタスクによるすべての変更が見えるようになります。次の文は現在のワールドエイジを引き上げます。

  1. Core.@latestworldの明示的な呼び出し
  2. 各トップレベル文の開始
  3. 各REPLプロンプトの開始
  4. 型または構造体の定義
  5. メソッド定義
  6. 定数宣言
  7. グローバル変数宣言(グローバル変数への代入は除く)
  8. using、import、export、またはpublic文
  9. @evalなど、その他の一部のマクロ(マクロの実装による)

ただし、現在のタスクのワールドエイジを永続的に引き上げられるのは、トップレベルに限られます。一般則として、上記の文をトップレベル以外のスコープで使うと構文エラーになります。

julia> f() = Core.@latestworld
ERROR: syntax: World age increment not at top level
Stacktrace:
 [1] top-level scope
   @ REPL[5]:1

ただし、@evalのように構文エラーにならない場合は、ワールドエイジへの副作用は無視されます。

これらの規則により、Juliaは通常の関数の実行中にワールドエイジが変化しないと仮定できます。

function my_function()
    before = Base.tls_world_age()
    # Any arbitrary code
    after = Base.tls_world_age()
    @assert before === after # always true
end

この不変条件により、Juliaはグローバルデータ構造の現在の状態に基づいて最適化を行いながら、それらのデータ構造を変更する機能を明確に提供できます。

Temporarily raising the world age using invokelatest

前述のとおり、タスクがトップレベル文を実行している場合を除き、Taskの実行が終わるまでワールドエイジを永続的に引き上げることはできません。ただし、invokelatestを使えば、スコープ内で一時的にワールドエイジを変更できます。

julia> function f end
f (generic function with 0 methods)

julia> begin
           Core.eval(@__MODULE__, :(f() = 1))
           invokelatest(f)
       end
1

invokelatestは、現在のタスクのワールドエイジを最新のグローバルワールドエイジ(invokelatestに入った時点)まで一時的に引き上げ、指定された関数を実行します。invokelatestを抜けると、ワールドエイジは元の値に戻ります。

World age and const struct redefinitions

メソッドの再定義について前述した意味論は、定数の再定義にも当てはまります。

julia> const x = 1
1

julia> get_const() = x
get_const (generic function with 1 method)

julia> begin
           @show get_const()
           Core.eval(@__MODULE__, :(const x = 2))
           @show get_const()
           Core.@latestworld
           @show get_const()
       end
get_const() = 1
get_const() = 1
get_const() = 2
2

ただし、誤解のないように付け加えると、通常のグローバル変数への代入には当てはまりません。グローバル変数への代入は直ちに見えるようになります。

julia> global y = 1
1

julia> get_global() = y
get_global (generic function with 1 method)

julia> begin
           @show get_global()
           Core.eval(@__MODULE__, :(y = 2))
           @show get_global()
       end
get_global() = 1
get_global() = 2
2

定数の再代入に関する特殊なケースの一つが、構造体型の再定義です。

julia> struct MyStruct
           x::Int
       end

julia> const one_field = MyStruct(1)
MyStruct(1)

julia> struct MyStruct
           x::Int
           y::Float64
       end

julia> const two_field = MyStruct(1, 2.0)
MyStruct(1, 2.0)

julia> one_field
@world(MyStruct, 38452:38455)(1)

julia> two_field
MyStruct(1, 2.0)

内部的には、MyStructの2つの定義は完全に別個の型です。しかし、新しいMyStruct型を定義すると、元のMyStruct定義に対するデフォルトのバインディングはなくなります。それでもこれらの型にアクセスできるようにするには、特殊な@worldマクロを使って、以前のワールドにおける名前の意味を参照できます。ただし、この機能はイントロスペクション専用です。また、ワールドエイジの番号はプリコンパイルをまたいで安定していないため、一般に不透明な値として扱う必要があります。

Binding partition introspection

特定のワールドエイジにおいて、システムがバインディングをどのように解釈するかを調べると役立つ場合があります。Core.Bindingのデフォルト表示は、その概要を把握するのに便利です(たとえば、前述のMyStructの例)。

julia> convert(Core.Binding, GlobalRef(@__MODULE__, :MyStruct))
Binding Main.MyStruct
   38456:∞ - constant binding to MyStruct
   38452:38455 - constant binding to @world(MyStruct, 38452:38455)
   38451:38451 - backdated constant binding to @world(MyStruct, 38452:38455)
   0:38450 - backdated constant binding to @world(MyStruct, 38452:38455)

World age and using/import

usingおよびimportを介して提供されるバインディングも、ワールドエイジ機構を通じて動作します。バインディングの解決は、現在のワールドエイジで見えるimportおよびusingの定義に基づく、状態を持たない関数です。たとえば、次のようになります。

julia> module M1; const x = 1; export x; end

julia> module M2; const x = 2; export x; end

julia> using .M1

julia> x
1

julia> using .M2

julia> x
ERROR: UndefVarError: `x` not defined in `Main`
Hint: It looks like two or more modules export different bindings with this name, resulting in ambiguity. Try explicitly importing it from a particular module, or qualifying the name with the module it should come from.

julia> convert(Core.Binding, GlobalRef(@__MODULE__, :x))
Binding Main.x
   38458:∞ - ambiguous binding - guard entry
   38457:38457 - implicit `using` resolved to constant 1

World age capture

一部の言語機能は、現在のタスクのワールドエイジを取り込みます。最も一般的な例の一つは、新しいタスクの作成です。新しく作成されたタスクは、作成時点で作成元タスクのローカルワールドエイジを引き継ぎます。その後、作成元タスクのワールドエイジが引き上げられても、明示的に引き上げない限り、そのワールドエイジを保持します。

julia> const x = 1

julia> t = @task (wait(); println("Running now"); x);

julia> const x = 2

julia> schedule(t);
Running now

julia> x
2

julia> fetch(t)
1

タスクに加えて、不透明クロージャも作成時のワールドエイジを取り込みます。Base.Experimental.@opaqueを参照してください。

Base.@world — Macro
@world(sym, world)

バインディング sym をワールド world で解決します。固定されたワールドで任意のコードを実行する方法については、invoke_in_world を参照してください。world は UnitRange の場合があり、その場合、バインディングが有効で、ワールド範囲全体で同じ値を持たない限り、マクロはエラーになります。

特例として、ワールド ∞ は常に最新のワールドを指します。これは、そのワールドが現在実行中のワールドより新しい場合も同様です。

@world マクロは、主に現在のワールドでは利用できなくなったバインディングを表示する際に使われます。

Example

julia> struct Foo; a::Int; end
Foo

julia> fold = Foo(1)

julia> Int(Base.get_world_counter())
26866

julia> struct Foo; a::Int; b::Int end
Foo

julia> fold
@world(Foo, 26866)(1)
Julia 1.12

この機能を使うには、Julia 1.12 以降が必要です。

source
Base.get_world_counter — Function
get_world_counter()

現在の最大ワールドエイジカウンターを返します。このカウンターは単調増加します。

Warning

このカウンターはグローバルな値であり、呼び出しの間にいつでも変化する可能性があります。一般に、ほとんどのリフレクション関数は、グローバルな最大ワールドエイジではなく、現在のタスクのワールドエイジを対象に動作します。tls_world_ageおよびmanual chapter of world ageも参照してください。

source
Base.invoke_in_world — Function
invoke_in_world(world, f, args...; kwargs...)

固定されたワールドエイジで f(args...; kwargs...) を呼び出します。world

これは、ユーザーの Julia セッション内で動作するものの、ユーザーのプログラムには含まれないインフラストラクチャに役立ちます。たとえば、REPL やエディターのサポートライブラリなどに関連するものです。このような場合、意図しないメソッドの無効化や再コンパイルによる遅延を防ぎ、ユーザーが誤ってサポート用インフラストラクチャを壊してしまうのを防ぐのに役立ちます。

グローバルなワールドエイジは Base.get_world_counter() を使って取得できます。取得した値は、現在の Julia セッションが続く間、またはシステムイメージをシリアライズして再読み込みする際に、後で使うために保存できます。

技術的には、invoke_in_world によって、f が呼び出す関数は、Julia セッション中にユーザーが拡張できなくなります。つまり、f(およびそれが呼び出す関数)から見えるジェネリック関数のメソッドテーブルは、指定された world の時点の状態に固定されます。ある意味では、これは invokelatest の逆のようなものです。

Note

プリコンパイル中に取得したワールドエイジを、後で使うために保存することはできません。プリコンパイルでは、ワールドエイジがメインの Julia セッションとは無関係なシステム状態を指す「並行宇宙」が生成されるためです。

source
Base.Experimental.@opaque — Macro
@opaque ([type, ]args...) -> body

指定したクロージャを「不透明」として扱います。不透明なクロージャは、呼び出し時ではなく、作成時のワールドエイジを捕捉します。これにより、キャプチャリストをより積極的に最適化できます。一方、作成箇所が静的に確認できない場合は、呼び出し箇所で不透明なクロージャをインライン化できなくなります。

許可する引数型をより柔軟に指定するため、引数タプル型(type)を任意で指定できます。特に、関数が可変長引数を受け取る場合でも、引数型を固定長にできます。

Warning

このインターフェースは実験的なものであり、予告なく変更または削除される可能性があります。

source