draft/man7/unix.7

   1 .\" This man page is Copyright (C) 1999 Andi Kleen <ak@muc.de>.
   2 .\" Permission is granted to distribute possibly modified copies
   3 .\" of this page provided the header is included verbatim,
   4 .\" and in case of nontrivial modification author and date
   5 .\" of the modification is added to the header.
   6 .\"
   7 .\" Modified, 2003-12-02, Michael Kerrisk, <mtk.manpages@gmail.com>
   8 .\" Modified, 2003-09-23, Adam Langley
   9 .\" Modified, 2004-05-27, Michael Kerrisk, <mtk.manpages@gmail.com>
  10 .\"     Added SOCK_SEQPACKET
  11 .\" 2008-05-27, mtk, Provide a clear description of the three types of
  12 .\"     address that can appear in the sockaddr_un structure: pathname,
  13 .\"     unnamed, and abstract.
  14 .\"
  15 .\"*******************************************************************
  16 .\"
  17 .\" This file was generated with po4a. Translate the source file.
  18 .\"
  19 .\"*******************************************************************
  20 .TH UNIX 7 2102\-04\-16 Linux "Linux Programmer's Manual"
  21 .SH 名前
  22 unix, AF_UNIX, AF_LOCAL \- ローカルな プロセス間通信用のソケット
  23 .SH 書式
  24 \fB#include <sys/socket.h>\fP
  25 .br
  26 \fB#include <sys/un.h>\fP
  27
  28 \fIunix_socket\fP\fB = socket(AF_UNIX, type, 0);\fP
  29 .br
  30 \fIerror\fP\fB = socketpair(AF_UNIX, type, 0, int *\fP\fIsv\fP\fB);\fP
  31 .SH 説明
  32 \fBAF_UNIX\fP (\fBAF_LOCAL\fP とも言われる) ソケットファミリーは、同じマシン上で
  33 プロセス同士が 効率的に通信するために用いられる。伝統的に、UNIX ドメイン
  34 ソケットは、名前なしにもできるし、 (ソケット型であると印のついた) ファイル
  35 システムのパス名に 結び付けることもできる。さらに Linux では、ファイル
  36 システムに依存しない抽象名前空間 (abstract namespace) もサポートしている。
  37
  38 有効なタイプを以下に示す。 \fBSOCK_STREAM\fP はストリーム指向のソケットである。
  39 \fBSOCK_DGRAM\fP はメッセージ境界を保存するデータグラム指向のソケットである
  40 (ほとんどの UNIX の実装では、UNIX ドメイン・データグラム・ソケットは 常に
  41 信頼でき、データグラムの並び替えは行わない)。
  42 \fBSOCK_SEQPACKET\fP はメッセージ境界を保存し、送信された順序でメッセージを
  43 届ける接続指向ソケット である (Linux 2.6.4 以降で利用できる)。
  44
  45 UNIX ドメインソケットでは、補助データを使って ファイルディスクリプタや
  46 プロセスの信任状 (credential) を 送受信することもできる。
  47 .SS アドレスのフォーマット
  48 UNIX ドメインソケットのアドレスは以下の構造体で表現される。
  49 .in +4n
  50 .nf
  51
  52 #define UNIX_PATH_MAX    108
  53
  54 struct sockaddr_un {
  55     sa_family_t sun_family;               /* AF_UNIX */
  56     char        sun_path[UNIX_PATH_MAX];  /* pathname */
  57 };
  58 .fi
  59 .in
  60 .PP
  61 \fIsun_family\fP には必ず \fBAF_UNIX\fP が入っている。
  62
  63 この構造体では 3 種類のアドレスが区別される。
  64 .IP * 3
  65 \fIpathname (パス名)\fP: \fBbind\fP(2) を使って、UNIX ドメインソケットを NULL 終端
  66 されたファイルシステム上の パス名に結び付けることができる。
  67 \fBgetsockname\fP(2), \fBgetpeername\fP(2), \fBaccept\fP(2) がソケットのアドレスを
  68 返す際には、その長さは
  69 \fIoffsetof(struct sockaddr_un, sun_path) + strlen(sun_path) + 1\fP
  70 であり、 \fIsun_path\fP に NULL 終端されたパス名が格納される。
  71 .IP *
  72 .\" There is quite some variation across implementations: FreeBSD
  73 .\" says the length is 16 bytes, HP-UX 11 says it's zero bytes.
  74 \fIunnamed (名前なし)\fP: \fBbind\fP(2)  を使ってパス名に結び付けることができないストリーム型のソケットは 名前を持たない。同様に、
  75 \fBsocketpair\fP(2)  で作成される 2 つのソケットも名前を持たない。 \fBgetsockname\fP(2),
  76 \fBgetpeername\fP(2), \fBaccept\fP(2)  が名前なしのソケットのアドレスを返す際には、 その長さは
  77 \fIsizeof(sa_family_t)\fP であり、 \fIsun_path\fP は検査すべきではない。
  78 .IP *
  79 \fIabstract (抽象)\fP: 抽象ソケットアドレスは、 \fIsun_path[0]\fP が NULL バイト
  80 (\(aq\e0\(aq) であることで区別される。この名前空間におけるソケットのアドレス
  81 は、 \fIsun_path\fP の残りのバイトの、アドレス構造体の指定された長さの範囲で表さ
  82 れる (名前中の NULL バイトには特別な意味はない)。この名前はファイルシステムの
  83 パス名とは何の関係もない。 \fBgetsockname\fP(2), \fBgetpeername\fP(2),
  84 \fBaccept\fP(2) が抽象ソケットのアドレスを返す際には、返される \fIaddrlen\fP は
  85 \fIsizeof(sa_family_t)\fP より大きく (つまり 2 より大きく)、ソケットの名前は
  86 \fIsun_path\fP の最初の \fI(addrlen \- sizeof(sa_family_t))\fP バイトに格納される。
  87 ソケットの抽象名前空間は Linux による拡張であり、移植性はない。
  88 .SS ソケットオプション
  89 歴史的な理由により、これらのオプションは たとえ \fBAF_UNIX\fP 固有のオプションであっても \fBSOL_SOCKET\fP 型で指定する。
  90 ソケットファミリーとして \fBSOL_SOCKET\fP を指定すると、 \fBsetsockopt\fP(2)  でオプションが設定でき、
  91 \fBgetsockopt\fP(2)  で取得ができる。
  92 .TP
  93 \fBSO_PASSCRED\fP
  94 送信プロセスの補助メッセージで信任状を受信できるようにする。このオプションが
  95 セットされていて、まだソケットが接続されていないと、抽象名前空間に他と重なら
  96 ない名前が自動的に生成される。ブール整数値のフラグを取る。
  97 .SS "自動バインド (autobind) 機能"
  98 .\" i.e. sizeof(short)
  99 \fBbind\fP(2) 呼び出しで \fIsizeof(sa_family_t)\fP として \fIaddrlen\fP を指定するか、
 100 アドレスに明示的にバインドされていないソケットに対して
 101 \fBSO_PASSCRED\fP ソケットオプションが指定されていた場合、
 102 そのソケットは抽象アドレスに自動的にバインドされる。
 103 このアドレスは、1 個の NULL バイトの後に、文字集合 \fI[0\-9a\-f]\fP のバイトが
 104 5 個続く形式である。したがって、自動的にバインドされるアドレス数には
 105 2^20 個という上限が存在する。
 106 (Linux 2.1.15 以降で、自動バインド機能が追加されたときには、
 107 8 バイトが使われており、自動バインドアドレス数の上限は 2^32 であった。
 108 Linux 2.3.15 で 5 バイトに変更された。)
 109 .SS "ソケット API"
 110 この節では、Linux の UNIX ドメインソケットでの、ドメイン固有の詳細仕様と
 111 ソケット API でサポートされていない機能について説明する。
 112
 113 UNIX ドメインソケットでは、帯域外データ (out\-of\-band data) の 送信
 114 (\fBsend\fP(2) と \fBrecv\fP(2) の \fBMSG_OOB\fP フラグ) はサポートされていない。
 115
 116 \fBsend\fP(2) \fBMSG_MORE\fP フラグは UNIX ドメインソケットではサポートされていない。
 117
 118 \fBrecv\fP(2) の \fIflags\fP 引き数での \fBMSG_TRUNC\fP の使用は UNIX ドメイン
 119 ソケットではサポートされていない。
 120
 121 \fBSO_SNDBUF\fP ソケットオプションは UNIX ドメインソケットで効果を持つが、
 122 \fBSO_RCVBUF\fP は効果がない。 データグラム・ソケットでは、 \fBSO_SNDBUF\fP の値が
 123 出力データグラムの上限サイズとなる。 実際の上限値は、 \fBSO_SNDBUF\fP オプション
 124 として設定された値の 2倍 (\fBsocket\fP(7) 参照) からオーバヘッドとして使用される
 125 32 バイトを引いた値となる。
 126 .SS 補助メッセージ
 127 補助データを送受するには、 \fBsendmsg\fP(2)  や \fBrecvmsg\fP(2)  を使用する。
 128 歴史的な理由により、以下に示す補助メッセージの型は たとえ \fBAF_UNIX\fP 固有のものであっても \fBSOL_SOCKET\fP 型で指定する。
 129 これらを送るには、構造体 \fIcmsghdr\fP の \fIcmsg_level\fP フィールドに \fBSOL_SOCKET\fP をセットし、
 130 \fIcmsg_type\fP フィールドにタイプをセットする。 詳細は \fBcmsg\fP(3)  を見よ。
 131 .TP
 132 \fBSCM_RIGHTS\fP
 133 他のプロセスでオープンされたファイルディスクリプタのセットを送受信する。 データ部分にファイルディスクリプタの整数配列が入っている。
 134 渡されたファイルディスクリプタは、あたかも \fBdup\fP(2)  で生成されたかのように振る舞う。
 135 .TP
 136 \fBSCM_CREDENTIALS\fP
 137 UNIX 信任状を送受信する。これは認証に用いることができる。
 138 信任状は \fIstruct ucred\fP の補助メッセージとして渡される。
 139 この構造体は \fI<sys/socket.h>\fP で以下のように定義されている。
 140
 141 .in +4n
 142 .nf
 143 struct ucred {
 144     pid_t pid;    /* process ID of the sending process */
 145     uid_t uid;    /* user ID of the sending process */
 146     gid_t gid;    /* group ID of the sending process */
 147 };
 148 .fi
 149 .in
 150
 151 glibc 2.8 以降では、この構造体の定義を得るためには
 152 (\fIどの\fPヘッダファイルをインクルードするよりも前に)
 153 機能検査マクロ \fB_GNU_SOURCE\fP を定義しなければならない。
 154
 155 送信側が指定した信任状は、カーネルがチェックする。 実効ユーザー ID が 0 のプロセスには、 自分自身以外の値を指定する事が許される。
 156 送信側は以下の 3 つを指定しなければならない。 1) 自分自身のプロセス ID (\fBCAP_SYS_ADMIN\fP 権限を持っていない場合)、 2)
 157 自分自身のユーザー ID あるいは実効ユーザー ID か保存 set\-user\-ID (\fBCAP_SETUID\fP 権限を持っていない場合)、 3)
 158 自分自身のグループ ID あるいは実行グループ ID か保存 set\-group\-ID (\fBCAP_SETGID\fP を持っていない場合)。
 159 \fIstruct ucred\fP メッセージを受信するためには、ソケットに対し \fBSO_PASSCRED\fP オプションを有効にしなくてはならない。
 160 .SS ioctl
 161 以下の \fBioctl\fP(2) 呼び出しは \fIvalue\fP に情報を入れて返す。
 162 正しい書式は以下の通り。
 163 .PP
 164 .RS
 165 .nf
 166 \fBint\fP\fI value\fP\fB;\fP
 167 \fIerror\fP\fB = ioctl(\fP\fIunix_socket\fP\fB, \fP\fIioctl_type\fP\fB, &\fP\fIvalue\fP\fB);\fP
 168 .fi
 169 .RE
 170 .PP
 171 \fIioctl_type\fP には以下を指定できる:
 172 .TP
 173 \fBSIOCINQ\fP
 174 .\" FIXME http://sources.redhat.com/bugzilla/show_bug.cgi?id=12002,
 175 .\" filed 2010-09-10, may cause SIOCINQ to be defined in glibc headers
 176 .\" SIOCOUTQ also has an effect for UNIX domain sockets, but not
 177 .\" quite what userland might expect. It seems to return the number
 178 .\" of bytes allocated for buffers containing pending output.
 179 .\" That number is normally larger than the number of bytes of pending
 180 .\" output. Since this info is, from userland's point of view, imprecise,
 181 .\" and it may well change, probably best not to document this now.
 182 受信バッファのキューにある、まだ読んでいないデータの量を返す。ソケットは
 183 LISTEN 状態にあってはならず、さもないとエラー (\fBEINVAL\fP) が返る。
 184 \fBSIOCINQ\fP は \fI<linux/sockios.h>\fP で定義されている。
 185 代わりに、\fI<sys/ioctl.h>\fP で定義されている、同義語の \fBFIONREAD\fP
 186 を使うこともできる。
 187 .SH エラー
 188 .TP
 189 \fBEADDRINUSE\fP
 190 指定したローカルアドレスが既に使用されているか、ファイルシステムの
 191 ソケットオブジェクトが既に存在している。
 192 .TP
 193 \fBECONNREFUSED\fP
 194 \fBconnect\fP(2) により指定されたリモートアドレスが接続待ちソケットではなかった。
 195 ターゲットアドレスがソケットではない場合にもこのエラーが発生する。
 196 .TP
 197 \fBECONNRESET\fP
 198 リモートソケットが予期しないかたちでクローズされた。
 199 .TP
 200 \fBEFAULT\fP
 201 ユーザーメモリアドレスが不正。
 202 .TP
 203 \fBEINVAL\fP
 204 渡した引数が不正。よくある原因としては、渡したアドレスの \fIsun_type\fP フィール
 205 ドに \fBAF_UNIX\fP が指定されていなかった、行おうとした操作に対してソケットが有
 206 効な状態ではなかった、など。
 207 .TP
 208 \fBEISCONN\fP
 209 既に接続されているソケットに対して \fBconnect\fP(2)  が呼ばれた。または、指定したターゲットアドレスが 既に接続済みのソケットだった。
 210 .TP
 211 \fBENOENT\fP
 212 \fBconnect\fP(2) に指定されたリモートアドレスのパス名が存在しなかった。
 213 .TP
 214 \fBENOMEM\fP
 215 メモリが足りない。
 216 .TP
 217 \fBENOTCONN\fP
 218 ソケット操作にターゲットアドレスが必要だが、 このソケットは接続されていない。
 219 .TP
 220 \fBEOPNOTSUPP\fP
 221 ストリーム指向でないソケットに対してストリーム操作が呼び出された。 または帯域外データオプションを用いようとした。
 222 .TP
 223 \fBEPERM\fP
 224 送信者が \fIstruct ucred\fP に不正な信任状を渡した。
 225 .TP
 226 \fBEPIPE\fP
 227 リモートソケットがストリームソケット上でクローズされた。 可能な場合は \fBSIGPIPE\fP も同時に送られる。これを避けるには
 228 \fBMSG_NOSIGNAL\fP フラグを \fBsendmsg\fP(2)  や \fBrecvmsg\fP(2)  に渡す。
 229 .TP
 230 \fBEPROTONOSUPPORT\fP
 231 渡されたプロトコルが \fBAF_UNIX\fP でない。
 232 .TP
 233 \fBEPROTOTYPE\fP
 234 リモートソケットとローカルソケットのタイプが一致していなかった (\fBSOCK_DGRAM\fP と \fBSOCK_STREAM\fP)。
 235 .TP
 236 \fBESOCKTNOSUPPORT\fP
 237 未知のソケットタイプ。
 238 .PP
 239 他にも汎用のソケット層でエラーが起こったり、 ファイルシステム上にソケットオブジェクトを作ろうとした場合に ファイルシステムのエラーが起こることがある。
 240 それぞれの詳細は適切な man ページを参照すること。
 241 .SH バージョン
 242 \fBSCM_CREDENTIALS\fP と抽象名前空間は、Linux 2.2 で導入された。 移植性が必要なプログラムでは使うべきではない。 (BSD
 243 由来のシステムの中にも信任状の送受信をサポートしているものがあるが、 その実装の詳細はシステムによって異なる)
 244 .SH 注意
 245 Linux の実装では、ファイルシステム上から見えるソケットは、それらが置かれてい
 246 るディレクトリのパーミッションに従う。ソケットの所有者、グループ、パーミッショ
 247 ンは変更できる。新しいソケットを作るとき、作ろうとするディレクトリに対して プ
 248 ロセスが書き込みと検索 (実行) 権限を持っていなければ、作成に失敗する。ソケッ
 249 トオブジェクトに接続するには、 read/write 権限が必要である。この動作は、多く
 250 の BSD 由来のシステムとは異なっている (BSD では UNIX ドメインソケットに対して
 251 はパーミッションを無視する)。 移植性の必要なプログラムでは、セキュリティをこ
 252 の仕様に依存してはならない。
 253
 254 ファイル名を指定してソケットにバインドすると、ファイルシステムにソケットが
 255 生成される。これは必要なくなったときに呼びだしたユーザーが削除しなければ
 256 ならない (\fBunlink\fP(2) を用いる)。 UNIX で通常使われる「背後で閉じる方式」
 257 が適用される。ソケットはいつでも unlink することができ、最後の参照が
 258 クローズされたときにファイルシステムから削除される。
 259
 260 \fBSOCK_STREAM\fP 上でファイルディスクリプタや信任状を渡すためには、同じ \fBsendmsg\fP(2)  や \fBrecvmsg\fP(2)
 261 コールで補助データ以外のデータを少なくとも 1 バイト送信/受信する必要がある。
 262
 263 UNIX ドメインのストリーム・ソケットでは、 帯域外データの概念はサポートされない。
 264 .SH 例
 265 \fBbind\fP(2)  参照。
 266
 267 \fBSCM_RIGHTS\fP の使用例については \fBcmsg\fP(3) を参照。
 268 .SH 関連項目
 269 \fBrecvmsg\fP(2), \fBsendmsg\fP(2), \fBsocket\fP(2), \fBsocketpair\fP(2), \fBcmsg\fP(3),
 270 \fBcapabilities\fP(7), \fBcredentials\fP(7), \fBsocket\fP(7)