Paolo Bonzini | 6dd844d | 2012-08-22 16:43:07 +0200 | [diff] [blame] | 1 | /* |
| 2 | * Serving QEMU block devices via NBD |
| 3 | * |
| 4 | * Copyright (c) 2012 Red Hat, Inc. |
| 5 | * |
| 6 | * Author: Paolo Bonzini <pbonzini@redhat.com> |
| 7 | * |
| 8 | * This work is licensed under the terms of the GNU GPL, version 2 or |
| 9 | * later. See the COPYING file in the top-level directory. |
| 10 | */ |
| 11 | |
Peter Maydell | d38ea87 | 2016-01-29 17:50:05 +0000 | [diff] [blame] | 12 | #include "qemu/osdep.h" |
Paolo Bonzini | 9c17d61 | 2012-12-17 18:20:04 +0100 | [diff] [blame] | 13 | #include "sysemu/blockdev.h" |
Max Reitz | e140177 | 2014-11-18 12:21:17 +0100 | [diff] [blame] | 14 | #include "sysemu/block-backend.h" |
Paolo Bonzini | 0d09e41 | 2013-02-05 17:06:20 +0100 | [diff] [blame] | 15 | #include "hw/block/block.h" |
Markus Armbruster | e688df6 | 2018-02-01 12:18:31 +0100 | [diff] [blame] | 16 | #include "qapi/error.h" |
Markus Armbruster | 9af2398 | 2018-02-11 10:36:01 +0100 | [diff] [blame] | 17 | #include "qapi/qapi-commands-block.h" |
Paolo Bonzini | 737e150 | 2012-12-17 18:19:44 +0100 | [diff] [blame] | 18 | #include "block/nbd.h" |
Daniel P. Berrange | ae39827 | 2016-02-10 18:41:03 +0000 | [diff] [blame] | 19 | #include "io/channel-socket.h" |
Daniel P. Berrange | 862172f | 2017-12-18 10:16:42 +0000 | [diff] [blame] | 20 | #include "io/net-listener.h" |
Paolo Bonzini | 6dd844d | 2012-08-22 16:43:07 +0200 | [diff] [blame] | 21 | |
Daniel P. Berrange | ddffee3 | 2016-02-10 18:41:14 +0000 | [diff] [blame] | 22 | typedef struct NBDServerData { |
Daniel P. Berrange | 862172f | 2017-12-18 10:16:42 +0000 | [diff] [blame] | 23 | QIONetListener *listener; |
Daniel P. Berrange | ddffee3 | 2016-02-10 18:41:14 +0000 | [diff] [blame] | 24 | QCryptoTLSCreds *tlscreds; |
Daniel P. Berrange | 0001945 | 2019-02-27 16:20:34 +0000 | [diff] [blame] | 25 | char *tlsauthz; |
Daniel P. Berrange | ddffee3 | 2016-02-10 18:41:14 +0000 | [diff] [blame] | 26 | } NBDServerData; |
| 27 | |
| 28 | static NBDServerData *nbd_server; |
| 29 | |
Eric Blake | 0c9390d | 2017-06-08 17:26:17 -0500 | [diff] [blame] | 30 | static void nbd_blockdev_client_closed(NBDClient *client, bool ignored) |
| 31 | { |
| 32 | nbd_client_put(client); |
| 33 | } |
Paolo Bonzini | 6dd844d | 2012-08-22 16:43:07 +0200 | [diff] [blame] | 34 | |
Daniel P. Berrange | 862172f | 2017-12-18 10:16:42 +0000 | [diff] [blame] | 35 | static void nbd_accept(QIONetListener *listener, QIOChannelSocket *cioc, |
| 36 | gpointer opaque) |
Paolo Bonzini | 6dd844d | 2012-08-22 16:43:07 +0200 | [diff] [blame] | 37 | { |
Daniel P. Berrange | 0d73f72 | 2016-09-30 11:57:14 +0100 | [diff] [blame] | 38 | qio_channel_set_name(QIO_CHANNEL(cioc), "nbd-server"); |
Daniel P. Berrange | 0001945 | 2019-02-27 16:20:34 +0000 | [diff] [blame] | 39 | nbd_client_new(cioc, nbd_server->tlscreds, nbd_server->tlsauthz, |
Eric Blake | 0c9390d | 2017-06-08 17:26:17 -0500 | [diff] [blame] | 40 | nbd_blockdev_client_closed); |
Paolo Bonzini | 6dd844d | 2012-08-22 16:43:07 +0200 | [diff] [blame] | 41 | } |
| 42 | |
Daniel P. Berrange | ddffee3 | 2016-02-10 18:41:14 +0000 | [diff] [blame] | 43 | |
| 44 | static void nbd_server_free(NBDServerData *server) |
Paolo Bonzini | 6dd844d | 2012-08-22 16:43:07 +0200 | [diff] [blame] | 45 | { |
Daniel P. Berrange | ddffee3 | 2016-02-10 18:41:14 +0000 | [diff] [blame] | 46 | if (!server) { |
| 47 | return; |
| 48 | } |
| 49 | |
Daniel P. Berrange | 862172f | 2017-12-18 10:16:42 +0000 | [diff] [blame] | 50 | qio_net_listener_disconnect(server->listener); |
| 51 | object_unref(OBJECT(server->listener)); |
Daniel P. Berrange | ddffee3 | 2016-02-10 18:41:14 +0000 | [diff] [blame] | 52 | if (server->tlscreds) { |
| 53 | object_unref(OBJECT(server->tlscreds)); |
| 54 | } |
Daniel P. Berrange | 0001945 | 2019-02-27 16:20:34 +0000 | [diff] [blame] | 55 | g_free(server->tlsauthz); |
Daniel P. Berrange | ddffee3 | 2016-02-10 18:41:14 +0000 | [diff] [blame] | 56 | |
| 57 | g_free(server); |
| 58 | } |
| 59 | |
| 60 | static QCryptoTLSCreds *nbd_get_tls_creds(const char *id, Error **errp) |
| 61 | { |
| 62 | Object *obj; |
| 63 | QCryptoTLSCreds *creds; |
| 64 | |
| 65 | obj = object_resolve_path_component( |
| 66 | object_get_objects_root(), id); |
| 67 | if (!obj) { |
| 68 | error_setg(errp, "No TLS credentials with id '%s'", |
| 69 | id); |
| 70 | return NULL; |
| 71 | } |
| 72 | creds = (QCryptoTLSCreds *) |
| 73 | object_dynamic_cast(obj, TYPE_QCRYPTO_TLS_CREDS); |
| 74 | if (!creds) { |
| 75 | error_setg(errp, "Object with id '%s' is not TLS credentials", |
| 76 | id); |
| 77 | return NULL; |
| 78 | } |
| 79 | |
| 80 | if (creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_SERVER) { |
| 81 | error_setg(errp, |
| 82 | "Expecting TLS credentials with a server endpoint"); |
| 83 | return NULL; |
| 84 | } |
| 85 | object_ref(obj); |
| 86 | return creds; |
| 87 | } |
| 88 | |
| 89 | |
Markus Armbruster | bd269eb | 2017-04-26 09:36:41 +0200 | [diff] [blame] | 90 | void nbd_server_start(SocketAddress *addr, const char *tls_creds, |
Daniel P. Berrange | 0001945 | 2019-02-27 16:20:34 +0000 | [diff] [blame] | 91 | const char *tls_authz, Error **errp) |
Daniel P. Berrange | ddffee3 | 2016-02-10 18:41:14 +0000 | [diff] [blame] | 92 | { |
| 93 | if (nbd_server) { |
Paolo Bonzini | 6dd844d | 2012-08-22 16:43:07 +0200 | [diff] [blame] | 94 | error_setg(errp, "NBD server already running"); |
| 95 | return; |
| 96 | } |
| 97 | |
Daniel P. Berrange | ddffee3 | 2016-02-10 18:41:14 +0000 | [diff] [blame] | 98 | nbd_server = g_new0(NBDServerData, 1); |
Daniel P. Berrange | 862172f | 2017-12-18 10:16:42 +0000 | [diff] [blame] | 99 | nbd_server->listener = qio_net_listener_new(); |
| 100 | |
| 101 | qio_net_listener_set_name(nbd_server->listener, |
| 102 | "nbd-listener"); |
| 103 | |
Juan Quintela | fc8135c | 2019-08-19 18:08:21 +0200 | [diff] [blame] | 104 | if (qio_net_listener_open_sync(nbd_server->listener, addr, 1, errp) < 0) { |
Daniel P. Berrange | ddffee3 | 2016-02-10 18:41:14 +0000 | [diff] [blame] | 105 | goto error; |
Paolo Bonzini | 6dd844d | 2012-08-22 16:43:07 +0200 | [diff] [blame] | 106 | } |
Daniel P. Berrange | ae39827 | 2016-02-10 18:41:03 +0000 | [diff] [blame] | 107 | |
Markus Armbruster | bd269eb | 2017-04-26 09:36:41 +0200 | [diff] [blame] | 108 | if (tls_creds) { |
Daniel P. Berrange | ddffee3 | 2016-02-10 18:41:14 +0000 | [diff] [blame] | 109 | nbd_server->tlscreds = nbd_get_tls_creds(tls_creds, errp); |
| 110 | if (!nbd_server->tlscreds) { |
| 111 | goto error; |
| 112 | } |
| 113 | |
Markus Armbruster | bd269eb | 2017-04-26 09:36:41 +0200 | [diff] [blame] | 114 | /* TODO SOCKET_ADDRESS_TYPE_FD where fd has AF_INET or AF_INET6 */ |
| 115 | if (addr->type != SOCKET_ADDRESS_TYPE_INET) { |
Daniel P. Berrange | ddffee3 | 2016-02-10 18:41:14 +0000 | [diff] [blame] | 116 | error_setg(errp, "TLS is only supported with IPv4/IPv6"); |
| 117 | goto error; |
| 118 | } |
| 119 | } |
| 120 | |
Daniel P. Berrange | 0001945 | 2019-02-27 16:20:34 +0000 | [diff] [blame] | 121 | nbd_server->tlsauthz = g_strdup(tls_authz); |
| 122 | |
Daniel P. Berrange | 862172f | 2017-12-18 10:16:42 +0000 | [diff] [blame] | 123 | qio_net_listener_set_client_func(nbd_server->listener, |
| 124 | nbd_accept, |
| 125 | NULL, |
| 126 | NULL); |
Daniel P. Berrange | ddffee3 | 2016-02-10 18:41:14 +0000 | [diff] [blame] | 127 | |
| 128 | return; |
| 129 | |
| 130 | error: |
| 131 | nbd_server_free(nbd_server); |
| 132 | nbd_server = NULL; |
Paolo Bonzini | 6dd844d | 2012-08-22 16:43:07 +0200 | [diff] [blame] | 133 | } |
| 134 | |
Kevin Wolf | eed8b69 | 2020-02-24 15:29:57 +0100 | [diff] [blame] | 135 | void nbd_server_start_options(NbdServerOptions *arg, Error **errp) |
| 136 | { |
| 137 | nbd_server_start(arg->addr, arg->tls_creds, arg->tls_authz, errp); |
| 138 | } |
| 139 | |
Markus Armbruster | bd269eb | 2017-04-26 09:36:41 +0200 | [diff] [blame] | 140 | void qmp_nbd_server_start(SocketAddressLegacy *addr, |
| 141 | bool has_tls_creds, const char *tls_creds, |
Daniel P. Berrange | 0001945 | 2019-02-27 16:20:34 +0000 | [diff] [blame] | 142 | bool has_tls_authz, const char *tls_authz, |
Markus Armbruster | bd269eb | 2017-04-26 09:36:41 +0200 | [diff] [blame] | 143 | Error **errp) |
| 144 | { |
| 145 | SocketAddress *addr_flat = socket_address_flatten(addr); |
| 146 | |
Daniel P. Berrange | 0001945 | 2019-02-27 16:20:34 +0000 | [diff] [blame] | 147 | nbd_server_start(addr_flat, tls_creds, tls_authz, errp); |
Markus Armbruster | bd269eb | 2017-04-26 09:36:41 +0200 | [diff] [blame] | 148 | qapi_free_SocketAddress(addr_flat); |
| 149 | } |
| 150 | |
Kevin Wolf | c62d24e | 2020-02-24 15:29:58 +0100 | [diff] [blame] | 151 | void qmp_nbd_server_add(BlockExportNbd *arg, Error **errp) |
Paolo Bonzini | 6dd844d | 2012-08-22 16:43:07 +0200 | [diff] [blame] | 152 | { |
Kevin Wolf | 094138d | 2016-07-06 14:15:51 +0200 | [diff] [blame] | 153 | BlockDriverState *bs = NULL; |
| 154 | BlockBackend *on_eject_blk; |
Paolo Bonzini | 6dd844d | 2012-08-22 16:43:07 +0200 | [diff] [blame] | 155 | NBDExport *exp; |
Eric Blake | 7596bbb | 2019-01-17 13:36:42 -0600 | [diff] [blame] | 156 | int64_t len; |
Eric Blake | 61bc846 | 2019-09-16 21:39:17 -0500 | [diff] [blame] | 157 | AioContext *aio_context; |
Paolo Bonzini | 6dd844d | 2012-08-22 16:43:07 +0200 | [diff] [blame] | 158 | |
Daniel P. Berrange | ddffee3 | 2016-02-10 18:41:14 +0000 | [diff] [blame] | 159 | if (!nbd_server) { |
Paolo Bonzini | 17b6be4 | 2012-11-12 14:25:17 +0100 | [diff] [blame] | 160 | error_setg(errp, "NBD server not running"); |
| 161 | return; |
| 162 | } |
| 163 | |
Kevin Wolf | c62d24e | 2020-02-24 15:29:58 +0100 | [diff] [blame] | 164 | if (!arg->has_name) { |
| 165 | arg->name = arg->device; |
Vladimir Sementsov-Ogievskiy | 902a1f9 | 2018-01-19 16:57:15 +0300 | [diff] [blame] | 166 | } |
| 167 | |
Kevin Wolf | c62d24e | 2020-02-24 15:29:58 +0100 | [diff] [blame] | 168 | if (strlen(arg->name) > NBD_MAX_STRING_SIZE) { |
| 169 | error_setg(errp, "export name '%s' too long", arg->name); |
Eric Blake | 93676c8 | 2019-11-13 20:46:34 -0600 | [diff] [blame] | 170 | return; |
| 171 | } |
| 172 | |
Kevin Wolf | c62d24e | 2020-02-24 15:29:58 +0100 | [diff] [blame] | 173 | if (arg->description && strlen(arg->description) > NBD_MAX_STRING_SIZE) { |
| 174 | error_setg(errp, "description '%s' too long", arg->description); |
Eric Blake | deb6ccb | 2019-11-13 20:46:35 -0600 | [diff] [blame] | 175 | return; |
| 176 | } |
| 177 | |
Kevin Wolf | c62d24e | 2020-02-24 15:29:58 +0100 | [diff] [blame] | 178 | if (nbd_export_find(arg->name)) { |
| 179 | error_setg(errp, "NBD server already has export named '%s'", arg->name); |
Paolo Bonzini | 6dd844d | 2012-08-22 16:43:07 +0200 | [diff] [blame] | 180 | return; |
| 181 | } |
| 182 | |
Kevin Wolf | c62d24e | 2020-02-24 15:29:58 +0100 | [diff] [blame] | 183 | on_eject_blk = blk_by_name(arg->device); |
Kevin Wolf | 094138d | 2016-07-06 14:15:51 +0200 | [diff] [blame] | 184 | |
Kevin Wolf | c62d24e | 2020-02-24 15:29:58 +0100 | [diff] [blame] | 185 | bs = bdrv_lookup_bs(arg->device, arg->device, errp); |
Kevin Wolf | 094138d | 2016-07-06 14:15:51 +0200 | [diff] [blame] | 186 | if (!bs) { |
Hani Benhabiles | 60fe4fa | 2014-05-18 11:50:04 +0100 | [diff] [blame] | 187 | return; |
| 188 | } |
Paolo Bonzini | 6dd844d | 2012-08-22 16:43:07 +0200 | [diff] [blame] | 189 | |
Eric Blake | 61bc846 | 2019-09-16 21:39:17 -0500 | [diff] [blame] | 190 | aio_context = bdrv_get_aio_context(bs); |
| 191 | aio_context_acquire(aio_context); |
Eric Blake | 7596bbb | 2019-01-17 13:36:42 -0600 | [diff] [blame] | 192 | len = bdrv_getlength(bs); |
| 193 | if (len < 0) { |
| 194 | error_setg_errno(errp, -len, |
| 195 | "Failed to determine the NBD export's length"); |
Eric Blake | 61bc846 | 2019-09-16 21:39:17 -0500 | [diff] [blame] | 196 | goto out; |
Eric Blake | 7596bbb | 2019-01-17 13:36:42 -0600 | [diff] [blame] | 197 | } |
| 198 | |
Kevin Wolf | c62d24e | 2020-02-24 15:29:58 +0100 | [diff] [blame] | 199 | if (!arg->has_writable) { |
| 200 | arg->writable = false; |
Paolo Bonzini | e644473 | 2012-11-04 12:43:37 +0100 | [diff] [blame] | 201 | } |
Kevin Wolf | 094138d | 2016-07-06 14:15:51 +0200 | [diff] [blame] | 202 | if (bdrv_is_read_only(bs)) { |
Kevin Wolf | c62d24e | 2020-02-24 15:29:58 +0100 | [diff] [blame] | 203 | arg->writable = false; |
Paolo Bonzini | e644473 | 2012-11-04 12:43:37 +0100 | [diff] [blame] | 204 | } |
| 205 | |
Kevin Wolf | c62d24e | 2020-02-24 15:29:58 +0100 | [diff] [blame] | 206 | exp = nbd_export_new(bs, 0, len, arg->name, arg->description, arg->bitmap, |
| 207 | !arg->writable, !arg->writable, |
Kevin Wolf | 094138d | 2016-07-06 14:15:51 +0200 | [diff] [blame] | 208 | NULL, false, on_eject_blk, errp); |
Max Reitz | 98f44bb | 2015-02-25 13:08:21 -0500 | [diff] [blame] | 209 | if (!exp) { |
Eric Blake | 61bc846 | 2019-09-16 21:39:17 -0500 | [diff] [blame] | 210 | goto out; |
Max Reitz | 98f44bb | 2015-02-25 13:08:21 -0500 | [diff] [blame] | 211 | } |
Paolo Bonzini | 6dd844d | 2012-08-22 16:43:07 +0200 | [diff] [blame] | 212 | |
Max Reitz | 741cc43 | 2016-01-29 16:36:06 +0100 | [diff] [blame] | 213 | /* The list of named exports has a strong reference to this export now and |
| 214 | * our only way of accessing it is through nbd_export_find(), so we can drop |
| 215 | * the strong reference that is @exp. */ |
| 216 | nbd_export_put(exp); |
Eric Blake | 61bc846 | 2019-09-16 21:39:17 -0500 | [diff] [blame] | 217 | |
| 218 | out: |
| 219 | aio_context_release(aio_context); |
Paolo Bonzini | 6dd844d | 2012-08-22 16:43:07 +0200 | [diff] [blame] | 220 | } |
| 221 | |
Vladimir Sementsov-Ogievskiy | a3b0dc7 | 2018-01-19 16:57:16 +0300 | [diff] [blame] | 222 | void qmp_nbd_server_remove(const char *name, |
| 223 | bool has_mode, NbdServerRemoveMode mode, |
| 224 | Error **errp) |
| 225 | { |
| 226 | NBDExport *exp; |
Eric Blake | 61bc846 | 2019-09-16 21:39:17 -0500 | [diff] [blame] | 227 | AioContext *aio_context; |
Vladimir Sementsov-Ogievskiy | a3b0dc7 | 2018-01-19 16:57:16 +0300 | [diff] [blame] | 228 | |
| 229 | if (!nbd_server) { |
| 230 | error_setg(errp, "NBD server not running"); |
| 231 | return; |
| 232 | } |
| 233 | |
| 234 | exp = nbd_export_find(name); |
| 235 | if (exp == NULL) { |
| 236 | error_setg(errp, "Export '%s' is not found", name); |
| 237 | return; |
| 238 | } |
| 239 | |
| 240 | if (!has_mode) { |
| 241 | mode = NBD_SERVER_REMOVE_MODE_SAFE; |
| 242 | } |
| 243 | |
Eric Blake | 61bc846 | 2019-09-16 21:39:17 -0500 | [diff] [blame] | 244 | aio_context = nbd_export_aio_context(exp); |
| 245 | aio_context_acquire(aio_context); |
Vladimir Sementsov-Ogievskiy | a3b0dc7 | 2018-01-19 16:57:16 +0300 | [diff] [blame] | 246 | nbd_export_remove(exp, mode, errp); |
Eric Blake | 61bc846 | 2019-09-16 21:39:17 -0500 | [diff] [blame] | 247 | aio_context_release(aio_context); |
Vladimir Sementsov-Ogievskiy | a3b0dc7 | 2018-01-19 16:57:16 +0300 | [diff] [blame] | 248 | } |
| 249 | |
Paolo Bonzini | 6dd844d | 2012-08-22 16:43:07 +0200 | [diff] [blame] | 250 | void qmp_nbd_server_stop(Error **errp) |
| 251 | { |
Eric Blake | 7801c3a | 2019-01-11 13:47:14 -0600 | [diff] [blame] | 252 | if (!nbd_server) { |
| 253 | error_setg(errp, "NBD server not running"); |
| 254 | return; |
| 255 | } |
| 256 | |
Max Reitz | 741cc43 | 2016-01-29 16:36:06 +0100 | [diff] [blame] | 257 | nbd_export_close_all(); |
Paolo Bonzini | 6dd844d | 2012-08-22 16:43:07 +0200 | [diff] [blame] | 258 | |
Daniel P. Berrange | ddffee3 | 2016-02-10 18:41:14 +0000 | [diff] [blame] | 259 | nbd_server_free(nbd_server); |
| 260 | nbd_server = NULL; |
Paolo Bonzini | 6dd844d | 2012-08-22 16:43:07 +0200 | [diff] [blame] | 261 | } |