Some enhancements about `pwndbg.gdblib.config` #1315

lebr0nli · 2022-10-21T19:48:56Z

Summary about this PR:

Support all parameter-class when create a GDB parameter
Use get_show_string to render better output when using show <param> (although GDB 12.x will do similar things by default, this function just makes sure every version can have that kind of output)
Show more information when using help set <param> and help show <param> if we create a config with help_docstring parameter.

Here are some examples of the updates included in this PR:

gdb.PARAM_AUTO_BOOLEAN with help_docstring

In Python script:

pwndbg.gdblib.config.add_param(
    "test",
    None,
    "test",
    help_docstring="on == AAAA\noff == BBBB\nauto == CCCC",
    param_class=gdb.PARAM_AUTO_BOOLEAN,
    scope="test",
)

In GDB:

pwndbg> show test
The current value of 'test' is 'auto'
pwndbg> set test on
Set test to 'on'
pwndbg> set test off
Set test to 'off'
pwndbg> set test auto_with_typo
"on", "off" or "auto" expected.
pwndbg> show test
The current value of 'test' is 'off'
pwndbg> set test auto
Set test to 'auto'
pwndbg> show test
The current value of 'test' is 'auto'
pwndbg> help show test
Show test
on == AAAA
off == BBBB
auto == CCCC
pwndbg> help set test
Set test
on == AAAA
off == BBBB
auto == CCCC

gdb.PARAM_AUTO_BOOLEAN with help_docstring

In Python script:

pwndbg.gdblib.config.add_param(
    "test",
    "A",
    "test",
    help_docstring="A == AAAA\nB == BBBB\nC == CCCC",
    param_class=gdb.PARAM_ENUM,
    enum_sequence=["A", "B", "C"],
    scope="test",
)

In GDB:

pwndbg> show test
The current value of 'test' is 'A'
pwndbg> set test B
Set test to 'B'
pwndbg> set test C
Set test to 'C'
pwndbg> set test D
Undefined item: "D".
pwndbg> show test
The current value of 'test' is 'C'
pwndbg> help show test
Show test
A == AAAA
B == BBBB
C == CCCC
pwndbg> help set test
Set test
A == AAAA
B == BBBB
C == CCCC

* Support all parameter-class * Use `get_show_string` to render better output when using `show <param>` * Show more information when using `help set <param>` and `help show <param>` if we create a config with `help_docstring` parameter. Some examples of the updates included in this commit: 1. `gdb.PARAM_AUTO_BOOLEAN` with `help_docstring` In Python script: ``` pwndbg.gdblib.config.add_param( "test", None, "test", "on == AAAA\noff == BBBB\nauto == CCCC", gdb.PARAM_AUTO_BOOLEAN, scope="test", ) ``` In GDB: ``` pwndbg> show test The current value of 'test' is 'auto' pwndbg> set test on Set test to 'on' pwndbg> set test off Set test to 'off' pwndbg> set test auto_with_typo "on", "off" or "auto" expected. pwndbg> show test The current value of 'test' is 'off' pwndbg> set test auto Set test to 'auto' pwndbg> show test The current value of 'test' is 'auto' pwndbg> help show test Show test on == AAAA off == BBBB auto == CCCC pwndbg> help set test Set test on == AAAA off == BBBB auto == CCCC ``` 2. `gdb.PARAM_AUTO_BOOLEAN` with `help_docstring` In Python script: ``` pwndbg.gdblib.config.add_param( "test", "A", "test", "A == AAAA\nB == BBBB\nC == CCCC", gdb.PARAM_ENUM, ["A", "B", "C"], scope="test", ) ``` In GDB: ``` pwndbg> show test The current value of 'test' is 'A' pwndbg> set test B Set test to 'B' pwndbg> set test C Set test to 'C' pwndbg> set test D Undefined item: "D". pwndbg> show test The current value of 'test' is 'C' pwndbg> help show test Show test A == AAAA B == BBBB C == CCCC pwndbg> help set test Set test A == AAAA B == BBBB C == CCCC ```

codecov-commenter · 2022-10-21T19:53:39Z

Codecov Report

Merging #1315 (2921927) into dev (5a323b4) will decrease coverage by 0.00%.
The diff coverage is 71.05%.

@@            Coverage Diff             @@
##              dev    #1315      +/-   ##
==========================================
- Coverage   55.04%   55.03%   -0.01%     
==========================================
  Files         156      156              
  Lines       19397    19410      +13     
  Branches     1804     1809       +5     
==========================================
+ Hits        10677    10683       +6     
- Misses       8276     8278       +2     
- Partials      444      449       +5

Impacted Files	Coverage Δ
pwndbg/gdblib/config.py	`68.88% <42.10%> (-10.53%)`	⬇️
pwndbg/color/theme.py	`100.00% <100.00%> (ø)`
pwndbg/glibc.py	`75.43% <100.00%> (ø)`
pwndbg/heap/__init__.py	`90.90% <100.00%> (+0.58%)`	⬆️
pwndbg/lib/config.py	`90.80% <100.00%> (+0.56%)`	⬆️
pwndbg/commands/vmmap.py	`43.15% <0.00%> (-1.18%)`	⬇️
pwndbg/lib/memory.py	`93.15% <0.00%> (-0.28%)`	⬇️
pwndbg/disasm/arch.py	`78.94% <0.00%> (ø)`
pwndbg/commands/flags.py	`37.03% <0.00%> (ø)`
pwndbg/disasm/__init__.py	`59.58% <0.00%> (ø)`
... and 1 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

gsingh93

Thanks for doing this and thanks for adding so many comments :) It was very easy to review.

pwndbg/gdblib/config.py

pwndbg/heap/__init__.py

tests/gdb-tests/tests/test_gdblib_parameter.py

gsingh93 · 2022-10-21T20:13:11Z

tests/gdb-tests/tests/test_gdblib_parameter.py

+    ):
+        # Note: This is really weird, according to GDB docs, 0 should mean "unlimited" for gdb.PARAM_UINTEGER and gdb.PARAM_INTEGER, but somehow GDB sets the value to `None` actually :/
+        # And hilarious thing is that GDB won't let you set the default value to `None` when you construct the `gdb.Parameter` object with `gdb.PARAM_UINTEGER` or `gdb.PARAM_INTEGER` lol
+        # Maybe it's a bug of GDB?


Let's consider reporting this upstream if we can.

Ok, I sent it to the mailing list of GDB now.

Link the discussion in a comment reply to this PR pls

https://sourceware.org/pipermail/gdb/2022-October/050398.html

https://sourceware.org/pipermail/gdb/2022-October/050398.html

Update: https://sourceware.org/pipermail/gdb/2022-October/050426.html
If I didn't misunderstand something, seems like the value in Python to represent unlimited will only be None instead of some integers in the future.
So we'll probably need to update the code here, the tests' params, and _value_to_gdb_native() to fit the new API in the future.

pwndbg/lib/config.py

gsingh93

LGTM, will let @disconnect3d take a look and merge.

gsingh93 · 2022-10-22T16:50:12Z

pwndbg/lib/config.py

+    def __init__(
+        self,
+        name,
+        default,
+        docstring,
+        help_docstring=None,
+        param_class=None,
+        enum_sequence=None,
+        scope="config",
+    ):


Maybe we should also add the * in here to force keyword params starting from help_docstring?

That probably makes sense, 👍.

Btw one note: docstring and help_docstring is not so obvious I guess? I already merged this but noticed this only now. Maybe we should rename docstring to set_show_doc?

* Add `*`: pwndbg#1315 (comment) * Use `set_show_doc` instead of `docstring`: pwndbg#1315 (comment)

…lated to config (#1388) * Add a config for the `vis_heap_chunks` command After this commit, we can use `set default-visualize-chunk-number <number>` to set the default value of the `count` argument of the `vis_heap_chunks` command. * Add a test for `default-visualize-chunk-number` * Refactor some code related to config * Add `*`: #1315 (comment) * Use `set_show_doc` instead of `docstring`: #1315 (comment)

lebr0nli added 3 commits October 22, 2022 03:22

Update the tests for gdblib parameter

013df85

Use auto boolean for safe-linking

d537e43

gsingh93 self-requested a review October 21, 2022 19:53

gsingh93 reviewed Oct 21, 2022

View reviewed changes

pwndbg/lib/config.py Show resolved Hide resolved

lebr0nli added 4 commits October 22, 2022 17:26

Fix some comments

14532fa

Pass help_docstring directly

609b3de

Force callers of add_param to use keyword arguments

f88d455

Create add_heap_param() to avoid setting the scope of param everytime

2921927

lebr0nli force-pushed the update-config branch from 986f51e to 2921927 Compare October 22, 2022 11:57

gsingh93 approved these changes Oct 22, 2022

View reviewed changes

disconnect3d merged commit 5b56071 into pwndbg:dev Oct 22, 2022

lebr0nli added a commit to lebr0nli/pwndbg that referenced this pull request Nov 21, 2022

Refactor some code related to config

3f286b9

* Add `*`: pwndbg#1315 (comment) * Use `set_show_doc` instead of `docstring`: pwndbg#1315 (comment)

lebr0nli added a commit to lebr0nli/pwndbg that referenced this pull request Nov 21, 2022

Refactor some code related to config

1504fc2

* Add `*`: pwndbg#1315 (comment) * Use `set_show_doc` instead of `docstring`: pwndbg#1315 (comment)

lebr0nli mentioned this pull request Nov 21, 2022

Add default-visualize-chunk-number config and refactor some code related to config #1388

Merged

lebr0nli deleted the update-config branch December 5, 2022 14:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Some enhancements about `pwndbg.gdblib.config` #1315

Some enhancements about `pwndbg.gdblib.config` #1315

lebr0nli commented Oct 21, 2022 •

edited

Loading

codecov-commenter commented Oct 21, 2022 •

edited

Loading

gsingh93 left a comment

gsingh93 Oct 21, 2022

lebr0nli Oct 22, 2022

disconnect3d Oct 22, 2022

lebr0nli Oct 23, 2022

lebr0nli Oct 31, 2022

gsingh93 left a comment

gsingh93 Oct 22, 2022

disconnect3d Oct 22, 2022

Some enhancements about pwndbg.gdblib.config #1315

Some enhancements about pwndbg.gdblib.config #1315

Conversation

lebr0nli commented Oct 21, 2022 • edited Loading

codecov-commenter commented Oct 21, 2022 • edited Loading

Codecov Report

gsingh93 left a comment

Choose a reason for hiding this comment

gsingh93 Oct 21, 2022

Choose a reason for hiding this comment

lebr0nli Oct 22, 2022

Choose a reason for hiding this comment

disconnect3d Oct 22, 2022

Choose a reason for hiding this comment

lebr0nli Oct 23, 2022

Choose a reason for hiding this comment

lebr0nli Oct 31, 2022

Choose a reason for hiding this comment

gsingh93 left a comment

Choose a reason for hiding this comment

gsingh93 Oct 22, 2022

Choose a reason for hiding this comment

disconnect3d Oct 22, 2022

Choose a reason for hiding this comment

Some enhancements about `pwndbg.gdblib.config` #1315

Some enhancements about `pwndbg.gdblib.config` #1315

lebr0nli commented Oct 21, 2022 •

edited

Loading

codecov-commenter commented Oct 21, 2022 •

edited

Loading