Blame view

RIOT/sys/net/application_layer/emcute/emcute.c 15 KB
a752c7ab   elopes   add first test an...
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
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
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
  /*
   * Copyright (C) 2017 Freie Universitรคt Berlin
   *
   * This file is subject to the terms and conditions of the GNU Lesser
   * General Public License v2.1. See the file LICENSE in the top level
   * directory for more details.
   */
  
  /**
   * @ingroup     net_emcute
   * @{
   *
   * @file
   * @brief       MQTT-SN implementation
   *
   * @author      Hauke Petersen <hauke.petersen@fu-berlin.de>
   *
   * @}
   */
  
  #include <string.h>
  
  #include "log.h"
  #include "mutex.h"
  #include "sched.h"
  #include "xtimer.h"
  #include "thread_flags.h"
  
  #include "net/emcute.h"
  #include "emcute_internal.h"
  
  #define ENABLE_DEBUG        (0)
  #include "debug.h"
  
  #define PROTOCOL_VERSION    (0x01)
  
  #define PUB_FLAGS           (EMCUTE_QOS_MASK | EMCUTE_RETAIN)
  #define SUB_FLAGS           (EMCUTE_DUP | EMCUTE_QOS_MASK | EMCUTE_TIT_MASK)
  
  #define TFLAGS_RESP         (0x0001)
  #define TFLAGS_TIMEOUT      (0x0002)
  #define TFLAGS_ANY          (TFLAGS_RESP | TFLAGS_TIMEOUT)
  
  
  static const char *cli_id;
  static sock_udp_t sock;
  static sock_udp_ep_t gateway;
  
  static uint8_t rbuf[EMCUTE_BUFSIZE];
  static uint8_t tbuf[EMCUTE_BUFSIZE];
  
  static emcute_sub_t *subs = NULL;
  
  static mutex_t txlock;
  
  static xtimer_t timer;
  static uint16_t id_next = 0x1234;
  static volatile uint8_t waiton = 0xff;
  static volatile uint16_t waitonid = 0;
  static volatile int result;
  
  static inline uint16_t get_u16(const uint8_t *buf)
  {
  #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
      return (uint16_t)((buf[0] << 8) | buf[1]);
  #else
      return (uint16_t)((buf[1] << 8) | buf[0]);
  #endif
  }
  
  static inline void set_u16(uint8_t *buf, uint16_t val)
  {
  #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
      buf[0] = (uint8_t)(val >> 8);
      buf[1] = (uint8_t)(val & 0xff);
  #else
      buf[0] = (uint8_t)(val & 0xff);
      buf[1] = (uint8_t)(val >> 8);
  #endif
  }
  
  static size_t set_len(uint8_t *buf, size_t len)
  {
      if (len < (0xff - 7)) {
          buf[0] = len + 1;
          return 1;
      }
      else {
          buf[0] = 0x01;
          set_u16(&tbuf[1], (uint16_t)(len + 3));
          return 3;
      }
  }
  
  static size_t get_len(uint8_t *buf, uint16_t *len)
  {
      if (buf[0] != 0x01) {
          *len = (uint16_t)buf[0];
          return 1;
      }
      else {
          *len = get_u16(&buf[1]);
          return 3;
      }
  }
  
  static void time_evt(void *arg)
  {
      thread_flags_set((thread_t *)arg, TFLAGS_TIMEOUT);
  }
  
  static int syncsend(uint8_t resp, size_t len, bool unlock)
  {
      int res = EMCUTE_TIMEOUT;
      waiton = resp;
      timer.arg = (void *)sched_active_thread;
      /* clear flags, in case the timer was triggered last time right before the
       * remove was called */
      thread_flags_clear(TFLAGS_ANY);
  
      for (unsigned retries = 0; retries < EMCUTE_N_RETRY; retries++) {
          DEBUG("[emcute] syncsend: sending round %i\n", retries);
          sock_udp_send(&sock, tbuf, len, &gateway);
  
          xtimer_set(&timer, (EMCUTE_T_RETRY * US_PER_SEC));
          thread_flags_t flags = thread_flags_wait_any(TFLAGS_ANY);
          if (flags & TFLAGS_RESP) {
              DEBUG("[emcute] syncsend: got response [%i]\n", result);
              xtimer_remove(&timer);
              res = result;
              retries = EMCUTE_N_RETRY;
          }
      }
  
      /* cleanup sync state */
      waiton = 0xff;
      if (unlock) {
          mutex_unlock(&txlock);
      }
      return res;
  }
  
  static void on_disconnect(void)
  {
      if (waiton == DISCONNECT) {
          gateway.port = 0;
          result = EMCUTE_OK;
          thread_flags_set((thread_t *)timer.arg, TFLAGS_RESP);
      }
  }
  
  static void on_ack(uint8_t type, int id_pos, int ret_pos, int res_pos)
  {
      if ((waiton == type) && (!id_pos || (waitonid == get_u16(&rbuf[id_pos])))) {
          if (!ret_pos || (rbuf[ret_pos] == ACCEPT)) {
              if (res_pos == 0) {
                  result = EMCUTE_OK;
              } else {
                  result = (int)get_u16(&rbuf[res_pos]);
              }
          } else {
              result = EMCUTE_REJECT;
          }
          thread_flags_set((thread_t *)timer.arg, TFLAGS_RESP);
      }
  }
  
  static void on_publish(size_t len, size_t pos)
  {
      /* make sure packet length is valid - if not, drop packet silently */
      if (len < (pos + 6)) {
          return;
      }
  
      emcute_sub_t *sub;
      uint16_t tid = get_u16(&rbuf[pos + 2]);
  
      /* allocate a response packet */
      uint8_t buf[7] = { 7, PUBACK, 0, 0, 0, 0, ACCEPT };
      /* and populate message ID and topic ID fields */
      memcpy(&buf[2], &rbuf[pos + 2], 4);
  
      /* return error code in case we don't support/understand active flags. So
       * far we only understand QoS 1... */
      if (rbuf[pos + 1] & ~(EMCUTE_QOS_1 | EMCUTE_TIT_SHORT)) {
          buf[6] = REJ_NOTSUP;
          sock_udp_send(&sock, &buf, 7, &gateway);
          return;
      }
  
      /* find the registered topic */
      for (sub = subs; sub && (sub->topic.id != tid); sub = sub->next) {}
      if (sub == NULL) {
          buf[6] = REJ_INVTID;
          sock_udp_send(&sock, &buf, 7, &gateway);
          DEBUG("[emcute] on pub: no subscription found\n");
      }
      else {
          if (rbuf[pos + 1] & EMCUTE_QOS_1) {
              sock_udp_send(&sock, &buf, 7, &gateway);
          }
          DEBUG("[emcute] on pub: got %i bytes of data\n", (int)(len - pos - 6));
          size_t dat_len = (len - pos - 6);
          void *dat = (dat_len > 0) ? &rbuf[pos + 6] : NULL;
          sub->cb(&sub->topic, dat, dat_len);
      }
  }
  
  static void on_pingreq(sock_udp_ep_t *remote)
  {
      /* @todo    respond with a PINGRESP only if the PINGREQ came from the
       *          connected gateway -> see spec v1.2, section 6.11 */
      uint8_t buf[2] = { 2, PINGRESP };
      sock_udp_send(&sock, &buf, 2, remote);
  }
  
  static void on_pingresp(void)
  {
      /** @todo: trigger update something like a 'last seen' value */
  }
  
  static void send_ping(void)
  {
      if (gateway.port != 0) {
          uint8_t buf[2] = { 2, PINGREQ };
          sock_udp_send(&sock, &buf, 2, &gateway);
      }
  }
  
  int emcute_con(sock_udp_ep_t *remote, bool clean, const char *will_topic,
                 const void *will_msg, size_t will_msg_len, unsigned will_flags)
  {
      int res;
      size_t len;
  
      assert(!will_topic || (will_topic && will_msg && !(will_flags & ~PUB_FLAGS)));
  
      mutex_lock(&txlock);
  
      /* check for existing connections and copy given UDP endpoint */
      if (gateway.port != 0) {
          return EMCUTE_NOGW;
      }
      memcpy(&gateway, remote, sizeof(sock_udp_ep_t));
  
      /* figure out which flags to set */
      uint8_t flags = (clean) ? EMCUTE_CS : 0;
      if (will_topic) {
          flags |= EMCUTE_WILL;
      }
  
      /* compute packet size */
      len = (strlen(cli_id) + 6);
      tbuf[0] = (uint8_t)len;
      tbuf[1] = CONNECT;
      tbuf[2] = flags;
      tbuf[3] = PROTOCOL_VERSION;
      set_u16(&tbuf[4], EMCUTE_KEEPALIVE);
      memcpy(&tbuf[6], cli_id, strlen(cli_id));
  
      /* configure 'state machine' and send the connection request */
      if (will_topic) {
          size_t topic_len = strlen(will_topic);
          if ((topic_len > EMCUTE_TOPIC_MAXLEN) ||
              ((will_msg_len + 4) > EMCUTE_BUFSIZE)) {
              gateway.port = 0;
              return EMCUTE_OVERFLOW;
          }
  
          res = syncsend(WILLTOPICREQ, len, false);
          if (res != EMCUTE_OK) {
              gateway.port = 0;
              return res;
          }
  
          /* now send WILLTOPIC */
          size_t pos = set_len(tbuf, (topic_len + 2));
          len = (pos + topic_len + 2);
          tbuf[pos++] = WILLTOPIC;
          tbuf[pos++] = will_flags;
          memcpy(&tbuf[pos], will_topic, strlen(will_topic));
  
          res = syncsend(WILLMSGREQ, len, false);
          if (res != EMCUTE_OK) {
              gateway.port = 0;
              return res;
          }
  
          /* and WILLMSG afterwards */
          pos = set_len(tbuf, (will_msg_len + 1));
          len = (pos + will_msg_len + 1);
          tbuf[pos++] = WILLMSG;
          memcpy(&tbuf[pos], will_msg, will_msg_len);
      }
  
      res = syncsend(CONNACK, len, true);
      if (res != EMCUTE_OK) {
          gateway.port = 0;
      }
      return res;
  }
  
  int emcute_discon(void)
  {
      if (gateway.port == 0) {
          return EMCUTE_NOGW;
      }
  
      mutex_lock(&txlock);
  
      tbuf[0] = 2;
      tbuf[1] = DISCONNECT;
  
      return syncsend(DISCONNECT, 2, true);
  }
  
  int emcute_reg(emcute_topic_t *topic)
  {
      assert(topic && topic->name);
  
      if (gateway.port == 0) {
          return EMCUTE_NOGW;
      }
      if (strlen(topic->name) > EMCUTE_TOPIC_MAXLEN) {
          return EMCUTE_OVERFLOW;
      }
  
      mutex_lock(&txlock);
  
      tbuf[0] = (strlen(topic->name) + 6);
      tbuf[1] = REGISTER;
      set_u16(&tbuf[2], 0);
      set_u16(&tbuf[4], id_next);
      waitonid = id_next++;
      memcpy(&tbuf[6], topic->name, strlen(topic->name));
  
      int res = syncsend(REGACK, (size_t)tbuf[0], true);
      if (res > 0) {
          topic->id = (uint16_t)res;
          res = EMCUTE_OK;
      }
      return res;
  }
  
  int emcute_pub(emcute_topic_t *topic, const void *data, size_t len,
                 unsigned flags)
  {
      int res = EMCUTE_OK;
  
      assert((topic->id != 0) && data && (len > 0) && !(flags & ~PUB_FLAGS));
  
      if (gateway.port == 0) {
          return EMCUTE_NOGW;
      }
      if (len >= (EMCUTE_BUFSIZE - 9)) {
          return EMCUTE_OVERFLOW;
      }
      if (flags & EMCUTE_QOS_2) {
          return EMCUTE_NOTSUP;
      }
  
      mutex_lock(&txlock);
  
      size_t pos = set_len(tbuf, (len + 6));
      len += (pos + 6);
      tbuf[pos++] = PUBLISH;
      tbuf[pos++] = flags;
      set_u16(&tbuf[pos], topic->id);
      pos += 2;
      set_u16(&tbuf[pos], id_next);
      waitonid = id_next++;
      pos += 2;
      memcpy(&tbuf[pos], data, len);
  
      if (flags & EMCUTE_QOS_1) {
          res = syncsend(PUBACK, len, true);
      }
      else {
          sock_udp_send(&sock, tbuf, len, &gateway);
          mutex_unlock(&txlock);
      }
  
      return res;
  }
  
  int emcute_sub(emcute_sub_t *sub, unsigned flags)
  {
      assert(sub && (sub->cb) && (sub->topic.name) && !(flags & ~SUB_FLAGS));
  
      if (gateway.port == 0) {
          return EMCUTE_NOGW;
      }
      if (strlen(sub->topic.name) > EMCUTE_TOPIC_MAXLEN) {
          return EMCUTE_OVERFLOW;
      }
  
      mutex_lock(&txlock);
  
      tbuf[0] = (strlen(sub->topic.name) + 5);
      tbuf[1] = SUBSCRIBE;
      tbuf[2] = flags;
      set_u16(&tbuf[3], id_next);
      waitonid = id_next++;
      memcpy(&tbuf[5], sub->topic.name, strlen(sub->topic.name));
  
      int res = syncsend(SUBACK, (size_t)tbuf[0], false);
      if (res > 0) {
          DEBUG("[emcute] sub: success, topic id is %i\n", res);
          sub->topic.id = res;
  
          /* check if subscription is already in the list, only insert if not*/
          emcute_sub_t *s;
          for (s = subs; s && (s != sub); s = s->next) {}
          if (!s) {
              sub->next = subs;
              subs = sub;
              res = EMCUTE_OK;
          }
      }
  
      mutex_unlock(&txlock);
      return res;
  }
  
  int emcute_unsub(emcute_sub_t *sub)
  {
      assert(sub && sub->topic.name);
  
      if (gateway.port == 0) {
          return EMCUTE_NOGW;
      }
  
      mutex_lock(&txlock);
  
      tbuf[0] = (strlen(sub->topic.name) + 5);
      tbuf[1] = UNSUBSCRIBE;
      tbuf[2] = 0;
      set_u16(&tbuf[3], id_next);
      waitonid = id_next++;
      memcpy(&tbuf[5], sub->topic.name, strlen(sub->topic.name));
  
      int res = syncsend(UNSUBACK, (size_t)tbuf[0], false);
      if (res == EMCUTE_OK) {
          if (subs == sub) {
              subs = sub->next;
          }
          else {
              emcute_sub_t *s;
              for (s = subs; s; s = s->next) {
                  if (s->next == sub) {
                      s->next = sub->next;
                      break;
                  }
              }
          }
      }
  
      mutex_unlock(&txlock);
      return res;
  }
  
  int emcute_willupd_topic(const char *topic, unsigned flags)
  {
      assert(!(flags & ~PUB_FLAGS));
  
      if (gateway.port == 0) {
          return EMCUTE_NOGW;
      }
      if (topic && (strlen(topic) > EMCUTE_TOPIC_MAXLEN)) {
          return EMCUTE_OVERFLOW;
      }
  
      mutex_lock(&txlock);
  
      tbuf[1] = WILLTOPICUPD;
      if (!topic) {
          tbuf[0] = 2;
      }
      else {
          tbuf[0] = (strlen(topic) + 3);
          tbuf[2] = flags;
          memcpy(&tbuf[3], topic, strlen(topic));
      }
  
      return syncsend(WILLTOPICRESP, (size_t)tbuf[0], true);
  }
  
  int emcute_willupd_msg(const void *data, size_t len)
  {
      assert(data && (len > 0));
  
      if (gateway.port == 0) {
          return EMCUTE_NOGW;
      }
      if (len > (EMCUTE_BUFSIZE - 4)) {
          return EMCUTE_OVERFLOW;
      }
  
      mutex_lock(&txlock);
  
      size_t pos = set_len(tbuf, (len + 1));
      len += (pos + 1);
      tbuf[pos++] = WILLMSGUPD;
      memcpy(&tbuf[pos], data, len);
  
      return syncsend(WILLMSGRESP, len, true);
  }
  
  void emcute_run(uint16_t port, const char *id)
  {
      assert(strlen(id) < EMCUTE_ID_MAXLEN);
  
      sock_udp_ep_t local = SOCK_IPV6_EP_ANY;
      sock_udp_ep_t remote;
      local.port = port;
      cli_id = id;
      timer.callback = time_evt;
      timer.arg = NULL;
      mutex_init(&txlock);
  
      if (sock_udp_create(&sock, &local, NULL, 0) < 0) {
          LOG_ERROR("[emcute] unable to open UDP socket on port %i\n", (int)port);
          return;
      }
  
      uint32_t start = xtimer_now_usec();
      uint32_t t_out = (EMCUTE_KEEPALIVE * US_PER_SEC);
  
      while (1) {
          ssize_t len = sock_udp_recv(&sock, rbuf, sizeof(rbuf), t_out, &remote);
  
          if ((len < 0) && (len != -ETIMEDOUT)) {
              LOG_ERROR("[emcute] error while receiving UDP packet\n");
              return;
          }
  
          if (len >= 2) {
              /* handle the packet */
              uint16_t pkt_len;
              /* catch invalid length field */
              if ((len == 2) && (rbuf[0] == 0x01)) {
                  continue;
              }
              /* parse length field */
              size_t pos = get_len(rbuf, &pkt_len);
              /* verify length to prevent overflows */
              if (((size_t)pkt_len > (size_t)len) || (pos >= (size_t)len)) {
                  continue;
              }
              /* get packet type */
              uint8_t type = rbuf[pos];
  
              switch (type) {
                  case CONNACK:       on_ack(type, 0, 2, 0);              break;
                  case WILLTOPICREQ:  on_ack(type, 0, 0, 0);              break;
                  case WILLMSGREQ:    on_ack(type, 0, 0, 0);              break;
                  case REGACK:        on_ack(type, 4, 6, 2);              break;
                  case PUBLISH:       on_publish((size_t)pkt_len, pos);   break;
                  case PUBACK:        on_ack(type, 4, 6, 0);              break;
                  case SUBACK:        on_ack(type, 5, 7, 3);              break;
                  case UNSUBACK:      on_ack(type, 2, 0, 0);              break;
                  case PINGREQ:       on_pingreq(&remote);                break;
                  case PINGRESP:      on_pingresp();                      break;
                  case DISCONNECT:    on_disconnect();                    break;
                  case WILLTOPICRESP: on_ack(type, 0, 0, 0);              break;
                  case WILLMSGRESP:   on_ack(type, 0, 0, 0);              break;
                  default:
                      LOG_DEBUG("[emcute] received unexpected type [%s]\n",
                                emcute_type_str(type));
              }
          }
  
          uint32_t now = xtimer_now_usec();
          if ((now - start) >= (EMCUTE_KEEPALIVE * US_PER_SEC)) {
              send_ping();
              start = now;
              t_out = (EMCUTE_KEEPALIVE * US_PER_SEC);
          }
          else {
              t_out = (EMCUTE_KEEPALIVE * US_PER_SEC) - (now - start);
          }
      }
  }