kernel/kthread.c

   1 /* Kernel thread helper functions.
   2  *   Copyright (C) 2004 IBM Corporation, Rusty Russell.
   3  *
   4  * Creation is done via kthreadd, so that we get a clean environment
   5  * even if we're invoked from userspace (think modprobe, hotplug cpu,
   6  * etc.).
   7  */
   8 #include <linux/sched.h>
   9 #include <linux/kthread.h>
  10 #include <linux/completion.h>
  11 #include <linux/err.h>
  12 #include <linux/cpuset.h>
  13 #include <linux/unistd.h>
  14 #include <linux/file.h>
  15 #include <linux/export.h>
  16 #include <linux/mutex.h>
  17 #include <linux/slab.h>
  18 #include <linux/freezer.h>
  19 #include <linux/ptrace.h>
  20 #include <linux/uaccess.h>
  21 #include <trace/events/sched.h>
  22
  23 static DEFINE_SPINLOCK(kthread_create_lock);
  24 static LIST_HEAD(kthread_create_list);
  25 struct task_struct *kthreadd_task;
  26
  27 struct kthread_create_info
  28 {
  29         /* Information passed to kthread() from kthreadd. */
  30         int (*threadfn)(void *data);
  31         void *data;
  32         int node;
  33
  34         /* Result passed back to kthread_create() from kthreadd. */
  35         struct task_struct *result;
  36         struct completion *done;
  37
  38         struct list_head list;
  39 };
  40
  41 struct kthread {
  42         unsigned long flags;
  43         unsigned int cpu;
  44         void *data;
  45         struct completion parked;
  46         struct completion exited;
  47 };
  48
  49 enum KTHREAD_BITS {
  50         KTHREAD_IS_PER_CPU = 0,
  51         KTHREAD_SHOULD_STOP,
  52         KTHREAD_SHOULD_PARK,
  53         KTHREAD_IS_PARKED,
  54 };
  55
  56 #define __to_kthread(vfork)     \
  57         container_of(vfork, struct kthread, exited)
  58
  59 static inline struct kthread *to_kthread(struct task_struct *k)
  60 {
  61         return __to_kthread(k->vfork_done);
  62 }
  63
  64 static struct kthread *to_live_kthread(struct task_struct *k)
  65 {
  66         struct completion *vfork = ACCESS_ONCE(k->vfork_done);
  67         if (likely(vfork) && try_get_task_stack(k))
  68                 return __to_kthread(vfork);
  69         return NULL;
  70 }
  71
  72 /**
  73  * kthread_should_stop - should this kthread return now?
  74  *
  75  * When someone calls kthread_stop() on your kthread, it will be woken
  76  * and this will return true.  You should then return, and your return
  77  * value will be passed through to kthread_stop().
  78  */
  79 bool kthread_should_stop(void)
  80 {
  81         return test_bit(KTHREAD_SHOULD_STOP, &to_kthread(current)->flags);
  82 }
  83 EXPORT_SYMBOL(kthread_should_stop);
  84
  85 /**
  86  * kthread_should_park - should this kthread park now?
  87  *
  88  * When someone calls kthread_park() on your kthread, it will be woken
  89  * and this will return true.  You should then do the necessary
  90  * cleanup and call kthread_parkme()
  91  *
  92  * Similar to kthread_should_stop(), but this keeps the thread alive
  93  * and in a park position. kthread_unpark() "restarts" the thread and
  94  * calls the thread function again.
  95  */
  96 bool kthread_should_park(void)
  97 {
  98         return test_bit(KTHREAD_SHOULD_PARK, &to_kthread(current)->flags);
  99 }
 100 EXPORT_SYMBOL_GPL(kthread_should_park);
 101
 102 /**
 103  * kthread_freezable_should_stop - should this freezable kthread return now?
 104  * @was_frozen: optional out parameter, indicates whether %current was frozen
 105  *
 106  * kthread_should_stop() for freezable kthreads, which will enter
 107  * refrigerator if necessary.  This function is safe from kthread_stop() /
 108  * freezer deadlock and freezable kthreads should use this function instead
 109  * of calling try_to_freeze() directly.
 110  */
 111 bool kthread_freezable_should_stop(bool *was_frozen)
 112 {
 113         bool frozen = false;
 114
 115         might_sleep();
 116
 117         if (unlikely(freezing(current)))
 118                 frozen = __refrigerator(true);
 119
 120         if (was_frozen)
 121                 *was_frozen = frozen;
 122
 123         return kthread_should_stop();
 124 }
 125 EXPORT_SYMBOL_GPL(kthread_freezable_should_stop);
 126
 127 /**
 128  * kthread_data - return data value specified on kthread creation
 129  * @task: kthread task in question
 130  *
 131  * Return the data value specified when kthread @task was created.
 132  * The caller is responsible for ensuring the validity of @task when
 133  * calling this function.
 134  */
 135 void *kthread_data(struct task_struct *task)
 136 {
 137         return to_kthread(task)->data;
 138 }
 139
 140 /**
 141  * kthread_probe_data - speculative version of kthread_data()
 142  * @task: possible kthread task in question
 143  *
 144  * @task could be a kthread task.  Return the data value specified when it
 145  * was created if accessible.  If @task isn't a kthread task or its data is
 146  * inaccessible for any reason, %NULL is returned.  This function requires
 147  * that @task itself is safe to dereference.
 148  */
 149 void *kthread_probe_data(struct task_struct *task)
 150 {
 151         struct kthread *kthread = to_kthread(task);
 152         void *data = NULL;
 153
 154         probe_kernel_read(&data, &kthread->data, sizeof(data));
 155         return data;
 156 }
 157
 158 static void __kthread_parkme(struct kthread *self)
 159 {
 160         __set_current_state(TASK_PARKED);
 161         while (test_bit(KTHREAD_SHOULD_PARK, &self->flags)) {
 162                 if (!test_and_set_bit(KTHREAD_IS_PARKED, &self->flags))
 163                         complete(&self->parked);
 164                 schedule();
 165                 __set_current_state(TASK_PARKED);
 166         }
 167         clear_bit(KTHREAD_IS_PARKED, &self->flags);
 168         __set_current_state(TASK_RUNNING);
 169 }
 170
 171 void kthread_parkme(void)
 172 {
 173         __kthread_parkme(to_kthread(current));
 174 }
 175 EXPORT_SYMBOL_GPL(kthread_parkme);
 176
 177 static int kthread(void *_create)
 178 {
 179         /* Copy data: it's on kthread's stack */
 180         struct kthread_create_info *create = _create;
 181         int (*threadfn)(void *data) = create->threadfn;
 182         void *data = create->data;
 183         struct completion *done;
 184         struct kthread self;
 185         int ret;
 186
 187         self.flags = 0;
 188         self.data = data;
 189         init_completion(&self.exited);
 190         init_completion(&self.parked);
 191         current->vfork_done = &self.exited;
 192
 193         /* If user was SIGKILLed, I release the structure. */
 194         done = xchg(&create->done, NULL);
 195         if (!done) {
 196                 kfree(create);
 197                 do_exit(-EINTR);
 198         }
 199         /* OK, tell user we're spawned, wait for stop or wakeup */
 200         __set_current_state(TASK_UNINTERRUPTIBLE);
 201         create->result = current;
 202         complete(done);
 203         schedule();
 204
 205         ret = -EINTR;
 206
 207         if (!test_bit(KTHREAD_SHOULD_STOP, &self.flags)) {
 208                 __kthread_parkme(&self);
 209                 ret = threadfn(data);
 210         }
 211         /* we can't just return, we must preserve "self" on stack */
 212         do_exit(ret);
 213 }
 214
 215 /* called from do_fork() to get node information for about to be created task */
 216 int tsk_fork_get_node(struct task_struct *tsk)
 217 {
 218 #ifdef CONFIG_NUMA
 219         if (tsk == kthreadd_task)
 220                 return tsk->pref_node_fork;
 221 #endif
 222         return NUMA_NO_NODE;
 223 }
 224
 225 static void create_kthread(struct kthread_create_info *create)
 226 {
 227         int pid;
 228
 229 #ifdef CONFIG_NUMA
 230         current->pref_node_fork = create->node;
 231 #endif
 232         /* We want our own signal handler (we take no signals by default). */
 233         pid = kernel_thread(kthread, create, CLONE_FS | CLONE_FILES | SIGCHLD);
 234         if (pid < 0) {
 235                 /* If user was SIGKILLed, I release the structure. */
 236                 struct completion *done = xchg(&create->done, NULL);
 237
 238                 if (!done) {
 239                         kfree(create);
 240                         return;
 241                 }
 242                 create->result = ERR_PTR(pid);
 243                 complete(done);
 244         }
 245 }
 246
 247 static struct task_struct *__kthread_create_on_node(int (*threadfn)(void *data),
 248                                                     void *data, int node,
 249                                                     const char namefmt[],
 250                                                     va_list args)
 251 {
 252         DECLARE_COMPLETION_ONSTACK(done);
 253         struct task_struct *task;
 254         struct kthread_create_info *create = kmalloc(sizeof(*create),
 255                                                      GFP_KERNEL);
 256
 257         if (!create)
 258                 return ERR_PTR(-ENOMEM);
 259         create->threadfn = threadfn;
 260         create->data = data;
 261         create->node = node;
 262         create->done = &done;
 263
 264         spin_lock(&kthread_create_lock);
 265         list_add_tail(&create->list, &kthread_create_list);
 266         spin_unlock(&kthread_create_lock);
 267
 268         wake_up_process(kthreadd_task);
 269         /*
 270          * Wait for completion in killable state, for I might be chosen by
 271          * the OOM killer while kthreadd is trying to allocate memory for
 272          * new kernel thread.
 273          */
 274         if (unlikely(wait_for_completion_killable(&done))) {
 275                 /*
 276                  * If I was SIGKILLed before kthreadd (or new kernel thread)
 277                  * calls complete(), leave the cleanup of this structure to
 278                  * that thread.
 279                  */
 280                 if (xchg(&create->done, NULL))
 281                         return ERR_PTR(-EINTR);
 282                 /*
 283                  * kthreadd (or new kernel thread) will call complete()
 284                  * shortly.
 285                  */
 286                 wait_for_completion(&done);
 287         }
 288         task = create->result;
 289         if (!IS_ERR(task)) {
 290                 static const struct sched_param param = { .sched_priority = 0 };
 291
 292                 vsnprintf(task->comm, sizeof(task->comm), namefmt, args);
 293                 /*
 294                  * root may have changed our (kthreadd's) priority or CPU mask.
 295                  * The kernel thread should not inherit these properties.
 296                  */
 297                 sched_setscheduler_nocheck(task, SCHED_NORMAL, &param);
 298                 set_cpus_allowed_ptr(task, cpu_all_mask);
 299         }
 300         kfree(create);
 301         return task;
 302 }
 303
 304 /**
 305  * kthread_create_on_node - create a kthread.
 306  * @threadfn: the function to run until signal_pending(current).
 307  * @data: data ptr for @threadfn.
 308  * @node: task and thread structures for the thread are allocated on this node
 309  * @namefmt: printf-style name for the thread.
 310  *
 311  * Description: This helper function creates and names a kernel
 312  * thread.  The thread will be stopped: use wake_up_process() to start
 313  * it.  See also kthread_run().  The new thread has SCHED_NORMAL policy and
 314  * is affine to all CPUs.
 315  *
 316  * If thread is going to be bound on a particular cpu, give its node
 317  * in @node, to get NUMA affinity for kthread stack, or else give NUMA_NO_NODE.
 318  * When woken, the thread will run @threadfn() with @data as its
 319  * argument. @threadfn() can either call do_exit() directly if it is a
 320  * standalone thread for which no one will call kthread_stop(), or
 321  * return when 'kthread_should_stop()' is true (which means
 322  * kthread_stop() has been called).  The return value should be zero
 323  * or a negative error number; it will be passed to kthread_stop().
 324  *
 325  * Returns a task_struct or ERR_PTR(-ENOMEM) or ERR_PTR(-EINTR).
 326  */
 327 struct task_struct *kthread_create_on_node(int (*threadfn)(void *data),
 328                                            void *data, int node,
 329                                            const char namefmt[],
 330                                            ...)
 331 {
 332         struct task_struct *task;
 333         va_list args;
 334
 335         va_start(args, namefmt);
 336         task = __kthread_create_on_node(threadfn, data, node, namefmt, args);
 337         va_end(args);
 338
 339         return task;
 340 }
 341 EXPORT_SYMBOL(kthread_create_on_node);
 342
 343 static void __kthread_bind_mask(struct task_struct *p, const struct cpumask *mask, long state)
 344 {
 345         unsigned long flags;
 346
 347         if (!wait_task_inactive(p, state)) {
 348                 WARN_ON(1);
 349                 return;
 350         }
 351
 352         /* It's safe because the task is inactive. */
 353         raw_spin_lock_irqsave(&p->pi_lock, flags);
 354         do_set_cpus_allowed(p, mask);
 355         p->flags |= PF_NO_SETAFFINITY;
 356         raw_spin_unlock_irqrestore(&p->pi_lock, flags);
 357 }
 358
 359 static void __kthread_bind(struct task_struct *p, unsigned int cpu, long state)
 360 {
 361         __kthread_bind_mask(p, cpumask_of(cpu), state);
 362 }
 363
 364 void kthread_bind_mask(struct task_struct *p, const struct cpumask *mask)
 365 {
 366         __kthread_bind_mask(p, mask, TASK_UNINTERRUPTIBLE);
 367 }
 368
 369 /**
 370  * kthread_bind - bind a just-created kthread to a cpu.
 371  * @p: thread created by kthread_create().
 372  * @cpu: cpu (might not be online, must be possible) for @k to run on.
 373  *
 374  * Description: This function is equivalent to set_cpus_allowed(),
 375  * except that @cpu doesn't need to be online, and the thread must be
 376  * stopped (i.e., just returned from kthread_create()).
 377  */
 378 void kthread_bind(struct task_struct *p, unsigned int cpu)
 379 {
 380         __kthread_bind(p, cpu, TASK_UNINTERRUPTIBLE);
 381 }
 382 EXPORT_SYMBOL(kthread_bind);
 383
 384 /**
 385  * kthread_create_on_cpu - Create a cpu bound kthread
 386  * @threadfn: the function to run until signal_pending(current).
 387  * @data: data ptr for @threadfn.
 388  * @cpu: The cpu on which the thread should be bound,
 389  * @namefmt: printf-style name for the thread. Format is restricted
 390  *           to "name.*%u". Code fills in cpu number.
 391  *
 392  * Description: This helper function creates and names a kernel thread
 393  * The thread will be woken and put into park mode.
 394  */
 395 struct task_struct *kthread_create_on_cpu(int (*threadfn)(void *data),
 396                                           void *data, unsigned int cpu,
 397                                           const char *namefmt)
 398 {
 399         struct task_struct *p;
 400
 401         p = kthread_create_on_node(threadfn, data, cpu_to_node(cpu), namefmt,
 402                                    cpu);
 403         if (IS_ERR(p))
 404                 return p;
 405         kthread_bind(p, cpu);
 406         /* CPU hotplug need to bind once again when unparking the thread. */
 407         set_bit(KTHREAD_IS_PER_CPU, &to_kthread(p)->flags);
 408         to_kthread(p)->cpu = cpu;
 409         return p;
 410 }
 411
 412 static void __kthread_unpark(struct task_struct *k, struct kthread *kthread)
 413 {
 414         clear_bit(KTHREAD_SHOULD_PARK, &kthread->flags);
 415         /*
 416          * We clear the IS_PARKED bit here as we don't wait
 417          * until the task has left the park code. So if we'd
 418          * park before that happens we'd see the IS_PARKED bit
 419          * which might be about to be cleared.
 420          */
 421         if (test_and_clear_bit(KTHREAD_IS_PARKED, &kthread->flags)) {
 422                 /*
 423                  * Newly created kthread was parked when the CPU was offline.
 424                  * The binding was lost and we need to set it again.
 425                  */
 426                 if (test_bit(KTHREAD_IS_PER_CPU, &kthread->flags))
 427                         __kthread_bind(k, kthread->cpu, TASK_PARKED);
 428                 wake_up_state(k, TASK_PARKED);
 429         }
 430 }
 431
 432 /**
 433  * kthread_unpark - unpark a thread created by kthread_create().
 434  * @k:          thread created by kthread_create().
 435  *
 436  * Sets kthread_should_park() for @k to return false, wakes it, and
 437  * waits for it to return. If the thread is marked percpu then its
 438  * bound to the cpu again.
 439  */
 440 void kthread_unpark(struct task_struct *k)
 441 {
 442         struct kthread *kthread = to_live_kthread(k);
 443
 444         if (kthread) {
 445                 __kthread_unpark(k, kthread);
 446                 put_task_stack(k);
 447         }
 448 }
 449 EXPORT_SYMBOL_GPL(kthread_unpark);
 450
 451 /**
 452  * kthread_park - park a thread created by kthread_create().
 453  * @k: thread created by kthread_create().
 454  *
 455  * Sets kthread_should_park() for @k to return true, wakes it, and
 456  * waits for it to return. This can also be called after kthread_create()
 457  * instead of calling wake_up_process(): the thread will park without
 458  * calling threadfn().
 459  *
 460  * Returns 0 if the thread is parked, -ENOSYS if the thread exited.
 461  * If called by the kthread itself just the park bit is set.
 462  */
 463 int kthread_park(struct task_struct *k)
 464 {
 465         struct kthread *kthread = to_live_kthread(k);
 466         int ret = -ENOSYS;
 467
 468         if (kthread) {
 469                 if (!test_bit(KTHREAD_IS_PARKED, &kthread->flags)) {
 470                         set_bit(KTHREAD_SHOULD_PARK, &kthread->flags);
 471                         if (k != current) {
 472                                 wake_up_process(k);
 473                                 wait_for_completion(&kthread->parked);
 474                         }
 475                 }
 476                 put_task_stack(k);
 477                 ret = 0;
 478         }
 479         return ret;
 480 }
 481 EXPORT_SYMBOL_GPL(kthread_park);
 482
 483 /**
 484  * kthread_stop - stop a thread created by kthread_create().
 485  * @k: thread created by kthread_create().
 486  *
 487  * Sets kthread_should_stop() for @k to return true, wakes it, and
 488  * waits for it to exit. This can also be called after kthread_create()
 489  * instead of calling wake_up_process(): the thread will exit without
 490  * calling threadfn().
 491  *
 492  * If threadfn() may call do_exit() itself, the caller must ensure
 493  * task_struct can't go away.
 494  *
 495  * Returns the result of threadfn(), or %-EINTR if wake_up_process()
 496  * was never called.
 497  */
 498 int kthread_stop(struct task_struct *k)
 499 {
 500         struct kthread *kthread;
 501         int ret;
 502
 503         trace_sched_kthread_stop(k);
 504
 505         get_task_struct(k);
 506         kthread = to_live_kthread(k);
 507         if (kthread) {
 508                 set_bit(KTHREAD_SHOULD_STOP, &kthread->flags);
 509                 __kthread_unpark(k, kthread);
 510                 wake_up_process(k);
 511                 wait_for_completion(&kthread->exited);
 512                 put_task_stack(k);
 513         }
 514         ret = k->exit_code;
 515         put_task_struct(k);
 516
 517         trace_sched_kthread_stop_ret(ret);
 518         return ret;
 519 }
 520 EXPORT_SYMBOL(kthread_stop);
 521
 522 int kthreadd(void *unused)
 523 {
 524         struct task_struct *tsk = current;
 525
 526         /* Setup a clean context for our children to inherit. */
 527         set_task_comm(tsk, "kthreadd");
 528         ignore_signals(tsk);
 529         set_cpus_allowed_ptr(tsk, cpu_all_mask);
 530         set_mems_allowed(node_states[N_MEMORY]);
 531
 532         current->flags |= PF_NOFREEZE;
 533
 534         for (;;) {
 535                 set_current_state(TASK_INTERRUPTIBLE);
 536                 if (list_empty(&kthread_create_list))
 537                         schedule();
 538                 __set_current_state(TASK_RUNNING);
 539
 540                 spin_lock(&kthread_create_lock);
 541                 while (!list_empty(&kthread_create_list)) {
 542                         struct kthread_create_info *create;
 543
 544                         create = list_entry(kthread_create_list.next,
 545                                             struct kthread_create_info, list);
 546                         list_del_init(&create->list);
 547                         spin_unlock(&kthread_create_lock);
 548
 549                         create_kthread(create);
 550
 551                         spin_lock(&kthread_create_lock);
 552                 }
 553                 spin_unlock(&kthread_create_lock);
 554         }
 555
 556         return 0;
 557 }
 558
 559 void __kthread_init_worker(struct kthread_worker *worker,
 560                                 const char *name,
 561                                 struct lock_class_key *key)
 562 {
 563         spin_lock_init(&worker->lock);
 564         lockdep_set_class_and_name(&worker->lock, key, name);
 565         INIT_LIST_HEAD(&worker->work_list);
 566         INIT_LIST_HEAD(&worker->delayed_work_list);
 567         worker->task = NULL;
 568 }
 569 EXPORT_SYMBOL_GPL(__kthread_init_worker);
 570
 571 /**
 572  * kthread_worker_fn - kthread function to process kthread_worker
 573  * @worker_ptr: pointer to initialized kthread_worker
 574  *
 575  * This function implements the main cycle of kthread worker. It processes
 576  * work_list until it is stopped with kthread_stop(). It sleeps when the queue
 577  * is empty.
 578  *
 579  * The works are not allowed to keep any locks, disable preemption or interrupts
 580  * when they finish. There is defined a safe point for freezing when one work
 581  * finishes and before a new one is started.
 582  *
 583  * Also the works must not be handled by more than one worker at the same time,
 584  * see also kthread_queue_work().
 585  */
 586 int kthread_worker_fn(void *worker_ptr)
 587 {
 588         struct kthread_worker *worker = worker_ptr;
 589         struct kthread_work *work;
 590
 591         /*
 592          * FIXME: Update the check and remove the assignment when all kthread
 593          * worker users are created using kthread_create_worker*() functions.
 594          */
 595         WARN_ON(worker->task && worker->task != current);
 596         worker->task = current;
 597 repeat:
 598         set_current_state(TASK_INTERRUPTIBLE);  /* mb paired w/ kthread_stop */
 599
 600         if (kthread_should_stop()) {
 601                 __set_current_state(TASK_RUNNING);
 602                 spin_lock_irq(&worker->lock);
 603                 worker->task = NULL;
 604                 spin_unlock_irq(&worker->lock);
 605                 return 0;
 606         }
 607
 608         work = NULL;
 609         spin_lock_irq(&worker->lock);
 610         if (!list_empty(&worker->work_list)) {
 611                 work = list_first_entry(&worker->work_list,
 612                                         struct kthread_work, node);
 613                 list_del_init(&work->node);
 614         }
 615         worker->current_work = work;
 616         spin_unlock_irq(&worker->lock);
 617
 618         if (work) {
 619                 __set_current_state(TASK_RUNNING);
 620                 work->func(work);
 621         } else if (!freezing(current))
 622                 schedule();
 623
 624         try_to_freeze();
 625         goto repeat;
 626 }
 627 EXPORT_SYMBOL_GPL(kthread_worker_fn);
 628
 629 static struct kthread_worker *
 630 __kthread_create_worker(int cpu, const char namefmt[], va_list args)
 631 {
 632         struct kthread_worker *worker;
 633         struct task_struct *task;
 634
 635         worker = kzalloc(sizeof(*worker), GFP_KERNEL);
 636         if (!worker)
 637                 return ERR_PTR(-ENOMEM);
 638
 639         kthread_init_worker(worker);
 640
 641         if (cpu >= 0) {
 642                 char name[TASK_COMM_LEN];
 643
 644                 /*
 645                  * kthread_create_worker_on_cpu() allows to pass a generic
 646                  * namefmt in compare with kthread_create_on_cpu. We need
 647                  * to format it here.
 648                  */
 649                 vsnprintf(name, sizeof(name), namefmt, args);
 650                 task = kthread_create_on_cpu(kthread_worker_fn, worker,
 651                                              cpu, name);
 652         } else {
 653                 task = __kthread_create_on_node(kthread_worker_fn, worker,
 654                                                 -1, namefmt, args);
 655         }
 656
 657         if (IS_ERR(task))
 658                 goto fail_task;
 659
 660         worker->task = task;
 661         wake_up_process(task);
 662         return worker;
 663
 664 fail_task:
 665         kfree(worker);
 666         return ERR_CAST(task);
 667 }
 668
 669 /**
 670  * kthread_create_worker - create a kthread worker
 671  * @namefmt: printf-style name for the kthread worker (task).
 672  *
 673  * Returns a pointer to the allocated worker on success, ERR_PTR(-ENOMEM)
 674  * when the needed structures could not get allocated, and ERR_PTR(-EINTR)
 675  * when the worker was SIGKILLed.
 676  */
 677 struct kthread_worker *
 678 kthread_create_worker(const char namefmt[], ...)
 679 {
 680         struct kthread_worker *worker;
 681         va_list args;
 682
 683         va_start(args, namefmt);
 684         worker = __kthread_create_worker(-1, namefmt, args);
 685         va_end(args);
 686
 687         return worker;
 688 }
 689 EXPORT_SYMBOL(kthread_create_worker);
 690
 691 /**
 692  * kthread_create_worker_on_cpu - create a kthread worker and bind it
 693  *      it to a given CPU and the associated NUMA node.
 694  * @cpu: CPU number
 695  * @namefmt: printf-style name for the kthread worker (task).
 696  *
 697  * Use a valid CPU number if you want to bind the kthread worker
 698  * to the given CPU and the associated NUMA node.
 699  *
 700  * A good practice is to add the cpu number also into the worker name.
 701  * For example, use kthread_create_worker_on_cpu(cpu, "helper/%d", cpu).
 702  *
 703  * Returns a pointer to the allocated worker on success, ERR_PTR(-ENOMEM)
 704  * when the needed structures could not get allocated, and ERR_PTR(-EINTR)
 705  * when the worker was SIGKILLed.
 706  */
 707 struct kthread_worker *
 708 kthread_create_worker_on_cpu(int cpu, const char namefmt[], ...)
 709 {
 710         struct kthread_worker *worker;
 711         va_list args;
 712
 713         va_start(args, namefmt);
 714         worker = __kthread_create_worker(cpu, namefmt, args);
 715         va_end(args);
 716
 717         return worker;
 718 }
 719 EXPORT_SYMBOL(kthread_create_worker_on_cpu);
 720
 721 /*
 722  * Returns true when the work could not be queued at the moment.
 723  * It happens when it is already pending in a worker list
 724  * or when it is being cancelled.
 725  */
 726 static inline bool queuing_blocked(struct kthread_worker *worker,
 727                                    struct kthread_work *work)
 728 {
 729         lockdep_assert_held(&worker->lock);
 730
 731         return !list_empty(&work->node) || work->canceling;
 732 }
 733
 734 static void kthread_insert_work_sanity_check(struct kthread_worker *worker,
 735                                              struct kthread_work *work)
 736 {
 737         lockdep_assert_held(&worker->lock);
 738         WARN_ON_ONCE(!list_empty(&work->node));
 739         /* Do not use a work with >1 worker, see kthread_queue_work() */
 740         WARN_ON_ONCE(work->worker && work->worker != worker);
 741 }
 742
 743 /* insert @work before @pos in @worker */
 744 static void kthread_insert_work(struct kthread_worker *worker,
 745                                 struct kthread_work *work,
 746                                 struct list_head *pos)
 747 {
 748         kthread_insert_work_sanity_check(worker, work);
 749
 750         list_add_tail(&work->node, pos);
 751         work->worker = worker;
 752         if (!worker->current_work && likely(worker->task))
 753                 wake_up_process(worker->task);
 754 }
 755
 756 /**
 757  * kthread_queue_work - queue a kthread_work
 758  * @worker: target kthread_worker
 759  * @work: kthread_work to queue
 760  *
 761  * Queue @work to work processor @task for async execution.  @task
 762  * must have been created with kthread_worker_create().  Returns %true
 763  * if @work was successfully queued, %false if it was already pending.
 764  *
 765  * Reinitialize the work if it needs to be used by another worker.
 766  * For example, when the worker was stopped and started again.
 767  */
 768 bool kthread_queue_work(struct kthread_worker *worker,
 769                         struct kthread_work *work)
 770 {
 771         bool ret = false;
 772         unsigned long flags;
 773
 774         spin_lock_irqsave(&worker->lock, flags);
 775         if (!queuing_blocked(worker, work)) {
 776                 kthread_insert_work(worker, work, &worker->work_list);
 777                 ret = true;
 778         }
 779         spin_unlock_irqrestore(&worker->lock, flags);
 780         return ret;
 781 }
 782 EXPORT_SYMBOL_GPL(kthread_queue_work);
 783
 784 /**
 785  * kthread_delayed_work_timer_fn - callback that queues the associated kthread
 786  *      delayed work when the timer expires.
 787  * @__data: pointer to the data associated with the timer
 788  *
 789  * The format of the function is defined by struct timer_list.
 790  * It should have been called from irqsafe timer with irq already off.
 791  */
 792 void kthread_delayed_work_timer_fn(unsigned long __data)
 793 {
 794         struct kthread_delayed_work *dwork =
 795                 (struct kthread_delayed_work *)__data;
 796         struct kthread_work *work = &dwork->work;
 797         struct kthread_worker *worker = work->worker;
 798
 799         /*
 800          * This might happen when a pending work is reinitialized.
 801          * It means that it is used a wrong way.
 802          */
 803         if (WARN_ON_ONCE(!worker))
 804                 return;
 805
 806         spin_lock(&worker->lock);
 807         /* Work must not be used with >1 worker, see kthread_queue_work(). */
 808         WARN_ON_ONCE(work->worker != worker);
 809
 810         /* Move the work from worker->delayed_work_list. */
 811         WARN_ON_ONCE(list_empty(&work->node));
 812         list_del_init(&work->node);
 813         kthread_insert_work(worker, work, &worker->work_list);
 814
 815         spin_unlock(&worker->lock);
 816 }
 817 EXPORT_SYMBOL(kthread_delayed_work_timer_fn);
 818
 819 void __kthread_queue_delayed_work(struct kthread_worker *worker,
 820                                   struct kthread_delayed_work *dwork,
 821                                   unsigned long delay)
 822 {
 823         struct timer_list *timer = &dwork->timer;
 824         struct kthread_work *work = &dwork->work;
 825
 826         WARN_ON_ONCE(timer->function != kthread_delayed_work_timer_fn ||
 827                      timer->data != (unsigned long)dwork);
 828
 829         /*
 830          * If @delay is 0, queue @dwork->work immediately.  This is for
 831          * both optimization and correctness.  The earliest @timer can
 832          * expire is on the closest next tick and delayed_work users depend
 833          * on that there's no such delay when @delay is 0.
 834          */
 835         if (!delay) {
 836                 kthread_insert_work(worker, work, &worker->work_list);
 837                 return;
 838         }
 839
 840         /* Be paranoid and try to detect possible races already now. */
 841         kthread_insert_work_sanity_check(worker, work);
 842
 843         list_add(&work->node, &worker->delayed_work_list);
 844         work->worker = worker;
 845         timer_stats_timer_set_start_info(&dwork->timer);
 846         timer->expires = jiffies + delay;
 847         add_timer(timer);
 848 }
 849
 850 /**
 851  * kthread_queue_delayed_work - queue the associated kthread work
 852  *      after a delay.
 853  * @worker: target kthread_worker
 854  * @dwork: kthread_delayed_work to queue
 855  * @delay: number of jiffies to wait before queuing
 856  *
 857  * If the work has not been pending it starts a timer that will queue
 858  * the work after the given @delay. If @delay is zero, it queues the
 859  * work immediately.
 860  *
 861  * Return: %false if the @work has already been pending. It means that
 862  * either the timer was running or the work was queued. It returns %true
 863  * otherwise.
 864  */
 865 bool kthread_queue_delayed_work(struct kthread_worker *worker,
 866                                 struct kthread_delayed_work *dwork,
 867                                 unsigned long delay)
 868 {
 869         struct kthread_work *work = &dwork->work;
 870         unsigned long flags;
 871         bool ret = false;
 872
 873         spin_lock_irqsave(&worker->lock, flags);
 874
 875         if (!queuing_blocked(worker, work)) {
 876                 __kthread_queue_delayed_work(worker, dwork, delay);
 877                 ret = true;
 878         }
 879
 880         spin_unlock_irqrestore(&worker->lock, flags);
 881         return ret;
 882 }
 883 EXPORT_SYMBOL_GPL(kthread_queue_delayed_work);
 884
 885 struct kthread_flush_work {
 886         struct kthread_work     work;
 887         struct completion       done;
 888 };
 889
 890 static void kthread_flush_work_fn(struct kthread_work *work)
 891 {
 892         struct kthread_flush_work *fwork =
 893                 container_of(work, struct kthread_flush_work, work);
 894         complete(&fwork->done);
 895 }
 896
 897 /**
 898  * kthread_flush_work - flush a kthread_work
 899  * @work: work to flush
 900  *
 901  * If @work is queued or executing, wait for it to finish execution.
 902  */
 903 void kthread_flush_work(struct kthread_work *work)
 904 {
 905         struct kthread_flush_work fwork = {
 906                 KTHREAD_WORK_INIT(fwork.work, kthread_flush_work_fn),
 907                 COMPLETION_INITIALIZER_ONSTACK(fwork.done),
 908         };
 909         struct kthread_worker *worker;
 910         bool noop = false;
 911
 912         worker = work->worker;
 913         if (!worker)
 914                 return;
 915
 916         spin_lock_irq(&worker->lock);
 917         /* Work must not be used with >1 worker, see kthread_queue_work(). */
 918         WARN_ON_ONCE(work->worker != worker);
 919
 920         if (!list_empty(&work->node))
 921                 kthread_insert_work(worker, &fwork.work, work->node.next);
 922         else if (worker->current_work == work)
 923                 kthread_insert_work(worker, &fwork.work,
 924                                     worker->work_list.next);
 925         else
 926                 noop = true;
 927
 928         spin_unlock_irq(&worker->lock);
 929
 930         if (!noop)
 931                 wait_for_completion(&fwork.done);
 932 }
 933 EXPORT_SYMBOL_GPL(kthread_flush_work);
 934
 935 /*
 936  * This function removes the work from the worker queue. Also it makes sure
 937  * that it won't get queued later via the delayed work's timer.
 938  *
 939  * The work might still be in use when this function finishes. See the
 940  * current_work proceed by the worker.
 941  *
 942  * Return: %true if @work was pending and successfully canceled,
 943  *      %false if @work was not pending
 944  */
 945 static bool __kthread_cancel_work(struct kthread_work *work, bool is_dwork,
 946                                   unsigned long *flags)
 947 {
 948         /* Try to cancel the timer if exists. */
 949         if (is_dwork) {
 950                 struct kthread_delayed_work *dwork =
 951                         container_of(work, struct kthread_delayed_work, work);
 952                 struct kthread_worker *worker = work->worker;
 953
 954                 /*
 955                  * del_timer_sync() must be called to make sure that the timer
 956                  * callback is not running. The lock must be temporary released
 957                  * to avoid a deadlock with the callback. In the meantime,
 958                  * any queuing is blocked by setting the canceling counter.
 959                  */
 960                 work->canceling++;
 961                 spin_unlock_irqrestore(&worker->lock, *flags);
 962                 del_timer_sync(&dwork->timer);
 963                 spin_lock_irqsave(&worker->lock, *flags);
 964                 work->canceling--;
 965         }
 966
 967         /*
 968          * Try to remove the work from a worker list. It might either
 969          * be from worker->work_list or from worker->delayed_work_list.
 970          */
 971         if (!list_empty(&work->node)) {
 972                 list_del_init(&work->node);
 973                 return true;
 974         }
 975
 976         return false;
 977 }
 978
 979 static bool __kthread_cancel_work_sync(struct kthread_work *work, bool is_dwork)
 980 {
 981         struct kthread_worker *worker = work->worker;
 982         unsigned long flags;
 983         int ret = false;
 984
 985         if (!worker)
 986                 goto out;
 987
 988         spin_lock_irqsave(&worker->lock, flags);
 989         /* Work must not be used with >1 worker, see kthread_queue_work(). */
 990         WARN_ON_ONCE(work->worker != worker);
 991
 992         ret = __kthread_cancel_work(work, is_dwork, &flags);
 993
 994         if (worker->current_work != work)
 995                 goto out_fast;
 996
 997         /*
 998          * The work is in progress and we need to wait with the lock released.
 999          * In the meantime, block any queuing by setting the canceling counter.
1000          */
1001         work->canceling++;
1002         spin_unlock_irqrestore(&worker->lock, flags);
1003         kthread_flush_work(work);
1004         spin_lock_irqsave(&worker->lock, flags);
1005         work->canceling--;
1006
1007 out_fast:
1008         spin_unlock_irqrestore(&worker->lock, flags);
1009 out:
1010         return ret;
1011 }
1012
1013 /**
1014  * kthread_cancel_work_sync - cancel a kthread work and wait for it to finish
1015  * @work: the kthread work to cancel
1016  *
1017  * Cancel @work and wait for its execution to finish.  This function
1018  * can be used even if the work re-queues itself. On return from this
1019  * function, @work is guaranteed to be not pending or executing on any CPU.
1020  *
1021  * kthread_cancel_work_sync(&delayed_work->work) must not be used for
1022  * delayed_work's. Use kthread_cancel_delayed_work_sync() instead.
1023  *
1024  * The caller must ensure that the worker on which @work was last
1025  * queued can't be destroyed before this function returns.
1026  *
1027  * Return: %true if @work was pending, %false otherwise.
1028  */
1029 bool kthread_cancel_work_sync(struct kthread_work *work)
1030 {
1031         return __kthread_cancel_work_sync(work, false);
1032 }
1033 EXPORT_SYMBOL_GPL(kthread_cancel_work_sync);
1034
1035 /**
1036  * kthread_cancel_delayed_work_sync - cancel a kthread delayed work and
1037  *      wait for it to finish.
1038  * @dwork: the kthread delayed work to cancel
1039  *
1040  * This is kthread_cancel_work_sync() for delayed works.
1041  *
1042  * Return: %true if @dwork was pending, %false otherwise.
1043  */
1044 bool kthread_cancel_delayed_work_sync(struct kthread_delayed_work *dwork)
1045 {
1046         return __kthread_cancel_work_sync(&dwork->work, true);
1047 }
1048 EXPORT_SYMBOL_GPL(kthread_cancel_delayed_work_sync);
1049
1050 /**
1051  * kthread_flush_worker - flush all current works on a kthread_worker
1052  * @worker: worker to flush
1053  *
1054  * Wait until all currently executing or pending works on @worker are
1055  * finished.
1056  */
1057 void kthread_flush_worker(struct kthread_worker *worker)
1058 {
1059         struct kthread_flush_work fwork = {
1060                 KTHREAD_WORK_INIT(fwork.work, kthread_flush_work_fn),
1061                 COMPLETION_INITIALIZER_ONSTACK(fwork.done),
1062         };
1063
1064         kthread_queue_work(worker, &fwork.work);
1065         wait_for_completion(&fwork.done);
1066 }
1067 EXPORT_SYMBOL_GPL(kthread_flush_worker);
1068
1069 /**
1070  * kthread_destroy_worker - destroy a kthread worker
1071  * @worker: worker to be destroyed
1072  *
1073  * Flush and destroy @worker.  The simple flush is enough because the kthread
1074  * worker API is used only in trivial scenarios.  There are no multi-step state
1075  * machines needed.
1076  */
1077 void kthread_destroy_worker(struct kthread_worker *worker)
1078 {
1079         struct task_struct *task;
1080
1081         task = worker->task;
1082         if (WARN_ON(!task))
1083                 return;
1084
1085         kthread_flush_worker(worker);
1086         kthread_stop(task);
1087         WARN_ON(!list_empty(&worker->work_list));
1088         kfree(worker);
1089 }
1090 EXPORT_SYMBOL(kthread_destroy_worker);