freeswitch-sofia-trace-parser 0.6.1

Parser for FreeSWITCH mod_sofia SIP trace dump files
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
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
use std::collections::HashMap;
use std::fs::File;
use std::path::Path;

use freeswitch_sofia_trace_parser::types::{
    Direction, ParseStats, SkipReason, SkipTracking, Transport,
};
use freeswitch_sofia_trace_parser::FrameIterator;

fn sample_dir() -> &'static Path {
    Path::new("samples")
}

struct FrameParseResult {
    frames: Vec<freeswitch_sofia_trace_parser::Frame>,
    stats: ParseStats,
}

fn parse_sample(name: &str) -> FrameParseResult {
    let path = sample_dir().join(name);
    if !path.exists() {
        eprintln!("skipping {name}: file not found");
        return FrameParseResult {
            frames: vec![],
            stats: ParseStats::default(),
        };
    }
    let file = File::open(&path).unwrap();
    let mut iter = FrameIterator::new(file).skip_tracking(SkipTracking::TrackRegions);
    let mut errors = 0usize;
    let frames: Vec<_> = iter
        .by_ref()
        .filter_map(|r| match r {
            Ok(f) => Some(f),
            Err(_) => {
                errors += 1;
                None
            }
        })
        .collect();
    if errors > 0 {
        eprintln!("{name}: {errors} recovery errors skipped");
    }
    let stats = iter.stats().clone();
    FrameParseResult { frames, stats }
}

fn assert_parse_stats(stats: &ParseStats, name: &str, max_partial: usize) {
    let partial_count = stats
        .unparsed_regions
        .iter()
        .filter(|r| r.reason == SkipReason::PartialFirstFrame)
        .count();
    let invalid_count = stats
        .unparsed_regions
        .iter()
        .filter(|r| r.reason == SkipReason::InvalidHeader)
        .count();

    eprintln!(
        "{name}: bytes_read={}, bytes_skipped={}, regions={} (partial={partial_count}, invalid={invalid_count})",
        stats.bytes_read,
        stats.bytes_skipped,
        stats.unparsed_regions.len(),
    );

    assert!(
        partial_count <= max_partial,
        "{name}: expected at most {max_partial} partial first frame(s), got {partial_count}"
    );
    assert_eq!(
        invalid_count, 0,
        "{name}: expected zero invalid header skips, got {invalid_count}"
    );
}

fn assert_all_frames_valid(frames: &[freeswitch_sofia_trace_parser::Frame], name: &str) {
    assert!(!frames.is_empty(), "{name}: no frames parsed");
    for (i, frame) in frames.iter().enumerate() {
        assert!(
            !frame.content.is_empty(),
            "{name}: frame {i} has empty content"
        );
        assert!(
            !frame.address.is_empty(),
            "{name}: frame {i} has empty address"
        );
    }
}

fn count_by_direction(frames: &[freeswitch_sofia_trace_parser::Frame]) -> (usize, usize) {
    let recv = frames
        .iter()
        .filter(|f| f.direction == Direction::Recv)
        .count();
    let sent = frames
        .iter()
        .filter(|f| f.direction == Direction::Sent)
        .count();
    (recv, sent)
}

#[test]
fn esinet1_v4_tcp() {
    let result = parse_sample("esinet1-v4-tcp.dump.20");
    let frames = &result.frames;
    if frames.is_empty() {
        return;
    }
    assert_all_frames_valid(frames, "esinet1-v4-tcp");
    assert_parse_stats(&result.stats, "esinet1-v4-tcp.dump.20", 1);

    // All frames should be TCP
    assert!(
        frames.iter().all(|f| f.transport == Transport::Tcp),
        "expected all TCP frames"
    );

    // Should have both recv and sent
    let (recv, sent) = count_by_direction(frames);
    assert!(recv > 0, "expected recv frames");
    assert!(sent > 0, "expected sent frames");

    eprintln!(
        "esinet1-v4-tcp.dump.20: {} frames ({} recv, {} sent)",
        frames.len(),
        recv,
        sent
    );

    // Verify byte_count matches content length for most frames
    let mismatches: Vec<_> = frames
        .iter()
        .enumerate()
        .filter(|(_, f)| f.byte_count != f.content.len())
        .collect();
    eprintln!(
        "  byte_count mismatches: {}/{}",
        mismatches.len(),
        frames.len()
    );

    // Verify addresses are bracketed IPv4 (e.g. [184.150.75.232]:17270)
    for frame in frames.iter().take(10) {
        assert!(
            frame.address.contains(':'),
            "address should contain port: {}",
            frame.address
        );
    }
}

#[test]
fn esinet1_v4_udp() {
    let result = parse_sample("esinet1-v4-udp.dump.20");
    let frames = &result.frames;
    if frames.is_empty() {
        return;
    }
    assert_all_frames_valid(frames, "esinet1-v4-udp");
    assert_parse_stats(&result.stats, "esinet1-v4-udp.dump.20", 1);

    assert!(
        frames.iter().all(|f| f.transport == Transport::Udp),
        "expected all UDP frames"
    );

    let (recv, sent) = count_by_direction(frames);
    eprintln!(
        "esinet1-v4-udp.dump.20: {} frames ({} recv, {} sent)",
        frames.len(),
        recv,
        sent
    );

    // UDP frames should have byte_count == content.len() (no reassembly needed)
    let mismatches = frames
        .iter()
        .filter(|f| f.byte_count != f.content.len())
        .count();
    eprintln!("  byte_count mismatches: {}/{}", mismatches, frames.len());
}

#[test]
fn esinet1_v6_tls() {
    let result = parse_sample("esinet1-v6-tls.dump.20");
    let frames = &result.frames;
    if frames.is_empty() {
        return;
    }
    assert_all_frames_valid(frames, "esinet1-v6-tls");
    assert_parse_stats(&result.stats, "esinet1-v6-tls.dump.20", 1);

    assert!(
        frames.iter().all(|f| f.transport == Transport::Tls),
        "expected all TLS frames"
    );

    // Addresses should be IPv6 bracketed
    for frame in frames.iter().take(10) {
        assert!(
            frame.address.starts_with('['),
            "expected IPv6 bracketed address: {}",
            frame.address
        );
    }

    let (recv, sent) = count_by_direction(frames);
    eprintln!(
        "esinet1-v6-tls.dump.20: {} frames ({} recv, {} sent)",
        frames.len(),
        recv,
        sent
    );
}

#[test]
fn internal_v4() {
    let result = parse_sample("internal-v4.dump.20");
    let frames = &result.frames;
    if frames.is_empty() {
        return;
    }
    assert_all_frames_valid(frames, "internal-v4");
    assert_parse_stats(&result.stats, "internal-v4.dump.20", 1);

    assert!(
        frames.iter().all(|f| f.transport == Transport::Tcp),
        "expected all TCP frames"
    );

    // Internal addresses should be private IPv4 (10.x)
    let private_count = frames
        .iter()
        .filter(|f| f.address.starts_with("[10."))
        .count();
    eprintln!(
        "internal-v4.dump.20: {} frames, {} with 10.x addresses",
        frames.len(),
        private_count
    );
}

#[test]
fn internal_v6() {
    let result = parse_sample("internal-v6.dump.20");
    let frames = &result.frames;
    if frames.is_empty() {
        return;
    }
    assert_all_frames_valid(frames, "internal-v6");
    assert_parse_stats(&result.stats, "internal-v6.dump.20", 1);

    assert!(
        frames.iter().all(|f| f.transport == Transport::Tcp),
        "expected all TCP frames"
    );

    // Internal addresses should be ULA (fd51::)
    let ula_count = frames
        .iter()
        .filter(|f| f.address.starts_with("[fd"))
        .count();
    eprintln!(
        "internal-v6.dump.20: {} frames, {} with fd:: addresses",
        frames.len(),
        ula_count
    );
}

#[test]
fn esinet1_v6_tcp() {
    let result = parse_sample("esinet1-v6-tcp.dump.205");
    let frames = &result.frames;
    if frames.is_empty() {
        return;
    }
    assert_all_frames_valid(frames, "esinet1-v6-tcp");
    assert_parse_stats(&result.stats, "esinet1-v6-tcp.dump.205", 1);

    assert!(
        frames.iter().all(|f| f.transport == Transport::Tcp),
        "expected all TCP frames"
    );

    for frame in frames.iter().take(10) {
        assert!(
            frame.address.starts_with('['),
            "expected IPv6 bracketed address: {}",
            frame.address
        );
    }

    let (recv, sent) = count_by_direction(frames);
    assert!(recv > 0, "expected recv frames");
    assert!(sent > 0, "expected sent frames");

    eprintln!(
        "esinet1-v6-tcp.dump.205: {} frames ({} recv, {} sent)",
        frames.len(),
        recv,
        sent
    );

    let mismatches = frames
        .iter()
        .filter(|f| f.byte_count != f.content.len())
        .count();
    eprintln!("  byte_count mismatches: {}/{}", mismatches, frames.len());
}

#[test]
fn esinet1_v6_udp() {
    let result = parse_sample("esinet1-v6-udp.dump.205");
    let frames = &result.frames;
    if frames.is_empty() {
        return;
    }
    assert_all_frames_valid(frames, "esinet1-v6-udp");
    assert_parse_stats(&result.stats, "esinet1-v6-udp.dump.205", 1);

    assert!(
        frames.iter().all(|f| f.transport == Transport::Udp),
        "expected all UDP frames"
    );

    for frame in frames.iter().take(10) {
        assert!(
            frame.address.starts_with('['),
            "expected IPv6 bracketed address: {}",
            frame.address
        );
    }

    let (recv, sent) = count_by_direction(frames);
    eprintln!(
        "esinet1-v6-udp.dump.205: {} frames ({} recv, {} sent)",
        frames.len(),
        recv,
        sent
    );

    let mismatches = frames
        .iter()
        .filter(|f| f.byte_count != f.content.len())
        .count();
    eprintln!("  byte_count mismatches: {}/{}", mismatches, frames.len());
}

#[test]
fn esinet1_v4_tls() {
    let result = parse_sample("esinet1-v4-tls.dump.193");
    let frames = &result.frames;
    if frames.is_empty() {
        return;
    }
    assert_all_frames_valid(frames, "esinet1-v4-tls");
    assert_parse_stats(&result.stats, "esinet1-v4-tls.dump.193", 1);

    assert!(
        frames.iter().all(|f| f.transport == Transport::Tls),
        "expected all TLS frames"
    );

    let (recv, sent) = count_by_direction(frames);
    eprintln!(
        "esinet1-v4-tls.dump.193: {} frames ({} recv, {} sent)",
        frames.len(),
        recv,
        sent
    );
}

#[test]
fn all_samples_consistent_frame_counts() {
    // Parse multiple rotated files of same type, verify they all parse without error
    let prefixes = [
        "esinet1-v4-tcp.dump",
        "esinet1-v4-tls.dump",
        "esinet1-v4-udp.dump",
        "esinet1-v6-tcp.dump",
        "esinet1-v6-tls.dump",
        "esinet1-v6-udp.dump",
        "internal-v4.dump",
        "internal-v6.dump",
    ];

    let dir = sample_dir();
    if !dir.exists() {
        eprintln!("skipping: samples/ not found");
        return;
    }

    for prefix in &prefixes {
        let mut files: Vec<String> = std::fs::read_dir(dir)
            .unwrap()
            .filter_map(Result::ok)
            .filter_map(|e| {
                let name = e.file_name().to_string_lossy().to_string();
                if name.starts_with(prefix)
                    && !name.ends_with(".xz")
                    && name.len() > prefix.len() + 1
                    && name.as_bytes()[prefix.len()] == b'.'
                    && name[prefix.len() + 1..].bytes().all(|b| b.is_ascii_digit())
                {
                    Some(name)
                } else {
                    None
                }
            })
            .collect();
        files.sort();

        if files.is_empty() {
            continue;
        }

        eprintln!("{prefix}: ({} files)", files.len());
        for name in &files {
            let file = File::open(dir.join(name)).unwrap();
            let mut iter = FrameIterator::new(file).skip_tracking(SkipTracking::TrackRegions);
            let frame_count = iter.by_ref().filter_map(Result::ok).count();
            let stats = iter.stats();
            eprintln!(
                "  {name}: {frame_count} frames, skipped={}",
                stats.bytes_skipped
            );
            assert_parse_stats(stats, name, 1);
        }
    }
}

#[test]
fn tcp_has_multiframe_sequences() {
    let result = parse_sample("esinet1-v4-tcp.dump.20");
    let frames = &result.frames;
    if frames.is_empty() {
        return;
    }

    // Find consecutive recv frames from same address (multi-frame SIP messages)
    let mut consecutive_runs = 0;
    let mut max_run = 0;
    let mut current_run = 1;

    for i in 1..frames.len() {
        if frames[i].direction == frames[i - 1].direction
            && frames[i].address == frames[i - 1].address
        {
            current_run += 1;
        } else {
            if current_run > 1 {
                consecutive_runs += 1;
                max_run = max_run.max(current_run);
            }
            current_run = 1;
        }
    }
    if current_run > 1 {
        consecutive_runs += 1;
        max_run = max_run.max(current_run);
    }

    eprintln!(
        "esinet1-v4-tcp: {consecutive_runs} multi-frame sequences, max run length: {max_run}"
    );
    assert!(
        consecutive_runs > 0,
        "expected at least one multi-frame sequence in TCP dump"
    );
}

#[test]
fn byte_count_distribution() {
    let result = parse_sample("esinet1-v4-tcp.dump.20");
    let frames = &result.frames;
    if frames.is_empty() {
        return;
    }

    let mut sizes: HashMap<usize, usize> = HashMap::new();
    for f in frames {
        *sizes.entry(f.byte_count).or_default() += 1;
    }

    let mut top: Vec<_> = sizes.into_iter().collect();
    top.sort_by(|a, b| b.1.cmp(&a.1));

    eprintln!("esinet1-v4-tcp byte_count distribution (top 10):");
    for (size, count) in top.iter().take(10) {
        eprintln!("  {size} bytes: {count} frames");
    }

    // 1440 should be common (TCP MSS segments from multi-frame messages)
    let mss_count = frames.iter().filter(|f| f.byte_count == 1440).count();
    eprintln!("  frames with 1440 bytes (TCP MSS): {mss_count}");
}

#[test]
fn file_concatenation_two_dumps() {
    // Simulates: cat dump.29 dump.28 | parser
    // Each file starts with a truncated first frame — the parser should handle
    // the join point gracefully via byte_count-aware boundary detection.
    let path1 = sample_dir().join("esinet1-v4-tcp.dump.29");
    let path2 = sample_dir().join("esinet1-v4-tcp.dump.28");
    if !path1.exists() || !path2.exists() {
        eprintln!("skipping file_concatenation_two_dumps: files not found");
        return;
    }

    // Parse each file individually (filter errors from recovery)
    let count1 = FrameIterator::new(File::open(&path1).unwrap())
        .filter_map(Result::ok)
        .count();
    let count2 = FrameIterator::new(File::open(&path2).unwrap())
        .filter_map(Result::ok)
        .count();

    // Parse concatenated stream
    let chain = std::io::Read::chain(File::open(&path1).unwrap(), File::open(&path2).unwrap());
    let mut combined_iter = FrameIterator::new(chain).skip_tracking(SkipTracking::TrackRegions);
    let combined_frames: Vec<_> = combined_iter.by_ref().filter_map(Result::ok).collect();

    // The concatenated parse should recover: we may lose the truncated first frame
    // of file 2 (absorbed or skipped), but the rest should parse fine.
    // Allow a small tolerance for the join point.
    let combined_count = combined_frames.len();
    let expected_min = count1 + count2 - 2; // at most 2 frames lost at join
    let expected_max = count1 + count2;

    eprintln!("dump.29: {count1} frames, dump.28: {count2} frames");
    eprintln!("concatenated: {combined_count} frames (expected {expected_min}..={expected_max})");

    assert!(
        combined_count >= expected_min && combined_count <= expected_max,
        "concatenated frame count {combined_count} outside expected range {expected_min}..={expected_max}"
    );

    // Verify zero byte_count mismatches in concatenated parse
    let mismatches = combined_frames
        .iter()
        .filter(|f| f.byte_count != f.content.len())
        .count();
    eprintln!("  byte_count mismatches: {mismatches}/{combined_count}");
    assert_eq!(
        mismatches, 0,
        "concatenated parse should have zero byte_count mismatches"
    );

    // Two files chained: at most 2 partial first frames (one per file boundary)
    assert_parse_stats(combined_iter.stats(), "concatenated dump.29+dump.28", 2);
}

#[test]
fn esinet1_v4_tcp_150() {
    let result = parse_sample("esinet1-v4-tcp.dump.150");
    let frames = &result.frames;
    if frames.is_empty() {
        return;
    }
    assert_all_frames_valid(frames, "esinet1-v4-tcp.dump.150");
    assert_parse_stats(&result.stats, "esinet1-v4-tcp.dump.150", 1);

    assert!(
        frames.iter().all(|f| f.transport == Transport::Tcp),
        "expected all TCP frames"
    );

    let (recv, sent) = count_by_direction(frames);
    assert!(recv > 0, "expected recv frames");
    assert!(sent > 0, "expected sent frames");

    let mismatches: Vec<_> = frames
        .iter()
        .enumerate()
        .filter(|(_, f)| f.byte_count != f.content.len())
        .collect();

    eprintln!(
        "esinet1-v4-tcp.dump.150: {} frames ({} recv, {} sent), {} byte_count mismatches",
        frames.len(),
        recv,
        sent,
        mismatches.len(),
    );
}