この記事は、インテル® デベロッパー・ゾーンに公開されている「Tutorial: Analyzing Memory Errors With Intel® Inspector and a C++ Sample Application for Linux*」の日本語参考訳です。
この記事の PDF 版はこちらからご利用になれます。
目次
メモリーエラー解析の使用例
ナビゲーションのクイックスタート
スタンドアロン GUI: アプリケーションのビルドと新規プロジェクトの作成
解析の設定
解析の実行
問題の選択
結果データの解釈
問題の解決
リビルドと解析の再実行
まとめ
法務上の注意書き
インテル® Inspector は、Windows* および Linux* でシリアル・アプリケーションおよびマルチスレッド・アプリケーションを開発するユーザー向けの、メモリーとスレッドのエラーを動的にチェックするツールです。
このチュートリアルでは、C++ サンプル・アプリケーションを使用して、Linux* プラットフォームでインテル® Inspector を利用してメモリーエラーを解析する方法を示します。
インテル® Inspector は、スタンドアロン製品として、または次の製品のコンポーネントとして利用できます。
- インテル® System Studio Professional Edition
- インテル® System Studio Ultimate Edition
- インテル® Parallel Studio XE Professional Edition
- インテル® Parallel Studio XE Cluster Edition
- ベータ版インテル® oneAPI HPC ツールキット
- ベータ版インテル® oneAPI IoT ツールキット
| チュートリアルの概要 | 最終的に独自のアプリケーションに適用可能なエンドツーエンドのワークフローを示します。
|
| 所要時間 | 10 – 15 分 |
| 目的 | 以下のトピックについて説明します。
|
| 関連情報 | このチュートリアルの概念と手順は、プログラミング言語に関係なく適用されますが、別のプログラミング言語のサンプル・アプリケーションを使用したチュートリアルも用意されています。
これらのサイトでは、ほかのインテル製品のチュートリアルも提供されています。 さらに、以下のサイトから追加のリソースを利用できます。 |
メモリーエラー解析の使用例
強力で柔軟性に優れたインテル® Inspector を活用する方法はたくさんあります。シリアルプログラムと並列プログラムのメモリーエラーを見つけて修正する次のワークフローは、生産性を迅速かつ最大限に高める 1 つの方法です。
このチュートリアルでは、次の方法でこのワークフローを実装します。
| ステップ 1: サンプルの展開と解析用の設定 | メモリーエラーを調査するためアプリケーションをビルドして、インテル® Inspector 環境を設定して、新しいインテル® Inspector プロジェクトを作成します。 |
| ステップ 2: 結果の収集 | |
| ステップ 3: 結果の調査 | |
| ステップ 4: 作業の確認 | アプリケーションをリビルドして、メモリーエラー解析を再度実行します。 |
ナビゲーションのクイックスタート
- インテル® Inspector 環境を設定する
- インテル® Inspector スタンドアロン GUI を開く
- インテル® Inspector スタンドアロン GUI を使用する
- インテル® Inspector の結果タブを使用する
インテル® Inspector 環境を設定する
次のいずれかの方法でインテル® Inspector 環境を設定します。
- 次のいずれかの
sourceコマンドを実行します。- csh/tcsh ユーザーの場合:
source <inspector-install-dir>/inspxe-vars.csh - bash ユーザーの場合:
source <inspector-install-dir>/inspxe-vars.sh
注
インテル® oneAPI HPC ツールキットまたはインテル® oneAPI IoT ツールキットに含まれるインテル® Inspector では、このスクリプトの名前は inspxe-vars ではなく env\vars です。デフォルトのインストール先
<inspector-install-dir>は、次のディレクトリー以下にあります。- root ユーザーの場合:
/opt/intel/ - 非 root ユーザーの場合:
$HOME/intel/
- csh/tcsh ユーザーの場合:
<inspector-install-dir>/bin32または<inspector-install-dir>/bin64をパスに追加します。
場合によっては、<studio-install-dir>/psxevars.csh または <studio-install-dir>/psxevars.sh コマンドを実行することもできます。デフォルトのインストール先 <studio-install-dir> は、次のディレクトリー以下にあります。
- root ユーザーの場合:
/opt/intel/ - 非 root ユーザーの場合:
$HOME/intel/
インテル® Inspector スタンドアロン GUI を開く
inspxe-gui コマンドを実行します。
インテル® Inspector スタンドアロン GUI を使用する
インテル® Inspector の結果タブを使用する
ボタンをクリックしてウィンドウペインの使用法に関するヘルプページを表示します。
、
、
、または 
をクリックしてウィンドウペインの表示/非表示を切り替えます。スタンドアロン GUI: アプリケーションのビルドと新規プロジェクトの作成
インテル® Inspector でメモリーエラーを調査可能なアプリケーションを作成します。
- ソフトウェア・ツールを取得する
- 最適なコンパイラー/リンカー設定を理解する
- アプリケーションをビルドする
- アプリケーションがインテル® Inspector の外部で実行されることを確認する
- インテル® Inspector 環境を設定する
- インテル® Inspector スタンドアロン GUI を開く
- 新しいプロジェクトを作成する
ソフトウェア・ツールを取得する
tachyon_insp_xe サンプル・アプリケーションを使用してチュートリアルの手順を実行するには、次のツールが必要です。
- インテル® Inspector のインストール・パッケージとライセンス
.tgzファイルの展開ユーティリティー- サポートされるコンパイラー (詳細はリリースノートを参照)
- エディター
インテル® Inspector をまだインストールしていない場合は、https://www.isus.jp/intel-inspector-xe/ から評価版をダウンロードします。
インテル® Inspector サンプル・アプリケーションをインストールして設定する
tachyon_insp_xe.tgzファイルを<install-dir>/samples/<locale>/C++/ディレクトリーから書き込み可能なディレクトリーへコピーするか、システムで共有します。デフォルトの<install-dir>は/opt/intelです。.tgzファイルからサンプルを展開して、tachyon_insp_xeディレクトリーを作成します。- EDITOR または VISUAL 環境変数が使用するテキストエディターに設定されていることを確認してください。
注
- サンプルは非決定的です。このチュートリアルで示すスクリーンショットは、実際の画面とは異なる場合があります。
- サンプルは、インテル® Inspector の機能を説明することを目的としており、コード作成のベスト・プラクティスを示すものではありません。
最適なコンパイラー/リンカー設定を理解する
インテル® Inspector は、デバッグモードとリリースモードの C++ および Fortran バイナリーでメモリーとスレッドのエラーを解析できますが、次の設定を使用してデバッグモードでコンパイル/リンクされたアプリケーションにおいて最も正確で完全な解析結果を生成します。
| コンパイラー/リンカーのプロパティー | 適切な C/C++ 設定 | 不適切な設定による影響 |
|---|---|---|
| デバッグ情報 | 有効 (-g) |
ファイル/行情報の欠落 |
| 最適化 | 無効 (-O0) |
正しくないファイル/行情報 |
| ダイナミック・ランタイム・ライブラリー | 選択 (インテル® コンパイラーの場合は -shared-intel、GNU* コンパイラーの場合はデフォルトまたは -Bdynamic) |
誤検出またはコード位置の欠落 |
| 基本ランタイム・エラー・チェック | 無効 (-fmudflap は使用しない) |
誤検出 |
| コンパイラー/リンカーのプロパティー | 適切な Fortran 設定 | 不適切な設定による影響 |
| デバッグ情報 | 有効 (-debug または -g) |
ファイル/行情報の欠落 |
| 最適化 | 無効 (-O0) |
正しくないファイル/行情報 |
| ダイナミック・ランタイム・ライブラリー | 選択 (-shared-intel) |
誤検出またはコード位置の欠落 |
| 基本ランタイム・エラー・チェック | なし (-check:none) |
誤検出 |
アプリケーションをビルドする
- ターミナルセッションで、ディレクトリーを
tachyon_insp_xeに変更します。 makeを実行します。
アプリケーションがインテル® Inspector の外部で実行されることを確認する
- 同じターミナルセッションで、次のコマンドを使用してサンプル・アプリケーションを実行します。
./tachyon.find_and_fix_memory_errors - アプリケーションの出力は次のようになります。
アプリケーションの出力ウィンドウは空です。原因はメモリーエラーです。さまざまなメモリーエラーを解決すると、アプリケーションの出力は次のようになります。
インテル® Inspector 環境を設定する
次のいずれかの方法でインテル® Inspector 環境を設定します。
- 次のいずれかの
sourceコマンドを実行します。- csh/tcsh ユーザーの場合:
source <inspector-install-dir>/inspxe-vars.csh - bash ユーザーの場合:
source <inspector-install-dir>/inspxe-vars.sh
注
インテル® oneAPI HPC ツールキットまたはインテル® oneAPI IoT ツールキットに含まれるインテル® Inspector では、このスクリプトの名前は inspxe-vars ではなく env\vars です。デフォルトのインストール先
<inspector-install-dir>は、次のディレクトリー以下にあります。- root ユーザーの場合:
/opt/intel/ - 非 root ユーザーの場合:
$HOME/intel/
- csh/tcsh ユーザーの場合:
<inspector-install-dir>/bin32または<inspector-install-dir>/bin64をパスに追加します。
場合によっては、<studio-install-dir>/psxevars.csh または <studio-install-dir>/psxevars.sh コマンドを実行することもできます。デフォルトのインストール先 <studio-install-dir> は、次のディレクトリー以下にあります。
- root ユーザーの場合:
/opt/intel/ - 非 root ユーザーの場合:
$HOME/intel/
インテル® Inspector スタンドアロン GUI を開く
同じターミナルセッションで、inspxe-gui & コマンドを使用してインテル® Inspector スタンドアロン GUI をバックグラウンドで実行します。
新しいプロジェクトを作成する
- [File] > [New] > [Project…] を選択して、次のようなダイアログボックスを表示します。
![[Create a Project] ダイアログボックス](https://www.isus.jp/wp-content/uploads/image/M06_CE5470E2-E0B0-4432-88B1-1A4A98DED41A.jpg)
- [Project name] フィールドに
memoryと入力します。[Create project] ボタンをクリックして、~/intel/inspxe/projects/memory/ディレクトリー (デフォルトの場所) にconfig.inspxeprojファイルを生成します。次のようなダイアログボックスが表示されます。![[Project Properties] ダイアログボックスの [Target] タブ](https://www.isus.jp/wp-content/uploads/image/M06_F27F303C-26CE-4CF6-AAB1-CE19C6FA3619.jpg)
- [Application] フィールドの横にある [Browse…] ボタンをクリックして、
tachyon_insp_xe/tachyon.find_and_fix_memory_errorsアプリケーションを選択します。インテル® Inspector によって [Working directory] フィールドに値が自動入力されます。[OK] ボダンをクリックして [Welcome] ページに戻ります。開いたプロジェクトの名前がタイトルバーと [Project Navigator] ペインに表示されます(必要に応じて、[View] > [Project Navigator] を選択して [Project Navigator] を表示します)。
解析の設定
インテル® Inspector には、解析の範囲とコストの制御を支援するため、事前定義済みのさまざまなメモリー解析タイプが用意されています。範囲が最も狭い解析タイプは、システムの負荷、および解析の実行に必要な時間とリソースが最小になりますが、最も少ないエラーセットを検出し、最小限の情報のみ提供します。範囲が最も広い解析タイプは、システムの負荷、および解析の実行に必要な時間とリソースが最大になりますが、最も多くのエラーセットを検出し、最も詳細な情報を提供します。
メモリーエラー解析を設定します。
[Analysis Type] ウィンドウを理解する
次のような [Analysis Type] ウィンドウを表示します。
- [File][New][Analysis…] を選択します。
- 解析タイプ・ドロップダウン・リストから [Memory Error Analysis] を選択します。
- スライダーを使用して [Detect Memory Problems] 解析タイプを選択します。
注
ウィンドウに 3 つのインタラクティブなデバッガー・ラジオボタンが表示される場合があります。
![[Analysis Type] ウィンドウ](https://www.isus.jp/wp-content/uploads/image/M06_22C694E0-906D-4C96-AA35-842F4076CE5A.jpg)
メモリーエラー解析タイプを選択する
次のステップに進む前に、設定内容が上記のスクリーンショットと一致していることを確認してください。インタラクティブなデバッガー・ラジオボタンが表示されている場合は、[Analyze without Debugger] ラジオボタンがオンになっていることを確認してください。
解析の実行
修正が必要なメモリーエラーを検出するには、[Analysis Type] ウィンドウの [Start] ボタンをクリックします。インテル® Inspector は、次の処理を実行します。
tachyon.find_and_fix_memory_errorsアプリケーションを実行します。- 対応が必要なメモリーエラーを識別します。
intel/inspxe/projects/memory/以下のディレクトリーに結果を収集します。- 結果をファイナライズします。
解析中、インテル® Inspector は次のような [Collection Log] ウィンドウを表示します。
![[Collection Log] ウィンドウ](https://www.isus.jp/wp-content/uploads/image/M06_D6E1B01A-A84F-40D1-84C7-0E1E8E1DD038.jpg)
注
このチュートリアルでは、インテル® Inspector スタンドアロン GUI から解析を実行する方法を説明します。インテル® Inspector コマンドライン・インターフェイス (inspxe-cl コマンド) を使用して解析を実行することもできます。
解析が完了すると、[Summary] ウィンドウが自動的に表示されます。
問題の選択
検出されたメモリーエラーの調査を開始します。
主要な用語を理解する
code location (コード位置): 「書き込み」コード位置など、インテル® Inspector が観測したソースコードの場所。以前は observation (観測位置) と呼ばれていました。
problem (問題): 初期化されていないメモリーアクセスなど、1 回または複数回検出された問題。問題が複数回検出された場合、コールスタックは同じですが、スレッドやタイムスタンプは異なります。問題とそれぞれの検出に関する情報を確認できます。
problem set (問題セット): アプリケーション実行中のオブジェクトの割り当て解除が早すぎることに起因する問題セットなど、解決策が共通している可能性がある、共通の問題タイプと共有コード位置を持つ問題のグループ。問題セットは、解析が完了した後にのみ表示されます。
その他の主要な用語については、「インテル® Inspector の用語集」 (英語) を参照してください。
[Summary] ウィンドウ内の各種ペインを理解する
解析が完了すると、次のような [Summary] ウィンドウが自動的に表示されます。
![[Summary] ウィンドウ](https://www.isus.jp/wp-content/uploads/image/M06_363F6EAD-A279-4CC3-A48B-40423ADC5815.jpg)
アイコンをクリックして、問題セットに含まれる問題を確認します。問題を選択する
確認が終わったら、find_and_fix_memory_errors.cpp ソースファイルの [Mismatched allocation/deallocation] 問題セットのデータ行をダブルクリックして、[Sources] ウィンドウでエラーの原因に関する詳細を確認します。
結果データの解釈
検出されたメモリーエラーの原因を特定します。
[Sources] ウィンドウ内の各種タブを理解する
[Mismatched allocation/deallocation] 問題セットのデータ行をダブルクリックすると、次のような [Sources] ウィンドウが表示され、エラーの原因に関する詳細な情報を確認できます。
![[Sources] ウィンドウ](https://www.isus.jp/wp-content/uploads/image/M06_185E726E-6464-485E-909F-B457161CBC57.jpg)
アイコンを使用して、[Mismatched allocation/deallocation] 問題の各コード位置のソース、逆アセンブリー、コールスタック情報を展開/折りたたみます。
問題の解釈と解決に関する詳細情報にアクセスする
- ソースタブまたは [Disassembly] タブ内の任意の場所を右クリックします。
- [Explain Problem] を選択して、[Mismatched deallocation site] 問題タイプに関するインテル® Inspector のヘルプを表示します。
問題の解決
検出されたメモリーエラーを修正します。
問題を調査する
find_and_fix_memory_errors.cpp サンプルファイルに埋め込まれているコメントから、[Mismatched allocation/deallocation] 問題の原因は、適切な割り当て解除関数 delete の代わりに free が使用されているためだと分かります。
エディターにアクセスする
ソースタブでハイライト表示されているコードをダブルクリックして、エディターで find_and_fix_memory_errors.cpp ソースファイルを開きます。
ソースコードを変更する
- free(drawing); をコメントアウトして、//delete drawing; のコメントを外します。
- 編集内容を保存します。
- 結果タブをクリックして [Sources] ウィンドウに戻ります。
注
[Sources] ウィンドウのデータは、解析時のソースコードであるため、変更内容は反映されません。 - [Summary] ボタンをクリックして [Summary] ウィンドウを再度表示します。
リビルドと解析の再実行
ソースコードの変更により [Mismatched allocation/deallocation] 問題が修正されたかどうか確認します。
アプリケーションをリビルドする
ターミナルセッションで、次の操作を行います。
- ディレクトリーを
tachyon_insp_xe/に変更します。 makeを実行します。
解析を再度実行する
同じ解析タイプの別の解析を実行するには、インテル® Inspector スタンドアロン GUI のメニューから、[File] > [New] > [Memory Error Analysis / Detect Memory Problems] を選択します。
アプリケーションの出力が適切に表示されるようになります。
解析 (収集とファイナライズの両方) が完了すると、[Summary] ウィンドウが自動的に表示されます。
![[Summary] ウィンドウ](https://www.isus.jp/wp-content/uploads/image/M06_CA8A1CB2-FCAB-443E-8C08-7280406DB2D4.jpg)
次のことに気付くでしょう。
- 新しい結果タブ「r002mi2」が作成されます。
find_and_fix_memory_errors.cppソースファイルで [Mismatched allocation/deallocation] 問題が検出されなくなりました。
まとめ
このチュートリアルでは、最終的に独自のアプリケーションに適用可能なエンドツーエンドのワークフローを示しました。
| ステップ | チュートリアルの内容 | 要点 |
|---|---|---|
| 1. 設定 | 最適なコンパイラー/リンカー設定でアプリケーションをビルドして、インテル® Inspector の外部で実行されることを確認し、インテル® Inspector 環境を設定して、解析結果を保持するプロジェクトを作成します。 |
次のオプションでデバッグモードでコンパイル/リンクされたアプリケーションは、最も正確で完全な結果を生成します: |
| 2. 結果の収集 | 解析タイプを選択して解析を実行します。解析中、インテル® Inspector は次の処理を行います。
|
|
| 3. 結果の調査 | 検出された問題を調査し、結果データを解釈して、インテル® Inspector からエディターに直接アクセスしてソースコードを変更します。 |
|
| 4. 作業の確認 | アプリケーションをリビルド/再リンクして、再度調査します。 |
次のステップ: 解析用に独自のアプリケーションを準備して、インテル® Inspector でエラーを見つけて修正します。
法務上の注意書き
本資料は、明示されているか否かにかかわらず、また禁反言によるとよらずにかかわらず、いかなる知的財産権のライセンスも許諾するものではありません。
インテル® テクノロジーの機能と利点はシステム構成によって異なり、対応するハードウェアやソフトウェア、またはサービスの有効化が必要となる場合があります。実際の性能はシステム構成によって異なります。絶対的なセキュリティーを提供できる製品またはコンポーネントはありません。詳細については、各システムメーカーまたは販売店にお問い合わせいただくか、http://www.intel.co.jp/ を参照してください。
インテルは、明示されているか否かにかかわらず、いかなる保証もいたしません。ここにいう保証には、商品適格性、特定目的への適合性、および非侵害性の黙示の保証、ならびに履行の過程、取引の過程、または取引での使用から生じるあらゆる保証を含みますが、これらに限定されるわけではありません。
本資料には、開発中の製品、サービスおよびプロセスについての情報が含まれています。ここに記載されているすべての情報は、予告なく変更されることがあります。インテルの最新の製品仕様およびロードマップをご希望の方は、インテルの担当者までお問い合わせください。
本資料で説明されている製品およびサービスには、設計上の不具合が含まれている可能性があり、公表されている仕様とは異なる動作をする場合があります。現在確認済みのエラッタについては、インテルまでお問い合わせください。
Intel、インテル、Intel ロゴは、アメリカ合衆国および / またはその他の国における Intel Corporation またはその子会社の商標です。
* その他の社名、製品名などは、一般に各社の表示、商標または登録商標です。
© Intel Corporation.
本ソフトウェアおよび関連ドキュメントは、インテルが著作権を有する著作物であり、その使用には付随する明示的なライセンス (「ライセンス」) が適用されます。ライセンスに明記されている場合を除き、インテルから事前に書面による許可なしに、ソフトウェアまたは関連ドキュメントを使用、改変、複製、公開、配布、開示、転送してはなりません。
本ソフトウェアおよび関連ドキュメントは現状のまま提供され、ライセンスに明記されている場合を除き、明示されているか否かにかかわらず、いかなる保証もいたしません。
コンパイラーの最適化に関する詳細は、最適化に関する注意事項を参照してください。
