lari - 実行時インタフェースのリンク分析
lari [-bCDsvV] [-a | -i | -o] file | directory...
lari [-CDosv] [-m [-d mapdir]] file
lari ユーティリティーは、動的 ELF オブジェクトのインタフェース要件を分析します。2 つの基本操作モードを利用できます。最初のモードでは、実行時インタフェース情報を表示します。2 番目のモードでは、インタフェース定義を生成します。
動的オブジェクトは、外部コンシューマに提供するインタフェースを表すシンボル定義を提供します。実行時に、あるオブジェクトのシンボル参照から、別のオブジェクトのシンボル定義への結合が確立されます。lari は、指定されたオブジェクトのインタフェース定義と実行時結合の両方を分析します。
実行時インタフェース情報を表示するときに、lari は、ファイルまたはディレクトリの数を分析できます。lari は、コマンド行で指定したそれぞれの file を分析します。lari は、コマンド行で指定したそれぞれの directory の下位に再帰的に移動して、見つかったそれぞれのファイルを処理します。
インタフェース定義を生成するときに、lari は、コマンド行で指定した単一の file だけを処理できます。
The lari utility can analyze userland and kernel objects:
Dynamic executable and shared objects are used by user processes, and are managed at runtime by the runtime linker, ld.so.1(1).The lari utility processes files as dynamic ELF objects by using ldd(1).
The ldd utility provides information on all bindings that are established as part of loading the object.Due to the use of the ldd, the specified object is not executed, and no user controlled loading of objects by dlopen(3C) occurs.The –D option can be employed to analyze such cases.See Analysis of User Controlled Object Loading under EXTENDED DESCRIPTION.
Kernel modules are used by the unix kernel, and are managed at runtime by the Kernel Runtime Linker (krtld).The lari utility processes kernel modules by using kldd(1).This processing uses the –r and –b kldd options to obtain information on all bindings that are established as part of loading the object.Due to the use of kldd, the specified kernel module is not loaded or executed.
lari は、インタフェース情報を表示するときに、処理された動的オブジェクトのインタフェースを分析し、デフォルトで、関心を引く情報を表示します。「拡張機能説明」の「関心を引く情報」を参照してください。表示される情報は、ほかのツールへのパイピングにも適しています。この機能は、開発者がプロセス結合を分析したり、複雑な結合シナリオをデバッグしたりするときに役立ちます。
lari を使ってインタフェース定義を生成すると、処理対象の動的オブジェクトのインタフェース要件をより正確に定義できるようになります。動的オブジェクトを作成するときに、明示的にバージョン定義されたインタフェースを定義するようにしてください。この定義は、外部ユーザーが利用できるシンボル定義を制御します。また、この定義によって、実行時のオブジェクトの実行コスト全体を削減できることがよくあります。インタフェース定義は、リンカーで –M オプションおよび関連付けられた mapfile ディレクティブを使用することによって、作成時にオブジェクトに割り当てることができます。mapfile を使用してオブジェクトのバージョンを定義する方法の詳細は、Oracle Solaris 11.4 Linkers and Libraries Guideを参照してください。これらの mapfile の初期バージョンは、lari で作成できます。
以下のオプションがサポートされています。
分析対象のオブジェクトに関するすべてのインタフェース情報を表示します。ノート: このオプションからの出力は大量になることがありますが、多くの場合、ほかの分析ツールへのパイピングに役立ちます。
インタフェース情報を、明示的に結合されているシンボルに制限します。ノート: protected と定義したシンボルは、定義用オブジェクト内から結合されている可能性があります。この結合はリンク編集時に満たされるので、実行時環境では表示されません。protected シンボルは、このオプションで表示されます。
DemanglesC++ シンボル名を復号化します。このオプションは、実行時インタフェース情報を拡張するときに役立ちます。インタフェース定義の生成時に、demangled 名がコメントとして mapfile に追加されます。
mapfile が作成されるディレクトリ (mapdir) を定義します。デフォルトでは、現在の作業ディレクトリが使用されます。
動的オブジェクトではなくデバッグ情報として入力ファイルを解釈します。See Analysis of User Controlled Object Loading under EXTENDED DESCRIPTION.
関心を引くインタフェース結合情報を表示します。ほかの出力制御オプションが指定されていない場合、このモードがデフォルトです。「拡張機能説明」の「関心を引く情報」を参照してください。
処理される動的オブジェクトごとに mapfile を作成します。これらの mapfile には、処理されている入力ファイルで必要になる各オブジェクトのインタフェース要件が反映されます。
インタフェース情報を、オーバーヘッドとみなされているシンボルに制限します。mapfile の作成時、オーバーヘッドシンボルがローカルシンボルとして項目化されます。「拡張機能説明」の「オーバーヘッド情報」を参照してください。
Saves the bindings information produced from ldd(1), or kldd(1), for further analysis.See FILES.
すでにバージョン定義されているオブジェクトを無視します。バージョン定義されているオブジェクトのインタフェースはすでに定義されていますが、表示されるインタフェース情報にはその情報が含まれています。たとえば、バージョン定義されている共有オブジェクトであれば、特定のプロセスのオーバーヘッドシンボルが表示される場合があります。共有オブジェクトは多くの場合、複数のプロセスで使用できるように設計されているので、これらのオブジェクトで用意されているインタフェースは、単一のプロセスの要件を超えるときがあります。したがって –v オプションを使用すると、インタフェース情報を表示するときにノイズを軽減できます。
関心を引くシンボル可視設定を追加します。singleton または protected と定義されたシンボルは、このオプションで識別されます。
バージョン情報を出力してすぐに終了します。
使用法に関するメッセージを出力したあと、すぐに終了します。
lari から生成される実行時インタフェース情報は、次の形式になります。
[information]: symbol-name [demangled-name]: object-name
各行には、インタフェースシンボル (symbol-name) と、シンボルが定義されるオブジェクト (object-name) が記述されます。シンボルが関数を表す場合、シンボル名のあとに () が続きます。If the symbol represents a data object, the symbol name is followed by the symbol size, enclosed within [].If the –C option is used, the symbol name is accompanied by the demangled name, demangled-name.情報フィールドには、シンボルの使用について記述した次のトークンの 1 つまたは複数が表示されます。
2 つの 10 進数値は、シンボル数 (cnt) と、このオブジェクトへの結合の数 (bnd) を示します。シンボル数は、分析対象のオブジェクトで見つかったこのシンボル定義の出現数です。1 より大きな数は、シンボル定義が複数回出現したことを示しています。結合の数は、実行時リンカーによってこのシンボル定義に結合されたオブジェクトの数を示しています。
このシンボル定義は、外部オブジェクトから結合されています。
このシンボル定義は、同じオブジェクトから結合されています。
The following tokens are specific to userland executables and shared objects:
このシンボル定義は、動的実行可能ファイル内でのプロシージャリンケージテーブルエントリのアドレスです。
このシンボル定義は、コピー再配置の参照データです。
このシンボル定義は、直接結合されています。
このシンボル定義は filtee にあります。
このシンボル定義は割り込みシンボルを規定します。明示的に割り込みオブジェクトであることを示すオブジェクトは、すべてのグローバルシンボルを割り込みシンボルとして定義します。 ld(1) の –z interpose オプションおよび ld.so.1(1) の LD_PRELOAD 変数を参照してください。動的実行可能ファイル内の個々のシンボルは、INTERPOSE mapfile 指令を使用することによって、割り込みシンボルとして定義できます。
このシンボル定義は、定義に直接結合することを明示的に禁止します。
このシンボルは protected と定義されています。このシンボルには、シンボルが宣言されたオブジェクトからの内部結合が存在する可能性があります。この属性を持つ内部結合には、別のシンボル定義が割り込むことはできません。
このシンボル定義はフィルタとして機能し、フィルタ対象へのリダイレクションを規定します。
このシンボルへの結合は、シンボル検索中のある時点で拒否されました。直接結合要求が、直接結合を防止するタグが付けられているシンボルを見つけると、結合が拒否されます。このシナリオでは、シンボル検索は、デフォルトの検索モデルを使用して繰り返されます。結合はまだ、元の拒否されたシンボルに解決できます。デフォルト以外のシンボル検索が、singleton として識別されたシンボルを見つけたときにも、結合は拒否されます。この場合も、シンボル検索は、デフォルトの検索モデルを使用して繰り返されます。
このシンボル参照は dlsym(3C) などのユーザー要求に起因します。
The following token is specific to kernel modules:
This symbol definition is a module stub (modstub) provided by the unix kernel.
これらのシンボル分類の詳細は、Oracle Solaris 11.4 Linkers and Libraries Guideを参照してください。
デフォルトで、または –i オプションを明示的に使用すると、lari は、実行時インタフェース情報をフィルタ処理して、関心を引くイベントを示します。このフィルタ処理は主に、大きなアプリケーションから生成される情報量を減らすときに実行します。また、この情報を使用すると、複雑な結合シナリオをデバッグするときに注目すべき箇所がわかります。多くの場合で、問題領域を強調します。ただし、特定のアプリケーション用に意味のある情報を正確に分類することは困難です。–a オプションを使用すると、調査対象のアプリケーションに固有のイベントの結合情報を自由に検索できます。
関心を引くシンボル定義が検出された場合、同じシンボルのほかのすべての定義が出力されます。関心を引くインタフェース情報がフォーカスしているのは、シンボルの複数の定義の存在です。However, the userland and kernel runtime linking environments differ substantially in the details of their operations, and so, the ways in which multiple definitions become interesting differ.
The userland runtime linking environment provides the concept of interposition, in which one symbol typically interposes on one or more other symbol definitions.ある定義の結合数 (bnd) が 0 でなく、ほかのすべての定義の結合数が 0 である場合に、この割り込みが発生しています。コンパイル環境 (つまりリンク環境) に起因する割り込みは、関心を引くものとは判断されません。これらの割り込みの出現例としては、コピー再配置 ([C]) や、プロシージャリンケージアドレスへの結合 ([A]) などがあります。
多くの場合、割り込みは望ましいものです。その目的は、共有オブジェクトからのシンボル定義を多重定義する、つまり置き換えることです。 ld(1) の –z interpose オプションを使用すると、割り込むオブジェクトに明示的にタグ ([I]) を付けることができます。これらのオブジェクトは、プロセスでオブジェクトを読み込む順番とは無関係に、安全にシンボルに割り込むことができます。ただし、明示的でない割り込みが使用される場合には注意してください。この割り込みは、プロセスを構成するオブジェクトの読み込み順序に起因するためです。
ユーザーが作成した多重定義シンボルは、関心を引く情報として lari から出力されます。この例では、interpose1() の 2 つの定義が存在しますが、main の定義だけが参照されます。
[2:1E]: interpose1(): ./main [2:0]: interpose1(): ./libA.so
割り込みは、予期しないシンボル名の衝突によって生じた、想定外の好ましくないイベントである場合もあります。このような割り込みの症状としては、関数への参照が存在することがわかっているのに、その関数が呼び出されない場合などがあります。このシナリオは、前の例で説明したように、多重定義シンボルとして識別できます。しかし、オブジェクトが特定のシンボルを定義および参照する場合に、より意外なシナリオが多く発生します。
このシナリオの例は、2 つの動的オブジェクトが同じ関数 interpose2() を定義し参照する場合です。このシンボルへの参照はすべて、プロセスで読み込まれる最初の動的オブジェクトに結合します。この場合、オブジェクト libA.so の interpose2() の定義は、オブジェクト libB.so の interpose2() の定義に割り込み、これを隠ぺいします。lari からの出力は次のようになります。
[2:2ES]: interpose2(): ./libA.so [2:0]: interpose2(): ./libB.so
多重定義シンボルに個別に結合する場合もあります。直接結合が有効になっている場合や ([D])、シンボルの可視性が protected の場合は ([P])、個別に結合されます。個別の結合は明示的に確立できますが、予期しない想定外の結合が存在する場合もあります。直接結合されたシンボルと、可視性が protected のシンボルは、関心を引く情報として出力されます。
The kernel runtime linking environment is more basic than the userland environment, and does not support the full userland interposition concept.However, multiple definitions can still cause a simple form of interposition in which one definition hides the other.A typical scenario is a module that defines a function that is also defined by one of its dependencies, or by the kernel runtime system.This type of interposition is seen when there are multiple definitions, each with a non-zero binding count.
This form of interposition might be useful.A module could provide a variation of some other module, by redefining the functions that differ, and allowing the older module to provide the remaining functions that do not need to be changed.Such interface inheritance must be managed carefully.The use of a mapfile to define explicit interfaces for such use is recommended.
Multiply-defined symbols are output from lari as interesting.In this example, module kmod provides its own implementation of the strlen() function.The module binds to its own version, while the rest of the system binds to the version found in the unix kernel:
[2:1E]: strlen(): /platform/i86pc/kernel/amd64/unix [2:1S]: strlen(): kmod
A scenario such as this is usually an undesirable and surprising event, caused by an unexpected symbol name clash.It is rarely desirable for parts of the system to use one implementation of a function like strlen(), while other parts use another.More typically, this output would suggest that a duplicate definition is unnecessary, and could be removed.
–o オプションを使用した場合、lari は、オーバーヘッドとみなされるシンボル定義を表示します。
参照されないグローバルシンボルはオーバーヘッドとみなされます。オブジェクト内で提供されるシンボル情報によって、オブジェクトのテキストセグメントのサイズが必要以上に増加します。さらに、シンボル情報によって、実行時にオブジェクト内でほかのシンボル参照を検索するために必要な処理が増える場合があります。
同じオブジェクトからしか参照されないグローバルシンボルは、同じ特性を持っています。シンボル参照の実行時検索は、結果として、参照を行なった同じオブジェクトへの結合になり、追加のオーバーヘッドになります。
これらの両方のシンボル定義は、オブジェクトのインタフェースを定義することによってローカルスコープに降格できます。インタフェース定義は、リンカーで、–M オプションおよび関連付けられた mapfile 指令を使用することによって、作成時にファイルに割り当てることができます。mapfile の詳細は、Oracle Solaris 11.4 Linkers and Libraries Guideを参照してください。–m オプションを付けて lari を使用して、これらの mapfile の初期バージョンを作成します。
lari を使用して mapfile を生成すると、バージョン定義された共有オブジェクトには、オーバーヘッドシンボルをローカルに降格すべきであることを示す mapfile が作成されます。このモデルでは、lari は、既存のインタフェース定義と比較するための mapfile を生成できます。–v オプションを使用して、mapfile を作成するときに、バージョン定義された共有オブジェクトを無視します。
コピー再配置はオーバーヘッドともみなされるため、通常は回避すべきです。コピーされたデータのサイズは、そのインタフェースの定義です。この定義は、データが定義されている共有オブジェクトのより新しいバージョンでのデータサイズを変更する機能を制限します。この制限、およびコピー再配置を処理するコストは、関数インタフェースを使用してデータを参照することによって回避できます。コピー再配置の lari からの出力は次のようになります。
[2:1EC]: __iob[0x140]: ./main [2:0]: __iob[0x140]: ./libA.so.1
前の例で使用された __iob など、いくつかの小さなコピー再配置が存在することに注意してください。これは、システムライブラリのプログラミング操作のために歴史的な理由により存在しています。
オーバーヘッド情報の別の例は、動的実行可能ファイルのプロシージャリンケージテーブルエントリに、動的オブジェクトを結合する場合です。動的実行可能ファイルが外部関数を参照する場合、プロシージャリンケージテーブルエントリが作成されます。この構造では、関数呼び出しが実際に行われるまで、参照結合を延期できます。動的オブジェクトがこの参照された同じ関数のアドレスを取得した場合、動的オブジェクトは、動的実行可能ファイルのプロシージャリンケージテーブルエントリに結合します。このタイプのイベントの例は、次の点を明らかにします。
[2:1EA]: foo(): ./main [2:1E]: foo(): ./libA.so
このタイプの少数の結合は、通常は心配する必要はありません。ただし、ジャンプテーブルプログラミング技法などによって、これらの結合が多数発生する場合は、オーバーヘッドを起こす一因となることが考えられます。このタイプのアドレス再配置結合では、直接関数を呼び出したときに使用される遅延再配置処理ではなく、アプリケーション起動時の再配置処理が必要になります。このアドレスを使用するために、実行時に間接参照も必要になります。
Without the –D option, lari uses ldd(1) to process userland executable and shared object files.次のオプションを使用します。
–r and –e LD_DEBUG=files,bindings,detail
これらのオプションは、オブジェクトを読み込む過程で確立されたすべての結合に関する情報を提示します。Due to the use of the ldd, the specified object is not executed, and hence no user controlled loading of objects, by dlopen(3C) occurs.実行プロセスからすべての結合情報を取得するために、次の環境変数を直接実行時リンカー ld.so.1(1) に渡すことができます。
LD_DEBUG=files,bindings,detail LD_DEBUG_OUTPUT=lari.dbg \ LD_BIND_NOW=yes
結果として得られるデバッグ出力 lari.dbg.pid は、lari で –D オプションを使用して処理できます。ノート: lari は、デバッグ出力で定義されたパス名を使用して処理された各オブジェクトを分析しようとします。したがって、完全な正確な分析を行うために、各オブジェクトには lari からアクセスできる必要があります。デバッグ出力ファイルは、C ロケールで生成する必要があります。
次の例では、複数のシンボル定義が存在するプロセスの分析を示します。共有オブジェクト libX.so と libY.so は関数 interpose() を呼び出します。この関数は、アプリケーション main と、共有オブジェクト libA.so の両方に存在します。割り込みのため、両方の参照は main の interpose() の定義に結合します。
共有オブジェクト libX.so と libY.so は関数 foo() も呼び出します。この関数は、アプリケーション main と、共有オブジェクト libA.so、libX.so、および libY.so に存在します。libX.so と libY.so の両方は直接結合を有効にして構築されているので、各オブジェクトはそれぞれ独自の定義に結合します。
example% lari ./main [3:0]: foo(): ./libA.so [3:1SD]: foo(): ./libX.so [3:1SD]: foo(): ./libY.so [2:0]: interpose(): ./libA.so [2:2EP]: interpose(): ./main
結合情報をさらに分析するために、結合データをその後の検査用に保存できます。たとえば、前の出力は、関数 interpose() が、main の外部にある 2 つのオブジェクトから呼び出されたことを示しています。結合の出力を検査することによって、この関数への参照が行われた場所を明らかにできます。
example% lari -s ./main
lari: ./main: bindings information saved as: \
/usr/tmp/lari.dbg.main
.....
example% fgrep foo /usr/tmp/lari.dbg.main
binding file=./libX.so to file=./main: symbol `interpose'
binding file=./libY.so to file=./main: symbol `interpose'
ノート: 結合の出力にはプロセス識別子、アドレス、その他の結合情報が伴うので、出力は通常、ここに示すよりも多くなります。
使用例 2 インタフェース定義の生成次の例では、アプリケーションとその依存関係のインタフェース定義を作成しますが、バージョンが定義されたシステムライブラリは無視します。アプリケーション main は、foo.so のインタフェース one()、two()、および three() を参照します。
example% lari -omv ./main
example% cat mapfile-foo.so
#
# Interface Definition mapfile for:
# Dynamic Object: ./foo.so
# Process: ./main
#
foo.so {
global:
one;
three;
two;
local:
_one;
_three;
_two;
*;
};
ldd(1) によって生成された結合の出力。
属性についての詳細は、マニュアルページの attributes(7) を参照してください。
|
人間が読める形式の出力は「不確実」です。オプションは「確実」です。
kldd(1), ld(1), ld.so.1(1), ldd(1), dlopen(3C), dlsym(3C), attributes(7)