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