85b494c16b
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.
339 lines
10 KiB
C
339 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
|
|
* Rudolph1: a simple block data flooding protocol
|
|
* \author
|
|
* Adam Dunkels <adam@sics.se>
|
|
*/
|
|
|
|
/**
|
|
* \addtogroup rudolph1
|
|
* @{
|
|
*/
|
|
|
|
#include <stdio.h>
|
|
#include <stddef.h> /* for offsetof */
|
|
|
|
#include "net/rime/rime.h"
|
|
#include "net/rime/rudolph1.h"
|
|
#include "cfs/cfs.h"
|
|
|
|
#define DEFAULT_SEND_INTERVAL CLOCK_SECOND * 2
|
|
#define TRICKLE_INTERVAL CLOCK_SECOND / 2
|
|
#define NACK_TIMEOUT CLOCK_SECOND / 4
|
|
#define REPAIR_TIMEOUT CLOCK_SECOND / 4
|
|
|
|
struct rudolph1_hdr {
|
|
uint8_t type;
|
|
uint8_t version;
|
|
uint16_t chunk;
|
|
};
|
|
|
|
#define RUDOLPH1_DATASIZE 64
|
|
|
|
struct rudolph1_datapacket {
|
|
struct rudolph1_hdr h;
|
|
uint8_t datalen;
|
|
uint8_t data[RUDOLPH1_DATASIZE];
|
|
};
|
|
|
|
enum {
|
|
TYPE_DATA,
|
|
TYPE_NACK,
|
|
};
|
|
|
|
#define DEBUG 0
|
|
#if DEBUG
|
|
#include <stdio.h>
|
|
#define PRINTF(...) printf(__VA_ARGS__)
|
|
#else
|
|
#define PRINTF(...)
|
|
#endif
|
|
|
|
#define LT(a, b) ((signed char)((a) - (b)) < 0)
|
|
|
|
/*---------------------------------------------------------------------------*/
|
|
static int
|
|
read_data(struct rudolph1_conn *c, uint8_t *dataptr, int chunk)
|
|
{
|
|
int len = 0;
|
|
|
|
if(c->cb->read_chunk) {
|
|
len = c->cb->read_chunk(c, chunk * RUDOLPH1_DATASIZE,
|
|
dataptr, RUDOLPH1_DATASIZE);
|
|
}
|
|
return len;
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
static int
|
|
format_data(struct rudolph1_conn *c, int chunk)
|
|
{
|
|
struct rudolph1_datapacket *p;
|
|
|
|
packetbuf_clear();
|
|
p = packetbuf_dataptr();
|
|
p->h.type = TYPE_DATA;
|
|
p->h.version = c->version;
|
|
p->h.chunk = chunk;
|
|
p->datalen = read_data(c, p->data, chunk);
|
|
packetbuf_set_datalen(sizeof(struct rudolph1_datapacket) -
|
|
(RUDOLPH1_DATASIZE - p->datalen));
|
|
|
|
return p->datalen;
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
static void
|
|
write_data(struct rudolph1_conn *c, int chunk, uint8_t *data, int datalen)
|
|
{
|
|
if(chunk == 0) {
|
|
c->cb->write_chunk(c, 0, RUDOLPH1_FLAG_NEWFILE, data, 0);
|
|
}
|
|
|
|
if(datalen < RUDOLPH1_DATASIZE) {
|
|
PRINTF("%d.%d: get %d bytes, file complete\n",
|
|
linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1],
|
|
datalen);
|
|
c->cb->write_chunk(c, chunk * RUDOLPH1_DATASIZE,
|
|
RUDOLPH1_FLAG_LASTCHUNK, data, datalen);
|
|
} else {
|
|
c->cb->write_chunk(c, chunk * RUDOLPH1_DATASIZE,
|
|
RUDOLPH1_FLAG_NONE, data, datalen);
|
|
}
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
static void
|
|
send_nack(struct rudolph1_conn *c)
|
|
{
|
|
struct rudolph1_hdr *hdr;
|
|
packetbuf_clear();
|
|
packetbuf_hdralloc(sizeof(struct rudolph1_hdr));
|
|
hdr = packetbuf_hdrptr();
|
|
|
|
hdr->type = TYPE_NACK;
|
|
hdr->version = c->version;
|
|
hdr->chunk = c->chunk;
|
|
|
|
PRINTF("%d.%d: Sending nack for %d:%d\n",
|
|
linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1],
|
|
hdr->version, hdr->chunk);
|
|
ipolite_send(&c->ipolite, NACK_TIMEOUT, sizeof(struct rudolph1_hdr));
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
static void
|
|
handle_data(struct rudolph1_conn *c, struct rudolph1_datapacket *p)
|
|
{
|
|
if(LT(c->version, p->h.version)) {
|
|
PRINTF("%d.%d: rudolph1 new version %d, chunk %d\n",
|
|
linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1],
|
|
p->h.version, p->h.chunk);
|
|
c->version = p->h.version;
|
|
c->highest_chunk_heard = c->chunk = 0;
|
|
if(p->h.chunk != 0) {
|
|
send_nack(c);
|
|
} else {
|
|
write_data(c, 0, p->data, p->datalen);
|
|
c->chunk = 1; /* Next chunk is 1. */
|
|
}
|
|
/* }*/
|
|
} else if(p->h.version == c->version) {
|
|
PRINTF("%d.%d: got chunk %d (%d) highest heard %d\n",
|
|
linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1],
|
|
p->h.chunk, c->chunk, c->highest_chunk_heard);
|
|
|
|
if(p->h.chunk == c->chunk) {
|
|
PRINTF("%d.%d: received chunk %d\n",
|
|
linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1],
|
|
p->h.chunk);
|
|
write_data(c, p->h.chunk, p->data, p->datalen);
|
|
if(c->highest_chunk_heard < c->chunk) {
|
|
c->highest_chunk_heard = c->chunk;
|
|
}
|
|
c->chunk++;
|
|
} else if(p->h.chunk > c->chunk) {
|
|
PRINTF("%d.%d: received chunk %d > %d, sending NACK\n",
|
|
linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1],
|
|
p->h.chunk, c->chunk);
|
|
send_nack(c);
|
|
c->highest_chunk_heard = p->h.chunk;
|
|
} else if(p->h.chunk < c->chunk) {
|
|
/* Ignore packets with a lower chunk number */
|
|
}
|
|
|
|
/* If we have heard a higher chunk number, we send a NACK so that
|
|
we get a repair for the next packet. */
|
|
|
|
if(c->highest_chunk_heard > p->h.chunk) {
|
|
send_nack(c);
|
|
}
|
|
} else { /* p->h.version < c->current.h.version */
|
|
/* Ignore packets with old version */
|
|
}
|
|
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
static void
|
|
recv_trickle(struct trickle_conn *trickle)
|
|
{
|
|
struct rudolph1_conn *c = (struct rudolph1_conn *)trickle;
|
|
struct rudolph1_datapacket *p = packetbuf_dataptr();
|
|
|
|
if(p->h.type == TYPE_DATA) {
|
|
PRINTF("%d.%d: received trickle with chunk %d\n",
|
|
linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1],
|
|
p->h.chunk);
|
|
handle_data(c, p);
|
|
}
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
static void
|
|
sent_ipolite(struct ipolite_conn *ipolite)
|
|
{
|
|
PRINTF("%d.%d: Sent ipolite\n",
|
|
linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1]);
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
static void
|
|
dropped_ipolite(struct ipolite_conn *ipolite)
|
|
{
|
|
PRINTF("%d.%d: dropped ipolite\n",
|
|
linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1]);
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
static void
|
|
recv_ipolite(struct ipolite_conn *ipolite, const linkaddr_t *from)
|
|
{
|
|
struct rudolph1_conn *c = (struct rudolph1_conn *)
|
|
((char *)ipolite - offsetof(struct rudolph1_conn, ipolite));
|
|
struct rudolph1_datapacket *p = packetbuf_dataptr();
|
|
|
|
PRINTF("%d.%d: Got ipolite type %d\n",
|
|
linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1],
|
|
p->h.type);
|
|
|
|
c->nacks++;
|
|
|
|
if(p->h.type == TYPE_NACK) {
|
|
PRINTF("%d.%d: Got NACK for %d:%d (%d:%d)\n",
|
|
linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1],
|
|
p->h.version, p->h.chunk,
|
|
c->version, c->chunk);
|
|
if(p->h.version == c->version) {
|
|
if(p->h.chunk < c->chunk) {
|
|
/* Format and send a repair packet */
|
|
PRINTF("%d.%d: sending repair for chunk %d\n",
|
|
linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1],
|
|
p->h.chunk);
|
|
format_data(c, p->h.chunk);
|
|
ipolite_send(&c->ipolite, REPAIR_TIMEOUT, sizeof(struct rudolph1_hdr));
|
|
}
|
|
} else if(LT(p->h.version, c->version)) {
|
|
format_data(c, 0);
|
|
ipolite_send(&c->ipolite, c->send_interval / 2, sizeof(struct rudolph1_hdr));
|
|
}
|
|
} else if(p->h.type == TYPE_DATA) {
|
|
/* This is a repair packet from someone else. */
|
|
PRINTF("%d.%d: got repair for chunk %d\n",
|
|
linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1],
|
|
p->h.chunk);
|
|
handle_data(c, p);
|
|
}
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
static void
|
|
send_next_packet(void *ptr)
|
|
{
|
|
struct rudolph1_conn *c = ptr;
|
|
int len;
|
|
if(c->nacks == 0) {
|
|
len = format_data(c, c->chunk);
|
|
trickle_send(&c->trickle);
|
|
if(len == RUDOLPH1_DATASIZE) {
|
|
ctimer_set(&c->t, c->send_interval, send_next_packet, c);
|
|
}
|
|
PRINTF("%d.%d: send_next_packet chunk %d, next %d\n",
|
|
linkaddr_node_addr.u8[0], linkaddr_node_addr.u8[1],
|
|
c->chunk, c->chunk + 1);
|
|
|
|
c->highest_chunk_heard = c->chunk;
|
|
c->chunk++;
|
|
|
|
} else {
|
|
ctimer_set(&c->t, c->send_interval, send_next_packet, c);
|
|
}
|
|
c->nacks = 0;
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
static const struct ipolite_callbacks ipolite = { recv_ipolite, sent_ipolite,
|
|
dropped_ipolite };
|
|
static const struct trickle_callbacks trickle = { recv_trickle };
|
|
/*---------------------------------------------------------------------------*/
|
|
void
|
|
rudolph1_open(struct rudolph1_conn *c, uint16_t channel,
|
|
const struct rudolph1_callbacks *cb)
|
|
{
|
|
trickle_open(&c->trickle, TRICKLE_INTERVAL, channel, &trickle);
|
|
ipolite_open(&c->ipolite, channel + 1, 1, &ipolite);
|
|
c->cb = cb;
|
|
c->version = 0;
|
|
c->send_interval = DEFAULT_SEND_INTERVAL;
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
void
|
|
rudolph1_close(struct rudolph1_conn *c)
|
|
{
|
|
trickle_close(&c->trickle);
|
|
ipolite_close(&c->ipolite);
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
void
|
|
rudolph1_send(struct rudolph1_conn *c, clock_time_t send_interval)
|
|
{
|
|
c->version++;
|
|
c->chunk = c->highest_chunk_heard = 0;
|
|
/* c->trickle_interval = TRICKLE_INTERVAL;*/
|
|
format_data(c, 0);
|
|
trickle_send(&c->trickle);
|
|
c->chunk++;
|
|
c->send_interval = send_interval;
|
|
ctimer_set(&c->t, send_interval, send_next_packet, c);
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
void
|
|
rudolph1_stop(struct rudolph1_conn *c)
|
|
{
|
|
ctimer_stop(&c->t);
|
|
}
|
|
/*---------------------------------------------------------------------------*/
|
|
/** @} */
|