PVS-Studio for Visual C ++

かなり前に、私たちの記事はすべて、PVS-Studioツール自体ではなく、あらゆることに専念し始めました。 実績のあるプロジェクト、C ++言語の複雑さ、C＃でのプラグインの作成、コマンドラインからのPVS-Studioの起動について説明します。 しかし、まず第一に、PVS-StudioはVisual Studioを使用する開発者を対象としています。 このツールを使いやすくするために多くのことをしました。 しかし、これは多くの場合、舞台裏にあるものです。 私はこの状況を修正し、PVS-Studioプラグインについてゼロから伝えることにしました。 Visual C ++を使用している場合は、この記事が役立ちます。

静的コード分析とは何か、なぜ必要なのか

静的コード分析は、プログラムのソースコードのエラーと欠点を識別するプロセスです。 静的分析は、自動化されたコードレビュープロセスと見なすことができます。 共同コードレビュー 、優れた方法論。 しかし、これには重大な欠点もあります-高コストです。 新しいコードをレビューしたり、推奨事項を作成した後にコードを再レビューしたりするために、定期的に複数のプログラマーを集める必要があります。



一方では、定期的にコードをレビューしたいと思います。 一方、高すぎます。 トレードオフは静的コード分析ツールです。 彼らはプログラムのソースコードをたゆみなく処理し、プログラマーにコードの特定のセクションにもっと注意を払うように勧めています。 もちろん、プログラムは、プログラマーのチームによって実行されたコードの完全なレビューに代わるものではありません。 ただし、利益/価格比により、静的分析の使用は多くの企業にとって非常に有用なプラクティスになります。



多数の商用および無料の静的コードアナライザーがあります。 静的アナライザーの大規模なリストは、ウィキペディアで入手できます： 静的コード分析のためのツールのリスト 。 静的コードアナライザーが存在する言語のリストも非常に多くなっています（C、C ++、C＃、Java、Ada、Fortran、Perl、Rubyなど）。 当然、 PVS-Studioアナライザーについて説明します。



静的解析の主な利点は、プログラムの欠陥をなくすコストを大幅に削減できることです。 エラーが早く特定されると、修正のコストが低くなります。 したがって、McConnellの著書「Perfect Code」に記載されているデータによると、テスト段階での間違いの修正には、設計（執筆）段階よりも10倍の費用がかかります。







図1.欠陥の導入と検出の時間に応じた欠陥修正の平均コスト（表のデータはS. McConnell "Perfect Code"による本から取られています）。 画像をクリックして拡大します。



静的分析ツールを使用すると、設計段階で多数のエラーを特定できるため、プロジェクト全体の開発コストを大幅に削減できます。 たとえば、PVS-Studio静的コードアナライザーはコンパイル直後にバックグラウンドで起動でき、潜在的なエラーが見つかった場合はプログラマーに通知します。 このモードの詳細については、以下で説明します。



コードレビューと静的分析のトピックについては、記事の最後に引用されている記事[ 1、2、3 ]で詳細に説明されています。

PVS-Studio Static Code Analyzer

PVS-Studioは、C、C ++、C ++ 11、C ++ / CXのアプリケーションのソースコードのエラーを検出する静的アナライザーです。 主にVisual Studioのユーザーを対象としています（他の環境のサポートについては、製品ページを参照してください ）。 アナライザーはVS2005-VS2012と完全に統合されます。 まもなくVS2013のサポートを追加します。 その結果、ユーザーはメインメニューの追加項目「PVS-Studio」と診断メッセージを操作するためのウィンドウを受け取ります（図2を参照）。







図2. Visual Studioへの統合中にPVS-Studioアナライザーによって追加された主な要素。 画像をクリックして拡大します。

初期設定

分析装置は、設置後すぐに操作できる状態になります。 ほとんどの場合、最初の実行を完了するために何も構成する必要はありません。 最初に必要な設定は、サードパーティのライブラリを除外することだけです。 jpegライブラリソースファイルの内容はまだ編集しません。 したがって、確認する必要はありません。 さらに、分析からフォルダーを除外すると、分析時間が短縮されます。 分析から除外されるディレクトリは、ここで設定されます：オプション->ファイルをチェックしない-> PathMasks（図3を参照）。







図3.アナライザーがチェックしないディレクトリーのリストの編集。 画像をクリックして拡大します。



指定された名前のいずれかがファイルのフルパスにある場合、分析は実行されません。 デフォルトでは、一部のディレクトリの名前はすでにリストに含まれています。 ただし、プロジェクトでは、ZLibライブラリを含むフォルダは「zlib」ではなく、「zip_lib」などと呼ばれる場合があります。 したがって、このリストを編集する必要があります。 編集を開始するには、3つの点があるボタンをクリックします。



PathMasksリストの有効なマスクの例：

• c：\ Libs \-このフォルダーとそのサブフォルダーにあるすべてのプロジェクトファイルは除外されます。
• \ Libs \または* \ Libs \ *-Libsサブフォルダーを含むパスを持つディレクトリにあるすべてのファイルが除外されます。 「*」文字が指定されていない場合でも、それらは自動的に追加されるため、両方の記録オプションは同じです。
• Libsまたは* Libs *-すべてのファイルが除外されます。パスには、名前または名前の断片として「Libs」を持つサブフォルダーが含まれます。 また、この場合、名前にLibを含むファイル、たとえばc：\ project \ mylibs.cppは除外されます。 混乱を避けるために、常にスラッシュを使用することをお勧めします。

フォルダ全体を除外することに加えて、個々のファイルを除外するマスクを指定できます。 このために、FileNameMasks設定があります。 除外リストの使用方法の詳細については、ドキュメント： 設定：ファイルをチェックしないを参照してください 。

プロジェクト検証

初期設定が完了すると、プロジェクトのチェックを開始できます。 ほとんどの場合、ソリューション全体をすぐに確認できます。 これを行うには、PVS-Studio-> Check-> Solutionメニュー項目を選択します（図4を参照）。







図4. PVS-Studioアナライザーを使用したソリューションの検証。



確認に問題がある場合は、当社のWebサイトの「 確認できませんか？ 」セクションを参照することをお勧めします。 これらは無知な「プラグが差し込まれていることを確認する」コンセントではありません。 このセクションでは、ユーザーが私たちに連絡した典型的な状況について説明し、アクションの推奨オプションを示します。

診断メッセージのリストを操作する

チェック後、すべての診断メッセージが特別なウィンドウに表示されます。 ウィンドウには多くのコントロールがあります。 それらはすべて、ユーザーにとって関心のある診断メッセージを正確に表示するのに役立ちます。 ただし、最初はウィンドウが複雑に見えるかもしれません。 すべてのコントロールを見てみましょう（図5を参照）。







図5.診断メッセージが表示されたウィンドウ。 画像をクリックして拡大します。

1. 実際にはPVS-Studioウィンドウ。
2. ボタンには、「問題が発生しました」というメッセージが含まれています。 たとえば、ファイルの1つを前処理することはできません。
3. さまざまなレベルのアラートを含むボタン。 現在、3つの診断レベルがすべて含まれています。 同時に、第1レベルの132個の警告、第2レベルの235個の警告、および第3レベルの390個の警告がウィンドウに表示されます。 メッセージレベルは、番号付きの三角形の形でいずれかの列に表示されます。
4. 診断ルールのアクティブなセット。 GA-一般診断、OP-最適化、64-64ビット診断、MP-OpenMP関連のエラー、CS-ユーザー診断。 このウィンドウには、GAおよびMPに関連する警告が表示されます。
5. falseとマークされたメッセージの表示を有効/無効にします。 誤ったアラートがオンになりました。 この機能の詳細については、ドキュメント： 誤警告の抑制を参照してください 。
6. 診断メッセージを検索します。
7. クイックフィルター。 たとえば、コードV501を持ち、XYZプロジェクトにあるメッセージのみをリストに残すことができます。
8. 前/次のメッセージに移動します。 これにより、対応するファイルが開き、カーソルが潜在的なエラーのある行に置かれます。 また、ダブルクリックして、リストから診断をいつでも選択できます。
9. 設定ウィンドウを開きます。

診断メッセージの表は、次の列に分かれています。

• アスタリスク 彼女には特別な目的はありません。 ユーザーは自分の判断で解釈できます。 例えば、彼はさらに注意深い分析のために最も興味深い警告を指摘するかもしれません。 たとえば、ThunderbirdやOutlookなどの電子メールプログラムで、文字にアスタリスクを付けることです。
• レベル 。 警告が適用されるレベル。 1レベル-最も不審な場所。 レベル3-コードの誤検知または軽微な不正確性。
• ID 一意のメッセージ番号。 大きなリストを扱うときに便利です。 たとえば、特定の番号のメッセージに移動できます（ コンテキストメニューの[ IDへの移動... ]項目を参照）。
• コード メッセージコード マウスでクリックすると、警告の説明が記載されたページが開きます。
• メッセージ 診断メッセージのテキスト。
• プロジェクト プロジェクト名（コンテキストメニューを使用してこの列を無効にできます）。
• ファイル ファイル名。
• 行 行番号。 重要！ いくつかの行の後、セミコロンがビルドされることに注意してください。 例：「123（...）」。 この番号をクリックすると、このメッセージに関連するすべてのコード行のリストが表示されます。 この場合、リスト内の各行に移動できます。
• 「False Alarm」をマークします。 警告が偽であることを示すマーク。 N 5ボタンが押された場合にのみ、コードに誤った警告が表示されることに注意してください（図5を参照）。

はい、これをすべて読むのは大変でした。 ただし、使用を開始すると、すぐにツールに慣れることができます。 また、設定するために何かを押すことはほとんどありません。

コンテキストメニュー

したがって、メッセージをダブルクリックすると、目的のテキストの断片に移動します。 マウスの右ボタンを押すと、コンテキストメニューが開きます。



メニューは非常にシンプルで、各項目の説明で記事をオーバーロードしないでください。 不明な点がある場合は、ドキュメントをご覧ください。



ただし、非常に便利な機能について説明します。



設定で、除外するフォルダー/ファイルを追加できることに注意してください（図2を参照）。 そのため、何かを追加するのは思ったよりもずっと簡単です！



「ファイルをチェックせず、すべてのメッセージを非表示にしない」という項目に注意してください。 クリックすると、例外に追加できるパスのリストが表示されます（図6を参照）。







図6.スキャンからファイルを除外します。 画像をクリックして拡大します。



別のファイルまたはディレクトリのいずれかを選択できます。 この図は、フォルダー「E：\ [Build] \ VirualDub \ src \ test」が選択されていることを示しています。 これは、このフォルダーとすべてのサブフォルダー内のすべてのファイルが分析から除外されることを意味します。 さらに、これらのファイルに関連するすべてのメッセージはリストからすぐに消えます。 とても快適です。 テスト（フォルダー「test」）に関連するすべてのメッセージを削除するために、分析を再開する必要はありません。

増分分析モード

最も重要な機能の1つであるインクリメンタルコード分析について話さないと、PVS-Studioの概要は不完全になります。



エラーが早く発見されるほど、修正のコストは安くなります。 プログラムの編集済みテキストのエラーをすぐに強調することが理想的です。 ただし、技術的に難しく、リソースを大量に消費します。 したがって、PVS-Studioは、修正されたコードが正常にコンパイルされた時点でバックグラウンドで起動します。 したがって、エラーは変更されたばかりのコードで検索されます。 分析が行われているという事実は、システムトレイのアイコンによって判断できます。



エラーが見つかると、危険を警告するポップアップウィンドウが表示されます（図7を参照）。







図7.編集されたファイルに疑わしい場所が見つかったというポップアップメッセージ。



このポップアップメッセージをクリックすると、PVS-Studioウィンドウが開き（図2を参照）、疑わしいコードフラグメントを調べることができます。



実際、このモードを説明するよりも、このモードを使用する方が簡単です。 前と同じようにコードを書きます。 必要に応じて、アナライザーが邪魔します。 試してみてください！



私たちは常にこのモードを使用しています。 はい、コーディングエラーが発生することもあります。 また、それらをすぐに修正する機能により、欠陥を検出する時間と、プログラムが計画どおりに動作しない理由を理解しようとする時間が大幅に短縮されます。 デバッグに15〜20分費やしてから、インデックスのタイプミスを見つけるのは残念です。 PVS-Studioがコードに表示された直後にPVS-Studioでエラーを検出した最後のケースの1つを次に示します。

if (in[0] == '\\' && in[1] == '.' && in[1] == '\\') { in += 2; continue; }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

しかし、これらはもちろん花です。 PVS-Studioアナライザーは非常に便利な場合があります。 アナライザーに関するレビューの1つは、「 静的アナライザーの使用例 」です。 テキストはあなたに考えさせます。



まとめます。 インクリメンタル分析は、間違いなく試してみるべきものです。 新しいコードでいくつかの間違いを見つけたらすぐに彼を愛するでしょう。

PVS-Studioの機能

簡単にしましょう。 PVS-Studioで利用可能なすべての診断を簡潔に説明することは不可能です。 診断の完全なリストとその詳細な説明は、ドキュメント「診断されたエラーの説明」に記載されています。 診断をタイプごとにグループ化したテーブルに限定します。 一部の診断は、複数のグループに含まれています。 実際、分割は非常にarbitrary意的です。 たとえば、タイプミスにより、初期化されていないメモリが使用される可能性があります。 それどころか、いくつかのエラーはテーブル内の場所を見つけられませんでした;それらはあまりにも具体的です。 それでも、表全体を見ると、静的コードアナライザーの機能がわかります（図8を参照）。







図8. PVS-Studioの機能。 画像をクリックして拡大します。



ご覧のとおり、タイプミスにより発生したエラーの検索、コピーペーストなどの領域で、アナライザは可能な限り顕在化します。 コードセキュリティに関連する問題を診断します。



これが実際にどのように機能するかについては、エラーデータベースを調べるとわかります 。 このデータベースでは、さまざまなオープンソースプロジェクトをチェックすることで発見したすべてのエラーを収集します。

おわりに

もちろん、ここでは楽器についてすべてを説明しませんでした。 すべてを伝えると、記事はドキュメントに変わります。 目標は、Visual Studio環境内でツールを使用することがいかに簡単かを示すことでした。 他の環境と動作モードについては、当社のWebサイトにあるドキュメントと他の記事で読むことができます。 ちなみに、プログラマーにとっては興味深いことがたくさんあります。 歩き回ってください。



トラブルのないコードをお祈りし、PVS-Studioをお楽しみください。 ご質問がある場合は、いつでもお気軽にお問い合わせください。 私たちに書いてください 。

追加のリソース：

1. コードレビュー
2. 静的コード分析 。
3. 静的コード分析ツール 。
4. 静的解析に関する神話。 2番目の神話は、プロの開発者が愚かな間違いを犯さないということです。
5. PVS-Studioをダウンロードして試してください。
6. エラーがほとんどないのはなぜですか？ レオトルストイと静的コード分析 。
7. チームのPVS-Studioアナライザーの価格とその購入方法について話し合います： PVS-Studioを購入します。
8. 記事を読んだ後によく聞かれる質問への回答。

更新

記事の更新版： PVS-Studio for Visual C ++ 。