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:     Paolo Abeni <pabeni@redhat.com>,
        Eric Dumazet <edumazet@google.com>,
        "David S. Miller" <davem@davemloft.net>,
        Florian Fainelli <f.fainelli@gmail.com>,
        Andrew Lunn <andrew@lunn.ch>, UNGLinuxDriver@microchip.com,
        Alexandre Belloni <alexandre.belloni@bootlin.com>,
        Claudiu Manoil <claudiu.manoil@nxp.com>,
        Vladimir Oltean <vladimir.oltean@nxp.com>
Subject: [PATCH v2 net-next 3/3] net: mscc: ocelot: issue a warning if stats are incorrectly ordered
Date:   Sat, 19 Nov 2022 15:14:06 -0800
Message-Id: <20221119231406.3167852-4-colin.foster@in-advantage.com>
In-Reply-To: <20221119231406.3167852-1-colin.foster@in-advantage.com>
References: <20221119231406.3167852-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?NhZIhcUBScE55+0J1kzJPiQW+dxjv4QrxZpCRi7KTxjclYStk7+BYFWiSwmx?=
 =?us-ascii?Q?B2pvRJnj/e09zTmGDHQfQw29T+RYM49Gi413AGenQrGiMR2rfEoblicwGOBX?=
 =?us-ascii?Q?Xk9JBmI4Cl3CGjsA1n69/eQCluGKe5YfUqfCu91rxY5aWzWN37raWGxQeX3i?=
 =?us-ascii?Q?iR6fm4Cy+k/CePTuN5o7JRMncNxpwSC6Bp8sMba+sYElSehXh2gxeqoL5I2+?=
 =?us-ascii?Q?WzenY82fOFl709jy4LdhoKKUBzoBnleR6+cqYqsxlecZZrn1NF3LJbZechjO?=
 =?us-ascii?Q?u4F/j3505ZJ/Jq6xnAcvyygTdk7gtC3fmlkA7Gkq7CfWNw07aY7o1QXM6H1O?=
 =?us-ascii?Q?0wpK/ozN3wU3M9Cq3/dQAK41y7wowhM3hzJJEZ5zHz/UIYyPmUVuf/Eu7/5N?=
 =?us-ascii?Q?+w+mpSNIaQXnqrPiJboJXqU1ayknO0DnoMhwZa6HKOxrHAZuh57se9CqrYjp?=
 =?us-ascii?Q?+7tU5qMwZQPvL1QeIOHzIGtUSN5wn/903iHEimXGdU5MF0c9fz9Miv2tqMEc?=
 =?us-ascii?Q?tJTAe0qy3Lubye8tUzVcCOg3jsbnnZbsAb6YBBV5lXwT/jMCMLDWr+oSWBBh?=
 =?us-ascii?Q?NcoimTkDzX30VZrwMXYIwPz65LtptX2g66XtATOzu5XosXCwe9QG7igi9wvE?=
 =?us-ascii?Q?cn5zfIWxqzbN6H6hWhsAP0b7PLHwd5YxVEHvj5gUOQsV7AdHybQbXVPmaWOc?=
 =?us-ascii?Q?X46KyrzTWX67fC7g7xP0rds/SHGmBX0o4YtjLuS+fciP9/CE7UUHnJJjKhc6?=
 =?us-ascii?Q?Dy5/pyuiUm9Ej2LfHLVfBhAQfKWIXeOaFNLtAB+q45doY4yJ+8lzdzOMNimN?=
 =?us-ascii?Q?cRK9Xkz5zjxbf50ttWEfdbH+mCvmzZ1Jm0JlX/y/d0wqbtjzywiSyPRmIwz4?=
 =?us-ascii?Q?icCXANv2L7kvCt3ZY0LX9jufrDsr7yn7lMEbR6AksvhsNFwLAEX5GZewVHOX?=
 =?us-ascii?Q?unCVNi4eDoXJlnALNCgQqpoqA+Mvh7cl9iNz4JmbyjGfbVlUbcTNE+5CyvVw?=
 =?us-ascii?Q?kJPQJKaRe379JjiinhaFHslbVVgHaLrZiildKE1JTR1OHc9dJ2/zUdyCfF7J?=
 =?us-ascii?Q?0Wa9O9cMPKzFiE5w26l1Dd28aZkRYRRSqVuVddhKhw1XU1QJivreVIU27Z8a?=
 =?us-ascii?Q?YzSiU0tPsI7GlYSObRqpCOFVEdyZCXWjg1KmzNkRv5T4rWEVcrQZNf//D8Ww?=
 =?us-ascii?Q?79lj1MTwpvRaQojp+Ht6RkBReddw20r6pxZiKEUA1Pvsz4Jwt1M2+PrXVTAD?=
 =?us-ascii?Q?xH7tF1Wr2EgS+QTbrMPhtj3f/z4n1GPOr4yARFyFDPG5WLByGvh48jx0UAem?=
 =?us-ascii?Q?TlbiLqTPpodWZBUS1uIDW7DoJMbpcBSKhr11pO3rryjPGj7ZW0JQynt9CW4V?=
 =?us-ascii?Q?cyFFAxihsJVH9GBs+D0KRIZP03qH7PibgkjwH8J1OUeygtDufEHsVVEVHwzt?=
 =?us-ascii?Q?p3EpWFLD/SAV17VApsYyzVZ1fQm1C0hlWQq09PVU4FbwE3iLNLqcbC6fM6Bh?=
 =?us-ascii?Q?GK+ji69bpHcuNGbuQvrAeLoLXGEUc0tpjylF4B0AKjNfrEPTpkbPcvnCLuDg?=
 =?us-ascii?Q?ffzXOpHn+Ehj5JKdl1vyqDV0/1es50BVJvPn9Qo3tV2N/TXSpYsS6ZGxGPOv?=
 =?us-ascii?Q?MA=3D=3D?=
X-OriginatorOrg: in-advantage.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 46ff3f0f-2b85-44a2-8cc1-08daca83ccf6
X-MS-Exchange-CrossTenant-AuthSource: MWHPR1001MB2351.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 19 Nov 2022 23:14:25.5832
 (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: nGOfZ7RphEJ/Nf11de9NuL0STvy54DJeHWTCIUMFAPxtIcDxWFL/mXgleDytiwjEeNJ1e4ffmsPIMlgvnK73ZS6PWP6fxy3Hkr3uFZHEM2Y=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CH2PR10MB4293
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
        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

Ocelot uses regmap_bulk_read() operations to efficiently read stats
registers. Currently the implementation relies on the stats layout to be
ordered to be most efficient.

Issue a warning if any future implementations happen to break this pattern.

Signed-off-by: Colin Foster <colin.foster@in-advantage.com>
Co-developed-by: Vladimir Oltean <vladimir.oltean@nxp.com>
---

v1->v2
    * New patch, picked up from previous mailings

---
 drivers/net/ethernet/mscc/ocelot_stats.c | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/drivers/net/ethernet/mscc/ocelot_stats.c b/drivers/net/ethernet/mscc/ocelot_stats.c
index 68e9f450c468..1478c3b21af1 100644
--- a/drivers/net/ethernet/mscc/ocelot_stats.c
+++ b/drivers/net/ethernet/mscc/ocelot_stats.c
@@ -602,7 +602,7 @@ EXPORT_SYMBOL(ocelot_port_get_stats64);
 static int ocelot_prepare_stats_regions(struct ocelot *ocelot)
 {
 	struct ocelot_stats_region *region = NULL;
-	unsigned int last;
+	unsigned int last = 0;
 	int i;
 
 	INIT_LIST_HEAD(&ocelot->stats_regions);
@@ -619,6 +619,12 @@ static int ocelot_prepare_stats_regions(struct ocelot *ocelot)
 			if (!region)
 				return -ENOMEM;
 
+			/* enum ocelot_stat must be kept sorted in the same
+			 * order as ocelot_stats_layout[i].reg in order to have
+			 * efficient bulking
+			 */
+			WARN_ON(last >= ocelot_stats_layout[i].reg);
+
 			region->base = ocelot_stats_layout[i].reg;
 			region->count = 1;
 			list_add_tail(&region->node, &ocelot->stats_regions);
-- 
2.25.1