1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2018 Intel Corporation
5 #ifndef _RTE_BPF_ETHDEV_H_
6 #define _RTE_BPF_ETHDEV_H_
9 * @file rte_bpf_ethdev.h
10 * @b EXPERIMENTAL: this API may change without prior notice
12 * API to install BPF filter as RX/TX callbacks for eth devices.
13 * Note that right now:
14 * - it is not MT safe, i.e. it is not allowed to do load/unload for the
15 * same port/queue from different threads in parallel.
16 * - though it allows to do load/unload at runtime
17 * (while RX/TX is ongoing on given port/queue).
18 * - allows only one BPF program per port/queue,
19 * i.e. new load will replace previously loaded for that port/queue BPF program.
20 * Filter behaviour - if BPF program returns zero value for a given packet,
21 * then it will be dropped inside callback and no further processing
22 * on RX - it will be dropped inside callback and no further processing
23 * for that packet will happen.
24 * on TX - packet will remain unsent, and it is responsibility of the user
25 * to handle such situation (drop, try to send again, etc.).
35 RTE_BPF_ETH_F_NONE = 0,
36 RTE_BPF_ETH_F_JIT = 0x1, /*< use compiled into native ISA code */
40 * Unload previously loaded BPF program (if any) from given RX port/queue
41 * and remove appropriate RX port/queue callback.
44 * The identifier of the ethernet port
46 * The identifier of the RX queue on the given port
50 rte_bpf_eth_rx_unload(uint16_t port, uint16_t queue);
53 * Unload previously loaded BPF program (if any) from given TX port/queue
54 * and remove appropriate TX port/queue callback.
57 * The identifier of the ethernet port
59 * The identifier of the TX queue on the given port
63 rte_bpf_eth_tx_unload(uint16_t port, uint16_t queue);
66 * Load BPF program from the ELF file and install callback to execute it
67 * on given RX port/queue.
70 * The identifier of the ethernet port
72 * The identifier of the RX queue on the given port
74 * Pathname for a ELF file.
76 * Name of the executable section within the file to load.
78 * Parameters used to create and initialise the BPF execution context.
80 * Flags that define expected behavior of the loaded filter
81 * (i.e. jited/non-jited version to use).
83 * Zero on successful completion or negative error code otherwise.
87 rte_bpf_eth_rx_elf_load(uint16_t port, uint16_t queue,
88 const struct rte_bpf_prm *prm, const char *fname, const char *sname,
92 * Load BPF program from the ELF file and install callback to execute it
93 * on given TX port/queue.
96 * The identifier of the ethernet port
98 * The identifier of the TX queue on the given port
100 * Pathname for a ELF file.
102 * Name of the executable section within the file to load.
104 * Parameters used to create and initialise the BPF execution context.
106 * Flags that define expected expected behavior of the loaded filter
107 * (i.e. jited/non-jited version to use).
109 * Zero on successful completion or negative error code otherwise.
113 rte_bpf_eth_tx_elf_load(uint16_t port, uint16_t queue,
114 const struct rte_bpf_prm *prm, const char *fname, const char *sname,
121 #endif /* _RTE_BPF_ETHDEV_H_ */