blob: a0667de7a04c85de62a63527255c492f01063db8 [file] [log] [blame]
Hank Janssenc88c4e42010-05-04 15:55:05 -07001/*
2 * Copyright (c) 2010, Microsoft Corporation.
3 *
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
11 * more details.
12 *
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
15 * Place - Suite 330, Boston, MA 02111-1307 USA.
16 *
17 * Authors:
18 * Haiyang Zhang <haiyangz@microsoft.com>
19 * Hank Janssen <hjanssen@microsoft.com>
20 */
Hank Janssenaf7a5b62011-03-29 13:58:49 -070021#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
22
Hank Janssenc88c4e42010-05-04 15:55:05 -070023#include <linux/kernel.h>
24#include <linux/init.h>
25#include <linux/module.h>
26#include <linux/slab.h>
27#include <linux/sysctl.h>
Greg Kroah-Hartman9e629072010-05-04 08:26:23 -070028#include <linux/reboot.h>
Greg Kroah-Hartman46a97192011-10-04 12:29:52 -070029#include <linux/hyperv.h>
Hank Janssenc88c4e42010-05-04 15:55:05 -070030
K. Y. Srinivasana29b6432011-09-18 10:31:33 -070031static void shutdown_onchannelcallback(void *context);
32static struct hv_util_service util_shutdown = {
33 .util_cb = shutdown_onchannelcallback,
34};
35
36static void timesync_onchannelcallback(void *context);
37static struct hv_util_service util_timesynch = {
38 .util_cb = timesync_onchannelcallback,
39};
40
41static void heartbeat_onchannelcallback(void *context);
42static struct hv_util_service util_heartbeat = {
43 .util_cb = heartbeat_onchannelcallback,
44};
45
46static struct hv_util_service util_kvp = {
47 .util_cb = hv_kvp_onchannelcallback,
48 .util_init = hv_kvp_init,
49 .util_deinit = hv_kvp_deinit,
50};
Hank Janssenc88c4e42010-05-04 15:55:05 -070051
Greg Kroah-Hartman66109442010-05-04 14:31:18 -070052static void shutdown_onchannelcallback(void *context)
Hank Janssenc88c4e42010-05-04 15:55:05 -070053{
54 struct vmbus_channel *channel = context;
Hank Janssen45241e52010-12-13 16:23:36 -080055 u32 recvlen;
Hank Janssenc88c4e42010-05-04 15:55:05 -070056 u64 requestid;
57 u8 execute_shutdown = false;
K. Y. Srinivasana29b6432011-09-18 10:31:33 -070058 u8 *shut_txf_buf = util_shutdown.recv_buffer;
Hank Janssenc88c4e42010-05-04 15:55:05 -070059
60 struct shutdown_msg_data *shutdown_msg;
61
62 struct icmsg_hdr *icmsghdrp;
63 struct icmsg_negotiate *negop = NULL;
64
Hank Janssen45241e52010-12-13 16:23:36 -080065 vmbus_recvpacket(channel, shut_txf_buf,
66 PAGE_SIZE, &recvlen, &requestid);
Hank Janssenc88c4e42010-05-04 15:55:05 -070067
68 if (recvlen > 0) {
Hank Janssen45241e52010-12-13 16:23:36 -080069 icmsghdrp = (struct icmsg_hdr *)&shut_txf_buf[
Hank Janssenc88c4e42010-05-04 15:55:05 -070070 sizeof(struct vmbuspipe_hdr)];
71
72 if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
K. Y. Srinivasanc836d0a2012-05-12 13:44:58 -070073 vmbus_prep_negotiate_resp(icmsghdrp, negop,
74 shut_txf_buf, MAX_SRV_VER, MAX_SRV_VER);
Hank Janssenc88c4e42010-05-04 15:55:05 -070075 } else {
Hank Janssen45241e52010-12-13 16:23:36 -080076 shutdown_msg =
77 (struct shutdown_msg_data *)&shut_txf_buf[
78 sizeof(struct vmbuspipe_hdr) +
79 sizeof(struct icmsg_hdr)];
Hank Janssenc88c4e42010-05-04 15:55:05 -070080
81 switch (shutdown_msg->flags) {
82 case 0:
83 case 1:
84 icmsghdrp->status = HV_S_OK;
85 execute_shutdown = true;
86
Hank Janssenaf7a5b62011-03-29 13:58:49 -070087 pr_info("Shutdown request received -"
Greg Kroah-Hartman32235b02011-04-13 12:14:05 -070088 " graceful shutdown initiated\n");
Hank Janssenc88c4e42010-05-04 15:55:05 -070089 break;
90 default:
91 icmsghdrp->status = HV_E_FAIL;
92 execute_shutdown = false;
93
Hank Janssenaf7a5b62011-03-29 13:58:49 -070094 pr_info("Shutdown request received -"
95 " Invalid request\n");
Hank Janssenc88c4e42010-05-04 15:55:05 -070096 break;
Joe Perches95cd17c2011-04-10 14:31:35 -070097 }
Hank Janssenc88c4e42010-05-04 15:55:05 -070098 }
99
100 icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
101 | ICMSGHDRFLAG_RESPONSE;
102
Hank Janssen45241e52010-12-13 16:23:36 -0800103 vmbus_sendpacket(channel, shut_txf_buf,
Hank Janssenc88c4e42010-05-04 15:55:05 -0700104 recvlen, requestid,
Haiyang Zhang415f2282011-01-26 12:12:13 -0800105 VM_PKT_DATA_INBAND, 0);
Hank Janssenc88c4e42010-05-04 15:55:05 -0700106 }
107
Hank Janssenc88c4e42010-05-04 15:55:05 -0700108 if (execute_shutdown == true)
K. Y. Srinivasanae2a0b42011-08-27 11:31:30 -0700109 orderly_poweroff(true);
Hank Janssenc88c4e42010-05-04 15:55:05 -0700110}
111
Haiyang Zhang39c4e9c2010-05-05 19:23:46 +0000112/*
Haiyang Zhange9ec3602010-05-11 15:11:24 +0000113 * Set guest time to host UTC time.
Haiyang Zhang39c4e9c2010-05-05 19:23:46 +0000114 */
Haiyang Zhange9ec3602010-05-11 15:11:24 +0000115static inline void do_adj_guesttime(u64 hosttime)
Haiyang Zhang39c4e9c2010-05-05 19:23:46 +0000116{
117 s64 host_tns;
118 struct timespec host_ts;
Haiyang Zhang39c4e9c2010-05-05 19:23:46 +0000119
120 host_tns = (hosttime - WLTIMEDELTA) * 100;
121 host_ts = ns_to_timespec(host_tns);
122
Haiyang Zhange9ec3602010-05-11 15:11:24 +0000123 do_settimeofday(&host_ts);
124}
125
126/*
K. Y. Srinivasan95ff7cd2011-08-27 11:31:31 -0700127 * Set the host time in a process context.
128 */
129
130struct adj_time_work {
131 struct work_struct work;
132 u64 host_time;
133};
134
135static void hv_set_host_time(struct work_struct *work)
136{
137 struct adj_time_work *wrk;
138
139 wrk = container_of(work, struct adj_time_work, work);
140 do_adj_guesttime(wrk->host_time);
141 kfree(wrk);
142}
143
144/*
Haiyang Zhange9ec3602010-05-11 15:11:24 +0000145 * Synchronize time with host after reboot, restore, etc.
146 *
147 * ICTIMESYNCFLAG_SYNC flag bit indicates reboot, restore events of the VM.
148 * After reboot the flag ICTIMESYNCFLAG_SYNC is included in the first time
149 * message after the timesync channel is opened. Since the hv_utils module is
150 * loaded after hv_vmbus, the first message is usually missed. The other
151 * thing is, systime is automatically set to emulated hardware clock which may
152 * not be UTC time or in the same time zone. So, to override these effects, we
153 * use the first 50 time samples for initial system time setting.
154 */
155static inline void adj_guesttime(u64 hosttime, u8 flags)
156{
K. Y. Srinivasan95ff7cd2011-08-27 11:31:31 -0700157 struct adj_time_work *wrk;
Haiyang Zhange9ec3602010-05-11 15:11:24 +0000158 static s32 scnt = 50;
159
K. Y. Srinivasan95ff7cd2011-08-27 11:31:31 -0700160 wrk = kmalloc(sizeof(struct adj_time_work), GFP_ATOMIC);
161 if (wrk == NULL)
162 return;
163
164 wrk->host_time = hosttime;
Haiyang Zhang39c4e9c2010-05-05 19:23:46 +0000165 if ((flags & ICTIMESYNCFLAG_SYNC) != 0) {
K. Y. Srinivasan95ff7cd2011-08-27 11:31:31 -0700166 INIT_WORK(&wrk->work, hv_set_host_time);
167 schedule_work(&wrk->work);
Haiyang Zhang39c4e9c2010-05-05 19:23:46 +0000168 return;
169 }
170
Haiyang Zhange9ec3602010-05-11 15:11:24 +0000171 if ((flags & ICTIMESYNCFLAG_SAMPLE) != 0 && scnt > 0) {
Haiyang Zhang39c4e9c2010-05-05 19:23:46 +0000172 scnt--;
K. Y. Srinivasan95ff7cd2011-08-27 11:31:31 -0700173 INIT_WORK(&wrk->work, hv_set_host_time);
174 schedule_work(&wrk->work);
175 } else
176 kfree(wrk);
Haiyang Zhang39c4e9c2010-05-05 19:23:46 +0000177}
178
179/*
180 * Time Sync Channel message handler.
181 */
182static void timesync_onchannelcallback(void *context)
183{
184 struct vmbus_channel *channel = context;
Hank Janssen45241e52010-12-13 16:23:36 -0800185 u32 recvlen;
Haiyang Zhang39c4e9c2010-05-05 19:23:46 +0000186 u64 requestid;
187 struct icmsg_hdr *icmsghdrp;
188 struct ictimesync_data *timedatap;
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700189 u8 *time_txf_buf = util_timesynch.recv_buffer;
Haiyang Zhang39c4e9c2010-05-05 19:23:46 +0000190
Hank Janssen45241e52010-12-13 16:23:36 -0800191 vmbus_recvpacket(channel, time_txf_buf,
192 PAGE_SIZE, &recvlen, &requestid);
Haiyang Zhang39c4e9c2010-05-05 19:23:46 +0000193
194 if (recvlen > 0) {
Hank Janssen45241e52010-12-13 16:23:36 -0800195 icmsghdrp = (struct icmsg_hdr *)&time_txf_buf[
Haiyang Zhang39c4e9c2010-05-05 19:23:46 +0000196 sizeof(struct vmbuspipe_hdr)];
197
198 if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
K. Y. Srinivasanc836d0a2012-05-12 13:44:58 -0700199 vmbus_prep_negotiate_resp(icmsghdrp, NULL, time_txf_buf,
200 MAX_SRV_VER, MAX_SRV_VER);
Haiyang Zhang39c4e9c2010-05-05 19:23:46 +0000201 } else {
Hank Janssen45241e52010-12-13 16:23:36 -0800202 timedatap = (struct ictimesync_data *)&time_txf_buf[
Haiyang Zhang39c4e9c2010-05-05 19:23:46 +0000203 sizeof(struct vmbuspipe_hdr) +
204 sizeof(struct icmsg_hdr)];
205 adj_guesttime(timedatap->parenttime, timedatap->flags);
206 }
207
208 icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
209 | ICMSGHDRFLAG_RESPONSE;
210
Hank Janssen45241e52010-12-13 16:23:36 -0800211 vmbus_sendpacket(channel, time_txf_buf,
Haiyang Zhang39c4e9c2010-05-05 19:23:46 +0000212 recvlen, requestid,
Haiyang Zhang415f2282011-01-26 12:12:13 -0800213 VM_PKT_DATA_INBAND, 0);
Haiyang Zhang39c4e9c2010-05-05 19:23:46 +0000214 }
Haiyang Zhang39c4e9c2010-05-05 19:23:46 +0000215}
216
Hank Janssen9153f7b2010-05-15 14:39:58 -0700217/*
218 * Heartbeat functionality.
219 * Every two seconds, Hyper-V send us a heartbeat request message.
220 * we respond to this message, and Hyper-V knows we are alive.
221 */
222static void heartbeat_onchannelcallback(void *context)
223{
224 struct vmbus_channel *channel = context;
Hank Janssen45241e52010-12-13 16:23:36 -0800225 u32 recvlen;
Hank Janssen9153f7b2010-05-15 14:39:58 -0700226 u64 requestid;
227 struct icmsg_hdr *icmsghdrp;
228 struct heartbeat_msg_data *heartbeat_msg;
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700229 u8 *hbeat_txf_buf = util_heartbeat.recv_buffer;
Hank Janssen9153f7b2010-05-15 14:39:58 -0700230
Hank Janssen45241e52010-12-13 16:23:36 -0800231 vmbus_recvpacket(channel, hbeat_txf_buf,
232 PAGE_SIZE, &recvlen, &requestid);
Hank Janssen9153f7b2010-05-15 14:39:58 -0700233
234 if (recvlen > 0) {
Hank Janssen45241e52010-12-13 16:23:36 -0800235 icmsghdrp = (struct icmsg_hdr *)&hbeat_txf_buf[
Hank Janssen9153f7b2010-05-15 14:39:58 -0700236 sizeof(struct vmbuspipe_hdr)];
237
238 if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
K. Y. Srinivasanc836d0a2012-05-12 13:44:58 -0700239 vmbus_prep_negotiate_resp(icmsghdrp, NULL,
240 hbeat_txf_buf, MAX_SRV_VER, MAX_SRV_VER);
Hank Janssen9153f7b2010-05-15 14:39:58 -0700241 } else {
Hank Janssen45241e52010-12-13 16:23:36 -0800242 heartbeat_msg =
243 (struct heartbeat_msg_data *)&hbeat_txf_buf[
244 sizeof(struct vmbuspipe_hdr) +
245 sizeof(struct icmsg_hdr)];
Hank Janssen9153f7b2010-05-15 14:39:58 -0700246
Hank Janssen9153f7b2010-05-15 14:39:58 -0700247 heartbeat_msg->seq_num += 1;
248 }
249
250 icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
251 | ICMSGHDRFLAG_RESPONSE;
252
Hank Janssen45241e52010-12-13 16:23:36 -0800253 vmbus_sendpacket(channel, hbeat_txf_buf,
Hank Janssen9153f7b2010-05-15 14:39:58 -0700254 recvlen, requestid,
Haiyang Zhang415f2282011-01-26 12:12:13 -0800255 VM_PKT_DATA_INBAND, 0);
Hank Janssen9153f7b2010-05-15 14:39:58 -0700256 }
Hank Janssen9153f7b2010-05-15 14:39:58 -0700257}
Haiyang Zhang39c4e9c2010-05-05 19:23:46 +0000258
K. Y. Srinivasan84946892011-09-13 10:59:38 -0700259static int util_probe(struct hv_device *dev,
260 const struct hv_vmbus_device_id *dev_id)
K. Y. Srinivasan283f2122011-08-25 09:48:36 -0700261{
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700262 struct hv_util_service *srv =
263 (struct hv_util_service *)dev_id->driver_data;
264 int ret;
265
K. Y. Srinivasan9b595782012-08-13 10:06:51 -0700266 srv->recv_buffer = kmalloc(PAGE_SIZE * 2, GFP_KERNEL);
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700267 if (!srv->recv_buffer)
268 return -ENOMEM;
269 if (srv->util_init) {
270 ret = srv->util_init(srv);
271 if (ret) {
K. Y. Srinivasan4e65f6e2011-09-18 10:31:34 -0700272 ret = -ENODEV;
273 goto error1;
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700274 }
275 }
276
K. Y. Srinivasan9b595782012-08-13 10:06:51 -0700277 ret = vmbus_open(dev->channel, 4 * PAGE_SIZE, 4 * PAGE_SIZE, NULL, 0,
K. Y. Srinivasan4e65f6e2011-09-18 10:31:34 -0700278 srv->util_cb, dev->channel);
279 if (ret)
280 goto error;
281
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700282 hv_set_drvdata(dev, srv);
K. Y. Srinivasan283f2122011-08-25 09:48:36 -0700283 return 0;
K. Y. Srinivasan4e65f6e2011-09-18 10:31:34 -0700284
285error:
286 if (srv->util_deinit)
287 srv->util_deinit();
288error1:
289 kfree(srv->recv_buffer);
290 return ret;
K. Y. Srinivasan283f2122011-08-25 09:48:36 -0700291}
292
293static int util_remove(struct hv_device *dev)
294{
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700295 struct hv_util_service *srv = hv_get_drvdata(dev);
296
K. Y. Srinivasan4e65f6e2011-09-18 10:31:34 -0700297 vmbus_close(dev->channel);
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700298 if (srv->util_deinit)
299 srv->util_deinit();
300 kfree(srv->recv_buffer);
301
K. Y. Srinivasan283f2122011-08-25 09:48:36 -0700302 return 0;
303}
304
305static const struct hv_vmbus_device_id id_table[] = {
Greg Kroah-Hartmanc45cf2d2011-08-25 11:41:33 -0700306 /* Shutdown guid */
307 { VMBUS_DEVICE(0x31, 0x60, 0x0B, 0X0E, 0x13, 0x52, 0x34, 0x49,
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700308 0x81, 0x8B, 0x38, 0XD9, 0x0C, 0xED, 0x39, 0xDB)
309 .driver_data = (unsigned long)&util_shutdown },
Greg Kroah-Hartmanc45cf2d2011-08-25 11:41:33 -0700310 /* Time synch guid */
311 { VMBUS_DEVICE(0x30, 0xe6, 0x27, 0x95, 0xae, 0xd0, 0x7b, 0x49,
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700312 0xad, 0xce, 0xe8, 0x0a, 0xb0, 0x17, 0x5c, 0xaf)
313 .driver_data = (unsigned long)&util_timesynch },
Greg Kroah-Hartmanc45cf2d2011-08-25 11:41:33 -0700314 /* Heartbeat guid */
315 { VMBUS_DEVICE(0x39, 0x4f, 0x16, 0x57, 0x15, 0x91, 0x78, 0x4e,
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700316 0xab, 0x55, 0x38, 0x2f, 0x3b, 0xd5, 0x42, 0x2d)
317 .driver_data = (unsigned long)&util_heartbeat },
Greg Kroah-Hartmanc45cf2d2011-08-25 11:41:33 -0700318 /* KVP guid */
319 { VMBUS_DEVICE(0xe7, 0xf4, 0xa0, 0xa9, 0x45, 0x5a, 0x96, 0x4d,
K. Y. Srinivasana29b6432011-09-18 10:31:33 -0700320 0xb8, 0x27, 0x8a, 0x84, 0x1e, 0x8c, 0x3, 0xe6)
321 .driver_data = (unsigned long)&util_kvp },
Greg Kroah-Hartmanc45cf2d2011-08-25 11:41:33 -0700322 { },
K. Y. Srinivasan283f2122011-08-25 09:48:36 -0700323};
324
325MODULE_DEVICE_TABLE(vmbus, id_table);
326
327/* The one and only one */
328static struct hv_driver util_drv = {
Greg Kroah-Hartman768fa212011-08-25 15:07:32 -0700329 .name = "hv_util",
K. Y. Srinivasan283f2122011-08-25 09:48:36 -0700330 .id_table = id_table,
331 .probe = util_probe,
332 .remove = util_remove,
333};
334
Hank Janssenc88c4e42010-05-04 15:55:05 -0700335static int __init init_hyperv_utils(void)
336{
Hank Janssenaf7a5b62011-03-29 13:58:49 -0700337 pr_info("Registering HyperV Utility Driver\n");
Hank Janssenc88c4e42010-05-04 15:55:05 -0700338
K. Y. Srinivasan4e65f6e2011-09-18 10:31:34 -0700339 return vmbus_driver_register(&util_drv);
Hank Janssenc88c4e42010-05-04 15:55:05 -0700340}
341
342static void exit_hyperv_utils(void)
343{
Hank Janssenaf7a5b62011-03-29 13:58:49 -0700344 pr_info("De-Registered HyperV Utility Driver\n");
Hank Janssenc88c4e42010-05-04 15:55:05 -0700345
Greg Kroah-Hartman768fa212011-08-25 15:07:32 -0700346 vmbus_driver_unregister(&util_drv);
Hank Janssenc88c4e42010-05-04 15:55:05 -0700347}
348
349module_init(init_hyperv_utils);
350module_exit(exit_hyperv_utils);
351
352MODULE_DESCRIPTION("Hyper-V Utilities");
353MODULE_VERSION(HV_DRV_VERSION);
354MODULE_LICENSE("GPL");