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 1D3D5A04B5 for ; Wed, 13 Jan 2021 14:28:10 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 05856140D1B; Wed, 13 Jan 2021 14:28:10 +0100 (CET) Received: from mail-wm1-f50.google.com (mail-wm1-f50.google.com [209.85.128.50]) by mails.dpdk.org (Postfix) with ESMTP id B01AC140D1B for ; Wed, 13 Jan 2021 14:28:08 +0100 (CET) Received: by mail-wm1-f50.google.com with SMTP id r4so1604946wmh.5 for ; Wed, 13 Jan 2021 05:28:08 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind.com; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=7YV2pCtuDLgFwp1YQwjintkrdqFBdSo3VCDbMtCGVBo=; b=bCIjzYA9UB2TAmDyZ4ukEDqWhXz+wc2CkybdJXZotsmgff/HTrSfcs0uT6Q5y/lZ9A /TR1v4K83sDettuD+y0GJsxanENNighLHjh8Yc7bAnVYPLqnCccfyrcUy75y3vk3WSyV tf0CtjAC4ealmvEQ+7V/709dGLPA5H6b+LtLh8DRDHl6M6rij0nC6BgjBOfRFZ3uefy2 uFsJ6/pCwxS2RNLxZccZCJMohRLn7xaI1VtP56TJSJnS57VlxWCiBbYsEuYDHvRmEnio szqWaLrr+HuAXtMe1bK2IkzrQqGvVVt/vezrE1hD74wAtnArv59sPr0EFTN3fk2PgkcC +UDA== 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:in-reply-to :references:mime-version:content-transfer-encoding; bh=7YV2pCtuDLgFwp1YQwjintkrdqFBdSo3VCDbMtCGVBo=; b=SNEyus/jSO5dwWpxmI9KULNQo1urmDTc5X542Hu2jTG9zVBi37gKWLRfdZ+5RXolNJ RnAPXH1gBWhJR5xF1WYCmxfi9MMkJiA1ZZ0fn2SRzakBRRXRXCpyi7kgsWow1o+Xot4l ufM1GZ8VNxLm/RRMqjBshEW8GbB2s4p88SAm2sTRH8kGGt7HV9nXhGyd2e6joi3uYMuo E84lOK8jJDSzmEhvhzh/4257ai8CoHjz8TZWuNe+M0u81u1mn2YjKhsoe5EmnyMbY/k+ F/Xq3ne+PwSjPdHTxIKud/Ku8zdD77UQ5h6iHqKYg3HllD8Hs+gLC//KtmSFNmdeQu5b D8Pw== X-Gm-Message-State: AOAM530/YpG5qoiqpqsJNnwRGk8lcKnI12iz4Z/zIpFBzcvE94dHOY6H QEdh61KvXW5vCEJPB0linCWaLw== X-Google-Smtp-Source: ABdhPJw+Ydml+so9gjrOWng0jv5LGoru4jv39SYBODzgnHG4OAK9vTe4+/KJvYyvCbYRJ4/x5TCXXQ== X-Received: by 2002:a05:600c:22d7:: with SMTP id 23mr2243601wmg.7.1610544488410; Wed, 13 Jan 2021 05:28:08 -0800 (PST) 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 i11sm2711061wmq.10.2021.01.13.05.28.07 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 13 Jan 2021 05:28:07 -0800 (PST) From: Olivier Matz To: dev@dpdk.org Cc: andrew.rybchenko@oktetlabs.ru, konstantin.ananyev@intel.com, mb@smartsharesystems.com, alialnu@nvidia.com, ajitkhaparde@gmail.com, stable@dpdk.org, Ajit Khaparde Date: Wed, 13 Jan 2021 14:27:34 +0100 Message-Id: <20210113132734.1636-1-olivier.matz@6wind.com> X-Mailer: git-send-email 2.29.2 In-Reply-To: <20201104170007.8026-1-olivier.matz@6wind.com> References: <20201104170007.8026-1-olivier.matz@6wind.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Subject: [dpdk-stable] [PATCH v4] mbuf: fix reset on mbuf free X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-bounces@dpdk.org Sender: "stable" m->nb_seg must be reset on mbuf free whatever the value of m->next, because it can happen that m->nb_seg is != 1. For instance in this case: m1 = rte_pktmbuf_alloc(mp); rte_pktmbuf_append(m1, 500); m2 = rte_pktmbuf_alloc(mp); rte_pktmbuf_append(m2, 500); rte_pktmbuf_chain(m1, m2); m0 = rte_pktmbuf_alloc(mp); rte_pktmbuf_append(m0, 500); rte_pktmbuf_chain(m0, m1); As rte_pktmbuf_chain() does not reset nb_seg in the initial m1 segment (this is not required), after this code the mbuf chain have 3 segments: - m0: next=m1, nb_seg=3 - m1: next=m2, nb_seg=2 - m2: next=NULL, nb_seg=1 Then split this chain between m1 and m2, it would result in 2 packets: - first packet - m0: next=m1, nb_seg=2 - m1: next=NULL, nb_seg=2 - second packet - m2: next=NULL, nb_seg=1 Freeing the first packet will not restore nb_seg=1 in the second segment. This is an issue because it is expected that mbufs stored in pool have their nb_seg field set to 1. Fixes: 8f094a9ac5d7 ("mbuf: set mbuf fields while in pool") Cc: stable@dpdk.org Signed-off-by: Olivier Matz Acked-by: Morten Brørup Acked-by: Ajit Khaparde Acked-by: Konstantin Ananyev --- v4 * add a unit test (suggested by David) v3 * fix commit log again (thanks Morten for spotting it) v2 * avoid write access if uneeded (suggested by Konstantin) * enhance comments in mbuf header file (suggested by Morten) * fix commit log app/test/test_mbuf.c | 69 +++++++++++++++++++++++++++++++++ lib/librte_mbuf/rte_mbuf.c | 4 +- lib/librte_mbuf/rte_mbuf.h | 8 ++-- lib/librte_mbuf/rte_mbuf_core.h | 13 ++++++- 4 files changed, 86 insertions(+), 8 deletions(-) diff --git a/app/test/test_mbuf.c b/app/test/test_mbuf.c index a40f7d4883..ad2cbab600 100644 --- a/app/test/test_mbuf.c +++ b/app/test/test_mbuf.c @@ -2677,6 +2677,70 @@ test_mbuf_dyn(struct rte_mempool *pktmbuf_pool) return -1; } +/* check that m->nb_segs and m->next are reset on mbuf free */ +static int +test_nb_segs_and_next_reset(void) +{ + struct rte_mbuf *m0 = NULL, *m1 = NULL, *m2 = NULL; + struct rte_mempool *pool = NULL; + + pool = rte_pktmbuf_pool_create("test_mbuf_reset", + 3, 0, 0, MBUF_DATA_SIZE, SOCKET_ID_ANY); + if (pool == NULL) + GOTO_FAIL("Failed to create mbuf pool"); + + /* alloc mbufs */ + m0 = rte_pktmbuf_alloc(pool); + m1 = rte_pktmbuf_alloc(pool); + m2 = rte_pktmbuf_alloc(pool); + if (m0 == NULL || m1 == NULL || m2 == NULL) + GOTO_FAIL("Failed to allocate mbuf"); + + /* append data in all of them */ + if (rte_pktmbuf_append(m0, 500) == NULL || + rte_pktmbuf_append(m1, 500) == NULL || + rte_pktmbuf_append(m2, 500) == NULL) + GOTO_FAIL("Failed to append data in mbuf"); + + /* chain them in one mbuf m0 */ + rte_pktmbuf_chain(m1, m2); + rte_pktmbuf_chain(m0, m1); + if (m0->nb_segs != 3 || m0->next != m1 || m1->next != m2 || + m2->next != NULL) { + m1 = m2 = NULL; + GOTO_FAIL("Failed to chain mbufs"); + } + + /* split m0 chain in two, between m1 and m2 */ + m0->nb_segs = 2; + m1->next = NULL; + m2->nb_segs = 1; + + /* free the 2 mbuf chains m0 and m2 */ + rte_pktmbuf_free(m0); + rte_pktmbuf_free(m2); + + /* realloc the 3 mbufs */ + m0 = rte_mbuf_raw_alloc(pool); + m1 = rte_mbuf_raw_alloc(pool); + m2 = rte_mbuf_raw_alloc(pool); + if (m0 == NULL || m1 == NULL || m2 == NULL) + GOTO_FAIL("Failed to reallocate mbuf"); + + /* ensure that m->next and m->nb_segs are reset allocated mbufs */ + if (m0->nb_segs != 1 || m0->next != NULL || + m1->nb_segs != 1 || m1->next != NULL || + m2->nb_segs != 1 || m2->next != NULL) + GOTO_FAIL("nb_segs or next was not reset properly"); + + return 0; + +fail: + if (pool != NULL) + rte_mempool_free(pool); + return -1; +} + static int test_mbuf(void) { @@ -2867,6 +2931,11 @@ test_mbuf(void) goto err; } + /* test reset of m->nb_segs and m->next on mbuf free */ + if (test_nb_segs_and_next_reset() < 0) { + printf("test_nb_segs_and_next_reset() failed\n"); + goto err; + } ret = 0; err: diff --git a/lib/librte_mbuf/rte_mbuf.c b/lib/librte_mbuf/rte_mbuf.c index 7d09ee2939..5f77840557 100644 --- a/lib/librte_mbuf/rte_mbuf.c +++ b/lib/librte_mbuf/rte_mbuf.c @@ -129,10 +129,10 @@ rte_pktmbuf_free_pinned_extmem(void *addr, void *opaque) rte_mbuf_ext_refcnt_set(m->shinfo, 1); m->ol_flags = EXT_ATTACHED_MBUF; - if (m->next != NULL) { + if (m->next != NULL) m->next = NULL; + if (m->nb_segs != 1) m->nb_segs = 1; - } rte_mbuf_raw_free(m); } diff --git a/lib/librte_mbuf/rte_mbuf.h b/lib/librte_mbuf/rte_mbuf.h index c4c9ebfaa0..8c1097ed76 100644 --- a/lib/librte_mbuf/rte_mbuf.h +++ b/lib/librte_mbuf/rte_mbuf.h @@ -1340,10 +1340,10 @@ rte_pktmbuf_prefree_seg(struct rte_mbuf *m) return NULL; } - if (m->next != NULL) { + if (m->next != NULL) m->next = NULL; + if (m->nb_segs != 1) m->nb_segs = 1; - } return m; @@ -1357,10 +1357,10 @@ rte_pktmbuf_prefree_seg(struct rte_mbuf *m) return NULL; } - if (m->next != NULL) { + if (m->next != NULL) m->next = NULL; + if (m->nb_segs != 1) m->nb_segs = 1; - } rte_mbuf_refcnt_set(m, 1); return m; diff --git a/lib/librte_mbuf/rte_mbuf_core.h b/lib/librte_mbuf/rte_mbuf_core.h index 567551deab..78a1fcc8ff 100644 --- a/lib/librte_mbuf/rte_mbuf_core.h +++ b/lib/librte_mbuf/rte_mbuf_core.h @@ -495,7 +495,12 @@ struct rte_mbuf { * or non-atomic) is controlled by the RTE_MBUF_REFCNT_ATOMIC flag. */ uint16_t refcnt; - uint16_t nb_segs; /**< Number of segments. */ + + /** + * Number of segments. Only valid for the first segment of an mbuf + * chain. + */ + uint16_t nb_segs; /** Input port (16 bits to support more than 256 virtual ports). * The event eth Tx adapter uses this field to specify the output port. @@ -591,7 +596,11 @@ struct rte_mbuf { /* second cache line - fields only used in slow path or on TX */ RTE_MARKER cacheline1 __rte_cache_min_aligned; - struct rte_mbuf *next; /**< Next segment of scattered packet. */ + /** + * Next segment of scattered packet. Must be NULL in the last segment or + * in case of non-segmented packet. + */ + struct rte_mbuf *next; /* fields to support TX offloads */ RTE_STD_C11 -- 2.29.2