C言語 プログラミング

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

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

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

この記事についてなのですが、下処理の部分でlseekとwriteではなくftruncate関数を使うことはできないのでしょうか。

恥ずかしながら、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ページで見ることができます。ポイントを挙げると以下のような感じでしょうか。

  • fd で参照されるファイルを指定したバイトの長さになるように延長する、もしくは切り詰める
  • ファイルオフセットは変更されない
  • ファイルは書き込み用に開いていなければならない

たしかに、この関数なら上述した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を使う例が紹介されていたので、割とよく使われる方法なのかもしれません。

This is test file for using mmap.
mmap is useful for read/write file.

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

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

XSI 非準拠のシステムの場合、POSIX 標準は ftruncate() に対して length がファイルの長さより長かった場合、エラーを返すかファイルを伸張するかの二つの動作を許容している。

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

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

ではでは

関連記事

C言語 自作物 Linux プログラミング

wordleもどきのCUIアプリをつくってみた

最近、wordleという英単語当てゲームで遊んでいます。シンプルなゲームながら、通勤時間の暇つぶしや友人とのスコア比べなど意外と中毒性があり面白いです。 普通に英単語の勉強にもなるので、もっとたくさん ...

RaspberryPi Linux

Raspberry Pi4+Ubuntu ServerでGitLabを動かしてみる

お仕事でGitLabに触れる機会があったので、学習用に自宅にもGitLabが欲しくなりました。 手元にあるRaspberry Pi4+Dockerならお手軽に立ち上げられるはずと着手したものの、意外と ...

Flutter プログラミング

【Flutter】アプリ内の設定値を実装する方法

アプリ内で独自の設定を作る場合、そのデータを保持する方法を考える必要があります。 SQL、テキストファイルなど選択肢は多々ありますが、shared_preferencesというパッケージを使えば簡単に ...

RaspberryPi Linux

YoctoでRaspberryPi4のイメージをビルドしてみた

昨今、様々なデバイスでLinuxが動くようになっている中、組み込みLinuxのデファクトスタンダードとなりつつあるのが「Yocto」と呼ばれるビルドシステムです。 組み込みの現場ではその名前を聞くこと ...

C++ 自作物

言語処理系をつくろう(第7回):比較演算子を実装する

自作の言語処理系開発日記の第7回です。前回までで変数の実装が終わったので、ここからはいよいよ制御構文を実装…と思ったのですが、制御のためには比較演算子を実装する必要がありました。 ということで、今回は ...

Ryo Yoneyama

とある会社でソフトウェアエンジニアをしています。技術的な備忘録を中心にまとめてます。ネタがあれば日記も書きます。

    -C言語, プログラミング