klist.h 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. * klist.h - Some generic list helpers, extending struct list_head a bit.
  4. *
  5. * Implementations are found in lib/klist.c
  6. *
  7. * Copyright (C) 2005 Patrick Mochel
  8. */
  9. #ifndef _LINUX_KLIST_H
  10. #define _LINUX_KLIST_H
  11. #include <linux/spinlock.h>
  12. #include <linux/kref.h>
  13. #include <linux/list.h>
  14. struct klist_node;
  15. struct klist {
  16. spinlock_t k_lock;
  17. struct list_head k_list;
  18. void (*get)(struct klist_node *);
  19. void (*put)(struct klist_node *);
  20. } __attribute__ ((aligned (sizeof(void *))));
  21. #define KLIST_INIT(_name, _get, _put) \
  22. { .k_lock = __SPIN_LOCK_UNLOCKED(_name.k_lock), \
  23. .k_list = LIST_HEAD_INIT(_name.k_list), \
  24. .get = _get, \
  25. .put = _put, }
  26. #define DEFINE_KLIST(_name, _get, _put) \
  27. struct klist _name = KLIST_INIT(_name, _get, _put)
  28. extern void klist_init(struct klist *k, void (*get)(struct klist_node *),
  29. void (*put)(struct klist_node *));
  30. struct klist_node {
  31. void *n_klist; /* never access directly */
  32. struct list_head n_node;
  33. struct kref n_ref;
  34. };
  35. extern void klist_add_tail(struct klist_node *n, struct klist *k);
  36. extern void klist_add_head(struct klist_node *n, struct klist *k);
  37. extern void klist_add_behind(struct klist_node *n, struct klist_node *pos);
  38. extern void klist_add_before(struct klist_node *n, struct klist_node *pos);
  39. extern void klist_del(struct klist_node *n);
  40. extern void klist_remove(struct klist_node *n);
  41. extern int klist_node_attached(struct klist_node *n);
  42. struct klist_iter {
  43. struct klist *i_klist;
  44. struct klist_node *i_cur;
  45. };
  46. extern void klist_iter_init(struct klist *k, struct klist_iter *i);
  47. extern void klist_iter_init_node(struct klist *k, struct klist_iter *i,
  48. struct klist_node *n);
  49. extern void klist_iter_exit(struct klist_iter *i);
  50. extern struct klist_node *klist_prev(struct klist_iter *i);
  51. extern struct klist_node *klist_next(struct klist_iter *i);
  52. #endif