include/os/freebsd/spl/sys/taskq.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or https://opensource.org/licenses/CDDL-1.0.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 /*
  22  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
  23  * Use is subject to license terms.
  24  */
  25
  26 #ifndef _SYS_TASKQ_H
  27 #define _SYS_TASKQ_H
  28
  29 #ifdef _KERNEL
  30
  31 #include <sys/types.h>
  32 #include <sys/proc.h>
  33 #include <sys/queue.h>
  34 #include <sys/taskqueue.h>
  35 #include <sys/thread.h>
  36
  37 #ifdef  __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 #define TASKQ_NAMELEN   31
  42
  43 typedef struct taskq {
  44         struct taskqueue        *tq_queue;
  45 } taskq_t;
  46
  47 typedef uintptr_t taskqid_t;
  48 typedef void (task_func_t)(void *);
  49
  50 typedef struct taskq_ent {
  51         union {
  52                 struct task      tqent_task;
  53                 struct timeout_task tqent_timeout_task;
  54         };
  55         task_func_t     *tqent_func;
  56         void            *tqent_arg;
  57         taskqid_t        tqent_id;
  58         LIST_ENTRY(taskq_ent) tqent_hash;
  59         uint_t           tqent_type;
  60         volatile uint_t  tqent_rc;
  61 } taskq_ent_t;
  62
  63 /*
  64  * Public flags for taskq_create(): bit range 0-15
  65  */
  66 #define TASKQ_PREPOPULATE       0x0001  /* Prepopulate with threads and data */
  67 #define TASKQ_CPR_SAFE          0x0002  /* Use CPR safe protocol */
  68 #define TASKQ_DYNAMIC           0x0004  /* Use dynamic thread scheduling */
  69 #define TASKQ_THREADS_CPU_PCT   0x0008  /* number of threads as % of ncpu */
  70 #define TASKQ_DC_BATCH          0x0010  /* Taskq uses SDC in batch mode */
  71
  72 /*
  73  * Flags for taskq_dispatch. TQ_SLEEP/TQ_NOSLEEP should be same as
  74  * KM_SLEEP/KM_NOSLEEP.
  75  */
  76 #define TQ_SLEEP        0x00    /* Can block for memory */
  77 #define TQ_NOSLEEP      0x01    /* cannot block for memory; may fail */
  78 #define TQ_NOQUEUE      0x02    /* Do not enqueue if can't dispatch */
  79 #define TQ_NOALLOC      0x04    /* cannot allocate memory; may fail */
  80 #define TQ_FRONT        0x08    /* Put task at the front of the queue */
  81
  82 #define TASKQID_INVALID         ((taskqid_t)0)
  83
  84 #define taskq_init_ent(x)
  85 extern taskq_t *system_taskq;
  86 /* Global dynamic task queue for long delay */
  87 extern taskq_t *system_delay_taskq;
  88
  89 extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
  90 extern taskqid_t taskq_dispatch_delay(taskq_t *, task_func_t, void *,
  91     uint_t, clock_t);
  92 extern void taskq_dispatch_ent(taskq_t *, task_func_t, void *, uint_t,
  93     taskq_ent_t *);
  94 extern int taskq_empty_ent(taskq_ent_t *);
  95 taskq_t *taskq_create(const char *, int, pri_t, int, int, uint_t);
  96 taskq_t *taskq_create_instance(const char *, int, int, pri_t, int, int, uint_t);
  97 taskq_t *taskq_create_proc(const char *, int, pri_t, int, int,
  98     struct proc *, uint_t);
  99 taskq_t *taskq_create_sysdc(const char *, int, int, int,
 100     struct proc *, uint_t, uint_t);
 101 void    nulltask(void *);
 102 extern void taskq_destroy(taskq_t *);
 103 extern void taskq_wait_id(taskq_t *, taskqid_t);
 104 extern void taskq_wait_outstanding(taskq_t *, taskqid_t);
 105 extern void taskq_wait(taskq_t *);
 106 extern int taskq_cancel_id(taskq_t *, taskqid_t);
 107 extern int taskq_member(taskq_t *, kthread_t *);
 108 extern taskq_t *taskq_of_curthread(void);
 109 void    taskq_suspend(taskq_t *);
 110 int     taskq_suspended(taskq_t *);
 111 void    taskq_resume(taskq_t *);
 112
 113 #ifdef  __cplusplus
 114 }
 115 #endif
 116
 117 #endif /* _KERNEL */
 118
 119 #ifdef _STANDALONE
 120 typedef int taskq_ent_t;
 121 #define taskq_init_ent(x)
 122 #endif /* _STANDALONE */
 123
 124 #endif  /* _SYS_TASKQ_H */