net/batman-adv/gateway_client.c

   1 /*
   2  * Copyright (C) 2009-2011 B.A.T.M.A.N. contributors:
   3  *
   4  * Marek Lindner
   5  *
   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.
   9  *
  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.
  14  *
  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
  18  * 02110-1301, USA
  19  *
  20  */
  21
  22 #include "main.h"
  23 #include "gateway_client.h"
  24 #include "gateway_common.h"
  25 #include "hard-interface.h"
  26 #include "originator.h"
  27 #include <linux/ip.h>
  28 #include <linux/ipv6.h>
  29 #include <linux/udp.h>
  30 #include <linux/if_vlan.h>
  31
  32 static void gw_node_free_ref(struct gw_node *gw_node)
  33 {
  34         if (atomic_dec_and_test(&gw_node->refcount))
  35                 kfree_rcu(gw_node, rcu);
  36 }
  37
  38 static struct gw_node *gw_get_selected_gw_node(struct bat_priv *bat_priv)
  39 {
  40         struct gw_node *gw_node;
  41
  42         rcu_read_lock();
  43         gw_node = rcu_dereference(bat_priv->curr_gw);
  44         if (!gw_node)
  45                 goto out;
  46
  47         if (!atomic_inc_not_zero(&gw_node->refcount))
  48                 gw_node = NULL;
  49
  50 out:
  51         rcu_read_unlock();
  52         return gw_node;
  53 }
  54
  55 struct orig_node *gw_get_selected_orig(struct bat_priv *bat_priv)
  56 {
  57         struct gw_node *gw_node;
  58         struct orig_node *orig_node = NULL;
  59
  60         gw_node = gw_get_selected_gw_node(bat_priv);
  61         if (!gw_node)
  62                 goto out;
  63
  64         rcu_read_lock();
  65         orig_node = gw_node->orig_node;
  66         if (!orig_node)
  67                 goto unlock;
  68
  69         if (!atomic_inc_not_zero(&orig_node->refcount))
  70                 orig_node = NULL;
  71
  72 unlock:
  73         rcu_read_unlock();
  74 out:
  75         if (gw_node)
  76                 gw_node_free_ref(gw_node);
  77         return orig_node;
  78 }
  79
  80 static void gw_select(struct bat_priv *bat_priv, struct gw_node *new_gw_node)
  81 {
  82         struct gw_node *curr_gw_node;
  83
  84         spin_lock_bh(&bat_priv->gw_list_lock);
  85
  86         if (new_gw_node && !atomic_inc_not_zero(&new_gw_node->refcount))
  87                 new_gw_node = NULL;
  88
  89         curr_gw_node = bat_priv->curr_gw;
  90         rcu_assign_pointer(bat_priv->curr_gw, new_gw_node);
  91
  92         if (curr_gw_node)
  93                 gw_node_free_ref(curr_gw_node);
  94
  95         spin_unlock_bh(&bat_priv->gw_list_lock);
  96 }
  97
  98 void gw_deselect(struct bat_priv *bat_priv)
  99 {
 100         gw_select(bat_priv, NULL);
 101 }
 102
 103 void gw_election(struct bat_priv *bat_priv)
 104 {
 105         struct hlist_node *node;
 106         struct gw_node *gw_node, *curr_gw = NULL, *curr_gw_tmp = NULL;
 107         struct neigh_node *router;
 108         uint8_t max_tq = 0;
 109         uint32_t max_gw_factor = 0, tmp_gw_factor = 0;
 110         int down, up;
 111
 112         /**
 113          * The batman daemon checks here if we already passed a full originator
 114          * cycle in order to make sure we don't choose the first gateway we
 115          * hear about. This check is based on the daemon's uptime which we
 116          * don't have.
 117          **/
 118         if (atomic_read(&bat_priv->gw_mode) != GW_MODE_CLIENT)
 119                 return;
 120
 121         curr_gw = gw_get_selected_gw_node(bat_priv);
 122         if (curr_gw)
 123                 goto out;
 124
 125         rcu_read_lock();
 126         if (hlist_empty(&bat_priv->gw_list)) {
 127                 bat_dbg(DBG_BATMAN, bat_priv,
 128                         "Removing selected gateway - "
 129                         "no gateway in range\n");
 130                 gw_deselect(bat_priv);
 131                 goto unlock;
 132         }
 133
 134         hlist_for_each_entry_rcu(gw_node, node, &bat_priv->gw_list, list) {
 135                 if (gw_node->deleted)
 136                         continue;
 137
 138                 router = orig_node_get_router(gw_node->orig_node);
 139                 if (!router)
 140                         continue;
 141
 142                 switch (atomic_read(&bat_priv->gw_sel_class)) {
 143                 case 1: /* fast connection */
 144                         gw_bandwidth_to_kbit(gw_node->orig_node->gw_flags,
 145                                              &down, &up);
 146
 147                         tmp_gw_factor = (router->tq_avg * router->tq_avg *
 148                                          down * 100 * 100) /
 149                                          (TQ_LOCAL_WINDOW_SIZE *
 150                                          TQ_LOCAL_WINDOW_SIZE * 64);
 151
 152                         if ((tmp_gw_factor > max_gw_factor) ||
 153                             ((tmp_gw_factor == max_gw_factor) &&
 154                              (router->tq_avg > max_tq)))
 155                                 curr_gw_tmp = gw_node;
 156                         break;
 157
 158                 default: /**
 159                           * 2:  stable connection (use best statistic)
 160                           * 3:  fast-switch (use best statistic but change as
 161                           *     soon as a better gateway appears)
 162                           * XX: late-switch (use best statistic but change as
 163                           *     soon as a better gateway appears which has
 164                           *     $routing_class more tq points)
 165                           **/
 166                         if (router->tq_avg > max_tq)
 167                                 curr_gw_tmp = gw_node;
 168                         break;
 169                 }
 170
 171                 if (router->tq_avg > max_tq)
 172                         max_tq = router->tq_avg;
 173
 174                 if (tmp_gw_factor > max_gw_factor)
 175                         max_gw_factor = tmp_gw_factor;
 176
 177                 neigh_node_free_ref(router);
 178         }
 179
 180         if (curr_gw != curr_gw_tmp) {
 181                 router = orig_node_get_router(curr_gw_tmp->orig_node);
 182                 if (!router)
 183                         goto unlock;
 184
 185                 if ((curr_gw) && (!curr_gw_tmp))
 186                         bat_dbg(DBG_BATMAN, bat_priv,
 187                                 "Removing selected gateway - "
 188                                 "no gateway in range\n");
 189                 else if ((!curr_gw) && (curr_gw_tmp))
 190                         bat_dbg(DBG_BATMAN, bat_priv,
 191                                 "Adding route to gateway %pM "
 192                                 "(gw_flags: %i, tq: %i)\n",
 193                                 curr_gw_tmp->orig_node->orig,
 194                                 curr_gw_tmp->orig_node->gw_flags,
 195                                 router->tq_avg);
 196                 else
 197                         bat_dbg(DBG_BATMAN, bat_priv,
 198                                 "Changing route to gateway %pM "
 199                                 "(gw_flags: %i, tq: %i)\n",
 200                                 curr_gw_tmp->orig_node->orig,
 201                                 curr_gw_tmp->orig_node->gw_flags,
 202                                 router->tq_avg);
 203
 204                 neigh_node_free_ref(router);
 205                 gw_select(bat_priv, curr_gw_tmp);
 206         }
 207
 208 unlock:
 209         rcu_read_unlock();
 210 out:
 211         if (curr_gw)
 212                 gw_node_free_ref(curr_gw);
 213 }
 214
 215 void gw_check_election(struct bat_priv *bat_priv, struct orig_node *orig_node)
 216 {
 217         struct orig_node *curr_gw_orig;
 218         struct neigh_node *router_gw = NULL, *router_orig = NULL;
 219         uint8_t gw_tq_avg, orig_tq_avg;
 220
 221         curr_gw_orig = gw_get_selected_orig(bat_priv);
 222         if (!curr_gw_orig)
 223                 goto deselect;
 224
 225         router_gw = orig_node_get_router(curr_gw_orig);
 226         if (!router_gw)
 227                 goto deselect;
 228
 229         /* this node already is the gateway */
 230         if (curr_gw_orig == orig_node)
 231                 goto out;
 232
 233         router_orig = orig_node_get_router(orig_node);
 234         if (!router_orig)
 235                 goto out;
 236
 237         gw_tq_avg = router_gw->tq_avg;
 238         orig_tq_avg = router_orig->tq_avg;
 239
 240         /* the TQ value has to be better */
 241         if (orig_tq_avg < gw_tq_avg)
 242                 goto out;
 243
 244         /**
 245          * if the routing class is greater than 3 the value tells us how much
 246          * greater the TQ value of the new gateway must be
 247          **/
 248         if ((atomic_read(&bat_priv->gw_sel_class) > 3) &&
 249             (orig_tq_avg - gw_tq_avg < atomic_read(&bat_priv->gw_sel_class)))
 250                 goto out;
 251
 252         bat_dbg(DBG_BATMAN, bat_priv,
 253                 "Restarting gateway selection: better gateway found (tq curr: "
 254                 "%i, tq new: %i)\n",
 255                 gw_tq_avg, orig_tq_avg);
 256
 257 deselect:
 258         gw_deselect(bat_priv);
 259 out:
 260         if (curr_gw_orig)
 261                 orig_node_free_ref(curr_gw_orig);
 262         if (router_gw)
 263                 neigh_node_free_ref(router_gw);
 264         if (router_orig)
 265                 neigh_node_free_ref(router_orig);
 266
 267         return;
 268 }
 269
 270 static void gw_node_add(struct bat_priv *bat_priv,
 271                         struct orig_node *orig_node, uint8_t new_gwflags)
 272 {
 273         struct gw_node *gw_node;
 274         int down, up;
 275
 276         gw_node = kmalloc(sizeof(struct gw_node), GFP_ATOMIC);
 277         if (!gw_node)
 278                 return;
 279
 280         memset(gw_node, 0, sizeof(struct gw_node));
 281         INIT_HLIST_NODE(&gw_node->list);
 282         gw_node->orig_node = orig_node;
 283         atomic_set(&gw_node->refcount, 1);
 284
 285         spin_lock_bh(&bat_priv->gw_list_lock);
 286         hlist_add_head_rcu(&gw_node->list, &bat_priv->gw_list);
 287         spin_unlock_bh(&bat_priv->gw_list_lock);
 288
 289         gw_bandwidth_to_kbit(new_gwflags, &down, &up);
 290         bat_dbg(DBG_BATMAN, bat_priv,
 291                 "Found new gateway %pM -> gw_class: %i - %i%s/%i%s\n",
 292                 orig_node->orig, new_gwflags,
 293                 (down > 2048 ? down / 1024 : down),
 294                 (down > 2048 ? "MBit" : "KBit"),
 295                 (up > 2048 ? up / 1024 : up),
 296                 (up > 2048 ? "MBit" : "KBit"));
 297 }
 298
 299 void gw_node_update(struct bat_priv *bat_priv,
 300                     struct orig_node *orig_node, uint8_t new_gwflags)
 301 {
 302         struct hlist_node *node;
 303         struct gw_node *gw_node, *curr_gw;
 304
 305         /**
 306          * Note: We don't need a NULL check here, since curr_gw never gets
 307          * dereferenced. If curr_gw is NULL we also should not exit as we may
 308          * have this gateway in our list (duplication check!) even though we
 309          * have no currently selected gateway.
 310          */
 311         curr_gw = gw_get_selected_gw_node(bat_priv);
 312
 313         rcu_read_lock();
 314         hlist_for_each_entry_rcu(gw_node, node, &bat_priv->gw_list, list) {
 315                 if (gw_node->orig_node != orig_node)
 316                         continue;
 317
 318                 bat_dbg(DBG_BATMAN, bat_priv,
 319                         "Gateway class of originator %pM changed from "
 320                         "%i to %i\n",
 321                         orig_node->orig, gw_node->orig_node->gw_flags,
 322                         new_gwflags);
 323
 324                 gw_node->deleted = 0;
 325
 326                 if (new_gwflags == 0) {
 327                         gw_node->deleted = jiffies;
 328                         bat_dbg(DBG_BATMAN, bat_priv,
 329                                 "Gateway %pM removed from gateway list\n",
 330                                 orig_node->orig);
 331
 332                         if (gw_node == curr_gw)
 333                                 goto deselect;
 334                 }
 335
 336                 goto unlock;
 337         }
 338
 339         if (new_gwflags == 0)
 340                 goto unlock;
 341
 342         gw_node_add(bat_priv, orig_node, new_gwflags);
 343         goto unlock;
 344
 345 deselect:
 346         gw_deselect(bat_priv);
 347 unlock:
 348         rcu_read_unlock();
 349
 350         if (curr_gw)
 351                 gw_node_free_ref(curr_gw);
 352 }
 353
 354 void gw_node_delete(struct bat_priv *bat_priv, struct orig_node *orig_node)
 355 {
 356         return gw_node_update(bat_priv, orig_node, 0);
 357 }
 358
 359 void gw_node_purge(struct bat_priv *bat_priv)
 360 {
 361         struct gw_node *gw_node, *curr_gw;
 362         struct hlist_node *node, *node_tmp;
 363         unsigned long timeout = 2 * PURGE_TIMEOUT * HZ;
 364         char do_deselect = 0;
 365
 366         curr_gw = gw_get_selected_gw_node(bat_priv);
 367
 368         spin_lock_bh(&bat_priv->gw_list_lock);
 369
 370         hlist_for_each_entry_safe(gw_node, node, node_tmp,
 371                                   &bat_priv->gw_list, list) {
 372                 if (((!gw_node->deleted) ||
 373                      (time_before(jiffies, gw_node->deleted + timeout))) &&
 374                     atomic_read(&bat_priv->mesh_state) == MESH_ACTIVE)
 375                         continue;
 376
 377                 if (curr_gw == gw_node)
 378                         do_deselect = 1;
 379
 380                 hlist_del_rcu(&gw_node->list);
 381                 gw_node_free_ref(gw_node);
 382         }
 383
 384         spin_unlock_bh(&bat_priv->gw_list_lock);
 385
 386         /* gw_deselect() needs to acquire the gw_list_lock */
 387         if (do_deselect)
 388                 gw_deselect(bat_priv);
 389
 390         if (curr_gw)
 391                 gw_node_free_ref(curr_gw);
 392 }
 393
 394 /**
 395  * fails if orig_node has no router
 396  */
 397 static int _write_buffer_text(struct bat_priv *bat_priv,
 398                               struct seq_file *seq, struct gw_node *gw_node)
 399 {
 400         struct gw_node *curr_gw;
 401         struct neigh_node *router;
 402         int down, up, ret = -1;
 403
 404         gw_bandwidth_to_kbit(gw_node->orig_node->gw_flags, &down, &up);
 405
 406         router = orig_node_get_router(gw_node->orig_node);
 407         if (!router)
 408                 goto out;
 409
 410         curr_gw = gw_get_selected_gw_node(bat_priv);
 411
 412         ret = seq_printf(seq, "%s %pM (%3i) %pM [%10s]: %3i - %i%s/%i%s\n",
 413                          (curr_gw == gw_node ? "=>" : "  "),
 414                          gw_node->orig_node->orig,
 415                          router->tq_avg, router->addr,
 416                          router->if_incoming->net_dev->name,
 417                          gw_node->orig_node->gw_flags,
 418                          (down > 2048 ? down / 1024 : down),
 419                          (down > 2048 ? "MBit" : "KBit"),
 420                          (up > 2048 ? up / 1024 : up),
 421                          (up > 2048 ? "MBit" : "KBit"));
 422
 423         neigh_node_free_ref(router);
 424         if (curr_gw)
 425                 gw_node_free_ref(curr_gw);
 426 out:
 427         return ret;
 428 }
 429
 430 int gw_client_seq_print_text(struct seq_file *seq, void *offset)
 431 {
 432         struct net_device *net_dev = (struct net_device *)seq->private;
 433         struct bat_priv *bat_priv = netdev_priv(net_dev);
 434         struct hard_iface *primary_if;
 435         struct gw_node *gw_node;
 436         struct hlist_node *node;
 437         int gw_count = 0, ret = 0;
 438
 439         primary_if = primary_if_get_selected(bat_priv);
 440         if (!primary_if) {
 441                 ret = seq_printf(seq, "BATMAN mesh %s disabled - please "
 442                                  "specify interfaces to enable it\n",
 443                                  net_dev->name);
 444                 goto out;
 445         }
 446
 447         if (primary_if->if_status != IF_ACTIVE) {
 448                 ret = seq_printf(seq, "BATMAN mesh %s disabled - "
 449                                  "primary interface not active\n",
 450                                  net_dev->name);
 451                 goto out;
 452         }
 453
 454         seq_printf(seq, "      %-12s (%s/%i) %17s [%10s]: gw_class ... "
 455                    "[B.A.T.M.A.N. adv %s%s, MainIF/MAC: %s/%pM (%s)]\n",
 456                    "Gateway", "#", TQ_MAX_VALUE, "Nexthop",
 457                    "outgoingIF", SOURCE_VERSION, REVISION_VERSION_STR,
 458                    primary_if->net_dev->name,
 459                    primary_if->net_dev->dev_addr, net_dev->name);
 460
 461         rcu_read_lock();
 462         hlist_for_each_entry_rcu(gw_node, node, &bat_priv->gw_list, list) {
 463                 if (gw_node->deleted)
 464                         continue;
 465
 466                 /* fails if orig_node has no router */
 467                 if (_write_buffer_text(bat_priv, seq, gw_node) < 0)
 468                         continue;
 469
 470                 gw_count++;
 471         }
 472         rcu_read_unlock();
 473
 474         if (gw_count == 0)
 475                 seq_printf(seq, "No gateways in range ...\n");
 476
 477 out:
 478         if (primary_if)
 479                 hardif_free_ref(primary_if);
 480         return ret;
 481 }
 482
 483 int gw_is_target(struct bat_priv *bat_priv, struct sk_buff *skb)
 484 {
 485         struct ethhdr *ethhdr;
 486         struct iphdr *iphdr;
 487         struct ipv6hdr *ipv6hdr;
 488         struct udphdr *udphdr;
 489         struct gw_node *curr_gw;
 490         unsigned int header_len = 0;
 491
 492         if (atomic_read(&bat_priv->gw_mode) == GW_MODE_OFF)
 493                 return 0;
 494
 495         /* check for ethernet header */
 496         if (!pskb_may_pull(skb, header_len + ETH_HLEN))
 497                 return 0;
 498         ethhdr = (struct ethhdr *)skb->data;
 499         header_len += ETH_HLEN;
 500
 501         /* check for initial vlan header */
 502         if (ntohs(ethhdr->h_proto) == ETH_P_8021Q) {
 503                 if (!pskb_may_pull(skb, header_len + VLAN_HLEN))
 504                         return 0;
 505                 ethhdr = (struct ethhdr *)(skb->data + VLAN_HLEN);
 506                 header_len += VLAN_HLEN;
 507         }
 508
 509         /* check for ip header */
 510         switch (ntohs(ethhdr->h_proto)) {
 511         case ETH_P_IP:
 512                 if (!pskb_may_pull(skb, header_len + sizeof(struct iphdr)))
 513                         return 0;
 514                 iphdr = (struct iphdr *)(skb->data + header_len);
 515                 header_len += iphdr->ihl * 4;
 516
 517                 /* check for udp header */
 518                 if (iphdr->protocol != IPPROTO_UDP)
 519                         return 0;
 520
 521                 break;
 522         case ETH_P_IPV6:
 523                 if (!pskb_may_pull(skb, header_len + sizeof(struct ipv6hdr)))
 524                         return 0;
 525                 ipv6hdr = (struct ipv6hdr *)(skb->data + header_len);
 526                 header_len += sizeof(struct ipv6hdr);
 527
 528                 /* check for udp header */
 529                 if (ipv6hdr->nexthdr != IPPROTO_UDP)
 530                         return 0;
 531
 532                 break;
 533         default:
 534                 return 0;
 535         }
 536
 537         if (!pskb_may_pull(skb, header_len + sizeof(struct udphdr)))
 538                 return 0;
 539         udphdr = (struct udphdr *)(skb->data + header_len);
 540         header_len += sizeof(struct udphdr);
 541
 542         /* check for bootp port */
 543         if ((ntohs(ethhdr->h_proto) == ETH_P_IP) &&
 544              (ntohs(udphdr->dest) != 67))
 545                 return 0;
 546
 547         if ((ntohs(ethhdr->h_proto) == ETH_P_IPV6) &&
 548             (ntohs(udphdr->dest) != 547))
 549                 return 0;
 550
 551         if (atomic_read(&bat_priv->gw_mode) == GW_MODE_SERVER)
 552                 return -1;
 553
 554         curr_gw = gw_get_selected_gw_node(bat_priv);
 555         if (!curr_gw)
 556                 return 0;
 557
 558         if (curr_gw)
 559                 gw_node_free_ref(curr_gw);
 560         return 1;
 561 }