Comments/Doc error for CRYPTODEV of DPDK

Comments/Doc error for CRYPTODEV of DPDK

[Wang, Songyi]

[-- Attachment #1: Type: text/plain, Size: 1449 bytes --]

Hi maintainer of DPDK,

I've noticed an error on comment of DPDK version 23.11 rte_cryptodev.h: 928-930

/**
 * Create a symmetric session mempool.
 *
 * @param name
 *   The unique mempool name.
 * @param nb_elts
 *   The number of elements in the mempool.
 * @param elt_size
 *   The size of the element. This value will be ignored if it is smaller than
 *   the minimum session header size required for the system. For the user who
 *   want to use the same mempool for sym session and session private data it
 *   can be the maximum value of all existing devices' private data and session
 *   header sizes.
 * @param cache_size
 *   The number of per-lcore cache elements
 * @param priv_size
 *   The private data size of each session.
 * @param socket_id
 *   The *socket_id* argument is the socket identifier in the case of
 *   NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA
 *   constraint for the reserved zone.
 *
 * @return
 *  - On success return size of the session
 *  - On failure returns 0
 */
__rte_experimental
struct rte_mempool *
rte_cryptodev_sym_session_pool_create(const char *name, uint32_t nb_elts,
    uint32_t elt_size, uint32_t cache_size, uint16_t priv_size,
    int socket_id);


But the return value of this function seems to be a pointer to the mempool created or NULL pointer, instead of the mempool size.

Could you please check it?

Thank you and BR,
Songyi

[-- Attachment #2: Type: text/html, Size: 13727 bytes --]

Re: Comments/Doc error for CRYPTODEV of DPDK

[David Marchand]

Hello,

On Fri, Jan 19, 2024 at 8:48 AM Wang, Songyi <songyi.wang@intel.com> wrote:
>
> Hi maintainer of DPDK,

Redirecting to the cryptodev maintainers.
Akhil, Fan, can you have a look?

Thanks.

>
>
>
> I’ve noticed an error on comment of DPDK version 23.11 rte_cryptodev.h: 928-930


-- 
David Marchand

RE: [EXT] Re: Comments/Doc error for CRYPTODEV of DPDK

[Akhil Goyal]

Hi,
> Hello,
> 
> On Fri, Jan 19, 2024 at 8:48 AM Wang, Songyi <songyi.wang@intel.com> wrote:
> >
> > Hi maintainer of DPDK,
> 
> Redirecting to the cryptodev maintainers.
> Akhil, Fan, can you have a look?
> 
> Thanks.
> 
> >
> >
> >
> > I’ve noticed an error on comment of DPDK version 23.11 rte_cryptodev.h: 928-
> 930
> 
Can you specify the error?

Regards,
Akhil

RE: [EXT] Re: Comments/Doc error for CRYPTODEV of DPDK

[Akhil Goyal]

> > > I’ve noticed an error on comment of DPDK version 23.11 rte_cryptodev.h:
> 928-
> > 930

Ok, now I see the original mail. Thanks David.
The line numbers pointed as 928-930 does not have the API 
rte_cryptodev_sym_session_pool_create for v23.11 

The API is at line 1036-1039. And the comment is correct above that. Please check
http://git.dpdk.org/dpdk-stable/tree/lib/cryptodev/rte_cryptodev.h?h=23.11#n1032

Regards,
Akhil

RE: [EXT] Re: Comments/Doc error for CRYPTODEV of DPDK

[Wang, Songyi]

Hi Akhil,

Ok, Seems like I need to update my code version. Thank you for letting me know!

BR, Songyi

-----Original Message-----
From: Akhil Goyal <gakhil@marvell.com> 
Sent: Friday, January 19, 2024 4:27 PM
To: Marchand, David <david.marchand@redhat.com>; Wang, Songyi <songyi.wang@intel.com>; Fan Zhang <fanzhang.oss@gmail.com>
Cc: dev@dpdk.org; Dong, Yao <yao.dong@intel.com>
Subject: RE: [EXT] Re: Comments/Doc error for CRYPTODEV of DPDK

> > > I’ve noticed an error on comment of DPDK version 23.11 rte_cryptodev.h:
> 928-
> > 930

Ok, now I see the original mail. Thanks David.
The line numbers pointed as 928-930 does not have the API rte_cryptodev_sym_session_pool_create for v23.11 

The API is at line 1036-1039. And the comment is correct above that. Please check
http://git.dpdk.org/dpdk-stable/tree/lib/cryptodev/rte_cryptodev.h?h=23.11#n1032

Regards,
Akhil