[dpdk-dev] [PATCH v2 2/2] ethdev: add new offload flag to keep CRC

[Shahaf Shuler]

Wednesday, March 21, 2018 9:48 PM, Ferruh Yigit:
> DEV_RX_OFFLOAD_KEEP_CRC offload flag added.
> 
> DEV_RX_OFFLOAD_CRC_STRIP flag will remain one more release but default
> behavior in PMDs is to strip the CRC independent from this flag.
> 
> Until DEV_RX_OFFLOAD_CRC_STRIP flag is removed:
> - Setting both KEEP_CRC & CRC_STRIP is INVALID
> - Setting only CRC_STRIP PMD should strip the CRC
> - Setting only KEEP_CRC PMD should keep the CRC
> - Not setting both PMD should strip the CRC

We cannot have such default behavior, it may break existing applications.

The API of ethdev offloads says (even though it is not well documented) :  DEV_RX_OFFLOAD_CRC_STRIP (emphasis the STRIP). 
meaning, if set -> STRIP, if not set -> don't strip.  I am aware to at least one application which wants to have the CRC, and for that purpose it naturally don't set the offload flag. 

The fact some PMDs lack the ability to toggle the CRC stripping should be exposed in the "limitations" section of their related guide. 

Up to here, this is the behavior as defined by the API. 

Now, we want to change it, and I think it makes sense. However I think we should take similar approach to what we did with the ethdev offloads API:
1. at first stage a new offload flag is exposed DEV_RX_OFFLOAD_KEEP_CRC and implemented on the PMDs. 
2. there is a conversion function on ethdev. Which for example converts ~DEV_RX_OFFLOAD_CRC_STRIP -> DEV_RX_OFFLOAD_KEEP_CRC for the PMDs.
3. deprecation of DEV_RX_OFFLOAD_CRC_STRIP for applications and remove of the conversion functions. 

More below,

> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit at intel.com>
> ---
>  lib/librte_ether/rte_ethdev.h | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h
> index 5e13dca6a..ab1030d42 100644
> --- a/lib/librte_ether/rte_ethdev.h
> +++ b/lib/librte_ether/rte_ethdev.h
> @@ -939,6 +939,9 @@ struct rte_eth_conf {
>  #define DEV_RX_OFFLOAD_SCATTER		0x00002000
>  #define DEV_RX_OFFLOAD_TIMESTAMP	0x00004000
>  #define DEV_RX_OFFLOAD_SECURITY         0x00008000
> +/* Invalid to set both DEV_RX_OFFLOAD_CRC_STRIP and
> +DEV_RX_OFFLOAD_KEEP_CRC
> + * No DEV_RX_OFFLOAD_CRC_STRIP flag means stripping CRC */
> +#define DEV_RX_OFFLOAD_KEEP_CRC		0x00010000

Need also comment on DEV_RX_OFFLOAD_CRC_STRIP to say it is deprecated.

>  #define DEV_RX_OFFLOAD_CHECKSUM (DEV_RX_OFFLOAD_IPV4_CKSUM |
> \
>  				 DEV_RX_OFFLOAD_UDP_CKSUM | \
>  				 DEV_RX_OFFLOAD_TCP_CKSUM)
> --
> 2.13.6