list.h 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989
  1. #ifndef _LINUX_LIST_H
  2. #define _LINUX_LIST_H
  3. #ifdef __KERNEL__
  4. #include <linux/stddef.h>
  5. #include <linux/poison.h>
  6. #include <linux/prefetch.h>
  7. #include <asm/system.h>
  8. /*
  9. * Simple doubly linked list implementation.
  10. *
  11. * Some of the internal functions ("__xxx") are useful when
  12. * manipulating whole lists rather than single entries, as
  13. * sometimes we already know the next/prev entries and we can
  14. * generate better code by using them directly rather than
  15. * using the generic single-entry routines.
  16. */
  17. struct list_head {
  18. struct list_head *next, *prev;
  19. };
  20. #define LIST_HEAD_INIT(name) { &(name), &(name) }
  21. #define LIST_HEAD(name) \
  22. struct list_head name = LIST_HEAD_INIT(name)
  23. static inline void INIT_LIST_HEAD(struct list_head *list)
  24. {
  25. list->next = list;
  26. list->prev = list;
  27. }
  28. /*
  29. * Insert a new entry between two known consecutive entries.
  30. *
  31. * This is only for internal list manipulation where we know
  32. * the prev/next entries already!
  33. */
  34. #ifndef CONFIG_DEBUG_LIST
  35. static inline void __list_add(struct list_head *new,
  36. struct list_head *prev,
  37. struct list_head *next)
  38. {
  39. next->prev = new;
  40. new->next = next;
  41. new->prev = prev;
  42. prev->next = new;
  43. }
  44. #else
  45. extern void __list_add(struct list_head *new,
  46. struct list_head *prev,
  47. struct list_head *next);
  48. #endif
  49. /**
  50. * list_add - add a new entry
  51. * @new: new entry to be added
  52. * @head: list head to add it after
  53. *
  54. * Insert a new entry after the specified head.
  55. * This is good for implementing stacks.
  56. */
  57. #ifndef CONFIG_DEBUG_LIST
  58. static inline void list_add(struct list_head *new, struct list_head *head)
  59. {
  60. __list_add(new, head, head->next);
  61. }
  62. #else
  63. extern void list_add(struct list_head *new, struct list_head *head);
  64. #endif
  65. /**
  66. * list_add_tail - add a new entry
  67. * @new: new entry to be added
  68. * @head: list head to add it before
  69. *
  70. * Insert a new entry before the specified head.
  71. * This is useful for implementing queues.
  72. */
  73. static inline void list_add_tail(struct list_head *new, struct list_head *head)
  74. {
  75. __list_add(new, head->prev, head);
  76. }
  77. /*
  78. * Insert a new entry between two known consecutive entries.
  79. *
  80. * This is only for internal list manipulation where we know
  81. * the prev/next entries already!
  82. */
  83. static inline void __list_add_rcu(struct list_head * new,
  84. struct list_head * prev, struct list_head * next)
  85. {
  86. new->next = next;
  87. new->prev = prev;
  88. smp_wmb();
  89. next->prev = new;
  90. prev->next = new;
  91. }
  92. /**
  93. * list_add_rcu - add a new entry to rcu-protected list
  94. * @new: new entry to be added
  95. * @head: list head to add it after
  96. *
  97. * Insert a new entry after the specified head.
  98. * This is good for implementing stacks.
  99. *
  100. * The caller must take whatever precautions are necessary
  101. * (such as holding appropriate locks) to avoid racing
  102. * with another list-mutation primitive, such as list_add_rcu()
  103. * or list_del_rcu(), running on this same list.
  104. * However, it is perfectly legal to run concurrently with
  105. * the _rcu list-traversal primitives, such as
  106. * list_for_each_entry_rcu().
  107. */
  108. static inline void list_add_rcu(struct list_head *new, struct list_head *head)
  109. {
  110. __list_add_rcu(new, head, head->next);
  111. }
  112. /**
  113. * list_add_tail_rcu - add a new entry to rcu-protected list
  114. * @new: new entry to be added
  115. * @head: list head to add it before
  116. *
  117. * Insert a new entry before the specified head.
  118. * This is useful for implementing queues.
  119. *
  120. * The caller must take whatever precautions are necessary
  121. * (such as holding appropriate locks) to avoid racing
  122. * with another list-mutation primitive, such as list_add_tail_rcu()
  123. * or list_del_rcu(), running on this same list.
  124. * However, it is perfectly legal to run concurrently with
  125. * the _rcu list-traversal primitives, such as
  126. * list_for_each_entry_rcu().
  127. */
  128. static inline void list_add_tail_rcu(struct list_head *new,
  129. struct list_head *head)
  130. {
  131. __list_add_rcu(new, head->prev, head);
  132. }
  133. /*
  134. * Delete a list entry by making the prev/next entries
  135. * point to each other.
  136. *
  137. * This is only for internal list manipulation where we know
  138. * the prev/next entries already!
  139. */
  140. static inline void __list_del(struct list_head * prev, struct list_head * next)
  141. {
  142. next->prev = prev;
  143. prev->next = next;
  144. }
  145. /**
  146. * list_del - deletes entry from list.
  147. * @entry: the element to delete from the list.
  148. * Note: list_empty() on entry does not return true after this, the entry is
  149. * in an undefined state.
  150. */
  151. #ifndef CONFIG_DEBUG_LIST
  152. static inline void list_del(struct list_head *entry)
  153. {
  154. __list_del(entry->prev, entry->next);
  155. entry->next = LIST_POISON1;
  156. entry->prev = LIST_POISON2;
  157. }
  158. #else
  159. extern void list_del(struct list_head *entry);
  160. #endif
  161. /**
  162. * list_del_rcu - deletes entry from list without re-initialization
  163. * @entry: the element to delete from the list.
  164. *
  165. * Note: list_empty() on entry does not return true after this,
  166. * the entry is in an undefined state. It is useful for RCU based
  167. * lockfree traversal.
  168. *
  169. * In particular, it means that we can not poison the forward
  170. * pointers that may still be used for walking the list.
  171. *
  172. * The caller must take whatever precautions are necessary
  173. * (such as holding appropriate locks) to avoid racing
  174. * with another list-mutation primitive, such as list_del_rcu()
  175. * or list_add_rcu(), running on this same list.
  176. * However, it is perfectly legal to run concurrently with
  177. * the _rcu list-traversal primitives, such as
  178. * list_for_each_entry_rcu().
  179. *
  180. * Note that the caller is not permitted to immediately free
  181. * the newly deleted entry. Instead, either synchronize_rcu()
  182. * or call_rcu() must be used to defer freeing until an RCU
  183. * grace period has elapsed.
  184. */
  185. static inline void list_del_rcu(struct list_head *entry)
  186. {
  187. __list_del(entry->prev, entry->next);
  188. entry->prev = LIST_POISON2;
  189. }
  190. /**
  191. * list_replace - replace old entry by new one
  192. * @old : the element to be replaced
  193. * @new : the new element to insert
  194. *
  195. * If @old was empty, it will be overwritten.
  196. */
  197. static inline void list_replace(struct list_head *old,
  198. struct list_head *new)
  199. {
  200. new->next = old->next;
  201. new->next->prev = new;
  202. new->prev = old->prev;
  203. new->prev->next = new;
  204. }
  205. static inline void list_replace_init(struct list_head *old,
  206. struct list_head *new)
  207. {
  208. list_replace(old, new);
  209. INIT_LIST_HEAD(old);
  210. }
  211. /**
  212. * list_replace_rcu - replace old entry by new one
  213. * @old : the element to be replaced
  214. * @new : the new element to insert
  215. *
  216. * The @old entry will be replaced with the @new entry atomically.
  217. * Note: @old should not be empty.
  218. */
  219. static inline void list_replace_rcu(struct list_head *old,
  220. struct list_head *new)
  221. {
  222. new->next = old->next;
  223. new->prev = old->prev;
  224. smp_wmb();
  225. new->next->prev = new;
  226. new->prev->next = new;
  227. old->prev = LIST_POISON2;
  228. }
  229. /**
  230. * list_del_init - deletes entry from list and reinitialize it.
  231. * @entry: the element to delete from the list.
  232. */
  233. static inline void list_del_init(struct list_head *entry)
  234. {
  235. __list_del(entry->prev, entry->next);
  236. INIT_LIST_HEAD(entry);
  237. }
  238. /**
  239. * list_move - delete from one list and add as another's head
  240. * @list: the entry to move
  241. * @head: the head that will precede our entry
  242. */
  243. static inline void list_move(struct list_head *list, struct list_head *head)
  244. {
  245. __list_del(list->prev, list->next);
  246. list_add(list, head);
  247. }
  248. /**
  249. * list_move_tail - delete from one list and add as another's tail
  250. * @list: the entry to move
  251. * @head: the head that will follow our entry
  252. */
  253. static inline void list_move_tail(struct list_head *list,
  254. struct list_head *head)
  255. {
  256. __list_del(list->prev, list->next);
  257. list_add_tail(list, head);
  258. }
  259. /**
  260. * list_is_last - tests whether @list is the last entry in list @head
  261. * @list: the entry to test
  262. * @head: the head of the list
  263. */
  264. static inline int list_is_last(const struct list_head *list,
  265. const struct list_head *head)
  266. {
  267. return list->next == head;
  268. }
  269. /**
  270. * list_empty - tests whether a list is empty
  271. * @head: the list to test.
  272. */
  273. static inline int list_empty(const struct list_head *head)
  274. {
  275. return head->next == head;
  276. }
  277. /**
  278. * list_empty_careful - tests whether a list is empty and not being modified
  279. * @head: the list to test
  280. *
  281. * Description:
  282. * tests whether a list is empty _and_ checks that no other CPU might be
  283. * in the process of modifying either member (next or prev)
  284. *
  285. * NOTE: using list_empty_careful() without synchronization
  286. * can only be safe if the only activity that can happen
  287. * to the list entry is list_del_init(). Eg. it cannot be used
  288. * if another CPU could re-list_add() it.
  289. */
  290. static inline int list_empty_careful(const struct list_head *head)
  291. {
  292. struct list_head *next = head->next;
  293. return (next == head) && (next == head->prev);
  294. }
  295. /**
  296. * list_is_singular - tests whether a list has just one entry.
  297. * @head: the list to test.
  298. */
  299. static inline int list_is_singular(const struct list_head *head)
  300. {
  301. return !list_empty(head) && (head->next == head->prev);
  302. }
  303. static inline void __list_splice(const struct list_head *list,
  304. struct list_head *head)
  305. {
  306. struct list_head *first = list->next;
  307. struct list_head *last = list->prev;
  308. struct list_head *at = head->next;
  309. first->prev = head;
  310. head->next = first;
  311. last->next = at;
  312. at->prev = last;
  313. }
  314. /**
  315. * list_splice - join two lists
  316. * @list: the new list to add.
  317. * @head: the place to add it in the first list.
  318. */
  319. static inline void list_splice(const struct list_head *list,
  320. struct list_head *head)
  321. {
  322. if (!list_empty(list))
  323. __list_splice(list, head);
  324. }
  325. /**
  326. * list_splice_init - join two lists and reinitialise the emptied list.
  327. * @list: the new list to add.
  328. * @head: the place to add it in the first list.
  329. *
  330. * The list at @list is reinitialised
  331. */
  332. static inline void list_splice_init(struct list_head *list,
  333. struct list_head *head)
  334. {
  335. if (!list_empty(list)) {
  336. __list_splice(list, head);
  337. INIT_LIST_HEAD(list);
  338. }
  339. }
  340. /**
  341. * list_splice_init_rcu - splice an RCU-protected list into an existing list.
  342. * @list: the RCU-protected list to splice
  343. * @head: the place in the list to splice the first list into
  344. * @sync: function to sync: synchronize_rcu(), synchronize_sched(), ...
  345. *
  346. * @head can be RCU-read traversed concurrently with this function.
  347. *
  348. * Note that this function blocks.
  349. *
  350. * Important note: the caller must take whatever action is necessary to
  351. * prevent any other updates to @head. In principle, it is possible
  352. * to modify the list as soon as sync() begins execution.
  353. * If this sort of thing becomes necessary, an alternative version
  354. * based on call_rcu() could be created. But only if -really-
  355. * needed -- there is no shortage of RCU API members.
  356. */
  357. static inline void list_splice_init_rcu(struct list_head *list,
  358. struct list_head *head,
  359. void (*sync)(void))
  360. {
  361. struct list_head *first = list->next;
  362. struct list_head *last = list->prev;
  363. struct list_head *at = head->next;
  364. if (list_empty(head))
  365. return;
  366. /* "first" and "last" tracking list, so initialize it. */
  367. INIT_LIST_HEAD(list);
  368. /*
  369. * At this point, the list body still points to the source list.
  370. * Wait for any readers to finish using the list before splicing
  371. * the list body into the new list. Any new readers will see
  372. * an empty list.
  373. */
  374. sync();
  375. /*
  376. * Readers are finished with the source list, so perform splice.
  377. * The order is important if the new list is global and accessible
  378. * to concurrent RCU readers. Note that RCU readers are not
  379. * permitted to traverse the prev pointers without excluding
  380. * this function.
  381. */
  382. last->next = at;
  383. smp_wmb();
  384. head->next = first;
  385. first->prev = head;
  386. at->prev = last;
  387. }
  388. /**
  389. * list_entry - get the struct for this entry
  390. * @ptr: the &struct list_head pointer.
  391. * @type: the type of the struct this is embedded in.
  392. * @member: the name of the list_struct within the struct.
  393. */
  394. #define list_entry(ptr, type, member) \
  395. container_of(ptr, type, member)
  396. /**
  397. * list_first_entry - get the first element from a list
  398. * @ptr: the list head to take the element from.
  399. * @type: the type of the struct this is embedded in.
  400. * @member: the name of the list_struct within the struct.
  401. *
  402. * Note, that list is expected to be not empty.
  403. */
  404. #define list_first_entry(ptr, type, member) \
  405. list_entry((ptr)->next, type, member)
  406. /**
  407. * list_for_each - iterate over a list
  408. * @pos: the &struct list_head to use as a loop cursor.
  409. * @head: the head for your list.
  410. */
  411. #define list_for_each(pos, head) \
  412. for (pos = (head)->next; prefetch(pos->next), pos != (head); \
  413. pos = pos->next)
  414. /**
  415. * __list_for_each - iterate over a list
  416. * @pos: the &struct list_head to use as a loop cursor.
  417. * @head: the head for your list.
  418. *
  419. * This variant differs from list_for_each() in that it's the
  420. * simplest possible list iteration code, no prefetching is done.
  421. * Use this for code that knows the list to be very short (empty
  422. * or 1 entry) most of the time.
  423. */
  424. #define __list_for_each(pos, head) \
  425. for (pos = (head)->next; pos != (head); pos = pos->next)
  426. /**
  427. * list_for_each_prev - iterate over a list backwards
  428. * @pos: the &struct list_head to use as a loop cursor.
  429. * @head: the head for your list.
  430. */
  431. #define list_for_each_prev(pos, head) \
  432. for (pos = (head)->prev; prefetch(pos->prev), pos != (head); \
  433. pos = pos->prev)
  434. /**
  435. * list_for_each_safe - iterate over a list safe against removal of list entry
  436. * @pos: the &struct list_head to use as a loop cursor.
  437. * @n: another &struct list_head to use as temporary storage
  438. * @head: the head for your list.
  439. */
  440. #define list_for_each_safe(pos, n, head) \
  441. for (pos = (head)->next, n = pos->next; pos != (head); \
  442. pos = n, n = pos->next)
  443. /**
  444. * list_for_each_prev_safe - iterate over a list backwards safe against removal of list entry
  445. * @pos: the &struct list_head to use as a loop cursor.
  446. * @n: another &struct list_head to use as temporary storage
  447. * @head: the head for your list.
  448. */
  449. #define list_for_each_prev_safe(pos, n, head) \
  450. for (pos = (head)->prev, n = pos->prev; \
  451. prefetch(pos->prev), pos != (head); \
  452. pos = n, n = pos->prev)
  453. /**
  454. * list_for_each_entry - iterate over list of given type
  455. * @pos: the type * to use as a loop cursor.
  456. * @head: the head for your list.
  457. * @member: the name of the list_struct within the struct.
  458. */
  459. #define list_for_each_entry(pos, head, member) \
  460. for (pos = list_entry((head)->next, typeof(*pos), member); \
  461. prefetch(pos->member.next), &pos->member != (head); \
  462. pos = list_entry(pos->member.next, typeof(*pos), member))
  463. /**
  464. * list_for_each_entry_reverse - iterate backwards over list of given type.
  465. * @pos: the type * to use as a loop cursor.
  466. * @head: the head for your list.
  467. * @member: the name of the list_struct within the struct.
  468. */
  469. #define list_for_each_entry_reverse(pos, head, member) \
  470. for (pos = list_entry((head)->prev, typeof(*pos), member); \
  471. prefetch(pos->member.prev), &pos->member != (head); \
  472. pos = list_entry(pos->member.prev, typeof(*pos), member))
  473. /**
  474. * list_prepare_entry - prepare a pos entry for use in list_for_each_entry_continue()
  475. * @pos: the type * to use as a start point
  476. * @head: the head of the list
  477. * @member: the name of the list_struct within the struct.
  478. *
  479. * Prepares a pos entry for use as a start point in list_for_each_entry_continue().
  480. */
  481. #define list_prepare_entry(pos, head, member) \
  482. ((pos) ? : list_entry(head, typeof(*pos), member))
  483. /**
  484. * list_for_each_entry_continue - continue iteration over list of given type
  485. * @pos: the type * to use as a loop cursor.
  486. * @head: the head for your list.
  487. * @member: the name of the list_struct within the struct.
  488. *
  489. * Continue to iterate over list of given type, continuing after
  490. * the current position.
  491. */
  492. #define list_for_each_entry_continue(pos, head, member) \
  493. for (pos = list_entry(pos->member.next, typeof(*pos), member); \
  494. prefetch(pos->member.next), &pos->member != (head); \
  495. pos = list_entry(pos->member.next, typeof(*pos), member))
  496. /**
  497. * list_for_each_entry_continue_reverse - iterate backwards from the given point
  498. * @pos: the type * to use as a loop cursor.
  499. * @head: the head for your list.
  500. * @member: the name of the list_struct within the struct.
  501. *
  502. * Start to iterate over list of given type backwards, continuing after
  503. * the current position.
  504. */
  505. #define list_for_each_entry_continue_reverse(pos, head, member) \
  506. for (pos = list_entry(pos->member.prev, typeof(*pos), member); \
  507. prefetch(pos->member.prev), &pos->member != (head); \
  508. pos = list_entry(pos->member.prev, typeof(*pos), member))
  509. /**
  510. * list_for_each_entry_from - iterate over list of given type from the current point
  511. * @pos: the type * to use as a loop cursor.
  512. * @head: the head for your list.
  513. * @member: the name of the list_struct within the struct.
  514. *
  515. * Iterate over list of given type, continuing from current position.
  516. */
  517. #define list_for_each_entry_from(pos, head, member) \
  518. for (; prefetch(pos->member.next), &pos->member != (head); \
  519. pos = list_entry(pos->member.next, typeof(*pos), member))
  520. /**
  521. * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
  522. * @pos: the type * to use as a loop cursor.
  523. * @n: another type * to use as temporary storage
  524. * @head: the head for your list.
  525. * @member: the name of the list_struct within the struct.
  526. */
  527. #define list_for_each_entry_safe(pos, n, head, member) \
  528. for (pos = list_entry((head)->next, typeof(*pos), member), \
  529. n = list_entry(pos->member.next, typeof(*pos), member); \
  530. &pos->member != (head); \
  531. pos = n, n = list_entry(n->member.next, typeof(*n), member))
  532. /**
  533. * list_for_each_entry_safe_continue
  534. * @pos: the type * to use as a loop cursor.
  535. * @n: another type * to use as temporary storage
  536. * @head: the head for your list.
  537. * @member: the name of the list_struct within the struct.
  538. *
  539. * Iterate over list of given type, continuing after current point,
  540. * safe against removal of list entry.
  541. */
  542. #define list_for_each_entry_safe_continue(pos, n, head, member) \
  543. for (pos = list_entry(pos->member.next, typeof(*pos), member), \
  544. n = list_entry(pos->member.next, typeof(*pos), member); \
  545. &pos->member != (head); \
  546. pos = n, n = list_entry(n->member.next, typeof(*n), member))
  547. /**
  548. * list_for_each_entry_safe_from
  549. * @pos: the type * to use as a loop cursor.
  550. * @n: another type * to use as temporary storage
  551. * @head: the head for your list.
  552. * @member: the name of the list_struct within the struct.
  553. *
  554. * Iterate over list of given type from current point, safe against
  555. * removal of list entry.
  556. */
  557. #define list_for_each_entry_safe_from(pos, n, head, member) \
  558. for (n = list_entry(pos->member.next, typeof(*pos), member); \
  559. &pos->member != (head); \
  560. pos = n, n = list_entry(n->member.next, typeof(*n), member))
  561. /**
  562. * list_for_each_entry_safe_reverse
  563. * @pos: the type * to use as a loop cursor.
  564. * @n: another type * to use as temporary storage
  565. * @head: the head for your list.
  566. * @member: the name of the list_struct within the struct.
  567. *
  568. * Iterate backwards over list of given type, safe against removal
  569. * of list entry.
  570. */
  571. #define list_for_each_entry_safe_reverse(pos, n, head, member) \
  572. for (pos = list_entry((head)->prev, typeof(*pos), member), \
  573. n = list_entry(pos->member.prev, typeof(*pos), member); \
  574. &pos->member != (head); \
  575. pos = n, n = list_entry(n->member.prev, typeof(*n), member))
  576. /**
  577. * list_for_each_rcu - iterate over an rcu-protected list
  578. * @pos: the &struct list_head to use as a loop cursor.
  579. * @head: the head for your list.
  580. *
  581. * This list-traversal primitive may safely run concurrently with
  582. * the _rcu list-mutation primitives such as list_add_rcu()
  583. * as long as the traversal is guarded by rcu_read_lock().
  584. */
  585. #define list_for_each_rcu(pos, head) \
  586. for (pos = rcu_dereference((head)->next); \
  587. prefetch(pos->next), pos != (head); \
  588. pos = rcu_dereference(pos->next))
  589. #define __list_for_each_rcu(pos, head) \
  590. for (pos = rcu_dereference((head)->next); \
  591. pos != (head); \
  592. pos = rcu_dereference(pos->next))
  593. /**
  594. * list_for_each_entry_rcu - iterate over rcu list of given type
  595. * @pos: the type * to use as a loop cursor.
  596. * @head: the head for your list.
  597. * @member: the name of the list_struct within the struct.
  598. *
  599. * This list-traversal primitive may safely run concurrently with
  600. * the _rcu list-mutation primitives such as list_add_rcu()
  601. * as long as the traversal is guarded by rcu_read_lock().
  602. */
  603. #define list_for_each_entry_rcu(pos, head, member) \
  604. for (pos = list_entry(rcu_dereference((head)->next), typeof(*pos), member); \
  605. prefetch(pos->member.next), &pos->member != (head); \
  606. pos = list_entry(rcu_dereference(pos->member.next), typeof(*pos), member))
  607. /**
  608. * list_for_each_continue_rcu
  609. * @pos: the &struct list_head to use as a loop cursor.
  610. * @head: the head for your list.
  611. *
  612. * Iterate over an rcu-protected list, continuing after current point.
  613. *
  614. * This list-traversal primitive may safely run concurrently with
  615. * the _rcu list-mutation primitives such as list_add_rcu()
  616. * as long as the traversal is guarded by rcu_read_lock().
  617. */
  618. #define list_for_each_continue_rcu(pos, head) \
  619. for ((pos) = rcu_dereference((pos)->next); \
  620. prefetch((pos)->next), (pos) != (head); \
  621. (pos) = rcu_dereference((pos)->next))
  622. /*
  623. * Double linked lists with a single pointer list head.
  624. * Mostly useful for hash tables where the two pointer list head is
  625. * too wasteful.
  626. * You lose the ability to access the tail in O(1).
  627. */
  628. struct hlist_head {
  629. struct hlist_node *first;
  630. };
  631. struct hlist_node {
  632. struct hlist_node *next, **pprev;
  633. };
  634. #define HLIST_HEAD_INIT { .first = NULL }
  635. #define HLIST_HEAD(name) struct hlist_head name = { .first = NULL }
  636. #define INIT_HLIST_HEAD(ptr) ((ptr)->first = NULL)
  637. static inline void INIT_HLIST_NODE(struct hlist_node *h)
  638. {
  639. h->next = NULL;
  640. h->pprev = NULL;
  641. }
  642. static inline int hlist_unhashed(const struct hlist_node *h)
  643. {
  644. return !h->pprev;
  645. }
  646. static inline int hlist_empty(const struct hlist_head *h)
  647. {
  648. return !h->first;
  649. }
  650. static inline void __hlist_del(struct hlist_node *n)
  651. {
  652. struct hlist_node *next = n->next;
  653. struct hlist_node **pprev = n->pprev;
  654. *pprev = next;
  655. if (next)
  656. next->pprev = pprev;
  657. }
  658. static inline void hlist_del(struct hlist_node *n)
  659. {
  660. __hlist_del(n);
  661. n->next = LIST_POISON1;
  662. n->pprev = LIST_POISON2;
  663. }
  664. /**
  665. * hlist_del_rcu - deletes entry from hash list without re-initialization
  666. * @n: the element to delete from the hash list.
  667. *
  668. * Note: list_unhashed() on entry does not return true after this,
  669. * the entry is in an undefined state. It is useful for RCU based
  670. * lockfree traversal.
  671. *
  672. * In particular, it means that we can not poison the forward
  673. * pointers that may still be used for walking the hash list.
  674. *
  675. * The caller must take whatever precautions are necessary
  676. * (such as holding appropriate locks) to avoid racing
  677. * with another list-mutation primitive, such as hlist_add_head_rcu()
  678. * or hlist_del_rcu(), running on this same list.
  679. * However, it is perfectly legal to run concurrently with
  680. * the _rcu list-traversal primitives, such as
  681. * hlist_for_each_entry().
  682. */
  683. static inline void hlist_del_rcu(struct hlist_node *n)
  684. {
  685. __hlist_del(n);
  686. n->pprev = LIST_POISON2;
  687. }
  688. static inline void hlist_del_init(struct hlist_node *n)
  689. {
  690. if (!hlist_unhashed(n)) {
  691. __hlist_del(n);
  692. INIT_HLIST_NODE(n);
  693. }
  694. }
  695. /**
  696. * hlist_replace_rcu - replace old entry by new one
  697. * @old : the element to be replaced
  698. * @new : the new element to insert
  699. *
  700. * The @old entry will be replaced with the @new entry atomically.
  701. */
  702. static inline void hlist_replace_rcu(struct hlist_node *old,
  703. struct hlist_node *new)
  704. {
  705. struct hlist_node *next = old->next;
  706. new->next = next;
  707. new->pprev = old->pprev;
  708. smp_wmb();
  709. if (next)
  710. new->next->pprev = &new->next;
  711. *new->pprev = new;
  712. old->pprev = LIST_POISON2;
  713. }
  714. static inline void hlist_add_head(struct hlist_node *n, struct hlist_head *h)
  715. {
  716. struct hlist_node *first = h->first;
  717. n->next = first;
  718. if (first)
  719. first->pprev = &n->next;
  720. h->first = n;
  721. n->pprev = &h->first;
  722. }
  723. /**
  724. * hlist_add_head_rcu
  725. * @n: the element to add to the hash list.
  726. * @h: the list to add to.
  727. *
  728. * Description:
  729. * Adds the specified element to the specified hlist,
  730. * while permitting racing traversals.
  731. *
  732. * The caller must take whatever precautions are necessary
  733. * (such as holding appropriate locks) to avoid racing
  734. * with another list-mutation primitive, such as hlist_add_head_rcu()
  735. * or hlist_del_rcu(), running on this same list.
  736. * However, it is perfectly legal to run concurrently with
  737. * the _rcu list-traversal primitives, such as
  738. * hlist_for_each_entry_rcu(), used to prevent memory-consistency
  739. * problems on Alpha CPUs. Regardless of the type of CPU, the
  740. * list-traversal primitive must be guarded by rcu_read_lock().
  741. */
  742. static inline void hlist_add_head_rcu(struct hlist_node *n,
  743. struct hlist_head *h)
  744. {
  745. struct hlist_node *first = h->first;
  746. n->next = first;
  747. n->pprev = &h->first;
  748. smp_wmb();
  749. if (first)
  750. first->pprev = &n->next;
  751. h->first = n;
  752. }
  753. /* next must be != NULL */
  754. static inline void hlist_add_before(struct hlist_node *n,
  755. struct hlist_node *next)
  756. {
  757. n->pprev = next->pprev;
  758. n->next = next;
  759. next->pprev = &n->next;
  760. *(n->pprev) = n;
  761. }
  762. static inline void hlist_add_after(struct hlist_node *n,
  763. struct hlist_node *next)
  764. {
  765. next->next = n->next;
  766. n->next = next;
  767. next->pprev = &n->next;
  768. if(next->next)
  769. next->next->pprev = &next->next;
  770. }
  771. /**
  772. * hlist_add_before_rcu
  773. * @n: the new element to add to the hash list.
  774. * @next: the existing element to add the new element before.
  775. *
  776. * Description:
  777. * Adds the specified element to the specified hlist
  778. * before the specified node while permitting racing traversals.
  779. *
  780. * The caller must take whatever precautions are necessary
  781. * (such as holding appropriate locks) to avoid racing
  782. * with another list-mutation primitive, such as hlist_add_head_rcu()
  783. * or hlist_del_rcu(), running on this same list.
  784. * However, it is perfectly legal to run concurrently with
  785. * the _rcu list-traversal primitives, such as
  786. * hlist_for_each_entry_rcu(), used to prevent memory-consistency
  787. * problems on Alpha CPUs.
  788. */
  789. static inline void hlist_add_before_rcu(struct hlist_node *n,
  790. struct hlist_node *next)
  791. {
  792. n->pprev = next->pprev;
  793. n->next = next;
  794. smp_wmb();
  795. next->pprev = &n->next;
  796. *(n->pprev) = n;
  797. }
  798. /**
  799. * hlist_add_after_rcu
  800. * @prev: the existing element to add the new element after.
  801. * @n: the new element to add to the hash list.
  802. *
  803. * Description:
  804. * Adds the specified element to the specified hlist
  805. * after the specified node while permitting racing traversals.
  806. *
  807. * The caller must take whatever precautions are necessary
  808. * (such as holding appropriate locks) to avoid racing
  809. * with another list-mutation primitive, such as hlist_add_head_rcu()
  810. * or hlist_del_rcu(), running on this same list.
  811. * However, it is perfectly legal to run concurrently with
  812. * the _rcu list-traversal primitives, such as
  813. * hlist_for_each_entry_rcu(), used to prevent memory-consistency
  814. * problems on Alpha CPUs.
  815. */
  816. static inline void hlist_add_after_rcu(struct hlist_node *prev,
  817. struct hlist_node *n)
  818. {
  819. n->next = prev->next;
  820. n->pprev = &prev->next;
  821. smp_wmb();
  822. prev->next = n;
  823. if (n->next)
  824. n->next->pprev = &n->next;
  825. }
  826. #define hlist_entry(ptr, type, member) container_of(ptr,type,member)
  827. #define hlist_for_each(pos, head) \
  828. for (pos = (head)->first; pos && ({ prefetch(pos->next); 1; }); \
  829. pos = pos->next)
  830. #define hlist_for_each_safe(pos, n, head) \
  831. for (pos = (head)->first; pos && ({ n = pos->next; 1; }); \
  832. pos = n)
  833. /**
  834. * hlist_for_each_entry - iterate over list of given type
  835. * @tpos: the type * to use as a loop cursor.
  836. * @pos: the &struct hlist_node to use as a loop cursor.
  837. * @head: the head for your list.
  838. * @member: the name of the hlist_node within the struct.
  839. */
  840. #define hlist_for_each_entry(tpos, pos, head, member) \
  841. for (pos = (head)->first; \
  842. pos && ({ prefetch(pos->next); 1;}) && \
  843. ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
  844. pos = pos->next)
  845. /**
  846. * hlist_for_each_entry_continue - iterate over a hlist continuing after current point
  847. * @tpos: the type * to use as a loop cursor.
  848. * @pos: the &struct hlist_node to use as a loop cursor.
  849. * @member: the name of the hlist_node within the struct.
  850. */
  851. #define hlist_for_each_entry_continue(tpos, pos, member) \
  852. for (pos = (pos)->next; \
  853. pos && ({ prefetch(pos->next); 1;}) && \
  854. ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
  855. pos = pos->next)
  856. /**
  857. * hlist_for_each_entry_from - iterate over a hlist continuing from current point
  858. * @tpos: the type * to use as a loop cursor.
  859. * @pos: the &struct hlist_node to use as a loop cursor.
  860. * @member: the name of the hlist_node within the struct.
  861. */
  862. #define hlist_for_each_entry_from(tpos, pos, member) \
  863. for (; pos && ({ prefetch(pos->next); 1;}) && \
  864. ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
  865. pos = pos->next)
  866. /**
  867. * hlist_for_each_entry_safe - iterate over list of given type safe against removal of list entry
  868. * @tpos: the type * to use as a loop cursor.
  869. * @pos: the &struct hlist_node to use as a loop cursor.
  870. * @n: another &struct hlist_node to use as temporary storage
  871. * @head: the head for your list.
  872. * @member: the name of the hlist_node within the struct.
  873. */
  874. #define hlist_for_each_entry_safe(tpos, pos, n, head, member) \
  875. for (pos = (head)->first; \
  876. pos && ({ n = pos->next; 1; }) && \
  877. ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
  878. pos = n)
  879. /**
  880. * hlist_for_each_entry_rcu - iterate over rcu list of given type
  881. * @tpos: the type * to use as a loop cursor.
  882. * @pos: the &struct hlist_node to use as a loop cursor.
  883. * @head: the head for your list.
  884. * @member: the name of the hlist_node within the struct.
  885. *
  886. * This list-traversal primitive may safely run concurrently with
  887. * the _rcu list-mutation primitives such as hlist_add_head_rcu()
  888. * as long as the traversal is guarded by rcu_read_lock().
  889. */
  890. #define hlist_for_each_entry_rcu(tpos, pos, head, member) \
  891. for (pos = rcu_dereference((head)->first); \
  892. pos && ({ prefetch(pos->next); 1;}) && \
  893. ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
  894. pos = rcu_dereference(pos->next))
  895. #else
  896. #warning "don't include kernel headers in userspace"
  897. #endif /* __KERNEL__ */
  898. #endif