Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Vladimir Oltean <vladimir.oltean@nxp.com>
To:     netdev@vger.kernel.org
Cc:     "David S. Miller" <davem@davemloft.net>,
        Eric Dumazet <edumazet@google.com>,
        Jakub Kicinski <kuba@kernel.org>,
        Paolo Abeni <pabeni@redhat.com>,
        Claudiu Manoil <claudiu.manoil@nxp.com>,
        linux-kernel@vger.kernel.org
Subject: [PATCH net] net: enetc: zeroize buffer descriptors in enetc_dma_alloc_bdr()
Date:   Mon, 24 Oct 2022 20:20:49 +0300
Message-Id: <20221024172049.4187400-1-vladimir.oltean@nxp.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?XDMETNTMAA2Kf3LwfjWjlpf+0V+6DeI7nPIVmyhkMnWbzyTVwvSg7ITmypCq?=
 =?us-ascii?Q?Q13ACmHqIB3j7mJK81RMDWCg/LXstpG2csLHr4F8Pcl2hG3tVvGXAMNiJpsn?=
 =?us-ascii?Q?ktQ4TUNruH+cMSIKcJqgdd2oYBD3Ibk2v41vYgdIiwdX9STa8HgzUNUdgL28?=
 =?us-ascii?Q?xvvKryXC0f8SiHQ3wuw5Foua8sJNCkU/z5woqlmnp8fnl9aidb6o5qturhw/?=
 =?us-ascii?Q?ywehmlNuSeYQpO2C8l8XxA87ZFucpAc3Ct8q4/0Zx4ZuNd+OGEEM5FOhk0LZ?=
 =?us-ascii?Q?AKPylsh4XX6nwpzAJlrM61ZteCMGizSYekDIIs17AKojbrqB67xbAc/MDEzj?=
 =?us-ascii?Q?UaEEuBtHq4DGt46IxPydVK5MeECkASROCj6jc/l9HFggVNLXDf0T30azOStM?=
 =?us-ascii?Q?zOEQFTloewWrgJQuLG62thmq5NeKQjWe237x9PmJqpDcpCgFbaXJ0Iz1s+fW?=
 =?us-ascii?Q?kqQA2iPCH4oQGWPhObSUgTtR6ztH0n8AZbOHRre+xsmdCyyHieAlIJlXEmQB?=
 =?us-ascii?Q?m3LUphi9LX/yzkC7zGxmheHVWD9EtDO0+S7NFhLsKZy7geOBndzV6J5U5F/J?=
 =?us-ascii?Q?biM4i/RXam9y6awjYbvSvuNH8GSJi6jeQ6XhUFzOrk3/Sn4PQHrgrvA6GyMu?=
 =?us-ascii?Q?1NFPGn/7VGCq1/SVj1LjMTdNpCWHQC+J5Mj5pMHFjdojSDJcqYX4GWZA/qj7?=
 =?us-ascii?Q?DyKi5bVNBujaOG/7xIS1SLYdxKiS9yaSZDexblf/FK2MACBPcSeGNaOicBC7?=
 =?us-ascii?Q?W9gEPS8PnP98Wfvbhmj9nJRZr73Reh3/6v29KBHHZ6yenc6PuHF0MvObOFEe?=
 =?us-ascii?Q?JlXDEgWjqRSsqqgdgjavLlqtQ0Yjtf0wrMP2lyZWJVTXY/SnjDKjmnsVEqyS?=
 =?us-ascii?Q?OIdBRH3uMvbKM8atNRKHbNJ4JA6DypiKTfuesMcpWPYjDH+TH1bA3uyhVgWP?=
 =?us-ascii?Q?0VhkPn1jYjRxYiv8Zl9Y2YJXSnQQJ129SS8ByEWIuDoSZ1yYz20cw+eUS3+a?=
 =?us-ascii?Q?/pWnAtamsy5+PHPm+eWPktGZjRiqGKWYU28YIWKrAToY2DfN5Mo2FguazFEQ?=
 =?us-ascii?Q?79BWE13u5lEyjvV06RBaeCoYPnO96sEfv19BfDXqSTSGtGUe2+uUJ7xFs2e4?=
 =?us-ascii?Q?H6zenh6xpTvfgtNHEPs5OZCiXT7q/nyQns9RHCiYODo/39QP4M/9DywTYLw2?=
 =?us-ascii?Q?GwG2XQLhmhQjJGbloNSNe1lRg6qirdC6D5Yvv5XvuHnHd8TtOwkl4DXH45Kr?=
 =?us-ascii?Q?P86J7LpPfbf/n68ImTaNpkGXN7SEur9saja7/yrQM6zFS6vvwSruWe1LOn2y?=
 =?us-ascii?Q?P5LB7XJW3ASPqP2gDVMUY5bd4ec1AYbw45G5pWDpfXcFE4ju59WaTPnWmLxT?=
 =?us-ascii?Q?51POiqu6wFzhhwGpaQVM0Un+UHRb481+/mULPk6mcs9jdf4TSKB2ItZ1obF/?=
 =?us-ascii?Q?Zxepbc60lh7zWShpo5JOD5ZGVL38XXVKicjh6DTLzptgq9JWDVKNpZjmpsXr?=
 =?us-ascii?Q?xgkB+t6dUG/Z+jxZZkQT7iGwjyDw7AvczJT/3gh4+KSovtSIdMGvbMX3zLLN?=
 =?us-ascii?Q?vISDfZskQLtb+KLhByNS+RWZbOVI5RR6D4w2nZAUXaj8b+jUbmv6se89JhCv?=
 =?us-ascii?Q?mw=3D=3D?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 4618dcda-9908-4a73-e115-08dab5e42248
X-MS-Exchange-CrossTenant-AuthSource: VI1PR04MB5136.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 24 Oct 2022 17:21:06.1375
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: dmKmiKEfhAXbiw2yyxiSOvWpcZ0biOrN3uRD531bOwQ1aABFmDsfdCRmwjfgSZ18ACbaK7MFaTI6I6/xBgdiBg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB8PR04MB7003
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS autolearn=ham
        autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Under memory pressure, enetc_refill_rx_ring() may fail, and when called
during the enetc_open() -> enetc_setup_rxbdr() procedure, this is not
checked for.

An extreme case of memory pressure will result in exactly zero buffers
being allocated for the RX ring, and in such a case it is expected that
hardware drops all RX packets due to lack of buffers.

The hardware drop happens, however the driver has undefined behavior and
may even crash. Explanation follows below.

The enetc NAPI poll procedure is shared between RX and TX conf, and
enetc_poll() calls enetc_clean_rx_ring() even if the reason why NAPI was
scheduled is TX.

The enetc_clean_rx_ring() function (and its XDP derivative) is not
prepared to handle such a condition. It has this loop exit condition:

		rxbd = enetc_rxbd(rx_ring, i);
		bd_status = le32_to_cpu(rxbd->r.lstatus);
		if (!bd_status)
			break;

otherwise said, the NAPI poll procedure does not look at the Producer
Index of the RX ring, instead it just walks circularly through the
descriptors until it finds one which is not Ready.

The problem is that the enetc_rxbd(rx_ring, i) RX descriptor is only
initialized by enetc_refill_rx_ring() if page allocation has succeeded.

So if memory allocation ever failed, enetc_clean_rx_ring() looks at
rxbd->r.lstatus as an exit condition, but "rxbd" itself is uninitialized
memory. If it contains junk, then junk buffers will be processed.

To fix the problem, memset the DMA coherent area used for BD rings.
This makes all BDs be "not ready" by default, which makes
enetc_clean_rx_ring() exit early from the BD processing loop when there
is no valid buffer available.

Fixes: d4fd0404c1c9 ("enetc: Introduce basic PF and VF ENETC ethernet drivers")
Signed-off-by: Vladimir Oltean <vladimir.oltean@nxp.com>
---
 drivers/net/ethernet/freescale/enetc/enetc.c | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/drivers/net/ethernet/freescale/enetc/enetc.c b/drivers/net/ethernet/freescale/enetc/enetc.c
index 54bc92fc6bf0..1c272ca3a05a 100644
--- a/drivers/net/ethernet/freescale/enetc/enetc.c
+++ b/drivers/net/ethernet/freescale/enetc/enetc.c
@@ -1738,18 +1738,21 @@ void enetc_get_si_caps(struct enetc_si *si)
 
 static int enetc_dma_alloc_bdr(struct enetc_bdr *r, size_t bd_size)
 {
-	r->bd_base = dma_alloc_coherent(r->dev, r->bd_count * bd_size,
-					&r->bd_dma_base, GFP_KERNEL);
+	size_t size = r->bd_count * bd_size;
+
+	r->bd_base = dma_alloc_coherent(r->dev, size, &r->bd_dma_base,
+					GFP_KERNEL);
 	if (!r->bd_base)
 		return -ENOMEM;
 
 	/* h/w requires 128B alignment */
 	if (!IS_ALIGNED(r->bd_dma_base, 128)) {
-		dma_free_coherent(r->dev, r->bd_count * bd_size, r->bd_base,
-				  r->bd_dma_base);
+		dma_free_coherent(r->dev, size, r->bd_base, r->bd_dma_base);
 		return -EINVAL;
 	}
 
+	memset(r->bd_base, 0, size);
+
 	return 0;
 }
 
-- 
2.34.1