ttlog 0.1.21

High-performance lock-free tracing and logging system
Documentation
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
449
450
451
452
453
454
455
456
457
mod __test__;

use chrono::Duration;
use std::num;
use std::sync::OnceLock;
use std::time::{Instant, SystemTime, UNIX_EPOCH};
use std::{sync::Arc, thread};

use crate::event::{LogEvent, LogLevel};
use crate::lf_buffer::LockFreeRingBuffer;
use crate::listener::LogListener;
use crate::panic_hook::PanicHook;
use crate::snapshot::SnapshotWriter;
use crate::string_interner::StringInterner;
use crossbeam_channel::{unbounded, Receiver, Sender};
use std::sync::atomic::{self, AtomicU8, Ordering};

#[derive(Debug)]
pub enum Message {
  SnapshotImmediate(String, std::sync::mpsc::Sender<()>),
  FlushAndExit,
}

pub enum ListenerMessage {
  Add(
    Arc<dyn LogListener + std::panic::UnwindSafe + std::panic::RefUnwindSafe>,
    std::sync::mpsc::Sender<()>,
  ),
  Shutdown,
}

// New message type for direct event broadcasting
#[derive(Debug, Clone)]
pub struct EventBroadcast {
  pub event: LogEvent,
}

impl std::fmt::Display for Message {
  fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
    match self {
      Message::SnapshotImmediate(reason, _) => write!(f, "SnapshotImmediate: {}", reason),
      Message::FlushAndExit => write!(f, "FlushAndExit"),
    }
  }
}

pub struct Trace {
  /// For snapshots (accumulates events, only drained on snapshot)
  pub snapshot_buffer: Arc<LockFreeRingBuffer<LogEvent>>,
  /// Channel sender for communicating with the writer thread
  pub sender: Sender<Message>,
  /// Direct event broadcasting channel - unbounded to ensure no events are lost
  pub event_broadcast_sender: Sender<EventBroadcast>,
  /// Atomic log level for runtime filtering
  pub level: atomic::AtomicU8,
  pub interner: Arc<StringInterner>,
  pub listener_sender: Sender<ListenerMessage>,
  pub write_thread: Option<thread::JoinHandle<()>>,
  pub listener_thread: Option<thread::JoinHandle<()>>,
}

pub static GLOBAL_LOGGER: OnceLock<Trace> = OnceLock::new();

impl Trace {
  pub fn new(
    sender: Sender<Message>,
    listener_sender: Sender<ListenerMessage>,
    event_broadcast_sender: Sender<EventBroadcast>,
    interner: Arc<StringInterner>,
    snapshot_buffer: Arc<LockFreeRingBuffer<LogEvent>>,
  ) -> Self {
    Self {
      sender,
      event_broadcast_sender,
      snapshot_buffer,
      interner,
      listener_sender,
      level: AtomicU8::new(LogLevel::WARN as u8),
      write_thread: None,
      listener_thread: None,
    }
  }

  fn set_handler(
    &mut self,
    write_thread: Option<thread::JoinHandle<()>>,
    listener_thread: Option<thread::JoinHandle<()>>,
  ) {
    self.write_thread = write_thread;
    self.listener_thread = listener_thread;
  }

  pub fn init(
    capacity: usize,
    channel_capacity: usize,
    service_name: &str,
    storage_path: Option<&str>,
  ) -> Self {
    let (sender, receiver) = crossbeam_channel::bounded::<Message>(channel_capacity);
    let (listener_sender, listener_receiver) = crossbeam_channel::bounded::<ListenerMessage>(16);

    // Use unbounded channel for event broadcasting to ensure no events are lost
    let (event_broadcast_sender, event_broadcast_receiver) = unbounded::<EventBroadcast>();

    let interner = Arc::new(StringInterner::new());

    // Only need snapshot buffer now - listeners get events directly
    let snapshot_buffer = Arc::new(LockFreeRingBuffer::new(capacity));
    let snapshot_buffer_clone = Arc::clone(&snapshot_buffer);
    let interner_clone = Arc::clone(&interner);

    // Install panic hook before spawning writer thread
    PanicHook::install(sender.clone());

    let service_name = service_name.to_string();
    let storage_path: String = match storage_path {
      Some(path) => path.to_string(),
      None => "./tmp/".to_string(),
    };

    // Create the trace instance first
    let mut trace = Trace::new(
      sender,
      listener_sender,
      event_broadcast_sender,
      interner,
      snapshot_buffer,
    );

    // Set the global logger BEFORE spawning the writer thread
    match GLOBAL_LOGGER.set(trace.clone()) {
      Ok(_) => {
        println!("GLOBAL_LOGGER initialized");
      },
      Err(_) => panic!("GLOBAL_LOGGER already initialized"),
    };

    let write_thread_handle = thread::spawn(move || {
      Self::writer_loop(
        receiver,
        capacity,
        service_name,
        storage_path,
        snapshot_buffer_clone,
        interner_clone,
      );
    });

    // Spawn separate listener management thread
    let interner_listener = Arc::clone(&trace.interner);
    let listener_thread_handle = thread::spawn(move || {
      Self::listener_loop(
        listener_receiver,
        event_broadcast_receiver,
        interner_listener,
      );
    });

    trace.set_handler(Some(write_thread_handle), Some(listener_thread_handle));

    // Wait for writer and listener threads to start
    // write_thread_handle.join().unwrap();
    // listener_thread_handle.join().unwrap();

    trace
  }

  pub fn add_listener(
    &self,
    listener: Arc<dyn LogListener + std::panic::UnwindSafe + std::panic::RefUnwindSafe>,
  ) {
    let (ack_tx, ack_rx) = std::sync::mpsc::channel();
    match self
      .listener_sender
      .send(ListenerMessage::Add(listener, ack_tx))
    {
      Ok(_) => {
        println!("[Trace] Listener addition request sent");
        if ack_rx.recv().is_err() {
          eprintln!("[Trace] Listener addition ack channel dropped");
        }
      },
      Err(e) => {
        eprintln!("[Trace] Failed to add listener: {:?}", e);
      },
    }
  }

  pub fn shutdown(&mut self) {
    // Shutdown listeners first
    let _ = self.listener_sender.try_send(ListenerMessage::Shutdown);
    // Then shutdown writer
    let _ = self.sender.try_send(Message::FlushAndExit);

    // join threads instead of sleeping
    if let Some(handle) = self.write_thread.take() {
      let _ = handle.join();
    }
    if let Some(handle) = self.listener_thread.take() {
      let _ = handle.join();
    }

    eprintln!("[Trace] Shutdown completed");
  }

  pub fn get_sender(&self) -> Sender<Message> {
    self.sender.clone()
  }

  pub fn request_snapshot(&self, reason: impl Into<String>) {
    let (tx, rx) = std::sync::mpsc::channel();

    if let Err(e) = self
      .sender
      .try_send(Message::SnapshotImmediate(reason.into(), tx))
    {
      eprintln!("[Snapshot Request] Failed to enqueue: {:?}", e);
      return;
    }

    eprintln!("[Snapshot Request] Waiting for snapshot completion...");
    if rx.recv().is_ok() {
      eprintln!("[Snapshot Request] Snapshot completed!");
    }
  }

  pub fn set_level(&self, level: LogLevel) {
    self.level.store(level as u8, Ordering::Relaxed);
    if let Some(logger) = GLOBAL_LOGGER.get() {
      logger.level.store(level as u8, Ordering::Relaxed);
    }
  }

  pub fn get_level(&self) -> LogLevel {
    let level_u8 = self.level.load(Ordering::Relaxed);
    unsafe { std::mem::transmute(level_u8) }
  }

  #[inline(always)]
  pub fn send_event_fast(
    &self,
    log_level: u8,
    target_id: u16,
    message_id: Option<num::NonZeroU16>,
    thread_id: u8,
    file_id: u16,
    position: (u32, u32),
    kv_id: Option<num::NonZeroU16>,
  ) {
    let timestamp = SystemTime::now()
      .duration_since(UNIX_EPOCH)
      .unwrap_or_default()
      .as_millis() as u64;

    let event = LogEvent {
      packed_meta: LogEvent::pack_meta(
        timestamp,
        unsafe { std::mem::transmute::<u8, LogLevel>(log_level) },
        thread_id,
      ),
      target_id,
      message_id,
      position,
      file_id,
      kv_id,
    };

    // Add to snapshot buffer for periodic snapshots
    self.snapshot_buffer.push_overwrite(event.clone());

    // Broadcast to all listeners immediately - no buffering, no limits
    // Using unbounded channel ensures no events are lost
    if self
      .event_broadcast_sender
      .try_send(EventBroadcast { event })
      .is_err()
    {
      // If the channel is somehow full or closed, we could optionally log this
      // but we don't want to block the critical logging path
      eprintln!("[Trace] Warning: Failed to broadcast event to listeners");
    }
  }

  // Separate writer loop focused only on snapshots and control messages
  fn writer_loop(
    receiver: Receiver<Message>,
    capacity: usize,
    service_name: String,
    storage_path: String,
    mut snapshot_buffer: Arc<LockFreeRingBuffer<LogEvent>>,
    interner: Arc<StringInterner>,
  ) {
    let mut last_periodic = Instant::now();
    let periodic_flush_interval = Duration::seconds(60).to_std().unwrap();
    let service = SnapshotWriter::with_storage_path(service_name, storage_path);

    eprintln!(
      "[Trace] Writer thread started with buffer capacity: {}",
      capacity
    );

    loop {
      // Handle control messages with timeout to allow periodic snapshots
      match receiver.recv_timeout(periodic_flush_interval) {
        Ok(msg) => match msg {
          Message::SnapshotImmediate(reason, ack) => {
            eprintln!(
              "[Snapshot] Requested: {} (buffer has {} events)",
              reason,
              snapshot_buffer.len()
            );

            if !snapshot_buffer.is_empty() {
              if let Err(e) =
                service.snapshot_and_write(&mut snapshot_buffer, reason.clone(), interner.clone())
              {
                eprintln!("[Snapshot] failed: {}", e);
              } else {
                eprintln!("[Snapshot] completed successfully");
              }
            } else {
              eprintln!("[Snapshot] buffer empty, skipping snapshot");
            }
            let _ = ack.send(());
          },
          Message::FlushAndExit => {
            eprintln!("[Trace] Received shutdown signal");

            // Final snapshot with remaining events
            if !snapshot_buffer.is_empty() {
              let _ = service.snapshot_and_write(&mut snapshot_buffer, "flush_and_exit", interner);
            }

            eprintln!("[Trace] Writer thread shutting down");
            return;
          },
        },
        Err(_) => {
          // Timeout occurred - check for periodic snapshot
          if last_periodic.elapsed() >= periodic_flush_interval && !snapshot_buffer.is_empty() {
            eprintln!(
              "[Snapshot] Periodic snapshot triggered ({} events)",
              snapshot_buffer.len()
            );
            let _result =
              service.snapshot_and_write(&mut snapshot_buffer, "periodic", interner.clone());
            last_periodic = Instant::now();
          }
        },
      }
    }
  }

  // Dedicated listener loop - handles all listener events without limits
  fn listener_loop(
    listener_receiver: Receiver<ListenerMessage>,
    event_receiver: Receiver<EventBroadcast>,
    interner: Arc<StringInterner>,
  ) {
    let mut listeners: Vec<
      Arc<dyn LogListener + std::panic::UnwindSafe + std::panic::RefUnwindSafe>,
    > = Vec::new();

    println!("[Trace] Listener thread started");

    loop {
      crossbeam_channel::select! {
        recv(listener_receiver) -> msg => {
          match msg {
            Ok(ListenerMessage::Add(listener, ack)) => {
              listener.on_start();
              listeners.push(listener);
              eprintln!("[Trace] Added new listener, total: {}", listeners.len());
              let _ = ack.send(());
            },
            Ok(ListenerMessage::Shutdown) => {
              eprintln!("[Trace] Listener thread received shutdown signal");

              // Process any remaining events
              while let Ok(event_broadcast) = event_receiver.try_recv() {
                for listener in &listeners {
                  let _ = std::panic::catch_unwind(|| {
                    listener.handle(&event_broadcast.event, &interner);
                  });
                }
              }

              // Cleanup listeners
              for listener in &listeners {
                listener.on_shutdown();
              }

              eprintln!("[Trace] Listener thread shutting down");
              return;
            },
            Err(_) => {
              // Channel closed
              eprintln!("[Trace] Listener management channel closed");
              return;
            }
          }
        },
        recv(event_receiver) -> event_msg => {
          match event_msg {
            Ok(event_broadcast) => {
              // Broadcast to ALL listeners - no limits, no batching
              for listener in &listeners {
                let result = std::panic::catch_unwind(|| {
                  listener.handle(&event_broadcast.event, &interner);
                });

                if result.is_err() {
                  eprintln!("[Trace] Listener panicked, continuing with others");
                }
              }
            },
            Err(_) => {
              // Event channel closed
              eprintln!("[Trace] Event broadcast channel closed");
              return;
            }
          }
        }
      }
    }
  }
}

impl Clone for Trace {
  fn clone(&self) -> Self {
    Self {
      snapshot_buffer: Arc::clone(&self.snapshot_buffer),
      sender: self.sender.clone(),
      event_broadcast_sender: self.event_broadcast_sender.clone(),
      level: AtomicU8::new(self.level.load(Ordering::Relaxed)),
      interner: Arc::clone(&self.interner),
      listener_sender: self.listener_sender.clone(),
      write_thread: None,
      listener_thread: None,
    }
  }
}

impl Drop for Trace {
  fn drop(&mut self) {
    // If shutdown wasn't called explicitly
    let _ = self.listener_sender.try_send(ListenerMessage::Shutdown);
    let _ = self.sender.try_send(Message::FlushAndExit);

    if let Some(handle) = self.write_thread.take() {
      let _ = handle.join();
    }
    if let Some(handle) = self.listener_thread.take() {
      let _ = handle.join();
    }
  }
}