2 * page-types: Tool for querying page flags
4 * Copyright (C) 2009 Intel corporation
5 * Copyright (C) 2009 Wu Fengguang <fengguang.wu@intel.com>
8 #define _LARGEFILE64_SOURCE
18 #include <sys/types.h>
19 #include <sys/errno.h>
20 #include <sys/fcntl.h>
24 * pagemap kernel ABI bits
27 #define PM_ENTRY_BYTES sizeof(uint64_t)
28 #define PM_STATUS_BITS 3
29 #define PM_STATUS_OFFSET (64 - PM_STATUS_BITS)
30 #define PM_STATUS_MASK (((1LL << PM_STATUS_BITS) - 1) << PM_STATUS_OFFSET)
31 #define PM_STATUS(nr) (((nr) << PM_STATUS_OFFSET) & PM_STATUS_MASK)
32 #define PM_PSHIFT_BITS 6
33 #define PM_PSHIFT_OFFSET (PM_STATUS_OFFSET - PM_PSHIFT_BITS)
34 #define PM_PSHIFT_MASK (((1LL << PM_PSHIFT_BITS) - 1) << PM_PSHIFT_OFFSET)
35 #define PM_PSHIFT(x) (((u64) (x) << PM_PSHIFT_OFFSET) & PM_PSHIFT_MASK)
36 #define PM_PFRAME_MASK ((1LL << PM_PSHIFT_OFFSET) - 1)
37 #define PM_PFRAME(x) ((x) & PM_PFRAME_MASK)
39 #define PM_PRESENT PM_STATUS(4LL)
40 #define PM_SWAP PM_STATUS(2LL)
48 #define PROC_KPAGEFLAGS "/proc/kpageflags"
50 /* copied from kpageflags_read() */
53 #define KPF_REFERENCED 2
54 #define KPF_UPTODATE 3
59 #define KPF_WRITEBACK 8
63 /* [11-20] new additions in 2.6.31 */
66 #define KPF_SWAPCACHE 13
67 #define KPF_SWAPBACKED 14
68 #define KPF_COMPOUND_HEAD 15
69 #define KPF_COMPOUND_TAIL 16
71 #define KPF_UNEVICTABLE 18
72 #define KPF_HWPOISON 19
75 /* [32-] kernel hacking assistances */
76 #define KPF_RESERVED 32
77 #define KPF_MLOCKED 33
78 #define KPF_MAPPEDTODISK 34
79 #define KPF_PRIVATE 35
80 #define KPF_PRIVATE_2 36
81 #define KPF_OWNER_PRIVATE 37
83 #define KPF_UNCACHED 39
85 /* [48-] take some arbitrary free slots for expanding overloaded flags
86 * not part of kernel API
88 #define KPF_READAHEAD 48
89 #define KPF_SLOB_FREE 49
90 #define KPF_SLUB_FROZEN 50
91 #define KPF_SLUB_DEBUG 51
93 #define KPF_ALL_BITS ((uint64_t)~0ULL)
94 #define KPF_HACKERS_BITS (0xffffULL << 32)
95 #define KPF_OVERLOADED_BITS (0xffffULL << 48)
96 #define BIT(name) (1ULL << KPF_##name)
97 #define BITS_COMPOUND (BIT(COMPOUND_HEAD) | BIT(COMPOUND_TAIL))
99 static char *page_flag_names[] = {
100 [KPF_LOCKED] = "L:locked",
101 [KPF_ERROR] = "E:error",
102 [KPF_REFERENCED] = "R:referenced",
103 [KPF_UPTODATE] = "U:uptodate",
104 [KPF_DIRTY] = "D:dirty",
106 [KPF_ACTIVE] = "A:active",
107 [KPF_SLAB] = "S:slab",
108 [KPF_WRITEBACK] = "W:writeback",
109 [KPF_RECLAIM] = "I:reclaim",
110 [KPF_BUDDY] = "B:buddy",
112 [KPF_MMAP] = "M:mmap",
113 [KPF_ANON] = "a:anonymous",
114 [KPF_SWAPCACHE] = "s:swapcache",
115 [KPF_SWAPBACKED] = "b:swapbacked",
116 [KPF_COMPOUND_HEAD] = "H:compound_head",
117 [KPF_COMPOUND_TAIL] = "T:compound_tail",
118 [KPF_HUGE] = "G:huge",
119 [KPF_UNEVICTABLE] = "u:unevictable",
120 [KPF_HWPOISON] = "X:hwpoison",
121 [KPF_NOPAGE] = "n:nopage",
123 [KPF_RESERVED] = "r:reserved",
124 [KPF_MLOCKED] = "m:mlocked",
125 [KPF_MAPPEDTODISK] = "d:mappedtodisk",
126 [KPF_PRIVATE] = "P:private",
127 [KPF_PRIVATE_2] = "p:private_2",
128 [KPF_OWNER_PRIVATE] = "O:owner_private",
129 [KPF_ARCH] = "h:arch",
130 [KPF_UNCACHED] = "c:uncached",
132 [KPF_READAHEAD] = "I:readahead",
133 [KPF_SLOB_FREE] = "P:slob_free",
134 [KPF_SLUB_FROZEN] = "A:slub_frozen",
135 [KPF_SLUB_DEBUG] = "E:slub_debug",
143 static int opt_raw; /* for kernel developers */
144 static int opt_list; /* list pages (in ranges) */
145 static int opt_no_summary; /* don't show summary */
146 static pid_t opt_pid; /* process to walk */
148 #define MAX_ADDR_RANGES 1024
149 static int nr_addr_ranges;
150 static unsigned long opt_offset[MAX_ADDR_RANGES];
151 static unsigned long opt_size[MAX_ADDR_RANGES];
153 #define MAX_VMAS 10240
155 static unsigned long pg_start[MAX_VMAS];
156 static unsigned long pg_end[MAX_VMAS];
157 static unsigned long voffset;
159 static int pagemap_fd;
161 #define MAX_BIT_FILTERS 64
162 static int nr_bit_filters;
163 static uint64_t opt_mask[MAX_BIT_FILTERS];
164 static uint64_t opt_bits[MAX_BIT_FILTERS];
166 static int page_size;
168 #define PAGES_BATCH (64 << 10) /* 64k pages */
169 static int kpageflags_fd;
171 #define HASH_SHIFT 13
172 #define HASH_SIZE (1 << HASH_SHIFT)
173 #define HASH_MASK (HASH_SIZE - 1)
174 #define HASH_KEY(flags) (flags & HASH_MASK)
176 static unsigned long total_pages;
177 static unsigned long nr_pages[HASH_SIZE];
178 static uint64_t page_flags[HASH_SIZE];
185 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
187 #define min_t(type, x, y) ({ \
190 __min1 < __min2 ? __min1 : __min2; })
192 #define max_t(type, x, y) ({ \
195 __max1 > __max2 ? __max1 : __max2; })
197 static unsigned long pages2mb(unsigned long pages)
199 return (pages * page_size) >> 20;
202 static void fatal(const char *x, ...)
207 vfprintf(stderr, x, ap);
217 static char *page_flag_name(uint64_t flags)
223 for (i = 0, j = 0; i < ARRAY_SIZE(page_flag_names); i++) {
224 present = (flags >> i) & 1;
225 if (!page_flag_names[i]) {
227 fatal("unkown flag bit %d\n", i);
230 buf[j++] = present ? page_flag_names[i][0] : '_';
236 static char *page_flag_longname(uint64_t flags)
238 static char buf[1024];
241 for (i = 0, n = 0; i < ARRAY_SIZE(page_flag_names); i++) {
242 if (!page_flag_names[i])
244 if ((flags >> i) & 1)
245 n += snprintf(buf + n, sizeof(buf) - n, "%s,",
246 page_flag_names[i] + 2);
257 * page list and summary
260 static void show_page_range(unsigned long offset, uint64_t flags)
262 static uint64_t flags0;
263 static unsigned long voff;
264 static unsigned long index;
265 static unsigned long count;
267 if (flags == flags0 && offset == index + count &&
268 (!opt_pid || voffset == voff + count)) {
275 printf("%lx\t", voff);
276 printf("%lx\t%lx\t%s\n",
277 index, count, page_flag_name(flags0));
286 static void show_page(unsigned long offset, uint64_t flags)
289 printf("%lx\t", voffset);
290 printf("%lx\t%s\n", offset, page_flag_name(flags));
293 static void show_summary(void)
297 printf(" flags\tpage-count MB"
298 " symbolic-flags\t\t\tlong-symbolic-flags\n");
300 for (i = 0; i < ARRAY_SIZE(nr_pages); i++) {
302 printf("0x%016llx\t%10lu %8lu %s\t%s\n",
303 (unsigned long long)page_flags[i],
305 pages2mb(nr_pages[i]),
306 page_flag_name(page_flags[i]),
307 page_flag_longname(page_flags[i]));
310 printf(" total\t%10lu %8lu\n",
311 total_pages, pages2mb(total_pages));
319 static int bit_mask_ok(uint64_t flags)
323 for (i = 0; i < nr_bit_filters; i++) {
324 if (opt_bits[i] == KPF_ALL_BITS) {
325 if ((flags & opt_mask[i]) == 0)
328 if ((flags & opt_mask[i]) != opt_bits[i])
336 static uint64_t expand_overloaded_flags(uint64_t flags)
338 /* SLOB/SLUB overload several page flags */
339 if (flags & BIT(SLAB)) {
340 if (flags & BIT(PRIVATE))
341 flags ^= BIT(PRIVATE) | BIT(SLOB_FREE);
342 if (flags & BIT(ACTIVE))
343 flags ^= BIT(ACTIVE) | BIT(SLUB_FROZEN);
344 if (flags & BIT(ERROR))
345 flags ^= BIT(ERROR) | BIT(SLUB_DEBUG);
348 /* PG_reclaim is overloaded as PG_readahead in the read path */
349 if ((flags & (BIT(RECLAIM) | BIT(WRITEBACK))) == BIT(RECLAIM))
350 flags ^= BIT(RECLAIM) | BIT(READAHEAD);
355 static uint64_t well_known_flags(uint64_t flags)
357 /* hide flags intended only for kernel hacker */
358 flags &= ~KPF_HACKERS_BITS;
360 /* hide non-hugeTLB compound pages */
361 if ((flags & BITS_COMPOUND) && !(flags & BIT(HUGE)))
362 flags &= ~BITS_COMPOUND;
372 static int hash_slot(uint64_t flags)
374 int k = HASH_KEY(flags);
377 /* Explicitly reserve slot 0 for flags 0: the following logic
378 * cannot distinguish an unoccupied slot from slot (flags==0).
383 /* search through the remaining (HASH_SIZE-1) slots */
384 for (i = 1; i < ARRAY_SIZE(page_flags); i++, k++) {
385 if (!k || k >= ARRAY_SIZE(page_flags))
387 if (page_flags[k] == 0) {
388 page_flags[k] = flags;
391 if (page_flags[k] == flags)
395 fatal("hash table full: bump up HASH_SHIFT?\n");
399 static void add_page(unsigned long offset, uint64_t flags)
401 flags = expand_overloaded_flags(flags);
404 flags = well_known_flags(flags);
406 if (!bit_mask_ok(flags))
410 show_page_range(offset, flags);
411 else if (opt_list == 2)
412 show_page(offset, flags);
414 nr_pages[hash_slot(flags)]++;
418 static void walk_pfn(unsigned long index, unsigned long count)
424 if (index > ULONG_MAX / KPF_BYTES)
425 fatal("index overflow: %lu\n", index);
427 lseek(kpageflags_fd, index * KPF_BYTES, SEEK_SET);
430 uint64_t kpageflags_buf[KPF_BYTES * PAGES_BATCH];
432 batch = min_t(unsigned long, count, PAGES_BATCH);
433 n = read(kpageflags_fd, kpageflags_buf, batch * KPF_BYTES);
437 perror(PROC_KPAGEFLAGS);
441 if (n % KPF_BYTES != 0)
442 fatal("partial read: %lu bytes\n", n);
445 for (i = 0; i < n; i++)
446 add_page(index + i, kpageflags_buf[i]);
454 #define PAGEMAP_BATCH 4096
455 static unsigned long task_pfn(unsigned long pgoff)
457 static uint64_t buf[PAGEMAP_BATCH];
458 static unsigned long start;
462 if (pgoff < start || pgoff >= start + count) {
463 if (lseek64(pagemap_fd,
464 (uint64_t)pgoff * PM_ENTRY_BYTES,
466 perror("pagemap seek");
469 count = read(pagemap_fd, buf, sizeof(buf));
473 perror("pagemap read");
476 if (count % PM_ENTRY_BYTES) {
477 fatal("pagemap read not aligned.\n");
480 count /= PM_ENTRY_BYTES;
484 pfn = buf[pgoff - start];
485 if (pfn & PM_PRESENT)
486 pfn = PM_PFRAME(pfn);
493 static void walk_task(unsigned long index, unsigned long count)
496 const unsigned long end = index + count;
498 while (index < end) {
500 while (pg_end[i] <= index)
503 if (pg_start[i] >= end)
506 voffset = max_t(unsigned long, pg_start[i], index);
507 index = min_t(unsigned long, pg_end[i], end);
509 assert(voffset < index);
510 for (; voffset < index; voffset++) {
511 unsigned long pfn = task_pfn(voffset);
518 static void add_addr_range(unsigned long offset, unsigned long size)
520 if (nr_addr_ranges >= MAX_ADDR_RANGES)
521 fatal("too many addr ranges\n");
523 opt_offset[nr_addr_ranges] = offset;
524 opt_size[nr_addr_ranges] = min_t(unsigned long, size, ULONG_MAX-offset);
528 static void walk_addr_ranges(void)
532 kpageflags_fd = open(PROC_KPAGEFLAGS, O_RDONLY);
533 if (kpageflags_fd < 0) {
534 perror(PROC_KPAGEFLAGS);
539 add_addr_range(0, ULONG_MAX);
541 for (i = 0; i < nr_addr_ranges; i++)
543 walk_pfn(opt_offset[i], opt_size[i]);
545 walk_task(opt_offset[i], opt_size[i]);
547 close(kpageflags_fd);
555 static const char *page_flag_type(uint64_t flag)
557 if (flag & KPF_HACKERS_BITS)
559 if (flag & KPF_OVERLOADED_BITS)
564 static void usage(void)
569 "page-types [options]\n"
570 " -r|--raw Raw mode, for kernel developers\n"
571 " -a|--addr addr-spec Walk a range of pages\n"
572 " -b|--bits bits-spec Walk pages with specified bits\n"
573 " -p|--pid pid Walk process address space\n"
574 #if 0 /* planned features */
575 " -f|--file filename Walk file address space\n"
577 " -l|--list Show page details in ranges\n"
578 " -L|--list-each Show page details one by one\n"
579 " -N|--no-summary Don't show summay info\n"
580 " -h|--help Show this usage message\n"
582 " N one page at offset N (unit: pages)\n"
583 " N+M pages range from N to N+M-1\n"
584 " N,M pages range from N to M-1\n"
585 " N, pages range from N to end\n"
586 " ,M pages range from 0 to M-1\n"
588 " bit1,bit2 (flags & (bit1|bit2)) != 0\n"
589 " bit1,bit2=bit1 (flags & (bit1|bit2)) == bit1\n"
590 " bit1,~bit2 (flags & (bit1|bit2)) == bit1\n"
591 " =bit1,bit2 flags == (bit1|bit2)\n"
595 for (i = 0, j = 0; i < ARRAY_SIZE(page_flag_names); i++) {
596 if (!page_flag_names[i])
598 printf("%16s%s", page_flag_names[i] + 2,
599 page_flag_type(1ULL << i));
606 "(r) raw mode bits (o) overloaded bits\n");
609 static unsigned long long parse_number(const char *str)
611 unsigned long long n;
613 n = strtoll(str, NULL, 0);
615 if (n == 0 && str[0] != '0')
616 fatal("invalid name or number: %s\n", str);
621 static void parse_pid(const char *str)
626 opt_pid = parse_number(str);
628 sprintf(buf, "/proc/%d/pagemap", opt_pid);
629 pagemap_fd = open(buf, O_RDONLY);
630 if (pagemap_fd < 0) {
635 sprintf(buf, "/proc/%d/maps", opt_pid);
636 file = fopen(buf, "r");
642 while (fgets(buf, sizeof(buf), file) != NULL) {
643 unsigned long vm_start;
644 unsigned long vm_end;
645 unsigned long long pgoff;
651 n = sscanf(buf, "%lx-%lx %c%c%c%c %llx %x:%x %lu",
659 fprintf(stderr, "unexpected line: %s\n", buf);
662 pg_start[nr_vmas] = vm_start / page_size;
663 pg_end[nr_vmas] = vm_end / page_size;
664 if (++nr_vmas >= MAX_VMAS) {
665 fprintf(stderr, "too many VMAs\n");
672 static void parse_file(const char *name)
676 static void parse_addr_range(const char *optarg)
678 unsigned long offset;
682 p = strchr(optarg, ',');
684 p = strchr(optarg, '+');
688 size = parse_number(p + 1);
690 offset = parse_number(optarg);
694 size = parse_number(p + 1);
697 fatal("invalid range: %lu,%lu\n",
703 offset = parse_number(optarg);
707 add_addr_range(offset, size);
710 static void add_bits_filter(uint64_t mask, uint64_t bits)
712 if (nr_bit_filters >= MAX_BIT_FILTERS)
713 fatal("too much bit filters\n");
715 opt_mask[nr_bit_filters] = mask;
716 opt_bits[nr_bit_filters] = bits;
720 static uint64_t parse_flag_name(const char *str, int len)
727 if (len <= 8 && !strncmp(str, "compound", len))
728 return BITS_COMPOUND;
730 for (i = 0; i < ARRAY_SIZE(page_flag_names); i++) {
731 if (!page_flag_names[i])
733 if (!strncmp(str, page_flag_names[i] + 2, len))
737 return parse_number(str);
740 static uint64_t parse_flag_names(const char *str, int all)
746 if (*p == ',' || *p == '=' || *p == '\0') {
747 if ((*str != '~') || (*str == '~' && all && *++str))
748 flags |= parse_flag_name(str, p - str);
759 static void parse_bits_mask(const char *optarg)
765 p = strchr(optarg, '=');
768 bits = parse_flag_names(p + 1, 0);
770 mask = parse_flag_names(optarg, 0);
771 bits = parse_flag_names(p + 1, 0);
772 } else if (strchr(optarg, '~')) {
773 mask = parse_flag_names(optarg, 1);
774 bits = parse_flag_names(optarg, 0);
776 mask = parse_flag_names(optarg, 0);
780 add_bits_filter(mask, bits);
784 static struct option opts[] = {
785 { "raw" , 0, NULL, 'r' },
786 { "pid" , 1, NULL, 'p' },
787 { "file" , 1, NULL, 'f' },
788 { "addr" , 1, NULL, 'a' },
789 { "bits" , 1, NULL, 'b' },
790 { "list" , 0, NULL, 'l' },
791 { "list-each" , 0, NULL, 'L' },
792 { "no-summary", 0, NULL, 'N' },
793 { "help" , 0, NULL, 'h' },
794 { NULL , 0, NULL, 0 }
797 int main(int argc, char *argv[])
801 page_size = getpagesize();
803 while ((c = getopt_long(argc, argv,
804 "rp:f:a:b:lLNh", opts, NULL)) != -1) {
816 parse_addr_range(optarg);
819 parse_bits_mask(optarg);
839 if (opt_list && opt_pid)
842 printf("offset\tlen\tflags\n");
844 printf("offset\tflags\n");
849 show_page_range(0, 0); /* drain the buffer */