[dpdk-dev] [PATCH] compressdev: implement API

[Trahe, Fiona]

Hi Tomas,
Sorry for the delay in replying to this

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas at monjalon.net]
> Sent: Sunday, February 4, 2018 2:25 PM
> To: Trahe, Fiona <fiona.trahe at intel.com>
> Cc: dev at dpdk.org; ahmed.mansour at nxp.com; Shally.Verma at cavium.com; De Lara Guarch, Pablo
> <pablo.de.lara.guarch at intel.com>
> Subject: Re: [dpdk-dev] [PATCH] compressdev: implement API
> 
> 02/02/2018 19:25, Fiona Trahe:
> >  config/common_base                                 |   6 +
> >  doc/api/doxy-api-index.md                          |   1 +
> >  doc/api/doxy-api.conf                              |   1 +
> >  lib/Makefile                                       |   3 +
> >  lib/librte_compressdev/Makefile                    |  29 +
> >  lib/librte_compressdev/rte_comp.h                  | 503 ++++++++++++
> 
> Why rte_comp.h instead of the more consistent rte_compress.h?
[Fiona]  I did originally... but ran into difficulty with horribly names like
RTE_COMPRESS_COMPRESS
RTE_COMPRESS_DECOMPRESS
rte_compress_compress_xform
rte_compress_decompress_xform
So compress is both the module prefix and the name of one of the actions.
I could have used compressdev - but names were very long.
So decided to opt for using 
_compressdev_ in names to do with the device and
_comp_ in names to do with the compression service

Also I could have used compdev instead of compressdev, 
but I felt compress should be in the lib name

> 
> >  lib/librte_compressdev/rte_compressdev.c           | 902 +++++++++++++++++++++
> >  lib/librte_compressdev/rte_compressdev.h           | 757 +++++++++++++++++
> >  lib/librte_compressdev/rte_compressdev_pmd.c       | 163 ++++
> >  lib/librte_compressdev/rte_compressdev_pmd.h       | 439 ++++++++++
> >  lib/librte_compressdev/rte_compressdev_version.map |  47 ++
> >  lib/librte_eal/common/include/rte_log.h            |   1 +
> >  mk/rte.app.mk                                      |   1 +
> >  13 files changed, 2853 insertions(+)
> 
> Please update MAINTAINERS file and release notes.
> 
> Maybe it is worth splitting this patch in few shorter parts?
[Fiona] will do
> 
> 
> > --- a/config/common_base
> > +++ b/config/common_base
> > @@ -535,6 +535,12 @@ CONFIG_RTE_LIBRTE_PMD_MRVL_CRYPTO=n
> >  CONFIG_RTE_LIBRTE_PMD_MRVL_CRYPTO_DEBUG=n
> >
> >  #
> > +# Compile generic compression device library
> > +#
> > +CONFIG_RTE_LIBRTE_COMPRESSDEV=y
> > +CONFIG_RTE_COMPRESS_MAX_DEVS=64
> > +
> > +#
> >  # Compile generic security library
> >  #
> >  CONFIG_RTE_LIBRTE_SECURITY=y
> > diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
> > index d77f205..07b8e75 100644
> > --- a/doc/api/doxy-api-index.md
> > +++ b/doc/api/doxy-api-index.md
> > @@ -43,6 +43,7 @@ The public API headers are grouped by topics:
> >    [rte_tm]             (@ref rte_tm.h),
> >    [rte_mtr]            (@ref rte_mtr.h),
> >    [bbdev]              (@ref rte_bbdev.h),
> > +  [compressdev]        (@ref rte_compressdev.h),
> >    [cryptodev]          (@ref rte_cryptodev.h),
> >    [security]           (@ref rte_security.h),
> >    [eventdev]           (@ref rte_eventdev.h),
> 
> Please move it between security and eventdev in these lists.
ok