From 0e5da5181b98172f633e2d294d9345d5ca66fa48 Mon Sep 17 00:00:00 2001 From: Matthieu Dorier Date: Mon, 25 Mar 2024 15:31:34 +0000 Subject: [PATCH] added a lot of code on the client side --- CMakeLists.txt | 2 +- examples/client.c | 2 +- examples/server.c | 2 +- include/flock/flock-backend.h | 2 +- include/flock/flock-client.h | 2 +- include/flock/flock-common.h | 2 +- include/flock/flock-group.h | 44 +- include/flock/flock-server.h | 2 +- src/CMakeLists.txt | 3 +- src/bedrock-module.c | 2 +- src/client.c | 107 +--- src/client.h | 19 +- src/config.h.in | 4 +- src/dummy/dummy-backend.c | 2 +- src/dummy/dummy-backend.h | 2 +- src/group-handle.c | 505 +++++++++++++++ src/group-view.h | 304 +++++++++ src/provider.c | 40 +- src/provider.h | 7 +- src/types.h | 11 +- src/uthash.h | 1140 +++++++++++++++++++++++++++++++++ tests/test-client.cpp | 2 +- 22 files changed, 2050 insertions(+), 156 deletions(-) create mode 100644 src/group-handle.c create mode 100644 src/group-view.h create mode 100644 src/uthash.h diff --git a/CMakeLists.txt b/CMakeLists.txt index 28343eb..57268d9 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,4 +1,4 @@ -# (C) 2020 The University of Chicago +# (C) 2024 The University of Chicago # See COPYRIGHT in top-level directory. cmake_minimum_required (VERSION 3.8) project (flock C CXX) diff --git a/examples/client.c b/examples/client.c index f47295e..6aed863 100644 --- a/examples/client.c +++ b/examples/client.c @@ -1,5 +1,5 @@ /* - * (C) 2020 The University of Chicago + * (C) 2024 The University of Chicago * * See COPYRIGHT in top-level directory. */ diff --git a/examples/server.c b/examples/server.c index 0943fc1..c5d3fc8 100644 --- a/examples/server.c +++ b/examples/server.c @@ -1,5 +1,5 @@ /* - * (C) 2020 The University of Chicago + * (C) 2024 The University of Chicago * * See COPYRIGHT in top-level directory. */ diff --git a/include/flock/flock-backend.h b/include/flock/flock-backend.h index ffb254c..072c02b 100644 --- a/include/flock/flock-backend.h +++ b/include/flock/flock-backend.h @@ -1,5 +1,5 @@ /* - * (C) 2020 The University of Chicago + * (C) 2024 The University of Chicago * * See COPYRIGHT in top-level directory. */ diff --git a/include/flock/flock-client.h b/include/flock/flock-client.h index 3d6011b..65a0789 100644 --- a/include/flock/flock-client.h +++ b/include/flock/flock-client.h @@ -1,5 +1,5 @@ /* - * (C) 2020 The University of Chicago + * (C) 2024 The University of Chicago * * See COPYRIGHT in top-level directory. */ diff --git a/include/flock/flock-common.h b/include/flock/flock-common.h index 1b0f4df..3eaf693 100644 --- a/include/flock/flock-common.h +++ b/include/flock/flock-common.h @@ -1,5 +1,5 @@ /* - * (C) 2020 The University of Chicago + * (C) 2024 The University of Chicago * * See COPYRIGHT in top-level directory. */ diff --git a/include/flock/flock-group.h b/include/flock/flock-group.h index e030d56..abc9354 100644 --- a/include/flock/flock-group.h +++ b/include/flock/flock-group.h @@ -1,5 +1,5 @@ /* - * (C) 2020 The University of Chicago + * (C) 2024 The University of Chicago * * See COPYRIGHT in top-level directory. */ @@ -57,7 +57,7 @@ flock_return_t flock_group_handle_create( * "transport": "", * "credentials": 42, * "members": [ - * { "address": "", "provider_id": 1234 }, + * { "rank": 12, "address": "", "provider_id": 1234 }, * ... * ], * "metadata": { @@ -170,12 +170,12 @@ flock_return_t flock_group_live_member_count( * * @param void* User-provided context * @param size_t Member rank - * @param hg_addr_t Address of the member + * @param const char* Address of the member * @param uint16_t Provider ID of the member * * @return true to continue iterating, false to break */ -typedef bool (*flock_member_access_fn)(void*, size_t, hg_addr_t, uint16_t); +typedef bool (*flock_member_access_fn)(void*, size_t, const char*, uint16_t); /** * @brief Iterate over the members of the group. The iteration @@ -213,6 +213,25 @@ flock_return_t flock_group_member_get_address( size_t rank, hg_addr_t* address); +/** + * @brief Get the address of a member at a given rank, as a string. + * + * @important The caller is responsible for calling free on the address. + * + * If no member exist at that rank, the address will be set to NULL + * and the function will return FLOCK_ERR_NO_MEMBER. + * + * @param[in] handle Group handle + * @param[in] rank Rank of the process + * @param[out] address Address of the process + * + * @return FLOCK_SUCCESS or error code defined in flock-common.h + */ +flock_return_t flock_group_member_get_address_string( + flock_group_handle_t handle, + size_t rank, + char** address); + /** * @brief Get the provider ID of a member at a given rank. * @@ -241,7 +260,7 @@ flock_return_t flock_group_member_get_provider_id( */ flock_return_t flock_group_member_get_rank( flock_group_handle_t handle, - hg_addr_t address, + const char* address, uint16_t provider_id, size_t* rank); @@ -250,13 +269,11 @@ flock_return_t flock_group_member_get_rank( * * @param void* User-provided context * @param const char* Metadata key - * @param size_t Size of the metadata key * @param const char* Metadata value - * @param size_t Size of the metadata value * * @return true to continue iterating, false to break */ -typedef bool (*flock_metadata_access_fn)(void*, const char*, size_t, const char*, size_t); +typedef bool (*flock_metadata_access_fn)(void*, const char*, const char*); /** * @brief Iterate over the metadata associated with the group. @@ -276,9 +293,11 @@ flock_return_t flock_group_metadata_iterate( * @brief Get the value associated with a given key and pass * the key/value pair to the provided access function. * + * If no value is found associated with the specified key, + * the callback will be called with NULL as the value. + * * @param handle Group handle * @param key Metadata key - * @param key_size Size of the key * @param access_fn Function to call on the metadata * @param context Context to pass to the callback * @@ -287,7 +306,6 @@ flock_return_t flock_group_metadata_iterate( flock_return_t flock_group_metadata_access( flock_group_handle_t handle, const char* key, - size_t key_size, flock_metadata_access_fn access_fn, void* context); @@ -299,18 +317,14 @@ flock_return_t flock_group_metadata_access( * * @param handle Group handle * @param key Key to add - * @param key_size Size of the key * @param value Value to add - * @param value_size Size of the value * * @return FLOCK_SUCCESS or error code defined in flock-common.h */ flock_return_t flock_group_metadata_set( flock_group_handle_t handle, const char* key, - size_t key_size, - const char* value, - size_t value_size); + const char* value); /** * @brief Update the internal view of the group. diff --git a/include/flock/flock-server.h b/include/flock/flock-server.h index 9be186d..c80bb32 100644 --- a/include/flock/flock-server.h +++ b/include/flock/flock-server.h @@ -1,5 +1,5 @@ /* - * (C) 2020 The University of Chicago + * (C) 2024 The University of Chicago * * See COPYRIGHT in top-level directory. */ diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 5dbe553..52fbd30 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -3,7 +3,8 @@ set (server-src-files provider.c) set (client-src-files - client.c) + client.c + group-handle.c) set (dummy-src-files dummy/dummy-backend.c) diff --git a/src/bedrock-module.c b/src/bedrock-module.c index db3a4fe..f1770df 100644 --- a/src/bedrock-module.c +++ b/src/bedrock-module.c @@ -1,5 +1,5 @@ /* - * (C) 2020 The University of Chicago + * (C) 2024 The University of Chicago * * See COPYRIGHT in top-level directory. */ diff --git a/src/client.c b/src/client.c index eecb314..455ec9e 100644 --- a/src/client.c +++ b/src/client.c @@ -1,5 +1,5 @@ /* - * (C) 2020 The University of Chicago + * (C) 2024 The University of Chicago * * See COPYRIGHT in top-level directory. */ @@ -13,15 +13,18 @@ flock_return_t flock_client_init(margo_instance_id mid, ABT_pool pool, flock_cli if(!c) return FLOCK_ERR_ALLOCATION; c->mid = mid; + if(pool == ABT_POOL_NULL) + margo_get_handler_pool(mid, &pool); + c->pool = pool; hg_bool_t flag; hg_id_t id; - margo_registered_name(mid, "flock_sum", &id, &flag); + margo_registered_name(mid, "flock_update", &id, &flag); if(flag == HG_TRUE) { - margo_registered_name(mid, "flock_sum", &c->sum_id, &flag); + margo_registered_name(mid, "flock_update", &c->update_id, &flag); } else { - c->sum_id = MARGO_REGISTER(mid, "flock_sum", sum_in_t, sum_out_t, NULL); + c->update_id = MARGO_REGISTER(mid, "flock_update", void, update_out_t, NULL); } *client = c; @@ -39,90 +42,20 @@ flock_return_t flock_client_finalize(flock_client_t client) return FLOCK_SUCCESS; } -flock_return_t flock_group_handle_create( - flock_client_t client, - hg_addr_t addr, - uint16_t provider_id, - uint32_t mode, - flock_group_handle_t* handle) -{ - if(client == FLOCK_CLIENT_NULL) - return FLOCK_ERR_INVALID_ARGS; - - hg_return_t ret; - - if(mode & FLOCK_MODE_INIT_UPDATE) { - char buffer[sizeof("flock")]; - size_t bufsize = sizeof("flock"); - ret = margo_provider_get_identity(client->mid, addr, provider_id, buffer, &bufsize); - if(ret != HG_SUCCESS || strcmp("flock", buffer) != 0) - return FLOCK_ERR_INVALID_PROVIDER; - } - - flock_group_handle_t rh = - (flock_group_handle_t)calloc(1, sizeof(*rh)); - - if(!rh) return FLOCK_ERR_ALLOCATION; - - ret = margo_addr_dup(client->mid, addr, &(rh->addr)); - if(ret != HG_SUCCESS) { - free(rh); - return FLOCK_ERR_FROM_MERCURY; - } - - rh->client = client; - rh->provider_id = provider_id; - rh->refcount = 1; - - client->num_group_handles += 1; - - *handle = rh; - return FLOCK_SUCCESS; -} - -flock_return_t flock_group_handle_ref_incr( - flock_group_handle_t handle) -{ - if(handle == FLOCK_GROUP_HANDLE_NULL) - return FLOCK_ERR_INVALID_ARGS; - handle->refcount += 1; - return FLOCK_SUCCESS; -} - -flock_return_t flock_group_handle_release(flock_group_handle_t handle) -{ - if(handle == FLOCK_GROUP_HANDLE_NULL) - return FLOCK_ERR_INVALID_ARGS; - handle->refcount -= 1; - if(handle->refcount == 0) { - margo_addr_free(handle->client->mid, handle->addr); - handle->client->num_group_handles -= 1; - free(handle); - } - return FLOCK_SUCCESS; -} - -#if 0 -flock_return_t flock_compute_sum( +flock_return_t flock_group_update( flock_group_handle_t handle, - int32_t x, - int32_t y, - int32_t* result) + flock_request_t* req) { hg_handle_t h; - sum_in_t in; - sum_out_t out; + update_out_t out; hg_return_t hret; flock_return_t ret; - in.x = x; - in.y = y; - - hret = margo_create(handle->client->mid, handle->addr, handle->client->sum_id, &h); + hret = margo_create(handle->client->mid, handle->addr, handle->client->update_id, &h); if(hret != HG_SUCCESS) return FLOCK_ERR_FROM_MERCURY; - hret = margo_provider_forward(handle->provider_id, h, &in); + hret = margo_provider_forward(handle->provider_id, h, NULL); if(hret != HG_SUCCESS) { ret = FLOCK_ERR_FROM_MERCURY; goto finish; @@ -134,9 +67,18 @@ flock_return_t flock_compute_sum( goto finish; } - ret = out.ret; - if(ret == FLOCK_SUCCESS) - *result = out.result; + LOCK_GROUP_VIEW(&handle->view); + handle->view.capacity = out.view.capacity; + handle->view.size = out.view.size; + handle->view.members = out.view.members; + handle->view.metadata = out.view.metadata; + UNLOCK_GROUP_VIEW(&handle->view); + + // Prevent margo_free_output from freeing the content we just moved + out.view.size = 0; + out.view.capacity = 0; + out.view.members = NULL; + out.view.metadata = NULL; margo_free_output(h, &out); @@ -144,4 +86,3 @@ flock_return_t flock_compute_sum( margo_destroy(h); return ret; } -#endif diff --git a/src/client.h b/src/client.h index f0ee6ac..60f9c8f 100644 --- a/src/client.h +++ b/src/client.h @@ -1,5 +1,5 @@ /* - * (C) 2020 The University of Chicago + * (C) 2024 The University of Chicago * * See COPYRIGHT in top-level directory. */ @@ -12,15 +12,22 @@ typedef struct flock_client { margo_instance_id mid; - hg_id_t sum_id; + ABT_pool pool; + hg_id_t update_id; uint64_t num_group_handles; } flock_client; typedef struct flock_group_handle { - flock_client_t client; - hg_addr_t addr; - uint16_t provider_id; - uint64_t refcount; + flock_client_t client; + uint64_t refcount; + // Bellow are the address and provider ID of the member + // that will be contacted in priority for updates + hg_addr_t addr; + uint16_t provider_id; + // Group view + group_view_t view; + // Credentials + int64_t credentials; } flock_group_handle; #endif diff --git a/src/config.h.in b/src/config.h.in index edeebf1..a22941c 100644 --- a/src/config.h.in +++ b/src/config.h.in @@ -1,6 +1,6 @@ /* - * (C) 2020 The University of Chicago - * + * (C) 2024 The University of Chicago + * * See COPYRIGHT in top-level directory. */ #ifndef _CONFIG_H diff --git a/src/dummy/dummy-backend.c b/src/dummy/dummy-backend.c index 4d43d94..a1b355c 100644 --- a/src/dummy/dummy-backend.c +++ b/src/dummy/dummy-backend.c @@ -1,5 +1,5 @@ /* - * (C) 2020 The University of Chicago + * (C) 2024 The University of Chicago * * See COPYRIGHT in top-level directory. */ diff --git a/src/dummy/dummy-backend.h b/src/dummy/dummy-backend.h index ccfd585..ea18c89 100644 --- a/src/dummy/dummy-backend.h +++ b/src/dummy/dummy-backend.h @@ -1,5 +1,5 @@ /* - * (C) 2020 The University of Chicago + * (C) 2024 The University of Chicago * * See COPYRIGHT in top-level directory. */ diff --git a/src/group-handle.c b/src/group-handle.c new file mode 100644 index 0000000..19d6510 --- /dev/null +++ b/src/group-handle.c @@ -0,0 +1,505 @@ +/* + * (C) 2024 The University of Chicago + * + * See COPYRIGHT in top-level directory. + */ +#include "types.h" +#include "client.h" +#include "group-view.h" +#include "flock/flock-client.h" +#include + +flock_return_t flock_group_handle_create( + flock_client_t client, + hg_addr_t addr, + uint16_t provider_id, + uint32_t mode, + flock_group_handle_t* handle) +{ + if(client == FLOCK_CLIENT_NULL) + return FLOCK_ERR_INVALID_ARGS; + + hg_return_t hret; + + if(mode & FLOCK_MODE_INIT_UPDATE) { + char buffer[sizeof("flock")]; + size_t bufsize = sizeof("flock"); + hret = margo_provider_get_identity(client->mid, addr, provider_id, buffer, &bufsize); + if(hret != HG_SUCCESS || strcmp("flock", buffer) != 0) + return FLOCK_ERR_INVALID_PROVIDER; + } + + flock_group_handle_t rh = + (flock_group_handle_t)calloc(1, sizeof(*rh)); + + if(!rh) return FLOCK_ERR_ALLOCATION; + + hret = margo_addr_dup(client->mid, addr, &(rh->addr)); + if(hret != HG_SUCCESS) { + free(rh); + return FLOCK_ERR_FROM_MERCURY; + } + + rh->client = client; + rh->provider_id = provider_id; + rh->refcount = 1; + + client->num_group_handles += 1; + + if(mode & FLOCK_MODE_INIT_UPDATE) { + flock_return_t ret = flock_group_update(rh, NULL); + if(ret != FLOCK_SUCCESS) { + flock_group_handle_release(rh); + return ret; + } + } + + *handle = rh; + return FLOCK_SUCCESS; +} + +flock_return_t flock_group_handle_ref_incr( + flock_group_handle_t handle) +{ + if(handle == FLOCK_GROUP_HANDLE_NULL) + return FLOCK_ERR_INVALID_ARGS; + handle->refcount += 1; + return FLOCK_SUCCESS; +} + +flock_return_t flock_group_handle_release(flock_group_handle_t handle) +{ + if(handle == FLOCK_GROUP_HANDLE_NULL) + return FLOCK_ERR_INVALID_ARGS; + handle->refcount -= 1; + if(handle->refcount == 0) { + margo_addr_free(handle->client->mid, handle->addr); + handle->client->num_group_handles -= 1; + free(handle); + } + return FLOCK_SUCCESS; +} + +flock_return_t flock_group_handle_create_from_file( + flock_client_t client, + const char* filename, + uint32_t mode, + flock_group_handle_t* handle) +{ + // Read the content of the file into a buffer + char* buffer = NULL; + size_t length; + FILE* file = fopen(filename, "r"); + if(!file) { + margo_error(client->mid, "[flock] Could not read file %s", filename); + return FLOCK_ERR_INVALID_ARGS; + } + fseek(file, 0, SEEK_END); + length = ftell(file); + fseek(file, 0, SEEK_SET); + buffer = (char *)malloc(length + 1); + if (buffer) { + ssize_t r = fread(buffer, 1, length, file); + (void)r; + buffer[length] = '\0'; // Null-terminate the string + } else { + return FLOCK_ERR_ALLOCATION; + } + fclose(file); + + flock_return_t ret = flock_group_handle_create_from_serialized( + client, buffer, length, mode, handle); + free(buffer); + return ret; +} + +flock_return_t flock_group_handle_create_from_serialized( + flock_client_t client, + const char* serialized_view, + size_t view_size, + uint32_t mode, + flock_group_handle_t* handle) +{ + if(client == FLOCK_CLIENT_NULL) + return FLOCK_ERR_INVALID_ARGS; + + hg_return_t hret; + + // Parse the content of the file + struct json_tokener* tokener = json_tokener_new(); + enum json_tokener_error jerr; + struct json_object* content = json_tokener_parse_ex(tokener, serialized_view, view_size); + if (!content) { + jerr = json_tokener_get_error(tokener); + margo_error(client->mid, + "[flock] JSON parse error: %s", + json_tokener_error_desc(jerr)); + json_tokener_free(tokener); + return FLOCK_ERR_INVALID_CONFIG; + } + json_tokener_free(tokener); + if (!(json_object_is_type(content, json_type_object))) { + margo_error(client->mid, "[flock] Invalid JSON group description"); + json_object_put(content); + return FLOCK_ERR_INVALID_CONFIG; + } + + flock_return_t ret = FLOCK_SUCCESS; + + // Check that the content has the right format + struct json_object* credentials = json_object_object_get(content, "credentials"); + struct json_object* transport = json_object_object_get(content, "transport"); + struct json_object* members = json_object_object_get(content, "members"); + struct json_object* metadata = json_object_object_get(content, "metadata"); + + if(credentials && !json_object_is_type(credentials, json_type_int)) { + margo_error(client->mid, "[flock] \"credentials\" field should be an integer"); + ret = FLOCK_ERR_INVALID_CONFIG; + goto finish; + } + + if(!transport) { + margo_error(client->mid, "[flock] \"transport\" field not found"); + ret = FLOCK_ERR_INVALID_CONFIG; + goto finish; + } + + if(!json_object_is_type(transport, json_type_string)) { + margo_error(client->mid, "[flock] \"transport\" field should be of type string"); + ret = FLOCK_ERR_INVALID_CONFIG; + goto finish; + } + + if(metadata && !json_object_is_type(metadata, json_type_object)) { + margo_error(client->mid, "[flock] \"metadata\" field should be of type object"); + ret = FLOCK_ERR_INVALID_CONFIG; + goto finish; + } + + if(!members) { + margo_error(client->mid, "[flock] \"members\" field not found"); + ret = FLOCK_ERR_INVALID_CONFIG; + goto finish; + } + + if(!json_object_is_type(members, json_type_array)) { + margo_error(client->mid, "[flock] \"members\" field should be of type array"); + ret = FLOCK_ERR_INVALID_CONFIG; + goto finish; + } + + if(json_object_array_length(members) == 0) { + margo_error(client->mid, "[flock] \"members\" field should have at least one element"); + ret = FLOCK_ERR_INVALID_CONFIG; + goto finish; + } + + for(size_t i = 0; i < json_object_array_length(members); ++i) { + struct json_object* member = json_object_array_get_idx(members, i); + if(!json_object_is_type(member, json_type_object)) { + margo_error(client->mid, "[flock] \"members[%llu]\" should be an object", i); + ret = FLOCK_ERR_INVALID_CONFIG; + goto finish; + } + struct json_object* address = json_object_object_get(member, "address"); + struct json_object* rank = json_object_object_get(member, "rank"); + struct json_object* provider_id = json_object_object_get(member, "provider_id"); + if(!address) { + margo_error(client->mid, "[flock] \"members[%llu].address\" not found", i); + ret = FLOCK_ERR_INVALID_CONFIG; + goto finish; + } + if(!provider_id) { + margo_error(client->mid, "[flock] \"members[%llu].provider_id\" not found", i); + ret = FLOCK_ERR_INVALID_CONFIG; + goto finish; + } + if(!rank) { + margo_error(client->mid, "[flock] \"members[%llu].rank\" not found", i); + ret = FLOCK_ERR_INVALID_CONFIG; + goto finish; + } + if(!json_object_is_type(address, json_type_string)) { + margo_error(client->mid, "[flock] \"members[%llu].address\" should be a string", i); + ret = FLOCK_ERR_INVALID_CONFIG; + goto finish; + } + if(!json_object_is_type(provider_id, json_type_int)) { + margo_error(client->mid, "[flock] \"members[%llu].provider_id\" should be an integer", i); + ret = FLOCK_ERR_INVALID_CONFIG; + goto finish; + } + if(json_object_get_int64(provider_id) < 0 || json_object_get_int64(provider_id) > 65535) { + margo_error(client->mid, "[flock] \"members[%llu].provider_id\" value out of allowed range", i); + ret = FLOCK_ERR_INVALID_CONFIG; + goto finish; + } + if(json_object_get_int64(provider_id) < 0) { + margo_error(client->mid, "[flock] \"members[%llu].rank\" value cannot be negative", i); + ret = FLOCK_ERR_INVALID_CONFIG; + goto finish; + } + } + + // convert the JSON into the internal group view + group_view_t view = GROUP_VIEW_INITIALIZER; + for(size_t i = 0; i < json_object_array_length(members); ++i) { + struct json_object* member = json_object_array_get_idx(members, i); + struct json_object* address = json_object_object_get(member, "address"); + struct json_object* provider_id = json_object_object_get(member, "provider_id"); + struct json_object* rank = json_object_object_get(member, "rank"); + group_view_add_member(&view, + json_object_get_uint64(rank), + (uint16_t)json_object_get_uint64(provider_id), + json_object_get_string(address)); + } + json_object_object_foreach(metadata, metadata_key, metadata_value) { + metadata_t* md = (metadata_t*)calloc(1, sizeof(*md)); + md->key = strdup(metadata_key); + md->value = strdup(json_object_get_string(metadata_value)); + HASH_ADD(hh, view.metadata, key, strlen(md->key), md); + } + + flock_group_handle_t rh = + (flock_group_handle_t)calloc(1, sizeof(*rh)); + + if(!rh) { + ret = FLOCK_ERR_ALLOCATION; + goto finish; + } + + const char* addr = view.members[0].str_addr; + + hret = margo_addr_lookup(client->mid, addr, &(rh->addr)); + if(hret != HG_SUCCESS) { + free(rh); + return FLOCK_ERR_FROM_MERCURY; + } + + rh->client = client; + rh->provider_id = view.members[0].provider_id; + rh->refcount = 1; + rh->view = view; + + client->num_group_handles += 1; + + if(mode & FLOCK_MODE_INIT_UPDATE) { + flock_return_t ret = flock_group_update(rh, NULL); + if(ret != FLOCK_SUCCESS) { + flock_group_handle_release(rh); + goto finish; + } + } + + *handle = rh; + +finish: + json_object_put(content); + return ret; +} + +static inline bool metadata_to_json(void* ctx, const char* key, const char* value) +{ + struct json_object* map = (struct json_object*)ctx; + json_object_object_add(map, key, json_object_new_string(value)); + return true; +} + +flock_return_t flock_group_serialize( + flock_group_handle_t handle, + void (*serializer)(void*, const char*, size_t), + void* context) +{ + struct json_object* view = json_object_new_object(); + if(!serializer) return FLOCK_ERR_INVALID_ARGS; + + LOCK_GROUP_VIEW(&handle->view); + struct json_object* members = json_object_new_array_ext(handle->view.size); + json_object_object_add(view, "members", members); + for(size_t i=0; i < handle->view.size; ++i) { + struct json_object* member = json_object_new_object(); + json_object_object_add(member, + "address", json_object_new_string(handle->view.members[i].str_addr)); + json_object_object_add(member, + "provider_id", json_object_new_uint64(handle->view.members[i].provider_id)); + json_object_array_add(members, member); + } + + hg_class_t* hg_class = margo_get_class(handle->client->mid); + json_object_object_add( + view, "transport", json_object_new_string(HG_Class_get_protocol(hg_class))); + + json_object_object_add( + view, "credentials", json_object_new_int64(handle->credentials)); + + struct json_object* metadata = json_object_new_object(); + group_view_metadata_iterate(&handle->view, metadata_to_json, metadata); + json_object_object_add(view, "metadata", metadata); + + size_t len; + const char* str = json_object_to_json_string_length(view, 0, &len); + if(!str) { + UNLOCK_GROUP_VIEW(&handle->view); + return FLOCK_ERR_ALLOCATION; + } + + UNLOCK_GROUP_VIEW(&handle->view); + serializer(context, str, len); + + json_object_put(view); + return FLOCK_SUCCESS; +} + +flock_return_t flock_group_size( + flock_group_handle_t handle, + size_t* size) +{ + // IMPORTANT: in the group_view structure, the "size" field + // is the number of entries in the array, not the size of the + // group. The size of the group is defined as R+1 where R is + // the maximum rank found in the group. + LOCK_GROUP_VIEW(&handle->view); + member_t* last_member = handle->view.members + handle->view.size; + *size = last_member->rank + 1; + UNLOCK_GROUP_VIEW(&handle->view); + return FLOCK_SUCCESS; +} + +flock_return_t flock_group_live_member_count( + flock_group_handle_t handle, + size_t* count) +{ + LOCK_GROUP_VIEW(&handle->view); + *count = handle->view.size; + UNLOCK_GROUP_VIEW(&handle->view); + return FLOCK_SUCCESS; +} + +flock_return_t flock_group_member_iterate( + flock_group_handle_t handle, + flock_member_access_fn access_fn, + void* context) +{ + if(!access_fn) return FLOCK_SUCCESS; + LOCK_GROUP_VIEW(&handle->view); + // Call the callback on all members + for(size_t i=0; i < handle->view.size; ++i) { + if(!access_fn(context, + handle->view.members[i].rank, + handle->view.members[i].str_addr, + handle->view.members[i].provider_id)) + break; + } + UNLOCK_GROUP_VIEW(&handle->view); + return FLOCK_SUCCESS; +} + +flock_return_t flock_group_member_get_address_string( + flock_group_handle_t handle, + size_t rank, + char** address) +{ + LOCK_GROUP_VIEW(&handle->view); + const member_t* member = group_view_find_member(&handle->view, rank); + if(!member) { + UNLOCK_GROUP_VIEW(&handle->view); + *address = NULL; + return FLOCK_ERR_NO_MEMBER; + } + *address = strdup(member->str_addr); + UNLOCK_GROUP_VIEW(&handle->view); + return FLOCK_SUCCESS; +} + +flock_return_t flock_group_member_get_address( + flock_group_handle_t handle, + size_t rank, + hg_addr_t* address) +{ + LOCK_GROUP_VIEW(&handle->view); + const member_t* member = group_view_find_member(&handle->view, rank); + if(!member) { + UNLOCK_GROUP_VIEW(&handle->view); + *address = HG_ADDR_NULL; + return FLOCK_ERR_NO_MEMBER; + } + hg_return_t hret = margo_addr_lookup( + handle->client->mid, + member->str_addr, address); + UNLOCK_GROUP_VIEW(&handle->view); + if(hret != HG_SUCCESS) return FLOCK_ERR_FROM_MERCURY; + return FLOCK_SUCCESS; +} + +flock_return_t flock_group_member_get_provider_id( + flock_group_handle_t handle, + size_t rank, + uint16_t* provider_id) +{ + + LOCK_GROUP_VIEW(&handle->view); + const member_t* member = group_view_find_member(&handle->view, rank); + if(!member) { + UNLOCK_GROUP_VIEW(&handle->view); + *provider_id = MARGO_MAX_PROVIDER_ID; + return FLOCK_ERR_NO_MEMBER; + } + *provider_id = member->provider_id; + UNLOCK_GROUP_VIEW(&handle->view); + return FLOCK_SUCCESS; +} + +flock_return_t flock_group_member_get_rank( + flock_group_handle_t handle, + const char* address, + uint16_t provider_id, + size_t* rank) +{ + *rank = SIZE_MAX; + flock_return_t ret = FLOCK_ERR_NO_MEMBER; + LOCK_GROUP_VIEW(&handle->view); + for(size_t i=0; i < handle->view.size; ++i) { + if(provider_id != handle->view.members[i].provider_id) continue; + if(strcmp(address, handle->view.members[i].str_addr) != 0) continue; + *rank = handle->view.members[i].rank; + ret = FLOCK_SUCCESS; + break; + } + UNLOCK_GROUP_VIEW(&handle->view); + return ret; +} + +flock_return_t flock_group_metadata_iterate( + flock_group_handle_t handle, + flock_metadata_access_fn access_fn, + void* context) +{ + if(!access_fn) return FLOCK_SUCCESS; + LOCK_GROUP_VIEW(&handle->view); + group_view_metadata_iterate(&handle->view, access_fn, context); + UNLOCK_GROUP_VIEW(&handle->view); + return FLOCK_SUCCESS; +} + +flock_return_t flock_group_metadata_access( + flock_group_handle_t handle, + const char* key, + flock_metadata_access_fn access_fn, + void* context) +{ + + if(!access_fn) return FLOCK_SUCCESS; + LOCK_GROUP_VIEW(&handle->view); + const char* value = group_view_find_metadata(&handle->view, key); + access_fn(context, key, value); + UNLOCK_GROUP_VIEW(&handle->view); + return FLOCK_SUCCESS; +} + +flock_return_t flock_group_metadata_set( + flock_group_handle_t handle, + const char* key, + const char* value) +{ + // TODO +} diff --git a/src/group-view.h b/src/group-view.h new file mode 100644 index 0000000..aa1a780 --- /dev/null +++ b/src/group-view.h @@ -0,0 +1,304 @@ +/* + * (C) 2024 The University of Chicago + * + * See COPYRIGHT in top-level directory. + */ +#ifndef FLOCK_GROUP_VIEW_H +#define FLOCK_GROUP_VIEW_H + +#include +#include +#include +#include +#include +#include "flock/flock-group.h" +#include +#include +#include +#include "uthash.h" + +typedef struct { + uint64_t rank; + uint16_t provider_id; + char* str_addr; +} member_t; + +typedef struct { + char* key; + char* value; + UT_hash_handle hh; +} metadata_t; + +typedef struct { + size_t size; + size_t capacity; + member_t* members; + metadata_t* metadata; + ABT_mutex_memory mtx; +} group_view_t; + +#define GROUP_VIEW_INITIALIZER {0,0,NULL,NULL,ABT_MUTEX_INITIALIZER} + +#define LOCK_GROUP_VIEW(view) do { \ + ABT_mutex_lock(ABT_MUTEX_MEMORY_GET_HANDLE(&(view)->mtx)); \ +} while(0) + +#define UNLOCK_GROUP_VIEW(view) do { \ + ABT_mutex_unlock(ABT_MUTEX_MEMORY_GET_HANDLE(&(view)->mtx)); \ +} while(0) + +static inline void clear_group_view(group_view_t *view) +{ + if (view) { + LOCK_GROUP_VIEW(view); + for (size_t i = 0; i < view->size; ++i) { + free(view->members[i].str_addr); + } + free(view->members); + view->capacity = 0; + view->size = 0; + UNLOCK_GROUP_VIEW(view); + } +} + +static inline ssize_t group_view_binary_search(const group_view_t *view, uint64_t key) +{ + ssize_t left = 0; + ssize_t right = view->size - 1; + while (left <= right) { + ssize_t mid = left + (right - left) / 2; + if (view->members[mid].rank == key) { + return mid; // Key found + } else if (view->members[mid].rank < key) { + left = mid + 1; + } else { + right = mid - 1; + } + } + return -1; // Key not found +} + +static inline bool group_view_add_member( + group_view_t *view, + uint64_t rank, + uint16_t provider_id, + const char *address) +{ + LOCK_GROUP_VIEW(view); + bool ret = true; + + // Check if there is enough capacity, if not, resize + if (view->size == view->capacity) { + view->capacity *= 2; + member_t *temp = (member_t *)realloc(view->members, view->capacity * sizeof(member_t)); + if (!temp) { + UNLOCK_GROUP_VIEW(view); + ret = false; + goto finish; + } + view->members = temp; + } + + // Find the position to insert while maintaining sorted order + size_t pos = 0; + while (pos < view->size && view->members[pos].rank < rank) { + ++pos; + } + + // Shift elements to make space for the new member + memmove(&view->members[pos + 1], &view->members[pos], (view->size - pos) * sizeof(member_t)); + + // Insert the new member + view->members[pos].rank = rank; + view->members[pos].provider_id = provider_id; + view->members[pos].str_addr = strdup(address); + if (!view->members[pos].str_addr) { + UNLOCK_GROUP_VIEW(view); + ret = false; // Memory allocation failed + goto finish; + } + + ++view->size; + +finish: + UNLOCK_GROUP_VIEW(view); + return ret; +} + +// Function to remove a member based on its rank +static inline bool group_view_remove_member(group_view_t *view, uint64_t rank) +{ + LOCK_GROUP_VIEW(view); + bool ret = true; + ssize_t idx = group_view_binary_search(view, rank); + if (idx == -1) { + ret = false; + goto finish; + } + + // Free the memory allocated for the address + free(view->members[idx].str_addr); + + // Shift elements to remove the member + memmove(&view->members[idx], &view->members[idx + 1], (view->size - idx - 1) * sizeof(member_t)); + + --view->size; + +finish: + UNLOCK_GROUP_VIEW(view); + return ret; +} + +// Function to find a member based on its rank +static inline const member_t *group_view_find_member(const group_view_t *view, uint64_t rank) +{ + ssize_t idx = group_view_binary_search(view, rank); + if (idx == -1) { + return NULL; // member_t not found + } + return &view->members[idx]; +} + +// Function to get the value associated with a metadata key (returns NULL if not found) +static inline const char* group_view_find_metadata(const group_view_t *view, const char* key) +{ + metadata_t* md = NULL; + HASH_FIND_STR(view->metadata, key, md); + return md ? md->value : NULL; +} + +// Function to iterate over the metadata +static inline void group_view_metadata_iterate( + const group_view_t *view, + flock_metadata_access_fn access_fn, + void* context) +{ + metadata_t *md, *tmp; + HASH_ITER(hh, view->metadata, md, tmp) { + if(!access_fn(context, md->key, md->value)) goto finish; + } +finish: + return; +} + +// Function to serialize/deserialize a group view +static inline hg_return_t hg_proc_group_view_t_internal(hg_proc_t proc, group_view_t* view) { + hg_return_t ret = HG_SUCCESS; + switch(hg_proc_get_op(proc)) { + case HG_ENCODE: + { + ret = hg_proc_hg_size_t(proc, &view->size); + if(ret != HG_SUCCESS) return ret; + for(size_t i=0; i < view->size; ++i) { + ret = hg_proc_uint64_t(proc, &view->members[i].rank); + if(ret != HG_SUCCESS) return ret; + ret = hg_proc_uint16_t(proc, &view->members[i].provider_id); + if(ret != HG_SUCCESS) return ret; + size_t addr_size = strlen(view->members[i].str_addr); + ret = hg_proc_hg_size_t(proc, &addr_size); + if(ret != HG_SUCCESS) return ret; + ret = hg_proc_memcpy(proc, view->members[i].str_addr, addr_size); + if(ret != HG_SUCCESS) return ret; + } + size_t count_metadata = HASH_COUNT(view->metadata); + ret = hg_proc_hg_size_t(proc, &count_metadata); + if(ret != HG_SUCCESS) return ret; + metadata_t *current_md, *tmp; + HASH_ITER(hh, view->metadata, current_md, tmp) { + uint64_t ksize = strlen(current_md->key); + uint64_t vsize = strlen(current_md->value); + ret = hg_proc_uint64_t(proc, &ksize); + if(ret != HG_SUCCESS) return ret; + ret = hg_proc_memcpy(proc, current_md->key, ksize); + if(ret != HG_SUCCESS) return ret; + ret = hg_proc_uint64_t(proc, &vsize); + if(ret != HG_SUCCESS) return ret; + ret = hg_proc_memcpy(proc, current_md->value, vsize); + if(ret != HG_SUCCESS) return ret; + } + } + break; + case HG_DECODE: + { + // Free anything already in the array and the array itself + for(size_t i=0; i < view->size; ++i) + free(view->members[i].str_addr); + view->capacity = 0; + free(view->members); + // Deserialize members + ret = hg_proc_hg_size_t(proc, &view->size); + if(ret != HG_SUCCESS) return ret; + view->capacity = view->size; + view->members = (member_t*)malloc(view->size * sizeof(member_t)); + if(!view->members) return HG_NOMEM; + for(size_t i=0; i < view->size; ++i) { + ret = hg_proc_uint64_t(proc, &view->members[i].rank); + if(ret != HG_SUCCESS) return ret; + ret = hg_proc_uint16_t(proc, &view->members[i].provider_id); + if(ret != HG_SUCCESS) return ret; + size_t addr_size = 0; + ret = hg_proc_hg_size_t(proc, &addr_size); + if(ret != HG_SUCCESS) return ret; + view->members[i].str_addr = calloc(addr_size + 1, 1); + if(!view->members[i].str_addr) { // Allocation failed + view->size = i; + clear_group_view(view); + return HG_NOMEM; + } + ret = hg_proc_memcpy(proc, view->members[i].str_addr, addr_size); + if(ret != HG_SUCCESS) { // Deserialization of address failed + view->size = i; + clear_group_view(view); + return ret; + } + } + // Deserialize metadata + size_t count_metadata = 0; + ret = hg_proc_hg_size_t(proc, &count_metadata); + if(ret != HG_SUCCESS) { + clear_group_view(view); + return ret; + } + for(size_t i = 0; i < count_metadata; ++i) { + uint64_t ksize = 0, vsize = 0; + metadata_t* md = (metadata_t*)calloc(1, sizeof(metadata_t)); + ret = hg_proc_uint64_t(proc, &ksize); + if(ret != HG_SUCCESS) { + clear_group_view(view); + return ret; + } + ret = hg_proc_memcpy(proc, md->key, ksize); + if(ret != HG_SUCCESS) { + clear_group_view(view); + return ret; + } + ret = hg_proc_uint64_t(proc, &vsize); + if(ret != HG_SUCCESS) { + clear_group_view(view); + return ret; + } + ret = hg_proc_memcpy(proc, md->value, vsize); + if(ret != HG_SUCCESS) { + clear_group_view(view); + return ret; + } + HASH_ADD_KEYPTR(hh, view->metadata, md->key, ksize, md); + } + } + break; + case HG_FREE: + clear_group_view(view); + break; + } + return HG_SUCCESS; +} + +static inline hg_return_t hg_proc_group_view_t(hg_proc_t proc, group_view_t* view) { + LOCK_GROUP_VIEW(view); + hg_return_t hret = hg_proc_group_view_t_internal(proc, view); + UNLOCK_GROUP_VIEW(view); + return hret; +} + +#endif /* FLOCK_GROUP_VIEW_H */ + diff --git a/src/provider.c b/src/provider.c index 722bb5c..b734e8f 100644 --- a/src/provider.c +++ b/src/provider.c @@ -1,5 +1,5 @@ /* - * (C) 2020 The University of Chicago + * (C) 2024 The University of Chicago * * See COPYRIGHT in top-level directory. */ @@ -23,8 +23,8 @@ static inline flock_backend_impl* find_backend_impl(const char* name); static inline flock_return_t add_backend_impl(flock_backend_impl* backend); /* Client RPCs */ -static DECLARE_MARGO_RPC_HANDLER(flock_sum_ult) -static void flock_sum_ult(hg_handle_t h); +static DECLARE_MARGO_RPC_HANDLER(flock_update_ult) +static void flock_update_ult(hg_handle_t h); /* FIXME: add other RPC declarations here */ @@ -95,11 +95,11 @@ flock_return_t flock_provider_register( /* Client RPCs */ - id = MARGO_REGISTER_PROVIDER(mid, "flock_sum", - sum_in_t, sum_out_t, - flock_sum_ult, provider_id, p->pool); + id = MARGO_REGISTER_PROVIDER(mid, "flock_update", + void, update_out_t, + flock_update_ult, provider_id, p->pool); margo_register_data(mid, id, (void*)p, NULL); - p->sum_id = id; + p->update_id = id; /* FIXME: add other RPC registration here */ /* ... */ @@ -170,9 +170,7 @@ static void flock_finalize_provider(void* p) flock_provider_t provider = (flock_provider_t)p; margo_info(provider->mid, "Finalizing FLOCK provider"); margo_provider_deregister_identity(provider->mid, provider->provider_id); - margo_deregister(provider->mid, provider->create_group_id); - margo_deregister(provider->mid, provider->destroy_group_id); - margo_deregister(provider->mid, provider->sum_id); + margo_deregister(provider->mid, provider->update_id); /* FIXME deregister other RPC ids ... */ /* destroy the group's context */ @@ -224,11 +222,10 @@ flock_return_t flock_provider_register_backend( return add_backend_impl(backend_impl); } -static void flock_sum_ult(hg_handle_t h) +static void flock_update_ult(hg_handle_t h) { hg_return_t hret; - sum_in_t in; - sum_out_t out; + update_out_t out; /* find the margo instance */ margo_instance_id mid = margo_hg_handle_get_instance(h); @@ -237,32 +234,23 @@ static void flock_sum_ult(hg_handle_t h) const struct hg_info* info = margo_get_info(h); flock_provider_t provider = (flock_provider_t)margo_registered_data(mid, info->id); - /* deserialize the input */ - hret = margo_get_input(h, &in); - if(hret != HG_SUCCESS) { - margo_error(mid, "Could not deserialize output (mercury error %d)", hret); - out.ret = FLOCK_ERR_FROM_MERCURY; - goto finish; - } - flock_group* group = provider->group; if(!group) { out.ret = FLOCK_ERR_INVALID_GROUP; goto finish; } - /* call sum on the group's context */ - out.result = group->fn->sum(group->ctx, in.x, in.y); + /* call update on the group's context */ +// out.result = group->fn->update(group->ctx, in.x, in.y); out.ret = FLOCK_SUCCESS; - margo_debug(mid, "Called sum RPC"); + margo_debug(mid, "Called update RPC"); finish: hret = margo_respond(h, &out); - hret = margo_free_input(h, &in); margo_destroy(h); } -static DEFINE_MARGO_RPC_HANDLER(flock_sum_ult) +static DEFINE_MARGO_RPC_HANDLER(flock_update_ult) static inline flock_backend_impl* find_backend_impl(const char* name) { diff --git a/src/provider.h b/src/provider.h index 910232b..2fe181e 100644 --- a/src/provider.h +++ b/src/provider.h @@ -1,5 +1,5 @@ /* - * (C) 2020 The University of Chicago + * (C) 2024 The University of Chicago * * See COPYRIGHT in top-level directory. */ @@ -22,11 +22,8 @@ typedef struct flock_provider { ABT_pool pool; // Pool on which to post RPC requests /* Resource */ flock_group* group; - /* RPC identifiers for admins */ - hg_id_t create_group_id; - hg_id_t destroy_group_id; /* RPC identifiers for clients */ - hg_id_t sum_id; + hg_id_t update_id; /* ... add other RPC identifiers here ... */ } flock_provider; diff --git a/src/types.h b/src/types.h index 0e55a43..7211869 100644 --- a/src/types.h +++ b/src/types.h @@ -1,5 +1,5 @@ /* - * (C) 2020 The University of Chicago + * (C) 2024 The University of Chicago * * See COPYRIGHT in top-level directory. */ @@ -12,15 +12,12 @@ #include #include #include "flock/flock-common.h" +#include "group-view.h" /* Client RPC types */ -MERCURY_GEN_PROC(sum_in_t, - ((int32_t)(x))\ - ((int32_t)(y))) - -MERCURY_GEN_PROC(sum_out_t, - ((int32_t)(result))\ +MERCURY_GEN_PROC(update_out_t, + ((group_view_t)(view))\ ((int32_t)(ret))) /* FIXME: other types come here */ diff --git a/src/uthash.h b/src/uthash.h new file mode 100644 index 0000000..68693bf --- /dev/null +++ b/src/uthash.h @@ -0,0 +1,1140 @@ +/* +Copyright (c) 2003-2022, Troy D. Hanson https://troydhanson.github.io/uthash/ +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS +IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A +PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER +OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, +EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, +PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR +PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +*/ + +#ifndef UTHASH_H +#define UTHASH_H + +#define UTHASH_VERSION 2.3.0 + +#include /* memcmp, memset, strlen */ +#include /* ptrdiff_t */ +#include /* exit */ + +#if defined(HASH_DEFINE_OWN_STDINT) && HASH_DEFINE_OWN_STDINT +/* This codepath is provided for backward compatibility, but I plan to remove it. */ +#warning "HASH_DEFINE_OWN_STDINT is deprecated; please use HASH_NO_STDINT instead" +typedef unsigned int uint32_t; +typedef unsigned char uint8_t; +#elif defined(HASH_NO_STDINT) && HASH_NO_STDINT +#else +#include /* uint8_t, uint32_t */ +#endif + +/* These macros use decltype or the earlier __typeof GNU extension. + As decltype is only available in newer compilers (VS2010 or gcc 4.3+ + when compiling c++ source) this code uses whatever method is needed + or, for VS2008 where neither is available, uses casting workarounds. */ +#if !defined(DECLTYPE) && !defined(NO_DECLTYPE) +#if defined(_MSC_VER) /* MS compiler */ +#if _MSC_VER >= 1600 && defined(__cplusplus) /* VS2010 or newer in C++ mode */ +#define DECLTYPE(x) (decltype(x)) +#else /* VS2008 or older (or VS2010 in C mode) */ +#define NO_DECLTYPE +#endif +#elif defined(__MCST__) /* Elbrus C Compiler */ +#define DECLTYPE(x) (__typeof(x)) +#elif defined(__BORLANDC__) || defined(__ICCARM__) || defined(__LCC__) || defined(__WATCOMC__) +#define NO_DECLTYPE +#else /* GNU, Sun and other compilers */ +#define DECLTYPE(x) (__typeof(x)) +#endif +#endif + +#ifdef NO_DECLTYPE +#define DECLTYPE(x) +#define DECLTYPE_ASSIGN(dst,src) \ +do { \ + char **_da_dst = (char**)(&(dst)); \ + *_da_dst = (char*)(src); \ +} while (0) +#else +#define DECLTYPE_ASSIGN(dst,src) \ +do { \ + (dst) = DECLTYPE(dst)(src); \ +} while (0) +#endif + +#ifndef uthash_malloc +#define uthash_malloc(sz) malloc(sz) /* malloc fcn */ +#endif +#ifndef uthash_free +#define uthash_free(ptr,sz) free(ptr) /* free fcn */ +#endif +#ifndef uthash_bzero +#define uthash_bzero(a,n) memset(a,'\0',n) +#endif +#ifndef uthash_strlen +#define uthash_strlen(s) strlen(s) +#endif + +#ifndef HASH_FUNCTION +#define HASH_FUNCTION(keyptr,keylen,hashv) HASH_JEN(keyptr, keylen, hashv) +#endif + +#ifndef HASH_KEYCMP +#define HASH_KEYCMP(a,b,n) memcmp(a,b,n) +#endif + +#ifndef uthash_noexpand_fyi +#define uthash_noexpand_fyi(tbl) /* can be defined to log noexpand */ +#endif +#ifndef uthash_expand_fyi +#define uthash_expand_fyi(tbl) /* can be defined to log expands */ +#endif + +#ifndef HASH_NONFATAL_OOM +#define HASH_NONFATAL_OOM 0 +#endif + +#if HASH_NONFATAL_OOM +/* malloc failures can be recovered from */ + +#ifndef uthash_nonfatal_oom +#define uthash_nonfatal_oom(obj) do {} while (0) /* non-fatal OOM error */ +#endif + +#define HASH_RECORD_OOM(oomed) do { (oomed) = 1; } while (0) +#define IF_HASH_NONFATAL_OOM(x) x + +#else +/* malloc failures result in lost memory, hash tables are unusable */ + +#ifndef uthash_fatal +#define uthash_fatal(msg) exit(-1) /* fatal OOM error */ +#endif + +#define HASH_RECORD_OOM(oomed) uthash_fatal("out of memory") +#define IF_HASH_NONFATAL_OOM(x) + +#endif + +/* initial number of buckets */ +#define HASH_INITIAL_NUM_BUCKETS 32U /* initial number of buckets */ +#define HASH_INITIAL_NUM_BUCKETS_LOG2 5U /* lg2 of initial number of buckets */ +#define HASH_BKT_CAPACITY_THRESH 10U /* expand when bucket count reaches */ + +/* calculate the element whose hash handle address is hhp */ +#define ELMT_FROM_HH(tbl,hhp) ((void*)(((char*)(hhp)) - ((tbl)->hho))) +/* calculate the hash handle from element address elp */ +#define HH_FROM_ELMT(tbl,elp) ((UT_hash_handle*)(void*)(((char*)(elp)) + ((tbl)->hho))) + +#define HASH_ROLLBACK_BKT(hh, head, itemptrhh) \ +do { \ + struct UT_hash_handle *_hd_hh_item = (itemptrhh); \ + unsigned _hd_bkt; \ + HASH_TO_BKT(_hd_hh_item->hashv, (head)->hh.tbl->num_buckets, _hd_bkt); \ + (head)->hh.tbl->buckets[_hd_bkt].count++; \ + _hd_hh_item->hh_next = NULL; \ + _hd_hh_item->hh_prev = NULL; \ +} while (0) + +#define HASH_VALUE(keyptr,keylen,hashv) \ +do { \ + HASH_FUNCTION(keyptr, keylen, hashv); \ +} while (0) + +#define HASH_FIND_BYHASHVALUE(hh,head,keyptr,keylen,hashval,out) \ +do { \ + (out) = NULL; \ + if (head) { \ + unsigned _hf_bkt; \ + HASH_TO_BKT(hashval, (head)->hh.tbl->num_buckets, _hf_bkt); \ + if (HASH_BLOOM_TEST((head)->hh.tbl, hashval) != 0) { \ + HASH_FIND_IN_BKT((head)->hh.tbl, hh, (head)->hh.tbl->buckets[ _hf_bkt ], keyptr, keylen, hashval, out); \ + } \ + } \ +} while (0) + +#define HASH_FIND(hh,head,keyptr,keylen,out) \ +do { \ + (out) = NULL; \ + if (head) { \ + unsigned _hf_hashv; \ + HASH_VALUE(keyptr, keylen, _hf_hashv); \ + HASH_FIND_BYHASHVALUE(hh, head, keyptr, keylen, _hf_hashv, out); \ + } \ +} while (0) + +#ifdef HASH_BLOOM +#define HASH_BLOOM_BITLEN (1UL << HASH_BLOOM) +#define HASH_BLOOM_BYTELEN (HASH_BLOOM_BITLEN/8UL) + (((HASH_BLOOM_BITLEN%8UL)!=0UL) ? 1UL : 0UL) +#define HASH_BLOOM_MAKE(tbl,oomed) \ +do { \ + (tbl)->bloom_nbits = HASH_BLOOM; \ + (tbl)->bloom_bv = (uint8_t*)uthash_malloc(HASH_BLOOM_BYTELEN); \ + if (!(tbl)->bloom_bv) { \ + HASH_RECORD_OOM(oomed); \ + } else { \ + uthash_bzero((tbl)->bloom_bv, HASH_BLOOM_BYTELEN); \ + (tbl)->bloom_sig = HASH_BLOOM_SIGNATURE; \ + } \ +} while (0) + +#define HASH_BLOOM_FREE(tbl) \ +do { \ + uthash_free((tbl)->bloom_bv, HASH_BLOOM_BYTELEN); \ +} while (0) + +#define HASH_BLOOM_BITSET(bv,idx) (bv[(idx)/8U] |= (1U << ((idx)%8U))) +#define HASH_BLOOM_BITTEST(bv,idx) (bv[(idx)/8U] & (1U << ((idx)%8U))) + +#define HASH_BLOOM_ADD(tbl,hashv) \ + HASH_BLOOM_BITSET((tbl)->bloom_bv, ((hashv) & (uint32_t)((1UL << (tbl)->bloom_nbits) - 1U))) + +#define HASH_BLOOM_TEST(tbl,hashv) \ + HASH_BLOOM_BITTEST((tbl)->bloom_bv, ((hashv) & (uint32_t)((1UL << (tbl)->bloom_nbits) - 1U))) + +#else +#define HASH_BLOOM_MAKE(tbl,oomed) +#define HASH_BLOOM_FREE(tbl) +#define HASH_BLOOM_ADD(tbl,hashv) +#define HASH_BLOOM_TEST(tbl,hashv) (1) +#define HASH_BLOOM_BYTELEN 0U +#endif + +#define HASH_MAKE_TABLE(hh,head,oomed) \ +do { \ + (head)->hh.tbl = (UT_hash_table*)uthash_malloc(sizeof(UT_hash_table)); \ + if (!(head)->hh.tbl) { \ + HASH_RECORD_OOM(oomed); \ + } else { \ + uthash_bzero((head)->hh.tbl, sizeof(UT_hash_table)); \ + (head)->hh.tbl->tail = &((head)->hh); \ + (head)->hh.tbl->num_buckets = HASH_INITIAL_NUM_BUCKETS; \ + (head)->hh.tbl->log2_num_buckets = HASH_INITIAL_NUM_BUCKETS_LOG2; \ + (head)->hh.tbl->hho = (char*)(&(head)->hh) - (char*)(head); \ + (head)->hh.tbl->buckets = (UT_hash_bucket*)uthash_malloc( \ + HASH_INITIAL_NUM_BUCKETS * sizeof(struct UT_hash_bucket)); \ + (head)->hh.tbl->signature = HASH_SIGNATURE; \ + if (!(head)->hh.tbl->buckets) { \ + HASH_RECORD_OOM(oomed); \ + uthash_free((head)->hh.tbl, sizeof(UT_hash_table)); \ + } else { \ + uthash_bzero((head)->hh.tbl->buckets, \ + HASH_INITIAL_NUM_BUCKETS * sizeof(struct UT_hash_bucket)); \ + HASH_BLOOM_MAKE((head)->hh.tbl, oomed); \ + IF_HASH_NONFATAL_OOM( \ + if (oomed) { \ + uthash_free((head)->hh.tbl->buckets, \ + HASH_INITIAL_NUM_BUCKETS*sizeof(struct UT_hash_bucket)); \ + uthash_free((head)->hh.tbl, sizeof(UT_hash_table)); \ + } \ + ) \ + } \ + } \ +} while (0) + +#define HASH_REPLACE_BYHASHVALUE_INORDER(hh,head,fieldname,keylen_in,hashval,add,replaced,cmpfcn) \ +do { \ + (replaced) = NULL; \ + HASH_FIND_BYHASHVALUE(hh, head, &((add)->fieldname), keylen_in, hashval, replaced); \ + if (replaced) { \ + HASH_DELETE(hh, head, replaced); \ + } \ + HASH_ADD_KEYPTR_BYHASHVALUE_INORDER(hh, head, &((add)->fieldname), keylen_in, hashval, add, cmpfcn); \ +} while (0) + +#define HASH_REPLACE_BYHASHVALUE(hh,head,fieldname,keylen_in,hashval,add,replaced) \ +do { \ + (replaced) = NULL; \ + HASH_FIND_BYHASHVALUE(hh, head, &((add)->fieldname), keylen_in, hashval, replaced); \ + if (replaced) { \ + HASH_DELETE(hh, head, replaced); \ + } \ + HASH_ADD_KEYPTR_BYHASHVALUE(hh, head, &((add)->fieldname), keylen_in, hashval, add); \ +} while (0) + +#define HASH_REPLACE(hh,head,fieldname,keylen_in,add,replaced) \ +do { \ + unsigned _hr_hashv; \ + HASH_VALUE(&((add)->fieldname), keylen_in, _hr_hashv); \ + HASH_REPLACE_BYHASHVALUE(hh, head, fieldname, keylen_in, _hr_hashv, add, replaced); \ +} while (0) + +#define HASH_REPLACE_INORDER(hh,head,fieldname,keylen_in,add,replaced,cmpfcn) \ +do { \ + unsigned _hr_hashv; \ + HASH_VALUE(&((add)->fieldname), keylen_in, _hr_hashv); \ + HASH_REPLACE_BYHASHVALUE_INORDER(hh, head, fieldname, keylen_in, _hr_hashv, add, replaced, cmpfcn); \ +} while (0) + +#define HASH_APPEND_LIST(hh, head, add) \ +do { \ + (add)->hh.next = NULL; \ + (add)->hh.prev = ELMT_FROM_HH((head)->hh.tbl, (head)->hh.tbl->tail); \ + (head)->hh.tbl->tail->next = (add); \ + (head)->hh.tbl->tail = &((add)->hh); \ +} while (0) + +#define HASH_AKBI_INNER_LOOP(hh,head,add,cmpfcn) \ +do { \ + do { \ + if (cmpfcn(DECLTYPE(head)(_hs_iter), add) > 0) { \ + break; \ + } \ + } while ((_hs_iter = HH_FROM_ELMT((head)->hh.tbl, _hs_iter)->next)); \ +} while (0) + +#ifdef NO_DECLTYPE +#undef HASH_AKBI_INNER_LOOP +#define HASH_AKBI_INNER_LOOP(hh,head,add,cmpfcn) \ +do { \ + char *_hs_saved_head = (char*)(head); \ + do { \ + DECLTYPE_ASSIGN(head, _hs_iter); \ + if (cmpfcn(head, add) > 0) { \ + DECLTYPE_ASSIGN(head, _hs_saved_head); \ + break; \ + } \ + DECLTYPE_ASSIGN(head, _hs_saved_head); \ + } while ((_hs_iter = HH_FROM_ELMT((head)->hh.tbl, _hs_iter)->next)); \ +} while (0) +#endif + +#if HASH_NONFATAL_OOM + +#define HASH_ADD_TO_TABLE(hh,head,keyptr,keylen_in,hashval,add,oomed) \ +do { \ + if (!(oomed)) { \ + unsigned _ha_bkt; \ + (head)->hh.tbl->num_items++; \ + HASH_TO_BKT(hashval, (head)->hh.tbl->num_buckets, _ha_bkt); \ + HASH_ADD_TO_BKT((head)->hh.tbl->buckets[_ha_bkt], hh, &(add)->hh, oomed); \ + if (oomed) { \ + HASH_ROLLBACK_BKT(hh, head, &(add)->hh); \ + HASH_DELETE_HH(hh, head, &(add)->hh); \ + (add)->hh.tbl = NULL; \ + uthash_nonfatal_oom(add); \ + } else { \ + HASH_BLOOM_ADD((head)->hh.tbl, hashval); \ + HASH_EMIT_KEY(hh, head, keyptr, keylen_in); \ + } \ + } else { \ + (add)->hh.tbl = NULL; \ + uthash_nonfatal_oom(add); \ + } \ +} while (0) + +#else + +#define HASH_ADD_TO_TABLE(hh,head,keyptr,keylen_in,hashval,add,oomed) \ +do { \ + unsigned _ha_bkt; \ + (head)->hh.tbl->num_items++; \ + HASH_TO_BKT(hashval, (head)->hh.tbl->num_buckets, _ha_bkt); \ + HASH_ADD_TO_BKT((head)->hh.tbl->buckets[_ha_bkt], hh, &(add)->hh, oomed); \ + HASH_BLOOM_ADD((head)->hh.tbl, hashval); \ + HASH_EMIT_KEY(hh, head, keyptr, keylen_in); \ +} while (0) + +#endif + + +#define HASH_ADD_KEYPTR_BYHASHVALUE_INORDER(hh,head,keyptr,keylen_in,hashval,add,cmpfcn) \ +do { \ + IF_HASH_NONFATAL_OOM( int _ha_oomed = 0; ) \ + (add)->hh.hashv = (hashval); \ + (add)->hh.key = (char*) (keyptr); \ + (add)->hh.keylen = (unsigned) (keylen_in); \ + if (!(head)) { \ + (add)->hh.next = NULL; \ + (add)->hh.prev = NULL; \ + HASH_MAKE_TABLE(hh, add, _ha_oomed); \ + IF_HASH_NONFATAL_OOM( if (!_ha_oomed) { ) \ + (head) = (add); \ + IF_HASH_NONFATAL_OOM( } ) \ + } else { \ + void *_hs_iter = (head); \ + (add)->hh.tbl = (head)->hh.tbl; \ + HASH_AKBI_INNER_LOOP(hh, head, add, cmpfcn); \ + if (_hs_iter) { \ + (add)->hh.next = _hs_iter; \ + if (((add)->hh.prev = HH_FROM_ELMT((head)->hh.tbl, _hs_iter)->prev)) { \ + HH_FROM_ELMT((head)->hh.tbl, (add)->hh.prev)->next = (add); \ + } else { \ + (head) = (add); \ + } \ + HH_FROM_ELMT((head)->hh.tbl, _hs_iter)->prev = (add); \ + } else { \ + HASH_APPEND_LIST(hh, head, add); \ + } \ + } \ + HASH_ADD_TO_TABLE(hh, head, keyptr, keylen_in, hashval, add, _ha_oomed); \ + HASH_FSCK(hh, head, "HASH_ADD_KEYPTR_BYHASHVALUE_INORDER"); \ +} while (0) + +#define HASH_ADD_KEYPTR_INORDER(hh,head,keyptr,keylen_in,add,cmpfcn) \ +do { \ + unsigned _hs_hashv; \ + HASH_VALUE(keyptr, keylen_in, _hs_hashv); \ + HASH_ADD_KEYPTR_BYHASHVALUE_INORDER(hh, head, keyptr, keylen_in, _hs_hashv, add, cmpfcn); \ +} while (0) + +#define HASH_ADD_BYHASHVALUE_INORDER(hh,head,fieldname,keylen_in,hashval,add,cmpfcn) \ + HASH_ADD_KEYPTR_BYHASHVALUE_INORDER(hh, head, &((add)->fieldname), keylen_in, hashval, add, cmpfcn) + +#define HASH_ADD_INORDER(hh,head,fieldname,keylen_in,add,cmpfcn) \ + HASH_ADD_KEYPTR_INORDER(hh, head, &((add)->fieldname), keylen_in, add, cmpfcn) + +#define HASH_ADD_KEYPTR_BYHASHVALUE(hh,head,keyptr,keylen_in,hashval,add) \ +do { \ + IF_HASH_NONFATAL_OOM( int _ha_oomed = 0; ) \ + (add)->hh.hashv = (hashval); \ + (add)->hh.key = (const void*) (keyptr); \ + (add)->hh.keylen = (unsigned) (keylen_in); \ + if (!(head)) { \ + (add)->hh.next = NULL; \ + (add)->hh.prev = NULL; \ + HASH_MAKE_TABLE(hh, add, _ha_oomed); \ + IF_HASH_NONFATAL_OOM( if (!_ha_oomed) { ) \ + (head) = (add); \ + IF_HASH_NONFATAL_OOM( } ) \ + } else { \ + (add)->hh.tbl = (head)->hh.tbl; \ + HASH_APPEND_LIST(hh, head, add); \ + } \ + HASH_ADD_TO_TABLE(hh, head, keyptr, keylen_in, hashval, add, _ha_oomed); \ + HASH_FSCK(hh, head, "HASH_ADD_KEYPTR_BYHASHVALUE"); \ +} while (0) + +#define HASH_ADD_KEYPTR(hh,head,keyptr,keylen_in,add) \ +do { \ + unsigned _ha_hashv; \ + HASH_VALUE(keyptr, keylen_in, _ha_hashv); \ + HASH_ADD_KEYPTR_BYHASHVALUE(hh, head, keyptr, keylen_in, _ha_hashv, add); \ +} while (0) + +#define HASH_ADD_BYHASHVALUE(hh,head,fieldname,keylen_in,hashval,add) \ + HASH_ADD_KEYPTR_BYHASHVALUE(hh, head, &((add)->fieldname), keylen_in, hashval, add) + +#define HASH_ADD(hh,head,fieldname,keylen_in,add) \ + HASH_ADD_KEYPTR(hh, head, &((add)->fieldname), keylen_in, add) + +#define HASH_TO_BKT(hashv,num_bkts,bkt) \ +do { \ + bkt = ((hashv) & ((num_bkts) - 1U)); \ +} while (0) + +/* delete "delptr" from the hash table. + * "the usual" patch-up process for the app-order doubly-linked-list. + * The use of _hd_hh_del below deserves special explanation. + * These used to be expressed using (delptr) but that led to a bug + * if someone used the same symbol for the head and deletee, like + * HASH_DELETE(hh,users,users); + * We want that to work, but by changing the head (users) below + * we were forfeiting our ability to further refer to the deletee (users) + * in the patch-up process. Solution: use scratch space to + * copy the deletee pointer, then the latter references are via that + * scratch pointer rather than through the repointed (users) symbol. + */ +#define HASH_DELETE(hh,head,delptr) \ + HASH_DELETE_HH(hh, head, &(delptr)->hh) + +#define HASH_DELETE_HH(hh,head,delptrhh) \ +do { \ + const struct UT_hash_handle *_hd_hh_del = (delptrhh); \ + if ((_hd_hh_del->prev == NULL) && (_hd_hh_del->next == NULL)) { \ + HASH_BLOOM_FREE((head)->hh.tbl); \ + uthash_free((head)->hh.tbl->buckets, \ + (head)->hh.tbl->num_buckets * sizeof(struct UT_hash_bucket)); \ + uthash_free((head)->hh.tbl, sizeof(UT_hash_table)); \ + (head) = NULL; \ + } else { \ + unsigned _hd_bkt; \ + if (_hd_hh_del == (head)->hh.tbl->tail) { \ + (head)->hh.tbl->tail = HH_FROM_ELMT((head)->hh.tbl, _hd_hh_del->prev); \ + } \ + if (_hd_hh_del->prev != NULL) { \ + HH_FROM_ELMT((head)->hh.tbl, _hd_hh_del->prev)->next = _hd_hh_del->next; \ + } else { \ + DECLTYPE_ASSIGN(head, _hd_hh_del->next); \ + } \ + if (_hd_hh_del->next != NULL) { \ + HH_FROM_ELMT((head)->hh.tbl, _hd_hh_del->next)->prev = _hd_hh_del->prev; \ + } \ + HASH_TO_BKT(_hd_hh_del->hashv, (head)->hh.tbl->num_buckets, _hd_bkt); \ + HASH_DEL_IN_BKT((head)->hh.tbl->buckets[_hd_bkt], _hd_hh_del); \ + (head)->hh.tbl->num_items--; \ + } \ + HASH_FSCK(hh, head, "HASH_DELETE_HH"); \ +} while (0) + +/* convenience forms of HASH_FIND/HASH_ADD/HASH_DEL */ +#define HASH_FIND_STR(head,findstr,out) \ +do { \ + unsigned _uthash_hfstr_keylen = (unsigned)uthash_strlen(findstr); \ + HASH_FIND(hh, head, findstr, _uthash_hfstr_keylen, out); \ +} while (0) +#define HASH_ADD_STR(head,strfield,add) \ +do { \ + unsigned _uthash_hastr_keylen = (unsigned)uthash_strlen((add)->strfield); \ + HASH_ADD(hh, head, strfield[0], _uthash_hastr_keylen, add); \ +} while (0) +#define HASH_REPLACE_STR(head,strfield,add,replaced) \ +do { \ + unsigned _uthash_hrstr_keylen = (unsigned)uthash_strlen((add)->strfield); \ + HASH_REPLACE(hh, head, strfield[0], _uthash_hrstr_keylen, add, replaced); \ +} while (0) +#define HASH_FIND_INT(head,findint,out) \ + HASH_FIND(hh,head,findint,sizeof(int),out) +#define HASH_ADD_INT(head,intfield,add) \ + HASH_ADD(hh,head,intfield,sizeof(int),add) +#define HASH_REPLACE_INT(head,intfield,add,replaced) \ + HASH_REPLACE(hh,head,intfield,sizeof(int),add,replaced) +#define HASH_FIND_PTR(head,findptr,out) \ + HASH_FIND(hh,head,findptr,sizeof(void *),out) +#define HASH_ADD_PTR(head,ptrfield,add) \ + HASH_ADD(hh,head,ptrfield,sizeof(void *),add) +#define HASH_REPLACE_PTR(head,ptrfield,add,replaced) \ + HASH_REPLACE(hh,head,ptrfield,sizeof(void *),add,replaced) +#define HASH_DEL(head,delptr) \ + HASH_DELETE(hh,head,delptr) + +/* HASH_FSCK checks hash integrity on every add/delete when HASH_DEBUG is defined. + * This is for uthash developer only; it compiles away if HASH_DEBUG isn't defined. + */ +#ifdef HASH_DEBUG +#include /* fprintf, stderr */ +#define HASH_OOPS(...) do { fprintf(stderr, __VA_ARGS__); exit(-1); } while (0) +#define HASH_FSCK(hh,head,where) \ +do { \ + struct UT_hash_handle *_thh; \ + if (head) { \ + unsigned _bkt_i; \ + unsigned _count = 0; \ + char *_prev; \ + for (_bkt_i = 0; _bkt_i < (head)->hh.tbl->num_buckets; ++_bkt_i) { \ + unsigned _bkt_count = 0; \ + _thh = (head)->hh.tbl->buckets[_bkt_i].hh_head; \ + _prev = NULL; \ + while (_thh) { \ + if (_prev != (char*)(_thh->hh_prev)) { \ + HASH_OOPS("%s: invalid hh_prev %p, actual %p\n", \ + (where), (void*)_thh->hh_prev, (void*)_prev); \ + } \ + _bkt_count++; \ + _prev = (char*)(_thh); \ + _thh = _thh->hh_next; \ + } \ + _count += _bkt_count; \ + if ((head)->hh.tbl->buckets[_bkt_i].count != _bkt_count) { \ + HASH_OOPS("%s: invalid bucket count %u, actual %u\n", \ + (where), (head)->hh.tbl->buckets[_bkt_i].count, _bkt_count); \ + } \ + } \ + if (_count != (head)->hh.tbl->num_items) { \ + HASH_OOPS("%s: invalid hh item count %u, actual %u\n", \ + (where), (head)->hh.tbl->num_items, _count); \ + } \ + _count = 0; \ + _prev = NULL; \ + _thh = &(head)->hh; \ + while (_thh) { \ + _count++; \ + if (_prev != (char*)_thh->prev) { \ + HASH_OOPS("%s: invalid prev %p, actual %p\n", \ + (where), (void*)_thh->prev, (void*)_prev); \ + } \ + _prev = (char*)ELMT_FROM_HH((head)->hh.tbl, _thh); \ + _thh = (_thh->next ? HH_FROM_ELMT((head)->hh.tbl, _thh->next) : NULL); \ + } \ + if (_count != (head)->hh.tbl->num_items) { \ + HASH_OOPS("%s: invalid app item count %u, actual %u\n", \ + (where), (head)->hh.tbl->num_items, _count); \ + } \ + } \ +} while (0) +#else +#define HASH_FSCK(hh,head,where) +#endif + +/* When compiled with -DHASH_EMIT_KEYS, length-prefixed keys are emitted to + * the descriptor to which this macro is defined for tuning the hash function. + * The app can #include to get the prototype for write(2). */ +#ifdef HASH_EMIT_KEYS +#define HASH_EMIT_KEY(hh,head,keyptr,fieldlen) \ +do { \ + unsigned _klen = fieldlen; \ + write(HASH_EMIT_KEYS, &_klen, sizeof(_klen)); \ + write(HASH_EMIT_KEYS, keyptr, (unsigned long)fieldlen); \ +} while (0) +#else +#define HASH_EMIT_KEY(hh,head,keyptr,fieldlen) +#endif + +/* The Bernstein hash function, used in Perl prior to v5.6. Note (x<<5+x)=x*33. */ +#define HASH_BER(key,keylen,hashv) \ +do { \ + unsigned _hb_keylen = (unsigned)keylen; \ + const unsigned char *_hb_key = (const unsigned char*)(key); \ + (hashv) = 0; \ + while (_hb_keylen-- != 0U) { \ + (hashv) = (((hashv) << 5) + (hashv)) + *_hb_key++; \ + } \ +} while (0) + + +/* SAX/FNV/OAT/JEN hash functions are macro variants of those listed at + * http://eternallyconfuzzled.com/tuts/algorithms/jsw_tut_hashing.aspx + * (archive link: https://archive.is/Ivcan ) + */ +#define HASH_SAX(key,keylen,hashv) \ +do { \ + unsigned _sx_i; \ + const unsigned char *_hs_key = (const unsigned char*)(key); \ + hashv = 0; \ + for (_sx_i=0; _sx_i < keylen; _sx_i++) { \ + hashv ^= (hashv << 5) + (hashv >> 2) + _hs_key[_sx_i]; \ + } \ +} while (0) +/* FNV-1a variation */ +#define HASH_FNV(key,keylen,hashv) \ +do { \ + unsigned _fn_i; \ + const unsigned char *_hf_key = (const unsigned char*)(key); \ + (hashv) = 2166136261U; \ + for (_fn_i=0; _fn_i < keylen; _fn_i++) { \ + hashv = hashv ^ _hf_key[_fn_i]; \ + hashv = hashv * 16777619U; \ + } \ +} while (0) + +#define HASH_OAT(key,keylen,hashv) \ +do { \ + unsigned _ho_i; \ + const unsigned char *_ho_key=(const unsigned char*)(key); \ + hashv = 0; \ + for(_ho_i=0; _ho_i < keylen; _ho_i++) { \ + hashv += _ho_key[_ho_i]; \ + hashv += (hashv << 10); \ + hashv ^= (hashv >> 6); \ + } \ + hashv += (hashv << 3); \ + hashv ^= (hashv >> 11); \ + hashv += (hashv << 15); \ +} while (0) + +#define HASH_JEN_MIX(a,b,c) \ +do { \ + a -= b; a -= c; a ^= ( c >> 13 ); \ + b -= c; b -= a; b ^= ( a << 8 ); \ + c -= a; c -= b; c ^= ( b >> 13 ); \ + a -= b; a -= c; a ^= ( c >> 12 ); \ + b -= c; b -= a; b ^= ( a << 16 ); \ + c -= a; c -= b; c ^= ( b >> 5 ); \ + a -= b; a -= c; a ^= ( c >> 3 ); \ + b -= c; b -= a; b ^= ( a << 10 ); \ + c -= a; c -= b; c ^= ( b >> 15 ); \ +} while (0) + +#define HASH_JEN(key,keylen,hashv) \ +do { \ + unsigned _hj_i,_hj_j,_hj_k; \ + unsigned const char *_hj_key=(unsigned const char*)(key); \ + hashv = 0xfeedbeefu; \ + _hj_i = _hj_j = 0x9e3779b9u; \ + _hj_k = (unsigned)(keylen); \ + while (_hj_k >= 12U) { \ + _hj_i += (_hj_key[0] + ( (unsigned)_hj_key[1] << 8 ) \ + + ( (unsigned)_hj_key[2] << 16 ) \ + + ( (unsigned)_hj_key[3] << 24 ) ); \ + _hj_j += (_hj_key[4] + ( (unsigned)_hj_key[5] << 8 ) \ + + ( (unsigned)_hj_key[6] << 16 ) \ + + ( (unsigned)_hj_key[7] << 24 ) ); \ + hashv += (_hj_key[8] + ( (unsigned)_hj_key[9] << 8 ) \ + + ( (unsigned)_hj_key[10] << 16 ) \ + + ( (unsigned)_hj_key[11] << 24 ) ); \ + \ + HASH_JEN_MIX(_hj_i, _hj_j, hashv); \ + \ + _hj_key += 12; \ + _hj_k -= 12U; \ + } \ + hashv += (unsigned)(keylen); \ + switch ( _hj_k ) { \ + case 11: hashv += ( (unsigned)_hj_key[10] << 24 ); /* FALLTHROUGH */ \ + case 10: hashv += ( (unsigned)_hj_key[9] << 16 ); /* FALLTHROUGH */ \ + case 9: hashv += ( (unsigned)_hj_key[8] << 8 ); /* FALLTHROUGH */ \ + case 8: _hj_j += ( (unsigned)_hj_key[7] << 24 ); /* FALLTHROUGH */ \ + case 7: _hj_j += ( (unsigned)_hj_key[6] << 16 ); /* FALLTHROUGH */ \ + case 6: _hj_j += ( (unsigned)_hj_key[5] << 8 ); /* FALLTHROUGH */ \ + case 5: _hj_j += _hj_key[4]; /* FALLTHROUGH */ \ + case 4: _hj_i += ( (unsigned)_hj_key[3] << 24 ); /* FALLTHROUGH */ \ + case 3: _hj_i += ( (unsigned)_hj_key[2] << 16 ); /* FALLTHROUGH */ \ + case 2: _hj_i += ( (unsigned)_hj_key[1] << 8 ); /* FALLTHROUGH */ \ + case 1: _hj_i += _hj_key[0]; /* FALLTHROUGH */ \ + default: ; \ + } \ + HASH_JEN_MIX(_hj_i, _hj_j, hashv); \ +} while (0) + +/* The Paul Hsieh hash function */ +#undef get16bits +#if (defined(__GNUC__) && defined(__i386__)) || defined(__WATCOMC__) \ + || defined(_MSC_VER) || defined (__BORLANDC__) || defined (__TURBOC__) +#define get16bits(d) (*((const uint16_t *) (d))) +#endif + +#if !defined (get16bits) +#define get16bits(d) ((((uint32_t)(((const uint8_t *)(d))[1])) << 8) \ + +(uint32_t)(((const uint8_t *)(d))[0]) ) +#endif +#define HASH_SFH(key,keylen,hashv) \ +do { \ + unsigned const char *_sfh_key=(unsigned const char*)(key); \ + uint32_t _sfh_tmp, _sfh_len = (uint32_t)keylen; \ + \ + unsigned _sfh_rem = _sfh_len & 3U; \ + _sfh_len >>= 2; \ + hashv = 0xcafebabeu; \ + \ + /* Main loop */ \ + for (;_sfh_len > 0U; _sfh_len--) { \ + hashv += get16bits (_sfh_key); \ + _sfh_tmp = ((uint32_t)(get16bits (_sfh_key+2)) << 11) ^ hashv; \ + hashv = (hashv << 16) ^ _sfh_tmp; \ + _sfh_key += 2U*sizeof (uint16_t); \ + hashv += hashv >> 11; \ + } \ + \ + /* Handle end cases */ \ + switch (_sfh_rem) { \ + case 3: hashv += get16bits (_sfh_key); \ + hashv ^= hashv << 16; \ + hashv ^= (uint32_t)(_sfh_key[sizeof (uint16_t)]) << 18; \ + hashv += hashv >> 11; \ + break; \ + case 2: hashv += get16bits (_sfh_key); \ + hashv ^= hashv << 11; \ + hashv += hashv >> 17; \ + break; \ + case 1: hashv += *_sfh_key; \ + hashv ^= hashv << 10; \ + hashv += hashv >> 1; \ + break; \ + default: ; \ + } \ + \ + /* Force "avalanching" of final 127 bits */ \ + hashv ^= hashv << 3; \ + hashv += hashv >> 5; \ + hashv ^= hashv << 4; \ + hashv += hashv >> 17; \ + hashv ^= hashv << 25; \ + hashv += hashv >> 6; \ +} while (0) + +/* iterate over items in a known bucket to find desired item */ +#define HASH_FIND_IN_BKT(tbl,hh,head,keyptr,keylen_in,hashval,out) \ +do { \ + if ((head).hh_head != NULL) { \ + DECLTYPE_ASSIGN(out, ELMT_FROM_HH(tbl, (head).hh_head)); \ + } else { \ + (out) = NULL; \ + } \ + while ((out) != NULL) { \ + if ((out)->hh.hashv == (hashval) && (out)->hh.keylen == (keylen_in)) { \ + if (HASH_KEYCMP((out)->hh.key, keyptr, keylen_in) == 0) { \ + break; \ + } \ + } \ + if ((out)->hh.hh_next != NULL) { \ + DECLTYPE_ASSIGN(out, ELMT_FROM_HH(tbl, (out)->hh.hh_next)); \ + } else { \ + (out) = NULL; \ + } \ + } \ +} while (0) + +/* add an item to a bucket */ +#define HASH_ADD_TO_BKT(head,hh,addhh,oomed) \ +do { \ + UT_hash_bucket *_ha_head = &(head); \ + _ha_head->count++; \ + (addhh)->hh_next = _ha_head->hh_head; \ + (addhh)->hh_prev = NULL; \ + if (_ha_head->hh_head != NULL) { \ + _ha_head->hh_head->hh_prev = (addhh); \ + } \ + _ha_head->hh_head = (addhh); \ + if ((_ha_head->count >= ((_ha_head->expand_mult + 1U) * HASH_BKT_CAPACITY_THRESH)) \ + && !(addhh)->tbl->noexpand) { \ + HASH_EXPAND_BUCKETS(addhh,(addhh)->tbl, oomed); \ + IF_HASH_NONFATAL_OOM( \ + if (oomed) { \ + HASH_DEL_IN_BKT(head,addhh); \ + } \ + ) \ + } \ +} while (0) + +/* remove an item from a given bucket */ +#define HASH_DEL_IN_BKT(head,delhh) \ +do { \ + UT_hash_bucket *_hd_head = &(head); \ + _hd_head->count--; \ + if (_hd_head->hh_head == (delhh)) { \ + _hd_head->hh_head = (delhh)->hh_next; \ + } \ + if ((delhh)->hh_prev) { \ + (delhh)->hh_prev->hh_next = (delhh)->hh_next; \ + } \ + if ((delhh)->hh_next) { \ + (delhh)->hh_next->hh_prev = (delhh)->hh_prev; \ + } \ +} while (0) + +/* Bucket expansion has the effect of doubling the number of buckets + * and redistributing the items into the new buckets. Ideally the + * items will distribute more or less evenly into the new buckets + * (the extent to which this is true is a measure of the quality of + * the hash function as it applies to the key domain). + * + * With the items distributed into more buckets, the chain length + * (item count) in each bucket is reduced. Thus by expanding buckets + * the hash keeps a bound on the chain length. This bounded chain + * length is the essence of how a hash provides constant time lookup. + * + * The calculation of tbl->ideal_chain_maxlen below deserves some + * explanation. First, keep in mind that we're calculating the ideal + * maximum chain length based on the *new* (doubled) bucket count. + * In fractions this is just n/b (n=number of items,b=new num buckets). + * Since the ideal chain length is an integer, we want to calculate + * ceil(n/b). We don't depend on floating point arithmetic in this + * hash, so to calculate ceil(n/b) with integers we could write + * + * ceil(n/b) = (n/b) + ((n%b)?1:0) + * + * and in fact a previous version of this hash did just that. + * But now we have improved things a bit by recognizing that b is + * always a power of two. We keep its base 2 log handy (call it lb), + * so now we can write this with a bit shift and logical AND: + * + * ceil(n/b) = (n>>lb) + ( (n & (b-1)) ? 1:0) + * + */ +#define HASH_EXPAND_BUCKETS(hh,tbl,oomed) \ +do { \ + unsigned _he_bkt; \ + unsigned _he_bkt_i; \ + struct UT_hash_handle *_he_thh, *_he_hh_nxt; \ + UT_hash_bucket *_he_new_buckets, *_he_newbkt; \ + _he_new_buckets = (UT_hash_bucket*)uthash_malloc( \ + sizeof(struct UT_hash_bucket) * (tbl)->num_buckets * 2U); \ + if (!_he_new_buckets) { \ + HASH_RECORD_OOM(oomed); \ + } else { \ + uthash_bzero(_he_new_buckets, \ + sizeof(struct UT_hash_bucket) * (tbl)->num_buckets * 2U); \ + (tbl)->ideal_chain_maxlen = \ + ((tbl)->num_items >> ((tbl)->log2_num_buckets+1U)) + \ + ((((tbl)->num_items & (((tbl)->num_buckets*2U)-1U)) != 0U) ? 1U : 0U); \ + (tbl)->nonideal_items = 0; \ + for (_he_bkt_i = 0; _he_bkt_i < (tbl)->num_buckets; _he_bkt_i++) { \ + _he_thh = (tbl)->buckets[ _he_bkt_i ].hh_head; \ + while (_he_thh != NULL) { \ + _he_hh_nxt = _he_thh->hh_next; \ + HASH_TO_BKT(_he_thh->hashv, (tbl)->num_buckets * 2U, _he_bkt); \ + _he_newbkt = &(_he_new_buckets[_he_bkt]); \ + if (++(_he_newbkt->count) > (tbl)->ideal_chain_maxlen) { \ + (tbl)->nonideal_items++; \ + if (_he_newbkt->count > _he_newbkt->expand_mult * (tbl)->ideal_chain_maxlen) { \ + _he_newbkt->expand_mult++; \ + } \ + } \ + _he_thh->hh_prev = NULL; \ + _he_thh->hh_next = _he_newbkt->hh_head; \ + if (_he_newbkt->hh_head != NULL) { \ + _he_newbkt->hh_head->hh_prev = _he_thh; \ + } \ + _he_newbkt->hh_head = _he_thh; \ + _he_thh = _he_hh_nxt; \ + } \ + } \ + uthash_free((tbl)->buckets, (tbl)->num_buckets * sizeof(struct UT_hash_bucket)); \ + (tbl)->num_buckets *= 2U; \ + (tbl)->log2_num_buckets++; \ + (tbl)->buckets = _he_new_buckets; \ + (tbl)->ineff_expands = ((tbl)->nonideal_items > ((tbl)->num_items >> 1)) ? \ + ((tbl)->ineff_expands+1U) : 0U; \ + if ((tbl)->ineff_expands > 1U) { \ + (tbl)->noexpand = 1; \ + uthash_noexpand_fyi(tbl); \ + } \ + uthash_expand_fyi(tbl); \ + } \ +} while (0) + + +/* This is an adaptation of Simon Tatham's O(n log(n)) mergesort */ +/* Note that HASH_SORT assumes the hash handle name to be hh. + * HASH_SRT was added to allow the hash handle name to be passed in. */ +#define HASH_SORT(head,cmpfcn) HASH_SRT(hh,head,cmpfcn) +#define HASH_SRT(hh,head,cmpfcn) \ +do { \ + unsigned _hs_i; \ + unsigned _hs_looping,_hs_nmerges,_hs_insize,_hs_psize,_hs_qsize; \ + struct UT_hash_handle *_hs_p, *_hs_q, *_hs_e, *_hs_list, *_hs_tail; \ + if (head != NULL) { \ + _hs_insize = 1; \ + _hs_looping = 1; \ + _hs_list = &((head)->hh); \ + while (_hs_looping != 0U) { \ + _hs_p = _hs_list; \ + _hs_list = NULL; \ + _hs_tail = NULL; \ + _hs_nmerges = 0; \ + while (_hs_p != NULL) { \ + _hs_nmerges++; \ + _hs_q = _hs_p; \ + _hs_psize = 0; \ + for (_hs_i = 0; _hs_i < _hs_insize; ++_hs_i) { \ + _hs_psize++; \ + _hs_q = ((_hs_q->next != NULL) ? \ + HH_FROM_ELMT((head)->hh.tbl, _hs_q->next) : NULL); \ + if (_hs_q == NULL) { \ + break; \ + } \ + } \ + _hs_qsize = _hs_insize; \ + while ((_hs_psize != 0U) || ((_hs_qsize != 0U) && (_hs_q != NULL))) { \ + if (_hs_psize == 0U) { \ + _hs_e = _hs_q; \ + _hs_q = ((_hs_q->next != NULL) ? \ + HH_FROM_ELMT((head)->hh.tbl, _hs_q->next) : NULL); \ + _hs_qsize--; \ + } else if ((_hs_qsize == 0U) || (_hs_q == NULL)) { \ + _hs_e = _hs_p; \ + if (_hs_p != NULL) { \ + _hs_p = ((_hs_p->next != NULL) ? \ + HH_FROM_ELMT((head)->hh.tbl, _hs_p->next) : NULL); \ + } \ + _hs_psize--; \ + } else if ((cmpfcn( \ + DECLTYPE(head)(ELMT_FROM_HH((head)->hh.tbl, _hs_p)), \ + DECLTYPE(head)(ELMT_FROM_HH((head)->hh.tbl, _hs_q)) \ + )) <= 0) { \ + _hs_e = _hs_p; \ + if (_hs_p != NULL) { \ + _hs_p = ((_hs_p->next != NULL) ? \ + HH_FROM_ELMT((head)->hh.tbl, _hs_p->next) : NULL); \ + } \ + _hs_psize--; \ + } else { \ + _hs_e = _hs_q; \ + _hs_q = ((_hs_q->next != NULL) ? \ + HH_FROM_ELMT((head)->hh.tbl, _hs_q->next) : NULL); \ + _hs_qsize--; \ + } \ + if ( _hs_tail != NULL ) { \ + _hs_tail->next = ((_hs_e != NULL) ? \ + ELMT_FROM_HH((head)->hh.tbl, _hs_e) : NULL); \ + } else { \ + _hs_list = _hs_e; \ + } \ + if (_hs_e != NULL) { \ + _hs_e->prev = ((_hs_tail != NULL) ? \ + ELMT_FROM_HH((head)->hh.tbl, _hs_tail) : NULL); \ + } \ + _hs_tail = _hs_e; \ + } \ + _hs_p = _hs_q; \ + } \ + if (_hs_tail != NULL) { \ + _hs_tail->next = NULL; \ + } \ + if (_hs_nmerges <= 1U) { \ + _hs_looping = 0; \ + (head)->hh.tbl->tail = _hs_tail; \ + DECLTYPE_ASSIGN(head, ELMT_FROM_HH((head)->hh.tbl, _hs_list)); \ + } \ + _hs_insize *= 2U; \ + } \ + HASH_FSCK(hh, head, "HASH_SRT"); \ + } \ +} while (0) + +/* This function selects items from one hash into another hash. + * The end result is that the selected items have dual presence + * in both hashes. There is no copy of the items made; rather + * they are added into the new hash through a secondary hash + * hash handle that must be present in the structure. */ +#define HASH_SELECT(hh_dst, dst, hh_src, src, cond) \ +do { \ + unsigned _src_bkt, _dst_bkt; \ + void *_last_elt = NULL, *_elt; \ + UT_hash_handle *_src_hh, *_dst_hh, *_last_elt_hh=NULL; \ + ptrdiff_t _dst_hho = ((char*)(&(dst)->hh_dst) - (char*)(dst)); \ + if ((src) != NULL) { \ + for (_src_bkt=0; _src_bkt < (src)->hh_src.tbl->num_buckets; _src_bkt++) { \ + for (_src_hh = (src)->hh_src.tbl->buckets[_src_bkt].hh_head; \ + _src_hh != NULL; \ + _src_hh = _src_hh->hh_next) { \ + _elt = ELMT_FROM_HH((src)->hh_src.tbl, _src_hh); \ + if (cond(_elt)) { \ + IF_HASH_NONFATAL_OOM( int _hs_oomed = 0; ) \ + _dst_hh = (UT_hash_handle*)(void*)(((char*)_elt) + _dst_hho); \ + _dst_hh->key = _src_hh->key; \ + _dst_hh->keylen = _src_hh->keylen; \ + _dst_hh->hashv = _src_hh->hashv; \ + _dst_hh->prev = _last_elt; \ + _dst_hh->next = NULL; \ + if (_last_elt_hh != NULL) { \ + _last_elt_hh->next = _elt; \ + } \ + if ((dst) == NULL) { \ + DECLTYPE_ASSIGN(dst, _elt); \ + HASH_MAKE_TABLE(hh_dst, dst, _hs_oomed); \ + IF_HASH_NONFATAL_OOM( \ + if (_hs_oomed) { \ + uthash_nonfatal_oom(_elt); \ + (dst) = NULL; \ + continue; \ + } \ + ) \ + } else { \ + _dst_hh->tbl = (dst)->hh_dst.tbl; \ + } \ + HASH_TO_BKT(_dst_hh->hashv, _dst_hh->tbl->num_buckets, _dst_bkt); \ + HASH_ADD_TO_BKT(_dst_hh->tbl->buckets[_dst_bkt], hh_dst, _dst_hh, _hs_oomed); \ + (dst)->hh_dst.tbl->num_items++; \ + IF_HASH_NONFATAL_OOM( \ + if (_hs_oomed) { \ + HASH_ROLLBACK_BKT(hh_dst, dst, _dst_hh); \ + HASH_DELETE_HH(hh_dst, dst, _dst_hh); \ + _dst_hh->tbl = NULL; \ + uthash_nonfatal_oom(_elt); \ + continue; \ + } \ + ) \ + HASH_BLOOM_ADD(_dst_hh->tbl, _dst_hh->hashv); \ + _last_elt = _elt; \ + _last_elt_hh = _dst_hh; \ + } \ + } \ + } \ + } \ + HASH_FSCK(hh_dst, dst, "HASH_SELECT"); \ +} while (0) + +#define HASH_CLEAR(hh,head) \ +do { \ + if ((head) != NULL) { \ + HASH_BLOOM_FREE((head)->hh.tbl); \ + uthash_free((head)->hh.tbl->buckets, \ + (head)->hh.tbl->num_buckets*sizeof(struct UT_hash_bucket)); \ + uthash_free((head)->hh.tbl, sizeof(UT_hash_table)); \ + (head) = NULL; \ + } \ +} while (0) + +#define HASH_OVERHEAD(hh,head) \ + (((head) != NULL) ? ( \ + (size_t)(((head)->hh.tbl->num_items * sizeof(UT_hash_handle)) + \ + ((head)->hh.tbl->num_buckets * sizeof(UT_hash_bucket)) + \ + sizeof(UT_hash_table) + \ + (HASH_BLOOM_BYTELEN))) : 0U) + +#ifdef NO_DECLTYPE +#define HASH_ITER(hh,head,el,tmp) \ +for(((el)=(head)), ((*(char**)(&(tmp)))=(char*)((head!=NULL)?(head)->hh.next:NULL)); \ + (el) != NULL; ((el)=(tmp)), ((*(char**)(&(tmp)))=(char*)((tmp!=NULL)?(tmp)->hh.next:NULL))) +#else +#define HASH_ITER(hh,head,el,tmp) \ +for(((el)=(head)), ((tmp)=DECLTYPE(el)((head!=NULL)?(head)->hh.next:NULL)); \ + (el) != NULL; ((el)=(tmp)), ((tmp)=DECLTYPE(el)((tmp!=NULL)?(tmp)->hh.next:NULL))) +#endif + +/* obtain a count of items in the hash */ +#define HASH_COUNT(head) HASH_CNT(hh,head) +#define HASH_CNT(hh,head) ((head != NULL)?((head)->hh.tbl->num_items):0U) + +typedef struct UT_hash_bucket { + struct UT_hash_handle *hh_head; + unsigned count; + + /* expand_mult is normally set to 0. In this situation, the max chain length + * threshold is enforced at its default value, HASH_BKT_CAPACITY_THRESH. (If + * the bucket's chain exceeds this length, bucket expansion is triggered). + * However, setting expand_mult to a non-zero value delays bucket expansion + * (that would be triggered by additions to this particular bucket) + * until its chain length reaches a *multiple* of HASH_BKT_CAPACITY_THRESH. + * (The multiplier is simply expand_mult+1). The whole idea of this + * multiplier is to reduce bucket expansions, since they are expensive, in + * situations where we know that a particular bucket tends to be overused. + * It is better to let its chain length grow to a longer yet-still-bounded + * value, than to do an O(n) bucket expansion too often. + */ + unsigned expand_mult; + +} UT_hash_bucket; + +/* random signature used only to find hash tables in external analysis */ +#define HASH_SIGNATURE 0xa0111fe1u +#define HASH_BLOOM_SIGNATURE 0xb12220f2u + +typedef struct UT_hash_table { + UT_hash_bucket *buckets; + unsigned num_buckets, log2_num_buckets; + unsigned num_items; + struct UT_hash_handle *tail; /* tail hh in app order, for fast append */ + ptrdiff_t hho; /* hash handle offset (byte pos of hash handle in element */ + + /* in an ideal situation (all buckets used equally), no bucket would have + * more than ceil(#items/#buckets) items. that's the ideal chain length. */ + unsigned ideal_chain_maxlen; + + /* nonideal_items is the number of items in the hash whose chain position + * exceeds the ideal chain maxlen. these items pay the penalty for an uneven + * hash distribution; reaching them in a chain traversal takes >ideal steps */ + unsigned nonideal_items; + + /* ineffective expands occur when a bucket doubling was performed, but + * afterward, more than half the items in the hash had nonideal chain + * positions. If this happens on two consecutive expansions we inhibit any + * further expansion, as it's not helping; this happens when the hash + * function isn't a good fit for the key domain. When expansion is inhibited + * the hash will still work, albeit no longer in constant time. */ + unsigned ineff_expands, noexpand; + + uint32_t signature; /* used only to find hash tables in external analysis */ +#ifdef HASH_BLOOM + uint32_t bloom_sig; /* used only to test bloom exists in external analysis */ + uint8_t *bloom_bv; + uint8_t bloom_nbits; +#endif + +} UT_hash_table; + +typedef struct UT_hash_handle { + struct UT_hash_table *tbl; + void *prev; /* prev element in app order */ + void *next; /* next element in app order */ + struct UT_hash_handle *hh_prev; /* previous hh in bucket order */ + struct UT_hash_handle *hh_next; /* next hh in bucket order */ + const void *key; /* ptr to enclosing struct's key */ + unsigned keylen; /* enclosing struct's key len */ + unsigned hashv; /* result of hash-fcn(key) */ +} UT_hash_handle; + +#endif /* UTHASH_H */ diff --git a/tests/test-client.cpp b/tests/test-client.cpp index 6ac562b..fe9064f 100644 --- a/tests/test-client.cpp +++ b/tests/test-client.cpp @@ -1,5 +1,5 @@ /* - * (C) 2020 The University of Chicago + * (C) 2024 The University of Chicago * * See COPYRIGHT in top-level directory. */