[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-common.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_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_step();
        replay_add_event(REPLAY_ASYNC_EVENT_BH, bh, NULL, id);
    } else {
        qemu_bh_schedule(bh);
    }
}

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