teamy-mft 0.7.0

TeamDman's Master File Table CLI and library for NTFS.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
use crate::cli::global_args::GlobalArgs;
use chrono::Local;
use color_eyre::owo_colors::OwoColorize;
use eyre::bail;
use std::fmt;
use std::fs::File;
use std::sync::Arc;
use std::sync::LazyLock;
use std::sync::Mutex;
use std::time::Instant;
use tracing::Event;
use tracing::debug;
use tracing::field::Field;
use tracing::field::Visit;
use tracing_subscriber::EnvFilter;
use tracing_subscriber::Registry;
use tracing_subscriber::filter::FilterFn;
use tracing_subscriber::fmt::FmtContext;
use tracing_subscriber::fmt::FormatEvent;
use tracing_subscriber::fmt::FormatFields;
#[cfg(all(feature = "tracy", not(test)))]
use tracing_subscriber::fmt::format::DefaultFields;
use tracing_subscriber::fmt::format::Writer;
use tracing_subscriber::fmt::writer::BoxMakeWriter;
use tracing_subscriber::fmt::writer::MakeWriterExt;
use tracing_subscriber::prelude::*;
use tracing_subscriber::registry::LookupSpan;
use tracing_subscriber::util::SubscriberInitExt;

struct SourceAwareEventFormat<E> {
    inner: E,
}

static LOG_START: LazyLock<Instant> = LazyLock::new(Instant::now);

#[derive(Debug, Default)]
struct DaemonRemotePrettyFields {
    message: Option<String>,
    target: Option<String>,
    file: Option<String>,
    line: Option<String>,
    spans: Option<String>,
    rpc_method: Option<String>,
    correlation_id: Option<String>,
    fields: Option<String>,
}

impl DaemonRemotePrettyFields {
    fn record_rendered(&mut self, field: &Field, rendered: &str) {
        let value = rendered.trim_matches('"').to_string();
        match field.name() {
            "message" => self.message = Some(value),
            "daemon_target" => self.target = Some(value),
            "daemon_file" => self.file = Some(value),
            "daemon_line" => self.line = Some(value),
            "daemon_spans" => self.spans = Some(value),
            "rpc_method" => self.rpc_method = Some(value),
            "correlation_id" => self.correlation_id = Some(value),
            "daemon_fields" => self.fields = Some(value),
            _ => {}
        }
    }
}

impl Visit for DaemonRemotePrettyFields {
    fn record_debug(&mut self, field: &Field, value: &dyn fmt::Debug) {
        self.record_rendered(field, &format!("{value:?}"));
    }

    fn record_str(&mut self, field: &Field, value: &str) {
        self.record_rendered(field, value);
    }

    fn record_bool(&mut self, field: &Field, value: bool) {
        self.record_rendered(field, &value.to_string());
    }

    fn record_i64(&mut self, field: &Field, value: i64) {
        self.record_rendered(field, &value.to_string());
    }

    fn record_u64(&mut self, field: &Field, value: u64) {
        self.record_rendered(field, &value.to_string());
    }

    fn record_i128(&mut self, field: &Field, value: i128) {
        self.record_rendered(field, &value.to_string());
    }

    fn record_u128(&mut self, field: &Field, value: u128) {
        self.record_rendered(field, &value.to_string());
    }

    fn record_f64(&mut self, field: &Field, value: f64) {
        self.record_rendered(field, &value.to_string());
    }
}

#[cfg(all(feature = "tracy", not(test)))]
#[derive(Default)]
struct TracyLayerConfig {
    formatter: TracyPlainFields,
}

#[cfg(all(feature = "tracy", not(test)))]
impl tracing_tracy::Config for TracyLayerConfig {
    type Formatter = TracyPlainFields;

    fn formatter(&self) -> &Self::Formatter {
        &self.formatter
    }
}

#[cfg(all(feature = "tracy", not(test)))]
#[derive(Default)]
struct TracyPlainFields(DefaultFields);

#[cfg(all(feature = "tracy", not(test)))]
impl<'writer> FormatFields<'writer> for TracyPlainFields {
    fn format_fields<R: tracing_subscriber::field::RecordFields>(
        &self,
        writer: Writer<'writer>,
        fields: R,
    ) -> fmt::Result {
        self.0.format_fields(writer, fields)
    }
}

impl<S, N, E> FormatEvent<S, N> for SourceAwareEventFormat<E>
where
    S: tracing::Subscriber + for<'span> LookupSpan<'span>,
    N: for<'writer> FormatFields<'writer> + 'static,
    E: FormatEvent<S, N>,
{
    fn format_event(
        &self,
        ctx: &FmtContext<'_, S, N>,
        mut writer: Writer<'_>,
        event: &Event<'_>,
    ) -> fmt::Result {
        let source = if event
            .metadata()
            .target()
            .starts_with(crate::machine::daemon_log::DAEMON_REMOTE_TARGET)
        {
            if writer.has_ansi_escapes() {
                "[daemon] ".bright_blue().to_string()
            } else {
                String::from("[daemon] ")
            }
        } else {
            if writer.has_ansi_escapes() {
                "[client] ".bright_green().to_string()
            } else {
                String::from("[client] ")
            }
        };
        writer.write_str(&source)?;
        if event.metadata().target() == crate::machine::daemon_log::DAEMON_REMOTE_TARGET {
            return format_daemon_remote_event(&mut writer, event);
        }
        self.inner.format_event(ctx, writer, event)
    }
}

fn format_daemon_remote_event(writer: &mut Writer<'_>, event: &Event<'_>) -> fmt::Result {
    let mut fields = DaemonRemotePrettyFields::default();
    event.record(&mut fields);

    let ansi = writer.has_ansi_escapes();
    let elapsed = LOG_START.elapsed().as_secs_f64();
    let level = event.metadata().level();
    let target = fields
        .target
        .as_deref()
        .unwrap_or_else(|| event.metadata().target());
    let message = fields
        .message
        .as_deref()
        .unwrap_or_else(|| event.metadata().name());

    write!(
        writer,
        "{} {} {}{} {}",
        style_dim(ansi, &format!("{elapsed:>16.9}s")),
        style_level(ansi, *level, &level.to_string()),
        style_level_bold(ansi, *level, target),
        style_level(ansi, *level, ":"),
        style_level(ansi, *level, message)
    )?;
    if let Some(event_fields) = fields.fields.as_deref().filter(|fields| !fields.is_empty()) {
        write!(
            writer,
            "{} {}",
            style_level(ansi, *level, ","),
            style_daemon_field_list(ansi, *level, event_fields)
        )?;
    }

    match (
        fields.file.as_deref().filter(|file| *file != "unknown"),
        fields.line.as_deref().filter(|line| *line != "unknown"),
    ) {
        (Some(file), Some(line)) => write!(
            writer,
            "\n    {} {file}:{line}",
            style_source_label(ansi, "at")
        )?,
        (Some(file), None) => write!(writer, "\n    {} {file}", style_source_label(ansi, "at"))?,
        _ => {}
    }

    if let Some(spans) = fields.spans.as_deref().filter(|spans| !spans.is_empty()) {
        write!(writer, "\n    {} {spans}", style_source_label(ansi, "in"))?;
        let method = fields
            .rpc_method
            .as_deref()
            .filter(|method| *method != "global");
        let correlation_id = fields
            .correlation_id
            .as_deref()
            .filter(|correlation_id| *correlation_id != "global");
        match (method, correlation_id) {
            (Some(method), Some(correlation_id)) => {
                write!(
                    writer,
                    " {} {}{}, {}{}",
                    style_dim(ansi, "with"),
                    style_level_bold(ansi, *level, "rpc_method"),
                    style_level(ansi, *level, &format!("=\"{method}\"")),
                    style_level_bold(ansi, *level, "correlation_id"),
                    style_level(ansi, *level, &format!("={correlation_id}"))
                )?;
            }
            (Some(method), None) => write!(
                writer,
                " {} {}{}",
                style_dim(ansi, "with"),
                style_level_bold(ansi, *level, "rpc_method"),
                style_level(ansi, *level, &format!("=\"{method}\""))
            )?,
            (None, Some(correlation_id)) => write!(
                writer,
                " {} {}{}",
                style_dim(ansi, "with"),
                style_level_bold(ansi, *level, "correlation_id"),
                style_level(ansi, *level, &format!("={correlation_id}"))
            )?,
            (None, None) => {}
        }
    }

    writeln!(writer)
}

fn style_level(ansi: bool, level: tracing::Level, value: &str) -> String {
    if !ansi {
        return value.to_string();
    }

    match level {
        tracing::Level::TRACE => value.purple().to_string(),
        tracing::Level::DEBUG => value.blue().to_string(),
        tracing::Level::INFO => value.green().to_string(),
        tracing::Level::WARN => value.yellow().to_string(),
        tracing::Level::ERROR => value.red().to_string(),
    }
}

fn style_level_bold(ansi: bool, level: tracing::Level, value: &str) -> String {
    if !ansi {
        return value.to_string();
    }

    match level {
        tracing::Level::TRACE => value.purple().bold().to_string(),
        tracing::Level::DEBUG => value.blue().bold().to_string(),
        tracing::Level::INFO => value.green().bold().to_string(),
        tracing::Level::WARN => value.yellow().bold().to_string(),
        tracing::Level::ERROR => value.red().bold().to_string(),
    }
}

fn style_dim(ansi: bool, value: &str) -> String {
    if ansi {
        value.dimmed().to_string()
    } else {
        value.to_string()
    }
}

fn style_source_label(ansi: bool, value: &str) -> String {
    if ansi {
        value.dimmed().italic().to_string()
    } else {
        value.to_string()
    }
}

fn style_daemon_field_list(ansi: bool, level: tracing::Level, fields: &str) -> String {
    fields
        .split(", ")
        .map(|field| {
            let Some((key, value)) = field.split_once('=') else {
                return style_level(ansi, level, field);
            };
            format!(
                "{}{}",
                style_level_bold(ansi, level, key),
                style_level(ansi, level, &format!("={value}"))
            )
        })
        .collect::<Vec<_>>()
        .join(&style_level(ansi, level, ", "))
}

fn default_log_filter(global_args: &GlobalArgs) -> eyre::Result<EnvFilter> {
    if let Some(filter) = global_args.log_filter.as_ref() {
        if global_args.debug {
            bail!("cannot specify log filter with --debug");
        }
        return EnvFilter::builder().parse(filter).map_err(Into::into);
    }

    let own_level = if global_args.debug { "debug" } else { "info" };
    let filter = format!("warn,teamy_mft={own_level}");
    EnvFilter::builder().parse(filter).map_err(Into::into)
}

fn stderr_event_filter(metadata: &tracing::Metadata<'_>) -> bool {
    metadata.target() != crate::machine::daemon_log::DAEMON_REMOTE_SPAN_TRANSITION_TARGET
}

#[cfg(all(feature = "tracy", not(test)))]
fn tracy_log_filter() -> eyre::Result<EnvFilter> {
    EnvFilter::builder()
        .parse(
            [
                "trace",
                "cranelift_codegen=warn",
                "cranelift_frontend=warn",
                "cranelift_jit=warn",
                "cranelift_native=warn",
                "regalloc2=warn",
                "wasmtime=warn",
            ]
            .join(","),
        )
        .map_err(Into::into)
}

// tool[impl logging.stderr-output]
// tool[impl logging.file-path-option]
// tool[impl logging.file-structured-ndjson]
/// Initialize logging based on the provided configuration.
///
/// # Errors
///
/// This function will return an error if creating the log file or directories fails.
///
/// # Panics
///
/// This function may panic if locking or cloning the log file handle fails.
pub fn init_logging(global_args: &GlobalArgs) -> eyre::Result<()> {
    LazyLock::force(&LOG_START);

    let subscriber = Registry::default();

    let stderr_layer = tracing_subscriber::fmt::layer()
        .with_file(cfg!(debug_assertions))
        .with_line_number(cfg!(debug_assertions))
        .with_target(true)
        .with_writer(std::io::stderr.and(crate::windows_utils::log::LOG_BUFFER.clone()))
        .event_format(SourceAwareEventFormat {
            inner: tracing_subscriber::fmt::format()
                .pretty()
                .with_timer(tracing_subscriber::fmt::time::uptime()),
        })
        .with_filter(default_log_filter(global_args)?)
        .with_filter(FilterFn::new(stderr_event_filter));

    let subscriber = subscriber.with(stderr_layer);
    let subscriber = subscriber.with(crate::machine::daemon_log::DaemonTraceLayer);

    let json_log_path = match global_args.log_file.as_ref() {
        None => None,
        Some(path) if std::path::PathBuf::from(path).is_dir() => {
            let timestamp = Local::now().format("%Y-%m-%d_%H-%M-%S");
            let filename = format!("log_{timestamp}.ndjson");
            Some(std::path::PathBuf::from(path).join(filename))
        }
        Some(path) => Some(std::path::PathBuf::from(path)),
    };
    let json_layer = if let Some(ref json_log_path) = json_log_path {
        if let Some(parent) = json_log_path.parent() {
            std::fs::create_dir_all(parent)?;
        }
        let file = File::create(json_log_path)?;
        let file = Arc::new(Mutex::new(file));
        let json_writer = BoxMakeWriter::new(move || {
            file.lock()
                .expect("failed to lock json log file")
                .try_clone()
                .expect("failed to clone json log file handle")
        });

        let json_layer = tracing_subscriber::fmt::layer()
            .event_format(tracing_subscriber::fmt::format().json())
            .with_file(true)
            .with_target(false)
            .with_line_number(true)
            .with_writer(json_writer)
            .with_filter(default_log_filter(global_args)?);
        Some(json_layer)
    } else {
        None
    };
    let subscriber = subscriber.with(json_layer);

    #[cfg(all(feature = "tracy", not(test)))]
    let subscriber = subscriber.with(
        tracing_tracy::TracyLayer::new(TracyLayerConfig::default())
            .with_filter(tracy_log_filter()?),
    );

    if let Err(error) = subscriber.try_init() {
        eprintln!(
            "Failed to initialize tracing subscriber - are you running `cargo test`? If so, multiple test entrypoints may be running from the same process. https://github.com/tokio-rs/console/issues/505 : {error}"
        );
        return Ok(());
    }

    #[cfg(all(feature = "tracy", not(test)))]
    tracing::info!(
        "Tracy profiling layer added, memory usage will increase until a client is connected"
    );

    debug!(
        ?json_log_path,
        debug = global_args.debug,
        "Tracing initialized"
    );

    // Because our logging uses uptime as the timestamp, log the current time at startup to provide a reference point for when events occurred.
    tracing::info!("Current time: {}", Local::now().format("%Y-%m-%d %H:%M:%S"));

    Ok(())
}