From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 6D114A0487 for ; Tue, 2 Jul 2019 12:33:27 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 4450F1B9B5; Tue, 2 Jul 2019 12:33:27 +0200 (CEST) Received: from mail-wr1-f66.google.com (mail-wr1-f66.google.com [209.85.221.66]) by dpdk.org (Postfix) with ESMTP id 240851B9AE for ; Tue, 2 Jul 2019 12:33:25 +0200 (CEST) Received: by mail-wr1-f66.google.com with SMTP id c27so9478375wrb.2 for ; Tue, 02 Jul 2019 03:33:25 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind.com; s=google; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to; bh=fuTo/aa1UxsLComXXBlX0MW4fq07aJYlzWhkf8fI2dQ=; b=hKf/oGqdMZqQLHc8goVgboke3M+pMLfYCHYCKdmjT/ToMSVfA8Mo+Edfyl2JKSKVjy egZrHpTqOmxQY+FcVu8afvHnBQVLfy1N7OHnvBBlGu7Z1XzLK3c1lml0F1Mv7osXzq8r SpjX+HU8eRyzAncIEgKs9TdS6G+ikhReB2UI9Ppzb7k1Uj1jUH/EA+ig8qsp+xfkSBcD 43wGZi+969MfOtpsYbhV9wI0tXIR5bp/DhwL/2vnaIc/5Jox5UHINv3sYVVFDSabyvfe UgFBZGZNok/G1Ad3GOUTEcKOv+xEx2n3U7EGvRc6rzUFWpjAoZ9KTr6+S4bkiDedSJgd a+IQ== 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:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to; bh=fuTo/aa1UxsLComXXBlX0MW4fq07aJYlzWhkf8fI2dQ=; b=p5hPJgA1z/4twnfhyeoFNjNhHADqz+5fY9ZdL032h/iij4NpGAnQlPcBvsEKzlCmJg 5J45lGoFU2zpycTwo7KNS03FVRDdAmL0b1ISQAVnYark22IZbIvyDtHdmjzU1Bgk+0jv 6jY2VFgbpYYoVY81NfiXrkHo5jKhpzHFKc22XNPtZq8wChagdWH+mmU71X71qsz8nq8X mkCcjrsPPHvMGflBhzscrc9JSGuxZ0kCKeKfeqA6KwzvwpYE/tN24UKd300Dyt0NL/Z/ m9FF+vDeX+KmirnAkoEMMV2xOOgWDZES8RgA39vx6Vi/yG/qjTTA6/4jNf8nyTjHvKS2 P8LQ== X-Gm-Message-State: APjAAAVcpJ82gZDMeyd8zR7vkJHY4jqXgTv6+ds6YAkFJAX+hGnFAiuo FDuq8o3v9FHHc6q2PKOo08n2iA== X-Google-Smtp-Source: APXvYqwSPoXLfRQRThDCyN0ff7FpL/OF/OBgFd/obo/RAWa6bWWp1zj/oH6HER3YL67K+qFywTZrNA== X-Received: by 2002:a5d:5510:: with SMTP id b16mr23026323wrv.267.1562063604871; Tue, 02 Jul 2019 03:33:24 -0700 (PDT) Received: from 6wind.com (32.40.136.77.rev.sfr.net. [77.136.40.32]) by smtp.gmail.com with ESMTPSA id 5sm2065204wmi.22.2019.07.02.03.33.23 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 02 Jul 2019 03:33:23 -0700 (PDT) Date: Tue, 2 Jul 2019 12:33:21 +0200 From: Adrien Mazarguil To: Dekel Peled Cc: Andrew Rybchenko , "wenzhuo.lu@intel.com" , "jingjing.wu@intel.com" , "bernard.iremonger@intel.com" , Yongseok Koh , Shahaf Shuler , Slava Ovsiienko , "dev@dpdk.org" , Ori Kam Message-ID: <20190702103321.GB4512@6wind.com> References: <1553177917-43297-1-git-send-email-dekelp@mellanox.com> <359385afd8826483cd8b7af2c8a5ea45d4d5a9b2.1561994563.git.dekelp@mellanox.com> <7ebe9e0c-cd76-28ef-0788-1b5a81177139@solarflare.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: Subject: Re: [dpdk-dev] [PATCH v9 1/3] ethdev: add actions to modify TCP header fields X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" On Tue, Jul 02, 2019 at 09:52:40AM +0000, Dekel Peled wrote: > Thanks, PSB > > > -----Original Message----- > > From: Andrew Rybchenko > > Sent: Tuesday, July 2, 2019 11:14 AM > > To: Dekel Peled ; Adrien Mazarguil > > ; wenzhuo.lu@intel.com; > > jingjing.wu@intel.com; bernard.iremonger@intel.com; Yongseok Koh > > ; Shahaf Shuler ; Slava > > Ovsiienko ; arybchenko@solarflare.com > > Cc: dev@dpdk.org; Ori Kam > > Subject: Re: [dpdk-dev] [PATCH v9 1/3] ethdev: add actions to modify TCP > > header fields > > > > On 01.07.2019 18:43, Dekel Peled wrote: > > > Add actions: > > > - INC_TCP_SEQ - Increase sequence number in the outermost TCP header. > > > - DEC_TCP_SEQ - Decrease sequence number in the outermost TCP > > header. > > > - INC_TCP_ACK - Increase acknowledgment number in the outermost TCP > > > header. > > > - DEC_TCP_ACK - Decrease acknowledgment number in the outermost TCP > > > header. > > > > > > Original work by Xiaoyu Min. > > > > > > This patch uses the new approach introduced by [1], using a simple > > > integer instead of using an action-specific structure for each of the > > > new actions. > > > > > > [1] > > > > > https://eur03.safelinks.protection.outlook.com/?url=http%3A%2F%2Fpatch > > > > > es.dpdk.org%2Fpatch%2F55773%2F&data=02%7C01%7Cdekelp%40mell > > anox.co > > > > > m%7Cae3a2667c3a243a9c1e508d6fec54a22%7Ca652971c7d2e4d9ba6a4d1492 > > 56f461 > > > > > b%7C0%7C0%7C636976520663069258&sdata=1z3uDQGnnyPZH9NAUuY5 > > 0ZSg3smyZ > > > nDmc3QZtuNTmyg%3D&reserved=0 > > > > > > Signed-off-by: Dekel Peled > > > Acked-by: Andrew Rybchenko > > > --- > > > doc/guides/prog_guide/rte_flow.rst | 32 > > ++++++++++++++++++++++++++++++++ > > > lib/librte_ethdev/rte_flow.c | 4 ++++ > > > lib/librte_ethdev/rte_flow.h | 32 > > ++++++++++++++++++++++++++++++++ > > > 3 files changed, 68 insertions(+) > > > > > > diff --git a/doc/guides/prog_guide/rte_flow.rst > > > b/doc/guides/prog_guide/rte_flow.rst > > > index 67deed7..bbe32db 100644 > > > --- a/doc/guides/prog_guide/rte_flow.rst > > > +++ b/doc/guides/prog_guide/rte_flow.rst > > > @@ -2346,6 +2346,38 @@ Otherwise, RTE_FLOW_ERROR_TYPE_ACTION > > error will be returned. > > > | ``mac_addr`` | MAC address | > > > +--------------+---------------+ > > > > > > +Action: ``INC_TCP_SEQ`` > > > +^^^^^^^^^^^^^^^^^^^^^^^ > > > + > > > +Increase sequence number in the outermost TCP header. > > > +Value to increase TCP sequence number by is a big-endian 32 bit integer. > > > + > > > +Using this action on non-matching traffic will result in undefined behavior. > > > + > > > +Action: ``DEC_TCP_SEQ`` > > > +^^^^^^^^^^^^^^^^^^^^^^^ > > > + > > > +Decrease sequence number in the outermost TCP header. > > > +Value to decrease TCP sequence number by is a big-endian 32 bit integer. > > > + > > > +Using this action on non-matching traffic will result in undefined behavior. > > > + > > > +Action: ``INC_TCP_ACK`` > > > +^^^^^^^^^^^^^^^^^^^^^^^ > > > + > > > +Increase acknowledgment number in the outermost TCP header. > > > +Value to increase TCP acknowledgment number by is a big-endian 32 bit > > integer. > > > + > > > +Using this action on non-matching traffic will result in undefined behavior. > > > + > > > +Action: ``DEC_TCP_ACK`` > > > +^^^^^^^^^^^^^^^^^^^^^^^ > > > + > > > +Decrease acknowledgment number in the outermost TCP header. > > > +Value to decrease TCP acknowledgment number by is a big-endian 32 bit > > integer. > > > + > > > +Using this action on non-matching traffic will result in undefined behavior. > > > + > > > Negative types > > > ~~~~~~~~~~~~~~ > > > > > > diff --git a/lib/librte_ethdev/rte_flow.c > > > b/lib/librte_ethdev/rte_flow.c index 3277be1..0c9f6c6 100644 > > > --- a/lib/librte_ethdev/rte_flow.c > > > +++ b/lib/librte_ethdev/rte_flow.c > > > @@ -143,6 +143,10 @@ struct rte_flow_desc_data { > > > MK_FLOW_ACTION(SET_TTL, sizeof(struct rte_flow_action_set_ttl)), > > > MK_FLOW_ACTION(SET_MAC_SRC, sizeof(struct > > rte_flow_action_set_mac)), > > > MK_FLOW_ACTION(SET_MAC_DST, sizeof(struct > > > rte_flow_action_set_mac)), > > > + MK_FLOW_ACTION(INC_TCP_SEQ, sizeof(rte_be32_t)), > > > + MK_FLOW_ACTION(DEC_TCP_SEQ, sizeof(rte_be32_t)), > > > + MK_FLOW_ACTION(INC_TCP_ACK, sizeof(rte_be32_t)), > > > + MK_FLOW_ACTION(DEC_TCP_ACK, sizeof(rte_be32_t)), > > > }; > > > > > > static int > > > diff --git a/lib/librte_ethdev/rte_flow.h > > > b/lib/librte_ethdev/rte_flow.h index 2232856..28445f4 100644 > > > --- a/lib/librte_ethdev/rte_flow.h > > > +++ b/lib/librte_ethdev/rte_flow.h > > > @@ -1651,6 +1651,38 @@ enum rte_flow_action_type { > > > * See struct rte_flow_action_set_mac. > > > */ > > > RTE_FLOW_ACTION_TYPE_SET_MAC_DST, > > > + > > > + /** > > > + * Increase sequence number in the outermost TCP header. > > > + * > > > + * Using this action on non-matching traffic will result in > > > + * undefined behavior. > > > + */ > > > + RTE_FLOW_ACTION_TYPE_INC_TCP_SEQ, > > > + > > > + /** > > > + * Decrease sequence number in the outermost TCP header. > > > + * > > > + * Using this action on non-matching traffic will result in > > > + * undefined behavior. > > > + */ > > > + RTE_FLOW_ACTION_TYPE_DEC_TCP_SEQ, > > > + > > > + /** > > > + * Increase acknowledgment number in the outermost TCP header. > > > + * > > > + * Using this action on non-matching traffic will result in > > > + * undefined behavior. > > > + */ > > > + RTE_FLOW_ACTION_TYPE_INC_TCP_ACK, > > > + > > > + /** > > > + * Decrease acknowledgment number in the outermost TCP header. > > > + * > > > + * Using this action on non-matching traffic will result in > > > + * undefined behavior. > > > + */ > > > + RTE_FLOW_ACTION_TYPE_DEC_TCP_ACK, > > > }; > > > > > > /** > > > > Other actions have type of configuration data description in a comment just > > before the action enum element. I'm not sure why it is skipped here. > > It is really vital information. > > > > I had the relevant struct name here, and removed it when I changed it to integer. > In the documentation doc/guides/prog_guide/rte_flow.rst I added description, please see above. Yes, still Andrew is right, header documentation must be exhaustive. Developers might use rte_flow.rst as reference and to understand the underlying design but will definitely rely on rte_flow.h (and Doxygen) when writing code. I suggest something which describes types and how they are used a bit like enum rte_flow_conv_op, e.g. for RTE_FLOW_ACTION_TYPE_DEC_TCP_ACK: [...] * * Action configuration specifies the value to decrease TCP acknowledgment * number as a big-endian 32 bit integer. * * @p conf type: * @code const rte_be32_t * @endcode */ I know other actions do not have the same format but we'll update them eventually. -- Adrien Mazarguil 6WIND