]>
Commit | Line | Data |
---|---|---|
c88c4e4c HJ |
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 <[email protected]> | |
19 | * Hank Janssen <[email protected]> | |
20 | */ | |
af7a5b6e HJ |
21 | #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt |
22 | ||
c88c4e4c HJ |
23 | #include <linux/kernel.h> |
24 | #include <linux/init.h> | |
25 | #include <linux/module.h> | |
26 | #include <linux/slab.h> | |
27 | #include <linux/sysctl.h> | |
9e629075 | 28 | #include <linux/reboot.h> |
46a97191 | 29 | #include <linux/hyperv.h> |
c88c4e4c | 30 | |
01325476 | 31 | #include "hyperv_vmbus.h" |
6741335b | 32 | |
3a491605 S |
33 | #define SD_MAJOR 3 |
34 | #define SD_MINOR 0 | |
35 | #define SD_VERSION (SD_MAJOR << 16 | SD_MINOR) | |
6741335b | 36 | |
3a491605 S |
37 | #define SD_WS2008_MAJOR 1 |
38 | #define SD_WS2008_VERSION (SD_WS2008_MAJOR << 16 | SD_MINOR) | |
39 | ||
40 | #define TS_MAJOR 3 | |
41 | #define TS_MINOR 0 | |
42 | #define TS_VERSION (TS_MAJOR << 16 | TS_MINOR) | |
43 | ||
44 | #define TS_WS2008_MAJOR 1 | |
45 | #define TS_WS2008_VERSION (TS_WS2008_MAJOR << 16 | TS_MINOR) | |
46 | ||
47 | #define HB_MAJOR 3 | |
48 | #define HB_MINOR 0 | |
49 | #define HB_VERSION (HB_MAJOR << 16 | HB_MINOR) | |
50 | ||
51 | #define HB_WS2008_MAJOR 1 | |
52 | #define HB_WS2008_VERSION (HB_WS2008_MAJOR << 16 | HB_MINOR) | |
53 | ||
54 | static int sd_srv_version; | |
55 | static int ts_srv_version; | |
56 | static int hb_srv_version; | |
57 | static int util_fw_version; | |
6741335b | 58 | |
a29b643c S |
59 | static void shutdown_onchannelcallback(void *context); |
60 | static struct hv_util_service util_shutdown = { | |
61 | .util_cb = shutdown_onchannelcallback, | |
62 | }; | |
63 | ||
64 | static void timesync_onchannelcallback(void *context); | |
65 | static struct hv_util_service util_timesynch = { | |
66 | .util_cb = timesync_onchannelcallback, | |
67 | }; | |
68 | ||
69 | static void heartbeat_onchannelcallback(void *context); | |
70 | static struct hv_util_service util_heartbeat = { | |
71 | .util_cb = heartbeat_onchannelcallback, | |
72 | }; | |
73 | ||
74 | static struct hv_util_service util_kvp = { | |
75 | .util_cb = hv_kvp_onchannelcallback, | |
76 | .util_init = hv_kvp_init, | |
77 | .util_deinit = hv_kvp_deinit, | |
78 | }; | |
c88c4e4c | 79 | |
96dd86fa S |
80 | static struct hv_util_service util_vss = { |
81 | .util_cb = hv_vss_onchannelcallback, | |
82 | .util_init = hv_vss_init, | |
83 | .util_deinit = hv_vss_deinit, | |
84 | }; | |
85 | ||
01325476 S |
86 | static struct hv_util_service util_fcopy = { |
87 | .util_cb = hv_fcopy_onchannelcallback, | |
88 | .util_init = hv_fcopy_init, | |
89 | .util_deinit = hv_fcopy_deinit, | |
90 | }; | |
91 | ||
3dd6cb49 S |
92 | static void perform_shutdown(struct work_struct *dummy) |
93 | { | |
94 | orderly_poweroff(true); | |
95 | } | |
96 | ||
97 | /* | |
98 | * Perform the shutdown operation in a thread context. | |
99 | */ | |
100 | static DECLARE_WORK(shutdown_work, perform_shutdown); | |
101 | ||
6610944a | 102 | static void shutdown_onchannelcallback(void *context) |
c88c4e4c HJ |
103 | { |
104 | struct vmbus_channel *channel = context; | |
45241e50 | 105 | u32 recvlen; |
c88c4e4c | 106 | u64 requestid; |
31734634 | 107 | bool execute_shutdown = false; |
a29b643c | 108 | u8 *shut_txf_buf = util_shutdown.recv_buffer; |
c88c4e4c HJ |
109 | |
110 | struct shutdown_msg_data *shutdown_msg; | |
111 | ||
112 | struct icmsg_hdr *icmsghdrp; | |
113 | struct icmsg_negotiate *negop = NULL; | |
114 | ||
45241e50 HJ |
115 | vmbus_recvpacket(channel, shut_txf_buf, |
116 | PAGE_SIZE, &recvlen, &requestid); | |
c88c4e4c HJ |
117 | |
118 | if (recvlen > 0) { | |
45241e50 | 119 | icmsghdrp = (struct icmsg_hdr *)&shut_txf_buf[ |
c88c4e4c HJ |
120 | sizeof(struct vmbuspipe_hdr)]; |
121 | ||
122 | if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) { | |
c836d0ab | 123 | vmbus_prep_negotiate_resp(icmsghdrp, negop, |
3a491605 S |
124 | shut_txf_buf, util_fw_version, |
125 | sd_srv_version); | |
c88c4e4c | 126 | } else { |
45241e50 HJ |
127 | shutdown_msg = |
128 | (struct shutdown_msg_data *)&shut_txf_buf[ | |
129 | sizeof(struct vmbuspipe_hdr) + | |
130 | sizeof(struct icmsg_hdr)]; | |
c88c4e4c HJ |
131 | |
132 | switch (shutdown_msg->flags) { | |
133 | case 0: | |
134 | case 1: | |
135 | icmsghdrp->status = HV_S_OK; | |
136 | execute_shutdown = true; | |
137 | ||
af7a5b6e | 138 | pr_info("Shutdown request received -" |
32235b07 | 139 | " graceful shutdown initiated\n"); |
c88c4e4c HJ |
140 | break; |
141 | default: | |
142 | icmsghdrp->status = HV_E_FAIL; | |
143 | execute_shutdown = false; | |
144 | ||
af7a5b6e HJ |
145 | pr_info("Shutdown request received -" |
146 | " Invalid request\n"); | |
c88c4e4c | 147 | break; |
95cd17c9 | 148 | } |
c88c4e4c HJ |
149 | } |
150 | ||
151 | icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION | |
152 | | ICMSGHDRFLAG_RESPONSE; | |
153 | ||
45241e50 | 154 | vmbus_sendpacket(channel, shut_txf_buf, |
c88c4e4c | 155 | recvlen, requestid, |
415f2287 | 156 | VM_PKT_DATA_INBAND, 0); |
c88c4e4c HJ |
157 | } |
158 | ||
c88c4e4c | 159 | if (execute_shutdown == true) |
3dd6cb49 | 160 | schedule_work(&shutdown_work); |
c88c4e4c HJ |
161 | } |
162 | ||
39c4e9c3 | 163 | /* |
e9ec3603 | 164 | * Set guest time to host UTC time. |
39c4e9c3 | 165 | */ |
e9ec3603 | 166 | static inline void do_adj_guesttime(u64 hosttime) |
39c4e9c3 HZ |
167 | { |
168 | s64 host_tns; | |
169 | struct timespec host_ts; | |
39c4e9c3 HZ |
170 | |
171 | host_tns = (hosttime - WLTIMEDELTA) * 100; | |
172 | host_ts = ns_to_timespec(host_tns); | |
173 | ||
e9ec3603 HZ |
174 | do_settimeofday(&host_ts); |
175 | } | |
176 | ||
95ff7cde S |
177 | /* |
178 | * Set the host time in a process context. | |
179 | */ | |
180 | ||
181 | struct adj_time_work { | |
182 | struct work_struct work; | |
183 | u64 host_time; | |
184 | }; | |
185 | ||
186 | static void hv_set_host_time(struct work_struct *work) | |
187 | { | |
188 | struct adj_time_work *wrk; | |
189 | ||
190 | wrk = container_of(work, struct adj_time_work, work); | |
191 | do_adj_guesttime(wrk->host_time); | |
192 | kfree(wrk); | |
193 | } | |
194 | ||
e9ec3603 HZ |
195 | /* |
196 | * Synchronize time with host after reboot, restore, etc. | |
197 | * | |
198 | * ICTIMESYNCFLAG_SYNC flag bit indicates reboot, restore events of the VM. | |
199 | * After reboot the flag ICTIMESYNCFLAG_SYNC is included in the first time | |
200 | * message after the timesync channel is opened. Since the hv_utils module is | |
201 | * loaded after hv_vmbus, the first message is usually missed. The other | |
202 | * thing is, systime is automatically set to emulated hardware clock which may | |
203 | * not be UTC time or in the same time zone. So, to override these effects, we | |
204 | * use the first 50 time samples for initial system time setting. | |
205 | */ | |
206 | static inline void adj_guesttime(u64 hosttime, u8 flags) | |
207 | { | |
95ff7cde | 208 | struct adj_time_work *wrk; |
e9ec3603 HZ |
209 | static s32 scnt = 50; |
210 | ||
95ff7cde S |
211 | wrk = kmalloc(sizeof(struct adj_time_work), GFP_ATOMIC); |
212 | if (wrk == NULL) | |
213 | return; | |
214 | ||
215 | wrk->host_time = hosttime; | |
39c4e9c3 | 216 | if ((flags & ICTIMESYNCFLAG_SYNC) != 0) { |
95ff7cde S |
217 | INIT_WORK(&wrk->work, hv_set_host_time); |
218 | schedule_work(&wrk->work); | |
39c4e9c3 HZ |
219 | return; |
220 | } | |
221 | ||
e9ec3603 | 222 | if ((flags & ICTIMESYNCFLAG_SAMPLE) != 0 && scnt > 0) { |
39c4e9c3 | 223 | scnt--; |
95ff7cde S |
224 | INIT_WORK(&wrk->work, hv_set_host_time); |
225 | schedule_work(&wrk->work); | |
226 | } else | |
227 | kfree(wrk); | |
39c4e9c3 HZ |
228 | } |
229 | ||
230 | /* | |
231 | * Time Sync Channel message handler. | |
232 | */ | |
233 | static void timesync_onchannelcallback(void *context) | |
234 | { | |
235 | struct vmbus_channel *channel = context; | |
45241e50 | 236 | u32 recvlen; |
39c4e9c3 HZ |
237 | u64 requestid; |
238 | struct icmsg_hdr *icmsghdrp; | |
239 | struct ictimesync_data *timedatap; | |
a29b643c | 240 | u8 *time_txf_buf = util_timesynch.recv_buffer; |
3a491605 | 241 | struct icmsg_negotiate *negop = NULL; |
39c4e9c3 | 242 | |
45241e50 HJ |
243 | vmbus_recvpacket(channel, time_txf_buf, |
244 | PAGE_SIZE, &recvlen, &requestid); | |
39c4e9c3 HZ |
245 | |
246 | if (recvlen > 0) { | |
45241e50 | 247 | icmsghdrp = (struct icmsg_hdr *)&time_txf_buf[ |
39c4e9c3 HZ |
248 | sizeof(struct vmbuspipe_hdr)]; |
249 | ||
250 | if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) { | |
3a491605 S |
251 | vmbus_prep_negotiate_resp(icmsghdrp, negop, |
252 | time_txf_buf, | |
253 | util_fw_version, | |
254 | ts_srv_version); | |
39c4e9c3 | 255 | } else { |
45241e50 | 256 | timedatap = (struct ictimesync_data *)&time_txf_buf[ |
39c4e9c3 HZ |
257 | sizeof(struct vmbuspipe_hdr) + |
258 | sizeof(struct icmsg_hdr)]; | |
259 | adj_guesttime(timedatap->parenttime, timedatap->flags); | |
260 | } | |
261 | ||
262 | icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION | |
263 | | ICMSGHDRFLAG_RESPONSE; | |
264 | ||
45241e50 | 265 | vmbus_sendpacket(channel, time_txf_buf, |
39c4e9c3 | 266 | recvlen, requestid, |
415f2287 | 267 | VM_PKT_DATA_INBAND, 0); |
39c4e9c3 | 268 | } |
39c4e9c3 HZ |
269 | } |
270 | ||
9153f7b9 HJ |
271 | /* |
272 | * Heartbeat functionality. | |
273 | * Every two seconds, Hyper-V send us a heartbeat request message. | |
274 | * we respond to this message, and Hyper-V knows we are alive. | |
275 | */ | |
276 | static void heartbeat_onchannelcallback(void *context) | |
277 | { | |
278 | struct vmbus_channel *channel = context; | |
45241e50 | 279 | u32 recvlen; |
9153f7b9 HJ |
280 | u64 requestid; |
281 | struct icmsg_hdr *icmsghdrp; | |
282 | struct heartbeat_msg_data *heartbeat_msg; | |
a29b643c | 283 | u8 *hbeat_txf_buf = util_heartbeat.recv_buffer; |
3a491605 | 284 | struct icmsg_negotiate *negop = NULL; |
9153f7b9 | 285 | |
45241e50 HJ |
286 | vmbus_recvpacket(channel, hbeat_txf_buf, |
287 | PAGE_SIZE, &recvlen, &requestid); | |
9153f7b9 HJ |
288 | |
289 | if (recvlen > 0) { | |
45241e50 | 290 | icmsghdrp = (struct icmsg_hdr *)&hbeat_txf_buf[ |
9153f7b9 HJ |
291 | sizeof(struct vmbuspipe_hdr)]; |
292 | ||
293 | if (icmsghdrp->icmsgtype == ICMSGTYPE_NEGOTIATE) { | |
3a491605 S |
294 | vmbus_prep_negotiate_resp(icmsghdrp, negop, |
295 | hbeat_txf_buf, util_fw_version, | |
296 | hb_srv_version); | |
9153f7b9 | 297 | } else { |
45241e50 HJ |
298 | heartbeat_msg = |
299 | (struct heartbeat_msg_data *)&hbeat_txf_buf[ | |
300 | sizeof(struct vmbuspipe_hdr) + | |
301 | sizeof(struct icmsg_hdr)]; | |
9153f7b9 | 302 | |
9153f7b9 HJ |
303 | heartbeat_msg->seq_num += 1; |
304 | } | |
305 | ||
306 | icmsghdrp->icflags = ICMSGHDRFLAG_TRANSACTION | |
307 | | ICMSGHDRFLAG_RESPONSE; | |
308 | ||
45241e50 | 309 | vmbus_sendpacket(channel, hbeat_txf_buf, |
9153f7b9 | 310 | recvlen, requestid, |
415f2287 | 311 | VM_PKT_DATA_INBAND, 0); |
9153f7b9 | 312 | } |
9153f7b9 | 313 | } |
39c4e9c3 | 314 | |
84946899 S |
315 | static int util_probe(struct hv_device *dev, |
316 | const struct hv_vmbus_device_id *dev_id) | |
283f2129 | 317 | { |
a29b643c S |
318 | struct hv_util_service *srv = |
319 | (struct hv_util_service *)dev_id->driver_data; | |
320 | int ret; | |
321 | ||
9bd2d0df | 322 | srv->recv_buffer = kmalloc(PAGE_SIZE * 4, GFP_KERNEL); |
a29b643c S |
323 | if (!srv->recv_buffer) |
324 | return -ENOMEM; | |
325 | if (srv->util_init) { | |
326 | ret = srv->util_init(srv); | |
327 | if (ret) { | |
4e65f6e8 S |
328 | ret = -ENODEV; |
329 | goto error1; | |
a29b643c S |
330 | } |
331 | } | |
332 | ||
7ae3e035 S |
333 | /* |
334 | * The set of services managed by the util driver are not performance | |
335 | * critical and do not need batched reading. Furthermore, some services | |
336 | * such as KVP can only handle one message from the host at a time. | |
337 | * Turn off batched reading for all util drivers before we open the | |
338 | * channel. | |
339 | */ | |
340 | ||
341 | set_channel_read_state(dev->channel, false); | |
342 | ||
a29b643c | 343 | hv_set_drvdata(dev, srv); |
18965663 | 344 | |
3a491605 S |
345 | /* |
346 | * Based on the host; initialize the framework and | |
347 | * service version numbers we will negotiate. | |
348 | */ | |
349 | switch (vmbus_proto_version) { | |
350 | case (VERSION_WS2008): | |
351 | util_fw_version = UTIL_WS2K8_FW_VERSION; | |
352 | sd_srv_version = SD_WS2008_VERSION; | |
353 | ts_srv_version = TS_WS2008_VERSION; | |
354 | hb_srv_version = HB_WS2008_VERSION; | |
355 | break; | |
356 | ||
357 | default: | |
358 | util_fw_version = UTIL_FW_VERSION; | |
359 | sd_srv_version = SD_VERSION; | |
360 | ts_srv_version = TS_VERSION; | |
361 | hb_srv_version = HB_VERSION; | |
362 | } | |
363 | ||
18965663 DC |
364 | ret = vmbus_open(dev->channel, 4 * PAGE_SIZE, 4 * PAGE_SIZE, NULL, 0, |
365 | srv->util_cb, dev->channel); | |
366 | if (ret) | |
367 | goto error; | |
368 | ||
283f2129 | 369 | return 0; |
4e65f6e8 S |
370 | |
371 | error: | |
372 | if (srv->util_deinit) | |
373 | srv->util_deinit(); | |
374 | error1: | |
375 | kfree(srv->recv_buffer); | |
376 | return ret; | |
283f2129 S |
377 | } |
378 | ||
379 | static int util_remove(struct hv_device *dev) | |
380 | { | |
a29b643c S |
381 | struct hv_util_service *srv = hv_get_drvdata(dev); |
382 | ||
383 | if (srv->util_deinit) | |
384 | srv->util_deinit(); | |
5380b383 | 385 | vmbus_close(dev->channel); |
a29b643c S |
386 | kfree(srv->recv_buffer); |
387 | ||
283f2129 S |
388 | return 0; |
389 | } | |
390 | ||
391 | static const struct hv_vmbus_device_id id_table[] = { | |
c45cf2d4 | 392 | /* Shutdown guid */ |
d13984e5 S |
393 | { HV_SHUTDOWN_GUID, |
394 | .driver_data = (unsigned long)&util_shutdown | |
395 | }, | |
c45cf2d4 | 396 | /* Time synch guid */ |
d13984e5 S |
397 | { HV_TS_GUID, |
398 | .driver_data = (unsigned long)&util_timesynch | |
399 | }, | |
c45cf2d4 | 400 | /* Heartbeat guid */ |
d13984e5 S |
401 | { HV_HEART_BEAT_GUID, |
402 | .driver_data = (unsigned long)&util_heartbeat | |
403 | }, | |
c45cf2d4 | 404 | /* KVP guid */ |
d13984e5 S |
405 | { HV_KVP_GUID, |
406 | .driver_data = (unsigned long)&util_kvp | |
407 | }, | |
96dd86fa S |
408 | /* VSS GUID */ |
409 | { HV_VSS_GUID, | |
410 | .driver_data = (unsigned long)&util_vss | |
411 | }, | |
01325476 S |
412 | /* File copy GUID */ |
413 | { HV_FCOPY_GUID, | |
414 | .driver_data = (unsigned long)&util_fcopy | |
415 | }, | |
c45cf2d4 | 416 | { }, |
283f2129 S |
417 | }; |
418 | ||
419 | MODULE_DEVICE_TABLE(vmbus, id_table); | |
420 | ||
421 | /* The one and only one */ | |
422 | static struct hv_driver util_drv = { | |
768fa219 | 423 | .name = "hv_util", |
283f2129 S |
424 | .id_table = id_table, |
425 | .probe = util_probe, | |
426 | .remove = util_remove, | |
427 | }; | |
428 | ||
c88c4e4c HJ |
429 | static int __init init_hyperv_utils(void) |
430 | { | |
af7a5b6e | 431 | pr_info("Registering HyperV Utility Driver\n"); |
c88c4e4c | 432 | |
4e65f6e8 | 433 | return vmbus_driver_register(&util_drv); |
c88c4e4c HJ |
434 | } |
435 | ||
436 | static void exit_hyperv_utils(void) | |
437 | { | |
af7a5b6e | 438 | pr_info("De-Registered HyperV Utility Driver\n"); |
c88c4e4c | 439 | |
768fa219 | 440 | vmbus_driver_unregister(&util_drv); |
c88c4e4c HJ |
441 | } |
442 | ||
443 | module_init(init_hyperv_utils); | |
444 | module_exit(exit_hyperv_utils); | |
445 | ||
446 | MODULE_DESCRIPTION("Hyper-V Utilities"); | |
c88c4e4c | 447 | MODULE_LICENSE("GPL"); |