list.h 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998
  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. static inline void __list_splice(struct list_head *list,
  296. struct list_head *head)
  297. {
  298. struct list_head *first = list->next;
  299. struct list_head *last = list->prev;
  300. struct list_head *at = head->next;
  301. first->prev = head;
  302. head->next = first;
  303. last->next = at;
  304. at->prev = last;
  305. }
  306. /**
  307. * list_splice - join two lists
  308. * @list: the new list to add.
  309. * @head: the place to add it in the first list.
  310. */
  311. static inline void list_splice(struct list_head *list, struct list_head *head)
  312. {
  313. if (!list_empty(list))
  314. __list_splice(list, head);
  315. }
  316. /**
  317. * list_splice_init - join two lists and reinitialise the emptied list.
  318. * @list: the new list to add.
  319. * @head: the place to add it in the first list.
  320. *
  321. * The list at @list is reinitialised
  322. */
  323. static inline void list_splice_init(struct list_head *list,
  324. struct list_head *head)
  325. {
  326. if (!list_empty(list)) {
  327. __list_splice(list, head);
  328. INIT_LIST_HEAD(list);
  329. }
  330. }
  331. /**
  332. * list_splice_init_rcu - splice an RCU-protected list into an existing list.
  333. * @list: the RCU-protected list to splice
  334. * @head: the place in the list to splice the first list into
  335. * @sync: function to sync: synchronize_rcu(), synchronize_sched(), ...
  336. *
  337. * @head can be RCU-read traversed concurrently with this function.
  338. *
  339. * Note that this function blocks.
  340. *
  341. * Important note: the caller must take whatever action is necessary to
  342. * prevent any other updates to @head. In principle, it is possible
  343. * to modify the list as soon as sync() begins execution.
  344. * If this sort of thing becomes necessary, an alternative version
  345. * based on call_rcu() could be created. But only if -really-
  346. * needed -- there is no shortage of RCU API members.
  347. */
  348. static inline void list_splice_init_rcu(struct list_head *list,
  349. struct list_head *head,
  350. void (*sync)(void))
  351. {
  352. struct list_head *first = list->next;
  353. struct list_head *last = list->prev;
  354. struct list_head *at = head->next;
  355. if (list_empty(head))
  356. return;
  357. /* "first" and "last" tracking list, so initialize it. */
  358. INIT_LIST_HEAD(list);
  359. /*
  360. * At this point, the list body still points to the source list.
  361. * Wait for any readers to finish using the list before splicing
  362. * the list body into the new list. Any new readers will see
  363. * an empty list.
  364. */
  365. sync();
  366. /*
  367. * Readers are finished with the source list, so perform splice.
  368. * The order is important if the new list is global and accessible
  369. * to concurrent RCU readers. Note that RCU readers are not
  370. * permitted to traverse the prev pointers without excluding
  371. * this function.
  372. */
  373. last->next = at;
  374. smp_wmb();
  375. head->next = first;
  376. first->prev = head;
  377. at->prev = last;
  378. }
  379. /**
  380. * list_entry - get the struct for this entry
  381. * @ptr: the &struct list_head pointer.
  382. * @type: the type of the struct this is embedded in.
  383. * @member: the name of the list_struct within the struct.
  384. */
  385. #define list_entry(ptr, type, member) \
  386. container_of(ptr, type, member)
  387. /**
  388. * list_first_entry - get the first element from a list
  389. * @ptr: the list head to take the element from.
  390. * @type: the type of the struct this is embedded in.
  391. * @member: the name of the list_struct within the struct.
  392. *
  393. * Note, that list is expected to be not empty.
  394. */
  395. #define list_first_entry(ptr, type, member) \
  396. list_entry((ptr)->next, type, member)
  397. /**
  398. * list_for_each - iterate over a list
  399. * @pos: the &struct list_head to use as a loop cursor.
  400. * @head: the head for your list.
  401. */
  402. #define list_for_each(pos, head) \
  403. for (pos = (head)->next; prefetch(pos->next), pos != (head); \
  404. pos = pos->next)
  405. /**
  406. * __list_for_each - iterate over a list
  407. * @pos: the &struct list_head to use as a loop cursor.
  408. * @head: the head for your list.
  409. *
  410. * This variant differs from list_for_each() in that it's the
  411. * simplest possible list iteration code, no prefetching is done.
  412. * Use this for code that knows the list to be very short (empty
  413. * or 1 entry) most of the time.
  414. */
  415. #define __list_for_each(pos, head) \
  416. for (pos = (head)->next; pos != (head); pos = pos->next)
  417. /**
  418. * list_for_each_prev - iterate over a list backwards
  419. * @pos: the &struct list_head to use as a loop cursor.
  420. * @head: the head for your list.
  421. */
  422. #define list_for_each_prev(pos, head) \
  423. for (pos = (head)->prev; prefetch(pos->prev), pos != (head); \
  424. pos = pos->prev)
  425. /**
  426. * list_for_each_safe - iterate over a list safe against removal of list entry
  427. * @pos: the &struct list_head to use as a loop cursor.
  428. * @n: another &struct list_head to use as temporary storage
  429. * @head: the head for your list.
  430. */
  431. #define list_for_each_safe(pos, n, head) \
  432. for (pos = (head)->next, n = pos->next; pos != (head); \
  433. pos = n, n = pos->next)
  434. /**
  435. * list_for_each_prev_safe - iterate over a list backwards safe against removal
  436. of list entry
  437. * @pos: the &struct list_head to use as a loop cursor.
  438. * @n: another &struct list_head to use as temporary storage
  439. * @head: the head for your list.
  440. */
  441. #define list_for_each_prev_safe(pos, n, head) \
  442. for (pos = (head)->prev, n = pos->prev; \
  443. prefetch(pos->prev), pos != (head); \
  444. pos = n, n = pos->prev)
  445. /**
  446. * list_for_each_entry - iterate over list of given type
  447. * @pos: the type * to use as a loop cursor.
  448. * @head: the head for your list.
  449. * @member: the name of the list_struct within the struct.
  450. */
  451. #define list_for_each_entry(pos, head, member) \
  452. for (pos = list_entry((head)->next, typeof(*pos), member); \
  453. prefetch(pos->member.next), &pos->member != (head); \
  454. pos = list_entry(pos->member.next, typeof(*pos), member))
  455. /**
  456. * list_for_each_entry_reverse - iterate backwards over list of given type.
  457. * @pos: the type * to use as a loop cursor.
  458. * @head: the head for your list.
  459. * @member: the name of the list_struct within the struct.
  460. */
  461. #define list_for_each_entry_reverse(pos, head, member) \
  462. for (pos = list_entry((head)->prev, typeof(*pos), member); \
  463. prefetch(pos->member.prev), &pos->member != (head); \
  464. pos = list_entry(pos->member.prev, typeof(*pos), member))
  465. /**
  466. * list_prepare_entry - prepare a pos entry for use in list_for_each_entry_continue()
  467. * @pos: the type * to use as a start point
  468. * @head: the head of the list
  469. * @member: the name of the list_struct within the struct.
  470. *
  471. * Prepares a pos entry for use as a start point in list_for_each_entry_continue().
  472. */
  473. #define list_prepare_entry(pos, head, member) \
  474. ((pos) ? : list_entry(head, typeof(*pos), member))
  475. /**
  476. * list_for_each_entry_continue - continue iteration over list of given type
  477. * @pos: the type * to use as a loop cursor.
  478. * @head: the head for your list.
  479. * @member: the name of the list_struct within the struct.
  480. *
  481. * Continue to iterate over list of given type, continuing after
  482. * the current position.
  483. */
  484. #define list_for_each_entry_continue(pos, head, member) \
  485. for (pos = list_entry(pos->member.next, typeof(*pos), member); \
  486. prefetch(pos->member.next), &pos->member != (head); \
  487. pos = list_entry(pos->member.next, typeof(*pos), member))
  488. /**
  489. * list_for_each_entry_continue_reverse - iterate backwards from the given point
  490. * @pos: the type * to use as a loop cursor.
  491. * @head: the head for your list.
  492. * @member: the name of the list_struct within the struct.
  493. *
  494. * Start to iterate over list of given type backwards, continuing after
  495. * the current position.
  496. */
  497. #define list_for_each_entry_continue_reverse(pos, head, member) \
  498. for (pos = list_entry(pos->member.prev, typeof(*pos), member); \
  499. prefetch(pos->member.prev), &pos->member != (head); \
  500. pos = list_entry(pos->member.prev, typeof(*pos), member))
  501. /**
  502. * list_for_each_entry_from - iterate over list of given type from the current point
  503. * @pos: the type * to use as a loop cursor.
  504. * @head: the head for your list.
  505. * @member: the name of the list_struct within the struct.
  506. *
  507. * Iterate over list of given type, continuing from current position.
  508. */
  509. #define list_for_each_entry_from(pos, head, member) \
  510. for (; prefetch(pos->member.next), &pos->member != (head); \
  511. pos = list_entry(pos->member.next, typeof(*pos), member))
  512. /**
  513. * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
  514. * @pos: the type * to use as a loop cursor.
  515. * @n: another type * to use as temporary storage
  516. * @head: the head for your list.
  517. * @member: the name of the list_struct within the struct.
  518. */
  519. #define list_for_each_entry_safe(pos, n, head, member) \
  520. for (pos = list_entry((head)->next, typeof(*pos), member), \
  521. n = list_entry(pos->member.next, typeof(*pos), member); \
  522. &pos->member != (head); \
  523. pos = n, n = list_entry(n->member.next, typeof(*n), member))
  524. /**
  525. * list_for_each_entry_safe_continue
  526. * @pos: the type * to use as a loop cursor.
  527. * @n: another type * to use as temporary storage
  528. * @head: the head for your list.
  529. * @member: the name of the list_struct within the struct.
  530. *
  531. * Iterate over list of given type, continuing after current point,
  532. * safe against removal of list entry.
  533. */
  534. #define list_for_each_entry_safe_continue(pos, n, head, member) \
  535. for (pos = list_entry(pos->member.next, typeof(*pos), member), \
  536. n = list_entry(pos->member.next, typeof(*pos), member); \
  537. &pos->member != (head); \
  538. pos = n, n = list_entry(n->member.next, typeof(*n), member))
  539. /**
  540. * list_for_each_entry_safe_from
  541. * @pos: the type * to use as a loop cursor.
  542. * @n: another type * to use as temporary storage
  543. * @head: the head for your list.
  544. * @member: the name of the list_struct within the struct.
  545. *
  546. * Iterate over list of given type from current point, safe against
  547. * removal of list entry.
  548. */
  549. #define list_for_each_entry_safe_from(pos, n, head, member) \
  550. for (n = list_entry(pos->member.next, typeof(*pos), member); \
  551. &pos->member != (head); \
  552. pos = n, n = list_entry(n->member.next, typeof(*n), member))
  553. /**
  554. * list_for_each_entry_safe_reverse
  555. * @pos: the type * to use as a loop cursor.
  556. * @n: another type * to use as temporary storage
  557. * @head: the head for your list.
  558. * @member: the name of the list_struct within the struct.
  559. *
  560. * Iterate backwards over list of given type, safe against removal
  561. * of list entry.
  562. */
  563. #define list_for_each_entry_safe_reverse(pos, n, head, member) \
  564. for (pos = list_entry((head)->prev, typeof(*pos), member), \
  565. n = list_entry(pos->member.prev, typeof(*pos), member); \
  566. &pos->member != (head); \
  567. pos = n, n = list_entry(n->member.prev, typeof(*n), member))
  568. /**
  569. * list_for_each_rcu - iterate over an rcu-protected list
  570. * @pos: the &struct list_head to use as a loop cursor.
  571. * @head: the head for your list.
  572. *
  573. * This list-traversal primitive may safely run concurrently with
  574. * the _rcu list-mutation primitives such as list_add_rcu()
  575. * as long as the traversal is guarded by rcu_read_lock().
  576. */
  577. #define list_for_each_rcu(pos, head) \
  578. for (pos = (head)->next; \
  579. prefetch(rcu_dereference(pos)->next), pos != (head); \
  580. pos = pos->next)
  581. #define __list_for_each_rcu(pos, head) \
  582. for (pos = (head)->next; \
  583. rcu_dereference(pos) != (head); \
  584. pos = pos->next)
  585. /**
  586. * list_for_each_safe_rcu
  587. * @pos: the &struct list_head to use as a loop cursor.
  588. * @n: another &struct list_head to use as temporary storage
  589. * @head: the head for your list.
  590. *
  591. * Iterate over an rcu-protected list, safe against removal of list entry.
  592. *
  593. * This list-traversal primitive may safely run concurrently with
  594. * the _rcu list-mutation primitives such as list_add_rcu()
  595. * as long as the traversal is guarded by rcu_read_lock().
  596. */
  597. #define list_for_each_safe_rcu(pos, n, head) \
  598. for (pos = (head)->next; \
  599. n = rcu_dereference(pos)->next, pos != (head); \
  600. pos = n)
  601. /**
  602. * list_for_each_entry_rcu - iterate over rcu list of given type
  603. * @pos: the type * to use as a loop cursor.
  604. * @head: the head for your list.
  605. * @member: the name of the list_struct within the struct.
  606. *
  607. * This list-traversal primitive may safely run concurrently with
  608. * the _rcu list-mutation primitives such as list_add_rcu()
  609. * as long as the traversal is guarded by rcu_read_lock().
  610. */
  611. #define list_for_each_entry_rcu(pos, head, member) \
  612. for (pos = list_entry((head)->next, typeof(*pos), member); \
  613. prefetch(rcu_dereference(pos)->member.next), \
  614. &pos->member != (head); \
  615. pos = list_entry(pos->member.next, typeof(*pos), member))
  616. /**
  617. * list_for_each_continue_rcu
  618. * @pos: the &struct list_head to use as a loop cursor.
  619. * @head: the head for your list.
  620. *
  621. * Iterate over an rcu-protected list, continuing after current point.
  622. *
  623. * This list-traversal primitive may safely run concurrently with
  624. * the _rcu list-mutation primitives such as list_add_rcu()
  625. * as long as the traversal is guarded by rcu_read_lock().
  626. */
  627. #define list_for_each_continue_rcu(pos, head) \
  628. for ((pos) = (pos)->next; \
  629. prefetch(rcu_dereference((pos))->next), (pos) != (head); \
  630. (pos) = (pos)->next)
  631. /*
  632. * Double linked lists with a single pointer list head.
  633. * Mostly useful for hash tables where the two pointer list head is
  634. * too wasteful.
  635. * You lose the ability to access the tail in O(1).
  636. */
  637. struct hlist_head {
  638. struct hlist_node *first;
  639. };
  640. struct hlist_node {
  641. struct hlist_node *next, **pprev;
  642. };
  643. #define HLIST_HEAD_INIT { .first = NULL }
  644. #define HLIST_HEAD(name) struct hlist_head name = { .first = NULL }
  645. #define INIT_HLIST_HEAD(ptr) ((ptr)->first = NULL)
  646. static inline void INIT_HLIST_NODE(struct hlist_node *h)
  647. {
  648. h->next = NULL;
  649. h->pprev = NULL;
  650. }
  651. static inline int hlist_unhashed(const struct hlist_node *h)
  652. {
  653. return !h->pprev;
  654. }
  655. static inline int hlist_empty(const struct hlist_head *h)
  656. {
  657. return !h->first;
  658. }
  659. static inline void __hlist_del(struct hlist_node *n)
  660. {
  661. struct hlist_node *next = n->next;
  662. struct hlist_node **pprev = n->pprev;
  663. *pprev = next;
  664. if (next)
  665. next->pprev = pprev;
  666. }
  667. static inline void hlist_del(struct hlist_node *n)
  668. {
  669. __hlist_del(n);
  670. n->next = LIST_POISON1;
  671. n->pprev = LIST_POISON2;
  672. }
  673. /**
  674. * hlist_del_rcu - deletes entry from hash list without re-initialization
  675. * @n: the element to delete from the hash list.
  676. *
  677. * Note: list_unhashed() on entry does not return true after this,
  678. * the entry is in an undefined state. It is useful for RCU based
  679. * lockfree traversal.
  680. *
  681. * In particular, it means that we can not poison the forward
  682. * pointers that may still be used for walking the hash list.
  683. *
  684. * The caller must take whatever precautions are necessary
  685. * (such as holding appropriate locks) to avoid racing
  686. * with another list-mutation primitive, such as hlist_add_head_rcu()
  687. * or hlist_del_rcu(), running on this same list.
  688. * However, it is perfectly legal to run concurrently with
  689. * the _rcu list-traversal primitives, such as
  690. * hlist_for_each_entry().
  691. */
  692. static inline void hlist_del_rcu(struct hlist_node *n)
  693. {
  694. __hlist_del(n);
  695. n->pprev = LIST_POISON2;
  696. }
  697. static inline void hlist_del_init(struct hlist_node *n)
  698. {
  699. if (!hlist_unhashed(n)) {
  700. __hlist_del(n);
  701. INIT_HLIST_NODE(n);
  702. }
  703. }
  704. /**
  705. * hlist_replace_rcu - replace old entry by new one
  706. * @old : the element to be replaced
  707. * @new : the new element to insert
  708. *
  709. * The @old entry will be replaced with the @new entry atomically.
  710. */
  711. static inline void hlist_replace_rcu(struct hlist_node *old,
  712. struct hlist_node *new)
  713. {
  714. struct hlist_node *next = old->next;
  715. new->next = next;
  716. new->pprev = old->pprev;
  717. smp_wmb();
  718. if (next)
  719. new->next->pprev = &new->next;
  720. *new->pprev = new;
  721. old->pprev = LIST_POISON2;
  722. }
  723. static inline void hlist_add_head(struct hlist_node *n, struct hlist_head *h)
  724. {
  725. struct hlist_node *first = h->first;
  726. n->next = first;
  727. if (first)
  728. first->pprev = &n->next;
  729. h->first = n;
  730. n->pprev = &h->first;
  731. }
  732. /**
  733. * hlist_add_head_rcu
  734. * @n: the element to add to the hash list.
  735. * @h: the list to add to.
  736. *
  737. * Description:
  738. * Adds the specified element to the specified hlist,
  739. * while permitting racing traversals.
  740. *
  741. * The caller must take whatever precautions are necessary
  742. * (such as holding appropriate locks) to avoid racing
  743. * with another list-mutation primitive, such as hlist_add_head_rcu()
  744. * or hlist_del_rcu(), running on this same list.
  745. * However, it is perfectly legal to run concurrently with
  746. * the _rcu list-traversal primitives, such as
  747. * hlist_for_each_entry_rcu(), used to prevent memory-consistency
  748. * problems on Alpha CPUs. Regardless of the type of CPU, the
  749. * list-traversal primitive must be guarded by rcu_read_lock().
  750. */
  751. static inline void hlist_add_head_rcu(struct hlist_node *n,
  752. struct hlist_head *h)
  753. {
  754. struct hlist_node *first = h->first;
  755. n->next = first;
  756. n->pprev = &h->first;
  757. smp_wmb();
  758. if (first)
  759. first->pprev = &n->next;
  760. h->first = n;
  761. }
  762. /* next must be != NULL */
  763. static inline void hlist_add_before(struct hlist_node *n,
  764. struct hlist_node *next)
  765. {
  766. n->pprev = next->pprev;
  767. n->next = next;
  768. next->pprev = &n->next;
  769. *(n->pprev) = n;
  770. }
  771. static inline void hlist_add_after(struct hlist_node *n,
  772. struct hlist_node *next)
  773. {
  774. next->next = n->next;
  775. n->next = next;
  776. next->pprev = &n->next;
  777. if(next->next)
  778. next->next->pprev = &next->next;
  779. }
  780. /**
  781. * hlist_add_before_rcu
  782. * @n: the new element to add to the hash list.
  783. * @next: the existing element to add the new element before.
  784. *
  785. * Description:
  786. * Adds the specified element to the specified hlist
  787. * before the specified node while permitting racing traversals.
  788. *
  789. * The caller must take whatever precautions are necessary
  790. * (such as holding appropriate locks) to avoid racing
  791. * with another list-mutation primitive, such as hlist_add_head_rcu()
  792. * or hlist_del_rcu(), running on this same list.
  793. * However, it is perfectly legal to run concurrently with
  794. * the _rcu list-traversal primitives, such as
  795. * hlist_for_each_entry_rcu(), used to prevent memory-consistency
  796. * problems on Alpha CPUs.
  797. */
  798. static inline void hlist_add_before_rcu(struct hlist_node *n,
  799. struct hlist_node *next)
  800. {
  801. n->pprev = next->pprev;
  802. n->next = next;
  803. smp_wmb();
  804. next->pprev = &n->next;
  805. *(n->pprev) = n;
  806. }
  807. /**
  808. * hlist_add_after_rcu
  809. * @prev: the existing element to add the new element after.
  810. * @n: the new element to add to the hash list.
  811. *
  812. * Description:
  813. * Adds the specified element to the specified hlist
  814. * after the specified node while permitting racing traversals.
  815. *
  816. * The caller must take whatever precautions are necessary
  817. * (such as holding appropriate locks) to avoid racing
  818. * with another list-mutation primitive, such as hlist_add_head_rcu()
  819. * or hlist_del_rcu(), running on this same list.
  820. * However, it is perfectly legal to run concurrently with
  821. * the _rcu list-traversal primitives, such as
  822. * hlist_for_each_entry_rcu(), used to prevent memory-consistency
  823. * problems on Alpha CPUs.
  824. */
  825. static inline void hlist_add_after_rcu(struct hlist_node *prev,
  826. struct hlist_node *n)
  827. {
  828. n->next = prev->next;
  829. n->pprev = &prev->next;
  830. smp_wmb();
  831. prev->next = n;
  832. if (n->next)
  833. n->next->pprev = &n->next;
  834. }
  835. #define hlist_entry(ptr, type, member) container_of(ptr,type,member)
  836. #define hlist_for_each(pos, head) \
  837. for (pos = (head)->first; pos && ({ prefetch(pos->next); 1; }); \
  838. pos = pos->next)
  839. #define hlist_for_each_safe(pos, n, head) \
  840. for (pos = (head)->first; pos && ({ n = pos->next; 1; }); \
  841. pos = n)
  842. /**
  843. * hlist_for_each_entry - iterate over list of given type
  844. * @tpos: the type * to use as a loop cursor.
  845. * @pos: the &struct hlist_node to use as a loop cursor.
  846. * @head: the head for your list.
  847. * @member: the name of the hlist_node within the struct.
  848. */
  849. #define hlist_for_each_entry(tpos, pos, head, member) \
  850. for (pos = (head)->first; \
  851. pos && ({ prefetch(pos->next); 1;}) && \
  852. ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
  853. pos = pos->next)
  854. /**
  855. * hlist_for_each_entry_continue - iterate over a hlist continuing after current point
  856. * @tpos: the type * to use as a loop cursor.
  857. * @pos: the &struct hlist_node to use as a loop cursor.
  858. * @member: the name of the hlist_node within the struct.
  859. */
  860. #define hlist_for_each_entry_continue(tpos, pos, member) \
  861. for (pos = (pos)->next; \
  862. pos && ({ prefetch(pos->next); 1;}) && \
  863. ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
  864. pos = pos->next)
  865. /**
  866. * hlist_for_each_entry_from - iterate over a hlist continuing from current point
  867. * @tpos: the type * to use as a loop cursor.
  868. * @pos: the &struct hlist_node to use as a loop cursor.
  869. * @member: the name of the hlist_node within the struct.
  870. */
  871. #define hlist_for_each_entry_from(tpos, pos, member) \
  872. for (; pos && ({ prefetch(pos->next); 1;}) && \
  873. ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
  874. pos = pos->next)
  875. /**
  876. * hlist_for_each_entry_safe - iterate over list of given type safe against removal of list entry
  877. * @tpos: the type * to use as a loop cursor.
  878. * @pos: the &struct hlist_node to use as a loop cursor.
  879. * @n: another &struct hlist_node to use as temporary storage
  880. * @head: the head for your list.
  881. * @member: the name of the hlist_node within the struct.
  882. */
  883. #define hlist_for_each_entry_safe(tpos, pos, n, head, member) \
  884. for (pos = (head)->first; \
  885. pos && ({ n = pos->next; 1; }) && \
  886. ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
  887. pos = n)
  888. /**
  889. * hlist_for_each_entry_rcu - iterate over rcu list of given type
  890. * @tpos: the type * to use as a loop cursor.
  891. * @pos: the &struct hlist_node to use as a loop cursor.
  892. * @head: the head for your list.
  893. * @member: the name of the hlist_node within the struct.
  894. *
  895. * This list-traversal primitive may safely run concurrently with
  896. * the _rcu list-mutation primitives such as hlist_add_head_rcu()
  897. * as long as the traversal is guarded by rcu_read_lock().
  898. */
  899. #define hlist_for_each_entry_rcu(tpos, pos, head, member) \
  900. for (pos = (head)->first; \
  901. rcu_dereference(pos) && ({ prefetch(pos->next); 1;}) && \
  902. ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
  903. pos = pos->next)
  904. #else
  905. #warning "don't include kernel headers in userspace"
  906. #endif /* __KERNEL__ */
  907. #endif