blob: 2fb1cdf55d10b882c78276221a0d0caaeba388a2 [file] [log] [blame]
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +01001/*
2 * Event loop thread
3 *
4 * Copyright Red Hat Inc., 2013
5 *
6 * Authors:
7 * Stefan Hajnoczi <stefanha@redhat.com>
8 *
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.
11 *
12 */
13
Peter Maydelld38ea872016-01-29 17:50:05 +000014#include "qemu/osdep.h"
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +010015#include "qom/object.h"
16#include "qom/object_interfaces.h"
17#include "qemu/module.h"
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +010018#include "block/aio.h"
Paolo Bonzinid16341f2016-10-27 12:49:00 +020019#include "block/block.h"
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +010020#include "sysemu/iothread.h"
Markus Armbrustere688df62018-02-01 12:18:31 +010021#include "qapi/error.h"
Markus Armbruster112ed242018-02-26 17:13:27 -060022#include "qapi/qapi-commands-misc.h"
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +030023#include "qemu/error-report.h"
Paolo Bonziniab28bd22015-07-09 08:55:38 +020024#include "qemu/rcu.h"
Paolo Bonzinie4370162016-10-27 12:48:59 +020025#include "qemu/main-loop.h"
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +010026
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +010027typedef ObjectClass IOThreadClass;
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +010028
29#define IOTHREAD_GET_CLASS(obj) \
30 OBJECT_GET_CLASS(IOThreadClass, obj, TYPE_IOTHREAD)
31#define IOTHREAD_CLASS(klass) \
32 OBJECT_CLASS_CHECK(IOThreadClass, klass, TYPE_IOTHREAD)
33
Peter Xu90c558b2018-03-22 16:56:30 +080034#ifdef CONFIG_POSIX
Stefan Hajnoczicdd7abf2017-01-26 17:01:19 +000035/* Benchmark results from 2016 on NVMe SSD drives show max polling times around
36 * 16-32 microseconds yield IOPS improvements for both iodepth=1 and iodepth=32
37 * workloads.
38 */
39#define IOTHREAD_POLL_MAX_NS_DEFAULT 32768ULL
Peter Xu90c558b2018-03-22 16:56:30 +080040#else
41#define IOTHREAD_POLL_MAX_NS_DEFAULT 0ULL
42#endif
Stefan Hajnoczicdd7abf2017-01-26 17:01:19 +000043
Paolo Bonzinie4370162016-10-27 12:48:59 +020044static __thread IOThread *my_iothread;
45
46AioContext *qemu_get_current_aio_context(void)
47{
48 return my_iothread ? my_iothread->ctx : qemu_get_aio_context();
49}
50
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +010051static void *iothread_run(void *opaque)
52{
53 IOThread *iothread = opaque;
54
Paolo Bonziniab28bd22015-07-09 08:55:38 +020055 rcu_register_thread();
56
Paolo Bonzinie4370162016-10-27 12:48:59 +020057 my_iothread = iothread;
Stefan Hajnoczi88eb7c22014-02-27 11:48:41 +010058 qemu_mutex_lock(&iothread->init_done_lock);
59 iothread->thread_id = qemu_get_thread_id();
60 qemu_cond_signal(&iothread->init_done_cond);
61 qemu_mutex_unlock(&iothread->init_done_lock);
62
Stefan Hajnoczi2362a282017-12-07 20:13:19 +000063 while (iothread->running) {
Paolo Bonzini65c1b5b2016-10-27 12:49:06 +020064 aio_poll(iothread->ctx, true);
Wang Yong329163c2017-08-29 15:22:37 +080065
66 if (atomic_read(&iothread->worker_context)) {
67 GMainLoop *loop;
68
69 g_main_context_push_thread_default(iothread->worker_context);
70 iothread->main_loop =
71 g_main_loop_new(iothread->worker_context, TRUE);
72 loop = iothread->main_loop;
73
74 g_main_loop_run(iothread->main_loop);
75 iothread->main_loop = NULL;
76 g_main_loop_unref(loop);
77
78 g_main_context_pop_thread_default(iothread->worker_context);
Wang Yong329163c2017-08-29 15:22:37 +080079 }
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +010080 }
Paolo Bonziniab28bd22015-07-09 08:55:38 +020081
82 rcu_unregister_thread();
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +010083 return NULL;
84}
85
Stefan Hajnoczi2362a282017-12-07 20:13:19 +000086/* Runs in iothread_run() thread */
87static void iothread_stop_bh(void *opaque)
88{
89 IOThread *iothread = opaque;
90
91 iothread->running = false; /* stop iothread_run() */
92
93 if (iothread->main_loop) {
94 g_main_loop_quit(iothread->main_loop);
95 }
96}
97
Peter Xu82d90702017-09-28 10:59:56 +080098void iothread_stop(IOThread *iothread)
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +010099{
Peter Xu82d90702017-09-28 10:59:56 +0800100 if (!iothread->ctx || iothread->stopping) {
101 return;
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +0300102 }
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +0100103 iothread->stopping = true;
Stefan Hajnoczi2362a282017-12-07 20:13:19 +0000104 aio_bh_schedule_oneshot(iothread->ctx, iothread_stop_bh, iothread);
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +0100105 qemu_thread_join(&iothread->thread);
Peter Xu82d90702017-09-28 10:59:56 +0800106}
107
Stefan Hajnoczicdd7abf2017-01-26 17:01:19 +0000108static void iothread_instance_init(Object *obj)
109{
110 IOThread *iothread = IOTHREAD(obj);
111
112 iothread->poll_max_ns = IOTHREAD_POLL_MAX_NS_DEFAULT;
Marc-André Lureau14a2d112018-08-21 12:07:16 +0200113 iothread->thread_id = -1;
Stefan Hajnoczicdd7abf2017-01-26 17:01:19 +0000114}
115
Fam Zhengdce89212016-09-08 17:28:51 +0800116static void iothread_instance_finalize(Object *obj)
117{
118 IOThread *iothread = IOTHREAD(obj);
119
Peter Xu82d90702017-09-28 10:59:56 +0800120 iothread_stop(iothread);
Marc-André Lureau14a2d112018-08-21 12:07:16 +0200121
122 if (iothread->thread_id != -1) {
123 qemu_cond_destroy(&iothread->init_done_cond);
124 qemu_mutex_destroy(&iothread->init_done_lock);
125 }
Peter Xu15544342018-04-09 16:39:56 +0800126 /*
127 * Before glib2 2.33.10, there is a glib2 bug that GSource context
128 * pointer may not be cleared even if the context has already been
129 * destroyed (while it should). Here let's free the AIO context
130 * earlier to bypass that glib bug.
131 *
132 * We can remove this comment after the minimum supported glib2
133 * version boosts to 2.33.10. Before that, let's free the
134 * GSources first before destroying any GMainContext.
135 */
136 if (iothread->ctx) {
137 aio_context_unref(iothread->ctx);
138 iothread->ctx = NULL;
139 }
Peter Xu5b3ac232017-09-28 10:59:57 +0800140 if (iothread->worker_context) {
141 g_main_context_unref(iothread->worker_context);
142 iothread->worker_context = NULL;
143 }
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +0100144}
145
146static void iothread_complete(UserCreatable *obj, Error **errp)
147{
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +0300148 Error *local_error = NULL;
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +0100149 IOThread *iothread = IOTHREAD(obj);
Paolo Bonzinid21e8772015-11-24 14:46:44 +0100150 char *name, *thread_name;
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +0100151
152 iothread->stopping = false;
Stefan Hajnoczi2362a282017-12-07 20:13:19 +0000153 iothread->running = true;
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +0300154 iothread->ctx = aio_context_new(&local_error);
155 if (!iothread->ctx) {
156 error_propagate(errp, local_error);
157 return;
158 }
Stefan Hajnoczi88eb7c22014-02-27 11:48:41 +0100159
Stefan Hajnoczi5e5db492016-12-01 19:26:52 +0000160 aio_context_set_poll_params(iothread->ctx,
161 iothread->poll_max_ns,
162 iothread->poll_grow,
163 iothread->poll_shrink,
Stefan Hajnoczi0d9d86f2016-12-01 19:26:45 +0000164 &local_error);
165 if (local_error) {
166 error_propagate(errp, local_error);
167 aio_context_unref(iothread->ctx);
168 iothread->ctx = NULL;
169 return;
170 }
171
Stefan Hajnoczi88eb7c22014-02-27 11:48:41 +0100172 qemu_mutex_init(&iothread->init_done_lock);
173 qemu_cond_init(&iothread->init_done_cond);
Wang Yong329163c2017-08-29 15:22:37 +0800174 iothread->once = (GOnce) G_ONCE_INIT;
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +0100175
176 /* This assumes we are called from a thread with useful CPU affinity for us
177 * to inherit.
178 */
Paolo Bonzinid21e8772015-11-24 14:46:44 +0100179 name = object_get_canonical_path_component(OBJECT(obj));
180 thread_name = g_strdup_printf("IO %s", name);
181 qemu_thread_create(&iothread->thread, thread_name, iothread_run,
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +0100182 iothread, QEMU_THREAD_JOINABLE);
Paolo Bonzinid21e8772015-11-24 14:46:44 +0100183 g_free(thread_name);
184 g_free(name);
Stefan Hajnoczi88eb7c22014-02-27 11:48:41 +0100185
186 /* Wait for initialization to complete */
187 qemu_mutex_lock(&iothread->init_done_lock);
188 while (iothread->thread_id == -1) {
189 qemu_cond_wait(&iothread->init_done_cond,
190 &iothread->init_done_lock);
191 }
192 qemu_mutex_unlock(&iothread->init_done_lock);
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +0100193}
194
Stefan Hajnoczi5e5db492016-12-01 19:26:52 +0000195typedef struct {
196 const char *name;
197 ptrdiff_t offset; /* field's byte offset in IOThread struct */
198} PollParamInfo;
199
200static PollParamInfo poll_max_ns_info = {
201 "poll-max-ns", offsetof(IOThread, poll_max_ns),
202};
203static PollParamInfo poll_grow_info = {
204 "poll-grow", offsetof(IOThread, poll_grow),
205};
206static PollParamInfo poll_shrink_info = {
207 "poll-shrink", offsetof(IOThread, poll_shrink),
208};
209
210static void iothread_get_poll_param(Object *obj, Visitor *v,
Stefan Hajnoczi0d9d86f2016-12-01 19:26:45 +0000211 const char *name, void *opaque, Error **errp)
212{
213 IOThread *iothread = IOTHREAD(obj);
Stefan Hajnoczi5e5db492016-12-01 19:26:52 +0000214 PollParamInfo *info = opaque;
215 int64_t *field = (void *)iothread + info->offset;
Stefan Hajnoczi0d9d86f2016-12-01 19:26:45 +0000216
Stefan Hajnoczi5e5db492016-12-01 19:26:52 +0000217 visit_type_int64(v, name, field, errp);
Stefan Hajnoczi0d9d86f2016-12-01 19:26:45 +0000218}
219
Stefan Hajnoczi5e5db492016-12-01 19:26:52 +0000220static void iothread_set_poll_param(Object *obj, Visitor *v,
Stefan Hajnoczi0d9d86f2016-12-01 19:26:45 +0000221 const char *name, void *opaque, Error **errp)
222{
223 IOThread *iothread = IOTHREAD(obj);
Stefan Hajnoczi5e5db492016-12-01 19:26:52 +0000224 PollParamInfo *info = opaque;
225 int64_t *field = (void *)iothread + info->offset;
Stefan Hajnoczi0d9d86f2016-12-01 19:26:45 +0000226 Error *local_err = NULL;
227 int64_t value;
228
229 visit_type_int64(v, name, &value, &local_err);
230 if (local_err) {
231 goto out;
232 }
233
234 if (value < 0) {
Stefan Hajnoczi5e5db492016-12-01 19:26:52 +0000235 error_setg(&local_err, "%s value must be in range [0, %"PRId64"]",
236 info->name, INT64_MAX);
Stefan Hajnoczi0d9d86f2016-12-01 19:26:45 +0000237 goto out;
238 }
239
Stefan Hajnoczi5e5db492016-12-01 19:26:52 +0000240 *field = value;
Stefan Hajnoczi0d9d86f2016-12-01 19:26:45 +0000241
242 if (iothread->ctx) {
Stefan Hajnoczi5e5db492016-12-01 19:26:52 +0000243 aio_context_set_poll_params(iothread->ctx,
244 iothread->poll_max_ns,
245 iothread->poll_grow,
246 iothread->poll_shrink,
247 &local_err);
Stefan Hajnoczi0d9d86f2016-12-01 19:26:45 +0000248 }
249
250out:
251 error_propagate(errp, local_err);
252}
253
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +0100254static void iothread_class_init(ObjectClass *klass, void *class_data)
255{
256 UserCreatableClass *ucc = USER_CREATABLE_CLASS(klass);
257 ucc->complete = iothread_complete;
Stefan Hajnoczi0d9d86f2016-12-01 19:26:45 +0000258
259 object_class_property_add(klass, "poll-max-ns", "int",
Stefan Hajnoczi5e5db492016-12-01 19:26:52 +0000260 iothread_get_poll_param,
261 iothread_set_poll_param,
262 NULL, &poll_max_ns_info, &error_abort);
263 object_class_property_add(klass, "poll-grow", "int",
264 iothread_get_poll_param,
265 iothread_set_poll_param,
266 NULL, &poll_grow_info, &error_abort);
267 object_class_property_add(klass, "poll-shrink", "int",
268 iothread_get_poll_param,
269 iothread_set_poll_param,
270 NULL, &poll_shrink_info, &error_abort);
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +0100271}
272
273static const TypeInfo iothread_info = {
274 .name = TYPE_IOTHREAD,
275 .parent = TYPE_OBJECT,
276 .class_init = iothread_class_init,
277 .instance_size = sizeof(IOThread),
Stefan Hajnoczicdd7abf2017-01-26 17:01:19 +0000278 .instance_init = iothread_instance_init,
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +0100279 .instance_finalize = iothread_instance_finalize,
280 .interfaces = (InterfaceInfo[]) {
281 {TYPE_USER_CREATABLE},
282 {}
283 },
284};
285
286static void iothread_register_types(void)
287{
288 type_register_static(&iothread_info);
289}
290
291type_init(iothread_register_types)
292
Stefan Hajnoczibe8d8532014-03-03 11:30:05 +0100293char *iothread_get_id(IOThread *iothread)
294{
295 return object_get_canonical_path_component(OBJECT(iothread));
296}
297
298AioContext *iothread_get_aio_context(IOThread *iothread)
299{
300 return iothread->ctx;
301}
Stefan Hajnoczidc3dd0d2014-02-27 11:48:42 +0100302
303static int query_one_iothread(Object *object, void *opaque)
304{
305 IOThreadInfoList ***prev = opaque;
306 IOThreadInfoList *elem;
307 IOThreadInfo *info;
308 IOThread *iothread;
309
310 iothread = (IOThread *)object_dynamic_cast(object, TYPE_IOTHREAD);
311 if (!iothread) {
312 return 0;
313 }
314
315 info = g_new0(IOThreadInfo, 1);
316 info->id = iothread_get_id(iothread);
317 info->thread_id = iothread->thread_id;
Pavel Hrdina5fc00482017-02-10 10:41:17 +0100318 info->poll_max_ns = iothread->poll_max_ns;
319 info->poll_grow = iothread->poll_grow;
320 info->poll_shrink = iothread->poll_shrink;
Stefan Hajnoczidc3dd0d2014-02-27 11:48:42 +0100321
322 elem = g_new0(IOThreadInfoList, 1);
323 elem->value = info;
324 elem->next = NULL;
325
326 **prev = elem;
327 *prev = &elem->next;
328 return 0;
329}
330
331IOThreadInfoList *qmp_query_iothreads(Error **errp)
332{
333 IOThreadInfoList *head = NULL;
334 IOThreadInfoList **prev = &head;
Daniel P. Berrangebc2256c2015-05-13 17:14:05 +0100335 Object *container = object_get_objects_root();
Stefan Hajnoczidc3dd0d2014-02-27 11:48:42 +0100336
337 object_child_foreach(container, query_one_iothread, &prev);
338 return head;
339}
Fam Zhengdce89212016-09-08 17:28:51 +0800340
Wang Yong329163c2017-08-29 15:22:37 +0800341static gpointer iothread_g_main_context_init(gpointer opaque)
342{
343 AioContext *ctx;
344 IOThread *iothread = opaque;
345 GSource *source;
346
347 iothread->worker_context = g_main_context_new();
348
349 ctx = iothread_get_aio_context(iothread);
350 source = aio_get_g_source(ctx);
351 g_source_attach(source, iothread->worker_context);
352 g_source_unref(source);
353
354 aio_notify(iothread->ctx);
355 return NULL;
356}
357
358GMainContext *iothread_get_g_main_context(IOThread *iothread)
359{
360 g_once(&iothread->once, iothread_g_main_context_init, iothread);
361
362 return iothread->worker_context;
363}
Peter Xu0173e212017-09-28 10:59:55 +0800364
365IOThread *iothread_create(const char *id, Error **errp)
366{
367 Object *obj;
368
369 obj = object_new_with_props(TYPE_IOTHREAD,
370 object_get_internal_root(),
371 id, errp, NULL);
372
373 return IOTHREAD(obj);
374}
375
376void iothread_destroy(IOThread *iothread)
377{
378 object_unparent(OBJECT(iothread));
379}
Stefan Hajnoczifbcc6922017-12-06 14:45:48 +0000380
381/* Lookup IOThread by its id. Only finds user-created objects, not internal
382 * iothread_create() objects. */
383IOThread *iothread_by_id(const char *id)
384{
385 return IOTHREAD(object_resolve_path_type(id, TYPE_IOTHREAD, NULL));
386}