2.12.2021, 9:00 - 11:00: Due to updates GitLab may be unavailable for some minutes between 09:00 and 11:00.

simplemqttserverthread.cpp 19.5 KB
Newer Older
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
//================================================================================
// Name        : simplemqttserverthread.cpp
// Author      : Axel Auweter
// Copyright   : Leibniz Supercomputing Centre
// Description : Implementation of classes for running MQTT server threads
//================================================================================

//================================================================================
// This file is part of DCDB (DataCenter DataBase)
// Copyright (C) 2011-2016 Leibniz Supercomputing Centre
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
//================================================================================
26
27

#include "simplemqttserver.h"
28
#include "abrt.h"
29
#include "messaging.h"
30
31

using namespace std;
32
using namespace boost::system;
33
34
35
36
37

#ifdef SimpleMQTTVerbose
static boost::mutex coutMtx;
#endif

38
39
static boost::mutex launchMtx;

40
41
42
43
44
45
46
47
48
SimpleMQTTServerThread::SimpleMQTTServerThread()
{
  /*
   * Start the thread at the 'launch' function. The 'launch'
   * function will take care of calling the child-specific
   * 'run' function which contains the thread's main loop.
   *
   * Special care must be taken not to call the run function
   * before the child has gone through its constructor. Thus,
49
50
51
52
53
54
55
56
57
58
59
60
   * we lock a mutex (launchMtx) that will cause the 'launch'
   * function to  wait until the mutex is released by the
   * child's constructor.
   *
   * A second mutex (cleanupMtx) is held to allow others to
   * wait for a thread to return from its child-specific
   * 'run' function. This is necessary for cases where the
   * child class has local objects that can only be destroyed
   * after the 'run' function has finished (to avoid access
   * to these objects in the 'run'function after destroying
   * them). In such cases, the child class destructor can try
   * to obtain the mutex in the destructor.
61
   */
62
63
  launchMtx.lock();
  cleanupMtx.lock();
64
65
66

  terminate = false;
  if (pthread_create(&t, NULL, launch, this) != 0) {
67
      LOG(error) << "Error creating new MQTT server thread.";
68
      abrt(EXIT_FAILURE, INTERR);
69
70
71
72
  }

#ifdef SimpleMQTTVerbose
  coutMtx.lock();
73
  cout << "Started Thread (" << hex << t << ") of class (" << this << ")...\n";
74
75
76
77
78
79
80
81
82
83
84
85
  coutMtx.unlock();
#endif
}

SimpleMQTTServerThread::~SimpleMQTTServerThread()
{
  /*
   * Terminate the thread and join it to ensure proper
   * thread termination before the class is destroyed.
   */
  terminate = true;
  if (pthread_join(t, NULL) != 0) {
86
      LOG(error) << "Error joining thread.";
87
      abrt(EXIT_FAILURE, INTERR);
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
  }

#ifdef SimpleMQTTVerbose
  coutMtx.lock();
  cout << "Terminated Thread (" << t << ") of class (" << this << ")...\n";
  coutMtx.unlock();
#endif
}

void* SimpleMQTTServerThread::launch(void *selfPtr)
{
#ifdef SimpleMQTTVerbose
  coutMtx.lock();
  cout << "Running launcher for class (" << selfPtr << ")...\n";
  coutMtx.unlock();
#endif

  /*
   * The following lines guard the run function to be called
   * before the constructor of the child class has finished.
   * The lock is released at the end of the child's constructor.
   */
110
111
  launchMtx.lock();
  launchMtx.unlock();
112
113
114
115
116
117

  /*
   * Call the child's run function...
   */
  ((SimpleMQTTServerThread*)selfPtr)->run();

118
119
120
121
122
  /*
   * The thread will terminate. Unlock the cleanupMtx...
   */
  ((SimpleMQTTServerThread*)selfPtr)->cleanupMtx.unlock();

123
124
125
  return NULL;
}

126
127
128
129
130
131
132
133
134
135
136
void SimpleMQTTServerThread::yield()
{
  /*
   * Yield this thread's execution to give way to other threads.
   * This is being used in the SimpleMQTTServer to allow the
   * accept thread acquiring the fdsMtx lock. Otherwise, in
   * particular on single-CPU systems (or when the acceptThread
   * and the messageThread share a core), waiting connections
   * may have to wait a long time before the lock will be given
   * to the acceptThread.
   */
137
  boost::this_thread::yield();
138
139
}

140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
void SimpleMQTTServerAcceptThread::run()
{
#ifdef SimpleMQTTVerbose
  coutMtx.lock();
  cout << "Running SimpleMQTTServerAcceptThread for socket " << socket << "...\n";
  coutMtx.unlock();
#endif

  int newsock = -1;
  struct pollfd fd;

  while (!terminate) {
      /*
       * Wait for something to happen on the socket...
       */
      fd.fd = socket;
      fd.events = POLLIN | POLLPRI;
      fd.revents = 0;
      if(poll(&fd, 1, SimpleMQTTPollTimeout) > 0 && (fd.revents & (POLLIN | POLLPRI))) {
159
160
161
162
163
164
165
166
167
168
169
170
          /*
           * Take the next incoming connection.
           */
#ifdef SimpleMQTTVerbose
          coutMtx.lock();
          cout << "Thread (" << this << ") waiting in accept()...\n";
          coutMtx.unlock();
#endif
          newsock = accept(socket, NULL, 0);
          if (newsock != -1) {
              int opt = fcntl(newsock, F_GETFL, 0);
              if (opt == -1 || fcntl(newsock, F_SETFL, opt | O_NONBLOCK)==-1) {
171
#ifdef SimpleMQTTVerbose
172
173
174
                coutMtx.lock();
                cout << "Setting socket to non-blocking in thread (" << this << ") failed for socket " << newsock << "...\n";
                coutMtx.unlock();
175
#endif
176
177
                close(newsock);
              } else {
178
#ifdef SimpleMQTTVerbose
179
180
181
                    coutMtx.lock();
                    cout << "Successfully set socket " << newsock << " non-blocking in thread (" << this << ")...\n";
                    coutMtx.unlock();
182
#endif
183
184
185
186
                  if (messageThreads.size() < this->_maxThreads) {
                      // Spawning new threads, if not exceeding maximum thread pool size
                      messageThreads.push_back(new SimpleMQTTServerMessageThread(messageCallback, this->_maxConnPerThread));
                      messageThreads.back()->queueConnection(newsock);
187
                  }
188
189
190
191
192
193
194
195
196
197
198
199
200
                  else {
                      // If thread pool is full, we cycle through it to find any available threads to connect to
                      unsigned int ctr=0;
                      do {
                          // Rotating the thread queue to ensure round-robin scheduling
                          threadCtr = (threadCtr + 1) % messageThreads.size();
                      } while(ctr++ < messageThreads.size() && messageThreads[threadCtr]->queueConnection(newsock));

                      if(ctr > messageThreads.size()) {
                          LOG(warning) << "Socket " << socket << " cannot accept more connections.";
                          // FIXME: There must be nicer ways to handle such situations...
                          close(newsock);
                      }
201
#ifdef SimpleMQTTVerbose
202
203
204
205
206
                      else {
                          coutMtx.lock();
                          cout << "Found a message thread with capacity: " << messageThreads.front() << "\n";
                          coutMtx.unlock();
                      }
207
#endif
208
                  }
209
              }
210
            }
211
#ifdef SimpleMQTTVerbose
212
213
214
215
216
            else {
              coutMtx.lock();
              cout << "Accept() in thread (" << this << ") returned -1...\n";
              coutMtx.unlock();
            }
217
#endif
218
219
220
221
      }
  }
}

222
void SimpleMQTTServerAcceptThread::setMessageCallback(SimpleMQTTMessageCallback callback)
223
{
224
225
226
227
228
  /*
   * Set the function that will be called for each received
   * MQTT message and propagate to all message threads.
   */
  messageCallback = callback;
229
230
  for (std::vector<SimpleMQTTServerMessageThread*>::iterator i = messageThreads.begin(); i != messageThreads.end(); i++) {
      (*i)->setMessageCallback(callback);
231
232
233
  }
}

234
SimpleMQTTServerAcceptThread::SimpleMQTTServerAcceptThread(int listenSock, SimpleMQTTMessageCallback callback, uint64_t maxThreads, uint64_t maxConnPerThread)
235
236
237
238
{
  /*
   * Assign socket and message callback.
   */
239
240
  this->_maxThreads = maxThreads;
  this->_maxConnPerThread = maxConnPerThread;
241
  socket = listenSock;
242
  messageCallback = callback;
243
  threadCtr = 0;
244
245
246
247
248

  /*
   * Release the lock to indicate that the constructor has
   * finished. This causes the launcher to call the run function.
   */
249
  launchMtx.unlock();
250
251
}

252
253
254
255
256
257
258
259
260
261
SimpleMQTTServerAcceptThread::~SimpleMQTTServerAcceptThread() {
    terminate = true;

    cleanupMtx.lock();
    cleanupMtx.unlock();

    //De-allocating and destroying running message threads
    for(auto t : messageThreads)
        delete t;
    messageThreads.clear();
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
int SimpleMQTTServerMessageThread::sendAck(int connectionId) {
  uint8_t buf[] = {0, 0, 0, 0};
  switch(msg[connectionId]->getType()) {
    case MQTT_CONNECT: {
      buf[0] = MQTT_CONNACK << 4;
      buf[1] = 2;
      break;
    }
    case MQTT_PUBLISH: {
      if (msg[connectionId]->getQoS() == 0) {
        return 1;
      } else {
        if (msg[connectionId]->getQoS() == 1) {
          buf[0] = MQTT_PUBACK << 4;
        } else {
          buf[0] = MQTT_PUBREC << 4;
        }
        buf[1] = 2;
        uint16_t msgId = htons(msg[connectionId]->getMsgId());
        buf[2] = ((uint8_t*)&msgId)[0];
        buf[3] = ((uint8_t*)&msgId)[1];
      }
      break;
    }
    case MQTT_PUBREL: {
      buf[0] = MQTT_PUBCOMP << 4;
      buf[1] = 2;
      uint16_t msgId = htons(msg[connectionId]->getMsgId());
      buf[2] = ((uint8_t*)&msgId)[0];
      buf[3] = ((uint8_t*)&msgId)[1];
      break;
    }
296
    case MQTT_PINGREQ: {
297
298
299
300
301
302
303
304
305
306
      buf[0] = MQTT_PINGRESP << 4;
      buf[1] = 0;
      break;
    }
    default:
      return 1;
  }
  return !(write(fds[connectionId].fd, buf, buf[1]+2) == buf[1]+2);
}

307
308
309
310
311
312
313
314
315
void SimpleMQTTServerMessageThread::run()
{
#ifdef SimpleMQTTVerbose
  coutMtx.lock();
  cout << "Running SimpleMQTTServerMessageThread (" << this << ")...\n";
  coutMtx.unlock();
#endif

  int numfds = -1;
316
  char inbuf[SimpleMQTTReadBufferSize];
317
318
319

  while (!terminate) {
      /*
320
       * Check for pending connections
321
       */
322
      assignConnections();
323

324
      /*
325
       * Check for activity on our sockets...
326
       */
327
      numfds = poll(fds, this->_maxConnPerThread, SimpleMQTTPollTimeout);
328

329
      if (numfds == -1)
330
          throw new boost::system::system_error(errno, boost::system::system_category(), "Error in poll().");
331
332
333
334
335

      /*
       * Apparently, there is work to do...
       */
      if (numfds > 0) {
336
          for (unsigned connectionId=0; connectionId<this->_maxConnPerThread; connectionId++) {
337
338
339
              if (fds[connectionId].fd != -1) {
#ifdef SimpleMQTTVerbose
                  coutMtx.lock();
340
                  cout << "fd(" << fds[connectionId].fd << ") revents: " << hex << fds[connectionId].revents << dec << "\n";
341
342
                  coutMtx.unlock();
#endif
343
344
345
346
                  /* Remote side hung up */
                  if (fds[connectionId].revents & POLLHUP) {
                      releaseConnection(connectionId);
                  }
347

348
                  if (fds[connectionId].revents & POLLIN) {
349
350
351
352
353
354
355
                      char* readPtr;
                      ssize_t rbytes, lbytes, bytes;

                      rbytes = read(fds[connectionId].fd, inbuf, SimpleMQTTReadBufferSize);

                      readPtr = inbuf;
                      lbytes = rbytes;
356
357

                      /*
358
                       * If read() returns 0, the connection was closed on the
359
360
                       * remote side. In this case, release it from our list.
                       */
361
                      if (rbytes == 0) {
362
363
                          releaseConnection(connectionId);
                      }
364
365
366
367
368
369
370
371

                      while (lbytes > 0) {
                          /*
                           * Allocate new message if there is none.
                           */
                          if (!msg[connectionId]) {
                              msg[connectionId] = new SimpleMQTTMessage();
                              if (!msg[connectionId]) {
372
                                  LOG(warning) << "Out of memory! Discarding network input!";
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
                                  continue;
                              }
#ifdef SimpleMQTTVerbose
                              coutMtx.lock();
                              cout << "Allocated new SimpleMQTTMessage (" << msg[connectionId] << ")...\n";
                              coutMtx.unlock();
#endif
                          }

                          /*
                           * Append received data to message.
                           */
                          bytes = msg[connectionId]->appendRawData(readPtr, lbytes);
                          readPtr += bytes;
                          lbytes -= bytes;

                          /*
                           * Check if message is complete.
                           */
                          if (msg[connectionId]->complete()) {
                              /*
394
395
396
397
                               * Forward message upstream!
                               * If there is a callback function, it is responsible
                               * for freeing the message using delete. Otherwise, we
                               * have to take care of this, here.
398
399
400
401
402
403
                               */
#ifdef SimpleMQTTVerbose
                              coutMtx.lock();
                              cout << "Completed receiving SimpleMQTTMessage (" << msg[connectionId] << ")...\n";
                              coutMtx.unlock();
#endif
404
405
                            switch(msg[connectionId]->getType()) {
                              case MQTT_CONNECT: {
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
                                sendAck(connectionId);
                                break;
                              }
                              case MQTT_PUBLISH: {
                                if ((messageCallback(msg[connectionId]) == 0) && (msg[connectionId]->getQoS() > 0)) {
                                  sendAck(connectionId);
                                }
                                break;
                              }
                              case MQTT_PUBREL: {
                                sendAck(connectionId);
                                break;
                              }
                              case MQTT_PINGREQ: {
                                sendAck(connectionId);
421
422
423
424
425
                                break;
                              }
                              case MQTT_DISCONNECT: {
                                releaseConnection(connectionId);
                                break;
426
                              }
427
428
429
430
431
                              default: {
                                if (messageCallback) {
                                  messageCallback(msg[connectionId]);
                                }
                                else {
432
                                  LOG(trace) << "Nothing to do..";
433
434
                                }
                                break;
435
                              }
436
                            }
437
438
                            if(msg[connectionId])
                                msg[connectionId]->clear();
439
440
                          }
                      }
441
442
443
444
445
446
447
                  }
              }
          }
      }
  }
}

448
int SimpleMQTTServerMessageThread::queueConnection(int newsock) {
449
  if (numConnections >= this->_maxConnPerThread) {
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
#ifdef SimpleMQTTVerbose
      coutMtx.lock();
      cout << "Maximum number of connections reached, rejecting new connection  (" << this << ", " << newsock << ", " << numConnections << ")...\n";
      coutMtx.unlock();
#endif
    return 2;
  }

  int nextWritePos = (fdQueueWritePos + 1) % SimpleMQTTConnectionsQueueLength;
  if (nextWritePos == fdQueueReadPos) {
#ifdef SimpleMQTTVerbose
    coutMtx.lock();
    cout << "Queue is full, rejecting new connection  (" << this << ", " << newsock << ", " << fdQueueWritePos << ")...\n";
    coutMtx.unlock();
#endif
    return 1;
  }

#ifdef SimpleMQTTVerbose
  coutMtx.lock();
  cout << "Queued new connection  (" << this << ", " << newsock << ", " << fdQueueWritePos << ")...\n";
  coutMtx.unlock();
#endif
  fdQueue[fdQueueWritePos] = newsock;
  fdQueueWritePos = nextWritePos;
  return 0;
476
477
}

478
void SimpleMQTTServerMessageThread::assignConnections()
479
480
481
482
{
  /*
   * Find the first free slot in fds and assign connection.
   */
483
484
  while (fdQueueWritePos != fdQueueReadPos) {
    /* There is no free fd slot at the moment, defer.. */
485
    if (numConnections >= this->_maxConnPerThread) {
486
487
      return;
    }
488

489
    for (unsigned i=0; i<this->_maxConnPerThread; i++) {
490
491
492
493
494
495
      if (fds[i].fd == -1) {
        fds[i].events = POLLIN | POLLPRI | POLLHUP;
        fds[i].revents = 0;
        fds[i].fd = fdQueue[fdQueueReadPos];
        numConnections++;
        fdQueueReadPos = (fdQueueReadPos + 1) % SimpleMQTTConnectionsQueueLength;
496

497
#ifdef SimpleMQTTVerbose
498
499
500
        coutMtx.lock();
        cout << "Assigned connection  (" << this << ", " << i << ", " << fds[i].fd << ")...\n";
        coutMtx.unlock();
501
#endif
502
        break;
503
      }
504
    }
505
506
507
508
509
510
511
512
  }
}

void SimpleMQTTServerMessageThread::releaseConnection(int connectionId)
{
  /*
   * Close the connection an clean up.
   */
513
  shutdown(fds[connectionId].fd, SHUT_RDWR);
514
515
516
517
  close(fds[connectionId].fd);
  fds[connectionId].fd = -1;
  fds[connectionId].events = 0;
  fds[connectionId].revents = 0;
518
519
520
521
  if (msg[connectionId]) {
      delete msg[connectionId];
      msg[connectionId] = NULL;
  }
522
  numConnections--;
523
524
525
526
527
528

#ifdef SimpleMQTTVerbose
  coutMtx.lock();
  cout << "Released connection  (" << this << ", " << connectionId << ")...\n";
  coutMtx.unlock();
#endif
529
530
}

531
532
533
534
535
void SimpleMQTTServerMessageThread::setMessageCallback(SimpleMQTTMessageCallback callback)
{
  messageCallback = callback;
}

536
SimpleMQTTServerMessageThread::SimpleMQTTServerMessageThread(SimpleMQTTMessageCallback callback, uint64_t maxConnPerThread)
537
{
538
539
540
541
542
543
#ifdef SimpleMQTTVerbose
  coutMtx.lock();
  cout << "Created new MessageThread (" << (void*)this << ")\n";
  coutMtx.unlock();
#endif

544
545
546
547
  this->_maxConnPerThread = maxConnPerThread;
  this->fds = new struct pollfd[this->_maxConnPerThread];
  this->msg = new SimpleMQTTMessage*[this->_maxConnPerThread];

548
549
550
551
  /*
   * Clear the fds array. Warning: This will only work when the
   * size of the fds array is determined at compile time.
   */
552
  memset(fds, -1, sizeof(fds[0]) * this->_maxConnPerThread);
553

Axel Auweter's avatar
Axel Auweter committed
554
555
556
557
  /*
   * Clear the msg array. Warning: This will only work when the
   * size of the msg array is determined at compile time.
   */
558
  memset(msg, 0, sizeof(msg[0]) * this->_maxConnPerThread);
Axel Auweter's avatar
Axel Auweter committed
559

560
  /*
561
562
   * Initialize the number of active connections to 0 and set
   * the messageCallback function.
563
564
   */
  numConnections = 0;
565
  messageCallback = callback;
566

567
568
569
570
571
572
573
  /*
   * Initialize the fd queue for new connections
   */
  fdQueue = new(int[SimpleMQTTConnectionsQueueLength]);
  fdQueueReadPos = 0;
  fdQueueWritePos = 0;

574
575
576
577
  /*
   * Release the lock to indicate that the constructor has
   * finished. This causes the launcher to call the run function.
   */
578
  launchMtx.unlock();
579
580
581
582
}

SimpleMQTTServerMessageThread::~SimpleMQTTServerMessageThread()
{
583
584
585
586
587
588
589
590
591
592
593
  /*
   * When this destructor is called externally, we are likely
   * holding the fdsMtx mutex and waiting in poll().
   * Terminate the thread from here and acquire cleanupMtx to
   * ensure that the thread's 'run' function has terminated in
   * order to avoid fdsMtx to be accessed after destruction.
   */
  terminate = true;

  cleanupMtx.lock();
  cleanupMtx.unlock();
594
595
596
597
598
599

  delete[] fdQueue;
  for(unsigned i=0; i<_maxConnPerThread; i++)
      delete msg[i];
  delete[] msg;
  delete[] fds;
600
601
}