1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* Copyright (c) 2026 Meta Platforms, Inc. and affiliates. */ 3 4 #ifndef __BPF_DIAGNOSTICS_H 5 #define __BPF_DIAGNOSTICS_H 6 7 #include <linux/bpf.h> 8 #include <linux/compiler_attributes.h> 9 #include <linux/stdarg.h> 10 #include <linux/types.h> 11 12 struct bpf_reference_state; 13 struct bpf_func_state; 14 struct bpf_reg_state; 15 struct bpf_verifier_env; 16 struct bpf_verifier_state; 17 struct btf; 18 19 const char *bpf_diag_fmt_s64_sum(struct bpf_verifier_env *env, s64 value, int addend); 20 enum bpf_diag_mod_reason { 21 BPF_DIAG_MOD_WRITE, 22 BPF_DIAG_MOD_SPILL, 23 BPF_DIAG_MOD_VAR_WRITE, 24 BPF_DIAG_MOD_REF_RELEASE, 25 BPF_DIAG_MOD_PKT_DATA_CHANGE, 26 BPF_DIAG_MOD_NON_OWN_REF, 27 BPF_DIAG_MOD_CALLER_SAVED, 28 }; 29 30 enum bpf_diag_context_kind { 31 BPF_DIAG_CONTEXT_NONE, 32 BPF_DIAG_CONTEXT_RCU, 33 BPF_DIAG_CONTEXT_PREEMPT, 34 BPF_DIAG_CONTEXT_IRQ, 35 BPF_DIAG_CONTEXT_LOCK, 36 }; 37 38 enum bpf_diag_invalid_deref_kind { 39 BPF_DIAG_DEREF_SCALAR, 40 BPF_DIAG_DEREF_NULLABLE_PTR, 41 BPF_DIAG_DEREF_MODIFIED_PTR, 42 BPF_DIAG_DEREF_INVALID_PTR, 43 }; 44 45 bool bpf_diag_enabled(const struct bpf_verifier_env *env); 46 int bpf_diag_init(struct bpf_verifier_env *env); 47 void bpf_diag_init_frame(struct bpf_verifier_env *env, struct bpf_func_state *state); 48 char *bpf_diag_fmt_buf(struct bpf_verifier_env *env, size_t size); 49 const char *bpf_diag_vfmt(struct bpf_verifier_env *env, const char *fmt, va_list args) 50 __printf(2, 0); 51 const char *bpf_diag_fmt(struct bpf_verifier_env *env, const char *fmt, ...) __printf(2, 3); 52 const char *bpf_diag_fmt_btf_type(struct bpf_verifier_env *env, const struct btf *btf, u32 type_id); 53 const char *bpf_diag_reg_type_plain(struct bpf_verifier_env *env, enum bpf_reg_type type); 54 u64 bpf_diag_event_log_save(struct bpf_verifier_env *env); 55 void bpf_diag_event_log_restore(struct bpf_verifier_env *env, u64 log_pos); 56 u32 bpf_diag_irq_depth(const struct bpf_verifier_state *state); 57 void bpf_diag_free(struct bpf_verifier_env *env); 58 void bpf_diag_register_type(struct bpf_verifier_env *env, u32 insn_idx, int regno, 59 const char *problem, const char *reason, const char *suggestion); 60 void bpf_diag_invalid_deref(struct bpf_verifier_env *env, u32 insn_idx, int regno, 61 const char *reg_name, const struct bpf_reg_state *reg, 62 enum bpf_diag_invalid_deref_kind kind, s64 offset); 63 void bpf_diag_unreadable_reg(struct bpf_verifier_env *env, u32 insn_idx, int regno); 64 void bpf_diag_stack_arg_uninit(struct bpf_verifier_env *env, u32 insn_idx, int nargs, 65 int stack_arg_slot, const char *callee_name, 66 const char *arg_name); 67 void bpf_diag_memory(struct bpf_verifier_env *env, u32 insn_idx, const char *problem, 68 const char *reason, const char *suggestion); 69 void bpf_diag_mem_bounds(struct bpf_verifier_env *env, u32 insn_idx, int regno, 70 const char *reg_name, const char *type_name, const char *proof, 71 int off, int size, u32 mem_size, const struct bpf_reg_state *reg); 72 void bpf_diag_res(struct bpf_verifier_env *env, u32 insn_idx, const char *problem, 73 const char *reason, const char *suggestion); 74 void bpf_diag_lock(struct bpf_verifier_env *env, u32 insn_idx, const char *problem, 75 const char *reason, const char *suggestion, 76 const struct bpf_reference_state *active_lock); 77 void bpf_diag_irq(struct bpf_verifier_env *env, u32 insn_idx, const char *problem, 78 const char *reason, const char *suggestion, u32 depth); 79 void bpf_diag_leak(struct bpf_verifier_env *env, u32 ref_id, u32 alloc_insn, u32 fail_insn); 80 void bpf_diag_call_type(struct bpf_verifier_env *env, u32 insn_idx, int argno, int regno, 81 int stack_arg_slot, const char *call_name, const char *arg_name, 82 const char *reason, const char *suggestion); 83 void bpf_diag_ctx_forbidden(struct bpf_verifier_env *env, u32 insn_idx, 84 const char *operation, const char *suggestion); 85 void bpf_diag_ctx_active(struct bpf_verifier_env *env, u32 insn_idx, const char *operation, 86 enum bpf_diag_context_kind ctx_kind, const char *suggestion); 87 void bpf_diag_ctx_required(struct bpf_verifier_env *env, u32 insn_idx, const char *operation, 88 enum bpf_diag_context_kind ctx_kind, const char *suggestion); 89 void bpf_diag_ctx_underflow(struct bpf_verifier_env *env, u32 insn_idx, 90 const char *operation, enum bpf_diag_context_kind ctx_kind, 91 const char *suggestion); 92 void bpf_diag_program_structure(struct bpf_verifier_env *env, u32 insn_idx, 93 const char *problem, const char *suggestion, 94 const char *reason_fmt, ...) __printf(5, 6); 95 void bpf_diag_policy(struct bpf_verifier_env *env, u32 insn_idx, const char *operation, 96 const char *reason, const char *suggestion); 97 void bpf_diag_record_branch(struct bpf_verifier_env *env, u32 insn_idx, bool cond_true); 98 void bpf_diag_mod_begin(struct bpf_verifier_env *env, const struct bpf_reg_state *reg, 99 const struct bpf_reg_state *origin, enum bpf_diag_mod_reason reason); 100 void bpf_diag_mod_end(struct bpf_verifier_env *env); 101 void bpf_diag_record_scrub(struct bpf_verifier_env *env, const struct bpf_reg_state *reg, 102 enum bpf_diag_mod_reason reason); 103 void bpf_diag_record_scrub_stack(struct bpf_verifier_env *env, 104 const struct bpf_func_state *state, s16 min_off, s16 max_off, 105 enum bpf_diag_mod_reason reason); 106 void bpf_diag_record_ref_acquire(struct bpf_verifier_env *env, u32 insn_idx, u32 ref_id); 107 void bpf_diag_record_ref_release(struct bpf_verifier_env *env, u32 insn_idx, u32 ref_id); 108 void bpf_diag_record_context(struct bpf_verifier_env *env, u32 insn_idx, 109 enum bpf_diag_context_kind ctx_kind, bool enter, u32 depth); 110 111 #endif /* __BPF_DIAGNOSTICS_H */ 112