Skip to contentSkip to conversation

platform/x86: think-lmi: Abort probe on analyze failure

PATCH In review Alex Williamson 4 participants 4 messages Nov 8, 2021 – Nov 9, 2021 x86 platform drivers

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 platform/x86: think-lmi: Abort probe on analyze failure

A Lenovo ThinkStation S20 (4157CTO BIOS 60KT41AUS) fails to boot on recent kernels including the think-lmi driver, due to the fact that errors returned by the tlmi_analyze() function are ignored by tlmi_probe(), where tlmi_sysfs_init() is called unconditionally. This results in making use of an array of already freed, non-null pointers and other uninitialized globals, causing all sorts of nasty kobject and memory faults.

Make use of the analyze function return value, free a couple leaked allocations, and remove the settings_count field, which is incremented but never consumed.

Fixes a40cd7ef22fb ("platform/x86: think-lmi: Add WMI interface support on Lenovo platforms")
---
 drivers/platform/x86/think-lmi.c |   13 ++++++++++---
 drivers/platform/x86/think-lmi.h |    1 -
 2 files changed, 10 insertions(+), 4 deletions(-)
drivers/platform/x86/think-lmi.c +10 -3
index 9472aae72df2..c4d9c45350f7 100644
@@ -888,8 +888,10 @@ static int tlmi_analyze(void)
 			break;
 		if (!item)
 			break;
-		if (!*item)
+		if (!*item) {
+			kfree(item);
 			continue;
+		}
 
 		/* It is not allowed to have '/' for file name. Convert it into '\'. */
 		strreplace(item, '/', '\\');
@@ -902,6 +904,7 @@ static int tlmi_analyze(void)
 		setting = kzalloc(sizeof(*setting), GFP_KERNEL);
 		if (!setting) {
 			ret = -ENOMEM;
+			kfree(item);
 			goto fail_clear_attr;
 		}
 		setting->index = i;
@@ -916,7 +919,6 @@ static int tlmi_analyze(void)
 		}
 		kobject_init(&setting->kobj, &tlmi_attr_setting_ktype);
 		tlmi_priv.setting[i] = setting;
-		tlmi_priv.settings_count++;
 		kfree(item);
 	}
 
@@ -983,7 +985,12 @@ static void tlmi_remove(struct wmi_device *wdev)
 
 static int tlmi_probe(struct wmi_device *wdev, const void *context)
 {
-	tlmi_analyze();
+	int ret;
+
+	ret = tlmi_analyze();
+	if (ret)
+		return ret;
+
 	return tlmi_sysfs_init();
 }
 
drivers/platform/x86/think-lmi.h +0 -1
index f8e26823075f..2ce5086a5af2 100644
@@ -55,7 +55,6 @@ struct tlmi_attr_setting {
 struct think_lmi {
 	struct wmi_device *wmi_device;
 
-	int settings_count;
 	bool can_set_bios_settings;
 	bool can_get_bios_selections;
 	bool can_set_bios_password;
Reviewed-by on v1 1/1
#1 lore raw

Thanks Alex

Quoted 24 lines · Alex Williamson

A Lenovo ThinkStation S20 (4157CTO BIOS 60KT41AUS) fails to boot on recent kernels including the think-lmi driver, due to the fact that errors returned by the tlmi_analyze() function are ignored by tlmi_probe(), where tlmi_sysfs_init() is called unconditionally. This results in making use of an array of already freed, non-null pointers and other uninitialized globals, causing all sorts of nasty kobject and memory faults.

Make use of the analyze function return value, free a couple leaked allocations, and remove the settings_count field, which is incremented but never consumed.

Fixes a40cd7ef22fb ("platform/x86: think-lmi: Add WMI interface support on Lenovo platforms")
---
  drivers/platform/x86/think-lmi.c |   13 ++++++++++---
  drivers/platform/x86/think-lmi.h |    1 -
  2 files changed, 10 insertions(+), 4 deletions(-)
drivers/platform/x86/think-lmi.c +0 -0
index 9472aae72df2..c4d9c45350f7 100644

drivers/platform/x86/think-lmi.c static int tlmi_analyze(void) · line 894

Quoted 8 lines
drivers/platform/x86/think-lmi.c +3 -1
@@ -888,8 +888,10 @@ static int tlmi_analyze(void)
  			break;
  		if (!item)
  			break;
-		if (!*item)
+		if (!*item) {
+			kfree(item);
  			continue;
+		}

I feel bad that I missed this in my original commit.
I've (obviously) not seen it on any platforms I've tested. I'll see if we can get the FW team to address the origins of this too - I'm guessing the root cause is in the FW

Quoted 22 lines
drivers/platform/x86/think-lmi.c +1 -1
  		/* It is not allowed to have '/' for file name. Convert it into '\'. */
  		strreplace(item, '/', '\\');
@@ -902,6 +904,7 @@ static int tlmi_analyze(void)
  		setting = kzalloc(sizeof(*setting), GFP_KERNEL);
  		if (!setting) {
  			ret = -ENOMEM;
+			kfree(item);
  			goto fail_clear_attr;
  		}
  		setting->index = i;
@@ -916,7 +919,6 @@ static int tlmi_analyze(void)
  		}
  		kobject_init(&setting->kobj, &tlmi_attr_setting_ktype);
  		tlmi_priv.setting[i] = setting;
-		tlmi_priv.settings_count++;
  		kfree(item);
  	}
 
@@ -983,7 +985,12 @@ static void tlmi_remove(struct wmi_device *wdev)
 
  static int tlmi_probe(struct wmi_device *wdev, const void *context)

drivers/platform/x86/think-lmi.c static void tlmi_remove(struct wmi_device *wdev) · line 995

Quoted 10 lines
drivers/platform/x86/think-lmi.c +6 -1
  {
-	tlmi_analyze();
+	int ret;
+
+	ret = tlmi_analyze();
+	if (ret)
+		return ret;
+
  	return tlmi_sysfs_init();
  }

Looks good

Quoted 7 lines
drivers/platform/x86/think-lmi.h +0 -0
index f8e26823075f..2ce5086a5af2 100644

drivers/platform/x86/think-lmi.h struct tlmi_attr_setting { · line 60

Quoted 7 lines
drivers/platform/x86/think-lmi.h +0 -1
@@ -55,7 +55,6 @@ struct tlmi_attr_setting {
  struct think_lmi {
  	struct wmi_device *wmi_device;
 
-	int settings_count;
  	bool can_set_bios_settings;
  	bool can_get_bios_selections;
  	bool can_set_bios_password;

Originally the settings_count was used in the ioctl based driver we have, but I have no issue with it being removed as it serves no use. Thanks for the clean up.

Mark

Reviewed-by on v1 1/1
#2 lore raw
In reply to Alex Williamson
Quoted 11 lines · Alex Williamson

A Lenovo ThinkStation S20 (4157CTO BIOS 60KT41AUS) fails to boot on recent kernels including the think-lmi driver, due to the fact that errors returned by the tlmi_analyze() function are ignored by tlmi_probe(), where tlmi_sysfs_init() is called unconditionally. This results in making use of an array of already freed, non-null pointers and other uninitialized globals, causing all sorts of nasty kobject and memory faults.

Make use of the analyze function return value, free a couple leaked allocations, and remove the settings_count field, which is incremented but never consumed.

part of me would like to see this split into 2 patches, one to fix the memory leaks, and one to fix the boot issue. But, its so small its hard to argue for splitting up.

Looks good enough to me:

Quoted 68 lines
Fixes a40cd7ef22fb ("platform/x86: think-lmi: Add WMI interface support on Lenovo platforms")
---
 drivers/platform/x86/think-lmi.c |   13 ++++++++++---
 drivers/platform/x86/think-lmi.h |    1 -
 2 files changed, 10 insertions(+), 4 deletions(-)
drivers/platform/x86/think-lmi.c +10 -3
index 9472aae72df2..c4d9c45350f7 100644
@@ -888,8 +888,10 @@ static int tlmi_analyze(void)
 			break;
 		if (!item)
 			break;
-		if (!*item)
+		if (!*item) {
+			kfree(item);
 			continue;
+		}
 
 		/* It is not allowed to have '/' for file name. Convert it into '\'. */
 		strreplace(item, '/', '\\');
@@ -902,6 +904,7 @@ static int tlmi_analyze(void)
 		setting = kzalloc(sizeof(*setting), GFP_KERNEL);
 		if (!setting) {
 			ret = -ENOMEM;
+			kfree(item);
 			goto fail_clear_attr;
 		}
 		setting->index = i;
@@ -916,7 +919,6 @@ static int tlmi_analyze(void)
 		}
 		kobject_init(&setting->kobj, &tlmi_attr_setting_ktype);
 		tlmi_priv.setting[i] = setting;
-		tlmi_priv.settings_count++;
 		kfree(item);
 	}
 
@@ -983,7 +985,12 @@ static void tlmi_remove(struct wmi_device *wdev)
 
 static int tlmi_probe(struct wmi_device *wdev, const void *context)
 {
-	tlmi_analyze();
+	int ret;
+
+	ret = tlmi_analyze();
+	if (ret)
+		return ret;
+
 	return tlmi_sysfs_init();
 }
 
drivers/platform/x86/think-lmi.h +0 -1
index f8e26823075f..2ce5086a5af2 100644
@@ -55,7 +55,6 @@ struct tlmi_attr_setting {
 struct think_lmi {
 	struct wmi_device *wmi_device;
 
-	int settings_count;
 	bool can_set_bios_settings;
 	bool can_get_bios_selections;
 	bool can_set_bios_password;
Reviewed-by on v1 1/1
#3 lore raw
In reply to Alex Williamson

Hi,

Quoted 8 lines · Alex Williamson

A Lenovo ThinkStation S20 (4157CTO BIOS 60KT41AUS) fails to boot on recent kernels including the think-lmi driver, due to the fact that errors returned by the tlmi_analyze() function are ignored by tlmi_probe(), where tlmi_sysfs_init() is called unconditionally. This results in making use of an array of already freed, non-null pointers and other uninitialized globals, causing all sorts of nasty kobject and memory faults.

Quoted 6 lines

Make use of the analyze function return value, free a couple leaked allocations, and remove the settings_count field, which is incremented but never consumed.

Fixes a40cd7ef22fb ("platform/x86: think-lmi: Add WMI interface support on Lenovo platforms")

Thanks, patch looks good to me:

I'll send this to Linus in my first fixes pull-req for 5.16 (once 516-rc1 is out)

Regards,

Hans

Quoted 65 lines
---
 drivers/platform/x86/think-lmi.c |   13 ++++++++++---
 drivers/platform/x86/think-lmi.h |    1 -
 2 files changed, 10 insertions(+), 4 deletions(-)
drivers/platform/x86/think-lmi.c +10 -3
index 9472aae72df2..c4d9c45350f7 100644
@@ -888,8 +888,10 @@ static int tlmi_analyze(void)
 			break;
 		if (!item)
 			break;
-		if (!*item)
+		if (!*item) {
+			kfree(item);
 			continue;
+		}
 
 		/* It is not allowed to have '/' for file name. Convert it into '\'. */
 		strreplace(item, '/', '\\');
@@ -902,6 +904,7 @@ static int tlmi_analyze(void)
 		setting = kzalloc(sizeof(*setting), GFP_KERNEL);
 		if (!setting) {
 			ret = -ENOMEM;
+			kfree(item);
 			goto fail_clear_attr;
 		}
 		setting->index = i;
@@ -916,7 +919,6 @@ static int tlmi_analyze(void)
 		}
 		kobject_init(&setting->kobj, &tlmi_attr_setting_ktype);
 		tlmi_priv.setting[i] = setting;
-		tlmi_priv.settings_count++;
 		kfree(item);
 	}
 
@@ -983,7 +985,12 @@ static void tlmi_remove(struct wmi_device *wdev)
 
 static int tlmi_probe(struct wmi_device *wdev, const void *context)
 {
-	tlmi_analyze();
+	int ret;
+
+	ret = tlmi_analyze();
+	if (ret)
+		return ret;
+
 	return tlmi_sysfs_init();
 }
 
drivers/platform/x86/think-lmi.h +0 -1
index f8e26823075f..2ce5086a5af2 100644
@@ -55,7 +55,6 @@ struct tlmi_attr_setting {
 struct think_lmi {
 	struct wmi_device *wmi_device;
 
-	int settings_count;
 	bool can_set_bios_settings;
 	bool can_get_bios_selections;
 	bool can_set_bios_password;