qemu/backends/cryptodev-vhost-user.c
<<
>>
Prefs
   1/*
   2 * QEMU Cryptodev backend for QEMU cipher APIs
   3 *
   4 * Copyright (c) 2016 HUAWEI TECHNOLOGIES CO., LTD.
   5 *
   6 * Authors:
   7 *    Gonglei <arei.gonglei@huawei.com>
   8 *
   9 * This library is free software; you can redistribute it and/or
  10 * modify it under the terms of the GNU Lesser General Public
  11 * License as published by the Free Software Foundation; either
  12 * version 2 of the License, or (at your option) any later version.
  13 *
  14 * This library is distributed in the hope that it will be useful,
  15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 * Lesser General Public License for more details.
  18 *
  19 * You should have received a copy of the GNU Lesser General Public
  20 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  21 *
  22 */
  23
  24#include "qemu/osdep.h"
  25#include "hw/boards.h"
  26#include "qapi/error.h"
  27#include "qapi/qmp/qerror.h"
  28#include "qemu/error-report.h"
  29#include "hw/virtio/vhost-user.h"
  30#include "standard-headers/linux/virtio_crypto.h"
  31#include "sysemu/cryptodev-vhost.h"
  32#include "chardev/char-fe.h"
  33#include "sysemu/cryptodev-vhost-user.h"
  34
  35
  36/**
  37 * @TYPE_CRYPTODEV_BACKEND_VHOST_USER:
  38 * name of backend that uses vhost user server
  39 */
  40#define TYPE_CRYPTODEV_BACKEND_VHOST_USER "cryptodev-vhost-user"
  41
  42#define CRYPTODEV_BACKEND_VHOST_USER(obj) \
  43    OBJECT_CHECK(CryptoDevBackendVhostUser, \
  44                 (obj), TYPE_CRYPTODEV_BACKEND_VHOST_USER)
  45
  46
  47typedef struct CryptoDevBackendVhostUser {
  48    CryptoDevBackend parent_obj;
  49
  50    VhostUserState *vhost_user;
  51    CharBackend chr;
  52    char *chr_name;
  53    bool opened;
  54    CryptoDevBackendVhost *vhost_crypto[MAX_CRYPTO_QUEUE_NUM];
  55} CryptoDevBackendVhostUser;
  56
  57static int
  58cryptodev_vhost_user_running(
  59             CryptoDevBackendVhost *crypto)
  60{
  61    return crypto ? 1 : 0;
  62}
  63
  64CryptoDevBackendVhost *
  65cryptodev_vhost_user_get_vhost(
  66                         CryptoDevBackendClient *cc,
  67                         CryptoDevBackend *b,
  68                         uint16_t queue)
  69{
  70    CryptoDevBackendVhostUser *s =
  71                      CRYPTODEV_BACKEND_VHOST_USER(b);
  72    assert(cc->type == CRYPTODEV_BACKEND_TYPE_VHOST_USER);
  73    assert(queue < MAX_CRYPTO_QUEUE_NUM);
  74
  75    return s->vhost_crypto[queue];
  76}
  77
  78static void cryptodev_vhost_user_stop(int queues,
  79                          CryptoDevBackendVhostUser *s)
  80{
  81    size_t i;
  82
  83    for (i = 0; i < queues; i++) {
  84        if (!cryptodev_vhost_user_running(s->vhost_crypto[i])) {
  85            continue;
  86        }
  87
  88        cryptodev_vhost_cleanup(s->vhost_crypto[i]);
  89        s->vhost_crypto[i] = NULL;
  90    }
  91}
  92
  93static int
  94cryptodev_vhost_user_start(int queues,
  95                         CryptoDevBackendVhostUser *s)
  96{
  97    CryptoDevBackendVhostOptions options;
  98    CryptoDevBackend *b = CRYPTODEV_BACKEND(s);
  99    int max_queues;
 100    size_t i;
 101
 102    for (i = 0; i < queues; i++) {
 103        if (cryptodev_vhost_user_running(s->vhost_crypto[i])) {
 104            continue;
 105        }
 106
 107        options.opaque = s->vhost_user;
 108        options.backend_type = VHOST_BACKEND_TYPE_USER;
 109        options.cc = b->conf.peers.ccs[i];
 110        s->vhost_crypto[i] = cryptodev_vhost_init(&options);
 111        if (!s->vhost_crypto[i]) {
 112            error_report("failed to init vhost_crypto for queue %zu", i);
 113            goto err;
 114        }
 115
 116        if (i == 0) {
 117            max_queues =
 118              cryptodev_vhost_get_max_queues(s->vhost_crypto[i]);
 119            if (queues > max_queues) {
 120                error_report("you are asking more queues than supported: %d",
 121                             max_queues);
 122                goto err;
 123            }
 124        }
 125    }
 126
 127    return 0;
 128
 129err:
 130    cryptodev_vhost_user_stop(i + 1, s);
 131    return -1;
 132}
 133
 134static Chardev *
 135cryptodev_vhost_claim_chardev(CryptoDevBackendVhostUser *s,
 136                                    Error **errp)
 137{
 138    Chardev *chr;
 139
 140    if (s->chr_name == NULL) {
 141        error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
 142                   "chardev", "a valid character device");
 143        return NULL;
 144    }
 145
 146    chr = qemu_chr_find(s->chr_name);
 147    if (chr == NULL) {
 148        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
 149                  "Device '%s' not found", s->chr_name);
 150        return NULL;
 151    }
 152
 153    return chr;
 154}
 155
 156static void cryptodev_vhost_user_event(void *opaque, int event)
 157{
 158    CryptoDevBackendVhostUser *s = opaque;
 159    CryptoDevBackend *b = CRYPTODEV_BACKEND(s);
 160    int queues = b->conf.peers.queues;
 161
 162    assert(queues < MAX_CRYPTO_QUEUE_NUM);
 163
 164    switch (event) {
 165    case CHR_EVENT_OPENED:
 166        if (cryptodev_vhost_user_start(queues, s) < 0) {
 167            exit(1);
 168        }
 169        b->ready = true;
 170        break;
 171    case CHR_EVENT_CLOSED:
 172        b->ready = false;
 173        cryptodev_vhost_user_stop(queues, s);
 174        break;
 175    }
 176}
 177
 178static void cryptodev_vhost_user_init(
 179             CryptoDevBackend *backend, Error **errp)
 180{
 181    int queues = backend->conf.peers.queues;
 182    size_t i;
 183    Error *local_err = NULL;
 184    Chardev *chr;
 185    VhostUserState *user;
 186    CryptoDevBackendClient *cc;
 187    CryptoDevBackendVhostUser *s =
 188                      CRYPTODEV_BACKEND_VHOST_USER(backend);
 189
 190    chr = cryptodev_vhost_claim_chardev(s, &local_err);
 191    if (local_err) {
 192        error_propagate(errp, local_err);
 193        return;
 194    }
 195
 196    s->opened = true;
 197
 198    for (i = 0; i < queues; i++) {
 199        cc = cryptodev_backend_new_client(
 200                  "cryptodev-vhost-user", NULL);
 201        cc->info_str = g_strdup_printf("cryptodev-vhost-user%zu to %s ",
 202                                       i, chr->label);
 203        cc->queue_index = i;
 204        cc->type = CRYPTODEV_BACKEND_TYPE_VHOST_USER;
 205
 206        backend->conf.peers.ccs[i] = cc;
 207
 208        if (i == 0) {
 209            if (!qemu_chr_fe_init(&s->chr, chr, &local_err)) {
 210                error_propagate(errp, local_err);
 211                return;
 212            }
 213        }
 214    }
 215
 216    user = vhost_user_init();
 217    if (!user) {
 218        error_setg(errp, "Failed to init vhost_user");
 219        return;
 220    }
 221
 222    user->chr = &s->chr;
 223    s->vhost_user = user;
 224
 225    qemu_chr_fe_set_handlers(&s->chr, NULL, NULL,
 226                     cryptodev_vhost_user_event, NULL, s, NULL, true);
 227
 228    backend->conf.crypto_services =
 229                         1u << VIRTIO_CRYPTO_SERVICE_CIPHER |
 230                         1u << VIRTIO_CRYPTO_SERVICE_HASH |
 231                         1u << VIRTIO_CRYPTO_SERVICE_MAC;
 232    backend->conf.cipher_algo_l = 1u << VIRTIO_CRYPTO_CIPHER_AES_CBC;
 233    backend->conf.hash_algo = 1u << VIRTIO_CRYPTO_HASH_SHA1;
 234
 235    backend->conf.max_size = UINT64_MAX;
 236    backend->conf.max_cipher_key_len = VHOST_USER_MAX_CIPHER_KEY_LEN;
 237    backend->conf.max_auth_key_len = VHOST_USER_MAX_AUTH_KEY_LEN;
 238}
 239
 240static int64_t cryptodev_vhost_user_sym_create_session(
 241           CryptoDevBackend *backend,
 242           CryptoDevBackendSymSessionInfo *sess_info,
 243           uint32_t queue_index, Error **errp)
 244{
 245    CryptoDevBackendClient *cc =
 246                   backend->conf.peers.ccs[queue_index];
 247    CryptoDevBackendVhost *vhost_crypto;
 248    uint64_t session_id = 0;
 249    int ret;
 250
 251    vhost_crypto = cryptodev_vhost_user_get_vhost(cc, backend, queue_index);
 252    if (vhost_crypto) {
 253        struct vhost_dev *dev = &(vhost_crypto->dev);
 254        ret = dev->vhost_ops->vhost_crypto_create_session(dev,
 255                                                          sess_info,
 256                                                          &session_id);
 257        if (ret < 0) {
 258            return -1;
 259        } else {
 260            return session_id;
 261        }
 262    }
 263    return -1;
 264}
 265
 266static int cryptodev_vhost_user_sym_close_session(
 267           CryptoDevBackend *backend,
 268           uint64_t session_id,
 269           uint32_t queue_index, Error **errp)
 270{
 271    CryptoDevBackendClient *cc =
 272                  backend->conf.peers.ccs[queue_index];
 273    CryptoDevBackendVhost *vhost_crypto;
 274    int ret;
 275
 276    vhost_crypto = cryptodev_vhost_user_get_vhost(cc, backend, queue_index);
 277    if (vhost_crypto) {
 278        struct vhost_dev *dev = &(vhost_crypto->dev);
 279        ret = dev->vhost_ops->vhost_crypto_close_session(dev,
 280                                                         session_id);
 281        if (ret < 0) {
 282            return -1;
 283        } else {
 284            return 0;
 285        }
 286    }
 287    return -1;
 288}
 289
 290static void cryptodev_vhost_user_cleanup(
 291             CryptoDevBackend *backend,
 292             Error **errp)
 293{
 294    CryptoDevBackendVhostUser *s =
 295                      CRYPTODEV_BACKEND_VHOST_USER(backend);
 296    size_t i;
 297    int queues = backend->conf.peers.queues;
 298    CryptoDevBackendClient *cc;
 299
 300    cryptodev_vhost_user_stop(queues, s);
 301
 302    for (i = 0; i < queues; i++) {
 303        cc = backend->conf.peers.ccs[i];
 304        if (cc) {
 305            cryptodev_backend_free_client(cc);
 306            backend->conf.peers.ccs[i] = NULL;
 307        }
 308    }
 309
 310    if (s->vhost_user) {
 311        vhost_user_cleanup(s->vhost_user);
 312        g_free(s->vhost_user);
 313        s->vhost_user = NULL;
 314    }
 315}
 316
 317static void cryptodev_vhost_user_set_chardev(Object *obj,
 318                                    const char *value, Error **errp)
 319{
 320    CryptoDevBackendVhostUser *s =
 321                      CRYPTODEV_BACKEND_VHOST_USER(obj);
 322
 323    if (s->opened) {
 324        error_setg(errp, QERR_PERMISSION_DENIED);
 325    } else {
 326        g_free(s->chr_name);
 327        s->chr_name = g_strdup(value);
 328    }
 329}
 330
 331static char *
 332cryptodev_vhost_user_get_chardev(Object *obj, Error **errp)
 333{
 334    CryptoDevBackendVhostUser *s =
 335                      CRYPTODEV_BACKEND_VHOST_USER(obj);
 336    Chardev *chr = qemu_chr_fe_get_driver(&s->chr);
 337
 338    if (chr && chr->label) {
 339        return g_strdup(chr->label);
 340    }
 341
 342    return NULL;
 343}
 344
 345static void cryptodev_vhost_user_instance_int(Object *obj)
 346{
 347    object_property_add_str(obj, "chardev",
 348                            cryptodev_vhost_user_get_chardev,
 349                            cryptodev_vhost_user_set_chardev,
 350                            NULL);
 351}
 352
 353static void cryptodev_vhost_user_finalize(Object *obj)
 354{
 355    CryptoDevBackendVhostUser *s =
 356                      CRYPTODEV_BACKEND_VHOST_USER(obj);
 357
 358    qemu_chr_fe_deinit(&s->chr, false);
 359
 360    g_free(s->chr_name);
 361}
 362
 363static void
 364cryptodev_vhost_user_class_init(ObjectClass *oc, void *data)
 365{
 366    CryptoDevBackendClass *bc = CRYPTODEV_BACKEND_CLASS(oc);
 367
 368    bc->init = cryptodev_vhost_user_init;
 369    bc->cleanup = cryptodev_vhost_user_cleanup;
 370    bc->create_session = cryptodev_vhost_user_sym_create_session;
 371    bc->close_session = cryptodev_vhost_user_sym_close_session;
 372    bc->do_sym_op = NULL;
 373}
 374
 375static const TypeInfo cryptodev_vhost_user_info = {
 376    .name = TYPE_CRYPTODEV_BACKEND_VHOST_USER,
 377    .parent = TYPE_CRYPTODEV_BACKEND,
 378    .class_init = cryptodev_vhost_user_class_init,
 379    .instance_init = cryptodev_vhost_user_instance_int,
 380    .instance_finalize = cryptodev_vhost_user_finalize,
 381    .instance_size = sizeof(CryptoDevBackendVhostUser),
 382};
 383
 384static void
 385cryptodev_vhost_user_register_types(void)
 386{
 387    type_register_static(&cryptodev_vhost_user_info);
 388}
 389
 390type_init(cryptodev_vhost_user_register_types);
 391