kthread.h 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134
  1. #ifndef _LINUX_KTHREAD_H
  2. #define _LINUX_KTHREAD_H
  3. /* Simple interface for creating and stopping kernel threads without mess. */
  4. #include <linux/err.h>
  5. #include <linux/sched.h>
  6. __printf(4, 5)
  7. struct task_struct *kthread_create_on_node(int (*threadfn)(void *data),
  8. void *data,
  9. int node,
  10. const char namefmt[], ...);
  11. #define kthread_create(threadfn, data, namefmt, arg...) \
  12. kthread_create_on_node(threadfn, data, -1, namefmt, ##arg)
  13. /**
  14. * kthread_run - create and wake a thread.
  15. * @threadfn: the function to run until signal_pending(current).
  16. * @data: data ptr for @threadfn.
  17. * @namefmt: printf-style name for the thread.
  18. *
  19. * Description: Convenient wrapper for kthread_create() followed by
  20. * wake_up_process(). Returns the kthread or ERR_PTR(-ENOMEM).
  21. */
  22. #define kthread_run(threadfn, data, namefmt, ...) \
  23. ({ \
  24. struct task_struct *__k \
  25. = kthread_create(threadfn, data, namefmt, ## __VA_ARGS__); \
  26. if (!IS_ERR(__k)) \
  27. wake_up_process(__k); \
  28. __k; \
  29. })
  30. void kthread_bind(struct task_struct *k, unsigned int cpu);
  31. int kthread_stop(struct task_struct *k);
  32. int kthread_should_stop(void);
  33. bool kthread_freezable_should_stop(bool *was_frozen);
  34. void *kthread_data(struct task_struct *k);
  35. int kthreadd(void *unused);
  36. extern struct task_struct *kthreadd_task;
  37. extern int tsk_fork_get_node(struct task_struct *tsk);
  38. /*
  39. * Simple work processor based on kthread.
  40. *
  41. * This provides easier way to make use of kthreads. A kthread_work
  42. * can be queued and flushed using queue/flush_kthread_work()
  43. * respectively. Queued kthread_works are processed by a kthread
  44. * running kthread_worker_fn().
  45. *
  46. * A kthread_work can't be freed while it is executing.
  47. */
  48. struct kthread_work;
  49. typedef void (*kthread_work_func_t)(struct kthread_work *work);
  50. struct kthread_worker {
  51. spinlock_t lock;
  52. struct list_head work_list;
  53. struct task_struct *task;
  54. };
  55. struct kthread_work {
  56. struct list_head node;
  57. kthread_work_func_t func;
  58. wait_queue_head_t done;
  59. atomic_t flushing;
  60. int queue_seq;
  61. int done_seq;
  62. };
  63. #define KTHREAD_WORKER_INIT(worker) { \
  64. .lock = __SPIN_LOCK_UNLOCKED((worker).lock), \
  65. .work_list = LIST_HEAD_INIT((worker).work_list), \
  66. }
  67. #define KTHREAD_WORK_INIT(work, fn) { \
  68. .node = LIST_HEAD_INIT((work).node), \
  69. .func = (fn), \
  70. .done = __WAIT_QUEUE_HEAD_INITIALIZER((work).done), \
  71. .flushing = ATOMIC_INIT(0), \
  72. }
  73. #define DEFINE_KTHREAD_WORKER(worker) \
  74. struct kthread_worker worker = KTHREAD_WORKER_INIT(worker)
  75. #define DEFINE_KTHREAD_WORK(work, fn) \
  76. struct kthread_work work = KTHREAD_WORK_INIT(work, fn)
  77. /*
  78. * kthread_worker.lock and kthread_work.done need their own lockdep class
  79. * keys if they are defined on stack with lockdep enabled. Use the
  80. * following macros when defining them on stack.
  81. */
  82. #ifdef CONFIG_LOCKDEP
  83. # define KTHREAD_WORKER_INIT_ONSTACK(worker) \
  84. ({ init_kthread_worker(&worker); worker; })
  85. # define DEFINE_KTHREAD_WORKER_ONSTACK(worker) \
  86. struct kthread_worker worker = KTHREAD_WORKER_INIT_ONSTACK(worker)
  87. # define KTHREAD_WORK_INIT_ONSTACK(work, fn) \
  88. ({ init_kthread_work((&work), fn); work; })
  89. # define DEFINE_KTHREAD_WORK_ONSTACK(work, fn) \
  90. struct kthread_work work = KTHREAD_WORK_INIT_ONSTACK(work, fn)
  91. #else
  92. # define DEFINE_KTHREAD_WORKER_ONSTACK(worker) DEFINE_KTHREAD_WORKER(worker)
  93. # define DEFINE_KTHREAD_WORK_ONSTACK(work, fn) DEFINE_KTHREAD_WORK(work, fn)
  94. #endif
  95. extern void __init_kthread_worker(struct kthread_worker *worker,
  96. const char *name, struct lock_class_key *key);
  97. #define init_kthread_worker(worker) \
  98. do { \
  99. static struct lock_class_key __key; \
  100. __init_kthread_worker((worker), "("#worker")->lock", &__key); \
  101. } while (0)
  102. #define init_kthread_work(work, fn) \
  103. do { \
  104. memset((work), 0, sizeof(struct kthread_work)); \
  105. INIT_LIST_HEAD(&(work)->node); \
  106. (work)->func = (fn); \
  107. init_waitqueue_head(&(work)->done); \
  108. } while (0)
  109. int kthread_worker_fn(void *worker_ptr);
  110. bool queue_kthread_work(struct kthread_worker *worker,
  111. struct kthread_work *work);
  112. void flush_kthread_work(struct kthread_work *work);
  113. void flush_kthread_worker(struct kthread_worker *worker);
  114. #endif /* _LINUX_KTHREAD_H */