IncrediBuild分散アセンブリシステムとPVS-Studioの統合

PVS-StudioはC / C ++コードを分析し、エラーが隠れている場所をプログラマーに伝えるか、将来問題になる可能性のあるコードのセクションを示します。 開発中のプロジェクトが十分に大きい場合、分析には非常に長い時間がかかる可能性があります。 大規模プロジェクトの分析を高速化するには、IncrediBuildツールを使用できます。 PVS-StudioアナライザーとIncrediBuildツールが既にインストールされている場合は、この記事から友達を作り、分析を高速化する方法を学びます。 将来、PVS-StudioアナライザーはIncrediBuildとさらに密に統合されるでしょう。 ただし、PVS-Studioの起動を複数のマシンで並行して実行できることを繰り返します。 簡単です。 記事では、その方法を説明します。

はじめに

プロジェクトのコンパイルに30分以上かかる開発者は、 IncrediBuild製品の存在を知っています。 このソリューションは、複数のマシンでの分散アセンブリによるコンパイルを高速化するように設計されています。 その結果、複数のコンピューター（たとえば4台）が同時にプロジェクトをコンパイルしています。 各コンピューターはファイルの一部をコンパイルし、その結果、合計ビルド時間が数回短縮されます。



最近、 PVS-Studioユーザーから、IncrediBuildサポートをソリューションに追加するようにというリクエストが寄せられました。 IncrediBuild開発チームに連絡し、支援を求めました。 IncrediBuildチームは喜んで対応し、PVS-StudioとIncrediBuildを共有する方法を共有する準備ができました。



現在（PVS-Studioバージョン5.25）、マシンにPVS-Studioをインストールしたユーザーには、IDEのメニューに「IncrediBuildを使用してPVS-Studioでプロジェクトをチェックする」オプションが表示されません。 PVS-Studioの次のバージョンでは、このようなメニュー項目が表示される可能性があります。 しかし、今では、IncrediBuildユーザーはPVS-Studioを使用するときにこのシステムの恩恵を受けることができます。 ほんの少しの魔法が必要です。 この記事では、どの呪文を唱えるかを説明しています。

PVS-Studioはどのように機能しますか？

PVS-StudioとIncrediBuildを統合したい人はどのような目標がありますか？ この最終的な目標は、ソースファイルの分析に必要な時間を短縮することであることは明らかだと思います。 実際に「PVS-Studioでのコードチェック」とは何か、それをIncrediBuildに「接続」する方法を見てみましょう。



IncrediBuildは、主に利用可能なコンピューティングリソース間、つまり開発者のコ​​ンピューター間でアセンブリタスクを分散することを目的としています。 PVS-Studio静的アナライザーを起動するときに、何を正確に配布する必要がありますか？



PVS-Studioは、PVS-Studio.exeコマンドラインユーティリティを使用して、ソースC / C ++ファイルの直接検証を実行します。 このユーティリティはアナライザのコアであり、その使用原理により、C ++コンパイラに非常に近いものです。 特に、PVS-Studio.exeを毎回実行して各ソースファイルをチェックし、このファイルのすべてのコンパイルパラメーターと追加のパラメーターをこのユーティリティに渡す必要があります。



ご注意 アナライザーは、最初にファイルを前処理する必要があるため、コンパイルパラメーターが必要です。 したがって、どのプリプロセッサディレクティブが宣言されているか、ヘッダーファイルを探す場所などを知っている必要があります。



PVS-Studio.exeは「手動」での使用を目的としていないことに注意してください。ソースファイルがあるディレクトリに単に「設定」することはできません。 この起動手順を自動化するために、Visual Studio開発環境に統合されるPVS-Studioプラグインが使用されます。 または、 PVS-Studio Standaloneシェルを使用できます。



もちろん、MSBuild以外のアセンブリシステムを使用する場合、PVS-Studio.exeの実行は他のアセンブリシステムに統合できますが、アナライザーユーザーがPVS-Studio.exeを直接使用しないという原則を取り消すわけではありません。



アナライザーの動作を最適化するには、PVS-Studio.exeプロセスを開始する段階で分析手順を配布する必要があることは、今では明らかだと思います。 この状況は、Incredibuildが通常のプロジェクトビルドで動作する方法に非常に似ています-コンパイラ（たとえば、cl.exe）とリンカーの開始を配布します。



この場合、IncrediBuildはローカルアセンブリシステムを「欺きます」。 MSBuild.exeは、「ローカル」にコンパイルおよびリンクプロセスを開始し、IncrediBuildは、これらのプロセスの実際の作業を、利用可能なコンピューティングノード（コンピューター）に直接配布します。



もちろん、IncrediBuildがコンピューティングノード間で分散できるプロセスに制限がないことは明らかです。 どのようにしてPVS-Studioを「だまし」ますか？ この場合、PVS-Studio.exeプロセスの開始に直接関与している人を「欺く」必要があります。



例として、ユーザーがMSBuildでビルドされたMicrosoft Visual Studioのプロジェクトを持っているという事実に注目しましょう。 次に、このプロジェクトを検証するために、彼はこのIDEにPVS-Studioプラグインを使用する可能性が高いでしょう。 IDEプラグインはIDE自体の一部であるため、「トリック」する必要があるプラグイン（devenv.exe）に名前を付けることができます。これは、Microsoft Visual Studioとまったく同じプロセスです。



また、PVS-Studioユーザーが静的アナライザーを使用し、定期的に「ビルドサーバー」で実行しているとします。 また、プロジェクトが十分に大きい（数千のソースファイル）と仮定します。そうしないと、ユーザーは検証を高速化する意味がありません。



これはすべて、ユーザーが「手動で」メニュー項目「ソリューションの確認」を選択してテストを開始しないことを意味します。 彼はその後何をしますか？

"C:\Program Files (x86)\Microsoft Visual Studio 12.0\Common7\IDE\devenv.exe" "D:\Test\OmniSample\OmniSample (vs2013).sln" /command "PVSStudio.CheckSolution Win32|Release|D:\Test\OmniSample\test.plog"
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

上記は、OmniSample（vs2013）.slnプロジェクト、Win32 |リリース構成のPVS-Studio分析起動ラインです。 分析が完了すると、devenv.exeプロセスは自動的に終了します。 検証ログはD：\ Test \ OmniSample \ test.plogに保存されます。 これは、コマンドラインからPVS-Studioを使用する「標準」の方法です。詳細については、 こちらをご覧ください。



繰り返しになりますが、これがPVS-Studioを使用する唯一の方法ではありませんが、わかりやすくするために、これについて詳しく説明します。



このコマンドを実行するとどうなりますか？ 前述のように、起動されたdevenv.exeプロセスは、ソースファイルごとに1つ、PVS-Studio.exeプロセスの並列実行を開始します。 いくつのパスワードプロセスが開始されるかは、アナライザーの設定に示されており、この設定は変更できます。 デフォルトでは、PVS-Studioはシステム内の論理コアと同じ数のプロセスを同時に開始します。

IncrediBuildはどのように役立ちますか？

1000ファイルのプロジェクトがあり、4つのコアを持つマシンで分析を実行するとします。 これは、devenv.exeアナライザーがプロジェクト全体を正常に検証するために250回の反復（各4プロセス）を行う必要があることを意味します。 IncrediBuildはどのように役立ちますか？



PVS-Studioユーザーにさらに3台のマシンがあり、それぞれで4つのプロセッサコアも使用できるとします。 PVS-Studio.exeの起動をこれらの4台のマシンに「分散」できれば、250の「反復」だけでなく、62.5だけで済みます（コアが16個あるため）。



別のコンピューターでアナライザースタートを配布するには、 IBConsoleコマンドラインユーティリティを使用します。

 ibconsole /command=incredi.bat /profile=incredi.xml
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

incredi.xmlファイルには次の内容が含まれている必要があります。

 <?xml version="1.0" encoding="UTF-8" standalone="no" ?> <Profile FormatVersion="1"> <Tools> <Tool Filename="devenv" AllowIntercept="true" /> <Tool Filename="PVS-Studio" AllowRemote="true" /> </Tools> </Profile>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ご覧のとおり、devenvのアクティビティを「傍受」し、PVS-Studioプロセスを「配布」することができます。 incredi.batファイルでは、前の記事で説明したdevenv.exeの起動行を指定する必要があります。 また、PVS-Studio設定で並列化レベルを4から16に変更することを忘れないでください。



IncrediBuildが4つのマシンにプリインストールされ、正しく構成されていると仮定します。 ibconsoleコマンドを実行すると、PVS-Studio.exeの起動がこれら4台のコンピューター間で分散され、合計分析時間が短縮されることがわかります。



同時に、このコマンドが実行されるマシンを除くすべてのマシンで、PVS-StudioとVisual Studioの両方、および検証済みのソースを保持する必要はありません。 IncrediBuildがこれを処理します。



分析時間はどれくらい短縮されますか？ 最初は4コアではなく16コアであるため、正確に4倍減少するように見えるかもしれません。実際、この数は4未満であり、多くの要因に依存します。 これらの要因には、コンピューターのパフォーマンス、他のタスクとのワークロード、ネットワーク帯域幅などが含まれます。 しかし、4未満になると確信できます。 いずれにせよ、「ボトルネック効果」が観察されます。 結局、分析のイニシエーター（devenv.exe）はPVS-Studio.exe起動の結果を処理する必要があります。 私たちの実験では、4台の車を使用すると、2.5〜3.5倍の加速が得られました。



ユーザーが「ソリューションの確認」項目を選択して分析を手動で開始したい場合は、devenv.exeの単純な呼び出しをそこに書き込むことでincredi.batファイルの内容を変更するだけです-Visual Studioウィンドウが開き、これらすべてのアクションを実行できます分散起動アナライザー。 もちろん、これは単にVisual Studioを開いて「check in IncrediBuild」メニュー項目を選択するほど便利ではなく、将来的にはそのような項目が実際にPVS-Studioメニューに表示される可能性があります。

おわりに

IncrediBuildとPVS-Studioは、現在のバージョンで既に一緒に使用できます。 何か問題がある場合は、必ずご連絡ください 。お手伝いさせていただきます。





この記事を英語を話す聴衆と共有したい場合は、翻訳リンクPaul Eremeevを使用してください。 PVS-StudioとIncrediBuild Distributed Build Systemの統合 。