Skip to contentSkip to conversation

tracing: use %ps format string to print symbols

PATCH Superseded Arnd Bergmann 2 participants 3 messages Oct 15, 2021 Tracing

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 tracing: use %ps format string to print symbols

From: Arnd Bergmann <[email protected]>

clang started warning about excessive stack usage in hist_trigger_print_key()

kernel/trace/trace_events_hist.c:4723:13: error: stack frame size (1336) exceeds limit (1024) in function 'hist_trigger_print_key' [-Werror,-Wframe-larger-than]

The problem is that there are two 512-byte arrays on the stack if hist_trigger_stacktrace_print() gets inlined. I don't think this has changed in the past five years, but something probably changed the inlining decisions made by the compiler, so the problem is now made more obvious.

Rather than printing the symbol names into separate buffers, it seems we can simply use the special %ps format string modifier to print the pointers symbolically and get rid of both buffers.

Fixes 69a0200c2e25 ("tracing: Add hist trigger support for stacktraces as keys")

---
I'm not sure if the %ps format string actually works as intended with the explicit length modifier, it would be good if someone could try this out before applying. Would it be ok to remove the length modifier otherwise?

---
 kernel/trace/trace_events_hist.c | 15 +++++----------
 1 file changed, 5 insertions(+), 10 deletions(-)
kernel/trace/trace_events_hist.c +5 -10
index a6061a69aa84..640c79898b51 100644
@@ -4706,7 +4706,6 @@ static void hist_trigger_stacktrace_print(struct seq_file *m,
 					  unsigned long *stacktrace_entries,
 					  unsigned int max_entries)
 {
-	char str[KSYM_SYMBOL_LEN];
 	unsigned int spaces = 8;
 	unsigned int i;
 
@@ -4715,8 +4714,7 @@ static void hist_trigger_stacktrace_print(struct seq_file *m,
 			return;
 
 		seq_printf(m, "%*c", 1 + spaces, ' ');
-		sprint_symbol(str, stacktrace_entries[i]);
-		seq_printf(m, "%s\n", str);
+		seq_printf(m, "%pS\n", stacktrace_entries[i]);
 	}
 }
 
@@ -4726,7 +4724,6 @@ static void hist_trigger_print_key(struct seq_file *m,
 				   struct tracing_map_elt *elt)
 {
 	struct hist_field *key_field;
-	char str[KSYM_SYMBOL_LEN];
 	bool multiline = false;
 	const char *field_name;
 	unsigned int i;
@@ -4747,14 +4744,12 @@ static void hist_trigger_print_key(struct seq_file *m,
 			seq_printf(m, "%s: %llx", field_name, uval);
 		} else if (key_field->flags & HIST_FIELD_FL_SYM) {
 			uval = *(u64 *)(key + key_field->offset);
-			sprint_symbol_no_offset(str, uval);
-			seq_printf(m, "%s: [%llx] %-45s", field_name,
-				   uval, str);
+			seq_printf(m, "%s: [%llx] %-45ps", field_name,
+				   uval, (void *)uval);
 		} else if (key_field->flags & HIST_FIELD_FL_SYM_OFFSET) {
 			uval = *(u64 *)(key + key_field->offset);
-			sprint_symbol(str, uval);
-			seq_printf(m, "%s: [%llx] %-55s", field_name,
-				   uval, str);
+			seq_printf(m, "%s: [%llx] %-55ps", field_name,
+				   uval, (void *)uval);
 		} else if (key_field->flags & HIST_FIELD_FL_EXECNAME) {
 			struct hist_elt_data *elt_data = elt->private_data;
 			char *comm;
Signature · 1 line
2.29.2
maintainer
#1 lore raw
Quoted 5 lines · On Fri, 15 Oct 2021 10:34:31 +0200 Arnd Bergmann <[email protected]> wrote:

From: Arnd Bergmann <[email protected]>

clang started warning about excessive stack usage in hist_trigger_print_key()

Quoted 7 lines

kernel/trace/trace_events_hist.c:4723:13: error: stack frame size (1336) exceeds limit (1024) in function 'hist_trigger_print_key' [-Werror,-Wframe-larger-than]

The problem is that there are two 512-byte arrays on the stack if hist_trigger_stacktrace_print() gets inlined. I don't think this has changed in the past five years, but something probably changed the inlining decisions made by the compiler, so the problem is now made more obvious.

Could we just add "noinline" attribute to that function?

Quoted 5 lines

Rather than printing the symbol names into separate buffers, it seems we can simply use the special %ps format string modifier to print the pointers symbolically and get rid of both buffers.

Quoted 7 lines
Fixes 69a0200c2e25 ("tracing: Add hist trigger support for stacktraces as keys")

---
I'm not sure if the %ps format string actually works as intended with the explicit length modifier, it would be good if someone could try this out before applying. Would it be ok to remove the length modifier otherwise?

I believe that shows a "table" format. So the length modifier is required.

Quoted 40 lines
---
 kernel/trace/trace_events_hist.c | 15 +++++----------
 1 file changed, 5 insertions(+), 10 deletions(-)
kernel/trace/trace_events_hist.c +1 -6
index a6061a69aa84..640c79898b51 100644
@@ -4706,7 +4706,6 @@ static void hist_trigger_stacktrace_print(struct seq_file *m,
 					  unsigned long *stacktrace_entries,
 					  unsigned int max_entries)
 {
-	char str[KSYM_SYMBOL_LEN];
 	unsigned int spaces = 8;
 	unsigned int i;
 
@@ -4715,8 +4714,7 @@ static void hist_trigger_stacktrace_print(struct seq_file *m,
 			return;
 
 		seq_printf(m, "%*c", 1 + spaces, ' ');
-		sprint_symbol(str, stacktrace_entries[i]);
-		seq_printf(m, "%s\n", str);
+		seq_printf(m, "%pS\n", stacktrace_entries[i]);
 	}
 }
 
@@ -4726,7 +4724,6 @@ static void hist_trigger_print_key(struct seq_file *m,
 				   struct tracing_map_elt *elt)
 {
 	struct hist_field *key_field;
-	char str[KSYM_SYMBOL_LEN];
 	bool multiline = false;
 	const char *field_name;
 	unsigned int i;
@@ -4747,14 +4744,12 @@ static void hist_trigger_print_key(struct seq_file *m,
 			seq_printf(m, "%s: %llx", field_name, uval);
 		} else if (key_field->flags & HIST_FIELD_FL_SYM) {
 			uval = *(u64 *)(key + key_field->offset);
-			sprint_symbol_no_offset(str, uval);
-			seq_printf(m, "%s: [%llx] %-45s", field_name,

kernel/trace/trace_events_hist.c static void hist_trigger_print_key(struct seq_file *m, · line 4752

Quoted 10 lines
kernel/trace/trace_events_hist.c +4 -4
-				   uval, str);
+			seq_printf(m, "%s: [%llx] %-45ps", field_name,
+				   uval, (void *)uval);
 		} else if (key_field->flags & HIST_FIELD_FL_SYM_OFFSET) {
 			uval = *(u64 *)(key + key_field->offset);
-			sprint_symbol(str, uval);
-			seq_printf(m, "%s: [%llx] %-55s", field_name,
-				   uval, str);
+			seq_printf(m, "%s: [%llx] %-55ps", field_name,
+				   uval, (void *)uval);

The above requires "Ps" not "ps".

But other than that, I could test if this doesn't change the formatting and functionality at all.

-- Steve

Quoted 3 lines
kernel/trace/trace_events_hist.c +0 -0
 		} else if (key_field->flags & HIST_FIELD_FL_EXECNAME) {
 			struct hist_elt_data *elt_data = elt->private_data;
 			char *comm;
#2 lore raw
Quoted 11 lines · Steven Rostedt
Quoted 7 lines · On Fri, 15 Oct 2021 10:34:31 +0200 Arnd Bergmann <[email protected]> wrote:

From: Arnd Bergmann <[email protected]>

clang started warning about excessive stack usage in hist_trigger_print_key()

kernel/trace/trace_events_hist.c:4723:13: error: stack frame size (1336) exceeds limit (1024) in function 'hist_trigger_print_key' [-Werror,-Wframe-larger-than]

Quoted 7 lines
Quoted 5 lines

The problem is that there are two 512-byte arrays on the stack if hist_trigger_stacktrace_print() gets inlined. I don't think this has changed in the past five years, but something probably changed the inlining decisions made by the compiler, so the problem is now made more obvious.

Could we just add "noinline" attribute to that function?

It would avoid the warning, but not reduce the overall stack usage. If that's good enough for you, I'm fine with that as well.

Quoted 7 lines

kernel/trace/trace_events_hist.c static void hist_trigger_stacktrace_print(struct seq_file *m, · line 4717

Quoted 7 lines
kernel/trace/trace_events_hist.c +1 -2
@@ -4715,8 +4714,7 @@ static void hist_trigger_stacktrace_print(struct seq_file *m,
                      return;
 
              seq_printf(m, "%*c", 1 + spaces, ' ');
-             sprint_symbol(str, stacktrace_entries[i]);
-             seq_printf(m, "%s\n", str);
+             seq_printf(m, "%pS\n", stacktrace_entries[i]);

I just noticed this needs an extra cast to (void*) to avoid a warning with clang,
not sure why I saw it build cleanly before.

Quoted 10 lines
Quoted 10 lines
kernel/trace/trace_events_hist.c +2 -3
@@ -4747,14 +4744,12 @@ static void hist_trigger_print_key(struct seq_file *m,
                      seq_printf(m, "%s: %llx", field_name, uval);
              } else if (key_field->flags & HIST_FIELD_FL_SYM) {
                      uval = *(u64 *)(key + key_field->offset);
-                     sprint_symbol_no_offset(str, uval);
-                     seq_printf(m, "%s: [%llx] %-45s", field_name,
-                                uval, str);
+                     seq_printf(m, "%s: [%llx] %-45ps", field_name,
+                                uval, (void *)uval);
              } else if (key_field->flags & HIST_FIELD_FL_SYM_OFFSET) {
Quoted 8 lines

kernel/trace/trace_events_hist.c static void hist_trigger_print_key(struct seq_file *m, · line 4752

Quoted 6 lines
kernel/trace/trace_events_hist.c +2 -3
                      uval = *(u64 *)(key + key_field->offset);
-                     sprint_symbol(str, uval);
-                     seq_printf(m, "%s: [%llx] %-55s", field_name,
-                                uval, str);
+                     seq_printf(m, "%s: [%llx] %-55ps", field_name,
+                                uval, (void *)uval);

The above requires "Ps" not "ps".

you mean "%-55pS", right?

Quoted 2 lines

But other than that, I could test if this doesn't change the formatting and functionality at all.

Ok, let me know if I should resend with the two small changes I mentioned, or if you want to just go with the 'noinline_for_stack' annotation.

Arnd