[Rust] Replace log with tracing

[emesare]

• Added more documentation
• Replaced global named logger for plugins, fixing the issue when the CU has multiple (e.g. statically linked demo)
• Explicitly name the target for the log event, this is how it must be done to guarantee we send it to the correct one
• Simplified some misc code
• Added session_id event field, to send logs to a particular session (e.g. binary view scoped logs)

This is a breaking change, but I believe there is no better time to make it, we cannot continue to use the log crate, it is too limited for our needs.

Still need to finish docs and cross link more between the logger module and the tracing module, as well as provide some examples in the top level module docs.

Still need to place more session id spans in relevant callbacks so that they automatically get scoped to a bv.

TBD if we keep the tracing re-exports for the macros, we might instead let callers use the non re-exported version. or we might move the code into logger and then re-export tracing at the top level, or we might not re-export at all and assume the caller includes tracing in Cargo.toml.

[emesare]

Resolves #6863

[emesare]

Force pushed removing explicit targets in log calls, replaced with rewrite rules within the registered tracing BinaryNinjaLayer

[emesare]

Migration guide:

1. Add/Remove crates:

diff --git a/plugins/pdb-ng/Cargo.toml b/plugins/pdb-ng/Cargo.toml
--- a/plugins/pdb-ng/Cargo.toml
+++ b/plugins/pdb-ng/Cargo.toml
@@ -16,1 +16,2 @@
 regex = "1"
+tracing = "0.1"

2. Replace usage of log helper macros:

diff --git a/plugins/warp/src/plugin/load.rs b/plugins/warp/src/plugin/load.rs
--- a/plugins/warp/src/plugin/load.rs
+++ b/plugins/warp/src/plugin/load.rs
@@ -132,4 +133,4 @@
             Err(e) => {
-                log::error!("Failed to read signature file: {}", e);
+                tracing::error!("Failed to read signature file: {}", e);
                 return;
             }

You can technically keep using log::info! and friends, see tracing documentation for more details.

3. Replace Logger::new at top of plugin init with tracing_init!:

diff --git a/plugins/pdb-ng/src/lib.rs b/plugins/pdb-ng/src/lib.rs
--- a/plugins/pdb-ng/src/lib.rs
+++ b/plugins/pdb-ng/src/lib.rs
@@ -721,1 +729,1 @@
-    Logger::new("PDB").init();
+    binaryninja::tracing_init!("PDB Import");

[bdash]

LGTM, with some minor comments.

[plafosse]

Mark already approved this. I'm in favor too. Just setting Mark as assigned so my filtering works :)