swift-inspect

swift-inspect is a debugging tool which allows you to inspect a live Swift process to gain insight into the runtime interactions of the application.

swift-inspect uses the reflection APIs to introspect the live process. It relies on the swift remote mirror library to remotely reconstruct data types.

Building

swift-inspect can be built using swift-package-manager.

Windows

In order to build on Windows, some additional parameters must be passed to the build tool to locate the necessary libraries.

swift build -Xcc -I%SDKROOT%\usr\include\swift\SwiftRemoteMirror -Xlinker %SDKROOT%\usr\lib\swift\windows\x86_64\swiftRemoteMirror.lib

Linux

In order to build on Linux, some additional parameters must be passed to the build tool to locate the necessary includes and libraries.

swift build -Xswiftc -I$(git rev-parse --show-toplevel)/include/swift/SwiftRemoteMirror -Xlinker -lswiftRemoteMirror

CMake

In order to build on Windows with CMake, some additional parameters must be passed to the build tool to locate the necessary Swift modules.

cmake -B out -G Ninja -S . -D ArgumentParser_DIR=... -D CMAKE_Swift_FLAGS="-Xcc -I%SDKROOT%\usr\include\swift\SwiftRemoteMirror"

In order to build on Linux with CMake, some additional parameters must be passed to the build tool to locate the necessary Swift modules.

cmake -B out -G Ninja -S . -D ArgumentParser_DIR=... -D CMAKE_Swift_FLAGS="-Xcc -I$(git rev-parse --show-toplevel)/include/swift/SwiftRemoteMirror"

Building with CMake requires a local copy of swift-argument-parser built with CMake. The ArumentParser_DIR= definition must refer to the cmake/modules sub-directory of the swift-argument-parser build output directory.

Using

The following inspection operations are available currently.

All Platforms

dump-cache-nodes <name-or-pid> : Print the metadata cache nodes.

dump-conformance-cache <name-or-pid> : Print the content of the protocol conformance cache.

dump-generic-metadata <name-or-pid> [--backtrace] [--backtrace-long] : Print generic metadata allocations.

dump-raw-metadata <name-or-pid> [--backtrace] [--backtrace-long] : Print metadata allocations.

Darwin and Windows Only

dump-arrays <name-or-pid> : Print information about array objects in the target

Darwin Only

dump-concurrency <name-or-pid> : Print information about tasks, actors, and threads under Concurrency.