Add list membership API and uint64 hash utilities (#1103)

Author: bretambrose

include/aws/common/hash_table.h

@@ -434,6 +434,16 @@ bool aws_hash_table_is_valid(const struct aws_hash_table *map);
 AWS_COMMON_API
 bool aws_hash_iter_is_valid(const struct aws_hash_iter *iter);
 
+/**
+ * Helper function to hash keys that are uint64_t values.
+ */
+AWS_COMMON_API uint64_t aws_hash_uint64_t(const void *item);
+
+/**
+ * Helper function to compare hash keys that are uint64_t values.
+ */
+AWS_COMMON_API bool aws_hash_compare_uint64_t_eq(const void *a, const void *b);
+
 AWS_EXTERN_C_END
 AWS_POP_SANE_WARNING_LEVEL
 

include/aws/common/linked_list.h

@@ -182,6 +182,11 @@ AWS_STATIC_IMPL void aws_linked_list_move_all_front(
     struct aws_linked_list *AWS_RESTRICT dst,
     struct aws_linked_list *AWS_RESTRICT src);
 
+/**
+ * Returns true if the node is currently in a list, false otherwise.
+ */
+AWS_STATIC_IMPL bool aws_linked_list_node_is_in_list(struct aws_linked_list_node *node);
+
 #ifndef AWS_NO_STATIC_IMPL
 #    include <aws/common/linked_list.inl>
 #endif /* AWS_NO_STATIC_IMPL */

include/aws/common/linked_list.inl

@@ -431,6 +431,10 @@ AWS_STATIC_IMPL void aws_linked_list_move_all_front(
     AWS_POSTCONDITION(aws_linked_list_is_valid(dst));
 }
 
+AWS_STATIC_IMPL bool aws_linked_list_node_is_in_list(struct aws_linked_list_node *node) {
+    return aws_linked_list_node_prev_is_valid(node) && aws_linked_list_node_next_is_valid(node);
+}
+
 AWS_EXTERN_C_END
 
 #endif /* AWS_COMMON_LINKED_LIST_INL */

source/hash_table.c

@@ -1104,3 +1104,11 @@ int hash_table_state_required_bytes(size_t size, size_t *required_bytes) {
 
     return AWS_OP_SUCCESS;
 }
+
+uint64_t aws_hash_uint64_t(const void *item) {
+    return *(uint64_t *)item;
+}
+
+bool aws_hash_compare_uint64_t_eq(const void *a, const void *b) {
+    return *(uint64_t *)a == *(uint64_t *)b;
+}

tests/CMakeLists.txt

@@ -105,6 +105,7 @@ add_test_case(linked_list_reverse_iteration)
 add_test_case(linked_list_swap_contents)
 add_test_case(linked_list_move_all_back)
 add_test_case(linked_list_move_all_front)
+add_test_case(linked_list_node_in_list)
 
 add_test_case(hex_encoding_test_case_empty_test)
 add_test_case(hex_encoding_test_case_f_test)

tests/linked_list_test.c

@@ -518,3 +518,26 @@ AWS_TEST_CASE(linked_list_reverse_iteration, s_test_linked_list_reverse_iteratio
 AWS_TEST_CASE(linked_list_swap_contents, s_test_linked_list_swap_contents)
 AWS_TEST_CASE(linked_list_move_all_back, s_test_linked_list_move_all_back)
 AWS_TEST_CASE(linked_list_move_all_front, s_test_linked_list_move_all_front)
+
+static int s_linked_list_node_in_list_fn(struct aws_allocator *allocator, void *ctx) {
+    (void)allocator;
+    (void)ctx;
+
+    struct aws_linked_list list;
+    aws_linked_list_init(&list);
+
+    struct aws_linked_list_node node;
+    AWS_ZERO_STRUCT(node);
+
+    ASSERT_FALSE(aws_linked_list_node_is_in_list(&node));
+
+    aws_linked_list_push_back(&list, &node);
+    ASSERT_TRUE(aws_linked_list_node_is_in_list(&node));
+    aws_linked_list_remove(&node);
+
+    ASSERT_FALSE(aws_linked_list_node_is_in_list(&node));
+
+    return AWS_OP_SUCCESS;
+}
+
+AWS_TEST_CASE(linked_list_node_in_list, s_linked_list_node_in_list_fn)