Merge branch 'PolynomialDivision-feature/add_workflow'
[olsrd.git] / lib / bmf / src / PacketHistory.h
1 /*
2  * The olsr.org Optimized Link-State Routing daemon (olsrd)
3  *
4  * (c) by the OLSR project
5  *
6  * See our Git repository to find out who worked on this file
7  * and thus is a copyright holder on it.
8  *
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  *
15  * * Redistributions of source code must retain the above copyright
16  *   notice, this list of conditions and the following disclaimer.
17  * * Redistributions in binary form must reproduce the above copyright
18  *   notice, this list of conditions and the following disclaimer in
19  *   the documentation and/or other materials provided with the
20  *   distribution.
21  * * Neither the name of olsr.org, olsrd nor the names of its
22  *   contributors may be used to endorse or promote products derived
23  *   from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
28  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
35  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  *
38  * Visit http://www.olsr.org for more information.
39  *
40  * If you find this software useful feel free to make a donation
41  * to the project. For more information see the website or contact
42  * the copyright holders.
43  *
44  */
45
46 #ifndef _BMF_PACKETHISTORY_H
47 #define _BMF_PACKETHISTORY_H
48
49 /* -------------------------------------------------------------------------
50  * File       : PacketHistory.h
51  * Description: Functions for keeping and accessing the history of processed
52  *              multicast IP packets.
53  * Created    : 29 Jun 2006
54  *
55  * ------------------------------------------------------------------------- */
56
57 /* System includes */
58 #include <sys/types.h> /* ssize_t */
59 #include <sys/times.h> /* clock_t */
60
61 #define N_HASH_BITS 12
62 #define HISTORY_HASH_SIZE (1u << N_HASH_BITS)
63
64 /* Time-out of duplicate entries, in milliseconds */
65 #define HISTORY_HOLD_TIME 3000
66
67 struct TDupEntry
68 {
69   u_int32_t crc32;
70   clock_t timeOut;
71   struct TDupEntry* next;
72 };
73
74 void InitPacketHistory(void);
75 u_int32_t PacketCrc32(unsigned char* ipPkt, ssize_t len);
76 u_int32_t Hash(u_int32_t from32);
77 void MarkRecentPacket(u_int32_t crc32);
78 int CheckAndMarkRecentPacket(u_int32_t crc32);
79 void PrunePacketHistory(void*);
80
81 #endif /* _BMF_PACKETHISTORY_H */