xref: /freebsd-14-stable/sys/kern/kern_time.c (revision 69366448264956c18d0b46f900593442ed8e79ba)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1982, 1986, 1989, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  *	@(#)kern_time.c	8.1 (Berkeley) 6/10/93
32  */
33 
34 #include <sys/cdefs.h>
35 #include "opt_ktrace.h"
36 
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/limits.h>
40 #include <sys/clock.h>
41 #include <sys/lock.h>
42 #include <sys/mutex.h>
43 #include <sys/sysproto.h>
44 #include <sys/resourcevar.h>
45 #include <sys/signalvar.h>
46 #include <sys/kernel.h>
47 #include <sys/sleepqueue.h>
48 #include <sys/syscallsubr.h>
49 #include <sys/sysctl.h>
50 #include <sys/priv.h>
51 #include <sys/proc.h>
52 #include <sys/posix4.h>
53 #include <sys/time.h>
54 #include <sys/timers.h>
55 #include <sys/timetc.h>
56 #include <sys/vnode.h>
57 #ifdef KTRACE
58 #include <sys/ktrace.h>
59 #endif
60 
61 #include <vm/vm.h>
62 #include <vm/vm_extern.h>
63 
64 #define MAX_CLOCKS 	(CLOCK_MONOTONIC+1)
65 #define CPUCLOCK_BIT		0x80000000
66 #define CPUCLOCK_PROCESS_BIT	0x40000000
67 #define CPUCLOCK_ID_MASK	(~(CPUCLOCK_BIT|CPUCLOCK_PROCESS_BIT))
68 #define MAKE_THREAD_CPUCLOCK(tid)	(CPUCLOCK_BIT|(tid))
69 #define MAKE_PROCESS_CPUCLOCK(pid)	\
70 	(CPUCLOCK_BIT|CPUCLOCK_PROCESS_BIT|(pid))
71 
72 #define NS_PER_SEC	1000000000
73 
74 static struct kclock	posix_clocks[MAX_CLOCKS];
75 static uma_zone_t	itimer_zone = NULL;
76 
77 /*
78  * Time of day and interval timer support.
79  *
80  * These routines provide the kernel entry points to get and set
81  * the time-of-day and per-process interval timers.  Subroutines
82  * here provide support for adding and subtracting timeval structures
83  * and decrementing interval timers, optionally reloading the interval
84  * timers when they expire.
85  */
86 
87 static int	settime(struct thread *, struct timeval *);
88 static void	timevalfix(struct timeval *);
89 static int	user_clock_nanosleep(struct thread *td, clockid_t clock_id,
90 		    int flags, const struct timespec *ua_rqtp,
91 		    struct timespec *ua_rmtp);
92 
93 static void	itimer_start(void);
94 static int	itimer_init(void *, int, int);
95 static void	itimer_fini(void *, int);
96 static void	itimer_enter(struct itimer *);
97 static void	itimer_leave(struct itimer *);
98 static struct itimer *itimer_find(struct proc *, int);
99 static void	itimers_alloc(struct proc *);
100 static int	realtimer_create(struct itimer *);
101 static int	realtimer_gettime(struct itimer *, struct itimerspec *);
102 static int	realtimer_settime(struct itimer *, int,
103 			struct itimerspec *, struct itimerspec *);
104 static int	realtimer_delete(struct itimer *);
105 static void	realtimer_clocktime(clockid_t, struct timespec *);
106 static void	realtimer_expire(void *);
107 static void	realtimer_expire_l(struct itimer *it, bool proc_locked);
108 
109 static void	realitexpire(void *arg);
110 
111 static int	register_posix_clock(int, const struct kclock *);
112 static void	itimer_fire(struct itimer *it);
113 static int	itimespecfix(struct timespec *ts);
114 
115 #define CLOCK_CALL(clock, call, arglist)		\
116 	((*posix_clocks[clock].call) arglist)
117 
118 SYSINIT(posix_timer, SI_SUB_P1003_1B, SI_ORDER_FIRST+4, itimer_start, NULL);
119 
120 static int
settime(struct thread * td,struct timeval * tv)121 settime(struct thread *td, struct timeval *tv)
122 {
123 	struct timeval delta, tv1, tv2;
124 	static struct timeval maxtime, laststep;
125 	struct timespec ts;
126 
127 	microtime(&tv1);
128 	delta = *tv;
129 	timevalsub(&delta, &tv1);
130 
131 	/*
132 	 * If the system is secure, we do not allow the time to be
133 	 * set to a value earlier than 1 second less than the highest
134 	 * time we have yet seen. The worst a miscreant can do in
135 	 * this circumstance is "freeze" time. He couldn't go
136 	 * back to the past.
137 	 *
138 	 * We similarly do not allow the clock to be stepped more
139 	 * than one second, nor more than once per second. This allows
140 	 * a miscreant to make the clock march double-time, but no worse.
141 	 */
142 	if (securelevel_gt(td->td_ucred, 1) != 0) {
143 		if (delta.tv_sec < 0 || delta.tv_usec < 0) {
144 			/*
145 			 * Update maxtime to latest time we've seen.
146 			 */
147 			if (tv1.tv_sec > maxtime.tv_sec)
148 				maxtime = tv1;
149 			tv2 = *tv;
150 			timevalsub(&tv2, &maxtime);
151 			if (tv2.tv_sec < -1) {
152 				tv->tv_sec = maxtime.tv_sec - 1;
153 				printf("Time adjustment clamped to -1 second\n");
154 			}
155 		} else {
156 			if (tv1.tv_sec == laststep.tv_sec)
157 				return (EPERM);
158 			if (delta.tv_sec > 1) {
159 				tv->tv_sec = tv1.tv_sec + 1;
160 				printf("Time adjustment clamped to +1 second\n");
161 			}
162 			laststep = *tv;
163 		}
164 	}
165 
166 	ts.tv_sec = tv->tv_sec;
167 	ts.tv_nsec = tv->tv_usec * 1000;
168 	tc_setclock(&ts);
169 	resettodr();
170 	return (0);
171 }
172 
173 #ifndef _SYS_SYSPROTO_H_
174 struct clock_getcpuclockid2_args {
175 	id_t id;
176 	int which,
177 	clockid_t *clock_id;
178 };
179 #endif
180 /* ARGSUSED */
181 int
sys_clock_getcpuclockid2(struct thread * td,struct clock_getcpuclockid2_args * uap)182 sys_clock_getcpuclockid2(struct thread *td, struct clock_getcpuclockid2_args *uap)
183 {
184 	clockid_t clk_id;
185 	int error;
186 
187 	error = kern_clock_getcpuclockid2(td, uap->id, uap->which, &clk_id);
188 	if (error == 0)
189 		error = copyout(&clk_id, uap->clock_id, sizeof(clockid_t));
190 	return (error);
191 }
192 
193 int
kern_clock_getcpuclockid2(struct thread * td,id_t id,int which,clockid_t * clk_id)194 kern_clock_getcpuclockid2(struct thread *td, id_t id, int which,
195     clockid_t *clk_id)
196 {
197 	struct proc *p;
198 	pid_t pid;
199 	lwpid_t tid;
200 	int error;
201 
202 	switch (which) {
203 	case CPUCLOCK_WHICH_PID:
204 		if (id != 0) {
205 			error = pget(id, PGET_CANSEE | PGET_NOTID, &p);
206 			if (error != 0)
207 				return (error);
208 			PROC_UNLOCK(p);
209 			pid = id;
210 		} else {
211 			pid = td->td_proc->p_pid;
212 		}
213 		*clk_id = MAKE_PROCESS_CPUCLOCK(pid);
214 		return (0);
215 	case CPUCLOCK_WHICH_TID:
216 		tid = id == 0 ? td->td_tid : id;
217 		*clk_id = MAKE_THREAD_CPUCLOCK(tid);
218 		return (0);
219 	default:
220 		return (EINVAL);
221 	}
222 }
223 
224 #ifndef _SYS_SYSPROTO_H_
225 struct clock_gettime_args {
226 	clockid_t clock_id;
227 	struct	timespec *tp;
228 };
229 #endif
230 /* ARGSUSED */
231 int
sys_clock_gettime(struct thread * td,struct clock_gettime_args * uap)232 sys_clock_gettime(struct thread *td, struct clock_gettime_args *uap)
233 {
234 	struct timespec ats;
235 	int error;
236 
237 	error = kern_clock_gettime(td, uap->clock_id, &ats);
238 	if (error == 0)
239 		error = copyout(&ats, uap->tp, sizeof(ats));
240 
241 	return (error);
242 }
243 
244 static inline void
cputick2timespec(uint64_t runtime,struct timespec * ats)245 cputick2timespec(uint64_t runtime, struct timespec *ats)
246 {
247 	uint64_t tr;
248 	tr = cpu_tickrate();
249 	ats->tv_sec = runtime / tr;
250 	ats->tv_nsec = ((runtime % tr) * 1000000000ULL) / tr;
251 }
252 
253 void
kern_thread_cputime(struct thread * targettd,struct timespec * ats)254 kern_thread_cputime(struct thread *targettd, struct timespec *ats)
255 {
256 	uint64_t runtime, curtime, switchtime;
257 
258 	if (targettd == NULL) { /* current thread */
259 		spinlock_enter();
260 		switchtime = PCPU_GET(switchtime);
261 		curtime = cpu_ticks();
262 		runtime = curthread->td_runtime;
263 		spinlock_exit();
264 		runtime += curtime - switchtime;
265 	} else {
266 		PROC_LOCK_ASSERT(targettd->td_proc, MA_OWNED);
267 		thread_lock(targettd);
268 		runtime = targettd->td_runtime;
269 		thread_unlock(targettd);
270 	}
271 	cputick2timespec(runtime, ats);
272 }
273 
274 void
kern_process_cputime(struct proc * targetp,struct timespec * ats)275 kern_process_cputime(struct proc *targetp, struct timespec *ats)
276 {
277 	uint64_t runtime;
278 	struct rusage ru;
279 
280 	PROC_LOCK_ASSERT(targetp, MA_OWNED);
281 	PROC_STATLOCK(targetp);
282 	rufetch(targetp, &ru);
283 	runtime = targetp->p_rux.rux_runtime;
284 	if (curthread->td_proc == targetp)
285 		runtime += cpu_ticks() - PCPU_GET(switchtime);
286 	PROC_STATUNLOCK(targetp);
287 	cputick2timespec(runtime, ats);
288 }
289 
290 static int
get_cputime(struct thread * td,clockid_t clock_id,struct timespec * ats)291 get_cputime(struct thread *td, clockid_t clock_id, struct timespec *ats)
292 {
293 	struct proc *p, *p2;
294 	struct thread *td2;
295 	lwpid_t tid;
296 	pid_t pid;
297 	int error;
298 
299 	p = td->td_proc;
300 	if ((clock_id & CPUCLOCK_PROCESS_BIT) == 0) {
301 		tid = clock_id & CPUCLOCK_ID_MASK;
302 		td2 = tdfind(tid, p->p_pid);
303 		if (td2 == NULL)
304 			return (EINVAL);
305 		kern_thread_cputime(td2, ats);
306 		PROC_UNLOCK(td2->td_proc);
307 	} else {
308 		pid = clock_id & CPUCLOCK_ID_MASK;
309 		error = pget(pid, PGET_CANSEE, &p2);
310 		if (error != 0)
311 			return (EINVAL);
312 		kern_process_cputime(p2, ats);
313 		PROC_UNLOCK(p2);
314 	}
315 	return (0);
316 }
317 
318 int
kern_clock_gettime(struct thread * td,clockid_t clock_id,struct timespec * ats)319 kern_clock_gettime(struct thread *td, clockid_t clock_id, struct timespec *ats)
320 {
321 	struct timeval sys, user;
322 	struct proc *p;
323 
324 	p = td->td_proc;
325 	switch (clock_id) {
326 	case CLOCK_REALTIME:		/* Default to precise. */
327 	case CLOCK_REALTIME_PRECISE:
328 		nanotime(ats);
329 		break;
330 	case CLOCK_REALTIME_FAST:
331 		getnanotime(ats);
332 		break;
333 	case CLOCK_VIRTUAL:
334 		PROC_LOCK(p);
335 		PROC_STATLOCK(p);
336 		calcru(p, &user, &sys);
337 		PROC_STATUNLOCK(p);
338 		PROC_UNLOCK(p);
339 		TIMEVAL_TO_TIMESPEC(&user, ats);
340 		break;
341 	case CLOCK_PROF:
342 		PROC_LOCK(p);
343 		PROC_STATLOCK(p);
344 		calcru(p, &user, &sys);
345 		PROC_STATUNLOCK(p);
346 		PROC_UNLOCK(p);
347 		timevaladd(&user, &sys);
348 		TIMEVAL_TO_TIMESPEC(&user, ats);
349 		break;
350 	case CLOCK_MONOTONIC:		/* Default to precise. */
351 	case CLOCK_MONOTONIC_PRECISE:
352 	case CLOCK_UPTIME:
353 	case CLOCK_UPTIME_PRECISE:
354 		nanouptime(ats);
355 		break;
356 	case CLOCK_UPTIME_FAST:
357 	case CLOCK_MONOTONIC_FAST:
358 		getnanouptime(ats);
359 		break;
360 	case CLOCK_SECOND:
361 		ats->tv_sec = time_second;
362 		ats->tv_nsec = 0;
363 		break;
364 	case CLOCK_THREAD_CPUTIME_ID:
365 		kern_thread_cputime(NULL, ats);
366 		break;
367 	case CLOCK_PROCESS_CPUTIME_ID:
368 		PROC_LOCK(p);
369 		kern_process_cputime(p, ats);
370 		PROC_UNLOCK(p);
371 		break;
372 	default:
373 		if ((int)clock_id >= 0)
374 			return (EINVAL);
375 		return (get_cputime(td, clock_id, ats));
376 	}
377 	return (0);
378 }
379 
380 #ifndef _SYS_SYSPROTO_H_
381 struct clock_settime_args {
382 	clockid_t clock_id;
383 	const struct	timespec *tp;
384 };
385 #endif
386 /* ARGSUSED */
387 int
sys_clock_settime(struct thread * td,struct clock_settime_args * uap)388 sys_clock_settime(struct thread *td, struct clock_settime_args *uap)
389 {
390 	struct timespec ats;
391 	int error;
392 
393 	if ((error = copyin(uap->tp, &ats, sizeof(ats))) != 0)
394 		return (error);
395 	return (kern_clock_settime(td, uap->clock_id, &ats));
396 }
397 
398 static int allow_insane_settime = 0;
399 SYSCTL_INT(_debug, OID_AUTO, allow_insane_settime, CTLFLAG_RWTUN,
400     &allow_insane_settime, 0,
401     "do not perform possibly restrictive checks on settime(2) args");
402 
403 int
kern_clock_settime(struct thread * td,clockid_t clock_id,struct timespec * ats)404 kern_clock_settime(struct thread *td, clockid_t clock_id, struct timespec *ats)
405 {
406 	struct timeval atv;
407 	int error;
408 
409 	if ((error = priv_check(td, PRIV_CLOCK_SETTIME)) != 0)
410 		return (error);
411 	if (clock_id != CLOCK_REALTIME)
412 		return (EINVAL);
413 	if (!timespecvalid_interval(ats))
414 		return (EINVAL);
415 	if (!allow_insane_settime &&
416 	    (ats->tv_sec > 8000ULL * 365 * 24 * 60 * 60 ||
417 	    ats->tv_sec < utc_offset()))
418 		return (EINVAL);
419 	/* XXX Don't convert nsec->usec and back */
420 	TIMESPEC_TO_TIMEVAL(&atv, ats);
421 	error = settime(td, &atv);
422 	return (error);
423 }
424 
425 #ifndef _SYS_SYSPROTO_H_
426 struct clock_getres_args {
427 	clockid_t clock_id;
428 	struct	timespec *tp;
429 };
430 #endif
431 int
sys_clock_getres(struct thread * td,struct clock_getres_args * uap)432 sys_clock_getres(struct thread *td, struct clock_getres_args *uap)
433 {
434 	struct timespec ts;
435 	int error;
436 
437 	if (uap->tp == NULL)
438 		return (0);
439 
440 	error = kern_clock_getres(td, uap->clock_id, &ts);
441 	if (error == 0)
442 		error = copyout(&ts, uap->tp, sizeof(ts));
443 	return (error);
444 }
445 
446 int
kern_clock_getres(struct thread * td,clockid_t clock_id,struct timespec * ts)447 kern_clock_getres(struct thread *td, clockid_t clock_id, struct timespec *ts)
448 {
449 
450 	ts->tv_sec = 0;
451 	switch (clock_id) {
452 	case CLOCK_REALTIME:
453 	case CLOCK_REALTIME_FAST:
454 	case CLOCK_REALTIME_PRECISE:
455 	case CLOCK_MONOTONIC:
456 	case CLOCK_MONOTONIC_FAST:
457 	case CLOCK_MONOTONIC_PRECISE:
458 	case CLOCK_UPTIME:
459 	case CLOCK_UPTIME_FAST:
460 	case CLOCK_UPTIME_PRECISE:
461 		/*
462 		 * Round up the result of the division cheaply by adding 1.
463 		 * Rounding up is especially important if rounding down
464 		 * would give 0.  Perfect rounding is unimportant.
465 		 */
466 		ts->tv_nsec = NS_PER_SEC / tc_getfrequency() + 1;
467 		break;
468 	case CLOCK_VIRTUAL:
469 	case CLOCK_PROF:
470 		/* Accurately round up here because we can do so cheaply. */
471 		ts->tv_nsec = howmany(NS_PER_SEC, hz);
472 		break;
473 	case CLOCK_SECOND:
474 		ts->tv_sec = 1;
475 		ts->tv_nsec = 0;
476 		break;
477 	case CLOCK_THREAD_CPUTIME_ID:
478 	case CLOCK_PROCESS_CPUTIME_ID:
479 	cputime:
480 		ts->tv_nsec = 1000000000 / cpu_tickrate() + 1;
481 		break;
482 	default:
483 		if ((int)clock_id < 0)
484 			goto cputime;
485 		return (EINVAL);
486 	}
487 	return (0);
488 }
489 
490 int
kern_nanosleep(struct thread * td,struct timespec * rqt,struct timespec * rmt)491 kern_nanosleep(struct thread *td, struct timespec *rqt, struct timespec *rmt)
492 {
493 
494 	return (kern_clock_nanosleep(td, CLOCK_REALTIME, TIMER_RELTIME, rqt,
495 	    rmt));
496 }
497 
498 static uint8_t nanowait[MAXCPU];
499 
500 int
kern_clock_nanosleep(struct thread * td,clockid_t clock_id,int flags,const struct timespec * rqt,struct timespec * rmt)501 kern_clock_nanosleep(struct thread *td, clockid_t clock_id, int flags,
502     const struct timespec *rqt, struct timespec *rmt)
503 {
504 	struct timespec ts, now;
505 	sbintime_t sbt, sbtt, prec, tmp;
506 	time_t over;
507 	int error;
508 	bool is_abs_real;
509 
510 	if (rqt->tv_nsec < 0 || rqt->tv_nsec >= NS_PER_SEC)
511 		return (EINVAL);
512 	if ((flags & ~TIMER_ABSTIME) != 0)
513 		return (EINVAL);
514 	switch (clock_id) {
515 	case CLOCK_REALTIME:
516 	case CLOCK_REALTIME_PRECISE:
517 	case CLOCK_REALTIME_FAST:
518 	case CLOCK_SECOND:
519 		is_abs_real = (flags & TIMER_ABSTIME) != 0;
520 		break;
521 	case CLOCK_MONOTONIC:
522 	case CLOCK_MONOTONIC_PRECISE:
523 	case CLOCK_MONOTONIC_FAST:
524 	case CLOCK_UPTIME:
525 	case CLOCK_UPTIME_PRECISE:
526 	case CLOCK_UPTIME_FAST:
527 		is_abs_real = false;
528 		break;
529 	case CLOCK_VIRTUAL:
530 	case CLOCK_PROF:
531 	case CLOCK_PROCESS_CPUTIME_ID:
532 		return (ENOTSUP);
533 	case CLOCK_THREAD_CPUTIME_ID:
534 	default:
535 		return (EINVAL);
536 	}
537 	do {
538 		ts = *rqt;
539 		if ((flags & TIMER_ABSTIME) != 0) {
540 			if (is_abs_real)
541 				td->td_rtcgen =
542 				    atomic_load_acq_int(&rtc_generation);
543 			error = kern_clock_gettime(td, clock_id, &now);
544 			KASSERT(error == 0, ("kern_clock_gettime: %d", error));
545 			timespecsub(&ts, &now, &ts);
546 		}
547 		if (ts.tv_sec < 0 || (ts.tv_sec == 0 && ts.tv_nsec == 0)) {
548 			error = EWOULDBLOCK;
549 			break;
550 		}
551 		if (ts.tv_sec > INT32_MAX / 2) {
552 			over = ts.tv_sec - INT32_MAX / 2;
553 			ts.tv_sec -= over;
554 		} else
555 			over = 0;
556 		tmp = tstosbt(ts);
557 		prec = tmp;
558 		prec >>= tc_precexp;
559 		if (TIMESEL(&sbt, tmp))
560 			sbt += tc_tick_sbt;
561 		sbt += tmp;
562 		error = tsleep_sbt(&nanowait[curcpu], PWAIT | PCATCH, "nanslp",
563 		    sbt, prec, C_ABSOLUTE);
564 	} while (error == 0 && is_abs_real && td->td_rtcgen == 0);
565 	td->td_rtcgen = 0;
566 	if (error != EWOULDBLOCK) {
567 		if (TIMESEL(&sbtt, tmp))
568 			sbtt += tc_tick_sbt;
569 		if (sbtt >= sbt)
570 			return (0);
571 		if (error == ERESTART)
572 			error = EINTR;
573 		if ((flags & TIMER_ABSTIME) == 0 && rmt != NULL) {
574 			ts = sbttots(sbt - sbtt);
575 			ts.tv_sec += over;
576 			if (ts.tv_sec < 0)
577 				timespecclear(&ts);
578 			*rmt = ts;
579 		}
580 		return (error);
581 	}
582 	return (0);
583 }
584 
585 #ifndef _SYS_SYSPROTO_H_
586 struct nanosleep_args {
587 	struct	timespec *rqtp;
588 	struct	timespec *rmtp;
589 };
590 #endif
591 /* ARGSUSED */
592 int
sys_nanosleep(struct thread * td,struct nanosleep_args * uap)593 sys_nanosleep(struct thread *td, struct nanosleep_args *uap)
594 {
595 
596 	return (user_clock_nanosleep(td, CLOCK_REALTIME, TIMER_RELTIME,
597 	    uap->rqtp, uap->rmtp));
598 }
599 
600 #ifndef _SYS_SYSPROTO_H_
601 struct clock_nanosleep_args {
602 	clockid_t clock_id;
603 	int 	  flags;
604 	struct	timespec *rqtp;
605 	struct	timespec *rmtp;
606 };
607 #endif
608 /* ARGSUSED */
609 int
sys_clock_nanosleep(struct thread * td,struct clock_nanosleep_args * uap)610 sys_clock_nanosleep(struct thread *td, struct clock_nanosleep_args *uap)
611 {
612 	int error;
613 
614 	error = user_clock_nanosleep(td, uap->clock_id, uap->flags, uap->rqtp,
615 	    uap->rmtp);
616 	return (kern_posix_error(td, error));
617 }
618 
619 static int
user_clock_nanosleep(struct thread * td,clockid_t clock_id,int flags,const struct timespec * ua_rqtp,struct timespec * ua_rmtp)620 user_clock_nanosleep(struct thread *td, clockid_t clock_id, int flags,
621     const struct timespec *ua_rqtp, struct timespec *ua_rmtp)
622 {
623 	struct timespec rmt, rqt;
624 	int error, error2;
625 
626 	error = copyin(ua_rqtp, &rqt, sizeof(rqt));
627 	if (error)
628 		return (error);
629 	error = kern_clock_nanosleep(td, clock_id, flags, &rqt, &rmt);
630 	if (error == EINTR && ua_rmtp != NULL && (flags & TIMER_ABSTIME) == 0) {
631 		error2 = copyout(&rmt, ua_rmtp, sizeof(rmt));
632 		if (error2 != 0)
633 			error = error2;
634 	}
635 	return (error);
636 }
637 
638 #ifndef _SYS_SYSPROTO_H_
639 struct gettimeofday_args {
640 	struct	timeval *tp;
641 	struct	timezone *tzp;
642 };
643 #endif
644 /* ARGSUSED */
645 int
sys_gettimeofday(struct thread * td,struct gettimeofday_args * uap)646 sys_gettimeofday(struct thread *td, struct gettimeofday_args *uap)
647 {
648 	struct timeval atv;
649 	struct timezone rtz;
650 	int error = 0;
651 
652 	if (uap->tp) {
653 		microtime(&atv);
654 		error = copyout(&atv, uap->tp, sizeof (atv));
655 	}
656 	if (error == 0 && uap->tzp != NULL) {
657 		rtz.tz_minuteswest = 0;
658 		rtz.tz_dsttime = 0;
659 		error = copyout(&rtz, uap->tzp, sizeof (rtz));
660 	}
661 	return (error);
662 }
663 
664 #ifndef _SYS_SYSPROTO_H_
665 struct settimeofday_args {
666 	struct	timeval *tv;
667 	struct	timezone *tzp;
668 };
669 #endif
670 /* ARGSUSED */
671 int
sys_settimeofday(struct thread * td,struct settimeofday_args * uap)672 sys_settimeofday(struct thread *td, struct settimeofday_args *uap)
673 {
674 	struct timeval atv, *tvp;
675 	struct timezone atz, *tzp;
676 	int error;
677 
678 	if (uap->tv) {
679 		error = copyin(uap->tv, &atv, sizeof(atv));
680 		if (error)
681 			return (error);
682 		tvp = &atv;
683 	} else
684 		tvp = NULL;
685 	if (uap->tzp) {
686 		error = copyin(uap->tzp, &atz, sizeof(atz));
687 		if (error)
688 			return (error);
689 		tzp = &atz;
690 	} else
691 		tzp = NULL;
692 	return (kern_settimeofday(td, tvp, tzp));
693 }
694 
695 int
kern_settimeofday(struct thread * td,struct timeval * tv,struct timezone * tzp)696 kern_settimeofday(struct thread *td, struct timeval *tv, struct timezone *tzp)
697 {
698 	int error;
699 
700 	error = priv_check(td, PRIV_SETTIMEOFDAY);
701 	if (error)
702 		return (error);
703 	/* Verify all parameters before changing time. */
704 	if (tv) {
705 		if (tv->tv_usec < 0 || tv->tv_usec >= 1000000 ||
706 		    tv->tv_sec < 0)
707 			return (EINVAL);
708 		error = settime(td, tv);
709 	}
710 	return (error);
711 }
712 
713 /*
714  * Get value of an interval timer.  The process virtual and profiling virtual
715  * time timers are kept in the p_stats area, since they can be swapped out.
716  * These are kept internally in the way they are specified externally: in
717  * time until they expire.
718  *
719  * The real time interval timer is kept in the process table slot for the
720  * process, and its value (it_value) is kept as an absolute time rather than
721  * as a delta, so that it is easy to keep periodic real-time signals from
722  * drifting.
723  *
724  * Virtual time timers are processed in the hardclock() routine of
725  * kern_clock.c.  The real time timer is processed by a timeout routine,
726  * called from the softclock() routine.  Since a callout may be delayed in
727  * real time due to interrupt processing in the system, it is possible for
728  * the real time timeout routine (realitexpire, given below), to be delayed
729  * in real time past when it is supposed to occur.  It does not suffice,
730  * therefore, to reload the real timer .it_value from the real time timers
731  * .it_interval.  Rather, we compute the next time in absolute time the timer
732  * should go off.
733  */
734 #ifndef _SYS_SYSPROTO_H_
735 struct getitimer_args {
736 	u_int	which;
737 	struct	itimerval *itv;
738 };
739 #endif
740 int
sys_getitimer(struct thread * td,struct getitimer_args * uap)741 sys_getitimer(struct thread *td, struct getitimer_args *uap)
742 {
743 	struct itimerval aitv;
744 	int error;
745 
746 	error = kern_getitimer(td, uap->which, &aitv);
747 	if (error != 0)
748 		return (error);
749 	return (copyout(&aitv, uap->itv, sizeof (struct itimerval)));
750 }
751 
752 int
kern_getitimer(struct thread * td,u_int which,struct itimerval * aitv)753 kern_getitimer(struct thread *td, u_int which, struct itimerval *aitv)
754 {
755 	struct proc *p = td->td_proc;
756 	struct timeval ctv;
757 
758 	if (which > ITIMER_PROF)
759 		return (EINVAL);
760 
761 	if (which == ITIMER_REAL) {
762 		/*
763 		 * Convert from absolute to relative time in .it_value
764 		 * part of real time timer.  If time for real time timer
765 		 * has passed return 0, else return difference between
766 		 * current time and time for the timer to go off.
767 		 */
768 		PROC_LOCK(p);
769 		*aitv = p->p_realtimer;
770 		PROC_UNLOCK(p);
771 		if (timevalisset(&aitv->it_value)) {
772 			microuptime(&ctv);
773 			if (timevalcmp(&aitv->it_value, &ctv, <))
774 				timevalclear(&aitv->it_value);
775 			else
776 				timevalsub(&aitv->it_value, &ctv);
777 		}
778 	} else {
779 		PROC_ITIMLOCK(p);
780 		*aitv = p->p_stats->p_timer[which];
781 		PROC_ITIMUNLOCK(p);
782 	}
783 #ifdef KTRACE
784 	if (KTRPOINT(td, KTR_STRUCT))
785 		ktritimerval(aitv);
786 #endif
787 	return (0);
788 }
789 
790 #ifndef _SYS_SYSPROTO_H_
791 struct setitimer_args {
792 	u_int	which;
793 	struct	itimerval *itv, *oitv;
794 };
795 #endif
796 int
sys_setitimer(struct thread * td,struct setitimer_args * uap)797 sys_setitimer(struct thread *td, struct setitimer_args *uap)
798 {
799 	struct itimerval aitv, oitv;
800 	int error;
801 
802 	if (uap->itv == NULL) {
803 		uap->itv = uap->oitv;
804 		return (sys_getitimer(td, (struct getitimer_args *)uap));
805 	}
806 
807 	if ((error = copyin(uap->itv, &aitv, sizeof(struct itimerval))))
808 		return (error);
809 	error = kern_setitimer(td, uap->which, &aitv, &oitv);
810 	if (error != 0 || uap->oitv == NULL)
811 		return (error);
812 	return (copyout(&oitv, uap->oitv, sizeof(struct itimerval)));
813 }
814 
815 int
kern_setitimer(struct thread * td,u_int which,struct itimerval * aitv,struct itimerval * oitv)816 kern_setitimer(struct thread *td, u_int which, struct itimerval *aitv,
817     struct itimerval *oitv)
818 {
819 	struct proc *p = td->td_proc;
820 	struct timeval ctv;
821 	sbintime_t sbt, pr;
822 
823 	if (aitv == NULL)
824 		return (kern_getitimer(td, which, oitv));
825 
826 	if (which > ITIMER_PROF)
827 		return (EINVAL);
828 #ifdef KTRACE
829 	if (KTRPOINT(td, KTR_STRUCT))
830 		ktritimerval(aitv);
831 #endif
832 	if (itimerfix(&aitv->it_value) ||
833 	    aitv->it_value.tv_sec > INT32_MAX / 2)
834 		return (EINVAL);
835 	if (!timevalisset(&aitv->it_value))
836 		timevalclear(&aitv->it_interval);
837 	else if (itimerfix(&aitv->it_interval) ||
838 	    aitv->it_interval.tv_sec > INT32_MAX / 2)
839 		return (EINVAL);
840 
841 	if (which == ITIMER_REAL) {
842 		PROC_LOCK(p);
843 		if (timevalisset(&p->p_realtimer.it_value))
844 			callout_stop(&p->p_itcallout);
845 		microuptime(&ctv);
846 		if (timevalisset(&aitv->it_value)) {
847 			pr = tvtosbt(aitv->it_value) >> tc_precexp;
848 			timevaladd(&aitv->it_value, &ctv);
849 			sbt = tvtosbt(aitv->it_value);
850 			callout_reset_sbt(&p->p_itcallout, sbt, pr,
851 			    realitexpire, p, C_ABSOLUTE);
852 		}
853 		*oitv = p->p_realtimer;
854 		p->p_realtimer = *aitv;
855 		PROC_UNLOCK(p);
856 		if (timevalisset(&oitv->it_value)) {
857 			if (timevalcmp(&oitv->it_value, &ctv, <))
858 				timevalclear(&oitv->it_value);
859 			else
860 				timevalsub(&oitv->it_value, &ctv);
861 		}
862 	} else {
863 		if (aitv->it_interval.tv_sec == 0 &&
864 		    aitv->it_interval.tv_usec != 0 &&
865 		    aitv->it_interval.tv_usec < tick)
866 			aitv->it_interval.tv_usec = tick;
867 		if (aitv->it_value.tv_sec == 0 &&
868 		    aitv->it_value.tv_usec != 0 &&
869 		    aitv->it_value.tv_usec < tick)
870 			aitv->it_value.tv_usec = tick;
871 		PROC_ITIMLOCK(p);
872 		*oitv = p->p_stats->p_timer[which];
873 		p->p_stats->p_timer[which] = *aitv;
874 		PROC_ITIMUNLOCK(p);
875 	}
876 #ifdef KTRACE
877 	if (KTRPOINT(td, KTR_STRUCT))
878 		ktritimerval(oitv);
879 #endif
880 	return (0);
881 }
882 
883 static void
realitexpire_reset_callout(struct proc * p,sbintime_t * isbtp)884 realitexpire_reset_callout(struct proc *p, sbintime_t *isbtp)
885 {
886 	sbintime_t prec;
887 
888 	if ((p->p_flag & P_WEXIT) != 0)
889 		return;
890 	prec = isbtp == NULL ? tvtosbt(p->p_realtimer.it_interval) : *isbtp;
891 	callout_reset_sbt(&p->p_itcallout, tvtosbt(p->p_realtimer.it_value),
892 	    prec >> tc_precexp, realitexpire, p, C_ABSOLUTE);
893 }
894 
895 void
itimer_proc_continue(struct proc * p)896 itimer_proc_continue(struct proc *p)
897 {
898 	struct timeval ctv;
899 	struct itimer *it;
900 	int id;
901 
902 	PROC_LOCK_ASSERT(p, MA_OWNED);
903 
904 	if ((p->p_flag2 & P2_ITSTOPPED) != 0) {
905 		p->p_flag2 &= ~P2_ITSTOPPED;
906 		microuptime(&ctv);
907 		if (timevalcmp(&p->p_realtimer.it_value, &ctv, >=))
908 			realitexpire(p);
909 		else
910 			realitexpire_reset_callout(p, NULL);
911 	}
912 
913 	if (p->p_itimers != NULL) {
914 		for (id = 3; id < TIMER_MAX; id++) {
915 			it = p->p_itimers->its_timers[id];
916 			if (it == NULL)
917 				continue;
918 			if ((it->it_flags & ITF_PSTOPPED) != 0) {
919 				ITIMER_LOCK(it);
920 				if ((it->it_flags & ITF_PSTOPPED) != 0) {
921 					it->it_flags &= ~ITF_PSTOPPED;
922 					if ((it->it_flags & ITF_DELETING) == 0)
923 						realtimer_expire_l(it, true);
924 				}
925 				ITIMER_UNLOCK(it);
926 			}
927 		}
928 	}
929 }
930 
931 /*
932  * Real interval timer expired:
933  * send process whose timer expired an alarm signal.
934  * If time is not set up to reload, then just return.
935  * Else compute next time timer should go off which is > current time.
936  * This is where delay in processing this timeout causes multiple
937  * SIGALRM calls to be compressed into one.
938  * tvtohz() always adds 1 to allow for the time until the next clock
939  * interrupt being strictly less than 1 clock tick, but we don't want
940  * that here since we want to appear to be in sync with the clock
941  * interrupt even when we're delayed.
942  */
943 static void
realitexpire(void * arg)944 realitexpire(void *arg)
945 {
946 	struct proc *p;
947 	struct timeval ctv;
948 	sbintime_t isbt;
949 
950 	p = (struct proc *)arg;
951 	kern_psignal(p, SIGALRM);
952 	if (!timevalisset(&p->p_realtimer.it_interval)) {
953 		timevalclear(&p->p_realtimer.it_value);
954 		return;
955 	}
956 
957 	isbt = tvtosbt(p->p_realtimer.it_interval);
958 	if (isbt >= sbt_timethreshold)
959 		getmicrouptime(&ctv);
960 	else
961 		microuptime(&ctv);
962 	do {
963 		timevaladd(&p->p_realtimer.it_value,
964 		    &p->p_realtimer.it_interval);
965 	} while (timevalcmp(&p->p_realtimer.it_value, &ctv, <=));
966 
967 	if (P_SHOULDSTOP(p) || P_KILLED(p)) {
968 		p->p_flag2 |= P2_ITSTOPPED;
969 		return;
970 	}
971 
972 	p->p_flag2 &= ~P2_ITSTOPPED;
973 	realitexpire_reset_callout(p, &isbt);
974 }
975 
976 /*
977  * Check that a proposed value to load into the .it_value or
978  * .it_interval part of an interval timer is acceptable, and
979  * fix it to have at least minimal value (i.e. if it is less
980  * than the resolution of the clock, round it up.)
981  */
982 int
itimerfix(struct timeval * tv)983 itimerfix(struct timeval *tv)
984 {
985 
986 	if (tv->tv_sec < 0 || tv->tv_usec < 0 || tv->tv_usec >= 1000000)
987 		return (EINVAL);
988 	if (tv->tv_sec == 0 && tv->tv_usec != 0 &&
989 	    tv->tv_usec < (u_int)tick / 16)
990 		tv->tv_usec = (u_int)tick / 16;
991 	return (0);
992 }
993 
994 /*
995  * Decrement an interval timer by a specified number
996  * of microseconds, which must be less than a second,
997  * i.e. < 1000000.  If the timer expires, then reload
998  * it.  In this case, carry over (usec - old value) to
999  * reduce the value reloaded into the timer so that
1000  * the timer does not drift.  This routine assumes
1001  * that it is called in a context where the timers
1002  * on which it is operating cannot change in value.
1003  */
1004 int
itimerdecr(struct itimerval * itp,int usec)1005 itimerdecr(struct itimerval *itp, int usec)
1006 {
1007 
1008 	if (itp->it_value.tv_usec < usec) {
1009 		if (itp->it_value.tv_sec == 0) {
1010 			/* expired, and already in next interval */
1011 			usec -= itp->it_value.tv_usec;
1012 			goto expire;
1013 		}
1014 		itp->it_value.tv_usec += 1000000;
1015 		itp->it_value.tv_sec--;
1016 	}
1017 	itp->it_value.tv_usec -= usec;
1018 	usec = 0;
1019 	if (timevalisset(&itp->it_value))
1020 		return (1);
1021 	/* expired, exactly at end of interval */
1022 expire:
1023 	if (timevalisset(&itp->it_interval)) {
1024 		itp->it_value = itp->it_interval;
1025 		itp->it_value.tv_usec -= usec;
1026 		if (itp->it_value.tv_usec < 0) {
1027 			itp->it_value.tv_usec += 1000000;
1028 			itp->it_value.tv_sec--;
1029 		}
1030 	} else
1031 		itp->it_value.tv_usec = 0;		/* sec is already 0 */
1032 	return (0);
1033 }
1034 
1035 /*
1036  * Add and subtract routines for timevals.
1037  * N.B.: subtract routine doesn't deal with
1038  * results which are before the beginning,
1039  * it just gets very confused in this case.
1040  * Caveat emptor.
1041  */
1042 void
timevaladd(struct timeval * t1,const struct timeval * t2)1043 timevaladd(struct timeval *t1, const struct timeval *t2)
1044 {
1045 
1046 	t1->tv_sec += t2->tv_sec;
1047 	t1->tv_usec += t2->tv_usec;
1048 	timevalfix(t1);
1049 }
1050 
1051 void
timevalsub(struct timeval * t1,const struct timeval * t2)1052 timevalsub(struct timeval *t1, const struct timeval *t2)
1053 {
1054 
1055 	t1->tv_sec -= t2->tv_sec;
1056 	t1->tv_usec -= t2->tv_usec;
1057 	timevalfix(t1);
1058 }
1059 
1060 static void
timevalfix(struct timeval * t1)1061 timevalfix(struct timeval *t1)
1062 {
1063 
1064 	if (t1->tv_usec < 0) {
1065 		t1->tv_sec--;
1066 		t1->tv_usec += 1000000;
1067 	}
1068 	if (t1->tv_usec >= 1000000) {
1069 		t1->tv_sec++;
1070 		t1->tv_usec -= 1000000;
1071 	}
1072 }
1073 
1074 /*
1075  * ratecheck(): simple time-based rate-limit checking.
1076  */
1077 int
ratecheck(struct timeval * lasttime,const struct timeval * mininterval)1078 ratecheck(struct timeval *lasttime, const struct timeval *mininterval)
1079 {
1080 	struct timeval tv, delta;
1081 	int rv = 0;
1082 
1083 	getmicrouptime(&tv);		/* NB: 10ms precision */
1084 	delta = tv;
1085 	timevalsub(&delta, lasttime);
1086 
1087 	/*
1088 	 * check for 0,0 is so that the message will be seen at least once,
1089 	 * even if interval is huge.
1090 	 */
1091 	if (timevalcmp(&delta, mininterval, >=) ||
1092 	    (lasttime->tv_sec == 0 && lasttime->tv_usec == 0)) {
1093 		*lasttime = tv;
1094 		rv = 1;
1095 	}
1096 
1097 	return (rv);
1098 }
1099 
1100 /*
1101  * eventratecheck(): events per second limitation.
1102  *
1103  * Return 0 if the limit is to be enforced (e.g. the caller
1104  * should ignore the event because of the rate limitation).
1105  *
1106  * maxeps of 0 always causes zero to be returned.  maxeps of -1
1107  * always causes 1 to be returned; this effectively defeats rate
1108  * limiting.
1109  *
1110  * Note that we maintain the struct timeval for compatibility
1111  * with other bsd systems.  We reuse the storage and just monitor
1112  * clock ticks for minimal overhead.
1113  */
1114 int
eventratecheck(struct timeval * lasttime,int * cureps,int maxeps)1115 eventratecheck(struct timeval *lasttime, int *cureps, int maxeps)
1116 {
1117 	int now;
1118 
1119 	/*
1120 	 * Reset the last time and counter if this is the first call
1121 	 * or more than a second has passed since the last update of
1122 	 * lasttime.
1123 	 */
1124 	now = ticks;
1125 	if (lasttime->tv_sec == 0 || (u_int)(now - lasttime->tv_sec) >= hz) {
1126 		lasttime->tv_sec = now;
1127 		*cureps = 1;
1128 		return (maxeps != 0);
1129 	} else {
1130 		(*cureps)++;		/* NB: ignore potential overflow */
1131 		return (maxeps < 0 || *cureps <= maxeps);
1132 	}
1133 }
1134 
1135 static void
itimer_start(void)1136 itimer_start(void)
1137 {
1138 	static const struct kclock rt_clock = {
1139 		.timer_create  = realtimer_create,
1140 		.timer_delete  = realtimer_delete,
1141 		.timer_settime = realtimer_settime,
1142 		.timer_gettime = realtimer_gettime,
1143 	};
1144 
1145 	itimer_zone = uma_zcreate("itimer", sizeof(struct itimer),
1146 		NULL, NULL, itimer_init, itimer_fini, UMA_ALIGN_PTR, 0);
1147 	register_posix_clock(CLOCK_REALTIME,  &rt_clock);
1148 	register_posix_clock(CLOCK_MONOTONIC, &rt_clock);
1149 	p31b_setcfg(CTL_P1003_1B_TIMERS, 200112L);
1150 	p31b_setcfg(CTL_P1003_1B_DELAYTIMER_MAX, INT_MAX);
1151 	p31b_setcfg(CTL_P1003_1B_TIMER_MAX, TIMER_MAX);
1152 }
1153 
1154 static int
register_posix_clock(int clockid,const struct kclock * clk)1155 register_posix_clock(int clockid, const struct kclock *clk)
1156 {
1157 	if ((unsigned)clockid >= MAX_CLOCKS) {
1158 		printf("%s: invalid clockid\n", __func__);
1159 		return (0);
1160 	}
1161 	posix_clocks[clockid] = *clk;
1162 	return (1);
1163 }
1164 
1165 static int
itimer_init(void * mem,int size,int flags)1166 itimer_init(void *mem, int size, int flags)
1167 {
1168 	struct itimer *it;
1169 
1170 	it = (struct itimer *)mem;
1171 	mtx_init(&it->it_mtx, "itimer lock", NULL, MTX_DEF);
1172 	return (0);
1173 }
1174 
1175 static void
itimer_fini(void * mem,int size)1176 itimer_fini(void *mem, int size)
1177 {
1178 	struct itimer *it;
1179 
1180 	it = (struct itimer *)mem;
1181 	mtx_destroy(&it->it_mtx);
1182 }
1183 
1184 static void
itimer_enter(struct itimer * it)1185 itimer_enter(struct itimer *it)
1186 {
1187 
1188 	mtx_assert(&it->it_mtx, MA_OWNED);
1189 	it->it_usecount++;
1190 }
1191 
1192 static void
itimer_leave(struct itimer * it)1193 itimer_leave(struct itimer *it)
1194 {
1195 
1196 	mtx_assert(&it->it_mtx, MA_OWNED);
1197 	KASSERT(it->it_usecount > 0, ("invalid it_usecount"));
1198 
1199 	if (--it->it_usecount == 0 && (it->it_flags & ITF_WANTED) != 0)
1200 		wakeup(it);
1201 }
1202 
1203 #ifndef _SYS_SYSPROTO_H_
1204 struct ktimer_create_args {
1205 	clockid_t clock_id;
1206 	struct sigevent * evp;
1207 	int * timerid;
1208 };
1209 #endif
1210 int
sys_ktimer_create(struct thread * td,struct ktimer_create_args * uap)1211 sys_ktimer_create(struct thread *td, struct ktimer_create_args *uap)
1212 {
1213 	struct sigevent *evp, ev;
1214 	int id;
1215 	int error;
1216 
1217 	if (uap->evp == NULL) {
1218 		evp = NULL;
1219 	} else {
1220 		error = copyin(uap->evp, &ev, sizeof(ev));
1221 		if (error != 0)
1222 			return (error);
1223 		evp = &ev;
1224 	}
1225 	error = kern_ktimer_create(td, uap->clock_id, evp, &id, -1);
1226 	if (error == 0) {
1227 		error = copyout(&id, uap->timerid, sizeof(int));
1228 		if (error != 0)
1229 			kern_ktimer_delete(td, id);
1230 	}
1231 	return (error);
1232 }
1233 
1234 int
kern_ktimer_create(struct thread * td,clockid_t clock_id,struct sigevent * evp,int * timerid,int preset_id)1235 kern_ktimer_create(struct thread *td, clockid_t clock_id, struct sigevent *evp,
1236     int *timerid, int preset_id)
1237 {
1238 	struct proc *p = td->td_proc;
1239 	struct itimer *it;
1240 	int id;
1241 	int error;
1242 
1243 	if (clock_id < 0 || clock_id >= MAX_CLOCKS)
1244 		return (EINVAL);
1245 
1246 	if (posix_clocks[clock_id].timer_create == NULL)
1247 		return (EINVAL);
1248 
1249 	if (evp != NULL) {
1250 		if (evp->sigev_notify != SIGEV_NONE &&
1251 		    evp->sigev_notify != SIGEV_SIGNAL &&
1252 		    evp->sigev_notify != SIGEV_THREAD_ID)
1253 			return (EINVAL);
1254 		if ((evp->sigev_notify == SIGEV_SIGNAL ||
1255 		     evp->sigev_notify == SIGEV_THREAD_ID) &&
1256 			!_SIG_VALID(evp->sigev_signo))
1257 			return (EINVAL);
1258 	}
1259 
1260 	if (p->p_itimers == NULL)
1261 		itimers_alloc(p);
1262 
1263 	it = uma_zalloc(itimer_zone, M_WAITOK);
1264 	it->it_flags = 0;
1265 	it->it_usecount = 0;
1266 	timespecclear(&it->it_time.it_value);
1267 	timespecclear(&it->it_time.it_interval);
1268 	it->it_overrun = 0;
1269 	it->it_overrun_last = 0;
1270 	it->it_clockid = clock_id;
1271 	it->it_proc = p;
1272 	ksiginfo_init(&it->it_ksi);
1273 	it->it_ksi.ksi_flags |= KSI_INS | KSI_EXT;
1274 	error = CLOCK_CALL(clock_id, timer_create, (it));
1275 	if (error != 0)
1276 		goto out;
1277 
1278 	PROC_LOCK(p);
1279 	if (preset_id != -1) {
1280 		KASSERT(preset_id >= 0 && preset_id < 3, ("invalid preset_id"));
1281 		id = preset_id;
1282 		if (p->p_itimers->its_timers[id] != NULL) {
1283 			PROC_UNLOCK(p);
1284 			error = 0;
1285 			goto out;
1286 		}
1287 	} else {
1288 		/*
1289 		 * Find a free timer slot, skipping those reserved
1290 		 * for setitimer().
1291 		 */
1292 		for (id = 3; id < TIMER_MAX; id++)
1293 			if (p->p_itimers->its_timers[id] == NULL)
1294 				break;
1295 		if (id == TIMER_MAX) {
1296 			PROC_UNLOCK(p);
1297 			error = EAGAIN;
1298 			goto out;
1299 		}
1300 	}
1301 	p->p_itimers->its_timers[id] = it;
1302 	if (evp != NULL)
1303 		it->it_sigev = *evp;
1304 	else {
1305 		it->it_sigev.sigev_notify = SIGEV_SIGNAL;
1306 		switch (clock_id) {
1307 		default:
1308 		case CLOCK_REALTIME:
1309 			it->it_sigev.sigev_signo = SIGALRM;
1310 			break;
1311 		case CLOCK_VIRTUAL:
1312  			it->it_sigev.sigev_signo = SIGVTALRM;
1313 			break;
1314 		case CLOCK_PROF:
1315 			it->it_sigev.sigev_signo = SIGPROF;
1316 			break;
1317 		}
1318 		it->it_sigev.sigev_value.sival_int = id;
1319 	}
1320 
1321 	if (it->it_sigev.sigev_notify == SIGEV_SIGNAL ||
1322 	    it->it_sigev.sigev_notify == SIGEV_THREAD_ID) {
1323 		it->it_ksi.ksi_signo = it->it_sigev.sigev_signo;
1324 		it->it_ksi.ksi_code = SI_TIMER;
1325 		it->it_ksi.ksi_value = it->it_sigev.sigev_value;
1326 		it->it_ksi.ksi_timerid = id;
1327 	}
1328 	PROC_UNLOCK(p);
1329 	*timerid = id;
1330 	return (0);
1331 
1332 out:
1333 	ITIMER_LOCK(it);
1334 	CLOCK_CALL(it->it_clockid, timer_delete, (it));
1335 	ITIMER_UNLOCK(it);
1336 	uma_zfree(itimer_zone, it);
1337 	return (error);
1338 }
1339 
1340 #ifndef _SYS_SYSPROTO_H_
1341 struct ktimer_delete_args {
1342 	int timerid;
1343 };
1344 #endif
1345 int
sys_ktimer_delete(struct thread * td,struct ktimer_delete_args * uap)1346 sys_ktimer_delete(struct thread *td, struct ktimer_delete_args *uap)
1347 {
1348 
1349 	return (kern_ktimer_delete(td, uap->timerid));
1350 }
1351 
1352 static struct itimer *
itimer_find(struct proc * p,int timerid)1353 itimer_find(struct proc *p, int timerid)
1354 {
1355 	struct itimer *it;
1356 
1357 	PROC_LOCK_ASSERT(p, MA_OWNED);
1358 	if ((p->p_itimers == NULL) ||
1359 	    (timerid < 0) || (timerid >= TIMER_MAX) ||
1360 	    (it = p->p_itimers->its_timers[timerid]) == NULL) {
1361 		return (NULL);
1362 	}
1363 	ITIMER_LOCK(it);
1364 	if ((it->it_flags & ITF_DELETING) != 0) {
1365 		ITIMER_UNLOCK(it);
1366 		it = NULL;
1367 	}
1368 	return (it);
1369 }
1370 
1371 int
kern_ktimer_delete(struct thread * td,int timerid)1372 kern_ktimer_delete(struct thread *td, int timerid)
1373 {
1374 	struct proc *p = td->td_proc;
1375 	struct itimer *it;
1376 
1377 	PROC_LOCK(p);
1378 	it = itimer_find(p, timerid);
1379 	if (it == NULL) {
1380 		PROC_UNLOCK(p);
1381 		return (EINVAL);
1382 	}
1383 	PROC_UNLOCK(p);
1384 
1385 	it->it_flags |= ITF_DELETING;
1386 	while (it->it_usecount > 0) {
1387 		it->it_flags |= ITF_WANTED;
1388 		msleep(it, &it->it_mtx, PPAUSE, "itimer", 0);
1389 	}
1390 	it->it_flags &= ~ITF_WANTED;
1391 	CLOCK_CALL(it->it_clockid, timer_delete, (it));
1392 	ITIMER_UNLOCK(it);
1393 
1394 	PROC_LOCK(p);
1395 	if (KSI_ONQ(&it->it_ksi))
1396 		sigqueue_take(&it->it_ksi);
1397 	p->p_itimers->its_timers[timerid] = NULL;
1398 	PROC_UNLOCK(p);
1399 	uma_zfree(itimer_zone, it);
1400 	return (0);
1401 }
1402 
1403 #ifndef _SYS_SYSPROTO_H_
1404 struct ktimer_settime_args {
1405 	int timerid;
1406 	int flags;
1407 	const struct itimerspec * value;
1408 	struct itimerspec * ovalue;
1409 };
1410 #endif
1411 int
sys_ktimer_settime(struct thread * td,struct ktimer_settime_args * uap)1412 sys_ktimer_settime(struct thread *td, struct ktimer_settime_args *uap)
1413 {
1414 	struct itimerspec val, oval, *ovalp;
1415 	int error;
1416 
1417 	error = copyin(uap->value, &val, sizeof(val));
1418 	if (error != 0)
1419 		return (error);
1420 	ovalp = uap->ovalue != NULL ? &oval : NULL;
1421 	error = kern_ktimer_settime(td, uap->timerid, uap->flags, &val, ovalp);
1422 	if (error == 0 && uap->ovalue != NULL)
1423 		error = copyout(ovalp, uap->ovalue, sizeof(*ovalp));
1424 	return (error);
1425 }
1426 
1427 int
kern_ktimer_settime(struct thread * td,int timer_id,int flags,struct itimerspec * val,struct itimerspec * oval)1428 kern_ktimer_settime(struct thread *td, int timer_id, int flags,
1429     struct itimerspec *val, struct itimerspec *oval)
1430 {
1431 	struct proc *p;
1432 	struct itimer *it;
1433 	int error;
1434 
1435 	p = td->td_proc;
1436 	PROC_LOCK(p);
1437 	if (timer_id < 3 || (it = itimer_find(p, timer_id)) == NULL) {
1438 		PROC_UNLOCK(p);
1439 		error = EINVAL;
1440 	} else {
1441 		PROC_UNLOCK(p);
1442 		itimer_enter(it);
1443 		error = CLOCK_CALL(it->it_clockid, timer_settime, (it,
1444 		    flags, val, oval));
1445 		itimer_leave(it);
1446 		ITIMER_UNLOCK(it);
1447 	}
1448 	return (error);
1449 }
1450 
1451 #ifndef _SYS_SYSPROTO_H_
1452 struct ktimer_gettime_args {
1453 	int timerid;
1454 	struct itimerspec * value;
1455 };
1456 #endif
1457 int
sys_ktimer_gettime(struct thread * td,struct ktimer_gettime_args * uap)1458 sys_ktimer_gettime(struct thread *td, struct ktimer_gettime_args *uap)
1459 {
1460 	struct itimerspec val;
1461 	int error;
1462 
1463 	error = kern_ktimer_gettime(td, uap->timerid, &val);
1464 	if (error == 0)
1465 		error = copyout(&val, uap->value, sizeof(val));
1466 	return (error);
1467 }
1468 
1469 int
kern_ktimer_gettime(struct thread * td,int timer_id,struct itimerspec * val)1470 kern_ktimer_gettime(struct thread *td, int timer_id, struct itimerspec *val)
1471 {
1472 	struct proc *p;
1473 	struct itimer *it;
1474 	int error;
1475 
1476 	p = td->td_proc;
1477 	PROC_LOCK(p);
1478 	if (timer_id < 3 || (it = itimer_find(p, timer_id)) == NULL) {
1479 		PROC_UNLOCK(p);
1480 		error = EINVAL;
1481 	} else {
1482 		PROC_UNLOCK(p);
1483 		itimer_enter(it);
1484 		error = CLOCK_CALL(it->it_clockid, timer_gettime, (it, val));
1485 		itimer_leave(it);
1486 		ITIMER_UNLOCK(it);
1487 	}
1488 	return (error);
1489 }
1490 
1491 #ifndef _SYS_SYSPROTO_H_
1492 struct timer_getoverrun_args {
1493 	int timerid;
1494 };
1495 #endif
1496 int
sys_ktimer_getoverrun(struct thread * td,struct ktimer_getoverrun_args * uap)1497 sys_ktimer_getoverrun(struct thread *td, struct ktimer_getoverrun_args *uap)
1498 {
1499 
1500 	return (kern_ktimer_getoverrun(td, uap->timerid));
1501 }
1502 
1503 int
kern_ktimer_getoverrun(struct thread * td,int timer_id)1504 kern_ktimer_getoverrun(struct thread *td, int timer_id)
1505 {
1506 	struct proc *p = td->td_proc;
1507 	struct itimer *it;
1508 	int error ;
1509 
1510 	PROC_LOCK(p);
1511 	if (timer_id < 3 ||
1512 	    (it = itimer_find(p, timer_id)) == NULL) {
1513 		PROC_UNLOCK(p);
1514 		error = EINVAL;
1515 	} else {
1516 		td->td_retval[0] = it->it_overrun_last;
1517 		ITIMER_UNLOCK(it);
1518 		PROC_UNLOCK(p);
1519 		error = 0;
1520 	}
1521 	return (error);
1522 }
1523 
1524 static int
realtimer_create(struct itimer * it)1525 realtimer_create(struct itimer *it)
1526 {
1527 	callout_init_mtx(&it->it_callout, &it->it_mtx, 0);
1528 	return (0);
1529 }
1530 
1531 static int
realtimer_delete(struct itimer * it)1532 realtimer_delete(struct itimer *it)
1533 {
1534 	mtx_assert(&it->it_mtx, MA_OWNED);
1535 
1536 	/*
1537 	 * clear timer's value and interval to tell realtimer_expire
1538 	 * to not rearm the timer.
1539 	 */
1540 	timespecclear(&it->it_time.it_value);
1541 	timespecclear(&it->it_time.it_interval);
1542 	ITIMER_UNLOCK(it);
1543 	callout_drain(&it->it_callout);
1544 	ITIMER_LOCK(it);
1545 	return (0);
1546 }
1547 
1548 static int
realtimer_gettime(struct itimer * it,struct itimerspec * ovalue)1549 realtimer_gettime(struct itimer *it, struct itimerspec *ovalue)
1550 {
1551 	struct timespec cts;
1552 
1553 	mtx_assert(&it->it_mtx, MA_OWNED);
1554 
1555 	realtimer_clocktime(it->it_clockid, &cts);
1556 	*ovalue = it->it_time;
1557 	if (ovalue->it_value.tv_sec != 0 || ovalue->it_value.tv_nsec != 0) {
1558 		timespecsub(&ovalue->it_value, &cts, &ovalue->it_value);
1559 		if (ovalue->it_value.tv_sec < 0 ||
1560 		    (ovalue->it_value.tv_sec == 0 &&
1561 		     ovalue->it_value.tv_nsec == 0)) {
1562 			ovalue->it_value.tv_sec  = 0;
1563 			ovalue->it_value.tv_nsec = 1;
1564 		}
1565 	}
1566 	return (0);
1567 }
1568 
1569 static int
realtimer_settime(struct itimer * it,int flags,struct itimerspec * value,struct itimerspec * ovalue)1570 realtimer_settime(struct itimer *it, int flags, struct itimerspec *value,
1571     struct itimerspec *ovalue)
1572 {
1573 	struct timespec cts, ts;
1574 	struct timeval tv;
1575 	struct itimerspec val;
1576 
1577 	mtx_assert(&it->it_mtx, MA_OWNED);
1578 
1579 	val = *value;
1580 	if (itimespecfix(&val.it_value))
1581 		return (EINVAL);
1582 
1583 	if (timespecisset(&val.it_value)) {
1584 		if (itimespecfix(&val.it_interval))
1585 			return (EINVAL);
1586 	} else {
1587 		timespecclear(&val.it_interval);
1588 	}
1589 
1590 	if (ovalue != NULL)
1591 		realtimer_gettime(it, ovalue);
1592 
1593 	it->it_time = val;
1594 	if (timespecisset(&val.it_value)) {
1595 		realtimer_clocktime(it->it_clockid, &cts);
1596 		ts = val.it_value;
1597 		if ((flags & TIMER_ABSTIME) == 0) {
1598 			/* Convert to absolute time. */
1599 			timespecadd(&it->it_time.it_value, &cts,
1600 			    &it->it_time.it_value);
1601 		} else {
1602 			timespecsub(&ts, &cts, &ts);
1603 			/*
1604 			 * We don't care if ts is negative, tztohz will
1605 			 * fix it.
1606 			 */
1607 		}
1608 		TIMESPEC_TO_TIMEVAL(&tv, &ts);
1609 		callout_reset(&it->it_callout, tvtohz(&tv), realtimer_expire,
1610 		    it);
1611 	} else {
1612 		callout_stop(&it->it_callout);
1613 	}
1614 
1615 	return (0);
1616 }
1617 
1618 static void
realtimer_clocktime(clockid_t id,struct timespec * ts)1619 realtimer_clocktime(clockid_t id, struct timespec *ts)
1620 {
1621 	if (id == CLOCK_REALTIME)
1622 		getnanotime(ts);
1623 	else	/* CLOCK_MONOTONIC */
1624 		getnanouptime(ts);
1625 }
1626 
1627 int
itimer_accept(struct proc * p,int timerid,ksiginfo_t * ksi)1628 itimer_accept(struct proc *p, int timerid, ksiginfo_t *ksi)
1629 {
1630 	struct itimer *it;
1631 
1632 	PROC_LOCK_ASSERT(p, MA_OWNED);
1633 	it = itimer_find(p, timerid);
1634 	if (it != NULL) {
1635 		ksi->ksi_overrun = it->it_overrun;
1636 		it->it_overrun_last = it->it_overrun;
1637 		it->it_overrun = 0;
1638 		ITIMER_UNLOCK(it);
1639 		return (0);
1640 	}
1641 	return (EINVAL);
1642 }
1643 
1644 static int
itimespecfix(struct timespec * ts)1645 itimespecfix(struct timespec *ts)
1646 {
1647 
1648 	if (!timespecvalid_interval(ts))
1649 		return (EINVAL);
1650 	if ((UINT64_MAX - ts->tv_nsec) / NS_PER_SEC < ts->tv_sec)
1651 		return (EINVAL);
1652 	if (ts->tv_sec == 0 && ts->tv_nsec != 0 && ts->tv_nsec < tick * 1000)
1653 		ts->tv_nsec = tick * 1000;
1654 	return (0);
1655 }
1656 
1657 #define	timespectons(tsp)			\
1658 	((uint64_t)(tsp)->tv_sec * NS_PER_SEC + (tsp)->tv_nsec)
1659 #define	timespecfromns(ns) (struct timespec){	\
1660 	.tv_sec = (ns) / NS_PER_SEC,		\
1661 	.tv_nsec = (ns) % NS_PER_SEC		\
1662 }
1663 
1664 static void
realtimer_expire_l(struct itimer * it,bool proc_locked)1665 realtimer_expire_l(struct itimer *it, bool proc_locked)
1666 {
1667 	struct timespec cts, ts;
1668 	struct timeval tv;
1669 	struct proc *p;
1670 	uint64_t interval, now, overruns, value;
1671 
1672 	realtimer_clocktime(it->it_clockid, &cts);
1673 	/* Only fire if time is reached. */
1674 	if (timespeccmp(&cts, &it->it_time.it_value, >=)) {
1675 		if (timespecisset(&it->it_time.it_interval)) {
1676 			timespecadd(&it->it_time.it_value,
1677 			    &it->it_time.it_interval,
1678 			    &it->it_time.it_value);
1679 
1680 			interval = timespectons(&it->it_time.it_interval);
1681 			value = timespectons(&it->it_time.it_value);
1682 			now = timespectons(&cts);
1683 
1684 			if (now >= value) {
1685 				/*
1686 				 * We missed at least one period.
1687 				 */
1688 				overruns = howmany(now - value + 1, interval);
1689 				if (it->it_overrun + overruns >=
1690 				    it->it_overrun &&
1691 				    it->it_overrun + overruns <= INT_MAX) {
1692 					it->it_overrun += (int)overruns;
1693 				} else {
1694 					it->it_overrun = INT_MAX;
1695 					it->it_ksi.ksi_errno = ERANGE;
1696 				}
1697 				value =
1698 				    now + interval - (now - value) % interval;
1699 				it->it_time.it_value = timespecfromns(value);
1700 			}
1701 		} else {
1702 			/* single shot timer ? */
1703 			timespecclear(&it->it_time.it_value);
1704 		}
1705 
1706 		p = it->it_proc;
1707 		if (timespecisset(&it->it_time.it_value)) {
1708 			if (P_SHOULDSTOP(p) || P_KILLED(p)) {
1709 				it->it_flags |= ITF_PSTOPPED;
1710 			} else {
1711 				timespecsub(&it->it_time.it_value, &cts, &ts);
1712 				TIMESPEC_TO_TIMEVAL(&tv, &ts);
1713 				callout_reset(&it->it_callout, tvtohz(&tv),
1714 				    realtimer_expire, it);
1715 			}
1716 		}
1717 
1718 		itimer_enter(it);
1719 		ITIMER_UNLOCK(it);
1720 		if (proc_locked)
1721 			PROC_UNLOCK(p);
1722 		itimer_fire(it);
1723 		if (proc_locked)
1724 			PROC_LOCK(p);
1725 		ITIMER_LOCK(it);
1726 		itimer_leave(it);
1727 	} else if (timespecisset(&it->it_time.it_value)) {
1728 		p = it->it_proc;
1729 		if (P_SHOULDSTOP(p) || P_KILLED(p)) {
1730 			it->it_flags |= ITF_PSTOPPED;
1731 		} else {
1732 			ts = it->it_time.it_value;
1733 			timespecsub(&ts, &cts, &ts);
1734 			TIMESPEC_TO_TIMEVAL(&tv, &ts);
1735 			callout_reset(&it->it_callout, tvtohz(&tv),
1736 			    realtimer_expire, it);
1737 		}
1738 	}
1739 }
1740 
1741 /* Timeout callback for realtime timer */
1742 static void
realtimer_expire(void * arg)1743 realtimer_expire(void *arg)
1744 {
1745 	realtimer_expire_l(arg, false);
1746 }
1747 
1748 static void
itimer_fire(struct itimer * it)1749 itimer_fire(struct itimer *it)
1750 {
1751 	struct proc *p = it->it_proc;
1752 	struct thread *td;
1753 
1754 	if (it->it_sigev.sigev_notify == SIGEV_SIGNAL ||
1755 	    it->it_sigev.sigev_notify == SIGEV_THREAD_ID) {
1756 		if (sigev_findtd(p, &it->it_sigev, &td) != 0) {
1757 			ITIMER_LOCK(it);
1758 			timespecclear(&it->it_time.it_value);
1759 			timespecclear(&it->it_time.it_interval);
1760 			callout_stop(&it->it_callout);
1761 			ITIMER_UNLOCK(it);
1762 			return;
1763 		}
1764 		if (!KSI_ONQ(&it->it_ksi)) {
1765 			it->it_ksi.ksi_errno = 0;
1766 			ksiginfo_set_sigev(&it->it_ksi, &it->it_sigev);
1767 			tdsendsignal(p, td, it->it_ksi.ksi_signo, &it->it_ksi);
1768 		} else {
1769 			if (it->it_overrun < INT_MAX)
1770 				it->it_overrun++;
1771 			else
1772 				it->it_ksi.ksi_errno = ERANGE;
1773 		}
1774 		PROC_UNLOCK(p);
1775 	}
1776 }
1777 
1778 static void
itimers_alloc(struct proc * p)1779 itimers_alloc(struct proc *p)
1780 {
1781 	struct itimers *its;
1782 
1783 	its = malloc(sizeof (struct itimers), M_SUBPROC, M_WAITOK | M_ZERO);
1784 	PROC_LOCK(p);
1785 	if (p->p_itimers == NULL) {
1786 		p->p_itimers = its;
1787 		PROC_UNLOCK(p);
1788 	}
1789 	else {
1790 		PROC_UNLOCK(p);
1791 		free(its, M_SUBPROC);
1792 	}
1793 }
1794 
1795 /* Clean up timers when some process events are being triggered. */
1796 static void
itimers_event_exit_exec(int start_idx,struct proc * p)1797 itimers_event_exit_exec(int start_idx, struct proc *p)
1798 {
1799 	struct itimers *its;
1800 	struct itimer *it;
1801 	int i;
1802 
1803 	its = p->p_itimers;
1804 	if (its == NULL)
1805 		return;
1806 
1807 	for (i = start_idx; i < TIMER_MAX; ++i) {
1808 		if ((it = its->its_timers[i]) != NULL)
1809 			kern_ktimer_delete(curthread, i);
1810 	}
1811 	if (its->its_timers[0] == NULL && its->its_timers[1] == NULL &&
1812 	    its->its_timers[2] == NULL) {
1813 		/* Synchronize with itimer_proc_continue(). */
1814 		PROC_LOCK(p);
1815 		p->p_itimers = NULL;
1816 		PROC_UNLOCK(p);
1817 		free(its, M_SUBPROC);
1818 	}
1819 }
1820 
1821 void
itimers_exec(struct proc * p)1822 itimers_exec(struct proc *p)
1823 {
1824 	/*
1825 	 * According to susv3, XSI interval timers should be inherited
1826 	 * by new image.
1827 	 */
1828 	itimers_event_exit_exec(3, p);
1829 }
1830 
1831 void
itimers_exit(struct proc * p)1832 itimers_exit(struct proc *p)
1833 {
1834 	itimers_event_exit_exec(0, p);
1835 }
1836