Introduction

This extension allows you to register a number of test machines (as name/address pairs) and nominate one as a debug target. The machine name and address can be accessed with the commands/variables from your launch.json and tasks.json

It also provides facilities to aid in using rsync in the debug configuration, launch.json

Getting Started

Open the VS Code settings, and select Extensions and then Datapath Debug Tools Add your test machine(s) as name and address pairs.

To nominate a machine as the debug target, select the navigation bar and type > Set the debug target and then use the quick select menu.

The following commands are available to use in your launch.json and tasks.json:

${commands:datapath.debugTargetName} - gets the debug target machine name

${commands:datapath.debugTargetAddress} - gets the debug target machine address

${commands:datapath.debugPort} - gets the port for the debug session

${commands:datapath.userName} - gets the username

${commands:datapath.builtDirectory} - gets the binaries built directory

${commands:datapath.targetDirectory} - gets the binaries target directory (on the remote machine)

${commands:datapath.sshKey} - gets the ssh key

${commands:datapath.tempDirectory} - the directory for temporary files used by the extension, e.g. scripts

${commands:datapath.configurationScript} - provides the path to a Python script that contains variables and settings to be used with LLDB debugging python scripts. Created a Python module called: 'debugSessionConfiguration' The variables exposed are:

• TARGET_LOCAL_PATH - The local path to the debug executable target.
• TARGET_REMOTE_PATH - The remote system path to the debug executable target.
• LOCAL_BUILT_ASSETS_DIRECTORY - rsync from this directory path.
• REMOTE_WORKING_DIRECTORY - rsync to this directory path. The working directory on the remote target system.
• REMOTE_SSH_KEY - The SSH key used to access the remote system. Use this for rsync operations.
• REMOTE_USERNAME - The username to use when accessing the remote system. Use this as the username for rsync operations.
• DEBUG_SERVER_ADDRESS - The IPv4 address of the remote debug target. Used this as the destination for rsync operations and when connecting a debugger.
• DEBUG_SERVER_PORT - The port the debug server is using.
• CODELLDB_RPC_ADDRESS - The address of the local codelldb RPC server.
• CODELLDB_RPC_PORT - The port of the local codelldb RPC server.
• CODELLDB_RPC_TOKEN - The secret token used when connecting to the local codelldb RPC server.