summaryrefslogtreecommitdiffstats
path: root/qdbd/server.cpp
blob: 9e47528315ad78a6ab010ef87dc232fded226c57 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
/******************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the Qt Debug Bridge.
**
** $QT_BEGIN_LICENSE:COMM$
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** $QT_END_LICENSE$
**
******************************************************************************/
#include "server.h"

#include "createexecutor.h"
#include "echoexecutor.h"
#include "libqdb/make_unique.h"
#include "libqdb/protocol/protocol.h"
#include "libqdb/protocol/qdbmessage.h"
#include "libqdb/protocol/qdbtransport.h"
#include "libqdb/stream.h"

#include <QtCore/qdebug.h>
#include <QtCore/qloggingcategory.h>

#include <algorithm>

Q_LOGGING_CATEGORY(connectionC, "qdb.connection");

Server::Server(QdbTransport *transport, QObject *parent)
    : AbstractConnection{transport, parent},
      m_state{ServerState::Disconnected},
      m_executors{}
{

}

Server::~Server() = default;

void Server::handleMessage()
{
    QdbMessage message = m_transport->receive();

    Q_ASSERT_X(message.command() != QdbMessage::Invalid, "Server::handleMessage()", "Received invalid message");

    switch (m_state) {
    case ServerState::Disconnected:
        if (message.command() != QdbMessage::Connect) {
            qCWarning(connectionC) << "Server got non-Connect message in Disconnected state. Resetting.";
            resetServer(false);
            break;
        }
        checkVersion(message);
        resetServer(true);
        break;
    case ServerState::Connected:
        switch (message.command()) {
        case QdbMessage::Connect:
            qCWarning(connectionC()) << "Server received QdbMessage::Connect while already connected. Resetting.";
            checkVersion(message);
            resetServer(true);
            break;
        case QdbMessage::Open:
            handleOpen(message.hostStream(), message.data());
            break;
        case QdbMessage::Write:
            handleWrite(message);
            break;
        case QdbMessage::Close:
            closeStream(message.deviceStream());
            break;
        case QdbMessage::Ok:
            qCWarning(connectionC) << "Server received QdbMessage::Ok in connected state";
            break;
        case QdbMessage::Invalid:
            Q_UNREACHABLE();
            break;
        }
        break;
    case ServerState::Waiting:
        switch (message.command()) {
        case QdbMessage::Connect:
            qCWarning(connectionC()) << "Server received QdbMessage::Connect while already connected and waiting. Resetting.";
            resetServer(true);
            break;
        case QdbMessage::Open:
            handleOpen(message.hostStream(), message.data());
            break;
        case QdbMessage::Write:
            handleWrite(message);
            break;
        case QdbMessage::Close:
            m_state = ServerState::Connected;
            closeStream(message.deviceStream());
            break;
        case QdbMessage::Ok:
            m_state = ServerState::Connected;
            break;
        case QdbMessage::Invalid:
            Q_UNREACHABLE();
            break;
        }
        break;
    }
    processQueue();
}

void Server::enqueueMessage(const QdbMessage &message)
{
    Q_ASSERT(message.command() != QdbMessage::Invalid);
    qCDebug(connectionC) << "Server enqueue: " << message;
    m_outgoingMessages.enqueue(message);
    processQueue();
}

void Server::processQueue()
{
    if (m_outgoingMessages.isEmpty()) {
        return;
    }

    if (m_state == ServerState::Waiting) {
        qCDebug(connectionC) << "Server::processQueue() skipping to wait for QdbMessage::Ok";
        return;
    }

    auto message = m_outgoingMessages.dequeue();

    Q_ASSERT_X(message.command() != QdbMessage::Invalid, "Server::processQueue()",
               "Tried to send invalid message");

    if (!m_transport->send(message)) {
        qCCritical(connectionC) << "Server could not send" << message;
        m_state = ServerState::Disconnected;
        return;
    }

    switch (message.command()) {
    case QdbMessage::Open:
        qFatal("Server sending QdbMessage::Open is not supported");
        break;
    case QdbMessage::Write:
        Q_ASSERT(m_state == ServerState::Connected);
        m_state = ServerState::Waiting;
        break;
        // Connect, Close and Ok are not acknowledged when sent by server,
        // so no need to transition to ServerState::Waiting.
        // Since there is no acknowledgment incoming, we also need to move
        // onto the next message in the queue, otherwise it would only be sent
        // after host sends us something.
    case QdbMessage::Connect:
        //[[fallthrough]]
    case QdbMessage::Close:
        //[[fallthrough]]
    case QdbMessage::Ok:
        if (!m_outgoingMessages.isEmpty()) {
            processQueue();
        }
        break;
    case QdbMessage::Invalid:
        Q_UNREACHABLE();
        break;
    }
}

void Server::handleOpen(StreamId hostId, const QByteArray &tag)
{
    StreamId deviceId = m_nextStreamId++;
    enqueueMessage(QdbMessage{QdbMessage::Ok, hostId, deviceId});
    m_streams[deviceId] = make_unique<Stream>(this, hostId, deviceId);
    m_executors[deviceId] = createExecutor(m_streams[deviceId].get(), tag);
}

void Server::resetServer(bool hostConnected)
{
    m_outgoingMessages.clear();
    m_executors.clear();
    m_streams.clear();
    m_state = hostConnected ? ServerState::Connected : ServerState::Disconnected;

    QByteArray buffer{};
    QDataStream dataStream{&buffer, QIODevice::WriteOnly};
    dataStream << qdbProtocolVersion;

    enqueueMessage(QdbMessage{QdbMessage::Connect, 0, 0, buffer});
}

void Server::handleWrite(const QdbMessage &message)
{
    if (m_streams.find(message.deviceStream()) == m_streams.end()) {
        qCWarning(connectionC) << "Server received message to non-existing stream" << message.deviceStream();
        enqueueMessage(QdbMessage{QdbMessage::Close, message.hostStream(), message.deviceStream()});
        return;
    }
    enqueueMessage(QdbMessage{QdbMessage::Ok, message.hostStream(), message.deviceStream()});
    m_streams[message.deviceStream()]->receiveMessage(message);
}

void Server::closeStream(StreamId id)
{
    if (m_streams.find(id) == m_streams.end()) {
        qCWarning(connectionC) << "Server received Close to a non-existing stream" << id;
        return;
    }

    m_streams[id]->close();
    m_executors.erase(id);
    m_streams.erase(id);

    auto messageInStream = [&id](const QdbMessage &message) {
        return message.deviceStream() == id;
    };
    m_outgoingMessages.erase(
                std::remove_if(m_outgoingMessages.begin(), m_outgoingMessages.end(), messageInStream),
                m_outgoingMessages.end());
    // Closes are not acknowledged
}

void Server::checkVersion(const QdbMessage &message)
{
    Q_ASSERT(message.command() == QdbMessage::Connect);
    Q_ASSERT(message.data().size() == sizeof(qdbProtocolVersion));

    QDataStream dataStream{message.data()};
    uint32_t protocolVersion;
    dataStream >> protocolVersion;

    if (protocolVersion != qdbProtocolVersion) {
        qCCritical(connectionC()) << "Protocol version" << protocolVersion << "requested, but only version"
                                  << qdbProtocolVersion << "is known";
    }
}