xref: /onnv-gate/usr/src/uts/common/sys/taskq.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef	_SYS_TASKQ_H
28*0Sstevel@tonic-gate #define	_SYS_TASKQ_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #include <sys/types.h>
33*0Sstevel@tonic-gate #include <sys/thread.h>
34*0Sstevel@tonic-gate 
35*0Sstevel@tonic-gate #ifdef	__cplusplus
36*0Sstevel@tonic-gate extern "C" {
37*0Sstevel@tonic-gate #endif
38*0Sstevel@tonic-gate 
39*0Sstevel@tonic-gate #define	TASKQ_NAMELEN	31
40*0Sstevel@tonic-gate 
41*0Sstevel@tonic-gate typedef struct taskq taskq_t;
42*0Sstevel@tonic-gate typedef uintptr_t taskqid_t;
43*0Sstevel@tonic-gate typedef void (task_func_t)(void *);
44*0Sstevel@tonic-gate 
45*0Sstevel@tonic-gate /*
46*0Sstevel@tonic-gate  * Public flags for taskq_create(): bit range 0-15
47*0Sstevel@tonic-gate  */
48*0Sstevel@tonic-gate #define	TASKQ_PREPOPULATE	0x0001	/* Prepopulate with threads and data */
49*0Sstevel@tonic-gate #define	TASKQ_CPR_SAFE		0x0002	/* Use CPR safe protocol */
50*0Sstevel@tonic-gate #define	TASKQ_DYNAMIC		0x0004	/* Use dynamic thread scheduling */
51*0Sstevel@tonic-gate 
52*0Sstevel@tonic-gate /*
53*0Sstevel@tonic-gate  * Flags for taskq_dispatch. TQ_SLEEP/TQ_NOSLEEP should be same as
54*0Sstevel@tonic-gate  * KM_SLEEP/KM_NOSLEEP.
55*0Sstevel@tonic-gate  */
56*0Sstevel@tonic-gate #define	TQ_SLEEP	0x00	/* Can block for memory */
57*0Sstevel@tonic-gate #define	TQ_NOSLEEP	0x01	/* cannot block for memory; may fail */
58*0Sstevel@tonic-gate #define	TQ_NOQUEUE	0x02	/* Do not enqueue if can't dispatch */
59*0Sstevel@tonic-gate #define	TQ_NOALLOC	0x04	/* cannot allocate memory; may fail */
60*0Sstevel@tonic-gate 
61*0Sstevel@tonic-gate #ifdef _KERNEL
62*0Sstevel@tonic-gate 
63*0Sstevel@tonic-gate extern taskq_t *system_taskq;
64*0Sstevel@tonic-gate 
65*0Sstevel@tonic-gate extern void	taskq_init(void);
66*0Sstevel@tonic-gate 
67*0Sstevel@tonic-gate extern taskq_t	*taskq_create(const char *, int, pri_t, int, int, uint_t);
68*0Sstevel@tonic-gate extern taskq_t	*taskq_create_instance(const char *, int, int, pri_t, int,
69*0Sstevel@tonic-gate     int, uint_t);
70*0Sstevel@tonic-gate extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
71*0Sstevel@tonic-gate extern void	nulltask(void *);
72*0Sstevel@tonic-gate extern void	taskq_destroy(taskq_t *);
73*0Sstevel@tonic-gate extern void	taskq_wait(taskq_t *);
74*0Sstevel@tonic-gate extern void	taskq_suspend(taskq_t *);
75*0Sstevel@tonic-gate extern int	taskq_suspended(taskq_t *);
76*0Sstevel@tonic-gate extern void	taskq_resume(taskq_t *);
77*0Sstevel@tonic-gate extern int	taskq_member(taskq_t *, kthread_t *);
78*0Sstevel@tonic-gate 
79*0Sstevel@tonic-gate #endif	/* _KERNEL */
80*0Sstevel@tonic-gate 
81*0Sstevel@tonic-gate #ifdef	__cplusplus
82*0Sstevel@tonic-gate }
83*0Sstevel@tonic-gate #endif
84*0Sstevel@tonic-gate 
85*0Sstevel@tonic-gate #endif	/* _SYS_TASKQ_H */
86