xref: /openbmc/qemu/replay/replay-events.c (revision 0b30dc01)
1c0c071d0SPavel Dovgalyuk /*
2c0c071d0SPavel Dovgalyuk  * replay-events.c
3c0c071d0SPavel Dovgalyuk  *
4c0c071d0SPavel Dovgalyuk  * Copyright (c) 2010-2015 Institute for System Programming
5c0c071d0SPavel Dovgalyuk  *                         of the Russian Academy of Sciences.
6c0c071d0SPavel Dovgalyuk  *
7c0c071d0SPavel Dovgalyuk  * This work is licensed under the terms of the GNU GPL, version 2 or later.
8c0c071d0SPavel Dovgalyuk  * See the COPYING file in the top-level directory.
9c0c071d0SPavel Dovgalyuk  *
10c0c071d0SPavel Dovgalyuk  */
11c0c071d0SPavel Dovgalyuk 
12d38ea87aSPeter Maydell #include "qemu/osdep.h"
13c0c071d0SPavel Dovgalyuk #include "qemu-common.h"
14c0c071d0SPavel Dovgalyuk #include "qemu/error-report.h"
15c0c071d0SPavel Dovgalyuk #include "sysemu/replay.h"
16c0c071d0SPavel Dovgalyuk #include "replay-internal.h"
178a354bd9SPavel Dovgalyuk #include "block/aio.h"
18ee312992SPavel Dovgalyuk #include "ui/input.h"
19c0c071d0SPavel Dovgalyuk 
20c0c071d0SPavel Dovgalyuk typedef struct Event {
21c0c071d0SPavel Dovgalyuk     ReplayAsyncEventKind event_kind;
22c0c071d0SPavel Dovgalyuk     void *opaque;
23c0c071d0SPavel Dovgalyuk     void *opaque2;
24c0c071d0SPavel Dovgalyuk     uint64_t id;
25c0c071d0SPavel Dovgalyuk 
26c0c071d0SPavel Dovgalyuk     QTAILQ_ENTRY(Event) events;
27c0c071d0SPavel Dovgalyuk } Event;
28c0c071d0SPavel Dovgalyuk 
29c0c071d0SPavel Dovgalyuk static QTAILQ_HEAD(, Event) events_list = QTAILQ_HEAD_INITIALIZER(events_list);
30c0c071d0SPavel Dovgalyuk static bool events_enabled;
31c0c071d0SPavel Dovgalyuk 
32c0c071d0SPavel Dovgalyuk /* Functions */
33c0c071d0SPavel Dovgalyuk 
34c0c071d0SPavel Dovgalyuk static void replay_run_event(Event *event)
35c0c071d0SPavel Dovgalyuk {
36c0c071d0SPavel Dovgalyuk     switch (event->event_kind) {
378a354bd9SPavel Dovgalyuk     case REPLAY_ASYNC_EVENT_BH:
388a354bd9SPavel Dovgalyuk         aio_bh_call(event->opaque);
398a354bd9SPavel Dovgalyuk         break;
40ee312992SPavel Dovgalyuk     case REPLAY_ASYNC_EVENT_INPUT:
41ee312992SPavel Dovgalyuk         qemu_input_event_send_impl(NULL, (InputEvent *)event->opaque);
42ee312992SPavel Dovgalyuk         qapi_free_InputEvent((InputEvent *)event->opaque);
43ee312992SPavel Dovgalyuk         break;
44ee312992SPavel Dovgalyuk     case REPLAY_ASYNC_EVENT_INPUT_SYNC:
45ee312992SPavel Dovgalyuk         qemu_input_event_sync_impl();
46ee312992SPavel Dovgalyuk         break;
4733577b47SPavel Dovgalyuk     case REPLAY_ASYNC_EVENT_CHAR_READ:
4833577b47SPavel Dovgalyuk         replay_event_char_read_run(event->opaque);
4933577b47SPavel Dovgalyuk         break;
5063785678SPavel Dovgalyuk     case REPLAY_ASYNC_EVENT_BLOCK:
5163785678SPavel Dovgalyuk         aio_bh_call(event->opaque);
5263785678SPavel Dovgalyuk         break;
53646c5478SPavel Dovgalyuk     case REPLAY_ASYNC_EVENT_NET:
54646c5478SPavel Dovgalyuk         replay_event_net_run(event->opaque);
55646c5478SPavel Dovgalyuk         break;
56c0c071d0SPavel Dovgalyuk     default:
57c0c071d0SPavel Dovgalyuk         error_report("Replay: invalid async event ID (%d) in the queue",
58c0c071d0SPavel Dovgalyuk                     event->event_kind);
59c0c071d0SPavel Dovgalyuk         exit(1);
60c0c071d0SPavel Dovgalyuk         break;
61c0c071d0SPavel Dovgalyuk     }
62c0c071d0SPavel Dovgalyuk }
63c0c071d0SPavel Dovgalyuk 
64c0c071d0SPavel Dovgalyuk void replay_enable_events(void)
65c0c071d0SPavel Dovgalyuk {
661652e0c3SPavel Dovgalyuk     if (replay_mode != REPLAY_MODE_NONE) {
67c0c071d0SPavel Dovgalyuk         events_enabled = true;
68c0c071d0SPavel Dovgalyuk     }
691652e0c3SPavel Dovgalyuk }
70c0c071d0SPavel Dovgalyuk 
71c0c071d0SPavel Dovgalyuk bool replay_has_events(void)
72c0c071d0SPavel Dovgalyuk {
73c0c071d0SPavel Dovgalyuk     return !QTAILQ_EMPTY(&events_list);
74c0c071d0SPavel Dovgalyuk }
75c0c071d0SPavel Dovgalyuk 
76c0c071d0SPavel Dovgalyuk void replay_flush_events(void)
77c0c071d0SPavel Dovgalyuk {
78d759c951SAlex Bennée     g_assert(replay_mutex_locked());
79d759c951SAlex Bennée 
80c0c071d0SPavel Dovgalyuk     while (!QTAILQ_EMPTY(&events_list)) {
81c0c071d0SPavel Dovgalyuk         Event *event = QTAILQ_FIRST(&events_list);
82c0c071d0SPavel Dovgalyuk         replay_run_event(event);
83c0c071d0SPavel Dovgalyuk         QTAILQ_REMOVE(&events_list, event, events);
84c0c071d0SPavel Dovgalyuk         g_free(event);
85c0c071d0SPavel Dovgalyuk     }
86c0c071d0SPavel Dovgalyuk }
87c0c071d0SPavel Dovgalyuk 
88c0c071d0SPavel Dovgalyuk void replay_disable_events(void)
89c0c071d0SPavel Dovgalyuk {
90c0c071d0SPavel Dovgalyuk     if (replay_mode != REPLAY_MODE_NONE) {
91c0c071d0SPavel Dovgalyuk         events_enabled = false;
92c0c071d0SPavel Dovgalyuk         /* Flush events queue before waiting of completion */
93c0c071d0SPavel Dovgalyuk         replay_flush_events();
94c0c071d0SPavel Dovgalyuk     }
95c0c071d0SPavel Dovgalyuk }
96c0c071d0SPavel Dovgalyuk 
97c0c071d0SPavel Dovgalyuk void replay_clear_events(void)
98c0c071d0SPavel Dovgalyuk {
99d759c951SAlex Bennée     g_assert(replay_mutex_locked());
100d759c951SAlex Bennée 
101c0c071d0SPavel Dovgalyuk     while (!QTAILQ_EMPTY(&events_list)) {
102c0c071d0SPavel Dovgalyuk         Event *event = QTAILQ_FIRST(&events_list);
103c0c071d0SPavel Dovgalyuk         QTAILQ_REMOVE(&events_list, event, events);
104c0c071d0SPavel Dovgalyuk 
105c0c071d0SPavel Dovgalyuk         g_free(event);
106c0c071d0SPavel Dovgalyuk     }
107c0c071d0SPavel Dovgalyuk }
108c0c071d0SPavel Dovgalyuk 
109c0c071d0SPavel Dovgalyuk /*! Adds specified async event to the queue */
11033577b47SPavel Dovgalyuk void replay_add_event(ReplayAsyncEventKind event_kind,
111c0c071d0SPavel Dovgalyuk                       void *opaque,
112c0c071d0SPavel Dovgalyuk                       void *opaque2, uint64_t id)
113c0c071d0SPavel Dovgalyuk {
114c0c071d0SPavel Dovgalyuk     assert(event_kind < REPLAY_ASYNC_COUNT);
115c0c071d0SPavel Dovgalyuk 
116c0c071d0SPavel Dovgalyuk     if (!replay_file || replay_mode == REPLAY_MODE_NONE
117c0c071d0SPavel Dovgalyuk         || !events_enabled) {
118c0c071d0SPavel Dovgalyuk         Event e;
119c0c071d0SPavel Dovgalyuk         e.event_kind = event_kind;
120c0c071d0SPavel Dovgalyuk         e.opaque = opaque;
121c0c071d0SPavel Dovgalyuk         e.opaque2 = opaque2;
122c0c071d0SPavel Dovgalyuk         e.id = id;
123c0c071d0SPavel Dovgalyuk         replay_run_event(&e);
124c0c071d0SPavel Dovgalyuk         return;
125c0c071d0SPavel Dovgalyuk     }
126c0c071d0SPavel Dovgalyuk 
127c0c071d0SPavel Dovgalyuk     Event *event = g_malloc0(sizeof(Event));
128c0c071d0SPavel Dovgalyuk     event->event_kind = event_kind;
129c0c071d0SPavel Dovgalyuk     event->opaque = opaque;
130c0c071d0SPavel Dovgalyuk     event->opaque2 = opaque2;
131c0c071d0SPavel Dovgalyuk     event->id = id;
132c0c071d0SPavel Dovgalyuk 
133d759c951SAlex Bennée     g_assert(replay_mutex_locked());
134c0c071d0SPavel Dovgalyuk     QTAILQ_INSERT_TAIL(&events_list, event, events);
135c0c071d0SPavel Dovgalyuk }
1368a354bd9SPavel Dovgalyuk 
1378a354bd9SPavel Dovgalyuk void replay_bh_schedule_event(QEMUBH *bh)
1388a354bd9SPavel Dovgalyuk {
1391652e0c3SPavel Dovgalyuk     if (events_enabled) {
1408a354bd9SPavel Dovgalyuk         uint64_t id = replay_get_current_step();
1418a354bd9SPavel Dovgalyuk         replay_add_event(REPLAY_ASYNC_EVENT_BH, bh, NULL, id);
1428a354bd9SPavel Dovgalyuk     } else {
1438a354bd9SPavel Dovgalyuk         qemu_bh_schedule(bh);
1448a354bd9SPavel Dovgalyuk     }
1458a354bd9SPavel Dovgalyuk }
146c0c071d0SPavel Dovgalyuk 
147ee312992SPavel Dovgalyuk void replay_add_input_event(struct InputEvent *event)
148ee312992SPavel Dovgalyuk {
149ee312992SPavel Dovgalyuk     replay_add_event(REPLAY_ASYNC_EVENT_INPUT, event, NULL, 0);
150ee312992SPavel Dovgalyuk }
151ee312992SPavel Dovgalyuk 
152ee312992SPavel Dovgalyuk void replay_add_input_sync_event(void)
153ee312992SPavel Dovgalyuk {
154ee312992SPavel Dovgalyuk     replay_add_event(REPLAY_ASYNC_EVENT_INPUT_SYNC, NULL, NULL, 0);
155ee312992SPavel Dovgalyuk }
156ee312992SPavel Dovgalyuk 
15763785678SPavel Dovgalyuk void replay_block_event(QEMUBH *bh, uint64_t id)
15863785678SPavel Dovgalyuk {
1591652e0c3SPavel Dovgalyuk     if (events_enabled) {
16063785678SPavel Dovgalyuk         replay_add_event(REPLAY_ASYNC_EVENT_BLOCK, bh, NULL, id);
16163785678SPavel Dovgalyuk     } else {
16263785678SPavel Dovgalyuk         qemu_bh_schedule(bh);
16363785678SPavel Dovgalyuk     }
16463785678SPavel Dovgalyuk }
16563785678SPavel Dovgalyuk 
166c0c071d0SPavel Dovgalyuk static void replay_save_event(Event *event, int checkpoint)
167c0c071d0SPavel Dovgalyuk {
168c0c071d0SPavel Dovgalyuk     if (replay_mode != REPLAY_MODE_PLAY) {
169c0c071d0SPavel Dovgalyuk         /* put the event into the file */
170c0c071d0SPavel Dovgalyuk         replay_put_event(EVENT_ASYNC);
171c0c071d0SPavel Dovgalyuk         replay_put_byte(checkpoint);
172c0c071d0SPavel Dovgalyuk         replay_put_byte(event->event_kind);
173c0c071d0SPavel Dovgalyuk 
174c0c071d0SPavel Dovgalyuk         /* save event-specific data */
175c0c071d0SPavel Dovgalyuk         switch (event->event_kind) {
1768a354bd9SPavel Dovgalyuk         case REPLAY_ASYNC_EVENT_BH:
1778a354bd9SPavel Dovgalyuk             replay_put_qword(event->id);
1788a354bd9SPavel Dovgalyuk             break;
179ee312992SPavel Dovgalyuk         case REPLAY_ASYNC_EVENT_INPUT:
180ee312992SPavel Dovgalyuk             replay_save_input_event(event->opaque);
181ee312992SPavel Dovgalyuk             break;
182ee312992SPavel Dovgalyuk         case REPLAY_ASYNC_EVENT_INPUT_SYNC:
183ee312992SPavel Dovgalyuk             break;
18433577b47SPavel Dovgalyuk         case REPLAY_ASYNC_EVENT_CHAR_READ:
18533577b47SPavel Dovgalyuk             replay_event_char_read_save(event->opaque);
18633577b47SPavel Dovgalyuk             break;
18763785678SPavel Dovgalyuk         case REPLAY_ASYNC_EVENT_BLOCK:
18863785678SPavel Dovgalyuk             replay_put_qword(event->id);
18963785678SPavel Dovgalyuk             break;
190646c5478SPavel Dovgalyuk         case REPLAY_ASYNC_EVENT_NET:
191646c5478SPavel Dovgalyuk             replay_event_net_save(event->opaque);
192646c5478SPavel Dovgalyuk             break;
193c0c071d0SPavel Dovgalyuk         default:
19495b4aed5SPavel Dovgalyuk             error_report("Unknown ID %" PRId64 " of replay event", event->id);
195c0c071d0SPavel Dovgalyuk             exit(1);
196c0c071d0SPavel Dovgalyuk         }
197c0c071d0SPavel Dovgalyuk     }
198c0c071d0SPavel Dovgalyuk }
199c0c071d0SPavel Dovgalyuk 
200c0c071d0SPavel Dovgalyuk /* Called with replay mutex locked */
201c0c071d0SPavel Dovgalyuk void replay_save_events(int checkpoint)
202c0c071d0SPavel Dovgalyuk {
203d759c951SAlex Bennée     g_assert(replay_mutex_locked());
20489e46eb4SPavel Dovgalyuk     g_assert(checkpoint != CHECKPOINT_CLOCK_WARP_START);
205c0c071d0SPavel Dovgalyuk     while (!QTAILQ_EMPTY(&events_list)) {
206c0c071d0SPavel Dovgalyuk         Event *event = QTAILQ_FIRST(&events_list);
207c0c071d0SPavel Dovgalyuk         replay_save_event(event, checkpoint);
208c0c071d0SPavel Dovgalyuk         replay_run_event(event);
209c0c071d0SPavel Dovgalyuk         QTAILQ_REMOVE(&events_list, event, events);
210c0c071d0SPavel Dovgalyuk         g_free(event);
211c0c071d0SPavel Dovgalyuk     }
212c0c071d0SPavel Dovgalyuk }
213c0c071d0SPavel Dovgalyuk 
214c0c071d0SPavel Dovgalyuk static Event *replay_read_event(int checkpoint)
215c0c071d0SPavel Dovgalyuk {
216c0c071d0SPavel Dovgalyuk     Event *event;
217*0b30dc01SPavel Dovgalyuk     if (replay_state.read_event_kind == -1) {
218*0b30dc01SPavel Dovgalyuk         replay_state.read_event_checkpoint = replay_get_byte();
219*0b30dc01SPavel Dovgalyuk         replay_state.read_event_kind = replay_get_byte();
220*0b30dc01SPavel Dovgalyuk         replay_state.read_event_id = -1;
221c0c071d0SPavel Dovgalyuk         replay_check_error();
222c0c071d0SPavel Dovgalyuk     }
223c0c071d0SPavel Dovgalyuk 
224*0b30dc01SPavel Dovgalyuk     if (checkpoint != replay_state.read_event_checkpoint) {
225c0c071d0SPavel Dovgalyuk         return NULL;
226c0c071d0SPavel Dovgalyuk     }
227c0c071d0SPavel Dovgalyuk 
228c0c071d0SPavel Dovgalyuk     /* Events that has not to be in the queue */
229*0b30dc01SPavel Dovgalyuk     switch (replay_state.read_event_kind) {
2308a354bd9SPavel Dovgalyuk     case REPLAY_ASYNC_EVENT_BH:
231*0b30dc01SPavel Dovgalyuk         if (replay_state.read_event_id == -1) {
232*0b30dc01SPavel Dovgalyuk             replay_state.read_event_id = replay_get_qword();
2338a354bd9SPavel Dovgalyuk         }
2348a354bd9SPavel Dovgalyuk         break;
235ee312992SPavel Dovgalyuk     case REPLAY_ASYNC_EVENT_INPUT:
236ee312992SPavel Dovgalyuk         event = g_malloc0(sizeof(Event));
237*0b30dc01SPavel Dovgalyuk         event->event_kind = replay_state.read_event_kind;
238ee312992SPavel Dovgalyuk         event->opaque = replay_read_input_event();
239ee312992SPavel Dovgalyuk         return event;
240ee312992SPavel Dovgalyuk     case REPLAY_ASYNC_EVENT_INPUT_SYNC:
241ee312992SPavel Dovgalyuk         event = g_malloc0(sizeof(Event));
242*0b30dc01SPavel Dovgalyuk         event->event_kind = replay_state.read_event_kind;
243ee312992SPavel Dovgalyuk         event->opaque = 0;
244ee312992SPavel Dovgalyuk         return event;
24533577b47SPavel Dovgalyuk     case REPLAY_ASYNC_EVENT_CHAR_READ:
24633577b47SPavel Dovgalyuk         event = g_malloc0(sizeof(Event));
247*0b30dc01SPavel Dovgalyuk         event->event_kind = replay_state.read_event_kind;
24833577b47SPavel Dovgalyuk         event->opaque = replay_event_char_read_load();
24933577b47SPavel Dovgalyuk         return event;
25063785678SPavel Dovgalyuk     case REPLAY_ASYNC_EVENT_BLOCK:
251*0b30dc01SPavel Dovgalyuk         if (replay_state.read_event_id == -1) {
252*0b30dc01SPavel Dovgalyuk             replay_state.read_event_id = replay_get_qword();
25363785678SPavel Dovgalyuk         }
25463785678SPavel Dovgalyuk         break;
255646c5478SPavel Dovgalyuk     case REPLAY_ASYNC_EVENT_NET:
256646c5478SPavel Dovgalyuk         event = g_malloc0(sizeof(Event));
257*0b30dc01SPavel Dovgalyuk         event->event_kind = replay_state.read_event_kind;
258646c5478SPavel Dovgalyuk         event->opaque = replay_event_net_load();
259646c5478SPavel Dovgalyuk         return event;
260c0c071d0SPavel Dovgalyuk     default:
261*0b30dc01SPavel Dovgalyuk         error_report("Unknown ID %d of replay event",
262*0b30dc01SPavel Dovgalyuk             replay_state.read_event_kind);
263c0c071d0SPavel Dovgalyuk         exit(1);
264c0c071d0SPavel Dovgalyuk         break;
265c0c071d0SPavel Dovgalyuk     }
266c0c071d0SPavel Dovgalyuk 
267c0c071d0SPavel Dovgalyuk     QTAILQ_FOREACH(event, &events_list, events) {
268*0b30dc01SPavel Dovgalyuk         if (event->event_kind == replay_state.read_event_kind
269*0b30dc01SPavel Dovgalyuk             && (replay_state.read_event_id == -1
270*0b30dc01SPavel Dovgalyuk                 || replay_state.read_event_id == event->id)) {
271c0c071d0SPavel Dovgalyuk             break;
272c0c071d0SPavel Dovgalyuk         }
273c0c071d0SPavel Dovgalyuk     }
274c0c071d0SPavel Dovgalyuk 
275c0c071d0SPavel Dovgalyuk     if (event) {
276c0c071d0SPavel Dovgalyuk         QTAILQ_REMOVE(&events_list, event, events);
277c0c071d0SPavel Dovgalyuk     } else {
278c0c071d0SPavel Dovgalyuk         return NULL;
279c0c071d0SPavel Dovgalyuk     }
280c0c071d0SPavel Dovgalyuk 
281c0c071d0SPavel Dovgalyuk     /* Read event-specific data */
282c0c071d0SPavel Dovgalyuk 
283c0c071d0SPavel Dovgalyuk     return event;
284c0c071d0SPavel Dovgalyuk }
285c0c071d0SPavel Dovgalyuk 
286c0c071d0SPavel Dovgalyuk /* Called with replay mutex locked */
287c0c071d0SPavel Dovgalyuk void replay_read_events(int checkpoint)
288c0c071d0SPavel Dovgalyuk {
289d759c951SAlex Bennée     g_assert(replay_mutex_locked());
290f186d64dSPavel Dovgalyuk     while (replay_state.data_kind == EVENT_ASYNC) {
291c0c071d0SPavel Dovgalyuk         Event *event = replay_read_event(checkpoint);
292c0c071d0SPavel Dovgalyuk         if (!event) {
293c0c071d0SPavel Dovgalyuk             break;
294c0c071d0SPavel Dovgalyuk         }
2951a96e3c1SPavel Dovgalyuk         replay_finish_event();
296*0b30dc01SPavel Dovgalyuk         replay_state.read_event_kind = -1;
297c0c071d0SPavel Dovgalyuk         replay_run_event(event);
298c0c071d0SPavel Dovgalyuk 
299c0c071d0SPavel Dovgalyuk         g_free(event);
300c0c071d0SPavel Dovgalyuk     }
301c0c071d0SPavel Dovgalyuk }
302c0c071d0SPavel Dovgalyuk 
303c0c071d0SPavel Dovgalyuk void replay_init_events(void)
304c0c071d0SPavel Dovgalyuk {
305*0b30dc01SPavel Dovgalyuk     replay_state.read_event_kind = -1;
306c0c071d0SPavel Dovgalyuk }
307c0c071d0SPavel Dovgalyuk 
308c0c071d0SPavel Dovgalyuk void replay_finish_events(void)
309c0c071d0SPavel Dovgalyuk {
310c0c071d0SPavel Dovgalyuk     events_enabled = false;
311c0c071d0SPavel Dovgalyuk     replay_clear_events();
312c0c071d0SPavel Dovgalyuk }
313c0c071d0SPavel Dovgalyuk 
314c0c071d0SPavel Dovgalyuk bool replay_events_enabled(void)
315c0c071d0SPavel Dovgalyuk {
316c0c071d0SPavel Dovgalyuk     return events_enabled;
317c0c071d0SPavel Dovgalyuk }
3186d0ceb80SPavel Dovgalyuk 
3196d0ceb80SPavel Dovgalyuk uint64_t blkreplay_next_id(void)
3206d0ceb80SPavel Dovgalyuk {
3216d0ceb80SPavel Dovgalyuk     if (replay_events_enabled()) {
3226d0ceb80SPavel Dovgalyuk         return replay_state.block_request_id++;
3236d0ceb80SPavel Dovgalyuk     }
3246d0ceb80SPavel Dovgalyuk     return 0;
3256d0ceb80SPavel Dovgalyuk }
326