vncserver.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2010, 2015 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 __BASE_VNC_VNC_SERVER_HH__
#define __BASE_VNC_VNC_SERVER_HH__
 
#include <iostream>
 
#include "base/circlebuf.hh"
#include "base/compiler.hh"
#include "base/pollevent.hh"
#include "base/socket.hh"
#include "base/vnc/vncinput.hh"
#include "params/VncServer.hh"
#include "sim/sim_object.hh"
 
namespace gem5
{
 
class VncServer : public VncInput
{
  public:
 
    const static uint32_t AuthInvalid = 0;
    const static uint32_t AuthNone    = 1;
 
    const static uint32_t VncOK   = 0;
 
    enum ServerMessages
    {
        ServerFrameBufferUpdate     = 0,
        ServerSetColorMapEntries    = 1,
        ServerBell                  = 2,
        ServerCutText               = 3
    };
 
    enum EncodingTypes
    {
        EncodingRaw         = 0,
        EncodingCopyRect    = 1,
        EncodingHextile     = 5,
        EncodingDesktopSize = -223
    };
 
    enum MouseEvents
    {
        MouseLeftButton     = 0x1,
        MouseRightButton    = 0x2,
        MouseMiddleButton   = 0x4
    };
 
    const char* vncVersion() const
    {
        return "RFB 003.008\n";
    }
 
    enum ConnectionState
    {
        WaitForProtocolVersion,
        WaitForSecurityResponse,
        WaitForClientInit,
        InitializationPhase,
        NormalPhase
    };
 
    struct GEM5_PACKED ServerInitMsg
    {
        uint16_t fbWidth;
        uint16_t fbHeight;
        PixelFormat px;
        uint32_t namelen;
        char name[2]; // just to put M5 in here
    };
 
    struct GEM5_PACKED FrameBufferUpdate
    {
        uint8_t type;
        uint8_t padding;
        uint16_t num_rects;
    };
 
    struct GEM5_PACKED FrameBufferRect
    {
        uint16_t x;
        uint16_t y;
        uint16_t width;
        uint16_t height;
        int32_t encoding;
    };
 
    struct GEM5_PACKED ServerCutText
    {
        uint8_t type;
        uint8_t padding[3];
        uint32_t length;
    };
 
  protected:
    class ListenEvent: public PollEvent
    {
      protected:
        VncServer *vncserver;
 
      public:
        ListenEvent(VncServer *vs, int fd, int e);
        void process(int revent);
    };
 
    friend class ListenEvent;
    ListenEvent *listenEvent;
 
    class DataEvent: public PollEvent
    {
      protected:
        VncServer *vncserver;
 
      public:
        DataEvent(VncServer *vs, int fd, int e);
        void process(int revent);
    };
 
    friend class DataEvent;
    DataEvent *dataEvent;
 
    int number;
    int dataFd; // data stream file describer
 
    ListenSocketPtr listener;
 
    void listen();
    void accept();
    void data();
    void detach();
 
  public:
    typedef VncServerParams Params;
    VncServer(const Params &p);
    ~VncServer();
 
    // RFB
  protected:
 
    ConnectionState curState;
 
    bool sendUpdate;
 
    PixelFormat pixelFormat;
 
    bool supportsRawEnc;
 
    bool supportsResizeEnc;
 
  protected:
    void sendError(const char* error_msg);
 
    bool read(uint8_t *buf, size_t len);
 
    bool read1(uint8_t *buf, size_t len);
 
 
    template <typename T> bool read(T* val);
 
 
    bool write(const uint8_t *buf, size_t len);
 
    template <typename T> bool write(T* val);
 
    bool write(const char* str);
 
    void checkProtocolVersion();
 
    void checkSecurity();
 
    void sendServerInit();
 
    void sendError(std::string error_msg);
 
    void sendFrameBufferUpdate();
 
    void setPixelFormat();
 
    void setEncodings();
 
    void requestFbUpdate();
 
    void recvKeyboardInput();
 
    void recvPointerInput();
 
    void recvCutText();
 
    void sendFrameBufferResized();
 
    static const PixelConverter pixelConverter;
 
  public:
    void setDirty() override;
    void frameBufferResized() override;
};
 
} // namespace gem5
 
#endif