diff options
author | K. Y. Srinivasan <kys@microsoft.com> | 2014-02-16 14:34:30 -0500 |
---|---|---|
committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2014-02-18 13:53:48 -0500 |
commit | 01325476d6e46185031be4a9bc6443832dbc807c (patch) | |
tree | 0c173657fa89e7612b7ccc643e3b443f2123189f | |
parent | e0270addae23aef8401b1150cbca20b8fb373cd0 (diff) |
Drivers: hv: Implement the file copy service
Implement the file copy service for Linux guests on Hyper-V. This permits the
host to copy a file (over VMBUS) into the guest. This facility is part of
"guest integration services" supported on the Windows platform.
Here is a link that provides additional details on this functionality:
http://technet.microsoft.com/en-us/library/dn464282.aspx
In V1 version of the patch I have addressed comments from
Olaf Hering <olaf@aepfle.de> and Dan Carpenter <dan.carpenter@oracle.com>
In V2 version of this patch I did some minor cleanup (making some globals
static). In V4 version of the patch I have addressed all of Olaf's
most recent set of comments/concerns.
In V5 version of the patch I had addressed Greg's most recent comments.
I would like to thank Greg for suggesting that I use misc device; it has
significantly simplified the code.
In V6 version of the patch I have cleaned up error message based on Olaf's
comments. I have also rebased the patch based on the current tip.
In this version of the patch, I have addressed the latest comments from Greg.
Signed-off-by: K. Y. Srinivasan <kys@microsoft.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
-rw-r--r-- | drivers/hv/Makefile | 2 | ||||
-rw-r--r-- | drivers/hv/hv_fcopy.c | 414 | ||||
-rw-r--r-- | drivers/hv/hv_util.c | 11 | ||||
-rw-r--r-- | drivers/hv/hyperv_vmbus.h | 4 | ||||
-rw-r--r-- | include/linux/hyperv.h | 12 | ||||
-rw-r--r-- | include/uapi/linux/hyperv.h | 46 | ||||
-rw-r--r-- | tools/hv/hv_fcopy_daemon.c | 195 |
7 files changed, 682 insertions, 2 deletions
diff --git a/drivers/hv/Makefile b/drivers/hv/Makefile index 0a74b5661186..5e4dfa4cfe22 100644 --- a/drivers/hv/Makefile +++ b/drivers/hv/Makefile | |||
@@ -5,4 +5,4 @@ obj-$(CONFIG_HYPERV_BALLOON) += hv_balloon.o | |||
5 | hv_vmbus-y := vmbus_drv.o \ | 5 | hv_vmbus-y := vmbus_drv.o \ |
6 | hv.o connection.o channel.o \ | 6 | hv.o connection.o channel.o \ |
7 | channel_mgmt.o ring_buffer.o | 7 | channel_mgmt.o ring_buffer.o |
8 | hv_utils-y := hv_util.o hv_kvp.o hv_snapshot.o | 8 | hv_utils-y := hv_util.o hv_kvp.o hv_snapshot.o hv_fcopy.o |
diff --git a/drivers/hv/hv_fcopy.c b/drivers/hv/hv_fcopy.c new file mode 100644 index 000000000000..285b5e210a09 --- /dev/null +++ b/drivers/hv/hv_fcopy.c | |||
@@ -0,0 +1,414 @@ | |||
1 | /* | ||
2 | * An implementation of file copy service. | ||
3 | * | ||
4 | * Copyright (C) 2014, Microsoft, Inc. | ||
5 | * | ||
6 | * Author : K. Y. Srinivasan <ksrinivasan@novell.com> | ||
7 | * | ||
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. | ||
11 | * | ||
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 | ||
16 | * details. | ||
17 | * | ||
18 | */ | ||
19 | |||
20 | #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt | ||
21 | |||
22 | #include <linux/semaphore.h> | ||
23 | #include <linux/fs.h> | ||
24 | #include <linux/nls.h> | ||
25 | #include <linux/workqueue.h> | ||
26 | #include <linux/cdev.h> | ||
27 | #include <linux/hyperv.h> | ||
28 | #include <linux/sched.h> | ||
29 | #include <linux/uaccess.h> | ||
30 | #include <linux/miscdevice.h> | ||
31 | |||
32 | #include "hyperv_vmbus.h" | ||
33 | |||
34 | #define WIN8_SRV_MAJOR 1 | ||
35 | #define WIN8_SRV_MINOR 1 | ||
36 | #define WIN8_SRV_VERSION (WIN8_SRV_MAJOR << 16 | WIN8_SRV_MINOR) | ||
37 | |||
38 | /* | ||
39 | * Global state maintained for transaction that is being processed. | ||
40 | * For a class of integration services, including the "file copy service", | ||
41 | * the specified protocol is a "request/response" protocol which means that | ||
42 | * there can only be single outstanding transaction from the host at any | ||
43 | * given point in time. We use this to simplify memory management in this | ||
44 | * driver - we cache and process only one message at a time. | ||
45 | * | ||
46 | * While the request/response protocol is guaranteed by the host, we further | ||
47 | * ensure this by serializing packet processing in this driver - we do not | ||
48 | * read additional packets from the VMBUs until the current packet is fully | ||
49 | * handled. | ||
50 | * | ||
51 | * The transaction "active" state is set when we receive a request from the | ||
52 | * host and we cleanup this state when the transaction is completed - when we | ||
53 | * respond to the host with our response. When the transaction active state is | ||
54 | * set, we defer handling incoming packets. | ||
55 | */ | ||
56 | |||
57 | static struct { | ||
58 | bool active; /* transaction status - active or not */ | ||
59 | int recv_len; /* number of bytes received. */ | ||
60 | struct hv_fcopy_hdr *fcopy_msg; /* current message */ | ||
61 | struct hv_start_fcopy message; /* sent to daemon */ | ||
62 | struct vmbus_channel *recv_channel; /* chn we got the request */ | ||
63 | u64 recv_req_id; /* request ID. */ | ||
64 | void *fcopy_context; /* for the channel callback */ | ||
65 | struct semaphore read_sema; | ||
66 | } fcopy_transaction; | ||
67 | |||
68 | static bool opened; /* currently device opened */ | ||
69 | |||
70 | /* | ||
71 | * Before we can accept copy messages from the host, we need | ||
72 | * to handshake with the user level daemon. This state tracks | ||
73 | * if we are in the handshake phase. | ||
74 | */ | ||
75 | static bool in_hand_shake = true; | ||
76 | static void fcopy_send_data(void); | ||
77 | static void fcopy_respond_to_host(int error); | ||
78 | static void fcopy_work_func(struct work_struct *dummy); | ||
79 | static DECLARE_DELAYED_WORK(fcopy_work, fcopy_work_func); | ||
80 | static u8 *recv_buffer; | ||
81 | |||
82 | static void fcopy_work_func(struct work_struct *dummy) | ||
83 | { | ||
84 | /* | ||
85 | * If the timer fires, the user-mode component has not responded; | ||
86 | * process the pending transaction. | ||
87 | */ | ||
88 | fcopy_respond_to_host(HV_E_FAIL); | ||
89 | } | ||
90 | |||
91 | static int fcopy_handle_handshake(u32 version) | ||
92 | { | ||
93 | switch (version) { | ||
94 | case FCOPY_CURRENT_VERSION: | ||
95 | break; | ||
96 | default: | ||
97 | /* | ||
98 | * For now we will fail the registration. | ||
99 | * If and when we have multiple versions to | ||
100 | * deal with, we will be backward compatible. | ||
101 | * We will add this code when needed. | ||
102 | */ | ||
103 | return -EINVAL; | ||
104 | } | ||
105 | pr_info("FCP: user-mode registering done. Daemon version: %d\n", | ||
106 | version); | ||
107 | fcopy_transaction.active = false; | ||
108 | if (fcopy_transaction.fcopy_context) | ||
109 | hv_fcopy_onchannelcallback(fcopy_transaction.fcopy_context); | ||
110 | in_hand_shake = false; | ||
111 | return 0; | ||
112 | } | ||
113 | |||
114 | static void fcopy_send_data(void) | ||
115 | { | ||
116 | struct hv_start_fcopy *smsg_out = &fcopy_transaction.message; | ||
117 | int operation = fcopy_transaction.fcopy_msg->operation; | ||
118 | struct hv_start_fcopy *smsg_in; | ||
119 | |||
120 | /* | ||
121 | * The strings sent from the host are encoded in | ||
122 | * in utf16; convert it to utf8 strings. | ||
123 | * The host assures us that the utf16 strings will not exceed | ||
124 | * the max lengths specified. We will however, reserve room | ||
125 | * for the string terminating character - in the utf16s_utf8s() | ||
126 | * function we limit the size of the buffer where the converted | ||
127 | * string is placed to W_MAX_PATH -1 to guarantee | ||
128 | * that the strings can be properly terminated! | ||
129 | */ | ||
130 | |||
131 | switch (operation) { | ||
132 | case START_FILE_COPY: | ||
133 | memset(smsg_out, 0, sizeof(struct hv_start_fcopy)); | ||
134 | smsg_out->hdr.operation = operation; | ||
135 | smsg_in = (struct hv_start_fcopy *)fcopy_transaction.fcopy_msg; | ||
136 | |||
137 | utf16s_to_utf8s((wchar_t *)smsg_in->file_name, W_MAX_PATH, | ||
138 | UTF16_LITTLE_ENDIAN, | ||
139 | (__u8 *)smsg_out->file_name, W_MAX_PATH - 1); | ||
140 | |||
141 | utf16s_to_utf8s((wchar_t *)smsg_in->path_name, W_MAX_PATH, | ||
142 | UTF16_LITTLE_ENDIAN, | ||
143 | (__u8 *)smsg_out->path_name, W_MAX_PATH - 1); | ||
144 | |||
145 | smsg_out->copy_flags = smsg_in->copy_flags; | ||
146 | smsg_out->file_size = smsg_in->file_size; | ||
147 | break; | ||
148 | |||
149 | default: | ||
150 | break; | ||
151 | } | ||
152 | up(&fcopy_transaction.read_sema); | ||
153 | return; | ||
154 | } | ||
155 | |||
156 | /* | ||
157 | * Send a response back to the host. | ||
158 | */ | ||
159 | |||
160 | static void | ||
161 | fcopy_respond_to_host(int error) | ||
162 | { | ||
163 | struct icmsg_hdr *icmsghdr; | ||
164 | u32 buf_len; | ||
165 | struct vmbus_channel *channel; | ||
166 | u64 req_id; | ||
167 | |||
168 | /* | ||
169 | * Copy the global state for completing the transaction. Note that | ||
170 | * only one transaction can be active at a time. This is guaranteed | ||
171 | * by the file copy protocol implemented by the host. Furthermore, | ||
172 | * the "transaction active" state we maintain ensures that there can | ||
173 | * only be one active transaction at a time. | ||
174 | */ | ||
175 | |||
176 | buf_len = fcopy_transaction.recv_len; | ||
177 | channel = fcopy_transaction.recv_channel; | ||
178 | req_id = fcopy_transaction.recv_req_id; | ||
179 | |||
180 | fcopy_transaction.active = false; | ||
181 | |||
182 | icmsghdr = (struct icmsg_hdr *) | ||
183 | &recv_buffer[sizeof(struct vmbuspipe_hdr)]; | ||
184 | |||
185 | if (channel->onchannel_callback == NULL) | ||
186 | /* | ||
187 | * We have raced with util driver being unloaded; | ||
188 | * silently return. | ||
189 | */ | ||
190 | return; | ||
191 | |||
192 | icmsghdr->status = error; | ||
193 | icmsghdr->icflags = ICMSGHDRFLAG_TRANSACTION | ICMSGHDRFLAG_RESPONSE; | ||
194 | vmbus_sendpacket(channel, recv_buffer, buf_len, req_id, | ||
195 | VM_PKT_DATA_INBAND, 0); | ||
196 | } | ||
197 | |||
198 | void hv_fcopy_onchannelcallback(void *context) | ||
199 | { | ||
200 | struct vmbus_channel *channel = context; | ||
201 | u32 recvlen; | ||
202 | u64 requestid; | ||
203 | struct hv_fcopy_hdr *fcopy_msg; | ||
204 | struct icmsg_hdr *icmsghdr; | ||
205 | struct icmsg_negotiate *negop = NULL; | ||
206 | int util_fw_version; | ||
207 | int fcopy_srv_version; | ||
208 | |||
209 | if (fcopy_transaction.active) { | ||
210 | /* | ||
211 | * We will defer processing this callback once | ||
212 | * the current transaction is complete. | ||
213 | */ | ||
214 | fcopy_transaction.fcopy_context = context; | ||
215 | return; | ||
216 | } | ||
217 | |||
218 | vmbus_recvpacket(channel, recv_buffer, PAGE_SIZE * 2, &recvlen, | ||
219 | &requestid); | ||
220 | if (recvlen <= 0) | ||
221 | return; | ||
222 | |||
223 | icmsghdr = (struct icmsg_hdr *)&recv_buffer[ | ||
224 | sizeof(struct vmbuspipe_hdr)]; | ||
225 | if (icmsghdr->icmsgtype == ICMSGTYPE_NEGOTIATE) { | ||
226 | util_fw_version = UTIL_FW_VERSION; | ||
227 | fcopy_srv_version = WIN8_SRV_VERSION; | ||
228 | vmbus_prep_negotiate_resp(icmsghdr, negop, recv_buffer, | ||
229 | util_fw_version, fcopy_srv_version); | ||
230 | } else { | ||
231 | fcopy_msg = (struct hv_fcopy_hdr *)&recv_buffer[ | ||
232 | sizeof(struct vmbuspipe_hdr) + | ||
233 | sizeof(struct icmsg_hdr)]; | ||
234 | |||
235 | /* | ||
236 | * Stash away this global state for completing the | ||
237 | * transaction; note transactions are serialized. | ||
238 | */ | ||
239 | |||
240 | fcopy_transaction.active = true; | ||
241 | fcopy_transaction.recv_len = recvlen; | ||
242 | fcopy_transaction.recv_channel = channel; | ||
243 | fcopy_transaction.recv_req_id = requestid; | ||
244 | fcopy_transaction.fcopy_msg = fcopy_msg; | ||
245 | |||
246 | /* | ||
247 | * Send the information to the user-level daemon. | ||
248 | */ | ||
249 | fcopy_send_data(); | ||
250 | schedule_delayed_work(&fcopy_work, 5*HZ); | ||
251 | return; | ||
252 | } | ||
253 | icmsghdr->icflags = ICMSGHDRFLAG_TRANSACTION | ICMSGHDRFLAG_RESPONSE; | ||
254 | vmbus_sendpacket(channel, recv_buffer, recvlen, requestid, | ||
255 | VM_PKT_DATA_INBAND, 0); | ||
256 | } | ||
257 | |||
258 | /* | ||
259 | * Create a char device that can support read/write for passing | ||
260 | * the payload. | ||
261 | */ | ||
262 | |||
263 | static ssize_t fcopy_read(struct file *file, char __user *buf, | ||
264 | size_t count, loff_t *ppos) | ||
265 | { | ||
266 | void *src; | ||
267 | size_t copy_size; | ||
268 | int operation; | ||
269 | |||
270 | /* | ||
271 | * Wait until there is something to be read. | ||
272 | */ | ||
273 | if (down_interruptible(&fcopy_transaction.read_sema)) | ||
274 | return -EINTR; | ||
275 | |||
276 | /* | ||
277 | * The channel may be rescinded and in this case, we will wakeup the | ||
278 | * the thread blocked on the semaphore and we will use the opened | ||
279 | * state to correctly handle this case. | ||
280 | */ | ||
281 | if (!opened) | ||
282 | return -ENODEV; | ||
283 | |||
284 | operation = fcopy_transaction.fcopy_msg->operation; | ||
285 | |||
286 | if (operation == START_FILE_COPY) { | ||
287 | src = &fcopy_transaction.message; | ||
288 | copy_size = sizeof(struct hv_start_fcopy); | ||
289 | if (count < copy_size) | ||
290 | return 0; | ||
291 | } else { | ||
292 | src = fcopy_transaction.fcopy_msg; | ||
293 | copy_size = sizeof(struct hv_do_fcopy); | ||
294 | if (count < copy_size) | ||
295 | return 0; | ||
296 | } | ||
297 | if (copy_to_user(buf, src, copy_size)) | ||
298 | return -EFAULT; | ||
299 | |||
300 | return copy_size; | ||
301 | } | ||
302 | |||
303 | static ssize_t fcopy_write(struct file *file, const char __user *buf, | ||
304 | size_t count, loff_t *ppos) | ||
305 | { | ||
306 | int response = 0; | ||
307 | |||
308 | if (count != sizeof(int)) | ||
309 | return -EINVAL; | ||
310 | |||
311 | if (copy_from_user(&response, buf, sizeof(int))) | ||
312 | return -EFAULT; | ||
313 | |||
314 | if (in_hand_shake) { | ||
315 | if (fcopy_handle_handshake(response)) | ||
316 | return -EINVAL; | ||
317 | return sizeof(int); | ||
318 | } | ||
319 | |||
320 | /* | ||
321 | * Complete the transaction by forwarding the result | ||
322 | * to the host. But first, cancel the timeout. | ||
323 | */ | ||
324 | if (cancel_delayed_work_sync(&fcopy_work)) | ||
325 | fcopy_respond_to_host(response); | ||
326 | |||
327 | return sizeof(int); | ||
328 | } | ||
329 | |||
330 | int fcopy_open(struct inode *inode, struct file *f) | ||
331 | { | ||
332 | /* | ||
333 | * The user level daemon that will open this device is | ||
334 | * really an extension of this driver. We can have only | ||
335 | * active open at a time. | ||
336 | */ | ||
337 | if (opened) | ||
338 | return -EBUSY; | ||
339 | |||
340 | /* | ||
341 | * The daemon is alive; setup the state. | ||
342 | */ | ||
343 | opened = true; | ||
344 | return 0; | ||
345 | } | ||
346 | |||
347 | int fcopy_release(struct inode *inode, struct file *f) | ||
348 | { | ||
349 | /* | ||
350 | * The daemon has exited; reset the state. | ||
351 | */ | ||
352 | in_hand_shake = true; | ||
353 | opened = false; | ||
354 | return 0; | ||
355 | } | ||
356 | |||
357 | |||
358 | static const struct file_operations fcopy_fops = { | ||
359 | .read = fcopy_read, | ||
360 | .write = fcopy_write, | ||
361 | .release = fcopy_release, | ||
362 | .open = fcopy_open, | ||
363 | }; | ||
364 | |||
365 | static struct miscdevice fcopy_misc = { | ||
366 | .minor = MISC_DYNAMIC_MINOR, | ||
367 | .name = "vmbus/hv_fcopy", | ||
368 | .fops = &fcopy_fops, | ||
369 | }; | ||
370 | |||
371 | static int fcopy_dev_init(void) | ||
372 | { | ||
373 | return misc_register(&fcopy_misc); | ||
374 | } | ||
375 | |||
376 | static void fcopy_dev_deinit(void) | ||
377 | { | ||
378 | |||
379 | /* | ||
380 | * The device is going away - perhaps because the | ||
381 | * host has rescinded the channel. Setup state so that | ||
382 | * user level daemon can gracefully exit if it is blocked | ||
383 | * on the read semaphore. | ||
384 | */ | ||
385 | opened = false; | ||
386 | /* | ||
387 | * Signal the semaphore as the device is | ||
388 | * going away. | ||
389 | */ | ||
390 | up(&fcopy_transaction.read_sema); | ||
391 | misc_deregister(&fcopy_misc); | ||
392 | } | ||
393 | |||
394 | int hv_fcopy_init(struct hv_util_service *srv) | ||
395 | { | ||
396 | recv_buffer = srv->recv_buffer; | ||
397 | |||
398 | /* | ||
399 | * When this driver loads, the user level daemon that | ||
400 | * processes the host requests may not yet be running. | ||
401 | * Defer processing channel callbacks until the daemon | ||
402 | * has registered. | ||
403 | */ | ||
404 | fcopy_transaction.active = true; | ||
405 | sema_init(&fcopy_transaction.read_sema, 0); | ||
406 | |||
407 | return fcopy_dev_init(); | ||
408 | } | ||
409 | |||
410 | void hv_fcopy_deinit(void) | ||
411 | { | ||
412 | cancel_delayed_work_sync(&fcopy_work); | ||
413 | fcopy_dev_deinit(); | ||
414 | } | ||
diff --git a/drivers/hv/hv_util.c b/drivers/hv/hv_util.c index 62dfd246b948..dd761806f0e8 100644 --- a/drivers/hv/hv_util.c +++ b/drivers/hv/hv_util.c | |||
@@ -28,6 +28,7 @@ | |||
28 | #include <linux/reboot.h> | 28 | #include <linux/reboot.h> |
29 | #include <linux/hyperv.h> | 29 | #include <linux/hyperv.h> |
30 | 30 | ||
31 | #include "hyperv_vmbus.h" | ||
31 | 32 | ||
32 | #define SD_MAJOR 3 | 33 | #define SD_MAJOR 3 |
33 | #define SD_MINOR 0 | 34 | #define SD_MINOR 0 |
@@ -82,6 +83,12 @@ static struct hv_util_service util_vss = { | |||
82 | .util_deinit = hv_vss_deinit, | 83 | .util_deinit = hv_vss_deinit, |
83 | }; | 84 | }; |
84 | 85 | ||
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 | |||
85 | static void perform_shutdown(struct work_struct *dummy) | 92 | static void perform_shutdown(struct work_struct *dummy) |
86 | { | 93 | { |
87 | orderly_poweroff(true); | 94 | orderly_poweroff(true); |
@@ -401,6 +408,10 @@ static const struct hv_vmbus_device_id id_table[] = { | |||
401 | { HV_VSS_GUID, | 408 | { HV_VSS_GUID, |
402 | .driver_data = (unsigned long)&util_vss | 409 | .driver_data = (unsigned long)&util_vss |
403 | }, | 410 | }, |
411 | /* File copy GUID */ | ||
412 | { HV_FCOPY_GUID, | ||
413 | .driver_data = (unsigned long)&util_fcopy | ||
414 | }, | ||
404 | { }, | 415 | { }, |
405 | }; | 416 | }; |
406 | 417 | ||
diff --git a/drivers/hv/hyperv_vmbus.h b/drivers/hv/hyperv_vmbus.h index 1544609881fe..860134da8039 100644 --- a/drivers/hv/hyperv_vmbus.h +++ b/drivers/hv/hyperv_vmbus.h | |||
@@ -669,5 +669,9 @@ int vmbus_set_event(struct vmbus_channel *channel); | |||
669 | 669 | ||
670 | void vmbus_on_event(unsigned long data); | 670 | void vmbus_on_event(unsigned long data); |
671 | 671 | ||
672 | int hv_fcopy_init(struct hv_util_service *); | ||
673 | void hv_fcopy_deinit(void); | ||
674 | void hv_fcopy_onchannelcallback(void *); | ||
675 | |||
672 | 676 | ||
673 | #endif /* _HYPERV_VMBUS_H */ | 677 | #endif /* _HYPERV_VMBUS_H */ |
diff --git a/include/linux/hyperv.h b/include/linux/hyperv.h index fb66fba368d7..62ea1a06836a 100644 --- a/include/linux/hyperv.h +++ b/include/linux/hyperv.h | |||
@@ -30,7 +30,6 @@ | |||
30 | #include <linux/types.h> | 30 | #include <linux/types.h> |
31 | #include <linux/scatterlist.h> | 31 | #include <linux/scatterlist.h> |
32 | #include <linux/list.h> | 32 | #include <linux/list.h> |
33 | #include <linux/uuid.h> | ||
34 | #include <linux/timer.h> | 33 | #include <linux/timer.h> |
35 | #include <linux/workqueue.h> | 34 | #include <linux/workqueue.h> |
36 | #include <linux/completion.h> | 35 | #include <linux/completion.h> |
@@ -1050,6 +1049,17 @@ void vmbus_driver_unregister(struct hv_driver *hv_driver); | |||
1050 | } | 1049 | } |
1051 | 1050 | ||
1052 | /* | 1051 | /* |
1052 | * Guest File Copy Service | ||
1053 | * {34D14BE3-DEE4-41c8-9AE7-6B174977C192} | ||
1054 | */ | ||
1055 | |||
1056 | #define HV_FCOPY_GUID \ | ||
1057 | .guid = { \ | ||
1058 | 0xE3, 0x4B, 0xD1, 0x34, 0xE4, 0xDE, 0xC8, 0x41, \ | ||
1059 | 0x9A, 0xE7, 0x6B, 0x17, 0x49, 0x77, 0xC1, 0x92 \ | ||
1060 | } | ||
1061 | |||
1062 | /* | ||
1053 | * Common header for Hyper-V ICs | 1063 | * Common header for Hyper-V ICs |
1054 | */ | 1064 | */ |
1055 | 1065 | ||
diff --git a/include/uapi/linux/hyperv.h b/include/uapi/linux/hyperv.h index 1861f8e2ce2b..9beb7c991638 100644 --- a/include/uapi/linux/hyperv.h +++ b/include/uapi/linux/hyperv.h | |||
@@ -25,6 +25,8 @@ | |||
25 | #ifndef _UAPI_HYPERV_H | 25 | #ifndef _UAPI_HYPERV_H |
26 | #define _UAPI_HYPERV_H | 26 | #define _UAPI_HYPERV_H |
27 | 27 | ||
28 | #include <linux/uuid.h> | ||
29 | |||
28 | /* | 30 | /* |
29 | * Framework version for util services. | 31 | * Framework version for util services. |
30 | */ | 32 | */ |
@@ -94,6 +96,50 @@ struct hv_vss_msg { | |||
94 | } __attribute__((packed)); | 96 | } __attribute__((packed)); |
95 | 97 | ||
96 | /* | 98 | /* |
99 | * Implementation of a host to guest copy facility. | ||
100 | */ | ||
101 | |||
102 | #define FCOPY_VERSION_0 0 | ||
103 | #define FCOPY_CURRENT_VERSION FCOPY_VERSION_0 | ||
104 | #define W_MAX_PATH 260 | ||
105 | |||
106 | enum hv_fcopy_op { | ||
107 | START_FILE_COPY = 0, | ||
108 | WRITE_TO_FILE, | ||
109 | COMPLETE_FCOPY, | ||
110 | CANCEL_FCOPY, | ||
111 | }; | ||
112 | |||
113 | struct hv_fcopy_hdr { | ||
114 | __u32 operation; | ||
115 | uuid_le service_id0; /* currently unused */ | ||
116 | uuid_le service_id1; /* currently unused */ | ||
117 | } __attribute__((packed)); | ||
118 | |||
119 | #define OVER_WRITE 0x1 | ||
120 | #define CREATE_PATH 0x2 | ||
121 | |||
122 | struct hv_start_fcopy { | ||
123 | struct hv_fcopy_hdr hdr; | ||
124 | __u16 file_name[W_MAX_PATH]; | ||
125 | __u16 path_name[W_MAX_PATH]; | ||
126 | __u32 copy_flags; | ||
127 | __u64 file_size; | ||
128 | } __attribute__((packed)); | ||
129 | |||
130 | /* | ||
131 | * The file is chunked into fragments. | ||
132 | */ | ||
133 | #define DATA_FRAGMENT (6 * 1024) | ||
134 | |||
135 | struct hv_do_fcopy { | ||
136 | struct hv_fcopy_hdr hdr; | ||
137 | __u64 offset; | ||
138 | __u32 size; | ||
139 | __u8 data[DATA_FRAGMENT]; | ||
140 | }; | ||
141 | |||
142 | /* | ||
97 | * An implementation of HyperV key value pair (KVP) functionality for Linux. | 143 | * An implementation of HyperV key value pair (KVP) functionality for Linux. |
98 | * | 144 | * |
99 | * | 145 | * |
diff --git a/tools/hv/hv_fcopy_daemon.c b/tools/hv/hv_fcopy_daemon.c new file mode 100644 index 000000000000..4ecc4fd0bc1b --- /dev/null +++ b/tools/hv/hv_fcopy_daemon.c | |||
@@ -0,0 +1,195 @@ | |||
1 | /* | ||
2 | * An implementation of host to guest copy functionality for Linux. | ||
3 | * | ||
4 | * Copyright (C) 2014, Microsoft, Inc. | ||
5 | * | ||
6 | * Author : K. Y. Srinivasan <kys@microsoft.com> | ||
7 | * | ||
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. | ||
11 | * | ||
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 | ||
16 | * details. | ||
17 | */ | ||
18 | |||
19 | |||
20 | #include <sys/types.h> | ||
21 | #include <sys/socket.h> | ||
22 | #include <sys/poll.h> | ||
23 | #include <linux/types.h> | ||
24 | #include <linux/kdev_t.h> | ||
25 | #include <stdio.h> | ||
26 | #include <stdlib.h> | ||
27 | #include <unistd.h> | ||
28 | #include <string.h> | ||
29 | #include <ctype.h> | ||
30 | #include <errno.h> | ||
31 | #include <linux/hyperv.h> | ||
32 | #include <syslog.h> | ||
33 | #include <sys/stat.h> | ||
34 | #include <fcntl.h> | ||
35 | #include <dirent.h> | ||
36 | |||
37 | static int target_fd; | ||
38 | static char target_fname[W_MAX_PATH]; | ||
39 | |||
40 | static int hv_start_fcopy(struct hv_start_fcopy *smsg) | ||
41 | { | ||
42 | int error = HV_E_FAIL; | ||
43 | char *q, *p; | ||
44 | |||
45 | /* | ||
46 | * If possile append a path seperator to the path. | ||
47 | */ | ||
48 | if (strlen((char *)smsg->path_name) < (W_MAX_PATH - 2)) | ||
49 | strcat((char *)smsg->path_name, "/"); | ||
50 | |||
51 | p = (char *)smsg->path_name; | ||
52 | snprintf(target_fname, sizeof(target_fname), "%s/%s", | ||
53 | (char *)smsg->path_name, smsg->file_name); | ||
54 | |||
55 | syslog(LOG_INFO, "Target file name: %s", target_fname); | ||
56 | /* | ||
57 | * Check to see if the path is already in place; if not, | ||
58 | * create if required. | ||
59 | */ | ||
60 | while ((q = strchr(p, '/')) != NULL) { | ||
61 | if (q == p) { | ||
62 | p++; | ||
63 | continue; | ||
64 | } | ||
65 | *q = '\0'; | ||
66 | if (access((char *)smsg->path_name, F_OK)) { | ||
67 | if (smsg->copy_flags & CREATE_PATH) { | ||
68 | if (mkdir((char *)smsg->path_name, 0755)) { | ||
69 | syslog(LOG_ERR, "Failed to create %s", | ||
70 | (char *)smsg->path_name); | ||
71 | goto done; | ||
72 | } | ||
73 | } else { | ||
74 | syslog(LOG_ERR, "Invalid path: %s", | ||
75 | (char *)smsg->path_name); | ||
76 | goto done; | ||
77 | } | ||
78 | } | ||
79 | p = q + 1; | ||
80 | *q = '/'; | ||
81 | } | ||
82 | |||
83 | if (!access(target_fname, F_OK)) { | ||
84 | syslog(LOG_INFO, "File: %s exists", target_fname); | ||
85 | if (!smsg->copy_flags & OVER_WRITE) | ||
86 | goto done; | ||
87 | } | ||
88 | |||
89 | target_fd = open(target_fname, O_RDWR | O_CREAT | O_CLOEXEC, 0744); | ||
90 | if (target_fd == -1) { | ||
91 | syslog(LOG_INFO, "Open Failed: %s", strerror(errno)); | ||
92 | goto done; | ||
93 | } | ||
94 | |||
95 | error = 0; | ||
96 | done: | ||
97 | return error; | ||
98 | } | ||
99 | |||
100 | static int hv_copy_data(struct hv_do_fcopy *cpmsg) | ||
101 | { | ||
102 | ssize_t bytes_written; | ||
103 | |||
104 | bytes_written = pwrite(target_fd, cpmsg->data, cpmsg->size, | ||
105 | cpmsg->offset); | ||
106 | |||
107 | if (bytes_written != cpmsg->size) | ||
108 | return HV_E_FAIL; | ||
109 | |||
110 | return 0; | ||
111 | } | ||
112 | |||
113 | static int hv_copy_finished(void) | ||
114 | { | ||
115 | close(target_fd); | ||
116 | return 0; | ||
117 | } | ||
118 | static int hv_copy_cancel(void) | ||
119 | { | ||
120 | close(target_fd); | ||
121 | unlink(target_fname); | ||
122 | return 0; | ||
123 | |||
124 | } | ||
125 | |||
126 | int main(void) | ||
127 | { | ||
128 | int fd, fcopy_fd, len; | ||
129 | int error; | ||
130 | int version = FCOPY_CURRENT_VERSION; | ||
131 | char *buffer[4096 * 2]; | ||
132 | struct hv_fcopy_hdr *in_msg; | ||
133 | |||
134 | if (daemon(1, 0)) { | ||
135 | syslog(LOG_ERR, "daemon() failed; error: %s", strerror(errno)); | ||
136 | exit(EXIT_FAILURE); | ||
137 | } | ||
138 | |||
139 | openlog("HV_FCOPY", 0, LOG_USER); | ||
140 | syslog(LOG_INFO, "HV_FCOPY starting; pid is:%d", getpid()); | ||
141 | |||
142 | fcopy_fd = open("/dev/vmbus/hv_fcopy", O_RDWR); | ||
143 | |||
144 | if (fcopy_fd < 0) { | ||
145 | syslog(LOG_ERR, "open /dev/vmbus/hv_fcopy failed; error: %d %s", | ||
146 | errno, strerror(errno)); | ||
147 | exit(EXIT_FAILURE); | ||
148 | } | ||
149 | |||
150 | /* | ||
151 | * Register with the kernel. | ||
152 | */ | ||
153 | if ((write(fcopy_fd, &version, sizeof(int))) != sizeof(int)) { | ||
154 | syslog(LOG_ERR, "Registration failed: %s", strerror(errno)); | ||
155 | exit(EXIT_FAILURE); | ||
156 | } | ||
157 | |||
158 | while (1) { | ||
159 | /* | ||
160 | * In this loop we process fcopy messages after the | ||
161 | * handshake is complete. | ||
162 | */ | ||
163 | len = pread(fcopy_fd, buffer, (4096 * 2), 0); | ||
164 | if (len < 0) { | ||
165 | syslog(LOG_ERR, "pread failed: %s", strerror(errno)); | ||
166 | exit(EXIT_FAILURE); | ||
167 | } | ||
168 | in_msg = (struct hv_fcopy_hdr *)buffer; | ||
169 | |||
170 | switch (in_msg->operation) { | ||
171 | case START_FILE_COPY: | ||
172 | error = hv_start_fcopy((struct hv_start_fcopy *)in_msg); | ||
173 | break; | ||
174 | case WRITE_TO_FILE: | ||
175 | error = hv_copy_data((struct hv_do_fcopy *)in_msg); | ||
176 | break; | ||
177 | case COMPLETE_FCOPY: | ||
178 | error = hv_copy_finished(); | ||
179 | break; | ||
180 | case CANCEL_FCOPY: | ||
181 | error = hv_copy_cancel(); | ||
182 | break; | ||
183 | |||
184 | default: | ||
185 | syslog(LOG_ERR, "Unknown operation: %d", | ||
186 | in_msg->operation); | ||
187 | |||
188 | } | ||
189 | |||
190 | if (pwrite(fcopy_fd, &error, sizeof(int), 0) != sizeof(int)) { | ||
191 | syslog(LOG_ERR, "pwrite failed: %s", strerror(errno)); | ||
192 | exit(EXIT_FAILURE); | ||
193 | } | ||
194 | } | ||
195 | } | ||