From patchwork Fri Jun 9 07:08:24 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: 128454 X-Patchwork-Delegate: jerinj@marvell.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 CF36342C6A; Fri, 9 Jun 2023 09:15:15 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id E35CD41153; Fri, 9 Jun 2023 09:15:13 +0200 (CEST) Received: from EUR01-DB5-obe.outbound.protection.outlook.com (mail-db5eur01on2055.outbound.protection.outlook.com [40.107.15.55]) by mails.dpdk.org (Postfix) with ESMTP id ED32640A84 for ; Fri, 9 Jun 2023 09:15:12 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=Z4efn5McS0lK1OKNEFssfu+JCDxGOe7FvdLcLxq2xtZgI91khn4byvy4izCm2Ew8nJSZETUOJOiRvp3d4GmlTGG0mBlRzWZwc7SWcy1MHSVxMb4g0WT4xeBtWrre8IQwnSDFwqqo5+6gw8e1KDZECdEhFUc12oaTDj5hYwKWBXgLFVWx3kA7xcMOCVmWpKpQZDmSgluMFRZVSd9as8JntKk6OtMsYKjl2o1Nyql+w31i82/G4I7BTPHIujqtf7Xac9Mr7DqqWCIZItVHbG4KEy+7xYiZOTfqvECRSq0gptzUxIOuIDu3/SB5n/ZXI4nG5EwL6tSeh1xDv2DvJB8flg== 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=8ageEB8gVpMs7XZxyut6gkRorqOf6Q5YkiReaSTCW3s=; b=UE3fvD1cPoAcnFR4hngWCiEwb/E9zMXiyMc+GiYHYpMzqAtSChYJcOvvy61DCD9nix9KuL+8k7J+y2O0ysorFJEvO7ebsOtLXSSomK3Tr0ETpm3Nj4Jri3Lhpl94fTt6nsK3D1K8jb6trKA8Qyv6QkhvJk54MMPv9hYnEtW0/yMHDKkFGCpFkpxc3iBws0zNcQ0ZIC/1mQtfqMBv4djDJc1Y5CsTr4anO3OyHtQMQM8fIChVn8OnIHO+jVr9P00t/2WW7nuUefc5HYeQppsQSsQxTTtevIN0Z1rb549mvJA2az0dL9MvZCgUprh+iNJTchKEkb/TOxvcaL3aPcIY8g== 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=8ageEB8gVpMs7XZxyut6gkRorqOf6Q5YkiReaSTCW3s=; b=ECKmV9kO3gBv9ypRncGB06kfMhjAngfxLJccYTAdw4rCEIETUiNoFJsvD7p242QT2QDlreYnkKWt32xa2BzdIPkbGLCIInpb23BqtpVMVBHVRS9a+EW5uKIjlWSZKjSFCFDDzzN0IXjHKgY5r/6lAMTPizjPtTvGNvOwsw2Rj28= Received: from FR0P281CA0189.DEUP281.PROD.OUTLOOK.COM (2603:10a6:d10:ab::20) by PA4PR07MB7566.eurprd07.prod.outlook.com (2603:10a6:102:c2::17) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6455.32; Fri, 9 Jun 2023 07:15:10 +0000 Received: from VI1EUR02FT014.eop-EUR02.prod.protection.outlook.com (2603:10a6:d10:ab:cafe::89) by FR0P281CA0189.outlook.office365.com (2603:10a6:d10:ab::20) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6500.14 via Frontend Transport; Fri, 9 Jun 2023 07:15:09 +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 VI1EUR02FT014.mail.protection.outlook.com (10.13.61.57) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256) id 15.20.6477.27 via Frontend Transport; Fri, 9 Jun 2023 07:15:10 +0000 Received: from ESESBMB505.ericsson.se (153.88.183.172) by ESESSMB502.ericsson.se (153.88.183.163) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.2507.23; Fri, 9 Jun 2023 09:15:10 +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.23 via Frontend Transport; Fri, 9 Jun 2023 09:15:09 +0200 Received: from breslau.. (seliicwb00002.seli.gic.ericsson.se [10.156.25.100]) by seliicinfr00050.seli.gic.ericsson.se (Postfix) with ESMTP id 04C171C006A; Fri, 9 Jun 2023 09:15:10 +0200 (CEST) From: =?utf-8?q?Mattias_R=C3=B6nnblom?= To: CC: Jerin Jacob , , , , , =?utf-8?q?Mattias_R=C3=B6nnblom?= Subject: [RFC v4 1/3] eventdev: introduce event dispatcher Date: Fri, 9 Jun 2023 09:08:24 +0200 Message-ID: <20230609070826.149336-2-mattias.ronnblom@ericsson.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230609070826.149336-1-mattias.ronnblom@ericsson.com> References: <20230522091628.96236-2-mattias.ronnblom@ericsson.com> <20230609070826.149336-1-mattias.ronnblom@ericsson.com> MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: VI1EUR02FT014:EE_|PA4PR07MB7566:EE_ X-MS-Office365-Filtering-Correlation-Id: d1d6478e-722b-4755-b285-08db68b9430d X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: WCnnwVIP1rC36UngaOSn69wwggNx8GvlJuHmoXzvGMWt+bk41JBlqU2JhqvYAz/YUicSr/nwdvyjiwfgnqsh8lQQTNzCvRThvcW5nUUEO9VLRq29N74J5uxshnN8XeTI1d9nQnL2JL9h+0VADYy+VafMoOUBbYkhoHVo4u0xjdbpxHvDc7S6x7sIV2fbiuL1zFX7loRQTLy2fDWLnA5S2h3A1d1uxa69vmPg4YfO2dzPMQ2eYXyw7UYeTdrjUqdShhYMKJPHVYYbg1reOzYlaWKhWEy56xSRMDcADZXFgr6WmP/Ta5jWt7HJuRWS9PLFNXW5gfyhldjb0/3yNzOQp+VaV2uE2ikii9eU2LJhWkDH6tTOWcKR93/GGPgpbIqC6i2RgE0Fqir01K5wfeCecHKA0ssPhbsbYrFv0a5qQceavZ4RDfmRGBw57WgBV4ZWXXc61VL4QkDEkzmRB2FORx/Ko2rBJAFPLs3Cf4sQn1zU+cYIQPTy3/4EvcOVP9jiQ6Na6hvy7jUj+Vp7hQKSjKF7JEquHBvhvdq6lILQ+Z4N2GBYs7DPhXCPEVoTkRvhP6TM54fL86QNcdJUacQCwoKXzSq9WWMMqMbfnmavrv7903dxRRJ4Q1yfoDDXj/peNrYf9YhuIPtaskyhiyXbX/alObFTVkDpizl78E2v4M3MtWO8W4dnDvhXwAInRi/+zL2bKZ6crX3MPuKXQQteEQbsCKTB39aF1OvhNEFEl/jRthWznNISQX/O3tajxxb8CddrsJuMxs8N+hSrPfOo1OnzqkoReyZZOriHB8UTgtA= 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:(13230028)(4636009)(136003)(346002)(376002)(396003)(39860400002)(451199021)(46966006)(36840700001)(40470700004)(107886003)(6266002)(186003)(26005)(1076003)(2616005)(66574015)(336012)(83380400001)(86362001)(47076005)(82310400005)(6666004)(30864003)(2906002)(54906003)(36756003)(36860700001)(8676002)(82960400001)(82740400003)(40480700001)(6916009)(5660300002)(41300700001)(7636003)(40460700003)(4326008)(356005)(8936002)(478600001)(70206006)(70586007)(316002); DIR:OUT; SFP:1101; X-OriginatorOrg: ericsson.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 09 Jun 2023 07:15:10.5485 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: d1d6478e-722b-4755-b285-08db68b9430d 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: VI1EUR02FT014.eop-EUR02.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: PA4PR07MB7566 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 event dispatcher is to help reduce coupling in an Eventdev-based DPDK application. In addition, the event 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 --- 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. --- lib/eventdev/meson.build | 2 + lib/eventdev/rte_event_dispatcher.c | 770 ++++++++++++++++++++++++++++ lib/eventdev/rte_event_dispatcher.h | 448 ++++++++++++++++ lib/eventdev/version.map | 13 + 4 files changed, 1233 insertions(+) create mode 100644 lib/eventdev/rte_event_dispatcher.c create mode 100644 lib/eventdev/rte_event_dispatcher.h diff --git a/lib/eventdev/meson.build b/lib/eventdev/meson.build index 6edf98dfa5..c0edc744fe 100644 --- a/lib/eventdev/meson.build +++ b/lib/eventdev/meson.build @@ -19,6 +19,7 @@ sources = files( 'rte_event_crypto_adapter.c', 'rte_event_eth_rx_adapter.c', 'rte_event_eth_tx_adapter.c', + 'rte_event_dispatcher.c', 'rte_event_ring.c', 'rte_event_timer_adapter.c', 'rte_eventdev.c', @@ -27,6 +28,7 @@ headers = files( 'rte_event_crypto_adapter.h', 'rte_event_eth_rx_adapter.h', 'rte_event_eth_tx_adapter.h', + 'rte_event_dispatcher.h', 'rte_event_ring.h', 'rte_event_timer_adapter.h', 'rte_eventdev.h', diff --git a/lib/eventdev/rte_event_dispatcher.c b/lib/eventdev/rte_event_dispatcher.c new file mode 100644 index 0000000000..5e5096e2cc --- /dev/null +++ b/lib/eventdev/rte_event_dispatcher.c @@ -0,0 +1,770 @@ +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright(c) 2023 Ericsson AB + */ + +#include +#include + +#include +#include +#include +#include +#include + +#include "eventdev_pmd.h" + +#include + +#define RED_MAX_PORTS_PER_LCORE 4 +#define RED_MAX_HANDLERS 32 +#define RED_MAX_FINALIZERS 16 +#define RED_AVG_PRIO_INTERVAL 2000 + +struct rte_event_dispatcher_lcore_port { + uint8_t port_id; + uint16_t batch_size; + uint64_t timeout; +}; + +struct rte_event_dispatcher_handler { + int id; + rte_event_dispatcher_match_t match_fun; + void *match_data; + rte_event_dispatcher_process_t process_fun; + void *process_data; +}; + +struct rte_event_dispatcher_finalizer { + int id; + rte_event_dispatcher_finalize_t finalize_fun; + void *finalize_data; +}; + +struct rte_event_dispatcher_lcore { + uint8_t num_ports; + uint16_t num_handlers; + int32_t prio_count; + struct rte_event_dispatcher_lcore_port ports[RED_MAX_PORTS_PER_LCORE]; + struct rte_event_dispatcher_handler handlers[RED_MAX_HANDLERS]; + struct rte_event_dispatcher_stats stats; +} __rte_cache_aligned; + +struct rte_event_dispatcher { + uint8_t id; + uint8_t event_dev_id; + int socket_id; + uint32_t service_id; + struct rte_event_dispatcher_lcore lcores[RTE_MAX_LCORE]; + uint16_t num_finalizers; + struct rte_event_dispatcher_finalizer finalizers[RED_MAX_FINALIZERS]; +}; + +static struct rte_event_dispatcher *dispatchers[UINT8_MAX]; + +static bool +red_has_dispatcher(uint8_t id) +{ + return dispatchers[id] != NULL; +} + +static struct rte_event_dispatcher * +red_get_dispatcher(uint8_t id) +{ + return dispatchers[id]; +} + +static void +red_set_dispatcher(uint8_t id, struct rte_event_dispatcher *dispatcher) +{ + dispatchers[id] = dispatcher; +} + +#define RED_VALID_ID_OR_RET_EINVAL(id) \ + do { \ + if (unlikely(!red_has_dispatcher(id))) { \ + RTE_EDEV_LOG_ERR("Invalid dispatcher id %d\n", id); \ + return -EINVAL; \ + } \ + } while (0) + +static int +red_lookup_handler_idx(struct rte_event_dispatcher_lcore *lcore, + const struct rte_event *event) +{ + uint16_t i; + + for (i = 0; i < lcore->num_handlers; i++) { + struct rte_event_dispatcher_handler *handler = + &lcore->handlers[i]; + + if (handler->match_fun(event, handler->match_data)) + return i; + } + + return -1; +} + +static void +red_prioritize_handler(struct rte_event_dispatcher_lcore *lcore, + int handler_idx) +{ + struct rte_event_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 +red_consider_prioritize_handler(struct rte_event_dispatcher_lcore *lcore, + int handler_idx, uint16_t handler_events) +{ + lcore->prio_count -= handler_events; + + if (unlikely(lcore->prio_count <= 0)) { + red_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(RED_AVG_PRIO_INTERVAL) + + RED_AVG_PRIO_INTERVAL / 2; + } +} + +static inline void +red_dispatch_events(struct rte_event_dispatcher *dispatcher, + struct rte_event_dispatcher_lcore *lcore, + struct rte_event_dispatcher_lcore_port *port, + struct rte_event *events, uint16_t num_events) +{ + int i; + struct rte_event bursts[RED_MAX_HANDLERS][num_events]; + uint16_t burst_lens[RED_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 = red_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_event_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. + */ + red_consider_prioritize_handler(lcore, i, len); + } + + lcore->stats.ev_dispatch_count += dispatch_count; + lcore->stats.ev_drop_count += drop_count; + + for (i = 0; i < dispatcher->num_finalizers; i++) { + struct rte_event_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 +red_port_dequeue(struct rte_event_dispatcher *dispatcher, + struct rte_event_dispatcher_lcore *lcore, + struct rte_event_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)) + red_dispatch_events(dispatcher, lcore, port, events, n); + + lcore->stats.poll_count++; + + return n; +} + +static __rte_always_inline uint16_t +red_lcore_process(struct rte_event_dispatcher *dispatcher, + struct rte_event_dispatcher_lcore *lcore) +{ + uint16_t i; + uint16_t event_count = 0; + + for (i = 0; i < lcore->num_ports; i++) { + struct rte_event_dispatcher_lcore_port *port = + &lcore->ports[i]; + + event_count += red_port_dequeue(dispatcher, lcore, port); + } + + return event_count; +} + +static int32_t +red_process(void *userdata) +{ + struct rte_event_dispatcher *dispatcher = userdata; + unsigned int lcore_id = rte_lcore_id(); + struct rte_event_dispatcher_lcore *lcore = + &dispatcher->lcores[lcore_id]; + uint64_t event_count; + + event_count = red_lcore_process(dispatcher, lcore); + + if (unlikely(event_count == 0)) + return -EAGAIN; + + return 0; +} + +static int +red_service_register(struct rte_event_dispatcher *dispatcher) +{ + struct rte_service_spec service = { + .callback = red_process, + .callback_userdata = dispatcher, + .capabilities = RTE_SERVICE_CAP_MT_SAFE, + .socket_id = dispatcher->socket_id + }; + int rc; + + snprintf(service.name, RTE_SERVICE_NAME_MAX - 1, "red_%d", + dispatcher->id); + + rc = rte_service_component_register(&service, &dispatcher->service_id); + + if (rc) + RTE_EDEV_LOG_ERR("Registration of event dispatcher service " + "%s failed with error code %d\n", + service.name, rc); + + return rc; +} + +static int +red_service_unregister(struct rte_event_dispatcher *dispatcher) +{ + int rc; + + rc = rte_service_component_unregister(dispatcher->service_id); + + if (rc) + RTE_EDEV_LOG_ERR("Unregistration of event dispatcher service " + "failed with error code %d\n", rc); + + return rc; +} + +int +rte_event_dispatcher_create(uint8_t id, uint8_t event_dev_id) +{ + int socket_id; + struct rte_event_dispatcher *dispatcher; + int rc; + + if (red_has_dispatcher(id)) { + RTE_EDEV_LOG_ERR("Dispatcher with id %d already exists\n", + id); + return -EEXIST; + } + + socket_id = rte_event_dev_socket_id(event_dev_id); + + dispatcher = + rte_malloc_socket("event dispatcher", + sizeof(struct rte_event_dispatcher), + RTE_CACHE_LINE_SIZE, socket_id); + + if (dispatcher == NULL) { + RTE_EDEV_LOG_ERR("Unable to allocate memory for event " + "dispatcher\n"); + return -ENOMEM; + } + + *dispatcher = (struct rte_event_dispatcher) { + .id = id, + .event_dev_id = event_dev_id, + .socket_id = socket_id + }; + + rc = red_service_register(dispatcher); + + if (rc < 0) { + rte_free(dispatcher); + return rc; + } + + red_set_dispatcher(id, dispatcher); + + return 0; +} + +int +rte_event_dispatcher_free(uint8_t id) +{ + struct rte_event_dispatcher *dispatcher; + int rc; + + RED_VALID_ID_OR_RET_EINVAL(id); + dispatcher = red_get_dispatcher(id); + + rc = red_service_unregister(dispatcher); + + if (rc) + return rc; + + red_set_dispatcher(id, NULL); + + rte_free(dispatcher); + + return 0; +} + +int +rte_event_dispatcher_service_id_get(uint8_t id, uint32_t *service_id) +{ + struct rte_event_dispatcher *dispatcher; + + RED_VALID_ID_OR_RET_EINVAL(id); + dispatcher = red_get_dispatcher(id); + + *service_id = dispatcher->service_id; + + return 0; +} + +static int +lcore_port_index(struct rte_event_dispatcher_lcore *lcore, + uint8_t event_port_id) +{ + uint16_t i; + + for (i = 0; i < lcore->num_ports; i++) { + struct rte_event_dispatcher_lcore_port *port = + &lcore->ports[i]; + + if (port->port_id == event_port_id) + return i; + } + + return -1; +} + +int +rte_event_dispatcher_bind_port_to_lcore(uint8_t id, uint8_t event_port_id, + uint16_t batch_size, uint64_t timeout, + unsigned int lcore_id) +{ + struct rte_event_dispatcher *dispatcher; + struct rte_event_dispatcher_lcore *lcore; + struct rte_event_dispatcher_lcore_port *port; + + RED_VALID_ID_OR_RET_EINVAL(id); + dispatcher = red_get_dispatcher(id); + + lcore = &dispatcher->lcores[lcore_id]; + + if (lcore->num_ports == RED_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_event_dispatcher_lcore_port) { + .port_id = event_port_id, + .batch_size = batch_size, + .timeout = timeout + }; + + lcore->num_ports++; + + return 0; +} + +int +rte_event_dispatcher_unbind_port_from_lcore(uint8_t id, uint8_t event_port_id, + unsigned int lcore_id) +{ + struct rte_event_dispatcher *dispatcher; + struct rte_event_dispatcher_lcore *lcore; + int port_idx; + struct rte_event_dispatcher_lcore_port *port; + struct rte_event_dispatcher_lcore_port *last; + + RED_VALID_ID_OR_RET_EINVAL(id); + dispatcher = red_get_dispatcher(id); + + 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_event_dispatcher_handler* +red_lcore_get_handler_by_id(struct rte_event_dispatcher_lcore *lcore, + int handler_id) +{ + int i; + + for (i = 0; i < lcore->num_handlers; i++) { + struct rte_event_dispatcher_handler *handler = + &lcore->handlers[i]; + + if (handler->id == handler_id) + return handler; + } + + return NULL; +} + +static int +red_alloc_handler_id(struct rte_event_dispatcher *dispatcher) +{ + int handler_id = 0; + struct rte_event_dispatcher_lcore *reference_lcore = + &dispatcher->lcores[0]; + + if (reference_lcore->num_handlers == RED_MAX_HANDLERS) + return -1; + + while (red_lcore_get_handler_by_id(reference_lcore, handler_id) != NULL) + handler_id++; + + return handler_id; +} + +static void +red_lcore_install_handler(struct rte_event_dispatcher_lcore *lcore, + const struct rte_event_dispatcher_handler *handler) +{ + int handler_idx = lcore->num_handlers; + + lcore->handlers[handler_idx] = *handler; + lcore->num_handlers++; +} + +static void +red_install_handler(struct rte_event_dispatcher *dispatcher, + const struct rte_event_dispatcher_handler *handler) +{ + int i; + + for (i = 0; i < RTE_MAX_LCORE; i++) { + struct rte_event_dispatcher_lcore *lcore = + &dispatcher->lcores[i]; + red_lcore_install_handler(lcore, handler); + } +} + +int +rte_event_dispatcher_register(uint8_t id, + rte_event_dispatcher_match_t match_fun, + void *match_data, + rte_event_dispatcher_process_t process_fun, + void *process_data) +{ + struct rte_event_dispatcher *dispatcher; + struct rte_event_dispatcher_handler handler = { + .match_fun = match_fun, + .match_data = match_data, + .process_fun = process_fun, + .process_data = process_data + }; + + RED_VALID_ID_OR_RET_EINVAL(id); + dispatcher = red_get_dispatcher(id); + + handler.id = red_alloc_handler_id(dispatcher); + + if (handler.id < 0) + return -ENOMEM; + + red_install_handler(dispatcher, &handler); + + return handler.id; +} + +static int +red_lcore_uninstall_handler(struct rte_event_dispatcher_lcore *lcore, + int handler_id) +{ + struct rte_event_dispatcher_handler *unreg_handler; + int handler_idx; + uint16_t last_idx; + + unreg_handler = red_lcore_get_handler_by_id(lcore, handler_id); + + if (unreg_handler == NULL) + return -EINVAL; + + handler_idx = &lcore->handlers[0] - unreg_handler; + + 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_event_dispatcher_handler) * n); + } + + lcore->num_handlers--; + + return 0; +} + +static int +red_uninstall_handler(struct rte_event_dispatcher *dispatcher, + int handler_id) +{ + unsigned int lcore_id; + + for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) { + struct rte_event_dispatcher_lcore *lcore = + &dispatcher->lcores[lcore_id]; + int rc; + + rc = red_lcore_uninstall_handler(lcore, handler_id); + + if (rc < 0) + return rc; + } + + return 0; +} + +int +rte_event_dispatcher_unregister(uint8_t id, int handler_id) +{ + struct rte_event_dispatcher *dispatcher; + int rc; + + RED_VALID_ID_OR_RET_EINVAL(id); + dispatcher = red_get_dispatcher(id); + + rc = red_uninstall_handler(dispatcher, handler_id); + + return rc; +} + +static struct rte_event_dispatcher_finalizer* +red_get_finalizer_by_id(struct rte_event_dispatcher *dispatcher, + int handler_id) +{ + int i; + + for (i = 0; i < dispatcher->num_finalizers; i++) { + struct rte_event_dispatcher_finalizer *finalizer = + &dispatcher->finalizers[i]; + + if (finalizer->id == handler_id) + return finalizer; + } + + return NULL; +} + +static int +red_alloc_finalizer_id(struct rte_event_dispatcher *dispatcher) +{ + int finalizer_id = 0; + + while (red_get_finalizer_by_id(dispatcher, finalizer_id) != NULL) + finalizer_id++; + + return finalizer_id; +} + +static struct rte_event_dispatcher_finalizer * +red_alloc_finalizer(struct rte_event_dispatcher *dispatcher) +{ + int finalizer_idx; + struct rte_event_dispatcher_finalizer *finalizer; + + if (dispatcher->num_finalizers == RED_MAX_FINALIZERS) + return NULL; + + finalizer_idx = dispatcher->num_finalizers; + finalizer = &dispatcher->finalizers[finalizer_idx]; + + finalizer->id = red_alloc_finalizer_id(dispatcher); + + dispatcher->num_finalizers++; + + return finalizer; +} + +int +rte_event_dispatcher_finalize_register(uint8_t id, + rte_event_dispatcher_finalize_t finalize_fun, + void *finalize_data) +{ + struct rte_event_dispatcher *dispatcher; + struct rte_event_dispatcher_finalizer *finalizer; + + RED_VALID_ID_OR_RET_EINVAL(id); + dispatcher = red_get_dispatcher(id); + + finalizer = red_alloc_finalizer(dispatcher); + + if (finalizer == NULL) + return -ENOMEM; + + finalizer->finalize_fun = finalize_fun; + finalizer->finalize_data = finalize_data; + + return finalizer->id; +} + +int +rte_event_dispatcher_finalize_unregister(uint8_t id, int handler_id) +{ + struct rte_event_dispatcher *dispatcher; + struct rte_event_dispatcher_finalizer *unreg_finalizer; + int handler_idx; + uint16_t last_idx; + + RED_VALID_ID_OR_RET_EINVAL(id); + dispatcher = red_get_dispatcher(id); + + unreg_finalizer = red_get_finalizer_by_id(dispatcher, handler_id); + + if (unreg_finalizer == NULL) + return -EINVAL; + + handler_idx = &dispatcher->finalizers[0] - unreg_finalizer; + + last_idx = dispatcher->num_finalizers - 1; + + if (handler_idx != last_idx) { + /* move all finalizers to maintain finalizer order */ + int n = last_idx - handler_idx; + memmove(unreg_finalizer, unreg_finalizer + 1, + sizeof(struct rte_event_dispatcher_finalizer) * n); + } + + dispatcher->num_finalizers--; + + return 0; +} + +static void +red_aggregate_stats(struct rte_event_dispatcher_stats *result, + const struct rte_event_dispatcher_stats *part) +{ + result->poll_count += part->poll_count; + result->ev_dispatch_count += part->ev_dispatch_count; + result->ev_drop_count += part->ev_drop_count; +} + +int +rte_event_dispatcher_stats_get(uint8_t id, + struct rte_event_dispatcher_stats *stats) +{ + struct rte_event_dispatcher *dispatcher; + unsigned int lcore_id; + + RED_VALID_ID_OR_RET_EINVAL(id); + dispatcher = red_get_dispatcher(id); + + *stats = (struct rte_event_dispatcher_stats) {}; + + for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) { + struct rte_event_dispatcher_lcore *lcore = + &dispatcher->lcores[lcore_id]; + + red_aggregate_stats(stats, &lcore->stats); + } + + return 0; +} + +static int +red_set_service_runstate(uint8_t id, int state) +{ + struct rte_event_dispatcher *dispatcher; + int rc; + + RED_VALID_ID_OR_RET_EINVAL(id); + dispatcher = red_get_dispatcher(id); + + 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_event_dispatcher_start(uint8_t id) +{ + return red_set_service_runstate(id, 1); +} + +int +rte_event_dispatcher_stop(uint8_t id) +{ + return red_set_service_runstate(id, 0); +} diff --git a/lib/eventdev/rte_event_dispatcher.h b/lib/eventdev/rte_event_dispatcher.h new file mode 100644 index 0000000000..927e7e0b3c --- /dev/null +++ b/lib/eventdev/rte_event_dispatcher.h @@ -0,0 +1,448 @@ +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright(c) 2023 Ericsson AB + */ + +#ifndef __RTE_EVENT_DISPATCHER_H__ +#define __RTE_EVENT_DISPATCHER_H__ + +/** + * @file + * + * RTE Event Dispatcher + * + * The purpose of the event 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 + +/** + * Function prototype for match callbacks. + * + * Match callbacks are used by an application to decide how the + * event 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_event_dispatcher_register(). + * + * @return + * Returns true in case this events should be delivered (via + * the process callback), and false otherwise. + */ +typedef bool +(*rte_event_dispatcher_match_t)(const struct rte_event *event, void *cb_data); + +/** + * Function prototype for process callbacks. + * + * The process callbacks are used by the event 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_event_dispatcher_register(). + */ + +typedef void +(*rte_event_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 event 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_event_dispatcher_finalize_register(). + */ + +typedef void +(*rte_event_dispatcher_finalize_t)(uint8_t event_dev_id, uint8_t event_port_id, + void *cb_data); + +/** + * Event dispatcher statistics + */ +struct rte_event_dispatcher_stats { + uint64_t poll_count; + /**< Number of event dequeue calls made toward the event device. */ + uint64_t ev_dispatch_count; + /**< Number of events dispatched to a handler.*/ + uint64_t ev_drop_count; + /**< Number of events dropped because no handler was found. */ +}; + +/** + * Create an event dispatcher with the specified id. + * + * @param id + * An application-specified, unique (across all event dispatcher + * instances) identifier. + * + * @param event_dev_id + * The identifier of the event device from which this event dispatcher + * will dequeue events. + * + * @return + * - 0: Success + * - <0: Error code on failure + */ +__rte_experimental +int +rte_event_dispatcher_create(uint8_t id, uint8_t event_dev_id); + +/** + * Free an event dispatcher. + * + * @param id + * The event dispatcher identifier. + * + * @return + * - 0: Success + * - <0: Error code on failure + */ +__rte_experimental +int +rte_event_dispatcher_free(uint8_t id); + +/** + * Retrieve the service identifier of an event dispatcher. + * + * @param id + * The event dispatcher identifier. + * + * @param [out] service_id + * A pointer to a caller-supplied buffer where the event dispatcher's + * service id will be stored. + * + * @return + * - 0: Success + * - <0: Error code on failure. + */ +__rte_experimental +int +rte_event_dispatcher_service_id_get(uint8_t id, uint32_t *service_id); + +/** + * Binds an event device port to a specific lcore on the specified + * event 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 event dispatcher service is mapped (with + * rte_service_map_lcore_set()) to a lcore for which no ports are + * bound, the service function will be a no-operation. + * + * This function is not MT safe. + * + * @param id + * The event dispatcher identifier. + * + * @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_event_dispatcher_bind_port_to_lcore(uint8_t id, 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 is not MT safe. + * + * @param id + * The event dispatcher identifier. + * + * @param event_port_id + * The event device port identifier. + * + * @param lcore_id + * The lcore which was using this event port. + * + * @return + * - 0: Success + * - -EINVAL: Invalid @c id. + * - -ENOENT: Event port id not bound to this @c lcore_id. + */ +__rte_experimental +int +rte_event_dispatcher_unbind_port_from_lcore(uint8_t id, 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 event 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 + * event dispatcher may choose to deliver first [ev0, ev2] using A's + * deliver function, and then [ev1] to B - or vice versa. + * + * rte_event_dispatcher_register() is not MT safe. + * + * @param id + * The event dispatcher identifier. + * + * @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_event_dispatcher_register(uint8_t id, + rte_event_dispatcher_match_t match_fun, + void *match_cb_data, + rte_event_dispatcher_process_t process_fun, + void *process_cb_data); + +/** + * Unregister an event handler. + * + * This function is not MT safe. + * + * @param id + * The event dispatcher identifier. + * + * @param handler_id + * The handler registration id returned by the original + * rte_event_dispatcher_register() call. + * + * @return + * - 0: Success + * - -EINVAL: The @c id and/or the @c handler_id parameter was invalid. + */ +__rte_experimental +int +rte_event_dispatcher_unregister(uint8_t id, 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 event 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_event_dispatcher_finalize_register() is not MT safe. + * + * @param id + * The event dispatcher identifier. + * + * @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_event_dispatcher_finalize_register(uint8_t id, + rte_event_dispatcher_finalize_t finalize_fun, + void *finalize_data); + +/** + * Unregister a finalize callback. + * + * This function is not MT safe. + * + * @param id + * The event dispatcher identifier. + * + * @param reg_id + * The finalize registration id returned by the original + * rte_event_dispatcher_finalize_register() call. + * + * @return + * - 0: Success + * - -EINVAL: The @c id and/or the @c reg_id parameter was invalid. + */ +__rte_experimental +int +rte_event_dispatcher_finalize_unregister(uint8_t id, int reg_id); + +/** + * Start an event dispatcher instance. + * + * Enables the event dispatcher service. + * + * The underlying event device must have been started prior to calling + * rte_event_dispatcher_start(). + * + * For the event 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'. An event dispatcher's + * service is retrieved using rte_event_dispatcher_service_id_get(). + * + * Each service lcore to which the event dispatcher is mapped should + * have at least one event port configured. Such configuration is + * performed by calling rte_event_dispatcher_bind_port_to_lcore(), + * prior to starting the event dispatcher. + * + * @param id + * The event dispatcher identifier. + * + * @return + * - 0: Success + * - -EINVAL: Invalid @c id. + */ +__rte_experimental +int +rte_event_dispatcher_start(uint8_t id); + +/** + * Stop a running event dispatcher instance. + * + * Disables the event dispatcher service. + * + * @param id + * The event dispatcher identifier. + * + * @return + * - 0: Success + * - -EINVAL: Invalid @c id. + */ +__rte_experimental +int +rte_event_dispatcher_stop(uint8_t id); + +/** + * Retrieve statistics for an event dispatcher instance. + * + * This function is MT safe and may be called from any thread + * (including unregistered non-EAL threads). + * + * @param id + * The event dispatcher identifier. + * @param[out] stats + * A pointer to a structure to fill with statistics. + * @return + * - 0: Success + * - -EINVAL: The @c id parameter was invalid. + */ +__rte_experimental +int +rte_event_dispatcher_stats_get(uint8_t id, + struct rte_event_dispatcher_stats *stats); + +#ifdef __cplusplus +} +#endif + +#endif /* __RTE_EVENT_DISPATCHER__ */ diff --git a/lib/eventdev/version.map b/lib/eventdev/version.map index 89068a5713..d3aa878686 100644 --- a/lib/eventdev/version.map +++ b/lib/eventdev/version.map @@ -131,6 +131,19 @@ EXPERIMENTAL { rte_event_eth_tx_adapter_runtime_params_init; rte_event_eth_tx_adapter_runtime_params_set; rte_event_timer_remaining_ticks_get; + + rte_event_dispatcher_create; + rte_event_dispatcher_free; + rte_event_dispatcher_service_id_get; + rte_event_dispatcher_bind_port_to_lcore; + rte_event_dispatcher_unbind_port_from_lcore; + rte_event_dispatcher_register; + rte_event_dispatcher_unregister; + rte_event_dispatcher_finalize_register; + rte_event_dispatcher_finalize_unregister; + rte_event_dispatcher_start; + rte_event_dispatcher_stop; + rte_event_dispatcher_stats_get; }; INTERNAL { From patchwork Fri Jun 9 07:08:25 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: 128455 X-Patchwork-Delegate: jerinj@marvell.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 EF56F42C6A; Fri, 9 Jun 2023 09:15:24 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 6CF1442D2C; Fri, 9 Jun 2023 09:15:16 +0200 (CEST) Received: from EUR04-VI1-obe.outbound.protection.outlook.com (mail-vi1eur04on2040.outbound.protection.outlook.com [40.107.8.40]) by mails.dpdk.org (Postfix) with ESMTP id 3D91B42D1D for ; Fri, 9 Jun 2023 09:15:15 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=OFyOITdDKYOvqG2ZtbASObZYdZTmW+iDhJULqqh8iYbrr3zfjmKKlzeKEJ59Y/or98iZ9vj7yR1PSKQBUFdwk6FTSZZ3ZwueddtZKQptA+n6YAIzh868rXk2LMryZ10T96MGgVW483NZQAOqwDUiv9n/fAf+7jFAiZiaNFOjNVM6nwcjPu8duOlzYLO/70P9aWp1M7hGOpKwQmivyx1SEtNl/v6X3LrYEDcQYjLW51dimCvYXA5svbppDL74a9uj1JnxRTg3upI5cTLUYLmc3gTxKOzpsUsYSKFilvUJ75KlKzG2vOtJ8Ms9LDXwwO71uRNrvWeaPYS7ZLg4Pv8XKA== 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=NUZ6aBGBx+/qyG5/eJZsAZr1zriC4GlWiIIXJv9bs2M=; b=O2tBJMP0vh3WZu+3e14ryzYUjunaPd1YWMHe7pczV2tXEHnNoIZ/hXSjqWrwaIUJFdkqzXNrY5F2nalnZlFyIy80OipU0fMw4AtTGo9wNOjFyFmRIeWwWxb62StlTTffyHkYdNlroP3GWaf49eyjTyk1e9ztFy/NxnstqpBTfztS70NW7plC9eP034uiPPe3ruX4J0ZipMYVHnaEm5WxceZPDjg539ZyWyKQL3TVmyS1WmEZg3O+WoUZncBEi4xhXRK1VYwk1NemzYKdPZpLEIKdx391TrOT5jWkeyNWh2h/r9Wj6qn2cH5rxf/AMCZcr4Y3RC1S5swVy9DktZSElQ== 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=NUZ6aBGBx+/qyG5/eJZsAZr1zriC4GlWiIIXJv9bs2M=; b=BVyTmez+1BHhWkAztYrqFuEUnIIXNRPiYx8JNwTJ4bXLHMSfKSeqjwiMyZz84G5Aq5eKCEyKxzBcvL3gZlwXfmjfcYp5DILjrznVzwGPwQkfEd3dUsMABTfdtMaeI6WwTW163osgViMgr+3YVT5iidU76TSxkE4xgyPrxRFHyIQ= Received: from DUZPR01CA0098.eurprd01.prod.exchangelabs.com (2603:10a6:10:4bb::29) by PR3PR07MB6521.eurprd07.prod.outlook.com (2603:10a6:102:66::23) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6455.32; Fri, 9 Jun 2023 07:15:13 +0000 Received: from DB5EUR02FT039.eop-EUR02.prod.protection.outlook.com (2603:10a6:10:4bb:cafe::e1) by DUZPR01CA0098.outlook.office365.com (2603:10a6:10:4bb::29) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6477.27 via Frontend Transport; Fri, 9 Jun 2023 07:15:13 +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 DB5EUR02FT039.mail.protection.outlook.com (10.13.58.107) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256) id 15.20.6477.27 via Frontend Transport; Fri, 9 Jun 2023 07:15:13 +0000 Received: from ESESSMB504.ericsson.se (153.88.183.165) 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.23; Fri, 9 Jun 2023 09:15:11 +0200 Received: from seliicinfr00050.seli.gic.ericsson.se (153.88.183.153) by smtp.internal.ericsson.com (153.88.183.192) with Microsoft SMTP Server id 15.1.2507.23 via Frontend Transport; Fri, 9 Jun 2023 09:15:12 +0200 Received: from breslau.. (seliicwb00002.seli.gic.ericsson.se [10.156.25.100]) by seliicinfr00050.seli.gic.ericsson.se (Postfix) with ESMTP id 3A0DD1C006A; Fri, 9 Jun 2023 09:15:12 +0200 (CEST) From: =?utf-8?q?Mattias_R=C3=B6nnblom?= To: CC: Jerin Jacob , , , , , =?utf-8?q?Mattias_R=C3=B6nnblom?= Subject: [RFC v4 2/3] test: add event dispatcher test suite Date: Fri, 9 Jun 2023 09:08:25 +0200 Message-ID: <20230609070826.149336-3-mattias.ronnblom@ericsson.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230609070826.149336-1-mattias.ronnblom@ericsson.com> References: <20230522091628.96236-2-mattias.ronnblom@ericsson.com> <20230609070826.149336-1-mattias.ronnblom@ericsson.com> MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: DB5EUR02FT039:EE_|PR3PR07MB6521:EE_ X-MS-Office365-Filtering-Correlation-Id: 3f8172e9-dac8-40b4-0302-08db68b944d6 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: av1KMprzECoaHkovl7ots/RguBtlhDfX6oW7VSI7ieNFVBe+l8E//gY+3MEkGXrIZxYuDF97X+cCDLbwwUxy89xFSGgGYG+hZAmZ00vElqSybYMmVOPsMeldgqRNec/k6Lsm91RI4Fs0xaTd33yWOQ/e/Nobatgz7rn8mNEnv4/ZO10O2jFmXwSuWhKX+o+ONAXAs8j10tQiGehi6ZFrt4dqjgDANLnS1JruEho7kG/wFwQDk/O+Nue7g2FDY8pEMAgGOZazlshCPVRlztvxasHwkDx+AR8U7m368sSqc/mzYYoidbdlnUKV+GMvn3ifmaIc1oge470NeJPEvMwULu3QCLfxKVriXElmJxpBRph1nf697T7fkEMK8pVL6D0/Yi3nPctmaaGb+COR+HkE6AnobOVRXsd4O1O7E8Mp/4Czdfb3ucd+NPgXciiUEyQDF3Mz0PhwbWeYSLZpolE7JufJW2QIqXKS+VCDajxGDuY7h3pt3aXIKxKvj2grhrFkQck8a6uR1CapcUXGea8vV117knBqvClRp46/1wc8b1De8NdIYNoZwS6pg9Mq5SeqZNqVSnnFd241I1xDrFKz8I7Isc00qcL4XcphDkKbbki84ugjPOEecohbHH98Qov9ZV7YV97T4kQFBO+KtnO4FMLK+vOJv5Ptdwfo0WJ8i0gnC/E4ysisnxsGsc01Ws56QDLuSQdukqMSIoTjAOPn7ext1QnCvz393WwHkaDzHskU0YYGBmVpeVZwvCVa/sdy 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:(13230028)(4636009)(346002)(136003)(39860400002)(396003)(376002)(451199021)(40470700004)(36840700001)(46966006)(26005)(107886003)(1076003)(2616005)(336012)(6266002)(47076005)(66574015)(83380400001)(186003)(82310400005)(36860700001)(6666004)(82960400001)(70206006)(82740400003)(70586007)(7636003)(2906002)(356005)(30864003)(54906003)(40460700003)(5660300002)(36756003)(8676002)(8936002)(4326008)(41300700001)(86362001)(478600001)(316002)(6916009)(40480700001); DIR:OUT; SFP:1101; X-OriginatorOrg: ericsson.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 09 Jun 2023 07:15:13.5234 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 3f8172e9-dac8-40b4-0302-08db68b944d6 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: DB5EUR02FT039.eop-EUR02.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: PR3PR07MB6521 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 event dispatcher. --- RFC v4: Adapt to non-const events in process function prototype. Signed-off-by: Mattias Rönnblom --- app/test/meson.build | 1 + app/test/test_event_dispatcher.c | 814 +++++++++++++++++++++++++++++++ 2 files changed, 815 insertions(+) create mode 100644 app/test/test_event_dispatcher.c diff --git a/app/test/meson.build b/app/test/meson.build index b9b5432496..fac3b6b88b 100644 --- a/app/test/meson.build +++ b/app/test/meson.build @@ -50,6 +50,7 @@ test_sources = files( 'test_errno.c', 'test_ethdev_link.c', 'test_event_crypto_adapter.c', + 'test_event_dispatcher.c', 'test_event_eth_rx_adapter.c', 'test_event_ring.c', 'test_event_timer_adapter.c', diff --git a/app/test/test_event_dispatcher.c b/app/test/test_event_dispatcher.c new file mode 100644 index 0000000000..a6ce430e21 --- /dev/null +++ b/app/test/test_event_dispatcher.c @@ -0,0 +1,814 @@ +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright(c) 2023 Ericsson AB + */ + +#include "test.h" + +#include + +#include +#include +#include +#include +#include + +#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 test_app { + uint8_t event_dev_id; + uint8_t dispatcher_id; + uint32_t dispatcher_service_id; + + unsigned int service_lcores[NUM_SERVICE_CORES]; + + struct app_queue queues[NUM_QUEUES]; + + bool running; + + atomic_int completed_events; + atomic_int errors; +}; + +#define RETURN_ON_ERROR(rc) \ + do { \ + if (rc != TEST_SUCCESS) \ + return rc; \ + } while (0) + +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_id = rte_rand_max(256); + + rc = rte_event_dispatcher_create(app->dispatcher_id, + app->event_dev_id); + + TEST_ASSERT_SUCCESS(rc, "Unable to create event dispatcher"); + + rc = rte_event_dispatcher_service_id_get(app->dispatcher_id, + &app->dispatcher_service_id); + TEST_ASSERT_SUCCESS(rc, "Unable to get event dispatcher service ID"); + + 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, "Error disabling dispatcher service"); + + 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"); + + rte_event_dispatcher_free(app->dispatcher_id); + + return TEST_SUCCESS; +} + +static int +test_app_bind_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_event_dispatcher_bind_port_to_lcore( + app->dispatcher_id, WORKER_PORT_ID(i), + DEQUEUE_BURST_SIZE, 0, lcore_id + ); + + TEST_ASSERT_SUCCESS(rc, "Unable to bind event device port %d " + "to lcore %d", WORKER_PORT_ID(i), + lcore_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_event_dispatcher_unbind_port_from_lcore( + app->dispatcher_id, + 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) +{ + atomic_fetch_add_explicit(&app->errors, 1, 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 + atomic_fetch_add_explicit(&app->completed_events, num, + memory_order_relaxed); +} + +static int +test_app_register_callbacks(struct test_app *app) +{ + int i; + + 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_event_dispatcher_register(app->dispatcher_id, + 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; + } + + 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; + + if (reg_id < 0) /* unregistered already */ + return 0; + + int rc = rte_event_dispatcher_unregister(app->dispatcher_id, 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; + + for (i = 0; i < NUM_QUEUES; i++) { + int rc; + + rc = test_app_unregister_callback(app, i); + RETURN_ON_ERROR(rc); + } + + return TEST_SUCCESS; +} + +static int +test_app_start_dispatcher(struct test_app *app) +{ + int rc; + + rc = rte_event_dispatcher_start(app->dispatcher_id); + + 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_event_dispatcher_stop(app->dispatcher_id); + + TEST_ASSERT_SUCCESS(rc, "Unable to stop the event dispatcher"); + + 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]); + + RETURN_ON_ERROR(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); + + RETURN_ON_ERROR(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_ON_ERROR(rc); + } + + 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_ON_ERROR(rc); + } + + return TEST_SUCCESS; +} + +static int +test_app_start(struct test_app *app) +{ + int rc; + + rc = test_app_start_event_dev(app); + RETURN_ON_ERROR(rc); + + rc = test_app_start_service_cores(app); + RETURN_ON_ERROR(rc); + + rc = test_app_start_dispatcher(app); + + app->running = true; + + return rc; +} + +static int +test_app_stop(struct test_app *app) +{ + int rc; + + rc = test_app_stop_dispatcher(app); + RETURN_ON_ERROR(rc); + + test_app_stop_service_cores(app); + RETURN_ON_ERROR(rc); + + test_app_stop_event_dev(app); + RETURN_ON_ERROR(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); + RETURN_ON_ERROR(rc); + + rc = test_app_create_dispatcher(test_app); + + rc = test_app_setup_service_cores(test_app); + RETURN_ON_ERROR(rc); + + rc = test_app_register_callbacks(test_app); + RETURN_ON_ERROR(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 atomic_load_explicit(&app->completed_events, + memory_order_relaxed); +} + +static int +test_app_get_errors(struct test_app *app) +{ + return atomic_load_explicit(&app->errors, memory_order_relaxed); +} + +static int +test_basic(void) +{ + int rc; + int i; + + rc = test_app_start(test_app); + RETURN_ON_ERROR(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); + RETURN_ON_ERROR(rc); + + struct rte_event_dispatcher_stats stats; + rc = rte_event_dispatcher_stats_get(test_app->dispatcher_id, + &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"); + + return TEST_SUCCESS; +} + +static int +test_drop(void) +{ + int rc; + uint8_t unhandled_queue = 1; + struct rte_event_dispatcher_stats stats; + + rc = test_app_start(test_app); + RETURN_ON_ERROR(rc); + + rc = test_app_unregister_callback(test_app, unhandled_queue); + RETURN_ON_ERROR(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 { + rc = rte_event_dispatcher_stats_get(test_app->dispatcher_id, + &stats); + RETURN_ON_ERROR(rc); + + 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); + RETURN_ON_ERROR(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; +} + +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_CASES_END() + } +}; + +static int +test_event_dispatcher(void) +{ + return unit_test_suite_runner(&test_suite); +} + +REGISTER_TEST_COMMAND(event_dispatcher_autotest, test_event_dispatcher); From patchwork Fri Jun 9 07:08:26 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: 128456 X-Patchwork-Delegate: jerinj@marvell.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 7603C42C6A; Fri, 9 Jun 2023 09:15:31 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 916D742D0B; Fri, 9 Jun 2023 09:15:19 +0200 (CEST) Received: from EUR02-VI1-obe.outbound.protection.outlook.com (mail-vi1eur02on2077.outbound.protection.outlook.com [40.107.241.77]) by mails.dpdk.org (Postfix) with ESMTP id 673BA41148 for ; Fri, 9 Jun 2023 09:15:18 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=QYKkz8xN30DMZ9pwtVIcrtis3YxHOjfU9eBhIL/L31amLbxbVBLj1ye9jQrZLx/i0qj4B1a7nBDgjIcOFA4YOF1K6lqAZXerKX6dO3O5qlWB9MbAAMJu3cC+ClPc23E/ClWrW8CmIrU247ll/Pz5QCrBVsWasOGljsugaBl6fG/ckbR9Wf8b3ZXiEEaQQ+TmrBho+dRkO7peRBSU08GVJSykAmLG9k38fsJea11ioWo27M1aKOpMGhqzvQ0iLOn3/Rcx11ojpnDjHcq5Ne5ttQYW7HBcGFLTUG+UKG6InXf4EC8syoRGwRwlZQiDoG1oQCA95pnhw6ymKBPMhy08JQ== 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=tgWl1KKJwIi7TpMgT195luBLbXctEfd82RXDACRPTA4=; b=EDgU3g7zs3qiBIW3SFvfHeqLL66dFLHg0vWkJHwSjZkVfWc6N7u05levgv8Gf4MdRSRhNDyQp2bU2VwUvEJmUkWb8v4mDdMj0oqJlBWwyOMCn8aWuPnQFhsV4xgIn4fEZxiU/CTe2NxJyJMOWp14jyzoox0+RmXMN2HpLd34jZ+nT+RhIR8KrQH4iS8Sat1nh+3dz1h1tODhK9dW8RbYfSPpb/xnK8ihK5uvUuzUt+V+BXOd6xi/fG162FWUPLtWS3RgtrJH3VtaKGLcN96KiBkIVNJc+4W50EODZxCXZpfl5ypdLXWqDgiDUh8DDYXmx0fuHsjzoFJ/FO5+1OZSnw== 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=tgWl1KKJwIi7TpMgT195luBLbXctEfd82RXDACRPTA4=; b=PNVt0vI5pQtT/Ja1ruyfsfrqwQ9K3UqL18HjDcBgxfXSFeko1rniXuHxW3h0w2WlZOqP/bD6IzjfuMScTIlR35lAkW9pH+IMFrI8tACrJCFRHGJjwaO5SS0LQNkDRjWo2EAc9XIfvui1IYjJpTG5TnYRFyVEwBgv7A4//KZqIOY= Received: from DUZPR01CA0143.eurprd01.prod.exchangelabs.com (2603:10a6:10:4bd::8) by DU0PR07MB9092.eurprd07.prod.outlook.com (2603:10a6:10:407::12) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6455.39; Fri, 9 Jun 2023 07:15:16 +0000 Received: from DB5EUR02FT006.eop-EUR02.prod.protection.outlook.com (2603:10a6:10:4bd:cafe::55) by DUZPR01CA0143.outlook.office365.com (2603:10a6:10:4bd::8) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6477.27 via Frontend Transport; Fri, 9 Jun 2023 07:15:16 +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 DB5EUR02FT006.mail.protection.outlook.com (10.13.58.161) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256) id 15.20.6477.27 via Frontend Transport; Fri, 9 Jun 2023 07:15:17 +0000 Received: from ESESSMB501.ericsson.se (153.88.183.162) by ESESSMB503.ericsson.se (153.88.183.164) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.2507.23; Fri, 9 Jun 2023 09:15:15 +0200 Received: from seliicinfr00050.seli.gic.ericsson.se (153.88.183.153) by smtp.internal.ericsson.com (153.88.183.189) with Microsoft SMTP Server id 15.1.2507.23 via Frontend Transport; Fri, 9 Jun 2023 09:15:15 +0200 Received: from breslau.. (seliicwb00002.seli.gic.ericsson.se [10.156.25.100]) by seliicinfr00050.seli.gic.ericsson.se (Postfix) with ESMTP id B0F7D1C006A; Fri, 9 Jun 2023 09:15:15 +0200 (CEST) From: =?utf-8?q?Mattias_R=C3=B6nnblom?= To: CC: Jerin Jacob , , , , , =?utf-8?q?Mattias_R=C3=B6nnblom?= Subject: [RFC v4 3/3] doc: add event dispatcher programming guide Date: Fri, 9 Jun 2023 09:08:26 +0200 Message-ID: <20230609070826.149336-4-mattias.ronnblom@ericsson.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230609070826.149336-1-mattias.ronnblom@ericsson.com> References: <20230522091628.96236-2-mattias.ronnblom@ericsson.com> <20230609070826.149336-1-mattias.ronnblom@ericsson.com> MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: DB5EUR02FT006:EE_|DU0PR07MB9092:EE_ X-MS-Office365-Filtering-Correlation-Id: 942ae225-d18d-47b0-77ca-08db68b9471c X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: g0TSe8Ihbg+UsgBH+BTzqFK6wdqJy6LXe/b6yyjUtdezmKSGuXx/tb2RKyQUEcohDZhchStBbGWm7cSKJ3es0LaMr+0AvqCzht5mSxO4HjwmCQGlbTFYMRNHcKathr++2TZE2g6vkfYlsDCUCl8Ta6n9ZUZPDYzuLDE66UUyuzKY6lXGDPf/lpo7OeMKqX9mVHAxTglVkTRDZOHVofIK6j1v0HhYdilXwnlxInzQ27Dg5mttsk908DDu5Z4KdpiWLvlzfPN3J5Nc4dhVssuFNrdt9ilAriRaCI16hkzlo5CkpUJkYtStnduho4W7aFcrrshe75NG/FpiwHn9bJ1U0Re5z7YuHwt7E5vySBhjVdkLbpIdzC7rMtEg5HDZ0CqklFNsTJAR2LOpeZmxSZPasxr48WVfsTvAZ20bwxhimispcdPr7tWqgVVFCeNcFYlgObRhwye3Jvhjz0mhs5KfZfYWyl6lUg0CZ7p3c3DYh/chqn3+AtdoV5xhOQtaLqU+E5V3o3T+5hsk2HLmhyQfZkdgsOuA42e5XKy2ph6PlA01c9081wIFkQTGUVYyRnp6I/afmm4JRq9O42qVEreVxetG57+ub6BN/vPUNLx3HGZKnBbwijrjGdvtqG7n4NY+QMpMCzY4vB2xbmAh/muf+Ryn/k9lQs+8U+2PadJMHNAPj8I8ldM/mU5st1H70r0TXT1hj6k33XIIChkKhtAXhzykeEB2tr8KlUTXoWTAAgYPmHTOPsPi7Hi+BZjCdhI567giUDp9FGM2UaqEKpCYjmNmqWLhJyLCeOi/AkOSOWs= 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:(13230028)(4636009)(136003)(39860400002)(376002)(346002)(396003)(451199021)(40470700004)(36840700001)(46966006)(70586007)(70206006)(8676002)(36756003)(5660300002)(8936002)(6666004)(66899021)(6916009)(4326008)(478600001)(54906003)(336012)(41300700001)(40460700003)(316002)(40480700001)(82960400001)(82740400003)(7636003)(356005)(6266002)(47076005)(107886003)(1076003)(66574015)(186003)(83380400001)(86362001)(36860700001)(26005)(82310400005)(30864003)(2906002)(2616005); DIR:OUT; SFP:1101; X-OriginatorOrg: ericsson.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 09 Jun 2023 07:15:17.3406 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 942ae225-d18d-47b0-77ca-08db68b9471c 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: DB5EUR02FT006.eop-EUR02.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: DU0PR07MB9092 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 the for the event dispatcher. Signed-off-by: Mattias Rönnblom --- RFC v4: o Extend event matching section of the programming guide. o Improve grammar and spelling. --- doc/api/doxy-api-index.md | 1 + doc/guides/prog_guide/event_dispatcher.rst | 443 +++++++++++++++++++++ doc/guides/prog_guide/index.rst | 1 + 3 files changed, 445 insertions(+) create mode 100644 doc/guides/prog_guide/event_dispatcher.rst diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md index c709fd48ad..05b22057f9 100644 --- a/doc/api/doxy-api-index.md +++ b/doc/api/doxy-api-index.md @@ -29,6 +29,7 @@ The public API headers are grouped by topics: [event_eth_tx_adapter](@ref rte_event_eth_tx_adapter.h), [event_timer_adapter](@ref rte_event_timer_adapter.h), [event_crypto_adapter](@ref rte_event_crypto_adapter.h), + [event_dispatcher](@ref rte_event_dispatcher.h), [rawdev](@ref rte_rawdev.h), [metrics](@ref rte_metrics.h), [bitrate](@ref rte_bitrate.h), diff --git a/doc/guides/prog_guide/event_dispatcher.rst b/doc/guides/prog_guide/event_dispatcher.rst new file mode 100644 index 0000000000..d3386bc609 --- /dev/null +++ b/doc/guides/prog_guide/event_dispatcher.rst @@ -0,0 +1,443 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2023 Ericsson AB. + +Event Dispatcher +================ + +Overview +-------- + +The purpose of the event dispatcher is to help reduce coupling in an +:doc:`Eventdev `-based DPDK application. + +In particular, the event 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 event 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 event dispatcher separates the mechanism (routing events to their +receiver) from the policy (which events should go where). + +The basic operation of the event 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 event 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_event_dispatcher_register(EVENT_DISPATCHER_ID, 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 event +dispatcher is a run as a DPDK :doc:`Service `. + +The event 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. + +Event Dispatcher Creation +------------------------- + +An event dispatcher is created with using +``rte_event_dispatcher_create()``. + +The dispatcher id is provided by the application, and must be unique. + +The event device must be configured before the event dispatcher is +created. + +Usually, only one event dispatcher is needed per event device. An +event dispatcher handles exactly one event device. + +An event dispatcher is freed using the ``rte_event_dispatcher_free()`` +function. The event 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 event dispatcher must know which +event ports are to be used, on all the lcores it uses. The application +provides this information using +``rte_event_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_event_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 event +dispatcher's service function is running on any lcore. + +Event Handlers +-------------- + +The event dispatcher handler is an interface between the event +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_event_dispatcher_match_t`` callback, which job is to + decide if this event is to be the property of this handler. +* The ``rte_event_dispatcher_process_t``, which is used by the + event 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 convience or to +further decouple sub-modules. However, the event dispatcher may impose +an upper limit of the number handlers. In addition, installing a large +number of handlers increase event 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 event 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 event 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 event 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 +event 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 event 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 event dispatcher deliveres these events to the +application. + +The event 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 event 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 event 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 event dispatcher may also deliver ``e2`` before the three events +destined for module B. + +An example of what the event 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 event 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 event 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_event_dispatcher_finalize_register`` call is used to +register a finalize callback. The function +``rte_event_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_event_dispatcher_finalize_register(EVENT_DISPATCHER_ID, + finalize_batch, + shared_event_buffer); + +The event 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 event dispatcher's service function is running on any +lcore. + +Service +------- + +The event 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 event dispatcher +(identified by ``EVENT_DISPATCHER_ID``) to that lcore. + +.. code-block:: c + + static void + launch_event_dispatcher_core(unsigned lcore_id) + { + uint32_t service_id; + + rte_service_lcore_add(lcore_id); + + rte_event_dispatcher_service_id_get(EVENT_DISPATCHER_ID, + &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 event dispatcher must be started. + +.. code-block:: c + + rte_event_dispatcher_start(EVENT_DISPATCHER_ID); + + +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 event 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 event dispatcher service on the same lcore. + +Tasks that prior to the introduction of the event 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 event 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 87333ee84a..74fcbcee6b 100644 --- a/doc/guides/prog_guide/index.rst +++ b/doc/guides/prog_guide/index.rst @@ -59,6 +59,7 @@ Programmer's Guide event_ethernet_tx_adapter event_timer_adapter event_crypto_adapter + event_dispatcher qos_framework power_man packet_classif_access_ctrl