Skip to content

Bitvector in-place refactor #5569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
notxvilka merged 24 commits into from
Dec 23, 2025
Merged

Bitvector in-place refactor #5569

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
ed14f88
Add an in-place addition of bitvectors.
Rot127 Nov 27, 2025
0e3e3b1
Decouple _elem_len from assumption it has just enough bytes to hold l…
Rot127 Nov 28, 2025
b06b258
Add in-place copy of bits.
Rot127 Nov 28, 2025
f847ef9
Use default copy bits bitvector function.
Rot127 Dec 1, 2025
fb56200
Mark stack allocated bit vector.
Rot127 Dec 1, 2025
bb55bee
Add inplace variant of complement_1
Rot127 Dec 2, 2025
29af805
Implement inplace bitvecotr not.
Rot127 Dec 2, 2025
06abe4a
Add inplace variant of rz_bv_and
Rot127 Dec 2, 2025
641b2a6
Implement inplace variant of rz_bv_or
Rot127 Dec 2, 2025
3edcea7
Implement inplace variant of rz_bv_xor
Rot127 Dec 2, 2025
46f395c
Constify rz_bv_lsb/msb
Rot127 Dec 2, 2025
855b870
Implement inplace variant of rz_bv_neg
Rot127 Dec 2, 2025
05fb027
Fix inplace add. Add inplace SUB
Rot127 Dec 4, 2025
8910308
Remove prefix
Rot127 Dec 4, 2025
ba59ef0
Remove invalid const
Rot127 Dec 4, 2025
468e3aa
Implement in-place casting of bit vectors.
Rot127 Dec 1, 2025
ca87e93
Add a hash test
Rot127 Dec 5, 2025
83535dc
Fix unnecessary &
Rot127 Dec 9, 2025
30e8ba5
Prevent OOB reads & writes by copying only the minimum of bytes.
Rot127 Dec 9, 2025
6ee917e
Add inplace MUL
Rot127 Dec 15, 2025
965901b
Add ble version for bitvector set/get with bytes.
Rot127 Dec 16, 2025
877653b
Add documentation for inplace bitvector functions.
Rot127 Dec 19, 2025
2f1c451
Add bench of add/sub() and sub/add_inplace().
Rot127 Dec 20, 2025
06b615d
Remove rz_bv_copy_nbits_inplace because it was the same as rz_bv_copy…
Rot127 Dec 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 29 additions & 6 deletions librz/include/rz_util/rz_bitvector.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,21 @@ extern "C" {
* Ref : https://web.cs.dal.ca/~jamie/UWO/BitVectors/README.html
*/
typedef struct bitvector_t {
union {
struct {
ut8 *large_a; ///< little endian array of bytes for bitvectors > 64 bits whose size is defined in _elem_len
ut64 small_u; ///< value of the bitvector when the size is <= 64 bits
} bits;
ut32 _elem_len; ///< length of ut8 array (bits.large_a) -- real / physical
/**
* \brief This flag is set if the bit vector is allocated on the stack.
* This means large_a must not be reallocated or freed.
*/
bool stack_alloc;
/**
* \brief length of ut8 array (bits.large_a) -- real / physical
* NOTE: It is possible that a bits.large_a is larger than required for the
* bit vector length.
*/
ut32 _elem_len;
ut32 len; ///< number of bits -- virtual / logical
} RzBitVector;

Expand Down Expand Up @@ -54,31 +64,42 @@ RZ_API bool rz_bv_rshift(RZ_NONNULL RzBitVector *bv, ut32 size);
RZ_API bool rz_bv_lshift_fill(RZ_NONNULL RzBitVector *bv, ut32 size, bool fill_bit);
RZ_API bool rz_bv_rshift_fill(RZ_NONNULL RzBitVector *bv, ut32 size, bool fill_bit);
RZ_API RZ_OWN RzBitVector *rz_bv_and(RZ_NONNULL RzBitVector *x, RZ_NONNULL RzBitVector *y);
RZ_API bool rz_bv_and_inplace(RZ_INOUT RZ_NONNULL RzBitVector *x, RZ_NONNULL const RzBitVector *y);
RZ_API RZ_OWN RzBitVector *rz_bv_or(RZ_NONNULL RzBitVector *x, RZ_NONNULL RzBitVector *y);
RZ_API bool rz_bv_or_inplace(RZ_INOUT RZ_NONNULL RzBitVector *x, RZ_NONNULL const RzBitVector *y);
RZ_API RZ_OWN RzBitVector *rz_bv_xor(RZ_NONNULL RzBitVector *x, RZ_NONNULL RzBitVector *y);
#define rz_bv_neg rz_bv_complement_2
#define rz_bv_not rz_bv_complement_1
RZ_API bool rz_bv_xor_inplace(RZ_INOUT RZ_NONNULL RzBitVector *x, RZ_NONNULL const RzBitVector *y);
#define rz_bv_neg rz_bv_complement_2
#define rz_bv_neg_inplace rz_bv_complement_2_inplace
#define rz_bv_not rz_bv_complement_1
#define rz_bv_not_inplace rz_bv_complement_1_inplace
RZ_API RZ_OWN RzBitVector *rz_bv_complement_1(RZ_NONNULL RzBitVector *bv);
RZ_API bool rz_bv_complement_1_inplace(RZ_INOUT RZ_NONNULL RzBitVector *bv);
RZ_API RZ_OWN RzBitVector *rz_bv_complement_2(RZ_NONNULL RzBitVector *bv);
RZ_API bool rz_bv_complement_2_inplace(RZ_INOUT RZ_NONNULL RzBitVector *bv);

// Module 2 arithmetic operations
RZ_API RZ_OWN RzBitVector *rz_bv_add(RZ_NONNULL RzBitVector *x, RZ_NONNULL RzBitVector *y, RZ_NULLABLE bool *carry);
RZ_API bool rz_bv_add_inplace(RZ_INOUT RZ_NONNULL RZ_BORROW RzBitVector *x, const RZ_NONNULL RzBitVector *y, RZ_NULLABLE bool *carry);
RZ_API RZ_OWN RzBitVector *rz_bv_sub(RZ_NONNULL RzBitVector *x, RZ_NONNULL RzBitVector *y, RZ_NULLABLE bool *borrow);
RZ_API bool rz_bv_sub_inplace(RZ_INOUT RZ_NONNULL RzBitVector *x, RZ_INOUT RZ_NONNULL RzBitVector *y, RZ_NULLABLE bool *borrow);
RZ_API RZ_OWN RzBitVector *rz_bv_mul(RZ_NONNULL RzBitVector *x, RZ_NONNULL RzBitVector *y);
RZ_API bool rz_bv_mul_inplace(RZ_NONNULL RZ_INOUT RzBitVector *x, const RZ_NONNULL RzBitVector *y);
RZ_API RZ_OWN RzBitVector *rz_bv_div(RZ_NONNULL RzBitVector *x, RZ_NONNULL RzBitVector *y);
RZ_API RZ_OWN RzBitVector *rz_bv_mod(RZ_NONNULL RzBitVector *x, RZ_NONNULL RzBitVector *y);
RZ_API RZ_OWN RzBitVector *rz_bv_sdiv(RZ_NONNULL RzBitVector *x, RZ_NONNULL RzBitVector *y);
RZ_API RZ_OWN RzBitVector *rz_bv_smod(RZ_NONNULL RzBitVector *x, RZ_NONNULL RzBitVector *y);

RZ_API bool rz_bv_msb(RZ_NONNULL RzBitVector *bv);
RZ_API bool rz_bv_lsb(RZ_NONNULL RzBitVector *bv);
RZ_API bool rz_bv_msb(RZ_NONNULL const RzBitVector *bv);
RZ_API bool rz_bv_lsb(RZ_NONNULL const RzBitVector *bv);
RZ_API bool rz_bv_eq(RZ_NONNULL RzBitVector *x, RZ_NONNULL RzBitVector *y);
RZ_API bool rz_bv_ule(RZ_NONNULL RzBitVector *x, RZ_NONNULL RzBitVector *y);
RZ_API bool rz_bv_sle(RZ_NONNULL RzBitVector *x, RZ_NONNULL RzBitVector *y);

RZ_API ut32 rz_bv_clz(RZ_NONNULL RzBitVector *bv);
RZ_API ut32 rz_bv_ctz(RZ_NONNULL RzBitVector *bv);

RZ_API bool rz_bv_cast_inplace(RZ_INOUT RZ_NONNULL RzBitVector *bv, ut32 to_size, bool fill_bit);
RZ_API RzBitVector *rz_bv_cast(RZ_NONNULL RzBitVector *bv, ut32 to_size, bool fill_bit);

// some convert functions
Expand All @@ -95,8 +116,10 @@ RZ_API RZ_OWN RzBitVector *rz_bv_new_from_bytes_le(RZ_IN RZ_NONNULL const ut8 *b
RZ_API RZ_OWN RzBitVector *rz_bv_new_from_bytes_be(RZ_IN RZ_NONNULL const ut8 *buf, ut32 bit_offset, ut32 size);
RZ_API bool rz_bv_set_from_ut64(RZ_NONNULL RzBitVector *bv, ut64 value);
RZ_API bool rz_bv_set_from_st64(RZ_NONNULL RzBitVector *bv, st64 value);
RZ_API void rz_bv_set_from_bytes_ble(RZ_NONNULL RzBitVector *bv, RZ_IN RZ_NONNULL const ut8 *buf, ut32 bit_offset, ut32 size, bool big_endian);
RZ_API void rz_bv_set_from_bytes_le(RZ_NONNULL RzBitVector *bv, RZ_IN RZ_NONNULL const ut8 *buf, ut32 bit_offset, ut32 size);
RZ_API void rz_bv_set_from_bytes_be(RZ_NONNULL RzBitVector *bv, RZ_IN RZ_NONNULL const ut8 *buf, ut32 bit_offset, ut32 size);
RZ_API void rz_bv_set_to_bytes_ble(RZ_NONNULL const RzBitVector *bv, RZ_OUT RZ_NONNULL ut8 *buf, bool big_endian);
RZ_API void rz_bv_set_to_bytes_le(RZ_NONNULL const RzBitVector *bv, RZ_OUT RZ_NONNULL ut8 *buf);
RZ_API void rz_bv_set_to_bytes_be(RZ_NONNULL const RzBitVector *bv, RZ_OUT RZ_NONNULL ut8 *buf);
RZ_API RZ_OWN char *rz_bv_as_string(RZ_NONNULL const RzBitVector *bv);
Expand Down
Loading
Loading