mmapの下処理にftruncate関数を利用する

以前このブログで公開した記事の中に、C言語のmmap関数の使い方についてまとめた記事がありました。

Corgi Lab. ～備忘録のための技術ブログ～

 

3 Shares

3 Users

5 Pockets

ファイルの読み書きにmmapを使ってみる

プログラムのループ中でファイルに何かしらのデータを書き込むとき、そのたびにwriteをしていたのではディスクへのI/Oが頻発してしまい、パフォーマンスに影響することがあります。「C言語だとそんなときはmmapを使うと良い」という話を聞いたのですが、そのときの私は「mmap？なにそれ(´・ω・)」という状態だったので、ちょっと調べて使ってみることにしました。mmapとは？そもそもmmapって何？ということですが、私の浅い理解では「ファイルをメモリ上にマッピングして、そのメモリ上を読み書きすれば良い状態にする」という理解に落...

そして大変ありがたいことに、この記事を読んでくださった方から1つの質問をいただきました。その質問が次のとおり。

恥ずかしながら、ftruncate関数の存在を知らなかったので即答ができなかったのですが、勉強のためにもあらためて調べてみることにしました。

mmapの下処理について

質問の中にあった「下処理」ですが、これはmmapによるファイル書き込みのサンプルコード中、以下の3行のことです。

lseek(fd, map_size, SEEK_SET);
write(fd, &c, sizeof(char));
lseek(fd, 0, SEEK_SET);

これらの処理自体は何者かというと、ファイルの実体を作成する処理になります。lseekで所望のファイルサイズ（map_size）の分だけファイルポインタ（fd）を進め、そこに0を書き込みます。その後にファイルポインタを先頭に戻すことで、指定したサイズ分のファイルができあがるという仕組みです。

ftruncate関数を使ってみる

ここからが本題です。まず、ftruncate関数の説明はこのManページで見ることができます。ポイントを挙げると以下のような感じでしょうか。

たしかに、この関数なら上述した3行のコードを関数1つで置き換えできそうです。ファイルポインタを進めてデータを書き込む代わりに、ファイルそのものを伸張する形になるかと思います。ということで、さっそく試してみました。下記サンプルコードの23行目が置き換えた部分になります。

#include <stdio.h>
#include <fcntl.h>
#include <sys/mman.h>
#include <string.h>
#include <unistd.h>

#define FILE_SIZE 1024

int main(void) {
    int fd;
    char *map;
    long page_size, map_size;

    fd = open("writeFile", O_CREAT | O_RDWR, 0666);
    if(fd < 0) {
        printf("Error : can't open file\n");
        return -1;
    }

    page_size = getpagesize();
    map_size = (FILE_SIZE / page_size + 1) * page_size;

    if(ftruncate(fd, map_size) != 0){
        printf("Error : ftruncate failed\n");
        return -1;
    }

    map = (char*)mmap(NULL, map_size, PROT_WRITE, MAP_SHARED, fd, 0);

    if(map == MAP_FAILED) {
        printf("Error : mmap failed\n");
        return -1;
    }

    strcat(map, "This is test file for using mmap.\n");
    strcat(map, "mmap is useful for read/write file.\n");

    msync(map, map_size, 0);

    close(fd);
    munmap(map, map_size);

    return 0;
}

このコードを実行した結果、作成されたファイルの中身は以下のようになりました。置き換え前と同じ結果なので特に問題なさそうです。調べている途中、いくつかのサイトでもmmapの下処理にftruncateを使う例が紹介されていたので、割とよく使われる方法なのかもしれません。

処理系次第では動かない？

1点だけ注意が必要かなと感じたのは、ファイルの伸張に対する挙動が処理系によって異なるということです。Manページの記載によると、

とあります。つまり、処理系によってはファイルの伸張がエラーになる場合があるので、そのときはmmapの下処理にftruncateを使うことができません。

ということで簡単ではありましたが、ftruncate関数によるファイル実体作成の検証でした。mmapと組み合わせて使うときには1つの関数の下処理が済んでしまうので、とても楽でよいですね。大変勉強になりました。あらためて、質問いただきありがとうございました。

ではでは