postgresql開発ことはじめ - 第27回しくみ＋アプリケーション勉強会

Copyright 2013 Metro Systems. 1

PostgreSQL開発ことはじめ

第２7回しくみ＋アプリケーション勉強会２０１３年10月5日

株式会社メトロシステムズ花田　茂


自己紹介

● 氏名– 花田　茂（はなだ　しげる）

● 所属– 株式会社メトロシステムズ

● メールアドレス– [email protected]

● Twitter– @s87

● ブログ– http://d.hatena.ne.jp/s87/


アジェンダ

● PostgreSQLの進化● PostgreSQL開発の流れ● パッチレビュー● 開発環境の用意● PostgreSQLのビルド● ソースを読んでみましょう● 動きを見てみましょう● 改造してみましょう● 提案してみましょう● 開発関連の情報源


PostgreSQLの進化(1)

● 9.3の主な変更点– Materialized Views(Kevin Grittner)– Auto-Updatable Views(Dean Rasheed)– Advanced JSON support(Andrew Danstan)– LATERAL support(Tom Lane)– Writable FDW(KaiGai Kohei)– Add postgres_fdw(Shigeru Hanada)– Event Triggers(Dimitri Fontaine, Robert Haas, Álvaro

Herrera)– Checksum Data Pages(Simon Riggs, Jef Davis, Greg Smith,

Ants Aasma)– Efcient Foreign Key Locks(Álvaro Herrera, Noah Misch,

Andres Freund, Alexander Shulgin, Marti Raudsepp)– Reduce System V Memory requirement(Robert Haas)



● 9.3の主な変更点– Materialized Views(Kevin Grittner)– Auto-Updatable Views(Dean Rasheed)– Advanced JSON support(Andrew Danstan)– LATERAL support(Tom Lane)– Writable FDW(KaiGai Kohei)– Add postgres_fdw(Shigeru Hanada)– Event Triggers(Dimitri Fontaine, Robert Haas, Álvaro

Herrera)– Checksum Data Pages(Simon Riggs, Jef Davis, Greg Smith,

Ants Aasma)– Efcient Foreign Key Locks(Álvaro Herrera, Noah Misch,

Andres Freund, Alexander Shulgin, Marti Raudsepp)– Reduce System V Memory requirement(Robert Haas)

CommitterMajor ContributorContributorOthers



● PostgreSQLはオープンソースソフトウェア● コミュニティが著作権を持ち、一定の条件を

満たせば開発に参加可能！



● 例：View関連のリリースノート



● 例：View関連のリリースノート

機能追加のクレジットは個人名所属企業やスポンサー企業の名前はメーリングリストでの言及のみOK


PostgreSQL開発の流れ(1)

● メジャーリリースは一年に一度● 9.3の開発スケジュール

– ２０１２年● Developer Meeting（５月）● CommitFest（６月、９月、１１月）

– ２０１３年● CommitFest（１月）● Feature Freeze・αテスト（４月）● βテスト（５月〜）● Release Candidateリリース（８月）● 正式リリース（9月）



● Developer Meeting– 主要な開発者が集まって、F２Fで議論

● 次バージョンで開発したい内容の提案● 開発の進め方の議論

– オタワで開催されるPGconと同時期に開催● Developer Meeting以外にもCluster Summit等も

– 議論の内容はwikiで公開● http://wiki.postgresql.org/wiki/PgCon_2013_

Developer_Meeting



● CommitFest（コミットフェスト）– 過去の苦い経験から生まれた、新機能取り込みの

サイクル● 以前は、パッチを投稿してもレビューしてもらえず埋も

れていった機能も● 機能開発期間とレビュー・取り込み期間を明確にし

て、開発リソースを効率よく活用するための仕組み● 詳細情報はPostgreSQL Wikiにて

– http://wiki.postgresql.org/wiki/CommitFest– 最近はCommitFest Managerという進行役がい

て、レビュー状況などを管理



● CommitFestアプリ– 投稿されたパッチは、専用Webアプリで管理

● https://commitfest.postgresql.org● 利用にはPostgreSQLコミュニティアカウントが必要

– https://www.postgresql.org/account/signup/

https://commitfest.postgresql.org/

https://www.postgresql.org/account/signup/



● CommitFestの状態– Future

● 将来開催予定– Open

● パッチ登録受付中– In Progress

● 現在進行中– Closed

● 終了



● CommitFestでのパッチ管理– パッチは、Webベースの専用アプリで管理

● https://commitfest.postgresql.org● PostgreSQLコミュニティアカウントが必要

– パッチを作成したら、pgsql-hackers MLに投稿し、そのメールのMessage-IDを「Open」状態のCommitFestに登録

– CommitFestが始まると、レビュワーがついてパッチをレビューしてくれるので、開発者はレビューコメントに対応



● CommitFestでのパッチ状態– Needs Review

● 開発者がパッチを投げてレビュー待ち– Waiting on Author

● レビューコメントが付いて開発者対応待ち– Ready for Committer

● レビューワーがOKを出してコミッタの判断待ち– Committed

● 晴れてコミット！– Returned with Feedback

● 本CFではこれ以上扱わない、次回以降に再挑戦



● CommitFestでのレビュー– レビューの仕方は日本語ドキュメントで！

● http://wiki.postgresql.org/wiki/Reviewing_a_Patch/ja

– 永安さんのブログにも整理されています！● http://pgsqldeepdive.blogspot.jp/2013/06/co

mmitfestpatchreview.html– Round Robin Reviewerという制度も！

● 比較的簡単なパッチをCF Managerが割り当ててくれます



● レビューは開発参加の第一歩！– パッチを提案する人は必ず他者のパッチをレ

ビューする決まり● つまり、レビューできないとパッチが投げられない！

– いきなり全体を把握するのは困難（というか無理）なので、簡単なパッチのレビューをとっかかりにするのは効果的！

– 正式にレビュワーとして登録しなくても、他者のレビュー結果を自分のものと比べると勉強になります！


パッチレビュー(1)

● 何をレビューすればいいの？– 提案レビュー

● パッチフォーマット● パッチ適用可否● ドキュメントやテストの充足

– 仕様レビュー● パッチの目的適合性、必要性、重複度● SQL標準への準拠● 他の箇所との整合性



● 何をレビューすればいいの？– 機能レビュー

● 公言している機能の実現度● コーナーケース（重箱の隅）の完成度● アサーション違反やクラッシュケースの確認

– 性能試験● 性能低下を招かないこと● 性能向上パッチの場合の性能改善度



● 何をレビューすればいいの？– コーティングレビュー

● コーディング規約の準拠– http://wiki.postgresql.org/wiki/Developer_FAQ#What.27s_

the_formatting_style_used_in_PostgreSQL_source_code.3F● 移植性や多環境での動作確認● コードと整合した適切なコメント● セキュリティ上の考慮

– アーキテクチャレビュー● アーキテクチャ・他の機能・モジュールとの整合性● 将来的に問題となる依存性などがないか

– レビューのレビュー● レビューが適切になされたか

http://www.postgresql.org/docs/devel/static/source.html



● レビューしたいけど環境がない！– レビューワーはVMが無料で借りられます！

As part of an ongoing effort to encourage patch review for thePostgreSQL project, we will be funding cloud servers for patch reviewersand testers who need them for CommitFests. That is, if you want to helpwith reviewing or testing a patch for a CommitFest, and don't have yourown test server to use, the PostgreSQL project (via our funds atSoftware In the Public Interest) will pay for you to use a cloud serverfor the duration of your review/testing.

So, if "I don't have anywhere to test it" was your excuse for notreviewing in the past, time to stop making excuses and start reviewing!

Since these are cloud servers, they won't work well for performancetesting. However, they will be excellent for testing replication.

If you need one of these, please contact me to allocate a VM for you.

2013-07-13 Josh Berkus氏のメールより



● レビューしたいけど環境がない！– VMでCentOS入れとけば十分です！

● Windowsでのビルドはちょっと手間がかかるので、Linux環境がお勧め

– 一応マニュアルにやり方載ってます● 逆に言うと、Windows環境でもレビューすると喜ばれ

るでしょう！– Macならいくつかツール入れれば簡単に用意でき

ます


開発環境の用意(1)

● 開発環境に必要なもの– OS

● Unix、Linux、Mac OS Xなど– ツール

● gccなどのCコンパイラ● bison/flex/perl● DocBook(ドキュメントコンパイル用)● git● お好みのエディタ(私はvim)



● ソース持ってきましょう– gitで開発リポジトリをクローン

● git://git.postgresql.org/git/postgresql.git● 全versionの変更履歴が手元に届きます● githubにもミラーがあります

[tmp]$ time git clone git://git.postgresql.org/git/postgresql.gitCloning into 'postgresql'...remote: Counting objects: 478279, done.remote: Compressing objects: 100% (81023/81023), done.remote: Total 478279 (delta 400814), reused 472740 (delta 395295)Receiving objects: 100% (478279/478279), 137.90 MiB | 1.81 MiB/s, done.Resolving deltas: 100% (400814/400814), done.

real 2m9.138suser 0m32.854ssys 0m6.458s

新宿のルノアールのau wifiで計測ここでは7:07程度＠au LTE

https://github.com/postgres/postgres



● パッチ当てる場合は、ブランチに注意– 次バージョンはmasterブランチで開発

● 過去バージョンはREL9_3_STABLEなどのブランチ[postgresql(master)]$ git branch -r origin/HEAD -> origin/master origin/REL2_0B origin/REL6_4 origin/REL6_5_PATCHES origin/REL7_0_PATCHES origin/REL7_1_STABLE... origin/REL8_3_STABLE origin/REL9_1_STABLE origin/REL9_2_STABLE origin/REL9_3_STABLE origin/Release_1_0_3 origin/WIN32_DEV origin/ecpg_big_bison origin/master[postgresql(master)]$



● ソースコードの構成[postgresql(master)]$ ls -F | catCOPYRIGHT 著作権表記GNUmakefile.in Makefile生成元Makefile MakefileREADME PostgreSQLの簡単な説明README.git INSTALL等がない説明aclocal.m4 autoconf用ファイルconfig/ autoconf用ファイル群configure* configureスクリプトconfigure.incontrib/ contribモジュールdoc/ ドキュメントのソースsrc/ プログラムソース



● ソースコードの構成（src）[postgresql(master)]$ ls -F src/* | catbackend/bin/common/include/interfaces/makefiles/pl/port/template/test/timezone/tools/tutorial/

バックエンドサーバOSコマンド（psqlやpg_dumpなど）フロントエンド/バックエンド共通ヘッダファイルフロントエンドI/F（libpqやECPG）ビルド用ファイル手続き言語（PL/pgSQLやPL/Perlなど）環境依存コード環境依存のビルド設定リグレッションテストタイムゾーンデータベース開発用ツール群SQLチュートリアル



● ソースコードの構成（src/backendの一部）[postgresql(master)]$ ls -F src/backend/* | cataccess/bootstrap/catalog/commands/executor/optimizer/parser/postmaster/replication/rewrite/storage/tcop/

アクセスメソッド（インデックス）起動・初期化システムカタログ定義SQLコマンドエグゼキュータプランナ・オプティマイザパーササーバプロセスのエントリポイントレプリケーション関連リライタバッファ・ストーレジ・ロック管理リクエストディスパッチ（Traffic COP）



● PostgreSQLの処理の流れ– クライアントがクエリ実行– tcopがメッセージを受け付ける– パーサがクエリ文字列を解析し構文木を生成

● 解析の過程でカタログを参照– リライタが構文木を書き換え（ビュー展開など）– プランナ・オプティマイザが実行計画を生成

● 生成の過程で統計情報を参照– エグゼキュータが実行計画に基づいて実行

● 共有バッファや抽象化されたストレージを利用– 結果をクライアントに返却


PostgreSQLのビルド(1)

● いつも通りの３ステップです– configure、make、make install

● ただし、レビュー・開発用には少し工夫を– --enable-cassert

● Assert()マクロを有効化して、プログラムバグの検出を容易に（これがないといきなりクラッシュしたり）

– --enable-debug● コンパイラに-gオプション渡したり

– CFLAGS=-O0● コンパイラの最適化を無効にして関数や変数を実体化


PostgreSQLのビルド(2)

● いつも通りの３ステップです– configure、make、make install

● ただし、レビュー・開発用には少し工夫を– --enable-cassert

● Assert()マクロを有効化して、プログラムバグの検出を容易に（これがないといきなりクラッシュしたり）

– --enable-debug● コンパイラに-gオプション渡したり

– --prefix=$HOME/pgsql-study● インストール先を分けたり

– CFLAGS=-O0● コンパイラの最適化を無効にして関数や変数を実体化


ソース読んでみましょう(1)

● とりあえず、もう一工夫– タグファイルを作成してタグジャンプしましょう

● src/tools/make_ctags● src/tools/make_etags

● さて、どこから読みましょう？


ソース読んでみましょう(2)

● まずはエグゼキュータやSQLコマンドあたりがお手頃– EXPLAINのJSONフォーマットってどう実現し

ているの？– SELECTの実行計画ってどう動くの？– VACUUMって結局何やってるの？

● 慣れてきたら、普段気になっている部分を見てみるのも


動きを見てみましょう(1)

● gdbを使って処理を追ってみましょう– psqlで接続– pg_backend_pid()でバックエンドプロセス特定– gdbでアタッチ– 適当なところにブレークポイント設定– psqlからクエリ実行（または適当なアクション）– gdbでブレークしたところからステップ実行


改造してみましょう(1)

● ソースコードは書き換え放題！– オープンソースですから。– gitでブランチ切っておくと幸せになれます

● いつでも戻せる、差分が分かる、Etc.– ソース書き換えたら、新しいバイナリに切り替え

● ビルド、インストール、再起動が必要！● ビルドはsrc/backendで実行すればOK



● デバッグ時のTips– elog()でのprintfデバッグ

● プロトタイプ：elog(level, fmt, ...)● 例：

intfunc(int param){

int foo;

elog(WARNING, "%s() called with %d", __FUNCTION__, param);...elog(WARNING, "foo = %d before xxx", foo);exec_xxx(...);elog(WARNING, "foo = %d after xxx", foo);...

}



● デバッグ時のTips– NodeTag

● NodeTagオブジェクト種別識別子● 構造体の先頭にNodeTagを置き、その値でオブジェク

ト種別を識別/* * The first field of a node of any type is guaranteed to be the NodeTag. * Hence the type of any node can be gotten by casting it to Node. Declaring * a variable to be of Node * (instead of void *) can also facilitate * debugging. */typedef struct Node{ NodeTag type;} Node;



– NodeTag（続き）typedef struct JoinExpr{ NodeTag type; JoinType jointype; /* type of join */ bool isNatural; /* Natural join? Will need to shape table */ Node *larg; /* left subtree */ Node *rarg; /* right subtree */ List *usingClause; /* USING clause, if any (list of String) */ Node *quals; /* qualifiers on join, if any */ Alias *alias; /* user-written alias clause, if any */ int rtindex; /* RT index assigned for join, or 0 */} JoinExpr;


提案してみましょう(1)

● どんなネタで？– バグを修正（CF外で提案可能）

● pgsql-bugsにもネタあり– 欲しい機能を実現

● pgsql-generalにもネタあり– 遅い部分を改善

● pgsql-performaneにもネタあり– TODOリストからピックアップ

● http://wiki.postgresql.org/wiki/Todo– ドキュメント間違いを修正

● pgsql-doc



● 提案のステップ– pgsql-hackersに外部仕様等を提案– 意見がまとまってきたらPoCパッチを作成したり– コンセンサスが得られたらCommitFestに登録– CommitFestが始まったら

● 他者のパッチをレビュー● レビューコメントに対応

– Committed！● or Returned with Feedback→再挑戦…



● 提案のポイント– Design First

● いきなり実装せず、設計を議論（将来性・拡張性を重視）● 最初は難しいので、否定されてもくじけずにチャレンジを！

– 意見がまとまってきたらPoCパッチ● 動きを見せると意外と意見が変わります● コーナーケースもきちんと見ましょう！

– コーディングは周辺に合わせて！● 不用意に関係ない箇所を書き換えない！● バックパッチのし易さも重要な基準です

– とにかく議論！● 「Low-context」の世界です


開発関連の情報源

● Development Information(PostgreSQL wiki)– http://wiki.postgresql.org/wiki/Development_in

formation● Developer FAQ

– http://wiki.postgresql.org/wiki/Developer_FAQ● hackers-jp

– JPUG主催の日本語ML– pgsql-jpよりもテクニカルな内容を議論する場– 最近は流量が…復活させましょう！


おわりに

● ご清聴ありがとうございました。

postgresql開発ことはじめ - 第27回しくみ＋アプリケーション勉強会

Technology