/* Copyright 2003-2004 Roger Dingledine Copyright 2004-2005 Roger Dingledine, Nick Mathewson */ /* See LICENSE for licensing information */ /* $Id$ */ const char container_c_id[] = "$Id$"; /** * \file container.c * \brief Implements a smartlist (a resizable array) along * with helper functions to use smartlists. Also includes a * splay-tree implementation of the string-to-void* map. **/ #include "compat.h" #include "util.h" #include "log.h" #include "container.h" #include "crypto.h" #ifdef HAVE_CTYPE_H #include #endif #include #include #include #include "ht.h" /* All newly allocated smartlists have this capacity. */ #define SMARTLIST_DEFAULT_CAPACITY 32 /** Allocate and return an empty smartlist. */ smartlist_t * smartlist_create(void) { smartlist_t *sl = tor_malloc(sizeof(smartlist_t)); sl->num_used = 0; sl->capacity = SMARTLIST_DEFAULT_CAPACITY; sl->list = tor_malloc(sizeof(void *) * sl->capacity); return sl; } /** Deallocate a smartlist. Does not release storage associated with the * list's elements. */ void smartlist_free(smartlist_t *sl) { tor_free(sl->list); tor_free(sl); } /** Change the capacity of the smartlist to n, so that we can grow * the list up to n elements with no further reallocation or wasted * space. If n is less than or equal to the number of elements * currently in the list, reduce the list's capacity as much as * possible without losing elements. */ void smartlist_set_capacity(smartlist_t *sl, int n) { if (n < sl->num_used) n = sl->num_used; if (sl->capacity != n) { sl->capacity = n; sl->list = tor_realloc(sl->list, sizeof(void*)*sl->capacity); } } /** Remove all elements from the list. */ void smartlist_clear(smartlist_t *sl) { sl->num_used = 0; } /** Set the list's new length to len (which must be \<= the list's * current size). Remove the last smartlist_len(sl)-len elements from the * list. */ void smartlist_truncate(smartlist_t *sl, int len) { tor_assert(len <= sl->num_used); sl->num_used = len; } /** Append element to the end of the list. */ void smartlist_add(smartlist_t *sl, void *element) { if (sl->num_used >= sl->capacity) { int higher = sl->capacity * 2; tor_assert(higher > sl->capacity); /* detect overflow */ sl->capacity = higher; sl->list = tor_realloc(sl->list, sizeof(void*)*sl->capacity); } sl->list[sl->num_used++] = element; } /** Append each element from S2 to the end of S1. */ void smartlist_add_all(smartlist_t *sl, const smartlist_t *s2) { int n2 = sl->num_used + s2->num_used; if (n2 > sl->capacity) { int higher = sl->capacity * 2; while (n2 > higher) higher *= 2; sl->capacity = higher; sl->list = tor_realloc(sl->list, sizeof(void*)*sl->capacity); } memcpy(sl->list + sl->num_used, s2->list, s2->num_used*sizeof(void*)); sl->num_used += s2->num_used; } /** Remove all elements E from sl such that E==element. Preserve * the order of any elements before E, but elements after E can be * rearranged. */ void smartlist_remove(smartlist_t *sl, void *element) { int i; if (element == NULL) return; for (i=0; i < sl->num_used; i++) if (sl->list[i] == element) { sl->list[i] = sl->list[--sl->num_used]; /* swap with the end */ i--; /* so we process the new i'th element */ } } /** If there are any strings in sl equal to element, remove and free them. * Does not preserve order. */ void smartlist_string_remove(smartlist_t *sl, const char *element) { int i; tor_assert(sl); tor_assert(element); for (i = 0; i < sl->num_used; ++i) { if (!strcmp(element, sl->list[i])) { tor_free(sl->list[i]); sl->list[i] = sl->list[--sl->num_used]; /* swap with the end */ i--; /* so we process the new i'th element */ } } } /** Return true iff some element E of sl has E==element. */ int smartlist_isin(const smartlist_t *sl, void *element) { int i; for (i=0; i < sl->num_used; i++) if (sl->list[i] == element) return 1; return 0; } /** Return true iff sl has some element E such that * !strcmp(E,element) */ int smartlist_string_isin(const smartlist_t *sl, const char *element) { int i; if (!sl) return 0; for (i=0; i < sl->num_used; i++) if (strcmp((const char*)sl->list[i],element)==0) return 1; return 0; } /** Return true iff sl has some element E such that E is equal * to the decimal encoding of num. */ int smartlist_string_num_isin(const smartlist_t *sl, int num) { char buf[16]; tor_snprintf(buf,sizeof(buf),"%d", num); return smartlist_string_isin(sl, buf); } /** Return true iff some element E of sl2 has smartlist_isin(sl1,E). */ int smartlist_overlap(const smartlist_t *sl1, const smartlist_t *sl2) { int i; for (i=0; i < sl2->num_used; i++) if (smartlist_isin(sl1, sl2->list[i])) return 1; return 0; } /** Remove every element E of sl1 such that !smartlist_isin(sl2,E). * Does not preserve the order of sl1. */ void smartlist_intersect(smartlist_t *sl1, const smartlist_t *sl2) { int i; for (i=0; i < sl1->num_used; i++) if (!smartlist_isin(sl2, sl1->list[i])) { sl1->list[i] = sl1->list[--sl1->num_used]; /* swap with the end */ i--; /* so we process the new i'th element */ } } /** Remove every element E of sl1 such that smartlist_isin(sl2,E). * Does not preserve the order of sl1. */ void smartlist_subtract(smartlist_t *sl1, const smartlist_t *sl2) { int i; for (i=0; i < sl2->num_used; i++) smartlist_remove(sl1, sl2->list[i]); } /** Remove the idxth element of sl; if idx is not the last * element, swap the last element of sl into the idxth space. * Return the old value of the idxth element. */ void smartlist_del(smartlist_t *sl, int idx) { tor_assert(sl); tor_assert(idx>=0); tor_assert(idx < sl->num_used); sl->list[idx] = sl->list[--sl->num_used]; } /** Remove the idxth element of sl; if idx is not the last element, * moving all subsequent elements back one space. Return the old value * of the idxth element. */ void smartlist_del_keeporder(smartlist_t *sl, int idx) { tor_assert(sl); tor_assert(idx>=0); tor_assert(idx < sl->num_used); --sl->num_used; if (idx < sl->num_used) memmove(sl->list+idx, sl->list+idx+1, sizeof(void*)*(sl->num_used-idx)); } /** Insert the value val as the new idxth element of * sl, moving all items previously at idx or later * forward one space. */ void smartlist_insert(smartlist_t *sl, int idx, void *val) { tor_assert(sl); tor_assert(idx>=0); tor_assert(idx <= sl->num_used); if (idx == sl->num_used) { smartlist_add(sl, val); } else { /* Ensure sufficient capacity */ if (sl->num_used >= sl->capacity) { sl->capacity *= 2; sl->list = tor_realloc(sl->list, sizeof(void*)*sl->capacity); } /* Move other elements away */ if (idx < sl->num_used) memmove(sl->list + idx + 1, sl->list + idx, sizeof(void*)*(sl->num_used-idx)); sl->num_used++; sl->list[idx] = val; } } /** * Split a string str along all occurrences of sep, * adding the split strings, in order, to sl. If * flags&SPLIT_SKIP_SPACE is true, remove initial and * trailing space from each entry. If * flags&SPLIT_IGNORE_BLANK is true, remove any entries of * length 0. If max>0, divide the string into no more than max * pieces. If sep is NULL, split on any sequence of horizontal space. */ int smartlist_split_string(smartlist_t *sl, const char *str, const char *sep, int flags, int max) { const char *cp, *end, *next; int n = 0; tor_assert(sl); tor_assert(str); cp = str; while (1) { if (flags&SPLIT_SKIP_SPACE) { while (TOR_ISSPACE(*cp)) ++cp; } if (max>0 && n == max-1) { end = strchr(cp,'\0'); } else if (sep) { end = strstr(cp,sep); if (!end) end = strchr(cp,'\0'); } else { for (end = cp; *end && *end != '\t' && *end != ' '; ++end) ; } if (!*end) { next = NULL; } else if (sep) { next = end+strlen(sep); } else { next = end+1; while (*next == '\t' || *next == ' ') ++next; } if (flags&SPLIT_SKIP_SPACE) { while (end > cp && TOR_ISSPACE(*(end-1))) --end; } if (end != cp || !(flags&SPLIT_IGNORE_BLANK)) { smartlist_add(sl, tor_strndup(cp, end-cp)); ++n; } if (!next) break; cp = next; } return n; } /** Allocate and return a new string containing the concatenation of * the elements of sl, in order, separated by join. If * terminate is true, also terminate the string with join. * If len_out is not NULL, set len_out to the length of * the returned string. Requires that every element of sl is * NUL-terminated string. */ char * smartlist_join_strings(smartlist_t *sl, const char *join, int terminate, size_t *len_out) { return smartlist_join_strings2(sl,join,strlen(join),terminate,len_out); } /** As smartlist_join_strings, but instead of separating/terminated with a * NUL-terminated string join, uses the join_len-byte sequence * at join. (Useful for generating a sequence of NUL-terminated * strings.) */ char * smartlist_join_strings2(smartlist_t *sl, const char *join, size_t join_len, int terminate, size_t *len_out) { int i; size_t n = 0; char *r = NULL, *dst, *src; tor_assert(sl); tor_assert(join); if (terminate) n = join_len; for (i = 0; i < sl->num_used; ++i) { n += strlen(sl->list[i]); if (i+1 < sl->num_used) /* avoid double-counting the last one */ n += join_len; } dst = r = tor_malloc(n+1); for (i = 0; i < sl->num_used; ) { for (src = sl->list[i]; *src; ) *dst++ = *src++; if (++i < sl->num_used) { memcpy(dst, join, join_len); dst += join_len; } } if (terminate) { memcpy(dst, join, join_len); dst += join_len; } *dst = '\0'; if (len_out) *len_out = dst-r; return r; } /** Sort the members of sl into an order defined by * the ordering function compare, which returns less then 0 if a * precedes b, greater than 0 if b precedes a, and 0 if a 'equals' b. */ void smartlist_sort(smartlist_t *sl, int (*compare)(const void **a, const void **b)) { if (!sl->num_used) return; qsort(sl->list, sl->num_used, sizeof(void*), (int (*)(const void *,const void*))compare); } /** Assuming the members of sl are in order, return a pointer to the * member which matches key. Ordering and matching are defined by a * compare function, which returns 0 on a match; less than 0 if key is * less than member, and greater than 0 if key is greater then member. */ void * smartlist_bsearch(smartlist_t *sl, const void *key, int (*compare)(const void *key, const void **member)) { void ** r; if (!sl->num_used) return NULL; r = bsearch(key, sl->list, sl->num_used, sizeof(void*), (int (*)(const void *, const void *))compare); return r ? *r : NULL; } /** Helper: compare two const char **s. */ static int _compare_string_ptrs(const void **_a, const void **_b) { return strcmp((const char*)*_a, (const char*)*_b); } /** Sort a smartlist sl containing strings into lexically ascending * order. */ void smartlist_sort_strings(smartlist_t *sl) { smartlist_sort(sl, _compare_string_ptrs); } #define DEFINE_MAP_STRUCTS(maptype, keydecl, prefix) \ typedef struct prefix ## entry_t { \ HT_ENTRY(prefix ## entry_t) node; \ keydecl; \ void *val; \ } prefix ## entry_t; \ struct maptype { \ HT_HEAD(prefix ## tree, prefix ## entry_t) head; \ }; DEFINE_MAP_STRUCTS(strmap_t, char *key, strmap_); DEFINE_MAP_STRUCTS(digestmap_t, char key[DIGEST_LEN], digestmap_); /** Helper: compare strmap_t_entry objects by key value. */ static INLINE int strmap_entries_eq(strmap_entry_t *a, strmap_entry_t *b) { return !strcmp(a->key, b->key); } static INLINE unsigned int strmap_entry_hash(strmap_entry_t *a) { return ht_string_hash(a->key); } /** Helper: compare digestmap_entry_t objects by key value. */ static INLINE int digestmap_entries_eq(digestmap_entry_t *a, digestmap_entry_t *b) { return !memcmp(a->key, b->key, DIGEST_LEN); } static INLINE unsigned int digestmap_entry_hash(digestmap_entry_t *a) { uint32_t *p = (uint32_t*)a->key; return ht_improve_hash(p[0] ^ p[1] ^ p[2] ^ p[3] ^ p[4]); } HT_PROTOTYPE(strmap_tree, strmap_entry_t, node, strmap_entry_hash, strmap_entries_eq); HT_GENERATE(strmap_tree, strmap_entry_t, node, strmap_entry_hash, strmap_entries_eq, 0.6, malloc, realloc, free); HT_PROTOTYPE(digestmap_tree, digestmap_entry_t, node, digestmap_entry_hash, digestmap_entries_eq); HT_GENERATE(digestmap_tree, digestmap_entry_t, node, digestmap_entry_hash, digestmap_entries_eq, 0.6, malloc, realloc, free); /** Constructor to create a new empty map from strings to void*'s. */ strmap_t * strmap_new(void) { strmap_t *result; result = tor_malloc(sizeof(strmap_t)); HT_INIT(&result->head); return result; } /** Constructor to create a new empty map from digests to void*'s. */ digestmap_t * digestmap_new(void) { digestmap_t *result; result = tor_malloc(sizeof(digestmap_t)); HT_INIT(&result->head); return result; } /** Set the current value for key to val. Returns the previous * value for key if one was set, or NULL if one was not. * * This function makes a copy of key if necessary, but not of * val. */ void * strmap_set(strmap_t *map, const char *key, void *val) { strmap_entry_t *resolve; strmap_entry_t search; void *oldval; tor_assert(map); tor_assert(key); tor_assert(val); search.key = (char*)key; resolve = HT_FIND(strmap_tree, &map->head, &search); if (resolve) { oldval = resolve->val; resolve->val = val; return oldval; } else { resolve = tor_malloc_zero(sizeof(strmap_entry_t)); resolve->key = tor_strdup(key); resolve->val = val; tor_assert(!HT_FIND(strmap_tree, &map->head, resolve)); HT_INSERT(strmap_tree, &map->head, resolve); return NULL; } } /** Like strmap_set() above but for digestmaps. */ void * digestmap_set(digestmap_t *map, const char *key, void *val) { digestmap_entry_t *resolve; digestmap_entry_t search; void *oldval; tor_assert(map); tor_assert(key); tor_assert(val); memcpy(&search.key, key, DIGEST_LEN); resolve = HT_FIND(digestmap_tree, &map->head, &search); if (resolve) { oldval = resolve->val; resolve->val = val; return oldval; } else { resolve = tor_malloc_zero(sizeof(digestmap_entry_t)); memcpy(resolve->key, key, DIGEST_LEN); resolve->val = val; HT_INSERT(digestmap_tree, &map->head, resolve); return NULL; } } /** Return the current value associated with key, or NULL if no * value is set. */ void * strmap_get(strmap_t *map, const char *key) { strmap_entry_t *resolve; strmap_entry_t search; tor_assert(map); tor_assert(key); search.key = (char*)key; resolve = HT_FIND(strmap_tree, &map->head, &search); if (resolve) { return resolve->val; } else { return NULL; } } /** Like strmap_get() above but for digestmaps. */ void * digestmap_get(digestmap_t *map, const char *key) { digestmap_entry_t *resolve; digestmap_entry_t search; tor_assert(map); tor_assert(key); memcpy(&search.key, key, DIGEST_LEN); resolve = HT_FIND(digestmap_tree, &map->head, &search); if (resolve) { return resolve->val; } else { return NULL; } } /** Remove the value currently associated with key from the map. * Return the value if one was set, or NULL if there was no entry for * key. * * Note: you must free any storage associated with the returned value. */ void * strmap_remove(strmap_t *map, const char *key) { strmap_entry_t *resolve; strmap_entry_t search; void *oldval; tor_assert(map); tor_assert(key); search.key = (char*)key; resolve = HT_REMOVE(strmap_tree, &map->head, &search); if (resolve) { oldval = resolve->val; tor_free(resolve->key); tor_free(resolve); return oldval; } else { return NULL; } } /** Like strmap_remove() above but for digestmaps. */ void * digestmap_remove(digestmap_t *map, const char *key) { digestmap_entry_t *resolve; digestmap_entry_t search; void *oldval; tor_assert(map); tor_assert(key); memcpy(&search.key, key, DIGEST_LEN); resolve = HT_REMOVE(digestmap_tree, &map->head, &search); if (resolve) { oldval = resolve->val; tor_free(resolve); return oldval; } else { return NULL; } } /** Same as strmap_set, but first converts key to lowercase. */ void * strmap_set_lc(strmap_t *map, const char *key, void *val) { /* We could be a little faster by using strcasecmp instead, and a separate * type, but I don't think it matters. */ void *v; char *lc_key = tor_strdup(key); tor_strlower(lc_key); v = strmap_set(map,lc_key,val); tor_free(lc_key); return v; } /** Same as strmap_get, but first converts key to lowercase. */ void * strmap_get_lc(strmap_t *map, const char *key) { void *v; char *lc_key = tor_strdup(key); tor_strlower(lc_key); v = strmap_get(map,lc_key); tor_free(lc_key); return v; } /** Same as strmap_remove, but first converts key to lowercase */ void * strmap_remove_lc(strmap_t *map, const char *key) { void *v; char *lc_key = tor_strdup(key); tor_strlower(lc_key); v = strmap_remove(map,lc_key); tor_free(lc_key); return v; } /** return an iterator pointer to the front of a map. * * Iterator example: * * \code * // uppercase values in "map", removing empty values. * * strmap_iter_t *iter; * const char *key; * void *val; * char *cp; * * for (iter = strmap_iter_init(map); !strmap_iter_done(iter); ) { * strmap_iter_get(iter, &key, &val); * cp = (char*)val; * if (!*cp) { * iter = strmap_iter_next_rmv(iter); * free(val); * } else { * for (;*cp;cp++) *cp = toupper(*cp); * iter = strmap_iter_next(iter); * } * } * \endcode * */ strmap_iter_t * strmap_iter_init(strmap_t *map) { tor_assert(map); return HT_START(strmap_tree, &map->head); } digestmap_iter_t * digestmap_iter_init(digestmap_t *map) { tor_assert(map); return HT_START(digestmap_tree, &map->head); } /** Advance the iterator iter for map a single step to the next entry. */ strmap_iter_t * strmap_iter_next(strmap_t *map, strmap_iter_t *iter) { tor_assert(map); tor_assert(iter); return HT_NEXT(strmap_tree, &map->head, iter); } digestmap_iter_t * digestmap_iter_next(digestmap_t *map, digestmap_iter_t *iter) { tor_assert(map); tor_assert(iter); return HT_NEXT(digestmap_tree, &map->head, iter); } /** Advance the iterator iter a single step to the next entry, removing * the current entry. */ strmap_iter_t * strmap_iter_next_rmv(strmap_t *map, strmap_iter_t *iter) { strmap_iter_t *next; tor_assert(map); tor_assert(iter); next = HT_NEXT_RMV(strmap_tree, &map->head, iter); tor_free((*iter)->key); tor_free(*iter); return next; } digestmap_iter_t * digestmap_iter_next_rmv(digestmap_t *map, digestmap_iter_t *iter) { digestmap_iter_t *next; tor_assert(map); tor_assert(iter); next = HT_NEXT_RMV(digestmap_tree, &map->head, iter); tor_free(*iter); return next; } /** Set *keyp and *valp to the current entry pointed to by iter. */ void strmap_iter_get(strmap_iter_t *iter, const char **keyp, void **valp) { tor_assert(iter); tor_assert(keyp); tor_assert(valp); *keyp = (*iter)->key; *valp = (*iter)->val; } void digestmap_iter_get(digestmap_iter_t *iter, const char **keyp, void **valp) { tor_assert(iter); tor_assert(keyp); tor_assert(valp); *keyp = (*iter)->key; *valp = (*iter)->val; } /** Return true iff iter has advanced past the last entry of map. */ int strmap_iter_done(strmap_iter_t *iter) { return iter == NULL; } int digestmap_iter_done(digestmap_iter_t *iter) { return iter == NULL; } /** Remove all entries from map, and deallocate storage for those entries. * If free_val is provided, it is invoked on every value in map. */ void strmap_free(strmap_t *map, void (*free_val)(void*)) { strmap_entry_t **ent, **next, *this; for (ent = HT_START(strmap_tree, &map->head); ent != NULL; ent = next) { this = *ent; next = HT_NEXT_RMV(strmap_tree, &map->head, ent); tor_free(this->key); if (free_val) free_val(this->val); tor_free(this); } tor_assert(HT_EMPTY(&map->head)); HT_CLEAR(strmap_tree, &map->head); tor_free(map); } void digestmap_free(digestmap_t *map, void (*free_val)(void*)) { digestmap_entry_t **ent, **next, *this; for (ent = HT_START(digestmap_tree, &map->head); ent != NULL; ent = next) { this = *ent; next = HT_NEXT_RMV(digestmap_tree, &map->head, ent); if (free_val) free_val(this->val); tor_free(this); } tor_assert(HT_EMPTY(&map->head)); HT_CLEAR(digestmap_tree, &map->head); tor_free(map); } /** Return true iff map has no entries. */ int strmap_isempty(strmap_t *map) { return HT_EMPTY(&map->head); } int digestmap_isempty(digestmap_t *map) { return HT_EMPTY(&map->head); }