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