Skip to content

DEBUGGING.md

Latest commit

 

History

History
100 lines (77 loc) · 2.78 KB

DEBUGGING.md

File metadata and controls

100 lines (77 loc) · 2.78 KB

Debugging

This guide provides information on how to debug the addon using LLDB (and potentially llnode).

Quick Start

1. Build Debug Version

The first step, is building a debug version of the addon. If you are building from static libraries, you can provide the same flags here.

pnpm pregyp rebuild --debug
# You can also enable extra debug logging
pnpm pregyp rebuild --debug --node_libcurl_debug=true
# Or build with AddressSanitizer for memory error detection
pnpm pregyp rebuild --debug --node_libcurl_asan_debug=true
# If building statically
npm_config_node_libcurl_debug=true npm_config_curl_config_bin=~/deps/libcurl/build/8.17.0/bin/curl-config npm_config_curl_static_build="true" pnpm pregyp rebuild

2. Create a Test File

Create a file named debug-test.hidden.js with the following content:

#!/usr/bin/env node
const path = require('path')

const nodeLibcurl = require(
  path.join(__dirname, '..', 'lib', 'binding', 'node_libcurl.node'),
)

const log = (message) => {
  console.log(
    `[nodejs main] [thread: ${nodeLibcurl.Curl.THREAD_ID}] ${message}`,
  )
}

async function main() {
  try {
    log('🚀 Starting Debug Test\n')

    const easy = new nodeLibcurl.Easy()
    const multi = new nodeLibcurl.Multi()
    easy.setOpt('URL', 'https://httpbin.org/get')
    multi.addHandle(easy)

    let resolve
    const promise = new Promise((res) => {
      resolve = res
    })

    multi.onMessage((...args) => {
      console.log('Message callback called', args)
      resolve()
    })

    easy.perform()

    await promise

    console.log('\n✅ Test completed successfully!')
  } catch (error) {
    console.error('\n❌ Test failed:', error.message)
    process.exit(1)
  }
}

main()

3. Run Under LLDB

lldb -- node debug-test.hidden.js

4. Debug

run

Building Node.js from Source

This assumes MacOS, but similar commands will work elsewhere.

NODE_VERSION=20.18.1
git clone --depth 1 --branch v${NODEVERSION} https://github.com/nodejs/node
./configure --prefix ~/node-from-source/${NODEVERSION} --v8-non-optimized-debug --v8-with-dchecks --debug --debug-node
make -j$(sysctl -n hw.logicalcpu)
make install

After building, you can rebuild the addon so it uses that version of Node.js:

pnpm pregyp rebuild --debug --nodedir=~/node-from-source/$NODEVERSION

Thread Sanitizer

CFLAGS="-fsanitize=thread -g -O1" CXXFLAGS="-fsanitize=thread -g -O1" LDFLAGS="-fsanitize=thread" npm_config_curl_config_bin=/home/jcm/deps/libcurl/build/$LIBCURL_RELEASE/bin/curl-config npm_config_curl_static_build=true pnpm pregyp build && TSAN_OPTIONS="second_deadlock_stack=1 history_size=7 halt_on_error=1 suppressions=$(pwd)/tsan-suppressions.txt" LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libtsan.so.0 node examples/22-worker-threads.js