draft/man3/dlopen.3

   1 .\" Copyright 1995 Yggdrasil Computing, Incorporated.
   2 .\" written by Adam J. Richter (adam@yggdrasil.com),
   3 .\" with typesetting help from Daniel Quinlan (quinlan@yggdrasil.com).
   4 .\" and Copyright 2003 Michael Kerrisk (mtk.manpages@gmail.com).
   5 .\"
   6 .\" %%%LICENSE_START(GPLv2+_DOC_FULL)
   7 .\" This is free documentation; you can redistribute it and/or
   8 .\" modify it under the terms of the GNU General Public License as
   9 .\" published by the Free Software Foundation; either version 2 of
  10 .\" the License, or (at your option) any later version.
  11 .\"
  12 .\" The GNU General Public License's references to "object code"
  13 .\" and "executables" are to be interpreted as the output of any
  14 .\" document formatting or typesetting system, including
  15 .\" intermediate and printed output.
  16 .\"
  17 .\" This manual is distributed in the hope that it will be useful,
  18 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 .\" GNU General Public License for more details.
  21 .\"
  22 .\" You should have received a copy of the GNU General Public
  23 .\" License along with this manual; if not, see
  24 .\" <http://www.gnu.org/licenses/>.
  25 .\" %%%LICENSE_END
  26 .\"
  27 .\" Modified by David A. Wheeler <dwheeler@dwheeler.com> 2000-11-28.
  28 .\" Applied patch by Terran Melconian, aeb, 2001-12-14.
  29 .\" Modified by Hacksaw <hacksaw@hacksaw.org> 2003-03-13.
  30 .\" Modified by Matt Domsch, 2003-04-09: _init and _fini obsolete
  31 .\" Modified by Michael Kerrisk <mtk.manpages@gmail.com> 2003-05-16.
  32 .\" Modified by Walter Harms: dladdr, dlvsym
  33 .\" Modified by Petr Baudis <pasky@suse.cz>, 2008-12-04: dladdr caveat
  34 .\"
  35 .\"*******************************************************************
  36 .\"
  37 .\" This file was generated with po4a. Translate the source file.
  38 .\"
  39 .\"*******************************************************************
  40 .TH DLOPEN 3 2008\-12\-06 Linux "Linux Programmer's Manual"
  41 .SH 名前
  42 dlclose, dlerror, dlopen, dlsym \- 動的リンクを行うローダへの プログラミングインターフェース
  43 .SH 書式
  44 \fB#include <dlfcn.h>\fP
  45 .sp
  46 \fBvoid *dlopen(const char *\fP\fIfilename\fP\fB, int \fP\fIflag\fP\fB);\fP
  47 .sp
  48 \fBchar *dlerror(void);\fP
  49 .sp
  50 \fBvoid *dlsym(void *\fP\fIhandle\fP\fB, const char *\fP\fIsymbol\fP\fB);\fP
  51 .sp
  52 \fBint dlclose(void *\fP\fIhandle\fP\fB);\fP
  53 .sp
  54 \fI\-ldl\fP でリンクする。
  55 .SH 説明
  56 \fBdlopen\fP(), \fBdlsym\fP(), \fBdlclose\fP(), \fBdlerror\fP()  の 4つの関数は、動的リンク (dynamic
  57 linking) を行うローダへの インタフェースを実装したものである。
  58 .SS dlerror()
  59 関数 \fBdlerror\fP()  は、前回 \fBdlerror\fP()  が呼び出された後に、 \fBdlopen\fP(), \fBdlsym\fP(),
  60 \fBdlclose\fP()  のいずれかで最後に発生したエラーについての説明メッセージを返す。
  61 初期化後または前回呼び出された後で、エラーが発生していなければ NULL を返す。
  62 .SS dlopen()
  63 関数 \fBdlopen\fP()  は、NULL 終端された文字列 \fIfilename\fP で指定されたファイル名の動的ライブラリ (dynamic
  64 library) をロードし、 その動的ライブラリへの内部「ハンドル」を返す。 \fIfilename\fP が NULL
  65 の場合、メイン・プログラムへのハンドルが返される。 \fIfilename\fP がスラッシュ ("/")
  66 を含む場合、(相対か絶対かの)パス名として解釈される。 それ以外の場合、動的リンカは以下の手順でライブラリを検索する (詳細は \fBld.so\fP(8)
  67 を参照):
  68 .IP o 4
  69 (ELF のみ) 呼び出し元プログラムの実行ファイルに DT_RPATH タグが含まれており、 DT_RUNPATH
  70 タグが含まれていない場合、DT_RPATH タグに書かれている ディレクトリ・リストを検索する。
  71 .IP o
  72 プログラムの開始時に環境変数 \fBLD_LIBRARY_PATH\fP にコロン区切りのディレクトリのリストが定義されていれば、
  73 この環境変数に定義されたディレクトリが検索される (セキュリティ上の理由で、この変数は set\-UID や set\-GID された
  74 プログラムの場合は無視される)。
  75 .IP o
  76 (ELF のみ) 呼び出し元プログラムの実行ファイルに DT_RUNPATH タグが含まれて
  77 いる場合、そのタグに書かれているディレクトリ・リストを検索する。
  78 .IP o
  79 キャッシュファイル \fI/etc/ld.so.cache\fP の中に \fIfilename\fP のエントリが入っているかをチェックする
  80 (\fB/etc/ld.so.cache\fP は \fBldconfig\fP(8)  によって管理されている)。
  81 .IP o
  82 ディレクトリ \fI/lib\fP と \fI/usr/lib\fP をこの順番で検索する。
  83 .PP
  84 そのライブラリが他の共有ライブラリに依存している場合は、 依存しているライブラリも動的リンカが同じ検索ルールに基づいて 自動的にロードする
  85 (それらのライブラリにさらに依存関係がある場合などは この処理は再帰的に行われる)。
  86 .PP
  87 \fIflag\fP には以下の 2 つの値のいずれかを含めなければならない:
  88 .TP
  89 \fBRTLD_LAZY\fP
  90 lazy binding (手抜きなシンボルの結び付け) が行う。 シンボルの解決はそのシンボルを参照するコードが実行されるときにのみ
  91 行われる。シンボルが一度も参照されなかった場合には、そのシンボルは 解決されないままとなる。 (lazy binding
  92 は関数参照についてのみ実施される; 変数への参照は常に ライブラリがロードされた時点で直ちに解決される。)
  93 .TP
  94 \fBRTLD_NOW\fP
  95 この値が指定されるか、環境変数 \fBLD_BIND_NOW\fP に空でない文字列が設定された場合、 ライブラリ中の未定義のシンボルを全て解決してから
  96 \fBdlopen\fP()  は復帰する。解決できなかったときにはエラーが返される。
  97 .PP
  98 以下の値のうち 0 個以上を論理和 (OR) の形で \fIflag\fP に追加することもできる:
  99 .TP
 100 \fBRTLD_GLOBAL\fP
 101 このライブラリで定義されているシンボルが、これより後でロードされる ライブラリのシンボル解決で利用できるようになる。
 102 .TP
 103 \fBRTLD_LOCAL\fP
 104 このフラグは \fBRTLD_GLOBAL\fP の反対の意味であり、どちらのフラグも指定されなかった場合は こちらがデフォルトとなる。
 105 このライブラリで定義されているシンボルは、これより後でロードされる ライブラリでのシンボル参照で利用できない。
 106 .TP
 107 \fBRTLD_NODELETE\fP (glibc 2.2 以降)
 108 .\" (But it is present on Solaris.)
 109 \fBdlclose\fP()  中にそのライブラリをアンロードしない。 そのため、同じライブラリをこれ以降に \fBdlopen\fP()
 110 で再度ロードした場合に、ライブラリ内の静的変数は再初期化されない。 このフラグは POSIX.1\-2001 では規定されていない。
 111 .TP
 112 \fBRTLD_NOLOAD\fP (glibc 2.2 以降)
 113 .\" (But it is present on Solaris.)
 114 .\"
 115 そのライブラリをロードしない。 このフラグはそのライブラリがすでに組み込まれているかを検査するのに 利用できる (\fBdlopen\fP()
 116 は、ライブラリが組み込まれていなければ NULL を返し、 すでに組み込まれていればそのライブラリのハンドルを返す)。
 117 また、すでにロードされているライブラリのフラグを昇格させるのにも 利用できる。例えば、過去に \fBRTLD_LOCAL\fP でロードしたライブラリを
 118 \fBRTLD_NOLOAD\ |\ RTLD_GLOBAL\fP で再オープンすることができる。 このフラグは POSIX.1\-2001
 119 では規定されていない。
 120 .TP
 121 \fBRTLD_DEEPBIND\fP (glibc 2.3.4 以降)
 122 .\" Inimitably described by UD in
 123 .\" http://sources.redhat.com/ml/libc-hacker/2004-09/msg00083.html.
 124 このライブラリ内のシンボルの参照領域をグローバル領域よりも前に配置する。 つまり、内蔵型のライブラリでは、すでにロードされたライブラリに含まれる
 125 同じ名前のグローバルなシンボルよりも自ライブラリ内のシンボルが優先して 使われる。 このフラグは POSIX.1\-2001 では規定されていない。
 126 .PP
 127 \fIfilename\fP が NULL ポインタである場合は、 返されるハンドルはメイン・プログラムのものになる。 このハンドルが \fBdlsym\fP()
 128 に渡されると、シンボルの検索は、メイン・プログラム内、 プログラムの起動時にロードされる全ての共有ライブラリ、 \fBdlopen\fP()  によって
 129 \fBRTLD_GLOBAL\fP フラグ付きでロードされた全ての共有ライブラリ、の順序で行われる。
 130 .PP
 131 オープンされたライブラリ中での外部参照は、 そのライブラリの依存リストにあるライブラリか、 \fBRTLD_GLOBAL\fP
 132 フラグ付きで既にオープンされているライブラリを使って解決される。 実行ファイルが "\-rdynamic" フラグ ("\-\-export\-dynamic"
 133 も同義)  付きでリンクされている場合は、実行ファイル中のグローバルシンボルも、 動的にロードされるライブラリ内の参照解決に用いられる。
 134 .PP
 135 同じライブラリが \fBdlopen\fP()  によって再度ロードされた場合には、同じファイルハンドルが返される。 dl
 136 ライブラリはライブラリハンドルのリンク数を管理している。 したがって動的ライブラリは \fBdlclose\fP()  が \fBdlopen\fP()
 137 と同じ回数だけ呼び出されない限りアンロードされない。 \fB_init\fP()  ルーチンは一度だけ呼び出される (\fB_init\fP()
 138 が存在する場合のみ)。 \fBRTLD_NOW\fP が指定されて \fBdlopen\fP()  が呼び出された場合、 \fBRTLD_LAZY\fP
 139 で以前にロードされたライブラリのシンボル解決が実行されることがある。
 140 .PP
 141 \fBdlopen\fP()  は、何らかの理由で失敗すると NULL を返す。
 142 .SS dlsym()
 143 関数 \fBdlsym\fP()  は、 \fBdlopen\fP()  が返した動的ライブラリの「ハンドル」と、 NULL
 144 終端されたシンボル名の文字列を引き数に取り、 そのシンボルがロードされたメモリのアドレスを返す。
 145 シンボルが、指定されたライブラリと、指定されたライブラリがロードされる際に \fBdlopen\fP()
 146 が自動的にロードしてライブラリのいずれにも見つからない場合には、 \fBdlsym\fP()  は NULL を返す (\fBdlsym\fP()
 147 による検索は、これらのライブラリの依存関係のツリーを先頭から 辿って行われる)。 実際にはシンボルの値自体が NULL になることもある (そのため、
 148 \fBdlsym\fP()  の返り値が NULL であったとしても必ずしもエラーという訳ではない)。 エラーかどうかを確認する正しい方法は以下の通りである:
 149 \fBdlerror\fP()  を呼び出して以前のエラー状態をクリアしてから、 \fBdlsym\fP()  を呼び出す。その後でもう一度
 150 \fBdlerror\fP()  を呼び出して、 \fBdlerror\fP()  の返り値を変数に保存し、保存した値が NULL であるか判定する。
 151 .PP
 152 \fBRTLD_DEFAULT\fP と \fBRTLD_NEXT\fP という二つの特別な擬似ハンドルがある。 \fBRTLD_DEFAULT\fP
 153 は、デフォルトのライブラリ検索順序にしたがって、 検索対象のシンボルが最初に現れるところを探す。 \fBRTLD_NEXT\fP
 154 は、ライブラリ検索順序の中で現在のライブラリ以降で最初に 関数が現れるところを探す。この機能を使うことで、別の共有ライブラリの
 155 関数へのラッパーを提供することができる。
 156 .SS dlclose()
 157 関数 \fBdlclose\fP()  は動的ライブラリのハンドル \fIhandle\fP の参照カウントを 1 減らす。参照カウントが 0
 158 になり、ロードされている 他のライブラリからそのライブラリ内のシンボルが使われていなければ、 その動的ライブラリをアンロードする。
 159 .LP
 160 関数 \fBdlclose\fP()  は、成功した場合は 0 を返し、エラーの場合 0 以外を返す。
 161 .SS "廃止されたシンボル _init() と _fini()"
 162 リンカは \fB_init\fP と \fB_fini\fP を特別なシンボルと解釈する。 ある動的ライブラリで \fB_init\fP()
 163 という名前のルーチンがエクスポートされていれば、 そのコードは、ライブラリのロード後、かつ \fBdlopen\fP()  が復帰する前に実行される。
 164 その動的ライブラリで \fB_fini\fP()  という名前のルーチンがエクスポートされていれば、
 165 ライブラリがアンロードされる直前にそのルーチンが呼び出される。 システムの起動ファイルに対するリンクを避ける必要がある場合、 \fBgcc\fP(1)
 166 のコマンドラインに \fI\-nostartfiles\fP オプションを指定すればよい。
 167 .LP
 168 .\" void _init(void) __attribute__((constructor));
 169 .\" void _fini(void) __attribute__((destructor));
 170 このルーチンや、gcc のオプション \fB\-nostartfiles\fP や \fB\-nostdlib\fP は使用しないことを推奨する。
 171 これらを使うと、望ましくない動作をすることがある。 なぜなら、(特別な措置が行われない限り) これらの constructor/destructor
 172 ルーチンは実行されないからである。
 173 .LP
 174 代わりに、ライブラリは \fB__attribute__((constructor))\fP や \fB__attribute__((destructor))\fP
 175 の関数属性を使って必要なルーチンをエクスポートするのがよい。 これらについては gcc の info ページを参照のこと。 constructor
 176 ルーチンは \fBdlopen\fP()  が復帰する前に実行され、 destructor ルーチンは \fBdlclose\fP()  が復帰する前に実行される。
 177 .SS "GNU での拡張: dladdr() と dlvsym()"
 178 glibc では POSIX には記載されていない関数が 2つ追加されている。 プロトタイプは以下の通りである。
 179 .sp
 180 .nf
 181 \fB#define _GNU_SOURCE\fP         /* feature_test_macros(7) 参照 */
 182 \fB#include <dlfcn.h>\fP
 183 .sp
 184 \fBint dladdr(void *\fP\fIaddr\fP\fB, Dl_info *\fP\fIinfo\fP\fB);\fP
 185 .sp
 186 \fBvoid *dlvsym(void *\fP\fIhandle\fP\fB, char *\fP\fIsymbol\fP\fB, char *\fP\fIversion\fP\fB);\fP
 187 .fi
 188 .PP
 189 関数 \fBdladdr\fP()  は、関数のポインタを引き数にとり、関数の名前と関数が定義されている ファイルの解決を試みる。情報は \fIDl_info\fP
 190 構造体に格納される。
 191 .sp
 192 .in +4n
 193 .nf
 194 typedef struct {
 195     const char *dli_fname;  /* Pathname of shared object that
 196                                contains address */
 197     void       *dli_fbase;  /* Address at which shared object
 198                                is loaded */
 199     const char *dli_sname;  /* Name of nearest symbol with address
 200                                lower than \fIaddr\fP */
 201     void       *dli_saddr;  /* Exact address of symbol named
 202                                in \fIdli_sname\fP */
 203 } Dl_info;
 204 .fi
 205 .in
 206 .PP
 207 \fIaddr\fP にマッチするシンボルが見つからなかった場合、 \fIdli_sname\fP と \fIdli_saddr\fP は NULL にセットされる。
 208 .PP
 209 \fBdladdr\fP()  は、エラー時には 0 を返し、成功した場合は 0 以外を返す。
 210 .PP
 211 関数 \fBdlvsym\fP()  は \fBdlsym\fP()  と同じ動作をするが、バージョンの文字列を渡す引き数が 追加されている点が異なる
 212 (\fBdlvsym\fP()  はバージョン 2.1 以降の glibc で提供されている)。
 213 .SH 準拠
 214 POSIX.1\-2003 には \fBdlclose\fP(), \fBdlerror\fP(), \fBdlopen\fP(), \fBdlsym\fP().
 215 の記載がある。
 216 .SH 注意
 217 .\" .LP
 218 .\" The string returned by
 219 .\" .BR dlerror ()
 220 .\" should not be modified.
 221 .\" Some systems give the prototype as
 222 .\" .sp
 223 .\" .in +5
 224 .\" .B "const char *dlerror(void);"
 225 .\" .in
 226 シンボル \fBRTLD_DEFAULT\fP と \fBRTLD_NEXT\fP は \fI<dlfcn.h>\fP で定義されており、
 227 \fI<dlfcn.h>\fP のインクルード前に \fB_GNU_SOURCE\fP が定義されている場合のみ有効となる。
 228
 229 glibc 2.2.3 以降では、 \fBatexit\fP(3)  を使って、ライブラリがアンロードされる際に自動的に呼び出される 終了ハンドラ (exit
 230 handler) を登録することができる。
 231 .SS 歴史
 232 dlopen インターフェースの標準は SunOS をもとにしている。 SunOS には \fBdladdr\fP()  もあったが、 \fBdlvsym\fP()
 233 はなかった。
 234 .SH バグ
 235 時として、 \fBdladdr\fP()  に渡した関数ポインタは驚くような値になることがある。 いくつかのアーキテクチャ (特に i386 と
 236 x86_64) では、 引き数として使用した関数が動的リンクライブラリで定義されるもので あったとしても、 \fIdli_fname\fP と
 237 \fIdli_fbase\fP が \fBdladdr\fP()  を呼び出したオブジェクトを参照した状態で終わっていることがある。
 238 .PP
 239 問題は、関数ポインタの解決は今なおコンパイル時に行われるが、 そのポインタは元のオブジェクトの \fIplt\fP (Procedure Linkage
 240 Table) セクションを指しているだけだという点にある (オブジェクト自体は、ダイナミックリンカによってシンボルの解決が行われた後に、
 241 関数の呼び出しを行う)。 これに対処する方法としては、 コードを position\-independent でコンパイルするという方法がある。
 242 そうすると、コンパイラはコンパイル時にポインタを用意することができず、 今日の \fBgcc\fP(1)  では、実行時に \fBdladdr\fP()
 243 に関数ポインタを渡す前に、 \fIgot\fP (Global Offset Table) から最終的なシンボルのアドレスをロードするだけの
 244 コードが生成される。
 245 .SH 例
 246 math ライブラリをロードし、2.0 の余弦を表示する
 247 .nf
 248
 249 #include <stdio.h>
 250 #include <stdlib.h>
 251 #include <dlfcn.h>
 252
 253 int
 254 main(int argc, char **argv)
 255 {
 256     void *handle;
 257     double (*cosine)(double);
 258     char *error;
 259
 260     handle = dlopen("libm.so", RTLD_LAZY);
 261     if (!handle) {
 262         fprintf(stderr, "%s\en", dlerror());
 263         exit(EXIT_FAILURE);
 264     }
 265
 266     dlerror();    /* Clear any existing error */
 267
 268     /* Writing: cosine = (double (*)(double)) dlsym(handle, "cos");
 269        would seem more natural, but the C99 standard leaves
 270        casting from "void *" to a function pointer undefined.
 271        The assignment used below is the POSIX.1\-2003 (Technical
 272        Corrigendum 1) workaround; see the Rationale for the
 273        POSIX specification of dlsym(). */
 274
 275 .\" But in fact "gcc -O2 -Wall" will complain about the preceding cast.
 276     *(void **) (&cosine) = dlsym(handle, "cos");
 277
 278     if ((error = dlerror()) != NULL)  {
 279         fprintf(stderr, "%s\en", error);
 280         exit(EXIT_FAILURE);
 281     }
 282
 283     printf("%f\en", (*cosine)(2.0));
 284     dlclose(handle);
 285     exit(EXIT_SUCCESS);
 286 }
 287 .fi
 288 .PP
 289 このプログラムを "foo.c" に書いたとすると、以下のコマンドでプログラムを ビルドできる。
 290 .in +4n
 291 .LP
 292     gcc \-rdynamic \-o foo foo.c \-ldl
 293 .in
 294 .PP
 295 \fB_init\fP()  と \fB_fini\fP()  をエクスポートするライブラリの場合は 以下のようにしてコンパイルする必要がある。 例として
 296 \fIbar.c\fP をコンパイルする場合:
 297 .in +4n
 298 .LP
 299     gcc \-shared \-nostartfiles \-o bar bar.c
 300 .in
 301 .SH 関連項目
 302 \fBld\fP(1), \fBldd\fP(1), \fBdl_iterate_phdr\fP(3), \fBrtld\-audit\fP(7), \fBld.so\fP(8),
 303 \fBldconfig\fP(8)
 304
 305 ld.so info pages, gcc info pages, ld info pages
 306 .SH この文書について
 307 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
 308 である。プロジェクトの説明とバグ報告に関する情報は
 309 http://www.kernel.org/doc/man\-pages/ に書かれている。