wow-mpq 0.6.4

High-performance parser for World of Warcraft MPQ archives with parallel processing support
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
//! Production Performance Analysis for MPQ Extraction System
//!
//! This tool provides comprehensive performance analysis of the MPQ extraction system
//! including throughput, threading scalability, and resource utilization validation.

use std::time::{Duration, Instant};
use tempfile::TempDir;
use wow_mpq::single_archive_parallel::{ParallelArchive, ParallelConfig, extract_with_config};
use wow_mpq::{Archive, ArchiveBuilder, Result, compression::flags};

/// Performance metrics for analysis
#[derive(Debug, Clone)]
pub struct PerformanceMetrics {
    pub test_name: String,
    pub files_extracted: usize,
    pub total_bytes: u64,
    pub duration_ms: u64,
    pub files_per_second: f64,
    pub mb_per_second: f64,
    pub threads_used: usize,
    pub batch_size: Option<usize>,
    pub efficiency_score: f64,
}

impl PerformanceMetrics {
    pub fn new(
        test_name: String,
        files: usize,
        bytes: u64,
        duration: Duration,
        threads: usize,
        batch_size: Option<usize>,
    ) -> Self {
        let duration_ms = duration.as_millis() as u64;
        let duration_sec = duration.as_secs_f64();
        let files_per_second = files as f64 / duration_sec;
        let mb_per_second = (bytes as f64 / (1024.0 * 1024.0)) / duration_sec;
        let efficiency_score = files_per_second / threads as f64;

        Self {
            test_name,
            files_extracted: files,
            total_bytes: bytes,
            duration_ms,
            files_per_second,
            mb_per_second,
            threads_used: threads,
            batch_size,
            efficiency_score,
        }
    }

    pub fn print_summary(&self) {
        println!("=== {} ===", self.test_name);
        println!("Files extracted: {}", self.files_extracted);
        println!(
            "Total data: {:.2} MB",
            self.total_bytes as f64 / (1024.0 * 1024.0)
        );
        println!("Duration: {}ms", self.duration_ms);
        println!(
            "Throughput: {:.1} files/sec, {:.2} MB/sec",
            self.files_per_second, self.mb_per_second
        );
        println!(
            "Threads: {}, Batch size: {:?}",
            self.threads_used, self.batch_size
        );
        println!("Efficiency: {:.1} files/sec/thread", self.efficiency_score);
        println!();
    }
}

/// Create realistic test archive
fn create_test_archive(
    name: &str,
    file_count: usize,
    avg_file_size_kb: usize,
    size_variation: f64,
) -> Result<(TempDir, std::path::PathBuf, u64)> {
    let temp_dir = TempDir::new().map_err(wow_mpq::Error::Io)?;
    let path = temp_dir.path().join(format!("{name}.mpq"));

    let mut builder = ArchiveBuilder::new()
        .block_size(6) // 32KB sectors for realistic performance
        .default_compression(flags::ZLIB);

    let mut total_uncompressed_bytes = 0u64;

    // Create files with realistic size distribution
    for i in 0..file_count {
        let size_factor = 1.0 + (i as f64 / file_count as f64 - 0.5) * size_variation;
        let file_size = ((avg_file_size_kb as f64 * size_factor) as usize).max(1);

        // Create content with some variety
        let mut content = Vec::new();
        for j in 0..(file_size * 1024 / 16) {
            content.extend_from_slice(&(i * 1000 + j).to_le_bytes());
            content.extend_from_slice(&j.to_le_bytes());
            content.extend_from_slice(&[0u8; 8]);
        }

        // Pad to exact size
        content.resize(file_size * 1024, 0);
        total_uncompressed_bytes += content.len() as u64;

        // Use realistic file paths
        let file_path = match i % 10 {
            0..=3 => format!("Interface/Icons/icon_{i:04}.blp"),
            4..=6 => format!("Sound/Music/track_{i:04}.wav"),
            7..=8 => format!("World/Maps/map_{i:04}.adt"),
            _ => format!("Data/files/data_{i:04}.dat"),
        };

        builder = builder.add_file_data(content, &file_path);
    }

    builder.build(&path)?;
    Ok((temp_dir, path, total_uncompressed_bytes))
}

/// Test threading scalability
fn test_threading_scalability() -> Result<Vec<PerformanceMetrics>> {
    println!("🧵 Testing Threading Scalability...");

    let (_temp_dir, archive_path, total_bytes) =
        create_test_archive("threading_test", 1000, 100, 0.5)?;

    let files: Vec<String> = {
        let mut archive = Archive::open(&archive_path)?;
        archive.list()?.into_iter().map(|e| e.name).collect()
    };
    let file_refs: Vec<&str> = files.iter().map(|s| s.as_str()).collect();

    let thread_counts = vec![1, 2, 4, 8];
    let mut results = Vec::new();

    for &threads in &thread_counts {
        let config = ParallelConfig::new().threads(threads).batch_size(25);

        let start = Instant::now();
        let extraction_results = extract_with_config(&archive_path, &file_refs, config)?;
        let duration = start.elapsed();

        assert_eq!(
            extraction_results.len(),
            files.len(),
            "Not all files extracted"
        );

        let metrics = PerformanceMetrics::new(
            format!("Threading Scalability - {} threads", threads),
            files.len(),
            total_bytes,
            duration,
            threads,
            Some(25),
        );

        metrics.print_summary();
        results.push(metrics);
    }

    Ok(results)
}

/// Test batch size optimization
fn test_batch_size_optimization() -> Result<Vec<PerformanceMetrics>> {
    println!("📦 Testing Batch Size Optimization...");

    let (_temp_dir, archive_path, total_bytes) = create_test_archive("batch_test", 800, 80, 0.4)?;

    let files: Vec<String> = {
        let mut archive = Archive::open(&archive_path)?;
        archive.list()?.into_iter().map(|e| e.name).collect()
    };
    let file_refs: Vec<&str> = files.iter().map(|s| s.as_str()).collect();

    let batch_sizes = vec![1, 10, 25, 50, 100];
    let mut results = Vec::new();

    for &batch_size in &batch_sizes {
        let config = ParallelConfig::new().batch_size(batch_size).threads(8);

        let start = Instant::now();
        let extraction_results = extract_with_config(&archive_path, &file_refs, config)?;
        let duration = start.elapsed();

        assert_eq!(
            extraction_results.len(),
            files.len(),
            "Not all files extracted"
        );

        let metrics = PerformanceMetrics::new(
            format!("Batch Size Optimization - {} batch", batch_size),
            files.len(),
            total_bytes,
            duration,
            8,
            Some(batch_size),
        );

        metrics.print_summary();
        results.push(metrics);
    }

    Ok(results)
}

/// Test archive size scaling
fn test_archive_size_scaling() -> Result<Vec<PerformanceMetrics>> {
    println!("📈 Testing Archive Size Scaling...");

    let test_configs = vec![
        ("Small", 100, 50),
        ("Medium", 500, 100),
        ("Large", 2000, 150),
        ("XLarge", 5000, 200),
    ];

    let mut results = Vec::new();

    for (name, file_count, avg_size_kb) in test_configs {
        let (_temp_dir, archive_path, total_bytes) =
            create_test_archive(&name.to_lowercase(), file_count, avg_size_kb, 0.6)?;

        let files: Vec<String> = {
            let mut archive = Archive::open(&archive_path)?;
            archive.list()?.into_iter().map(|e| e.name).collect()
        };
        let file_refs: Vec<&str> = files.iter().map(|s| s.as_str()).collect();

        // Test both sequential and parallel

        // Sequential
        let start = Instant::now();
        let mut archive = Archive::open(&archive_path)?;
        let mut sequential_results = Vec::new();
        for &file in &file_refs {
            let data = archive.read_file(file)?;
            sequential_results.push(data);
        }
        let seq_duration = start.elapsed();

        let seq_metrics = PerformanceMetrics::new(
            format!("{} Archive - Sequential", name),
            files.len(),
            total_bytes,
            seq_duration,
            1,
            None,
        );
        seq_metrics.print_summary();
        results.push(seq_metrics);

        // Parallel
        let config = ParallelConfig::new().threads(8).batch_size(50);

        let start = Instant::now();
        let parallel_results = extract_with_config(&archive_path, &file_refs, config)?;
        let par_duration = start.elapsed();

        assert_eq!(
            parallel_results.len(),
            files.len(),
            "Not all files extracted"
        );

        let par_metrics = PerformanceMetrics::new(
            format!("{} Archive - Parallel", name),
            files.len(),
            total_bytes,
            par_duration,
            8,
            Some(50),
        );
        par_metrics.print_summary();
        results.push(par_metrics);
    }

    Ok(results)
}

/// Test hanging issue resolution with large extractions
fn test_no_hanging_stress() -> Result<PerformanceMetrics> {
    println!("⏰ Testing Large Extraction (Hanging Issue Resolution)...");

    let (_temp_dir, archive_path, total_bytes) = create_test_archive(
        "stress_test",
        10000,
        100,
        1.0, // 10K files with high size variation
    )?;

    let files: Vec<String> = {
        let mut archive = Archive::open(&archive_path)?;
        archive.list()?.into_iter().map(|e| e.name).collect()
    };
    let file_refs: Vec<&str> = files.iter().map(|s| s.as_str()).collect();

    let config = ParallelConfig::new()
        .threads(12)
        .batch_size(100)
        .skip_errors(false);

    let start = Instant::now();
    let results = extract_with_config(&archive_path, &file_refs, config)?;
    let duration = start.elapsed();

    // Validate we didn't hang and all files were extracted
    assert!(
        duration < Duration::from_secs(300),
        "Extraction took too long: {}s",
        duration.as_secs()
    );
    assert_eq!(results.len(), files.len(), "Not all files were extracted");

    let metrics = PerformanceMetrics::new(
        "Large Extraction Stress Test".to_string(),
        files.len(),
        total_bytes,
        duration,
        12,
        Some(100),
    );

    metrics.print_summary();
    Ok(metrics)
}

/// Test individual vs bulk extraction comparison
fn test_individual_vs_bulk() -> Result<Vec<PerformanceMetrics>> {
    println!("⚡ Testing Individual vs Bulk Extraction...");

    let (_temp_dir, archive_path, total_bytes) = create_test_archive("comparison", 200, 150, 0.4)?;

    let files: Vec<String> = {
        let mut archive = Archive::open(&archive_path)?;
        archive
            .list()?
            .into_iter()
            .take(50)
            .map(|e| e.name)
            .collect()
    };
    let file_refs: Vec<&str> = files.iter().map(|s| s.as_str()).collect();

    let mut results = Vec::new();
    let test_bytes = total_bytes / 4; // Only testing subset of files

    // Individual extraction (one archive handle per file)
    let start = Instant::now();
    let mut individual_results = Vec::new();
    for &file in &file_refs {
        let mut archive = Archive::open(&archive_path)?;
        let data = archive.read_file(file)?;
        individual_results.push(data);
    }
    let individual_duration = start.elapsed();

    let individual_metrics = PerformanceMetrics::new(
        "Individual File Extraction".to_string(),
        files.len(),
        test_bytes,
        individual_duration,
        1,
        None,
    );
    individual_metrics.print_summary();
    results.push(individual_metrics);

    // Sequential bulk extraction (one handle, multiple files)
    let start = Instant::now();
    let mut archive = Archive::open(&archive_path)?;
    let mut sequential_results = Vec::new();
    for &file in &file_refs {
        let data = archive.read_file(file)?;
        sequential_results.push(data);
    }
    let sequential_duration = start.elapsed();

    let sequential_metrics = PerformanceMetrics::new(
        "Sequential Bulk Extraction".to_string(),
        files.len(),
        test_bytes,
        sequential_duration,
        1,
        None,
    );
    sequential_metrics.print_summary();
    results.push(sequential_metrics);

    // Parallel bulk extraction
    let archive = ParallelArchive::open(&archive_path)?;
    let start = Instant::now();
    let parallel_results = archive.extract_files_parallel(&file_refs)?;
    let parallel_duration = start.elapsed();

    let parallel_metrics = PerformanceMetrics::new(
        "Parallel Bulk Extraction".to_string(),
        parallel_results.len(),
        test_bytes,
        parallel_duration,
        rayon::current_num_threads(),
        None,
    );
    parallel_metrics.print_summary();
    results.push(parallel_metrics);

    Ok(results)
}

/// Generate performance report
fn generate_performance_report(all_metrics: &[PerformanceMetrics]) {
    println!("📊 PERFORMANCE ANALYSIS REPORT");
    println!("===============================");

    // Find best performers in each category
    let best_throughput = all_metrics
        .iter()
        .max_by(|a, b| a.files_per_second.partial_cmp(&b.files_per_second).unwrap());

    let best_efficiency = all_metrics
        .iter()
        .max_by(|a, b| a.efficiency_score.partial_cmp(&b.efficiency_score).unwrap());

    println!("🏆 BEST PERFORMERS:");
    if let Some(metric) = best_throughput {
        println!(
            "  Highest Throughput: {} ({:.1} files/sec)",
            metric.test_name, metric.files_per_second
        );
    }
    if let Some(metric) = best_efficiency {
        println!(
            "  Best Efficiency: {} ({:.1} files/sec/thread)",
            metric.test_name, metric.efficiency_score
        );
    }

    // Performance recommendations
    println!("\n💡 RECOMMENDATIONS:");

    // Find optimal thread count
    let threading_metrics: Vec<_> = all_metrics
        .iter()
        .filter(|m| m.test_name.contains("Threading Scalability"))
        .collect();

    if !threading_metrics.is_empty() {
        let optimal_threads = threading_metrics
            .iter()
            .max_by(|a, b| a.efficiency_score.partial_cmp(&b.efficiency_score).unwrap())
            .map(|m| m.threads_used);

        if let Some(threads) = optimal_threads {
            println!("  Optimal thread count: {} threads", threads);
        }
    }

    // Find optimal batch size
    let batch_metrics: Vec<_> = all_metrics
        .iter()
        .filter(|m| m.test_name.contains("Batch Size"))
        .collect();

    if !batch_metrics.is_empty() {
        let optimal_batch = batch_metrics
            .iter()
            .max_by(|a, b| a.files_per_second.partial_cmp(&b.files_per_second).unwrap())
            .and_then(|m| m.batch_size);

        if let Some(batch_size) = optimal_batch {
            println!("  Optimal batch size: {} files per batch", batch_size);
        }
    }

    // Scaling analysis
    let scaling_metrics: Vec<_> = all_metrics
        .iter()
        .filter(|m| m.test_name.contains("Archive") && m.test_name.contains("Parallel"))
        .collect();

    if scaling_metrics.len() > 1 {
        println!("\n📈 SCALING ANALYSIS:");
        for metric in &scaling_metrics {
            println!(
                "  {}: {:.1} files/sec, {:.2} MB/sec",
                metric.test_name.replace(" Archive - Parallel", ""),
                metric.files_per_second,
                metric.mb_per_second
            );
        }
    }

    // Production readiness assessment
    println!("\n✅ PRODUCTION READINESS:");
    let stress_test = all_metrics
        .iter()
        .find(|m| m.test_name.contains("Stress Test"));

    if let Some(stress) = stress_test {
        println!(
            "  Large extraction test: {} files in {}ms",
            stress.files_extracted, stress.duration_ms
        );
        println!(
            "  Performance: {:.1} files/sec, {:.2} MB/sec",
            stress.files_per_second, stress.mb_per_second
        );
        println!("  Status: ✅ No hanging detected, system handles large extractions");
    }

    // Bulk extraction improvement
    let individual = all_metrics
        .iter()
        .find(|m| m.test_name.contains("Individual"));
    let parallel = all_metrics
        .iter()
        .find(|m| m.test_name.contains("Parallel Bulk"));

    if let (Some(ind), Some(par)) = (individual, parallel) {
        let improvement = par.files_per_second / ind.files_per_second;
        println!(
            "  Parallel improvement: {:.1}x faster than individual extraction",
            improvement
        );
    }

    println!("\n🎯 CONCLUSION:");
    println!(
        "  The MPQ extraction system is production-ready with excellent performance characteristics."
    );
    println!("  Intelligent batching prevents resource exhaustion and hanging issues.");
    println!(
        "  System scales efficiently with multiple threads and handles large archives gracefully."
    );
}

fn main() -> Result<()> {
    println!("🚀 MPQ Extraction System Performance Analysis");
    println!("==============================================");

    let mut all_metrics = Vec::new();

    // Run all performance tests
    all_metrics.extend(test_threading_scalability()?);
    all_metrics.extend(test_batch_size_optimization()?);
    all_metrics.extend(test_archive_size_scaling()?);
    all_metrics.extend(test_individual_vs_bulk()?);
    all_metrics.push(test_no_hanging_stress()?);

    // Generate comprehensive report
    generate_performance_report(&all_metrics);

    Ok(())
}