forked from matth-x/MicroOcpp
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathRequestQueue.cpp
More file actions
408 lines (331 loc) · 13.1 KB
/
RequestQueue.cpp
File metadata and controls
408 lines (331 loc) · 13.1 KB
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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
// matth-x/MicroOcpp
// Copyright Matthias Akstaller 2019 - 2024
// MIT License
#include <limits>
#include <MicroOcpp/Core/RequestQueue.h>
#include <MicroOcpp/Core/Request.h>
#include <MicroOcpp/Core/Connection.h>
#include <MicroOcpp/Core/OcppError.h>
#include <MicroOcpp/Core/OperationRegistry.h>
#include <MicroOcpp/Operations/StatusNotification.h>
#include <MicroOcpp/Debug.h>
size_t removePayload(const char *src, size_t src_size, char *dst, size_t dst_size);
using namespace MicroOcpp;
VolatileRequestQueue::VolatileRequestQueue() : MemoryManaged("VolatileRequestQueue") {
}
VolatileRequestQueue::~VolatileRequestQueue() = default;
void VolatileRequestQueue::loop() {
/*
* Drop timed out operations
*/
size_t i = 0;
while (i < len) {
size_t index = (front + i) % MO_REQUEST_CACHE_MAXSIZE;
auto& request = requests[index];
if (request->isTimeoutExceeded()) {
MO_DBG_INFO("operation timeout: %s", request->getOperationType());
request->executeTimeout();
if (index == front) {
requests[front].reset();
front = (front + 1) % MO_REQUEST_CACHE_MAXSIZE;
len--;
} else {
requests[index].reset();
for (size_t i = (index + MO_REQUEST_CACHE_MAXSIZE - front) % MO_REQUEST_CACHE_MAXSIZE; i < len - 1; i++) {
requests[(front + i) % MO_REQUEST_CACHE_MAXSIZE] = std::move(requests[(front + i + 1) % MO_REQUEST_CACHE_MAXSIZE]);
}
len--;
}
} else {
i++;
}
}
}
unsigned int VolatileRequestQueue::getFrontRequestOpNr() {
if (len == 0) {
return NoOperation;
}
return 1; //return OpNr 1 to grant PreBoot queue higher priority (=0), but send messages before tx-msg queue (starting with 10)
}
std::unique_ptr<Request> VolatileRequestQueue::fetchFrontRequest() {
if (len == 0) {
return nullptr;
}
std::unique_ptr<Request> result = std::move(requests[front]);
front = (front + 1) % MO_REQUEST_CACHE_MAXSIZE;
len--;
MO_DBG_VERBOSE("front %zu len %zu", front, len);
return result;
}
bool VolatileRequestQueue::pushRequestBack(std::unique_ptr<Request> request) {
// Don't queue up multiple StatusNotification messages for the same connectorId
#if 0 // Leads to ASAN failure when executed by Unit test suite (CustomOperation is casted to StatusNotification)
if (strcmp(request->getOperationType(), "StatusNotification") == 0)
{
size_t i = 0;
while (i < len) {
size_t index = (front + i) % MO_REQUEST_CACHE_MAXSIZE;
if (strcmp(requests[index]->getOperationType(), "StatusNotification")!= 0)
{
i++;
continue;
}
auto new_status_notification = static_cast<Ocpp16::StatusNotification*>(request->getOperation());
auto old_status_notification = static_cast<Ocpp16::StatusNotification*>(requests[index]->getOperation());
if (old_status_notification->getConnectorId() == new_status_notification->getConnectorId()) {
requests[index].reset();
for (size_t i = (index + MO_REQUEST_CACHE_MAXSIZE - front) % MO_REQUEST_CACHE_MAXSIZE; i < len - 1; i++) {
requests[(front + i) % MO_REQUEST_CACHE_MAXSIZE] = std::move(requests[(front + i + 1) % MO_REQUEST_CACHE_MAXSIZE]);
}
len--;
} else {
i++;
}
}
}
#endif
if (len >= MO_REQUEST_CACHE_MAXSIZE) {
MO_DBG_INFO("Drop cached operation (cache full): %s", requests[front]->getOperationType());
requests[front]->executeTimeout();
requests[front].reset();
front = (front + 1) % MO_REQUEST_CACHE_MAXSIZE;
len--;
}
requests[(front + len) % MO_REQUEST_CACHE_MAXSIZE] = std::move(request);
len++;
return true;
}
RequestQueue::RequestQueue(Connection& connection, OperationRegistry& operationRegistry)
: MemoryManaged("RequestQueue"), connection(connection), operationRegistry(operationRegistry) {
ReceiveTXTcallback callback = [this] (const char *payload, size_t length) {
return this->receiveMessage(payload, length);
};
connection.setReceiveTXTcallback(callback);
memset(sendQueues, 0, sizeof(sendQueues));
addSendQueue(&defaultSendQueue);
}
void RequestQueue::loop() {
/*
* Check if front request timed out
*/
if (sendReqFront && sendReqFront->isTimeoutExceeded()) {
MO_DBG_INFO("operation timeout: %s", sendReqFront->getOperationType());
sendReqFront->executeTimeout();
sendReqFront.reset();
}
if (recvReqFront && recvReqFront->isTimeoutExceeded()) {
MO_DBG_INFO("operation timeout: %s", recvReqFront->getOperationType());
recvReqFront->executeTimeout();
recvReqFront.reset();
}
defaultSendQueue.loop();
if (!connection.isConnected()) {
return;
}
/**
* Send and dequeue a pending confirmation message, if existing
*
* If a message has been sent, terminate this loop() function.
*/
if (!recvReqFront) {
recvReqFront = recvQueue.fetchFrontRequest();
}
if (recvReqFront) {
auto response = initJsonDoc(getMemoryTag());
auto ret = recvReqFront->createResponse(response);
if (ret == Request::CreateResponseResult::Success) {
auto out = makeString(getMemoryTag());
serializeJson(response, out);
bool success = connection.sendTXT(out.c_str(), out.length());
if (success) {
MO_DBG_TRAFFIC_OUT(out.c_str());
recvReqFront.reset();
}
return;
} //else: There will be another attempt to send this conf message in a future loop call
}
/**
* Send pending req message
*/
if (!sendReqFront) {
unsigned int minOpNr = RequestEmitter::NoOperation;
size_t index = MO_NUM_REQUEST_QUEUES;
for (size_t i = 0; i < MO_NUM_REQUEST_QUEUES && sendQueues[i]; i++) {
auto opNr = sendQueues[i]->getFrontRequestOpNr();
if (opNr < minOpNr) {
minOpNr = opNr;
index = i;
}
}
if (index < MO_NUM_REQUEST_QUEUES) {
sendReqFront = sendQueues[index]->fetchFrontRequest();
}
}
if (sendReqFront && !sendReqFront->isRequestSent()) {
auto request = initJsonDoc(getMemoryTag());
auto ret = sendReqFront->createRequest(request);
if (ret == Request::CreateRequestResult::Success) {
//send request
auto out = makeString(getMemoryTag());
serializeJson(request, out);
bool success = connection.sendTXT(out.c_str(), out.length());
if (success) {
MO_DBG_TRAFFIC_OUT(out.c_str());
sendReqFront->setRequestSent(); //mask as sent and wait for response / timeout
}
return;
}
}
}
void RequestQueue::sendRequest(std::unique_ptr<Request> op){
defaultSendQueue.pushRequestBack(std::move(op));
}
void RequestQueue::sendRequestPreBoot(std::unique_ptr<Request> op){
if (!preBootSendQueue) {
MO_DBG_ERR("did not set PreBoot queue");
return;
}
preBootSendQueue->pushRequestBack(std::move(op));
}
void RequestQueue::addSendQueue(RequestEmitter* sendQueue) {
for (size_t i = 0; i < MO_NUM_REQUEST_QUEUES; i++) {
if (!sendQueues[i]) {
sendQueues[i] = sendQueue;
return;
}
}
MO_DBG_ERR("exceeded sendQueue capacity");
}
void RequestQueue::setPreBootSendQueue(VolatileRequestQueue *preBootQueue) {
this->preBootSendQueue = preBootQueue;
addSendQueue(preBootQueue);
}
unsigned int RequestQueue::getNextOpNr() {
return nextOpNr++;
}
bool RequestQueue::receiveMessage(const char* payload, size_t length) {
MO_DBG_TRAFFIC_IN((int) length, payload);
size_t capacity_init = (3 * length) / 2;
//capacity = ceil capacity_init to the next power of two; should be at least 128
size_t capacity = 128;
while (capacity < capacity_init && capacity < MO_MAX_JSON_CAPACITY) {
capacity *= 2;
}
if (capacity > MO_MAX_JSON_CAPACITY) {
capacity = MO_MAX_JSON_CAPACITY;
}
auto doc = initJsonDoc(getMemoryTag());
DeserializationError err = DeserializationError::NoMemory;
while (err == DeserializationError::NoMemory && capacity <= MO_MAX_JSON_CAPACITY) {
doc = initJsonDoc(getMemoryTag(), capacity);
err = deserializeJson(doc, payload, length);
capacity *= 2;
}
bool success = false;
switch (err.code()) {
case DeserializationError::Ok: {
int messageTypeId = doc[0] | -1;
if (messageTypeId == MESSAGE_TYPE_CALL) {
receiveRequest(doc.as<JsonArray>());
success = true;
} else if (messageTypeId == MESSAGE_TYPE_CALLRESULT ||
messageTypeId == MESSAGE_TYPE_CALLERROR) {
receiveResponse(doc.as<JsonArray>());
success = true;
} else {
MO_DBG_WARN("Invalid OCPP message! (though JSON has successfully been deserialized)");
}
break;
}
case DeserializationError::InvalidInput:
MO_DBG_WARN("Invalid input! Not a JSON");
break;
case DeserializationError::NoMemory: {
MO_DBG_WARN("incoming operation exceeds buffer capacity. Input length = %zu, max capacity = %d", length, MO_MAX_JSON_CAPACITY);
/*
* If websocket input is of message type MESSAGE_TYPE_CALL, send back a message of type MESSAGE_TYPE_CALLERROR.
* Then the communication counterpart knows that this operation failed.
* If the input type is MESSAGE_TYPE_CALLRESULT, then abort the operation to avoid getting stalled.
*/
doc = initJsonDoc(getMemoryTag(), 200);
char onlyRpcHeader[200];
size_t onlyRpcHeader_len = removePayload(payload, length, onlyRpcHeader, sizeof(onlyRpcHeader));
DeserializationError err2 = deserializeJson(doc, onlyRpcHeader, onlyRpcHeader_len);
if (err2.code() == DeserializationError::Ok) {
int messageTypeId = doc[0] | -1;
if (messageTypeId == MESSAGE_TYPE_CALL) {
success = true;
auto op = makeRequest(new MsgBufferExceeded(MO_MAX_JSON_CAPACITY, length));
receiveRequest(doc.as<JsonArray>(), std::move(op));
} else if (messageTypeId == MESSAGE_TYPE_CALLRESULT ||
messageTypeId == MESSAGE_TYPE_CALLERROR) {
success = true;
MO_DBG_WARN("crop incoming response");
receiveResponse(doc.as<JsonArray>());
}
}
break;
}
default:
MO_DBG_WARN("Deserialization failed: %s", err.c_str());
break;
}
return success;
}
/**
* call conf() on each element of the queue. Start with first element. On successful message delivery,
* delete the element from the list. Try all the pending OCPP Operations until the right one is found.
*
* This function could result in improper behavior in Charging Stations, because messages are not
* guaranteed to be received and therefore processed in the right order.
*/
void RequestQueue::receiveResponse(JsonArray json) {
if (!sendReqFront || !sendReqFront->receiveResponse(json)) {
MO_DBG_WARN("Received response doesn't match pending operation");
}
sendReqFront.reset();
}
void RequestQueue::receiveRequest(JsonArray json) {
auto op = operationRegistry.deserializeOperation(json[2] | "UNDEFINED");
if (op == nullptr) {
MO_DBG_WARN("OOM");
return;
}
receiveRequest(json, std::move(op));
}
void RequestQueue::receiveRequest(JsonArray json, std::unique_ptr<Request> op) {
op->receiveRequest(json); //execute the operation
recvQueue.pushRequestBack(std::move(op)); //enqueue so loop() plans conf sending
}
/*
* Tries to recover the Ocpp-Operation header from a broken message.
*
* Example input:
* [2, "75705e50-682d-404e-b400-1bca33d41e19", "ChangeConfiguration", {"key":"now the message breaks...
*
* The Json library returns an error code when trying to deserialize that broken message. This
* function searches for the first occurence of the character '{' and writes "}]" after it.
*
* Example output:
* [2, "75705e50-682d-404e-b400-1bca33d41e19", "ChangeConfiguration", {}]
*
*/
size_t removePayload(const char *src, size_t src_size, char *dst, size_t dst_size) {
size_t res_len = 0;
for (size_t i = 0; i < src_size && i < dst_size-3; i++) {
if (src[i] == '\0'){
//no payload found within specified range. Cancel execution
break;
}
dst[i] = src[i];
if (src[i] == '{') {
dst[i+1] = '}';
dst[i+2] = ']';
res_len = i+3;
break;
}
}
dst[res_len] = '\0';
res_len++;
return res_len;
}