Initial addittion of the BMF multicast plugin
[olsrd.git] / lib / bmf / src / PacketHistory.h
1 #ifndef _BMF_PACKETHISTORY_H
2 #define _BMF_PACKETHISTORY_H
3
4 /*
5  * OLSR Basic Multicast Forwarding (BMF) plugin.
6  * Copyright (c) 2005, 2006, Thales Communications, Huizen, The Netherlands.
7  * Written by Erik Tromp.
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without 
11  * modification, are permitted provided that the following conditions 
12  * are met:
13  *
14  * * Redistributions of source code must retain the above copyright 
15  *   notice, this list of conditions and the following disclaimer.
16  * * Redistributions in binary form must reproduce the above copyright 
17  *   notice, this list of conditions and the following disclaimer in 
18  *   the documentation and/or other materials provided with the 
19  *   distribution.
20  * * Neither the name of Thales, BMF nor the names of its 
21  *   contributors may be used to endorse or promote products derived 
22  *   from this software without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
26  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
27  * IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
28  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
29  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
30  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 
31  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
32  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
33  * OF THE POSSIBILITY OF SUCH DAMAGE.
34  */
35
36 /* $Id: PacketHistory.h,v 1.1 2006/05/03 08:59:04 kattemat Exp $ */
37
38 #include <sys/types.h> /* ssize_t */
39
40 /* 2 bits per seen packet fingerping: 
41  * 11 = "seen recently",
42  * 01 = "timing out"
43  * 00 = "not seen recently"
44  * Note that 10 is unused */
45 #define NBITS_PER_PACKET 2
46 #define NBITS_IN_UINT16 (sizeof(u_int16_t) * 8)
47 #define NBITS_IN_UINT32 (sizeof(u_int32_t) * 8)
48 #define NPACKETS_PER_ENTRY (NBITS_IN_UINT32 / NBITS_PER_PACKET)
49 #define HISTORY_TABLE_SIZE ((1 << NBITS_IN_UINT16) / NPACKETS_PER_ENTRY)
50
51 void InitPacketHistory(void);
52 void MarkRecentPacket(unsigned char* buffer, ssize_t len);
53 int CheckMarkRecentPacket(unsigned char* buffer, ssize_t len);
54 void PrunePacketHistory(void*);
55
56 #endif /* _BMF_PACKETHISTORY_H */