blob: 0a27c9b88c2e0edf6cd108e819470821eadf5420 [file] [log] [blame]
* QEMU Random Number Generator Backend
* Copyright IBM, Corp. 2012
* Authors:
* Anthony Liguori <>
* This work is licensed under the terms of the GNU GPL, version 2 or later.
* See the COPYING file in the top-level directory.
#ifndef QEMU_RNG_H
#define QEMU_RNG_H
#include "qom/object.h"
#include "qemu-common.h"
#include "qapi/error.h"
#define TYPE_RNG_BACKEND "rng-backend"
#define RNG_BACKEND(obj) \
#define RNG_BACKEND_GET_CLASS(obj) \
#define RNG_BACKEND_CLASS(klass) \
typedef struct RngBackendClass RngBackendClass;
typedef struct RngBackend RngBackend;
typedef void (EntropyReceiveFunc)(void *opaque,
const void *data,
size_t size);
struct RngBackendClass
ObjectClass parent_class;
void (*request_entropy)(RngBackend *s, size_t size,
EntropyReceiveFunc *receive_entropy, void *opaque);
void (*cancel_requests)(RngBackend *s);
void (*opened)(RngBackend *s, Error **errp);
struct RngBackend
Object parent;
/*< protected >*/
bool opened;
* rng_backend_request_entropy:
* @s: the backend to request entropy from
* @size: the number of bytes of data to request
* @receive_entropy: a function to be invoked when entropy is available
* @opaque: data that should be passed to @receive_entropy
* This function is used by the front-end to request entropy from an entropy
* source. This function can be called multiple times before @receive_entropy
* is invoked with different values of @receive_entropy and @opaque. The
* backend will queue each request and handle appropriately.
* The backend does not need to pass the full amount of data to @receive_entropy
* but will pass a value greater than 0.
void rng_backend_request_entropy(RngBackend *s, size_t size,
EntropyReceiveFunc *receive_entropy,
void *opaque);
* rng_backend_cancel_requests:
* @s: the backend to cancel all pending requests in
* Cancels all pending requests submitted by @rng_backend_request_entropy. This
* should be used by a device during reset or in preparation for live migration
* to stop tracking any request.
void rng_backend_cancel_requests(RngBackend *s);