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:   Colin Foster <colin.foster@in-advantage.com>
To:     linux-kernel@vger.kernel.org, netdev@vger.kernel.org
Cc:     Jakub Kicinski <kuba@kernel.org>,
        "David S. Miller" <davem@davemloft.net>,
        UNGLinuxDriver@microchip.com,
        Alexandre Belloni <alexandre.belloni@bootlin.com>,
        Claudiu Manoil <claudiu.manoil@nxp.com>,
        Vladimir Oltean <vladimir.oltean@nxp.com>,
        Vladimir Oltean <olteanv@gmail.com>
Subject: [PATCH v6 net-next 1/5] net: mscc: ocelot: fix mutex lock error during ethtool stats read
Date:   Wed,  9 Feb 2022 20:13:41 -0800
Message-Id: <20220210041345.321216-2-colin.foster@in-advantage.com>
In-Reply-To: <20220210041345.321216-1-colin.foster@in-advantage.com>
References: <20220210041345.321216-1-colin.foster@in-advantage.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?aVeDfyUUkcTkHkLUVkrijv6Nt98EHQUhUL8PjoMhRCqVxXSCP4LVAecYIWey?=
 =?us-ascii?Q?kXn1ONT8Sc88swK/UYLGiOydF+RGCY6+KDLF8kctTii+efca2xhPCw/+pC1B?=
 =?us-ascii?Q?Z9wNv/onzfYtQevmEXLKuzmLy0v5gJrVlI3Fpz95sygxJRVLx+6NgpU0ll3C?=
 =?us-ascii?Q?Bju8tK05Bz2fxU5NzK+Iu46AjAPP9Ae06eSusUtLtAcuKpHXG2DgHhV9JLHF?=
 =?us-ascii?Q?lZ72FcHQWTQF0wF1wQUlYNbR+s1uBozRmUnChrx/bsh0haQuOoMqLvqVNVqA?=
 =?us-ascii?Q?BB/Z3NNHh94UEqtSM1aJsQsHkWJoFRNo4l+URazDWTNY7aE00wwvz5IyuJJg?=
 =?us-ascii?Q?ucO9t1zVEzMkhRGi9D4u25VUQMM6tyc2iMGple5kuom5bhh9vsUOYA08yCxH?=
 =?us-ascii?Q?hxLs5LBdL2OtPO3awwHM6bP6Pg9mJ4rWjbBLwr+yqRAj07n41gX+WEwMRmZ/?=
 =?us-ascii?Q?bkMdOeqL/SBVUbxDebfMgN2EI7kXBLIw5JJvw4FVAb1t6UtKZk5bmgd50wHe?=
 =?us-ascii?Q?5usjSMf3coVob6ZSz2nOv7A3lRslbteibfGARTwszwwWjJuk0dynQFit0CG1?=
 =?us-ascii?Q?lAXCLaPtfg2ltfK1rATN4UCM5lDk3kie65eMtLSHKAwLNKEQeNLLkhhp4zHS?=
 =?us-ascii?Q?OXGA1nJ3AQ5BTBWgHkPOuEBza+OBzKwXYLiPyWvENNHKdqOoPVtI9LmF/nlG?=
 =?us-ascii?Q?6KMYdUn8yDuQ7WbrAvguahkM1GL0vA2Cfzf3s9vtMQ5mjhTvLTdrhROw3YdK?=
 =?us-ascii?Q?BjP3qv6LZySVEyZBwwH886yqMf6qp4yvNhIVSqVuQ542PY3gDNT2BtcUlAir?=
 =?us-ascii?Q?YzLuSXAUyGq3eFrqMktPlN4G9FsQwwkO++KEGT7tlw81zSZWd5YxhjtOR86e?=
 =?us-ascii?Q?INqoX4eb9eN7Hl44kPLIkbSeuObIBptGA287Em1A1W5+lGR71FOXpvC8UrC+?=
 =?us-ascii?Q?XolLc2XfMkLv5jKX/Y1Z0eH0adPLPqssZ/aAlotxRpxjWA5IwmZL3rFfCoLX?=
 =?us-ascii?Q?cJuqyIQ5LWWN7uPMZ0arfueZR/isPAEo6o1/YolM2ZtovSE/vs/EQIqAjxdR?=
 =?us-ascii?Q?NIcSVPiq8eDO+0WE42wjDNhfrsjYM/UqiS2HLBzm09efsTQjJjXNShLUjq2l?=
 =?us-ascii?Q?B5lWhsaN9wZKg9jgUHOYqaqYIHX21dmHrlUWI/O/OPBiH4PY1YkPvPU3gb5T?=
 =?us-ascii?Q?6wmOX3gCb4LBN4/wYGejMMjwEYoiar+vcOgcQICB8Brq1xPdm/BAlGMHRc/Z?=
 =?us-ascii?Q?33Fvps/aCqI/GXsMLoXLadrpOP4Er7karRPjGbLKsWyT4VcYMjNs5pEhwMGu?=
 =?us-ascii?Q?IlRIgvAi+igWtXdxVTQ8Y/J028eeYDwNhNW2qwOJaO2CXseeGQKZqg5sJeVt?=
 =?us-ascii?Q?tG6ns52W3t40v2eWgOSljb+9VylcGpUkdZDh5KPzXkYSehjbg+5bMQblkcVz?=
 =?us-ascii?Q?zCqF6zdrtHY3li8woXMxk6F8O5BAUuLpfovj27pk/E6Op1lxJCXnZXWlgz2A?=
 =?us-ascii?Q?inuJV4yWpoOJL0/YLmITg6J1DJ5zQP2oeG6pfMHGfXEDSqzs/S39f0ocU5tJ?=
 =?us-ascii?Q?Y3JhELEX8lFOXBWHuMNNkTcCE4tvdChNeMe+wFmu0D4dufRbOwJJCoYVuNIF?=
 =?us-ascii?Q?g4HdleeNN1a4ojbPRnVKOkBjYltemKCkZolIbYWVvSAWMdFwNveq+XzqeHQR?=
 =?us-ascii?Q?CaVbngZa6pr3+575qQ8wtjyshYQ=3D?=
X-OriginatorOrg: in-advantage.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 4b184d77-46e9-4dcf-bdc1-08d9ec4bfbc6
X-MS-Exchange-CrossTenant-AuthSource: DM5PR1001MB2345.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 10 Feb 2022 04:15:34.3100
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 48e842ca-fbd8-4633-a79d-0c955a7d3aae
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: eegGckG9wKtdC4q6HJSw8wB0zEC3IPlVWSYojEtp/NQ2SgNj9CnkuDY6dNmBAv/jNVzKaApihLYyD2Hkqc5Ukqj5/KzCOhOdxQ/Y4VDk7pQ=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN7PR10MB2564
X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS,
        T_SCC_BODY_TEXT_LINE 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

An ongoing workqueue populates the stats buffer. At the same time, a user
might query the statistics. While writing to the buffer is mutex-locked,
reading from the buffer wasn't. This could lead to buggy reads by ethtool.

Signed-off-by: Colin Foster <colin.foster@in-advantage.com>
Fixes: a556c76adc052 ("net: mscc: Add initial Ocelot switch support")
Reported-by: Vladimir Oltean <olteanv@gmail.com>
---
 drivers/net/ethernet/mscc/ocelot.c | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/drivers/net/ethernet/mscc/ocelot.c b/drivers/net/ethernet/mscc/ocelot.c
index 455293aa6343..6933dff1dd37 100644
--- a/drivers/net/ethernet/mscc/ocelot.c
+++ b/drivers/net/ethernet/mscc/ocelot.c
@@ -1737,12 +1737,11 @@ void ocelot_get_strings(struct ocelot *ocelot, int port, u32 sset, u8 *data)
 }
 EXPORT_SYMBOL(ocelot_get_strings);
 
+/* Caller must hold &ocelot->stats_lock */
 static void ocelot_update_stats(struct ocelot *ocelot)
 {
 	int i, j;
 
-	mutex_lock(&ocelot->stats_lock);
-
 	for (i = 0; i < ocelot->num_phys_ports; i++) {
 		/* Configure the port to read the stats from */
 		ocelot_write(ocelot, SYS_STAT_CFG_STAT_VIEW(i), SYS_STAT_CFG);
@@ -1761,8 +1760,6 @@ static void ocelot_update_stats(struct ocelot *ocelot)
 					      ~(u64)U32_MAX) + val;
 		}
 	}
-
-	mutex_unlock(&ocelot->stats_lock);
 }
 
 static void ocelot_check_stats_work(struct work_struct *work)
@@ -1771,7 +1768,9 @@ static void ocelot_check_stats_work(struct work_struct *work)
 	struct ocelot *ocelot = container_of(del_work, struct ocelot,
 					     stats_work);
 
+	mutex_lock(&ocelot->stats_lock);
 	ocelot_update_stats(ocelot);
+	mutex_unlock(&ocelot->stats_lock);
 
 	queue_delayed_work(ocelot->stats_queue, &ocelot->stats_work,
 			   OCELOT_STATS_CHECK_DELAY);
@@ -1781,12 +1780,16 @@ void ocelot_get_ethtool_stats(struct ocelot *ocelot, int port, u64 *data)
 {
 	int i;
 
+	mutex_lock(&ocelot->stats_lock);
+
 	/* check and update now */
 	ocelot_update_stats(ocelot);
 
 	/* Copy all counters */
 	for (i = 0; i < ocelot->num_stats; i++)
 		*data++ = ocelot->stats[port * ocelot->num_stats + i];
+
+	mutex_unlock(&ocelot->stats_lock);
 }
 EXPORT_SYMBOL(ocelot_get_ethtool_stats);
 
-- 
2.25.1