rte_bpf_validate_debug.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2025 Huawei Technologies Co., Ltd
 */

#ifndef _RTE_BPF_VALIDATE_DEBUG_H_
#define _RTE_BPF_VALIDATE_DEBUG_H_

#include <bpf_def.h>
#include <rte_compat.h>

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

#define RTE_BPF_VALIDATE_DEBUG_MAY_BE_FALSE RTE_BIT32(0)
#define RTE_BPF_VALIDATE_DEBUG_MAY_BE_TRUE  RTE_BIT32(1)

enum rte_bpf_validate_debug_event {
    /* Just before every instruction, at branch or validation end. */
    RTE_BPF_VALIDATE_DEBUG_EVENT_STEP,
    /* Validator has failed its internal self-checks. */
    RTE_BPF_VALIDATE_DEBUG_EVENT_INVALID_STATE,
    /* Start of validation. */
    RTE_BPF_VALIDATE_DEBUG_EVENT_VALIDATION_START,
    /* Successful finish of validation. */
    RTE_BPF_VALIDATE_DEBUG_EVENT_VALIDATION_SUCCESS,
    /* Finish of validation with error. */
    RTE_BPF_VALIDATE_DEBUG_EVENT_VALIDATION_FAILURE,
    /* Beginning of a branch just after the jump. */
    RTE_BPF_VALIDATE_DEBUG_EVENT_BRANCH_ENTER,
    /* Pruning branch as verified earlier. */
    RTE_BPF_VALIDATE_DEBUG_EVENT_BRANCH_PRUNE,
    /* End of branch verification, after the last verified instruction. */
    RTE_BPF_VALIDATE_DEBUG_EVENT_BRANCH_RETURN,
    /* Pruning branch as dynamically unreachable. */
    RTE_BPF_VALIDATE_DEBUG_EVENT_BRANCH_UNREACHABLE,
    /* Number of valid event values. */
    RTE_BPF_VALIDATE_DEBUG_EVENT_END,
};

struct rte_bpf_validate_debug;
struct rte_bpf_validate_debug_point;

struct rte_bpf_validate_debug_callback {
    int (*fn)(struct rte_bpf_validate_debug *debug, void *ctx);
    void *ctx;
};

typedef int (*rte_bpf_validate_debug_point_process_t)(struct rte_bpf_validate_debug_point *point,
    void *ctx);

__rte_experimental
struct rte_bpf_validate_debug *
rte_bpf_validate_debug_create(void);

__rte_experimental
void
rte_bpf_validate_debug_destroy(struct rte_bpf_validate_debug *debug);

__rte_experimental
struct rte_bpf_validate_debug_point *
rte_bpf_validate_debug_break(struct rte_bpf_validate_debug *debug, uint32_t pc,
    const struct rte_bpf_validate_debug_callback *callback);

__rte_experimental
struct rte_bpf_validate_debug_point *
rte_bpf_validate_debug_catch(struct rte_bpf_validate_debug *debug,
    enum rte_bpf_validate_debug_event event,
    const struct rte_bpf_validate_debug_callback *callback);

__rte_experimental
void
rte_bpf_validate_debug_point_destroy(struct rte_bpf_validate_debug_point *point);

__rte_experimental
const struct rte_bpf_prm_ex *
rte_bpf_validate_debug_get_bpf_param(const struct rte_bpf_validate_debug *debug);

__rte_experimental
int
rte_bpf_validate_debug_get_ins(const struct rte_bpf_validate_debug *debug,
    const struct ebpf_insn **ins, uint32_t *nb_ins);

__rte_experimental
struct rte_bpf_validate_debug_point *
rte_bpf_validate_debug_get_last_point(const struct rte_bpf_validate_debug *debug);

__rte_experimental
uint32_t
rte_bpf_validate_debug_get_pc(const struct rte_bpf_validate_debug *debug);

__rte_experimental
int
rte_bpf_validate_debug_get_validation_result(const struct rte_bpf_validate_debug *debug,
    int *result);

__rte_experimental
int
rte_bpf_validate_debug_can_access(const struct rte_bpf_validate_debug *debug,
    const struct ebpf_insn *access, uint64_t off64);

__rte_experimental
int
rte_bpf_validate_debug_may_jump(const struct rte_bpf_validate_debug *debug,
    const struct ebpf_insn *jump, uint64_t imm64);

__rte_experimental
int
rte_bpf_validate_debug_format_register_info(const struct rte_bpf_validate_debug *debug,
    char *buffer, size_t bufsz, uint8_t reg);

__rte_experimental
int
rte_bpf_validate_debug_format_frame_info(const struct rte_bpf_validate_debug *debug,
    char *buffer, size_t bufsz, int32_t offset);

__rte_experimental
int32_t
rte_bpf_validate_debug_get_frame_size(const struct rte_bpf_validate_debug *debug);

__rte_experimental
int
rte_bpf_validate_debug_format_value(char *buffer, size_t bufsz, char format,
    uint64_t value);

__rte_experimental
int
rte_bpf_validate_debug_format_interval(char *buffer, size_t bufsz, char format,
    uint64_t min, uint64_t max);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_BPF_VALIDATE_DEBUG_H_ */