rrtrace 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a124628bbb1039ea27c48968665bf6959431debeeba3068fca7525e7a4e47c2
-  data.tar.gz: 8b1e21f4b384326c82f59e6f43739a4be18c3463a0f461b7f4375523696488ae
+  metadata.gz: 4770d1ed4c3dfd4e968190d28c300e613b4fe660407a481f85a567a74139c2b6
+  data.tar.gz: b867a6b6d82c1069b0c3a5892a4020a17594d1711094d2880fc3b4e268a37461
 SHA512:
-  metadata.gz: 32a443232b6937c43efd666a635347484da22c5d67da40c7c1ed23b31ccfb08a750af48f49a2182061acb842bdf837c0df763b120f9f550726d739731f7669d0
-  data.tar.gz: d73f389d094a12cad5d73c34ec8727d939ec98f6c5b2fe5b6a74f98bc25021fccae41c561a30c787a09eea90241c8812d32cc743f4ceccd825864695753616b5
+  metadata.gz: f94c33853d5c3bd8c145659cee3248f36d874d5abb36b483c0d4a3b760edf8ac387a174e3624e055fe93db18fd41bb91beb7a2ba160c9959add8fcc4165daa20
+  data.tar.gz: e87f11308160e5b2ab3c7effc25dbb5958ba537f79521c3e1d8cd16ff30f95ba02f4db6e06c90fbc1eb0c4c6afd6d75be6f5f31c4e7561462bc09ff9c4d17107

data/.github/dependabot.yml

@@ -0,0 +1,36 @@
+version: 2
+updates:
+  - package-ecosystem: "cargo"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    cooldown:
+      default-days: 3
+    groups:
+      semver-compatible:
+        applies-to: version-updates
+        update-types:
+          - "minor"
+          - "patch"
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    cooldown:
+      default-days: 3
+    groups:
+      semver-compatible:
+        applies-to: version-updates
+        update-types:
+          - "minor"
+          - "patch"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    cooldown:
+      default-days: 3
+    groups:
+      default:
+        patterns:
+          - "*"

data/.github/workflows/ci.yml

@@ -0,0 +1,94 @@
+name: CI
+
+on: push
+
+jobs:
+  rustfmt:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: dtolnay/rust-toolchain@stable
+
+      - run: cargo fmt --all --check
+
+  clippy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: clippy
+
+      - uses: actions/cache@v5
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+          key: ${{ runner.os }}-cargo-${{ hashFiles('Cargo.lock') }}
+          restore-keys: ${{ github.ref_name != github.event.repository.default_branch && format('{0}-cargo-', runner.os) }}
+
+      - uses: actions/cache@v5
+        with:
+          path: target
+          key: ${{ runner.os }}-cargo-clippy-${{ hashFiles('Cargo.lock') }}
+          restore-keys: ${{ github.ref_name != github.event.repository.default_branch && format('{0}-cargo-clippy-', runner.os) }}
+
+      - run: cargo fetch --locked
+
+      - run: cargo clippy --tests -- -D warnings
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: dtolnay/rust-toolchain@stable
+
+      - uses: actions/cache@v5
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+          key: ${{ runner.os }}-cargo-${{ hashFiles('Cargo.lock') }}
+          restore-keys: ${{ github.ref_name != github.event.repository.default_branch && format('{0}-cargo-', runner.os) }}
+
+      - uses: actions/cache@v5
+        with:
+          path: target
+          key: ${{ runner.os }}-cargo-test-${{ hashFiles('Cargo.lock') }}
+          restore-keys: ${{ github.ref_name != github.event.repository.default_branch && format('{0}-cargo-test-', runner.os) }}
+
+      - run: cargo fetch --locked
+
+      - run: cargo test --locked
+
+  taplo:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - id: latest-taplo-version
+        run: |
+          V=$(curl https://index.crates.io/ta/pl/taplo-cli | jq -r 'select(.yanked == false) | .vers' | grep --extended-regexp '^[0-9]+\.[0-9]+\.[0-9]+$' | sort --reverse --version-sort | head --lines=1)
+          echo "Latest version of taplo-cli: $V"
+          echo "version=$V" >> $GITHUB_OUTPUT
+
+      - id: taplo-bin-cache
+        uses: actions/cache@v5
+        with:
+          path: ~/.cargo/bin/taplo
+          key: ${{ runner.os }}-taplo-cli-${{ steps.latest-taplo-version.outputs.version }}
+
+      - if: steps.taplo-bin-cache.outputs.cache-hit != 'true'
+        uses: dtolnay/rust-toolchain@stable
+
+      - if: steps.taplo-bin-cache.outputs.cache-hit != 'true'
+        run: cargo install taplo-cli@${{ steps.latest-taplo-version.outputs.version }} --locked
+
+      - run: ~/.cargo/bin/taplo fmt --check

data/.github/workflows/release.yml

@@ -12,7 +12,7 @@ jobs:
         os: [ ubuntu-latest, macos-latest, windows-latest ]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
@@ -46,7 +46,7 @@ jobs:
           mv rrtrace-${{ steps.get_version.outputs.version }}.gem pkg/
 
       - name: Upload artifacts
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
         with:
           name: gems-${{ matrix.os }}
           path: pkg/*.gem
@@ -60,7 +60,7 @@ jobs:
       id-token: write
       contents: write
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
@@ -69,7 +69,7 @@ jobs:
           bundler-cache: true
 
       - name: Download artifacts
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v8
         with:
           path: pkg
           merge-multiple: true

data/Cargo.lock

@@ -100,6 +100,16 @@ dependencies = [
  "libloading",
 ]
 
+[[package]]
+name = "atomic-wait"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a55b94919229f2c42292fd71ffa4b75e83193bffdd77b1e858cd55fd2d0b0ea8"
+dependencies = [
+ "libc",
+ "windows-sys 0.42.0",
+]
+
 [[package]]
 name = "atomic-waker"
 version = "1.1.2"
@@ -333,25 +343,6 @@ dependencies = [
  "libc",
 ]
 
-[[package]]
-name = "crossbeam-deque"
-version = "0.8.6"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9dd111b7b7f7d55b72c0a6ae361660ee5853c9af73f70c3c2ef6858b950e2e51"
-dependencies = [
- "crossbeam-epoch",
- "crossbeam-utils",
-]
-
-[[package]]
-name = "crossbeam-epoch"
-version = "0.9.18"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5b82ac4a3c2ca9c3460964f020e1402edd5753411d7737aa39c3714ad1b5420e"
-dependencies = [
- "crossbeam-utils",
-]
-
 [[package]]
 name = "crossbeam-queue"
 version = "0.3.12"
@@ -1290,16 +1281,6 @@ version = "0.6.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "20675572f6f24e9e76ef639bc5552774ed45f1c30e2951e1e99c59888861c539"
 
-[[package]]
-name = "rayon-core"
-version = "1.13.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "22e18b0f0062d30d4230b2e85ff77fdfe4326feb054b9783a3460d8435c8ab91"
-dependencies = [
- "crossbeam-deque",
- "crossbeam-utils",
-]
-
 [[package]]
 name = "redox_syscall"
 version = "0.4.1"
@@ -1337,12 +1318,12 @@ checksum = "19b30a45b0cd0bcca8037f3d0dc3421eaf95327a17cad11964fb8179b4fc4832"
 name = "rrtrace"
 version = "0.1.0"
 dependencies = [
+ "atomic-wait",
  "bytemuck",
  "crossbeam-queue",
  "glam",
  "libc",
  "pollster",
- "rayon-core",
  "smallvec",
  "wgpu",
  "windows-sys 0.61.2",
@@ -2160,6 +2141,21 @@ dependencies = [
  "windows-link",
 ]
 
+[[package]]
+name = "windows-sys"
+version = "0.42.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5a3e1820f08b8513f676f7ab6c1f99ff312fb97b553d30ff4dd86f9f15728aa7"
+dependencies = [
+ "windows_aarch64_gnullvm 0.42.2",
+ "windows_aarch64_msvc 0.42.2",
+ "windows_i686_gnu 0.42.2",
+ "windows_i686_msvc 0.42.2",
+ "windows_x86_64_gnu 0.42.2",
+ "windows_x86_64_gnullvm 0.42.2",
+ "windows_x86_64_msvc 0.42.2",
+]
+
 [[package]]
 name = "windows-sys"
 version = "0.45.0"

data/Cargo.toml

@@ -1,17 +1,17 @@
 [package]
+edition = "2024"
 name = "rrtrace"
 version = "0.1.0"
-edition = "2024"
 
 [profile.release]
 overflow-checks = true
 
 [dependencies]
-bytemuck = { version = "1.24.0", features = ["derive"] }
+atomic-wait = "1.1.0"
+bytemuck = { features = ["derive"], version = "1.24.0" }
 crossbeam-queue = "0.3.12"
 glam = "0.30.9"
 pollster = "0.4.0"
-rayon-core = "1.13.0"
 smallvec = "1.15.1"
 wgpu = "28.0.0"
 winit = "0.30.12"
@@ -20,4 +20,8 @@ winit = "0.30.12"
 libc = "0.2.178"
 
 [target.'cfg(windows)'.dependencies]
-windows-sys = { version = "0.61.2", features = ["Win32_System_Memory", "Win32_Foundation", "Win32_System_Diagnostics_Debug"] }
+windows-sys = { features = [
+  "Win32_Foundation",
+  "Win32_System_Diagnostics_Debug",
+  "Win32_System_Memory",
+], version = "0.61.2" }

data/README.md

@@ -1,39 +1,100 @@
-# Rrtrace
+# rrtrace
 
-TODO: Delete this and the text below, and describe your gem
+`rrtrace` is a Ruby tracing tool with a Rust-based visualizer.
+It records Ruby method calls, returns, GC transitions, and thread lifecycle events, then streams them to a separate GPU renderer process for real-time visualization.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rrtrace`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Features
 
-## Installation
+- Trace Ruby `call` / `return` and C-level `c_call` / `c_return` events
+- Capture GC enter / exit events
+- Capture thread start / ready / suspend / resume / exit events
+- Stream events through shared memory to a separate visualizer process
+- Render the trace with a native Rust application built on `wgpu` and `winit`
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## How It Works
 
-Install the gem and add to the application's Gemfile by executing:
+`rrtrace` consists of two parts:
+
+1. A Ruby native extension written in C
+   - Installs Ruby tracepoints and internal thread event hooks
+   - Writes trace events into a shared-memory ring buffer
+   - Launches the visualizer process
+2. A Rust visualizer
+   - Reads events from shared memory
+   - Builds trace state in background threads
+   - Renders the result in a desktop window using the GPU
+
+At a high level, the data flow is:
+
+`Ruby VM` -> `C extension hooks` -> `shared-memory ring buffer` -> `Rust visualizer` -> `window`
+
+## Usage
+
+### CLI
+
+Run a Ruby script under `rrtrace`:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+rrtrace path/to/script.rb
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+You can also use the repository executable directly during development:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle exec exe/rrtrace path/to/script.rb
 ```
 
-## Usage
+The command starts the visualizer process, opens a window, loads the target Ruby file, and stops tracing when the program exits.
+
+### Ruby API
+
+For manual control:
+
+```ruby
+require "rrtrace"
+
+Rrtrace.start
+
+# your Ruby code here
 
-TODO: Write usage instructions here
+Rrtrace.stop
+```
+
+Available methods:
+
+- `Rrtrace.start`
+- `Rrtrace.stop`
+- `Rrtrace.started?`
+- `Rrtrace.visualizer_path`
+
+`Rrtrace.stop` is also registered with `at_exit`, so tracing is cleaned up automatically when the process exits normally.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Install dependencies:
+
+```bash
+bin/setup
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Build the extension and visualizer:
 
-## Contributing
+```bash
+bundle exec rake build
+```
+
+Useful commands:
+
+```bash
+bundle exec rake compile
+bundle exec rake standard
+cargo test --locked
+cargo fmt --all
+cargo clippy --tests -- -D warnings
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rrtrace.
+The Rust visualizer built during extension compilation is copied to `libexec/rrtrace` (or `libexec/rrtrace.exe` on Windows).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+This project is licensed under the MIT License. See [LICENSE.txt](LICENSE.txt).

data/exe/rrtrace

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rrtrace"
+
+if ARGV.empty?
+    $stderr.puts "Usage: rrtrace <executable.rb> [args...]"
+    exit 1
+end
+
+executable = ARGV.shift
+
+$0 = executable
+Rrtrace.start
+load executable
+Rrtrace.stop

data/ext/rrtrace/process_manager_posix.h

@@ -4,9 +4,14 @@
 #include <sys/types.h>
 #include <sys/wait.h>
 #include <spawn.h>
+#include <signal.h>
 
 typedef pid_t process_id;
 
+static inline process_id invalid_process_id(void) {
+    return 0;
+}
+
 extern char **environ;
 
 static inline process_id spawn_process(const char *cmd, char * const* restrict argv) {
@@ -17,9 +22,20 @@ static inline process_id spawn_process(const char *cmd, char * const* restrict a
 }
 
 static inline int is_process_running(process_id pid) {
+    if (pid == 0) return 0;
     int status;
-    waitpid(pid, &status, WNOHANG);
-    return !WIFEXITED(status);
+    pid_t result = waitpid(pid, &status, WNOHANG);
+    return result == 0;
+}
+
+static inline void terminate_process(process_id pid) {
+    if (pid == 0) return;
+    kill(pid, SIGTERM);
+    waitpid(pid, NULL, 0);
+}
+
+static inline void close_process(process_id pid) {
+    (void)pid;
 }
 
 #endif /* PROCESS_MANAGER_POSIX_H */

data/ext/rrtrace/process_manager_windows.h

@@ -6,6 +6,10 @@
 
 typedef HANDLE process_id;
 
+static inline process_id invalid_process_id(void) {
+    return NULL;
+}
+
 static inline process_id spawn_process(const char *cmd, char * const* argv) {
     STARTUPINFOA si;
     PROCESS_INFORMATION pi;
@@ -37,4 +41,14 @@ static inline int is_process_running(process_id pid) {
     return 0;
 }
 
+static inline void terminate_process(process_id pid) {
+    if (pid == NULL) return;
+    TerminateProcess(pid, 1);
+}
+
+static inline void close_process(process_id pid) {
+    if (pid == NULL) return;
+    CloseHandle(pid);
+}
+
 #endif /* PROCESS_MANAGER_WIN_H */