Add line number + file name + function name to logs

Author: ngernest

monitor/Cargo.toml

@@ -16,5 +16,9 @@ baa.workspace = true
 patronus.workspace = true
 wellen = "0.19.0"
 log = "0.4.27"
+stdext = "0.3"
 rustc-hash.workspace = true
 anyhow = "1.0.100"
+
+[dev-dependencies]
+wellen = "0.19.0"

monitor/src/designs.rs

@@ -3,7 +3,6 @@
 // author: Kevin Laeufer <laeufer@cornell.edu>
 // author: Ernest Ng <eyn5@cornell.edu>
 
-use log::info;
 use protocols::{
     ir::{Field, SymbolId, SymbolTable, Transaction, Type},
     serialize::serialize_field,

monitor/src/global_scheduler.rs

@@ -14,7 +14,6 @@ use crate::{
         Trace,
     },
 };
-use log::info;
 use rustc_hash::FxHashSet;
 
 pub struct GlobalScheduler {

monitor/src/interpreter.rs

@@ -1,7 +1,6 @@
 use std::collections::hash_map::Entry;
 
 use baa::{BitVecMutOps, BitVecOps, BitVecValue};
-use log::info;
 use protocols::{
     errors::{AssertionError, EvaluationError, ExecutionError, ExecutionResult, SymbolError},
     interpreter::ExprValue,

monitor/src/macros.rs

@@ -0,0 +1,5 @@
+/// A wrapper around the `log::info!` macro, which includes the name of the
+/// function in which the log was called (obtained via `stdext::function_name!`)
+macro_rules! info {
+    ($($arg:tt)*) => { log::info!(target: stdext::function_name!(), $($arg)*) }
+}

monitor/src/main.rs

@@ -3,6 +3,8 @@
 // author: Ernest Ng <eyn5@cornell.edu>
 // author: Kevin Laeufer <laeufer@cornell.edu>
 
+#[macro_use]
+mod macros;
 mod axi_experiment;
 mod designs;
 mod global_context;
@@ -27,6 +29,8 @@ use protocols::diagnostic::DiagnosticHandler;
 use protocols::ir::{SymbolTable, Transaction};
 use protocols::parser::parsing_helper;
 use protocols::typecheck::type_check;
+use std::io::Write;
+use std::path::Path;
 
 // From the top-level directory, run:
 // $ cargo run --package protocols-monitor -- -p protocols/tests/adders/adder_d1/add_d1.prot -w trace.fst -i add_d1:Adder
@@ -104,8 +108,45 @@ fn main() -> anyhow::Result<()> {
     // For concision, we disable timestamps and the module paths in the log
     let mut logger = env_logger::Builder::new();
 
+    let use_color = cli.color != ColorChoice::Never;
     logger
-        .format_timestamp(None)
+        .format(move |buf, record| {
+            use clap::builder::styling::{AnsiColor, Color, Style};
+            use log::Level;
+            let file = record
+                .file()
+                .and_then(|f| Path::new(f).file_name()?.to_str())
+                .unwrap_or("?");
+            let line = record.line().unwrap_or(0);
+            let fn_name = record
+                .target()
+                .rsplit("::")
+                .next()
+                .unwrap_or(record.target());
+            let level_style = if use_color {
+                let color = match record.level() {
+                    Level::Info => AnsiColor::Cyan,
+                    _ => AnsiColor::Red,
+                };
+                Style::new().fg_color(Some(Color::Ansi(color))).bold()
+            } else {
+                Style::new()
+            };
+            let dim_style = if use_color {
+                Style::new().dimmed()
+            } else {
+                Style::new()
+            };
+            writeln!(
+                buf,
+                "{}{file}:{line}{} {}({fn_name}){}: {}",
+                dim_style.render(),
+                dim_style.render_reset(),
+                level_style.render(),
+                level_style.render_reset(),
+                record.args()
+            )
+        })
         .filter_level(cli.verbosity.log_level_filter());
 
     if cli.color == ColorChoice::Never {

monitor/src/scheduler.rs

@@ -1,6 +1,5 @@
 use anyhow::{Context, anyhow};
 use baa::{BitVecOps, BitVecValue};
-use log::info;
 use protocols::{
     errors::{EvaluationError, ExecutionError},
     ir::{Expr, Stmt, StmtId, SymbolId, SymbolTable, Transaction},

monitor/src/signal_trace.rs

@@ -6,7 +6,6 @@
 use crate::{Instance, designs::Design, global_context::TimeUnit};
 use anyhow::Context;
 use baa::BitVecValue;
-use log::info;
 use protocols::ir::SymbolId;
 use rustc_hash::FxHashMap;
 use wellen::{Hierarchy, SignalRef};