Basic 'handle' implementation and tests.

This abstraction covers the case where one part of the program needs
to refer to another object that is allowed to disappear.

4 files changed, 99 insertions, 1 deletions

diff --git a/src/test/include.am b/src/test/include.am
index 7d80fdf152..a3543ddbf4 100644
--- a/src/test/include.am
+++ b/src/test/include.am
@@ -86,6 +86,7 @@ src_test_test_SOURCES = \
 	src/test/test_guardfraction.c \
 	src/test/test_extorport.c \
 	src/test/test_hs.c \
+	src/test/test_handles.c \
 	src/test/test_introduce.c \
 	src/test/test_keypin.c \
 	src/test/test_link_handshake.c \
diff --git a/src/test/test.c b/src/test/test.c
index ed167a3e67..3519dcadb0 100644
--- a/src/test/test.c
+++ b/src/test/test.c
@@ -1177,6 +1177,7 @@ extern struct testcase_t util_tests[];
 extern struct testcase_t util_format_tests[];
 extern struct testcase_t util_process_tests[];
 extern struct testcase_t dns_tests[];
+extern struct testcase_t handle_tests[];
 
 struct testgroup_t testgroups[] = {
   { "", test_array },
@@ -1231,6 +1232,7 @@ struct testgroup_t testgroups[] = {
   { "util/logging/", logging_tests },
   { "util/process/", util_process_tests },
   { "util/thread/", thread_tests },
+  { "util/handle/", handle_tests },
   { "dns/", dns_tests },
   END_OF_GROUPS
 };
diff --git a/src/test/test.h b/src/test/test.h
index e618ce1224..153b7cae00 100644
--- a/src/test/test.h
+++ b/src/test/test.h
@@ -73,7 +73,7 @@
     {print_ = (I64_PRINTF_TYPE) value_;}, {}, TT_EXIT_TEST_FUNCTION)
 
 const char *get_fname(const char *name);
-crypto_pk_t *pk_generate(int idx);
+struct crypto_pk_t *pk_generate(int idx);
 
 #define US2_CONCAT_2__(a, b) a ## __ ## b
 #define US_CONCAT_2__(a, b) a ## _ ## b
diff --git a/src/test/test_handles.c b/src/test/test_handles.c
new file mode 100644
index 0000000000..8aaae13845
--- /dev/null
+++ b/src/test/test_handles.c
@@ -0,0 +1,95 @@
+/* Copyright (c) 2016, The Tor Project, Inc. */
+/* See LICENSE for licensing information */
+
+#include "orconfig.h"
+#include "test.h"
+
+#include "util.h"
+#include "handles.h"
+
+typedef struct demo_t {
+  HANDLE_ENTRY(demo, demo_t);
+  int val;
+} demo_t;
+
+HANDLE_DECL(demo, demo_t, static);
+HANDLE_IMPL(demo, demo_t, static);
+
+static demo_t *
+demo_new(int val)
+{
+  demo_t *d = tor_malloc_zero(sizeof(demo_t));
+  d->val = val;
+  return d;
+}
+
+static void
+demo_free(demo_t *d)
+{
+  if (d == NULL)
+    return;
+  demo_handles_clear(d);
+  tor_free(d);
+}
+
+static void
+test_handle_basic(void *arg)
+{
+  (void) arg;
+  demo_t *d1 = NULL, *d2 = NULL;
+  demo_handle_t *wr1 = NULL, *wr2 = NULL, *wr3 = NULL, *wr4 = NULL;
+
+  d1 = demo_new(9000);
+  d2 = demo_new(9009);
+
+  wr1 = demo_handle_new(d1);
+  wr2 = demo_handle_new(d1);
+  wr3 = demo_handle_new(d1);
+  wr4 = demo_handle_new(d2);
+
+  tt_assert(wr1);
+  tt_assert(wr2);
+  tt_assert(wr3);
+  tt_assert(wr4);
+
+  tt_ptr_op(demo_handle_get(wr1), OP_EQ, d1);
+  tt_ptr_op(demo_handle_get(wr2), OP_EQ, d1);
+  tt_ptr_op(demo_handle_get(wr3), OP_EQ, d1);
+  tt_ptr_op(demo_handle_get(wr4), OP_EQ, d2);
+
+  demo_handle_free(wr1);
+  wr1 = NULL;
+  tt_ptr_op(demo_handle_get(wr2), OP_EQ, d1);
+  tt_ptr_op(demo_handle_get(wr3), OP_EQ, d1);
+  tt_ptr_op(demo_handle_get(wr4), OP_EQ, d2);
+
+  demo_free(d1);
+  d1 = NULL;
+  tt_ptr_op(demo_handle_get(wr2), OP_EQ, NULL);
+  tt_ptr_op(demo_handle_get(wr3), OP_EQ, NULL);
+  tt_ptr_op(demo_handle_get(wr4), OP_EQ, d2);
+
+  demo_handle_free(wr2);
+  wr2 = NULL;
+  tt_ptr_op(demo_handle_get(wr3), OP_EQ, NULL);
+  tt_ptr_op(demo_handle_get(wr4), OP_EQ, d2);
+
+  demo_handle_free(wr3);
+  wr3 = NULL;
+ done:
+  demo_handle_free(wr1);
+  demo_handle_free(wr2);
+  demo_handle_free(wr3);
+  demo_handle_free(wr4);
+  demo_free(d1);
+  demo_free(d2);
+}
+
+#define HANDLE_TEST(name, flags)                       \
+  { #name, test_handle_ ##name, (flags), NULL, NULL }
+
+struct testcase_t handle_tests[] = {
+  HANDLE_TEST(basic, 0),
+  END_OF_TESTCASES
+};
+