File: AutomationEngine.cpp

package info (click to toggle)
darkradiant 3.9.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 41,080 kB
  • sloc: cpp: 264,743; ansic: 10,659; python: 1,852; xml: 1,650; sh: 92; makefile: 21
file content (326 lines) | stat: -rw-r--r-- 8,742 bytes parent folder | download | duplicates (3)
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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
#include "AutomationEngine.h"

#include <cassert>

#include "MessageTcp.h"
#include "clsocket/ActiveSocket.h"

#include <fmt/format.h>


namespace gameconn
{

namespace
{
    const char* const DEFAULT_HOST = "localhost";
    const int DEFAULT_PORT = 3879;

    inline std::string seqnoPreamble(std::size_t seq) {
        return fmt::format("seqno {0}\n", seq);
    }

    struct ScopedDepthCounter {
        int& ref;
        ScopedDepthCounter(int& counter) : ref(counter) {
            ref++;
        }
        ~ScopedDepthCounter() {
            ref--;
        }
    };
}

AutomationEngine::AutomationEngine()
{}
AutomationEngine::~AutomationEngine()
{
    disconnect(true);
}

bool AutomationEngine::isAlive() const
{
    return _connection && _connection->isAlive();
}
bool AutomationEngine::hasLostConnection() const
{
    return _connection && !_connection->isAlive();
}

bool AutomationEngine::connect()
{
    if (isAlive())
        return true;    //already connected

    // Make connection using clsocket
    // TODO: make port configurable, as it is in TDM?
    std::unique_ptr<CActiveSocket> connection(new CActiveSocket());
    if (
        !connection->Initialize() ||
        !connection->SetNonblocking() ||
        !connection->Open(DEFAULT_HOST, DEFAULT_PORT))
    {
        return false;
    }

    _connection.reset(new MessageTcp());
    _connection->init(std::move(connection));
    if (!_connection->isAlive())
        return false;

    return true;
}

void AutomationEngine::disconnect(bool force)
{
    if (force) {
        //drop everything pending 
        _multistepProcs.clear();
        _requests.clear();
    }
    else {
        //try to finish all pending
        waitForTags();
    }

    if (_connection)
        _connection.reset();
}


int AutomationEngine::generateNewSequenceNumber()
{
    return ++_seqno;
}

AutomationEngine::Request* AutomationEngine::sendRequest(int tag, const std::string& request) {
    assert(tag < 31);
    if (!_connection)
        throw DisconnectException();

    Request req;
    req._seqno = generateNewSequenceNumber();
    req._request = request;
    req._tag = tag;
    req._finished = false;

    std::string fullMessage = seqnoPreamble(req._seqno) + req._request;
    _connection->writeMessage(fullMessage.data(), (int)fullMessage.size());
    _requests.push_back(req);

    return &_requests.back();
}

void AutomationEngine::think() {
    ScopedDepthCounter dc(_thinkDepth);

    if (_connection) {
        _connection->think();

        //check if full response is here
        std::vector<char> responseBytes;
        while (_connection->readMessage(responseBytes)) {
            //validate and remove preamble
            int responseSeqno, lineLen;
            int ret = sscanf(responseBytes.data(), "response %d\n%n", &responseSeqno, &lineLen);
            assert(ret == 1); ret;
            std::string response(responseBytes.begin() + lineLen, responseBytes.end());

            //find request, mark it as "no longer in progress"
            if (Request* req = findRequest(responseSeqno)) {
                req->_finished = true;
                req->_response = response;
            }
        }
    }

    //execute callbacks for finished requests
    for (int i = 0; i < _requests.size(); i++) {
        if (_requests[i]._finished && _requests[i]._callback) {
            _requests[i]._callback(_requests[i]._seqno);
            _requests[i]._callback = {};
        }
    }

    //don't do some stuff in nested think calls:
    //  1) don't delete finished requests (multistep proc might still need it)
    //  2) don't resume multistep procedures (to avoid recursion)
    if (_thinkDepth == 1) {
        //resume multistep procedures
        for (int i = 0; i < _multistepProcs.size(); i++) {
            MultistepProcedure& proc = _multistepProcs[i];
            if (!isMultistepProcStillWaiting(proc, false)) {
                //BEWARE: it may call blocking requests,
                //which in turn call think recursively!
                resumeMultistepProcedure(proc._id);
            }
        }

        //remove finished requests
        int k = 0;
        for (int i = 0; i < _requests.size(); i++) {
            if (!_requests[i]._finished)
                _requests[k++] = _requests[i];
        }
        _requests.resize(k);

        //remove finished multistep procedures
        k = 0;
        for (int i = 0; i < _multistepProcs.size(); i++) {
            if (_multistepProcs[i]._currentStep >= 0)
                _multistepProcs[k++] = _multistepProcs[i];
        }
        _multistepProcs.resize(k);
    }
}

bool AutomationEngine::isMultistepProcStillWaiting(const MultistepProcedure& proc, bool waitForPoll) const
{
    bool stillWaits = false;

    for (int j = 0; j < proc._waitForSeqnos.size() && !stillWaits; j++) {
        int waitSeqno = proc._waitForSeqnos[j];

        if (waitSeqno == SEQNO_WAIT_POLL) {
            if (waitForPoll)
                stillWaits = true;
        }
        else if (Request* req = findRequest(waitSeqno)) {
            if (!req->_finished)
                stillWaits = true;
        }
    }

    return stillWaits;
}

void AutomationEngine::resumeMultistepProcedure(int id)
{
    MultistepProcedure* proc;
    do {
        proc = findMultistepProc(id);
        assert(proc);

        if (proc->_currentStep < 0)
            break;  //finished

        auto ret = proc->_function(proc->_currentStep);

        proc->_currentStep = ret.nextStep;
        proc->_waitForSeqnos = ret.seqnoWaitList;
    }
    while (!isMultistepProcStillWaiting(*proc, true));
}

bool AutomationEngine::areInProgress(const std::vector<int>& reqSeqnos, const std::vector<int>& procIds)
{
    for (int seqno : reqSeqnos)
        if (Request* req = findRequest(seqno))
            if (!req->_finished)
                return true;
    for (int id : procIds)
        if (MultistepProcedure* proc = findMultistepProc(id))
            if (proc->_currentStep >= 0)
                return true;
    return false;
}

bool AutomationEngine::areTagsInProgress(int tagMask)
{
    for (int i = 0; i < _requests.size(); i++)
        if (tagMask & (1 << _requests[i]._tag))
            if (!_requests[i]._finished)
                return true;
    for (int i = 0; i < _multistepProcs.size(); i++)
        if (tagMask & (1 << _multistepProcs[i]._tag))
            if (_multistepProcs[i]._currentStep >= 0)
                return true;
    return false;
}

void AutomationEngine::wait(const std::vector<int>& reqSeqnos, const std::vector<int>& procIds)
{
    while (areInProgress(reqSeqnos, procIds)) {
        if (!isAlive())
            throw DisconnectException();
        think();
    }
}

void AutomationEngine::waitForTags(int tagMask)
{
    while (areTagsInProgress(tagMask)) {
        if (!isAlive())
            throw DisconnectException();
        think();
    }
}

std::string AutomationEngine::executeRequestBlocking(int tag, const std::string& request)
{
    Request* req = sendRequest(tag, request);
    int seqno = req->_seqno;

    std::string response;
    req->_callback = [this, seqno, &response](int num) {
        Request *req = findRequest(seqno);
        assert(num == seqno && req && req->_finished);
        response = req->_response;
    };

    wait({seqno}, {});

    return response;
}

int AutomationEngine::executeRequestAsync(int tag, const std::string& request, const std::function<void(int)>& callback)
{
    Request* req = sendRequest(tag, request);
    req->_callback = callback;
    return req->_seqno;
}

int AutomationEngine::executeMultistepProc(int tag, const std::function<MultistepProcReturn(int)>& function, int startStep)
{
    assert(tag < 31);
    MultistepProcedure proc;
    proc._id = ++_procIds;
    proc._tag = tag;
    proc._function = function;
    proc._currentStep = startStep;
    _multistepProcs.push_back(proc);
    return proc._id;
}

AutomationEngine::Request* AutomationEngine::findRequest(int seqno) const
{
    for (int i = 0; i < _requests.size(); i++) {
        if (_requests[i]._seqno == seqno)
            return const_cast<Request*>(&_requests[i]);
    }
    return nullptr;
}

AutomationEngine::MultistepProcedure* AutomationEngine::findMultistepProc(int id) const
{
    for (int i = 0; i < _multistepProcs.size(); i++) {
        if (_multistepProcs[i]._id == id)
            return const_cast<MultistepProcedure*>(&_multistepProcs[i]);
    }
    return nullptr;
}

std::string AutomationEngine::getResponse(int seqno) const
{
    const Request* req = findRequest(seqno);

    //TODO: perhaps we should simply keep finished requests in memory forever?...
    assert(req);
    if (!req)
        return "";

    assert(req->_finished);
    return req->_response;
}

}