hv_util.c 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352
  1. /*
  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. */
  21. #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  22. #include <linux/kernel.h>
  23. #include <linux/init.h>
  24. #include <linux/module.h>
  25. #include <linux/slab.h>
  26. #include <linux/sysctl.h>
  27. #include <linux/reboot.h>
  28. #include <linux/hyperv.h>
  29. static void shutdown_onchannelcallback(void *context);
  30. static struct hv_util_service util_shutdown = {
  31. .util_cb = shutdown_onchannelcallback,
  32. };
  33. static void timesync_onchannelcallback(void *context);
  34. static struct hv_util_service util_timesynch = {
  35. .util_cb = timesync_onchannelcallback,
  36. };
  37. static void heartbeat_onchannelcallback(void *context);
  38. static struct hv_util_service util_heartbeat = {
  39. .util_cb = heartbeat_onchannelcallback,
  40. };
  41. static struct hv_util_service util_kvp = {
  42. .util_cb = hv_kvp_onchannelcallback,
  43. .util_init = hv_kvp_init,
  44. .util_deinit = hv_kvp_deinit,
  45. };
  46. static void shutdown_onchannelcallback(void *context)
  47. {
  48. struct vmbus_channel *channel = context;
  49. u32 recvlen;
  50. u64 requestid;
  51. u8 execute_shutdown = false;
  52. u8 *shut_txf_buf = util_shutdown.recv_buffer;
  53. struct shutdown_msg_data *shutdown_msg;
  54. struct icmsg_hdr *icmsghdrp;
  55. struct icmsg_negotiate *negop = NULL;
  56. vmbus_recvpacket(channel, shut_txf_buf,
  57. PAGE_SIZE, &recvlen, &requestid);
  58. if (recvlen > 0) {
  59. icmsghdrp = (struct icmsg_hdr *)&shut_txf_buf[
  60. sizeof(struct vmbuspipe_hdr)];
  61. if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
  62. vmbus_prep_negotiate_resp(icmsghdrp, negop, shut_txf_buf);
  63. } else {
  64. shutdown_msg =
  65. (struct shutdown_msg_data *)&shut_txf_buf[
  66. sizeof(struct vmbuspipe_hdr) +
  67. sizeof(struct icmsg_hdr)];
  68. switch (shutdown_msg->flags) {
  69. case 0:
  70. case 1:
  71. icmsghdrp->status = HV_S_OK;
  72. execute_shutdown = true;
  73. pr_info("Shutdown request received -"
  74. " graceful shutdown initiated\n");
  75. break;
  76. default:
  77. icmsghdrp->status = HV_E_FAIL;
  78. execute_shutdown = false;
  79. pr_info("Shutdown request received -"
  80. " Invalid request\n");
  81. break;
  82. }
  83. }
  84. icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
  85. | ICMSGHDRFLAG_RESPONSE;
  86. vmbus_sendpacket(channel, shut_txf_buf,
  87. recvlen, requestid,
  88. VM_PKT_DATA_INBAND, 0);
  89. }
  90. if (execute_shutdown == true)
  91. orderly_poweroff(true);
  92. }
  93. /*
  94. * Set guest time to host UTC time.
  95. */
  96. static inline void do_adj_guesttime(u64 hosttime)
  97. {
  98. s64 host_tns;
  99. struct timespec host_ts;
  100. host_tns = (hosttime - WLTIMEDELTA) * 100;
  101. host_ts = ns_to_timespec(host_tns);
  102. do_settimeofday(&host_ts);
  103. }
  104. /*
  105. * Set the host time in a process context.
  106. */
  107. struct adj_time_work {
  108. struct work_struct work;
  109. u64 host_time;
  110. };
  111. static void hv_set_host_time(struct work_struct *work)
  112. {
  113. struct adj_time_work *wrk;
  114. wrk = container_of(work, struct adj_time_work, work);
  115. do_adj_guesttime(wrk->host_time);
  116. kfree(wrk);
  117. }
  118. /*
  119. * Synchronize time with host after reboot, restore, etc.
  120. *
  121. * ICTIMESYNCFLAG_SYNC flag bit indicates reboot, restore events of the VM.
  122. * After reboot the flag ICTIMESYNCFLAG_SYNC is included in the first time
  123. * message after the timesync channel is opened. Since the hv_utils module is
  124. * loaded after hv_vmbus, the first message is usually missed. The other
  125. * thing is, systime is automatically set to emulated hardware clock which may
  126. * not be UTC time or in the same time zone. So, to override these effects, we
  127. * use the first 50 time samples for initial system time setting.
  128. */
  129. static inline void adj_guesttime(u64 hosttime, u8 flags)
  130. {
  131. struct adj_time_work *wrk;
  132. static s32 scnt = 50;
  133. wrk = kmalloc(sizeof(struct adj_time_work), GFP_ATOMIC);
  134. if (wrk == NULL)
  135. return;
  136. wrk->host_time = hosttime;
  137. if ((flags & ICTIMESYNCFLAG_SYNC) != 0) {
  138. INIT_WORK(&wrk->work, hv_set_host_time);
  139. schedule_work(&wrk->work);
  140. return;
  141. }
  142. if ((flags & ICTIMESYNCFLAG_SAMPLE) != 0 && scnt > 0) {
  143. scnt--;
  144. INIT_WORK(&wrk->work, hv_set_host_time);
  145. schedule_work(&wrk->work);
  146. } else
  147. kfree(wrk);
  148. }
  149. /*
  150. * Time Sync Channel message handler.
  151. */
  152. static void timesync_onchannelcallback(void *context)
  153. {
  154. struct vmbus_channel *channel = context;
  155. u32 recvlen;
  156. u64 requestid;
  157. struct icmsg_hdr *icmsghdrp;
  158. struct ictimesync_data *timedatap;
  159. u8 *time_txf_buf = util_timesynch.recv_buffer;
  160. vmbus_recvpacket(channel, time_txf_buf,
  161. PAGE_SIZE, &recvlen, &requestid);
  162. if (recvlen > 0) {
  163. icmsghdrp = (struct icmsg_hdr *)&time_txf_buf[
  164. sizeof(struct vmbuspipe_hdr)];
  165. if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
  166. vmbus_prep_negotiate_resp(icmsghdrp, NULL, time_txf_buf);
  167. } else {
  168. timedatap = (struct ictimesync_data *)&time_txf_buf[
  169. sizeof(struct vmbuspipe_hdr) +
  170. sizeof(struct icmsg_hdr)];
  171. adj_guesttime(timedatap->parenttime, timedatap->flags);
  172. }
  173. icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
  174. | ICMSGHDRFLAG_RESPONSE;
  175. vmbus_sendpacket(channel, time_txf_buf,
  176. recvlen, requestid,
  177. VM_PKT_DATA_INBAND, 0);
  178. }
  179. }
  180. /*
  181. * Heartbeat functionality.
  182. * Every two seconds, Hyper-V send us a heartbeat request message.
  183. * we respond to this message, and Hyper-V knows we are alive.
  184. */
  185. static void heartbeat_onchannelcallback(void *context)
  186. {
  187. struct vmbus_channel *channel = context;
  188. u32 recvlen;
  189. u64 requestid;
  190. struct icmsg_hdr *icmsghdrp;
  191. struct heartbeat_msg_data *heartbeat_msg;
  192. u8 *hbeat_txf_buf = util_heartbeat.recv_buffer;
  193. vmbus_recvpacket(channel, hbeat_txf_buf,
  194. PAGE_SIZE, &recvlen, &requestid);
  195. if (recvlen > 0) {
  196. icmsghdrp = (struct icmsg_hdr *)&hbeat_txf_buf[
  197. sizeof(struct vmbuspipe_hdr)];
  198. if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) {
  199. vmbus_prep_negotiate_resp(icmsghdrp, NULL, hbeat_txf_buf);
  200. } else {
  201. heartbeat_msg =
  202. (struct heartbeat_msg_data *)&hbeat_txf_buf[
  203. sizeof(struct vmbuspipe_hdr) +
  204. sizeof(struct icmsg_hdr)];
  205. heartbeat_msg->seq_num += 1;
  206. }
  207. icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION
  208. | ICMSGHDRFLAG_RESPONSE;
  209. vmbus_sendpacket(channel, hbeat_txf_buf,
  210. recvlen, requestid,
  211. VM_PKT_DATA_INBAND, 0);
  212. }
  213. }
  214. static int util_probe(struct hv_device *dev,
  215. const struct hv_vmbus_device_id *dev_id)
  216. {
  217. struct hv_util_service *srv =
  218. (struct hv_util_service *)dev_id->driver_data;
  219. int ret;
  220. srv->recv_buffer = kmalloc(PAGE_SIZE, GFP_KERNEL);
  221. if (!srv->recv_buffer)
  222. return -ENOMEM;
  223. if (srv->util_init) {
  224. ret = srv->util_init(srv);
  225. if (ret) {
  226. ret = -ENODEV;
  227. goto error1;
  228. }
  229. }
  230. ret = vmbus_open(dev->channel, 2 * PAGE_SIZE, 2 * PAGE_SIZE, NULL, 0,
  231. srv->util_cb, dev->channel);
  232. if (ret)
  233. goto error;
  234. hv_set_drvdata(dev, srv);
  235. return 0;
  236. error:
  237. if (srv->util_deinit)
  238. srv->util_deinit();
  239. error1:
  240. kfree(srv->recv_buffer);
  241. return ret;
  242. }
  243. static int util_remove(struct hv_device *dev)
  244. {
  245. struct hv_util_service *srv = hv_get_drvdata(dev);
  246. vmbus_close(dev->channel);
  247. if (srv->util_deinit)
  248. srv->util_deinit();
  249. kfree(srv->recv_buffer);
  250. return 0;
  251. }
  252. static const struct hv_vmbus_device_id id_table[] = {
  253. /* Shutdown guid */
  254. { VMBUS_DEVICE(0x31, 0x60, 0x0B, 0X0E, 0x13, 0x52, 0x34, 0x49,
  255. 0x81, 0x8B, 0x38, 0XD9, 0x0C, 0xED, 0x39, 0xDB)
  256. .driver_data = (unsigned long)&util_shutdown },
  257. /* Time synch guid */
  258. { VMBUS_DEVICE(0x30, 0xe6, 0x27, 0x95, 0xae, 0xd0, 0x7b, 0x49,
  259. 0xad, 0xce, 0xe8, 0x0a, 0xb0, 0x17, 0x5c, 0xaf)
  260. .driver_data = (unsigned long)&util_timesynch },
  261. /* Heartbeat guid */
  262. { VMBUS_DEVICE(0x39, 0x4f, 0x16, 0x57, 0x15, 0x91, 0x78, 0x4e,
  263. 0xab, 0x55, 0x38, 0x2f, 0x3b, 0xd5, 0x42, 0x2d)
  264. .driver_data = (unsigned long)&util_heartbeat },
  265. /* KVP guid */
  266. { VMBUS_DEVICE(0xe7, 0xf4, 0xa0, 0xa9, 0x45, 0x5a, 0x96, 0x4d,
  267. 0xb8, 0x27, 0x8a, 0x84, 0x1e, 0x8c, 0x3, 0xe6)
  268. .driver_data = (unsigned long)&util_kvp },
  269. { },
  270. };
  271. MODULE_DEVICE_TABLE(vmbus, id_table);
  272. /* The one and only one */
  273. static struct hv_driver util_drv = {
  274. .name = "hv_util",
  275. .id_table = id_table,
  276. .probe = util_probe,
  277. .remove = util_remove,
  278. };
  279. static int __init init_hyperv_utils(void)
  280. {
  281. pr_info("Registering HyperV Utility Driver\n");
  282. return vmbus_driver_register(&util_drv);
  283. }
  284. static void exit_hyperv_utils(void)
  285. {
  286. pr_info("De-Registered HyperV Utility Driver\n");
  287. vmbus_driver_unregister(&util_drv);
  288. }
  289. module_init(init_hyperv_utils);
  290. module_exit(exit_hyperv_utils);
  291. MODULE_DESCRIPTION("Hyper-V Utilities");
  292. MODULE_VERSION(HV_DRV_VERSION);
  293. MODULE_LICENSE("GPL");