mincore: mmap() returns MAP_FAILED on failure
[pcu.git] / pcu-mincore.1.txt
bloba3a83008c9e90117045a80b0af34cb6c62e47eed
1 % PCU-MINCORE(1) Page Cache Utilities Manual
2 % Eric Wong <normalperson@yhbt.net>
3 % July 26, 2009
5 # NAME
6 pcu-mincore - shows cache status for given files
8 # SYNOPSIS
9 pcu-mincore [-o OFFSET] [-l LENGTH] FILE...
11 # DESCRIPTION
12 A command-line interface to the mincore(2) syscall to inspect
13 whether or not certain pages belonging to a file are cached in
14 resident memory.
16 # OPTIONS
17 -o OFFSET
18 :   Scan only pages on or after the given offset.
19     This offset is rounded down to the previous page offset.
20     The default offset is zero (beginning of the file)
22 -l LENGTH
23 :    Check only the given length in bytes.
24     This length is rounded up next page offset.
25     The default is to scan the entire file.
27 # OUTPUT
28 One line for every page scanned in the following format:
30    \<filename\>: \<offset\> \<incore\>
32 offset is a hexadecimal number for a given range of PAGE_SIZE bytes.
33 incore is a boolean value indicating whether or not the page beginning
34 at a particular offset is cached in resident memory or not.
36 # ENVIRONMENT
37 none
39 # SEE ALSO
40 [`mincore`(2)][2]
42 # BUGS
43 None known. Email <pcu@librelist.com> if you find any.
45 [2]: http://kernel.org/doc/man-pages/online/pages/man2/mincore.2.html