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.1 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 "qapi/error.h"
26 #include "qapi/qmp/qerror.h"
27 #include "qemu/error-report.h"
28 #include "hw/virtio/vhost-user.h"
29 #include "standard-headers/linux/virtio_crypto.h"
30 #include "sysemu/cryptodev-vhost.h"
31 #include "chardev/char-fe.h"
32 #include "sysemu/cryptodev-vhost-user.h"
33 #include "qom/object.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 OBJECT_DECLARE_SIMPLE_TYPE(CryptoDevBackendVhostUser, CRYPTODEV_BACKEND_VHOST_USER)
43
44
45 struct CryptoDevBackendVhostUser {
46 CryptoDevBackend parent_obj;
47
48 VhostUserState vhost_user;
49 CharBackend chr;
50 char *chr_name;
51 bool opened;
52 CryptoDevBackendVhost *vhost_crypto[MAX_CRYPTO_QUEUE_NUM];
53 };
54
55 static int
cryptodev_vhost_user_running(CryptoDevBackendVhost * crypto)56 cryptodev_vhost_user_running(
57 CryptoDevBackendVhost *crypto)
58 {
59 return crypto ? 1 : 0;
60 }
61
62 CryptoDevBackendVhost *
cryptodev_vhost_user_get_vhost(CryptoDevBackendClient * cc,CryptoDevBackend * b,uint16_t queue)63 cryptodev_vhost_user_get_vhost(
64 CryptoDevBackendClient *cc,
65 CryptoDevBackend *b,
66 uint16_t queue)
67 {
68 CryptoDevBackendVhostUser *s =
69 CRYPTODEV_BACKEND_VHOST_USER(b);
70 assert(cc->type == QCRYPTODEV_BACKEND_TYPE_VHOST_USER);
71 assert(queue < MAX_CRYPTO_QUEUE_NUM);
72
73 return s->vhost_crypto[queue];
74 }
75
cryptodev_vhost_user_stop(int queues,CryptoDevBackendVhostUser * s)76 static void cryptodev_vhost_user_stop(int queues,
77 CryptoDevBackendVhostUser *s)
78 {
79 size_t i;
80
81 for (i = 0; i < queues; i++) {
82 if (!cryptodev_vhost_user_running(s->vhost_crypto[i])) {
83 continue;
84 }
85
86 cryptodev_vhost_cleanup(s->vhost_crypto[i]);
87 s->vhost_crypto[i] = NULL;
88 }
89 }
90
91 static int
cryptodev_vhost_user_start(int queues,CryptoDevBackendVhostUser * s)92 cryptodev_vhost_user_start(int queues,
93 CryptoDevBackendVhostUser *s)
94 {
95 CryptoDevBackendVhostOptions options;
96 CryptoDevBackend *b = CRYPTODEV_BACKEND(s);
97 int max_queues;
98 size_t i;
99
100 for (i = 0; i < queues; i++) {
101 if (cryptodev_vhost_user_running(s->vhost_crypto[i])) {
102 continue;
103 }
104
105 options.opaque = &s->vhost_user;
106 options.backend_type = VHOST_BACKEND_TYPE_USER;
107 options.cc = b->conf.peers.ccs[i];
108 s->vhost_crypto[i] = cryptodev_vhost_init(&options);
109 if (!s->vhost_crypto[i]) {
110 error_report("failed to init vhost_crypto for queue %zu", i);
111 goto err;
112 }
113
114 if (i == 0) {
115 max_queues =
116 cryptodev_vhost_get_max_queues(s->vhost_crypto[i]);
117 if (queues > max_queues) {
118 error_report("you are asking more queues than supported: %d",
119 max_queues);
120 goto err;
121 }
122 }
123 }
124
125 return 0;
126
127 err:
128 cryptodev_vhost_user_stop(i + 1, s);
129 return -1;
130 }
131
132 static Chardev *
cryptodev_vhost_claim_chardev(CryptoDevBackendVhostUser * s,Error ** errp)133 cryptodev_vhost_claim_chardev(CryptoDevBackendVhostUser *s,
134 Error **errp)
135 {
136 Chardev *chr;
137
138 if (s->chr_name == NULL) {
139 error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
140 "chardev", "a valid character device");
141 return NULL;
142 }
143
144 chr = qemu_chr_find(s->chr_name);
145 if (chr == NULL) {
146 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
147 "Device '%s' not found", s->chr_name);
148 return NULL;
149 }
150
151 return chr;
152 }
153
cryptodev_vhost_user_event(void * opaque,QEMUChrEvent event)154 static void cryptodev_vhost_user_event(void *opaque, QEMUChrEvent event)
155 {
156 CryptoDevBackendVhostUser *s = opaque;
157 CryptoDevBackend *b = CRYPTODEV_BACKEND(s);
158 int queues = b->conf.peers.queues;
159
160 assert(queues < MAX_CRYPTO_QUEUE_NUM);
161
162 switch (event) {
163 case CHR_EVENT_OPENED:
164 if (cryptodev_vhost_user_start(queues, s) < 0) {
165 exit(1);
166 }
167 b->ready = true;
168 break;
169 case CHR_EVENT_CLOSED:
170 b->ready = false;
171 cryptodev_vhost_user_stop(queues, s);
172 break;
173 case CHR_EVENT_BREAK:
174 case CHR_EVENT_MUX_IN:
175 case CHR_EVENT_MUX_OUT:
176 /* Ignore */
177 break;
178 }
179 }
180
cryptodev_vhost_user_init(CryptoDevBackend * backend,Error ** errp)181 static void cryptodev_vhost_user_init(
182 CryptoDevBackend *backend, Error **errp)
183 {
184 int queues = backend->conf.peers.queues;
185 size_t i;
186 Error *local_err = NULL;
187 Chardev *chr;
188 CryptoDevBackendClient *cc;
189 CryptoDevBackendVhostUser *s =
190 CRYPTODEV_BACKEND_VHOST_USER(backend);
191
192 chr = cryptodev_vhost_claim_chardev(s, &local_err);
193 if (local_err) {
194 error_propagate(errp, local_err);
195 return;
196 }
197
198 s->opened = true;
199
200 for (i = 0; i < queues; i++) {
201 cc = cryptodev_backend_new_client();
202 cc->info_str = g_strdup_printf("cryptodev-vhost-user%zu to %s ",
203 i, chr->label);
204 cc->queue_index = i;
205 cc->type = QCRYPTODEV_BACKEND_TYPE_VHOST_USER;
206
207 backend->conf.peers.ccs[i] = cc;
208
209 if (i == 0) {
210 if (!qemu_chr_fe_init(&s->chr, chr, errp)) {
211 return;
212 }
213 }
214 }
215
216 if (!vhost_user_init(&s->vhost_user, &s->chr, errp)) {
217 return;
218 }
219
220 qemu_chr_fe_set_handlers(&s->chr, NULL, NULL,
221 cryptodev_vhost_user_event, NULL, s, NULL, true);
222
223 backend->conf.crypto_services =
224 1u << QCRYPTODEV_BACKEND_SERVICE_TYPE_CIPHER |
225 1u << QCRYPTODEV_BACKEND_SERVICE_TYPE_HASH |
226 1u << QCRYPTODEV_BACKEND_SERVICE_TYPE_MAC;
227 backend->conf.cipher_algo_l = 1u << VIRTIO_CRYPTO_CIPHER_AES_CBC;
228 backend->conf.hash_algo = 1u << VIRTIO_CRYPTO_HASH_SHA1;
229
230 backend->conf.max_size = UINT64_MAX;
231 backend->conf.max_cipher_key_len = VHOST_USER_MAX_CIPHER_KEY_LEN;
232 backend->conf.max_auth_key_len = VHOST_USER_MAX_AUTH_KEY_LEN;
233 }
234
cryptodev_vhost_user_crypto_create_session(CryptoDevBackend * backend,CryptoDevBackendSessionInfo * sess_info,uint32_t queue_index,Error ** errp)235 static int64_t cryptodev_vhost_user_crypto_create_session(
236 CryptoDevBackend *backend,
237 CryptoDevBackendSessionInfo *sess_info,
238 uint32_t queue_index, Error **errp)
239 {
240 CryptoDevBackendClient *cc =
241 backend->conf.peers.ccs[queue_index];
242 CryptoDevBackendVhost *vhost_crypto;
243 uint64_t session_id = 0;
244 int ret;
245
246 vhost_crypto = cryptodev_vhost_user_get_vhost(cc, backend, queue_index);
247 if (vhost_crypto) {
248 struct vhost_dev *dev = &(vhost_crypto->dev);
249 ret = dev->vhost_ops->vhost_crypto_create_session(dev,
250 sess_info,
251 &session_id);
252 if (ret < 0) {
253 return -1;
254 } else {
255 return session_id;
256 }
257 }
258 return -1;
259 }
260
cryptodev_vhost_user_create_session(CryptoDevBackend * backend,CryptoDevBackendSessionInfo * sess_info,uint32_t queue_index,CryptoDevCompletionFunc cb,void * opaque)261 static int cryptodev_vhost_user_create_session(
262 CryptoDevBackend *backend,
263 CryptoDevBackendSessionInfo *sess_info,
264 uint32_t queue_index,
265 CryptoDevCompletionFunc cb,
266 void *opaque)
267 {
268 uint32_t op_code = sess_info->op_code;
269 int64_t ret;
270 Error *local_error = NULL;
271 int status;
272
273 switch (op_code) {
274 case VIRTIO_CRYPTO_CIPHER_CREATE_SESSION:
275 case VIRTIO_CRYPTO_AKCIPHER_CREATE_SESSION:
276 case VIRTIO_CRYPTO_HASH_CREATE_SESSION:
277 case VIRTIO_CRYPTO_MAC_CREATE_SESSION:
278 case VIRTIO_CRYPTO_AEAD_CREATE_SESSION:
279 ret = cryptodev_vhost_user_crypto_create_session(backend, sess_info,
280 queue_index, &local_error);
281 break;
282
283 default:
284 error_report("Unsupported opcode :%" PRIu32 "", sess_info->op_code);
285 return -VIRTIO_CRYPTO_NOTSUPP;
286 }
287
288 if (local_error) {
289 error_report_err(local_error);
290 }
291 if (ret < 0) {
292 status = -VIRTIO_CRYPTO_ERR;
293 } else {
294 sess_info->session_id = ret;
295 status = VIRTIO_CRYPTO_OK;
296 }
297 if (cb) {
298 cb(opaque, status);
299 }
300 return 0;
301 }
302
cryptodev_vhost_user_close_session(CryptoDevBackend * backend,uint64_t session_id,uint32_t queue_index,CryptoDevCompletionFunc cb,void * opaque)303 static int cryptodev_vhost_user_close_session(
304 CryptoDevBackend *backend,
305 uint64_t session_id,
306 uint32_t queue_index,
307 CryptoDevCompletionFunc cb,
308 void *opaque)
309 {
310 CryptoDevBackendClient *cc =
311 backend->conf.peers.ccs[queue_index];
312 CryptoDevBackendVhost *vhost_crypto;
313 int ret = -1, status;
314
315 vhost_crypto = cryptodev_vhost_user_get_vhost(cc, backend, queue_index);
316 if (vhost_crypto) {
317 struct vhost_dev *dev = &(vhost_crypto->dev);
318 ret = dev->vhost_ops->vhost_crypto_close_session(dev,
319 session_id);
320 if (ret < 0) {
321 status = -VIRTIO_CRYPTO_ERR;
322 } else {
323 status = VIRTIO_CRYPTO_OK;
324 }
325 } else {
326 status = -VIRTIO_CRYPTO_NOTSUPP;
327 }
328 if (cb) {
329 cb(opaque, status);
330 }
331 return 0;
332 }
333
cryptodev_vhost_user_cleanup(CryptoDevBackend * backend,Error ** errp)334 static void cryptodev_vhost_user_cleanup(
335 CryptoDevBackend *backend,
336 Error **errp)
337 {
338 CryptoDevBackendVhostUser *s =
339 CRYPTODEV_BACKEND_VHOST_USER(backend);
340 size_t i;
341 int queues = backend->conf.peers.queues;
342 CryptoDevBackendClient *cc;
343
344 cryptodev_vhost_user_stop(queues, s);
345
346 for (i = 0; i < queues; i++) {
347 cc = backend->conf.peers.ccs[i];
348 if (cc) {
349 cryptodev_backend_free_client(cc);
350 backend->conf.peers.ccs[i] = NULL;
351 }
352 }
353
354 vhost_user_cleanup(&s->vhost_user);
355 }
356
cryptodev_vhost_user_set_chardev(Object * obj,const char * value,Error ** errp)357 static void cryptodev_vhost_user_set_chardev(Object *obj,
358 const char *value, Error **errp)
359 {
360 CryptoDevBackendVhostUser *s =
361 CRYPTODEV_BACKEND_VHOST_USER(obj);
362
363 if (s->opened) {
364 error_setg(errp, "Property 'chardev' can no longer be set");
365 } else {
366 g_free(s->chr_name);
367 s->chr_name = g_strdup(value);
368 }
369 }
370
371 static char *
cryptodev_vhost_user_get_chardev(Object * obj,Error ** errp)372 cryptodev_vhost_user_get_chardev(Object *obj, Error **errp)
373 {
374 CryptoDevBackendVhostUser *s =
375 CRYPTODEV_BACKEND_VHOST_USER(obj);
376 Chardev *chr = qemu_chr_fe_get_driver(&s->chr);
377
378 if (chr && chr->label) {
379 return g_strdup(chr->label);
380 }
381
382 return NULL;
383 }
384
cryptodev_vhost_user_finalize(Object * obj)385 static void cryptodev_vhost_user_finalize(Object *obj)
386 {
387 CryptoDevBackendVhostUser *s =
388 CRYPTODEV_BACKEND_VHOST_USER(obj);
389
390 qemu_chr_fe_deinit(&s->chr, false);
391
392 g_free(s->chr_name);
393 }
394
395 static void
cryptodev_vhost_user_class_init(ObjectClass * oc,void * data)396 cryptodev_vhost_user_class_init(ObjectClass *oc, void *data)
397 {
398 CryptoDevBackendClass *bc = CRYPTODEV_BACKEND_CLASS(oc);
399
400 bc->init = cryptodev_vhost_user_init;
401 bc->cleanup = cryptodev_vhost_user_cleanup;
402 bc->create_session = cryptodev_vhost_user_create_session;
403 bc->close_session = cryptodev_vhost_user_close_session;
404 bc->do_op = NULL;
405
406 object_class_property_add_str(oc, "chardev",
407 cryptodev_vhost_user_get_chardev,
408 cryptodev_vhost_user_set_chardev);
409
410 }
411
412 static const TypeInfo cryptodev_vhost_user_info = {
413 .name = TYPE_CRYPTODEV_BACKEND_VHOST_USER,
414 .parent = TYPE_CRYPTODEV_BACKEND,
415 .class_init = cryptodev_vhost_user_class_init,
416 .instance_finalize = cryptodev_vhost_user_finalize,
417 .instance_size = sizeof(CryptoDevBackendVhostUser),
418 };
419
420 static void
cryptodev_vhost_user_register_types(void)421 cryptodev_vhost_user_register_types(void)
422 {
423 type_register_static(&cryptodev_vhost_user_info);
424 }
425
426 type_init(cryptodev_vhost_user_register_types);
427