xref: /onnv-gate/usr/src/cmd/fm/fmd/common/fmd_timerq.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	_FMD_TIMERQ_H
28*0Sstevel@tonic-gate #define	_FMD_TIMERQ_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 <pthread.h>
33*0Sstevel@tonic-gate #include <time.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 #include <fmd_idspace.h>
40*0Sstevel@tonic-gate #include <fmd_thread.h>
41*0Sstevel@tonic-gate #include <fmd_event.h>
42*0Sstevel@tonic-gate #include <fmd_list.h>
43*0Sstevel@tonic-gate 
44*0Sstevel@tonic-gate typedef void fmd_timer_f(void *, id_t, hrtime_t);
45*0Sstevel@tonic-gate 
46*0Sstevel@tonic-gate typedef struct fmd_timer {
47*0Sstevel@tonic-gate 	fmd_list_t tmr_list;	/* expiry or free list next/prev pointers */
48*0Sstevel@tonic-gate 	hrtime_t tmr_hrt;	/* high-res time at which timer should fire */
49*0Sstevel@tonic-gate 	fmd_idspace_t *tmr_ids;	/* idspace that contains the timer id */
50*0Sstevel@tonic-gate 	id_t tmr_id;		/* client identifier for this timer */
51*0Sstevel@tonic-gate 	fmd_timer_f *tmr_func;	/* function that should be called on expiry */
52*0Sstevel@tonic-gate 	void *tmr_arg;		/* argument to pass back to tmr_func */
53*0Sstevel@tonic-gate 	pthread_cond_t tmr_cv;	/* condition variable for waiting on tmr_func */
54*0Sstevel@tonic-gate } fmd_timer_t;
55*0Sstevel@tonic-gate 
56*0Sstevel@tonic-gate typedef struct fmd_timerq {
57*0Sstevel@tonic-gate 	fmd_thread_t *tmq_thread; /* thread handling timer expiry for queue */
58*0Sstevel@tonic-gate 	uint_t tmq_abort;	/* flag indicating tmq_thread should abort */
59*0Sstevel@tonic-gate 	pthread_mutex_t tmq_lock; /* lock protecting timer queue contents */
60*0Sstevel@tonic-gate 	pthread_cond_t tmq_cv;	/* condition variable for tmq_list, abort */
61*0Sstevel@tonic-gate 	fmd_list_t tmq_list;	/* list of active timers, sorted by tmr_hrt */
62*0Sstevel@tonic-gate 	fmd_list_t tmq_free;	/* list of free timers */
63*0Sstevel@tonic-gate } fmd_timerq_t;
64*0Sstevel@tonic-gate 
65*0Sstevel@tonic-gate extern id_t fmd_timerq_install(fmd_timerq_t *,
66*0Sstevel@tonic-gate     fmd_idspace_t *, fmd_timer_f *, void *, fmd_event_t *, hrtime_t);
67*0Sstevel@tonic-gate 
68*0Sstevel@tonic-gate extern void *fmd_timerq_remove(fmd_timerq_t *, fmd_idspace_t *, id_t);
69*0Sstevel@tonic-gate extern fmd_timerq_t *fmd_timerq_create(void);
70*0Sstevel@tonic-gate extern void fmd_timerq_destroy(fmd_timerq_t *);
71*0Sstevel@tonic-gate 
72*0Sstevel@tonic-gate #ifdef	__cplusplus
73*0Sstevel@tonic-gate }
74*0Sstevel@tonic-gate #endif
75*0Sstevel@tonic-gate 
76*0Sstevel@tonic-gate #endif	/* _FMD_TIMERQ_H */
77