From a583ecba7b1c46cf38564a493c3bcf531656b462 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Mon, 19 Sep 2022 19:26:08 -0700 Subject: [PATCH] add proc-pid-mountinfo parser (initial) --- docs/parsers/proc_pid_io.md | 6 +- docs/parsers/proc_pid_mountinfo.md | 132 ++++++++++++++++++++ jc/lib.py | 1 + jc/parsers/proc_pid_io.py | 8 +- jc/parsers/proc_pid_mountinfo.py | 190 +++++++++++++++++++++++++++++ man/jc.1 | 7 +- 6 files changed, 336 insertions(+), 8 deletions(-) create mode 100644 docs/parsers/proc_pid_mountinfo.md create mode 100644 jc/parsers/proc_pid_mountinfo.py diff --git a/docs/parsers/proc_pid_io.md b/docs/parsers/proc_pid_io.md index 471420ee..63884858 100644 --- a/docs/parsers/proc_pid_io.md +++ b/docs/parsers/proc_pid_io.md @@ -7,15 +7,15 @@ jc - JSON Convert `/proc//io` file parser Usage (cli): - $ cat /proc//io | jc --proc + $ cat /proc/1/io | jc --proc or - $ jc /proc//io + $ jc /proc/1/io or - $ cat /proc//io | jc --proc-pid-io + $ cat /proc/1/io | jc --proc-pid-io Usage (module): diff --git a/docs/parsers/proc_pid_mountinfo.md b/docs/parsers/proc_pid_mountinfo.md new file mode 100644 index 00000000..58ecc4d3 --- /dev/null +++ b/docs/parsers/proc_pid_mountinfo.md @@ -0,0 +1,132 @@ +[Home](https://kellyjonbrazil.github.io/jc/) + + +# jc.parsers.proc\_pid\_mountinfo + +jc - JSON Convert `/proc//mountinfo` file parser + +Usage (cli): + + $ cat /proc/1/mountinfo | jc --proc + +or + + $ jc /proc/1/mountinfo + +or + + $ cat /proc/1/mountinfo | jc --proc-pid-mountinfo + +Usage (module): + + import jc + result = jc.parse('proc', proc_pid_mountinfo_file) + +or + + import jc + result = jc.parse('proc_pid_mountinfo', proc_pid_mountinfo_file) + +Schema: + + [ + { + "module": string, + "size": integer, + "used": integer, + "used_by": [ + string + ], + "status": string, + "location": string + } + ] + +Examples: + + $ cat /proc/1/mountinfo | jc --proc -p + [ + { + "module": "binfmt_misc", + "size": 24576, + "used": 1, + "used_by": [], + "status": "Live", + "location": "0xffffffffc0ab4000" + }, + { + "module": "vsock_loopback", + "size": 16384, + "used": 0, + "used_by": [], + "status": "Live", + "location": "0xffffffffc0a14000" + }, + { + "module": "vmw_vsock_virtio_transport_common", + "size": 36864, + "used": 1, + "used_by": [ + "vsock_loopback" + ], + "status": "Live", + "location": "0xffffffffc0a03000" + }, + ... + ] + + $ cat /proc/1/mountinfo | jc --proc_pid-mountinfo -p -r + [ + { + "module": "binfmt_misc", + "size": "24576", + "used": "1", + "used_by": [], + "status": "Live", + "location": "0xffffffffc0ab4000" + }, + { + "module": "vsock_loopback", + "size": "16384", + "used": "0", + "used_by": [], + "status": "Live", + "location": "0xffffffffc0a14000" + }, + { + "module": "vmw_vsock_virtio_transport_common", + "size": "36864", + "used": "1", + "used_by": [ + "vsock_loopback" + ], + "status": "Live", + "location": "0xffffffffc0a03000" + }, + ... + ] + + + +### 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 4fbb91a7..da8bf7a9 100644 --- a/jc/lib.py +++ b/jc/lib.py @@ -115,6 +115,7 @@ parsers = [ 'proc-pid-fdinfo', 'proc-pid-io', 'proc-pid-maps', + 'proc-pid-mountinfo', 'proc-pid-numa-maps', 'ps', 'route', diff --git a/jc/parsers/proc_pid_io.py b/jc/parsers/proc_pid_io.py index c34c4d8d..8bfe71c1 100644 --- a/jc/parsers/proc_pid_io.py +++ b/jc/parsers/proc_pid_io.py @@ -2,15 +2,15 @@ Usage (cli): - $ cat /proc//io | jc --proc + $ cat /proc/1/io | jc --proc or - $ jc /proc//io + $ jc /proc/1/io or - $ cat /proc//io | jc --proc-pid-io + $ cat /proc/1/io | jc --proc-pid-io Usage (module): @@ -50,7 +50,7 @@ import jc.utils class info(): """Provides parser metadata (version, author, etc.)""" version = '1.0' - description = '`/proc/pid-io` file parser' + description = '`/proc//io` file parser' author = 'Kelly Brazil' author_email = 'kellyjonbrazil@gmail.com' compatible = ['linux'] diff --git a/jc/parsers/proc_pid_mountinfo.py b/jc/parsers/proc_pid_mountinfo.py new file mode 100644 index 00000000..f64018f7 --- /dev/null +++ b/jc/parsers/proc_pid_mountinfo.py @@ -0,0 +1,190 @@ +"""jc - JSON Convert `/proc//mountinfo` file parser + +Usage (cli): + + $ cat /proc/1/mountinfo | jc --proc + +or + + $ jc /proc/1/mountinfo + +or + + $ cat /proc/1/mountinfo | jc --proc-pid-mountinfo + +Usage (module): + + import jc + result = jc.parse('proc', proc_pid_mountinfo_file) + +or + + import jc + result = jc.parse('proc_pid_mountinfo', proc_pid_mountinfo_file) + +Schema: + + [ + { + "module": string, + "size": integer, + "used": integer, + "used_by": [ + string + ], + "status": string, + "location": string + } + ] + +Examples: + + $ cat /proc/1/mountinfo | jc --proc -p + [ + { + "module": "binfmt_misc", + "size": 24576, + "used": 1, + "used_by": [], + "status": "Live", + "location": "0xffffffffc0ab4000" + }, + { + "module": "vsock_loopback", + "size": 16384, + "used": 0, + "used_by": [], + "status": "Live", + "location": "0xffffffffc0a14000" + }, + { + "module": "vmw_vsock_virtio_transport_common", + "size": 36864, + "used": 1, + "used_by": [ + "vsock_loopback" + ], + "status": "Live", + "location": "0xffffffffc0a03000" + }, + ... + ] + + $ cat /proc/1/mountinfo | jc --proc_pid-mountinfo -p -r + [ + { + "module": "binfmt_misc", + "size": "24576", + "used": "1", + "used_by": [], + "status": "Live", + "location": "0xffffffffc0ab4000" + }, + { + "module": "vsock_loopback", + "size": "16384", + "used": "0", + "used_by": [], + "status": "Live", + "location": "0xffffffffc0a14000" + }, + { + "module": "vmw_vsock_virtio_transport_common", + "size": "36864", + "used": "1", + "used_by": [ + "vsock_loopback" + ], + "status": "Live", + "location": "0xffffffffc0a03000" + }, + ... + ] +""" +import re +from typing import List, Dict +import jc.utils + + +class info(): + """Provides parser metadata (version, author, etc.)""" + version = '1.0' + description = '`/proc//mountinfo` 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 = {'size', 'used'} + + for entry in proc_data: + for key in entry: + if key in int_list: + entry[key] = jc.utils.convert_to_int(entry[key]) + + 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): + + line_pattern = re.compile(r''' + ^(?P\d+)\s + (?P\d+)\s + (?P\d+): + (?P\d+)\s + (?P\S+)\s + (?P\S+)\s + (?P\S+)\s? + (?P(?:\s?\S+:\S+\s?)*)\s?-\s + (?P\S+)\s + (?P\S+)\s + (?P\S+) + ''', re.VERBOSE + ) + + for line in filter(None, data.splitlines()): + + line_match = line_pattern.search(line) + if line_match: + raw_output.append(line_match.groupdict()) + + return raw_output if raw else _process(raw_output) diff --git a/man/jc.1 b/man/jc.1 index 641d3a6f..4a72b238 100644 --- a/man/jc.1 +++ b/man/jc.1 @@ -553,13 +553,18 @@ PLIST file parser .TP .B \fB--proc-pid-io\fP -`/proc/pid-io` file parser +`/proc//io` file parser .TP .B \fB--proc-pid-maps\fP `/proc//maps` file parser +.TP +.B +\fB--proc-pid-mountinfo\fP +`/proc//mountinfo` file parser + .TP .B \fB--proc-pid-numa-maps\fP