libgit2の内部データ構造: strmap

libgit2の内部ではハッシュテーブルが使われていたりしますが、C言語標準ライブラリにはハッシュテーブルはありません。ここで公開されている外部のライブラリ[khash.h](http://attractivechaos.awardspace.com/)をラップして作られています。コードリーディングメモです。

# khashとは何か

MITライセンスですが、著者はプロフィールを隠しています。

https://attractivechaos.wordpress.com/about/

```
このブログはanonymousなブログだ ... 
俺は完璧主義者だ。もし、読者がこのブログを書いている私を知っているなら、
私は出来る限りすべてを完璧にし続けたいと思うだろう。
それは私を神経質にして、何を書くにしても疲れ果ててしまうだろう。
もし読者が私が誰かを知らないのであれば、自分を解放することができて、
心が赴くままに書き続けられるだろう。 (意訳)
```

こういう厨二病な感じ、嫌いじゃないです。とはいえ、ちょっと古いですが[ここのエントリー](https://attractivechaos.wordpress.com/2008/08/28/comparison-of-hash-table-libraries/)に書かれているベンチマークの結果を見ると、トップクラスに高速で、メモリ使用量もトップクラスに少ない高性能なライブラリであることが分かります。

<table border="1" cellspacing="0" cellpadding="0">
<tbody>
<tr>
<td width="90">Library</td>
<td>Mac-intCPU (sec)</td>
<td>Mac-strCPU (sec)</td>
<td>Mac PeakMem (MB)</td>
<td>Linux-intCPU (sec)</td>
<td>Linux-strCPU (sec)</td>
<td>Linux PeakMem (MB)</td>
</tr>
<tr>
<td>glib</td>
<td>1.904</td>
<td>2.436</td>
<td>11.192</td>
<td>3.490</td>
<td>4.720</td>
<td>24.968</td>
</tr>
<tr>
<td>ghthash</td>
<td>2.593</td>
<td>2.869</td>
<td>29.0/39.0</td>
<td>3.260</td>
<td>3.460</td>
<td>61.232</td>
</tr>
<tr>
<td>CC’s hashtable</td>
<td>2.740</td>
<td>3.424</td>
<td>59.756</td>
<td>3.040</td>
<td>4.050</td>
<td>129.020</td>
</tr>
<tr>
<td>TR1</td>
<td>1.371</td>
<td>2.571</td>
<td>16.140</td>
<td>1.750</td>
<td>3.300</td>
<td>28.648</td>
</tr>
<tr>
<td>STL hash_set</td>
<td>1.631</td>
<td>2.698</td>
<td>14.592</td>
<td>2.070</td>
<td>3.430</td>
<td>25.764</td>
</tr>
<tr>
<td>google-sparse</td>
<td>2.957</td>
<td>6.098</td>
<td>4.800</td>
<td>2.560</td>
<td>6.930</td>
<td>5.42/8.54</td>
</tr>
<tr>
<td>google-dense</td>
<td>0.700</td>
<td>2.833</td>
<td>24.616</td>
<td>0.550</td>
<td>2.820</td>
<td>24.7/49.3</td>
</tr>
<tr>
<td>khash (C++)</td>
<td>1.089</td>
<td>2.372</td>
<td>6.772</td>
<td>1.100</td>
<td>2.900</td>
<td>6.88/13.1</td>
</tr>
<tr>
<td>khash (C)</td>
<td>0.987</td>
<td>2.294</td>
<td>6.780</td>
<td>1.140</td>
<td>2.940</td>
<td>6.91/13.1</td>
</tr>
<tr>
<td>STL set (RB)</td>
<td>5.898</td>
<td>12.978</td>
<td>19.868</td>
<td>7.840</td>
<td>18.620</td>
<td>29.388</td>
</tr>
<tr>
<td>kbtree (C)</td>
<td>3.080</td>
<td>13.413</td>
<td>3.268</td>
<td>4.260</td>
<td>17.620</td>
<td>4.86/9.59</td>
</tr>
<tr>
<td>NP’s splaytree</td>
<td>8.455</td>
<td>23.369</td>
<td>8.936</td>
<td>11.180</td>
<td>27.610</td>
<td>19.024</td>
</tr>
</tbody>
</table>

ブログのやつは少しバージョンが古く、最新のものは[github](https://github.com/attractivechaos/klib/blob/master/khash.h)上にあります。libgit2もこちらのバージョンを使っています。

内部はC言語のマクロを駆使して書かれています。.cはなく、ヘッダファイルのみのライブラリです。マクロを使っているからといって見にくいコードというわけではなく、型の柔軟性を持たせるというC++のテンプレートっぽいことをさせたいだけに見えます。実際にC++の文字列で使えるかは試してませんが、以下の宣言がほぼ等価です。

```cpp
typedef std::map<int, std::string> > ZipTable;
```

```c
KHASH_DECLARE(ZipTable, int, std::string)
```

``KHASH_DECLARE``を呼ぶと、構造体などが作られます。最初のパラメータが名前で、この名前の数だけ型が作られます。同じ型ごとにいくつもインスタンスは作れますが、かならずすべてのマクロの引数の先頭にこれを入れます。

```c
khash_t(ZipTable) *h = kh_init(ZipTable);
```

こんな感じです。値の挿入や参照は直接ハッシュに格納するのではなく、一度イテレータを取得してから入れるスタイルです。

```
int ret;
// イテレータ型
khiter_t k;

// 値の挿入もイテレータを取ってきてから
k = kh_put(ZipTable, h, 1508510, &ret);
kh_value(h, k) = "渋谷ヒカリエ";

// 値の参照もイテレータ経由
k = kh_get(ZipTable, h, 1508510);
```

他にも、存在チェック、クリア、格納されている要素を参照する外部イテレータなど、よくある機能は網羅されているようです。また、キーの同一性比較の関数を入れ替える初期化宣言などもあり、C言語では ``==`` で比較できない文字列をキーに入れることもできるようになっています。

# libgit2での使い方

``KHASH_DECLARE`` が内部で呼んでいるマクロをばらして以下のように呼んでいます。名前は``str``、キーは``const char*``、値は ``void *`` です。

```c
__KHASH_TYPE(str, const char *, void *)
__KHASH_IMPL(str, static kh_inline, const char *, void *, 1, kh_str_hash_func, kh_str_hash_equal)
```

libgit2ではkhashのAPIはすべての内部に押し込められていて、外に露出はしていません。

```
#define git_strmap_lookup_index(h, k)  kh_get(str, h, k) 
```

とはいえ、マクロを使った薄いラッパーなので、困ったらkhash.hを読めばなんとかなりそうです。

これはlibgit2の内部APIなので、libgit2を使うユーザはこのあたりを知る必要はありません。