draft/man2/pipe.2

   1 .\" Copyright (C) 2005, 2008, Michael Kerrisk <mtk.manpages@gmail.com>
   2 .\" (A few fragments remain from an earlier (1992) version by
   3 .\" Drew Eckhardt <drew@cs.colorado.edu>.)
   4 .\"
   5 .\" %%%LICENSE_START(VERBATIM)
   6 .\" Permission is granted to make and distribute verbatim copies of this
   7 .\" manual provided the copyright notice and this permission notice are
   8 .\" preserved on all copies.
   9 .\"
  10 .\" Permission is granted to copy and distribute modified versions of this
  11 .\" manual under the conditions for verbatim copying, provided that the
  12 .\" entire resulting derived work is distributed under the terms of a
  13 .\" permission notice identical to this one.
  14 .\"
  15 .\" Since the Linux kernel and libraries are constantly changing, this
  16 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  17 .\" responsibility for errors or omissions, or for damages resulting from
  18 .\" the use of the information contained herein.  The author(s) may not
  19 .\" have taken the same level of care in the production of this manual,
  20 .\" which is licensed free of charge, as they might when working
  21 .\" professionally.
  22 .\"
  23 .\" Formatted or processed versions of this manual, if unaccompanied by
  24 .\" the source, must acknowledge the copyright and authors of this work.
  25 .\" %%%LICENSE_END
  26 .\"
  27 .\" Modified by Michael Haardt <michael@moria.de>
  28 .\" Modified 1993-07-23 by Rik Faith <faith@cs.unc.edu>
  29 .\" Modified 1996-10-22 by Eric S. Raymond <esr@thyrsus.com>
  30 .\" Modified 2004-06-17 by Michael Kerrisk <mtk.manpages@gmail.com>
  31 .\" Modified 2005, mtk: added an example program
  32 .\" Modified 2008-01-09, mtk: rewrote DESCRIPTION; minor additions
  33 .\"     to EXAMPLE text.
  34 .\" 2008-10-10, mtk: add description of pipe2()
  35 .\"
  36 .\"*******************************************************************
  37 .\"
  38 .\" This file was generated with po4a. Translate the source file.
  39 .\"
  40 .\"*******************************************************************
  41 .\"
  42 .\" Japanese Version Copyright (c) 1997 SUTO, Mitsuaki
  43 .\"         all rights reserved.
  44 .\" Translated Thu Jun 26 21:09:51 JST 1997
  45 .\"         by SUTO, Mitsuaki <suto@av.crl.sony.co.jp>
  46 .\" Updated & Modified Thu Feb 10 00:47:11 JST 2005
  47 .\"         by Yuichi SATO <ysato444@yahoo.co.jp>
  48 .\" Updated & Modified Sat Dec 17 08:10:16 JST 2005 by Yuichi SATO
  49 .\" Updated 2008-02-10, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v2.77
  50 .\" Updated 2008-11-09, Akihiro MOTOKI, LDP v3.13
  51 .\" Updated 2012-04-30, Akihiro MOTOKI <amotoki@gmail.com>
  52 .\"
  53 .TH PIPE 2 2014\-07\-08 Linux "Linux Programmer's Manual"
  54 .SH 名前
  55 pipe, pipe2 \- パイプを生成する
  56 .SH 書式
  57 .nf
  58 \fB#include <unistd.h>\fP
  59 .sp
  60 \fBint pipe(int \fP\fIpipefd\fP\fB[2]);\fP
  61 .sp
  62 \fB#define _GNU_SOURCE\fP             /* feature_test_macros(7) 参照 */
  63 \fB#include <fcntl.h>\fP              /* O_* 定数の定義の取得 */
  64 \fB#include <unistd.h>\fP
  65 .sp
  66 \fBint pipe2(int \fP\fIpipefd\fP\fB[2], int \fP\fIflags\fP\fB);\fP
  67 .fi
  68 .SH 説明
  69 \fBpipe\fP()  はパイプを生成する。 パイプは、プロセス間通信に使用できる単方向のデータチャネルである。 配列 \fIpipefd\fP
  70 は、パイプの両端を参照する二つのファイルディスクリプタを 返すのに使用される。 \fIpipefd[0]\fP がパイプの読み出し側、
  71 \fIpipefd[1]\fP がパイプの書き込み側である。 パイプの書き込み側に書き込まれたデータは、
  72 パイプの読み出し側から読み出されるまでカーネルでバッファリングされる。 さらなる詳細は \fBpipe\fP(7)  を参照のこと。
  73
  74 \fBpipe2\fP()  は \fIflags\fP が 0 の場合には \fBpipe\fP()  と同じである。 \fIflags\fP に以下の値をビット毎の論理和
  75 (OR) で指定することで、 異なる動作をさせることができる。
  76 .TP
  77 \fBO_CLOEXEC\fP
  78 新しく生成される二つのファイルディスクリプタの close\-on\-exec (\fBFD_CLOEXEC\fP)  フラグをセットする。
  79 このフラグが役に立つ理由については、 \fBopen\fP(2)  の \fBO_CLOEXEC\fP フラグの説明を参照のこと。
  80 .TP
  81 \fBO_DIRECT\fP (Linux 3.4 以降)
  82 .\" commit 9883035ae7edef3ec62ad215611cb8e17d6a1a5d
  83 「パケット」モードで入出力を行うパイプを作成する。 このパイプへの \fBwrite\fP(2) それぞれが別のパケットとして扱われ、 このパイプからの
  84 \fBread\fP(2) では一度に一つパケットが読み出される。 以下の点に注意すること。
  85 .RS
  86 .IP * 3
  87 Writes of greater than \fBPIPE_BUF\fP bytes (see \fBpipe\fP(7))  will be split
  88 into multiple packets.  The constant \fBPIPE_BUF\fP is defined in
  89 \fI<limits.h>\fP.
  90 .IP *
  91 \fBread\fP(2)
  92 で次のパケットよりも小さなバッファサイズを指定した場合、要求されたバイト数のデータが読み出され、そのパケットの超過分のバイトは破棄される。
  93 可能性のある最大サイズのパケットを読み出すには、\fBPIPE_BUF\fP のバッファサイズを指定すれば十分である (上の項目を参照)。
  94 .IP *
  95 長さ 0 のパケットはサポートされていない。 (バッファサイズ 0 を指定した \fBread\fP(2) は何も行わず 0 を返す)。
  96 .RE
  97 .IP
  98 このフラグをサポートしていない古いカーネルでは、エラー \fBEINVAL\fP が返る。これによりカーネルがサポートしていないことが分かる。
  99 .TP
 100 \fBO_NONBLOCK\fP
 101 新しく生成される二つのオープンファイル記述 (open file description) の \fBO_NONBLOCK\fP
 102 ファイルステータスフラグをセットする。 このフラグを使うことで、 \fBO_NONBLOCK\fP をセットするために \fBfcntl\fP(2)
 103 を追加で呼び出す必要がなくなる。
 104 .SH 返り値
 105 成功した場合は 0 が返される。エラーの場合は \-1 が返され、 \fIerrno\fP が適切に設定される。
 106 .SH エラー
 107 .TP
 108 \fBEFAULT\fP
 109 \fIpipefd\fP が無効な値である。
 110 .TP
 111 \fBEINVAL\fP
 112 (\fBpipe2\fP())  \fIflags\fP に無効な値が入っている。
 113 .TP
 114 \fBEMFILE\fP
 115 このプロセスで使われているファイルディスクリプタが多すぎる。
 116 .TP
 117 \fBENFILE\fP
 118 オープンされているファイルの総数がシステムの制限に達している。
 119 .SH バージョン
 120 \fBpipe2\fP()  はバージョン 2.6.27 で Linux に追加された。 glibc によるサポートはバージョン 2.9 以降で利用できる。
 121 .SH 準拠
 122 \fBpipe\fP(): POSIX.1\-2001.
 123
 124 \fBpipe2\fP()  は Linux 固有である。
 125 .SH 例
 126 .\" fork.2 refers to this example program.
 127 以下のプログラムではパイプを生成し、その後 \fBfork\fP(2)  で子プロセスを生成する。
 128 子プロセスは同じパイプを参照するファイルディスクリプタ集合のコピーを 継承する。 \fBfork\fP(2)  の後、各プロセスはパイプ
 129 (\fBpipe\fP(7)  を参照) に必要がなくなったディスクリプタをクローズする。 親プロセスはプログラムのコマンドライン引き数に含まれる
 130 文字列をパイプへ書き込み、 子プロセスはこの文字列をパイプから 1 バイトずつ読み込んで標準出力にエコーする。
 131 .SS プログラムのソース
 132 .nf
 133 #include <sys/types.h>
 134 #include <sys/wait.h>
 135 #include <stdio.h>
 136 #include <stdlib.h>
 137 #include <unistd.h>
 138 #include <string.h>
 139
 140 int
 141 main(int argc, char *argv[])
 142 {
 143     int pipefd[2];
 144     pid_t cpid;
 145     char buf;
 146
 147     if (argc != 2) {
 148         fprintf(stderr, "Usage: %s <string>\en", argv[0]);
 149         exit(EXIT_FAILURE);
 150     }
 151
 152     if (pipe(pipefd) == \-1) {
 153         perror("pipe");
 154         exit(EXIT_FAILURE);
 155     }
 156
 157     cpid = fork();
 158     if (cpid == \-1) {
 159         perror("fork");
 160         exit(EXIT_FAILURE);
 161     }
 162
 163     if (cpid == 0) {    /* 子プロセスがパイプから読み込む */
 164         close(pipefd[1]);  /* 使用しない write 側はクローズする */
 165
 166         while (read(pipefd[0], &buf, 1) > 0)
 167             write(STDOUT_FILENO, &buf, 1);
 168
 169         write(STDOUT_FILENO, "\en", 1);
 170         close(pipefd[0]);
 171         _exit(EXIT_SUCCESS);
 172
 173     } else {            /* 親プロセスは argv[1] をパイプへ書き込む */
 174         close(pipefd[0]);          /* 使用しない read 側はクローズする */
 175         write(pipefd[1], argv[1], strlen(argv[1]));
 176         close(pipefd[1]);          /* 読み込み側が EOF に出会う */
 177         wait(NULL);                /* 子プロセスを待つ */
 178         exit(EXIT_SUCCESS);
 179     }
 180 }
 181 .fi
 182 .SH 関連項目
 183 \fBfork\fP(2), \fBread\fP(2), \fBsocketpair\fP(2), \fBwrite\fP(2), \fBpopen\fP(3),
 184 \fBpipe\fP(7)
 185 .SH この文書について
 186 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.75 の一部
 187 である。プロジェクトの説明とバグ報告に関する情報は
 188 http://www.kernel.org/doc/man\-pages/ に書かれている。