docs/devel: Format literals correctly
[qemu.git] / backends / rng-random.c
blob7add272edddf3ec446ce50b3276deb065aeee9fd
1 /*
2 * QEMU Random Number Generator Backend
4 * Copyright IBM, Corp. 2012
6 * Authors:
7 * Anthony Liguori <aliguori@us.ibm.com>
9 * This work is licensed under the terms of the GNU GPL, version 2 or later.
10 * See the COPYING file in the top-level directory.
13 #include "qemu/osdep.h"
14 #include "sysemu/rng-random.h"
15 #include "sysemu/rng.h"
16 #include "qapi/error.h"
17 #include "qapi/qmp/qerror.h"
18 #include "qemu/main-loop.h"
19 #include "qemu/module.h"
21 struct RngRandom
23 RngBackend parent;
25 int fd;
26 char *filename;
29 /**
30 * A simple and incomplete backend to request entropy from /dev/random.
32 * This backend exposes an additional "filename" property that can be used to
33 * set the filename to use to open the backend.
36 static void entropy_available(void *opaque)
38 RngRandom *s = RNG_RANDOM(opaque);
40 while (!QSIMPLEQ_EMPTY(&s->parent.requests)) {
41 RngRequest *req = QSIMPLEQ_FIRST(&s->parent.requests);
42 ssize_t len;
44 len = read(s->fd, req->data, req->size);
45 if (len < 0 && errno == EAGAIN) {
46 return;
48 g_assert(len != -1);
50 req->receive_entropy(req->opaque, req->data, len);
52 rng_backend_finalize_request(&s->parent, req);
55 /* We've drained all requests, the fd handler can be reset. */
56 qemu_set_fd_handler(s->fd, NULL, NULL, NULL);
59 static void rng_random_request_entropy(RngBackend *b, RngRequest *req)
61 RngRandom *s = RNG_RANDOM(b);
63 if (QSIMPLEQ_EMPTY(&s->parent.requests)) {
64 /* If there are no pending requests yet, we need to
65 * install our fd handler. */
66 qemu_set_fd_handler(s->fd, entropy_available, NULL, s);
70 static void rng_random_opened(RngBackend *b, Error **errp)
72 RngRandom *s = RNG_RANDOM(b);
74 if (s->filename == NULL) {
75 error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
76 "filename", "a valid filename");
77 } else {
78 s->fd = qemu_open_old(s->filename, O_RDONLY | O_NONBLOCK);
79 if (s->fd == -1) {
80 error_setg_file_open(errp, errno, s->filename);
85 static char *rng_random_get_filename(Object *obj, Error **errp)
87 RngRandom *s = RNG_RANDOM(obj);
89 return g_strdup(s->filename);
92 static void rng_random_set_filename(Object *obj, const char *filename,
93 Error **errp)
95 RngBackend *b = RNG_BACKEND(obj);
96 RngRandom *s = RNG_RANDOM(obj);
98 if (b->opened) {
99 error_setg(errp, QERR_PERMISSION_DENIED);
100 return;
103 g_free(s->filename);
104 s->filename = g_strdup(filename);
107 static void rng_random_init(Object *obj)
109 RngRandom *s = RNG_RANDOM(obj);
111 s->filename = g_strdup("/dev/urandom");
112 s->fd = -1;
115 static void rng_random_finalize(Object *obj)
117 RngRandom *s = RNG_RANDOM(obj);
119 if (s->fd != -1) {
120 qemu_set_fd_handler(s->fd, NULL, NULL, NULL);
121 qemu_close(s->fd);
124 g_free(s->filename);
127 static void rng_random_class_init(ObjectClass *klass, void *data)
129 RngBackendClass *rbc = RNG_BACKEND_CLASS(klass);
131 rbc->request_entropy = rng_random_request_entropy;
132 rbc->opened = rng_random_opened;
133 object_class_property_add_str(klass, "filename",
134 rng_random_get_filename,
135 rng_random_set_filename);
139 static const TypeInfo rng_random_info = {
140 .name = TYPE_RNG_RANDOM,
141 .parent = TYPE_RNG_BACKEND,
142 .instance_size = sizeof(RngRandom),
143 .class_init = rng_random_class_init,
144 .instance_init = rng_random_init,
145 .instance_finalize = rng_random_finalize,
148 static void register_types(void)
150 type_register_static(&rng_random_info);
153 type_init(register_types);