From db0571bef3ba683462b8bd204e68da379707de75 Mon Sep 17 00:00:00 2001 From: adamdunkels Date: Tue, 15 May 2007 07:41:36 +0000 Subject: [PATCH] Identified polite broadcast primitive --- core/net/rime/ipolite.c | 142 ++++++++++++++++++++++++++++++++++++++++ core/net/rime/ipolite.h | 89 +++++++++++++++++++++++++ 2 files changed, 231 insertions(+) create mode 100644 core/net/rime/ipolite.c create mode 100644 core/net/rime/ipolite.h diff --git a/core/net/rime/ipolite.c b/core/net/rime/ipolite.c new file mode 100644 index 000000000..116399d13 --- /dev/null +++ b/core/net/rime/ipolite.c @@ -0,0 +1,142 @@ +/** + * \addtogroup rimeipolite + * @{ + */ + +/* + * 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: ipolite.c,v 1.1 2007/05/15 07:41:36 adamdunkels Exp $ + */ + +/** + * \file + * Ipolite Anonymous best effort local area BroadCast (ipolite) + * \author + * Adam Dunkels + */ + +#include "net/rime.h" +#include "net/rime/ipolite.h" +#include "lib/rand.h" + +#include + +#define MAX(a,b) ((a)>(b)?(a):(b)) + +/*---------------------------------------------------------------------------*/ +static void +recv(struct ibc_conn *ibc, rimeaddr_t *from) +{ + struct ipolite_conn *c = (struct ipolite_conn *)ibc; + if(c->q != NULL && + rimebuf_datalen() == queuebuf_datalen(c->q) && + memcmp(rimebuf_dataptr(), queuebuf_dataptr(c->q), + MAX(c->hdrsize, rimebuf_datalen())) == 0) { + /* We received a copy of our own packet, so we do not send out + packet. */ + queuebuf_free(c->q); + c->q = NULL; + ctimer_stop(&c->t); + if(c->cb->dropped) { + c->cb->dropped(c); + } + } + if(c->cb->recv) { + c->cb->recv(c, from); + } +} +/*---------------------------------------------------------------------------*/ +static void +send(void *ptr) +{ + struct ipolite_conn *c = ptr; + + if(c->q != NULL) { + queuebuf_to_rimebuf(c->q); + queuebuf_free(c->q); + c->q = NULL; + ibc_send(&c->c); + if(c->cb->sent) { + c->cb->sent(c); + } + } +} +/*---------------------------------------------------------------------------*/ +static const struct ibc_callbacks ibc = { recv }; +/*---------------------------------------------------------------------------*/ +void +ipolite_open(struct ipolite_conn *c, u16_t channel, + const struct ipolite_callbacks *cb) +{ + ibc_open(&c->c, channel, &ibc); + c->cb = cb; +} +/*---------------------------------------------------------------------------*/ +void +ipolite_close(struct ipolite_conn *c) +{ + ibc_close(&c->c); + ctimer_stop(&c->t); + if(c->q != NULL) { + queuebuf_free(c->q); + c->q = NULL; + } +} +/*---------------------------------------------------------------------------*/ +int +ipolite_send(struct ipolite_conn *c, clock_time_t interval, u8_t hdrsize) +{ + if(c->q != NULL) { + /* If we are already about to send a packet, we cancel the old one. */ + queuebuf_free(c->q); + } + c->hdrsize = hdrsize; + c->q = queuebuf_new_from_rimebuf(); + if(c->q != NULL) { + ctimer_set(&c->t, + interval / 2 + (random_rand() % (interval / 2)), + send, c); + return 1; + } + return 0; +} +/*---------------------------------------------------------------------------*/ +void +ipolite_cancel(struct ipolite_conn *c) +{ + ctimer_stop(&c->t); + if(c->q != NULL) { + queuebuf_free(c->q); + c->q = NULL; + } +} +/*---------------------------------------------------------------------------*/ +/** @} */ diff --git a/core/net/rime/ipolite.h b/core/net/rime/ipolite.h new file mode 100644 index 000000000..78fcd0cbd --- /dev/null +++ b/core/net/rime/ipolite.h @@ -0,0 +1,89 @@ +/** + * \addtogroup rime + * @{ + */ + +/** + * \defgroup rimeipolite Ipolite anonymous best effort local broadcast + * @{ + * + * The ipolite module sends one anonymous packet that is unique within a + * time interval. + * + * \section channels Channels + * + * The ipolite module uses 1 channel. + * + */ + +/* + * 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: ipolite.h,v 1.1 2007/05/15 07:41:36 adamdunkels Exp $ + */ + +/** + * \file + * Header file for Ipolite Anonymous best effort local Broadcast (ipolite) + * \author + * Adam Dunkels + */ + +#ifndef __IPOLITE_H__ +#define __IPOLITE_H__ + +#include "net/rime.h" + +struct ipolite_conn; + +struct ipolite_callbacks { + void (* recv)(struct ipolite_conn *c, rimeaddr_t *from); + void (* sent)(struct ipolite_conn *c); + void (* dropped)(struct ipolite_conn *c); +}; + +struct ipolite_conn { + struct ibc_conn c; + const struct ipolite_callbacks *cb; + struct ctimer t; + struct queuebuf *q; + u8_t hdrsize; +}; + +void ipolite_open(struct ipolite_conn *c, u16_t channel, + const struct ipolite_callbacks *cb); +void ipolite_close(struct ipolite_conn *c); +int ipolite_send(struct ipolite_conn *c, clock_time_t interval, u8_t hdrsize); +void ipolite_cancel(struct ipolite_conn *c); + +#endif /* __IPOLITE_H__ */ + +/** @} */ +/** @} */