From 7c1bb3f368b9b8143877794f134970ce77b7d2ac Mon Sep 17 00:00:00 2001 From: Charles McGarvey Date: Fri, 25 Nov 2016 18:14:49 -0700 Subject: [PATCH] initial commit --- .gitignore | 12 ++ .travis.yml | 25 +++ Changes | 4 + LICENSE | 379 +++++++++++++++++++++++++++++++++++++++++ README.md | 102 +++++++++++ corpus/maps1 | 20 +++ dist.ini | 8 + lib/Linux/Proc/Maps.pm | 210 +++++++++++++++++++++++ t/01-basic.t | 75 ++++++++ 9 files changed, 835 insertions(+) create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 Changes create mode 100644 LICENSE create mode 100644 README.md create mode 100644 corpus/maps1 create mode 100644 dist.ini create mode 100644 lib/Linux/Proc/Maps.pm create mode 100644 t/01-basic.t diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0553574 --- /dev/null +++ b/.gitignore @@ -0,0 +1,12 @@ +*.bs +*.o +*.tar* +*~ +/.build +/.perl-version +/Linux-Proc-Maps-* +/MYMETA.* +/Makefile +/blib +/local* +/pm_to_blib diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..86a7da9 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,25 @@ +sudo: false +language: perl +perl: + - 'blead' + - '5.20' + - '5.18' + - '5.16' + - '5.14' + - '5.12' + - '5.10' + - '5.8' +matrix: + allow_failures: + - perl: 'blead' + - perl: '5.8' + fast_finish: true +before_install: + - git config --global user.name "TravisCI" + - git config --global user.email $HOSTNAME":not-for-mail@travis-ci.org" +install: + - cpanm --quiet --notest --skip-satisfied Dist::Zilla + - "dzil authordeps --missing | grep -vP '[^\\w:]' | xargs -n 5 -P 10 cpanm --quiet --notest" + - "dzil listdeps --author --missing | grep -vP '[^\\w:]' | cpanm --verbose" +script: + - dzil smoke --release --author diff --git a/Changes b/Changes new file mode 100644 index 0000000..79dd49f --- /dev/null +++ b/Changes @@ -0,0 +1,4 @@ +Revision history for Linux-Proc-Maps. + +{{$NEXT}} + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..1935df6 --- /dev/null +++ b/LICENSE @@ -0,0 +1,379 @@ +This software is copyright (c) 2016 by Charles McGarvey. + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. + +Terms of the Perl programming language system itself + +a) the GNU General Public License as published by the Free + Software Foundation; either version 1, or (at your option) any + later version, or +b) the "Artistic License" + +--- The GNU General Public License, Version 1, February 1989 --- + +This software is Copyright (c) 2016 by Charles McGarvey. + +This is free software, licensed under: + + The GNU General Public License, Version 1, February 1989 + + GNU GENERAL PUBLIC LICENSE + Version 1, February 1989 + + Copyright (C) 1989 Free Software Foundation, Inc. + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The license agreements of most software companies try to keep users +at the mercy of those companies. By contrast, our General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. The +General Public License applies to the Free Software Foundation's +software and to any other program whose authors commit to using it. +You can use it for your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Specifically, the General Public License is designed to make +sure that you have the freedom to give away or sell copies of free +software, that you receive source code or can get it if you want it, +that you can change the software or use pieces of it in new free +programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of a such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must tell them their rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any program or other work which +contains a notice placed by the copyright holder saying it may be +distributed under the terms of this General Public License. The +"Program", below, refers to any such program or work, and a "work based +on the Program" means either the Program or any work containing the +Program or a portion of it, either verbatim or with modifications. Each +licensee is addressed as "you". + + 1. You may copy and distribute verbatim copies of the Program's source +code as you receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice and +disclaimer of warranty; keep intact all the notices that refer to this +General Public License and to the absence of any warranty; and give any +other recipients of the Program a copy of this General Public License +along with the Program. You may charge a fee for the physical act of +transferring a copy. + + 2. You may modify your copy or copies of the Program or any portion of +it, and copy and distribute such modifications under the terms of Paragraph +1 above, provided that you also do the following: + + a) cause the modified files to carry prominent notices stating that + you changed the files and the date of any change; and + + b) cause the whole of any work that you distribute or publish, that + in whole or in part contains the Program or any part thereof, either + with or without modifications, to be licensed at no charge to all + third parties under the terms of this General Public License (except + that you may choose to grant warranty protection to some or all + third parties, at your option). + + c) If the modified program normally reads commands interactively when + run, you must cause it, when started running for such interactive use + in the simplest and most usual way, to print or display an + announcement including an appropriate copyright notice and a notice + that there is no warranty (or else, saying that you provide a + warranty) and that users may redistribute the program under these + conditions, and telling the user how to view a copy of this General + Public License. + + d) You may charge a fee for the physical act of transferring a + copy, and you may at your option offer warranty protection in + exchange for a fee. + +Mere aggregation of another independent work with the Program (or its +derivative) on a volume of a storage or distribution medium does not bring +the other work under the scope of these terms. + + 3. You may copy and distribute the Program (or a portion or derivative of +it, under Paragraph 2) in object code or executable form under the terms of +Paragraphs 1 and 2 above provided that you also do one of the following: + + a) accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of + Paragraphs 1 and 2 above; or, + + b) accompany it with a written offer, valid for at least three + years, to give any third party free (except for a nominal charge + for the cost of distribution) a complete machine-readable copy of the + corresponding source code, to be distributed under the terms of + Paragraphs 1 and 2 above; or, + + c) accompany it with the information you received as to where the + corresponding source code may be obtained. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form alone.) + +Source code for a work means the preferred form of the work for making +modifications to it. For an executable file, complete source code means +all the source code for all modules it contains; but, as a special +exception, it need not include source code for modules which are standard +libraries that accompany the operating system on which the executable +file runs, or for standard header files or definitions files that +accompany that operating system. + + 4. You may not copy, modify, sublicense, distribute or transfer the +Program except as expressly provided under this General Public License. +Any attempt otherwise to copy, modify, sublicense, distribute or transfer +the Program is void, and will automatically terminate your rights to use +the Program under this License. However, parties who have received +copies, or rights to use copies, from you under this General Public +License will not have their licenses terminated so long as such parties +remain in full compliance. + + 5. By copying, distributing or modifying the Program (or any work based +on the Program) you indicate your acceptance of this license to do so, +and all its terms and conditions. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the original +licensor to copy, distribute or modify the Program subject to these +terms and conditions. You may not impose any further restrictions on the +recipients' exercise of the rights granted herein. + + 7. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of the license which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +the license, you may choose any version ever published by the Free Software +Foundation. + + 8. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + Appendix: How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to humanity, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + + To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively convey +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) 19yy + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 1, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) 19xx name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the +appropriate parts of the General Public License. Of course, the +commands you use may be called something other than `show w' and `show +c'; they could even be mouse-clicks or menu items--whatever suits your +program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + program `Gnomovision' (a program to direct compilers to make passes + at assemblers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +That's all there is to it! + + +--- The Artistic License 1.0 --- + +This software is Copyright (c) 2016 by Charles McGarvey. + +This is free software, licensed under: + + The Artistic License 1.0 + +The Artistic License + +Preamble + +The intent of this document is to state the conditions under which a Package +may be copied, such that the Copyright Holder maintains some semblance of +artistic control over the development of the package, while giving the users of +the package the right to use and distribute the Package in a more-or-less +customary fashion, plus the right to make reasonable modifications. + +Definitions: + + - "Package" refers to the collection of files distributed by the Copyright + Holder, and derivatives of that collection of files created through + textual modification. + - "Standard Version" refers to such a Package if it has not been modified, + or has been modified in accordance with the wishes of the Copyright + Holder. + - "Copyright Holder" is whoever is named in the copyright or copyrights for + the package. + - "You" is you, if you're thinking about copying or distributing this Package. + - "Reasonable copying fee" is whatever you can justify on the basis of media + cost, duplication charges, time of people involved, and so on. (You will + not be required to justify it to the Copyright Holder, but only to the + computing community at large as a market that must bear the fee.) + - "Freely Available" means that no fee is charged for the item itself, though + there may be fees involved in handling the item. It also means that + recipients of the item may redistribute it under the same conditions they + received it. + +1. You may make and give away verbatim copies of the source form of the +Standard Version of this Package without restriction, provided that you +duplicate all of the original copyright notices and associated disclaimers. + +2. You may apply bug fixes, portability fixes and other modifications derived +from the Public Domain or from the Copyright Holder. A Package modified in such +a way shall still be considered the Standard Version. + +3. You may otherwise modify your copy of this Package in any way, provided that +you insert a prominent notice in each changed file stating how and when you +changed that file, and provided that you do at least ONE of the following: + + a) place your modifications in the Public Domain or otherwise make them + Freely Available, such as by posting said modifications to Usenet or an + equivalent medium, or placing the modifications on a major archive site + such as ftp.uu.net, or by allowing the Copyright Holder to include your + modifications in the Standard Version of the Package. + + b) use the modified Package only within your corporation or organization. + + c) rename any non-standard executables so the names do not conflict with + standard executables, which must also be provided, and provide a separate + manual page for each non-standard executable that clearly documents how it + differs from the Standard Version. + + d) make other distribution arrangements with the Copyright Holder. + +4. You may distribute the programs of this Package in object code or executable +form, provided that you do at least ONE of the following: + + a) distribute a Standard Version of the executables and library files, + together with instructions (in the manual page or equivalent) on where to + get the Standard Version. + + b) accompany the distribution with the machine-readable source of the Package + with your modifications. + + c) accompany any non-standard executables with their corresponding Standard + Version executables, giving the non-standard executables non-standard + names, and clearly documenting the differences in manual pages (or + equivalent), together with instructions on where to get the Standard + Version. + + d) make other distribution arrangements with the Copyright Holder. + +5. You may charge a reasonable copying fee for any distribution of this +Package. You may charge any fee you choose for support of this Package. You +may not charge a fee for this Package itself. However, you may distribute this +Package in aggregate with other (possibly commercial) programs as part of a +larger (possibly commercial) software distribution provided that you do not +advertise this Package as a product of your own. + +6. The scripts and library files supplied as input to or produced as output +from the programs of this Package do not automatically fall under the copyright +of this Package, but belong to whomever generated them, and may be sold +commercially, and may be aggregated with this Package. + +7. C or perl subroutines supplied by you and linked into this Package shall not +be considered part of this Package. + +8. The name of the Copyright Holder may not be used to endorse or promote +products derived from this software without specific prior written permission. + +9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED +WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF +MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + +The End + diff --git a/README.md b/README.md new file mode 100644 index 0000000..cbf3513 --- /dev/null +++ b/README.md @@ -0,0 +1,102 @@ +# NAME + +Linux::Proc::Maps - Read and write /proc/\[pid\]/maps files + +# VERSION + +version 0.001 + +# SYNOPSIS + + use Linux::Proc::Maps qw(read_maps); + + # by pid: + my $vm_regions = read_maps(pid => $$); + + # by pid with explicit procfs mount: + my $vm_regions = read_maps(mnt => '/proc', pid => 123); + + # by file: + my $vm_regions = read_maps(file => '/proc/456/maps'); + +# DESCRIPTION + +This module reads and writes `/proc/[pid]/maps` files that contain listed mapped memory regions. + +# METHODS + +## read\_maps %args + +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. + +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 + +Returns a string with the contents of a maps file from the memory regions passed. + +This is the opposite of ["read\_maps"](#read_maps). + +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 and return a single line from a maps file into a region represented as a hashref. + +For example, + + # address perms offset dev inode pathname + 08048000-08056000 r-xp 00000000 03:0c 64593 /usr/sbin/gpm + +becomes: + + { + address_start => 134512640, + address_end => 134569984, + read => 1, + write => '', + execute => 1, + shared => '', + offset => 0, + device => '03:0c' + inode => '64593', + pathname => '/usr/sbin/gpm', + } + +## format\_maps\_single\_line \\%region + +Return a single line for a maps file from a region represented as a hashref. + +This is the opposite of ["parse\_maps\_single\_line"](#parse_maps_single_line). + +# SEE ALSO + +[proc(5)](http://man.he.net/man5/proc) describes the file format. + +# BUGS + +Please report any bugs or feature requests on the bugtracker website +[https://github.com/chazmcgarvey/Linux-Proc-Maps/issues](https://github.com/chazmcgarvey/Linux-Proc-Maps/issues) + +When submitting a bug or request, please include a test-file or a +patch to an existing test-file that illustrates the bug or desired +feature. + +# AUTHOR + +Charles McGarvey + +# COPYRIGHT AND LICENSE + +This software is copyright (c) 2016 by Charles McGarvey. + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. diff --git a/corpus/maps1 b/corpus/maps1 new file mode 100644 index 0000000..37d86a2 --- /dev/null +++ b/corpus/maps1 @@ -0,0 +1,20 @@ +00400000-0040c000 r-xp 00000000 08:01 23624 /bin/cat +0060b000-0060c000 r--p 0000b000 08:01 23624 /bin/cat +0060c000-0060d000 rw-p 0000c000 08:01 23624 /bin/cat +021d8000-021f9000 rw-p 00000000 00:00 0 [heap] +7f5d19f24000-7f5d1a0f2000 r--p 00000000 08:01 24504 /usr/lib64/locale/locale-archive +7f5d1a0f2000-7f5d1a28a000 r-xp 00000000 08:01 48313 /lib64/libc-2.22.so +7f5d1a28a000-7f5d1a48a000 ---p 00198000 08:01 48313 /lib64/libc-2.22.so +7f5d1a48a000-7f5d1a48e000 r--p 00198000 08:01 48313 /lib64/libc-2.22.so +7f5d1a48e000-7f5d1a490000 rw-p 0019c000 08:01 48313 /lib64/libc-2.22.so +7f5d1a490000-7f5d1a494000 rw-p 00000000 00:00 0 +7f5d1a494000-7f5d1a4b6000 r-xp 00000000 08:01 48312 /lib64/ld-2.22.so +7f5d1a67d000-7f5d1a680000 rw-p 00000000 00:00 0 +7f5d1a692000-7f5d1a6b5000 rw-p 00000000 00:00 0 +7f5d1a6b5000-7f5d1a6b6000 r--p 00021000 08:01 48312 /lib64/ld-2.22.so +7f5d1a6b6000-7f5d1a6b7000 rw-p 00022000 08:01 48312 /lib64/ld-2.22.so +7f5d1a6b7000-7f5d1a6b8000 rw-p 00000000 00:00 0 +7ffc6eeac000-7ffc6eece000 rw-p 00000000 00:00 0 [stack] +7ffc6ef4f000-7ffc6ef51000 r--p 00000000 00:00 0 [vvar] +7ffc6ef51000-7ffc6ef53000 r-xp 00000000 00:00 0 [vdso] +ffffffffff600000-ffffffffff601000 r-xp 00000000 00:00 0 [vsyscall] diff --git a/dist.ini b/dist.ini new file mode 100644 index 0000000..02f165b --- /dev/null +++ b/dist.ini @@ -0,0 +1,8 @@ + +name = Linux-Proc-Maps +author = Charles McGarvey +license = Perl_5 +copyright_holder = Charles McGarvey + +[@Author::CCM] + diff --git a/lib/Linux/Proc/Maps.pm b/lib/Linux/Proc/Maps.pm new file mode 100644 index 0000000..21a3b12 --- /dev/null +++ b/lib/Linux/Proc/Maps.pm @@ -0,0 +1,210 @@ +package Linux::Proc::Maps; +# ABSTRACT: Read and write /proc/[pid]/maps files +# KEYWORDS: linux proc procfs + +use warnings; +use strict; + +our $VERSION = '999.999'; # VERSION + +use Carp qw(croak); +use Exporter qw(import); +use namespace::clean -except => [qw(import)]; + +our @EXPORT_OK = qw(read_maps write_maps parse_maps_single_line format_maps_single_line); + +=head1 SYNOPSIS + + use Linux::Proc::Maps qw(read_maps); + + # by pid: + my $vm_regions = read_maps(pid => $$); + + # by pid with explicit procfs mount: + my $vm_regions = read_maps(mnt => '/proc', pid => 123); + + # by file: + my $vm_regions = read_maps(file => '/proc/456/maps'); + +=head1 DESCRIPTION + +This module reads and writes F files that contain listed mapped memory regions. + +=method read_maps + +Read and parse a maps file, returning an arrayref of regions (each represented as a hashref). See +L to see the format of the hashrefs. + + my $regions = read_maps(%args); + +Arguments: + +=for :list +* C - Path to maps file +* C - Process ID (one of C or C is required) +* C - Absolute path where L is mounted (optional, default: C) + +=cut + +sub read_maps { + my %args = @_ == 1 ? (pid => $_[0]) : @_; + + my $file = $args{file}; + + if (!$file and my $pid = $args{pid}) { + if ($pid =~ /^\d+$/) { + require File::Spec::Functions; + my $procfs = $args{mnt} || $ENV{PERL_LINUX_PROC_MAPS_MOUNT} || + File::Spec::Functions::catdir(File::Spec::Functions::rootdir(), 'proc'); + $file = File::Spec::Functions::catfile($procfs, $pid, 'maps'); + } + else { + $file = $args{pid}; + } + } + + $file or croak 'Filename or PID required'; + open(my $fh, '<:encoding(UTF-8)', $file) or croak "Open failed ($file): $!"; + + my @regions; + + while (my $line = <$fh>) { + chomp $line; + + my $region = parse_maps_single_line($line); + next if !$region; + + push @regions, $region; + } + + return \@regions; +} + +=method 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 L. + +Arguments: + +=for :list +* C - Write maps to this open file handle (optional) +* C - Open this filepath and write maps to that file (optional) + +=cut + +sub write_maps { + my $regions = shift or croak 'Regions required'; + my %args = @_; + + ref $regions eq 'ARRAY' or croak 'Regions must be an arrayref'; + + my $out = ''; + + for my $region (@$regions) { + $out .= format_maps_single_line($region); + } + + # maybe print out the memory regions to a filehandle + my $fh = $args{fh}; + if (!$fh and my $file = $args{file}) { + open($fh, '>:encoding(UTF-8)', $file) or croak "Open failed ($file): $!"; + } + print $fh $out if $fh; + + return $out; +} + +=method 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 + 08048000-08056000 r-xp 00000000 03:0c 64593 /usr/sbin/gpm + +becomes: + + { + address_start => 134512640, + address_end => 134569984, + read => 1, + write => '', + execute => 1, + shared => '', + offset => 0, + device => '03:0c' + inode => '64593', + pathname => '/usr/sbin/gpm', + } + +=cut + +sub parse_maps_single_line { + my $line = shift or croak 'Line from a maps file required'; + + chomp $line; + + my ($addr1, $addr2, $read, $write, $exec, $shared, $offset, $device, $inode, $pathname) = $line =~ m{ + ^ + ([[:xdigit:]]+)-([[:xdigit:]]+) + \s+ ([r-])([w-])([x-])([sp]) + \s+ ([[:xdigit:]]+) + \s+ ([[:xdigit:]]+:[[:xdigit:]]+) + \s+ (\d+) + (?: \s+ (.*))? + }x; + + return if !$addr1; + + no warnings 'portable'; # for hex() on 64-bit perls + + return { + address_start => hex($addr1), + address_end => hex($addr2), + read => 'r' eq $read, + write => 'w' eq $write, + execute => 'x' eq $exec, + shared => 's' eq $shared, + offset => hex($offset), + device => $device, + inode => $inode, + pathname => $pathname || '', + }; +} + +=method 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 L. + +=cut + +sub format_maps_single_line { + my $region = shift or croak 'Region required'; + + my @args = @{$region}{qw(address_start address_end read write execute shared offset device inode)}; + $args[2] = $args[2] ? 'r' : '-'; + $args[3] = $args[3] ? 'w' : '-'; + $args[4] = $args[4] ? 'x' : '-'; + $args[5] = $args[5] ? 's' : 'p'; + + return sprintf("%-72s %s\n", sprintf("%x-%x %s%s%s%s %08x %s %d", @args), $region->{pathname}); +} + +=head1 SEE ALSO + +L describes the file format. + +=cut + +1; diff --git a/t/01-basic.t b/t/01-basic.t new file mode 100644 index 0000000..15692ce --- /dev/null +++ b/t/01-basic.t @@ -0,0 +1,75 @@ +#!perl + +use warnings; +use strict; + +use Path::Tiny; +use Test::More tests => 4; + +BEGIN { + use_ok('Linux::Proc::Maps'); + use_ok('Linux::Proc::Maps', qw{read_maps write_maps parse_maps_single_line format_maps_single_line}); +} + +subtest read_maps => sub { + plan tests => 4; + + eval { read_maps() }; + like($@, qr/filename or pid required/i, 'Die on missing argument'); + + eval { read_maps('missing-ebo3d1FHkKEAsGL3ZK89H5') }; + like($@, qr/open failed/i, 'Die on open failed'); + + my $regions = read_maps(path('corpus/maps1')->absolute); + isa_ok($regions, 'ARRAY'); + is(scalar @$regions, 20, 'Number of regions is correct'); + # note explain $regions; +}; + +subtest parse_maps_single_line => sub { + plan tests => 7; + + { + my $line = '00400000-0040c000 r-xp 00000000 08:01 23624 /bin/cat'; + my $region = parse_maps_single_line($line); + + isa_ok($region, 'HASH'); + is_deeply($region, { + address_end => 4243456, + address_start => 4194304, + device => '08:01', + execute => 1, + inode => 23624, + offset => 0, + pathname => '/bin/cat', + read => 1, + shared => '', + write => '', + }, 'Region parses correctly'); + # note explain $region; + } + + { + my $line = '021d8000-021f9000 rw-p 00000000 00:00 0 [heap]'; + my $region = parse_maps_single_line($line); + + isa_ok($region, 'HASH'); + is($region->{pathname}, '[heap]', 'Heap region identified'); + } + + { + my $line = '7f5d1a490000-7f5d1a494000 rw-p 00000000 00:00 0 '; + my $region = parse_maps_single_line($line); + + isa_ok($region, 'HASH'); + is($region->{pathname}, '', 'Pathname is optional'); + } + + { + my $line = '7f5d1a490000-7f5d1a494000 rw-p 00000000 00:00'; + my $region = parse_maps_single_line($line); + + is($region, undef, 'Missing inode correctly fails'); + } +}; + -- 2.43.0