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
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
use {
    anyhow::{anyhow, Context, Result},
    object::{Object, ObjectSection, ObjectSymbol, SymbolKind},
    rustc_demangle::demangle,
    solana_compute_budget::compute_budget::ComputeBudget,
    solana_sbpf::{
        ebpf,
        elf::Executable,
        program::BuiltinProgram,
        static_analysis::Analysis,
        vm::{Config, ContextObject},
    },
    std::{collections::BTreeMap, fs, path::Path, sync::Arc},
};

/// Returns the base compute-unit cost agave charges for `syscall_name`.
///
/// Pulled directly from `ComputeBudget` constants so the numbers match
/// what the runtime would actually meter (minus variable parts we can't
/// infer from registers — big-buffer hash/log costs in particular).
///
/// Unknown syscalls fall back to `syscall_base_cost`, which is what
/// agave itself uses as the floor for "any syscall at all" work.
fn syscall_cost(budget: &ComputeBudget, syscall_name: &str) -> u64 {
    match syscall_name {
        "sol_log_64_" => budget.log_64_units,
        "sol_log_pubkey" => budget.log_pubkey_units,
        "sol_sha256" | "sol_keccak256" | "sol_blake3" => budget.sha256_base_cost,
        "sol_secp256k1_recover" => budget.secp256k1_recover_cost,
        "sol_invoke_signed_c" | "sol_invoke_signed_rust" => budget.invoke_units,
        "sol_create_program_address" | "sol_try_find_program_address" => {
            budget.create_program_address_units
        }
        "sol_memcpy_" | "sol_memmove_" | "sol_memset_" | "sol_memcmp_" => budget.mem_op_base_cost,
        "sol_get_clock_sysvar"
        | "sol_get_epoch_schedule_sysvar"
        | "sol_get_fees_sysvar"
        | "sol_get_rent_sysvar"
        | "sol_get_last_restart_slot"
        | "sol_get_epoch_rewards_sysvar"
        | "sol_get_sysvar" => budget.sysvar_base_cost,
        "sol_curve_validate_point" => budget.curve25519_edwards_validate_point_cost,
        "sol_curve_group_op" => budget.curve25519_edwards_add_cost,
        "sol_big_mod_exp" => budget.big_modular_exponentiation_base_cost,
        "sol_remaining_compute_units" => budget.get_remaining_compute_units_cost,
        "sol_alt_bn128_compression" => budget.alt_bn128_g1_compress,
        "sol_alt_bn128_group_op" => budget.alt_bn128_addition_cost,
        "sol_poseidon" => budget.poseidon_cost_coefficient_c,
        // Includes sol_log_, sol_log_data, sol_log_compute_units_, abort,
        // sol_panic_, sol_set_return_data, sol_get_return_data,
        // sol_get_stack_height, sol_get_epoch_stake,
        // sol_get_processed_sibling_instruction, and anything agave added
        // that we haven't mapped yet.
        _ => budget.syscall_base_cost,
    }
}

pub struct FlamegraphReport {
    pub program_name: String,
    pub total_cu: u64,
    pub stacks: BTreeMap<Vec<String>, u64>,
}

type FunctionSymbolMap = BTreeMap<u64, String>;
type SyscallSymbolMap = BTreeMap<u32, String>;
type SymbolCache = BTreeMap<String, (FunctionSymbolMap, SyscallSymbolMap)>;

/// Size in bytes of one register trace entry: 12 x u64 = 96 bytes.
pub const REGS_ENTRY_SIZE: usize = 12 * std::mem::size_of::<u64>();

/// Size in bytes of one raw SBPF instruction: 8 bytes.
pub const INSN_ENTRY_SIZE: usize = 8;

/// One step yielded by [`stream_trace`].
///
/// Borrowed from the caller's maintained call stack so consumers that only
/// care about a snapshot can clone into owned state on demand.
pub struct StreamStep<'a> {
    pub pc: u64,
    pub regs: [u64; 12],
    pub insn: [u8; 8],
    /// Call stack from program-root to current frame. Length >= 1.
    pub call_stack: &'a [String],
    /// Resolved function display name for this PC (same as `call_stack.last()`
    /// with the `@ {entry_pc:#x}` suffix stripped).
    pub func: &'a str,
    /// `Some(name)` if this step is a syscall leaf (SBPFv1 `CALL_IMM` where
    /// the next traced PC == pc+1); `None` otherwise.
    pub syscall: Option<String>,
    /// CU cost attributed to this step: 1 for a plain instruction, or the
    /// syscall base cost (from `ComputeBudget`) for a syscall leaf.
    pub cu_cost: u64,
}

/// Provides the minimal VM context needed to parse and inspect an executable.
#[derive(Default)]
struct NoopContext;

impl ContextObject for NoopContext {
    fn consume(&mut self, _amount: u64) {}
    fn get_remaining(&self) -> u64 {
        0
    }
}

/// Streams a trace (regs + insns pair), invoking `visit` for every step with
/// the up-to-date call stack, resolved function, CU cost, and (for syscall
/// leaves) the syscall name.
///
/// The algorithm is PC-driven rather than opcode-driven: for every traced
/// instruction we look up which function the PC falls into and resync the
/// maintained call stack against it. If the resolved function is already in
/// the stack we pop down to it (we missed one or more returns); if it's not
/// in the stack we push it (we missed a call, e.g. via a tail call or direct
/// branch). This is more robust than dispatching off `EXIT`/`RETURN` opcodes
/// because direct jumps between functions never produce a matching call/ret
/// pair.
///
/// The one case we still special-case is SBPFv1's `CALL_IMM` → syscall: a
/// syscall does not change the persistent call stack (the caller resumes at
/// the next instruction), but we still want to attribute its single traced
/// CU to a `[syscall] {name}` leaf frame for display.
#[allow(clippy::too_many_arguments)]
pub fn stream_trace(
    regs_data: &[u8],
    insns_data: &[u8],
    count: usize,
    symbol_map: &BTreeMap<u64, String>,
    syscall_names: &BTreeMap<u32, String>,
    program_name: &str,
    budget: &ComputeBudget,
    mut visit: impl FnMut(StreamStep<'_>),
) {
    // Track the call stack by maintaining a stack of function display names.
    // The root frame is the program name and is never popped. Every other
    // frame is formatted as `{function_name} @ {entry_pc:#x}` so the SVG
    // shows both the resolved symbol and its SBPF entry point.
    let mut call_stack: Vec<String> = vec![program_name.to_owned()];

    for i in 0..count {
        let regs = read_regs(regs_data, i);
        let insn = read_insn(insns_data, i);
        let pc = regs[11];

        // Resolve the function containing this PC along with its entry PC,
        // and build the display frame name we'd use if we had to push it.
        let (current_name, current_entry_pc) = lookup_function_with_pc(symbol_map, pc);
        let current_frame = format!("{current_name} @ {current_entry_pc:#x}");

        // PC-driven call-stack resync. If the top of the stack no longer
        // matches the current frame, either we missed one or more returns
        // (pop down to `current_frame` if it is anywhere in the stack) or we
        // missed a call (push `current_frame`).
        if call_stack.last().map(String::as_str) != Some(current_frame.as_str()) {
            if let Some(depth) = call_stack.iter().rposition(|f| f == &current_frame) {
                call_stack.truncate(depth + 1);
            } else {
                call_stack.push(current_frame);
            }
        }

        // SBPFv1 CALL_IMM is overloaded: it's either an internal call (PC
        // jumps to the callee on the next trace entry) or an external
        // syscall (PC advances by 1). We only need to intercept the syscall
        // case — internal calls are handled by the resync above on the next
        // iteration, which will see the callee's PC and push it.
        if insn[0] == ebpf::CALL_IMM {
            let imm = u32::from_le_bytes(insn[4..8].try_into().unwrap());
            let is_syscall = if i + 1 < count {
                let next_regs = read_regs(regs_data, i + 1);
                let next_pc = next_regs[11];
                // Syscall: PC advances by 1 (next sequential instruction).
                // Internal call: PC jumps to a different location.
                next_pc == pc + 1
            } else {
                // Last traced instruction — treat as internal call so the
                // call site is attributed to the current frame rather than
                // an unresolvable syscall stub.
                false
            };

            if is_syscall {
                let syscall_name = syscall_names
                    .get(&imm)
                    .cloned()
                    .unwrap_or_else(|| format!("syscall_{imm:#x}"));
                let cost = syscall_cost(budget, &syscall_name);
                visit(StreamStep {
                    pc,
                    regs,
                    insn,
                    call_stack: &call_stack,
                    func: &current_name,
                    syscall: Some(syscall_name),
                    cu_cost: cost,
                });
                continue;
            }
        }

        // Default attribution: 1 CU to the current call-stack top. EXIT /
        // RETURN opcodes fall into this arm too — their pop is handled
        // implicitly by the next iteration's PC-driven resync.
        visit(StreamStep {
            pc,
            regs,
            insn,
            call_stack: &call_stack,
            func: &current_name,
            syscall: None,
            cu_cost: 1,
        });
    }
}

/// Folds a trace into SVG stacks + total CU by consuming [`stream_trace`].
fn process_trace(
    regs_data: &[u8],
    insns_data: &[u8],
    count: usize,
    symbol_map: &BTreeMap<u64, String>,
    syscall_names: &BTreeMap<u32, String>,
    program_name: &str,
    budget: &ComputeBudget,
) -> (BTreeMap<Vec<String>, u64>, u64) {
    let mut folded_stacks: BTreeMap<Vec<String>, u64> = BTreeMap::new();
    let mut total_cu: u64 = 0;

    stream_trace(
        regs_data,
        insns_data,
        count,
        symbol_map,
        syscall_names,
        program_name,
        budget,
        |step| {
            total_cu += step.cu_cost;
            if let Some(syscall) = &step.syscall {
                let mut stack: Vec<String> = step.call_stack.to_vec();
                stack.push(format!("[syscall] {syscall}"));
                *folded_stacks.entry(stack).or_default() += step.cu_cost;
            } else {
                *folded_stacks.entry(step.call_stack.to_vec()).or_default() += step.cu_cost;
            }
        },
    );

    (folded_stacks, total_cu)
}

/// Reads the i-th register entry (12 x u64) from raw bytes.
pub fn read_regs(data: &[u8], i: usize) -> [u64; 12] {
    let offset = i * REGS_ENTRY_SIZE;
    let mut regs = [0u64; 12];
    for (r, reg) in regs.iter_mut().enumerate() {
        let start = offset + r * 8;
        let bytes: [u8; 8] = data[start..start + 8].try_into().unwrap();
        *reg = u64::from_le_bytes(bytes);
    }
    regs
}

/// Reads the i-th instruction entry (8 bytes) from raw bytes.
pub fn read_insn(data: &[u8], i: usize) -> [u8; 8] {
    let offset = i * INSN_ENTRY_SIZE;
    data[offset..offset + 8].try_into().unwrap()
}

/// Looks up the function name AND entry PC for a given PC using the symbol
/// map, by walking to the nearest lower-or-equal symbol entry. Returns
/// `("unknown_{pc:#x}", pc)` as a fallback when the map has no covering
/// entry.
pub fn lookup_function_with_pc(symbol_map: &BTreeMap<u64, String>, pc: u64) -> (String, u64) {
    symbol_map
        .range(..=pc)
        .next_back()
        .map(|(entry_pc, name)| (name.clone(), *entry_pc))
        .unwrap_or_else(|| (format!("unknown_{pc:#x}"), pc))
}

/// One invocation's trace files + the program it ran.
pub struct InvocationFiles {
    pub inv_seq: u32,
    pub tx_seq: u32,
    pub program_id: String,
    pub regs_path: std::path::PathBuf,
    pub insns_path: std::path::PathBuf,
}

/// Parses filenames like `0001__tx2.regs` (written by
/// `anchor-v2-testing`'s `TestNameCallback`) and groups everything
/// under a test directory into a stable, tx-ordered list of
/// invocations. Ignores files that don't match the expected layout or
/// are missing a sibling.
pub fn discover_invocations(trace_dir: &Path) -> Result<Vec<InvocationFiles>> {
    let mut found = Vec::new();
    if !trace_dir.exists() {
        return Ok(found);
    }

    let entries = fs::read_dir(trace_dir)
        .with_context(|| format!("Failed to read trace directory {}", trace_dir.display()))?;

    for entry in entries {
        let entry = entry?;
        let path = entry.path();
        if path.extension().and_then(|e| e.to_str()) != Some("regs") {
            continue;
        }
        let stem = match path.file_stem().and_then(|s| s.to_str()) {
            Some(s) => s,
            None => continue,
        };
        // Expect `NNNN__txN`.
        let Some((inv_part, tx_part)) = stem.split_once("__") else {
            continue;
        };
        let Some(tx_digits) = tx_part.strip_prefix("tx") else {
            continue;
        };
        let Ok(inv_seq) = inv_part.parse::<u32>() else {
            continue;
        };
        let Ok(tx_seq) = tx_digits.parse::<u32>() else {
            continue;
        };

        let insns_path = path.with_extension("insns");
        let pid_path = path.with_extension("program_id");
        if !insns_path.exists() || !pid_path.exists() {
            continue;
        }
        let program_id = match fs::read_to_string(&pid_path) {
            Ok(s) => s.trim().to_owned(),
            Err(_) => continue,
        };

        found.push(InvocationFiles {
            inv_seq,
            tx_seq,
            program_id,
            regs_path: path,
            insns_path,
        });
    }

    // Deterministic: ascending by (tx, inv).
    found.sort_by_key(|f| (f.tx_seq, f.inv_seq));
    Ok(found)
}

/// Build one [`FlamegraphReport`] per outer transaction in the test.
///
/// Each tx's report folds together every invocation (top-level +
/// CPIs) within that tx, symbolicating each invocation against its
/// own program's ELF. Invocations whose `program_id` has no entry in
/// `programs` contribute frames labeled `[unresolved <pid>]` so CUs
/// aren't silently dropped.
///
/// Returns reports keyed by `tx_seq` (1-indexed, matching the
/// `TestNameCallback`'s before-invocation counter). Empty map if the
/// directory has no parseable traces.
pub fn build_tx_reports(
    test_name: &str,
    test_dir: &Path,
    programs: &std::collections::BTreeMap<String, std::path::PathBuf>,
    manifest_dir: Option<&Path>,
) -> Result<std::collections::BTreeMap<u32, FlamegraphReport>> {
    let invocations = discover_invocations(test_dir)?;
    if invocations.is_empty() {
        return Ok(std::collections::BTreeMap::new());
    }

    // Cache symbol maps per program — loading an ELF is expensive.
    let mut symbol_cache: SymbolCache = BTreeMap::new();
    for (pid, elf) in programs {
        if let Ok(maps) = load_function_map(elf, manifest_dir) {
            symbol_cache.insert(pid.clone(), maps);
        }
    }

    // Fallback (empty) maps for invocations whose program we can't
    // resolve. We still want their CU accounted for, just as flat
    // `[unresolved]` stacks.
    let empty_symbols: BTreeMap<u64, String> = BTreeMap::new();
    let empty_syscalls: BTreeMap<u32, String> = BTreeMap::new();

    let mut reports: std::collections::BTreeMap<u32, (BTreeMap<Vec<String>, u64>, u64)> =
        std::collections::BTreeMap::new();
    let budget = ComputeBudget::new_with_defaults(false, false);

    for inv in &invocations {
        let regs = fs::read(&inv.regs_path)
            .with_context(|| format!("read {}", inv.regs_path.display()))?;
        let insns = fs::read(&inv.insns_path)
            .with_context(|| format!("read {}", inv.insns_path.display()))?;
        let count = (regs.len() / REGS_ENTRY_SIZE).min(insns.len() / INSN_ENTRY_SIZE);
        if count == 0 {
            continue;
        }

        let (symbols, syscalls) = match symbol_cache.get(&inv.program_id) {
            Some((s, c)) => (s, c),
            None => (&empty_symbols, &empty_syscalls),
        };

        // Label the program frame by short program id (first 8 +
        // last 4 chars) so it's identifiable but not taking half the
        // SVG width. Resolved programs use a nicer name when the ELF
        // filename is known.
        let program_label = match programs.get(&inv.program_id) {
            Some(elf_path) => {
                let short_pid = short_pid(&inv.program_id);
                elf_path
                    .file_stem()
                    .and_then(|s| s.to_str())
                    .map(|n| format!("[program {n} ({short_pid})]"))
                    .unwrap_or_else(|| format!("[program {}]", inv.program_id))
            }
            None => format!("[unresolved {}]", short_pid(&inv.program_id)),
        };

        let (stacks, cu) = process_trace(
            &regs,
            &insns,
            count,
            symbols,
            syscalls,
            &program_label,
            &budget,
        );
        let entry = reports
            .entry(inv.tx_seq)
            .or_insert_with(|| (BTreeMap::new(), 0));
        for (stack, cost) in stacks {
            *entry.0.entry(stack).or_default() += cost;
        }
        entry.1 += cu;
    }

    Ok(reports
        .into_iter()
        .filter(|(_, (_, cu))| *cu > 0)
        .map(|(tx_seq, (stacks, cu))| {
            (
                tx_seq,
                FlamegraphReport {
                    program_name: format!("{test_name} · tx{tx_seq}"),
                    total_cu: cu,
                    stacks,
                },
            )
        })
        .collect())
}

fn short_pid(pid: &str) -> String {
    if pid.len() <= 13 {
        pid.to_owned()
    } else {
        format!("{}{}", &pid[..8], &pid[pid.len() - 4..])
    }
}

/// Loads function symbols from an ELF file using the SBPF loader.
///
/// This parses the ELF with `solana_sbpf` to extract the function registry and
/// analysis labels, which contain all internal function entry points with their
/// demangled names. Additionally loads symbols from the ELF's object-level symbol
/// table (dynamic symbols) as a fallback.
///
/// If the deployed binary is stripped (common for `cargo-build-sbf`), we also
/// try loading symbols from the unstripped build artifact in the
/// `target/sbpf-solana-solana/release/` directory.
pub fn load_function_map(
    elf_path: &Path,
    manifest_dir: Option<&Path>,
) -> Result<(BTreeMap<u64, String>, BTreeMap<u32, String>)> {
    let elf_bytes =
        fs::read(elf_path).with_context(|| format!("Failed to read ELF {}", elf_path.display()))?;

    // Parse through SBPF to get function registry labels.
    let loader = Arc::new(BuiltinProgram::new_loader(Config {
        enable_symbol_and_section_labels: true,
        ..Config::default()
    }));

    let executable = Executable::<NoopContext>::from_elf(&elf_bytes, loader)
        .map_err(|err| anyhow!("Failed to parse SBPF ELF {}: {err}", elf_path.display()))?;

    let analysis = Analysis::from_executable(&executable)
        .map_err(|err| anyhow!("Failed to analyze SBPF executable: {err}"))?;

    let mut symbols: BTreeMap<u64, String> = BTreeMap::new();

    // Primary source: SBPF analysis function labels (internal function registry).
    for (pc, (_key, name)) in analysis.functions.iter() {
        let normalized = normalize_symbol(name, *pc);
        symbols.entry(*pc as u64).or_insert(normalized);
    }

    // Secondary source: symbols from the deployed ELF (often stripped).
    if let Ok(extra) = load_elf_symbols(&elf_bytes) {
        for (pc, name) in extra {
            symbols.entry(pc as u64).or_insert(name);
        }
    }

    // Tertiary source: the unstripped pre-deploy binary in the build directory.
    // cargo-build-sbf strips the binary before copying to target/deploy/, but
    // the unstripped version remains in target/sbpf-solana-solana/release/.
    if let Some(unstripped_path) = find_unstripped_binary(elf_path, manifest_dir) {
        if let Ok(unstripped_bytes) = fs::read(&unstripped_path) {
            if let Ok(extra) = load_elf_symbols(&unstripped_bytes) {
                for (pc, name) in extra {
                    // Only overwrite generic "function_N" labels.
                    let entry = symbols.entry(pc as u64);
                    match entry {
                        std::collections::btree_map::Entry::Vacant(v) => {
                            v.insert(name);
                        }
                        std::collections::btree_map::Entry::Occupied(mut o) => {
                            if o.get().starts_with("function_") {
                                o.insert(name);
                            }
                        }
                    }
                }
            }
        }
    }

    Ok((symbols, syscall_hash_map()))
}

/// Known syscall names registered by `agave`/`solana-program-runtime`. Used
/// both for symbol resolution in trace processing and to seed sbpf's loader
/// registry so its disassembler can name `CALL_IMM` syscalls instead of
/// printing `[invalid]`.
pub const KNOWN_SYSCALLS: &[&str] = &[
    // Panics / aborts.
    "abort",
    // Logging.
    "sol_log_",
    "sol_log_64_",
    "sol_log_compute_units_",
    "sol_log_data",
    "sol_log_pubkey",
    // Hashing + crypto.
    "sol_sha256",
    "sol_keccak256",
    "sol_blake3",
    "sol_poseidon",
    "sol_secp256k1_recover",
    "sol_curve_validate_point",
    "sol_curve_group_op",
    "sol_curve_multiscalar_mul",
    "sol_curve_pairing_map",
    "sol_alt_bn128_group_op",
    "sol_alt_bn128_compression",
    "sol_big_mod_exp",
    // CPIs.
    "sol_invoke_signed_c",
    "sol_invoke_signed_rust",
    // Return data.
    "sol_set_return_data",
    "sol_get_return_data",
    // PDAs.
    "sol_create_program_address",
    "sol_try_find_program_address",
    // Memory ops.
    "sol_memcpy_",
    "sol_memmove_",
    "sol_memset_",
    "sol_memcmp_",
    // Sysvars (individual fast paths + the generic dispatcher).
    "sol_get_clock_sysvar",
    "sol_get_epoch_schedule_sysvar",
    "sol_get_fees_sysvar",
    "sol_get_rent_sysvar",
    "sol_get_last_restart_slot",
    "sol_get_epoch_rewards_sysvar",
    "sol_get_sysvar",
    // Misc.
    "sol_panic_",
    "sol_get_processed_sibling_instruction",
    "sol_get_stack_height",
    "sol_remaining_compute_units",
    "sol_get_epoch_stake",
];

/// Build the syscall hash → name map for trace processing. Hashes are
/// computed on the fly via `solana_sbpf::ebpf::hash_symbol_name` so we
/// never have to keep a table of hex magic numbers in sync.
///
/// When a new syscall lands in agave-syscalls, add its name to
/// [`KNOWN_SYSCALLS`] and it'll automatically get symbolicated.
fn syscall_hash_map() -> BTreeMap<u32, String> {
    KNOWN_SYSCALLS
        .iter()
        .map(|name| {
            (
                solana_sbpf::ebpf::hash_symbol_name(name.as_bytes()),
                (*name).to_owned(),
            )
        })
        .collect()
}

/// Tries to locate the unstripped SBF binary for a deployed program.
///
/// `cargo-build-sbf --sbf-out-dir <dir>` copies a **stripped** .so into
/// `<dir>/`, but the unstripped build artifact remains in the cargo target
/// tree of whichever workspace actually compiled the program. In the bench
/// setup that can be any of:
///
///   - `<bench>/target/sbpf-solana-solana/release/<name>.so` — for programs
///     that are bench-workspace members (anchor v1 / v2).
///   - `<bench>/programs/<family>/<variant>/target/sbpf-solana-solana/release/<name>.so`
///     — for programs with their own `[workspace]` (pinocchio / steel / quasar).
///   - `<repo>/target/sbpf-solana-solana/release/<name>.so` — historical
///     location when building from the repo root.
///
/// Rather than enumerate every path combinatorially, we walk upward from the
/// deployed .so until we hit a directory that contains a `bench/` or
/// `programs/` sibling (the repo root-ish), then do a bounded recursive
/// search under it for a file matching `name` inside any
/// `sbpf-solana-solana/release` directory. Returns the first non-stripped
/// match, or `None` if nothing is found.
pub fn find_unstripped_binary(
    deployed_path: &Path,
    manifest_dir: Option<&Path>,
) -> Option<std::path::PathBuf> {
    let file_name = deployed_path.file_name()?.to_str()?.to_owned();

    // Preferred path: walk up from the manifest dir to find the nearest
    // containing `[workspace]` Cargo.toml (the workspace root that actually
    // built the program). For an isolated `[workspace]` program the root is
    // the manifest dir itself; for a bench-workspace member it's several
    // levels up (e.g. `bench/programs/helloworld/anchor-v1` → `bench/`).
    // Cargo always places build artifacts under `<workspace_root>/target/`,
    // so this gives us a precise lookup with no ambiguity — the same
    // program rebuilt at a different lib name couldn't leak a stale binary
    // because the workspace root is deterministic from the manifest path.
    if let Some(manifest) = manifest_dir {
        if let Some(root) = find_workspace_root(manifest) {
            let direct = root
                .join("target")
                .join("sbpf-solana-solana")
                .join("release")
                .join(&file_name);
            if direct.exists() {
                return Some(direct);
            }
            let deps = root
                .join("target")
                .join("sbpf-solana-solana")
                .join("release")
                .join("deps")
                .join(&file_name);
            if deps.exists() {
                return Some(deps);
            }
        }
    }

    // Fallback: walk up the deployed path to a plausible repo root and
    // recursively search for the file under any `sbpf-solana-solana/release`
    // directory. This handles historical layouts and cases where no
    // manifest_dir was supplied.
    let mut root = deployed_path.parent()?;
    loop {
        let parent = root.parent()?;
        let has_bench = parent.join("bench").is_dir();
        let has_target = parent.join("target").is_dir();
        if has_bench || has_target {
            root = parent;
            break;
        }
        root = parent;
    }

    search_for_unstripped(root, &file_name, 0)
}

/// Walks up from `manifest_dir` looking for a `Cargo.toml` that declares a
/// `[workspace]` table. Returns the directory of the first such manifest, or
/// `manifest_dir` itself if none is found (assumes single-crate repo).
fn find_workspace_root(manifest_dir: &Path) -> Option<std::path::PathBuf> {
    let mut current: std::path::PathBuf = manifest_dir.to_path_buf();
    loop {
        let cargo_toml = current.join("Cargo.toml");
        if cargo_toml.exists() {
            if let Ok(contents) = fs::read_to_string(&cargo_toml) {
                // Crude but good enough: the marker `[workspace]` at the
                // start of a line or after a newline means this Cargo.toml
                // defines a workspace.
                if contents.contains("\n[workspace]") || contents.starts_with("[workspace]") {
                    return Some(current);
                }
            }
        }
        let parent = current.parent()?;
        current = parent.to_path_buf();
    }
}

/// Recursively searches `dir` for `file_name` inside any
/// `sbpf-solana-solana/release` subdirectory. Depth-limited to avoid
/// pathological descent into dependencies. Returns the first match that is
/// not stripped (larger than the matching deployed .so would be — we can't
/// cheaply check strip state, but filtering by "inside release" usually
/// works since cargo's own target tree always keeps symbols).
fn search_for_unstripped(dir: &Path, file_name: &str, depth: usize) -> Option<std::path::PathBuf> {
    // Hard cap on recursion: repo layouts never nest workspaces more than
    // ~4 deep (e.g. `<repo>/bench/programs/<family>/<variant>/target/...`).
    // 6 is generous and cheap.
    if depth > 6 {
        return None;
    }

    // Quick check: does this directory already contain the file we want at
    // the expected `sbpf-solana-solana/release/<file>` path?
    let direct = dir
        .join("target")
        .join("sbpf-solana-solana")
        .join("release")
        .join(file_name);
    if direct.exists() {
        return Some(direct);
    }
    let deps = dir
        .join("target")
        .join("sbpf-solana-solana")
        .join("release")
        .join("deps")
        .join(file_name);
    if deps.exists() {
        return Some(deps);
    }

    // Recurse into subdirectories — but skip well-known noisy subtrees.
    let entries = fs::read_dir(dir).ok()?;
    for entry in entries.flatten() {
        let path = entry.path();
        if !path.is_dir() {
            continue;
        }
        let Some(name) = path.file_name().and_then(|n| n.to_str()) else {
            continue;
        };
        // Skip hidden dirs, target/deploy (stripped), node_modules, .git.
        if name.starts_with('.')
            || name == "node_modules"
            || name == "deploy"
            || name == "deploy-debug"
        {
            continue;
        }
        if let Some(found) = search_for_unstripped(&path, file_name, depth + 1) {
            return Some(found);
        }
    }

    None
}

/// Loads text symbols from an ELF file's symbol tables and maps them to SBPF PCs.
fn load_elf_symbols(elf_bytes: &[u8]) -> Result<BTreeMap<usize, String>> {
    let file = object::File::parse(elf_bytes)
        .map_err(|err| anyhow!("Failed to parse ELF for symbols: {err}"))?;

    let text_section = file
        .sections()
        .find(|s| s.name().ok() == Some(".text"))
        .or_else(|| {
            file.sections()
                .find(|s| s.kind() == object::SectionKind::Text)
        })
        .ok_or_else(|| anyhow!("No .text section"))?;

    let text_address = text_section.address();
    let text_end = text_address.saturating_add(text_section.size());

    let mut symbols = BTreeMap::new();

    for symbol in file.symbols().chain(file.dynamic_symbols()) {
        if symbol.kind() != SymbolKind::Text || symbol.address() == 0 {
            continue;
        }
        let Ok(name) = symbol.name() else {
            continue;
        };
        if name.is_empty() {
            continue;
        }

        let address = symbol.address();
        if address < text_address || address >= text_end {
            continue;
        }

        let relative = address - text_address;
        if relative % ebpf::INSN_SIZE as u64 != 0 {
            continue;
        }

        let pc = (relative / ebpf::INSN_SIZE as u64) as usize;
        symbols
            .entry(pc)
            .or_insert_with(|| normalize_symbol(name, pc));
    }

    Ok(symbols)
}

/// Demangles and normalizes a raw symbol for flamegraph display.
fn normalize_symbol(name: &str, pc: usize) -> String {
    let trimmed = name.trim_matches(char::from(0));
    let normalized = if trimmed.is_empty() {
        format!("function_{pc}")
    } else {
        demangle(trimmed).to_string()
    };

    let cleaned = strip_rust_hash_suffix(&normalized)
        .replace(';', ":")
        .replace('\n', " ");

    shorten_qualified_name(&cleaned)
}

/// Removes the trailing rustc symbol hash suffix when present.
fn strip_rust_hash_suffix(symbol: &str) -> &str {
    let Some((prefix, suffix)) = symbol.rsplit_once("::h") else {
        return symbol;
    };

    if suffix.len() == 16 && suffix.bytes().all(|b| b.is_ascii_hexdigit()) {
        prefix
    } else {
        symbol
    }
}

/// Shortens a fully qualified Rust name to at most the last 3 segments.
fn shorten_qualified_name(name: &str) -> String {
    // Don't shorten names that contain generic parameters or closures.
    if name.contains('<') || name.contains('{') || name.matches("::").count() <= 2 {
        return name.to_owned();
    }

    let parts: Vec<&str> = name.split("::").collect();
    if parts.len() <= 3 {
        return name.to_owned();
    }

    parts[parts.len() - 3..].join("::")
}

#[cfg(test)]
mod tests {
    use {super::*, std::path::Path, tempfile::tempdir};

    fn regs_bytes(pcs: &[u64]) -> Vec<u8> {
        let mut out = Vec::with_capacity(pcs.len() * REGS_ENTRY_SIZE);
        for pc in pcs {
            let mut regs = [0u64; 12];
            regs[11] = *pc;
            for reg in regs {
                out.extend_from_slice(&reg.to_le_bytes());
            }
        }
        out
    }

    fn insns_bytes(insns: &[[u8; INSN_ENTRY_SIZE]]) -> Vec<u8> {
        insns.iter().flat_map(|insn| insn.iter().copied()).collect()
    }

    fn plain_insns(count: usize) -> Vec<[u8; INSN_ENTRY_SIZE]> {
        vec![[0; INSN_ENTRY_SIZE]; count]
    }

    fn call_imm(imm: u32) -> [u8; INSN_ENTRY_SIZE] {
        let mut insn = [0; INSN_ENTRY_SIZE];
        insn[0] = ebpf::CALL_IMM;
        insn[4..8].copy_from_slice(&imm.to_le_bytes());
        insn
    }

    fn write_invocation(dir: &Path, stem: &str, program_id: &str, pcs: &[u64]) {
        std::fs::create_dir_all(dir).unwrap();
        let insns = plain_insns(pcs.len());
        std::fs::write(dir.join(format!("{stem}.regs")), regs_bytes(pcs)).unwrap();
        std::fs::write(dir.join(format!("{stem}.insns")), insns_bytes(&insns)).unwrap();
        std::fs::write(dir.join(format!("{stem}.program_id")), program_id).unwrap();
    }

    #[test]
    fn lookup_function_with_pc_uses_nearest_lower_symbol() {
        let symbols = BTreeMap::from([
            (10, "entry".to_string()),
            (20, "callee".to_string()),
            (40, "tail".to_string()),
        ]);

        assert_eq!(
            lookup_function_with_pc(&symbols, 20),
            ("callee".to_string(), 20)
        );
        assert_eq!(
            lookup_function_with_pc(&symbols, 27),
            ("callee".to_string(), 20)
        );
        assert_eq!(
            lookup_function_with_pc(&symbols, 9),
            ("unknown_0x9".to_string(), 9)
        );
    }

    #[test]
    fn stream_trace_resyncs_call_stack_from_pc_flow() {
        let symbols = BTreeMap::from([
            (0, "entry".to_string()),
            (10, "callee".to_string()),
            (20, "tail".to_string()),
        ]);
        let pcs = [0, 1, 10, 11, 2, 20, 21, 3];
        let insns = plain_insns(pcs.len());
        let mut observed = Vec::new();

        stream_trace(
            &regs_bytes(&pcs),
            &insns_bytes(&insns),
            pcs.len(),
            &symbols,
            &BTreeMap::new(),
            "program",
            &ComputeBudget::new_with_defaults(false, false),
            |step| observed.push((step.pc, step.func.to_owned(), step.call_stack.to_vec())),
        );

        assert_eq!(
            observed
                .iter()
                .map(|(_, _, stack)| stack.len())
                .collect::<Vec<_>>(),
            vec![2, 2, 3, 3, 2, 3, 3, 2]
        );
        assert_eq!(observed[2].1, "callee");
        assert_eq!(observed[4].1, "entry");
        assert_eq!(observed[5].1, "tail");
        assert_eq!(observed[7].1, "entry");
    }

    #[test]
    fn stream_trace_attributes_sequential_call_imm_as_syscall_leaf() {
        let symbols = BTreeMap::from([(0, "entry".to_string())]);
        let syscall_hash = ebpf::hash_symbol_name(b"sol_log_64_");
        let syscall_names = BTreeMap::from([(syscall_hash, "sol_log_64_".to_string())]);
        let pcs = [0, 1];
        let insns = [call_imm(syscall_hash), [0; INSN_ENTRY_SIZE]];
        let mut observed = Vec::new();

        stream_trace(
            &regs_bytes(&pcs),
            &insns_bytes(&insns),
            pcs.len(),
            &symbols,
            &syscall_names,
            "program",
            &ComputeBudget::new_with_defaults(false, false),
            |step| {
                observed.push((
                    step.pc,
                    step.syscall.clone(),
                    step.cu_cost,
                    step.call_stack.to_vec(),
                ))
            },
        );

        assert_eq!(observed[0].0, 0);
        assert_eq!(observed[0].1.as_deref(), Some("sol_log_64_"));
        assert!(observed[0].2 > 1);
        assert_eq!(observed[0].3, vec!["program", "entry @ 0x0"]);
        assert_eq!(observed[1].1, None);
        assert_eq!(observed[1].3, vec!["program", "entry @ 0x0"]);
    }

    #[test]
    fn stream_trace_does_not_treat_last_call_imm_as_syscall() {
        let symbols = BTreeMap::from([(0, "entry".to_string())]);
        let syscall_hash = ebpf::hash_symbol_name(b"sol_log_64_");
        let syscall_names = BTreeMap::from([(syscall_hash, "sol_log_64_".to_string())]);
        let mut observed = Vec::new();

        stream_trace(
            &regs_bytes(&[0]),
            &insns_bytes(&[call_imm(syscall_hash)]),
            1,
            &symbols,
            &syscall_names,
            "program",
            &ComputeBudget::new_with_defaults(false, false),
            |step| observed.push((step.syscall.clone(), step.cu_cost)),
        );

        assert_eq!(observed, vec![(None, 1)]);
    }

    #[test]
    fn discover_invocations_sorts_by_tx_then_inv_and_ignores_incomplete_files() {
        let dir = tempdir().unwrap();
        write_invocation(dir.path(), "0002__tx1", "pid_b", &[0]);
        write_invocation(dir.path(), "0001__tx2", "pid_c", &[0]);
        write_invocation(dir.path(), "0001__tx1", "pid_a", &[0]);
        std::fs::write(dir.path().join("bad.regs"), regs_bytes(&[0])).unwrap();
        std::fs::write(dir.path().join("0003__tx1.regs"), regs_bytes(&[0])).unwrap();
        std::fs::write(dir.path().join("0004__tx1.regs"), regs_bytes(&[0])).unwrap();
        std::fs::write(
            dir.path().join("0004__tx1.insns"),
            insns_bytes(&plain_insns(1)),
        )
        .unwrap();
        std::fs::write(dir.path().join("0005__tx1.gdb.regs"), regs_bytes(&[0])).unwrap();

        let found = discover_invocations(dir.path()).unwrap();

        assert_eq!(found.len(), 3);
        assert_eq!(
            found
                .iter()
                .map(|inv| (inv.tx_seq, inv.inv_seq, inv.program_id.as_str()))
                .collect::<Vec<_>>(),
            vec![(1, 1, "pid_a"), (1, 2, "pid_b"), (2, 1, "pid_c")]
        );
    }

    #[test]
    fn build_tx_reports_separates_transactions_and_keeps_unresolved_program_cu() {
        let dir = tempdir().unwrap();
        let pid = "Program111111111111111111111111111111111";
        write_invocation(dir.path(), "0001__tx1", pid, &[0, 1]);
        write_invocation(dir.path(), "0002__tx2", pid, &[0]);

        let reports = build_tx_reports("case", dir.path(), &BTreeMap::new(), None).unwrap();

        assert_eq!(reports.keys().copied().collect::<Vec<_>>(), vec![1, 2]);
        assert_eq!(reports[&1].program_name, "case · tx1");
        assert_eq!(reports[&1].total_cu, 2);
        assert_eq!(reports[&2].total_cu, 1);
        assert!(reports[&1]
            .stacks
            .keys()
            .any(|stack| stack.first().is_some_and(|f| f.starts_with("[unresolved "))));
    }

    #[test]
    fn build_tx_reports_merges_multiple_invocations_in_same_tx() {
        let dir = tempdir().unwrap();
        let pid = "Program222222222222222222222222222222222";
        write_invocation(dir.path(), "0001__tx7", pid, &[0]);
        write_invocation(dir.path(), "0002__tx7", pid, &[0]);

        let reports = build_tx_reports("case", dir.path(), &BTreeMap::new(), None).unwrap();

        assert_eq!(reports.keys().copied().collect::<Vec<_>>(), vec![7]);
        let report = &reports[&7];
        assert_eq!(report.total_cu, 2);
        assert_eq!(report.stacks.len(), 1);
        assert_eq!(*report.stacks.values().next().unwrap(), 2);
    }
}