From 0206e1cd3bc86cb1eed9f67bb39179e415e05e43 Mon Sep 17 00:00:00 2001
From: adamdunkels <adamdunkels>
Date: Tue, 22 May 2007 20:45:18 +0000
Subject: [PATCH] Hop-by-hop reliable multi-hop communication primitive
(untested)
---
core/net/rime/rmh.c | 156 ++++++++++++++++++++++++++++++++++++++++++++
core/net/rime/rmh.h | 92 ++++++++++++++++++++++++++
2 files changed, 248 insertions(+)
create mode 100644 core/net/rime/rmh.c
create mode 100644 core/net/rime/rmh.h
diff --git a/core/net/rime/rmh.c b/core/net/rime/rmh.c
new file mode 100644
index 000000000..a84e33829
--- /dev/null
+++ b/core/net/rime/rmh.c
@@ -0,0 +1,156 @@
+/**
+ * \addtogroup rimermh
+ * @{
+ */
+
+/*
+ * Copyright (c) 2007, Swedish Institute of Computer Science.
+ * 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.
+ *
+ * $Id: rmh.c,v 1.1 2007/05/22 20:45:18 adamdunkels Exp $
+ */
+
+/**
+ * \file
+ * Multihop forwarding
+ * \author
+ * Adam Dunkels <adam@sics.se>
+ */
+
+#include "contiki.h"
+#include "net/rime.h"
+#include "net/rime/rmh.h"
+
+struct data_hdr {
+ rimeaddr_t dest;
+ rimeaddr_t originator;
+ u8_t hops;
+ u8_t max_rexmits;
+};
+
+#define DEBUG 0
+#if DEBUG
+#include <stdio.h>
+#define PRINTF(...) printf(__VA_ARGS__)
+#else
+#define PRINTF(...)
+#endif
+
+/*---------------------------------------------------------------------------*/
+static int
+received(struct ruc_conn *uc, rimeaddr_t *from, u8_t seqno)
+{
+ struct rmh_conn *c = (struct rmh_conn *)uc;
+ struct data_hdr *msg = rimebuf_dataptr();
+ rimeaddr_t *nexthop;
+
+ PRINTF("data_packet_received from %d towards %d len %d\n", from->u16[0],
+ msg->dest.u16[0],
+ rimebuf_datalen());
+
+ if(rimeaddr_cmp(&msg->dest, &rimeaddr_node_addr)) {
+ PRINTF("for us!\n");
+ rimebuf_hdrreduce(sizeof(struct data_hdr));
+ if(c->cb->recv) {
+ c->cb->recv(c, &msg->originator);
+ }
+ } else {
+ nexthop = NULL;
+ if(c->cb->forward) {
+ nexthop = c->cb->forward(c, &msg->originator,
+ &msg->dest, from, msg->hops);
+ }
+ if(nexthop) {
+ PRINTF("forwarding to %d\n", rt->nexthop.u16[0]);
+ msg->hops++;
+ ruc_send(&c->c, nexthop, c->num_rexmit);
+
+ }
+ }
+ return 1;
+}
+/*---------------------------------------------------------------------------*/
+static void
+sent(struct ruc_conn *c)
+{
+
+}
+/*---------------------------------------------------------------------------*/
+static void
+timedout(struct ruc_conn *c)
+{
+
+}
+/*---------------------------------------------------------------------------*/
+static const struct ruc_callbacks data_callbacks = { received ,
+ sent,
+ timedout};
+/*---------------------------------------------------------------------------*/
+void
+rmh_open(struct rmh_conn *c, u16_t channel,
+ const struct rmh_callbacks *callbacks)
+{
+ ruc_open(&c->c, channel, &data_callbacks);
+ c->cb = callbacks;
+}
+/*---------------------------------------------------------------------------*/
+void
+rmh_close(struct rmh_conn *c)
+{
+ ruc_close(&c->c);
+}
+/*---------------------------------------------------------------------------*/
+int
+rmh_send(struct rmh_conn *c, rimeaddr_t *to, u8_t num_rexmit, u8_t max_hops)
+{
+ rimeaddr_t *nexthop;
+ struct data_hdr *hdr;
+
+ c->num_rexmit = num_rexmit;
+ nexthop = c->cb->forward(c, &rimeaddr_node_addr, to, NULL, 0);
+ if(nexthop == NULL) {
+ PRINTF("rmh_send: no route\n");
+ return 0;
+ } else {
+ PRINTF("rmh_send: sending data\n");
+
+
+ if(rimebuf_hdralloc(sizeof(struct data_hdr))) {
+ hdr = rimebuf_hdrptr();
+ rimeaddr_copy(&hdr->dest, to);
+ rimeaddr_copy(&hdr->originator, &rimeaddr_node_addr);
+ hdr->hops = 0;
+ hdr->max_rexmits = num_rexmit;
+ ruc_send(&c->c, nexthop, num_rexmit);
+ }
+ return 1;
+ }
+}
+/*---------------------------------------------------------------------------*/
+/** @} */
diff --git a/core/net/rime/rmh.h b/core/net/rime/rmh.h
new file mode 100644
index 000000000..7a6563122
--- /dev/null
+++ b/core/net/rime/rmh.h
@@ -0,0 +1,92 @@
+/**
+ * \addtogroup rime
+ * @{
+ */
+
+/**
+ * \defgroup rimermh Best-effort multihop forwarding
+ * @{
+ *
+ * The rmh module implements a multihop forwarding mechanism. Routes
+ * must have already been setup with the route_add() function. Setting
+ * up routes is done with another Rime module such as the \ref
+ * routediscovery "route-discovery module".
+ *
+ * \section channels Channels
+ *
+ * The rmh module uses 1 channel.
+ *
+ */
+
+/*
+ * Copyright (c) 2006, Swedish Institute of Computer Science.
+ * 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.
+ *
+ * $Id: rmh.h,v 1.1 2007/05/22 20:45:18 adamdunkels Exp $
+ */
+
+/**
+ * \file
+ * Multihop forwarding header file
+ * \author
+ * Adam Dunkels <adam@sics.se>
+ */
+
+#ifndef __RMH_H__
+#define __RMH_H__
+
+#include "net/rime/abc.h"
+#include "net/rime/rimeaddr.h"
+
+struct rmh_conn;
+
+struct rmh_callbacks {
+ void (* recv)(struct rmh_conn *ptr, rimeaddr_t *sender);
+ rimeaddr_t *(* forward)(struct rmh_conn *ptr,
+ rimeaddr_t *originator,
+ rimeaddr_t *dest,
+ rimeaddr_t *prevhop,
+ u8_t hops);
+};
+
+struct rmh_conn {
+ struct ruc_conn c;
+ const struct rmh_callbacks *cb;
+ u8_t num_rexmit;
+};
+
+void rmh_open(struct rmh_conn *c, u16_t channel,
+ const struct rmh_callbacks *u);
+void rmh_close(struct rmh_conn *c);
+int rmh_send(struct rmh_conn *c, rimeaddr_t *to, u8_t num_rexmit,
+ u8_t max_hops);
+
+#endif /* __RMH_H__ */
+/** @} */
+/** @} */