initial commit
[freebsd-arm:freebsd-arm.git] / cddl / contrib / opensolaris / uts / common / 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 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 /*
49  * Public flags for taskq_create(): bit range 0-15
50  */
51 #define TASKQ_PREPOPULATE       0x0001  /* Prepopulate with threads and data */
52 #define TASKQ_CPR_SAFE          0x0002  /* Use CPR safe protocol */
53 #define TASKQ_DYNAMIC           0x0004  /* Use dynamic thread scheduling */
54 #define TASKQ_THREADS_CPU_PCT   0x0008  /* number of threads as % of ncpu */
55
56 /*
57  * Flags for taskq_dispatch. TQ_SLEEP/TQ_NOSLEEP should be same as
58  * KM_SLEEP/KM_NOSLEEP.
59  */
60 #define TQ_SLEEP        0x00    /* Can block for memory */
61 #define TQ_NOSLEEP      0x01    /* cannot block for memory; may fail */
62 #define TQ_NOQUEUE      0x02    /* Do not enqueue if can't dispatch */
63 #define TQ_NOALLOC      0x04    /* cannot allocate memory; may fail */
64
65 #ifdef _KERNEL
66
67 extern taskq_t *system_taskq;
68
69 extern void     taskq_init(void);
70 extern void     taskq_mp_init(void);
71
72 extern taskq_t  *taskq_create(const char *, int, pri_t, int, int, uint_t);
73 extern taskq_t  *taskq_create_instance(const char *, int, int, pri_t, int,
74     int, uint_t);
75 extern taskqid_t taskq_dispatch(taskq_t *, task_func_t, void *, uint_t);
76 extern void     nulltask(void *);
77 extern void     taskq_destroy(taskq_t *);
78 extern void     taskq_wait(taskq_t *);
79 extern void     taskq_suspend(taskq_t *);
80 extern int      taskq_suspended(taskq_t *);
81 extern void     taskq_resume(taskq_t *);
82 extern int      taskq_member(taskq_t *, kthread_t *);
83
84 #endif  /* _KERNEL */
85
86 #ifdef  __cplusplus
87 }
88 #endif
89
90 #endif  /* _SYS_TASKQ_H */