Implement index-dump executable to dump unit and record files - #264 #266

DPrakashhh · 2025-12-23T06:44:34Z

Trying new PR style.
Status: ✅ Ready for Review

Explanation:
Implements a new executable index-dump that allows dumping Unit and Record files from the Index Store using the IndexStore Swift library. This serves as a native Swift replacement for c-index-test (from LLVM), making it significantly easier to debug and inspect Index Store contents (modules, dependencies, symbols, occurrences) without needing to build the full LLVM project.

Scope:
This is Additive. It introduces a new executable target index-dump in Package.swift and does not modify existing IndexStoreDB logic.

Issues:
Fixes: Implement an executable to dump unit and record files #264

Risk:
Low/None. This is a standalone developer tool. It has no impact on the production runtime or the library itself.

Testing:
Verified manually by building the tool and running it against a local .build index store.

Verified unit mode:
1- Correctly lists Module, Main File, and Dependencies.
2- Verified record mode: Correctly lists Symbols and Occurrences.

(Please see attached screenshot for verification)

Reviewers: Suggested by @ahoppen . Open to review by anyone.

ahoppen

Nice. Left a few general comments inline.

Sources/index-dump/main.swift

Package.swift

DPrakashhh · 2025-12-23T08:59:04Z

Nice. Left a few general comments inline.

Thanks for the review! On it :)

DPrakashhh · 2025-12-23T09:51:37Z

I have updated the implementation to address all feedback:

1- CLI Infrastructure: Migrated to swift-argument-parser for a more robust command-line interface and auto-generated help pages.
2- Mode Inference: Added logic to automatically detect if a file is a unit or record based on its directory path (checking for /units/ or /records/), while still allowing for a manual --mode override.
3- Output Refinement: Refactored the dumping logic to accumulate output into a string buffer, ensuring a single print call at the end of the operation.
4- Swift 6 Adoption: Enabled Swift 6 language mode and the requested upcoming feature flags in Package.swift.
5- API Fixes: Corrected the closure return types for the IndexStore iterators to return .continue.

Verified the build and functionality locally. Ready for another look!

Package.swift

Sources/index-dump/main.swift

DPrakashhh · 2026-01-03T12:09:33Z

On it sir :)

DPrakashhh · 2026-01-03T14:52:46Z

I have updated the branch to address all your feedback. Here are the key changes:

Package.swift updates:
1- Restored Metadata: Restored the unintentionally removed comments and ensured a trailing newline.
2- Swift 6 Mode: Enabled Swift 6 language mode and upcoming features (omitting Lifetimes as suggested).
3- Local Dependencies: Updated the local dependency path for swift-argument-parser to use the relative parent directory.

main.swift updates:
1-Refactored Architecture: Factored out dumping into separate functions and switched to an exhaustive switch for mode handling.
2-Path Safety: Used pathComponents for mode and store inference to ensure full compatibility with Windows path separators.
3-Automatic Inference: Added logic to automatically infer the libIndexStore path from the toolchain and the store path from the file's location.
4-Exhaustive Output: Expanded the dump to include all properties for Units and Records, including system/module flags and correct occurrence positions.

All 45 tests are passing. Ready for another look!

ahoppen

A couple more comments inline.

Package.swift

Sources/index-dump/main.swift

DPrakashhh · 2026-01-04T02:35:45Z

I have an exam in 2 days, so I will be back on January 7th to address the remaining feedback. Thank you so much for your patience and guidance!

DPrakashhh · 2026-01-07T18:25:25Z

I have made changes based on the review you have gave to me
Please check :)
Sorry for addressing this 4 days later.

ahoppen

Left a few more comments inline. I think we’re getting a lot closer 👍🏽

Sources/index-dump/main.swift

Sources/IndexStore/IndexStoreDescription.swift

Tests/IndexStoreTests/IndexStoreTests.swift

ahoppen · 2026-01-07T20:19:39Z

Sources/index-dump/main.swift

+    var nameOrPath: String
+
+    @Option(help: "Path to libIndexStore. Inferred if omitted.")
+    var libPath: String?


Let’s explicitly name this argument --lib-index-store

This is still unresolved. To clarify, I mean setting name: .customLong("lib-index-store") in the @Option.

ahoppen · 2026-01-07T20:19:55Z

Sources/index-dump/main.swift

+    @Option(help: "Path to libIndexStore. Inferred if omitted.")
+    var libPath: String?
+
+    @Option(help: "Path to the index store directory. Inferred if omitted.")


Let’s explicitly name this variable --index-store

Same here, still unresolved.

DPrakashhh · 2026-01-08T09:31:02Z

On it :)

ahoppen

A few more comments inline. Also, there’s a merge conflict now. Could you resolve this by rebasing your changes on top of the latest main and then also running swift-format -ipr . again?

Sources/index-dump/LibIndexStoreProvider.swift

Sources/index-dump/main.swift

Sources/IndexStore/IndexStoreDescription.swift

Tests/IndexStoreTests/IndexStoreTests.swift

DPrakashhh · 2026-01-09T16:27:55Z

On it boss:)

DPrakashhh · 2026-01-09T16:59:10Z

A few more comments inline. Also, there’s a merge conflict now. Could you resolve this by rebasing your changes on top of the latest main and then also running swift-format -ipr . again?

I think i have done something wrong , i have done rebasing but after running swift-format -ipr this happened ? Sorry for disturbing but i think i messed up - I am asking this to be sure :(

ahoppen · 2026-01-09T17:21:17Z

Hmm, I cannot tell if that’s correct or not. Do you want to push your changes so I can check? We can always revert to a previous commit hash.

DPrakashhh · 2026-01-09T17:48:30Z

Hmm, I cannot tell if that’s correct or not. Do you want to push your changes so I can check? We can always revert to a previous commit hash.

yes , please check !

ahoppen · 2026-01-09T21:40:12Z

OK, that does indeed look messed up. The problem is that you didn’t properly rebase the changes on top of main, I think. Here’s the steps I’d take to clean it up

# Remove your formatting commit
git reset --hard HEAD^
# Add remote to the upstream repo in swiftlang if you don’t have it yet
git remote add swiftlang https://github.com/swiftlang/indexstore-db.git
git fetch swiftlang
# Rebase changes on top of swiftlang/indexstore-db’s main branch
git rebase swiftlang/main
# Resolve merge conflicts and finish the rebase
# Run swift-format
swift format -ipr .
# Only commit the changes to the files you have touch, importantly don’t modify files in `INPUTS` or the generated test files.
# Force push your changes
git push -f

…wiftlang#264)

DPrakashhh · 2026-01-10T04:04:25Z

Thank you so much sir

OK, that does indeed look messed up. The problem is that you didn’t properly rebase the changes on top of main, I think. Here’s the steps I’d take to clean it up

# Remove your formatting commit
git reset --hard HEAD^
# Add remote to the upstream repo in swiftlang if you don’t have it yet
git remote add swiftlang https://github.com/swiftlang/indexstore-db.git
git fetch swiftlang
# Rebase changes on top of swiftlang/indexstore-db’s main branch
git rebase swiftlang/main
# Resolve merge conflicts and finish the rebase
# Run swift-format
swift format -ipr .
# Only commit the changes to the files you have touch, importantly don’t modify files in `INPUTS` or the generated test files.
# Force push your changes
git push -f

Huge thanks for the git help! The PR is now clean and rebased. I'm very happy to have this back on track! 😊
Now working on the review :)

ahoppen

This PR doesn’t build, nor does it pass the tests you added. Could you please ensure that it compiles and passes the tests before putting this up for review again?

ahoppen · 2026-01-11T08:49:46Z

Sources/IndexStore/IndexStoreDescription.swift

+          """
+          \(occurrence.position.line):\(occurrence.position.column) \
+          | \(occurrence.symbol.kind) \
+          | USR: \(occurrence.symbol.usr.string) \


For anyone working on this, it’ll be obvious that this is a USR (kind of lesson number 1 you need to learn), so I’d omit that.

Suggested change

| USR: \(occurrence.symbol.usr.string) \

| \(occurrence.symbol.usr.string) \

ahoppen · 2026-01-11T08:49:52Z

Sources/IndexStore/IndexStoreDescription.swift

+extension IndexStoreRecord: CustomStringConvertible {
+  public var description: String {
+    let symbolLines = symbols.map { symbol in
+      "\(symbol.kind) | \(symbol.name.string) | USR: \(symbol.usr.string)"


Suggested change

"\(symbol.kind) | \(symbol.name.string) | USR: \(symbol.usr.string)"

"\(symbol.kind) | \(symbol.name.string) | \(symbol.usr.string)"

ahoppen · 2026-01-11T08:50:42Z

Sources/IndexStore/IndexStoreDescription.swift

+    var result = """
+      Module: \(moduleName.string)
+      Has Main File: \(hasMainFile)
+      Main File: \(mainFile.string)
+      Output File: \(outputFile.string)
+      Target: \(target.string)
+      Sysroot: \(sysrootPath.string)
+      Working Directory: \(workingDirectory.string)
+      Is System: \(isSystemUnit)
+      Is Module: \(isModuleUnit)
+      Is Debug: \(isDebugCompilation)
+      Provider Identifier: \(providerIdentifier.string)
+      Provider Version: \(providerVersion.string)
+      Mod Date: \(modificationDate)
+
+      DEPENDENCIES START
+      \(dependencies.map { dep in
+        "\(String(describing: dep.kind).capitalized) | \(dep.name.string)"
+      }.joined(separator: "\n"))
+      DEPENDENCIES END
+      """


Suggested change

var result = """

Module: \(moduleName.string)

Has Main File: \(hasMainFile)

Main File: \(mainFile.string)

Output File: \(outputFile.string)

Target: \(target.string)

Sysroot: \(sysrootPath.string)

Working Directory: \(workingDirectory.string)

Is System: \(isSystemUnit)

Is Module: \(isModuleUnit)

Is Debug: \(isDebugCompilation)

Provider Identifier: \(providerIdentifier.string)

Provider Version: \(providerVersion.string)

Mod Date: \(modificationDate)

DEPENDENCIES START

\(dependencies.map { dep in

"\(String(describing: dep.kind).capitalized) | \(dep.name.string)"

}.joined(separator: "\n"))

DEPENDENCIES END

"""

let dependenciesLines = dependencies.map { dep in

"\(String(describing: dep.kind).capitalized) | \(dep.name.string)"

}.joined(separator: "\n")

return """

Module: \(moduleName.string)

Has Main File: \(hasMainFile)

Main File: \(mainFile.string)

Output File: \(outputFile.string)

Target: \(target.string)

Sysroot: \(sysrootPath.string)

Working Directory: \(workingDirectory.string)

Is System: \(isSystemUnit)

Is Module: \(isModuleUnit)

Is Debug: \(isDebugCompilation)

Provider Identifier: \(providerIdentifier.string)

Provider Version: \(providerVersion.string)

Mod Date: \(modificationDate)

DEPENDENCIES START

\()

DEPENDENCIES END

"""

ahoppen · 2026-01-11T08:51:15Z

Tests/IndexStoreTests/IndexStoreTests.swift

+      """
+    ])
+    try await project.withIndexStore { indexStore in
+      let unitName = try #require(indexStore.unitNames(sorted: false).map { $0.string }.only)


Suggested change

let unitName = try #require(indexStore.unitNames(sorted: false).map { $0.string }.only)

let unitName = try #require(indexStore.unitNames(sorted: false).map(\.string).only)

DPrakashhh requested review from ahoppen, hamishknight and rintaro as code owners December 23, 2025 06:44

DPrakashhh mentioned this pull request Dec 23, 2025

Implement an executable to dump unit and record files #264

Open

ahoppen reviewed Dec 23, 2025

View reviewed changes

Sources/index-dump/main.swift Outdated Show resolved Hide resolved

Sources/index-dump/main.swift Outdated Show resolved Hide resolved

Sources/index-dump/main.swift Outdated Show resolved Hide resolved

Package.swift Outdated Show resolved Hide resolved

DPrakashhh force-pushed the feature/index-store-dumper branch 2 times, most recently from 790786c to e4a8f81 Compare December 23, 2025 09:49

DPrakashhh requested a review from ahoppen December 23, 2025 09:51

ahoppen reviewed Jan 3, 2026

View reviewed changes

DPrakashhh force-pushed the feature/index-store-dumper branch from b729de4 to 590e4cd Compare January 3, 2026 14:08

DPrakashhh requested a review from ahoppen January 3, 2026 14:54

ahoppen reviewed Jan 3, 2026

View reviewed changes

ahoppen reviewed Jan 7, 2026

View reviewed changes

DPrakashhh force-pushed the feature/index-store-dumper branch from ceaa80f to 032d295 Compare January 9, 2026 15:36

DPrakashhh requested a review from ahoppen January 9, 2026 15:49

ahoppen reviewed Jan 9, 2026

View reviewed changes

Divya Prakash added 2 commits January 10, 2026 09:20

Implement index-dump executable to dump unit and record files (Fixes s…

48a1168

…wiftlang#264)

Refactor index-dump based on review

231314c

DPrakashhh added 4 commits January 10, 2026 09:25

Fixes based on the review

8567317

made changes based on the review

eb2baf7

more changes

f981265

Apply swift-format

d4aa158

DPrakashhh force-pushed the feature/index-store-dumper branch from 0c18ea9 to d4aa158 Compare January 10, 2026 03:57

Few more changes

7e18248

DPrakashhh force-pushed the feature/index-store-dumper branch from 79e7080 to 7e18248 Compare January 10, 2026 04:56

DPrakashhh requested a review from ahoppen January 10, 2026 05:05

ahoppen reviewed Jan 11, 2026

View reviewed changes

	\| USR: \(occurrence.symbol.usr.string) \
	\| \(occurrence.symbol.usr.string) \

	"\(symbol.kind) \| \(symbol.name.string) \| USR: \(symbol.usr.string)"
	"\(symbol.kind) \| \(symbol.name.string) \| \(symbol.usr.string)"

	let unitName = try #require(indexStore.unitNames(sorted: false).map { $0.string }.only)
	let unitName = try #require(indexStore.unitNames(sorted: false).map(\.string).only)

Implement index-dump executable to dump unit and record files - #264 #266

Are you sure you want to change the base?

Implement index-dump executable to dump unit and record files - #264 #266

Conversation

DPrakashhh commented Dec 23, 2025

Uh oh!

ahoppen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DPrakashhh commented Dec 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DPrakashhh commented Dec 23, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DPrakashhh commented Jan 3, 2026

Uh oh!

DPrakashhh commented Jan 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ahoppen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DPrakashhh commented Jan 4, 2026

Uh oh!

DPrakashhh commented Jan 7, 2026

Uh oh!

ahoppen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ahoppen Jan 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DPrakashhh commented Jan 8, 2026

Uh oh!

ahoppen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DPrakashhh commented Dec 23, 2025 •

edited

Loading

DPrakashhh commented Jan 3, 2026 •

edited

Loading

ahoppen Jan 11, 2026 •

edited

Loading

DPrakashhh commented Jan 9, 2026 •

edited

Loading

DPrakashhh commented Jan 10, 2026 •

edited

Loading