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