PUD: add getOlsrMessageOriginator function
[olsrd.git] / lib / pud / src / pud.c
1 #include "pud.h"
2
3 /* Plugin includes */
4 #include "configuration.h"
5 #include "networkInterfaces.h"
6 #include "dump.h"
7 #include "gpsConversion.h"
8 #include "receiver.h"
9 #include "dedup.h"
10 #include "compiler.h"
11
12 /* OLSRD includes */
13 #include "ipcalc.h"
14 #include "parser.h"
15 #include "olsr.h"
16
17 /* System includes */
18 #include <assert.h>
19
20 /** The size of the buffer in which the received NMEA string is stored */
21 #define BUFFER_SIZE_FOR_OLSR    2048
22
23 /** The size of the buffer in which the transmit NMEA string is assembled */
24 #define BUFFER_SIZE_FROM_OLSR   512
25
26 /** The transmit socket address */
27 static union olsr_sockaddr * txAddress;
28
29 /** The de-duplication list */
30 static DeDupList deDupList;
31
32 /**
33  Report a plugin error.
34
35  @param useErrno
36  when true then errno is used in the error message; the error reason is also
37  reported.
38  @param format
39  a pointer to the format string
40  @param ...
41  arguments to the format string
42  */
43 void pudError(bool useErrno, const char *format, ...) {
44         char strDesc[256];
45         char *stringErr = NULL;
46
47         if (useErrno) {
48                 stringErr = strerror(errno);
49         }
50
51         if ((format == NULL) || (*format == '\0')) {
52                 if (useErrno) {
53                         olsr_printf(0, "%s: %s\n", PUD_PLUGIN_ABBR, stringErr);
54                 } else {
55                         olsr_printf(0, "%s: Unknown error\n", PUD_PLUGIN_ABBR);
56                 }
57         } else {
58                 va_list arglist;
59
60                 va_start(arglist, format);
61                 vsnprintf(strDesc, sizeof(strDesc), format, arglist);
62                 va_end(arglist);
63
64                 strDesc[sizeof(strDesc) - 1] = '\0'; /* Ensures null termination */
65
66                 if (useErrno) {
67                         olsr_printf(0, "%s: %s: %s\n", PUD_PLUGIN_ABBR, strDesc, stringErr);
68                 } else {
69                         olsr_printf(0, "%s: %s\n", PUD_PLUGIN_ABBR, strDesc);
70                 }
71         }
72 }
73
74 /**
75  Sends a buffer out on all transmit interfaces
76
77  @param buffer
78  the buffer
79  @param bufferLength
80  the number of bytes in the buffer
81  */
82 static void sendToAllTxInterfaces(unsigned char *buffer,
83                 unsigned int bufferLength) {
84         TRxTxNetworkInterface *txNetworkInterfaces = getTxNetworkInterfaces();
85         while (txNetworkInterfaces != NULL) {
86                 TRxTxNetworkInterface *networkInterface = txNetworkInterfaces;
87
88 #ifdef PUD_DUMP_GPS_PACKETS_TX_NON_OLSR
89                 olsr_printf(0, "%s: packet sent to non-OLSR interface %s (%u bytes)\n",
90                                 PUD_PLUGIN_ABBR, &networkInterface->name[0], bufferLength);
91                 dump_packet(&buffer[0], bufferLength);
92 #endif
93
94                 errno = 0;
95                 if (sendto(networkInterface->socketFd, buffer, bufferLength, 0,
96                                 (struct sockaddr *) &txAddress->in, sizeof(txAddress->in)) < 0) {
97                         pudError(true, "Transmit error on interface %s",
98                                         (char *) &networkInterface->name);
99                 }
100                 txNetworkInterfaces = networkInterface->next;
101         }
102 }
103
104 /**
105  Called by OLSR core when a packet for the plugin is received from the OLSR
106  network. It converts the packet into an NMEA string and transmits it over all
107  transmit non-OLSR network interfaces.
108
109  @param olsrMessage
110  a pointer to the received OLSR message
111  @param in_if
112  a pointer to the OLSR network interface on which the packet was received
113  @param ipaddr
114  a pointer to the IP address of the sender
115
116  @return
117  - true when the packet was processed
118  - false otherwise
119  */
120 bool packetReceivedFromOlsr(union olsr_message *olsrMessage,
121                 struct interface *in_if __attribute__ ((unused)), union olsr_ip_addr *ipaddr __attribute__ ((unused))) {
122         const union olsr_ip_addr * originator = getOlsrMessageOriginator(
123                         olsr_cnf->ip_version, olsrMessage);
124         unsigned int transmitStringLength;
125         unsigned char buffer[BUFFER_SIZE_FROM_OLSR];
126
127 #ifdef PUD_DUMP_GPS_PACKETS_RX_OLSR
128         unsigned int olsrMessageSize;
129 #endif
130
131         /* determine the originator of the messsage */
132         if (olsr_cnf->ip_version == AF_INET) {
133 #ifdef PUD_DUMP_GPS_PACKETS_RX_OLSR
134                 olsrMessageSize = ntohs(olsrMessage->v4.olsr_msgsize);
135 #endif
136         } else {
137 #ifdef PUD_DUMP_GPS_PACKETS_RX_OLSR
138                 olsrMessageSize = ntohs(olsrMessage->v6.olsr_msgsize);
139 #endif
140         }
141
142         /* when we do not loopback then check if the message originated from this
143          * node: back off */
144         if (!getUseLoopback() && ipequal(originator, &olsr_cnf->main_addr)) {
145                 return false;
146         }
147
148         /* do deduplication: when we have already seen this message from the same
149          * originator then just back off */
150         if (likely(getUseDeDup())) {
151                 if (isInDeDupList(&deDupList, olsrMessage)) {
152                         return false;
153                 }
154
155                 addToDeDup(&deDupList, olsrMessage);
156         }
157
158 #ifdef PUD_DUMP_GPS_PACKETS_RX_OLSR
159         olsr_printf(0, "\n%s: packet received from OLSR interface %s (%u bytes)\n",
160                         PUD_PLUGIN_ABBR, in_if->int_name, olsrMessageSize);
161         dump_packet((unsigned char *) olsrMessage, olsrMessageSize);
162 #endif
163
164         transmitStringLength = gpsFromOlsr(olsrMessage, &buffer[0], sizeof(buffer));
165         if (unlikely(transmitStringLength == 0)) {
166                 return false;
167         }
168
169         sendToAllTxInterfaces(&buffer[0], transmitStringLength);
170
171         return true;
172 }
173
174 /**
175  Called by OLSR core when a packet for the plugin is received from the non-OLSR
176  network. It converts the packet into the internal OLSR wire format for a
177  position update and transmits it over all OLSR network interfaces.
178
179  @param skfd
180  the socket file descriptor on which the packet is received
181  @param data
182  a pointer to the network interface structure on which the packet was received
183  @param flags
184  unused
185  */
186 #ifdef PUD_DUMP_GPS_PACKETS_RX_NON_OLSR
187 static void packetReceivedForOlsr(int skfd, void *data, unsigned int flags __attribute__ ((unused))) {
188 #else
189 static void packetReceivedForOlsr(int skfd, void *data __attribute__ ((unused)), unsigned int flags __attribute__ ((unused))) {
190 #endif
191         if (skfd >= 0) {
192                 unsigned char rxBuffer[BUFFER_SIZE_FOR_OLSR];
193                 ssize_t rxCount;
194                 struct sockaddr sender;
195                 socklen_t senderSize = sizeof(sender);
196
197                 assert(data != NULL);
198
199                 /* Receive the captured Ethernet frame */
200                 memset(&sender, 0, senderSize);
201                 errno = 0;
202                 rxCount = recvfrom(skfd, &rxBuffer[0], (sizeof(rxBuffer) - 1), 0,
203                                 &sender, &senderSize);
204                 if (rxCount < 0) {
205                         pudError(true, "Receive error in %s, ignoring message.", __func__);
206                         return;
207                 }
208
209                 /* make sure the string is null-terminated */
210                 rxBuffer[rxCount] = '\0';
211
212                 /* only accept messages from configured IP addresses */
213                 if (!isRxAllowedSourceIpAddress(&sender)) {
214                         return;
215                 }
216
217 #ifdef PUD_DUMP_GPS_PACKETS_RX_NON_OLSR
218                 {
219                         TRxTxNetworkInterface * networkInterface = data;
220                         void * src;
221                         in_port_t port;
222                         char fromAddr[64];
223
224                         if (olsr_cnf->ip_version == AF_INET) {
225                                 src = &((struct sockaddr_in*) &sender)->sin_addr;
226                                 port = ntohs(((struct sockaddr_in*) &sender)->sin_port);
227                         } else {
228                                 src = &((struct sockaddr_in6*) &sender)->sin6_addr;
229                                 port = ntohs(((struct sockaddr_in6*) &sender)->sin6_port);
230                         }
231
232                         inet_ntop(olsr_cnf->ip_version, src, &fromAddr[0], sizeof(fromAddr));
233                         olsr_printf(0, "\n%s: packet received from %s, port %u on non-OLSR"
234                                         " interface %s (%lu bytes)\n", PUD_PLUGIN_ABBR, &fromAddr[0],
235                                         port, &networkInterface->name[0], (size_t) rxCount);
236
237                         dump_packet(&rxBuffer[0], (size_t)rxCount);
238                 }
239 #endif
240
241                 /* we have the received string in the rxBuffer now */
242
243                 /* hand the NMEA information to the receiver */
244                 (void) receiverUpdateGpsInformation(&rxBuffer[0], rxCount);
245         }
246 }
247
248 /**
249  Initialise the plugin: check the configuration, initialise the NMEA parser,
250  create network interface sockets, hookup the plugin to OLSR and setup data
251  that can be setup in advance.
252
253  @return
254  - false upon failure
255  - true otherwise
256  */
257 bool initPud(void) {
258         if (!checkConfig()) {
259                 pudError(false, "Invalid configuration");
260                 goto error;
261         }
262
263         initDeDupList(&deDupList, getDeDupDepth());
264
265         /* set global transmit socket config */
266         txAddress = getTxMcAddr();
267
268         if (!startReceiver()) {
269                 pudError(false, "Could not start receiver");
270                 goto error;
271         }
272
273         /*
274          * Creates receive and transmit sockets and register the receive sockets
275          * with the OLSR stack
276          */
277         if (!createNetworkInterfaces(&packetReceivedForOlsr)) {
278                 pudError(false, "Could not create require network interfaces");
279                 goto error;
280         }
281
282         if (!checkRunSetup()) {
283                 pudError(false, "Invalid configuration");
284                 goto error;
285         }
286
287         /*
288          * Tell OLSR to launch olsr_parser when the packets for this plugin
289          * arrive from the OLSR network
290          */
291         olsr_parser_add_function(&packetReceivedFromOlsr, PUD_OLSR_MSG_TYPE);
292
293         return true;
294
295         error: closePud();
296         return false;
297 }
298
299 /**
300  Stop the plugin: shut down all created network interface sockets and destroy
301  the NMEA parser.
302  */
303 void closePud(void) {
304         closeNetworkInterfaces();
305         stopReceiver();
306         destroyDeDupList(&deDupList);
307 }