GETMNTENT(3)

名前
getmntent, setmntent, addmntent, endmntent, hasmntopt, getmntent_r - ファイルシステム記述ファイルのエントリを取得する

書式
#include <stdio.h>
#include <mntent.h>

FILE *setmntent(const char *filename, const char *type);

struct mntent *getmntent(FILE *fp);

int addmntent(FILE *fp, const struct mntent *mnt);

int endmntent(FILE *fp);

char *hasmntopt(const struct mntent *mnt, const char *opt);

/* GNU による拡張 */
#include <mntent.h>

struct mntent *getmntent_r(FILE *fp, struct mntent *mntbuf,
                           char *buf, int buflen);

glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照):

getmntent_r(): _BSD_SOURCE || _SVID_SOURCE

説明
これらのルーチンは、ファイルシステムを記述したファイル /etc/fstab と、マウントされているファイルシステムを記述したファイル /etc/mtab にアクセスするために用いられる。

setmntent() 関数は、ファイルシステムの記述ファイル filename をオープンして、 そのファイルポインタを返す。このファイルポインタは getmntent() によって用いられる。引き数 type は要求するアクセス形式で、 fopen(3) の mode 引き数と同じ値を取ることができる。

getmntent() 関数はファイルシステムの記述ファイル fp から新しい行を読 み込み、行をフィールドに分割した内容を収めた構造体へのポインタを返す。 ポインタはメモリの静的な領域を指しており、この領域は getmntent() を次に呼び出したときに上書きされてしまう。

addmntent() 関数は mntent 構造体 mnt の内容を、オープンされているファイル fp の最後に追加する。

endmntent() 関数はファイルシステムの記述ファイル fp を閉じる。

hasmntopt() 関数は mntent 構造体 mnt の mnt_opts フィールド (下記 参照) をスキャンし、 opt に一致する部分文字列があるかを調べる。 有効なマウントオプションについては <mntent.h> と mount(8) を参照のこと。

リエントラントな関数 getmntent_r() は getmntent() と同じだが、 ユーザが用意した *mntbuf に struct mount を格納し、その構造体の各エントリが指し示す文字列を ユーザが用意した大きさ buflen の配列 buf に書き込む。

mntent 構造体は <mntent.h> で以下のように定義されている。

struct mntent {
    char *mnt_fsname;   /* name of mounted file system */
    char *mnt_dir;      /* file system path prefix */
    char *mnt_type;     /* mount type (see mntent.h) */
    char *mnt_opts;     /* mount options (see mntent.h) */
    int   mnt_freq;     /* dump frequency in days */
    int   mnt_passno;   /* pass number on parallel fsck */
};
mtab や fstab ファイルでは、各フィールドは空白で区切られているので、 スペース、タブ、改行、バックスラッシュの 4文字をこれらのファイルで 使いたい場合で、かつ mntent 構造体の 4つの文字列メンバーのいずれかに対応するフィールド内で 使いたい場合には、8進のエスケープ表記を使って表現する: スペース (\040), タブ (\011), 改行 (\012), バックスラッシュ (\134)。 addmntent() と getmntent() は、文字列表現から エスケープ表現への変換、およびその逆を行う。

返り値
getmntent() と getmntent_r() は mntent 構造体へのポインタを返す。 失敗した場合は NULL を返す。

addmntent() 関数は成功したら 0 を返し、失敗したら 1 を返す。

endmntent() 関数はつねに 1 を返す。

hasmntopt() 関数は、マッチした場合は部分文字列へのアドレスを返し、 マッチしなければ NULL を返す。

ファイル
/etc/fstab          ファイルシステム記述ファイル
/etc/mtab           マウントされたファイルシステムの記述ファイル

準拠
リエントラントでない関数は SunOS 4.1.3 由来のものである。 getmntent_r() 関数は HPUX 10 で導入されたが、このバージョンでは int を返す。 上記に示したプロトタイプは glibc 独自のものである。

注意
System V にも getmntent() 関数はあるが、 呼び出し手順が異なり、返される構造体も異なる。 System V では /etc/mnttab が用いられる。 4.4BSD と Digital UNIX には getmntinfo() があるが、 システムコール getfsstat() のラッパー関数である。

関連項目
fopen(3), fstab(5), mount(8)

この文書について
この man ページは Linux man-pages プロジェクトのリリース 3.54 の一部 である。プロジェクトの説明とバグ報告に関する情報は http://www.kernel.org/doc/man-pages/ に書かれている。