innodb-utils 5.0.0

InnoDB file analysis toolkit
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
use std::collections::HashMap;
use std::io::Write;

use byteorder::{BigEndian, ByteOrder};
use colored::Colorize;
use rayon::prelude::*;

use crate::cli::{create_progress_bar, wprint, wprintln};
use crate::innodb::checksum;
use crate::innodb::page::{FilHeader, FspHeader};
use crate::innodb::page_types::PageType;
use crate::innodb::tablespace::Tablespace;
use crate::util::hex::format_offset;
use crate::IdbError;

/// Options for the parse subcommand.
pub struct ParseOptions {
    pub file: String,
    pub page: Option<u64>,
    pub verbose: bool,
    pub no_empty: bool,
    pub page_size: Option<u32>,
    pub json: bool,
    /// Output as CSV.
    pub csv: bool,
    pub keyring: Option<String>,
    /// Number of threads for parallel processing (0 = auto-detect).
    pub threads: usize,
    /// Use memory-mapped I/O for file access.
    pub mmap: bool,
    /// Stream results incrementally for lower memory usage.
    pub streaming: bool,
}

/// JSON-serializable page info.
#[derive(serde::Serialize)]
struct PageJson {
    page_number: u64,
    header: FilHeader,
    page_type_name: String,
    page_type_description: String,
    byte_start: u64,
    byte_end: u64,
    #[serde(skip_serializing_if = "Option::is_none")]
    fsp_header: Option<crate::innodb::page::FspHeader>,
}

/// Pre-parsed page data for parallel processing.
struct ParsedPage {
    page_num: u64,
    header: Option<FilHeader>,
    page_type: PageType,
}

/// Parse an InnoDB tablespace file and display page headers with a type summary.
///
/// Opens the tablespace, auto-detects (or uses the overridden) page size, then
/// iterates over every page reading the 38-byte FIL header to extract the
/// checksum, page number, prev/next page pointers, LSN, page type, and space ID.
/// Page 0 additionally displays the FSP header (space ID, tablespace size,
/// free-page limit, and flags).
///
/// When the tablespace has more than one page, all page data is read into memory
/// and headers are parsed in parallel using rayon. Results are collected in
/// page order for deterministic output.
///
/// In **single-page mode** (`-p N`), only the specified page is printed with
/// its full FIL header and trailer. In **full-file mode** (the default), all
/// pages are listed and a frequency summary table is appended showing how many
/// pages of each type exist. Pages with zero checksum and type `Allocated` are
/// skipped by default unless `--verbose` is set; `--no-empty` additionally
/// filters these from `--json` output.
///
/// With `--verbose`, each page also shows checksum validation status (algorithm,
/// stored vs. calculated values) and LSN consistency between header and trailer.
pub fn execute(opts: &ParseOptions, writer: &mut dyn Write) -> Result<(), IdbError> {
    let mut ts = crate::cli::open_tablespace(&opts.file, opts.page_size, opts.mmap)?;

    if let Some(ref keyring_path) = opts.keyring {
        crate::cli::setup_decryption(&mut ts, keyring_path)?;
    }

    let page_size = ts.page_size();

    // Streaming mode: process one page at a time, output immediately
    if opts.streaming && opts.page.is_none() {
        if opts.json {
            return execute_streaming_json(opts, &mut ts, page_size, writer);
        }
        return execute_streaming_text(opts, &mut ts, page_size, writer);
    }

    if opts.json {
        return execute_json(opts, &mut ts, page_size, writer);
    }

    if opts.csv {
        return execute_csv(opts, &mut ts, page_size, writer);
    }

    if let Some(page_num) = opts.page {
        // Single page mode — no parallelism needed
        let page_data = ts.read_page(page_num)?;
        print_page_info(writer, &page_data, page_num, page_size, opts.verbose)?;
    } else {
        // All pages mode — use parallel processing
        let page_count = ts.page_count();
        let ps = page_size as usize;

        // Read all pages into memory
        let all_data = ts.read_all_pages()?;

        // Print FSP header first
        let page0_data = &all_data[0..ps];
        if let Some(fsp) = FspHeader::parse(page0_data) {
            print_fsp_header(writer, &fsp)?;
            wprintln!(writer)?;
        }

        wprintln!(
            writer,
            "Pages in {} ({} pages, page size {}):",
            opts.file,
            page_count,
            page_size
        )?;
        wprintln!(writer, "{}", "-".repeat(50))?;

        // Create progress bar before parallel work so it tracks real progress
        let pb = create_progress_bar(page_count, "pages");

        // Parse headers in parallel to build type counts
        let parsed_pages: Vec<ParsedPage> = (0..page_count)
            .into_par_iter()
            .map(|page_num| {
                let offset = page_num as usize * ps;
                if offset + ps > all_data.len() {
                    pb.inc(1);
                    return ParsedPage {
                        page_num,
                        header: None,
                        page_type: PageType::Unknown(0),
                    };
                }
                let page_data = &all_data[offset..offset + ps];
                let header = FilHeader::parse(page_data);
                let page_type = header
                    .as_ref()
                    .map(|h| h.page_type)
                    .unwrap_or(PageType::Unknown(0));
                pb.inc(1);
                ParsedPage {
                    page_num,
                    header,
                    page_type,
                }
            })
            .collect();

        pb.finish_and_clear();

        let mut type_counts: HashMap<PageType, u64> = HashMap::new();

        for pp in &parsed_pages {
            let header = match &pp.header {
                Some(h) => h,
                None => continue,
            };

            *type_counts.entry(pp.page_type).or_insert(0) += 1;

            // Skip empty pages if --no-empty
            if opts.no_empty && header.checksum == 0 && header.page_type == PageType::Allocated {
                continue;
            }

            // Skip pages with zero checksum unless they are page 0
            if header.checksum == 0 && pp.page_num != 0 && !opts.verbose {
                continue;
            }

            let offset = pp.page_num as usize * ps;
            let page_data = &all_data[offset..offset + ps];
            print_page_info(writer, page_data, pp.page_num, page_size, opts.verbose)?;
        }

        // Print page type summary
        wprintln!(writer)?;
        wprintln!(writer, "{}", "Page Type Summary".bold())?;
        let mut sorted_types: Vec<_> = type_counts.iter().collect();
        sorted_types.sort_by(|a, b| b.1.cmp(a.1));
        for (pt, count) in sorted_types {
            let label = if *count == 1 { "page" } else { "pages" };
            wprintln!(writer, "  {:20} {:>6} {}", pt.name(), count, label)?;
        }
    }

    Ok(())
}

/// Streaming text mode: process pages one at a time via `for_each_page()`,
/// writing each result immediately. No progress bar, no bulk memory allocation.
fn execute_streaming_text(
    opts: &ParseOptions,
    ts: &mut Tablespace,
    page_size: u32,
    writer: &mut dyn Write,
) -> Result<(), IdbError> {
    let page_count = ts.page_count();

    // Print FSP header from page 0 first
    let page0_data = ts.read_page(0)?;
    if let Some(fsp) = FspHeader::parse(&page0_data) {
        print_fsp_header(writer, &fsp)?;
        wprintln!(writer)?;
    }

    wprintln!(
        writer,
        "Pages in {} ({} pages, page size {}):",
        opts.file,
        page_count,
        page_size
    )?;
    wprintln!(writer, "{}", "-".repeat(50))?;

    let mut type_counts: HashMap<PageType, u64> = HashMap::new();

    ts.for_each_page(|page_num, page_data| {
        let header = match FilHeader::parse(page_data) {
            Some(h) => h,
            None => return Ok(()),
        };

        let page_type = header.page_type;
        *type_counts.entry(page_type).or_insert(0) += 1;

        // Skip empty pages if --no-empty
        if opts.no_empty && header.checksum == 0 && header.page_type == PageType::Allocated {
            return Ok(());
        }

        // Skip pages with zero checksum unless they are page 0
        if header.checksum == 0 && page_num != 0 && !opts.verbose {
            return Ok(());
        }

        print_page_info(writer, page_data, page_num, page_size, opts.verbose)?;
        Ok(())
    })?;

    // Print page type summary
    wprintln!(writer)?;
    wprintln!(writer, "{}", "Page Type Summary".bold())?;
    let mut sorted_types: Vec<_> = type_counts.iter().collect();
    sorted_types.sort_by(|a, b| b.1.cmp(a.1));
    for (pt, count) in sorted_types {
        let label = if *count == 1 { "page" } else { "pages" };
        wprintln!(writer, "  {:20} {:>6} {}", pt.name(), count, label)?;
    }

    Ok(())
}

/// Streaming JSON mode: output NDJSON (one JSON object per line per page).
fn execute_streaming_json(
    opts: &ParseOptions,
    ts: &mut Tablespace,
    page_size: u32,
    writer: &mut dyn Write,
) -> Result<(), IdbError> {
    ts.for_each_page(|page_num, page_data| {
        let header = match FilHeader::parse(page_data) {
            Some(h) => h,
            None => return Ok(()),
        };

        if opts.no_empty && header.checksum == 0 && header.page_type == PageType::Allocated {
            return Ok(());
        }

        let pt = header.page_type;
        let byte_start = page_num * page_size as u64;
        let fsp_header = if page_num == 0 {
            FspHeader::parse(page_data)
        } else {
            None
        };

        let page_json = PageJson {
            page_number: page_num,
            page_type_name: pt.name().to_string(),
            page_type_description: pt.description().to_string(),
            byte_start,
            byte_end: byte_start + page_size as u64,
            header,
            fsp_header,
        };

        let line = serde_json::to_string(&page_json)
            .map_err(|e| IdbError::Parse(format!("JSON error: {}", e)))?;
        wprintln!(writer, "{}", line)?;
        Ok(())
    })?;

    Ok(())
}

/// Execute parse in CSV output mode.
fn execute_csv(
    opts: &ParseOptions,
    ts: &mut Tablespace,
    _page_size: u32,
    writer: &mut dyn Write,
) -> Result<(), IdbError> {
    wprintln!(
        writer,
        "page_number,checksum,page_type,lsn,space_id,prev_page,next_page"
    )?;

    let range: Box<dyn Iterator<Item = u64>> = if let Some(p) = opts.page {
        Box::new(std::iter::once(p))
    } else {
        Box::new(0..ts.page_count())
    };

    for page_num in range {
        let page_data = ts.read_page(page_num)?;
        let header = match FilHeader::parse(&page_data) {
            Some(h) => h,
            None => continue,
        };

        if opts.no_empty && header.checksum == 0 && header.page_type == PageType::Allocated {
            continue;
        }

        let prev = if header.has_prev() {
            header.prev_page.to_string()
        } else {
            String::new()
        };
        let next = if header.has_next() {
            header.next_page.to_string()
        } else {
            String::new()
        };

        wprintln!(
            writer,
            "{},{},{},{},{},{},{}",
            page_num,
            header.checksum,
            crate::cli::csv_escape(header.page_type.name()),
            header.lsn,
            header.space_id,
            prev,
            next
        )?;
    }
    Ok(())
}

/// Execute parse in JSON output mode.
fn execute_json(
    opts: &ParseOptions,
    ts: &mut Tablespace,
    page_size: u32,
    writer: &mut dyn Write,
) -> Result<(), IdbError> {
    if let Some(p) = opts.page {
        // Single page — no parallelism
        let page_data = ts.read_page(p)?;
        let header = match FilHeader::parse(&page_data) {
            Some(h) => h,
            None => {
                wprintln!(writer, "[]")?;
                return Ok(());
            }
        };

        let pt = header.page_type;
        let byte_start = p * page_size as u64;
        let fsp_header = if p == 0 {
            FspHeader::parse(&page_data)
        } else {
            None
        };

        let pages = vec![PageJson {
            page_number: p,
            page_type_name: pt.name().to_string(),
            page_type_description: pt.description().to_string(),
            byte_start,
            byte_end: byte_start + page_size as u64,
            header,
            fsp_header,
        }];

        let json = serde_json::to_string_pretty(&pages)
            .map_err(|e| IdbError::Parse(format!("JSON serialization error: {}", e)))?;
        wprintln!(writer, "{}", json)?;
        return Ok(());
    }

    // Full tablespace — read all then process in parallel
    let page_count = ts.page_count();
    let ps = page_size as usize;
    let all_data = ts.read_all_pages()?;

    let pages: Vec<Option<PageJson>> = (0..page_count)
        .into_par_iter()
        .map(|page_num| {
            let offset = page_num as usize * ps;
            if offset + ps > all_data.len() {
                return None;
            }
            let page_data = &all_data[offset..offset + ps];
            let header = match FilHeader::parse(page_data) {
                Some(h) => h,
                None => return None,
            };

            if opts.no_empty && header.checksum == 0 && header.page_type == PageType::Allocated {
                return None;
            }

            let pt = header.page_type;
            let byte_start = page_num * page_size as u64;
            let fsp_header = if page_num == 0 {
                FspHeader::parse(page_data)
            } else {
                None
            };

            Some(PageJson {
                page_number: page_num,
                page_type_name: pt.name().to_string(),
                page_type_description: pt.description().to_string(),
                byte_start,
                byte_end: byte_start + page_size as u64,
                header,
                fsp_header,
            })
        })
        .collect();

    let pages: Vec<PageJson> = pages.into_iter().flatten().collect();

    let json = serde_json::to_string_pretty(&pages)
        .map_err(|e| IdbError::Parse(format!("JSON serialization error: {}", e)))?;
    wprintln!(writer, "{}", json)?;
    Ok(())
}

/// Print detailed information about a single page.
fn print_page_info(
    writer: &mut dyn Write,
    page_data: &[u8],
    page_num: u64,
    page_size: u32,
    verbose: bool,
) -> Result<(), IdbError> {
    let header = match FilHeader::parse(page_data) {
        Some(h) => h,
        None => {
            eprintln!("Could not parse FIL header for page {}", page_num);
            return Ok(());
        }
    };

    let byte_start = page_num * page_size as u64;
    let byte_end = byte_start + page_size as u64;

    let pt = header.page_type;

    wprintln!(writer, "Page: {}", header.page_number)?;
    wprintln!(writer, "{}", "-".repeat(20))?;
    wprintln!(writer, "{}", "HEADER".bold())?;
    wprintln!(writer, "Byte Start: {}", format_offset(byte_start))?;
    wprintln!(
        writer,
        "Page Type: {}\n-- {}: {} - {}",
        pt.as_u16(),
        pt.name(),
        pt.description(),
        pt.usage()
    )?;

    if verbose {
        wprintln!(
            writer,
            "PAGE_N_HEAP (Amount of records in page): {}",
            read_page_n_heap(page_data)
        )?;
    }

    wprint!(writer, "Prev Page: ")?;
    if !header.has_prev() {
        wprintln!(writer, "Not used.")?;
    } else {
        wprintln!(writer, "{}", header.prev_page)?;
    }

    wprint!(writer, "Next Page: ")?;
    if !header.has_next() {
        wprintln!(writer, "Not used.")?;
    } else {
        wprintln!(writer, "{}", header.next_page)?;
    }

    wprintln!(writer, "LSN: {}", header.lsn)?;
    wprintln!(writer, "Space ID: {}", header.space_id)?;
    wprintln!(writer, "Checksum: {}", header.checksum)?;

    // Checksum validation
    let csum_result = checksum::validate_checksum(page_data, page_size, None);
    if verbose {
        let status = if csum_result.valid {
            "OK".green().to_string()
        } else {
            "MISMATCH".red().to_string()
        };
        wprintln!(
            writer,
            "Checksum Status: {} ({:?}, stored={}, calculated={})",
            status,
            csum_result.algorithm,
            csum_result.stored_checksum,
            csum_result.calculated_checksum
        )?;
    }

    wprintln!(writer)?;

    // Trailer
    let ps = page_size as usize;
    if page_data.len() >= ps {
        let trailer_offset = ps - 8;
        if let Some(trailer) = crate::innodb::page::FilTrailer::parse(&page_data[trailer_offset..])
        {
            wprintln!(writer, "{}", "TRAILER".bold())?;
            wprintln!(writer, "Old-style Checksum: {}", trailer.checksum)?;
            wprintln!(writer, "Low 32 bits of LSN: {}", trailer.lsn_low32)?;
            wprintln!(writer, "Byte End: {}", format_offset(byte_end))?;

            // LSN validation
            if verbose {
                let lsn_valid = checksum::validate_lsn(page_data, page_size);
                let lsn_status = if lsn_valid {
                    "OK".green().to_string()
                } else {
                    "MISMATCH".red().to_string()
                };
                wprintln!(writer, "LSN Consistency: {}", lsn_status)?;
            }
        }
    }
    wprintln!(writer, "{}", "-".repeat(20))?;
    Ok(())
}

/// Print FSP header information.
fn print_fsp_header(writer: &mut dyn Write, fsp: &FspHeader) -> Result<(), IdbError> {
    wprintln!(writer, "{}", "-".repeat(20))?;
    wprintln!(writer, "{}", "FSP_HDR - Filespace Header".bold())?;
    wprintln!(writer, "{}", "-".repeat(20))?;
    wprintln!(writer, "Space ID: {}", fsp.space_id)?;
    wprintln!(writer, "Size (pages): {}", fsp.size)?;
    wprintln!(writer, "Page Free Limit: {}", fsp.free_limit)?;
    wprintln!(writer, "Flags: {}", fsp.flags)?;
    Ok(())
}

/// Read PAGE_N_HEAP from the page header (INDEX page specific).
fn read_page_n_heap(page_data: &[u8]) -> u16 {
    let offset = crate::innodb::constants::FIL_PAGE_DATA + 4; // PAGE_N_HEAP is at FIL_PAGE_DATA + 4
    if page_data.len() < offset + 2 {
        return 0;
    }
    BigEndian::read_u16(&page_data[offset..])
}