名前

open, creat -ファイルやデバイスのオープン、作成を行う

書式

#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
int open(const char * pathname , int flags );
int open(const char * pathname , int flags , mode_t mode );

int creat(const char *pathname, mode_t mode);

説明

ファイルの pathname を与えると、 open() はファイルディスクリプタを返す。ファイルディスクリプタは、この後に続くシステムコール ( read(2), write(2), lseek(2), fcntl(2) など) で使用される小さな非負の整数である。このシステムコールが成功した場合に返されるファイルディスクリプタはそのプロセスがその時点でオープンしていないファイルディスクリプタのうち最小の数字のものとなる。

デフォルトでは、新しいファイルディスクリプタは execve(2) を実行した後もオープンされたままとなる (つまり、 fcntl(2) に説明がある FD_CLOEXEC ファイルディスクリプタフラグは最初は無効である;後述の O_CLOEXEC フラグを使うとこのデフォルトを変更することができる)。ファイルオフセット (file offset) はファイルの先頭に設定される ( lseek(2) 参照)。

open() を呼び出すと、「オープンファイル記述」 (open file description) が作成される。ファイル記述とは、システム全体のオープン中のファイルのテーブルのエントリである。このエントリは、ファイルオフセットとファイル状態フラグ ( fcntl(2) F_SETFL 操作により変更可能) が保持する。ファイルディスクリプタはこれらのエントリの一つへの参照である。この後で pathname が削除されたり、他のファイルを参照するように変更されたりしても、この参照は影響を受けない。新しいオープンファイル記述は最初は他のどのプロセスとも共有されていないが、 fork(2) で共有が起こる場合がある。

引き数 flags には、アクセスモード O_RDONLY, O_WRONLY, O_RDWR のどれかひとつが入っていなければならない。これらはそれぞれ読み込み専用、書き込み専用、読み書き用にファイルをオープンすることを要求するものである。

さらに、 flags には、ファイル作成フラグ (file creation flag) とファイル状態フラグ (file status flag) を 0 個以上「ビット単位の OR (bitwise-or)」で指定することができる。 ファイル作成フラグ は O_CLOEXEC, O_CREAT, O_DIRECTORY, O_EXCL, O_NOCTTY, O_NOFOLLOW, O_TRUNC, O_TTY_INIT である。 ファイル状態フラグ は以下のリストのうち上記以外の残りのものである。二種類のフラグの違いは、ファイル状態フラグの方は fcntl(2) を使ってその内容を取得したり (場合によっては) 変更したりできる点にある。ファイル作成フラグとファイル状態フラグの全リストを以下に示す:

O_APPEND

ファイルを追加 (append) モードでオープンする。毎回の write(2) の前に lseek(2) を行ったかのように、ファイルポインタをファイルの最後に移動する。 NFS ファイルシステムで、 O_APPEND を使用すると、複数のプロセスがひとつのファイルに同時にデータを追加した場合、ファイルが壊れてしまうことがある。これは NFS が追加モードをサポートしていないため、クライアントのカーネル (kernel) がそれをシミュレートしなければならないのだが、競合状態を避けることはできないからである。

O_ASYNC

シグナル駆動 I/O (signal-driven I/O) を有効にする: このファイルディスクリプタへの入力または出力が可能になった場合に、シグナルを生成する (デフォルトは SIGIO であるが、 fcntl(2) によって変更可能である)。この機能が使用可能なのは端末、疑似端末、ソケットのみであり、 (Linux 2.6 以降では) パイプと FIFO に対しても使用できる。さらに詳しい説明は fcntl(2) を参照すること。

O_CLOEXEC (Linux 2.6.23 以降)

新しいファイルディスクリプタに対して close-on-exec フラグを有効にする。このフラグを指定することで、プログラムは FD_CLOEXEC フラグをセットするための fcntl(2) F_SETFD 操作を別途呼び出す必要がなくなる。また、ある種のマルチスレッドのプログラムはこのフラグの使用は不可欠である。なぜなら、個別に FD_CLOEXEC フラグを設定する fcntl(2) F_SETFD 操作を呼び出したとしても、あるスレッドがファイルディスクリプタをオープンするのと同時に別のスレッドが fork(2) と execve(2) を実行するという競合条件を避けるのには十分ではないからである。

O_CREAT

ファイルが存在しなかった場合は作成 (create) する。ファイルの所有者 (ユーザー ID) は、プロセスの実効ユーザー ID に設定される。グループ所有権 (グループ ID) は、プロセスの実効グループ ID または親ディレクトリのグループ ID に設定される (これは、ファイルシステムタイプ、マウントオプション、親ディレクトリのモードに依存する。 mount(8) で説明されているマウントオプション bsdgroups と sysvgroups を参照)。

O_DIRECT (Linux 2.4.10 以降)

このファイルに対する I/O のキャッシュの効果を最小化しようとする。このフラグを使うと、一般的に性能が低下する。しかしアプリケーションが独自にキャッシングを行っているような特別な場合には役に立つ。ファイルの I/O はユーザー空間バッファに対して直接行われる。 O_DIRECT フラグ自身はデータを同期で転送しようとはするが、 O_SYNC フラグのようにデータと必要なメタデータの転送が保証されるわけではない。同期 I/O を保証するためには、 O_DIRECT に加えて O_SYNC を使用しなければならない。下記の「注意」の節の議論も参照。

 

ブロックデバイスに対する似通った意味のインターフェースが raw(8) で説明されている (但し、このインタフェースは非推奨である)。

O_DIRECTORY

pathname がディレクトリでなければオープンは失敗する。このフラグは Linux 特有であり、 opendir(3) が FIFO やテープデバイスに対してコールされた場合のサービス不能 (denial-of-service) 攻撃を避けるためにカーネル 2.1.126 で追加された。しかしこれは opendir(3) の実装以外では使用するべきではない。

O_EXCL

この呼び出しでファイルが作成されることを保証する。このフラグが O_CREAT と一緒に指定され、 pathname のファイルが既に存在した場合、 open() は失敗する。

 

これら二つのフラグが指定された際、シンボリックリンクは辿られない。 pathname がシンボリックリンクの場合、シンボリックリンクがどこを指しているかに関わらず open() は失敗する。

 

一般的には、 O_CREAT を指定せずに O_EXCL を使用した場合の O_EXCL の動作は規定されていない。これには一つ例外があり、Linux 2.6 以降では、 pathname がブロックデバイスを参照している場合、 O_CREAT なしで O_EXCL を使用することができる。システムがそのブロックデバイスを使用中の場合 (例えば、マウントされているなど)、 open() はエラー EBUSY で失敗する。

 

NFS では、 O_EXCL は、Linux 2.6 以降で NFSv3 以降を使っている場合でのみサポートされる。 O_EXCL サポートが提供されていない NFS 環境では、このフラグに頼ってロック処理を実行するプログラムは競合状態 (race condition) に出会う可能性がある。ロックファイルを使用して不可分 (atomic) なファイルロックを実現し、 NFS が O_EXCL をサポートしているかに依存しないようにしたい場合、移植性のある方法は、同じファイルシステム上に他と名前の重ならないファイル (例えばホスト名と PID を組み合わせた名前) を作成し、 link(2) を使用してそのロックファイルへのリンクを作成することである。 link(2) コールの返り値が 0 ならばロックに成功している。あるいは、そのファイルに stat(2) を使用してリンク数 (link count) が 2 になっているかをチェックする。そうなっていれば、同じくロックに成功しているということである。

O_LARGEFILE

(LFS) off_t ではサイズを表せない (だだし off64_t ではサイズを表せる)ファイルをオープン可能にする。この定義を有効にするためには、( どのヘッダファイルをインクルードするよりも前に) _LARGEFILE64_SOURCE マクロを定義しなければならない。 32 ビットシステムにおいて大きなファイルにアクセスしたい場合、 ( O_LARGEFILE を使うよりも) _FILE_OFFSET_BITS 機能検査マクロを 64 にセットする方が望ましい方法である ( feature_test_macros(7) を参照)。

O_NOATIME (Linux 2.6.8 以降)

ファイルに対して read(2) が実行されたときに、最終アクセス時刻 (inode の st_atime) を更新しない。このフラグはインデックス作成やバックアッププログラムで使うことを意図している。これを使うとディスクに対する操作を大幅に減らすことができる。このフラグは全てのファイルシステムに対して有効であるわけではない。その一例が NFS であり、サーバがアクセス時刻を管理している。

O_NOCTTY

pathname が端末 (terminal) デバイス— tty(4) 参照—を指している場合に、たとえそのプロセスが制御端末を持っていなくても、オープンしたファイルは制御端末にはならない。

O_NOFOLLOW

pathname がシンボリックリンクだった場合、オープンは失敗する。これは FreeBSD の拡張で、Linux には 2.1.126 より追加された。 pathname の前のコンポーネント (earlier component;訳註: 最後のディレクトリセパレータより前の部分) がシンボリックリンクである場合には、それが指す先が参照される。

O_NONBLOCK または O_NDELAY

可能ならば、ファイルは非停止 (nonblocking) モードでオープンされる。 open() も、返したファイルディスクリプタに対する以後のすべての操作も呼び出したプロセスを待たせることはない。 FIFO (名前付きパイプ) を扱う場合には fifo(7) も参照すること。強制ファイルロック (mandatory file lock) やファイルリース (file lease) と組み合わせた場合の、 O_NONBLOCK の効果についての議論は、 fcntl(2) を参照すること。

O_SYNC

ファイルは同期 (synchronous) I/O モードでオープンされる。 open() が返したファイルディスクリプタに対して write(2) を行うと、必ず呼び出したプロセスをブロックし、該当ハードウェアに物理的に書き込まれるまで返らない。 以下の「注意」の章も参照。

O_TRUNC

ファイルが既に存在し、通常ファイルであり、書き込み可モードでオープンされている (つまり、 O_RDWRまたは O_WRONLY の) 場合、長さ 0 に切り詰め (truncate) られる。ファイルが FIFO または端末デバイスファイルの場合、 O_TRUNC フラグは無視される。それ以外の場合、 O_TRUNC の効果は未定義である。

これらの選択フラグのいくつかはファイルをオープンした後でも fcntl(2) を使用して変更することができる。

creat() は flags に O_CREAT|O_WRONLY|O_TRUNC を指定して open() を行うのと等価である。

返り値

open() と creat() は新しいファイルディスクリプタを返す。エラーが発生した場合は-1 を返す (その場合は errno が適切に設定される)。

エラー

EACCES

ファイルに対する要求されたアクセスが許されていないか、 pathname のディレクトリ部分の何れかのディレクトリに検索許可がなかった。またはファイルが存在せず、親ディレクトリへの書き込み許可がなかった。 ( path_resolution(7) も参照すること。)

EDQUOT

Where O_CREAT is specified, the file does not exist, and the user's quota of disk blocks or inodes on the file system has been exhausted.

EEXIST

pathname は既に存在し、 O_CREAT と O_EXCL が使用された。

EFAULT

pathname がアクセス可能なアドレス空間の外を指している。

EFBIG

EOVERFLOW 参照。

EINTR

遅いデバイス (例えば FIFO、 fifo(7) 参照) のオープンが完了するのを待って停止している間にシステムコールがシグナルハンドラにより割り込まれた。 signal(7) 参照。

EISDIR

pathname はディレクトリを参照しており、書き込み要求が含まれていた (つまり O_WRONLY または O_RDWR が設定されている)。

ELOOP

pathname を解決する際に遭遇したシンボリックリンクが多過ぎる。または O_NOFOLLOW が指定されており、 pathname がシンボリックリンクだった。

EMFILE

プロセスがオープンしているファイル数がすでに最大数に達している。

ENAMETOOLONG

pathname が長過ぎる。

ENFILE

オープンされているファイルの総数がシステムの制限に達している。

ENODEV

pathname がデバイススペシャルファイルを参照しており、対応するデバイスが存在しない。 (これは Linux カーネルのバグであり、この場合には ENXIO が返されるべきである)

ENOENT

O_CREAT が設定されておらず、かつ指定されたファイルが存在しない。または、 pathname のディレクトリ部分が存在しないか壊れた (dangling) シンボリックリンクである。

ENOMEM

十分なカーネルメモリーがない。

ENOSPC

pathname を作成する必要があるが、 pathname を含んでいるデバイスに新しいファイルのための空き容量がない。

ENOTDIR

pathname に含まれるディレクトリ部分のどれかが実際にはディレクトリでない。または O_DIRECTORY が指定されており、 pathname がディレクトリでない。

ENXIO

O_NONBLOCK | O_WRONLY が設定されており、指定したファイルが FIFO でそのファイルを読み込みのためにオープンしているプロセスが存在しない。または、ファイルがデバイススペシャルファイルで対応するデバイスが存在しない。

EOVERFLOW

pathname が参照しているのが、大き過ぎてオープンできない通常のファイルである。通常、このエラーが発生するは、32 ビットプラットフォーム上で -D_FILE_OFFSET_BITS=64 を指定せずにコンパイルされたアプリケーションが、ファイルサイズが (2<31)-1 ビットを超えるファイルを開こうとした場合である。上記の O_LARGEFILE も参照。これは POSIX.1-2001 で規定されているエラーである。 2.6.24 より前のカーネルでは、Linux はこの場合にエラー EFBIG を返していた。

EPERM

O_NOATIME フラグが指定されたが、呼び出し元の実効ユーザー ID がファイルの所有者と一致せず、かつ呼び出し元に特権 ( CAP_FOWNER) がない。

EROFS

pathname が読み込み専用のファイルシステム上のファイルを参照しており、書き込みアクセスが要求された。

ETXTBSY

pathname が現在実行中の実行イメージを参照しており、書き込みが要求された。

EWOULDBLOCK

O_NONBLOCK フラグが指定されたが、そのファイルには矛盾するリースが設定されていた ( fcntl(2) 参照)。

準拠

SVr4, 4.3BSD, POSIX.1-2001. フラグ O_DIRECTORY, O_NOATIME, O_NOFOLLOW は Linux 特有のものであり、これらのフラグの定義を得るためには、 (「どの」ヘッダファイルをインクルードするよりも前に) _GNU_SOURCE を定義する必要があるかもしれない。 O_CLOEXEC フラグは POSIX.1-2001 では規定されていないが、 POSIX.1-2008 で規定されている。 O_DIRECT は POSIX では規定されていない。 O_DIRECT の定義を得るには (「どの」ヘッダファイルをインクルードするよりも前に) _GNU_SOURCE を定義しなければならない。

注意

Linux では、 O_NONBLOCK フラグは、 open を実行したいが read または write を実行する意図は必ずしもないことを意味する。これは ioctl(2) のためのファイルディスクリプタを取得するために、デバイスをオープンするときによく用いられる。 「アクセスモード」の値 O_RDONLY, O_WRONLY, O_RDWR は、 flags に指定できる他の値と違い、個々のビットを指定するものではなく、これらの値は flags の下位 2 ビットを定義する。 O_RDONLY, O_WRONLY, O_RDWR はそれぞれ 0, 1, 2 に定義されている。言い換えると、 O_RDONLY | O_WRONLY の組み合わせは論理的に間違いであり、確かに O_RDWR と同じ意味ではない。 Linux では、特別な、非標準なアクセスモードとして 3 (バイナリでは 11) が予約されており flags に指定できる。このアクセスモードを指定すると、ファイルの読み出し/書き込み許可をチェックし、読み出しにも書き込みにも使用できないディスクリプタを返す。この非標準のアクセスモードはいくつかの Linux ドライバで、デバイス固有の ioctl(2) 操作にのみ使用されるディスクリプタを返すために使われている。

O_RDONLY | O_TRUNC の影響は未定義であり、その動作は実装によって異なる。多くのシステムではファイルは実際に切り詰められる。

NFS を実現しているプロトコルには多くの不備があり、特に O_SYNC と O_NDELAY に影響する。

POSIX では、3 種類の同期 I/O が提供されており、 O_SYNC, O_DSYNC, O_RSYNC フラグがこれに対応するものである。今のところ (カーネル 2.6.31)、 Linux では O_SYNC だけが実装されているが、 glibc は O_DSYNC と O_RSYNC に O_SYNC と同じ数値を割り当てている。ほとんどの Linux のファイルシステムは、実際には POSIX の O_SYNC の動作ではなく O_DSYNC の動作だけを実装している。 POSIX の O_SYNC では、 open() がユーザ空間に返る際に、書き込みに関する全てのメタデータの更新がディスクに書き込まれている必要がある。一方、 O_DSYNC では、 open() が返るまでに、実際のファイルのデータとそのデータを取得するために必要なメタデータだけがディスクに書き込まれていればよい。

open() はスペシャルファイルをオープンすることができるが、 creat() でスペシャルファイルを作成できない点に注意すること。代わりに mknod(2) を使用する。

UID マッピングを使用している NFS ファイルシステムでは、 open() がファイルディスクリプタを返した場合でも read(2) が EACCES で拒否される場合がある。これはクライアントがアクセス許可のチェックを行って open() を実行するが、読み込みや書き込みの際にはサーバーで UID マッピングが行われるためである。

ファイルが新しく作成されると、ファイルの st_atime, st_ctime, st_mtime フィールド (それぞれ最終アクセス時刻、最終状態変更時刻、最終修正時刻である。 stat(2) 参照) が現在時刻に設定される。さらに親ディレクトリの st_ctime と st_mtime も現在時刻に設定される。それ以外の場合で、O_TRUNC フラグでファイルが修正されたときは、ファイルの st_ctime と st_mtime フィールドが現在時刻に設定される。

バグ

現在のところ、 open() の呼び出し時に O_ASYNC を指定してシグナル駆動 I/O を有効にすることはできない。このフラグを有効にするには fcntl(2) を使用すること。

関連項目

chmod(2), chown(2), close(2), dup(2), fcntl(2), link(2), lseek(2), mknod(2), mmap(2), mount(2), openat(2), read(2), socket(2), stat(2), umask(2), unlink(2), write(2), fopen(3), fifo(7), path_resolution(7), symlink(7)

この文書について

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