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