jmap: new module

ccan/jmap/_info

+#include <stdio.h>
+#include <string.h>
+#include "config.h"
+
+/**
+ * jmap - map from indices to values (based on libJudy)
+ *
+ * This provides a convenient wrapper for using JudyL arrays; using
+ * integers or pointers as an index, Judy arrays provide an efficient
+ * map to integers or pointers.
+ *
+ * jmap.h simply contains wrappers for a size_t-indexed size_t values, and
+ * jmap_type.h contain a wrapper macro for size_t->pointer maps and pointer
+ * ->pointer maps.
+ *
+ * Example:
+ * // Silly example of associating data with arguments by pointer and int.
+ * #include <string.h>
+ * #include <stdio.h>
+ * #include <ccan/jmap/jmap_type.h>
+ * 
+ * struct opt_detail {
+ * 	bool is_long;
+ * 	unsigned int length; // == 1 if !is_long.
+ * };
+ * 
+ * // Define jmap_arg_<op> and jmap_arg, for int -> argv.
+ * JMAP_DEFINE_UINTIDX_TYPE(char, arg);
+ * // Define jmap_opt_<op> and jmap_opt, for argv -> struct opt_detail *.
+ * JMAP_DEFINE_PTRIDX_TYPE(char, struct opt_detail, opt);
+ * 
+ * int main(int argc, char *argv[])
+ * {
+ * 	int i;
+ * 	// This map is equivalent to the argv[] array.  Silly example.
+ * 	struct jmap_arg *arg = jmap_arg_new();
+ * 	struct jmap_opt *opt = jmap_opt_new();
+ * 	struct opt_detail *d;
+ * 
+ * 	// Note: this is not correct for real parsing!
+ * 	for (i = 0; i < argc; i++) {
+ * 		jmap_arg_add(arg, i, argv[i]);
+ * 		if (i < 1 || argv[i][0] != '-')
+ * 			continue;
+ * 		d = malloc(sizeof(*d));
+ * 		if (argv[i][1] == '-') {
+ * 			// --<stuff>
+ * 			d->is_long = true;
+ * 			d->length = strlen(argv[i]+2);
+ * 		} else {
+ * 			// -<opt1>
+ * 			d->is_long = false;
+ * 			d->length = 1;
+ * 		}
+ * 		jmap_opt_add(opt, argv[i], d);
+ * 	}
+ * 
+ * 	printf("Found %u options:\n", jmap_opt_count(opt));
+ * 	for (i = jmap_arg_first(arg,-1); i!=-1; i = jmap_arg_next(arg,i,-1)) {
+ * 		char *a = jmap_arg_get(arg, i);
+ * 		d = jmap_opt_get(opt, a);
+ * 		printf("  Arg %i ('%s') is a %s of %u chars\n",
+ * 		       i, a,
+ * 		       d == NULL ? "normal argument"
+ * 		       : d->is_long ? "long option"
+ * 		       : "short option",
+ * 		       d == NULL ? strlen(a) : d->length);
+ * 		// We no longer need it, so free it here.
+ * 		free(d);
+ * 	}
+ * 	jmap_opt_free(opt);
+ * 	jmap_arg_free(arg);
+ * 	return 0;
+ * }
+ * 
+ * License: LGPL (2 or any later version)
+ * Author: Rusty Russell <rusty@rustcorp.com.au>
+ */
+int main(int argc, char *argv[])
+{
+	if (argc != 2)
+		return 1;
+
+	if (strcmp(argv[1], "depends") == 0) {
+		printf("ccan/build_assert\n");
+		printf("ccan/compiler\n");
+		printf("Judy\n");
+		return 0;
+	}
+
+	if (strcmp(argv[1], "libs") == 0) {
+		printf("Judy\n");
+		return 0;
+	}
+
+	return 1;
+}

ccan/jmap/jmap.c

+#include <ccan/jmap/jmap.h>
+#include <ccan/build_assert/build_assert.h>
+#include <stdlib.h>
+#include <string.h>
+
+struct jmap *jmap_new(void)
+{
+	struct jmap *map;
+
+	/* Judy uses Word_t, we use size_t. */
+	BUILD_ASSERT(sizeof(size_t) == sizeof(Word_t));
+
+	map = malloc(sizeof(*map));
+	if (map) {
+		map->judy = NULL;
+		memset(&map->err, 0, sizeof(map->err));
+		map->errstr = NULL;
+		map->num_accesses = 0;
+		map->acc_value = NULL;
+		map->acc_index = 0;
+		map->funcname = NULL;
+	}
+	return map;
+}
+
+const char *jmap_error_(struct jmap *map)
+{
+	char *str;
+	free((char *)map->errstr);
+	map->errstr = str = malloc(100);
+	if (!map->errstr)
+		return "out of memory";
+
+	sprintf(str,
+		"JU_ERRNO_* == %d, ID == %d\n",
+		JU_ERRNO(&map->err), JU_ERRID(&map->err));
+	return str;
+}
+
+void jmap_free(const struct jmap *map)
+{
+	free((char *)map->errstr);
+	Judy1FreeArray((PPvoid_t)&map->judy, PJE0);
+	free((void *)map);
+}

ccan/jmap/test/run-access-count.c

+/* Test our access counting failures. */
+#include <ccan/jmap/jmap.c>
+#include <ccan/tap/tap.h>
+#include <sys/types.h>
+#include <sys/wait.h>
+#include <unistd.h>
+
+int main(int argc, char *argv[])
+{
+	struct jmap *map;
+	size_t *value;
+	int status;
+
+	plan_tests(9);
+
+	map = jmap_new();
+	ok1(jmap_error(map) == NULL);
+	ok1(jmap_add(map, 0, 1));
+
+	/* add while holding value. */
+	value = jmap_getval(map, 0);
+	ok1(value);
+	if (!fork()) {
+		jmap_add(map, 1, 2);
+		exit(0);
+	} else {
+		wait(&status);
+		ok1(WIFSIGNALED(status) && WTERMSIG(status) == SIGABRT);
+	}
+	jmap_putval(map, &value);
+
+	/* del while holding value. */
+	value = jmap_getval(map, 0);
+	ok1(value);
+	if (!fork()) {
+		jmap_del(map, 0);
+		exit(0);
+	} else {
+		wait(&status);
+		ok1(WIFSIGNALED(status) && WTERMSIG(status) == SIGABRT);
+	}
+	jmap_putval(map, &value);
+
+	ok1(jmap_add(map, 0, 1));
+
+	/* set while holding value ok. */
+	value = jmap_getval(map, 0);
+	ok1(value);
+	if (!fork()) {
+		jmap_set(map, 0, 2);
+		exit(0);
+	} else {
+		wait(&status);
+		ok1(WIFEXITED(status) && WEXITSTATUS(status) == 0);
+	}
+	jmap_putval(map, &value);
+
+	/* FIXME: test jmap_nthval, jmap_firstval etc. */
+	jmap_free(map);
+
+	return exit_status();
+}

ccan/jmap/test/run-ptridx-type.c

+#include <ccan/tap/tap.h>
+#include <ccan/jmap/jmap_type.h>
+#include <ccan/jmap/jmap.c>
+
+struct foo;
+struct idx;
+
+JMAP_DEFINE_PTRIDX_TYPE(struct idx, struct foo, foo);
+
+#define NUM 100
+
+static int cmp_ptr(const void *a, const void *b)
+{
+	return *(char **)a - *(char **)b;
+}
+
+int main(int argc, char *argv[])
+{
+	struct jmap_foo *map;
+	struct foo *foo[NUM], **foop;
+	struct idx *idx[NUM], *index;
+
+	unsigned int i;
+
+	plan_tests(25 + NUM*2 + 6);
+	for (i = 0; i < NUM; i++)
+		foo[i] = malloc(20);
+
+	qsort(foo, NUM, sizeof(foo[0]), cmp_ptr);
+
+	/* idx[i] == foo[i] + 1, for easy checking */
+	for (i = 0; i < NUM; i++)
+		idx[i] = (void *)((char *)foo[i] + 1);
+
+	map = jmap_foo_new();
+	ok1(jmap_foo_error(map) == NULL);
+
+	ok1(jmap_foo_test(map, idx[i]) == false);
+	ok1(jmap_foo_get(map, idx[i]) == (struct foo *)NULL);
+	ok1(jmap_foo_count(map) == 0);
+	ok1(jmap_foo_first(map) == (struct idx *)NULL);
+	ok1(jmap_foo_del(map, idx[0]) == false);
+
+	/* Set only works on existing cases. */
+	ok1(jmap_foo_set(map, idx[0], foo[0]) == false);
+	ok1(jmap_foo_add(map, idx[0], foo[1]) == true);
+	ok1(jmap_foo_get(map, idx[0]) == foo[1]);
+	ok1(jmap_foo_set(map, idx[0], foo[0]) == true);
+	ok1(jmap_foo_get(map, idx[0]) == foo[0]);
+
+	ok1(jmap_foo_test(map, idx[0]) == true);
+	ok1(jmap_foo_count(map) == 1);
+	ok1(jmap_foo_first(map) == idx[0]);
+	ok1(jmap_foo_next(map, idx[0]) == NULL);
+
+	ok1(jmap_foo_del(map, idx[0]) == true);
+	ok1(jmap_foo_test(map, idx[0]) == false);
+	ok1(jmap_foo_count(map) == 0);
+
+	for (i = 0; i < NUM; i++)
+		jmap_foo_add(map, idx[i], foo[i]);
+
+	ok1(jmap_foo_count(map) == NUM);
+
+	ok1(jmap_foo_first(map) == idx[0]);
+	ok1(jmap_foo_next(map, idx[0]) == idx[1]);
+	ok1(jmap_foo_next(map, idx[NUM-1]) == NULL);
+
+	ok1(jmap_foo_get(map, idx[0]) == foo[0]);
+	ok1(jmap_foo_get(map, idx[NUM-1]) == foo[NUM-1]);
+	ok1(jmap_foo_get(map, (void *)((char *)idx[NUM-1] + 1)) == NULL);
+
+	/* Reverse values in map. */
+	for (i = 0; i < NUM; i++) {
+		foop = jmap_foo_getval(map, idx[i]);
+		ok1(*foop == foo[i]);
+		*foop = foo[NUM-1-i];
+		jmap_foo_putval(map, &foop);
+	}
+	for (i = 0; i < NUM; i++)
+		ok1(jmap_foo_get(map, idx[i]) == foo[NUM-1-i]);
+
+	foop = jmap_foo_firstval(map, &index);
+	ok1(index == idx[0]);
+	ok1(*foop == foo[NUM-1]);
+	jmap_foo_putval(map, &foop);
+
+	foop = jmap_foo_nextval(map, &index);
+	ok1(index == idx[1]);
+	ok1(*foop == foo[NUM-2]);
+	jmap_foo_putval(map, &foop);
+
+	index = idx[NUM-1];
+	foop = jmap_foo_nextval(map, &index);
+	ok1(foop == NULL);
+
+	ok1(jmap_foo_error(map) == NULL);
+	jmap_foo_free(map);
+
+	return exit_status();
+}

ccan/jmap/test/run-uintidx-type.c

+#include <ccan/tap/tap.h>
+#include <ccan/jmap/jmap_type.h>
+#include <ccan/jmap/jmap.c>
+
+struct foo;
+
+JMAP_DEFINE_UINTIDX_TYPE(struct foo, foo);
+
+#define NUM 100
+
+int main(int argc, char *argv[])
+{
+	struct jmap_foo *map;
+	struct foo *foo[NUM], **foop;
+	unsigned int i;
+
+	plan_tests(37 + NUM*2 + 19);
+	for (i = 0; i < NUM; i++)
+		foo[i] = malloc(20);
+
+	map = jmap_foo_new();
+	ok1(jmap_foo_error(map) == NULL);
+
+	ok1(jmap_foo_test(map, 0) == false);
+	ok1(jmap_foo_get(map, 0) == (struct foo *)NULL);
+	ok1(jmap_foo_popcount(map, 0, -1) == 0);
+	ok1(jmap_foo_first(map, 0) == 0);
+	ok1(jmap_foo_last(map, 0) == 0);
+	ok1(jmap_foo_del(map, 0) == false);
+
+	/* Set only works on existing cases. */
+	ok1(jmap_foo_set(map, 0, foo[0]) == false);
+	ok1(jmap_foo_add(map, 0, foo[1]) == true);
+	ok1(jmap_foo_get(map, 0) == foo[1]);
+	ok1(jmap_foo_set(map, 0, foo[0]) == true);
+	ok1(jmap_foo_get(map, 0) == foo[0]);
+
+	ok1(jmap_foo_test(map, 0) == true);
+	ok1(jmap_foo_popcount(map, 0, -1) == 1);
+	ok1(jmap_foo_first(map, -1) == 0);
+	ok1(jmap_foo_last(map, -1) == 0);
+	ok1(jmap_foo_next(map, 0, -1) == (size_t)-1);
+	ok1(jmap_foo_prev(map, 0, -1) == (size_t)-1);
+
+	ok1(jmap_foo_del(map, 0) == true);
+	ok1(jmap_foo_test(map, 0) == false);
+	ok1(jmap_foo_popcount(map, 0, -1) == 0);
+
+	for (i = 0; i < NUM; i++)
+		jmap_foo_add(map, i, foo[i]);
+
+	ok1(jmap_foo_popcount(map, 0, -1) == NUM);
+	ok1(jmap_foo_popcount(map, 0, NUM-1) == NUM);
+	ok1(jmap_foo_popcount(map, 0, NUM/2-1) == NUM/2);
+	ok1(jmap_foo_popcount(map, NUM/2, NUM) == NUM - NUM/2);
+
+	ok1(jmap_foo_nth(map, 0, -1) == 0);
+	ok1(jmap_foo_nth(map, NUM-1, -1) == NUM-1);
+	ok1(jmap_foo_nth(map, NUM, -1) == (size_t)-1);
+	ok1(jmap_foo_first(map, -1) == 0);
+	ok1(jmap_foo_last(map, -1) == NUM-1);
+	ok1(jmap_foo_next(map, 0, -1) == 1);
+	ok1(jmap_foo_next(map, NUM-1, -1) == (size_t)-1);
+	ok1(jmap_foo_prev(map, 1, -1) == 0);
+	ok1(jmap_foo_prev(map, 0, -1) == (size_t)-1);
+
+	ok1(jmap_foo_get(map, 0) == foo[0]);
+	ok1(jmap_foo_get(map, NUM-1) == foo[NUM-1]);
+	ok1(jmap_foo_get(map, NUM) == NULL);
+
+	/* Reverse values in map. */
+	for (i = 0; i < NUM; i++) {
+		foop = jmap_foo_getval(map, i);
+		ok1(*foop == foo[i]);
+		*foop = foo[NUM-1-i];
+		jmap_foo_putval(map, &foop);
+	}
+	for (i = 0; i < NUM; i++)
+		ok1(jmap_foo_get(map, i) == foo[NUM-1-i]);
+
+	foop = jmap_foo_nthval(map, 0, &i);
+	ok1(i == 0);
+	ok1(*foop == foo[NUM-1]);
+	jmap_foo_putval(map, &foop);
+	foop = jmap_foo_nthval(map, NUM-1, &i);
+	ok1(i == NUM-1);
+	ok1(*foop == foo[0]);
+	jmap_foo_putval(map, &foop);
+
+	foop = jmap_foo_firstval(map, &i);
+	ok1(i == 0);
+	ok1(*foop == foo[NUM-1]);
+	jmap_foo_putval(map, &foop);
+
+	foop = jmap_foo_nextval(map, &i);
+	ok1(i == 1);
+	ok1(*foop == foo[NUM-2]);
+	jmap_foo_putval(map, &foop);
+
+	foop = jmap_foo_prevval(map, &i);
+	ok1(i == 0);
+	ok1(*foop == foo[NUM-1]);
+	jmap_foo_putval(map, &foop);
+
+	foop = jmap_foo_prevval(map, &i);
+	ok1(foop == NULL);
+
+	foop = jmap_foo_lastval(map, &i);
+	ok1(i == NUM-1);
+	ok1(*foop == foo[0]);
+	jmap_foo_putval(map, &foop);
+
+	foop = jmap_foo_prevval(map, &i);
+	ok1(i == NUM-2);
+	ok1(*foop == foo[1]);
+	jmap_foo_putval(map, &foop);
+
+	foop = jmap_foo_nextval(map, &i);
+	ok1(i == NUM-1);
+	ok1(*foop == foo[0]);
+	jmap_foo_putval(map, &foop);
+
+	foop = jmap_foo_nextval(map, &i);
+	ok1(foop == NULL);
+
+	ok1(jmap_foo_error(map) == NULL);
+	jmap_foo_free(map);
+
+	return exit_status();
+}

ccan/jmap/test/run.c

+#include <ccan/tap/tap.h>
+#define DEBUG
+#include <ccan/jmap/jmap.c>
+
+int main(int argc, char *argv[])
+{
+	struct jmap *map;
+	size_t i, *value;
+	const char *err;
+
+	plan_tests(53);
+
+	map = jmap_new();
+	ok1(jmap_error(map) == NULL);
+
+	ok1(jmap_test(map, 0) == false);
+	ok1(jmap_del(map, 0) == false);
+	ok1(jmap_add(map, 0, 1) == true);
+	ok1(jmap_test(map, 0) == true);
+	ok1(jmap_get(map, 0, -1) == 1);
+	ok1(jmap_get(map, 1, -1) == (size_t)-1);
+	ok1(jmap_del(map, 0) == true);
+
+	ok1(jmap_popcount(map, 0, -1) == 0);
+	ok1(jmap_nth(map, 0, 0) == 0);
+	ok1(jmap_nth(map, 0, -1) == (size_t)-1);
+	ok1(jmap_first(map, 0) == 0);
+	ok1(jmap_first(map, -1) == (size_t)-1);
+	ok1(jmap_last(map, 0) == 0);
+	ok1(jmap_last(map, -1) == (size_t)-1);
+
+	ok1(jmap_getval(map, 0) == NULL);
+
+	/* Map a million indices, 16 apart. */
+	for (i = 0; i < 1000000; i++)
+		jmap_add(map, i << 4, (i << 5) + 1);
+
+	/* This only take 6.3MB on my 32-bit system. */
+	diag("%u bytes memory used\n", (unsigned)JudyLMemUsed(map->judy));
+
+	ok1(jmap_get(map, 0, -1) == 1);
+	ok1(jmap_get(map, 999999 << 4, -1) == (999999 << 5) + 1);
+	ok1(jmap_popcount(map, 0, -1) == 1000000);
+	ok1(jmap_nth(map, 0, -1) == 0);
+	ok1(jmap_nth(map, 999999, -1) == 999999 << 4);
+	ok1(jmap_nth(map, 1000000, -1) == (size_t)-1);
+	ok1(jmap_first(map, -1) == 0);
+	ok1(jmap_last(map, -1) == 999999 << 4);
+	ok1(jmap_next(map, 0, -1) == 1 << 4);
+	ok1(jmap_next(map, 999999 << 4, -1) == (size_t)-1);
+	ok1(jmap_prev(map, 1, -1) == 0);
+	ok1(jmap_prev(map, 0, -1) == (size_t)-1);
+	ok1(jmap_error(map) == NULL);
+
+	/* Accessors. */
+	value = jmap_getval(map, 0);
+	ok1(value && *value == 1);
+	*value = 2;
+	ok1(jmap_get(map, 0, -1) == 2);
+	jmap_putval(map, &value);
+	ok1(jmap_get(map, 0, -1) == 2);
+	ok1(jmap_set(map, 0, 1));
+
+	value = jmap_getval(map, 999999 << 4);
+	ok1(value && *value == (999999 << 5) + 1);
+	jmap_putval(map, &value);
+
+	value = jmap_nthval(map, 0, &i);
+	ok1(i == 0);
+	ok1(value && *value == 1);
+	jmap_putval(map, &value);
+	value = jmap_nthval(map, 999999, &i);
+	ok1(i == 999999 << 4);
+	ok1(value && *value == (999999 << 5) + 1);
+	jmap_putval(map, &value);
+	ok1(jmap_nthval(map, 1000000, &i) == NULL);
+
+	value = jmap_firstval(map, &i);
+	ok1(i == 0);
+	ok1(value && *value == 1);
+	jmap_putval(map, &value);
+	ok1(jmap_prevval(map, &i) == NULL);
+
+	i = 0;
+	value = jmap_nextval(map, &i);
+	ok1(i == 1 << 4);
+	ok1(value && *value == (1 << 5) + 1);
+	jmap_putval(map, &value);
+
+	value = jmap_lastval(map, &i);
+	ok1(i == 999999 << 4);
+	ok1(value && *value == (999999 << 5) + 1);
+	jmap_putval(map, &value);
+	ok1(jmap_nextval(map, &i) == NULL);
+
+	i = 999999 << 4;
+	value = jmap_prevval(map, &i);
+	ok1(i == 999998 << 4);
+	ok1(value && *value == (999998 << 5) + 1);
+	jmap_putval(map, &value);
+
+	/* Test error handling */
+	JU_ERRNO(&map->err) = 100;
+	JU_ERRID(&map->err) = 991;
+	err = jmap_error(map);
+	ok1(err);
+	ok1(strstr(err, "100"));
+	ok1(strstr(err, "991"));
+	ok1(err == map->errstr);
+	jmap_free(map);
+
+	return exit_status();
+}