1 /******************************************************************************/
2 /* pfixtools: a collection of postfix related tools */
4 /* ________________________________________________________________________ */
6 /* Redistribution and use in source and binary forms, with or without */
7 /* modification, are permitted provided that the following conditions */
10 /* 1. Redistributions of source code must retain the above copyright */
11 /* notice, this list of conditions and the following disclaimer. */
12 /* 2. Redistributions in binary form must reproduce the above copyright */
13 /* notice, this list of conditions and the following disclaimer in the */
14 /* documentation and/or other materials provided with the distribution. */
15 /* 3. The names of its contributors may not be used to endorse or promote */
16 /* products derived from this software without specific prior written */
19 /* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND */
20 /* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE */
21 /* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR */
22 /* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS */
23 /* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR */
24 /* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF */
25 /* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS */
26 /* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN */
27 /* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) */
28 /* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF */
29 /* THE POSSIBILITY OF SUCH DAMAGE. */
30 /******************************************************************************/
33 * Copyright © 2008 Florent Bruneau
41 typedef struct trie_entry_t trie_entry_t;
47 int32_t children_offset;
52 trie_entry_t *entries;
67 trie_t *trie_new(void)
69 return p_new(trie_t, 1);
72 static inline void trie_cleanup_build_data(trie_t *trie)
74 for (int i = 0 ; i < trie->keys_len ; ++i) {
75 p_delete(&trie->keys[i]);
77 p_delete(&trie->keys);
78 trie->keys_len = trie->keys_size = 0;
81 void trie_delete(trie_t **trie)
84 trie_cleanup_build_data(*trie);
85 p_delete(&(*trie)->entries);
86 p_delete(&(*trie)->c);
91 /** Check that the given entry is a prefix for the given key.
93 static inline bool trie_entry_c_match(const trie_t *trie,
94 const trie_entry_t *entry,
95 const char *key, int *pos)
97 const char *c = trie->c + entry->c_offset;
99 for (i = 0 ; i < entry->c_len ; ++i) {
100 if (key[i] != c[i]) {
113 static inline bool trie_entry_match(const trie_t *trie,
114 const trie_entry_t *entry, const char *key)
116 return !!(strcmp(trie->c + entry->c_offset, key) == 0);
119 static inline bool trie_entry_is_leaf(const trie_entry_t *entry)
121 return entry->children_len == 0;
124 /** Lookup for a child of entry matching the given entry at the given pos.
125 * Only the first character of the children is taken into account in the
126 * lookup. The current entry is assumed to match the key.
128 static inline trie_entry_t* trie_entry_child(const trie_t *trie,
129 const trie_entry_t* entry,
132 int start = entry->children_offset;
133 int end = start + entry->children_len;
136 while (start < end) {
137 int mid = (start + end) / 2;
138 trie_entry_t* child = &trie->entries[mid];
139 const char c2 = trie->c[child->c_offset];
157 #define GROW(Buffer, Added, Len, Size) \
159 const int required_size = (Len) + (Added); \
160 int next_size = (Size); \
161 if (next_size >= required_size) { \
165 next_size = p_alloc_nr(next_size); \
166 } while (next_size < required_size); \
167 p_allocgrow(&(Buffer), next_size, &(Size)); \
170 static inline void trie_grow(trie_t *trie, int delta)
172 GROW(trie->entries, delta, trie->entries_len, trie->entries_size);
175 static inline int trie_entry_new(trie_t *trie)
177 memset(trie->entries + trie->entries_len, 0, sizeof(trie_entry_t));
178 return trie->entries_len++;
181 static inline int trie_add_leaf(trie_t *trie, const char *key)
184 int len = m_strlen(key) + 1;
185 entry = &trie->entries[trie_entry_new(trie)];
186 GROW(trie->c, len, trie->c_len, trie->c_size);
187 memcpy(trie->c + trie->c_len, key, len);
188 entry->c_offset = trie->c_len;
191 return trie->entries_len - 1;
194 static inline void trie_entry_insert_child(trie_t *trie, trie_entry_t *entry,
197 if (entry->children_len == 0) {
198 entry->children_offset = pchild;
199 entry->children_len = 1;
201 if (entry->children_offset + entry->children_len != pchild) {
203 printf("Inserting child %d while offset is %d[%d]\n",
204 pchild, entry->children_offset, entry->children_len);
207 ++entry->children_len;
211 static inline void trie_entry_split(trie_t *trie, trie_entry_t *entry, int pos)
214 child = &trie->entries[trie_entry_new(trie)];
216 child->c_offset = entry->c_offset;
217 child->c_len = entry->c_len;
221 child->c_offset = entry->c_offset + pos;
222 child->c_len = entry->c_len - pos;
225 child->children_offset = entry->children_offset;
226 child->children_len = entry->children_len;
227 entry->children_offset = trie->entries_len - 1;
228 entry->children_len = 1;
231 void trie_insert(trie_t *trie, const char* key)
233 GROW(trie->keys, 1, trie->keys_len, trie->keys_size);
234 trie->keys[trie->keys_len++] = strdup(key);
238 static inline void trie_compile_aux(trie_t *trie, int id,
239 int first_key, int last_key, int offset,
246 for (int off_diff = initial_diff ; fork_pos == 0 ; ++off_diff, ++offset) {
247 current = trie->keys[first_key][offset];
248 for (int i = first_key + 1 ; i < last_key ; ++i) {
249 if (trie->keys[i][offset] != current) {
252 trie_entry_split(trie, &trie->entries[id], off_diff);
254 trie_entry_insert_child(trie, &trie->entries[id],
255 trie_add_leaf(trie, trie->keys[i] +
257 forks[fork_pos++] = i;
258 current = trie->keys[i][offset];
262 forks[fork_pos] = last_key;
264 const int children_len = trie->entries[id].children_len;
265 for (int i = 0 ; i < children_len ; ++i) {
266 int child = trie->entries[id].children_offset + i;
267 if (forks[i] - 1 > first_key) {
268 trie_compile_aux(trie, child, first_key, forks[i], offset, 1);
270 first_key = forks[i];
275 static inline void trie_shrink(trie_t *trie)
277 p_shrink(&trie->entries, trie->entries_len, &trie->entries_size);
278 p_shrink(&trie->c, trie->c_len, &trie->c_size);
281 static inline void trie_lock(trie_t *trie)
283 if (mlock(trie->entries, sizeof(trie_entry_t) * trie->entries_len) != 0) {
287 if (mlock(trie->c, trie->c_len) != 0) {
289 munlock(trie->entries, sizeof(trie_entry_t) * trie->entries_len);
297 void trie_compile(trie_t *trie, bool memlock)
300 # define QSORT_TYPE str_t
301 # define QSORT_BASE trie->keys
302 # define QSORT_NELT trie->keys_len
303 # define QSORT_LT(a,b) strcmp(*a, *b) < 0
307 trie_grow(trie, trie->keys_len);
308 trie_compile_aux(trie, trie_add_leaf(trie, trie->keys[0]),
309 0, trie->keys_len, 0, 0);
310 trie_cleanup_build_data(trie);
317 bool trie_lookup(const trie_t *trie, const char *key)
319 if (trie->entries_len == 0) {
322 trie_entry_t *current = trie->entries;
325 if (trie_entry_is_leaf(current)) {
326 return trie_entry_match(trie, current, key);
327 } else if (trie_entry_c_match(trie, current, key, &pos)) {
329 current = trie_entry_child(trie, current, key);
330 if (current == NULL) {
344 static inline void trie_entry_inspect(const trie_t *trie,
345 const trie_entry_t *entry, int level)
347 static int max_depth = 0;
348 static int leaves = 0;
349 static int depth_sum = 0;
351 if (trie_entry_is_leaf(entry)) {
352 if (level > max_depth) {
358 for (int i = 0 ; i < level ; ++i) {
361 if (entry->c_len == 0) {
362 fputs("(nil)", stdout);
364 const char *c = trie->c + entry->c_offset;
365 printf("(%d) ", entry->c_len);
366 for (int i = 0 ; i < entry->c_len ; ++i) {
370 fputs("\\0 ", stdout);
375 for (int i = entry->children_offset ;
376 i < entry->children_offset + entry->children_len ; ++i) {
377 trie_entry_inspect(trie, &trie->entries[i], level + 1);
380 printf("Average char per node: %d\n", trie->c_len / trie->entries_len);
381 printf("Number of nodes: %d\n", trie->entries_len);
382 printf("Number of leaves: %d\n", leaves);
383 printf("Max depth: %d\n", max_depth);
384 printf("Average leaf depth: %d\n", depth_sum / leaves);
385 printf("Memory used: %d\n", (trie->entries_size * sizeof(trie_entry_t))
386 + (trie->c_size) + sizeof(trie_t));
390 void trie_inspect(const trie_t *trie)
392 trie_entry_inspect(trie, trie->entries, 0);