LXR qemu/tests/qtest/boot-serial-test.c

   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
  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.
  14 */
  15
  16#include "qemu/osdep.h"
  17#include "libqos/libqtest.h"
  18#include "libqos/libqos-spapr.h"
  19
  20static const uint8_t bios_avr[] = {
  21    0x88, 0xe0,             /* ldi r24, 0x08   */
  22    0x80, 0x93, 0xc1, 0x00, /* sts 0x00C1, r24 ; Enable tx */
  23    0x86, 0xe0,             /* ldi r24, 0x06   */
  24    0x80, 0x93, 0xc2, 0x00, /* sts 0x00C2, r24 ; Set the data bits to 8 */
  25    0x84, 0xe5,             /* ldi r24, 0x54   */
  26    0x80, 0x93, 0xc6, 0x00, /* sts 0x00C6, r24 ; Output 'T' */
  27};
  28
  29static const uint8_t kernel_mcf5208[] = {
  30    0x41, 0xf9, 0xfc, 0x06, 0x00, 0x00,     /* lea 0xfc060000,%a0 */
  31    0x10, 0x3c, 0x00, 0x54,                 /* move.b #'T',%d0 */
  32    0x11, 0x7c, 0x00, 0x04, 0x00, 0x08,     /* move.b #4,8(%a0)     Enable TX */
  33    0x11, 0x40, 0x00, 0x0c,                 /* move.b %d0,12(%a0)   Print 'T' */
  34    0x60, 0xfa                              /* bra.s  loop */
  35};
  36
  37static const uint8_t bios_nextcube[] = {
  38    0x06, 0x00, 0x00, 0x00,                 /* Initial SP */
  39    0x01, 0x00, 0x00, 0x08,                 /* Initial PC */
  40    0x41, 0xf9, 0x02, 0x11, 0x80, 0x00,     /* lea 0x02118000,%a0 */
  41    0x10, 0x3c, 0x00, 0x54,                 /* move.b #'T',%d0 */
  42    0x11, 0x7c, 0x00, 0x05, 0x00, 0x01,     /* move.b #5,1(%a0)    Sel TXCTRL */
  43    0x11, 0x7c, 0x00, 0x68, 0x00, 0x01,     /* move.b #0x68,1(%a0) Enable TX */
  44    0x11, 0x40, 0x00, 0x03,                 /* move.b %d0,3(%a0)   Print 'T' */
  45    0x60, 0xfa                              /* bra.s  loop */
  46};
  47
  48static const uint8_t kernel_pls3adsp1800[] = {
  49    0xb0, 0x00, 0x84, 0x00,                 /* imm   0x8400 */
  50    0x30, 0x60, 0x00, 0x04,                 /* addik r3,r0,4 */
  51    0x30, 0x80, 0x00, 0x54,                 /* addik r4,r0,'T' */
  52    0xf0, 0x83, 0x00, 0x00,                 /* sbi   r4,r3,0 */
  53    0xb8, 0x00, 0xff, 0xfc                  /* bri   -4  loop */
  54};
  55
  56static const uint8_t kernel_plml605[] = {
  57    0xe0, 0x83, 0x00, 0xb0,                 /* imm   0x83e0 */
  58    0x00, 0x10, 0x60, 0x30,                 /* addik r3,r0,0x1000 */
  59    0x54, 0x00, 0x80, 0x30,                 /* addik r4,r0,'T' */
  60    0x00, 0x00, 0x83, 0xf0,                 /* sbi   r4,r3,0 */
  61    0xfc, 0xff, 0x00, 0xb8                  /* bri   -4  loop */
  62};
  63
  64static const uint8_t bios_moxiesim[] = {
  65    0x20, 0x10, 0x00, 0x00, 0x03, 0xf8,     /* ldi.s r1,0x3f8 */
  66    0x1b, 0x20, 0x00, 0x00, 0x00, 0x54,     /* ldi.b r2,'T' */
  67    0x1e, 0x12,                             /* st.b  r1,r2 */
  68    0x1a, 0x00, 0x00, 0x00, 0x10, 0x00      /* jmpa  0x1000 */
  69};
  70
  71static const uint8_t bios_raspi2[] = {
  72    0x08, 0x30, 0x9f, 0xe5,                 /* ldr   r3,[pc,#8]    Get base */
  73    0x54, 0x20, 0xa0, 0xe3,                 /* mov     r2,#'T' */
  74    0x00, 0x20, 0xc3, 0xe5,                 /* strb    r2,[r3] */
  75    0xfb, 0xff, 0xff, 0xea,                 /* b       loop */
  76    0x00, 0x10, 0x20, 0x3f,                 /* 0x3f201000 = UART0 base addr */
  77};
  78
  79static const uint8_t kernel_aarch64[] = {
  80    0x81, 0x0a, 0x80, 0x52,                 /* mov     w1, #0x54 */
  81    0x02, 0x20, 0xa1, 0xd2,                 /* mov     x2, #0x9000000 */
  82    0x41, 0x00, 0x00, 0x39,                 /* strb    w1, [x2] */
  83    0xfd, 0xff, 0xff, 0x17,                 /* b       -12 (loop) */
  84};
  85
  86static const uint8_t kernel_nrf51[] = {
  87    0x00, 0x00, 0x00, 0x00,                 /* Stack top address */
  88    0x09, 0x00, 0x00, 0x00,                 /* Reset handler address */
  89    0x04, 0x4a,                             /* ldr  r2, [pc, #16] Get ENABLE */
  90    0x04, 0x21,                             /* movs r1, #4 */
  91    0x11, 0x60,                             /* str  r1, [r2] */
  92    0x04, 0x4a,                             /* ldr  r2, [pc, #16] Get STARTTX */
  93    0x01, 0x21,                             /* movs r1, #1 */
  94    0x11, 0x60,                             /* str  r1, [r2] */
  95    0x03, 0x4a,                             /* ldr  r2, [pc, #12] Get TXD */
  96    0x54, 0x21,                             /* movs r1, 'T' */
  97    0x11, 0x60,                             /* str  r1, [r2] */
  98    0xfe, 0xe7,                             /* b    . */
  99    0x00, 0x25, 0x00, 0x40,                 /* 0x40002500 = UART ENABLE */
 100    0x08, 0x20, 0x00, 0x40,                 /* 0x40002008 = UART STARTTX */
 101    0x1c, 0x25, 0x00, 0x40                  /* 0x4000251c = UART TXD */
 102};
 103
 104typedef struct testdef {
 105    const char *arch;       /* Target architecture */
 106    const char *machine;    /* Name of the machine */
 107    const char *extra;      /* Additional parameters */
 108    const char *expect;     /* Expected string in the serial output */
 109    size_t codesize;        /* Size of the kernel or bios data */
 110    const uint8_t *kernel;  /* Set in case we use our own mini kernel */
 111    const uint8_t *bios;    /* Set in case we use our own mini bios */
 112} testdef_t;
 113
 114static testdef_t tests[] = {
 115    { "alpha", "clipper", "", "PCI:" },
 116    { "avr", "arduino-duemilanove", "", "T", sizeof(bios_avr), NULL, bios_avr },
 117    { "avr", "arduino-mega-2560-v3", "", "T", sizeof(bios_avr), NULL, bios_avr},
 118    { "ppc", "ppce500", "", "U-Boot" },
 119    { "ppc", "40p", "-vga none -boot d", "Trying cd:," },
 120    { "ppc", "g3beige", "", "PowerPC,750" },
 121    { "ppc", "mac99", "", "PowerPC,G4" },
 122    { "ppc", "sam460ex", "-m 256", "DRAM:  256 MiB" },
 123    { "ppc64", "ppce500", "", "U-Boot" },
 124    { "ppc64", "40p", "-m 192", "Memory: 192M" },
 125    { "ppc64", "mac99", "", "PowerPC,970FX" },
 126    { "ppc64", "pseries",
 127      "-machine " PSERIES_DEFAULT_CAPABILITIES,
 128      "Open Firmware" },
 129    { "ppc64", "powernv8", "", "OPAL" },
 130    { "ppc64", "powernv9", "", "OPAL" },
 131    { "ppc64", "sam460ex", "-device e1000", "8086  100e" },
 132    { "i386", "isapc", "-cpu qemu32 -device sga", "SGABIOS" },
 133    { "i386", "pc", "-device sga", "SGABIOS" },
 134    { "i386", "q35", "-device sga", "SGABIOS" },
 135    { "x86_64", "isapc", "-cpu qemu32 -device sga", "SGABIOS" },
 136    { "x86_64", "q35", "-device sga", "SGABIOS" },
 137    { "sparc", "LX", "", "TMS390S10" },
 138    { "sparc", "SS-4", "", "MB86904" },
 139    { "sparc", "SS-600MP", "", "TMS390Z55" },
 140    { "sparc64", "sun4u", "", "UltraSPARC" },
 141    { "s390x", "s390-ccw-virtio", "", "device" },
 142    { "m68k", "mcf5208evb", "", "TT", sizeof(kernel_mcf5208), kernel_mcf5208 },
 143    { "m68k", "next-cube", "", "TT", sizeof(bios_nextcube), 0, bios_nextcube },
 144    { "microblaze", "petalogix-s3adsp1800", "", "TT",
 145      sizeof(kernel_pls3adsp1800), kernel_pls3adsp1800 },
 146    { "microblazeel", "petalogix-ml605", "", "TT",
 147      sizeof(kernel_plml605), kernel_plml605 },
 148    { "moxie", "moxiesim", "", "TT", sizeof(bios_moxiesim), 0, bios_moxiesim },
 149    { "arm", "raspi2", "", "TT", sizeof(bios_raspi2), 0, bios_raspi2 },
 150    /* For hppa, force bios to output to serial by disabling graphics. */
 151    { "hppa", "hppa", "-vga none", "SeaBIOS wants SYSTEM HALT" },
 152    { "aarch64", "virt", "-cpu max", "TT", sizeof(kernel_aarch64),
 153      kernel_aarch64 },
 154    { "arm", "microbit", "", "T", sizeof(kernel_nrf51), kernel_nrf51 },
 155
 156    { NULL }
 157};
 158
 159static bool check_guest_output(QTestState *qts, const testdef_t *test, int fd)
 160{
 161    int nbr = 0, pos = 0, ccnt;
 162    time_t now, start = time(NULL);
 163    char ch;
 164
 165    /* Poll serial output... */
 166    while (1) {
 167        ccnt = 0;
 168        while (ccnt++ < 512 && (nbr = read(fd, &ch, 1)) == 1) {
 169            if (ch == test->expect[pos]) {
 170                pos += 1;
 171                if (test->expect[pos] == '\0') {
 172                    /* We've reached the end of the expected string! */
 173                    return true;
 174                }
 175            } else {
 176                pos = 0;
 177            }
 178        }
 179        g_assert(nbr >= 0);
 180        /* Wait only if the child is still alive.  */
 181        if (!qtest_probe_child(qts)) {
 182            break;
 183        }
 184        /* Wait at most 360 seconds.  */
 185        now = time(NULL);
 186        if (now - start >= 360) {
 187            break;
 188        }
 189        g_usleep(10000);
 190    }
 191
 192    return false;
 193}
 194
 195static void test_machine(const void *data)
 196{
 197    const testdef_t *test = data;
 198    char serialtmp[] = "/tmp/qtest-boot-serial-sXXXXXX";
 199    char codetmp[] = "/tmp/qtest-boot-serial-cXXXXXX";
 200    const char *codeparam = "";
 201    const uint8_t *code = NULL;
 202    QTestState *qts;
 203    int ser_fd;
 204
 205    ser_fd = mkstemp(serialtmp);
 206    g_assert(ser_fd != -1);
 207
 208    if (test->kernel) {
 209        code = test->kernel;
 210        codeparam = "-kernel";
 211    } else if (test->bios) {
 212        code = test->bios;
 213        codeparam = "-bios";
 214    }
 215
 216    if (code) {
 217        ssize_t wlen;
 218        int code_fd;
 219
 220        code_fd = mkstemp(codetmp);
 221        g_assert(code_fd != -1);
 222        wlen = write(code_fd, code, test->codesize);
 223        g_assert(wlen == test->codesize);
 224        close(code_fd);
 225    }
 226
 227    /*
 228     * Make sure that this test uses tcg if available: It is used as a
 229     * fast-enough smoketest for that.
 230     */
 231    qts = qtest_initf("%s %s -M %s -no-shutdown "
 232                      "-chardev file,id=serial0,path=%s "
 233                      "-serial chardev:serial0 -accel tcg -accel kvm %s",
 234                      codeparam, code ? codetmp : "", test->machine,
 235                      serialtmp, test->extra);
 236    if (code) {
 237        unlink(codetmp);
 238    }
 239
 240    if (!check_guest_output(qts, test, ser_fd)) {
 241        g_error("Failed to find expected string. Please check '%s'",
 242                serialtmp);
 243    }
 244    unlink(serialtmp);
 245
 246    qtest_quit(qts);
 247
 248    close(ser_fd);
 249}
 250
 251int main(int argc, char *argv[])
 252{
 253    const char *arch = qtest_get_arch();
 254    int i;
 255
 256    g_test_init(&argc, &argv, NULL);
 257
 258    for (i = 0; tests[i].arch != NULL; i++) {
 259        if (strcmp(arch, tests[i].arch) == 0) {
 260            char *name = g_strdup_printf("boot-serial/%s", tests[i].machine);
 261            qtest_add_data_func(name, &tests[i], test_machine);
 262            g_free(name);
 263        }
 264    }
 265
 266    return g_test_run();
 267}
 268