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
74 /* [32-] kernel hacking assistances */
75 #define KPF_RESERVED 32
76 #define KPF_MLOCKED 33
77 #define KPF_MAPPEDTODISK 34
78 #define KPF_PRIVATE 35
79 #define KPF_PRIVATE_2 36
80 #define KPF_OWNER_PRIVATE 37
82 #define KPF_UNCACHED 39
84 /* [48-] take some arbitrary free slots for expanding overloaded flags
85 * not part of kernel API
87 #define KPF_READAHEAD 48
88 #define KPF_SLOB_FREE 49
89 #define KPF_SLUB_FROZEN 50
90 #define KPF_SLUB_DEBUG 51
92 #define KPF_ALL_BITS ((uint64_t)~0ULL)
93 #define KPF_HACKERS_BITS (0xffffULL << 32)
94 #define KPF_OVERLOADED_BITS (0xffffULL << 48)
95 #define BIT(name) (1ULL << KPF_##name)
96 #define BITS_COMPOUND (BIT(COMPOUND_HEAD) | BIT(COMPOUND_TAIL))
98 static char *page_flag_names[] = {
99 [KPF_LOCKED] = "L:locked",
100 [KPF_ERROR] = "E:error",
101 [KPF_REFERENCED] = "R:referenced",
102 [KPF_UPTODATE] = "U:uptodate",
103 [KPF_DIRTY] = "D:dirty",
105 [KPF_ACTIVE] = "A:active",
106 [KPF_SLAB] = "S:slab",
107 [KPF_WRITEBACK] = "W:writeback",
108 [KPF_RECLAIM] = "I:reclaim",
109 [KPF_BUDDY] = "B:buddy",
111 [KPF_MMAP] = "M:mmap",
112 [KPF_ANON] = "a:anonymous",
113 [KPF_SWAPCACHE] = "s:swapcache",
114 [KPF_SWAPBACKED] = "b:swapbacked",
115 [KPF_COMPOUND_HEAD] = "H:compound_head",
116 [KPF_COMPOUND_TAIL] = "T:compound_tail",
117 [KPF_HUGE] = "G:huge",
118 [KPF_UNEVICTABLE] = "u:unevictable",
119 [KPF_NOPAGE] = "n:nopage",
121 [KPF_RESERVED] = "r:reserved",
122 [KPF_MLOCKED] = "m:mlocked",
123 [KPF_MAPPEDTODISK] = "d:mappedtodisk",
124 [KPF_PRIVATE] = "P:private",
125 [KPF_PRIVATE_2] = "p:private_2",
126 [KPF_OWNER_PRIVATE] = "O:owner_private",
127 [KPF_ARCH] = "h:arch",
128 [KPF_UNCACHED] = "c:uncached",
130 [KPF_READAHEAD] = "I:readahead",
131 [KPF_SLOB_FREE] = "P:slob_free",
132 [KPF_SLUB_FROZEN] = "A:slub_frozen",
133 [KPF_SLUB_DEBUG] = "E:slub_debug",
141 static int opt_raw; /* for kernel developers */
142 static int opt_list; /* list pages (in ranges) */
143 static int opt_no_summary; /* don't show summary */
144 static pid_t opt_pid; /* process to walk */
146 #define MAX_ADDR_RANGES 1024
147 static int nr_addr_ranges;
148 static unsigned long opt_offset[MAX_ADDR_RANGES];
149 static unsigned long opt_size[MAX_ADDR_RANGES];
151 #define MAX_VMAS 10240
153 static unsigned long pg_start[MAX_VMAS];
154 static unsigned long pg_end[MAX_VMAS];
155 static unsigned long voffset;
157 static int pagemap_fd;
159 #define MAX_BIT_FILTERS 64
160 static int nr_bit_filters;
161 static uint64_t opt_mask[MAX_BIT_FILTERS];
162 static uint64_t opt_bits[MAX_BIT_FILTERS];
164 static int page_size;
166 #define PAGES_BATCH (64 << 10) /* 64k pages */
167 static int kpageflags_fd;
169 #define HASH_SHIFT 13
170 #define HASH_SIZE (1 << HASH_SHIFT)
171 #define HASH_MASK (HASH_SIZE - 1)
172 #define HASH_KEY(flags) (flags & HASH_MASK)
174 static unsigned long total_pages;
175 static unsigned long nr_pages[HASH_SIZE];
176 static uint64_t page_flags[HASH_SIZE];
183 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
185 #define min_t(type, x, y) ({ \
188 __min1 < __min2 ? __min1 : __min2; })
190 #define max_t(type, x, y) ({ \
193 __max1 > __max2 ? __max1 : __max2; })
195 static unsigned long pages2mb(unsigned long pages)
197 return (pages * page_size) >> 20;
200 static void fatal(const char *x, ...)
205 vfprintf(stderr, x, ap);
215 static char *page_flag_name(uint64_t flags)
221 for (i = 0, j = 0; i < ARRAY_SIZE(page_flag_names); i++) {
222 present = (flags >> i) & 1;
223 if (!page_flag_names[i]) {
225 fatal("unkown flag bit %d\n", i);
228 buf[j++] = present ? page_flag_names[i][0] : '_';
234 static char *page_flag_longname(uint64_t flags)
236 static char buf[1024];
239 for (i = 0, n = 0; i < ARRAY_SIZE(page_flag_names); i++) {
240 if (!page_flag_names[i])
242 if ((flags >> i) & 1)
243 n += snprintf(buf + n, sizeof(buf) - n, "%s,",
244 page_flag_names[i] + 2);
255 * page list and summary
258 static void show_page_range(unsigned long offset, uint64_t flags)
260 static uint64_t flags0;
261 static unsigned long voff;
262 static unsigned long index;
263 static unsigned long count;
265 if (flags == flags0 && offset == index + count &&
266 (!opt_pid || voffset == voff + count)) {
273 printf("%lx\t", voff);
274 printf("%lx\t%lx\t%s\n",
275 index, count, page_flag_name(flags0));
284 static void show_page(unsigned long offset, uint64_t flags)
287 printf("%lx\t", voffset);
288 printf("%lx\t%s\n", offset, page_flag_name(flags));
291 static void show_summary(void)
295 printf(" flags\tpage-count MB"
296 " symbolic-flags\t\t\tlong-symbolic-flags\n");
298 for (i = 0; i < ARRAY_SIZE(nr_pages); i++) {
300 printf("0x%016llx\t%10lu %8lu %s\t%s\n",
301 (unsigned long long)page_flags[i],
303 pages2mb(nr_pages[i]),
304 page_flag_name(page_flags[i]),
305 page_flag_longname(page_flags[i]));
308 printf(" total\t%10lu %8lu\n",
309 total_pages, pages2mb(total_pages));
317 static int bit_mask_ok(uint64_t flags)
321 for (i = 0; i < nr_bit_filters; i++) {
322 if (opt_bits[i] == KPF_ALL_BITS) {
323 if ((flags & opt_mask[i]) == 0)
326 if ((flags & opt_mask[i]) != opt_bits[i])
334 static uint64_t expand_overloaded_flags(uint64_t flags)
336 /* SLOB/SLUB overload several page flags */
337 if (flags & BIT(SLAB)) {
338 if (flags & BIT(PRIVATE))
339 flags ^= BIT(PRIVATE) | BIT(SLOB_FREE);
340 if (flags & BIT(ACTIVE))
341 flags ^= BIT(ACTIVE) | BIT(SLUB_FROZEN);
342 if (flags & BIT(ERROR))
343 flags ^= BIT(ERROR) | BIT(SLUB_DEBUG);
346 /* PG_reclaim is overloaded as PG_readahead in the read path */
347 if ((flags & (BIT(RECLAIM) | BIT(WRITEBACK))) == BIT(RECLAIM))
348 flags ^= BIT(RECLAIM) | BIT(READAHEAD);
353 static uint64_t well_known_flags(uint64_t flags)
355 /* hide flags intended only for kernel hacker */
356 flags &= ~KPF_HACKERS_BITS;
358 /* hide non-hugeTLB compound pages */
359 if ((flags & BITS_COMPOUND) && !(flags & BIT(HUGE)))
360 flags &= ~BITS_COMPOUND;
370 static int hash_slot(uint64_t flags)
372 int k = HASH_KEY(flags);
375 /* Explicitly reserve slot 0 for flags 0: the following logic
376 * cannot distinguish an unoccupied slot from slot (flags==0).
381 /* search through the remaining (HASH_SIZE-1) slots */
382 for (i = 1; i < ARRAY_SIZE(page_flags); i++, k++) {
383 if (!k || k >= ARRAY_SIZE(page_flags))
385 if (page_flags[k] == 0) {
386 page_flags[k] = flags;
389 if (page_flags[k] == flags)
393 fatal("hash table full: bump up HASH_SHIFT?\n");
397 static void add_page(unsigned long offset, uint64_t flags)
399 flags = expand_overloaded_flags(flags);
402 flags = well_known_flags(flags);
404 if (!bit_mask_ok(flags))
408 show_page_range(offset, flags);
409 else if (opt_list == 2)
410 show_page(offset, flags);
412 nr_pages[hash_slot(flags)]++;
416 static void walk_pfn(unsigned long index, unsigned long count)
422 if (index > ULONG_MAX / KPF_BYTES)
423 fatal("index overflow: %lu\n", index);
425 lseek(kpageflags_fd, index * KPF_BYTES, SEEK_SET);
428 uint64_t kpageflags_buf[KPF_BYTES * PAGES_BATCH];
430 batch = min_t(unsigned long, count, PAGES_BATCH);
431 n = read(kpageflags_fd, kpageflags_buf, batch * KPF_BYTES);
435 perror(PROC_KPAGEFLAGS);
439 if (n % KPF_BYTES != 0)
440 fatal("partial read: %lu bytes\n", n);
443 for (i = 0; i < n; i++)
444 add_page(index + i, kpageflags_buf[i]);
452 #define PAGEMAP_BATCH 4096
453 static unsigned long task_pfn(unsigned long pgoff)
455 static uint64_t buf[PAGEMAP_BATCH];
456 static unsigned long start;
460 if (pgoff < start || pgoff >= start + count) {
461 if (lseek64(pagemap_fd,
462 (uint64_t)pgoff * PM_ENTRY_BYTES,
464 perror("pagemap seek");
467 count = read(pagemap_fd, buf, sizeof(buf));
471 perror("pagemap read");
474 if (count % PM_ENTRY_BYTES) {
475 fatal("pagemap read not aligned.\n");
478 count /= PM_ENTRY_BYTES;
482 pfn = buf[pgoff - start];
483 if (pfn & PM_PRESENT)
484 pfn = PM_PFRAME(pfn);
491 static void walk_task(unsigned long index, unsigned long count)
494 const unsigned long end = index + count;
496 while (index < end) {
498 while (pg_end[i] <= index)
501 if (pg_start[i] >= end)
504 voffset = max_t(unsigned long, pg_start[i], index);
505 index = min_t(unsigned long, pg_end[i], end);
507 assert(voffset < index);
508 for (; voffset < index; voffset++) {
509 unsigned long pfn = task_pfn(voffset);
516 static void add_addr_range(unsigned long offset, unsigned long size)
518 if (nr_addr_ranges >= MAX_ADDR_RANGES)
519 fatal("too many addr ranges\n");
521 opt_offset[nr_addr_ranges] = offset;
522 opt_size[nr_addr_ranges] = min_t(unsigned long, size, ULONG_MAX-offset);
526 static void walk_addr_ranges(void)
530 kpageflags_fd = open(PROC_KPAGEFLAGS, O_RDONLY);
531 if (kpageflags_fd < 0) {
532 perror(PROC_KPAGEFLAGS);
537 add_addr_range(0, ULONG_MAX);
539 for (i = 0; i < nr_addr_ranges; i++)
541 walk_pfn(opt_offset[i], opt_size[i]);
543 walk_task(opt_offset[i], opt_size[i]);
545 close(kpageflags_fd);
553 static const char *page_flag_type(uint64_t flag)
555 if (flag & KPF_HACKERS_BITS)
557 if (flag & KPF_OVERLOADED_BITS)
562 static void usage(void)
567 "page-types [options]\n"
568 " -r|--raw Raw mode, for kernel developers\n"
569 " -a|--addr addr-spec Walk a range of pages\n"
570 " -b|--bits bits-spec Walk pages with specified bits\n"
571 " -p|--pid pid Walk process address space\n"
572 #if 0 /* planned features */
573 " -f|--file filename Walk file address space\n"
575 " -l|--list Show page details in ranges\n"
576 " -L|--list-each Show page details one by one\n"
577 " -N|--no-summary Don't show summay info\n"
578 " -h|--help Show this usage message\n"
580 " N one page at offset N (unit: pages)\n"
581 " N+M pages range from N to N+M-1\n"
582 " N,M pages range from N to M-1\n"
583 " N, pages range from N to end\n"
584 " ,M pages range from 0 to M-1\n"
586 " bit1,bit2 (flags & (bit1|bit2)) != 0\n"
587 " bit1,bit2=bit1 (flags & (bit1|bit2)) == bit1\n"
588 " bit1,~bit2 (flags & (bit1|bit2)) == bit1\n"
589 " =bit1,bit2 flags == (bit1|bit2)\n"
593 for (i = 0, j = 0; i < ARRAY_SIZE(page_flag_names); i++) {
594 if (!page_flag_names[i])
596 printf("%16s%s", page_flag_names[i] + 2,
597 page_flag_type(1ULL << i));
604 "(r) raw mode bits (o) overloaded bits\n");
607 static unsigned long long parse_number(const char *str)
609 unsigned long long n;
611 n = strtoll(str, NULL, 0);
613 if (n == 0 && str[0] != '0')
614 fatal("invalid name or number: %s\n", str);
619 static void parse_pid(const char *str)
624 opt_pid = parse_number(str);
626 sprintf(buf, "/proc/%d/pagemap", opt_pid);
627 pagemap_fd = open(buf, O_RDONLY);
628 if (pagemap_fd < 0) {
633 sprintf(buf, "/proc/%d/maps", opt_pid);
634 file = fopen(buf, "r");
640 while (fgets(buf, sizeof(buf), file) != NULL) {
641 unsigned long vm_start;
642 unsigned long vm_end;
643 unsigned long long pgoff;
649 n = sscanf(buf, "%lx-%lx %c%c%c%c %llx %x:%x %lu",
657 fprintf(stderr, "unexpected line: %s\n", buf);
660 pg_start[nr_vmas] = vm_start / page_size;
661 pg_end[nr_vmas] = vm_end / page_size;
662 if (++nr_vmas >= MAX_VMAS) {
663 fprintf(stderr, "too many VMAs\n");
670 static void parse_file(const char *name)
674 static void parse_addr_range(const char *optarg)
676 unsigned long offset;
680 p = strchr(optarg, ',');
682 p = strchr(optarg, '+');
686 size = parse_number(p + 1);
688 offset = parse_number(optarg);
692 size = parse_number(p + 1);
695 fatal("invalid range: %lu,%lu\n",
701 offset = parse_number(optarg);
705 add_addr_range(offset, size);
708 static void add_bits_filter(uint64_t mask, uint64_t bits)
710 if (nr_bit_filters >= MAX_BIT_FILTERS)
711 fatal("too much bit filters\n");
713 opt_mask[nr_bit_filters] = mask;
714 opt_bits[nr_bit_filters] = bits;
718 static uint64_t parse_flag_name(const char *str, int len)
725 if (len <= 8 && !strncmp(str, "compound", len))
726 return BITS_COMPOUND;
728 for (i = 0; i < ARRAY_SIZE(page_flag_names); i++) {
729 if (!page_flag_names[i])
731 if (!strncmp(str, page_flag_names[i] + 2, len))
735 return parse_number(str);
738 static uint64_t parse_flag_names(const char *str, int all)
744 if (*p == ',' || *p == '=' || *p == '\0') {
745 if ((*str != '~') || (*str == '~' && all && *++str))
746 flags |= parse_flag_name(str, p - str);
757 static void parse_bits_mask(const char *optarg)
763 p = strchr(optarg, '=');
766 bits = parse_flag_names(p + 1, 0);
768 mask = parse_flag_names(optarg, 0);
769 bits = parse_flag_names(p + 1, 0);
770 } else if (strchr(optarg, '~')) {
771 mask = parse_flag_names(optarg, 1);
772 bits = parse_flag_names(optarg, 0);
774 mask = parse_flag_names(optarg, 0);
778 add_bits_filter(mask, bits);
782 static struct option opts[] = {
783 { "raw" , 0, NULL, 'r' },
784 { "pid" , 1, NULL, 'p' },
785 { "file" , 1, NULL, 'f' },
786 { "addr" , 1, NULL, 'a' },
787 { "bits" , 1, NULL, 'b' },
788 { "list" , 0, NULL, 'l' },
789 { "list-each" , 0, NULL, 'L' },
790 { "no-summary", 0, NULL, 'N' },
791 { "help" , 0, NULL, 'h' },
792 { NULL , 0, NULL, 0 }
795 int main(int argc, char *argv[])
799 page_size = getpagesize();
801 while ((c = getopt_long(argc, argv,
802 "rp:f:a:b:lLNh", opts, NULL)) != -1) {
814 parse_addr_range(optarg);
817 parse_bits_mask(optarg);
837 if (opt_list && opt_pid)
840 printf("offset\tlen\tflags\n");
842 printf("offset\tflags\n");
847 show_page_range(0, 0); /* drain the buffer */