common/trie.c

   1 /******************************************************************************/
   2 /*          pfixtools: a collection of postfix related tools                  */
   3 /*          ~~~~~~~~~                                                         */
   4 /*  ________________________________________________________________________  */
   5 /*                                                                            */
   6 /*  Redistribution and use in source and binary forms, with or without        */
   7 /*  modification, are permitted provided that the following conditions        */
   8 /*  are met:                                                                  */
   9 /*                                                                            */
  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     */
  17 /*     permission.                                                            */
  18 /*                                                                            */
  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 /******************************************************************************/
  31
  32 /*
  33  * Copyright © 2008 Florent Bruneau
  34  */
  35
  36 #include "array.h"
  37 #include "str.h"
  38 #include "trie.h"
  39
  40 typedef struct trie_entry_t trie_entry_t;
  41
  42 struct trie_entry_t {
  43     uint32_t c_offset;
  44     uint32_t children_offset;
  45
  46     uint16_t c_len;
  47     uint16_t children_len;
  48 };
  49 #define TRIE_ENTRY_INIT { 0, 0, 0, 0 }
  50 ARRAY(trie_entry_t)
  51
  52 struct trie_t {
  53     A(trie_entry_t) entries;
  54     A(char)         c;
  55     A(char)         keys;
  56     A(int)          keys_offset;
  57
  58     bool locked;
  59 };
  60
  61 trie_t *trie_new(void)
  62 {
  63     return p_new(trie_t, 1);
  64 }
  65
  66 static inline void trie_cleanup_build_data(trie_t *trie)
  67 {
  68     array_wipe(trie->keys);
  69     array_wipe(trie->keys_offset);
  70 }
  71
  72 void trie_delete(trie_t **trie)
  73 {
  74     if (*trie) {
  75         trie_cleanup_build_data(*trie);
  76         trie_unlock(*trie);
  77         array_wipe((*trie)->entries);
  78         array_wipe((*trie)->c);
  79         p_delete(trie);
  80     }
  81 }
  82
  83 /** Check that the given entry is a prefix for the given key.
  84  */
  85 static inline bool trie_entry_c_match(const trie_t *trie,
  86                                       const trie_entry_t *entry,
  87                                       const char *key)
  88 {
  89     const char *c = array_ptr(trie->c, entry->c_offset);
  90     int i = 0;
  91     for (i = 0 ; i < entry->c_len ; ++i) {
  92         if (key[i] != c[i]) {
  93             return false;
  94         }
  95     }
  96     return true;
  97 }
  98
  99 static inline bool trie_entry_match(const trie_t *trie,
 100                                     const trie_entry_t *entry, const char *key)
 101 {
 102     return !!(strcmp(array_ptr(trie->c, entry->c_offset), key) == 0);
 103 }
 104
 105 static inline bool trie_entry_prefix(const trie_t *trie,
 106                                      const trie_entry_t *entry, const char *key)
 107 {
 108     int len = entry->c_len;
 109     if (len > 0 && array_elt(trie->c, entry->c_offset + len - 1) == '\0') {
 110         --len;
 111     }
 112     return !!(strncmp(array_ptr(trie->c, entry->c_offset), key, len) == 0);
 113 }
 114
 115 static inline bool trie_entry_is_leaf(const trie_entry_t *entry)
 116 {
 117     return entry->children_len == 0;
 118 }
 119
 120 /** Lookup for a child of entry matching the given entry at the given pos.
 121  * Only the first character of the children is taken into account in the
 122  * lookup. The current entry is assumed to match the key.
 123  */
 124 static inline const trie_entry_t* trie_entry_child(const trie_t *trie,
 125                                                    const trie_entry_t* entry,
 126                                                    const char *key)
 127 {
 128     uint32_t start = entry->children_offset;
 129     uint32_t end   = start + entry->children_len;
 130     const char c = *key;
 131
 132     while (start < end) {
 133         uint32_t mid = (start + end) >> 1;
 134         const trie_entry_t* child = array_ptr(trie->entries, mid);
 135         const char c2 = array_elt(trie->c, child->c_offset);
 136
 137         if (c2 == c) {
 138           return child;
 139         }
 140         if (c < c2) {
 141           end = mid;
 142         } else {
 143           start = mid + 1;
 144         }
 145     }
 146     return NULL;
 147 }
 148
 149 static inline uint32_t trie_entry_new(trie_t *trie)
 150 {
 151     const trie_entry_t e = TRIE_ENTRY_INIT;
 152     array_add(trie->entries, e);
 153     return trie->entries.len - 1;
 154 }
 155
 156 static inline uint32_t trie_add_leaf(trie_t *trie, const char *key)
 157 {
 158     trie_entry_t *entry;
 159     int len = m_strlen(key) + 1;
 160     entry = array_ptr(trie->entries, trie_entry_new(trie));
 161     entry->c_offset = trie->c.len;
 162     entry->c_len    = len;
 163     array_append(trie->c, key, len);
 164     return trie->entries.len - 1;
 165 }
 166
 167 static inline void trie_entry_insert_child(trie_t *trie, trie_entry_t *entry,
 168                                            uint32_t pchild)
 169 {
 170     if (entry->children_len == 0) {
 171         entry->children_offset = pchild;
 172         entry->children_len    = 1;
 173     } else {
 174         if (entry->children_offset + entry->children_len != pchild) {
 175             printf("Inserting child %d while offset is %d[%d]\n",
 176                    pchild, entry->children_offset, entry->children_len);
 177             abort();
 178         }
 179         ++entry->children_len;
 180     }
 181 }
 182
 183 static inline void trie_entry_split(trie_t *trie, trie_entry_t *entry, uint16_t pos)
 184 {
 185     trie_entry_t *child;
 186     child    = array_ptr(trie->entries, trie_entry_new(trie));
 187     if (pos == 0) {
 188         child->c_offset = entry->c_offset;
 189         child->c_len    = entry->c_len;
 190         entry->c_offset = 0;
 191         entry->c_len    = 0;
 192     } else {
 193         child->c_offset = entry->c_offset + pos;
 194         child->c_len    = entry->c_len - pos;
 195         entry->c_len    = pos;
 196     }
 197     child->children_offset = entry->children_offset;
 198     child->children_len    = entry->children_len;
 199     entry->children_offset = trie->entries.len - 1;
 200     entry->children_len    = 1;
 201 }
 202
 203 void trie_insert(trie_t *trie, const char* key)
 204 {
 205     assert(trie->entries.len == 0 && "Trie already compiled");
 206
 207     int len = m_strlen(key) + 1;
 208     array_add(trie->keys_offset, trie->keys.len);
 209     array_append(trie->keys, key, len);
 210 }
 211
 212
 213 static inline void trie_compile_aux(trie_t *trie, uint32_t id,
 214                                     uint32_t first_key, uint32_t last_key,
 215                                     int offset, int initial_diff)
 216 {
 217     uint32_t forks[256];
 218     uint32_t fork_pos = 0;
 219     char current = '\0';
 220
 221     for (int off_diff = initial_diff ; fork_pos == 0 ; ++off_diff, ++offset) {
 222         current = array_elt(trie->keys, array_elt(trie->keys_offset, first_key) + offset);
 223         for (uint32_t i = first_key + 1 ; i < last_key ; ++i) {
 224             const char *str = array_ptr(trie->keys, array_elt(trie->keys_offset, i));
 225             const char c = str[offset];
 226             if (c != current) {
 227                 array_ensure_capacity_delta(trie->entries, 2);
 228                 if (fork_pos == 0) {
 229                     trie_entry_split(trie, array_ptr(trie->entries, id), off_diff);
 230                 }
 231                 trie_entry_insert_child(trie, array_ptr(trie->entries, id),
 232                                         trie_add_leaf(trie, str + offset));
 233                 forks[fork_pos++] = i;
 234                 current = c;
 235             }
 236         }
 237         if (fork_pos == 0 && current == '\0') {
 238             return;
 239         }
 240     }
 241     forks[fork_pos] = last_key;
 242
 243     const uint8_t children_len = array_elt(trie->entries, id).children_len;
 244     for (uint16_t i = 0 ; i < children_len ; ++i) {
 245         int child = array_elt(trie->entries, id).children_offset + i;
 246         if (forks[i] - 1 > first_key) {
 247             trie_compile_aux(trie, child, first_key, forks[i], offset, 1);
 248         }
 249         first_key = forks[i];
 250     }
 251 }
 252
 253 void trie_compile(trie_t *trie, bool memlock)
 254 {
 255     assert(trie->entries.len == 0 && "Trie already compiled");
 256     assert(trie->keys.len != 0 && "Trying to compile an empty trie");
 257     {
 258 #       define QSORT_TYPE int
 259 #       define QSORT_BASE trie->keys_offset.data
 260 #       define QSORT_NELT trie->keys_offset.len
 261 #       define QSORT_LT(a,b) strcmp(trie->keys.data + *a, trie->keys.data + *b) < 0
 262 #       include "qsort.c"
 263     }
 264
 265     array_ensure_capacity(trie->entries, trie->keys.len);
 266     trie_compile_aux(trie, trie_add_leaf(trie, trie->keys.data),
 267                      0, trie->keys_offset.len, 0, 0);
 268     trie_cleanup_build_data(trie);
 269     array_adjust(trie->entries);
 270     array_adjust(trie->c);
 271     if (memlock) {
 272         trie_lock(trie);
 273     }
 274 }
 275
 276 bool trie_lookup(const trie_t *trie, const char *key)
 277 {
 278     assert(trie->keys.len == 0L && "Can't lookup: trie not compiled");
 279     if (trie->entries.len == 0) {
 280         return false;
 281     } else {
 282         const trie_entry_t *current = array_ptr(trie->entries, 0);
 283         while (true) {
 284             if (trie_entry_is_leaf(current)) {
 285                 return trie_entry_match(trie, current, key);
 286             } else if (trie_entry_c_match(trie, current, key)) {
 287                 key += current->c_len;
 288                 current = trie_entry_child(trie, current, key);
 289                 if (current == NULL) {
 290                     return false;
 291                 }
 292             } else {
 293                 return false;
 294             }
 295         }
 296     }
 297 }
 298
 299 bool trie_prefix(const trie_t *trie, const char *key)
 300 {
 301     assert(trie->keys.len == 0L && "Can't lookup: trie not compiled");
 302     if (trie->entries.len == 0) {
 303         return false;
 304     } else {
 305         const trie_entry_t *current = array_ptr(trie->entries, 0);
 306         while (true) {
 307             if (trie_entry_is_leaf(current)) {
 308                 return trie_entry_prefix(trie, current, key);
 309             } else if (trie_entry_c_match(trie, current, key)) {
 310                 key += current->c_len;
 311                 current = trie_entry_child(trie, current, key);
 312                 if (current == NULL) {
 313                     return false;
 314                 }
 315             } else {
 316                 return false;
 317             }
 318         }
 319     }
 320 }
 321
 322 void trie_lock(trie_t *trie)
 323 {
 324     if (trie->locked) {
 325         return;
 326     }
 327     if (!array_lock(trie->entries)) {
 328         UNIXERR("mlock");
 329     }
 330     if (!array_lock(trie->c)) {
 331         UNIXERR("mlock");
 332     }
 333     if (mlock(trie, sizeof(trie_t)) != 0) {
 334         UNIXERR("mlock");
 335         return;
 336     }
 337     trie->locked = true;
 338 }
 339
 340 void trie_unlock(trie_t *trie)
 341 {
 342     if (!trie->locked) {
 343         return;
 344     }
 345     array_unlock(trie->entries);
 346     array_unlock(trie->c);
 347     munlock(trie, sizeof(trie_t));
 348     trie->locked = false;
 349 }
 350
 351 /* Debug {{{1
 352  */
 353
 354 static inline void trie_entry_inspect(const trie_t *trie, bool show_content,
 355                                       const trie_entry_t *entry, int level)
 356 {
 357     static int max_depth = 0;
 358     static int leaves    = 0;
 359     static int depth_sum = 0;
 360
 361     if (entry == array_ptr(trie->entries, 0)) {
 362       max_depth = 0;
 363       leaves    = 0;
 364       depth_sum = 0;
 365     }
 366     if (trie_entry_is_leaf(entry)) {
 367         if (level > max_depth) {
 368             max_depth = level;
 369         }
 370         ++leaves;
 371         depth_sum += level;
 372     }
 373     if (show_content) {
 374         for (int i = 0 ; i < level ; ++i) {
 375             fputs("  ", stdout);
 376         }
 377         if (entry->c_len == 0) {
 378             fputs("(nil)", stdout);
 379         } else {
 380             const char *c = array_ptr(trie->c, entry->c_offset);
 381             printf("(%d) ", entry->c_len);
 382             for (int i = 0 ; i < entry->c_len ; ++i) {
 383                 if (c[i]) {
 384                     printf("%c ", c[i]);
 385                 } else {
 386                     fputs("\\0 ", stdout);
 387                 }
 388             }
 389         }
 390         fputs("\n", stdout);
 391     }
 392     for (uint32_t i = entry->children_offset ;
 393           i < entry->children_offset + entry->children_len ; ++i) {
 394         trie_entry_inspect(trie, show_content, array_ptr(trie->entries, i), level + 1);
 395     }
 396     if (level == 0) {
 397         printf("Average char per node: %d\n", trie->c.len / trie->entries.len);
 398         printf("Number of nodes: %d\n", trie->entries.len);
 399         printf("Number of leaves: %d\n", leaves);
 400         printf("Max depth: %d\n", max_depth);
 401         printf("Average leaf depth: %d\n", depth_sum / leaves);
 402         printf("Memory used: %d\n", (trie->entries.size * sizeof(trie_entry_t))
 403                                   + (trie->c.size) + sizeof(trie_t));
 404     }
 405 }
 406
 407 void trie_inspect(const trie_t *trie, bool show_content)
 408 {
 409     trie_entry_inspect(trie, show_content, trie->entries.data, 0);
 410 }