tests/ahci-test.c

   1 /*
   2  * AHCI test cases
   3  *
   4  * Copyright (c) 2014 John Snow <[email protected]>
   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
  25 #include <stdint.h>
  26 #include <string.h>
  27 #include <stdio.h>
  28 #include <getopt.h>
  29 #include <glib.h>
  30
  31 #include "libqtest.h"
  32 #include "libqos/libqos-pc.h"
  33 #include "libqos/ahci.h"
  34 #include "libqos/pci-pc.h"
  35
  36 #include "qemu-common.h"
  37 #include "qemu/host-utils.h"
  38
  39 #include "hw/pci/pci_ids.h"
  40 #include "hw/pci/pci_regs.h"
  41
  42 /* Test images sizes in MB */
  43 #define TEST_IMAGE_SIZE_MB_LARGE (200 * 1024)
  44 #define TEST_IMAGE_SIZE_MB_SMALL 64
  45
  46 /*** Globals ***/
  47 static char tmp_path[] = "/tmp/qtest.XXXXXX";
  48 static char debug_path[] = "/tmp/qtest-blkdebug.XXXXXX";
  49 static char mig_socket[] = "/tmp/qtest-migration.XXXXXX";
  50 static bool ahci_pedantic;
  51 static const char *imgfmt;
  52 static unsigned test_image_size_mb;
  53
  54 /*** Function Declarations ***/
  55 static void ahci_test_port_spec(AHCIQState *ahci, uint8_t port);
  56 static void ahci_test_pci_spec(AHCIQState *ahci);
  57 static void ahci_test_pci_caps(AHCIQState *ahci, uint16_t header,
  58                                uint8_t offset);
  59 static void ahci_test_satacap(AHCIQState *ahci, uint8_t offset);
  60 static void ahci_test_msicap(AHCIQState *ahci, uint8_t offset);
  61 static void ahci_test_pmcap(AHCIQState *ahci, uint8_t offset);
  62
  63 /*** Utilities ***/
  64
  65 static uint64_t mb_to_sectors(uint64_t image_size_mb)
  66 {
  67     return (image_size_mb * 1024 * 1024) / AHCI_SECTOR_SIZE;
  68 }
  69
  70 static void string_bswap16(uint16_t *s, size_t bytes)
  71 {
  72     g_assert_cmphex((bytes & 1), ==, 0);
  73     bytes /= 2;
  74
  75     while (bytes--) {
  76         *s = bswap16(*s);
  77         s++;
  78     }
  79 }
  80
  81 /**
  82  * Verify that the transfer did not corrupt our state at all.
  83  */
  84 static void verify_state(AHCIQState *ahci)
  85 {
  86     int i, j;
  87     uint32_t ahci_fingerprint;
  88     uint64_t hba_base;
  89     uint64_t hba_stored;
  90     AHCICommandHeader cmd;
  91
  92     ahci_fingerprint = qpci_config_readl(ahci->dev, PCI_VENDOR_ID);
  93     g_assert_cmphex(ahci_fingerprint, ==, ahci->fingerprint);
  94
  95     /* If we haven't initialized, this is as much as can be validated. */
  96     if (!ahci->hba_base) {
  97         return;
  98     }
  99
 100     hba_base = (uint64_t)qpci_config_readl(ahci->dev, PCI_BASE_ADDRESS_5);
 101     hba_stored = (uint64_t)(uintptr_t)ahci->hba_base;
 102     g_assert_cmphex(hba_base, ==, hba_stored);
 103
 104     g_assert_cmphex(ahci_rreg(ahci, AHCI_CAP), ==, ahci->cap);
 105     g_assert_cmphex(ahci_rreg(ahci, AHCI_CAP2), ==, ahci->cap2);
 106
 107     for (i = 0; i < 32; i++) {
 108         g_assert_cmphex(ahci_px_rreg(ahci, i, AHCI_PX_FB), ==,
 109                         ahci->port[i].fb);
 110         g_assert_cmphex(ahci_px_rreg(ahci, i, AHCI_PX_CLB), ==,
 111                         ahci->port[i].clb);
 112         for (j = 0; j < 32; j++) {
 113             ahci_get_command_header(ahci, i, j, &cmd);
 114             g_assert_cmphex(cmd.prdtl, ==, ahci->port[i].prdtl[j]);
 115             g_assert_cmphex(cmd.ctba, ==, ahci->port[i].ctba[j]);
 116         }
 117     }
 118 }
 119
 120 static void ahci_migrate(AHCIQState *from, AHCIQState *to, const char *uri)
 121 {
 122     QOSState *tmp = to->parent;
 123     QPCIDevice *dev = to->dev;
 124     char *uri_local = NULL;
 125
 126     if (uri == NULL) {
 127         uri_local = g_strdup_printf("%s%s", "unix:", mig_socket);
 128         uri = uri_local;
 129     }
 130
 131     /* context will be 'to' after completion. */
 132     migrate(from->parent, to->parent, uri);
 133
 134     /* We'd like for the AHCIState objects to still point
 135      * to information specific to its specific parent
 136      * instance, but otherwise just inherit the new data. */
 137     memcpy(to, from, sizeof(AHCIQState));
 138     to->parent = tmp;
 139     to->dev = dev;
 140
 141     tmp = from->parent;
 142     dev = from->dev;
 143     memset(from, 0x00, sizeof(AHCIQState));
 144     from->parent = tmp;
 145     from->dev = dev;
 146
 147     verify_state(to);
 148     g_free(uri_local);
 149 }
 150
 151 /*** Test Setup & Teardown ***/
 152
 153 /**
 154  * Start a Q35 machine and bookmark a handle to the AHCI device.
 155  */
 156 static AHCIQState *ahci_vboot(const char *cli, va_list ap)
 157 {
 158     AHCIQState *s;
 159
 160     s = g_malloc0(sizeof(AHCIQState));
 161     s->parent = qtest_pc_vboot(cli, ap);
 162     alloc_set_flags(s->parent->alloc, ALLOC_LEAK_ASSERT);
 163
 164     /* Verify that we have an AHCI device present. */
 165     s->dev = get_ahci_device(&s->fingerprint);
 166
 167     return s;
 168 }
 169
 170 /**
 171  * Start a Q35 machine and bookmark a handle to the AHCI device.
 172  */
 173 static AHCIQState *ahci_boot(const char *cli, ...)
 174 {
 175     AHCIQState *s;
 176     va_list ap;
 177
 178     if (cli) {
 179         va_start(ap, cli);
 180         s = ahci_vboot(cli, ap);
 181         va_end(ap);
 182     } else {
 183         cli = "-drive if=none,id=drive0,file=%s,cache=writeback,serial=%s"
 184             ",format=%s"
 185             " -M q35 "
 186             "-device ide-hd,drive=drive0 "
 187             "-global ide-hd.ver=%s";
 188         s = ahci_boot(cli, tmp_path, "testdisk", imgfmt, "version");
 189     }
 190
 191     return s;
 192 }
 193
 194 /**
 195  * Clean up the PCI device, then terminate the QEMU instance.
 196  */
 197 static void ahci_shutdown(AHCIQState *ahci)
 198 {
 199     QOSState *qs = ahci->parent;
 200
 201     set_context(qs);
 202     ahci_clean_mem(ahci);
 203     free_ahci_device(ahci->dev);
 204     g_free(ahci);
 205     qtest_shutdown(qs);
 206 }
 207
 208 /**
 209  * Boot and fully enable the HBA device.
 210  * @see ahci_boot, ahci_pci_enable and ahci_hba_enable.
 211  */
 212 static AHCIQState *ahci_boot_and_enable(const char *cli, ...)
 213 {
 214     AHCIQState *ahci;
 215     va_list ap;
 216     uint16_t buff[256];
 217     uint8_t port;
 218     uint8_t hello;
 219
 220     if (cli) {
 221         va_start(ap, cli);
 222         ahci = ahci_vboot(cli, ap);
 223         va_end(ap);
 224     } else {
 225         ahci = ahci_boot(NULL);
 226     }
 227
 228     ahci_pci_enable(ahci);
 229     ahci_hba_enable(ahci);
 230     /* Initialize test device */
 231     port = ahci_port_select(ahci);
 232     ahci_port_clear(ahci, port);
 233     if (is_atapi(ahci, port)) {
 234         hello = CMD_PACKET_ID;
 235     } else {
 236         hello = CMD_IDENTIFY;
 237     }
 238     ahci_io(ahci, port, hello, &buff, sizeof(buff), 0);
 239
 240     return ahci;
 241 }
 242
 243 /*** Specification Adherence Tests ***/
 244
 245 /**
 246  * Implementation for test_pci_spec. Ensures PCI configuration space is sane.
 247  */
 248 static void ahci_test_pci_spec(AHCIQState *ahci)
 249 {
 250     uint8_t datab;
 251     uint16_t data;
 252     uint32_t datal;
 253
 254     /* Most of these bits should start cleared until we turn them on. */
 255     data = qpci_config_readw(ahci->dev, PCI_COMMAND);
 256     ASSERT_BIT_CLEAR(data, PCI_COMMAND_MEMORY);
 257     ASSERT_BIT_CLEAR(data, PCI_COMMAND_MASTER);
 258     ASSERT_BIT_CLEAR(data, PCI_COMMAND_SPECIAL);     /* Reserved */
 259     ASSERT_BIT_CLEAR(data, PCI_COMMAND_VGA_PALETTE); /* Reserved */
 260     ASSERT_BIT_CLEAR(data, PCI_COMMAND_PARITY);
 261     ASSERT_BIT_CLEAR(data, PCI_COMMAND_WAIT);        /* Reserved */
 262     ASSERT_BIT_CLEAR(data, PCI_COMMAND_SERR);
 263     ASSERT_BIT_CLEAR(data, PCI_COMMAND_FAST_BACK);
 264     ASSERT_BIT_CLEAR(data, PCI_COMMAND_INTX_DISABLE);
 265     ASSERT_BIT_CLEAR(data, 0xF800);                  /* Reserved */
 266
 267     data = qpci_config_readw(ahci->dev, PCI_STATUS);
 268     ASSERT_BIT_CLEAR(data, 0x01 | 0x02 | 0x04);     /* Reserved */
 269     ASSERT_BIT_CLEAR(data, PCI_STATUS_INTERRUPT);
 270     ASSERT_BIT_SET(data, PCI_STATUS_CAP_LIST);      /* must be set */
 271     ASSERT_BIT_CLEAR(data, PCI_STATUS_UDF);         /* Reserved */
 272     ASSERT_BIT_CLEAR(data, PCI_STATUS_PARITY);
 273     ASSERT_BIT_CLEAR(data, PCI_STATUS_SIG_TARGET_ABORT);
 274     ASSERT_BIT_CLEAR(data, PCI_STATUS_REC_TARGET_ABORT);
 275     ASSERT_BIT_CLEAR(data, PCI_STATUS_REC_MASTER_ABORT);
 276     ASSERT_BIT_CLEAR(data, PCI_STATUS_SIG_SYSTEM_ERROR);
 277     ASSERT_BIT_CLEAR(data, PCI_STATUS_DETECTED_PARITY);
 278
 279     /* RID occupies the low byte, CCs occupy the high three. */
 280     datal = qpci_config_readl(ahci->dev, PCI_CLASS_REVISION);
 281     if (ahci_pedantic) {
 282         /* AHCI 1.3 specifies that at-boot, the RID should reset to 0x00,
 283          * Though in practice this is likely seldom true. */
 284         ASSERT_BIT_CLEAR(datal, 0xFF);
 285     }
 286
 287     /* BCC *must* equal 0x01. */
 288     g_assert_cmphex(PCI_BCC(datal), ==, 0x01);
 289     if (PCI_SCC(datal) == 0x01) {
 290         /* IDE */
 291         ASSERT_BIT_SET(0x80000000, datal);
 292         ASSERT_BIT_CLEAR(0x60000000, datal);
 293     } else if (PCI_SCC(datal) == 0x04) {
 294         /* RAID */
 295         g_assert_cmphex(PCI_PI(datal), ==, 0);
 296     } else if (PCI_SCC(datal) == 0x06) {
 297         /* AHCI */
 298         g_assert_cmphex(PCI_PI(datal), ==, 0x01);
 299     } else {
 300         g_assert_not_reached();
 301     }
 302
 303     datab = qpci_config_readb(ahci->dev, PCI_CACHE_LINE_SIZE);
 304     g_assert_cmphex(datab, ==, 0);
 305
 306     datab = qpci_config_readb(ahci->dev, PCI_LATENCY_TIMER);
 307     g_assert_cmphex(datab, ==, 0);
 308
 309     /* Only the bottom 7 bits must be off. */
 310     datab = qpci_config_readb(ahci->dev, PCI_HEADER_TYPE);
 311     ASSERT_BIT_CLEAR(datab, 0x7F);
 312
 313     /* BIST is optional, but the low 7 bits must always start off regardless. */
 314     datab = qpci_config_readb(ahci->dev, PCI_BIST);
 315     ASSERT_BIT_CLEAR(datab, 0x7F);
 316
 317     /* BARS 0-4 do not have a boot spec, but ABAR/BAR5 must be clean. */
 318     datal = qpci_config_readl(ahci->dev, PCI_BASE_ADDRESS_5);
 319     g_assert_cmphex(datal, ==, 0);
 320
 321     qpci_config_writel(ahci->dev, PCI_BASE_ADDRESS_5, 0xFFFFFFFF);
 322     datal = qpci_config_readl(ahci->dev, PCI_BASE_ADDRESS_5);
 323     /* ABAR must be 32-bit, memory mapped, non-prefetchable and
 324      * must be >= 512 bytes. To that end, bits 0-8 must be off. */
 325     ASSERT_BIT_CLEAR(datal, 0xFF);
 326
 327     /* Capability list MUST be present, */
 328     datal = qpci_config_readl(ahci->dev, PCI_CAPABILITY_LIST);
 329     /* But these bits are reserved. */
 330     ASSERT_BIT_CLEAR(datal, ~0xFF);
 331     g_assert_cmphex(datal, !=, 0);
 332
 333     /* Check specification adherence for capability extenstions. */
 334     data = qpci_config_readw(ahci->dev, datal);
 335
 336     switch (ahci->fingerprint) {
 337     case AHCI_INTEL_ICH9:
 338         /* Intel ICH9 Family Datasheet 14.1.19 p.550 */
 339         g_assert_cmphex((data & 0xFF), ==, PCI_CAP_ID_MSI);
 340         break;
 341     default:
 342         /* AHCI 1.3, Section 2.1.14 -- CAP must point to PMCAP. */
 343         g_assert_cmphex((data & 0xFF), ==, PCI_CAP_ID_PM);
 344     }
 345
 346     ahci_test_pci_caps(ahci, data, (uint8_t)datal);
 347
 348     /* Reserved. */
 349     datal = qpci_config_readl(ahci->dev, PCI_CAPABILITY_LIST + 4);
 350     g_assert_cmphex(datal, ==, 0);
 351
 352     /* IPIN might vary, but ILINE must be off. */
 353     datab = qpci_config_readb(ahci->dev, PCI_INTERRUPT_LINE);
 354     g_assert_cmphex(datab, ==, 0);
 355 }
 356
 357 /**
 358  * Test PCI capabilities for AHCI specification adherence.
 359  */
 360 static void ahci_test_pci_caps(AHCIQState *ahci, uint16_t header,
 361                                uint8_t offset)
 362 {
 363     uint8_t cid = header & 0xFF;
 364     uint8_t next = header >> 8;
 365
 366     g_test_message("CID: %02x; next: %02x", cid, next);
 367
 368     switch (cid) {
 369     case PCI_CAP_ID_PM:
 370         ahci_test_pmcap(ahci, offset);
 371         break;
 372     case PCI_CAP_ID_MSI:
 373         ahci_test_msicap(ahci, offset);
 374         break;
 375     case PCI_CAP_ID_SATA:
 376         ahci_test_satacap(ahci, offset);
 377         break;
 378
 379     default:
 380         g_test_message("Unknown CAP 0x%02x", cid);
 381     }
 382
 383     if (next) {
 384         ahci_test_pci_caps(ahci, qpci_config_readw(ahci->dev, next), next);
 385     }
 386 }
 387
 388 /**
 389  * Test SATA PCI capabilitity for AHCI specification adherence.
 390  */
 391 static void ahci_test_satacap(AHCIQState *ahci, uint8_t offset)
 392 {
 393     uint16_t dataw;
 394     uint32_t datal;
 395
 396     g_test_message("Verifying SATACAP");
 397
 398     /* Assert that the SATACAP version is 1.0, And reserved bits are empty. */
 399     dataw = qpci_config_readw(ahci->dev, offset + 2);
 400     g_assert_cmphex(dataw, ==, 0x10);
 401
 402     /* Grab the SATACR1 register. */
 403     datal = qpci_config_readw(ahci->dev, offset + 4);
 404
 405     switch (datal & 0x0F) {
 406     case 0x04: /* BAR0 */
 407     case 0x05: /* BAR1 */
 408     case 0x06:
 409     case 0x07:
 410     case 0x08:
 411     case 0x09: /* BAR5 */
 412     case 0x0F: /* Immediately following SATACR1 in PCI config space. */
 413         break;
 414     default:
 415         /* Invalid BARLOC for the Index Data Pair. */
 416         g_assert_not_reached();
 417     }
 418
 419     /* Reserved. */
 420     g_assert_cmphex((datal >> 24), ==, 0x00);
 421 }
 422
 423 /**
 424  * Test MSI PCI capability for AHCI specification adherence.
 425  */
 426 static void ahci_test_msicap(AHCIQState *ahci, uint8_t offset)
 427 {
 428     uint16_t dataw;
 429     uint32_t datal;
 430
 431     g_test_message("Verifying MSICAP");
 432
 433     dataw = qpci_config_readw(ahci->dev, offset + PCI_MSI_FLAGS);
 434     ASSERT_BIT_CLEAR(dataw, PCI_MSI_FLAGS_ENABLE);
 435     ASSERT_BIT_CLEAR(dataw, PCI_MSI_FLAGS_QSIZE);
 436     ASSERT_BIT_CLEAR(dataw, PCI_MSI_FLAGS_RESERVED);
 437
 438     datal = qpci_config_readl(ahci->dev, offset + PCI_MSI_ADDRESS_LO);
 439     g_assert_cmphex(datal, ==, 0);
 440
 441     if (dataw & PCI_MSI_FLAGS_64BIT) {
 442         g_test_message("MSICAP is 64bit");
 443         datal = qpci_config_readl(ahci->dev, offset + PCI_MSI_ADDRESS_HI);
 444         g_assert_cmphex(datal, ==, 0);
 445         dataw = qpci_config_readw(ahci->dev, offset + PCI_MSI_DATA_64);
 446         g_assert_cmphex(dataw, ==, 0);
 447     } else {
 448         g_test_message("MSICAP is 32bit");
 449         dataw = qpci_config_readw(ahci->dev, offset + PCI_MSI_DATA_32);
 450         g_assert_cmphex(dataw, ==, 0);
 451     }
 452 }
 453
 454 /**
 455  * Test Power Management PCI capability for AHCI specification adherence.
 456  */
 457 static void ahci_test_pmcap(AHCIQState *ahci, uint8_t offset)
 458 {
 459     uint16_t dataw;
 460
 461     g_test_message("Verifying PMCAP");
 462
 463     dataw = qpci_config_readw(ahci->dev, offset + PCI_PM_PMC);
 464     ASSERT_BIT_CLEAR(dataw, PCI_PM_CAP_PME_CLOCK);
 465     ASSERT_BIT_CLEAR(dataw, PCI_PM_CAP_RESERVED);
 466     ASSERT_BIT_CLEAR(dataw, PCI_PM_CAP_D1);
 467     ASSERT_BIT_CLEAR(dataw, PCI_PM_CAP_D2);
 468
 469     dataw = qpci_config_readw(ahci->dev, offset + PCI_PM_CTRL);
 470     ASSERT_BIT_CLEAR(dataw, PCI_PM_CTRL_STATE_MASK);
 471     ASSERT_BIT_CLEAR(dataw, PCI_PM_CTRL_RESERVED);
 472     ASSERT_BIT_CLEAR(dataw, PCI_PM_CTRL_DATA_SEL_MASK);
 473     ASSERT_BIT_CLEAR(dataw, PCI_PM_CTRL_DATA_SCALE_MASK);
 474 }
 475
 476 static void ahci_test_hba_spec(AHCIQState *ahci)
 477 {
 478     unsigned i;
 479     uint32_t reg;
 480     uint32_t ports;
 481     uint8_t nports_impl;
 482     uint8_t maxports;
 483
 484     g_assert(ahci != NULL);
 485
 486     /*
 487      * Note that the AHCI spec does expect the BIOS to set up a few things:
 488      * CAP.SSS    - Support for staggered spin-up            (t/f)
 489      * CAP.SMPS   - Support for mechanical presence switches (t/f)
 490      * PI         - Ports Implemented                        (1-32)
 491      * PxCMD.HPCP - Hot Plug Capable Port
 492      * PxCMD.MPSP - Mechanical Presence Switch Present
 493      * PxCMD.CPD  - Cold Presence Detection support
 494      *
 495      * Additional items are touched if CAP.SSS is on, see AHCI 10.1.1 p.97:
 496      * Foreach Port Implemented:
 497      * -PxCMD.ST, PxCMD.CR, PxCMD.FRE, PxCMD.FR, PxSCTL.DET are 0
 498      * -PxCLB/U and PxFB/U are set to valid regions in memory
 499      * -PxSUD is set to 1.
 500      * -PxSSTS.DET is polled for presence; if detected, we continue:
 501      * -PxSERR is cleared with 1's.
 502      * -If PxTFD.STS.BSY, PxTFD.STS.DRQ, and PxTFD.STS.ERR are all zero,
 503      *  the device is ready.
 504      */
 505
 506     /* 1 CAP - Capabilities Register */
 507     ahci->cap = ahci_rreg(ahci, AHCI_CAP);
 508     ASSERT_BIT_CLEAR(ahci->cap, AHCI_CAP_RESERVED);
 509
 510     /* 2 GHC - Global Host Control */
 511     reg = ahci_rreg(ahci, AHCI_GHC);
 512     ASSERT_BIT_CLEAR(reg, AHCI_GHC_HR);
 513     ASSERT_BIT_CLEAR(reg, AHCI_GHC_IE);
 514     ASSERT_BIT_CLEAR(reg, AHCI_GHC_MRSM);
 515     if (BITSET(ahci->cap, AHCI_CAP_SAM)) {
 516         g_test_message("Supports AHCI-Only Mode: GHC_AE is Read-Only.");
 517         ASSERT_BIT_SET(reg, AHCI_GHC_AE);
 518     } else {
 519         g_test_message("Supports AHCI/Legacy mix.");
 520         ASSERT_BIT_CLEAR(reg, AHCI_GHC_AE);
 521     }
 522
 523     /* 3 IS - Interrupt Status */
 524     reg = ahci_rreg(ahci, AHCI_IS);
 525     g_assert_cmphex(reg, ==, 0);
 526
 527     /* 4 PI - Ports Implemented */
 528     ports = ahci_rreg(ahci, AHCI_PI);
 529     /* Ports Implemented must be non-zero. */
 530     g_assert_cmphex(ports, !=, 0);
 531     /* Ports Implemented must be <= Number of Ports. */
 532     nports_impl = ctpopl(ports);
 533     g_assert_cmpuint(((AHCI_CAP_NP & ahci->cap) + 1), >=, nports_impl);
 534
 535     /* Ports must be within the proper range. Given a mapping of SIZE,
 536      * 256 bytes are used for global HBA control, and the rest is used
 537      * for ports data, at 0x80 bytes each. */
 538     g_assert_cmphex(ahci->barsize, >, 0);
 539     maxports = (ahci->barsize - HBA_DATA_REGION_SIZE) / HBA_PORT_DATA_SIZE;
 540     /* e.g, 30 ports for 4K of memory. (4096 - 256) / 128 = 30 */
 541     g_assert_cmphex((reg >> maxports), ==, 0);
 542
 543     /* 5 AHCI Version */
 544     reg = ahci_rreg(ahci, AHCI_VS);
 545     switch (reg) {
 546     case AHCI_VERSION_0_95:
 547     case AHCI_VERSION_1_0:
 548     case AHCI_VERSION_1_1:
 549     case AHCI_VERSION_1_2:
 550     case AHCI_VERSION_1_3:
 551         break;
 552     default:
 553         g_assert_not_reached();
 554     }
 555
 556     /* 6 Command Completion Coalescing Control: depends on CAP.CCCS. */
 557     reg = ahci_rreg(ahci, AHCI_CCCCTL);
 558     if (BITSET(ahci->cap, AHCI_CAP_CCCS)) {
 559         ASSERT_BIT_CLEAR(reg, AHCI_CCCCTL_EN);
 560         ASSERT_BIT_CLEAR(reg, AHCI_CCCCTL_RESERVED);
 561         ASSERT_BIT_SET(reg, AHCI_CCCCTL_CC);
 562         ASSERT_BIT_SET(reg, AHCI_CCCCTL_TV);
 563     } else {
 564         g_assert_cmphex(reg, ==, 0);
 565     }
 566
 567     /* 7 CCC_PORTS */
 568     reg = ahci_rreg(ahci, AHCI_CCCPORTS);
 569     /* Must be zeroes initially regardless of CAP.CCCS */
 570     g_assert_cmphex(reg, ==, 0);
 571
 572     /* 8 EM_LOC */
 573     reg = ahci_rreg(ahci, AHCI_EMLOC);
 574     if (BITCLR(ahci->cap, AHCI_CAP_EMS)) {
 575         g_assert_cmphex(reg, ==, 0);
 576     }
 577
 578     /* 9 EM_CTL */
 579     reg = ahci_rreg(ahci, AHCI_EMCTL);
 580     if (BITSET(ahci->cap, AHCI_CAP_EMS)) {
 581         ASSERT_BIT_CLEAR(reg, AHCI_EMCTL_STSMR);
 582         ASSERT_BIT_CLEAR(reg, AHCI_EMCTL_CTLTM);
 583         ASSERT_BIT_CLEAR(reg, AHCI_EMCTL_CTLRST);
 584         ASSERT_BIT_CLEAR(reg, AHCI_EMCTL_RESERVED);
 585     } else {
 586         g_assert_cmphex(reg, ==, 0);
 587     }
 588
 589     /* 10 CAP2 -- Capabilities Extended */
 590     ahci->cap2 = ahci_rreg(ahci, AHCI_CAP2);
 591     ASSERT_BIT_CLEAR(ahci->cap2, AHCI_CAP2_RESERVED);
 592
 593     /* 11 BOHC -- Bios/OS Handoff Control */
 594     reg = ahci_rreg(ahci, AHCI_BOHC);
 595     g_assert_cmphex(reg, ==, 0);
 596
 597     /* 12 -- 23: Reserved */
 598     g_test_message("Verifying HBA reserved area is empty.");
 599     for (i = AHCI_RESERVED; i < AHCI_NVMHCI; ++i) {
 600         reg = ahci_rreg(ahci, i);
 601         g_assert_cmphex(reg, ==, 0);
 602     }
 603
 604     /* 24 -- 39: NVMHCI */
 605     if (BITCLR(ahci->cap2, AHCI_CAP2_NVMP)) {
 606         g_test_message("Verifying HBA/NVMHCI area is empty.");
 607         for (i = AHCI_NVMHCI; i < AHCI_VENDOR; ++i) {
 608             reg = ahci_rreg(ahci, i);
 609             g_assert_cmphex(reg, ==, 0);
 610         }
 611     }
 612
 613     /* 40 -- 63: Vendor */
 614     g_test_message("Verifying HBA/Vendor area is empty.");
 615     for (i = AHCI_VENDOR; i < AHCI_PORTS; ++i) {
 616         reg = ahci_rreg(ahci, i);
 617         g_assert_cmphex(reg, ==, 0);
 618     }
 619
 620     /* 64 -- XX: Port Space */
 621     for (i = 0; ports || (i < maxports); ports >>= 1, ++i) {
 622         if (BITSET(ports, 0x1)) {
 623             g_test_message("Testing port %u for spec", i);
 624             ahci_test_port_spec(ahci, i);
 625         } else {
 626             uint16_t j;
 627             uint16_t low = AHCI_PORTS + (32 * i);
 628             uint16_t high = AHCI_PORTS + (32 * (i + 1));
 629             g_test_message("Asserting unimplemented port %u "
 630                            "(reg [%u-%u]) is empty.",
 631                            i, low, high - 1);
 632             for (j = low; j < high; ++j) {
 633                 reg = ahci_rreg(ahci, j);
 634                 g_assert_cmphex(reg, ==, 0);
 635             }
 636         }
 637     }
 638 }
 639
 640 /**
 641  * Test the memory space for one port for specification adherence.
 642  */
 643 static void ahci_test_port_spec(AHCIQState *ahci, uint8_t port)
 644 {
 645     uint32_t reg;
 646     unsigned i;
 647
 648     /* (0) CLB */
 649     reg = ahci_px_rreg(ahci, port, AHCI_PX_CLB);
 650     ASSERT_BIT_CLEAR(reg, AHCI_PX_CLB_RESERVED);
 651
 652     /* (1) CLBU */
 653     if (BITCLR(ahci->cap, AHCI_CAP_S64A)) {
 654         reg = ahci_px_rreg(ahci, port, AHCI_PX_CLBU);
 655         g_assert_cmphex(reg, ==, 0);
 656     }
 657
 658     /* (2) FB */
 659     reg = ahci_px_rreg(ahci, port, AHCI_PX_FB);
 660     ASSERT_BIT_CLEAR(reg, AHCI_PX_FB_RESERVED);
 661
 662     /* (3) FBU */
 663     if (BITCLR(ahci->cap, AHCI_CAP_S64A)) {
 664         reg = ahci_px_rreg(ahci, port, AHCI_PX_FBU);
 665         g_assert_cmphex(reg, ==, 0);
 666     }
 667
 668     /* (4) IS */
 669     reg = ahci_px_rreg(ahci, port, AHCI_PX_IS);
 670     g_assert_cmphex(reg, ==, 0);
 671
 672     /* (5) IE */
 673     reg = ahci_px_rreg(ahci, port, AHCI_PX_IE);
 674     g_assert_cmphex(reg, ==, 0);
 675
 676     /* (6) CMD */
 677     reg = ahci_px_rreg(ahci, port, AHCI_PX_CMD);
 678     ASSERT_BIT_CLEAR(reg, AHCI_PX_CMD_FRE);
 679     ASSERT_BIT_CLEAR(reg, AHCI_PX_CMD_RESERVED);
 680     ASSERT_BIT_CLEAR(reg, AHCI_PX_CMD_CCS);
 681     ASSERT_BIT_CLEAR(reg, AHCI_PX_CMD_FR);
 682     ASSERT_BIT_CLEAR(reg, AHCI_PX_CMD_CR);
 683     ASSERT_BIT_CLEAR(reg, AHCI_PX_CMD_PMA); /* And RW only if CAP.SPM */
 684     ASSERT_BIT_CLEAR(reg, AHCI_PX_CMD_APSTE); /* RW only if CAP2.APST */
 685     ASSERT_BIT_CLEAR(reg, AHCI_PX_CMD_ATAPI);
 686     ASSERT_BIT_CLEAR(reg, AHCI_PX_CMD_DLAE);
 687     ASSERT_BIT_CLEAR(reg, AHCI_PX_CMD_ALPE);  /* RW only if CAP.SALP */
 688     ASSERT_BIT_CLEAR(reg, AHCI_PX_CMD_ASP);   /* RW only if CAP.SALP */
 689     ASSERT_BIT_CLEAR(reg, AHCI_PX_CMD_ICC);
 690     /* If CPDetect support does not exist, CPState must be off. */
 691     if (BITCLR(reg, AHCI_PX_CMD_CPD)) {
 692         ASSERT_BIT_CLEAR(reg, AHCI_PX_CMD_CPS);
 693     }
 694     /* If MPSPresence is not set, MPSState must be off. */
 695     if (BITCLR(reg, AHCI_PX_CMD_MPSP)) {
 696         ASSERT_BIT_CLEAR(reg, AHCI_PX_CMD_MPSS);
 697     }
 698     /* If we do not support MPS, MPSS and MPSP must be off. */
 699     if (BITCLR(ahci->cap, AHCI_CAP_SMPS)) {
 700         ASSERT_BIT_CLEAR(reg, AHCI_PX_CMD_MPSS);
 701         ASSERT_BIT_CLEAR(reg, AHCI_PX_CMD_MPSP);
 702     }
 703     /* If, via CPD or MPSP we detect a drive, HPCP must be on. */
 704     if (BITANY(reg, AHCI_PX_CMD_CPD | AHCI_PX_CMD_MPSP)) {
 705         ASSERT_BIT_SET(reg, AHCI_PX_CMD_HPCP);
 706     }
 707     /* HPCP and ESP cannot both be active. */
 708     g_assert(!BITSET(reg, AHCI_PX_CMD_HPCP | AHCI_PX_CMD_ESP));
 709     /* If CAP.FBSS is not set, FBSCP must not be set. */
 710     if (BITCLR(ahci->cap, AHCI_CAP_FBSS)) {
 711         ASSERT_BIT_CLEAR(reg, AHCI_PX_CMD_FBSCP);
 712     }
 713
 714     /* (7) RESERVED */
 715     reg = ahci_px_rreg(ahci, port, AHCI_PX_RES1);
 716     g_assert_cmphex(reg, ==, 0);
 717
 718     /* (8) TFD */
 719     reg = ahci_px_rreg(ahci, port, AHCI_PX_TFD);
 720     /* At boot, prior to an FIS being received, the TFD register should be 0x7F,
 721      * which breaks down as follows, as seen in AHCI 1.3 sec 3.3.8, p. 27. */
 722     ASSERT_BIT_SET(reg, AHCI_PX_TFD_STS_ERR);
 723     ASSERT_BIT_SET(reg, AHCI_PX_TFD_STS_CS1);
 724     ASSERT_BIT_SET(reg, AHCI_PX_TFD_STS_DRQ);
 725     ASSERT_BIT_SET(reg, AHCI_PX_TFD_STS_CS2);
 726     ASSERT_BIT_CLEAR(reg, AHCI_PX_TFD_STS_BSY);
 727     ASSERT_BIT_CLEAR(reg, AHCI_PX_TFD_ERR);
 728     ASSERT_BIT_CLEAR(reg, AHCI_PX_TFD_RESERVED);
 729
 730     /* (9) SIG */
 731     /* Though AHCI specifies the boot value should be 0xFFFFFFFF,
 732      * Even when GHC.ST is zero, the AHCI HBA may receive the initial
 733      * D2H register FIS and update the signature asynchronously,
 734      * so we cannot expect a value here. AHCI 1.3, sec 3.3.9, pp 27-28 */
 735
 736     /* (10) SSTS / SCR0: SStatus */
 737     reg = ahci_px_rreg(ahci, port, AHCI_PX_SSTS);
 738     ASSERT_BIT_CLEAR(reg, AHCI_PX_SSTS_RESERVED);
 739     /* Even though the register should be 0 at boot, it is asynchronous and
 740      * prone to change, so we cannot test any well known value. */
 741
 742     /* (11) SCTL / SCR2: SControl */
 743     reg = ahci_px_rreg(ahci, port, AHCI_PX_SCTL);
 744     g_assert_cmphex(reg, ==, 0);
 745
 746     /* (12) SERR / SCR1: SError */
 747     reg = ahci_px_rreg(ahci, port, AHCI_PX_SERR);
 748     g_assert_cmphex(reg, ==, 0);
 749
 750     /* (13) SACT / SCR3: SActive */
 751     reg = ahci_px_rreg(ahci, port, AHCI_PX_SACT);
 752     g_assert_cmphex(reg, ==, 0);
 753
 754     /* (14) CI */
 755     reg = ahci_px_rreg(ahci, port, AHCI_PX_CI);
 756     g_assert_cmphex(reg, ==, 0);
 757
 758     /* (15) SNTF */
 759     reg = ahci_px_rreg(ahci, port, AHCI_PX_SNTF);
 760     g_assert_cmphex(reg, ==, 0);
 761
 762     /* (16) FBS */
 763     reg = ahci_px_rreg(ahci, port, AHCI_PX_FBS);
 764     ASSERT_BIT_CLEAR(reg, AHCI_PX_FBS_EN);
 765     ASSERT_BIT_CLEAR(reg, AHCI_PX_FBS_DEC);
 766     ASSERT_BIT_CLEAR(reg, AHCI_PX_FBS_SDE);
 767     ASSERT_BIT_CLEAR(reg, AHCI_PX_FBS_DEV);
 768     ASSERT_BIT_CLEAR(reg, AHCI_PX_FBS_DWE);
 769     ASSERT_BIT_CLEAR(reg, AHCI_PX_FBS_RESERVED);
 770     if (BITSET(ahci->cap, AHCI_CAP_FBSS)) {
 771         /* if Port-Multiplier FIS-based switching avail, ADO must >= 2 */
 772         g_assert((reg & AHCI_PX_FBS_ADO) >> ctzl(AHCI_PX_FBS_ADO) >= 2);
 773     }
 774
 775     /* [17 -- 27] RESERVED */
 776     for (i = AHCI_PX_RES2; i < AHCI_PX_VS; ++i) {
 777         reg = ahci_px_rreg(ahci, port, i);
 778         g_assert_cmphex(reg, ==, 0);
 779     }
 780
 781     /* [28 -- 31] Vendor-Specific */
 782     for (i = AHCI_PX_VS; i < 32; ++i) {
 783         reg = ahci_px_rreg(ahci, port, i);
 784         if (reg) {
 785             g_test_message("INFO: Vendor register %u non-empty", i);
 786         }
 787     }
 788 }
 789
 790 /**
 791  * Utilizing an initialized AHCI HBA, issue an IDENTIFY command to the first
 792  * device we see, then read and check the response.
 793  */
 794 static void ahci_test_identify(AHCIQState *ahci)
 795 {
 796     uint16_t buff[256];
 797     unsigned px;
 798     int rc;
 799     uint16_t sect_size;
 800     const size_t buffsize = 512;
 801
 802     g_assert(ahci != NULL);
 803
 804     /**
 805      * This serves as a bit of a tutorial on AHCI device programming:
 806      *
 807      * (1) Create a data buffer for the IDENTIFY response to be sent to
 808      * (2) Create a Command Table buffer, where we will store the
 809      *     command and PRDT (Physical Region Descriptor Table)
 810      * (3) Construct an FIS host-to-device command structure, and write it to
 811      *     the top of the Command Table buffer.
 812      * (4) Create one or more Physical Region Descriptors (PRDs) that describe
 813      *     a location in memory where data may be stored/retrieved.
 814      * (5) Write these PRDTs to the bottom (offset 0x80) of the Command Table.
 815      * (6) Each AHCI port has up to 32 command slots. Each slot contains a
 816      *     header that points to a Command Table buffer. Pick an unused slot
 817      *     and update it to point to the Command Table we have built.
 818      * (7) Now: Command #n points to our Command Table, and our Command Table
 819      *     contains the FIS (that describes our command) and the PRDTL, which
 820      *     describes our buffer.
 821      * (8) We inform the HBA via PxCI (Command Issue) that the command in slot
 822      *     #n is ready for processing.
 823      */
 824
 825     /* Pick the first implemented and running port */
 826     px = ahci_port_select(ahci);
 827     g_test_message("Selected port %u for test", px);
 828
 829     /* Clear out the FIS Receive area and any pending interrupts. */
 830     ahci_port_clear(ahci, px);
 831
 832     /* "Read" 512 bytes using CMD_IDENTIFY into the host buffer. */
 833     ahci_io(ahci, px, CMD_IDENTIFY, &buff, buffsize, 0);
 834
 835     /* Check serial number/version in the buffer */
 836     /* NB: IDENTIFY strings are packed in 16bit little endian chunks.
 837      * Since we copy byte-for-byte in ahci-test, on both LE and BE, we need to
 838      * unchunk this data. By contrast, ide-test copies 2 bytes at a time, and
 839      * as a consequence, only needs to unchunk the data on LE machines. */
 840     string_bswap16(&buff[10], 20);
 841     rc = memcmp(&buff[10], "testdisk            ", 20);
 842     g_assert_cmphex(rc, ==, 0);
 843
 844     string_bswap16(&buff[23], 8);
 845     rc = memcmp(&buff[23], "version ", 8);
 846     g_assert_cmphex(rc, ==, 0);
 847
 848     sect_size = le16_to_cpu(*((uint16_t *)(&buff[5])));
 849     g_assert_cmphex(sect_size, ==, AHCI_SECTOR_SIZE);
 850 }
 851
 852 static void ahci_test_io_rw_simple(AHCIQState *ahci, unsigned bufsize,
 853                                    uint64_t sector, uint8_t read_cmd,
 854                                    uint8_t write_cmd)
 855 {
 856     uint64_t ptr;
 857     uint8_t port;
 858     unsigned char *tx = g_malloc(bufsize);
 859     unsigned char *rx = g_malloc0(bufsize);
 860
 861     g_assert(ahci != NULL);
 862
 863     /* Pick the first running port and clear it. */
 864     port = ahci_port_select(ahci);
 865     ahci_port_clear(ahci, port);
 866
 867     /*** Create pattern and transfer to guest ***/
 868     /* Data buffer in the guest */
 869     ptr = ahci_alloc(ahci, bufsize);
 870     g_assert(ptr);
 871
 872     /* Write some indicative pattern to our buffer. */
 873     generate_pattern(tx, bufsize, AHCI_SECTOR_SIZE);
 874     bufwrite(ptr, tx, bufsize);
 875
 876     /* Write this buffer to disk, then read it back to the DMA buffer. */
 877     ahci_guest_io(ahci, port, write_cmd, ptr, bufsize, sector);
 878     qmemset(ptr, 0x00, bufsize);
 879     ahci_guest_io(ahci, port, read_cmd, ptr, bufsize, sector);
 880
 881     /*** Read back the Data ***/
 882     bufread(ptr, rx, bufsize);
 883     g_assert_cmphex(memcmp(tx, rx, bufsize), ==, 0);
 884
 885     ahci_free(ahci, ptr);
 886     g_free(tx);
 887     g_free(rx);
 888 }
 889
 890 static uint8_t ahci_test_nondata(AHCIQState *ahci, uint8_t ide_cmd)
 891 {
 892     uint8_t port;
 893     AHCICommand *cmd;
 894
 895     /* Sanitize */
 896     port = ahci_port_select(ahci);
 897     ahci_port_clear(ahci, port);
 898
 899     /* Issue Command */
 900     cmd = ahci_command_create(ide_cmd);
 901     ahci_command_commit(ahci, cmd, port);
 902     ahci_command_issue(ahci, cmd);
 903     ahci_command_verify(ahci, cmd);
 904     ahci_command_free(cmd);
 905
 906     return port;
 907 }
 908
 909 static void ahci_test_flush(AHCIQState *ahci)
 910 {
 911     ahci_test_nondata(ahci, CMD_FLUSH_CACHE);
 912 }
 913
 914 static void ahci_test_max(AHCIQState *ahci)
 915 {
 916     RegD2HFIS *d2h = g_malloc0(0x20);
 917     uint64_t nsect;
 918     uint8_t port;
 919     uint8_t cmd;
 920     uint64_t config_sect = mb_to_sectors(test_image_size_mb) - 1;
 921
 922     if (config_sect > 0xFFFFFF) {
 923         cmd = CMD_READ_MAX_EXT;
 924     } else {
 925         cmd = CMD_READ_MAX;
 926     }
 927
 928     port = ahci_test_nondata(ahci, cmd);
 929     memread(ahci->port[port].fb + 0x40, d2h, 0x20);
 930     nsect = (uint64_t)d2h->lba_hi[2] << 40 |
 931         (uint64_t)d2h->lba_hi[1] << 32 |
 932         (uint64_t)d2h->lba_hi[0] << 24 |
 933         (uint64_t)d2h->lba_lo[2] << 16 |
 934         (uint64_t)d2h->lba_lo[1] << 8 |
 935         (uint64_t)d2h->lba_lo[0];
 936
 937     g_assert_cmphex(nsect, ==, config_sect);
 938     g_free(d2h);
 939 }
 940
 941
 942 /******************************************************************************/
 943 /* Test Interfaces                                                            */
 944 /******************************************************************************/
 945
 946 /**
 947  * Basic sanity test to boot a machine, find an AHCI device, and shutdown.
 948  */
 949 static void test_sanity(void)
 950 {
 951     AHCIQState *ahci;
 952     ahci = ahci_boot(NULL);
 953     ahci_shutdown(ahci);
 954 }
 955
 956 /**
 957  * Ensure that the PCI configuration space for the AHCI device is in-line with
 958  * the AHCI 1.3 specification for initial values.
 959  */
 960 static void test_pci_spec(void)
 961 {
 962     AHCIQState *ahci;
 963     ahci = ahci_boot(NULL);
 964     ahci_test_pci_spec(ahci);
 965     ahci_shutdown(ahci);
 966 }
 967
 968 /**
 969  * Engage the PCI AHCI device and sanity check the response.
 970  * Perform additional PCI config space bringup for the HBA.
 971  */
 972 static void test_pci_enable(void)
 973 {
 974     AHCIQState *ahci;
 975     ahci = ahci_boot(NULL);
 976     ahci_pci_enable(ahci);
 977     ahci_shutdown(ahci);
 978 }
 979
 980 /**
 981  * Investigate the memory mapped regions of the HBA,
 982  * and test them for AHCI specification adherence.
 983  */
 984 static void test_hba_spec(void)
 985 {
 986     AHCIQState *ahci;
 987
 988     ahci = ahci_boot(NULL);
 989     ahci_pci_enable(ahci);
 990     ahci_test_hba_spec(ahci);
 991     ahci_shutdown(ahci);
 992 }
 993
 994 /**
 995  * Engage the HBA functionality of the AHCI PCI device,
 996  * and bring it into a functional idle state.
 997  */
 998 static void test_hba_enable(void)
 999 {
1000     AHCIQState *ahci;
1001
1002     ahci = ahci_boot(NULL);
1003     ahci_pci_enable(ahci);
1004     ahci_hba_enable(ahci);
1005     ahci_shutdown(ahci);
1006 }
1007
1008 /**
1009  * Bring up the device and issue an IDENTIFY command.
1010  * Inspect the state of the HBA device and the data returned.
1011  */
1012 static void test_identify(void)
1013 {
1014     AHCIQState *ahci;
1015
1016     ahci = ahci_boot_and_enable(NULL);
1017     ahci_test_identify(ahci);
1018     ahci_shutdown(ahci);
1019 }
1020
1021 /**
1022  * Fragmented DMA test: Perform a standard 4K DMA read/write
1023  * test, but make sure the physical regions are fragmented to
1024  * be very small, each just 32 bytes, to see how AHCI performs
1025  * with chunks defined to be much less than a sector.
1026  */
1027 static void test_dma_fragmented(void)
1028 {
1029     AHCIQState *ahci;
1030     AHCICommand *cmd;
1031     uint8_t px;
1032     size_t bufsize = 4096;
1033     unsigned char *tx = g_malloc(bufsize);
1034     unsigned char *rx = g_malloc0(bufsize);
1035     uint64_t ptr;
1036
1037     ahci = ahci_boot_and_enable(NULL);
1038     px = ahci_port_select(ahci);
1039     ahci_port_clear(ahci, px);
1040
1041     /* create pattern */
1042     generate_pattern(tx, bufsize, AHCI_SECTOR_SIZE);
1043
1044     /* Create a DMA buffer in guest memory, and write our pattern to it. */
1045     ptr = guest_alloc(ahci->parent->alloc, bufsize);
1046     g_assert(ptr);
1047     bufwrite(ptr, tx, bufsize);
1048
1049     cmd = ahci_command_create(CMD_WRITE_DMA);
1050     ahci_command_adjust(cmd, 0, ptr, bufsize, 32);
1051     ahci_command_commit(ahci, cmd, px);
1052     ahci_command_issue(ahci, cmd);
1053     ahci_command_verify(ahci, cmd);
1054     ahci_command_free(cmd);
1055
1056     cmd = ahci_command_create(CMD_READ_DMA);
1057     ahci_command_adjust(cmd, 0, ptr, bufsize, 32);
1058     ahci_command_commit(ahci, cmd, px);
1059     ahci_command_issue(ahci, cmd);
1060     ahci_command_verify(ahci, cmd);
1061     ahci_command_free(cmd);
1062
1063     /* Read back the guest's receive buffer into local memory */
1064     bufread(ptr, rx, bufsize);
1065     guest_free(ahci->parent->alloc, ptr);
1066
1067     g_assert_cmphex(memcmp(tx, rx, bufsize), ==, 0);
1068
1069     ahci_shutdown(ahci);
1070
1071     g_free(rx);
1072     g_free(tx);
1073 }
1074
1075 static void test_flush(void)
1076 {
1077     AHCIQState *ahci;
1078
1079     ahci = ahci_boot_and_enable(NULL);
1080     ahci_test_flush(ahci);
1081     ahci_shutdown(ahci);
1082 }
1083
1084 static void test_flush_retry(void)
1085 {
1086     AHCIQState *ahci;
1087     AHCICommand *cmd;
1088     uint8_t port;
1089     const char *s;
1090
1091     prepare_blkdebug_script(debug_path, "flush_to_disk");
1092     ahci = ahci_boot_and_enable("-drive file=blkdebug:%s:%s,if=none,id=drive0,"
1093                                 "format=%s,cache=writeback,"
1094                                 "rerror=stop,werror=stop "
1095                                 "-M q35 "
1096                                 "-device ide-hd,drive=drive0 ",
1097                                 debug_path,
1098                                 tmp_path, imgfmt);
1099
1100     /* Issue Flush Command and wait for error */
1101     port = ahci_port_select(ahci);
1102     ahci_port_clear(ahci, port);
1103     cmd = ahci_command_create(CMD_FLUSH_CACHE);
1104     ahci_command_commit(ahci, cmd, port);
1105     ahci_command_issue_async(ahci, cmd);
1106     qmp_eventwait("STOP");
1107
1108     /* Complete the command */
1109     s = "{'execute':'cont' }";
1110     qmp_async(s);
1111     qmp_eventwait("RESUME");
1112     ahci_command_wait(ahci, cmd);
1113     ahci_command_verify(ahci, cmd);
1114
1115     ahci_command_free(cmd);
1116     ahci_shutdown(ahci);
1117 }
1118
1119 /**
1120  * Basic sanity test to boot a machine, find an AHCI device, and shutdown.
1121  */
1122 static void test_migrate_sanity(void)
1123 {
1124     AHCIQState *src, *dst;
1125     char *uri = g_strdup_printf("unix:%s", mig_socket);
1126
1127     src = ahci_boot("-m 1024 -M q35 "
1128                     "-drive if=ide,file=%s,format=%s ", tmp_path, imgfmt);
1129     dst = ahci_boot("-m 1024 -M q35 "
1130                     "-drive if=ide,file=%s,format=%s "
1131                     "-incoming %s", tmp_path, imgfmt, uri);
1132
1133     ahci_migrate(src, dst, uri);
1134
1135     ahci_shutdown(src);
1136     ahci_shutdown(dst);
1137     g_free(uri);
1138 }
1139
1140 /**
1141  * Simple migration test: Write a pattern, migrate, then read.
1142  */
1143 static void ahci_migrate_simple(uint8_t cmd_read, uint8_t cmd_write)
1144 {
1145     AHCIQState *src, *dst;
1146     uint8_t px;
1147     size_t bufsize = 4096;
1148     unsigned char *tx = g_malloc(bufsize);
1149     unsigned char *rx = g_malloc0(bufsize);
1150     char *uri = g_strdup_printf("unix:%s", mig_socket);
1151
1152     src = ahci_boot_and_enable("-m 1024 -M q35 "
1153                                "-drive if=ide,format=%s,file=%s ",
1154                                imgfmt, tmp_path);
1155     dst = ahci_boot("-m 1024 -M q35 "
1156                     "-drive if=ide,format=%s,file=%s "
1157                     "-incoming %s", imgfmt, tmp_path, uri);
1158
1159     set_context(src->parent);
1160
1161     /* initialize */
1162     px = ahci_port_select(src);
1163     ahci_port_clear(src, px);
1164
1165     /* create pattern */
1166     generate_pattern(tx, bufsize, AHCI_SECTOR_SIZE);
1167
1168     /* Write, migrate, then read. */
1169     ahci_io(src, px, cmd_write, tx, bufsize, 0);
1170     ahci_migrate(src, dst, uri);
1171     ahci_io(dst, px, cmd_read, rx, bufsize, 0);
1172
1173     /* Verify pattern */
1174     g_assert_cmphex(memcmp(tx, rx, bufsize), ==, 0);
1175
1176     ahci_shutdown(src);
1177     ahci_shutdown(dst);
1178     g_free(rx);
1179     g_free(tx);
1180     g_free(uri);
1181 }
1182
1183 static void test_migrate_dma(void)
1184 {
1185     ahci_migrate_simple(CMD_READ_DMA, CMD_WRITE_DMA);
1186 }
1187
1188 static void test_migrate_ncq(void)
1189 {
1190     ahci_migrate_simple(READ_FPDMA_QUEUED, WRITE_FPDMA_QUEUED);
1191 }
1192
1193 /**
1194  * Halted IO Error Test
1195  *
1196  * Simulate an error on first write, Try to write a pattern,
1197  * Confirm the VM has stopped, resume the VM, verify command
1198  * has completed, then read back the data and verify.
1199  */
1200 static void ahci_halted_io_test(uint8_t cmd_read, uint8_t cmd_write)
1201 {
1202     AHCIQState *ahci;
1203     uint8_t port;
1204     size_t bufsize = 4096;
1205     unsigned char *tx = g_malloc(bufsize);
1206     unsigned char *rx = g_malloc0(bufsize);
1207     uint64_t ptr;
1208     AHCICommand *cmd;
1209
1210     prepare_blkdebug_script(debug_path, "write_aio");
1211
1212     ahci = ahci_boot_and_enable("-drive file=blkdebug:%s:%s,if=none,id=drive0,"
1213                                 "format=%s,cache=writeback,"
1214                                 "rerror=stop,werror=stop "
1215                                 "-M q35 "
1216                                 "-device ide-hd,drive=drive0 ",
1217                                 debug_path,
1218                                 tmp_path, imgfmt);
1219
1220     /* Initialize and prepare */
1221     port = ahci_port_select(ahci);
1222     ahci_port_clear(ahci, port);
1223
1224     /* create DMA source buffer and write pattern */
1225     generate_pattern(tx, bufsize, AHCI_SECTOR_SIZE);
1226     ptr = ahci_alloc(ahci, bufsize);
1227     g_assert(ptr);
1228     memwrite(ptr, tx, bufsize);
1229
1230     /* Attempt to write (and fail) */
1231     cmd = ahci_guest_io_halt(ahci, port, cmd_write,
1232                              ptr, bufsize, 0);
1233
1234     /* Attempt to resume the command */
1235     ahci_guest_io_resume(ahci, cmd);
1236     ahci_free(ahci, ptr);
1237
1238     /* Read back and verify */
1239     ahci_io(ahci, port, cmd_read, rx, bufsize, 0);
1240     g_assert_cmphex(memcmp(tx, rx, bufsize), ==, 0);
1241
1242     /* Cleanup and go home */
1243     ahci_shutdown(ahci);
1244     g_free(rx);
1245     g_free(tx);
1246 }
1247
1248 static void test_halted_dma(void)
1249 {
1250     ahci_halted_io_test(CMD_READ_DMA, CMD_WRITE_DMA);
1251 }
1252
1253 static void test_halted_ncq(void)
1254 {
1255     ahci_halted_io_test(READ_FPDMA_QUEUED, WRITE_FPDMA_QUEUED);
1256 }
1257
1258 /**
1259  * IO Error Migration Test
1260  *
1261  * Simulate an error on first write, Try to write a pattern,
1262  * Confirm the VM has stopped, migrate, resume the VM,
1263  * verify command has completed, then read back the data and verify.
1264  */
1265 static void ahci_migrate_halted_io(uint8_t cmd_read, uint8_t cmd_write)
1266 {
1267     AHCIQState *src, *dst;
1268     uint8_t port;
1269     size_t bufsize = 4096;
1270     unsigned char *tx = g_malloc(bufsize);
1271     unsigned char *rx = g_malloc0(bufsize);
1272     uint64_t ptr;
1273     AHCICommand *cmd;
1274     char *uri = g_strdup_printf("unix:%s", mig_socket);
1275
1276     prepare_blkdebug_script(debug_path, "write_aio");
1277
1278     src = ahci_boot_and_enable("-drive file=blkdebug:%s:%s,if=none,id=drive0,"
1279                                "format=%s,cache=writeback,"
1280                                "rerror=stop,werror=stop "
1281                                "-M q35 "
1282                                "-device ide-hd,drive=drive0 ",
1283                                debug_path,
1284                                tmp_path, imgfmt);
1285
1286     dst = ahci_boot("-drive file=%s,if=none,id=drive0,"
1287                     "format=%s,cache=writeback,"
1288                     "rerror=stop,werror=stop "
1289                     "-M q35 "
1290                     "-device ide-hd,drive=drive0 "
1291                     "-incoming %s",
1292                     tmp_path, imgfmt, uri);
1293
1294     set_context(src->parent);
1295
1296     /* Initialize and prepare */
1297     port = ahci_port_select(src);
1298     ahci_port_clear(src, port);
1299     generate_pattern(tx, bufsize, AHCI_SECTOR_SIZE);
1300
1301     /* create DMA source buffer and write pattern */
1302     ptr = ahci_alloc(src, bufsize);
1303     g_assert(ptr);
1304     memwrite(ptr, tx, bufsize);
1305
1306     /* Write, trigger the VM to stop, migrate, then resume. */
1307     cmd = ahci_guest_io_halt(src, port, cmd_write,
1308                              ptr, bufsize, 0);
1309     ahci_migrate(src, dst, uri);
1310     ahci_guest_io_resume(dst, cmd);
1311     ahci_free(dst, ptr);
1312
1313     /* Read back */
1314     ahci_io(dst, port, cmd_read, rx, bufsize, 0);
1315
1316     /* Verify TX and RX are identical */
1317     g_assert_cmphex(memcmp(tx, rx, bufsize), ==, 0);
1318
1319     /* Cleanup and go home. */
1320     ahci_shutdown(src);
1321     ahci_shutdown(dst);
1322     g_free(rx);
1323     g_free(tx);
1324     g_free(uri);
1325 }
1326
1327 static void test_migrate_halted_dma(void)
1328 {
1329     ahci_migrate_halted_io(CMD_READ_DMA, CMD_WRITE_DMA);
1330 }
1331
1332 static void test_migrate_halted_ncq(void)
1333 {
1334     ahci_migrate_halted_io(READ_FPDMA_QUEUED, WRITE_FPDMA_QUEUED);
1335 }
1336
1337 /**
1338  * Migration test: Try to flush, migrate, then resume.
1339  */
1340 static void test_flush_migrate(void)
1341 {
1342     AHCIQState *src, *dst;
1343     AHCICommand *cmd;
1344     uint8_t px;
1345     const char *s;
1346     char *uri = g_strdup_printf("unix:%s", mig_socket);
1347
1348     prepare_blkdebug_script(debug_path, "flush_to_disk");
1349
1350     src = ahci_boot_and_enable("-drive file=blkdebug:%s:%s,if=none,id=drive0,"
1351                                "cache=writeback,rerror=stop,werror=stop,"
1352                                "format=%s "
1353                                "-M q35 "
1354                                "-device ide-hd,drive=drive0 ",
1355                                debug_path, tmp_path, imgfmt);
1356     dst = ahci_boot("-drive file=%s,if=none,id=drive0,"
1357                     "cache=writeback,rerror=stop,werror=stop,"
1358                     "format=%s "
1359                     "-M q35 "
1360                     "-device ide-hd,drive=drive0 "
1361                     "-incoming %s", tmp_path, imgfmt, uri);
1362
1363     set_context(src->parent);
1364
1365     /* Issue Flush Command */
1366     px = ahci_port_select(src);
1367     ahci_port_clear(src, px);
1368     cmd = ahci_command_create(CMD_FLUSH_CACHE);
1369     ahci_command_commit(src, cmd, px);
1370     ahci_command_issue_async(src, cmd);
1371     qmp_eventwait("STOP");
1372
1373     /* Migrate over */
1374     ahci_migrate(src, dst, uri);
1375
1376     /* Complete the command */
1377     s = "{'execute':'cont' }";
1378     qmp_async(s);
1379     qmp_eventwait("RESUME");
1380     ahci_command_wait(dst, cmd);
1381     ahci_command_verify(dst, cmd);
1382
1383     ahci_command_free(cmd);
1384     ahci_shutdown(src);
1385     ahci_shutdown(dst);
1386     g_free(uri);
1387 }
1388
1389 static void test_max(void)
1390 {
1391     AHCIQState *ahci;
1392
1393     ahci = ahci_boot_and_enable(NULL);
1394     ahci_test_max(ahci);
1395     ahci_shutdown(ahci);
1396 }
1397
1398 static void test_reset(void)
1399 {
1400     AHCIQState *ahci;
1401     int i;
1402
1403     ahci = ahci_boot(NULL);
1404     ahci_test_pci_spec(ahci);
1405     ahci_pci_enable(ahci);
1406
1407     for (i = 0; i < 2; i++) {
1408         ahci_test_hba_spec(ahci);
1409         ahci_hba_enable(ahci);
1410         ahci_test_identify(ahci);
1411         ahci_test_io_rw_simple(ahci, 4096, 0,
1412                                CMD_READ_DMA_EXT,
1413                                CMD_WRITE_DMA_EXT);
1414         ahci_set(ahci, AHCI_GHC, AHCI_GHC_HR);
1415         ahci_clean_mem(ahci);
1416     }
1417
1418     ahci_shutdown(ahci);
1419 }
1420
1421 static void test_ncq_simple(void)
1422 {
1423     AHCIQState *ahci;
1424
1425     ahci = ahci_boot_and_enable(NULL);
1426     ahci_test_io_rw_simple(ahci, 4096, 0,
1427                            READ_FPDMA_QUEUED,
1428                            WRITE_FPDMA_QUEUED);
1429     ahci_shutdown(ahci);
1430 }
1431
1432 /******************************************************************************/
1433 /* AHCI I/O Test Matrix Definitions                                           */
1434
1435 enum BuffLen {
1436     LEN_BEGIN = 0,
1437     LEN_SIMPLE = LEN_BEGIN,
1438     LEN_DOUBLE,
1439     LEN_LONG,
1440     LEN_SHORT,
1441     NUM_LENGTHS
1442 };
1443
1444 static const char *buff_len_str[NUM_LENGTHS] = { "simple", "double",
1445                                                  "long", "short" };
1446
1447 enum AddrMode {
1448     ADDR_MODE_BEGIN = 0,
1449     ADDR_MODE_LBA28 = ADDR_MODE_BEGIN,
1450     ADDR_MODE_LBA48,
1451     NUM_ADDR_MODES
1452 };
1453
1454 static const char *addr_mode_str[NUM_ADDR_MODES] = { "lba28", "lba48" };
1455
1456 enum IOMode {
1457     MODE_BEGIN = 0,
1458     MODE_PIO = MODE_BEGIN,
1459     MODE_DMA,
1460     NUM_MODES
1461 };
1462
1463 static const char *io_mode_str[NUM_MODES] = { "pio", "dma" };
1464
1465 enum IOOps {
1466     IO_BEGIN = 0,
1467     IO_READ = IO_BEGIN,
1468     IO_WRITE,
1469     NUM_IO_OPS
1470 };
1471
1472 enum OffsetType {
1473     OFFSET_BEGIN = 0,
1474     OFFSET_ZERO = OFFSET_BEGIN,
1475     OFFSET_LOW,
1476     OFFSET_HIGH,
1477     NUM_OFFSETS
1478 };
1479
1480 static const char *offset_str[NUM_OFFSETS] = { "zero", "low", "high" };
1481
1482 typedef struct AHCIIOTestOptions {
1483     enum BuffLen length;
1484     enum AddrMode address_type;
1485     enum IOMode io_type;
1486     enum OffsetType offset;
1487 } AHCIIOTestOptions;
1488
1489 static uint64_t offset_sector(enum OffsetType ofst,
1490                               enum AddrMode addr_type,
1491                               uint64_t buffsize)
1492 {
1493     uint64_t ceil;
1494     uint64_t nsectors;
1495
1496     switch (ofst) {
1497     case OFFSET_ZERO:
1498         return 0;
1499     case OFFSET_LOW:
1500         return 1;
1501     case OFFSET_HIGH:
1502         ceil = (addr_type == ADDR_MODE_LBA28) ? 0xfffffff : 0xffffffffffff;
1503         ceil = MIN(ceil, mb_to_sectors(test_image_size_mb) - 1);
1504         nsectors = buffsize / AHCI_SECTOR_SIZE;
1505         return ceil - nsectors + 1;
1506     default:
1507         g_assert_not_reached();
1508     }
1509 }
1510
1511 /**
1512  * Table of possible I/O ATA commands given a set of enumerations.
1513  */
1514 static const uint8_t io_cmds[NUM_MODES][NUM_ADDR_MODES][NUM_IO_OPS] = {
1515     [MODE_PIO] = {
1516         [ADDR_MODE_LBA28] = {
1517             [IO_READ] = CMD_READ_PIO,
1518             [IO_WRITE] = CMD_WRITE_PIO },
1519         [ADDR_MODE_LBA48] = {
1520             [IO_READ] = CMD_READ_PIO_EXT,
1521             [IO_WRITE] = CMD_WRITE_PIO_EXT }
1522     },
1523     [MODE_DMA] = {
1524         [ADDR_MODE_LBA28] = {
1525             [IO_READ] = CMD_READ_DMA,
1526             [IO_WRITE] = CMD_WRITE_DMA },
1527         [ADDR_MODE_LBA48] = {
1528             [IO_READ] = CMD_READ_DMA_EXT,
1529             [IO_WRITE] = CMD_WRITE_DMA_EXT }
1530     }
1531 };
1532
1533 /**
1534  * Test a Read/Write pattern using various commands, addressing modes,
1535  * transfer modes, and buffer sizes.
1536  */
1537 static void test_io_rw_interface(enum AddrMode lba48, enum IOMode dma,
1538                                  unsigned bufsize, uint64_t sector)
1539 {
1540     AHCIQState *ahci;
1541
1542     ahci = ahci_boot_and_enable(NULL);
1543     ahci_test_io_rw_simple(ahci, bufsize, sector,
1544                            io_cmds[dma][lba48][IO_READ],
1545                            io_cmds[dma][lba48][IO_WRITE]);
1546     ahci_shutdown(ahci);
1547 }
1548
1549 /**
1550  * Demultiplex the test data and invoke the actual test routine.
1551  */
1552 static void test_io_interface(gconstpointer opaque)
1553 {
1554     AHCIIOTestOptions *opts = (AHCIIOTestOptions *)opaque;
1555     unsigned bufsize;
1556     uint64_t sector;
1557
1558     switch (opts->length) {
1559     case LEN_SIMPLE:
1560         bufsize = 4096;
1561         break;
1562     case LEN_DOUBLE:
1563         bufsize = 8192;
1564         break;
1565     case LEN_LONG:
1566         bufsize = 4096 * 64;
1567         break;
1568     case LEN_SHORT:
1569         bufsize = 512;
1570         break;
1571     default:
1572         g_assert_not_reached();
1573     }
1574
1575     sector = offset_sector(opts->offset, opts->address_type, bufsize);
1576     test_io_rw_interface(opts->address_type, opts->io_type, bufsize, sector);
1577     g_free(opts);
1578     return;
1579 }
1580
1581 static void create_ahci_io_test(enum IOMode type, enum AddrMode addr,
1582                                 enum BuffLen len, enum OffsetType offset)
1583 {
1584     char *name;
1585     AHCIIOTestOptions *opts;
1586
1587     opts = g_malloc(sizeof(AHCIIOTestOptions));
1588     opts->length = len;
1589     opts->address_type = addr;
1590     opts->io_type = type;
1591     opts->offset = offset;
1592
1593     name = g_strdup_printf("ahci/io/%s/%s/%s/%s",
1594                            io_mode_str[type],
1595                            addr_mode_str[addr],
1596                            buff_len_str[len],
1597                            offset_str[offset]);
1598
1599     if ((addr == ADDR_MODE_LBA48) && (offset == OFFSET_HIGH) &&
1600         (mb_to_sectors(test_image_size_mb) <= 0xFFFFFFF)) {
1601         g_test_message("%s: skipped; test image too small", name);
1602         g_free(name);
1603         return;
1604     }
1605
1606     qtest_add_data_func(name, opts, test_io_interface);
1607     g_free(name);
1608 }
1609
1610 /******************************************************************************/
1611
1612 int main(int argc, char **argv)
1613 {
1614     const char *arch;
1615     int ret;
1616     int fd;
1617     int c;
1618     int i, j, k, m;
1619
1620     static struct option long_options[] = {
1621         {"pedantic", no_argument, 0, 'p' },
1622         {0, 0, 0, 0},
1623     };
1624
1625     /* Should be first to utilize g_test functionality, So we can see errors. */
1626     g_test_init(&argc, &argv, NULL);
1627
1628     while (1) {
1629         c = getopt_long(argc, argv, "", long_options, NULL);
1630         if (c == -1) {
1631             break;
1632         }
1633         switch (c) {
1634         case -1:
1635             break;
1636         case 'p':
1637             ahci_pedantic = 1;
1638             break;
1639         default:
1640             fprintf(stderr, "Unrecognized ahci_test option.\n");
1641             g_assert_not_reached();
1642         }
1643     }
1644
1645     /* Check architecture */
1646     arch = qtest_get_arch();
1647     if (strcmp(arch, "i386") && strcmp(arch, "x86_64")) {
1648         g_test_message("Skipping test for non-x86");
1649         return 0;
1650     }
1651
1652     /* Create a temporary image */
1653     fd = mkstemp(tmp_path);
1654     g_assert(fd >= 0);
1655     if (have_qemu_img()) {
1656         imgfmt = "qcow2";
1657         test_image_size_mb = TEST_IMAGE_SIZE_MB_LARGE;
1658         mkqcow2(tmp_path, TEST_IMAGE_SIZE_MB_LARGE);
1659     } else {
1660         g_test_message("QTEST_QEMU_IMG not set or qemu-img missing; "
1661                        "skipping LBA48 high-sector tests");
1662         imgfmt = "raw";
1663         test_image_size_mb = TEST_IMAGE_SIZE_MB_SMALL;
1664         ret = ftruncate(fd, test_image_size_mb * 1024 * 1024);
1665         g_assert(ret == 0);
1666     }
1667     close(fd);
1668
1669     /* Create temporary blkdebug instructions */
1670     fd = mkstemp(debug_path);
1671     g_assert(fd >= 0);
1672     close(fd);
1673
1674     /* Reserve a hollow file to use as a socket for migration tests */
1675     fd = mkstemp(mig_socket);
1676     g_assert(fd >= 0);
1677     close(fd);
1678
1679     /* Run the tests */
1680     qtest_add_func("/ahci/sanity",     test_sanity);
1681     qtest_add_func("/ahci/pci_spec",   test_pci_spec);
1682     qtest_add_func("/ahci/pci_enable", test_pci_enable);
1683     qtest_add_func("/ahci/hba_spec",   test_hba_spec);
1684     qtest_add_func("/ahci/hba_enable", test_hba_enable);
1685     qtest_add_func("/ahci/identify",   test_identify);
1686
1687     for (i = MODE_BEGIN; i < NUM_MODES; i++) {
1688         for (j = ADDR_MODE_BEGIN; j < NUM_ADDR_MODES; j++) {
1689             for (k = LEN_BEGIN; k < NUM_LENGTHS; k++) {
1690                 for (m = OFFSET_BEGIN; m < NUM_OFFSETS; m++) {
1691                     create_ahci_io_test(i, j, k, m);
1692                 }
1693             }
1694         }
1695     }
1696
1697     qtest_add_func("/ahci/io/dma/lba28/fragmented", test_dma_fragmented);
1698
1699     qtest_add_func("/ahci/flush/simple", test_flush);
1700     qtest_add_func("/ahci/flush/retry", test_flush_retry);
1701     qtest_add_func("/ahci/flush/migrate", test_flush_migrate);
1702
1703     qtest_add_func("/ahci/migrate/sanity", test_migrate_sanity);
1704     qtest_add_func("/ahci/migrate/dma/simple", test_migrate_dma);
1705     qtest_add_func("/ahci/io/dma/lba28/retry", test_halted_dma);
1706     qtest_add_func("/ahci/migrate/dma/halted", test_migrate_halted_dma);
1707
1708     qtest_add_func("/ahci/max", test_max);
1709     qtest_add_func("/ahci/reset", test_reset);
1710
1711     qtest_add_func("/ahci/io/ncq/simple", test_ncq_simple);
1712     qtest_add_func("/ahci/migrate/ncq/simple", test_migrate_ncq);
1713     qtest_add_func("/ahci/io/ncq/retry", test_halted_ncq);
1714     qtest_add_func("/ahci/migrate/ncq/halted", test_migrate_halted_ncq);
1715
1716     ret = g_test_run();
1717
1718     /* Cleanup */
1719     unlink(tmp_path);
1720     unlink(debug_path);
1721     unlink(mig_socket);
1722
1723     return ret;
1724 }