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