Archipelago » qemu

/*

 * Copyright (C) 2010 Red Hat, Inc.

 *

 * written by Yaniv Kamay, Izik Eidus, Gerd Hoffmann

 * maintained by Gerd Hoffmann <kraxel@redhat.com>

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License as

 * published by the Free Software Foundation; either version 2 or

 * (at your option) version 3 of the License.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, see <http://www.gnu.org/licenses/>.

 */

#include <zlib.h>

#include "qemu-common.h"

#include "qemu-timer.h"

#include "qemu-queue.h"

#include "monitor.h"

#include "sysemu.h"

#include "trace.h"

#include "qxl.h"

#ifndef CONFIG_QXL_IO_MONITORS_CONFIG_ASYNC

/* spice-protocol is too old, add missing definitions */

#define QXL_IO_MONITORS_CONFIG_ASYNC (QXL_IO_FLUSH_RELEASE + 1)

#endif

/*

 * NOTE: SPICE_RING_PROD_ITEM accesses memory on the pci bar and as

 * such can be changed by the guest, so to avoid a guest trigerrable

 * abort we just qxl_set_guest_bug and set the return to NULL. Still

 * it may happen as a result of emulator bug as well.

 */

#undef SPICE_RING_PROD_ITEM

#define SPICE_RING_PROD_ITEM(qxl, r, ret) {                             \

        typeof(r) start = r;                                            \

        typeof(r) end = r + 1;                                          \

        uint32_t prod = (r)->prod & SPICE_RING_INDEX_MASK(r);           \

        typeof(&(r)->items[prod]) m_item = &(r)->items[prod];           \

        if (!((uint8_t*)m_item >= (uint8_t*)(start) && (uint8_t*)(m_item + 1) <= (uint8_t*)(end))) { \

            qxl_set_guest_bug(qxl, "SPICE_RING_PROD_ITEM indices mismatch " \

                          "! %p <= %p < %p", (uint8_t *)start,          \

                          (uint8_t *)m_item, (uint8_t *)end);           \

            ret = NULL;                                                 \

        } else {                                                        \

            ret = &m_item->el;                                          \

        }                                                               \

    }

#undef SPICE_RING_CONS_ITEM

#define SPICE_RING_CONS_ITEM(qxl, r, ret) {                             \

        typeof(r) start = r;                                            \

        typeof(r) end = r + 1;                                          \

        uint32_t cons = (r)->cons & SPICE_RING_INDEX_MASK(r);           \

        typeof(&(r)->items[cons]) m_item = &(r)->items[cons];           \

        if (!((uint8_t*)m_item >= (uint8_t*)(start) && (uint8_t*)(m_item + 1) <= (uint8_t*)(end))) { \

            qxl_set_guest_bug(qxl, "SPICE_RING_CONS_ITEM indices mismatch " \

                          "! %p <= %p < %p", (uint8_t *)start,          \

                          (uint8_t *)m_item, (uint8_t *)end);           \

            ret = NULL;                                                 \

        } else {                                                        \

            ret = &m_item->el;                                          \

        }                                                               \

    }

#undef ALIGN

#define ALIGN(a, b) (((a) + ((b) - 1)) & ~((b) - 1))

#define PIXEL_SIZE 0.2936875 //1280x1024 is 14.8" x 11.9" 

#define QXL_MODE(_x, _y, _b, _o)                  \

    {   .x_res = _x,                              \

        .y_res = _y,                              \

        .bits  = _b,                              \

        .stride = (_x) * (_b) / 8,                \

        .x_mili = PIXEL_SIZE * (_x),              \

        .y_mili = PIXEL_SIZE * (_y),              \

        .orientation = _o,                        \

    }

#define QXL_MODE_16_32(x_res, y_res, orientation) \

    QXL_MODE(x_res, y_res, 16, orientation),      \

    QXL_MODE(x_res, y_res, 32, orientation)

#define QXL_MODE_EX(x_res, y_res)                 \

    QXL_MODE_16_32(x_res, y_res, 0),              \

    QXL_MODE_16_32(y_res, x_res, 1),              \

    QXL_MODE_16_32(x_res, y_res, 2),              \

    QXL_MODE_16_32(y_res, x_res, 3)

static QXLMode qxl_modes[] = {

    QXL_MODE_EX(640, 480),

    QXL_MODE_EX(800, 480),

    QXL_MODE_EX(800, 600),

    QXL_MODE_EX(832, 624),

    QXL_MODE_EX(960, 640),

    QXL_MODE_EX(1024, 600),

    QXL_MODE_EX(1024, 768),

    QXL_MODE_EX(1152, 864),

    QXL_MODE_EX(1152, 870),

    QXL_MODE_EX(1280, 720),

    QXL_MODE_EX(1280, 760),

    QXL_MODE_EX(1280, 768),

    QXL_MODE_EX(1280, 800),

    QXL_MODE_EX(1280, 960),

    QXL_MODE_EX(1280, 1024),

    QXL_MODE_EX(1360, 768),

    QXL_MODE_EX(1366, 768),

    QXL_MODE_EX(1400, 1050),

    QXL_MODE_EX(1440, 900),

    QXL_MODE_EX(1600, 900),

    QXL_MODE_EX(1600, 1200),

    QXL_MODE_EX(1680, 1050),

    QXL_MODE_EX(1920, 1080),

    /* these modes need more than 8 MB video memory */

    QXL_MODE_EX(1920, 1200),

    QXL_MODE_EX(1920, 1440),

    QXL_MODE_EX(2048, 1536),

    QXL_MODE_EX(2560, 1440),

    QXL_MODE_EX(2560, 1600),

    /* these modes need more than 16 MB video memory */

    QXL_MODE_EX(2560, 2048),

    QXL_MODE_EX(2800, 2100),

    QXL_MODE_EX(3200, 2400),

};

static PCIQXLDevice *qxl0;

static void qxl_send_events(PCIQXLDevice *d, uint32_t events);

static int qxl_destroy_primary(PCIQXLDevice *d, qxl_async_io async);

static void qxl_reset_memslots(PCIQXLDevice *d);

static void qxl_reset_surfaces(PCIQXLDevice *d);

static void qxl_ring_set_dirty(PCIQXLDevice *qxl);

void qxl_set_guest_bug(PCIQXLDevice *qxl, const char *msg, ...)

{

    trace_qxl_set_guest_bug(qxl->id);

    qxl_send_events(qxl, QXL_INTERRUPT_ERROR);

    qxl->guest_bug = 1;

    if (qxl->guestdebug) {

        va_list ap;

        va_start(ap, msg);

        fprintf(stderr, "qxl-%d: guest bug: ", qxl->id);

        vfprintf(stderr, msg, ap);

        fprintf(stderr, "\n");

        va_end(ap);

    }

}

static void qxl_clear_guest_bug(PCIQXLDevice *qxl)

{

    qxl->guest_bug = 0;

}

void qxl_spice_update_area(PCIQXLDevice *qxl, uint32_t surface_id,

                           struct QXLRect *area, struct QXLRect *dirty_rects,

                           uint32_t num_dirty_rects,

                           uint32_t clear_dirty_region,

                           qxl_async_io async, struct QXLCookie *cookie)

{

    trace_qxl_spice_update_area(qxl->id, surface_id, area->left, area->right,

                                area->top, area->bottom);

    trace_qxl_spice_update_area_rest(qxl->id, num_dirty_rects,

                                     clear_dirty_region);

    if (async == QXL_SYNC) {

        qxl->ssd.worker->update_area(qxl->ssd.worker, surface_id, area,

                        dirty_rects, num_dirty_rects, clear_dirty_region);

    } else {

        assert(cookie != NULL);

        spice_qxl_update_area_async(&qxl->ssd.qxl, surface_id, area,

                                    clear_dirty_region, (uintptr_t)cookie);

    }

}

static void qxl_spice_destroy_surface_wait_complete(PCIQXLDevice *qxl,

                                                    uint32_t id)

{

    trace_qxl_spice_destroy_surface_wait_complete(qxl->id, id);

    qemu_mutex_lock(&qxl->track_lock);

    qxl->guest_surfaces.cmds[id] = 0;

    qxl->guest_surfaces.count--;

    qemu_mutex_unlock(&qxl->track_lock);

}

static void qxl_spice_destroy_surface_wait(PCIQXLDevice *qxl, uint32_t id,

                                           qxl_async_io async)

{

    QXLCookie *cookie;

    trace_qxl_spice_destroy_surface_wait(qxl->id, id, async);

    if (async) {

        cookie = qxl_cookie_new(QXL_COOKIE_TYPE_IO,

                                QXL_IO_DESTROY_SURFACE_ASYNC);

        cookie->u.surface_id = id;

        spice_qxl_destroy_surface_async(&qxl->ssd.qxl, id, (uintptr_t)cookie);

    } else {

        qxl->ssd.worker->destroy_surface_wait(qxl->ssd.worker, id);

        qxl_spice_destroy_surface_wait_complete(qxl, id);

    }

}

static void qxl_spice_flush_surfaces_async(PCIQXLDevice *qxl)

{

    trace_qxl_spice_flush_surfaces_async(qxl->id, qxl->guest_surfaces.count,

                                         qxl->num_free_res);

    spice_qxl_flush_surfaces_async(&qxl->ssd.qxl,

        (uintptr_t)qxl_cookie_new(QXL_COOKIE_TYPE_IO,

                                  QXL_IO_FLUSH_SURFACES_ASYNC));

}

void qxl_spice_loadvm_commands(PCIQXLDevice *qxl, struct QXLCommandExt *ext,

                               uint32_t count)

{

    trace_qxl_spice_loadvm_commands(qxl->id, ext, count);

    qxl->ssd.worker->loadvm_commands(qxl->ssd.worker, ext, count);

}

void qxl_spice_oom(PCIQXLDevice *qxl)

{

    trace_qxl_spice_oom(qxl->id);

    qxl->ssd.worker->oom(qxl->ssd.worker);

}

void qxl_spice_reset_memslots(PCIQXLDevice *qxl)

{

    trace_qxl_spice_reset_memslots(qxl->id);

    qxl->ssd.worker->reset_memslots(qxl->ssd.worker);

}

static void qxl_spice_destroy_surfaces_complete(PCIQXLDevice *qxl)

{

    trace_qxl_spice_destroy_surfaces_complete(qxl->id);

    qemu_mutex_lock(&qxl->track_lock);

    memset(qxl->guest_surfaces.cmds, 0,

           sizeof(qxl->guest_surfaces.cmds) * qxl->ssd.num_surfaces);

    qxl->guest_surfaces.count = 0;

    qemu_mutex_unlock(&qxl->track_lock);

}

static void qxl_spice_destroy_surfaces(PCIQXLDevice *qxl, qxl_async_io async)

{

    trace_qxl_spice_destroy_surfaces(qxl->id, async);

    if (async) {

        spice_qxl_destroy_surfaces_async(&qxl->ssd.qxl,

                (uintptr_t)qxl_cookie_new(QXL_COOKIE_TYPE_IO,

                                          QXL_IO_DESTROY_ALL_SURFACES_ASYNC));

    } else {

        qxl->ssd.worker->destroy_surfaces(qxl->ssd.worker);

        qxl_spice_destroy_surfaces_complete(qxl);

    }

}

static void qxl_spice_monitors_config_async(PCIQXLDevice *qxl, int replay)

{

    trace_qxl_spice_monitors_config(qxl->id);

/* 0x000b01 == 0.11.1 */

#if SPICE_SERVER_VERSION >= 0x000b01 && \

    defined(CONFIG_QXL_IO_MONITORS_CONFIG_ASYNC)

    if (replay) {

        /*

         * don't use QXL_COOKIE_TYPE_IO:

         *  - we are not running yet (post_load), we will assert

         *    in send_events

         *  - this is not a guest io, but a reply, so async_io isn't set.

         */

        spice_qxl_monitors_config_async(&qxl->ssd.qxl,

                qxl->guest_monitors_config,

                MEMSLOT_GROUP_GUEST,

                (uintptr_t)qxl_cookie_new(

                    QXL_COOKIE_TYPE_POST_LOAD_MONITORS_CONFIG,

                    0));

    } else {

        qxl->guest_monitors_config = qxl->ram->monitors_config;

        spice_qxl_monitors_config_async(&qxl->ssd.qxl,

                qxl->ram->monitors_config,

                MEMSLOT_GROUP_GUEST,

                (uintptr_t)qxl_cookie_new(QXL_COOKIE_TYPE_IO,

                                          QXL_IO_MONITORS_CONFIG_ASYNC));

    }

#else

    fprintf(stderr, "qxl: too old spice-protocol/spice-server for "

            "QXL_IO_MONITORS_CONFIG_ASYNC\n");

#endif

}

void qxl_spice_reset_image_cache(PCIQXLDevice *qxl)

{

    trace_qxl_spice_reset_image_cache(qxl->id);

    qxl->ssd.worker->reset_image_cache(qxl->ssd.worker);

}

void qxl_spice_reset_cursor(PCIQXLDevice *qxl)

{

    trace_qxl_spice_reset_cursor(qxl->id);

    qxl->ssd.worker->reset_cursor(qxl->ssd.worker);

    qemu_mutex_lock(&qxl->track_lock);

    qxl->guest_cursor = 0;

    qemu_mutex_unlock(&qxl->track_lock);

}

static inline uint32_t msb_mask(uint32_t val)

{

    uint32_t mask;

    do {

        mask = ~(val - 1) & val;

        val &= ~mask;

    } while (mask < val);

    return mask;

}

static ram_addr_t qxl_rom_size(void)

{

    uint32_t rom_size = sizeof(QXLRom) + sizeof(QXLModes) + sizeof(qxl_modes);

    rom_size = MAX(rom_size, TARGET_PAGE_SIZE);

    rom_size = msb_mask(rom_size * 2 - 1);

    return rom_size;

}

static void init_qxl_rom(PCIQXLDevice *d)

{

    QXLRom *rom = memory_region_get_ram_ptr(&d->rom_bar);

    QXLModes *modes = (QXLModes *)(rom + 1);

    uint32_t ram_header_size;

    uint32_t surface0_area_size;

    uint32_t num_pages;

    uint32_t fb;

    int i, n;

    memset(rom, 0, d->rom_size);

    rom->magic         = cpu_to_le32(QXL_ROM_MAGIC);

    rom->id            = cpu_to_le32(d->id);

    rom->log_level     = cpu_to_le32(d->guestdebug);

    rom->modes_offset  = cpu_to_le32(sizeof(QXLRom));

    rom->slot_gen_bits = MEMSLOT_GENERATION_BITS;

    rom->slot_id_bits  = MEMSLOT_SLOT_BITS;

    rom->slots_start   = 1;

    rom->slots_end     = NUM_MEMSLOTS - 1;

    rom->n_surfaces    = cpu_to_le32(d->ssd.num_surfaces);

    for (i = 0, n = 0; i < ARRAY_SIZE(qxl_modes); i++) {

        fb = qxl_modes[i].y_res * qxl_modes[i].stride;

        if (fb > d->vgamem_size) {

            continue;

        }

        modes->modes[n].id          = cpu_to_le32(i);

        modes->modes[n].x_res       = cpu_to_le32(qxl_modes[i].x_res);

        modes->modes[n].y_res       = cpu_to_le32(qxl_modes[i].y_res);

        modes->modes[n].bits        = cpu_to_le32(qxl_modes[i].bits);

        modes->modes[n].stride      = cpu_to_le32(qxl_modes[i].stride);

        modes->modes[n].x_mili      = cpu_to_le32(qxl_modes[i].x_mili);

        modes->modes[n].y_mili      = cpu_to_le32(qxl_modes[i].y_mili);

        modes->modes[n].orientation = cpu_to_le32(qxl_modes[i].orientation);

        n++;

    }

    modes->n_modes     = cpu_to_le32(n);

    ram_header_size    = ALIGN(sizeof(QXLRam), 4096);

    surface0_area_size = ALIGN(d->vgamem_size, 4096);

    num_pages          = d->vga.vram_size;

    num_pages         -= ram_header_size;

    num_pages         -= surface0_area_size;

    num_pages          = num_pages / TARGET_PAGE_SIZE;

    rom->draw_area_offset   = cpu_to_le32(0);

    rom->surface0_area_size = cpu_to_le32(surface0_area_size);

    rom->pages_offset       = cpu_to_le32(surface0_area_size);

    rom->num_pages          = cpu_to_le32(num_pages);

    rom->ram_header_offset  = cpu_to_le32(d->vga.vram_size - ram_header_size);

    d->shadow_rom = *rom;

    d->rom        = rom;

    d->modes      = modes;

}

static void init_qxl_ram(PCIQXLDevice *d)

{

    uint8_t *buf;

    uint64_t *item;

    buf = d->vga.vram_ptr;

    d->ram = (QXLRam *)(buf + le32_to_cpu(d->shadow_rom.ram_header_offset));

    d->ram->magic       = cpu_to_le32(QXL_RAM_MAGIC);

    d->ram->int_pending = cpu_to_le32(0);

    d->ram->int_mask    = cpu_to_le32(0);

    d->ram->update_surface = 0;

    SPICE_RING_INIT(&d->ram->cmd_ring);

    SPICE_RING_INIT(&d->ram->cursor_ring);

    SPICE_RING_INIT(&d->ram->release_ring);

    SPICE_RING_PROD_ITEM(d, &d->ram->release_ring, item);

    assert(item);

    *item = 0;

    qxl_ring_set_dirty(d);

}

/* can be called from spice server thread context */

static void qxl_set_dirty(MemoryRegion *mr, ram_addr_t addr, ram_addr_t end)

{

    memory_region_set_dirty(mr, addr, end - addr);

}

static void qxl_rom_set_dirty(PCIQXLDevice *qxl)

{

    qxl_set_dirty(&qxl->rom_bar, 0, qxl->rom_size);

}

/* called from spice server thread context only */

static void qxl_ram_set_dirty(PCIQXLDevice *qxl, void *ptr)

{

    void *base = qxl->vga.vram_ptr;

    intptr_t offset;

    offset = ptr - base;

    offset &= ~(TARGET_PAGE_SIZE-1);

    assert(offset < qxl->vga.vram_size);

    qxl_set_dirty(&qxl->vga.vram, offset, offset + TARGET_PAGE_SIZE);

}

/* can be called from spice server thread context */

static void qxl_ring_set_dirty(PCIQXLDevice *qxl)

{

    ram_addr_t addr = qxl->shadow_rom.ram_header_offset;

    ram_addr_t end  = qxl->vga.vram_size;

    qxl_set_dirty(&qxl->vga.vram, addr, end);

}

/*

 * keep track of some command state, for savevm/loadvm.

 * called from spice server thread context only

 */

static int qxl_track_command(PCIQXLDevice *qxl, struct QXLCommandExt *ext)

{

    switch (le32_to_cpu(ext->cmd.type)) {

    case QXL_CMD_SURFACE:

    {

        QXLSurfaceCmd *cmd = qxl_phys2virt(qxl, ext->cmd.data, ext->group_id);

        if (!cmd) {

            return 1;

        }

        uint32_t id = le32_to_cpu(cmd->surface_id);

        if (id >= qxl->ssd.num_surfaces) {

            qxl_set_guest_bug(qxl, "QXL_CMD_SURFACE id %d >= %d", id,

                              qxl->ssd.num_surfaces);

            return 1;

        }

        qemu_mutex_lock(&qxl->track_lock);

        if (cmd->type == QXL_SURFACE_CMD_CREATE) {

            qxl->guest_surfaces.cmds[id] = ext->cmd.data;

            qxl->guest_surfaces.count++;

            if (qxl->guest_surfaces.max < qxl->guest_surfaces.count)

                qxl->guest_surfaces.max = qxl->guest_surfaces.count;

        }

        if (cmd->type == QXL_SURFACE_CMD_DESTROY) {

            qxl->guest_surfaces.cmds[id] = 0;

            qxl->guest_surfaces.count--;

        }

        qemu_mutex_unlock(&qxl->track_lock);

        break;

    }

    case QXL_CMD_CURSOR:

    {

        QXLCursorCmd *cmd = qxl_phys2virt(qxl, ext->cmd.data, ext->group_id);

        if (!cmd) {

            return 1;

        }

        if (cmd->type == QXL_CURSOR_SET) {

            qemu_mutex_lock(&qxl->track_lock);

            qxl->guest_cursor = ext->cmd.data;

            qemu_mutex_unlock(&qxl->track_lock);

        }

        break;

    }

    }

    return 0;

}

/* spice display interface callbacks */

static void interface_attach_worker(QXLInstance *sin, QXLWorker *qxl_worker)

{

    PCIQXLDevice *qxl = container_of(sin, PCIQXLDevice, ssd.qxl);

    trace_qxl_interface_attach_worker(qxl->id);

    qxl->ssd.worker = qxl_worker;

}

static void interface_set_compression_level(QXLInstance *sin, int level)

{

    PCIQXLDevice *qxl = container_of(sin, PCIQXLDevice, ssd.qxl);

    trace_qxl_interface_set_compression_level(qxl->id, level);

    qxl->shadow_rom.compression_level = cpu_to_le32(level);

    qxl->rom->compression_level = cpu_to_le32(level);

    qxl_rom_set_dirty(qxl);

}

static void interface_set_mm_time(QXLInstance *sin, uint32_t mm_time)

{

    PCIQXLDevice *qxl = container_of(sin, PCIQXLDevice, ssd.qxl);

    trace_qxl_interface_set_mm_time(qxl->id, mm_time);

    qxl->shadow_rom.mm_clock = cpu_to_le32(mm_time);

    qxl->rom->mm_clock = cpu_to_le32(mm_time);

    qxl_rom_set_dirty(qxl);

}

static void interface_get_init_info(QXLInstance *sin, QXLDevInitInfo *info)

{

    PCIQXLDevice *qxl = container_of(sin, PCIQXLDevice, ssd.qxl);

    trace_qxl_interface_get_init_info(qxl->id);

    info->memslot_gen_bits = MEMSLOT_GENERATION_BITS;

    info->memslot_id_bits = MEMSLOT_SLOT_BITS;

    info->num_memslots = NUM_MEMSLOTS;

    info->num_memslots_groups = NUM_MEMSLOTS_GROUPS;

    info->internal_groupslot_id = 0;

    info->qxl_ram_size = le32_to_cpu(qxl->shadow_rom.num_pages) << TARGET_PAGE_BITS;

    info->n_surfaces = qxl->ssd.num_surfaces;

}

static const char *qxl_mode_to_string(int mode)

{

    switch (mode) {

    case QXL_MODE_COMPAT:

        return "compat";

    case QXL_MODE_NATIVE:

        return "native";

    case QXL_MODE_UNDEFINED:

        return "undefined";

    case QXL_MODE_VGA:

        return "vga";

    }

    return "INVALID";

}

static const char *io_port_to_string(uint32_t io_port)

{

    if (io_port >= QXL_IO_RANGE_SIZE) {

        return "out of range";

    }

    static const char *io_port_to_string[QXL_IO_RANGE_SIZE + 1] = {

        [QXL_IO_NOTIFY_CMD]             = "QXL_IO_NOTIFY_CMD",

        [QXL_IO_NOTIFY_CURSOR]          = "QXL_IO_NOTIFY_CURSOR",

        [QXL_IO_UPDATE_AREA]            = "QXL_IO_UPDATE_AREA",

        [QXL_IO_UPDATE_IRQ]             = "QXL_IO_UPDATE_IRQ",

        [QXL_IO_NOTIFY_OOM]             = "QXL_IO_NOTIFY_OOM",

        [QXL_IO_RESET]                  = "QXL_IO_RESET",

        [QXL_IO_SET_MODE]               = "QXL_IO_SET_MODE",

        [QXL_IO_LOG]                    = "QXL_IO_LOG",

        [QXL_IO_MEMSLOT_ADD]            = "QXL_IO_MEMSLOT_ADD",

        [QXL_IO_MEMSLOT_DEL]            = "QXL_IO_MEMSLOT_DEL",

        [QXL_IO_DETACH_PRIMARY]         = "QXL_IO_DETACH_PRIMARY",

        [QXL_IO_ATTACH_PRIMARY]         = "QXL_IO_ATTACH_PRIMARY",

        [QXL_IO_CREATE_PRIMARY]         = "QXL_IO_CREATE_PRIMARY",

        [QXL_IO_DESTROY_PRIMARY]        = "QXL_IO_DESTROY_PRIMARY",

        [QXL_IO_DESTROY_SURFACE_WAIT]   = "QXL_IO_DESTROY_SURFACE_WAIT",

        [QXL_IO_DESTROY_ALL_SURFACES]   = "QXL_IO_DESTROY_ALL_SURFACES",

        [QXL_IO_UPDATE_AREA_ASYNC]      = "QXL_IO_UPDATE_AREA_ASYNC",

        [QXL_IO_MEMSLOT_ADD_ASYNC]      = "QXL_IO_MEMSLOT_ADD_ASYNC",

        [QXL_IO_CREATE_PRIMARY_ASYNC]   = "QXL_IO_CREATE_PRIMARY_ASYNC",

        [QXL_IO_DESTROY_PRIMARY_ASYNC]  = "QXL_IO_DESTROY_PRIMARY_ASYNC",

        [QXL_IO_DESTROY_SURFACE_ASYNC]  = "QXL_IO_DESTROY_SURFACE_ASYNC",

        [QXL_IO_DESTROY_ALL_SURFACES_ASYNC]

                                        = "QXL_IO_DESTROY_ALL_SURFACES_ASYNC",

        [QXL_IO_FLUSH_SURFACES_ASYNC]   = "QXL_IO_FLUSH_SURFACES_ASYNC",

        [QXL_IO_FLUSH_RELEASE]          = "QXL_IO_FLUSH_RELEASE",

        [QXL_IO_MONITORS_CONFIG_ASYNC]  = "QXL_IO_MONITORS_CONFIG_ASYNC",

    };

    return io_port_to_string[io_port];

}

/* called from spice server thread context only */

static int interface_get_command(QXLInstance *sin, struct QXLCommandExt *ext)

{

    PCIQXLDevice *qxl = container_of(sin, PCIQXLDevice, ssd.qxl);

    SimpleSpiceUpdate *update;

    QXLCommandRing *ring;

    QXLCommand *cmd;

    int notify, ret;

    trace_qxl_ring_command_check(qxl->id, qxl_mode_to_string(qxl->mode));

    switch (qxl->mode) {

    case QXL_MODE_VGA:

        ret = false;

        qemu_mutex_lock(&qxl->ssd.lock);

        update = QTAILQ_FIRST(&qxl->ssd.updates);

        if (update != NULL) {

            QTAILQ_REMOVE(&qxl->ssd.updates, update, next);

            *ext = update->ext;

            ret = true;

        }

        qemu_mutex_unlock(&qxl->ssd.lock);

        if (ret) {

            trace_qxl_ring_command_get(qxl->id, qxl_mode_to_string(qxl->mode));

            qxl_log_command(qxl, "vga", ext);

        }

        return ret;

    case QXL_MODE_COMPAT:

    case QXL_MODE_NATIVE:

    case QXL_MODE_UNDEFINED:

        ring = &qxl->ram->cmd_ring;

        if (qxl->guest_bug || SPICE_RING_IS_EMPTY(ring)) {

            return false;

        }

        SPICE_RING_CONS_ITEM(qxl, ring, cmd);

        if (!cmd) {

            return false;

        }

        ext->cmd      = *cmd;

        ext->group_id = MEMSLOT_GROUP_GUEST;

        ext->flags    = qxl->cmdflags;

        SPICE_RING_POP(ring, notify);

        qxl_ring_set_dirty(qxl);

        if (notify) {

            qxl_send_events(qxl, QXL_INTERRUPT_DISPLAY);

        }

        qxl->guest_primary.commands++;

        qxl_track_command(qxl, ext);

        qxl_log_command(qxl, "cmd", ext);

        trace_qxl_ring_command_get(qxl->id, qxl_mode_to_string(qxl->mode));

        return true;

    default:

        return false;

    }

}

/* called from spice server thread context only */

static int interface_req_cmd_notification(QXLInstance *sin)

{

    PCIQXLDevice *qxl = container_of(sin, PCIQXLDevice, ssd.qxl);

    int wait = 1;

    trace_qxl_ring_command_req_notification(qxl->id);

    switch (qxl->mode) {

    case QXL_MODE_COMPAT:

    case QXL_MODE_NATIVE:

    case QXL_MODE_UNDEFINED:

        SPICE_RING_CONS_WAIT(&qxl->ram->cmd_ring, wait);

        qxl_ring_set_dirty(qxl);

        break;

    default:

        /* nothing */

        break;

    }

    return wait;

}

/* called from spice server thread context only */

static inline void qxl_push_free_res(PCIQXLDevice *d, int flush)

{

    QXLReleaseRing *ring = &d->ram->release_ring;

    uint64_t *item;

    int notify;

#define QXL_FREE_BUNCH_SIZE 32

    if (ring->prod - ring->cons + 1 == ring->num_items) {

        /* ring full -- can't push */

        return;

    }

    if (!flush && d->oom_running) {

        /* collect everything from oom handler before pushing */

        return;

    }

    if (!flush && d->num_free_res < QXL_FREE_BUNCH_SIZE) {

        /* collect a bit more before pushing */

        return;

    }

    SPICE_RING_PUSH(ring, notify);

    trace_qxl_ring_res_push(d->id, qxl_mode_to_string(d->mode),

           d->guest_surfaces.count, d->num_free_res,

           d->last_release, notify ? "yes" : "no");

    trace_qxl_ring_res_push_rest(d->id, ring->prod - ring->cons,

           ring->num_items, ring->prod, ring->cons);

    if (notify) {

        qxl_send_events(d, QXL_INTERRUPT_DISPLAY);

    }

    SPICE_RING_PROD_ITEM(d, ring, item);

    if (!item) {

        return;

    }

    *item = 0;

    d->num_free_res = 0;

    d->last_release = NULL;

    qxl_ring_set_dirty(d);

}

/* called from spice server thread context only */

static void interface_release_resource(QXLInstance *sin,

                                       struct QXLReleaseInfoExt ext)

{

    PCIQXLDevice *qxl = container_of(sin, PCIQXLDevice, ssd.qxl);

    QXLReleaseRing *ring;

    uint64_t *item, id;

    if (ext.group_id == MEMSLOT_GROUP_HOST) {

        /* host group -> vga mode update request */

        qemu_spice_destroy_update(&qxl->ssd, (void *)(intptr_t)ext.info->id);

        return;

    }

    /*

     * ext->info points into guest-visible memory

     * pci bar 0, $command.release_info

     */

    ring = &qxl->ram->release_ring;

    SPICE_RING_PROD_ITEM(qxl, ring, item);

    if (!item) {

        return;

    }

    if (*item == 0) {

        /* stick head into the ring */

        id = ext.info->id;

        ext.info->next = 0;

        qxl_ram_set_dirty(qxl, &ext.info->next);

        *item = id;

        qxl_ring_set_dirty(qxl);

    } else {

        /* append item to the list */

        qxl->last_release->next = ext.info->id;

        qxl_ram_set_dirty(qxl, &qxl->last_release->next);

        ext.info->next = 0;

        qxl_ram_set_dirty(qxl, &ext.info->next);

    }

    qxl->last_release = ext.info;

    qxl->num_free_res++;

    trace_qxl_ring_res_put(qxl->id, qxl->num_free_res);

    qxl_push_free_res(qxl, 0);

}

/* called from spice server thread context only */

static int interface_get_cursor_command(QXLInstance *sin, struct QXLCommandExt *ext)

{

    PCIQXLDevice *qxl = container_of(sin, PCIQXLDevice, ssd.qxl);

    QXLCursorRing *ring;

    QXLCommand *cmd;

    int notify;

    trace_qxl_ring_cursor_check(qxl->id, qxl_mode_to_string(qxl->mode));

    switch (qxl->mode) {

    case QXL_MODE_COMPAT:

    case QXL_MODE_NATIVE:

    case QXL_MODE_UNDEFINED:

        ring = &qxl->ram->cursor_ring;

        if (SPICE_RING_IS_EMPTY(ring)) {

            return false;

        }

        SPICE_RING_CONS_ITEM(qxl, ring, cmd);

        if (!cmd) {

            return false;

        }

        ext->cmd      = *cmd;

        ext->group_id = MEMSLOT_GROUP_GUEST;

        ext->flags    = qxl->cmdflags;

        SPICE_RING_POP(ring, notify);

        qxl_ring_set_dirty(qxl);

        if (notify) {

            qxl_send_events(qxl, QXL_INTERRUPT_CURSOR);

        }

        qxl->guest_primary.commands++;

        qxl_track_command(qxl, ext);

        qxl_log_command(qxl, "csr", ext);

        if (qxl->id == 0) {

            qxl_render_cursor(qxl, ext);

        }

        trace_qxl_ring_cursor_get(qxl->id, qxl_mode_to_string(qxl->mode));

        return true;

    default:

        return false;

    }

}

/* called from spice server thread context only */

static int interface_req_cursor_notification(QXLInstance *sin)

{

    PCIQXLDevice *qxl = container_of(sin, PCIQXLDevice, ssd.qxl);

    int wait = 1;

    trace_qxl_ring_cursor_req_notification(qxl->id);

    switch (qxl->mode) {

    case QXL_MODE_COMPAT:

    case QXL_MODE_NATIVE:

    case QXL_MODE_UNDEFINED:

        SPICE_RING_CONS_WAIT(&qxl->ram->cursor_ring, wait);

        qxl_ring_set_dirty(qxl);

        break;

    default:

        /* nothing */

        break;

    }

    return wait;

}

/* called from spice server thread context */

static void interface_notify_update(QXLInstance *sin, uint32_t update_id)

{

    /*

     * Called by spice-server as a result of a QXL_CMD_UPDATE which is not in

     * use by xf86-video-qxl and is defined out in the qxl windows driver.

     * Probably was at some earlier version that is prior to git start (2009),

     * and is still guest trigerrable.

     */

    fprintf(stderr, "%s: deprecated\n", __func__);

}

/* called from spice server thread context only */

static int interface_flush_resources(QXLInstance *sin)

{

    PCIQXLDevice *qxl = container_of(sin, PCIQXLDevice, ssd.qxl);

    int ret;

    ret = qxl->num_free_res;

    if (ret) {

        qxl_push_free_res(qxl, 1);

    }

    return ret;

}

static void qxl_create_guest_primary_complete(PCIQXLDevice *d);

/* called from spice server thread context only */

static void interface_async_complete_io(PCIQXLDevice *qxl, QXLCookie *cookie)

{

    uint32_t current_async;

    qemu_mutex_lock(&qxl->async_lock);

    current_async = qxl->current_async;

    qxl->current_async = QXL_UNDEFINED_IO;

    qemu_mutex_unlock(&qxl->async_lock);

    trace_qxl_interface_async_complete_io(qxl->id, current_async, cookie);

    if (!cookie) {

        fprintf(stderr, "qxl: %s: error, cookie is NULL\n", __func__);

        return;

    }

    if (cookie && current_async != cookie->io) {

        fprintf(stderr,

                "qxl: %s: error: current_async = %d != %"

                PRId64 " = cookie->io\n", __func__, current_async, cookie->io);

    }

    switch (current_async) {

    case QXL_IO_MEMSLOT_ADD_ASYNC:

    case QXL_IO_DESTROY_PRIMARY_ASYNC:

    case QXL_IO_UPDATE_AREA_ASYNC:

    case QXL_IO_FLUSH_SURFACES_ASYNC:

    case QXL_IO_MONITORS_CONFIG_ASYNC:

        break;

    case QXL_IO_CREATE_PRIMARY_ASYNC:

        qxl_create_guest_primary_complete(qxl);

        break;

    case QXL_IO_DESTROY_ALL_SURFACES_ASYNC:

        qxl_spice_destroy_surfaces_complete(qxl);

        break;

    case QXL_IO_DESTROY_SURFACE_ASYNC:

        qxl_spice_destroy_surface_wait_complete(qxl, cookie->u.surface_id);

        break;

    default:

        fprintf(stderr, "qxl: %s: unexpected current_async %d\n", __func__,

                current_async);

    }

    qxl_send_events(qxl, QXL_INTERRUPT_IO_CMD);

}

/* called from spice server thread context only */

static void interface_update_area_complete(QXLInstance *sin,

        uint32_t surface_id,

        QXLRect *dirty, uint32_t num_updated_rects)

{

    PCIQXLDevice *qxl = container_of(sin, PCIQXLDevice, ssd.qxl);

    int i;

    int qxl_i;

    qemu_mutex_lock(&qxl->ssd.lock);

    if (surface_id != 0 || !qxl->render_update_cookie_num) {

        qemu_mutex_unlock(&qxl->ssd.lock);

        return;

    }

    trace_qxl_interface_update_area_complete(qxl->id, surface_id, dirty->left,

            dirty->right, dirty->top, dirty->bottom);

    trace_qxl_interface_update_area_complete_rest(qxl->id, num_updated_rects);

    if (qxl->num_dirty_rects + num_updated_rects > QXL_NUM_DIRTY_RECTS) {

        /*

         * overflow - treat this as a full update. Not expected to be common.