]>
Commit | Line | Data |
---|---|---|
cd831bd7 | 1 | /* |
7a5ca864 FB |
2 | * Copyright (C) 2005 Anthony Liguori <[email protected]> |
3 | * | |
4 | * Network Block Device | |
5 | * | |
6 | * This program is free software; you can redistribute it and/or modify | |
7 | * it under the terms of the GNU General Public License as published by | |
8 | * the Free Software Foundation; under version 2 of the License. | |
9 | * | |
10 | * This program is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
13 | * GNU General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU General Public License | |
8167ee88 | 16 | * along with this program; if not, see <http://www.gnu.org/licenses/>. |
7a5ca864 FB |
17 | */ |
18 | ||
d38ea87a | 19 | #include "qemu/osdep.h" |
da34e65c | 20 | #include "qapi/error.h" |
5a61cb60 | 21 | #include "qemu-common.h" |
f348b6d1 | 22 | #include "qemu/cutils.h" |
26f54e9a | 23 | #include "sysemu/block-backend.h" |
b3838a40 | 24 | #include "block/block_int.h" |
737e150e | 25 | #include "block/nbd.h" |
6a1751b7 | 26 | #include "qemu/main-loop.h" |
537b41f5 | 27 | #include "qemu/error-report.h" |
0ab3b337 | 28 | #include "qemu/config-file.h" |
8c116b0e | 29 | #include "block/snapshot.h" |
b3838a40 | 30 | #include "qapi/util.h" |
d49b6836 | 31 | #include "qapi/qmp/qstring.h" |
0ab3b337 | 32 | #include "qom/object_interfaces.h" |
d0d6ff58 | 33 | #include "io/channel-socket.h" |
7a5ca864 | 34 | |
7a5ca864 | 35 | #include <getopt.h> |
2bff4b6f | 36 | #include <libgen.h> |
a517e88b | 37 | #include <pthread.h> |
cd831bd7 | 38 | |
713cc671 | 39 | #define SOCKET_PATH "/var/lock/qemu-nbd-%s" |
fa8b7ce2 DB |
40 | #define QEMU_NBD_OPT_CACHE 256 |
41 | #define QEMU_NBD_OPT_AIO 257 | |
42 | #define QEMU_NBD_OPT_DISCARD 258 | |
43 | #define QEMU_NBD_OPT_DETECT_ZEROES 259 | |
44 | #define QEMU_NBD_OPT_OBJECT 260 | |
45 | #define QEMU_NBD_OPT_TLSCREDS 261 | |
46 | #define QEMU_NBD_OPT_IMAGE_OPTS 262 | |
7a5ca864 | 47 | |
af49bbbe | 48 | static NBDExport *exp; |
3d4b2f9c | 49 | static bool newproto; |
b1d8e52e | 50 | static int verbose; |
a517e88b | 51 | static char *srcpath; |
48bec07e | 52 | static SocketAddress *saddr; |
7860a380 PB |
53 | static int persistent = 0; |
54 | static enum { RUNNING, TERMINATE, TERMINATING, TERMINATED } state; | |
a61c6782 PB |
55 | static int shared = 1; |
56 | static int nb_fds; | |
d0d6ff58 DB |
57 | static QIOChannelSocket *server_ioc; |
58 | static int server_watch = -1; | |
145614a1 | 59 | static QCryptoTLSCreds *tlscreds; |
7a5ca864 FB |
60 | |
61 | static void usage(const char *name) | |
62 | { | |
b033cd86 | 63 | (printf) ( |
7a5ca864 FB |
64 | "Usage: %s [OPTIONS] FILE\n" |
65 | "QEMU Disk Network Block Device Server\n" | |
66 | "\n" | |
713cc671 PL |
67 | " -h, --help display this help and exit\n" |
68 | " -V, --version output version information and exit\n" | |
b033cd86 PB |
69 | "\n" |
70 | "Connection properties:\n" | |
713cc671 PL |
71 | " -p, --port=PORT port to listen on (default `%d')\n" |
72 | " -b, --bind=IFACE interface to bind to (default `0.0.0.0')\n" | |
73 | " -k, --socket=PATH path to the unix socket\n" | |
74 | " (default '"SOCKET_PATH"')\n" | |
75 | " -e, --shared=NUM device can be shared by NUM clients (default '1')\n" | |
76 | " -t, --persistent don't exit on the last connection\n" | |
77 | " -v, --verbose display extra debugging information\n" | |
7a5ca864 | 78 | "\n" |
b033cd86 | 79 | "Exposing part of the image:\n" |
713cc671 PL |
80 | " -o, --offset=OFFSET offset into the image\n" |
81 | " -P, --partition=NUM only expose partition NUM\n" | |
b033cd86 | 82 | "\n" |
0ab3b337 DB |
83 | "General purpose options:\n" |
84 | " --object type,id=ID,... define an object such as 'secret' for providing\n" | |
85 | " passwords and/or encryption keys\n" | |
b033cd86 PB |
86 | #ifdef __linux__ |
87 | "Kernel NBD client support:\n" | |
713cc671 PL |
88 | " -c, --connect=DEV connect FILE to the local NBD device DEV\n" |
89 | " -d, --disconnect disconnect the specified device\n" | |
b033cd86 PB |
90 | "\n" |
91 | #endif | |
92 | "\n" | |
93 | "Block device options:\n" | |
713cc671 PL |
94 | " -f, --format=FORMAT set image format (raw, qcow2, ...)\n" |
95 | " -r, --read-only export read-only\n" | |
96 | " -s, --snapshot use FILE as an external snapshot, create a temporary\n" | |
97 | " file with backing_file=FILE, redirect the write to\n" | |
98 | " the temporary one\n" | |
8c116b0e | 99 | " -l, --load-snapshot=SNAPSHOT_PARAM\n" |
713cc671 PL |
100 | " load an internal snapshot inside FILE and export it\n" |
101 | " as an read-only device, SNAPSHOT_PARAM format is\n" | |
102 | " 'snapshot.id=[ID],snapshot.name=[NAME]', or\n" | |
103 | " '[ID_OR_NAME]'\n" | |
104 | " -n, --nocache disable host cache\n" | |
105 | " --cache=MODE set cache mode (none, writeback, ...)\n" | |
713cc671 | 106 | " --aio=MODE set AIO mode (native or threads)\n" |
b3838a40 | 107 | " --discard=MODE set discard mode (ignore, unmap)\n" |
6883de6c | 108 | " --detect-zeroes=MODE set detect-zeroes mode (off, on, unmap)\n" |
77c9aaef | 109 | " --image-opts treat FILE as a full set of image options\n" |
b033cd86 PB |
110 | "\n" |
111 | "Report bugs to <[email protected]>\n" | |
c2e2872b | 112 | , name, NBD_DEFAULT_PORT, "DEVICE"); |
7a5ca864 FB |
113 | } |
114 | ||
115 | static void version(const char *name) | |
116 | { | |
117 | printf( | |
315bc7aa | 118 | "%s version 0.0.1\n" |
7a5ca864 FB |
119 | "Written by Anthony Liguori.\n" |
120 | "\n" | |
121 | "Copyright (C) 2006 Anthony Liguori <[email protected]>.\n" | |
122 | "This is free software; see the source for copying conditions. There is NO\n" | |
123 | "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n" | |
315bc7aa | 124 | , name); |
7a5ca864 FB |
125 | } |
126 | ||
127 | struct partition_record | |
128 | { | |
129 | uint8_t bootable; | |
130 | uint8_t start_head; | |
131 | uint32_t start_cylinder; | |
132 | uint8_t start_sector; | |
133 | uint8_t system; | |
134 | uint8_t end_head; | |
135 | uint8_t end_cylinder; | |
136 | uint8_t end_sector; | |
137 | uint32_t start_sector_abs; | |
138 | uint32_t nb_sectors_abs; | |
139 | }; | |
140 | ||
141 | static void read_partition(uint8_t *p, struct partition_record *r) | |
142 | { | |
143 | r->bootable = p[0]; | |
144 | r->start_head = p[1]; | |
145 | r->start_cylinder = p[3] | ((p[2] << 2) & 0x0300); | |
146 | r->start_sector = p[2] & 0x3f; | |
147 | r->system = p[4]; | |
148 | r->end_head = p[5]; | |
149 | r->end_cylinder = p[7] | ((p[6] << 2) & 0x300); | |
150 | r->end_sector = p[6] & 0x3f; | |
ac97393d HR |
151 | |
152 | r->start_sector_abs = le32_to_cpup((uint32_t *)(p + 8)); | |
153 | r->nb_sectors_abs = le32_to_cpup((uint32_t *)(p + 12)); | |
7a5ca864 FB |
154 | } |
155 | ||
4c58e80a | 156 | static int find_partition(BlockBackend *blk, int partition, |
7a5ca864 FB |
157 | off_t *offset, off_t *size) |
158 | { | |
159 | struct partition_record mbr[4]; | |
160 | uint8_t data[512]; | |
161 | int i; | |
162 | int ext_partnum = 4; | |
cb7cf0e3 | 163 | int ret; |
7a5ca864 | 164 | |
4c58e80a | 165 | if ((ret = blk_read(blk, 0, data, 1)) < 0) { |
a4699e55 | 166 | error_report("error while reading: %s", strerror(-ret)); |
85b01e09 | 167 | exit(EXIT_FAILURE); |
cb7cf0e3 | 168 | } |
7a5ca864 FB |
169 | |
170 | if (data[510] != 0x55 || data[511] != 0xaa) { | |
185b4338 | 171 | return -EINVAL; |
7a5ca864 FB |
172 | } |
173 | ||
174 | for (i = 0; i < 4; i++) { | |
175 | read_partition(&data[446 + 16 * i], &mbr[i]); | |
176 | ||
453b07b1 | 177 | if (!mbr[i].system || !mbr[i].nb_sectors_abs) { |
7a5ca864 | 178 | continue; |
453b07b1 | 179 | } |
7a5ca864 FB |
180 | |
181 | if (mbr[i].system == 0xF || mbr[i].system == 0x5) { | |
182 | struct partition_record ext[4]; | |
183 | uint8_t data1[512]; | |
184 | int j; | |
185 | ||
4c58e80a | 186 | if ((ret = blk_read(blk, mbr[i].start_sector_abs, data1, 1)) < 0) { |
a4699e55 | 187 | error_report("error while reading: %s", strerror(-ret)); |
85b01e09 | 188 | exit(EXIT_FAILURE); |
cb7cf0e3 | 189 | } |
7a5ca864 FB |
190 | |
191 | for (j = 0; j < 4; j++) { | |
192 | read_partition(&data1[446 + 16 * j], &ext[j]); | |
453b07b1 | 193 | if (!ext[j].system || !ext[j].nb_sectors_abs) { |
7a5ca864 | 194 | continue; |
453b07b1 | 195 | } |
7a5ca864 FB |
196 | |
197 | if ((ext_partnum + j + 1) == partition) { | |
198 | *offset = (uint64_t)ext[j].start_sector_abs << 9; | |
199 | *size = (uint64_t)ext[j].nb_sectors_abs << 9; | |
200 | return 0; | |
201 | } | |
202 | } | |
203 | ext_partnum += 4; | |
204 | } else if ((i + 1) == partition) { | |
205 | *offset = (uint64_t)mbr[i].start_sector_abs << 9; | |
206 | *size = (uint64_t)mbr[i].nb_sectors_abs << 9; | |
207 | return 0; | |
208 | } | |
209 | } | |
210 | ||
185b4338 | 211 | return -ENOENT; |
7a5ca864 FB |
212 | } |
213 | ||
bb345110 PB |
214 | static void termsig_handler(int signum) |
215 | { | |
7860a380 | 216 | state = TERMINATE; |
a61c6782 | 217 | qemu_notify_event(); |
bb345110 PB |
218 | } |
219 | ||
537b41f5 | 220 | |
a517e88b | 221 | static void *show_parts(void *arg) |
cd831bd7 | 222 | { |
a6ac2313 | 223 | char *device = arg; |
a517e88b PB |
224 | int nbd; |
225 | ||
226 | /* linux just needs an open() to trigger | |
227 | * the partition table update | |
228 | * but remember to load the module with max_part != 0 : | |
229 | * modprobe nbd max_part=63 | |
230 | */ | |
231 | nbd = open(device, O_RDWR); | |
fc19f8a0 | 232 | if (nbd >= 0) { |
a517e88b PB |
233 | close(nbd); |
234 | } | |
235 | return NULL; | |
236 | } | |
cd831bd7 | 237 | |
a517e88b PB |
238 | static void *nbd_client_thread(void *arg) |
239 | { | |
a6ac2313 | 240 | char *device = arg; |
a517e88b | 241 | off_t size; |
a517e88b | 242 | uint32_t nbdflags; |
d0d6ff58 DB |
243 | QIOChannelSocket *sioc; |
244 | int fd; | |
a517e88b PB |
245 | int ret; |
246 | pthread_t show_parts_thread; | |
1ce52846 | 247 | Error *local_error = NULL; |
a517e88b | 248 | |
d0d6ff58 DB |
249 | sioc = qio_channel_socket_new(); |
250 | if (qio_channel_socket_connect_sync(sioc, | |
251 | saddr, | |
252 | &local_error) < 0) { | |
48bec07e | 253 | error_report_err(local_error); |
dc10e8b3 SH |
254 | goto out; |
255 | } | |
a517e88b | 256 | |
1c778ef7 | 257 | ret = nbd_receive_negotiate(QIO_CHANNEL(sioc), NULL, &nbdflags, |
f95910fe | 258 | NULL, NULL, NULL, |
3f472659 | 259 | &size, &local_error); |
fc19f8a0 | 260 | if (ret < 0) { |
1ce52846 | 261 | if (local_error) { |
78288671 | 262 | error_report_err(local_error); |
1ce52846 | 263 | } |
0c544d73 | 264 | goto out_socket; |
a517e88b PB |
265 | } |
266 | ||
a6ac2313 | 267 | fd = open(device, O_RDWR); |
fc19f8a0 | 268 | if (fd < 0) { |
a6ac2313 | 269 | /* Linux-only, we can use %m in printf. */ |
b9884681 | 270 | error_report("Failed to open %s: %m", device); |
0c544d73 | 271 | goto out_socket; |
a6ac2313 PB |
272 | } |
273 | ||
1c778ef7 | 274 | ret = nbd_init(fd, sioc, nbdflags, size); |
fc19f8a0 | 275 | if (ret < 0) { |
0c544d73 | 276 | goto out_fd; |
a517e88b PB |
277 | } |
278 | ||
279 | /* update partition table */ | |
a6ac2313 | 280 | pthread_create(&show_parts_thread, NULL, show_parts, device); |
a517e88b | 281 | |
c1f8fdc3 PB |
282 | if (verbose) { |
283 | fprintf(stderr, "NBD device %s is now connected to %s\n", | |
284 | device, srcpath); | |
285 | } else { | |
286 | /* Close stderr so that the qemu-nbd process exits. */ | |
287 | dup2(STDOUT_FILENO, STDERR_FILENO); | |
288 | } | |
a517e88b PB |
289 | |
290 | ret = nbd_client(fd); | |
291 | if (ret) { | |
0c544d73 | 292 | goto out_fd; |
cd831bd7 | 293 | } |
a517e88b | 294 | close(fd); |
d0d6ff58 | 295 | object_unref(OBJECT(sioc)); |
a517e88b PB |
296 | kill(getpid(), SIGTERM); |
297 | return (void *) EXIT_SUCCESS; | |
298 | ||
0c544d73 PB |
299 | out_fd: |
300 | close(fd); | |
301 | out_socket: | |
d0d6ff58 | 302 | object_unref(OBJECT(sioc)); |
a517e88b PB |
303 | out: |
304 | kill(getpid(), SIGTERM); | |
305 | return (void *) EXIT_FAILURE; | |
cd831bd7 TS |
306 | } |
307 | ||
e4afbf4f | 308 | static int nbd_can_accept(void) |
a61c6782 PB |
309 | { |
310 | return nb_fds < shared; | |
311 | } | |
312 | ||
7860a380 PB |
313 | static void nbd_export_closed(NBDExport *exp) |
314 | { | |
315 | assert(state == TERMINATING); | |
316 | state = TERMINATED; | |
317 | } | |
318 | ||
d0d6ff58 | 319 | static void nbd_update_server_watch(void); |
e4afbf4f | 320 | |
1743b515 | 321 | static void nbd_client_closed(NBDClient *client) |
a61c6782 | 322 | { |
1743b515 | 323 | nb_fds--; |
7860a380 PB |
324 | if (nb_fds == 0 && !persistent && state == RUNNING) { |
325 | state = TERMINATE; | |
326 | } | |
d0d6ff58 | 327 | nbd_update_server_watch(); |
7860a380 | 328 | nbd_client_put(client); |
a61c6782 PB |
329 | } |
330 | ||
d0d6ff58 | 331 | static gboolean nbd_accept(QIOChannel *ioc, GIOCondition cond, gpointer opaque) |
a61c6782 | 332 | { |
d0d6ff58 | 333 | QIOChannelSocket *cioc; |
a61c6782 | 334 | |
d0d6ff58 DB |
335 | cioc = qio_channel_socket_accept(QIO_CHANNEL_SOCKET(ioc), |
336 | NULL); | |
337 | if (!cioc) { | |
338 | return TRUE; | |
0c544d73 PB |
339 | } |
340 | ||
7860a380 | 341 | if (state >= TERMINATE) { |
d0d6ff58 DB |
342 | object_unref(OBJECT(cioc)); |
343 | return TRUE; | |
7860a380 PB |
344 | } |
345 | ||
ee7d7aab | 346 | nb_fds++; |
d0d6ff58 | 347 | nbd_update_server_watch(); |
f95910fe | 348 | nbd_client_new(newproto ? NULL : exp, cioc, |
145614a1 | 349 | tlscreds, NULL, nbd_client_closed); |
d0d6ff58 DB |
350 | object_unref(OBJECT(cioc)); |
351 | ||
352 | return TRUE; | |
a61c6782 PB |
353 | } |
354 | ||
d0d6ff58 | 355 | static void nbd_update_server_watch(void) |
e4afbf4f FZ |
356 | { |
357 | if (nbd_can_accept()) { | |
d0d6ff58 DB |
358 | if (server_watch == -1) { |
359 | server_watch = qio_channel_add_watch(QIO_CHANNEL(server_ioc), | |
360 | G_IO_IN, | |
361 | nbd_accept, | |
362 | NULL, NULL); | |
363 | } | |
e4afbf4f | 364 | } else { |
d0d6ff58 DB |
365 | if (server_watch != -1) { |
366 | g_source_remove(server_watch); | |
367 | server_watch = -1; | |
368 | } | |
e4afbf4f FZ |
369 | } |
370 | } | |
371 | ||
48bec07e DB |
372 | |
373 | static SocketAddress *nbd_build_socket_address(const char *sockpath, | |
374 | const char *bindto, | |
375 | const char *port) | |
376 | { | |
377 | SocketAddress *saddr; | |
378 | ||
379 | saddr = g_new0(SocketAddress, 1); | |
380 | if (sockpath) { | |
2d32adda | 381 | saddr->type = SOCKET_ADDRESS_KIND_UNIX; |
32bafa8f EB |
382 | saddr->u.q_unix.data = g_new0(UnixSocketAddress, 1); |
383 | saddr->u.q_unix.data->path = g_strdup(sockpath); | |
48bec07e | 384 | } else { |
0399293e | 385 | InetSocketAddress *inet; |
2d32adda | 386 | saddr->type = SOCKET_ADDRESS_KIND_INET; |
32bafa8f | 387 | inet = saddr->u.inet.data = g_new0(InetSocketAddress, 1); |
0399293e | 388 | inet->host = g_strdup(bindto); |
48bec07e | 389 | if (port) { |
0399293e | 390 | inet->port = g_strdup(port); |
48bec07e | 391 | } else { |
0399293e | 392 | inet->port = g_strdup_printf("%d", NBD_DEFAULT_PORT); |
48bec07e DB |
393 | } |
394 | } | |
395 | ||
396 | return saddr; | |
397 | } | |
398 | ||
399 | ||
77c9aaef DB |
400 | static QemuOptsList file_opts = { |
401 | .name = "file", | |
402 | .implied_opt_name = "file", | |
403 | .head = QTAILQ_HEAD_INITIALIZER(file_opts.head), | |
404 | .desc = { | |
405 | /* no elements => accept any params */ | |
406 | { /* end of list */ } | |
407 | }, | |
408 | }; | |
409 | ||
0ab3b337 DB |
410 | static QemuOptsList qemu_object_opts = { |
411 | .name = "object", | |
412 | .implied_opt_name = "qom-type", | |
413 | .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head), | |
414 | .desc = { | |
415 | { } | |
416 | }, | |
417 | }; | |
418 | ||
419 | ||
145614a1 DB |
420 | |
421 | static QCryptoTLSCreds *nbd_get_tls_creds(const char *id, Error **errp) | |
422 | { | |
423 | Object *obj; | |
424 | QCryptoTLSCreds *creds; | |
425 | ||
426 | obj = object_resolve_path_component( | |
427 | object_get_objects_root(), id); | |
428 | if (!obj) { | |
429 | error_setg(errp, "No TLS credentials with id '%s'", | |
430 | id); | |
431 | return NULL; | |
432 | } | |
433 | creds = (QCryptoTLSCreds *) | |
434 | object_dynamic_cast(obj, TYPE_QCRYPTO_TLS_CREDS); | |
435 | if (!creds) { | |
436 | error_setg(errp, "Object with id '%s' is not TLS credentials", | |
437 | id); | |
438 | return NULL; | |
439 | } | |
440 | ||
441 | if (creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_SERVER) { | |
442 | error_setg(errp, | |
443 | "Expecting TLS credentials with a server endpoint"); | |
444 | return NULL; | |
445 | } | |
446 | object_ref(obj); | |
447 | return creds; | |
448 | } | |
449 | ||
450 | ||
7a5ca864 FB |
451 | int main(int argc, char **argv) |
452 | { | |
26f54e9a | 453 | BlockBackend *blk; |
7a5ca864 FB |
454 | BlockDriverState *bs; |
455 | off_t dev_offset = 0; | |
b90fb4b8 | 456 | uint32_t nbdflags = 0; |
cd831bd7 | 457 | bool disconnect = false; |
7a5ca864 | 458 | const char *bindto = "0.0.0.0"; |
48bec07e DB |
459 | const char *port = NULL; |
460 | char *sockpath = NULL; | |
a6ac2313 | 461 | char *device = NULL; |
7a5ca864 | 462 | off_t fd_size; |
8c116b0e WX |
463 | QemuOpts *sn_opts = NULL; |
464 | const char *sn_id_or_name = NULL; | |
3d4b2f9c | 465 | const char *sopt = "hVb:o:p:rsnP:c:dvk:e:f:tl:x:"; |
7a5ca864 | 466 | struct option lopt[] = { |
aa6e546c DB |
467 | { "help", no_argument, NULL, 'h' }, |
468 | { "version", no_argument, NULL, 'V' }, | |
469 | { "bind", required_argument, NULL, 'b' }, | |
470 | { "port", required_argument, NULL, 'p' }, | |
471 | { "socket", required_argument, NULL, 'k' }, | |
472 | { "offset", required_argument, NULL, 'o' }, | |
473 | { "read-only", no_argument, NULL, 'r' }, | |
474 | { "partition", required_argument, NULL, 'P' }, | |
475 | { "connect", required_argument, NULL, 'c' }, | |
476 | { "disconnect", no_argument, NULL, 'd' }, | |
477 | { "snapshot", no_argument, NULL, 's' }, | |
478 | { "load-snapshot", required_argument, NULL, 'l' }, | |
479 | { "nocache", no_argument, NULL, 'n' }, | |
480 | { "cache", required_argument, NULL, QEMU_NBD_OPT_CACHE }, | |
481 | { "aio", required_argument, NULL, QEMU_NBD_OPT_AIO }, | |
482 | { "discard", required_argument, NULL, QEMU_NBD_OPT_DISCARD }, | |
483 | { "detect-zeroes", required_argument, NULL, | |
484 | QEMU_NBD_OPT_DETECT_ZEROES }, | |
485 | { "shared", required_argument, NULL, 'e' }, | |
486 | { "format", required_argument, NULL, 'f' }, | |
487 | { "persistent", no_argument, NULL, 't' }, | |
488 | { "verbose", no_argument, NULL, 'v' }, | |
489 | { "object", required_argument, NULL, QEMU_NBD_OPT_OBJECT }, | |
490 | { "export-name", required_argument, NULL, 'x' }, | |
491 | { "tls-creds", required_argument, NULL, QEMU_NBD_OPT_TLSCREDS }, | |
492 | { "image-opts", no_argument, NULL, QEMU_NBD_OPT_IMAGE_OPTS }, | |
660f11be | 493 | { NULL, 0, NULL, 0 } |
7a5ca864 FB |
494 | }; |
495 | int ch; | |
496 | int opt_ind = 0; | |
7a5ca864 | 497 | char *end; |
f5edb014 | 498 | int flags = BDRV_O_RDWR; |
7a5ca864 | 499 | int partition = -1; |
4fbec260 | 500 | int ret = 0; |
39a5235c | 501 | bool seen_cache = false; |
ded9d2d5 | 502 | bool seen_discard = false; |
39a5235c | 503 | bool seen_aio = false; |
a517e88b | 504 | pthread_t client_thread; |
e6b63677 | 505 | const char *fmt = NULL; |
34b5d2c6 | 506 | Error *local_err = NULL; |
b3838a40 | 507 | BlockdevDetectZeroesOptions detect_zeroes = BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF; |
4fbec260 | 508 | QDict *options = NULL; |
3d4b2f9c | 509 | const char *export_name = NULL; |
145614a1 | 510 | const char *tlscredsid = NULL; |
77c9aaef | 511 | bool imageOpts = false; |
6effd5bf | 512 | bool writethrough = true; |
7a5ca864 | 513 | |
a517e88b PB |
514 | /* The client thread uses SIGTERM to interrupt the server. A signal |
515 | * handler ensures that "qemu-nbd -v -c" exits with a nice status code. | |
516 | */ | |
bb345110 | 517 | struct sigaction sa_sigterm; |
bb345110 PB |
518 | memset(&sa_sigterm, 0, sizeof(sa_sigterm)); |
519 | sa_sigterm.sa_handler = termsig_handler; | |
520 | sigaction(SIGTERM, &sa_sigterm, NULL); | |
0ab3b337 DB |
521 | module_call_init(MODULE_INIT_QOM); |
522 | qemu_add_opts(&qemu_object_opts); | |
10f5bff6 | 523 | qemu_init_exec_dir(argv[0]); |
bb345110 | 524 | |
7a5ca864 FB |
525 | while ((ch = getopt_long(argc, argv, sopt, lopt, &opt_ind)) != -1) { |
526 | switch (ch) { | |
527 | case 's': | |
2f726488 TS |
528 | flags |= BDRV_O_SNAPSHOT; |
529 | break; | |
530 | case 'n': | |
39a5235c PB |
531 | optarg = (char *) "none"; |
532 | /* fallthrough */ | |
533 | case QEMU_NBD_OPT_CACHE: | |
534 | if (seen_cache) { | |
85b01e09 MA |
535 | error_report("-n and --cache can only be specified once"); |
536 | exit(EXIT_FAILURE); | |
39a5235c PB |
537 | } |
538 | seen_cache = true; | |
6effd5bf | 539 | if (bdrv_parse_cache_mode(optarg, &flags, &writethrough) == -1) { |
85b01e09 MA |
540 | error_report("Invalid cache mode `%s'", optarg); |
541 | exit(EXIT_FAILURE); | |
39a5235c | 542 | } |
7a5ca864 | 543 | break; |
39a5235c PB |
544 | case QEMU_NBD_OPT_AIO: |
545 | if (seen_aio) { | |
85b01e09 MA |
546 | error_report("--aio can only be specified once"); |
547 | exit(EXIT_FAILURE); | |
39a5235c PB |
548 | } |
549 | seen_aio = true; | |
550 | if (!strcmp(optarg, "native")) { | |
551 | flags |= BDRV_O_NATIVE_AIO; | |
552 | } else if (!strcmp(optarg, "threads")) { | |
553 | /* this is the default */ | |
554 | } else { | |
85b01e09 MA |
555 | error_report("invalid aio mode `%s'", optarg); |
556 | exit(EXIT_FAILURE); | |
39a5235c PB |
557 | } |
558 | break; | |
ded9d2d5 PB |
559 | case QEMU_NBD_OPT_DISCARD: |
560 | if (seen_discard) { | |
85b01e09 MA |
561 | error_report("--discard can only be specified once"); |
562 | exit(EXIT_FAILURE); | |
ded9d2d5 PB |
563 | } |
564 | seen_discard = true; | |
565 | if (bdrv_parse_discard_flags(optarg, &flags) == -1) { | |
85b01e09 MA |
566 | error_report("Invalid discard mode `%s'", optarg); |
567 | exit(EXIT_FAILURE); | |
ded9d2d5 PB |
568 | } |
569 | break; | |
b3838a40 PL |
570 | case QEMU_NBD_OPT_DETECT_ZEROES: |
571 | detect_zeroes = | |
572 | qapi_enum_parse(BlockdevDetectZeroesOptions_lookup, | |
573 | optarg, | |
7fb1cf16 | 574 | BLOCKDEV_DETECT_ZEROES_OPTIONS__MAX, |
b3838a40 PL |
575 | BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF, |
576 | &local_err); | |
577 | if (local_err) { | |
c29b77f9 MA |
578 | error_reportf_err(local_err, |
579 | "Failed to parse detect_zeroes mode: "); | |
85b01e09 | 580 | exit(EXIT_FAILURE); |
b3838a40 PL |
581 | } |
582 | if (detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP && | |
583 | !(flags & BDRV_O_UNMAP)) { | |
85b01e09 MA |
584 | error_report("setting detect-zeroes to unmap is not allowed " |
585 | "without setting discard operation to unmap"); | |
586 | exit(EXIT_FAILURE); | |
b3838a40 PL |
587 | } |
588 | break; | |
7a5ca864 FB |
589 | case 'b': |
590 | bindto = optarg; | |
591 | break; | |
592 | case 'p': | |
48bec07e | 593 | port = optarg; |
7a5ca864 FB |
594 | break; |
595 | case 'o': | |
596 | dev_offset = strtoll (optarg, &end, 0); | |
597 | if (*end) { | |
85b01e09 MA |
598 | error_report("Invalid offset `%s'", optarg); |
599 | exit(EXIT_FAILURE); | |
7a5ca864 FB |
600 | } |
601 | if (dev_offset < 0) { | |
85b01e09 MA |
602 | error_report("Offset must be positive `%s'", optarg); |
603 | exit(EXIT_FAILURE); | |
7a5ca864 FB |
604 | } |
605 | break; | |
8c116b0e WX |
606 | case 'l': |
607 | if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) { | |
70b94331 MA |
608 | sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts, |
609 | optarg, false); | |
8c116b0e | 610 | if (!sn_opts) { |
85b01e09 MA |
611 | error_report("Failed in parsing snapshot param `%s'", |
612 | optarg); | |
613 | exit(EXIT_FAILURE); | |
8c116b0e WX |
614 | } |
615 | } else { | |
616 | sn_id_or_name = optarg; | |
617 | } | |
618 | /* fall through */ | |
7a5ca864 | 619 | case 'r': |
b90fb4b8 | 620 | nbdflags |= NBD_FLAG_READ_ONLY; |
07108b29 | 621 | flags &= ~BDRV_O_RDWR; |
7a5ca864 FB |
622 | break; |
623 | case 'P': | |
624 | partition = strtol(optarg, &end, 0); | |
713cc671 | 625 | if (*end) { |
85b01e09 MA |
626 | error_report("Invalid partition `%s'", optarg); |
627 | exit(EXIT_FAILURE); | |
713cc671 PL |
628 | } |
629 | if (partition < 1 || partition > 8) { | |
85b01e09 MA |
630 | error_report("Invalid partition %d", partition); |
631 | exit(EXIT_FAILURE); | |
713cc671 | 632 | } |
7a5ca864 | 633 | break; |
cd831bd7 | 634 | case 'k': |
b32f6c28 | 635 | sockpath = optarg; |
713cc671 | 636 | if (sockpath[0] != '/') { |
9af9e0fe | 637 | error_report("socket path must be absolute"); |
85b01e09 | 638 | exit(EXIT_FAILURE); |
713cc671 | 639 | } |
cd831bd7 TS |
640 | break; |
641 | case 'd': | |
642 | disconnect = true; | |
643 | break; | |
644 | case 'c': | |
645 | device = optarg; | |
646 | break; | |
3b05a8e9 TS |
647 | case 'e': |
648 | shared = strtol(optarg, &end, 0); | |
649 | if (*end) { | |
85b01e09 MA |
650 | error_report("Invalid shared device number '%s'", optarg); |
651 | exit(EXIT_FAILURE); | |
3b05a8e9 TS |
652 | } |
653 | if (shared < 1) { | |
9af9e0fe | 654 | error_report("Shared device number must be greater than 0"); |
85b01e09 | 655 | exit(EXIT_FAILURE); |
3b05a8e9 TS |
656 | } |
657 | break; | |
e6b63677 DB |
658 | case 'f': |
659 | fmt = optarg; | |
660 | break; | |
713cc671 PL |
661 | case 't': |
662 | persistent = 1; | |
663 | break; | |
3d4b2f9c DB |
664 | case 'x': |
665 | export_name = optarg; | |
666 | break; | |
7a5ca864 FB |
667 | case 'v': |
668 | verbose = 1; | |
669 | break; | |
670 | case 'V': | |
671 | version(argv[0]); | |
672 | exit(0); | |
673 | break; | |
674 | case 'h': | |
675 | usage(argv[0]); | |
676 | exit(0); | |
677 | break; | |
678 | case '?': | |
85b01e09 MA |
679 | error_report("Try `%s --help' for more information.", argv[0]); |
680 | exit(EXIT_FAILURE); | |
0ab3b337 DB |
681 | case QEMU_NBD_OPT_OBJECT: { |
682 | QemuOpts *opts; | |
683 | opts = qemu_opts_parse_noisily(&qemu_object_opts, | |
684 | optarg, true); | |
685 | if (!opts) { | |
686 | exit(EXIT_FAILURE); | |
687 | } | |
688 | } break; | |
145614a1 DB |
689 | case QEMU_NBD_OPT_TLSCREDS: |
690 | tlscredsid = optarg; | |
691 | break; | |
77c9aaef DB |
692 | case QEMU_NBD_OPT_IMAGE_OPTS: |
693 | imageOpts = true; | |
694 | break; | |
7a5ca864 FB |
695 | } |
696 | } | |
697 | ||
698 | if ((argc - optind) != 1) { | |
433672b0 MA |
699 | error_report("Invalid number of arguments"); |
700 | error_printf("Try `%s --help' for more information.\n", argv[0]); | |
85b01e09 | 701 | exit(EXIT_FAILURE); |
7a5ca864 FB |
702 | } |
703 | ||
0ab3b337 DB |
704 | if (qemu_opts_foreach(&qemu_object_opts, |
705 | user_creatable_add_opts_foreach, | |
706 | NULL, &local_err)) { | |
707 | error_report_err(local_err); | |
708 | exit(EXIT_FAILURE); | |
709 | } | |
710 | ||
145614a1 DB |
711 | if (tlscredsid) { |
712 | if (sockpath) { | |
713 | error_report("TLS is only supported with IPv4/IPv6"); | |
714 | exit(EXIT_FAILURE); | |
715 | } | |
716 | if (device) { | |
717 | error_report("TLS is not supported with a host device"); | |
718 | exit(EXIT_FAILURE); | |
719 | } | |
720 | if (!export_name) { | |
721 | /* Set the default NBD protocol export name, since | |
722 | * we *must* use new style protocol for TLS */ | |
723 | export_name = ""; | |
724 | } | |
725 | tlscreds = nbd_get_tls_creds(tlscredsid, &local_err); | |
726 | if (local_err) { | |
727 | error_report("Failed to get TLS creds %s", | |
728 | error_get_pretty(local_err)); | |
729 | exit(EXIT_FAILURE); | |
730 | } | |
731 | } | |
732 | ||
cd831bd7 | 733 | if (disconnect) { |
d0d6ff58 DB |
734 | int nbdfd = open(argv[optind], O_RDWR); |
735 | if (nbdfd < 0) { | |
85b01e09 MA |
736 | error_report("Cannot open %s: %s", argv[optind], |
737 | strerror(errno)); | |
738 | exit(EXIT_FAILURE); | |
fc19f8a0 | 739 | } |
d0d6ff58 | 740 | nbd_disconnect(nbdfd); |
cd831bd7 | 741 | |
d0d6ff58 | 742 | close(nbdfd); |
cd831bd7 TS |
743 | |
744 | printf("%s disconnected\n", argv[optind]); | |
745 | ||
713cc671 | 746 | return 0; |
cd831bd7 TS |
747 | } |
748 | ||
c1f8fdc3 PB |
749 | if (device && !verbose) { |
750 | int stderr_fd[2]; | |
751 | pid_t pid; | |
752 | int ret; | |
753 | ||
fc19f8a0 | 754 | if (qemu_pipe(stderr_fd) < 0) { |
85b01e09 MA |
755 | error_report("Error setting up communication pipe: %s", |
756 | strerror(errno)); | |
757 | exit(EXIT_FAILURE); | |
c1f8fdc3 PB |
758 | } |
759 | ||
760 | /* Now daemonize, but keep a communication channel open to | |
761 | * print errors and exit with the proper status code. | |
762 | */ | |
763 | pid = fork(); | |
70d4739e | 764 | if (pid < 0) { |
85b01e09 MA |
765 | error_report("Failed to fork: %s", strerror(errno)); |
766 | exit(EXIT_FAILURE); | |
70d4739e | 767 | } else if (pid == 0) { |
c1f8fdc3 | 768 | close(stderr_fd[0]); |
9faf31b6 | 769 | ret = qemu_daemon(1, 0); |
c1f8fdc3 PB |
770 | |
771 | /* Temporarily redirect stderr to the parent's pipe... */ | |
772 | dup2(stderr_fd[1], STDERR_FILENO); | |
fc19f8a0 | 773 | if (ret < 0) { |
85b01e09 MA |
774 | error_report("Failed to daemonize: %s", strerror(errno)); |
775 | exit(EXIT_FAILURE); | |
c1f8fdc3 PB |
776 | } |
777 | ||
778 | /* ... close the descriptor we inherited and go on. */ | |
779 | close(stderr_fd[1]); | |
780 | } else { | |
781 | bool errors = false; | |
782 | char *buf; | |
783 | ||
784 | /* In the parent. Print error messages from the child until | |
785 | * it closes the pipe. | |
786 | */ | |
787 | close(stderr_fd[1]); | |
788 | buf = g_malloc(1024); | |
789 | while ((ret = read(stderr_fd[0], buf, 1024)) > 0) { | |
790 | errors = true; | |
791 | ret = qemu_write_full(STDERR_FILENO, buf, ret); | |
fc19f8a0 | 792 | if (ret < 0) { |
c1f8fdc3 PB |
793 | exit(EXIT_FAILURE); |
794 | } | |
795 | } | |
fc19f8a0 | 796 | if (ret < 0) { |
85b01e09 MA |
797 | error_report("Cannot read from daemon: %s", |
798 | strerror(errno)); | |
799 | exit(EXIT_FAILURE); | |
c1f8fdc3 PB |
800 | } |
801 | ||
802 | /* Usually the daemon should not print any message. | |
803 | * Exit with zero status in that case. | |
804 | */ | |
805 | exit(errors); | |
806 | } | |
807 | } | |
808 | ||
a6ac2313 PB |
809 | if (device != NULL && sockpath == NULL) { |
810 | sockpath = g_malloc(128); | |
811 | snprintf(sockpath, 128, SOCKET_PATH, basename(device)); | |
cd831bd7 TS |
812 | } |
813 | ||
48bec07e DB |
814 | saddr = nbd_build_socket_address(sockpath, bindto, port); |
815 | ||
2f78e491 | 816 | if (qemu_init_main_loop(&local_err)) { |
565f65d2 | 817 | error_report_err(local_err); |
2f78e491 CN |
818 | exit(EXIT_FAILURE); |
819 | } | |
802ddc37 PB |
820 | bdrv_init(); |
821 | atexit(bdrv_close_all); | |
822 | ||
77c9aaef DB |
823 | srcpath = argv[optind]; |
824 | if (imageOpts) { | |
825 | QemuOpts *opts; | |
826 | if (fmt) { | |
827 | error_report("--image-opts and -f are mutually exclusive"); | |
828 | exit(EXIT_FAILURE); | |
829 | } | |
830 | opts = qemu_opts_parse_noisily(&file_opts, srcpath, true); | |
831 | if (!opts) { | |
832 | qemu_opts_reset(&file_opts); | |
833 | exit(EXIT_FAILURE); | |
834 | } | |
835 | options = qemu_opts_to_qdict(opts, NULL); | |
836 | qemu_opts_reset(&file_opts); | |
efaa7c4e | 837 | blk = blk_new_open(NULL, NULL, options, flags, &local_err); |
77c9aaef DB |
838 | } else { |
839 | if (fmt) { | |
840 | options = qdict_new(); | |
841 | qdict_put(options, "driver", qstring_from_str(fmt)); | |
842 | } | |
efaa7c4e | 843 | blk = blk_new_open(srcpath, NULL, options, flags, &local_err); |
e6b63677 DB |
844 | } |
845 | ||
4fbec260 | 846 | if (!blk) { |
c29b77f9 MA |
847 | error_reportf_err(local_err, "Failed to blk_new_open '%s': ", |
848 | argv[optind]); | |
85b01e09 | 849 | exit(EXIT_FAILURE); |
802ddc37 | 850 | } |
4fbec260 | 851 | bs = blk_bs(blk); |
802ddc37 | 852 | |
6effd5bf KW |
853 | blk_set_enable_write_cache(blk, !writethrough); |
854 | ||
8c116b0e WX |
855 | if (sn_opts) { |
856 | ret = bdrv_snapshot_load_tmp(bs, | |
857 | qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID), | |
858 | qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME), | |
859 | &local_err); | |
860 | } else if (sn_id_or_name) { | |
861 | ret = bdrv_snapshot_load_tmp_by_id_or_name(bs, sn_id_or_name, | |
862 | &local_err); | |
863 | } | |
864 | if (ret < 0) { | |
c29b77f9 | 865 | error_reportf_err(local_err, "Failed to load snapshot: "); |
85b01e09 | 866 | exit(EXIT_FAILURE); |
8c116b0e WX |
867 | } |
868 | ||
b3838a40 | 869 | bs->detect_zeroes = detect_zeroes; |
4c58e80a | 870 | fd_size = blk_getlength(blk); |
98f44bbe | 871 | if (fd_size < 0) { |
85b01e09 MA |
872 | error_report("Failed to determine the image length: %s", |
873 | strerror(-fd_size)); | |
874 | exit(EXIT_FAILURE); | |
98f44bbe | 875 | } |
802ddc37 | 876 | |
185b4338 | 877 | if (partition != -1) { |
4c58e80a | 878 | ret = find_partition(blk, partition, &dev_offset, &fd_size); |
185b4338 | 879 | if (ret < 0) { |
85b01e09 | 880 | error_report("Could not find partition %d: %s", partition, |
a4699e55 | 881 | strerror(-ret)); |
85b01e09 | 882 | exit(EXIT_FAILURE); |
185b4338 | 883 | } |
802ddc37 PB |
884 | } |
885 | ||
98f44bbe HR |
886 | exp = nbd_export_new(blk, dev_offset, fd_size, nbdflags, nbd_export_closed, |
887 | &local_err); | |
888 | if (!exp) { | |
4fffeb5e | 889 | error_report_err(local_err); |
85b01e09 | 890 | exit(EXIT_FAILURE); |
98f44bbe | 891 | } |
3d4b2f9c DB |
892 | if (export_name) { |
893 | nbd_export_set_name(exp, export_name); | |
894 | newproto = true; | |
895 | } | |
3b05a8e9 | 896 | |
d0d6ff58 DB |
897 | server_ioc = qio_channel_socket_new(); |
898 | if (qio_channel_socket_listen_sync(server_ioc, saddr, &local_err) < 0) { | |
899 | object_unref(OBJECT(server_ioc)); | |
48bec07e | 900 | error_report_err(local_err); |
7a5ca864 | 901 | return 1; |
a61c6782 | 902 | } |
f1ef5555 PB |
903 | |
904 | if (device) { | |
905 | int ret; | |
906 | ||
a6ac2313 | 907 | ret = pthread_create(&client_thread, NULL, nbd_client_thread, device); |
f1ef5555 | 908 | if (ret != 0) { |
85b01e09 MA |
909 | error_report("Failed to create client thread: %s", strerror(ret)); |
910 | exit(EXIT_FAILURE); | |
f1ef5555 PB |
911 | } |
912 | } else { | |
913 | /* Shut up GCC warnings. */ | |
914 | memset(&client_thread, 0, sizeof(client_thread)); | |
915 | } | |
916 | ||
d0d6ff58 | 917 | nbd_update_server_watch(); |
7a5ca864 | 918 | |
9faf31b6 MT |
919 | /* now when the initialization is (almost) complete, chdir("/") |
920 | * to free any busy filesystems */ | |
921 | if (chdir("/") < 0) { | |
85b01e09 MA |
922 | error_report("Could not chdir to root directory: %s", |
923 | strerror(errno)); | |
924 | exit(EXIT_FAILURE); | |
9faf31b6 MT |
925 | } |
926 | ||
7860a380 | 927 | state = RUNNING; |
3b05a8e9 | 928 | do { |
a61c6782 | 929 | main_loop_wait(false); |
7860a380 PB |
930 | if (state == TERMINATE) { |
931 | state = TERMINATING; | |
932 | nbd_export_close(exp); | |
933 | nbd_export_put(exp); | |
934 | exp = NULL; | |
935 | } | |
936 | } while (state != TERMINATED); | |
7a5ca864 | 937 | |
26f54e9a | 938 | blk_unref(blk); |
b32f6c28 PB |
939 | if (sockpath) { |
940 | unlink(sockpath); | |
941 | } | |
7a5ca864 | 942 | |
fbf28a43 | 943 | qemu_opts_del(sn_opts); |
8c116b0e | 944 | |
a517e88b PB |
945 | if (device) { |
946 | void *ret; | |
947 | pthread_join(client_thread, &ret); | |
948 | exit(ret != NULL); | |
949 | } else { | |
950 | exit(EXIT_SUCCESS); | |
951 | } | |
7a5ca864 | 952 | } |