[qemu.git] / replay / replay-events.c

/*
 * replay-events.c
 *
 * Copyright (c) 2010-2015 Institute for System Programming
 *                         of the Russian Academy of Sciences.
 *
 * This work is licensed under the terms of the GNU GPL, version 2 or later.
 * See the COPYING file in the top-level directory.
 *
 */

#include "qemu/osdep.h"
#include "qemu/error-report.h"
#include "sysemu/replay.h"
#include "replay-internal.h"
#include "block/aio.h"
#include "ui/input.h"

typedef struct Event {
    ReplayAsyncEventKind event_kind;
    void *opaque;
    void *opaque2;
    uint64_t id;

    QTAILQ_ENTRY(Event) events;
} Event;

static QTAILQ_HEAD(, Event) events_list = QTAILQ_HEAD_INITIALIZER(events_list);
static bool events_enabled;

/* Functions */

static void replay_run_event(Event *event)
{
    switch (event->event_kind) {
    case REPLAY_ASYNC_EVENT_BH:
        aio_bh_call(event->opaque);
        break;
    case REPLAY_ASYNC_EVENT_BH_ONESHOT:
        ((QEMUBHFunc *)event->opaque)(event->opaque2);
        break;
    case REPLAY_ASYNC_EVENT_INPUT:
        qemu_input_event_send_impl(NULL, (InputEvent *)event->opaque);
        qapi_free_InputEvent((InputEvent *)event->opaque);
        break;
    case REPLAY_ASYNC_EVENT_INPUT_SYNC:
        qemu_input_event_sync_impl();
        break;
    case REPLAY_ASYNC_EVENT_CHAR_READ:
        replay_event_char_read_run(event->opaque);
        break;
    case REPLAY_ASYNC_EVENT_BLOCK:
        aio_bh_call(event->opaque);
        break;
    case REPLAY_ASYNC_EVENT_NET:
        replay_event_net_run(event->opaque);
        break;
    default:
        error_report("Replay: invalid async event ID (%d) in the queue",
                    event->event_kind);
        exit(1);
        break;
    }
}

void replay_enable_events(void)
{
    if (replay_mode != REPLAY_MODE_NONE) {
        events_enabled = true;
    }
}

bool replay_has_events(void)
{
    return !QTAILQ_EMPTY(&events_list);
}

void replay_flush_events(void)
{
    g_assert(replay_mutex_locked());

    while (!QTAILQ_EMPTY(&events_list)) {
        Event *event = QTAILQ_FIRST(&events_list);
        replay_run_event(event);
        QTAILQ_REMOVE(&events_list, event, events);
        g_free(event);
    }
}

void replay_disable_events(void)
{
    if (replay_mode != REPLAY_MODE_NONE) {
        events_enabled = false;
        /* Flush events queue before waiting of completion */
        replay_flush_events();
    }
}

/*! Adds specified async event to the queue */
void replay_add_event(ReplayAsyncEventKind event_kind,
                      void *opaque,
                      void *opaque2, uint64_t id)
{
    assert(event_kind < REPLAY_ASYNC_COUNT);

    if (!replay_file || replay_mode == REPLAY_MODE_NONE
        || !events_enabled) {
        Event e;
        e.event_kind = event_kind;
        e.opaque = opaque;
        e.opaque2 = opaque2;
        e.id = id;
        replay_run_event(&e);
        return;
    }

    Event *event = g_malloc0(sizeof(Event));
    event->event_kind = event_kind;
    event->opaque = opaque;
    event->opaque2 = opaque2;
    event->id = id;

    g_assert(replay_mutex_locked());
    QTAILQ_INSERT_TAIL(&events_list, event, events);
}

void replay_bh_schedule_event(QEMUBH *bh)
{
    if (events_enabled) {
        uint64_t id = replay_get_current_icount();
        replay_add_event(REPLAY_ASYNC_EVENT_BH, bh, NULL, id);
    } else {
        qemu_bh_schedule(bh);
    }
}

void replay_bh_schedule_oneshot_event(AioContext *ctx,
    QEMUBHFunc *cb, void *opaque)
{
    if (events_enabled) {
        uint64_t id = replay_get_current_icount();
        replay_add_event(REPLAY_ASYNC_EVENT_BH_ONESHOT, cb, opaque, id);
    } else {
        aio_bh_schedule_oneshot(ctx, cb, opaque);
    }
}

void replay_add_input_event(struct InputEvent *event)
{
    replay_add_event(REPLAY_ASYNC_EVENT_INPUT, event, NULL, 0);
}

void replay_add_input_sync_event(void)
{
    replay_add_event(REPLAY_ASYNC_EVENT_INPUT_SYNC, NULL, NULL, 0);
}

void replay_block_event(QEMUBH *bh, uint64_t id)
{
    if (events_enabled) {
        replay_add_event(REPLAY_ASYNC_EVENT_BLOCK, bh, NULL, id);
    } else {
        qemu_bh_schedule(bh);
    }
}

static void replay_save_event(Event *event, int checkpoint)
{
    if (replay_mode != REPLAY_MODE_PLAY) {
        /* put the event into the file */
        replay_put_event(EVENT_ASYNC);
        replay_put_byte(checkpoint);
        replay_put_byte(event->event_kind);

        /* save event-specific data */
        switch (event->event_kind) {
        case REPLAY_ASYNC_EVENT_BH:
        case REPLAY_ASYNC_EVENT_BH_ONESHOT:
            replay_put_qword(event->id);
            break;
        case REPLAY_ASYNC_EVENT_INPUT:
            replay_save_input_event(event->opaque);
            break;
        case REPLAY_ASYNC_EVENT_INPUT_SYNC:
            break;
        case REPLAY_ASYNC_EVENT_CHAR_READ:
            replay_event_char_read_save(event->opaque);
            break;
        case REPLAY_ASYNC_EVENT_BLOCK:
            replay_put_qword(event->id);
            break;
        case REPLAY_ASYNC_EVENT_NET:
            replay_event_net_save(event->opaque);
            break;
        default:
            error_report("Unknown ID %" PRId64 " of replay event", event->id);
            exit(1);
        }
    }
}

/* Called with replay mutex locked */
void replay_save_events(int checkpoint)
{
    g_assert(replay_mutex_locked());
    g_assert(checkpoint != CHECKPOINT_CLOCK_WARP_START);
    g_assert(checkpoint != CHECKPOINT_CLOCK_VIRTUAL);
    while (!QTAILQ_EMPTY(&events_list)) {
        Event *event = QTAILQ_FIRST(&events_list);
        replay_save_event(event, checkpoint);
        replay_run_event(event);
        QTAILQ_REMOVE(&events_list, event, events);
        g_free(event);
    }
}

static Event *replay_read_event(int checkpoint)
{
    Event *event;
    if (replay_state.read_event_kind == -1) {
        replay_state.read_event_checkpoint = replay_get_byte();
        replay_state.read_event_kind = replay_get_byte();
        replay_state.read_event_id = -1;
        replay_check_error();
    }

    if (checkpoint != replay_state.read_event_checkpoint) {
        return NULL;
    }

    /* Events that has not to be in the queue */
    switch (replay_state.read_event_kind) {
    case REPLAY_ASYNC_EVENT_BH:
    case REPLAY_ASYNC_EVENT_BH_ONESHOT:
        if (replay_state.read_event_id == -1) {
            replay_state.read_event_id = replay_get_qword();
        }
        break;
    case REPLAY_ASYNC_EVENT_INPUT:
        event = g_malloc0(sizeof(Event));
        event->event_kind = replay_state.read_event_kind;
        event->opaque = replay_read_input_event();
        return event;
    case REPLAY_ASYNC_EVENT_INPUT_SYNC:
        event = g_malloc0(sizeof(Event));
        event->event_kind = replay_state.read_event_kind;
        event->opaque = 0;
        return event;
    case REPLAY_ASYNC_EVENT_CHAR_READ:
        event = g_malloc0(sizeof(Event));
        event->event_kind = replay_state.read_event_kind;
        event->opaque = replay_event_char_read_load();
        return event;
    case REPLAY_ASYNC_EVENT_BLOCK:
        if (replay_state.read_event_id == -1) {
            replay_state.read_event_id = replay_get_qword();
        }
        break;
    case REPLAY_ASYNC_EVENT_NET:
        event = g_malloc0(sizeof(Event));
        event->event_kind = replay_state.read_event_kind;
        event->opaque = replay_event_net_load();
        return event;
    default:
        error_report("Unknown ID %d of replay event",
            replay_state.read_event_kind);
        exit(1);
        break;
    }

    QTAILQ_FOREACH(event, &events_list, events) {
        if (event->event_kind == replay_state.read_event_kind
            && (replay_state.read_event_id == -1
                || replay_state.read_event_id == event->id)) {
            break;
        }
    }

    if (event) {
        QTAILQ_REMOVE(&events_list, event, events);
    } else {
        return NULL;
    }

    /* Read event-specific data */

    return event;
}

/* Called with replay mutex locked */
void replay_read_events(int checkpoint)
{
    g_assert(replay_mutex_locked());
    while (replay_state.data_kind == EVENT_ASYNC) {
        Event *event = replay_read_event(checkpoint);
        if (!event) {
            break;
        }
        replay_finish_event();
        replay_state.read_event_kind = -1;
        replay_run_event(event);

        g_free(event);
    }
}

void replay_init_events(void)
{
    replay_state.read_event_kind = -1;
}

void replay_finish_events(void)
{
    events_enabled = false;
    replay_flush_events();
}

bool replay_events_enabled(void)
{
    return events_enabled;
}

uint64_t blkreplay_next_id(void)
{
    if (replay_events_enabled()) {
        return replay_state.block_request_id++;
    }
    return 0;
}
Commit	Line	Data
c0c071d0 PD	1	/*
	2	* replay-events.c
	3	*
	4	* Copyright (c) 2010-2015 Institute for System Programming
	5	* of the Russian Academy of Sciences.
	6	*
	7	* This work is licensed under the terms of the GNU GPL, version 2 or later.
	8	* See the COPYING file in the top-level directory.
	9	*
	10	*/
	11
d38ea87a	12	#include "qemu/osdep.h"
c0c071d0 PD	13	#include "qemu/error-report.h"
	14	#include "sysemu/replay.h"
	15	#include "replay-internal.h"
8a354bd9	16	#include "block/aio.h"
ee312992	17	#include "ui/input.h"
c0c071d0 PD	18
	19	typedef struct Event {
	20	ReplayAsyncEventKind event_kind;
	21	void *opaque;
	22	void *opaque2;
	23	uint64_t id;
	24
	25	QTAILQ_ENTRY(Event) events;
	26	} Event;
	27
	28	static QTAILQ_HEAD(, Event) events_list = QTAILQ_HEAD_INITIALIZER(events_list);
c0c071d0 PD	29	static bool events_enabled;
	30
	31	/* Functions */
	32
	33	static void replay_run_event(Event *event)
	34	{
	35	switch (event->event_kind) {
8a354bd9 PD	36	case REPLAY_ASYNC_EVENT_BH:
	37	aio_bh_call(event->opaque);
	38	break;
e4ec5ad4 PD	39	case REPLAY_ASYNC_EVENT_BH_ONESHOT:
	40	((QEMUBHFunc *)event->opaque)(event->opaque2);
	41	break;
ee312992 PD	42	case REPLAY_ASYNC_EVENT_INPUT:
	43	qemu_input_event_send_impl(NULL, (InputEvent *)event->opaque);
	44	qapi_free_InputEvent((InputEvent *)event->opaque);
	45	break;
	46	case REPLAY_ASYNC_EVENT_INPUT_SYNC:
	47	qemu_input_event_sync_impl();
	48	break;
33577b47 PD	49	case REPLAY_ASYNC_EVENT_CHAR_READ:
	50	replay_event_char_read_run(event->opaque);
	51	break;
63785678 PD	52	case REPLAY_ASYNC_EVENT_BLOCK:
	53	aio_bh_call(event->opaque);
	54	break;
646c5478 PD	55	case REPLAY_ASYNC_EVENT_NET:
	56	replay_event_net_run(event->opaque);
	57	break;
c0c071d0 PD	58	default:
	59	error_report("Replay: invalid async event ID (%d) in the queue",
	60	event->event_kind);
	61	exit(1);
	62	break;
	63	}
	64	}
	65
	66	void replay_enable_events(void)
	67	{
1652e0c3 PD	68	if (replay_mode != REPLAY_MODE_NONE) {
	69	events_enabled = true;
	70	}
c0c071d0 PD	71	}
	72
	73	bool replay_has_events(void)
	74	{
	75	return !QTAILQ_EMPTY(&events_list);
	76	}
	77
	78	void replay_flush_events(void)
	79	{
d759c951 AB	80	g_assert(replay_mutex_locked());
d759c951 AB	81
c0c071d0 PD	82	while (!QTAILQ_EMPTY(&events_list)) {
c0c071d0 PD	83	Event *event = QTAILQ_FIRST(&events_list);
c0c071d0	84	replay_run_event(event);
c0c071d0 PD	85	QTAILQ_REMOVE(&events_list, event, events);
	86	g_free(event);
	87	}
c0c071d0 PD	88	}
	89
	90	void replay_disable_events(void)
	91	{
	92	if (replay_mode != REPLAY_MODE_NONE) {
	93	events_enabled = false;
	94	/* Flush events queue before waiting of completion */
	95	replay_flush_events();
	96	}
	97	}
	98
c0c071d0	99	/! Adds specified async event to the queue /
33577b47 PD	100	void replay_add_event(ReplayAsyncEventKind event_kind,
	101	void *opaque,
	102	void *opaque2, uint64_t id)
c0c071d0 PD	103	{
	104	assert(event_kind < REPLAY_ASYNC_COUNT);
	105
	106	if (!replay_file \|\| replay_mode == REPLAY_MODE_NONE
	107	\|\| !events_enabled) {
	108	Event e;
	109	e.event_kind = event_kind;
	110	e.opaque = opaque;
	111	e.opaque2 = opaque2;
	112	e.id = id;
	113	replay_run_event(&e);
	114	return;
	115	}
	116
	117	Event *event = g_malloc0(sizeof(Event));
	118	event->event_kind = event_kind;
	119	event->opaque = opaque;
	120	event->opaque2 = opaque2;
	121	event->id = id;
	122
d759c951	123	g_assert(replay_mutex_locked());
c0c071d0	124	QTAILQ_INSERT_TAIL(&events_list, event, events);
c0c071d0	125	}
8a354bd9 PD	126
	127	void replay_bh_schedule_event(QEMUBH *bh)
	128	{
1652e0c3	129	if (events_enabled) {
13f26713	130	uint64_t id = replay_get_current_icount();
8a354bd9 PD	131	replay_add_event(REPLAY_ASYNC_EVENT_BH, bh, NULL, id);
	132	} else {
	133	qemu_bh_schedule(bh);
	134	}
	135	}
c0c071d0	136
e4ec5ad4 PD	137	void replay_bh_schedule_oneshot_event(AioContext *ctx,
	138	QEMUBHFunc cb, void opaque)
	139	{
	140	if (events_enabled) {
	141	uint64_t id = replay_get_current_icount();
	142	replay_add_event(REPLAY_ASYNC_EVENT_BH_ONESHOT, cb, opaque, id);
	143	} else {
	144	aio_bh_schedule_oneshot(ctx, cb, opaque);
	145	}
	146	}
	147
ee312992 PD	148	void replay_add_input_event(struct InputEvent *event)
	149	{
	150	replay_add_event(REPLAY_ASYNC_EVENT_INPUT, event, NULL, 0);
	151	}
	152
	153	void replay_add_input_sync_event(void)
	154	{
	155	replay_add_event(REPLAY_ASYNC_EVENT_INPUT_SYNC, NULL, NULL, 0);
	156	}
	157
63785678 PD	158	void replay_block_event(QEMUBH *bh, uint64_t id)
63785678 PD	159	{
1652e0c3	160	if (events_enabled) {
63785678 PD	161	replay_add_event(REPLAY_ASYNC_EVENT_BLOCK, bh, NULL, id);
	162	} else {
	163	qemu_bh_schedule(bh);
	164	}
	165	}
	166
c0c071d0 PD	167	static void replay_save_event(Event *event, int checkpoint)
	168	{
	169	if (replay_mode != REPLAY_MODE_PLAY) {
	170	/* put the event into the file */
	171	replay_put_event(EVENT_ASYNC);
	172	replay_put_byte(checkpoint);
	173	replay_put_byte(event->event_kind);
	174
	175	/* save event-specific data */
	176	switch (event->event_kind) {
8a354bd9	177	case REPLAY_ASYNC_EVENT_BH:
e4ec5ad4	178	case REPLAY_ASYNC_EVENT_BH_ONESHOT:
8a354bd9 PD	179	replay_put_qword(event->id);
8a354bd9 PD	180	break;
ee312992 PD	181	case REPLAY_ASYNC_EVENT_INPUT:
	182	replay_save_input_event(event->opaque);
	183	break;
	184	case REPLAY_ASYNC_EVENT_INPUT_SYNC:
	185	break;
33577b47 PD	186	case REPLAY_ASYNC_EVENT_CHAR_READ:
	187	replay_event_char_read_save(event->opaque);
	188	break;
63785678 PD	189	case REPLAY_ASYNC_EVENT_BLOCK:
	190	replay_put_qword(event->id);
	191	break;
646c5478 PD	192	case REPLAY_ASYNC_EVENT_NET:
	193	replay_event_net_save(event->opaque);
	194	break;
c0c071d0	195	default:
95b4aed5	196	error_report("Unknown ID %" PRId64 " of replay event", event->id);
c0c071d0	197	exit(1);
c0c071d0 PD	198	}
	199	}
	200	}
	201
	202	/* Called with replay mutex locked */
	203	void replay_save_events(int checkpoint)
	204	{
d759c951	205	g_assert(replay_mutex_locked());
89e46eb4	206	g_assert(checkpoint != CHECKPOINT_CLOCK_WARP_START);
ca9759c2	207	g_assert(checkpoint != CHECKPOINT_CLOCK_VIRTUAL);
c0c071d0 PD	208	while (!QTAILQ_EMPTY(&events_list)) {
	209	Event *event = QTAILQ_FIRST(&events_list);
	210	replay_save_event(event, checkpoint);
c0c071d0	211	replay_run_event(event);
c0c071d0 PD	212	QTAILQ_REMOVE(&events_list, event, events);
	213	g_free(event);
	214	}
	215	}
	216
	217	static Event *replay_read_event(int checkpoint)
	218	{
	219	Event *event;
0b30dc01 PD	220	if (replay_state.read_event_kind == -1) {
	221	replay_state.read_event_checkpoint = replay_get_byte();
	222	replay_state.read_event_kind = replay_get_byte();
	223	replay_state.read_event_id = -1;
c0c071d0 PD	224	replay_check_error();
	225	}
	226
0b30dc01	227	if (checkpoint != replay_state.read_event_checkpoint) {
c0c071d0 PD	228	return NULL;
	229	}
	230
	231	/* Events that has not to be in the queue */
0b30dc01	232	switch (replay_state.read_event_kind) {
8a354bd9	233	case REPLAY_ASYNC_EVENT_BH:
e4ec5ad4	234	case REPLAY_ASYNC_EVENT_BH_ONESHOT:
0b30dc01 PD	235	if (replay_state.read_event_id == -1) {
0b30dc01 PD	236	replay_state.read_event_id = replay_get_qword();
8a354bd9 PD	237	}
8a354bd9 PD	238	break;
ee312992 PD	239	case REPLAY_ASYNC_EVENT_INPUT:
ee312992 PD	240	event = g_malloc0(sizeof(Event));
0b30dc01	241	event->event_kind = replay_state.read_event_kind;
ee312992 PD	242	event->opaque = replay_read_input_event();
	243	return event;
	244	case REPLAY_ASYNC_EVENT_INPUT_SYNC:
	245	event = g_malloc0(sizeof(Event));
0b30dc01	246	event->event_kind = replay_state.read_event_kind;
ee312992 PD	247	event->opaque = 0;
ee312992 PD	248	return event;
33577b47 PD	249	case REPLAY_ASYNC_EVENT_CHAR_READ:
33577b47 PD	250	event = g_malloc0(sizeof(Event));
0b30dc01	251	event->event_kind = replay_state.read_event_kind;
33577b47 PD	252	event->opaque = replay_event_char_read_load();
33577b47 PD	253	return event;
63785678	254	case REPLAY_ASYNC_EVENT_BLOCK:
0b30dc01 PD	255	if (replay_state.read_event_id == -1) {
0b30dc01 PD	256	replay_state.read_event_id = replay_get_qword();
63785678 PD	257	}
63785678 PD	258	break;
646c5478 PD	259	case REPLAY_ASYNC_EVENT_NET:
646c5478 PD	260	event = g_malloc0(sizeof(Event));
0b30dc01	261	event->event_kind = replay_state.read_event_kind;
646c5478 PD	262	event->opaque = replay_event_net_load();
646c5478 PD	263	return event;
c0c071d0	264	default:
0b30dc01 PD	265	error_report("Unknown ID %d of replay event",
0b30dc01 PD	266	replay_state.read_event_kind);
c0c071d0 PD	267	exit(1);
	268	break;
	269	}
	270
	271	QTAILQ_FOREACH(event, &events_list, events) {
0b30dc01 PD	272	if (event->event_kind == replay_state.read_event_kind
	273	&& (replay_state.read_event_id == -1
	274	\|\| replay_state.read_event_id == event->id)) {
c0c071d0 PD	275	break;
	276	}
	277	}
	278
	279	if (event) {
	280	QTAILQ_REMOVE(&events_list, event, events);
	281	} else {
	282	return NULL;
	283	}
	284
	285	/* Read event-specific data */
	286
	287	return event;
	288	}
	289
	290	/* Called with replay mutex locked */
	291	void replay_read_events(int checkpoint)
	292	{
d759c951	293	g_assert(replay_mutex_locked());
f186d64d	294	while (replay_state.data_kind == EVENT_ASYNC) {
c0c071d0 PD	295	Event *event = replay_read_event(checkpoint);
	296	if (!event) {
	297	break;
	298	}
1a96e3c1	299	replay_finish_event();
0b30dc01	300	replay_state.read_event_kind = -1;
c0c071d0	301	replay_run_event(event);
c0c071d0 PD	302
c0c071d0 PD	303	g_free(event);
c0c071d0 PD	304	}
	305	}
	306
	307	void replay_init_events(void)
	308	{
0b30dc01	309	replay_state.read_event_kind = -1;
c0c071d0 PD	310	}
	311
	312	void replay_finish_events(void)
	313	{
	314	events_enabled = false;
d873fe03	315	replay_flush_events();
c0c071d0 PD	316	}
	317
	318	bool replay_events_enabled(void)
	319	{
	320	return events_enabled;
	321	}
6d0ceb80 PD	322
	323	uint64_t blkreplay_next_id(void)
	324	{
	325	if (replay_events_enabled()) {
	326	return replay_state.block_request_id++;
	327	}
	328	return 0;
	329	}