net/batman-adv/distributed-arp-table.c

   1 /* Copyright (C) 2011-2013 B.A.T.M.A.N. contributors:
   2  *
   3  * Antonio Quartulli
   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/if_ether.h>
  21 #include <linux/if_arp.h>
  22 #include <net/arp.h>
  23
  24 #include "main.h"
  25 #include "hash.h"
  26 #include "distributed-arp-table.h"
  27 #include "hard-interface.h"
  28 #include "originator.h"
  29 #include "send.h"
  30 #include "types.h"
  31 #include "translation-table.h"
  32 #include "unicast.h"
  33
  34 static void batadv_dat_purge(struct work_struct *work);
  35
  36 /**
  37  * batadv_dat_start_timer - initialise the DAT periodic worker
  38  * @bat_priv: the bat priv with all the soft interface information
  39  */
  40 static void batadv_dat_start_timer(struct batadv_priv *bat_priv)
  41 {
  42         INIT_DELAYED_WORK(&bat_priv->dat.work, batadv_dat_purge);
  43         queue_delayed_work(batadv_event_workqueue, &bat_priv->dat.work,
  44                            msecs_to_jiffies(10000));
  45 }
  46
  47 /**
  48  * batadv_dat_entry_free_ref - decrement the dat_entry refcounter and possibly
  49  * free it
  50  * @dat_entry: the entry to free
  51  */
  52 static void batadv_dat_entry_free_ref(struct batadv_dat_entry *dat_entry)
  53 {
  54         if (atomic_dec_and_test(&dat_entry->refcount))
  55                 kfree_rcu(dat_entry, rcu);
  56 }
  57
  58 /**
  59  * batadv_dat_to_purge - check whether a dat_entry has to be purged or not
  60  * @dat_entry: the entry to check
  61  *
  62  * Returns true if the entry has to be purged now, false otherwise.
  63  */
  64 static bool batadv_dat_to_purge(struct batadv_dat_entry *dat_entry)
  65 {
  66         return batadv_has_timed_out(dat_entry->last_update,
  67                                     BATADV_DAT_ENTRY_TIMEOUT);
  68 }
  69
  70 /**
  71  * __batadv_dat_purge - delete entries from the DAT local storage
  72  * @bat_priv: the bat priv with all the soft interface information
  73  * @to_purge: function in charge to decide whether an entry has to be purged or
  74  *            not. This function takes the dat_entry as argument and has to
  75  *            returns a boolean value: true is the entry has to be deleted,
  76  *            false otherwise
  77  *
  78  * Loops over each entry in the DAT local storage and deletes it if and only if
  79  * the to_purge function passed as argument returns true.
  80  */
  81 static void __batadv_dat_purge(struct batadv_priv *bat_priv,
  82                                bool (*to_purge)(struct batadv_dat_entry *))
  83 {
  84         spinlock_t *list_lock; /* protects write access to the hash lists */
  85         struct batadv_dat_entry *dat_entry;
  86         struct hlist_node *node_tmp;
  87         struct hlist_head *head;
  88         uint32_t i;
  89
  90         if (!bat_priv->dat.hash)
  91                 return;
  92
  93         for (i = 0; i < bat_priv->dat.hash->size; i++) {
  94                 head = &bat_priv->dat.hash->table[i];
  95                 list_lock = &bat_priv->dat.hash->list_locks[i];
  96
  97                 spin_lock_bh(list_lock);
  98                 hlist_for_each_entry_safe(dat_entry, node_tmp, head,
  99                                           hash_entry) {
 100                         /* if a helper function has been passed as parameter,
 101                          * ask it if the entry has to be purged or not
 102                          */
 103                         if (to_purge && !to_purge(dat_entry))
 104                                 continue;
 105
 106                         hlist_del_rcu(&dat_entry->hash_entry);
 107                         batadv_dat_entry_free_ref(dat_entry);
 108                 }
 109                 spin_unlock_bh(list_lock);
 110         }
 111 }
 112
 113 /**
 114  * batadv_dat_purge - periodic task that deletes old entries from the local DAT
 115  * hash table
 116  * @work: kernel work struct
 117  */
 118 static void batadv_dat_purge(struct work_struct *work)
 119 {
 120         struct delayed_work *delayed_work;
 121         struct batadv_priv_dat *priv_dat;
 122         struct batadv_priv *bat_priv;
 123
 124         delayed_work = container_of(work, struct delayed_work, work);
 125         priv_dat = container_of(delayed_work, struct batadv_priv_dat, work);
 126         bat_priv = container_of(priv_dat, struct batadv_priv, dat);
 127
 128         __batadv_dat_purge(bat_priv, batadv_dat_to_purge);
 129         batadv_dat_start_timer(bat_priv);
 130 }
 131
 132 /**
 133  * batadv_compare_dat - comparing function used in the local DAT hash table
 134  * @node: node in the local table
 135  * @data2: second object to compare the node to
 136  *
 137  * Returns 1 if the two entries are the same, 0 otherwise.
 138  */
 139 static int batadv_compare_dat(const struct hlist_node *node, const void *data2)
 140 {
 141         const void *data1 = container_of(node, struct batadv_dat_entry,
 142                                          hash_entry);
 143
 144         return (memcmp(data1, data2, sizeof(__be32)) == 0 ? 1 : 0);
 145 }
 146
 147 /**
 148  * batadv_arp_hw_src - extract the hw_src field from an ARP packet
 149  * @skb: ARP packet
 150  * @hdr_size: size of the possible header before the ARP packet
 151  *
 152  * Returns the value of the hw_src field in the ARP packet.
 153  */
 154 static uint8_t *batadv_arp_hw_src(struct sk_buff *skb, int hdr_size)
 155 {
 156         uint8_t *addr;
 157
 158         addr = (uint8_t *)(skb->data + hdr_size);
 159         addr += ETH_HLEN + sizeof(struct arphdr);
 160
 161         return addr;
 162 }
 163
 164 /**
 165  * batadv_arp_ip_src - extract the ip_src field from an ARP packet
 166  * @skb: ARP packet
 167  * @hdr_size: size of the possible header before the ARP packet
 168  *
 169  * Returns the value of the ip_src field in the ARP packet.
 170  */
 171 static __be32 batadv_arp_ip_src(struct sk_buff *skb, int hdr_size)
 172 {
 173         return *(__be32 *)(batadv_arp_hw_src(skb, hdr_size) + ETH_ALEN);
 174 }
 175
 176 /**
 177  * batadv_arp_hw_dst - extract the hw_dst field from an ARP packet
 178  * @skb: ARP packet
 179  * @hdr_size: size of the possible header before the ARP packet
 180  *
 181  * Returns the value of the hw_dst field in the ARP packet.
 182  */
 183 static uint8_t *batadv_arp_hw_dst(struct sk_buff *skb, int hdr_size)
 184 {
 185         return batadv_arp_hw_src(skb, hdr_size) + ETH_ALEN + 4;
 186 }
 187
 188 /**
 189  * batadv_arp_ip_dst - extract the ip_dst field from an ARP packet
 190  * @skb: ARP packet
 191  * @hdr_size: size of the possible header before the ARP packet
 192  *
 193  * Returns the value of the ip_dst field in the ARP packet.
 194  */
 195 static __be32 batadv_arp_ip_dst(struct sk_buff *skb, int hdr_size)
 196 {
 197         return *(__be32 *)(batadv_arp_hw_src(skb, hdr_size) + ETH_ALEN * 2 + 4);
 198 }
 199
 200 /**
 201  * batadv_hash_dat - compute the hash value for an IP address
 202  * @data: data to hash
 203  * @size: size of the hash table
 204  *
 205  * Returns the selected index in the hash table for the given data.
 206  */
 207 static uint32_t batadv_hash_dat(const void *data, uint32_t size)
 208 {
 209         const unsigned char *key = data;
 210         uint32_t hash = 0;
 211         size_t i;
 212
 213         for (i = 0; i < 4; i++) {
 214                 hash += key[i];
 215                 hash += (hash << 10);
 216                 hash ^= (hash >> 6);
 217         }
 218
 219         hash += (hash << 3);
 220         hash ^= (hash >> 11);
 221         hash += (hash << 15);
 222
 223         return hash % size;
 224 }
 225
 226 /**
 227  * batadv_dat_entry_hash_find - look for a given dat_entry in the local hash
 228  * table
 229  * @bat_priv: the bat priv with all the soft interface information
 230  * @ip: search key
 231  *
 232  * Returns the dat_entry if found, NULL otherwise.
 233  */
 234 static struct batadv_dat_entry *
 235 batadv_dat_entry_hash_find(struct batadv_priv *bat_priv, __be32 ip)
 236 {
 237         struct hlist_head *head;
 238         struct batadv_dat_entry *dat_entry, *dat_entry_tmp = NULL;
 239         struct batadv_hashtable *hash = bat_priv->dat.hash;
 240         uint32_t index;
 241
 242         if (!hash)
 243                 return NULL;
 244
 245         index = batadv_hash_dat(&ip, hash->size);
 246         head = &hash->table[index];
 247
 248         rcu_read_lock();
 249         hlist_for_each_entry_rcu(dat_entry, head, hash_entry) {
 250                 if (dat_entry->ip != ip)
 251                         continue;
 252
 253                 if (!atomic_inc_not_zero(&dat_entry->refcount))
 254                         continue;
 255
 256                 dat_entry_tmp = dat_entry;
 257                 break;
 258         }
 259         rcu_read_unlock();
 260
 261         return dat_entry_tmp;
 262 }
 263
 264 /**
 265  * batadv_dat_entry_add - add a new dat entry or update it if already exists
 266  * @bat_priv: the bat priv with all the soft interface information
 267  * @ip: ipv4 to add/edit
 268  * @mac_addr: mac address to assign to the given ipv4
 269  */
 270 static void batadv_dat_entry_add(struct batadv_priv *bat_priv, __be32 ip,
 271                                  uint8_t *mac_addr)
 272 {
 273         struct batadv_dat_entry *dat_entry;
 274         int hash_added;
 275
 276         dat_entry = batadv_dat_entry_hash_find(bat_priv, ip);
 277         /* if this entry is already known, just update it */
 278         if (dat_entry) {
 279                 if (!batadv_compare_eth(dat_entry->mac_addr, mac_addr))
 280                         memcpy(dat_entry->mac_addr, mac_addr, ETH_ALEN);
 281                 dat_entry->last_update = jiffies;
 282                 batadv_dbg(BATADV_DBG_DAT, bat_priv,
 283                            "Entry updated: %pI4 %pM\n", &dat_entry->ip,
 284                            dat_entry->mac_addr);
 285                 goto out;
 286         }
 287
 288         dat_entry = kmalloc(sizeof(*dat_entry), GFP_ATOMIC);
 289         if (!dat_entry)
 290                 goto out;
 291
 292         dat_entry->ip = ip;
 293         memcpy(dat_entry->mac_addr, mac_addr, ETH_ALEN);
 294         dat_entry->last_update = jiffies;
 295         atomic_set(&dat_entry->refcount, 2);
 296
 297         hash_added = batadv_hash_add(bat_priv->dat.hash, batadv_compare_dat,
 298                                      batadv_hash_dat, &dat_entry->ip,
 299                                      &dat_entry->hash_entry);
 300
 301         if (unlikely(hash_added != 0)) {
 302                 /* remove the reference for the hash */
 303                 batadv_dat_entry_free_ref(dat_entry);
 304                 goto out;
 305         }
 306
 307         batadv_dbg(BATADV_DBG_DAT, bat_priv, "New entry added: %pI4 %pM\n",
 308                    &dat_entry->ip, dat_entry->mac_addr);
 309
 310 out:
 311         if (dat_entry)
 312                 batadv_dat_entry_free_ref(dat_entry);
 313 }
 314
 315 #ifdef CONFIG_BATMAN_ADV_DEBUG
 316
 317 /**
 318  * batadv_dbg_arp - print a debug message containing all the ARP packet details
 319  * @bat_priv: the bat priv with all the soft interface information
 320  * @skb: ARP packet
 321  * @type: ARP type
 322  * @hdr_size: size of the possible header before the ARP packet
 323  * @msg: message to print together with the debugging information
 324  */
 325 static void batadv_dbg_arp(struct batadv_priv *bat_priv, struct sk_buff *skb,
 326                            uint16_t type, int hdr_size, char *msg)
 327 {
 328         struct batadv_unicast_4addr_packet *unicast_4addr_packet;
 329         struct batadv_bcast_packet *bcast_pkt;
 330         uint8_t *orig_addr;
 331         __be32 ip_src, ip_dst;
 332
 333         if (msg)
 334                 batadv_dbg(BATADV_DBG_DAT, bat_priv, "%s\n", msg);
 335
 336         ip_src = batadv_arp_ip_src(skb, hdr_size);
 337         ip_dst = batadv_arp_ip_dst(skb, hdr_size);
 338         batadv_dbg(BATADV_DBG_DAT, bat_priv,
 339                    "ARP MSG = [src: %pM-%pI4 dst: %pM-%pI4]\n",
 340                    batadv_arp_hw_src(skb, hdr_size), &ip_src,
 341                    batadv_arp_hw_dst(skb, hdr_size), &ip_dst);
 342
 343         if (hdr_size == 0)
 344                 return;
 345
 346         unicast_4addr_packet = (struct batadv_unicast_4addr_packet *)skb->data;
 347
 348         switch (unicast_4addr_packet->u.header.packet_type) {
 349         case BATADV_UNICAST:
 350                 batadv_dbg(BATADV_DBG_DAT, bat_priv,
 351                            "* encapsulated within a UNICAST packet\n");
 352                 break;
 353         case BATADV_UNICAST_4ADDR:
 354                 batadv_dbg(BATADV_DBG_DAT, bat_priv,
 355                            "* encapsulated within a UNICAST_4ADDR packet (src: %pM)\n",
 356                            unicast_4addr_packet->src);
 357                 switch (unicast_4addr_packet->subtype) {
 358                 case BATADV_P_DAT_DHT_PUT:
 359                         batadv_dbg(BATADV_DBG_DAT, bat_priv, "* type: DAT_DHT_PUT\n");
 360                         break;
 361                 case BATADV_P_DAT_DHT_GET:
 362                         batadv_dbg(BATADV_DBG_DAT, bat_priv, "* type: DAT_DHT_GET\n");
 363                         break;
 364                 case BATADV_P_DAT_CACHE_REPLY:
 365                         batadv_dbg(BATADV_DBG_DAT, bat_priv,
 366                                    "* type: DAT_CACHE_REPLY\n");
 367                         break;
 368                 case BATADV_P_DATA:
 369                         batadv_dbg(BATADV_DBG_DAT, bat_priv, "* type: DATA\n");
 370                         break;
 371                 default:
 372                         batadv_dbg(BATADV_DBG_DAT, bat_priv, "* type: Unknown (%u)!\n",
 373                                    unicast_4addr_packet->u.header.packet_type);
 374                 }
 375                 break;
 376         case BATADV_BCAST:
 377                 bcast_pkt = (struct batadv_bcast_packet *)unicast_4addr_packet;
 378                 orig_addr = bcast_pkt->orig;
 379                 batadv_dbg(BATADV_DBG_DAT, bat_priv,
 380                            "* encapsulated within a BCAST packet (src: %pM)\n",
 381                            orig_addr);
 382                 break;
 383         default:
 384                 batadv_dbg(BATADV_DBG_DAT, bat_priv,
 385                            "* encapsulated within an unknown packet type (0x%x)\n",
 386                            unicast_4addr_packet->u.header.packet_type);
 387         }
 388 }
 389
 390 #else
 391
 392 static void batadv_dbg_arp(struct batadv_priv *bat_priv, struct sk_buff *skb,
 393                            uint16_t type, int hdr_size, char *msg)
 394 {
 395 }
 396
 397 #endif /* CONFIG_BATMAN_ADV_DEBUG */
 398
 399 /**
 400  * batadv_is_orig_node_eligible - check whether a node can be a DHT candidate
 401  * @res: the array with the already selected candidates
 402  * @select: number of already selected candidates
 403  * @tmp_max: address of the currently evaluated node
 404  * @max: current round max address
 405  * @last_max: address of the last selected candidate
 406  * @candidate: orig_node under evaluation
 407  * @max_orig_node: last selected candidate
 408  *
 409  * Returns true if the node has been elected as next candidate or false
 410  * otherwise.
 411  */
 412 static bool batadv_is_orig_node_eligible(struct batadv_dat_candidate *res,
 413                                          int select, batadv_dat_addr_t tmp_max,
 414                                          batadv_dat_addr_t max,
 415                                          batadv_dat_addr_t last_max,
 416                                          struct batadv_orig_node *candidate,
 417                                          struct batadv_orig_node *max_orig_node)
 418 {
 419         bool ret = false;
 420         int j;
 421
 422         /* check if orig node candidate is running DAT */
 423         if (!(candidate->capabilities & BATADV_ORIG_CAPA_HAS_DAT))
 424                 goto out;
 425
 426         /* Check if this node has already been selected... */
 427         for (j = 0; j < select; j++)
 428                 if (res[j].orig_node == candidate)
 429                         break;
 430         /* ..and possibly skip it */
 431         if (j < select)
 432                 goto out;
 433         /* sanity check: has it already been selected? This should not happen */
 434         if (tmp_max > last_max)
 435                 goto out;
 436         /* check if during this iteration an originator with a closer dht
 437          * address has already been found
 438          */
 439         if (tmp_max < max)
 440                 goto out;
 441         /* this is an hash collision with the temporary selected node. Choose
 442          * the one with the lowest address
 443          */
 444         if ((tmp_max == max) && max_orig_node &&
 445             (batadv_compare_eth(candidate->orig, max_orig_node->orig) > 0))
 446                 goto out;
 447
 448         ret = true;
 449 out:
 450         return ret;
 451 }
 452
 453 /**
 454  * batadv_choose_next_candidate - select the next DHT candidate
 455  * @bat_priv: the bat priv with all the soft interface information
 456  * @cands: candidates array
 457  * @select: number of candidates already present in the array
 458  * @ip_key: key to look up in the DHT
 459  * @last_max: pointer where the address of the selected candidate will be saved
 460  */
 461 static void batadv_choose_next_candidate(struct batadv_priv *bat_priv,
 462                                          struct batadv_dat_candidate *cands,
 463                                          int select, batadv_dat_addr_t ip_key,
 464                                          batadv_dat_addr_t *last_max)
 465 {
 466         batadv_dat_addr_t max = 0, tmp_max = 0;
 467         struct batadv_orig_node *orig_node, *max_orig_node = NULL;
 468         struct batadv_hashtable *hash = bat_priv->orig_hash;
 469         struct hlist_head *head;
 470         int i;
 471
 472         /* if no node is eligible as candidate, leave the candidate type as
 473          * NOT_FOUND
 474          */
 475         cands[select].type = BATADV_DAT_CANDIDATE_NOT_FOUND;
 476
 477         /* iterate over the originator list and find the node with the closest
 478          * dat_address which has not been selected yet
 479          */
 480         for (i = 0; i < hash->size; i++) {
 481                 head = &hash->table[i];
 482
 483                 rcu_read_lock();
 484                 hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
 485                         /* the dht space is a ring using unsigned addresses */
 486                         tmp_max = BATADV_DAT_ADDR_MAX - orig_node->dat_addr +
 487                                   ip_key;
 488
 489                         if (!batadv_is_orig_node_eligible(cands, select,
 490                                                           tmp_max, max,
 491                                                           *last_max, orig_node,
 492                                                           max_orig_node))
 493                                 continue;
 494
 495                         if (!atomic_inc_not_zero(&orig_node->refcount))
 496                                 continue;
 497
 498                         max = tmp_max;
 499                         if (max_orig_node)
 500                                 batadv_orig_node_free_ref(max_orig_node);
 501                         max_orig_node = orig_node;
 502                 }
 503                 rcu_read_unlock();
 504         }
 505         if (max_orig_node) {
 506                 cands[select].type = BATADV_DAT_CANDIDATE_ORIG;
 507                 cands[select].orig_node = max_orig_node;
 508                 batadv_dbg(BATADV_DBG_DAT, bat_priv,
 509                            "dat_select_candidates() %d: selected %pM addr=%u dist=%u\n",
 510                            select, max_orig_node->orig, max_orig_node->dat_addr,
 511                            max);
 512         }
 513         *last_max = max;
 514 }
 515
 516 /**
 517  * batadv_dat_select_candidates - select the nodes which the DHT message has to
 518  * be sent to
 519  * @bat_priv: the bat priv with all the soft interface information
 520  * @ip_dst: ipv4 to look up in the DHT
 521  *
 522  * An originator O is selected if and only if its DHT_ID value is one of three
 523  * closest values (from the LEFT, with wrap around if needed) then the hash
 524  * value of the key. ip_dst is the key.
 525  *
 526  * Returns the candidate array of size BATADV_DAT_CANDIDATE_NUM.
 527  */
 528 static struct batadv_dat_candidate *
 529 batadv_dat_select_candidates(struct batadv_priv *bat_priv, __be32 ip_dst)
 530 {
 531         int select;
 532         batadv_dat_addr_t last_max = BATADV_DAT_ADDR_MAX, ip_key;
 533         struct batadv_dat_candidate *res;
 534
 535         if (!bat_priv->orig_hash)
 536                 return NULL;
 537
 538         res = kmalloc(BATADV_DAT_CANDIDATES_NUM * sizeof(*res), GFP_ATOMIC);
 539         if (!res)
 540                 return NULL;
 541
 542         ip_key = (batadv_dat_addr_t)batadv_hash_dat(&ip_dst,
 543                                                     BATADV_DAT_ADDR_MAX);
 544
 545         batadv_dbg(BATADV_DBG_DAT, bat_priv,
 546                    "dat_select_candidates(): IP=%pI4 hash(IP)=%u\n", &ip_dst,
 547                    ip_key);
 548
 549         for (select = 0; select < BATADV_DAT_CANDIDATES_NUM; select++)
 550                 batadv_choose_next_candidate(bat_priv, res, select, ip_key,
 551                                              &last_max);
 552
 553         return res;
 554 }
 555
 556 /**
 557  * batadv_dat_send_data - send a payload to the selected candidates
 558  * @bat_priv: the bat priv with all the soft interface information
 559  * @skb: payload to send
 560  * @ip: the DHT key
 561  * @packet_subtype: unicast4addr packet subtype to use
 562  *
 563  * This function copies the skb with pskb_copy() and is sent as unicast packet
 564  * to each of the selected candidates.
 565  *
 566  * Returns true if the packet is sent to at least one candidate, false
 567  * otherwise.
 568  */
 569 static bool batadv_dat_send_data(struct batadv_priv *bat_priv,
 570                                  struct sk_buff *skb, __be32 ip,
 571                                  int packet_subtype)
 572 {
 573         int i;
 574         bool ret = false;
 575         int send_status;
 576         struct batadv_neigh_node *neigh_node = NULL;
 577         struct sk_buff *tmp_skb;
 578         struct batadv_dat_candidate *cand;
 579
 580         cand = batadv_dat_select_candidates(bat_priv, ip);
 581         if (!cand)
 582                 goto out;
 583
 584         batadv_dbg(BATADV_DBG_DAT, bat_priv, "DHT_SEND for %pI4\n", &ip);
 585
 586         for (i = 0; i < BATADV_DAT_CANDIDATES_NUM; i++) {
 587                 if (cand[i].type == BATADV_DAT_CANDIDATE_NOT_FOUND)
 588                         continue;
 589
 590                 neigh_node = batadv_orig_node_get_router(cand[i].orig_node);
 591                 if (!neigh_node)
 592                         goto free_orig;
 593
 594                 tmp_skb = pskb_copy(skb, GFP_ATOMIC);
 595                 if (!batadv_unicast_4addr_prepare_skb(bat_priv, tmp_skb,
 596                                                       cand[i].orig_node,
 597                                                       packet_subtype)) {
 598                         kfree_skb(tmp_skb);
 599                         goto free_neigh;
 600                 }
 601
 602                 send_status = batadv_send_skb_packet(tmp_skb,
 603                                                      neigh_node->if_incoming,
 604                                                      neigh_node->addr);
 605                 if (send_status == NET_XMIT_SUCCESS) {
 606                         /* count the sent packet */
 607                         switch (packet_subtype) {
 608                         case BATADV_P_DAT_DHT_GET:
 609                                 batadv_inc_counter(bat_priv,
 610                                                    BATADV_CNT_DAT_GET_TX);
 611                                 break;
 612                         case BATADV_P_DAT_DHT_PUT:
 613                                 batadv_inc_counter(bat_priv,
 614                                                    BATADV_CNT_DAT_PUT_TX);
 615                                 break;
 616                         }
 617
 618                         /* packet sent to a candidate: return true */
 619                         ret = true;
 620                 }
 621 free_neigh:
 622                 batadv_neigh_node_free_ref(neigh_node);
 623 free_orig:
 624                 batadv_orig_node_free_ref(cand[i].orig_node);
 625         }
 626
 627 out:
 628         kfree(cand);
 629         return ret;
 630 }
 631
 632 /**
 633  * batadv_dat_tvlv_container_update - update the dat tvlv container after dat
 634  *  setting change
 635  * @bat_priv: the bat priv with all the soft interface information
 636  */
 637 static void batadv_dat_tvlv_container_update(struct batadv_priv *bat_priv)
 638 {
 639         char dat_mode;
 640
 641         dat_mode = atomic_read(&bat_priv->distributed_arp_table);
 642
 643         switch (dat_mode) {
 644         case 0:
 645                 batadv_tvlv_container_unregister(bat_priv, BATADV_TVLV_DAT, 1);
 646                 break;
 647         case 1:
 648                 batadv_tvlv_container_register(bat_priv, BATADV_TVLV_DAT, 1,
 649                                                NULL, 0);
 650                 break;
 651         }
 652 }
 653
 654 /**
 655  * batadv_dat_status_update - update the dat tvlv container after dat
 656  *  setting change
 657  * @net_dev: the soft interface net device
 658  */
 659 void batadv_dat_status_update(struct net_device *net_dev)
 660 {
 661         struct batadv_priv *bat_priv = netdev_priv(net_dev);
 662         batadv_dat_tvlv_container_update(bat_priv);
 663 }
 664
 665 /**
 666  * batadv_gw_tvlv_ogm_handler_v1 - process incoming dat tvlv container
 667  * @bat_priv: the bat priv with all the soft interface information
 668  * @orig: the orig_node of the ogm
 669  * @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags)
 670  * @tvlv_value: tvlv buffer containing the gateway data
 671  * @tvlv_value_len: tvlv buffer length
 672  */
 673 static void batadv_dat_tvlv_ogm_handler_v1(struct batadv_priv *bat_priv,
 674                                            struct batadv_orig_node *orig,
 675                                            uint8_t flags,
 676                                            void *tvlv_value,
 677                                            uint16_t tvlv_value_len)
 678 {
 679         if (flags & BATADV_TVLV_HANDLER_OGM_CIFNOTFND)
 680                 orig->capabilities &= ~BATADV_ORIG_CAPA_HAS_DAT;
 681         else
 682                 orig->capabilities |= BATADV_ORIG_CAPA_HAS_DAT;
 683 }
 684
 685 /**
 686  * batadv_dat_hash_free - free the local DAT hash table
 687  * @bat_priv: the bat priv with all the soft interface information
 688  */
 689 static void batadv_dat_hash_free(struct batadv_priv *bat_priv)
 690 {
 691         if (!bat_priv->dat.hash)
 692                 return;
 693
 694         __batadv_dat_purge(bat_priv, NULL);
 695
 696         batadv_hash_destroy(bat_priv->dat.hash);
 697
 698         bat_priv->dat.hash = NULL;
 699 }
 700
 701 /**
 702  * batadv_dat_init - initialise the DAT internals
 703  * @bat_priv: the bat priv with all the soft interface information
 704  */
 705 int batadv_dat_init(struct batadv_priv *bat_priv)
 706 {
 707         if (bat_priv->dat.hash)
 708                 return 0;
 709
 710         bat_priv->dat.hash = batadv_hash_new(1024);
 711
 712         if (!bat_priv->dat.hash)
 713                 return -ENOMEM;
 714
 715         batadv_dat_start_timer(bat_priv);
 716
 717         batadv_tvlv_handler_register(bat_priv, batadv_dat_tvlv_ogm_handler_v1,
 718                                      NULL, BATADV_TVLV_DAT, 1,
 719                                      BATADV_TVLV_HANDLER_OGM_CIFNOTFND);
 720         batadv_dat_tvlv_container_update(bat_priv);
 721         return 0;
 722 }
 723
 724 /**
 725  * batadv_dat_free - free the DAT internals
 726  * @bat_priv: the bat priv with all the soft interface information
 727  */
 728 void batadv_dat_free(struct batadv_priv *bat_priv)
 729 {
 730         batadv_tvlv_container_unregister(bat_priv, BATADV_TVLV_DAT, 1);
 731         batadv_tvlv_handler_unregister(bat_priv, BATADV_TVLV_DAT, 1);
 732
 733         cancel_delayed_work_sync(&bat_priv->dat.work);
 734
 735         batadv_dat_hash_free(bat_priv);
 736 }
 737
 738 /**
 739  * batadv_dat_cache_seq_print_text - print the local DAT hash table
 740  * @seq: seq file to print on
 741  * @offset: not used
 742  */
 743 int batadv_dat_cache_seq_print_text(struct seq_file *seq, void *offset)
 744 {
 745         struct net_device *net_dev = (struct net_device *)seq->private;
 746         struct batadv_priv *bat_priv = netdev_priv(net_dev);
 747         struct batadv_hashtable *hash = bat_priv->dat.hash;
 748         struct batadv_dat_entry *dat_entry;
 749         struct batadv_hard_iface *primary_if;
 750         struct hlist_head *head;
 751         unsigned long last_seen_jiffies;
 752         int last_seen_msecs, last_seen_secs, last_seen_mins;
 753         uint32_t i;
 754
 755         primary_if = batadv_seq_print_text_primary_if_get(seq);
 756         if (!primary_if)
 757                 goto out;
 758
 759         seq_printf(seq, "Distributed ARP Table (%s):\n", net_dev->name);
 760         seq_printf(seq, "          %-7s          %-13s %5s\n", "IPv4", "MAC",
 761                    "last-seen");
 762
 763         for (i = 0; i < hash->size; i++) {
 764                 head = &hash->table[i];
 765
 766                 rcu_read_lock();
 767                 hlist_for_each_entry_rcu(dat_entry, head, hash_entry) {
 768                         last_seen_jiffies = jiffies - dat_entry->last_update;
 769                         last_seen_msecs = jiffies_to_msecs(last_seen_jiffies);
 770                         last_seen_mins = last_seen_msecs / 60000;
 771                         last_seen_msecs = last_seen_msecs % 60000;
 772                         last_seen_secs = last_seen_msecs / 1000;
 773
 774                         seq_printf(seq, " * %15pI4 %14pM %6i:%02i\n",
 775                                    &dat_entry->ip, dat_entry->mac_addr,
 776                                    last_seen_mins, last_seen_secs);
 777                 }
 778                 rcu_read_unlock();
 779         }
 780
 781 out:
 782         if (primary_if)
 783                 batadv_hardif_free_ref(primary_if);
 784         return 0;
 785 }
 786
 787 /**
 788  * batadv_arp_get_type - parse an ARP packet and gets the type
 789  * @bat_priv: the bat priv with all the soft interface information
 790  * @skb: packet to analyse
 791  * @hdr_size: size of the possible header before the ARP packet in the skb
 792  *
 793  * Returns the ARP type if the skb contains a valid ARP packet, 0 otherwise.
 794  */
 795 static uint16_t batadv_arp_get_type(struct batadv_priv *bat_priv,
 796                                     struct sk_buff *skb, int hdr_size)
 797 {
 798         struct arphdr *arphdr;
 799         struct ethhdr *ethhdr;
 800         __be32 ip_src, ip_dst;
 801         uint8_t *hw_src, *hw_dst;
 802         uint16_t type = 0;
 803
 804         /* pull the ethernet header */
 805         if (unlikely(!pskb_may_pull(skb, hdr_size + ETH_HLEN)))
 806                 goto out;
 807
 808         ethhdr = (struct ethhdr *)(skb->data + hdr_size);
 809
 810         if (ethhdr->h_proto != htons(ETH_P_ARP))
 811                 goto out;
 812
 813         /* pull the ARP payload */
 814         if (unlikely(!pskb_may_pull(skb, hdr_size + ETH_HLEN +
 815                                     arp_hdr_len(skb->dev))))
 816                 goto out;
 817
 818         arphdr = (struct arphdr *)(skb->data + hdr_size + ETH_HLEN);
 819
 820         /* check whether the ARP packet carries a valid IP information */
 821         if (arphdr->ar_hrd != htons(ARPHRD_ETHER))
 822                 goto out;
 823
 824         if (arphdr->ar_pro != htons(ETH_P_IP))
 825                 goto out;
 826
 827         if (arphdr->ar_hln != ETH_ALEN)
 828                 goto out;
 829
 830         if (arphdr->ar_pln != 4)
 831                 goto out;
 832
 833         /* Check for bad reply/request. If the ARP message is not sane, DAT
 834          * will simply ignore it
 835          */
 836         ip_src = batadv_arp_ip_src(skb, hdr_size);
 837         ip_dst = batadv_arp_ip_dst(skb, hdr_size);
 838         if (ipv4_is_loopback(ip_src) || ipv4_is_multicast(ip_src) ||
 839             ipv4_is_loopback(ip_dst) || ipv4_is_multicast(ip_dst) ||
 840             ipv4_is_zeronet(ip_src) || ipv4_is_lbcast(ip_src) ||
 841             ipv4_is_zeronet(ip_dst) || ipv4_is_lbcast(ip_dst))
 842                 goto out;
 843
 844         hw_src = batadv_arp_hw_src(skb, hdr_size);
 845         if (is_zero_ether_addr(hw_src) || is_multicast_ether_addr(hw_src))
 846                 goto out;
 847
 848         /* don't care about the destination MAC address in ARP requests */
 849         if (arphdr->ar_op != htons(ARPOP_REQUEST)) {
 850                 hw_dst = batadv_arp_hw_dst(skb, hdr_size);
 851                 if (is_zero_ether_addr(hw_dst) ||
 852                     is_multicast_ether_addr(hw_dst))
 853                         goto out;
 854         }
 855
 856         type = ntohs(arphdr->ar_op);
 857 out:
 858         return type;
 859 }
 860
 861 /**
 862  * batadv_dat_snoop_outgoing_arp_request - snoop the ARP request and try to
 863  * answer using DAT
 864  * @bat_priv: the bat priv with all the soft interface information
 865  * @skb: packet to check
 866  *
 867  * Returns true if the message has been sent to the dht candidates, false
 868  * otherwise. In case of a positive return value the message has to be enqueued
 869  * to permit the fallback.
 870  */
 871 bool batadv_dat_snoop_outgoing_arp_request(struct batadv_priv *bat_priv,
 872                                            struct sk_buff *skb)
 873 {
 874         uint16_t type = 0;
 875         __be32 ip_dst, ip_src;
 876         uint8_t *hw_src;
 877         bool ret = false;
 878         struct batadv_dat_entry *dat_entry = NULL;
 879         struct sk_buff *skb_new;
 880
 881         if (!atomic_read(&bat_priv->distributed_arp_table))
 882                 goto out;
 883
 884         type = batadv_arp_get_type(bat_priv, skb, 0);
 885         /* If the node gets an ARP_REQUEST it has to send a DHT_GET unicast
 886          * message to the selected DHT candidates
 887          */
 888         if (type != ARPOP_REQUEST)
 889                 goto out;
 890
 891         batadv_dbg_arp(bat_priv, skb, type, 0, "Parsing outgoing ARP REQUEST");
 892
 893         ip_src = batadv_arp_ip_src(skb, 0);
 894         hw_src = batadv_arp_hw_src(skb, 0);
 895         ip_dst = batadv_arp_ip_dst(skb, 0);
 896
 897         batadv_dat_entry_add(bat_priv, ip_src, hw_src);
 898
 899         dat_entry = batadv_dat_entry_hash_find(bat_priv, ip_dst);
 900         if (dat_entry) {
 901                 /* If the ARP request is destined for a local client the local
 902                  * client will answer itself. DAT would only generate a
 903                  * duplicate packet.
 904                  *
 905                  * Moreover, if the soft-interface is enslaved into a bridge, an
 906                  * additional DAT answer may trigger kernel warnings about
 907                  * a packet coming from the wrong port.
 908                  */
 909                 if (batadv_is_my_client(bat_priv, dat_entry->mac_addr)) {
 910                         ret = true;
 911                         goto out;
 912                 }
 913
 914                 skb_new = arp_create(ARPOP_REPLY, ETH_P_ARP, ip_src,
 915                                      bat_priv->soft_iface, ip_dst, hw_src,
 916                                      dat_entry->mac_addr, hw_src);
 917                 if (!skb_new)
 918                         goto out;
 919
 920                 skb_reset_mac_header(skb_new);
 921                 skb_new->protocol = eth_type_trans(skb_new,
 922                                                    bat_priv->soft_iface);
 923                 bat_priv->stats.rx_packets++;
 924                 bat_priv->stats.rx_bytes += skb->len + ETH_HLEN;
 925                 bat_priv->soft_iface->last_rx = jiffies;
 926
 927                 netif_rx(skb_new);
 928                 batadv_dbg(BATADV_DBG_DAT, bat_priv, "ARP request replied locally\n");
 929                 ret = true;
 930         } else {
 931                 /* Send the request to the DHT */
 932                 ret = batadv_dat_send_data(bat_priv, skb, ip_dst,
 933                                            BATADV_P_DAT_DHT_GET);
 934         }
 935 out:
 936         if (dat_entry)
 937                 batadv_dat_entry_free_ref(dat_entry);
 938         return ret;
 939 }
 940
 941 /**
 942  * batadv_dat_snoop_incoming_arp_request - snoop the ARP request and try to
 943  * answer using the local DAT storage
 944  * @bat_priv: the bat priv with all the soft interface information
 945  * @skb: packet to check
 946  * @hdr_size: size of the encapsulation header
 947  *
 948  * Returns true if the request has been answered, false otherwise.
 949  */
 950 bool batadv_dat_snoop_incoming_arp_request(struct batadv_priv *bat_priv,
 951                                            struct sk_buff *skb, int hdr_size)
 952 {
 953         uint16_t type;
 954         __be32 ip_src, ip_dst;
 955         uint8_t *hw_src;
 956         struct sk_buff *skb_new;
 957         struct batadv_dat_entry *dat_entry = NULL;
 958         bool ret = false;
 959         int err;
 960
 961         if (!atomic_read(&bat_priv->distributed_arp_table))
 962                 goto out;
 963
 964         type = batadv_arp_get_type(bat_priv, skb, hdr_size);
 965         if (type != ARPOP_REQUEST)
 966                 goto out;
 967
 968         hw_src = batadv_arp_hw_src(skb, hdr_size);
 969         ip_src = batadv_arp_ip_src(skb, hdr_size);
 970         ip_dst = batadv_arp_ip_dst(skb, hdr_size);
 971
 972         batadv_dbg_arp(bat_priv, skb, type, hdr_size,
 973                        "Parsing incoming ARP REQUEST");
 974
 975         batadv_dat_entry_add(bat_priv, ip_src, hw_src);
 976
 977         dat_entry = batadv_dat_entry_hash_find(bat_priv, ip_dst);
 978         if (!dat_entry)
 979                 goto out;
 980
 981         skb_new = arp_create(ARPOP_REPLY, ETH_P_ARP, ip_src,
 982                              bat_priv->soft_iface, ip_dst, hw_src,
 983                              dat_entry->mac_addr, hw_src);
 984
 985         if (!skb_new)
 986                 goto out;
 987
 988         /* To preserve backwards compatibility, the node has choose the outgoing
 989          * format based on the incoming request packet type. The assumption is
 990          * that a node not using the 4addr packet format doesn't support it.
 991          */
 992         if (hdr_size == sizeof(struct batadv_unicast_4addr_packet))
 993                 err = batadv_unicast_4addr_send_skb(bat_priv, skb_new,
 994                                                     BATADV_P_DAT_CACHE_REPLY);
 995         else
 996                 err = batadv_unicast_send_skb(bat_priv, skb_new);
 997
 998         if (!err) {
 999                 batadv_inc_counter(bat_priv, BATADV_CNT_DAT_CACHED_REPLY_TX);
1000                 ret = true;
1001         }
1002 out:
1003         if (dat_entry)
1004                 batadv_dat_entry_free_ref(dat_entry);
1005         if (ret)
1006                 kfree_skb(skb);
1007         return ret;
1008 }
1009
1010 /**
1011  * batadv_dat_snoop_outgoing_arp_reply - snoop the ARP reply and fill the DHT
1012  * @bat_priv: the bat priv with all the soft interface information
1013  * @skb: packet to check
1014  */
1015 void batadv_dat_snoop_outgoing_arp_reply(struct batadv_priv *bat_priv,
1016                                          struct sk_buff *skb)
1017 {
1018         uint16_t type;
1019         __be32 ip_src, ip_dst;
1020         uint8_t *hw_src, *hw_dst;
1021
1022         if (!atomic_read(&bat_priv->distributed_arp_table))
1023                 return;
1024
1025         type = batadv_arp_get_type(bat_priv, skb, 0);
1026         if (type != ARPOP_REPLY)
1027                 return;
1028
1029         batadv_dbg_arp(bat_priv, skb, type, 0, "Parsing outgoing ARP REPLY");
1030
1031         hw_src = batadv_arp_hw_src(skb, 0);
1032         ip_src = batadv_arp_ip_src(skb, 0);
1033         hw_dst = batadv_arp_hw_dst(skb, 0);
1034         ip_dst = batadv_arp_ip_dst(skb, 0);
1035
1036         batadv_dat_entry_add(bat_priv, ip_src, hw_src);
1037         batadv_dat_entry_add(bat_priv, ip_dst, hw_dst);
1038
1039         /* Send the ARP reply to the candidates for both the IP addresses that
1040          * the node obtained from the ARP reply
1041          */
1042         batadv_dat_send_data(bat_priv, skb, ip_src, BATADV_P_DAT_DHT_PUT);
1043         batadv_dat_send_data(bat_priv, skb, ip_dst, BATADV_P_DAT_DHT_PUT);
1044 }
1045 /**
1046  * batadv_dat_snoop_incoming_arp_reply - snoop the ARP reply and fill the local
1047  * DAT storage only
1048  * @bat_priv: the bat priv with all the soft interface information
1049  * @skb: packet to check
1050  * @hdr_size: size of the encapsulation header
1051  */
1052 bool batadv_dat_snoop_incoming_arp_reply(struct batadv_priv *bat_priv,
1053                                          struct sk_buff *skb, int hdr_size)
1054 {
1055         uint16_t type;
1056         __be32 ip_src, ip_dst;
1057         uint8_t *hw_src, *hw_dst;
1058         bool ret = false;
1059
1060         if (!atomic_read(&bat_priv->distributed_arp_table))
1061                 goto out;
1062
1063         type = batadv_arp_get_type(bat_priv, skb, hdr_size);
1064         if (type != ARPOP_REPLY)
1065                 goto out;
1066
1067         batadv_dbg_arp(bat_priv, skb, type, hdr_size,
1068                        "Parsing incoming ARP REPLY");
1069
1070         hw_src = batadv_arp_hw_src(skb, hdr_size);
1071         ip_src = batadv_arp_ip_src(skb, hdr_size);
1072         hw_dst = batadv_arp_hw_dst(skb, hdr_size);
1073         ip_dst = batadv_arp_ip_dst(skb, hdr_size);
1074
1075         /* Update our internal cache with both the IP addresses the node got
1076          * within the ARP reply
1077          */
1078         batadv_dat_entry_add(bat_priv, ip_src, hw_src);
1079         batadv_dat_entry_add(bat_priv, ip_dst, hw_dst);
1080
1081         /* if this REPLY is directed to a client of mine, let's deliver the
1082          * packet to the interface
1083          */
1084         ret = !batadv_is_my_client(bat_priv, hw_dst);
1085 out:
1086         if (ret)
1087                 kfree_skb(skb);
1088         /* if ret == false -> packet has to be delivered to the interface */
1089         return ret;
1090 }
1091
1092 /**
1093  * batadv_dat_drop_broadcast_packet - check if an ARP request has to be dropped
1094  * (because the node has already obtained the reply via DAT) or not
1095  * @bat_priv: the bat priv with all the soft interface information
1096  * @forw_packet: the broadcast packet
1097  *
1098  * Returns true if the node can drop the packet, false otherwise.
1099  */
1100 bool batadv_dat_drop_broadcast_packet(struct batadv_priv *bat_priv,
1101                                       struct batadv_forw_packet *forw_packet)
1102 {
1103         uint16_t type;
1104         __be32 ip_dst;
1105         struct batadv_dat_entry *dat_entry = NULL;
1106         bool ret = false;
1107         const size_t bcast_len = sizeof(struct batadv_bcast_packet);
1108
1109         if (!atomic_read(&bat_priv->distributed_arp_table))
1110                 goto out;
1111
1112         /* If this packet is an ARP_REQUEST and the node already has the
1113          * information that it is going to ask, then the packet can be dropped
1114          */
1115         if (forw_packet->num_packets)
1116                 goto out;
1117
1118         type = batadv_arp_get_type(bat_priv, forw_packet->skb, bcast_len);
1119         if (type != ARPOP_REQUEST)
1120                 goto out;
1121
1122         ip_dst = batadv_arp_ip_dst(forw_packet->skb, bcast_len);
1123         dat_entry = batadv_dat_entry_hash_find(bat_priv, ip_dst);
1124         /* check if the node already got this entry */
1125         if (!dat_entry) {
1126                 batadv_dbg(BATADV_DBG_DAT, bat_priv,
1127                            "ARP Request for %pI4: fallback\n", &ip_dst);
1128                 goto out;
1129         }
1130
1131         batadv_dbg(BATADV_DBG_DAT, bat_priv,
1132                    "ARP Request for %pI4: fallback prevented\n", &ip_dst);
1133         ret = true;
1134
1135 out:
1136         if (dat_entry)
1137                 batadv_dat_entry_free_ref(dat_entry);
1138         return ret;
1139 }