rte_bpf.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2018 Intel Corporation
 */
 
#ifndef _RTE_BPF_H_
#define _RTE_BPF_H_
 
#include <rte_common.h>
#include <rte_mbuf.h>
#include <rte_malloc.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * eBPF instruction format
 */
struct rte_ebpf_insn {
    uint8_t code;
    uint8_t dst_reg:4;
    uint8_t src_reg:4;
    int16_t off;
    int32_t imm;
};
 
/*
 * eBPF allows functions with up to 5 arguments.
 */
#define RTE_BPF_FUNC_MAX_ARGS   5
 
#define RTE_BPF_EXEC_FLAG_JIT   RTE_BIT64(0)    
#define RTE_BPF_EXEC_FLAG_MASK  RTE_BPF_EXEC_FLAG_JIT
 
/* Format instructions as assembler. */
#define RTE_BPF_FORMAT_FLAG_DISASSEMBLY     0
/* Format instructions as hexadecimal. */
#define RTE_BPF_FORMAT_FLAG_HEXADECIMAL     RTE_BIT32(0)
 
/* Only valid in disassembly mode. */
/* Format jump offsets relative to the next instruction. */
#define RTE_BPF_FORMAT_FLAG_RELATIVE_JUMPS  0
/* Format jump targets relative to the start of the program. */
#define RTE_BPF_FORMAT_FLAG_ABSOLUTE_JUMPS  RTE_BIT32(1)
 
/* Only valid in hexadecimal mode. */
/* Format full hexadecimal representation of wide instructions. */
#define RTE_BPF_FORMAT_FLAG_AUTO_WIDE       0
/* Format as hexadecimal only first half of wide instructions. */
#define RTE_BPF_FORMAT_FLAG_NEVER_WIDE      RTE_BIT32(2)
 
enum rte_bpf_arg_type {
    RTE_BPF_ARG_UNDEF,      
    RTE_BPF_ARG_RAW,        
    RTE_BPF_ARG_PTR = 0x10, 
    RTE_BPF_ARG_PTR_MBUF,   
    RTE_BPF_ARG_RESERVED    
};
 
struct rte_bpf_arg {
    enum rte_bpf_arg_type type;
    size_t size;
    size_t buf_size;
};
 
#define RTE_BPF_ARG_PTR_TYPE(x) ((x) & RTE_BPF_ARG_PTR)
 
enum rte_bpf_xtype {
    RTE_BPF_XTYPE_FUNC, 
    RTE_BPF_XTYPE_VAR   
};
 
struct rte_bpf_xsym {
    const char *name;        
    enum rte_bpf_xtype type; 
    union {
        struct {
            uint64_t (*val)(uint64_t, uint64_t, uint64_t,
                uint64_t, uint64_t);
            uint32_t nb_args;
            struct rte_bpf_arg args[RTE_BPF_FUNC_MAX_ARGS];
            struct rte_bpf_arg ret; 
        } func;
        struct {
            void *val; 
            struct rte_bpf_arg desc; 
        } var; 
    };
};
 
enum rte_bpf_origin {
    RTE_BPF_ORIGIN_RAW,     
    RTE_BPF_ORIGIN_CBPF,        
    RTE_BPF_ORIGIN_ELF_FILE,    
    RTE_BPF_ORIGIN_ELF_MEMORY,  
};
 
struct bpf_insn;
struct rte_bpf_validate_debug;
 
struct rte_bpf_prm_ex {
    size_t sz;  
    uint32_t flags;  
    enum rte_bpf_origin origin;  
    union {
        struct {
            const struct rte_ebpf_insn *ins;  
            uint32_t nb_ins;  
        } raw;
        struct {
            const struct bpf_insn *ins;  
            uint32_t nb_ins;  
        } cbpf;
        struct {
            const char *path;  
            const char *section;  
        } elf_file;
        struct {
            const void *data;  
            size_t size;  
            const char *section;  
        } elf_memory;
    };
 
    const struct rte_bpf_xsym *xsym;
    uint32_t nb_xsym;  
    struct rte_bpf_arg prog_arg[RTE_BPF_FUNC_MAX_ARGS];  
    uint32_t nb_prog_arg;  
    /* Validate debug instance. */
    struct rte_bpf_validate_debug *debug;
};
 
struct rte_bpf_prm {
    const struct rte_ebpf_insn *ins; 
    uint32_t nb_ins;            
    const struct rte_bpf_xsym *xsym;
    uint32_t nb_xsym; 
    struct rte_bpf_arg prog_arg; 
};
 
struct rte_bpf_jit {
    uint64_t (*func)(void *); 
    size_t sz;                
};
 
union rte_bpf_func_arg {
    uint64_t u64;
    void *ptr;
};
 
typedef uint64_t (*rte_bpf_jit_func0_t)(void);
typedef uint64_t (*rte_bpf_jit_func1_t)(union rte_bpf_func_arg);
typedef uint64_t (*rte_bpf_jit_func2_t)(union rte_bpf_func_arg, union rte_bpf_func_arg);
typedef uint64_t (*rte_bpf_jit_func3_t)(union rte_bpf_func_arg, union rte_bpf_func_arg,
    union rte_bpf_func_arg);
typedef uint64_t (*rte_bpf_jit_func4_t)(union rte_bpf_func_arg, union rte_bpf_func_arg,
    union rte_bpf_func_arg, union rte_bpf_func_arg);
typedef uint64_t (*rte_bpf_jit_func5_t)(union rte_bpf_func_arg, union rte_bpf_func_arg,
    union rte_bpf_func_arg, union rte_bpf_func_arg, union rte_bpf_func_arg);
 
struct rte_bpf_jit_ex {
    union {
        void *raw;
        rte_bpf_jit_func0_t func0;  /* nullary function */
        rte_bpf_jit_func1_t func1;  /* unary function */
        rte_bpf_jit_func2_t func2;  /* binary function */
        rte_bpf_jit_func3_t func3;  /* ternary function */
        rte_bpf_jit_func4_t func4;  /* quaternary function */
        rte_bpf_jit_func5_t func5;  /* quinary function */
    };
    size_t sz;
};
 
/* Tuple of eBPF program arguments. */
struct rte_bpf_prog_ctx {
    union rte_bpf_func_arg arg[RTE_BPF_FUNC_MAX_ARGS];
};
 
struct rte_bpf;
 
void
rte_bpf_destroy(struct rte_bpf *bpf);
 
__rte_experimental
struct rte_bpf *
rte_bpf_load_ex(const struct rte_bpf_prm_ex *prm)
    __rte_malloc __rte_dealloc(rte_bpf_destroy, 1);
 
struct rte_bpf *
rte_bpf_load(const struct rte_bpf_prm *prm)
    __rte_malloc __rte_dealloc(rte_bpf_destroy, 1);
 
struct rte_bpf *
rte_bpf_elf_load(const struct rte_bpf_prm *prm, const char *fname,
        const char *sname)
    __rte_malloc __rte_dealloc(rte_bpf_destroy, 1);
 
uint64_t
rte_bpf_exec(const struct rte_bpf *bpf, void *ctx);
 
__rte_experimental
uint64_t
rte_bpf_exec_ex(const struct rte_bpf *bpf, const struct rte_bpf_prog_ctx *ctx,
        uint64_t flags);
 
uint32_t
rte_bpf_exec_burst(const struct rte_bpf *bpf, void *ctx[], uint64_t rc[],
        uint32_t num);
 
__rte_experimental
uint32_t
rte_bpf_exec_burst_ex(const struct rte_bpf *bpf, const struct rte_bpf_prog_ctx *ctx,
        uint64_t rc[], uint32_t num, uint64_t flags);
 
int
rte_bpf_get_jit(const struct rte_bpf *bpf, struct rte_bpf_jit *jit);
 
__rte_experimental
int
rte_bpf_get_jit_ex(const struct rte_bpf *bpf, struct rte_bpf_jit_ex *jit);
 
__rte_experimental
bool
rte_bpf_insn_is_wide(const struct rte_ebpf_insn *ins);
 
__rte_experimental
int
rte_bpf_format(char *buffer, size_t bufsz, const struct rte_ebpf_insn *ins,
    uint32_t pc, uint32_t flags);
 
void
rte_bpf_dump(FILE *f, const struct rte_ebpf_insn *buf, uint32_t len);
 
struct bpf_program;
 
struct rte_bpf_prm *
rte_bpf_convert(const struct bpf_program *prog)
    __rte_malloc __rte_dealloc_free;
 
#ifdef __cplusplus
}
#endif
 
#endif /* _RTE_BPF_H_ */