2 * Copyright (C) 2007-2011 B.A.T.M.A.N. contributors:
4 * Marek Lindner, Simon Wunderlich
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of version 2 of the GNU General Public
8 * License as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
25 #include "translation-table.h"
26 #include "soft-interface.h"
27 #include "hard-interface.h"
29 #include "aggregation.h"
30 #include "gateway_common.h"
31 #include "originator.h"
33 static void send_outstanding_bcast_packet(struct work_struct *work);
35 /* apply hop penalty for a normal link */
36 static uint8_t hop_penalty(uint8_t tq, const struct bat_priv *bat_priv)
38 int hop_penalty = atomic_read(&bat_priv->hop_penalty);
39 return (tq * (TQ_MAX_VALUE - hop_penalty)) / (TQ_MAX_VALUE);
42 /* when do we schedule our own packet to be sent */
43 static unsigned long own_send_time(const struct bat_priv *bat_priv)
45 return jiffies + msecs_to_jiffies(
46 atomic_read(&bat_priv->orig_interval) -
47 JITTER + (random32() % 2*JITTER));
50 /* when do we schedule a forwarded packet to be sent */
51 static unsigned long forward_send_time(void)
53 return jiffies + msecs_to_jiffies(random32() % (JITTER/2));
56 /* send out an already prepared packet to the given address via the
57 * specified batman interface */
58 int send_skb_packet(struct sk_buff *skb, struct hard_iface *hard_iface,
59 const uint8_t *dst_addr)
61 struct ethhdr *ethhdr;
63 if (hard_iface->if_status != IF_ACTIVE)
66 if (unlikely(!hard_iface->net_dev))
69 if (!(hard_iface->net_dev->flags & IFF_UP)) {
70 pr_warning("Interface %s is not up - can't send packet via "
71 "that interface!\n", hard_iface->net_dev->name);
75 /* push to the ethernet header. */
76 if (my_skb_head_push(skb, sizeof(*ethhdr)) < 0)
79 skb_reset_mac_header(skb);
81 ethhdr = (struct ethhdr *) skb_mac_header(skb);
82 memcpy(ethhdr->h_source, hard_iface->net_dev->dev_addr, ETH_ALEN);
83 memcpy(ethhdr->h_dest, dst_addr, ETH_ALEN);
84 ethhdr->h_proto = __constant_htons(ETH_P_BATMAN);
86 skb_set_network_header(skb, ETH_HLEN);
87 skb->priority = TC_PRIO_CONTROL;
88 skb->protocol = __constant_htons(ETH_P_BATMAN);
90 skb->dev = hard_iface->net_dev;
92 /* dev_queue_xmit() returns a negative result on error. However on
93 * congestion and traffic shaping, it drops and returns NET_XMIT_DROP
94 * (which is > 0). This will not be treated as an error. */
96 return dev_queue_xmit(skb);
102 /* Send a packet to a given interface */
103 static void send_packet_to_if(struct forw_packet *forw_packet,
104 struct hard_iface *hard_iface)
106 struct bat_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
110 struct batman_packet *batman_packet;
113 if (hard_iface->if_status != IF_ACTIVE)
118 batman_packet = (struct batman_packet *)forw_packet->skb->data;
120 /* adjust all flags and log packets */
121 while (aggregated_packet(buff_pos,
122 forw_packet->packet_len,
123 batman_packet->tt_num_changes)) {
125 /* we might have aggregated direct link packets with an
126 * ordinary base packet */
127 if ((forw_packet->direct_link_flags & (1 << packet_num)) &&
128 (forw_packet->if_incoming == hard_iface))
129 batman_packet->flags |= DIRECTLINK;
131 batman_packet->flags &= ~DIRECTLINK;
133 fwd_str = (packet_num > 0 ? "Forwarding" : (forw_packet->own ?
136 bat_dbg(DBG_BATMAN, bat_priv,
137 "%s %spacket (originator %pM, seqno %d, TQ %d, TTL %d,"
138 " IDF %s, hvn %d) on interface %s [%pM]\n",
139 fwd_str, (packet_num > 0 ? "aggregated " : ""),
140 batman_packet->orig, ntohl(batman_packet->seqno),
141 batman_packet->tq, batman_packet->ttl,
142 (batman_packet->flags & DIRECTLINK ?
144 batman_packet->ttvn, hard_iface->net_dev->name,
145 hard_iface->net_dev->dev_addr);
147 buff_pos += sizeof(*batman_packet) +
148 tt_len(batman_packet->tt_num_changes);
150 batman_packet = (struct batman_packet *)
151 (forw_packet->skb->data + buff_pos);
154 /* create clone because function is called more than once */
155 skb = skb_clone(forw_packet->skb, GFP_ATOMIC);
157 send_skb_packet(skb, hard_iface, broadcast_addr);
160 /* send a batman packet */
161 static void send_packet(struct forw_packet *forw_packet)
163 struct hard_iface *hard_iface;
164 struct net_device *soft_iface;
165 struct bat_priv *bat_priv;
166 struct batman_packet *batman_packet =
167 (struct batman_packet *)(forw_packet->skb->data);
168 int directlink = (batman_packet->flags & DIRECTLINK ? 1 : 0);
170 if (!forw_packet->if_incoming) {
171 pr_err("Error - can't forward packet: incoming iface not "
176 soft_iface = forw_packet->if_incoming->soft_iface;
177 bat_priv = netdev_priv(soft_iface);
179 if (forw_packet->if_incoming->if_status != IF_ACTIVE)
182 /* multihomed peer assumed */
183 /* non-primary OGMs are only broadcasted on their interface */
184 if ((directlink && (batman_packet->ttl == 1)) ||
185 (forw_packet->own && (forw_packet->if_incoming->if_num > 0))) {
187 /* FIXME: what about aggregated packets ? */
188 bat_dbg(DBG_BATMAN, bat_priv,
189 "%s packet (originator %pM, seqno %d, TTL %d) "
190 "on interface %s [%pM]\n",
191 (forw_packet->own ? "Sending own" : "Forwarding"),
192 batman_packet->orig, ntohl(batman_packet->seqno),
194 forw_packet->if_incoming->net_dev->name,
195 forw_packet->if_incoming->net_dev->dev_addr);
197 /* skb is only used once and than forw_packet is free'd */
198 send_skb_packet(forw_packet->skb, forw_packet->if_incoming,
200 forw_packet->skb = NULL;
205 /* broadcast on every interface */
207 list_for_each_entry_rcu(hard_iface, &hardif_list, list) {
208 if (hard_iface->soft_iface != soft_iface)
211 send_packet_to_if(forw_packet, hard_iface);
216 static void realloc_packet_buffer(struct hard_iface *hard_iface,
219 unsigned char *new_buff;
220 struct batman_packet *batman_packet;
222 new_buff = kmalloc(new_len, GFP_ATOMIC);
224 /* keep old buffer if kmalloc should fail */
226 memcpy(new_buff, hard_iface->packet_buff,
227 sizeof(*batman_packet));
229 kfree(hard_iface->packet_buff);
230 hard_iface->packet_buff = new_buff;
231 hard_iface->packet_len = new_len;
235 /* when calling this function (hard_iface == primary_if) has to be true */
236 static void prepare_packet_buffer(struct bat_priv *bat_priv,
237 struct hard_iface *hard_iface)
240 struct batman_packet *batman_packet;
242 new_len = BAT_PACKET_LEN +
243 tt_len((uint8_t)atomic_read(&bat_priv->tt_local_changes));
245 /* if we have too many changes for one packet don't send any
246 * and wait for the tt table request which will be fragmented */
247 if (new_len > hard_iface->soft_iface->mtu)
248 new_len = BAT_PACKET_LEN;
250 realloc_packet_buffer(hard_iface, new_len);
251 batman_packet = (struct batman_packet *)hard_iface->packet_buff;
253 atomic_set(&bat_priv->tt_crc, tt_local_crc(bat_priv));
255 /* reset the sending counter */
256 atomic_set(&bat_priv->tt_ogm_append_cnt, TT_OGM_APPEND_MAX);
258 batman_packet->tt_num_changes = tt_changes_fill_buffer(bat_priv,
259 hard_iface->packet_buff + BAT_PACKET_LEN,
260 hard_iface->packet_len - BAT_PACKET_LEN);
264 static void reset_packet_buffer(struct bat_priv *bat_priv,
265 struct hard_iface *hard_iface)
267 struct batman_packet *batman_packet;
269 realloc_packet_buffer(hard_iface, BAT_PACKET_LEN);
271 batman_packet = (struct batman_packet *)hard_iface->packet_buff;
272 batman_packet->tt_num_changes = 0;
275 void schedule_own_packet(struct hard_iface *hard_iface)
277 struct bat_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
278 struct hard_iface *primary_if;
279 unsigned long send_time;
280 struct batman_packet *batman_packet;
283 if ((hard_iface->if_status == IF_NOT_IN_USE) ||
284 (hard_iface->if_status == IF_TO_BE_REMOVED))
287 vis_server = atomic_read(&bat_priv->vis_mode);
288 primary_if = primary_if_get_selected(bat_priv);
291 * the interface gets activated here to avoid race conditions between
292 * the moment of activating the interface in
293 * hardif_activate_interface() where the originator mac is set and
294 * outdated packets (especially uninitialized mac addresses) in the
297 if (hard_iface->if_status == IF_TO_BE_ACTIVATED)
298 hard_iface->if_status = IF_ACTIVE;
300 if (hard_iface == primary_if) {
301 /* if at least one change happened */
302 if (atomic_read(&bat_priv->tt_local_changes) > 0) {
303 prepare_packet_buffer(bat_priv, hard_iface);
304 /* Increment the TTVN only once per OGM interval */
305 atomic_inc(&bat_priv->ttvn);
308 /* if the changes have been sent enough times */
309 if (!atomic_dec_not_zero(&bat_priv->tt_ogm_append_cnt))
310 reset_packet_buffer(bat_priv, hard_iface);
314 * NOTE: packet_buff might just have been re-allocated in
315 * prepare_packet_buffer() or in reset_packet_buffer()
317 batman_packet = (struct batman_packet *)hard_iface->packet_buff;
319 /* change sequence number to network order */
320 batman_packet->seqno =
321 htonl((uint32_t)atomic_read(&hard_iface->seqno));
323 batman_packet->ttvn = atomic_read(&bat_priv->ttvn);
324 batman_packet->tt_crc = htons((uint16_t)atomic_read(&bat_priv->tt_crc));
326 if (vis_server == VIS_TYPE_SERVER_SYNC)
327 batman_packet->flags |= VIS_SERVER;
329 batman_packet->flags &= ~VIS_SERVER;
331 if ((hard_iface == primary_if) &&
332 (atomic_read(&bat_priv->gw_mode) == GW_MODE_SERVER))
333 batman_packet->gw_flags =
334 (uint8_t)atomic_read(&bat_priv->gw_bandwidth);
336 batman_packet->gw_flags = NO_FLAGS;
338 atomic_inc(&hard_iface->seqno);
340 slide_own_bcast_window(hard_iface);
341 send_time = own_send_time(bat_priv);
342 add_bat_packet_to_list(bat_priv,
343 hard_iface->packet_buff,
344 hard_iface->packet_len,
345 hard_iface, 1, send_time);
348 hardif_free_ref(primary_if);
351 void schedule_forward_packet(struct orig_node *orig_node,
352 const struct ethhdr *ethhdr,
353 struct batman_packet *batman_packet,
355 struct hard_iface *if_incoming)
357 struct bat_priv *bat_priv = netdev_priv(if_incoming->soft_iface);
358 struct neigh_node *router;
359 uint8_t in_tq, in_ttl, tq_avg = 0;
360 unsigned long send_time;
361 uint8_t tt_num_changes;
363 if (batman_packet->ttl <= 1) {
364 bat_dbg(DBG_BATMAN, bat_priv, "ttl exceeded\n");
368 router = orig_node_get_router(orig_node);
370 in_tq = batman_packet->tq;
371 in_ttl = batman_packet->ttl;
372 tt_num_changes = batman_packet->tt_num_changes;
374 batman_packet->ttl--;
375 memcpy(batman_packet->prev_sender, ethhdr->h_source, ETH_ALEN);
377 /* rebroadcast tq of our best ranking neighbor to ensure the rebroadcast
378 * of our best tq value */
379 if (router && router->tq_avg != 0) {
381 /* rebroadcast ogm of best ranking neighbor as is */
382 if (!compare_eth(router->addr, ethhdr->h_source)) {
383 batman_packet->tq = router->tq_avg;
385 if (router->last_ttl)
386 batman_packet->ttl = router->last_ttl - 1;
389 tq_avg = router->tq_avg;
393 neigh_node_free_ref(router);
395 /* apply hop penalty */
396 batman_packet->tq = hop_penalty(batman_packet->tq, bat_priv);
398 bat_dbg(DBG_BATMAN, bat_priv,
399 "Forwarding packet: tq_orig: %i, tq_avg: %i, "
400 "tq_forw: %i, ttl_orig: %i, ttl_forw: %i\n",
401 in_tq, tq_avg, batman_packet->tq, in_ttl - 1,
404 batman_packet->seqno = htonl(batman_packet->seqno);
405 batman_packet->tt_crc = htons(batman_packet->tt_crc);
407 /* switch of primaries first hop flag when forwarding */
408 batman_packet->flags &= ~PRIMARIES_FIRST_HOP;
410 batman_packet->flags |= DIRECTLINK;
412 batman_packet->flags &= ~DIRECTLINK;
414 send_time = forward_send_time();
415 add_bat_packet_to_list(bat_priv,
416 (unsigned char *)batman_packet,
417 sizeof(*batman_packet) + tt_len(tt_num_changes),
418 if_incoming, 0, send_time);
421 static void forw_packet_free(struct forw_packet *forw_packet)
423 if (forw_packet->skb)
424 kfree_skb(forw_packet->skb);
425 if (forw_packet->if_incoming)
426 hardif_free_ref(forw_packet->if_incoming);
430 static void _add_bcast_packet_to_list(struct bat_priv *bat_priv,
431 struct forw_packet *forw_packet,
432 unsigned long send_time)
434 INIT_HLIST_NODE(&forw_packet->list);
436 /* add new packet to packet list */
437 spin_lock_bh(&bat_priv->forw_bcast_list_lock);
438 hlist_add_head(&forw_packet->list, &bat_priv->forw_bcast_list);
439 spin_unlock_bh(&bat_priv->forw_bcast_list_lock);
441 /* start timer for this packet */
442 INIT_DELAYED_WORK(&forw_packet->delayed_work,
443 send_outstanding_bcast_packet);
444 queue_delayed_work(bat_event_workqueue, &forw_packet->delayed_work,
448 /* add a broadcast packet to the queue and setup timers. broadcast packets
449 * are sent multiple times to increase probability for beeing received.
451 * This function returns NETDEV_TX_OK on success and NETDEV_TX_BUSY on
454 * The skb is not consumed, so the caller should make sure that the
456 int add_bcast_packet_to_list(struct bat_priv *bat_priv,
457 const struct sk_buff *skb)
459 struct hard_iface *primary_if = NULL;
460 struct forw_packet *forw_packet;
461 struct bcast_packet *bcast_packet;
462 struct sk_buff *newskb;
464 if (!atomic_dec_not_zero(&bat_priv->bcast_queue_left)) {
465 bat_dbg(DBG_BATMAN, bat_priv, "bcast packet queue full\n");
469 primary_if = primary_if_get_selected(bat_priv);
473 forw_packet = kmalloc(sizeof(*forw_packet), GFP_ATOMIC);
478 newskb = skb_copy(skb, GFP_ATOMIC);
482 /* as we have a copy now, it is safe to decrease the TTL */
483 bcast_packet = (struct bcast_packet *)newskb->data;
486 skb_reset_mac_header(newskb);
488 forw_packet->skb = newskb;
489 forw_packet->if_incoming = primary_if;
491 /* how often did we send the bcast packet ? */
492 forw_packet->num_packets = 0;
494 _add_bcast_packet_to_list(bat_priv, forw_packet, 1);
500 atomic_inc(&bat_priv->bcast_queue_left);
503 hardif_free_ref(primary_if);
504 return NETDEV_TX_BUSY;
507 static void send_outstanding_bcast_packet(struct work_struct *work)
509 struct hard_iface *hard_iface;
510 struct delayed_work *delayed_work =
511 container_of(work, struct delayed_work, work);
512 struct forw_packet *forw_packet =
513 container_of(delayed_work, struct forw_packet, delayed_work);
514 struct sk_buff *skb1;
515 struct net_device *soft_iface = forw_packet->if_incoming->soft_iface;
516 struct bat_priv *bat_priv = netdev_priv(soft_iface);
518 spin_lock_bh(&bat_priv->forw_bcast_list_lock);
519 hlist_del(&forw_packet->list);
520 spin_unlock_bh(&bat_priv->forw_bcast_list_lock);
522 if (atomic_read(&bat_priv->mesh_state) == MESH_DEACTIVATING)
525 /* rebroadcast packet */
527 list_for_each_entry_rcu(hard_iface, &hardif_list, list) {
528 if (hard_iface->soft_iface != soft_iface)
531 /* send a copy of the saved skb */
532 skb1 = skb_clone(forw_packet->skb, GFP_ATOMIC);
534 send_skb_packet(skb1, hard_iface, broadcast_addr);
538 forw_packet->num_packets++;
540 /* if we still have some more bcasts to send */
541 if (forw_packet->num_packets < 3) {
542 _add_bcast_packet_to_list(bat_priv, forw_packet,
548 forw_packet_free(forw_packet);
549 atomic_inc(&bat_priv->bcast_queue_left);
552 void send_outstanding_bat_packet(struct work_struct *work)
554 struct delayed_work *delayed_work =
555 container_of(work, struct delayed_work, work);
556 struct forw_packet *forw_packet =
557 container_of(delayed_work, struct forw_packet, delayed_work);
558 struct bat_priv *bat_priv;
560 bat_priv = netdev_priv(forw_packet->if_incoming->soft_iface);
561 spin_lock_bh(&bat_priv->forw_bat_list_lock);
562 hlist_del(&forw_packet->list);
563 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
565 if (atomic_read(&bat_priv->mesh_state) == MESH_DEACTIVATING)
568 send_packet(forw_packet);
571 * we have to have at least one packet in the queue
572 * to determine the queues wake up time unless we are
575 if (forw_packet->own)
576 schedule_own_packet(forw_packet->if_incoming);
579 /* don't count own packet */
580 if (!forw_packet->own)
581 atomic_inc(&bat_priv->batman_queue_left);
583 forw_packet_free(forw_packet);
586 void purge_outstanding_packets(struct bat_priv *bat_priv,
587 const struct hard_iface *hard_iface)
589 struct forw_packet *forw_packet;
590 struct hlist_node *tmp_node, *safe_tmp_node;
594 bat_dbg(DBG_BATMAN, bat_priv,
595 "purge_outstanding_packets(): %s\n",
596 hard_iface->net_dev->name);
598 bat_dbg(DBG_BATMAN, bat_priv,
599 "purge_outstanding_packets()\n");
601 /* free bcast list */
602 spin_lock_bh(&bat_priv->forw_bcast_list_lock);
603 hlist_for_each_entry_safe(forw_packet, tmp_node, safe_tmp_node,
604 &bat_priv->forw_bcast_list, list) {
607 * if purge_outstanding_packets() was called with an argmument
608 * we delete only packets belonging to the given interface
611 (forw_packet->if_incoming != hard_iface))
614 spin_unlock_bh(&bat_priv->forw_bcast_list_lock);
617 * send_outstanding_bcast_packet() will lock the list to
618 * delete the item from the list
620 pending = cancel_delayed_work_sync(&forw_packet->delayed_work);
621 spin_lock_bh(&bat_priv->forw_bcast_list_lock);
624 hlist_del(&forw_packet->list);
625 forw_packet_free(forw_packet);
628 spin_unlock_bh(&bat_priv->forw_bcast_list_lock);
630 /* free batman packet list */
631 spin_lock_bh(&bat_priv->forw_bat_list_lock);
632 hlist_for_each_entry_safe(forw_packet, tmp_node, safe_tmp_node,
633 &bat_priv->forw_bat_list, list) {
636 * if purge_outstanding_packets() was called with an argmument
637 * we delete only packets belonging to the given interface
640 (forw_packet->if_incoming != hard_iface))
643 spin_unlock_bh(&bat_priv->forw_bat_list_lock);
646 * send_outstanding_bat_packet() will lock the list to
647 * delete the item from the list
649 pending = cancel_delayed_work_sync(&forw_packet->delayed_work);
650 spin_lock_bh(&bat_priv->forw_bat_list_lock);
653 hlist_del(&forw_packet->list);
654 forw_packet_free(forw_packet);
657 spin_unlock_bh(&bat_priv->forw_bat_list_lock);