macho-objc 0.5.0

Objective-C metadata parsing for Mach-O images
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
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
use macho_core::format::io::pod::{
    self, RawClassRoT64, RawMethodListHeader, RawMethodT, RawRelativeMethodT,
};
use macho_core::model::addr::{ThinFileOffset, Va};
use macho_core::model::macho_file::MachoFile;
use macho_core::model::section::Section;

use crate::error::{Error, Result};
use crate::resolve::{ObjCPointerProvenance, ObjCResolver};
use crate::types::{
    METHOD_LIST_ENTSIZE_MASK, METHOD_LIST_USES_DIRECT_SELECTOR_OFFSETS,
    METHOD_LIST_USES_RELATIVE_OFFSETS,
};

/// Objective-C method dispatch kind.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ObjCMethodKind {
    /// Instance method (`-`).
    Instance,
    /// Class method (`+`).
    Class,
}

/// Storage and decoding provenance for one Objective-C method-list entry.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ObjCMethodRecordProvenance {
    /// Exact thin-file offset containing the method record.
    pub record_file_offset: ThinFileOffset,
    /// Runtime address corresponding to the first byte of the record.
    pub record_va: Va,
    /// Encoded record size selected by the method-list header.
    pub record_size: u64,
    /// Absolute-pointer or relative-field decoding details.
    pub encoding: ObjCMethodRecordEncoding,
}

/// Pointer or relative-field representation used by one method record.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ObjCMethodRecordEncoding {
    /// Three pointer-sized fields, each retaining its fixup provenance.
    Absolute {
        /// Selector-name pointer provenance.
        selector_pointer: ObjCPointerProvenance,
        /// Type-encoding pointer provenance.
        type_encoding_pointer: ObjCPointerProvenance,
        /// Implementation pointer provenance.
        implementation_pointer: ObjCPointerProvenance,
    },
    /// Three signed 32-bit offsets relative to their own field addresses.
    Relative {
        /// Runtime address used as the selector-offset basis.
        selector_field_va: Va,
        /// Runtime address used as the type-encoding-offset basis.
        type_encoding_field_va: Va,
        /// Runtime address used as the implementation-offset basis.
        implementation_field_va: Va,
        /// Direct-string or indirect-selector-reference representation.
        selector: ObjCRelativeSelectorEncoding,
    },
}

/// Selector representation selected by a relative method-list header.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ObjCRelativeSelectorEncoding {
    /// The relative offset reaches the selector string directly.
    DirectString {
        /// Exact file offset of the selector cstring.
        selector_string_file_offset: ThinFileOffset,
    },
    /// The relative offset reaches a pointer to the selector string.
    IndirectReference {
        /// Exact file offset of the selector-reference pointer.
        selector_reference_file_offset: ThinFileOffset,
        /// Fixup provenance of that pointer.
        selector_reference_pointer: ObjCPointerProvenance,
    },
}

/// One parsed Objective-C method record with exact storage provenance.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ObjCMethodRecord {
    /// Runtime address of the owning class, metaclass, or category record.
    pub owner_va: Va,
    /// Owning class name.
    pub class_name: String,
    /// Owning category name, when the method comes from a category.
    pub category_name: Option<String>,
    /// Selector spelling.
    pub method_name: String,
    /// Raw Objective-C type encoding.
    pub type_encoding: String,
    /// Instance or class dispatch kind.
    pub kind: ObjCMethodKind,
    /// Resolved implementation virtual address.
    pub imp: Va,
    /// Exact record storage and pointer/relative decoding provenance.
    pub provenance: ObjCMethodRecordProvenance,
}

/// One parsed Objective-C implementation entry.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ObjCMethodImp {
    /// Owning class name.
    pub class_name: String,
    /// Owning category name, when the method comes from a category.
    pub category_name: Option<String>,
    /// Selector spelling.
    pub method_name: String,
    /// Instance or class dispatch kind.
    pub kind: ObjCMethodKind,
    /// Implementation virtual address.
    pub imp: Va,
}

/// Fold class and category method implementations into caller-owned state.
///
/// Runtime pointer lists and method lists are traversed directly; no complete
/// Objective-C graph or method vector is materialized. The state is returned
/// only after every nested pointer, name, method entry, and implementation
/// address parses successfully. A malformed suffix therefore drops the partial
/// accumulator and returns only the typed parse error.
pub fn fold_method_imps<State>(
    macho: &MachoFile<'_>,
    state: State,
    mut folder: impl FnMut(&mut State, ObjCMethodImp) -> Result<()>,
) -> Result<State> {
    fold_method_records(macho, state, |state, record| {
        folder(
            state,
            ObjCMethodImp {
                class_name: record.class_name,
                category_name: record.category_name,
                method_name: record.method_name,
                kind: record.kind,
                imp: record.imp,
            },
        )
    })
}

/// Fold strict method records with exact storage and decoding provenance.
pub fn fold_method_records<State>(
    macho: &MachoFile<'_>,
    mut state: State,
    mut folder: impl FnMut(&mut State, ObjCMethodRecord) -> Result<()>,
) -> Result<State> {
    if !macho.is_64bit() {
        return Err(Error::unsupported(
            "ObjC method implementation parsing is only supported for 64-bit binaries",
        ));
    }
    let resolver = ObjCResolver::new(macho)?;
    let (class_list, category_list) = runtime_lists(macho);
    if let Some(section) = class_list {
        fold_pointer_list(macho, &resolver, section, |class_va| {
            fold_class(&resolver, class_va, &mut state, &mut folder)
        })?;
    }
    if let Some(section) = category_list {
        fold_pointer_list(macho, &resolver, section, |category_va| {
            fold_category(&resolver, category_va, &mut state, &mut folder)
        })?;
    }
    Ok(state)
}

/// Fold method implementations from one borrowed thin Mach-O byte source.
///
/// The source is not copied and may be a byte slice, vector, or caller-owned
/// read-only memory map. Universal binaries require explicit architecture
/// selection through [`macho_core::parse`] and [`fold_method_imps`].
pub fn fold_method_imps_from_source<S, State>(
    source: &S,
    state: State,
    folder: impl FnMut(&mut State, ObjCMethodImp) -> Result<()>,
) -> Result<State>
where
    S: AsRef<[u8]> + ?Sized,
{
    let macho = crate::parse_source(source)?;
    fold_method_imps(&macho, state, folder)
}

/// Fold strict method records from one borrowed thin Mach-O byte source.
pub fn fold_method_records_from_source<S, State>(
    source: &S,
    state: State,
    folder: impl FnMut(&mut State, ObjCMethodRecord) -> Result<()>,
) -> Result<State>
where
    S: AsRef<[u8]> + ?Sized,
{
    let macho = crate::parse_source(source)?;
    fold_method_records(&macho, state, folder)
}

fn runtime_lists<'macho>(
    macho: &'macho MachoFile<'_>,
) -> (Option<&'macho Section>, Option<&'macho Section>) {
    let mut classes = None;
    let mut categories = None;
    for section in macho.all_sections() {
        if section.section_name() == "__objc_classlist" && classes.is_none() {
            classes = Some(section);
        } else if section.section_name() == "__objc_catlist" && categories.is_none() {
            categories = Some(section);
        }
    }
    (classes, categories)
}

fn fold_pointer_list(
    macho: &MachoFile<'_>,
    resolver: &ObjCResolver<'_>,
    section: &Section,
    mut visitor: impl FnMut(Va) -> Result<()>,
) -> Result<()> {
    let offset = section.offset().0;
    let size = section.size();
    if size % 8 != 0 {
        return Err(Error::format(format!(
            "section {} size {size:#x} is not pointer-aligned",
            section.section_name()
        )));
    }
    let end = offset
        .checked_add(size)
        .ok_or_else(|| Error::address("Objective-C pointer-list range overflows"))?;
    if end > macho.file_size() as u64 {
        return Err(Error::bounds(offset, size, macho.file_size() as u64));
    }
    for ordinal in 0..size / 8 {
        let pointer_offset = offset
            .checked_add(ordinal * 8)
            .ok_or_else(|| Error::address("Objective-C pointer offset overflows"))?;
        let runtime_va = resolver
            .read_pointer_at_offset(pointer_offset)?
            .filter(|va| va.0 != 0)
            .ok_or_else(|| {
                Error::format(format!(
                    "{}[{ordinal}] has a null or unresolved runtime pointer",
                    section.section_name()
                ))
            })?;
        visitor(runtime_va)?;
    }
    Ok(())
}

fn fold_class<State>(
    resolver: &ObjCResolver<'_>,
    class_va: Va,
    state: &mut State,
    folder: &mut impl FnMut(&mut State, ObjCMethodRecord) -> Result<()>,
) -> Result<()> {
    let class_offset = resolver.va_to_offset(class_va)?.0;
    let data_va = required_pointer(
        resolver,
        checked_field_offset(class_offset, 32, "class data")?,
        "class data",
    )?;
    let ro_offset = resolver
        .va_to_offset(Va(data_va.0 & crate::types::CLASS_DATA_POINTER_MASK))?
        .0;
    let _: RawClassRoT64 = pod::read_pod(resolver.macho().bytes(), ro_offset as usize)?;
    let class_name = required_cstring_pointer(
        resolver,
        checked_field_offset(ro_offset, 24, "class name")?,
        "class name",
    )?;

    fold_optional_method_list(
        resolver,
        checked_field_offset(ro_offset, 32, "class methods")?,
        class_va,
        &class_name,
        None,
        ObjCMethodKind::Instance,
        state,
        folder,
    )?;
    if let Some(meta_va) = resolver.read_pointer_at_offset(class_offset)? {
        let meta_offset = resolver.va_to_offset(meta_va)?.0;
        let meta_data = required_pointer(
            resolver,
            checked_field_offset(meta_offset, 32, "metaclass data")?,
            "metaclass data",
        )?;
        let meta_ro_offset = resolver
            .va_to_offset(Va(meta_data.0 & crate::types::CLASS_DATA_POINTER_MASK))?
            .0;
        let _: RawClassRoT64 = pod::read_pod(resolver.macho().bytes(), meta_ro_offset as usize)?;
        fold_optional_method_list(
            resolver,
            checked_field_offset(meta_ro_offset, 32, "metaclass methods")?,
            meta_va,
            &class_name,
            None,
            ObjCMethodKind::Class,
            state,
            folder,
        )?;
    }
    Ok(())
}

fn fold_category<State>(
    resolver: &ObjCResolver<'_>,
    category_va: Va,
    state: &mut State,
    folder: &mut impl FnMut(&mut State, ObjCMethodRecord) -> Result<()>,
) -> Result<()> {
    let offset = resolver.va_to_offset(category_va)?.0;
    let category_name = required_cstring_pointer(resolver, offset, "category name")?;
    let class_name =
        strict_class_ref_name(resolver, checked_field_offset(offset, 8, "category class")?)?;
    fold_optional_method_list(
        resolver,
        checked_field_offset(offset, 16, "category instance methods")?,
        category_va,
        &class_name,
        Some(&category_name),
        ObjCMethodKind::Instance,
        state,
        folder,
    )?;
    fold_optional_method_list(
        resolver,
        checked_field_offset(offset, 24, "category class methods")?,
        category_va,
        &class_name,
        Some(&category_name),
        ObjCMethodKind::Class,
        state,
        folder,
    )
}

#[allow(clippy::too_many_arguments)]
fn fold_optional_method_list<State>(
    resolver: &ObjCResolver<'_>,
    pointer_offset: u64,
    owner_va: Va,
    class_name: &str,
    category_name: Option<&str>,
    kind: ObjCMethodKind,
    state: &mut State,
    folder: &mut impl FnMut(&mut State, ObjCMethodRecord) -> Result<()>,
) -> Result<()> {
    let Some(list_va) = resolver.read_pointer_at_offset(pointer_offset)? else {
        return Ok(());
    };
    if list_va.0 == 0 {
        return Ok(());
    }
    fold_method_list(resolver, list_va, |record| {
        folder(
            state,
            ObjCMethodRecord {
                owner_va,
                class_name: class_name.to_owned(),
                category_name: category_name.map(str::to_owned),
                method_name: record.method_name,
                type_encoding: record.type_encoding,
                kind,
                imp: record.imp,
                provenance: record.provenance,
            },
        )
    })
}

struct ParsedMethodRecord {
    method_name: String,
    type_encoding: String,
    imp: Va,
    provenance: ObjCMethodRecordProvenance,
}

fn fold_method_list(
    resolver: &ObjCResolver<'_>,
    list_va: Va,
    mut visitor: impl FnMut(ParsedMethodRecord) -> Result<()>,
) -> Result<()> {
    let offset = resolver.va_to_offset(list_va)?.as_usize();
    let data = resolver.macho().bytes();
    let endian = resolver.endian();
    let header: RawMethodListHeader = pod::read_pod(data, offset)?;
    let flags = endian.interpret_u32(header.entsize_and_flags);
    let count = endian.interpret_u32(header.count) as usize;
    let relative = flags & METHOD_LIST_USES_RELATIVE_OFFSETS != 0;
    let direct_selectors = flags & METHOD_LIST_USES_DIRECT_SELECTOR_OFFSETS != 0;
    let minimum = if relative {
        size_of::<RawRelativeMethodT>()
    } else {
        size_of::<RawMethodT>()
    };
    let encoded_size = (flags & METHOD_LIST_ENTSIZE_MASK) as usize;
    let entry_size = if encoded_size == 0 {
        minimum
    } else {
        encoded_size
    };
    if entry_size < minimum {
        return Err(Error::format(format!(
            "method entry size {entry_size} is smaller than {minimum}"
        )));
    }
    let entries_start = offset
        .checked_add(size_of::<RawMethodListHeader>())
        .ok_or_else(|| Error::address("method-list header range overflows"))?;
    let entries_size = count
        .checked_mul(entry_size)
        .ok_or_else(|| Error::address("method-list entry range overflows"))?;
    let entries_end = entries_start
        .checked_add(entries_size)
        .ok_or_else(|| Error::address("method-list end overflows"))?;
    if entries_end > data.len() {
        return Err(Error::bounds(
            entries_start as u64,
            entries_size as u64,
            data.len() as u64,
        ));
    }

    for ordinal in 0..count {
        let entry_offset = entries_start + ordinal * entry_size;
        let record = if relative {
            parse_relative_method(resolver, entry_offset, entry_size, direct_selectors)?
        } else {
            parse_absolute_method(resolver, entry_offset, entry_size)?
        };
        visitor(record)?;
    }
    Ok(())
}

fn parse_relative_method(
    resolver: &ObjCResolver<'_>,
    entry_offset: usize,
    entry_size: usize,
    direct_selectors: bool,
) -> Result<ParsedMethodRecord> {
    let data = resolver.macho().bytes();
    let endian = resolver.endian();
    let raw: RawRelativeMethodT = pod::read_pod(data, entry_offset)?;
    let name_relative = endian.interpret_i32(raw.name_offset) as isize;
    let types_relative = endian.interpret_i32(raw.types_offset) as isize;
    let imp_relative = endian.interpret_i32(raw.imp_offset) as i64;
    let selector_offset = entry_offset
        .checked_add_signed(name_relative)
        .ok_or_else(|| Error::address("relative method selector offset overflows"))?;
    let (name, selector) = if direct_selectors {
        (
            read_cstring_at_file_offset(data, selector_offset)?.to_owned(),
            ObjCRelativeSelectorEncoding::DirectString {
                selector_string_file_offset: ThinFileOffset(selector_offset as u64),
            },
        )
    } else {
        let string_va = resolver
            .read_pointer_at_offset(selector_offset as u64)?
            .ok_or_else(|| Error::address("relative method selector reference is unresolved"))?;
        (
            resolver.read_cstring(string_va)?.to_owned(),
            ObjCRelativeSelectorEncoding::IndirectReference {
                selector_reference_file_offset: ThinFileOffset(selector_offset as u64),
                selector_reference_pointer: resolver
                    .pointer_provenance_at_offset(selector_offset as u64),
            },
        )
    };
    let types_field_offset = entry_offset
        .checked_add(4)
        .ok_or_else(|| Error::address("relative method type-encoding field overflows"))?;
    let types_offset = types_field_offset
        .checked_add_signed(types_relative)
        .ok_or_else(|| Error::address("relative method type-encoding offset overflows"))?;
    let type_encoding = read_cstring_at_file_offset(data, types_offset)?.to_owned();
    let imp_field_offset = entry_offset
        .checked_add(8)
        .ok_or_else(|| Error::address("relative method IMP field overflows"))?;
    let imp_field_va = resolver
        .macho()
        .address_map()
        .thin_offset_to_va(ThinFileOffset(imp_field_offset as u64))?;
    let imp = imp_field_va
        .0
        .checked_add_signed(imp_relative)
        .filter(|value| *value != 0)
        .map(Va)
        .ok_or_else(|| Error::address("relative method IMP address is invalid"))?;
    let address_map = resolver.macho().address_map();
    let record_file_offset = ThinFileOffset(entry_offset as u64);
    let record_va = address_map.thin_offset_to_va(record_file_offset)?;
    Ok(ParsedMethodRecord {
        method_name: name,
        type_encoding,
        imp,
        provenance: ObjCMethodRecordProvenance {
            record_file_offset,
            record_va,
            record_size: entry_size as u64,
            encoding: ObjCMethodRecordEncoding::Relative {
                selector_field_va: record_va,
                type_encoding_field_va: address_map
                    .thin_offset_to_va(ThinFileOffset(types_field_offset as u64))?,
                implementation_field_va: imp_field_va,
                selector,
            },
        },
    })
}

fn parse_absolute_method(
    resolver: &ObjCResolver<'_>,
    entry_offset: usize,
    entry_size: usize,
) -> Result<ParsedMethodRecord> {
    let name = required_cstring_pointer(resolver, entry_offset as u64, "method name")?;
    let types_offset = checked_field_offset(entry_offset as u64, 8, "method type encoding")?;
    let type_encoding = required_cstring_pointer(resolver, types_offset, "method type encoding")?;
    let imp_offset = checked_field_offset(entry_offset as u64, 16, "method IMP")?;
    let imp = required_pointer(resolver, imp_offset, "method IMP")?;
    if imp.0 == 0 {
        return Err(Error::address("method IMP is null"));
    }
    let record_file_offset = ThinFileOffset(entry_offset as u64);
    Ok(ParsedMethodRecord {
        method_name: name,
        type_encoding,
        imp,
        provenance: ObjCMethodRecordProvenance {
            record_file_offset,
            record_va: resolver
                .macho()
                .address_map()
                .thin_offset_to_va(record_file_offset)?,
            record_size: entry_size as u64,
            encoding: ObjCMethodRecordEncoding::Absolute {
                selector_pointer: resolver.pointer_provenance_at_offset(entry_offset as u64),
                type_encoding_pointer: resolver.pointer_provenance_at_offset(types_offset),
                implementation_pointer: resolver.pointer_provenance_at_offset(imp_offset),
            },
        },
    })
}

fn strict_class_ref_name(resolver: &ObjCResolver<'_>, pointer_offset: u64) -> Result<String> {
    if let Some(bind_name) = resolver.bind_name_at_offset(pointer_offset) {
        return Ok(bind_name
            .strip_prefix("_OBJC_CLASS_$_")
            .unwrap_or(bind_name)
            .to_owned());
    }
    let class_va = required_pointer(resolver, pointer_offset, "category class")?;
    let class_offset = resolver.va_to_offset(class_va)?.0;
    let data_va = required_pointer(
        resolver,
        checked_field_offset(class_offset, 32, "category class data")?,
        "category class data",
    )?;
    let ro_offset = resolver
        .va_to_offset(Va(data_va.0 & crate::types::CLASS_DATA_POINTER_MASK))?
        .0;
    required_cstring_pointer(
        resolver,
        checked_field_offset(ro_offset, 24, "category class name")?,
        "category class name",
    )
}

fn checked_field_offset(base: u64, delta: u64, field: &str) -> Result<u64> {
    base.checked_add(delta)
        .ok_or_else(|| Error::address(format!("{field} offset overflows")))
}

fn required_pointer(resolver: &ObjCResolver<'_>, offset: u64, field: &str) -> Result<Va> {
    resolver
        .read_pointer_at_offset(offset)?
        .filter(|va| va.0 != 0)
        .ok_or_else(|| Error::format(format!("{field} pointer is null or unresolved")))
}

fn required_cstring_pointer(
    resolver: &ObjCResolver<'_>,
    offset: u64,
    field: &str,
) -> Result<String> {
    let va = required_pointer(resolver, offset, field)?;
    resolver.read_cstring(va).map(str::to_owned)
}

fn read_cstring_at_file_offset(data: &[u8], offset: usize) -> Result<&str> {
    let slice = data
        .get(offset..)
        .ok_or_else(|| Error::bounds(offset as u64, 1, data.len() as u64))?;
    let end = slice
        .iter()
        .position(|byte| *byte == 0)
        .ok_or_else(|| Error::format(format!("unterminated string at file offset {offset:#x}")))?;
    std::str::from_utf8(&slice[..end])
        .map_err(|error| Error::format(format!("invalid UTF-8 at offset {offset:#x}: {error}")))
}

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

    fn thin(bytes: &[u8]) -> &MachoFile<'_> {
        let container = Box::leak(Box::new(macho_core::parse(bytes).unwrap()));
        match container {
            macho_core::model::container::MachoContainer::Thin(macho) => macho,
            macho_core::model::container::MachoContainer::Fat(_) => panic!("expected thin image"),
        }
    }

    #[test]
    fn folds_class_and_category_method_imps_without_collecting_a_graph() {
        let class_bytes = macho_test_support::disassembly_objc_boundary();
        let class_imps = fold_method_imps(thin(&class_bytes), Vec::new(), |items, item| {
            items.push(item);
            Ok(())
        })
        .unwrap();
        assert!(
            class_imps.iter().any(|item| {
                item.class_name == "Fixture"
                    && item.category_name.is_none()
                    && item.method_name == "next"
                    && item.kind == ObjCMethodKind::Instance
            }),
            "{class_imps:?}"
        );
        let class_records = fold_method_records(thin(&class_bytes), Vec::new(), |items, item| {
            items.push(item);
            Ok(())
        })
        .unwrap();
        let class_method = class_records
            .iter()
            .find(|item| item.method_name == "next")
            .unwrap();
        assert_eq!(class_method.type_encoding, "v@:");
        assert_eq!(class_method.provenance.record_file_offset.0, 0x2c8);
        assert_eq!(class_method.provenance.record_va.0, 0x1_0000_02c8);
        assert_eq!(class_method.provenance.record_size, 24);
        assert_eq!(
            class_method.provenance.encoding,
            ObjCMethodRecordEncoding::Absolute {
                selector_pointer: ObjCPointerProvenance::Direct,
                type_encoding_pointer: ObjCPointerProvenance::Direct,
                implementation_pointer: ObjCPointerProvenance::Direct,
            }
        );

        let category_bytes = macho_test_support::disassembly_objc_category_labels();
        let category_imps = fold_method_imps(thin(&category_bytes), Vec::new(), |items, item| {
            items.push(item);
            Ok(())
        })
        .unwrap();
        assert!(
            category_imps
                .iter()
                .any(|item| item.category_name.as_deref() == Some("Fixture")
                    && item.kind == ObjCMethodKind::Instance)
        );
        assert!(
            category_imps
                .iter()
                .any(|item| item.category_name.as_deref() == Some("Fixture")
                    && item.kind == ObjCMethodKind::Class)
        );
    }

    #[test]
    fn relative_method_records_retain_each_field_basis_and_selector_reference() {
        let mut bytes = macho_test_support::disassembly_objc_boundary();
        const IMAGE_BASE: u64 = 0x1_0000_0000;
        const ENTRY: usize = 0x2c8;
        const SELECTOR_REFERENCE: usize = 0x2f8;
        bytes[0x2c0..0x2c4].copy_from_slice(&0x8000_000cu32.to_le_bytes());
        bytes[ENTRY..ENTRY + 4].copy_from_slice(
            &i32::try_from(SELECTOR_REFERENCE - ENTRY)
                .unwrap()
                .to_le_bytes(),
        );
        bytes[ENTRY + 4..ENTRY + 8]
            .copy_from_slice(&i32::try_from(0x2f0 - (ENTRY + 4)).unwrap().to_le_bytes());
        bytes[ENTRY + 8..ENTRY + 12].copy_from_slice(&(-0xcci32).to_le_bytes());
        bytes[SELECTOR_REFERENCE..SELECTOR_REFERENCE + 8]
            .copy_from_slice(&(IMAGE_BASE + 0x2e8).to_le_bytes());

        let records = fold_method_records(thin(&bytes), Vec::new(), |items, item| {
            items.push(item);
            Ok(())
        })
        .unwrap();
        let record = records
            .iter()
            .find(|item| item.method_name == "next")
            .unwrap();
        assert_eq!(record.type_encoding, "v@:");
        assert_eq!(record.imp.0, IMAGE_BASE + 0x204);
        assert_eq!(record.provenance.record_file_offset.0, ENTRY as u64);
        assert_eq!(record.provenance.record_size, 12);
        assert_eq!(
            record.provenance.encoding,
            ObjCMethodRecordEncoding::Relative {
                selector_field_va: Va(IMAGE_BASE + ENTRY as u64),
                type_encoding_field_va: Va(IMAGE_BASE + ENTRY as u64 + 4),
                implementation_field_va: Va(IMAGE_BASE + ENTRY as u64 + 8),
                selector: ObjCRelativeSelectorEncoding::IndirectReference {
                    selector_reference_file_offset: ThinFileOffset(SELECTOR_REFERENCE as u64),
                    selector_reference_pointer: ObjCPointerProvenance::Direct,
                },
            }
        );

        bytes[0x2c0..0x2c4].copy_from_slice(&0xc000_000cu32.to_le_bytes());
        bytes[ENTRY..ENTRY + 4]
            .copy_from_slice(&i32::try_from(0x2e8 - ENTRY).unwrap().to_le_bytes());
        let direct_records = fold_method_records(thin(&bytes), Vec::new(), |items, item| {
            items.push(item);
            Ok(())
        })
        .unwrap();
        let direct = direct_records
            .iter()
            .find(|item| item.method_name == "next")
            .unwrap();
        assert!(matches!(
            direct.provenance.encoding,
            ObjCMethodRecordEncoding::Relative {
                selector: ObjCRelativeSelectorEncoding::DirectString {
                    selector_string_file_offset: ThinFileOffset(0x2e8),
                },
                ..
            }
        ));
    }

    #[test]
    fn damaged_chained_fixups_reject_instead_of_falling_back_to_legacy_metadata() {
        let mut bytes = macho_test_support::disassembly_objc_boundary();
        const HEADER_SIZE: usize = 32;
        const SEGMENT_COMMAND_SIZE: usize = 72 + 2 * 80;
        const SYMTAB_COMMAND_SIZE: usize = 24;
        const CHAINED_COMMAND_SIZE: usize = 16;
        const COMMAND_OFFSET: usize = HEADER_SIZE + SEGMENT_COMMAND_SIZE + SYMTAB_COMMAND_SIZE;

        bytes[16..20].copy_from_slice(&3u32.to_le_bytes());
        bytes[20..24].copy_from_slice(
            &((SEGMENT_COMMAND_SIZE + SYMTAB_COMMAND_SIZE + CHAINED_COMMAND_SIZE) as u32)
                .to_le_bytes(),
        );
        bytes[COMMAND_OFFSET..COMMAND_OFFSET + 4].copy_from_slice(&0x8000_0034u32.to_le_bytes());
        bytes[COMMAND_OFFSET + 4..COMMAND_OFFSET + 8]
            .copy_from_slice(&(CHAINED_COMMAND_SIZE as u32).to_le_bytes());
        bytes[COMMAND_OFFSET + 8..COMMAND_OFFSET + 12].copy_from_slice(&u32::MAX.to_le_bytes());
        bytes[COMMAND_OFFSET + 12..COMMAND_OFFSET + 16].copy_from_slice(&28u32.to_le_bytes());

        let error = fold_method_records(thin(&bytes), (), |_, _| Ok(()))
            .expect_err("damaged chained-fixup payload must reject");
        assert!(error.to_string().contains("offset"), "{error}");
    }

    #[test]
    fn malformed_suffix_drops_an_accumulator_after_a_valid_imp() {
        let mut bytes = macho_test_support::disassembly_objc_boundary();
        // Extend __objc_classlist over the class object's isa word. The first
        // class method list is valid and invokes the folder; its malformed isa
        // then fails before the accumulator can be returned.
        bytes[224..232].copy_from_slice(&16u64.to_le_bytes());
        bytes[0x248..0x250].copy_from_slice(&u64::MAX.to_le_bytes());
        let callback_count = std::cell::Cell::new(0usize);
        let result = fold_method_imps(thin(&bytes), 0usize, |count, _| {
            *count += 1;
            callback_count.set(callback_count.get() + 1);
            Ok(())
        });
        assert_eq!(callback_count.get(), 1);
        assert!(result.is_err());
    }
}