3 Linux::Proc::Maps - Read and write /proc/\[pid\]/maps files
11 use Linux::Proc::Maps qw(read_maps);
14 my $vm_regions = read_maps(pid => $$);
16 # by pid with explicit procfs mount:
17 my $vm_regions = read_maps(mnt => '/proc', pid => 123);
20 my $vm_regions = read_maps(file => '/proc/456/maps');
24 This module reads and writes `/proc/[pid]/maps` files that contain listed mapped memory regions.
30 Read and parse a maps file, returning an arrayref of regions (each represented as a hashref). See
31 ["parse\_maps\_single\_line"](#parse_maps_single_line) to see the format of the hashrefs.
33 my $regions = read_maps(%args);
37 - `file` - Path to maps file
38 - `pid` - Process ID (one of `file` or `pid` is required)
39 - `mnt` - Absolute path where [proc(5)](http://man.he.net/man5/proc) is mounted (optional, default: `/proc`)
43 Returns a string with the contents of a maps file from the memory regions passed.
45 my $file_content = write_maps(\@regions, %args);
47 This is the opposite of ["read\_maps"](#read_maps).
51 - `fh` - Write maps to this open file handle (optional)
52 - `file` - Open this filepath and write maps to that file (optional)
54 ## parse\_maps\_single\_line
56 Parse and return a single line from a maps file into a region represented as a hashref.
58 my $region = parse_maps_single_line($line);
62 # address perms offset dev inode pathname
63 08048000-08056000 r-xp 00000000 03:0c 64593 /usr/sbin/gpm
68 address_start => 134512640,
69 address_end => 134569984,
77 pathname => '/usr/sbin/gpm',
80 ## format\_maps\_single\_line
82 Return a single line for a maps file from a region represented as a hashref.
84 my $line = format_maps_single_line(\%region);
86 This is the opposite of ["parse\_maps\_single\_line"](#parse_maps_single_line).
90 [proc(5)](http://man.he.net/man5/proc) describes the file format.
94 Integer overloading may occur if you try to parse memory regions from address spaces larger than
95 your current architecture (or perl) supports. This is currently not fatal, though you will get
96 warnings from perl that you probably shouldn't ignore.
100 Please report any bugs or feature requests on the bugtracker website
101 [https://github.com/chazmcgarvey/Linux-Proc-Maps/issues](https://github.com/chazmcgarvey/Linux-Proc-Maps/issues)
103 When submitting a bug or request, please include a test-file or a
104 patch to an existing test-file that illustrates the bug or desired
109 Charles McGarvey <chazmcgarvey@brokenzipper.com>
111 # COPYRIGHT AND LICENSE
113 This software is copyright (c) 2016 by Charles McGarvey.
115 This is free software; you can redistribute it and/or modify it under
116 the same terms as the Perl 5 programming language system itself.