page-types: introduce kpageflags_flags()
[safe/jmp/linux-2.6] / Documentation / vm / page-types.c
1 /*
2  * page-types: Tool for querying page flags
3  *
4  * Copyright (C) 2009 Intel corporation
5  *
6  * Authors: Wu Fengguang <fengguang.wu@intel.com>
7  *
8  * Released under the General Public License (GPL).
9  */
10
11 #define _LARGEFILE64_SOURCE
12 #include <stdio.h>
13 #include <stdlib.h>
14 #include <unistd.h>
15 #include <stdint.h>
16 #include <stdarg.h>
17 #include <string.h>
18 #include <getopt.h>
19 #include <limits.h>
20 #include <assert.h>
21 #include <sys/types.h>
22 #include <sys/errno.h>
23 #include <sys/fcntl.h>
24
25
26 /*
27  * pagemap kernel ABI bits
28  */
29
30 #define PM_ENTRY_BYTES      sizeof(uint64_t)
31 #define PM_STATUS_BITS      3
32 #define PM_STATUS_OFFSET    (64 - PM_STATUS_BITS)
33 #define PM_STATUS_MASK      (((1LL << PM_STATUS_BITS) - 1) << PM_STATUS_OFFSET)
34 #define PM_STATUS(nr)       (((nr) << PM_STATUS_OFFSET) & PM_STATUS_MASK)
35 #define PM_PSHIFT_BITS      6
36 #define PM_PSHIFT_OFFSET    (PM_STATUS_OFFSET - PM_PSHIFT_BITS)
37 #define PM_PSHIFT_MASK      (((1LL << PM_PSHIFT_BITS) - 1) << PM_PSHIFT_OFFSET)
38 #define PM_PSHIFT(x)        (((u64) (x) << PM_PSHIFT_OFFSET) & PM_PSHIFT_MASK)
39 #define PM_PFRAME_MASK      ((1LL << PM_PSHIFT_OFFSET) - 1)
40 #define PM_PFRAME(x)        ((x) & PM_PFRAME_MASK)
41
42 #define PM_PRESENT          PM_STATUS(4LL)
43 #define PM_SWAP             PM_STATUS(2LL)
44
45
46 /*
47  * kernel page flags
48  */
49
50 #define KPF_BYTES               8
51 #define PROC_KPAGEFLAGS         "/proc/kpageflags"
52
53 /* copied from kpageflags_read() */
54 #define KPF_LOCKED              0
55 #define KPF_ERROR               1
56 #define KPF_REFERENCED          2
57 #define KPF_UPTODATE            3
58 #define KPF_DIRTY               4
59 #define KPF_LRU                 5
60 #define KPF_ACTIVE              6
61 #define KPF_SLAB                7
62 #define KPF_WRITEBACK           8
63 #define KPF_RECLAIM             9
64 #define KPF_BUDDY               10
65
66 /* [11-20] new additions in 2.6.31 */
67 #define KPF_MMAP                11
68 #define KPF_ANON                12
69 #define KPF_SWAPCACHE           13
70 #define KPF_SWAPBACKED          14
71 #define KPF_COMPOUND_HEAD       15
72 #define KPF_COMPOUND_TAIL       16
73 #define KPF_HUGE                17
74 #define KPF_UNEVICTABLE         18
75 #define KPF_HWPOISON            19
76 #define KPF_NOPAGE              20
77 #define KPF_KSM                 21
78
79 /* [32-] kernel hacking assistances */
80 #define KPF_RESERVED            32
81 #define KPF_MLOCKED             33
82 #define KPF_MAPPEDTODISK        34
83 #define KPF_PRIVATE             35
84 #define KPF_PRIVATE_2           36
85 #define KPF_OWNER_PRIVATE       37
86 #define KPF_ARCH                38
87 #define KPF_UNCACHED            39
88
89 /* [48-] take some arbitrary free slots for expanding overloaded flags
90  * not part of kernel API
91  */
92 #define KPF_READAHEAD           48
93 #define KPF_SLOB_FREE           49
94 #define KPF_SLUB_FROZEN         50
95 #define KPF_SLUB_DEBUG          51
96
97 #define KPF_ALL_BITS            ((uint64_t)~0ULL)
98 #define KPF_HACKERS_BITS        (0xffffULL << 32)
99 #define KPF_OVERLOADED_BITS     (0xffffULL << 48)
100 #define BIT(name)               (1ULL << KPF_##name)
101 #define BITS_COMPOUND           (BIT(COMPOUND_HEAD) | BIT(COMPOUND_TAIL))
102
103 static char *page_flag_names[] = {
104         [KPF_LOCKED]            = "L:locked",
105         [KPF_ERROR]             = "E:error",
106         [KPF_REFERENCED]        = "R:referenced",
107         [KPF_UPTODATE]          = "U:uptodate",
108         [KPF_DIRTY]             = "D:dirty",
109         [KPF_LRU]               = "l:lru",
110         [KPF_ACTIVE]            = "A:active",
111         [KPF_SLAB]              = "S:slab",
112         [KPF_WRITEBACK]         = "W:writeback",
113         [KPF_RECLAIM]           = "I:reclaim",
114         [KPF_BUDDY]             = "B:buddy",
115
116         [KPF_MMAP]              = "M:mmap",
117         [KPF_ANON]              = "a:anonymous",
118         [KPF_SWAPCACHE]         = "s:swapcache",
119         [KPF_SWAPBACKED]        = "b:swapbacked",
120         [KPF_COMPOUND_HEAD]     = "H:compound_head",
121         [KPF_COMPOUND_TAIL]     = "T:compound_tail",
122         [KPF_HUGE]              = "G:huge",
123         [KPF_UNEVICTABLE]       = "u:unevictable",
124         [KPF_HWPOISON]          = "X:hwpoison",
125         [KPF_NOPAGE]            = "n:nopage",
126         [KPF_KSM]               = "x:ksm",
127
128         [KPF_RESERVED]          = "r:reserved",
129         [KPF_MLOCKED]           = "m:mlocked",
130         [KPF_MAPPEDTODISK]      = "d:mappedtodisk",
131         [KPF_PRIVATE]           = "P:private",
132         [KPF_PRIVATE_2]         = "p:private_2",
133         [KPF_OWNER_PRIVATE]     = "O:owner_private",
134         [KPF_ARCH]              = "h:arch",
135         [KPF_UNCACHED]          = "c:uncached",
136
137         [KPF_READAHEAD]         = "I:readahead",
138         [KPF_SLOB_FREE]         = "P:slob_free",
139         [KPF_SLUB_FROZEN]       = "A:slub_frozen",
140         [KPF_SLUB_DEBUG]        = "E:slub_debug",
141 };
142
143
144 /*
145  * data structures
146  */
147
148 static int              opt_raw;        /* for kernel developers */
149 static int              opt_list;       /* list pages (in ranges) */
150 static int              opt_no_summary; /* don't show summary */
151 static pid_t            opt_pid;        /* process to walk */
152
153 #define MAX_ADDR_RANGES 1024
154 static int              nr_addr_ranges;
155 static unsigned long    opt_offset[MAX_ADDR_RANGES];
156 static unsigned long    opt_size[MAX_ADDR_RANGES];
157
158 #define MAX_VMAS        10240
159 static int              nr_vmas;
160 static unsigned long    pg_start[MAX_VMAS];
161 static unsigned long    pg_end[MAX_VMAS];
162
163 #define MAX_BIT_FILTERS 64
164 static int              nr_bit_filters;
165 static uint64_t         opt_mask[MAX_BIT_FILTERS];
166 static uint64_t         opt_bits[MAX_BIT_FILTERS];
167
168 static int              page_size;
169
170 static int              pagemap_fd;
171 static int              kpageflags_fd;
172
173 #define HASH_SHIFT      13
174 #define HASH_SIZE       (1 << HASH_SHIFT)
175 #define HASH_MASK       (HASH_SIZE - 1)
176 #define HASH_KEY(flags) (flags & HASH_MASK)
177
178 static unsigned long    total_pages;
179 static unsigned long    nr_pages[HASH_SIZE];
180 static uint64_t         page_flags[HASH_SIZE];
181
182
183 /*
184  * helper functions
185  */
186
187 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
188
189 #define min_t(type, x, y) ({                    \
190         type __min1 = (x);                      \
191         type __min2 = (y);                      \
192         __min1 < __min2 ? __min1 : __min2; })
193
194 #define max_t(type, x, y) ({                    \
195         type __max1 = (x);                      \
196         type __max2 = (y);                      \
197         __max1 > __max2 ? __max1 : __max2; })
198
199 static unsigned long pages2mb(unsigned long pages)
200 {
201         return (pages * page_size) >> 20;
202 }
203
204 static void fatal(const char *x, ...)
205 {
206         va_list ap;
207
208         va_start(ap, x);
209         vfprintf(stderr, x, ap);
210         va_end(ap);
211         exit(EXIT_FAILURE);
212 }
213
214 int checked_open(const char *pathname, int flags)
215 {
216         int fd = open(pathname, flags);
217
218         if (fd < 0) {
219                 perror(pathname);
220                 exit(EXIT_FAILURE);
221         }
222
223         return fd;
224 }
225
226 /*
227  * pagemap/kpageflags routines
228  */
229
230 static unsigned long do_u64_read(int fd, char *name,
231                                  uint64_t *buf,
232                                  unsigned long index,
233                                  unsigned long count)
234 {
235         long bytes;
236
237         if (index > ULONG_MAX / 8)
238                 fatal("index overflow: %lu\n", index);
239
240         if (lseek(fd, index * 8, SEEK_SET) < 0) {
241                 perror(name);
242                 exit(EXIT_FAILURE);
243         }
244
245         bytes = read(fd, buf, count * 8);
246         if (bytes < 0) {
247                 perror(name);
248                 exit(EXIT_FAILURE);
249         }
250         if (bytes % 8)
251                 fatal("partial read: %lu bytes\n", bytes);
252
253         return bytes / 8;
254 }
255
256 static unsigned long kpageflags_read(uint64_t *buf,
257                                      unsigned long index,
258                                      unsigned long pages)
259 {
260         return do_u64_read(kpageflags_fd, PROC_KPAGEFLAGS, buf, index, pages);
261 }
262
263 static unsigned long pagemap_read(uint64_t *buf,
264                                   unsigned long index,
265                                   unsigned long pages)
266 {
267         return do_u64_read(pagemap_fd, "/proc/pid/pagemap", buf, index, pages);
268 }
269
270 static unsigned long pagemap_pfn(uint64_t val)
271 {
272         unsigned long pfn;
273
274         if (val & PM_PRESENT)
275                 pfn = PM_PFRAME(val);
276         else
277                 pfn = 0;
278
279         return pfn;
280 }
281
282
283 /*
284  * page flag names
285  */
286
287 static char *page_flag_name(uint64_t flags)
288 {
289         static char buf[65];
290         int present;
291         int i, j;
292
293         for (i = 0, j = 0; i < ARRAY_SIZE(page_flag_names); i++) {
294                 present = (flags >> i) & 1;
295                 if (!page_flag_names[i]) {
296                         if (present)
297                                 fatal("unkown flag bit %d\n", i);
298                         continue;
299                 }
300                 buf[j++] = present ? page_flag_names[i][0] : '_';
301         }
302
303         return buf;
304 }
305
306 static char *page_flag_longname(uint64_t flags)
307 {
308         static char buf[1024];
309         int i, n;
310
311         for (i = 0, n = 0; i < ARRAY_SIZE(page_flag_names); i++) {
312                 if (!page_flag_names[i])
313                         continue;
314                 if ((flags >> i) & 1)
315                         n += snprintf(buf + n, sizeof(buf) - n, "%s,",
316                                         page_flag_names[i] + 2);
317         }
318         if (n)
319                 n--;
320         buf[n] = '\0';
321
322         return buf;
323 }
324
325
326 /*
327  * page list and summary
328  */
329
330 static void show_page_range(unsigned long voffset,
331                             unsigned long offset, uint64_t flags)
332 {
333         static uint64_t      flags0;
334         static unsigned long voff;
335         static unsigned long index;
336         static unsigned long count;
337
338         if (flags == flags0 && offset == index + count &&
339             (!opt_pid || voffset == voff + count)) {
340                 count++;
341                 return;
342         }
343
344         if (count) {
345                 if (opt_pid)
346                         printf("%lx\t", voff);
347                 printf("%lx\t%lx\t%s\n",
348                                 index, count, page_flag_name(flags0));
349         }
350
351         flags0 = flags;
352         index  = offset;
353         voff   = voffset;
354         count  = 1;
355 }
356
357 static void show_page(unsigned long voffset,
358                       unsigned long offset, uint64_t flags)
359 {
360         if (opt_pid)
361                 printf("%lx\t", voffset);
362         printf("%lx\t%s\n", offset, page_flag_name(flags));
363 }
364
365 static void show_summary(void)
366 {
367         int i;
368
369         printf("             flags\tpage-count       MB"
370                 "  symbolic-flags\t\t\tlong-symbolic-flags\n");
371
372         for (i = 0; i < ARRAY_SIZE(nr_pages); i++) {
373                 if (nr_pages[i])
374                         printf("0x%016llx\t%10lu %8lu  %s\t%s\n",
375                                 (unsigned long long)page_flags[i],
376                                 nr_pages[i],
377                                 pages2mb(nr_pages[i]),
378                                 page_flag_name(page_flags[i]),
379                                 page_flag_longname(page_flags[i]));
380         }
381
382         printf("             total\t%10lu %8lu\n",
383                         total_pages, pages2mb(total_pages));
384 }
385
386
387 /*
388  * page flag filters
389  */
390
391 static int bit_mask_ok(uint64_t flags)
392 {
393         int i;
394
395         for (i = 0; i < nr_bit_filters; i++) {
396                 if (opt_bits[i] == KPF_ALL_BITS) {
397                         if ((flags & opt_mask[i]) == 0)
398                                 return 0;
399                 } else {
400                         if ((flags & opt_mask[i]) != opt_bits[i])
401                                 return 0;
402                 }
403         }
404
405         return 1;
406 }
407
408 static uint64_t expand_overloaded_flags(uint64_t flags)
409 {
410         /* SLOB/SLUB overload several page flags */
411         if (flags & BIT(SLAB)) {
412                 if (flags & BIT(PRIVATE))
413                         flags ^= BIT(PRIVATE) | BIT(SLOB_FREE);
414                 if (flags & BIT(ACTIVE))
415                         flags ^= BIT(ACTIVE) | BIT(SLUB_FROZEN);
416                 if (flags & BIT(ERROR))
417                         flags ^= BIT(ERROR) | BIT(SLUB_DEBUG);
418         }
419
420         /* PG_reclaim is overloaded as PG_readahead in the read path */
421         if ((flags & (BIT(RECLAIM) | BIT(WRITEBACK))) == BIT(RECLAIM))
422                 flags ^= BIT(RECLAIM) | BIT(READAHEAD);
423
424         return flags;
425 }
426
427 static uint64_t well_known_flags(uint64_t flags)
428 {
429         /* hide flags intended only for kernel hacker */
430         flags &= ~KPF_HACKERS_BITS;
431
432         /* hide non-hugeTLB compound pages */
433         if ((flags & BITS_COMPOUND) && !(flags & BIT(HUGE)))
434                 flags &= ~BITS_COMPOUND;
435
436         return flags;
437 }
438
439 static uint64_t kpageflags_flags(uint64_t flags)
440 {
441         flags = expand_overloaded_flags(flags);
442
443         if (!opt_raw)
444                 flags = well_known_flags(flags);
445
446         return flags;
447 }
448
449 /*
450  * page frame walker
451  */
452
453 static int hash_slot(uint64_t flags)
454 {
455         int k = HASH_KEY(flags);
456         int i;
457
458         /* Explicitly reserve slot 0 for flags 0: the following logic
459          * cannot distinguish an unoccupied slot from slot (flags==0).
460          */
461         if (flags == 0)
462                 return 0;
463
464         /* search through the remaining (HASH_SIZE-1) slots */
465         for (i = 1; i < ARRAY_SIZE(page_flags); i++, k++) {
466                 if (!k || k >= ARRAY_SIZE(page_flags))
467                         k = 1;
468                 if (page_flags[k] == 0) {
469                         page_flags[k] = flags;
470                         return k;
471                 }
472                 if (page_flags[k] == flags)
473                         return k;
474         }
475
476         fatal("hash table full: bump up HASH_SHIFT?\n");
477         exit(EXIT_FAILURE);
478 }
479
480 static void add_page(unsigned long voffset,
481                      unsigned long offset, uint64_t flags)
482 {
483         flags = kpageflags_flags(flags);
484
485         if (!bit_mask_ok(flags))
486                 return;
487
488         if (opt_list == 1)
489                 show_page_range(voffset, offset, flags);
490         else if (opt_list == 2)
491                 show_page(voffset, offset, flags);
492
493         nr_pages[hash_slot(flags)]++;
494         total_pages++;
495 }
496
497 #define KPAGEFLAGS_BATCH        (64 << 10)      /* 64k pages */
498 static void walk_pfn(unsigned long voffset,
499                      unsigned long index,
500                      unsigned long count)
501 {
502         uint64_t buf[KPAGEFLAGS_BATCH];
503         unsigned long batch;
504         unsigned long pages;
505         unsigned long i;
506
507         while (count) {
508                 batch = min_t(unsigned long, count, KPAGEFLAGS_BATCH);
509                 pages = kpageflags_read(buf, index, batch);
510                 if (pages == 0)
511                         break;
512
513                 for (i = 0; i < pages; i++)
514                         add_page(voffset + i, index + i, buf[i]);
515
516                 index += pages;
517                 count -= pages;
518         }
519 }
520
521 #define PAGEMAP_BATCH   (64 << 10)
522 static void walk_vma(unsigned long index, unsigned long count)
523 {
524         uint64_t buf[PAGEMAP_BATCH];
525         unsigned long batch;
526         unsigned long pages;
527         unsigned long pfn;
528         unsigned long i;
529
530         while (count) {
531                 batch = min_t(unsigned long, count, PAGEMAP_BATCH);
532                 pages = pagemap_read(buf, index, batch);
533                 if (pages == 0)
534                         break;
535
536                 for (i = 0; i < pages; i++) {
537                         pfn = pagemap_pfn(buf[i]);
538                         if (pfn)
539                                 walk_pfn(index + i, pfn, 1);
540                 }
541
542                 index += pages;
543                 count -= pages;
544         }
545 }
546
547 static void walk_task(unsigned long index, unsigned long count)
548 {
549         const unsigned long end = index + count;
550         unsigned long start;
551         int i = 0;
552
553         while (index < end) {
554
555                 while (pg_end[i] <= index)
556                         if (++i >= nr_vmas)
557                                 return;
558                 if (pg_start[i] >= end)
559                         return;
560
561                 start = max_t(unsigned long, pg_start[i], index);
562                 index = min_t(unsigned long, pg_end[i], end);
563
564                 assert(start < index);
565                 walk_vma(start, index - start);
566         }
567 }
568
569 static void add_addr_range(unsigned long offset, unsigned long size)
570 {
571         if (nr_addr_ranges >= MAX_ADDR_RANGES)
572                 fatal("too many addr ranges\n");
573
574         opt_offset[nr_addr_ranges] = offset;
575         opt_size[nr_addr_ranges] = min_t(unsigned long, size, ULONG_MAX-offset);
576         nr_addr_ranges++;
577 }
578
579 static void walk_addr_ranges(void)
580 {
581         int i;
582
583         kpageflags_fd = checked_open(PROC_KPAGEFLAGS, O_RDONLY);
584
585         if (!nr_addr_ranges)
586                 add_addr_range(0, ULONG_MAX);
587
588         for (i = 0; i < nr_addr_ranges; i++)
589                 if (!opt_pid)
590                         walk_pfn(0, opt_offset[i], opt_size[i]);
591                 else
592                         walk_task(opt_offset[i], opt_size[i]);
593
594         close(kpageflags_fd);
595 }
596
597
598 /*
599  * user interface
600  */
601
602 static const char *page_flag_type(uint64_t flag)
603 {
604         if (flag & KPF_HACKERS_BITS)
605                 return "(r)";
606         if (flag & KPF_OVERLOADED_BITS)
607                 return "(o)";
608         return "   ";
609 }
610
611 static void usage(void)
612 {
613         int i, j;
614
615         printf(
616 "page-types [options]\n"
617 "            -r|--raw                  Raw mode, for kernel developers\n"
618 "            -a|--addr    addr-spec    Walk a range of pages\n"
619 "            -b|--bits    bits-spec    Walk pages with specified bits\n"
620 "            -p|--pid     pid          Walk process address space\n"
621 #if 0 /* planned features */
622 "            -f|--file    filename     Walk file address space\n"
623 #endif
624 "            -l|--list                 Show page details in ranges\n"
625 "            -L|--list-each            Show page details one by one\n"
626 "            -N|--no-summary           Don't show summay info\n"
627 "            -h|--help                 Show this usage message\n"
628 "addr-spec:\n"
629 "            N                         one page at offset N (unit: pages)\n"
630 "            N+M                       pages range from N to N+M-1\n"
631 "            N,M                       pages range from N to M-1\n"
632 "            N,                        pages range from N to end\n"
633 "            ,M                        pages range from 0 to M-1\n"
634 "bits-spec:\n"
635 "            bit1,bit2                 (flags & (bit1|bit2)) != 0\n"
636 "            bit1,bit2=bit1            (flags & (bit1|bit2)) == bit1\n"
637 "            bit1,~bit2                (flags & (bit1|bit2)) == bit1\n"
638 "            =bit1,bit2                flags == (bit1|bit2)\n"
639 "bit-names:\n"
640         );
641
642         for (i = 0, j = 0; i < ARRAY_SIZE(page_flag_names); i++) {
643                 if (!page_flag_names[i])
644                         continue;
645                 printf("%16s%s", page_flag_names[i] + 2,
646                                  page_flag_type(1ULL << i));
647                 if (++j > 3) {
648                         j = 0;
649                         putchar('\n');
650                 }
651         }
652         printf("\n                                   "
653                 "(r) raw mode bits  (o) overloaded bits\n");
654 }
655
656 static unsigned long long parse_number(const char *str)
657 {
658         unsigned long long n;
659
660         n = strtoll(str, NULL, 0);
661
662         if (n == 0 && str[0] != '0')
663                 fatal("invalid name or number: %s\n", str);
664
665         return n;
666 }
667
668 static void parse_pid(const char *str)
669 {
670         FILE *file;
671         char buf[5000];
672
673         opt_pid = parse_number(str);
674
675         sprintf(buf, "/proc/%d/pagemap", opt_pid);
676         pagemap_fd = checked_open(buf, O_RDONLY);
677
678         sprintf(buf, "/proc/%d/maps", opt_pid);
679         file = fopen(buf, "r");
680         if (!file) {
681                 perror(buf);
682                 exit(EXIT_FAILURE);
683         }
684
685         while (fgets(buf, sizeof(buf), file) != NULL) {
686                 unsigned long vm_start;
687                 unsigned long vm_end;
688                 unsigned long long pgoff;
689                 int major, minor;
690                 char r, w, x, s;
691                 unsigned long ino;
692                 int n;
693
694                 n = sscanf(buf, "%lx-%lx %c%c%c%c %llx %x:%x %lu",
695                            &vm_start,
696                            &vm_end,
697                            &r, &w, &x, &s,
698                            &pgoff,
699                            &major, &minor,
700                            &ino);
701                 if (n < 10) {
702                         fprintf(stderr, "unexpected line: %s\n", buf);
703                         continue;
704                 }
705                 pg_start[nr_vmas] = vm_start / page_size;
706                 pg_end[nr_vmas] = vm_end / page_size;
707                 if (++nr_vmas >= MAX_VMAS) {
708                         fprintf(stderr, "too many VMAs\n");
709                         break;
710                 }
711         }
712         fclose(file);
713 }
714
715 static void parse_file(const char *name)
716 {
717 }
718
719 static void parse_addr_range(const char *optarg)
720 {
721         unsigned long offset;
722         unsigned long size;
723         char *p;
724
725         p = strchr(optarg, ',');
726         if (!p)
727                 p = strchr(optarg, '+');
728
729         if (p == optarg) {
730                 offset = 0;
731                 size   = parse_number(p + 1);
732         } else if (p) {
733                 offset = parse_number(optarg);
734                 if (p[1] == '\0')
735                         size = ULONG_MAX;
736                 else {
737                         size = parse_number(p + 1);
738                         if (*p == ',') {
739                                 if (size < offset)
740                                         fatal("invalid range: %lu,%lu\n",
741                                                         offset, size);
742                                 size -= offset;
743                         }
744                 }
745         } else {
746                 offset = parse_number(optarg);
747                 size   = 1;
748         }
749
750         add_addr_range(offset, size);
751 }
752
753 static void add_bits_filter(uint64_t mask, uint64_t bits)
754 {
755         if (nr_bit_filters >= MAX_BIT_FILTERS)
756                 fatal("too much bit filters\n");
757
758         opt_mask[nr_bit_filters] = mask;
759         opt_bits[nr_bit_filters] = bits;
760         nr_bit_filters++;
761 }
762
763 static uint64_t parse_flag_name(const char *str, int len)
764 {
765         int i;
766
767         if (!*str || !len)
768                 return 0;
769
770         if (len <= 8 && !strncmp(str, "compound", len))
771                 return BITS_COMPOUND;
772
773         for (i = 0; i < ARRAY_SIZE(page_flag_names); i++) {
774                 if (!page_flag_names[i])
775                         continue;
776                 if (!strncmp(str, page_flag_names[i] + 2, len))
777                         return 1ULL << i;
778         }
779
780         return parse_number(str);
781 }
782
783 static uint64_t parse_flag_names(const char *str, int all)
784 {
785         const char *p    = str;
786         uint64_t   flags = 0;
787
788         while (1) {
789                 if (*p == ',' || *p == '=' || *p == '\0') {
790                         if ((*str != '~') || (*str == '~' && all && *++str))
791                                 flags |= parse_flag_name(str, p - str);
792                         if (*p != ',')
793                                 break;
794                         str = p + 1;
795                 }
796                 p++;
797         }
798
799         return flags;
800 }
801
802 static void parse_bits_mask(const char *optarg)
803 {
804         uint64_t mask;
805         uint64_t bits;
806         const char *p;
807
808         p = strchr(optarg, '=');
809         if (p == optarg) {
810                 mask = KPF_ALL_BITS;
811                 bits = parse_flag_names(p + 1, 0);
812         } else if (p) {
813                 mask = parse_flag_names(optarg, 0);
814                 bits = parse_flag_names(p + 1, 0);
815         } else if (strchr(optarg, '~')) {
816                 mask = parse_flag_names(optarg, 1);
817                 bits = parse_flag_names(optarg, 0);
818         } else {
819                 mask = parse_flag_names(optarg, 0);
820                 bits = KPF_ALL_BITS;
821         }
822
823         add_bits_filter(mask, bits);
824 }
825
826
827 static struct option opts[] = {
828         { "raw"       , 0, NULL, 'r' },
829         { "pid"       , 1, NULL, 'p' },
830         { "file"      , 1, NULL, 'f' },
831         { "addr"      , 1, NULL, 'a' },
832         { "bits"      , 1, NULL, 'b' },
833         { "list"      , 0, NULL, 'l' },
834         { "list-each" , 0, NULL, 'L' },
835         { "no-summary", 0, NULL, 'N' },
836         { "help"      , 0, NULL, 'h' },
837         { NULL        , 0, NULL, 0 }
838 };
839
840 int main(int argc, char *argv[])
841 {
842         int c;
843
844         page_size = getpagesize();
845
846         while ((c = getopt_long(argc, argv,
847                                 "rp:f:a:b:lLNh", opts, NULL)) != -1) {
848                 switch (c) {
849                 case 'r':
850                         opt_raw = 1;
851                         break;
852                 case 'p':
853                         parse_pid(optarg);
854                         break;
855                 case 'f':
856                         parse_file(optarg);
857                         break;
858                 case 'a':
859                         parse_addr_range(optarg);
860                         break;
861                 case 'b':
862                         parse_bits_mask(optarg);
863                         break;
864                 case 'l':
865                         opt_list = 1;
866                         break;
867                 case 'L':
868                         opt_list = 2;
869                         break;
870                 case 'N':
871                         opt_no_summary = 1;
872                         break;
873                 case 'h':
874                         usage();
875                         exit(0);
876                 default:
877                         usage();
878                         exit(1);
879                 }
880         }
881
882         if (opt_list && opt_pid)
883                 printf("voffset\t");
884         if (opt_list == 1)
885                 printf("offset\tlen\tflags\n");
886         if (opt_list == 2)
887                 printf("offset\tflags\n");
888
889         walk_addr_ranges();
890
891         if (opt_list == 1)
892                 show_page_range(0, 0, 0);  /* drain the buffer */
893
894         if (opt_no_summary)
895                 return 0;
896
897         if (opt_list)
898                 printf("\n\n");
899
900         show_summary();
901
902         return 0;
903 }