implement rop.cache to store and return cached ROP search results #5706

devalgupta404 · 2025-12-29T16:57:32Z

Your checklist for this pull request

I've read the guidelines for contributing to this repository.
I made sure to follow the project's coding style.
I've documented every RZ_API function and struct this PR changes.
I've added tests that prove my changes are effective (required for changes to RZ_API).
I've updated the Rizin book with the relevant information (if needed).
I've used AI tools to generate fully or partially these code changes and I'm sure the changes are not copyrighted by somebody else.

Detailed description

The rop.cache config option existed but was never implemented. The cache field in RzRopSearchContext was set from config but never used in the search logic.

This PR implements the caching functionality by:

Using the existing ht_rop hashtable in RzAnalysis to store search results
Keying results by DJB2 hash of the grep argument
Returning cached results immediately on subsequent identical searches
Properly freeing the hashtable on analysis cleanup

Test plan

Unit tests pass:
meson test -C build rop rop_constraint
1/2 rizin:unit / rop OK
2/2 rizin:unit / rop_constraint OK
Timing proof (same as issue rop.cache seems not work in risc-v binary #5544):
[0x00000000]> e rop.cache=true
[0x00000000]> time /R/ jalr
0x000001fa 2ad6 sw a0, 44(sp)
0x000001fc 6df2 bnez a2, 0x1de
0x000001fe 0293 jalr t1
...
0.056576
[0x00000000]> time /R/ jalr
0x000001fa 2ad6 sw a0, 44(sp)
0x000001fc 6df2 bnez a2, 0x1de
0x000001fe 0293 jalr t1
...
0.000016

Search	Time	Notes
1st	0.056576s	Actual search
2nd	0.000016s	Cached (~3500x faster)

Closing issues

closes #5544

codecov · 2025-12-29T19:00:43Z

Codecov Report

❌ Patch coverage is 27.77778% with 13 lines in your changes missing coverage. Please review.
✅ Project coverage is 46.81%. Comparing base (bb70c1a) to head (c0491b5).
⚠️ Report is 6 commits behind head on dev.

Files with missing lines	Patch %	Lines
librz/core/rop.c	23.52%	9 Missing and 4 partials ⚠️

Additional details and impacted files

Files with missing lines	Coverage Δ
librz/arch/analysis.c	`70.00% <100.00%> (+0.05%)`	⬆️
librz/core/rop.c	`57.01% <23.52%> (-0.50%)`	⬇️

... and 13 files with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c6940c5...c0491b5. Read the comment docs.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Rot127 · 2025-12-30T15:34:59Z

test/unit/test_rop.c

+		core, "mov", false, RZ_ROP_GADGET_PRINT, RZ_ROP_DETAIL_SEARCH_NON, NULL);
+	RzCmdStatus status = rz_core_rop_search(core, context);
+	mu_assert_eq(status, RZ_CMD_STATUS_OK, "rop search should succeed");
+	mu_assert_notnull(core->analysis->ht_rop, "ht_rop should be initialized after cached search");


Please also check if the correct result is in the cache.

Then do another search for the same gadget.

@Rot127 should i manually insert result into cache and then verify the second search returns the cached result correctly?

No, after the search the result is expected to be in the cache.

devalgupta404 · 2026-01-10T23:00:35Z

@Rot127 did you check the updated test?

Rot127 · 2026-01-11T00:59:20Z

Please fix the build first

devalgupta404 · 2026-01-13T15:50:56Z

@Rot127 i fixed the build issue please take a look.

Rot127 · 2026-01-13T18:08:26Z

Tests still fail though. Please check

devalgupta404 · 2026-01-15T17:10:45Z

@Rot127 i fixed the build issue and test locally whatever was failing previously

Local Test Verification

Fix: test_rop binary path resolution

Updated test/unit/test_rop.c to correctly resolve the test binary path.

Results

test_rop:

$ build/test/unit/test_rop
test_rop_cache OK
test_rz_direct_solver OK

meson test:

Ok: 146
Fail: 0

rz-test:

24068 OK 1048 BR 11 XX 25 FX

(11 XX are pre-existing failures unrelated to this PR)

So can you please rerun the workflows

…uent searches

- ARM: Update jump table case label from '3...4' to '4' (more precise) - x86_64: Update switch/case ranges to match improved analysis output - cmd_print: Update histogram EXPECT to include ANSI codes that rizin outputs

This reverts commit acca26610a494311626da0d000b029b254b77a33.

devalgupta404 · 2026-01-19T14:58:47Z

@Rot127

While running CI tests locally, I found memory leaks but noticed that CI already
tolerates them (.github/workflows/ci.yml lines 106, 125, 143 - detect_leaks=0
and allow_failure: true).

I fixed some leaks anyway - should I keep or revert these changes?

Also, I moved some tests from unit to integration after learning that unit tests
shouldn't use binaries. Is this correct?

devalgupta404 requested review from Rot127, kazarmy, ret2libc, thestr4ng3r and wargio as code owners December 29, 2025 16:57

github-actions bot added rz-test RzAnalysis RzCore labels Dec 29, 2025

devalgupta404 force-pushed the fix/rop-cache-5544 branch from a6b94e2 to 418a0a9 Compare December 30, 2025 14:33

Rot127 requested changes Dec 30, 2025

View reviewed changes

Rot127 added the Requirements not met The PR doesn't meet the minimum contribution requirements. See CONTRIBUTING.md for details. label Dec 30, 2025

Rot127 marked this pull request as draft December 30, 2025 15:37

devalgupta404 force-pushed the fix/rop-cache-5544 branch 2 times, most recently from c0491b5 to c068675 Compare January 5, 2026 13:44

devalgupta404 force-pushed the fix/rop-cache-5544 branch from c068675 to f5725bf Compare January 11, 2026 13:17

devalgupta404 force-pushed the fix/rop-cache-5544 branch 3 times, most recently from a572e56 to d06143f Compare January 15, 2026 12:19

github-actions bot added RzType RzUtil RZIL labels Jan 15, 2026

devalgupta404 force-pushed the fix/rop-cache-5544 branch from d06143f to de43eb3 Compare January 15, 2026 14:30

devalgupta404 added 2 commits January 17, 2026 10:31

implement rop.cache to store and return cached ROP search results

5f04f46

update test to check if cached result is correct or not

2783b8b

devalgupta404 added 10 commits January 17, 2026 10:31

Test verifies that ROP search results are cached and reused on subseq…

d64f659

…uent searches

fix build issue

4efeec9

Added platform-specific binary selection in the test

1cec4ea

Fix rop.cache to not cache empty greparg searches

4333586

Fix clang-format issues in test_rop.c

e59eeba

Update test expectations for improved analysis output

1c9d377

- ARM: Update jump table case label from '3...4' to '4' (more precise) - x86_64: Update switch/case ranges to match improved analysis output - cmd_print: Update histogram EXPECT to include ANSI codes that rizin outputs

Revert "Update test expectations for improved analysis output"

a01e7d3

This reverts commit acca26610a494311626da0d000b029b254b77a33.

fix: memory leaks in ROP search and unit tests

96e8626

fix(test): resolve hello-linux-x86_64 path dynamically

e422516

move test_rop_cache to integration test suite

000c656

devalgupta404 force-pushed the fix/rop-cache-5544 branch from de43eb3 to 000c656 Compare January 17, 2026 05:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

implement rop.cache to store and return cached ROP search results #5706

implement rop.cache to store and return cached ROP search results #5706

Uh oh!

devalgupta404 commented Dec 29, 2025

Uh oh!

codecov bot commented Dec 29, 2025 •

edited

Loading

Uh oh!

Rot127 Dec 30, 2025

Uh oh!

devalgupta404 Dec 30, 2025 •

edited

Loading

Uh oh!

Rot127 Jan 2, 2026

Uh oh!

devalgupta404 commented Jan 10, 2026

Uh oh!

Rot127 commented Jan 11, 2026

Uh oh!

devalgupta404 commented Jan 13, 2026

Uh oh!

Rot127 commented Jan 13, 2026

Uh oh!

devalgupta404 commented Jan 15, 2026 •

edited

Loading

Uh oh!

devalgupta404 commented Jan 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

implement rop.cache to store and return cached ROP search results #5706

Are you sure you want to change the base?

implement rop.cache to store and return cached ROP search results #5706

Uh oh!

Conversation

devalgupta404 commented Dec 29, 2025

Uh oh!

codecov bot commented Dec 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Rot127 Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

devalgupta404 Dec 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Rot127 Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

devalgupta404 commented Jan 10, 2026

Uh oh!

Rot127 commented Jan 11, 2026

Uh oh!

devalgupta404 commented Jan 13, 2026

Uh oh!

Rot127 commented Jan 13, 2026

Uh oh!

devalgupta404 commented Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Local Test Verification

Fix: test_rop binary path resolution

Results

Uh oh!

devalgupta404 commented Jan 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov bot commented Dec 29, 2025 •

edited

Loading

devalgupta404 Dec 30, 2025 •

edited

Loading

devalgupta404 commented Jan 15, 2026 •

edited

Loading