From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 806F3A0613 for ; Wed, 28 Aug 2019 06:37:41 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id C64BE1C1D0; Wed, 28 Aug 2019 06:37:39 +0200 (CEST) Received: from mx0b-0016f401.pphosted.com (mx0b-0016f401.pphosted.com [67.231.156.173]) by dpdk.org (Postfix) with ESMTP id 177C31C1CC for ; Wed, 28 Aug 2019 06:37:37 +0200 (CEST) Received: from pps.filterd (m0045851.ppops.net [127.0.0.1]) by mx0b-0016f401.pphosted.com (8.16.0.42/8.16.0.42) with SMTP id x7S4ZKoJ028506; Tue, 27 Aug 2019 21:37:37 -0700 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com; h=from : to : cc : subject : date : message-id : references : in-reply-to : content-type : content-transfer-encoding : mime-version; s=pfpt0818; bh=DYqJ+cc+lfb8a6YHtX8ESBdDfew48glH+mZiKkOoHIs=; b=QugIVKGv4NbyKtyUnNYOogMqHW8ad4MW3PT7dK2/fef0zJiTcwXkzOCwRZKL0cyTqd/j Jbr2euJuGBogY+mt/CTTAl7Y8lAAmaoSt0zbaqIKmsqoZLEtsjF32GkICmQuF8t8P7vo foHgfk/WOKsItByvNkvvS70UR/UHU8Zl1s8VoRN5YNSnp67TVO98gPqb27IKuveu3c3U 4gqWLmVNUU6zLX+6lEpoN+4TmZQ5Besddbf0ZQgApQugKS7X+FQEqN+BhDNCXRodhRrP 0ix5o5Y7ck0Ge7h4J+WAuMbN5b6bujcQSe1mEYLQog4FiQOxLYMS6qGXTyORriAOhCZY EQ== Received: from sc-exch01.marvell.com ([199.233.58.181]) by mx0b-0016f401.pphosted.com with ESMTP id 2uk4rknhcr-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); Tue, 27 Aug 2019 21:37:37 -0700 Received: from SC-EXCH01.marvell.com (10.93.176.81) by SC-EXCH01.marvell.com (10.93.176.81) with Microsoft SMTP Server (TLS) id 15.0.1367.3; Tue, 27 Aug 2019 21:37:35 -0700 Received: from NAM03-BY2-obe.outbound.protection.outlook.com (104.47.42.57) by SC-EXCH01.marvell.com (10.93.176.81) with Microsoft SMTP Server (TLS) id 15.0.1367.3 via Frontend Transport; Tue, 27 Aug 2019 21:37:35 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=ga5y23Jd2fNeSVdxsbzYeRsOtkDnFIh03dybVpsKIJcKqlYZ3+sfEuhGI5t32lLBu8DCsuJtnKXef95DwL9YhLKB+Ku24i1vRzlW/ywVZUtUghai4+TI+P1JUfN8SP+rx34WjlDZOPw9r6ZK6Rbh3jVKfw12Y5+advHnl1uGE5pW0G5gqM71sOZrJkczqf/9Gn9U9x0EnNdoOZYDEQgmWONVY0dNLyK9IZRRaZvNep+PFK3AX0uUgw7IF6S6GG8o4X28TpiLAdfKxwK1+Nl2Grs8s360ERUfJDIw9+bN5gUkNnrqBubwyG30QCf4eKneIltb6C/Hjafkf0lxDgo8Rg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=DYqJ+cc+lfb8a6YHtX8ESBdDfew48glH+mZiKkOoHIs=; b=SHeb42kxJDLOE26MfRmhrrtSAeNPlLs6fV3fYhvmdepXl3ZaahH3S2qkwm/EzSPygZVaibo45ZNG573+kU2YYESbEkY6UmXKpq7ke7Wt85Gf5J+isA5hIAVVXSgT5Z1EosJwLfC0bFcr/m0uQJXzUEwB+IaG4+Bgosaco4M7IvAgzsr6IaA8aOVUyT9JOYDfobIm3p7wrrw4jhlrq4HthmjFxo3VpOOHykAZMBL0mdTNTskB7sSUCUqLuYVKZz4WcfeJxb+pxZL50Sm7FDcSR/GPhFXOLllwM63OnI+VfHOM81OkpAikPAVvI+dV/ywP5Jn6RtQMgWuT1T2U4u9oKg== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=marvell.com; dmarc=pass action=none header.from=marvell.com; dkim=pass header.d=marvell.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.onmicrosoft.com; s=selector2-marvell-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=DYqJ+cc+lfb8a6YHtX8ESBdDfew48glH+mZiKkOoHIs=; b=k1uFpav2CeruORZfv4bjMvKyxrfTtuMCqWk3tIz2XLWaVEftvcfB7ZYyBqX9+gInMnb0gKtLOURAAf1QZbiyW2j8Z83HXs6AtUdaveL7Lo05eM0h/y+WoDYMNb61cy5EfaXJz9kvf46004kJxxoz9OdNz3GRvgT5/Rmr2ksPDhQ= Received: from BN6PR1801MB2052.namprd18.prod.outlook.com (10.161.157.11) by BN6PR1801MB1875.namprd18.prod.outlook.com (10.161.157.27) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2199.21; Wed, 28 Aug 2019 04:37:29 +0000 Received: from BN6PR1801MB2052.namprd18.prod.outlook.com ([fe80::8daf:c020:85a4:9b94]) by BN6PR1801MB2052.namprd18.prod.outlook.com ([fe80::8daf:c020:85a4:9b94%7]) with mapi id 15.20.2199.021; Wed, 28 Aug 2019 04:37:29 +0000 From: Shally Verma To: Fiona Trahe , "dev@dpdk.org" CC: "akhil.goyal@nxp.com" , Ashish Gupta Thread-Topic: [PATCH] doc/compressdev: clarify that structs should be zeroed before use Thread-Index: AQHVXPyHBnBd5WkRok+MVAcKouijZ6cP+fBw Date: Wed, 28 Aug 2019 04:37:29 +0000 Message-ID: References: <1566926764-31816-1-git-send-email-fiona.trahe@intel.com> In-Reply-To: <1566926764-31816-1-git-send-email-fiona.trahe@intel.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [115.113.156.2] x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: 335cc43b-87f0-4af3-63e2-08d72b716f7d x-microsoft-antispam: BCL:0; PCL:0; RULEID:(2390118)(7020095)(4652040)(8989299)(4534185)(7168020)(4627221)(201703031133081)(201702281549075)(8990200)(5600166)(711020)(4605104)(1401327)(2017052603328)(7193020); SRVR:BN6PR1801MB1875; x-ms-traffictypediagnostic: BN6PR1801MB1875: x-ms-exchange-transport-forked: True x-microsoft-antispam-prvs: x-ms-oob-tlc-oobclassifiers: OLM:9508; x-forefront-prvs: 014304E855 x-forefront-antispam-report: SFV:NSPM; SFS:(10009020)(4636009)(39860400002)(396003)(346002)(376002)(136003)(366004)(199004)(189003)(13464003)(66556008)(7736002)(71190400001)(107886003)(8936002)(6246003)(81156014)(81166006)(6116002)(71200400001)(25786009)(86362001)(26005)(14444005)(256004)(305945005)(74316002)(8676002)(478600001)(99286004)(4326008)(7696005)(55236004)(53546011)(6506007)(110136005)(54906003)(76176011)(102836004)(186003)(316002)(14454004)(476003)(2501003)(53936002)(9686003)(55016002)(6436002)(33656002)(2906002)(229853002)(446003)(486006)(11346002)(66946007)(66476007)(66446008)(64756008)(52536014)(76116006)(66066001)(3846002)(5660300002); DIR:OUT; SFP:1101; SCL:1; SRVR:BN6PR1801MB1875; H:BN6PR1801MB2052.namprd18.prod.outlook.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; A:1; MX:1; received-spf: None (protection.outlook.com: marvell.com does not designate permitted sender hosts) x-ms-exchange-senderadcheck: 1 x-microsoft-antispam-message-info: 1mPqUNPwztNt+SAgMR4SPsl62qP6M0NUD+K3apJbrhJW4U0FCrj7Fsq3lbqHCeBnQG/rg00ZYRNNIrvGEP1amvpymApZV9Eol6xQVFgsUldRg0E7IWa8bZvSNIE3+4c3UkqtFubel3IcRkZgJLfu61zFI8NK3FxhFgpQ+w4niX4t1N4jkfgur2wZeYCJpiYOGqcDlvz/CfpmntldymzqgtyaVkYNAr+RWoL6WjJ79aoZHOBTohgg4JRLzlRuCEFF+SJv+rFzPXZ2jr98tJG74t+GJep9V3leiSZUuQmaY+DA8/takCdr9k/l4kL4v00CJyOA8JvyMnrbN2rS5jCBNUCYhm1m2/q64TnHfAkOpZ3UfJ4RncxKqgRXDBiIY+FRQkbG0DQ4LWkFVSqthcCXeDDFDiSuByG/FLjwwVcIjpU= Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-MS-Exchange-CrossTenant-Network-Message-Id: 335cc43b-87f0-4af3-63e2-08d72b716f7d X-MS-Exchange-CrossTenant-originalarrivaltime: 28 Aug 2019 04:37:29.7212 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 70e1fb47-1155-421d-87fc-2e58f638b6e0 X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: i704eh2oVr+CB3ZnJQ64U75RUhgyYKItKzjCjfyfWVtKDCDrXpt41/40J1ZLaZEYc1VA7h7+Y1ExLPRIcTqGEg== X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN6PR1801MB1875 X-OriginatorOrg: marvell.com X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:5.22.84,1.0.8 definitions=2019-08-28_01:2019-08-27,2019-08-28 signatures=0 Subject: Re: [dpdk-dev] [PATCH] doc/compressdev: clarify that structs should be zeroed before use X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" > -----Original Message----- > From: Fiona Trahe > Sent: Tuesday, August 27, 2019 10:56 PM > To: dev@dpdk.org > Cc: akhil.goyal@nxp.com; Ashish Gupta ; Shally > Verma ; Fiona Trahe > Subject: [PATCH] doc/compressdev: clarify that structs should be zeroed > before use >=20 > Some structs used on the API are zeroed on creation by API calls, (e.g. > rte_comp_op), but a few are allocated in the application domain. > Clarify that the application should zero those to enable future extension= s > without API breakage. >=20 > Signed-off-by: Fiona Trahe > --- > doc/guides/prog_guide/compressdev.rst | 10 ++++++++++ > 1 files changed, 10 insertions(+), 0 deletions(-) >=20 > diff --git a/doc/guides/prog_guide/compressdev.rst > b/doc/guides/prog_guide/compressdev.rst > index a089db1..2a85eba 100644 > --- a/doc/guides/prog_guide/compressdev.rst > +++ b/doc/guides/prog_guide/compressdev.rst > @@ -76,6 +76,11 @@ The ``rte_compressdev_configure`` API is used to > configure a compression device. > The ``rte_compressdev_config`` structure is used to pass the configurati= on > parameters. >=20 > +The allocation of the ``rte_compressdev_config`` struct passed on the > +API is in the application domain, so to allow future API extensions in > +a backwardly compatible manner the application should zero this struct, > +e.g. using sizeof(), before populating it. This allows the addition of n= ew > parameters to the struct with default value of zero indicating original > behaviour. > + > See *DPDK API Reference* for details. >=20 > Configuration of Queue Pairs > @@ -264,6 +269,11 @@ Compression transforms (``rte_comp_xform``) are > the mechanism to specify the details of the compression operation such a= s > algorithm, window size and checksum. >=20 > +The allocation of the ``rte_comp_xform`` struct passed on the API is in > +the application domain, so to allow future API extensions in a > +backwardly compatible manner the application should zero this struct, > +e.g. using sizeof(), before populating it. This allows the addition of n= ew > parameters to the struct with default value of zero indicating original > behaviour. > + [Shally] Though summary and description looks fine. Only thing to confirm i= s that this description is applicable only on xform and config structure? A= nd 0s to all field is allowed values. I have not gone back to refer to latest config and xform structure so take = it just a pointer to check on these cases. Thanks Shally > Compression API Hash support > ---------------------------- >=20 > -- > 1.7.0.7