Merge branch 'for-next' of git://git.kernel.org/pub/scm/linux/kernel/git/nab/target...
[linux-2.6-block.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
d6f94d91
LL
122static void batadv_v_ogm_schedule(struct batadv_hard_iface *hard_iface)
123{
124}
125
126static void batadv_v_ogm_emit(struct batadv_forw_packet *forw_packet)
127{
128}
129
261e264d
AQ
130/**
131 * batadv_v_orig_print_neigh - print neighbors for the originator table
132 * @orig_node: the orig_node for which the neighbors are printed
133 * @if_outgoing: outgoing interface for these entries
134 * @seq: debugfs table seq_file struct
135 *
136 * Must be called while holding an rcu lock.
137 */
138static void
139batadv_v_orig_print_neigh(struct batadv_orig_node *orig_node,
140 struct batadv_hard_iface *if_outgoing,
141 struct seq_file *seq)
142{
143 struct batadv_neigh_node *neigh_node;
144 struct batadv_neigh_ifinfo *n_ifinfo;
145
146 hlist_for_each_entry_rcu(neigh_node, &orig_node->neigh_list, list) {
147 n_ifinfo = batadv_neigh_ifinfo_get(neigh_node, if_outgoing);
148 if (!n_ifinfo)
149 continue;
150
151 seq_printf(seq, " %pM (%9u.%1u)",
152 neigh_node->addr,
153 n_ifinfo->bat_v.throughput / 10,
154 n_ifinfo->bat_v.throughput % 10);
155
156 batadv_neigh_ifinfo_put(n_ifinfo);
157 }
158}
159
626d23e8
LL
160/**
161 * batadv_v_hardif_neigh_print - print a single ELP neighbour node
162 * @seq: neighbour table seq_file struct
163 * @hardif_neigh: hardif neighbour information
164 */
165static void
166batadv_v_hardif_neigh_print(struct seq_file *seq,
167 struct batadv_hardif_neigh_node *hardif_neigh)
168{
169 int last_secs, last_msecs;
170 u32 throughput;
171
172 last_secs = jiffies_to_msecs(jiffies - hardif_neigh->last_seen) / 1000;
173 last_msecs = jiffies_to_msecs(jiffies - hardif_neigh->last_seen) % 1000;
174 throughput = ewma_throughput_read(&hardif_neigh->bat_v.throughput);
175
176 seq_printf(seq, "%pM %4i.%03is (%9u.%1u) [%10s]\n",
177 hardif_neigh->addr, last_secs, last_msecs, throughput / 10,
178 throughput % 10, hardif_neigh->if_incoming->net_dev->name);
179}
180
181/**
182 * batadv_v_neigh_print - print the single hop neighbour list
183 * @bat_priv: the bat priv with all the soft interface information
184 * @seq: neighbour table seq_file struct
185 */
186static void batadv_v_neigh_print(struct batadv_priv *bat_priv,
187 struct seq_file *seq)
188{
189 struct net_device *net_dev = (struct net_device *)seq->private;
190 struct batadv_hardif_neigh_node *hardif_neigh;
191 struct batadv_hard_iface *hard_iface;
192 int batman_count = 0;
193
925a6f37
AQ
194 seq_puts(seq,
195 " Neighbor last-seen ( throughput) [ IF]\n");
626d23e8
LL
196
197 rcu_read_lock();
198 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
199 if (hard_iface->soft_iface != net_dev)
200 continue;
201
202 hlist_for_each_entry_rcu(hardif_neigh,
203 &hard_iface->neigh_list, list) {
204 batadv_v_hardif_neigh_print(seq, hardif_neigh);
205 batman_count++;
206 }
207 }
208 rcu_read_unlock();
209
210 if (batman_count == 0)
211 seq_puts(seq, "No batman nodes in range ...\n");
212}
213
261e264d
AQ
214/**
215 * batadv_v_orig_print - print the originator table
216 * @bat_priv: the bat priv with all the soft interface information
217 * @seq: debugfs table seq_file struct
218 * @if_outgoing: the outgoing interface for which this should be printed
219 */
220static void batadv_v_orig_print(struct batadv_priv *bat_priv,
221 struct seq_file *seq,
222 struct batadv_hard_iface *if_outgoing)
223{
224 struct batadv_neigh_node *neigh_node;
225 struct batadv_hashtable *hash = bat_priv->orig_hash;
226 int last_seen_msecs, last_seen_secs;
227 struct batadv_orig_node *orig_node;
228 struct batadv_neigh_ifinfo *n_ifinfo;
229 unsigned long last_seen_jiffies;
230 struct hlist_head *head;
231 int batman_count = 0;
232 u32 i;
233
925a6f37
AQ
234 seq_puts(seq,
235 " Originator last-seen ( throughput) Nexthop [outgoingIF]: Potential nexthops ...\n");
261e264d
AQ
236
237 for (i = 0; i < hash->size; i++) {
238 head = &hash->table[i];
239
240 rcu_read_lock();
241 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
242 neigh_node = batadv_orig_router_get(orig_node,
243 if_outgoing);
244 if (!neigh_node)
245 continue;
246
247 n_ifinfo = batadv_neigh_ifinfo_get(neigh_node,
248 if_outgoing);
249 if (!n_ifinfo)
250 goto next;
251
252 last_seen_jiffies = jiffies - orig_node->last_seen;
253 last_seen_msecs = jiffies_to_msecs(last_seen_jiffies);
254 last_seen_secs = last_seen_msecs / 1000;
255 last_seen_msecs = last_seen_msecs % 1000;
256
257 seq_printf(seq, "%pM %4i.%03is (%9u.%1u) %pM [%10s]:",
258 orig_node->orig, last_seen_secs,
259 last_seen_msecs,
260 n_ifinfo->bat_v.throughput / 10,
261 n_ifinfo->bat_v.throughput % 10,
262 neigh_node->addr,
263 neigh_node->if_incoming->net_dev->name);
264
265 batadv_v_orig_print_neigh(orig_node, if_outgoing, seq);
266 seq_puts(seq, "\n");
267 batman_count++;
268
269next:
270 batadv_neigh_node_put(neigh_node);
271 if (n_ifinfo)
272 batadv_neigh_ifinfo_put(n_ifinfo);
273 }
274 rcu_read_unlock();
275 }
276
277 if (batman_count == 0)
278 seq_puts(seq, "No batman nodes in range ...\n");
279}
280
97869060
AQ
281static int batadv_v_neigh_cmp(struct batadv_neigh_node *neigh1,
282 struct batadv_hard_iface *if_outgoing1,
283 struct batadv_neigh_node *neigh2,
284 struct batadv_hard_iface *if_outgoing2)
285{
286 struct batadv_neigh_ifinfo *ifinfo1, *ifinfo2;
71f9d27d 287 int ret = 0;
97869060
AQ
288
289 ifinfo1 = batadv_neigh_ifinfo_get(neigh1, if_outgoing1);
71f9d27d
SE
290 if (WARN_ON(!ifinfo1))
291 goto err_ifinfo1;
292
97869060 293 ifinfo2 = batadv_neigh_ifinfo_get(neigh2, if_outgoing2);
71f9d27d
SE
294 if (WARN_ON(!ifinfo2))
295 goto err_ifinfo2;
97869060 296
71f9d27d 297 ret = ifinfo1->bat_v.throughput - ifinfo2->bat_v.throughput;
97869060 298
71f9d27d
SE
299 batadv_neigh_ifinfo_put(ifinfo2);
300err_ifinfo2:
301 batadv_neigh_ifinfo_put(ifinfo1);
302err_ifinfo1:
303 return ret;
97869060
AQ
304}
305
306static bool batadv_v_neigh_is_sob(struct batadv_neigh_node *neigh1,
307 struct batadv_hard_iface *if_outgoing1,
308 struct batadv_neigh_node *neigh2,
309 struct batadv_hard_iface *if_outgoing2)
310{
311 struct batadv_neigh_ifinfo *ifinfo1, *ifinfo2;
312 u32 threshold;
71f9d27d 313 bool ret = false;
97869060
AQ
314
315 ifinfo1 = batadv_neigh_ifinfo_get(neigh1, if_outgoing1);
71f9d27d
SE
316 if (WARN_ON(!ifinfo1))
317 goto err_ifinfo1;
97869060 318
71f9d27d
SE
319 ifinfo2 = batadv_neigh_ifinfo_get(neigh2, if_outgoing2);
320 if (WARN_ON(!ifinfo2))
321 goto err_ifinfo2;
a45e932a 322
97869060
AQ
323 threshold = ifinfo1->bat_v.throughput / 4;
324 threshold = ifinfo1->bat_v.throughput - threshold;
325
71f9d27d
SE
326 ret = ifinfo2->bat_v.throughput > threshold;
327
328 batadv_neigh_ifinfo_put(ifinfo2);
329err_ifinfo2:
330 batadv_neigh_ifinfo_put(ifinfo1);
331err_ifinfo1:
332 return ret;
97869060
AQ
333}
334
d6f94d91
LL
335static struct batadv_algo_ops batadv_batman_v __read_mostly = {
336 .name = "BATMAN_V",
b6cf5d49 337 .bat_iface_activate = batadv_v_iface_activate,
d6f94d91
LL
338 .bat_iface_enable = batadv_v_iface_enable,
339 .bat_iface_disable = batadv_v_iface_disable,
340 .bat_iface_update_mac = batadv_v_iface_update_mac,
341 .bat_primary_iface_set = batadv_v_primary_iface_set,
162bd64c 342 .bat_hardif_neigh_init = batadv_v_hardif_neigh_init,
d6f94d91
LL
343 .bat_ogm_emit = batadv_v_ogm_emit,
344 .bat_ogm_schedule = batadv_v_ogm_schedule,
261e264d 345 .bat_orig_print = batadv_v_orig_print,
97869060
AQ
346 .bat_neigh_cmp = batadv_v_neigh_cmp,
347 .bat_neigh_is_similar_or_better = batadv_v_neigh_is_sob,
626d23e8 348 .bat_neigh_print = batadv_v_neigh_print,
d6f94d91
LL
349};
350
0da00359
AQ
351/**
352 * batadv_v_mesh_init - initialize the B.A.T.M.A.N. V private resources for a
353 * mesh
354 * @bat_priv: the object representing the mesh interface to initialise
355 *
356 * Return: 0 on success or a negative error code otherwise
357 */
358int batadv_v_mesh_init(struct batadv_priv *bat_priv)
359{
360 return batadv_v_ogm_init(bat_priv);
361}
362
363/**
364 * batadv_v_mesh_free - free the B.A.T.M.A.N. V private resources for a mesh
365 * @bat_priv: the object representing the mesh interface to free
366 */
367void batadv_v_mesh_free(struct batadv_priv *bat_priv)
368{
369 batadv_v_ogm_free(bat_priv);
370}
371
d6f94d91
LL
372/**
373 * batadv_v_init - B.A.T.M.A.N. V initialization function
374 *
375 * Description: Takes care of initializing all the subcomponents.
376 * It is invoked upon module load only.
377 *
378 * Return: 0 on success or a negative error code otherwise
379 */
380int __init batadv_v_init(void)
381{
162bd64c
LL
382 int ret;
383
384 /* B.A.T.M.A.N. V echo location protocol packet */
385 ret = batadv_recv_handler_register(BATADV_ELP,
386 batadv_v_elp_packet_recv);
387 if (ret < 0)
388 return ret;
389
0da00359
AQ
390 ret = batadv_recv_handler_register(BATADV_OGM2,
391 batadv_v_ogm_packet_recv);
392 if (ret < 0)
393 goto elp_unregister;
162bd64c 394
0da00359 395 ret = batadv_algo_register(&batadv_batman_v);
162bd64c 396 if (ret < 0)
0da00359
AQ
397 goto ogm_unregister;
398
399 return ret;
400
401ogm_unregister:
402 batadv_recv_handler_unregister(BATADV_OGM2);
403
404elp_unregister:
405 batadv_recv_handler_unregister(BATADV_ELP);
162bd64c
LL
406
407 return ret;
d6f94d91 408}