2012-06-20 08:59:32 +02:00
|
|
|
/*
|
|
|
|
* A virtio device implementing a hardware random number generator.
|
|
|
|
*
|
|
|
|
* Copyright 2012 Red Hat, Inc.
|
|
|
|
* Copyright 2012 Amit Shah <amit.shah@redhat.com>
|
|
|
|
*
|
|
|
|
* This work is licensed under the terms of the GNU GPL, version 2 or
|
|
|
|
* (at your option) any later version. See the COPYING file in the
|
|
|
|
* top-level directory.
|
|
|
|
*/
|
|
|
|
|
2016-01-26 19:17:07 +01:00
|
|
|
#include "qemu/osdep.h"
|
include/qemu/osdep.h: Don't include qapi/error.h
Commit 57cb38b included qapi/error.h into qemu/osdep.h to get the
Error typedef. Since then, we've moved to include qemu/osdep.h
everywhere. Its file comment explains: "To avoid getting into
possible circular include dependencies, this file should not include
any other QEMU headers, with the exceptions of config-host.h,
compiler.h, os-posix.h and os-win32.h, all of which are doing a
similar job to this file and are under similar constraints."
qapi/error.h doesn't do a similar job, and it doesn't adhere to
similar constraints: it includes qapi-types.h. That's in excess of
100KiB of crap most .c files don't actually need.
Add the typedef to qemu/typedefs.h, and include that instead of
qapi/error.h. Include qapi/error.h in .c files that need it and don't
get it now. Include qapi-types.h in qom/object.h for uint16List.
Update scripts/clean-includes accordingly. Update it further to match
reality: replace config.h by config-target.h, add sysemu/os-posix.h,
sysemu/os-win32.h. Update the list of includes in the qemu/osdep.h
comment quoted above similarly.
This reduces the number of objects depending on qapi/error.h from "all
of them" to less than a third. Unfortunately, the number depending on
qapi-types.h shrinks only a little. More work is needed for that one.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
[Fix compilation without the spice devel packages. - Paolo]
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2016-03-14 09:01:28 +01:00
|
|
|
#include "qapi/error.h"
|
2012-12-17 18:20:00 +01:00
|
|
|
#include "qemu/iov.h"
|
2019-05-23 16:35:07 +02:00
|
|
|
#include "qemu/module.h"
|
2019-08-12 07:23:59 +02:00
|
|
|
#include "qemu/timer.h"
|
2013-02-05 17:06:20 +01:00
|
|
|
#include "hw/virtio/virtio.h"
|
2019-08-12 07:23:51 +02:00
|
|
|
#include "hw/qdev-properties.h"
|
2013-02-05 17:06:20 +01:00
|
|
|
#include "hw/virtio/virtio-rng.h"
|
2013-04-08 16:55:25 +02:00
|
|
|
#include "sysemu/rng.h"
|
2019-08-12 07:23:59 +02:00
|
|
|
#include "sysemu/runstate.h"
|
2014-01-16 17:34:39 +01:00
|
|
|
#include "qom/object_interfaces.h"
|
2014-08-04 12:52:44 +02:00
|
|
|
#include "trace.h"
|
2012-06-20 08:59:32 +02:00
|
|
|
|
|
|
|
static bool is_guest_ready(VirtIORNG *vrng)
|
|
|
|
{
|
2013-04-24 10:08:01 +02:00
|
|
|
VirtIODevice *vdev = VIRTIO_DEVICE(vrng);
|
2012-06-20 08:59:32 +02:00
|
|
|
if (virtio_queue_ready(vrng->vq)
|
2013-04-24 10:08:01 +02:00
|
|
|
&& (vdev->status & VIRTIO_CONFIG_S_DRIVER_OK)) {
|
2012-06-20 08:59:32 +02:00
|
|
|
return true;
|
|
|
|
}
|
2014-08-04 12:52:44 +02:00
|
|
|
trace_virtio_rng_guest_not_ready(vrng);
|
2012-06-20 08:59:32 +02:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2012-11-29 23:02:56 +01:00
|
|
|
static size_t get_request_size(VirtQueue *vq, unsigned quota)
|
2012-06-20 08:59:32 +02:00
|
|
|
{
|
2012-11-21 06:51:18 +01:00
|
|
|
unsigned int in, out;
|
2012-06-20 08:59:32 +02:00
|
|
|
|
2012-11-29 23:02:56 +01:00
|
|
|
virtqueue_get_avail_bytes(vq, &in, &out, quota, 0);
|
2012-11-21 06:51:18 +01:00
|
|
|
return in;
|
2012-06-20 08:59:32 +02:00
|
|
|
}
|
|
|
|
|
2012-10-30 23:45:05 +01:00
|
|
|
static void virtio_rng_process(VirtIORNG *vrng);
|
|
|
|
|
2012-06-20 08:59:32 +02:00
|
|
|
/* Send data from a char device over to the guest */
|
|
|
|
static void chr_read(void *opaque, const void *buf, size_t size)
|
|
|
|
{
|
|
|
|
VirtIORNG *vrng = opaque;
|
2013-04-24 10:08:01 +02:00
|
|
|
VirtIODevice *vdev = VIRTIO_DEVICE(vrng);
|
2016-02-04 15:26:51 +01:00
|
|
|
VirtQueueElement *elem;
|
2012-06-20 08:59:32 +02:00
|
|
|
size_t len;
|
|
|
|
int offset;
|
|
|
|
|
|
|
|
if (!is_guest_ready(vrng)) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2017-04-12 15:53:12 +02:00
|
|
|
/* we can't modify the virtqueue until
|
|
|
|
* our state is fully synced
|
|
|
|
*/
|
|
|
|
|
|
|
|
if (!runstate_check(RUN_STATE_RUNNING)) {
|
|
|
|
trace_virtio_rng_cpu_is_stopped(vrng, size);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2012-10-30 23:45:05 +01:00
|
|
|
vrng->quota_remaining -= size;
|
|
|
|
|
2012-06-20 08:59:32 +02:00
|
|
|
offset = 0;
|
|
|
|
while (offset < size) {
|
2016-02-04 15:26:51 +01:00
|
|
|
elem = virtqueue_pop(vrng->vq, sizeof(VirtQueueElement));
|
|
|
|
if (!elem) {
|
2012-06-20 08:59:32 +02:00
|
|
|
break;
|
|
|
|
}
|
2017-04-12 15:53:12 +02:00
|
|
|
trace_virtio_rng_popped(vrng);
|
2016-02-04 15:26:51 +01:00
|
|
|
len = iov_from_buf(elem->in_sg, elem->in_num,
|
2012-06-20 08:59:32 +02:00
|
|
|
0, buf + offset, size - offset);
|
|
|
|
offset += len;
|
|
|
|
|
2016-02-04 15:26:51 +01:00
|
|
|
virtqueue_push(vrng->vq, elem, len);
|
2014-08-04 12:52:44 +02:00
|
|
|
trace_virtio_rng_pushed(vrng, len);
|
2016-02-04 15:26:51 +01:00
|
|
|
g_free(elem);
|
2012-06-20 08:59:32 +02:00
|
|
|
}
|
2013-04-24 10:08:01 +02:00
|
|
|
virtio_notify(vdev, vrng->vq);
|
2016-03-03 10:48:34 +01:00
|
|
|
|
|
|
|
if (!virtio_queue_empty(vrng->vq)) {
|
|
|
|
/* If we didn't drain the queue, call virtio_rng_process
|
|
|
|
* to take care of asking for more data as appropriate.
|
|
|
|
*/
|
|
|
|
virtio_rng_process(vrng);
|
|
|
|
}
|
2012-06-20 08:59:32 +02:00
|
|
|
}
|
|
|
|
|
2012-10-30 23:45:05 +01:00
|
|
|
static void virtio_rng_process(VirtIORNG *vrng)
|
2012-06-20 08:59:32 +02:00
|
|
|
{
|
2012-11-21 06:51:18 +01:00
|
|
|
size_t size;
|
2012-11-29 23:02:56 +01:00
|
|
|
unsigned quota;
|
2012-10-30 23:45:05 +01:00
|
|
|
|
|
|
|
if (!is_guest_ready(vrng)) {
|
|
|
|
return;
|
|
|
|
}
|
2012-06-20 08:59:32 +02:00
|
|
|
|
2015-07-15 14:16:47 +02:00
|
|
|
if (vrng->activate_timer) {
|
|
|
|
timer_mod(vrng->rate_limit_timer,
|
|
|
|
qemu_clock_get_ms(QEMU_CLOCK_VIRTUAL) + vrng->conf.period_ms);
|
|
|
|
vrng->activate_timer = false;
|
|
|
|
}
|
|
|
|
|
2012-11-29 23:02:56 +01:00
|
|
|
if (vrng->quota_remaining < 0) {
|
|
|
|
quota = 0;
|
|
|
|
} else {
|
|
|
|
quota = MIN((uint64_t)vrng->quota_remaining, (uint64_t)UINT32_MAX);
|
|
|
|
}
|
|
|
|
size = get_request_size(vrng->vq, quota);
|
2014-08-04 12:52:44 +02:00
|
|
|
|
|
|
|
trace_virtio_rng_request(vrng, size, quota);
|
|
|
|
|
2012-10-30 23:45:05 +01:00
|
|
|
size = MIN(vrng->quota_remaining, size);
|
2012-11-21 06:51:18 +01:00
|
|
|
if (size) {
|
2012-06-20 08:59:32 +02:00
|
|
|
rng_backend_request_entropy(vrng->rng, size, chr_read, vrng);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2012-10-30 23:45:05 +01:00
|
|
|
static void handle_input(VirtIODevice *vdev, VirtQueue *vq)
|
|
|
|
{
|
2013-04-24 10:08:01 +02:00
|
|
|
VirtIORNG *vrng = VIRTIO_RNG(vdev);
|
2012-10-30 23:45:05 +01:00
|
|
|
virtio_rng_process(vrng);
|
|
|
|
}
|
|
|
|
|
2015-07-27 11:49:19 +02:00
|
|
|
static uint64_t get_features(VirtIODevice *vdev, uint64_t f, Error **errp)
|
2012-06-20 08:59:32 +02:00
|
|
|
{
|
|
|
|
return f;
|
|
|
|
}
|
|
|
|
|
2017-04-12 15:53:12 +02:00
|
|
|
static void virtio_rng_vm_state_change(void *opaque, int running,
|
|
|
|
RunState state)
|
2012-06-20 08:59:32 +02:00
|
|
|
{
|
2014-11-27 06:48:10 +01:00
|
|
|
VirtIORNG *vrng = opaque;
|
2012-06-20 08:59:32 +02:00
|
|
|
|
2017-04-12 15:53:12 +02:00
|
|
|
trace_virtio_rng_vm_state_change(vrng, running, state);
|
|
|
|
|
2012-10-30 23:45:05 +01:00
|
|
|
/* We may have an element ready but couldn't process it due to a quota
|
2017-04-12 15:53:12 +02:00
|
|
|
* limit or because CPU was stopped. Make sure to try again when the
|
|
|
|
* CPU restart.
|
2012-11-21 06:51:21 +01:00
|
|
|
*/
|
2012-10-30 23:45:05 +01:00
|
|
|
|
2017-04-12 15:53:12 +02:00
|
|
|
if (running && is_guest_ready(vrng)) {
|
|
|
|
virtio_rng_process(vrng);
|
|
|
|
}
|
2012-06-20 08:59:32 +02:00
|
|
|
}
|
|
|
|
|
2012-10-30 23:45:05 +01:00
|
|
|
static void check_rate_limit(void *opaque)
|
|
|
|
{
|
2013-04-24 10:08:01 +02:00
|
|
|
VirtIORNG *vrng = opaque;
|
2012-10-30 23:45:05 +01:00
|
|
|
|
2013-04-24 10:08:01 +02:00
|
|
|
vrng->quota_remaining = vrng->conf.max_bytes;
|
|
|
|
virtio_rng_process(vrng);
|
2015-07-15 14:16:47 +02:00
|
|
|
vrng->activate_timer = true;
|
2012-10-30 23:45:05 +01:00
|
|
|
}
|
|
|
|
|
2018-06-27 13:25:20 +02:00
|
|
|
static void virtio_rng_set_status(VirtIODevice *vdev, uint8_t status)
|
|
|
|
{
|
|
|
|
VirtIORNG *vrng = VIRTIO_RNG(vdev);
|
|
|
|
|
|
|
|
if (!vdev->vm_running) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
vdev->status = status;
|
|
|
|
|
|
|
|
/* Something changed, try to process buffers */
|
|
|
|
virtio_rng_process(vrng);
|
|
|
|
}
|
|
|
|
|
2013-07-30 02:57:37 +02:00
|
|
|
static void virtio_rng_device_realize(DeviceState *dev, Error **errp)
|
2012-06-20 08:59:32 +02:00
|
|
|
{
|
2013-07-30 02:57:37 +02:00
|
|
|
VirtIODevice *vdev = VIRTIO_DEVICE(dev);
|
2013-07-30 05:12:47 +02:00
|
|
|
VirtIORNG *vrng = VIRTIO_RNG(dev);
|
2012-06-20 08:59:32 +02:00
|
|
|
Error *local_err = NULL;
|
|
|
|
|
2014-12-11 08:47:42 +01:00
|
|
|
if (vrng->conf.period_ms <= 0) {
|
2014-07-30 01:28:58 +02:00
|
|
|
error_setg(errp, "'period' parameter expects a positive integer");
|
2013-07-30 02:57:37 +02:00
|
|
|
return;
|
2013-11-21 11:53:23 +01:00
|
|
|
}
|
|
|
|
|
2014-07-30 01:28:57 +02:00
|
|
|
/* Workaround: Property parsing does not enforce unsigned integers,
|
|
|
|
* So this is a hack to reject such numbers. */
|
|
|
|
if (vrng->conf.max_bytes > INT64_MAX) {
|
2014-07-30 01:28:58 +02:00
|
|
|
error_setg(errp, "'max-bytes' parameter must be non-negative, "
|
|
|
|
"and less than 2^63");
|
2014-07-30 01:28:57 +02:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2013-04-24 10:07:59 +02:00
|
|
|
if (vrng->conf.rng == NULL) {
|
2019-08-20 18:06:15 +02:00
|
|
|
Object *default_backend = object_new(TYPE_RNG_BUILTIN);
|
2013-04-24 10:07:59 +02:00
|
|
|
|
2019-08-20 18:06:14 +02:00
|
|
|
user_creatable_complete(USER_CREATABLE(default_backend),
|
2014-01-16 17:34:39 +01:00
|
|
|
&local_err);
|
|
|
|
if (local_err) {
|
|
|
|
error_propagate(errp, local_err);
|
2019-08-20 18:06:14 +02:00
|
|
|
object_unref(default_backend);
|
2014-01-16 17:34:39 +01:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2019-08-20 18:06:14 +02:00
|
|
|
object_property_add_child(OBJECT(dev), "default-backend",
|
qom: Drop parameter @errp of object_property_add() & friends
The only way object_property_add() can fail is when a property with
the same name already exists. Since our property names are all
hardcoded, failure is a programming error, and the appropriate way to
handle it is passing &error_abort.
Same for its variants, except for object_property_add_child(), which
additionally fails when the child already has a parent. Parentage is
also under program control, so this is a programming error, too.
We have a bit over 500 callers. Almost half of them pass
&error_abort, slightly fewer ignore errors, one test case handles
errors, and the remaining few callers pass them to their own callers.
The previous few commits demonstrated once again that ignoring
programming errors is a bad idea.
Of the few ones that pass on errors, several violate the Error API.
The Error ** argument must be NULL, &error_abort, &error_fatal, or a
pointer to a variable containing NULL. Passing an argument of the
latter kind twice without clearing it in between is wrong: if the
first call sets an error, it no longer points to NULL for the second
call. ich9_pm_add_properties(), sparc32_ledma_realize(),
sparc32_dma_realize(), xilinx_axidma_realize(), xilinx_enet_realize()
are wrong that way.
When the one appropriate choice of argument is &error_abort, letting
users pick the argument is a bad idea.
Drop parameter @errp and assert the preconditions instead.
There's one exception to "duplicate property name is a programming
error": the way object_property_add() implements the magic (and
undocumented) "automatic arrayification". Don't drop @errp there.
Instead, rename object_property_add() to object_property_try_add(),
and add the obvious wrapper object_property_add().
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
Message-Id: <20200505152926.18877-15-armbru@redhat.com>
[Two semantic rebase conflicts resolved]
2020-05-05 17:29:22 +02:00
|
|
|
default_backend);
|
2013-04-24 10:07:59 +02:00
|
|
|
|
2014-03-19 08:58:57 +01:00
|
|
|
/* The child property took a reference, we can safely drop ours now */
|
2019-08-20 18:06:14 +02:00
|
|
|
object_unref(default_backend);
|
2014-03-19 08:58:57 +01:00
|
|
|
|
2019-08-20 18:06:14 +02:00
|
|
|
object_property_set_link(OBJECT(dev), default_backend,
|
|
|
|
"rng", &error_abort);
|
2013-04-24 10:07:55 +02:00
|
|
|
}
|
2012-06-20 08:59:32 +02:00
|
|
|
|
2013-04-24 10:07:59 +02:00
|
|
|
vrng->rng = vrng->conf.rng;
|
2012-06-20 08:59:32 +02:00
|
|
|
if (vrng->rng == NULL) {
|
2014-07-30 01:28:58 +02:00
|
|
|
error_setg(errp, "'rng' parameter expects a valid object");
|
2013-07-30 02:57:37 +02:00
|
|
|
return;
|
2012-06-20 08:59:32 +02:00
|
|
|
}
|
|
|
|
|
2014-07-30 01:28:57 +02:00
|
|
|
virtio_init(vdev, "virtio-rng", VIRTIO_ID_RNG, 0);
|
2013-04-24 10:07:55 +02:00
|
|
|
|
2014-07-30 01:28:57 +02:00
|
|
|
vrng->vq = virtio_add_queue(vdev, 8, handle_input);
|
2013-04-24 10:07:54 +02:00
|
|
|
vrng->quota_remaining = vrng->conf.max_bytes;
|
2013-08-21 17:03:08 +02:00
|
|
|
vrng->rate_limit_timer = timer_new_ms(QEMU_CLOCK_VIRTUAL,
|
2012-10-30 23:45:05 +01:00
|
|
|
check_rate_limit, vrng);
|
2015-07-15 14:16:47 +02:00
|
|
|
vrng->activate_timer = true;
|
2017-04-12 15:53:12 +02:00
|
|
|
|
|
|
|
vrng->vmstate = qemu_add_vm_change_state_handler(virtio_rng_vm_state_change,
|
|
|
|
vrng);
|
2013-04-24 10:07:55 +02:00
|
|
|
}
|
|
|
|
|
2013-07-30 03:50:44 +02:00
|
|
|
static void virtio_rng_device_unrealize(DeviceState *dev, Error **errp)
|
2013-04-24 10:07:55 +02:00
|
|
|
{
|
2013-07-30 03:50:44 +02:00
|
|
|
VirtIODevice *vdev = VIRTIO_DEVICE(dev);
|
|
|
|
VirtIORNG *vrng = VIRTIO_RNG(dev);
|
2013-04-24 10:07:55 +02:00
|
|
|
|
2017-04-12 15:53:12 +02:00
|
|
|
qemu_del_vm_change_state_handler(vrng->vmstate);
|
2013-08-21 17:03:08 +02:00
|
|
|
timer_del(vrng->rate_limit_timer);
|
|
|
|
timer_free(vrng->rate_limit_timer);
|
2019-10-25 10:35:23 +02:00
|
|
|
virtio_del_queue(vdev, 0);
|
2013-04-24 10:21:22 +02:00
|
|
|
virtio_cleanup(vdev);
|
2013-04-24 10:07:55 +02:00
|
|
|
}
|
|
|
|
|
2016-10-06 14:55:48 +02:00
|
|
|
static const VMStateDescription vmstate_virtio_rng = {
|
|
|
|
.name = "virtio-rng",
|
|
|
|
.minimum_version_id = 1,
|
|
|
|
.version_id = 1,
|
|
|
|
.fields = (VMStateField[]) {
|
|
|
|
VMSTATE_VIRTIO_DEVICE,
|
|
|
|
VMSTATE_END_OF_LIST()
|
|
|
|
},
|
|
|
|
};
|
2016-07-14 19:22:48 +02:00
|
|
|
|
2013-04-24 10:07:55 +02:00
|
|
|
static Property virtio_rng_properties[] = {
|
2015-06-10 17:04:33 +02:00
|
|
|
/* Set a default rate limit of 2^47 bytes per minute or roughly 2TB/s. If
|
|
|
|
* you have an entropy source capable of generating more entropy than this
|
|
|
|
* and you can pass it through via virtio-rng, then hats off to you. Until
|
|
|
|
* then, this is unlimited for all practical purposes.
|
|
|
|
*/
|
|
|
|
DEFINE_PROP_UINT64("max-bytes", VirtIORNG, conf.max_bytes, INT64_MAX),
|
|
|
|
DEFINE_PROP_UINT32("period", VirtIORNG, conf.period_ms, 1 << 16),
|
2017-07-14 04:14:57 +02:00
|
|
|
DEFINE_PROP_LINK("rng", VirtIORNG, conf.rng, TYPE_RNG_BACKEND, RngBackend *),
|
2013-04-24 10:07:55 +02:00
|
|
|
DEFINE_PROP_END_OF_LIST(),
|
|
|
|
};
|
|
|
|
|
|
|
|
static void virtio_rng_class_init(ObjectClass *klass, void *data)
|
|
|
|
{
|
|
|
|
DeviceClass *dc = DEVICE_CLASS(klass);
|
|
|
|
VirtioDeviceClass *vdc = VIRTIO_DEVICE_CLASS(klass);
|
2013-07-30 02:57:37 +02:00
|
|
|
|
2020-01-10 16:30:32 +01:00
|
|
|
device_class_set_props(dc, virtio_rng_properties);
|
2016-07-14 19:22:48 +02:00
|
|
|
dc->vmsd = &vmstate_virtio_rng;
|
2013-07-29 16:17:45 +02:00
|
|
|
set_bit(DEVICE_CATEGORY_MISC, dc->categories);
|
2013-07-30 02:57:37 +02:00
|
|
|
vdc->realize = virtio_rng_device_realize;
|
2013-07-30 03:50:44 +02:00
|
|
|
vdc->unrealize = virtio_rng_device_unrealize;
|
2013-04-24 10:07:55 +02:00
|
|
|
vdc->get_features = get_features;
|
2018-06-27 13:25:20 +02:00
|
|
|
vdc->set_status = virtio_rng_set_status;
|
2013-04-24 10:07:55 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
static const TypeInfo virtio_rng_info = {
|
|
|
|
.name = TYPE_VIRTIO_RNG,
|
|
|
|
.parent = TYPE_VIRTIO_DEVICE,
|
|
|
|
.instance_size = sizeof(VirtIORNG),
|
|
|
|
.class_init = virtio_rng_class_init,
|
|
|
|
};
|
|
|
|
|
|
|
|
static void virtio_register_types(void)
|
|
|
|
{
|
|
|
|
type_register_static(&virtio_rng_info);
|
|
|
|
}
|
|
|
|
|
|
|
|
type_init(virtio_register_types)
|