blob: 8376730ebd6987984a1f98625198677929d59fd3 [file] [log] [blame]
Linus Luessingd6f94d92016-01-16 16:40:09 +08001/* Copyright (C) 2011-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_v_elp.h"
19#include "main.h"
20
21#include <linux/atomic.h>
22#include <linux/byteorder/generic.h>
23#include <linux/errno.h>
24#include <linux/etherdevice.h>
Antonio Quartullic8334842015-11-10 18:50:51 +010025#include <linux/ethtool.h>
Linus Luessingd6f94d92016-01-16 16:40:09 +080026#include <linux/fs.h>
27#include <linux/if_ether.h>
28#include <linux/jiffies.h>
29#include <linux/kernel.h>
Antonio Quartullic8334842015-11-10 18:50:51 +010030#include <linux/kref.h>
Linus Luessingd6f94d92016-01-16 16:40:09 +080031#include <linux/netdevice.h>
32#include <linux/random.h>
33#include <linux/rculist.h>
34#include <linux/rcupdate.h>
Antonio Quartullic8334842015-11-10 18:50:51 +010035#include <linux/rtnetlink.h>
Linus Luessingd6f94d92016-01-16 16:40:09 +080036#include <linux/skbuff.h>
37#include <linux/stddef.h>
38#include <linux/string.h>
39#include <linux/types.h>
40#include <linux/workqueue.h>
Antonio Quartullic8334842015-11-10 18:50:51 +010041#include <net/cfg80211.h>
Linus Luessingd6f94d92016-01-16 16:40:09 +080042
43#include "bat_algo.h"
Antonio Quartulli93231582016-01-16 16:40:13 +080044#include "bat_v_ogm.h"
Linus Luessingd6f94d92016-01-16 16:40:09 +080045#include "hard-interface.h"
Linus Luessing162bd642016-01-16 16:40:10 +080046#include "originator.h"
Linus Luessingd6f94d92016-01-16 16:40:09 +080047#include "packet.h"
Linus Luessing162bd642016-01-16 16:40:10 +080048#include "routing.h"
Linus Luessingd6f94d92016-01-16 16:40:09 +080049#include "send.h"
50
51/**
52 * batadv_v_elp_start_timer - restart timer for ELP periodic work
53 * @hard_iface: the interface for which the timer has to be reset
54 */
55static void batadv_v_elp_start_timer(struct batadv_hard_iface *hard_iface)
56{
57 unsigned int msecs;
58
59 msecs = atomic_read(&hard_iface->bat_v.elp_interval) - BATADV_JITTER;
60 msecs += prandom_u32() % (2 * BATADV_JITTER);
61
62 queue_delayed_work(batadv_event_workqueue, &hard_iface->bat_v.elp_wq,
63 msecs_to_jiffies(msecs));
64}
65
66/**
Antonio Quartullic8334842015-11-10 18:50:51 +010067 * batadv_v_elp_get_throughput - get the throughput towards a neighbour
68 * @neigh: the neighbour for which the throughput has to be obtained
69 *
70 * Return: The throughput towards the given neighbour in multiples of 100kpbs
71 * (a value of '1' equals to 0.1Mbps, '10' equals 1Mbps, etc).
72 */
73static u32 batadv_v_elp_get_throughput(struct batadv_hardif_neigh_node *neigh)
74{
75 struct batadv_hard_iface *hard_iface = neigh->if_incoming;
76 struct ethtool_link_ksettings link_settings;
77 struct station_info sinfo;
78 u32 throughput;
79 int ret;
80
81 /* if the user specified a customised value for this interface, then
82 * return it directly
83 */
84 throughput = atomic_read(&hard_iface->bat_v.throughput_override);
85 if (throughput != 0)
86 return throughput;
87
88 /* if this is a wireless device, then ask its throughput through
89 * cfg80211 API
90 */
91 if (batadv_is_wifi_netdev(hard_iface->net_dev)) {
92 if (hard_iface->net_dev->ieee80211_ptr) {
93 ret = cfg80211_get_station(hard_iface->net_dev,
94 neigh->addr, &sinfo);
95 if (ret == -ENOENT) {
96 /* Node is not associated anymore! It would be
97 * possible to delete this neighbor. For now set
98 * the throughput metric to 0.
99 */
100 return 0;
101 }
102 if (!ret)
103 return sinfo.expected_throughput / 100;
104 }
105
106 /* unsupported WiFi driver version */
107 goto default_throughput;
108 }
109
110 /* if not a wifi interface, check if this device provides data via
111 * ethtool (e.g. an Ethernet adapter)
112 */
113 memset(&link_settings, 0, sizeof(link_settings));
114 rtnl_lock();
115 ret = __ethtool_get_link_ksettings(hard_iface->net_dev, &link_settings);
116 rtnl_unlock();
117 if (ret == 0) {
118 /* link characteristics might change over time */
119 if (link_settings.base.duplex == DUPLEX_FULL)
120 hard_iface->bat_v.flags |= BATADV_FULL_DUPLEX;
121 else
122 hard_iface->bat_v.flags &= ~BATADV_FULL_DUPLEX;
123
124 throughput = link_settings.base.speed;
125 if (throughput && (throughput != SPEED_UNKNOWN))
126 return throughput * 10;
127 }
128
129default_throughput:
130 if (!(hard_iface->bat_v.flags & BATADV_WARNING_DEFAULT)) {
131 batadv_info(hard_iface->soft_iface,
132 "WiFi driver or ethtool info does not provide information about link speeds on interface %s, therefore defaulting to hardcoded throughput values of %u.%1u Mbps. Consider overriding the throughput manually or checking your driver.\n",
133 hard_iface->net_dev->name,
134 BATADV_THROUGHPUT_DEFAULT_VALUE / 10,
135 BATADV_THROUGHPUT_DEFAULT_VALUE % 10);
136 hard_iface->bat_v.flags |= BATADV_WARNING_DEFAULT;
137 }
138
139 /* if none of the above cases apply, return the base_throughput */
140 return BATADV_THROUGHPUT_DEFAULT_VALUE;
141}
142
143/**
144 * batadv_v_elp_throughput_metric_update - worker updating the throughput metric
145 * of a single hop neighbour
146 * @work: the work queue item
147 */
148void batadv_v_elp_throughput_metric_update(struct work_struct *work)
149{
150 struct batadv_hardif_neigh_node_bat_v *neigh_bat_v;
151 struct batadv_hardif_neigh_node *neigh;
152
153 neigh_bat_v = container_of(work, struct batadv_hardif_neigh_node_bat_v,
154 metric_work);
155 neigh = container_of(neigh_bat_v, struct batadv_hardif_neigh_node,
156 bat_v);
157
158 ewma_throughput_add(&neigh->bat_v.throughput,
159 batadv_v_elp_get_throughput(neigh));
160
161 /* decrement refcounter to balance increment performed before scheduling
162 * this task
163 */
164 batadv_hardif_neigh_put(neigh);
165}
166
167/**
Linus Luessingd6f94d92016-01-16 16:40:09 +0800168 * batadv_v_elp_periodic_work - ELP periodic task per interface
169 * @work: work queue item
170 *
171 * Emits broadcast ELP message in regular intervals.
172 */
173static void batadv_v_elp_periodic_work(struct work_struct *work)
174{
Antonio Quartullic8334842015-11-10 18:50:51 +0100175 struct batadv_hardif_neigh_node *hardif_neigh;
Linus Luessingd6f94d92016-01-16 16:40:09 +0800176 struct batadv_hard_iface *hard_iface;
177 struct batadv_hard_iface_bat_v *bat_v;
178 struct batadv_elp_packet *elp_packet;
179 struct batadv_priv *bat_priv;
180 struct sk_buff *skb;
181 u32 elp_interval;
182
183 bat_v = container_of(work, struct batadv_hard_iface_bat_v, elp_wq.work);
184 hard_iface = container_of(bat_v, struct batadv_hard_iface, bat_v);
185 bat_priv = netdev_priv(hard_iface->soft_iface);
186
187 if (atomic_read(&bat_priv->mesh_state) == BATADV_MESH_DEACTIVATING)
188 goto out;
189
190 /* we are in the process of shutting this interface down */
191 if ((hard_iface->if_status == BATADV_IF_NOT_IN_USE) ||
192 (hard_iface->if_status == BATADV_IF_TO_BE_REMOVED))
193 goto out;
194
195 /* the interface was enabled but may not be ready yet */
196 if (hard_iface->if_status != BATADV_IF_ACTIVE)
197 goto restart_timer;
198
199 skb = skb_copy(hard_iface->bat_v.elp_skb, GFP_ATOMIC);
200 if (!skb)
201 goto restart_timer;
202
203 elp_packet = (struct batadv_elp_packet *)skb->data;
204 elp_packet->seqno = htonl(atomic_read(&hard_iface->bat_v.elp_seqno));
205 elp_interval = atomic_read(&hard_iface->bat_v.elp_interval);
206 elp_packet->elp_interval = htonl(elp_interval);
207
208 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
209 "Sending broadcast ELP packet on interface %s, seqno %u\n",
210 hard_iface->net_dev->name,
211 atomic_read(&hard_iface->bat_v.elp_seqno));
212
Antonio Quartulli95d39272016-01-16 16:40:15 +0800213 batadv_send_broadcast_skb(skb, hard_iface);
Linus Luessingd6f94d92016-01-16 16:40:09 +0800214
215 atomic_inc(&hard_iface->bat_v.elp_seqno);
216
Antonio Quartullic8334842015-11-10 18:50:51 +0100217 /* The throughput metric is updated on each sent packet. This way, if a
218 * node is dead and no longer sends packets, batman-adv is still able to
219 * react timely to its death.
220 *
221 * The throughput metric is updated by following these steps:
222 * 1) if the hard_iface is wifi => send a number of unicast ELPs for
223 * probing/sampling to each neighbor
224 * 2) update the throughput metric value of each neighbor (note that the
225 * value retrieved in this step might be 100ms old because the
226 * probing packets at point 1) could still be in the HW queue)
227 */
228 rcu_read_lock();
229 hlist_for_each_entry_rcu(hardif_neigh, &hard_iface->neigh_list, list) {
230 if (!kref_get_unless_zero(&hardif_neigh->refcount))
231 continue;
232
233 /* Reading the estimated throughput from cfg80211 is a task that
234 * may sleep and that is not allowed in an rcu protected
235 * context. Therefore schedule a task for that.
236 */
237 queue_work(batadv_event_workqueue,
238 &hardif_neigh->bat_v.metric_work);
239 }
240 rcu_read_unlock();
241
Linus Luessingd6f94d92016-01-16 16:40:09 +0800242restart_timer:
243 batadv_v_elp_start_timer(hard_iface);
244out:
245 return;
246}
247
248/**
249 * batadv_v_elp_iface_enable - setup the ELP interface private resources
250 * @hard_iface: interface for which the data has to be prepared
251 *
252 * Return: 0 on success or a -ENOMEM in case of failure.
253 */
254int batadv_v_elp_iface_enable(struct batadv_hard_iface *hard_iface)
255{
256 struct batadv_elp_packet *elp_packet;
257 unsigned char *elp_buff;
258 u32 random_seqno;
259 size_t size;
260 int res = -ENOMEM;
261
262 size = ETH_HLEN + NET_IP_ALIGN + BATADV_ELP_HLEN;
263 hard_iface->bat_v.elp_skb = dev_alloc_skb(size);
264 if (!hard_iface->bat_v.elp_skb)
265 goto out;
266
267 skb_reserve(hard_iface->bat_v.elp_skb, ETH_HLEN + NET_IP_ALIGN);
268 elp_buff = skb_push(hard_iface->bat_v.elp_skb, BATADV_ELP_HLEN);
269 elp_packet = (struct batadv_elp_packet *)elp_buff;
270 memset(elp_packet, 0, BATADV_ELP_HLEN);
271
272 elp_packet->packet_type = BATADV_ELP;
273 elp_packet->version = BATADV_COMPAT_VERSION;
274
275 /* randomize initial seqno to avoid collision */
276 get_random_bytes(&random_seqno, sizeof(random_seqno));
277 atomic_set(&hard_iface->bat_v.elp_seqno, random_seqno);
278 atomic_set(&hard_iface->bat_v.elp_interval, 500);
279
Antonio Quartullic8334842015-11-10 18:50:51 +0100280 /* assume full-duplex by default */
281 hard_iface->bat_v.flags |= BATADV_FULL_DUPLEX;
282
283 /* warn the user (again) if there is no throughput data is available */
284 hard_iface->bat_v.flags &= ~BATADV_WARNING_DEFAULT;
285
286 if (batadv_is_wifi_netdev(hard_iface->net_dev))
287 hard_iface->bat_v.flags &= ~BATADV_FULL_DUPLEX;
288
Linus Luessingd6f94d92016-01-16 16:40:09 +0800289 INIT_DELAYED_WORK(&hard_iface->bat_v.elp_wq,
290 batadv_v_elp_periodic_work);
291 batadv_v_elp_start_timer(hard_iface);
292 res = 0;
293
294out:
295 return res;
296}
297
298/**
299 * batadv_v_elp_iface_disable - release ELP interface private resources
300 * @hard_iface: interface for which the resources have to be released
301 */
302void batadv_v_elp_iface_disable(struct batadv_hard_iface *hard_iface)
303{
304 cancel_delayed_work_sync(&hard_iface->bat_v.elp_wq);
305
306 dev_kfree_skb(hard_iface->bat_v.elp_skb);
307 hard_iface->bat_v.elp_skb = NULL;
308}
309
310/**
311 * batadv_v_elp_primary_iface_set - change internal data to reflect the new
312 * primary interface
313 * @primary_iface: the new primary interface
314 */
315void batadv_v_elp_primary_iface_set(struct batadv_hard_iface *primary_iface)
316{
317 struct batadv_hard_iface *hard_iface;
318 struct batadv_elp_packet *elp_packet;
319 struct sk_buff *skb;
320
321 /* update orig field of every elp iface belonging to this mesh */
322 rcu_read_lock();
323 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
324 if (primary_iface->soft_iface != hard_iface->soft_iface)
325 continue;
326
327 if (!hard_iface->bat_v.elp_skb)
328 continue;
329
330 skb = hard_iface->bat_v.elp_skb;
331 elp_packet = (struct batadv_elp_packet *)skb->data;
332 ether_addr_copy(elp_packet->orig,
333 primary_iface->net_dev->dev_addr);
334 }
335 rcu_read_unlock();
336}
Linus Luessing162bd642016-01-16 16:40:10 +0800337
338/**
Linus Luessing162bd642016-01-16 16:40:10 +0800339 * batadv_v_elp_neigh_update - update an ELP neighbour node
340 * @bat_priv: the bat priv with all the soft interface information
341 * @neigh_addr: the neighbour interface address
342 * @if_incoming: the interface the packet was received through
343 * @elp_packet: the received ELP packet
344 *
345 * Updates the ELP neighbour node state with the data received within the new
346 * ELP packet.
347 */
348static void batadv_v_elp_neigh_update(struct batadv_priv *bat_priv,
349 u8 *neigh_addr,
350 struct batadv_hard_iface *if_incoming,
351 struct batadv_elp_packet *elp_packet)
352
353{
354 struct batadv_neigh_node *neigh;
355 struct batadv_orig_node *orig_neigh;
356 struct batadv_hardif_neigh_node *hardif_neigh;
357 s32 seqno_diff;
358 s32 elp_latest_seqno;
359
360 orig_neigh = batadv_v_ogm_orig_get(bat_priv, elp_packet->orig);
361 if (!orig_neigh)
362 return;
363
364 neigh = batadv_neigh_node_new(orig_neigh, if_incoming, neigh_addr);
365 if (!neigh)
366 goto orig_free;
367
368 hardif_neigh = batadv_hardif_neigh_get(if_incoming, neigh_addr);
369 if (!hardif_neigh)
370 goto neigh_free;
371
372 elp_latest_seqno = hardif_neigh->bat_v.elp_latest_seqno;
373 seqno_diff = ntohl(elp_packet->seqno) - elp_latest_seqno;
374
375 /* known or older sequence numbers are ignored. However always adopt
376 * if the router seems to have been restarted.
377 */
378 if (seqno_diff < 1 && seqno_diff > -BATADV_ELP_MAX_AGE)
379 goto hardif_free;
380
381 neigh->last_seen = jiffies;
382 hardif_neigh->last_seen = jiffies;
383 hardif_neigh->bat_v.elp_latest_seqno = ntohl(elp_packet->seqno);
384 hardif_neigh->bat_v.elp_interval = ntohl(elp_packet->elp_interval);
385
386hardif_free:
387 if (hardif_neigh)
388 batadv_hardif_neigh_put(hardif_neigh);
389neigh_free:
390 if (neigh)
391 batadv_neigh_node_put(neigh);
392orig_free:
393 if (orig_neigh)
394 batadv_orig_node_put(orig_neigh);
395}
396
397/**
398 * batadv_v_elp_packet_recv - main ELP packet handler
399 * @skb: the received packet
400 * @if_incoming: the interface this packet was received through
401 *
402 * Return: NET_RX_SUCCESS and consumes the skb if the packet was peoperly
403 * processed or NET_RX_DROP in case of failure.
404 */
405int batadv_v_elp_packet_recv(struct sk_buff *skb,
406 struct batadv_hard_iface *if_incoming)
407{
408 struct batadv_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
409 struct batadv_elp_packet *elp_packet;
410 struct batadv_hard_iface *primary_if;
411 struct ethhdr *ethhdr = (struct ethhdr *)skb_mac_header(skb);
412 bool ret;
413
414 ret = batadv_check_management_packet(skb, if_incoming, BATADV_ELP_HLEN);
415 if (!ret)
416 return NET_RX_DROP;
417
418 if (batadv_is_my_mac(bat_priv, ethhdr->h_source))
419 return NET_RX_DROP;
420
421 /* did we receive a B.A.T.M.A.N. V ELP packet on an interface
422 * that does not have B.A.T.M.A.N. V ELP enabled ?
423 */
424 if (strcmp(bat_priv->bat_algo_ops->name, "BATMAN_V") != 0)
425 return NET_RX_DROP;
426
427 elp_packet = (struct batadv_elp_packet *)skb->data;
428
429 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
430 "Received ELP packet from %pM seqno %u ORIG: %pM\n",
431 ethhdr->h_source, ntohl(elp_packet->seqno),
432 elp_packet->orig);
433
434 primary_if = batadv_primary_if_get_selected(bat_priv);
435 if (!primary_if)
436 goto out;
437
438 batadv_v_elp_neigh_update(bat_priv, ethhdr->h_source, if_incoming,
439 elp_packet);
440
441out:
442 if (primary_if)
443 batadv_hardif_put(primary_if);
444 consume_skb(skb);
445 return NET_RX_SUCCESS;
446}