1*6469ec7bSandvar /* $NetBSD: hvtimesync.c,v 1.3 2022/11/02 18:18:44 andvar Exp $ */
2afdb7e40Snonaka
3afdb7e40Snonaka /*-
4afdb7e40Snonaka * Copyright (c) 2014,2016-2017 Microsoft Corp.
5afdb7e40Snonaka * All rights reserved.
6afdb7e40Snonaka *
7afdb7e40Snonaka * Redistribution and use in source and binary forms, with or without
8afdb7e40Snonaka * modification, are permitted provided that the following conditions
9afdb7e40Snonaka * are met:
10afdb7e40Snonaka * 1. Redistributions of source code must retain the above copyright
11afdb7e40Snonaka * notice unmodified, this list of conditions, and the following
12afdb7e40Snonaka * disclaimer.
13afdb7e40Snonaka * 2. Redistributions in binary form must reproduce the above copyright
14afdb7e40Snonaka * notice, this list of conditions and the following disclaimer in the
15afdb7e40Snonaka * documentation and/or other materials provided with the distribution.
16afdb7e40Snonaka *
17afdb7e40Snonaka * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18afdb7e40Snonaka * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19afdb7e40Snonaka * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20afdb7e40Snonaka * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21afdb7e40Snonaka * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22afdb7e40Snonaka * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23afdb7e40Snonaka * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24afdb7e40Snonaka * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25afdb7e40Snonaka * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26afdb7e40Snonaka * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27afdb7e40Snonaka */
28afdb7e40Snonaka
29afdb7e40Snonaka #include <sys/cdefs.h>
30afdb7e40Snonaka #ifdef __KERNEL_RCSID
31*6469ec7bSandvar __KERNEL_RCSID(0, "$NetBSD: hvtimesync.c,v 1.3 2022/11/02 18:18:44 andvar Exp $");
32afdb7e40Snonaka #endif
33afdb7e40Snonaka #ifdef __FBSDID
34afdb7e40Snonaka __FBSDID("$FreeBSD: head/sys/dev/hyperv/utilities/vmbus_timesync.c 322488 2017-08-14 06:00:50Z sephe $");
35afdb7e40Snonaka #endif
36afdb7e40Snonaka
37afdb7e40Snonaka #include <sys/param.h>
38afdb7e40Snonaka #include <sys/systm.h>
39afdb7e40Snonaka #include <sys/device.h>
40afdb7e40Snonaka #include <sys/module.h>
41afdb7e40Snonaka #include <sys/pmf.h>
42afdb7e40Snonaka #include <sys/sysctl.h>
43afdb7e40Snonaka #include <sys/timetc.h>
44afdb7e40Snonaka
45afdb7e40Snonaka #include <dev/hyperv/vmbusvar.h>
46afdb7e40Snonaka #include <dev/hyperv/vmbusicreg.h>
47afdb7e40Snonaka #include <dev/hyperv/vmbusicvar.h>
48afdb7e40Snonaka
49afdb7e40Snonaka #define VMBUS_TIMESYNC_FWVER_MAJOR 3
50afdb7e40Snonaka #define VMBUS_TIMESYNC_FWVER \
51afdb7e40Snonaka VMBUS_IC_VERSION(VMBUS_TIMESYNC_FWVER_MAJOR, 0)
52afdb7e40Snonaka
53afdb7e40Snonaka #define VMBUS_TIMESYNC_MSGVER_MAJOR 4
54afdb7e40Snonaka #define VMBUS_TIMESYNC_MSGVER \
55afdb7e40Snonaka VMBUS_IC_VERSION(VMBUS_TIMESYNC_MSGVER_MAJOR, 0)
56afdb7e40Snonaka
57afdb7e40Snonaka #define VMBUS_TIMESYNC_MSGVER4(sc) \
58afdb7e40Snonaka VMBUS_ICVER_LE(VMBUS_IC_VERSION(4, 0), (sc)->sc_vmbusic.sc_msgver)
59afdb7e40Snonaka
60afdb7e40Snonaka #define VMBUS_TIMESYNC_DORTT(sc) \
61afdb7e40Snonaka (VMBUS_TIMESYNC_MSGVER4((sc)) && (hyperv_tc64 != NULL))
62afdb7e40Snonaka
63afdb7e40Snonaka static int hvtimesync_match(device_t, cfdata_t, void *);
64afdb7e40Snonaka static void hvtimesync_attach(device_t, device_t, void *);
65afdb7e40Snonaka static int hvtimesync_detach(device_t, int);
66afdb7e40Snonaka
67afdb7e40Snonaka static void hvtimesync_channel_cb(void *);
68afdb7e40Snonaka static int hvtimesync_sysctl_setup(device_t);
69afdb7e40Snonaka
70afdb7e40Snonaka struct hvtimesync_softc {
71afdb7e40Snonaka struct vmbusic_softc sc_vmbusic;
72afdb7e40Snonaka };
73afdb7e40Snonaka
74afdb7e40Snonaka CFATTACH_DECL_NEW(hvtimesync, sizeof(struct hvtimesync_softc),
75afdb7e40Snonaka hvtimesync_match, hvtimesync_attach, hvtimesync_detach, NULL);
76afdb7e40Snonaka
77afdb7e40Snonaka static int hvtimesync_ignore_sync;
78*6469ec7bSandvar static int hvtimesync_sample_verbose;
79afdb7e40Snonaka static int hvtimesync_sample_thresh = -1;
80afdb7e40Snonaka
81afdb7e40Snonaka static int
hvtimesync_match(device_t parent,cfdata_t cf,void * aux)82afdb7e40Snonaka hvtimesync_match(device_t parent, cfdata_t cf, void *aux)
83afdb7e40Snonaka {
84afdb7e40Snonaka struct vmbus_attach_args *aa = aux;
85afdb7e40Snonaka
86afdb7e40Snonaka return vmbusic_probe(aa, &hyperv_guid_timesync);
87afdb7e40Snonaka }
88afdb7e40Snonaka
89afdb7e40Snonaka static void
hvtimesync_attach(device_t parent,device_t self,void * aux)90afdb7e40Snonaka hvtimesync_attach(device_t parent, device_t self, void *aux)
91afdb7e40Snonaka {
92afdb7e40Snonaka struct vmbus_attach_args *aa = aux;
93afdb7e40Snonaka int error;
94afdb7e40Snonaka
95afdb7e40Snonaka aprint_naive("\n");
968fd434d0Snonaka aprint_normal(": Hyper-V Time Synchronization Service\n");
97afdb7e40Snonaka
98afdb7e40Snonaka error = vmbusic_attach(self, aa, hvtimesync_channel_cb);
99afdb7e40Snonaka if (error)
100afdb7e40Snonaka return;
101afdb7e40Snonaka
102afdb7e40Snonaka (void) pmf_device_register(self, NULL, NULL);
103afdb7e40Snonaka
104afdb7e40Snonaka (void) hvtimesync_sysctl_setup(self);
105afdb7e40Snonaka }
106afdb7e40Snonaka
107afdb7e40Snonaka static int
hvtimesync_detach(device_t self,int flags)108afdb7e40Snonaka hvtimesync_detach(device_t self, int flags)
109afdb7e40Snonaka {
110afdb7e40Snonaka int error;
111afdb7e40Snonaka
112afdb7e40Snonaka error = vmbusic_detach(self, flags);
113afdb7e40Snonaka if (error)
114afdb7e40Snonaka return error;
115afdb7e40Snonaka
116afdb7e40Snonaka pmf_device_deregister(self);
117afdb7e40Snonaka
118afdb7e40Snonaka return 0;
119afdb7e40Snonaka }
120afdb7e40Snonaka
121afdb7e40Snonaka static void
do_timesync(struct hvtimesync_softc * sc,uint64_t hvtime,uint64_t sent_tc,uint8_t tsflags)122afdb7e40Snonaka do_timesync(struct hvtimesync_softc *sc, uint64_t hvtime, uint64_t sent_tc,
123afdb7e40Snonaka uint8_t tsflags)
124afdb7e40Snonaka {
125afdb7e40Snonaka struct vmbusic_softc *vsc = &sc->sc_vmbusic;
126afdb7e40Snonaka struct timespec vm_ts, hv_ts;
127afdb7e40Snonaka uint64_t hv_ns, vm_ns, rtt = 0;
128afdb7e40Snonaka int64_t diff;
129afdb7e40Snonaka
130afdb7e40Snonaka if (VMBUS_TIMESYNC_DORTT(sc))
131afdb7e40Snonaka rtt = hyperv_tc64() - sent_tc;
132afdb7e40Snonaka
133afdb7e40Snonaka hv_ns = (hvtime - VMBUS_ICMSG_TS_BASE + rtt) * HYPERV_TIMER_NS_FACTOR;
134afdb7e40Snonaka nanotime(&vm_ts);
135afdb7e40Snonaka vm_ns = (vm_ts.tv_sec * NANOSECOND) + vm_ts.tv_nsec;
136afdb7e40Snonaka
137afdb7e40Snonaka if ((tsflags & VMBUS_ICMSG_TS_FLAG_SYNC) && !hvtimesync_ignore_sync) {
138afdb7e40Snonaka #if 0
139afdb7e40Snonaka device_printf(vsc->sc_dev,
140afdb7e40Snonaka "apply sync request, hv: %ju, vm: %ju\n",
141afdb7e40Snonaka (uintmax_t)hv_ns, (uintmax_t)vm_ns);
142afdb7e40Snonaka #endif
143afdb7e40Snonaka hv_ts.tv_sec = hv_ns / NANOSECOND;
144afdb7e40Snonaka hv_ts.tv_nsec = hv_ns % NANOSECOND;
145afdb7e40Snonaka tc_setclock(&hv_ts);
146afdb7e40Snonaka /* Done! */
147afdb7e40Snonaka return;
148afdb7e40Snonaka }
149afdb7e40Snonaka
150afdb7e40Snonaka if ((tsflags & VMBUS_ICMSG_TS_FLAG_SAMPLE) &&
151afdb7e40Snonaka hvtimesync_sample_thresh >= 0) {
152*6469ec7bSandvar if (hvtimesync_sample_verbose) {
153afdb7e40Snonaka device_printf(vsc->sc_dev,
154afdb7e40Snonaka "sample request, hv: %ju, vm: %ju\n",
155afdb7e40Snonaka (uintmax_t)hv_ns, (uintmax_t)vm_ns);
156afdb7e40Snonaka }
157afdb7e40Snonaka
158afdb7e40Snonaka if (hv_ns > vm_ns)
159afdb7e40Snonaka diff = hv_ns - vm_ns;
160afdb7e40Snonaka else
161afdb7e40Snonaka diff = vm_ns - hv_ns;
162afdb7e40Snonaka /* nanosec -> millisec */
163afdb7e40Snonaka diff /= 1000000;
164afdb7e40Snonaka
165afdb7e40Snonaka if (diff > hvtimesync_sample_thresh) {
166afdb7e40Snonaka device_printf(vsc->sc_dev,
167afdb7e40Snonaka "apply sample request, hv: %ju, vm: %ju\n",
168afdb7e40Snonaka (uintmax_t)hv_ns, (uintmax_t)vm_ns);
169afdb7e40Snonaka hv_ts.tv_sec = hv_ns / NANOSECOND;
170afdb7e40Snonaka hv_ts.tv_nsec = hv_ns % NANOSECOND;
171afdb7e40Snonaka tc_setclock(&hv_ts);
172afdb7e40Snonaka }
173afdb7e40Snonaka /* Done */
174afdb7e40Snonaka return;
175afdb7e40Snonaka }
176afdb7e40Snonaka }
177afdb7e40Snonaka
178afdb7e40Snonaka static void
hvtimesync_channel_cb(void * arg)179afdb7e40Snonaka hvtimesync_channel_cb(void *arg)
180afdb7e40Snonaka {
181afdb7e40Snonaka struct hvtimesync_softc *sc = arg;
182afdb7e40Snonaka struct vmbusic_softc *vsc = &sc->sc_vmbusic;
183afdb7e40Snonaka struct vmbus_channel *ch = vsc->sc_chan;
184afdb7e40Snonaka struct vmbus_icmsg_hdr *hdr;
185afdb7e40Snonaka uint64_t rid;
186afdb7e40Snonaka uint32_t rlen;
187afdb7e40Snonaka int error;
188afdb7e40Snonaka
189afdb7e40Snonaka error = vmbus_channel_recv(ch, vsc->sc_buf, vsc->sc_buflen,
190afdb7e40Snonaka &rlen, &rid, 0);
191afdb7e40Snonaka if (error || rlen == 0) {
192afdb7e40Snonaka if (error != EAGAIN) {
193afdb7e40Snonaka DPRINTF("%s: timesync error=%d len=%u\n",
194afdb7e40Snonaka device_xname(vsc->sc_dev), error, rlen);
195afdb7e40Snonaka }
196afdb7e40Snonaka return;
197afdb7e40Snonaka }
198afdb7e40Snonaka if (rlen < sizeof(*hdr)) {
199afdb7e40Snonaka DPRINTF("%s: hvtimesync short read len=%u\n",
200afdb7e40Snonaka device_xname(vsc->sc_dev), rlen);
201afdb7e40Snonaka return;
202afdb7e40Snonaka }
203afdb7e40Snonaka
204afdb7e40Snonaka hdr = (struct vmbus_icmsg_hdr *)vsc->sc_buf;
205afdb7e40Snonaka switch (hdr->ic_type) {
206afdb7e40Snonaka case VMBUS_ICMSG_TYPE_NEGOTIATE:
207afdb7e40Snonaka error = vmbusic_negotiate(vsc, hdr, &rlen, VMBUS_TIMESYNC_FWVER,
208afdb7e40Snonaka VMBUS_TIMESYNC_MSGVER);
209afdb7e40Snonaka if (error)
210afdb7e40Snonaka return;
211afdb7e40Snonaka if (VMBUS_TIMESYNC_DORTT(sc)) {
212afdb7e40Snonaka DPRINTF("%s: RTT\n", device_xname(vsc->sc_dev));
213afdb7e40Snonaka }
214afdb7e40Snonaka break;
215afdb7e40Snonaka
216afdb7e40Snonaka case VMBUS_ICMSG_TYPE_TIMESYNC:
217afdb7e40Snonaka if (VMBUS_TIMESYNC_MSGVER4(sc)) {
218afdb7e40Snonaka struct vmbus_icmsg_timesync4 *msg4;
219afdb7e40Snonaka
220afdb7e40Snonaka if (rlen < sizeof(*msg4)) {
221afdb7e40Snonaka DPRINTF("%s: invalid timesync4 len=%u\n",
222afdb7e40Snonaka device_xname(vsc->sc_dev), rlen);
223afdb7e40Snonaka return;
224afdb7e40Snonaka }
225afdb7e40Snonaka
226afdb7e40Snonaka msg4 = (struct vmbus_icmsg_timesync4 *)hdr;
227afdb7e40Snonaka do_timesync(sc, msg4->ic_hvtime, msg4->ic_sent_tc,
228afdb7e40Snonaka msg4->ic_tsflags);
229afdb7e40Snonaka } else {
230afdb7e40Snonaka struct vmbus_icmsg_timesync *msg;
231afdb7e40Snonaka
232afdb7e40Snonaka if (rlen < sizeof(*msg)) {
233afdb7e40Snonaka DPRINTF("%s: invalid timesync len=%u\n",
234afdb7e40Snonaka device_xname(vsc->sc_dev), rlen);
235afdb7e40Snonaka return;
236afdb7e40Snonaka }
237afdb7e40Snonaka
238afdb7e40Snonaka msg = (struct vmbus_icmsg_timesync *)hdr;
239afdb7e40Snonaka do_timesync(sc, msg->ic_hvtime, 0, msg->ic_tsflags);
240afdb7e40Snonaka }
241afdb7e40Snonaka break;
242afdb7e40Snonaka
243afdb7e40Snonaka default:
244afdb7e40Snonaka device_printf(vsc->sc_dev,
245afdb7e40Snonaka "unhandled _timesync message type %u\n", hdr->ic_type);
246afdb7e40Snonaka return;
247afdb7e40Snonaka }
248afdb7e40Snonaka
249afdb7e40Snonaka (void) vmbusic_sendresp(vsc, ch, vsc->sc_buf, rlen, rid);
250afdb7e40Snonaka }
251afdb7e40Snonaka
252afdb7e40Snonaka static int
hvtimesync_sysctl_setup(device_t self)253afdb7e40Snonaka hvtimesync_sysctl_setup(device_t self)
254afdb7e40Snonaka {
255afdb7e40Snonaka struct hvtimesync_softc *sc = device_private(self);
256afdb7e40Snonaka struct vmbusic_softc *vsc = &sc->sc_vmbusic;
257afdb7e40Snonaka const struct sysctlnode *node;
258afdb7e40Snonaka int error;
259afdb7e40Snonaka
260afdb7e40Snonaka error = sysctl_createv(NULL, 0, NULL, &node,
261afdb7e40Snonaka CTLFLAG_PERMANENT, CTLTYPE_NODE, "machdep", NULL,
262afdb7e40Snonaka NULL, 0, NULL, 0, CTL_MACHDEP, CTL_EOL);
263afdb7e40Snonaka if (error)
264afdb7e40Snonaka return error;
265afdb7e40Snonaka error = sysctl_createv(NULL, 0, &node, &node,
266afdb7e40Snonaka CTLFLAG_PERMANENT, CTLTYPE_NODE, "hyperv", NULL,
267afdb7e40Snonaka NULL, 0, NULL, 0, CTL_CREATE, CTL_EOL);
268afdb7e40Snonaka if (error)
269afdb7e40Snonaka return error;
270afdb7e40Snonaka
271afdb7e40Snonaka error = sysctl_createv(&vsc->sc_log, 0, &node, &node,
272afdb7e40Snonaka 0, CTLTYPE_NODE, "timesync", NULL,
273afdb7e40Snonaka NULL, 0, NULL, 0, CTL_CREATE, CTL_EOL);
274afdb7e40Snonaka if (error)
275afdb7e40Snonaka return error;
276afdb7e40Snonaka
277afdb7e40Snonaka error = sysctl_createv(&vsc->sc_log, 0, &node, NULL,
278afdb7e40Snonaka CTLFLAG_READWRITE,
279afdb7e40Snonaka CTLTYPE_INT, "ignore_sync", NULL,
280afdb7e40Snonaka NULL, 0, &hvtimesync_ignore_sync, 0,
281afdb7e40Snonaka CTL_CREATE, CTL_EOL);
282afdb7e40Snonaka if (error)
283afdb7e40Snonaka return error;
284afdb7e40Snonaka error = sysctl_createv(&vsc->sc_log, 0, &node, NULL,
285afdb7e40Snonaka CTLFLAG_READWRITE,
286afdb7e40Snonaka CTLTYPE_INT, "sample_verbose", NULL,
287*6469ec7bSandvar NULL, 0, &hvtimesync_sample_verbose, 0,
288afdb7e40Snonaka CTL_CREATE, CTL_EOL);
289afdb7e40Snonaka if (error)
290afdb7e40Snonaka return error;
291afdb7e40Snonaka error = sysctl_createv(&vsc->sc_log, 0, &node, NULL,
292afdb7e40Snonaka CTLFLAG_READWRITE,
293afdb7e40Snonaka CTLTYPE_INT, "sample_thresh", NULL,
294afdb7e40Snonaka NULL, 0, &hvtimesync_sample_thresh, 0,
295afdb7e40Snonaka CTL_CREATE, CTL_EOL);
296afdb7e40Snonaka if (error)
297afdb7e40Snonaka return error;
298afdb7e40Snonaka
299afdb7e40Snonaka return 0;
300afdb7e40Snonaka }
301afdb7e40Snonaka
302afdb7e40Snonaka MODULE(MODULE_CLASS_DRIVER, hvtimesync, "vmbus");
303afdb7e40Snonaka
304afdb7e40Snonaka #ifdef _MODULE
305afdb7e40Snonaka #include "ioconf.c"
306afdb7e40Snonaka #endif
307afdb7e40Snonaka
308afdb7e40Snonaka static int
hvtimesync_modcmd(modcmd_t cmd,void * aux)309afdb7e40Snonaka hvtimesync_modcmd(modcmd_t cmd, void *aux)
310afdb7e40Snonaka {
311afdb7e40Snonaka int error = 0;
312afdb7e40Snonaka
313afdb7e40Snonaka switch (cmd) {
314afdb7e40Snonaka case MODULE_CMD_INIT:
315afdb7e40Snonaka #ifdef _MODULE
316afdb7e40Snonaka error = config_init_component(cfdriver_ioconf_hvtimesync,
317afdb7e40Snonaka cfattach_ioconf_hvtimesync, cfdata_ioconf_hvtimesync);
318afdb7e40Snonaka #endif
319afdb7e40Snonaka break;
320afdb7e40Snonaka
321afdb7e40Snonaka case MODULE_CMD_FINI:
322afdb7e40Snonaka #ifdef _MODULE
323afdb7e40Snonaka error = config_fini_component(cfdriver_ioconf_hvtimesync,
324afdb7e40Snonaka cfattach_ioconf_hvtimesync, cfdata_ioconf_hvtimesync);
325afdb7e40Snonaka #endif
326afdb7e40Snonaka break;
327afdb7e40Snonaka
328afdb7e40Snonaka case MODULE_CMD_AUTOUNLOAD:
329afdb7e40Snonaka error = EBUSY;
330afdb7e40Snonaka break;
331afdb7e40Snonaka
332afdb7e40Snonaka default:
333afdb7e40Snonaka error = ENOTTY;
334afdb7e40Snonaka break;
335afdb7e40Snonaka }
336afdb7e40Snonaka
337afdb7e40Snonaka return error;
338afdb7e40Snonaka }
339