From patchwork Mon Oct 9 18:17:09 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Mattias_R=C3=B6nnblom?= X-Patchwork-Id: 132446 X-Patchwork-Delegate: david.marchand@redhat.com Return-Path: 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]) by inbox.dpdk.org (Postfix) with ESMTP id 6595642340; Mon, 9 Oct 2023 20:22:41 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 3D34A4068E; Mon, 9 Oct 2023 20:22:37 +0200 (CEST) Received: from EUR04-DB3-obe.outbound.protection.outlook.com (mail-db3eur04on2074.outbound.protection.outlook.com [40.107.6.74]) by mails.dpdk.org (Postfix) with ESMTP id CB50840648; Mon, 9 Oct 2023 20:22:35 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=Bu2kAl5L15AjwwoDIzHWBxwta+RwPLOeNWradvGPW6WdQrUXjEWwq7ozCsfrIcQlc5sOrKfGGy2OdoFl4P9gtD09XH4XR9bQZ5RTg1Xzl/jp31JJrBwDvv6Wgo6SiBBQOKIsB9CrFBuM/4SdQGuYlovfKGB33eus/L0rPw0w0UlquHL7F0d/kSDlDSVWvgwzVdhdZBFEkEZf1HGCnXD+8S75kryvqFcse9D9dorymjygQs9i/YqsatuQ6Xpcgr7cuxEiXJVPxDcswIY2ysIa1R6Pc159C2wbgfVCIl1sDy12qZe/qMoLBJPXptFXjdWOeiALvZEOU/hfc2xOep5exg== 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-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=KuMcmt16ZSpSUsB7YhaIJETm0+fP9sDjNs6YhNNyiAE=; b=gfDp9lX2d5qVHEOno4bk8lyU+iGNO/TcXG65YY8JezoZnjd0wrCQJjn+tkG2mfixYFjO9SikKUbeD2VlS2L9nFw3SnS+6YWe1jbhCWznlN1to+89ph/BBgrbMyVjAXQH098spanZZJGmlgkWqBdP+8jjKBLIa94xMzvJkx3Bvn+/01/Le7BSxT0H9XQ2U+1M1VdVyJ2aN+q0upS8L0sMQoMCnd60LR8xiI5c6ykJVsFLtgIRQbcWF4tO7hlBSe6M5atYMUR4xk+LECYkPQ/YyktvdV2nGRHhrO+0Nt7BSQ8VAUdjL2GTpCyB0e7XVskBHp4kiOZqE5Whcy1eGve31g== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 192.176.1.74) smtp.rcpttodomain=dpdk.org smtp.mailfrom=ericsson.com; dmarc=pass (p=reject sp=reject pct=100) action=none header.from=ericsson.com; dkim=none (message not signed); arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ericsson.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=KuMcmt16ZSpSUsB7YhaIJETm0+fP9sDjNs6YhNNyiAE=; b=mra0GTJ6R0hTAmBVZgz2pQeB6oSxAnVWKwwajr/69QdlPp9SBkKTJ9tpSzFcVXXNIW966Qr8hAnCpmS6Sy1vbwk9NXpfa8pUAC98LKGr8/CxMZk4RfUBMk5BCKTFbUSVZyVnnLTthL31uiBYvxpr4CwD/+OpoXuJBBZyfKmNBVY= Received: from AM6PR01CA0040.eurprd01.prod.exchangelabs.com (2603:10a6:20b:e0::17) by AS4PR07MB9631.eurprd07.prod.outlook.com (2603:10a6:20b:4f4::5) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6863.36; Mon, 9 Oct 2023 18:22:32 +0000 Received: from AMS1EPF0000004A.eurprd04.prod.outlook.com (2603:10a6:20b:e0:cafe::22) by AM6PR01CA0040.outlook.office365.com (2603:10a6:20b:e0::17) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6863.35 via Frontend Transport; Mon, 9 Oct 2023 18:22:32 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 192.176.1.74) smtp.mailfrom=ericsson.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=ericsson.com; Received-SPF: Pass (protection.outlook.com: domain of ericsson.com designates 192.176.1.74 as permitted sender) receiver=protection.outlook.com; client-ip=192.176.1.74; helo=oa.msg.ericsson.com; pr=C Received: from oa.msg.ericsson.com (192.176.1.74) by AMS1EPF0000004A.mail.protection.outlook.com (10.167.16.134) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256) id 15.20.6838.22 via Frontend Transport; Mon, 9 Oct 2023 18:22:32 +0000 Received: from SESAMB601.ericsson.se (100.87.178.23) by ESESSMB501.ericsson.se (153.88.183.162) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.2507.32; Mon, 9 Oct 2023 20:22:32 +0200 Received: from ESESBMB502.ericsson.se (153.88.183.34) by SESAMB601.ericsson.se (100.87.178.23) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256) id 15.2.1118.26; Mon, 9 Oct 2023 20:22:31 +0200 Received: from seliicinfr00050.seli.gic.ericsson.se (153.88.183.153) by smtp.internal.ericsson.com (153.88.183.185) with Microsoft SMTP Server id 15.1.2507.32 via Frontend Transport; Mon, 9 Oct 2023 20:22:31 +0200 Received: from breslau.. (seliicwb00002.seli.gic.ericsson.se [10.156.25.100]) by seliicinfr00050.seli.gic.ericsson.se (Postfix) with ESMTP id C76391C006A; Mon, 9 Oct 2023 20:22:31 +0200 (CEST) From: =?utf-8?q?Mattias_R=C3=B6nnblom?= To: , CC: Jerin Jacob , , , , Peter Nilsson , Heng Wang , "Naga Harish K S V" , Pavan Nikhilesh , Gujjar Abhinandan S , Erik Gabriel Carrillo , Shijith Thotton , "Hemant Agrawal" , Sachin Saxena , Liang Ma , Peter Mccarthy , Zhirun Yan , =?utf-8?q?Mattias_R=C3=B6nnblom?= Subject: [PATCH v6 1/3] lib: introduce dispatcher library Date: Mon, 9 Oct 2023 20:17:09 +0200 Message-ID: <20231009181711.440865-2-mattias.ronnblom@ericsson.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231009181711.440865-1-mattias.ronnblom@ericsson.com> References: <20230928073056.359356-2-mattias.ronnblom@ericsson.com> <20231009181711.440865-1-mattias.ronnblom@ericsson.com> MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: AMS1EPF0000004A:EE_|AS4PR07MB9631:EE_ X-MS-Office365-Filtering-Correlation-Id: 55cc0eda-c54b-4186-9682-08dbc8f4b435 X-LD-Processed: 92e84ceb-fbfd-47ab-be52-080c6b87953f,ExtAddr X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: ygEwKUlBHkNDJ91btohAx4xkIszqtkegQAshFT50fYsQ1smlPZXNoNABVW0fPDm202TP8Bv6gxOSV3FWex+VBrdcXWrK3nXu6jal7BLKQ7PaAX1e2NDMYygRysvNIHkcf2EsxO46Lp6u0Nj8ubrb+qFkT6Rw2kyE3NLvPg7wSIcGeuhPiwjODEgx1DTYuiRrYRJAstBVO+5MQk85KWDChjm2OI7/fNSP3jhH8titESRfvfd3gjBhl7XL6i0spZ50eh57StL+lWvrl19CQn2r+e+MdFof7EQne4VqnBeEIqyKbOyDy9K6VqnPj6AdodSkf2udMqMKZAxD/TgKAbTyX6x2RSmiKOK1ZGpPaeMRt4Vl5af3uuVVEAVmT7htB5K11gxegffwwqTAVCHvLsNeWP++SEnDvo2ovDPM6FmRkqpwLE3QyH+i2uU8Gu+zBUMCXe0CxcfzBokoit1GlKp+0HbZJZcy6Sz9QpqGth4TAw25s+00uiEThM7FMw3nI95M9DtrUErMY900y3v+Ym6sU/2hoeNgPZKK7qmI50JJIQDluAKhcW1Ra3CMgcgv8FVYr9dTHJNXtsWFVrxFpbSfRQ37Dz1tVYD9dKWj6fb8npvlNyZKONQ62q8tqng+lLmLgPkhn5bco1nSgTIpt7I/PCHKMsmYgJSz8q/ceNzQSoYVROPYuBw1ghdnDXumHgjGyVOor6uFzoINcdA5v+oSCHYL8fQYGaZJnIay8ROWs7XgrI81mcmS2pmLeQHB0opdM6HEhE+XqvO8zbsJb4PDbcA0ETqJHctP7tiIfp+F77CMJL//DHvwfEKov39aClvAIc/0jG5VkdtAAMz3vQWs8qgV4gVtMwQypcXS7dONdBc= X-Forefront-Antispam-Report: CIP:192.176.1.74; CTRY:SE; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:oa.msg.ericsson.com; PTR:office365.se.ericsson.net; CAT:NONE; SFS:(13230031)(4636009)(396003)(376002)(136003)(39860400002)(346002)(230922051799003)(82310400011)(451199024)(64100799003)(1800799009)(186009)(46966006)(40470700004)(36840700001)(40460700003)(6266002)(336012)(2616005)(26005)(1076003)(8936002)(36860700001)(8676002)(478600001)(6666004)(66574015)(47076005)(30864003)(7416002)(107886003)(83380400001)(4326008)(2906002)(54906003)(70586007)(70206006)(110136005)(41300700001)(316002)(5660300002)(82960400001)(7636003)(36756003)(82740400003)(40480700001)(86362001)(356005)(2101003); DIR:OUT; SFP:1101; X-OriginatorOrg: ericsson.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 09 Oct 2023 18:22:32.3418 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 55cc0eda-c54b-4186-9682-08dbc8f4b435 X-MS-Exchange-CrossTenant-Id: 92e84ceb-fbfd-47ab-be52-080c6b87953f X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=92e84ceb-fbfd-47ab-be52-080c6b87953f; Ip=[192.176.1.74]; Helo=[oa.msg.ericsson.com] X-MS-Exchange-CrossTenant-AuthSource: AMS1EPF0000004A.eurprd04.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: AS4PR07MB9631 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org The purpose of the dispatcher library is to help reduce coupling in an Eventdev-based DPDK application. In addition, the dispatcher also provides a convenient and flexible way for the application to use service cores for application-level processing. Signed-off-by: Mattias Rönnblom Tested-by: Peter Nilsson Reviewed-by: Heng Wang --- PATCH v6: o Use single tab as indentation for continuation lines in multiple-line function prototypes. (David Marchand) o Add dispatcher library release note. (David Marchand) o Various indentation and spelling improvements. (David Marchand) o Add direct , and includes, instead of relying on . (David Marchand) o Avoid Doxygen post annotations for struct fields. (David Marchand) PATCH v5: o Move from using an integer id to a pointer to reference a dispatcher instance, to simplify the API. o Fix bug where dispatcher stats retrieval function erroneously depended on the user-supplied stats buffer being all-zero. PATCH v4: o Fix bugs in handler and finalizer unregistration. (Naga Harish) o Return -EINVAL in cases where NULL pointers were provided in calls requiring non-NULL pointers. (Naga Harish) o Add experimental warning for the whole API. (Jerin Jacob) PATCH v3: o To underline its optional character and since it does not provide hardware abstraction, the event dispatcher is now a separate library. o Change name from rte_event_dispatcher -> rte_dispatcher, to make it shorter and to avoid the rte_event_* namespace. PATCH v2: o Add dequeue batch count statistic. o Add statistics reset function to API. o Clarify MT safety guarantees (or lack thereof) in the API documentation. o Change loop variable type in evd_lcore_get_handler_by_id() to uint16_t, to be consistent with similar loops elsewhere in the dispatcher. o Fix variable names in finalizer unregister function. PATCH: o Change prefix from RED to EVD, to avoid confusion with random early detection. RFC v4: o Move handlers to per-lcore data structures. o Introduce mechanism which rearranges handlers so that often-used handlers tend to be tried first. o Terminate dispatch loop in case all events are delivered. o To avoid the dispatcher's service function hogging the CPU, process only one batch per call. o Have service function return -EAGAIN if no work is performed. o Events delivered in the process function is no longer marked 'const', since modifying them may be useful for the application and cause no difficulties for the dispatcher. o Various minor API documentation improvements. RFC v3: o Add stats_get() function to the version.map file. --- MAINTAINERS | 4 + doc/api/doxy-api-index.md | 1 + doc/api/doxy-api.conf.in | 1 + doc/guides/rel_notes/release_23_11.rst | 5 + lib/dispatcher/meson.build | 13 + lib/dispatcher/rte_dispatcher.c | 691 +++++++++++++++++++++++++ lib/dispatcher/rte_dispatcher.h | 466 +++++++++++++++++ lib/dispatcher/version.map | 20 + lib/meson.build | 2 + 9 files changed, 1203 insertions(+) create mode 100644 lib/dispatcher/meson.build create mode 100644 lib/dispatcher/rte_dispatcher.c create mode 100644 lib/dispatcher/rte_dispatcher.h create mode 100644 lib/dispatcher/version.map diff --git a/MAINTAINERS b/MAINTAINERS index 00f5a5f9e6..a4372701c4 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1733,6 +1733,10 @@ M: Nithin Dabilpuram M: Pavan Nikhilesh F: lib/node/ +Dispatcher - EXPERIMENTAL +M: Mattias Rönnblom +F: lib/dispatcher/ + Test Applications ----------------- diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md index fdeda13932..7d0cad9fed 100644 --- a/doc/api/doxy-api-index.md +++ b/doc/api/doxy-api-index.md @@ -155,6 +155,7 @@ The public API headers are grouped by topics: - **classification** [reorder](@ref rte_reorder.h), + [dispatcher](@ref rte_dispatcher.h), [distributor](@ref rte_distributor.h), [EFD](@ref rte_efd.h), [ACL](@ref rte_acl.h), diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in index df801d32f9..93709e1d2c 100644 --- a/doc/api/doxy-api.conf.in +++ b/doc/api/doxy-api.conf.in @@ -34,6 +34,7 @@ INPUT = @TOPDIR@/doc/api/doxy-api-index.md \ @TOPDIR@/lib/cmdline \ @TOPDIR@/lib/compressdev \ @TOPDIR@/lib/cryptodev \ + @TOPDIR@/lib/dispatcher \ @TOPDIR@/lib/distributor \ @TOPDIR@/lib/dmadev \ @TOPDIR@/lib/efd \ diff --git a/doc/guides/rel_notes/release_23_11.rst b/doc/guides/rel_notes/release_23_11.rst index 9319c86cd8..b5c5073018 100644 --- a/doc/guides/rel_notes/release_23_11.rst +++ b/doc/guides/rel_notes/release_23_11.rst @@ -80,6 +80,11 @@ New Features device is different from the Tx Ethernet device with respective driver callback functions in ``rte_eth_recycle_mbufs``. +* **Added dispatcher library.** + + Added dispatcher library which purpose is to help decouple different + parts (modules) of an eventdev-based application. + * **Updated Solarflare net driver.** * Added support for transfer flow action ``INDIRECT`` with subtype ``VXLAN_ENCAP``. diff --git a/lib/dispatcher/meson.build b/lib/dispatcher/meson.build new file mode 100644 index 0000000000..ffaef26a6d --- /dev/null +++ b/lib/dispatcher/meson.build @@ -0,0 +1,13 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright(c) 2023 Ericsson AB + +if is_windows + build = false + reason = 'not supported on Windows' + subdir_done() +endif + +sources = files('rte_dispatcher.c') +headers = files('rte_dispatcher.h') + +deps += ['eventdev'] diff --git a/lib/dispatcher/rte_dispatcher.c b/lib/dispatcher/rte_dispatcher.c new file mode 100644 index 0000000000..83e80ede96 --- /dev/null +++ b/lib/dispatcher/rte_dispatcher.c @@ -0,0 +1,691 @@ +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright(c) 2023 Ericsson AB + */ + +#include +#include + +#include +#include +#include +#include +#include + +#include "eventdev_pmd.h" + +#include + +#define EVD_MAX_PORTS_PER_LCORE 4 +#define EVD_MAX_HANDLERS 32 +#define EVD_MAX_FINALIZERS 16 +#define EVD_AVG_PRIO_INTERVAL 2000 +#define EVD_SERVICE_NAME "dispatcher" + +struct rte_dispatcher_lcore_port { + uint8_t port_id; + uint16_t batch_size; + uint64_t timeout; +}; + +struct rte_dispatcher_handler { + int id; + rte_dispatcher_match_t match_fun; + void *match_data; + rte_dispatcher_process_t process_fun; + void *process_data; +}; + +struct rte_dispatcher_finalizer { + int id; + rte_dispatcher_finalize_t finalize_fun; + void *finalize_data; +}; + +struct rte_dispatcher_lcore { + uint8_t num_ports; + uint16_t num_handlers; + int32_t prio_count; + struct rte_dispatcher_lcore_port ports[EVD_MAX_PORTS_PER_LCORE]; + struct rte_dispatcher_handler handlers[EVD_MAX_HANDLERS]; + struct rte_dispatcher_stats stats; +} __rte_cache_aligned; + +struct rte_dispatcher { + uint8_t event_dev_id; + int socket_id; + uint32_t service_id; + struct rte_dispatcher_lcore lcores[RTE_MAX_LCORE]; + uint16_t num_finalizers; + struct rte_dispatcher_finalizer finalizers[EVD_MAX_FINALIZERS]; +}; + +static int +evd_lookup_handler_idx(struct rte_dispatcher_lcore *lcore, + const struct rte_event *event) +{ + uint16_t i; + + for (i = 0; i < lcore->num_handlers; i++) { + struct rte_dispatcher_handler *handler = + &lcore->handlers[i]; + + if (handler->match_fun(event, handler->match_data)) + return i; + } + + return -1; +} + +static void +evd_prioritize_handler(struct rte_dispatcher_lcore *lcore, + int handler_idx) +{ + struct rte_dispatcher_handler tmp; + + if (handler_idx == 0) + return; + + /* Let the lucky handler "bubble" up the list */ + + tmp = lcore->handlers[handler_idx - 1]; + lcore->handlers[handler_idx - 1] = lcore->handlers[handler_idx]; + lcore->handlers[handler_idx] = tmp; +} + +static inline void +evd_consider_prioritize_handler(struct rte_dispatcher_lcore *lcore, + int handler_idx, uint16_t handler_events) +{ + lcore->prio_count -= handler_events; + + if (unlikely(lcore->prio_count <= 0)) { + evd_prioritize_handler(lcore, handler_idx); + + /* + * Randomize the interval in the unlikely case + * the traffic follow some very strict pattern. + */ + lcore->prio_count = + rte_rand_max(EVD_AVG_PRIO_INTERVAL) + + EVD_AVG_PRIO_INTERVAL / 2; + } +} + +static inline void +evd_dispatch_events(struct rte_dispatcher *dispatcher, + struct rte_dispatcher_lcore *lcore, + struct rte_dispatcher_lcore_port *port, + struct rte_event *events, uint16_t num_events) +{ + int i; + struct rte_event bursts[EVD_MAX_HANDLERS][num_events]; + uint16_t burst_lens[EVD_MAX_HANDLERS] = { 0 }; + uint16_t drop_count = 0; + uint16_t dispatch_count; + uint16_t dispatched = 0; + + for (i = 0; i < num_events; i++) { + struct rte_event *event = &events[i]; + int handler_idx; + + handler_idx = evd_lookup_handler_idx(lcore, event); + + if (unlikely(handler_idx < 0)) { + drop_count++; + continue; + } + + bursts[handler_idx][burst_lens[handler_idx]] = *event; + burst_lens[handler_idx]++; + } + + dispatch_count = num_events - drop_count; + + for (i = 0; i < lcore->num_handlers && + dispatched < dispatch_count; i++) { + struct rte_dispatcher_handler *handler = + &lcore->handlers[i]; + uint16_t len = burst_lens[i]; + + if (len == 0) + continue; + + handler->process_fun(dispatcher->event_dev_id, port->port_id, + bursts[i], len, handler->process_data); + + dispatched += len; + + /* + * Safe, since any reshuffling will only involve + * already-processed handlers. + */ + evd_consider_prioritize_handler(lcore, i, len); + } + + lcore->stats.ev_batch_count++; + lcore->stats.ev_dispatch_count += dispatch_count; + lcore->stats.ev_drop_count += drop_count; + + for (i = 0; i < dispatcher->num_finalizers; i++) { + struct rte_dispatcher_finalizer *finalizer = + &dispatcher->finalizers[i]; + + finalizer->finalize_fun(dispatcher->event_dev_id, + port->port_id, + finalizer->finalize_data); + } +} + +static __rte_always_inline uint16_t +evd_port_dequeue(struct rte_dispatcher *dispatcher, + struct rte_dispatcher_lcore *lcore, + struct rte_dispatcher_lcore_port *port) +{ + uint16_t batch_size = port->batch_size; + struct rte_event events[batch_size]; + uint16_t n; + + n = rte_event_dequeue_burst(dispatcher->event_dev_id, port->port_id, + events, batch_size, port->timeout); + + if (likely(n > 0)) + evd_dispatch_events(dispatcher, lcore, port, events, n); + + lcore->stats.poll_count++; + + return n; +} + +static __rte_always_inline uint16_t +evd_lcore_process(struct rte_dispatcher *dispatcher, + struct rte_dispatcher_lcore *lcore) +{ + uint16_t i; + uint16_t event_count = 0; + + for (i = 0; i < lcore->num_ports; i++) { + struct rte_dispatcher_lcore_port *port = + &lcore->ports[i]; + + event_count += evd_port_dequeue(dispatcher, lcore, port); + } + + return event_count; +} + +static int32_t +evd_process(void *userdata) +{ + struct rte_dispatcher *dispatcher = userdata; + unsigned int lcore_id = rte_lcore_id(); + struct rte_dispatcher_lcore *lcore = + &dispatcher->lcores[lcore_id]; + uint64_t event_count; + + event_count = evd_lcore_process(dispatcher, lcore); + + if (unlikely(event_count == 0)) + return -EAGAIN; + + return 0; +} + +static int +evd_service_register(struct rte_dispatcher *dispatcher) +{ + struct rte_service_spec service = { + .callback = evd_process, + .callback_userdata = dispatcher, + .capabilities = RTE_SERVICE_CAP_MT_SAFE, + .socket_id = dispatcher->socket_id + }; + int rc; + + snprintf(service.name, sizeof(service.name), EVD_SERVICE_NAME); + + rc = rte_service_component_register(&service, &dispatcher->service_id); + if (rc != 0) + RTE_EDEV_LOG_ERR("Registration of dispatcher service " + "%s failed with error code %d\n", + service.name, rc); + + return rc; +} + +static int +evd_service_unregister(struct rte_dispatcher *dispatcher) +{ + int rc; + + rc = rte_service_component_unregister(dispatcher->service_id); + if (rc != 0) + RTE_EDEV_LOG_ERR("Unregistration of dispatcher service " + "failed with error code %d\n", rc); + + return rc; +} + +struct rte_dispatcher * +rte_dispatcher_create(uint8_t event_dev_id) +{ + int socket_id; + struct rte_dispatcher *dispatcher; + int rc; + + socket_id = rte_event_dev_socket_id(event_dev_id); + + dispatcher = + rte_malloc_socket("dispatcher", sizeof(struct rte_dispatcher), + RTE_CACHE_LINE_SIZE, socket_id); + + if (dispatcher == NULL) { + RTE_EDEV_LOG_ERR("Unable to allocate memory for dispatcher\n"); + rte_errno = ENOMEM; + return NULL; + } + + *dispatcher = (struct rte_dispatcher) { + .event_dev_id = event_dev_id, + .socket_id = socket_id + }; + + rc = evd_service_register(dispatcher); + if (rc < 0) { + rte_free(dispatcher); + rte_errno = -rc; + return NULL; + } + + return dispatcher; +} + +int +rte_dispatcher_free(struct rte_dispatcher *dispatcher) +{ + int rc; + + if (dispatcher == NULL) + return 0; + + rc = evd_service_unregister(dispatcher); + if (rc != 0) + return rc; + + rte_free(dispatcher); + + return 0; +} + +uint32_t +rte_dispatcher_service_id_get(const struct rte_dispatcher *dispatcher) +{ + return dispatcher->service_id; +} + +static int +lcore_port_index(struct rte_dispatcher_lcore *lcore, + uint8_t event_port_id) +{ + uint16_t i; + + for (i = 0; i < lcore->num_ports; i++) { + struct rte_dispatcher_lcore_port *port = + &lcore->ports[i]; + + if (port->port_id == event_port_id) + return i; + } + + return -1; +} + +int +rte_dispatcher_bind_port_to_lcore(struct rte_dispatcher *dispatcher, + uint8_t event_port_id, uint16_t batch_size, uint64_t timeout, + unsigned int lcore_id) +{ + struct rte_dispatcher_lcore *lcore; + struct rte_dispatcher_lcore_port *port; + + lcore = &dispatcher->lcores[lcore_id]; + + if (lcore->num_ports == EVD_MAX_PORTS_PER_LCORE) + return -ENOMEM; + + if (lcore_port_index(lcore, event_port_id) >= 0) + return -EEXIST; + + port = &lcore->ports[lcore->num_ports]; + + *port = (struct rte_dispatcher_lcore_port) { + .port_id = event_port_id, + .batch_size = batch_size, + .timeout = timeout + }; + + lcore->num_ports++; + + return 0; +} + +int +rte_dispatcher_unbind_port_from_lcore(struct rte_dispatcher *dispatcher, + uint8_t event_port_id, unsigned int lcore_id) +{ + struct rte_dispatcher_lcore *lcore; + int port_idx; + struct rte_dispatcher_lcore_port *port; + struct rte_dispatcher_lcore_port *last; + + lcore = &dispatcher->lcores[lcore_id]; + + port_idx = lcore_port_index(lcore, event_port_id); + + if (port_idx < 0) + return -ENOENT; + + port = &lcore->ports[port_idx]; + last = &lcore->ports[lcore->num_ports - 1]; + + if (port != last) + *port = *last; + + lcore->num_ports--; + + return 0; +} + +static struct rte_dispatcher_handler * +evd_lcore_get_handler_by_id(struct rte_dispatcher_lcore *lcore, int handler_id) +{ + uint16_t i; + + for (i = 0; i < lcore->num_handlers; i++) { + struct rte_dispatcher_handler *handler = + &lcore->handlers[i]; + + if (handler->id == handler_id) + return handler; + } + + return NULL; +} + +static int +evd_alloc_handler_id(struct rte_dispatcher *dispatcher) +{ + int handler_id = 0; + struct rte_dispatcher_lcore *reference_lcore = + &dispatcher->lcores[0]; + + if (reference_lcore->num_handlers == EVD_MAX_HANDLERS) + return -1; + + while (evd_lcore_get_handler_by_id(reference_lcore, handler_id) != NULL) + handler_id++; + + return handler_id; +} + +static void +evd_lcore_install_handler(struct rte_dispatcher_lcore *lcore, + const struct rte_dispatcher_handler *handler) +{ + int handler_idx = lcore->num_handlers; + + lcore->handlers[handler_idx] = *handler; + lcore->num_handlers++; +} + +static void +evd_install_handler(struct rte_dispatcher *dispatcher, + const struct rte_dispatcher_handler *handler) +{ + int i; + + for (i = 0; i < RTE_MAX_LCORE; i++) { + struct rte_dispatcher_lcore *lcore = + &dispatcher->lcores[i]; + evd_lcore_install_handler(lcore, handler); + } +} + +int +rte_dispatcher_register(struct rte_dispatcher *dispatcher, + rte_dispatcher_match_t match_fun, void *match_data, + rte_dispatcher_process_t process_fun, void *process_data) +{ + struct rte_dispatcher_handler handler = { + .match_fun = match_fun, + .match_data = match_data, + .process_fun = process_fun, + .process_data = process_data + }; + + handler.id = evd_alloc_handler_id(dispatcher); + + if (handler.id < 0) + return -ENOMEM; + + evd_install_handler(dispatcher, &handler); + + return handler.id; +} + +static int +evd_lcore_uninstall_handler(struct rte_dispatcher_lcore *lcore, + int handler_id) +{ + struct rte_dispatcher_handler *unreg_handler; + int handler_idx; + uint16_t last_idx; + + unreg_handler = evd_lcore_get_handler_by_id(lcore, handler_id); + + if (unreg_handler == NULL) { + RTE_EDEV_LOG_ERR("Invalid handler id %d\n", handler_id); + return -EINVAL; + } + + handler_idx = unreg_handler - &lcore->handlers[0]; + + last_idx = lcore->num_handlers - 1; + + if (handler_idx != last_idx) { + /* move all handlers to maintain handler order */ + int n = last_idx - handler_idx; + memmove(unreg_handler, unreg_handler + 1, + sizeof(struct rte_dispatcher_handler) * n); + } + + lcore->num_handlers--; + + return 0; +} + +static int +evd_uninstall_handler(struct rte_dispatcher *dispatcher, int handler_id) +{ + unsigned int lcore_id; + + for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) { + struct rte_dispatcher_lcore *lcore = + &dispatcher->lcores[lcore_id]; + int rc; + + rc = evd_lcore_uninstall_handler(lcore, handler_id); + if (rc < 0) + return rc; + } + + return 0; +} + +int +rte_dispatcher_unregister(struct rte_dispatcher *dispatcher, int handler_id) +{ + return evd_uninstall_handler(dispatcher, handler_id); +} + +static struct rte_dispatcher_finalizer * +evd_get_finalizer_by_id(struct rte_dispatcher *dispatcher, + int handler_id) +{ + int i; + + for (i = 0; i < dispatcher->num_finalizers; i++) { + struct rte_dispatcher_finalizer *finalizer = + &dispatcher->finalizers[i]; + + if (finalizer->id == handler_id) + return finalizer; + } + + return NULL; +} + +static int +evd_alloc_finalizer_id(struct rte_dispatcher *dispatcher) +{ + int finalizer_id = 0; + + while (evd_get_finalizer_by_id(dispatcher, finalizer_id) != NULL) + finalizer_id++; + + return finalizer_id; +} + +static struct rte_dispatcher_finalizer * +evd_alloc_finalizer(struct rte_dispatcher *dispatcher) +{ + int finalizer_idx; + struct rte_dispatcher_finalizer *finalizer; + + if (dispatcher->num_finalizers == EVD_MAX_FINALIZERS) + return NULL; + + finalizer_idx = dispatcher->num_finalizers; + finalizer = &dispatcher->finalizers[finalizer_idx]; + + finalizer->id = evd_alloc_finalizer_id(dispatcher); + + dispatcher->num_finalizers++; + + return finalizer; +} + +int +rte_dispatcher_finalize_register(struct rte_dispatcher *dispatcher, + rte_dispatcher_finalize_t finalize_fun, void *finalize_data) +{ + struct rte_dispatcher_finalizer *finalizer; + + finalizer = evd_alloc_finalizer(dispatcher); + + if (finalizer == NULL) + return -ENOMEM; + + finalizer->finalize_fun = finalize_fun; + finalizer->finalize_data = finalize_data; + + return finalizer->id; +} + +int +rte_dispatcher_finalize_unregister(struct rte_dispatcher *dispatcher, + int finalizer_id) +{ + struct rte_dispatcher_finalizer *unreg_finalizer; + int finalizer_idx; + uint16_t last_idx; + + unreg_finalizer = evd_get_finalizer_by_id(dispatcher, finalizer_id); + + if (unreg_finalizer == NULL) { + RTE_EDEV_LOG_ERR("Invalid finalizer id %d\n", finalizer_id); + return -EINVAL; + } + + finalizer_idx = unreg_finalizer - &dispatcher->finalizers[0]; + + last_idx = dispatcher->num_finalizers - 1; + + if (finalizer_idx != last_idx) { + /* move all finalizers to maintain order */ + int n = last_idx - finalizer_idx; + memmove(unreg_finalizer, unreg_finalizer + 1, + sizeof(struct rte_dispatcher_finalizer) * n); + } + + dispatcher->num_finalizers--; + + return 0; +} + +static int +evd_set_service_runstate(struct rte_dispatcher *dispatcher, int state) +{ + int rc; + + rc = rte_service_component_runstate_set(dispatcher->service_id, + state); + if (rc != 0) { + RTE_EDEV_LOG_ERR("Unexpected error %d occurred while setting " + "service component run state to %d\n", rc, + state); + RTE_ASSERT(0); + } + + return 0; +} + +int +rte_dispatcher_start(struct rte_dispatcher *dispatcher) +{ + return evd_set_service_runstate(dispatcher, 1); +} + +int +rte_dispatcher_stop(struct rte_dispatcher *dispatcher) +{ + return evd_set_service_runstate(dispatcher, 0); +} + +static void +evd_aggregate_stats(struct rte_dispatcher_stats *result, + const struct rte_dispatcher_stats *part) +{ + result->poll_count += part->poll_count; + result->ev_batch_count += part->ev_batch_count; + result->ev_dispatch_count += part->ev_dispatch_count; + result->ev_drop_count += part->ev_drop_count; +} + +void +rte_dispatcher_stats_get(const struct rte_dispatcher *dispatcher, + struct rte_dispatcher_stats *stats) +{ + unsigned int lcore_id; + + *stats = (struct rte_dispatcher_stats) {}; + + for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) { + const struct rte_dispatcher_lcore *lcore = + &dispatcher->lcores[lcore_id]; + + evd_aggregate_stats(stats, &lcore->stats); + } +} + +void +rte_dispatcher_stats_reset(struct rte_dispatcher *dispatcher) +{ + unsigned int lcore_id; + + for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) { + struct rte_dispatcher_lcore *lcore = + &dispatcher->lcores[lcore_id]; + + lcore->stats = (struct rte_dispatcher_stats) {}; + } +} diff --git a/lib/dispatcher/rte_dispatcher.h b/lib/dispatcher/rte_dispatcher.h new file mode 100644 index 0000000000..1f2faaaee8 --- /dev/null +++ b/lib/dispatcher/rte_dispatcher.h @@ -0,0 +1,466 @@ +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright(c) 2023 Ericsson AB + */ + +#ifndef __RTE_DISPATCHER_H__ +#define __RTE_DISPATCHER_H__ + +/** + * @file + * + * RTE Dispatcher + * + * @warning + * @b EXPERIMENTAL: + * All functions in this file may be changed or removed without prior notice. + * + * The purpose of the dispatcher is to help decouple different parts + * of an application (e.g., modules), sharing the same underlying + * event device. + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#include +#include +#include + +/** + * Function prototype for match callbacks. + * + * Match callbacks are used by an application to decide how the + * dispatcher distributes events to different parts of the + * application. + * + * The application is not expected to process the event at the point + * of the match call. Such matters should be deferred to the process + * callback invocation. + * + * The match callback may be used as an opportunity to prefetch data. + * + * @param event + * Pointer to event + * + * @param cb_data + * The pointer supplied by the application in + * rte_dispatcher_register(). + * + * @return + * Returns true in case this event should be delivered (via + * the process callback), and false otherwise. + */ +typedef bool +(*rte_dispatcher_match_t)(const struct rte_event *event, void *cb_data); + +/** + * Function prototype for process callbacks. + * + * The process callbacks are used by the dispatcher to deliver + * events for processing. + * + * @param event_dev_id + * The originating event device id. + * + * @param event_port_id + * The originating event port. + * + * @param events + * Pointer to an array of events. + * + * @param num + * The number of events in the @p events array. + * + * @param cb_data + * The pointer supplied by the application in + * rte_dispatcher_register(). + */ + +typedef void +(*rte_dispatcher_process_t)(uint8_t event_dev_id, uint8_t event_port_id, + struct rte_event *events, uint16_t num, void *cb_data); + +/** + * Function prototype for finalize callbacks. + * + * The finalize callbacks are used by the dispatcher to notify the + * application it has delivered all events from a particular batch + * dequeued from the event device. + * + * @param event_dev_id + * The originating event device id. + * + * @param event_port_id + * The originating event port. + * + * @param cb_data + * The pointer supplied by the application in + * rte_dispatcher_finalize_register(). + */ + +typedef void +(*rte_dispatcher_finalize_t)(uint8_t event_dev_id, uint8_t event_port_id, + void *cb_data); + +/** + * Dispatcher statistics + */ +struct rte_dispatcher_stats { + /** Number of event dequeue calls made toward the event device. */ + uint64_t poll_count; + /** Number of non-empty event batches dequeued from event device.*/ + uint64_t ev_batch_count; + /** Number of events dispatched to a handler.*/ + uint64_t ev_dispatch_count; + /** Number of events dropped because no handler was found. */ + uint64_t ev_drop_count; +}; + +/** + * Create a dispatcher with the specified id. + * + * @param event_dev_id + * The identifier of the event device from which this dispatcher + * will dequeue events. + * + * @return + * A pointer to a new dispatcher instance, or NULL on failure, in which + * case rte_errno is set. + */ +__rte_experimental +struct rte_dispatcher * +rte_dispatcher_create(uint8_t event_dev_id); + +/** + * Free a dispatcher. + * + * @param dispatcher + * The dispatcher instance. + * + * @return + * - 0: Success + * - <0: Error code on failure + */ +__rte_experimental +int +rte_dispatcher_free(struct rte_dispatcher *dispatcher); + +/** + * Retrieve the service identifier of a dispatcher. + * + * @param dispatcher + * The dispatcher instance. + * + * @return + * The dispatcher service's id. + */ +__rte_experimental +uint32_t +rte_dispatcher_service_id_get(const struct rte_dispatcher *dispatcher); + +/** + * Binds an event device port to a specific lcore on the specified + * dispatcher. + * + * This function configures the event port id to be used by the event + * dispatcher service, if run on the specified lcore. + * + * Multiple event device ports may be bound to the same lcore. A + * particular port must not be bound to more than one lcore. + * + * If the dispatcher service is mapped (with rte_service_map_lcore_set()) + * to a lcore to which no ports are bound, the service function will be a + * no-operation. + * + * This function may be called by any thread (including unregistered + * non-EAL threads), but not while the dispatcher is running on lcore + * specified by @c lcore_id. + * + * @param dispatcher + * The dispatcher instance. + * + * @param event_port_id + * The event device port identifier. + * + * @param batch_size + * The batch size to use in rte_event_dequeue_burst(), for the + * configured event device port and lcore. + * + * @param timeout + * The timeout parameter to use in rte_event_dequeue_burst(), for the + * configured event device port and lcore. + * + * @param lcore_id + * The lcore by which this event port will be used. + * + * @return + * - 0: Success + * - -ENOMEM: Unable to allocate sufficient resources. + * - -EEXISTS: Event port is already configured. + * - -EINVAL: Invalid arguments. + */ +__rte_experimental +int +rte_dispatcher_bind_port_to_lcore(struct rte_dispatcher *dispatcher, + uint8_t event_port_id, uint16_t batch_size, uint64_t timeout, + unsigned int lcore_id); + +/** + * Unbind an event device port from a specific lcore. + * + * This function may be called by any thread (including unregistered + * non-EAL threads), but not while the dispatcher is running on + * lcore specified by @c lcore_id. + * + * @param dispatcher + * The dispatcher instance. + * + * @param event_port_id + * The event device port identifier. + * + * @param lcore_id + * The lcore which was using this event port. + * + * @return + * - 0: Success + * - -ENOENT: Event port id not bound to this @c lcore_id. + */ +__rte_experimental +int +rte_dispatcher_unbind_port_from_lcore(struct rte_dispatcher *dispatcher, + uint8_t event_port_id, unsigned int lcore_id); + +/** + * Register an event handler. + * + * The match callback function is used to select if a particular event + * should be delivered, using the corresponding process callback + * function. + * + * The reason for having two distinct steps is to allow the dispatcher + * to deliver all events as a batch. This in turn will cause + * processing of a particular kind of events to happen in a + * back-to-back manner, improving cache locality. + * + * The list of handler callback functions is shared among all lcores, + * but will only be executed on lcores which has an eventdev port + * bound to them, and which are running the dispatcher service. + * + * An event is delivered to at most one handler. Events where no + * handler is found are dropped. + * + * The application must not depend on the order of which the match + * functions are invoked. + * + * Ordering of events is not guaranteed to be maintained between + * different deliver callbacks. For example, suppose there are two + * callbacks registered, matching different subsets of events arriving + * on an atomic queue. A batch of events [ev0, ev1, ev2] are dequeued + * on a particular port, all pertaining to the same flow. The match + * callback for registration A returns true for ev0 and ev2, and the + * matching function for registration B for ev1. In that scenario, the + * dispatcher may choose to deliver first [ev0, ev2] using A's deliver + * function, and then [ev1] to B - or vice versa. + * + * rte_dispatcher_register() may be called by any thread + * (including unregistered non-EAL threads), but not while the event + * dispatcher is running on any service lcore. + * + * @param dispatcher + * The dispatcher instance. + * + * @param match_fun + * The match callback function. + * + * @param match_cb_data + * A pointer to some application-specific opaque data (or NULL), + * which is supplied back to the application when match_fun is + * called. + * + * @param process_fun + * The process callback function. + * + * @param process_cb_data + * A pointer to some application-specific opaque data (or NULL), + * which is supplied back to the application when process_fun is + * called. + * + * @return + * - >= 0: The identifier for this registration. + * - -ENOMEM: Unable to allocate sufficient resources. + */ +__rte_experimental +int +rte_dispatcher_register(struct rte_dispatcher *dispatcher, + rte_dispatcher_match_t match_fun, void *match_cb_data, + rte_dispatcher_process_t process_fun, void *process_cb_data); + +/** + * Unregister an event handler. + * + * This function may be called by any thread (including unregistered + * non-EAL threads), but not while the dispatcher is running on + * any service lcore. + * + * @param dispatcher + * The dispatcher instance. + * + * @param handler_id + * The handler registration id returned by the original + * rte_dispatcher_register() call. + * + * @return + * - 0: Success + * - -EINVAL: The @c handler_id parameter was invalid. + */ +__rte_experimental +int +rte_dispatcher_unregister(struct rte_dispatcher *dispatcher, int handler_id); + +/** + * Register a finalize callback function. + * + * An application may optionally install one or more finalize + * callbacks. + * + * All finalize callbacks are invoked by the dispatcher when a + * complete batch of events (retrieve using rte_event_dequeue_burst()) + * have been delivered to the application (or have been dropped). + * + * The finalize callback is not tied to any particular handler. + * + * The finalize callback provides an opportunity for the application + * to do per-batch processing. One case where this may be useful is if + * an event output buffer is used, and is shared among several + * handlers. In such a case, proper output buffer flushing may be + * assured using a finalize callback. + * + * rte_dispatcher_finalize_register() may be called by any thread + * (including unregistered non-EAL threads), but not while the + * dispatcher is running on any service lcore. + * + * @param dispatcher + * The dispatcher instance. + * + * @param finalize_fun + * The function called after completing the processing of a + * dequeue batch. + * + * @param finalize_data + * A pointer to some application-specific opaque data (or NULL), + * which is supplied back to the application when @c finalize_fun is + * called. + * + * @return + * - >= 0: The identifier for this registration. + * - -ENOMEM: Unable to allocate sufficient resources. + */ +__rte_experimental +int +rte_dispatcher_finalize_register(struct rte_dispatcher *dispatcher, + rte_dispatcher_finalize_t finalize_fun, void *finalize_data); + +/** + * Unregister a finalize callback. + * + * This function may be called by any thread (including unregistered + * non-EAL threads), but not while the dispatcher is running on + * any service lcore. + * + * @param dispatcher + * The dispatcher instance. + * + * @param reg_id + * The finalize registration id returned by the original + * rte_dispatcher_finalize_register() call. + * + * @return + * - 0: Success + * - -EINVAL: The @c reg_id parameter was invalid. + */ +__rte_experimental +int +rte_dispatcher_finalize_unregister(struct rte_dispatcher *dispatcher, int reg_id); + +/** + * Start a dispatcher instance. + * + * Enables the dispatcher service. + * + * The underlying event device must have been started prior to calling + * rte_dispatcher_start(). + * + * For the dispatcher to actually perform work (i.e., dispatch + * events), its service must have been mapped to one or more service + * lcores, and its service run state set to '1'. A dispatcher's + * service is retrieved using rte_dispatcher_service_id_get(). + * + * Each service lcore to which the dispatcher is mapped should + * have at least one event port configured. Such configuration is + * performed by calling rte_dispatcher_bind_port_to_lcore(), prior to + * starting the dispatcher. + * + * @param dispatcher + * The dispatcher instance. + * + * @return + * - 0: Success + * - <0: Error code on failure + */ +__rte_experimental +int +rte_dispatcher_start(struct rte_dispatcher *dispatcher); + +/** + * Stop a running dispatcher instance. + * + * Disables the dispatcher service. + * + * @param dispatcher + * The dispatcher instance. + * + * @return + * - 0: Success + * - -EINVAL: Invalid @c id. + */ +__rte_experimental +int +rte_dispatcher_stop(struct rte_dispatcher *dispatcher); + +/** + * Retrieve statistics for a dispatcher instance. + * + * This function is MT safe and may be called by any thread + * (including unregistered non-EAL threads). + * + * @param dispatcher + * The dispatcher instance. + * @param[out] stats + * A pointer to a structure to fill with statistics. + */ +__rte_experimental +void +rte_dispatcher_stats_get(const struct rte_dispatcher *dispatcher, + struct rte_dispatcher_stats *stats); + +/** + * Reset statistics for a dispatcher instance. + * + * This function may be called by any thread (including unregistered + * non-EAL threads), but may not produce the correct result if the + * dispatcher is running on any service lcore. + * + * @param dispatcher + * The dispatcher instance. + */ +__rte_experimental +void +rte_dispatcher_stats_reset(struct rte_dispatcher *dispatcher); + +#ifdef __cplusplus +} +#endif + +#endif /* __RTE_DISPATCHER__ */ diff --git a/lib/dispatcher/version.map b/lib/dispatcher/version.map new file mode 100644 index 0000000000..44585e4f15 --- /dev/null +++ b/lib/dispatcher/version.map @@ -0,0 +1,20 @@ +EXPERIMENTAL { + global: + + # added in 23.11 + rte_dispatcher_bind_port_to_lcore; + rte_dispatcher_create; + rte_dispatcher_finalize_register; + rte_dispatcher_finalize_unregister; + rte_dispatcher_free; + rte_dispatcher_register; + rte_dispatcher_service_id_get; + rte_dispatcher_start; + rte_dispatcher_stats_get; + rte_dispatcher_stats_reset; + rte_dispatcher_stop; + rte_dispatcher_unbind_port_from_lcore; + rte_dispatcher_unregister; + + local: *; +}; diff --git a/lib/meson.build b/lib/meson.build index cf4aa63630..59d381bf7a 100644 --- a/lib/meson.build +++ b/lib/meson.build @@ -35,6 +35,7 @@ libraries = [ 'distributor', 'efd', 'eventdev', + 'dispatcher', # dispatcher depends on eventdev 'gpudev', 'gro', 'gso', @@ -81,6 +82,7 @@ optional_libs = [ 'cfgfile', 'compressdev', 'cryptodev', + 'dispatcher', 'distributor', 'dmadev', 'efd', From patchwork Mon Oct 9 18:17:10 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Mattias_R=C3=B6nnblom?= X-Patchwork-Id: 132448 X-Patchwork-Delegate: david.marchand@redhat.com Return-Path: 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]) by inbox.dpdk.org (Postfix) with ESMTP id B3F2542340; Mon, 9 Oct 2023 20:22:59 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 18D1A40E25; Mon, 9 Oct 2023 20:22:40 +0200 (CEST) Received: from EUR05-VI1-obe.outbound.protection.outlook.com (mail-vi1eur05on2088.outbound.protection.outlook.com [40.107.21.88]) by mails.dpdk.org (Postfix) with ESMTP id 07FEE4069D; Mon, 9 Oct 2023 20:22:38 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=h4zi4YvZESHFXJR3u31o4VdTrMruKtBjXwiTds0uBLNo1hTnq5DjvPjaMZe6PxzX//4fduFmkY1Zo0J2MwpXMqFvnSuxE5zag6E1eAaaGV/LlSDv0rsxfzT8ijP4GmGX2lX2d13qbRc+/pb97U/n1dAy8bkfKkHOKymhsB/n5aNjfq5I/SBgwJtRdSRQSRDuxxZpnF4TxppAuG1VgMIkzU1zKPZaJEc0cjqFAWBzdwDf13DBrgdnh/MTCdwcTYhETRNnub+Q03MGB+rasjw25M7A1PC1AwewmaMEgmiJzkL8rr3uOXrAb/Y4tt95USP/BYrS7BSaJvYIEXLyiJXpbA== 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-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=3jWZy6dSc8AqC2LJmC/xWJ4f87TihBjmw7QKEf03bZA=; b=I4+DoBst3eU98tldnTMgeNcV7x7j34WTgp1WdTDVEgwitdfOw916gfDh/ynszoov36zGEeZ7qbVYskl+5Zv1w8CXC/2h/p35d6rJBdupS0pRvscj4QR2MHDRrnhoI+3oAWRn8dDVpMt36nHmIpsJoIuas084n4sW6nFh7baakMx4M/qxUJKk4xoKEd4n9w9IDeZHGzP6qZZ5KjupyTUgVVherpjm7bT2lljE8QIpsctgE7ZsXym6fCW5wBAGiDbQrPkh2gL/0tOwQ5QYlfUiMrUQ7mpeqPXSDG3vZWEx/0AR/C4WW4JylYEP/MykUkxX+T2qQZkdFMc65ZZcNC90Qw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 192.176.1.74) smtp.rcpttodomain=dpdk.org smtp.mailfrom=ericsson.com; dmarc=pass (p=reject sp=reject pct=100) action=none header.from=ericsson.com; dkim=none (message not signed); arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ericsson.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=3jWZy6dSc8AqC2LJmC/xWJ4f87TihBjmw7QKEf03bZA=; b=rl9iBLTCEehur9KeH6p08qxBcSCpyIJ/Ux2BXY+yVg8V0AVK+aH0Jv59wvTnJSJeQLup180SSfPL6wlu4B5Gi1dFhLEGt4yxsAwYKWCor2oAtkfihs16y4hobi6piKcVO7ZlNMxDtixOmhj7X/BwmXpkdrZkjfT+yJLvoerqEbU= Received: from AM0PR01CA0158.eurprd01.prod.exchangelabs.com (2603:10a6:208:aa::27) by AM9PR07MB7108.eurprd07.prod.outlook.com (2603:10a6:20b:2ca::16) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6863.37; Mon, 9 Oct 2023 18:22:34 +0000 Received: from AM4PEPF00025F96.EURPRD83.prod.outlook.com (2603:10a6:208:aa:cafe::65) by AM0PR01CA0158.outlook.office365.com (2603:10a6:208:aa::27) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6863.36 via Frontend Transport; Mon, 9 Oct 2023 18:22:34 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 192.176.1.74) smtp.mailfrom=ericsson.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=ericsson.com; Received-SPF: Pass (protection.outlook.com: domain of ericsson.com designates 192.176.1.74 as permitted sender) receiver=protection.outlook.com; client-ip=192.176.1.74; helo=oa.msg.ericsson.com; pr=C Received: from oa.msg.ericsson.com (192.176.1.74) by AM4PEPF00025F96.mail.protection.outlook.com (10.167.16.5) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256) id 15.20.6907.2 via Frontend Transport; Mon, 9 Oct 2023 18:22:33 +0000 Received: from ESESBMB505.ericsson.se (153.88.183.172) by ESESBMB503.ericsson.se (153.88.183.170) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.2507.32; Mon, 9 Oct 2023 20:22:32 +0200 Received: from seliicinfr00050.seli.gic.ericsson.se (153.88.183.153) by smtp.internal.ericsson.com (153.88.183.188) with Microsoft SMTP Server id 15.1.2507.32 via Frontend Transport; Mon, 9 Oct 2023 20:22:32 +0200 Received: from breslau.. (seliicwb00002.seli.gic.ericsson.se [10.156.25.100]) by seliicinfr00050.seli.gic.ericsson.se (Postfix) with ESMTP id A77B91C006B; Mon, 9 Oct 2023 20:22:32 +0200 (CEST) From: =?utf-8?q?Mattias_R=C3=B6nnblom?= To: , CC: Jerin Jacob , , , , Peter Nilsson , Heng Wang , "Naga Harish K S V" , Pavan Nikhilesh , Gujjar Abhinandan S , Erik Gabriel Carrillo , Shijith Thotton , "Hemant Agrawal" , Sachin Saxena , Liang Ma , Peter Mccarthy , Zhirun Yan , =?utf-8?q?Mattias_R=C3=B6nnblom?= Subject: [PATCH v6 2/3] test: add dispatcher test suite Date: Mon, 9 Oct 2023 20:17:10 +0200 Message-ID: <20231009181711.440865-3-mattias.ronnblom@ericsson.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231009181711.440865-1-mattias.ronnblom@ericsson.com> References: <20230928073056.359356-2-mattias.ronnblom@ericsson.com> <20231009181711.440865-1-mattias.ronnblom@ericsson.com> MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: AM4PEPF00025F96:EE_|AM9PR07MB7108:EE_ X-MS-Office365-Filtering-Correlation-Id: 8be48adf-bc1f-43c7-afa6-08dbc8f4b503 X-LD-Processed: 92e84ceb-fbfd-47ab-be52-080c6b87953f,ExtAddr X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: 53AE56dlIHC8dirw5IarjsEtcfZKDC6eNggOIsdv457MAP8HFOdeOlX7qWGR3ldvQwH+OlKZlrnMskRS04AzpxIc9fPoYbr35Fb/b9/C2CXN2wyQDTMFlMXz/wE0VdF32lUqxKU8RNeFBS4z77A5r8zd1VSVsmqwOAX//GnOvGgcEGxhLxkhmst4ZHgpoDK4yXSJnhapp9j5E6A7J+DQzW1ICBFqqOP1BjyGKnDhATaqjcVNTjr9MqcyxtcyRTu9K/KNU2lPGfIDtPoR6HDVWeDhfFcxt7NCezJn9NoHSUplq29iStrFU83STxfEwHVyI290dhU87DomMjaCn50Bv3+6u4GSzz6bMMpcGMP9gBnWoX4MDqfieHFv2iFKgmlbSf2e/QVUhRbX767FDG8jsKcgHQzbFhZ9hTI91RhuhnltquFNANSGeljOH5Uf7ymDvxJCeIDSQIPGkEc/ttCPiwisULFzhdzPSuZjHk8r5rEf79DqW7bRAc1NP+INsIAGgavwsNh/A3DfkxxDhMuO85at+kUYloXr3TAYlE1JMCZbOdOkKL0YL5wMSkLsmlsgngdXiVIciWxzzCn6kIa/D5qJHCoORqcGpD8foxwzcTTcp9kpiAv+ET5dC7ZHMhOaBHMrYsBk+TneL0+XYWfUGXDrDACttOnGUNOJwR9b1HFFpG+6i1DgYDjD47r6ASniUfCm/RSZGL7jln7sCc2axOYqMVj29xaCTaFy8h+8nHOGidgFX7lqp0qpdleXIJhmaV9xtVmQ68UL9k2UEZdAd0MEA87RgQmy4q2FTB9lrsJCB60m4QrSgndtSfKiXtwkvxAPdUSZ7DDWKD8ZUC49E2bzhe+zLF4C4ftKQ26Ogo4= X-Forefront-Antispam-Report: CIP:192.176.1.74; CTRY:SE; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:oa.msg.ericsson.com; PTR:office365.se.ericsson.net; CAT:NONE; SFS:(13230031)(4636009)(396003)(346002)(39860400002)(136003)(376002)(230922051799003)(451199024)(186009)(64100799003)(1800799009)(82310400011)(40470700004)(46966006)(36840700001)(6666004)(107886003)(2616005)(1076003)(40460700003)(82740400003)(86362001)(40480700001)(7636003)(356005)(36756003)(82960400001)(36860700001)(83380400001)(6266002)(47076005)(336012)(7416002)(2906002)(66574015)(30864003)(478600001)(41300700001)(26005)(8936002)(8676002)(4326008)(316002)(5660300002)(110136005)(70586007)(54906003)(70206006)(2101003); DIR:OUT; SFP:1101; X-OriginatorOrg: ericsson.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 09 Oct 2023 18:22:33.6925 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 8be48adf-bc1f-43c7-afa6-08dbc8f4b503 X-MS-Exchange-CrossTenant-Id: 92e84ceb-fbfd-47ab-be52-080c6b87953f X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=92e84ceb-fbfd-47ab-be52-080c6b87953f; Ip=[192.176.1.74]; Helo=[oa.msg.ericsson.com] X-MS-Exchange-CrossTenant-AuthSource: AM4PEPF00025F96.EURPRD83.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM9PR07MB7108 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Add unit tests for the dispatcher. --- PATCH v6: o Register test as "fast". (David Marchand) o Use single tab as indentation for continuation lines in multiple-line function prototypes. (David Marchand) o Add Signed-off-by line. (David Marchand) o Use DPDK atomics wrapper API instead of C11 atomics. PATCH v5: o Update test suite to use pointer and not integer id when calling dispatcher functions. PATCH v3: o Adapt the test suite to dispatcher API name changes. PATCH v2: o Test finalize callback functionality. o Test handler and finalizer count upper limits. o Add statistics reset test. o Make sure dispatcher supply the proper event dev id and port id back to the application. PATCH: o Extend test to cover often-used handler optimization feature. RFC v4: o Adapt to non-const events in process function prototype. Signed-off-by: Mattias Rönnblom --- MAINTAINERS | 1 + app/test/meson.build | 1 + app/test/test_dispatcher.c | 1050 ++++++++++++++++++++++++++++++++++++ 3 files changed, 1052 insertions(+) create mode 100644 app/test/test_dispatcher.c diff --git a/MAINTAINERS b/MAINTAINERS index a4372701c4..262401d43d 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1736,6 +1736,7 @@ F: lib/node/ Dispatcher - EXPERIMENTAL M: Mattias Rönnblom F: lib/dispatcher/ +F: app/test/test_dispatcher.c Test Applications diff --git a/app/test/meson.build b/app/test/meson.build index bf9fc90612..ace10327f8 100644 --- a/app/test/meson.build +++ b/app/test/meson.build @@ -59,6 +59,7 @@ source_file_deps = { 'test_cycles.c': [], 'test_debug.c': [], 'test_devargs.c': ['kvargs'], + 'test_dispatcher.c': ['dispatcher'], 'test_distributor.c': ['distributor'], 'test_distributor_perf.c': ['distributor'], 'test_dmadev.c': ['dmadev', 'bus_vdev'], diff --git a/app/test/test_dispatcher.c b/app/test/test_dispatcher.c new file mode 100644 index 0000000000..5a9c972d1f --- /dev/null +++ b/app/test/test_dispatcher.c @@ -0,0 +1,1050 @@ +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright(c) 2023 Ericsson AB + */ + +#include +#include +#include +#include +#include +#include + +#include "test.h" + +#define NUM_WORKERS 3 + +#define NUM_PORTS (NUM_WORKERS + 1) +#define WORKER_PORT_ID(worker_idx) (worker_idx) +#define DRIVER_PORT_ID (NUM_PORTS - 1) + +#define NUM_SERVICE_CORES NUM_WORKERS + +/* Eventdev */ +#define NUM_QUEUES 8 +#define LAST_QUEUE_ID (NUM_QUEUES - 1) +#define MAX_EVENTS 4096 +#define NEW_EVENT_THRESHOLD (MAX_EVENTS / 2) +#define DEQUEUE_BURST_SIZE 32 +#define ENQUEUE_BURST_SIZE 32 + +#define NUM_EVENTS 10000000 +#define NUM_FLOWS 16 + +#define DSW_VDEV "event_dsw0" + +struct app_queue { + uint8_t queue_id; + uint64_t sn[NUM_FLOWS]; + int dispatcher_reg_id; +}; + +struct cb_count { + uint8_t expected_event_dev_id; + uint8_t expected_event_port_id[RTE_MAX_LCORE]; + RTE_ATOMIC(int) count; +}; + +struct test_app { + uint8_t event_dev_id; + struct rte_dispatcher *dispatcher; + uint32_t dispatcher_service_id; + + unsigned int service_lcores[NUM_SERVICE_CORES]; + + int never_match_reg_id; + uint64_t never_match_count; + struct cb_count never_process_count; + + struct app_queue queues[NUM_QUEUES]; + + int finalize_reg_id; + struct cb_count finalize_count; + + bool running; + + RTE_ATOMIC(int) completed_events; + RTE_ATOMIC(int) errors; +}; + +static struct test_app * +test_app_create(void) +{ + int i; + struct test_app *app; + + app = calloc(1, sizeof(struct test_app)); + + if (app == NULL) + return NULL; + + for (i = 0; i < NUM_QUEUES; i++) + app->queues[i].queue_id = i; + + return app; +} + +static void +test_app_free(struct test_app *app) +{ + free(app); +} + +static int +test_app_create_vdev(struct test_app *app) +{ + int rc; + + rc = rte_vdev_init(DSW_VDEV, NULL); + if (rc < 0) + return TEST_SKIPPED; + + rc = rte_event_dev_get_dev_id(DSW_VDEV); + + app->event_dev_id = (uint8_t)rc; + + return TEST_SUCCESS; +} + +static int +test_app_destroy_vdev(struct test_app *app) +{ + int rc; + + rc = rte_event_dev_close(app->event_dev_id); + TEST_ASSERT_SUCCESS(rc, "Error while closing event device"); + + rc = rte_vdev_uninit(DSW_VDEV); + TEST_ASSERT_SUCCESS(rc, "Error while uninitializing virtual device"); + + return TEST_SUCCESS; +} + +static int +test_app_setup_event_dev(struct test_app *app) +{ + int rc; + int i; + + rc = test_app_create_vdev(app); + if (rc < 0) + return rc; + + struct rte_event_dev_config config = { + .nb_event_queues = NUM_QUEUES, + .nb_event_ports = NUM_PORTS, + .nb_events_limit = MAX_EVENTS, + .nb_event_queue_flows = 64, + .nb_event_port_dequeue_depth = DEQUEUE_BURST_SIZE, + .nb_event_port_enqueue_depth = ENQUEUE_BURST_SIZE + }; + + rc = rte_event_dev_configure(app->event_dev_id, &config); + + TEST_ASSERT_SUCCESS(rc, "Unable to configure event device"); + + struct rte_event_queue_conf queue_config = { + .priority = RTE_EVENT_DEV_PRIORITY_NORMAL, + .schedule_type = RTE_SCHED_TYPE_ATOMIC, + .nb_atomic_flows = 64 + }; + + for (i = 0; i < NUM_QUEUES; i++) { + uint8_t queue_id = i; + + rc = rte_event_queue_setup(app->event_dev_id, queue_id, + &queue_config); + + TEST_ASSERT_SUCCESS(rc, "Unable to setup queue %d", queue_id); + } + + struct rte_event_port_conf port_config = { + .new_event_threshold = NEW_EVENT_THRESHOLD, + .dequeue_depth = DEQUEUE_BURST_SIZE, + .enqueue_depth = ENQUEUE_BURST_SIZE + }; + + for (i = 0; i < NUM_PORTS; i++) { + uint8_t event_port_id = i; + + rc = rte_event_port_setup(app->event_dev_id, event_port_id, + &port_config); + TEST_ASSERT_SUCCESS(rc, "Failed to create event port %d", + event_port_id); + + if (event_port_id == DRIVER_PORT_ID) + continue; + + rc = rte_event_port_link(app->event_dev_id, event_port_id, + NULL, NULL, 0); + + TEST_ASSERT_EQUAL(rc, NUM_QUEUES, "Failed to link port %d", + event_port_id); + } + + return TEST_SUCCESS; +} + +static int +test_app_teardown_event_dev(struct test_app *app) +{ + return test_app_destroy_vdev(app); +} + +static int +test_app_start_event_dev(struct test_app *app) +{ + int rc; + + rc = rte_event_dev_start(app->event_dev_id); + TEST_ASSERT_SUCCESS(rc, "Unable to start event device"); + + return TEST_SUCCESS; +} + +static void +test_app_stop_event_dev(struct test_app *app) +{ + rte_event_dev_stop(app->event_dev_id); +} + +static int +test_app_create_dispatcher(struct test_app *app) +{ + int rc; + + app->dispatcher = rte_dispatcher_create(app->event_dev_id); + + TEST_ASSERT(app->dispatcher != NULL, "Unable to create event " + "dispatcher"); + + app->dispatcher_service_id = + rte_dispatcher_service_id_get(app->dispatcher); + + rc = rte_service_set_stats_enable(app->dispatcher_service_id, 1); + + TEST_ASSERT_SUCCESS(rc, "Unable to enable event dispatcher service " + "stats"); + + rc = rte_service_runstate_set(app->dispatcher_service_id, 1); + + TEST_ASSERT_SUCCESS(rc, "Unable to set dispatcher service runstate"); + + return TEST_SUCCESS; +} + +static int +test_app_free_dispatcher(struct test_app *app) +{ + int rc; + + rc = rte_service_runstate_set(app->dispatcher_service_id, 0); + TEST_ASSERT_SUCCESS(rc, "Error disabling dispatcher service"); + + rc = rte_dispatcher_free(app->dispatcher); + TEST_ASSERT_SUCCESS(rc, "Error freeing dispatcher"); + + return TEST_SUCCESS; +} + +static int +test_app_bind_ports(struct test_app *app) +{ + int i; + + app->never_process_count.expected_event_dev_id = + app->event_dev_id; + app->finalize_count.expected_event_dev_id = + app->event_dev_id; + + for (i = 0; i < NUM_WORKERS; i++) { + unsigned int lcore_id = app->service_lcores[i]; + uint8_t port_id = WORKER_PORT_ID(i); + + int rc = rte_dispatcher_bind_port_to_lcore( + app->dispatcher, port_id, DEQUEUE_BURST_SIZE, 0, + lcore_id + ); + + TEST_ASSERT_SUCCESS(rc, "Unable to bind event device port %d " + "to lcore %d", port_id, lcore_id); + + app->never_process_count.expected_event_port_id[lcore_id] = + port_id; + app->finalize_count.expected_event_port_id[lcore_id] = port_id; + } + + + return TEST_SUCCESS; +} + +static int +test_app_unbind_ports(struct test_app *app) +{ + int i; + + for (i = 0; i < NUM_WORKERS; i++) { + unsigned int lcore_id = app->service_lcores[i]; + + int rc = rte_dispatcher_unbind_port_from_lcore( + app->dispatcher, + WORKER_PORT_ID(i), + lcore_id + ); + + TEST_ASSERT_SUCCESS(rc, "Unable to unbind event device port %d " + "from lcore %d", WORKER_PORT_ID(i), + lcore_id); + } + + return TEST_SUCCESS; +} + +static bool +match_queue(const struct rte_event *event, void *cb_data) +{ + uintptr_t queue_id = (uintptr_t)cb_data; + + return event->queue_id == queue_id; +} + +static int +test_app_get_worker_index(struct test_app *app, unsigned int lcore_id) +{ + int i; + + for (i = 0; i < NUM_SERVICE_CORES; i++) + if (app->service_lcores[i] == lcore_id) + return i; + + return -1; +} + +static int +test_app_get_worker_port(struct test_app *app, unsigned int lcore_id) +{ + int worker; + + worker = test_app_get_worker_index(app, lcore_id); + + if (worker < 0) + return -1; + + return WORKER_PORT_ID(worker); +} + +static void +test_app_queue_note_error(struct test_app *app) +{ + rte_atomic_fetch_add_explicit(&app->errors, 1, rte_memory_order_relaxed); +} + +static void +test_app_process_queue(uint8_t p_event_dev_id, uint8_t p_event_port_id, + struct rte_event *in_events, uint16_t num, + void *cb_data) +{ + struct app_queue *app_queue = cb_data; + struct test_app *app = container_of(app_queue, struct test_app, + queues[app_queue->queue_id]); + unsigned int lcore_id = rte_lcore_id(); + bool intermediate_queue = app_queue->queue_id != LAST_QUEUE_ID; + int event_port_id; + uint16_t i; + struct rte_event out_events[num]; + + event_port_id = test_app_get_worker_port(app, lcore_id); + + if (event_port_id < 0 || p_event_dev_id != app->event_dev_id || + p_event_port_id != event_port_id) { + test_app_queue_note_error(app); + return; + } + + for (i = 0; i < num; i++) { + const struct rte_event *in_event = &in_events[i]; + struct rte_event *out_event = &out_events[i]; + uint64_t sn = in_event->u64; + uint64_t expected_sn; + + if (in_event->queue_id != app_queue->queue_id) { + test_app_queue_note_error(app); + return; + } + + expected_sn = app_queue->sn[in_event->flow_id]++; + + if (expected_sn != sn) { + test_app_queue_note_error(app); + return; + } + + if (intermediate_queue) + *out_event = (struct rte_event) { + .queue_id = in_event->queue_id + 1, + .flow_id = in_event->flow_id, + .sched_type = RTE_SCHED_TYPE_ATOMIC, + .op = RTE_EVENT_OP_FORWARD, + .priority = RTE_EVENT_DEV_PRIORITY_NORMAL, + .u64 = sn + }; + } + + if (intermediate_queue) { + uint16_t n = 0; + + do { + n += rte_event_enqueue_forward_burst(p_event_dev_id, + p_event_port_id, + out_events + n, + num - n); + } while (n != num); + } else + rte_atomic_fetch_add_explicit(&app->completed_events, num, + rte_memory_order_relaxed); +} + +static bool +never_match(const struct rte_event *event __rte_unused, void *cb_data) +{ + uint64_t *count = cb_data; + + (*count)++; + + return false; +} + +static void +test_app_never_process(uint8_t event_dev_id, uint8_t event_port_id, + struct rte_event *in_events __rte_unused, uint16_t num, void *cb_data) +{ + struct cb_count *count = cb_data; + unsigned int lcore_id = rte_lcore_id(); + + if (event_dev_id == count->expected_event_dev_id && + event_port_id == count->expected_event_port_id[lcore_id]) + rte_atomic_fetch_add_explicit(&count->count, num, + rte_memory_order_relaxed); +} + +static void +finalize(uint8_t event_dev_id, uint8_t event_port_id, void *cb_data) +{ + struct cb_count *count = cb_data; + unsigned int lcore_id = rte_lcore_id(); + + if (event_dev_id == count->expected_event_dev_id && + event_port_id == count->expected_event_port_id[lcore_id]) + rte_atomic_fetch_add_explicit(&count->count, 1, + rte_memory_order_relaxed); +} + +static int +test_app_register_callbacks(struct test_app *app) +{ + int i; + + app->never_match_reg_id = + rte_dispatcher_register(app->dispatcher, never_match, + &app->never_match_count, + test_app_never_process, + &app->never_process_count); + + TEST_ASSERT(app->never_match_reg_id >= 0, "Unable to register " + "never-match handler"); + + for (i = 0; i < NUM_QUEUES; i++) { + struct app_queue *app_queue = &app->queues[i]; + uintptr_t queue_id = app_queue->queue_id; + int reg_id; + + reg_id = rte_dispatcher_register(app->dispatcher, + match_queue, (void *)queue_id, + test_app_process_queue, + app_queue); + + TEST_ASSERT(reg_id >= 0, "Unable to register consumer " + "callback for queue %d", i); + + app_queue->dispatcher_reg_id = reg_id; + } + + app->finalize_reg_id = + rte_dispatcher_finalize_register(app->dispatcher, + finalize, + &app->finalize_count); + TEST_ASSERT_SUCCESS(app->finalize_reg_id, "Error registering " + "finalize callback"); + + return TEST_SUCCESS; +} + +static int +test_app_unregister_callback(struct test_app *app, uint8_t queue_id) +{ + int reg_id = app->queues[queue_id].dispatcher_reg_id; + int rc; + + if (reg_id < 0) /* unregistered already */ + return 0; + + rc = rte_dispatcher_unregister(app->dispatcher, reg_id); + + TEST_ASSERT_SUCCESS(rc, "Unable to unregister consumer " + "callback for queue %d", queue_id); + + app->queues[queue_id].dispatcher_reg_id = -1; + + return TEST_SUCCESS; +} + +static int +test_app_unregister_callbacks(struct test_app *app) +{ + int i; + int rc; + + if (app->never_match_reg_id >= 0) { + rc = rte_dispatcher_unregister(app->dispatcher, + app->never_match_reg_id); + + TEST_ASSERT_SUCCESS(rc, "Unable to unregister never-match " + "handler"); + app->never_match_reg_id = -1; + } + + for (i = 0; i < NUM_QUEUES; i++) { + rc = test_app_unregister_callback(app, i); + if (rc != TEST_SUCCESS) + return rc; + } + + if (app->finalize_reg_id >= 0) { + rc = rte_dispatcher_finalize_unregister( + app->dispatcher, app->finalize_reg_id + ); + app->finalize_reg_id = -1; + } + + return TEST_SUCCESS; +} + +static int +test_app_start_dispatcher(struct test_app *app) +{ + int rc; + + rc = rte_dispatcher_start(app->dispatcher); + + TEST_ASSERT_SUCCESS(rc, "Unable to start the event dispatcher"); + + return TEST_SUCCESS; +} + +static int +test_app_stop_dispatcher(struct test_app *app) +{ + int rc; + + rc = rte_dispatcher_stop(app->dispatcher); + + TEST_ASSERT_SUCCESS(rc, "Unable to stop the event dispatcher"); + + return TEST_SUCCESS; +} + +static int +test_app_reset_dispatcher_stats(struct test_app *app) +{ + struct rte_dispatcher_stats stats; + + rte_dispatcher_stats_reset(app->dispatcher); + + memset(&stats, 0xff, sizeof(stats)); + + rte_dispatcher_stats_get(app->dispatcher, &stats); + + TEST_ASSERT_EQUAL(stats.poll_count, 0, "Poll count not zero"); + TEST_ASSERT_EQUAL(stats.ev_batch_count, 0, "Batch count not zero"); + TEST_ASSERT_EQUAL(stats.ev_dispatch_count, 0, "Dispatch count " + "not zero"); + TEST_ASSERT_EQUAL(stats.ev_drop_count, 0, "Drop count not zero"); + + return TEST_SUCCESS; +} + +static int +test_app_setup_service_core(struct test_app *app, unsigned int lcore_id) +{ + int rc; + + rc = rte_service_lcore_add(lcore_id); + TEST_ASSERT_SUCCESS(rc, "Unable to make lcore %d an event dispatcher " + "service core", lcore_id); + + rc = rte_service_map_lcore_set(app->dispatcher_service_id, lcore_id, 1); + TEST_ASSERT_SUCCESS(rc, "Unable to map event dispatcher service"); + + return TEST_SUCCESS; +} + +static int +test_app_setup_service_cores(struct test_app *app) +{ + int i; + int lcore_id = -1; + + for (i = 0; i < NUM_SERVICE_CORES; i++) { + lcore_id = rte_get_next_lcore(lcore_id, 1, 0); + + TEST_ASSERT(lcore_id != RTE_MAX_LCORE, + "Too few lcores. Needs at least %d worker lcores", + NUM_SERVICE_CORES); + + app->service_lcores[i] = lcore_id; + } + + for (i = 0; i < NUM_SERVICE_CORES; i++) { + int rc; + + rc = test_app_setup_service_core(app, app->service_lcores[i]); + if (rc != TEST_SUCCESS) + return rc; + } + + return TEST_SUCCESS; +} + +static int +test_app_teardown_service_core(struct test_app *app, unsigned int lcore_id) +{ + int rc; + + rc = rte_service_map_lcore_set(app->dispatcher_service_id, lcore_id, 0); + TEST_ASSERT_SUCCESS(rc, "Unable to unmap event dispatcher service"); + + rc = rte_service_lcore_del(lcore_id); + TEST_ASSERT_SUCCESS(rc, "Unable change role of service lcore %d", + lcore_id); + + return TEST_SUCCESS; +} + +static int +test_app_teardown_service_cores(struct test_app *app) +{ + int i; + + for (i = 0; i < NUM_SERVICE_CORES; i++) { + unsigned int lcore_id = app->service_lcores[i]; + int rc; + + rc = test_app_teardown_service_core(app, lcore_id); + if (rc != TEST_SUCCESS) + return rc; + } + + return TEST_SUCCESS; +} + +static int +test_app_start_service_cores(struct test_app *app) +{ + int i; + + for (i = 0; i < NUM_SERVICE_CORES; i++) { + unsigned int lcore_id = app->service_lcores[i]; + int rc; + + rc = rte_service_lcore_start(lcore_id); + TEST_ASSERT_SUCCESS(rc, "Unable to start service lcore %d", + lcore_id); + } + + return TEST_SUCCESS; +} + +static int +test_app_stop_service_cores(struct test_app *app) +{ + int i; + + for (i = 0; i < NUM_SERVICE_CORES; i++) { + unsigned int lcore_id = app->service_lcores[i]; + int rc; + + rc = rte_service_lcore_stop(lcore_id); + TEST_ASSERT_SUCCESS(rc, "Unable to stop service lcore %d", + lcore_id); + } + + return TEST_SUCCESS; +} + +static int +test_app_start(struct test_app *app) +{ + int rc; + + rc = test_app_start_event_dev(app); + if (rc != TEST_SUCCESS) + return rc; + + rc = test_app_start_service_cores(app); + if (rc != TEST_SUCCESS) + return rc; + + rc = test_app_start_dispatcher(app); + if (rc != TEST_SUCCESS) + return rc; + + app->running = true; + + return TEST_SUCCESS; +} + +static int +test_app_stop(struct test_app *app) +{ + int rc; + + rc = test_app_stop_dispatcher(app); + if (rc != TEST_SUCCESS) + return rc; + + test_app_stop_service_cores(app); + if (rc != TEST_SUCCESS) + return rc; + + test_app_stop_event_dev(app); + if (rc != TEST_SUCCESS) + return rc; + + app->running = false; + + return TEST_SUCCESS; +} + +struct test_app *test_app; + +static int +test_setup(void) +{ + int rc; + + test_app = test_app_create(); + TEST_ASSERT(test_app != NULL, "Unable to allocate memory"); + + rc = test_app_setup_event_dev(test_app); + if (rc != TEST_SUCCESS) + return rc; + + rc = test_app_create_dispatcher(test_app); + + rc = test_app_setup_service_cores(test_app); + if (rc != TEST_SUCCESS) + return rc; + + rc = test_app_register_callbacks(test_app); + if (rc != TEST_SUCCESS) + return rc; + + rc = test_app_bind_ports(test_app); + + return rc; +} + +static void test_teardown(void) +{ + if (test_app->running) + test_app_stop(test_app); + + test_app_teardown_service_cores(test_app); + + test_app_unregister_callbacks(test_app); + + test_app_unbind_ports(test_app); + + test_app_free_dispatcher(test_app); + + test_app_teardown_event_dev(test_app); + + test_app_free(test_app); + + test_app = NULL; +} + +static int +test_app_get_completed_events(struct test_app *app) +{ + return rte_atomic_load_explicit(&app->completed_events, + rte_memory_order_relaxed); +} + +static int +test_app_get_errors(struct test_app *app) +{ + return rte_atomic_load_explicit(&app->errors, rte_memory_order_relaxed); +} + +static int +test_basic(void) +{ + int rc; + int i; + + rc = test_app_start(test_app); + if (rc != TEST_SUCCESS) + return rc; + + uint64_t sns[NUM_FLOWS] = { 0 }; + + for (i = 0; i < NUM_EVENTS;) { + struct rte_event events[ENQUEUE_BURST_SIZE]; + int left; + int batch_size; + int j; + uint16_t n = 0; + + batch_size = 1 + rte_rand_max(ENQUEUE_BURST_SIZE); + left = NUM_EVENTS - i; + + batch_size = RTE_MIN(left, batch_size); + + for (j = 0; j < batch_size; j++) { + struct rte_event *event = &events[j]; + uint64_t sn; + uint32_t flow_id; + + flow_id = rte_rand_max(NUM_FLOWS); + + sn = sns[flow_id]++; + + *event = (struct rte_event) { + .queue_id = 0, + .flow_id = flow_id, + .sched_type = RTE_SCHED_TYPE_ATOMIC, + .op = RTE_EVENT_OP_NEW, + .priority = RTE_EVENT_DEV_PRIORITY_NORMAL, + .u64 = sn + }; + } + + while (n < batch_size) + n += rte_event_enqueue_new_burst(test_app->event_dev_id, + DRIVER_PORT_ID, + events + n, + batch_size - n); + + i += batch_size; + } + + while (test_app_get_completed_events(test_app) != NUM_EVENTS) + rte_event_maintain(test_app->event_dev_id, DRIVER_PORT_ID, 0); + + rc = test_app_get_errors(test_app); + TEST_ASSERT(rc == 0, "%d errors occurred", rc); + + rc = test_app_stop(test_app); + if (rc != TEST_SUCCESS) + return rc; + + struct rte_dispatcher_stats stats; + rte_dispatcher_stats_get(test_app->dispatcher, &stats); + + TEST_ASSERT_EQUAL(stats.ev_drop_count, 0, "Drop count is not zero"); + TEST_ASSERT_EQUAL(stats.ev_dispatch_count, NUM_EVENTS * NUM_QUEUES, + "Invalid dispatch count"); + TEST_ASSERT(stats.poll_count > 0, "Poll count is zero"); + + TEST_ASSERT_EQUAL(test_app->never_process_count.count, 0, + "Never-match handler's process function has " + "been called"); + + int finalize_count = + rte_atomic_load_explicit(&test_app->finalize_count.count, + rte_memory_order_relaxed); + + TEST_ASSERT(finalize_count > 0, "Finalize count is zero"); + TEST_ASSERT(finalize_count <= (int)stats.ev_dispatch_count, + "Finalize count larger than event count"); + + TEST_ASSERT_EQUAL(finalize_count, (int)stats.ev_batch_count, + "%"PRIu64" batches dequeued, but finalize called %d " + "times", stats.ev_batch_count, finalize_count); + + /* + * The event dispatcher should call often-matching match functions + * more often, and thus this never-matching match function should + * be called relatively infrequently. + */ + TEST_ASSERT(test_app->never_match_count < + (stats.ev_dispatch_count / 4), + "Never-matching match function called suspiciously often"); + + rc = test_app_reset_dispatcher_stats(test_app); + if (rc != TEST_SUCCESS) + return rc; + + return TEST_SUCCESS; +} + +static int +test_drop(void) +{ + int rc; + uint8_t unhandled_queue; + struct rte_dispatcher_stats stats; + + unhandled_queue = (uint8_t)rte_rand_max(NUM_QUEUES); + + rc = test_app_start(test_app); + if (rc != TEST_SUCCESS) + return rc; + + rc = test_app_unregister_callback(test_app, unhandled_queue); + if (rc != TEST_SUCCESS) + return rc; + + struct rte_event event = { + .queue_id = unhandled_queue, + .flow_id = 0, + .sched_type = RTE_SCHED_TYPE_ATOMIC, + .op = RTE_EVENT_OP_NEW, + .priority = RTE_EVENT_DEV_PRIORITY_NORMAL, + .u64 = 0 + }; + + do { + rc = rte_event_enqueue_burst(test_app->event_dev_id, + DRIVER_PORT_ID, &event, 1); + } while (rc == 0); + + do { + rte_dispatcher_stats_get(test_app->dispatcher, &stats); + + rte_event_maintain(test_app->event_dev_id, DRIVER_PORT_ID, 0); + } while (stats.ev_drop_count == 0 && stats.ev_dispatch_count == 0); + + rc = test_app_stop(test_app); + if (rc != TEST_SUCCESS) + return rc; + + TEST_ASSERT_EQUAL(stats.ev_drop_count, 1, "Drop count is not one"); + TEST_ASSERT_EQUAL(stats.ev_dispatch_count, 0, + "Dispatch count is not zero"); + TEST_ASSERT(stats.poll_count > 0, "Poll count is zero"); + + return TEST_SUCCESS; +} + +#define MORE_THAN_MAX_HANDLERS 1000 +#define MIN_HANDLERS 32 + +static int +test_many_handler_registrations(void) +{ + int rc; + int num_regs = 0; + int reg_ids[MORE_THAN_MAX_HANDLERS]; + int reg_id; + int i; + + rc = test_app_unregister_callbacks(test_app); + if (rc != TEST_SUCCESS) + return rc; + + for (i = 0; i < MORE_THAN_MAX_HANDLERS; i++) { + reg_id = rte_dispatcher_register(test_app->dispatcher, + never_match, NULL, + test_app_never_process, NULL); + if (reg_id < 0) + break; + + reg_ids[num_regs++] = reg_id; + } + + TEST_ASSERT_EQUAL(reg_id, -ENOMEM, "Incorrect return code. Expected " + "%d but was %d", -ENOMEM, reg_id); + TEST_ASSERT(num_regs >= MIN_HANDLERS, "Registration failed already " + "after %d handler registrations.", num_regs); + + for (i = 0; i < num_regs; i++) { + rc = rte_dispatcher_unregister(test_app->dispatcher, + reg_ids[i]); + TEST_ASSERT_SUCCESS(rc, "Unable to unregister handler %d", + reg_ids[i]); + } + + return TEST_SUCCESS; +} + +static void +dummy_finalize(uint8_t event_dev_id __rte_unused, + uint8_t event_port_id __rte_unused, + void *cb_data __rte_unused) +{ +} + +#define MORE_THAN_MAX_FINALIZERS 1000 +#define MIN_FINALIZERS 16 + +static int +test_many_finalize_registrations(void) +{ + int rc; + int num_regs = 0; + int reg_ids[MORE_THAN_MAX_FINALIZERS]; + int reg_id; + int i; + + rc = test_app_unregister_callbacks(test_app); + if (rc != TEST_SUCCESS) + return rc; + + for (i = 0; i < MORE_THAN_MAX_FINALIZERS; i++) { + reg_id = rte_dispatcher_finalize_register( + test_app->dispatcher, dummy_finalize, NULL + ); + + if (reg_id < 0) + break; + + reg_ids[num_regs++] = reg_id; + } + + TEST_ASSERT_EQUAL(reg_id, -ENOMEM, "Incorrect return code. Expected " + "%d but was %d", -ENOMEM, reg_id); + TEST_ASSERT(num_regs >= MIN_FINALIZERS, "Finalize registration failed " + "already after %d registrations.", num_regs); + + for (i = 0; i < num_regs; i++) { + rc = rte_dispatcher_finalize_unregister( + test_app->dispatcher, reg_ids[i] + ); + TEST_ASSERT_SUCCESS(rc, "Unable to unregister finalizer %d", + reg_ids[i]); + } + + return TEST_SUCCESS; +} + +static struct unit_test_suite test_suite = { + .suite_name = "Event dispatcher test suite", + .unit_test_cases = { + TEST_CASE_ST(test_setup, test_teardown, test_basic), + TEST_CASE_ST(test_setup, test_teardown, test_drop), + TEST_CASE_ST(test_setup, test_teardown, + test_many_handler_registrations), + TEST_CASE_ST(test_setup, test_teardown, + test_many_finalize_registrations), + TEST_CASES_END() + } +}; + +static int +test_dispatcher(void) +{ + return unit_test_suite_runner(&test_suite); +} + +REGISTER_FAST_TEST(dispatcher_autotest, false, true, test_dispatcher); From patchwork Mon Oct 9 18:17:11 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Mattias_R=C3=B6nnblom?= X-Patchwork-Id: 132447 X-Patchwork-Delegate: david.marchand@redhat.com Return-Path: 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]) by inbox.dpdk.org (Postfix) with ESMTP id 68F0342340; Mon, 9 Oct 2023 20:22:52 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id ECCC240DDE; Mon, 9 Oct 2023 20:22:38 +0200 (CEST) Received: from EUR04-HE1-obe.outbound.protection.outlook.com (mail-he1eur04on2088.outbound.protection.outlook.com [40.107.7.88]) by mails.dpdk.org (Postfix) with ESMTP id E82E84067D; Mon, 9 Oct 2023 20:22:37 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=DgvtokQNui5czfLhtkvvkx9qPfapyCrTHJYJv7yU1o91RykvHSS3EDAEG3ArmR5WVG8EDrKWKRUC7vs29Vk239O0iI9z+MHTk9FGB8xRJNBKbueRka7RyxiNa9+n6awjCeq9Y3xh63DW3Q2GldVU44OEYX81nG/Lcy1UYaVA70y8zyyocKKiQ4r8pDNUZUCe26pfKQFS/kRzEPWL+rNQSOb3J7MV4bhlkHGA7w1yG+qjVmAvEbVGK9d7RqVWWgNsmlnfrwC3q1wbhYVESkoeZf33lhEqxBnoatdGdZ68/BbFf2q8x7jKN1XhnoTYJf9A6WORNIJAFXp5kenDivVJBw== 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-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=SGeRhTcMGaF8LK+jwyi+QqRhYIUSzRs4MgbTRnmI1CY=; b=l0q/fnrEYI1txPCug6V/HNuxKWZWMwgd1CKVBaWFHTR9bnuoFuxiuLJnJrHspmey9S2Q3/in5lSCx72fsQnbvYEM2PX5sAA6GDOe4h+YHm9D9XHHmay5O1pcmv03/gqlMJCACWT/NKFu7/u6GY2QQjGgBQVkw8RLkPED0L6M8FKhxaDWRmGlEjZATnrm0Cs9868OctdXRE4XvjcYNlE5G6EOuZJfRVrKD76/Iwc/2qf7AyRIytAj9c1VeeMRZjK2RGJyPYDRCcefFfFL2rDP92YR2ql8YAa8gbe/NaNnDILTdeLhJa1kMm6k/eZOd8sVb5j6+bBlPpAreX4EWaHt4g== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 192.176.1.74) smtp.rcpttodomain=dpdk.org smtp.mailfrom=ericsson.com; dmarc=pass (p=reject sp=reject pct=100) action=none header.from=ericsson.com; dkim=none (message not signed); arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ericsson.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=SGeRhTcMGaF8LK+jwyi+QqRhYIUSzRs4MgbTRnmI1CY=; b=s8QzGJf/ASlDA8gMRKVEeiTeU7J0x1FinkdFxLFyih1PWVXWiZ57lISi9doWyvii1dJWzIziIvubzRiz1JVESpTvbEyvcs86lEd12Yz2aqZLJQEkpwgr9XYoYwOXPK9Zf26B1NtKmnXMYW9SrXhS7YKJCUaDYuAbEVxAEri8QLQ= Received: from AS9PR06CA0374.eurprd06.prod.outlook.com (2603:10a6:20b:460::29) by DB9PR07MB9269.eurprd07.prod.outlook.com (2603:10a6:10:459::8) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6838.43; Mon, 9 Oct 2023 18:22:34 +0000 Received: from AMS0EPF000001B2.eurprd05.prod.outlook.com (2603:10a6:20b:460:cafe::29) by AS9PR06CA0374.outlook.office365.com (2603:10a6:20b:460::29) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6863.37 via Frontend Transport; Mon, 9 Oct 2023 18:22:34 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 192.176.1.74) smtp.mailfrom=ericsson.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=ericsson.com; Received-SPF: Pass (protection.outlook.com: domain of ericsson.com designates 192.176.1.74 as permitted sender) receiver=protection.outlook.com; client-ip=192.176.1.74; helo=oa.msg.ericsson.com; pr=C Received: from oa.msg.ericsson.com (192.176.1.74) by AMS0EPF000001B2.mail.protection.outlook.com (10.167.16.166) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256) id 15.20.6838.22 via Frontend Transport; Mon, 9 Oct 2023 18:22:33 +0000 Received: from ESESBMB504.ericsson.se (153.88.183.171) by ESESBMB504.ericsson.se (153.88.183.171) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.2507.32; Mon, 9 Oct 2023 20:22:33 +0200 Received: from seliicinfr00050.seli.gic.ericsson.se (153.88.183.153) by smtp.internal.ericsson.com (153.88.183.187) with Microsoft SMTP Server id 15.1.2507.32 via Frontend Transport; Mon, 9 Oct 2023 20:22:33 +0200 Received: from breslau.. (seliicwb00002.seli.gic.ericsson.se [10.156.25.100]) by seliicinfr00050.seli.gic.ericsson.se (Postfix) with ESMTP id 4F3DD1C006A; Mon, 9 Oct 2023 20:22:33 +0200 (CEST) From: =?utf-8?q?Mattias_R=C3=B6nnblom?= To: , CC: Jerin Jacob , , , , Peter Nilsson , Heng Wang , "Naga Harish K S V" , Pavan Nikhilesh , Gujjar Abhinandan S , Erik Gabriel Carrillo , Shijith Thotton , "Hemant Agrawal" , Sachin Saxena , Liang Ma , Peter Mccarthy , Zhirun Yan , =?utf-8?q?Mattias_R=C3=B6nnblom?= Subject: [PATCH v6 3/3] doc: add dispatcher programming guide Date: Mon, 9 Oct 2023 20:17:11 +0200 Message-ID: <20231009181711.440865-4-mattias.ronnblom@ericsson.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231009181711.440865-1-mattias.ronnblom@ericsson.com> References: <20230928073056.359356-2-mattias.ronnblom@ericsson.com> <20231009181711.440865-1-mattias.ronnblom@ericsson.com> MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: AMS0EPF000001B2:EE_|DB9PR07MB9269:EE_ X-MS-Office365-Filtering-Correlation-Id: eaf70d75-622f-4e85-87cb-08dbc8f4b526 X-LD-Processed: 92e84ceb-fbfd-47ab-be52-080c6b87953f,ExtAddr X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: AS6D3AvZO9atbQS/9dUHx6WZ/vUNmtdgBqKPLkDtbdjQs9PUf8ziqopYhY6pHILfPpgM9Of9W3/fc86cxk7qRxZ2ssQAZUp0gvB7Wzz/aIXNAVFdLIm0T5XdmJKpV7JNK+kz1ITGpbzu/CMcgYhFSK6rRQ8yeMysS3oL+BbGCsRyo6I45zjzlVGE8qPOVEXNYPV3YqdkYkNopvBWEsP3Dn7Q6Mf3tzmEyqx8hmVj2/dVl432dJ5NiGWNU6y7GzK+QbM5LTmlsgVwGw5gebLRS/gK2Q0oCO+qqB/fqlmcSi2t3u5R8NYCnGCbtupHF5T8yYnhs7ytDwCraYw21wmDMy61+oEIyEV+qbX1J8QW3dAsu1bcML9FPVA6iM240vXUZ1T8HihFeRFsi0ageNZKAwGcOBipbcRd4wT0hjVAjxMbeL/cPj8++BNJdyCYwrI6Jjwl6hVU6bYEGncFFLs86cDxxp7Tb7yRJ+savB9oEyaMRM+lS01CPGCzH3MsCLZHGRh0ZTL6rS9PcNlJQtAPT34kV18QS63Hmiwww1A2Or3o+Ittu/Tw1NSjkGappQEpG+LMdVJDe2AsTGDCIbdJrbgQ7yMGXzhU+fuGbCgMChasZuYmO0PxaNN8fUtR+QzT6PooCAEyE8y/6VP5rbipD+hR+qvMdITRdj9pFTfKO8RsuiicGkt5nVJIqAp88TpU8fP/po8VLD9lt1C8OerHTvpNTtKDs9rZOj9cKgO9ivcVG/o+CX0NuUOBnE95d5FW4oBPJcQD8DIbASjBZ8irn1Wnn0mzwkLfvFjVQbEhPHyTsd2qNFQTxr9RmVPeavZ8I2FHoB3RSbkw3h0/7jxMtjJRxi7J458e1TmDRrmWFj4= X-Forefront-Antispam-Report: CIP:192.176.1.74; CTRY:SE; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:oa.msg.ericsson.com; PTR:office365.se.ericsson.net; CAT:NONE; SFS:(13230031)(4636009)(136003)(39860400002)(396003)(376002)(346002)(230922051799003)(64100799003)(186009)(1800799009)(451199024)(82310400011)(36840700001)(46966006)(40470700004)(40460700003)(40480700001)(66899024)(107886003)(6666004)(478600001)(82740400003)(82960400001)(36860700001)(7636003)(356005)(36756003)(86362001)(7416002)(2906002)(47076005)(83380400001)(2616005)(26005)(66574015)(6266002)(1076003)(336012)(8936002)(30864003)(70206006)(70586007)(54906003)(110136005)(41300700001)(8676002)(316002)(5660300002)(4326008)(2101003); DIR:OUT; SFP:1101; X-OriginatorOrg: ericsson.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 09 Oct 2023 18:22:33.9208 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: eaf70d75-622f-4e85-87cb-08dbc8f4b526 X-MS-Exchange-CrossTenant-Id: 92e84ceb-fbfd-47ab-be52-080c6b87953f X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=92e84ceb-fbfd-47ab-be52-080c6b87953f; Ip=[192.176.1.74]; Helo=[oa.msg.ericsson.com] X-MS-Exchange-CrossTenant-AuthSource: AMS0EPF000001B2.eurprd05.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB9PR07MB9269 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Provide programming guide for the dispatcher library. Signed-off-by: Mattias Rönnblom --- PATCH v6: o Eliminate unneeded white space in code blocks. (David Marchand) PATCH v5: o Update guide to match API changes related to dispatcher ids. PATCH v3: o Adapt guide to the dispatcher API name changes. PATCH: o Improve grammar and spelling. RFC v4: o Extend event matching section of the programming guide. o Improve grammar and spelling. --- MAINTAINERS | 1 + doc/guides/prog_guide/dispatcher_lib.rst | 433 +++++++++++++++++++++++ doc/guides/prog_guide/index.rst | 1 + 3 files changed, 435 insertions(+) create mode 100644 doc/guides/prog_guide/dispatcher_lib.rst diff --git a/MAINTAINERS b/MAINTAINERS index 262401d43d..748c15cfe9 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1737,6 +1737,7 @@ Dispatcher - EXPERIMENTAL M: Mattias Rönnblom F: lib/dispatcher/ F: app/test/test_dispatcher.c +F: doc/guides/prog_guide/dispatcher_lib.rst Test Applications diff --git a/doc/guides/prog_guide/dispatcher_lib.rst b/doc/guides/prog_guide/dispatcher_lib.rst new file mode 100644 index 0000000000..2ab798920c --- /dev/null +++ b/doc/guides/prog_guide/dispatcher_lib.rst @@ -0,0 +1,433 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2023 Ericsson AB. + +Dispatcher +========== + +Overview +-------- + +The purpose of the dispatcher is to help reduce coupling in an +:doc:`Eventdev `-based DPDK application. + +In particular, the dispatcher addresses a scenario where an +application's modules share the same event device and event device +ports, and performs work on the same lcore threads. + +The dispatcher replaces the conditional logic that follows an event +device dequeue operation, where events are dispatched to different +parts of the application, typically based on fields in the +``rte_event``, such as the ``queue_id``, ``sub_event_type``, or +``sched_type``. + +Below is an excerpt from a fictitious application consisting of two +modules; A and B. In this example, event-to-module routing is based +purely on queue id, where module A expects all events to a certain +queue id, and module B two other queue ids. [#Mapping]_ + +.. code-block:: c + + for (;;) { + struct rte_event events[MAX_BURST]; + unsigned int n; + + n = rte_event_dequeue_burst(dev_id, port_id, events, + MAX_BURST, 0); + + for (i = 0; i < n; i++) { + const struct rte_event *event = &events[i]; + + switch (event->queue_id) { + case MODULE_A_QUEUE_ID: + module_a_process(event); + break; + case MODULE_B_STAGE_0_QUEUE_ID: + module_b_process_stage_0(event); + break; + case MODULE_B_STAGE_1_QUEUE_ID: + module_b_process_stage_1(event); + break; + } + } + } + +The issue this example attempts to illustrate is that the centralized +conditional logic has knowledge of things that should be private to +the modules. In other words, this pattern leads to a violation of +module encapsulation. + +The shared conditional logic contains explicit knowledge about what +events should go where. In case, for example, the +``module_a_process()`` is broken into two processing stages — a +module-internal affair — the shared conditional code must be updated +to reflect this change. + +The centralized event routing code becomes an issue in larger +applications, where modules are developed by different organizations. +This pattern also makes module reuse across different application more +difficult. The part of the conditional logic relevant for a particular +application may need to be duplicated across many module +instantiations (e.g., applications and test setups). + +The dispatcher separates the mechanism (routing events to their +receiver) from the policy (which events should go where). + +The basic operation of the dispatcher is as follows: + +* Dequeue a batch of events from the event device. +* For each event determine which handler should receive the event, using + a set of application-provided, per-handler event matching callback + functions. +* Provide events matching a particular handler, to that handler, using + its process callback. + +If the above application would have made use of the dispatcher, the +code relevant for its module A may have looked something like this: + +.. code-block:: c + + static bool + module_a_match(const struct rte_event *event, void *cb_data) + { + return event->queue_id == MODULE_A_QUEUE_ID; + } + + static void + module_a_process_events(uint8_t event_dev_id, uint8_t event_port_id, + const struct rte_event *events, + uint16_t num, void *cb_data) + { + uint16_t i; + + for (i = 0; i < num; i++) + module_a_process_event(&events[i]); + } + + /* In the module's initialization code */ + rte_dispatcher_register(dispatcher, module_a_match, NULL, + module_a_process_events, module_a_data); + +(Error handling is left out of this and future example code in this +chapter.) + +When the shared conditional logic is removed, a new question arise: +which part of the system actually runs the dispatching mechanism? Or +phrased differently, what is replacing the function hosting the shared +conditional logic (typically launched on all lcores using +``rte_eal_remote_launch()``)? To solve this issue, the dispatcher is a +run as a DPDK :doc:`Service `. + +The dispatcher is a layer between the application and the event device +in the receive direction. In the transmit (i.e., item of work +submission) direction, the application directly accesses the Eventdev +core API (e.g., ``rte_event_enqueue_burst()``) to submit new or +forwarded event to the event device. + +Dispatcher Creation +------------------- + +A dispatcher is created with using +``rte_dispatcher_create()``. + +The event device must be configured before the dispatcher is created. + +Usually, only one dispatcher is needed per event device. A dispatcher +handles exactly one event device. + +An dispatcher is freed using the ``rte_dispatcher_free()`` +function. The dispatcher's service functions must not be running on +any lcore at the point of this call. + +Event Port Binding +------------------ + +To be able to dequeue events, the dispatcher must know which event +ports are to be used, on all the lcores it uses. The application +provides this information using +``rte_dispatcher_bind_port_to_lcore()``. + +This call is typically made from the part of the application that +deals with deployment issues (e.g., iterating lcores and determining +which lcore does what), at the time of application initialization. + +The ``rte_dispatcher_unbind_port_from_lcore()`` is used to undo +this operation. + +Multiple lcore threads may not safely use the same event +port. [#Port-MT-Safety] + +Event ports cannot safely be bound or unbound while the dispatcher's +service function is running on any lcore. + +Event Handlers +-------------- + +The dispatcher handler is an interface between the dispatcher and an +application module, used to route events to the appropriate part of +the application. + +Handler Registration +^^^^^^^^^^^^^^^^^^^^ + +The event handler interface consists of two function pointers: + +* The ``rte_dispatcher_match_t`` callback, which job is to + decide if this event is to be the property of this handler. +* The ``rte_dispatcher_process_t``, which is used by the + dispatcher to deliver matched events. + +An event handler registration is valid on all lcores. + +The functions pointed to by the match and process callbacks resides in +the application's domain logic, with one or more handlers per +application module. + +A module may use more than one event handler, for convenience or to +further decouple sub-modules. However, the dispatcher may impose an +upper limit of the number handlers. In addition, installing a large +number of handlers increase dispatcher overhead, although this does +not nessarily translate to a system-level performance degradation. See +the section on :ref:`Event Clustering` for more information. + +Handler registration and unregistration cannot safely be done while +the dispatcher's service function is running on any lcore. + +Event Matching +^^^^^^^^^^^^^^ + +A handler's match callback function decides if an event should be +delivered to this handler, or not. + +An event is routed to no more than one handler. Thus, if a match +function returns true, no further match functions will be invoked for +that event. + +Match functions must not depend on being invocated in any particular +order (e.g., in the handler registration order). + +Events failing to match any handler are dropped, and the +``ev_drop_count`` counter is updated accordingly. + +Event Delivery +^^^^^^^^^^^^^^ + +The handler callbacks are invocated by the dispatcher's service +function, upon the arrival of events to the event ports bound to the +running service lcore. + +A particular event is delivery to at most one handler. + +The application must not depend on all match callback invocations for +a particular event batch being made prior to any process calls are +being made. For example, if the dispatcher dequeues two events from +the event device, it may choose to find out the destination for the +first event, and deliver it, and then continue to find out the +destination for the second, and then deliver that event as well. The +dispatcher may also choose a strategy where no event is delivered +until the destination handler for both events have been determined. + +The events provided in a single process call always belong to the same +event port dequeue burst. + +.. _Event Clustering: + +Event Clustering +^^^^^^^^^^^^^^^^ + +The dispatcher maintains the order of events destined for the same +handler. + +*Order* here refers to the order in which the events were delivered +from the event device to the dispatcher (i.e., in the event array +populated by ``rte_event_dequeue_burst()``), in relation to the order +in which the dispatcher deliveres these events to the application. + +The dispatcher *does not* guarantee to maintain the order of events +delivered to *different* handlers. + +For example, assume that ``MODULE_A_QUEUE_ID`` expands to the value 0, +and ``MODULE_B_STAGE_0_QUEUE_ID`` expands to the value 1. Then +consider a scenario where the following events are dequeued from the +event device (qid is short for event queue id). + +.. code-block:: + + [e0: qid=1], [e1: qid=1], [e2: qid=0], [e3: qid=1] + +The dispatcher may deliver the events in the following manner: + +.. code-block:: + + module_b_stage_0_process([e0: qid=1], [e1: qid=1]) + module_a_process([e2: qid=0]) + module_b_stage_0_process([e2: qid=1]) + +The dispatcher may also choose to cluster (group) all events destined +for ``module_b_stage_0_process()`` into one array: + +.. code-block:: + + module_b_stage_0_process([e0: qid=1], [e1: qid=1], [e3: qid=1]) + module_a_process([e2: qid=0]) + +Here, the event ``e2`` is reordered and placed behind ``e3``, from a +delivery order point of view. This kind of reshuffling is allowed, +since the events are destined for different handlers. + +The dispatcher may also deliver ``e2`` before the three events +destined for module B. + +An example of what the dispatcher may not do, is to reorder event +``e1`` so, that it precedes ``e0`` in the array passed to the module +B's stage 0 process callback. + +Although clustering requires some extra work for the dispatcher, it +leads to fewer process function calls. In addition, and likely more +importantly, it improves temporal locality of memory accesses to +handler-specific data structures in the application, which in turn may +lead to fewer cache misses and improved overall performance. + +Finalize +-------- + +The dispatcher may be configured to notify one or more parts of the +application when the matching and processing of a batch of events has +completed. + +The ``rte_dispatcher_finalize_register`` call is used to +register a finalize callback. The function +``rte_dispatcher_finalize_unregister`` is used to remove a +callback. + +The finalize hook may be used by a set of event handlers (in the same +modules, or a set of cooperating modules) sharing an event output +buffer, since it allows for flushing of the buffers at the last +possible moment. In particular, it allows for buffering of +``RTE_EVENT_OP_FORWARD`` events, which must be flushed before the next +``rte_event_dequeue_burst()`` call is made (assuming implicit release +is employed). + +The following is an example with an application-defined event output +buffer (the ``event_buffer``): + +.. code-block:: c + + static void + finalize_batch(uint8_t event_dev_id, uint8_t event_port_id, + void *cb_data) + { + struct event_buffer *buffer = cb_data; + unsigned lcore_id = rte_lcore_id(); + struct event_buffer_lcore *lcore_buffer = + &buffer->lcore_buffer[lcore_id]; + + event_buffer_lcore_flush(lcore_buffer); + } + + /* In the module's initialization code */ + rte_dispatcher_finalize_register(dispatcher, finalize_batch, + shared_event_buffer); + +The dispatcher does not track any relationship between a handler and a +finalize callback, and all finalize callbacks will be called, if (and +only if) at least one event was dequeued from the event device. + +Finalize callback registration and unregistration cannot safely be +done while the dispatcher's service function is running on any lcore. + +Service +------- + +The dispatcher is a DPDK service, and is managed in a manner similar +to other DPDK services (e.g., an Event Timer Adapter). + +Below is an example of how to configure a particular lcore to serve as +a service lcore, and to map an already-configured dispatcher +(identified by ``DISPATCHER_ID``) to that lcore. + +.. code-block:: c + + static void + launch_dispatcher_core(struct rte_dispatcher *dispatcher, + unsigned lcore_id) + { + uint32_t service_id; + + rte_service_lcore_add(lcore_id); + + rte_dispatcher_service_id_get(dispatcher, &service_id); + + rte_service_map_lcore_set(service_id, lcore_id, 1); + + rte_service_lcore_start(lcore_id); + + rte_service_runstate_set(service_id, 1); + } + +As the final step, the dispatcher must be started. + +.. code-block:: c + + rte_dispatcher_start(dispatcher); + + +Multi Service Dispatcher Lcores +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +In an Eventdev application, most (or all) compute-intensive and +performance-sensitive processing is done in an event-driven manner, +where CPU cycles spent on application domain logic is the direct +result of items of work (i.e., ``rte_event`` events) dequeued from an +event device. + +In the light of this, it makes sense to have the dispatcher service be +the only DPDK service on all lcores used for packet processing — at +least in principle. + +However, there is nothing in DPDK that prevents colocating other +services with the dispatcher service on the same lcore. + +Tasks that prior to the introduction of the dispatcher into the +application was performed on the lcore, even though no events were +received, are prime targets for being converted into such auxiliary +services, running on the dispatcher core set. + +An example of such a task would be the management of a per-lcore timer +wheel (i.e., calling ``rte_timer_manage()``). + +For applications employing :doc:`Read-Copy-Update (RCU) ` (or +similar technique), may opt for having quiescent state (e.g., calling +``rte_rcu_qsbr_quiescent()``) signaling factored out into a separate +service, to assure resource reclaimination occurs even in though some +lcores currently do not process any events. + +If more services than the dispatcher service is mapped to a service +lcore, it's important that the other service are well-behaved and +don't interfere with event processing to the extent the system's +throughput and/or latency requirements are at risk of not being met. + +In particular, to avoid jitter, they should have an small upper bound +for the maximum amount of time spent in a single service function +call. + +An example of scenario with a more CPU-heavy colocated service is a +low-lcore count deployment, where the event device lacks the +``RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT`` capability (and thus +require software to feed incoming packets into the event device). In +this case, the best performance may be achieved if the Event Ethernet +RX and/or TX Adapters are mapped to lcores also used by for event +dispatching, since otherwise the adapter lcores would have a lot of +idle CPU cycles. + +.. rubric:: Footnotes + +.. [#Mapping] + Event routing may reasonably be done based on other ``rte_event`` + fields (or even event user data). Indeed, that's the very reason to + have match callback functions, instead of a simple queue + id-to-handler mapping scheme. Queue id-based routing serves well in + a simple example. + +.. [#Port-MT-Safety] + This property (which is a feature, not a bug) is inherited from the + core Eventdev APIs. diff --git a/doc/guides/prog_guide/index.rst b/doc/guides/prog_guide/index.rst index 52a6d9e7aa..ab05bd6074 100644 --- a/doc/guides/prog_guide/index.rst +++ b/doc/guides/prog_guide/index.rst @@ -60,6 +60,7 @@ Programmer's Guide event_ethernet_tx_adapter event_timer_adapter event_crypto_adapter + dispatcher_lib qos_framework power_man packet_classif_access_ctrl