diff mbox series

[GIT,PULL] tracing: gfp: Fix regression of GFP flags in trace events 6.13

Message ID 20250118093657.60fe1c2f@gandalf.local.home (mailing list archive)
State New
Headers show
Series [GIT,PULL] tracing: gfp: Fix regression of GFP flags in trace events 6.13 | expand

Commit Message

Steven Rostedt Jan. 18, 2025, 2:36 p.m. UTC
Linus,

Fix regression in GFP output in trace events

It was reported that the GFP flags in trace events went from human
readable to just their hex values:

  gfp_flags=GFP_HIGHUSER_MOVABLE|__GFP_COMP to gfp_flags=0x140cca

This was caused by a change that added the use of enums in calculating
the GFP flags. As defines get translated into their values in the
trace event format files, the user space tooling could easily convert
the GFP flags into their symbols via the __print_flags() helper macro.
The problem is that enums do not get converted, and the names of the
enums show up in the format files and user space tooling cannot translate
them.

Add TRACE_DEFINE_ENUM() around the enums used for GFP flags which is the
tracing infrastructure macro that informs the tracing subsystem what
the values for enums and it can then expose that to user space.


Please pull the latest trace-v6.13-rc7-2 tree, which can be found at:


  git://git.kernel.org/pub/scm/linux/kernel/git/trace/linux-trace.git
trace-v6.13-rc7-2

Tag SHA1: c3b4e29a5e12d9b3cc8df441a52a44cc28f66f5c
Head SHA1: 60295b944ff6805e677c48ae4178532b207d43be


Steven Rostedt (1):
      tracing: gfp: Fix the GFP enum values shown for user space tracing tools

----
 include/trace/events/mmflags.h | 63 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 63 insertions(+)
---------------------------
commit 60295b944ff6805e677c48ae4178532b207d43be
Author: Steven Rostedt <rostedt@goodmis.org>
Date:   Thu Jan 16 16:41:24 2025 -0500

    tracing: gfp: Fix the GFP enum values shown for user space tracing tools
    
    Tracing tools like perf and trace-cmd read the /sys/kernel/tracing/events/*/*/format
    files to know how to parse the data and also how to print it. For the
    "print fmt" portion of that file, if anything uses an enum that is not
    exported to the tracing system, user space will not be able to parse it.
    
    The GFP flags use to be defines, and defines get translated in the print
    fmt sections. But now they are converted to use enums, which is not.
    
    The mm_page_alloc trace event format use to have:
    
      print fmt: "page=%p pfn=0x%lx order=%d migratetype=%d gfp_flags=%s",
        REC->pfn != -1UL ? (((struct page *)vmemmap_base) + (REC->pfn)) : ((void
        *)0), REC->pfn != -1UL ? REC->pfn : 0, REC->order, REC->migratetype,
        (REC->gfp_flags) ? __print_flags(REC->gfp_flags, "|", {( unsigned
        long)(((((((( gfp_t)(0x400u|0x800u)) | (( gfp_t)0x40u) | (( gfp_t)0x80u) |
        (( gfp_t)0x100000u)) | (( gfp_t)0x02u)) | (( gfp_t)0x08u) | (( gfp_t)0)) |
        (( gfp_t)0x40000u) | (( gfp_t)0x80000u) | (( gfp_t)0x2000u)) & ~((
        gfp_t)(0x400u|0x800u))) | (( gfp_t)0x400u)), "GFP_TRANSHUGE"}, {( unsigned
        long)((((((( gfp_t)(0x400u|0x800u)) | (( gfp_t)0x40u) | (( gfp_t)0x80u) |
        (( gfp_t)0x100000u)) | (( gfp_t)0x02u)) | (( gfp_t)0x08u) | (( gfp_t)0)) ...
    
    Where the GFP values are shown and not their names. But after the GFP
    flags were converted to use enums, it has:
    
      print fmt: "page=%p pfn=0x%lx order=%d migratetype=%d gfp_flags=%s",
        REC->pfn != -1UL ? (vmemmap + (REC->pfn)) : ((void *)0), REC->pfn != -1UL
        ? REC->pfn : 0, REC->order, REC->migratetype, (REC->gfp_flags) ?
        __print_flags(REC->gfp_flags, "|", {( unsigned long)((((((((
        gfp_t)(((((1UL))) << (___GFP_DIRECT_RECLAIM_BIT))|((((1UL))) <<
        (___GFP_KSWAPD_RECLAIM_BIT)))) | (( gfp_t)((((1UL))) << (___GFP_IO_BIT)))
        | (( gfp_t)((((1UL))) << (___GFP_FS_BIT))) | (( gfp_t)((((1UL))) <<
        (___GFP_HARDWALL_BIT)))) | (( gfp_t)((((1UL))) << (___GFP_HIGHMEM_BIT))))
        | (( gfp_t)((((1UL))) << (___GFP_MOVABLE_BIT))) | (( gfp_t)0)) | ((
        gfp_t)((((1UL))) << (___GFP_COMP_BIT))) ...
    
    Where the enums names like ___GFP_KSWAPD_RECLAIM_BIT are shown and not their
    values. User space has no way to convert these names to their values and
    the output will fail to parse. What is shown is now:
    
      mm_page_alloc:  page=0xffffffff981685f3 pfn=0x1d1ac1 order=0 migratetype=1 gfp_flags=0x140cca
    
    The TRACE_DEFINE_ENUM() macro was created to handle enums in the print fmt
    files. This causes them to be replaced at boot up with the numbers, so
    that user space tooling can parse it. By using this macro, the output is
    back to the human readable:
    
      mm_page_alloc: page=0xffffffff981685f3 pfn=0x122233 order=0 migratetype=1 gfp_flags=GFP_HIGHUSER_MOVABLE|__GFP_COMP
    
    Cc: stable@vger.kernel.org
    Cc: Masami Hiramatsu <mhiramat@kernel.org>
    Cc: Mark Rutland <mark.rutland@arm.com>
    Cc: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
    Cc: Andrew Morton <akpm@linux-foundation.org>
    Cc: Veronika  Molnarova <vmolnaro@redhat.com>
    Cc: Suren Baghdasaryan <surenb@google.com>
    Cc: Linus Torvalds <torvalds@linux-foundation.org>
    Link: https://lore.kernel.org/20250116214438.749504792@goodmis.org
    Reported-by: Michael Petlan <mpetlan@redhat.com>
    Closes: https://lore.kernel.org/all/87be5f7c-1a0-dad-daa0-54e342efaea7@redhat.com/
    Fixes: 772dd0342727c ("mm: enumerate all gfp flags")
    Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>

Comments

pr-tracker-bot@kernel.org Jan. 18, 2025, 9:34 p.m. UTC | #1
The pull request you sent on Sat, 18 Jan 2025 09:36:57 -0500:

> git://git.kernel.org/pub/scm/linux/kernel/git/trace/linux-trace.git trace-v6.13-rc7-2

has been merged into torvalds/linux.git:
https://git.kernel.org/torvalds/c/fda5e3f284002ea55dac1c98c1498d6dd684046e

Thank you!
diff mbox series

Patch

diff --git a/include/trace/events/mmflags.h b/include/trace/events/mmflags.h
index bb8a59c6caa2..d36c857dd249 100644
--- a/include/trace/events/mmflags.h
+++ b/include/trace/events/mmflags.h
@@ -13,6 +13,69 @@ 
  * Thus most bits set go first.
  */
 
+/* These define the values that are enums (the bits) */
+#define TRACE_GFP_FLAGS_GENERAL			\
+	TRACE_GFP_EM(DMA)			\
+	TRACE_GFP_EM(HIGHMEM)			\
+	TRACE_GFP_EM(DMA32)			\
+	TRACE_GFP_EM(MOVABLE)			\
+	TRACE_GFP_EM(RECLAIMABLE)		\
+	TRACE_GFP_EM(HIGH)			\
+	TRACE_GFP_EM(IO)			\
+	TRACE_GFP_EM(FS)			\
+	TRACE_GFP_EM(ZERO)			\
+	TRACE_GFP_EM(DIRECT_RECLAIM)		\
+	TRACE_GFP_EM(KSWAPD_RECLAIM)		\
+	TRACE_GFP_EM(WRITE)			\
+	TRACE_GFP_EM(NOWARN)			\
+	TRACE_GFP_EM(RETRY_MAYFAIL)		\
+	TRACE_GFP_EM(NOFAIL)			\
+	TRACE_GFP_EM(NORETRY)			\
+	TRACE_GFP_EM(MEMALLOC)			\
+	TRACE_GFP_EM(COMP)			\
+	TRACE_GFP_EM(NOMEMALLOC)		\
+	TRACE_GFP_EM(HARDWALL)			\
+	TRACE_GFP_EM(THISNODE)			\
+	TRACE_GFP_EM(ACCOUNT)			\
+	TRACE_GFP_EM(ZEROTAGS)
+
+#ifdef CONFIG_KASAN_HW_TAGS
+# define TRACE_GFP_FLAGS_KASAN			\
+	TRACE_GFP_EM(SKIP_ZERO)			\
+	TRACE_GFP_EM(SKIP_KASAN)
+#else
+# define TRACE_GFP_FLAGS_KASAN
+#endif
+
+#ifdef CONFIG_LOCKDEP
+# define TRACE_GFP_FLAGS_LOCKDEP		\
+	TRACE_GFP_EM(NOLOCKDEP)
+#else
+# define TRACE_GFP_FLAGS_LOCKDEP
+#endif
+
+#ifdef CONFIG_SLAB_OBJ_EXT
+# define TRACE_GFP_FLAGS_SLAB			\
+	TRACE_GFP_EM(NO_OBJ_EXT)
+#else
+# define TRACE_GFP_FLAGS_SLAB
+#endif
+
+#define TRACE_GFP_FLAGS				\
+	TRACE_GFP_FLAGS_GENERAL			\
+	TRACE_GFP_FLAGS_KASAN			\
+	TRACE_GFP_FLAGS_LOCKDEP			\
+	TRACE_GFP_FLAGS_SLAB
+
+#undef TRACE_GFP_EM
+#define TRACE_GFP_EM(a) TRACE_DEFINE_ENUM(___GFP_##a##_BIT);
+
+TRACE_GFP_FLAGS
+
+/* Just in case these are ever used */
+TRACE_DEFINE_ENUM(___GFP_UNUSED_BIT);
+TRACE_DEFINE_ENUM(___GFP_LAST_BIT);
+
 #define gfpflag_string(flag) {(__force unsigned long)flag, #flag}
 
 #define __def_gfpflag_names			\