]>
git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - drivers/hv/hv_snapshot.c
2 * An implementation of host initiated guest snapshot.
5 * Copyright (C) 2013, Microsoft, Inc.
6 * Author : K. Y. Srinivasan <kys@microsoft.com>
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License version 2 as published
10 * by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
15 * NON INFRINGEMENT. See the GNU General Public License for more
19 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
21 #include <linux/net.h>
22 #include <linux/nls.h>
23 #include <linux/connector.h>
24 #include <linux/workqueue.h>
25 #include <linux/hyperv.h>
27 #include "hyperv_vmbus.h"
28 #include "hv_utils_transport.h"
32 #define VSS_VERSION (VSS_MAJOR << 16 | VSS_MINOR)
34 #define VSS_VER_COUNT 1
35 static const int vss_versions
[] = {
39 #define FW_VER_COUNT 1
40 static const int fw_versions
[] = {
45 * Timeout values are based on expecations from host
47 #define VSS_FREEZE_TIMEOUT (15 * 60)
50 * Global state maintained for transaction that is being processed. For a class
51 * of integration services, including the "VSS service", the specified protocol
52 * is a "request/response" protocol which means that there can only be single
53 * outstanding transaction from the host at any given point in time. We use
54 * this to simplify memory management in this driver - we cache and process
55 * only one message at a time.
57 * While the request/response protocol is guaranteed by the host, we further
58 * ensure this by serializing packet processing in this driver - we do not
59 * read additional packets from the VMBUs until the current packet is fully
64 int state
; /* hvutil_device_state */
65 int recv_len
; /* number of bytes received. */
66 struct vmbus_channel
*recv_channel
; /* chn we got the request */
67 u64 recv_req_id
; /* request ID. */
68 struct hv_vss_msg
*msg
; /* current message */
72 static void vss_respond_to_host(int error
);
75 * This state maintains the version number registered by the daemon.
77 static int dm_reg_value
;
79 static const char vss_devname
[] = "vmbus/hv_vss";
80 static __u8
*recv_buffer
;
81 static struct hvutil_transport
*hvt
;
82 static struct completion release_event
;
84 static void vss_timeout_func(struct work_struct
*dummy
);
85 static void vss_handle_request(struct work_struct
*dummy
);
87 static DECLARE_DELAYED_WORK(vss_timeout_work
, vss_timeout_func
);
88 static DECLARE_WORK(vss_handle_request_work
, vss_handle_request
);
90 static void vss_poll_wrapper(void *channel
)
92 /* Transaction is finished, reset the state here to avoid races. */
93 vss_transaction
.state
= HVUTIL_READY
;
94 hv_vss_onchannelcallback(channel
);
98 * Callback when data is received from user mode.
101 static void vss_timeout_func(struct work_struct
*dummy
)
104 * Timeout waiting for userspace component to reply happened.
106 pr_warn("VSS: timeout waiting for daemon to reply\n");
107 vss_respond_to_host(HV_E_FAIL
);
109 hv_poll_channel(vss_transaction
.recv_channel
, vss_poll_wrapper
);
112 static void vss_register_done(void)
114 hv_poll_channel(vss_transaction
.recv_channel
, vss_poll_wrapper
);
115 pr_debug("VSS: userspace daemon registered\n");
118 static int vss_handle_handshake(struct hv_vss_msg
*vss_msg
)
120 u32 our_ver
= VSS_OP_REGISTER1
;
122 switch (vss_msg
->vss_hdr
.operation
) {
123 case VSS_OP_REGISTER
:
124 /* Daemon doesn't expect us to reply */
125 dm_reg_value
= VSS_OP_REGISTER
;
127 case VSS_OP_REGISTER1
:
128 /* Daemon expects us to reply with our own version */
129 if (hvutil_transport_send(hvt
, &our_ver
, sizeof(our_ver
),
132 dm_reg_value
= VSS_OP_REGISTER1
;
137 pr_info("VSS: userspace daemon ver. %d connected\n", dm_reg_value
);
141 static int vss_on_msg(void *msg
, int len
)
143 struct hv_vss_msg
*vss_msg
= (struct hv_vss_msg
*)msg
;
145 if (len
!= sizeof(*vss_msg
)) {
146 pr_debug("VSS: Message size does not match length\n");
150 if (vss_msg
->vss_hdr
.operation
== VSS_OP_REGISTER
||
151 vss_msg
->vss_hdr
.operation
== VSS_OP_REGISTER1
) {
153 * Don't process registration messages if we're in the middle
154 * of a transaction processing.
156 if (vss_transaction
.state
> HVUTIL_READY
) {
157 pr_debug("VSS: Got unexpected registration request\n");
161 return vss_handle_handshake(vss_msg
);
162 } else if (vss_transaction
.state
== HVUTIL_USERSPACE_REQ
) {
163 vss_transaction
.state
= HVUTIL_USERSPACE_RECV
;
165 if (vss_msg
->vss_hdr
.operation
== VSS_OP_HOT_BACKUP
)
166 vss_transaction
.msg
->vss_cf
.flags
=
167 VSS_HBU_NO_AUTO_RECOVERY
;
169 if (cancel_delayed_work_sync(&vss_timeout_work
)) {
170 vss_respond_to_host(vss_msg
->error
);
171 /* Transaction is finished, reset the state. */
172 hv_poll_channel(vss_transaction
.recv_channel
,
176 /* This is a spurious call! */
177 pr_debug("VSS: Transaction not active\n");
183 static void vss_send_op(void)
185 int op
= vss_transaction
.msg
->vss_hdr
.operation
;
187 struct hv_vss_msg
*vss_msg
;
189 /* The transaction state is wrong. */
190 if (vss_transaction
.state
!= HVUTIL_HOSTMSG_RECEIVED
) {
191 pr_debug("VSS: Unexpected attempt to send to daemon\n");
195 vss_msg
= kzalloc(sizeof(*vss_msg
), GFP_KERNEL
);
199 vss_msg
->vss_hdr
.operation
= op
;
201 vss_transaction
.state
= HVUTIL_USERSPACE_REQ
;
203 schedule_delayed_work(&vss_timeout_work
, op
== VSS_OP_FREEZE
?
204 VSS_FREEZE_TIMEOUT
* HZ
: HV_UTIL_TIMEOUT
* HZ
);
206 rc
= hvutil_transport_send(hvt
, vss_msg
, sizeof(*vss_msg
), NULL
);
208 pr_warn("VSS: failed to communicate to the daemon: %d\n", rc
);
209 if (cancel_delayed_work_sync(&vss_timeout_work
)) {
210 vss_respond_to_host(HV_E_FAIL
);
211 vss_transaction
.state
= HVUTIL_READY
;
220 static void vss_handle_request(struct work_struct
*dummy
)
222 switch (vss_transaction
.msg
->vss_hdr
.operation
) {
224 * Initiate a "freeze/thaw" operation in the guest.
225 * We respond to the host once the operation is complete.
227 * We send the message to the user space daemon and the operation is
228 * performed in the daemon.
232 case VSS_OP_HOT_BACKUP
:
233 if (vss_transaction
.state
< HVUTIL_READY
) {
234 /* Userspace is not registered yet */
235 pr_debug("VSS: Not ready for request.\n");
236 vss_respond_to_host(HV_E_FAIL
);
240 pr_debug("VSS: Received request for op code: %d\n",
241 vss_transaction
.msg
->vss_hdr
.operation
);
242 vss_transaction
.state
= HVUTIL_HOSTMSG_RECEIVED
;
245 case VSS_OP_GET_DM_INFO
:
246 vss_transaction
.msg
->dm_info
.flags
= 0;
252 vss_respond_to_host(0);
253 hv_poll_channel(vss_transaction
.recv_channel
, vss_poll_wrapper
);
257 * Send a response back to the host.
261 vss_respond_to_host(int error
)
263 struct icmsg_hdr
*icmsghdrp
;
265 struct vmbus_channel
*channel
;
269 * Copy the global state for completing the transaction. Note that
270 * only one transaction can be active at a time.
273 buf_len
= vss_transaction
.recv_len
;
274 channel
= vss_transaction
.recv_channel
;
275 req_id
= vss_transaction
.recv_req_id
;
277 icmsghdrp
= (struct icmsg_hdr
*)
278 &recv_buffer
[sizeof(struct vmbuspipe_hdr
)];
280 if (channel
->onchannel_callback
== NULL
)
282 * We have raced with util driver being unloaded;
287 icmsghdrp
->status
= error
;
289 icmsghdrp
->icflags
= ICMSGHDRFLAG_TRANSACTION
| ICMSGHDRFLAG_RESPONSE
;
291 vmbus_sendpacket(channel
, recv_buffer
, buf_len
, req_id
,
292 VM_PKT_DATA_INBAND
, 0);
297 * This callback is invoked when we get a VSS message from the host.
298 * The host ensures that only one VSS transaction can be active at a time.
301 void hv_vss_onchannelcallback(void *context
)
303 struct vmbus_channel
*channel
= context
;
306 struct hv_vss_msg
*vss_msg
;
309 struct icmsg_hdr
*icmsghdrp
;
311 if (vss_transaction
.state
> HVUTIL_READY
)
314 vmbus_recvpacket(channel
, recv_buffer
, PAGE_SIZE
* 2, &recvlen
,
318 icmsghdrp
= (struct icmsg_hdr
*)&recv_buffer
[
319 sizeof(struct vmbuspipe_hdr
)];
321 if (icmsghdrp
->icmsgtype
== ICMSGTYPE_NEGOTIATE
) {
322 if (vmbus_prep_negotiate_resp(icmsghdrp
,
323 recv_buffer
, fw_versions
, FW_VER_COUNT
,
324 vss_versions
, VSS_VER_COUNT
,
325 NULL
, &vss_srv_version
)) {
327 pr_info("VSS IC version %d.%d\n",
328 vss_srv_version
>> 16,
329 vss_srv_version
& 0xFFFF);
332 vss_msg
= (struct hv_vss_msg
*)&recv_buffer
[
333 sizeof(struct vmbuspipe_hdr
) +
334 sizeof(struct icmsg_hdr
)];
337 * Stash away this global state for completing the
338 * transaction; note transactions are serialized.
341 vss_transaction
.recv_len
= recvlen
;
342 vss_transaction
.recv_req_id
= requestid
;
343 vss_transaction
.msg
= (struct hv_vss_msg
*)vss_msg
;
345 schedule_work(&vss_handle_request_work
);
349 icmsghdrp
->icflags
= ICMSGHDRFLAG_TRANSACTION
350 | ICMSGHDRFLAG_RESPONSE
;
352 vmbus_sendpacket(channel
, recv_buffer
,
354 VM_PKT_DATA_INBAND
, 0);
359 static void vss_on_reset(void)
361 if (cancel_delayed_work_sync(&vss_timeout_work
))
362 vss_respond_to_host(HV_E_FAIL
);
363 vss_transaction
.state
= HVUTIL_DEVICE_INIT
;
364 complete(&release_event
);
368 hv_vss_init(struct hv_util_service
*srv
)
370 init_completion(&release_event
);
371 if (vmbus_proto_version
< VERSION_WIN8_1
) {
372 pr_warn("Integration service 'Backup (volume snapshot)'"
373 " not supported on this host version.\n");
376 recv_buffer
= srv
->recv_buffer
;
377 vss_transaction
.recv_channel
= srv
->channel
;
380 * When this driver loads, the user level daemon that
381 * processes the host requests may not yet be running.
382 * Defer processing channel callbacks until the daemon
385 vss_transaction
.state
= HVUTIL_DEVICE_INIT
;
387 hvt
= hvutil_transport_init(vss_devname
, CN_VSS_IDX
, CN_VSS_VAL
,
388 vss_on_msg
, vss_on_reset
);
390 pr_warn("VSS: Failed to initialize transport\n");
397 void hv_vss_deinit(void)
399 vss_transaction
.state
= HVUTIL_DEVICE_DYING
;
400 cancel_delayed_work_sync(&vss_timeout_work
);
401 cancel_work_sync(&vss_handle_request_work
);
402 hvutil_transport_destroy(hvt
);
403 wait_for_completion(&release_event
);