vmbus_heartbeat.c revision 303131
1/*-
2 * Copyright (c) 2014,2016 Microsoft Corp.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice unmodified, this list of conditions, and the following
10 *    disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 *
26 * $FreeBSD: head/sys/dev/hyperv/utilities/hv_heartbeat.c 303131 2016-07-21 06:09:47Z sephe $
27 */
28
29#include <sys/param.h>
30#include <sys/kernel.h>
31#include <sys/bus.h>
32#include <sys/malloc.h>
33#include <sys/module.h>
34#include <sys/timetc.h>
35#include <sys/syscallsubr.h>
36
37#include <dev/hyperv/include/hyperv.h>
38#include <dev/hyperv/include/vmbus.h>
39#include <dev/hyperv/utilities/hv_utilreg.h>
40#include "hv_util.h"
41#include "vmbus_if.h"
42
43/* Heartbeat Service */
44static const struct hyperv_guid service_guid = { .hv_guid =
45	{0x39, 0x4f, 0x16, 0x57, 0x15, 0x91, 0x78, 0x4e,
46	0xab, 0x55, 0x38, 0x2f, 0x3b, 0xd5, 0x42, 0x2d} };
47
48/**
49 * Process heartbeat message
50 */
51static void
52hv_heartbeat_cb(struct vmbus_channel *channel, void *context)
53{
54	uint8_t*		buf;
55	int			recvlen;
56	uint64_t		requestid;
57	int			ret;
58
59	struct hv_vmbus_heartbeat_msg_data*	heartbeat_msg;
60	struct hv_vmbus_icmsg_hdr*		icmsghdrp;
61	hv_util_sc			*softc;
62
63	softc = (hv_util_sc*)context;
64	buf = softc->receive_buffer;
65
66	recvlen = PAGE_SIZE;
67	ret = vmbus_chan_recv(channel, buf, &recvlen, &requestid);
68	KASSERT(ret != ENOBUFS, ("hvheartbeat recvbuf is not large enough"));
69	/* XXX check recvlen to make sure that it contains enough data */
70
71	if ((ret == 0) && recvlen > 0) {
72
73	    icmsghdrp = (struct hv_vmbus_icmsg_hdr *)
74		&buf[sizeof(struct hv_vmbus_pipe_hdr)];
75
76	    if (icmsghdrp->icmsgtype == HV_ICMSGTYPE_NEGOTIATE) {
77		hv_negotiate_version(icmsghdrp, NULL, buf);
78
79	    } else {
80		heartbeat_msg =
81		    (struct hv_vmbus_heartbeat_msg_data *)
82			&buf[sizeof(struct hv_vmbus_pipe_hdr) +
83			     sizeof(struct hv_vmbus_icmsg_hdr)];
84
85		heartbeat_msg->seq_num += 1;
86	    }
87
88	    icmsghdrp->icflags = HV_ICMSGHDRFLAG_TRANSACTION |
89				 HV_ICMSGHDRFLAG_RESPONSE;
90
91	    vmbus_chan_send(channel, VMBUS_CHANPKT_TYPE_INBAND, 0,
92	        buf, recvlen, requestid);
93	}
94}
95
96static int
97hv_heartbeat_probe(device_t dev)
98{
99	if (resource_disabled("hvheartbeat", 0))
100		return ENXIO;
101
102	if (VMBUS_PROBE_GUID(device_get_parent(dev), dev, &service_guid) == 0) {
103		device_set_desc(dev, "Hyper-V Heartbeat Service");
104		return BUS_PROBE_DEFAULT;
105	}
106	return ENXIO;
107}
108
109static int
110hv_heartbeat_attach(device_t dev)
111{
112	hv_util_sc *softc = (hv_util_sc*)device_get_softc(dev);
113
114	softc->callback = hv_heartbeat_cb;
115
116	return hv_util_attach(dev);
117}
118
119static device_method_t heartbeat_methods[] = {
120	/* Device interface */
121	DEVMETHOD(device_probe, hv_heartbeat_probe),
122	DEVMETHOD(device_attach, hv_heartbeat_attach),
123	DEVMETHOD(device_detach, hv_util_detach),
124	{ 0, 0 }
125};
126
127static driver_t heartbeat_driver = { "hvheartbeat", heartbeat_methods, sizeof(hv_util_sc)};
128
129static devclass_t heartbeat_devclass;
130
131DRIVER_MODULE(hv_heartbeat, vmbus, heartbeat_driver, heartbeat_devclass, NULL, NULL);
132MODULE_VERSION(hv_heartbeat, 1);
133MODULE_DEPEND(hv_heartbeat, vmbus, 1, 1, 1);
134