]>
Commit | Line | Data |
---|---|---|
718e3744 | 1 | /* Generic linked list |
2 | * Copyright (C) 1997, 2000 Kunihiro Ishiguro | |
3 | * | |
4 | * This file is part of GNU Zebra. | |
5 | * | |
6 | * GNU Zebra is free software; you can redistribute it and/or modify it | |
7 | * under the terms of the GNU General Public License as published by the | |
8 | * Free Software Foundation; either version 2, or (at your option) any | |
9 | * later version. | |
10 | * | |
11 | * GNU Zebra is distributed in the hope that it will be useful, but | |
12 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
14 | * General Public License for more details. | |
15 | * | |
16 | * You should have received a copy of the GNU General Public License | |
17 | * along with GNU Zebra; see the file COPYING. If not, write to the Free | |
18 | * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA | |
19 | * 02111-1307, USA. | |
20 | */ | |
21 | ||
22 | #ifndef _ZEBRA_LINKLIST_H | |
23 | #define _ZEBRA_LINKLIST_H | |
24 | ||
1eb8ef25 | 25 | /* listnodes must always contain data to be valid. Adding an empty node |
26 | * to a list is invalid | |
27 | */ | |
718e3744 | 28 | struct listnode |
29 | { | |
30 | struct listnode *next; | |
31 | struct listnode *prev; | |
1eb8ef25 | 32 | |
33 | /* private member, use getdata() to retrieve, do not access directly */ | |
718e3744 | 34 | void *data; |
35 | }; | |
36 | ||
37 | struct list | |
38 | { | |
39 | struct listnode *head; | |
40 | struct listnode *tail; | |
1eb8ef25 | 41 | |
a7a9990f | 42 | /* invariant: count is the number of listnodes in the list */ |
718e3744 | 43 | unsigned int count; |
1eb8ef25 | 44 | |
a7a9990f | 45 | /* |
46 | * Returns -1 if val1 < val2, 0 if equal?, 1 if val1 > val2. | |
47 | * Used as definition of sorted for listnode_add_sort | |
48 | */ | |
718e3744 | 49 | int (*cmp) (void *val1, void *val2); |
1eb8ef25 | 50 | |
51 | /* callback to free user-owned data when listnode is deleted. supplying | |
52 | * this callback is very much encouraged! | |
53 | */ | |
718e3744 | 54 | void (*del) (void *val); |
55 | }; | |
56 | ||
54dd6122 JB |
57 | #define listnextnode(X) ((X) ? ((X)->next) : NULL) |
58 | #define listhead(X) ((X) ? ((X)->head) : NULL) | |
59 | #define listtail(X) ((X) ? ((X)->tail) : NULL) | |
718e3744 | 60 | #define listcount(X) ((X)->count) |
61 | #define list_isempty(X) ((X)->head == NULL && (X)->tail == NULL) | |
1eb8ef25 | 62 | #define listgetdata(X) (assert((X)->data != NULL), (X)->data) |
718e3744 | 63 | |
64 | /* Prototypes. */ | |
8cc4198f | 65 | extern struct list *list_new(void); /* encouraged: set list.del callback on new lists */ |
66 | extern void list_free (struct list *); | |
718e3744 | 67 | |
8cc4198f | 68 | extern void listnode_add (struct list *, void *); |
69 | extern void listnode_add_sort (struct list *, void *); | |
a8fd8202 | 70 | extern struct listnode *listnode_add_after (struct list *, struct listnode *, void *); |
b21e9619 | 71 | extern struct listnode *listnode_add_before (struct list *, struct listnode *, void *); |
93559b99 | 72 | extern void listnode_move_to_tail (struct list *, struct listnode *); |
8cc4198f | 73 | extern void listnode_delete (struct list *, void *); |
74 | extern struct listnode *listnode_lookup (struct list *, void *); | |
75 | extern void *listnode_head (struct list *); | |
718e3744 | 76 | |
8cc4198f | 77 | extern void list_delete (struct list *); |
78 | extern void list_delete_all_node (struct list *); | |
718e3744 | 79 | |
80 | /* For ospfd and ospf6d. */ | |
8cc4198f | 81 | extern void list_delete_node (struct list *, struct listnode *); |
718e3744 | 82 | |
83 | /* For ospf_spf.c */ | |
8cc4198f | 84 | extern void list_add_list (struct list *, struct list *); |
718e3744 | 85 | |
1eb8ef25 | 86 | /* List iteration macro. |
87 | * Usage: for (ALL_LIST_ELEMENTS (...) { ... } | |
88 | * It is safe to delete the listnode using this macro. | |
89 | */ | |
90 | #define ALL_LIST_ELEMENTS(list,node,nextnode,data) \ | |
54dd6122 | 91 | (node) = listhead(list), ((data) = NULL); \ |
1eb8ef25 | 92 | (node) != NULL && \ |
a5c851c7 | 93 | ((data) = listgetdata(node),(nextnode) = node->next, 1); \ |
54dd6122 | 94 | (node) = (nextnode), ((data) = NULL) |
1eb8ef25 | 95 | |
96 | /* read-only list iteration macro. | |
97 | * Usage: as per ALL_LIST_ELEMENTS, but not safe to delete the listnode Only | |
98 | * use this macro when it is *immediately obvious* the listnode is not | |
99 | * deleted in the body of the loop. Does not have forward-reference overhead | |
100 | * of previous macro. | |
101 | */ | |
102 | #define ALL_LIST_ELEMENTS_RO(list,node,data) \ | |
54dd6122 | 103 | (node) = listhead(list), ((data) = NULL);\ |
1eb8ef25 | 104 | (node) != NULL && ((data) = listgetdata(node), 1); \ |
54dd6122 | 105 | (node) = listnextnode(node), ((data) = NULL) |
718e3744 | 106 | |
1eb8ef25 | 107 | /* these *do not* cleanup list nodes and referenced data, as the functions |
108 | * do - these macros simply {de,at}tach a listnode from/to a list. | |
109 | */ | |
110 | ||
111 | /* List node attach macro. */ | |
112 | #define LISTNODE_ATTACH(L,N) \ | |
718e3744 | 113 | do { \ |
114 | (N)->prev = (L)->tail; \ | |
de111d75 | 115 | (N)->next = NULL; \ |
718e3744 | 116 | if ((L)->head == NULL) \ |
117 | (L)->head = (N); \ | |
118 | else \ | |
119 | (L)->tail->next = (N); \ | |
120 | (L)->tail = (N); \ | |
071fcedb | 121 | (L)->count++; \ |
718e3744 | 122 | } while (0) |
123 | ||
1eb8ef25 | 124 | /* List node detach macro. */ |
125 | #define LISTNODE_DETACH(L,N) \ | |
718e3744 | 126 | do { \ |
127 | if ((N)->prev) \ | |
128 | (N)->prev->next = (N)->next; \ | |
129 | else \ | |
130 | (L)->head = (N)->next; \ | |
131 | if ((N)->next) \ | |
132 | (N)->next->prev = (N)->prev; \ | |
133 | else \ | |
134 | (L)->tail = (N)->prev; \ | |
071fcedb | 135 | (L)->count--; \ |
718e3744 | 136 | } while (0) |
137 | ||
138 | #endif /* _ZEBRA_LINKLIST_H */ |