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