Skip to contentSkip to conversation

cpufreq: intel_pstate: Reporting reasons why driver prematurely exit

PATCH Superseded Erwan Velu 3 participants 5 messages Feb 12, 2019 – Feb 13, 2019

Subsystems (2)

v4 of 6 Superseded Latest is v6 →

lore
Share & tools
lore

Erwan Velu

author
#0 lore raw

PATCH v4 1/1 cpufreq: intel_pstate: Reporting reasons why driver prematurely exit

The init code path has several exceptions where the module can decide not to load. As CONFIG_X86_INTEL_PSTATE is generally set to Y, the return code is not reachable. The initialization code is neither verbose of the reason why it did choose to prematurely exit.

This situation leads to a situation where its difficult for a user to determine, on a given platform, why the driver didn't load properly.

This patch is about reporting to the user the reason/context of why the driver failed to load. That is a precious hint when debugging a platform.

---
 drivers/cpufreq/intel_pstate.c | 27 +++++++++++++++++++++------
 1 file changed, 21 insertions(+), 6 deletions(-)
drivers/cpufreq/intel_pstate.c +21 -6
index dd66decf2087..eb62e5555dcc 100644
@@ -2475,6 +2475,7 @@ static bool __init intel_pstate_no_acpi_pss(void)
 		kfree(pss);
 	}
 
+	pr_debug("Cannot detect ACPI PSS");
 	return true;
 }
 
@@ -2484,10 +2485,15 @@ static bool __init intel_pstate_no_acpi_pcch(void)
 	acpi_handle handle;
 
 	status = acpi_get_handle(NULL, "\\_SB", &handle);
-	if (ACPI_FAILURE(status))
+	if (ACPI_FAILURE(status)) {
+		pr_debug("Cannot detect ACPI SB");
 		return true;
+	}
 
-	return !acpi_has_method(handle, "PCCH");
+	status = acpi_has_method(handle, "PCCH");
+	if (!status)
+		pr_debug("Cannot detect ACPI PCCH");
+	return !status;
 }
 
 static bool __init intel_pstate_has_acpi_ppc(void)
@@ -2502,6 +2508,7 @@ static bool __init intel_pstate_has_acpi_ppc(void)
 		if (acpi_has_method(pr->handle, "_PPC"))
 			return true;
 	}
+	pr_debug("Cannot detect ACPI PPC");
 	return false;
 }
 
@@ -2539,8 +2546,10 @@ static bool __init intel_pstate_platform_pwr_mgmt_exists(void)
 	id = x86_match_cpu(intel_pstate_cpu_oob_ids);
 	if (id) {
 		rdmsrl(MSR_MISC_PWR_MGMT, misc_pwr);
-		if ( misc_pwr & (1 << 8))
+		if (misc_pwr & (1 << 8)) {
+			pr_debug("MSR_MISC_PWR_MGMT reports enabled HW coordination");
 			return true;
+		}
 	}
 
 	idx = acpi_match_platform_list(plat_info);
@@ -2606,22 +2615,28 @@ static int __init intel_pstate_init(void)
 		}
 	} else {
 		id = x86_match_cpu(intel_pstate_cpu_ids);
-		if (!id)
+		if (!id) {
+			pr_warn("CPU ID is not in the list of supported devices\n");
 			return -ENODEV;
+		}
 
 		copy_cpu_funcs((struct pstate_funcs *)id->driver_data);
 	}
 
-	if (intel_pstate_msrs_not_valid())
+	if (intel_pstate_msrs_not_valid()) {
+		pr_warn("Cannot enable driver as per invalid MSRs\n");
 		return -ENODEV;
+	}
 
 hwp_cpu_matched:
 	/*
 	 * The Intel pstate driver will be ignored if the platform
 	 * firmware has its own power management modes.
 	 */
-	if (intel_pstate_platform_pwr_mgmt_exists())
+	if (intel_pstate_platform_pwr_mgmt_exists()) {
+		pr_warn("Platform already taking care of power management\n");
 		return -ENODEV;
+	}
 
 	if (!hwp_active && hwp_only)
 		return -ENOTSUPP;
Signature · 1 line
2.20.1
#1 lore raw
Quoted 5 lines · Erwan Velu

The init code path has several exceptions where the module can decide not to load. As CONFIG_X86_INTEL_PSTATE is generally set to Y, the return code is not reachable. The initialization code is neither verbose of the reason why it did choose to prematurely exit.

Quoted 7 lines

This situation leads to a situation where its difficult for a user to determine, on a given platform, why the driver didn't load properly.

This patch is about reporting to the user the reason/context of why the driver failed to load. That is a precious hint when debugging a platform.

Newline characters are missing in all of your messages.

drivers/cpufreq/intel_pstate.c static bool __init intel_pstate_no_acpi_pss(void) · line 2478

Quoted 13 lines
---
 drivers/cpufreq/intel_pstate.c | 27 +++++++++++++++++++++------
 1 file changed, 21 insertions(+), 6 deletions(-)
drivers/cpufreq/intel_pstate.c +1 -0
index dd66decf2087..eb62e5555dcc 100644
@@ -2475,6 +2475,7 @@ static bool __init intel_pstate_no_acpi_pss(void)
                kfree(pss);
        }
 
+       pr_debug("Cannot detect ACPI PSS");

"ACPI _PSS not found\n"

drivers/cpufreq/intel_pstate.c static bool __init intel_pstate_no_acpi_pcch(void) · line 2489

Quoted 10 lines
drivers/cpufreq/intel_pstate.c +2 -1
        return true;
 }
 
@@ -2484,10 +2485,15 @@ static bool __init intel_pstate_no_acpi_pcch(void)
        acpi_handle handle;
 
        status = acpi_get_handle(NULL, "\\_SB", &handle);
-       if (ACPI_FAILURE(status))
+       if (ACPI_FAILURE(status)) {
+               pr_debug("Cannot detect ACPI SB");

This is very unlikely to happen, I wouldn't bother to print anything here.

drivers/cpufreq/intel_pstate.c static bool __init intel_pstate_no_acpi_pcch(void) · line 2495

Quoted 7 lines
drivers/cpufreq/intel_pstate.c +4 -1
                return true;
+       }
 
-       return !acpi_has_method(handle, "PCCH");
+       status = acpi_has_method(handle, "PCCH");
+       if (!status)
+               pr_debug("Cannot detect ACPI PCCH");

This message can be printed by the caller and, again, I would prefer something like "ACPI PCCH not found".

drivers/cpufreq/intel_pstate.c static bool __init intel_pstate_has_acpi_ppc(void) · line 2511

Quoted 9 lines
drivers/cpufreq/intel_pstate.c +2 -0
+       return !status;
 }
 
 static bool __init intel_pstate_has_acpi_ppc(void)
@@ -2502,6 +2508,7 @@ static bool __init intel_pstate_has_acpi_ppc(void)
                if (acpi_has_method(pr->handle, "_PPC"))
                        return true;
        }
+       pr_debug("Cannot detect ACPI PPC");

"ACPI _PPC not found\n"

drivers/cpufreq/intel_pstate.c static bool __init intel_pstate_platform_pwr_mgmt_exists(void) · line 2550

Quoted 10 lines
drivers/cpufreq/intel_pstate.c +2 -1
        return false;
 }
 
@@ -2539,8 +2546,10 @@ static bool __init intel_pstate_platform_pwr_mgmt_exists(void)
        id = x86_match_cpu(intel_pstate_cpu_oob_ids);
        if (id) {
                rdmsrl(MSR_MISC_PWR_MGMT, misc_pwr);
-               if ( misc_pwr & (1 << 8))
+               if (misc_pwr & (1 << 8)) {
+                       pr_debug("MSR_MISC_PWR_MGMT reports enabled HW coordination");

IIRC this means that the platform is managing P-states on systems without HWP, so I would print something like "P-states managed by the platform\n".

drivers/cpufreq/intel_pstate.c static int __init intel_pstate_init(void) · line 2619

Quoted 12 lines
drivers/cpufreq/intel_pstate.c +3 -1
                        return true;
+               }
        }
 
        idx = acpi_match_platform_list(plat_info);
@@ -2606,22 +2615,28 @@ static int __init intel_pstate_init(void)
                }
        } else {
                id = x86_match_cpu(intel_pstate_cpu_ids);
-               if (!id)
+               if (!id) {
+                       pr_warn("CPU ID is not in the list of supported devices\n");

Why not pr_debug()?

And analogously below?

Quoted 26 lines
drivers/cpufreq/intel_pstate.c +7 -3
                        return -ENODEV;
+               }
 
                copy_cpu_funcs((struct pstate_funcs *)id->driver_data);
        }
 
-       if (intel_pstate_msrs_not_valid())
+       if (intel_pstate_msrs_not_valid()) {
+               pr_warn("Cannot enable driver as per invalid MSRs\n");
                return -ENODEV;
+       }
 
 hwp_cpu_matched:
        /*
         * The Intel pstate driver will be ignored if the platform
         * firmware has its own power management modes.
         */
-       if (intel_pstate_platform_pwr_mgmt_exists())
+       if (intel_pstate_platform_pwr_mgmt_exists()) {
+               pr_warn("Platform already taking care of power management\n");
                return -ENODEV;
+       }
 
        if (!hwp_active && hwp_only)
                return -ENOTSUPP;
--
#2 lore raw

Le 13/02/2019 à 00:01, Rafael J. Wysocki a écrit :
[...]

Quoted 1 line

Newline characters are missing in all of your messages.

oops. Fixing this.

Quoted 1 line

"ACPI _PSS not found\n"

Done.

Quoted 11 lines

drivers/cpufreq/intel_pstate.c static bool __init intel_pstate_no_acpi_pcch(void) · line 2489

Quoted 10 lines
         return true;

}

drivers/cpufreq/intel_pstate.c +2 -1
@@ -2484,10 +2485,15 @@ static bool __init intel_pstate_no_acpi_pcch(void)
         acpi_handle handle;
 
         status = acpi_get_handle(NULL, "\\_SB", &handle);
-       if (ACPI_FAILURE(status))
+       if (ACPI_FAILURE(status)) {
+               pr_debug("Cannot detect ACPI SB");

This is very unlikely to happen, I wouldn't bother to print anything here.

As this is test is made, it means someone considered that case could exist.

That's why a added a message to catch this case while debugging.

I do agree that is not very likely.

Quoted 10 lines

drivers/cpufreq/intel_pstate.c static bool __init intel_pstate_no_acpi_pcch(void) · line 2495

Quoted 8 lines
drivers/cpufreq/intel_pstate.c +4 -1
                 return true;
+       }
 
-       return !acpi_has_method(handle, "PCCH");
+       status = acpi_has_method(handle, "PCCH");
+       if (!status)
+               pr_debug("Cannot detect ACPI PCCH");

This message can be printed by the caller and, again, I would prefer something like "ACPI PCCH not found".

Fixed too.

[..]

Quoted 1 line

"ACPI _PPC not found\n"

fixed.

Quoted 13 lines

drivers/cpufreq/intel_pstate.c static bool __init intel_pstate_platform_pwr_mgmt_exists(void) · line 2550

Quoted 10 lines
drivers/cpufreq/intel_pstate.c +2 -1
         return false;
  }
 
@@ -2539,8 +2546,10 @@ static bool __init intel_pstate_platform_pwr_mgmt_exists(void)
         id = x86_match_cpu(intel_pstate_cpu_oob_ids);
         if (id) {
                 rdmsrl(MSR_MISC_PWR_MGMT, misc_pwr);
-               if ( misc_pwr & (1 << 8))
+               if (misc_pwr & (1 << 8)) {
+                       pr_debug("MSR_MISC_PWR_MGMT reports enabled HW coordination");

IIRC this means that the platform is managing P-states on systems without HWP, so I would print something like "P-states managed by the platform\n".

That's what the caller reports.

I added this additional message because this function added as special case for this MSR setting.

if intel_pstate_platform_pwr_mgmt_exists() is true, that's nice to know why when debugging.

Quoted 14 lines

drivers/cpufreq/intel_pstate.c static int __init intel_pstate_init(void) · line 2619

Quoted 12 lines
drivers/cpufreq/intel_pstate.c +3 -1
                         return true;
+               }
         }
 
         idx = acpi_match_platform_list(plat_info);
@@ -2606,22 +2615,28 @@ static int __init intel_pstate_init(void)
                 }
         } else {
                 id = x86_match_cpu(intel_pstate_cpu_ids);
-               if (!id)
+               if (!id) {
+                       pr_warn("CPU ID is not in the list of supported devices\n");

Why not pr_debug()?

Quoted 1 line

And analogously below?

I'm coming from a use case where on the same hardware, changing the kernel changed the performance profile and impacted user's performance.

I had to debug this case from a running server.

From the dmesg, one of the difference I saw was about the
missing "Intel P-state driver initializing" message, but nothing else.

The reason why the driver didn't engaged itself wasn't explicit.

As CONFIG_X86_INTEL_PSTATE is set to Y by default, I wasn't enable to reload it in any way.

By reading the code, most of the code path and return options doesn't have a single pr_<something> call to explain why.

So I had to rebuild the kernel + my patch to understand which path was taken and then find the root cause of why the pstate behavior changed.

I wanted to contribute back my experience here by providing messages to ease the understanding and potentially debugging of the driver without recompiling it.

So the root of this patch is being able to report the main reasons of why the driver didn't engaged itself with a pr_warn (could be also a pr_info).

All the major and probable "return -ENODEV" calls before pr_info("Intel P-state driver initializing\n") deserves to be explicit and reachable on dmesg for the operators.

I'm operating 30K+ servers and having this kind direct information would save serious time when debugging this situations.

If my experience in that area could help other users, I'd be happy.

I'm positing a v5 with all those changes.

Thanks for the review.

Erwan,

#3 lore raw
Quoted 25 lines · Erwan Velu

Le 13/02/2019 à 00:01, Rafael J. Wysocki a écrit :
[...]

Quoted 1 line

Newline characters are missing in all of your messages.

oops. Fixing this.

Quoted 1 line

"ACPI _PSS not found\n"

Done.

Quoted 11 lines

drivers/cpufreq/intel_pstate.c static bool __init intel_pstate_no_acpi_pcch(void) · line 2489

Quoted 10 lines
         return true;

}

drivers/cpufreq/intel_pstate.c +2 -1
@@ -2484,10 +2485,15 @@ static bool __init intel_pstate_no_acpi_pcch(void)
         acpi_handle handle;
 
         status = acpi_get_handle(NULL, "\\_SB", &handle);
-       if (ACPI_FAILURE(status))
+       if (ACPI_FAILURE(status)) {
+               pr_debug("Cannot detect ACPI SB");

This is very unlikely to happen, I wouldn't bother to print anything here.

Quoted 5 lines

As this is test is made, it means someone considered that case could exist.

That's why a added a message to catch this case while debugging.

I do agree that is not very likely.

So a single "no PCCH" message for this whole function should be sufficient.

Quoted 29 lines
Quoted 10 lines

drivers/cpufreq/intel_pstate.c static bool __init intel_pstate_no_acpi_pcch(void) · line 2495

Quoted 8 lines
drivers/cpufreq/intel_pstate.c +4 -1
                 return true;
+       }
 
-       return !acpi_has_method(handle, "PCCH");
+       status = acpi_has_method(handle, "PCCH");
+       if (!status)
+               pr_debug("Cannot detect ACPI PCCH");

This message can be printed by the caller and, again, I would prefer something like "ACPI PCCH not found".

Fixed too.

[..]

Quoted 1 line

"ACPI _PPC not found\n"

fixed.

Quoted 13 lines

drivers/cpufreq/intel_pstate.c static bool __init intel_pstate_platform_pwr_mgmt_exists(void) · line 2550

Quoted 10 lines
drivers/cpufreq/intel_pstate.c +2 -1
         return false;
  }
 
@@ -2539,8 +2546,10 @@ static bool __init intel_pstate_platform_pwr_mgmt_exists(void)
         id = x86_match_cpu(intel_pstate_cpu_oob_ids);
         if (id) {
                 rdmsrl(MSR_MISC_PWR_MGMT, misc_pwr);
-               if ( misc_pwr & (1 << 8))
+               if (misc_pwr & (1 << 8)) {
+                       pr_debug("MSR_MISC_PWR_MGMT reports enabled HW coordination");

IIRC this means that the platform is managing P-states on systems without HWP, so I would print something like "P-states managed by the platform\n".

Quoted 7 lines

That's what the caller reports.

I added this additional message because this function added as special case for this MSR setting.

if intel_pstate_platform_pwr_mgmt_exists() is true, that's nice to know why when debugging.

I see.

Quoted 19 lines
Quoted 14 lines

drivers/cpufreq/intel_pstate.c static int __init intel_pstate_init(void) · line 2619

Quoted 12 lines
drivers/cpufreq/intel_pstate.c +3 -1
                         return true;
+               }
         }
 
         idx = acpi_match_platform_list(plat_info);
@@ -2606,22 +2615,28 @@ static int __init intel_pstate_init(void)
                 }
         } else {
                 id = x86_match_cpu(intel_pstate_cpu_ids);
-               if (!id)
+               if (!id) {
+                       pr_warn("CPU ID is not in the list of supported devices\n");

Why not pr_debug()?

Quoted 1 line

And analogously below?

I'm coming from a use case where on the same hardware, changing the kernel changed the performance profile and impacted user's performance.

Quoted 6 lines

I had to debug this case from a running server.

From the dmesg, one of the difference I saw was about the
missing "Intel P-state driver initializing" message, but nothing else.

The reason why the driver didn't engaged itself wasn't explicit.

And what did turn out to be the problem?

Anyway, pr_info() should be sufficient IMO.

Quoted 22 lines

As CONFIG_X86_INTEL_PSTATE is set to Y by default, I wasn't enable to reload it in any way.

By reading the code, most of the code path and return options doesn't have a single pr_<something> call to explain why.

So I had to rebuild the kernel + my patch to understand which path was taken and then find the root cause of why the pstate behavior changed.

I wanted to contribute back my experience here by providing messages to ease the understanding and potentially debugging of the driver without recompiling it.

So the root of this patch is being able to report the main reasons of why the driver didn't engaged itself with a pr_warn (could be also a pr_info).

All the major and probable "return -ENODEV" calls before pr_info("Intel P-state driver initializing\n") deserves to be explicit and reachable on dmesg for the operators.

Quoted 6 lines

I'm operating 30K+ servers and having this kind direct information would save serious time when debugging this situations.

If my experience in that area could help other users, I'd be happy.

I'm positing a v5 with all those changes.

Many thanks for your contribution!

#4 lore raw

Le 13/02/2019 à 11:34, Rafael J. Wysocki a écrit :

Quoted 1 line

So a single "no PCCH" message for this whole function should be sufficient.

Let's do that.

[...]

Quoted 3 lines

And what did turn out to be the problem?

Anyway, pr_info() should be sufficient IMO.

You should be pretty aware of 95d6c0857e54b788982746071130d822a795026b ;)

Depending if we have or not this patch, intel_pstate engage itself or not.

When engaged, we have to perform some configuration that the other state doesn't imply.

I'm updating the patch this way than send a v6.

I just let intel_pstate_msrs_not_valid() in pr_warn() as this one is not supposed to be a "normal" case.

Thanks for your time & reviews.

Quoted 1 line

Many thanks for your contribution!

My pleasure !

Erwan,