fs9p.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2017 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.
 */
 
#ifndef __DEV_VIRTIO_FS9P_HH__
#define __DEV_VIRTIO_FS9P_HH__
 
#include <map>
#include <memory>
#include <string>
 
#include "base/compiler.hh"
#include "base/pollevent.hh"
#include "dev/virtio/base.hh"
 
namespace gem5
{
 
struct VirtIO9PBaseParams;
 
typedef uint8_t P9MsgType;
typedef uint16_t P9Tag;
 
struct GEM5_PACKED P9MsgHeader
{
    uint32_t len;
    P9MsgType type;
    P9Tag tag;
};

template <typename T> inline T
p9toh(T v) { return letoh(v); }

template <typename T> inline T
htop9(T v) { return htole(v); }
 
template <> inline P9MsgHeader
p9toh(P9MsgHeader v)
{
    v.len = p9toh(v.len);
    v.type = p9toh(v.type);
    v.tag = p9toh(v.tag);
    return v;
}
 
template <> inline P9MsgHeader
htop9(P9MsgHeader v)
{
    v.len = htop9(v.len);
    v.type = htop9(v.type);
    v.tag = htop9(v.tag);
    return v;
}

class VirtIO9PBase : public VirtIODeviceBase
{
  public:
    typedef VirtIO9PBaseParams Params;
    VirtIO9PBase(const Params &params);
    virtual ~VirtIO9PBase();
 
    void readConfig(PacketPtr pkt, Addr cfgOffset);
 
  protected:
    struct GEM5_PACKED Config
    {
        uint16_t len;
        char tag[];
    };

    std::unique_ptr<Config, void(*)(void *p)> config =
        {nullptr, [](void *p){ operator delete(p); }};

    static const DeviceId ID_9P = 0x09;

    static const FeatureBits F_MOUNT_TAG = 0x01;
 
  protected:
    class FSQueue : public VirtQueue
    {
      public:
        FSQueue(PortProxy &proxy, ByteOrder bo,
                uint16_t size, VirtIO9PBase &_parent)
            : VirtQueue(proxy, bo, size), parent(_parent) {}
        virtual ~FSQueue() {}
 
        void onNotifyDescriptor(VirtDescriptor *desc);
 
        std::string name() const { return parent.name() + ".queue"; }
 
      protected:
        VirtIO9PBase &parent;
    };
 
    FSQueue queue;
 
  protected:
    virtual void recvTMsg(const P9MsgHeader &header, const uint8_t *data, size_t size) = 0;
    void sendRMsg(const P9MsgHeader &header, const uint8_t *data, size_t size);

    void dumpMsg(const P9MsgHeader &header, const uint8_t *data, size_t size);
 
  private:
    std::map<P9Tag, VirtDescriptor *> pendingTransactions;
};
 
struct VirtIO9PProxyParams;

class VirtIO9PProxy : public VirtIO9PBase
{
  public:
    typedef VirtIO9PProxyParams Params;
    VirtIO9PProxy(const Params &params);
    virtual ~VirtIO9PProxy();
 
    void serialize(CheckpointOut &cp) const override;
    void unserialize(CheckpointIn &cp) override;
 
  protected:
    void recvTMsg(const P9MsgHeader &header, const uint8_t *data,
                  size_t size) override;

    void serverDataReady();

    virtual ssize_t read(uint8_t *data, size_t len) = 0;
    virtual ssize_t write(const uint8_t *data, size_t len) = 0;

    void readAll(uint8_t *data, size_t len);
    void writeAll(const uint8_t *data, size_t len);

     bool deviceUsed;
};
 
struct VirtIO9PDiodParams;

class VirtIO9PDiod : public VirtIO9PProxy
{
  public:
    typedef VirtIO9PDiodParams Params;
    VirtIO9PDiod(const Params &params);
    virtual ~VirtIO9PDiod();
 
    void startup();
 
  protected:
    void startDiod();
 
    ssize_t read(uint8_t *data, size_t len);
    ssize_t write(const uint8_t *data, size_t len);
    void terminateDiod();
 
  private:
    class DiodDataEvent : public PollEvent
    {
      public:
        DiodDataEvent(VirtIO9PDiod &_parent, int fd, int event)
            : PollEvent(fd, event), parent(_parent) {}
 
        virtual ~DiodDataEvent() {};
 
        void process(int revent);
 
      private:
        VirtIO9PDiod &parent;
    };

    int fd_to_diod;
    int fd_from_diod;
 
    std::unique_ptr<DiodDataEvent> dataEvent;

    int diod_pid;
};
 
struct VirtIO9PSocketParams;

class VirtIO9PSocket : public VirtIO9PProxy
{
  public:
    typedef VirtIO9PSocketParams Params;
    VirtIO9PSocket(const Params &params);
    virtual ~VirtIO9PSocket();
 
    void startup();
 
  protected:
    void connectSocket();

    void socketDisconnect();
 
    ssize_t read(uint8_t *data, size_t len);
    ssize_t write(const uint8_t *data, size_t len);
 
  private:
    class SocketDataEvent : public PollEvent
    {
      public:
        SocketDataEvent(VirtIO9PSocket &_parent, int fd, int event)
            : PollEvent(fd, event), parent(_parent) {}
 
        virtual ~SocketDataEvent() {};
 
        void process(int revent);
 
      private:
        VirtIO9PSocket &parent;
    };

    int fdSocket;
 
    std::unique_ptr<SocketDataEvent> dataEvent;
};
 
} // namespace gem5
 
#endif // __DEV_VIRTIO_FS9P_HH__