[mirror_ubuntu-bionic-kernel.git] / spl / include / sys / taskq.h

/*****************************************************************************\
 *  Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC.
 *  Copyright (C) 2007 The Regents of the University of California.
 *  Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
 *  Written by Brian Behlendorf <behlendorf1@llnl.gov>.
 *  UCRL-CODE-235197
 *
 *  This file is part of the SPL, Solaris Porting Layer.
 *  For details, see <http://zfsonlinux.org/>.
 *
 *  The SPL is free software; you can redistribute it and/or modify it
 *  under the terms of the GNU General Public License as published by the
 *  Free Software Foundation; either version 2 of the License, or (at your
 *  option) any later version.
 *
 *  The SPL is distributed in the hope that it will be useful, but WITHOUT
 *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 *  for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with the SPL.  If not, see <http://www.gnu.org/licenses/>.
\*****************************************************************************/

#ifndef _SPL_TASKQ_H
#define _SPL_TASKQ_H

#include <linux/module.h>
#include <linux/gfp.h>
#include <linux/slab.h>
#include <linux/interrupt.h>
#include <linux/kthread.h>
#include <linux/wait_compat.h>
#include <sys/types.h>
#include <sys/thread.h>

#define TASKQ_NAMELEN		31

#define TASKQ_PREPOPULATE	0x00000001
#define TASKQ_CPR_SAFE		0x00000002
#define TASKQ_DYNAMIC		0x00000004
#define TASKQ_THREADS_CPU_PCT	0x00000008
#define TASKQ_DC_BATCH		0x00000010
#define TASKQ_ACTIVE		0x80000000

/*
 * Flags for taskq_dispatch. TQ_SLEEP/TQ_NOSLEEP should be same as
 * KM_SLEEP/KM_NOSLEEP.  TQ_NOQUEUE/TQ_NOALLOC are set particularly
 * large so as not to conflict with already used GFP_* defines.
 */
#define TQ_SLEEP		0x00000000
#define TQ_NOSLEEP		0x00000001
#define TQ_PUSHPAGE		0x00000002
#define TQ_NOQUEUE		0x01000000
#define TQ_NOALLOC		0x02000000
#define TQ_NEW			0x04000000
#define TQ_FRONT		0x08000000

typedef unsigned long taskqid_t;
typedef void (task_func_t)(void *);

typedef struct taskq {
	spinlock_t		tq_lock;       /* protects taskq_t */
	unsigned long		tq_lock_flags; /* interrupt state */
	char			*tq_name;      /* taskq name */
	struct list_head	tq_thread_list;/* list of all threads */
	struct list_head	tq_active_list;/* list of active threads */
	int			tq_nactive;    /* # of active threads */
	int			tq_nthreads;   /* # of existing threads */
	int			tq_nspawn;     /* # of threads being spawned */
	int			tq_maxthreads; /* # of threads maximum */
	int			tq_pri;        /* priority */
	int			tq_minalloc;   /* min task_t pool size */
	int			tq_maxalloc;   /* max task_t pool size */
	int			tq_nalloc;     /* cur task_t pool size */
	uint_t			tq_flags;      /* flags */
	taskqid_t		tq_next_id;    /* next pend/work id */
	taskqid_t		tq_lowest_id;  /* lowest pend/work id */
	struct list_head	tq_free_list;  /* free task_t's */
	struct list_head	tq_pend_list;  /* pending task_t's */
	struct list_head	tq_prio_list;  /* priority pending task_t's */
	struct list_head	tq_delay_list; /* delayed task_t's */
	spl_wait_queue_head_t	tq_work_waitq; /* new work waitq */
	spl_wait_queue_head_t	tq_wait_waitq; /* wait waitq */
} taskq_t;

typedef struct taskq_ent {
	spinlock_t		tqent_lock;
	spl_wait_queue_head_t	tqent_waitq;
	struct timer_list	tqent_timer;
	struct list_head	tqent_list;
	taskqid_t		tqent_id;
	task_func_t		*tqent_func;
	void			*tqent_arg;
	taskq_t			*tqent_taskq;
	uintptr_t		tqent_flags;
} taskq_ent_t;

#define TQENT_FLAG_PREALLOC     0x1
#define TQENT_FLAG_CANCEL       0x2

typedef struct taskq_thread {
	struct list_head	tqt_thread_list;
	struct list_head	tqt_active_list;
	struct task_struct	*tqt_thread;
	taskq_t			*tqt_tq;
	taskqid_t		tqt_id;
	taskq_ent_t		*tqt_task;
	uintptr_t		tqt_flags;
} taskq_thread_t;

/* Global system-wide dynamic task queue available for all consumers */
extern taskq_t *system_taskq;

extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
extern taskqid_t taskq_dispatch_delay(taskq_t *, task_func_t, void *,
    uint_t, clock_t);
extern void taskq_dispatch_ent(taskq_t *, task_func_t, void *, uint_t,
    taskq_ent_t *);
extern int taskq_empty_ent(taskq_ent_t *);
extern void taskq_init_ent(taskq_ent_t *);
extern taskq_t *taskq_create(const char *, int, pri_t, int, int, uint_t);
extern void taskq_destroy(taskq_t *);
extern void taskq_wait_id(taskq_t *, taskqid_t);
extern void taskq_wait_outstanding(taskq_t *, taskqid_t);
extern void taskq_wait(taskq_t *);
extern int taskq_cancel_id(taskq_t *, taskqid_t);
extern int taskq_member(taskq_t *, void *);

#define taskq_create_proc(name, nthreads, pri, min, max, proc, flags) \
    taskq_create(name, nthreads, pri, min, max, flags)
#define taskq_create_sysdc(name, nthreads, min, max, proc, dc, flags) \
    taskq_create(name, nthreads, maxclsyspri, min, max, flags)

int spl_taskq_init(void);
void spl_taskq_fini(void);

#endif  /* _SPL_TASKQ_H */
Commit	Line	Data
70e083d2 TG	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://zfsonlinux.org/>.
	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>
3ab1144a	33	#include <linux/wait_compat.h>
70e083d2 TG	34	#include <sys/types.h>
	35	#include <sys/thread.h>
	36
	37	#define TASKQ_NAMELEN 31
	38
	39	#define TASKQ_PREPOPULATE 0x00000001
	40	#define TASKQ_CPR_SAFE 0x00000002
	41	#define TASKQ_DYNAMIC 0x00000004
	42	#define TASKQ_THREADS_CPU_PCT 0x00000008
	43	#define TASKQ_DC_BATCH 0x00000010
	44	#define TASKQ_ACTIVE 0x80000000
	45
	46	/*
	47	* Flags for taskq_dispatch. TQ_SLEEP/TQ_NOSLEEP should be same as
	48	* KM_SLEEP/KM_NOSLEEP. TQ_NOQUEUE/TQ_NOALLOC are set particularly
	49	* large so as not to conflict with already used GFP_* defines.
	50	*/
	51	#define TQ_SLEEP 0x00000000
	52	#define TQ_NOSLEEP 0x00000001
	53	#define TQ_PUSHPAGE 0x00000002
	54	#define TQ_NOQUEUE 0x01000000
	55	#define TQ_NOALLOC 0x02000000
	56	#define TQ_NEW 0x04000000
	57	#define TQ_FRONT 0x08000000
	58
	59	typedef unsigned long taskqid_t;
	60	typedef void (task_func_t)(void *);
	61
	62	typedef struct taskq {
	63	spinlock_t tq_lock; /* protects taskq_t */
	64	unsigned long tq_lock_flags; /* interrupt state */
	65	char tq_name; / taskq name */
	66	struct list_head tq_thread_list;/* list of all threads */
	67	struct list_head tq_active_list;/* list of active threads */
	68	int tq_nactive; /* # of active threads */
	69	int tq_nthreads; /* # of existing threads */
	70	int tq_nspawn; /* # of threads being spawned */
	71	int tq_maxthreads; /* # of threads maximum */
	72	int tq_pri; /* priority */
	73	int tq_minalloc; /* min task_t pool size */
	74	int tq_maxalloc; /* max task_t pool size */
	75	int tq_nalloc; /* cur task_t pool size */
	76	uint_t tq_flags; /* flags */
	77	taskqid_t tq_next_id; /* next pend/work id */
	78	taskqid_t tq_lowest_id; /* lowest pend/work id */
	79	struct list_head tq_free_list; /* free task_t's */
	80	struct list_head tq_pend_list; /* pending task_t's */
	81	struct list_head tq_prio_list; /* priority pending task_t's */
	82	struct list_head tq_delay_list; /* delayed task_t's */
3ab1144a CIK	83	spl_wait_queue_head_t tq_work_waitq; /* new work waitq */
3ab1144a CIK	84	spl_wait_queue_head_t tq_wait_waitq; /* wait waitq */
70e083d2 TG	85	} taskq_t;
	86
	87	typedef struct taskq_ent {
	88	spinlock_t tqent_lock;
3ab1144a	89	spl_wait_queue_head_t tqent_waitq;
70e083d2 TG	90	struct timer_list tqent_timer;
	91	struct list_head tqent_list;
	92	taskqid_t tqent_id;
	93	task_func_t *tqent_func;
	94	void *tqent_arg;
	95	taskq_t *tqent_taskq;
	96	uintptr_t tqent_flags;
	97	} taskq_ent_t;
	98
	99	#define TQENT_FLAG_PREALLOC 0x1
	100	#define TQENT_FLAG_CANCEL 0x2
	101
	102	typedef struct taskq_thread {
	103	struct list_head tqt_thread_list;
	104	struct list_head tqt_active_list;
	105	struct task_struct *tqt_thread;
	106	taskq_t *tqt_tq;
	107	taskqid_t tqt_id;
	108	taskq_ent_t *tqt_task;
	109	uintptr_t tqt_flags;
	110	} taskq_thread_t;
	111
	112	/* Global system-wide dynamic task queue available for all consumers */
	113	extern taskq_t *system_taskq;
	114
	115	extern taskqid_t taskq_dispatch(taskq_t , task_func_t, void , uint_t);
	116	extern taskqid_t taskq_dispatch_delay(taskq_t , task_func_t, void ,
	117	uint_t, clock_t);
	118	extern void taskq_dispatch_ent(taskq_t , task_func_t, void , uint_t,
	119	taskq_ent_t *);
	120	extern int taskq_empty_ent(taskq_ent_t *);
	121	extern void taskq_init_ent(taskq_ent_t *);
	122	extern taskq_t taskq_create(const char , int, pri_t, int, int, uint_t);
	123	extern void taskq_destroy(taskq_t *);
	124	extern void taskq_wait_id(taskq_t *, taskqid_t);
	125	extern void taskq_wait_outstanding(taskq_t *, taskqid_t);
	126	extern void taskq_wait(taskq_t *);
	127	extern int taskq_cancel_id(taskq_t *, taskqid_t);
	128	extern int taskq_member(taskq_t , void );
	129
	130	#define taskq_create_proc(name, nthreads, pri, min, max, proc, flags) \
	131	taskq_create(name, nthreads, pri, min, max, flags)
	132	#define taskq_create_sysdc(name, nthreads, min, max, proc, dc, flags) \
	133	taskq_create(name, nthreads, maxclsyspri, min, max, flags)
	134
	135	int spl_taskq_init(void);
	136	void spl_taskq_fini(void);
	137
	138	#endif /* _SPL_TASKQ_H */