qemu/blockdev-nbd.c
<<
>>
Prefs
   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
  12#include "qemu/osdep.h"
  13#include "sysemu/blockdev.h"
  14#include "sysemu/block-backend.h"
  15#include "hw/block/block.h"
  16#include "qapi/error.h"
  17#include "qapi/qapi-commands-block.h"
  18#include "sysemu/sysemu.h"
  19#include "block/nbd.h"
  20#include "io/channel-socket.h"
  21#include "io/net-listener.h"
  22
  23typedef struct NBDServerData {
  24    QIONetListener *listener;
  25    QCryptoTLSCreds *tlscreds;
  26} NBDServerData;
  27
  28static NBDServerData *nbd_server;
  29
  30static void nbd_blockdev_client_closed(NBDClient *client, bool ignored)
  31{
  32    nbd_client_put(client);
  33}
  34
  35static void nbd_accept(QIONetListener *listener, QIOChannelSocket *cioc,
  36                       gpointer opaque)
  37{
  38    qio_channel_set_name(QIO_CHANNEL(cioc), "nbd-server");
  39    nbd_client_new(cioc, nbd_server->tlscreds, NULL,
  40                   nbd_blockdev_client_closed);
  41}
  42
  43
  44static void nbd_server_free(NBDServerData *server)
  45{
  46    if (!server) {
  47        return;
  48    }
  49
  50    qio_net_listener_disconnect(server->listener);
  51    object_unref(OBJECT(server->listener));
  52    if (server->tlscreds) {
  53        object_unref(OBJECT(server->tlscreds));
  54    }
  55
  56    g_free(server);
  57}
  58
  59static QCryptoTLSCreds *nbd_get_tls_creds(const char *id, Error **errp)
  60{
  61    Object *obj;
  62    QCryptoTLSCreds *creds;
  63
  64    obj = object_resolve_path_component(
  65        object_get_objects_root(), id);
  66    if (!obj) {
  67        error_setg(errp, "No TLS credentials with id '%s'",
  68                   id);
  69        return NULL;
  70    }
  71    creds = (QCryptoTLSCreds *)
  72        object_dynamic_cast(obj, TYPE_QCRYPTO_TLS_CREDS);
  73    if (!creds) {
  74        error_setg(errp, "Object with id '%s' is not TLS credentials",
  75                   id);
  76        return NULL;
  77    }
  78
  79    if (creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_SERVER) {
  80        error_setg(errp,
  81                   "Expecting TLS credentials with a server endpoint");
  82        return NULL;
  83    }
  84    object_ref(obj);
  85    return creds;
  86}
  87
  88
  89void nbd_server_start(SocketAddress *addr, const char *tls_creds,
  90                      Error **errp)
  91{
  92    if (nbd_server) {
  93        error_setg(errp, "NBD server already running");
  94        return;
  95    }
  96
  97    nbd_server = g_new0(NBDServerData, 1);
  98    nbd_server->listener = qio_net_listener_new();
  99
 100    qio_net_listener_set_name(nbd_server->listener,
 101                              "nbd-listener");
 102
 103    if (qio_net_listener_open_sync(nbd_server->listener, addr, errp) < 0) {
 104        goto error;
 105    }
 106
 107    if (tls_creds) {
 108        nbd_server->tlscreds = nbd_get_tls_creds(tls_creds, errp);
 109        if (!nbd_server->tlscreds) {
 110            goto error;
 111        }
 112
 113        /* TODO SOCKET_ADDRESS_TYPE_FD where fd has AF_INET or AF_INET6 */
 114        if (addr->type != SOCKET_ADDRESS_TYPE_INET) {
 115            error_setg(errp, "TLS is only supported with IPv4/IPv6");
 116            goto error;
 117        }
 118    }
 119
 120    qio_net_listener_set_client_func(nbd_server->listener,
 121                                     nbd_accept,
 122                                     NULL,
 123                                     NULL);
 124
 125    return;
 126
 127 error:
 128    nbd_server_free(nbd_server);
 129    nbd_server = NULL;
 130}
 131
 132void qmp_nbd_server_start(SocketAddressLegacy *addr,
 133                          bool has_tls_creds, const char *tls_creds,
 134                          Error **errp)
 135{
 136    SocketAddress *addr_flat = socket_address_flatten(addr);
 137
 138    nbd_server_start(addr_flat, tls_creds, errp);
 139    qapi_free_SocketAddress(addr_flat);
 140}
 141
 142void qmp_nbd_server_add(const char *device, bool has_name, const char *name,
 143                        bool has_writable, bool writable, Error **errp)
 144{
 145    BlockDriverState *bs = NULL;
 146    BlockBackend *on_eject_blk;
 147    NBDExport *exp;
 148
 149    if (!nbd_server) {
 150        error_setg(errp, "NBD server not running");
 151        return;
 152    }
 153
 154    if (!has_name) {
 155        name = device;
 156    }
 157
 158    if (nbd_export_find(name)) {
 159        error_setg(errp, "NBD server already has export named '%s'", name);
 160        return;
 161    }
 162
 163    on_eject_blk = blk_by_name(device);
 164
 165    bs = bdrv_lookup_bs(device, device, errp);
 166    if (!bs) {
 167        return;
 168    }
 169
 170    if (!has_writable) {
 171        writable = false;
 172    }
 173    if (bdrv_is_read_only(bs)) {
 174        writable = false;
 175    }
 176
 177    exp = nbd_export_new(bs, 0, -1, writable ? 0 : NBD_FLAG_READ_ONLY,
 178                         NULL, false, on_eject_blk, errp);
 179    if (!exp) {
 180        return;
 181    }
 182
 183    nbd_export_set_name(exp, name);
 184
 185    /* The list of named exports has a strong reference to this export now and
 186     * our only way of accessing it is through nbd_export_find(), so we can drop
 187     * the strong reference that is @exp. */
 188    nbd_export_put(exp);
 189}
 190
 191void qmp_nbd_server_remove(const char *name,
 192                           bool has_mode, NbdServerRemoveMode mode,
 193                           Error **errp)
 194{
 195    NBDExport *exp;
 196
 197    if (!nbd_server) {
 198        error_setg(errp, "NBD server not running");
 199        return;
 200    }
 201
 202    exp = nbd_export_find(name);
 203    if (exp == NULL) {
 204        error_setg(errp, "Export '%s' is not found", name);
 205        return;
 206    }
 207
 208    if (!has_mode) {
 209        mode = NBD_SERVER_REMOVE_MODE_SAFE;
 210    }
 211
 212    nbd_export_remove(exp, mode, errp);
 213}
 214
 215void qmp_nbd_server_stop(Error **errp)
 216{
 217    nbd_export_close_all();
 218
 219    nbd_server_free(nbd_server);
 220    nbd_server = NULL;
 221}
 222
 223void qmp_x_nbd_server_add_bitmap(const char *name, const char *bitmap,
 224                                 bool has_bitmap_export_name,
 225                                 const char *bitmap_export_name,
 226                                 Error **errp)
 227{
 228    NBDExport *exp;
 229
 230    if (!nbd_server) {
 231        error_setg(errp, "NBD server not running");
 232        return;
 233    }
 234
 235    exp = nbd_export_find(name);
 236    if (exp == NULL) {
 237        error_setg(errp, "Export '%s' is not found", name);
 238        return;
 239    }
 240
 241    nbd_export_bitmap(exp, bitmap,
 242                      has_bitmap_export_name ? bitmap_export_name : bitmap,
 243                      errp);
 244}
 245