1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (C) 2012-2020  B.A.T.M.A.N. contributors:
3  *
4  * Martin Hundebøll, Jeppe Ledet-Pedersen
5  */
6 
7 #include "network-coding.h"
8 #include "main.h"
9 
10 #include <linux/atomic.h>
11 #include <linux/bitops.h>
12 #include <linux/byteorder/generic.h>
13 #include <linux/compiler.h>
14 #include <linux/debugfs.h>
15 #include <linux/errno.h>
16 #include <linux/etherdevice.h>
17 #include <linux/gfp.h>
18 #include <linux/if_ether.h>
19 #include <linux/if_packet.h>
20 #include <linux/init.h>
21 #include <linux/jhash.h>
22 #include <linux/jiffies.h>
23 #include <linux/kernel.h>
24 #include <linux/kref.h>
25 #include <linux/list.h>
26 #include <linux/lockdep.h>
27 #include <linux/net.h>
28 #include <linux/netdevice.h>
29 #include <linux/printk.h>
30 #include <linux/random.h>
31 #include <linux/rculist.h>
32 #include <linux/rcupdate.h>
33 #include <linux/seq_file.h>
34 #include <linux/skbuff.h>
35 #include <linux/slab.h>
36 #include <linux/spinlock.h>
37 #include <linux/stddef.h>
38 #include <linux/string.h>
39 #include <linux/workqueue.h>
40 #include <uapi/linux/batadv_packet.h>
41 
42 #include "hard-interface.h"
43 #include "hash.h"
44 #include "log.h"
45 #include "originator.h"
46 #include "routing.h"
47 #include "send.h"
48 #include "tvlv.h"
49 
50 static struct lock_class_key batadv_nc_coding_hash_lock_class_key;
51 static struct lock_class_key batadv_nc_decoding_hash_lock_class_key;
52 
53 static void batadv_nc_worker(struct work_struct *work);
54 static int batadv_nc_recv_coded_packet(struct sk_buff *skb,
55 				       struct batadv_hard_iface *recv_if);
56 
57 /**
58  * batadv_nc_init() - one-time initialization for network coding
59  *
60  * Return: 0 on success or negative error number in case of failure
61  */
62 int __init batadv_nc_init(void)
63 {
64 	int ret;
65 
66 	/* Register our packet type */
67 	ret = batadv_recv_handler_register(BATADV_CODED,
68 					   batadv_nc_recv_coded_packet);
69 
70 	return ret;
71 }
72 
73 /**
74  * batadv_nc_start_timer() - initialise the nc periodic worker
75  * @bat_priv: the bat priv with all the soft interface information
76  */
77 static void batadv_nc_start_timer(struct batadv_priv *bat_priv)
78 {
79 	queue_delayed_work(batadv_event_workqueue, &bat_priv->nc.work,
80 			   msecs_to_jiffies(10));
81 }
82 
83 /**
84  * batadv_nc_tvlv_container_update() - update the network coding tvlv container
85  *  after network coding setting change
86  * @bat_priv: the bat priv with all the soft interface information
87  */
88 static void batadv_nc_tvlv_container_update(struct batadv_priv *bat_priv)
89 {
90 	char nc_mode;
91 
92 	nc_mode = atomic_read(&bat_priv->network_coding);
93 
94 	switch (nc_mode) {
95 	case 0:
96 		batadv_tvlv_container_unregister(bat_priv, BATADV_TVLV_NC, 1);
97 		break;
98 	case 1:
99 		batadv_tvlv_container_register(bat_priv, BATADV_TVLV_NC, 1,
100 					       NULL, 0);
101 		break;
102 	}
103 }
104 
105 /**
106  * batadv_nc_status_update() - update the network coding tvlv container after
107  *  network coding setting change
108  * @net_dev: the soft interface net device
109  */
110 void batadv_nc_status_update(struct net_device *net_dev)
111 {
112 	struct batadv_priv *bat_priv = netdev_priv(net_dev);
113 
114 	batadv_nc_tvlv_container_update(bat_priv);
115 }
116 
117 /**
118  * batadv_nc_tvlv_ogm_handler_v1() - process incoming nc tvlv container
119  * @bat_priv: the bat priv with all the soft interface information
120  * @orig: the orig_node of the ogm
121  * @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags)
122  * @tvlv_value: tvlv buffer containing the gateway data
123  * @tvlv_value_len: tvlv buffer length
124  */
125 static void batadv_nc_tvlv_ogm_handler_v1(struct batadv_priv *bat_priv,
126 					  struct batadv_orig_node *orig,
127 					  u8 flags,
128 					  void *tvlv_value, u16 tvlv_value_len)
129 {
130 	if (flags & BATADV_TVLV_HANDLER_OGM_CIFNOTFND)
131 		clear_bit(BATADV_ORIG_CAPA_HAS_NC, &orig->capabilities);
132 	else
133 		set_bit(BATADV_ORIG_CAPA_HAS_NC, &orig->capabilities);
134 }
135 
136 /**
137  * batadv_nc_mesh_init() - initialise coding hash table and start housekeeping
138  * @bat_priv: the bat priv with all the soft interface information
139  *
140  * Return: 0 on success or negative error number in case of failure
141  */
142 int batadv_nc_mesh_init(struct batadv_priv *bat_priv)
143 {
144 	bat_priv->nc.timestamp_fwd_flush = jiffies;
145 	bat_priv->nc.timestamp_sniffed_purge = jiffies;
146 
147 	if (bat_priv->nc.coding_hash || bat_priv->nc.decoding_hash)
148 		return 0;
149 
150 	bat_priv->nc.coding_hash = batadv_hash_new(128);
151 	if (!bat_priv->nc.coding_hash)
152 		goto err;
153 
154 	batadv_hash_set_lock_class(bat_priv->nc.coding_hash,
155 				   &batadv_nc_coding_hash_lock_class_key);
156 
157 	bat_priv->nc.decoding_hash = batadv_hash_new(128);
158 	if (!bat_priv->nc.decoding_hash)
159 		goto err;
160 
161 	batadv_hash_set_lock_class(bat_priv->nc.decoding_hash,
162 				   &batadv_nc_decoding_hash_lock_class_key);
163 
164 	INIT_DELAYED_WORK(&bat_priv->nc.work, batadv_nc_worker);
165 	batadv_nc_start_timer(bat_priv);
166 
167 	batadv_tvlv_handler_register(bat_priv, batadv_nc_tvlv_ogm_handler_v1,
168 				     NULL, BATADV_TVLV_NC, 1,
169 				     BATADV_TVLV_HANDLER_OGM_CIFNOTFND);
170 	batadv_nc_tvlv_container_update(bat_priv);
171 	return 0;
172 
173 err:
174 	return -ENOMEM;
175 }
176 
177 /**
178  * batadv_nc_init_bat_priv() - initialise the nc specific bat_priv variables
179  * @bat_priv: the bat priv with all the soft interface information
180  */
181 void batadv_nc_init_bat_priv(struct batadv_priv *bat_priv)
182 {
183 	atomic_set(&bat_priv->network_coding, 0);
184 	bat_priv->nc.min_tq = 200;
185 	bat_priv->nc.max_fwd_delay = 10;
186 	bat_priv->nc.max_buffer_time = 200;
187 }
188 
189 /**
190  * batadv_nc_init_orig() - initialise the nc fields of an orig_node
191  * @orig_node: the orig_node which is going to be initialised
192  */
193 void batadv_nc_init_orig(struct batadv_orig_node *orig_node)
194 {
195 	INIT_LIST_HEAD(&orig_node->in_coding_list);
196 	INIT_LIST_HEAD(&orig_node->out_coding_list);
197 	spin_lock_init(&orig_node->in_coding_list_lock);
198 	spin_lock_init(&orig_node->out_coding_list_lock);
199 }
200 
201 /**
202  * batadv_nc_node_release() - release nc_node from lists and queue for free
203  *  after rcu grace period
204  * @ref: kref pointer of the nc_node
205  */
206 static void batadv_nc_node_release(struct kref *ref)
207 {
208 	struct batadv_nc_node *nc_node;
209 
210 	nc_node = container_of(ref, struct batadv_nc_node, refcount);
211 
212 	batadv_orig_node_put(nc_node->orig_node);
213 	kfree_rcu(nc_node, rcu);
214 }
215 
216 /**
217  * batadv_nc_node_put() - decrement the nc_node refcounter and possibly
218  *  release it
219  * @nc_node: nc_node to be free'd
220  */
221 static void batadv_nc_node_put(struct batadv_nc_node *nc_node)
222 {
223 	kref_put(&nc_node->refcount, batadv_nc_node_release);
224 }
225 
226 /**
227  * batadv_nc_path_release() - release nc_path from lists and queue for free
228  *  after rcu grace period
229  * @ref: kref pointer of the nc_path
230  */
231 static void batadv_nc_path_release(struct kref *ref)
232 {
233 	struct batadv_nc_path *nc_path;
234 
235 	nc_path = container_of(ref, struct batadv_nc_path, refcount);
236 
237 	kfree_rcu(nc_path, rcu);
238 }
239 
240 /**
241  * batadv_nc_path_put() - decrement the nc_path refcounter and possibly
242  *  release it
243  * @nc_path: nc_path to be free'd
244  */
245 static void batadv_nc_path_put(struct batadv_nc_path *nc_path)
246 {
247 	kref_put(&nc_path->refcount, batadv_nc_path_release);
248 }
249 
250 /**
251  * batadv_nc_packet_free() - frees nc packet
252  * @nc_packet: the nc packet to free
253  * @dropped: whether the packet is freed because is is dropped
254  */
255 static void batadv_nc_packet_free(struct batadv_nc_packet *nc_packet,
256 				  bool dropped)
257 {
258 	if (dropped)
259 		kfree_skb(nc_packet->skb);
260 	else
261 		consume_skb(nc_packet->skb);
262 
263 	batadv_nc_path_put(nc_packet->nc_path);
264 	kfree(nc_packet);
265 }
266 
267 /**
268  * batadv_nc_to_purge_nc_node() - checks whether an nc node has to be purged
269  * @bat_priv: the bat priv with all the soft interface information
270  * @nc_node: the nc node to check
271  *
272  * Return: true if the entry has to be purged now, false otherwise
273  */
274 static bool batadv_nc_to_purge_nc_node(struct batadv_priv *bat_priv,
275 				       struct batadv_nc_node *nc_node)
276 {
277 	if (atomic_read(&bat_priv->mesh_state) != BATADV_MESH_ACTIVE)
278 		return true;
279 
280 	return batadv_has_timed_out(nc_node->last_seen, BATADV_NC_NODE_TIMEOUT);
281 }
282 
283 /**
284  * batadv_nc_to_purge_nc_path_coding() - checks whether an nc path has timed out
285  * @bat_priv: the bat priv with all the soft interface information
286  * @nc_path: the nc path to check
287  *
288  * Return: true if the entry has to be purged now, false otherwise
289  */
290 static bool batadv_nc_to_purge_nc_path_coding(struct batadv_priv *bat_priv,
291 					      struct batadv_nc_path *nc_path)
292 {
293 	if (atomic_read(&bat_priv->mesh_state) != BATADV_MESH_ACTIVE)
294 		return true;
295 
296 	/* purge the path when no packets has been added for 10 times the
297 	 * max_fwd_delay time
298 	 */
299 	return batadv_has_timed_out(nc_path->last_valid,
300 				    bat_priv->nc.max_fwd_delay * 10);
301 }
302 
303 /**
304  * batadv_nc_to_purge_nc_path_decoding() - checks whether an nc path has timed
305  *  out
306  * @bat_priv: the bat priv with all the soft interface information
307  * @nc_path: the nc path to check
308  *
309  * Return: true if the entry has to be purged now, false otherwise
310  */
311 static bool batadv_nc_to_purge_nc_path_decoding(struct batadv_priv *bat_priv,
312 						struct batadv_nc_path *nc_path)
313 {
314 	if (atomic_read(&bat_priv->mesh_state) != BATADV_MESH_ACTIVE)
315 		return true;
316 
317 	/* purge the path when no packets has been added for 10 times the
318 	 * max_buffer time
319 	 */
320 	return batadv_has_timed_out(nc_path->last_valid,
321 				    bat_priv->nc.max_buffer_time * 10);
322 }
323 
324 /**
325  * batadv_nc_purge_orig_nc_nodes() - go through list of nc nodes and purge stale
326  *  entries
327  * @bat_priv: the bat priv with all the soft interface information
328  * @list: list of nc nodes
329  * @lock: nc node list lock
330  * @to_purge: function in charge to decide whether an entry has to be purged or
331  *	      not. This function takes the nc node as argument and has to return
332  *	      a boolean value: true if the entry has to be deleted, false
333  *	      otherwise
334  */
335 static void
336 batadv_nc_purge_orig_nc_nodes(struct batadv_priv *bat_priv,
337 			      struct list_head *list,
338 			      spinlock_t *lock,
339 			      bool (*to_purge)(struct batadv_priv *,
340 					       struct batadv_nc_node *))
341 {
342 	struct batadv_nc_node *nc_node, *nc_node_tmp;
343 
344 	/* For each nc_node in list */
345 	spin_lock_bh(lock);
346 	list_for_each_entry_safe(nc_node, nc_node_tmp, list, list) {
347 		/* if an helper function has been passed as parameter,
348 		 * ask it if the entry has to be purged or not
349 		 */
350 		if (to_purge && !to_purge(bat_priv, nc_node))
351 			continue;
352 
353 		batadv_dbg(BATADV_DBG_NC, bat_priv,
354 			   "Removing nc_node %pM -> %pM\n",
355 			   nc_node->addr, nc_node->orig_node->orig);
356 		list_del_rcu(&nc_node->list);
357 		batadv_nc_node_put(nc_node);
358 	}
359 	spin_unlock_bh(lock);
360 }
361 
362 /**
363  * batadv_nc_purge_orig() - purges all nc node data attached of the given
364  *  originator
365  * @bat_priv: the bat priv with all the soft interface information
366  * @orig_node: orig_node with the nc node entries to be purged
367  * @to_purge: function in charge to decide whether an entry has to be purged or
368  *	      not. This function takes the nc node as argument and has to return
369  *	      a boolean value: true is the entry has to be deleted, false
370  *	      otherwise
371  */
372 void batadv_nc_purge_orig(struct batadv_priv *bat_priv,
373 			  struct batadv_orig_node *orig_node,
374 			  bool (*to_purge)(struct batadv_priv *,
375 					   struct batadv_nc_node *))
376 {
377 	/* Check ingoing nc_node's of this orig_node */
378 	batadv_nc_purge_orig_nc_nodes(bat_priv, &orig_node->in_coding_list,
379 				      &orig_node->in_coding_list_lock,
380 				      to_purge);
381 
382 	/* Check outgoing nc_node's of this orig_node */
383 	batadv_nc_purge_orig_nc_nodes(bat_priv, &orig_node->out_coding_list,
384 				      &orig_node->out_coding_list_lock,
385 				      to_purge);
386 }
387 
388 /**
389  * batadv_nc_purge_orig_hash() - traverse entire originator hash to check if
390  *  they have timed out nc nodes
391  * @bat_priv: the bat priv with all the soft interface information
392  */
393 static void batadv_nc_purge_orig_hash(struct batadv_priv *bat_priv)
394 {
395 	struct batadv_hashtable *hash = bat_priv->orig_hash;
396 	struct hlist_head *head;
397 	struct batadv_orig_node *orig_node;
398 	u32 i;
399 
400 	if (!hash)
401 		return;
402 
403 	/* For each orig_node */
404 	for (i = 0; i < hash->size; i++) {
405 		head = &hash->table[i];
406 
407 		rcu_read_lock();
408 		hlist_for_each_entry_rcu(orig_node, head, hash_entry)
409 			batadv_nc_purge_orig(bat_priv, orig_node,
410 					     batadv_nc_to_purge_nc_node);
411 		rcu_read_unlock();
412 	}
413 }
414 
415 /**
416  * batadv_nc_purge_paths() - traverse all nc paths part of the hash and remove
417  *  unused ones
418  * @bat_priv: the bat priv with all the soft interface information
419  * @hash: hash table containing the nc paths to check
420  * @to_purge: function in charge to decide whether an entry has to be purged or
421  *	      not. This function takes the nc node as argument and has to return
422  *	      a boolean value: true is the entry has to be deleted, false
423  *	      otherwise
424  */
425 static void batadv_nc_purge_paths(struct batadv_priv *bat_priv,
426 				  struct batadv_hashtable *hash,
427 				  bool (*to_purge)(struct batadv_priv *,
428 						   struct batadv_nc_path *))
429 {
430 	struct hlist_head *head;
431 	struct hlist_node *node_tmp;
432 	struct batadv_nc_path *nc_path;
433 	spinlock_t *lock; /* Protects lists in hash */
434 	u32 i;
435 
436 	for (i = 0; i < hash->size; i++) {
437 		head = &hash->table[i];
438 		lock = &hash->list_locks[i];
439 
440 		/* For each nc_path in this bin */
441 		spin_lock_bh(lock);
442 		hlist_for_each_entry_safe(nc_path, node_tmp, head, hash_entry) {
443 			/* if an helper function has been passed as parameter,
444 			 * ask it if the entry has to be purged or not
445 			 */
446 			if (to_purge && !to_purge(bat_priv, nc_path))
447 				continue;
448 
449 			/* purging an non-empty nc_path should never happen, but
450 			 * is observed under high CPU load. Delay the purging
451 			 * until next iteration to allow the packet_list to be
452 			 * emptied first.
453 			 */
454 			if (!unlikely(list_empty(&nc_path->packet_list))) {
455 				net_ratelimited_function(printk,
456 							 KERN_WARNING
457 							 "Skipping free of non-empty nc_path (%pM -> %pM)!\n",
458 							 nc_path->prev_hop,
459 							 nc_path->next_hop);
460 				continue;
461 			}
462 
463 			/* nc_path is unused, so remove it */
464 			batadv_dbg(BATADV_DBG_NC, bat_priv,
465 				   "Remove nc_path %pM -> %pM\n",
466 				   nc_path->prev_hop, nc_path->next_hop);
467 			hlist_del_rcu(&nc_path->hash_entry);
468 			batadv_nc_path_put(nc_path);
469 		}
470 		spin_unlock_bh(lock);
471 	}
472 }
473 
474 /**
475  * batadv_nc_hash_key_gen() - computes the nc_path hash key
476  * @key: buffer to hold the final hash key
477  * @src: source ethernet mac address going into the hash key
478  * @dst: destination ethernet mac address going into the hash key
479  */
480 static void batadv_nc_hash_key_gen(struct batadv_nc_path *key, const char *src,
481 				   const char *dst)
482 {
483 	memcpy(key->prev_hop, src, sizeof(key->prev_hop));
484 	memcpy(key->next_hop, dst, sizeof(key->next_hop));
485 }
486 
487 /**
488  * batadv_nc_hash_choose() - compute the hash value for an nc path
489  * @data: data to hash
490  * @size: size of the hash table
491  *
492  * Return: the selected index in the hash table for the given data.
493  */
494 static u32 batadv_nc_hash_choose(const void *data, u32 size)
495 {
496 	const struct batadv_nc_path *nc_path = data;
497 	u32 hash = 0;
498 
499 	hash = jhash(&nc_path->prev_hop, sizeof(nc_path->prev_hop), hash);
500 	hash = jhash(&nc_path->next_hop, sizeof(nc_path->next_hop), hash);
501 
502 	return hash % size;
503 }
504 
505 /**
506  * batadv_nc_hash_compare() - comparing function used in the network coding hash
507  *  tables
508  * @node: node in the local table
509  * @data2: second object to compare the node to
510  *
511  * Return: true if the two entry are the same, false otherwise
512  */
513 static bool batadv_nc_hash_compare(const struct hlist_node *node,
514 				   const void *data2)
515 {
516 	const struct batadv_nc_path *nc_path1, *nc_path2;
517 
518 	nc_path1 = container_of(node, struct batadv_nc_path, hash_entry);
519 	nc_path2 = data2;
520 
521 	/* Return 1 if the two keys are identical */
522 	if (!batadv_compare_eth(nc_path1->prev_hop, nc_path2->prev_hop))
523 		return false;
524 
525 	if (!batadv_compare_eth(nc_path1->next_hop, nc_path2->next_hop))
526 		return false;
527 
528 	return true;
529 }
530 
531 /**
532  * batadv_nc_hash_find() - search for an existing nc path and return it
533  * @hash: hash table containing the nc path
534  * @data: search key
535  *
536  * Return: the nc_path if found, NULL otherwise.
537  */
538 static struct batadv_nc_path *
539 batadv_nc_hash_find(struct batadv_hashtable *hash,
540 		    void *data)
541 {
542 	struct hlist_head *head;
543 	struct batadv_nc_path *nc_path, *nc_path_tmp = NULL;
544 	int index;
545 
546 	if (!hash)
547 		return NULL;
548 
549 	index = batadv_nc_hash_choose(data, hash->size);
550 	head = &hash->table[index];
551 
552 	rcu_read_lock();
553 	hlist_for_each_entry_rcu(nc_path, head, hash_entry) {
554 		if (!batadv_nc_hash_compare(&nc_path->hash_entry, data))
555 			continue;
556 
557 		if (!kref_get_unless_zero(&nc_path->refcount))
558 			continue;
559 
560 		nc_path_tmp = nc_path;
561 		break;
562 	}
563 	rcu_read_unlock();
564 
565 	return nc_path_tmp;
566 }
567 
568 /**
569  * batadv_nc_send_packet() - send non-coded packet and free nc_packet struct
570  * @nc_packet: the nc packet to send
571  */
572 static void batadv_nc_send_packet(struct batadv_nc_packet *nc_packet)
573 {
574 	batadv_send_unicast_skb(nc_packet->skb, nc_packet->neigh_node);
575 	nc_packet->skb = NULL;
576 	batadv_nc_packet_free(nc_packet, false);
577 }
578 
579 /**
580  * batadv_nc_sniffed_purge() - Checks timestamp of given sniffed nc_packet.
581  * @bat_priv: the bat priv with all the soft interface information
582  * @nc_path: the nc path the packet belongs to
583  * @nc_packet: the nc packet to be checked
584  *
585  * Checks whether the given sniffed (overheard) nc_packet has hit its buffering
586  * timeout. If so, the packet is no longer kept and the entry deleted from the
587  * queue. Has to be called with the appropriate locks.
588  *
589  * Return: false as soon as the entry in the fifo queue has not been timed out
590  * yet and true otherwise.
591  */
592 static bool batadv_nc_sniffed_purge(struct batadv_priv *bat_priv,
593 				    struct batadv_nc_path *nc_path,
594 				    struct batadv_nc_packet *nc_packet)
595 {
596 	unsigned long timeout = bat_priv->nc.max_buffer_time;
597 	bool res = false;
598 
599 	lockdep_assert_held(&nc_path->packet_list_lock);
600 
601 	/* Packets are added to tail, so the remaining packets did not time
602 	 * out and we can stop processing the current queue
603 	 */
604 	if (atomic_read(&bat_priv->mesh_state) == BATADV_MESH_ACTIVE &&
605 	    !batadv_has_timed_out(nc_packet->timestamp, timeout))
606 		goto out;
607 
608 	/* purge nc packet */
609 	list_del(&nc_packet->list);
610 	batadv_nc_packet_free(nc_packet, true);
611 
612 	res = true;
613 
614 out:
615 	return res;
616 }
617 
618 /**
619  * batadv_nc_fwd_flush() - Checks the timestamp of the given nc packet.
620  * @bat_priv: the bat priv with all the soft interface information
621  * @nc_path: the nc path the packet belongs to
622  * @nc_packet: the nc packet to be checked
623  *
624  * Checks whether the given nc packet has hit its forward timeout. If so, the
625  * packet is no longer delayed, immediately sent and the entry deleted from the
626  * queue. Has to be called with the appropriate locks.
627  *
628  * Return: false as soon as the entry in the fifo queue has not been timed out
629  * yet and true otherwise.
630  */
631 static bool batadv_nc_fwd_flush(struct batadv_priv *bat_priv,
632 				struct batadv_nc_path *nc_path,
633 				struct batadv_nc_packet *nc_packet)
634 {
635 	unsigned long timeout = bat_priv->nc.max_fwd_delay;
636 
637 	lockdep_assert_held(&nc_path->packet_list_lock);
638 
639 	/* Packets are added to tail, so the remaining packets did not time
640 	 * out and we can stop processing the current queue
641 	 */
642 	if (atomic_read(&bat_priv->mesh_state) == BATADV_MESH_ACTIVE &&
643 	    !batadv_has_timed_out(nc_packet->timestamp, timeout))
644 		return false;
645 
646 	/* Send packet */
647 	batadv_inc_counter(bat_priv, BATADV_CNT_FORWARD);
648 	batadv_add_counter(bat_priv, BATADV_CNT_FORWARD_BYTES,
649 			   nc_packet->skb->len + ETH_HLEN);
650 	list_del(&nc_packet->list);
651 	batadv_nc_send_packet(nc_packet);
652 
653 	return true;
654 }
655 
656 /**
657  * batadv_nc_process_nc_paths() - traverse given nc packet pool and free timed
658  *  out nc packets
659  * @bat_priv: the bat priv with all the soft interface information
660  * @hash: to be processed hash table
661  * @process_fn: Function called to process given nc packet. Should return true
662  *	        to encourage this function to proceed with the next packet.
663  *	        Otherwise the rest of the current queue is skipped.
664  */
665 static void
666 batadv_nc_process_nc_paths(struct batadv_priv *bat_priv,
667 			   struct batadv_hashtable *hash,
668 			   bool (*process_fn)(struct batadv_priv *,
669 					      struct batadv_nc_path *,
670 					      struct batadv_nc_packet *))
671 {
672 	struct hlist_head *head;
673 	struct batadv_nc_packet *nc_packet, *nc_packet_tmp;
674 	struct batadv_nc_path *nc_path;
675 	bool ret;
676 	int i;
677 
678 	if (!hash)
679 		return;
680 
681 	/* Loop hash table bins */
682 	for (i = 0; i < hash->size; i++) {
683 		head = &hash->table[i];
684 
685 		/* Loop coding paths */
686 		rcu_read_lock();
687 		hlist_for_each_entry_rcu(nc_path, head, hash_entry) {
688 			/* Loop packets */
689 			spin_lock_bh(&nc_path->packet_list_lock);
690 			list_for_each_entry_safe(nc_packet, nc_packet_tmp,
691 						 &nc_path->packet_list, list) {
692 				ret = process_fn(bat_priv, nc_path, nc_packet);
693 				if (!ret)
694 					break;
695 			}
696 			spin_unlock_bh(&nc_path->packet_list_lock);
697 		}
698 		rcu_read_unlock();
699 	}
700 }
701 
702 /**
703  * batadv_nc_worker() - periodic task for housekeeping related to network
704  *  coding
705  * @work: kernel work struct
706  */
707 static void batadv_nc_worker(struct work_struct *work)
708 {
709 	struct delayed_work *delayed_work;
710 	struct batadv_priv_nc *priv_nc;
711 	struct batadv_priv *bat_priv;
712 	unsigned long timeout;
713 
714 	delayed_work = to_delayed_work(work);
715 	priv_nc = container_of(delayed_work, struct batadv_priv_nc, work);
716 	bat_priv = container_of(priv_nc, struct batadv_priv, nc);
717 
718 	batadv_nc_purge_orig_hash(bat_priv);
719 	batadv_nc_purge_paths(bat_priv, bat_priv->nc.coding_hash,
720 			      batadv_nc_to_purge_nc_path_coding);
721 	batadv_nc_purge_paths(bat_priv, bat_priv->nc.decoding_hash,
722 			      batadv_nc_to_purge_nc_path_decoding);
723 
724 	timeout = bat_priv->nc.max_fwd_delay;
725 
726 	if (batadv_has_timed_out(bat_priv->nc.timestamp_fwd_flush, timeout)) {
727 		batadv_nc_process_nc_paths(bat_priv, bat_priv->nc.coding_hash,
728 					   batadv_nc_fwd_flush);
729 		bat_priv->nc.timestamp_fwd_flush = jiffies;
730 	}
731 
732 	if (batadv_has_timed_out(bat_priv->nc.timestamp_sniffed_purge,
733 				 bat_priv->nc.max_buffer_time)) {
734 		batadv_nc_process_nc_paths(bat_priv, bat_priv->nc.decoding_hash,
735 					   batadv_nc_sniffed_purge);
736 		bat_priv->nc.timestamp_sniffed_purge = jiffies;
737 	}
738 
739 	/* Schedule a new check */
740 	batadv_nc_start_timer(bat_priv);
741 }
742 
743 /**
744  * batadv_can_nc_with_orig() - checks whether the given orig node is suitable
745  *  for coding or not
746  * @bat_priv: the bat priv with all the soft interface information
747  * @orig_node: neighboring orig node which may be used as nc candidate
748  * @ogm_packet: incoming ogm packet also used for the checks
749  *
750  * Return: true if:
751  *  1) The OGM must have the most recent sequence number.
752  *  2) The TTL must be decremented by one and only one.
753  *  3) The OGM must be received from the first hop from orig_node.
754  *  4) The TQ value of the OGM must be above bat_priv->nc.min_tq.
755  */
756 static bool batadv_can_nc_with_orig(struct batadv_priv *bat_priv,
757 				    struct batadv_orig_node *orig_node,
758 				    struct batadv_ogm_packet *ogm_packet)
759 {
760 	struct batadv_orig_ifinfo *orig_ifinfo;
761 	u32 last_real_seqno;
762 	u8 last_ttl;
763 
764 	orig_ifinfo = batadv_orig_ifinfo_get(orig_node, BATADV_IF_DEFAULT);
765 	if (!orig_ifinfo)
766 		return false;
767 
768 	last_ttl = orig_ifinfo->last_ttl;
769 	last_real_seqno = orig_ifinfo->last_real_seqno;
770 	batadv_orig_ifinfo_put(orig_ifinfo);
771 
772 	if (last_real_seqno != ntohl(ogm_packet->seqno))
773 		return false;
774 	if (last_ttl != ogm_packet->ttl + 1)
775 		return false;
776 	if (!batadv_compare_eth(ogm_packet->orig, ogm_packet->prev_sender))
777 		return false;
778 	if (ogm_packet->tq < bat_priv->nc.min_tq)
779 		return false;
780 
781 	return true;
782 }
783 
784 /**
785  * batadv_nc_find_nc_node() - search for an existing nc node and return it
786  * @orig_node: orig node originating the ogm packet
787  * @orig_neigh_node: neighboring orig node from which we received the ogm packet
788  *  (can be equal to orig_node)
789  * @in_coding: traverse incoming or outgoing network coding list
790  *
791  * Return: the nc_node if found, NULL otherwise.
792  */
793 static struct batadv_nc_node *
794 batadv_nc_find_nc_node(struct batadv_orig_node *orig_node,
795 		       struct batadv_orig_node *orig_neigh_node,
796 		       bool in_coding)
797 {
798 	struct batadv_nc_node *nc_node, *nc_node_out = NULL;
799 	struct list_head *list;
800 
801 	if (in_coding)
802 		list = &orig_neigh_node->in_coding_list;
803 	else
804 		list = &orig_neigh_node->out_coding_list;
805 
806 	/* Traverse list of nc_nodes to orig_node */
807 	rcu_read_lock();
808 	list_for_each_entry_rcu(nc_node, list, list) {
809 		if (!batadv_compare_eth(nc_node->addr, orig_node->orig))
810 			continue;
811 
812 		if (!kref_get_unless_zero(&nc_node->refcount))
813 			continue;
814 
815 		/* Found a match */
816 		nc_node_out = nc_node;
817 		break;
818 	}
819 	rcu_read_unlock();
820 
821 	return nc_node_out;
822 }
823 
824 /**
825  * batadv_nc_get_nc_node() - retrieves an nc node or creates the entry if it was
826  *  not found
827  * @bat_priv: the bat priv with all the soft interface information
828  * @orig_node: orig node originating the ogm packet
829  * @orig_neigh_node: neighboring orig node from which we received the ogm packet
830  *  (can be equal to orig_node)
831  * @in_coding: traverse incoming or outgoing network coding list
832  *
833  * Return: the nc_node if found or created, NULL in case of an error.
834  */
835 static struct batadv_nc_node *
836 batadv_nc_get_nc_node(struct batadv_priv *bat_priv,
837 		      struct batadv_orig_node *orig_node,
838 		      struct batadv_orig_node *orig_neigh_node,
839 		      bool in_coding)
840 {
841 	struct batadv_nc_node *nc_node;
842 	spinlock_t *lock; /* Used to lock list selected by "int in_coding" */
843 	struct list_head *list;
844 
845 	/* Select ingoing or outgoing coding node */
846 	if (in_coding) {
847 		lock = &orig_neigh_node->in_coding_list_lock;
848 		list = &orig_neigh_node->in_coding_list;
849 	} else {
850 		lock = &orig_neigh_node->out_coding_list_lock;
851 		list = &orig_neigh_node->out_coding_list;
852 	}
853 
854 	spin_lock_bh(lock);
855 
856 	/* Check if nc_node is already added */
857 	nc_node = batadv_nc_find_nc_node(orig_node, orig_neigh_node, in_coding);
858 
859 	/* Node found */
860 	if (nc_node)
861 		goto unlock;
862 
863 	nc_node = kzalloc(sizeof(*nc_node), GFP_ATOMIC);
864 	if (!nc_node)
865 		goto unlock;
866 
867 	/* Initialize nc_node */
868 	INIT_LIST_HEAD(&nc_node->list);
869 	kref_init(&nc_node->refcount);
870 	ether_addr_copy(nc_node->addr, orig_node->orig);
871 	kref_get(&orig_neigh_node->refcount);
872 	nc_node->orig_node = orig_neigh_node;
873 
874 	batadv_dbg(BATADV_DBG_NC, bat_priv, "Adding nc_node %pM -> %pM\n",
875 		   nc_node->addr, nc_node->orig_node->orig);
876 
877 	/* Add nc_node to orig_node */
878 	kref_get(&nc_node->refcount);
879 	list_add_tail_rcu(&nc_node->list, list);
880 
881 unlock:
882 	spin_unlock_bh(lock);
883 
884 	return nc_node;
885 }
886 
887 /**
888  * batadv_nc_update_nc_node() - updates stored incoming and outgoing nc node
889  *  structs (best called on incoming OGMs)
890  * @bat_priv: the bat priv with all the soft interface information
891  * @orig_node: orig node originating the ogm packet
892  * @orig_neigh_node: neighboring orig node from which we received the ogm packet
893  *  (can be equal to orig_node)
894  * @ogm_packet: incoming ogm packet
895  * @is_single_hop_neigh: orig_node is a single hop neighbor
896  */
897 void batadv_nc_update_nc_node(struct batadv_priv *bat_priv,
898 			      struct batadv_orig_node *orig_node,
899 			      struct batadv_orig_node *orig_neigh_node,
900 			      struct batadv_ogm_packet *ogm_packet,
901 			      int is_single_hop_neigh)
902 {
903 	struct batadv_nc_node *in_nc_node = NULL;
904 	struct batadv_nc_node *out_nc_node = NULL;
905 
906 	/* Check if network coding is enabled */
907 	if (!atomic_read(&bat_priv->network_coding))
908 		goto out;
909 
910 	/* check if orig node is network coding enabled */
911 	if (!test_bit(BATADV_ORIG_CAPA_HAS_NC, &orig_node->capabilities))
912 		goto out;
913 
914 	/* accept ogms from 'good' neighbors and single hop neighbors */
915 	if (!batadv_can_nc_with_orig(bat_priv, orig_node, ogm_packet) &&
916 	    !is_single_hop_neigh)
917 		goto out;
918 
919 	/* Add orig_node as in_nc_node on hop */
920 	in_nc_node = batadv_nc_get_nc_node(bat_priv, orig_node,
921 					   orig_neigh_node, true);
922 	if (!in_nc_node)
923 		goto out;
924 
925 	in_nc_node->last_seen = jiffies;
926 
927 	/* Add hop as out_nc_node on orig_node */
928 	out_nc_node = batadv_nc_get_nc_node(bat_priv, orig_neigh_node,
929 					    orig_node, false);
930 	if (!out_nc_node)
931 		goto out;
932 
933 	out_nc_node->last_seen = jiffies;
934 
935 out:
936 	if (in_nc_node)
937 		batadv_nc_node_put(in_nc_node);
938 	if (out_nc_node)
939 		batadv_nc_node_put(out_nc_node);
940 }
941 
942 /**
943  * batadv_nc_get_path() - get existing nc_path or allocate a new one
944  * @bat_priv: the bat priv with all the soft interface information
945  * @hash: hash table containing the nc path
946  * @src: ethernet source address - first half of the nc path search key
947  * @dst: ethernet destination address - second half of the nc path search key
948  *
949  * Return: pointer to nc_path if the path was found or created, returns NULL
950  * on error.
951  */
952 static struct batadv_nc_path *batadv_nc_get_path(struct batadv_priv *bat_priv,
953 						 struct batadv_hashtable *hash,
954 						 u8 *src,
955 						 u8 *dst)
956 {
957 	int hash_added;
958 	struct batadv_nc_path *nc_path, nc_path_key;
959 
960 	batadv_nc_hash_key_gen(&nc_path_key, src, dst);
961 
962 	/* Search for existing nc_path */
963 	nc_path = batadv_nc_hash_find(hash, (void *)&nc_path_key);
964 
965 	if (nc_path) {
966 		/* Set timestamp to delay removal of nc_path */
967 		nc_path->last_valid = jiffies;
968 		return nc_path;
969 	}
970 
971 	/* No existing nc_path was found; create a new */
972 	nc_path = kzalloc(sizeof(*nc_path), GFP_ATOMIC);
973 
974 	if (!nc_path)
975 		return NULL;
976 
977 	/* Initialize nc_path */
978 	INIT_LIST_HEAD(&nc_path->packet_list);
979 	spin_lock_init(&nc_path->packet_list_lock);
980 	kref_init(&nc_path->refcount);
981 	nc_path->last_valid = jiffies;
982 	ether_addr_copy(nc_path->next_hop, dst);
983 	ether_addr_copy(nc_path->prev_hop, src);
984 
985 	batadv_dbg(BATADV_DBG_NC, bat_priv, "Adding nc_path %pM -> %pM\n",
986 		   nc_path->prev_hop,
987 		   nc_path->next_hop);
988 
989 	/* Add nc_path to hash table */
990 	kref_get(&nc_path->refcount);
991 	hash_added = batadv_hash_add(hash, batadv_nc_hash_compare,
992 				     batadv_nc_hash_choose, &nc_path_key,
993 				     &nc_path->hash_entry);
994 
995 	if (hash_added < 0) {
996 		kfree(nc_path);
997 		return NULL;
998 	}
999 
1000 	return nc_path;
1001 }
1002 
1003 /**
1004  * batadv_nc_random_weight_tq() - scale the receivers TQ-value to avoid unfair
1005  *  selection of a receiver with slightly lower TQ than the other
1006  * @tq: to be weighted tq value
1007  *
1008  * Return: scaled tq value
1009  */
1010 static u8 batadv_nc_random_weight_tq(u8 tq)
1011 {
1012 	/* randomize the estimated packet loss (max TQ - estimated TQ) */
1013 	u8 rand_tq = prandom_u32_max(BATADV_TQ_MAX_VALUE + 1 - tq);
1014 
1015 	/* convert to (randomized) estimated tq again */
1016 	return BATADV_TQ_MAX_VALUE - rand_tq;
1017 }
1018 
1019 /**
1020  * batadv_nc_memxor() - XOR destination with source
1021  * @dst: byte array to XOR into
1022  * @src: byte array to XOR from
1023  * @len: length of destination array
1024  */
1025 static void batadv_nc_memxor(char *dst, const char *src, unsigned int len)
1026 {
1027 	unsigned int i;
1028 
1029 	for (i = 0; i < len; ++i)
1030 		dst[i] ^= src[i];
1031 }
1032 
1033 /**
1034  * batadv_nc_code_packets() - code a received unicast_packet with an nc packet
1035  *  into a coded_packet and send it
1036  * @bat_priv: the bat priv with all the soft interface information
1037  * @skb: data skb to forward
1038  * @ethhdr: pointer to the ethernet header inside the skb
1039  * @nc_packet: structure containing the packet to the skb can be coded with
1040  * @neigh_node: next hop to forward packet to
1041  *
1042  * Return: true if both packets are consumed, false otherwise.
1043  */
1044 static bool batadv_nc_code_packets(struct batadv_priv *bat_priv,
1045 				   struct sk_buff *skb,
1046 				   struct ethhdr *ethhdr,
1047 				   struct batadv_nc_packet *nc_packet,
1048 				   struct batadv_neigh_node *neigh_node)
1049 {
1050 	u8 tq_weighted_neigh, tq_weighted_coding, tq_tmp;
1051 	struct sk_buff *skb_dest, *skb_src;
1052 	struct batadv_unicast_packet *packet1;
1053 	struct batadv_unicast_packet *packet2;
1054 	struct batadv_coded_packet *coded_packet;
1055 	struct batadv_neigh_node *neigh_tmp, *router_neigh, *first_dest;
1056 	struct batadv_neigh_node *router_coding = NULL, *second_dest;
1057 	struct batadv_neigh_ifinfo *router_neigh_ifinfo = NULL;
1058 	struct batadv_neigh_ifinfo *router_coding_ifinfo = NULL;
1059 	u8 *first_source, *second_source;
1060 	__be32 packet_id1, packet_id2;
1061 	size_t count;
1062 	bool res = false;
1063 	int coding_len;
1064 	int unicast_size = sizeof(*packet1);
1065 	int coded_size = sizeof(*coded_packet);
1066 	int header_add = coded_size - unicast_size;
1067 
1068 	/* TODO: do we need to consider the outgoing interface for
1069 	 * coded packets?
1070 	 */
1071 	router_neigh = batadv_orig_router_get(neigh_node->orig_node,
1072 					      BATADV_IF_DEFAULT);
1073 	if (!router_neigh)
1074 		goto out;
1075 
1076 	router_neigh_ifinfo = batadv_neigh_ifinfo_get(router_neigh,
1077 						      BATADV_IF_DEFAULT);
1078 	if (!router_neigh_ifinfo)
1079 		goto out;
1080 
1081 	neigh_tmp = nc_packet->neigh_node;
1082 	router_coding = batadv_orig_router_get(neigh_tmp->orig_node,
1083 					       BATADV_IF_DEFAULT);
1084 	if (!router_coding)
1085 		goto out;
1086 
1087 	router_coding_ifinfo = batadv_neigh_ifinfo_get(router_coding,
1088 						       BATADV_IF_DEFAULT);
1089 	if (!router_coding_ifinfo)
1090 		goto out;
1091 
1092 	tq_tmp = router_neigh_ifinfo->bat_iv.tq_avg;
1093 	tq_weighted_neigh = batadv_nc_random_weight_tq(tq_tmp);
1094 	tq_tmp = router_coding_ifinfo->bat_iv.tq_avg;
1095 	tq_weighted_coding = batadv_nc_random_weight_tq(tq_tmp);
1096 
1097 	/* Select one destination for the MAC-header dst-field based on
1098 	 * weighted TQ-values.
1099 	 */
1100 	if (tq_weighted_neigh >= tq_weighted_coding) {
1101 		/* Destination from nc_packet is selected for MAC-header */
1102 		first_dest = nc_packet->neigh_node;
1103 		first_source = nc_packet->nc_path->prev_hop;
1104 		second_dest = neigh_node;
1105 		second_source = ethhdr->h_source;
1106 		packet1 = (struct batadv_unicast_packet *)nc_packet->skb->data;
1107 		packet2 = (struct batadv_unicast_packet *)skb->data;
1108 		packet_id1 = nc_packet->packet_id;
1109 		packet_id2 = batadv_skb_crc32(skb,
1110 					      skb->data + sizeof(*packet2));
1111 	} else {
1112 		/* Destination for skb is selected for MAC-header */
1113 		first_dest = neigh_node;
1114 		first_source = ethhdr->h_source;
1115 		second_dest = nc_packet->neigh_node;
1116 		second_source = nc_packet->nc_path->prev_hop;
1117 		packet1 = (struct batadv_unicast_packet *)skb->data;
1118 		packet2 = (struct batadv_unicast_packet *)nc_packet->skb->data;
1119 		packet_id1 = batadv_skb_crc32(skb,
1120 					      skb->data + sizeof(*packet1));
1121 		packet_id2 = nc_packet->packet_id;
1122 	}
1123 
1124 	/* Instead of zero padding the smallest data buffer, we
1125 	 * code into the largest.
1126 	 */
1127 	if (skb->len <= nc_packet->skb->len) {
1128 		skb_dest = nc_packet->skb;
1129 		skb_src = skb;
1130 	} else {
1131 		skb_dest = skb;
1132 		skb_src = nc_packet->skb;
1133 	}
1134 
1135 	/* coding_len is used when decoding the packet shorter packet */
1136 	coding_len = skb_src->len - unicast_size;
1137 
1138 	if (skb_linearize(skb_dest) < 0 || skb_linearize(skb_src) < 0)
1139 		goto out;
1140 
1141 	skb_push(skb_dest, header_add);
1142 
1143 	coded_packet = (struct batadv_coded_packet *)skb_dest->data;
1144 	skb_reset_mac_header(skb_dest);
1145 
1146 	coded_packet->packet_type = BATADV_CODED;
1147 	coded_packet->version = BATADV_COMPAT_VERSION;
1148 	coded_packet->ttl = packet1->ttl;
1149 
1150 	/* Info about first unicast packet */
1151 	ether_addr_copy(coded_packet->first_source, first_source);
1152 	ether_addr_copy(coded_packet->first_orig_dest, packet1->dest);
1153 	coded_packet->first_crc = packet_id1;
1154 	coded_packet->first_ttvn = packet1->ttvn;
1155 
1156 	/* Info about second unicast packet */
1157 	ether_addr_copy(coded_packet->second_dest, second_dest->addr);
1158 	ether_addr_copy(coded_packet->second_source, second_source);
1159 	ether_addr_copy(coded_packet->second_orig_dest, packet2->dest);
1160 	coded_packet->second_crc = packet_id2;
1161 	coded_packet->second_ttl = packet2->ttl;
1162 	coded_packet->second_ttvn = packet2->ttvn;
1163 	coded_packet->coded_len = htons(coding_len);
1164 
1165 	/* This is where the magic happens: Code skb_src into skb_dest */
1166 	batadv_nc_memxor(skb_dest->data + coded_size,
1167 			 skb_src->data + unicast_size, coding_len);
1168 
1169 	/* Update counters accordingly */
1170 	if (BATADV_SKB_CB(skb_src)->decoded &&
1171 	    BATADV_SKB_CB(skb_dest)->decoded) {
1172 		/* Both packets are recoded */
1173 		count = skb_src->len + ETH_HLEN;
1174 		count += skb_dest->len + ETH_HLEN;
1175 		batadv_add_counter(bat_priv, BATADV_CNT_NC_RECODE, 2);
1176 		batadv_add_counter(bat_priv, BATADV_CNT_NC_RECODE_BYTES, count);
1177 	} else if (!BATADV_SKB_CB(skb_src)->decoded &&
1178 		   !BATADV_SKB_CB(skb_dest)->decoded) {
1179 		/* Both packets are newly coded */
1180 		count = skb_src->len + ETH_HLEN;
1181 		count += skb_dest->len + ETH_HLEN;
1182 		batadv_add_counter(bat_priv, BATADV_CNT_NC_CODE, 2);
1183 		batadv_add_counter(bat_priv, BATADV_CNT_NC_CODE_BYTES, count);
1184 	} else if (BATADV_SKB_CB(skb_src)->decoded &&
1185 		   !BATADV_SKB_CB(skb_dest)->decoded) {
1186 		/* skb_src recoded and skb_dest is newly coded */
1187 		batadv_inc_counter(bat_priv, BATADV_CNT_NC_RECODE);
1188 		batadv_add_counter(bat_priv, BATADV_CNT_NC_RECODE_BYTES,
1189 				   skb_src->len + ETH_HLEN);
1190 		batadv_inc_counter(bat_priv, BATADV_CNT_NC_CODE);
1191 		batadv_add_counter(bat_priv, BATADV_CNT_NC_CODE_BYTES,
1192 				   skb_dest->len + ETH_HLEN);
1193 	} else if (!BATADV_SKB_CB(skb_src)->decoded &&
1194 		   BATADV_SKB_CB(skb_dest)->decoded) {
1195 		/* skb_src is newly coded and skb_dest is recoded */
1196 		batadv_inc_counter(bat_priv, BATADV_CNT_NC_CODE);
1197 		batadv_add_counter(bat_priv, BATADV_CNT_NC_CODE_BYTES,
1198 				   skb_src->len + ETH_HLEN);
1199 		batadv_inc_counter(bat_priv, BATADV_CNT_NC_RECODE);
1200 		batadv_add_counter(bat_priv, BATADV_CNT_NC_RECODE_BYTES,
1201 				   skb_dest->len + ETH_HLEN);
1202 	}
1203 
1204 	/* skb_src is now coded into skb_dest, so free it */
1205 	consume_skb(skb_src);
1206 
1207 	/* avoid duplicate free of skb from nc_packet */
1208 	nc_packet->skb = NULL;
1209 	batadv_nc_packet_free(nc_packet, false);
1210 
1211 	/* Send the coded packet and return true */
1212 	batadv_send_unicast_skb(skb_dest, first_dest);
1213 	res = true;
1214 out:
1215 	if (router_neigh)
1216 		batadv_neigh_node_put(router_neigh);
1217 	if (router_coding)
1218 		batadv_neigh_node_put(router_coding);
1219 	if (router_neigh_ifinfo)
1220 		batadv_neigh_ifinfo_put(router_neigh_ifinfo);
1221 	if (router_coding_ifinfo)
1222 		batadv_neigh_ifinfo_put(router_coding_ifinfo);
1223 	return res;
1224 }
1225 
1226 /**
1227  * batadv_nc_skb_coding_possible() - true if a decoded skb is available at dst.
1228  * @skb: data skb to forward
1229  * @dst: destination mac address of the other skb to code with
1230  * @src: source mac address of skb
1231  *
1232  * Whenever we network code a packet we have to check whether we received it in
1233  * a network coded form. If so, we may not be able to use it for coding because
1234  * some neighbors may also have received (overheard) the packet in the network
1235  * coded form without being able to decode it. It is hard to know which of the
1236  * neighboring nodes was able to decode the packet, therefore we can only
1237  * re-code the packet if the source of the previous encoded packet is involved.
1238  * Since the source encoded the packet we can be certain it has all necessary
1239  * decode information.
1240  *
1241  * Return: true if coding of a decoded packet is allowed.
1242  */
1243 static bool batadv_nc_skb_coding_possible(struct sk_buff *skb, u8 *dst, u8 *src)
1244 {
1245 	if (BATADV_SKB_CB(skb)->decoded && !batadv_compare_eth(dst, src))
1246 		return false;
1247 	return true;
1248 }
1249 
1250 /**
1251  * batadv_nc_path_search() - Find the coding path matching in_nc_node and
1252  *  out_nc_node to retrieve a buffered packet that can be used for coding.
1253  * @bat_priv: the bat priv with all the soft interface information
1254  * @in_nc_node: pointer to skb next hop's neighbor nc node
1255  * @out_nc_node: pointer to skb source's neighbor nc node
1256  * @skb: data skb to forward
1257  * @eth_dst: next hop mac address of skb
1258  *
1259  * Return: true if coding of a decoded skb is allowed.
1260  */
1261 static struct batadv_nc_packet *
1262 batadv_nc_path_search(struct batadv_priv *bat_priv,
1263 		      struct batadv_nc_node *in_nc_node,
1264 		      struct batadv_nc_node *out_nc_node,
1265 		      struct sk_buff *skb,
1266 		      u8 *eth_dst)
1267 {
1268 	struct batadv_nc_path *nc_path, nc_path_key;
1269 	struct batadv_nc_packet *nc_packet_out = NULL;
1270 	struct batadv_nc_packet *nc_packet, *nc_packet_tmp;
1271 	struct batadv_hashtable *hash = bat_priv->nc.coding_hash;
1272 	int idx;
1273 
1274 	if (!hash)
1275 		return NULL;
1276 
1277 	/* Create almost path key */
1278 	batadv_nc_hash_key_gen(&nc_path_key, in_nc_node->addr,
1279 			       out_nc_node->addr);
1280 	idx = batadv_nc_hash_choose(&nc_path_key, hash->size);
1281 
1282 	/* Check for coding opportunities in this nc_path */
1283 	rcu_read_lock();
1284 	hlist_for_each_entry_rcu(nc_path, &hash->table[idx], hash_entry) {
1285 		if (!batadv_compare_eth(nc_path->prev_hop, in_nc_node->addr))
1286 			continue;
1287 
1288 		if (!batadv_compare_eth(nc_path->next_hop, out_nc_node->addr))
1289 			continue;
1290 
1291 		spin_lock_bh(&nc_path->packet_list_lock);
1292 		if (list_empty(&nc_path->packet_list)) {
1293 			spin_unlock_bh(&nc_path->packet_list_lock);
1294 			continue;
1295 		}
1296 
1297 		list_for_each_entry_safe(nc_packet, nc_packet_tmp,
1298 					 &nc_path->packet_list, list) {
1299 			if (!batadv_nc_skb_coding_possible(nc_packet->skb,
1300 							   eth_dst,
1301 							   in_nc_node->addr))
1302 				continue;
1303 
1304 			/* Coding opportunity is found! */
1305 			list_del(&nc_packet->list);
1306 			nc_packet_out = nc_packet;
1307 			break;
1308 		}
1309 
1310 		spin_unlock_bh(&nc_path->packet_list_lock);
1311 		break;
1312 	}
1313 	rcu_read_unlock();
1314 
1315 	return nc_packet_out;
1316 }
1317 
1318 /**
1319  * batadv_nc_skb_src_search() - Loops through the list of neighboring nodes of
1320  *  the skb's sender (may be equal to the originator).
1321  * @bat_priv: the bat priv with all the soft interface information
1322  * @skb: data skb to forward
1323  * @eth_dst: next hop mac address of skb
1324  * @eth_src: source mac address of skb
1325  * @in_nc_node: pointer to skb next hop's neighbor nc node
1326  *
1327  * Return: an nc packet if a suitable coding packet was found, NULL otherwise.
1328  */
1329 static struct batadv_nc_packet *
1330 batadv_nc_skb_src_search(struct batadv_priv *bat_priv,
1331 			 struct sk_buff *skb,
1332 			 u8 *eth_dst,
1333 			 u8 *eth_src,
1334 			 struct batadv_nc_node *in_nc_node)
1335 {
1336 	struct batadv_orig_node *orig_node;
1337 	struct batadv_nc_node *out_nc_node;
1338 	struct batadv_nc_packet *nc_packet = NULL;
1339 
1340 	orig_node = batadv_orig_hash_find(bat_priv, eth_src);
1341 	if (!orig_node)
1342 		return NULL;
1343 
1344 	rcu_read_lock();
1345 	list_for_each_entry_rcu(out_nc_node,
1346 				&orig_node->out_coding_list, list) {
1347 		/* Check if the skb is decoded and if recoding is possible */
1348 		if (!batadv_nc_skb_coding_possible(skb,
1349 						   out_nc_node->addr, eth_src))
1350 			continue;
1351 
1352 		/* Search for an opportunity in this nc_path */
1353 		nc_packet = batadv_nc_path_search(bat_priv, in_nc_node,
1354 						  out_nc_node, skb, eth_dst);
1355 		if (nc_packet)
1356 			break;
1357 	}
1358 	rcu_read_unlock();
1359 
1360 	batadv_orig_node_put(orig_node);
1361 	return nc_packet;
1362 }
1363 
1364 /**
1365  * batadv_nc_skb_store_before_coding() - set the ethernet src and dst of the
1366  *  unicast skb before it is stored for use in later decoding
1367  * @bat_priv: the bat priv with all the soft interface information
1368  * @skb: data skb to store
1369  * @eth_dst_new: new destination mac address of skb
1370  */
1371 static void batadv_nc_skb_store_before_coding(struct batadv_priv *bat_priv,
1372 					      struct sk_buff *skb,
1373 					      u8 *eth_dst_new)
1374 {
1375 	struct ethhdr *ethhdr;
1376 
1377 	/* Copy skb header to change the mac header */
1378 	skb = pskb_copy_for_clone(skb, GFP_ATOMIC);
1379 	if (!skb)
1380 		return;
1381 
1382 	/* Set the mac header as if we actually sent the packet uncoded */
1383 	ethhdr = eth_hdr(skb);
1384 	ether_addr_copy(ethhdr->h_source, ethhdr->h_dest);
1385 	ether_addr_copy(ethhdr->h_dest, eth_dst_new);
1386 
1387 	/* Set data pointer to MAC header to mimic packets from our tx path */
1388 	skb_push(skb, ETH_HLEN);
1389 
1390 	/* Add the packet to the decoding packet pool */
1391 	batadv_nc_skb_store_for_decoding(bat_priv, skb);
1392 
1393 	/* batadv_nc_skb_store_for_decoding() clones the skb, so we must free
1394 	 * our ref
1395 	 */
1396 	consume_skb(skb);
1397 }
1398 
1399 /**
1400  * batadv_nc_skb_dst_search() - Loops through list of neighboring nodes to dst.
1401  * @skb: data skb to forward
1402  * @neigh_node: next hop to forward packet to
1403  * @ethhdr: pointer to the ethernet header inside the skb
1404  *
1405  * Loops through the list of neighboring nodes the next hop has a good
1406  * connection to (receives OGMs with a sufficient quality). We need to find a
1407  * neighbor of our next hop that potentially sent a packet which our next hop
1408  * also received (overheard) and has stored for later decoding.
1409  *
1410  * Return: true if the skb was consumed (encoded packet sent) or false otherwise
1411  */
1412 static bool batadv_nc_skb_dst_search(struct sk_buff *skb,
1413 				     struct batadv_neigh_node *neigh_node,
1414 				     struct ethhdr *ethhdr)
1415 {
1416 	struct net_device *netdev = neigh_node->if_incoming->soft_iface;
1417 	struct batadv_priv *bat_priv = netdev_priv(netdev);
1418 	struct batadv_orig_node *orig_node = neigh_node->orig_node;
1419 	struct batadv_nc_node *nc_node;
1420 	struct batadv_nc_packet *nc_packet = NULL;
1421 
1422 	rcu_read_lock();
1423 	list_for_each_entry_rcu(nc_node, &orig_node->in_coding_list, list) {
1424 		/* Search for coding opportunity with this in_nc_node */
1425 		nc_packet = batadv_nc_skb_src_search(bat_priv, skb,
1426 						     neigh_node->addr,
1427 						     ethhdr->h_source, nc_node);
1428 
1429 		/* Opportunity was found, so stop searching */
1430 		if (nc_packet)
1431 			break;
1432 	}
1433 	rcu_read_unlock();
1434 
1435 	if (!nc_packet)
1436 		return false;
1437 
1438 	/* Save packets for later decoding */
1439 	batadv_nc_skb_store_before_coding(bat_priv, skb,
1440 					  neigh_node->addr);
1441 	batadv_nc_skb_store_before_coding(bat_priv, nc_packet->skb,
1442 					  nc_packet->neigh_node->addr);
1443 
1444 	/* Code and send packets */
1445 	if (batadv_nc_code_packets(bat_priv, skb, ethhdr, nc_packet,
1446 				   neigh_node))
1447 		return true;
1448 
1449 	/* out of mem ? Coding failed - we have to free the buffered packet
1450 	 * to avoid memleaks. The skb passed as argument will be dealt with
1451 	 * by the calling function.
1452 	 */
1453 	batadv_nc_send_packet(nc_packet);
1454 	return false;
1455 }
1456 
1457 /**
1458  * batadv_nc_skb_add_to_path() - buffer skb for later encoding / decoding
1459  * @skb: skb to add to path
1460  * @nc_path: path to add skb to
1461  * @neigh_node: next hop to forward packet to
1462  * @packet_id: checksum to identify packet
1463  *
1464  * Return: true if the packet was buffered or false in case of an error.
1465  */
1466 static bool batadv_nc_skb_add_to_path(struct sk_buff *skb,
1467 				      struct batadv_nc_path *nc_path,
1468 				      struct batadv_neigh_node *neigh_node,
1469 				      __be32 packet_id)
1470 {
1471 	struct batadv_nc_packet *nc_packet;
1472 
1473 	nc_packet = kzalloc(sizeof(*nc_packet), GFP_ATOMIC);
1474 	if (!nc_packet)
1475 		return false;
1476 
1477 	/* Initialize nc_packet */
1478 	nc_packet->timestamp = jiffies;
1479 	nc_packet->packet_id = packet_id;
1480 	nc_packet->skb = skb;
1481 	nc_packet->neigh_node = neigh_node;
1482 	nc_packet->nc_path = nc_path;
1483 
1484 	/* Add coding packet to list */
1485 	spin_lock_bh(&nc_path->packet_list_lock);
1486 	list_add_tail(&nc_packet->list, &nc_path->packet_list);
1487 	spin_unlock_bh(&nc_path->packet_list_lock);
1488 
1489 	return true;
1490 }
1491 
1492 /**
1493  * batadv_nc_skb_forward() - try to code a packet or add it to the coding packet
1494  *  buffer
1495  * @skb: data skb to forward
1496  * @neigh_node: next hop to forward packet to
1497  *
1498  * Return: true if the skb was consumed (encoded packet sent) or false otherwise
1499  */
1500 bool batadv_nc_skb_forward(struct sk_buff *skb,
1501 			   struct batadv_neigh_node *neigh_node)
1502 {
1503 	const struct net_device *netdev = neigh_node->if_incoming->soft_iface;
1504 	struct batadv_priv *bat_priv = netdev_priv(netdev);
1505 	struct batadv_unicast_packet *packet;
1506 	struct batadv_nc_path *nc_path;
1507 	struct ethhdr *ethhdr = eth_hdr(skb);
1508 	__be32 packet_id;
1509 	u8 *payload;
1510 
1511 	/* Check if network coding is enabled */
1512 	if (!atomic_read(&bat_priv->network_coding))
1513 		goto out;
1514 
1515 	/* We only handle unicast packets */
1516 	payload = skb_network_header(skb);
1517 	packet = (struct batadv_unicast_packet *)payload;
1518 	if (packet->packet_type != BATADV_UNICAST)
1519 		goto out;
1520 
1521 	/* Try to find a coding opportunity and send the skb if one is found */
1522 	if (batadv_nc_skb_dst_search(skb, neigh_node, ethhdr))
1523 		return true;
1524 
1525 	/* Find or create a nc_path for this src-dst pair */
1526 	nc_path = batadv_nc_get_path(bat_priv,
1527 				     bat_priv->nc.coding_hash,
1528 				     ethhdr->h_source,
1529 				     neigh_node->addr);
1530 
1531 	if (!nc_path)
1532 		goto out;
1533 
1534 	/* Add skb to nc_path */
1535 	packet_id = batadv_skb_crc32(skb, payload + sizeof(*packet));
1536 	if (!batadv_nc_skb_add_to_path(skb, nc_path, neigh_node, packet_id))
1537 		goto free_nc_path;
1538 
1539 	/* Packet is consumed */
1540 	return true;
1541 
1542 free_nc_path:
1543 	batadv_nc_path_put(nc_path);
1544 out:
1545 	/* Packet is not consumed */
1546 	return false;
1547 }
1548 
1549 /**
1550  * batadv_nc_skb_store_for_decoding() - save a clone of the skb which can be
1551  *  used when decoding coded packets
1552  * @bat_priv: the bat priv with all the soft interface information
1553  * @skb: data skb to store
1554  */
1555 void batadv_nc_skb_store_for_decoding(struct batadv_priv *bat_priv,
1556 				      struct sk_buff *skb)
1557 {
1558 	struct batadv_unicast_packet *packet;
1559 	struct batadv_nc_path *nc_path;
1560 	struct ethhdr *ethhdr = eth_hdr(skb);
1561 	__be32 packet_id;
1562 	u8 *payload;
1563 
1564 	/* Check if network coding is enabled */
1565 	if (!atomic_read(&bat_priv->network_coding))
1566 		goto out;
1567 
1568 	/* Check for supported packet type */
1569 	payload = skb_network_header(skb);
1570 	packet = (struct batadv_unicast_packet *)payload;
1571 	if (packet->packet_type != BATADV_UNICAST)
1572 		goto out;
1573 
1574 	/* Find existing nc_path or create a new */
1575 	nc_path = batadv_nc_get_path(bat_priv,
1576 				     bat_priv->nc.decoding_hash,
1577 				     ethhdr->h_source,
1578 				     ethhdr->h_dest);
1579 
1580 	if (!nc_path)
1581 		goto out;
1582 
1583 	/* Clone skb and adjust skb->data to point at batman header */
1584 	skb = skb_clone(skb, GFP_ATOMIC);
1585 	if (unlikely(!skb))
1586 		goto free_nc_path;
1587 
1588 	if (unlikely(!pskb_may_pull(skb, ETH_HLEN)))
1589 		goto free_skb;
1590 
1591 	if (unlikely(!skb_pull_rcsum(skb, ETH_HLEN)))
1592 		goto free_skb;
1593 
1594 	/* Add skb to nc_path */
1595 	packet_id = batadv_skb_crc32(skb, payload + sizeof(*packet));
1596 	if (!batadv_nc_skb_add_to_path(skb, nc_path, NULL, packet_id))
1597 		goto free_skb;
1598 
1599 	batadv_inc_counter(bat_priv, BATADV_CNT_NC_BUFFER);
1600 	return;
1601 
1602 free_skb:
1603 	kfree_skb(skb);
1604 free_nc_path:
1605 	batadv_nc_path_put(nc_path);
1606 out:
1607 	return;
1608 }
1609 
1610 /**
1611  * batadv_nc_skb_store_sniffed_unicast() - check if a received unicast packet
1612  *  should be saved in the decoding buffer and, if so, store it there
1613  * @bat_priv: the bat priv with all the soft interface information
1614  * @skb: unicast skb to store
1615  */
1616 void batadv_nc_skb_store_sniffed_unicast(struct batadv_priv *bat_priv,
1617 					 struct sk_buff *skb)
1618 {
1619 	struct ethhdr *ethhdr = eth_hdr(skb);
1620 
1621 	if (batadv_is_my_mac(bat_priv, ethhdr->h_dest))
1622 		return;
1623 
1624 	/* Set data pointer to MAC header to mimic packets from our tx path */
1625 	skb_push(skb, ETH_HLEN);
1626 
1627 	batadv_nc_skb_store_for_decoding(bat_priv, skb);
1628 }
1629 
1630 /**
1631  * batadv_nc_skb_decode_packet() - decode given skb using the decode data stored
1632  *  in nc_packet
1633  * @bat_priv: the bat priv with all the soft interface information
1634  * @skb: unicast skb to decode
1635  * @nc_packet: decode data needed to decode the skb
1636  *
1637  * Return: pointer to decoded unicast packet if the packet was decoded or NULL
1638  * in case of an error.
1639  */
1640 static struct batadv_unicast_packet *
1641 batadv_nc_skb_decode_packet(struct batadv_priv *bat_priv, struct sk_buff *skb,
1642 			    struct batadv_nc_packet *nc_packet)
1643 {
1644 	const int h_size = sizeof(struct batadv_unicast_packet);
1645 	const int h_diff = sizeof(struct batadv_coded_packet) - h_size;
1646 	struct batadv_unicast_packet *unicast_packet;
1647 	struct batadv_coded_packet coded_packet_tmp;
1648 	struct ethhdr *ethhdr, ethhdr_tmp;
1649 	u8 *orig_dest, ttl, ttvn;
1650 	unsigned int coding_len;
1651 	int err;
1652 
1653 	/* Save headers temporarily */
1654 	memcpy(&coded_packet_tmp, skb->data, sizeof(coded_packet_tmp));
1655 	memcpy(&ethhdr_tmp, skb_mac_header(skb), sizeof(ethhdr_tmp));
1656 
1657 	if (skb_cow(skb, 0) < 0)
1658 		return NULL;
1659 
1660 	if (unlikely(!skb_pull_rcsum(skb, h_diff)))
1661 		return NULL;
1662 
1663 	/* Data points to batman header, so set mac header 14 bytes before
1664 	 * and network to data
1665 	 */
1666 	skb_set_mac_header(skb, -ETH_HLEN);
1667 	skb_reset_network_header(skb);
1668 
1669 	/* Reconstruct original mac header */
1670 	ethhdr = eth_hdr(skb);
1671 	*ethhdr = ethhdr_tmp;
1672 
1673 	/* Select the correct unicast header information based on the location
1674 	 * of our mac address in the coded_packet header
1675 	 */
1676 	if (batadv_is_my_mac(bat_priv, coded_packet_tmp.second_dest)) {
1677 		/* If we are the second destination the packet was overheard,
1678 		 * so the Ethernet address must be copied to h_dest and
1679 		 * pkt_type changed from PACKET_OTHERHOST to PACKET_HOST
1680 		 */
1681 		ether_addr_copy(ethhdr->h_dest, coded_packet_tmp.second_dest);
1682 		skb->pkt_type = PACKET_HOST;
1683 
1684 		orig_dest = coded_packet_tmp.second_orig_dest;
1685 		ttl = coded_packet_tmp.second_ttl;
1686 		ttvn = coded_packet_tmp.second_ttvn;
1687 	} else {
1688 		orig_dest = coded_packet_tmp.first_orig_dest;
1689 		ttl = coded_packet_tmp.ttl;
1690 		ttvn = coded_packet_tmp.first_ttvn;
1691 	}
1692 
1693 	coding_len = ntohs(coded_packet_tmp.coded_len);
1694 
1695 	if (coding_len > skb->len)
1696 		return NULL;
1697 
1698 	/* Here the magic is reversed:
1699 	 *   extract the missing packet from the received coded packet
1700 	 */
1701 	batadv_nc_memxor(skb->data + h_size,
1702 			 nc_packet->skb->data + h_size,
1703 			 coding_len);
1704 
1705 	/* Resize decoded skb if decoded with larger packet */
1706 	if (nc_packet->skb->len > coding_len + h_size) {
1707 		err = pskb_trim_rcsum(skb, coding_len + h_size);
1708 		if (err)
1709 			return NULL;
1710 	}
1711 
1712 	/* Create decoded unicast packet */
1713 	unicast_packet = (struct batadv_unicast_packet *)skb->data;
1714 	unicast_packet->packet_type = BATADV_UNICAST;
1715 	unicast_packet->version = BATADV_COMPAT_VERSION;
1716 	unicast_packet->ttl = ttl;
1717 	ether_addr_copy(unicast_packet->dest, orig_dest);
1718 	unicast_packet->ttvn = ttvn;
1719 
1720 	batadv_nc_packet_free(nc_packet, false);
1721 	return unicast_packet;
1722 }
1723 
1724 /**
1725  * batadv_nc_find_decoding_packet() - search through buffered decoding data to
1726  *  find the data needed to decode the coded packet
1727  * @bat_priv: the bat priv with all the soft interface information
1728  * @ethhdr: pointer to the ethernet header inside the coded packet
1729  * @coded: coded packet we try to find decode data for
1730  *
1731  * Return: pointer to nc packet if the needed data was found or NULL otherwise.
1732  */
1733 static struct batadv_nc_packet *
1734 batadv_nc_find_decoding_packet(struct batadv_priv *bat_priv,
1735 			       struct ethhdr *ethhdr,
1736 			       struct batadv_coded_packet *coded)
1737 {
1738 	struct batadv_hashtable *hash = bat_priv->nc.decoding_hash;
1739 	struct batadv_nc_packet *tmp_nc_packet, *nc_packet = NULL;
1740 	struct batadv_nc_path *nc_path, nc_path_key;
1741 	u8 *dest, *source;
1742 	__be32 packet_id;
1743 	int index;
1744 
1745 	if (!hash)
1746 		return NULL;
1747 
1748 	/* Select the correct packet id based on the location of our mac-addr */
1749 	dest = ethhdr->h_source;
1750 	if (!batadv_is_my_mac(bat_priv, coded->second_dest)) {
1751 		source = coded->second_source;
1752 		packet_id = coded->second_crc;
1753 	} else {
1754 		source = coded->first_source;
1755 		packet_id = coded->first_crc;
1756 	}
1757 
1758 	batadv_nc_hash_key_gen(&nc_path_key, source, dest);
1759 	index = batadv_nc_hash_choose(&nc_path_key, hash->size);
1760 
1761 	/* Search for matching coding path */
1762 	rcu_read_lock();
1763 	hlist_for_each_entry_rcu(nc_path, &hash->table[index], hash_entry) {
1764 		/* Find matching nc_packet */
1765 		spin_lock_bh(&nc_path->packet_list_lock);
1766 		list_for_each_entry(tmp_nc_packet,
1767 				    &nc_path->packet_list, list) {
1768 			if (packet_id == tmp_nc_packet->packet_id) {
1769 				list_del(&tmp_nc_packet->list);
1770 
1771 				nc_packet = tmp_nc_packet;
1772 				break;
1773 			}
1774 		}
1775 		spin_unlock_bh(&nc_path->packet_list_lock);
1776 
1777 		if (nc_packet)
1778 			break;
1779 	}
1780 	rcu_read_unlock();
1781 
1782 	if (!nc_packet)
1783 		batadv_dbg(BATADV_DBG_NC, bat_priv,
1784 			   "No decoding packet found for %u\n", packet_id);
1785 
1786 	return nc_packet;
1787 }
1788 
1789 /**
1790  * batadv_nc_recv_coded_packet() - try to decode coded packet and enqueue the
1791  *  resulting unicast packet
1792  * @skb: incoming coded packet
1793  * @recv_if: pointer to interface this packet was received on
1794  *
1795  * Return: NET_RX_SUCCESS if the packet has been consumed or NET_RX_DROP
1796  * otherwise.
1797  */
1798 static int batadv_nc_recv_coded_packet(struct sk_buff *skb,
1799 				       struct batadv_hard_iface *recv_if)
1800 {
1801 	struct batadv_priv *bat_priv = netdev_priv(recv_if->soft_iface);
1802 	struct batadv_unicast_packet *unicast_packet;
1803 	struct batadv_coded_packet *coded_packet;
1804 	struct batadv_nc_packet *nc_packet;
1805 	struct ethhdr *ethhdr;
1806 	int hdr_size = sizeof(*coded_packet);
1807 
1808 	/* Check if network coding is enabled */
1809 	if (!atomic_read(&bat_priv->network_coding))
1810 		goto free_skb;
1811 
1812 	/* Make sure we can access (and remove) header */
1813 	if (unlikely(!pskb_may_pull(skb, hdr_size)))
1814 		goto free_skb;
1815 
1816 	coded_packet = (struct batadv_coded_packet *)skb->data;
1817 	ethhdr = eth_hdr(skb);
1818 
1819 	/* Verify frame is destined for us */
1820 	if (!batadv_is_my_mac(bat_priv, ethhdr->h_dest) &&
1821 	    !batadv_is_my_mac(bat_priv, coded_packet->second_dest))
1822 		goto free_skb;
1823 
1824 	/* Update stat counter */
1825 	if (batadv_is_my_mac(bat_priv, coded_packet->second_dest))
1826 		batadv_inc_counter(bat_priv, BATADV_CNT_NC_SNIFFED);
1827 
1828 	nc_packet = batadv_nc_find_decoding_packet(bat_priv, ethhdr,
1829 						   coded_packet);
1830 	if (!nc_packet) {
1831 		batadv_inc_counter(bat_priv, BATADV_CNT_NC_DECODE_FAILED);
1832 		goto free_skb;
1833 	}
1834 
1835 	/* Make skb's linear, because decoding accesses the entire buffer */
1836 	if (skb_linearize(skb) < 0)
1837 		goto free_nc_packet;
1838 
1839 	if (skb_linearize(nc_packet->skb) < 0)
1840 		goto free_nc_packet;
1841 
1842 	/* Decode the packet */
1843 	unicast_packet = batadv_nc_skb_decode_packet(bat_priv, skb, nc_packet);
1844 	if (!unicast_packet) {
1845 		batadv_inc_counter(bat_priv, BATADV_CNT_NC_DECODE_FAILED);
1846 		goto free_nc_packet;
1847 	}
1848 
1849 	/* Mark packet as decoded to do correct recoding when forwarding */
1850 	BATADV_SKB_CB(skb)->decoded = true;
1851 	batadv_inc_counter(bat_priv, BATADV_CNT_NC_DECODE);
1852 	batadv_add_counter(bat_priv, BATADV_CNT_NC_DECODE_BYTES,
1853 			   skb->len + ETH_HLEN);
1854 	return batadv_recv_unicast_packet(skb, recv_if);
1855 
1856 free_nc_packet:
1857 	batadv_nc_packet_free(nc_packet, true);
1858 free_skb:
1859 	kfree_skb(skb);
1860 
1861 	return NET_RX_DROP;
1862 }
1863 
1864 /**
1865  * batadv_nc_mesh_free() - clean up network coding memory
1866  * @bat_priv: the bat priv with all the soft interface information
1867  */
1868 void batadv_nc_mesh_free(struct batadv_priv *bat_priv)
1869 {
1870 	batadv_tvlv_container_unregister(bat_priv, BATADV_TVLV_NC, 1);
1871 	batadv_tvlv_handler_unregister(bat_priv, BATADV_TVLV_NC, 1);
1872 	cancel_delayed_work_sync(&bat_priv->nc.work);
1873 
1874 	batadv_nc_purge_paths(bat_priv, bat_priv->nc.coding_hash, NULL);
1875 	batadv_hash_destroy(bat_priv->nc.coding_hash);
1876 	batadv_nc_purge_paths(bat_priv, bat_priv->nc.decoding_hash, NULL);
1877 	batadv_hash_destroy(bat_priv->nc.decoding_hash);
1878 }
1879 
1880 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
1881 /**
1882  * batadv_nc_nodes_seq_print_text() - print the nc node information
1883  * @seq: seq file to print on
1884  * @offset: not used
1885  *
1886  * Return: always 0
1887  */
1888 int batadv_nc_nodes_seq_print_text(struct seq_file *seq, void *offset)
1889 {
1890 	struct net_device *net_dev = (struct net_device *)seq->private;
1891 	struct batadv_priv *bat_priv = netdev_priv(net_dev);
1892 	struct batadv_hashtable *hash = bat_priv->orig_hash;
1893 	struct batadv_hard_iface *primary_if;
1894 	struct hlist_head *head;
1895 	struct batadv_orig_node *orig_node;
1896 	struct batadv_nc_node *nc_node;
1897 	int i;
1898 
1899 	primary_if = batadv_seq_print_text_primary_if_get(seq);
1900 	if (!primary_if)
1901 		goto out;
1902 
1903 	/* Traverse list of originators */
1904 	for (i = 0; i < hash->size; i++) {
1905 		head = &hash->table[i];
1906 
1907 		/* For each orig_node in this bin */
1908 		rcu_read_lock();
1909 		hlist_for_each_entry_rcu(orig_node, head, hash_entry) {
1910 			/* no need to print the orig node if it does not have
1911 			 * network coding neighbors
1912 			 */
1913 			if (list_empty(&orig_node->in_coding_list) &&
1914 			    list_empty(&orig_node->out_coding_list))
1915 				continue;
1916 
1917 			seq_printf(seq, "Node:      %pM\n", orig_node->orig);
1918 
1919 			seq_puts(seq, " Ingoing:  ");
1920 			/* For each in_nc_node to this orig_node */
1921 			list_for_each_entry_rcu(nc_node,
1922 						&orig_node->in_coding_list,
1923 						list)
1924 				seq_printf(seq, "%pM ",
1925 					   nc_node->addr);
1926 			seq_puts(seq, "\n Outgoing: ");
1927 			/* For out_nc_node to this orig_node */
1928 			list_for_each_entry_rcu(nc_node,
1929 						&orig_node->out_coding_list,
1930 						list)
1931 				seq_printf(seq, "%pM ",
1932 					   nc_node->addr);
1933 			seq_puts(seq, "\n\n");
1934 		}
1935 		rcu_read_unlock();
1936 	}
1937 
1938 out:
1939 	if (primary_if)
1940 		batadv_hardif_put(primary_if);
1941 	return 0;
1942 }
1943 
1944 /**
1945  * batadv_nc_init_debugfs() - create nc folder and related files in debugfs
1946  * @bat_priv: the bat priv with all the soft interface information
1947  */
1948 void batadv_nc_init_debugfs(struct batadv_priv *bat_priv)
1949 {
1950 	struct dentry *nc_dir;
1951 
1952 	nc_dir = debugfs_create_dir("nc", bat_priv->debug_dir);
1953 
1954 	debugfs_create_u8("min_tq", 0644, nc_dir, &bat_priv->nc.min_tq);
1955 
1956 	debugfs_create_u32("max_fwd_delay", 0644, nc_dir,
1957 			   &bat_priv->nc.max_fwd_delay);
1958 
1959 	debugfs_create_u32("max_buffer_time", 0644, nc_dir,
1960 			   &bat_priv->nc.max_buffer_time);
1961 }
1962 #endif
1963