1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29#include "qemu/osdep.h"
30#include "block/nbd-client.h"
31#include "qapi/error.h"
32#include "qemu/uri.h"
33#include "block/block_int.h"
34#include "qemu/module.h"
35#include "qapi-visit.h"
36#include "qapi/qobject-input-visitor.h"
37#include "qapi/qobject-output-visitor.h"
38#include "qapi/qmp/qdict.h"
39#include "qapi/qmp/qjson.h"
40#include "qapi/qmp/qstring.h"
41#include "qemu/cutils.h"
42
43#define EN_OPTSTR ":exportname="
44
45typedef struct BDRVNBDState {
46 NBDClientSession client;
47
48
49 SocketAddress *saddr;
50 char *export, *tlscredsid;
51} BDRVNBDState;
52
53static int nbd_parse_uri(const char *filename, QDict *options)
54{
55 URI *uri;
56 const char *p;
57 QueryParams *qp = NULL;
58 int ret = 0;
59 bool is_unix;
60
61 uri = uri_parse(filename);
62 if (!uri) {
63 return -EINVAL;
64 }
65
66
67 if (!g_strcmp0(uri->scheme, "nbd")) {
68 is_unix = false;
69 } else if (!g_strcmp0(uri->scheme, "nbd+tcp")) {
70 is_unix = false;
71 } else if (!g_strcmp0(uri->scheme, "nbd+unix")) {
72 is_unix = true;
73 } else {
74 ret = -EINVAL;
75 goto out;
76 }
77
78 p = uri->path ? uri->path : "/";
79 p += strspn(p, "/");
80 if (p[0]) {
81 qdict_put_str(options, "export", p);
82 }
83
84 qp = query_params_parse(uri->query);
85 if (qp->n > 1 || (is_unix && !qp->n) || (!is_unix && qp->n)) {
86 ret = -EINVAL;
87 goto out;
88 }
89
90 if (is_unix) {
91
92 if (uri->server || uri->port || strcmp(qp->p[0].name, "socket")) {
93 ret = -EINVAL;
94 goto out;
95 }
96 qdict_put_str(options, "server.type", "unix");
97 qdict_put_str(options, "server.path", qp->p[0].value);
98 } else {
99 QString *host;
100 char *port_str;
101
102
103 if (!uri->server) {
104 ret = -EINVAL;
105 goto out;
106 }
107
108
109 if (uri->server[0] == '[') {
110 host = qstring_from_substr(uri->server, 1,
111 strlen(uri->server) - 2);
112 } else {
113 host = qstring_from_str(uri->server);
114 }
115
116 qdict_put_str(options, "server.type", "inet");
117 qdict_put(options, "server.host", host);
118
119 port_str = g_strdup_printf("%d", uri->port ?: NBD_DEFAULT_PORT);
120 qdict_put_str(options, "server.port", port_str);
121 g_free(port_str);
122 }
123
124out:
125 if (qp) {
126 query_params_free(qp);
127 }
128 uri_free(uri);
129 return ret;
130}
131
132static bool nbd_has_filename_options_conflict(QDict *options, Error **errp)
133{
134 const QDictEntry *e;
135
136 for (e = qdict_first(options); e; e = qdict_next(options, e)) {
137 if (!strcmp(e->key, "host") ||
138 !strcmp(e->key, "port") ||
139 !strcmp(e->key, "path") ||
140 !strcmp(e->key, "export") ||
141 strstart(e->key, "server.", NULL))
142 {
143 error_setg(errp, "Option '%s' cannot be used with a file name",
144 e->key);
145 return true;
146 }
147 }
148
149 return false;
150}
151
152static void nbd_parse_filename(const char *filename, QDict *options,
153 Error **errp)
154{
155 char *file;
156 char *export_name;
157 const char *host_spec;
158 const char *unixpath;
159
160 if (nbd_has_filename_options_conflict(options, errp)) {
161 return;
162 }
163
164 if (strstr(filename, "://")) {
165 int ret = nbd_parse_uri(filename, options);
166 if (ret < 0) {
167 error_setg(errp, "No valid URL specified");
168 }
169 return;
170 }
171
172 file = g_strdup(filename);
173
174 export_name = strstr(file, EN_OPTSTR);
175 if (export_name) {
176 if (export_name[strlen(EN_OPTSTR)] == 0) {
177 goto out;
178 }
179 export_name[0] = 0;
180 export_name += strlen(EN_OPTSTR);
181
182 qdict_put_str(options, "export", export_name);
183 }
184
185
186 if (!strstart(file, "nbd:", &host_spec)) {
187 error_setg(errp, "File name string for NBD must start with 'nbd:'");
188 goto out;
189 }
190
191 if (!*host_spec) {
192 goto out;
193 }
194
195
196 if (strstart(host_spec, "unix:", &unixpath)) {
197 qdict_put_str(options, "server.type", "unix");
198 qdict_put_str(options, "server.path", unixpath);
199 } else {
200 InetSocketAddress *addr = g_new(InetSocketAddress, 1);
201
202 if (inet_parse(addr, host_spec, errp)) {
203 goto out_inet;
204 }
205
206 qdict_put_str(options, "server.type", "inet");
207 qdict_put_str(options, "server.host", addr->host);
208 qdict_put_str(options, "server.port", addr->port);
209 out_inet:
210 qapi_free_InetSocketAddress(addr);
211 }
212
213out:
214 g_free(file);
215}
216
217static bool nbd_process_legacy_socket_options(QDict *output_options,
218 QemuOpts *legacy_opts,
219 Error **errp)
220{
221 const char *path = qemu_opt_get(legacy_opts, "path");
222 const char *host = qemu_opt_get(legacy_opts, "host");
223 const char *port = qemu_opt_get(legacy_opts, "port");
224 const QDictEntry *e;
225
226 if (!path && !host && !port) {
227 return true;
228 }
229
230 for (e = qdict_first(output_options); e; e = qdict_next(output_options, e))
231 {
232 if (strstart(e->key, "server.", NULL)) {
233 error_setg(errp, "Cannot use 'server' and path/host/port at the "
234 "same time");
235 return false;
236 }
237 }
238
239 if (path && host) {
240 error_setg(errp, "path and host may not be used at the same time");
241 return false;
242 } else if (path) {
243 if (port) {
244 error_setg(errp, "port may not be used without host");
245 return false;
246 }
247
248 qdict_put_str(output_options, "server.type", "unix");
249 qdict_put_str(output_options, "server.path", path);
250 } else if (host) {
251 qdict_put_str(output_options, "server.type", "inet");
252 qdict_put_str(output_options, "server.host", host);
253 qdict_put_str(output_options, "server.port",
254 port ?: stringify(NBD_DEFAULT_PORT));
255 }
256
257 return true;
258}
259
260static SocketAddress *nbd_config(BDRVNBDState *s, QDict *options,
261 Error **errp)
262{
263 SocketAddress *saddr = NULL;
264 QDict *addr = NULL;
265 QObject *crumpled_addr = NULL;
266 Visitor *iv = NULL;
267 Error *local_err = NULL;
268
269 qdict_extract_subqdict(options, &addr, "server.");
270 if (!qdict_size(addr)) {
271 error_setg(errp, "NBD server address missing");
272 goto done;
273 }
274
275 crumpled_addr = qdict_crumple(addr, errp);
276 if (!crumpled_addr) {
277 goto done;
278 }
279
280
281
282
283
284
285
286
287
288 iv = qobject_input_visitor_new(crumpled_addr);
289 visit_type_SocketAddress(iv, NULL, &saddr, &local_err);
290 if (local_err) {
291 error_propagate(errp, local_err);
292 goto done;
293 }
294
295done:
296 QDECREF(addr);
297 qobject_decref(crumpled_addr);
298 visit_free(iv);
299 return saddr;
300}
301
302NBDClientSession *nbd_get_client_session(BlockDriverState *bs)
303{
304 BDRVNBDState *s = bs->opaque;
305 return &s->client;
306}
307
308static QIOChannelSocket *nbd_establish_connection(SocketAddress *saddr,
309 Error **errp)
310{
311 QIOChannelSocket *sioc;
312 Error *local_err = NULL;
313
314 sioc = qio_channel_socket_new();
315 qio_channel_set_name(QIO_CHANNEL(sioc), "nbd-client");
316
317 qio_channel_socket_connect_sync(sioc,
318 saddr,
319 &local_err);
320 if (local_err) {
321 object_unref(OBJECT(sioc));
322 error_propagate(errp, local_err);
323 return NULL;
324 }
325
326 qio_channel_set_delay(QIO_CHANNEL(sioc), false);
327
328 return sioc;
329}
330
331
332static QCryptoTLSCreds *nbd_get_tls_creds(const char *id, Error **errp)
333{
334 Object *obj;
335 QCryptoTLSCreds *creds;
336
337 obj = object_resolve_path_component(
338 object_get_objects_root(), id);
339 if (!obj) {
340 error_setg(errp, "No TLS credentials with id '%s'",
341 id);
342 return NULL;
343 }
344 creds = (QCryptoTLSCreds *)
345 object_dynamic_cast(obj, TYPE_QCRYPTO_TLS_CREDS);
346 if (!creds) {
347 error_setg(errp, "Object with id '%s' is not TLS credentials",
348 id);
349 return NULL;
350 }
351
352 if (creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_CLIENT) {
353 error_setg(errp,
354 "Expecting TLS credentials with a client endpoint");
355 return NULL;
356 }
357 object_ref(obj);
358 return creds;
359}
360
361
362static QemuOptsList nbd_runtime_opts = {
363 .name = "nbd",
364 .head = QTAILQ_HEAD_INITIALIZER(nbd_runtime_opts.head),
365 .desc = {
366 {
367 .name = "host",
368 .type = QEMU_OPT_STRING,
369 .help = "TCP host to connect to",
370 },
371 {
372 .name = "port",
373 .type = QEMU_OPT_STRING,
374 .help = "TCP port to connect to",
375 },
376 {
377 .name = "path",
378 .type = QEMU_OPT_STRING,
379 .help = "Unix socket path to connect to",
380 },
381 {
382 .name = "export",
383 .type = QEMU_OPT_STRING,
384 .help = "Name of the NBD export to open",
385 },
386 {
387 .name = "tls-creds",
388 .type = QEMU_OPT_STRING,
389 .help = "ID of the TLS credentials to use",
390 },
391 },
392};
393
394static int nbd_open(BlockDriverState *bs, QDict *options, int flags,
395 Error **errp)
396{
397 BDRVNBDState *s = bs->opaque;
398 QemuOpts *opts = NULL;
399 Error *local_err = NULL;
400 QIOChannelSocket *sioc = NULL;
401 QCryptoTLSCreds *tlscreds = NULL;
402 const char *hostname = NULL;
403 int ret = -EINVAL;
404
405 opts = qemu_opts_create(&nbd_runtime_opts, NULL, 0, &error_abort);
406 qemu_opts_absorb_qdict(opts, options, &local_err);
407 if (local_err) {
408 error_propagate(errp, local_err);
409 goto error;
410 }
411
412
413 if (!nbd_process_legacy_socket_options(options, opts, errp)) {
414 goto error;
415 }
416
417
418 s->saddr = nbd_config(s, options, errp);
419 if (!s->saddr) {
420 goto error;
421 }
422
423 s->export = g_strdup(qemu_opt_get(opts, "export"));
424
425 s->tlscredsid = g_strdup(qemu_opt_get(opts, "tls-creds"));
426 if (s->tlscredsid) {
427 tlscreds = nbd_get_tls_creds(s->tlscredsid, errp);
428 if (!tlscreds) {
429 goto error;
430 }
431
432
433 if (s->saddr->type != SOCKET_ADDRESS_TYPE_INET) {
434 error_setg(errp, "TLS only supported over IP sockets");
435 goto error;
436 }
437 hostname = s->saddr->u.inet.host;
438 }
439
440
441
442
443 sioc = nbd_establish_connection(s->saddr, errp);
444 if (!sioc) {
445 ret = -ECONNREFUSED;
446 goto error;
447 }
448
449
450 ret = nbd_client_init(bs, sioc, s->export,
451 tlscreds, hostname, errp);
452 error:
453 if (sioc) {
454 object_unref(OBJECT(sioc));
455 }
456 if (tlscreds) {
457 object_unref(OBJECT(tlscreds));
458 }
459 if (ret < 0) {
460 qapi_free_SocketAddress(s->saddr);
461 g_free(s->export);
462 g_free(s->tlscredsid);
463 }
464 qemu_opts_del(opts);
465 return ret;
466}
467
468static int nbd_co_flush(BlockDriverState *bs)
469{
470 return nbd_client_co_flush(bs);
471}
472
473static void nbd_refresh_limits(BlockDriverState *bs, Error **errp)
474{
475 NBDClientSession *s = nbd_get_client_session(bs);
476 uint32_t max = MIN_NON_ZERO(NBD_MAX_BUFFER_SIZE, s->info.max_block);
477
478 bs->bl.max_pdiscard = max;
479 bs->bl.max_pwrite_zeroes = max;
480 bs->bl.max_transfer = max;
481
482 if (s->info.opt_block &&
483 s->info.opt_block > bs->bl.opt_transfer) {
484 bs->bl.opt_transfer = s->info.opt_block;
485 }
486}
487
488static void nbd_close(BlockDriverState *bs)
489{
490 BDRVNBDState *s = bs->opaque;
491
492 nbd_client_close(bs);
493
494 qapi_free_SocketAddress(s->saddr);
495 g_free(s->export);
496 g_free(s->tlscredsid);
497}
498
499static int64_t nbd_getlength(BlockDriverState *bs)
500{
501 BDRVNBDState *s = bs->opaque;
502
503 return s->client.info.size;
504}
505
506static void nbd_detach_aio_context(BlockDriverState *bs)
507{
508 nbd_client_detach_aio_context(bs);
509}
510
511static void nbd_attach_aio_context(BlockDriverState *bs,
512 AioContext *new_context)
513{
514 nbd_client_attach_aio_context(bs, new_context);
515}
516
517static void nbd_refresh_filename(BlockDriverState *bs, QDict *options)
518{
519 BDRVNBDState *s = bs->opaque;
520 QDict *opts = qdict_new();
521 QObject *saddr_qdict;
522 Visitor *ov;
523 const char *host = NULL, *port = NULL, *path = NULL;
524
525 if (s->saddr->type == SOCKET_ADDRESS_TYPE_INET) {
526 const InetSocketAddress *inet = &s->saddr->u.inet;
527 if (!inet->has_ipv4 && !inet->has_ipv6 && !inet->has_to) {
528 host = inet->host;
529 port = inet->port;
530 }
531 } else if (s->saddr->type == SOCKET_ADDRESS_TYPE_UNIX) {
532 path = s->saddr->u.q_unix.path;
533 }
534
535 qdict_put_str(opts, "driver", "nbd");
536
537 if (path && s->export) {
538 snprintf(bs->exact_filename, sizeof(bs->exact_filename),
539 "nbd+unix:///%s?socket=%s", s->export, path);
540 } else if (path && !s->export) {
541 snprintf(bs->exact_filename, sizeof(bs->exact_filename),
542 "nbd+unix://?socket=%s", path);
543 } else if (host && s->export) {
544 snprintf(bs->exact_filename, sizeof(bs->exact_filename),
545 "nbd://%s:%s/%s", host, port, s->export);
546 } else if (host && !s->export) {
547 snprintf(bs->exact_filename, sizeof(bs->exact_filename),
548 "nbd://%s:%s", host, port);
549 }
550
551 ov = qobject_output_visitor_new(&saddr_qdict);
552 visit_type_SocketAddress(ov, NULL, &s->saddr, &error_abort);
553 visit_complete(ov, &saddr_qdict);
554 visit_free(ov);
555 qdict_put_obj(opts, "server", saddr_qdict);
556
557 if (s->export) {
558 qdict_put_str(opts, "export", s->export);
559 }
560 if (s->tlscredsid) {
561 qdict_put_str(opts, "tls-creds", s->tlscredsid);
562 }
563
564 qdict_flatten(opts);
565 bs->full_open_options = opts;
566}
567
568static BlockDriver bdrv_nbd = {
569 .format_name = "nbd",
570 .protocol_name = "nbd",
571 .instance_size = sizeof(BDRVNBDState),
572 .bdrv_parse_filename = nbd_parse_filename,
573 .bdrv_file_open = nbd_open,
574 .bdrv_co_preadv = nbd_client_co_preadv,
575 .bdrv_co_pwritev = nbd_client_co_pwritev,
576 .bdrv_co_pwrite_zeroes = nbd_client_co_pwrite_zeroes,
577 .bdrv_close = nbd_close,
578 .bdrv_co_flush_to_os = nbd_co_flush,
579 .bdrv_co_pdiscard = nbd_client_co_pdiscard,
580 .bdrv_refresh_limits = nbd_refresh_limits,
581 .bdrv_getlength = nbd_getlength,
582 .bdrv_detach_aio_context = nbd_detach_aio_context,
583 .bdrv_attach_aio_context = nbd_attach_aio_context,
584 .bdrv_refresh_filename = nbd_refresh_filename,
585};
586
587static BlockDriver bdrv_nbd_tcp = {
588 .format_name = "nbd",
589 .protocol_name = "nbd+tcp",
590 .instance_size = sizeof(BDRVNBDState),
591 .bdrv_parse_filename = nbd_parse_filename,
592 .bdrv_file_open = nbd_open,
593 .bdrv_co_preadv = nbd_client_co_preadv,
594 .bdrv_co_pwritev = nbd_client_co_pwritev,
595 .bdrv_co_pwrite_zeroes = nbd_client_co_pwrite_zeroes,
596 .bdrv_close = nbd_close,
597 .bdrv_co_flush_to_os = nbd_co_flush,
598 .bdrv_co_pdiscard = nbd_client_co_pdiscard,
599 .bdrv_refresh_limits = nbd_refresh_limits,
600 .bdrv_getlength = nbd_getlength,
601 .bdrv_detach_aio_context = nbd_detach_aio_context,
602 .bdrv_attach_aio_context = nbd_attach_aio_context,
603 .bdrv_refresh_filename = nbd_refresh_filename,
604};
605
606static BlockDriver bdrv_nbd_unix = {
607 .format_name = "nbd",
608 .protocol_name = "nbd+unix",
609 .instance_size = sizeof(BDRVNBDState),
610 .bdrv_parse_filename = nbd_parse_filename,
611 .bdrv_file_open = nbd_open,
612 .bdrv_co_preadv = nbd_client_co_preadv,
613 .bdrv_co_pwritev = nbd_client_co_pwritev,
614 .bdrv_co_pwrite_zeroes = nbd_client_co_pwrite_zeroes,
615 .bdrv_close = nbd_close,
616 .bdrv_co_flush_to_os = nbd_co_flush,
617 .bdrv_co_pdiscard = nbd_client_co_pdiscard,
618 .bdrv_refresh_limits = nbd_refresh_limits,
619 .bdrv_getlength = nbd_getlength,
620 .bdrv_detach_aio_context = nbd_detach_aio_context,
621 .bdrv_attach_aio_context = nbd_attach_aio_context,
622 .bdrv_refresh_filename = nbd_refresh_filename,
623};
624
625static void bdrv_nbd_init(void)
626{
627 bdrv_register(&bdrv_nbd);
628 bdrv_register(&bdrv_nbd_tcp);
629 bdrv_register(&bdrv_nbd_unix);
630}
631
632block_init(bdrv_nbd_init);
633