Merge branch 'acpi-bus'
[linux-2.6-block.git] / tools / vm / page-types.c
1 /*
2  * page-types: Tool for querying page flags
3  *
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.
7  *
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
11  * more details.
12  *
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.
16  *
17  * Copyright (C) 2009 Intel corporation
18  *
19  * Authors: Wu Fengguang <fengguang.wu@intel.com>
20  */
21
22 #define _FILE_OFFSET_BITS 64
23 #define _GNU_SOURCE
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <unistd.h>
27 #include <stdint.h>
28 #include <stdarg.h>
29 #include <string.h>
30 #include <getopt.h>
31 #include <limits.h>
32 #include <assert.h>
33 #include <ftw.h>
34 #include <time.h>
35 #include <setjmp.h>
36 #include <signal.h>
37 #include <sys/types.h>
38 #include <sys/errno.h>
39 #include <sys/fcntl.h>
40 #include <sys/mount.h>
41 #include <sys/statfs.h>
42 #include <sys/mman.h>
43 #include "../../include/uapi/linux/magic.h"
44 #include "../../include/uapi/linux/kernel-page-flags.h"
45 #include <api/fs/fs.h>
46
47 #ifndef MAX_PATH
48 # define MAX_PATH 256
49 #endif
50
51 #ifndef STR
52 # define _STR(x) #x
53 # define STR(x) _STR(x)
54 #endif
55
56 /*
57  * pagemap kernel ABI bits
58  */
59
60 #define PM_ENTRY_BYTES          8
61 #define PM_PFRAME_BITS          55
62 #define PM_PFRAME_MASK          ((1LL << PM_PFRAME_BITS) - 1)
63 #define PM_PFRAME(x)            ((x) & PM_PFRAME_MASK)
64 #define MAX_SWAPFILES_SHIFT     5
65 #define PM_SWAP_OFFSET(x)       (((x) & PM_PFRAME_MASK) >> MAX_SWAPFILES_SHIFT)
66 #define PM_SOFT_DIRTY           (1ULL << 55)
67 #define PM_MMAP_EXCLUSIVE       (1ULL << 56)
68 #define PM_FILE                 (1ULL << 61)
69 #define PM_SWAP                 (1ULL << 62)
70 #define PM_PRESENT              (1ULL << 63)
71
72 /*
73  * kernel page flags
74  */
75
76 #define KPF_BYTES               8
77 #define PROC_KPAGEFLAGS         "/proc/kpageflags"
78 #define PROC_KPAGECOUNT         "/proc/kpagecount"
79 #define PROC_KPAGECGROUP        "/proc/kpagecgroup"
80
81 #define SYS_KERNEL_MM_PAGE_IDLE "/sys/kernel/mm/page_idle/bitmap"
82
83 /* [32-] kernel hacking assistances */
84 #define KPF_RESERVED            32
85 #define KPF_MLOCKED             33
86 #define KPF_MAPPEDTODISK        34
87 #define KPF_PRIVATE             35
88 #define KPF_PRIVATE_2           36
89 #define KPF_OWNER_PRIVATE       37
90 #define KPF_ARCH                38
91 #define KPF_UNCACHED            39
92 #define KPF_SOFTDIRTY           40
93
94 /* [48-] take some arbitrary free slots for expanding overloaded flags
95  * not part of kernel API
96  */
97 #define KPF_READAHEAD           48
98 #define KPF_SLOB_FREE           49
99 #define KPF_SLUB_FROZEN         50
100 #define KPF_SLUB_DEBUG          51
101 #define KPF_FILE                61
102 #define KPF_SWAP                62
103 #define KPF_MMAP_EXCLUSIVE      63
104
105 #define KPF_ALL_BITS            ((uint64_t)~0ULL)
106 #define KPF_HACKERS_BITS        (0xffffULL << 32)
107 #define KPF_OVERLOADED_BITS     (0xffffULL << 48)
108 #define BIT(name)               (1ULL << KPF_##name)
109 #define BITS_COMPOUND           (BIT(COMPOUND_HEAD) | BIT(COMPOUND_TAIL))
110
111 static const char * const page_flag_names[] = {
112         [KPF_LOCKED]            = "L:locked",
113         [KPF_ERROR]             = "E:error",
114         [KPF_REFERENCED]        = "R:referenced",
115         [KPF_UPTODATE]          = "U:uptodate",
116         [KPF_DIRTY]             = "D:dirty",
117         [KPF_LRU]               = "l:lru",
118         [KPF_ACTIVE]            = "A:active",
119         [KPF_SLAB]              = "S:slab",
120         [KPF_WRITEBACK]         = "W:writeback",
121         [KPF_RECLAIM]           = "I:reclaim",
122         [KPF_BUDDY]             = "B:buddy",
123
124         [KPF_MMAP]              = "M:mmap",
125         [KPF_ANON]              = "a:anonymous",
126         [KPF_SWAPCACHE]         = "s:swapcache",
127         [KPF_SWAPBACKED]        = "b:swapbacked",
128         [KPF_COMPOUND_HEAD]     = "H:compound_head",
129         [KPF_COMPOUND_TAIL]     = "T:compound_tail",
130         [KPF_HUGE]              = "G:huge",
131         [KPF_UNEVICTABLE]       = "u:unevictable",
132         [KPF_HWPOISON]          = "X:hwpoison",
133         [KPF_NOPAGE]            = "n:nopage",
134         [KPF_KSM]               = "x:ksm",
135         [KPF_THP]               = "t:thp",
136         [KPF_BALLOON]           = "o:balloon",
137         [KPF_PGTABLE]           = "g:pgtable",
138         [KPF_ZERO_PAGE]         = "z:zero_page",
139         [KPF_IDLE]              = "i:idle_page",
140
141         [KPF_RESERVED]          = "r:reserved",
142         [KPF_MLOCKED]           = "m:mlocked",
143         [KPF_MAPPEDTODISK]      = "d:mappedtodisk",
144         [KPF_PRIVATE]           = "P:private",
145         [KPF_PRIVATE_2]         = "p:private_2",
146         [KPF_OWNER_PRIVATE]     = "O:owner_private",
147         [KPF_ARCH]              = "h:arch",
148         [KPF_UNCACHED]          = "c:uncached",
149         [KPF_SOFTDIRTY]         = "f:softdirty",
150
151         [KPF_READAHEAD]         = "I:readahead",
152         [KPF_SLOB_FREE]         = "P:slob_free",
153         [KPF_SLUB_FROZEN]       = "A:slub_frozen",
154         [KPF_SLUB_DEBUG]        = "E:slub_debug",
155
156         [KPF_FILE]              = "F:file",
157         [KPF_SWAP]              = "w:swap",
158         [KPF_MMAP_EXCLUSIVE]    = "1:mmap_exclusive",
159 };
160
161
162 static const char * const debugfs_known_mountpoints[] = {
163         "/sys/kernel/debug",
164         "/debug",
165         0,
166 };
167
168 /*
169  * data structures
170  */
171
172 static int              opt_raw;        /* for kernel developers */
173 static int              opt_list;       /* list pages (in ranges) */
174 static int              opt_mark_idle;  /* set accessed bit */
175 static int              opt_no_summary; /* don't show summary */
176 static pid_t            opt_pid;        /* process to walk */
177 const char              *opt_file;      /* file or directory path */
178 static uint64_t         opt_cgroup;     /* cgroup inode */
179 static int              opt_list_cgroup;/* list page cgroup */
180 static int              opt_list_mapcnt;/* list page map count */
181 static const char       *opt_kpageflags;/* kpageflags file to parse */
182
183 #define MAX_ADDR_RANGES 1024
184 static int              nr_addr_ranges;
185 static unsigned long    opt_offset[MAX_ADDR_RANGES];
186 static unsigned long    opt_size[MAX_ADDR_RANGES];
187
188 #define MAX_VMAS        10240
189 static int              nr_vmas;
190 static unsigned long    pg_start[MAX_VMAS];
191 static unsigned long    pg_end[MAX_VMAS];
192
193 #define MAX_BIT_FILTERS 64
194 static int              nr_bit_filters;
195 static uint64_t         opt_mask[MAX_BIT_FILTERS];
196 static uint64_t         opt_bits[MAX_BIT_FILTERS];
197
198 static int              page_size;
199
200 static int              pagemap_fd;
201 static int              kpageflags_fd;
202 static int              kpagecount_fd = -1;
203 static int              kpagecgroup_fd = -1;
204 static int              page_idle_fd = -1;
205
206 static int              opt_hwpoison;
207 static int              opt_unpoison;
208
209 static const char       *hwpoison_debug_fs;
210 static int              hwpoison_inject_fd;
211 static int              hwpoison_forget_fd;
212
213 #define HASH_SHIFT      13
214 #define HASH_SIZE       (1 << HASH_SHIFT)
215 #define HASH_MASK       (HASH_SIZE - 1)
216 #define HASH_KEY(flags) (flags & HASH_MASK)
217
218 static unsigned long    total_pages;
219 static unsigned long    nr_pages[HASH_SIZE];
220 static uint64_t         page_flags[HASH_SIZE];
221
222
223 /*
224  * helper functions
225  */
226
227 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
228
229 #define min_t(type, x, y) ({                    \
230         type __min1 = (x);                      \
231         type __min2 = (y);                      \
232         __min1 < __min2 ? __min1 : __min2; })
233
234 #define max_t(type, x, y) ({                    \
235         type __max1 = (x);                      \
236         type __max2 = (y);                      \
237         __max1 > __max2 ? __max1 : __max2; })
238
239 static unsigned long pages2mb(unsigned long pages)
240 {
241         return (pages * page_size) >> 20;
242 }
243
244 static void fatal(const char *x, ...)
245 {
246         va_list ap;
247
248         va_start(ap, x);
249         vfprintf(stderr, x, ap);
250         va_end(ap);
251         exit(EXIT_FAILURE);
252 }
253
254 static int checked_open(const char *pathname, int flags)
255 {
256         int fd = open(pathname, flags);
257
258         if (fd < 0) {
259                 perror(pathname);
260                 exit(EXIT_FAILURE);
261         }
262
263         return fd;
264 }
265
266 /*
267  * pagemap/kpageflags routines
268  */
269
270 static unsigned long do_u64_read(int fd, const char *name,
271                                  uint64_t *buf,
272                                  unsigned long index,
273                                  unsigned long count)
274 {
275         long bytes;
276
277         if (index > ULONG_MAX / 8)
278                 fatal("index overflow: %lu\n", index);
279
280         bytes = pread(fd, buf, count * 8, (off_t)index * 8);
281         if (bytes < 0) {
282                 perror(name);
283                 exit(EXIT_FAILURE);
284         }
285         if (bytes % 8)
286                 fatal("partial read: %lu bytes\n", bytes);
287
288         return bytes / 8;
289 }
290
291 static unsigned long kpageflags_read(uint64_t *buf,
292                                      unsigned long index,
293                                      unsigned long pages)
294 {
295         return do_u64_read(kpageflags_fd, opt_kpageflags, buf, index, pages);
296 }
297
298 static unsigned long kpagecgroup_read(uint64_t *buf,
299                                       unsigned long index,
300                                       unsigned long pages)
301 {
302         if (kpagecgroup_fd < 0)
303                 return pages;
304
305         return do_u64_read(kpagecgroup_fd, opt_kpageflags, buf, index, pages);
306 }
307
308 static unsigned long kpagecount_read(uint64_t *buf,
309                                      unsigned long index,
310                                      unsigned long pages)
311 {
312         return kpagecount_fd < 0 ? pages :
313                 do_u64_read(kpagecount_fd, PROC_KPAGECOUNT,
314                             buf, index, pages);
315 }
316
317 static unsigned long pagemap_read(uint64_t *buf,
318                                   unsigned long index,
319                                   unsigned long pages)
320 {
321         return do_u64_read(pagemap_fd, "/proc/pid/pagemap", buf, index, pages);
322 }
323
324 static unsigned long pagemap_pfn(uint64_t val)
325 {
326         unsigned long pfn;
327
328         if (val & PM_PRESENT)
329                 pfn = PM_PFRAME(val);
330         else
331                 pfn = 0;
332
333         return pfn;
334 }
335
336 static unsigned long pagemap_swap_offset(uint64_t val)
337 {
338         return val & PM_SWAP ? PM_SWAP_OFFSET(val) : 0;
339 }
340
341 /*
342  * page flag names
343  */
344
345 static char *page_flag_name(uint64_t flags)
346 {
347         static char buf[65];
348         int present;
349         size_t i, j;
350
351         for (i = 0, j = 0; i < ARRAY_SIZE(page_flag_names); i++) {
352                 present = (flags >> i) & 1;
353                 if (!page_flag_names[i]) {
354                         if (present)
355                                 fatal("unknown flag bit %d\n", i);
356                         continue;
357                 }
358                 buf[j++] = present ? page_flag_names[i][0] : '_';
359         }
360
361         return buf;
362 }
363
364 static char *page_flag_longname(uint64_t flags)
365 {
366         static char buf[1024];
367         size_t i, n;
368
369         for (i = 0, n = 0; i < ARRAY_SIZE(page_flag_names); i++) {
370                 if (!page_flag_names[i])
371                         continue;
372                 if ((flags >> i) & 1)
373                         n += snprintf(buf + n, sizeof(buf) - n, "%s,",
374                                         page_flag_names[i] + 2);
375         }
376         if (n)
377                 n--;
378         buf[n] = '\0';
379
380         return buf;
381 }
382
383
384 /*
385  * page list and summary
386  */
387
388 static void show_page_range(unsigned long voffset, unsigned long offset,
389                             unsigned long size, uint64_t flags,
390                             uint64_t cgroup, uint64_t mapcnt)
391 {
392         static uint64_t      flags0;
393         static uint64_t      cgroup0;
394         static uint64_t      mapcnt0;
395         static unsigned long voff;
396         static unsigned long index;
397         static unsigned long count;
398
399         if (flags == flags0 && cgroup == cgroup0 && mapcnt == mapcnt0 &&
400             offset == index + count && size && voffset == voff + count) {
401                 count += size;
402                 return;
403         }
404
405         if (count) {
406                 if (opt_pid)
407                         printf("%lx\t", voff);
408                 if (opt_file)
409                         printf("%lu\t", voff);
410                 if (opt_list_cgroup)
411                         printf("@%llu\t", (unsigned long long)cgroup0);
412                 if (opt_list_mapcnt)
413                         printf("%lu\t", mapcnt0);
414                 printf("%lx\t%lx\t%s\n",
415                                 index, count, page_flag_name(flags0));
416         }
417
418         flags0 = flags;
419         cgroup0 = cgroup;
420         mapcnt0 = mapcnt;
421         index  = offset;
422         voff   = voffset;
423         count  = size;
424 }
425
426 static void flush_page_range(void)
427 {
428         show_page_range(0, 0, 0, 0, 0, 0);
429 }
430
431 static void show_page(unsigned long voffset, unsigned long offset,
432                       uint64_t flags, uint64_t cgroup, uint64_t mapcnt)
433 {
434         if (opt_pid)
435                 printf("%lx\t", voffset);
436         if (opt_file)
437                 printf("%lu\t", voffset);
438         if (opt_list_cgroup)
439                 printf("@%llu\t", (unsigned long long)cgroup);
440         if (opt_list_mapcnt)
441                 printf("%lu\t", mapcnt);
442
443         printf("%lx\t%s\n", offset, page_flag_name(flags));
444 }
445
446 static void show_summary(void)
447 {
448         size_t i;
449
450         printf("             flags\tpage-count       MB"
451                 "  symbolic-flags\t\t\tlong-symbolic-flags\n");
452
453         for (i = 0; i < ARRAY_SIZE(nr_pages); i++) {
454                 if (nr_pages[i])
455                         printf("0x%016llx\t%10lu %8lu  %s\t%s\n",
456                                 (unsigned long long)page_flags[i],
457                                 nr_pages[i],
458                                 pages2mb(nr_pages[i]),
459                                 page_flag_name(page_flags[i]),
460                                 page_flag_longname(page_flags[i]));
461         }
462
463         printf("             total\t%10lu %8lu\n",
464                         total_pages, pages2mb(total_pages));
465 }
466
467
468 /*
469  * page flag filters
470  */
471
472 static int bit_mask_ok(uint64_t flags)
473 {
474         int i;
475
476         for (i = 0; i < nr_bit_filters; i++) {
477                 if (opt_bits[i] == KPF_ALL_BITS) {
478                         if ((flags & opt_mask[i]) == 0)
479                                 return 0;
480                 } else {
481                         if ((flags & opt_mask[i]) != opt_bits[i])
482                                 return 0;
483                 }
484         }
485
486         return 1;
487 }
488
489 static uint64_t expand_overloaded_flags(uint64_t flags, uint64_t pme)
490 {
491         /* SLOB/SLUB overload several page flags */
492         if (flags & BIT(SLAB)) {
493                 if (flags & BIT(PRIVATE))
494                         flags ^= BIT(PRIVATE) | BIT(SLOB_FREE);
495                 if (flags & BIT(ACTIVE))
496                         flags ^= BIT(ACTIVE) | BIT(SLUB_FROZEN);
497                 if (flags & BIT(ERROR))
498                         flags ^= BIT(ERROR) | BIT(SLUB_DEBUG);
499         }
500
501         /* PG_reclaim is overloaded as PG_readahead in the read path */
502         if ((flags & (BIT(RECLAIM) | BIT(WRITEBACK))) == BIT(RECLAIM))
503                 flags ^= BIT(RECLAIM) | BIT(READAHEAD);
504
505         if (pme & PM_SOFT_DIRTY)
506                 flags |= BIT(SOFTDIRTY);
507         if (pme & PM_FILE)
508                 flags |= BIT(FILE);
509         if (pme & PM_SWAP)
510                 flags |= BIT(SWAP);
511         if (pme & PM_MMAP_EXCLUSIVE)
512                 flags |= BIT(MMAP_EXCLUSIVE);
513
514         return flags;
515 }
516
517 static uint64_t well_known_flags(uint64_t flags)
518 {
519         /* hide flags intended only for kernel hacker */
520         flags &= ~KPF_HACKERS_BITS;
521
522         /* hide non-hugeTLB compound pages */
523         if ((flags & BITS_COMPOUND) && !(flags & BIT(HUGE)))
524                 flags &= ~BITS_COMPOUND;
525
526         return flags;
527 }
528
529 static uint64_t kpageflags_flags(uint64_t flags, uint64_t pme)
530 {
531         if (opt_raw)
532                 flags = expand_overloaded_flags(flags, pme);
533         else
534                 flags = well_known_flags(flags);
535
536         return flags;
537 }
538
539 /*
540  * page actions
541  */
542
543 static void prepare_hwpoison_fd(void)
544 {
545         char buf[MAX_PATH + 1];
546
547         hwpoison_debug_fs = debugfs__mount();
548         if (!hwpoison_debug_fs) {
549                 perror("mount debugfs");
550                 exit(EXIT_FAILURE);
551         }
552
553         if (opt_hwpoison && !hwpoison_inject_fd) {
554                 snprintf(buf, MAX_PATH, "%s/hwpoison/corrupt-pfn",
555                         hwpoison_debug_fs);
556                 hwpoison_inject_fd = checked_open(buf, O_WRONLY);
557         }
558
559         if (opt_unpoison && !hwpoison_forget_fd) {
560                 snprintf(buf, MAX_PATH, "%s/hwpoison/unpoison-pfn",
561                         hwpoison_debug_fs);
562                 hwpoison_forget_fd = checked_open(buf, O_WRONLY);
563         }
564 }
565
566 static int hwpoison_page(unsigned long offset)
567 {
568         char buf[100];
569         int len;
570
571         len = sprintf(buf, "0x%lx\n", offset);
572         len = write(hwpoison_inject_fd, buf, len);
573         if (len < 0) {
574                 perror("hwpoison inject");
575                 return len;
576         }
577         return 0;
578 }
579
580 static int unpoison_page(unsigned long offset)
581 {
582         char buf[100];
583         int len;
584
585         len = sprintf(buf, "0x%lx\n", offset);
586         len = write(hwpoison_forget_fd, buf, len);
587         if (len < 0) {
588                 perror("hwpoison forget");
589                 return len;
590         }
591         return 0;
592 }
593
594 static int mark_page_idle(unsigned long offset)
595 {
596         static unsigned long off;
597         static uint64_t buf;
598         int len;
599
600         if ((offset / 64 == off / 64) || buf == 0) {
601                 buf |= 1UL << (offset % 64);
602                 off = offset;
603                 return 0;
604         }
605
606         len = pwrite(page_idle_fd, &buf, 8, 8 * (off / 64));
607         if (len < 0) {
608                 perror("mark page idle");
609                 return len;
610         }
611
612         buf = 1UL << (offset % 64);
613         off = offset;
614
615         return 0;
616 }
617
618 /*
619  * page frame walker
620  */
621
622 static size_t hash_slot(uint64_t flags)
623 {
624         size_t k = HASH_KEY(flags);
625         size_t i;
626
627         /* Explicitly reserve slot 0 for flags 0: the following logic
628          * cannot distinguish an unoccupied slot from slot (flags==0).
629          */
630         if (flags == 0)
631                 return 0;
632
633         /* search through the remaining (HASH_SIZE-1) slots */
634         for (i = 1; i < ARRAY_SIZE(page_flags); i++, k++) {
635                 if (!k || k >= ARRAY_SIZE(page_flags))
636                         k = 1;
637                 if (page_flags[k] == 0) {
638                         page_flags[k] = flags;
639                         return k;
640                 }
641                 if (page_flags[k] == flags)
642                         return k;
643         }
644
645         fatal("hash table full: bump up HASH_SHIFT?\n");
646         exit(EXIT_FAILURE);
647 }
648
649 static void add_page(unsigned long voffset, unsigned long offset,
650                      uint64_t flags, uint64_t cgroup, uint64_t mapcnt,
651                      uint64_t pme)
652 {
653         flags = kpageflags_flags(flags, pme);
654
655         if (!bit_mask_ok(flags))
656                 return;
657
658         if (opt_cgroup && cgroup != (uint64_t)opt_cgroup)
659                 return;
660
661         if (opt_hwpoison)
662                 hwpoison_page(offset);
663         if (opt_unpoison)
664                 unpoison_page(offset);
665
666         if (opt_mark_idle)
667                 mark_page_idle(offset);
668
669         if (opt_list == 1)
670                 show_page_range(voffset, offset, 1, flags, cgroup, mapcnt);
671         else if (opt_list == 2)
672                 show_page(voffset, offset, flags, cgroup, mapcnt);
673
674         nr_pages[hash_slot(flags)]++;
675         total_pages++;
676 }
677
678 #define KPAGEFLAGS_BATCH        (64 << 10)      /* 64k pages */
679 static void walk_pfn(unsigned long voffset,
680                      unsigned long index,
681                      unsigned long count,
682                      uint64_t pme)
683 {
684         uint64_t buf[KPAGEFLAGS_BATCH];
685         uint64_t cgi[KPAGEFLAGS_BATCH];
686         uint64_t cnt[KPAGEFLAGS_BATCH];
687         unsigned long batch;
688         unsigned long pages;
689         unsigned long i;
690
691         /*
692          * kpagecgroup_read() reads only if kpagecgroup were opened, but
693          * /proc/kpagecgroup might even not exist, so it's better to fill
694          * them with zeros here.
695          */
696         if (count == 1)
697                 cgi[0] = 0;
698         else
699                 memset(cgi, 0, sizeof cgi);
700
701         while (count) {
702                 batch = min_t(unsigned long, count, KPAGEFLAGS_BATCH);
703                 pages = kpageflags_read(buf, index, batch);
704                 if (pages == 0)
705                         break;
706
707                 if (kpagecgroup_read(cgi, index, pages) != pages)
708                         fatal("kpagecgroup returned fewer pages than expected");
709
710                 if (kpagecount_read(cnt, index, batch) != pages)
711                         fatal("kpagecount returned fewer pages than expected");
712
713                 for (i = 0; i < pages; i++)
714                         add_page(voffset + i, index + i,
715                                  buf[i], cgi[i], cnt[i], pme);
716
717                 index += pages;
718                 count -= pages;
719         }
720 }
721
722 static void walk_swap(unsigned long voffset, uint64_t pme)
723 {
724         uint64_t flags = kpageflags_flags(0, pme);
725
726         if (!bit_mask_ok(flags))
727                 return;
728
729         if (opt_cgroup)
730                 return;
731
732         if (opt_list == 1)
733                 show_page_range(voffset, pagemap_swap_offset(pme),
734                                 1, flags, 0, 0);
735         else if (opt_list == 2)
736                 show_page(voffset, pagemap_swap_offset(pme), flags, 0, 0);
737
738         nr_pages[hash_slot(flags)]++;
739         total_pages++;
740 }
741
742 #define PAGEMAP_BATCH   (64 << 10)
743 static void walk_vma(unsigned long index, unsigned long count)
744 {
745         uint64_t buf[PAGEMAP_BATCH];
746         unsigned long batch;
747         unsigned long pages;
748         unsigned long pfn;
749         unsigned long i;
750
751         while (count) {
752                 batch = min_t(unsigned long, count, PAGEMAP_BATCH);
753                 pages = pagemap_read(buf, index, batch);
754                 if (pages == 0)
755                         break;
756
757                 for (i = 0; i < pages; i++) {
758                         pfn = pagemap_pfn(buf[i]);
759                         if (pfn)
760                                 walk_pfn(index + i, pfn, 1, buf[i]);
761                         if (buf[i] & PM_SWAP)
762                                 walk_swap(index + i, buf[i]);
763                 }
764
765                 index += pages;
766                 count -= pages;
767         }
768 }
769
770 static void walk_task(unsigned long index, unsigned long count)
771 {
772         const unsigned long end = index + count;
773         unsigned long start;
774         int i = 0;
775
776         while (index < end) {
777
778                 while (pg_end[i] <= index)
779                         if (++i >= nr_vmas)
780                                 return;
781                 if (pg_start[i] >= end)
782                         return;
783
784                 start = max_t(unsigned long, pg_start[i], index);
785                 index = min_t(unsigned long, pg_end[i], end);
786
787                 assert(start < index);
788                 walk_vma(start, index - start);
789         }
790 }
791
792 static void add_addr_range(unsigned long offset, unsigned long size)
793 {
794         if (nr_addr_ranges >= MAX_ADDR_RANGES)
795                 fatal("too many addr ranges\n");
796
797         opt_offset[nr_addr_ranges] = offset;
798         opt_size[nr_addr_ranges] = min_t(unsigned long, size, ULONG_MAX-offset);
799         nr_addr_ranges++;
800 }
801
802 static void walk_addr_ranges(void)
803 {
804         int i;
805
806         kpageflags_fd = checked_open(opt_kpageflags, O_RDONLY);
807
808         if (!nr_addr_ranges)
809                 add_addr_range(0, ULONG_MAX);
810
811         for (i = 0; i < nr_addr_ranges; i++)
812                 if (!opt_pid)
813                         walk_pfn(opt_offset[i], opt_offset[i], opt_size[i], 0);
814                 else
815                         walk_task(opt_offset[i], opt_size[i]);
816
817         if (opt_mark_idle)
818                 mark_page_idle(0);
819
820         close(kpageflags_fd);
821 }
822
823
824 /*
825  * user interface
826  */
827
828 static const char *page_flag_type(uint64_t flag)
829 {
830         if (flag & KPF_HACKERS_BITS)
831                 return "(r)";
832         if (flag & KPF_OVERLOADED_BITS)
833                 return "(o)";
834         return "   ";
835 }
836
837 static void usage(void)
838 {
839         size_t i, j;
840
841         printf(
842 "page-types [options]\n"
843 "            -r|--raw                   Raw mode, for kernel developers\n"
844 "            -d|--describe flags        Describe flags\n"
845 "            -a|--addr    addr-spec     Walk a range of pages\n"
846 "            -b|--bits    bits-spec     Walk pages with specified bits\n"
847 "            -c|--cgroup  path|@inode   Walk pages within memory cgroup\n"
848 "            -p|--pid     pid           Walk process address space\n"
849 "            -f|--file    filename      Walk file address space\n"
850 "            -i|--mark-idle             Mark pages idle\n"
851 "            -l|--list                  Show page details in ranges\n"
852 "            -L|--list-each             Show page details one by one\n"
853 "            -C|--list-cgroup           Show cgroup inode for pages\n"
854 "            -M|--list-mapcnt           Show page map count\n"
855 "            -N|--no-summary            Don't show summary info\n"
856 "            -X|--hwpoison              hwpoison pages\n"
857 "            -x|--unpoison              unpoison pages\n"
858 "            -F|--kpageflags filename   kpageflags file to parse\n"
859 "            -h|--help                  Show this usage message\n"
860 "flags:\n"
861 "            0x10                       bitfield format, e.g.\n"
862 "            anon                       bit-name, e.g.\n"
863 "            0x10,anon                  comma-separated list, e.g.\n"
864 "addr-spec:\n"
865 "            N                          one page at offset N (unit: pages)\n"
866 "            N+M                        pages range from N to N+M-1\n"
867 "            N,M                        pages range from N to M-1\n"
868 "            N,                         pages range from N to end\n"
869 "            ,M                         pages range from 0 to M-1\n"
870 "bits-spec:\n"
871 "            bit1,bit2                  (flags & (bit1|bit2)) != 0\n"
872 "            bit1,bit2=bit1             (flags & (bit1|bit2)) == bit1\n"
873 "            bit1,~bit2                 (flags & (bit1|bit2)) == bit1\n"
874 "            =bit1,bit2                 flags == (bit1|bit2)\n"
875 "bit-names:\n"
876         );
877
878         for (i = 0, j = 0; i < ARRAY_SIZE(page_flag_names); i++) {
879                 if (!page_flag_names[i])
880                         continue;
881                 printf("%16s%s", page_flag_names[i] + 2,
882                                  page_flag_type(1ULL << i));
883                 if (++j > 3) {
884                         j = 0;
885                         putchar('\n');
886                 }
887         }
888         printf("\n                                   "
889                 "(r) raw mode bits  (o) overloaded bits\n");
890 }
891
892 static unsigned long long parse_number(const char *str)
893 {
894         unsigned long long n;
895
896         n = strtoll(str, NULL, 0);
897
898         if (n == 0 && str[0] != '0')
899                 fatal("invalid name or number: %s\n", str);
900
901         return n;
902 }
903
904 static void parse_pid(const char *str)
905 {
906         FILE *file;
907         char buf[5000];
908
909         opt_pid = parse_number(str);
910
911         sprintf(buf, "/proc/%d/pagemap", opt_pid);
912         pagemap_fd = checked_open(buf, O_RDONLY);
913
914         sprintf(buf, "/proc/%d/maps", opt_pid);
915         file = fopen(buf, "r");
916         if (!file) {
917                 perror(buf);
918                 exit(EXIT_FAILURE);
919         }
920
921         while (fgets(buf, sizeof(buf), file) != NULL) {
922                 unsigned long vm_start;
923                 unsigned long vm_end;
924                 unsigned long long pgoff;
925                 int major, minor;
926                 char r, w, x, s;
927                 unsigned long ino;
928                 int n;
929
930                 n = sscanf(buf, "%lx-%lx %c%c%c%c %llx %x:%x %lu",
931                            &vm_start,
932                            &vm_end,
933                            &r, &w, &x, &s,
934                            &pgoff,
935                            &major, &minor,
936                            &ino);
937                 if (n < 10) {
938                         fprintf(stderr, "unexpected line: %s\n", buf);
939                         continue;
940                 }
941                 pg_start[nr_vmas] = vm_start / page_size;
942                 pg_end[nr_vmas] = vm_end / page_size;
943                 if (++nr_vmas >= MAX_VMAS) {
944                         fprintf(stderr, "too many VMAs\n");
945                         break;
946                 }
947         }
948         fclose(file);
949 }
950
951 static void show_file(const char *name, const struct stat *st)
952 {
953         unsigned long long size = st->st_size;
954         char atime[64], mtime[64];
955         long now = time(NULL);
956
957         printf("%s\tInode: %u\tSize: %llu (%llu pages)\n",
958                         name, (unsigned)st->st_ino,
959                         size, (size + page_size - 1) / page_size);
960
961         strftime(atime, sizeof(atime), "%c", localtime(&st->st_atime));
962         strftime(mtime, sizeof(mtime), "%c", localtime(&st->st_mtime));
963
964         printf("Modify: %s (%ld seconds ago)\nAccess: %s (%ld seconds ago)\n",
965                         mtime, now - st->st_mtime,
966                         atime, now - st->st_atime);
967 }
968
969 static sigjmp_buf sigbus_jmp;
970
971 static void * volatile sigbus_addr;
972
973 static void sigbus_handler(int sig, siginfo_t *info, void *ucontex)
974 {
975         (void)sig;
976         (void)ucontex;
977         sigbus_addr = info ? info->si_addr : NULL;
978         siglongjmp(sigbus_jmp, 1);
979 }
980
981 static struct sigaction sigbus_action = {
982         .sa_sigaction = sigbus_handler,
983         .sa_flags = SA_SIGINFO,
984 };
985
986 static void walk_file(const char *name, const struct stat *st)
987 {
988         uint8_t vec[PAGEMAP_BATCH];
989         uint64_t buf[PAGEMAP_BATCH], flags;
990         uint64_t cgroup = 0;
991         uint64_t mapcnt = 0;
992         unsigned long nr_pages, pfn, i;
993         off_t off, end = st->st_size;
994         int fd;
995         ssize_t len;
996         void *ptr;
997         int first = 1;
998
999         fd = checked_open(name, O_RDONLY|O_NOATIME|O_NOFOLLOW);
1000
1001         for (off = 0; off < end; off += len) {
1002                 nr_pages = (end - off + page_size - 1) / page_size;
1003                 if (nr_pages > PAGEMAP_BATCH)
1004                         nr_pages = PAGEMAP_BATCH;
1005                 len = nr_pages * page_size;
1006
1007                 ptr = mmap(NULL, len, PROT_READ, MAP_SHARED, fd, off);
1008                 if (ptr == MAP_FAILED)
1009                         fatal("mmap failed: %s", name);
1010
1011                 /* determine cached pages */
1012                 if (mincore(ptr, len, vec))
1013                         fatal("mincore failed: %s", name);
1014
1015                 /* turn off readahead */
1016                 if (madvise(ptr, len, MADV_RANDOM))
1017                         fatal("madvice failed: %s", name);
1018
1019                 if (sigsetjmp(sigbus_jmp, 1)) {
1020                         end = off + sigbus_addr ? sigbus_addr - ptr : 0;
1021                         fprintf(stderr, "got sigbus at offset %lld: %s\n",
1022                                         (long long)end, name);
1023                         goto got_sigbus;
1024                 }
1025
1026                 /* populate ptes */
1027                 for (i = 0; i < nr_pages ; i++) {
1028                         if (vec[i] & 1)
1029                                 (void)*(volatile int *)(ptr + i * page_size);
1030                 }
1031 got_sigbus:
1032
1033                 /* turn off harvesting reference bits */
1034                 if (madvise(ptr, len, MADV_SEQUENTIAL))
1035                         fatal("madvice failed: %s", name);
1036
1037                 if (pagemap_read(buf, (unsigned long)ptr / page_size,
1038                                         nr_pages) != nr_pages)
1039                         fatal("cannot read pagemap");
1040
1041                 munmap(ptr, len);
1042
1043                 for (i = 0; i < nr_pages; i++) {
1044                         pfn = pagemap_pfn(buf[i]);
1045                         if (!pfn)
1046                                 continue;
1047                         if (!kpageflags_read(&flags, pfn, 1))
1048                                 continue;
1049                         if (!kpagecgroup_read(&cgroup, pfn, 1))
1050                                 fatal("kpagecgroup_read failed");
1051                         if (!kpagecount_read(&mapcnt, pfn, 1))
1052                                 fatal("kpagecount_read failed");
1053                         if (first && opt_list) {
1054                                 first = 0;
1055                                 flush_page_range();
1056                                 show_file(name, st);
1057                         }
1058                         add_page(off / page_size + i, pfn,
1059                                  flags, cgroup, mapcnt, buf[i]);
1060                 }
1061         }
1062
1063         close(fd);
1064 }
1065
1066 int walk_tree(const char *name, const struct stat *st, int type, struct FTW *f)
1067 {
1068         (void)f;
1069         switch (type) {
1070         case FTW_F:
1071                 if (S_ISREG(st->st_mode))
1072                         walk_file(name, st);
1073                 break;
1074         case FTW_DNR:
1075                 fprintf(stderr, "cannot read dir: %s\n", name);
1076                 break;
1077         }
1078         return 0;
1079 }
1080
1081 static void walk_page_cache(void)
1082 {
1083         struct stat st;
1084
1085         kpageflags_fd = checked_open(opt_kpageflags, O_RDONLY);
1086         pagemap_fd = checked_open("/proc/self/pagemap", O_RDONLY);
1087         sigaction(SIGBUS, &sigbus_action, NULL);
1088
1089         if (stat(opt_file, &st))
1090                 fatal("stat failed: %s\n", opt_file);
1091
1092         if (S_ISREG(st.st_mode)) {
1093                 walk_file(opt_file, &st);
1094         } else if (S_ISDIR(st.st_mode)) {
1095                 /* do not follow symlinks and mountpoints */
1096                 if (nftw(opt_file, walk_tree, 64, FTW_MOUNT | FTW_PHYS) < 0)
1097                         fatal("nftw failed: %s\n", opt_file);
1098         } else
1099                 fatal("unhandled file type: %s\n", opt_file);
1100
1101         close(kpageflags_fd);
1102         close(pagemap_fd);
1103         signal(SIGBUS, SIG_DFL);
1104 }
1105
1106 static void parse_file(const char *name)
1107 {
1108         opt_file = name;
1109 }
1110
1111 static void parse_cgroup(const char *path)
1112 {
1113         if (path[0] == '@') {
1114                 opt_cgroup = parse_number(path + 1);
1115                 return;
1116         }
1117
1118         struct stat st;
1119
1120         if (stat(path, &st))
1121                 fatal("stat failed: %s: %m\n", path);
1122
1123         if (!S_ISDIR(st.st_mode))
1124                 fatal("cgroup supposed to be a directory: %s\n", path);
1125
1126         opt_cgroup = st.st_ino;
1127 }
1128
1129 static void parse_addr_range(const char *optarg)
1130 {
1131         unsigned long offset;
1132         unsigned long size;
1133         char *p;
1134
1135         p = strchr(optarg, ',');
1136         if (!p)
1137                 p = strchr(optarg, '+');
1138
1139         if (p == optarg) {
1140                 offset = 0;
1141                 size   = parse_number(p + 1);
1142         } else if (p) {
1143                 offset = parse_number(optarg);
1144                 if (p[1] == '\0')
1145                         size = ULONG_MAX;
1146                 else {
1147                         size = parse_number(p + 1);
1148                         if (*p == ',') {
1149                                 if (size < offset)
1150                                         fatal("invalid range: %lu,%lu\n",
1151                                                         offset, size);
1152                                 size -= offset;
1153                         }
1154                 }
1155         } else {
1156                 offset = parse_number(optarg);
1157                 size   = 1;
1158         }
1159
1160         add_addr_range(offset, size);
1161 }
1162
1163 static void add_bits_filter(uint64_t mask, uint64_t bits)
1164 {
1165         if (nr_bit_filters >= MAX_BIT_FILTERS)
1166                 fatal("too much bit filters\n");
1167
1168         opt_mask[nr_bit_filters] = mask;
1169         opt_bits[nr_bit_filters] = bits;
1170         nr_bit_filters++;
1171 }
1172
1173 static uint64_t parse_flag_name(const char *str, int len)
1174 {
1175         size_t i;
1176
1177         if (!*str || !len)
1178                 return 0;
1179
1180         if (len <= 8 && !strncmp(str, "compound", len))
1181                 return BITS_COMPOUND;
1182
1183         for (i = 0; i < ARRAY_SIZE(page_flag_names); i++) {
1184                 if (!page_flag_names[i])
1185                         continue;
1186                 if (!strncmp(str, page_flag_names[i] + 2, len))
1187                         return 1ULL << i;
1188         }
1189
1190         return parse_number(str);
1191 }
1192
1193 static uint64_t parse_flag_names(const char *str, int all)
1194 {
1195         const char *p    = str;
1196         uint64_t   flags = 0;
1197
1198         while (1) {
1199                 if (*p == ',' || *p == '=' || *p == '\0') {
1200                         if ((*str != '~') || (*str == '~' && all && *++str))
1201                                 flags |= parse_flag_name(str, p - str);
1202                         if (*p != ',')
1203                                 break;
1204                         str = p + 1;
1205                 }
1206                 p++;
1207         }
1208
1209         return flags;
1210 }
1211
1212 static void parse_bits_mask(const char *optarg)
1213 {
1214         uint64_t mask;
1215         uint64_t bits;
1216         const char *p;
1217
1218         p = strchr(optarg, '=');
1219         if (p == optarg) {
1220                 mask = KPF_ALL_BITS;
1221                 bits = parse_flag_names(p + 1, 0);
1222         } else if (p) {
1223                 mask = parse_flag_names(optarg, 0);
1224                 bits = parse_flag_names(p + 1, 0);
1225         } else if (strchr(optarg, '~')) {
1226                 mask = parse_flag_names(optarg, 1);
1227                 bits = parse_flag_names(optarg, 0);
1228         } else {
1229                 mask = parse_flag_names(optarg, 0);
1230                 bits = KPF_ALL_BITS;
1231         }
1232
1233         add_bits_filter(mask, bits);
1234 }
1235
1236 static void parse_kpageflags(const char *name)
1237 {
1238         opt_kpageflags = name;
1239 }
1240
1241 static void describe_flags(const char *optarg)
1242 {
1243         uint64_t flags = parse_flag_names(optarg, 0);
1244
1245         printf("0x%016llx\t%s\t%s\n",
1246                 (unsigned long long)flags,
1247                 page_flag_name(flags),
1248                 page_flag_longname(flags));
1249 }
1250
1251 static const struct option opts[] = {
1252         { "raw"       , 0, NULL, 'r' },
1253         { "pid"       , 1, NULL, 'p' },
1254         { "file"      , 1, NULL, 'f' },
1255         { "addr"      , 1, NULL, 'a' },
1256         { "bits"      , 1, NULL, 'b' },
1257         { "cgroup"    , 1, NULL, 'c' },
1258         { "describe"  , 1, NULL, 'd' },
1259         { "mark-idle" , 0, NULL, 'i' },
1260         { "list"      , 0, NULL, 'l' },
1261         { "list-each" , 0, NULL, 'L' },
1262         { "list-cgroup", 0, NULL, 'C' },
1263         { "list-mapcnt", 0, NULL, 'M' },
1264         { "no-summary", 0, NULL, 'N' },
1265         { "hwpoison"  , 0, NULL, 'X' },
1266         { "unpoison"  , 0, NULL, 'x' },
1267         { "kpageflags", 0, NULL, 'F' },
1268         { "help"      , 0, NULL, 'h' },
1269         { NULL        , 0, NULL, 0 }
1270 };
1271
1272 int main(int argc, char *argv[])
1273 {
1274         int c;
1275
1276         page_size = getpagesize();
1277
1278         while ((c = getopt_long(argc, argv,
1279                                 "rp:f:a:b:d:c:CilLMNXxF:h",
1280                                 opts, NULL)) != -1) {
1281                 switch (c) {
1282                 case 'r':
1283                         opt_raw = 1;
1284                         break;
1285                 case 'p':
1286                         parse_pid(optarg);
1287                         break;
1288                 case 'f':
1289                         parse_file(optarg);
1290                         break;
1291                 case 'a':
1292                         parse_addr_range(optarg);
1293                         break;
1294                 case 'b':
1295                         parse_bits_mask(optarg);
1296                         break;
1297                 case 'c':
1298                         parse_cgroup(optarg);
1299                         break;
1300                 case 'C':
1301                         opt_list_cgroup = 1;
1302                         break;
1303                 case 'd':
1304                         describe_flags(optarg);
1305                         exit(0);
1306                 case 'i':
1307                         opt_mark_idle = 1;
1308                         break;
1309                 case 'l':
1310                         opt_list = 1;
1311                         break;
1312                 case 'L':
1313                         opt_list = 2;
1314                         break;
1315                 case 'M':
1316                         opt_list_mapcnt = 1;
1317                         break;
1318                 case 'N':
1319                         opt_no_summary = 1;
1320                         break;
1321                 case 'X':
1322                         opt_hwpoison = 1;
1323                         prepare_hwpoison_fd();
1324                         break;
1325                 case 'x':
1326                         opt_unpoison = 1;
1327                         prepare_hwpoison_fd();
1328                         break;
1329                 case 'F':
1330                         parse_kpageflags(optarg);
1331                         break;
1332                 case 'h':
1333                         usage();
1334                         exit(0);
1335                 default:
1336                         usage();
1337                         exit(1);
1338                 }
1339         }
1340
1341         if (!opt_kpageflags)
1342                 opt_kpageflags = PROC_KPAGEFLAGS;
1343
1344         if (opt_cgroup || opt_list_cgroup)
1345                 kpagecgroup_fd = checked_open(PROC_KPAGECGROUP, O_RDONLY);
1346
1347         if (opt_list && opt_list_mapcnt)
1348                 kpagecount_fd = checked_open(PROC_KPAGECOUNT, O_RDONLY);
1349
1350         if (opt_mark_idle && opt_file)
1351                 page_idle_fd = checked_open(SYS_KERNEL_MM_PAGE_IDLE, O_RDWR);
1352
1353         if (opt_list && opt_pid)
1354                 printf("voffset\t");
1355         if (opt_list && opt_file)
1356                 printf("foffset\t");
1357         if (opt_list && opt_list_cgroup)
1358                 printf("cgroup\t");
1359         if (opt_list && opt_list_mapcnt)
1360                 printf("map-cnt\t");
1361
1362         if (opt_list == 1)
1363                 printf("offset\tlen\tflags\n");
1364         if (opt_list == 2)
1365                 printf("offset\tflags\n");
1366
1367         if (opt_file)
1368                 walk_page_cache();
1369         else
1370                 walk_addr_ranges();
1371
1372         if (opt_list == 1)
1373                 flush_page_range();
1374
1375         if (opt_no_summary)
1376                 return 0;
1377
1378         if (opt_list)
1379                 printf("\n\n");
1380
1381         show_summary();
1382
1383         if (opt_list_mapcnt)
1384                 close(kpagecount_fd);
1385
1386         if (page_idle_fd >= 0)
1387                 close(page_idle_fd);
1388
1389         return 0;
1390 }