2 * page-types: Tool for querying page flags
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License as published by the Free
6 * Software Foundation; version 2.
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should find a copy of v2 of the GNU General Public License somewhere on
14 * your Linux system; if not, write to the Free Software Foundation, Inc., 59
15 * Temple Place, Suite 330, Boston, MA 02111-1307 USA.
17 * Copyright (C) 2009 Intel corporation
19 * Authors: Wu Fengguang <fengguang.wu@intel.com>
22 #define _LARGEFILE64_SOURCE
32 #include <sys/types.h>
33 #include <sys/errno.h>
34 #include <sys/fcntl.h>
35 #include <sys/mount.h>
36 #include <sys/statfs.h>
37 #include "../../include/uapi/linux/magic.h"
38 #include "../../include/uapi/linux/kernel-page-flags.h"
39 #include <lk/debugfs.h>
47 # define STR(x) _STR(x)
51 * pagemap kernel ABI bits
54 #define PM_ENTRY_BYTES sizeof(uint64_t)
55 #define PM_STATUS_BITS 3
56 #define PM_STATUS_OFFSET (64 - PM_STATUS_BITS)
57 #define PM_STATUS_MASK (((1LL << PM_STATUS_BITS) - 1) << PM_STATUS_OFFSET)
58 #define PM_STATUS(nr) (((nr) << PM_STATUS_OFFSET) & PM_STATUS_MASK)
59 #define PM_PSHIFT_BITS 6
60 #define PM_PSHIFT_OFFSET (PM_STATUS_OFFSET - PM_PSHIFT_BITS)
61 #define PM_PSHIFT_MASK (((1LL << PM_PSHIFT_BITS) - 1) << PM_PSHIFT_OFFSET)
62 #define PM_PSHIFT(x) (((u64) (x) << PM_PSHIFT_OFFSET) & PM_PSHIFT_MASK)
63 #define PM_PFRAME_MASK ((1LL << PM_PSHIFT_OFFSET) - 1)
64 #define PM_PFRAME(x) ((x) & PM_PFRAME_MASK)
66 #define PM_PRESENT PM_STATUS(4LL)
67 #define PM_SWAP PM_STATUS(2LL)
75 #define PROC_KPAGEFLAGS "/proc/kpageflags"
77 /* [32-] kernel hacking assistances */
78 #define KPF_RESERVED 32
79 #define KPF_MLOCKED 33
80 #define KPF_MAPPEDTODISK 34
81 #define KPF_PRIVATE 35
82 #define KPF_PRIVATE_2 36
83 #define KPF_OWNER_PRIVATE 37
85 #define KPF_UNCACHED 39
87 /* [48-] take some arbitrary free slots for expanding overloaded flags
88 * not part of kernel API
90 #define KPF_READAHEAD 48
91 #define KPF_SLOB_FREE 49
92 #define KPF_SLUB_FROZEN 50
93 #define KPF_SLUB_DEBUG 51
95 #define KPF_ALL_BITS ((uint64_t)~0ULL)
96 #define KPF_HACKERS_BITS (0xffffULL << 32)
97 #define KPF_OVERLOADED_BITS (0xffffULL << 48)
98 #define BIT(name) (1ULL << KPF_##name)
99 #define BITS_COMPOUND (BIT(COMPOUND_HEAD) | BIT(COMPOUND_TAIL))
101 static const char * const page_flag_names
[] = {
102 [KPF_LOCKED
] = "L:locked",
103 [KPF_ERROR
] = "E:error",
104 [KPF_REFERENCED
] = "R:referenced",
105 [KPF_UPTODATE
] = "U:uptodate",
106 [KPF_DIRTY
] = "D:dirty",
108 [KPF_ACTIVE
] = "A:active",
109 [KPF_SLAB
] = "S:slab",
110 [KPF_WRITEBACK
] = "W:writeback",
111 [KPF_RECLAIM
] = "I:reclaim",
112 [KPF_BUDDY
] = "B:buddy",
114 [KPF_MMAP
] = "M:mmap",
115 [KPF_ANON
] = "a:anonymous",
116 [KPF_SWAPCACHE
] = "s:swapcache",
117 [KPF_SWAPBACKED
] = "b:swapbacked",
118 [KPF_COMPOUND_HEAD
] = "H:compound_head",
119 [KPF_COMPOUND_TAIL
] = "T:compound_tail",
120 [KPF_HUGE
] = "G:huge",
121 [KPF_UNEVICTABLE
] = "u:unevictable",
122 [KPF_HWPOISON
] = "X:hwpoison",
123 [KPF_NOPAGE
] = "n:nopage",
127 [KPF_RESERVED
] = "r:reserved",
128 [KPF_MLOCKED
] = "m:mlocked",
129 [KPF_MAPPEDTODISK
] = "d:mappedtodisk",
130 [KPF_PRIVATE
] = "P:private",
131 [KPF_PRIVATE_2
] = "p:private_2",
132 [KPF_OWNER_PRIVATE
] = "O:owner_private",
133 [KPF_ARCH
] = "h:arch",
134 [KPF_UNCACHED
] = "c:uncached",
136 [KPF_READAHEAD
] = "I:readahead",
137 [KPF_SLOB_FREE
] = "P:slob_free",
138 [KPF_SLUB_FROZEN
] = "A:slub_frozen",
139 [KPF_SLUB_DEBUG
] = "E:slub_debug",
143 static const char * const debugfs_known_mountpoints
[] = {
153 static int opt_raw
; /* for kernel developers */
154 static int opt_list
; /* list pages (in ranges) */
155 static int opt_no_summary
; /* don't show summary */
156 static pid_t opt_pid
; /* process to walk */
158 #define MAX_ADDR_RANGES 1024
159 static int nr_addr_ranges
;
160 static unsigned long opt_offset
[MAX_ADDR_RANGES
];
161 static unsigned long opt_size
[MAX_ADDR_RANGES
];
163 #define MAX_VMAS 10240
165 static unsigned long pg_start
[MAX_VMAS
];
166 static unsigned long pg_end
[MAX_VMAS
];
168 #define MAX_BIT_FILTERS 64
169 static int nr_bit_filters
;
170 static uint64_t opt_mask
[MAX_BIT_FILTERS
];
171 static uint64_t opt_bits
[MAX_BIT_FILTERS
];
173 static int page_size
;
175 static int pagemap_fd
;
176 static int kpageflags_fd
;
178 static int opt_hwpoison
;
179 static int opt_unpoison
;
181 static char *hwpoison_debug_fs
;
182 static int hwpoison_inject_fd
;
183 static int hwpoison_forget_fd
;
185 #define HASH_SHIFT 13
186 #define HASH_SIZE (1 << HASH_SHIFT)
187 #define HASH_MASK (HASH_SIZE - 1)
188 #define HASH_KEY(flags) (flags & HASH_MASK)
190 static unsigned long total_pages
;
191 static unsigned long nr_pages
[HASH_SIZE
];
192 static uint64_t page_flags
[HASH_SIZE
];
199 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
201 #define min_t(type, x, y) ({ \
204 __min1 < __min2 ? __min1 : __min2; })
206 #define max_t(type, x, y) ({ \
209 __max1 > __max2 ? __max1 : __max2; })
211 static unsigned long pages2mb(unsigned long pages
)
213 return (pages
* page_size
) >> 20;
216 static void fatal(const char *x
, ...)
221 vfprintf(stderr
, x
, ap
);
226 static int checked_open(const char *pathname
, int flags
)
228 int fd
= open(pathname
, flags
);
239 * pagemap/kpageflags routines
242 static unsigned long do_u64_read(int fd
, char *name
,
249 if (index
> ULONG_MAX
/ 8)
250 fatal("index overflow: %lu\n", index
);
252 if (lseek(fd
, index
* 8, SEEK_SET
) < 0) {
257 bytes
= read(fd
, buf
, count
* 8);
263 fatal("partial read: %lu bytes\n", bytes
);
268 static unsigned long kpageflags_read(uint64_t *buf
,
272 return do_u64_read(kpageflags_fd
, PROC_KPAGEFLAGS
, buf
, index
, pages
);
275 static unsigned long pagemap_read(uint64_t *buf
,
279 return do_u64_read(pagemap_fd
, "/proc/pid/pagemap", buf
, index
, pages
);
282 static unsigned long pagemap_pfn(uint64_t val
)
286 if (val
& PM_PRESENT
)
287 pfn
= PM_PFRAME(val
);
299 static char *page_flag_name(uint64_t flags
)
305 for (i
= 0, j
= 0; i
< ARRAY_SIZE(page_flag_names
); i
++) {
306 present
= (flags
>> i
) & 1;
307 if (!page_flag_names
[i
]) {
309 fatal("unknown flag bit %d\n", i
);
312 buf
[j
++] = present
? page_flag_names
[i
][0] : '_';
318 static char *page_flag_longname(uint64_t flags
)
320 static char buf
[1024];
323 for (i
= 0, n
= 0; i
< ARRAY_SIZE(page_flag_names
); i
++) {
324 if (!page_flag_names
[i
])
326 if ((flags
>> i
) & 1)
327 n
+= snprintf(buf
+ n
, sizeof(buf
) - n
, "%s,",
328 page_flag_names
[i
] + 2);
339 * page list and summary
342 static void show_page_range(unsigned long voffset
,
343 unsigned long offset
, uint64_t flags
)
345 static uint64_t flags0
;
346 static unsigned long voff
;
347 static unsigned long index
;
348 static unsigned long count
;
350 if (flags
== flags0
&& offset
== index
+ count
&&
351 (!opt_pid
|| voffset
== voff
+ count
)) {
358 printf("%lx\t", voff
);
359 printf("%lx\t%lx\t%s\n",
360 index
, count
, page_flag_name(flags0
));
369 static void show_page(unsigned long voffset
,
370 unsigned long offset
, uint64_t flags
)
373 printf("%lx\t", voffset
);
374 printf("%lx\t%s\n", offset
, page_flag_name(flags
));
377 static void show_summary(void)
381 printf(" flags\tpage-count MB"
382 " symbolic-flags\t\t\tlong-symbolic-flags\n");
384 for (i
= 0; i
< ARRAY_SIZE(nr_pages
); i
++) {
386 printf("0x%016llx\t%10lu %8lu %s\t%s\n",
387 (unsigned long long)page_flags
[i
],
389 pages2mb(nr_pages
[i
]),
390 page_flag_name(page_flags
[i
]),
391 page_flag_longname(page_flags
[i
]));
394 printf(" total\t%10lu %8lu\n",
395 total_pages
, pages2mb(total_pages
));
403 static int bit_mask_ok(uint64_t flags
)
407 for (i
= 0; i
< nr_bit_filters
; i
++) {
408 if (opt_bits
[i
] == KPF_ALL_BITS
) {
409 if ((flags
& opt_mask
[i
]) == 0)
412 if ((flags
& opt_mask
[i
]) != opt_bits
[i
])
420 static uint64_t expand_overloaded_flags(uint64_t flags
)
422 /* SLOB/SLUB overload several page flags */
423 if (flags
& BIT(SLAB
)) {
424 if (flags
& BIT(PRIVATE
))
425 flags
^= BIT(PRIVATE
) | BIT(SLOB_FREE
);
426 if (flags
& BIT(ACTIVE
))
427 flags
^= BIT(ACTIVE
) | BIT(SLUB_FROZEN
);
428 if (flags
& BIT(ERROR
))
429 flags
^= BIT(ERROR
) | BIT(SLUB_DEBUG
);
432 /* PG_reclaim is overloaded as PG_readahead in the read path */
433 if ((flags
& (BIT(RECLAIM
) | BIT(WRITEBACK
))) == BIT(RECLAIM
))
434 flags
^= BIT(RECLAIM
) | BIT(READAHEAD
);
439 static uint64_t well_known_flags(uint64_t flags
)
441 /* hide flags intended only for kernel hacker */
442 flags
&= ~KPF_HACKERS_BITS
;
444 /* hide non-hugeTLB compound pages */
445 if ((flags
& BITS_COMPOUND
) && !(flags
& BIT(HUGE
)))
446 flags
&= ~BITS_COMPOUND
;
451 static uint64_t kpageflags_flags(uint64_t flags
)
453 flags
= expand_overloaded_flags(flags
);
456 flags
= well_known_flags(flags
);
465 static void prepare_hwpoison_fd(void)
467 char buf
[MAX_PATH
+ 1];
469 hwpoison_debug_fs
= debugfs_mount(NULL
);
470 if (!hwpoison_debug_fs
) {
471 perror("mount debugfs");
475 if (opt_hwpoison
&& !hwpoison_inject_fd
) {
476 snprintf(buf
, MAX_PATH
, "%s/hwpoison/corrupt-pfn",
478 hwpoison_inject_fd
= checked_open(buf
, O_WRONLY
);
481 if (opt_unpoison
&& !hwpoison_forget_fd
) {
482 snprintf(buf
, MAX_PATH
, "%s/hwpoison/unpoison-pfn",
484 hwpoison_forget_fd
= checked_open(buf
, O_WRONLY
);
488 static int hwpoison_page(unsigned long offset
)
493 len
= sprintf(buf
, "0x%lx\n", offset
);
494 len
= write(hwpoison_inject_fd
, buf
, len
);
496 perror("hwpoison inject");
502 static int unpoison_page(unsigned long offset
)
507 len
= sprintf(buf
, "0x%lx\n", offset
);
508 len
= write(hwpoison_forget_fd
, buf
, len
);
510 perror("hwpoison forget");
520 static size_t hash_slot(uint64_t flags
)
522 size_t k
= HASH_KEY(flags
);
525 /* Explicitly reserve slot 0 for flags 0: the following logic
526 * cannot distinguish an unoccupied slot from slot (flags==0).
531 /* search through the remaining (HASH_SIZE-1) slots */
532 for (i
= 1; i
< ARRAY_SIZE(page_flags
); i
++, k
++) {
533 if (!k
|| k
>= ARRAY_SIZE(page_flags
))
535 if (page_flags
[k
] == 0) {
536 page_flags
[k
] = flags
;
539 if (page_flags
[k
] == flags
)
543 fatal("hash table full: bump up HASH_SHIFT?\n");
547 static void add_page(unsigned long voffset
,
548 unsigned long offset
, uint64_t flags
)
550 flags
= kpageflags_flags(flags
);
552 if (!bit_mask_ok(flags
))
556 hwpoison_page(offset
);
558 unpoison_page(offset
);
561 show_page_range(voffset
, offset
, flags
);
562 else if (opt_list
== 2)
563 show_page(voffset
, offset
, flags
);
565 nr_pages
[hash_slot(flags
)]++;
569 #define KPAGEFLAGS_BATCH (64 << 10) /* 64k pages */
570 static void walk_pfn(unsigned long voffset
,
574 uint64_t buf
[KPAGEFLAGS_BATCH
];
580 batch
= min_t(unsigned long, count
, KPAGEFLAGS_BATCH
);
581 pages
= kpageflags_read(buf
, index
, batch
);
585 for (i
= 0; i
< pages
; i
++)
586 add_page(voffset
+ i
, index
+ i
, buf
[i
]);
593 #define PAGEMAP_BATCH (64 << 10)
594 static void walk_vma(unsigned long index
, unsigned long count
)
596 uint64_t buf
[PAGEMAP_BATCH
];
603 batch
= min_t(unsigned long, count
, PAGEMAP_BATCH
);
604 pages
= pagemap_read(buf
, index
, batch
);
608 for (i
= 0; i
< pages
; i
++) {
609 pfn
= pagemap_pfn(buf
[i
]);
611 walk_pfn(index
+ i
, pfn
, 1);
619 static void walk_task(unsigned long index
, unsigned long count
)
621 const unsigned long end
= index
+ count
;
625 while (index
< end
) {
627 while (pg_end
[i
] <= index
)
630 if (pg_start
[i
] >= end
)
633 start
= max_t(unsigned long, pg_start
[i
], index
);
634 index
= min_t(unsigned long, pg_end
[i
], end
);
636 assert(start
< index
);
637 walk_vma(start
, index
- start
);
641 static void add_addr_range(unsigned long offset
, unsigned long size
)
643 if (nr_addr_ranges
>= MAX_ADDR_RANGES
)
644 fatal("too many addr ranges\n");
646 opt_offset
[nr_addr_ranges
] = offset
;
647 opt_size
[nr_addr_ranges
] = min_t(unsigned long, size
, ULONG_MAX
-offset
);
651 static void walk_addr_ranges(void)
655 kpageflags_fd
= checked_open(PROC_KPAGEFLAGS
, O_RDONLY
);
658 add_addr_range(0, ULONG_MAX
);
660 for (i
= 0; i
< nr_addr_ranges
; i
++)
662 walk_pfn(0, opt_offset
[i
], opt_size
[i
]);
664 walk_task(opt_offset
[i
], opt_size
[i
]);
666 close(kpageflags_fd
);
674 static const char *page_flag_type(uint64_t flag
)
676 if (flag
& KPF_HACKERS_BITS
)
678 if (flag
& KPF_OVERLOADED_BITS
)
683 static void usage(void)
688 "page-types [options]\n"
689 " -r|--raw Raw mode, for kernel developers\n"
690 " -d|--describe flags Describe flags\n"
691 " -a|--addr addr-spec Walk a range of pages\n"
692 " -b|--bits bits-spec Walk pages with specified bits\n"
693 " -p|--pid pid Walk process address space\n"
694 #if 0 /* planned features */
695 " -f|--file filename Walk file address space\n"
697 " -l|--list Show page details in ranges\n"
698 " -L|--list-each Show page details one by one\n"
699 " -N|--no-summary Don't show summary info\n"
700 " -X|--hwpoison hwpoison pages\n"
701 " -x|--unpoison unpoison pages\n"
702 " -h|--help Show this usage message\n"
704 " 0x10 bitfield format, e.g.\n"
705 " anon bit-name, e.g.\n"
706 " 0x10,anon comma-separated list, e.g.\n"
708 " N one page at offset N (unit: pages)\n"
709 " N+M pages range from N to N+M-1\n"
710 " N,M pages range from N to M-1\n"
711 " N, pages range from N to end\n"
712 " ,M pages range from 0 to M-1\n"
714 " bit1,bit2 (flags & (bit1|bit2)) != 0\n"
715 " bit1,bit2=bit1 (flags & (bit1|bit2)) == bit1\n"
716 " bit1,~bit2 (flags & (bit1|bit2)) == bit1\n"
717 " =bit1,bit2 flags == (bit1|bit2)\n"
721 for (i
= 0, j
= 0; i
< ARRAY_SIZE(page_flag_names
); i
++) {
722 if (!page_flag_names
[i
])
724 printf("%16s%s", page_flag_names
[i
] + 2,
725 page_flag_type(1ULL << i
));
732 "(r) raw mode bits (o) overloaded bits\n");
735 static unsigned long long parse_number(const char *str
)
737 unsigned long long n
;
739 n
= strtoll(str
, NULL
, 0);
741 if (n
== 0 && str
[0] != '0')
742 fatal("invalid name or number: %s\n", str
);
747 static void parse_pid(const char *str
)
752 opt_pid
= parse_number(str
);
754 sprintf(buf
, "/proc/%d/pagemap", opt_pid
);
755 pagemap_fd
= checked_open(buf
, O_RDONLY
);
757 sprintf(buf
, "/proc/%d/maps", opt_pid
);
758 file
= fopen(buf
, "r");
764 while (fgets(buf
, sizeof(buf
), file
) != NULL
) {
765 unsigned long vm_start
;
766 unsigned long vm_end
;
767 unsigned long long pgoff
;
773 n
= sscanf(buf
, "%lx-%lx %c%c%c%c %llx %x:%x %lu",
781 fprintf(stderr
, "unexpected line: %s\n", buf
);
784 pg_start
[nr_vmas
] = vm_start
/ page_size
;
785 pg_end
[nr_vmas
] = vm_end
/ page_size
;
786 if (++nr_vmas
>= MAX_VMAS
) {
787 fprintf(stderr
, "too many VMAs\n");
794 static void parse_file(const char *name
)
798 static void parse_addr_range(const char *optarg
)
800 unsigned long offset
;
804 p
= strchr(optarg
, ',');
806 p
= strchr(optarg
, '+');
810 size
= parse_number(p
+ 1);
812 offset
= parse_number(optarg
);
816 size
= parse_number(p
+ 1);
819 fatal("invalid range: %lu,%lu\n",
825 offset
= parse_number(optarg
);
829 add_addr_range(offset
, size
);
832 static void add_bits_filter(uint64_t mask
, uint64_t bits
)
834 if (nr_bit_filters
>= MAX_BIT_FILTERS
)
835 fatal("too much bit filters\n");
837 opt_mask
[nr_bit_filters
] = mask
;
838 opt_bits
[nr_bit_filters
] = bits
;
842 static uint64_t parse_flag_name(const char *str
, int len
)
849 if (len
<= 8 && !strncmp(str
, "compound", len
))
850 return BITS_COMPOUND
;
852 for (i
= 0; i
< ARRAY_SIZE(page_flag_names
); i
++) {
853 if (!page_flag_names
[i
])
855 if (!strncmp(str
, page_flag_names
[i
] + 2, len
))
859 return parse_number(str
);
862 static uint64_t parse_flag_names(const char *str
, int all
)
868 if (*p
== ',' || *p
== '=' || *p
== '\0') {
869 if ((*str
!= '~') || (*str
== '~' && all
&& *++str
))
870 flags
|= parse_flag_name(str
, p
- str
);
881 static void parse_bits_mask(const char *optarg
)
887 p
= strchr(optarg
, '=');
890 bits
= parse_flag_names(p
+ 1, 0);
892 mask
= parse_flag_names(optarg
, 0);
893 bits
= parse_flag_names(p
+ 1, 0);
894 } else if (strchr(optarg
, '~')) {
895 mask
= parse_flag_names(optarg
, 1);
896 bits
= parse_flag_names(optarg
, 0);
898 mask
= parse_flag_names(optarg
, 0);
902 add_bits_filter(mask
, bits
);
905 static void describe_flags(const char *optarg
)
907 uint64_t flags
= parse_flag_names(optarg
, 0);
909 printf("0x%016llx\t%s\t%s\n",
910 (unsigned long long)flags
,
911 page_flag_name(flags
),
912 page_flag_longname(flags
));
915 static const struct option opts
[] = {
916 { "raw" , 0, NULL
, 'r' },
917 { "pid" , 1, NULL
, 'p' },
918 { "file" , 1, NULL
, 'f' },
919 { "addr" , 1, NULL
, 'a' },
920 { "bits" , 1, NULL
, 'b' },
921 { "describe" , 1, NULL
, 'd' },
922 { "list" , 0, NULL
, 'l' },
923 { "list-each" , 0, NULL
, 'L' },
924 { "no-summary", 0, NULL
, 'N' },
925 { "hwpoison" , 0, NULL
, 'X' },
926 { "unpoison" , 0, NULL
, 'x' },
927 { "help" , 0, NULL
, 'h' },
928 { NULL
, 0, NULL
, 0 }
931 int main(int argc
, char *argv
[])
935 page_size
= getpagesize();
937 while ((c
= getopt_long(argc
, argv
,
938 "rp:f:a:b:d:lLNXxh", opts
, NULL
)) != -1) {
950 parse_addr_range(optarg
);
953 parse_bits_mask(optarg
);
956 describe_flags(optarg
);
969 prepare_hwpoison_fd();
973 prepare_hwpoison_fd();
984 if (opt_list
&& opt_pid
)
987 printf("offset\tlen\tflags\n");
989 printf("offset\tflags\n");
994 show_page_range(0, 0, 0); /* drain the buffer */