/usr/include/dnscore/list-dl.h is in libyadifa-dev 2.1.6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 | /*------------------------------------------------------------------------------
*
* Copyright (c) 2011-2016, EURid. All rights reserved.
* The YADIFA TM software product is provided under the BSD 3-clause license:
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of EURid nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
*------------------------------------------------------------------------------
*
*/
/** @defgroup collections Generic collections functions
* @ingroup dnscore
* @brief A node-based single linked list
*
* A node-based single linked list
*
* @{
*/
/*----------------------------------------------------------------------------*/
#ifndef LIST_DL_H_
#define LIST_DL_H_
/* ------------------------------------------------------------
*
* INCLUDES
*/
#include <dnscore/sys_types.h>
#include <dnscore/zalloc.h>
/* ------------------------------------------------------------
*
* STRUCTS
*/
/**
* Linked list for interface data
*
* (looks like a no-header no-sentinel single-linked list of strings)
*
*
* head : the base structure of the list
* item : the concept of what is being stored in the list
* node : holds the item
* data : the reference to the item (which can be called data because it's type-less)
*
*/
typedef struct list_dl_node_s list_dl_node_s;
// 24 bytes
struct list_dl_node_s
{
struct list_dl_node_s *next;
struct list_dl_node_s *prev;
void *data;
};
typedef struct list_dl_node_sentiel_s list_dl_node_sentiel_s;
// 16 bytes
struct list_dl_node_sentiel_s
{
struct list_dl_node_s *next;
struct list_dl_node_s *prev;
};
typedef struct list_dl_s list_dl_s;
// 36 bytes
struct list_dl_s
{
list_dl_node_sentiel_s head_sentinel;
list_dl_node_sentiel_s tail_sentinel;
u32 size;
};
typedef struct list_dl_iterator_s list_dl_iterator_s;
struct list_dl_iterator_s
{
list_dl_s *list;
list_dl_node_s *current_node;
};
/* ------------------------------------------------------------
*
* PROTOTYPES
*/
static inline void
list_dl_iterator_init(list_dl_iterator_s *iter, list_dl_s *list)
{
iter->list = list;
iter->current_node = (list_dl_node_s*)&list->head_sentinel;
}
static inline bool
list_dl_iterator_has_next(list_dl_iterator_s *iter)
{
return iter->current_node->next != (list_dl_node_s*)&iter->list->tail_sentinel;
}
static inline void*
list_dl_iterator_next(list_dl_iterator_s *iter)
{
iter->current_node = iter->current_node->next;
return iter->current_node->data;
}
static inline list_dl_node_s *
list_dl_node_alloc()
{
list_dl_node_s *node;
ZALLOC_OR_DIE(list_dl_node_s*, node, list_dl_node_s, GENERIC_TAG);
return node;
}
static inline void
list_dl_node_free(list_dl_node_s *node)
{
ZFREE(node, list_dl_node_s);
}
/**
* Initialises a list.
*
* @param list
*/
static inline void
list_dl_init(list_dl_s *list)
{
ZEROMEMORY(list, sizeof(list_dl_s));
list->head_sentinel.next = (list_dl_node_s*)&list->tail_sentinel;
list->tail_sentinel.prev = (list_dl_node_s*)&list->head_sentinel;
}
/**
* Adds an item at the head of the list.
*
* @param list
* @param data
*/
static inline void
list_dl_insert(list_dl_s *list, void *data)
{
list_dl_node_s *node;
ZALLOC_OR_DIE(list_dl_node_s*, node, list_dl_node_s, GENERIC_TAG);
node->next = list->head_sentinel.next;
node->prev = (list_dl_node_s*)&list->head_sentinel;
list->head_sentinel.next->prev = node;
list->head_sentinel.next = node;
#ifdef DEBUG
assert(list->head_sentinel.next->prev == (list_dl_node_s*)&list->head_sentinel);
#endif
node->data = data;
list->size++;
}
static inline void
list_dl_insert_node(list_dl_s *list, list_dl_node_s *node)
{
node->next = list->head_sentinel.next;
node->prev = (list_dl_node_s*)&list->head_sentinel;
list->head_sentinel.next->prev = node;
list->head_sentinel.next = node;
#ifdef DEBUG
assert(list->head_sentinel.next->prev == (list_dl_node_s*)&list->head_sentinel);
#endif
list->size++;
}
/**
* Adds an item at the tail of the list.
*
* @param list
* @param data
*/
static inline void
list_dl_append(list_dl_s *list, void *data)
{
list_dl_node_s *node;
ZALLOC_OR_DIE(list_dl_node_s*, node, list_dl_node_s, GENERIC_TAG);
node->next = (list_dl_node_s*)&list->tail_sentinel;
node->prev = list->tail_sentinel.prev;
list->tail_sentinel.prev->next = node;
list->tail_sentinel.prev = node;
#ifdef DEBUG
assert(list->tail_sentinel.prev->next == (list_dl_node_s*)&list->tail_sentinel);
#endif
node->data = data;
list->size++;
}
static inline void
list_dl_append_node(list_dl_s *list, list_dl_node_s *node)
{
node->next = (list_dl_node_s*)&list->tail_sentinel;
node->prev = list->tail_sentinel.prev;
list->tail_sentinel.prev->next = node;
list->tail_sentinel.prev = node;
#ifdef DEBUG
assert(list->tail_sentinel.prev->next == (list_dl_node_s*)&list->tail_sentinel);
#endif
list->size++;
}
static inline void
list_dl_append_list(list_dl_s *list, list_dl_s *list_to_add)
{
if(list_to_add->size > 0)
{
list_dl_node_s *node;
node = list_to_add->head_sentinel.next;
node->prev = list->tail_sentinel.prev;
list->tail_sentinel.prev->next = node;
node = list_to_add->tail_sentinel.prev;
node->next = (list_dl_node_s*)&list->tail_sentinel;
list->tail_sentinel.prev = node;
list->size += list_to_add->size;
list_to_add->head_sentinel.next = (list_dl_node_s*)&list_to_add->tail_sentinel;
list_to_add->tail_sentinel.prev = (list_dl_node_s*)&list_to_add->head_sentinel;
list_to_add->size = 0;
}
}
/**
*
* Adds an item to the list.
* Effectively inserts the item.
*
* @param list
* @param data
*/
static inline void
list_dl_add(list_dl_s *list, void *data)
{
list_dl_append(list, data);
}
/**
* Remove the first item from the list.
* Deletes the node but not the data.
* The data is returned.
*
* @param list
* @return the data or NULL if the list is empty
*/
static inline void*
list_dl_remove_first(list_dl_s *list)
{
if(list->size > 0)
{
#ifdef DEBUG
assert(list->head_sentinel.next != (list_dl_node_s*)&list->tail_sentinel);
assert(list->tail_sentinel.prev != (list_dl_node_s*)&list->head_sentinel);
assert(list->head_sentinel.next != NULL);
assert(list->tail_sentinel.prev != NULL);
#endif
list_dl_node_s *node = list->head_sentinel.next;
list->head_sentinel.next = node->next;
node->next->prev = (list_dl_node_s*)&list->head_sentinel;
list->size--;
void *data = node->data;
ZFREE(node, list_dl_node_s);
#ifdef DEBUG
assert(list->head_sentinel.next->prev == (list_dl_node_s*)&list->head_sentinel);
#endif
return data;
}
else
{
return NULL;
}
}
static inline list_dl_node_s*
list_dl_remove_first_node(list_dl_s *list)
{
if(list->size > 0)
{
#ifdef DEBUG
assert(list->head_sentinel.next != (list_dl_node_s*)&list->tail_sentinel);
assert(list->tail_sentinel.prev != (list_dl_node_s*)&list->head_sentinel);
assert(list->head_sentinel.next != NULL);
assert(list->tail_sentinel.prev != NULL);
#endif
list_dl_node_s *node = list->head_sentinel.next;
list->head_sentinel.next = node->next;
node->next->prev = (list_dl_node_s*)&list->head_sentinel;
list->size--;
#ifdef DEBUG
assert(list->head_sentinel.next->prev == (list_dl_node_s*)&list->head_sentinel);
#endif
return node;
}
else
{
return NULL;
}
}
/**
* Remove the last item from the list.
* Deletes the node but not the data.
* The data is returned.
*
* @param list
* @return the data or NULL if the list is empty
*/
static inline void*
list_dl_remove_last(list_dl_s *list)
{
if(list->size > 0)
{
#ifdef DEBUG
assert(list->head_sentinel.next != (list_dl_node_s*)&list->tail_sentinel);
assert(list->tail_sentinel.prev != (list_dl_node_s*)&list->head_sentinel);
assert(list->head_sentinel.next != NULL);
assert(list->tail_sentinel.prev != NULL);
#endif
list_dl_node_s *node = list->tail_sentinel.prev;
list->tail_sentinel.prev = node->prev;
node->prev->next = (list_dl_node_s*)&list->tail_sentinel;
list->size--;
void *data = node->data;
ZFREE(node, list_dl_node_s);
#ifdef DEBUG
assert(list->tail_sentinel.prev->next == (list_dl_node_s*)&list->tail_sentinel);
#endif
return data;
}
else
{
return NULL;
}
}
static inline list_dl_node_s *
list_dl_remove_last_node(list_dl_s *list)
{
if(list->size > 0)
{
#ifdef DEBUG
assert(list->head_sentinel.next != (list_dl_node_s*)&list->tail_sentinel);
assert(list->tail_sentinel.prev != (list_dl_node_s*)&list->head_sentinel);
assert(list->head_sentinel.next != NULL);
assert(list->tail_sentinel.prev != NULL);
#endif
list_dl_node_s *node = list->tail_sentinel.prev;
list->tail_sentinel.prev = node->prev;
node->prev->next = (list_dl_node_s*)&list->tail_sentinel;
list->size--;
#ifdef DEBUG
assert(list->tail_sentinel.prev->next == (list_dl_node_s*)&list->tail_sentinel);
#endif
return node;
}
else
{
return NULL;
}
}
/**
* Enqueues the item in the list, seen as a queue.
*
* @param list
* @param data
*/
static inline void
list_dl_enqueue(list_dl_s *list, void *data)
{
list_dl_insert(list, data);
}
/**
* Dequeues the item from the list, seen as a queue.
*
* @param list
* @return an item or NULL if the list/queue is empty
*/
static inline void*
list_dl_dequeue(list_dl_s *list)
{
void *data = list_dl_remove_last(list);
return data;
}
/**
* Remove the first item that points to data;
*
* @param list
* @param data
* @return TRUE if an item has been deleted
*/
bool list_dl_remove(list_dl_s *list, const void *data);
/**
* Remove the first item for which the match does not returns 0.
*
* @param list
* @param match a callback function called with the data and args
* @param args
* @return
*/
bool list_dl_remove_matching(list_dl_s *list, result_callback_function *match, void *args);
/**
* Remove all the items for which the match does not returns 0.
*
* @param list
* @param match a callback function called with the data and args
* @param args
* @return
*/
bool list_dl_remove_all_matching(list_dl_s *list, result_callback_function *match, void *args);
/**
* Remove all items from the list.
* Deletes the nodes but not the data.
*
* @param list
*/
void list_dl_clear(list_dl_s *list);
/**
* Iterates through the items of the function, calling the comparator.
*
* The comparator must return:
*
* COLLECTION_ITEM_SKIP : go to next item
* COLLECTION_ITEM_STOP : stop processing, return NULL
* COLLECTION_ITEM_PROCESS_THEN_STOP : stop processing, return node data
*
* @param list
* @param comparator
*
* @return a matching node or NULL
*/
void *list_dl_search(list_dl_s *list, result_callback_function *comparator, void *parm);
/**
*
* Returns the index of that specific pointer into the list
* Linear search (slow)
*
* @param list
* @param comparator
* @return
*/
ya_result list_dl_indexof(list_dl_s *list, void *data);
void *list_dl_get(list_dl_s *list, int index);
ya_result list_dl_foreach(list_dl_s *list, result_callback_function *callback, void *caller_data);
/**
* Iterates through the items of the function, calling the comparator.
*
* The comparator must return:
*
* COLLECTION_ITEM_SKIP : go to next item
* COLLECTION_ITEM_PROCESS : delete, then go to next item
* COLLECTION_ITEM_STOP : stop processing
* COLLECTION_ITEM_PROCESS_THEN_STOP : delete, then stop processing
*
* @param list
* @param comparator
*
* @return TRUE if at least one item has been deleted, FALSE otherwise.
*/
bool list_dl_remove_match(list_dl_s *list, result_callback_function *comparator, void *parm);
/**
*
* Returns the size of the list
*
* @param list
* @return the size of the list
*/
static inline u32
list_dl_size(const list_dl_s *list)
{
#ifdef DEBUG
if(list->size == 0)
{
assert(list->head_sentinel.next == (list_dl_node_s*)&list->tail_sentinel);
assert(list->tail_sentinel.prev == (list_dl_node_s*)&list->head_sentinel);
assert(list->head_sentinel.prev == NULL);
assert(list->tail_sentinel.next == NULL);
}
#endif
return list->size;
}
/* ------------------------------------------------------------ */
#endif /* LIST_DL_H_ */
|