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 http://www.opensolaris.org/os/licensing.
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 #include <sys/types.h>
30 #include <sys/proc.h>
31 #include <sys/taskqueue.h>
32 
33 #ifdef	__cplusplus
34 extern "C" {
35 #endif
36 
37 #define	TASKQ_NAMELEN	31
38 
39 struct taskqueue;
40 struct taskq {
41 	struct taskqueue	*tq_queue;
42 };
43 
44 typedef struct taskq taskq_t;
45 typedef uintptr_t taskqid_t;
46 typedef void (task_func_t)(void *);
47 
48 struct proc;
49 
50 /*
51  * Public flags for taskq_create(): bit range 0-15
52  */
53 #define	TASKQ_PREPOPULATE	0x0001	/* Prepopulate with threads and data */
54 #define	TASKQ_CPR_SAFE		0x0002	/* Use CPR safe protocol */
55 #define	TASKQ_DYNAMIC		0x0004	/* Use dynamic thread scheduling */
56 #define	TASKQ_THREADS_CPU_PCT	0x0008	/* number of threads as % of ncpu */
57 #define	TASKQ_DC_BATCH		0x0010	/* Taskq uses SDC in batch mode */
58 
59 /*
60  * Flags for taskq_dispatch. TQ_SLEEP/TQ_NOSLEEP should be same as
61  * KM_SLEEP/KM_NOSLEEP.
62  */
63 #define	TQ_SLEEP	0x00	/* Can block for memory */
64 #define	TQ_NOSLEEP	0x01	/* cannot block for memory; may fail */
65 #define	TQ_NOQUEUE	0x02	/* Do not enqueue if can't dispatch */
66 #define	TQ_NOALLOC	0x04	/* cannot allocate memory; may fail */
67 #define	TQ_FRONT	0x08	/* Put task at the front of the queue */
68 
69 #ifdef _KERNEL
70 
71 extern taskq_t *system_taskq;
72 
73 extern void	taskq_init(void);
74 extern void	taskq_mp_init(void);
75 
76 extern taskq_t	*taskq_create(const char *, int, pri_t, int, int, uint_t);
77 extern taskq_t	*taskq_create_instance(const char *, int, int, pri_t, int,
78     int, uint_t);
79 extern taskq_t	*taskq_create_proc(const char *, int, pri_t, int, int,
80     struct proc *, uint_t);
81 extern taskq_t	*taskq_create_sysdc(const char *, int, int, int,
82     struct proc *, uint_t, uint_t);
83 extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
84 extern void	nulltask(void *);
85 extern void	taskq_destroy(taskq_t *);
86 extern void	taskq_wait(taskq_t *);
87 extern void	taskq_suspend(taskq_t *);
88 extern int	taskq_suspended(taskq_t *);
89 extern void	taskq_resume(taskq_t *);
90 extern int	taskq_member(taskq_t *, kthread_t *);
91 
92 #endif	/* _KERNEL */
93 
94 #ifdef	__cplusplus
95 }
96 #endif
97 
98 #endif	/* _SYS_TASKQ_H */
99