b7d3e301df8f838eb5ad04b17bb28df5578882fa
[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   /* File descriptor of raw packet socket, used for capturing multicast packets */
58   int capturingSkfd;
59
60   /* File descriptor of UDP (datagram) socket for encapsulated multicast packets.
61    * Only used for OLSR-enabled interfaces; set to -1 if interface is not OLSR-enabled. */
62   int encapsulatingSkfd;
63
64   /* File descriptor of UDP packet socket, used for listening to encapsulation packets.
65    * Used only when PlParam "BmfMechanism" is set to "UnicastPromiscuous". */
66   int listeningSkfd;
67
68   unsigned char macAddr[IFHWADDRLEN];
69
70   char ifName[IFNAMSIZ];
71
72   /* OLSRs idea of this network interface. NULL if this interface is not
73    * OLSR-enabled. */
74   struct interface *olsrIntf;
75
76   /* IP address of this network interface */
77   union olsr_ip_addr intAddr;
78
79   /* Broadcast address of this network interface */
80   union olsr_ip_addr broadAddr;
81
82 #define FRAGMENT_HISTORY_SIZE 10
83   struct TFragmentHistory {
84     u_int16_t ipId;
85     u_int8_t ipProto;
86     struct in_addr ipSrc;
87     struct in_addr ipDst;
88   } fragmentHistory[FRAGMENT_HISTORY_SIZE];
89
90   int nextFragmentHistoryEntry;
91
92   /* Number of received and transmitted BMF packets on this interface */
93   u_int32_t nBmfPacketsRx;
94   u_int32_t nBmfPacketsRxDup;
95   u_int32_t nBmfPacketsTx;
96
97   /* Next element in list */
98   struct TBmfInterface *next;
99 };
100
101 extern struct TBmfInterface *BmfInterfaces;
102
103 extern int HighestSkfd;
104 extern fd_set InputSet;
105
106 extern int EtherTunTapFd;
107
108 extern char EtherTunTapIfName[];
109
110 /* 10.255.255.253 in host byte order */
111 #define ETHERTUNTAPDEFAULTIP 0x0AFFFFFD
112
113 extern u_int32_t EtherTunTapIp;
114 extern u_int32_t EtherTunTapIpMask;
115 extern u_int32_t EtherTunTapIpBroadcast;
116
117 extern int CapturePacketsOnOlsrInterfaces;
118
119 enum TBmfMechanism { BM_BROADCAST = 0, BM_UNICAST_PROMISCUOUS };
120 extern enum TBmfMechanism BmfMechanism;
121
122 int SetBmfInterfaceName(const char *ifname, void *data, set_plugin_parameter_addon addon);
123 int SetBmfInterfaceIp(const char *ip, void *data, set_plugin_parameter_addon addon);
124 int SetCapturePacketsOnOlsrInterfaces(const char *enable, void *data, set_plugin_parameter_addon addon);
125 int SetBmfMechanism(const char *mechanism, void *data, set_plugin_parameter_addon addon);
126 int DeactivateSpoofFilter(void);
127 void RestoreSpoofFilter(void);
128
129 #define MAX_UNICAST_NEIGHBORS 10
130 struct TBestNeighbors {
131   struct link_entry *links[MAX_UNICAST_NEIGHBORS];
132 };
133
134 void FindNeighbors(struct TBestNeighbors *neighbors, struct link_entry **bestNeighbor, struct TBmfInterface *intf,
135                    union olsr_ip_addr *source, union olsr_ip_addr *forwardedBy, union olsr_ip_addr *forwardedTo,
136                    int *nPossibleNeighbors);
137
138 int CreateBmfNetworkInterfaces(struct interface *skipThisIntf);
139 void AddInterface(struct interface *newIntf);
140 void CloseBmfNetworkInterfaces(void);
141 int AddNonOlsrBmfIf(const char *ifName, void *data, set_plugin_parameter_addon addon);
142 int IsNonOlsrBmfIf(const char *ifName);
143 void CheckAndUpdateLocalBroadcast(unsigned char *ipPacket, union olsr_ip_addr *broadAddr);
144 void AddMulticastRoute(void);
145 void DeleteMulticastRoute(void);
146
147 #endif /* _BMF_NETWORKINTERFACES_H */
148
149 /*
150  * Local Variables:
151  * c-basic-offset: 2
152  * indent-tabs-mode: nil
153  * End:
154  */