From 76e7347ecfebfda702e193b4de52130bacb1078d Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Mon, 19 Sep 2022 18:33:30 -0700 Subject: [PATCH] add proc-pid-maps parser --- docs/parsers/proc_pid_maps.md | 125 ++++++++++++++++++++++ jc/lib.py | 1 + jc/parsers/proc_pid_maps.py | 191 ++++++++++++++++++++++++++++++++++ man/jc.1 | 5 + 4 files changed, 322 insertions(+) create mode 100644 docs/parsers/proc_pid_maps.md create mode 100644 jc/parsers/proc_pid_maps.py diff --git a/docs/parsers/proc_pid_maps.md b/docs/parsers/proc_pid_maps.md new file mode 100644 index 00000000..7ca1557b --- /dev/null +++ b/docs/parsers/proc_pid_maps.md @@ -0,0 +1,125 @@ +[Home](https://kellyjonbrazil.github.io/jc/) + + +# jc.parsers.proc\_pid\_maps + +jc - JSON Convert `/proc//maps` file parser + +Usage (cli): + + $ cat /proc/1/maps | jc --proc + +or + + $ jc /proc/1/maps + +or + + $ cat /proc/1/maps | jc --proc-pid-maps + +Usage (module): + + import jc + result = jc.parse('proc', proc_pid_maps_file) + +or + + import jc + result = jc.parse('proc_pid_maps', proc_pid_maps_file) + +Schema: + + [ + { + "start": string, + "end": string, + "perms": [ + string + ], + "offset": string, + "inode": integer, + "pathname": string, + "maj": string, + "min": string + } + ] + +Examples: + + $ cat /proc/1/maps | jc --proc -p + [ + { + "perms": [ + "read", + "private" + ], + "offset": "00000000", + "inode": 798126, + "pathname": "/usr/lib/systemd/systemd", + "start": "55a9e753c000", + "end": "55a9e7570000", + "maj": "fd", + "min": "00" + }, + { + "perms": [ + "read", + "execute", + "private" + ], + "offset": "00034000", + "inode": 798126, + "pathname": "/usr/lib/systemd/systemd", + "start": "55a9e7570000", + "end": "55a9e763a000", + "maj": "fd", + "min": "00" + }, + ... + ] + + $ cat /proc/1/maps | jc --proc-pid-maps -p -r + [ + { + "address": "55a9e753c000-55a9e7570000", + "perms": "r--p", + "offset": "00000000", + "dev": "fd:00", + "inode": "798126", + "pathname": "/usr/lib/systemd/systemd" + }, + { + "address": "55a9e7570000-55a9e763a000", + "perms": "r-xp", + "offset": "00034000", + "dev": "fd:00", + "inode": "798126", + "pathname": "/usr/lib/systemd/systemd" + }, + ... + ] + + + +### parse + +```python +def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict] +``` + +Main text parsing function + +Parameters: + + data: (string) text data to parse + raw: (boolean) unprocessed output if True + quiet: (boolean) suppress warning messages if True + +Returns: + + List of Dictionaries. Raw or processed structured data. + +### Parser Information +Compatibility: linux + +Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com) diff --git a/jc/lib.py b/jc/lib.py index c7e21bd2..4fbb91a7 100644 --- a/jc/lib.py +++ b/jc/lib.py @@ -114,6 +114,7 @@ parsers = [ 'proc-zoneinfo', 'proc-pid-fdinfo', 'proc-pid-io', + 'proc-pid-maps', 'proc-pid-numa-maps', 'ps', 'route', diff --git a/jc/parsers/proc_pid_maps.py b/jc/parsers/proc_pid_maps.py new file mode 100644 index 00000000..22c8765b --- /dev/null +++ b/jc/parsers/proc_pid_maps.py @@ -0,0 +1,191 @@ +"""jc - JSON Convert `/proc//maps` file parser + +Usage (cli): + + $ cat /proc/1/maps | jc --proc + +or + + $ jc /proc/1/maps + +or + + $ cat /proc/1/maps | jc --proc-pid-maps + +Usage (module): + + import jc + result = jc.parse('proc', proc_pid_maps_file) + +or + + import jc + result = jc.parse('proc_pid_maps', proc_pid_maps_file) + +Schema: + + [ + { + "start": string, + "end": string, + "perms": [ + string + ], + "offset": string, + "inode": integer, + "pathname": string, + "maj": string, + "min": string + } + ] + +Examples: + + $ cat /proc/1/maps | jc --proc -p + [ + { + "perms": [ + "read", + "private" + ], + "offset": "00000000", + "inode": 798126, + "pathname": "/usr/lib/systemd/systemd", + "start": "55a9e753c000", + "end": "55a9e7570000", + "maj": "fd", + "min": "00" + }, + { + "perms": [ + "read", + "execute", + "private" + ], + "offset": "00034000", + "inode": 798126, + "pathname": "/usr/lib/systemd/systemd", + "start": "55a9e7570000", + "end": "55a9e763a000", + "maj": "fd", + "min": "00" + }, + ... + ] + + $ cat /proc/1/maps | jc --proc-pid-maps -p -r + [ + { + "address": "55a9e753c000-55a9e7570000", + "perms": "r--p", + "offset": "00000000", + "dev": "fd:00", + "inode": "798126", + "pathname": "/usr/lib/systemd/systemd" + }, + { + "address": "55a9e7570000-55a9e763a000", + "perms": "r-xp", + "offset": "00034000", + "dev": "fd:00", + "inode": "798126", + "pathname": "/usr/lib/systemd/systemd" + }, + ... + ] +""" +from typing import List, Dict +import jc.utils +from jc.parsers.universal import simple_table_parse + + +class info(): + """Provides parser metadata (version, author, etc.)""" + version = '1.0' + description = '`/proc//maps` file parser' + author = 'Kelly Brazil' + author_email = 'kellyjonbrazil@gmail.com' + compatible = ['linux'] + hidden = True + + +__version__ = info.version + + +def _process(proc_data: List[Dict]) -> List[Dict]: + """ + Final processing to conform to the schema. + + Parameters: + + proc_data: (List of Dictionaries) raw structured data to process + + Returns: + + List of Dictionaries. Structured to conform to the schema. + """ + int_list = {'inode'} + + perms_map = { + 'r': 'read', + 'w': 'write', + 'x': 'execute', + 's': 'shared', + 'p': 'private', + '-': None + } + + for entry in proc_data: + for key in entry: + if key in int_list: + entry[key] = int(entry[key]) + + if 'address' in entry: + start, end = entry['address'].split('-') + entry['start'] = start + entry['end'] = end + del entry['address'] + + if 'perms' in entry: + perms_list = [perms_map[x] for x in entry['perms'] if perms_map[x]] + entry['perms'] = perms_list + + if 'dev' in entry: + maj, min = entry['dev'].split(':', maxsplit=1) + entry['maj'] = maj + entry['min'] = min + del entry['dev'] + + return proc_data + + +def parse( + data: str, + raw: bool = False, + quiet: bool = False +) -> List[Dict]: + """ + Main text parsing function + + Parameters: + + data: (string) text data to parse + raw: (boolean) unprocessed output if True + quiet: (boolean) suppress warning messages if True + + Returns: + + List of Dictionaries. Raw or processed structured data. + """ + jc.utils.compatibility(__name__, info.compatible, quiet) + jc.utils.input_type_check(data) + + raw_output: List = [] + + if jc.utils.has_data(data): + + header = 'address perms offset dev inode pathname\n' + data = header + data + raw_output = simple_table_parse(data.splitlines()) + + return raw_output if raw else _process(raw_output) diff --git a/man/jc.1 b/man/jc.1 index 1dbffce2..641d3a6f 100644 --- a/man/jc.1 +++ b/man/jc.1 @@ -555,6 +555,11 @@ PLIST file parser \fB--proc-pid-io\fP `/proc/pid-io` file parser +.TP +.B +\fB--proc-pid-maps\fP +`/proc//maps` file parser + .TP .B \fB--proc-pid-numa-maps\fP