include/sys/taskq.h

   1 /*****************************************************************************\
   2  *  Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC.
   3  *  Copyright (C) 2007 The Regents of the University of California.
   4  *  Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
   5  *  Written by Brian Behlendorf <behlendorf1@llnl.gov>.
   6  *  UCRL-CODE-235197
   7  *
   8  *  This file is part of the SPL, Solaris Porting Layer.
   9  *  For details, see <http://github.com/behlendorf/spl/>.
  10  *
  11  *  The SPL is free software; you can redistribute it and/or modify it
  12  *  under the terms of the GNU General Public License as published by the
  13  *  Free Software Foundation; either version 2 of the License, or (at your
  14  *  option) any later version.
  15  *
  16  *  The SPL is distributed in the hope that it will be useful, but WITHOUT
  17  *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18  *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19  *  for more details.
  20  *
  21  *  You should have received a copy of the GNU General Public License along
  22  *  with the SPL.  If not, see <http://www.gnu.org/licenses/>.
  23 \*****************************************************************************/
  24
  25 #ifndef _SPL_TASKQ_H
  26 #define _SPL_TASKQ_H
  27
  28 #include <linux/module.h>
  29 #include <linux/gfp.h>
  30 #include <linux/slab.h>
  31 #include <linux/interrupt.h>
  32 #include <linux/kthread.h>
  33 #include <sys/types.h>
  34 #include <sys/thread.h>
  35
  36 #define TASKQ_NAMELEN           31
  37
  38 #define TASKQ_PREPOPULATE       0x00000001
  39 #define TASKQ_CPR_SAFE          0x00000002
  40 #define TASKQ_DYNAMIC           0x00000004
  41 #define TASKQ_THREADS_CPU_PCT   0x00000008
  42 #define TASKQ_DC_BATCH          0x00000010
  43
  44 typedef unsigned long taskqid_t;
  45 typedef void (task_func_t)(void *);
  46
  47 typedef struct taskq_ent {
  48         spinlock_t              tqent_lock;
  49         struct list_head        tqent_list;
  50         taskqid_t               tqent_id;
  51         task_func_t             *tqent_func;
  52         void                    *tqent_arg;
  53         uintptr_t               tqent_flags;
  54 } taskq_ent_t;
  55
  56 #define TQENT_FLAG_PREALLOC     0x1
  57
  58 /*
  59  * Flags for taskq_dispatch. TQ_SLEEP/TQ_NOSLEEP should be same as
  60  * KM_SLEEP/KM_NOSLEEP.  TQ_NOQUEUE/TQ_NOALLOC are set particularly
  61  * large so as not to conflict with already used GFP_* defines.
  62  */
  63 #define TQ_SLEEP                KM_SLEEP
  64 #define TQ_NOSLEEP              KM_NOSLEEP
  65 #define TQ_PUSHPAGE             KM_PUSHPAGE
  66 #define TQ_NOQUEUE              0x01000000
  67 #define TQ_NOALLOC              0x02000000
  68 #define TQ_NEW                  0x04000000
  69 #define TQ_FRONT                0x08000000
  70 #define TQ_ACTIVE               0x80000000
  71
  72 typedef struct taskq {
  73         spinlock_t              tq_lock;       /* protects taskq_t */
  74         unsigned long           tq_lock_flags; /* interrupt state */
  75         const char              *tq_name;      /* taskq name */
  76         struct list_head        tq_thread_list;/* list of all threads */
  77         struct list_head        tq_active_list;/* list of active threads */
  78         int                     tq_nactive;    /* # of active threads */
  79         int                     tq_nthreads;   /* # of total threads */
  80         int                     tq_pri;        /* priority */
  81         int                     tq_minalloc;   /* min task_t pool size */
  82         int                     tq_maxalloc;   /* max task_t pool size */
  83         int                     tq_nalloc;     /* cur task_t pool size */
  84         uint_t                  tq_flags;      /* flags */
  85         taskqid_t               tq_next_id;    /* next pend/work id */
  86         taskqid_t               tq_lowest_id;  /* lowest pend/work id */
  87         struct list_head        tq_free_list;  /* free task_t's */
  88         struct list_head        tq_pend_list;  /* pending task_t's */
  89         struct list_head        tq_prio_list;  /* priority pending task_t's */
  90         wait_queue_head_t       tq_work_waitq; /* new work waitq */
  91         wait_queue_head_t       tq_wait_waitq; /* wait waitq */
  92 } taskq_t;
  93
  94 typedef struct taskq_thread {
  95         struct list_head       tqt_thread_list;
  96         struct list_head       tqt_active_list;
  97         struct task_struct     *tqt_thread;
  98         taskq_t                *tqt_tq;
  99         taskqid_t              tqt_id;
 100         uintptr_t              tqt_flags;
 101 } taskq_thread_t;
 102
 103 /* Global system-wide dynamic task queue available for all consumers */
 104 extern taskq_t *system_taskq;
 105
 106 extern taskqid_t __taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
 107 extern void __taskq_dispatch_ent(taskq_t *, task_func_t, void *, uint_t, taskq_ent_t *);
 108 extern int __taskq_empty_ent(taskq_ent_t *);
 109 extern void __taskq_init_ent(taskq_ent_t *);
 110 extern taskq_t *__taskq_create(const char *, int, pri_t, int, int, uint_t);
 111 extern void __taskq_destroy(taskq_t *);
 112 extern void __taskq_wait_id(taskq_t *, taskqid_t);
 113 extern void __taskq_wait(taskq_t *);
 114 extern int __taskq_member(taskq_t *, void *);
 115
 116 int spl_taskq_init(void);
 117 void spl_taskq_fini(void);
 118
 119 #define taskq_member(tq, t)                __taskq_member(tq, t)
 120 #define taskq_wait_id(tq, id)              __taskq_wait_id(tq, id)
 121 #define taskq_wait(tq)                     __taskq_wait(tq)
 122 #define taskq_dispatch(tq, f, p, fl)       __taskq_dispatch(tq, f, p, fl)
 123 #define taskq_dispatch_ent(tq, f, p, fl, t) __taskq_dispatch_ent(tq, f, p, fl, t)
 124 #define taskq_empty_ent(t)                 __taskq_empty_ent(t)
 125 #define taskq_init_ent(t)                  __taskq_init_ent(t)
 126 #define taskq_create(n, th, p, mi, ma, fl) __taskq_create(n, th, p, mi, ma, fl)
 127 #define taskq_create_proc(n, th, p, mi, ma, pr, fl)     \
 128         __taskq_create(n, th, p, mi, ma, fl)
 129 #define taskq_create_sysdc(n, th, mi, ma, pr, dc, fl)   \
 130         __taskq_create(n, th, maxclsyspri, mi, ma, fl)
 131 #define taskq_destroy(tq)                  __taskq_destroy(tq)
 132
 133 #endif  /* _SPL_TASKQ_H */