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 static inline void 238 list_add(struct list_head *new, struct list_head *head) 239 { 240 241 __list_add(new, head, head->next); 242 } 243 244 static inline void 245 list_add_tail(struct list_head *new, struct list_head *head) 246 { 247 248 __list_add(new, head->prev, head); 249 } 250 251 static inline void 252 list_move(struct list_head *list, struct list_head *head) 253 { 254 255 list_del(list); 256 list_add(list, head); 257 } 258 259 static inline void 260 list_move_tail(struct list_head *entry, struct list_head *head) 261 { 262 263 list_del(entry); 264 list_add_tail(entry, head); 265 } 266 267 static inline void 268 list_rotate_to_front(struct list_head *entry, struct list_head *head) 269 { 270 271 list_move_tail(entry, head); 272 } 273 274 static inline void 275 list_bulk_move_tail(struct list_head *head, struct list_head *first, 276 struct list_head *last) 277 { 278 first->prev->next = last->next; 279 last->next->prev = first->prev; 280 head->prev->next = first; 281 first->prev = head->prev; 282 last->next = head; 283 head->prev = last; 284 } 285 286 static inline void 287 linux_list_splice(const struct list_head *list, struct list_head *prev, 288 struct list_head *next) 289 { 290 struct list_head *first; 291 struct list_head *last; 292 293 if (list_empty(list)) 294 return; 295 first = list->next; 296 last = list->prev; 297 first->prev = prev; 298 prev->next = first; 299 last->next = next; 300 next->prev = last; 301 } 302 303 static inline void 304 list_splice(const struct list_head *list, struct list_head *head) 305 { 306 307 linux_list_splice(list, head, head->next); 308 } 309 310 static inline void 311 list_splice_tail(struct list_head *list, struct list_head *head) 312 { 313 314 linux_list_splice(list, head->prev, head); 315 } 316 317 static inline void 318 list_splice_init(struct list_head *list, struct list_head *head) 319 { 320 321 linux_list_splice(list, head, head->next); 322 INIT_LIST_HEAD(list); 323 } 324 325 static inline void 326 list_splice_tail_init(struct list_head *list, struct list_head *head) 327 { 328 329 linux_list_splice(list, head->prev, head); 330 INIT_LIST_HEAD(list); 331 } 332 333 #undef LIST_HEAD 334 #define LIST_HEAD(name) struct list_head name = { &(name), &(name) } 335 336 struct hlist_head { 337 struct hlist_node *first; 338 }; 339 340 struct hlist_node { 341 struct hlist_node *next, **pprev; 342 }; 343 #define HLIST_HEAD_INIT { } 344 #define HLIST_HEAD(name) struct hlist_head name = HLIST_HEAD_INIT 345 #define INIT_HLIST_HEAD(head) (head)->first = NULL 346 #define INIT_HLIST_NODE(node) \ 347 do { \ 348 (node)->next = NULL; \ 349 (node)->pprev = NULL; \ 350 } while (0) 351 352 static inline int 353 hlist_unhashed(const struct hlist_node *h) 354 { 355 356 return !h->pprev; 357 } 358 359 static inline int 360 hlist_empty(const struct hlist_head *h) 361 { 362 363 return !READ_ONCE(h->first); 364 } 365 366 static inline void 367 hlist_del(struct hlist_node *n) 368 { 369 370 WRITE_ONCE(*(n->pprev), n->next); 371 if (n->next != NULL) 372 n->next->pprev = n->pprev; 373 } 374 375 static inline void 376 hlist_del_init(struct hlist_node *n) 377 { 378 379 if (hlist_unhashed(n)) 380 return; 381 hlist_del(n); 382 INIT_HLIST_NODE(n); 383 } 384 385 static inline void 386 hlist_add_head(struct hlist_node *n, struct hlist_head *h) 387 { 388 389 n->next = h->first; 390 if (h->first != NULL) 391 h->first->pprev = &n->next; 392 WRITE_ONCE(h->first, n); 393 n->pprev = &h->first; 394 } 395 396 static inline void 397 hlist_add_before(struct hlist_node *n, struct hlist_node *next) 398 { 399 400 n->pprev = next->pprev; 401 n->next = next; 402 next->pprev = &n->next; 403 WRITE_ONCE(*(n->pprev), n); 404 } 405 406 static inline void 407 hlist_add_behind(struct hlist_node *n, struct hlist_node *prev) 408 { 409 410 n->next = prev->next; 411 WRITE_ONCE(prev->next, n); 412 n->pprev = &prev->next; 413 414 if (n->next != NULL) 415 n->next->pprev = &n->next; 416 } 417 418 static inline void 419 hlist_move_list(struct hlist_head *old, struct hlist_head *new) 420 { 421 422 new->first = old->first; 423 if (new->first) 424 new->first->pprev = &new->first; 425 old->first = NULL; 426 } 427 428 static inline int list_is_singular(const struct list_head *head) 429 { 430 return !list_empty(head) && (head->next == head->prev); 431 } 432 433 static inline void __list_cut_position(struct list_head *list, 434 struct list_head *head, struct list_head *entry) 435 { 436 struct list_head *new_first = entry->next; 437 list->next = head->next; 438 list->next->prev = list; 439 list->prev = entry; 440 entry->next = list; 441 head->next = new_first; 442 new_first->prev = head; 443 } 444 445 static inline void list_cut_position(struct list_head *list, 446 struct list_head *head, struct list_head *entry) 447 { 448 if (list_empty(head)) 449 return; 450 if (list_is_singular(head) && 451 (head->next != entry && head != entry)) 452 return; 453 if (entry == head) 454 INIT_LIST_HEAD(list); 455 else 456 __list_cut_position(list, head, entry); 457 } 458 459 static inline int list_is_first(const struct list_head *list, 460 const struct list_head *head) 461 { 462 463 return (list->prev == head); 464 } 465 466 static inline int list_is_last(const struct list_head *list, 467 const struct list_head *head) 468 { 469 return list->next == head; 470 } 471 472 static inline size_t 473 list_count_nodes(const struct list_head *list) 474 { 475 const struct list_head *lh; 476 size_t count; 477 478 count = 0; 479 list_for_each(lh, list) { 480 count++; 481 } 482 483 return (count); 484 } 485 486 #define hlist_entry(ptr, type, field) container_of(ptr, type, field) 487 488 #define hlist_for_each(p, head) \ 489 for (p = (head)->first; p; p = (p)->next) 490 491 #define hlist_for_each_safe(p, n, head) \ 492 for (p = (head)->first; p && ({ n = (p)->next; 1; }); p = n) 493 494 #define hlist_entry_safe(ptr, type, member) \ 495 ((ptr) ? hlist_entry(ptr, type, member) : NULL) 496 497 #define hlist_for_each_entry(pos, head, member) \ 498 for (pos = hlist_entry_safe((head)->first, typeof(*(pos)), member);\ 499 pos; \ 500 pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member)) 501 502 #define hlist_for_each_entry_continue(pos, member) \ 503 for (pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member); \ 504 (pos); \ 505 pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member)) 506 507 #define hlist_for_each_entry_from(pos, member) \ 508 for (; (pos); \ 509 pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member)) 510 511 #define hlist_for_each_entry_safe(pos, n, head, member) \ 512 for (pos = hlist_entry_safe((head)->first, typeof(*(pos)), member); \ 513 (pos) && ({ n = (pos)->member.next; 1; }); \ 514 pos = hlist_entry_safe(n, typeof(*(pos)), member)) 515 516 #if defined(LINUXKPI_VERSION) && LINUXKPI_VERSION >= 51300 517 extern void list_sort(void *priv, struct list_head *head, int (*cmp)(void *priv, 518 const struct list_head *a, const struct list_head *b)); 519 #else 520 extern void list_sort(void *priv, struct list_head *head, int (*cmp)(void *priv, 521 struct list_head *a, struct list_head *b)); 522 #endif 523 524 #endif /* _LINUXKPI_LINUX_LIST_H_ */ 525