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 2009 Sun Microsystems, Inc. All rights reserved.
24 * Use is subject to license terms.
25 */
26 /*
27 * Copyright 2013 Nexenta Systems, Inc. All rights reserved.
28 */
29
30 /*
31 * Copyright (c) 2015, Joyent, Inc. All rights reserved.
32 */
33
34 #ifndef _SYS_TIMER_H
35 #define _SYS_TIMER_H
36
37 #include <sys/types.h>
38 #include <sys/proc.h>
39 #include <sys/thread.h>
40
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44
45 #ifdef _KERNEL
46
47 #define _TIMER_MAX 32
48 extern volatile int timer_max; /* patchable via /etc/system */
49
50 /*
51 * Bit values for the it_lock field.
52 */
53 #define ITLK_LOCKED 0x01
54 #define ITLK_WANTED 0x02
55 #define ITLK_REMOVE 0x04
56
57 /*
58 * Bit values for the it_flags field.
59 */
60 #define IT_SIGNAL 0x01
61 #define IT_PORT 0x02 /* use event port notification */
62
63 struct clock_backend;
64
65 struct itimer;
66 typedef struct itimer itimer_t;
67
68 struct itimer {
69 itimerspec_t it_itime;
70 hrtime_t it_hrtime;
71 ushort_t it_flags;
72 ushort_t it_lock;
73 void *it_arg; /* clock backend-specific data */
74 struct proc *it_proc;
75 union {
76 struct {
77 sigqueue_t *__it_sigq;
78 klwp_t *__it_lwp;
79 } __proc;
80 void *__it_frontend;
81 } __data; /* timer frontend-specific data */
82 kcondvar_t it_cv;
83 int it_blockers;
84 int it_pending;
85 int it_overrun;
86 struct clock_backend *it_backend;
87 void (*it_fire)(itimer_t *);
88 kmutex_t it_mutex;
89 void *it_portev; /* port_kevent_t pointer */
90 void *it_portsrc; /* port_source_t pointer */
91 int it_portfd; /* port file descriptor */
92 };
93
94 #define it_sigq __data.__proc.__it_sigq
95 #define it_lwp __data.__proc.__it_lwp
96 #define it_frontend __data.__it_frontend
97
98 typedef struct clock_backend {
99 struct sigevent clk_default;
100 int (*clk_clock_settime)(timespec_t *);
101 int (*clk_clock_gettime)(timespec_t *);
102 int (*clk_clock_getres)(timespec_t *);
103 int (*clk_timer_create)(itimer_t *, void (*)(itimer_t *));
104 int (*clk_timer_settime)(itimer_t *, int, const struct itimerspec *);
105 int (*clk_timer_gettime)(itimer_t *, struct itimerspec *);
106 int (*clk_timer_delete)(itimer_t *);
107 void (*clk_timer_lwpbind)(itimer_t *);
108 } clock_backend_t;
109
110 extern void clock_add_backend(clockid_t clock, clock_backend_t *backend);
111 extern clock_backend_t *clock_get_backend(clockid_t clock);
112
113 extern void timer_lwpbind();
114
115 extern void timer_func(sigqueue_t *);
116 extern void timer_exit(void);
117 extern void timer_lwpexit(void);
118 extern clock_t hzto(struct timeval *);
119 extern clock_t timespectohz(timespec_t *, timespec_t);
120 extern int64_t timespectohz64(timespec_t *);
121 extern int itimerspecfix(timespec_t *);
122 extern void timespecadd(timespec_t *, timespec_t *);
123 extern void timespecsub(timespec_t *, timespec_t *);
124 extern void timespecfix(timespec_t *);
125 extern int xgetitimer(uint_t, struct itimerval *, int);
126 extern int xsetitimer(uint_t, struct itimerval *, int);
127 extern void delete_itimer_realprof(void);
128
129 #define timerspecisset(tvp) ((tvp)->tv_sec || (tvp)->tv_nsec)
130 #define timerspeccmp(tvp, uvp) (((tvp)->tv_sec - (uvp)->tv_sec) ? \
131 ((tvp)->tv_sec - (uvp)->tv_sec):((tvp)->tv_nsec - (uvp)->tv_nsec))
132 #define timerspecclear(tvp) ((tvp)->tv_sec = (tvp)->tv_nsec = 0)
133
134 struct oldsigevent {
135 /* structure definition prior to notification attributes member */
136 int _notify;
137 union {
138 int _signo;
139 void (*_notify_function)(union sigval);
140 } _un;
141 union sigval _value;
142 };
143
144 #if defined(_SYSCALL32)
145
146 struct oldsigevent32 {
147 int32_t _notify;
148 union {
149 int32_t _signo;
150 caddr32_t _notify_function;
151 } _un;
152 union sigval32 _value;
153 };
154
155 #endif /* _SYSCALL32 */
156 #endif /* _KERNEL */
157
158 #ifdef __cplusplus
159 }
160 #endif
161
162 #endif /* _SYS_TIMER_H */