convert ip_prefix_list to common/list datastructure
[olsrd.git] / src / hna_set.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Andreas Tonnesen(andreto@olsr.org)
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright
11  *   notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright
13  *   notice, this list of conditions and the following disclaimer in
14  *   the documentation and/or other materials provided with the
15  *   distribution.
16  * * Neither the name of olsr.org, olsrd nor the names of its
17  *   contributors may be used to endorse or promote products derived
18  *   from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * Visit http://www.olsr.org for more information.
34  *
35  * If you find this software useful feel free to make a donation
36  * to the project. For more information see the website or contact
37  * the copyright holders.
38  *
39  */
40
41 #include "hna_set.h"
42 #include "ipcalc.h"
43 #include "defs.h"
44 #include "parser.h"
45 #include "olsr.h"
46 #include "scheduler.h"
47 #include "net_olsr.h"
48 #include "tc_set.h"
49 #include "olsr_ip_prefix_list.h"
50
51 /* Some cookies for stats keeping */
52 static struct olsr_cookie_info *hna_net_timer_cookie = NULL;
53 static struct olsr_cookie_info *hna_net_mem_cookie = NULL;
54
55 /**
56  * Initialize the HNA set
57  */
58 void
59 olsr_init_hna_set(void)
60 {
61   OLSR_PRINTF(5, "HNA: init\n");
62
63   hna_net_timer_cookie =
64     olsr_alloc_cookie("HNA Network", OLSR_COOKIE_TYPE_TIMER);
65
66   hna_net_mem_cookie =
67     olsr_alloc_cookie("hna_net", OLSR_COOKIE_TYPE_MEMORY);
68   olsr_cookie_set_memory_size(hna_net_mem_cookie, sizeof(struct hna_net));
69 }
70
71 /**
72  * Lookup a network entry in the HNA subtree.
73  *
74  * @param tc the HNA hookup point
75  * @param prefic the prefix to look for
76  *
77  * @return the localized entry or NULL of not found
78  */
79 static struct hna_net *
80 olsr_lookup_hna_net(struct tc_entry *tc, const struct olsr_ip_prefix *prefix)
81 {
82   return (hna_tc_tree2hna(avl_find(&tc->hna_tree, prefix)));
83 }
84
85 /**
86  * Adds a network entry to a HNA gateway.
87  *
88  * @param tc the gateway entry to add the network to
89  * @param net the nework prefix to add
90  * @param prefixlen the prefix length
91  *
92  * @return the newly created entry
93  */
94 static struct hna_net *
95 olsr_add_hna_net(struct tc_entry *tc, const struct olsr_ip_prefix *prefix)
96 {
97   /* Add the net */
98   struct hna_net *new_net = olsr_cookie_malloc(hna_net_mem_cookie);
99
100   /* Fill struct */
101   new_net->hna_prefix = *prefix;
102
103   /* Set backpointer */
104   new_net->hna_tc = tc;
105   olsr_lock_tc_entry(tc);
106
107   /*
108    * Insert into the per-tc hna subtree.
109    */
110   new_net->hna_tc_node.key = &new_net->hna_prefix;
111   avl_insert(&tc->hna_tree, &new_net->hna_tc_node, AVL_DUP_NO);
112
113   return new_net;
114 }
115
116 /**
117  * Delete a single HNA network.
118  *
119  * @param hna_net the hna_net to delete.
120  */
121 static void
122 olsr_delete_hna_net(struct hna_net *hna_net)
123 {
124   struct tc_entry *tc = hna_net->hna_tc;
125
126   /*
127    * Delete the rt_path for the hna_net.
128    */
129   olsr_delete_routing_table(&hna_net->hna_prefix.prefix,
130                             hna_net->hna_prefix.prefix_len,
131                             &tc->addr, OLSR_RT_ORIGIN_HNA);
132
133   /*
134    * Remove from the per-tc tree.
135    */
136   avl_delete(&tc->hna_tree, &hna_net->hna_tc_node);
137
138   /*
139    * Unlock and free.
140    */
141   olsr_unlock_tc_entry(tc);
142   olsr_cookie_free(hna_net_mem_cookie, hna_net);
143 }
144
145 /**
146  * Callback for the hna_net timer.
147  */
148 static void
149 olsr_expire_hna_net_entry(void *context)
150 {
151   struct hna_net *hna_net = context;
152 #ifdef DEBUG
153   struct ipaddr_str buf;
154   struct ipprefix_str prefixstr;
155
156   OLSR_PRINTF(5, "HNA: timeout %s via hna-gw %s\n",
157               olsr_ip_prefix_to_string(&prefixstr, &hna_net->hna_prefix),
158               olsr_ip_to_string(&buf, &hna_net->hna_tc->addr));
159 #endif
160
161   hna_net->hna_net_timer = NULL; /* be pedandic */
162
163   olsr_delete_hna_net(hna_net);
164 }
165
166 /**
167  * Update a HNA entry. If it does not exist it
168  * is created.
169  * This is the only function that should be called
170  * from outside concerning creation of HNA entries.
171  *
172  *@param gw address of the gateway
173  *@param net address of the network
174  *@param mask the netmask
175  *@param vtime the validitytime of the entry
176  *
177  *@return nada
178  */
179 static void
180 olsr_update_hna_entry(const union olsr_ip_addr *gw,
181                       const struct olsr_ip_prefix *prefix,
182                       olsr_reltime vtime)
183 {
184   struct tc_entry *tc = olsr_locate_tc_entry(gw);
185   struct hna_net *net_entry = olsr_lookup_hna_net(tc, prefix);
186
187   if (net_entry == NULL) {
188     /* Need to add the net */
189     net_entry = olsr_add_hna_net(tc, prefix);
190     changes_hna = true;
191   }
192
193   /*
194    * Add the rt_path for the entry.
195    */
196   olsr_insert_routing_table(&net_entry->hna_prefix.prefix,
197                             net_entry->hna_prefix.prefix_len,
198                             &tc->addr,
199                             OLSR_RT_ORIGIN_HNA);
200
201   /*
202    * Start, or refresh the timer, whatever is appropriate.
203    */
204   olsr_set_timer(&net_entry->hna_net_timer, vtime,
205                  OLSR_HNA_NET_JITTER, OLSR_TIMER_ONESHOT,
206                  &olsr_expire_hna_net_entry, net_entry,
207                  hna_net_timer_cookie->ci_id);
208 }
209
210 /**
211  * Print all HNA entries.
212  *
213  *@return nada
214  */
215 void
216 olsr_print_hna_set(void)
217 {
218   /* The whole function doesn't do anything else. */
219 #ifndef NODEBUG
220   struct tc_entry *tc;
221
222   OLSR_PRINTF(1,
223               "\n--- %s ------------------------------------------------- HNA\n\n",
224               olsr_wallclock_string());
225
226   OLSR_FOR_ALL_TC_ENTRIES(tc) {
227     struct ipaddr_str buf;
228     struct hna_net *hna_net;
229     OLSR_PRINTF(1, "HNA-gw %s: ", olsr_ip_to_string(&buf, &tc->addr));
230     OLSR_FOR_ALL_TC_HNA_ENTRIES(tc, hna_net) {
231       struct ipprefix_str prefixstr;
232       OLSR_PRINTF(1, "%-27s", olsr_ip_prefix_to_string(&prefixstr, &hna_net->hna_prefix));
233     } OLSR_FOR_ALL_TC_HNA_ENTRIES_END(tc, hna_net);
234     OLSR_PRINTF(1, "\n");
235   } OLSR_FOR_ALL_TC_ENTRIES_END(tc);
236 #endif
237 }
238
239 /**
240  * Process incoming HNA message.
241  * Forwards the message if that is to be done.
242  */
243 bool
244 olsr_input_hna(union olsr_message *msg,
245                struct interface *in_if __attribute__((unused)),
246                union olsr_ip_addr *from_addr)
247 {
248   struct olsrmsg_hdr msg_hdr;
249   struct olsr_ip_prefix prefix;
250   struct ipaddr_str buf;
251   const uint8_t *curr, *curr_end;
252   int hnasize;
253
254   if (!(curr = olsr_parse_msg_hdr(msg, &msg_hdr))) {
255     return false;
256   }
257
258   /* We are only interested in HNA message types. */
259   if (msg_hdr.type != HNA_MESSAGE) {
260     return false;
261   }
262
263   hnasize = msg_hdr.size - (olsr_cnf->ip_version == AF_INET ?
264                             offsetof(struct olsrmsg, message) :
265                             offsetof(struct olsrmsg6, message));
266   if (hnasize < 0) {
267     OLSR_PRINTF(0, "HNA message size %d too small (at least %lu)!\n",
268                 msg_hdr.size,
269                 (unsigned long)(olsr_cnf->ip_version == AF_INET ?
270                                 offsetof(struct olsrmsg, message) :
271                                 offsetof(struct olsrmsg6, message)));
272     return false;
273   }
274
275   if ((hnasize % (2 * olsr_cnf->ipsize)) != 0) {
276     OLSR_PRINTF(0, "HNA message size %d illegal!\n", msg_hdr.size);
277     return false;
278   }
279
280   /*
281    * If the sender interface (NB: not originator) of this message
282    * is not in the symmetric 1-hop neighborhood of this node, the
283    * message MUST be discarded.
284    */
285   if (check_neighbor_link(from_addr) != SYM_LINK) {
286     OLSR_PRINTF(2, "Received HNA from NON SYM neighbor %s\n",
287                 olsr_ip_to_string(&buf, from_addr));
288     return false;
289   }
290
291   OLSR_PRINTF(1, "Processing HNA from %s, seq 0x%04x\n",
292               olsr_ip_to_string(&buf, &msg_hdr.originator), msg_hdr.seqno);
293
294   /*
295    * Now walk the list of HNA advertisements.
296    */
297   curr_end = (const uint8_t *)msg + msg_hdr.size;
298   while (curr < curr_end) {
299
300     pkt_get_ipaddress(&curr, &prefix.prefix);
301     pkt_get_prefixlen(&curr, &prefix.prefix_len);
302
303     if (!ip_prefix_list_find(&olsr_cnf->hna_entries, &prefix.prefix,
304                              prefix.prefix_len)) {
305       /*
306        * Only update if it's not from us.
307        */
308       olsr_update_hna_entry(&msg_hdr.originator, &prefix, msg_hdr.vtime);
309     }
310   }
311   /* Forward the message */
312   return true;
313 }
314
315 /*
316  * Local Variables:
317  * c-basic-offset: 2
318  * indent-tabs-mode: nil
319  * End:
320  */