Let's Start Contributing to OpenJDK from Today!（Oracle Groundbreakers APAC Virtual Tour 2021 発表資料）

© 2021 NTT DATA Corporation
Let's Start Contributing to OpenJDK from Today!
今日からOpenJDKへのコントリビュートを始めよう！
2021年11月27日 Oracle Groundbreakers APAC Virtual Tour 2021
株式会社NTTデータ
阪田浩一

自己紹介
• Javaチャンピオン
• Oracle Groundbreakerアンバサダ
• OpenJDK Author
• 株式会社NTTデータ所属
© 2021 NTT DATA Corporation 2
Koichi Sakata
阪田浩一
jyukutyo

今日の内容
• OpenJDKの開発プロセス
• OpenJDKへのコントリビュート手順
• OpenJDKへのパッチ投稿の追体験

今日伝えたいこと
OpenJDKへのコントリビュートは
難しくありません
一緒にやっていきましょう！！

5
【クイズ】
9月にリリースされた最新バージョン
Java 17(LTS)で解決したIssueは何件でしょうか？
※OpenJDKのJIRAでのカウント
A. 1000~2000
B. 2000~3000
C. 3000~4000
D. 4000よりも多い

6
9月にリリースされた最新バージョン
Java 17(LTS)で解決したIssueは何件でしょうか？
A. 1000~2000
B. 2000~3000
C. 3000~4000
D. 4000よりも多い
【答え】
B The arrival of Java 17! https://blogs.oracle.com/java/post/announcing-java17
(2,645)

Java 17における組織別Issue解決数
The arrival of Java 17! https://blogs.oracle.com/java/post/announcing-java17

前提知識としての
OpenJDK開発プロセス

Java 17における組織別Issue解決数
1. Oracle社
2. Red Hat社
3. 個人開発者総計 (Independent)
4. SAP社
5. Tencent社
6. Amazon社
7. NTTデータ
8. Arm社
9. Alibaba社

JavaとOpenJDKの関係
• OpenJDKはJavaのオープンソース実装
» 多くの企業や組織、個人がその開発に貢献
• さまざまなベンダや組織が出しているJava(JDK)は
多くがOpenJDKベース

OpenJDKをどのように開発しているのか
• 他のOSSと開発の流れはおおむね同じ
• 開発規模が大きいため管理単位がいくつかある
» プロジェクト
» JEP
» JBS

OpenJDKのプロジェクト
• OpenJDKにおける新機能開発プロジェクト
» Project Lambda（ラムダ式）
» Project Jigsaw（モジュール）
» Project Valhalla
» Project Amber
» Project Panama
» Project Metropolis
» Project Loom
など
開発中の
プロジェクト

Project Amber
• プログラムの生産性を向上させることを目的として
小さな機能をいくつも管理するプロジェクト
» 近年の言語構文の変化はこのAmberから
• レコード
• パターンマッチ系
• シールクラス
• テキストブロック
• switch式
• など
» プロジェクト内の細かな機能ごとに1つのJEP（後述）となる

JEP: JDK Enhancement Proposals
• Javaの機能変更提案
» 追加
» 拡張
» 非推奨化
» 削除
• 各提案に番号を振り管理
» 例: JEP 406

JEPの例
JEP 406: Pattern Matching for
switch (Preview)
https://openjdk.java.net/jeps/406

Java 17
JDK 17 https://openjdk.java.net/projects/jdk/17/
JDK 17に
含まれる
JEP

JEPにあるIssue

JBS: JDK Bug System
https://bugs.openjdk.java.net/browse/JDK-8213076

JBS: JDK Bug System
• カスタマイズしたJIRA
» Issue管理システム
• 管理対象はバグだけではない
» 新機能追加
» 機能拡張
» バックポート
• などOpenJDK開発に関するあらゆることを管理
• Issue単位で実装を進めていく

JBS
JEP
複雑な新機能
プロジェクト Project Amber
パターンマッチ
JEP 305,375,394
(for instanceof)
Issue
8181287
Issue
8181287
Issue
8250623
JEP 405
(Record & Array)
Issue
8260244
JEP 406
(for switch)
Issue
8213076
Draft JEPs
他機能
パターンマッチでの開発プロセス
• 単一機能など複雑でなければプロジェクトに属さずJEPのみ作成
• 小さな拡張やバグはJEPではなくJBSのIssueのみで管理

OpenJDK開発への
コントリビュート手順

OpenJDKに貢献するさまざまな方法
1. パッチを出す
2. コードをレビューする
3. アイデアを出す
4. 議論に参加する
5. イベントで登壇して話す
6. ブログに投稿する
など

OpenJDKに貢献するさまざまな方法
2. コードをレビューする
3. アイデアを出す
4. 議論に参加する
5. イベントで登壇して話す
6. ブログに投稿する
など
今日話すこと

バグ修正を考える
• バグ修正でコントリビュートする手順
» 他のOSSにする場合とほとんど同じ一般的な手順

コントリビュートの手順
1. バグを見つける
2. バグを修正する
4. レビューを受ける
5. コメントに対応する
6. パッチがマージされる

1. ➡バグを見つける
2. バグを修正する

そもそもバグを見つけられる？
• OpenJDK上アプリケーションはうまく動いている
» OpenJDK起因のバグに出会うことはそうない
• ではどうやって修正が必要なポイントを見つけられる？

私が実施した方法
• 修正が必要なポイントをどのように見つけるか
1. ツールの新しいバージョンを使ってビルドしてみる

ツールの新しいバージョンでビルドする
• OpenJDKにはJavaコードだけでなくC++コードもある
• OpenJDKは複数のプラットフォームで
それぞれ異なるツールを使ってビルドする
» GCC, Clang, Visual Studio
» Linux, macOS, Windows (+WSL)
• 新たなエラーや警告が発生する場合がある
» 見つけたら修正を試みよう！

OpenJDKをビルドする手順
1. GitHubからOpenJDKのリポジトリをクローンする
2. $ sh configure [--enable-debug]
3. $ make images
(Omitted)

OpenJDKビルドのデモ

私の体験談
• GCC 10でビルドしてみて？という同僚のアドバイス
» 3つの警告が新たに発生した
» コントリビュートの機会をついに得た！
In file included from /home/jyukutyo/code/jdk/src/hotspot/share/classfile/systemDictionary.hpp:31,
from /home/jyukutyo/code/jdk/src/hotspot/share/classfile/javaClasses.hpp:28,
from /home/jyukutyo/code/jdk/src/hotspot/share/precompiled/precompiled.hpp:35:
In member function 'void Symbol::byte_at_put(int, u1)',
inlined from 'Symbol::Symbol(const u1*, int, int)' at
/home/jyukutyo/code/jdk/src/hotspot/share/oops/symbol.cpp:55:16:
/home/jyukutyo/code/jdk/src/hotspot/share/oops/symbol.hpp:130:18: error: writing 1 byte into a region of
size 0 [-Werror=stringop-overflow=]
130 | _body[index] = value;
| ~~~~~~~~~~~~~^~~~~~~
(omitted)

GCC 10での変更点
33
GCC 10 Release Series — Changes, New Features, and Fixes https://gcc.gnu.org/gcc-10/changes.html

2. JDK Bug System (JBS)で課題を検索してみる

JDK Bug System (JBS)
• OpenJDKのバグトラッキングシステム
» https://bugs.openjdk.java.net/projects/JDK/issues/

ラベルでフィルターする
• OpenJDKのバグトラッキングシステム
» https://bugs.openjdk.java.net/projects/JDK/issues/
» 読み取り専用なら誰でも利用可能
» starterラベルでフィルターする
• starterラベルは初心者向け
• clean-upラベルも同様

2. JDK Bug System (JBS)で課題を検索してみる

1. ✅バグを見つける
2. ➡バグを修正する

テストの実行も重要
• （コードの修正方法は内容に依存するので）
コードの修正が完了したと仮定します
• 対応するテストを実行する必要がある

• （コードの修正方法は内容に依存するので）
コードの修正が完了したと仮定します
» Javaコードのテストツール: jtreg
• リグレッションテストハーネス
• https://openjdk.java.net/jtreg/index.html

jtregのテスト実行デモ

» C++コードのテストツール: gtest (GoogleTest)
• Google C++テスティングフレームワーク

» C++コードのテストツール: gtest (GoogleTest)
• Google C++テスティングフレームワーク
$ ./build/linux-x86_64-server-fastdebug/hotspot/variant-server/libjvm/gtest/gtestLauncher -jdk:./build/linux-
x86_64-server-fastdebug/jdk --gtest_filter=LogConfigurationTest.*
Note: Google Test filter = LogConfigurationTest.*
[==========] Running 15 tests from 1 test case.
[----------] Global test environment set-up.
[----------] 15 tests from LogConfigurationTest
[ RUN ] LogConfigurationTest.describe_vm
[ OK ] LogConfigurationTest.describe_vm (1 ms)
(omitted)
[==========] 15 tests from 1 test case ran. (659 ms total)
[ PASSED ] 15 tests.

2. ✅バグを修正する
3. ➡パッチを出す

一番初めにすること
• メーリングリストにメールを送る
» 問題を詳細に説明する
» すでに修正パッチを書いているならそれも合わせて送る

メーリングリスト
• パッチだけでなくさまざまなことがここから始まる
» https://mail.openjdk.java.net/

• 200以上のメーリングリスト

• 200以上のメーリングリスト
» hotspot-dev - JVM
» compiler-dev - Javaコンパイラ
» core-libs-dev - Javaクラスライブラリ
» jdk-dev - 総合的なJDKに関する議論を扱う

私の体験談
• パブリックなメーリングリストに
英語でメールを送る！？
» 怖い...

私の体験談
• パブリックなメーリングリストに
英語でメールを送る！？
» 怖い...
» 大丈夫！
• 多くの人は親切で丁寧に対応してくれます
» 私たちのように英語が第2言語の人に対しても

私の初めてのメール

結果として
• JBSにイシューが登録される
» プルリクエストを作成する段階になった！

OpenJDKのソースコードリポジトリ
https://github.com/openjdk/jdk
• GitおよびGitHubを利用
» ただしプルリクエストファーストではない
• 開発者ロールがない場合は
まずメーリングリストへ投稿する
» 以前はMercurialを利用していた
• Project Skara
» Git, GitHubへの移行
» 新規開発者への敷居を低くするため
» JEP 357, 369

JBSとGitHubの関係
• JBSにすべてのイシューが登録される
» JBSのイシューNo.をプルリクエストのタイトルに含める
• PRへのコメントは関連するメーリングリストに
メールとして送られる
» 逆にメールで返信すればPRへのコメントとして投稿される

プルリクエストを送る
• OCAにサインする必要がある
» Oracle Contribution Agreement
» https://oca.opensource.oracle.com/

プルリクエストを送る
• いつものように作成する

3. ✅パッチを出す
4. ➡レビューを受ける

レビューを受ける
• Reviewerからレビューを受ける必要がある
» ReviewerとはOpenJDK開発でのロールの1つ

• Reviewerからレビューを受ける必要がある
» ReviewerとはOpenJDK開発でのロールの1つ
• OpenJDK開発のロール
» Reviewer - Committer + PRのレビュー
» Committer - Author + コミットとPRのスポンサー
» Author - JBSの編集
全世界で
ReviewerとCommitterは
合わせて300人強います

4. ✅レビューを受ける
5. ✅コメントに対応する
6. ➡パッチがマージされる

スポンサーになってくれる人を見つける
• レビューが終わっても自分でPRはマージできない
» "スポンサー"が必要
• ReviewerかCommitterがスポンサーになれる
• スポンサーがPRのマージを実施する

(Omitted)

完了！
4. ✅レビューを受ける
5. ✅コメントに対応する
6. ✅パッチがマージされる

実際のパッチ投稿を
追体験

バグを見つける
• GCC 10が出た後Linuxでビルドした
» 3つの警告が新たに発生した
» コントリビュート機会をついに得た！
In file included from /home/jyukutyo/code/jdk/src/hotspot/share/classfile/systemDictionary.hpp:31,
from /home/jyukutyo/code/jdk/src/hotspot/share/classfile/javaClasses.hpp:28,
from /home/jyukutyo/code/jdk/src/hotspot/share/precompiled/precompiled.hpp:35:
In member function 'void Symbol::byte_at_put(int, u1)',
inlined from 'Symbol::Symbol(const u1*, int, int)' at
/home/jyukutyo/code/jdk/src/hotspot/share/oops/symbol.cpp:55:16:
/home/jyukutyo/code/jdk/src/hotspot/share/oops/symbol.hpp:130:18: error: writing 1 byte into a region of
size 0 [-Werror=stringop-overflow=]
| ~~~~~~~~~~~~~^~~~~~~
(omitted)

バグを修正する
• 警告の内容を確認（抜粋）
/home/jyukutyo/code/jdk/src/hotspot/share/oops/symbol.hpp:130:18: error:
writing 1 byte into a region of size 0 [-Werror=stringop-overflow=]
| ~~~~~~~~~~~~~^~~~~~~
/home/jyukutyo/code/jdk/src/java.base/share/native/libfdlibm/k_standard.c:743:19:
error: 'exc.retval' may be used uninitialized in this function [-Werror=maybe-
uninitialized]
743 | return exc.retval;
| ~~~^~~~~~~
/home/jyukutyo/code/jdk/src/java.base/unix/native/libnet/NetworkInterface.c:974:13:
/usr/include/x86_64-linux-gnu/bits/string_fortified.h:106:10: error:
'__builtin_strncpy' output may be truncated copying 15 bytes from a string of length 15
[-Werror=stringop-truncation]
106 | return __builtin___strncpy_chk (__dest, __src, __len, __bos (__dest));
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

バグを修正する
• 以下のコードが対象
» symbol.{hpp,cpp}
» k_standard.c
» NetworkInterface.c

四苦八苦しながら
修正する
（各ファイル数行）
理解の記録：https://www.sakatakoichi.com/entry/2020/06/22/HotSpot_VMのシンボル名に関わるコード

最新リビジョンで最終確認をする
• 念のため複数のGCCバージョンで
ビルドを実行して確認した
» ビルドなので確認に時間がかかる

メーリングリストにパッチを送る
どのMLに出す？？

• hotspot-runtime-devのMLへパッチをメールする
↓
• 一部をJBSにissue登録してもらえた
• パッチに対するコメントももらえた

ただ、ここから反応がなく
数週経ってしまう

• 一部をJBSへ登録してもらえた
• パッチに対するコメントももらえた
↓
• 再度メールし「この課題を進めたいです」と
主張してみる
↓
• パッチへのコメントが再開
• 最終的にレビューまで進んだ！

参考: MLへの英語メール
• 文章表現がとても難しく感じた
» ビジネスメールでもない
» プライベートでもない
» メールなのでGitHubでやり取りするときの感じだと
簡素すぎ！？
• 数行の英語メールを書くのにものすごく時間がかかる
» Google翻訳で英語を書き
和訳が変でないかを確認する
• （日本語を英語にするのではなく逆にする）

主要開発者の方
からも長文の
コメントをもらえた

スポンサーを見つけリポジトリへプッシュしてもらう
• パッチへのコメントから最終的にレビューまで進んだ！
↓
• レビュー者にスポンサーとしてリポジトリにプッシュし
てもらえた

ついに僕も
JVMの一部に…！

めでたしめでたし
（ん！？待てよ）

• hotspot-runtime-devのMLへパッチをメールする
↓
• 一部をJBSへ登録してもらえた

パッチの残りの部分を
新たに進めなくては！

私がやるべきこと
• メーリングリストにパッチをメールする
» 別のML（core-libs-dev）に
パッチの残りの部分をメールする
• スポンサーを見つける
• スポンサーにパッチを適用し
リポジトリへプッシュしてもらう

• 別のML（core-libs-dev）にパッチの残りの部分を
メールする
↓
• 残りの中のさらに一部をレビューしてもらえた
• 最後の1ファイルは長年更新がなくレビューできる人が
簡単に見つからない
↓
• コード修正ではない解決方法を模索し提案をメールする
» ビルドでその警告を無視する設定など

• しばらくやり取りしていると、
ここをレビューできる方からメールがあり
（つまりOpenJDK主要開発者からのメール）
レビューOKをもらえた！
• 他レビュワーからのレビューも加えて
そのままスポンサーになってもらう

スポンサーを見つける/パッチを適用してプッシュしてもらう
• リポジトリにプッシュしてもらえた

図解
最初に作った
パッチ
パッチ1
HotSpot系
(Symbol)
パッチ2
core-libs系
レビュー1
NetworkInterface
レビュー2
k_standard

このような込み入ったことに
なるケースもありますが
多くはスムーズに進みます

大事なこと
• 自分の考えを主張すること！
» 私を含め多くの日本人にとって勇気がいることの1つ

大事なこと
» 言わなくても伝わる誰かが汲み取ってくれるは
日本における文化でありグローバルなコミュニティで
前提にすることはできない

大事なこと
» 言わなくても伝わる誰かが汲み取ってくれるは
日本における文化でありグローバルなコミュニティで
前提にすることはできない
» 根拠や筋道が大きく誤っていなければ
主張することで物事は進む
• 一度の主張で反響がなくても諦めてはいけない
• むしろ一度で進み出す方がまれです

簡単な内容のパッチ例2つ

93
例: jcmdのバグ修正

94
Java 16のjcmdにおけるULログ設定バグ

95

96
Java 17のjcmdでのULログ

97
例: clhasdbのバグ修正

98
CLHSDBでヒストグラムを取得する

99
Java 16だとここがバグ

100
バグ修正
https://github.com/openjdk/jdk/pull/3087/files
intで扱っているから
ヒープサイズが大きいとバグが現れる

コマンドツールのバグ修正
• jcmd, jhsdbなどのコマンド関連では
Java 17に対して3つほどコントリビュートできた
» コマンドは試しやすいのでバグを見つけられるかも！
» 試すうちにJVMの知識もつき労力対効果がよい！

まとめ
• パッチを出すのは怖くないよ！
» OpenJDKへのコントリビュートは難しくない
• 一緒にOpenJDKをさらによくしていきましょう！

All other company or product names mentioned here in are trademarks or registered trademarks of their respective owners.

Let's Start Contributing to OpenJDK from Today!（Oracle Groundbreakers APAC Virtual Tour 2021 発表資料）

Recomendados

Recomendados

Más contenido relacionado

La actualidad más candente

La actualidad más candente (20)

Similar a Let's Start Contributing to OpenJDK from Today!（Oracle Groundbreakers APAC Virtual Tour 2021 発表資料）

Similar a Let's Start Contributing to OpenJDK from Today!（Oracle Groundbreakers APAC Virtual Tour 2021 発表資料） (20)

Más de NTT DATA Technology & Innovation

Más de NTT DATA Technology & Innovation (20)

Último

Último (8)

Let's Start Contributing to OpenJDK from Today!（Oracle Groundbreakers APAC Virtual Tour 2021 発表資料）

Notas del editor