src/utils/llist.c

   1 /*
   2  * SysDB - src/utils/llist.c
   3  * Copyright (C) 2012 Sebastian 'tokkee' Harl <sh@tokkee.org>
   4  * All rights reserved.
   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  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  17  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  18  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
  19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #include "utils/llist.h"
  29
  30 #include <assert.h>
  31 #include <stdlib.h>
  32 #include <strings.h>
  33
  34 #include <pthread.h>
  35
  36 /*
  37  * private data types
  38  */
  39
  40 struct sdb_llist_elem;
  41 typedef struct sdb_llist_elem sdb_llist_elem_t;
  42
  43 struct sdb_llist_elem {
  44         sdb_object_t *obj;
  45
  46         sdb_llist_elem_t *next;
  47         sdb_llist_elem_t *prev;
  48 };
  49
  50 struct sdb_llist {
  51         pthread_rwlock_t lock;
  52
  53         sdb_llist_elem_t *head;
  54         sdb_llist_elem_t *tail;
  55
  56         size_t length;
  57 };
  58
  59 struct sdb_llist_iter {
  60         sdb_llist_t *list;
  61         sdb_llist_elem_t *elem;
  62 };
  63
  64 /*
  65  * private helper functions
  66  */
  67
  68 /* Insert a new element after 'elem'. If 'elem' is NULL, insert at the head of
  69  * the list. */
  70 static int
  71 sdb_llist_insert_after(sdb_llist_t *list, sdb_llist_elem_t *elem,
  72                 sdb_object_t *obj)
  73 {
  74         sdb_llist_elem_t *new;
  75
  76         assert(list);
  77
  78         new = malloc(sizeof(*new));
  79         if (! new)
  80                 return -1;
  81
  82         new->obj  = obj;
  83         if (elem)
  84                 new->next = elem->next;
  85         else if (list->head)
  86                 new->next = list->head;
  87         else
  88                 new->next = NULL;
  89         new->prev = elem;
  90
  91         if (elem) {
  92                 if (elem->next)
  93                         elem->next->prev = new;
  94                 else
  95                         list->tail = new;
  96                 elem->next = new;
  97         }
  98         else {
  99                 /* new entry will be new head */
 100                 if (list->head)
 101                         list->head->prev = new;
 102
 103                 list->head = new;
 104                 if (! list->tail)
 105                         list->tail = new;
 106         }
 107
 108         assert(list->head && list->tail);
 109         if (! list->length) {
 110                 assert(list->head == list->tail);
 111         }
 112
 113         sdb_object_ref(obj);
 114         ++list->length;
 115         return 0;
 116 } /* sdb_llist_insert_after */
 117
 118 static sdb_object_t *
 119 sdb_llist_remove_elem(sdb_llist_t *list, sdb_llist_elem_t *elem)
 120 {
 121         sdb_object_t *obj;
 122
 123         assert(list && elem);
 124
 125         obj = elem->obj;
 126
 127         if (elem->prev)
 128                 elem->prev->next = elem->next;
 129         else {
 130                 assert(elem == list->head);
 131                 list->head = elem->next;
 132         }
 133
 134         if (elem->next)
 135                 elem->next->prev = elem->prev;
 136         else {
 137                 assert(elem == list->tail);
 138                 list->tail = elem->prev;
 139         }
 140
 141         elem->prev = elem->next = NULL;
 142         free(elem);
 143
 144         --list->length;
 145         return obj;
 146 } /* sdb_llist_remove_elem */
 147
 148 /*
 149  * public API
 150  */
 151
 152 sdb_llist_t *
 153 sdb_llist_create(void)
 154 {
 155         sdb_llist_t *list;
 156
 157         list = malloc(sizeof(*list));
 158         if (! list)
 159                 return NULL;
 160
 161         pthread_rwlock_init(&list->lock, /* attr = */ NULL);
 162
 163         list->head = list->tail = NULL;
 164         list->length = 0;
 165         return list;
 166 } /* sdb_llist_create */
 167
 168 sdb_llist_t *
 169 sdb_llist_clone(sdb_llist_t *list)
 170 {
 171         sdb_llist_t *new;
 172         sdb_llist_elem_t *elem;
 173
 174         if (! list)
 175                 return NULL;
 176
 177         new = sdb_llist_create();
 178         if (! new)
 179                 return NULL;
 180
 181         if (! list->length) {
 182                 assert((! list->head) && (! list->tail));
 183                 return new;
 184         }
 185
 186         for (elem = list->head; elem; elem = elem->next) {
 187                 if (sdb_llist_append(new, elem->obj)) {
 188                         sdb_llist_destroy(new);
 189                         return NULL;
 190                 }
 191         }
 192         return new;
 193 } /* sdb_llist_clone */
 194
 195 void
 196 sdb_llist_destroy(sdb_llist_t *list)
 197 {
 198         sdb_llist_elem_t *elem;
 199
 200         if (! list)
 201                 return;
 202
 203         pthread_rwlock_wrlock(&list->lock);
 204
 205         elem = list->head;
 206         while (elem) {
 207                 sdb_llist_elem_t *tmp = elem->next;
 208
 209                 sdb_object_deref(elem->obj);
 210                 free(elem);
 211
 212                 elem = tmp;
 213         }
 214
 215         list->head = list->tail = NULL;
 216         list->length = 0;
 217
 218         pthread_rwlock_unlock(&list->lock);
 219         pthread_rwlock_destroy(&list->lock);
 220         free(list);
 221 } /* sdb_llist_destroy */
 222
 223 int
 224 sdb_llist_append(sdb_llist_t *list, sdb_object_t *obj)
 225 {
 226         int status;
 227
 228         if ((! list) || (! obj))
 229                 return -1;
 230
 231         pthread_rwlock_wrlock(&list->lock);
 232         status = sdb_llist_insert_after(list, list->tail, obj);
 233         pthread_rwlock_unlock(&list->lock);
 234         return status;
 235 } /* sdb_llist_append */
 236
 237 int
 238 sdb_llist_insert(sdb_llist_t *list, sdb_object_t *obj, size_t idx)
 239 {
 240         sdb_llist_elem_t *prev;
 241         sdb_llist_elem_t *next;
 242
 243         int status;
 244
 245         size_t i;
 246
 247         if ((! list) || (! obj) || (idx > list->length))
 248                 return -1;
 249
 250         pthread_rwlock_wrlock(&list->lock);
 251
 252         prev = NULL;
 253         next = list->head;
 254
 255         for (i = 0; i < idx; ++i) {
 256                 prev = next;
 257                 next = next->next;
 258         }
 259         status = sdb_llist_insert_after(list, prev, obj);
 260         pthread_rwlock_unlock(&list->lock);
 261         return status;
 262 } /* sdb_llist_insert */
 263
 264 int
 265 sdb_llist_insert_sorted(sdb_llist_t *list,
 266                 sdb_object_t *obj, sdb_llist_cmp_cb compare)
 267 {
 268         sdb_llist_elem_t *prev;
 269         sdb_llist_elem_t *next;
 270
 271         int status;
 272
 273         if ((! list) || (! obj) || (! compare))
 274                 return -1;
 275
 276         pthread_rwlock_wrlock(&list->lock);
 277
 278         prev = NULL;
 279         next = list->head;
 280
 281         while (next) {
 282                 if (compare(obj, next->obj) < 0)
 283                         break;
 284
 285                 prev = next;
 286                 next = next->next;
 287         }
 288         status = sdb_llist_insert_after(list, prev, obj);
 289         pthread_rwlock_unlock(&list->lock);
 290         return status;
 291 } /* sdb_llist_insert_sorted */
 292
 293 sdb_object_t *
 294 sdb_llist_search(sdb_llist_t *list,
 295                 sdb_llist_lookup_cb lookup, void *user_data)
 296 {
 297         sdb_llist_elem_t *elem;
 298
 299         if ((! list) || (! lookup))
 300                 return NULL;
 301
 302         pthread_rwlock_rdlock(&list->lock);
 303
 304         for (elem = list->head; elem; elem = elem->next)
 305                 if (! lookup(elem->obj, user_data))
 306                         break;
 307
 308         pthread_rwlock_unlock(&list->lock);
 309         if (elem)
 310                 return elem->obj;
 311         return NULL;
 312 } /* sdb_llist_search */
 313
 314 sdb_object_t *
 315 sdb_llist_search_by_name(sdb_llist_t *list, const char *key)
 316 {
 317         sdb_llist_elem_t *elem;
 318
 319         if (! list)
 320                 return NULL;
 321
 322         pthread_rwlock_rdlock(&list->lock);
 323
 324         for (elem = list->head; elem; elem = elem->next)
 325                 if (! strcasecmp(elem->obj->name, key))
 326                         break;
 327
 328         pthread_rwlock_unlock(&list->lock);
 329
 330         if (elem)
 331                 return elem->obj;
 332         return NULL;
 333 } /* sdb_llist_search_by_name */
 334
 335 sdb_object_t *
 336 sdb_llist_shift(sdb_llist_t *list)
 337 {
 338         sdb_object_t *obj;
 339
 340         if ((! list) || (! list->head))
 341                 return NULL;
 342
 343         pthread_rwlock_wrlock(&list->lock);
 344         obj = sdb_llist_remove_elem(list, list->head);
 345         pthread_rwlock_unlock(&list->lock);
 346         return obj;
 347 } /* sdb_llist_shift */
 348
 349 sdb_llist_iter_t *
 350 sdb_llist_get_iter(sdb_llist_t *list)
 351 {
 352         sdb_llist_iter_t *iter;
 353
 354         if (! list)
 355                 return NULL;
 356
 357         iter = malloc(sizeof(*iter));
 358         if (! iter)
 359                 return NULL;
 360
 361         pthread_rwlock_rdlock(&list->lock);
 362
 363         iter->list = list;
 364         iter->elem = list->head;
 365
 366         /* XXX: keep lock until destroying the iterator? */
 367         pthread_rwlock_unlock(&list->lock);
 368         return iter;
 369 } /* sdb_llist_get_iter */
 370
 371 void
 372 sdb_llist_iter_destroy(sdb_llist_iter_t *iter)
 373 {
 374         if (! iter)
 375                 return;
 376
 377         iter->list = NULL;
 378         iter->elem = NULL;
 379         free(iter);
 380 } /* sdb_llist_iter_destroy */
 381
 382 _Bool
 383 sdb_llist_iter_has_next(sdb_llist_iter_t *iter)
 384 {
 385         if (! iter)
 386                 return 0;
 387         return iter->elem != NULL;
 388 } /* sdb_llist_iter_has_next */
 389
 390 sdb_object_t *
 391 sdb_llist_iter_get_next(sdb_llist_iter_t *iter)
 392 {
 393         sdb_object_t *obj;
 394
 395         if ((! iter) || (! iter->elem))
 396                 return NULL;
 397
 398         pthread_rwlock_rdlock(&iter->list->lock);
 399
 400         obj = iter->elem->obj;
 401         iter->elem = iter->elem->next;
 402
 403         pthread_rwlock_unlock(&iter->list->lock);
 404         return obj;
 405 } /* sdb_llist_iter_get_next */
 406
 407 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 408