パッケージjava.lang.foreign
Javaランタイム外部のメモリーおよびファンクションへの低レベル・アクセスを提供します。
外部メモリー・アクセス
外部メモリー・アクセスをサポートするために導入される主な抽象化は、Javaヒープの内側または外側に存在するメモリーの連続したリージョンをモデル化するMemorySegment
です。 メモリー・セグメントは、通常、Arena
を使用して割り当てられます。これは、割り当てるセグメントをバッキングするメモリー・リージョンの存続期間を制御します。 メモリー・セグメントの内容は、サイズ、オフセットおよび整列制約を問い合せるための基本的な操作を提供するmemory layout
を使用して記述できます。 メモリー・レイアウトは、「レイアウト・パス」を使用して計算できる「varハンドル」を使用して「アクセス・メモリー・セグメント」に、より抽象的な代替方法も提供します。
たとえば、プリミティブ型int
の10個の値を保持するのに十分な大きさのメモリーのオフ・ヒープ・リージョンを割り当て、それを0
から9
の範囲の値で入力するには、次のコードを使用します:
try (Arena arena = Arena.ofConfined()) {
MemorySegment segment = arena.allocate(10 * 4);
for (int i = 0 ; i < 10 ; i++) {
segment.setAtIndex(ValueLayout.JAVA_INT, i, i);
}
}
int
の10値を格納するのに十分です。 ネイティブ・セグメントは、「限定アリーナ」を使用して割り当てられます。 そのため、ネイティブ・セグメントへのアクセスは、現在のスレッド(アリーナを作成したスレッド)に制限されます。 さらに、アリーナが閉じられると、ネイティブ・セグメントが無効になり、メモリーのバッキング・リージョンが解放されます。 try-with-resources構成の使用に注意してください: このアイディオムは、「Java言語仕様」の14.20.3項で説明するセマンティクスに従って、ネイティブ・セグメントをバッキングするメモリーのオフ・ヒープ・リージョンがブロックの最後に解放されるようにします。
メモリー・セグメントは、メモリー・アクセスに関して強力な安全性を保証します。 まず、メモリー・セグメントにアクセスする際、アクセス座標が(アクセス時)で検証され、アクセス操作によって使用されるメモリー・セグメントの境界が「外部」にあるアドレスでアクセスが行われないようにします。 この保証「空間安全」と呼ばれます。つまり、メモリー・セグメントへのアクセスは、「Java言語仕様」の15.10.4項で説明されているように、配列アクセスと同様に境界チェックされます。
また、メモリーのリージョンが (i.e. use-after-free)の割り当て解除後にアクセスされないようにするために、セグメントも (アクセス時)を検証して、取得元のアリーナが閉じられていないことを確認します。 ここでは、この保証「時間的安全」を呼び出します。
空間安全と時間的安全性を組み合せると、各メモリー・アクセス操作が成功することを確認できます - メモリー・セグメントをバッキングするメモリー・リージョン内の有効なロケーションにアクセス - または失敗。
外部ファンクション・アクセス
外部ファンクション・アクセスをサポートするために導入される主な抽象は、SymbolLookup
、FunctionDescriptor
およびLinker
です。 1つ目は、ライブラリ内のシンボルの検索に使用されます。2つ目は、外部ファンクションのシグネチャのモデル化に使用されます。3つ目は、外部ファンクションをMethodHandle
インスタンスとしてリンクするために使用されます。これにより、クライアントは、C/C++コード(Java Native Interface (JNI)の場合と同じです。)の中間レイヤーを必要とせずに、外部ファンクション・コールをJavaで直接実行できます。
たとえば、Linux/x64プラットフォームでC標準ライブラリ関数strlen
を使用して文字列の長さをコンピュートするには、次のコードを使用できます:
Linker linker = Linker.nativeLinker();
SymbolLookup stdlib = linker.defaultLookup();
MethodHandle strlen = linker.downcallHandle(
stdlib.findOrThrow("strlen"),
FunctionDescriptor.of(ValueLayout.JAVA_LONG, ValueLayout.ADDRESS)
);
try (Arena arena = Arena.ofConfined()) {
MemorySegment cString = arena.allocateFrom("Hello");
long len = (long)strlen.invokeExact(cString); // 5
}
strlen
関数を「探す」するために使用します。この関数をターゲットとする「downcallメソッド・ハンドル」は、その後「取得済」RESTRICTEDになります。 リンクを正常に完了するには、strlen
ファンクションのシグネチャを記述したFunctionDescriptor
インスタンスを指定する必要があります。 この情報から、リンカーは、基礎となるプラットフォームのABIで指定されたルールに従って、メソッド・ハンドルの起動(ここでは、MethodHandle.invokeExact(java.lang.Object...)
を使用して実行します。)を外部関数コールに変換する一連のステップを一意に決定します。
Arena
クラスは、前述の例に示すように、「変換中」 Java文字列をゼロで終了するUTF-8文字列に変換するなど、外部コードと対話するための多くの便利なメソッドも提供します。
- APIのノート:
- 通常のメモリー・モデルでは、ネイティブ・メモリー・セグメントへのアクセス時に(17.4を参照してください)が適用されないことが保証されます。これらのセグメントは、メモリーのオフ・ヒープ・リージョンによってバックアップされるためです。
- 導入されたバージョン:
- 22
- 外部仕様
-
インタフェースクラス説明メモリーの一部のリージョンのアドレスをモデル化するために使用される値のレイアウト。アリーナは、ネイティブ・メモリー・セグメントのライフサイクルを制御し、柔軟な割当てとタイムリな割当て解除の両方を提供します。関数記述子は、外部関数のシグネチャをモデル化します。複数の異種「メンバー・レイアウト」の集計である複合レイアウト。リンカーは、Javaコードから外部関数にアクセスでき、外部関数からJavaコードにアクセスできます。リンカー・オプションは、リンケージ・リクエストに追加のパラメータを指定するために使用されます。メモリー・レイアウトは、メモリー・セグメントの内容を記述します。「レイアウト・パス」内の要素。メモリー・セグメントは、メモリーの連続したリージョンへのアクセスを提供します。スコープは、関連付けられているすべてのメモリー・セグメントのlifetimeをモデル化します。パディング・レイアウト。「メモリー・セグメント」の割当てに使用できるオブジェクト。特定の「要素レイアウト」の均質な繰返しを示す複合レイアウト。メンバー・レイアウトが次々にレイアウトされるグループ・レイアウト。「シンボル・ルックアップ」は、1つ以上のライブラリ内のシンボルのアドレスを取得します。メンバー・レイアウトが同じ開始オフセットでレイアウトされるグループ・レイアウト。基本データ型の値をモデル化するレイアウト。キャリアが
boolean.class
の値レイアウト。キャリアがbyte.class
の値レイアウト。キャリアがchar.class
の値レイアウト。キャリアがdouble.class
の値レイアウト。キャリアがfloat.class
の値レイアウト。キャリアがint.class
の値レイアウト。キャリアがlong.class
の値レイアウト。キャリアがshort.class
の値レイアウト。