ddex-parser 0.4.5

High-performance DDEX XML parser with SIMD optimization (40+ MB/s)
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
//! Performance analysis and profiling for streaming parser

use crate::error::ParseError;
use crate::streaming::working_impl::{WorkingStreamIterator, WorkingStreamingElement};
use ddex_core::models::versions::ERNVersion;
use std::io::Cursor;
use std::time::Instant;

/// Generate large test XML for performance testing
fn generate_large_test_file(target_size_bytes: usize) -> Vec<u8> {
    let mut xml = String::from(
        r#"<?xml version="1.0" encoding="UTF-8"?>
<ern:NewReleaseMessage xmlns:ern="http://ddex.net/xml/ern/43">
    <MessageHeader>
        <MessageId>PERF-TEST-MSG</MessageId>
        <CreatedDateTime>2023-01-01T00:00:00Z</CreatedDateTime>
    </MessageHeader>
"#,
    );

    // Calculate how many releases we need
    let single_release_size = 500; // Approximate size of one release
    let target_releases = (target_size_bytes / single_release_size).max(10);

    println!(
        "Generating {} releases for performance test",
        target_releases
    );

    for i in 0..target_releases {
        xml.push_str(&format!(
            r#"
    <Release ReleaseReference="PERF-REL-{:06}">
        <ReferenceTitle>
            <TitleText>Performance Test Release #{}</TitleText>
            <SubTitle>Benchmark Dataset</SubTitle>
        </ReferenceTitle>
        <Genre>
            <GenreText>Electronic</GenreText>
            <SubGenre>Ambient</SubGenre>
        </Genre>
        <PLine>
            <Year>2023</Year>
            <PLineText>℗ 2023 Test Label</PLineText>
        </PLine>
        <CLine>
            <Year>2023</Year>
            <CLineText>© 2023 Test Label</CLineText>
        </CLine>
        <ReleaseLabelReference>LBL-{:03}</ReleaseLabelReference>
    </Release>
"#,
            i,
            i,
            i % 100
        ));

        // Add some sound recordings too
        for j in 0..5 {
            let resource_ref = format!("PERF-RES-{:06}-{:02}", i, j);
            let isrc = format!("PERF{:08}", i * 100 + j);
            let track_title = format!("Track {} from Release {}", j + 1, i);
            let duration_min = (i * j + 180) % 10;
            let duration_sec = i % 60;
            let party_id = format!("00{:08}", i % 100);
            let artist_name = format!("Perf Artist {}", i % 1000);

            xml.push_str(&format!(
                r#"
    <SoundRecording ResourceReference="{}">
        <ResourceId>
            <ISRC>{}</ISRC>
        </ResourceId>
        <ReferenceTitle>
            <TitleText>{}</TitleText>
        </ReferenceTitle>
        <Duration>PT{}M{}S</Duration>
        <CreationDate>2023-01-01</CreationDate>
        <LanguageOfPerformance>en</LanguageOfPerformance>
        <ResourceContributor>
            <PartyId namespace="IPI">{}</PartyId>
            <PartyName>{}</PartyName>
            <ContributorRole>MainArtist</ContributorRole>
        </ResourceContributor>
    </SoundRecording>
"#,
                resource_ref, isrc, track_title, duration_min, duration_sec, party_id, artist_name
            ));
        }

        // Add progress feedback for large files
        if i > 0 && i % 1000 == 0 {
            println!(
                "Generated {} releases, file size: {:.1}MB",
                i,
                xml.len() as f64 / (1024.0 * 1024.0)
            );
        }
    }

    xml.push_str("</ern:NewReleaseMessage>");

    println!(
        "Generated test file: {:.2}MB with {} releases",
        xml.len() as f64 / (1024.0 * 1024.0),
        target_releases
    );

    xml.into_bytes()
}

/// Profile memory allocations and string operations
fn profile_memory_allocations() {
    let xml = r#"<?xml version="1.0" encoding="UTF-8"?>
<ern:NewReleaseMessage xmlns:ern="http://ddex.net/xml/ern/43">
    <Release ReleaseReference="MEM-TEST">
        <ReferenceTitle><TitleText>Memory Test</TitleText></ReferenceTitle>
    </Release>
</ern:NewReleaseMessage>"#;

    let iterations = 10_000;

    let start = Instant::now();
    for _ in 0..iterations {
        let cursor = Cursor::new(xml.as_bytes());
        let mut iterator = WorkingStreamIterator::new(cursor, ERNVersion::V4_3);
        let _: Vec<_> = iterator.collect();
    }
    let elapsed = start.elapsed();

    let per_iteration = elapsed.as_micros() as f64 / iterations as f64;
    println!(
        "Memory allocation profile: {:.2}μs per parse iteration",
        per_iteration
    );

    // This reveals string allocation overhead
}

/// Profile DOM parsing bottleneck
fn profile_dom_parsing() {
    let xml = r#"<?xml version="1.0" encoding="UTF-8"?>
<ern:NewReleaseMessage xmlns:ern="http://ddex.net/xml/ern/43">
    <Release ReleaseReference="DOM-TEST">
        <ReferenceTitle><TitleText>DOM Parsing Test</TitleText></ReferenceTitle>
    </Release>
</ern:NewReleaseMessage>"#;

    let cursor = Cursor::new(xml.as_bytes());
    let mut iterator = WorkingStreamIterator::new(cursor, ERNVersion::V4_3);

    let start = Instant::now();
    let mut event_count = 0;

    while let Some(result) = iterator.next() {
        if result.is_ok() {
            event_count += 1;
        }
    }

    let elapsed = start.elapsed();
    println!(
        "DOM parsing profile: {:?} for {} events, {:.2}μs per event",
        elapsed,
        event_count,
        elapsed.as_micros() as f64 / event_count as f64
    );
}

/// Profile string operations and text extraction
fn profile_string_operations() {
    // Test string creation overhead
    let test_strings = vec![
        "Short",
        "Medium length string for testing",
        "Very long string that would be typical of a DDEX release title or other metadata field that could be quite lengthy",
    ];

    let iterations = 100_000;

    for test_str in test_strings {
        let start = Instant::now();
        for _ in 0..iterations {
            let _owned: String = test_str.to_string();
        }
        let to_string_time = start.elapsed();

        let start = Instant::now();
        for _ in 0..iterations {
            let _owned: String = test_str.to_owned();
        }
        let to_owned_time = start.elapsed();

        let start = Instant::now();
        for _ in 0..iterations {
            let _owned: String = String::from(test_str);
        }
        let from_time = start.elapsed();

        println!("String '{}' ({} bytes):", test_str, test_str.len());
        println!(
            "  to_string(): {:.2}ns per op",
            to_string_time.as_nanos() as f64 / iterations as f64
        );
        println!(
            "  to_owned():  {:.2}ns per op",
            to_owned_time.as_nanos() as f64 / iterations as f64
        );
        println!(
            "  String::from(): {:.2}ns per op",
            from_time.as_nanos() as f64 / iterations as f64
        );
    }
}

/// Comprehensive performance analysis
pub struct PerformanceAnalyzer {
    results: Vec<BenchmarkResult>,
}

#[derive(Debug, Clone)]
pub struct BenchmarkResult {
    pub test_name: String,
    pub file_size_mb: f64,
    pub throughput_mb_per_sec: f64,
    pub elements_per_sec: u64,
    pub memory_peak_mb: f64,
    pub parse_time: std::time::Duration,
}

impl PerformanceAnalyzer {
    pub fn new() -> Self {
        Self {
            results: Vec::new(),
        }
    }

    pub fn benchmark_current_implementation(&mut self) -> Result<(), ParseError> {
        println!("🔍 Benchmarking current streaming implementation...\n");

        // Test different file sizes
        let test_sizes = vec![(1, "1MB"), (10, "10MB"), (50, "50MB"), (100, "100MB")];

        for (size_mb, name) in test_sizes {
            let target_bytes = size_mb * 1024 * 1024;
            let test_data = generate_large_test_file(target_bytes);

            println!(
                "Testing {}: {:.2}MB actual size",
                name,
                test_data.len() as f64 / (1024.0 * 1024.0)
            );

            let result = self.benchmark_data(&test_data, name)?;
            self.results.push(result);
        }

        self.analyze_bottlenecks();
        Ok(())
    }

    fn benchmark_data(&self, data: &[u8], test_name: &str) -> Result<BenchmarkResult, ParseError> {
        let cursor = Cursor::new(data);
        let mut iterator = WorkingStreamIterator::new(cursor, ERNVersion::V4_3);

        let start = Instant::now();
        let initial_stats = iterator.stats();

        let mut element_count = 0;
        let mut max_memory = 0;

        while let Some(result) = iterator.next() {
            result?; // Propagate parse errors
            element_count += 1;

            let stats = iterator.stats();
            max_memory = max_memory.max(stats.current_memory_bytes);

            // Sample memory every 1000 elements to avoid overhead
            if element_count % 1000 == 0 {
                // Memory sampling
            }
        }

        let parse_time = start.elapsed();
        let final_stats = iterator.stats();

        let file_size_mb = data.len() as f64 / (1024.0 * 1024.0);
        let throughput = file_size_mb / parse_time.as_secs_f64();
        let elements_per_sec = element_count as f64 / parse_time.as_secs_f64();

        let result = BenchmarkResult {
            test_name: test_name.to_string(),
            file_size_mb,
            throughput_mb_per_sec: throughput,
            elements_per_sec: elements_per_sec as u64,
            memory_peak_mb: max_memory as f64 / (1024.0 * 1024.0),
            parse_time,
        };

        println!("📊 {} Results:", test_name);
        println!("   Throughput:    {:.2} MB/s", result.throughput_mb_per_sec);
        println!("   Elements/sec:  {:.0}", result.elements_per_sec);
        println!("   Peak memory:   {:.2} MB", result.memory_peak_mb);
        println!("   Parse time:    {:.2}s", result.parse_time.as_secs_f64());
        println!();

        Ok(result)
    }

    fn analyze_bottlenecks(&self) {
        println!("🎯 BOTTLENECK ANALYSIS");
        println!("======================");

        if let Some(best) = self.results.iter().max_by(|a, b| {
            a.throughput_mb_per_sec
                .partial_cmp(&b.throughput_mb_per_sec)
                .unwrap()
        }) {
            println!(
                "Best throughput: {:.2} MB/s ({})",
                best.throughput_mb_per_sec, best.test_name
            );
        }

        let avg_throughput: f64 = self
            .results
            .iter()
            .map(|r| r.throughput_mb_per_sec)
            .sum::<f64>()
            / self.results.len() as f64;
        println!("Average throughput: {:.2} MB/s", avg_throughput);
        println!("TARGET throughput: 280 MB/s");
        println!("Required improvement: {:.0}x", 280.0 / avg_throughput);
        println!();

        println!("🚨 Identified bottlenecks:");
        if avg_throughput < 5.0 {
            println!(
                "   1. DOM-based parsing: Current implementation likely using full DOM parsing"
            );
            println!("   2. String allocations: Excessive String::clone() and to_string() calls");
            println!("   3. Memory allocations: Non-zero-copy buffer management");
            println!("   4. XML parser overhead: quick-xml may be suboptimal for streaming");
        }

        println!("\n💡 Optimization targets:");
        println!("   • Replace DOM parsing with streaming-native parsing");
        println!("   • Implement zero-copy string handling");
        println!("   • Use SIMD for pattern matching");
        println!("   • Optimize memory allocation patterns");
        println!("   • Consider specialized DDEX parsing instead of generic XML");
    }

    pub fn get_current_performance(&self) -> Option<f64> {
        self.results
            .iter()
            .map(|r| r.throughput_mb_per_sec)
            .max_by(|a, b| a.partial_cmp(b).unwrap())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_performance_analysis() {
        let mut analyzer = PerformanceAnalyzer::new();
        analyzer.benchmark_current_implementation().unwrap();

        // Ensure we have baseline metrics
        assert!(
            !analyzer.results.is_empty(),
            "Should have benchmark results"
        );

        if let Some(current_perf) = analyzer.get_current_performance() {
            println!("Current best performance: {:.2} MB/s", current_perf);
            println!(
                "Need {:.0}x improvement to reach 280 MB/s",
                280.0 / current_perf
            );
        }
    }

    #[test]
    fn test_chunk_size_optimization() {
        let xml = generate_large_test_file(10 * 1024 * 1024); // 10MB
        let chunk_sizes = vec![1024, 8192, 65536, 1048576]; // 1KB to 1MB

        println!("Chunk size optimization analysis:");

        for chunk_size in chunk_sizes {
            let start = Instant::now();
            let mut total_elements = 0;

            for chunk in xml.chunks(chunk_size) {
                let cursor = Cursor::new(chunk);
                let iterator = WorkingStreamIterator::new(cursor, ERNVersion::V4_3);
                total_elements += iterator.count();
            }

            let elapsed = start.elapsed();
            let throughput = xml.len() as f64 / elapsed.as_secs_f64() / 1_000_000.0;

            println!(
                "Chunk size {:8}: {:.2} MB/s ({} elements)",
                chunk_size, throughput, total_elements
            );
        }
    }

    #[test]
    fn test_memory_allocation_profiling() {
        profile_memory_allocations();
    }

    #[test]
    fn test_dom_parsing_profiling() {
        profile_dom_parsing();
    }

    #[test]
    fn test_string_operations_profiling() {
        profile_string_operations();
    }
}