blob: 18e891a329e0fa227ba22af83fe26498678af2cb [file] [log] [blame]
Wu Fengguang35efa5e2009-06-16 15:32:27 -07001/*
2 * page-types: Tool for querying page flags
3 *
4 * Copyright (C) 2009 Intel corporation
Wu Fengguang0c57eff2009-10-07 16:32:28 -07005 *
6 * Authors: Wu Fengguang <fengguang.wu@intel.com>
7 *
8 * Released under the General Public License (GPL).
Wu Fengguang35efa5e2009-06-16 15:32:27 -07009 */
10
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -070011#define _LARGEFILE64_SOURCE
Wu Fengguang35efa5e2009-06-16 15:32:27 -070012#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>
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -070020#include <assert.h>
Wu Fengguang35efa5e2009-06-16 15:32:27 -070021#include <sys/types.h>
22#include <sys/errno.h>
23#include <sys/fcntl.h>
24
25
26/*
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -070027 * 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/*
Wu Fengguang35efa5e2009-06-16 15:32:27 -070047 * 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
Wu Fengguang253fb022009-10-07 16:32:27 -070075#define KPF_HWPOISON 19
Wu Fengguang35efa5e2009-06-16 15:32:27 -070076#define KPF_NOPAGE 20
Wu Fengguanga1bbb5e2009-10-07 16:32:28 -070077#define KPF_KSM 21
Wu Fengguang35efa5e2009-06-16 15:32:27 -070078
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
103static 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",
Wu Fengguang253fb022009-10-07 16:32:27 -0700124 [KPF_HWPOISON] = "X:hwpoison",
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700125 [KPF_NOPAGE] = "n:nopage",
Wu Fengguanga1bbb5e2009-10-07 16:32:28 -0700126 [KPF_KSM] = "x:ksm",
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700127
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
148static int opt_raw; /* for kernel developers */
149static int opt_list; /* list pages (in ranges) */
150static int opt_no_summary; /* don't show summary */
151static pid_t opt_pid; /* process to walk */
152
153#define MAX_ADDR_RANGES 1024
154static int nr_addr_ranges;
155static unsigned long opt_offset[MAX_ADDR_RANGES];
156static unsigned long opt_size[MAX_ADDR_RANGES];
157
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700158#define MAX_VMAS 10240
159static int nr_vmas;
160static unsigned long pg_start[MAX_VMAS];
161static unsigned long pg_end[MAX_VMAS];
162static unsigned long voffset;
163
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700164#define MAX_BIT_FILTERS 64
165static int nr_bit_filters;
166static uint64_t opt_mask[MAX_BIT_FILTERS];
167static uint64_t opt_bits[MAX_BIT_FILTERS];
168
169static int page_size;
170
Wu Fengguang4a1b6722009-10-07 16:32:30 -0700171static int pagemap_fd;
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700172static int kpageflags_fd;
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700173
174#define HASH_SHIFT 13
175#define HASH_SIZE (1 << HASH_SHIFT)
176#define HASH_MASK (HASH_SIZE - 1)
177#define HASH_KEY(flags) (flags & HASH_MASK)
178
179static unsigned long total_pages;
180static unsigned long nr_pages[HASH_SIZE];
181static uint64_t page_flags[HASH_SIZE];
182
183
184/*
185 * helper functions
186 */
187
188#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
189
190#define min_t(type, x, y) ({ \
191 type __min1 = (x); \
192 type __min2 = (y); \
193 __min1 < __min2 ? __min1 : __min2; })
194
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700195#define max_t(type, x, y) ({ \
196 type __max1 = (x); \
197 type __max2 = (y); \
198 __max1 > __max2 ? __max1 : __max2; })
199
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700200static unsigned long pages2mb(unsigned long pages)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700201{
202 return (pages * page_size) >> 20;
203}
204
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700205static void fatal(const char *x, ...)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700206{
207 va_list ap;
208
209 va_start(ap, x);
210 vfprintf(stderr, x, ap);
211 va_end(ap);
212 exit(EXIT_FAILURE);
213}
214
Wu Fengguang31bbf662009-10-07 16:32:29 -0700215int checked_open(const char *pathname, int flags)
216{
217 int fd = open(pathname, flags);
218
219 if (fd < 0) {
220 perror(pathname);
221 exit(EXIT_FAILURE);
222 }
223
224 return fd;
225}
226
Wu Fengguang4a1b6722009-10-07 16:32:30 -0700227/*
228 * pagemap/kpageflags routines
229 */
230
231static unsigned long do_u64_read(int fd, char *name,
232 uint64_t *buf,
233 unsigned long index,
234 unsigned long count)
235{
236 long bytes;
237
238 if (index > ULONG_MAX / 8)
239 fatal("index overflow: %lu\n", index);
240
241 if (lseek(fd, index * 8, SEEK_SET) < 0) {
242 perror(name);
243 exit(EXIT_FAILURE);
244 }
245
246 bytes = read(fd, buf, count * 8);
247 if (bytes < 0) {
248 perror(name);
249 exit(EXIT_FAILURE);
250 }
251 if (bytes % 8)
252 fatal("partial read: %lu bytes\n", bytes);
253
254 return bytes / 8;
255}
256
257static unsigned long kpageflags_read(uint64_t *buf,
258 unsigned long index,
259 unsigned long pages)
260{
261 return do_u64_read(kpageflags_fd, PROC_KPAGEFLAGS, buf, index, pages);
262}
263
264static unsigned long pagemap_read(uint64_t *buf,
265 unsigned long index,
266 unsigned long pages)
267{
268 return do_u64_read(pagemap_fd, "/proc/pid/pagemap", buf, index, pages);
269}
270
271static unsigned long pagemap_pfn(uint64_t val)
272{
273 unsigned long pfn;
274
275 if (val & PM_PRESENT)
276 pfn = PM_PFRAME(val);
277 else
278 pfn = 0;
279
280 return pfn;
281}
282
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700283
284/*
285 * page flag names
286 */
287
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700288static char *page_flag_name(uint64_t flags)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700289{
290 static char buf[65];
291 int present;
292 int i, j;
293
294 for (i = 0, j = 0; i < ARRAY_SIZE(page_flag_names); i++) {
295 present = (flags >> i) & 1;
296 if (!page_flag_names[i]) {
297 if (present)
298 fatal("unkown flag bit %d\n", i);
299 continue;
300 }
301 buf[j++] = present ? page_flag_names[i][0] : '_';
302 }
303
304 return buf;
305}
306
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700307static char *page_flag_longname(uint64_t flags)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700308{
309 static char buf[1024];
310 int i, n;
311
312 for (i = 0, n = 0; i < ARRAY_SIZE(page_flag_names); i++) {
313 if (!page_flag_names[i])
314 continue;
315 if ((flags >> i) & 1)
316 n += snprintf(buf + n, sizeof(buf) - n, "%s,",
317 page_flag_names[i] + 2);
318 }
319 if (n)
320 n--;
321 buf[n] = '\0';
322
323 return buf;
324}
325
326
327/*
328 * page list and summary
329 */
330
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700331static void show_page_range(unsigned long offset, uint64_t flags)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700332{
333 static uint64_t flags0;
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700334 static unsigned long voff;
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700335 static unsigned long index;
336 static unsigned long count;
337
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700338 if (flags == flags0 && offset == index + count &&
339 (!opt_pid || voffset == voff + count)) {
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700340 count++;
341 return;
342 }
343
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700344 if (count) {
345 if (opt_pid)
346 printf("%lx\t", voff);
347 printf("%lx\t%lx\t%s\n",
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700348 index, count, page_flag_name(flags0));
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700349 }
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700350
351 flags0 = flags;
352 index = offset;
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700353 voff = voffset;
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700354 count = 1;
355}
356
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700357static void show_page(unsigned long offset, uint64_t flags)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700358{
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700359 if (opt_pid)
360 printf("%lx\t", voffset);
361 printf("%lx\t%s\n", offset, page_flag_name(flags));
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700362}
363
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700364static void show_summary(void)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700365{
366 int i;
367
368 printf(" flags\tpage-count MB"
369 " symbolic-flags\t\t\tlong-symbolic-flags\n");
370
371 for (i = 0; i < ARRAY_SIZE(nr_pages); i++) {
372 if (nr_pages[i])
373 printf("0x%016llx\t%10lu %8lu %s\t%s\n",
374 (unsigned long long)page_flags[i],
375 nr_pages[i],
376 pages2mb(nr_pages[i]),
377 page_flag_name(page_flags[i]),
378 page_flag_longname(page_flags[i]));
379 }
380
381 printf(" total\t%10lu %8lu\n",
382 total_pages, pages2mb(total_pages));
383}
384
385
386/*
387 * page flag filters
388 */
389
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700390static int bit_mask_ok(uint64_t flags)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700391{
392 int i;
393
394 for (i = 0; i < nr_bit_filters; i++) {
395 if (opt_bits[i] == KPF_ALL_BITS) {
396 if ((flags & opt_mask[i]) == 0)
397 return 0;
398 } else {
399 if ((flags & opt_mask[i]) != opt_bits[i])
400 return 0;
401 }
402 }
403
404 return 1;
405}
406
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700407static uint64_t expand_overloaded_flags(uint64_t flags)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700408{
409 /* SLOB/SLUB overload several page flags */
410 if (flags & BIT(SLAB)) {
411 if (flags & BIT(PRIVATE))
412 flags ^= BIT(PRIVATE) | BIT(SLOB_FREE);
413 if (flags & BIT(ACTIVE))
414 flags ^= BIT(ACTIVE) | BIT(SLUB_FROZEN);
415 if (flags & BIT(ERROR))
416 flags ^= BIT(ERROR) | BIT(SLUB_DEBUG);
417 }
418
419 /* PG_reclaim is overloaded as PG_readahead in the read path */
420 if ((flags & (BIT(RECLAIM) | BIT(WRITEBACK))) == BIT(RECLAIM))
421 flags ^= BIT(RECLAIM) | BIT(READAHEAD);
422
423 return flags;
424}
425
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700426static uint64_t well_known_flags(uint64_t flags)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700427{
428 /* hide flags intended only for kernel hacker */
429 flags &= ~KPF_HACKERS_BITS;
430
431 /* hide non-hugeTLB compound pages */
432 if ((flags & BITS_COMPOUND) && !(flags & BIT(HUGE)))
433 flags &= ~BITS_COMPOUND;
434
435 return flags;
436}
437
438
439/*
440 * page frame walker
441 */
442
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700443static int hash_slot(uint64_t flags)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700444{
445 int k = HASH_KEY(flags);
446 int i;
447
448 /* Explicitly reserve slot 0 for flags 0: the following logic
449 * cannot distinguish an unoccupied slot from slot (flags==0).
450 */
451 if (flags == 0)
452 return 0;
453
454 /* search through the remaining (HASH_SIZE-1) slots */
455 for (i = 1; i < ARRAY_SIZE(page_flags); i++, k++) {
456 if (!k || k >= ARRAY_SIZE(page_flags))
457 k = 1;
458 if (page_flags[k] == 0) {
459 page_flags[k] = flags;
460 return k;
461 }
462 if (page_flags[k] == flags)
463 return k;
464 }
465
466 fatal("hash table full: bump up HASH_SHIFT?\n");
467 exit(EXIT_FAILURE);
468}
469
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700470static void add_page(unsigned long offset, uint64_t flags)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700471{
472 flags = expand_overloaded_flags(flags);
473
474 if (!opt_raw)
475 flags = well_known_flags(flags);
476
477 if (!bit_mask_ok(flags))
478 return;
479
480 if (opt_list == 1)
481 show_page_range(offset, flags);
482 else if (opt_list == 2)
483 show_page(offset, flags);
484
485 nr_pages[hash_slot(flags)]++;
486 total_pages++;
487}
488
Wu Fengguang4a1b6722009-10-07 16:32:30 -0700489#define KPAGEFLAGS_BATCH (64 << 10) /* 64k pages */
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700490static void walk_pfn(unsigned long index, unsigned long count)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700491{
Wu Fengguang4a1b6722009-10-07 16:32:30 -0700492 uint64_t buf[KPAGEFLAGS_BATCH];
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700493 unsigned long batch;
Wu Fengguang4a1b6722009-10-07 16:32:30 -0700494 unsigned long pages;
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700495 unsigned long i;
496
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700497 while (count) {
Wu Fengguang4a1b6722009-10-07 16:32:30 -0700498 batch = min_t(unsigned long, count, KPAGEFLAGS_BATCH);
499 pages = kpageflags_read(buf, index, batch);
500 if (pages == 0)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700501 break;
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700502
Wu Fengguang4a1b6722009-10-07 16:32:30 -0700503 for (i = 0; i < pages; i++)
504 add_page(index + i, buf[i]);
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700505
Wu Fengguang4a1b6722009-10-07 16:32:30 -0700506 index += pages;
507 count -= pages;
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700508 }
509}
510
Wu Fengguang4a1b6722009-10-07 16:32:30 -0700511#define PAGEMAP_BATCH (64 << 10)
512static void walk_vma(unsigned long index, unsigned long count)
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700513{
Wu Fengguang4a1b6722009-10-07 16:32:30 -0700514 uint64_t buf[PAGEMAP_BATCH];
515 unsigned long batch;
516 unsigned long pages;
517 unsigned long pfn;
518 unsigned long i;
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700519
Wu Fengguang4a1b6722009-10-07 16:32:30 -0700520 while (count) {
521 batch = min_t(unsigned long, count, PAGEMAP_BATCH);
522 pages = pagemap_read(buf, index, batch);
523 if (pages == 0)
524 break;
525
526 for (i = 0; i < pages; i++) {
527 pfn = pagemap_pfn(buf[i]);
528 voffset = index + i;
529 if (pfn)
530 walk_pfn(pfn, 1);
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700531 }
Wu Fengguang4a1b6722009-10-07 16:32:30 -0700532
533 index += pages;
534 count -= pages;
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700535 }
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700536}
537
538static void walk_task(unsigned long index, unsigned long count)
539{
540 int i = 0;
541 const unsigned long end = index + count;
542
543 while (index < end) {
544
545 while (pg_end[i] <= index)
546 if (++i >= nr_vmas)
547 return;
548 if (pg_start[i] >= end)
549 return;
550
551 voffset = max_t(unsigned long, pg_start[i], index);
552 index = min_t(unsigned long, pg_end[i], end);
553
554 assert(voffset < index);
Wu Fengguang4a1b6722009-10-07 16:32:30 -0700555 walk_vma(voffset, index - voffset);
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700556 }
557}
558
559static void add_addr_range(unsigned long offset, unsigned long size)
560{
561 if (nr_addr_ranges >= MAX_ADDR_RANGES)
562 fatal("too many addr ranges\n");
563
564 opt_offset[nr_addr_ranges] = offset;
565 opt_size[nr_addr_ranges] = min_t(unsigned long, size, ULONG_MAX-offset);
566 nr_addr_ranges++;
567}
568
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700569static void walk_addr_ranges(void)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700570{
571 int i;
572
Wu Fengguang31bbf662009-10-07 16:32:29 -0700573 kpageflags_fd = checked_open(PROC_KPAGEFLAGS, O_RDONLY);
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700574
575 if (!nr_addr_ranges)
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700576 add_addr_range(0, ULONG_MAX);
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700577
578 for (i = 0; i < nr_addr_ranges; i++)
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700579 if (!opt_pid)
580 walk_pfn(opt_offset[i], opt_size[i]);
581 else
582 walk_task(opt_offset[i], opt_size[i]);
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700583
584 close(kpageflags_fd);
585}
586
587
588/*
589 * user interface
590 */
591
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700592static const char *page_flag_type(uint64_t flag)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700593{
594 if (flag & KPF_HACKERS_BITS)
595 return "(r)";
596 if (flag & KPF_OVERLOADED_BITS)
597 return "(o)";
598 return " ";
599}
600
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700601static void usage(void)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700602{
603 int i, j;
604
605 printf(
606"page-types [options]\n"
607" -r|--raw Raw mode, for kernel developers\n"
608" -a|--addr addr-spec Walk a range of pages\n"
609" -b|--bits bits-spec Walk pages with specified bits\n"
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700610" -p|--pid pid Walk process address space\n"
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700611#if 0 /* planned features */
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700612" -f|--file filename Walk file address space\n"
613#endif
614" -l|--list Show page details in ranges\n"
615" -L|--list-each Show page details one by one\n"
616" -N|--no-summary Don't show summay info\n"
617" -h|--help Show this usage message\n"
618"addr-spec:\n"
619" N one page at offset N (unit: pages)\n"
620" N+M pages range from N to N+M-1\n"
621" N,M pages range from N to M-1\n"
622" N, pages range from N to end\n"
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700623" ,M pages range from 0 to M-1\n"
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700624"bits-spec:\n"
625" bit1,bit2 (flags & (bit1|bit2)) != 0\n"
626" bit1,bit2=bit1 (flags & (bit1|bit2)) == bit1\n"
627" bit1,~bit2 (flags & (bit1|bit2)) == bit1\n"
628" =bit1,bit2 flags == (bit1|bit2)\n"
629"bit-names:\n"
630 );
631
632 for (i = 0, j = 0; i < ARRAY_SIZE(page_flag_names); i++) {
633 if (!page_flag_names[i])
634 continue;
635 printf("%16s%s", page_flag_names[i] + 2,
636 page_flag_type(1ULL << i));
637 if (++j > 3) {
638 j = 0;
639 putchar('\n');
640 }
641 }
642 printf("\n "
643 "(r) raw mode bits (o) overloaded bits\n");
644}
645
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700646static unsigned long long parse_number(const char *str)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700647{
648 unsigned long long n;
649
650 n = strtoll(str, NULL, 0);
651
652 if (n == 0 && str[0] != '0')
653 fatal("invalid name or number: %s\n", str);
654
655 return n;
656}
657
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700658static void parse_pid(const char *str)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700659{
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700660 FILE *file;
661 char buf[5000];
662
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700663 opt_pid = parse_number(str);
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700664
665 sprintf(buf, "/proc/%d/pagemap", opt_pid);
Wu Fengguang31bbf662009-10-07 16:32:29 -0700666 pagemap_fd = checked_open(buf, O_RDONLY);
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700667
668 sprintf(buf, "/proc/%d/maps", opt_pid);
669 file = fopen(buf, "r");
670 if (!file) {
671 perror(buf);
672 exit(EXIT_FAILURE);
673 }
674
675 while (fgets(buf, sizeof(buf), file) != NULL) {
676 unsigned long vm_start;
677 unsigned long vm_end;
678 unsigned long long pgoff;
679 int major, minor;
680 char r, w, x, s;
681 unsigned long ino;
682 int n;
683
684 n = sscanf(buf, "%lx-%lx %c%c%c%c %llx %x:%x %lu",
685 &vm_start,
686 &vm_end,
687 &r, &w, &x, &s,
688 &pgoff,
689 &major, &minor,
690 &ino);
691 if (n < 10) {
692 fprintf(stderr, "unexpected line: %s\n", buf);
693 continue;
694 }
695 pg_start[nr_vmas] = vm_start / page_size;
696 pg_end[nr_vmas] = vm_end / page_size;
697 if (++nr_vmas >= MAX_VMAS) {
698 fprintf(stderr, "too many VMAs\n");
699 break;
700 }
701 }
702 fclose(file);
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700703}
704
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700705static void parse_file(const char *name)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700706{
707}
708
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700709static void parse_addr_range(const char *optarg)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700710{
711 unsigned long offset;
712 unsigned long size;
713 char *p;
714
715 p = strchr(optarg, ',');
716 if (!p)
717 p = strchr(optarg, '+');
718
719 if (p == optarg) {
720 offset = 0;
721 size = parse_number(p + 1);
722 } else if (p) {
723 offset = parse_number(optarg);
724 if (p[1] == '\0')
725 size = ULONG_MAX;
726 else {
727 size = parse_number(p + 1);
728 if (*p == ',') {
729 if (size < offset)
730 fatal("invalid range: %lu,%lu\n",
731 offset, size);
732 size -= offset;
733 }
734 }
735 } else {
736 offset = parse_number(optarg);
737 size = 1;
738 }
739
740 add_addr_range(offset, size);
741}
742
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700743static void add_bits_filter(uint64_t mask, uint64_t bits)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700744{
745 if (nr_bit_filters >= MAX_BIT_FILTERS)
746 fatal("too much bit filters\n");
747
748 opt_mask[nr_bit_filters] = mask;
749 opt_bits[nr_bit_filters] = bits;
750 nr_bit_filters++;
751}
752
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700753static uint64_t parse_flag_name(const char *str, int len)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700754{
755 int i;
756
757 if (!*str || !len)
758 return 0;
759
760 if (len <= 8 && !strncmp(str, "compound", len))
761 return BITS_COMPOUND;
762
763 for (i = 0; i < ARRAY_SIZE(page_flag_names); i++) {
764 if (!page_flag_names[i])
765 continue;
766 if (!strncmp(str, page_flag_names[i] + 2, len))
767 return 1ULL << i;
768 }
769
770 return parse_number(str);
771}
772
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700773static uint64_t parse_flag_names(const char *str, int all)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700774{
775 const char *p = str;
776 uint64_t flags = 0;
777
778 while (1) {
779 if (*p == ',' || *p == '=' || *p == '\0') {
780 if ((*str != '~') || (*str == '~' && all && *++str))
781 flags |= parse_flag_name(str, p - str);
782 if (*p != ',')
783 break;
784 str = p + 1;
785 }
786 p++;
787 }
788
789 return flags;
790}
791
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700792static void parse_bits_mask(const char *optarg)
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700793{
794 uint64_t mask;
795 uint64_t bits;
796 const char *p;
797
798 p = strchr(optarg, '=');
799 if (p == optarg) {
800 mask = KPF_ALL_BITS;
801 bits = parse_flag_names(p + 1, 0);
802 } else if (p) {
803 mask = parse_flag_names(optarg, 0);
804 bits = parse_flag_names(p + 1, 0);
805 } else if (strchr(optarg, '~')) {
806 mask = parse_flag_names(optarg, 1);
807 bits = parse_flag_names(optarg, 0);
808 } else {
809 mask = parse_flag_names(optarg, 0);
810 bits = KPF_ALL_BITS;
811 }
812
813 add_bits_filter(mask, bits);
814}
815
816
Ladinu Chandrasingheb7ed6982009-09-22 16:43:42 -0700817static struct option opts[] = {
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700818 { "raw" , 0, NULL, 'r' },
819 { "pid" , 1, NULL, 'p' },
820 { "file" , 1, NULL, 'f' },
821 { "addr" , 1, NULL, 'a' },
822 { "bits" , 1, NULL, 'b' },
823 { "list" , 0, NULL, 'l' },
824 { "list-each" , 0, NULL, 'L' },
825 { "no-summary", 0, NULL, 'N' },
826 { "help" , 0, NULL, 'h' },
827 { NULL , 0, NULL, 0 }
828};
829
830int main(int argc, char *argv[])
831{
832 int c;
833
834 page_size = getpagesize();
835
836 while ((c = getopt_long(argc, argv,
837 "rp:f:a:b:lLNh", opts, NULL)) != -1) {
838 switch (c) {
839 case 'r':
840 opt_raw = 1;
841 break;
842 case 'p':
843 parse_pid(optarg);
844 break;
845 case 'f':
846 parse_file(optarg);
847 break;
848 case 'a':
849 parse_addr_range(optarg);
850 break;
851 case 'b':
852 parse_bits_mask(optarg);
853 break;
854 case 'l':
855 opt_list = 1;
856 break;
857 case 'L':
858 opt_list = 2;
859 break;
860 case 'N':
861 opt_no_summary = 1;
862 break;
863 case 'h':
864 usage();
865 exit(0);
866 default:
867 usage();
868 exit(1);
869 }
870 }
871
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700872 if (opt_list && opt_pid)
873 printf("voffset\t");
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700874 if (opt_list == 1)
Wu Fengguang0b4b2ad2009-09-23 15:56:16 -0700875 printf("offset\tlen\tflags\n");
Wu Fengguang35efa5e2009-06-16 15:32:27 -0700876 if (opt_list == 2)
877 printf("offset\tflags\n");
878
879 walk_addr_ranges();
880
881 if (opt_list == 1)
882 show_page_range(0, 0); /* drain the buffer */
883
884 if (opt_no_summary)
885 return 0;
886
887 if (opt_list)
888 printf("\n\n");
889
890 show_summary();
891
892 return 0;
893}