feat: binary trace format (#19)

* chore: moved runtime_tracing library to a subdirectory

This is preparation for creating a workspace, which will contain the library and
a command line tool.

* chore: add Cargo.toml that defines the workspace

* chore: cargo new runtime_tracing_cli

* chore: added dependency to runtime_tracing in runtime_tracing_cli

* chore: added dependency to capnp

* chore: add build dependency to capnpc

* feat: add trace.capnp

* feat: added build.rs that compiles the .capnp file to a .rs file

* feat: include the generated trace_capnp.rs file

* feat: added address to ValueRecord::reference

* feat: added RecordEvent.metadata to capnproto

* feat: added functions for reading and writing capnproto trace files

This is just a copy of the bulk conversion code from my command line json<->bin
conversion tool. These are not fully integrated into the runtime_tracing
library, yet.

* feat: return vector of TraceLowLevelEvent in read_trace()

* feat: read_trace takes an input parameter, instead of reading from stdin

* feat: write_trace now takes an output parameter

* feat: introduced TraceEventsFileFormat

* feat: implemented TraceEventsFileFormat::Binary in Tracer::store_trace_events

* feat: export TraceEventsFileFormat outside from the crate

* feat: add header to the beginning of the binary file

* feat: validate the header in read_trace()

* feat: added dependency to clap in runtime_tracing_cli

* feat: implemented the convert command in runtime_tracing_cli - capable of conversion between binary and json trace formats

* chore: removed unused 'use'

* fix: use write_all() instead of write() to write the header, since write() is not guaranteed to write the entire buffer

* refactor: prettify the else .. if chain in determine_file_format_from_name

* refactor: rm redundant 'static

* refactor: use a slice instead of Vec<> for the write_trace parameter

* ci: install capnproto

* ci: run on all PRs

* feat: add BigInt to the capnproto binary format

* refactor: fn conv_typekind() replaced with a From<> trait implementation

* refactor: fn conv_typekind2() also replaced with a From<> trait implementation

---------

Co-authored-by: Ro6afF <[email protected]>

Author: nickysn

.github/workflows/rust.yml

@@ -4,7 +4,6 @@ on:
   push:
     branches: [ "master" ]
   pull_request:
-    branches: [ "master" ]
 
 env:
   CARGO_TERM_COLOR: always
@@ -15,6 +14,8 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
+    - name: Install capnproto
+      run: sudo apt-get install -y capnproto
     - name: Lint
       run: cargo clippy
 
@@ -24,6 +25,8 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
+    - name: Install capnproto
+      run: sudo apt-get install -y capnproto
     - name: Build
       run: cargo build --verbose
     - name: Run tests

Cargo.toml

@@ -1,24 +1,6 @@
-[package]
-name = "runtime_tracing"
-version = "0.11.0"
-edition = "2021"
-authors = ["Metacraft Labs Ltd"]
-description = "A library for the schema and tracing helpers for the CodeTracer db trace format"
-readme = "README.md"
-repository = "https://github.com/metacraft-labs/runtime_tracing"
-license = "MIT"
-keywords = ["debugging", "development-tools"]
+[workspace]
+resolver = "2"
+members = ["runtime_tracing", "runtime_tracing_cli"]
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
-[dependencies]
-base64 = "0.22.1"
-num-traits = "0.2"
-num-derive = "0.4"
-serde = { version = "1.0", features = ["derive"] }
-serde_json = "1.0"
-serde_repr = "0.1"
-
-[lib]
-name = "runtime_tracing"
-path = "src/lib.rs"
+[workspace.dependencies]
+runtime_tracing = { path = "runtime_tracing/" }

runtime_tracing/Cargo.toml

@@ -0,0 +1,29 @@
+[package]
+name = "runtime_tracing"
+version = "0.11.0"
+edition = "2021"
+authors = ["Metacraft Labs Ltd"]
+description = "A library for the schema and tracing helpers for the CodeTracer db trace format"
+readme = "README.md"
+repository = "https://github.com/metacraft-labs/runtime_tracing"
+license = "MIT"
+keywords = ["debugging", "development-tools"]
+build = "build.rs"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+base64 = "0.22.1"
+num-traits = "0.2"
+num-derive = "0.4"
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0"
+serde_repr = "0.1"
+capnp = "0.21.1"
+
+[build-dependencies]
+capnpc = "0.21.0"
+
+[lib]
+name = "runtime_tracing"
+path = "src/lib.rs"

runtime_tracing/build.rs

@@ -0,0 +1,6 @@
+fn main() {
+    ::capnpc::CompilerCommand::new()
+        .file("src/trace.capnp")
+        .run()
+        .expect("compiling schema")
+}