blob: 4aa005004ebd58f63e30aa984e00de2ece2106bc [file] [log] [blame]
thscd831bd2008-07-03 10:23:51 +00001/*
bellard7a5ca862008-05-27 21:13:40 +00002 * 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
Blue Swirl8167ee82009-07-16 20:47:01 +000016 * along with this program; if not, see <http://www.gnu.org/licenses/>.
bellard7a5ca862008-05-27 21:13:40 +000017 */
18
Peter Maydelld38ea872016-01-29 17:50:05 +000019#include "qemu/osdep.h"
Eric Blakec2a3d7d2017-07-21 08:50:47 -050020#include <getopt.h>
21#include <libgen.h>
22#include <pthread.h>
23
Markus Armbrustera8d25322019-05-23 16:35:08 +020024#include "qemu-common.h"
Markus Armbrusterda34e652016-03-14 09:01:28 +010025#include "qapi/error.h"
Veronia Bahaaf348b6d2016-03-20 19:16:19 +020026#include "qemu/cutils.h"
Markus Armbruster26f54e92014-10-07 13:59:04 +020027#include "sysemu/block-backend.h"
Peter Lievenb3838a42014-08-13 19:20:18 +020028#include "block/block_int.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010029#include "block/nbd.h"
Alex Bligh6a1751b2013-08-21 16:02:47 +010030#include "qemu/main-loop.h"
Markus Armbruster0b8fa322019-05-23 16:35:07 +020031#include "qemu/module.h"
Markus Armbruster922a01a2018-02-01 12:18:46 +010032#include "qemu/option.h"
Paolo Bonzini537b41f2014-02-17 14:43:51 +010033#include "qemu/error-report.h"
Daniel P. Berrange0ab3b332016-02-10 18:41:00 +000034#include "qemu/config-file.h"
Paolo Bonzini58369e22016-03-15 17:22:36 +010035#include "qemu/bswap.h"
Denis V. Lunev39ca4632016-06-17 17:44:12 +030036#include "qemu/log.h"
Paolo Bonzini53fabd42017-03-16 16:29:45 +010037#include "qemu/systemd.h"
Wenchao Xia8c116b02013-12-04 17:10:55 +080038#include "block/snapshot.h"
Markus Armbruster452fcdb2018-02-01 12:18:39 +010039#include "qapi/qmp/qdict.h"
Markus Armbrusterd49b6832015-03-17 18:29:20 +010040#include "qapi/qmp/qstring.h"
Daniel P. Berrange0ab3b332016-02-10 18:41:00 +000041#include "qom/object_interfaces.h"
Daniel P. Berranged0d6ff52016-02-10 18:41:02 +000042#include "io/channel-socket.h"
Daniel P. Berrangee4849c12017-12-18 10:16:43 +000043#include "io/net-listener.h"
Daniel P. Berrangec2297082016-04-06 12:12:06 +010044#include "crypto/init.h"
Denis V. Lunev39ca4632016-06-17 17:44:12 +030045#include "trace/control.h"
Eric Blakebe377132017-07-21 08:50:46 -050046#include "qemu-version.h"
bellard7a5ca862008-05-27 21:13:40 +000047
Eric Blake3c1fa352018-12-15 07:53:08 -060048#ifdef __linux__
49#define HAVE_NBD_DEVICE 1
50#else
51#define HAVE_NBD_DEVICE 0
52#endif
53
Peter Lieven713cc672014-08-13 19:20:19 +020054#define SOCKET_PATH "/var/lock/qemu-nbd-%s"
Daniel P. Berrangefa8b7ce2016-02-17 10:10:21 +000055#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
Max Reitzffb31e12016-09-28 22:46:42 +020062#define QEMU_NBD_OPT_FORK 263
Daniel P. Berrangeb25e12d2019-02-27 16:20:33 +000063#define QEMU_NBD_OPT_TLSAUTHZ 264
Max Reitz637bc5a2019-05-08 23:18:16 +020064#define QEMU_NBD_OPT_PID_FILE 265
bellard7a5ca862008-05-27 21:13:40 +000065
Eric Blakebd31c212016-05-06 10:26:42 -060066#define MBR_SIZE 512
67
Philippe Mathieu-Daudé9d976582019-01-11 17:35:19 +010068static NBDExport *export;
blueswir1b1d8e522008-10-26 13:43:07 +000069static int verbose;
Paolo Bonzinia517e882011-11-04 15:51:21 +010070static char *srcpath;
Markus Armbrusterbd269eb2017-04-26 09:36:41 +020071static SocketAddress *saddr;
Paolo Bonzini7860a382012-09-18 13:31:56 +020072static int persistent = 0;
73static enum { RUNNING, TERMINATE, TERMINATING, TERMINATED } state;
Paolo Bonzinia61c6782011-09-12 17:28:11 +020074static int shared = 1;
75static int nb_fds;
Daniel P. Berrangee4849c12017-12-18 10:16:43 +000076static QIONetListener *server;
Daniel P. Berrange145614a2016-02-10 18:41:13 +000077static QCryptoTLSCreds *tlscreds;
Daniel P. Berrangeb25e12d2019-02-27 16:20:33 +000078static const char *tlsauthz;
bellard7a5ca862008-05-27 21:13:40 +000079
80static void usage(const char *name)
81{
Paolo Bonzinib033cd82012-07-18 14:50:52 +020082 (printf) (
bellard7a5ca862008-05-27 21:13:40 +000083"Usage: %s [OPTIONS] FILE\n"
Eric Blake68b96f12019-01-17 13:36:56 -060084" or: %s -L [OPTIONS]\n"
85"QEMU Disk Network Block Device Utility\n"
bellard7a5ca862008-05-27 21:13:40 +000086"\n"
Peter Lieven713cc672014-08-13 19:20:19 +020087" -h, --help display this help and exit\n"
88" -V, --version output version information and exit\n"
bellard7a5ca862008-05-27 21:13:40 +000089"\n"
Paolo Bonzinib033cd82012-07-18 14:50:52 +020090"Connection properties:\n"
Peter Lieven713cc672014-08-13 19:20:19 +020091" -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"
Vladimir Sementsov-Ogievskiyf5cd0bb2018-10-03 20:02:27 +030098" -x, --export-name=NAME expose export by name (default is empty string)\n"
99" -D, --description=TEXT export a human-readable description\n"
Paolo Bonzinib033cd82012-07-18 14:50:52 +0200100"\n"
101"Exposing part of the image:\n"
Peter Lieven713cc672014-08-13 19:20:19 +0200102" -o, --offset=OFFSET offset into the image\n"
Eric Blake636192c2019-01-11 13:47:20 -0600103" -B, --bitmap=NAME expose a persistent dirty bitmap\n"
Paolo Bonzinib033cd82012-07-18 14:50:52 +0200104"\n"
Daniel P. Berrange0ab3b332016-02-10 18:41:00 +0000105"General purpose options:\n"
Eric Blake68b96f12019-01-17 13:36:56 -0600106" -L, --list list exports available from another NBD server\n"
Daniel P. Berrange0ab3b332016-02-10 18:41:00 +0000107" --object type,id=ID,... define an object such as 'secret' for providing\n"
108" passwords and/or encryption keys\n"
Eric Blakef7812df2018-10-03 13:04:26 -0500109" --tls-creds=ID use id of an earlier --object to provide TLS\n"
Daniel P. Berrangeb25e12d2019-02-27 16:20:33 +0000110" --tls-authz=ID use id of an earlier --object to provide\n"
111" authorization\n"
Denis V. Lunev39ca4632016-06-17 17:44:12 +0300112" -T, --trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
113" specify tracing options\n"
Max Reitzffb31e12016-09-28 22:46:42 +0200114" --fork fork off the server process and exit the parent\n"
115" once the server is running\n"
Max Reitz637bc5a2019-05-08 23:18:16 +0200116" --pid-file=PATH store the server's process ID in the given file\n"
Eric Blake3c1fa352018-12-15 07:53:08 -0600117#if HAVE_NBD_DEVICE
118"\n"
Paolo Bonzinib033cd82012-07-18 14:50:52 +0200119"Kernel NBD client support:\n"
Peter Lieven713cc672014-08-13 19:20:19 +0200120" -c, --connect=DEV connect FILE to the local NBD device DEV\n"
121" -d, --disconnect disconnect the specified device\n"
Paolo Bonzinib033cd82012-07-18 14:50:52 +0200122#endif
123"\n"
124"Block device options:\n"
Peter Lieven713cc672014-08-13 19:20:19 +0200125" -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"
Wenchao Xia8c116b02013-12-04 17:10:55 +0800130" -l, --load-snapshot=SNAPSHOT_PARAM\n"
Peter Lieven713cc672014-08-13 19:20:19 +0200131" 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"
Aarushi Mehta76802742020-01-20 14:18:56 +0000137" --aio=MODE set AIO mode (native, io_uring or threads)\n"
Peter Lievenb3838a42014-08-13 19:20:18 +0200138" --discard=MODE set discard mode (ignore, unmap)\n"
Andrey Korolyov6883de62015-07-31 22:12:54 +0300139" --detect-zeroes=MODE set detect-zeroes mode (off, on, unmap)\n"
Daniel P. Berrange77c9aae2016-02-17 10:10:19 +0000140" --image-opts treat FILE as a full set of image options\n"
Paolo Bonzinib033cd82012-07-18 14:50:52 +0200141"\n"
Eric Blakef5048cb2017-08-03 11:33:53 -0500142QEMU_HELP_BOTTOM "\n"
Eric Blake68b96f12019-01-17 13:36:56 -0600143 , name, name, NBD_DEFAULT_PORT, "DEVICE");
bellard7a5ca862008-05-27 21:13:40 +0000144}
145
146static void version(const char *name)
147{
148 printf(
Thomas Huth7e563bf2018-02-15 12:06:47 +0100149"%s " QEMU_FULL_VERSION "\n"
bellard7a5ca862008-05-27 21:13:40 +0000150"Written by Anthony Liguori.\n"
151"\n"
Eric Blakebe377132017-07-21 08:50:46 -0500152QEMU_COPYRIGHT "\n"
bellard7a5ca862008-05-27 21:13:40 +0000153"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"
ths315bc7a2008-07-18 18:06:23 +0000155 , name);
bellard7a5ca862008-05-27 21:13:40 +0000156}
157
Paolo Bonzinibb345112011-11-04 15:51:19 +0100158static void termsig_handler(int signum)
159{
Pavel Butsykin23994a52016-04-14 13:20:15 +0300160 atomic_cmpxchg(&state, RUNNING, TERMINATE);
Paolo Bonzinia61c6782011-09-12 17:28:11 +0200161 qemu_notify_event();
Paolo Bonzinibb345112011-11-04 15:51:19 +0100162}
163
Paolo Bonzini537b41f2014-02-17 14:43:51 +0100164
Eric Blake68b96f12019-01-17 13:36:56 -0600165static 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) {
Max Reitzc4e2aff2019-04-05 21:16:35 +0200195 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",
Eric Blake0a479542019-08-23 09:37:23 -0500206 [NBD_FLAG_SEND_FAST_ZERO_BIT] = "fast-zero",
Max Reitzc4e2aff2019-04-05 21:16:35 +0200207 };
208
Eric Blake68b96f12019-01-17 13:36:56 -0600209 printf(" size: %" PRIu64 "\n", list[i].size);
210 printf(" flags: 0x%x (", list[i].flags);
Max Reitzc4e2aff2019-04-05 21:16:35 +0200211 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 }
Eric Blake68b96f12019-01-17 13:36:56 -0600215 }
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
Eric Blake3c1fa352018-12-15 07:53:08 -0600239#if HAVE_NBD_DEVICE
Paolo Bonzinia517e882011-11-04 15:51:21 +0100240static void *show_parts(void *arg)
thscd831bd2008-07-03 10:23:51 +0000241{
Paolo Bonzinia6ac2312011-12-06 09:07:00 +0100242 char *device = arg;
Paolo Bonzinia517e882011-11-04 15:51:21 +0100243 int nbd;
thscd831bd2008-07-03 10:23:51 +0000244
Paolo Bonzinia517e882011-11-04 15:51:21 +0100245 /* 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);
Paolo Bonzinifc19f8a2012-03-07 11:05:34 +0100251 if (nbd >= 0) {
Paolo Bonzinia517e882011-11-04 15:51:21 +0100252 close(nbd);
thscd831bd2008-07-03 10:23:51 +0000253 }
Paolo Bonzinia517e882011-11-04 15:51:21 +0100254 return NULL;
255}
256
257static void *nbd_client_thread(void *arg)
258{
Paolo Bonzinia6ac2312011-12-06 09:07:00 +0100259 char *device = arg;
Eric Blake6dc16672019-01-17 13:36:46 -0600260 NBDExportInfo info = { .request_sizes = false, .name = g_strdup("") };
Daniel P. Berranged0d6ff52016-02-10 18:41:02 +0000261 QIOChannelSocket *sioc;
262 int fd;
Paolo Bonzinia517e882011-11-04 15:51:21 +0100263 int ret;
264 pthread_t show_parts_thread;
Max Reitz1ce52842015-01-26 21:02:59 -0500265 Error *local_error = NULL;
Paolo Bonzinia517e882011-11-04 15:51:21 +0100266
Daniel P. Berranged0d6ff52016-02-10 18:41:02 +0000267 sioc = qio_channel_socket_new();
268 if (qio_channel_socket_connect_sync(sioc,
269 saddr,
270 &local_error) < 0) {
Daniel P. Berrange48bec072015-09-16 14:52:23 +0100271 error_report_err(local_error);
Stefan Hajnoczidc10e8b2012-01-05 13:16:07 +0000272 goto out;
273 }
Paolo Bonzinia517e882011-11-04 15:51:21 +0100274
Vladimir Sementsov-Ogievskiya8e2bb62019-06-18 14:43:21 +0300275 ret = nbd_receive_negotiate(NULL, QIO_CHANNEL(sioc),
Eric Blake004a89f2017-07-07 15:30:41 -0500276 NULL, NULL, NULL, &info, &local_error);
Paolo Bonzinifc19f8a2012-03-07 11:05:34 +0100277 if (ret < 0) {
Max Reitz1ce52842015-01-26 21:02:59 -0500278 if (local_error) {
Markus Armbruster78288672015-12-18 16:35:07 +0100279 error_report_err(local_error);
Max Reitz1ce52842015-01-26 21:02:59 -0500280 }
Paolo Bonzini0c544d72014-03-14 18:10:54 +0100281 goto out_socket;
Paolo Bonzinia517e882011-11-04 15:51:21 +0100282 }
283
Paolo Bonzinia6ac2312011-12-06 09:07:00 +0100284 fd = open(device, O_RDWR);
Paolo Bonzinifc19f8a2012-03-07 11:05:34 +0100285 if (fd < 0) {
Paolo Bonzinia6ac2312011-12-06 09:07:00 +0100286 /* Linux-only, we can use %m in printf. */
Markus Armbrusterb9884682015-12-18 16:35:18 +0100287 error_report("Failed to open %s: %m", device);
Paolo Bonzini0c544d72014-03-14 18:10:54 +0100288 goto out_socket;
Paolo Bonzinia6ac2312011-12-06 09:07:00 +0100289 }
290
Eric Blake004a89f2017-07-07 15:30:41 -0500291 ret = nbd_init(fd, sioc, &info, &local_error);
Paolo Bonzinifc19f8a2012-03-07 11:05:34 +0100292 if (ret < 0) {
Vladimir Sementsov-Ogievskiybe41c102017-05-26 14:09:13 +0300293 error_report_err(local_error);
Paolo Bonzini0c544d72014-03-14 18:10:54 +0100294 goto out_fd;
Paolo Bonzinia517e882011-11-04 15:51:21 +0100295 }
296
297 /* update partition table */
Paolo Bonzinia6ac2312011-12-06 09:07:00 +0100298 pthread_create(&show_parts_thread, NULL, show_parts, device);
Paolo Bonzinia517e882011-11-04 15:51:21 +0100299
Paolo Bonzinic1f8fdc2011-11-04 15:51:22 +0100300 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 }
Paolo Bonzinia517e882011-11-04 15:51:21 +0100307
308 ret = nbd_client(fd);
309 if (ret) {
Paolo Bonzini0c544d72014-03-14 18:10:54 +0100310 goto out_fd;
Paolo Bonzinia517e882011-11-04 15:51:21 +0100311 }
312 close(fd);
Daniel P. Berranged0d6ff52016-02-10 18:41:02 +0000313 object_unref(OBJECT(sioc));
Eric Blake6dc16672019-01-17 13:36:46 -0600314 g_free(info.name);
Paolo Bonzinia517e882011-11-04 15:51:21 +0100315 kill(getpid(), SIGTERM);
316 return (void *) EXIT_SUCCESS;
317
Paolo Bonzini0c544d72014-03-14 18:10:54 +0100318out_fd:
319 close(fd);
320out_socket:
Daniel P. Berranged0d6ff52016-02-10 18:41:02 +0000321 object_unref(OBJECT(sioc));
Paolo Bonzinia517e882011-11-04 15:51:21 +0100322out:
Eric Blake6dc16672019-01-17 13:36:46 -0600323 g_free(info.name);
Paolo Bonzinia517e882011-11-04 15:51:21 +0100324 kill(getpid(), SIGTERM);
325 return (void *) EXIT_FAILURE;
thscd831bd2008-07-03 10:23:51 +0000326}
Eric Blake3c1fa352018-12-15 07:53:08 -0600327#endif /* HAVE_NBD_DEVICE */
thscd831bd2008-07-03 10:23:51 +0000328
Fam Zhenge4afbf42015-05-19 10:50:59 +0000329static int nbd_can_accept(void)
Paolo Bonzinia61c6782011-09-12 17:28:11 +0200330{
Eric Blakedf8ad9f2017-05-26 22:04:21 -0500331 return state == RUNNING && nb_fds < shared;
Paolo Bonzinia61c6782011-09-12 17:28:11 +0200332}
333
Philippe Mathieu-Daudé9d976582019-01-11 17:35:19 +0100334static void nbd_export_closed(NBDExport *export)
Paolo Bonzini7860a382012-09-18 13:31:56 +0200335{
336 assert(state == TERMINATING);
337 state = TERMINATED;
338}
339
Daniel P. Berranged0d6ff52016-02-10 18:41:02 +0000340static void nbd_update_server_watch(void);
Fam Zhenge4afbf42015-05-19 10:50:59 +0000341
Eric Blake0c9390d2017-06-08 17:26:17 -0500342static void nbd_client_closed(NBDClient *client, bool negotiated)
Paolo Bonzinia61c6782011-09-12 17:28:11 +0200343{
Paolo Bonzini1743b512011-09-19 14:33:23 +0200344 nb_fds--;
Eric Blake0c9390d2017-06-08 17:26:17 -0500345 if (negotiated && nb_fds == 0 && !persistent && state == RUNNING) {
Paolo Bonzini7860a382012-09-18 13:31:56 +0200346 state = TERMINATE;
347 }
Daniel P. Berranged0d6ff52016-02-10 18:41:02 +0000348 nbd_update_server_watch();
Paolo Bonzini7860a382012-09-18 13:31:56 +0200349 nbd_client_put(client);
Paolo Bonzinia61c6782011-09-12 17:28:11 +0200350}
351
Daniel P. Berrangee4849c12017-12-18 10:16:43 +0000352static void nbd_accept(QIONetListener *listener, QIOChannelSocket *cioc,
353 gpointer opaque)
Paolo Bonzinia61c6782011-09-12 17:28:11 +0200354{
Paolo Bonzini7860a382012-09-18 13:31:56 +0200355 if (state >= TERMINATE) {
Daniel P. Berrangee4849c12017-12-18 10:16:43 +0000356 return;
Paolo Bonzini7860a382012-09-18 13:31:56 +0200357 }
358
Fam Zhengee7d7aa2016-01-14 16:41:01 +0800359 nb_fds++;
Daniel P. Berranged0d6ff52016-02-10 18:41:02 +0000360 nbd_update_server_watch();
Daniel P. Berrangeb25e12d2019-02-27 16:20:33 +0000361 nbd_client_new(cioc, tlscreds, tlsauthz, nbd_client_closed);
Paolo Bonzinia61c6782011-09-12 17:28:11 +0200362}
363
Daniel P. Berranged0d6ff52016-02-10 18:41:02 +0000364static void nbd_update_server_watch(void)
Fam Zhenge4afbf42015-05-19 10:50:59 +0000365{
366 if (nbd_can_accept()) {
Daniel P. Berrangee4849c12017-12-18 10:16:43 +0000367 qio_net_listener_set_client_func(server, nbd_accept, NULL, NULL);
Fam Zhenge4afbf42015-05-19 10:50:59 +0000368 } else {
Daniel P. Berrangee4849c12017-12-18 10:16:43 +0000369 qio_net_listener_set_client_func(server, NULL, NULL, NULL);
Fam Zhenge4afbf42015-05-19 10:50:59 +0000370 }
371}
372
Daniel P. Berrange48bec072015-09-16 14:52:23 +0100373
Markus Armbrusterbd269eb2017-04-26 09:36:41 +0200374static SocketAddress *nbd_build_socket_address(const char *sockpath,
Daniel P. Berrange48bec072015-09-16 14:52:23 +0100375 const char *bindto,
376 const char *port)
377{
Markus Armbrusterbd269eb2017-04-26 09:36:41 +0200378 SocketAddress *saddr;
Daniel P. Berrange48bec072015-09-16 14:52:23 +0100379
Markus Armbrusterbd269eb2017-04-26 09:36:41 +0200380 saddr = g_new0(SocketAddress, 1);
Daniel P. Berrange48bec072015-09-16 14:52:23 +0100381 if (sockpath) {
Markus Armbrusterbd269eb2017-04-26 09:36:41 +0200382 saddr->type = SOCKET_ADDRESS_TYPE_UNIX;
383 saddr->u.q_unix.path = g_strdup(sockpath);
Daniel P. Berrange48bec072015-09-16 14:52:23 +0100384 } else {
Eric Blake03992932016-03-03 09:16:48 -0700385 InetSocketAddress *inet;
Markus Armbrusterbd269eb2017-04-26 09:36:41 +0200386 saddr->type = SOCKET_ADDRESS_TYPE_INET;
387 inet = &saddr->u.inet;
Eric Blake03992932016-03-03 09:16:48 -0700388 inet->host = g_strdup(bindto);
Daniel P. Berrange48bec072015-09-16 14:52:23 +0100389 if (port) {
Eric Blake03992932016-03-03 09:16:48 -0700390 inet->port = g_strdup(port);
Daniel P. Berrange48bec072015-09-16 14:52:23 +0100391 } else {
Eric Blake03992932016-03-03 09:16:48 -0700392 inet->port = g_strdup_printf("%d", NBD_DEFAULT_PORT);
Daniel P. Berrange48bec072015-09-16 14:52:23 +0100393 }
394 }
395
396 return saddr;
397}
398
399
Daniel P. Berrange77c9aae2016-02-17 10:10:19 +0000400static 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
Daniel P. Berrange0ab3b332016-02-10 18:41:00 +0000410static 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
Kevin Wolf495bf892019-10-11 21:49:17 +0200419static 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}
Daniel P. Berrange0ab3b332016-02-10 18:41:00 +0000426
Daniel P. Berrange145614a2016-02-10 18:41:13 +0000427
Eric Blake68b96f12019-01-17 13:36:56 -0600428static QCryptoTLSCreds *nbd_get_tls_creds(const char *id, bool list,
429 Error **errp)
Daniel P. Berrange145614a2016-02-10 18:41:13 +0000430{
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
Eric Blake68b96f12019-01-17 13:36:56 -0600449 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 }
Daniel P. Berrange145614a2016-02-10 18:41:13 +0000461 }
462 object_ref(obj);
463 return creds;
464}
465
Richard W.M. Jonesa721f532017-02-04 10:03:17 +0000466static 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
Richard W.M. Jonesa721f532017-02-04 10:03:17 +0000477/*
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,
Eric Blake68b96f12019-01-17 13:36:56 -0600483 const char *port,
484 bool list)
Richard W.M. Jonesa721f532017-02-04 10:03:17 +0000485{
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
Eric Blake68b96f12019-01-17 13:36:56 -0600502 if (list) {
503 return "List mode is incompatible with socket activation";
504 }
505
Richard W.M. Jonesa721f532017-02-04 10:03:17 +0000506 return NULL;
507}
Daniel P. Berrange145614a2016-02-10 18:41:13 +0000508
Kevin Wolfb3b52992018-05-16 13:46:37 +0200509static void qemu_nbd_shutdown(void)
510{
511 job_cancel_sync_all();
512 bdrv_close_all();
513}
514
bellard7a5ca862008-05-27 21:13:40 +0000515int main(int argc, char **argv)
516{
Markus Armbruster26f54e92014-10-07 13:59:04 +0200517 BlockBackend *blk;
bellard7a5ca862008-05-27 21:13:40 +0000518 BlockDriverState *bs;
Eric Blake9d26dfc2019-01-17 13:36:43 -0600519 uint64_t dev_offset = 0;
Eric Blakedbb38ca2019-08-23 09:37:22 -0500520 bool readonly = false;
thscd831bd2008-07-03 10:23:51 +0000521 bool disconnect = false;
Richard W.M. Jonesa721f532017-02-04 10:03:17 +0000522 const char *bindto = NULL;
Daniel P. Berrange48bec072015-09-16 14:52:23 +0100523 const char *port = NULL;
524 char *sockpath = NULL;
Paolo Bonzinia6ac2312011-12-06 09:07:00 +0100525 char *device = NULL;
Eric Blake9d26dfc2019-01-17 13:36:43 -0600526 int64_t fd_size;
Wenchao Xia8c116b02013-12-04 17:10:55 +0800527 QemuOpts *sn_opts = NULL;
528 const char *sn_id_or_name = NULL;
Eric Blake0bc16992020-01-23 10:46:50 -0600529 const char *sopt = "hVb:o:p:rsnc:dvk:e:f:tl:x:T:D:B:L";
bellard7a5ca862008-05-27 21:13:40 +0000530 struct option lopt[] = {
Daniel P. Berrangeaa6e5462016-02-17 10:10:22 +0000531 { "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' },
Eric Blake636192c2019-01-11 13:47:20 -0600538 { "bitmap", required_argument, NULL, 'B' },
Daniel P. Berrangeaa6e5462016-02-17 10:10:22 +0000539 { "connect", required_argument, NULL, 'c' },
540 { "disconnect", no_argument, NULL, 'd' },
Eric Blake68b96f12019-01-17 13:36:56 -0600541 { "list", no_argument, NULL, 'L' },
Daniel P. Berrangeaa6e5462016-02-17 10:10:22 +0000542 { "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' },
Eric Blakeb1a75b32016-10-14 13:33:03 -0500556 { "description", required_argument, NULL, 'D' },
Daniel P. Berrangeaa6e5462016-02-17 10:10:22 +0000557 { "tls-creds", required_argument, NULL, QEMU_NBD_OPT_TLSCREDS },
Daniel P. Berrangeb25e12d2019-02-27 16:20:33 +0000558 { "tls-authz", required_argument, NULL, QEMU_NBD_OPT_TLSAUTHZ },
Daniel P. Berrangeaa6e5462016-02-17 10:10:22 +0000559 { "image-opts", no_argument, NULL, QEMU_NBD_OPT_IMAGE_OPTS },
Denis V. Lunev39ca4632016-06-17 17:44:12 +0300560 { "trace", required_argument, NULL, 'T' },
Max Reitzffb31e12016-09-28 22:46:42 +0200561 { "fork", no_argument, NULL, QEMU_NBD_OPT_FORK },
Max Reitz637bc5a2019-05-08 23:18:16 +0200562 { "pid-file", required_argument, NULL, QEMU_NBD_OPT_PID_FILE },
Blue Swirl660f11b2009-07-31 21:16:51 +0000563 { NULL, 0, NULL, 0 }
bellard7a5ca862008-05-27 21:13:40 +0000564 };
565 int ch;
566 int opt_ind = 0;
Naphtali Spreif5edb012010-01-17 16:48:13 +0200567 int flags = BDRV_O_RDWR;
Max Reitz4fbec262015-02-05 13:58:19 -0500568 int ret = 0;
Paolo Bonzini39a52352012-07-18 14:57:15 +0200569 bool seen_cache = false;
Paolo Bonzinided9d2d2013-02-08 14:06:13 +0100570 bool seen_discard = false;
Paolo Bonzini39a52352012-07-18 14:57:15 +0200571 bool seen_aio = false;
Paolo Bonzinia517e882011-11-04 15:51:21 +0100572 pthread_t client_thread;
Daniel P. Berrangee6b63672013-03-19 11:20:20 +0000573 const char *fmt = NULL;
Max Reitz34b5d2c2013-09-05 14:45:29 +0200574 Error *local_err = NULL;
Peter Lievenb3838a42014-08-13 19:20:18 +0200575 BlockdevDetectZeroesOptions detect_zeroes = BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
Max Reitz4fbec262015-02-05 13:58:19 -0500576 QDict *options = NULL;
Eric Blake68b96f12019-01-17 13:36:56 -0600577 const char *export_name = NULL; /* defaults to "" later for server mode */
Eric Blakeb1a75b32016-10-14 13:33:03 -0500578 const char *export_description = NULL;
Eric Blake636192c2019-01-11 13:47:20 -0600579 const char *bitmap = NULL;
Daniel P. Berrange145614a2016-02-10 18:41:13 +0000580 const char *tlscredsid = NULL;
Daniel P. Berrange77c9aae2016-02-17 10:10:19 +0000581 bool imageOpts = false;
Kevin Wolf6effd5b2016-03-14 11:43:28 +0100582 bool writethrough = true;
Denis V. Lunev39ca4632016-06-17 17:44:12 +0300583 char *trace_file = NULL;
Max Reitzffb31e12016-09-28 22:46:42 +0200584 bool fork_process = false;
Eric Blake68b96f12019-01-17 13:36:56 -0600585 bool list = false;
Max Reitzffb31e12016-09-28 22:46:42 +0200586 int old_stderr = -1;
Richard W.M. Jonesa721f532017-02-04 10:03:17 +0000587 unsigned socket_activation;
Max Reitz637bc5a2019-05-08 23:18:16 +0200588 const char *pid_file_name = NULL;
bellard7a5ca862008-05-27 21:13:40 +0000589
Paolo Bonzinia517e882011-11-04 15:51:21 +0100590 /* 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 */
Paolo Bonzinibb345112011-11-04 15:51:19 +0100593 struct sigaction sa_sigterm;
Paolo Bonzinibb345112011-11-04 15:51:19 +0100594 memset(&sa_sigterm, 0, sizeof(sa_sigterm));
595 sa_sigterm.sa_handler = termsig_handler;
596 sigaction(SIGTERM, &sa_sigterm, NULL);
Daniel P. Berrangec2297082016-04-06 12:12:06 +0100597
Max Reitz041e32b2017-06-11 14:37:14 +0200598#ifdef CONFIG_POSIX
599 signal(SIGPIPE, SIG_IGN);
600#endif
601
Christophe Fergeauf5852ef2019-01-31 17:46:14 +0100602 error_init(argv[0]);
Daniel P. Berrangefe4db842016-10-04 14:35:52 +0100603 module_call_init(MODULE_INIT_TRACE);
Eduardo Habkoste8f2d272016-05-12 11:10:04 -0300604 qcrypto_init(&error_fatal);
Daniel P. Berrangec2297082016-04-06 12:12:06 +0100605
Daniel P. Berrange0ab3b332016-02-10 18:41:00 +0000606 module_call_init(MODULE_INIT_QOM);
607 qemu_add_opts(&qemu_object_opts);
Denis V. Lunev39ca4632016-06-17 17:44:12 +0300608 qemu_add_opts(&qemu_trace_opts);
Fam Zheng10f5bff2014-02-10 14:48:51 +0800609 qemu_init_exec_dir(argv[0]);
Paolo Bonzinibb345112011-11-04 15:51:19 +0100610
bellard7a5ca862008-05-27 21:13:40 +0000611 while ((ch = getopt_long(argc, argv, sopt, lopt, &opt_ind)) != -1) {
612 switch (ch) {
613 case 's':
ths2f726482008-07-03 11:47:46 +0000614 flags |= BDRV_O_SNAPSHOT;
615 break;
616 case 'n':
Paolo Bonzini39a52352012-07-18 14:57:15 +0200617 optarg = (char *) "none";
618 /* fallthrough */
619 case QEMU_NBD_OPT_CACHE:
620 if (seen_cache) {
Markus Armbruster85b01e02015-12-18 16:35:04 +0100621 error_report("-n and --cache can only be specified once");
622 exit(EXIT_FAILURE);
Paolo Bonzini39a52352012-07-18 14:57:15 +0200623 }
624 seen_cache = true;
Kevin Wolf6effd5b2016-03-14 11:43:28 +0100625 if (bdrv_parse_cache_mode(optarg, &flags, &writethrough) == -1) {
Markus Armbruster85b01e02015-12-18 16:35:04 +0100626 error_report("Invalid cache mode `%s'", optarg);
627 exit(EXIT_FAILURE);
Paolo Bonzini39a52352012-07-18 14:57:15 +0200628 }
bellard7a5ca862008-05-27 21:13:40 +0000629 break;
Paolo Bonzini39a52352012-07-18 14:57:15 +0200630 case QEMU_NBD_OPT_AIO:
631 if (seen_aio) {
Markus Armbruster85b01e02015-12-18 16:35:04 +0100632 error_report("--aio can only be specified once");
633 exit(EXIT_FAILURE);
Paolo Bonzini39a52352012-07-18 14:57:15 +0200634 }
635 seen_aio = true;
Aarushi Mehta76802742020-01-20 14:18:56 +0000636 if (bdrv_parse_aio(optarg, &flags) < 0) {
637 error_report("Invalid aio mode '%s'", optarg);
638 exit(EXIT_FAILURE);
Paolo Bonzini39a52352012-07-18 14:57:15 +0200639 }
640 break;
Paolo Bonzinided9d2d2013-02-08 14:06:13 +0100641 case QEMU_NBD_OPT_DISCARD:
642 if (seen_discard) {
Markus Armbruster85b01e02015-12-18 16:35:04 +0100643 error_report("--discard can only be specified once");
644 exit(EXIT_FAILURE);
Paolo Bonzinided9d2d2013-02-08 14:06:13 +0100645 }
646 seen_discard = true;
647 if (bdrv_parse_discard_flags(optarg, &flags) == -1) {
Markus Armbruster85b01e02015-12-18 16:35:04 +0100648 error_report("Invalid discard mode `%s'", optarg);
649 exit(EXIT_FAILURE);
Paolo Bonzinided9d2d2013-02-08 14:06:13 +0100650 }
651 break;
Peter Lievenb3838a42014-08-13 19:20:18 +0200652 case QEMU_NBD_OPT_DETECT_ZEROES:
653 detect_zeroes =
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +0200654 qapi_enum_parse(&BlockdevDetectZeroesOptions_lookup,
Peter Lievenb3838a42014-08-13 19:20:18 +0200655 optarg,
Peter Lievenb3838a42014-08-13 19:20:18 +0200656 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
657 &local_err);
658 if (local_err) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +0100659 error_reportf_err(local_err,
660 "Failed to parse detect_zeroes mode: ");
Markus Armbruster85b01e02015-12-18 16:35:04 +0100661 exit(EXIT_FAILURE);
Peter Lievenb3838a42014-08-13 19:20:18 +0200662 }
663 if (detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP &&
664 !(flags & BDRV_O_UNMAP)) {
Markus Armbruster85b01e02015-12-18 16:35:04 +0100665 error_report("setting detect-zeroes to unmap is not allowed "
666 "without setting discard operation to unmap");
667 exit(EXIT_FAILURE);
Peter Lievenb3838a42014-08-13 19:20:18 +0200668 }
669 break;
bellard7a5ca862008-05-27 21:13:40 +0000670 case 'b':
671 bindto = optarg;
672 break;
673 case 'p':
Daniel P. Berrange48bec072015-09-16 14:52:23 +0100674 port = optarg;
bellard7a5ca862008-05-27 21:13:40 +0000675 break;
676 case 'o':
Eric Blake43b51012019-01-17 13:36:44 -0600677 if (qemu_strtou64(optarg, NULL, 0, &dev_offset) < 0) {
678 error_report("Invalid offset '%s'", optarg);
Markus Armbruster85b01e02015-12-18 16:35:04 +0100679 exit(EXIT_FAILURE);
bellard7a5ca862008-05-27 21:13:40 +0000680 }
bellard7a5ca862008-05-27 21:13:40 +0000681 break;
Wenchao Xia8c116b02013-12-04 17:10:55 +0800682 case 'l':
683 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
Markus Armbruster70b94332015-02-13 12:50:26 +0100684 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
685 optarg, false);
Wenchao Xia8c116b02013-12-04 17:10:55 +0800686 if (!sn_opts) {
Markus Armbruster85b01e02015-12-18 16:35:04 +0100687 error_report("Failed in parsing snapshot param `%s'",
688 optarg);
689 exit(EXIT_FAILURE);
Wenchao Xia8c116b02013-12-04 17:10:55 +0800690 }
691 } else {
692 sn_id_or_name = optarg;
693 }
694 /* fall through */
bellard7a5ca862008-05-27 21:13:40 +0000695 case 'r':
Eric Blakedbb38ca2019-08-23 09:37:22 -0500696 readonly = true;
Naphtali Sprei07108b22010-03-14 15:19:57 +0200697 flags &= ~BDRV_O_RDWR;
bellard7a5ca862008-05-27 21:13:40 +0000698 break;
Eric Blake636192c2019-01-11 13:47:20 -0600699 case 'B':
700 bitmap = optarg;
701 break;
thscd831bd2008-07-03 10:23:51 +0000702 case 'k':
Paolo Bonzinib32f6c22011-11-04 15:51:20 +0100703 sockpath = optarg;
Peter Lieven713cc672014-08-13 19:20:19 +0200704 if (sockpath[0] != '/') {
Markus Armbruster9af9e0f2015-12-18 16:35:19 +0100705 error_report("socket path must be absolute");
Markus Armbruster85b01e02015-12-18 16:35:04 +0100706 exit(EXIT_FAILURE);
Peter Lieven713cc672014-08-13 19:20:19 +0200707 }
thscd831bd2008-07-03 10:23:51 +0000708 break;
709 case 'd':
710 disconnect = true;
711 break;
712 case 'c':
713 device = optarg;
714 break;
ths3b05a8e2008-07-03 12:45:02 +0000715 case 'e':
Eric Blake43b51012019-01-17 13:36:44 -0600716 if (qemu_strtoi(optarg, NULL, 0, &shared) < 0 ||
717 shared < 1) {
Markus Armbruster85b01e02015-12-18 16:35:04 +0100718 error_report("Invalid shared device number '%s'", optarg);
719 exit(EXIT_FAILURE);
ths3b05a8e2008-07-03 12:45:02 +0000720 }
ths3b05a8e2008-07-03 12:45:02 +0000721 break;
Daniel P. Berrangee6b63672013-03-19 11:20:20 +0000722 case 'f':
723 fmt = optarg;
724 break;
Peter Lieven713cc672014-08-13 19:20:19 +0200725 case 't':
726 persistent = 1;
727 break;
Daniel P. Berrange3d4b2f92016-02-10 18:41:08 +0000728 case 'x':
729 export_name = optarg;
Eric Blake93676c82019-11-13 20:46:34 -0600730 if (strlen(export_name) > NBD_MAX_STRING_SIZE) {
731 error_report("export name '%s' too long", export_name);
732 exit(EXIT_FAILURE);
733 }
Daniel P. Berrange3d4b2f92016-02-10 18:41:08 +0000734 break;
Eric Blakeb1a75b32016-10-14 13:33:03 -0500735 case 'D':
736 export_description = optarg;
Eric Blake93676c82019-11-13 20:46:34 -0600737 if (strlen(export_description) > NBD_MAX_STRING_SIZE) {
738 error_report("export description '%s' too long",
739 export_description);
740 exit(EXIT_FAILURE);
741 }
Eric Blakeb1a75b32016-10-14 13:33:03 -0500742 break;
bellard7a5ca862008-05-27 21:13:40 +0000743 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 '?':
Markus Armbruster85b01e02015-12-18 16:35:04 +0100755 error_report("Try `%s --help' for more information.", argv[0]);
756 exit(EXIT_FAILURE);
Daniel P. Berrange0ab3b332016-02-10 18:41:00 +0000757 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;
Daniel P. Berrange145614a2016-02-10 18:41:13 +0000765 case QEMU_NBD_OPT_TLSCREDS:
766 tlscredsid = optarg;
767 break;
Daniel P. Berrange77c9aae2016-02-17 10:10:19 +0000768 case QEMU_NBD_OPT_IMAGE_OPTS:
769 imageOpts = true;
770 break;
Denis V. Lunev39ca4632016-06-17 17:44:12 +0300771 case 'T':
772 g_free(trace_file);
773 trace_file = trace_opt_parse(optarg);
774 break;
Daniel P. Berrangeb25e12d2019-02-27 16:20:33 +0000775 case QEMU_NBD_OPT_TLSAUTHZ:
776 tlsauthz = optarg;
777 break;
Max Reitzffb31e12016-09-28 22:46:42 +0200778 case QEMU_NBD_OPT_FORK:
779 fork_process = true;
780 break;
Eric Blake68b96f12019-01-17 13:36:56 -0600781 case 'L':
782 list = true;
783 break;
Max Reitz637bc5a2019-05-08 23:18:16 +0200784 case QEMU_NBD_OPT_PID_FILE:
785 pid_file_name = optarg;
786 break;
bellard7a5ca862008-05-27 21:13:40 +0000787 }
788 }
789
Eric Blake68b96f12019-01-17 13:36:56 -0600790 if (list) {
791 if (argc != optind) {
792 error_report("List mode is incompatible with a file name");
793 exit(EXIT_FAILURE);
794 }
Eric Blake0bc16992020-01-23 10:46:50 -0600795 if (export_name || export_description || dev_offset ||
Eric Blake68b96f12019-01-17 13:36:56 -0600796 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) {
Markus Armbruster433672b2015-12-18 16:35:24 +0100806 error_report("Invalid number of arguments");
807 error_printf("Try `%s --help' for more information.\n", argv[0]);
Markus Armbruster85b01e02015-12-18 16:35:04 +0100808 exit(EXIT_FAILURE);
Eric Blake68b96f12019-01-17 13:36:56 -0600809 } else if (!export_name) {
810 export_name = "";
bellard7a5ca862008-05-27 21:13:40 +0000811 }
812
Markus Armbruster7e1e0c12018-10-17 10:26:43 +0200813 qemu_opts_foreach(&qemu_object_opts,
814 user_creatable_add_opts_foreach,
Kevin Wolf495bf892019-10-11 21:49:17 +0200815 qemu_nbd_object_print_help, &error_fatal);
Daniel P. Berrange0ab3b332016-02-10 18:41:00 +0000816
Denis V. Lunev39ca4632016-06-17 17:44:12 +0300817 if (!trace_init_backends()) {
818 exit(1);
819 }
820 trace_init_file(trace_file);
821 qemu_set_log(LOG_TRACE);
822
Richard W.M. Jonesa721f532017-02-04 10:03:17 +0000823 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,
Eric Blake68b96f12019-01-17 13:36:56 -0600829 bindto, port,
830 list);
Richard W.M. Jonesa721f532017-02-04 10:03:17 +0000831 if (err_msg != NULL) {
832 error_report("%s", err_msg);
833 exit(EXIT_FAILURE);
834 }
Paolo Bonzini53fabd42017-03-16 16:29:45 +0100835
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 }
Richard W.M. Jonesa721f532017-02-04 10:03:17 +0000842 }
843
Daniel P. Berrange145614a2016-02-10 18:41:13 +0000844 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 }
Daniel P. Berrangeb25e12d2019-02-27 16:20:33 +0000853 if (tlsauthz && list) {
854 error_report("TLS authorization is incompatible with export list");
855 exit(EXIT_FAILURE);
856 }
Eric Blake68b96f12019-01-17 13:36:56 -0600857 tlscreds = nbd_get_tls_creds(tlscredsid, list, &local_err);
Daniel P. Berrange145614a2016-02-10 18:41:13 +0000858 if (local_err) {
859 error_report("Failed to get TLS creds %s",
860 error_get_pretty(local_err));
861 exit(EXIT_FAILURE);
862 }
Daniel P. Berrangeb25e12d2019-02-27 16:20:33 +0000863 } else {
864 if (tlsauthz) {
865 error_report("--tls-authz is not permitted without --tls-creds");
866 exit(EXIT_FAILURE);
867 }
Daniel P. Berrange145614a2016-02-10 18:41:13 +0000868 }
869
Eric Blake68b96f12019-01-17 13:36:56 -0600870 if (list) {
871 saddr = nbd_build_socket_address(sockpath, bindto, port);
872 return qemu_nbd_client_list(saddr, tlscreds, bindto);
873 }
874
Eric Blake3c1fa352018-12-15 07:53:08 -0600875#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 */
thscd831bd2008-07-03 10:23:51 +0000881 if (disconnect) {
Daniel P. Berranged0d6ff52016-02-10 18:41:02 +0000882 int nbdfd = open(argv[optind], O_RDWR);
883 if (nbdfd < 0) {
Markus Armbruster85b01e02015-12-18 16:35:04 +0100884 error_report("Cannot open %s: %s", argv[optind],
885 strerror(errno));
886 exit(EXIT_FAILURE);
Paolo Bonzinifc19f8a2012-03-07 11:05:34 +0100887 }
Daniel P. Berranged0d6ff52016-02-10 18:41:02 +0000888 nbd_disconnect(nbdfd);
thscd831bd2008-07-03 10:23:51 +0000889
Daniel P. Berranged0d6ff52016-02-10 18:41:02 +0000890 close(nbdfd);
thscd831bd2008-07-03 10:23:51 +0000891
892 printf("%s disconnected\n", argv[optind]);
893
Peter Lieven713cc672014-08-13 19:20:19 +0200894 return 0;
thscd831bd2008-07-03 10:23:51 +0000895 }
Eric Blake3c1fa352018-12-15 07:53:08 -0600896#endif
thscd831bd2008-07-03 10:23:51 +0000897
Max Reitzffb31e12016-09-28 22:46:42 +0200898 if ((device && !verbose) || fork_process) {
Paolo Bonzinic1f8fdc2011-11-04 15:51:22 +0100899 int stderr_fd[2];
900 pid_t pid;
901 int ret;
902
Paolo Bonzinifc19f8a2012-03-07 11:05:34 +0100903 if (qemu_pipe(stderr_fd) < 0) {
Markus Armbruster85b01e02015-12-18 16:35:04 +0100904 error_report("Error setting up communication pipe: %s",
905 strerror(errno));
906 exit(EXIT_FAILURE);
Paolo Bonzinic1f8fdc2011-11-04 15:51:22 +0100907 }
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();
Max Reitz70d47392015-02-25 13:08:22 -0500913 if (pid < 0) {
Markus Armbruster85b01e02015-12-18 16:35:04 +0100914 error_report("Failed to fork: %s", strerror(errno));
915 exit(EXIT_FAILURE);
Max Reitz70d47392015-02-25 13:08:22 -0500916 } else if (pid == 0) {
Paolo Bonzinic1f8fdc2011-11-04 15:51:22 +0100917 close(stderr_fd[0]);
Max Reitze6df58a2019-05-08 23:18:18 +0200918
919 old_stderr = dup(STDERR_FILENO);
Michael Tokarev9faf31b2012-01-16 18:37:44 +0400920 ret = qemu_daemon(1, 0);
Paolo Bonzinic1f8fdc2011-11-04 15:51:22 +0100921
922 /* Temporarily redirect stderr to the parent's pipe... */
923 dup2(stderr_fd[1], STDERR_FILENO);
Paolo Bonzinifc19f8a2012-03-07 11:05:34 +0100924 if (ret < 0) {
Markus Armbruster85b01e02015-12-18 16:35:04 +0100925 error_report("Failed to daemonize: %s", strerror(errno));
926 exit(EXIT_FAILURE);
Paolo Bonzinic1f8fdc2011-11-04 15:51:22 +0100927 }
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);
Paolo Bonzinifc19f8a2012-03-07 11:05:34 +0100943 if (ret < 0) {
Paolo Bonzinic1f8fdc2011-11-04 15:51:22 +0100944 exit(EXIT_FAILURE);
945 }
946 }
Paolo Bonzinifc19f8a2012-03-07 11:05:34 +0100947 if (ret < 0) {
Markus Armbruster85b01e02015-12-18 16:35:04 +0100948 error_report("Cannot read from daemon: %s",
949 strerror(errno));
950 exit(EXIT_FAILURE);
Paolo Bonzinic1f8fdc2011-11-04 15:51:22 +0100951 }
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
Paolo Bonzinia6ac2312011-12-06 09:07:00 +0100960 if (device != NULL && sockpath == NULL) {
961 sockpath = g_malloc(128);
962 snprintf(sockpath, 128, SOCKET_PATH, basename(device));
thscd831bd2008-07-03 10:23:51 +0000963 }
964
Daniel P. Berrangee4849c12017-12-18 10:16:43 +0000965 server = qio_net_listener_new();
Richard W.M. Jonesa721f532017-02-04 10:03:17 +0000966 if (socket_activation == 0) {
Richard W.M. Jonesa721f532017-02-04 10:03:17 +0000967 saddr = nbd_build_socket_address(sockpath, bindto, port);
Juan Quintelafc8135c2019-08-19 18:08:21 +0200968 if (qio_net_listener_open_sync(server, saddr, 1, &local_err) < 0) {
Daniel P. Berrangee4849c12017-12-18 10:16:43 +0000969 object_unref(OBJECT(server));
Richard W.M. Jonesa721f532017-02-04 10:03:17 +0000970 error_report_err(local_err);
Daniel P. Berrangee4849c12017-12-18 10:16:43 +0000971 exit(EXIT_FAILURE);
Richard W.M. Jonesa721f532017-02-04 10:03:17 +0000972 }
973 } else {
Daniel P. Berrangee4849c12017-12-18 10:16:43 +0000974 size_t i;
Richard W.M. Jonesa721f532017-02-04 10:03:17 +0000975 /* See comment in check_socket_activation above. */
Daniel P. Berrangee4849c12017-12-18 10:16:43 +0000976 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));
Richard W.M. Jonesa721f532017-02-04 10:03:17 +0000988 }
989 }
Daniel P. Berrange48bec072015-09-16 14:52:23 +0100990
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +0300991 if (qemu_init_main_loop(&local_err)) {
Markus Armbruster565f65d2015-02-12 13:55:05 +0100992 error_report_err(local_err);
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +0300993 exit(EXIT_FAILURE);
994 }
Paolo Bonzini802ddc32011-11-04 15:51:24 +0100995 bdrv_init();
Kevin Wolfb3b52992018-05-16 13:46:37 +0200996 atexit(qemu_nbd_shutdown);
Paolo Bonzini802ddc32011-11-04 15:51:24 +0100997
Daniel P. Berrange77c9aae2016-02-17 10:10:19 +0000998 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);
Max Reitzefaa7c42016-03-16 19:54:38 +01001012 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
Daniel P. Berrange77c9aae2016-02-17 10:10:19 +00001013 } else {
1014 if (fmt) {
1015 options = qdict_new();
Eric Blake46f5ac22017-04-27 16:58:17 -05001016 qdict_put_str(options, "driver", fmt);
Daniel P. Berrange77c9aae2016-02-17 10:10:19 +00001017 }
Max Reitzefaa7c42016-03-16 19:54:38 +01001018 blk = blk_new_open(srcpath, NULL, options, flags, &local_err);
Daniel P. Berrangee6b63672013-03-19 11:20:20 +00001019 }
1020
Max Reitz4fbec262015-02-05 13:58:19 -05001021 if (!blk) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01001022 error_reportf_err(local_err, "Failed to blk_new_open '%s': ",
1023 argv[optind]);
Markus Armbruster85b01e02015-12-18 16:35:04 +01001024 exit(EXIT_FAILURE);
Paolo Bonzini802ddc32011-11-04 15:51:24 +01001025 }
Max Reitz4fbec262015-02-05 13:58:19 -05001026 bs = blk_bs(blk);
Paolo Bonzini802ddc32011-11-04 15:51:24 +01001027
Kevin Wolf6effd5b2016-03-14 11:43:28 +01001028 blk_set_enable_write_cache(blk, !writethrough);
1029
Wenchao Xia8c116b02013-12-04 17:10:55 +08001030 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) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01001040 error_reportf_err(local_err, "Failed to load snapshot: ");
Markus Armbruster85b01e02015-12-18 16:35:04 +01001041 exit(EXIT_FAILURE);
Wenchao Xia8c116b02013-12-04 17:10:55 +08001042 }
1043
Peter Lievenb3838a42014-08-13 19:20:18 +02001044 bs->detect_zeroes = detect_zeroes;
Max Reitz4c58e802014-11-18 12:21:19 +01001045 fd_size = blk_getlength(blk);
Max Reitz98f44bb2015-02-25 13:08:21 -05001046 if (fd_size < 0) {
Markus Armbruster85b01e02015-12-18 16:35:04 +01001047 error_report("Failed to determine the image length: %s",
1048 strerror(-fd_size));
1049 exit(EXIT_FAILURE);
Max Reitz98f44bb2015-02-25 13:08:21 -05001050 }
Paolo Bonzini802ddc32011-11-04 15:51:24 +01001051
Tomáš Golembiovskýe424b652016-10-05 23:40:20 +02001052 if (dev_offset >= fd_size) {
Eric Blake9d26dfc2019-01-17 13:36:43 -06001053 error_report("Offset (%" PRIu64 ") has to be smaller than the image "
1054 "size (%" PRId64 ")", dev_offset, fd_size);
Tomáš Golembiovskýe424b652016-10-05 23:40:20 +02001055 exit(EXIT_FAILURE);
1056 }
1057 fd_size -= dev_offset;
1058
Eric Blake3fa4c762019-01-11 13:47:16 -06001059 export = nbd_export_new(bs, dev_offset, fd_size, export_name,
Eric Blakedbb38ca2019-08-23 09:37:22 -05001060 export_description, bitmap, readonly, shared > 1,
Eric Blake678ba272019-01-11 13:47:19 -06001061 nbd_export_closed, writethrough, NULL,
1062 &error_fatal);
ths3b05a8e2008-07-03 12:45:02 +00001063
Paolo Bonzinif1ef5552011-11-04 15:51:23 +01001064 if (device) {
Eric Blake3c1fa352018-12-15 07:53:08 -06001065#if HAVE_NBD_DEVICE
Paolo Bonzinif1ef5552011-11-04 15:51:23 +01001066 int ret;
1067
Paolo Bonzinia6ac2312011-12-06 09:07:00 +01001068 ret = pthread_create(&client_thread, NULL, nbd_client_thread, device);
Paolo Bonzinif1ef5552011-11-04 15:51:23 +01001069 if (ret != 0) {
Markus Armbruster85b01e02015-12-18 16:35:04 +01001070 error_report("Failed to create client thread: %s", strerror(ret));
1071 exit(EXIT_FAILURE);
Paolo Bonzinif1ef5552011-11-04 15:51:23 +01001072 }
Eric Blake3c1fa352018-12-15 07:53:08 -06001073#endif
Paolo Bonzinif1ef5552011-11-04 15:51:23 +01001074 } else {
1075 /* Shut up GCC warnings. */
1076 memset(&client_thread, 0, sizeof(client_thread));
1077 }
1078
Daniel P. Berranged0d6ff52016-02-10 18:41:02 +00001079 nbd_update_server_watch();
bellard7a5ca862008-05-27 21:13:40 +00001080
Max Reitz637bc5a2019-05-08 23:18:16 +02001081 if (pid_file_name) {
1082 qemu_write_pidfile(pid_file_name, &error_fatal);
1083 }
1084
Michael Tokarev9faf31b2012-01-16 18:37:44 +04001085 /* now when the initialization is (almost) complete, chdir("/")
1086 * to free any busy filesystems */
1087 if (chdir("/") < 0) {
Markus Armbruster85b01e02015-12-18 16:35:04 +01001088 error_report("Could not chdir to root directory: %s",
1089 strerror(errno));
1090 exit(EXIT_FAILURE);
Michael Tokarev9faf31b2012-01-16 18:37:44 +04001091 }
1092
Max Reitzffb31e12016-09-28 22:46:42 +02001093 if (fork_process) {
1094 dup2(old_stderr, STDERR_FILENO);
1095 close(old_stderr);
1096 }
1097
Paolo Bonzini7860a382012-09-18 13:31:56 +02001098 state = RUNNING;
ths3b05a8e2008-07-03 12:45:02 +00001099 do {
Paolo Bonzinia61c6782011-09-12 17:28:11 +02001100 main_loop_wait(false);
Paolo Bonzini7860a382012-09-18 13:31:56 +02001101 if (state == TERMINATE) {
1102 state = TERMINATING;
Philippe Mathieu-Daudé9d976582019-01-11 17:35:19 +01001103 nbd_export_close(export);
1104 nbd_export_put(export);
1105 export = NULL;
Paolo Bonzini7860a382012-09-18 13:31:56 +02001106 }
1107 } while (state != TERMINATED);
ths3b05a8e2008-07-03 12:45:02 +00001108
Markus Armbruster26f54e92014-10-07 13:59:04 +02001109 blk_unref(blk);
Paolo Bonzinib32f6c22011-11-04 15:51:20 +01001110 if (sockpath) {
1111 unlink(sockpath);
1112 }
bellard7a5ca862008-05-27 21:13:40 +00001113
Markus Armbrusterfbf28a42014-09-29 16:07:55 +02001114 qemu_opts_del(sn_opts);
Wenchao Xia8c116b02013-12-04 17:10:55 +08001115
Paolo Bonzinia517e882011-11-04 15:51:21 +01001116 if (device) {
1117 void *ret;
1118 pthread_join(client_thread, &ret);
1119 exit(ret != NULL);
1120 } else {
1121 exit(EXIT_SUCCESS);
1122 }
bellard7a5ca862008-05-27 21:13:40 +00001123}