xref: /illumos-gate/usr/src/uts/common/sys/taskq.h (revision 35a5a3587fd94b666239c157d3722745250ccbd7)
17c478bd9Sstevel@tonic-gate /*
27c478bd9Sstevel@tonic-gate  * CDDL HEADER START
37c478bd9Sstevel@tonic-gate  *
47c478bd9Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
52e0c549eSJonathan Adams  * Common Development and Distribution License (the "License").
62e0c549eSJonathan Adams  * You may not use this file except in compliance with the License.
77c478bd9Sstevel@tonic-gate  *
87c478bd9Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
97c478bd9Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
107c478bd9Sstevel@tonic-gate  * See the License for the specific language governing permissions
117c478bd9Sstevel@tonic-gate  * and limitations under the License.
127c478bd9Sstevel@tonic-gate  *
137c478bd9Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
147c478bd9Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
157c478bd9Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
167c478bd9Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
177c478bd9Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
187c478bd9Sstevel@tonic-gate  *
197c478bd9Sstevel@tonic-gate  * CDDL HEADER END
207c478bd9Sstevel@tonic-gate  */
217c478bd9Sstevel@tonic-gate /*
222e0c549eSJonathan Adams  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
237c478bd9Sstevel@tonic-gate  * Use is subject to license terms.
247c478bd9Sstevel@tonic-gate  */
257c478bd9Sstevel@tonic-gate 
267c478bd9Sstevel@tonic-gate #ifndef	_SYS_TASKQ_H
277c478bd9Sstevel@tonic-gate #define	_SYS_TASKQ_H
287c478bd9Sstevel@tonic-gate 
297c478bd9Sstevel@tonic-gate #include <sys/types.h>
307c478bd9Sstevel@tonic-gate #include <sys/thread.h>
317c478bd9Sstevel@tonic-gate 
327c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
337c478bd9Sstevel@tonic-gate extern "C" {
347c478bd9Sstevel@tonic-gate #endif
357c478bd9Sstevel@tonic-gate 
367c478bd9Sstevel@tonic-gate #define	TASKQ_NAMELEN	31
377c478bd9Sstevel@tonic-gate 
387c478bd9Sstevel@tonic-gate typedef struct taskq taskq_t;
397c478bd9Sstevel@tonic-gate typedef uintptr_t taskqid_t;
407c478bd9Sstevel@tonic-gate typedef void (task_func_t)(void *);
417c478bd9Sstevel@tonic-gate 
42*35a5a358SJonathan Adams struct proc;
43*35a5a358SJonathan Adams 
447c478bd9Sstevel@tonic-gate /*
457c478bd9Sstevel@tonic-gate  * Public flags for taskq_create(): bit range 0-15
467c478bd9Sstevel@tonic-gate  */
477c478bd9Sstevel@tonic-gate #define	TASKQ_PREPOPULATE	0x0001	/* Prepopulate with threads and data */
487c478bd9Sstevel@tonic-gate #define	TASKQ_CPR_SAFE		0x0002	/* Use CPR safe protocol */
497c478bd9Sstevel@tonic-gate #define	TASKQ_DYNAMIC		0x0004	/* Use dynamic thread scheduling */
502e0c549eSJonathan Adams #define	TASKQ_THREADS_CPU_PCT	0x0008	/* number of threads as % of ncpu */
51*35a5a358SJonathan Adams #define	TASKQ_DC_BATCH		0x0010	/* Taskq uses SDC in batch mode */
527c478bd9Sstevel@tonic-gate 
537c478bd9Sstevel@tonic-gate /*
547c478bd9Sstevel@tonic-gate  * Flags for taskq_dispatch. TQ_SLEEP/TQ_NOSLEEP should be same as
557c478bd9Sstevel@tonic-gate  * KM_SLEEP/KM_NOSLEEP.
567c478bd9Sstevel@tonic-gate  */
577c478bd9Sstevel@tonic-gate #define	TQ_SLEEP	0x00	/* Can block for memory */
587c478bd9Sstevel@tonic-gate #define	TQ_NOSLEEP	0x01	/* cannot block for memory; may fail */
597c478bd9Sstevel@tonic-gate #define	TQ_NOQUEUE	0x02	/* Do not enqueue if can't dispatch */
607c478bd9Sstevel@tonic-gate #define	TQ_NOALLOC	0x04	/* cannot allocate memory; may fail */
61*35a5a358SJonathan Adams #define	TQ_FRONT	0x08	/* Put task at the front of the queue */
627c478bd9Sstevel@tonic-gate 
637c478bd9Sstevel@tonic-gate #ifdef _KERNEL
647c478bd9Sstevel@tonic-gate 
657c478bd9Sstevel@tonic-gate extern taskq_t *system_taskq;
667c478bd9Sstevel@tonic-gate 
677c478bd9Sstevel@tonic-gate extern void	taskq_init(void);
682e0c549eSJonathan Adams extern void	taskq_mp_init(void);
697c478bd9Sstevel@tonic-gate 
707c478bd9Sstevel@tonic-gate extern taskq_t	*taskq_create(const char *, int, pri_t, int, int, uint_t);
717c478bd9Sstevel@tonic-gate extern taskq_t	*taskq_create_instance(const char *, int, int, pri_t, int,
727c478bd9Sstevel@tonic-gate     int, uint_t);
73*35a5a358SJonathan Adams extern taskq_t	*taskq_create_proc(const char *, int, pri_t, int, int,
74*35a5a358SJonathan Adams     struct proc *, uint_t);
75*35a5a358SJonathan Adams extern taskq_t	*taskq_create_sysdc(const char *, int, int, int,
76*35a5a358SJonathan Adams     struct proc *, uint_t, uint_t);
777c478bd9Sstevel@tonic-gate extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
787c478bd9Sstevel@tonic-gate extern void	nulltask(void *);
797c478bd9Sstevel@tonic-gate extern void	taskq_destroy(taskq_t *);
807c478bd9Sstevel@tonic-gate extern void	taskq_wait(taskq_t *);
817c478bd9Sstevel@tonic-gate extern void	taskq_suspend(taskq_t *);
827c478bd9Sstevel@tonic-gate extern int	taskq_suspended(taskq_t *);
837c478bd9Sstevel@tonic-gate extern void	taskq_resume(taskq_t *);
847c478bd9Sstevel@tonic-gate extern int	taskq_member(taskq_t *, kthread_t *);
857c478bd9Sstevel@tonic-gate 
867c478bd9Sstevel@tonic-gate #endif	/* _KERNEL */
877c478bd9Sstevel@tonic-gate 
887c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
897c478bd9Sstevel@tonic-gate }
907c478bd9Sstevel@tonic-gate #endif
917c478bd9Sstevel@tonic-gate 
927c478bd9Sstevel@tonic-gate #endif	/* _SYS_TASKQ_H */
93