(split) DP: release pages (catch up to 3.50).

[linuxjm/LDP_man-pages.git] / release / man2 / execve.2

.\" Copyright (c) 1992 Drew Eckhardt (drew@cs.colorado.edu), March 28, 1992
.\" and Copyright (c) 2006 Michael Kerrisk <mtk.manpages@gmail.com>
.\"
.\" %%%LICENSE_START(VERBATIM)
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\" %%%LICENSE_END
.\"
.\" Modified by Michael Haardt <michael@moria.de>
.\" Modified 1993-07-21 by Rik Faith <faith@cs.unc.edu>
.\" Modified 1994-08-21 by Michael Chastain <mec@shell.portal.com>:
.\" Modified 1997-01-31 by Eric S. Raymond <esr@thyrsus.com>
.\" Modified 1999-11-12 by Urs Thuermann <urs@isnogud.escape.de>
.\" Modified 2004-06-23 by Michael Kerrisk <mtk.manpages@gmail.com>
.\" 2006-09-04 Michael Kerrisk <mtk.manpages@gmail.com>
.\"     Added list of process attributes that are not preserved on exec().
.\" 2007-09-14 Ollie Wild <aaw@google.com>, mtk
.\"     Add text describing limits on command-line arguments + environment
.\"
.\"*******************************************************************
.\"
.\" This file was generated with po4a. Translate the source file.
.\"
.\"*******************************************************************
.TH EXECVE 2 2012\-10\-27 Linux "Linux Programmer's Manual"
.SH 名前
execve \- プログラムを実行する
.SH 書式
\fB#include <unistd.h>\fP
.sp
\fBint execve(const char *\fP\fIfilename\fP\fB, char *const \fP\fIargv\fP\fB[], \fP
.br
\fB char *const \fP\fIenvp\fP\fB[]);\fP
.SH 説明
\fBexecve\fP()  は、\fIfilename\fP によって指定されたプログラムを実行する。 \fIfilename\fP は、バイナリ実行形式か、
以下の形式の行で始まるスクリプトでなければならない。

.in +4n
.nf
\fB#!\fP \fIinterpreter \fP[optional\-arg]
.fi
.in

後者の詳細は、後ろの「インタプリタ・スクリプト」の節を参照のこと。

\fIargv\fP は新しいプログラムに渡される引き数文字列の配列である。
慣例では、引き数文字列の最初の要素には実行されたファイルに関連付けられた
ファイル名を含めることになっている。
\fIenvp\fP は文字列の配列であり、伝統的に \fBkey=value\fP の形式をしており、
新しいプログラムの環境変数として渡される。
\fIargv\fP と \fIenvp\fP はいずれもの NULL ポインタで終わっている必要がある。
引き数配列と環境変数は、呼び出されたプログラムの main 関数を
以下のように定義することによってアクセス可能になる。

.in +4n
.nf
int main(int argc, char *argv[], char *envp[])
.fi
.in

成功した場合、 \fBexecve\fP()  は返らない。 そして、呼び出し元のプロセスの text, data, bss, スタックは、
読み込まれたプログラムによって上書きされる。

元のプログラムが ptrace されている場合、 \fBexecve\fP()  が成功した後に そのプログラムに \fBSIGTRAP\fP が送られる。

\fIfilename\fP で指定されたプログラムファイルに set\-user\-ID ビットが設定されており、 ファイルが存在するファイルシステムが
\fInosuid\fP (\fBmount\fP(2)  の \fBMS_NOSUID\fP フラグ) でマウントされておらず、 呼び出したプロセスが ptrace
されていない場合、 呼び出したプロセスの実効 (effective) ユーザ ID は プログラムファイルの所有者 (owner) に変更される。
同様に、プログラムファイルに set\-group\-ID ビットが設定されていた場合、 呼び出したプロセスの有効グループ ID は
プログラムファイルのグループに変更される。

プロセスの実効ユーザ ID は保存 (saved) set\-user\-ID にコピーされる。 同様に、実効グループ ID は保存
set\-group\-ID にコピーされる。 このコピーは、set\-user\-ID / set\-group\-ID 許可ビットにより発生する 実効 ID
の変更後に行われる。

実行ファイルが動的リンクされた a.out 実行形式で、共有ライブラリの スタブを含むものだった場合、実行の開始時に Linux の
ダイナミック・リンカ \fBld.so\fP(8)  が呼び出され、必要な共有ライブラリをメモリに読み込んでリンクを行う。

実行ファイルがダイナミック・リンクされた ELF 実行形式だった場合、
PT_INTERP セグメントに指定されたインタプリタが必要な 共有ライブラリ
(shared library) を読み込むのに使用される。
通常、インタプリタは glibc 2 をリンクしたバイナリでは
\fI/lib/ld\-linux.so.2\fP である (古い Linux libc5 をリンクした
バイナリでは、通常のインタプリタは \fI/lib/ld\-linux.so.1\fP であった)。

以下に示す以外のすべてのプロセス属性は \fBexecve\fP()  の前後で保持される。
.IP * 3
捕捉されたシグナルの処理方法 (disposition) は デフォルト動作にリセットされる (\fBsignal\fP(7))。
.IP *
代替シグナルスタックはどれも保持されない (\fBsigaltstack\fP(2))。
.IP *
メモリマッピングは保持されない (\fBmmap\fP(2))。
.IP *
付加された (attached) System V 共有メモリセグメントは分離される (\fBshmat\fP(2))。
.IP *
POSIX 共有メモリ領域はマッピングを解除される (\fBshm_open\fP(3))。
.IP *
オープンされた POSIX メッセージキューディスクリプタはクローズされる (\fBmq_overview\fP(7))。
.IP *
オープンされた POSIX 名前付きセマフォはいずれもクローズされる (\fBsem_overview\fP(7))。
.IP *
POSIX タイマは保持されない (\fBtimer_create\fP(2))。
.IP *
オープンされたディレクトリストリームはいずれもクローズされる (\fBopendir\fP(3))。
.IP *
メモリロックは保持されない (\fBmlock\fP(2), \fBmlockall\fP(2))。
.IP *
終了 (exit) ハンドラは保持されない (\fBatexit\fP(3), \fBon_exit\fP(3))。
.IP *
浮動小数点関連の環境はデフォルトにリセットされる (\fBfenv\fP(3)  参照)。
.PP
上記のリストのプロセス属性はいずれも POSIX.1\-2001 で規定されている。 以下に示す Linux 固有のプロセス属性も \fBexecve\fP()
の前後で保持されない。
.IP * 3
set\-user\-ID か set\-group\-ID されたプログラムが実行されている場合、 \fBprctl\fP(2)  の
\fBPR_SET_DUMPABLE\fP フラグはクリアされる。それ以外の場合、このフラグはセットされる。
.IP *
\fBprctl\fP(2)  の \fBPR_SET_KEEPCAPS\fP フラグはクリアされる。
.IP *
(Since Linux 2.4.36 / 2.6.23)  If a set\-user\-ID or set\-group\-ID program is
being executed, then the parent death signal set by \fBprctl\fP(2)
\fBPR_SET_PDEATHSIG\fP flag is cleared.
.IP *
プロセス名は新しい実行ファイルの名前にリセットされる。 プロセス名は \fBprctl\fP(2)  の \fBPR_SET_NAME\fP で設定でき、
\fIps\ \-o comm\fP で表示できる。
.IP *
The \fBSECBIT_KEEP_CAPS\fP \fIsecurebits\fP flag is cleared.  See
\fBcapabilities\fP(7).
.IP *
終了シグナル (termination signal) は \fBSIGCHLD\fP にリセットされる (\fBclone\fP(2)  参照)。
.PP
以下の点についても注意すること:
.IP * 3
呼び出し元スレッド以外の全てのスレッドは \fBexecve\fP()  中に破棄される。 mutex、条件変数、その他の pthread
オブジェクトは保持されない。
.IP *
\fIsetlocale(LC_ALL, "C")\fP 相当の処理がプログラム開始時に実行される。
.IP *
POSIX.1\-2001 は、動作が無視かデフォルトに設定されている全てのシグナル の処理方法は変更せずそのままにする、と規定している。
但し、POSIX.1\-2001 には一つ例外があり、 \fBSIGCHLD\fP が無視になっている場合、
その処理方法を変更せずにそのままにするか、デフォルト動作にリセットするかは 実装依存となっている。 Linux では前者 (変更しない) となっている。
.IP *
完了していない非同期 I/O 操作はキャンセルされる (\fBaio_read\fP(3), \fBaio_write\fP(3))。
.IP *
\fBexecve\fP(2)  時のケーパビリティの扱いについては、 \fBcapabilities\fP(7)  を参照。
.IP *
.\" On Linux it appears that these file descriptors are
.\" always open after an execve(), and it looks like
.\" Solaris 8 and FreeBSD 6.1 are the same. -- mtk, 30 Apr 2007
デフォルトでは、ファイルディスクリプタは \fBexecve\fP()  を行った後でもオープンされたままである。 close\-on\-exec
の印が付いているファイルディスクリプタはクローズされる。 \fBfcntl\fP(2)  の \fBFD_CLOEXEC\fP の説明を参照。
(ファイルディスクリプタがクローズされると、このプロセスが ファイルディスクリプタに対応するファイルに対して獲得していた
レコードのロックが全て解放されることになる。)  POSIX.1\-2001 では、 ファイルディスクリプタ 0, 1, 2 が \fBexecve\fP()
成功後にどこかでクローズされ、かつ 実行されるファイルに set\-user_ID か set\-group_ID の許可ビットが
セットされていてプロセスが特権を獲得した場合、 システムは何らかのファイルをオープンする際に これらの番号のディスクリプタのどれかを使うことがある、
とされている。 原則として、移植性が必要なプログラムでは、 特権の有無に関わらず、 \fBexecve\fP()  の前後でこれら
3つのファイルディスクリプタがクローズされたままで あることを前提にすることはできない。
.SS インタプリタ・スクリプト
インタプリタ・スクリプトとは、実行許可が有効になっていて、 最初の行が以下の形になっているテキストファイルのことである。

.in +4n
.nf
\fB#!\fP \fIinterpreter \fP[optional\-arg]
.fi
.in

\fIinterpreter\fP は有効な実行ファイルのパス名でなければならず、 それ自身がスクリプトであってはならない。 \fBexecve\fP()  の
\fIfilename\fP 引き数がインタプリタスクリプトを指定している場合、 \fIinterpreter\fP は以下の引き数で起動される。

.in +4n
.nf
\fIinterpreter\fP [optional\-arg] \fIfilename\fP arg...
.fi
.in

\fIarg...\fP は \fBexecve\fP()  の \fIargv\fP 引き数が指すワード列である。

移植性を持たすには、 \fIoptional\-arg\fP は空か 1ワードだけにすべきである (つまり、ホワイト・スペースを含めるべきではない)。
下記の「注意」の節を参照。
.SS 引き数と環境変数の合計サイズの上限
ほとんどの UNIX の実装は、新しいプログラムに渡すことができる コマンドライン引き数 (\fIargv\fP)  と環境変数 (\fIenvp\fP)
の文字列群の合計サイズに何らかの上限を設けている。 POSIX.1 は、 \fBARG_MAX\fP 定数を使ってこの上限を決める実装を認めている
(\fBARG_MAX\fP は \fI<limits.h>\fP で定義されるか、実行時に \fIsysconf(_SC_ARG_MAX)\fP
の呼び出しで入手できるかのいずれかである)。

カーネル 2.6.23 より前の Linux では、環境変数と引き数の文字列群を 格納するのに使用されるメモリは 32 ページに制限されていた (32
ページというのはカーネル定数 \fBMAX_ARG_PAGES\fP で定義される)。したがって、 ページサイズが 4 kB のアーキテクチャでは、
最大サイズは 128 kB ということになる。

.\" For some background on the changes to ARG_MAX in kernels 2.6.23 and
.\" 2.6.25, see:
.\"     http://sourceware.org/bugzilla/show_bug.cgi?id=5786
.\"     http://bugzilla.kernel.org/show_bug.cgi?id=10095
.\"     http://thread.gmane.org/gmane.linux.kernel/646709/focus=648101,
.\"     checked into 2.6.25 as commit a64e715fc74b1a7dcc5944f848acc38b2c4d4ee2.
.\" Ollie: That doesn't include the lists of pointers, though,
.\" so the actual usage is a bit higher (1 pointer per argument).
カーネル 2.6.23 以降では、ほとんどのアーキテクチャにおいて、 \fBexecve\fP()  が呼び出された時点で適用されているリソースのソフト上限
\fBRLIMIT_STACK\fP に基づいたサイズ上限が使われる (メモリ管理ユニット (MMU) を持たないアーキテクチャは上記の変更の
例外であり、これらのアーキテクチャではカーネル 2.6.23 より前と 同じ上限がそのまま使用される)。
これらのアーキテクチャでは、合計サイズは許可されたスタックサイズの 1/4 に制限されている (1/4
の上限を設けているのは、新しいプログラムが必ずある程度の スタック空間を持てることを保証するためである)。 Linux 2.6.25
以降では、カーネルはこのサイズ上限に 32 ページの下限を 設けている。これにより、 \fBRLIMIT_STACK\fP
が非常に小さく設定された場合でも、アプリケーションが少なくとも Linux 2.6.23 以前で提供されていたのと同じ大きさの引き数と環境変数の空間
と同じだけは確保できることが保証されている (この最低限の保証は Linux 2.6.23 と 2.6.24 では提供されていない)。
また、各文字列の上限は 32 ページ (カーネル定数 \fBMAX_ARG_STRLEN\fP)  で、文字列数の最大値は 0x7FFFFFFF である。
.SH 返り値
成功すると \fBexecve\fP()  は返らない。エラーの場合は \-1 を返し、 \fIerrno\fP を適切に設定する。
.SH エラー
.TP 
\fBE2BIG\fP
環境変数 (\fIenvp\fP)  と引き数リスト (\fIargv\fP)  の合計バイト数が大き過ぎる。
.TP 
\fBEACCES\fP
\fIfilename\fP やスクリプトインタプリタ名の構成要素に検索許可 (search permission)  が与えられていない
(\fBpath_resolution\fP(7)  も参照すること)。
.TP 
\fBEACCES\fP
ファイルもしくはスクリプトのインタプリタが通常ファイル (regular file)  でない。
.TP 
\fBEACCES\fP
ファイルやスクリプトや ELF インタプリタに 実行許可 (execute permission) が与えられていない。
.TP 
\fBEACCES\fP
ファイル・システムが \fInoexec\fP でマウントされている。
.TP 
\fBEFAULT\fP
\fIfilename\fP がアクセス可能なアドレス空間の外を指している。
.TP 
\fBEINVAL\fP
ELF 実行形式で複数の PT_INTERP セグメントが存在する。 (すなわち複数のインタプリタを指定した。)
.TP 
\fBEIO\fP
I/O エラーが発生した。
.TP 
\fBEISDIR\fP
ELF インタプリタがディレクトリだった。
.TP 
\fBELIBBAD\fP
ELF インタプリタが理解できるフォーマットでなかった。
.TP 
\fBELOOP\fP
\fIfilename\fP やスクリプトや ELF のインタプリタを解決する際に遭遇した シンボリック・リンクが多過ぎる。
.TP 
\fBEMFILE\fP
そのプロセスがオープンできるファイル数の上限まで既にオープンしている。
.TP 
\fBENAMETOOLONG\fP
\fIfilename\fP が長過ぎる。
.TP 
\fBENFILE\fP
オープンされたファイルの総数がシステム全体の上限に達していた。
.TP 
\fBENOENT\fP
ファイル \fIfilename\fP かスクリプトや ELF のインタプリタが存在しない。
.TP 
\fBENOEXEC\fP
実行ファイルが理解できない形式であるか、違うアーキテクチャのものか、 その他のフォーマット・エラーにより実行ができなかった。
.TP 
\fBENOMEM\fP
カーネルに十分なメモリがない。
.TP 
\fBENOTDIR\fP
\fIfilename\fP やスクリプトや ELF のインタプリタの構成要素がディレクトリでない。
.TP 
\fBEPERM\fP
ファイル・システムが \fInosuid\fP でマウントされ、ユーザがスーパーユーザでなく、 ファイルに set\-user\-ID あるいは
set\-group\-ID ビットが設定されている。
.TP 
\fBEPERM\fP
プロセスがトレースされ、ユーザがスーパーユーザでなく、 ファイルに set\-user\-ID あるいは set\-group\-ID ビットが設定されている。
.TP 
\fBETXTBSY\fP
実行ファイルを書き込み用にオープンしているプロセスがある。
.SH 準拠
.\" SVr4 documents additional error
.\" conditions EAGAIN, EINTR, ELIBACC, ENOLINK, EMULTIHOP; POSIX does not
.\" document ETXTBSY, EPERM, EFAULT, ELOOP, EIO, ENFILE, EMFILE, EINVAL,
.\" EISDIR or ELIBBAD error conditions.
SVr4, 4.3BSD, POSIX.1\-2001.  POSIX.1\-2001 には #! 動作についての記述はないが、 他は互換性がある。
.SH 注意
set\-user\-id プロセスと set\-group\-ID プロセスは \fBptrace\fP(2)  できない。

Linux はスクリプトの set\-user\-ID と set\-group\-ID ビットを無視する。

ファイルシステムを \fInosuid\fP でマウントした場合に set\-user\-ID/set\-group\-ID の実行ファイルを
どの様に扱うかは、Linux カーネルのバージョンによって異なる: あるバージョンでは、すでに必要な権限を持っている場合を除いて、 その実行を拒否する
(そして \fBEPERM\fP を返す)。別のあるバージョンでは set\-user\-ID/set\-group\-ID ビットのみを無視し \fBexec\fP()
は成功する。

#! 実行形式のシェル・スクリプトの 1行目に許されている文字数は、 最大 127 文字である。

.\" e.g., Solaris 8
.\" e.g., FreeBSD before 6.0, but not FreeBSD 6.0 onward
インタプリタ・スクリプトの \fIoptional\-arg\fP 引き数の解釈方法は実装により異なる。 Linux では、インタプリタ名
\fIinterpreter\fP に続く文字列全体がインタプリタに 1個の引き数として渡される。 しかし、動作が異なるシステムもある。 あるシステムでは、
\fIoptional\-arg\fP のうち最初のホワイト・スペースまでが 引き数として渡される。 また、別のシステムでは
インタプリタ・スクリプトは複数の引き数を持つことができ、 \fIoptional\-arg\fP 内のホワイト・スペースが引き数の区切りとなる。

.\" e.g., EFAULT on Solaris 8 and FreeBSD 6.1; but
.\" HP-UX 11 is like Linux -- mtk, Apr 2007
.\" Bug filed 30 Apr 2007: http://bugzilla.kernel.org/show_bug.cgi?id=8408
.\" Bug rejected (because fix would constitute an ABI change).
.\"
Linux では、 \fIargv\fP に NULL を指定することができる。これは、この引き数に NULL ポインタ
1個だけを含むリストへのポインタを指定したのと同じ効果を持つ。 \fB「この間違った機能を利用しないこと」\fP。 これは非標準で、移植性もない。
他のほとんどの UNIX システムでは、これを行うとエラー (\fBEFAULT\fP)  になる。

.\"
.\" .SH BUGS
.\" Some Linux versions have failed to check permissions on ELF
.\" interpreters.  This is a security hole, because it allows users to
.\" open any file, such as a rewinding tape device, for reading.  Some
.\" Linux versions have also had other security holes in
.\" .BR execve ()
.\" that could be exploited for denial of service by a suitably crafted
.\" ELF binary. There are no known problems with 2.0.34 or 2.2.15.
POSIX.1\-2001 は、 \fBsysconf\fP(3)  が返す値はプロセスの生存中は変化しないべきだとしている。 しかしながら、Linux
2.6.23 以降では、リソース上限 \fBRLIMIT_STACK\fP が変化した場合、 コマンドライン引き数と環境変数を保持するための空間に対する上限が
変化したことを反映して、 \fB_SC_ARG_MAX\fP が返す値も変化する。
.SS 歴史
UNIX V6 では \fBexec\fP()  コールの引き数リストは 0 で終端され、 \fImain\fP の引き数リストは \-1 で終端されていた。
そのため、 \fImain\fP の引き数リストは、その後の \fBexec\fP()  コールには直接使用できなかった。 UNIX V7 以降では、ともに
NULL で終端される。
.SH 例
このプログラムは、以下の二つ目のプログラムから実行するためのものである。 コマンドラインを 1行に 1個ずつ表示するだけのプログラムである。

.in +4n
.nf
/* myecho.c */

#include <stdio.h>
#include <stdlib.h>

int
main(int argc, char *argv[])
{
    int j;

    for (j = 0; j < argc; j++)
        printf("argv[%d]: %s\en", j, argv[j]);

    exit(EXIT_SUCCESS);
}
.fi
.in

以下のプログラムは、コマンドライン引き数で指定した名前のプログラムを 実行するのに使う。
.in +4n
.nf

/* execve.c */

#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>

int
main(int argc, char *argv[])
{
    char *newargv[] = { NULL, "hello", "world", NULL };
    char *newenviron[] = { NULL };

    if (argc != 2) {
        fprintf(stderr, "Usage: %s <file\-to\-exec>\en", argv[0]);
        exit(EXIT_FAILURE);
    }

    newargv[0] = argv[1];

    execve(argv[1], newargv, newenviron);
    perror("execve");   /* execve() only returns on error */
    exit(EXIT_FAILURE);
}
.fi
.in

二つ目のプログラムを使って一つ目のプログラムを実行するには 以下のようにする。

.in +4n
.nf
$\fB cc myecho.c \-o myecho\fP
$\fB cc execve.c \-o execve\fP
$\fB ./execve ./myecho\fP
argv[0]: ./myecho
argv[1]: hello
argv[2]: world
.fi
.in

さらに、これらのプログラムを使って、スクリプト・インタプリタの例を示す。 このために、「インタプリタ」として先ほど作成したプログラム \fImyecho\fP
を使うスクリプトを作成する。

.in +4n
.nf
$\fB cat > script.sh\fP
\fB#! ./myecho script\-arg\fP
\fB^D\fP
$\fB chmod +x script.sh\fP
.fi
.in

作成しておいたプログラムを使ってスクリプトを実行する。

.in +4n
.nf
$\fB ./execve ./script.sh\fP
argv[0]: ./myecho
argv[1]: script\-arg
argv[2]: ./script.sh
argv[3]: hello
argv[4]: world
.fi
.in
.SH 関連項目
\fBchmod\fP(2), \fBfork\fP(2), \fBptrace\fP(2), \fBexecl\fP(3), \fBfexecve\fP(3),
\fBgetopt\fP(3), \fBcredentials\fP(7), \fBenviron\fP(7), \fBpath_resolution\fP(7),
\fBld.so\fP(8)
.SH この文書について
この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.50 の一部
である。プロジェクトの説明とバグ報告に関する情報は
http://www.kernel.org/doc/man\-pages/ に書かれている。