Linux* ターゲットのサンプリング・ドライバーのビルドとインストール

リモート Linux* ターゲットシステム要件: ターゲットシステムへの root アクセスが必要です。

すべての Linux* システムの要件: サンプリング・ドライバーのソース。ローカルシステムのサンプリング・ドライバーのソースは、インテル® VTune™ プロファイラーのインストール先の <install_dir>/sepdk ディレクトリーにあります。リモートターゲットの場合、インストール先の <install_dir>/target ディレクトリーから、ターゲットシステム用のパッケージを見つけ、パッケージをターゲットにコピーして展開し、ドライバーをビルドします。

Linux* ホストシステムでのドライバーのインストール

Linux* ホストシステムで製品のインストール中に、[Advanced (詳細)] オプションによりドライバーのインストール・オプションを制御します。インテル® VTune™ プロファイラーは次のオプションを提供します。

オプション

説明

Sampling driver install type [build driver (default)/driver kit files only] (サンプリング・ドライバーのインストール・タイプ [ビルドドライバー (デフォルト)/ドライバー・キット・ファイルのみ])

ドライバーのインストール・オプションを選択します。デフォルトでは、インテル® VTune™ プロファイラーはカーネルに対応したドライバーをビルドするため、サンプリング・ドライバー・キットを使用します。インストール後にドライバーを手動でビルドする場合、[driver kit files only (ドライバー・キット・ファイルのみ)] オプションに変更します。

Driver access group [vtune (default)] (ドライバーのアクセスグループ [vtune (デフォルト)])

システムで収集を許可するユーザーを決定するため、ドライバーのアクセスグループの所有権を設定します。デフォルトのグループは、vtune です。このグループへのアクセスは制限されません。アクセスを制限するには、次の [Driver permissions (ドライバーのアクセス権限)] オプションを参照してください。[Advanced (詳細)] オプションでのインストール中に固有のグループを設定するか、インストール後に <install_dir>/sepdk/src ディレクトリーから、./boot-script -–group <your_group> コマンドを実行してグループを変更します。

Driver permissions [660 (default)] (ドライバーのアクセス権限 [660 (デフォルト)])

ドライバーのアクセス権限を変更します。デフォルトでは、vtune グループのユーザーのみがドライバーにアクセスできます。この設定で、ユーザーはシステム全体のプロファイル、アプリケーションのプロファイル、およびプロセスにアタッチしてプロファイルが可能です。

Load driver [yes (default)] (ドライバーのロード [はい (デフォルト)])

ドライバーをカーネルにロードします。

Install boot script [yes (default)] (ブートスクリプトのインストール [はい (デフォルト)])

システムを再起動するたびにドライバーをカーネルにロードするブートスクリプトを使用します。ブートスクリプトは、<install_dir>/sepdk/src ディレクトリーから、./boot-script --uninstall コマンドを実行して無効にできます。

Enable per-user collection mode [no (default)]/[yes] (ユーザーごとの収集モードを有効にする [いいえ (デフォルト)]/[はい])

ユーザーごとのフィルターを有効にして、ハードウェア・イベントベース・コレクターのドライバーをインストールします。フィルターが有効な場合、コレクターは収集を開始したユーザーによってスポーンされたプロセスのデータのみを収集します。無効 (デフォルト) の場合、システムのすべてのプロセスからサンプルが収集されます。セキュリティーの観点から、クラスター環境ではほかのユーザーから収集を分離するためフィルターを利用することを考えてください。管理者/root は、ドライバーをいつでも再ビルド/再起動することでフィルターモードを変更することができます。一般ユーザーは、製品のインストール後にモードを変更することはできません。

Linux* クラスター上の MPI アプリケーション解析では、インテル® Parallel Studio XE Cluster Edition をインストールする際に、[ユーザーごとのハードウェア・イベントベース・サンプリング] モードを有効にできます。このオプションは、収集中にインテル® VTune™ プロファイラーが現在のユーザーのデータのみを収集するようにします。インストール中に管理者によって有効にされると、通常のユーザーはこのモードを無効にすることができません。これは、ほかのユーザーのアクティビティーを含むノード全体のパフォーマンス・データを個々のユーザーが観察できないようにするためです。

インストール後に、それぞれの vars.sh ファイルを使用して、現在のターミナルセッションで適切な環境 (PATH、MANPATH) を設定できます。

Driver build options … (ドライバーのビルドオプション…)

このシステムのカーネル・ヘッダー・ファイルの場所を指定し、ドライバーのビルドに使用する C コンパイラーのパスと名前、ドライバーのビルドに使用する make コマンドのパスと名前を指定します。

サンプリング・ドライバーのインストールの確認

Linux* ホストシステム上で、サンプリング・ドライバーが正しくインストールされていることを確認するには、次の操作を行います。

  1. サンプリング・ドライバーがインストールされているか確認します。

    $ cd <install-dir>/sepdk/src

    $ ./insmod-sep -q

    これは、現在ドライバーがロードされているかどうかと、ドライバーデバイスのグループ所有権とファイルのアクセス権限に関する情報を提供します。

  2. グループの権限を確認します。

    ドライバーがロードされていても、ユーザーが query 出力のグループのメンバーに登録されていない場合、システム管理者にグループへの登録を申請してください。デフォルトのドライバーのアクセスグループは、vtune です。所属するグループを確認するには、コマンドラインから groups を実行します。これは、アクセス権限が 666 以外の場合にのみ必要です。

進行中の収集がなければ、ドライバーのロードによる実行時間のオーバーヘッドはなく、メモリー使用量のオーバーヘッドもわずかです。(デフォルトで使用される install-boot-script スクリプトなどを利用して) ブート時にシステムモジュールを自動的にロードすることができます。インテル® VTune™ プロファイラーによってデータが収集されていなければ、システムのパフォーマンスに影響するレイテンシーはありません。

カーネル設定の確認

カーネルの設定を確認します。

  1. カーネルのヘッダーソースが、ホストシステムに存在することを確認します。カーネルバージョンは、2.6.28 以降である必要があります。カーネルのバージョンを調べるには、kernel-src-dir/include/linux/utsrelease.h、またはカーネルのバージョンに応じて kernel-src-dir/include/generated/utsrelease.h を確認します。詳細は、sepdk/src ディレクトリーにある README.txt ファイルを参照してください。

  2. ハードウェア・イベントベース・サンプリング (EBS) 収集のため、次のオプションがカーネル設定で有効であることを確認してください。

    • CONFIG_MODULES=y

    • CONFIG_MODULE_UNLOAD=y

    • CONFIG_PROFILING=y (カーネルのバージョンが 5.16 以前の場合)

    • CONFIG_SMP=y

    • CONFIG_KALLSYMS=y

    • CONFIG_TRACEPOINTS=y (カーネルのバージョンが 5.17 以降では必須ですが、ほかのすべてのバージョンにも推奨されます)

    • CONFIG_KPROBES=y (カーネルのバージョンが 5.17 以降)

  3. また、上記のオプションに加え、スタック付きの EBS 収集向けのカーネル設定では、次のオプションが有効であるか確認してください。

  4. リモート・ターゲット・システムでカーネルモジュールの署名が必要であるかを決定します (CONFIG_MODULE_SIG_FORCE=y)。署名が必要である場合、ターゲットシステムと一致する署名キーが必要です。

    サンプリング・ドライバーを新たなカーネルソースからビルドして、それを既存のターゲットシステムで使用する場合、オリジナルのキーファイルを取得してサンプリング・ドライバーをオリジナルキーで署名する必要があります。別の方法として、新しいカーネルをビルドして、ターゲットデバイスに書き込んで使用することもできます。

サンプリング・ドライバーのビルド

必要条件:

注:

Linux* カーネルの更新などにより、インテル® VTune™ プロファイラーのインストールに含まれるサンプリング・ドライバーのバージョンがカーネルに適合しない場合、サンプリング・ドライバーのダウンロード・ページ (英語) から最新のサンプリング・ドライバーを入手できます。

ドライバーがない場合にビルドするには、次の操作を行います。

  1. ビルドスクリプトが格納されるディレクトリーに移動します。

    • ローカルシステム向けにドライバーをビルド: $ cd <install-dir>/sepdk/src

    • リモート・ターゲット・システム向けにドライバーをクロスビルド: $ cd <extract-dir>/sepdk/src

  2. カーネルに対応したドライバーをビルドする ./build-driver スクリプトを使用します。次に例を示します。

スクリプトの使い方に関するヘルプを表示するには、./build-driver -h コマンドを使用します。

Open Build Service (OBS) を使用して、RPM としてサンプリング・ドライバーをビルドするには:

ここでは、<install_dir>/sepdk/src ディレクトリーにある sepdk.spec ファイルを使用します。

サンプリング・ドライバーのインストール

リモート・ターゲット・システム要件: ssh、ftp、adb、sdb、またはサポートされるその他の手段を使用してターゲットシステム向けにドライバーを構築する場合、sepdk/src フォルダー、または --install-dir オプションで指定されるフォルダーをコピーします。

ドライバーをインストールするには、次の操作を行います。

  1. ドライバーのビルドが成功したら、./insmod-sep スクリプトを使用して手動でインストールします。

    $ cd <install_dir>/sepdk/src

    $ ./insmod-sep -r -g <group>

    ここで、<group> は、ドライバーへのアクセス権を持つユーザーのグループです。

    ユーザーごとのイベントベース・サンプリング収集を行うようにビルドされたドライバーをインストールするには、次のように -pu (-per-user) オプションを追加します。

    $ ./insmod-sep -g <group> -pu

    リソースが制限された環境で実行する場合、次のように -re オプションを追加します。

    $ ./insmod-sep -re

  2. ブート時に Linux* システムが自動的にドライバーをロードするようにします。

    $ cd <install_dir>/sepdk/src

    $ ./boot-script --install -g <group>

    -g <group> オプションは、ドライバーがビルドされたときのグループをオーバーライドする場合にのみ必要です。

Linux* システムからドライバーを削除するには:

./rmmod-sep -s

関連情報