batman-adv: move GW mode and selection class to private data structure
[deliverable/linux.git] / net / batman-adv / bat_v.c
CommitLineData
d6f94d91
LL
1/* Copyright (C) 2013-2016 B.A.T.M.A.N. contributors:
2 *
3 * Linus Lüssing, Marek Lindner
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of version 2 of the GNU General Public
7 * License as published by the Free Software Foundation.
8 *
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, see <http://www.gnu.org/licenses/>.
16 */
17
18#include "bat_algo.h"
19#include "main.h"
20
0b5ecc68 21#include <linux/atomic.h>
97869060 22#include <linux/bug.h>
d6f94d91
LL
23#include <linux/cache.h>
24#include <linux/init.h>
261e264d
AQ
25#include <linux/jiffies.h>
26#include <linux/netdevice.h>
27#include <linux/rculist.h>
28#include <linux/rcupdate.h>
29#include <linux/seq_file.h>
a45e932a 30#include <linux/stddef.h>
97869060 31#include <linux/types.h>
c833484e 32#include <linux/workqueue.h>
d6f94d91
LL
33
34#include "bat_v_elp.h"
0da00359 35#include "bat_v_ogm.h"
b6cf5d49 36#include "hard-interface.h"
261e264d 37#include "hash.h"
97869060 38#include "originator.h"
162bd64c 39#include "packet.h"
d6f94d91 40
b6cf5d49
AQ
41static void batadv_v_iface_activate(struct batadv_hard_iface *hard_iface)
42{
ebe24cea
ML
43 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
44 struct batadv_hard_iface *primary_if;
45
46 primary_if = batadv_primary_if_get_selected(bat_priv);
47
48 if (primary_if) {
49 batadv_v_elp_iface_activate(primary_if, hard_iface);
50 batadv_hardif_put(primary_if);
51 }
52
b6cf5d49
AQ
53 /* B.A.T.M.A.N. V does not use any queuing mechanism, therefore it can
54 * set the interface as ACTIVE right away, without any risk of race
55 * condition
56 */
57 if (hard_iface->if_status == BATADV_IF_TO_BE_ACTIVATED)
58 hard_iface->if_status = BATADV_IF_ACTIVE;
59}
60
d6f94d91
LL
61static int batadv_v_iface_enable(struct batadv_hard_iface *hard_iface)
62{
0da00359
AQ
63 int ret;
64
65 ret = batadv_v_elp_iface_enable(hard_iface);
66 if (ret < 0)
67 return ret;
68
69 ret = batadv_v_ogm_iface_enable(hard_iface);
70 if (ret < 0)
71 batadv_v_elp_iface_disable(hard_iface);
72
0b5ecc68
AQ
73 /* enable link throughput auto-detection by setting the throughput
74 * override to zero
75 */
76 atomic_set(&hard_iface->bat_v.throughput_override, 0);
77
0da00359 78 return ret;
d6f94d91
LL
79}
80
81static void batadv_v_iface_disable(struct batadv_hard_iface *hard_iface)
82{
83 batadv_v_elp_iface_disable(hard_iface);
84}
85
d6f94d91
LL
86static void batadv_v_primary_iface_set(struct batadv_hard_iface *hard_iface)
87{
88 batadv_v_elp_primary_iface_set(hard_iface);
0da00359 89 batadv_v_ogm_primary_iface_set(hard_iface);
d6f94d91
LL
90}
91
1653f61d
AQ
92/**
93 * batadv_v_iface_update_mac - react to hard-interface MAC address change
94 * @hard_iface: the modified interface
95 *
96 * If the modified interface is the primary one, update the originator
97 * address in the ELP and OGM messages to reflect the new MAC address.
98 */
99static void batadv_v_iface_update_mac(struct batadv_hard_iface *hard_iface)
100{
101 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
102 struct batadv_hard_iface *primary_if;
103
104 primary_if = batadv_primary_if_get_selected(bat_priv);
105 if (primary_if != hard_iface)
106 goto out;
107
108 batadv_v_primary_iface_set(hard_iface);
109out:
110 if (primary_if)
111 batadv_hardif_put(primary_if);
112}
113
162bd64c
LL
114static void
115batadv_v_hardif_neigh_init(struct batadv_hardif_neigh_node *hardif_neigh)
116{
117 ewma_throughput_init(&hardif_neigh->bat_v.throughput);
c833484e
AQ
118 INIT_WORK(&hardif_neigh->bat_v.metric_work,
119 batadv_v_elp_throughput_metric_update);
162bd64c
LL
120}
121
261e264d
AQ
122/**
123 * batadv_v_orig_print_neigh - print neighbors for the originator table
124 * @orig_node: the orig_node for which the neighbors are printed
125 * @if_outgoing: outgoing interface for these entries
126 * @seq: debugfs table seq_file struct
127 *
128 * Must be called while holding an rcu lock.
129 */
130static void
131batadv_v_orig_print_neigh(struct batadv_orig_node *orig_node,
132 struct batadv_hard_iface *if_outgoing,
133 struct seq_file *seq)
134{
135 struct batadv_neigh_node *neigh_node;
136 struct batadv_neigh_ifinfo *n_ifinfo;
137
138 hlist_for_each_entry_rcu(neigh_node, &orig_node->neigh_list, list) {
139 n_ifinfo = batadv_neigh_ifinfo_get(neigh_node, if_outgoing);
140 if (!n_ifinfo)
141 continue;
142
143 seq_printf(seq, " %pM (%9u.%1u)",
144 neigh_node->addr,
145 n_ifinfo->bat_v.throughput / 10,
146 n_ifinfo->bat_v.throughput % 10);
147
148 batadv_neigh_ifinfo_put(n_ifinfo);
149 }
150}
151
626d23e8
LL
152/**
153 * batadv_v_hardif_neigh_print - print a single ELP neighbour node
154 * @seq: neighbour table seq_file struct
155 * @hardif_neigh: hardif neighbour information
156 */
157static void
158batadv_v_hardif_neigh_print(struct seq_file *seq,
159 struct batadv_hardif_neigh_node *hardif_neigh)
160{
161 int last_secs, last_msecs;
162 u32 throughput;
163
164 last_secs = jiffies_to_msecs(jiffies - hardif_neigh->last_seen) / 1000;
165 last_msecs = jiffies_to_msecs(jiffies - hardif_neigh->last_seen) % 1000;
166 throughput = ewma_throughput_read(&hardif_neigh->bat_v.throughput);
167
168 seq_printf(seq, "%pM %4i.%03is (%9u.%1u) [%10s]\n",
169 hardif_neigh->addr, last_secs, last_msecs, throughput / 10,
170 throughput % 10, hardif_neigh->if_incoming->net_dev->name);
171}
172
173/**
174 * batadv_v_neigh_print - print the single hop neighbour list
175 * @bat_priv: the bat priv with all the soft interface information
176 * @seq: neighbour table seq_file struct
177 */
178static void batadv_v_neigh_print(struct batadv_priv *bat_priv,
179 struct seq_file *seq)
180{
181 struct net_device *net_dev = (struct net_device *)seq->private;
182 struct batadv_hardif_neigh_node *hardif_neigh;
183 struct batadv_hard_iface *hard_iface;
184 int batman_count = 0;
185
925a6f37
AQ
186 seq_puts(seq,
187 " Neighbor last-seen ( throughput) [ IF]\n");
626d23e8
LL
188
189 rcu_read_lock();
190 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
191 if (hard_iface->soft_iface != net_dev)
192 continue;
193
194 hlist_for_each_entry_rcu(hardif_neigh,
195 &hard_iface->neigh_list, list) {
196 batadv_v_hardif_neigh_print(seq, hardif_neigh);
197 batman_count++;
198 }
199 }
200 rcu_read_unlock();
201
202 if (batman_count == 0)
203 seq_puts(seq, "No batman nodes in range ...\n");
204}
205
261e264d
AQ
206/**
207 * batadv_v_orig_print - print the originator table
208 * @bat_priv: the bat priv with all the soft interface information
209 * @seq: debugfs table seq_file struct
210 * @if_outgoing: the outgoing interface for which this should be printed
211 */
212static void batadv_v_orig_print(struct batadv_priv *bat_priv,
213 struct seq_file *seq,
214 struct batadv_hard_iface *if_outgoing)
215{
216 struct batadv_neigh_node *neigh_node;
217 struct batadv_hashtable *hash = bat_priv->orig_hash;
218 int last_seen_msecs, last_seen_secs;
219 struct batadv_orig_node *orig_node;
220 struct batadv_neigh_ifinfo *n_ifinfo;
221 unsigned long last_seen_jiffies;
222 struct hlist_head *head;
223 int batman_count = 0;
224 u32 i;
225
925a6f37
AQ
226 seq_puts(seq,
227 " Originator last-seen ( throughput) Nexthop [outgoingIF]: Potential nexthops ...\n");
261e264d
AQ
228
229 for (i = 0; i < hash->size; i++) {
230 head = &hash->table[i];
231
232 rcu_read_lock();
233 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
234 neigh_node = batadv_orig_router_get(orig_node,
235 if_outgoing);
236 if (!neigh_node)
237 continue;
238
239 n_ifinfo = batadv_neigh_ifinfo_get(neigh_node,
240 if_outgoing);
241 if (!n_ifinfo)
242 goto next;
243
244 last_seen_jiffies = jiffies - orig_node->last_seen;
245 last_seen_msecs = jiffies_to_msecs(last_seen_jiffies);
246 last_seen_secs = last_seen_msecs / 1000;
247 last_seen_msecs = last_seen_msecs % 1000;
248
249 seq_printf(seq, "%pM %4i.%03is (%9u.%1u) %pM [%10s]:",
250 orig_node->orig, last_seen_secs,
251 last_seen_msecs,
252 n_ifinfo->bat_v.throughput / 10,
253 n_ifinfo->bat_v.throughput % 10,
254 neigh_node->addr,
255 neigh_node->if_incoming->net_dev->name);
256
257 batadv_v_orig_print_neigh(orig_node, if_outgoing, seq);
258 seq_puts(seq, "\n");
259 batman_count++;
260
261next:
262 batadv_neigh_node_put(neigh_node);
263 if (n_ifinfo)
264 batadv_neigh_ifinfo_put(n_ifinfo);
265 }
266 rcu_read_unlock();
267 }
268
269 if (batman_count == 0)
270 seq_puts(seq, "No batman nodes in range ...\n");
271}
272
97869060
AQ
273static int batadv_v_neigh_cmp(struct batadv_neigh_node *neigh1,
274 struct batadv_hard_iface *if_outgoing1,
275 struct batadv_neigh_node *neigh2,
276 struct batadv_hard_iface *if_outgoing2)
277{
278 struct batadv_neigh_ifinfo *ifinfo1, *ifinfo2;
71f9d27d 279 int ret = 0;
97869060
AQ
280
281 ifinfo1 = batadv_neigh_ifinfo_get(neigh1, if_outgoing1);
71f9d27d
SE
282 if (WARN_ON(!ifinfo1))
283 goto err_ifinfo1;
284
97869060 285 ifinfo2 = batadv_neigh_ifinfo_get(neigh2, if_outgoing2);
71f9d27d
SE
286 if (WARN_ON(!ifinfo2))
287 goto err_ifinfo2;
97869060 288
71f9d27d 289 ret = ifinfo1->bat_v.throughput - ifinfo2->bat_v.throughput;
97869060 290
71f9d27d
SE
291 batadv_neigh_ifinfo_put(ifinfo2);
292err_ifinfo2:
293 batadv_neigh_ifinfo_put(ifinfo1);
294err_ifinfo1:
295 return ret;
97869060
AQ
296}
297
298static bool batadv_v_neigh_is_sob(struct batadv_neigh_node *neigh1,
299 struct batadv_hard_iface *if_outgoing1,
300 struct batadv_neigh_node *neigh2,
301 struct batadv_hard_iface *if_outgoing2)
302{
303 struct batadv_neigh_ifinfo *ifinfo1, *ifinfo2;
304 u32 threshold;
71f9d27d 305 bool ret = false;
97869060
AQ
306
307 ifinfo1 = batadv_neigh_ifinfo_get(neigh1, if_outgoing1);
71f9d27d
SE
308 if (WARN_ON(!ifinfo1))
309 goto err_ifinfo1;
97869060 310
71f9d27d
SE
311 ifinfo2 = batadv_neigh_ifinfo_get(neigh2, if_outgoing2);
312 if (WARN_ON(!ifinfo2))
313 goto err_ifinfo2;
a45e932a 314
97869060
AQ
315 threshold = ifinfo1->bat_v.throughput / 4;
316 threshold = ifinfo1->bat_v.throughput - threshold;
317
71f9d27d
SE
318 ret = ifinfo2->bat_v.throughput > threshold;
319
320 batadv_neigh_ifinfo_put(ifinfo2);
321err_ifinfo2:
322 batadv_neigh_ifinfo_put(ifinfo1);
323err_ifinfo1:
324 return ret;
97869060
AQ
325}
326
d6f94d91
LL
327static struct batadv_algo_ops batadv_batman_v __read_mostly = {
328 .name = "BATMAN_V",
b6cf5d49 329 .bat_iface_activate = batadv_v_iface_activate,
d6f94d91
LL
330 .bat_iface_enable = batadv_v_iface_enable,
331 .bat_iface_disable = batadv_v_iface_disable,
332 .bat_iface_update_mac = batadv_v_iface_update_mac,
333 .bat_primary_iface_set = batadv_v_primary_iface_set,
162bd64c 334 .bat_hardif_neigh_init = batadv_v_hardif_neigh_init,
261e264d 335 .bat_orig_print = batadv_v_orig_print,
97869060
AQ
336 .bat_neigh_cmp = batadv_v_neigh_cmp,
337 .bat_neigh_is_similar_or_better = batadv_v_neigh_is_sob,
626d23e8 338 .bat_neigh_print = batadv_v_neigh_print,
d6f94d91
LL
339};
340
0da00359
AQ
341/**
342 * batadv_v_mesh_init - initialize the B.A.T.M.A.N. V private resources for a
343 * mesh
344 * @bat_priv: the object representing the mesh interface to initialise
345 *
346 * Return: 0 on success or a negative error code otherwise
347 */
348int batadv_v_mesh_init(struct batadv_priv *bat_priv)
349{
350 return batadv_v_ogm_init(bat_priv);
351}
352
353/**
354 * batadv_v_mesh_free - free the B.A.T.M.A.N. V private resources for a mesh
355 * @bat_priv: the object representing the mesh interface to free
356 */
357void batadv_v_mesh_free(struct batadv_priv *bat_priv)
358{
359 batadv_v_ogm_free(bat_priv);
360}
361
d6f94d91
LL
362/**
363 * batadv_v_init - B.A.T.M.A.N. V initialization function
364 *
365 * Description: Takes care of initializing all the subcomponents.
366 * It is invoked upon module load only.
367 *
368 * Return: 0 on success or a negative error code otherwise
369 */
370int __init batadv_v_init(void)
371{
162bd64c
LL
372 int ret;
373
374 /* B.A.T.M.A.N. V echo location protocol packet */
375 ret = batadv_recv_handler_register(BATADV_ELP,
376 batadv_v_elp_packet_recv);
377 if (ret < 0)
378 return ret;
379
0da00359
AQ
380 ret = batadv_recv_handler_register(BATADV_OGM2,
381 batadv_v_ogm_packet_recv);
382 if (ret < 0)
383 goto elp_unregister;
162bd64c 384
0da00359 385 ret = batadv_algo_register(&batadv_batman_v);
162bd64c 386 if (ret < 0)
0da00359
AQ
387 goto ogm_unregister;
388
389 return ret;
390
391ogm_unregister:
392 batadv_recv_handler_unregister(BATADV_OGM2);
393
394elp_unregister:
395 batadv_recv_handler_unregister(BATADV_ELP);
162bd64c
LL
396
397 return ret;
d6f94d91 398}
This page took 0.057394 seconds and 5 git commands to generate.