Gimlet

Gimlet is a VSCode Extension for debugging Solana programs. It is a wrapper for the locally installed tools agave-ledger-tool and solana-lldb.

Table of Contents

• Prerequisites
• Setup
  • macOS
  • Windows (WSL)
  • Verify you are using Solana LLVM Tools
• Installation
• Usage
  • Running Agave Ledger Tool
  • Debugging a Solana Program
  • Additional LLDB Commands
• Example Project
• Troubleshooting
  • macOS Issues
  • Windows (WSL) Issues
  • solana-lldb platform tools Issues

Prerequisites

Before using Gimlet, ensure you have the following tools installed:

Setup

Choose the appropriate setup instructions for your operating system:

macOS

1. Configuring PATH Variables

Add the following lines to your .zshrc or .bashrc:

# Solana CLI path
export PATH="$HOME/.local/share/solana/install/active_release/bin:$PATH"

# Solana LLDB tools path
# Note: Choose only one of the two options based on your Solana installation structure.

# Option 1
export PATH="/$PATH:/Users/user/.local/share/solana/install/active_release/bin/sdk/sbf/dependencies/platform-tools/llvm/bin"

# Option 2
export PATH="$PATH:$HOME/.local/share/solana/install/active_release/bin/sdk/sbf

2. If solana-lldb is not found

Run this command inside a Solana Rust project:

cargo-build-sbf --force-tools-install

This will force the installation of missing Solana build tools required for debugging.

Windows (WSL)

1. Prerequisites

• Follow the Solana Guide for WSL
• Install LLDB: sudo apt install lldb

2. Configuring PATH Variables (IMPORTANT!)

Add the following lines to your .bashrc:

. "$HOME/.cargo/env"
export PATH="/usr/bin:$PATH"
export PATH="/usr/local/bin:$PATH"
export PATH="$HOME/.cargo/bin:$PATH"
export PATH="/root/.avm/bin:$PATH"
export PATH="/root/.local/share/solana/install/active_release/bin:$PATH"
export LLDB_DEBUGSERVER_PATH="/usr/bin/lldb-server"

# Solana LLDB tools path (choose the one matching your installation)
# Option 1
export PATH="/$PATH:/root/.local/share/solana/install/active_release/bin/sdk/sbf/dependencies/platform-tools/llvm/bin"

# Option 2
export PATH="/$PATH:/root/.local/share/solana/install/active_release/bin/sdk/sbf

Verify you are using Solana LLVM Tools

• To correctly debug sBPF Solana programs you must use the llvm-objdump and solana-lldb provided by Solana's Platform Tools - not your locally(system) installed version.

1. Make sure your PATH includes the Solana Platform Tools directory.

export PATH="$PATH:$HOME/.local/share/solana/install/active_release/bin/sdk/sbf/dependencies/platform-tools/llvm/bin"

2. Confirm that llvm-objdump is coming from that path:

which llvm-objdump

3. Confirm that solana-lldb is in PATH:

which solana-lldb

Installation

1. Install the extension from the VS Code Marketplace
2. Ensure you have all Prerequisites installed locally

Usage

Getting Started

1. Open VS Code inside your Solana project folder
2. Start your local ledger (see Running Agave Ledger Tool)
3. Use Ctrl+Shift+P (or Cmd+Shift+P on macOS) to run Gimlet: Check Dependecies - this will run a script to verify all dependencies
4. Use the command palette to run either Run Agave Ledger Tool or Run Solana LLDB

Running Agave Ledger Tool

Starting a Local Ledger

Before running any commands, you need to start a local ledger:

solana-test-validator --ledger ./ledger

Running the Tool

1. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P)
2. Select Run Agave Ledger Tool
3. Enter a valid subcommand when prompted (example: accounts)

The output will be displayed in the integrated terminal.

Note: Make sure you have a local ledger set up and running before executing commands.

Debugging a Solana Program

IMPORTANT for Native Solana Programs:
When debugging native Solana programs (not using Anchor), you must add the #[no_mangle] and #[inline(never)] attributes to each instruction function you want to debug.
This ensures the function names are preserved and not optimized away, making breakpoints and debugging possible.

Note: Gimlet: Check Dependencies in the Command Palette to verify all requirements.

!IMPORTANT: You must have JSON file to execute an instruction using agave-ledger-tool -> Input JSON Guide.

1. Start Local Ledger
   Run:

   solana-test-validator --ledger ./ledger
   

   (This launches the Agave ledger environment.)

2. Open Command Palette

   • Windows/Linux: Ctrl + Shift + P
   • macOS: Cmd + Shift + P

3. Launch Solana LLDB Debugging

   • In the Command Palette, select Run Solana LLDB.

4. Run Agave Ledger Tool for Breakpoints

   • In the Command Palette again, select Run Agave Ledger Tool for Breakpoint.
   • This will deploy and execute your instruction using the input.json file.

5. Monitor the Solana LLDB Terminal

   • Wait until agave-ledger-tool connects successfully.
   • Then focus on the Solana LLDB terminal.

6. Set Breakpoints

   • Once the setup is complete, set or remove breakpoints in your IDE as needed.

7. Continue Process

   • Run the continue command inside the solana-lldb terminal to start debugging with your breakpoints active.
   • Or use the Continue process from Command Palette both of them are the same

Important Notes

• Restarting: To debug another instruction, run the Agave Ledger Tool for Breakpoints command again with a new input.json for that specific instruction.

• Process Launching: After setting breakpoints, use continue to restart the program and stop at your breakpoints.

• Multiple Breakpoints: Gimlet will make you choose one of your set breakpoints because agave-ledger-tool can run only for one instruction at a time.

Continue process Command from Command Palette

This command resumes the currently paused breakpoint in the same terminal, allowing you to resume the debugging with your current breakpoint.

Tip: You can run the debugging command multiple times to restart the entire debugging session.

Additional LLDB Commands

For a comprehensive list of LLDB commands and their usage, refer to the official LLDB Commands Documentation.

Example Project

For detailed step-by-step instructions on how to run the example project, refer to the Installation and Run Guide.

Troubleshooting

macOS

If you encounter issues with the extension, verify that you have the following packages installed:

Required Packages

Common Issues and Solutions

PATH Configuration for LLVM

Add this to your .zshrc or .bashrc:

export PATH="/opt/homebrew/opt/llvm/bin:$PATH"

args-dumper Not Found Error

Add this to your .zshrc or .bashrc:

export LLDB_DEBUGSERVER_PATH="/Applications/Xcode.app/Contents/SharedFrameworks/LLDB.framework/Versions/A/Resources/debugserver"

Attach Failed (Not Allowed to Attach to Process)

1. Check Console Messages: Look in Console.app near the debugserver entries when the attach failed. The subsystem that denied permission will likely have logged an informative message.

2. Grant Developer Tools Access:

   • Go to System Preferences → Privacy & Security → Developer Tools
   • Grant access to Terminal

3. Disable Debugging Protection: On some machines, you may need to disable debugging protection. Refer to this Apple Developer Forum thread for detailed instructions.

Permission Denied When Trying to Debug a Program

Refer to the Apple Developer Forum thread for instructions on disabling debugging protection for macOS systems.

Windows (WSL)

Common Issues and Solutions

libpython 3.10.so.1.0 Not Found or Executable Not Found

Install Python 3.10 and development libraries:

sudo apt update
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt update
sudo apt install python3.10 python3.10-dev
python 3.10 --version

lldb-server Not Found Error

This issue occurs when the PATH for the LLDB server is not set correctly. Add this to your .bashrc:

export LLDB_DEBUGSERVER_PATH="/usr/bin/lldb-server"

Solana LLDB

Common Issues and Solutions

Still cannot find solana-lldb

Sometimes, even after following the documentation to set up your PATH, tools like solana-lldb may not appear immediately. The exact location of platform-tools can vary slightly between machines, so you might need to locate it manually.

Steps:

1. Locate the solana installation folder

The default location is usually:

$HOME/.local/solana/install/active_release/bin

2. Find the llvm/bin folder

platform-tools/llvm/bin

This directory contains solana-lldb, llvm-objdump, and other necessary tools.

3. Add the folder to your PATH You can temporarily add it with:

export PATH=$HOME/.local/solana/install/active_release/bin/platform-tools/llvm/bin:$PATH

4. Verify the installation

solana-lldb --version   

If it shows the version, your PATH is set correctly, and the debugger tools are ready to use.