Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/121280/?format=api
{ "id": 121280, "url": "https://patches.dpdk.org/api/patches/121280/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/20221222092522.1628-1-anoobj@marvell.com/", "project": { "id": 1, "url": "https://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20221222092522.1628-1-anoobj@marvell.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20221222092522.1628-1-anoobj@marvell.com", "date": "2022-12-22T09:25:17", "name": "[0/5] lib: add pdcp protocol", "commit_ref": null, "pull_url": null, "state": null, "archived": false, "hash": null, "submitter": { "id": 1205, "url": "https://patches.dpdk.org/api/people/1205/?format=api", "name": "Anoob Joseph", "email": "anoobj@marvell.com" }, "delegate": null, "mbox": "https://patches.dpdk.org/project/dpdk/patch/20221222092522.1628-1-anoobj@marvell.com/mbox/", "series": [], "comments": "https://patches.dpdk.org/api/patches/121280/comments/", "check": "pending", "checks": "https://patches.dpdk.org/api/patches/121280/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 84272A034C;\n\tThu, 22 Dec 2022 10:27:47 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 3CF9F40698;\n\tThu, 22 Dec 2022 10:27:47 +0100 (CET)", "from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com\n [67.231.148.174])\n by mails.dpdk.org (Postfix) with ESMTP id A0E86400D7\n for <dev@dpdk.org>; Thu, 22 Dec 2022 10:27:45 +0100 (CET)", "from pps.filterd (m0045849.ppops.net [127.0.0.1])\n by mx0a-0016f401.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id\n 2BM7Mp6p015823; Thu, 22 Dec 2022 01:27:43 -0800", "from dc5-exch02.marvell.com ([199.233.59.182])\n by mx0a-0016f401.pphosted.com (PPS) with ESMTPS id 3mm79c3stv-1\n (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT);\n Thu, 22 Dec 2022 01:25:28 -0800", "from DC5-EXCH02.marvell.com (10.69.176.39) by DC5-EXCH02.marvell.com\n (10.69.176.39) with Microsoft SMTP Server (TLS) id 15.0.1497.42;\n Thu, 22 Dec 2022 01:25:26 -0800", "from maili.marvell.com (10.69.176.80) by DC5-EXCH02.marvell.com\n (10.69.176.39) with Microsoft SMTP Server id 15.0.1497.42 via Frontend\n Transport; Thu, 22 Dec 2022 01:25:26 -0800", "from BG-LT92004.corp.innovium.com (unknown [10.193.66.59])\n by maili.marvell.com (Postfix) with ESMTP id 87AB13F705D;\n Thu, 22 Dec 2022 01:25:22 -0800 (PST)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com;\n h=from : to : cc :\n subject : date : message-id : in-reply-to : references : mime-version :\n content-transfer-encoding : content-type; s=pfpt0220;\n bh=nAoCe50bf6bUW3XFFVPMJYJ3KckzfbW0/BAdGd3K30c=;\n b=Gw9P4AhsuyZwxbAn9i/kXzXgFdilnMRzxV2Flp51ES5XCgXYjyY2IoNWQrUvkkQQwcZF\n shSVDWUs4JsaA935+zBZUIOeDKasT9Ktv3tYCrQWBJ/ownxTl6ejH8AKRL3zHFKCkd1+\n VFOMqJB3fekAf+2A4Ty6QYr5iSY/JhA8OyTztk68PEdnwsAYbB5GDmcGc70rkbykKb+U\n 79n5rHwPUOkbw1I2zC1r7YXmtEZrQx+OKdKoeIM7EwrlO7y4Slq6TR4wreG7wAk0QOPT\n CxK95qo7PJefd0t9561/IUFA0I3Lvf8VmveY58Ny8aCwl7hiWTmC5gJFZnuxQEud8vch nQ==", "From": "Anoob Joseph <anoobj@marvell.com>", "To": "Thomas Monjalon <thomas@monjalon.net>, Akhil Goyal <gakhil@marvell.com>,\n Jerin Jacob <jerinj@marvell.com>, Konstantin Ananyev\n <konstantin.v.ananyev@yandex.ru>, Bernard Iremonger\n <bernard.iremonger@intel.com>", "CC": "Hemant Agrawal <hemant.agrawal@nxp.com>,\n =?utf-8?q?Mattias_R=C3=B6nnblom?= <mattias.ronnblom@ericsson.com>,\n \"Kiran Kumar K\" <kirankumark@marvell.com>,\n Volodymyr Fialko <vfialko@marvell.com>, <dev@dpdk.org>,\n Olivier Matz <olivier.matz@6wind.com>", "Subject": "[PATCH 0/5] lib: add pdcp protocol", "Date": "Thu, 22 Dec 2022 14:55:17 +0530", "Message-ID": "<20221222092522.1628-1-anoobj@marvell.com>", "X-Mailer": "git-send-email 2.25.1", "In-Reply-To": "<20221027052140.155-1-anoobj@marvell.com>", "References": "<20221027052140.155-1-anoobj@marvell.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Content-Type": "text/plain", "X-Proofpoint-ORIG-GUID": "I5yUsSg5CVKmn6pngtFS8MsQmR0v5LlZ", "X-Proofpoint-GUID": "I5yUsSg5CVKmn6pngtFS8MsQmR0v5LlZ", "X-Proofpoint-Virus-Version": "vendor=baseguard\n engine=ICAP:2.0.205,Aquarius:18.0.923,Hydra:6.0.545,FMLib:17.11.122.1\n definitions=2022-12-22_03,2022-12-21_01,2022-06-22_01", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <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>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org" }, "content": "Add Packet Data Convergence Protocol (PDCP) processing library.\n\nThe library is similar to lib_ipsec which provides IPsec processing\ncapabilities in DPDK.\n\nPDCP would involve roughly the following options,\n1. Transfer of user plane data\n2. Transfer of control plane data\n3. Header compression\n4. Uplink data compression\n5. Ciphering and integrity protection\n\nPDCP library provides following control path APIs that is used to\nconfigure various PDCP entities,\n1. rte_pdcp_entity_establish()\n2. rte_pdcp_entity_suspend()\n3. rte_pdcp_entity_release()\n\nPDCP process is split into 2 parts. One before crypto processing\n(rte_pdcp_pkt_pre_process()) and one after crypto processing\n(rte_pdcp_pkt_post_process()). Since cryptodev dequeue can return crypto\noperations belonging to multiple entities, rte_pdcp_pkt_crypto_group()\nis added to help grouping crypto operations belonging to same entity.\n\nSimilar to lib IPsec, lib PDCP would allow application to use same API\nsequence while leveraging protocol offload features enabled by rte_security\nlibrary. Lib PDCP would internally change the handles registered for\n*pre_process* and *post_process* based on features enabled in the entity.\n\nLib PDCP would create the required sessions on the device provided in entity to\nminimize the application requirements. Also, the crypto_op allocation and free\nwould also be done internally by lib PDCP to allow the library to create\ncrypto ops as required for the input packets. For example, when control PDUs are\nreceived, no cryptodev enqueue-dequeue is expected for the same and lib PDCP\nis expected to handle it differently.\n\nChanges from RFC\n- Implementation for all APIs covering basic control plane & user plane packets\n- Unit test leveraging existing PDCP vectors available in test_cryptodev\n- Unit test performing both UL & DL operations to verify various protocol\n features\n- Updated documentation\n\nChanges planned for next version\n- Add APIs for rte_pdcp_entity_re_establish, rte_pdcp_entity_reconfigure\n- Framework to handle control PDUs\n- Eventdev based timer integration for t-Reordering & discardTimer\n- Integration with reorder library to handle in-order delivery\n\nSample application sequence:\n\n\tstruct rte_mbuf **out_mb, *pkts[MAX_BURST_SIZE];\n\tstruct rte_crypto_op *cop[MAX_BURST_SIZE];\n\tstruct rte_pdcp_group grp[MAX_BURST_SIZE];\n\tstruct rte_pdcp_entity *pdcp_entity;\n\tint nb_max_out_mb, ret, nb_grp;\n\n\t/* Create PDCP entity */\n\tpdcp_entity = rte_pdcp_entity_establish(&conf);\n\n\t/**\n\t * Allocate buffer for holding mbufs returned during PDCP suspend,\n\t * release & post-process APIs.\n\t */\n\n\t/* Max packets that can be cached in entity + burst size */\n\tnb_max_out_mb = pdcp_entity->max_pkt_cache + 1;\n\tout_mb = rte_malloc(NULL, nb_max_out_mb * sizeof(uintptr_t), 0);\n\tif (out_mb == NULL) {\n\t\t/* Handle error */\n\t}\n\n\twhile (1) {\n\t\t/* Receive packet and form mbuf */\n\n\t\t/**\n\t\t * Prepare packets for crypto operation. Following operations\n\t\t * would be done,\n\t\t *\n\t\t * Transmitting entity/UL (only data PDUs):\n\t\t * - Perform compression\n\t\t * - Assign sequence number\n\t\t * - Add PDCP header\n\t\t * - Create & prepare crypto_op\n\t\t * - Prepare IV for crypto operation (auth_gen, encrypt)\n\t\t * - Save original PDCP SDU (during PDCP re-establishment,\n\t\t * unconfirmed PDCP SDUs need to crypto processed again and\n\t\t * transmitted/re-transmitted)\n\t\t *\n\t\t * Receiving entity/DL:\n\t\t * - Any control PDUs received would be processed and\n\t\t * appropriate actions taken. If data PDU, continue.\n\t\t * - Determine sequence number (based on HFN & per packet SN)\n\t\t * - Prepare crypto_op\n\t\t * - Prepare IV for crypto operation (decrypt, auth_verify)\n\t\t */\n\t\tnb_success = rte_pdcp_pkt_pre_process(pdcp_entity, pkts, cop,\n\t\t\t\t\t\t nb_rx, &nb_err);\n\t\tif (nb_err != 0) {\n\t\t\t/* Handle error packets */\n\t\t}\n\n\t\tif ((rte_cryptodev_enqueue_burst(dev_id, qp_id, cop, nb_success)\n\t\t\t\t!= nb_success) {\n\t\t\t/* Retry for enqueue failure packets */\n\t\t}\n\n\t\t...\n\n\t\tret = rte_cryptodev_dequeue_burst(dev_id, qp_id, cop,\n\t\t\t\t\t\t MAX_BURST_SIZE);\n\t\tif (ret == 0)\n\t\t\tcontinue;\n\n\t\t/**\n\t\t * Received a burst of completed crypto ops from cryptodev. It\n\t\t * may belong to various entities. Group similar ones together\n\t\t * for entity specific post-processing.\n\t\t */\n\n\t\t/**\n\t\t * Groups similar entities together. Frees crypto op and based\n\t\t * on crypto_op status, set mbuf->ol_flags which would be\n\t\t * checked in rte_pdcp_pkt_post_process().\n\t\t */\n\t\tnb_grp = rte_pdcp_pkt_crypto_group(cop, pkts, grp, ret);\n\n\t\tfor (i = 0; i != nb_grp; i++) {\n\n\t\t\t/**\n\t\t\t * Post process packets after crypto completion.\n\t\t\t * Following operations would be done,\n\t\t\t *\n\t\t\t * Transmitting entity/UL:\n\t\t\t * - Check crypto result\n\t\t\t *\n\t\t\t * Receiving entity/DL:\n\t\t\t * - Check crypto operation status\n\t\t\t * - Check for duplication (if yes, drop duplicate)\n\t\t\t * - Perform decompression\n\t\t\t * - Trim PDCP header\n\t\t\t * - Hold packet (SDU) for in-order delivery (return\n\t\t\t * completed packets as and when sequence is\n\t\t\t * completed)\n\t\t\t * - If not in sequence, cache the packet and start\n\t\t\t * t-Reordering timer. When timer expires, the\n\t\t\t * packets need to delivered to upper layers (not\n\t\t\t * treated as error packets).\n\t\t\t */\n\t\t\tnb_success = rte_pdcp_pkt_post_process(grp[i].id.ptr,\n\t\t\t\t\t\t\t grp[i].m, out_mb,\n\t\t\t\t\t\t\t grp[i].cnt,\n\t\t\t\t\t\t\t &nb_err);\n\t\t\tif (nb_err != 0) {\n\t\t\t\t/* Handle error packets */\n\t\t\t}\n\n\t\t\t/* Perform additional operations */\n\n\t\t\t/**\n\t\t\t * Tranmitting entity/UL\n\t\t\t * - If duplication is enabled, duplicate PDCP PDUs\n\t\t\t * - When lower layers confirm reception of a PDCP PDU,\n\t\t\t * it should be communicated to PDCP layer so that\n\t\t\t * PDCP can drop the corresponding SDU\n\t\t\t */\n\t\t}\n\t}\n\nAnoob Joseph (3):\n lib: add pdcp protocol\n app/test: add lib pdcp tests\n doc: add PDCP library guide\n\nVolodymyr Fialko (2):\n net: add PDCP header\n app/test: pdcp HFN tests in combined mode\n\n app/test/meson.build | 1 +\n app/test/test_cryptodev.h | 3 +\n app/test/test_pdcp.c | 999 ++++++++++++++\n doc/api/doxy-api-index.md | 4 +-\n doc/api/doxy-api.conf.in | 1 +\n .../img/pdcp_functional_overview.svg | 1 +\n doc/guides/prog_guide/index.rst | 1 +\n doc/guides/prog_guide/pdcp_lib.rst | 211 +++\n lib/meson.build | 1 +\n lib/net/meson.build | 1 +\n lib/net/rte_pdcp_hdr.h | 93 ++\n lib/pdcp/meson.build | 8 +\n lib/pdcp/pdcp_crypto.c | 240 ++++\n lib/pdcp/pdcp_crypto.h | 20 +\n lib/pdcp/pdcp_entity.h | 218 +++\n lib/pdcp/pdcp_process.c | 1195 +++++++++++++++++\n lib/pdcp/pdcp_process.h | 13 +\n lib/pdcp/rte_pdcp.c | 136 ++\n lib/pdcp/rte_pdcp.h | 263 ++++\n lib/pdcp/rte_pdcp_group.h | 133 ++\n lib/pdcp/version.map | 13 +\n 21 files changed, 3554 insertions(+), 1 deletion(-)\n create mode 100644 app/test/test_pdcp.c\n create mode 100644 doc/guides/prog_guide/img/pdcp_functional_overview.svg\n create mode 100644 doc/guides/prog_guide/pdcp_lib.rst\n create mode 100644 lib/net/rte_pdcp_hdr.h\n create mode 100644 lib/pdcp/meson.build\n create mode 100644 lib/pdcp/pdcp_crypto.c\n create mode 100644 lib/pdcp/pdcp_crypto.h\n create mode 100644 lib/pdcp/pdcp_entity.h\n create mode 100644 lib/pdcp/pdcp_process.c\n create mode 100644 lib/pdcp/pdcp_process.h\n create mode 100644 lib/pdcp/rte_pdcp.c\n create mode 100644 lib/pdcp/rte_pdcp.h\n create mode 100644 lib/pdcp/rte_pdcp_group.h\n create mode 100644 lib/pdcp/version.map", "diff": null, "prefixes": [ "0/5" ] }