Skip to contentSkip to conversation

timers: Make flags output in the timer_start tracepoint useful

PATCH Applied Thomas Gleixner 2 participants 7 messages Feb 10, 2017

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

The timer flags in the timer_start trace event contain lots of useful information, but the meaning is not clear in the trace output because its just printed as a hex value. Making tools rely on the bit positions is bad as they might change over time.

Decode the flags in the printout. Tools can retrieve the bits and their meaning from the trace format file.

Example output:
kworker/2:1-47 <SNIP> [timeout=592] cpu=2 idx=170 flags=D|I

So the timer is Deferrable and Interruptsafe, queued on CPU 2 into bucket 170.

---
 include/trace/events/timer.h |   14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)
include/trace/events/timer.h +12 -2
@@ -36,6 +36,13 @@ DEFINE_EVENT(timer_class, timer_init,
 	TP_ARGS(timer)
 );
 
+#define decode_timer_flags(flags)			\
+	__print_flags(flags, "|",			\
+		{  TIMER_MIGRATING,	"M" },		\
+		{  TIMER_DEFERRABLE,	"D" },		\
+		{  TIMER_PINNED,	"P" },		\
+		{  TIMER_IRQSAFE,	"I" })
+
 /**
  * timer_start - called when the timer is started
  * @timer:	pointer to struct timer_list
@@ -65,9 +72,12 @@ TRACE_EVENT(timer_start,
 		__entry->flags		= flags;
 	),
 
-	TP_printk("timer=%p function=%pf expires=%lu [timeout=%ld] flags=0x%08x",
+	TP_printk("timer=%p function=%pf expires=%lu [timeout=%ld] cpu=%u idx=%u flags=%s",
 		  __entry->timer, __entry->function, __entry->expires,
-		  (long)__entry->expires - __entry->now, __entry->flags)
+		  (long)__entry->expires - __entry->now,
+		  __entry->flags & TIMER_CPUMASK,
+		  __entry->flags >> TIMER_ARRAYSHIFT,
+		  decode_timer_flags(__entry->flags & TIMER_TRACE_FLAGMASK))
 );
 
 /**
maintainer
#1 lore raw
Quoted 38 lines · On Fri, 10 Feb 2017 14:25:03 +0100 (CET) Thomas Gleixner <[email protected]>…

The timer flags in the timer_start trace event contain lots of useful information, but the meaning is not clear in the trace output because its just printed as a hex value. Making tools rely on the bit positions is bad as they might change over time.

Decode the flags in the printout. Tools can retrieve the bits and their meaning from the trace format file.

Example output:
kworker/2:1-47 <SNIP> [timeout=592] cpu=2 idx=170 flags=D|I

So the timer is Deferrable and Interruptsafe, queued on CPU 2 into bucket 170.

---
 include/trace/events/timer.h |   14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)
include/trace/events/timer.h +7 -0
@@ -36,6 +36,13 @@ DEFINE_EVENT(timer_class, timer_init,
 	TP_ARGS(timer)
 );
 
+#define decode_timer_flags(flags)			\
+	__print_flags(flags, "|",			\
+		{  TIMER_MIGRATING,	"M" },		\
+		{  TIMER_DEFERRABLE,	"D" },		\
+		{  TIMER_PINNED,	"P" },		\
+		{  TIMER_IRQSAFE,	"I" })
+
 /**
  * timer_start - called when the timer is started
  * @timer:	pointer to struct timer_list
@@ -65,9 +72,12 @@ TRACE_EVENT(timer_start,
 		__entry->flags		= flags;

include/trace/events/timer.h TRACE_EVENT(timer_start, · line 80

Quoted 10 lines
include/trace/events/timer.h +5 -2
 	),
 
-	TP_printk("timer=%p function=%pf expires=%lu [timeout=%ld] flags=0x%08x",
+	TP_printk("timer=%p function=%pf expires=%lu [timeout=%ld] cpu=%u idx=%u flags=%s",
 		  __entry->timer, __entry->function, __entry->expires,
-		  (long)__entry->expires - __entry->now, __entry->flags)
+		  (long)__entry->expires - __entry->now,
+		  __entry->flags & TIMER_CPUMASK,
+		  __entry->flags >> TIMER_ARRAYSHIFT,
+		  decode_timer_flags(__entry->flags & TIMER_TRACE_FLAGMASK))

Hi Thomas,

This all looks good, but I can't find TIMER_TRACE_FLAGMASK. Was that added by another patch?

-- Steve

Quoted 3 lines
include/trace/events/timer.h +0 -0
 );
 
 /**
#2 lore raw
Quoted 54 lines · Steven Rostedt
Quoted 38 lines · On Fri, 10 Feb 2017 14:25:03 +0100 (CET) Thomas Gleixner <[email protected]>…

The timer flags in the timer_start trace event contain lots of useful information, but the meaning is not clear in the trace output because its just printed as a hex value. Making tools rely on the bit positions is bad as they might change over time.

Decode the flags in the printout. Tools can retrieve the bits and their meaning from the trace format file.

Example output:
kworker/2:1-47 <SNIP> [timeout=592] cpu=2 idx=170 flags=D|I

So the timer is Deferrable and Interruptsafe, queued on CPU 2 into bucket 170.

---
 include/trace/events/timer.h |   14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)
include/trace/events/timer.h +7 -0
@@ -36,6 +36,13 @@ DEFINE_EVENT(timer_class, timer_init,
 	TP_ARGS(timer)
 );
 
+#define decode_timer_flags(flags)			\
+	__print_flags(flags, "|",			\
+		{  TIMER_MIGRATING,	"M" },		\
+		{  TIMER_DEFERRABLE,	"D" },		\
+		{  TIMER_PINNED,	"P" },		\
+		{  TIMER_IRQSAFE,	"I" })
+
 /**
  * timer_start - called when the timer is started
  * @timer:	pointer to struct timer_list
@@ -65,9 +72,12 @@ TRACE_EVENT(timer_start,
 		__entry->flags		= flags;

include/trace/events/timer.h TRACE_EVENT(timer_start, · line 80

Quoted 10 lines
include/trace/events/timer.h +5 -2
 	),
 
-	TP_printk("timer=%p function=%pf expires=%lu [timeout=%ld] flags=0x%08x",
+	TP_printk("timer=%p function=%pf expires=%lu [timeout=%ld] cpu=%u idx=%u flags=%s",
 		  __entry->timer, __entry->function, __entry->expires,
-		  (long)__entry->expires - __entry->now, __entry->flags)
+		  (long)__entry->expires - __entry->now,
+		  __entry->flags & TIMER_CPUMASK,
+		  __entry->flags >> TIMER_ARRAYSHIFT,
+		  decode_timer_flags(__entry->flags & TIMER_TRACE_FLAGMASK))

Hi Thomas,

Quoted 2 lines

This all looks good, but I can't find TIMER_TRACE_FLAGMASK. Was that added by another patch?

-ENO_QUILT_REFRESH ....

maintainer
#3 lore raw
Quoted 31 lines · On Fri, 10 Feb 2017 15:37:11 +0100 (CET) Thomas Gleixner <[email protected]>…
Quoted 31 lines
Quoted 18 lines
include/trace/events/timer.h +7 -0
@@ -36,6 +36,13 @@ DEFINE_EVENT(timer_class, timer_init,
 	TP_ARGS(timer)
 );
 
+#define decode_timer_flags(flags)			\
+	__print_flags(flags, "|",			\
+		{  TIMER_MIGRATING,	"M" },		\
+		{  TIMER_DEFERRABLE,	"D" },		\
+		{  TIMER_PINNED,	"P" },		\
+		{  TIMER_IRQSAFE,	"I" })
+
 /**
  * timer_start - called when the timer is started
  * @timer:	pointer to struct timer_list
@@ -65,9 +72,12 @@ TRACE_EVENT(timer_start,
 		__entry->flags		= flags;

include/trace/events/timer.h TRACE_EVENT(timer_start, · line 80

Quoted 10 lines
include/trace/events/timer.h +5 -2
 	),
 
-	TP_printk("timer=%p function=%pf expires=%lu [timeout=%ld] flags=0x%08x",
+	TP_printk("timer=%p function=%pf expires=%lu [timeout=%ld] cpu=%u idx=%u flags=%s",
 		  __entry->timer, __entry->function, __entry->expires,
-		  (long)__entry->expires - __entry->now, __entry->flags)
+		  (long)__entry->expires - __entry->now,
+		  __entry->flags & TIMER_CPUMASK,
+		  __entry->flags >> TIMER_ARRAYSHIFT,
+		  decode_timer_flags(__entry->flags & TIMER_TRACE_FLAGMASK))  

Hi Thomas,

Quoted 4 lines
Quoted 2 lines

This all looks good, but I can't find TIMER_TRACE_FLAGMASK. Was that added by another patch?

-ENO_QUILT_REFRESH ....

I'm wondering if it wouldn't just make sense to add another mask in include/linux/timer.h along with the other TIMER macros?

#define TIMER_TYPEMASK 0x003C0000

Or some other name?

-- Steve

#4 lore raw
Quoted 34 lines · Steven Rostedt
Quoted 31 lines · On Fri, 10 Feb 2017 15:37:11 +0100 (CET) Thomas Gleixner <[email protected]>…
Quoted 31 lines
Quoted 18 lines
include/trace/events/timer.h +7 -0
@@ -36,6 +36,13 @@ DEFINE_EVENT(timer_class, timer_init,
 	TP_ARGS(timer)
 );
 
+#define decode_timer_flags(flags)			\
+	__print_flags(flags, "|",			\
+		{  TIMER_MIGRATING,	"M" },		\
+		{  TIMER_DEFERRABLE,	"D" },		\
+		{  TIMER_PINNED,	"P" },		\
+		{  TIMER_IRQSAFE,	"I" })
+
 /**
  * timer_start - called when the timer is started
  * @timer:	pointer to struct timer_list
@@ -65,9 +72,12 @@ TRACE_EVENT(timer_start,
 		__entry->flags		= flags;

include/trace/events/timer.h TRACE_EVENT(timer_start, · line 80

Quoted 10 lines
include/trace/events/timer.h +5 -2
 	),
 
-	TP_printk("timer=%p function=%pf expires=%lu [timeout=%ld] flags=0x%08x",
+	TP_printk("timer=%p function=%pf expires=%lu [timeout=%ld] cpu=%u idx=%u flags=%s",
 		  __entry->timer, __entry->function, __entry->expires,
-		  (long)__entry->expires - __entry->now, __entry->flags)
+		  (long)__entry->expires - __entry->now,
+		  __entry->flags & TIMER_CPUMASK,
+		  __entry->flags >> TIMER_ARRAYSHIFT,
+		  decode_timer_flags(__entry->flags & TIMER_TRACE_FLAGMASK))  

Hi Thomas,

Quoted 7 lines
Quoted 4 lines
Quoted 2 lines

This all looks good, but I can't find TIMER_TRACE_FLAGMASK. Was that added by another patch?

-ENO_QUILT_REFRESH ....

I'm wondering if it wouldn't just make sense to add another mask in include/linux/timer.h along with the other TIMER macros?

That's the missing hunk from timer.h which I did not refresh after testing it ....

include/linux/timer.h +2 -0
@@ -66,6 +66,8 @@ struct timer_list {
 #define TIMER_ARRAYSHIFT       22
 #define TIMER_ARRAYMASK                0xFFC00000
 
+#define TIMER_TRACE_FLAGMASK   (TIMER_MIGRATING | TIMER_DEFERRABLE | TIMER_PINNED | TIMER_IRQSAFE)
+
 #define __TIMER_INITIALIZER(_function, _expires, _data, _flags) { \
                .entry = { .next = TIMER_ENTRY_STATIC },        \
                .function = (_function),                        \
#5 lore raw

PATCH v2 1/1 timers: Make flags output in the timer_start tracepoint useful

The timer flags in the timer_start trace event contain lots of useful information, but the meaning is not clear in the trace output. Making tools rely on the bit positions is bad as they might change over time.

Decode the flags in the print out. Tools can retrieve the bits and their meaning from the trace format file.

---
V2: Add the missing hunk defining the mask in timer.h

---
 include/linux/timer.h        |    2 ++
 include/trace/events/timer.h |   14 ++++++++++++--
 2 files changed, 14 insertions(+), 2 deletions(-)
include/linux/timer.h +2 -0
@@ -66,6 +66,8 @@ struct timer_list {
 #define TIMER_ARRAYSHIFT	22
 #define TIMER_ARRAYMASK		0xFFC00000
 
+#define TIMER_TRACE_FLAGMASK	(TIMER_MIGRATING | TIMER_DEFERRABLE | TIMER_PINNED | TIMER_IRQSAFE)
+
 #define __TIMER_INITIALIZER(_function, _expires, _data, _flags) { \
 		.entry = { .next = TIMER_ENTRY_STATIC },	\
 		.function = (_function),			\
include/trace/events/timer.h +12 -2
@@ -36,6 +36,13 @@ DEFINE_EVENT(timer_class, timer_init,
 	TP_ARGS(timer)
 );
 
+#define decode_timer_flags(flags)			\
+	__print_flags(flags, "|",			\
+		{  TIMER_MIGRATING,	"M" },		\
+		{  TIMER_DEFERRABLE,	"D" },		\
+		{  TIMER_PINNED,	"P" },		\
+		{  TIMER_IRQSAFE,	"I" })
+
 /**
  * timer_start - called when the timer is started
  * @timer:	pointer to struct timer_list
@@ -65,9 +72,12 @@ TRACE_EVENT(timer_start,
 		__entry->flags		= flags;
 	),
 
-	TP_printk("timer=%p function=%pf expires=%lu [timeout=%ld] flags=0x%08x",
+	TP_printk("timer=%p function=%pf expires=%lu [timeout=%ld] cpu=%u idx=%u flags=%s",
 		  __entry->timer, __entry->function, __entry->expires,
-		  (long)__entry->expires - __entry->now, __entry->flags)
+		  (long)__entry->expires - __entry->now,
+		  __entry->flags & TIMER_CPUMASK,
+		  __entry->flags >> TIMER_ARRAYSHIFT,
+		  decode_timer_flags(__entry->flags & TIMER_TRACE_FLAGMASK))
 );
 
 /**
maintainer Applied
#6 lore raw
Quoted 4 lines · On Fri, 10 Feb 2017 16:41:15 +0100 (CET) Thomas Gleixner <[email protected]>…

The timer flags in the timer_start trace event contain lots of useful information, but the meaning is not clear in the trace output. Making tools rely on the bit positions is bad as they might change over time.

Quoted 8 lines

Decode the flags in the print out. Tools can retrieve the bits and their meaning from the trace format file.

---
V2: Add the missing hunk defining the mask in timer.h
---

Applied, Thanks!

-- Steve