kthread.h 4.4 KB

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