From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wr0-f193.google.com (mail-wr0-f193.google.com [209.85.128.193]) by dpdk.org (Postfix) with ESMTP id 72AD97EE3 for ; Thu, 19 Apr 2018 12:16:44 +0200 (CEST) Received: by mail-wr0-f193.google.com with SMTP id q13-v6so12519664wre.3 for ; Thu, 19 Apr 2018 03:16:44 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind-com.20150623.gappssmtp.com; s=20150623; h=date:from:to:subject:message-id:references:mime-version :content-disposition:in-reply-to; bh=Drwk0Mosh95KvfyZHTrcAPbnwhRE/UACZhOIEmDtKpM=; b=YQjzePHPdh8iwGZBxyQMjd0WB0ITyG3xqILGx/hwlBGW6TuAR3Z5+5P4PDXleYMqjB B/5lJpbuQwBOJ7bPiZeHN8vZyXfZMkjJze0Y72qUu9EMuZcZSGuLC+TH1HFqmS4/GX1E CcR+EOxPT5fsCRaFXgEaVczT0gal30lrtskEZSSgRGFbGXdWEOL+J+YC2NDRq3kFe7b3 bKoHp4BxyisUvlpDD1EMOIHeaOWGwKiVxKARt4nUtAts02ovwFsWxT/eNtmbUNvMVtYO PKJCOiMn1jsXmpw7JJnGUDbJuoyTGDhfXwFo3HzX+sq2gNGJDz23SePMBdEpGRQwkLc0 CLEw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:subject:message-id:references :mime-version:content-disposition:in-reply-to; bh=Drwk0Mosh95KvfyZHTrcAPbnwhRE/UACZhOIEmDtKpM=; b=khljA6TcioeV8TU8lzDp94pOpdVHQlNl+/z+2gfZxMPCduBQvjF/bcPYuu5vWOEhAX HMpAP7H+fGqbPYZ88mHNyZS9hhyAeYMkNTZp/nYAP6OT4FvAXTMfUT1tPZK0oYzdAKPB Ksbu5vHylNNEFLT8c8JyfLpBH9Bndg8K2TPizQAyBnn+LByLkIK+S5XwLISyHFqT5pf4 n8x7OlEDkTF2ie9C0hi71kmB0F2dZoYxH0wxovouqj2zxp3gjq28Tl44LjBhO8/4rcfO Kv+SgSYCvUB9sZ8O2fyo/okLPJK6vbLdHf27FdnEsZzwfin6kUAbrbJ7nXFZ4rfot7OF DkvQ== X-Gm-Message-State: ALQs6tB9f5A19JfP0coXi8X9JQNr6nuQ9lNFP4S6f4BeIWgS/PKnKUN1 LRU+7773vZwrHwblKcDwZCfgTw== X-Google-Smtp-Source: AIpwx4/mLXVB51230vtZsHmzru2ALTQCtbBoo7tZwtjpFgPKEMgKyE1/ztGNCkhm4uqUT5HZ41gJwg== X-Received: by 10.28.232.197 with SMTP id f66mr4247796wmi.119.1524133004191; Thu, 19 Apr 2018 03:16:44 -0700 (PDT) Received: from 6wind.com (host.78.145.23.62.rev.coltfrance.com. [62.23.145.78]) by smtp.gmail.com with ESMTPSA id t6-v6sm3691077wre.32.2018.04.19.03.16.43 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 19 Apr 2018 03:16:43 -0700 (PDT) Date: Thu, 19 Apr 2018 12:16:30 +0200 From: Adrien Mazarguil To: Thomas Monjalon , Ferruh Yigit , dev@dpdk.org Message-ID: <20180419100848.6178-3-adrien.mazarguil@6wind.com> References: <20180416150525.2817-1-adrien.mazarguil@6wind.com> <20180419100848.6178-1-adrien.mazarguil@6wind.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20180419100848.6178-1-adrien.mazarguil@6wind.com> X-Mailer: git-send-email 2.11.0 Subject: [dpdk-dev] [PATCH v5 02/16] ethdev: clarify flow API pattern items and actions X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 19 Apr 2018 10:16:44 -0000 Although pattern items and actions examples end with "and so on", these lists include all existing definitions and as a result are updated almost every time new types are added. This is cumbersome and pointless. This patch also synchronizes Doxygen and external API documentation wording with a slight clarification regarding meta pattern items. No fundamental API change. Signed-off-by: Adrien Mazarguil Acked-by: Andrew Rybchenko --- doc/guides/prog_guide/rte_flow.rst | 23 +++++++++++------------ lib/librte_ether/rte_flow.h | 23 ++++++++++------------- 2 files changed, 21 insertions(+), 25 deletions(-) diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst index 961943dda..a11ebd617 100644 --- a/doc/guides/prog_guide/rte_flow.rst +++ b/doc/guides/prog_guide/rte_flow.rst @@ -186,12 +186,13 @@ Pattern item Pattern items fall in two categories: -- Matching protocol headers and packet data (ANY, RAW, ETH, VLAN, IPV4, - IPV6, ICMP, UDP, TCP, SCTP, VXLAN, MPLS, GRE, ESP and so on), usually - associated with a specification structure. +- Matching protocol headers and packet data, usually associated with a + specification structure. These must be stacked in the same order as the + protocol layers to match inside packets, starting from the lowest. -- Matching meta-data or affecting pattern processing (END, VOID, INVERT, PF, - VF, PORT and so on), often without a specification structure. +- Matching meta-data or affecting pattern processing, often without a + specification structure. Since they do not match packet contents, their + position in the list is usually not relevant. Item specification structures are used to match specific values among protocol fields (or item properties). Documentation describes for each item @@ -1001,15 +1002,13 @@ to a flow rule. That list is not ordered. They fall in three categories: -- Terminating actions (such as QUEUE, DROP, RSS, PF, VF) that prevent - processing matched packets by subsequent flow rules, unless overridden - with PASSTHRU. +- Terminating actions that prevent processing matched packets by subsequent + flow rules, unless overridden with PASSTHRU. -- Non-terminating actions (PASSTHRU, DUP) that leave matched packets up for - additional processing by subsequent flow rules. +- Non-terminating actions that leave matched packets up for additional + processing by subsequent flow rules. -- Other non-terminating meta actions that do not affect the fate of packets - (END, VOID, MARK, FLAG, COUNT, SECURITY). +- Other non-terminating meta actions that do not affect the fate of packets. When several actions are combined in a flow rule, they should all have different types (e.g. dropping a packet twice is not possible). diff --git a/lib/librte_ether/rte_flow.h b/lib/librte_ether/rte_flow.h index 26b95c772..d28a2a473 100644 --- a/lib/librte_ether/rte_flow.h +++ b/lib/librte_ether/rte_flow.h @@ -78,15 +78,13 @@ struct rte_flow_attr { * * Pattern items fall in two categories: * - * - Matching protocol headers and packet data (ANY, RAW, ETH, VLAN, IPV4, - * IPV6, ICMP, UDP, TCP, SCTP, VXLAN and so on), usually associated with a + * - Matching protocol headers and packet data, usually associated with a * specification structure. These must be stacked in the same order as the - * protocol layers to match, starting from the lowest. + * protocol layers to match inside packets, starting from the lowest. * - * - Matching meta-data or affecting pattern processing (END, VOID, INVERT, - * PF, VF, PORT and so on), often without a specification structure. Since - * they do not match packet contents, these can be specified anywhere - * within item lists without affecting others. + * - Matching meta-data or affecting pattern processing, often without a + * specification structure. Since they do not match packet contents, their + * position in the list is usually not relevant. * * See the description of individual types for more information. Those * marked with [META] fall into the second category. @@ -865,15 +863,14 @@ struct rte_flow_item { * * They fall in three categories: * - * - Terminating actions (such as QUEUE, DROP, RSS, PF, VF) that prevent - * processing matched packets by subsequent flow rules, unless overridden - * with PASSTHRU. + * - Terminating actions that prevent processing matched packets by + * subsequent flow rules, unless overridden with PASSTHRU. * - * - Non terminating actions (PASSTHRU, DUP) that leave matched packets up - * for additional processing by subsequent flow rules. + * - Non terminating actions that leave matched packets up for additional + * processing by subsequent flow rules. * * - Other non terminating meta actions that do not affect the fate of - * packets (END, VOID, MARK, FLAG, COUNT). + * packets. * * When several actions are combined in a flow rule, they should all have * different types (e.g. dropping a packet twice is not possible). -- 2.11.0