xref: /titanic_44/usr/src/lib/libc/port/tpool/thread_pool_impl.h (revision 7257d1b4d25bfac0c802847390e98a464fd787ac)
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 /*
23  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef _THREAD_POOL_IMPL_H
28 #define	_THREAD_POOL_IMPL_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #include <thread_pool.h>
33 
34 #ifdef	__cplusplus
35 extern "C" {
36 #endif
37 
38 /*
39  * Thread pool implementation definitions.
40  * See <thread_pool.h> for interface declarations.
41  */
42 
43 /*
44  * FIFO queued job
45  */
46 typedef struct tpool_job tpool_job_t;
47 struct tpool_job {
48 	tpool_job_t	*tpj_next;		/* list of jobs */
49 	void		(*tpj_func)(void *);	/* function to call */
50 	void		*tpj_arg;		/* its argument */
51 };
52 
53 /*
54  * List of active threads, linked through their stacks.
55  */
56 typedef struct tpool_active tpool_active_t;
57 struct tpool_active {
58 	tpool_active_t	*tpa_next;	/* list of active threads */
59 	pthread_t	tpa_tid;	/* active thread id */
60 };
61 
62 /*
63  * The thread pool.
64  */
65 struct tpool {
66 	tpool_t		*tp_forw;	/* circular list of all thread pools */
67 	tpool_t		*tp_back;
68 	mutex_t		tp_mutex;	/* protects the pool data */
69 	cond_t		tp_busycv;	/* synchronization in tpool_dispatch */
70 	cond_t		tp_workcv;	/* synchronization with workers */
71 	cond_t		tp_waitcv;	/* synchronization in tpool_wait() */
72 	tpool_active_t	*tp_active;	/* threads performing work */
73 	tpool_job_t	*tp_head;	/* FIFO job queue */
74 	tpool_job_t	*tp_tail;
75 	pthread_attr_t	tp_attr;	/* attributes of the workers */
76 	int		tp_flags;	/* see below */
77 	uint_t		tp_linger;	/* seconds before idle workers exit */
78 	int		tp_njobs;	/* number of jobs in job queue */
79 	int		tp_minimum;	/* minimum number of worker threads */
80 	int		tp_maximum;	/* maximum number of worker threads */
81 	int		tp_current;	/* current number of worker threads */
82 	int		tp_idle;	/* number of idle workers */
83 };
84 
85 /* tp_flags */
86 #define	TP_WAIT		0x01		/* waiting in tpool_wait() */
87 #define	TP_SUSPEND	0x02		/* pool is being suspended */
88 #define	TP_DESTROY	0x04		/* pool is being destroyed */
89 #define	TP_ABANDON	0x08		/* pool is abandoned (auto-destroy) */
90 
91 extern int pthread_attr_clone(pthread_attr_t *, const pthread_attr_t *);
92 
93 extern const sigset_t maskset;		/* set of all maskable signals */
94 
95 #ifdef	__cplusplus
96 }
97 #endif
98 
99 #endif /* _THREAD_POOL_IMPL_H */
100