[mirror_qemu.git] / tests / test-vmstate.c

/*
 *  Test code for VMState
 *
 *  Copyright (c) 2013 Red Hat Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#include "qemu/osdep.h"

#include "qemu-common.h"
#include "migration/migration.h"
#include "migration/vmstate.h"
#include "qemu/coroutine.h"
#include "io/channel-file.h"

static char temp_file[] = "/tmp/vmst.test.XXXXXX";
static int temp_fd;

/* Fake yield_until_fd_readable() implementation so we don't have to pull the
 * coroutine code as dependency.
 */
void yield_until_fd_readable(int fd)
{
    fd_set fds;
    FD_ZERO(&fds);
    FD_SET(fd, &fds);
    select(fd + 1, &fds, NULL, NULL, NULL);
}


/* Duplicate temp_fd and seek to the beginning of the file */
static QEMUFile *open_test_file(bool write)
{
    int fd = dup(temp_fd);
    QIOChannel *ioc;
    QEMUFile *f;

    lseek(fd, 0, SEEK_SET);
    if (write) {
        g_assert_cmpint(ftruncate(fd, 0), ==, 0);
    }
    ioc = QIO_CHANNEL(qio_channel_file_new_fd(fd));
    if (write) {
        f = qemu_fopen_channel_output(ioc);
    } else {
        f = qemu_fopen_channel_input(ioc);
    }
    object_unref(OBJECT(ioc));
    return f;
}

#define SUCCESS(val) \
    g_assert_cmpint((val), ==, 0)

#define FAILURE(val) \
    g_assert_cmpint((val), !=, 0)

static void save_vmstate(const VMStateDescription *desc, void *obj)
{
    QEMUFile *f = open_test_file(true);

    /* Save file with vmstate */
    vmstate_save_state(f, desc, obj, NULL);
    qemu_put_byte(f, QEMU_VM_EOF);
    g_assert(!qemu_file_get_error(f));
    qemu_fclose(f);
}

static void compare_vmstate(uint8_t *wire, size_t size)
{
    QEMUFile *f = open_test_file(false);
    uint8_t result[size];

    /* read back as binary */

    g_assert_cmpint(qemu_get_buffer(f, result, sizeof(result)), ==,
                    sizeof(result));
    g_assert(!qemu_file_get_error(f));

    /* Compare that what is on the file is the same that what we
       expected to be there */
    SUCCESS(memcmp(result, wire, sizeof(result)));

    /* Must reach EOF */
    qemu_get_byte(f);
    g_assert_cmpint(qemu_file_get_error(f), ==, -EIO);

    qemu_fclose(f);
}

static int load_vmstate_one(const VMStateDescription *desc, void *obj,
                            int version, uint8_t *wire, size_t size)
{
    QEMUFile *f;
    int ret;

    f = open_test_file(true);
    qemu_put_buffer(f, wire, size);
    qemu_fclose(f);

    f = open_test_file(false);
    ret = vmstate_load_state(f, desc, obj, version);
    if (ret) {
        g_assert(qemu_file_get_error(f));
    } else{
        g_assert(!qemu_file_get_error(f));
    }
    qemu_fclose(f);
    return ret;
}


static int load_vmstate(const VMStateDescription *desc,
                        void *obj, void *obj_clone,
                        void (*obj_copy)(void *, void*),
                        int version, uint8_t *wire, size_t size)
{
    /* We test with zero size */
    obj_copy(obj_clone, obj);
    FAILURE(load_vmstate_one(desc, obj, version, wire, 0));

    /* Stream ends with QEMU_EOF, so we need at least 3 bytes to be
     * able to test in the middle */

    if (size > 3) {

        /* We test with size - 2. We can't test size - 1 due to EOF tricks */
        obj_copy(obj, obj_clone);
        FAILURE(load_vmstate_one(desc, obj, version, wire, size - 2));

        /* Test with size/2, first half of real state */
        obj_copy(obj, obj_clone);
        FAILURE(load_vmstate_one(desc, obj, version, wire, size/2));

        /* Test with size/2, second half of real state */
        obj_copy(obj, obj_clone);
        FAILURE(load_vmstate_one(desc, obj, version, wire + (size/2), size/2));

    }
    obj_copy(obj, obj_clone);
    return load_vmstate_one(desc, obj, version, wire, size);
}

/* Test struct that we are going to use for our tests */

typedef struct TestSimple {
    bool     b_1,   b_2;
    uint8_t  u8_1;
    uint16_t u16_1;
    uint32_t u32_1;
    uint64_t u64_1;
    int8_t   i8_1,  i8_2;
    int16_t  i16_1, i16_2;
    int32_t  i32_1, i32_2;
    int64_t  i64_1, i64_2;
} TestSimple;

/* Object instantiation, we are going to use it in more than one test */

TestSimple obj_simple = {
    .b_1 = true,
    .b_2 = false,
    .u8_1 = 130,
    .u16_1 = 512,
    .u32_1 = 70000,
    .u64_1 = 12121212,
    .i8_1 = 65,
    .i8_2 = -65,
    .i16_1 = 512,
    .i16_2 = -512,
    .i32_1 = 70000,
    .i32_2 = -70000,
    .i64_1 = 12121212,
    .i64_2 = -12121212,
};

/* Description of the values.  If you add a primitive type
   you are expected to add a test here */

static const VMStateDescription vmstate_simple_primitive = {
    .name = "simple/primitive",
    .version_id = 1,
    .minimum_version_id = 1,
    .fields = (VMStateField[]) {
        VMSTATE_BOOL(b_1, TestSimple),
        VMSTATE_BOOL(b_2, TestSimple),
        VMSTATE_UINT8(u8_1, TestSimple),
        VMSTATE_UINT16(u16_1, TestSimple),
        VMSTATE_UINT32(u32_1, TestSimple),
        VMSTATE_UINT64(u64_1, TestSimple),
        VMSTATE_INT8(i8_1, TestSimple),
        VMSTATE_INT8(i8_2, TestSimple),
        VMSTATE_INT16(i16_1, TestSimple),
        VMSTATE_INT16(i16_2, TestSimple),
        VMSTATE_INT32(i32_1, TestSimple),
        VMSTATE_INT32(i32_2, TestSimple),
        VMSTATE_INT64(i64_1, TestSimple),
        VMSTATE_INT64(i64_2, TestSimple),
        VMSTATE_END_OF_LIST()
    }
};

/* It describes what goes through the wire.  Our tests are basically:

   * save test
     - save a struct a vmstate to a file
     - read that file back (binary read, no vmstate)
     - compare it with what we expect to be on the wire
   * load test
     - save to the file what we expect to be on the wire
     - read struct back with vmstate in a different
     - compare back with the original struct
*/

uint8_t wire_simple_primitive[] = {
    /* b_1 */   0x01,
    /* b_2 */   0x00,
    /* u8_1 */  0x82,
    /* u16_1 */ 0x02, 0x00,
    /* u32_1 */ 0x00, 0x01, 0x11, 0x70,
    /* u64_1 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0xb8, 0xf4, 0x7c,
    /* i8_1 */  0x41,
    /* i8_2 */  0xbf,
    /* i16_1 */ 0x02, 0x00,
    /* i16_2 */ 0xfe, 0x0,
    /* i32_1 */ 0x00, 0x01, 0x11, 0x70,
    /* i32_2 */ 0xff, 0xfe, 0xee, 0x90,
    /* i64_1 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0xb8, 0xf4, 0x7c,
    /* i64_2 */ 0xff, 0xff, 0xff, 0xff, 0xff, 0x47, 0x0b, 0x84,
    QEMU_VM_EOF, /* just to ensure we won't get EOF reported prematurely */
};

static void obj_simple_copy(void *target, void *source)
{
    memcpy(target, source, sizeof(TestSimple));
}

static void test_simple_primitive(void)
{
    TestSimple obj, obj_clone;

    memset(&obj, 0, sizeof(obj));
    save_vmstate(&vmstate_simple_primitive, &obj_simple);

    compare_vmstate(wire_simple_primitive, sizeof(wire_simple_primitive));

    SUCCESS(load_vmstate(&vmstate_simple_primitive, &obj, &obj_clone,
                         obj_simple_copy, 1, wire_simple_primitive,
                         sizeof(wire_simple_primitive)));

#define FIELD_EQUAL(name)   g_assert_cmpint(obj.name, ==, obj_simple.name)

    FIELD_EQUAL(b_1);
    FIELD_EQUAL(b_2);
    FIELD_EQUAL(u8_1);
    FIELD_EQUAL(u16_1);
    FIELD_EQUAL(u32_1);
    FIELD_EQUAL(u64_1);
    FIELD_EQUAL(i8_1);
    FIELD_EQUAL(i8_2);
    FIELD_EQUAL(i16_1);
    FIELD_EQUAL(i16_2);
    FIELD_EQUAL(i32_1);
    FIELD_EQUAL(i32_2);
    FIELD_EQUAL(i64_1);
    FIELD_EQUAL(i64_2);
}
#undef FIELD_EQUAL

typedef struct TestStruct {
    uint32_t a, b, c, e;
    uint64_t d, f;
    bool skip_c_e;
} TestStruct;

static const VMStateDescription vmstate_versioned = {
    .name = "test/versioned",
    .version_id = 2,
    .minimum_version_id = 1,
    .fields = (VMStateField[]) {
        VMSTATE_UINT32(a, TestStruct),
        VMSTATE_UINT32_V(b, TestStruct, 2), /* Versioned field in the middle, so
                                             * we catch bugs more easily.
                                             */
        VMSTATE_UINT32(c, TestStruct),
        VMSTATE_UINT64(d, TestStruct),
        VMSTATE_UINT32_V(e, TestStruct, 2),
        VMSTATE_UINT64_V(f, TestStruct, 2),
        VMSTATE_END_OF_LIST()
    }
};

static void test_load_v1(void)
{
    QEMUFile *fsave = open_test_file(true);
    uint8_t buf[] = {
        0, 0, 0, 10,             /* a */
        0, 0, 0, 30,             /* c */
        0, 0, 0, 0, 0, 0, 0, 40, /* d */
        QEMU_VM_EOF, /* just to ensure we won't get EOF reported prematurely */
    };
    qemu_put_buffer(fsave, buf, sizeof(buf));
    qemu_fclose(fsave);

    QEMUFile *loading = open_test_file(false);
    TestStruct obj = { .b = 200, .e = 500, .f = 600 };
    vmstate_load_state(loading, &vmstate_versioned, &obj, 1);
    g_assert(!qemu_file_get_error(loading));
    g_assert_cmpint(obj.a, ==, 10);
    g_assert_cmpint(obj.b, ==, 200);
    g_assert_cmpint(obj.c, ==, 30);
    g_assert_cmpint(obj.d, ==, 40);
    g_assert_cmpint(obj.e, ==, 500);
    g_assert_cmpint(obj.f, ==, 600);
    qemu_fclose(loading);
}

static void test_load_v2(void)
{
    QEMUFile *fsave = open_test_file(true);
    uint8_t buf[] = {
        0, 0, 0, 10,             /* a */
        0, 0, 0, 20,             /* b */
        0, 0, 0, 30,             /* c */
        0, 0, 0, 0, 0, 0, 0, 40, /* d */
        0, 0, 0, 50,             /* e */
        0, 0, 0, 0, 0, 0, 0, 60, /* f */
        QEMU_VM_EOF, /* just to ensure we won't get EOF reported prematurely */
    };
    qemu_put_buffer(fsave, buf, sizeof(buf));
    qemu_fclose(fsave);

    QEMUFile *loading = open_test_file(false);
    TestStruct obj;
    vmstate_load_state(loading, &vmstate_versioned, &obj, 2);
    g_assert_cmpint(obj.a, ==, 10);
    g_assert_cmpint(obj.b, ==, 20);
    g_assert_cmpint(obj.c, ==, 30);
    g_assert_cmpint(obj.d, ==, 40);
    g_assert_cmpint(obj.e, ==, 50);
    g_assert_cmpint(obj.f, ==, 60);
    qemu_fclose(loading);
}

static bool test_skip(void *opaque, int version_id)
{
    TestStruct *t = (TestStruct *)opaque;
    return !t->skip_c_e;
}

static const VMStateDescription vmstate_skipping = {
    .name = "test/skip",
    .version_id = 2,
    .minimum_version_id = 1,
    .fields = (VMStateField[]) {
        VMSTATE_UINT32(a, TestStruct),
        VMSTATE_UINT32(b, TestStruct),
        VMSTATE_UINT32_TEST(c, TestStruct, test_skip),
        VMSTATE_UINT64(d, TestStruct),
        VMSTATE_UINT32_TEST(e, TestStruct, test_skip),
        VMSTATE_UINT64_V(f, TestStruct, 2),
        VMSTATE_END_OF_LIST()
    }
};


static void test_save_noskip(void)
{
    QEMUFile *fsave = open_test_file(true);
    TestStruct obj = { .a = 1, .b = 2, .c = 3, .d = 4, .e = 5, .f = 6,
                       .skip_c_e = false };
    vmstate_save_state(fsave, &vmstate_skipping, &obj, NULL);
    g_assert(!qemu_file_get_error(fsave));

    uint8_t expected[] = {
        0, 0, 0, 1,             /* a */
        0, 0, 0, 2,             /* b */
        0, 0, 0, 3,             /* c */
        0, 0, 0, 0, 0, 0, 0, 4, /* d */
        0, 0, 0, 5,             /* e */
        0, 0, 0, 0, 0, 0, 0, 6, /* f */
    };

    qemu_fclose(fsave);
    compare_vmstate(expected, sizeof(expected));
}

static void test_save_skip(void)
{
    QEMUFile *fsave = open_test_file(true);
    TestStruct obj = { .a = 1, .b = 2, .c = 3, .d = 4, .e = 5, .f = 6,
                       .skip_c_e = true };
    vmstate_save_state(fsave, &vmstate_skipping, &obj, NULL);
    g_assert(!qemu_file_get_error(fsave));

    uint8_t expected[] = {
        0, 0, 0, 1,             /* a */
        0, 0, 0, 2,             /* b */
        0, 0, 0, 0, 0, 0, 0, 4, /* d */
        0, 0, 0, 0, 0, 0, 0, 6, /* f */
    };

    qemu_fclose(fsave);
    compare_vmstate(expected, sizeof(expected));
}

static void test_load_noskip(void)
{
    QEMUFile *fsave = open_test_file(true);
    uint8_t buf[] = {
        0, 0, 0, 10,             /* a */
        0, 0, 0, 20,             /* b */
        0, 0, 0, 30,             /* c */
        0, 0, 0, 0, 0, 0, 0, 40, /* d */
        0, 0, 0, 50,             /* e */
        0, 0, 0, 0, 0, 0, 0, 60, /* f */
        QEMU_VM_EOF, /* just to ensure we won't get EOF reported prematurely */
    };
    qemu_put_buffer(fsave, buf, sizeof(buf));
    qemu_fclose(fsave);

    QEMUFile *loading = open_test_file(false);
    TestStruct obj = { .skip_c_e = false };
    vmstate_load_state(loading, &vmstate_skipping, &obj, 2);
    g_assert(!qemu_file_get_error(loading));
    g_assert_cmpint(obj.a, ==, 10);
    g_assert_cmpint(obj.b, ==, 20);
    g_assert_cmpint(obj.c, ==, 30);
    g_assert_cmpint(obj.d, ==, 40);
    g_assert_cmpint(obj.e, ==, 50);
    g_assert_cmpint(obj.f, ==, 60);
    qemu_fclose(loading);
}

static void test_load_skip(void)
{
    QEMUFile *fsave = open_test_file(true);
    uint8_t buf[] = {
        0, 0, 0, 10,             /* a */
        0, 0, 0, 20,             /* b */
        0, 0, 0, 0, 0, 0, 0, 40, /* d */
        0, 0, 0, 0, 0, 0, 0, 60, /* f */
        QEMU_VM_EOF, /* just to ensure we won't get EOF reported prematurely */
    };
    qemu_put_buffer(fsave, buf, sizeof(buf));
    qemu_fclose(fsave);

    QEMUFile *loading = open_test_file(false);
    TestStruct obj = { .skip_c_e = true, .c = 300, .e = 500 };
    vmstate_load_state(loading, &vmstate_skipping, &obj, 2);
    g_assert(!qemu_file_get_error(loading));
    g_assert_cmpint(obj.a, ==, 10);
    g_assert_cmpint(obj.b, ==, 20);
    g_assert_cmpint(obj.c, ==, 300);
    g_assert_cmpint(obj.d, ==, 40);
    g_assert_cmpint(obj.e, ==, 500);
    g_assert_cmpint(obj.f, ==, 60);
    qemu_fclose(loading);
}

int main(int argc, char **argv)
{
    temp_fd = mkstemp(temp_file);

    module_call_init(MODULE_INIT_QOM);

    g_test_init(&argc, &argv, NULL);
    g_test_add_func("/vmstate/simple/primitive", test_simple_primitive);
    g_test_add_func("/vmstate/versioned/load/v1", test_load_v1);
    g_test_add_func("/vmstate/versioned/load/v2", test_load_v2);
    g_test_add_func("/vmstate/field_exists/load/noskip", test_load_noskip);
    g_test_add_func("/vmstate/field_exists/load/skip", test_load_skip);
    g_test_add_func("/vmstate/field_exists/save/noskip", test_save_noskip);
    g_test_add_func("/vmstate/field_exists/save/skip", test_save_skip);
    g_test_run();

    close(temp_fd);
    unlink(temp_file);

    return 0;
}
Commit	Line	Data
2668b4bf EH	1	/*
	2	* Test code for VMState
	3	*
	4	* Copyright (c) 2013 Red Hat Inc.
	5	*
	6	* Permission is hereby granted, free of charge, to any person obtaining a copy
	7	* of this software and associated documentation files (the "Software"), to deal
	8	* in the Software without restriction, including without limitation the rights
	9	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	10	* copies of the Software, and to permit persons to whom the Software is
	11	* furnished to do so, subject to the following conditions:
	12	*
	13	* The above copyright notice and this permission notice shall be included in
	14	* all copies or substantial portions of the Software.
	15	*
	16	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	17	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	18	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	19	* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	20	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	21	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	22	* THE SOFTWARE.
	23	*/
	24
681c28a3	25	#include "qemu/osdep.h"
2668b4bf EH	26
	27	#include "qemu-common.h"
	28	#include "migration/migration.h"
	29	#include "migration/vmstate.h"
10817bf0	30	#include "qemu/coroutine.h"
8925839f	31	#include "io/channel-file.h"
2668b4bf	32
748bfb4e SW	33	static char temp_file[] = "/tmp/vmst.test.XXXXXX";
748bfb4e SW	34	static int temp_fd;
2668b4bf EH	35
	36	/* Fake yield_until_fd_readable() implementation so we don't have to pull the
	37	* coroutine code as dependency.
	38	*/
	39	void yield_until_fd_readable(int fd)
	40	{
	41	fd_set fds;
	42	FD_ZERO(&fds);
	43	FD_SET(fd, &fds);
	44	select(fd + 1, &fds, NULL, NULL, NULL);
	45	}
	46
9935baca	47
2668b4bf	48	/* Duplicate temp_fd and seek to the beginning of the file */
c6f6646c	49	static QEMUFile *open_test_file(bool write)
2668b4bf EH	50	{
2668b4bf EH	51	int fd = dup(temp_fd);
8925839f	52	QIOChannel *ioc;
4ae3c0e2 MAL	53	QEMUFile *f;
4ae3c0e2 MAL	54
2668b4bf	55	lseek(fd, 0, SEEK_SET);
c6f6646c	56	if (write) {
2668b4bf EH	57	g_assert_cmpint(ftruncate(fd, 0), ==, 0);
2668b4bf EH	58	}
8925839f DB	59	ioc = QIO_CHANNEL(qio_channel_file_new_fd(fd));
8925839f DB	60	if (write) {
4ae3c0e2	61	f = qemu_fopen_channel_output(ioc);
8925839f	62	} else {
4ae3c0e2	63	f = qemu_fopen_channel_input(ioc);
8925839f	64	}
4ae3c0e2 MAL	65	object_unref(OBJECT(ioc));
4ae3c0e2 MAL	66	return f;
2668b4bf EH	67	}
2668b4bf EH	68
4ea7df4e JQ	69	#define SUCCESS(val) \
4ea7df4e JQ	70	g_assert_cmpint((val), ==, 0)
2668b4bf	71
4ea7df4e JQ	72	#define FAILURE(val) \
4ea7df4e JQ	73	g_assert_cmpint((val), !=, 0)
2668b4bf	74
4ea7df4e JQ	75	static void save_vmstate(const VMStateDescription desc, void obj)
	76	{
	77	QEMUFile *f = open_test_file(true);
	78
	79	/* Save file with vmstate */
8118f095	80	vmstate_save_state(f, desc, obj, NULL);
4ea7df4e JQ	81	qemu_put_byte(f, QEMU_VM_EOF);
	82	g_assert(!qemu_file_get_error(f));
	83	qemu_fclose(f);
	84	}
2668b4bf	85
4ea7df4e	86	static void compare_vmstate(uint8_t *wire, size_t size)
2668b4bf	87	{
4ea7df4e JQ	88	QEMUFile *f = open_test_file(false);
4ea7df4e JQ	89	uint8_t result[size];
2668b4bf	90
4ea7df4e JQ	91	/* read back as binary */
	92
	93	g_assert_cmpint(qemu_get_buffer(f, result, sizeof(result)), ==,
2668b4bf	94	sizeof(result));
4ea7df4e JQ	95	g_assert(!qemu_file_get_error(f));
	96
	97	/* Compare that what is on the file is the same that what we
	98	expected to be there */
	99	SUCCESS(memcmp(result, wire, sizeof(result)));
2668b4bf EH	100
2668b4bf EH	101	/* Must reach EOF */
4ea7df4e JQ	102	qemu_get_byte(f);
4ea7df4e JQ	103	g_assert_cmpint(qemu_file_get_error(f), ==, -EIO);
2668b4bf	104
4ea7df4e	105	qemu_fclose(f);
2668b4bf EH	106	}
2668b4bf EH	107
4ea7df4e JQ	108	static int load_vmstate_one(const VMStateDescription desc, void obj,
4ea7df4e JQ	109	int version, uint8_t *wire, size_t size)
2668b4bf	110	{
4ea7df4e JQ	111	QEMUFile *f;
	112	int ret;
	113
	114	f = open_test_file(true);
	115	qemu_put_buffer(f, wire, size);
	116	qemu_fclose(f);
	117
	118	f = open_test_file(false);
	119	ret = vmstate_load_state(f, desc, obj, version);
	120	if (ret) {
	121	g_assert(qemu_file_get_error(f));
	122	} else{
	123	g_assert(!qemu_file_get_error(f));
	124	}
	125	qemu_fclose(f);
	126	return ret;
	127	}
2668b4bf	128
4ea7df4e JQ	129
	130	static int load_vmstate(const VMStateDescription *desc,
	131	void obj, void obj_clone,
	132	void (obj_copy)(void , void*),
	133	int version, uint8_t *wire, size_t size)
	134	{
	135	/* We test with zero size */
	136	obj_copy(obj_clone, obj);
	137	FAILURE(load_vmstate_one(desc, obj, version, wire, 0));
	138
	139	/* Stream ends with QEMU_EOF, so we need at least 3 bytes to be
	140	* able to test in the middle */
	141
	142	if (size > 3) {
	143
	144	/* We test with size - 2. We can't test size - 1 due to EOF tricks */
	145	obj_copy(obj, obj_clone);
	146	FAILURE(load_vmstate_one(desc, obj, version, wire, size - 2));
	147
	148	/* Test with size/2, first half of real state */
	149	obj_copy(obj, obj_clone);
	150	FAILURE(load_vmstate_one(desc, obj, version, wire, size/2));
	151
	152	/* Test with size/2, second half of real state */
	153	obj_copy(obj, obj_clone);
	154	FAILURE(load_vmstate_one(desc, obj, version, wire + (size/2), size/2));
	155
	156	}
	157	obj_copy(obj, obj_clone);
	158	return load_vmstate_one(desc, obj, version, wire, size);
	159	}
	160
	161	/* Test struct that we are going to use for our tests */
	162
	163	typedef struct TestSimple {
	164	bool b_1, b_2;
	165	uint8_t u8_1;
	166	uint16_t u16_1;
	167	uint32_t u32_1;
	168	uint64_t u64_1;
	169	int8_t i8_1, i8_2;
	170	int16_t i16_1, i16_2;
	171	int32_t i32_1, i32_2;
	172	int64_t i64_1, i64_2;
	173	} TestSimple;
	174
	175	/* Object instantiation, we are going to use it in more than one test */
	176
	177	TestSimple obj_simple = {
	178	.b_1 = true,
	179	.b_2 = false,
	180	.u8_1 = 130,
	181	.u16_1 = 512,
	182	.u32_1 = 70000,
	183	.u64_1 = 12121212,
	184	.i8_1 = 65,
	185	.i8_2 = -65,
	186	.i16_1 = 512,
	187	.i16_2 = -512,
	188	.i32_1 = 70000,
	189	.i32_2 = -70000,
	190	.i64_1 = 12121212,
	191	.i64_2 = -12121212,
	192	};
193
194	/* Description of the values. If you add a primitive type
195	you are expected to add a test here */
196
197	static const VMStateDescription vmstate_simple_primitive = {
198	.name = "simple/primitive",
199	.version_id = 1,
200	.minimum_version_id = 1,
201	.fields = (VMStateField[]) {
202	VMSTATE_BOOL(b_1, TestSimple),
203	VMSTATE_BOOL(b_2, TestSimple),
204	VMSTATE_UINT8(u8_1, TestSimple),
205	VMSTATE_UINT16(u16_1, TestSimple),
206	VMSTATE_UINT32(u32_1, TestSimple),
207	VMSTATE_UINT64(u64_1, TestSimple),
208	VMSTATE_INT8(i8_1, TestSimple),
209	VMSTATE_INT8(i8_2, TestSimple),
210	VMSTATE_INT16(i16_1, TestSimple),
211	VMSTATE_INT16(i16_2, TestSimple),
212	VMSTATE_INT32(i32_1, TestSimple),
213	VMSTATE_INT32(i32_2, TestSimple),
214	VMSTATE_INT64(i64_1, TestSimple),
215	VMSTATE_INT64(i64_2, TestSimple),
216	VMSTATE_END_OF_LIST()
217	}
218	};
219
220	/* It describes what goes through the wire. Our tests are basically:
221
222	* save test
223	- save a struct a vmstate to a file
224	- read that file back (binary read, no vmstate)
225	- compare it with what we expect to be on the wire
226	* load test
227	- save to the file what we expect to be on the wire
228	- read struct back with vmstate in a different
229	- compare back with the original struct
230	*/
231
232	uint8_t wire_simple_primitive[] = {
233	/* b_1 */ 0x01,
234	/* b_2 */ 0x00,
235	/* u8_1 */ 0x82,
236	/* u16_1 */ 0x02, 0x00,
237	/* u32_1 */ 0x00, 0x01, 0x11, 0x70,
238	/* u64_1 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0xb8, 0xf4, 0x7c,
239	/* i8_1 */ 0x41,
240	/* i8_2 */ 0xbf,
241	/* i16_1 */ 0x02, 0x00,
242	/* i16_2 */ 0xfe, 0x0,
243	/* i32_1 */ 0x00, 0x01, 0x11, 0x70,
244	/* i32_2 */ 0xff, 0xfe, 0xee, 0x90,
245	/* i64_1 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0xb8, 0xf4, 0x7c,
246	/* i64_2 */ 0xff, 0xff, 0xff, 0xff, 0xff, 0x47, 0x0b, 0x84,
247	QEMU_VM_EOF, /* just to ensure we won't get EOF reported prematurely */
248	};
249
250	static void obj_simple_copy(void target, void source)
251	{
252	memcpy(target, source, sizeof(TestSimple));
253	}
254
255	static void test_simple_primitive(void)
256	{
257	TestSimple obj, obj_clone;
258
259	memset(&obj, 0, sizeof(obj));
260	save_vmstate(&vmstate_simple_primitive, &obj_simple);
261
262	compare_vmstate(wire_simple_primitive, sizeof(wire_simple_primitive));
263
264	SUCCESS(load_vmstate(&vmstate_simple_primitive, &obj, &obj_clone,
265	obj_simple_copy, 1, wire_simple_primitive,
266	sizeof(wire_simple_primitive)));
267
268	#define FIELD_EQUAL(name) g_assert_cmpint(obj.name, ==, obj_simple.name)
269
270	FIELD_EQUAL(b_1);
271	FIELD_EQUAL(b_2);
272	FIELD_EQUAL(u8_1);
273	FIELD_EQUAL(u16_1);
274	FIELD_EQUAL(u32_1);
275	FIELD_EQUAL(u64_1);
276	FIELD_EQUAL(i8_1);
277	FIELD_EQUAL(i8_2);
278	FIELD_EQUAL(i16_1);
279	FIELD_EQUAL(i16_2);
280	FIELD_EQUAL(i32_1);
281	FIELD_EQUAL(i32_2);
282	FIELD_EQUAL(i64_1);
283	FIELD_EQUAL(i64_2);
2668b4bf	284	}
4ea7df4e JQ	285	#undef FIELD_EQUAL
	286
	287	typedef struct TestStruct {
	288	uint32_t a, b, c, e;
	289	uint64_t d, f;
	290	bool skip_c_e;
	291	} TestStruct;
2668b4bf EH	292
2668b4bf EH	293	static const VMStateDescription vmstate_versioned = {
4ea7df4e	294	.name = "test/versioned",
2668b4bf EH	295	.version_id = 2,
2668b4bf EH	296	.minimum_version_id = 1,
35d08458	297	.fields = (VMStateField[]) {
2668b4bf EH	298	VMSTATE_UINT32(a, TestStruct),
	299	VMSTATE_UINT32_V(b, TestStruct, 2), /* Versioned field in the middle, so
	300	* we catch bugs more easily.
	301	*/
	302	VMSTATE_UINT32(c, TestStruct),
	303	VMSTATE_UINT64(d, TestStruct),
	304	VMSTATE_UINT32_V(e, TestStruct, 2),
	305	VMSTATE_UINT64_V(f, TestStruct, 2),
	306	VMSTATE_END_OF_LIST()
	307	}
	308	};
	309
	310	static void test_load_v1(void)
	311	{
c6f6646c	312	QEMUFile *fsave = open_test_file(true);
2668b4bf EH	313	uint8_t buf[] = {
	314	0, 0, 0, 10, /* a */
	315	0, 0, 0, 30, /* c */
	316	0, 0, 0, 0, 0, 0, 0, 40, /* d */
	317	QEMU_VM_EOF, /* just to ensure we won't get EOF reported prematurely */
	318	};
	319	qemu_put_buffer(fsave, buf, sizeof(buf));
	320	qemu_fclose(fsave);
	321
c6f6646c	322	QEMUFile *loading = open_test_file(false);
2668b4bf EH	323	TestStruct obj = { .b = 200, .e = 500, .f = 600 };
	324	vmstate_load_state(loading, &vmstate_versioned, &obj, 1);
	325	g_assert(!qemu_file_get_error(loading));
	326	g_assert_cmpint(obj.a, ==, 10);
	327	g_assert_cmpint(obj.b, ==, 200);
	328	g_assert_cmpint(obj.c, ==, 30);
	329	g_assert_cmpint(obj.d, ==, 40);
	330	g_assert_cmpint(obj.e, ==, 500);
	331	g_assert_cmpint(obj.f, ==, 600);
	332	qemu_fclose(loading);
	333	}
	334
	335	static void test_load_v2(void)
	336	{
c6f6646c	337	QEMUFile *fsave = open_test_file(true);
2668b4bf EH	338	uint8_t buf[] = {
	339	0, 0, 0, 10, /* a */
	340	0, 0, 0, 20, /* b */
	341	0, 0, 0, 30, /* c */
	342	0, 0, 0, 0, 0, 0, 0, 40, /* d */
	343	0, 0, 0, 50, /* e */
	344	0, 0, 0, 0, 0, 0, 0, 60, /* f */
	345	QEMU_VM_EOF, /* just to ensure we won't get EOF reported prematurely */
	346	};
	347	qemu_put_buffer(fsave, buf, sizeof(buf));
	348	qemu_fclose(fsave);
	349
c6f6646c	350	QEMUFile *loading = open_test_file(false);
2668b4bf EH	351	TestStruct obj;
	352	vmstate_load_state(loading, &vmstate_versioned, &obj, 2);
	353	g_assert_cmpint(obj.a, ==, 10);
	354	g_assert_cmpint(obj.b, ==, 20);
	355	g_assert_cmpint(obj.c, ==, 30);
	356	g_assert_cmpint(obj.d, ==, 40);
	357	g_assert_cmpint(obj.e, ==, 50);
	358	g_assert_cmpint(obj.f, ==, 60);
	359	qemu_fclose(loading);
	360	}
	361
	362	static bool test_skip(void *opaque, int version_id)
	363	{
	364	TestStruct t = (TestStruct )opaque;
	365	return !t->skip_c_e;
	366	}
	367
	368	static const VMStateDescription vmstate_skipping = {
4ea7df4e	369	.name = "test/skip",
2668b4bf EH	370	.version_id = 2,
2668b4bf EH	371	.minimum_version_id = 1,
35d08458	372	.fields = (VMStateField[]) {
2668b4bf EH	373	VMSTATE_UINT32(a, TestStruct),
	374	VMSTATE_UINT32(b, TestStruct),
	375	VMSTATE_UINT32_TEST(c, TestStruct, test_skip),
	376	VMSTATE_UINT64(d, TestStruct),
	377	VMSTATE_UINT32_TEST(e, TestStruct, test_skip),
	378	VMSTATE_UINT64_V(f, TestStruct, 2),
	379	VMSTATE_END_OF_LIST()
	380	}
	381	};
	382
	383
	384	static void test_save_noskip(void)
	385	{
a8ec4437	386	QEMUFile *fsave = open_test_file(true);
2668b4bf EH	387	TestStruct obj = { .a = 1, .b = 2, .c = 3, .d = 4, .e = 5, .f = 6,
2668b4bf EH	388	.skip_c_e = false };
8118f095	389	vmstate_save_state(fsave, &vmstate_skipping, &obj, NULL);
2668b4bf	390	g_assert(!qemu_file_get_error(fsave));
2668b4bf	391
2668b4bf EH	392	uint8_t expected[] = {
	393	0, 0, 0, 1, /* a */
	394	0, 0, 0, 2, /* b */
	395	0, 0, 0, 3, /* c */
	396	0, 0, 0, 0, 0, 0, 0, 4, /* d */
	397	0, 0, 0, 5, /* e */
	398	0, 0, 0, 0, 0, 0, 0, 6, /* f */
	399	};
a8ec4437	400
9935baca	401	qemu_fclose(fsave);
a8ec4437	402	compare_vmstate(expected, sizeof(expected));
2668b4bf EH	403	}
	404
	405	static void test_save_skip(void)
	406	{
a8ec4437	407	QEMUFile *fsave = open_test_file(true);
2668b4bf EH	408	TestStruct obj = { .a = 1, .b = 2, .c = 3, .d = 4, .e = 5, .f = 6,
2668b4bf EH	409	.skip_c_e = true };
8118f095	410	vmstate_save_state(fsave, &vmstate_skipping, &obj, NULL);
2668b4bf	411	g_assert(!qemu_file_get_error(fsave));
2668b4bf	412
2668b4bf EH	413	uint8_t expected[] = {
	414	0, 0, 0, 1, /* a */
	415	0, 0, 0, 2, /* b */
	416	0, 0, 0, 0, 0, 0, 0, 4, /* d */
	417	0, 0, 0, 0, 0, 0, 0, 6, /* f */
	418	};
2668b4bf	419
9935baca	420	qemu_fclose(fsave);
a8ec4437	421	compare_vmstate(expected, sizeof(expected));
2668b4bf EH	422	}
	423
	424	static void test_load_noskip(void)
	425	{
a8ec4437	426	QEMUFile *fsave = open_test_file(true);
2668b4bf EH	427	uint8_t buf[] = {
	428	0, 0, 0, 10, /* a */
	429	0, 0, 0, 20, /* b */
	430	0, 0, 0, 30, /* c */
	431	0, 0, 0, 0, 0, 0, 0, 40, /* d */
	432	0, 0, 0, 50, /* e */
	433	0, 0, 0, 0, 0, 0, 0, 60, /* f */
	434	QEMU_VM_EOF, /* just to ensure we won't get EOF reported prematurely */
	435	};
a8ec4437 DB	436	qemu_put_buffer(fsave, buf, sizeof(buf));
a8ec4437 DB	437	qemu_fclose(fsave);
2668b4bf	438
a8ec4437	439	QEMUFile *loading = open_test_file(false);
2668b4bf EH	440	TestStruct obj = { .skip_c_e = false };
	441	vmstate_load_state(loading, &vmstate_skipping, &obj, 2);
	442	g_assert(!qemu_file_get_error(loading));
	443	g_assert_cmpint(obj.a, ==, 10);
	444	g_assert_cmpint(obj.b, ==, 20);
	445	g_assert_cmpint(obj.c, ==, 30);
	446	g_assert_cmpint(obj.d, ==, 40);
	447	g_assert_cmpint(obj.e, ==, 50);
	448	g_assert_cmpint(obj.f, ==, 60);
	449	qemu_fclose(loading);
	450	}
	451
	452	static void test_load_skip(void)
	453	{
a8ec4437	454	QEMUFile *fsave = open_test_file(true);
2668b4bf EH	455	uint8_t buf[] = {
	456	0, 0, 0, 10, /* a */
	457	0, 0, 0, 20, /* b */
	458	0, 0, 0, 0, 0, 0, 0, 40, /* d */
	459	0, 0, 0, 0, 0, 0, 0, 60, /* f */
	460	QEMU_VM_EOF, /* just to ensure we won't get EOF reported prematurely */
	461	};
a8ec4437 DB	462	qemu_put_buffer(fsave, buf, sizeof(buf));
a8ec4437 DB	463	qemu_fclose(fsave);
2668b4bf	464
a8ec4437	465	QEMUFile *loading = open_test_file(false);
2668b4bf EH	466	TestStruct obj = { .skip_c_e = true, .c = 300, .e = 500 };
	467	vmstate_load_state(loading, &vmstate_skipping, &obj, 2);
	468	g_assert(!qemu_file_get_error(loading));
	469	g_assert_cmpint(obj.a, ==, 10);
	470	g_assert_cmpint(obj.b, ==, 20);
	471	g_assert_cmpint(obj.c, ==, 300);
	472	g_assert_cmpint(obj.d, ==, 40);
	473	g_assert_cmpint(obj.e, ==, 500);
	474	g_assert_cmpint(obj.f, ==, 60);
	475	qemu_fclose(loading);
	476	}
	477
	478	int main(int argc, char **argv)
	479	{
	480	temp_fd = mkstemp(temp_file);
	481
8925839f DB	482	module_call_init(MODULE_INIT_QOM);
8925839f DB	483
2668b4bf	484	g_test_init(&argc, &argv, NULL);
4ea7df4e	485	g_test_add_func("/vmstate/simple/primitive", test_simple_primitive);
2668b4bf EH	486	g_test_add_func("/vmstate/versioned/load/v1", test_load_v1);
	487	g_test_add_func("/vmstate/versioned/load/v2", test_load_v2);
	488	g_test_add_func("/vmstate/field_exists/load/noskip", test_load_noskip);
	489	g_test_add_func("/vmstate/field_exists/load/skip", test_load_skip);
	490	g_test_add_func("/vmstate/field_exists/save/noskip", test_save_noskip);
	491	g_test_add_func("/vmstate/field_exists/save/skip", test_save_skip);
	492	g_test_run();
	493
	494	close(temp_fd);
	495	unlink(temp_file);
	496
	497	return 0;
	498	}