実験・実装 · 基礎から応用へ

オブジェクトの割当てとエスケープを調べる

計算結果を使うJavaの小例で割当てバイト数を測り、ソースのnewと実行時の割当てを区別します。

この記事をロゲイアに質問する確認問題3問に進むこれまでの誤答を復習する

更新日

この記事の目次
  1. newの回数と割当て量を分けて予測する
  2. JVM・フラグ・測定区間を固定する
  3. 二つのメソッドを別々に実装する
  4. 実測結果を読み、言える範囲を限定する
  5. 測定を壊す変更を見つける
  6. 差分の範囲をコード上で囲む
  7. 課題は予測・実行・説明を一組にする
  8. この記事をロゲイアに質問する理解を確かめる

newの回数と割当て量を分けて予測する

ソースにnewが書かれていても、実行時に毎回独立したオブジェクト領域が必要とは限りません。処理系が、その値を外部から観測できないと判断し、振る舞いを保てる場合には、フィールドの計算へ置き換えられることがあります。この実験では同じPairを繰り返し生成する二つのメソッドを比べます。一方は値を局所的に使い、もう一方はvolatileな静的フィールドへ保存します。

先にコンパイラと実行時の総論、およびGCの教材を読んでください。測るのは、現在のスレッドが割り当てたバイト数をJVMの管理APIが報告した値です。経過時間、GC後の生存量、プロセスの常駐メモリは測りません。ソース上の生成を数えるだけで実割当てを決めず、結果が使われないために計算全体が消える条件も避けます。sumを検査し表示することが、そのための実験条件です。

JVM・フラグ・測定区間を固定する

実測環境はUbuntuのOpenJDK 64-Bit Server VM 17.0.20+8-1-24.04-Ubuntuです。次のコードはJDK 17のソース起動で実行できます。ThreadMXBeanはcom.sun.managementの拡張を使うため、すべてのJava処理系に同じ機能があるとは限りません。対応していなければ例外で中止し、別の値を割当て量の代用として記録しないでください。

各メソッドを10万回の反復で20回ずつ呼んでから、50万回を一組として3回測ります。コンパイルと起動、ウォームアップ、出力処理は、各割当て差分の区間の外です。ウォームアップ回数はこの環境での条件であり、どのJVMでも最適化の完了を保証する数字ではありません。版とフラグを出力へ残し、同じファイルを有効・無効の二条件で別プロセスとして起動します。同時に別の条件まで変えないことが比較の基本です。

二つのメソッドを別々に実装する

コードをEscapeLab.javaへ保存します。java -XX:+DoEscapeAnalysis EscapeLab.javaを実行し、その後java -XX:-DoEscapeAnalysis EscapeLab.javaを実行してください。localとescapedを別メソッドにしている点を保ちます。一つのループ内に条件分岐を設けるだけでは、解析が同じように二つの経路を区別するとは限らないためです。

Pairのxとyはlongで、各反復の和は2i+1です。iが0からn-1までなら総和はnの二乗になり、nが50万なら250000000000です。intの範囲を超えるため、検査側でも(long)n * nを使います。escapedは各反復でsinkへ保存するので、参照がメソッドの外へ現れます。volatileへの書込みは別の費用も持ちますが、この教材は時間を比較していないため、二つの速度差を純粋な割当て費用とは呼びません。

java
import java.lang.management.ManagementFactory;
import com.sun.management.ThreadMXBean;

public class EscapeLab {
    static final class Pair {
        final long x, y;
        Pair(long x, long y) { this.x = x; this.y = y; }
    }
    static volatile Object sink;
    static long local(int n) {
        long sum = 0;
        for (int i = 0; i < n; i++) {
            Pair p = new Pair(i, i + 1);
            sum += p.x + p.y;
        }
        return sum;
    }
    static long escaped(int n) {
        long sum = 0;
        for (int i = 0; i < n; i++) {
            Pair p = new Pair(i, i + 1);
            sink = p;
            sum += p.x + p.y;
        }
        return sum;
    }
    public static void main(String[] args) {
        ThreadMXBean bean = (ThreadMXBean) ManagementFactory.getThreadMXBean();
        if (!bean.isThreadAllocatedMemorySupported())
            throw new UnsupportedOperationException("allocation counter unavailable");
        bean.setThreadAllocatedMemoryEnabled(true);
        int n = 500_000;
        for (int i = 0; i < 20; i++) {
            local(100_000);
            escaped(100_000);
        }
        long thread = Thread.currentThread().getId();
        System.out.println(System.getProperty("java.vm.name") + " "
            + System.getProperty("java.runtime.version"));
        System.out.println("flags=" + ManagementFactory.getRuntimeMXBean().getInputArguments());
        for (int round = 1; round <= 3; round++) {
            long before = bean.getThreadAllocatedBytes(thread);
            long a = local(n);
            long localBytes = bean.getThreadAllocatedBytes(thread) - before;
            before = bean.getThreadAllocatedBytes(thread);
            long b = escaped(n);
            long escapedBytes = bean.getThreadAllocatedBytes(thread) - before;
            if (a != (long)n * n || b != a)
                throw new AssertionError("incorrect result");
            System.out.printf("round=%d sum=%d localBytes=%d escapedBytes=%d%n",
                round, a, localBytes, escapedBytes);
        }
    }
}

実測結果を読み、言える範囲を限定する

有効にした実測では、3回ともlocalBytes=0、escapedBytes=16000000でした。無効にした実測では、3回とも両方が16000000でした。どちらの条件でもsumは250000000000です。少なくともこの実行では、同じ結果を返しながら、局所的な例の割当てカウンタが条件に応じて変わったことを確認できます。

この結果だけで「すべての局所変数はスタックに置かれる」とは言えません。オブジェクト自体が不要になり、フィールドに対応する値だけが扱われる可能性もあります。また、16000000という値から別のJVMのオブジェクト配置を一般化しないでください。ヘッダ、アラインメント、設定などが影響します。実行結果が異なる場合は、失敗と決めつけず、処理系とフラグ、ウォームアップ、コード変更を記録します。観測できない最適化を、起きたものとして補ってはいけません。

測定を壊す変更を見つける

sumの検査と出力を消すと、使われない計算を除去できる条件が変わります。sinkへの保存を一回だけに変えれば、外部へ現れるオブジェクトも変わります。printlnを反復内へ入れると、文字列や出力処理の割当てが測定区間へ混ざります。こうした変更は単なる書き方の違いではなく、何が観測可能かという実験条件の変更です。

別のスレッドが行う割当ては、このスレッド単位のカウンタでは同じように数えません。GCが起きた回数も、この差分には直接示されません。測定値の意味を外れた説明を避けるため、記録には「現在のスレッド」「測定区間の前後の差分」「3回の値」を含めます。合計だけを抜き出して結果を良く見せる必要はありません。一定しなければ全値を示し、より長いウォームアップなど一つの条件を変えて再測定します。

差分の範囲をコード上で囲む

測定の前後でカウンタを読む行の間へ、入力の生成や結果の文字列化を移すと、その割当ても差分へ含まれます。コード上で二つの読取り地点を囲み、その間に実行する処理を列挙してください。戻り値の検査は測定後にありますが、結果を後で使うため計算の意味は残ります。カウンタを有効にする準備やJVMの起動費用を含めていないことも、数値を比較する前提の一つです。

課題は予測・実行・説明を一組にする

課題としてnを25万へ変え、実行前にsumを求めてください。解答は62500000000です。同じ配置と最適化が保たれる場合、escapedの割当て量は元の半分に近づくと予測できますが、予測と実測を別の欄へ書きます。localが再び0になることも、どの環境でも成立するassertにはしません。振る舞いの正しさを検査するassertと、処理系の選択を観測するカウンタを分けるためです。

最後に、GCの教材で扱った生存集合と、この実験の割当て差分を比較してください。大量に割り当てても直後には不要になる場合があり、少量の割当てでもキャッシュが長く保持すれば生存量は増えます。解答では、この二つが異なる問いへの答えであることを示します。次のJIT教材では、観測に基づく仮定を使う最適化と、その仮定を保てなくなったときの処理へ進みます。

読了と問題の結果を、言語ごとにこのブラウザへ保存します。

コースの順番に沿って学ぶ

CS基礎を固める · STEP 20

学習コースから次を選ぶ