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
|
/* General queue data structure for GDB, the GNU debugger.
Copyright (C) 2012-2015 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#ifndef QUEUE_H
#define QUEUE_H
/* These macros implement functions and structs for a general queue.
Macro 'DEFINE_QUEUE_P(TYPEDEF)' is to define the new queue type for
TYPEDEF', and macro 'DECLARE_QUEUE_P' is to declare external queue
APIs. The character P indicates TYPEDEF is a pointer (P). The
counterpart on object (O) and integer (I) are not implemented.
An example of their use would be,
typedef struct foo
{} *foo_p;
DEFINE_QUEUE_P (foo_p);
// A pointer to a queue of foo pointers. FOO_XFREE is a destructor
// function for foo instances in queue.
QUEUE(foo_p) *foo_queue = QUEUE_alloc (foo_p, foo_xfree);
foo_p foo_var_p;
// Enqueue and Dequeue
QUEUE_enque (foo_p, foo_queue, foo_var_p);
foo_var_p = QUEUE_deque (foo_p, foo_queue);
static int visit_foo (QUEUE (foo_p) *q, QUEUE_ITER (foo_p) *iter,
foo_p f, void *data)
{
return 1;
}
// Iterate over queue.
QUEUE_iterate (foo_p, foo_queue, visit_foo, ¶m);
QUEUE_free (foo_p, foo_queue); // Free queue. */
/* Typical enqueue operation. Put V into queue Q. */
#define QUEUE_enque(TYPE, Q, V) queue_ ## TYPE ## _enque ((Q), (V))
/* Typical dequeue operation. Return head element of queue Q and
remove it. Q must not be empty. */
#define QUEUE_deque(TYPE, Q) queue_ ## TYPE ## _deque (Q)
/* Return the head element, but don't remove it from the queue.
Q must not be empty. */
#define QUEUE_peek(TYPE, Q) queue_ ## TYPE ## _peek (Q)
/* Return true if queue Q is empty. */
#define QUEUE_is_empty(TYPE, Q) queue_ ## TYPE ## _is_empty (Q)
/* Allocate memory for queue. FREE_FUNC is a function to release the
data put in each queue element. */
#define QUEUE_alloc(TYPE, FREE_FUNC) queue_ ## TYPE ## _alloc (FREE_FUNC)
/* Length of queue Q. */
#define QUEUE_length(TYPE, Q) queue_ ## TYPE ## _length (Q)
/* Free queue Q. Q's free_func is called once for each element. */
#define QUEUE_free(TYPE, Q) queue_ ## TYPE ## _free (Q)
/* Iterate over elements in the queue Q and call function OPERATE on
each element. It is allowed to remove element by OPERATE. OPERATE
returns false to terminate the iteration and true to continue the
iteration. Return false if iteration is terminated by function
OPERATE, otherwise return true. */
#define QUEUE_iterate(TYPE, Q, OPERATE, PARAM) \
queue_ ## TYPE ## _iterate ((Q), (OPERATE), (PARAM))
/* Remove the element per the state of iterator ITER from queue Q.
Leave the caller to release the data in the queue element. */
#define QUEUE_remove_elem(TYPE, Q, ITER) \
queue_ ## TYPE ## _remove_elem ((Q), (ITER))
/* Define a new queue implementation. */
#define QUEUE(TYPE) struct queue_ ## TYPE
#define QUEUE_ELEM(TYPE) struct queue_elem_ ## TYPE
#define QUEUE_ITER(TYPE) struct queue_iter_ ## TYPE
#define QUEUE_ITER_FUNC(TYPE) queue_ ## TYPE ## _operate_func
#define DEFINE_QUEUE_P(TYPE) \
QUEUE_ELEM (TYPE) \
{ \
QUEUE_ELEM (TYPE) *next; \
\
TYPE data; \
}; \
\
/* Queue iterator. */ \
QUEUE_ITER (TYPE) \
{ \
/* The current element during traverse. */ \
QUEUE_ELEM (TYPE) *p; \
/* The previous element of P. */ \
QUEUE_ELEM (TYPE) *prev; \
}; \
\
QUEUE(TYPE) \
{ \
/* The head and tail of the queue. */ \
QUEUE_ELEM (TYPE) *head; \
QUEUE_ELEM (TYPE) *tail; \
/* Function to release the data put in each \
queue element. */ \
void (*free_func) (TYPE); \
}; \
\
void \
queue_ ## TYPE ## _enque (QUEUE (TYPE) *q, TYPE v) \
{ \
QUEUE_ELEM (TYPE) *p = XNEW (QUEUE_ELEM (TYPE)); \
\
gdb_assert (q != NULL); \
p->data = v; \
p->next = NULL; \
if (q->tail == NULL) \
{ \
q->tail = p; \
q->head = p; \
} \
else \
{ \
q->tail->next = p; \
q->tail = p; \
} \
} \
\
TYPE \
queue_ ## TYPE ## _deque (QUEUE (TYPE) *q) \
{ \
QUEUE_ELEM (TYPE) *p; \
TYPE v; \
\
gdb_assert (q != NULL); \
p = q->head; \
gdb_assert (p != NULL); \
\
if (q->head == q->tail) \
{ \
q->head = NULL; \
q->tail = NULL; \
} \
else \
q->head = q->head->next; \
\
v = p->data; \
\
xfree (p); \
return v; \
} \
\
TYPE \
queue_ ## TYPE ## _peek (QUEUE (TYPE) *q) \
{ \
gdb_assert (q != NULL); \
gdb_assert (q->head != NULL); \
return q->head->data; \
} \
\
int \
queue_ ## TYPE ## _is_empty (QUEUE (TYPE) *q) \
{ \
gdb_assert (q != NULL); \
return q->head == NULL; \
} \
\
void \
queue_ ## TYPE ## _remove_elem (QUEUE (TYPE) *q, \
QUEUE_ITER (TYPE) *iter) \
{ \
gdb_assert (q != NULL); \
gdb_assert (iter != NULL && iter->p != NULL); \
\
if (iter->p == q->head || iter->p == q->tail) \
{ \
if (iter->p == q->head) \
q->head = iter->p->next; \
if (iter->p == q->tail) \
q->tail = iter->prev; \
} \
else \
iter->prev->next = iter->p->next; \
\
xfree (iter->p); \
/* Indicate that ITER->p has been deleted from QUEUE q. */ \
iter->p = NULL; \
} \
\
int \
queue_ ## TYPE ## _iterate (QUEUE (TYPE) *q, \
QUEUE_ITER_FUNC (TYPE) operate, \
void *data) \
{ \
QUEUE_ELEM (TYPE) *next = NULL; \
QUEUE_ITER (TYPE) iter = { NULL, NULL }; \
\
gdb_assert (q != NULL); \
\
for (iter.p = q->head; iter.p != NULL; iter.p = next) \
{ \
next = iter.p->next; \
if (!operate (q, &iter, iter.p->data, data)) \
return 0; \
/* ITER.P was not deleted by function OPERATE. */ \
if (iter.p != NULL) \
iter.prev = iter.p; \
} \
return 1; \
} \
\
QUEUE (TYPE) * \
queue_ ## TYPE ## _alloc (void (*free_func) (TYPE)) \
{ \
QUEUE (TYPE) *q = XNEW (QUEUE (TYPE)); \
\
q->head = NULL; \
q->tail = NULL; \
q->free_func = free_func; \
return q; \
} \
\
int \
queue_ ## TYPE ## _length (QUEUE (TYPE) *q) \
{ \
QUEUE_ELEM (TYPE) *p; \
int len = 0; \
\
gdb_assert (q != NULL); \
\
for (p = q->head; p != NULL; p = p->next) \
len++; \
\
return len; \
} \
\
void \
queue_ ## TYPE ## _free (QUEUE (TYPE) *q) \
{ \
QUEUE_ELEM (TYPE) *p, *next; \
\
gdb_assert (q != NULL); \
\
for (p = q->head; p != NULL; p = next) \
{ \
next = p->next; \
if (q->free_func) \
q->free_func (p->data); \
xfree (p); \
} \
xfree (q); \
} \
/* External declarations for queue functions. */
#define DECLARE_QUEUE_P(TYPE) \
QUEUE (TYPE); \
QUEUE_ELEM (TYPE); \
QUEUE_ITER (TYPE); \
extern void \
queue_ ## TYPE ## _enque (QUEUE (TYPE) *q, TYPE v); \
extern TYPE \
queue_ ## TYPE ## _deque (QUEUE (TYPE) *q); \
extern int queue_ ## TYPE ## _is_empty (QUEUE (TYPE) *q); \
extern QUEUE (TYPE) * \
queue_ ## TYPE ## _alloc (void (*free_func) (TYPE)); \
extern int queue_ ## TYPE ## _length (QUEUE (TYPE) *q); \
extern TYPE \
queue_ ## TYPE ## _peek (QUEUE (TYPE) *q); \
extern void queue_ ## TYPE ## _free (QUEUE (TYPE) *q); \
typedef int QUEUE_ITER_FUNC(TYPE) (QUEUE (TYPE) *, \
QUEUE_ITER (TYPE) *, \
TYPE, \
void *); \
extern int \
queue_ ## TYPE ## _iterate (QUEUE (TYPE) *q, \
QUEUE_ITER_FUNC (TYPE) operate, \
void *); \
extern void \
queue_ ## TYPE ## _remove_elem (QUEUE (TYPE) *q, \
QUEUE_ITER (TYPE) *iter); \
#endif /* QUEUE_H */
|