dev: Add a VirtIO block device model

4 files changed, 411 insertions, 0 deletions

diff --git a/src/dev/virtio/SConscript b/src/dev/virtio/SConscript
index 2d4fb00dd..42dc480f0 100644
--- a/src/dev/virtio/SConscript
+++ b/src/dev/virtio/SConscript
@@ -44,11 +44,14 @@ if env['TARGET_ISA'] == 'null':
 
 SimObject('VirtIO.py')
 SimObject('VirtIOConsole.py')
+SimObject('VirtIOBlock.py')
 
 Source('base.cc')
 Source('pci.cc')
 Source('console.cc')
+Source('block.cc')
 
 DebugFlag('VIO', 'VirtIO base functionality')
 DebugFlag('VIOPci', 'VirtIO PCI transport')
 DebugFlag('VIOConsole', 'VirtIO console device')
+DebugFlag('VIOBlock', 'VirtIO block device')
diff --git a/src/dev/virtio/VirtIOBlock.py b/src/dev/virtio/VirtIOBlock.py
new file mode 100644
index 000000000..1add847c7
--- /dev/null
+++ b/src/dev/virtio/VirtIOBlock.py
@@ -0,0 +1,50 @@
+# -*- mode:python -*-
+
+# Copyright (c) 2014 ARM Limited
+# All rights reserved.
+#
+# The license below extends only to copyright in the software and shall
+# not be construed as granting a license to any other intellectual
+# property including but not limited to intellectual property relating
+# to a hardware implementation of the functionality of the software
+# licensed hereunder.  You may use the software subject to the license
+# terms below provided that you ensure that this notice is replicated
+# unmodified and in its entirety in all distributions of the software,
+# modified or unmodified, in source code or in binary form.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met: redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer;
+# redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution;
+# neither the name of the copyright holders nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# Authors: Andreas Sandberg
+
+from m5.params import *
+from m5.proxy import *
+from VirtIO import VirtIODeviceBase
+
+class VirtIOBlock(VirtIODeviceBase):
+    type = 'VirtIOBlock'
+    cxx_header = 'dev/virtio/block.hh'
+
+    queueSize = Param.Unsigned(128, "Output queue size (pages)")
+
+    image = Param.DiskImage("Disk image")
diff --git a/src/dev/virtio/block.cc b/src/dev/virtio/block.cc
new file mode 100644
index 000000000..2b511e2f3
--- /dev/null
+++ b/src/dev/virtio/block.cc
@@ -0,0 +1,172 @@
+/*
+ * Copyright (c) 2014 ARM Limited
+ * All rights reserved
+ *
+ * The license below extends only to copyright in the software and shall
+ * not be construed as granting a license to any other intellectual
+ * property including but not limited to intellectual property relating
+ * to a hardware implementation of the functionality of the software
+ * licensed hereunder.  You may use the software subject to the license
+ * terms below provided that you ensure that this notice is replicated
+ * unmodified and in its entirety in all distributions of the software,
+ * modified or unmodified, in source code or in binary form.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met: redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer;
+ * redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution;
+ * neither the name of the copyright holders nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Authors: Andreas Sandberg
+ */
+
+#include "debug/VIOBlock.hh"
+#include "dev/virtio/block.hh"
+#include "params/VirtIOBlock.hh"
+#include "sim/system.hh"
+
+VirtIOBlock::VirtIOBlock(Params *params)
+    : VirtIODeviceBase(params, ID_BLOCK, sizeof(Config), 0),
+      qRequests(params->system->physProxy, params->queueSize, *this),
+      image(*params->image)
+{
+    registerQueue(qRequests);
+
+    config.capacity = image.size();
+}
+
+
+VirtIOBlock::~VirtIOBlock()
+{
+}
+
+void
+VirtIOBlock::readConfig(PacketPtr pkt, Addr cfgOffset)
+{
+    Config cfg_out;
+    cfg_out.capacity = htov_legacy(config.capacity);
+
+    readConfigBlob(pkt, cfgOffset, (uint8_t *)&cfg_out);
+}
+
+VirtIOBlock::Status
+VirtIOBlock::read(const BlkRequest &req, VirtDescriptor *desc_chain,
+                  size_t off_data, size_t size)
+{
+    uint8_t data[size];
+    uint64_t sector(req.sector);
+
+    DPRINTF(VIOBlock, "Read request starting @ sector %i (size: %i)\n",
+            sector, size);
+
+    if (size % SectorSize != 0)
+        panic("Unexpected request/sector size relationship\n");
+
+    for (Addr offset = 0; offset < size; offset += SectorSize) {
+        if (image.read(data + offset, sector) != SectorSize) {
+            warn("Failed to read sector %i\n", sector);
+            return S_IOERR;
+        }
+        ++sector;
+    }
+
+    desc_chain->chainWrite(off_data, data, size);
+
+    return S_OK;
+}
+
+VirtIOBlock::Status
+VirtIOBlock::write(const BlkRequest &req, VirtDescriptor *desc_chain,
+                  size_t off_data, size_t size)
+{
+    uint8_t data[size];
+    uint64_t sector(req.sector);
+
+    DPRINTF(VIOBlock, "Write request starting @ sector %i (size: %i)\n",
+            sector, size);
+
+    if (size % SectorSize != 0)
+        panic("Unexpected request/sector size relationship\n");
+
+
+    desc_chain->chainRead(off_data, data, size);
+
+    for (Addr offset = 0; offset < size; offset += SectorSize) {
+        if (image.write(data + offset, sector) != SectorSize) {
+            warn("Failed to write sector %i\n", sector);
+            return S_IOERR;
+        }
+        ++sector;
+    }
+
+    return S_OK;
+
+}
+
+void
+VirtIOBlock::RequestQueue::onNotifyDescriptor(VirtDescriptor *desc)
+{
+    DPRINTF(VIOBlock, "Got input data descriptor (len: %i)\n",
+            desc->size());
+    /*
+     * Read the request structure and do endian conversion if
+     * necessary.
+     */
+    BlkRequest req;
+    desc->chainRead(0, (uint8_t *)&req, sizeof(req));
+    req.type = htov_legacy(req.type);
+    req.sector = htov_legacy(req.sector);
+
+    Status status;
+    const size_t data_size(desc->chainSize()
+                           - sizeof(BlkRequest) - sizeof(Status));
+
+    switch (req.type) {
+      case T_IN:
+        status = parent.read(req, desc, sizeof(BlkRequest), data_size);
+        break;
+
+      case T_OUT:
+        status = parent.write(req, desc, sizeof(BlkRequest), data_size);
+        break;
+
+      case T_FLUSH:
+        status = S_OK;
+        break;
+
+      default:
+        warn("Unsupported IO request: %i\n", req.type);
+        status = S_UNSUPP;
+        break;
+    }
+
+    desc->chainWrite(sizeof(BlkRequest) + data_size,
+                     &status, sizeof(status));
+
+    // Tell the guest that we are done with this descriptor.
+    produceDescriptor(desc, sizeof(BlkRequest) + data_size + sizeof(Status));
+    parent.kick();
+}
+
+VirtIOBlock *
+VirtIOBlockParams::create()
+{
+    return new VirtIOBlock(this);
+}
diff --git a/src/dev/virtio/block.hh b/src/dev/virtio/block.hh
new file mode 100644
index 000000000..bef29580b
--- /dev/null
+++ b/src/dev/virtio/block.hh
@@ -0,0 +1,186 @@
+/*
+ * Copyright (c) 2014 ARM Limited
+ * All rights reserved
+ *
+ * The license below extends only to copyright in the software and shall
+ * not be construed as granting a license to any other intellectual
+ * property including but not limited to intellectual property relating
+ * to a hardware implementation of the functionality of the software
+ * licensed hereunder.  You may use the software subject to the license
+ * terms below provided that you ensure that this notice is replicated
+ * unmodified and in its entirety in all distributions of the software,
+ * modified or unmodified, in source code or in binary form.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met: redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer;
+ * redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution;
+ * neither the name of the copyright holders nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Authors: Andreas Sandberg
+ */
+
+#ifndef __DEV_VIRTIO_BLOCK_HH__
+#define __DEV_VIRTIO_BLOCK_HH__
+
+#include "dev/virtio/base.hh"
+#include "dev/disk_image.hh"
+#include "dev/terminal.hh"
+
+struct VirtIOBlockParams;
+
+/**
+ * VirtIO block device
+ *
+ * The block device uses the following queues:
+ *  -# Requests
+ *
+ * A guest issues a request by creating a descriptor chain that starts
+ * with a BlkRequest. Immediately after the BlkRequest follows the
+ * data for the request. The data buffer(s) are either input or output
+ * descriptors depending on the request type. The last byte in the
+ * descriptor chain should always be writable by the host and contains
+ * the request status code (OK/Error).
+ *
+ * The protocol supports asynchronous request completion by returning
+ * descriptor chains when they have been populated by the backing
+ * store. However, there is little point in doing so here.
+ *
+ * @see https://github.com/rustyrussell/virtio-spec
+ * @see http://docs.oasis-open.org/virtio/virtio/v1.0/virtio-v1.0.html
+ */
+class VirtIOBlock : public VirtIODeviceBase
+{
+  public:
+    typedef VirtIOBlockParams Params;
+    VirtIOBlock(Params *params);
+    virtual ~VirtIOBlock();
+
+    void readConfig(PacketPtr pkt, Addr cfgOffset);
+
+  protected:
+    static const DeviceId ID_BLOCK = 0x02;
+
+    /**
+     * Block device configuration structure
+     *
+     * @note This needs to be changed if the supported feature set
+     * changes!
+     */
+    struct Config {
+        uint64_t capacity;
+    } M5_ATTR_PACKED;
+    Config config;
+
+    /** @{
+     * @name Feature bits
+     */
+    static const FeatureBits F_SIZE_MAX = (1 << 1);
+    static const FeatureBits F_SEG_MAX = (1 << 2);
+    static const FeatureBits F_GEOMETRY = (1 << 4);
+    static const FeatureBits F_RO = (1 << 5);
+    static const FeatureBits F_BLK_SIZE = (1 << 6);
+    static const FeatureBits F_TOPOLOGY = (1 << 10);
+    /** @} */
+
+    /** @{
+     * @name VirtIO block requests
+     */
+    typedef uint32_t RequestType;
+    /** Read request */
+    static const RequestType T_IN = 0;
+    /** Write request */
+    static const RequestType T_OUT = 1;
+    /** Flush device buffers */
+    static const RequestType T_FLUSH = 4;
+    /** @} */
+
+    /** @{
+     * @name VirtIO block request status
+     */
+    typedef uint8_t Status;
+    /** Request succeeded */
+    static const Status S_OK = 0;
+    /** Request failed due to a device error */
+    static const Status S_IOERR = 1;
+    /** Request not supported */
+    static const Status S_UNSUPP = 2;
+    /** @} */
+
+    /** VirtIO block device request as sent by guest */
+    struct BlkRequest {
+        RequestType type;
+        uint32_t reserved;
+        uint64_t sector;
+    } M5_ATTR_PACKED;
+
+    /**
+     * Device read request.
+     *
+     * @param req Disk request from guest.
+     * @param desc_chain Request descriptor chain (from start of
+     *                   request)
+     * @param off_data Offset into the descriptor chain where data
+     *                 should be written.
+     * @param size Request data size.
+     */
+    Status read(const BlkRequest &req, VirtDescriptor *desc_chain,
+                size_t off_data, size_t size);
+    /**
+     * Device write request.
+     *
+     * @param req Disk request from guest.
+     * @param desc_chain Request descriptor chain (from start of
+     *                   request)
+     * @param off_data Offset into the descriptor chain where data
+     *                 should be read.
+     * @param size Request data size.
+     */
+    Status write(const BlkRequest &req, VirtDescriptor *desc_chain,
+                 size_t off_data, size_t size);
+
+  protected:
+    /**
+     * Virtqueue for disk requests.
+     */
+    class RequestQueue
+        : public VirtQueue
+    {
+      public:
+        RequestQueue(PortProxy &proxy, uint16_t size, VirtIOBlock &_parent)
+            : VirtQueue(proxy, size), parent(_parent) {}
+        virtual ~RequestQueue() {}
+
+        void onNotifyDescriptor(VirtDescriptor *desc);
+
+        std::string name() const { return parent.name() + ".qRequests"; }
+
+      protected:
+        VirtIOBlock &parent;
+    };
+
+    /** Device I/O request queue */
+    RequestQueue qRequests;
+
+    /** Image backing this device */
+    DiskImage &image;
+};
+
+#endif // __DEV_VIRTIO_BLOCK_HH__