From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <fiona.trahe@intel.com>
Received: from mga11.intel.com (mga11.intel.com [192.55.52.93])
 by dpdk.org (Postfix) with ESMTP id 8245E2B86
 for <dev@dpdk.org>; Wed, 15 May 2019 18:41:07 +0200 (CEST)
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
Received: from orsmga005.jf.intel.com ([10.7.209.41])
 by fmsmga102.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;
 15 May 2019 09:41:06 -0700
X-ExtLoop1: 1
Received: from irsmsx151.ger.corp.intel.com ([163.33.192.59])
 by orsmga005.jf.intel.com with ESMTP; 15 May 2019 09:41:05 -0700
Received: from irsmsx101.ger.corp.intel.com ([169.254.1.10]) by
 IRSMSX151.ger.corp.intel.com ([169.254.4.155]) with mapi id 14.03.0415.000;
 Wed, 15 May 2019 17:41:03 +0100
From: "Trahe, Fiona" <fiona.trahe@intel.com>
To: "dev@dpdk.org" <dev@dpdk.org>
CC: "akhil.goyal@nxp.com" <akhil.goyal@nxp.com>, "De Lara Guarch, Pablo"
 <pablo.de.lara.guarch@intel.com>, "Doherty, Declan"
 <declan.doherty@intel.com>, "Zhang, Roy Fan" <roy.fan.zhang@intel.com>,
 "jerinj@marvell.com" <jerinj@marvell.com>, "Nicolau, Radu"
 <radu.nicolau@intel.com>
Thread-Topic: [PATCH] doc/cryptodev: clarify that full xform struct should
 be zeroed before use
Thread-Index: AQHVCzx3+7LDPR05JkuQFxMMc5b+PKZsYpRA
Date: Wed, 15 May 2019 16:41:01 +0000
Message-ID: <348A99DA5F5B7549AA880327E580B43589768C28@IRSMSX101.ger.corp.intel.com>
References: <1557938216-3912-1-git-send-email-fiona.trahe@intel.com>
In-Reply-To: <1557938216-3912-1-git-send-email-fiona.trahe@intel.com>
Accept-Language: en-IE, en-US
Content-Language: en-US
X-MS-Has-Attach: 
X-MS-TNEF-Correlator: 
x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiYzUyOTQxZmUtMzI3Yi00NTNhLTlhN2QtYTg5MmU0Njc4MDNiIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoiYmhCZmJWVkl1aVBjdFhiVmhhSTh0REZTWFhyaXoyanBwT3krMTBRTCtTbEczaG13VXVlRStOTHQrU3pFMjU3SCJ9
x-ctpclassification: CTP_NT
dlp-product: dlpe-windows
dlp-version: 11.0.600.7
dlp-reaction: no-action
x-originating-ip: [163.33.239.182]
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
Subject: Re: [dpdk-dev] [PATCH] doc/cryptodev: clarify that full xform
 struct should be zeroed before use
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Wed, 15 May 2019 16:41:08 -0000

Hi Akhil, etc,
Is a deprecation notice necessary for this patch?
If this patch is accepted I will send a follow-up patchset zeroing the xfor=
ms in crypto apps.
Fiona

> -----Original Message-----
> From: Trahe, Fiona
> Sent: Wednesday, May 15, 2019 5:37 PM
> To: dev@dpdk.org
> Cc: Trahe, Fiona <fiona.trahe@intel.com>; akhil.goyal@nxp.com; De Lara Gu=
arch, Pablo
> <pablo.de.lara.guarch@intel.com>; Doherty, Declan <declan.doherty@intel.c=
om>; Zhang, Roy Fan
> <roy.fan.zhang@intel.com>; jerinj@marvell.com; Nicolau, Radu <radu.nicola=
u@intel.com>
> Subject: [PATCH] doc/cryptodev: clarify that full xform struct should be =
zeroed before use
>=20
> Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
> ---
>  doc/guides/prog_guide/cryptodev_lib.rst |   10 ++++++++--
>  1 files changed, 8 insertions(+), 2 deletions(-)
>=20
> diff --git a/doc/guides/prog_guide/cryptodev_lib.rst b/doc/guides/prog_gu=
ide/cryptodev_lib.rst
> index 23fa5bc..cc53b25 100644
> --- a/doc/guides/prog_guide/cryptodev_lib.rst
> +++ b/doc/guides/prog_guide/cryptodev_lib.rst
> @@ -497,7 +497,10 @@ Symmetric Crypto transforms (``rte_crypto_sym_xform`=
`) are the mechanism
> used
>  to specify the details of the Crypto operation. For chaining of symmetri=
c
>  operations such as cipher encrypt and authentication generate, the next =
pointer
>  allows transform to be chained together. Crypto devices which support ch=
aining
> -must publish the chaining of symmetric Crypto operations feature flag.
> +must publish the chaining of symmetric Crypto operations feature flag. A=
llocation of the
> +xform structure is in the the application domain. To allow future API ex=
tensions in a
> +backwardly compatible manner, e.g. addition of a new parameter, the appl=
ication should
> +zero the full xform struct before populating it.
>=20
>  Currently there are three transforms types cipher, authentication and AE=
AD.
>  Also it is important to note that the order in which the
> @@ -881,7 +884,10 @@ Transforms and Transform Chaining
>  Asymmetric Crypto transforms (``rte_crypto_asym_xform``) are the mechani=
sm used
>  to specify the details of the asymmetric Crypto operation. Next pointer =
within
>  xform allows transform to be chained together. Also it is important to n=
ote that
> -the order in which the transforms are passed indicates the order of the =
chaining.
> +the order in which the transforms are passed indicates the order of the =
chaining. Allocation
> +of the xform structure is in the the application domain. To allow future=
 API extensions in a
> +backwardly compatible manner, e.g. addition of a new parameter, the appl=
ication should
> +zero the full xform struct before populating it.
>=20
>  Not all asymmetric crypto xforms are supported for chaining. Currently s=
upported
>  asymmetric crypto chaining is Diffie-Hellman private key generation foll=
owed by
> --
> 1.7.0.7

From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from dpdk.org (dpdk.org [92.243.14.124])
	by dpdk.space (Postfix) with ESMTP id 205C0A00E6
	for <public@inbox.dpdk.org>; Wed, 15 May 2019 18:41:10 +0200 (CEST)
Received: from [92.243.14.124] (localhost [127.0.0.1])
	by dpdk.org (Postfix) with ESMTP id EEFE52BBD;
	Wed, 15 May 2019 18:41:08 +0200 (CEST)
Received: from mga11.intel.com (mga11.intel.com [192.55.52.93])
 by dpdk.org (Postfix) with ESMTP id 8245E2B86
 for <dev@dpdk.org>; Wed, 15 May 2019 18:41:07 +0200 (CEST)
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
Received: from orsmga005.jf.intel.com ([10.7.209.41])
 by fmsmga102.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;
 15 May 2019 09:41:06 -0700
X-ExtLoop1: 1
Received: from irsmsx151.ger.corp.intel.com ([163.33.192.59])
 by orsmga005.jf.intel.com with ESMTP; 15 May 2019 09:41:05 -0700
Received: from irsmsx101.ger.corp.intel.com ([169.254.1.10]) by
 IRSMSX151.ger.corp.intel.com ([169.254.4.155]) with mapi id 14.03.0415.000;
 Wed, 15 May 2019 17:41:03 +0100
From: "Trahe, Fiona" <fiona.trahe@intel.com>
To: "dev@dpdk.org" <dev@dpdk.org>
CC: "akhil.goyal@nxp.com" <akhil.goyal@nxp.com>, "De Lara Guarch, Pablo"
 <pablo.de.lara.guarch@intel.com>, "Doherty, Declan"
 <declan.doherty@intel.com>, "Zhang, Roy Fan" <roy.fan.zhang@intel.com>,
 "jerinj@marvell.com" <jerinj@marvell.com>, "Nicolau, Radu"
 <radu.nicolau@intel.com>
Thread-Topic: [PATCH] doc/cryptodev: clarify that full xform struct should
 be zeroed before use
Thread-Index: AQHVCzx3+7LDPR05JkuQFxMMc5b+PKZsYpRA
Date: Wed, 15 May 2019 16:41:01 +0000
Message-ID:
 <348A99DA5F5B7549AA880327E580B43589768C28@IRSMSX101.ger.corp.intel.com>
References: <1557938216-3912-1-git-send-email-fiona.trahe@intel.com>
In-Reply-To: <1557938216-3912-1-git-send-email-fiona.trahe@intel.com>
Accept-Language: en-IE, en-US
Content-Language: en-US
X-MS-Has-Attach: 
X-MS-TNEF-Correlator: 
x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiYzUyOTQxZmUtMzI3Yi00NTNhLTlhN2QtYTg5MmU0Njc4MDNiIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoiYmhCZmJWVkl1aVBjdFhiVmhhSTh0REZTWFhyaXoyanBwT3krMTBRTCtTbEczaG13VXVlRStOTHQrU3pFMjU3SCJ9
x-ctpclassification: CTP_NT
dlp-product: dlpe-windows
dlp-version: 11.0.600.7
dlp-reaction: no-action
x-originating-ip: [163.33.239.182]
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
Subject: Re: [dpdk-dev] [PATCH] doc/cryptodev: clarify that full xform
 struct should be zeroed before use
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>
Message-ID: <20190515164101.2DBM3D5Gp2SBdVK-BHzu8l0GcCOrQ0LOU64xlAx2nZU@z>

Hi Akhil, etc,
Is a deprecation notice necessary for this patch?
If this patch is accepted I will send a follow-up patchset zeroing the xfor=
ms in crypto apps.
Fiona

> -----Original Message-----
> From: Trahe, Fiona
> Sent: Wednesday, May 15, 2019 5:37 PM
> To: dev@dpdk.org
> Cc: Trahe, Fiona <fiona.trahe@intel.com>; akhil.goyal@nxp.com; De Lara Gu=
arch, Pablo
> <pablo.de.lara.guarch@intel.com>; Doherty, Declan <declan.doherty@intel.c=
om>; Zhang, Roy Fan
> <roy.fan.zhang@intel.com>; jerinj@marvell.com; Nicolau, Radu <radu.nicola=
u@intel.com>
> Subject: [PATCH] doc/cryptodev: clarify that full xform struct should be =
zeroed before use
>=20
> Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
> ---
>  doc/guides/prog_guide/cryptodev_lib.rst |   10 ++++++++--
>  1 files changed, 8 insertions(+), 2 deletions(-)
>=20
> diff --git a/doc/guides/prog_guide/cryptodev_lib.rst b/doc/guides/prog_gu=
ide/cryptodev_lib.rst
> index 23fa5bc..cc53b25 100644
> --- a/doc/guides/prog_guide/cryptodev_lib.rst
> +++ b/doc/guides/prog_guide/cryptodev_lib.rst
> @@ -497,7 +497,10 @@ Symmetric Crypto transforms (``rte_crypto_sym_xform`=
`) are the mechanism
> used
>  to specify the details of the Crypto operation. For chaining of symmetri=
c
>  operations such as cipher encrypt and authentication generate, the next =
pointer
>  allows transform to be chained together. Crypto devices which support ch=
aining
> -must publish the chaining of symmetric Crypto operations feature flag.
> +must publish the chaining of symmetric Crypto operations feature flag. A=
llocation of the
> +xform structure is in the the application domain. To allow future API ex=
tensions in a
> +backwardly compatible manner, e.g. addition of a new parameter, the appl=
ication should
> +zero the full xform struct before populating it.
>=20
>  Currently there are three transforms types cipher, authentication and AE=
AD.
>  Also it is important to note that the order in which the
> @@ -881,7 +884,10 @@ Transforms and Transform Chaining
>  Asymmetric Crypto transforms (``rte_crypto_asym_xform``) are the mechani=
sm used
>  to specify the details of the asymmetric Crypto operation. Next pointer =
within
>  xform allows transform to be chained together. Also it is important to n=
ote that
> -the order in which the transforms are passed indicates the order of the =
chaining.
> +the order in which the transforms are passed indicates the order of the =
chaining. Allocation
> +of the xform structure is in the the application domain. To allow future=
 API extensions in a
> +backwardly compatible manner, e.g. addition of a new parameter, the appl=
ication should
> +zero the full xform struct before populating it.
>=20
>  Not all asymmetric crypto xforms are supported for chaining. Currently s=
upported
>  asymmetric crypto chaining is Diffie-Hellman private key generation foll=
owed by
> --
> 1.7.0.7