sys/compat/linuxkpi/common/include/linux/kthread.h

   1 /*-
   2  * Copyright (c) 2010 Isilon Systems, Inc.
   3  * Copyright (c) 2010 iX Systems, Inc.
   4  * Copyright (c) 2010 Panasas, Inc.
   5  * Copyright (c) 2013-2016 Mellanox Technologies, Ltd.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice unmodified, this list of conditions, and the following
  13  *    disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  *
  29  * $FreeBSD$
  30  */
  31 #ifndef _LINUX_KTHREAD_H_
  32 #define _LINUX_KTHREAD_H_
  33
  34 #include <sys/param.h>
  35 #include <sys/lock.h>
  36 #include <sys/mutex.h>
  37 #include <sys/kernel.h>
  38 #include <sys/kthread.h>
  39 #include <sys/sleepqueue.h>
  40
  41 #include <linux/slab.h>
  42 #include <linux/sched.h>
  43
  44 static inline void
  45 linux_kthread_fn(void *arg)
  46 {
  47         struct task_struct *task;
  48         struct thread *td = curthread;
  49
  50         task = arg;
  51         task_struct_fill(td, task);
  52         task_struct_set(td, task);
  53         if (task->should_stop == 0)
  54                 task->task_ret = task->task_fn(task->task_data);
  55         PROC_LOCK(td->td_proc);
  56         task->should_stop = TASK_STOPPED;
  57         wakeup(task);
  58         PROC_UNLOCK(td->td_proc);
  59         task_struct_set(td, NULL);
  60         kthread_exit();
  61 }
  62
  63 static inline struct task_struct *
  64 linux_kthread_create(int (*threadfn)(void *data), void *data)
  65 {
  66         struct task_struct *task;
  67
  68         task = kzalloc(sizeof(*task), GFP_KERNEL);
  69         task->task_fn = threadfn;
  70         task->task_data = data;
  71
  72         return (task);
  73 }
  74
  75 #define kthread_run(fn, data, fmt, ...)                                 \
  76 ({                                                                      \
  77         struct task_struct *_task;                                      \
  78                                                                         \
  79         _task = linux_kthread_create((fn), (data));                     \
  80         if (kthread_add(linux_kthread_fn, _task, NULL, &_task->task_thread,     \
  81             0, 0, fmt, ## __VA_ARGS__)) {                               \
  82                 kfree(_task);                                           \
  83                 _task = NULL;                                           \
  84         }                                                               \
  85         _task;                                                          \
  86 })
  87
  88 #define kthread_should_stop()   current->should_stop
  89
  90 static inline int
  91 kthread_stop(struct task_struct *task)
  92 {
  93
  94         PROC_LOCK(task->task_thread->td_proc);
  95         task->should_stop = TASK_SHOULD_STOP;
  96         wake_up_process(task);
  97         while (task->should_stop != TASK_STOPPED)
  98                 msleep(task, &task->task_thread->td_proc->p_mtx, PWAIT,
  99                     "kstop", hz);
 100         PROC_UNLOCK(task->task_thread->td_proc);
 101         return task->task_ret;
 102 }
 103
 104 #endif  /* _LINUX_KTHREAD_H_ */