stop links from NEVER timing out. && optional vtime output in txtinfo
[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 - 2007, 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 /* -------------------------------------------------------------------------
37  * File       : PacketHistory.h
38  * Description: Functions for keeping and accessing the history of processed
39  *              multicast IP packets.
40  * Created    : 29 Jun 2006
41  *
42  * ------------------------------------------------------------------------- */
43
44 /* System includes */
45 #include <sys/types.h>          /* ssize_t */
46
47 #define N_HASH_BITS 12
48 #define HISTORY_HASH_SIZE (1 << N_HASH_BITS)
49
50 /* Time-out of duplicate entries, in milliseconds */
51 #define HISTORY_HOLD_TIME 3000
52
53 struct TDupEntry {
54   u_int32_t crc32;
55   u_int32_t timeOut;
56   struct TDupEntry *next;
57 };
58
59 void InitPacketHistory(void);
60 u_int32_t PacketCrc32(unsigned char *ipPkt, ssize_t len);
61 u_int32_t Hash(u_int32_t from32);
62 void MarkRecentPacket(u_int32_t crc32);
63 int CheckAndMarkRecentPacket(u_int32_t crc32);
64 void PrunePacketHistory(void *);
65
66 #endif /* _BMF_PACKETHISTORY_H */
67
68 /*
69  * Local Variables:
70  * c-basic-offset: 2
71  * indent-tabs-mode: nil
72  * End:
73  */