問題タブ [source-server]

注：私のターゲットの懸念は、通常のMSILでCLRをターゲットにするC＃です。これは、それで機能するが、より一般的なケースでは機能しない場合です。

既存のソース デバッグ サポートの例

最近、ユーザーが pdb ファイル内のソース パスを別の場所を指すように書き換えることができるSourcepack プロジェクトがリリースされました。これは、アセンブリのソースがあり、それをビルドしたときとまったく同じファイルシステムの場所に取得したくない場合に非常に便利です。

http://lowleveldesign.wordpress.com/2011/08/26/sourcepack-released/

オープンソース プロジェクトの場合、プロジェクトのユーザーがシンボルとソースを簡単に取得できるようにする方法として、http://www.symbolsource.org/を使用することは優れたアイデアです。

問題

ただし、法律上または便宜上の理由から、このようなアプローチを使用することがあまり現実的でないプロジェクトが非常に多くあります。また、プロジェクトをデバッグしている可能性のある人々のセットは、比較的小さいか、含まれている可能性があります。

デフォルトでは、プロジェクトの pdb にはディスク (IIRC) 上のファイルへのポインターが含まれており、ソース インデックス作成により、ソース サーバーを使用して、ソースの場所 (たとえば、バージョン管理システム) へのポインターを埋め込む機能を追加できます。実際にソースをフェッチするためのポインター。

ゴール

実際のソースを pdb に入れるだけ (事実上、現在 PDB に書き込まれているポインターを逆参照するだけ) の方が簡単なようです (デバッグや内部専用などの特定のビルドの場合)。その場合、ソース サーバーの部分全体を (少なくとも理論的には) スキップして、デバッグ時のストーリーへの依存関係をいくつか排除できるようです。ソースを圧縮して保存するかどうかは、ほとんど直交していますが、既存のデバッガーの実装を簡単にするために、最初のパスではおそらくそうしません。

PDB マッチング バイナリ ストーリーはすでに非常に優れているため、ソースを PDB に配置することは、ソース サーバー ポインターよりも優れています。ポインターは時間の経過と共に破損する可能性があるためです (ソース管理システムの移動、別のシステムへの変更、またはしかし、PDB にある実際のソースは「永久に」有効です。

これは「ソース サーバー」サポートとどう違うのですか?

(これは、利点が何であるかを尋ねるTigranのコメントの後に編集によって追加されました)

これを比較する必要がある「ベースライン」シナリオは、現在「通常の」ソース サーバー インスタンスを使用した「通常の」デバッグ エクスペリエンスのシナリオです。そのシナリオでは、(AFAIK) デバッグ エンジンは PDB から (代替ストリームを介して) ポインターを取得し、登録されたソース サーバーを使用して、そのポインターを介してソースを取得しようとします。通常、特定のアセンブリには複数のソース ファイルが含まれるため、ベースの場所を含む単一のポインターが存在するか、PDB (またはその他のもの) に複数のポインターが存在するかのいずれかですが、それはこの議論とは直交するはずです。

ソースを非表示/アクセスできないようにしておくことが望ましいプロジェクト (Windows、Office、Visual Studio などを含むほとんどの Microsoft 製品) では、PDB にポインターを含めることは、実際のソースを含めるよりもはるかに優れています (たとえそれがあったとしても)。暗号化されています）。このようなポインタは、必要なネットワーク アクセスとアクセス許可がなければ意味がありません。したがって、このようなアプローチは、ソースにアクセスできるかどうかを心配することなく、地球上の誰にでも PDB を出荷できることを意味します (最悪の場合、ソースがどのようにアクセスされるかを垣間見ることができます)。木が配置されていると思います）。

ただし、この「ソースを非表示にする」利点が存在しない 2 つの大規模なプロジェクト (具体的にはビルド) があります。

1 つ目は、とにかくソースにアクセスできる人だけが使用するビルドです。自分のマシンで実行され、そのマシンから離れることのないビルドは良い例です。攻撃者はソースを取得するためにファイルシステムからファイルを読み取る必要があるため、1 つのファイル (.cs) と別のファイル (.cs) から読み取る必要があります。 pdb) は、攻撃の難易度/ベクトルの点で比較的小さな違いです。同様に、マシン上の pdb にアクセスする人々がソースに「通常」アクセスできる人々と等しいか、そのサブセットであるテスト/ステージング環境に実行されてプッシュされるビルド。

2 つ目は (やや明らかに) オープンソース プロジェクトであり、プロジェクトのソースはすでに誰にでも公開されているため、ソースを隠しても何のメリットもありません。

これは、代わりに暗号化された形式でソースを含めるように比較的簡単に拡張できることに注意してください (フォーマット/エンコーディングデータも保存する必要があることについては既に話しているため)。 「通常の」ソースサーバーを使用するだけではありません。

利点？

上記の説明が邪魔にならないので、これを許可することの潜在的な利点のリストには、現時点で私の頭に浮かぶものが含まれます (ただし、これらに限定されません:):

• ソース サーバー サポートの設定に対処する必要はありません。It Just Works (IJW)、少なくともデバッガーが pdb を調べることを知っていた場合。
  • それまでの間、ソースを抽出して呼び出し元にフィードバックする単なるダミーである「固定」ソース サーバーを実行することもできます。このような構成は、(たとえば、localhost を使用して) 誰にとっても同じである可能性があり、ソース サーバーを実際に構成する現在の必要性を排除します。
• ビルドに「ソースのインデックス作成」を含める必要はありません
  • とにかくビルドはソース ファイルを読み取り、pdb ファイルを書き込むため、pdb に書き込まれた内容を変更するだけであり、ネットワーク呼び出しを実行したり、まだメモリにないデータを読み取ったりするためのビルド時のパフォーマンス ヒットはありません。
  • ソースを入れるための「ネイティブ」ビルドのサポートまでは、単純なビルド後のステップである可能性があります.PDBファイルの読み取り/変更の作業をすでに行っているため、Sourcepackプロジェクトの小さなフォークを介して最初に実装される可能性があります:)
• ソース管理システムを持つチーム/プロジェクトに依存しない
• ソース管理システムにチェックインされる各ファイルの特定のバージョンに依存しない (ほとんどの人は、IDE で実行するすべてのビルドをチェックインするわけではありません)
• ファイルがある特定のソース管理システムにアクセスする必要はありません
  • たとえば、DVCS の場合、PDB ポインターは git や mercurial などの「ランダムな」インスタンスを指している可能性があり、必ずしもアクセスできるインスタンスである必要はありません。
  • そのバージョンを追跡して、アクセスできるソース管理サーバー インスタンス (そこに存在する場合でも) までさかのぼるソース サーバー ツールは、AFAIK ではまだ存在しません)。
• プロジェクトが死んだ（削除された）または移動しても問題ありません
  • たとえば、プロジェクトがセルフホステッド、sourceforge、github、bitbucket、codeplex、code.google.com などの別のプロジェクトに移動した場合などです。
• デバッグしているマシンにネットワーク アクセスがない (または不十分な) 場合は問題ありません
  • たとえば、問題をデバッグするために「ネットワーク KVM」をボックスに実行しているが、ネットワークがないか、切断されたネットワークとしか通信できないため、ソース コントロール サーバーにアクセスできない場合)。
• 極端な場合、ビルドからプロジェクト ソースの一部を復元する機能。;)

注: 別のアプローチとして、実際のアセンブリにソースを含めることもできますが (たとえば、リソースとして)、pdb の方が適しています (pdb なしでビルドを出荷するのは簡単で、ソースが pdb にある場合は通常の実行時のパフォーマンス ヒットはありません)。アセンブリは同じコードで同じサイズなどであるため）

実装方法は？

表面的には、この種のサポートを追加するのはそれほど難しくないように見えますが、実際には単純なことではなく、関連するメカニズムについて十分に知らないためだと感じています.実装する。:)

私の推測では、次のようなものになります。

1. Sourcepack と同様の処理を行うビルド後のステップを追加しますが、ポインターを変更する代わりに、実際のソースに置き換えます。
   • ソースサーバーが何をする必要があるかによって、プレフィックスを付ける必要があるか、実際のソースが別の代替データストリームにあり、「ポインター」が「source-in-pdb:ads-foo.cs」に更新されます。 」または何でも。接頭辞またはポインタには、ソースファイルの保存方法も含めることができます（ファイルのエンコードとともに、非圧縮、gzip、bzip2など）
2. 問題の pdb からソースを実際に抽出して返す「ソース サーバー」を実装します。
   • ソースサーバーの「API」がPDBの場所を取得するのに十分な情報を持っているかどうか、ましてやコンテンツを実際に読み取る権限があるかどうかはわかりません。

サニティーチェック？

上記のせせらぎが邪魔にならないので、質問は実際には次のとおりです。

• このようなものはすでに存在しますか？（もしそうなら、ポインタを提供してください！）
• まだ存在しないと仮定すると、上記は最初のパスの実装として意味がありますか? 上記がスキップする落とし穴や複雑さはありますか?
• 上記について「いいえ」と「はい」と仮定すると、これを引き受けるという点で意味のある既存のプロジェクトはありますか (それは近いか、既存の範囲内にあります)?

ビルドサーバー（TeamCity）でGitと一緒にソースインデックスを使用し始めようとしています。

このプロジェクトをダウンロードします：SourceServer-GitExtensions

それを実行している間、私は警告/エラーに気づきました。スクリプト（PERLベース）を掘り下げてみると、スクリプトがこの関数を実行していることに気づきました。

これは、リポジトリのID（私が想定する最初のコミットのID）を取得しようとして実行されます。

問題は、現在マスターブランチを使用していないことです。

私の質問は-これは「リポジトリID」を取得するための適切で堅牢な方法ですか？マスターではなく、「チェックアウトされている現在のブランチ」を取得するために他の何かを実行できますか？

git を使用して Microsoft Symbol Server をセットアップしようとしています。あちこち探して、これを見つけました

https://github.com/joliver/SourceServer-GitExtensions

私は指示のすべてのステップに従いました。

デバッグしようとすると、Visual Studio からポップアップ ウィンドウが表示されました

そして、私はこのエラーが発生したコマンドを実行しました

何がうまくいかなかったのかわからない。それは私が複数のブランチを持っているためですか、そこにフェッチしたい特定のブランチを指定する必要がありますか?

これは、インデックスを生成するために使用したコマンドです

これらのコマンドを pdb (SymbolServerTests.pdb) ファイルに対して実行しようとしました

Srctool.exe SymbolServerTests.pdb

pdbstr -r -p:SymbolServerTests.pdb -s:srcsrv

更新:私はいくつかの改善を得たと思います。この場所にファイルをチェックアウトしました。

C:\Users\myusername\AppData\Local\SOURCE~1\bfef70fcb1efef501a09d451517a24f049383e28\04898e9268d374a9a503e4c138b27f01b7553a3e\codetest.cs

しかし、私は得ました

Determining whether the checksum matches for the following locations: 1: C:\Users\myusername\AppData\Local\SOURCE~1\bfef70fcb1efef501a09d451517a24f049383e82\26348c09499b843558a4cc676c0d17a83327d56e\codetest.cs Checksum: MD5 {60 d6 36 20 c3 af c8 31 eb 32 50 3f 27 6b 2f d8}チェックサムが一致しません。

pdb のチェックサムはどこで計算されますか?

ソース サーバー情報を含む PDB ファイルのインデックスを作成しました。pdbstr ユーティリティは、次の srcsrv ストリームをダンプします。

ご覧のとおり、これはデバッガーに Mercurial サーバーへの HTTP ゲートウェイを使用するように指示します。この PDB ファイルを WinDbg で使用すると、デバッガーは、repository-srv にアクセスするための基本的な HTTP 資格情報を要求し、ソース ファイルを正常に表示します。(同じ URL は、ブラウザ ウィンドウや、curl などのコマンド ライン ツールでも機能します。)

ただし、この PDB ファイルを Visual Studio 2012 で使用する (および [ツール] > [オプション] > [デバッグ] でソース サーバーのサポートを有効にしている) 場合、デバッガーはソース サーバーからのファイルを解決せず、ディスク上のファイルを指定するように求め、出力ウィンドウに次のエラーが表示されます。

追加のエラー情報がないため、これをさらに診断する方法がわかりません。より詳細なエラー情報を取得するために他にできることはありますか、それとも別の方法をとるべきですか?