dupのヘルプ・マニュアル
日本語 英語
dup --help
man dup
DUP(2) Linux Programmer’s Manual DUP(2)
名前
dup, dup2, dup3 - ファイル・ディスクリプタを複製する
書式
#include
int dup(int oldfd);
int dup2(int oldfd, int newfd);
#define _GNU_SOURCE
#include
int dup3(int oldfd, int newfd, int flags);
説明
これらのシステムコールは、ファイル・ディスクリプタ oldfd の複製を作る。
dup() は最も小さい番号の未使用のディスクリプタを新しいディスクリプタ と
して使用する。
dup2() は newfd を oldfd の複製として作成する。必要であれば最初に newfd
をクローズする。以下の点に注意すること。
* oldfd が有効なファイルディスクリプタでない場合、その呼び出しは失敗し
、 newfd はクローズされる。
* oldfd が有効なファイルディスクリプタで、 newfd が oldfd と同じ値の場
合、 dup2() は何もせず、 newfd を返す。
これらのシステムコールのいずれかが成功を返した場合には、古いファイル ・
デ ィスクリプタと新しいファイル・ディスクリプタは互いに可換なものとして
使うことができる。 2つのファイル・ディスクリプタは同じフ ァ イ ル 記 述
(description) (open(2) 参照) を参照しており、したがってファイルオフセッ
トやファイル状態フラグが共有される。例えば、一方のディスクリプタに対 し
て lseek(2) を使ってファイルオフセットを変更した場合、もう一方のディス
クリプタのオフセットも変化する。
2つのディスクリプタはファイル・ディスクリプタ・フ ラ グ (close-on-exec
flag) を 共 有 し ない。複製されたディスクリプタの close-on-exec flag
(fcntl(2) 参照) は off となる。
dup3() は dup2() と同じだが、以下の点が異なる。
* 呼び出し元が、新しいファイル・ディスクリプタに対し て close-on-exec
フ ラ グ を 強 制的に設定することができる。これを行うには、 flags に
O_CLOEXEC を指定する。このフラグが役に立つ理由については 、 open(2)
の O_CLOEXEC フラグの説明を参照のこと。
* oldfd が newfd と同じ場合、 dup3() は EINVAL エラーで失敗する。
返り値
成 功すると、これらのシステムコールは新しいディスクリプタを返す。エラー
の場合、-1 を返し、 errno を適切に設定する。
エラー
EBADF oldfd がオープンされたファイル・ディスクリプタでないか 、 newfd
がファイル・ディスクリプタとして許される範囲から外れている。
EBUSY (Linux のみ) open(2) や dup() との競合状態の場合に、 dup2() や
dup3() はこのエラーを返すかもしれない。
EINTR dup2() や dup3() の呼び出しがシグナルにより割り込まれた 。 sig-
nal(7) 参照。
EINVAL (dup3()) flags に無効な値が入っている。もしくは、 oldfd が newfd
と同じであった。
EMFILE プロセスがすでにオープンできる最大数までファイル・ディスクリプタ
を開いていて、さらに新しいものを開こうとした。
バージョン
dup3() はバージョン 2.6.27 で Linux に追加された。 glibc によるサポート
はバージョン 2.9 以降で利用できる。
準拠
dup(), dup2(): SVr4, 4.3BSD, POSIX.1-2001.
dup3() は Linux 固有である。
注意
newfd が範囲を超えた時に返されるエ ラ ー は 、 dup2() と fcntl(...,
F_DUPFD, ...) では異っている。 dup2() が F_DUPFD と同じように EINVAL
を返すシステムもある。
newfd がオープンされていると、 close(2) した時に報告されるはずのエラ ー
が失われてしまう。 dup2() や dup3() を使う前に先ず newfd をクローズする
ようにした方がいいだろう。
関連項目
close(2), fcntl(2), open(2)
Linux 2008-10-09 DUP(2)
DUP(2) Linux Programmer’s Manual DUP(2)
NAME
dup, dup2, dup3 - duplicate a file descriptor
SYNOPSIS
#include
int dup(int oldfd);
int dup2(int oldfd, int newfd);
#define _GNU_SOURCE
#include
int dup3(int oldfd, int newfd, int flags);
DESCRIPTION
These system calls create a copy of the file descriptor oldfd.
dup() uses the lowest-numbered unused descriptor for the new descrip-
tor.
dup2() makes newfd be the copy of oldfd, closing newfd first if neces-
sary, but note the following:
* If oldfd is not a valid file descriptor, then the call fails, and
newfd is not closed.
* If oldfd is a valid file descriptor, and newfd has the same value as
oldfd, then dup2() does nothing, and returns newfd.
After a successful return from one of these system calls, the old and
new file descriptors may be used interchangeably. They refer to the
same open file description (see open(2)) and thus share file offset and
file status flags; for example, if the file offset is modified by using
lseek(2) on one of the descriptors, the offset is also changed for the
other.
The two descriptors do not share file descriptor flags (the close-on-
exec flag). The close-on-exec flag (FD_CLOEXEC; see fcntl(2)) for the
duplicate descriptor is off.
dup3() is the same as dup2(), except that:
* The caller can force the close-on-exec flag to be set for the new
file descriptor by specifying O_CLOEXEC in flags. See the descrip-
tion of the same flag in open(2) for reasons why this may be useful.
* If oldfd equals newfd, then dup3() fails with the error EINVAL.
RETURN VALUE
On success, these system calls return the new descriptor. On error, -1
is returned, and errno is set appropriately.
ERRORS
EBADF oldfd isn’t an open file descriptor, or newfd is out of the
allowed range for file descriptors.
EBUSY (Linux only) This may be returned by dup2() or dup3() during a
race condition with open(2) and dup().
EINTR The dup2() or dup3() call was interrupted by a signal; see sig-
nal(7).
EINVAL (dup3()) flags contain an invalid value. Or, oldfd was equal to
newfd.
EMFILE The process already has the maximum number of file descriptors
open and tried to open a new one.
VERSIONS
dup3() was added to Linux in version 2.6.27; glibc support is available
starting with version 2.9.
CONFORMING TO
dup(), dup2(): SVr4, 4.3BSD, POSIX.1-2001.
dup3() is Linux-specific.
NOTES
The error returned by dup2() is different from that returned by
fcntl(..., F_DUPFD, ...) when newfd is out of range. On some systems
dup2() also sometimes returns EINVAL like F_DUPFD.
If newfd was open, any errors that would have been reported at close(2)
time are lost. A careful programmer will not use dup2() or dup3()
without closing newfd first.
SEE ALSO
close(2), fcntl(2), open(2)
COLOPHON
This page is part of release 3.22 of the Linux man-pages project. A
description of the project, and information about reporting bugs, can
be found at http://www.kernel.org/doc/man-pages/.
Linux 2008-10-09 DUP(2)