Skip to contentSkip to conversation

Fixing error_interrupt()'s messages v2

PATCH Superseded Elliott Mitchell 2 participants 10 messages Mar 17, 2023 – Mar 20, 2023

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

v2 cover Fixing error_interrupt()'s messages v2

Using a somewhat distinct strategy with the printk(). This is two patches, since nominally the first can work with other strategies. I could see them being squashed during commit to the main repository.

Elliott Mitchell (2):
x86/APIC: include full string with error_interrupt() error messages x86/APIC: modify error_interrupt() to output using single printk()

 xen/arch/x86/apic.c | 27 ++++++++++++++-------------
 1 file changed, 14 insertions(+), 13 deletions(-)
Signature · 4 lines
(\___(\___(\______          --=> 8-) EHM <=--          ______/)___/)___/)
 \BS (    |       [email protected] PGP 87145445       |    )   /
  \_CS\   |  _____  -O #include <stddisclaimer.h> O-   _____  |   /  _/
8A19\___\_|_/58D2 7E3D DDF4 7BA6 <-PGP-> 41D1 B375 37D0 8714\_|_/___/5445
#1 lore raw

PATCH v2 1/2 x86/APIC: include full string with error_interrupt() error messages

Rather than adding ", " with each printf(), simply include them in the string initially.

---
 xen/arch/x86/apic.c | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)
xen/arch/x86/apic.c +9 -9
index f71474d47d..8cfb8cd71c 100644
@@ -1401,14 +1401,14 @@ static void cf_check spurious_interrupt(struct cpu_user_regs *regs)
 static void cf_check error_interrupt(struct cpu_user_regs *regs)
 {
     static const char *const esr_fields[] = {
-        "Send CS error",
-        "Receive CS error",
-        "Send accept error",
-        "Receive accept error",
-        "Redirectable IPI",
-        "Send illegal vector",
-        "Received illegal vector",
-        "Illegal register address",
+        ", Send CS error",
+        ", Receive CS error",
+        ", Send accept error",
+        ", Receive accept error",
+        ", Redirectable IPI",
+        ", Send illegal vector",
+        ", Received illegal vector",
+        ", Illegal register address",
     };
     unsigned int v, v1;
     int i;
@@ -1423,7 +1423,7 @@ static void cf_check error_interrupt(struct cpu_user_regs *regs)
             smp_processor_id(), v , v1);
     for ( i = 7; i >= 0; --i )
         if ( v1 & (1 << i) )
-            printk(", %s", esr_fields[i]);
+            printk("%s", esr_fields[i]);
     printk("\n");
 }
 
Signature · 4 lines
(\___(\___(\______          --=> 8-) EHM <=--          ______/)___/)___/)
 \BS (    |       [email protected] PGP 87145445       |    )   /
  \_CS\   |  _____  -O #include <stddisclaimer.h> O-   _____  |   /  _/
8A19\___\_|_/58D2 7E3D DDF4 7BA6 <-PGP-> 41D1 B375 37D0 8714\_|_/___/5445
#2 lore raw

Re: [PATCH v2 1/2] x86/APIC: include full string with error_interrupt() error messages

Quoted 2 lines · Elliott Mitchell

Rather than adding ", " with each printf(), simply include them in the string initially.

Why is this better? You're now using more space in .rodata. (I haven't looked at patch 2 yet to see whether there's a possible reason there for the change here, but if there was it would need saying here.)

Jan

#3 lore raw

Re: [PATCH v2 1/2] x86/APIC: include full string with error_interrupt() error messages

Quoted 7 lines · Jan Beulich
Quoted 2 lines · Elliott Mitchell

Rather than adding ", " with each printf(), simply include them in the string initially.

Why is this better? You're now using more space in .rodata. (I haven't looked at patch 2 yet to see whether there's a possible reason there for the change here, but if there was it would need saying here.)

I would expect this to give trivially better performance. Instead of needing to needing copy some data from the format string, then strcat() from the arguments this turns it into a single strcat().

Other item is this sort of change is very often a precursor to replacing the use of a *printf()-type function with a str*cat()-type function. Though in this case I doubt there is a strlcatk() function so that is unlikely.

Signature · 4 lines
(\___(\___(\______          --=> 8-) EHM <=--          ______/)___/)___/)
 \BS (    |         [email protected]  PGP 87145445         |    )   /
  \_CS\   |  _____  -O #include <stddisclaimer.h> O-   _____  |   /  _/
8A19\___\_|_/58D2 7E3D DDF4 7BA6 <-PGP-> 41D1 B375 37D0 8714\_|_/___/5445
#4 lore raw

PATCH v2 2/2 x86/APIC: modify error_interrupt() to output using single printk()

In reply to Elliott Mitchell

This takes care of the issue of APIC errors tending to occur on multiple cores at one. In turn this tends to causes the error messages to be merged together, making understanding them difficult.

---
 xen/arch/x86/apic.c | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)
xen/arch/x86/apic.c +6 -5
index 8cfb8cd71c..89abd1ea51 100644
@@ -1410,6 +1410,7 @@ static void cf_check error_interrupt(struct cpu_user_regs *regs)
         ", Received illegal vector",
         ", Illegal register address",
     };
+    const char *entries[ARRAY_SIZE(esr_fields)];
     unsigned int v, v1;
     int i;
 
@@ -1419,12 +1420,12 @@ static void cf_check error_interrupt(struct cpu_user_regs *regs)
     v1 = apic_read(APIC_ESR);
     ack_APIC_irq();
 
-    printk(XENLOG_DEBUG "APIC error on CPU%u: %02x(%02x)",
-            smp_processor_id(), v , v1);
     for ( i = 7; i >= 0; --i )
-        if ( v1 & (1 << i) )
-            printk("%s", esr_fields[i]);
-    printk("\n");
+        entries[i] = v1 & (1 << i) ? esr_fields[i] : "";
+    printk(XENLOG_DEBUG "APIC error on CPU%u: %02x(%02x)"
+            "%s%s%s%s%s%s%s%s" "\n",
+            smp_processor_id(), v , v1, entries[0], entries[1], entries[2],
+            entries[3], entries[4], entries[5], entries[6], entries[7]);
 }
 
 /*
Signature · 4 lines
(\___(\___(\______          --=> 8-) EHM <=--          ______/)___/)___/)
 \BS (    |       [email protected] PGP 87145445       |    )   /
  \_CS\   |  _____  -O #include <stddisclaimer.h> O-   _____  |   /  _/
8A19\___\_|_/58D2 7E3D DDF4 7BA6 <-PGP-> 41D1 B375 37D0 8714\_|_/___/5445
#5 lore raw

Re: [PATCH v2 2/2] x86/APIC: modify error_interrupt() to output using single printk()

Quoted 2 lines · Elliott Mitchell

This takes care of the issue of APIC errors tending to occur on multiple cores at one. In turn this tends to causes the error messages to be

Nit: "at once"?

Quoted 3 lines

merged together, making understanding them difficult.

Here it becomes clear why you're making the change in patch 1; as you say in the cover letter these may better be folded (or else, as said there, patch 1 needs better justification).

Quoted 5 lines
xen/arch/x86/apic.c +0 -1
@@ -1419,12 +1420,12 @@ static void cf_check error_interrupt(struct cpu_user_regs *regs)
     v1 = apic_read(APIC_ESR);
     ack_APIC_irq();
 
-    printk(XENLOG_DEBUG "APIC error on CPU%u: %02x(%02x)",

xen/arch/x86/apic.c static void cf_check error_interrupt(struct cpu_user_regs *regs) · line 1428

Quoted 10 lines
xen/arch/x86/apic.c +5 -4
-            smp_processor_id(), v , v1);
     for ( i = 7; i >= 0; --i )
-        if ( v1 & (1 << i) )
-            printk("%s", esr_fields[i]);
-    printk("\n");
+        entries[i] = v1 & (1 << i) ? esr_fields[i] : "";
+    printk(XENLOG_DEBUG "APIC error on CPU%u: %02x(%02x)"
+            "%s%s%s%s%s%s%s%s" "\n",
+            smp_processor_id(), v , v1, entries[0], entries[1], entries[2],
+            entries[3], entries[4], entries[5], entries[6], entries[7]);

Two style nits: Indentation wants fixing here (it was wrong in the original code already), and the stray blank between v and the comma also wants dropping at this occasion.

Jan

#6 lore raw

Re: [PATCH v2 2/2] x86/APIC: modify error_interrupt() to output using single printk()

Quoted 5 lines · Jan Beulich
Quoted 2 lines · Elliott Mitchell

This takes care of the issue of APIC errors tending to occur on multiple cores at one. In turn this tends to causes the error messages to be

Nit: "at once"?

https://en.wiktionary.org/wiki/at_once

Adverb #2, synonym of "simultaneously".

Quoted 4 lines
Quoted 4 lines
xen/arch/x86/apic.c +0 -0
@@ -1419,12 +1420,12 @@ static void cf_check error_interrupt(struct cpu_user_regs *regs)
     v1 = apic_read(APIC_ESR);
     ack_APIC_irq();
 
Quoted 15 lines

xen/arch/x86/apic.c static void cf_check error_interrupt(struct cpu_user_regs *regs) · line 1428

Quoted 11 lines
xen/arch/x86/apic.c +5 -5
-    printk(XENLOG_DEBUG "APIC error on CPU%u: %02x(%02x)",
-            smp_processor_id(), v , v1);
     for ( i = 7; i >= 0; --i )
-        if ( v1 & (1 << i) )
-            printk("%s", esr_fields[i]);
-    printk("\n");
+        entries[i] = v1 & (1 << i) ? esr_fields[i] : "";
+    printk(XENLOG_DEBUG "APIC error on CPU%u: %02x(%02x)"
+            "%s%s%s%s%s%s%s%s" "\n",
+            smp_processor_id(), v , v1, entries[0], entries[1], entries[2],
+            entries[3], entries[4], entries[5], entries[6], entries[7]);

Two style nits: Indentation wants fixing here (it was wrong in the original code already), and the stray blank between v and the comma also wants dropping at this occasion.

There are several minor issues here which may be best handled during commit as they're very small items about how precisely you want this to look.

First, I later realized I goofed the argument order. In order to match the original implementation, it needs to be entries[7] ... entries[0] (could though be the low-order bits should be reported first).

Second, the order of the for loop no longer matters. Using ARRAY_SIZE(esr_fields) and increment should now be more maintainable (this would also allow i to be unsigned).

Third, I'm simply unsure how you would prefer to format the printk(). I imagine at some future point the register may have additional bits allocated. At such point esr_fields[] would grow, but this would also require adding to the format string and adding an argument.

Seems like several fiddly bits which mostly effect look and don't really effect the implementation.

Signature · 4 lines
(\___(\___(\______          --=> 8-) EHM <=--          ______/)___/)___/)
 \BS (    |         [email protected]  PGP 87145445         |    )   /
  \_CS\   |  _____  -O #include <stddisclaimer.h> O-   _____  |   /  _/
8A19\___\_|_/58D2 7E3D DDF4 7BA6 <-PGP-> 41D1 B375 37D0 8714\_|_/___/5445
#7 lore raw

Re: [PATCH v2 2/2] x86/APIC: modify error_interrupt() to output using single printk()

Quoted 10 lines · Elliott Mitchell
Quoted 5 lines · Jan Beulich
Quoted 2 lines · Elliott Mitchell

This takes care of the issue of APIC errors tending to occur on multiple cores at one. In turn this tends to causes the error messages to be

Nit: "at once"?

https://en.wiktionary.org/wiki/at_once

Adverb #2, synonym of "simultaneously".

And that's what you mean, I think? Not being a native speaker, I have no idea what "at one" is meaning here.

Quoted 20 lines
Quoted 4 lines
Quoted 4 lines
xen/arch/x86/apic.c +0 -0
@@ -1419,12 +1420,12 @@ static void cf_check error_interrupt(struct cpu_user_regs *regs)
     v1 = apic_read(APIC_ESR);
     ack_APIC_irq();
 
Quoted 15 lines

xen/arch/x86/apic.c static void cf_check error_interrupt(struct cpu_user_regs *regs) · line 1428

Quoted 11 lines
xen/arch/x86/apic.c +5 -5
-    printk(XENLOG_DEBUG "APIC error on CPU%u: %02x(%02x)",
-            smp_processor_id(), v , v1);
     for ( i = 7; i >= 0; --i )
-        if ( v1 & (1 << i) )
-            printk("%s", esr_fields[i]);
-    printk("\n");
+        entries[i] = v1 & (1 << i) ? esr_fields[i] : "";
+    printk(XENLOG_DEBUG "APIC error on CPU%u: %02x(%02x)"
+            "%s%s%s%s%s%s%s%s" "\n",
+            smp_processor_id(), v , v1, entries[0], entries[1], entries[2],
+            entries[3], entries[4], entries[5], entries[6], entries[7]);

Two style nits: Indentation wants fixing here (it was wrong in the original code already), and the stray blank between v and the comma also wants dropping at this occasion.

Quoted 7 lines

There are several minor issues here which may be best handled during commit as they're very small items about how precisely you want this to look.

First, I later realized I goofed the argument order. In order to match the original implementation, it needs to be entries[7] ... entries[0] (could though be the low-order bits should be reported first).

I'm not really concerned of the order. A change of order wants mentioning in the description though.

Quoted 3 lines

Second, the order of the for loop no longer matters. Using ARRAY_SIZE(esr_fields) and increment should now be more maintainable (this would also allow i to be unsigned).

Indeed. But that would better done in a separate patch then anyway.

Quoted 1 line

Third, I'm simply unsure how you would prefer to format the printk().

About any way matching style guidelines is okay. There are two more things to mention though (sorry for not noticing earlier): We aim at keeping the entire format string on one line, for grep-ability. And there's no need (and in fact no reason) to split the sequence of %s from the \n. To summarize:

    printk(XENLOG_DEBUG
           "APIC error on CPU%u: %02x(%02x)%s%s%s%s%s%s%s%s\n",

(unless of course it all fits on one line, which it looks like it does).

Jan

#8 lore raw

Re: [PATCH v2 2/2] x86/APIC: modify error_interrupt() to output using single printk()

Quoted 6 lines · Jan Beulich
Quoted 5 lines · Elliott Mitchell

There are several minor issues here which may be best handled during commit as they're very small items about how precisely you want this to look.

Quoted 6 lines
Quoted 3 lines

First, I later realized I goofed the argument order. In order to match the original implementation, it needs to be entries[7] ... entries[0] (could though be the low-order bits should be reported first).

I'm not really concerned of the order. A change of order wants mentioning in the description though.

Seemed simple enough to fix on commit (simply switch the order of numbers).

Quoted 5 lines
Quoted 3 lines

Second, the order of the for loop no longer matters. Using ARRAY_SIZE(esr_fields) and increment should now be more maintainable (this would also allow i to be unsigned).

Indeed. But that would better done in a separate patch then anyway.

Feel free to split.

Quoted 8 lines
Quoted 1 line

Third, I'm simply unsure how you would prefer to format the printk().

About any way matching style guidelines is okay. There are two more things to mention though (sorry for not noticing earlier): We aim at keeping the entire format string on one line, for grep-ability. And there's no need (and in fact no reason) to split the sequence of %s from the \n. To summarize:

Quoted 5 lines
    printk(XENLOG_DEBUG
           "APIC error on CPU%u: %02x(%02x)%s%s%s%s%s%s%s%s\n",

(unless of course it all fits on one line, which it looks like it does).

I like keeping the "%s%s%s%s%s%s%s%s" section separated since it needs to match the number of arguments. In the future where more bits of the register are defined, both sections will need to be modified together.

This seems to be a spot where there are large numbers of similarly functional, but mildly different style variants. As such I suspect this is best left in your hands as this is a bog of trivial style considerations which have no real functional effect.

Signature · 4 lines
(\___(\___(\______          --=> 8-) EHM <=--          ______/)___/)___/)
 \BS (    |         [email protected]  PGP 87145445         |    )   /
  \_CS\   |  _____  -O #include <stddisclaimer.h> O-   _____  |   /  _/
8A19\___\_|_/58D2 7E3D DDF4 7BA6 <-PGP-> 41D1 B375 37D0 8714\_|_/___/5445
#9 lore raw

Re: [PATCH v2 2/2] x86/APIC: modify error_interrupt() to output using single printk()

Quoted 44 lines · Elliott Mitchell
Quoted 6 lines · Jan Beulich
Quoted 5 lines · Elliott Mitchell

There are several minor issues here which may be best handled during commit as they're very small items about how precisely you want this to look.

Quoted 6 lines
Quoted 3 lines

First, I later realized I goofed the argument order. In order to match the original implementation, it needs to be entries[7] ... entries[0] (could though be the low-order bits should be reported first).

I'm not really concerned of the order. A change of order wants mentioning in the description though.

Seemed simple enough to fix on commit (simply switch the order of numbers).

Quoted 5 lines
Quoted 3 lines

Second, the order of the for loop no longer matters. Using ARRAY_SIZE(esr_fields) and increment should now be more maintainable (this would also allow i to be unsigned).

Indeed. But that would better done in a separate patch then anyway.

Feel free to split.

Quoted 8 lines
Quoted 1 line

Third, I'm simply unsure how you would prefer to format the printk().

About any way matching style guidelines is okay. There are two more things to mention though (sorry for not noticing earlier): We aim at keeping the entire format string on one line, for grep-ability. And there's no need (and in fact no reason) to split the sequence of %s from the \n. To summarize:

Quoted 5 lines
    printk(XENLOG_DEBUG
           "APIC error on CPU%u: %02x(%02x)%s%s%s%s%s%s%s%s\n",

(unless of course it all fits on one line, which it looks like it does).

I like keeping the "%s%s%s%s%s%s%s%s" section separated since it needs to match the number of arguments. In the future where more bits of the register are defined, both sections will need to be modified together.

Quoted 4 lines

This seems to be a spot where there are large numbers of similarly functional, but mildly different style variants. As such I suspect this is best left in your hands as this is a bog of trivial style considerations which have no real functional effect.

Just to clarify: What is or is not adjusted on commit is a decision of the committer. A no longer as active committer was actually of the opinion that it is a mistake to ever make any changes while committing. In the case here you're asking for far more changes (including either one to the description of patch 1, or the folding of both patches) than I personally would be willing to do. I'm sorry for that.

Jan