2016-11-18 17:46:37

by Josh Poimboeuf

[permalink] [raw]
Subject: [PATCH] x86/dumpstack: make stack name tags more comprehensible

NMI stack dumps are bracked by the following tags:

<NMI>
...
<EOE>

The ending tag is kind of confusing if you don't already know what "EOE"
means (end of exception). The same ending tag is also used to mark the
end of all other exceptions' stacks. For example:

<#DF>
...
<EOE>

And similarly, "EOI" is used as the ending tag for interrupts:

<IRQ>
...
<EOI>

Change the tags to be more comprehensible by making them symmetrical and
more XML-esque:

<NMI>
...
</NMI>

<#DF>
...
</#DF>

<IRQ>
...
</IRQ>

Signed-off-by: Josh Poimboeuf <[email protected]>
---
arch/x86/include/asm/stacktrace.h | 3 +--
arch/x86/kernel/dumpstack.c | 12 ++++++------
arch/x86/kernel/dumpstack_32.c | 19 ++++++++-----------
arch/x86/kernel/dumpstack_64.c | 22 ++++++++--------------
4 files changed, 23 insertions(+), 33 deletions(-)

diff --git a/arch/x86/include/asm/stacktrace.h b/arch/x86/include/asm/stacktrace.h
index 1e375b0..a3269c8 100644
--- a/arch/x86/include/asm/stacktrace.h
+++ b/arch/x86/include/asm/stacktrace.h
@@ -30,8 +30,7 @@ bool in_task_stack(unsigned long *stack, struct task_struct *task,
int get_stack_info(unsigned long *stack, struct task_struct *task,
struct stack_info *info, unsigned long *visit_mask);

-void stack_type_str(enum stack_type type, const char **begin,
- const char **end);
+const char *stack_type_name(enum stack_type type);

static inline bool on_stack(struct stack_info *info, void *addr, size_t len)
{
diff --git a/arch/x86/kernel/dumpstack.c b/arch/x86/kernel/dumpstack.c
index bbea45f..0cfd01d 100644
--- a/arch/x86/kernel/dumpstack.c
+++ b/arch/x86/kernel/dumpstack.c
@@ -76,7 +76,7 @@ void show_trace_log_lvl(struct task_struct *task, struct pt_regs *regs,
* - hardirq stack
*/
for (regs = NULL; stack; stack = stack_info.next_sp) {
- const char *str_begin, *str_end;
+ const char *stack_name;

/*
* If we overflowed the task stack into a guard page, jump back
@@ -88,9 +88,9 @@ void show_trace_log_lvl(struct task_struct *task, struct pt_regs *regs,
if (get_stack_info(stack, task, &stack_info, &visit_mask))
break;

- stack_type_str(stack_info.type, &str_begin, &str_end);
- if (str_begin)
- printk("%s <%s>\n", log_lvl, str_begin);
+ stack_name = stack_type_name(stack_info.type);
+ if (stack_name)
+ printk("%s <%s>\n", log_lvl, stack_name);

/*
* Scan the stack, printing any text addresses we find. At the
@@ -155,8 +155,8 @@ void show_trace_log_lvl(struct task_struct *task, struct pt_regs *regs,
__show_regs(regs, 0);
}

- if (str_end)
- printk("%s <%s>\n", log_lvl, str_end);
+ if (stack_name)
+ printk("%s </%s>\n", log_lvl, stack_name);
}
}

diff --git a/arch/x86/kernel/dumpstack_32.c b/arch/x86/kernel/dumpstack_32.c
index d7d20999..bb3b5b9 100644
--- a/arch/x86/kernel/dumpstack_32.c
+++ b/arch/x86/kernel/dumpstack_32.c
@@ -16,18 +16,15 @@

#include <asm/stacktrace.h>

-void stack_type_str(enum stack_type type, const char **begin, const char **end)
+const char *stack_type_name(enum stack_type type)
{
- switch (type) {
- case STACK_TYPE_IRQ:
- case STACK_TYPE_SOFTIRQ:
- *begin = "IRQ";
- *end = "EOI";
- break;
- default:
- *begin = NULL;
- *end = NULL;
- }
+ if (type == STACK_TYPE_IRQ)
+ return "IRQ";
+
+ if (type == STACK_TYPE_SOFTIRQ)
+ return "SOFTIRQ";
+
+ return NULL;
}

static bool in_hardirq_stack(unsigned long *stack, struct stack_info *info)
diff --git a/arch/x86/kernel/dumpstack_64.c b/arch/x86/kernel/dumpstack_64.c
index ab0f8b9..fac189e 100644
--- a/arch/x86/kernel/dumpstack_64.c
+++ b/arch/x86/kernel/dumpstack_64.c
@@ -28,23 +28,17 @@ static unsigned long exception_stack_sizes[N_EXCEPTION_STACKS] = {
[DEBUG_STACK - 1] = DEBUG_STKSZ
};

-void stack_type_str(enum stack_type type, const char **begin, const char **end)
+const char *stack_type_name(enum stack_type type)
{
BUILD_BUG_ON(N_EXCEPTION_STACKS != 4);

- switch (type) {
- case STACK_TYPE_IRQ:
- *begin = "IRQ";
- *end = "EOI";
- break;
- case STACK_TYPE_EXCEPTION ... STACK_TYPE_EXCEPTION_LAST:
- *begin = exception_stack_names[type - STACK_TYPE_EXCEPTION];
- *end = "EOE";
- break;
- default:
- *begin = NULL;
- *end = NULL;
- }
+ if (type == STACK_TYPE_IRQ)
+ return "IRQ";
+
+ if (type >= STACK_TYPE_EXCEPTION && type <= STACK_TYPE_EXCEPTION_LAST)
+ return exception_stack_names[type - STACK_TYPE_EXCEPTION];
+
+ return NULL;
}

static bool in_exception_stack(unsigned long *stack, struct stack_info *info)
--
2.7.4


2016-11-18 18:54:25

by Peter Zijlstra

[permalink] [raw]
Subject: Re: [PATCH] x86/dumpstack: make stack name tags more comprehensible

On Fri, Nov 18, 2016 at 11:46:23AM -0600, Josh Poimboeuf wrote:
> NMI stack dumps are bracked by the following tags:
>
> <NMI>
> ...
> <EOE>
>
> The ending tag is kind of confusing if you don't already know what "EOE"
> means (end of exception). The same ending tag is also used to mark the
> end of all other exceptions' stacks. For example:
>
> <#DF>
> ...
> <EOE>
>
> And similarly, "EOI" is used as the ending tag for interrupts:
>
> <IRQ>
> ...
> <EOI>
>
> Change the tags to be more comprehensible by making them symmetrical and
> more XML-esque:
>
> <NMI>
> ...
> </NMI>
>
> <#DF>
> ...
> </#DF>
>
> <IRQ>
> ...
> </IRQ>
>
> Signed-off-by: Josh Poimboeuf <[email protected]>

> arch/x86/include/asm/stacktrace.h | 3 +--
> arch/x86/kernel/dumpstack.c | 12 ++++++------
> arch/x86/kernel/dumpstack_32.c | 19 ++++++++-----------
> arch/x86/kernel/dumpstack_64.c | 22 ++++++++--------------
> 4 files changed, 23 insertions(+), 33 deletions(-)

And saves lines too, awesome!

Acked-by: Peter Zijlstra (Intel) <[email protected]>

2016-11-19 15:49:49

by Frederic Weisbecker

[permalink] [raw]
Subject: Re: [PATCH] x86/dumpstack: make stack name tags more comprehensible

2016-11-18 18:46 GMT+01:00 Josh Poimboeuf <[email protected]>:
> NMI stack dumps are bracked by the following tags:
>
> <NMI>
> ...
> <EOE>
>
> The ending tag is kind of confusing if you don't already know what "EOE"
> means (end of exception). The same ending tag is also used to mark the
> end of all other exceptions' stacks. For example:
>
> <#DF>
> ...
> <EOE>
>
> And similarly, "EOI" is used as the ending tag for interrupts:
>
> <IRQ>
> ...
> <EOI>
>
> Change the tags to be more comprehensible by making them symmetrical and
> more XML-esque:
>
> <NMI>
> ...
> </NMI>
>
> <#DF>
> ...
> </#DF>
>
> <IRQ>
> ...
> </IRQ>
>
> Signed-off-by: Josh Poimboeuf <[email protected]>

I like that! I hope not too many tools rely on the old namings.
But dmesg isn't supposed to be a stable ABI anyway.

Acked-by: Frederic Weisbecker <[email protected]>

2016-11-19 20:25:21

by Josh Poimboeuf

[permalink] [raw]
Subject: Re: [PATCH] x86/dumpstack: make stack name tags more comprehensible

On Fri, Nov 18, 2016 at 11:46:23AM -0600, Josh Poimboeuf wrote:
> NMI stack dumps are bracked by the following tags:

s/bracked/bracketed/

--
Josh

Subject: [tip:x86/asm] x86/dumpstack: Make stack name tags more comprehensible

Commit-ID: 2e080881993d6a018d2c2ee1901f933e4a17ea5a
Gitweb: http://git.kernel.org/tip/2e080881993d6a018d2c2ee1901f933e4a17ea5a
Author: Josh Poimboeuf <[email protected]>
AuthorDate: Fri, 18 Nov 2016 11:46:23 -0600
Committer: Ingo Molnar <[email protected]>
CommitDate: Mon, 21 Nov 2016 11:11:03 +0100

x86/dumpstack: Make stack name tags more comprehensible

NMI stack dumps are bracketed by the following tags:

<NMI>
...
<EOE>

The ending tag is kind of confusing if you don't already know what "EOE"
means (end of exception). The same ending tag is also used to mark the
end of all other exceptions' stacks. For example:

<#DF>
...
<EOE>

And similarly, "EOI" is used as the ending tag for interrupts:

<IRQ>
...
<EOI>

Change the tags to be more comprehensible by making them symmetrical and
more XML-esque:

<NMI>
...
</NMI>

<#DF>
...
</#DF>

<IRQ>
...
</IRQ>

Signed-off-by: Josh Poimboeuf <[email protected]>
Acked-by: Frederic Weisbecker <[email protected]>
Cc: Andy Lutomirski <[email protected]>
Cc: Borislav Petkov <[email protected]>
Cc: Brian Gerst <[email protected]>
Cc: Denys Vlasenko <[email protected]>
Cc: H. Peter Anvin <[email protected]>
Cc: Linus Torvalds <[email protected]>
Cc: Peter Zijlstra <[email protected]>
Cc: Thomas Gleixner <[email protected]>
Link: http://lkml.kernel.org/r/180196e3754572540b595bc56b947d43658979a7.1479491159.git.jpoimboe@redhat.com
Signed-off-by: Ingo Molnar <[email protected]>
---
arch/x86/include/asm/stacktrace.h | 3 +--
arch/x86/kernel/dumpstack.c | 12 ++++++------
arch/x86/kernel/dumpstack_32.c | 19 ++++++++-----------
arch/x86/kernel/dumpstack_64.c | 22 ++++++++--------------
4 files changed, 23 insertions(+), 33 deletions(-)

diff --git a/arch/x86/include/asm/stacktrace.h b/arch/x86/include/asm/stacktrace.h
index 1e375b0..a3269c8 100644
--- a/arch/x86/include/asm/stacktrace.h
+++ b/arch/x86/include/asm/stacktrace.h
@@ -30,8 +30,7 @@ bool in_task_stack(unsigned long *stack, struct task_struct *task,
int get_stack_info(unsigned long *stack, struct task_struct *task,
struct stack_info *info, unsigned long *visit_mask);

-void stack_type_str(enum stack_type type, const char **begin,
- const char **end);
+const char *stack_type_name(enum stack_type type);

static inline bool on_stack(struct stack_info *info, void *addr, size_t len)
{
diff --git a/arch/x86/kernel/dumpstack.c b/arch/x86/kernel/dumpstack.c
index 1e057b0..0e5c9d0 100644
--- a/arch/x86/kernel/dumpstack.c
+++ b/arch/x86/kernel/dumpstack.c
@@ -76,7 +76,7 @@ void show_trace_log_lvl(struct task_struct *task, struct pt_regs *regs,
* - hardirq stack
*/
for (regs = NULL; stack; stack = stack_info.next_sp) {
- const char *str_begin, *str_end;
+ const char *stack_name;

/*
* If we overflowed the task stack into a guard page, jump back
@@ -88,9 +88,9 @@ void show_trace_log_lvl(struct task_struct *task, struct pt_regs *regs,
if (get_stack_info(stack, task, &stack_info, &visit_mask))
break;

- stack_type_str(stack_info.type, &str_begin, &str_end);
- if (str_begin)
- printk("%s <%s>\n", log_lvl, str_begin);
+ stack_name = stack_type_name(stack_info.type);
+ if (stack_name)
+ printk("%s <%s>\n", log_lvl, stack_name);

/*
* Scan the stack, printing any text addresses we find. At the
@@ -155,8 +155,8 @@ void show_trace_log_lvl(struct task_struct *task, struct pt_regs *regs,
__show_regs(regs, 0);
}

- if (str_end)
- printk("%s <%s>\n", log_lvl, str_end);
+ if (stack_name)
+ printk("%s </%s>\n", log_lvl, stack_name);
}
}

diff --git a/arch/x86/kernel/dumpstack_32.c b/arch/x86/kernel/dumpstack_32.c
index d7d20999..bb3b5b9 100644
--- a/arch/x86/kernel/dumpstack_32.c
+++ b/arch/x86/kernel/dumpstack_32.c
@@ -16,18 +16,15 @@

#include <asm/stacktrace.h>

-void stack_type_str(enum stack_type type, const char **begin, const char **end)
+const char *stack_type_name(enum stack_type type)
{
- switch (type) {
- case STACK_TYPE_IRQ:
- case STACK_TYPE_SOFTIRQ:
- *begin = "IRQ";
- *end = "EOI";
- break;
- default:
- *begin = NULL;
- *end = NULL;
- }
+ if (type == STACK_TYPE_IRQ)
+ return "IRQ";
+
+ if (type == STACK_TYPE_SOFTIRQ)
+ return "SOFTIRQ";
+
+ return NULL;
}

static bool in_hardirq_stack(unsigned long *stack, struct stack_info *info)
diff --git a/arch/x86/kernel/dumpstack_64.c b/arch/x86/kernel/dumpstack_64.c
index ab0f8b9..fac189e 100644
--- a/arch/x86/kernel/dumpstack_64.c
+++ b/arch/x86/kernel/dumpstack_64.c
@@ -28,23 +28,17 @@ static unsigned long exception_stack_sizes[N_EXCEPTION_STACKS] = {
[DEBUG_STACK - 1] = DEBUG_STKSZ
};

-void stack_type_str(enum stack_type type, const char **begin, const char **end)
+const char *stack_type_name(enum stack_type type)
{
BUILD_BUG_ON(N_EXCEPTION_STACKS != 4);

- switch (type) {
- case STACK_TYPE_IRQ:
- *begin = "IRQ";
- *end = "EOI";
- break;
- case STACK_TYPE_EXCEPTION ... STACK_TYPE_EXCEPTION_LAST:
- *begin = exception_stack_names[type - STACK_TYPE_EXCEPTION];
- *end = "EOE";
- break;
- default:
- *begin = NULL;
- *end = NULL;
- }
+ if (type == STACK_TYPE_IRQ)
+ return "IRQ";
+
+ if (type >= STACK_TYPE_EXCEPTION && type <= STACK_TYPE_EXCEPTION_LAST)
+ return exception_stack_names[type - STACK_TYPE_EXCEPTION];
+
+ return NULL;
}

static bool in_exception_stack(unsigned long *stack, struct stack_info *info)

Subject: [tip:x86/asm] x86/dumpstack: Make stack name tags more comprehensible

Commit-ID: 3d02a9c48d479eb58841805baaf93c5a084b6010
Gitweb: http://git.kernel.org/tip/3d02a9c48d479eb58841805baaf93c5a084b6010
Author: Josh Poimboeuf <[email protected]>
AuthorDate: Fri, 18 Nov 2016 11:46:23 -0600
Committer: Ingo Molnar <[email protected]>
CommitDate: Mon, 21 Nov 2016 13:00:42 +0100

x86/dumpstack: Make stack name tags more comprehensible

NMI stack dumps are bracketed by the following tags:

<NMI>
...
<EOE>

The ending tag is kind of confusing if you don't already know what "EOE"
means (end of exception). The same ending tag is also used to mark the
end of all other exceptions' stacks. For example:

<#DF>
...
<EOE>

And similarly, "EOI" is used as the ending tag for interrupts:

<IRQ>
...
<EOI>

Change the tags to be more comprehensible by making them symmetrical and
more XML-esque:

<NMI>
...
</NMI>

<#DF>
...
</#DF>

<IRQ>
...
</IRQ>

Signed-off-by: Josh Poimboeuf <[email protected]>
Acked-by: Frederic Weisbecker <[email protected]>
Acked-by: Peter Zijlstra (Intel) <[email protected]>
Cc: Andy Lutomirski <[email protected]>
Cc: Borislav Petkov <[email protected]>
Cc: Brian Gerst <[email protected]>
Cc: Denys Vlasenko <[email protected]>
Cc: H. Peter Anvin <[email protected]>
Cc: Linus Torvalds <[email protected]>
Cc: Thomas Gleixner <[email protected]>
Link: http://lkml.kernel.org/r/180196e3754572540b595bc56b947d43658979a7.1479491159.git.jpoimboe@redhat.com
Signed-off-by: Ingo Molnar <[email protected]>
---
arch/x86/include/asm/stacktrace.h | 3 +--
arch/x86/kernel/dumpstack.c | 12 ++++++------
arch/x86/kernel/dumpstack_32.c | 19 ++++++++-----------
arch/x86/kernel/dumpstack_64.c | 22 ++++++++--------------
4 files changed, 23 insertions(+), 33 deletions(-)

diff --git a/arch/x86/include/asm/stacktrace.h b/arch/x86/include/asm/stacktrace.h
index 1e375b0..a3269c8 100644
--- a/arch/x86/include/asm/stacktrace.h
+++ b/arch/x86/include/asm/stacktrace.h
@@ -30,8 +30,7 @@ bool in_task_stack(unsigned long *stack, struct task_struct *task,
int get_stack_info(unsigned long *stack, struct task_struct *task,
struct stack_info *info, unsigned long *visit_mask);

-void stack_type_str(enum stack_type type, const char **begin,
- const char **end);
+const char *stack_type_name(enum stack_type type);

static inline bool on_stack(struct stack_info *info, void *addr, size_t len)
{
diff --git a/arch/x86/kernel/dumpstack.c b/arch/x86/kernel/dumpstack.c
index 1e057b0..0e5c9d0 100644
--- a/arch/x86/kernel/dumpstack.c
+++ b/arch/x86/kernel/dumpstack.c
@@ -76,7 +76,7 @@ void show_trace_log_lvl(struct task_struct *task, struct pt_regs *regs,
* - hardirq stack
*/
for (regs = NULL; stack; stack = stack_info.next_sp) {
- const char *str_begin, *str_end;
+ const char *stack_name;

/*
* If we overflowed the task stack into a guard page, jump back
@@ -88,9 +88,9 @@ void show_trace_log_lvl(struct task_struct *task, struct pt_regs *regs,
if (get_stack_info(stack, task, &stack_info, &visit_mask))
break;

- stack_type_str(stack_info.type, &str_begin, &str_end);
- if (str_begin)
- printk("%s <%s>\n", log_lvl, str_begin);
+ stack_name = stack_type_name(stack_info.type);
+ if (stack_name)
+ printk("%s <%s>\n", log_lvl, stack_name);

/*
* Scan the stack, printing any text addresses we find. At the
@@ -155,8 +155,8 @@ void show_trace_log_lvl(struct task_struct *task, struct pt_regs *regs,
__show_regs(regs, 0);
}

- if (str_end)
- printk("%s <%s>\n", log_lvl, str_end);
+ if (stack_name)
+ printk("%s </%s>\n", log_lvl, stack_name);
}
}

diff --git a/arch/x86/kernel/dumpstack_32.c b/arch/x86/kernel/dumpstack_32.c
index d7d20999..bb3b5b9 100644
--- a/arch/x86/kernel/dumpstack_32.c
+++ b/arch/x86/kernel/dumpstack_32.c
@@ -16,18 +16,15 @@

#include <asm/stacktrace.h>

-void stack_type_str(enum stack_type type, const char **begin, const char **end)
+const char *stack_type_name(enum stack_type type)
{
- switch (type) {
- case STACK_TYPE_IRQ:
- case STACK_TYPE_SOFTIRQ:
- *begin = "IRQ";
- *end = "EOI";
- break;
- default:
- *begin = NULL;
- *end = NULL;
- }
+ if (type == STACK_TYPE_IRQ)
+ return "IRQ";
+
+ if (type == STACK_TYPE_SOFTIRQ)
+ return "SOFTIRQ";
+
+ return NULL;
}

static bool in_hardirq_stack(unsigned long *stack, struct stack_info *info)
diff --git a/arch/x86/kernel/dumpstack_64.c b/arch/x86/kernel/dumpstack_64.c
index ab0f8b9..fac189e 100644
--- a/arch/x86/kernel/dumpstack_64.c
+++ b/arch/x86/kernel/dumpstack_64.c
@@ -28,23 +28,17 @@ static unsigned long exception_stack_sizes[N_EXCEPTION_STACKS] = {
[DEBUG_STACK - 1] = DEBUG_STKSZ
};

-void stack_type_str(enum stack_type type, const char **begin, const char **end)
+const char *stack_type_name(enum stack_type type)
{
BUILD_BUG_ON(N_EXCEPTION_STACKS != 4);

- switch (type) {
- case STACK_TYPE_IRQ:
- *begin = "IRQ";
- *end = "EOI";
- break;
- case STACK_TYPE_EXCEPTION ... STACK_TYPE_EXCEPTION_LAST:
- *begin = exception_stack_names[type - STACK_TYPE_EXCEPTION];
- *end = "EOE";
- break;
- default:
- *begin = NULL;
- *end = NULL;
- }
+ if (type == STACK_TYPE_IRQ)
+ return "IRQ";
+
+ if (type >= STACK_TYPE_EXCEPTION && type <= STACK_TYPE_EXCEPTION_LAST)
+ return exception_stack_names[type - STACK_TYPE_EXCEPTION];
+
+ return NULL;
}

static bool in_exception_stack(unsigned long *stack, struct stack_info *info)