From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id E56BB43AD9; Sun, 11 Feb 2024 10:31:21 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id A1E3640283; Sun, 11 Feb 2024 10:31:21 +0100 (CET) Received: from NAM10-DM6-obe.outbound.protection.outlook.com (mail-dm6nam10on2057.outbound.protection.outlook.com [40.107.93.57]) by mails.dpdk.org (Postfix) with ESMTP id 599CF4025D for ; Sun, 11 Feb 2024 10:31:20 +0100 (CET) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=VKNi9WEjIKrzgeUDjn0AwgbVOhl3+JnaOEEs9yuTd4mBGV5XS2qFOk2deoRnpZF4vo4fj+ZLeLqM8UmoWe5WTRVd5nsWUtZnh9bVLWBIyVyZgT/YzDGWb/tzSglzEb0fuaHXHvTWRbRJ6QrtRSovyDYCNNG9KRH5/aB4tzlcPCO1ZiF2QiLUToWthib6RoYTdckCO+wFuHKfb2CAJLJbwiXmOc3MCyrTsJjyoR2opX0K8rlXjcg+gTbyGrx932UAJ7iuL7bpnCoSiGJb1u3b21nE5W+Aa3bdsCjPhDHhe7ymm5wCaQTgGNmOKL+pDQDnxGXCHakaIZHCyOBFyHv0Jw== 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=6Aham1cm4RJovo36Jvmr3fJXkpi/AkHplENFsncalBQ=; b=T9RyDfvIrguLKDkmUaGxoTtifVF6a1foHLwREpy+a2T0vhUGiOzVAOXnR69vO1MCFs9nzCKGV5n0ryOlYyrBYnLTR4tNwlhMnEf0Qz1CQUmncYaLGzUxCb1IIgRGtRp5TX6lY5FICYgfYBVApi/NWNiSTreiKiA0ySyrrDGkePWNfCcKT4IwkuXupPuzNqJdceUkZRveJ6XmXZK9366xD05GaxHh3IHj00+cH588DNrBNFg9uet+PTIJlCT/LqQKWD8cBZti0qg1VFUMTuXJV6XXx7lEuo2snoiFGwNilyuKYE1JMPA4a/JOmREQd7+VAFm19II4Kmynb43uaYmiwg== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 216.228.117.161) smtp.rcpttodomain=dpdk.org smtp.mailfrom=nvidia.com; dmarc=pass (p=reject sp=reject pct=100) action=none header.from=nvidia.com; dkim=none (message not signed); arc=none (0) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=Nvidia.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=6Aham1cm4RJovo36Jvmr3fJXkpi/AkHplENFsncalBQ=; b=U8sHe1DGQssmR45ESVCg3HQ+45JibHSiy6b9aZDEJTGJ6vQqzoQiG9X4YY3NQwzG+ejP2i50odsK9aKrqQGs+4R83Nte/5Q5bixJ0RODtIBlAKszVThT1J4sEf+ernDG/fxkrjxsPA2XZYZou5zuMvN/58Yf00ZTOZVPhEg32JcMAUBlyA/VtkxL2ucr0yJdq41JLTBcX65bGS5sUGgGw7U5qRgsow/YB3Re6viBbKT9GTUYcRiCz0a2+KvGHRdyNo9OOF+jgR/ExzBVg51FMs0gpjsQg4Sxn2w3S5+rArYLjdxYGADVzlVGu1nt05sD1oiGbZDy6MwGiuVONRNLBg== Received: from SJ0PR05CA0096.namprd05.prod.outlook.com (2603:10b6:a03:334::11) by PH7PR12MB7427.namprd12.prod.outlook.com (2603:10b6:510:202::21) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7292.18; Sun, 11 Feb 2024 09:31:17 +0000 Received: from SJ1PEPF00001CE7.namprd03.prod.outlook.com (2603:10b6:a03:334:cafe::6e) by SJ0PR05CA0096.outlook.office365.com (2603:10b6:a03:334::11) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7292.8 via Frontend Transport; Sun, 11 Feb 2024 09:31:17 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 216.228.117.161) smtp.mailfrom=nvidia.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=nvidia.com; Received-SPF: Pass (protection.outlook.com: domain of nvidia.com designates 216.228.117.161 as permitted sender) receiver=protection.outlook.com; client-ip=216.228.117.161; helo=mail.nvidia.com; pr=C Received: from mail.nvidia.com (216.228.117.161) by SJ1PEPF00001CE7.mail.protection.outlook.com (10.167.242.23) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7249.19 via Frontend Transport; Sun, 11 Feb 2024 09:31:17 +0000 Received: from rnnvmail201.nvidia.com (10.129.68.8) by mail.nvidia.com (10.129.200.67) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.41; Sun, 11 Feb 2024 01:31:10 -0800 Received: from nvidia.com (10.126.231.35) by rnnvmail201.nvidia.com (10.129.68.8) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.1258.12; Sun, 11 Feb 2024 01:31:07 -0800 From: Gregory Etelson To: CC: , , , "Ori Kam" , Aman Singh , Yuying Zhang , Ferruh Yigit , "Andrew Rybchenko" Subject: [PATCH v5] ethdev: add template table resize API Date: Sun, 11 Feb 2024 11:30:53 +0200 Message-ID: <20240211093053.397469-1-getelson@nvidia.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20231217093205.321082-1-getelson@nvidia.com> References: <20231217093205.321082-1-getelson@nvidia.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-Originating-IP: [10.126.231.35] X-ClientProxiedBy: rnnvmail202.nvidia.com (10.129.68.7) To rnnvmail201.nvidia.com (10.129.68.8) X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: SJ1PEPF00001CE7:EE_|PH7PR12MB7427:EE_ X-MS-Office365-Filtering-Correlation-Id: 410cc5a3-f055-4db8-db2b-08dc2ae432b9 X-LD-Processed: 43083d15-7273-40c1-b7db-39efd9ccc17a,ExtAddr X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: B+aQSwN5WrzS+/Gb3sYlLvT5j9YPDQkt3NaxBXbIVQmEUx6Wlab0dUSr7oZgqTYUU0lCs07wx2DATvz91o94qFz65OZq9HDB2MLXoLn/rAD7SpVJEjyNkhZwcPsmqOy8RDtsTM69tc8RItOaq+zDwsoV/JqC9egTs3xlLy+jjbVojgAIRJJ2RrwiBFY9wq3yuMxsTdnWxK3nt2HJP7X5tRX7VdstWxkiKIa6SCO/cwo7aVbgReybjMveVHyep9C1QVzZ03MpZAYaNx5a1E+i+ClobfVA1jV0/1c8CXE7fwR8f//WX75/420WPs6/2ujDmGvOhwXvrj9Rm0vWcebg02CAimGFjpogv+eTN1G5Hm2Bff4kbi5qPPz9l44GdumSWe4JiqLKOuTUM4+d5I1m6RALRbeIp9wabeDaCFE4jOusRUa4QQ8xwablFrIge/TBvH1fG9UVctX/w/QfCoXYQ7akqMYMS2pAqUjhfy0+5QrA9cKoxDsG/S2KRsfW63DkC2Xgfjc5vrHVAJxyjO2JK16oZBuNPll+utNesGvFxRCO08NwfcSYmc8UZYPvf3YRNiEjLO8qVmkpf/GSXPhciFzasThp2YZ+OluJyZdV6Z4= X-Forefront-Antispam-Report: CIP:216.228.117.161; CTRY:US; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:mail.nvidia.com; PTR:dc6edge2.nvidia.com; CAT:NONE; SFS:(13230031)(4636009)(396003)(39860400002)(346002)(136003)(376002)(230922051799003)(230273577357003)(82310400011)(186009)(64100799003)(451199024)(1800799012)(40470700004)(36840700001)(46966006)(2906002)(41300700001)(55016003)(8936002)(8676002)(4326008)(30864003)(5660300002)(82740400003)(356005)(86362001)(83380400001)(36756003)(2616005)(6916009)(54906003)(426003)(316002)(6666004)(1076003)(16526019)(336012)(7636003)(70586007)(70206006)(478600001)(7696005)(6286002)(26005); DIR:OUT; SFP:1101; X-OriginatorOrg: Nvidia.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 11 Feb 2024 09:31:17.1406 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 410cc5a3-f055-4db8-db2b-08dc2ae432b9 X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=43083d15-7273-40c1-b7db-39efd9ccc17a; Ip=[216.228.117.161]; Helo=[mail.nvidia.com] X-MS-Exchange-CrossTenant-AuthSource: SJ1PEPF00001CE7.namprd03.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH7PR12MB7427 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 Template table creation API sets table flows capacity. If application needs more flows then the table was designed for, the following procedures must be completed: 1. Create a new template table with larger flows capacity. 2. Re-create existing flows in the new table and delete flows from the original table. 3. Destroy original table. Application cannot always execute that procedure: * Port may not have sufficient resources to allocate a new table while maintaining original table. * Application may not have existing flows "recipes" to re-create flows in a new table. The patch defines a new API that allows application to resize existing template table: * Resizable template table must be created with the RTE_FLOW_TABLE_SPECIALIZE_RESIZABLE_TABLE bit set. * Application resizes existing table with the `rte_flow_template_table_resize()` function call. The table resize procedure updates the table maximal flow number only. Other table attributes are not affected by the table resize. ** The table resize procedure must not interrupt existing table flows operations in hardware. ** The table resize procedure must not alter flow handlers held by application. * After `rte_flow_template_table_resize()` returned, application must update all existing table flow rules by calling `rte_flow_async_update_resized()`. The table resize procedure does not change application flow handler. However, flow object can reference internal PMD resources that are obsolete after table resize. `rte_flow_async_update_resized()` moves internal flow references to the updated table resources. The flow update must not interrupt hardware flow operations. * When all table flow were updated, application must call `rte_flow_template_table_resize_complete()`. The function releases PMD resources related to the original table. Application can start new table resize after `rte_flow_template_table_resize_complete()` returned. Testpmd commands: * Create resizable template table flow template_table create table_id resizable \ [transfer|ingress|egres] group \ rules_number \ pattern_template [ pattern_template [ ... ]] \ actions_template [ actions_template [ ... ]] * Resize table: flow template_table resize table_resize_id \ table_resize_rules_num * Queue a flow update: flow queue update_resized rule * Complete table resize: flow template_table resize_complete table Signed-off-by: Gregory Etelson Acked-by: Ori Kam --- v2: Update the patch comment. Add table resize commands to testpmd user guide. v3: Rename RTE_FLOW_TABLE_SPECIALIZE_RESIZABLE macro. v4: Remove inline. Add use case to rte_flow.rst. v5: update API guide in the rte_flow.rst. --- app/test-pmd/cmdline_flow.c | 86 ++++++++++++++- app/test-pmd/config.c | 102 +++++++++++++++++ app/test-pmd/testpmd.h | 6 + doc/guides/howto/rte_flow.rst | 116 ++++++++++++++++++++ doc/guides/rel_notes/release_24_03.rst | 2 + doc/guides/testpmd_app_ug/testpmd_funcs.rst | 15 ++- lib/ethdev/ethdev_trace.h | 33 ++++++ lib/ethdev/ethdev_trace_points.c | 9 ++ lib/ethdev/rte_flow.c | 77 +++++++++++++ lib/ethdev/rte_flow.h | 111 +++++++++++++++++++ lib/ethdev/rte_flow_driver.h | 15 +++ lib/ethdev/version.map | 6 + 12 files changed, 572 insertions(+), 6 deletions(-) diff --git a/app/test-pmd/cmdline_flow.c b/app/test-pmd/cmdline_flow.c index ce71818705..1a2556d53b 100644 --- a/app/test-pmd/cmdline_flow.c +++ b/app/test-pmd/cmdline_flow.c @@ -134,6 +134,7 @@ enum index { /* Queue arguments. */ QUEUE_CREATE, QUEUE_DESTROY, + QUEUE_FLOW_UPDATE_RESIZED, QUEUE_UPDATE, QUEUE_AGED, QUEUE_INDIRECT_ACTION, @@ -191,8 +192,12 @@ enum index { /* Table arguments. */ TABLE_CREATE, TABLE_DESTROY, + TABLE_RESIZE, + TABLE_RESIZE_COMPLETE, TABLE_CREATE_ID, TABLE_DESTROY_ID, + TABLE_RESIZE_ID, + TABLE_RESIZE_RULES_NUMBER, TABLE_INSERTION_TYPE, TABLE_INSERTION_TYPE_NAME, TABLE_HASH_FUNC, @@ -204,6 +209,7 @@ enum index { TABLE_TRANSFER, TABLE_TRANSFER_WIRE_ORIG, TABLE_TRANSFER_VPORT_ORIG, + TABLE_RESIZABLE, TABLE_RULES_NUMBER, TABLE_PATTERN_TEMPLATE, TABLE_ACTIONS_TEMPLATE, @@ -1323,6 +1329,8 @@ static const enum index next_group_attr[] = { static const enum index next_table_subcmd[] = { TABLE_CREATE, TABLE_DESTROY, + TABLE_RESIZE, + TABLE_RESIZE_COMPLETE, ZERO, }; @@ -1337,6 +1345,7 @@ static const enum index next_table_attr[] = { TABLE_TRANSFER, TABLE_TRANSFER_WIRE_ORIG, TABLE_TRANSFER_VPORT_ORIG, + TABLE_RESIZABLE, TABLE_RULES_NUMBER, TABLE_PATTERN_TEMPLATE, TABLE_ACTIONS_TEMPLATE, @@ -1353,6 +1362,7 @@ static const enum index next_table_destroy_attr[] = { static const enum index next_queue_subcmd[] = { QUEUE_CREATE, QUEUE_DESTROY, + QUEUE_FLOW_UPDATE_RESIZED, QUEUE_UPDATE, QUEUE_AGED, QUEUE_INDIRECT_ACTION, @@ -3344,6 +3354,19 @@ static const struct token token_list[] = { .args = ARGS(ARGS_ENTRY(struct buffer, port)), .call = parse_table_destroy, }, + [TABLE_RESIZE] = { + .name = "resize", + .help = "resize template table", + .next = NEXT(NEXT_ENTRY(TABLE_RESIZE_ID)), + .call = parse_table + }, + [TABLE_RESIZE_COMPLETE] = { + .name = "resize_complete", + .help = "complete table resize", + .next = NEXT(NEXT_ENTRY(TABLE_DESTROY_ID)), + .args = ARGS(ARGS_ENTRY(struct buffer, port)), + .call = parse_table_destroy, + }, /* Table arguments. */ [TABLE_CREATE_ID] = { .name = "table_id", @@ -3354,13 +3377,29 @@ static const struct token token_list[] = { }, [TABLE_DESTROY_ID] = { .name = "table", - .help = "specify table id to destroy", + .help = "table id", .next = NEXT(next_table_destroy_attr, NEXT_ENTRY(COMMON_TABLE_ID)), .args = ARGS(ARGS_ENTRY_PTR(struct buffer, args.table_destroy.table_id)), .call = parse_table_destroy, }, + [TABLE_RESIZE_ID] = { + .name = "table_resize_id", + .help = "table resize id", + .next = NEXT(NEXT_ENTRY(TABLE_RESIZE_RULES_NUMBER), + NEXT_ENTRY(COMMON_TABLE_ID)), + .args = ARGS(ARGS_ENTRY(struct buffer, args.table.id)), + .call = parse_table + }, + [TABLE_RESIZE_RULES_NUMBER] = { + .name = "table_resize_rules_num", + .help = "table resize rules number", + .next = NEXT(NEXT_ENTRY(END), NEXT_ENTRY(COMMON_UNSIGNED)), + .args = ARGS(ARGS_ENTRY(struct buffer, + args.table.attr.nb_flows)), + .call = parse_table + }, [TABLE_INSERTION_TYPE] = { .name = "insertion_type", .help = "specify insertion type", @@ -3433,6 +3472,12 @@ static const struct token token_list[] = { .next = NEXT(next_table_attr), .call = parse_table, }, + [TABLE_RESIZABLE] = { + .name = "resizable", + .help = "set resizable attribute", + .next = NEXT(next_table_attr), + .call = parse_table, + }, [TABLE_RULES_NUMBER] = { .name = "rules_number", .help = "number of rules in table", @@ -3525,6 +3570,14 @@ static const struct token token_list[] = { .args = ARGS(ARGS_ENTRY(struct buffer, queue)), .call = parse_qo_destroy, }, + [QUEUE_FLOW_UPDATE_RESIZED] = { + .name = "update_resized", + .help = "update a flow after table resize", + .next = NEXT(NEXT_ENTRY(QUEUE_DESTROY_ID), + NEXT_ENTRY(COMMON_QUEUE_ID)), + .args = ARGS(ARGS_ENTRY(struct buffer, queue)), + .call = parse_qo_destroy, + }, [QUEUE_UPDATE] = { .name = "update", .help = "update a flow rule", @@ -10334,6 +10387,7 @@ parse_table(struct context *ctx, const struct token *token, } switch (ctx->curr) { case TABLE_CREATE: + case TABLE_RESIZE: out->command = ctx->curr; ctx->objdata = 0; ctx->object = out; @@ -10378,18 +10432,25 @@ parse_table(struct context *ctx, const struct token *token, case TABLE_TRANSFER_WIRE_ORIG: if (!out->args.table.attr.flow_attr.transfer) return -1; - out->args.table.attr.specialize = RTE_FLOW_TABLE_SPECIALIZE_TRANSFER_WIRE_ORIG; + out->args.table.attr.specialize |= RTE_FLOW_TABLE_SPECIALIZE_TRANSFER_WIRE_ORIG; return len; case TABLE_TRANSFER_VPORT_ORIG: if (!out->args.table.attr.flow_attr.transfer) return -1; - out->args.table.attr.specialize = RTE_FLOW_TABLE_SPECIALIZE_TRANSFER_VPORT_ORIG; + out->args.table.attr.specialize |= RTE_FLOW_TABLE_SPECIALIZE_TRANSFER_VPORT_ORIG; + return len; + case TABLE_RESIZABLE: + out->args.table.attr.specialize |= + RTE_FLOW_TABLE_SPECIALIZE_RESIZABLE; return len; case TABLE_RULES_NUMBER: ctx->objdata = 0; ctx->object = out; ctx->objmask = NULL; return len; + case TABLE_RESIZE_ID: + case TABLE_RESIZE_RULES_NUMBER: + return len; default: return -1; } @@ -10411,7 +10472,8 @@ parse_table_destroy(struct context *ctx, const struct token *token, if (!out) return len; if (!out->command || out->command == TABLE) { - if (ctx->curr != TABLE_DESTROY) + if (ctx->curr != TABLE_DESTROY && + ctx->curr != TABLE_RESIZE_COMPLETE) return -1; if (sizeof(*out) > size) return -1; @@ -10513,7 +10575,8 @@ parse_qo_destroy(struct context *ctx, const struct token *token, if (!out) return len; if (!out->command || out->command == QUEUE) { - if (ctx->curr != QUEUE_DESTROY) + if (ctx->curr != QUEUE_DESTROY && + ctx->curr != QUEUE_FLOW_UPDATE_RESIZED) return -1; if (sizeof(*out) > size) return -1; @@ -12569,10 +12632,18 @@ cmd_flow_parsed(const struct buffer *in) in->args.table_destroy.table_id_n, in->args.table_destroy.table_id); break; + case TABLE_RESIZE_COMPLETE: + port_flow_template_table_resize_complete + (in->port, in->args.table_destroy.table_id[0]); + break; case GROUP_SET_MISS_ACTIONS: port_queue_group_set_miss_actions(in->port, &in->args.vc.attr, in->args.vc.actions); break; + case TABLE_RESIZE: + port_flow_template_table_resize(in->port, in->args.table.id, + in->args.table.attr.nb_flows); + break; case QUEUE_CREATE: port_queue_flow_create(in->port, in->queue, in->postpone, in->args.vc.table_id, in->args.vc.rule_id, @@ -12584,6 +12655,11 @@ cmd_flow_parsed(const struct buffer *in) in->args.destroy.rule_n, in->args.destroy.rule); break; + case QUEUE_FLOW_UPDATE_RESIZED: + port_queue_flow_update_resized(in->port, in->queue, + in->postpone, + in->args.destroy.rule[0]); + break; case QUEUE_UPDATE: port_queue_flow_update(in->port, in->queue, in->postpone, in->args.vc.rule_id, in->args.vc.act_templ_id, diff --git a/app/test-pmd/config.c b/app/test-pmd/config.c index cad7537bc6..e589ac614b 100644 --- a/app/test-pmd/config.c +++ b/app/test-pmd/config.c @@ -1403,6 +1403,19 @@ port_flow_new(const struct rte_flow_attr *attr, return NULL; } +static struct port_flow * +port_flow_locate(struct port_flow *flows_list, uint32_t flow_id) +{ + struct port_flow *pf = flows_list; + + while (pf) { + if (pf->id == flow_id) + break; + pf = pf->next; + } + return pf; +} + /** Print a message out of a flow error. */ static int port_flow_complain(struct rte_flow_error *error) @@ -1693,6 +1706,19 @@ table_alloc(uint32_t id, struct port_table **table, return 0; } +static struct port_table * +port_table_locate(struct port_table *tables_list, uint32_t table_id) +{ + struct port_table *pt = tables_list; + + while (pt) { + if (pt->id == table_id) + break; + pt = pt->next; + } + return pt; +} + /** Get info about flow management resources. */ int port_flow_get_info(portid_t port_id) @@ -2665,6 +2691,46 @@ port_flow_template_table_destroy(portid_t port_id, return ret; } +int +port_flow_template_table_resize_complete(portid_t port_id, uint32_t table_id) +{ + struct rte_port *port; + struct port_table *pt; + struct rte_flow_error error = { 0, }; + int ret; + + if (port_id_is_invalid(port_id, ENABLED_WARN)) + return -EINVAL; + port = &ports[port_id]; + pt = port_table_locate(port->table_list, table_id); + if (!pt) + return -EINVAL; + ret = rte_flow_template_table_resize_complete(port_id, + pt->table, &error); + return !ret ? 0 : port_flow_complain(&error); +} + +int +port_flow_template_table_resize(portid_t port_id, + uint32_t table_id, uint32_t flows_num) +{ + struct rte_port *port; + struct port_table *pt; + struct rte_flow_error error = { 0, }; + int ret; + + if (port_id_is_invalid(port_id, ENABLED_WARN)) + return -EINVAL; + port = &ports[port_id]; + pt = port_table_locate(port->table_list, table_id); + if (!pt) + return -EINVAL; + ret = rte_flow_template_table_resize(port_id, pt->table, flows_num, &error); + if (ret) + return port_flow_complain(&error); + return 0; +} + /** Flush table */ int port_flow_template_table_flush(portid_t port_id) @@ -2805,6 +2871,42 @@ port_queue_flow_create(portid_t port_id, queueid_t queue_id, return 0; } +int +port_queue_flow_update_resized(portid_t port_id, queueid_t queue_id, + bool postpone, uint32_t flow_id) +{ + const struct rte_flow_op_attr op_attr = { .postpone = postpone }; + struct rte_flow_error error = { 0, }; + struct port_flow *pf; + struct rte_port *port; + struct queue_job *job; + int ret; + + if (port_id_is_invalid(port_id, ENABLED_WARN) || + port_id == (portid_t)RTE_PORT_ALL) + return -EINVAL; + port = &ports[port_id]; + if (queue_id >= port->queue_nb) { + printf("Queue #%u is invalid\n", queue_id); + return -EINVAL; + } + pf = port_flow_locate(port->flow_list, flow_id); + if (!pf) + return -EINVAL; + job = calloc(1, sizeof(*job)); + if (!job) + return -ENOMEM; + job->type = QUEUE_JOB_TYPE_FLOW_TRANSFER; + job->pf = pf; + ret = rte_flow_async_update_resized(port_id, queue_id, &op_attr, + pf->flow, job, &error); + if (ret) { + free(job); + return port_flow_complain(&error); + } + return 0; +} + /** Enqueue number of destroy flow rules operations. */ int port_queue_flow_destroy(portid_t port_id, queueid_t queue_id, diff --git a/app/test-pmd/testpmd.h b/app/test-pmd/testpmd.h index 9b10a9ea1c..92f21e7776 100644 --- a/app/test-pmd/testpmd.h +++ b/app/test-pmd/testpmd.h @@ -110,6 +110,7 @@ enum { enum { QUEUE_JOB_TYPE_FLOW_CREATE, QUEUE_JOB_TYPE_FLOW_DESTROY, + QUEUE_JOB_TYPE_FLOW_TRANSFER, QUEUE_JOB_TYPE_FLOW_UPDATE, QUEUE_JOB_TYPE_ACTION_CREATE, QUEUE_JOB_TYPE_ACTION_DESTROY, @@ -981,7 +982,12 @@ int port_flow_template_table_create(portid_t port_id, uint32_t id, uint32_t nb_actions_templates, uint32_t *actions_templates); int port_flow_template_table_destroy(portid_t port_id, uint32_t n, const uint32_t *table); +int port_queue_flow_update_resized(portid_t port_id, queueid_t queue_id, + bool postpone, uint32_t flow_id); int port_flow_template_table_flush(portid_t port_id); +int port_flow_template_table_resize_complete(portid_t port_id, uint32_t table_id); +int port_flow_template_table_resize(portid_t port_id, + uint32_t table_id, uint32_t flows_num); int port_queue_group_set_miss_actions(portid_t port_id, const struct rte_flow_attr *attr, const struct rte_flow_action *actions); int port_queue_flow_create(portid_t port_id, queueid_t queue_id, diff --git a/doc/guides/howto/rte_flow.rst b/doc/guides/howto/rte_flow.rst index 27d4f28f77..7cdaadd0ed 100644 --- a/doc/guides/howto/rte_flow.rst +++ b/doc/guides/howto/rte_flow.rst @@ -303,3 +303,119 @@ Terminal 1: output log:: received packet with src ip = 176.80.50.4 sent to queue 3 received packet with src ip = 176.80.50.5 sent to queue 1 received packet with src ip = 176.80.50.6 sent to queue 3 + +Template API resizable table +---------------------------- + +Description +~~~~~~~~~~~ + +A guide to the resizable template table API. + +The resizable template table API enables applications to dynamically adjust +capacity of template tables without disrupting the existing flows operation. +The resizable template table API allows applications to optimize the memory +usage and performance of template tables according to the traffic conditions +and requirements. + +A typical use case for the resizable template table API + + 1. Create a resizable table with the initial capacity. + + 2. Change the table flows capacity. + + 3. Update flows that were created before the table update. + + 4. Complete the table resize procedure. + +When application begins to resize the table, it enters the resizable state. +When application finishes resizing the table, it returns to the normal state. +Only a table in the normal state can be resized. After a table is back to +the normal state, application can start a new resize. +Application can add, change or remove flow rules regardless of table state. +Table performance may worsen in the resizable state. Table performance must +recover after the table is back to the normal state. + +Table resize procedure must not interfere with flows that existed before +the table size changed. +Flow handles must remain unchanged during table resize. +Application must be able to create new flows and modify or delete existing flows +regardless of the table state. + +Application needs to set the `RTE_FLOW_TABLE_SPECIALIZE_RESIZABLE` bit in +the table attributes when creating a template table that can be resized. +The current API cannot make an existing table resizable if it was not created +with the `RTE_FLOW_TABLE_SPECIALIZE_RESIZABLE` bit. +Resizable template table starts in the normal state. + +Application can trigger the table to resize by calling +the `rte_flow_template_table_resize()` function. The resize process updates +the PMD table settings and port hardware to fit the new flows capacity. +The resize process must not affect the current flows functionality. +The resize process must not change the current flows handles. +Application can create new flows and modify or delete existing flows +while the table is resizing, but the table performance might be +slower than usual. + +Flows that existed before table resize are still functional after table resize. +However, the PMD flow resources that existed before table resize may not be +fully efficient after table resize. In this case, application can combine +the old flow resources from before the resize with the new flow resources +from after the resize. +Application uses the `rte_flow_async_update_resized()` function call to update +flow resources. The flow update process does not interfere with or alter +the existing flow object. It only updates the PMD resources associated with that +flow. +The post-resize flow update process may conflict with application flows +operations, such as creation, removal or update. Therefore, performance-oriented +applications need to choose the best time to call for post-resize flow update. +When application selects flows for the post table resize update, it can iterate +over all existing flows or it can keep track of the flows that need +to be updated. +Flows that were created after the `rte_flow_template_table_resize()` +call finished do not require an update. + +To return table to the normal state, use the +`rte_flow_template_table_resize_complete()`. If PMD does not require post-resize +flows update and application does not care about PMD resources optimization, +application can avoid post-resize flows update and move resized table back to +the normal state right after the `rte_flow_template_table_resize()`. +Application can resize the table again when it is in the normal state. + +Testpmd commands:(wrapped for clarity):: + + # 1. Create resizable template table for 1 flow. + testpmd> flow pattern_template 0 create ingress pattern_template_id 3 + template eth / ipv4 / udp src mask 0xffff / end + testpmd> flow actions_template 0 create ingress actions_template_id 7 + template count / rss / end + testpmd> flow template_table 0 create table_id 101 resizable ingress + group 1 priority 0 rules_number 1 + pattern_template 3 actions_template 7 + + # 2. Queue a flow rule. + testpmd> flow queue 0 create 0 template_table 101 + pattern_template 0 actions_template 0 postpone no + pattern eth / ipv4 / udp src spec 1 / end actions count / rss / end + + # 3. Resize the template table + # The new table capacity is 32 rules + testpmd> flow template_table 0 resize table_resize_id 101 + table_resize_rules_num 32 + + # 4. Queue more flow rules. + testpmd> flow queue 0 create 0 template_table 101 + pattern_template 0 actions_template 0 postpone no + pattern eth / ipv4 / udp src spec 2 / end actions count / rss / end + testpmd> flow queue 0 create 0 template_table 101 + pattern_template 0 actions_template 0 postpone no + pattern eth / ipv4 / udp src spec 3 / end actions count / rss / end + testpmd> flow queue 0 create 0 template_table 101 + pattern_template 0 actions_template 0 postpone no + pattern eth / ipv4 / udp src spec 4 / end actions count / rss / end + + # 5. Queue the initial flow update. + testpmd> flow queue 0 update_resized 0 rule 0 + + # 6. Complete the table resize. + testpmd> flow template_table 0 resize_complete table 101 diff --git a/doc/guides/rel_notes/release_24_03.rst b/doc/guides/rel_notes/release_24_03.rst index 6f8ad27808..047664a079 100644 --- a/doc/guides/rel_notes/release_24_03.rst +++ b/doc/guides/rel_notes/release_24_03.rst @@ -55,6 +55,8 @@ New Features Also, make sure to start the actual text at the margin. ======================================================= +* **Added support for template API table resize.** + Removed Items ------------- diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst index 447e28e694..d0d3adf643 100644 --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst @@ -2984,12 +2984,21 @@ following sections. - Create a table:: flow table {port_id} create - [table_id {id}] + [table_id {id}] [resizable] [group {group_id}] [priority {level}] [ingress] [egress] [transfer] rules_number {number} pattern_template {pattern_template_id} actions_template {actions_template_id} +- Resize a table:: + + flow template_table {port_id} resize + table_resize_id {id} table_resize_rules_num {number} + +- Complete table resize:: + + flow template_table {port_id} resize_complete table {table_id} + - Destroy a table:: flow table {port_id} destroy table {id} [...] @@ -3010,6 +3019,10 @@ following sections. pattern {item} [/ {item} [...]] / end actions {action} [/ {action} [...]] / end +- Enqueue flow update following table resize:: + + flow queue {port_id} update_resized {table_id} rule {rule_id} + - Enqueue destruction of specific flow rules:: flow queue {port_id} destroy {queue_id} diff --git a/lib/ethdev/ethdev_trace.h b/lib/ethdev/ethdev_trace.h index 1b1ae0cfe8..cd3327a619 100644 --- a/lib/ethdev/ethdev_trace.h +++ b/lib/ethdev/ethdev_trace.h @@ -2572,6 +2572,39 @@ RTE_TRACE_POINT_FP( rte_trace_point_emit_ptr(user_data); rte_trace_point_emit_int(ret); ) + +RTE_TRACE_POINT_FP( + rte_flow_trace_template_table_resize, + RTE_TRACE_POINT_ARGS(uint16_t port_id, + struct rte_flow_template_table *table, + uint32_t nb_rules, int ret), + rte_trace_point_emit_u16(port_id); + rte_trace_point_emit_ptr(table); + rte_trace_point_emit_u32(nb_rules); + rte_trace_point_emit_int(ret); +) + +RTE_TRACE_POINT_FP( + rte_flow_trace_async_update_resized, + RTE_TRACE_POINT_ARGS(uint16_t port_id, uint32_t queue, + const struct rte_flow_op_attr *attr, + struct rte_flow *rule, void *user_data, int ret), + rte_trace_point_emit_u16(port_id); + rte_trace_point_emit_u32(queue); + rte_trace_point_emit_ptr(attr); + rte_trace_point_emit_ptr(rule); + rte_trace_point_emit_ptr(user_data); + rte_trace_point_emit_int(ret); +) + +RTE_TRACE_POINT_FP( + rte_flow_trace_table_resize_complete, + RTE_TRACE_POINT_ARGS(uint16_t port_id, + struct rte_flow_template_table *table, int ret), + rte_trace_point_emit_u16(port_id); + rte_trace_point_emit_ptr(table); + rte_trace_point_emit_int(ret); +) #ifdef __cplusplus } #endif diff --git a/lib/ethdev/ethdev_trace_points.c b/lib/ethdev/ethdev_trace_points.c index 91f71d868b..1a1f685daa 100644 --- a/lib/ethdev/ethdev_trace_points.c +++ b/lib/ethdev/ethdev_trace_points.c @@ -774,3 +774,12 @@ RTE_TRACE_POINT_REGISTER(rte_flow_trace_async_action_list_handle_destroy, RTE_TRACE_POINT_REGISTER(rte_flow_trace_async_action_list_handle_query_update, lib.ethdev.flow.async_action_list_handle_query_update) + +RTE_TRACE_POINT_REGISTER(rte_flow_trace_template_table_resize, + lib.ethdev.flow.template_table_resize) + +RTE_TRACE_POINT_REGISTER(rte_flow_trace_async_update_resized, + lib.ethdev.flow.async_update_resized) + +RTE_TRACE_POINT_REGISTER(rte_flow_trace_table_resize_complete, + lib.ethdev.flow.table_resize_complete) diff --git a/lib/ethdev/rte_flow.c b/lib/ethdev/rte_flow.c index f49d1d3767..99987e6518 100644 --- a/lib/ethdev/rte_flow.c +++ b/lib/ethdev/rte_flow.c @@ -2481,3 +2481,80 @@ rte_flow_calc_table_hash(uint16_t port_id, const struct rte_flow_template_table hash, error); return flow_err(port_id, ret, error); } + +bool +rte_flow_table_resizable(__rte_unused uint16_t port_id, + const struct rte_flow_template_table_attr *tbl_attr) +{ + return (tbl_attr->specialize & + RTE_FLOW_TABLE_SPECIALIZE_RESIZABLE) != 0; +} + +int +rte_flow_template_table_resize(uint16_t port_id, + struct rte_flow_template_table *table, + uint32_t nb_rules, + struct rte_flow_error *error) +{ + int ret; + struct rte_eth_dev *dev; + const struct rte_flow_ops *ops; + + RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV); + ops = rte_flow_ops_get(port_id, error); + if (!ops || !ops->flow_template_table_resize) + return rte_flow_error_set(error, ENOTSUP, + RTE_FLOW_ERROR_TYPE_UNSPECIFIED, NULL, + "flow_template_table_resize not supported"); + dev = &rte_eth_devices[port_id]; + ret = ops->flow_template_table_resize(dev, table, nb_rules, error); + ret = flow_err(port_id, ret, error); + rte_flow_trace_template_table_resize(port_id, table, nb_rules, ret); + return ret; +} + +int +rte_flow_async_update_resized(uint16_t port_id, uint32_t queue, + const struct rte_flow_op_attr *attr, + struct rte_flow *rule, void *user_data, + struct rte_flow_error *error) +{ + int ret; + struct rte_eth_dev *dev; + const struct rte_flow_ops *ops; + + RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV); + ops = rte_flow_ops_get(port_id, error); + if (!ops || !ops->flow_update_resized) + return rte_flow_error_set(error, ENOTSUP, + RTE_FLOW_ERROR_TYPE_UNSPECIFIED, NULL, + "async_flow_async_transfer not supported"); + dev = &rte_eth_devices[port_id]; + ret = ops->flow_update_resized(dev, queue, attr, rule, user_data, error); + ret = flow_err(port_id, ret, error); + rte_flow_trace_async_update_resized(port_id, queue, attr, + rule, user_data, ret); + return ret; +} + +int +rte_flow_template_table_resize_complete(uint16_t port_id, + struct rte_flow_template_table *table, + struct rte_flow_error *error) +{ + int ret; + struct rte_eth_dev *dev; + const struct rte_flow_ops *ops; + + RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV); + ops = rte_flow_ops_get(port_id, error); + if (!ops || !ops->flow_template_table_resize_complete) + return rte_flow_error_set(error, ENOTSUP, + RTE_FLOW_ERROR_TYPE_UNSPECIFIED, NULL, + "flow_template_table_transfer_complete not supported"); + dev = &rte_eth_devices[port_id]; + ret = ops->flow_template_table_resize_complete(dev, table, error); + ret = flow_err(port_id, ret, error); + rte_flow_trace_table_resize_complete(port_id, table, ret); + return ret; +} diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h index 78b6bbb159..9aedc06516 100644 --- a/lib/ethdev/rte_flow.h +++ b/lib/ethdev/rte_flow.h @@ -5746,6 +5746,10 @@ struct rte_flow_template_table; * if the hint is supported. */ #define RTE_FLOW_TABLE_SPECIALIZE_TRANSFER_VPORT_ORIG RTE_BIT32(1) +/** + * Specialize table for resize. + */ +#define RTE_FLOW_TABLE_SPECIALIZE_RESIZABLE RTE_BIT32(2) /**@}*/ /** @@ -5824,6 +5828,25 @@ struct rte_flow_template_table_attr { enum rte_flow_table_hash_func hash_func; }; +/** + * @warning + * @b EXPERIMENTAL: this API may change without prior notice. + * + * Query whether a table can be resized. + * + * @param port_id + * Port identifier of Ethernet device. + * @param tbl_attr + * Template table. + * + * @return + * True if the table can be resized. + */ +__rte_experimental +bool +rte_flow_table_resizable(__rte_unused uint16_t port_id, + const struct rte_flow_template_table_attr *tbl_attr); + /** * @warning * @b EXPERIMENTAL: this API may change without prior notice. @@ -6750,6 +6773,94 @@ rte_flow_calc_table_hash(uint16_t port_id, const struct rte_flow_template_table const struct rte_flow_item pattern[], uint8_t pattern_template_index, uint32_t *hash, struct rte_flow_error *error); +/** + * @warning + * @b EXPERIMENTAL: this API may change without prior notice. + * + * Change template table flow rules capacity. + * PMD implementation must support table change to the new size. + * + * @param port_id + * Port identifier of Ethernet device. + * @param table + * Template table to modify. + * @param nb_rules + * New flow rules capacity. + * @param error + * Perform verbose error reporting if not NULL. + * PMDs initialize this structure in case of error only. + * + * @return + * - (0) if success. + * - (-ENODEV) if *port_id* invalid. + * - (-ENOTSUP) if underlying device does not support this functionality. + * - (-EINVAL) if *table* cannot be resized or resize to *nb_rules* + * is not supported in PMD. + */ +__rte_experimental +int +rte_flow_template_table_resize(uint16_t port_id, + struct rte_flow_template_table *table, + uint32_t nb_rules, + struct rte_flow_error *error); +/** + * @warning + * @b EXPERIMENTAL: this API may change without prior notice. + * + * Following table resize, update flow resources in port. + * + * @param port_id + * Port identifier of Ethernet device. + * @param queue + * Flow queue for async operation. + * @param attr + * Async operation attributes. + * @param rule + * Flow rule to update. + * @param user_data + * The user data that will be returned on async completion event. + * @param error + * Perform verbose error reporting if not NULL. + * PMDs initialize this structure in case of error only. + * + * @return + * - (0) if success. + * - (-ENODEV) if *port_id* invalid. + * - (-ENOTSUP) if underlying device does not support this functionality. + * - (-EINVAL) if *rule* cannot be updated. + */ +__rte_experimental +int +rte_flow_async_update_resized(uint16_t port_id, uint32_t queue, + const struct rte_flow_op_attr *attr, + struct rte_flow *rule, void *user_data, + struct rte_flow_error *error); + +/** + * @warning + * @b EXPERIMENTAL: this API may change without prior notice. + * + * Following table resize, notify port that all table flows were updated. + * + * @param port_id + * Port identifier of Ethernet device. + * @param table + * Template table that undergoing resize operation. + * @param error + * Perform verbose error reporting if not NULL. + * PMDs initialize this structure in case of error only. + * + * @return + * - (0) if success. + * - (-ENODEV) if *port_id* invalid. + * - (-ENOTSUP) if underlying device does not support this functionality. + * - (-EINVAL) PMD cannot complete table resize. + */ +__rte_experimental +int +rte_flow_template_table_resize_complete(uint16_t port_id, + struct rte_flow_template_table *table, + struct rte_flow_error *error); #ifdef __cplusplus } #endif diff --git a/lib/ethdev/rte_flow_driver.h b/lib/ethdev/rte_flow_driver.h index f35f659503..53d9393575 100644 --- a/lib/ethdev/rte_flow_driver.h +++ b/lib/ethdev/rte_flow_driver.h @@ -370,6 +370,21 @@ struct rte_flow_ops { (struct rte_eth_dev *dev, const struct rte_flow_template_table *table, const struct rte_flow_item pattern[], uint8_t pattern_template_index, uint32_t *hash, struct rte_flow_error *error); + /** @see rte_flow_template_table_resize() */ + int (*flow_template_table_resize)(struct rte_eth_dev *dev, + struct rte_flow_template_table *table, + uint32_t nb_rules, + struct rte_flow_error *error); + /** @see rte_flow_async_update_resized() */ + int (*flow_update_resized)(struct rte_eth_dev *dev, uint32_t queue, + const struct rte_flow_op_attr *attr, + struct rte_flow *rule, void *user_data, + struct rte_flow_error *error); + /** @see rte_flow_template_table_resize_complete() */ + int (*flow_template_table_resize_complete) + (struct rte_eth_dev *dev, + struct rte_flow_template_table *table, + struct rte_flow_error *error); }; /** diff --git a/lib/ethdev/version.map b/lib/ethdev/version.map index 5c4917c020..5b22aa598a 100644 --- a/lib/ethdev/version.map +++ b/lib/ethdev/version.map @@ -316,6 +316,12 @@ EXPERIMENTAL { rte_eth_recycle_rx_queue_info_get; rte_flow_group_set_miss_actions; rte_flow_calc_table_hash; + + # added in 24.03 + rte_flow_table_resizable; + rte_flow_template_table_resize; + rte_flow_async_update_resized; + rte_flow_template_table_resize_complete; }; INTERNAL { -- 2.39.2