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 1BCC0A0C40; Fri, 30 Jul 2021 17:58:09 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 9352240040; Fri, 30 Jul 2021 17:58:08 +0200 (CEST) Received: from mail-wr1-f53.google.com (mail-wr1-f53.google.com [209.85.221.53]) by mails.dpdk.org (Postfix) with ESMTP id D20194003F for ; Fri, 30 Jul 2021 17:58:06 +0200 (CEST) Received: by mail-wr1-f53.google.com with SMTP id c16so11871632wrp.13 for ; Fri, 30 Jul 2021 08:58:06 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind.com; s=google; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=/XXOBMRzklqo94Ynh9oQuWGcYv77mqdT8LZVQWvs3WY=; b=PISSfS8pls/6mmlq1t/LHJonHGxknAlpFee9SK7OYBYrE7dsuefcrniSMdOpkYviqx J52Rmo2fS5kg3u1NgwSH70PB+2oZIh2KD5qo4gsaVxUsTVV3uF1FESVdLlh1QINFJgZq jUK2xF8wtitVUC9QuNj5a/SJVvG1tGU0gIaHsaQikk7n8q9Yu6KDYJI5BoJoX/W2ypGZ 62vUpKme5sO1vxoNhWG7UM/K+kovflgEjOtnxSUqqNfInrWLhGG/UnNmFjNq+hX1JU88 ocqDO1xfCn+46xQplZBjxIRF8L3yMF2jsPU8IRNRrGIspXFANIXJYs0jDvltAbBwBT1y fkCg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=/XXOBMRzklqo94Ynh9oQuWGcYv77mqdT8LZVQWvs3WY=; b=dWPJcaGiHsd1Cjnvd6D6p6eAmkQ1Gbjv2oWj8VgJOVDJosUPrQPBhfqxUeGzbAvVNR 0c09i7dyUFgRnCZUxpt4Zam/FtvxUopGaGKnaLMixFBfN/jwpW9gszz3+RsSSJNjjF3P BuBCRI+FDTXKZpirURQ832gzb1gLdHkbHvt+Vp0hd/pmcKKKl5aCEdO07G0qn1P0kB9z xYzwzwF5R12xB0aXHkP2bTeFkjAY57FY471GQ803PkLX1RRrL9FE0Y1EIdkIcyQgjbpH jY+SuV3stH9akzSBFogfMG0CrnYO0zB0ju33R3HZkaoh+jZ4UV8PZ/1t3nV5LjMWsoxX 5X/w== X-Gm-Message-State: AOAM532xWqeCktDvEnIh4DcvPB8SZAO5UiORkHpfXAC/8lurBk3R+FIU Ddu4IC0b3fnONx3eXeRacGwCRC874eDBTPgP X-Google-Smtp-Source: ABdhPJyJwIvDrldFkWQI9+laKgJzcJ7vijG+6d3vZ0z+SOFeEJO4+r+ZD0buUO0EyrkpB+Z53qGpYg== X-Received: by 2002:adf:ecc9:: with SMTP id s9mr3755393wro.306.1627660686426; Fri, 30 Jul 2021 08:58:06 -0700 (PDT) Received: from gojira.dev.6wind.com (host.78.145.23.62.rev.coltfrance.com. [62.23.145.78]) by smtp.gmail.com with ESMTPSA id y197sm2328142wmc.7.2021.07.30.08.58.05 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 30 Jul 2021 08:58:05 -0700 (PDT) From: Olivier Matz To: dev@dpdk.org Cc: Ray Kinsella Date: Fri, 30 Jul 2021 17:57:01 +0200 Message-Id: <20210730155700.32574-1-olivier.matz@6wind.com> X-Mailer: git-send-email 2.29.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH] doc: announce renaming of mbuf offload flags 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 Sender: "dev" The mbuf offload flags do not match the DPDK namespace (they are not prefixed by RTE_). Announce their rename in 21.11, and the removal of the old names in 22.11. A draft coccinelle script is provided to anticipate what the renaming will be. Signed-off-by: Olivier Matz --- .../cocci/prefix_mbuf_offload_flags.cocci | 436 ++++++++++++++++++ doc/guides/rel_notes/deprecation.rst | 5 + 2 files changed, 441 insertions(+) create mode 100644 devtools/cocci/prefix_mbuf_offload_flags.cocci diff --git a/devtools/cocci/prefix_mbuf_offload_flags.cocci b/devtools/cocci/prefix_mbuf_offload_flags.cocci new file mode 100644 index 0000000000..8bfc7c29d1 --- /dev/null +++ b/devtools/cocci/prefix_mbuf_offload_flags.cocci @@ -0,0 +1,436 @@ +// +// Rename mbuf offload flags (and some other defines) to have +// an RTE_ prefix. +// This only replaces usages in C code, so it is advised to +// check for missing occurences with: +// for f in $(git ls-tree --full-tree -r --name-only HEAD); do +// if [ "$(file -b --mime-encoding $f)" != binary ]; then +// sed -i -e 's,PKT_RX_,RTE_MBUF_F_RX_,g' \ +// -e 's,PKT_TX_,RTE_MBUF_F_TX_,g' \ +// -e 's,EXT_ATTACHED_MBUF,RTE_MBUF_F_EXTERNAL,g' \ +// -e 's,IND_ATTACHED_MBUF,RTE_MBUF_F_INDIRECT,g' \ +// -e 's,PKT_FIRST_FREE,RTE_MBUF_F_FIRST_FREE,g' \ +// -e 's,PKT_LAST_FREE,RTE_MBUF_F_LAST_FREE,g' $f +// fi +// done +// +@@ +@@ + +- PKT_RX_VLAN ++ RTE_MBUF_F_RX_VLAN + +@@ +@@ + +- PKT_RX_RSS_HASH ++ RTE_MBUF_F_RX_RSS_HASH + +@@ +@@ + +- PKT_RX_FDIR ++ RTE_MBUF_F_RX_FDIR + +@@ +@@ + +- PKT_RX_L4_CKSUM_BAD ++ RTE_MBUF_F_RX_L4_CKSUM_BAD + +@@ +@@ + +- PKT_RX_IP_CKSUM_BAD ++ RTE_MBUF_F_RX_IP_CKSUM_BAD + +@@ +@@ + +- PKT_RX_OUTER_IP_CKSUM_BAD ++ RTE_MBUF_F_RX_OUTER_IP_CKSUM_BAD + +@@ +@@ + +- PKT_RX_EIP_CKSUM_BAD ++ RTE_MBUF_F_RX_EIP_CKSUM_BAD + +@@ +@@ + +- PKT_RX_VLAN_STRIPPED ++ RTE_MBUF_F_RX_VLAN_STRIPPED + +@@ +@@ + +- PKT_RX_IP_CKSUM_MASK ++ RTE_MBUF_F_RX_IP_CKSUM_MASK + +@@ +@@ + +- PKT_RX_IP_CKSUM_UNKNOWN ++ RTE_MBUF_F_RX_IP_CKSUM_UNKNOWN + +@@ +@@ + +- PKT_RX_IP_CKSUM_BAD ++ RTE_MBUF_F_RX_IP_CKSUM_BAD + +@@ +@@ + +- PKT_RX_IP_CKSUM_GOOD ++ RTE_MBUF_F_RX_IP_CKSUM_GOOD + +@@ +@@ + +- PKT_RX_IP_CKSUM_NONE ++ RTE_MBUF_F_RX_IP_CKSUM_NONE + +@@ +@@ + +- PKT_RX_L4_CKSUM_MASK ++ RTE_MBUF_F_RX_L4_CKSUM_MASK + +@@ +@@ + +- PKT_RX_L4_CKSUM_UNKNOWN ++ RTE_MBUF_F_RX_L4_CKSUM_UNKNOWN + +@@ +@@ + +- PKT_RX_L4_CKSUM_BAD ++ RTE_MBUF_F_RX_L4_CKSUM_BAD + +@@ +@@ + +- PKT_RX_L4_CKSUM_GOOD ++ RTE_MBUF_F_RX_L4_CKSUM_GOOD + +@@ +@@ + +- PKT_RX_L4_CKSUM_NONE ++ RTE_MBUF_F_RX_L4_CKSUM_NONE + +@@ +@@ + +- PKT_RX_IEEE1588_PTP ++ RTE_MBUF_F_RX_IEEE1588_PTP + +@@ +@@ + +- PKT_RX_IEEE1588_TMST ++ RTE_MBUF_F_RX_IEEE1588_TMST + +@@ +@@ + +- PKT_RX_FDIR_ID ++ RTE_MBUF_F_RX_FDIR_ID + +@@ +@@ + +- PKT_RX_FDIR_FLX ++ RTE_MBUF_F_RX_FDIR_FLX + +@@ +@@ + +- PKT_RX_QINQ_STRIPPED ++ RTE_MBUF_F_RX_QINQ_STRIPPED + +@@ +@@ + +- PKT_RX_LRO ++ RTE_MBUF_F_RX_LRO + +@@ +@@ + +- PKT_RX_SEC_OFFLOAD ++ RTE_MBUF_F_RX_SEC_OFFLOAD + +@@ +@@ + +- PKT_RX_SEC_OFFLOAD_FAILED ++ RTE_MBUF_F_RX_SEC_OFFLOAD_FAILED + +@@ +@@ + +- PKT_RX_QINQ ++ RTE_MBUF_F_RX_QINQ + +@@ +@@ + +- PKT_RX_OUTER_L4_CKSUM_MASK ++ RTE_MBUF_F_RX_OUTER_L4_CKSUM_MASK + +@@ +@@ + +- PKT_RX_OUTER_L4_CKSUM_UNKNOWN ++ RTE_MBUF_F_RX_OUTER_L4_CKSUM_UNKNOWN + +@@ +@@ + +- PKT_RX_OUTER_L4_CKSUM_BAD ++ RTE_MBUF_F_RX_OUTER_L4_CKSUM_BAD + +@@ +@@ + +- PKT_RX_OUTER_L4_CKSUM_GOOD ++ RTE_MBUF_F_RX_OUTER_L4_CKSUM_GOOD + +@@ +@@ + +- PKT_RX_OUTER_L4_CKSUM_INVALID ++ RTE_MBUF_F_RX_OUTER_L4_CKSUM_INVALID + +@@ +@@ + +- PKT_FIRST_FREE ++ RTE_MBUF_F_FIRST_FREE + +@@ +@@ + +- PKT_LAST_FREE ++ RTE_MBUF_F_LAST_FREE + +@@ +@@ + +- PKT_TX_OUTER_UDP_CKSUM ++ RTE_MBUF_F_TX_OUTER_UDP_CKSUM + +@@ +@@ + +- PKT_TX_UDP_SEG ++ RTE_MBUF_F_TX_UDP_SEG + +@@ +@@ + +- PKT_TX_SEC_OFFLOAD ++ RTE_MBUF_F_TX_SEC_OFFLOAD + +@@ +@@ + +- PKT_TX_MACSEC ++ RTE_MBUF_F_TX_MACSEC + +@@ +@@ + +- PKT_TX_TUNNEL_VXLAN ++ RTE_MBUF_F_TX_TUNNEL_VXLAN + +@@ +@@ + +- PKT_TX_TUNNEL_GRE ++ RTE_MBUF_F_TX_TUNNEL_GRE + +@@ +@@ + +- PKT_TX_TUNNEL_IPIP ++ RTE_MBUF_F_TX_TUNNEL_IPIP + +@@ +@@ + +- PKT_TX_TUNNEL_GENEVE ++ RTE_MBUF_F_TX_TUNNEL_GENEVE + +@@ +@@ + +- PKT_TX_TUNNEL_MPLSINUDP ++ RTE_MBUF_F_TX_TUNNEL_MPLSINUDP + +@@ +@@ + +- PKT_TX_TUNNEL_VXLAN_GPE ++ RTE_MBUF_F_TX_TUNNEL_VXLAN_GPE + +@@ +@@ + +- PKT_TX_TUNNEL_GTP ++ RTE_MBUF_F_TX_TUNNEL_GTP + +@@ +@@ + +- PKT_TX_TUNNEL_IP ++ RTE_MBUF_F_TX_TUNNEL_IP + +@@ +@@ + +- PKT_TX_TUNNEL_UDP ++ RTE_MBUF_F_TX_TUNNEL_UDP + +@@ +@@ + +- PKT_TX_TUNNEL_MASK ++ RTE_MBUF_F_TX_TUNNEL_MASK + +@@ +@@ + +- PKT_TX_QINQ ++ RTE_MBUF_F_TX_QINQ + +@@ +@@ + +- PKT_TX_QINQ_PKT ++ RTE_MBUF_F_TX_QINQ_PKT + +@@ +@@ + +- PKT_TX_TCP_SEG ++ RTE_MBUF_F_TX_TCP_SEG + +@@ +@@ + +- PKT_TX_IEEE1588_TMST ++ RTE_MBUF_F_TX_IEEE1588_TMST + +@@ +@@ + +- PKT_TX_L4_NO_CKSUM ++ RTE_MBUF_F_TX_L4_NO_CKSUM + +@@ +@@ + +- PKT_TX_TCP_CKSUM ++ RTE_MBUF_F_TX_TCP_CKSUM + +@@ +@@ + +- PKT_TX_SCTP_CKSUM ++ RTE_MBUF_F_TX_SCTP_CKSUM + +@@ +@@ + +- PKT_TX_UDP_CKSUM ++ RTE_MBUF_F_TX_UDP_CKSUM + +@@ +@@ + +- PKT_TX_L4_MASK ++ RTE_MBUF_F_TX_L4_MASK + +@@ +@@ + +- PKT_TX_IP_CKSUM ++ RTE_MBUF_F_TX_IP_CKSUM + +@@ +@@ + +- PKT_TX_IPV4 ++ RTE_MBUF_F_TX_IPV4 + +@@ +@@ + +- PKT_TX_IPV6 ++ RTE_MBUF_F_TX_IPV6 + +@@ +@@ + +- PKT_TX_VLAN ++ RTE_MBUF_F_TX_VLAN + +@@ +@@ + +- PKT_TX_VLAN_PKT ++ RTE_MBUF_F_TX_VLAN_PKT + +@@ +@@ + +- PKT_TX_OUTER_IP_CKSUM ++ RTE_MBUF_F_TX_OUTER_IP_CKSUM + +@@ +@@ + +- PKT_TX_OUTER_IPV4 ++ RTE_MBUF_F_TX_OUTER_IPV4 + +@@ +@@ + +- PKT_TX_OUTER_IPV6 ++ RTE_MBUF_F_TX_OUTER_IPV6 + +@@ +@@ + +- PKT_TX_OFFLOAD_MASK ++ RTE_MBUF_F_TX_OFFLOAD_MASK + +@@ +@@ + +- EXT_ATTACHED_MBUF ++ RTE_MBUF_F_EXTERNAL + +@@ +@@ + +- IND_ATTACHED_MBUF ++ RTE_MBUF_F_INDIRECT + +@@ +@@ + +- PKT_TX_DYNF_METADATA ++ RTE_MBUF_F_TX_DYNF_METADATA + +@@ +@@ + +- PKT_RX_DYNF_METADATA ++ RTE_MBUF_F_RX_DYNF_METADATA + diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 9584d6bfd7..04cb141de7 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -147,3 +147,8 @@ Deprecation Notices * cmdline: ``cmdline`` structure will be made opaque to hide platform-specific content. On Linux and FreeBSD, supported prior to DPDK 20.11, original structure will be kept until DPDK 21.11. + +* mbuf: The mbuf offload flags ``PKT_*`` will be renamed as ``RTE_MBUF_F_*``. + A compatibility layer will be kept until DPDK 22.11, except for the flags + that are already deprecated (ex: ``PKT_RX_L4_CKSUM_BAD``), which will + be removed. -- 2.29.2