chore: checkpoint before Python removal

This commit is contained in:
2026-03-26 22:33:59 +00:00
parent 683cec9307
commit e568ddf82a
29972 changed files with 11269302 additions and 2 deletions

View File

@@ -0,0 +1,211 @@
// Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) All rights reserved.
// SPDX-License-Identifier: Apache-2.0
#ifndef OPENSSL_HEADER_LHASH_INTERNAL_H
#define OPENSSL_HEADER_LHASH_INTERNAL_H
#include <openssl/lhash.h>
#if defined(__cplusplus)
extern "C" {
#endif
// lhash is a traditional, chaining hash table that automatically expands and
// contracts as needed. One should not use the lh_* functions directly, rather
// use the type-safe macro wrappers:
//
// A hash table of a specific type of object has type |LHASH_OF(type)|. This
// can be defined (once) with |DEFINE_LHASH_OF(type)| and declared where needed
// with |DECLARE_LHASH_OF(type)|. For example:
//
// struct foo {
// int bar;
// };
//
// DEFINE_LHASH_OF(struct foo)
//
// Although note that the hash table will contain /pointers/ to |foo|.
//
// A macro will be defined for each of the |OPENSSL_lh_*| functions below. For
// |LHASH_OF(foo)|, the macros would be |lh_foo_new|, |lh_foo_num_items| etc.
// lhash_cmp_func is a comparison function that returns a value equal, or not
// equal, to zero depending on whether |*a| is equal, or not equal to |*b|,
// respectively. Note the difference between this and |stack_cmp_func| in that
// this takes pointers to the objects directly.
//
// This function's actual type signature is int (*)(const T*, const T*). The
// low-level |lh_*| functions will be passed a type-specific wrapper to call it
// correctly.
typedef int (*lhash_cmp_func)(const void *a, const void *b);
typedef int (*lhash_cmp_func_helper)(lhash_cmp_func func, const void *a,
const void *b);
// lhash_hash_func is a function that maps an object to a uniformly distributed
// uint32_t.
//
// This function's actual type signature is uint32_t (*)(const T*). The
// low-level |lh_*| functions will be passed a type-specific wrapper to call it
// correctly.
typedef uint32_t (*lhash_hash_func)(const void *a);
typedef uint32_t (*lhash_hash_func_helper)(lhash_hash_func func, const void *a);
// OPENSSL_lh_new returns a new, empty hash table or NULL on error.
OPENSSL_EXPORT _LHASH *OPENSSL_lh_new(lhash_hash_func hash,
lhash_cmp_func comp);
// OPENSSL_lh_free frees the hash table itself but none of the elements. See
// |OPENSSL_lh_doall|.
OPENSSL_EXPORT void OPENSSL_lh_free(_LHASH *lh);
// OPENSSL_lh_num_items returns the number of items in |lh|.
OPENSSL_EXPORT size_t OPENSSL_lh_num_items(const _LHASH *lh);
// OPENSSL_lh_retrieve finds an element equal to |data| in the hash table and
// returns it. If no such element exists, it returns NULL.
OPENSSL_EXPORT void *OPENSSL_lh_retrieve(const _LHASH *lh, const void *data,
lhash_hash_func_helper call_hash_func,
lhash_cmp_func_helper call_cmp_func);
// OPENSSL_lh_retrieve_key finds an element matching |key|, given the specified
// hash and comparison function. This differs from |OPENSSL_lh_retrieve| in that
// the key may be a different type than the values stored in |lh|. |key_hash|
// and |cmp_key| must be compatible with the functions passed into
// |OPENSSL_lh_new|.
OPENSSL_EXPORT void *OPENSSL_lh_retrieve_key(const _LHASH *lh, const void *key,
uint32_t key_hash,
int (*cmp_key)(const void *key,
const void *value));
// OPENSSL_lh_insert inserts |data| into the hash table. If an existing element
// is equal to |data| (with respect to the comparison function) then |*old_data|
// will be set to that value and it will be replaced. Otherwise, or in the
// event of an error, |*old_data| will be set to NULL. It returns one on
// success or zero in the case of an allocation error.
OPENSSL_EXPORT int OPENSSL_lh_insert(_LHASH *lh, void **old_data, void *data,
lhash_hash_func_helper call_hash_func,
lhash_cmp_func_helper call_cmp_func);
// OPENSSL_lh_delete removes an element equal to |data| from the hash table and
// returns it. If no such element is found, it returns NULL.
OPENSSL_EXPORT void *OPENSSL_lh_delete(_LHASH *lh, const void *data,
lhash_hash_func_helper call_hash_func,
lhash_cmp_func_helper call_cmp_func);
// OPENSSL_lh_doall_arg calls |func| on each element of the hash table and also
// passes |arg| as the second argument.
// TODO(fork): rename this
OPENSSL_EXPORT void OPENSSL_lh_doall_arg(_LHASH *lh,
void (*func)(void *, void *),
void *arg);
#define DEFINE_LHASH_OF(type) \
/* We disable MSVC C4191 in this macro, which warns when pointers are cast \
* to the wrong type. While the cast itself is valid, it is often a bug \
* because calling it through the cast is UB. However, we never actually \
* call functions as |lhash_cmp_func|. The type is just a type-erased \
* function pointer. (C does not guarantee function pointers fit in \
* |void*|, and GCC will warn on this.) Thus we just disable the false \
* positive warning. */ \
OPENSSL_MSVC_PRAGMA(warning(push)) \
OPENSSL_MSVC_PRAGMA(warning(disable : 4191)) \
\
DECLARE_LHASH_OF(type) \
\
typedef int (*lhash_##type##_cmp_func)(const type *, const type *); \
typedef uint32_t (*lhash_##type##_hash_func)(const type *); \
\
OPENSSL_INLINE int lh_##type##_call_cmp_func(lhash_cmp_func func, \
const void *a, const void *b) { \
return ((lhash_##type##_cmp_func)func)((const type *)a, (const type *)b); \
} \
\
OPENSSL_INLINE uint32_t lh_##type##_call_hash_func(lhash_hash_func func, \
const void *a) { \
return ((lhash_##type##_hash_func)func)((const type *)a); \
} \
\
OPENSSL_INLINE LHASH_OF(type) *lh_##type##_new( \
lhash_##type##_hash_func hash, lhash_##type##_cmp_func comp) { \
return (LHASH_OF(type) *)OPENSSL_lh_new((lhash_hash_func)hash, \
(lhash_cmp_func)comp); \
} \
\
OPENSSL_INLINE void lh_##type##_free(LHASH_OF(type) *lh) { \
OPENSSL_lh_free((_LHASH *)lh); \
} \
\
OPENSSL_INLINE size_t lh_##type##_num_items(const LHASH_OF(type) *lh) { \
return OPENSSL_lh_num_items((const _LHASH *)lh); \
} \
\
OPENSSL_INLINE type *lh_##type##_retrieve(const LHASH_OF(type) *lh, \
const type *data) { \
return (type *)OPENSSL_lh_retrieve((const _LHASH *)lh, data, \
lh_##type##_call_hash_func, \
lh_##type##_call_cmp_func); \
} \
\
typedef struct { \
int (*cmp_key)(const void *key, const type *value); \
const void *key; \
} LHASH_CMP_KEY_##type; \
\
OPENSSL_INLINE int lh_##type##_call_cmp_key(const void *key, \
const void *value) { \
const LHASH_CMP_KEY_##type *cb = (const LHASH_CMP_KEY_##type *)key; \
return cb->cmp_key(cb->key, (const type *)value); \
} \
\
OPENSSL_INLINE type *lh_##type##_retrieve_key( \
const LHASH_OF(type) *lh, const void *key, uint32_t key_hash, \
int (*cmp_key)(const void *key, const type *value)) { \
LHASH_CMP_KEY_##type cb = {cmp_key, key}; \
return (type *)OPENSSL_lh_retrieve_key((const _LHASH *)lh, &cb, key_hash, \
lh_##type##_call_cmp_key); \
} \
\
OPENSSL_INLINE int lh_##type##_insert(LHASH_OF(type) *lh, type **old_data, \
type *data) { \
void *old_data_void = NULL; \
int ret = OPENSSL_lh_insert((_LHASH *)lh, &old_data_void, data, \
lh_##type##_call_hash_func, \
lh_##type##_call_cmp_func); \
*old_data = (type *)old_data_void; \
return ret; \
} \
\
OPENSSL_INLINE type *lh_##type##_delete(LHASH_OF(type) *lh, \
const type *data) { \
return (type *)OPENSSL_lh_delete((_LHASH *)lh, data, \
lh_##type##_call_hash_func, \
lh_##type##_call_cmp_func); \
} \
\
typedef struct { \
void (*doall_arg)(type *, void *); \
void *arg; \
} LHASH_DOALL_##type; \
\
OPENSSL_INLINE void lh_##type##_call_doall_arg(void *value, void *arg) { \
const LHASH_DOALL_##type *cb = (const LHASH_DOALL_##type *)arg; \
cb->doall_arg((type *)value, cb->arg); \
} \
\
OPENSSL_INLINE void lh_##type##_doall_arg( \
LHASH_OF(type) *lh, void (*func)(type *, void *), void *arg) { \
LHASH_DOALL_##type cb = {func, arg}; \
OPENSSL_lh_doall_arg((_LHASH *)lh, lh_##type##_call_doall_arg, &cb); \
} \
\
OPENSSL_MSVC_PRAGMA(warning(pop))
#if defined(__cplusplus)
} // extern C
#endif
#endif // OPENSSL_HEADER_LHASH_INTERNAL_H

View File

@@ -0,0 +1,300 @@
// Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) All rights reserved.
// SPDX-License-Identifier: Apache-2.0
#include <openssl/lhash.h>
#include <assert.h>
#include <limits.h>
#include <string.h>
#include <openssl/mem.h>
#include "internal.h"
#include "../internal.h"
// kMinNumBuckets is the minimum size of the buckets array in an |_LHASH|.
static const size_t kMinNumBuckets = 16;
// kMaxAverageChainLength contains the maximum, average chain length. When the
// average chain length exceeds this value, the hash table will be resized.
static const size_t kMaxAverageChainLength = 2;
static const size_t kMinAverageChainLength = 1;
// lhash_item_st is an element of a hash chain. It points to the opaque data
// for this element and to the next item in the chain. The linked-list is NULL
// terminated.
typedef struct lhash_item_st {
void *data;
struct lhash_item_st *next;
// hash contains the cached, hash value of |data|.
uint32_t hash;
} LHASH_ITEM;
struct lhash_st {
// num_items contains the total number of items in the hash table.
size_t num_items;
// buckets is an array of |num_buckets| pointers. Each points to the head of
// a chain of LHASH_ITEM objects that have the same hash value, mod
// |num_buckets|.
LHASH_ITEM **buckets;
// num_buckets contains the length of |buckets|. This value is always >=
// kMinNumBuckets.
size_t num_buckets;
// callback_depth contains the current depth of |lh_doall| or |lh_doall_arg|
// calls. If non-zero then this suppresses resizing of the |buckets| array,
// which would otherwise disrupt the iteration.
unsigned callback_depth;
lhash_cmp_func comp;
lhash_hash_func hash;
};
_LHASH *OPENSSL_lh_new(lhash_hash_func hash, lhash_cmp_func comp) {
_LHASH *ret = OPENSSL_zalloc(sizeof(_LHASH));
if (ret == NULL) {
return NULL;
}
ret->num_buckets = kMinNumBuckets;
ret->buckets = OPENSSL_calloc(ret->num_buckets, sizeof(LHASH_ITEM *));
if (ret->buckets == NULL) {
OPENSSL_free(ret);
return NULL;
}
ret->comp = comp;
ret->hash = hash;
return ret;
}
void OPENSSL_lh_free(_LHASH *lh) {
if (lh == NULL) {
return;
}
for (size_t i = 0; i < lh->num_buckets; i++) {
LHASH_ITEM *next;
for (LHASH_ITEM *n = lh->buckets[i]; n != NULL; n = next) {
next = n->next;
OPENSSL_free(n);
}
}
OPENSSL_free(lh->buckets);
OPENSSL_free(lh);
}
size_t OPENSSL_lh_num_items(const _LHASH *lh) { return lh->num_items; }
// get_next_ptr_and_hash returns a pointer to the pointer that points to the
// item equal to |data|. In other words, it searches for an item equal to |data|
// and, if it's at the start of a chain, then it returns a pointer to an
// element of |lh->buckets|, otherwise it returns a pointer to the |next|
// element of the previous item in the chain. If an element equal to |data| is
// not found, it returns a pointer that points to a NULL pointer. If |out_hash|
// is not NULL, then it also puts the hash value of |data| in |*out_hash|.
static LHASH_ITEM **get_next_ptr_and_hash(const _LHASH *lh, uint32_t *out_hash,
const void *data,
lhash_hash_func_helper call_hash_func,
lhash_cmp_func_helper call_cmp_func) {
const uint32_t hash = call_hash_func(lh->hash, data);
if (out_hash != NULL) {
*out_hash = hash;
}
LHASH_ITEM **ret = &lh->buckets[hash % lh->num_buckets];
for (LHASH_ITEM *cur = *ret; cur != NULL; cur = *ret) {
if (call_cmp_func(lh->comp, cur->data, data) == 0) {
break;
}
ret = &cur->next;
}
return ret;
}
// get_next_ptr_by_key behaves like |get_next_ptr_and_hash| but takes a key
// which may be a different type from the values stored in |lh|.
static LHASH_ITEM **get_next_ptr_by_key(const _LHASH *lh, const void *key,
uint32_t key_hash,
int (*cmp_key)(const void *key,
const void *value)) {
LHASH_ITEM **ret = &lh->buckets[key_hash % lh->num_buckets];
for (LHASH_ITEM *cur = *ret; cur != NULL; cur = *ret) {
if (cmp_key(key, cur->data) == 0) {
break;
}
ret = &cur->next;
}
return ret;
}
void *OPENSSL_lh_retrieve(const _LHASH *lh, const void *data,
lhash_hash_func_helper call_hash_func,
lhash_cmp_func_helper call_cmp_func) {
LHASH_ITEM **next_ptr =
get_next_ptr_and_hash(lh, NULL, data, call_hash_func, call_cmp_func);
return *next_ptr == NULL ? NULL : (*next_ptr)->data;
}
void *OPENSSL_lh_retrieve_key(const _LHASH *lh, const void *key,
uint32_t key_hash,
int (*cmp_key)(const void *key,
const void *value)) {
LHASH_ITEM **next_ptr = get_next_ptr_by_key(lh, key, key_hash, cmp_key);
return *next_ptr == NULL ? NULL : (*next_ptr)->data;
}
// lh_rebucket allocates a new array of |new_num_buckets| pointers and
// redistributes the existing items into it before making it |lh->buckets| and
// freeing the old array.
static void lh_rebucket(_LHASH *lh, const size_t new_num_buckets) {
LHASH_ITEM **new_buckets, *cur, *next;
size_t i, alloc_size;
alloc_size = sizeof(LHASH_ITEM *) * new_num_buckets;
if (alloc_size / sizeof(LHASH_ITEM*) != new_num_buckets) {
return;
}
new_buckets = OPENSSL_zalloc(alloc_size);
if (new_buckets == NULL) {
return;
}
for (i = 0; i < lh->num_buckets; i++) {
for (cur = lh->buckets[i]; cur != NULL; cur = next) {
const size_t new_bucket = cur->hash % new_num_buckets;
next = cur->next;
cur->next = new_buckets[new_bucket];
new_buckets[new_bucket] = cur;
}
}
OPENSSL_free(lh->buckets);
lh->num_buckets = new_num_buckets;
lh->buckets = new_buckets;
}
// lh_maybe_resize resizes the |buckets| array if needed.
static void lh_maybe_resize(_LHASH *lh) {
size_t avg_chain_length;
if (lh->callback_depth > 0) {
// Don't resize the hash if we are currently iterating over it.
return;
}
assert(lh->num_buckets >= kMinNumBuckets);
avg_chain_length = lh->num_items / lh->num_buckets;
if (avg_chain_length > kMaxAverageChainLength) {
const size_t new_num_buckets = lh->num_buckets * 2;
if (new_num_buckets > lh->num_buckets) {
lh_rebucket(lh, new_num_buckets);
}
} else if (avg_chain_length < kMinAverageChainLength &&
lh->num_buckets > kMinNumBuckets) {
size_t new_num_buckets = lh->num_buckets / 2;
if (new_num_buckets < kMinNumBuckets) {
new_num_buckets = kMinNumBuckets;
}
lh_rebucket(lh, new_num_buckets);
}
}
int OPENSSL_lh_insert(_LHASH *lh, void **old_data, void *data,
lhash_hash_func_helper call_hash_func,
lhash_cmp_func_helper call_cmp_func) {
uint32_t hash;
LHASH_ITEM **next_ptr, *item;
*old_data = NULL;
next_ptr =
get_next_ptr_and_hash(lh, &hash, data, call_hash_func, call_cmp_func);
if (*next_ptr != NULL) {
// An element equal to |data| already exists in the hash table. It will be
// replaced.
*old_data = (*next_ptr)->data;
(*next_ptr)->data = data;
return 1;
}
// An element equal to |data| doesn't exist in the hash table yet.
item = OPENSSL_zalloc(sizeof(LHASH_ITEM));
if (item == NULL) {
return 0;
}
item->data = data;
item->hash = hash;
*next_ptr = item;
lh->num_items++;
lh_maybe_resize(lh);
return 1;
}
void *OPENSSL_lh_delete(_LHASH *lh, const void *data,
lhash_hash_func_helper call_hash_func,
lhash_cmp_func_helper call_cmp_func) {
LHASH_ITEM **next_ptr, *item, *ret;
next_ptr =
get_next_ptr_and_hash(lh, NULL, data, call_hash_func, call_cmp_func);
if (*next_ptr == NULL) {
// No such element.
return NULL;
}
item = *next_ptr;
*next_ptr = item->next;
ret = item->data;
OPENSSL_free(item);
lh->num_items--;
lh_maybe_resize(lh);
return ret;
}
void OPENSSL_lh_doall_arg(_LHASH *lh, void (*func)(void *, void *), void *arg) {
if (lh == NULL) {
return;
}
if (lh->callback_depth < UINT_MAX) {
// |callback_depth| is a saturating counter.
lh->callback_depth++;
}
for (size_t i = 0; i < lh->num_buckets; i++) {
LHASH_ITEM *next;
for (LHASH_ITEM *cur = lh->buckets[i]; cur != NULL; cur = next) {
next = cur->next;
func(cur->data, arg);
}
}
if (lh->callback_depth < UINT_MAX) {
lh->callback_depth--;
}
// The callback may have added or removed elements and the non-zero value of
// |callback_depth| will have suppressed any resizing. Thus any needed
// resizing is done here.
lh_maybe_resize(lh);
}
void lh_doall_arg(_LHASH *lh, void (*func)(void *, void *), void *arg) {
OPENSSL_lh_doall_arg(lh, func, arg);
}

View File

@@ -0,0 +1,132 @@
// Copyright (c) 2014, Google Inc.
// SPDX-License-Identifier: ISC
#include <openssl/lhash.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <algorithm>
#include <memory>
#include <map>
#include <string>
#include <utility>
#include <vector>
#include <openssl/mem.h>
#include <gtest/gtest.h>
#include "internal.h"
DEFINE_LHASH_OF(char)
static std::unique_ptr<char[]> RandString(void) {
unsigned len = 1 + (rand() % 3); // NOLINT(clang-analyzer-security.insecureAPI.rand)
std::unique_ptr<char[]> ret(new char[len + 1]);
for (unsigned i = 0; i < len; i++) {
ret[i] = '0' + (rand() & 7); // NOLINT(clang-analyzer-security.insecureAPI.rand)
}
ret[len] = 0;
return ret;
}
struct FreeLHASH_OF_char {
void operator()(LHASH_OF(char) *lh) { lh_char_free(lh); }
};
static const char *Lookup(
std::map<std::string, std::unique_ptr<char[]>> *dummy_lh, const char *key) {
// Using operator[] implicitly inserts into the map.
auto iter = dummy_lh->find(key);
if (iter == dummy_lh->end()) {
return nullptr;
}
return iter->second.get();
}
TEST(LHashTest, Basic) {
std::unique_ptr<LHASH_OF(char), FreeLHASH_OF_char> lh(
lh_char_new(OPENSSL_strhash, strcmp));
ASSERT_TRUE(lh);
// lh is expected to store a canonical instance of each string. dummy_lh
// mirrors what it stores for comparison. It also manages ownership of the
// pointers.
std::map<std::string, std::unique_ptr<char[]>> dummy_lh;
for (unsigned i = 0; i < 100000; i++) {
EXPECT_EQ(dummy_lh.size(), lh_char_num_items(lh.get()));
// Check the entire contents and test |lh_*_doall_arg|. This takes O(N)
// time, so only do it every few iterations.
//
// TODO(davidben): |lh_*_doall_arg| also supports modifying the hash in the
// callback. Test this.
if (i % 1000 == 0) {
using ValueList = std::vector<const char *>;
ValueList expected, actual;
for (const auto &pair : dummy_lh) {
expected.push_back(pair.second.get());
}
std::sort(expected.begin(), expected.end());
lh_char_doall_arg(lh.get(),
[](char *ptr, void *arg) {
ValueList *out = reinterpret_cast<ValueList *>(arg);
out->push_back(ptr);
},
&actual);
std::sort(actual.begin(), actual.end());
EXPECT_EQ(expected, actual);
}
enum Action {
kRetrieve = 0,
kInsert,
kDelete,
};
Action action = static_cast<Action>(rand() % 3); // NOLINT(clang-analyzer-security.insecureAPI.rand)
switch (action) {
case kRetrieve: {
std::unique_ptr<char[]> key = RandString();
char *value = lh_char_retrieve(lh.get(), key.get());
EXPECT_EQ(Lookup(&dummy_lh, key.get()), value);
// Do the same lookup with |lh_char_retrieve_key|.
value = lh_char_retrieve_key(
lh.get(), &key, OPENSSL_strhash(key.get()),
[](const void *key_ptr, const char *data) -> int {
const char *key_data =
reinterpret_cast<const std::unique_ptr<char[]> *>(key_ptr)
->get();
return strcmp(key_data, data);
});
EXPECT_EQ(Lookup(&dummy_lh, key.get()), value);
break;
}
case kInsert: {
std::unique_ptr<char[]> key = RandString();
char *previous;
ASSERT_TRUE(lh_char_insert(lh.get(), &previous, key.get()));
EXPECT_EQ(Lookup(&dummy_lh, key.get()), previous);
dummy_lh[key.get()] = std::move(key);
break;
}
case kDelete: {
std::unique_ptr<char[]> key = RandString();
char *value = lh_char_delete(lh.get(), key.get());
EXPECT_EQ(Lookup(&dummy_lh, key.get()), value);
dummy_lh.erase(key.get());
break;
}
}
}
}