From c4949893b4c5b38119e1ad09dff3115d5be8b4ed Mon Sep 17 00:00:00 2001 From: Charles McGarvey Date: Fri, 25 Nov 2016 22:53:23 -0700 Subject: [PATCH] Release Linux-Proc-Maps 0.001 * Initial release --- Changes | 4 ++++ README.md | 16 ++++++++++++---- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/Changes b/Changes index 79dd49f..e4febab 100644 --- a/Changes +++ b/Changes @@ -2,3 +2,7 @@ Revision history for Linux-Proc-Maps. {{$NEXT}} +0.001 2016-11-25 22:53:07-07:00 MST7MDT + + * Initial release + diff --git a/README.md b/README.md index cbf3513..3bc06f0 100644 --- a/README.md +++ b/README.md @@ -25,21 +25,25 @@ This module reads and writes `/proc/[pid]/maps` files that contain listed mapped # METHODS -## read\_maps %args +## read\_maps Read and parse a maps file, returning an arrayref of regions (each represented as a hashref). See ["parse\_maps\_single\_line"](#parse_maps_single_line) to see the format of the hashrefs. + my $regions = read_maps(%args); + Arguments: - `file` - Path to maps file - `pid` - Process ID (one of `file` or `pid` is required) - `mnt` - Absolute path where [proc(5)](http://man.he.net/man5/proc) is mounted (optional, default: `/proc`) -## write\_maps \\@regions, %args +## write\_maps Returns a string with the contents of a maps file from the memory regions passed. + my $file_content = write_maps(\@regions, %args); + This is the opposite of ["read\_maps"](#read_maps). Arguments: @@ -47,10 +51,12 @@ Arguments: - `fh` - Write maps to this open file handle (optional) - `file` - Open this filepath and write maps to that file (optional) -## parse\_maps\_single\_line $line +## parse\_maps\_single\_line Parse and return a single line from a maps file into a region represented as a hashref. + my $region = parse_maps_single_line($line); + For example, # address perms offset dev inode pathname @@ -71,10 +77,12 @@ becomes: pathname => '/usr/sbin/gpm', } -## format\_maps\_single\_line \\%region +## format\_maps\_single\_line Return a single line for a maps file from a region represented as a hashref. + my $line = format_maps_single_line(\%region); + This is the opposite of ["parse\_maps\_single\_line"](#parse_maps_single_line). # SEE ALSO -- 2.44.0