Update to BMF 1.6.2 (written by Erik Tromp)
[olsrd.git] / lib / bmf / src / NetworkInterfaces.h
1 #ifndef _BMF_NETWORKINTERFACES_H
2 #define _BMF_NETWORKINTERFACES_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       : NetworkInterfaces.h
38  * Description: Functions to open and close sockets
39  * Created    : 29 Jun 2006
40  *
41  * ------------------------------------------------------------------------- */
42
43 /* System includes */
44 #include <netinet/in.h> /* struct in_addr */
45
46 /* OLSR includes */
47 #include "olsr_types.h" /* olsr_ip_addr */
48 #include "olsrd_plugin.h" /* union set_plugin_parameter_addon */
49
50 /* Plugin includes */
51 #include "Packet.h" /* IFHWADDRLEN */
52
53 /* Size of buffer in which packets are received */
54 #define BMF_BUFFER_SIZE 2048
55
56 struct TBmfInterface
57 {
58   /* File descriptor of raw packet socket, used for capturing multicast packets */
59   int capturingSkfd;
60
61   /* File descriptor of UDP (datagram) socket for encapsulated multicast packets. 
62    * Only used for OLSR-enabled interfaces; set to -1 if interface is not OLSR-enabled. */
63   int encapsulatingSkfd;
64
65   /* File descriptor of UDP packet socket, used for listening to encapsulation packets.
66    * Used only when PlParam "BmfMechanism" is set to "UnicastPromiscuous". */
67   int listeningSkfd;
68
69   unsigned char macAddr[IFHWADDRLEN];
70
71   char ifName[IFNAMSIZ];
72
73   /* OLSRs idea of this network interface. NULL if this interface is not
74    * OLSR-enabled. */
75   struct interface* olsrIntf;
76
77   /* IP address of this network interface */
78   union olsr_ip_addr intAddr;
79
80   /* Broadcast address of this network interface */
81   union olsr_ip_addr broadAddr;
82
83   /* Number of received and transmitted BMF packets on this interface */
84   u_int32_t nBmfPacketsRx;
85   u_int32_t nBmfPacketsRxDup;
86   u_int32_t nBmfPacketsTx;
87
88   /* Next element in list */
89   struct TBmfInterface* next; 
90 };
91
92 extern struct TBmfInterface* BmfInterfaces;
93
94 extern int HighestSkfd;
95 extern fd_set InputSet;
96
97 extern int EtherTunTapFd;
98
99 extern char EtherTunTapIfName[];
100
101 /* 10.255.255.253 in host byte order */
102 #define ETHERTUNTAPDEFAULTIP 0x0AFFFFFD
103
104 extern u_int32_t EtherTunTapIp;
105 extern u_int32_t EtherTunTapIpMask;
106 extern u_int32_t EtherTunTapIpBroadcast;
107
108 extern int CapturePacketsOnOlsrInterfaces;
109
110 enum TBmfMechanism { BM_BROADCAST = 0, BM_UNICAST_PROMISCUOUS };
111 extern enum TBmfMechanism BmfMechanism;
112
113 int SetBmfInterfaceName(const char* ifname, void* data, set_plugin_parameter_addon addon);
114 int SetBmfInterfaceIp(const char* ip, void* data, set_plugin_parameter_addon addon);
115 int SetCapturePacketsOnOlsrInterfaces(const char* enable, void* data, set_plugin_parameter_addon addon);
116 int SetBmfMechanism(const char* mechanism, void* data, set_plugin_parameter_addon addon);
117 int DeactivateSpoofFilter(void);
118 void RestoreSpoofFilter(void);
119
120 #define MAX_UNICAST_NEIGHBORS 10
121 struct TBestNeighbors
122 {
123   struct link_entry* links[MAX_UNICAST_NEIGHBORS];
124 };
125
126 void FindNeighbors(
127   struct TBestNeighbors* neighbors,
128   struct link_entry** bestNeighbor,
129   struct TBmfInterface* intf,
130   union olsr_ip_addr* source,
131   union olsr_ip_addr* forwardedBy,
132   union olsr_ip_addr* forwardedTo,
133   int* nPossibleNeighbors);
134
135 int CreateBmfNetworkInterfaces(struct interface* skipThisIntf);
136 void CloseBmfNetworkInterfaces(void);
137 int AddNonOlsrBmfIf(const char* ifName, void* data, set_plugin_parameter_addon addon);
138 int IsNonOlsrBmfIf(const char* ifName);
139 void CheckAndUpdateLocalBroadcast(unsigned char* ipPacket, union olsr_ip_addr* broadAddr);
140 void AddMulticastRoute(void);
141 void DeleteMulticastRoute(void);
142
143 #endif /* _BMF_NETWORKINTERFACES_H */