]> git.proxmox.com Git - mirror_qemu.git/blame - blockdev-nbd.c
configure: support passthrough of -Dxxx args to meson
[mirror_qemu.git] / blockdev-nbd.c
CommitLineData
6dd844db
PB
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
d38ea87a 12#include "qemu/osdep.h"
9c17d615 13#include "sysemu/blockdev.h"
e140177d 14#include "sysemu/block-backend.h"
0d09e41a 15#include "hw/block/block.h"
e688df6b 16#include "qapi/error.h"
8675cbd6
EB
17#include "qapi/clone-visitor.h"
18#include "qapi/qapi-visit-block-export.h"
5daa6bfd 19#include "qapi/qapi-commands-block-export.h"
737e150e 20#include "block/nbd.h"
ae398278 21#include "io/channel-socket.h"
862172f4 22#include "io/net-listener.h"
6dd844db 23
ddffee39 24typedef struct NBDServerData {
862172f4 25 QIONetListener *listener;
ddffee39 26 QCryptoTLSCreds *tlscreds;
00019455 27 char *tlsauthz;
1c8222b0
KW
28 uint32_t max_connections;
29 uint32_t connections;
ddffee39
DB
30} NBDServerData;
31
32static NBDServerData *nbd_server;
a5fced40 33static int qemu_nbd_connections = -1; /* Non-negative if this is qemu-nbd */
ddffee39 34
1c8222b0
KW
35static void nbd_update_server_watch(NBDServerData *s);
36
a5fced40 37void nbd_server_is_qemu_nbd(int max_connections)
00917172 38{
a5fced40 39 qemu_nbd_connections = max_connections;
00917172
KW
40}
41
5b1cb497
KW
42bool nbd_server_is_running(void)
43{
a5fced40 44 return nbd_server || qemu_nbd_connections >= 0;
5b1cb497
KW
45}
46
58a6fdcc
EB
47int nbd_server_max_connections(void)
48{
49 return nbd_server ? nbd_server->max_connections : qemu_nbd_connections;
50}
51
0c9390d9
EB
52static void nbd_blockdev_client_closed(NBDClient *client, bool ignored)
53{
54 nbd_client_put(client);
1c8222b0
KW
55 assert(nbd_server->connections > 0);
56 nbd_server->connections--;
57 nbd_update_server_watch(nbd_server);
0c9390d9 58}
6dd844db 59
862172f4
DB
60static void nbd_accept(QIONetListener *listener, QIOChannelSocket *cioc,
61 gpointer opaque)
6dd844db 62{
1c8222b0
KW
63 nbd_server->connections++;
64 nbd_update_server_watch(nbd_server);
65
0d73f725 66 qio_channel_set_name(QIO_CHANNEL(cioc), "nbd-server");
00019455 67 nbd_client_new(cioc, nbd_server->tlscreds, nbd_server->tlsauthz,
0c9390d9 68 nbd_blockdev_client_closed);
6dd844db
PB
69}
70
1c8222b0
KW
71static void nbd_update_server_watch(NBDServerData *s)
72{
73 if (!s->max_connections || s->connections < s->max_connections) {
74 qio_net_listener_set_client_func(s->listener, nbd_accept, NULL, NULL);
75 } else {
76 qio_net_listener_set_client_func(s->listener, NULL, NULL, NULL);
77 }
78}
ddffee39
DB
79
80static void nbd_server_free(NBDServerData *server)
6dd844db 81{
ddffee39 82 if (!server) {
6dd844db
PB
83 return;
84 }
85
862172f4
DB
86 qio_net_listener_disconnect(server->listener);
87 object_unref(OBJECT(server->listener));
ddffee39
DB
88 if (server->tlscreds) {
89 object_unref(OBJECT(server->tlscreds));
90 }
00019455 91 g_free(server->tlsauthz);
ddffee39
DB
92
93 g_free(server);
94}
95
96static QCryptoTLSCreds *nbd_get_tls_creds(const char *id, Error **errp)
97{
98 Object *obj;
99 QCryptoTLSCreds *creds;
100
101 obj = object_resolve_path_component(
102 object_get_objects_root(), id);
103 if (!obj) {
104 error_setg(errp, "No TLS credentials with id '%s'",
105 id);
106 return NULL;
107 }
108 creds = (QCryptoTLSCreds *)
109 object_dynamic_cast(obj, TYPE_QCRYPTO_TLS_CREDS);
110 if (!creds) {
111 error_setg(errp, "Object with id '%s' is not TLS credentials",
112 id);
113 return NULL;
114 }
115
7b3b6168
PMD
116 if (!qcrypto_tls_creds_check_endpoint(creds,
117 QCRYPTO_TLS_CREDS_ENDPOINT_SERVER,
118 errp)) {
ddffee39
DB
119 return NULL;
120 }
121 object_ref(obj);
122 return creds;
123}
124
125
bd269ebc 126void nbd_server_start(SocketAddress *addr, const char *tls_creds,
1c8222b0
KW
127 const char *tls_authz, uint32_t max_connections,
128 Error **errp)
ddffee39
DB
129{
130 if (nbd_server) {
131 error_setg(errp, "NBD server already running");
ae398278 132 return;
6dd844db 133 }
ae398278 134
ddffee39 135 nbd_server = g_new0(NBDServerData, 1);
1c8222b0 136 nbd_server->max_connections = max_connections;
862172f4
DB
137 nbd_server->listener = qio_net_listener_new();
138
139 qio_net_listener_set_name(nbd_server->listener,
140 "nbd-listener");
141
582d4210
EB
142 /*
143 * Because this server is persistent, a backlog of SOMAXCONN is
144 * better than trying to size it to max_connections.
145 */
146 if (qio_net_listener_open_sync(nbd_server->listener, addr, SOMAXCONN,
147 errp) < 0) {
ddffee39
DB
148 goto error;
149 }
150
bd269ebc 151 if (tls_creds) {
ddffee39
DB
152 nbd_server->tlscreds = nbd_get_tls_creds(tls_creds, errp);
153 if (!nbd_server->tlscreds) {
154 goto error;
155 }
ddffee39
DB
156 }
157
00019455
DB
158 nbd_server->tlsauthz = g_strdup(tls_authz);
159
1c8222b0 160 nbd_update_server_watch(nbd_server);
ddffee39
DB
161
162 return;
163
164 error:
165 nbd_server_free(nbd_server);
166 nbd_server = NULL;
6dd844db
PB
167}
168
eed8b691
KW
169void nbd_server_start_options(NbdServerOptions *arg, Error **errp)
170{
1c8222b0
KW
171 nbd_server_start(arg->addr, arg->tls_creds, arg->tls_authz,
172 arg->max_connections, errp);
eed8b691
KW
173}
174
bd269ebc 175void qmp_nbd_server_start(SocketAddressLegacy *addr,
54fde4ff
MA
176 const char *tls_creds,
177 const char *tls_authz,
1c8222b0 178 bool has_max_connections, uint32_t max_connections,
bd269ebc
MA
179 Error **errp)
180{
181 SocketAddress *addr_flat = socket_address_flatten(addr);
182
1c8222b0 183 nbd_server_start(addr_flat, tls_creds, tls_authz, max_connections, errp);
bd269ebc
MA
184 qapi_free_SocketAddress(addr_flat);
185}
186
b6076afc 187void qmp_nbd_server_add(NbdServerAddOptions *arg, Error **errp)
56ee8626 188{
9b562c64
KW
189 BlockExport *export;
190 BlockDriverState *bs;
191 BlockBackend *on_eject_blk;
b6076afc 192 BlockExportOptions *export_opts;
9b562c64
KW
193
194 bs = bdrv_lookup_bs(arg->device, arg->device, errp);
195 if (!bs) {
196 return;
197 }
198
b6076afc
KW
199 /*
200 * block-export-add would default to the node-name, but we may have to use
201 * the device name as a default here for compatibility.
202 */
54fde4ff 203 if (!arg->name) {
8675cbd6 204 arg->name = g_strdup(arg->device);
b6076afc
KW
205 }
206
207 export_opts = g_new(BlockExportOptions, 1);
208 *export_opts = (BlockExportOptions) {
209 .type = BLOCK_EXPORT_TYPE_NBD,
d53be9ce 210 .id = g_strdup(arg->name),
b6076afc 211 .node_name = g_strdup(bdrv_get_node_name(bs)),
30dbc81d
KW
212 .has_writable = arg->has_writable,
213 .writable = arg->writable,
56ee8626 214 };
cbad81ce 215 QAPI_CLONE_MEMBERS(BlockExportOptionsNbdBase, &export_opts->u.nbd,
8675cbd6 216 qapi_NbdServerAddOptions_base(arg));
54fde4ff 217 if (arg->bitmap) {
e5fb29d5
VSO
218 BlockDirtyBitmapOrStr *el = g_new(BlockDirtyBitmapOrStr, 1);
219
220 *el = (BlockDirtyBitmapOrStr) {
221 .type = QTYPE_QSTRING,
222 .u.local = g_strdup(arg->bitmap),
223 };
cbad81ce 224 export_opts->u.nbd.has_bitmaps = true;
e5fb29d5 225 QAPI_LIST_PREPEND(export_opts->u.nbd.bitmaps, el);
cbad81ce 226 }
9b562c64
KW
227
228 /*
229 * nbd-server-add doesn't complain when a read-only device should be
230 * exported as writable, but simply downgrades it. This is an error with
231 * block-export-add.
232 */
233 if (bdrv_is_read_only(bs)) {
30dbc81d
KW
234 export_opts->has_writable = true;
235 export_opts->writable = false;
9b562c64
KW
236 }
237
b6076afc 238 export = blk_exp_add(export_opts, errp);
9b562c64 239 if (!export) {
b6076afc 240 goto fail;
9b562c64
KW
241 }
242
243 /*
244 * nbd-server-add removes the export when the named BlockBackend used for
245 * @device goes away.
246 */
247 on_eject_blk = blk_by_name(arg->device);
248 if (on_eject_blk) {
249 nbd_export_set_on_eject_blk(export, on_eject_blk);
250 }
b6076afc
KW
251
252fail:
253 qapi_free_BlockExportOptions(export_opts);
6dd844db
PB
254}
255
a3b0dc75 256void qmp_nbd_server_remove(const char *name,
3c3bc462 257 bool has_mode, BlockExportRemoveMode mode,
a3b0dc75
VSO
258 Error **errp)
259{
3c3bc462 260 BlockExport *exp;
a3b0dc75 261
3c3bc462
KW
262 exp = blk_exp_find(name);
263 if (exp && exp->drv->type != BLOCK_EXPORT_TYPE_NBD) {
264 error_setg(errp, "Block export '%s' is not an NBD export", name);
a3b0dc75
VSO
265 return;
266 }
267
3c3bc462 268 qmp_block_export_del(name, has_mode, mode, errp);
a3b0dc75
VSO
269}
270
6dd844db
PB
271void qmp_nbd_server_stop(Error **errp)
272{
7801c3a7
EB
273 if (!nbd_server) {
274 error_setg(errp, "NBD server not running");
275 return;
276 }
277
bc4ee65b 278 blk_exp_close_all_type(BLOCK_EXPORT_TYPE_NBD);
6dd844db 279
ddffee39
DB
280 nbd_server_free(nbd_server);
281 nbd_server = NULL;
6dd844db 282}