Skip to content

Commit

Permalink
hashlib: add deprecated mkhash function to prevent plugin breakage
Browse files Browse the repository at this point in the history
  • Loading branch information
widlarizer committed Nov 11, 2024
1 parent 1f40e57 commit b4f3806
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
6 changes: 6 additions & 0 deletions docs/source/yosys_internals/hashing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -145,3 +145,9 @@ redirecting to ``hash_ops<T>``
Hasher h;
return (unsigned int)hash_acc(h).yield();
}
To get hashes for Yosys types, you can temporarily use the templated deprecated
``mkhash`` function until the majority of your plugin's users switch to a newer
version and live with the warnings, or set up a custom ``#ifdef``-based solution
if you really need to.
Feel free to contact Yosys maintainers with related issues.
16 changes: 12 additions & 4 deletions kernel/hashlib.h
Original file line number Diff line number Diff line change
Expand Up @@ -103,19 +103,19 @@ class HasherDJB32 {
static uint32_t fudge;
// The XOR version of DJB2
[[nodiscard]]
static uint32_t mkhash(uint32_t a, uint32_t b) {
static uint32_t djb2_xor(uint32_t a, uint32_t b) {
uint32_t hash = ((a << 5) + a) ^ b;
return hash;
}
public:
void hash32(uint32_t i) {
state = mkhash(i, state);
state = djb2_xor(i, state);
state = mkhash_xorshift(fudge ^ state);
return;
}
void hash64(uint64_t i) {
state = mkhash((uint32_t)(i % (1ULL << 32ULL)), state);
state = mkhash((uint32_t)(i >> 32ULL), state);
state = djb2_xor((uint32_t)(i % (1ULL << 32ULL)), state);
state = djb2_xor((uint32_t)(i >> 32ULL), state);
state = mkhash_xorshift(fudge ^ state);
return;
}
Expand Down Expand Up @@ -283,6 +283,14 @@ Hasher::hash_t run_hash(const T& obj) {
return hash_top_ops<T>::hash(obj).yield();
}

/** Refer to docs/source/yosys_internals/hashing.rst */
template<typename T>
[[nodiscard]]
[[deprecated]]
inline unsigned int mkhash(const T &v) {
return (unsigned int) run_hash<T>(v);
}

template<> struct hash_ops<std::monostate> {
static inline bool cmp(std::monostate a, std::monostate b) {
return a == b;
Expand Down

0 comments on commit b4f3806

Please sign in to comment.