Merge pull request #414 from ADVANSEE/duplicate-packets

mac: Fix false duplicate packets detections

core/net/mac/Makefile.mac

@@ -1,2 +1,2 @@
 CONTIKI_SOURCEFILES += cxmac.c xmac.c nullmac.c lpp.c frame802154.c sicslowmac.c nullrdc.c nullrdc-noframer.c mac.c
-CONTIKI_SOURCEFILES += framer-nullmac.c framer-802154.c csma.c contikimac.c phase.c
+CONTIKI_SOURCEFILES += framer-nullmac.c framer-802154.c csma.c contikimac.c phase.c mac-sequence.c

core/net/mac/contikimac.c

@@ -44,6 +44,7 @@
 #include "dev/radio.h"
 #include "dev/watchdog.h"
 #include "lib/random.h"
+#include "net/mac/mac-sequence.h"
 #include "net/mac/contikimac.h"
 #include "net/netstack.h"
 #include "net/rime.h"
@@ -263,18 +264,6 @@ static struct compower_activity current_packet;
 #define MIN(a, b) ((a) < (b)? (a) : (b))
 #endif /* MIN */
 
-struct seqno {
-  rimeaddr_t sender;
-  uint8_t seqno;
-};
-
-#ifdef NETSTACK_CONF_MAC_SEQNO_HISTORY
-#define MAX_SEQNOS NETSTACK_CONF_MAC_SEQNO_HISTORY
-#else /* NETSTACK_CONF_MAC_SEQNO_HISTORY */
-#define MAX_SEQNOS 16
-#endif /* NETSTACK_CONF_MAC_SEQNO_HISTORY */
-static struct seqno received_seqnos[MAX_SEQNOS];
-
 #if CONTIKIMAC_CONF_BROADCAST_RATE_LIMIT
 static struct timer broadcast_rate_timer;
 static int broadcast_rate_counter;
@@ -980,27 +969,13 @@ input_packet(void)
         ctimer_stop(&ct);
       }
 
-      /* Check for duplicate packet by comparing the sequence number
+      /* Check for duplicate packet. */
-         of the incoming packet with the last few ones we saw. */
+      if(mac_sequence_is_duplicate()) {
-      {
+        /* Drop the packet. */
-        int i;
+        /*        printf("Drop duplicate ContikiMAC layer packet\n");*/
-        for(i = 0; i < MAX_SEQNOS; ++i) {
+        return;
-          if(packetbuf_attr(PACKETBUF_ATTR_PACKET_ID) == received_seqnos[i].seqno &&
-             rimeaddr_cmp(packetbuf_addr(PACKETBUF_ADDR_SENDER),
-                          &received_seqnos[i].sender)) {
-            /* Drop the packet. */
-            /*        printf("Drop duplicate ContikiMAC layer packet\n");*/
-            return;
-          }
-        }
-        for(i = MAX_SEQNOS - 1; i > 0; --i) {
-          memcpy(&received_seqnos[i], &received_seqnos[i - 1],
-                 sizeof(struct seqno));
-        }
-        received_seqnos[0].seqno = packetbuf_attr(PACKETBUF_ATTR_PACKET_ID);
-        rimeaddr_copy(&received_seqnos[0].sender,
-                      packetbuf_addr(PACKETBUF_ADDR_SENDER));
       }
+      mac_sequence_register_seqno();
 
 #if CONTIKIMAC_CONF_COMPOWER
       /* Accumulate the power consumption for the packet reception. */

core/net/mac/csma.c

@@ -306,9 +306,16 @@ send_packet(mac_callback_t sent, void *ptr)
 {
   struct rdc_buf_list *q;
   struct neighbor_queue *n;
+  static uint8_t initialized = 0;
   static uint16_t seqno;
   const rimeaddr_t *addr = packetbuf_addr(PACKETBUF_ADDR_RECEIVER);
 
+  if(!initialized) {
+    initialized = 1;
+    /* Initialize the sequence number to a random value as per 802.15.4. */
+    seqno = random_rand();
+  }
+
   if(seqno == 0) {
     /* PACKETBUF_ATTR_MAC_SEQNO cannot be zero, due to a pecuilarity
        in framer-802154.c. */

core/net/mac/mac-sequence.c

@@ -0,0 +1,109 @@
+/*
+ * Copyright (c) 2010, Swedish Institute of Computer Science.
+ * All rights reserved.
+ *
+ * Copyright (c) 2013, ADVANSEE - http://www.advansee.com/
+ * Benoît Thébaudeau <benoit.thebaudeau@advansee.com>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. Neither the name of the Institute nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ *
+ * This file is part of the Contiki operating system.
+ *
+ */
+
+/**
+ * \file
+ *         MAC sequence numbers management
+ * \author
+ *         Adam Dunkels <adam@sics.se>
+ *         Benoît Thébaudeau <benoit.thebaudeau@advansee.com>
+ */
+
+#include <string.h>
+
+#include "contiki-net.h"
+#include "net/mac/mac-sequence.h"
+#include "net/packetbuf.h"
+#include "net/rime.h"
+
+struct seqno {
+  rimeaddr_t sender;
+  uint8_t seqno;
+};
+
+#ifdef NETSTACK_CONF_MAC_SEQNO_HISTORY
+#define MAX_SEQNOS NETSTACK_CONF_MAC_SEQNO_HISTORY
+#else /* NETSTACK_CONF_MAC_SEQNO_HISTORY */
+#define MAX_SEQNOS 16
+#endif /* NETSTACK_CONF_MAC_SEQNO_HISTORY */
+static struct seqno received_seqnos[MAX_SEQNOS];
+
+/*---------------------------------------------------------------------------*/
+int
+mac_sequence_is_duplicate(void)
+{
+  int i;
+
+  /*
+   * Check for duplicate packet by comparing the sequence number of the incoming
+   * packet with the last few ones we saw.
+   */
+  for(i = 0; i < MAX_SEQNOS; ++i) {
+    if(rimeaddr_cmp(packetbuf_addr(PACKETBUF_ADDR_SENDER),
+                    &received_seqnos[i].sender)) {
+      if(packetbuf_attr(PACKETBUF_ATTR_PACKET_ID) == received_seqnos[i].seqno) {
+        /* Duplicate packet. */
+        return 1;
+      }
+      break;
+    }
+  }
+  return 0;
+}
+/*---------------------------------------------------------------------------*/
+void
+mac_sequence_register_seqno(void)
+{
+  int i, j;
+
+  /* Locate possible previous sequence number for this address. */
+  for(i = 0; i < MAX_SEQNOS; ++i) {
+    if(rimeaddr_cmp(packetbuf_addr(PACKETBUF_ADDR_SENDER),
+                    &received_seqnos[i].sender)) {
+      i++;
+      break;
+    }
+  }
+
+  /* Keep the last sequence number for each address as per 802.15.4e. */
+  for(j = i - 1; j > 0; --j) {
+    memcpy(&received_seqnos[j], &received_seqnos[j - 1], sizeof(struct seqno));
+  }
+  received_seqnos[0].seqno = packetbuf_attr(PACKETBUF_ATTR_PACKET_ID);
+  rimeaddr_copy(&received_seqnos[0].sender,
+                packetbuf_addr(PACKETBUF_ADDR_SENDER));
+}
+/*---------------------------------------------------------------------------*/

core/net/mac/mac-sequence.h

@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) 2010, Swedish Institute of Computer Science.
+ * All rights reserved.
+ *
+ * Copyright (c) 2013, ADVANSEE - http://www.advansee.com/
+ * Benoît Thébaudeau <benoit.thebaudeau@advansee.com>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. Neither the name of the Institute nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ *
+ * This file is part of the Contiki operating system.
+ *
+ */
+
+/**
+ * \file
+ *         Header file for MAC sequence numbers management
+ * \author
+ *         Adam Dunkels <adam@sics.se>
+ *         Benoît Thébaudeau <benoit.thebaudeau@advansee.com>
+ */
+
+#ifndef MAC_SEQUENCE_H
+#define MAC_SEQUENCE_H
+
+/**
+ * \brief      Tell whether the packetbuf is a duplicate packet
+ * \return     Non-zero if the packetbuf is a duplicate packet, zero otherwise
+ *
+ *             This function is used to check for duplicate packet by comparing
+ *             the sequence number of the incoming packet with the last few ones
+ *             we saw, filtering with the Rime address.
+ */
+int mac_sequence_is_duplicate(void);
+
+/**
+ * \brief      Register the sequence number of the packetbuf
+ *
+ *             This function is used to add the sequence number of the incoming
+ *             packet to the history.
+ */
+void mac_sequence_register_seqno(void);
+
+#endif /* MAC_SEQUENCE_H */

core/net/mac/nullrdc.c

@@ -38,6 +38,7 @@
  *         Niclas Finne <nfi@sics.se>
  */
 
+#include "net/mac/mac-sequence.h"
 #include "net/mac/nullrdc.h"
 #include "net/packetbuf.h"
 #include "net/queuebuf.h"
@@ -107,21 +108,6 @@
 
 #define ACK_LEN 3
 
-#if NULLRDC_802154_AUTOACK || NULLRDC_802154_AUTOACK_HW
-struct seqno {
-  rimeaddr_t sender;
-  uint8_t seqno;
-};
-
-#ifdef NETSTACK_CONF_MAC_SEQNO_HISTORY
-#define MAX_SEQNOS NETSTACK_CONF_MAC_SEQNO_HISTORY
-#else /* NETSTACK_CONF_MAC_SEQNO_HISTORY */
-#define MAX_SEQNOS 8
-#endif /* NETSTACK_CONF_MAC_SEQNO_HISTORY */
-
-static struct seqno received_seqnos[MAX_SEQNOS];
-#endif /* NULLRDC_802154_AUTOACK || NULLRDC_802154_AUTOACK_HW */
-
 /*---------------------------------------------------------------------------*/
 static int
 send_one_packet(mac_callback_t sent, void *ptr)
@@ -312,27 +298,14 @@ packet_input(void)
     int duplicate = 0;
 
 #if NULLRDC_802154_AUTOACK || NULLRDC_802154_AUTOACK_HW
-    /* Check for duplicate packet by comparing the sequence number
+    /* Check for duplicate packet. */
-       of the incoming packet with the last few ones we saw. */
+    duplicate = mac_sequence_is_duplicate();
-    int i;
+    if(duplicate) {
-    for(i = 0; i < MAX_SEQNOS; ++i) {
+      /* Drop the packet. */
-      if(packetbuf_attr(PACKETBUF_ATTR_PACKET_ID) == received_seqnos[i].seqno &&
+      PRINTF("nullrdc: drop duplicate link layer packet %u\n",
-         rimeaddr_cmp(packetbuf_addr(PACKETBUF_ADDR_SENDER),
+             packetbuf_attr(PACKETBUF_ATTR_PACKET_ID));
-                      &received_seqnos[i].sender)) {
+    } else {
-        /* Drop the packet. */
+      mac_sequence_register_seqno();
-        PRINTF("nullrdc: drop duplicate link layer packet %u\n",
-               packetbuf_attr(PACKETBUF_ATTR_PACKET_ID));
-        duplicate = 1;
-      }
-    }
-    if(!duplicate) {
-      for(i = MAX_SEQNOS - 1; i > 0; --i) {
-        memcpy(&received_seqnos[i], &received_seqnos[i - 1],
-               sizeof(struct seqno));
-      }
-      received_seqnos[0].seqno = packetbuf_attr(PACKETBUF_ATTR_PACKET_ID);
-      rimeaddr_copy(&received_seqnos[0].sender,
-                    packetbuf_addr(PACKETBUF_ADDR_SENDER));
     }
 #endif /* NULLRDC_802154_AUTOACK */
 

core/net/mac/xmac.c

@@ -44,6 +44,7 @@
 #include "dev/watchdog.h"
 #include "lib/random.h"
 #include "net/netstack.h"
+#include "net/mac/mac-sequence.h"
 #include "net/mac/xmac.h"
 #include "net/rime.h"
 #include "net/rime/timesynch.h"
@@ -219,14 +220,6 @@ static rtimer_clock_t stream_until;
 #define MIN(a, b) ((a) < (b)? (a) : (b))
 #endif /* MIN */
 
-struct seqno {
-  rimeaddr_t sender;
-  uint8_t seqno;
-};
-
-#define MAX_SEQNOS 8
-static struct seqno received_seqnos[MAX_SEQNOS];
-
 
 /*---------------------------------------------------------------------------*/
 static void
@@ -807,26 +800,12 @@ input_packet(void)
 	   asleep. */
 	off();
 
-        /* Check for duplicate packet by comparing the sequence number
+        /* Check for duplicate packet. */
-           of the incoming packet with the last few ones we saw. */
+        if(mac_sequence_is_duplicate()) {
-        {
+          /* Drop the packet. */
-          int i;
+          return;
-          for(i = 0; i < MAX_SEQNOS; ++i) {
-            if(packetbuf_attr(PACKETBUF_ATTR_PACKET_ID) == received_seqnos[i].seqno &&
-               rimeaddr_cmp(packetbuf_addr(PACKETBUF_ADDR_SENDER),
-                            &received_seqnos[i].sender)) {
-              /* Drop the packet. */
-              return;
-            }
-          }
-          for(i = MAX_SEQNOS - 1; i > 0; --i) {
-            memcpy(&received_seqnos[i], &received_seqnos[i - 1],
-                   sizeof(struct seqno));
-          }
-          received_seqnos[0].seqno = packetbuf_attr(PACKETBUF_ATTR_PACKET_ID);
-          rimeaddr_copy(&received_seqnos[0].sender,
-                        packetbuf_addr(PACKETBUF_ADDR_SENDER));
         }
+        mac_sequence_register_seqno();
 
 #if XMAC_CONF_COMPOWER
 	/* Accumulate the power consumption for the packet reception. */