mm, printk: introduce new format for page_type
Subsystems (6)
v4 cover mm, printk: introduce new format for page_type
RFC v3:
https://lore.kernel.org/lkml/[email protected]
This series was originally part of "move PG_slab to page_type" series, but printk format implementation for page_type is separated to this series.
RFC v3 -> v4:
- dropped patch 1 ("mm/hwpoison: remove MF_MSG_SLAB from action_page_types") and patch 2 ("mm: move PG_slab flag to page_type") from previous spin as they are planned as separate series
- adjusted comments from Andy Shevchenko [1] and Petr Mladek [2]
- added patch 1 ("mmflags.h: use less error prone method to define pageflag_names") for consistency with patch 2 ("mm, printk: introduce new format %pGt for page_type"), as suggested by Andy Shevchenko [1]
[1] https://lore.kernel.org/lkml/[email protected]/
[2] https://lore.kernel.org/lkml/Y6HSutM8pmoKxQWp@alley/
Based on mm-unstable (ede43f2956cc "kasan: fix Oops due to missing calls to kasan_arch_is_rea()") as there are recent changes in mmflags.h.
Hyeonggon Yoo (3):
mmflags.h: use less error prone method to define pageflag_names mm, printk: introduce new format %pGt for page_type mm/debug: use %pGt to display page_type in dump_page()
Documentation/core-api/printk-formats.rst | 16 ++-- include/linux/page-flags.h | 7 +- include/trace/events/mmflags.h | 93 +++++++++++++---------- lib/test_printf.c | 26 +++++++ lib/vsprintf.c | 21 +++++ mm/debug.c | 7 ++ mm/internal.h | 1 + 7 files changed, 124 insertions(+), 47 deletions(-)
Signature · 1 line
2.39.1
PATCH v4 1/3 mmflags.h: use less error prone method to define pageflag_names
As suggested by Andy Shevchenko, use helper macro to decrease chances of typo when defining pageflag_names.
--- include/trace/events/mmflags.h | 85 ++++++++++++++++++---------------- 1 file changed, 44 insertions(+), 41 deletions(-)
include/trace/events/mmflags.h +44 -41
@@ -67,71 +67,74 @@ ) : "none"#ifdef CONFIG_MMU -#define IF_HAVE_PG_MLOCK (flag,string) ,{1UL << flag, string} +#define IF_HAVE_PG_MLOCK (_name) ,{1UL << PG_##_name, __stringify(_name)}#else -#define IF_HAVE_PG_MLOCK (flag,string) +#define IF_HAVE_PG_MLOCK (_name)#endif #ifdef CONFIG_ARCH_USES_PG_UNCACHED -#define IF_HAVE_PG_UNCACHED (flag,string) ,{1UL << flag, string} +#define IF_HAVE_PG_UNCACHED (_name) ,{1UL << PG_##_name, __stringify(_name)}#else -#define IF_HAVE_PG_UNCACHED (flag,string) +#define IF_HAVE_PG_UNCACHED (_name)#endif #ifdef CONFIG_MEMORY_FAILURE -#define IF_HAVE_PG_HWPOISON (flag,string) ,{1UL << flag, string} +#define IF_HAVE_PG_HWPOISON (_name) ,{1UL << PG_##_name, __stringify(_name)}#else -#define IF_HAVE_PG_HWPOISON (flag,string) +#define IF_HAVE_PG_HWPOISON (_name)#endif #if defined(CONFIG_PAGE_IDLE_FLAG ) && defined(CONFIG_64BIT ) -#define IF_HAVE_PG_IDLE (flag,string) ,{1UL << flag, string} +#define IF_HAVE_PG_IDLE (_name) ,{1UL << PG_##_name, __stringify(_name)}#else -#define IF_HAVE_PG_IDLE (flag,string) +#define IF_HAVE_PG_IDLE (_name)#endif #ifdef CONFIG_ARCH_USES_PG_ARCH_X -#define IF_HAVE_PG_ARCH_X (flag,string) ,{1UL << flag, string} +#define IF_HAVE_PG_ARCH_X (_name) ,{1UL << PG_##_name, __stringify(_name)}#else -#define IF_HAVE_PG_ARCH_X (flag,string) +#define IF_HAVE_PG_ARCH_X (_name)#endif #ifdef CONFIG_KASAN_HW_TAGS -#define IF_HAVE_PG_SKIP_KASAN_POISON (flag,string) ,{1UL << flag, string} +#define IF_HAVE_PG_SKIP_KASAN_POISON (_name) \ + ,{1UL << PG_##_name, __stringify(_name)}#else -#define IF_HAVE_PG_SKIP_KASAN_POISON (flag,string) +#define IF_HAVE_PG_SKIP_KASAN_POISON (_name)#endif +#define DEF_PAGEFLAG_NAME (_name) { 1UL << PG_##_name, __stringify(_name) } +#define __def_pageflag_names \ - {1UL << PG_locked, "locked" }, \ - {1UL << PG_waiters, "waiters" }, \ - {1UL << PG_error, "error" }, \ - {1UL << PG_referenced, "referenced" }, \ - {1UL << PG_uptodate, "uptodate" }, \ - {1UL << PG_dirty, "dirty" }, \ - {1UL << PG_lru, "lru" }, \ - {1UL << PG_active, "active" }, \ - {1UL << PG_workingset, "workingset" }, \ - {1UL << PG_slab, "slab" }, \ - {1UL << PG_owner_priv_1, "owner_priv_1" }, \ - {1UL << PG_arch_1, "arch_1" }, \ - {1UL << PG_reserved, "reserved" }, \ - {1UL << PG_private, "private" }, \ - {1UL << PG_private_2, "private_2" }, \ - {1UL << PG_writeback, "writeback" }, \ - {1UL << PG_head, "head" }, \ - {1UL << PG_mappedtodisk, "mappedtodisk" }, \ - {1UL << PG_reclaim, "reclaim" }, \ - {1UL << PG_swapbacked, "swapbacked" }, \ - {1UL << PG_unevictable, "unevictable" } \ -IF_HAVE_PG_MLOCK(PG_mlocked, "mlocked" ) \ -IF_HAVE_PG_UNCACHED(PG_uncached, "uncached" ) \ -IF_HAVE_PG_HWPOISON(PG_hwpoison, "hwpoison" ) \ -IF_HAVE_PG_IDLE(PG_young, "young" ) \ -IF_HAVE_PG_IDLE(PG_idle, "idle" ) \ -IF_HAVE_PG_ARCH_X(PG_arch_2, "arch_2" ) \ -IF_HAVE_PG_ARCH_X(PG_arch_3, "arch_3" ) \ -IF_HAVE_PG_SKIP_KASAN_POISON(PG_skip_kasan_poison, "skip_kasan_poison") + DEF_PAGEFLAG_NAME(locked), \ + DEF_PAGEFLAG_NAME(waiters), \ + DEF_PAGEFLAG_NAME(error), \ + DEF_PAGEFLAG_NAME(referenced), \ + DEF_PAGEFLAG_NAME(uptodate), \ + DEF_PAGEFLAG_NAME(dirty), \ + DEF_PAGEFLAG_NAME(lru), \ + DEF_PAGEFLAG_NAME(active), \ + DEF_PAGEFLAG_NAME(workingset), \ + DEF_PAGEFLAG_NAME(slab), \ + DEF_PAGEFLAG_NAME(owner_priv_1), \ + DEF_PAGEFLAG_NAME(arch_1), \ + DEF_PAGEFLAG_NAME(reserved), \ + DEF_PAGEFLAG_NAME(private), \ + DEF_PAGEFLAG_NAME(private_2), \ + DEF_PAGEFLAG_NAME(writeback), \ + DEF_PAGEFLAG_NAME(head), \ + DEF_PAGEFLAG_NAME(mappedtodisk), \ + DEF_PAGEFLAG_NAME(reclaim), \ + DEF_PAGEFLAG_NAME(swapbacked), \ + DEF_PAGEFLAG_NAME(unevictable) \ +IF_HAVE_PG_MLOCK(mlocked) \ +IF_HAVE_PG_UNCACHED(uncached) \ +IF_HAVE_PG_HWPOISON(hwpoison) \ +IF_HAVE_PG_IDLE(idle) \ +IF_HAVE_PG_IDLE(young) \ +IF_HAVE_PG_ARCH_X(arch_2) \ +IF_HAVE_PG_ARCH_X(arch_3) \ +IF_HAVE_PG_SKIP_KASAN_POISON(skip_kasan_poison)#define show_page_flags (flags) \ (flags) ? __print_flags(flags, "|", \
Signature · 1 line
2.39.1
Re: [PATCH mm-unstable v4 1/3] mmflags.h: use less error prone method to define pageflag_names
Quoted 2 lines · Hyeonggon Yoo
As suggested by Andy Shevchenko, use helper macro to decrease chances of typo when defining
pageflag_names.
Quoted 2 lines
LGTM, thank you!
Signature · 2 lines
With Best Regards, Andy Shevchenko
Re: [PATCH mm-unstable v4 1/3] mmflags.h: use less error prone method to define pageflag_names
Quoted 5 lines · Andy Shevchenko
Quoted 2 lines · Hyeonggon Yoo
As suggested by Andy Shevchenko, use helper macro to decrease chances of typo when defining
pageflag_names.Suggested-by ? :-)
oh, yeah I only wrote in changelog forgot to add the tag. I think Andrew will kindly add that when picking this series up?
Quoted 5 lines
Quoted 2 lines
LGTM, thank you!
Reviewed-by Andy Shevchenko <[email protected]>
Thank you a lot!
Quoted 3 lines
Signature · 2 lines
With Best Regards, Andy Shevchenko
Best Regards,
Hyeonggon
Andrew Morton
maintainerRe: [PATCH mm-unstable v4 1/3] mmflags.h: use less error prone method to define pageflag_names
Quoted 9 lines · On Tue, 31 Jan 2023 17:38:02 +0900 Hyeonggon Yoo <[email protected]> wrote:
Quoted 5 lines · Andy Shevchenko
Quoted 2 lines · Hyeonggon Yoo
As suggested by Andy Shevchenko, use helper macro to decrease chances of typo when defining
pageflag_names.Suggested-by ? :-)oh, yeah I only wrote in changelog forgot to add the tag. I think Andrew will kindly add that when picking this series up?
Sure.
We're at -rc6 so I'm slowing down on the features and cleanups. I'll probably park this series for the next -rc cycle.
Re: [PATCH mm-unstable v4 1/3] mmflags.h: use less error prone method to define pageflag_names
Quoted 7 lines · Andrew Morton
Quoted 5 lines · On Tue, 31 Jan 2023 17:38:02 +0900 Hyeonggon Yoo <[email protected]> wrote:
Quoted 4 lines · Andy Shevchenko
Quoted 2 lines · Hyeonggon Yoo
As suggested by Andy Shevchenko, use helper macro to decrease chances of typo when defining
pageflag_names.
Quoted 6 lines
Quoted 4 lines
Quoted 1 line
Suggested-by ? :-)oh, yeah I only wrote in changelog forgot to add the tag. I think Andrew will kindly add that when picking this series up?
Sure.
Thanks ;)
Quoted 2 lines
We're at -rc6 so I'm slowing down on the features and cleanups. I'll probably park this series for the next -rc cycle.
No problem!
PATCH v4 2/3 mm, printk: introduce new format %pGt for page_type
In reply to Hyeonggon Yoo%pGp format is used to display 'flags' field of a struct page. However, some page flags (i.e. PG_buddy, see page-flags.h for more details) are stored in page_type field. To display human-readable output of page_type, introduce %pGt format.
It is important to note the meaning of bits are different in page_type. if page_type is 0xffffffff, no flags are set. Setting PG_buddy (0x00000080) flag results in a page_type of 0xffffff7f. Clearing a bit actually means setting a flag. Bits in page_type are inverted when displaying type names.
Only values for which page_type_has_type() returns true are considered as page_type, to avoid confusion with mapcount values. if it returns false, only raw values are displayed and not page type names.
--- Documentation/core-api/printk-formats.rst | 16 +++++++++----- include/linux/page-flags.h | 7 +++++- include/trace/events/mmflags.h | 8 +++++++ lib/test_printf.c | 26 +++++++++++++++++++++++ lib/vsprintf.c | 21 ++++++++++++++++++ mm/debug.c | 5 +++++ mm/internal.h | 1 + 7 files changed, 78 insertions(+), 6 deletions(-)
Documentation/core-api/printk-formats.rst +11 -5
@@ -575,20 +575,26 @@ The field width is passed by value, the bitmap is passed by reference. Helper macros cpumask_pr_args() and nodemask_pr_args() are available to ease printing cpumask and nodemask. -Flags bitfields such as page flags, gfp_flags ---------------------------------------------- +Flags bitfields such as page flags, page_type, gfp_flags +-------------------------------------------------------- :: %pGp 0x17ffffc0002036(referenced|uptodate|lru|active|private|node=0|zone=2|lastcpupid=0x1fffff) + %pGt 0xffffff7f(buddy) %pGg GFP_USER|GFP_DMA32|GFP_NOWARN %pGv read|exec|mayread|maywrite|mayexec|denywrite For printing flags bitfields as a collection of symbolic constants that would construct the value. The type of flags is given by the third -character. Currently supported are [p]age flags, [v]ma_flags (both -expect ``unsigned long *``) and [g]fp_flags (expects ``gfp_t *``). The flag -names and print order depends on the particular type. +character. Currently supported are: + + - p - [p]age flags, expects value of type (``unsigned long *``) + - t - page [t]ype, expects value of type (``unsigned int *``) + - v - [v]ma_flags, expects value of type (``unsigned long *``) + - g - [g]fp_flags, expects value of type (``gfp_t *``) + +The flag names and print order depends on the particular type. Note that this format should not be used directly in the :c:func:`TP_printk()` part of a tracepoint. Instead, use the show_*_flags()
include/linux/page-flags.h +6 -1
@@ -926,9 +926,14 @@ static inline bool is_page_hwpoison(struct page *page)#define PageType (page, flag) \ ((page->page_type & (PAGE_TYPE_BASE | flag)) == PAGE_TYPE_BASE) +static inline int page_type_has_type (unsigned int page_type) +{ +return (int )page_type <PAGE_MAPCOUNT_RESERVE ; +} +static inline int page_has_type (struct page *page) { -return (int )page->page_type <PAGE_MAPCOUNT_RESERVE ; +return page_type_has_type (page->page_type); }#define PAGE_TYPE_OPS (uname, lname) \
include/trace/events/mmflags.h +8 -0
@@ -141,6 +141,14 @@ IF_HAVE_PG_SKIP_KASAN_POISON(skip_kasan_poison) __def_pageflag_names \ ) : "none" +#define DEF_PAGETYPE_NAME (_name) { PG_##_name, __stringify(_name) } + +#define __def_pagetype_names \ + DEF_PAGETYPE_NAME(offline), \ + DEF_PAGETYPE_NAME(guard), \ + DEF_PAGETYPE_NAME(table), \ + DEF_PAGETYPE_NAME(buddy) +#if defined(CONFIG_X86 )#define __VM_ARCH_SPECIFIC_1 {VM_PAT, "pat" }#elif defined(CONFIG_PPC )
lib/test_printf.c +26 -0
@@ -642,12 +642,26 @@ page_flags_test(int section, int node, int zone, int last_cpupid,test (cmp_buf,"%pGp" , &flags); } +static void __init page_type_test (unsigned int page_type,const char *name, +char *cmp_buf) +{ +unsigned long size; + + size =scnprintf (cmp_buf,BUF_SIZE ,"%#x(" , page_type); +if (page_type_has_type (page_type)) + size +=scnprintf (cmp_buf + size,BUF_SIZE - size,"%s" , name); + +snprintf (cmp_buf + size,BUF_SIZE - size,")" ); +test (cmp_buf,"%pGt" , &page_type); +} +static void __init flags (void ) {unsigned long flags;char *cmp_buffer;gfp_t gfp; +unsigned int page_type; cmp_buffer =kmalloc (BUF_SIZE ,GFP_KERNEL );if (!cmp_buffer)
@@ -687,6 +701,18 @@ flags(void) gfp |= __GFP_HIGH;test (cmp_buffer,"%pGg" , &gfp); + page_type = ~0 ; +page_type_test (page_type,"" , cmp_buffer); + + page_type =10 ; +page_type_test (page_type,"" , cmp_buffer); + + page_type = ~PG_buddy; +page_type_test (page_type,"buddy" , cmp_buffer); + + page_type = ~(PG_table | PG_buddy); +page_type_test (page_type,"table|buddy" , cmp_buffer); +kfree (cmp_buffer); }
lib/vsprintf.c +21 -0
@@ -2052,6 +2052,25 @@ char *format_page_flags(char *buf, char *end, unsigned long flags)return buf; } +static +char *format_page_type (char *buf,char *end,unsigned int page_type) +{ + buf =number (buf, end, page_type, default_flag_spec); + +if (buf < end) + *buf ='(' ; + buf++; + +if (page_type_has_type (page_type)) + buf =format_flags (buf, end, ~page_type, pagetype_names); + +if (buf < end) + *buf =')' ; + buf++; + +return buf; +} +static noinline_for_stack char *flags_string(char *buf, char *end, void *flags_ptr,struct printf_spec spec,const char *fmt)
@@ -2065,6 +2084,8 @@ char *flags_string(char *buf, char *end, void *flags_ptr,switch (fmt[1 ]) {case 'p' :return format_page_flags (buf, end, *(unsigned long *)flags_ptr); +case 't' : +return format_page_type (buf, end, *(unsigned int *)flags_ptr);case 'v' : flags = *(unsigned long *)flags_ptr; names = vmaflag_names;
mm/debug.c +5 -0
@@ -36,6 +36,11 @@ const struct trace_print_flags pageflag_names[] = { {0, NULL} }; +const struct trace_print_flags pagetype_names[] = { + __def_pagetype_names, + {0 ,NULL } +}; +const struct trace_print_flags gfpflag_names[] = { __def_gfpflag_names, {0 ,NULL }
mm/internal.h +1 -0
@@ -802,6 +802,7 @@ static inline void flush_tlb_batched_pending(struct mm_struct *mm)#endif /* CONFIG_ARCH_WANT_BATCHED_UNMAP_TLB_FLUSH */ extern const struct trace_print_flags pageflag_names[]; +extern const struct trace_print_flags pagetype_names[];extern const struct trace_print_flags vmaflag_names[];extern const struct trace_print_flags gfpflag_names[];
Signature · 1 line
2.39.1
Re: [PATCH mm-unstable v4 2/3] mm, printk: introduce new format %pGt for page_type
Quoted 10 lines · Hyeonggon Yoo
%pGp format is used to display 'flags' field of a struct page. However, some page flags (i.e.
PG_buddy, seepage-flags.hfor more details) are stored inpage_typefield. To display human-readable output ofpage_type, introduce %pGt format.It is important to note the meaning of bits are different in
page_type. ifpage_typeis0xffffffff, no flags are set. SettingPG_buddy(0x00000080) flag results in apage_typeof0xffffff7f. Clearing a bit actually means setting a flag. Bits inpage_typeare inverted when displaying type names.
Quoted 5 lines
Only values for which
page_type_has_type()returns true are considered aspage_type, to avoid confusion with mapcount values. if it returns false, only raw values are displayed and not page type names.Signed-off-by Hyeonggon Yoo <[email protected]>
I am sorry for the late review. It has somehow fallen through cracks.
Best Regards,
Petr
PATCH v4 3/3 mm/debug: use %pGt to display page_type in dump_page()
In reply to Hyeonggon YooSome page flags are stored in page_type rather than ->flags field. Use newly introduced page type %pGt in dump_page().
Below are some examples:
page:00000000da7184dd refcount:1 mapcount:0 mapping:0000000000000000 index:0x0 pfn:0x101cb3
flags: 0x2ffff0000000000(node=0|zone=2|lastcpupid=0xffff)page_type: 0xffffffff()
raw: 02ffff0000000000 0000000000000000 dead000000000122 0000000000000000 raw: 0000000000000000 0000000000000000 00000001ffffffff 0000000000000000 page dumped because: newly allocated page
page:00000000da7184dd refcount:0 mapcount:-128 mapping:0000000000000000 index:0x0 pfn:0x101cb3
flags: 0x2ffff0000000000(node=0|zone=2|lastcpupid=0xffff)page_type: 0xffffff7f(buddy)
raw: 02ffff0000000000 ffff88813fff8e80 ffff88813fff8e80 0000000000000000 raw: 0000000000000000 0000000000000000 00000000ffffff7f 0000000000000000 page dumped because: freed page
page:0000000042202316 refcount:3 mapcount:2 mapping:0000000000000000 index:0x7f634722a pfn:0x11994e memcg:ffff888100135000
anon flags: 0x2ffff0000080024(uptodate|active|swapbacked|node=0|zone=2|lastcpupid=0xffff)page_type: 0x1()
raw: 02ffff0000080024 0000000000000000 dead000000000122 ffff8881193398f1 raw: 00000007f634722a 0000000000000000 0000000300000001 ffff888100135000 page dumped because: user-mapped page
--- mm/debug.c | 2 ++ 1 file changed, 2 insertions(+)
mm/debug.c +2 -0
@@ -120,6 +120,8 @@ static void __dump_page(struct page *page)pr_warn ("%sflags: %pGp%s\n" , type, &head->flags, page_cma ?" CMA" :"" ); +pr_warn ("page_type: %pGt\n" , &head->page_type); +print_hex_dump (KERN_WARNING ,"raw: " ,DUMP_PREFIX_NONE ,32 ,sizeof (unsigned long ), page,sizeof (struct page ), false);
Signature · 1 line
2.39.1