1 /*- 2 * Copyright (c) 2010 Isilon Systems, Inc. 3 * Copyright (c) 2010 iX Systems, Inc. 4 * Copyright (c) 2010 Panasas, Inc. 5 * Copyright (c) 2013-2016 Mellanox Technologies, Ltd. 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice unmodified, this list of conditions, and the following 13 * disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 */ 29 #ifndef _LINUXKPI_LINUX_LIST_H_ 30 #define _LINUXKPI_LINUX_LIST_H_ 31 32 #ifndef _STANDALONE 33 /* 34 * Since LIST_HEAD conflicts with the Linux definition we must include any 35 * FreeBSD header which requires it here so it is resolved with the correct 36 * definition prior to the undef. 37 */ 38 #include <linux/types.h> 39 40 #include <sys/param.h> 41 #include <sys/kernel.h> 42 #include <sys/queue.h> 43 #include <sys/cpuset.h> 44 #include <sys/jail.h> 45 #include <sys/lock.h> 46 #include <sys/mutex.h> 47 #include <sys/proc.h> 48 #include <sys/vnode.h> 49 #include <sys/conf.h> 50 #include <sys/socket.h> 51 #include <sys/mbuf.h> 52 53 #include <net/bpf.h> 54 #include <net/ethernet.h> 55 #include <net/if.h> 56 #include <net/if_var.h> 57 #include <net/if_types.h> 58 #include <net/if_media.h> 59 #include <net/vnet.h> 60 61 #include <netinet/in.h> 62 #include <netinet/in_pcb.h> 63 #include <netinet/in_var.h> 64 #include <netinet/tcp_lro.h> 65 66 #include <netinet6/in6_var.h> 67 #include <netinet6/nd6.h> 68 69 #include <net80211/ieee80211.h> 70 #include <net80211/ieee80211_var.h> 71 #include <net80211/ieee80211_node.h> 72 73 #include <vm/vm.h> 74 #include <vm/vm_object.h> 75 #include <vm/pmap.h> 76 #endif 77 78 #ifndef prefetch 79 #define prefetch(x) 80 #endif 81 82 #define LINUX_LIST_HEAD_INIT(name) { &(name), &(name) } 83 84 #define LINUX_LIST_HEAD(name) \ 85 struct list_head name = LINUX_LIST_HEAD_INIT(name) 86 87 static inline void 88 INIT_LIST_HEAD(struct list_head *list) 89 { 90 91 list->next = list->prev = list; 92 } 93 94 static inline int 95 list_empty(const struct list_head *head) 96 { 97 98 return (head->next == head); 99 } 100 101 static inline int 102 list_empty_careful(const struct list_head *head) 103 { 104 struct list_head *next = head->next; 105 106 return ((next == head) && (next == head->prev)); 107 } 108 109 static inline void 110 __list_del(struct list_head *prev, struct list_head *next) 111 { 112 next->prev = prev; 113 WRITE_ONCE(prev->next, next); 114 } 115 116 static inline void 117 __list_del_entry(struct list_head *entry) 118 { 119 120 __list_del(entry->prev, entry->next); 121 } 122 123 static inline void 124 list_del(struct list_head *entry) 125 { 126 127 __list_del(entry->prev, entry->next); 128 } 129 130 static inline void 131 list_replace(struct list_head *old, struct list_head *new) 132 { 133 new->next = old->next; 134 new->next->prev = new; 135 new->prev = old->prev; 136 new->prev->next = new; 137 } 138 139 static inline void 140 list_replace_init(struct list_head *old, struct list_head *new) 141 { 142 list_replace(old, new); 143 INIT_LIST_HEAD(old); 144 } 145 146 static inline void 147 __list_add(struct list_head *new, struct list_head *prev, 148 struct list_head *next) 149 { 150 151 next->prev = new; 152 new->next = next; 153 new->prev = prev; 154 prev->next = new; 155 } 156 157 static inline void 158 list_del_init(struct list_head *entry) 159 { 160 161 list_del(entry); 162 INIT_LIST_HEAD(entry); 163 } 164 165 #define list_entry(ptr, type, field) container_of(ptr, type, field) 166 167 #define list_first_entry(ptr, type, member) \ 168 list_entry((ptr)->next, type, member) 169 170 #define list_last_entry(ptr, type, member) \ 171 list_entry((ptr)->prev, type, member) 172 173 #define list_first_entry_or_null(ptr, type, member) \ 174 (!list_empty(ptr) ? list_first_entry(ptr, type, member) : NULL) 175 176 #define list_next_entry(ptr, member) \ 177 list_entry(((ptr)->member.next), typeof(*(ptr)), member) 178 179 #define list_safe_reset_next(ptr, n, member) \ 180 (n) = list_next_entry(ptr, member) 181 182 #define list_prev_entry(ptr, member) \ 183 list_entry(((ptr)->member.prev), typeof(*(ptr)), member) 184 185 #define list_for_each(p, head) \ 186 for (p = (head)->next; p != (head); p = (p)->next) 187 188 #define list_for_each_safe(p, n, head) \ 189 for (p = (head)->next, n = (p)->next; p != (head); p = n, n = (p)->next) 190 191 #define list_for_each_entry(p, h, field) \ 192 for (p = list_entry((h)->next, typeof(*p), field); &(p)->field != (h); \ 193 p = list_entry((p)->field.next, typeof(*p), field)) 194 195 #define list_for_each_entry_safe(p, n, h, field) \ 196 for (p = list_entry((h)->next, typeof(*p), field), \ 197 n = list_entry((p)->field.next, typeof(*p), field); &(p)->field != (h);\ 198 p = n, n = list_entry(n->field.next, typeof(*n), field)) 199 200 #define list_for_each_entry_from(p, h, field) \ 201 for ( ; &(p)->field != (h); \ 202 p = list_entry((p)->field.next, typeof(*p), field)) 203 204 #define list_for_each_entry_continue(p, h, field) \ 205 for (p = list_next_entry((p), field); &(p)->field != (h); \ 206 p = list_next_entry((p), field)) 207 208 #define list_for_each_entry_safe_from(pos, n, head, member) \ 209 for (n = list_entry((pos)->member.next, typeof(*pos), member); \ 210 &(pos)->member != (head); \ 211 pos = n, n = list_entry(n->member.next, typeof(*n), member)) 212 213 #define list_for_each_entry_reverse(p, h, field) \ 214 for (p = list_entry((h)->prev, typeof(*p), field); &(p)->field != (h); \ 215 p = list_entry((p)->field.prev, typeof(*p), field)) 216 217 #define list_for_each_entry_safe_reverse(p, n, h, field) \ 218 for (p = list_entry((h)->prev, typeof(*p), field), \ 219 n = list_entry((p)->field.prev, typeof(*p), field); &(p)->field != (h); \ 220 p = n, n = list_entry(n->field.prev, typeof(*n), field)) 221 222 #define list_for_each_entry_continue_reverse(p, h, field) \ 223 for (p = list_entry((p)->field.prev, typeof(*p), field); &(p)->field != (h); \ 224 p = list_entry((p)->field.prev, typeof(*p), field)) 225 226 #define list_for_each_prev(p, h) for (p = (h)->prev; p != (h); p = (p)->prev) 227 228 #define list_for_each_prev_safe(p, n, h) \ 229 for (p = (h)->prev, n = (p)->prev; \ 230 p != (h); \ 231 p = n, n = (p)->prev) 232 233 #define list_for_each_entry_from_reverse(p, h, field) \ 234 for (; &p->field != (h); \ 235 p = list_prev_entry(p, field)) 236 237 #define list_for_each_rcu(p, head) \ 238 for (p = rcu_dereference((head)->next); \ 239 p != (head); \ 240 p = rcu_dereference((p)->next)) 241 242 static inline void 243 list_add(struct list_head *new, struct list_head *head) 244 { 245 246 __list_add(new, head, head->next); 247 } 248 249 static inline void 250 list_add_tail(struct list_head *new, struct list_head *head) 251 { 252 253 __list_add(new, head->prev, head); 254 } 255 256 static inline void 257 list_move(struct list_head *list, struct list_head *head) 258 { 259 260 list_del(list); 261 list_add(list, head); 262 } 263 264 static inline void 265 list_move_tail(struct list_head *entry, struct list_head *head) 266 { 267 268 list_del(entry); 269 list_add_tail(entry, head); 270 } 271 272 static inline void 273 list_rotate_to_front(struct list_head *entry, struct list_head *head) 274 { 275 276 list_move_tail(entry, head); 277 } 278 279 static inline void 280 list_bulk_move_tail(struct list_head *head, struct list_head *first, 281 struct list_head *last) 282 { 283 first->prev->next = last->next; 284 last->next->prev = first->prev; 285 head->prev->next = first; 286 first->prev = head->prev; 287 last->next = head; 288 head->prev = last; 289 } 290 291 static inline void 292 linux_list_splice(const struct list_head *list, struct list_head *prev, 293 struct list_head *next) 294 { 295 struct list_head *first; 296 struct list_head *last; 297 298 if (list_empty(list)) 299 return; 300 first = list->next; 301 last = list->prev; 302 first->prev = prev; 303 prev->next = first; 304 last->next = next; 305 next->prev = last; 306 } 307 308 static inline void 309 list_splice(const struct list_head *list, struct list_head *head) 310 { 311 312 linux_list_splice(list, head, head->next); 313 } 314 315 static inline void 316 list_splice_tail(struct list_head *list, struct list_head *head) 317 { 318 319 linux_list_splice(list, head->prev, head); 320 } 321 322 static inline void 323 list_splice_init(struct list_head *list, struct list_head *head) 324 { 325 326 linux_list_splice(list, head, head->next); 327 INIT_LIST_HEAD(list); 328 } 329 330 static inline void 331 list_splice_tail_init(struct list_head *list, struct list_head *head) 332 { 333 334 linux_list_splice(list, head->prev, head); 335 INIT_LIST_HEAD(list); 336 } 337 338 #undef LIST_HEAD 339 #define LIST_HEAD(name) struct list_head name = { &(name), &(name) } 340 341 struct hlist_head { 342 struct hlist_node *first; 343 }; 344 345 struct hlist_node { 346 struct hlist_node *next, **pprev; 347 }; 348 #define HLIST_HEAD_INIT { } 349 #define HLIST_HEAD(name) struct hlist_head name = HLIST_HEAD_INIT 350 #define INIT_HLIST_HEAD(head) (head)->first = NULL 351 #define INIT_HLIST_NODE(node) \ 352 do { \ 353 (node)->next = NULL; \ 354 (node)->pprev = NULL; \ 355 } while (0) 356 357 static inline int 358 hlist_unhashed(const struct hlist_node *h) 359 { 360 361 return !h->pprev; 362 } 363 364 static inline int 365 hlist_empty(const struct hlist_head *h) 366 { 367 368 return !READ_ONCE(h->first); 369 } 370 371 static inline void 372 hlist_del(struct hlist_node *n) 373 { 374 375 WRITE_ONCE(*(n->pprev), n->next); 376 if (n->next != NULL) 377 n->next->pprev = n->pprev; 378 } 379 380 static inline void 381 hlist_del_init(struct hlist_node *n) 382 { 383 384 if (hlist_unhashed(n)) 385 return; 386 hlist_del(n); 387 INIT_HLIST_NODE(n); 388 } 389 390 static inline void 391 hlist_add_head(struct hlist_node *n, struct hlist_head *h) 392 { 393 394 n->next = h->first; 395 if (h->first != NULL) 396 h->first->pprev = &n->next; 397 WRITE_ONCE(h->first, n); 398 n->pprev = &h->first; 399 } 400 401 static inline void 402 hlist_add_before(struct hlist_node *n, struct hlist_node *next) 403 { 404 405 n->pprev = next->pprev; 406 n->next = next; 407 next->pprev = &n->next; 408 WRITE_ONCE(*(n->pprev), n); 409 } 410 411 static inline void 412 hlist_add_behind(struct hlist_node *n, struct hlist_node *prev) 413 { 414 415 n->next = prev->next; 416 WRITE_ONCE(prev->next, n); 417 n->pprev = &prev->next; 418 419 if (n->next != NULL) 420 n->next->pprev = &n->next; 421 } 422 423 static inline void 424 hlist_move_list(struct hlist_head *old, struct hlist_head *new) 425 { 426 427 new->first = old->first; 428 if (new->first) 429 new->first->pprev = &new->first; 430 old->first = NULL; 431 } 432 433 static inline int list_is_singular(const struct list_head *head) 434 { 435 return !list_empty(head) && (head->next == head->prev); 436 } 437 438 static inline void __list_cut_position(struct list_head *list, 439 struct list_head *head, struct list_head *entry) 440 { 441 struct list_head *new_first = entry->next; 442 list->next = head->next; 443 list->next->prev = list; 444 list->prev = entry; 445 entry->next = list; 446 head->next = new_first; 447 new_first->prev = head; 448 } 449 450 static inline void list_cut_position(struct list_head *list, 451 struct list_head *head, struct list_head *entry) 452 { 453 if (list_empty(head)) 454 return; 455 if (list_is_singular(head) && 456 (head->next != entry && head != entry)) 457 return; 458 if (entry == head) 459 INIT_LIST_HEAD(list); 460 else 461 __list_cut_position(list, head, entry); 462 } 463 464 static inline int list_is_first(const struct list_head *list, 465 const struct list_head *head) 466 { 467 468 return (list->prev == head); 469 } 470 471 static inline int list_is_last(const struct list_head *list, 472 const struct list_head *head) 473 { 474 return list->next == head; 475 } 476 477 static inline size_t 478 list_count_nodes(const struct list_head *list) 479 { 480 const struct list_head *lh; 481 size_t count; 482 483 count = 0; 484 list_for_each(lh, list) { 485 count++; 486 } 487 488 return (count); 489 } 490 491 #define hlist_entry(ptr, type, field) container_of(ptr, type, field) 492 493 #define hlist_for_each(p, head) \ 494 for (p = (head)->first; p; p = (p)->next) 495 496 #define hlist_for_each_safe(p, n, head) \ 497 for (p = (head)->first; p && ({ n = (p)->next; 1; }); p = n) 498 499 #define hlist_entry_safe(ptr, type, member) \ 500 ((ptr) ? hlist_entry(ptr, type, member) : NULL) 501 502 #define hlist_for_each_entry(pos, head, member) \ 503 for (pos = hlist_entry_safe((head)->first, typeof(*(pos)), member);\ 504 pos; \ 505 pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member)) 506 507 #define hlist_for_each_entry_continue(pos, member) \ 508 for (pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member); \ 509 (pos); \ 510 pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member)) 511 512 #define hlist_for_each_entry_from(pos, member) \ 513 for (; (pos); \ 514 pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member)) 515 516 #define hlist_for_each_entry_safe(pos, n, head, member) \ 517 for (pos = hlist_entry_safe((head)->first, typeof(*(pos)), member); \ 518 (pos) && ({ n = (pos)->member.next; 1; }); \ 519 pos = hlist_entry_safe(n, typeof(*(pos)), member)) 520 521 #if defined(LINUXKPI_VERSION) && LINUXKPI_VERSION >= 51300 522 extern void list_sort(void *priv, struct list_head *head, int (*cmp)(void *priv, 523 const struct list_head *a, const struct list_head *b)); 524 #else 525 extern void list_sort(void *priv, struct list_head *head, int (*cmp)(void *priv, 526 struct list_head *a, struct list_head *b)); 527 #endif 528 529 #endif /* _LINUXKPI_LINUX_LIST_H_ */ 530