1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2015 Anton Ivanov (aivanov@{brocade.com,kot-begemot.co.uk})
4 * Copyright (C) 2015 Thomas Meyer (thomas@m3y3r.de)
5 * Copyright (C) 2012-2014 Cisco Systems
6 * Copyright (C) 2000 - 2007 Jeff Dike (jdike@{addtoit,linux.intel}.com)
7 * Copyright (C) 2019 Intel Corporation
10 #include <linux/clockchips.h>
11 #include <linux/init.h>
12 #include <linux/interrupt.h>
13 #include <linux/jiffies.h>
15 #include <linux/sched.h>
16 #include <linux/spinlock.h>
17 #include <linux/threads.h>
19 #include <asm/param.h>
20 #include <kern_util.h>
22 #include <linux/time-internal.h>
23 #include <linux/um_timetravel.h>
24 #include <shared/init.h>
26 #ifdef CONFIG_UML_TIME_TRAVEL_SUPPORT
27 enum time_travel_mode time_travel_mode;
28 EXPORT_SYMBOL_GPL(time_travel_mode);
30 static bool time_travel_start_set;
31 static unsigned long long time_travel_start;
32 static unsigned long long time_travel_time;
33 static LIST_HEAD(time_travel_events);
34 static LIST_HEAD(time_travel_irqs);
35 static unsigned long long time_travel_timer_interval;
36 static unsigned long long time_travel_next_event;
37 static struct time_travel_event time_travel_timer_event;
38 static int time_travel_ext_fd = -1;
39 static unsigned int time_travel_ext_waiting;
40 static bool time_travel_ext_prev_request_valid;
41 static unsigned long long time_travel_ext_prev_request;
42 static bool time_travel_ext_free_until_valid;
43 static unsigned long long time_travel_ext_free_until;
45 static void time_travel_set_time(unsigned long long ns)
47 if (unlikely(ns < time_travel_time))
48 panic("time-travel: time goes backwards %lld -> %lld\n",
49 time_travel_time, ns);
50 else if (unlikely(ns >= S64_MAX))
51 panic("The system was going to sleep forever, aborting");
53 time_travel_time = ns;
56 enum time_travel_message_handling {
62 static void time_travel_handle_message(struct um_timetravel_msg *msg,
63 enum time_travel_message_handling mode)
65 struct um_timetravel_msg resp = {
66 .op = UM_TIMETRAVEL_ACK,
71 * We can't unlock here, but interrupt signals with a timetravel_handler
72 * (see um_request_irq_tt) get to the timetravel_handler anyway.
74 if (mode != TTMH_READ) {
75 BUG_ON(mode == TTMH_IDLE && !irqs_disabled());
77 while (os_poll(1, &time_travel_ext_fd) != 0) {
82 ret = os_read_file(time_travel_ext_fd, msg, sizeof(*msg));
85 panic("time-travel external link is broken\n");
86 if (ret != sizeof(*msg))
87 panic("invalid time-travel message - %d bytes\n", ret);
91 WARN_ONCE(1, "time-travel: unexpected message %lld\n",
92 (unsigned long long)msg->op);
94 case UM_TIMETRAVEL_ACK:
96 case UM_TIMETRAVEL_RUN:
97 time_travel_set_time(msg->time);
99 case UM_TIMETRAVEL_FREE_UNTIL:
100 time_travel_ext_free_until_valid = true;
101 time_travel_ext_free_until = msg->time;
106 os_write_file(time_travel_ext_fd, &resp, sizeof(resp));
109 static u64 time_travel_ext_req(u32 op, u64 time)
113 struct um_timetravel_msg msg = {
120 * We need to block even the timetravel handlers of SIGIO here and
121 * only restore their use when we got the ACK - otherwise we may
122 * (will) get interrupted by that, try to queue the IRQ for future
123 * processing and thus send another request while we're still waiting
124 * for an ACK, but the peer doesn't know we got interrupted and will
125 * send the ACKs in the same order as the message, but we'd need to
126 * see them in the opposite order ...
128 * This wouldn't matter *too* much, but some ACKs carry the
129 * current time (for UM_TIMETRAVEL_GET) and getting another
130 * ACK without a time would confuse us a lot!
132 * The sequence number assignment that happens here lets us
133 * debug such message handling issues more easily.
135 block_signals_hard();
136 os_write_file(time_travel_ext_fd, &msg, sizeof(msg));
138 while (msg.op != UM_TIMETRAVEL_ACK)
139 time_travel_handle_message(&msg, TTMH_READ);
142 panic("time-travel: ACK message has different seqno! op=%d, seq=%d != %d time=%lld\n",
143 msg.op, msg.seq, mseq, msg.time);
145 if (op == UM_TIMETRAVEL_GET)
146 time_travel_set_time(msg.time);
147 unblock_signals_hard();
152 void __time_travel_wait_readable(int fd)
154 int fds[2] = { fd, time_travel_ext_fd };
157 if (time_travel_mode != TT_MODE_EXTERNAL)
160 while ((ret = os_poll(2, fds))) {
161 struct um_timetravel_msg msg;
164 time_travel_handle_message(&msg, TTMH_READ);
167 EXPORT_SYMBOL_GPL(__time_travel_wait_readable);
169 static void time_travel_ext_update_request(unsigned long long time)
171 if (time_travel_mode != TT_MODE_EXTERNAL)
174 /* asked for exactly this time previously */
175 if (time_travel_ext_prev_request_valid &&
176 time == time_travel_ext_prev_request)
180 * if we're running and are allowed to run past the request
181 * then we don't need to update it either
183 if (!time_travel_ext_waiting && time_travel_ext_free_until_valid &&
184 time < time_travel_ext_free_until)
187 time_travel_ext_prev_request = time;
188 time_travel_ext_prev_request_valid = true;
189 time_travel_ext_req(UM_TIMETRAVEL_REQUEST, time);
192 void __time_travel_propagate_time(void)
194 static unsigned long long last_propagated;
196 if (last_propagated == time_travel_time)
199 time_travel_ext_req(UM_TIMETRAVEL_UPDATE, time_travel_time);
200 last_propagated = time_travel_time;
202 EXPORT_SYMBOL_GPL(__time_travel_propagate_time);
204 /* returns true if we must do a wait to the simtime device */
205 static bool time_travel_ext_request(unsigned long long time)
208 * If we received an external sync point ("free until") then we
209 * don't have to request/wait for anything until then, unless
210 * we're already waiting.
212 if (!time_travel_ext_waiting && time_travel_ext_free_until_valid &&
213 time < time_travel_ext_free_until)
216 time_travel_ext_update_request(time);
220 static void time_travel_ext_wait(bool idle)
222 struct um_timetravel_msg msg = {
223 .op = UM_TIMETRAVEL_ACK,
226 time_travel_ext_prev_request_valid = false;
227 time_travel_ext_free_until_valid = false;
228 time_travel_ext_waiting++;
230 time_travel_ext_req(UM_TIMETRAVEL_WAIT, -1);
233 * Here we are deep in the idle loop, so we have to break out of the
234 * kernel abstraction in a sense and implement this in terms of the
235 * UML system waiting on the VQ interrupt while sleeping, when we get
236 * the signal it'll call time_travel_ext_vq_notify_done() completing the
239 while (msg.op != UM_TIMETRAVEL_RUN)
240 time_travel_handle_message(&msg, idle ? TTMH_IDLE : TTMH_POLL);
242 time_travel_ext_waiting--;
244 /* we might request more stuff while polling - reset when we run */
245 time_travel_ext_prev_request_valid = false;
248 static void time_travel_ext_get_time(void)
250 time_travel_ext_req(UM_TIMETRAVEL_GET, -1);
253 static void __time_travel_update_time(unsigned long long ns, bool idle)
255 if (time_travel_mode == TT_MODE_EXTERNAL && time_travel_ext_request(ns))
256 time_travel_ext_wait(idle);
258 time_travel_set_time(ns);
261 static struct time_travel_event *time_travel_first_event(void)
263 return list_first_entry_or_null(&time_travel_events,
264 struct time_travel_event,
268 static void __time_travel_add_event(struct time_travel_event *e,
269 unsigned long long time)
271 struct time_travel_event *tmp;
272 bool inserted = false;
281 local_irq_save(flags);
282 list_for_each_entry(tmp, &time_travel_events, list) {
284 * Add the new entry before one with higher time,
285 * or if they're equal and both on stack, because
286 * in that case we need to unwind the stack in the
287 * right order, and the later event (timer sleep
288 * or such) must be dequeued first.
290 if ((tmp->time > e->time) ||
291 (tmp->time == e->time && tmp->onstack && e->onstack)) {
292 list_add_tail(&e->list, &tmp->list);
299 list_add_tail(&e->list, &time_travel_events);
301 tmp = time_travel_first_event();
302 time_travel_ext_update_request(tmp->time);
303 time_travel_next_event = tmp->time;
304 local_irq_restore(flags);
307 static void time_travel_add_event(struct time_travel_event *e,
308 unsigned long long time)
313 __time_travel_add_event(e, time);
316 void time_travel_add_event_rel(struct time_travel_event *e,
317 unsigned long long delay_ns)
319 time_travel_add_event(e, time_travel_time + delay_ns);
322 void time_travel_periodic_timer(struct time_travel_event *e)
324 time_travel_add_event(&time_travel_timer_event,
325 time_travel_time + time_travel_timer_interval);
329 void deliver_time_travel_irqs(void)
331 struct time_travel_event *e;
335 * Don't do anything for most cases. Note that because here we have
336 * to disable IRQs (and re-enable later) we'll actually recurse at
337 * the end of the function, so this is strictly necessary.
339 if (likely(list_empty(&time_travel_irqs)))
342 local_irq_save(flags);
344 while ((e = list_first_entry_or_null(&time_travel_irqs,
345 struct time_travel_event,
352 local_irq_restore(flags);
355 static void time_travel_deliver_event(struct time_travel_event *e)
357 if (e == &time_travel_timer_event) {
359 * deliver_alarm() does the irq_enter/irq_exit
360 * by itself, so must handle it specially here
363 } else if (irqs_disabled()) {
364 list_add_tail(&e->list, &time_travel_irqs);
366 * set pending again, it was set to false when the
367 * event was deleted from the original list, but
368 * now it's still pending until we deliver the IRQ.
374 local_irq_save(flags);
378 local_irq_restore(flags);
382 bool time_travel_del_event(struct time_travel_event *e)
388 local_irq_save(flags);
391 local_irq_restore(flags);
395 static void time_travel_update_time(unsigned long long next, bool idle)
397 struct time_travel_event ne = {
400 struct time_travel_event *e;
401 bool finished = idle;
403 /* add it without a handler - we deal with that specifically below */
404 __time_travel_add_event(&ne, next);
407 e = time_travel_first_event();
410 __time_travel_update_time(e->time, idle);
412 /* new events may have been inserted while we were waiting */
413 if (e == time_travel_first_event()) {
414 BUG_ON(!time_travel_del_event(e));
415 BUG_ON(time_travel_time != e->time);
421 panic("On-stack event dequeued outside of the stack! time=%lld, event time=%lld, event=%pS\n",
422 time_travel_time, e->time, e);
423 time_travel_deliver_event(e);
427 e = time_travel_first_event();
429 time_travel_ext_update_request(e->time);
430 } while (ne.pending && !finished);
432 time_travel_del_event(&ne);
435 static void time_travel_update_time_rel(unsigned long long offs)
440 * Disable interrupts before calculating the new time so
441 * that a real timer interrupt (signal) can't happen at
442 * a bad time e.g. after we read time_travel_time but
443 * before we've completed updating the time.
445 local_irq_save(flags);
446 time_travel_update_time(time_travel_time + offs, false);
447 local_irq_restore(flags);
450 void time_travel_ndelay(unsigned long nsec)
453 * Not strictly needed to use _rel() version since this is
454 * only used in INFCPU/EXT modes, but it doesn't hurt and
455 * is more readable too.
457 time_travel_update_time_rel(nsec);
459 EXPORT_SYMBOL(time_travel_ndelay);
461 void time_travel_add_irq_event(struct time_travel_event *e)
463 BUG_ON(time_travel_mode != TT_MODE_EXTERNAL);
465 time_travel_ext_get_time();
467 * We could model interrupt latency here, for now just
468 * don't have any latency at all and request the exact
469 * same time (again) to run the interrupt...
471 time_travel_add_event(e, time_travel_time);
473 EXPORT_SYMBOL_GPL(time_travel_add_irq_event);
475 static void time_travel_oneshot_timer(struct time_travel_event *e)
480 void time_travel_sleep(void)
483 * Wait "forever" (using S64_MAX because there are some potential
484 * wrapping issues, especially with the current TT_MODE_EXTERNAL
485 * controller application.
487 unsigned long long next = S64_MAX;
489 if (time_travel_mode == TT_MODE_BASIC)
492 time_travel_update_time(next, true);
494 if (time_travel_mode == TT_MODE_BASIC &&
495 time_travel_timer_event.pending) {
496 if (time_travel_timer_event.fn == time_travel_periodic_timer) {
498 * This is somewhat wrong - we should get the first
499 * one sooner like the os_timer_one_shot() below...
501 os_timer_set_interval(time_travel_timer_interval);
503 os_timer_one_shot(time_travel_timer_event.time - next);
508 static void time_travel_handle_real_alarm(void)
510 time_travel_set_time(time_travel_next_event);
512 time_travel_del_event(&time_travel_timer_event);
514 if (time_travel_timer_event.fn == time_travel_periodic_timer)
515 time_travel_add_event(&time_travel_timer_event,
517 time_travel_timer_interval);
520 static void time_travel_set_interval(unsigned long long interval)
522 time_travel_timer_interval = interval;
525 static int time_travel_connect_external(const char *socket)
528 unsigned long long id = (unsigned long long)-1;
531 if ((sep = strchr(socket, ':'))) {
533 if (sep - socket > sizeof(buf) - 1)
536 memcpy(buf, socket, sep - socket);
537 if (kstrtoull(buf, 0, &id)) {
539 panic("time-travel: invalid external ID in string '%s'\n",
547 rc = os_connect_socket(socket);
549 panic("time-travel: failed to connect to external socket %s\n",
554 time_travel_ext_fd = rc;
556 time_travel_ext_req(UM_TIMETRAVEL_START, id);
561 static void time_travel_set_start(void)
563 if (time_travel_start_set)
566 switch (time_travel_mode) {
567 case TT_MODE_EXTERNAL:
568 time_travel_start = time_travel_ext_req(UM_TIMETRAVEL_GET_TOD, -1);
569 /* controller gave us the *current* time, so adjust by that */
570 time_travel_ext_get_time();
571 time_travel_start -= time_travel_time;
575 if (!time_travel_start_set)
576 time_travel_start = os_persistent_clock_emulation();
579 /* we just read the host clock with os_persistent_clock_emulation() */
583 time_travel_start_set = true;
585 #else /* CONFIG_UML_TIME_TRAVEL_SUPPORT */
586 #define time_travel_start_set 0
587 #define time_travel_start 0
588 #define time_travel_time 0
589 #define time_travel_ext_waiting 0
591 static inline void time_travel_update_time(unsigned long long ns, bool idle)
595 static inline void time_travel_update_time_rel(unsigned long long offs)
599 static inline void time_travel_handle_real_alarm(void)
603 static void time_travel_set_interval(unsigned long long interval)
607 static inline void time_travel_set_start(void)
611 /* fail link if this actually gets used */
612 extern u64 time_travel_ext_req(u32 op, u64 time);
614 /* these are empty macros so the struct/fn need not exist */
615 #define time_travel_add_event(e, time) do { } while (0)
616 /* externally not usable - redefine here so we can */
617 #undef time_travel_del_event
618 #define time_travel_del_event(e) do { } while (0)
621 void timer_handler(int sig, struct siginfo *unused_si, struct uml_pt_regs *regs)
626 * In basic time-travel mode we still get real interrupts
627 * (signals) but since we don't read time from the OS, we
628 * must update the simulated time here to the expiry when
630 * This is not the case in inf-cpu mode, since there we
631 * never get any real signals from the OS.
633 if (time_travel_mode == TT_MODE_BASIC)
634 time_travel_handle_real_alarm();
636 local_irq_save(flags);
637 do_IRQ(TIMER_IRQ, regs);
638 local_irq_restore(flags);
641 static int itimer_shutdown(struct clock_event_device *evt)
643 if (time_travel_mode != TT_MODE_OFF)
644 time_travel_del_event(&time_travel_timer_event);
646 if (time_travel_mode != TT_MODE_INFCPU &&
647 time_travel_mode != TT_MODE_EXTERNAL)
653 static int itimer_set_periodic(struct clock_event_device *evt)
655 unsigned long long interval = NSEC_PER_SEC / HZ;
657 if (time_travel_mode != TT_MODE_OFF) {
658 time_travel_del_event(&time_travel_timer_event);
659 time_travel_set_event_fn(&time_travel_timer_event,
660 time_travel_periodic_timer);
661 time_travel_set_interval(interval);
662 time_travel_add_event(&time_travel_timer_event,
663 time_travel_time + interval);
666 if (time_travel_mode != TT_MODE_INFCPU &&
667 time_travel_mode != TT_MODE_EXTERNAL)
668 os_timer_set_interval(interval);
673 static int itimer_next_event(unsigned long delta,
674 struct clock_event_device *evt)
678 if (time_travel_mode != TT_MODE_OFF) {
679 time_travel_del_event(&time_travel_timer_event);
680 time_travel_set_event_fn(&time_travel_timer_event,
681 time_travel_oneshot_timer);
682 time_travel_add_event(&time_travel_timer_event,
683 time_travel_time + delta);
686 if (time_travel_mode != TT_MODE_INFCPU &&
687 time_travel_mode != TT_MODE_EXTERNAL)
688 return os_timer_one_shot(delta);
693 static int itimer_one_shot(struct clock_event_device *evt)
695 return itimer_next_event(0, evt);
698 static struct clock_event_device timer_clockevent = {
699 .name = "posix-timer",
701 .cpumask = cpu_possible_mask,
702 .features = CLOCK_EVT_FEAT_PERIODIC |
703 CLOCK_EVT_FEAT_ONESHOT,
704 .set_state_shutdown = itimer_shutdown,
705 .set_state_periodic = itimer_set_periodic,
706 .set_state_oneshot = itimer_one_shot,
707 .set_next_event = itimer_next_event,
709 .max_delta_ns = 0xffffffff,
710 .max_delta_ticks = 0xffffffff,
711 .min_delta_ns = TIMER_MIN_DELTA,
712 .min_delta_ticks = TIMER_MIN_DELTA, // microsecond resolution should be enough for anyone, same as 640K RAM
717 static irqreturn_t um_timer(int irq, void *dev)
719 if (get_current()->mm != NULL)
721 /* userspace - relay signal, results in correct userspace timers */
722 os_alarm_process(get_current()->mm->context.id.u.pid);
725 (*timer_clockevent.event_handler)(&timer_clockevent);
730 static u64 timer_read(struct clocksource *cs)
732 if (time_travel_mode != TT_MODE_OFF) {
734 * We make reading the timer cost a bit so that we don't get
735 * stuck in loops that expect time to move more than the
736 * exact requested sleep amount, e.g. python's socket server,
737 * see https://bugs.python.org/issue37026.
739 * However, don't do that when we're in interrupt or such as
740 * then we might recurse into our own processing, and get to
741 * even more waiting, and that's not good - it messes up the
742 * "what do I do next" and onstack event we use to know when
743 * to return from time_travel_update_time().
745 if (!irqs_disabled() && !in_interrupt() && !in_softirq() &&
746 !time_travel_ext_waiting)
747 time_travel_update_time_rel(TIMER_MULTIPLIER);
748 return time_travel_time / TIMER_MULTIPLIER;
751 return os_nsecs() / TIMER_MULTIPLIER;
754 static struct clocksource timer_clocksource = {
758 .mask = CLOCKSOURCE_MASK(64),
759 .flags = CLOCK_SOURCE_IS_CONTINUOUS,
762 static void __init um_timer_setup(void)
766 err = request_irq(TIMER_IRQ, um_timer, IRQF_TIMER, "hr timer", NULL);
768 printk(KERN_ERR "register_timer : request_irq failed - "
769 "errno = %d\n", -err);
771 err = os_timer_create();
773 printk(KERN_ERR "creation of timer failed - errno = %d\n", -err);
777 err = clocksource_register_hz(&timer_clocksource, NSEC_PER_SEC/TIMER_MULTIPLIER);
779 printk(KERN_ERR "clocksource_register_hz returned %d\n", err);
782 clockevents_register_device(&timer_clockevent);
785 void read_persistent_clock64(struct timespec64 *ts)
789 time_travel_set_start();
791 if (time_travel_mode != TT_MODE_OFF)
792 nsecs = time_travel_start + time_travel_time;
794 nsecs = os_persistent_clock_emulation();
796 set_normalized_timespec64(ts, nsecs / NSEC_PER_SEC,
797 nsecs % NSEC_PER_SEC);
800 void __init time_init(void)
802 timer_set_signal_handler();
803 late_time_init = um_timer_setup;
806 #ifdef CONFIG_UML_TIME_TRAVEL_SUPPORT
807 unsigned long calibrate_delay_is_known(void)
809 if (time_travel_mode == TT_MODE_INFCPU ||
810 time_travel_mode == TT_MODE_EXTERNAL)
815 int setup_time_travel(char *str)
817 if (strcmp(str, "=inf-cpu") == 0) {
818 time_travel_mode = TT_MODE_INFCPU;
819 timer_clockevent.name = "time-travel-timer-infcpu";
820 timer_clocksource.name = "time-travel-clock";
824 if (strncmp(str, "=ext:", 5) == 0) {
825 time_travel_mode = TT_MODE_EXTERNAL;
826 timer_clockevent.name = "time-travel-timer-external";
827 timer_clocksource.name = "time-travel-clock-external";
828 return time_travel_connect_external(str + 5);
832 time_travel_mode = TT_MODE_BASIC;
833 timer_clockevent.name = "time-travel-timer";
834 timer_clocksource.name = "time-travel-clock";
841 __setup("time-travel", setup_time_travel);
842 __uml_help(setup_time_travel,
844 "This option just enables basic time travel mode, in which the clock/timers\n"
845 "inside the UML instance skip forward when there's nothing to do, rather than\n"
846 "waiting for real time to elapse. However, instance CPU speed is limited by\n"
847 "the real CPU speed, so e.g. a 10ms timer will always fire after ~10ms wall\n"
848 "clock (but quicker when there's nothing to do).\n"
850 "time-travel=inf-cpu\n"
851 "This enables time travel mode with infinite processing power, in which there\n"
852 "are no wall clock timers, and any CPU processing happens - as seen from the\n"
853 "guest - instantly. This can be useful for accurate simulation regardless of\n"
854 "debug overhead, physical CPU speed, etc. but is somewhat dangerous as it can\n"
855 "easily lead to getting stuck (e.g. if anything in the system busy loops).\n"
857 "time-travel=ext:[ID:]/path/to/socket\n"
858 "This enables time travel mode similar to =inf-cpu, except the system will\n"
859 "use the given socket to coordinate with a central scheduler, in order to\n"
860 "have more than one system simultaneously be on simulated time. The virtio\n"
861 "driver code in UML knows about this so you can also simulate networks and\n"
862 "devices using it, assuming the device has the right capabilities.\n"
863 "The optional ID is a 64-bit integer that's sent to the central scheduler.\n");
865 int setup_time_travel_start(char *str)
869 err = kstrtoull(str, 0, &time_travel_start);
873 time_travel_start_set = 1;
877 __setup("time-travel-start", setup_time_travel_start);
878 __uml_help(setup_time_travel_start,
879 "time-travel-start=<seconds>\n"
880 "Configure the UML instance's wall clock to start at this value rather than\n"
881 "the host's wall clock at the time of UML boot.\n");