btfdump 0.0.4

BTF introspection tool
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
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
use std::collections::HashMap;

use lazy_static::lazy_static;
use regex::RegexSet;

use crate::types::*;
use crate::{btf_error, BtfResult};

#[derive(Debug, Copy, Clone, Eq, PartialEq)]
enum OrderState {
    NotOrdered,
    Ordering,
    Ordered,
}

impl Default for OrderState {
    fn default() -> Self {
        OrderState::NotOrdered
    }
}

#[derive(Debug, Copy, Clone, Eq, PartialEq)]
enum EmitState {
    NotEmitted,
    Emitting,
    Emitted,
}

impl Default for EmitState {
    fn default() -> Self {
        EmitState::NotEmitted
    }
}

#[derive(Default)]
struct TypeState {
    order_state: OrderState,
    emit_state: EmitState,
    fwd_emitted: bool,
    name: String,
}

#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
enum NamedKind {
    Type,
    Ident,
}

#[derive(Debug)]
pub struct CDumperCfg {
    pub verbose: bool,
    pub union_as_struct: bool,
}

pub struct CDumper<'a> {
    btf: &'a Btf<'a>,
    cfg: CDumperCfg,
    state: Vec<TypeState>,
    names: HashMap<(NamedKind, &'a str), u32>,
}

impl<'a> CDumper<'a> {
    pub fn new(btf: &'a Btf<'a>, cfg: CDumperCfg) -> CDumper<'a> {
        let mut dumper = CDumper {
            btf: btf,
            cfg: cfg,
            state: Vec::new(),
            names: HashMap::new(),
        };
        dumper
            .state
            .resize_with(btf.type_cnt() as usize, Default::default);
        dumper
    }

    pub fn dump_types(
        &mut self,
        filter: Box<dyn Fn(u32, &'a BtfType<'a>) -> bool>,
    ) -> BtfResult<()> {
        for id in 1..self.btf.type_cnt() {
            let bt = self.btf.type_by_id(id);
            if filter(id, bt) {
                self.dump_type(id)?;
            }
        }
        Ok(())
    }

    pub fn dump_type(&mut self, id: u32) -> BtfResult<()> {
        let mut order = Vec::new();
        if self.cfg.verbose {
            println!("===================================================");
            println!("ORDERING id: {}, type: {}", id, self.btf.type_by_id(id));
        }
        self.order_type(id, false, &mut order)?;
        if self.cfg.verbose {
            for (i, &id) in order.iter().enumerate() {
                println!("ORDER #{} id: {}, type: {}", i, id, self.btf.type_by_id(id));
            }
        }
        // emit struct/union and fwds required by them in correct order
        for id in order {
            self.emit_type(id, 0)?;
        }
        Ok(())
    }

    fn order_type(&mut self, id: u32, has_ptr: bool, order: &mut Vec<u32>) -> BtfResult<bool> {
        if self.cfg.verbose && self.get_order_state(id) != OrderState::Ordered {
            println!(
                "ORDER TYPE id:{}, has_ptr:{}, type:{}, order_state:{:?}",
                id,
                has_ptr,
                self.btf.type_by_id(id),
                self.get_order_state(id)
            );
        }
        // order state is used to detect strong link cycles, but only for BTF kinds that are or
        // could be an independent definition (i.e., stand-alone fwd decl, enum, typedef, struct,
        // union). Ptrs, arrays, func_protos, modifiers are just means to get to these definitions.
        // Int/void don't need definitions, they are assumed to be always properly defined.
        // We also ignore datasec, var, and funcs. So for all non-defining kinds, we never even set
        // ordering state, for defining kinds we set OrderState::Ordering and subsequently
        // OrderState::Ordered only if it forms a strong link.
        match self.get_order_state(id) {
            OrderState::NotOrdered => {}
            OrderState::Ordering => match self.btf.type_by_id(id) {
                BtfType::Struct(t) | BtfType::Union(t) if has_ptr && !t.name.is_empty() => {
                    return Ok(false);
                }
                _ => {
                    return btf_error(format!(
                        "Unsatisfiable type cycle, id: {}, type: {}",
                        id,
                        self.btf.type_by_id(id)
                    ));
                }
            },
            // return true, letting typedefs know that it's ok to be emitted
            OrderState::Ordered => return Ok(true),
        }
        match self.btf.type_by_id(id) {
            BtfType::Func(_) | BtfType::Var(_) | BtfType::Datasec(_) | BtfType::DeclTag(_) => {}
            BtfType::Void | BtfType::Int(_) | BtfType::Float(_) => {
                self.set_order_state(id, OrderState::Ordered);
                return Ok(false);
            }
            BtfType::Volatile(t) => return self.order_type(t.type_id, has_ptr, order),
            BtfType::Const(t) => return self.order_type(t.type_id, has_ptr, order),
            BtfType::Restrict(t) => return self.order_type(t.type_id, has_ptr, order),
            BtfType::TypeTag(t) => return self.order_type(t.type_id, has_ptr, order),
            BtfType::Ptr(t) => {
                let res = self.order_type(t.type_id, true, order);
                self.set_order_state(id, OrderState::Ordered);
                return res;
            }
            BtfType::Array(t) => return self.order_type(t.val_type_id, has_ptr, order),
            BtfType::FuncProto(t) => {
                let mut is_strong = self.order_type(t.res_type_id, has_ptr, order)?;
                for p in &t.params {
                    if self.order_type(p.type_id, has_ptr, order)? {
                        is_strong = true;
                    }
                }
                return Ok(is_strong);
            }
            BtfType::Struct(t) | BtfType::Union(t) => {
                // struct/union is part of strong link, only if it's embedded (so no ptr in a path)
                // or it's anonymous (so has to be defined inline, even if declared through ptr)
                if !has_ptr || t.name.is_empty() {
                    self.set_order_state(id, OrderState::Ordering);

                    for m in &t.members {
                        self.order_type(m.type_id, false, order)?;
                    }
                    // no need to explicitly order anonymous embedded struct
                    if !t.name.is_empty() {
                        order.push(id);
                    }

                    self.set_order_state(id, OrderState::Ordered);
                    // report this was strong link
                    return Ok(true);
                }
            }
            BtfType::Enum(t) => {
                if !t.name.is_empty() {
                    order.push(id);
                }
                self.set_order_state(id, OrderState::Ordered);
                // report this was strong link
                return Ok(true);
            }
            BtfType::Enum64(t) => {
                if !t.name.is_empty() {
                    order.push(id);
                }
                self.set_order_state(id, OrderState::Ordered);
                // report this was strong link
                return Ok(true);
            }
            BtfType::Fwd(t) => {
                if !t.name.is_empty() {
                    order.push(id);
                }
                self.set_order_state(id, OrderState::Ordered);
                // report this was strong link
                return Ok(true);
            }
            BtfType::Typedef(t) => {
                let is_strong = self.order_type(t.type_id, has_ptr, order)?;
                if !has_ptr || is_strong {
                    order.push(id);
                    self.set_order_state(id, OrderState::Ordered);
                    // report this was strong link
                    return Ok(true);
                }
            }
        }
        Ok(false)
    }

    fn emit_type(&mut self, id: u32, cont_id: u32) -> BtfResult<()> {
        let top_level_def = cont_id == 0;
        if self.cfg.verbose {
            println!(
                "EMIT_TYPE id: {}, cont_id: {}, is_def: {}, state: {:?}, type: {}",
                id,
                cont_id,
                top_level_def,
                self.get_emit_state(id),
                self.btf.type_by_id(id)
            );
        }
        match self.get_emit_state(id) {
            EmitState::NotEmitted => {}
            EmitState::Emitting => {
                if self.get_fwd_emitted(id) {
                    return Ok(());
                }
                match self.btf.type_by_id(id) {
                    BtfType::Struct(t) | BtfType::Union(t) => {
                        // fwd was already emitted or no need for fwd declare if we are referencing
                        // a struct/union we are part of
                        if id == cont_id {
                            return Ok(());
                        }
                        if t.name.is_empty() {
                            return btf_error(format!(
                                "anonymous struct loop, id: {}, type: {}",
                                id,
                                self.btf.type_by_id(id)
                            ));
                        }
                        if self.emit_composite_fwd(id, t) {
                            println!(";\n");
                        }
                        self.set_fwd_emitted(id, true);
                        return Ok(());
                    }
                    BtfType::Typedef(t) => {
                        // for typedef fwd_emitted means typedef definition was emitted, but it can
                        // be used only for "weak" references through pointer only
                        if self.emit_typedef_def(id, t, 0) {
                            println!(";\n");
                        }
                        self.set_fwd_emitted(id, true);
                        return Ok(());
                    }
                    _ => return Ok(()),
                };
            }
            EmitState::Emitted => return Ok(()),
        }

        if top_level_def && self.btf.type_by_id(id).name().is_empty() {
            return btf_error(format!(
                "unexpected nameless definition, id: {}, type: {}",
                id,
                self.btf.type_by_id(id)
            ));
        }

        match self.btf.type_by_id(id) {
            BtfType::Func(_) | BtfType::Var(_) | BtfType::Datasec(_) | BtfType::DeclTag(_) => {}
            BtfType::Void | BtfType::Int(_) | BtfType::Float(_) => {}
            BtfType::Volatile(t) => self.emit_type(t.type_id, cont_id)?,
            BtfType::Const(t) => self.emit_type(t.type_id, cont_id)?,
            BtfType::Restrict(t) => self.emit_type(t.type_id, cont_id)?,
            BtfType::TypeTag(t) => self.emit_type(t.type_id, cont_id)?,
            BtfType::Ptr(t) => self.emit_type(t.type_id, cont_id)?,
            BtfType::Array(t) => self.emit_type(t.val_type_id, cont_id)?,
            BtfType::FuncProto(t) => {
                self.emit_type(t.res_type_id, cont_id)?;
                for p in &t.params {
                    self.emit_type(p.type_id, cont_id)?;
                }
            }
            BtfType::Struct(t) | BtfType::Union(t) => {
                self.set_emit_state(id, EmitState::Emitting);
                if top_level_def || t.name.is_empty() {
                    // top-level struct definition or embedded anonymous struct, ensure all field
                    // types have their fwds declared
                    for m in &t.members {
                        self.emit_type(m.type_id, if t.name.is_empty() { cont_id } else { id })?;
                    }
                } else if !self.get_fwd_emitted(id) && id != cont_id {
                    if self.emit_composite_fwd(id, t) {
                        println!(";\n");
                    }
                    self.set_fwd_emitted(id, true);
                }
                if top_level_def {
                    self.emit_composite_def(id, t, 0);
                    println!(";\n");
                    self.set_emit_state(id, EmitState::Emitted);
                } else {
                    self.set_emit_state(id, EmitState::NotEmitted);
                }
            }
            BtfType::Enum(t) => {
                if top_level_def {
                    self.emit_enum_def(id, t, 0);
                    println!(";\n");
                }
                self.set_emit_state(id, EmitState::Emitted);
            }
            BtfType::Enum64(t) => {
                if top_level_def {
                    self.emit_enum64_def(id, t, 0);
                    println!(";\n");
                }
                self.set_emit_state(id, EmitState::Emitted);
            }
            BtfType::Fwd(t) => {
                self.emit_fwd_def(id, t);
                println!(";\n");
                self.set_emit_state(id, EmitState::Emitted);
            }
            BtfType::Typedef(t) => {
                self.set_emit_state(id, EmitState::Emitting);
                self.emit_type(t.type_id, id)?;
                if !self.get_fwd_emitted(id) {
                    // emit typedef right now, if someone depends on it "weakly" (though pointer)
                    if self.emit_typedef_def(id, t, 0) {
                        println!(";\n");
                    }
                    self.set_fwd_emitted(id, true);
                }
                self.set_emit_state(id, EmitState::Emitted);
            }
        }
        Ok(())
    }

    fn get_fwd_emitted(&self, id: u32) -> bool {
        self.state[id as usize].fwd_emitted
    }

    fn set_fwd_emitted(&mut self, id: u32, emitted: bool) {
        self.state[id as usize].fwd_emitted = emitted;
    }

    fn get_order_state(&self, id: u32) -> OrderState {
        self.state[id as usize].order_state
    }

    fn set_order_state(&mut self, id: u32, state: OrderState) {
        self.state[id as usize].order_state = state;
    }

    fn get_emit_state(&self, id: u32) -> EmitState {
        self.state[id as usize].emit_state
    }

    fn set_emit_state(&mut self, id: u32, state: EmitState) {
        self.state[id as usize].emit_state = state;
    }

    fn emit_composite_fwd(&mut self, id: u32, t: &'a BtfComposite) -> bool {
        if NAMES_BLACKLIST.is_match(&t.name) {
            return false;
        }
        let keyword = if !t.is_struct && self.cfg.union_as_struct {
            "struct /*union*/"
        } else if t.is_struct {
            "struct"
        } else {
            "union"
        };
        print!(
            "{} {}",
            keyword,
            self.resolve_type_name(NamedKind::Type, id, t.name)
        );
        return true;
    }

    fn emit_composite_def(&mut self, id: u32, t: &'a BtfComposite, lvl: usize) {
        if NAMES_BLACKLIST.is_match(&t.name) {
            return;
        }
        let keyword = if !t.is_struct && self.cfg.union_as_struct {
            "struct /*union*/"
        } else if t.is_struct {
            "struct"
        } else {
            "union"
        };
        let packed = self.is_struct_packed(id, t);
        let name = self.resolve_type_name(NamedKind::Type, id, t.name);
        print!("{}{}{} {{", keyword, sep(&name), name);
        let mut offset = 0;
        for m in &t.members {
            self.emit_bit_padding(offset, m, packed, lvl + 1);

            print!("\n{}", pfx(lvl + 1));
            self.emit_type_decl(m.type_id, &m.name, lvl + 1);

            if m.bit_size == 0 {
                offset = m.bit_offset + self.btf.get_size_of(m.type_id) * 8;
            } else {
                print!(": {}", m.bit_size);
                offset = m.bit_offset + m.bit_size as u32;
            }
            print!(";");
        }
        if !t.members.is_empty() {
            print!("\n");
        }
        print!("{}}}", pfx(lvl));
        if packed {
            print!(" __attribute__((packed))");
        }
    }

    fn is_struct_packed(&self, id: u32, t: &BtfComposite) -> bool {
        if !t.is_struct {
            return false;
        }
        // size of a struct has to be a multiple of its alignment
        if t.sz % self.btf.get_align_of(id) != 0 {
            return true;
        }
        // all the non-bitfield fields have to be naturally aligned
        for m in &t.members {
            if m.bit_size == 0 && m.bit_offset % (self.btf.get_align_of(m.type_id) * 8) != 0 {
                return true;
            }
        }
        // even if original struct was marked as packed, we haven't detected any misalignment, so
        // there is no effect of packedness for given struct
        return false;
    }

    fn emit_bit_padding(&self, offset: u32, m: &BtfMember, packed: bool, lvl: usize) {
        if offset >= m.bit_offset {
            return;
        }
        let mut bit_diff = m.bit_offset - offset;
        let align = if packed {
            1
        } else {
            self.btf.get_align_of(m.type_id)
        };
        if m.bit_size == 0 && bit_diff < align * 8 {
            // natural padding will take care of a gap
            return;
        }
        let ptr_sz_bits = self.btf.ptr_sz() * 8;
        while bit_diff > 0 {
            let (pad_type, pad_bits) = if ptr_sz_bits > 32 && bit_diff > 32 {
                ("long", CDumper::chip_away_bits(bit_diff, ptr_sz_bits))
            } else if bit_diff > 16 {
                ("int", CDumper::chip_away_bits(bit_diff, 32))
            } else if bit_diff > 8 {
                ("short", CDumper::chip_away_bits(bit_diff, 16))
            } else {
                ("char", CDumper::chip_away_bits(bit_diff, 8))
            };
            bit_diff -= pad_bits;
            print!("\n{}{}: {};", pfx(lvl), pad_type, pad_bits);
        }
    }

    fn chip_away_bits(total: u32, at_most: u32) -> u32 {
        if total % at_most == 0 {
            at_most
        } else {
            total % at_most
        }
    }

    fn emit_enum_def(&mut self, id: u32, t: &'a BtfEnum, lvl: usize) {
        if NAMES_BLACKLIST.is_match(&t.name) {
            return;
        }
        let name = self.resolve_type_name(NamedKind::Type, id, t.name);
        if t.values.is_empty() {
            // enum fwd
            print!("enum{}{}", sep(&name), name);
        } else {
            print!("enum{}{} {{", sep(&name), name);
            for v in &t.values {
                let val_uniq_name = self.resolve_name(NamedKind::Ident, &v.name);
                print!("\n{}{} = {},", pfx(lvl + 1), &val_uniq_name, v.value);
            }
            print!("\n{}}}", pfx(lvl));
        }
    }

    fn emit_enum64_def(&mut self, id: u32, t: &'a BtfEnum64, lvl: usize) {
        if NAMES_BLACKLIST.is_match(&t.name) {
            return;
        }
        let name = self.resolve_type_name(NamedKind::Type, id, t.name);
        if t.values.is_empty() {
            // enum fwd
            print!("enum{}{}", sep(&name), name);
        } else {
            print!("enum{}{} {{", sep(&name), name);
            for v in &t.values {
                let val_uniq_name = self.resolve_name(NamedKind::Ident, &v.name);
                print!("\n{}{} = {},", pfx(lvl + 1), &val_uniq_name, v.value);
            }
            print!("\n{}}}", pfx(lvl));
        }
    }

    fn emit_fwd_def(&mut self, id: u32, t: &'a BtfFwd) {
        if NAMES_BLACKLIST.is_match(&t.name) {
            return;
        }
        let name = self.resolve_type_name(NamedKind::Type, id, t.name);
        match t.kind {
            BtfFwdKind::Struct => print!("struct {}", name),
            BtfFwdKind::Union => {
                if self.cfg.union_as_struct {
                    print!("struct /*union*/ {}", name)
                } else {
                    print!("union {}", name)
                }
            }
        }
    }

    fn emit_typedef_def(&mut self, id: u32, t: &'a BtfTypedef, lvl: usize) -> bool {
        if NAMES_BLACKLIST.is_match(&t.name) {
            return false;
        }
        let name = self.resolve_type_name(NamedKind::Ident, id, t.name);
        print!("typedef ");
        self.emit_type_decl(t.type_id, &name, lvl);
        return true;
    }

    fn emit_type_decl(&mut self, mut id: u32, fname: &str, lvl: usize) {
        // This algorithm emits correct C syntax for any type definition.
        //
        // For most types it's trivial, but there are few quirky type declaration  cases worth
        // mentioning:
        //   - function prototypes;
        //   - arrays;
        //   - const/volatile/restrict for pointers vs other types.
        // See Peter van der Linden's "Expert C Programming: Deep C Secrets", Ch.3 "Unscrambling
        // Declarations in C" for good discussion of this topic.
        //
        // This algorithm is in reverse to van der Linden's parsing algorithm. It goes from
        // structured BTF representation of type declaration to a valid compilable C syntax.
        let mut chain = Vec::new();
        loop {
            chain.push(id);
            match self.btf.type_by_id(id) {
                BtfType::Ptr(t) => id = t.type_id,
                BtfType::Const(t) => id = t.type_id,
                BtfType::Volatile(t) => id = t.type_id,
                BtfType::Restrict(t) => id = t.type_id,
                BtfType::Array(t) => id = t.val_type_id,
                BtfType::FuncProto(t) => id = t.res_type_id,
                BtfType::Var(_) | BtfType::Datasec(_) | BtfType::Func(_) => {
                    chain.pop();
                    print!("!@#! UNEXPECT TYPE DECL CHAIN ");
                    for parent_id in chain.iter().rev() {
                        print!("[{}] --> ", parent_id);
                    }
                    print!("[{}] {}", id, self.btf.type_by_id(id));
                    return;
                }
                _ => break,
            }
        }
        self.emit_type_chain(chain, fname, lvl);
    }

    fn emit_type_chain(&mut self, mut chain: Vec<u32>, fname: &str, lvl: usize) {
        // default to true, in case we have single ptr in a chain. E.g., in ptr -> func_proto case.
        // func_proto will start a new emit_type_chain with just ptr, which should be emitted as
        // (*) or (*<fname>), so we don't want to preprend space for that last ptr.
        let mut last_was_ptr = true;
        while let Some(id) = chain.pop() {
            match self.btf.type_by_id(id) {
                BtfType::Void => {
                    self.emit_mods(&mut chain);
                    print!("void");
                }
                BtfType::Int(t) => {
                    self.emit_mods(&mut chain);
                    print!("{}", t.name);
                }
                BtfType::Struct(t) | BtfType::Union(t) => {
                    self.emit_mods(&mut chain);
                    if t.name.is_empty() {
                        self.emit_composite_def(id, t, lvl); // inline anonymous struct
                    } else {
                        self.emit_composite_fwd(id, t);
                    }
                }
                BtfType::Enum(t) => {
                    self.emit_mods(&mut chain);
                    if t.name.is_empty() {
                        self.emit_enum_def(id, t, lvl); // inline anonymous enum
                    } else {
                        let uniq_name = self.resolve_type_name(NamedKind::Type, id, t.name);
                        print!("enum {}", &uniq_name);
                    }
                }
                BtfType::Enum64(t) => {
                    self.emit_mods(&mut chain);
                    if t.name.is_empty() {
                        self.emit_enum64_def(id, t, lvl); // inline anonymous enum
                    } else {
                        let uniq_name = self.resolve_type_name(NamedKind::Type, id, t.name);
                        print!("enum {}", &uniq_name);
                    }
                }
                BtfType::Fwd(t) => {
                    self.emit_mods(&mut chain);
                    self.emit_fwd_def(id, t);
                }
                BtfType::Typedef(t) => {
                    self.emit_mods(&mut chain);
                    let uniq_name = self.resolve_type_name(NamedKind::Ident, id, t.name);
                    print!("{}", &uniq_name);
                }
                BtfType::Ptr(_) => {
                    if last_was_ptr {
                        print!("*")
                    } else {
                        print!(" *")
                    }
                }
                BtfType::Volatile(_) => {
                    print!(" volatile");
                }
                BtfType::Const(_) => {
                    print!(" const");
                }
                BtfType::Restrict(_) => {
                    print!(" restrict");
                }
                BtfType::Array(t) => {
                    // GCC has a bug (https://gcc.gnu.org/bugzilla/show_bug.cgi?id=8354) which
                    // causes it to emit extra const/volatile modifier for array, if array's
                    // element type has const/volatile modifier. Clang doesn't do that.
                    // In general, it doesn't seem very meaningful to have a const/volatile
                    // modifier for array, so we are going to silently skip them here.
                    while let Some(id) = chain.pop() {
                        match self.btf.type_by_id(id) {
                            BtfType::Volatile(_) | BtfType::Const(_) | BtfType::Restrict(_) => {}
                            _ => {
                                chain.push(id);
                                break;
                            }
                        }
                    }
                    if let Some(&next_id) = chain.last() {
                        let t = self.btf.type_by_id(next_id);
                        if !fname.is_empty() && !last_was_ptr {
                            print!(" ");
                        }
                        if t.kind() != BtfKind::Array {
                            print!("(");
                        }
                        self.emit_type_chain(chain, fname, lvl);
                        if t.kind() != BtfKind::Array {
                            print!(")");
                        }
                    } else {
                        self.emit_name(fname, last_was_ptr);
                    }
                    print!("[{}]", t.nelems);
                    return;
                }
                BtfType::FuncProto(t) => {
                    self.emit_mods(&mut chain);
                    if chain.is_empty() {
                        self.emit_name(fname, last_was_ptr);
                    } else {
                        print!(" (");
                        self.emit_type_chain(chain, fname, lvl);
                        print!(")");
                    }
                    print!("(");
                    //
                    // Clang for BPF target generates func_proto with no args as a func_proto with
                    // a single void arg (i.e., <ret-type> (*f)(void) vs just <ret_type> (*f)()).
                    // We are going to pretend there are no args for such case.
                    let arg_cnt = t.params.len();
                    if arg_cnt == 1 && t.params[0].type_id == 0 {
                        print!(")");
                        return;
                    }

                    for (i, p) in t.params.iter().enumerate() {
                        if i > 0 {
                            print!(", ");
                        }
                        // func_proto with vararg has last arg of type 'void'
                        if i == arg_cnt - 1 && t.params[arg_cnt - 1].type_id == 0 {
                            print!("...");
                        } else {
                            self.emit_type_decl(p.type_id, &p.name, lvl);
                        }
                    }
                    print!(")");
                    return;
                }
                BtfType::Float(t) => {
                    self.emit_mods(&mut chain);
                    print!("{}", t.name);
                }
                BtfType::TypeTag(t) => {
                    self.emit_mods(&mut chain);
                    print!(" __attribute__((btf_tag((\"{}\")))", &t.name);
                }
                BtfType::Func(_) | BtfType::Var(_) | BtfType::Datasec(_) | BtfType::DeclTag(_) => {
                    print!(
                        "!@#! UNEXPECT TYPE DECL id: {}, type: {}",
                        id,
                        self.btf.type_by_id(id)
                    );
                }
            }
            if let BtfType::Ptr(_) = self.btf.type_by_id(id) {
                last_was_ptr = true;
            } else {
                last_was_ptr = false;
            }
        }
        self.emit_name(fname, last_was_ptr);
    }

    fn emit_name(&self, fname: &str, last_was_ptr: bool) {
        if last_was_ptr {
            print!("{}", fname);
        } else {
            print!("{}{}", sep(fname), fname);
        }
    }

    fn emit_mods(&self, chain: &mut Vec<u32>) {
        while let Some(id) = chain.pop() {
            match self.btf.type_by_id(id) {
                BtfType::Volatile(_) => {
                    print!("volatile ");
                }
                BtfType::Const(_) => {
                    print!("const ");
                }
                BtfType::Restrict(_) => {
                    print!("restrict ");
                }
                _ => {
                    chain.push(id);
                    break;
                }
            }
        }
    }

    fn resolve_type_name(&mut self, kind: NamedKind, id: u32, name: &'a str) -> String {
        if name.is_empty() {
            return EMPTY.to_owned();
        }
        let s = &mut self.state[id as usize];
        if s.name.is_empty() {
            let version = self.names.entry((kind, name)).or_insert(0);
            *version += 1;
            if *version == 1 {
                s.name = name.to_string()
            } else {
                s.name = format!("{}___{}", name, version)
            }
        }
        s.name.clone()
    }

    fn resolve_name(&mut self, kind: NamedKind, name: &'a str) -> String {
        let version = self.names.entry((kind, name)).or_insert(0);
        *version += 1;
        if *version == 1 {
            name.to_string()
        } else {
            format!("{}___{}", name, version)
        }
    }
}

lazy_static! {
    static ref NAMES_BLACKLIST: RegexSet =
        RegexSet::new(&["__builtin_va_list"]).expect("invalid blacklist regexes");
}

const EMPTY: &str = "";
const SPACE: &str = " ";
const PREFIXES: &str = "\t\t\t\t\t\t\t\t\t\t\t\t";

fn sep(name: &str) -> &str {
    if name.is_empty() {
        EMPTY
    } else {
        SPACE
    }
}

fn pfx(lvl: usize) -> &'static str {
    if lvl >= PREFIXES.len() {
        PREFIXES
    } else {
        &PREFIXES[0..lvl]
    }
}