[dpdk-dev] [PATCH v5 1/8] ether: refine debug build option
Thomas Monjalon
thomas at monjalon.net
Tue Mar 23 22:14:12 CET 2021
23/03/2021 12:07, Qi Zhang:
> PMDs use RTE_LIBRTE_<PMD_NAME>_DEBUG_RX|TX as build option to wrap
> data path debug code. As .config has been removed since the meson build,
> It is not friendly for new DPDK users to notice those debug options.
>
> The patch introduces below build options for data path debug, so PMD
> can choose to reuse them to avoid maintain their own.
>
> - RTE_ETHDEV_DEBUG_RX
> - RTE_ETHDEV_DEBUG_TX
>
> All the build options are documented at programming guide
> "3.1 Driver Option", so users can easily find them.
>
> The original undocumented RTE_LIBRTE_ETHDEV_DEBUG will alias to
> both RTE_ETHDEV_DEBUG_RX and RTE_ETHDEV_DEBUG_TX for backward
> compatibility.
>
> Signed-off-by: Qi Zhang <qi.z.zhang at intel.com>
[...]
> +The ethdev layer supports below compile options for debug purpose:
As suggested by Bruce, "build options" is a better term.
> +
> +- ``RTE_ETHDEV_DEBUG_RX`` (default **disabled**)
> +
> + Build with debug code on Rx path.
> +
> +- ``RTE_ETHDEV_DEBUG_TX`` (default **disabled**)
> +
> + Build with debug code on Tx path.
> +
> +.. Note::
> +
> + The ethdev library use above options to wrap debug code to trace invalid parameters
> + on data path APIs, so performance downgrade is expected when enabling those options.
> + Each PMD can decide to reuse them to wrap their own debug code in the Rx/Tx path.
Acked-by: Thomas Monjalon <thomas at monjalon.net>
More information about the dev
mailing list