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