net/batman-adv/main.c

   1 /* Copyright (C) 2007-2013 B.A.T.M.A.N. contributors:
   2  *
   3  * Marek Lindner, Simon Wunderlich
   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, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17  * 02110-1301, USA
  18  */
  19
  20 #include <linux/crc32c.h>
  21 #include <linux/highmem.h>
  22 #include <linux/if_vlan.h>
  23 #include <net/ip.h>
  24 #include <net/ipv6.h>
  25 #include <net/dsfield.h>
  26 #include "main.h"
  27 #include "sysfs.h"
  28 #include "debugfs.h"
  29 #include "routing.h"
  30 #include "send.h"
  31 #include "originator.h"
  32 #include "soft-interface.h"
  33 #include "icmp_socket.h"
  34 #include "translation-table.h"
  35 #include "hard-interface.h"
  36 #include "gateway_client.h"
  37 #include "bridge_loop_avoidance.h"
  38 #include "distributed-arp-table.h"
  39 #include "gateway_common.h"
  40 #include "hash.h"
  41 #include "bat_algo.h"
  42 #include "network-coding.h"
  43 #include "fragmentation.h"
  44
  45
  46 /* List manipulations on hardif_list have to be rtnl_lock()'ed,
  47  * list traversals just rcu-locked
  48  */
  49 struct list_head batadv_hardif_list;
  50 static int (*batadv_rx_handler[256])(struct sk_buff *,
  51                                      struct batadv_hard_iface *);
  52 char batadv_routing_algo[20] = "BATMAN_IV";
  53 static struct hlist_head batadv_algo_list;
  54
  55 unsigned char batadv_broadcast_addr[] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
  56
  57 struct workqueue_struct *batadv_event_workqueue;
  58
  59 static void batadv_recv_handler_init(void);
  60
  61 static int __init batadv_init(void)
  62 {
  63         INIT_LIST_HEAD(&batadv_hardif_list);
  64         INIT_HLIST_HEAD(&batadv_algo_list);
  65
  66         batadv_recv_handler_init();
  67
  68         batadv_iv_init();
  69         batadv_nc_init();
  70
  71         batadv_event_workqueue = create_singlethread_workqueue("bat_events");
  72
  73         if (!batadv_event_workqueue)
  74                 return -ENOMEM;
  75
  76         batadv_socket_init();
  77         batadv_debugfs_init();
  78
  79         register_netdevice_notifier(&batadv_hard_if_notifier);
  80         rtnl_link_register(&batadv_link_ops);
  81
  82         pr_info("B.A.T.M.A.N. advanced %s (compatibility version %i) loaded\n",
  83                 BATADV_SOURCE_VERSION, BATADV_COMPAT_VERSION);
  84
  85         return 0;
  86 }
  87
  88 static void __exit batadv_exit(void)
  89 {
  90         batadv_debugfs_destroy();
  91         rtnl_link_unregister(&batadv_link_ops);
  92         unregister_netdevice_notifier(&batadv_hard_if_notifier);
  93         batadv_hardif_remove_interfaces();
  94
  95         flush_workqueue(batadv_event_workqueue);
  96         destroy_workqueue(batadv_event_workqueue);
  97         batadv_event_workqueue = NULL;
  98
  99         rcu_barrier();
 100 }
 101
 102 int batadv_mesh_init(struct net_device *soft_iface)
 103 {
 104         struct batadv_priv *bat_priv = netdev_priv(soft_iface);
 105         int ret;
 106
 107         spin_lock_init(&bat_priv->forw_bat_list_lock);
 108         spin_lock_init(&bat_priv->forw_bcast_list_lock);
 109         spin_lock_init(&bat_priv->tt.changes_list_lock);
 110         spin_lock_init(&bat_priv->tt.req_list_lock);
 111         spin_lock_init(&bat_priv->tt.roam_list_lock);
 112         spin_lock_init(&bat_priv->tt.last_changeset_lock);
 113         spin_lock_init(&bat_priv->gw.list_lock);
 114         spin_lock_init(&bat_priv->tvlv.container_list_lock);
 115         spin_lock_init(&bat_priv->tvlv.handler_list_lock);
 116
 117         INIT_HLIST_HEAD(&bat_priv->forw_bat_list);
 118         INIT_HLIST_HEAD(&bat_priv->forw_bcast_list);
 119         INIT_HLIST_HEAD(&bat_priv->gw.list);
 120         INIT_LIST_HEAD(&bat_priv->tt.changes_list);
 121         INIT_LIST_HEAD(&bat_priv->tt.req_list);
 122         INIT_LIST_HEAD(&bat_priv->tt.roam_list);
 123         INIT_HLIST_HEAD(&bat_priv->tvlv.container_list);
 124         INIT_HLIST_HEAD(&bat_priv->tvlv.handler_list);
 125
 126         ret = batadv_originator_init(bat_priv);
 127         if (ret < 0)
 128                 goto err;
 129
 130         ret = batadv_tt_init(bat_priv);
 131         if (ret < 0)
 132                 goto err;
 133
 134         batadv_tt_local_add(soft_iface, soft_iface->dev_addr,
 135                             BATADV_NULL_IFINDEX);
 136
 137         ret = batadv_bla_init(bat_priv);
 138         if (ret < 0)
 139                 goto err;
 140
 141         ret = batadv_dat_init(bat_priv);
 142         if (ret < 0)
 143                 goto err;
 144
 145         ret = batadv_nc_mesh_init(bat_priv);
 146         if (ret < 0)
 147                 goto err;
 148
 149         batadv_gw_init(bat_priv);
 150
 151         atomic_set(&bat_priv->gw.reselect, 0);
 152         atomic_set(&bat_priv->mesh_state, BATADV_MESH_ACTIVE);
 153
 154         return 0;
 155
 156 err:
 157         batadv_mesh_free(soft_iface);
 158         return ret;
 159 }
 160
 161 void batadv_mesh_free(struct net_device *soft_iface)
 162 {
 163         struct batadv_priv *bat_priv = netdev_priv(soft_iface);
 164
 165         atomic_set(&bat_priv->mesh_state, BATADV_MESH_DEACTIVATING);
 166
 167         batadv_purge_outstanding_packets(bat_priv, NULL);
 168
 169         batadv_gw_node_purge(bat_priv);
 170         batadv_nc_mesh_free(bat_priv);
 171         batadv_dat_free(bat_priv);
 172         batadv_bla_free(bat_priv);
 173
 174         /* Free the TT and the originator tables only after having terminated
 175          * all the other depending components which may use these structures for
 176          * their purposes.
 177          */
 178         batadv_tt_free(bat_priv);
 179
 180         /* Since the originator table clean up routine is accessing the TT
 181          * tables as well, it has to be invoked after the TT tables have been
 182          * freed and marked as empty. This ensures that no cleanup RCU callbacks
 183          * accessing the TT data are scheduled for later execution.
 184          */
 185         batadv_originator_free(bat_priv);
 186
 187         batadv_gw_free(bat_priv);
 188
 189         free_percpu(bat_priv->bat_counters);
 190         bat_priv->bat_counters = NULL;
 191
 192         atomic_set(&bat_priv->mesh_state, BATADV_MESH_INACTIVE);
 193 }
 194
 195 /**
 196  * batadv_is_my_mac - check if the given mac address belongs to any of the real
 197  * interfaces in the current mesh
 198  * @bat_priv: the bat priv with all the soft interface information
 199  * @addr: the address to check
 200  */
 201 int batadv_is_my_mac(struct batadv_priv *bat_priv, const uint8_t *addr)
 202 {
 203         const struct batadv_hard_iface *hard_iface;
 204
 205         rcu_read_lock();
 206         list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
 207                 if (hard_iface->if_status != BATADV_IF_ACTIVE)
 208                         continue;
 209
 210                 if (hard_iface->soft_iface != bat_priv->soft_iface)
 211                         continue;
 212
 213                 if (batadv_compare_eth(hard_iface->net_dev->dev_addr, addr)) {
 214                         rcu_read_unlock();
 215                         return 1;
 216                 }
 217         }
 218         rcu_read_unlock();
 219         return 0;
 220 }
 221
 222 /**
 223  * batadv_seq_print_text_primary_if_get - called from debugfs table printing
 224  *  function that requires the primary interface
 225  * @seq: debugfs table seq_file struct
 226  *
 227  * Returns primary interface if found or NULL otherwise.
 228  */
 229 struct batadv_hard_iface *
 230 batadv_seq_print_text_primary_if_get(struct seq_file *seq)
 231 {
 232         struct net_device *net_dev = (struct net_device *)seq->private;
 233         struct batadv_priv *bat_priv = netdev_priv(net_dev);
 234         struct batadv_hard_iface *primary_if;
 235
 236         primary_if = batadv_primary_if_get_selected(bat_priv);
 237
 238         if (!primary_if) {
 239                 seq_printf(seq,
 240                            "BATMAN mesh %s disabled - please specify interfaces to enable it\n",
 241                            net_dev->name);
 242                 goto out;
 243         }
 244
 245         if (primary_if->if_status == BATADV_IF_ACTIVE)
 246                 goto out;
 247
 248         seq_printf(seq,
 249                    "BATMAN mesh %s disabled - primary interface not active\n",
 250                    net_dev->name);
 251         batadv_hardif_free_ref(primary_if);
 252         primary_if = NULL;
 253
 254 out:
 255         return primary_if;
 256 }
 257
 258 /**
 259  * batadv_max_header_len - calculate maximum encapsulation overhead for a
 260  *  payload packet
 261  *
 262  * Return the maximum encapsulation overhead in bytes.
 263  */
 264 int batadv_max_header_len(void)
 265 {
 266         int header_len = 0;
 267
 268         header_len = max_t(int, header_len,
 269                            sizeof(struct batadv_unicast_packet));
 270         header_len = max_t(int, header_len,
 271                            sizeof(struct batadv_unicast_4addr_packet));
 272         header_len = max_t(int, header_len,
 273                            sizeof(struct batadv_bcast_packet));
 274
 275 #ifdef CONFIG_BATMAN_ADV_NC
 276         header_len = max_t(int, header_len,
 277                            sizeof(struct batadv_coded_packet));
 278 #endif
 279
 280         return header_len;
 281 }
 282
 283 /**
 284  * batadv_skb_set_priority - sets skb priority according to packet content
 285  * @skb: the packet to be sent
 286  * @offset: offset to the packet content
 287  *
 288  * This function sets a value between 256 and 263 (802.1d priority), which
 289  * can be interpreted by the cfg80211 or other drivers.
 290  */
 291 void batadv_skb_set_priority(struct sk_buff *skb, int offset)
 292 {
 293         struct iphdr ip_hdr_tmp, *ip_hdr;
 294         struct ipv6hdr ip6_hdr_tmp, *ip6_hdr;
 295         struct ethhdr ethhdr_tmp, *ethhdr;
 296         struct vlan_ethhdr *vhdr, vhdr_tmp;
 297         u32 prio;
 298
 299         /* already set, do nothing */
 300         if (skb->priority >= 256 && skb->priority <= 263)
 301                 return;
 302
 303         ethhdr = skb_header_pointer(skb, offset, sizeof(*ethhdr), &ethhdr_tmp);
 304         if (!ethhdr)
 305                 return;
 306
 307         switch (ethhdr->h_proto) {
 308         case htons(ETH_P_8021Q):
 309                 vhdr = skb_header_pointer(skb, offset + sizeof(*vhdr),
 310                                           sizeof(*vhdr), &vhdr_tmp);
 311                 if (!vhdr)
 312                         return;
 313                 prio = ntohs(vhdr->h_vlan_TCI) & VLAN_PRIO_MASK;
 314                 prio = prio >> VLAN_PRIO_SHIFT;
 315                 break;
 316         case htons(ETH_P_IP):
 317                 ip_hdr = skb_header_pointer(skb, offset + sizeof(*ethhdr),
 318                                             sizeof(*ip_hdr), &ip_hdr_tmp);
 319                 if (!ip_hdr)
 320                         return;
 321                 prio = (ipv4_get_dsfield(ip_hdr) & 0xfc) >> 5;
 322                 break;
 323         case htons(ETH_P_IPV6):
 324                 ip6_hdr = skb_header_pointer(skb, offset + sizeof(*ethhdr),
 325                                              sizeof(*ip6_hdr), &ip6_hdr_tmp);
 326                 if (!ip6_hdr)
 327                         return;
 328                 prio = (ipv6_get_dsfield(ip6_hdr) & 0xfc) >> 5;
 329                 break;
 330         default:
 331                 return;
 332         }
 333
 334         skb->priority = prio + 256;
 335 }
 336
 337 static int batadv_recv_unhandled_packet(struct sk_buff *skb,
 338                                         struct batadv_hard_iface *recv_if)
 339 {
 340         return NET_RX_DROP;
 341 }
 342
 343 /* incoming packets with the batman ethertype received on any active hard
 344  * interface
 345  */
 346 int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev,
 347                            struct packet_type *ptype,
 348                            struct net_device *orig_dev)
 349 {
 350         struct batadv_priv *bat_priv;
 351         struct batadv_ogm_packet *batadv_ogm_packet;
 352         struct batadv_hard_iface *hard_iface;
 353         uint8_t idx;
 354         int ret;
 355
 356         hard_iface = container_of(ptype, struct batadv_hard_iface,
 357                                   batman_adv_ptype);
 358         skb = skb_share_check(skb, GFP_ATOMIC);
 359
 360         /* skb was released by skb_share_check() */
 361         if (!skb)
 362                 goto err_out;
 363
 364         /* packet should hold at least type and version */
 365         if (unlikely(!pskb_may_pull(skb, 2)))
 366                 goto err_free;
 367
 368         /* expect a valid ethernet header here. */
 369         if (unlikely(skb->mac_len != ETH_HLEN || !skb_mac_header(skb)))
 370                 goto err_free;
 371
 372         if (!hard_iface->soft_iface)
 373                 goto err_free;
 374
 375         bat_priv = netdev_priv(hard_iface->soft_iface);
 376
 377         if (atomic_read(&bat_priv->mesh_state) != BATADV_MESH_ACTIVE)
 378                 goto err_free;
 379
 380         /* discard frames on not active interfaces */
 381         if (hard_iface->if_status != BATADV_IF_ACTIVE)
 382                 goto err_free;
 383
 384         batadv_ogm_packet = (struct batadv_ogm_packet *)skb->data;
 385
 386         if (batadv_ogm_packet->header.version != BATADV_COMPAT_VERSION) {
 387                 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
 388                            "Drop packet: incompatible batman version (%i)\n",
 389                            batadv_ogm_packet->header.version);
 390                 goto err_free;
 391         }
 392
 393         /* all receive handlers return whether they received or reused
 394          * the supplied skb. if not, we have to free the skb.
 395          */
 396         idx = batadv_ogm_packet->header.packet_type;
 397         ret = (*batadv_rx_handler[idx])(skb, hard_iface);
 398
 399         if (ret == NET_RX_DROP)
 400                 kfree_skb(skb);
 401
 402         /* return NET_RX_SUCCESS in any case as we
 403          * most probably dropped the packet for
 404          * routing-logical reasons.
 405          */
 406         return NET_RX_SUCCESS;
 407
 408 err_free:
 409         kfree_skb(skb);
 410 err_out:
 411         return NET_RX_DROP;
 412 }
 413
 414 static void batadv_recv_handler_init(void)
 415 {
 416         int i;
 417
 418         for (i = 0; i < ARRAY_SIZE(batadv_rx_handler); i++)
 419                 batadv_rx_handler[i] = batadv_recv_unhandled_packet;
 420
 421         for (i = BATADV_UNICAST_MIN; i <= BATADV_UNICAST_MAX; i++)
 422                 batadv_rx_handler[i] = batadv_recv_unhandled_unicast_packet;
 423
 424         /* compile time checks for struct member offsets */
 425         BUILD_BUG_ON(offsetof(struct batadv_unicast_4addr_packet, src) != 10);
 426         BUILD_BUG_ON(offsetof(struct batadv_unicast_packet, dest) != 4);
 427         BUILD_BUG_ON(offsetof(struct batadv_unicast_tvlv_packet, dst) != 4);
 428         BUILD_BUG_ON(offsetof(struct batadv_frag_packet, dest) != 4);
 429         BUILD_BUG_ON(offsetof(struct batadv_icmp_packet, icmph.dst) != 4);
 430         BUILD_BUG_ON(offsetof(struct batadv_icmp_packet_rr, icmph.dst) != 4);
 431
 432         /* broadcast packet */
 433         batadv_rx_handler[BATADV_BCAST] = batadv_recv_bcast_packet;
 434
 435         /* unicast packets ... */
 436         /* unicast with 4 addresses packet */
 437         batadv_rx_handler[BATADV_UNICAST_4ADDR] = batadv_recv_unicast_packet;
 438         /* unicast packet */
 439         batadv_rx_handler[BATADV_UNICAST] = batadv_recv_unicast_packet;
 440         /* unicast tvlv packet */
 441         batadv_rx_handler[BATADV_UNICAST_TVLV] = batadv_recv_unicast_tvlv;
 442         /* batman icmp packet */
 443         batadv_rx_handler[BATADV_ICMP] = batadv_recv_icmp_packet;
 444         /* Fragmented packets */
 445         batadv_rx_handler[BATADV_UNICAST_FRAG] = batadv_recv_frag_packet;
 446 }
 447
 448 int
 449 batadv_recv_handler_register(uint8_t packet_type,
 450                              int (*recv_handler)(struct sk_buff *,
 451                                                  struct batadv_hard_iface *))
 452 {
 453         int (*curr)(struct sk_buff *,
 454                     struct batadv_hard_iface *);
 455         curr = batadv_rx_handler[packet_type];
 456
 457         if ((curr != batadv_recv_unhandled_packet) &&
 458             (curr != batadv_recv_unhandled_unicast_packet))
 459                 return -EBUSY;
 460
 461         batadv_rx_handler[packet_type] = recv_handler;
 462         return 0;
 463 }
 464
 465 void batadv_recv_handler_unregister(uint8_t packet_type)
 466 {
 467         batadv_rx_handler[packet_type] = batadv_recv_unhandled_packet;
 468 }
 469
 470 static struct batadv_algo_ops *batadv_algo_get(char *name)
 471 {
 472         struct batadv_algo_ops *bat_algo_ops = NULL, *bat_algo_ops_tmp;
 473
 474         hlist_for_each_entry(bat_algo_ops_tmp, &batadv_algo_list, list) {
 475                 if (strcmp(bat_algo_ops_tmp->name, name) != 0)
 476                         continue;
 477
 478                 bat_algo_ops = bat_algo_ops_tmp;
 479                 break;
 480         }
 481
 482         return bat_algo_ops;
 483 }
 484
 485 int batadv_algo_register(struct batadv_algo_ops *bat_algo_ops)
 486 {
 487         struct batadv_algo_ops *bat_algo_ops_tmp;
 488         int ret;
 489
 490         bat_algo_ops_tmp = batadv_algo_get(bat_algo_ops->name);
 491         if (bat_algo_ops_tmp) {
 492                 pr_info("Trying to register already registered routing algorithm: %s\n",
 493                         bat_algo_ops->name);
 494                 ret = -EEXIST;
 495                 goto out;
 496         }
 497
 498         /* all algorithms must implement all ops (for now) */
 499         if (!bat_algo_ops->bat_iface_enable ||
 500             !bat_algo_ops->bat_iface_disable ||
 501             !bat_algo_ops->bat_iface_update_mac ||
 502             !bat_algo_ops->bat_primary_iface_set ||
 503             !bat_algo_ops->bat_ogm_schedule ||
 504             !bat_algo_ops->bat_ogm_emit) {
 505                 pr_info("Routing algo '%s' does not implement required ops\n",
 506                         bat_algo_ops->name);
 507                 ret = -EINVAL;
 508                 goto out;
 509         }
 510
 511         INIT_HLIST_NODE(&bat_algo_ops->list);
 512         hlist_add_head(&bat_algo_ops->list, &batadv_algo_list);
 513         ret = 0;
 514
 515 out:
 516         return ret;
 517 }
 518
 519 int batadv_algo_select(struct batadv_priv *bat_priv, char *name)
 520 {
 521         struct batadv_algo_ops *bat_algo_ops;
 522         int ret = -EINVAL;
 523
 524         bat_algo_ops = batadv_algo_get(name);
 525         if (!bat_algo_ops)
 526                 goto out;
 527
 528         bat_priv->bat_algo_ops = bat_algo_ops;
 529         ret = 0;
 530
 531 out:
 532         return ret;
 533 }
 534
 535 int batadv_algo_seq_print_text(struct seq_file *seq, void *offset)
 536 {
 537         struct batadv_algo_ops *bat_algo_ops;
 538
 539         seq_puts(seq, "Available routing algorithms:\n");
 540
 541         hlist_for_each_entry(bat_algo_ops, &batadv_algo_list, list) {
 542                 seq_printf(seq, "%s\n", bat_algo_ops->name);
 543         }
 544
 545         return 0;
 546 }
 547
 548 /**
 549  * batadv_skb_crc32 - calculate CRC32 of the whole packet and skip bytes in
 550  *  the header
 551  * @skb: skb pointing to fragmented socket buffers
 552  * @payload_ptr: Pointer to position inside the head buffer of the skb
 553  *  marking the start of the data to be CRC'ed
 554  *
 555  * payload_ptr must always point to an address in the skb head buffer and not to
 556  * a fragment.
 557  */
 558 __be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr)
 559 {
 560         u32 crc = 0;
 561         unsigned int from;
 562         unsigned int to = skb->len;
 563         struct skb_seq_state st;
 564         const u8 *data;
 565         unsigned int len;
 566         unsigned int consumed = 0;
 567
 568         from = (unsigned int)(payload_ptr - skb->data);
 569
 570         skb_prepare_seq_read(skb, from, to, &st);
 571         while ((len = skb_seq_read(consumed, &data, &st)) != 0) {
 572                 crc = crc32c(crc, data, len);
 573                 consumed += len;
 574         }
 575
 576         return htonl(crc);
 577 }
 578
 579 /**
 580  * batadv_tvlv_handler_free_ref - decrement the tvlv handler refcounter and
 581  *  possibly free it
 582  * @tvlv_handler: the tvlv handler to free
 583  */
 584 static void
 585 batadv_tvlv_handler_free_ref(struct batadv_tvlv_handler *tvlv_handler)
 586 {
 587         if (atomic_dec_and_test(&tvlv_handler->refcount))
 588                 kfree_rcu(tvlv_handler, rcu);
 589 }
 590
 591 /**
 592  * batadv_tvlv_handler_get - retrieve tvlv handler from the tvlv handler list
 593  *  based on the provided type and version (both need to match)
 594  * @bat_priv: the bat priv with all the soft interface information
 595  * @type: tvlv handler type to look for
 596  * @version: tvlv handler version to look for
 597  *
 598  * Returns tvlv handler if found or NULL otherwise.
 599  */
 600 static struct batadv_tvlv_handler
 601 *batadv_tvlv_handler_get(struct batadv_priv *bat_priv,
 602                          uint8_t type, uint8_t version)
 603 {
 604         struct batadv_tvlv_handler *tvlv_handler_tmp, *tvlv_handler = NULL;
 605
 606         rcu_read_lock();
 607         hlist_for_each_entry_rcu(tvlv_handler_tmp,
 608                                  &bat_priv->tvlv.handler_list, list) {
 609                 if (tvlv_handler_tmp->type != type)
 610                         continue;
 611
 612                 if (tvlv_handler_tmp->version != version)
 613                         continue;
 614
 615                 if (!atomic_inc_not_zero(&tvlv_handler_tmp->refcount))
 616                         continue;
 617
 618                 tvlv_handler = tvlv_handler_tmp;
 619                 break;
 620         }
 621         rcu_read_unlock();
 622
 623         return tvlv_handler;
 624 }
 625
 626 /**
 627  * batadv_tvlv_container_free_ref - decrement the tvlv container refcounter and
 628  *  possibly free it
 629  * @tvlv_handler: the tvlv container to free
 630  */
 631 static void batadv_tvlv_container_free_ref(struct batadv_tvlv_container *tvlv)
 632 {
 633         if (atomic_dec_and_test(&tvlv->refcount))
 634                 kfree(tvlv);
 635 }
 636
 637 /**
 638  * batadv_tvlv_container_get - retrieve tvlv container from the tvlv container
 639  *  list based on the provided type and version (both need to match)
 640  * @bat_priv: the bat priv with all the soft interface information
 641  * @type: tvlv container type to look for
 642  * @version: tvlv container version to look for
 643  *
 644  * Has to be called with the appropriate locks being acquired
 645  * (tvlv.container_list_lock).
 646  *
 647  * Returns tvlv container if found or NULL otherwise.
 648  */
 649 static struct batadv_tvlv_container
 650 *batadv_tvlv_container_get(struct batadv_priv *bat_priv,
 651                            uint8_t type, uint8_t version)
 652 {
 653         struct batadv_tvlv_container *tvlv_tmp, *tvlv = NULL;
 654
 655         hlist_for_each_entry(tvlv_tmp, &bat_priv->tvlv.container_list, list) {
 656                 if (tvlv_tmp->tvlv_hdr.type != type)
 657                         continue;
 658
 659                 if (tvlv_tmp->tvlv_hdr.version != version)
 660                         continue;
 661
 662                 if (!atomic_inc_not_zero(&tvlv_tmp->refcount))
 663                         continue;
 664
 665                 tvlv = tvlv_tmp;
 666                 break;
 667         }
 668
 669         return tvlv;
 670 }
 671
 672 /**
 673  * batadv_tvlv_container_list_size - calculate the size of the tvlv container
 674  *  list entries
 675  * @bat_priv: the bat priv with all the soft interface information
 676  *
 677  * Has to be called with the appropriate locks being acquired
 678  * (tvlv.container_list_lock).
 679  *
 680  * Returns size of all currently registered tvlv containers in bytes.
 681  */
 682 static uint16_t batadv_tvlv_container_list_size(struct batadv_priv *bat_priv)
 683 {
 684         struct batadv_tvlv_container *tvlv;
 685         uint16_t tvlv_len = 0;
 686
 687         hlist_for_each_entry(tvlv, &bat_priv->tvlv.container_list, list) {
 688                 tvlv_len += sizeof(struct batadv_tvlv_hdr);
 689                 tvlv_len += ntohs(tvlv->tvlv_hdr.len);
 690         }
 691
 692         return tvlv_len;
 693 }
 694
 695 /**
 696  * batadv_tvlv_container_remove - remove tvlv container from the tvlv container
 697  *  list
 698  * @tvlv: the to be removed tvlv container
 699  *
 700  * Has to be called with the appropriate locks being acquired
 701  * (tvlv.container_list_lock).
 702  */
 703 static void batadv_tvlv_container_remove(struct batadv_tvlv_container *tvlv)
 704 {
 705         if (!tvlv)
 706                 return;
 707
 708         hlist_del(&tvlv->list);
 709
 710         /* first call to decrement the counter, second call to free */
 711         batadv_tvlv_container_free_ref(tvlv);
 712         batadv_tvlv_container_free_ref(tvlv);
 713 }
 714
 715 /**
 716  * batadv_tvlv_container_unregister - unregister tvlv container based on the
 717  *  provided type and version (both need to match)
 718  * @bat_priv: the bat priv with all the soft interface information
 719  * @type: tvlv container type to unregister
 720  * @version: tvlv container type to unregister
 721  */
 722 void batadv_tvlv_container_unregister(struct batadv_priv *bat_priv,
 723                                       uint8_t type, uint8_t version)
 724 {
 725         struct batadv_tvlv_container *tvlv;
 726
 727         spin_lock_bh(&bat_priv->tvlv.container_list_lock);
 728         tvlv = batadv_tvlv_container_get(bat_priv, type, version);
 729         batadv_tvlv_container_remove(tvlv);
 730         spin_unlock_bh(&bat_priv->tvlv.container_list_lock);
 731 }
 732
 733 /**
 734  * batadv_tvlv_container_register - register tvlv type, version and content
 735  *  to be propagated with each (primary interface) OGM
 736  * @bat_priv: the bat priv with all the soft interface information
 737  * @type: tvlv container type
 738  * @version: tvlv container version
 739  * @tvlv_value: tvlv container content
 740  * @tvlv_value_len: tvlv container content length
 741  *
 742  * If a container of the same type and version was already registered the new
 743  * content is going to replace the old one.
 744  */
 745 void batadv_tvlv_container_register(struct batadv_priv *bat_priv,
 746                                     uint8_t type, uint8_t version,
 747                                     void *tvlv_value, uint16_t tvlv_value_len)
 748 {
 749         struct batadv_tvlv_container *tvlv_old, *tvlv_new;
 750
 751         if (!tvlv_value)
 752                 tvlv_value_len = 0;
 753
 754         tvlv_new = kzalloc(sizeof(*tvlv_new) + tvlv_value_len, GFP_ATOMIC);
 755         if (!tvlv_new)
 756                 return;
 757
 758         tvlv_new->tvlv_hdr.version = version;
 759         tvlv_new->tvlv_hdr.type = type;
 760         tvlv_new->tvlv_hdr.len = htons(tvlv_value_len);
 761
 762         memcpy(tvlv_new + 1, tvlv_value, ntohs(tvlv_new->tvlv_hdr.len));
 763         INIT_HLIST_NODE(&tvlv_new->list);
 764         atomic_set(&tvlv_new->refcount, 1);
 765
 766         spin_lock_bh(&bat_priv->tvlv.container_list_lock);
 767         tvlv_old = batadv_tvlv_container_get(bat_priv, type, version);
 768         batadv_tvlv_container_remove(tvlv_old);
 769         hlist_add_head(&tvlv_new->list, &bat_priv->tvlv.container_list);
 770         spin_unlock_bh(&bat_priv->tvlv.container_list_lock);
 771 }
 772
 773 /**
 774  * batadv_tvlv_realloc_packet_buff - reallocate packet buffer to accomodate
 775  *  requested packet size
 776  * @packet_buff: packet buffer
 777  * @packet_buff_len: packet buffer size
 778  * @packet_min_len: requested packet minimum size
 779  * @additional_packet_len: requested additional packet size on top of minimum
 780  *  size
 781  *
 782  * Returns true of the packet buffer could be changed to the requested size,
 783  * false otherwise.
 784  */
 785 static bool batadv_tvlv_realloc_packet_buff(unsigned char **packet_buff,
 786                                             int *packet_buff_len,
 787                                             int min_packet_len,
 788                                             int additional_packet_len)
 789 {
 790         unsigned char *new_buff;
 791
 792         new_buff = kmalloc(min_packet_len + additional_packet_len, GFP_ATOMIC);
 793
 794         /* keep old buffer if kmalloc should fail */
 795         if (new_buff) {
 796                 memcpy(new_buff, *packet_buff, min_packet_len);
 797                 kfree(*packet_buff);
 798                 *packet_buff = new_buff;
 799                 *packet_buff_len = min_packet_len + additional_packet_len;
 800                 return true;
 801         }
 802
 803         return false;
 804 }
 805
 806 /**
 807  * batadv_tvlv_container_ogm_append - append tvlv container content to given
 808  *  OGM packet buffer
 809  * @bat_priv: the bat priv with all the soft interface information
 810  * @packet_buff: ogm packet buffer
 811  * @packet_buff_len: ogm packet buffer size including ogm header and tvlv
 812  *  content
 813  * @packet_min_len: ogm header size to be preserved for the OGM itself
 814  *
 815  * The ogm packet might be enlarged or shrunk depending on the current size
 816  * and the size of the to-be-appended tvlv containers.
 817  *
 818  * Returns size of all appended tvlv containers in bytes.
 819  */
 820 uint16_t batadv_tvlv_container_ogm_append(struct batadv_priv *bat_priv,
 821                                           unsigned char **packet_buff,
 822                                           int *packet_buff_len,
 823                                           int packet_min_len)
 824 {
 825         struct batadv_tvlv_container *tvlv;
 826         struct batadv_tvlv_hdr *tvlv_hdr;
 827         uint16_t tvlv_value_len;
 828         void *tvlv_value;
 829         bool ret;
 830
 831         spin_lock_bh(&bat_priv->tvlv.container_list_lock);
 832         tvlv_value_len = batadv_tvlv_container_list_size(bat_priv);
 833
 834         ret = batadv_tvlv_realloc_packet_buff(packet_buff, packet_buff_len,
 835                                               packet_min_len, tvlv_value_len);
 836
 837         if (!ret)
 838                 goto end;
 839
 840         if (!tvlv_value_len)
 841                 goto end;
 842
 843         tvlv_value = (*packet_buff) + packet_min_len;
 844
 845         hlist_for_each_entry(tvlv, &bat_priv->tvlv.container_list, list) {
 846                 tvlv_hdr = tvlv_value;
 847                 tvlv_hdr->type = tvlv->tvlv_hdr.type;
 848                 tvlv_hdr->version = tvlv->tvlv_hdr.version;
 849                 tvlv_hdr->len = tvlv->tvlv_hdr.len;
 850                 tvlv_value = tvlv_hdr + 1;
 851                 memcpy(tvlv_value, tvlv + 1, ntohs(tvlv->tvlv_hdr.len));
 852                 tvlv_value = (uint8_t *)tvlv_value + ntohs(tvlv->tvlv_hdr.len);
 853         }
 854
 855 end:
 856         spin_unlock_bh(&bat_priv->tvlv.container_list_lock);
 857         return tvlv_value_len;
 858 }
 859
 860 /**
 861  * batadv_tvlv_call_handler - parse the given tvlv buffer to call the
 862  *  appropriate handlers
 863  * @bat_priv: the bat priv with all the soft interface information
 864  * @tvlv_handler: tvlv callback function handling the tvlv content
 865  * @ogm_source: flag indicating wether the tvlv is an ogm or a unicast packet
 866  * @orig_node: orig node emitting the ogm packet
 867  * @src: source mac address of the unicast packet
 868  * @dst: destination mac address of the unicast packet
 869  * @tvlv_value: tvlv content
 870  * @tvlv_value_len: tvlv content length
 871  *
 872  * Returns success if handler was not found or the return value of the handler
 873  * callback.
 874  */
 875 static int batadv_tvlv_call_handler(struct batadv_priv *bat_priv,
 876                                     struct batadv_tvlv_handler *tvlv_handler,
 877                                     bool ogm_source,
 878                                     struct batadv_orig_node *orig_node,
 879                                     uint8_t *src, uint8_t *dst,
 880                                     void *tvlv_value, uint16_t tvlv_value_len)
 881 {
 882         if (!tvlv_handler)
 883                 return NET_RX_SUCCESS;
 884
 885         if (ogm_source) {
 886                 if (!tvlv_handler->ogm_handler)
 887                         return NET_RX_SUCCESS;
 888
 889                 if (!orig_node)
 890                         return NET_RX_SUCCESS;
 891
 892                 tvlv_handler->ogm_handler(bat_priv, orig_node,
 893                                           BATADV_NO_FLAGS,
 894                                           tvlv_value, tvlv_value_len);
 895                 tvlv_handler->flags |= BATADV_TVLV_HANDLER_OGM_CALLED;
 896         } else {
 897                 if (!src)
 898                         return NET_RX_SUCCESS;
 899
 900                 if (!dst)
 901                         return NET_RX_SUCCESS;
 902
 903                 if (!tvlv_handler->unicast_handler)
 904                         return NET_RX_SUCCESS;
 905
 906                 return tvlv_handler->unicast_handler(bat_priv, src,
 907                                                      dst, tvlv_value,
 908                                                      tvlv_value_len);
 909         }
 910
 911         return NET_RX_SUCCESS;
 912 }
 913
 914 /**
 915  * batadv_tvlv_containers_process - parse the given tvlv buffer to call the
 916  *  appropriate handlers
 917  * @bat_priv: the bat priv with all the soft interface information
 918  * @ogm_source: flag indicating wether the tvlv is an ogm or a unicast packet
 919  * @orig_node: orig node emitting the ogm packet
 920  * @src: source mac address of the unicast packet
 921  * @dst: destination mac address of the unicast packet
 922  * @tvlv_value: tvlv content
 923  * @tvlv_value_len: tvlv content length
 924  *
 925  * Returns success when processing an OGM or the return value of all called
 926  * handler callbacks.
 927  */
 928 int batadv_tvlv_containers_process(struct batadv_priv *bat_priv,
 929                                    bool ogm_source,
 930                                    struct batadv_orig_node *orig_node,
 931                                    uint8_t *src, uint8_t *dst,
 932                                    void *tvlv_value, uint16_t tvlv_value_len)
 933 {
 934         struct batadv_tvlv_handler *tvlv_handler;
 935         struct batadv_tvlv_hdr *tvlv_hdr;
 936         uint16_t tvlv_value_cont_len;
 937         uint8_t cifnotfound = BATADV_TVLV_HANDLER_OGM_CIFNOTFND;
 938         int ret = NET_RX_SUCCESS;
 939
 940         while (tvlv_value_len >= sizeof(*tvlv_hdr)) {
 941                 tvlv_hdr = tvlv_value;
 942                 tvlv_value_cont_len = ntohs(tvlv_hdr->len);
 943                 tvlv_value = tvlv_hdr + 1;
 944                 tvlv_value_len -= sizeof(*tvlv_hdr);
 945
 946                 if (tvlv_value_cont_len > tvlv_value_len)
 947                         break;
 948
 949                 tvlv_handler = batadv_tvlv_handler_get(bat_priv,
 950                                                        tvlv_hdr->type,
 951                                                        tvlv_hdr->version);
 952
 953                 ret |= batadv_tvlv_call_handler(bat_priv, tvlv_handler,
 954                                                 ogm_source, orig_node,
 955                                                 src, dst, tvlv_value,
 956                                                 tvlv_value_cont_len);
 957                 if (tvlv_handler)
 958                         batadv_tvlv_handler_free_ref(tvlv_handler);
 959                 tvlv_value = (uint8_t *)tvlv_value + tvlv_value_cont_len;
 960                 tvlv_value_len -= tvlv_value_cont_len;
 961         }
 962
 963         if (!ogm_source)
 964                 return ret;
 965
 966         rcu_read_lock();
 967         hlist_for_each_entry_rcu(tvlv_handler,
 968                                  &bat_priv->tvlv.handler_list, list) {
 969                 if ((tvlv_handler->flags & BATADV_TVLV_HANDLER_OGM_CIFNOTFND) &&
 970                     !(tvlv_handler->flags & BATADV_TVLV_HANDLER_OGM_CALLED))
 971                         tvlv_handler->ogm_handler(bat_priv, orig_node,
 972                                                   cifnotfound, NULL, 0);
 973
 974                 tvlv_handler->flags &= ~BATADV_TVLV_HANDLER_OGM_CALLED;
 975         }
 976         rcu_read_unlock();
 977
 978         return NET_RX_SUCCESS;
 979 }
 980
 981 /**
 982  * batadv_tvlv_ogm_receive - process an incoming ogm and call the appropriate
 983  *  handlers
 984  * @bat_priv: the bat priv with all the soft interface information
 985  * @batadv_ogm_packet: ogm packet containing the tvlv containers
 986  * @orig_node: orig node emitting the ogm packet
 987  */
 988 void batadv_tvlv_ogm_receive(struct batadv_priv *bat_priv,
 989                              struct batadv_ogm_packet *batadv_ogm_packet,
 990                              struct batadv_orig_node *orig_node)
 991 {
 992         void *tvlv_value;
 993         uint16_t tvlv_value_len;
 994
 995         if (!batadv_ogm_packet)
 996                 return;
 997
 998         tvlv_value_len = ntohs(batadv_ogm_packet->tvlv_len);
 999         if (!tvlv_value_len)
1000                 return;
1001
1002         tvlv_value = batadv_ogm_packet + 1;
1003
1004         batadv_tvlv_containers_process(bat_priv, true, orig_node, NULL, NULL,
1005                                        tvlv_value, tvlv_value_len);
1006 }
1007
1008 /**
1009  * batadv_tvlv_handler_register - register tvlv handler based on the provided
1010  *  type and version (both need to match) for ogm tvlv payload and/or unicast
1011  *  payload
1012  * @bat_priv: the bat priv with all the soft interface information
1013  * @optr: ogm tvlv handler callback function. This function receives the orig
1014  *  node, flags and the tvlv content as argument to process.
1015  * @uptr: unicast tvlv handler callback function. This function receives the
1016  *  source & destination of the unicast packet as well as the tvlv content
1017  *  to process.
1018  * @type: tvlv handler type to be registered
1019  * @version: tvlv handler version to be registered
1020  * @flags: flags to enable or disable TVLV API behavior
1021  */
1022 void batadv_tvlv_handler_register(struct batadv_priv *bat_priv,
1023                                   void (*optr)(struct batadv_priv *bat_priv,
1024                                                struct batadv_orig_node *orig,
1025                                                uint8_t flags,
1026                                                void *tvlv_value,
1027                                                uint16_t tvlv_value_len),
1028                                   int (*uptr)(struct batadv_priv *bat_priv,
1029                                               uint8_t *src, uint8_t *dst,
1030                                               void *tvlv_value,
1031                                               uint16_t tvlv_value_len),
1032                                   uint8_t type, uint8_t version, uint8_t flags)
1033 {
1034         struct batadv_tvlv_handler *tvlv_handler;
1035
1036         tvlv_handler = batadv_tvlv_handler_get(bat_priv, type, version);
1037         if (tvlv_handler) {
1038                 batadv_tvlv_handler_free_ref(tvlv_handler);
1039                 return;
1040         }
1041
1042         tvlv_handler = kzalloc(sizeof(*tvlv_handler), GFP_ATOMIC);
1043         if (!tvlv_handler)
1044                 return;
1045
1046         tvlv_handler->ogm_handler = optr;
1047         tvlv_handler->unicast_handler = uptr;
1048         tvlv_handler->type = type;
1049         tvlv_handler->version = version;
1050         tvlv_handler->flags = flags;
1051         atomic_set(&tvlv_handler->refcount, 1);
1052         INIT_HLIST_NODE(&tvlv_handler->list);
1053
1054         spin_lock_bh(&bat_priv->tvlv.handler_list_lock);
1055         hlist_add_head_rcu(&tvlv_handler->list, &bat_priv->tvlv.handler_list);
1056         spin_unlock_bh(&bat_priv->tvlv.handler_list_lock);
1057 }
1058
1059 /**
1060  * batadv_tvlv_handler_unregister - unregister tvlv handler based on the
1061  *  provided type and version (both need to match)
1062  * @bat_priv: the bat priv with all the soft interface information
1063  * @type: tvlv handler type to be unregistered
1064  * @version: tvlv handler version to be unregistered
1065  */
1066 void batadv_tvlv_handler_unregister(struct batadv_priv *bat_priv,
1067                                     uint8_t type, uint8_t version)
1068 {
1069         struct batadv_tvlv_handler *tvlv_handler;
1070
1071         tvlv_handler = batadv_tvlv_handler_get(bat_priv, type, version);
1072         if (!tvlv_handler)
1073                 return;
1074
1075         batadv_tvlv_handler_free_ref(tvlv_handler);
1076         spin_lock_bh(&bat_priv->tvlv.handler_list_lock);
1077         hlist_del_rcu(&tvlv_handler->list);
1078         spin_unlock_bh(&bat_priv->tvlv.handler_list_lock);
1079         batadv_tvlv_handler_free_ref(tvlv_handler);
1080 }
1081
1082 /**
1083  * batadv_tvlv_unicast_send - send a unicast packet with tvlv payload to the
1084  *  specified host
1085  * @bat_priv: the bat priv with all the soft interface information
1086  * @src: source mac address of the unicast packet
1087  * @dst: destination mac address of the unicast packet
1088  * @type: tvlv type
1089  * @version: tvlv version
1090  * @tvlv_value: tvlv content
1091  * @tvlv_value_len: tvlv content length
1092  */
1093 void batadv_tvlv_unicast_send(struct batadv_priv *bat_priv, uint8_t *src,
1094                               uint8_t *dst, uint8_t type, uint8_t version,
1095                               void *tvlv_value, uint16_t tvlv_value_len)
1096 {
1097         struct batadv_unicast_tvlv_packet *unicast_tvlv_packet;
1098         struct batadv_tvlv_hdr *tvlv_hdr;
1099         struct batadv_orig_node *orig_node;
1100         struct sk_buff *skb = NULL;
1101         unsigned char *tvlv_buff;
1102         unsigned int tvlv_len;
1103         ssize_t hdr_len = sizeof(*unicast_tvlv_packet);
1104         bool ret = false;
1105
1106         orig_node = batadv_orig_hash_find(bat_priv, dst);
1107         if (!orig_node)
1108                 goto out;
1109
1110         tvlv_len = sizeof(*tvlv_hdr) + tvlv_value_len;
1111
1112         skb = netdev_alloc_skb_ip_align(NULL, ETH_HLEN + hdr_len + tvlv_len);
1113         if (!skb)
1114                 goto out;
1115
1116         skb->priority = TC_PRIO_CONTROL;
1117         skb_reserve(skb, ETH_HLEN);
1118         tvlv_buff = skb_put(skb, sizeof(*unicast_tvlv_packet) + tvlv_len);
1119         unicast_tvlv_packet = (struct batadv_unicast_tvlv_packet *)tvlv_buff;
1120         unicast_tvlv_packet->header.packet_type = BATADV_UNICAST_TVLV;
1121         unicast_tvlv_packet->header.version = BATADV_COMPAT_VERSION;
1122         unicast_tvlv_packet->header.ttl = BATADV_TTL;
1123         unicast_tvlv_packet->reserved = 0;
1124         unicast_tvlv_packet->tvlv_len = htons(tvlv_len);
1125         unicast_tvlv_packet->align = 0;
1126         memcpy(unicast_tvlv_packet->src, src, ETH_ALEN);
1127         memcpy(unicast_tvlv_packet->dst, dst, ETH_ALEN);
1128
1129         tvlv_buff = (unsigned char *)(unicast_tvlv_packet + 1);
1130         tvlv_hdr = (struct batadv_tvlv_hdr *)tvlv_buff;
1131         tvlv_hdr->version = version;
1132         tvlv_hdr->type = type;
1133         tvlv_hdr->len = htons(tvlv_value_len);
1134         tvlv_buff += sizeof(*tvlv_hdr);
1135         memcpy(tvlv_buff, tvlv_value, tvlv_value_len);
1136
1137         if (batadv_send_skb_to_orig(skb, orig_node, NULL) != NET_XMIT_DROP)
1138                 ret = true;
1139
1140 out:
1141         if (skb && !ret)
1142                 kfree_skb(skb);
1143         if (orig_node)
1144                 batadv_orig_node_free_ref(orig_node);
1145 }
1146
1147 static int batadv_param_set_ra(const char *val, const struct kernel_param *kp)
1148 {
1149         struct batadv_algo_ops *bat_algo_ops;
1150         char *algo_name = (char *)val;
1151         size_t name_len = strlen(algo_name);
1152
1153         if (name_len > 0 && algo_name[name_len - 1] == '\n')
1154                 algo_name[name_len - 1] = '\0';
1155
1156         bat_algo_ops = batadv_algo_get(algo_name);
1157         if (!bat_algo_ops) {
1158                 pr_err("Routing algorithm '%s' is not supported\n", algo_name);
1159                 return -EINVAL;
1160         }
1161
1162         return param_set_copystring(algo_name, kp);
1163 }
1164
1165 static const struct kernel_param_ops batadv_param_ops_ra = {
1166         .set = batadv_param_set_ra,
1167         .get = param_get_string,
1168 };
1169
1170 static struct kparam_string batadv_param_string_ra = {
1171         .maxlen = sizeof(batadv_routing_algo),
1172         .string = batadv_routing_algo,
1173 };
1174
1175 module_param_cb(routing_algo, &batadv_param_ops_ra, &batadv_param_string_ra,
1176                 0644);
1177 module_init(batadv_init);
1178 module_exit(batadv_exit);
1179
1180 MODULE_LICENSE("GPL");
1181
1182 MODULE_AUTHOR(BATADV_DRIVER_AUTHOR);
1183 MODULE_DESCRIPTION(BATADV_DRIVER_DESC);
1184 MODULE_SUPPORTED_DEVICE(BATADV_DRIVER_DEVICE);
1185 MODULE_VERSION(BATADV_SOURCE_VERSION);