xref: /linux/kernel/time/posix-cpu-timers.c (revision aaf3d47e530616ed0cf9110ba8c537ace455dd90)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Implement CPU time clocks for the POSIX clock interface.
4  */
5 
6 #include <linux/sched/signal.h>
7 #include <linux/sched/cputime.h>
8 #include <linux/posix-timers.h>
9 #include <linux/errno.h>
10 #include <linux/math64.h>
11 #include <linux/uaccess.h>
12 #include <linux/kernel_stat.h>
13 #include <trace/events/timer.h>
14 #include <linux/tick.h>
15 #include <linux/workqueue.h>
16 #include <linux/compat.h>
17 #include <linux/sched/deadline.h>
18 #include <linux/task_work.h>
19 
20 #include "posix-timers.h"
21 
22 static bool posix_cpu_timer_rearm(struct k_itimer *timer);
23 
24 void posix_cputimers_group_init(struct posix_cputimers *pct, u64 cpu_limit)
25 {
26 	posix_cputimers_init(pct);
27 	if (cpu_limit != RLIM_INFINITY) {
28 		pct->bases[CPUCLOCK_PROF].nextevt = cpu_limit * NSEC_PER_SEC;
29 		pct->timers_active = true;
30 	}
31 }
32 
33 /*
34  * Called after updating RLIMIT_CPU to run cpu timer and update
35  * tsk->signal->posix_cputimers.bases[clock].nextevt expiration cache if
36  * necessary. Needs siglock protection since other code may update the
37  * expiration cache as well.
38  *
39  * Returns 0 on success, -ESRCH on failure.  Can fail if the task is exiting and
40  * we cannot lock_task_sighand.  Cannot fail if task is current.
41  */
42 int update_rlimit_cpu(struct task_struct *task, unsigned long rlim_new)
43 {
44 	u64 nsecs = (u64)rlim_new * NSEC_PER_SEC;
45 	unsigned long irq_fl;
46 
47 	if (!lock_task_sighand(task, &irq_fl))
48 		return -ESRCH;
49 	set_process_cpu_timer(task, CPUCLOCK_PROF, &nsecs, NULL);
50 	unlock_task_sighand(task, &irq_fl);
51 	return 0;
52 }
53 
54 /*
55  * Functions for validating access to tasks.
56  */
57 static struct pid *pid_for_clock(const clockid_t clock, bool gettime)
58 {
59 	const bool thread = !!CPUCLOCK_PERTHREAD(clock);
60 	const pid_t upid = CPUCLOCK_PID(clock);
61 	struct pid *pid;
62 
63 	if (CPUCLOCK_WHICH(clock) >= CPUCLOCK_MAX)
64 		return NULL;
65 
66 	/*
67 	 * If the encoded PID is 0, then the timer is targeted at current
68 	 * or the process to which current belongs.
69 	 */
70 	if (upid == 0)
71 		return thread ? task_pid(current) : task_tgid(current);
72 
73 	pid = find_vpid(upid);
74 	if (!pid)
75 		return NULL;
76 
77 	if (thread) {
78 		struct task_struct *tsk = pid_task(pid, PIDTYPE_PID);
79 		return (tsk && same_thread_group(tsk, current)) ? pid : NULL;
80 	}
81 
82 	/*
83 	 * For clock_gettime(PROCESS) allow finding the process by
84 	 * with the pid of the current task.  The code needs the tgid
85 	 * of the process so that pid_task(pid, PIDTYPE_TGID) can be
86 	 * used to find the process.
87 	 */
88 	if (gettime && (pid == task_pid(current)))
89 		return task_tgid(current);
90 
91 	/*
92 	 * For processes require that pid identifies a process.
93 	 */
94 	return pid_has_task(pid, PIDTYPE_TGID) ? pid : NULL;
95 }
96 
97 static inline int validate_clock_permissions(const clockid_t clock)
98 {
99 	int ret;
100 
101 	rcu_read_lock();
102 	ret = pid_for_clock(clock, false) ? 0 : -EINVAL;
103 	rcu_read_unlock();
104 
105 	return ret;
106 }
107 
108 static inline enum pid_type clock_pid_type(const clockid_t clock)
109 {
110 	return CPUCLOCK_PERTHREAD(clock) ? PIDTYPE_PID : PIDTYPE_TGID;
111 }
112 
113 static inline struct task_struct *cpu_timer_task_rcu(struct k_itimer *timer)
114 {
115 	return pid_task(timer->it.cpu.pid, clock_pid_type(timer->it_clock));
116 }
117 
118 /*
119  * Update expiry time from increment, and increase overrun count,
120  * given the current clock sample.
121  */
122 static u64 bump_cpu_timer(struct k_itimer *timer, u64 now)
123 {
124 	u64 delta, incr, expires = timer->it.cpu.node.expires;
125 	int i;
126 
127 	if (!timer->it_interval)
128 		return expires;
129 
130 	if (now < expires)
131 		return expires;
132 
133 	incr = timer->it_interval;
134 	delta = now + incr - expires;
135 
136 	/* Don't use (incr*2 < delta), incr*2 might overflow. */
137 	for (i = 0; incr < delta - incr; i++)
138 		incr = incr << 1;
139 
140 	for (; i >= 0; incr >>= 1, i--) {
141 		if (delta < incr)
142 			continue;
143 
144 		timer->it.cpu.node.expires += incr;
145 		timer->it_overrun += 1LL << i;
146 		delta -= incr;
147 	}
148 	return timer->it.cpu.node.expires;
149 }
150 
151 /* Check whether all cache entries contain U64_MAX, i.e. eternal expiry time */
152 static inline bool expiry_cache_is_inactive(const struct posix_cputimers *pct)
153 {
154 	return !(~pct->bases[CPUCLOCK_PROF].nextevt |
155 		 ~pct->bases[CPUCLOCK_VIRT].nextevt |
156 		 ~pct->bases[CPUCLOCK_SCHED].nextevt);
157 }
158 
159 static int
160 posix_cpu_clock_getres(const clockid_t which_clock, struct timespec64 *tp)
161 {
162 	int error = validate_clock_permissions(which_clock);
163 
164 	if (!error) {
165 		tp->tv_sec = 0;
166 		tp->tv_nsec = ((NSEC_PER_SEC + HZ - 1) / HZ);
167 		if (CPUCLOCK_WHICH(which_clock) == CPUCLOCK_SCHED) {
168 			/*
169 			 * If sched_clock is using a cycle counter, we
170 			 * don't have any idea of its true resolution
171 			 * exported, but it is much more than 1s/HZ.
172 			 */
173 			tp->tv_nsec = 1;
174 		}
175 	}
176 	return error;
177 }
178 
179 static int
180 posix_cpu_clock_set(const clockid_t clock, const struct timespec64 *tp)
181 {
182 	int error = validate_clock_permissions(clock);
183 
184 	/*
185 	 * You can never reset a CPU clock, but we check for other errors
186 	 * in the call before failing with EPERM.
187 	 */
188 	return error ? : -EPERM;
189 }
190 
191 /*
192  * Sample a per-thread clock for the given task. clkid is validated.
193  */
194 static u64 cpu_clock_sample(const clockid_t clkid, struct task_struct *p)
195 {
196 	u64 utime, stime;
197 
198 	if (clkid == CPUCLOCK_SCHED)
199 		return task_sched_runtime(p);
200 
201 	task_cputime(p, &utime, &stime);
202 
203 	switch (clkid) {
204 	case CPUCLOCK_PROF:
205 		return utime + stime;
206 	case CPUCLOCK_VIRT:
207 		return utime;
208 	default:
209 		WARN_ON_ONCE(1);
210 	}
211 	return 0;
212 }
213 
214 static inline void store_samples(u64 *samples, u64 stime, u64 utime, u64 rtime)
215 {
216 	samples[CPUCLOCK_PROF] = stime + utime;
217 	samples[CPUCLOCK_VIRT] = utime;
218 	samples[CPUCLOCK_SCHED] = rtime;
219 }
220 
221 static void task_sample_cputime(struct task_struct *p, u64 *samples)
222 {
223 	u64 stime, utime;
224 
225 	task_cputime(p, &utime, &stime);
226 	store_samples(samples, stime, utime, p->se.sum_exec_runtime);
227 }
228 
229 static void proc_sample_cputime_atomic(struct task_cputime_atomic *at,
230 				       u64 *samples)
231 {
232 	u64 stime, utime, rtime;
233 
234 	utime = atomic64_read(&at->utime);
235 	stime = atomic64_read(&at->stime);
236 	rtime = atomic64_read(&at->sum_exec_runtime);
237 	store_samples(samples, stime, utime, rtime);
238 }
239 
240 /*
241  * Set cputime to sum_cputime if sum_cputime > cputime. Use cmpxchg
242  * to avoid race conditions with concurrent updates to cputime.
243  */
244 static inline void __update_gt_cputime(atomic64_t *cputime, u64 sum_cputime)
245 {
246 	u64 curr_cputime = atomic64_read(cputime);
247 
248 	do {
249 		if (sum_cputime <= curr_cputime)
250 			return;
251 	} while (!atomic64_try_cmpxchg(cputime, &curr_cputime, sum_cputime));
252 }
253 
254 static void update_gt_cputime(struct task_cputime_atomic *cputime_atomic,
255 			      struct task_cputime *sum)
256 {
257 	__update_gt_cputime(&cputime_atomic->utime, sum->utime);
258 	__update_gt_cputime(&cputime_atomic->stime, sum->stime);
259 	__update_gt_cputime(&cputime_atomic->sum_exec_runtime, sum->sum_exec_runtime);
260 }
261 
262 /**
263  * thread_group_sample_cputime - Sample cputime for a given task
264  * @tsk:	Task for which cputime needs to be started
265  * @samples:	Storage for time samples
266  *
267  * Called from sys_getitimer() to calculate the expiry time of an active
268  * timer. That means group cputime accounting is already active. Called
269  * with task sighand lock held.
270  *
271  * Updates @times with an uptodate sample of the thread group cputimes.
272  */
273 void thread_group_sample_cputime(struct task_struct *tsk, u64 *samples)
274 {
275 	struct thread_group_cputimer *cputimer = &tsk->signal->cputimer;
276 	struct posix_cputimers *pct = &tsk->signal->posix_cputimers;
277 
278 	WARN_ON_ONCE(!pct->timers_active);
279 
280 	proc_sample_cputime_atomic(&cputimer->cputime_atomic, samples);
281 }
282 
283 /**
284  * thread_group_start_cputime - Start cputime and return a sample
285  * @tsk:	Task for which cputime needs to be started
286  * @samples:	Storage for time samples
287  *
288  * The thread group cputime accounting is avoided when there are no posix
289  * CPU timers armed. Before starting a timer it's required to check whether
290  * the time accounting is active. If not, a full update of the atomic
291  * accounting store needs to be done and the accounting enabled.
292  *
293  * Updates @times with an uptodate sample of the thread group cputimes.
294  */
295 static void thread_group_start_cputime(struct task_struct *tsk, u64 *samples)
296 {
297 	struct thread_group_cputimer *cputimer = &tsk->signal->cputimer;
298 	struct posix_cputimers *pct = &tsk->signal->posix_cputimers;
299 
300 	lockdep_assert_task_sighand_held(tsk);
301 
302 	/* Check if cputimer isn't running. This is accessed without locking. */
303 	if (!READ_ONCE(pct->timers_active)) {
304 		struct task_cputime sum;
305 
306 		/*
307 		 * The POSIX timer interface allows for absolute time expiry
308 		 * values through the TIMER_ABSTIME flag, therefore we have
309 		 * to synchronize the timer to the clock every time we start it.
310 		 */
311 		thread_group_cputime(tsk, &sum);
312 		update_gt_cputime(&cputimer->cputime_atomic, &sum);
313 
314 		/*
315 		 * We're setting timers_active without a lock. Ensure this
316 		 * only gets written to in one operation. We set it after
317 		 * update_gt_cputime() as a small optimization, but
318 		 * barriers are not required because update_gt_cputime()
319 		 * can handle concurrent updates.
320 		 */
321 		WRITE_ONCE(pct->timers_active, true);
322 	}
323 	proc_sample_cputime_atomic(&cputimer->cputime_atomic, samples);
324 }
325 
326 static void __thread_group_cputime(struct task_struct *tsk, u64 *samples)
327 {
328 	struct task_cputime ct;
329 
330 	thread_group_cputime(tsk, &ct);
331 	store_samples(samples, ct.stime, ct.utime, ct.sum_exec_runtime);
332 }
333 
334 /*
335  * Sample a process (thread group) clock for the given task clkid. If the
336  * group's cputime accounting is already enabled, read the atomic
337  * store. Otherwise a full update is required.  clkid is already validated.
338  */
339 static u64 cpu_clock_sample_group(const clockid_t clkid, struct task_struct *p,
340 				  bool start)
341 {
342 	struct thread_group_cputimer *cputimer = &p->signal->cputimer;
343 	struct posix_cputimers *pct = &p->signal->posix_cputimers;
344 	u64 samples[CPUCLOCK_MAX];
345 
346 	if (!READ_ONCE(pct->timers_active)) {
347 		if (start)
348 			thread_group_start_cputime(p, samples);
349 		else
350 			__thread_group_cputime(p, samples);
351 	} else {
352 		proc_sample_cputime_atomic(&cputimer->cputime_atomic, samples);
353 	}
354 
355 	return samples[clkid];
356 }
357 
358 static int posix_cpu_clock_get(const clockid_t clock, struct timespec64 *tp)
359 {
360 	const clockid_t clkid = CPUCLOCK_WHICH(clock);
361 	struct task_struct *tsk;
362 	u64 t;
363 
364 	rcu_read_lock();
365 	tsk = pid_task(pid_for_clock(clock, true), clock_pid_type(clock));
366 	if (!tsk) {
367 		rcu_read_unlock();
368 		return -EINVAL;
369 	}
370 
371 	if (CPUCLOCK_PERTHREAD(clock))
372 		t = cpu_clock_sample(clkid, tsk);
373 	else
374 		t = cpu_clock_sample_group(clkid, tsk, false);
375 	rcu_read_unlock();
376 
377 	*tp = ns_to_timespec64(t);
378 	return 0;
379 }
380 
381 /*
382  * Validate the clockid_t for a new CPU-clock timer, and initialize the timer.
383  * This is called from sys_timer_create() and do_cpu_nanosleep() with the
384  * new timer already all-zeros initialized.
385  */
386 static int posix_cpu_timer_create(struct k_itimer *new_timer)
387 {
388 	static struct lock_class_key posix_cpu_timers_key;
389 	struct pid *pid;
390 
391 	rcu_read_lock();
392 	pid = pid_for_clock(new_timer->it_clock, false);
393 	if (!pid) {
394 		rcu_read_unlock();
395 		return -EINVAL;
396 	}
397 
398 	/*
399 	 * If posix timer expiry is handled in task work context then
400 	 * timer::it_lock can be taken without disabling interrupts as all
401 	 * other locking happens in task context. This requires a separate
402 	 * lock class key otherwise regular posix timer expiry would record
403 	 * the lock class being taken in interrupt context and generate a
404 	 * false positive warning.
405 	 */
406 	if (IS_ENABLED(CONFIG_POSIX_CPU_TIMERS_TASK_WORK))
407 		lockdep_set_class(&new_timer->it_lock, &posix_cpu_timers_key);
408 
409 	new_timer->kclock = &clock_posix_cpu;
410 	timerqueue_init(&new_timer->it.cpu.node);
411 	INIT_LIST_HEAD(&new_timer->it.cpu.elist);
412 	new_timer->it.cpu.pid = get_pid(pid);
413 	rcu_read_unlock();
414 	return 0;
415 }
416 
417 static struct posix_cputimer_base *timer_base(struct k_itimer *timer,
418 					      struct task_struct *tsk)
419 {
420 	int clkidx = CPUCLOCK_WHICH(timer->it_clock);
421 
422 	if (CPUCLOCK_PERTHREAD(timer->it_clock))
423 		return tsk->posix_cputimers.bases + clkidx;
424 	else
425 		return tsk->signal->posix_cputimers.bases + clkidx;
426 }
427 
428 /*
429  * Force recalculating the base earliest expiration on the next tick.
430  * This will also re-evaluate the need to keep around the process wide
431  * cputime counter and tick dependency and eventually shut these down
432  * if necessary.
433  */
434 static void trigger_base_recalc_expires(struct k_itimer *timer,
435 					struct task_struct *tsk)
436 {
437 	struct posix_cputimer_base *base = timer_base(timer, tsk);
438 
439 	base->nextevt = 0;
440 }
441 
442 static inline bool cpu_timer_enqueue(struct timerqueue_head *head,
443 				     struct cpu_timer *ctmr)
444 {
445 	ctmr->head = head;
446 	return timerqueue_add(head, &ctmr->node);
447 }
448 
449 static inline bool cpu_timer_queued(struct cpu_timer *ctmr)
450 {
451 	return !!ctmr->head;
452 }
453 
454 static inline bool cpu_timer_dequeue(struct cpu_timer *ctmr)
455 {
456 	if (cpu_timer_queued(ctmr)) {
457 		timerqueue_del(ctmr->head, &ctmr->node);
458 		ctmr->head = NULL;
459 		return true;
460 	}
461 	return false;
462 }
463 
464 static inline u64 cpu_timer_getexpires(struct cpu_timer *ctmr)
465 {
466 	return ctmr->node.expires;
467 }
468 
469 static inline void cpu_timer_setexpires(struct cpu_timer *ctmr, u64 exp)
470 {
471 	ctmr->node.expires = exp;
472 }
473 
474 /*
475  * Dequeue the timer and reset the base if it was its earliest expiration.
476  * It makes sure the next tick recalculates the base next expiration so we
477  * don't keep the costly process wide cputime counter around for a random
478  * amount of time, along with the tick dependency.
479  *
480  * If another timer gets queued between this and the next tick, its
481  * expiration will update the base next event if necessary on the next
482  * tick.
483  */
484 static void disarm_timer(struct k_itimer *timer, struct task_struct *p)
485 {
486 	struct cpu_timer *ctmr = &timer->it.cpu;
487 	struct posix_cputimer_base *base;
488 
489 	if (!cpu_timer_dequeue(ctmr))
490 		return;
491 
492 	base = timer_base(timer, p);
493 	if (cpu_timer_getexpires(ctmr) == base->nextevt)
494 		trigger_base_recalc_expires(timer, p);
495 }
496 
497 /*
498  * Lookup the task via timer->it.cpu.pid and attempt to lock the task's sighand.
499  *
500  * This can race with the reaping of the task:
501  *
502  * CPU0					CPU1
503  *
504  * // Finds task
505  * p = pid_task(pid, pid_type);		__exit_signal(p)
506  *					  lock(p, sighand);
507  *					  posix_cpu_timers*_exit();
508  * sighand = lock_task_sighand(p);	  unhash_task(p);
509  *					  p->sighand = NULL;
510  *					  unlock(sighand);
511  *
512  * In this case sighand is NULL, which means the task and the associated timer
513  * queue cannot be longer accessed safely.
514  *
515  * __exit_signal() invokes posix_cpu_timers_exit() and if the thread group is
516  * dead it also invokes posix_cpu_timers_group_exit(). These functions delete
517  * all pending timers from the related timer queues. The POSIX timers (k_itimer)
518  * themself are still accessible, but not longer connected to the task.
519  *
520  * exec() works slightly differently. The task which exec()'s terminates all
521  * other threads in the thread group and runs __exit_signal() on them. As the
522  * thread group is not dead they only clean up the per task timers via
523  * posix_cpu_timers_exit().
524  *
525  * As the TGID on exec() stays the same per process timers stay queued, if they
526  * are armed. This works without a problem when exec() is done by the thread
527  * group leader. If a non-leader thread exec()'s this can end up in the
528  * following scenario:
529  *
530  * CPU0					CPU1
531  * // Returns old leader
532  * p = pid_task(pid, pid_type);		de_thread()
533  *					switch_leader()
534  *					release_task(old leader)
535  *					  __exit_signal()
536  *					  old_leader->sighand = NULL;
537  * // Returns NULL
538  * sighand = lock_task_sighand(p)
539  *
540  * That's problematic for several functions:
541  *
542  *  - posix_cpu_timer_del(): If the timer is still enqueued on the task the
543  *    underlying k_itimer will be freed which results in a UAF in
544  *    run_posix_cpu_timers() or on timerqueue related add/delete operations.
545  *    If the timer is not enqueued, the failure is harmless
546  *
547  *  - posix_cpu_timer_set(): Independent of the enqueued state that results in a
548  *    transient failure which is user space visible (-ESRCH) for regular posix
549  *    timers. But for the use case in do_cpu_nanosleep() it's the same UAF
550  *    problem just that the timer is allocated on the stack.
551  *
552  *  - posix_cpu_timer_rearm(): Timer is not enqueued at that point, but this
553  *    silently ignores the rearm request, which is a functional problem as the
554  *    timer wont expire anymore.
555  */
556 static struct task_struct *timer_lock_sighand(struct k_itimer *timer, unsigned long *flags)
557 {
558 	enum pid_type type = clock_pid_type(timer->it_clock);
559 	struct cpu_timer *ctmr = &timer->it.cpu;
560 
561 	guard(rcu)();
562 
563 	for (;;) {
564 		struct task_struct *t = pid_task(timer->it.cpu.pid, type);
565 
566 		/* Fail if the task cannot be found. */
567 		if (!t)
568 			break;
569 
570 		/* Try to lock the task's sighand */
571 		if (lock_task_sighand(t, flags))
572 			return t;
573 
574 		/*
575 		 * The next PID lookup might either fail or return the new
576 		 * leader. This is correct for both exit() and exec().
577 		 */
578 	}
579 
580 	/*
581 	 * If the timer is still enqueued, warn. There is nothing safe to do
582 	 * here as there might be two timers in there which are removed in
583 	 * parallel and that will cause more damage than good. This should never
584 	 * happen!
585 	 *
586 	 * Ensure that the stores to the timer and timerqueue are visible:
587 	 *
588 	 * __exit_signal()
589 	 *   posix_cpu_timers*_exit()
590 	 *   write_seqlock(seqlock)
591 	 *	smp_wmb(); <-------
592 	 *   __unhash_process()	  |	!pid_task()
593 	 *			  ---->	smp_rmb();
594 	 *				WARN_ON_ONCE(...)
595 	 */
596 	smp_rmb();
597 	WARN_ON_ONCE(ctmr->head || timerqueue_node_queued(&ctmr->node));
598 	return NULL;
599 }
600 
601 /*
602  * If the timer is queued on the expiry list, then it cannot be dequeued because
603  * the firing list is not protected by sighand->lock. The delivery path is
604  * waiting for the timer lock. So go back, unlock and retry.
605  */
606 static bool posix_cpu_timer_on_expiry_list(struct k_itimer *timer)
607 {
608 	if (list_empty(&timer->it.cpu.elist))
609 		return false;
610 
611 	/*
612 	 * Prevent signal delivery as there is no point in delivering a signal
613 	 * which is made obsolete right away.
614 	 */
615 	timer->it.cpu.firing = false;
616 	return true;
617 }
618 
619 /*
620  * Clean up a CPU-clock timer that is about to be destroyed.
621  * This is called from timer deletion with the timer already locked.
622  * If we return TIMER_RETRY, it's necessary to release the timer's lock
623  * and try again.  (This happens when the timer is in the middle of firing.)
624  */
625 static int posix_cpu_timer_del(struct k_itimer *timer)
626 {
627 	struct task_struct *p;
628 	unsigned long flags;
629 	int ret = 0;
630 
631 	p = timer_lock_sighand(timer, &flags);
632 
633 	if (likely(p)) {
634 		if (posix_cpu_timer_on_expiry_list(timer))
635 			ret = TIMER_RETRY;
636 		else
637 			disarm_timer(timer, p);
638 		unlock_task_sighand(p, &flags);
639 	}
640 
641 	if (!ret) {
642 		WARN_ON_ONCE(cpu_timer_queued(&timer->it.cpu));
643 		put_pid(timer->it.cpu.pid);
644 		timer->it_status = POSIX_TIMER_DISARMED;
645 	}
646 	return ret;
647 }
648 
649 static void cleanup_timerqueue(struct timerqueue_head *head)
650 {
651 	struct timerqueue_node *node;
652 	struct cpu_timer *ctmr;
653 
654 	while ((node = timerqueue_getnext(head))) {
655 		timerqueue_del(head, node);
656 		ctmr = container_of(node, struct cpu_timer, node);
657 		ctmr->head = NULL;
658 	}
659 }
660 
661 /*
662  * Clean out CPU timers which are still armed when a thread exits. The
663  * timers are only removed from the list. No other updates are done. The
664  * corresponding posix timers are still accessible, but cannot be rearmed.
665  *
666  * This must be called with the siglock held.
667  */
668 static void cleanup_timers(struct posix_cputimers *pct)
669 {
670 	cleanup_timerqueue(&pct->bases[CPUCLOCK_PROF].tqhead);
671 	cleanup_timerqueue(&pct->bases[CPUCLOCK_VIRT].tqhead);
672 	cleanup_timerqueue(&pct->bases[CPUCLOCK_SCHED].tqhead);
673 }
674 
675 static inline void posix_cpu_timers_exit_work(void);
676 
677 /*
678  * Invoked from posixtimer_exit_task() after PF_EXITING was set in tsk::flags or
679  * from posixtimer_exec_cleanup().
680  */
681 void posix_cpu_timers_exit_task(void)
682 {
683 	posix_cpu_timers_exit_work();
684 
685 	guard(spinlock_irq)(&current->sighand->siglock);
686 	cleanup_timers(&current->posix_cputimers);
687 }
688 
689 /*
690  * Invoked from posixtimer_exit_group() after PF_EXITING was set in tsk::flags.
691  */
692 void posix_cpu_timers_exit_group(void)
693 {
694 	posix_cpu_timers_exit_task();
695 
696 	guard(spinlock_irq)(&current->sighand->siglock);
697 	cleanup_timers(&current->signal->posix_cputimers);
698 }
699 
700 /*
701  * This function validates that POSIX CPU timers can be safely enqueued on the
702  * target task.
703  *
704  * Enqueue is allowed when PF_EXITING is not set. If set then it is only allowed
705  * for process shared timers (type = PIDTYPE_TGID) as long as tsk::signal::flags
706  * does not have SIGNAL_GROUP_EXIT set. PIDTYPE_PID targets are not allowed at
707  * all when the task has PF_EXITING set.
708  *
709  * This guarantees that after the POSIX timer cleanup in posixtimer_exit() no
710  * POSIX CPU timers are queued on the task or in case of a group exit on the
711  * process.
712  */
713 static inline bool task_can_enqueue_timer(struct task_struct *tsk, enum pid_type type)
714 {
715 	if (likely(!(tsk->flags & PF_EXITING)))
716 		return true;
717 
718 	return type == PIDTYPE_TGID && !(tsk->signal->flags & SIGNAL_GROUP_EXIT);
719 }
720 
721 /*
722  * Insert the timer on the appropriate list before any timers that
723  * expire later.  This must be called with the sighand lock held.
724  */
725 static void arm_timer(struct k_itimer *timer, struct task_struct *p)
726 {
727 	struct posix_cputimer_base *base = timer_base(timer, p);
728 	struct cpu_timer *ctmr = &timer->it.cpu;
729 	u64 newexp = cpu_timer_getexpires(ctmr);
730 
731 	lockdep_assert_held(&p->sighand->siglock);
732 
733 	timer->it_status = POSIX_TIMER_ARMED;
734 
735 	if (unlikely(!task_can_enqueue_timer(p, clock_pid_type(timer->it_clock))))
736 		return;
737 
738 	if (!cpu_timer_enqueue(&base->tqhead, ctmr))
739 		return;
740 
741 	/*
742 	 * We are the new earliest-expiring POSIX 1.b timer, hence
743 	 * need to update expiration cache. Take into account that
744 	 * for process timers we share expiration cache with itimers
745 	 * and RLIMIT_CPU and for thread timers with RLIMIT_RTTIME.
746 	 */
747 	if (newexp < base->nextevt)
748 		base->nextevt = newexp;
749 
750 	if (CPUCLOCK_PERTHREAD(timer->it_clock))
751 		tick_dep_set_task(p, TICK_DEP_BIT_POSIX_TIMER);
752 	else
753 		tick_dep_set_signal(p, TICK_DEP_BIT_POSIX_TIMER);
754 }
755 
756 /*
757  * The timer is locked, fire it and arrange for its reload.
758  */
759 static void cpu_timer_fire(struct k_itimer *timer)
760 {
761 	struct cpu_timer *ctmr = &timer->it.cpu;
762 
763 	timer->it_status = POSIX_TIMER_DISARMED;
764 
765 	if (unlikely(ctmr->nanosleep)) {
766 		/*
767 		 * This a special case for clock_nanosleep,
768 		 * not a normal timer from sys_timer_create.
769 		 */
770 		wake_up_process(timer->it_process);
771 		cpu_timer_setexpires(ctmr, 0);
772 	} else {
773 		posix_timer_queue_signal(timer);
774 		/* Disable oneshot timers */
775 		if (!timer->it_interval)
776 			cpu_timer_setexpires(ctmr, 0);
777 	}
778 }
779 
780 static void __posix_cpu_timer_get(struct k_itimer *timer, struct itimerspec64 *itp, u64 now);
781 
782 /*
783  * Guts of sys_timer_settime for CPU timers.
784  * This is called with the timer locked and interrupts disabled.
785  * If we return TIMER_RETRY, it's necessary to release the timer's lock
786  * and try again.  (This happens when the timer is in the middle of firing.)
787  */
788 static int posix_cpu_timer_set(struct k_itimer *timer, int timer_flags,
789 			       struct itimerspec64 *new, struct itimerspec64 *old)
790 {
791 	bool sigev_none = timer->it_sigev_notify == SIGEV_NONE;
792 	clockid_t clkid = CPUCLOCK_WHICH(timer->it_clock);
793 	struct cpu_timer *ctmr = &timer->it.cpu;
794 	u64 old_expires, new_expires, now;
795 	struct task_struct *p;
796 	unsigned long flags;
797 	int ret = 0;
798 
799 	p = timer_lock_sighand(timer, &flags);
800 	/*
801 	 * If p has just been reaped, we can no longer get any information about
802 	 * it at all.
803 	 */
804 	if (!p)
805 		return -ESRCH;
806 
807 	/*
808 	 * Use the to_ktime conversion because that clamps the maximum
809 	 * value to KTIME_MAX and avoid multiplication overflows.
810 	 */
811 	new_expires = ktime_to_ns(timespec64_to_ktime(new->it_value));
812 
813 	/* Retrieve the current expiry time before disarming the timer */
814 	old_expires = cpu_timer_getexpires(ctmr);
815 
816 	if (posix_cpu_timer_on_expiry_list(timer)) {
817 		ret = TIMER_RETRY;
818 	} else {
819 		cpu_timer_dequeue(ctmr);
820 		timer->it_status = POSIX_TIMER_DISARMED;
821 	}
822 
823 	/*
824 	 * Sample the current clock for saving the previous setting
825 	 * and for rearming the timer.
826 	 */
827 	if (CPUCLOCK_PERTHREAD(timer->it_clock))
828 		now = cpu_clock_sample(clkid, p);
829 	else
830 		now = cpu_clock_sample_group(clkid, p, !sigev_none);
831 
832 	/* Retrieve the previous expiry value if requested. */
833 	if (old) {
834 		old->it_value = (struct timespec64){ };
835 		if (old_expires)
836 			__posix_cpu_timer_get(timer, old, now);
837 	}
838 
839 	/* Retry if the timer expiry is running concurrently */
840 	if (unlikely(ret)) {
841 		unlock_task_sighand(p, &flags);
842 		return ret;
843 	}
844 
845 	/* Convert relative expiry time to absolute */
846 	if (new_expires && !(timer_flags & TIMER_ABSTIME))
847 		new_expires += now;
848 
849 	/* Set the new expiry time (might be 0) */
850 	cpu_timer_setexpires(ctmr, new_expires);
851 
852 	/*
853 	 * Arm the timer if it is not disabled, the new expiry value has
854 	 * not yet expired and the timer requires signal delivery.
855 	 * SIGEV_NONE timers are never armed. In case the timer is not
856 	 * armed, enforce the reevaluation of the timer base so that the
857 	 * process wide cputime counter can be disabled eventually.
858 	 */
859 	if (likely(!sigev_none)) {
860 		if (new_expires && now < new_expires)
861 			arm_timer(timer, p);
862 		else
863 			trigger_base_recalc_expires(timer, p);
864 	}
865 
866 	unlock_task_sighand(p, &flags);
867 
868 	posix_timer_set_common(timer, new);
869 
870 	/*
871 	 * If the new expiry time was already in the past the timer was not
872 	 * queued. Fire it immediately even if the thread never runs to
873 	 * accumulate more time on this clock.
874 	 */
875 	if (!sigev_none && new_expires && now >= new_expires)
876 		cpu_timer_fire(timer);
877 	return ret;
878 }
879 
880 static void __posix_cpu_timer_get(struct k_itimer *timer, struct itimerspec64 *itp, u64 now)
881 {
882 	bool sigev_none = timer->it_sigev_notify == SIGEV_NONE;
883 	u64 expires, iv = timer->it_interval;
884 
885 	/*
886 	 * Make sure that interval timers are moved forward for the
887 	 * following cases:
888 	 *  - SIGEV_NONE timers which are never armed
889 	 *  - Timers which expired, but the signal has not yet been
890 	 *    delivered
891 	 */
892 	if (iv && timer->it_status != POSIX_TIMER_ARMED)
893 		expires = bump_cpu_timer(timer, now);
894 	else
895 		expires = cpu_timer_getexpires(&timer->it.cpu);
896 
897 	/*
898 	 * Expired interval timers cannot have a remaining time <= 0.
899 	 * The kernel has to move them forward so that the next
900 	 * timer expiry is > @now.
901 	 */
902 	if (now < expires) {
903 		itp->it_value = ns_to_timespec64(expires - now);
904 	} else {
905 		/*
906 		 * A single shot SIGEV_NONE timer must return 0, when it is
907 		 * expired! Timers which have a real signal delivery mode
908 		 * must return a remaining time greater than 0 because the
909 		 * signal has not yet been delivered.
910 		 */
911 		if (!sigev_none)
912 			itp->it_value.tv_nsec = 1;
913 	}
914 }
915 
916 static void posix_cpu_timer_get(struct k_itimer *timer, struct itimerspec64 *itp)
917 {
918 	clockid_t clkid = CPUCLOCK_WHICH(timer->it_clock);
919 	struct task_struct *p;
920 	u64 now;
921 
922 	rcu_read_lock();
923 	p = cpu_timer_task_rcu(timer);
924 	if (p && cpu_timer_getexpires(&timer->it.cpu)) {
925 		itp->it_interval = ktime_to_timespec64(timer->it_interval);
926 
927 		if (CPUCLOCK_PERTHREAD(timer->it_clock))
928 			now = cpu_clock_sample(clkid, p);
929 		else
930 			now = cpu_clock_sample_group(clkid, p, false);
931 
932 		__posix_cpu_timer_get(timer, itp, now);
933 	}
934 	rcu_read_unlock();
935 }
936 
937 #define MAX_COLLECTED	20
938 
939 static u64 collect_timerqueue(struct timerqueue_head *head,
940 			      struct list_head *firing, u64 now)
941 {
942 	struct timerqueue_node *next;
943 	int i = 0;
944 
945 	while ((next = timerqueue_getnext(head))) {
946 		struct cpu_timer *ctmr;
947 		u64 expires;
948 
949 		ctmr = container_of(next, struct cpu_timer, node);
950 		expires = cpu_timer_getexpires(ctmr);
951 		/* Limit the number of timers to expire at once */
952 		if (++i == MAX_COLLECTED || now < expires)
953 			return expires;
954 
955 		ctmr->firing = true;
956 		/* See posix_cpu_timer_wait_running() */
957 		rcu_assign_pointer(ctmr->handling, current);
958 		cpu_timer_dequeue(ctmr);
959 		list_add_tail(&ctmr->elist, firing);
960 	}
961 
962 	return U64_MAX;
963 }
964 
965 static void collect_posix_cputimers(struct posix_cputimers *pct, u64 *samples,
966 				    struct list_head *firing)
967 {
968 	struct posix_cputimer_base *base = pct->bases;
969 	int i;
970 
971 	for (i = 0; i < CPUCLOCK_MAX; i++, base++) {
972 		base->nextevt = collect_timerqueue(&base->tqhead, firing,
973 						    samples[i]);
974 	}
975 }
976 
977 static inline void check_dl_overrun(struct task_struct *tsk)
978 {
979 	if (tsk->dl.dl_overrun) {
980 		tsk->dl.dl_overrun = 0;
981 		send_signal_locked(SIGXCPU, SEND_SIG_PRIV, tsk, PIDTYPE_TGID);
982 	}
983 }
984 
985 static bool check_rlimit(u64 time, u64 limit, int signo, bool rt, bool hard)
986 {
987 	if (time < limit)
988 		return false;
989 
990 	if (print_fatal_signals) {
991 		pr_info("%s Watchdog Timeout (%s): %s[%d]\n",
992 			rt ? "RT" : "CPU", hard ? "hard" : "soft",
993 			current->comm, task_pid_nr(current));
994 	}
995 	send_signal_locked(signo, SEND_SIG_PRIV, current, PIDTYPE_TGID);
996 	return true;
997 }
998 
999 /*
1000  * Check for any per-thread CPU timers that have fired and move them off
1001  * the tsk->cpu_timers[N] list onto the firing list.  Here we update the
1002  * tsk->it_*_expires values to reflect the remaining thread CPU timers.
1003  */
1004 static void check_thread_timers(struct task_struct *tsk,
1005 				struct list_head *firing)
1006 {
1007 	struct posix_cputimers *pct = &tsk->posix_cputimers;
1008 	u64 samples[CPUCLOCK_MAX];
1009 	unsigned long soft;
1010 
1011 	if (dl_task(tsk))
1012 		check_dl_overrun(tsk);
1013 
1014 	if (expiry_cache_is_inactive(pct))
1015 		return;
1016 
1017 	task_sample_cputime(tsk, samples);
1018 	collect_posix_cputimers(pct, samples, firing);
1019 
1020 	/*
1021 	 * Check for the special case thread timers.
1022 	 */
1023 	soft = task_rlimit(tsk, RLIMIT_RTTIME);
1024 	if (soft != RLIM_INFINITY) {
1025 		/* Task RT timeout is accounted in jiffies. RTTIME is usec */
1026 		unsigned long rttime = tsk->rt.timeout * (USEC_PER_SEC / HZ);
1027 		unsigned long hard = task_rlimit_max(tsk, RLIMIT_RTTIME);
1028 
1029 		/* At the hard limit, send SIGKILL. No further action. */
1030 		if (hard != RLIM_INFINITY &&
1031 		    check_rlimit(rttime, hard, SIGKILL, true, true))
1032 			return;
1033 
1034 		/* At the soft limit, send a SIGXCPU every second */
1035 		if (check_rlimit(rttime, soft, SIGXCPU, true, false)) {
1036 			soft += USEC_PER_SEC;
1037 			tsk->signal->rlim[RLIMIT_RTTIME].rlim_cur = soft;
1038 		}
1039 	}
1040 
1041 	if (expiry_cache_is_inactive(pct))
1042 		tick_dep_clear_task(tsk, TICK_DEP_BIT_POSIX_TIMER);
1043 }
1044 
1045 static inline void stop_process_timers(struct signal_struct *sig)
1046 {
1047 	struct posix_cputimers *pct = &sig->posix_cputimers;
1048 
1049 	/* Turn off the active flag. This is done without locking. */
1050 	WRITE_ONCE(pct->timers_active, false);
1051 	tick_dep_clear_signal(sig, TICK_DEP_BIT_POSIX_TIMER);
1052 }
1053 
1054 static void check_cpu_itimer(struct task_struct *tsk, struct cpu_itimer *it,
1055 			     u64 *expires, u64 cur_time, int signo)
1056 {
1057 	if (!it->expires)
1058 		return;
1059 
1060 	if (cur_time >= it->expires) {
1061 		if (it->incr)
1062 			it->expires += it->incr;
1063 		else
1064 			it->expires = 0;
1065 
1066 		trace_itimer_expire(signo == SIGPROF ?
1067 				    ITIMER_PROF : ITIMER_VIRTUAL,
1068 				    task_tgid(tsk), cur_time);
1069 		send_signal_locked(signo, SEND_SIG_PRIV, tsk, PIDTYPE_TGID);
1070 	}
1071 
1072 	if (it->expires && it->expires < *expires)
1073 		*expires = it->expires;
1074 }
1075 
1076 /*
1077  * Check for any per-thread CPU timers that have fired and move them
1078  * off the tsk->*_timers list onto the firing list.  Per-thread timers
1079  * have already been taken off.
1080  */
1081 static void check_process_timers(struct task_struct *tsk,
1082 				 struct list_head *firing)
1083 {
1084 	struct signal_struct *const sig = tsk->signal;
1085 	struct posix_cputimers *pct = &sig->posix_cputimers;
1086 	u64 samples[CPUCLOCK_MAX];
1087 	unsigned long soft;
1088 
1089 	/*
1090 	 * If there are no active process wide timers (POSIX 1.b, itimers,
1091 	 * RLIMIT_CPU) nothing to check. Also skip the process wide timer
1092 	 * processing when there is already another task handling them.
1093 	 */
1094 	if (!READ_ONCE(pct->timers_active) || pct->expiry_active)
1095 		return;
1096 
1097 	/*
1098 	 * Signify that a thread is checking for process timers.
1099 	 * Write access to this field is protected by the sighand lock.
1100 	 */
1101 	pct->expiry_active = true;
1102 
1103 	/*
1104 	 * Collect the current process totals. Group accounting is active
1105 	 * so the sample can be taken directly.
1106 	 */
1107 	proc_sample_cputime_atomic(&sig->cputimer.cputime_atomic, samples);
1108 	collect_posix_cputimers(pct, samples, firing);
1109 
1110 	/*
1111 	 * Check for the special case process timers.
1112 	 */
1113 	check_cpu_itimer(tsk, &sig->it[CPUCLOCK_PROF],
1114 			 &pct->bases[CPUCLOCK_PROF].nextevt,
1115 			 samples[CPUCLOCK_PROF], SIGPROF);
1116 	check_cpu_itimer(tsk, &sig->it[CPUCLOCK_VIRT],
1117 			 &pct->bases[CPUCLOCK_VIRT].nextevt,
1118 			 samples[CPUCLOCK_VIRT], SIGVTALRM);
1119 
1120 	soft = task_rlimit(tsk, RLIMIT_CPU);
1121 	if (soft != RLIM_INFINITY) {
1122 		/* RLIMIT_CPU is in seconds. Samples are nanoseconds */
1123 		unsigned long hard = task_rlimit_max(tsk, RLIMIT_CPU);
1124 		u64 ptime = samples[CPUCLOCK_PROF];
1125 		u64 softns = (u64)soft * NSEC_PER_SEC;
1126 		u64 hardns = (u64)hard * NSEC_PER_SEC;
1127 
1128 		/* At the hard limit, send SIGKILL. No further action. */
1129 		if (hard != RLIM_INFINITY &&
1130 		    check_rlimit(ptime, hardns, SIGKILL, false, true))
1131 			return;
1132 
1133 		/* At the soft limit, send a SIGXCPU every second */
1134 		if (check_rlimit(ptime, softns, SIGXCPU, false, false)) {
1135 			sig->rlim[RLIMIT_CPU].rlim_cur = soft + 1;
1136 			softns += NSEC_PER_SEC;
1137 		}
1138 
1139 		/* Update the expiry cache */
1140 		if (softns < pct->bases[CPUCLOCK_PROF].nextevt)
1141 			pct->bases[CPUCLOCK_PROF].nextevt = softns;
1142 	}
1143 
1144 	if (expiry_cache_is_inactive(pct))
1145 		stop_process_timers(sig);
1146 
1147 	pct->expiry_active = false;
1148 }
1149 
1150 /*
1151  * This is called from the signal code (via posixtimer_rearm)
1152  * when the last timer signal was delivered and we have to reload the timer.
1153  *
1154  * Return true unconditionally so the core code assumes the timer to be
1155  * armed. Otherwise it would requeue the signal.
1156  */
1157 static bool posix_cpu_timer_rearm(struct k_itimer *timer)
1158 {
1159 	clockid_t clkid = CPUCLOCK_WHICH(timer->it_clock);
1160 	struct task_struct *p;
1161 	unsigned long flags;
1162 	u64 now;
1163 
1164 	p = timer_lock_sighand(timer, &flags);
1165 	if (unlikely(!p))
1166 		return true;
1167 
1168 	/*
1169 	 * Fetch the current sample and update the timer's expiry time.
1170 	 */
1171 	if (CPUCLOCK_PERTHREAD(timer->it_clock))
1172 		now = cpu_clock_sample(clkid, p);
1173 	else
1174 		now = cpu_clock_sample_group(clkid, p, true);
1175 
1176 	bump_cpu_timer(timer, now);
1177 
1178 	/*
1179 	 * Now re-arm for the new expiry time.
1180 	 */
1181 	arm_timer(timer, p);
1182 	unlock_task_sighand(p, &flags);
1183 	return true;
1184 }
1185 
1186 /**
1187  * task_cputimers_expired - Check whether posix CPU timers are expired
1188  *
1189  * @samples:	Array of current samples for the CPUCLOCK clocks
1190  * @pct:	Pointer to a posix_cputimers container
1191  *
1192  * Returns true if any member of @samples is greater than the corresponding
1193  * member of @pct->bases[CLK].nextevt. False otherwise
1194  */
1195 static inline bool
1196 task_cputimers_expired(const u64 *samples, struct posix_cputimers *pct)
1197 {
1198 	int i;
1199 
1200 	for (i = 0; i < CPUCLOCK_MAX; i++) {
1201 		if (samples[i] >= pct->bases[i].nextevt)
1202 			return true;
1203 	}
1204 	return false;
1205 }
1206 
1207 /**
1208  * fastpath_timer_check - POSIX CPU timers fast path.
1209  *
1210  * @tsk:	The task (thread) being checked.
1211  *
1212  * Check the task and thread group timers.  If both are zero (there are no
1213  * timers set) return false.  Otherwise snapshot the task and thread group
1214  * timers and compare them with the corresponding expiration times.  Return
1215  * true if a timer has expired, else return false.
1216  */
1217 static inline bool fastpath_timer_check(struct task_struct *tsk)
1218 {
1219 	struct posix_cputimers *pct = &tsk->posix_cputimers;
1220 	struct signal_struct *sig;
1221 
1222 	if (!expiry_cache_is_inactive(pct)) {
1223 		u64 samples[CPUCLOCK_MAX];
1224 
1225 		task_sample_cputime(tsk, samples);
1226 		if (task_cputimers_expired(samples, pct))
1227 			return true;
1228 	}
1229 
1230 	sig = tsk->signal;
1231 	pct = &sig->posix_cputimers;
1232 	/*
1233 	 * Check if thread group timers expired when timers are active and
1234 	 * no other thread in the group is already handling expiry for
1235 	 * thread group cputimers. These fields are read without the
1236 	 * sighand lock. However, this is fine because this is meant to be
1237 	 * a fastpath heuristic to determine whether we should try to
1238 	 * acquire the sighand lock to handle timer expiry.
1239 	 *
1240 	 * In the worst case scenario, if concurrently timers_active is set
1241 	 * or expiry_active is cleared, but the current thread doesn't see
1242 	 * the change yet, the timer checks are delayed until the next
1243 	 * thread in the group gets a scheduler interrupt to handle the
1244 	 * timer. This isn't an issue in practice because these types of
1245 	 * delays with signals actually getting sent are expected.
1246 	 */
1247 	if (READ_ONCE(pct->timers_active) && !READ_ONCE(pct->expiry_active)) {
1248 		u64 samples[CPUCLOCK_MAX];
1249 
1250 		proc_sample_cputime_atomic(&sig->cputimer.cputime_atomic,
1251 					   samples);
1252 
1253 		if (task_cputimers_expired(samples, pct))
1254 			return true;
1255 	}
1256 
1257 	if (dl_task(tsk) && tsk->dl.dl_overrun)
1258 		return true;
1259 
1260 	return false;
1261 }
1262 
1263 static void handle_posix_cpu_timers(struct task_struct *tsk);
1264 
1265 #ifdef CONFIG_POSIX_CPU_TIMERS_TASK_WORK
1266 static void posix_cpu_timers_work(struct callback_head *work)
1267 {
1268 	struct posix_cputimers_work *cw = container_of(work, typeof(*cw), work);
1269 
1270 	mutex_lock(&cw->mutex);
1271 	handle_posix_cpu_timers(current);
1272 	mutex_unlock(&cw->mutex);
1273 }
1274 
1275 static inline void posix_cpu_timers_exit_work(void)
1276 {
1277 	/* Canceling the work is only valid for exit() but not for exec() */
1278 	if (!(current->flags & PF_EXITING))
1279 		return;
1280 	/*
1281 	 * current->flags has PF_EXITING set so this can be done lockless and
1282 	 * with interrupts enabled as PF_EXITING prevents the interrupt from
1283 	 * scheduling the work.
1284 	 */
1285 	if (current->posix_cputimers_work.scheduled)
1286 		task_work_cancel(current, &current->posix_cputimers_work.work);
1287 }
1288 
1289 /*
1290  * Invoked from the posix-timer core when a cancel operation failed because
1291  * the timer is marked firing. The caller holds rcu_read_lock(), which
1292  * protects the timer and the task which is expiring it from being freed.
1293  */
1294 static void posix_cpu_timer_wait_running(struct k_itimer *timr)
1295 {
1296 	struct task_struct *tsk = rcu_dereference(timr->it.cpu.handling);
1297 
1298 	/* Has the handling task completed expiry already? */
1299 	if (!tsk)
1300 		return;
1301 
1302 	/* Ensure that the task cannot go away */
1303 	get_task_struct(tsk);
1304 	/* Now drop the RCU protection so the mutex can be locked */
1305 	rcu_read_unlock();
1306 	/* Wait on the expiry mutex */
1307 	mutex_lock(&tsk->posix_cputimers_work.mutex);
1308 	/* Release it immediately again. */
1309 	mutex_unlock(&tsk->posix_cputimers_work.mutex);
1310 	/* Drop the task reference. */
1311 	put_task_struct(tsk);
1312 	/* Relock RCU so the callsite is balanced */
1313 	rcu_read_lock();
1314 }
1315 
1316 static void posix_cpu_timer_wait_running_nsleep(struct k_itimer *timr)
1317 {
1318 	/* Ensure that timr->it.cpu.handling task cannot go away */
1319 	rcu_read_lock();
1320 	spin_unlock_irq(&timr->it_lock);
1321 	posix_cpu_timer_wait_running(timr);
1322 	rcu_read_unlock();
1323 	/* @timr is on stack and is valid */
1324 	spin_lock_irq(&timr->it_lock);
1325 }
1326 
1327 /*
1328  * Clear existing posix CPU timers task work.
1329  */
1330 void clear_posix_cputimers_work(struct task_struct *p)
1331 {
1332 	/*
1333 	 * A copied work entry from the old task is not meaningful, clear it.
1334 	 * N.B. init_task_work will not do this.
1335 	 */
1336 	memset(&p->posix_cputimers_work.work, 0,
1337 	       sizeof(p->posix_cputimers_work.work));
1338 	init_task_work(&p->posix_cputimers_work.work,
1339 		       posix_cpu_timers_work);
1340 	mutex_init(&p->posix_cputimers_work.mutex);
1341 	p->posix_cputimers_work.scheduled = false;
1342 }
1343 
1344 /*
1345  * Initialize posix CPU timers task work in init task. Out of line to
1346  * keep the callback static and to avoid header recursion hell.
1347  */
1348 void __init posix_cputimers_init_work(void)
1349 {
1350 	clear_posix_cputimers_work(current);
1351 }
1352 
1353 /*
1354  * Note: All operations on tsk->posix_cputimer_work.scheduled happen either
1355  * in hard interrupt context or in task context with interrupts
1356  * disabled. Aside of that the writer/reader interaction is always in the
1357  * context of the current task, which means they are strict per CPU.
1358  */
1359 static inline bool posix_cpu_timers_work_scheduled(struct task_struct *tsk)
1360 {
1361 	return tsk->posix_cputimers_work.scheduled;
1362 }
1363 
1364 static inline void __run_posix_cpu_timers(struct task_struct *tsk)
1365 {
1366 	if (WARN_ON_ONCE(tsk->posix_cputimers_work.scheduled))
1367 		return;
1368 
1369 	/* Schedule task work to actually expire the timers */
1370 	tsk->posix_cputimers_work.scheduled = true;
1371 	task_work_add(tsk, &tsk->posix_cputimers_work.work, TWA_RESUME);
1372 }
1373 
1374 static inline bool posix_cpu_timers_enable_work(struct task_struct *tsk,
1375 						unsigned long start)
1376 {
1377 	bool ret = true;
1378 
1379 	/*
1380 	 * On !RT kernels interrupts are disabled while collecting expired
1381 	 * timers, so no tick can happen and the fast path check can be
1382 	 * reenabled without further checks.
1383 	 */
1384 	if (!IS_ENABLED(CONFIG_PREEMPT_RT)) {
1385 		tsk->posix_cputimers_work.scheduled = false;
1386 		return true;
1387 	}
1388 
1389 	/*
1390 	 * On RT enabled kernels ticks can happen while the expired timers
1391 	 * are collected under sighand lock. But any tick which observes
1392 	 * the CPUTIMERS_WORK_SCHEDULED bit set, does not run the fastpath
1393 	 * checks. So reenabling the tick work has do be done carefully:
1394 	 *
1395 	 * Disable interrupts and run the fast path check if jiffies have
1396 	 * advanced since the collecting of expired timers started. If
1397 	 * jiffies have not advanced or the fast path check did not find
1398 	 * newly expired timers, reenable the fast path check in the timer
1399 	 * interrupt. If there are newly expired timers, return false and
1400 	 * let the collection loop repeat.
1401 	 */
1402 	local_irq_disable();
1403 	if (start != jiffies && fastpath_timer_check(tsk))
1404 		ret = false;
1405 	else
1406 		tsk->posix_cputimers_work.scheduled = false;
1407 	local_irq_enable();
1408 
1409 	return ret;
1410 }
1411 #else /* CONFIG_POSIX_CPU_TIMERS_TASK_WORK */
1412 static inline void __run_posix_cpu_timers(struct task_struct *tsk)
1413 {
1414 	lockdep_posixtimer_enter();
1415 	handle_posix_cpu_timers(tsk);
1416 	lockdep_posixtimer_exit();
1417 }
1418 
1419 static inline void posix_cpu_timers_exit_work(void) { }
1420 
1421 static void posix_cpu_timer_wait_running(struct k_itimer *timr)
1422 {
1423 	cpu_relax();
1424 }
1425 
1426 static void posix_cpu_timer_wait_running_nsleep(struct k_itimer *timr)
1427 {
1428 	spin_unlock_irq(&timr->it_lock);
1429 	cpu_relax();
1430 	spin_lock_irq(&timr->it_lock);
1431 }
1432 
1433 static inline bool posix_cpu_timers_work_scheduled(struct task_struct *tsk)
1434 {
1435 	return false;
1436 }
1437 
1438 static inline bool posix_cpu_timers_enable_work(struct task_struct *tsk,
1439 						unsigned long start)
1440 {
1441 	return true;
1442 }
1443 #endif /* CONFIG_POSIX_CPU_TIMERS_TASK_WORK */
1444 
1445 static void handle_posix_cpu_timers(struct task_struct *tsk)
1446 {
1447 	struct k_itimer *timer, *next;
1448 	unsigned long flags, start;
1449 	LIST_HEAD(firing);
1450 
1451 	/*
1452 	 * tsk is current and ->sighand is stable, see the
1453 	 * tsk->exit_state check in run_posix_cpu_timers()
1454 	 */
1455 	spin_lock_irqsave(&tsk->sighand->siglock, flags);
1456 
1457 	do {
1458 		/*
1459 		 * On RT locking sighand lock does not disable interrupts,
1460 		 * so this needs to be careful vs. ticks. Store the current
1461 		 * jiffies value.
1462 		 */
1463 		start = READ_ONCE(jiffies);
1464 		barrier();
1465 
1466 		/*
1467 		 * Here we take off tsk->signal->cpu_timers[N] and
1468 		 * tsk->cpu_timers[N] all the timers that are firing, and
1469 		 * put them on the firing list.
1470 		 */
1471 		check_thread_timers(tsk, &firing);
1472 
1473 		check_process_timers(tsk, &firing);
1474 
1475 		/*
1476 		 * The above timer checks have updated the expiry cache and
1477 		 * because nothing can have queued or modified timers after
1478 		 * sighand lock was taken above it is guaranteed to be
1479 		 * consistent. So the next timer interrupt fastpath check
1480 		 * will find valid data.
1481 		 *
1482 		 * If timer expiry runs in the timer interrupt context then
1483 		 * the loop is not relevant as timers will be directly
1484 		 * expired in interrupt context. The stub function below
1485 		 * returns always true which allows the compiler to
1486 		 * optimize the loop out.
1487 		 *
1488 		 * If timer expiry is deferred to task work context then
1489 		 * the following rules apply:
1490 		 *
1491 		 * - On !RT kernels no tick can have happened on this CPU
1492 		 *   after sighand lock was acquired because interrupts are
1493 		 *   disabled. So reenabling task work before dropping
1494 		 *   sighand lock and reenabling interrupts is race free.
1495 		 *
1496 		 * - On RT kernels ticks might have happened but the tick
1497 		 *   work ignored posix CPU timer handling because the
1498 		 *   CPUTIMERS_WORK_SCHEDULED bit is set. Reenabling work
1499 		 *   must be done very carefully including a check whether
1500 		 *   ticks have happened since the start of the timer
1501 		 *   expiry checks. posix_cpu_timers_enable_work() takes
1502 		 *   care of that and eventually lets the expiry checks
1503 		 *   run again.
1504 		 */
1505 	} while (!posix_cpu_timers_enable_work(tsk, start));
1506 
1507 	/*
1508 	 * We must release sighand lock before taking any timer's lock.
1509 	 * There is a potential race with timer deletion here, as the
1510 	 * siglock now protects our private firing list.  We have set
1511 	 * the firing flag in each timer, so that a deletion attempt
1512 	 * that gets the timer lock before we do will give it up and
1513 	 * spin until we've taken care of that timer below.
1514 	 */
1515 	spin_unlock_irqrestore(&tsk->sighand->siglock, flags);
1516 
1517 	/*
1518 	 * Now that all the timers on our list have the firing flag,
1519 	 * no one will touch their list entries but us.  We'll take
1520 	 * each timer's lock before clearing its firing flag, so no
1521 	 * timer call will interfere.
1522 	 */
1523 	list_for_each_entry_safe(timer, next, &firing, it.cpu.elist) {
1524 		bool cpu_firing;
1525 
1526 		/*
1527 		 * spin_lock() is sufficient here even independent of the
1528 		 * expiry context. If expiry happens in hard interrupt
1529 		 * context it's obvious. For task work context it's safe
1530 		 * because all other operations on timer::it_lock happen in
1531 		 * task context (syscall or exit).
1532 		 */
1533 		spin_lock(&timer->it_lock);
1534 		list_del_init(&timer->it.cpu.elist);
1535 		cpu_firing = timer->it.cpu.firing;
1536 		timer->it.cpu.firing = false;
1537 		/*
1538 		 * If the firing flag is cleared then this raced with a
1539 		 * timer rearm/delete operation. So don't generate an
1540 		 * event.
1541 		 */
1542 		if (likely(cpu_firing))
1543 			cpu_timer_fire(timer);
1544 		/* See posix_cpu_timer_wait_running() */
1545 		rcu_assign_pointer(timer->it.cpu.handling, NULL);
1546 		spin_unlock(&timer->it_lock);
1547 	}
1548 }
1549 
1550 /*
1551  * This is called from the timer interrupt handler.  The irq handler has
1552  * already updated our counts.  We need to check if any timers fire now.
1553  * Interrupts are disabled.
1554  */
1555 void run_posix_cpu_timers(void)
1556 {
1557 	struct task_struct *tsk = current;
1558 
1559 	lockdep_assert_irqs_disabled();
1560 
1561 	/*
1562 	 * Ensure that release_task(tsk) can't happen while
1563 	 * handle_posix_cpu_timers() is running. Otherwise, a concurrent
1564 	 * posix_cpu_timer_del() may fail to lock_task_sighand(tsk) and
1565 	 * miss timer->it.cpu.firing != 0.
1566 	 */
1567 	if (tsk->flags & PF_EXITING)
1568 		return;
1569 
1570 	/*
1571 	 * If the actual expiry is deferred to task work context and the
1572 	 * work is already scheduled there is no point to do anything here.
1573 	 */
1574 	if (posix_cpu_timers_work_scheduled(tsk))
1575 		return;
1576 
1577 	/*
1578 	 * The fast path checks that there are no expired thread or thread
1579 	 * group timers.  If that's so, just return.
1580 	 */
1581 	if (!fastpath_timer_check(tsk))
1582 		return;
1583 
1584 	__run_posix_cpu_timers(tsk);
1585 }
1586 
1587 /*
1588  * Set one of the process-wide special case CPU timers or RLIMIT_CPU.
1589  * The tsk->sighand->siglock must be held by the caller.
1590  */
1591 void set_process_cpu_timer(struct task_struct *tsk, unsigned int clkid,
1592 			   u64 *newval, u64 *oldval)
1593 {
1594 	u64 now, *nextevt;
1595 
1596 	if (WARN_ON_ONCE(clkid >= CPUCLOCK_SCHED))
1597 		return;
1598 
1599 	nextevt = &tsk->signal->posix_cputimers.bases[clkid].nextevt;
1600 	now = cpu_clock_sample_group(clkid, tsk, true);
1601 
1602 	if (oldval) {
1603 		/*
1604 		 * We are setting itimer. The *oldval is absolute and we update
1605 		 * it to be relative, *newval argument is relative and we update
1606 		 * it to be absolute.
1607 		 */
1608 		if (*oldval) {
1609 			if (*oldval <= now) {
1610 				/* Just about to fire. */
1611 				*oldval = TICK_NSEC;
1612 			} else {
1613 				*oldval -= now;
1614 			}
1615 		}
1616 
1617 		if (*newval)
1618 			*newval += now;
1619 	}
1620 
1621 	/*
1622 	 * Update expiration cache if this is the earliest timer. CPUCLOCK_PROF
1623 	 * expiry cache is also used by RLIMIT_CPU!.
1624 	 */
1625 	if (*newval < *nextevt)
1626 		*nextevt = *newval;
1627 
1628 	tick_dep_set_signal(tsk, TICK_DEP_BIT_POSIX_TIMER);
1629 }
1630 
1631 static int do_cpu_nanosleep(const clockid_t which_clock, int flags,
1632 			    const struct timespec64 *rqtp)
1633 {
1634 	struct itimerspec64 it;
1635 	struct k_itimer timer;
1636 	u64 expires;
1637 	int error;
1638 
1639 	/*
1640 	 * Set up a temporary timer and then wait for it to go off.
1641 	 */
1642 	memset(&timer, 0, sizeof timer);
1643 	spin_lock_init(&timer.it_lock);
1644 	timer.it_clock = which_clock;
1645 	timer.it_overrun = -1;
1646 	error = posix_cpu_timer_create(&timer);
1647 	timer.it_process = current;
1648 	timer.it.cpu.nanosleep = true;
1649 
1650 	if (!error) {
1651 		static struct itimerspec64 zero_it;
1652 		struct restart_block *restart;
1653 
1654 		memset(&it, 0, sizeof(it));
1655 		it.it_value = *rqtp;
1656 
1657 		spin_lock_irq(&timer.it_lock);
1658 		error = posix_cpu_timer_set(&timer, flags, &it, NULL);
1659 		if (error) {
1660 			posix_cpu_timer_del(&timer);
1661 			spin_unlock_irq(&timer.it_lock);
1662 			return error;
1663 		}
1664 
1665 		while (!signal_pending(current)) {
1666 			if (!cpu_timer_getexpires(&timer.it.cpu)) {
1667 				/*
1668 				 * Our timer fired and was reset, below
1669 				 * deletion can not fail.
1670 				 */
1671 				posix_cpu_timer_del(&timer);
1672 				spin_unlock_irq(&timer.it_lock);
1673 				return 0;
1674 			}
1675 
1676 			/*
1677 			 * Block until cpu_timer_fire (or a signal) wakes us.
1678 			 */
1679 			__set_current_state(TASK_INTERRUPTIBLE);
1680 			spin_unlock_irq(&timer.it_lock);
1681 			schedule();
1682 			spin_lock_irq(&timer.it_lock);
1683 		}
1684 
1685 		/*
1686 		 * We were interrupted by a signal.
1687 		 */
1688 		expires = cpu_timer_getexpires(&timer.it.cpu);
1689 		error = posix_cpu_timer_set(&timer, 0, &zero_it, &it);
1690 		if (!error) {
1691 			/* Timer is now unarmed, deletion can not fail. */
1692 			posix_cpu_timer_del(&timer);
1693 		} else {
1694 			while (error == TIMER_RETRY) {
1695 				posix_cpu_timer_wait_running_nsleep(&timer);
1696 				error = posix_cpu_timer_del(&timer);
1697 			}
1698 		}
1699 
1700 		spin_unlock_irq(&timer.it_lock);
1701 
1702 		if ((it.it_value.tv_sec | it.it_value.tv_nsec) == 0) {
1703 			/*
1704 			 * It actually did fire already.
1705 			 */
1706 			return 0;
1707 		}
1708 
1709 		error = -ERESTART_RESTARTBLOCK;
1710 		/*
1711 		 * Report back to the user the time still remaining.
1712 		 */
1713 		restart = &current->restart_block;
1714 		restart->nanosleep.expires = ns_to_ktime(expires);
1715 		if (restart->nanosleep.type != TT_NONE)
1716 			error = nanosleep_copyout(restart, &it.it_value);
1717 	}
1718 
1719 	return error;
1720 }
1721 
1722 static long posix_cpu_nsleep_restart(struct restart_block *restart_block);
1723 
1724 static int posix_cpu_nsleep(const clockid_t which_clock, int flags,
1725 			    const struct timespec64 *rqtp)
1726 {
1727 	struct restart_block *restart_block = &current->restart_block;
1728 	int error;
1729 
1730 	/*
1731 	 * Diagnose required errors first.
1732 	 */
1733 	if (CPUCLOCK_PERTHREAD(which_clock) &&
1734 	    (CPUCLOCK_PID(which_clock) == 0 ||
1735 	     CPUCLOCK_PID(which_clock) == task_pid_vnr(current)))
1736 		return -EINVAL;
1737 
1738 	error = do_cpu_nanosleep(which_clock, flags, rqtp);
1739 
1740 	if (error == -ERESTART_RESTARTBLOCK) {
1741 
1742 		if (flags & TIMER_ABSTIME)
1743 			return -ERESTARTNOHAND;
1744 
1745 		restart_block->nanosleep.clockid = which_clock;
1746 		set_restart_fn(restart_block, posix_cpu_nsleep_restart);
1747 	}
1748 	return error;
1749 }
1750 
1751 static long posix_cpu_nsleep_restart(struct restart_block *restart_block)
1752 {
1753 	clockid_t which_clock = restart_block->nanosleep.clockid;
1754 	struct timespec64 t;
1755 
1756 	t = ktime_to_timespec64(restart_block->nanosleep.expires);
1757 
1758 	return do_cpu_nanosleep(which_clock, TIMER_ABSTIME, &t);
1759 }
1760 
1761 #define PROCESS_CLOCK	make_process_cpuclock(0, CPUCLOCK_SCHED)
1762 #define THREAD_CLOCK	make_thread_cpuclock(0, CPUCLOCK_SCHED)
1763 
1764 static int process_cpu_clock_getres(const clockid_t which_clock,
1765 				    struct timespec64 *tp)
1766 {
1767 	return posix_cpu_clock_getres(PROCESS_CLOCK, tp);
1768 }
1769 static int process_cpu_clock_get(const clockid_t which_clock,
1770 				 struct timespec64 *tp)
1771 {
1772 	return posix_cpu_clock_get(PROCESS_CLOCK, tp);
1773 }
1774 static int process_cpu_timer_create(struct k_itimer *timer)
1775 {
1776 	timer->it_clock = PROCESS_CLOCK;
1777 	return posix_cpu_timer_create(timer);
1778 }
1779 static int process_cpu_nsleep(const clockid_t which_clock, int flags,
1780 			      const struct timespec64 *rqtp)
1781 {
1782 	return posix_cpu_nsleep(PROCESS_CLOCK, flags, rqtp);
1783 }
1784 static int thread_cpu_clock_getres(const clockid_t which_clock,
1785 				   struct timespec64 *tp)
1786 {
1787 	return posix_cpu_clock_getres(THREAD_CLOCK, tp);
1788 }
1789 static int thread_cpu_clock_get(const clockid_t which_clock,
1790 				struct timespec64 *tp)
1791 {
1792 	return posix_cpu_clock_get(THREAD_CLOCK, tp);
1793 }
1794 static int thread_cpu_timer_create(struct k_itimer *timer)
1795 {
1796 	timer->it_clock = THREAD_CLOCK;
1797 	return posix_cpu_timer_create(timer);
1798 }
1799 
1800 const struct k_clock clock_posix_cpu = {
1801 	.clock_getres		= posix_cpu_clock_getres,
1802 	.clock_set		= posix_cpu_clock_set,
1803 	.clock_get_timespec	= posix_cpu_clock_get,
1804 	.timer_create		= posix_cpu_timer_create,
1805 	.nsleep			= posix_cpu_nsleep,
1806 	.timer_set		= posix_cpu_timer_set,
1807 	.timer_del		= posix_cpu_timer_del,
1808 	.timer_get		= posix_cpu_timer_get,
1809 	.timer_rearm		= posix_cpu_timer_rearm,
1810 	.timer_wait_running	= posix_cpu_timer_wait_running,
1811 };
1812 
1813 const struct k_clock clock_process = {
1814 	.clock_getres		= process_cpu_clock_getres,
1815 	.clock_get_timespec	= process_cpu_clock_get,
1816 	.timer_create		= process_cpu_timer_create,
1817 	.nsleep			= process_cpu_nsleep,
1818 };
1819 
1820 const struct k_clock clock_thread = {
1821 	.clock_getres		= thread_cpu_clock_getres,
1822 	.clock_get_timespec	= thread_cpu_clock_get,
1823 	.timer_create		= thread_cpu_timer_create,
1824 };
1825