研究進捗報告:
"データフローを用いた
プログラムの文書化"

新山祐介
2019年4月9日

https://euske.github.io/

一枚だけで概要説明

大目標: コードの理解を促進することにより大規模ソフトウェアの開発を支援する。ex. 文書自動生成
- 直接バグを発見するのが目的ではない。
RQ: プログラムの「意味」とは何か?
- この質問は広すぎるので、とりあえず「変数の意味」に絞る。 ex. この変数 cpu の意味は何か?
データの流れを詳細に検査することで意味を推測できるのでは?

変数・関数の使われ方 = データパス

ここでは、ある変数に代入される値が通る一連の処理 (または関数の引数および返り値が通る処理) を、その変数・関数の「データパス」と定義する。
「データフロー解析」というと既存の手法と誤解されそうなので、データパスという単語を用いた。

データパスの例

問. 以下の例で fp.readLine() の返り値は 2回利用される。どのように利用されているか?

private BufferedReader fp;

public String get() {
    String s = null;
    s = fp.readLine();
    int i = s.indexOf(' ');
    return s.substring(0, i);
}

グラフ化するとこうなる:

グラフ中の readLine() からたどったノードをデータパスとする:
- readLine() - #this:indexOf() - #arg1:substring() - return
- readLine() - #this:substring() - return
これは readLine() の返り値がどのように使われたかを示している。

Interprocedural 化する

private BufferedReader fp;

public String get() {
    String s = null;
    s = fp.readLine();
    int i = s.indexOf(' ');
    return s.substring(0, i);
}

void show() {
    String x = get();
    System.out.println(x+"!!");
}

グラフ化するとこうなる:

ここから得られる readLine() のデータパスは:
- readLine() - #this:indexOf() - #arg1:substring() - L:+ - #arg0:println()
- readLine() - #this:substring() - L:+ - #arg0:println()
以上2つの順列が、このプログラムにおける「readLine()の使い方」ということになる。
- 単純化のため、いまのところメソッドの返り値のみを使う。
- グラフ上の分岐は考慮せず、一本のパスのみを扱う。

データパスを収集する

フローグラフ抽出器 FGyama を利用する。
Java ソースコードから前出のようなグラフを生成する。
- 問. 上のグラフで...
  1. Flow sensitivity が必要な箇所はどこか。
  2. Context sensitivity が必要な箇所はどこか。
  3. Field sensitivity が必要な箇所はどこか。
グラフをデータパスに変換する。
この後、いろいろな分析(?)をおこなう。

ソースコード解析のいいところ

なるべくプログラマの意図を残しておける。
コンパイルの過程で消される部分も使える:
- コメント
- 最適化でなくなる変数:
```
const int a = 3;
int b = a + 1;
```
バイナリでは同一になる部分も区別できる:
- Java の type erasure による同一化:
  - List<Integer>.add()
  - List<String>.add()
- Calling context によってメソッドの区別, etc.

これまでの結果

プログラム中のコメントを分析しコード・変数の説明部分を抜き出すことに成功。 (APSEC2018論文)
関数の機能的クローンを発見するためにデータパスを利用。 (ジャーナル論文投稿済)
類似した意味のフィールド (メンバ変数) も同様の方法で発見できることが判明。

これからの計画

2変数、変数-関数間の関係を抽出する。 word2vec のコード版のようなもの。
データパスは逆方向にたどることもできる。メソッドへの入力 (引数) をたどっていくと、何がわかるのか?