osd-contiki/core/net/rime/route-discovery.c
Enrico Joerns 85b494c16b [doc] Give files a common structure by placing license first (partial)
Followed by doxyen file and group tags.
This patch is only a first attempt to make provide a clean structure,
many more files require rework, too.
2014-11-10 23:54:49 +01:00

320 lines
10 KiB
C

/*
* 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.
*
*/
/**
* \file
* Route discovery protocol
* \author
* Adam Dunkels <adam@sics.se>
*/
/**
* \addtogroup routediscovery
* @{
*/
#include "contiki.h"
#include "net/rime/rime.h"
#include "net/rime/route.h"
#include "net/rime/route-discovery.h"
#include <stddef.h> /* For offsetof */
#include <stdio.h>
struct route_msg {
linkaddr_t dest;
uint8_t rreq_id;
uint8_t pad;
};
struct rrep_hdr {
uint8_t rreq_id;
uint8_t hops;
linkaddr_t dest;
linkaddr_t originator;
};
#if CONTIKI_TARGET_NETSIM
#include "ether.h"
#endif
#define DEBUG 0
#if DEBUG
#include <stdio.h>
#define PRINTF(...) printf(__VA_ARGS__)
#else
#define PRINTF(...)
#endif
/*---------------------------------------------------------------------------*/
static char rrep_pending; /* A reply for a request is pending. */
/*---------------------------------------------------------------------------*/
static void
send_rreq(struct route_discovery_conn *c, const linkaddr_t *dest)
{
linkaddr_t dest_copy;
struct route_msg *msg;
linkaddr_copy(&dest_copy, dest);
dest = &dest_copy;
packetbuf_clear();
msg = packetbuf_dataptr();
packetbuf_set_datalen(sizeof(struct route_msg));
msg->pad = 0;
msg->rreq_id = c->rreq_id;
linkaddr_copy(&msg->dest, dest);
netflood_send(&c->rreqconn, c->rreq_id);
c->rreq_id++;
}
/*---------------------------------------------------------------------------*/
static void
send_rrep(struct route_discovery_conn *c, const linkaddr_t *dest)
{
struct rrep_hdr *rrepmsg;
struct route_entry *rt;
linkaddr_t saved_dest;
linkaddr_copy(&saved_dest, dest);
packetbuf_clear();
dest = &saved_dest;
rrepmsg = packetbuf_dataptr();
packetbuf_set_datalen(sizeof(struct rrep_hdr));
rrepmsg->hops = 0;
linkaddr_copy(&rrepmsg->dest, dest);
linkaddr_copy(&rrepmsg->originator, &linkaddr_node_addr);
rt = route_lookup(dest);
if(rt != NULL) {
PRINTF("%d.%d: send_rrep to %d.%d via %d.%d\n",
linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1],
dest->u8[0],dest->u8[1],
rt->nexthop.u8[0],rt->nexthop.u8[1]);
unicast_send(&c->rrepconn, &rt->nexthop);
} else {
PRINTF("%d.%d: no route for rrep to %d.%d\n",
linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1],
dest->u8[0],dest->u8[1]);
}
}
/*---------------------------------------------------------------------------*/
static void
insert_route(const linkaddr_t *originator, const linkaddr_t *last_hop,
uint8_t hops)
{
PRINTF("%d.%d: Inserting %d.%d into routing table, next hop %d.%d, hop count %d\n",
linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1],
originator->u8[0], originator->u8[1],
last_hop->u8[0], last_hop->u8[1],
hops);
route_add(originator, last_hop, hops, 0);
/*
struct route_entry *rt;
rt = route_lookup(originator);
if(rt == NULL || hops < rt->hop_count) {
PRINTF("%d.%d: Inserting %d.%d into routing table, next hop %d.%d, hop count %d\n",
linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1],
originator->u8[0], originator->u8[1],
last_hop->u8[0], last_hop->u8[1],
hops);
route_add(originator, last_hop, hops, 0);
#if CONTIKI_TARGET_NETSIM
ether_set_line(last_hop->u8[0], last_hop->u8[1]);
#endif
}*/
}
/*---------------------------------------------------------------------------*/
static void
rrep_packet_received(struct unicast_conn *uc, const linkaddr_t *from)
{
struct rrep_hdr *msg = packetbuf_dataptr();
struct route_entry *rt;
linkaddr_t dest;
struct route_discovery_conn *c = (struct route_discovery_conn *)
((char *)uc - offsetof(struct route_discovery_conn, rrepconn));
PRINTF("%d.%d: rrep_packet_received from %d.%d towards %d.%d len %d\n",
linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1],
from->u8[0],from->u8[1],
msg->dest.u8[0],msg->dest.u8[1],
packetbuf_datalen());
PRINTF("from %d.%d hops %d rssi %d lqi %d\n",
from->u8[0], from->u8[1],
msg->hops,
packetbuf_attr(PACKETBUF_ATTR_RSSI),
packetbuf_attr(PACKETBUF_ATTR_LINK_QUALITY));
insert_route(&msg->originator, from, msg->hops);
if(linkaddr_cmp(&msg->dest, &linkaddr_node_addr)) {
PRINTF("rrep for us!\n");
rrep_pending = 0;
ctimer_stop(&c->t);
if(c->cb->new_route) {
linkaddr_t originator;
/* If the callback modifies the packet, the originator address
will be lost. Therefore, we need to copy it into a local
variable before calling the callback. */
linkaddr_copy(&originator, &msg->originator);
c->cb->new_route(c, &originator);
}
} else {
linkaddr_copy(&dest, &msg->dest);
rt = route_lookup(&msg->dest);
if(rt != NULL) {
PRINTF("forwarding to %d.%d\n", rt->nexthop.u8[0], rt->nexthop.u8[1]);
msg->hops++;
unicast_send(&c->rrepconn, &rt->nexthop);
} else {
PRINTF("%d.%d: no route to %d.%d\n", linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1], msg->dest.u8[0], msg->dest.u8[1]);
}
}
}
/*---------------------------------------------------------------------------*/
static int
rreq_packet_received(struct netflood_conn *nf, const linkaddr_t *from,
const linkaddr_t *originator, uint8_t seqno, uint8_t hops)
{
struct route_msg *msg = packetbuf_dataptr();
struct route_discovery_conn *c = (struct route_discovery_conn *)
((char *)nf - offsetof(struct route_discovery_conn, rreqconn));
PRINTF("%d.%d: rreq_packet_received from %d.%d hops %d rreq_id %d last %d.%d/%d\n",
linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1],
from->u8[0], from->u8[1],
hops, msg->rreq_id,
c->last_rreq_originator.u8[0],
c->last_rreq_originator.u8[1],
c->last_rreq_id);
if(!(linkaddr_cmp(&c->last_rreq_originator, originator) &&
c->last_rreq_id == msg->rreq_id)) {
PRINTF("%d.%d: rreq_packet_received: request for %d.%d originator %d.%d / %d\n",
linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1],
msg->dest.u8[0], msg->dest.u8[1],
originator->u8[0], originator->u8[1],
msg->rreq_id);
linkaddr_copy(&c->last_rreq_originator, originator);
c->last_rreq_id = msg->rreq_id;
if(linkaddr_cmp(&msg->dest, &linkaddr_node_addr)) {
PRINTF("%d.%d: route_packet_received: route request for our address\n",
linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1]);
PRINTF("from %d.%d hops %d rssi %d lqi %d\n",
from->u8[0], from->u8[1],
hops,
packetbuf_attr(PACKETBUF_ATTR_RSSI),
packetbuf_attr(PACKETBUF_ATTR_LINK_QUALITY));
insert_route(originator, from, hops);
/* Send route reply back to source. */
send_rrep(c, originator);
return 0; /* Don't continue to flood the rreq packet. */
} else {
/* PRINTF("route request for %d\n", msg->dest_id);*/
PRINTF("from %d.%d hops %d rssi %d lqi %d\n",
from->u8[0], from->u8[1],
hops,
packetbuf_attr(PACKETBUF_ATTR_RSSI),
packetbuf_attr(PACKETBUF_ATTR_LINK_QUALITY));
insert_route(originator, from, hops);
}
return 1;
}
return 0; /* Don't forward packet. */
}
/*---------------------------------------------------------------------------*/
static const struct unicast_callbacks rrep_callbacks = {rrep_packet_received};
static const struct netflood_callbacks rreq_callbacks = {rreq_packet_received, NULL, NULL};
/*---------------------------------------------------------------------------*/
void
route_discovery_open(struct route_discovery_conn *c,
clock_time_t time,
uint16_t channels,
const struct route_discovery_callbacks *callbacks)
{
netflood_open(&c->rreqconn, time, channels + 0, &rreq_callbacks);
unicast_open(&c->rrepconn, channels + 1, &rrep_callbacks);
c->cb = callbacks;
}
/*---------------------------------------------------------------------------*/
void
route_discovery_close(struct route_discovery_conn *c)
{
unicast_close(&c->rrepconn);
netflood_close(&c->rreqconn);
ctimer_stop(&c->t);
}
/*---------------------------------------------------------------------------*/
static void
timeout_handler(void *ptr)
{
struct route_discovery_conn *c = ptr;
PRINTF("route_discovery: timeout, timed out\n");
rrep_pending = 0;
if(c->cb->timedout) {
c->cb->timedout(c);
}
}
/*---------------------------------------------------------------------------*/
int
route_discovery_discover(struct route_discovery_conn *c, const linkaddr_t *addr,
clock_time_t timeout)
{
if(rrep_pending) {
PRINTF("route_discovery_send: ignoring request because of pending response\n");
return 0;
}
PRINTF("route_discovery_send: sending route request\n");
ctimer_set(&c->t, timeout, timeout_handler, c);
rrep_pending = 1;
send_rreq(c, addr);
return 1;
}
/*---------------------------------------------------------------------------*/
/** @} */