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 0C5B7A04DD; Wed, 28 Oct 2020 14:26:19 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 88E4CCABE; Wed, 28 Oct 2020 14:26:17 +0100 (CET) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id 914B4CAAD for ; Wed, 28 Oct 2020 14:26:13 +0100 (CET) IronPort-SDR: +jzS4s9syAX04U64Cn52CB4EGZLB/JWvhwVt5AZQx7NuE6C6Zc72Nr7lh/NWW+7aSf/LuBlbaf 0o5TTxrY0AFw== X-IronPort-AV: E=McAfee;i="6000,8403,9787"; a="155224256" X-IronPort-AV: E=Sophos;i="5.77,426,1596524400"; d="scan'208";a="155224256" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 28 Oct 2020 06:26:12 -0700 IronPort-SDR: sGuHRcWuV87NcZEy0Dp4pZvAL+YoF9SNWLhrpQvex5CzybVUe+7/SeoC+m5jb7kzNQu/o/BKIE 72DmA8Ic6hOA== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,426,1596524400"; d="scan'208";a="526325499" Received: from fmsmsx602.amr.corp.intel.com ([10.18.126.82]) by fmsmga005.fm.intel.com with ESMTP; 28 Oct 2020 06:26:11 -0700 Received: from fmsmsx612.amr.corp.intel.com (10.18.126.92) by fmsmsx602.amr.corp.intel.com (10.18.126.82) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.1713.5; Wed, 28 Oct 2020 06:26:11 -0700 Received: from fmsmsx603.amr.corp.intel.com (10.18.126.83) by fmsmsx612.amr.corp.intel.com (10.18.126.92) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.1713.5; Wed, 28 Oct 2020 06:26:11 -0700 Received: from fmsedg601.ED.cps.intel.com (10.1.192.135) by fmsmsx603.amr.corp.intel.com (10.18.126.83) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.1713.5 via Frontend Transport; Wed, 28 Oct 2020 06:26:11 -0700 Received: from NAM12-DM6-obe.outbound.protection.outlook.com (104.47.59.168) by edgegateway.intel.com (192.55.55.70) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.1713.5; Wed, 28 Oct 2020 06:26:10 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=Z8Mo5by54n1NCqQMlLg53SMSMs8DnXijRXrGlwQj0w8fiI6o9yv9HgFWXMYcfoyB7IPy1X1Yd4w85KTXopAKm2jGjaTh2E9jHF4D0c5RFd/PKuuaTLwbfLBkQGNu6ijAFSnqp1UO7oGH2r3Mmqp+WGpAURNHvjm1RsT6w+2MXkyb85Bhs8pfu2FxyHo2dlfcHOtUmzKn0bgNmCPJcp3UycW4Jc+h410XIUCM/dYIWLRozP7lhLW64eyfPVq/IXIMk7+X/LGa2caQtfdMkUyzP/7QXXXafN0FksEMMZVkRZ5hqUAGKA14SKXZia9MI+oHWMv/435eVzNo3C+gvYRXaw== 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=7yC9hwcC5pKhgkTPtPjZb2f+IXC5c5xbxqvkg/IKm2A=; b=ZJrjpJh36sGmLfZJxp7KzVpAbrTCYR+f1zBmnqZ4dXjjnd4GPasKHzEzjmW9l3YM/Apt/M1jwLc7JmZVAgQi+oxt3cQvh+5TPCmgq3M/8sPNuy5tZUOe46ONXNEPZAbfZZczf9QaM9qJ+wS7vyXyeT8+KueH3VXGg5l4yQgLCFlx2jpZzvjt+5lLCluOcPduAFHoagVfvlUHC+mF5eM59CuufrQsvAZVNbQn9ZHx7LXphNHy7jzKDJj7eCE/zzvXvrjWke+Ck64c3eWGIJm0E1cSg5wvM26F2d/pYWJk5tJvT3Eclk8K7J5IgH6pO9s4p7COB1R1A5R/fYjsIDPzqA== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=intel.com; dmarc=pass action=none header.from=intel.com; dkim=pass header.d=intel.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=intel.onmicrosoft.com; s=selector2-intel-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=7yC9hwcC5pKhgkTPtPjZb2f+IXC5c5xbxqvkg/IKm2A=; b=U93hS4hvZ3sdl7SADTzvdscy1rtMn4gtI2iSUpMp48cloFYKveHuoKYSIyATGyHtfSEcriEYmqBglCIPPbgDkvj4H5n3SMBxr0BqvRgc73gnQL4/LujkRzex2HdEjHtQ9VXC4r9Ze//E9QwKsa9p06b0Upbsd2Qu1ZyzQ51+E+g= Received: from BYAPR11MB3301.namprd11.prod.outlook.com (2603:10b6:a03:7f::26) by BYAPR11MB3671.namprd11.prod.outlook.com (2603:10b6:a03:b3::15) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3499.18; Wed, 28 Oct 2020 13:26:08 +0000 Received: from BYAPR11MB3301.namprd11.prod.outlook.com ([fe80::f5a4:3f6b:ade3:296b]) by BYAPR11MB3301.namprd11.prod.outlook.com ([fe80::f5a4:3f6b:ade3:296b%3]) with mapi id 15.20.3499.027; Wed, 28 Oct 2020 13:26:08 +0000 From: "Ananyev, Konstantin" To: "Gujjar, Abhinandan S" , "dev@dpdk.org" , "Doherty, Declan" , "akhil.goyal@nxp.com" , "Honnappa.Nagarahalli@arm.com" CC: "Vangati, Narender" , "jerinj@marvell.com" Thread-Topic: [v5 1/2] cryptodev: support enqueue & dequeue callback functions Thread-Index: AQHWrQKwxKWeJ3Rr3kOT8NgJqu3eE6mtAFmw Date: Wed, 28 Oct 2020 13:26:08 +0000 Message-ID: References: <1603753767-79295-1-git-send-email-abhinandan.gujjar@intel.com> <1603753767-79295-2-git-send-email-abhinandan.gujjar@intel.com> In-Reply-To: <1603753767-79295-2-git-send-email-abhinandan.gujjar@intel.com> Accept-Language: en-GB, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: dlp-product: dlpe-windows dlp-reaction: no-action dlp-version: 11.5.1.3 authentication-results: intel.com; dkim=none (message not signed) header.d=none;intel.com; dmarc=none action=none header.from=intel.com; x-originating-ip: [46.7.39.127] x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: 92efece8-86b3-49c1-8dec-08d87b4507a1 x-ms-traffictypediagnostic: BYAPR11MB3671: x-ld-processed: 46c98d88-e344-4ed4-8496-4ed7712e255d,ExtAddr x-ms-exchange-transport-forked: True x-microsoft-antispam-prvs: x-ms-oob-tlc-oobclassifiers: OLM:10000; x-ms-exchange-senderadcheck: 1 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: 97W6fLYWFoyIDc0jx+Iy/p+0x7pnV8WFVsN33UF9kNAbTe78l7U2Xf7EcE0lT0fFTLXIiu1QDU3YAzEZv3m8ccLCaUfBXJ8EPJ5N+xgTWjVIE9s0mSJenpRQSEJ4NoXbL5wSV1Fl2I+X45r0btjnVXMGlOcHNgYXXUKBApOi/7P8ETOrzlW3WycO7CWP2Fe5SlcGh2V2vV4CeO9QG6PZdvpTddQDdixZMphPhLkzu1R1CcrHfiQdvNH5oIccaBghiYaqusjGlSDsGR0A6TSPML58PkCmQigzcOyaDDa45QZCYfurR39uYkQEp0vDuBIc x-forefront-antispam-report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:BYAPR11MB3301.namprd11.prod.outlook.com; PTR:; CAT:NONE; SFS:(4636009)(136003)(396003)(346002)(366004)(39860400002)(376002)(33656002)(186003)(26005)(478600001)(5660300002)(110136005)(55016002)(54906003)(316002)(4326008)(66946007)(76116006)(64756008)(66446008)(52536014)(66556008)(66476007)(2906002)(9686003)(71200400001)(86362001)(8676002)(6506007)(7696005)(8936002)(83380400001)(30864003)(579004)(559001); DIR:OUT; SFP:1102; x-ms-exchange-antispam-messagedata: 46HE1dAWs6+wyoLDreGYvLJ07G+EI5l4wbU9RA1aKsxS3ToVel+vtwYSUnTkwet35Xrbgm6KYWjxpkUOpt71wiTgQqCTgkg3ptY1zuFuqvGMBfFHqlD01wTE1slayRy3KwM4nr/b4TZErb6vS7XOctaBx0A29eyLTjULrhdV2SYy5/KHkLiX+m2seKX7MCxrPJ7EjX1pcNqGmSNRUrAKh2Pfs5ah5RpJhpPSMReXmgsYh6Us5/NGeeQ9qrF9zLVtevkxbUDwdMu2zeW7GmonFeDhfz+5alX5QC+UNjhIYyGroimGMUlZ5pw7EWwzVb2L5Ip5hvzVCzktdOTRBMu+8lXFn7U9++tGa1fDkTQk7YqkeZKc3ENftAjQLMTp+XuY4pQlV/koN4WC1MTpYg28zGLGvyAcbcr3nqMFpO7NSH1F0AVd3w5xRhcKR/HQwYMGwYBiPCm2EC29OngIwN6o0TBHIrolfQKjRHgsPAFDHx8D7q/P1TcE1vDRTGf5aiLnOdiGR2g0Go4GTqEB1B/Pwy8r1YxD6AePi7no/2/aB8rIsF26EqoyZtvE2K/flxWdQ1LkeLBFDHuDMNNdLJnU77uhf2bnpRGhVT8EwPwNOEAilHC8PMT6/0hxY7qnn03Iv3uJkZaZQ4BqGvMLblVbsA== Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: BYAPR11MB3301.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: 92efece8-86b3-49c1-8dec-08d87b4507a1 X-MS-Exchange-CrossTenant-originalarrivaltime: 28 Oct 2020 13:26:08.2563 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 46c98d88-e344-4ed4-8496-4ed7712e255d X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: Bb++q0ALNp56+hKy4vIQr7xoBBZaXihcd5wknmgkjo9CyJ5z81YaVCQKHyiHmCFCq49SlQyk7SFW3JNvqzpcu0damry1GI9KUCRkoITQ7Xw= X-MS-Exchange-Transport-CrossTenantHeadersStamped: BYAPR11MB3671 X-OriginatorOrg: intel.com Subject: Re: [dpdk-dev] [v5 1/2] cryptodev: support enqueue & dequeue callback functions 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" > This patch adds APIs to add/remove callback functions on crypto > enqueue/dequeue burst. The callback function will be called for > each burst of crypto ops received on a given crypto device queue pair. >=20 > Signed-off-by: Abhinandan Gujjar > Acked-by: Konstantin Ananyev > --- > config/rte_config.h | 1 + > doc/guides/prog_guide/cryptodev_lib.rst | 47 +++ > doc/guides/rel_notes/release_20_11.rst | 6 + > lib/librte_cryptodev/meson.build | 2 +- > lib/librte_cryptodev/rte_cryptodev.c | 419 +++++++++++++++++++= +++++- > lib/librte_cryptodev/rte_cryptodev.h | 260 ++++++++++++++- > lib/librte_cryptodev/rte_cryptodev_version.map | 4 + > 7 files changed, 736 insertions(+), 3 deletions(-) >=20 > diff --git a/config/rte_config.h b/config/rte_config.h > index 03d90d7..e999d93 100644 > --- a/config/rte_config.h > +++ b/config/rte_config.h > @@ -61,6 +61,7 @@ > /* cryptodev defines */ > #define RTE_CRYPTO_MAX_DEVS 64 > #define RTE_CRYPTODEV_NAME_LEN 64 > +#define RTE_CRYPTO_CALLBACKS 1 >=20 > /* compressdev defines */ > #define RTE_COMPRESS_MAX_DEVS 64 > diff --git a/doc/guides/prog_guide/cryptodev_lib.rst b/doc/guides/prog_gu= ide/cryptodev_lib.rst > index 72129e4..9d0ff59 100644 > --- a/doc/guides/prog_guide/cryptodev_lib.rst > +++ b/doc/guides/prog_guide/cryptodev_lib.rst > @@ -338,6 +338,53 @@ start of private data information. The offset is cou= nted from the start of the > rte_crypto_op including other crypto information such as the IVs (since = there can > be an IV also for authentication). >=20 > +User callback APIs > +~~~~~~~~~~~~~~~~~~ > +The add APIs configures a user callback function to be called for each b= urst of crypto > +ops received/sent on a given crypto device queue pair. The return value = is a pointer > +that can be used later to remove the callback API. Application is expect= ed to register > +a callback function of type ``rte_cryptodev_callback_fn``. Multiple call= back functions > +can be added for a given queue pair. API does not restrict on maximum nu= mber of > +callbacks. > + > +Callbacks registered by application would not survive rte_cryptodev_conf= igure() as it > +reinitializes the callback list. It is user responsibility to remove all= installed > +callbacks before calling rte_cryptodev_configure() to avoid possible mem= ory leakage. > + > +So, application is expected to add user callback after rte_cryptodev_con= figure(). > +The callbacks can also be added at the runtime. These callbacks get exec= uted when > +``rte_cryptodev_enqueue_burst``/``rte_cryptodev_dequeue_burst`` is calle= d. > + > +.. code-block:: c > + > + struct rte_cryptodev_cb * > + rte_cryptodev_add_enq_callback(uint8_t dev_id, > + uint16_t qp_id, > + rte_cryptodev_callback_fn cb_fn, > + void *cb_arg); > + > + struct rte_cryptodev_cb * > + rte_cryptodev_add_deq_callback(uint8_t dev_id, > + uint16_t qp_id, > + rte_cryptodev_callback_fn cb_fn, > + void *cb_arg); > + > + uint16_t (*rte_cryptodev_callback_fn)(uint16_t dev_id, uint16_t qp_id, > + struct rte_crypto_op **ops, uint16_t nb_ops, void *user_param); > + > +The remove API removes a callback function added by > +``rte_cryptodev_add_enq_callback``/``rte_cryptodev_add_deq_callback''. > + > +.. code-block:: c > + > + int rte_cryptodev_remove_enq_callback(uint8_t dev_id, > + uint16_t qp_id, > + struct rte_cryptodev_cb *cb); > + > + int rte_cryptodev_remove_deq_callback(uint8_t dev_id, > + uint16_t qp_id, > + struct rte_cryptodev_cb *cb); > + >=20 > Enqueue / Dequeue Burst APIs > ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > diff --git a/doc/guides/rel_notes/release_20_11.rst b/doc/guides/rel_note= s/release_20_11.rst > index 48717ee..d12fb31 100644 > --- a/doc/guides/rel_notes/release_20_11.rst > +++ b/doc/guides/rel_notes/release_20_11.rst > @@ -174,6 +174,12 @@ New Features > enqueue/dequeue operations but does not necessarily depends on > mbufs and cryptodev operation mempools. >=20 > +* **Added enqueue & dequeue callback APIs for cryptodev library.** > + > + Cryptodev libray is added with enqueue & dequeue callback APIs to > + enable applications to add/remove user callbacks which gets called > + for every enqueue/dequeue operation. > + > * **Updated the aesni_mb crypto PMD.** >=20 > * Added support for AES-ECB 128, 192 and 256. > diff --git a/lib/librte_cryptodev/meson.build b/lib/librte_cryptodev/meso= n.build > index c4c6b3b..8c5493f 100644 > --- a/lib/librte_cryptodev/meson.build > +++ b/lib/librte_cryptodev/meson.build > @@ -9,4 +9,4 @@ headers =3D files('rte_cryptodev.h', > 'rte_crypto.h', > 'rte_crypto_sym.h', > 'rte_crypto_asym.h') > -deps +=3D ['kvargs', 'mbuf'] > +deps +=3D ['kvargs', 'mbuf', 'rcu'] > diff --git a/lib/librte_cryptodev/rte_cryptodev.c b/lib/librte_cryptodev/= rte_cryptodev.c > index 3d95ac6..677c2ef 100644 > --- a/lib/librte_cryptodev/rte_cryptodev.c > +++ b/lib/librte_cryptodev/rte_cryptodev.c > @@ -448,6 +448,127 @@ struct rte_cryptodev_sym_session_pool_private_data = { > return 0; > } >=20 > +#ifdef RTE_CRYPTO_CALLBACKS > +/* spinlock for crypto device enq callbacks */ > +static rte_spinlock_t rte_cryptodev_callback_lock =3D RTE_SPINLOCK_INITI= ALIZER; > + > +static void > +cryptodev_cb_cleanup(struct rte_cryptodev *dev) > +{ > + struct rte_cryptodev_cb_rcu *list; > + struct rte_cryptodev_cb *cb, *next; > + uint16_t qp_id; > + > + if (dev->enq_cbs =3D=3D NULL && dev->deq_cbs =3D=3D NULL) > + return; > + > + for (qp_id =3D 0; qp_id < dev->data->nb_queue_pairs; qp_id++) { > + list =3D &dev->enq_cbs[qp_id]; > + cb =3D list->next; > + while (cb !=3D NULL) { > + next =3D cb->next; > + rte_free(cb); > + cb =3D next; > + } > + > + rte_free(list->qsbr); > + } > + > + for (qp_id =3D 0; qp_id < dev->data->nb_queue_pairs; qp_id++) { > + list =3D &dev->deq_cbs[qp_id]; > + cb =3D list->next; > + while (cb !=3D NULL) { > + next =3D cb->next; > + rte_free(cb); > + cb =3D next; > + } > + > + rte_free(list->qsbr); > + } > + > + rte_free(dev->enq_cbs); > + dev->enq_cbs =3D NULL; > + rte_free(dev->deq_cbs); > + dev->deq_cbs =3D NULL; > +} > + > +static int > +cryptodev_cb_init(struct rte_cryptodev *dev) > +{ > + struct rte_cryptodev_cb_rcu *list; > + struct rte_rcu_qsbr *qsbr; > + uint16_t qp_id; > + size_t size; > + > + /* Max thread set to 1, as one DP thread accessing a queue-pair */ > + const uint32_t max_threads =3D 1; > + > + dev->enq_cbs =3D rte_zmalloc(NULL, > + sizeof(struct rte_cryptodev_cb_rcu) * > + dev->data->nb_queue_pairs, 0); > + if (dev->enq_cbs =3D=3D NULL) { > + CDEV_LOG_ERR("Failed to allocate memory for enq callbacks"); > + rte_errno =3D ENOMEM; As a nit - if this function returns an error code as return value, no point to update rte_errno too. > + return -ENOMEM; > + } > + > + dev->deq_cbs =3D rte_zmalloc(NULL, > + sizeof(struct rte_cryptodev_cb_rcu) * > + dev->data->nb_queue_pairs, 0); > + if (dev->deq_cbs =3D=3D NULL) { > + CDEV_LOG_ERR("Failed to allocate memory for deq callbacks"); > + rte_free(dev->enq_cbs); > + rte_errno =3D ENOMEM; > + return -ENOMEM; > + } > + > + /* Create RCU QSBR variable */ > + size =3D rte_rcu_qsbr_get_memsize(max_threads); > + > + for (qp_id =3D 0; qp_id < dev->data->nb_queue_pairs; qp_id++) { > + list =3D &dev->enq_cbs[qp_id]; > + qsbr =3D rte_zmalloc(NULL, size, RTE_CACHE_LINE_SIZE); > + if (qsbr =3D=3D NULL) { > + CDEV_LOG_ERR("Failed to allocate memory for RCU on " > + "queue_pair_id=3D%d", qp_id); > + goto cb_init_err; > + } > + > + if (rte_rcu_qsbr_init(qsbr, max_threads)) { > + CDEV_LOG_ERR("Failed to initialize for RCU on " > + "queue_pair_id=3D%d", qp_id); > + goto cb_init_err; > + } > + > + list->qsbr =3D qsbr; > + } > + > + for (qp_id =3D 0; qp_id < dev->data->nb_queue_pairs; qp_id++) { > + list =3D &dev->deq_cbs[qp_id]; > + qsbr =3D rte_zmalloc(NULL, size, RTE_CACHE_LINE_SIZE); > + if (qsbr =3D=3D NULL) { > + CDEV_LOG_ERR("Failed to allocate memory for RCU on " > + "queue_pair_id=3D%d", qp_id); > + goto cb_init_err; > + } > + > + if (rte_rcu_qsbr_init(qsbr, max_threads)) { > + CDEV_LOG_ERR("Failed to initialize for RCU on " > + "queue_pair_id=3D%d", qp_id); > + goto cb_init_err; > + } > + > + list->qsbr =3D qsbr; > + } > + > + return 0; > + > +cb_init_err: > + cryptodev_cb_cleanup(dev); > + rte_errno =3D ENOMEM; Same here - no need to update rte_errno. > + return -ENOMEM; > +} > +#endif >=20 > const char * > rte_cryptodev_get_feature_name(uint64_t flag) > @@ -927,6 +1048,11 @@ struct rte_cryptodev * >=20 > RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP); >=20 > +#ifdef RTE_CRYPTO_CALLBACKS > + rte_spinlock_lock(&rte_cryptodev_callback_lock); > + cryptodev_cb_cleanup(dev); > + rte_spinlock_unlock(&rte_cryptodev_callback_lock); > +#endif > /* Setup new number of queue pairs and reconfigure device. */ > diag =3D rte_cryptodev_queue_pairs_config(dev, config->nb_queue_pairs, > config->socket_id); > @@ -936,11 +1062,19 @@ struct rte_cryptodev * > return diag; > } >=20 > +#ifdef RTE_CRYPTO_CALLBACKS > + rte_spinlock_lock(&rte_cryptodev_callback_lock); > + diag =3D cryptodev_cb_init(dev); > + rte_spinlock_unlock(&rte_cryptodev_callback_lock); > + if (diag) { > + CDEV_LOG_ERR("Callback init failed for dev_id=3D%d", dev_id); > + return diag; > + } > +#endif > rte_cryptodev_trace_configure(dev_id, config); > return (*dev->dev_ops->dev_configure)(dev, config); > } >=20 > - > int > rte_cryptodev_start(uint8_t dev_id) > { > @@ -1136,6 +1270,289 @@ struct rte_cryptodev * > socket_id); > } >=20 > +#ifdef RTE_CRYPTO_CALLBACKS > +struct rte_cryptodev_cb * > +rte_cryptodev_add_enq_callback(uint8_t dev_id, > + uint16_t qp_id, > + rte_cryptodev_callback_fn cb_fn, > + void *cb_arg) > +{ > + struct rte_cryptodev *dev; > + struct rte_cryptodev_cb_rcu *list; > + struct rte_cryptodev_cb *cb, *tail; > + > + if (!cb_fn) { > + CDEV_LOG_ERR("Callback is NULL on dev_id=3D%d", dev_id); > + rte_errno =3D EINVAL; > + return NULL; > + } > + > + if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) { > + CDEV_LOG_ERR("Invalid dev_id=3D%d", dev_id); > + rte_errno =3D ENODEV; > + return NULL; > + } > + > + dev =3D &rte_crypto_devices[dev_id]; > + if (qp_id >=3D dev->data->nb_queue_pairs) { > + CDEV_LOG_ERR("Invalid queue_pair_id=3D%d", qp_id); > + rte_errno =3D ENODEV; > + return NULL; > + } > + > + cb =3D rte_zmalloc(NULL, sizeof(*cb), 0); > + if (cb =3D=3D NULL) { > + CDEV_LOG_ERR("Failed to allocate memory for callback on " > + "dev=3D%d, queue_pair_id=3D%d", dev_id, qp_id); > + rte_errno =3D ENOMEM; > + return NULL; > + } > + > + rte_spinlock_lock(&rte_cryptodev_callback_lock); > + > + cb->fn =3D cb_fn; > + cb->arg =3D cb_arg; > + > + /* Add the callbacks in fifo order. */ > + list =3D &dev->enq_cbs[qp_id]; > + tail =3D list->next; > + > + if (tail) { > + while (tail->next) > + tail =3D tail->next; > + /* Stores to cb->fn and cb->param should complete before > + * cb is visible to data plane. > + */ > + __atomic_store_n(&tail->next, cb, __ATOMIC_RELEASE); > + } else { > + /* Stores to cb->fn and cb->param should complete before > + * cb is visible to data plane. > + */ > + __atomic_store_n(&list->next, cb, __ATOMIC_RELEASE); > + } > + > + rte_spinlock_unlock(&rte_cryptodev_callback_lock); > + > + return cb; > +} > + > +int > +rte_cryptodev_remove_enq_callback(uint8_t dev_id, > + uint16_t qp_id, > + struct rte_cryptodev_cb *cb) > +{ > + struct rte_cryptodev *dev; > + struct rte_cryptodev_cb **prev_cb, *curr_cb; > + struct rte_cryptodev_cb_rcu *list; > + int ret; > + > + ret =3D -EINVAL; > + > + if (!cb) { > + CDEV_LOG_ERR("Callback is NULL"); > + rte_errno =3D EINVAL; Same story here - no need to update rte_errno, if we provide error code as return value. > + return -EINVAL; > + } > + > + if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) { > + CDEV_LOG_ERR("Invalid dev_id=3D%d", dev_id); > + rte_errno =3D ENODEV; > + return -ENODEV; > + } > + > + dev =3D &rte_crypto_devices[dev_id]; > + if (qp_id >=3D dev->data->nb_queue_pairs) { > + CDEV_LOG_ERR("Invalid queue_pair_id=3D%d", qp_id); > + rte_errno =3D ENODEV; > + return -ENODEV; > + } > + > + rte_spinlock_lock(&rte_cryptodev_callback_lock); > + if (dev->enq_cbs =3D=3D NULL) { > + CDEV_LOG_ERR("Callback not initialized"); > + rte_errno =3D EINVAL; > + goto cb_err; > + } > + > + list =3D &dev->enq_cbs[qp_id]; > + if (list =3D=3D NULL) { > + CDEV_LOG_ERR("Callback list is NULL"); > + rte_errno =3D EINVAL; > + goto cb_err; > + } > + > + if (list->qsbr =3D=3D NULL) { > + CDEV_LOG_ERR("Rcu qsbr is NULL"); > + rte_errno =3D EINVAL; > + goto cb_err; > + } > + > + prev_cb =3D &list->next; > + for (; *prev_cb !=3D NULL; prev_cb =3D &curr_cb->next) { > + curr_cb =3D *prev_cb; > + if (curr_cb =3D=3D cb) { > + /* Remove the user cb from the callback list. */ > + __atomic_store_n(prev_cb, curr_cb->next, > + __ATOMIC_RELAXED); > + ret =3D 0; > + break; > + } > + } > + > + if (!ret) { > + /* Call sync with invalid thread id as this is part of > + * control plane API > + */ > + rte_rcu_qsbr_synchronize(list->qsbr, RTE_QSBR_THRID_INVALID); > + rte_free(cb); > + } > + > +cb_err: > + rte_spinlock_unlock(&rte_cryptodev_callback_lock); > + return ret; > +} > + > +struct rte_cryptodev_cb * > +rte_cryptodev_add_deq_callback(uint8_t dev_id, > + uint16_t qp_id, > + rte_cryptodev_callback_fn cb_fn, > + void *cb_arg) > +{ > + struct rte_cryptodev *dev; > + struct rte_cryptodev_cb_rcu *list; > + struct rte_cryptodev_cb *cb, *tail; > + > + if (!cb_fn) { > + CDEV_LOG_ERR("Callback is NULL on dev_id=3D%d", dev_id); > + rte_errno =3D EINVAL; > + return NULL; > + } > + > + if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) { > + CDEV_LOG_ERR("Invalid dev_id=3D%d", dev_id); > + rte_errno =3D ENODEV; > + return NULL; > + } > + > + dev =3D &rte_crypto_devices[dev_id]; > + if (qp_id >=3D dev->data->nb_queue_pairs) { > + CDEV_LOG_ERR("Invalid queue_pair_id=3D%d", qp_id); > + rte_errno =3D ENODEV; > + return NULL; > + } > + > + cb =3D rte_zmalloc(NULL, sizeof(*cb), 0); > + if (cb =3D=3D NULL) { > + CDEV_LOG_ERR("Failed to allocate memory for callback on " > + "dev=3D%d, queue_pair_id=3D%d", dev_id, qp_id); > + rte_errno =3D ENOMEM; > + return NULL; > + } > + > + rte_spinlock_lock(&rte_cryptodev_callback_lock); > + > + cb->fn =3D cb_fn; > + cb->arg =3D cb_arg; > + > + /* Add the callbacks in fifo order. */ > + list =3D &dev->deq_cbs[qp_id]; > + tail =3D list->next; > + > + if (tail) { > + while (tail->next) > + tail =3D tail->next; > + /* Stores to cb->fn and cb->param should complete before > + * cb is visible to data plane. > + */ > + __atomic_store_n(&tail->next, cb, __ATOMIC_RELEASE); > + } else { > + /* Stores to cb->fn and cb->param should complete before > + * cb is visible to data plane. > + */ > + __atomic_store_n(&list->next, cb, __ATOMIC_RELEASE); > + } > + > + rte_spinlock_unlock(&rte_cryptodev_callback_lock); > + > + return cb; > +} > + > +int > +rte_cryptodev_remove_deq_callback(uint8_t dev_id, > + uint16_t qp_id, > + struct rte_cryptodev_cb *cb) > +{ > + struct rte_cryptodev *dev; > + struct rte_cryptodev_cb **prev_cb, *curr_cb; > + struct rte_cryptodev_cb_rcu *list; > + int ret; > + > + ret =3D -EINVAL; > + > + if (!cb) { > + CDEV_LOG_ERR("Callback is NULL"); > + rte_errno =3D EINVAL; > + return -EINVAL; > + } > + > + if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) { > + CDEV_LOG_ERR("Invalid dev_id=3D%d", dev_id); > + rte_errno =3D ENODEV; > + return -ENODEV; > + } > + > + dev =3D &rte_crypto_devices[dev_id]; > + if (qp_id >=3D dev->data->nb_queue_pairs) { > + CDEV_LOG_ERR("Invalid queue_pair_id=3D%d", qp_id); > + rte_errno =3D ENODEV; > + return -ENODEV; > + } > + > + rte_spinlock_lock(&rte_cryptodev_callback_lock); > + if (dev->enq_cbs =3D=3D NULL) { > + CDEV_LOG_ERR("Callback not initialized"); > + rte_errno =3D EINVAL; > + goto cb_err; > + } > + > + list =3D &dev->deq_cbs[qp_id]; > + if (list =3D=3D NULL) { > + CDEV_LOG_ERR("Callback list is NULL"); > + rte_errno =3D EINVAL; > + goto cb_err; > + } > + > + if (list->qsbr =3D=3D NULL) { > + CDEV_LOG_ERR("Rcu qsbr is NULL"); > + rte_errno =3D EINVAL; > + goto cb_err; > + } > + > + prev_cb =3D &list->next; > + for (; *prev_cb !=3D NULL; prev_cb =3D &curr_cb->next) { > + curr_cb =3D *prev_cb; > + if (curr_cb =3D=3D cb) { > + /* Remove the user cb from the callback list. */ > + __atomic_store_n(prev_cb, curr_cb->next, > + __ATOMIC_RELAXED); > + ret =3D 0; > + break; > + } > + } > + > + if (!ret) { > + /* Call sync with invalid thread id as this is part of > + * control plane API > + */ > + rte_rcu_qsbr_synchronize(list->qsbr, RTE_QSBR_THRID_INVALID); > + rte_free(cb); > + } > + > +cb_err: > + rte_spinlock_unlock(&rte_cryptodev_callback_lock); > + return ret; > +} > +#endif >=20 > int > rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stat= s) > diff --git a/lib/librte_cryptodev/rte_cryptodev.h b/lib/librte_cryptodev/= rte_cryptodev.h > index 0935fd5..3477a37 100644 > --- a/lib/librte_cryptodev/rte_cryptodev.h > +++ b/lib/librte_cryptodev/rte_cryptodev.h > @@ -23,6 +23,7 @@ > #include "rte_dev.h" > #include > #include > +#include >=20 > #include "rte_cryptodev_trace_fp.h" >=20 > @@ -522,6 +523,32 @@ struct rte_cryptodev_qp_conf { > /**< The mempool for creating sess private data in sessionless mode */ > }; >=20 > +#ifdef RTE_CRYPTO_CALLBACKS > +/** > + * Function type used for processing crypto ops when enqueue/dequeue bur= st is > + * called. > + * > + * The callback function is called on enqueue/dequeue burst immediately. > + * > + * @param dev_id The identifier of the device. > + * @param qp_id The index of the queue pair on which ops are > + * enqueued/dequeued. The value must be in the > + * range [0, nb_queue_pairs - 1] previously > + * supplied to *rte_cryptodev_configure*. > + * @param ops The address of an array of *nb_ops* pointers > + * to *rte_crypto_op* structures which contain > + * the crypto operations to be processed. > + * @param nb_ops The number of operations to process. > + * @param user_param The arbitrary user parameter passed in by the > + * application when the callback was originally > + * registered. > + * @return The number of ops to be enqueued to the > + * crypto device. > + */ > +typedef uint16_t (*rte_cryptodev_callback_fn)(uint16_t dev_id, uint16_t = qp_id, > + struct rte_crypto_op **ops, uint16_t nb_ops, void *user_param); > +#endif > + > /** > * Typedef for application callback function to be registered by applica= tion > * software for notification of device events > @@ -822,7 +849,6 @@ struct rte_cryptodev_config { > enum rte_cryptodev_event_type event, > rte_cryptodev_cb_fn cb_fn, void *cb_arg); >=20 > - > typedef uint16_t (*dequeue_pkt_burst_t)(void *qp, > struct rte_crypto_op **ops, uint16_t nb_ops); > /**< Dequeue processed packets from queue pair of a device. */ > @@ -839,6 +865,33 @@ typedef uint16_t (*enqueue_pkt_burst_t)(void *qp, > /** Structure to keep track of registered callbacks */ > TAILQ_HEAD(rte_cryptodev_cb_list, rte_cryptodev_callback); >=20 > +#ifdef RTE_CRYPTO_CALLBACKS > +/** > + * @internal > + * Structure used to hold information about the callbacks to be called f= or a > + * queue pair on enqueue/dequeue. > + */ > +struct rte_cryptodev_cb { > + struct rte_cryptodev_cb *next; > + /** < Pointer to next callback */ > + rte_cryptodev_callback_fn fn; > + /** < Pointer to callback function */ > + void *arg; > + /** < Pointer to argument */ > +}; > + > +/** > + * @internal > + * Structure used to hold information about the RCU for a queue pair. > + */ > +struct rte_cryptodev_cb_rcu { > + struct rte_cryptodev_cb *next; > + /** < Pointer to next callback */ > + struct rte_rcu_qsbr *qsbr; > + /** < RCU QSBR variable per queue pair */ > +}; > +#endif > + > /** The data structure associated with each crypto device. */ > struct rte_cryptodev { > dequeue_pkt_burst_t dequeue_burst; > @@ -867,6 +920,12 @@ struct rte_cryptodev { > __extension__ > uint8_t attached : 1; > /**< Flag indicating the device is attached */ > + > + struct rte_cryptodev_cb_rcu *enq_cbs; > + /**< User application callback for pre enqueue processing */ > + > + struct rte_cryptodev_cb_rcu *deq_cbs; > + /**< User application callback for post dequeue processing */ > } __rte_cache_aligned; >=20 > void * > @@ -945,6 +1004,30 @@ struct rte_cryptodev_data { > { > struct rte_cryptodev *dev =3D &rte_cryptodevs[dev_id]; >=20 > +#ifdef RTE_CRYPTO_CALLBACKS > + if (unlikely(dev->deq_cbs !=3D NULL)) { > + struct rte_cryptodev_cb_rcu *list; > + struct rte_cryptodev_cb *cb; > + > + /* __ATOMIC_RELEASE memory order was used when the > + * call back was inserted into the list. > + * Since there is a clear dependency between loading > + * cb and cb->fn/cb->next, __ATOMIC_ACQUIRE memory order is > + * not required. > + */ > + list =3D &dev->deq_cbs[qp_id]; > + rte_rcu_qsbr_thread_online(list->qsbr, 0); > + cb =3D __atomic_load_n(&list->next, __ATOMIC_RELAXED); > + > + while (cb !=3D NULL) { > + nb_ops =3D cb->fn(dev_id, qp_id, ops, nb_ops, > + cb->arg); > + cb =3D cb->next; > + }; > + > + rte_rcu_qsbr_thread_offline(list->qsbr, 0); > + } > +#endif > nb_ops =3D (*dev->dequeue_burst) > (dev->data->queue_pairs[qp_id], ops, nb_ops); >=20 > @@ -989,6 +1072,31 @@ struct rte_cryptodev_data { > { > struct rte_cryptodev *dev =3D &rte_cryptodevs[dev_id]; >=20 > +#ifdef RTE_CRYPTO_CALLBACKS > + if (unlikely(dev->enq_cbs !=3D NULL)) { > + struct rte_cryptodev_cb_rcu *list; > + struct rte_cryptodev_cb *cb; > + > + /* __ATOMIC_RELEASE memory order was used when the > + * call back was inserted into the list. > + * Since there is a clear dependency between loading > + * cb and cb->fn/cb->next, __ATOMIC_ACQUIRE memory order is > + * not required. > + */ > + list =3D &dev->enq_cbs[qp_id]; > + rte_rcu_qsbr_thread_online(list->qsbr, 0); > + cb =3D __atomic_load_n(&list->next, __ATOMIC_RELAXED); > + > + while (cb !=3D NULL) { > + nb_ops =3D cb->fn(dev_id, qp_id, ops, nb_ops, > + cb->arg); > + cb =3D cb->next; > + }; > + > + rte_rcu_qsbr_thread_offline(list->qsbr, 0); > + } > +#endif > + > rte_cryptodev_trace_enqueue_burst(dev_id, qp_id, (void **)ops, nb_ops); > return (*dev->enqueue_burst)( > dev->data->queue_pairs[qp_id], ops, nb_ops); > @@ -1730,6 +1838,156 @@ struct rte_crypto_raw_dp_ctx { > rte_cryptodev_raw_dequeue_done(struct rte_crypto_raw_dp_ctx *ctx, > uint32_t n); >=20 > +#ifdef RTE_CRYPTO_CALLBACKS > +/** > + * @warning > + * @b EXPERIMENTAL: this API may change without prior notice > + * > + * Add a user callback for a given crypto device and queue pair which wi= ll be > + * called on crypto ops enqueue. > + * > + * This API configures a function to be called for each burst of crypto = ops > + * received on a given crypto device queue pair. The return value is a p= ointer > + * that can be used later to remove the callback using > + * rte_cryptodev_remove_enq_callback(). > + * > + * Callbacks registered by application would not survive > + * rte_cryptodev_configure() as it reinitializes the callback list. > + * It is user responsibility to remove all installed callbacks before > + * calling rte_cryptodev_configure() to avoid possible memory leakage. > + * Application is expected to call add API after rte_cryptodev_configure= (). > + * > + * Multiple functions can be registered per queue pair & they are called > + * in the order they were added. The API does not restrict on maximum nu= mber > + * of callbacks. > + * > + * @param dev_id The identifier of the device. > + * @param qp_id The index of the queue pair on which ops are > + * to be enqueued for processing. The value > + * must be in the range [0, nb_queue_pairs - 1] > + * previously supplied to > + * *rte_cryptodev_configure*. > + * @param cb_fn The callback function > + * @param cb_arg A generic pointer parameter which will be passed > + * to each invocation of the callback function on > + * this crypto device and queue pair. > + * > + * @return > + * NULL on error. Need to add that rte_errno will contain error code. > + * On success, a pointer value which can later be used to remove the c= allback. > + */ > + > +__rte_experimental > +struct rte_cryptodev_cb * > +rte_cryptodev_add_enq_callback(uint8_t dev_id, > + uint16_t qp_id, > + rte_cryptodev_callback_fn cb_fn, > + void *cb_arg); > + > +/** > + * @warning > + * @b EXPERIMENTAL: this API may change without prior notice > + * > + * Remove a user callback function for given crypto device and queue pai= r. > + * > + * This function is used to remove enqueue callbacks that were added to = a > + * crypto device queue pair using rte_cryptodev_add_enq_callback(). > + * > + * > + * > + * @param dev_id The identifier of the device. > + * @param qp_id The index of the queue pair on which ops are > + * to be enqueued. The value must be in the > + * range [0, nb_queue_pairs - 1] previously > + * supplied to *rte_cryptodev_configure*. > + * @param cb Pointer to user supplied callback created via > + * rte_cryptodev_add_enq_callback(). > + * > + * @return > + * - 0: Success. Callback was removed. > + * - -EINVAL: The dev_id or the qp_id is out of range, or the callbac= k > + * is NULL or not found for the crypto device queue pair. > + */ > + > +__rte_experimental > +int rte_cryptodev_remove_enq_callback(uint8_t dev_id, > + uint16_t qp_id, > + struct rte_cryptodev_cb *cb); > + > +/** > + * @warning > + * @b EXPERIMENTAL: this API may change without prior notice > + * > + * Add a user callback for a given crypto device and queue pair which wi= ll be > + * called on crypto ops dequeue. > + * > + * This API configures a function to be called for each burst of crypto = ops > + * received on a given crypto device queue pair. The return value is a p= ointer > + * that can be used later to remove the callback using > + * rte_cryptodev_remove_deq_callback(). > + * > + * Callbacks registered by application would not survive > + * rte_cryptodev_configure() as it reinitializes the callback list. > + * It is user responsibility to remove all installed callbacks before > + * calling rte_cryptodev_configure() to avoid possible memory leakage. > + * Application is expected to call add API after rte_cryptodev_configure= (). > + * > + * Multiple functions can be registered per queue pair & they are called > + * in the order they were added. The API does not restrict on maximum nu= mber > + * of callbacks. > + * > + * @param dev_id The identifier of the device. > + * @param qp_id The index of the queue pair on which ops are > + * to be dequeued. The value must be in the > + * range [0, nb_queue_pairs - 1] previously > + * supplied to *rte_cryptodev_configure*. > + * @param cb_fn The callback function > + * @param cb_arg A generic pointer parameter which will be passed > + * to each invocation of the callback function on > + * this crypto device and queue pair. > + * > + * @return > + * NULL on error. > + * On success, a pointer value which can later be used to remove the c= allback. > + */ > + > +__rte_experimental > +struct rte_cryptodev_cb * > +rte_cryptodev_add_deq_callback(uint8_t dev_id, > + uint16_t qp_id, > + rte_cryptodev_callback_fn cb_fn, > + void *cb_arg); > + > +/** > + * @warning > + * @b EXPERIMENTAL: this API may change without prior notice > + * > + * Remove a user callback function for given crypto device and queue pai= r. > + * > + * This function is used to remove dequeue callbacks that were added to = a > + * crypto device queue pair using rte_cryptodev_add_deq_callback(). > + * > + * > + * > + * @param dev_id The identifier of the device. > + * @param qp_id The index of the queue pair on which ops are > + * to be dequeued. The value must be in the > + * range [0, nb_queue_pairs - 1] previously > + * supplied to *rte_cryptodev_configure*. > + * @param cb Pointer to user supplied callback created via > + * rte_cryptodev_add_deq_callback(). > + * > + * @return > + * - 0: Success. Callback was removed. > + * - -EINVAL: The dev_id or the qp_id is out of range, or the callbac= k > + * is NULL or not found for the crypto device queue pair. > + */ > +__rte_experimental > +int rte_cryptodev_remove_deq_callback(uint8_t dev_id, > + uint16_t qp_id, > + struct rte_cryptodev_cb *cb); > +#endif > + > #ifdef __cplusplus > } > #endif > diff --git a/lib/librte_cryptodev/rte_cryptodev_version.map b/lib/librte_= cryptodev/rte_cryptodev_version.map > index 7e4360f..429b03e 100644 > --- a/lib/librte_cryptodev/rte_cryptodev_version.map > +++ b/lib/librte_cryptodev/rte_cryptodev_version.map > @@ -101,6 +101,8 @@ EXPERIMENTAL { > rte_cryptodev_get_qp_status; >=20 > # added in 20.11 > + rte_cryptodev_add_deq_callback; > + rte_cryptodev_add_enq_callback; > rte_cryptodev_configure_raw_dp_ctx; > rte_cryptodev_get_raw_dp_ctx_size; > rte_cryptodev_raw_dequeue; > @@ -109,4 +111,6 @@ EXPERIMENTAL { > rte_cryptodev_raw_enqueue; > rte_cryptodev_raw_enqueue_burst; > rte_cryptodev_raw_enqueue_done; > + rte_cryptodev_remove_deq_callback; > + rte_cryptodev_remove_enq_callback; > }; > -- > 1.9.1