gadget: add gadget.bytes_maxlen to truncate /Rt bytes column#6409
Open
clmoon2 wants to merge 1 commit into
Open
gadget: add gadget.bytes_maxlen to truncate /Rt bytes column#6409clmoon2 wants to merge 1 commit into
clmoon2 wants to merge 1 commit into
Conversation
…ggh-6359) The /Rt gadget search table prints the full hex of every gadget in the bytes column, which gets visually unmanageable once gadgets are more than a handful of instructions long. Add gadget.bytes_maxlen (default 0 = no truncation, preserves current behavior). When set to N, the bytes column for each row is capped at N bytes (2*N hex chars) with a trailing ... so the table stays readable even with long gadgets. Only affects table mode (/Rt); JSON, quiet, and standard modes are unchanged.
clmoon2
requested review from
Rot127,
b1llow,
kazarmy,
notxvilka,
ret2libc,
thestr4ng3r and
wargio
as code owners
wargio
reviewed
May 26, 2026
Comment on lines
+1316
to
+1318
| // gh-6359: optionally cap the bytes column. The hex string | ||
| // has two characters per byte, so a byte limit of N maps to | ||
| // 2*N hex chars before the truncation marker. |
wargio
reviewed
May 26, 2026
| SETBPREF("gadget.subchains", "false", "Display every length gadget from gadget.len=X to 2"); | ||
| SETBPREF("gadget.conditional", "false", "Include conditional jump, calls and returns in gadget search"); | ||
| SETBPREF("gadget.comments", "false", "Display comments in gadget search output"); | ||
| SETI("gadget.bytes_maxlen", 0, "Truncate the bytes column in /Rt table output to N bytes (0 = no truncation, append ... when truncated)"); |
Member
There was a problem hiding this comment.
Suggested change
| SETI("gadget.bytes_maxlen", 0, "Truncate the bytes column in /Rt table output to N bytes (0 = no truncation, append ... when truncated)"); | |
| SETI("gadget.bytes_maxlen", 0, "Truncate the bytes column in the gadget output table to N bytes (0 = disabled)"); |
Member
|
It's forbidden to remove the checklist. i have added it back. fill it up |
Author
|
filled in the checklist, sorry for stripping it out. let me know if anything else is needed. |
Member
|
@MrQuantum1915 have a look. |
wargio
changed the title
Codecov Report❌ Patch coverage is
Additional details and impacted files
... and 15 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
Contributor
MrQuantum1915
left a comment
MrQuantum1915
left a comment
There was a problem hiding this comment.
See one suggestion below
Also I think we should add 1 related test in test/db/cmd/cmd_rop.
otherwise LGTM
| SETBPREF("gadget.subchains", "false", "Display every length gadget from gadget.len=X to 2"); | ||
| SETBPREF("gadget.conditional", "false", "Include conditional jump, calls and returns in gadget search"); | ||
| SETBPREF("gadget.comments", "false", "Display comments in gadget search output"); | ||
| SETI("gadget.bytes_maxlen", 0, "Truncate the bytes column in /Rt table output to N bytes (0 = no truncation, append ... when truncated)"); |
Contributor
There was a problem hiding this comment.
since this config is restricted to only table mode, it would be better to use something like gadget.table.maxbytes
@wargio WDYT?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Your checklist for this pull request
RZ_APIfunction and struct this PR changes.RZ_API).Closes #6359.
The bytes column in
/Rttable mode shows the full concatenated hex of every instruction in the gadget, which gets visually unmanageable once gadgets are more than a handful of instructions long. The issue asks for a config var to cap that with an ellipsis when it overflows.Added
gadget.bytes_maxlen. Default is0so nothing changes for existing users. When set to N, each row's bytes column is capped at2*Nhex chars and a trailing...is appended.Scoped to
RZ_OUTPUT_MODE_TABLEonly. JSON, quiet, and standard modes need the full bytes for downstream consumption, so left alone.This config option could use a line in the Rizin book; left box 5 unchecked since the book is a separate repo. No test in this PR: the existing /Rt fixture (
bins/elf/varsub) has short gadgets that don't exercise the truncation.