Currently job artifacts in CI/CD pipelines on LRZ GitLab never expire. Starting from Wed 26.1.2022 the default expiration time will be 30 days (GitLab default). Currently existing artifacts in already completed jobs will not be affected by the change. The latest artifacts for all jobs in the latest successful pipelines will be kept. More information: https://gitlab.lrz.de/help/user/admin_area/settings/continuous_integration.html#default-artifacts-expiration

simplemqttserverthread.cpp 16.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
67

  terminate = false;
  if (pthread_create(&t, NULL, launch, this) != 0) {
      cout << "Error creating new MQTT server thread.\n";
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
86
  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) {
      cout << "Error joining thread.\n";
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
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
                coutMtx.lock();
                cout << "Successfully set socket " << newsock << " non-blocking in thread (" << this << ")...\n";
                coutMtx.unlock();
#endif
                /*
                 * Find a free message thread to take over
                 * the next incoming connection.
                 */
                boost::ptr_list<SimpleMQTTServerMessageThread>::iterator mt = messageThreads.begin();
                while ((mt != messageThreads.end()) && mt->queueConnection(newsock)) {
                  mt++;
                }

                if (mt == messageThreads.end()) {
                  /*
                   * In case no free message thread was found,
                   * try to create a new one as long as we do
                   * not exceed the maximum.
                   */
                  if (messageThreads.size() >= SimpleMQTTMaxThreadsPerSocket) {
                    cout << "Warning: socket " << socket << " cannot accept more connections.\n";
                    // FIXME: There must be nicer ways to handle such situations...
                    close(newsock);
                    break;
                  }
                  messageThreads.push_back(new SimpleMQTTServerMessageThread(messageCallback));
                  messageThreads.back().queueConnection(newsock);
                }
#ifdef SimpleMQTTVerbose
                else {
                  coutMtx.lock();
                  cout << "Found a message thread with capacity: " << &*mt << "\n";
                  coutMtx.unlock();
                }
213
#endif
214
              }
215
            }
216
#ifdef SimpleMQTTVerbose
217
218
219
220
221
            else {
              coutMtx.lock();
              cout << "Accept() in thread (" << this << ") returned -1...\n";
              coutMtx.unlock();
            }
222
#endif
223
224
225
226
      }
  }
}

227
void SimpleMQTTServerAcceptThread::setMessageCallback(SimpleMQTTMessageCallback callback)
228
{
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
  /*
   * Set the function that will be called for each received
   * MQTT message and propagate to all message threads.
   */
  messageCallback = callback;
  for (boost::ptr_list<SimpleMQTTServerMessageThread>::iterator i = messageThreads.begin(); i != messageThreads.end(); i++) {
      (*i).setMessageCallback(callback);
  }
}

SimpleMQTTServerAcceptThread::SimpleMQTTServerAcceptThread(int listenSock, SimpleMQTTMessageCallback callback)
{
  /*
   * Assign socket and message callback.
   */
244
  socket = listenSock;
245
  messageCallback = callback;
246
247
248
249
250

  /*
   * Release the lock to indicate that the constructor has
   * finished. This causes the launcher to call the run function.
   */
251
  launchMtx.unlock();
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
}

SimpleMQTTServerAcceptThread::~SimpleMQTTServerAcceptThread()
{
}

void SimpleMQTTServerMessageThread::run()
{
#ifdef SimpleMQTTVerbose
  coutMtx.lock();
  cout << "Running SimpleMQTTServerMessageThread (" << this << ")...\n";
  coutMtx.unlock();
#endif

  int numfds = -1;
267
  char inbuf[SimpleMQTTReadBufferSize];
268
269
270

  while (!terminate) {
      /*
271
       * Check for pending connections
272
       */
273
      assignConnections();
274

275
      /*
276
       * Check for activity on our sockets...
277
       */
278
      numfds = poll(fds, SimpleMQTTConnectionsPerThread, SimpleMQTTPollTimeout);
279

280
      if (numfds == -1)
281
          throw new boost::system::system_error(errno, boost::system::system_category(), "Error in poll().");
282
283
284
285
286
287

      /*
       * Apparently, there is work to do...
       */
      if (numfds > 0) {
          for (int connectionId=0; connectionId<SimpleMQTTConnectionsPerThread; connectionId++) {
288
289
290
              if (fds[connectionId].fd != -1) {
#ifdef SimpleMQTTVerbose
                  coutMtx.lock();
291
                  cout << "fd(" << fds[connectionId].fd << ") revents: " << hex << fds[connectionId].revents << dec << "\n";
292
293
                  coutMtx.unlock();
#endif
294
295
296
297
                  /* Remote side hung up */
                  if (fds[connectionId].revents & POLLHUP) {
                      releaseConnection(connectionId);
                  }
298

299
                  if (fds[connectionId].revents & POLLIN) {
300
301
302
303
304
305
306
                      char* readPtr;
                      ssize_t rbytes, lbytes, bytes;

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

                      readPtr = inbuf;
                      lbytes = rbytes;
307
308

                      /*
309
                       * If read() returns 0, the connection was closed on the
310
311
                       * remote side. In this case, release it from our list.
                       */
312
                      if (rbytes == 0) {
313
314
                          releaseConnection(connectionId);
                      }
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

                      while (lbytes > 0) {
                          /*
                           * Allocate new message if there is none.
                           */
                          if (!msg[connectionId]) {
                              msg[connectionId] = new SimpleMQTTMessage();
                              if (!msg[connectionId]) {
                                  cout << "Warning: Out of memory! Discarding network input!\n";
                                  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()) {
                              /*
345
346
347
348
                               * 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.
349
350
351
352
353
354
                               */
#ifdef SimpleMQTTVerbose
                              coutMtx.lock();
                              cout << "Completed receiving SimpleMQTTMessage (" << msg[connectionId] << ")...\n";
                              coutMtx.unlock();
#endif
355
356
357
358
359
360
                              if (messageCallback) {
                                  messageCallback(msg[connectionId]);
                              }
                              else {
                                  delete msg[connectionId];
                              }
361
362
363
                              msg[connectionId] = NULL;
                          }
                      }
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
int SimpleMQTTServerMessageThread::queueConnection(int newsock) {
  if (numConnections >= SimpleMQTTConnectionsPerThread) {
#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;
399
400
}

401
void SimpleMQTTServerMessageThread::assignConnections()
402
403
404
405
{
  /*
   * Find the first free slot in fds and assign connection.
   */
406
407
408
409
410
  while (fdQueueWritePos != fdQueueReadPos) {
    /* There is no free fd slot at the moment, defer.. */
    if (numConnections >= SimpleMQTTConnectionsPerThread) {
      return;
    }
411

412
413
414
415
416
417
418
    for (int i=0; i<SimpleMQTTConnectionsPerThread; i++) {
      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;
419

420
#ifdef SimpleMQTTVerbose
421
422
423
        coutMtx.lock();
        cout << "Assigned connection  (" << this << ", " << i << ", " << fds[i].fd << ")...\n";
        coutMtx.unlock();
424
#endif
425
      }
426
    }
427
428
429
430
431
432
433
434
  }
}

void SimpleMQTTServerMessageThread::releaseConnection(int connectionId)
{
  /*
   * Close the connection an clean up.
   */
435
  shutdown(fds[connectionId].fd, SHUT_RDWR);
436
437
438
439
440
  close(fds[connectionId].fd);
  fds[connectionId].fd = -1;
  fds[connectionId].events = 0;
  fds[connectionId].revents = 0;

441
442
443
444
  /*
   * If the connection was closed while we were receiving
   * a message, delete the corresponding message object.
   */
445
446
447
448
449
  if(msg[connectionId]) {
    delete msg[connectionId];
    msg[connectionId] = NULL;
  }

450
  numConnections--;
451
452
453
454
455
456

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

459
460
461
462
463
464
void SimpleMQTTServerMessageThread::setMessageCallback(SimpleMQTTMessageCallback callback)
{
  messageCallback = callback;
}

SimpleMQTTServerMessageThread::SimpleMQTTServerMessageThread(SimpleMQTTMessageCallback callback)
465
{
466
467
468
469
470
471
#ifdef SimpleMQTTVerbose
  coutMtx.lock();
  cout << "Created new MessageThread (" << (void*)this << ")\n";
  coutMtx.unlock();
#endif

472
473
474
475
476
477
  /*
   * Clear the fds array. Warning: This will only work when the
   * size of the fds array is determined at compile time.
   */
  memset(fds, -1, sizeof(fds));

Axel Auweter's avatar
Axel Auweter committed
478
479
480
481
482
483
  /*
   * Clear the msg array. Warning: This will only work when the
   * size of the msg array is determined at compile time.
   */
  memset(msg, 0, sizeof(msg));

484
  /*
485
486
   * Initialize the number of active connections to 0 and set
   * the messageCallback function.
487
488
   */
  numConnections = 0;
489
  messageCallback = callback;
490

491
492
493
494
495
496
497
  /*
   * Initialize the fd queue for new connections
   */
  fdQueue = new(int[SimpleMQTTConnectionsQueueLength]);
  fdQueueReadPos = 0;
  fdQueueWritePos = 0;

498
499
500
501
  /*
   * Release the lock to indicate that the constructor has
   * finished. This causes the launcher to call the run function.
   */
502
  launchMtx.unlock();
503
504
505
506
}

SimpleMQTTServerMessageThread::~SimpleMQTTServerMessageThread()
{
507
508
509
510
511
512
513
514
  /*
   * 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;
515
  delete fdQueue;
516
517
518

  cleanupMtx.lock();
  cleanupMtx.unlock();
519
520
}