# バッチ設計書 60-Index-Pdbs

## 概要

本ドキュメントは、PDBファイルにソースインデックスを付与するPowerShellスクリプト「Index-Pdbs.ps1」のバッチ設計書である。

### 本バッチの処理概要

本バッチは、ビルドで生成されたPDB（Program Database）ファイルにソースサーバーインデックス情報を埋め込む。pdbstr.exeとsrctool.exeを使用して、各PDBファイル内のソースファイルパスをGitHubのraw.githubusercontent.comのURLにマッピングし、デバッガーがソースコードを自動的にダウンロードできるようにする。

**業務上の目的・背景**：Windows Terminalのデバッグ時に、デバッガー（Visual Studio等）がPDBからソースコードの場所を特定し、GitHubリポジトリから自動的にソースをダウンロードできるようにする必要がある。本バッチはSRCSRV（Source Server）プロトコルに基づくインデックス情報をPDBに埋め込むことで、シンボルサーバー経由のソースレベルデバッグを可能にする。

**バッチの実行タイミング**：CI/CDパイプライン内でビルド完了後、シンボルパッケージ作成前に実行される。

**主要な処理内容**：
1. packages.configからPdbStrとSrcToolのバージョンを取得
2. git ls-filesでリポジトリ内の全ファイル一覧を取得（大文字小文字の正規化用）
3. 指定ディレクトリのPDBファイルを検索
4. 各PDBに対してsrctool.exeでソースファイル一覧を抽出
5. ソースファイルパスをリポジトリ相対パスに変換
6. git ls-filesの結果と照合して正しい大文字小文字を取得
7. SRCSRVストリーム（ソースサーバー情報）を構築
8. pdbstr.exeでSRCSRVストリームをPDBに書き込み
9. 結果を検証出力

**前後の処理との関連**：ビルド完了後に実行される。インデックス済みPDBはシンボルサーバーにアップロードされる。

**影響範囲**：指定ディレクトリ内のPDBファイルにSRCSRVストリームが書き込まれる。

## バッチ種別

CI/CD（シンボルインデックス処理）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | CI/CDパイプライン実行時 |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | CI/CDパイプライン |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| PDBファイル | SearchDir配下にPDBファイルが存在すること |
| packages.config | SourceRoot/build/packages.config にPdbStr/SrcToolパッケージのバージョンが記載されていること |
| NuGetパッケージ | Microsoft.Debugging.Tools.PdbStr / SrcTool パッケージが復元されていること |
| Gitリポジトリ | git ls-filesが実行可能であること |

### 実行可否判定

SearchDir配下にPDBファイルが存在し、srctool.exeで2行以上のソースファイル情報が取得できるPDBを対象とする。ソースファイル情報が不足するPDBはスキップされる。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| SearchDir | string | Yes | - | PDBファイルの検索ディレクトリ |
| SourceRoot | string | Yes | - | ソースコードのルートディレクトリ |
| CommitId | string | Yes | - | GitコミットSHA |
| Organization | string | No | "microsoft" | GitHubオーガニゼーション名 |
| Repo | string | No | "terminal" | GitHubリポジトリ名 |
| recursive | switch | No | - | サブディレクトリも再帰的に検索するか |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| {SearchDir}/*.pdb | PDB | デバッグシンボルファイル |
| build/packages.config | XML | NuGetパッケージバージョン定義 |
| git ls-files | テキスト | リポジトリ内ファイル一覧 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| {SearchDir}/*.pdb | PDB（更新） | SRCSRVストリームが埋め込まれたPDB |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| 対象ファイル | PDBファイル（in-place更新） |
| 埋め込み情報 | SRCSRVストリーム（HTTP Source Server v2） |
| ソースURL形式 | https://raw.githubusercontent.com/{Organization}/{Repo}/{CommitId}/{相対パス} |

## 処理フロー

### 処理シーケンス

```
1. ツールパスの解決
   └─ packages.configからPdbStr/SrcToolのバージョンを取得し、exeパスを構築
2. ファイルテーブルの構築
   └─ git ls-files の結果をハッシュテーブルに格納（大文字小文字の正規化用）
3. PDBファイルの検索
   └─ Get-ChildItem で {SearchDir}/*.pdb を検索（-recursiveオプション対応）
4. 各PDBの処理
   ├─ srctool.exe でPDB内のソースファイル一覧を抽出
   ├─ ソースファイル数が2行未満の場合はスキップ
   ├─ SourceRootからの相対パスに変換
   ├─ バックスラッシュをスラッシュに変換
   ├─ git ls-filesの結果と照合して正しいケースを取得
   └─ リポジトリ内のファイルのみをマッピングリストに追加
5. SRCSRVストリームの構築
   └─ SRCSRV ini/variables/source files/end セクションを生成
6. pdbstr.exeで書き込み
   └─ -w -s:srcsrv オプションでSRCSRVストリームをPDBに埋め込み
7. 検証出力
   └─ pdbstr.exe -r で読み出し確認、srctool.exe で最終確認
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[packages.configからツールバージョン取得]
    B --> C[git ls-filesでファイルテーブル構築]
    C --> D[PDBファイルを検索]
    D --> E{次のPDBあり?}
    E -->|あり| F[srctool.exeでソースファイル一覧抽出]
    F --> G{ソースファイル2行以上?}
    G -->|No| E
    G -->|Yes| H[相対パスに変換・ケース正規化]
    H --> I[マッピングリスト構築]
    I --> J[SRCSRVストリーム生成]
    J --> K[pdbstr.exe -w で書き込み]
    K --> L[pdbstr.exe -r で検証]
    L --> M[srctool.exe で検証]
    M --> E
    E -->|なし| N[Exit 0]
```

## データベース操作仕様

### 操作別データベース影響一覧

本バッチはデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | ツール未発見 | PdbStr/SrcToolのNuGetパッケージが復元されていない | NuGet restoreを実行 |
| N/A | srctoolエラー | PDBファイルが破損している | ビルドを再実行 |
| N/A | pdbstrエラー | PDBへの書き込みに失敗 | ファイルロック・パーミッションを確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

ErrorActionPreferenceを"Continue"に設定しているため、個々のPDBでエラーが発生しても処理は継続される。最終的にExit 0で正常終了する。

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | PDBファイル単位 |
| コミットタイミング | pdbstr.exe書き込み完了時 |
| ロールバック条件 | なし（in-place更新） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数十PDBファイル |
| 目標処理時間 | 数分以内 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

PDBファイルのin-place更新を行うため、同一PDBに対する同時アクセスは不可。CI/CDパイプライン内で逐次実行される。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| Verbose | PDB検出時 | "Found {PDBパス}" |
| Verbose | マッピング時 | "Mapped path {インデックス}: {マッピング}" |
| Verbose | SRCSRVファイルパス | "pdbstr.txt = {パス}" |
| 情報ログ | SRCSRVストリーム内容 | pdbstr.txtの内容を標準出力 |
| 情報ログ | pdbstr.exe実行 | pdbstr.exe のコマンドラインと結果 |
| 情報ログ | srctool.exe検証 | srctool.exe のコマンドラインと結果 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 特になし | N/A | N/A |

## 備考

- SRCSRVプロトコルv2を使用しており、HTTP経由でソースを取得するSource Serverの仕組みに基づく
- HTTP_ALIASは https://raw.githubusercontent.com/{Organization}/{Repo}/{CommitId}/ の形式
- SRC_INDEX=public を設定しており、パブリックなソースインデックスであることを示す
- git ls-filesの結果をハッシュテーブルで管理し、大文字小文字のケース正規化を行う（GitのURLはケースセンシティブ）
- Azure PipelinesのErrorActionPreference="Stop"を"Continue"にオーバーライドしている
- PdbStrとSrcToolは同じバージョンで更新される前提（packages.configのPdbStrバージョンをSrcToolにも適用）
- $env:TEMP にpdbstr.txtを一時ファイルとして出力し、pdbstr.exeの入力として使用
- Exit 0で明示的に正常終了し、ツールのエラーコードを上書きする
