[qemu.git] / tests / boot-serial-test.c

/*
 * Test serial output of some machines.
 *
 * Copyright 2016 Thomas Huth, Red Hat Inc.
 *
 * This work is licensed under the terms of the GNU GPL, version 2
 * or later. See the COPYING file in the top-level directory.
 *
 * This test is used to check that the serial output of the firmware
 * (that we provide for some machines) or some small mini-kernels that
 * we provide here contains an expected string. Thus we check that the
 * firmware/kernel still boots at least to a certain point and so we
 * know that the machine is not completely broken.
 */

#include "qemu/osdep.h"
#include "libqtest.h"

static const uint8_t kernel_mcf5208[] = {
    0x41, 0xf9, 0xfc, 0x06, 0x00, 0x00,     /* lea 0xfc060000,%a0 */
    0x10, 0x3c, 0x00, 0x54,                 /* move.b #'T',%d0 */
    0x11, 0x7c, 0x00, 0x04, 0x00, 0x08,     /* move.b #4,8(%a0)     Enable TX */
    0x11, 0x40, 0x00, 0x0c,                 /* move.b %d0,12(%a0)   Print 'T' */
    0x60, 0xfa                              /* bra.s  loop */
};

static const uint8_t kernel_pls3adsp1800[] = {
    0xb0, 0x00, 0x84, 0x00,                 /* imm   0x8400 */
    0x30, 0x60, 0x00, 0x04,                 /* addik r3,r0,4 */
    0x30, 0x80, 0x00, 0x54,                 /* addik r4,r0,'T' */
    0xf0, 0x83, 0x00, 0x00,                 /* sbi   r4,r3,0 */
    0xb8, 0x00, 0xff, 0xfc                  /* bri   -4  loop */
};

static const uint8_t kernel_plml605[] = {
    0xe0, 0x83, 0x00, 0xb0,                 /* imm   0x83e0 */
    0x00, 0x10, 0x60, 0x30,                 /* addik r3,r0,0x1000 */
    0x54, 0x00, 0x80, 0x30,                 /* addik r4,r0,'T' */
    0x00, 0x00, 0x83, 0xf0,                 /* sbi   r4,r3,0 */
    0xfc, 0xff, 0x00, 0xb8                  /* bri   -4  loop */
};

static const uint8_t bios_moxiesim[] = {
    0x20, 0x10, 0x00, 0x00, 0x03, 0xf8,     /* ldi.s r1,0x3f8 */
    0x1b, 0x20, 0x00, 0x00, 0x00, 0x54,     /* ldi.b r2,'T' */
    0x1e, 0x12,                             /* st.b  r1,r2 */
    0x1a, 0x00, 0x00, 0x00, 0x10, 0x00      /* jmpa  0x1000 */
};

static const uint8_t bios_raspi2[] = {
    0x08, 0x30, 0x9f, 0xe5,                 /* ldr   r3,[pc,#8]    Get base */
    0x54, 0x20, 0xa0, 0xe3,                 /* mov     r2,#'T' */
    0x00, 0x20, 0xc3, 0xe5,                 /* strb    r2,[r3] */
    0xfb, 0xff, 0xff, 0xea,                 /* b       loop */
    0x00, 0x10, 0x20, 0x3f,                 /* 0x3f201000 = UART0 base addr */
};

static const uint8_t kernel_aarch64[] = {
    0x81, 0x0a, 0x80, 0x52,                 /* mov     w1, #0x54 */
    0x02, 0x20, 0xa1, 0xd2,                 /* mov     x2, #0x9000000 */
    0x41, 0x00, 0x00, 0x39,                 /* strb    w1, [x2] */
    0xfd, 0xff, 0xff, 0x17,                 /* b       -12 (loop) */
};

static const uint8_t kernel_nrf51[] = {
    0x00, 0x00, 0x00, 0x00,                 /* Stack top address */
    0x09, 0x00, 0x00, 0x00,                 /* Reset handler address */
    0x04, 0x4a,                             /* ldr  r2, [pc, #16] Get ENABLE */
    0x04, 0x21,                             /* movs r1, #4 */
    0x11, 0x60,                             /* str  r1, [r2] */
    0x04, 0x4a,                             /* ldr  r2, [pc, #16] Get STARTTX */
    0x01, 0x21,                             /* movs r1, #1 */
    0x11, 0x60,                             /* str  r1, [r2] */
    0x03, 0x4a,                             /* ldr  r2, [pc, #12] Get TXD */
    0x54, 0x21,                             /* movs r1, 'T' */
    0x11, 0x60,                             /* str  r1, [r2] */
    0xfe, 0xe7,                             /* b    . */
    0x00, 0x25, 0x00, 0x40,                 /* 0x40002500 = UART ENABLE */
    0x08, 0x20, 0x00, 0x40,                 /* 0x40002008 = UART STARTTX */
    0x1c, 0x25, 0x00, 0x40                  /* 0x4000251c = UART TXD */
};

typedef struct testdef {
    const char *arch;       /* Target architecture */
    const char *machine;    /* Name of the machine */
    const char *extra;      /* Additional parameters */
    const char *expect;     /* Expected string in the serial output */
    size_t codesize;        /* Size of the kernel or bios data */
    const uint8_t *kernel;  /* Set in case we use our own mini kernel */
    const uint8_t *bios;    /* Set in case we use our own mini bios */
} testdef_t;

static testdef_t tests[] = {
    { "alpha", "clipper", "", "PCI:" },
    { "ppc", "ppce500", "", "U-Boot" },
    { "ppc", "40p", "-vga none -boot d", "Trying cd:," },
    { "ppc", "g3beige", "", "PowerPC,750" },
    { "ppc", "mac99", "", "PowerPC,G4" },
    { "ppc", "sam460ex", "-m 256", "DRAM:  256 MiB" },
    { "ppc64", "ppce500", "", "U-Boot" },
    { "ppc64", "40p", "-m 192", "Memory: 192M" },
    { "ppc64", "mac99", "", "PowerPC,970FX" },
    { "ppc64", "pseries", "", "Open Firmware" },
    { "ppc64", "powernv", "-cpu POWER8", "OPAL" },
    { "ppc64", "sam460ex", "-device e1000", "8086  100e" },
    { "i386", "isapc", "-cpu qemu32 -device sga", "SGABIOS" },
    { "i386", "pc", "-device sga", "SGABIOS" },
    { "i386", "q35", "-device sga", "SGABIOS" },
    { "x86_64", "isapc", "-cpu qemu32 -device sga", "SGABIOS" },
    { "x86_64", "q35", "-device sga", "SGABIOS" },
    { "sparc", "LX", "", "TMS390S10" },
    { "sparc", "SS-4", "", "MB86904" },
    { "sparc", "SS-600MP", "", "TMS390Z55" },
    { "sparc64", "sun4u", "", "UltraSPARC" },
    { "s390x", "s390-ccw-virtio", "", "virtio device" },
    { "m68k", "mcf5208evb", "", "TT", sizeof(kernel_mcf5208), kernel_mcf5208 },
    { "microblaze", "petalogix-s3adsp1800", "", "TT",
      sizeof(kernel_pls3adsp1800), kernel_pls3adsp1800 },
    { "microblazeel", "petalogix-ml605", "", "TT",
      sizeof(kernel_plml605), kernel_plml605 },
    { "moxie", "moxiesim", "", "TT", sizeof(bios_moxiesim), 0, bios_moxiesim },
    { "arm", "raspi2", "", "TT", sizeof(bios_raspi2), 0, bios_raspi2 },
    { "hppa", "hppa", "", "SeaBIOS wants SYSTEM HALT" },
    { "aarch64", "virt", "-cpu cortex-a57", "TT", sizeof(kernel_aarch64),
      kernel_aarch64 },
    { "arm", "microbit", "", "T", sizeof(kernel_nrf51), kernel_nrf51 },

    { NULL }
};

static bool check_guest_output(QTestState *qts, const testdef_t *test, int fd)
{
    int nbr = 0, pos = 0, ccnt;
    time_t now, start = time(NULL);
    char ch;

    /* Poll serial output... */
    while (1) {
        ccnt = 0;
        while (ccnt++ < 512 && (nbr = read(fd, &ch, 1)) == 1) {
            if (ch == test->expect[pos]) {
                pos += 1;
                if (test->expect[pos] == '\0') {
                    /* We've reached the end of the expected string! */
                    return true;
                }
            } else {
                pos = 0;
            }
        }
        g_assert(nbr >= 0);
        /* Wait only if the child is still alive.  */
        if (!qtest_probe_child(qts)) {
            break;
        }
        /* Wait at most 360 seconds.  */
        now = time(NULL);
        if (now - start >= 360) {
            break;
        }
        g_usleep(10000);
    }

    return false;
}

static void test_machine(const void *data)
{
    const testdef_t *test = data;
    char serialtmp[] = "/tmp/qtest-boot-serial-sXXXXXX";
    char codetmp[] = "/tmp/qtest-boot-serial-cXXXXXX";
    const char *codeparam = "";
    const uint8_t *code = NULL;
    QTestState *qts;
    int ser_fd;

    ser_fd = mkstemp(serialtmp);
    g_assert(ser_fd != -1);

    if (test->kernel) {
        code = test->kernel;
        codeparam = "-kernel";
    } else if (test->bios) {
        code = test->bios;
        codeparam = "-bios";
    }

    if (code) {
        ssize_t wlen;
        int code_fd;

        code_fd = mkstemp(codetmp);
        g_assert(code_fd != -1);
        wlen = write(code_fd, code, test->codesize);
        g_assert(wlen == test->codesize);
        close(code_fd);
    }

    /*
     * Make sure that this test uses tcg if available: It is used as a
     * fast-enough smoketest for that.
     */
    qts = qtest_initf("%s %s -M %s,accel=tcg:kvm -no-shutdown "
                      "-chardev file,id=serial0,path=%s "
                      "-serial chardev:serial0 %s",
                      codeparam, code ? codetmp : "", test->machine,
                      serialtmp, test->extra);
    if (code) {
        unlink(codetmp);
    }

    if (!check_guest_output(qts, test, ser_fd)) {
        g_error("Failed to find expected string. Please check '%s'",
                serialtmp);
    }
    unlink(serialtmp);

    qtest_quit(qts);

    close(ser_fd);
}

int main(int argc, char *argv[])
{
    const char *arch = qtest_get_arch();
    int i;

    g_test_init(&argc, &argv, NULL);

    for (i = 0; tests[i].arch != NULL; i++) {
        if (strcmp(arch, tests[i].arch) == 0) {
            char *name = g_strdup_printf("boot-serial/%s", tests[i].machine);
            qtest_add_data_func(name, &tests[i], test_machine);
            g_free(name);
        }
    }

    return g_test_run();
}
Commit	Line	Data
d2ab58ff TH	1	/*
	2	* Test serial output of some machines.
	3	*
	4	* Copyright 2016 Thomas Huth, Red Hat Inc.
	5	*
	6	* This work is licensed under the terms of the GNU GPL, version 2
	7	* or later. See the COPYING file in the top-level directory.
	8	*
	9	* This test is used to check that the serial output of the firmware
e12c08d3 TH	10	* (that we provide for some machines) or some small mini-kernels that
	11	* we provide here contains an expected string. Thus we check that the
	12	* firmware/kernel still boots at least to a certain point and so we
	13	* know that the machine is not completely broken.
d2ab58ff TH	14	*/
	15
	16	#include "qemu/osdep.h"
	17	#include "libqtest.h"
	18
598a29f3 TH	19	static const uint8_t kernel_mcf5208[] = {
	20	0x41, 0xf9, 0xfc, 0x06, 0x00, 0x00, /* lea 0xfc060000,%a0 */
	21	0x10, 0x3c, 0x00, 0x54, /* move.b #'T',%d0 */
	22	0x11, 0x7c, 0x00, 0x04, 0x00, 0x08, /* move.b #4,8(%a0) Enable TX */
	23	0x11, 0x40, 0x00, 0x0c, /* move.b %d0,12(%a0) Print 'T' */
	24	0x60, 0xfa /* bra.s loop */
	25	};
	26
acf53766 TH	27	static const uint8_t kernel_pls3adsp1800[] = {
	28	0xb0, 0x00, 0x84, 0x00, /* imm 0x8400 */
	29	0x30, 0x60, 0x00, 0x04, /* addik r3,r0,4 */
	30	0x30, 0x80, 0x00, 0x54, /* addik r4,r0,'T' */
	31	0xf0, 0x83, 0x00, 0x00, /* sbi r4,r3,0 */
	32	0xb8, 0x00, 0xff, 0xfc /* bri -4 loop */
	33	};
	34
	35	static const uint8_t kernel_plml605[] = {
	36	0xe0, 0x83, 0x00, 0xb0, /* imm 0x83e0 */
	37	0x00, 0x10, 0x60, 0x30, /* addik r3,r0,0x1000 */
	38	0x54, 0x00, 0x80, 0x30, /* addik r4,r0,'T' */
	39	0x00, 0x00, 0x83, 0xf0, /* sbi r4,r3,0 */
	40	0xfc, 0xff, 0x00, 0xb8 /* bri -4 loop */
	41	};
	42
7244edf2 TH	43	static const uint8_t bios_moxiesim[] = {
	44	0x20, 0x10, 0x00, 0x00, 0x03, 0xf8, /* ldi.s r1,0x3f8 */
	45	0x1b, 0x20, 0x00, 0x00, 0x00, 0x54, /* ldi.b r2,'T' */
	46	0x1e, 0x12, /* st.b r1,r2 */
	47	0x1a, 0x00, 0x00, 0x00, 0x10, 0x00 /* jmpa 0x1000 */
	48	};
	49
52cb6817 TH	50	static const uint8_t bios_raspi2[] = {
	51	0x08, 0x30, 0x9f, 0xe5, /* ldr r3,[pc,#8] Get base */
	52	0x54, 0x20, 0xa0, 0xe3, /* mov r2,#'T' */
	53	0x00, 0x20, 0xc3, 0xe5, /* strb r2,[r3] */
	54	0xfb, 0xff, 0xff, 0xea, /* b loop */
	55	0x00, 0x10, 0x20, 0x3f, /* 0x3f201000 = UART0 base addr */
	56	};
	57
ec2e988f WH	58	static const uint8_t kernel_aarch64[] = {
	59	0x81, 0x0a, 0x80, 0x52, /* mov w1, #0x54 */
	60	0x02, 0x20, 0xa1, 0xd2, /* mov x2, #0x9000000 */
	61	0x41, 0x00, 0x00, 0x39, /* strb w1, [x2] */
	62	0xfd, 0xff, 0xff, 0x17, /* b -12 (loop) */
	63	};
	64
a2c9a356 JS	65	static const uint8_t kernel_nrf51[] = {
	66	0x00, 0x00, 0x00, 0x00, /* Stack top address */
	67	0x09, 0x00, 0x00, 0x00, /* Reset handler address */
	68	0x04, 0x4a, /* ldr r2, [pc, #16] Get ENABLE */
	69	0x04, 0x21, /* movs r1, #4 */
	70	0x11, 0x60, /* str r1, [r2] */
	71	0x04, 0x4a, /* ldr r2, [pc, #16] Get STARTTX */
	72	0x01, 0x21, /* movs r1, #1 */
	73	0x11, 0x60, /* str r1, [r2] */
	74	0x03, 0x4a, /* ldr r2, [pc, #12] Get TXD */
	75	0x54, 0x21, /* movs r1, 'T' */
	76	0x11, 0x60, /* str r1, [r2] */
	77	0xfe, 0xe7, /* b . */
	78	0x00, 0x25, 0x00, 0x40, /* 0x40002500 = UART ENABLE */
	79	0x08, 0x20, 0x00, 0x40, /* 0x40002008 = UART STARTTX */
	80	0x1c, 0x25, 0x00, 0x40 /* 0x4000251c = UART TXD */
	81	};
	82
d2ab58ff TH	83	typedef struct testdef {
	84	const char arch; / Target architecture */
	85	const char machine; / Name of the machine */
	86	const char extra; / Additional parameters */
	87	const char expect; / Expected string in the serial output */
e12c08d3 TH	88	size_t codesize; /* Size of the kernel or bios data */
	89	const uint8_t kernel; / Set in case we use our own mini kernel */
	90	const uint8_t bios; / Set in case we use our own mini bios */
d2ab58ff TH	91	} testdef_t;
	92
	93	static testdef_t tests[] = {
	94	{ "alpha", "clipper", "", "PCI:" },
	95	{ "ppc", "ppce500", "", "U-Boot" },
8e93b2c3	96	{ "ppc", "40p", "-vga none -boot d", "Trying cd:," },
d3d4f757 TH	97	{ "ppc", "g3beige", "", "PowerPC,750" },
d3d4f757 TH	98	{ "ppc", "mac99", "", "PowerPC,G4" },
99b336cd	99	{ "ppc", "sam460ex", "-m 256", "DRAM: 256 MiB" },
d2ab58ff	100	{ "ppc64", "ppce500", "", "U-Boot" },
8e93b2c3	101	{ "ppc64", "40p", "-m 192", "Memory: 192M" },
d3d4f757	102	{ "ppc64", "mac99", "", "PowerPC,970FX" },
d2ab58ff	103	{ "ppc64", "pseries", "", "Open Firmware" },
459bb44c	104	{ "ppc64", "powernv", "-cpu POWER8", "OPAL" },
99b336cd	105	{ "ppc64", "sam460ex", "-device e1000", "8086 100e" },
d2ab58ff TH	106	{ "i386", "isapc", "-cpu qemu32 -device sga", "SGABIOS" },
	107	{ "i386", "pc", "-device sga", "SGABIOS" },
	108	{ "i386", "q35", "-device sga", "SGABIOS" },
	109	{ "x86_64", "isapc", "-cpu qemu32 -device sga", "SGABIOS" },
	110	{ "x86_64", "q35", "-device sga", "SGABIOS" },
e74fbf1f TH	111	{ "sparc", "LX", "", "TMS390S10" },
	112	{ "sparc", "SS-4", "", "MB86904" },
	113	{ "sparc", "SS-600MP", "", "TMS390Z55" },
	114	{ "sparc64", "sun4u", "", "UltraSPARC" },
052888f0	115	{ "s390x", "s390-ccw-virtio", "", "virtio device" },
598a29f3	116	{ "m68k", "mcf5208evb", "", "TT", sizeof(kernel_mcf5208), kernel_mcf5208 },
acf53766 TH	117	{ "microblaze", "petalogix-s3adsp1800", "", "TT",
	118	sizeof(kernel_pls3adsp1800), kernel_pls3adsp1800 },
	119	{ "microblazeel", "petalogix-ml605", "", "TT",
	120	sizeof(kernel_plml605), kernel_plml605 },
7244edf2	121	{ "moxie", "moxiesim", "", "TT", sizeof(bios_moxiesim), 0, bios_moxiesim },
52cb6817	122	{ "arm", "raspi2", "", "TT", sizeof(bios_raspi2), 0, bios_raspi2 },
3ff6dd47	123	{ "hppa", "hppa", "", "SeaBIOS wants SYSTEM HALT" },
ec2e988f WH	124	{ "aarch64", "virt", "-cpu cortex-a57", "TT", sizeof(kernel_aarch64),
ec2e988f WH	125	kernel_aarch64 },
a2c9a356	126	{ "arm", "microbit", "", "T", sizeof(kernel_nrf51), kernel_nrf51 },
598a29f3	127
d2ab58ff TH	128	{ NULL }
	129	};
	130
21f80286	131	static bool check_guest_output(QTestState qts, const testdef_t test, int fd)
d2ab58ff	132	{
21f80286 RH	133	int nbr = 0, pos = 0, ccnt;
21f80286 RH	134	time_t now, start = time(NULL);
d2ab58ff TH	135	char ch;
d2ab58ff TH	136
21f80286 RH	137	/* Poll serial output... */
21f80286 RH	138	while (1) {
92b540da	139	ccnt = 0;
5e5432b7	140	while (ccnt++ < 512 && (nbr = read(fd, &ch, 1)) == 1) {
d2ab58ff TH	141	if (ch == test->expect[pos]) {
	142	pos += 1;
	143	if (test->expect[pos] == '\0') {
	144	/* We've reached the end of the expected string! */
28a3cfc1	145	return true;
d2ab58ff TH	146	}
	147	} else {
	148	pos = 0;
	149	}
	150	}
	151	g_assert(nbr >= 0);
21f80286 RH	152	/* Wait only if the child is still alive. */
	153	if (!qtest_probe_child(qts)) {
	154	break;
	155	}
	156	/* Wait at most 360 seconds. */
	157	now = time(NULL);
	158	if (now - start >= 360) {
	159	break;
	160	}
d2ab58ff TH	161	g_usleep(10000);
	162	}
	163
28a3cfc1	164	return false;
d2ab58ff TH	165	}
	166
	167	static void test_machine(const void *data)
	168	{
	169	const testdef_t *test = data;
e12c08d3 TH	170	char serialtmp[] = "/tmp/qtest-boot-serial-sXXXXXX";
	171	char codetmp[] = "/tmp/qtest-boot-serial-cXXXXXX";
	172	const char *codeparam = "";
	173	const uint8_t *code = NULL;
e6426b74	174	QTestState *qts;
e12c08d3	175	int ser_fd;
d2ab58ff	176
e12c08d3 TH	177	ser_fd = mkstemp(serialtmp);
	178	g_assert(ser_fd != -1);
	179
	180	if (test->kernel) {
	181	code = test->kernel;
	182	codeparam = "-kernel";
	183	} else if (test->bios) {
	184	code = test->bios;
	185	codeparam = "-bios";
	186	}
	187
	188	if (code) {
	189	ssize_t wlen;
	190	int code_fd;
	191
	192	code_fd = mkstemp(codetmp);
	193	g_assert(code_fd != -1);
	194	wlen = write(code_fd, code, test->codesize);
	195	g_assert(wlen == test->codesize);
	196	close(code_fd);
	197	}
d2ab58ff	198
b96919d7 CH	199	/*
	200	* Make sure that this test uses tcg if available: It is used as a
	201	* fast-enough smoketest for that.
	202	*/
e6426b74 TH	203	qts = qtest_initf("%s %s -M %s,accel=tcg:kvm -no-shutdown "
	204	"-chardev file,id=serial0,path=%s "
	205	"-serial chardev:serial0 %s",
	206	codeparam, code ? codetmp : "", test->machine,
	207	serialtmp, test->extra);
e12c08d3 TH	208	if (code) {
	209	unlink(codetmp);
	210	}
d2ab58ff	211
21f80286	212	if (!check_guest_output(qts, test, ser_fd)) {
28a3cfc1 TH	213	g_error("Failed to find expected string. Please check '%s'",
	214	serialtmp);
	215	}
	216	unlink(serialtmp);
	217
e6426b74	218	qtest_quit(qts);
d2ab58ff	219
e12c08d3	220	close(ser_fd);
d2ab58ff TH	221	}
	222
	223	int main(int argc, char *argv[])
	224	{
	225	const char *arch = qtest_get_arch();
	226	int i;
	227
	228	g_test_init(&argc, &argv, NULL);
	229
	230	for (i = 0; tests[i].arch != NULL; i++) {
	231	if (strcmp(arch, tests[i].arch) == 0) {
	232	char *name = g_strdup_printf("boot-serial/%s", tests[i].machine);
	233	qtest_add_data_func(name, &tests[i], test_machine);
	234	g_free(name);
	235	}
	236	}
	237
	238	return g_test_run();
	239	}