Received-SPF: pass (google.com: domain of linux-kernel+bounces-78610-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.48.161 as permitted sender) client-ip=147.75.48.161;
From: John Garry <john.g.garry@oracle.com>
To: mcgrof@kernel.org, russ.weight@linux.dev, gregkh@linuxfoundation.org,
        rafael@kernel.org
Cc: linux-kernel@vger.kernel.org, masahiroy@kernel.org,
        John Garry <john.g.garry@oracle.com>
Subject: [PATCH v2] firmware_loader: Use init_utsname()->release
Date: Fri, 23 Feb 2024 15:31:21 +0000
Message-Id: <20240223153121.440763-1-john.g.garry@oracle.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: 
	=?us-ascii?Q?5oJWkp8sNleebBTEJ76yZfO1ecPb4FAB6LKRCfFQMkeabdJlA6zjnfX3llrv?=
 =?us-ascii?Q?/ixb+EtsFKFD6N3ktmuavdWB1UjskTmVG9VqctQzHCRpBahY2Lu5ihdbJXeh?=
 =?us-ascii?Q?oQfXnbAynZZTL8WDDgKZBCXoXEY/GqfGu+DGtxX6MmINnRXpfKIham9gNNAL?=
 =?us-ascii?Q?m0iqrzso9Jksm7aQCFWYNA/vg7EXaTkQQosBA8AeW0gv9QPjQGlZlsmOh+QI?=
 =?us-ascii?Q?e6DEV3l/8uveh2Ja15xcgrbHyhOb0xLSLIbm6bnNlAKDXxXGrFvCkKu/zBXc?=
 =?us-ascii?Q?1f7YCPQGILIm0rXSi4NX8Jundku0HH8OKfu8kKmtBLOAZ1wLz9wK/5+AFlTG?=
 =?us-ascii?Q?Q7J+DQOJlxa6TYwEKYJIpKlRKMljQXZwKGERp38vOC3ee+c9umudJLCdgtgX?=
 =?us-ascii?Q?SfM4qSM0JQkFH/tMj+57XeNAUfkW/ogv3klLYrmtIzK5+Es9UsHSouO3AyCW?=
 =?us-ascii?Q?luYp78okqpQhL1bwmNhYL9p4VfRCB306o1Z2sLoYArIUl9WI95P0YJobrcYM?=
 =?us-ascii?Q?+xD1Ic63fUyPpWBuPh4T9euLk+FAY/aNypxOsAcHY5F5klyxVtZonhmkfyxu?=
 =?us-ascii?Q?T4hT/LVbv4+Hot/pS5DGbjtYNby3/zuLQIC+H6DYhY4ALEScgNyQLLf3HyZB?=
 =?us-ascii?Q?4cxFt4zQpiCw2ZhNZejt1aHpfE/jedVLU2cQWur43tzVHAywdS4FjRp6qY7L?=
 =?us-ascii?Q?ykbuzMklX7THi2xD6goxNEG2g4QVBj7cMuPsYrH0oad2vzZzlKwi3paeJ3jP?=
 =?us-ascii?Q?z2mCDwnSYXK8vGfXUYI3mSR3i4hZCT2WoYYjI8aViK1qTAPFR0BLd07K48mI?=
 =?us-ascii?Q?HwK9Uw5QqsNrv4/C6l8LQFB2GakFN0eeVljsQEZp85bKmB/ggEu1+TG6MfLx?=
 =?us-ascii?Q?QrF0VOfrfgGQ2HJ22fwsLHw+P8KhTZdLaKrzEVlHWjiz2FDKTWTe2WOL0gjT?=
 =?us-ascii?Q?tbgdSlseCBSSBpJS8tNnvx+kDVyc66vz9dPQ4XlzGKoloBRNxqq22fyMAPkr?=
 =?us-ascii?Q?LQfIzJ3hEx6CphaHV7PiPvWCYGEnANEU1YyPM+E5NQg2xGKBod8Qsovgos9M?=
 =?us-ascii?Q?KVCoycJDGPP2KBfQ6HOl+5gAbNgjSog2j0G4dDbgb1+uKn3n9Ai/RdjrYu0a?=
 =?us-ascii?Q?Za2Q06ScY6Ft/pGj7VZqGYBlUpgivfwH+4L0ARk7w6bhBWoAxK9YEm+ZxW5L?=
 =?us-ascii?Q?OQMVni4kQk02nTOep+eNK39FeVivKTmI+hFIgees5N7GYhXdYikruqOGyz/2?=
 =?us-ascii?Q?dXa9W4MYQchdRBhdUzM9DCGHFwDNpusLE3Cfaz/YrM+L4grcibF0ppsflhq/?=
 =?us-ascii?Q?lT7mlcKBL+1lE4uUcEBF2gvOgv94xwDKqlO3sRURzxf7/y5OLQ5KZroXvXZA?=
 =?us-ascii?Q?6UgmfASKej5azo6JGDJCZlTqmvqt4QX2U1qkQntQKyKsWkl4gq6aszZ/CHmI?=
 =?us-ascii?Q?QY9uCdRfbesvI5J29JOicuYKCQ2ubllBBGBTwiVN2spFd87aoVD9kg9y+QGI?=
 =?us-ascii?Q?WgiZwXSgXmQjTeFq5xel1W//DgdXhnTv1die+iC4Vy52wiD8Oj/lfB5pD7b0?=
 =?us-ascii?Q?5yOcDyIsJ+NswK8lxRfdb4nphnOlYVFF0mZ99v7Q?=
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-0: 
	VLUElvD+jFYrQVjPZh6sDat3hGtwyT/FTRc+BUZ/0+bnN1PNox/jend/B2IgYn7rzsKP0d+88QOsaJx+LPE7SFyZ8a9tOvigXilrxNZs3/NIKRFdouck9+o0RpAwb2ozAy+wawkMBeFOt9sknI7vvHAkRxjChszzaZmDcbv8NmuV/h4c9SlI/NVGTjQ5NSc9JR3g4f4DVT9p2IKXvSghdsDu1Grw107Tada0SV9GLUY7HeTZMN+5Zu7oaJopqc15NZ3MjauIMYt9AP0tloalbDDnDBvS7V0+mwYmL78/V486hGHiY7zAg2b9RqWYflD4IisW1ThQzrH3YI9bXJ0sY8LEhuUO3HwbOl0k+R8BnPjaLfjBdS7mfie7tDSMlOeYXj7RGSd06mGo/zdS1xx4BqmoUmdwklSxOGwbp0n9A/I4LYX1pV4jw5wHE0IycN0Xrlf192OF0AXk6/hp+vB7DQ951qLRNKxMB94xqIIvJI2yWu6CcFUAY74iWQgPEKjtIZgsxIYSmLWUsek23M0K7wQnXWTemcXBby14f1191LBKq2osLFA9ZJW+9zcp5UFDswRKkwJbuiPEJWXEGWvQHa0YPVTgx0xPugq2pFz7voo=
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 5f063cf3-7dc9-4164-148c-08dc34848298
X-MS-Exchange-CrossTenant-AuthSource: CH2PR10MB4312.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 23 Feb 2024 15:31:31.2147
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: il6q+8jb6s+2JMUEAjGpxGwsLJhSv2ZIAV9y+seabbWz2SrvPH1FpEVsJolDxBXvnxaFlx6EBC17oGkrHOn1bg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BLAPR10MB4962
X-Proofpoint-Virus-Version: vendor=baseguard
 engine=ICAP:2.0.272,Aquarius:18.0.1011,Hydra:6.0.619,FMLib:17.11.176.26
 definitions=2024-02-23_01,2024-02-23_01,2023-05-22_02
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 malwarescore=0 suspectscore=0
 mlxscore=0 spamscore=0 mlxlogscore=999 phishscore=0 bulkscore=0
 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1
 engine=8.12.0-2311290000 definitions=main-2402230112
X-Proofpoint-ORIG-GUID: L4i77lE8ZashF5FKxS5O8c7_CYtITCgT
X-Proofpoint-GUID: L4i77lE8ZashF5FKxS5O8c7_CYtITCgT

Instead of using UTS_RELEASE, use init_utsname()->release, which means
that we don't need to rebuild the code just for the git head commit
changing.

Since UTS_RELEASE is used for fw_path[] and this points to const data,
append init_utsname()->release dynamically to an intermediate string.

The check for appending uts release is if the string in fw_path[] ends
in '/'. Since fw_path[] may include a path from the kernel command line
in fw_path_para, and it would be valid for this string to end in '/',
check for fw_path_para when appending uts release. 

Note: As mentioned by Masahiro in [0], when CONFIG_MODVERSIONS=y it
could be possible for a driver to be built as a module with a different
kernel baseline and so use a different UTS_RELEASE from that baseline. So
now using init_utsname()->release could lead to a change in behaviour
in this driver. However, considering the nature of this driver and how it
would not make sense to build it as an external module against a different
tree, this change should not have any effect on users.

[0] https://lore.kernel.org/lkml/CAK7LNAQ_r5yUjNpOppLkDBQ12sDxBYQTvRZGn1ng8D1POfZr_A@mail.gmail.com/

Reviewed-by: Luis Chamberlain <mcgrof@kernel.org>
Signed-off-by: John Garry <john.g.garry@oracle.com>
---
Changes in v2:
- moved note into commit log and tweaked slightly
- add Luis' RB tags, thanks

Also verified against fw loader selftest - it seems to show no regression
from baseline, however the baeline sometimes hangs (and also does with
this patch).

diff --git a/drivers/base/firmware_loader/main.c b/drivers/base/firmware_loader/main.c
index 3c67f24785fc..9a3671659134 100644
--- a/drivers/base/firmware_loader/main.c
+++ b/drivers/base/firmware_loader/main.c
@@ -38,7 +38,7 @@
 #include <linux/zstd.h>
 #include <linux/xz.h>
 
-#include <generated/utsrelease.h>
+#include <linux/utsname.h>
 
 #include "../base.h"
 #include "firmware.h"
@@ -471,9 +471,9 @@ static int fw_decompress_xz(struct device *dev, struct fw_priv *fw_priv,
 static char fw_path_para[256];
 static const char * const fw_path[] = {
 	fw_path_para,
-	"/lib/firmware/updates/" UTS_RELEASE,
+	"/lib/firmware/updates/", /* UTS_RELEASE is appended later */
 	"/lib/firmware/updates",
-	"/lib/firmware/" UTS_RELEASE,
+	"/lib/firmware/", /* UTS_RELEASE is appended later */
 	"/lib/firmware"
 };
 
@@ -496,7 +496,7 @@ fw_get_filesystem_firmware(struct device *device, struct fw_priv *fw_priv,
 	size_t size;
 	int i, len, maxlen = 0;
 	int rc = -ENOENT;
-	char *path, *nt = NULL;
+	char *path, *fw_path_string, *nt = NULL;
 	size_t msize = INT_MAX;
 	void *buffer = NULL;
 	dev_err(device, "%s suffix=%s\n", __func__, suffix);
@@ -511,6 +511,12 @@ fw_get_filesystem_firmware(struct device *device, struct fw_priv *fw_priv,
 	if (!path)
 		return -ENOMEM;
 
+	fw_path_string = __getname();
+	if (!fw_path_string) {
+		__putname(path);
+		return -ENOMEM;
+	}
+
 	wait_for_initramfs();
 	for (i = 0; i < ARRAY_SIZE(fw_path); i++) {
 		size_t file_size = 0;
@@ -521,16 +527,32 @@ fw_get_filesystem_firmware(struct device *device, struct fw_priv *fw_priv,
 		if (!fw_path[i][0])
 			continue;
 
+		len = snprintf(fw_path_string, PATH_MAX, "%s", fw_path[i]);
+		if (len >= PATH_MAX) {
+			rc = -ENAMETOOLONG;
+			break;
+		}
+
+		/* Special handling to append UTS_RELEASE */
+		if ((fw_path[i] != fw_path_para) && (fw_path[i][len - 1] == '/')) {
+			len = snprintf(fw_path_string, PATH_MAX, "%s%s",
+					fw_path[i], init_utsname()->release);
+			if (len >= PATH_MAX) {
+				rc = -ENAMETOOLONG;
+				break;
+			}
+		}
+
 		/* strip off \n from customized path */
-		maxlen = strlen(fw_path[i]);
+		maxlen = strlen(fw_path_string);
 		if (i == 0) {
-			nt = strchr(fw_path[i], '\n');
+			nt = strchr(fw_path_string, '\n');
 			if (nt)
-				maxlen = nt - fw_path[i];
+				maxlen = nt - fw_path_string;
 		}
 
 		len = snprintf(path, PATH_MAX, "%.*s/%s%s",
-			       maxlen, fw_path[i],
+			       maxlen, fw_path_string,
 			       fw_priv->fw_name, suffix);
 		if (len >= PATH_MAX) {
 			rc = -ENAMETOOLONG;
@@ -588,6 +610,7 @@ fw_get_filesystem_firmware(struct device *device, struct fw_priv *fw_priv,
 		break;
 	}
 	__putname(path);
+	__putname(fw_path_string);
 
 	return rc;
 }
-- 
2.31.1