1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright (C) 2007-2019  B.A.T.M.A.N. contributors:
3  *
4  * Marek Lindner, Simon Wunderlich
5  */
6 
7 #ifndef _NET_BATMAN_ADV_TYPES_H_
8 #define _NET_BATMAN_ADV_TYPES_H_
9 
10 #ifndef _NET_BATMAN_ADV_MAIN_H_
11 #error only "main.h" can be included directly
12 #endif
13 
14 #include <linux/average.h>
15 #include <linux/bitops.h>
16 #include <linux/compiler.h>
17 #include <linux/if.h>
18 #include <linux/if_ether.h>
19 #include <linux/kref.h>
20 #include <linux/mutex.h>
21 #include <linux/netdevice.h>
22 #include <linux/netlink.h>
23 #include <linux/sched.h> /* for linux/wait.h */
24 #include <linux/seq_file.h>
25 #include <linux/skbuff.h>
26 #include <linux/spinlock.h>
27 #include <linux/timer.h>
28 #include <linux/types.h>
29 #include <linux/wait.h>
30 #include <linux/workqueue.h>
31 #include <uapi/linux/batadv_packet.h>
32 #include <uapi/linux/batman_adv.h>
33 
34 #ifdef CONFIG_BATMAN_ADV_DAT
35 
36 /**
37  * typedef batadv_dat_addr_t - type used for all DHT addresses
38  *
39  * If it is changed, BATADV_DAT_ADDR_MAX is changed as well.
40  *
41  * *Please be careful: batadv_dat_addr_t must be UNSIGNED*
42  */
43 typedef u16 batadv_dat_addr_t;
44 
45 #endif /* CONFIG_BATMAN_ADV_DAT */
46 
47 /**
48  * enum batadv_dhcp_recipient - dhcp destination
49  */
50 enum batadv_dhcp_recipient {
51 	/** @BATADV_DHCP_NO: packet is not a dhcp message */
52 	BATADV_DHCP_NO = 0,
53 
54 	/** @BATADV_DHCP_TO_SERVER: dhcp message is directed to a server */
55 	BATADV_DHCP_TO_SERVER,
56 
57 	/** @BATADV_DHCP_TO_CLIENT: dhcp message is directed to a client */
58 	BATADV_DHCP_TO_CLIENT,
59 };
60 
61 /**
62  * BATADV_TT_REMOTE_MASK - bitmask selecting the flags that are sent over the
63  *  wire only
64  */
65 #define BATADV_TT_REMOTE_MASK	0x00FF
66 
67 /**
68  * BATADV_TT_SYNC_MASK - bitmask of the flags that need to be kept in sync
69  *  among the nodes. These flags are used to compute the global/local CRC
70  */
71 #define BATADV_TT_SYNC_MASK	0x00F0
72 
73 /**
74  * struct batadv_hard_iface_bat_iv - per hard-interface B.A.T.M.A.N. IV data
75  */
76 struct batadv_hard_iface_bat_iv {
77 	/** @ogm_buff: buffer holding the OGM packet */
78 	unsigned char *ogm_buff;
79 
80 	/** @ogm_buff_len: length of the OGM packet buffer */
81 	int ogm_buff_len;
82 
83 	/** @ogm_seqno: OGM sequence number - used to identify each OGM */
84 	atomic_t ogm_seqno;
85 
86 	/** @ogm_buff_mutex: lock protecting ogm_buff and ogm_buff_len */
87 	struct mutex ogm_buff_mutex;
88 };
89 
90 /**
91  * enum batadv_v_hard_iface_flags - interface flags useful to B.A.T.M.A.N. V
92  */
93 enum batadv_v_hard_iface_flags {
94 	/**
95 	 * @BATADV_FULL_DUPLEX: tells if the connection over this link is
96 	 *  full-duplex
97 	 */
98 	BATADV_FULL_DUPLEX	= BIT(0),
99 
100 	/**
101 	 * @BATADV_WARNING_DEFAULT: tells whether we have warned the user that
102 	 *  no throughput data is available for this interface and that default
103 	 *  values are assumed.
104 	 */
105 	BATADV_WARNING_DEFAULT	= BIT(1),
106 };
107 
108 /**
109  * struct batadv_hard_iface_bat_v - per hard-interface B.A.T.M.A.N. V data
110  */
111 struct batadv_hard_iface_bat_v {
112 	/** @elp_interval: time interval between two ELP transmissions */
113 	atomic_t elp_interval;
114 
115 	/** @elp_seqno: current ELP sequence number */
116 	atomic_t elp_seqno;
117 
118 	/** @elp_skb: base skb containing the ELP message to send */
119 	struct sk_buff *elp_skb;
120 
121 	/** @elp_wq: workqueue used to schedule ELP transmissions */
122 	struct delayed_work elp_wq;
123 
124 	/** @aggr_wq: workqueue used to transmit queued OGM packets */
125 	struct delayed_work aggr_wq;
126 
127 	/** @aggr_list: queue for to be aggregated OGM packets */
128 	struct sk_buff_head aggr_list;
129 
130 	/** @aggr_len: size of the OGM aggregate (excluding ethernet header) */
131 	unsigned int aggr_len;
132 
133 	/** @aggr_list_lock: protects aggr_list */
134 	spinlock_t aggr_list_lock;
135 
136 	/**
137 	 * @throughput_override: throughput override to disable link
138 	 *  auto-detection
139 	 */
140 	atomic_t throughput_override;
141 
142 	/** @flags: interface specific flags */
143 	u8 flags;
144 };
145 
146 /**
147  * enum batadv_hard_iface_wifi_flags - Flags describing the wifi configuration
148  *  of a batadv_hard_iface
149  */
150 enum batadv_hard_iface_wifi_flags {
151 	/** @BATADV_HARDIF_WIFI_WEXT_DIRECT: it is a wext wifi device */
152 	BATADV_HARDIF_WIFI_WEXT_DIRECT = BIT(0),
153 
154 	/** @BATADV_HARDIF_WIFI_CFG80211_DIRECT: it is a cfg80211 wifi device */
155 	BATADV_HARDIF_WIFI_CFG80211_DIRECT = BIT(1),
156 
157 	/**
158 	 * @BATADV_HARDIF_WIFI_WEXT_INDIRECT: link device is a wext wifi device
159 	 */
160 	BATADV_HARDIF_WIFI_WEXT_INDIRECT = BIT(2),
161 
162 	/**
163 	 * @BATADV_HARDIF_WIFI_CFG80211_INDIRECT: link device is a cfg80211 wifi
164 	 * device
165 	 */
166 	BATADV_HARDIF_WIFI_CFG80211_INDIRECT = BIT(3),
167 };
168 
169 /**
170  * struct batadv_hard_iface - network device known to batman-adv
171  */
172 struct batadv_hard_iface {
173 	/** @list: list node for batadv_hardif_list */
174 	struct list_head list;
175 
176 	/** @if_status: status of the interface for batman-adv */
177 	char if_status;
178 
179 	/**
180 	 * @num_bcasts: number of payload re-broadcasts on this interface (ARQ)
181 	 */
182 	u8 num_bcasts;
183 
184 	/**
185 	 * @wifi_flags: flags whether this is (directly or indirectly) a wifi
186 	 *  interface
187 	 */
188 	u32 wifi_flags;
189 
190 	/** @net_dev: pointer to the net_device */
191 	struct net_device *net_dev;
192 
193 	/** @hardif_obj: kobject of the per interface sysfs "mesh" directory */
194 	struct kobject *hardif_obj;
195 
196 	/** @refcount: number of contexts the object is used */
197 	struct kref refcount;
198 
199 	/**
200 	 * @batman_adv_ptype: packet type describing packets that should be
201 	 * processed by batman-adv for this interface
202 	 */
203 	struct packet_type batman_adv_ptype;
204 
205 	/**
206 	 * @soft_iface: the batman-adv interface which uses this network
207 	 *  interface
208 	 */
209 	struct net_device *soft_iface;
210 
211 	/** @rcu: struct used for freeing in an RCU-safe manner */
212 	struct rcu_head rcu;
213 
214 	/** @bat_iv: per hard-interface B.A.T.M.A.N. IV data */
215 	struct batadv_hard_iface_bat_iv bat_iv;
216 
217 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
218 	/** @bat_v: per hard-interface B.A.T.M.A.N. V data */
219 	struct batadv_hard_iface_bat_v bat_v;
220 #endif
221 
222 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
223 	/**
224 	 * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
225 	 */
226 	struct dentry *debug_dir;
227 #endif
228 
229 	/**
230 	 * @neigh_list: list of unique single hop neighbors via this interface
231 	 */
232 	struct hlist_head neigh_list;
233 
234 	/** @neigh_list_lock: lock protecting neigh_list */
235 	spinlock_t neigh_list_lock;
236 };
237 
238 /**
239  * struct batadv_orig_ifinfo - B.A.T.M.A.N. IV private orig_ifinfo members
240  */
241 struct batadv_orig_ifinfo_bat_iv {
242 	/**
243 	 * @bcast_own: bitfield which counts the number of our OGMs this
244 	 * orig_node rebroadcasted "back" to us  (relative to last_real_seqno)
245 	 */
246 	DECLARE_BITMAP(bcast_own, BATADV_TQ_LOCAL_WINDOW_SIZE);
247 
248 	/** @bcast_own_sum: sum of bcast_own */
249 	u8 bcast_own_sum;
250 };
251 
252 /**
253  * struct batadv_orig_ifinfo - originator info per outgoing interface
254  */
255 struct batadv_orig_ifinfo {
256 	/** @list: list node for &batadv_orig_node.ifinfo_list */
257 	struct hlist_node list;
258 
259 	/** @if_outgoing: pointer to outgoing hard-interface */
260 	struct batadv_hard_iface *if_outgoing;
261 
262 	/** @router: router that should be used to reach this originator */
263 	struct batadv_neigh_node __rcu *router;
264 
265 	/** @last_real_seqno: last and best known sequence number */
266 	u32 last_real_seqno;
267 
268 	/** @last_ttl: ttl of last received packet */
269 	u8 last_ttl;
270 
271 	/** @last_seqno_forwarded: seqno of the OGM which was forwarded last */
272 	u32 last_seqno_forwarded;
273 
274 	/** @batman_seqno_reset: time when the batman seqno window was reset */
275 	unsigned long batman_seqno_reset;
276 
277 	/** @bat_iv: B.A.T.M.A.N. IV private structure */
278 	struct batadv_orig_ifinfo_bat_iv bat_iv;
279 
280 	/** @refcount: number of contexts the object is used */
281 	struct kref refcount;
282 
283 	/** @rcu: struct used for freeing in an RCU-safe manner */
284 	struct rcu_head rcu;
285 };
286 
287 /**
288  * struct batadv_frag_table_entry - head in the fragment buffer table
289  */
290 struct batadv_frag_table_entry {
291 	/** @fragment_list: head of list with fragments */
292 	struct hlist_head fragment_list;
293 
294 	/** @lock: lock to protect the list of fragments */
295 	spinlock_t lock;
296 
297 	/** @timestamp: time (jiffie) of last received fragment */
298 	unsigned long timestamp;
299 
300 	/** @seqno: sequence number of the fragments in the list */
301 	u16 seqno;
302 
303 	/** @size: accumulated size of packets in list */
304 	u16 size;
305 
306 	/** @total_size: expected size of the assembled packet */
307 	u16 total_size;
308 };
309 
310 /**
311  * struct batadv_frag_list_entry - entry in a list of fragments
312  */
313 struct batadv_frag_list_entry {
314 	/** @list: list node information */
315 	struct hlist_node list;
316 
317 	/** @skb: fragment */
318 	struct sk_buff *skb;
319 
320 	/** @no: fragment number in the set */
321 	u8 no;
322 };
323 
324 /**
325  * struct batadv_vlan_tt - VLAN specific TT attributes
326  */
327 struct batadv_vlan_tt {
328 	/** @crc: CRC32 checksum of the entries belonging to this vlan */
329 	u32 crc;
330 
331 	/** @num_entries: number of TT entries for this VLAN */
332 	atomic_t num_entries;
333 };
334 
335 /**
336  * struct batadv_orig_node_vlan - VLAN specific data per orig_node
337  */
338 struct batadv_orig_node_vlan {
339 	/** @vid: the VLAN identifier */
340 	unsigned short vid;
341 
342 	/** @tt: VLAN specific TT attributes */
343 	struct batadv_vlan_tt tt;
344 
345 	/** @list: list node for &batadv_orig_node.vlan_list */
346 	struct hlist_node list;
347 
348 	/**
349 	 * @refcount: number of context where this object is currently in use
350 	 */
351 	struct kref refcount;
352 
353 	/** @rcu: struct used for freeing in a RCU-safe manner */
354 	struct rcu_head rcu;
355 };
356 
357 /**
358  * struct batadv_orig_bat_iv - B.A.T.M.A.N. IV private orig_node members
359  */
360 struct batadv_orig_bat_iv {
361 	/**
362 	 * @ogm_cnt_lock: lock protecting &batadv_orig_ifinfo_bat_iv.bcast_own,
363 	 * &batadv_orig_ifinfo_bat_iv.bcast_own_sum,
364 	 * &batadv_neigh_ifinfo_bat_iv.bat_iv.real_bits and
365 	 * &batadv_neigh_ifinfo_bat_iv.real_packet_count
366 	 */
367 	spinlock_t ogm_cnt_lock;
368 };
369 
370 /**
371  * struct batadv_orig_node - structure for orig_list maintaining nodes of mesh
372  */
373 struct batadv_orig_node {
374 	/** @orig: originator ethernet address */
375 	u8 orig[ETH_ALEN];
376 
377 	/** @ifinfo_list: list for routers per outgoing interface */
378 	struct hlist_head ifinfo_list;
379 
380 	/**
381 	 * @last_bonding_candidate: pointer to last ifinfo of last used router
382 	 */
383 	struct batadv_orig_ifinfo *last_bonding_candidate;
384 
385 #ifdef CONFIG_BATMAN_ADV_DAT
386 	/** @dat_addr: address of the orig node in the distributed hash */
387 	batadv_dat_addr_t dat_addr;
388 #endif
389 
390 	/** @last_seen: time when last packet from this node was received */
391 	unsigned long last_seen;
392 
393 	/**
394 	 * @bcast_seqno_reset: time when the broadcast seqno window was reset
395 	 */
396 	unsigned long bcast_seqno_reset;
397 
398 #ifdef CONFIG_BATMAN_ADV_MCAST
399 	/**
400 	 * @mcast_handler_lock: synchronizes mcast-capability and -flag changes
401 	 */
402 	spinlock_t mcast_handler_lock;
403 
404 	/** @mcast_flags: multicast flags announced by the orig node */
405 	u8 mcast_flags;
406 
407 	/**
408 	 * @mcast_want_all_unsnoopables_node: a list node for the
409 	 *  mcast.want_all_unsnoopables list
410 	 */
411 	struct hlist_node mcast_want_all_unsnoopables_node;
412 
413 	/**
414 	 * @mcast_want_all_ipv4_node: a list node for the mcast.want_all_ipv4
415 	 *  list
416 	 */
417 	struct hlist_node mcast_want_all_ipv4_node;
418 	/**
419 	 * @mcast_want_all_ipv6_node: a list node for the mcast.want_all_ipv6
420 	 *  list
421 	 */
422 	struct hlist_node mcast_want_all_ipv6_node;
423 
424 	/**
425 	 * @mcast_want_all_rtr4_node: a list node for the mcast.want_all_rtr4
426 	 *  list
427 	 */
428 	struct hlist_node mcast_want_all_rtr4_node;
429 	/**
430 	 * @mcast_want_all_rtr6_node: a list node for the mcast.want_all_rtr6
431 	 *  list
432 	 */
433 	struct hlist_node mcast_want_all_rtr6_node;
434 #endif
435 
436 	/** @capabilities: announced capabilities of this originator */
437 	unsigned long capabilities;
438 
439 	/**
440 	 * @capa_initialized: bitfield to remember whether a capability was
441 	 *  initialized
442 	 */
443 	unsigned long capa_initialized;
444 
445 	/** @last_ttvn: last seen translation table version number */
446 	atomic_t last_ttvn;
447 
448 	/** @tt_buff: last tt changeset this node received from the orig node */
449 	unsigned char *tt_buff;
450 
451 	/**
452 	 * @tt_buff_len: length of the last tt changeset this node received
453 	 *  from the orig node
454 	 */
455 	s16 tt_buff_len;
456 
457 	/** @tt_buff_lock: lock that protects tt_buff and tt_buff_len */
458 	spinlock_t tt_buff_lock;
459 
460 	/**
461 	 * @tt_lock: prevents from updating the table while reading it. Table
462 	 *  update is made up by two operations (data structure update and
463 	 *  metdata -CRC/TTVN-recalculation) and they have to be executed
464 	 *  atomically in order to avoid another thread to read the
465 	 *  table/metadata between those.
466 	 */
467 	spinlock_t tt_lock;
468 
469 	/**
470 	 * @bcast_bits: bitfield containing the info which payload broadcast
471 	 *  originated from this orig node this host already has seen (relative
472 	 *  to last_bcast_seqno)
473 	 */
474 	DECLARE_BITMAP(bcast_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
475 
476 	/**
477 	 * @last_bcast_seqno: last broadcast sequence number received by this
478 	 *  host
479 	 */
480 	u32 last_bcast_seqno;
481 
482 	/**
483 	 * @neigh_list: list of potential next hop neighbor towards this orig
484 	 *  node
485 	 */
486 	struct hlist_head neigh_list;
487 
488 	/**
489 	 * @neigh_list_lock: lock protecting neigh_list, ifinfo_list,
490 	 *  last_bonding_candidate and router
491 	 */
492 	spinlock_t neigh_list_lock;
493 
494 	/** @hash_entry: hlist node for &batadv_priv.orig_hash */
495 	struct hlist_node hash_entry;
496 
497 	/** @bat_priv: pointer to soft_iface this orig node belongs to */
498 	struct batadv_priv *bat_priv;
499 
500 	/** @bcast_seqno_lock: lock protecting bcast_bits & last_bcast_seqno */
501 	spinlock_t bcast_seqno_lock;
502 
503 	/** @refcount: number of contexts the object is used */
504 	struct kref refcount;
505 
506 	/** @rcu: struct used for freeing in an RCU-safe manner */
507 	struct rcu_head rcu;
508 
509 #ifdef CONFIG_BATMAN_ADV_NC
510 	/** @in_coding_list: list of nodes this orig can hear */
511 	struct list_head in_coding_list;
512 
513 	/** @out_coding_list: list of nodes that can hear this orig */
514 	struct list_head out_coding_list;
515 
516 	/** @in_coding_list_lock: protects in_coding_list */
517 	spinlock_t in_coding_list_lock;
518 
519 	/** @out_coding_list_lock: protects out_coding_list */
520 	spinlock_t out_coding_list_lock;
521 #endif
522 
523 	/** @fragments: array with heads for fragment chains */
524 	struct batadv_frag_table_entry fragments[BATADV_FRAG_BUFFER_COUNT];
525 
526 	/**
527 	 * @vlan_list: a list of orig_node_vlan structs, one per VLAN served by
528 	 *  the originator represented by this object
529 	 */
530 	struct hlist_head vlan_list;
531 
532 	/** @vlan_list_lock: lock protecting vlan_list */
533 	spinlock_t vlan_list_lock;
534 
535 	/** @bat_iv: B.A.T.M.A.N. IV private structure */
536 	struct batadv_orig_bat_iv bat_iv;
537 };
538 
539 /**
540  * enum batadv_orig_capabilities - orig node capabilities
541  */
542 enum batadv_orig_capabilities {
543 	/**
544 	 * @BATADV_ORIG_CAPA_HAS_DAT: orig node has distributed arp table
545 	 *  enabled
546 	 */
547 	BATADV_ORIG_CAPA_HAS_DAT,
548 
549 	/** @BATADV_ORIG_CAPA_HAS_NC: orig node has network coding enabled */
550 	BATADV_ORIG_CAPA_HAS_NC,
551 
552 	/** @BATADV_ORIG_CAPA_HAS_TT: orig node has tt capability */
553 	BATADV_ORIG_CAPA_HAS_TT,
554 
555 	/**
556 	 * @BATADV_ORIG_CAPA_HAS_MCAST: orig node has some multicast capability
557 	 *  (= orig node announces a tvlv of type BATADV_TVLV_MCAST)
558 	 */
559 	BATADV_ORIG_CAPA_HAS_MCAST,
560 };
561 
562 /**
563  * struct batadv_gw_node - structure for orig nodes announcing gw capabilities
564  */
565 struct batadv_gw_node {
566 	/** @list: list node for &batadv_priv_gw.list */
567 	struct hlist_node list;
568 
569 	/** @orig_node: pointer to corresponding orig node */
570 	struct batadv_orig_node *orig_node;
571 
572 	/** @bandwidth_down: advertised uplink download bandwidth */
573 	u32 bandwidth_down;
574 
575 	/** @bandwidth_up: advertised uplink upload bandwidth */
576 	u32 bandwidth_up;
577 
578 	/** @refcount: number of contexts the object is used */
579 	struct kref refcount;
580 
581 	/** @rcu: struct used for freeing in an RCU-safe manner */
582 	struct rcu_head rcu;
583 };
584 
585 DECLARE_EWMA(throughput, 10, 8)
586 
587 /**
588  * struct batadv_hardif_neigh_node_bat_v - B.A.T.M.A.N. V private neighbor
589  *  information
590  */
591 struct batadv_hardif_neigh_node_bat_v {
592 	/** @throughput: ewma link throughput towards this neighbor */
593 	struct ewma_throughput throughput;
594 
595 	/** @elp_interval: time interval between two ELP transmissions */
596 	u32 elp_interval;
597 
598 	/** @elp_latest_seqno: latest and best known ELP sequence number */
599 	u32 elp_latest_seqno;
600 
601 	/**
602 	 * @last_unicast_tx: when the last unicast packet has been sent to this
603 	 *  neighbor
604 	 */
605 	unsigned long last_unicast_tx;
606 
607 	/** @metric_work: work queue callback item for metric update */
608 	struct work_struct metric_work;
609 };
610 
611 /**
612  * struct batadv_hardif_neigh_node - unique neighbor per hard-interface
613  */
614 struct batadv_hardif_neigh_node {
615 	/** @list: list node for &batadv_hard_iface.neigh_list */
616 	struct hlist_node list;
617 
618 	/** @addr: the MAC address of the neighboring interface */
619 	u8 addr[ETH_ALEN];
620 
621 	/**
622 	 * @orig: the address of the originator this neighbor node belongs to
623 	 */
624 	u8 orig[ETH_ALEN];
625 
626 	/** @if_incoming: pointer to incoming hard-interface */
627 	struct batadv_hard_iface *if_incoming;
628 
629 	/** @last_seen: when last packet via this neighbor was received */
630 	unsigned long last_seen;
631 
632 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
633 	/** @bat_v: B.A.T.M.A.N. V private data */
634 	struct batadv_hardif_neigh_node_bat_v bat_v;
635 #endif
636 
637 	/** @refcount: number of contexts the object is used */
638 	struct kref refcount;
639 
640 	/** @rcu: struct used for freeing in a RCU-safe manner */
641 	struct rcu_head rcu;
642 };
643 
644 /**
645  * struct batadv_neigh_node - structure for single hops neighbors
646  */
647 struct batadv_neigh_node {
648 	/** @list: list node for &batadv_orig_node.neigh_list */
649 	struct hlist_node list;
650 
651 	/** @orig_node: pointer to corresponding orig_node */
652 	struct batadv_orig_node *orig_node;
653 
654 	/** @addr: the MAC address of the neighboring interface */
655 	u8 addr[ETH_ALEN];
656 
657 	/** @ifinfo_list: list for routing metrics per outgoing interface */
658 	struct hlist_head ifinfo_list;
659 
660 	/** @ifinfo_lock: lock protecting ifinfo_list and its members */
661 	spinlock_t ifinfo_lock;
662 
663 	/** @if_incoming: pointer to incoming hard-interface */
664 	struct batadv_hard_iface *if_incoming;
665 
666 	/** @last_seen: when last packet via this neighbor was received */
667 	unsigned long last_seen;
668 
669 	/** @hardif_neigh: hardif_neigh of this neighbor */
670 	struct batadv_hardif_neigh_node *hardif_neigh;
671 
672 	/** @refcount: number of contexts the object is used */
673 	struct kref refcount;
674 
675 	/** @rcu: struct used for freeing in an RCU-safe manner */
676 	struct rcu_head rcu;
677 };
678 
679 /**
680  * struct batadv_neigh_ifinfo_bat_iv - neighbor information per outgoing
681  *  interface for B.A.T.M.A.N. IV
682  */
683 struct batadv_neigh_ifinfo_bat_iv {
684 	/** @tq_recv: ring buffer of received TQ values from this neigh node */
685 	u8 tq_recv[BATADV_TQ_GLOBAL_WINDOW_SIZE];
686 
687 	/** @tq_index: ring buffer index */
688 	u8 tq_index;
689 
690 	/**
691 	 * @tq_avg: averaged tq of all tq values in the ring buffer (tq_recv)
692 	 */
693 	u8 tq_avg;
694 
695 	/**
696 	 * @real_bits: bitfield containing the number of OGMs received from this
697 	 *  neigh node (relative to orig_node->last_real_seqno)
698 	 */
699 	DECLARE_BITMAP(real_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
700 
701 	/** @real_packet_count: counted result of real_bits */
702 	u8 real_packet_count;
703 };
704 
705 /**
706  * struct batadv_neigh_ifinfo_bat_v - neighbor information per outgoing
707  *  interface for B.A.T.M.A.N. V
708  */
709 struct batadv_neigh_ifinfo_bat_v {
710 	/**
711 	 * @throughput: last throughput metric received from originator via this
712 	 *  neigh
713 	 */
714 	u32 throughput;
715 
716 	/** @last_seqno: last sequence number known for this neighbor */
717 	u32 last_seqno;
718 };
719 
720 /**
721  * struct batadv_neigh_ifinfo - neighbor information per outgoing interface
722  */
723 struct batadv_neigh_ifinfo {
724 	/** @list: list node for &batadv_neigh_node.ifinfo_list */
725 	struct hlist_node list;
726 
727 	/** @if_outgoing: pointer to outgoing hard-interface */
728 	struct batadv_hard_iface *if_outgoing;
729 
730 	/** @bat_iv: B.A.T.M.A.N. IV private structure */
731 	struct batadv_neigh_ifinfo_bat_iv bat_iv;
732 
733 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
734 	/** @bat_v: B.A.T.M.A.N. V private data */
735 	struct batadv_neigh_ifinfo_bat_v bat_v;
736 #endif
737 
738 	/** @last_ttl: last received ttl from this neigh node */
739 	u8 last_ttl;
740 
741 	/** @refcount: number of contexts the object is used */
742 	struct kref refcount;
743 
744 	/** @rcu: struct used for freeing in a RCU-safe manner */
745 	struct rcu_head rcu;
746 };
747 
748 #ifdef CONFIG_BATMAN_ADV_BLA
749 
750 /**
751  * struct batadv_bcast_duplist_entry - structure for LAN broadcast suppression
752  */
753 struct batadv_bcast_duplist_entry {
754 	/** @orig: mac address of orig node orginating the broadcast */
755 	u8 orig[ETH_ALEN];
756 
757 	/** @crc: crc32 checksum of broadcast payload */
758 	__be32 crc;
759 
760 	/** @entrytime: time when the broadcast packet was received */
761 	unsigned long entrytime;
762 };
763 #endif
764 
765 /**
766  * enum batadv_counters - indices for traffic counters
767  */
768 enum batadv_counters {
769 	/** @BATADV_CNT_TX: transmitted payload traffic packet counter */
770 	BATADV_CNT_TX,
771 
772 	/** @BATADV_CNT_TX_BYTES: transmitted payload traffic bytes counter */
773 	BATADV_CNT_TX_BYTES,
774 
775 	/**
776 	 * @BATADV_CNT_TX_DROPPED: dropped transmission payload traffic packet
777 	 *  counter
778 	 */
779 	BATADV_CNT_TX_DROPPED,
780 
781 	/** @BATADV_CNT_RX: received payload traffic packet counter */
782 	BATADV_CNT_RX,
783 
784 	/** @BATADV_CNT_RX_BYTES: received payload traffic bytes counter */
785 	BATADV_CNT_RX_BYTES,
786 
787 	/** @BATADV_CNT_FORWARD: forwarded payload traffic packet counter */
788 	BATADV_CNT_FORWARD,
789 
790 	/**
791 	 * @BATADV_CNT_FORWARD_BYTES: forwarded payload traffic bytes counter
792 	 */
793 	BATADV_CNT_FORWARD_BYTES,
794 
795 	/**
796 	 * @BATADV_CNT_MGMT_TX: transmitted routing protocol traffic packet
797 	 *  counter
798 	 */
799 	BATADV_CNT_MGMT_TX,
800 
801 	/**
802 	 * @BATADV_CNT_MGMT_TX_BYTES: transmitted routing protocol traffic bytes
803 	 *  counter
804 	 */
805 	BATADV_CNT_MGMT_TX_BYTES,
806 
807 	/**
808 	 * @BATADV_CNT_MGMT_RX: received routing protocol traffic packet counter
809 	 */
810 	BATADV_CNT_MGMT_RX,
811 
812 	/**
813 	 * @BATADV_CNT_MGMT_RX_BYTES: received routing protocol traffic bytes
814 	 *  counter
815 	 */
816 	BATADV_CNT_MGMT_RX_BYTES,
817 
818 	/** @BATADV_CNT_FRAG_TX: transmitted fragment traffic packet counter */
819 	BATADV_CNT_FRAG_TX,
820 
821 	/**
822 	 * @BATADV_CNT_FRAG_TX_BYTES: transmitted fragment traffic bytes counter
823 	 */
824 	BATADV_CNT_FRAG_TX_BYTES,
825 
826 	/** @BATADV_CNT_FRAG_RX: received fragment traffic packet counter */
827 	BATADV_CNT_FRAG_RX,
828 
829 	/**
830 	 * @BATADV_CNT_FRAG_RX_BYTES: received fragment traffic bytes counter
831 	 */
832 	BATADV_CNT_FRAG_RX_BYTES,
833 
834 	/** @BATADV_CNT_FRAG_FWD: forwarded fragment traffic packet counter */
835 	BATADV_CNT_FRAG_FWD,
836 
837 	/**
838 	 * @BATADV_CNT_FRAG_FWD_BYTES: forwarded fragment traffic bytes counter
839 	 */
840 	BATADV_CNT_FRAG_FWD_BYTES,
841 
842 	/**
843 	 * @BATADV_CNT_TT_REQUEST_TX: transmitted tt req traffic packet counter
844 	 */
845 	BATADV_CNT_TT_REQUEST_TX,
846 
847 	/** @BATADV_CNT_TT_REQUEST_RX: received tt req traffic packet counter */
848 	BATADV_CNT_TT_REQUEST_RX,
849 
850 	/**
851 	 * @BATADV_CNT_TT_RESPONSE_TX: transmitted tt resp traffic packet
852 	 *  counter
853 	 */
854 	BATADV_CNT_TT_RESPONSE_TX,
855 
856 	/**
857 	 * @BATADV_CNT_TT_RESPONSE_RX: received tt resp traffic packet counter
858 	 */
859 	BATADV_CNT_TT_RESPONSE_RX,
860 
861 	/**
862 	 * @BATADV_CNT_TT_ROAM_ADV_TX: transmitted tt roam traffic packet
863 	 *  counter
864 	 */
865 	BATADV_CNT_TT_ROAM_ADV_TX,
866 
867 	/**
868 	 * @BATADV_CNT_TT_ROAM_ADV_RX: received tt roam traffic packet counter
869 	 */
870 	BATADV_CNT_TT_ROAM_ADV_RX,
871 
872 #ifdef CONFIG_BATMAN_ADV_DAT
873 	/**
874 	 * @BATADV_CNT_DAT_GET_TX: transmitted dht GET traffic packet counter
875 	 */
876 	BATADV_CNT_DAT_GET_TX,
877 
878 	/** @BATADV_CNT_DAT_GET_RX: received dht GET traffic packet counter */
879 	BATADV_CNT_DAT_GET_RX,
880 
881 	/**
882 	 * @BATADV_CNT_DAT_PUT_TX: transmitted dht PUT traffic packet counter
883 	 */
884 	BATADV_CNT_DAT_PUT_TX,
885 
886 	/** @BATADV_CNT_DAT_PUT_RX: received dht PUT traffic packet counter */
887 	BATADV_CNT_DAT_PUT_RX,
888 
889 	/**
890 	 * @BATADV_CNT_DAT_CACHED_REPLY_TX: transmitted dat cache reply traffic
891 	 *  packet counter
892 	 */
893 	BATADV_CNT_DAT_CACHED_REPLY_TX,
894 #endif
895 
896 #ifdef CONFIG_BATMAN_ADV_NC
897 	/**
898 	 * @BATADV_CNT_NC_CODE: transmitted nc-combined traffic packet counter
899 	 */
900 	BATADV_CNT_NC_CODE,
901 
902 	/**
903 	 * @BATADV_CNT_NC_CODE_BYTES: transmitted nc-combined traffic bytes
904 	 *  counter
905 	 */
906 	BATADV_CNT_NC_CODE_BYTES,
907 
908 	/**
909 	 * @BATADV_CNT_NC_RECODE: transmitted nc-recombined traffic packet
910 	 *  counter
911 	 */
912 	BATADV_CNT_NC_RECODE,
913 
914 	/**
915 	 * @BATADV_CNT_NC_RECODE_BYTES: transmitted nc-recombined traffic bytes
916 	 *  counter
917 	 */
918 	BATADV_CNT_NC_RECODE_BYTES,
919 
920 	/**
921 	 * @BATADV_CNT_NC_BUFFER: counter for packets buffered for later nc
922 	 *  decoding
923 	 */
924 	BATADV_CNT_NC_BUFFER,
925 
926 	/**
927 	 * @BATADV_CNT_NC_DECODE: received and nc-decoded traffic packet counter
928 	 */
929 	BATADV_CNT_NC_DECODE,
930 
931 	/**
932 	 * @BATADV_CNT_NC_DECODE_BYTES: received and nc-decoded traffic bytes
933 	 *  counter
934 	 */
935 	BATADV_CNT_NC_DECODE_BYTES,
936 
937 	/**
938 	 * @BATADV_CNT_NC_DECODE_FAILED: received and decode-failed traffic
939 	 *  packet counter
940 	 */
941 	BATADV_CNT_NC_DECODE_FAILED,
942 
943 	/**
944 	 * @BATADV_CNT_NC_SNIFFED: counter for nc-decoded packets received in
945 	 *  promisc mode.
946 	 */
947 	BATADV_CNT_NC_SNIFFED,
948 #endif
949 
950 	/** @BATADV_CNT_NUM: number of traffic counters */
951 	BATADV_CNT_NUM,
952 };
953 
954 /**
955  * struct batadv_priv_tt - per mesh interface translation table data
956  */
957 struct batadv_priv_tt {
958 	/** @vn: translation table version number */
959 	atomic_t vn;
960 
961 	/**
962 	 * @ogm_append_cnt: counter of number of OGMs containing the local tt
963 	 *  diff
964 	 */
965 	atomic_t ogm_append_cnt;
966 
967 	/** @local_changes: changes registered in an originator interval */
968 	atomic_t local_changes;
969 
970 	/**
971 	 * @changes_list: tracks tt local changes within an originator interval
972 	 */
973 	struct list_head changes_list;
974 
975 	/** @local_hash: local translation table hash table */
976 	struct batadv_hashtable *local_hash;
977 
978 	/** @global_hash: global translation table hash table */
979 	struct batadv_hashtable *global_hash;
980 
981 	/** @req_list: list of pending & unanswered tt_requests */
982 	struct hlist_head req_list;
983 
984 	/**
985 	 * @roam_list: list of the last roaming events of each client limiting
986 	 *  the number of roaming events to avoid route flapping
987 	 */
988 	struct list_head roam_list;
989 
990 	/** @changes_list_lock: lock protecting changes_list */
991 	spinlock_t changes_list_lock;
992 
993 	/** @req_list_lock: lock protecting req_list */
994 	spinlock_t req_list_lock;
995 
996 	/** @roam_list_lock: lock protecting roam_list */
997 	spinlock_t roam_list_lock;
998 
999 	/** @last_changeset: last tt changeset this host has generated */
1000 	unsigned char *last_changeset;
1001 
1002 	/**
1003 	 * @last_changeset_len: length of last tt changeset this host has
1004 	 *  generated
1005 	 */
1006 	s16 last_changeset_len;
1007 
1008 	/**
1009 	 * @last_changeset_lock: lock protecting last_changeset &
1010 	 *  last_changeset_len
1011 	 */
1012 	spinlock_t last_changeset_lock;
1013 
1014 	/**
1015 	 * @commit_lock: prevents from executing a local TT commit while reading
1016 	 *  the local table. The local TT commit is made up by two operations
1017 	 *  (data structure update and metdata -CRC/TTVN- recalculation) and
1018 	 *  they have to be executed atomically in order to avoid another thread
1019 	 *  to read the table/metadata between those.
1020 	 */
1021 	spinlock_t commit_lock;
1022 
1023 	/** @work: work queue callback item for translation table purging */
1024 	struct delayed_work work;
1025 };
1026 
1027 #ifdef CONFIG_BATMAN_ADV_BLA
1028 
1029 /**
1030  * struct batadv_priv_bla - per mesh interface bridge loope avoidance data
1031  */
1032 struct batadv_priv_bla {
1033 	/** @num_requests: number of bla requests in flight */
1034 	atomic_t num_requests;
1035 
1036 	/**
1037 	 * @claim_hash: hash table containing mesh nodes this host has claimed
1038 	 */
1039 	struct batadv_hashtable *claim_hash;
1040 
1041 	/**
1042 	 * @backbone_hash: hash table containing all detected backbone gateways
1043 	 */
1044 	struct batadv_hashtable *backbone_hash;
1045 
1046 	/** @loopdetect_addr: MAC address used for own loopdetection frames */
1047 	u8 loopdetect_addr[ETH_ALEN];
1048 
1049 	/**
1050 	 * @loopdetect_lasttime: time when the loopdetection frames were sent
1051 	 */
1052 	unsigned long loopdetect_lasttime;
1053 
1054 	/**
1055 	 * @loopdetect_next: how many periods to wait for the next loopdetect
1056 	 *  process
1057 	 */
1058 	atomic_t loopdetect_next;
1059 
1060 	/**
1061 	 * @bcast_duplist: recently received broadcast packets array (for
1062 	 *  broadcast duplicate suppression)
1063 	 */
1064 	struct batadv_bcast_duplist_entry bcast_duplist[BATADV_DUPLIST_SIZE];
1065 
1066 	/**
1067 	 * @bcast_duplist_curr: index of last broadcast packet added to
1068 	 *  bcast_duplist
1069 	 */
1070 	int bcast_duplist_curr;
1071 
1072 	/**
1073 	 * @bcast_duplist_lock: lock protecting bcast_duplist &
1074 	 *  bcast_duplist_curr
1075 	 */
1076 	spinlock_t bcast_duplist_lock;
1077 
1078 	/** @claim_dest: local claim data (e.g. claim group) */
1079 	struct batadv_bla_claim_dst claim_dest;
1080 
1081 	/** @work: work queue callback item for cleanups & bla announcements */
1082 	struct delayed_work work;
1083 };
1084 #endif
1085 
1086 #ifdef CONFIG_BATMAN_ADV_DEBUG
1087 
1088 /**
1089  * struct batadv_priv_debug_log - debug logging data
1090  */
1091 struct batadv_priv_debug_log {
1092 	/** @log_buff: buffer holding the logs (ring bufer) */
1093 	char log_buff[BATADV_LOG_BUF_LEN];
1094 
1095 	/** @log_start: index of next character to read */
1096 	unsigned long log_start;
1097 
1098 	/** @log_end: index of next character to write */
1099 	unsigned long log_end;
1100 
1101 	/** @lock: lock protecting log_buff, log_start & log_end */
1102 	spinlock_t lock;
1103 
1104 	/** @queue_wait: log reader's wait queue */
1105 	wait_queue_head_t queue_wait;
1106 };
1107 #endif
1108 
1109 /**
1110  * struct batadv_priv_gw - per mesh interface gateway data
1111  */
1112 struct batadv_priv_gw {
1113 	/** @gateway_list: list of available gateway nodes */
1114 	struct hlist_head gateway_list;
1115 
1116 	/** @list_lock: lock protecting gateway_list, curr_gw, generation */
1117 	spinlock_t list_lock;
1118 
1119 	/** @curr_gw: pointer to currently selected gateway node */
1120 	struct batadv_gw_node __rcu *curr_gw;
1121 
1122 	/** @generation: current (generation) sequence number */
1123 	unsigned int generation;
1124 
1125 	/**
1126 	 * @mode: gateway operation: off, client or server (see batadv_gw_modes)
1127 	 */
1128 	atomic_t mode;
1129 
1130 	/** @sel_class: gateway selection class (applies if gw_mode client) */
1131 	atomic_t sel_class;
1132 
1133 	/**
1134 	 * @bandwidth_down: advertised uplink download bandwidth (if gw_mode
1135 	 *  server)
1136 	 */
1137 	atomic_t bandwidth_down;
1138 
1139 	/**
1140 	 * @bandwidth_up: advertised uplink upload bandwidth (if gw_mode server)
1141 	 */
1142 	atomic_t bandwidth_up;
1143 
1144 	/** @reselect: bool indicating a gateway re-selection is in progress */
1145 	atomic_t reselect;
1146 };
1147 
1148 /**
1149  * struct batadv_priv_tvlv - per mesh interface tvlv data
1150  */
1151 struct batadv_priv_tvlv {
1152 	/**
1153 	 * @container_list: list of registered tvlv containers to be sent with
1154 	 *  each OGM
1155 	 */
1156 	struct hlist_head container_list;
1157 
1158 	/** @handler_list: list of the various tvlv content handlers */
1159 	struct hlist_head handler_list;
1160 
1161 	/** @container_list_lock: protects tvlv container list access */
1162 	spinlock_t container_list_lock;
1163 
1164 	/** @handler_list_lock: protects handler list access */
1165 	spinlock_t handler_list_lock;
1166 };
1167 
1168 #ifdef CONFIG_BATMAN_ADV_DAT
1169 
1170 /**
1171  * struct batadv_priv_dat - per mesh interface DAT private data
1172  */
1173 struct batadv_priv_dat {
1174 	/** @addr: node DAT address */
1175 	batadv_dat_addr_t addr;
1176 
1177 	/** @hash: hashtable representing the local ARP cache */
1178 	struct batadv_hashtable *hash;
1179 
1180 	/** @work: work queue callback item for cache purging */
1181 	struct delayed_work work;
1182 };
1183 #endif
1184 
1185 #ifdef CONFIG_BATMAN_ADV_MCAST
1186 /**
1187  * struct batadv_mcast_querier_state - IGMP/MLD querier state when bridged
1188  */
1189 struct batadv_mcast_querier_state {
1190 	/** @exists: whether a querier exists in the mesh */
1191 	unsigned char exists:1;
1192 
1193 	/**
1194 	 * @shadowing: if a querier exists, whether it is potentially shadowing
1195 	 *  multicast listeners (i.e. querier is behind our own bridge segment)
1196 	 */
1197 	unsigned char shadowing:1;
1198 };
1199 
1200 /**
1201  * struct batadv_mcast_mla_flags - flags for the querier, bridge and tvlv state
1202  */
1203 struct batadv_mcast_mla_flags {
1204 	/** @querier_ipv4: the current state of an IGMP querier in the mesh */
1205 	struct batadv_mcast_querier_state querier_ipv4;
1206 
1207 	/** @querier_ipv6: the current state of an MLD querier in the mesh */
1208 	struct batadv_mcast_querier_state querier_ipv6;
1209 
1210 	/** @enabled: whether the multicast tvlv is currently enabled */
1211 	unsigned char enabled:1;
1212 
1213 	/** @bridged: whether the soft interface has a bridge on top */
1214 	unsigned char bridged:1;
1215 
1216 	/** @tvlv_flags: the flags we have last sent in our mcast tvlv */
1217 	u8 tvlv_flags;
1218 };
1219 
1220 /**
1221  * struct batadv_priv_mcast - per mesh interface mcast data
1222  */
1223 struct batadv_priv_mcast {
1224 	/**
1225 	 * @mla_list: list of multicast addresses we are currently announcing
1226 	 *  via TT
1227 	 */
1228 	struct hlist_head mla_list; /* see __batadv_mcast_mla_update() */
1229 
1230 	/**
1231 	 * @want_all_unsnoopables_list: a list of orig_nodes wanting all
1232 	 *  unsnoopable multicast traffic
1233 	 */
1234 	struct hlist_head want_all_unsnoopables_list;
1235 
1236 	/**
1237 	 * @want_all_ipv4_list: a list of orig_nodes wanting all IPv4 multicast
1238 	 *  traffic
1239 	 */
1240 	struct hlist_head want_all_ipv4_list;
1241 
1242 	/**
1243 	 * @want_all_ipv6_list: a list of orig_nodes wanting all IPv6 multicast
1244 	 *  traffic
1245 	 */
1246 	struct hlist_head want_all_ipv6_list;
1247 
1248 	/**
1249 	 * @want_all_rtr4_list: a list of orig_nodes wanting all routable IPv4
1250 	 *  multicast traffic
1251 	 */
1252 	struct hlist_head want_all_rtr4_list;
1253 
1254 	/**
1255 	 * @want_all_rtr6_list: a list of orig_nodes wanting all routable IPv6
1256 	 *  multicast traffic
1257 	 */
1258 	struct hlist_head want_all_rtr6_list;
1259 
1260 	/**
1261 	 * @mla_flags: flags for the querier, bridge and tvlv state
1262 	 */
1263 	struct batadv_mcast_mla_flags mla_flags;
1264 
1265 	/**
1266 	 * @mla_lock: a lock protecting mla_list and mla_flags
1267 	 */
1268 	spinlock_t mla_lock;
1269 
1270 	/**
1271 	 * @num_want_all_unsnoopables: number of nodes wanting unsnoopable IP
1272 	 *  traffic
1273 	 */
1274 	atomic_t num_want_all_unsnoopables;
1275 
1276 	/** @num_want_all_ipv4: counter for items in want_all_ipv4_list */
1277 	atomic_t num_want_all_ipv4;
1278 
1279 	/** @num_want_all_ipv6: counter for items in want_all_ipv6_list */
1280 	atomic_t num_want_all_ipv6;
1281 
1282 	/** @num_want_all_rtr4: counter for items in want_all_rtr4_list */
1283 	atomic_t num_want_all_rtr4;
1284 
1285 	/** @num_want_all_rtr6: counter for items in want_all_rtr6_list */
1286 	atomic_t num_want_all_rtr6;
1287 
1288 	/**
1289 	 * @want_lists_lock: lock for protecting modifications to mcasts
1290 	 *  want_all_{unsnoopables,ipv4,ipv6}_list (traversals are rcu-locked)
1291 	 */
1292 	spinlock_t want_lists_lock;
1293 
1294 	/** @work: work queue callback item for multicast TT and TVLV updates */
1295 	struct delayed_work work;
1296 };
1297 #endif
1298 
1299 /**
1300  * struct batadv_priv_nc - per mesh interface network coding private data
1301  */
1302 struct batadv_priv_nc {
1303 	/** @work: work queue callback item for cleanup */
1304 	struct delayed_work work;
1305 
1306 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
1307 	/**
1308 	 * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
1309 	 */
1310 	struct dentry *debug_dir;
1311 #endif
1312 
1313 	/**
1314 	 * @min_tq: only consider neighbors for encoding if neigh_tq > min_tq
1315 	 */
1316 	u8 min_tq;
1317 
1318 	/**
1319 	 * @max_fwd_delay: maximum packet forward delay to allow coding of
1320 	 *  packets
1321 	 */
1322 	u32 max_fwd_delay;
1323 
1324 	/**
1325 	 * @max_buffer_time: buffer time for sniffed packets used to decoding
1326 	 */
1327 	u32 max_buffer_time;
1328 
1329 	/**
1330 	 * @timestamp_fwd_flush: timestamp of last forward packet queue flush
1331 	 */
1332 	unsigned long timestamp_fwd_flush;
1333 
1334 	/**
1335 	 * @timestamp_sniffed_purge: timestamp of last sniffed packet queue
1336 	 *  purge
1337 	 */
1338 	unsigned long timestamp_sniffed_purge;
1339 
1340 	/**
1341 	 * @coding_hash: Hash table used to buffer skbs while waiting for
1342 	 *  another incoming skb to code it with. Skbs are added to the buffer
1343 	 *  just before being forwarded in routing.c
1344 	 */
1345 	struct batadv_hashtable *coding_hash;
1346 
1347 	/**
1348 	 * @decoding_hash: Hash table used to buffer skbs that might be needed
1349 	 *  to decode a received coded skb. The buffer is used for 1) skbs
1350 	 *  arriving on the soft-interface; 2) skbs overheard on the
1351 	 *  hard-interface; and 3) skbs forwarded by batman-adv.
1352 	 */
1353 	struct batadv_hashtable *decoding_hash;
1354 };
1355 
1356 /**
1357  * struct batadv_tp_unacked - unacked packet meta-information
1358  *
1359  * This struct is supposed to represent a buffer unacked packet. However, since
1360  * the purpose of the TP meter is to count the traffic only, there is no need to
1361  * store the entire sk_buff, the starting offset and the length are enough
1362  */
1363 struct batadv_tp_unacked {
1364 	/** @seqno: seqno of the unacked packet */
1365 	u32 seqno;
1366 
1367 	/** @len: length of the packet */
1368 	u16 len;
1369 
1370 	/** @list: list node for &batadv_tp_vars.unacked_list */
1371 	struct list_head list;
1372 };
1373 
1374 /**
1375  * enum batadv_tp_meter_role - Modus in tp meter session
1376  */
1377 enum batadv_tp_meter_role {
1378 	/** @BATADV_TP_RECEIVER: Initialized as receiver */
1379 	BATADV_TP_RECEIVER,
1380 
1381 	/** @BATADV_TP_SENDER: Initialized as sender */
1382 	BATADV_TP_SENDER
1383 };
1384 
1385 /**
1386  * struct batadv_tp_vars - tp meter private variables per session
1387  */
1388 struct batadv_tp_vars {
1389 	/** @list: list node for &bat_priv.tp_list */
1390 	struct hlist_node list;
1391 
1392 	/** @timer: timer for ack (receiver) and retry (sender) */
1393 	struct timer_list timer;
1394 
1395 	/** @bat_priv: pointer to the mesh object */
1396 	struct batadv_priv *bat_priv;
1397 
1398 	/** @start_time: start time in jiffies */
1399 	unsigned long start_time;
1400 
1401 	/** @other_end: mac address of remote */
1402 	u8 other_end[ETH_ALEN];
1403 
1404 	/** @role: receiver/sender modi */
1405 	enum batadv_tp_meter_role role;
1406 
1407 	/** @sending: sending binary semaphore: 1 if sending, 0 is not */
1408 	atomic_t sending;
1409 
1410 	/** @reason: reason for a stopped session */
1411 	enum batadv_tp_meter_reason reason;
1412 
1413 	/** @finish_work: work item for the finishing procedure */
1414 	struct delayed_work finish_work;
1415 
1416 	/** @test_length: test length in milliseconds */
1417 	u32 test_length;
1418 
1419 	/** @session: TP session identifier */
1420 	u8 session[2];
1421 
1422 	/** @icmp_uid: local ICMP "socket" index */
1423 	u8 icmp_uid;
1424 
1425 	/* sender variables */
1426 
1427 	/** @dec_cwnd: decimal part of the cwnd used during linear growth */
1428 	u16 dec_cwnd;
1429 
1430 	/** @cwnd: current size of the congestion window */
1431 	u32 cwnd;
1432 
1433 	/** @cwnd_lock: lock do protect @cwnd & @dec_cwnd */
1434 	spinlock_t cwnd_lock;
1435 
1436 	/**
1437 	 * @ss_threshold: Slow Start threshold. Once cwnd exceeds this value the
1438 	 *  connection switches to the Congestion Avoidance state
1439 	 */
1440 	u32 ss_threshold;
1441 
1442 	/** @last_acked: last acked byte */
1443 	atomic_t last_acked;
1444 
1445 	/** @last_sent: last sent byte, not yet acked */
1446 	u32 last_sent;
1447 
1448 	/** @tot_sent: amount of data sent/ACKed so far */
1449 	atomic64_t tot_sent;
1450 
1451 	/** @dup_acks: duplicate ACKs counter */
1452 	atomic_t dup_acks;
1453 
1454 	/** @fast_recovery: true if in Fast Recovery mode */
1455 	unsigned char fast_recovery:1;
1456 
1457 	/** @recover: last sent seqno when entering Fast Recovery */
1458 	u32 recover;
1459 
1460 	/** @rto: sender timeout */
1461 	u32 rto;
1462 
1463 	/** @srtt: smoothed RTT scaled by 2^3 */
1464 	u32 srtt;
1465 
1466 	/** @rttvar: RTT variation scaled by 2^2 */
1467 	u32 rttvar;
1468 
1469 	/**
1470 	 * @more_bytes: waiting queue anchor when waiting for more ack/retry
1471 	 *  timeout
1472 	 */
1473 	wait_queue_head_t more_bytes;
1474 
1475 	/** @prerandom_offset: offset inside the prerandom buffer */
1476 	u32 prerandom_offset;
1477 
1478 	/** @prerandom_lock: spinlock protecting access to prerandom_offset */
1479 	spinlock_t prerandom_lock;
1480 
1481 	/* receiver variables */
1482 
1483 	/** @last_recv: last in-order received packet */
1484 	u32 last_recv;
1485 
1486 	/** @unacked_list: list of unacked packets (meta-info only) */
1487 	struct list_head unacked_list;
1488 
1489 	/** @unacked_lock: protect unacked_list */
1490 	spinlock_t unacked_lock;
1491 
1492 	/** @last_recv_time: time time (jiffies) a msg was received */
1493 	unsigned long last_recv_time;
1494 
1495 	/** @refcount: number of context where the object is used */
1496 	struct kref refcount;
1497 
1498 	/** @rcu: struct used for freeing in an RCU-safe manner */
1499 	struct rcu_head rcu;
1500 };
1501 
1502 /**
1503  * struct batadv_softif_vlan - per VLAN attributes set
1504  */
1505 struct batadv_softif_vlan {
1506 	/** @bat_priv: pointer to the mesh object */
1507 	struct batadv_priv *bat_priv;
1508 
1509 	/** @vid: VLAN identifier */
1510 	unsigned short vid;
1511 
1512 	/** @kobj: kobject for sysfs vlan subdirectory */
1513 	struct kobject *kobj;
1514 
1515 	/** @ap_isolation: AP isolation state */
1516 	atomic_t ap_isolation;		/* boolean */
1517 
1518 	/** @tt: TT private attributes (VLAN specific) */
1519 	struct batadv_vlan_tt tt;
1520 
1521 	/** @list: list node for &bat_priv.softif_vlan_list */
1522 	struct hlist_node list;
1523 
1524 	/**
1525 	 * @refcount: number of context where this object is currently in use
1526 	 */
1527 	struct kref refcount;
1528 
1529 	/** @rcu: struct used for freeing in a RCU-safe manner */
1530 	struct rcu_head rcu;
1531 };
1532 
1533 /**
1534  * struct batadv_priv_bat_v - B.A.T.M.A.N. V per soft-interface private data
1535  */
1536 struct batadv_priv_bat_v {
1537 	/** @ogm_buff: buffer holding the OGM packet */
1538 	unsigned char *ogm_buff;
1539 
1540 	/** @ogm_buff_len: length of the OGM packet buffer */
1541 	int ogm_buff_len;
1542 
1543 	/** @ogm_seqno: OGM sequence number - used to identify each OGM */
1544 	atomic_t ogm_seqno;
1545 
1546 	/** @ogm_buff_mutex: lock protecting ogm_buff and ogm_buff_len */
1547 	struct mutex ogm_buff_mutex;
1548 
1549 	/** @ogm_wq: workqueue used to schedule OGM transmissions */
1550 	struct delayed_work ogm_wq;
1551 };
1552 
1553 /**
1554  * struct batadv_priv - per mesh interface data
1555  */
1556 struct batadv_priv {
1557 	/**
1558 	 * @mesh_state: current status of the mesh
1559 	 *  (inactive/active/deactivating)
1560 	 */
1561 	atomic_t mesh_state;
1562 
1563 	/** @soft_iface: net device which holds this struct as private data */
1564 	struct net_device *soft_iface;
1565 
1566 	/**
1567 	 * @bat_counters: mesh internal traffic statistic counters (see
1568 	 *  batadv_counters)
1569 	 */
1570 	u64 __percpu *bat_counters; /* Per cpu counters */
1571 
1572 	/**
1573 	 * @aggregated_ogms: bool indicating whether OGM aggregation is enabled
1574 	 */
1575 	atomic_t aggregated_ogms;
1576 
1577 	/** @bonding: bool indicating whether traffic bonding is enabled */
1578 	atomic_t bonding;
1579 
1580 	/**
1581 	 * @fragmentation: bool indicating whether traffic fragmentation is
1582 	 *  enabled
1583 	 */
1584 	atomic_t fragmentation;
1585 
1586 	/**
1587 	 * @packet_size_max: max packet size that can be transmitted via
1588 	 *  multiple fragmented skbs or a single frame if fragmentation is
1589 	 *  disabled
1590 	 */
1591 	atomic_t packet_size_max;
1592 
1593 	/**
1594 	 * @frag_seqno: incremental counter to identify chains of egress
1595 	 *  fragments
1596 	 */
1597 	atomic_t frag_seqno;
1598 
1599 #ifdef CONFIG_BATMAN_ADV_BLA
1600 	/**
1601 	 * @bridge_loop_avoidance: bool indicating whether bridge loop
1602 	 *  avoidance is enabled
1603 	 */
1604 	atomic_t bridge_loop_avoidance;
1605 #endif
1606 
1607 #ifdef CONFIG_BATMAN_ADV_DAT
1608 	/**
1609 	 * @distributed_arp_table: bool indicating whether distributed ARP table
1610 	 *  is enabled
1611 	 */
1612 	atomic_t distributed_arp_table;
1613 #endif
1614 
1615 #ifdef CONFIG_BATMAN_ADV_MCAST
1616 	/**
1617 	 * @multicast_mode: Enable or disable multicast optimizations on this
1618 	 *  node's sender/originating side
1619 	 */
1620 	atomic_t multicast_mode;
1621 
1622 	/**
1623 	 * @multicast_fanout: Maximum number of packet copies to generate for a
1624 	 *  multicast-to-unicast conversion
1625 	 */
1626 	atomic_t multicast_fanout;
1627 #endif
1628 
1629 	/** @orig_interval: OGM broadcast interval in milliseconds */
1630 	atomic_t orig_interval;
1631 
1632 	/**
1633 	 * @hop_penalty: penalty which will be applied to an OGM's tq-field on
1634 	 *  every hop
1635 	 */
1636 	atomic_t hop_penalty;
1637 
1638 #ifdef CONFIG_BATMAN_ADV_DEBUG
1639 	/** @log_level: configured log level (see batadv_dbg_level) */
1640 	atomic_t log_level;
1641 #endif
1642 
1643 	/**
1644 	 * @isolation_mark: the skb->mark value used to match packets for AP
1645 	 *  isolation
1646 	 */
1647 	u32 isolation_mark;
1648 
1649 	/**
1650 	 * @isolation_mark_mask: bitmask identifying the bits in skb->mark to be
1651 	 *  used for the isolation mark
1652 	 */
1653 	u32 isolation_mark_mask;
1654 
1655 	/** @bcast_seqno: last sent broadcast packet sequence number */
1656 	atomic_t bcast_seqno;
1657 
1658 	/**
1659 	 * @bcast_queue_left: number of remaining buffered broadcast packet
1660 	 *  slots
1661 	 */
1662 	atomic_t bcast_queue_left;
1663 
1664 	/** @batman_queue_left: number of remaining OGM packet slots */
1665 	atomic_t batman_queue_left;
1666 
1667 	/** @mesh_obj: kobject for sysfs mesh subdirectory */
1668 	struct kobject *mesh_obj;
1669 
1670 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
1671 	/** @debug_dir: dentry for debugfs batman-adv subdirectory */
1672 	struct dentry *debug_dir;
1673 #endif
1674 
1675 	/** @forw_bat_list: list of aggregated OGMs that will be forwarded */
1676 	struct hlist_head forw_bat_list;
1677 
1678 	/**
1679 	 * @forw_bcast_list: list of broadcast packets that will be
1680 	 *  rebroadcasted
1681 	 */
1682 	struct hlist_head forw_bcast_list;
1683 
1684 	/** @tp_list: list of tp sessions */
1685 	struct hlist_head tp_list;
1686 
1687 	/** @tp_num: number of currently active tp sessions */
1688 	struct batadv_hashtable *orig_hash;
1689 
1690 	/** @orig_hash: hash table containing mesh participants (orig nodes) */
1691 	spinlock_t forw_bat_list_lock;
1692 
1693 	/** @forw_bat_list_lock: lock protecting forw_bat_list */
1694 	spinlock_t forw_bcast_list_lock;
1695 
1696 	/** @forw_bcast_list_lock: lock protecting forw_bcast_list */
1697 	spinlock_t tp_list_lock;
1698 
1699 	/** @tp_list_lock: spinlock protecting @tp_list */
1700 	atomic_t tp_num;
1701 
1702 	/** @orig_work: work queue callback item for orig node purging */
1703 	struct delayed_work orig_work;
1704 
1705 	/**
1706 	 * @primary_if: one of the hard-interfaces assigned to this mesh
1707 	 *  interface becomes the primary interface
1708 	 */
1709 	struct batadv_hard_iface __rcu *primary_if;  /* rcu protected pointer */
1710 
1711 	/** @algo_ops: routing algorithm used by this mesh interface */
1712 	struct batadv_algo_ops *algo_ops;
1713 
1714 	/**
1715 	 * @softif_vlan_list: a list of softif_vlan structs, one per VLAN
1716 	 *  created on top of the mesh interface represented by this object
1717 	 */
1718 	struct hlist_head softif_vlan_list;
1719 
1720 	/** @softif_vlan_list_lock: lock protecting softif_vlan_list */
1721 	spinlock_t softif_vlan_list_lock;
1722 
1723 #ifdef CONFIG_BATMAN_ADV_BLA
1724 	/** @bla: bridge loope avoidance data */
1725 	struct batadv_priv_bla bla;
1726 #endif
1727 
1728 #ifdef CONFIG_BATMAN_ADV_DEBUG
1729 	/** @debug_log: holding debug logging relevant data */
1730 	struct batadv_priv_debug_log *debug_log;
1731 #endif
1732 
1733 	/** @gw: gateway data */
1734 	struct batadv_priv_gw gw;
1735 
1736 	/** @tt: translation table data */
1737 	struct batadv_priv_tt tt;
1738 
1739 	/** @tvlv: type-version-length-value data */
1740 	struct batadv_priv_tvlv tvlv;
1741 
1742 #ifdef CONFIG_BATMAN_ADV_DAT
1743 	/** @dat: distributed arp table data */
1744 	struct batadv_priv_dat dat;
1745 #endif
1746 
1747 #ifdef CONFIG_BATMAN_ADV_MCAST
1748 	/** @mcast: multicast data */
1749 	struct batadv_priv_mcast mcast;
1750 #endif
1751 
1752 #ifdef CONFIG_BATMAN_ADV_NC
1753 	/**
1754 	 * @network_coding: bool indicating whether network coding is enabled
1755 	 */
1756 	atomic_t network_coding;
1757 
1758 	/** @nc: network coding data */
1759 	struct batadv_priv_nc nc;
1760 #endif /* CONFIG_BATMAN_ADV_NC */
1761 
1762 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
1763 	/** @bat_v: B.A.T.M.A.N. V per soft-interface private data */
1764 	struct batadv_priv_bat_v bat_v;
1765 #endif
1766 };
1767 
1768 /**
1769  * struct batadv_socket_client - layer2 icmp socket client data
1770  */
1771 struct batadv_socket_client {
1772 	/**
1773 	 * @queue_list: packet queue for packets destined for this socket client
1774 	 */
1775 	struct list_head queue_list;
1776 
1777 	/** @queue_len: number of packets in the packet queue (queue_list) */
1778 	unsigned int queue_len;
1779 
1780 	/** @index: socket client's index in the batadv_socket_client_hash */
1781 	unsigned char index;
1782 
1783 	/** @lock: lock protecting queue_list, queue_len & index */
1784 	spinlock_t lock;
1785 
1786 	/** @queue_wait: socket client's wait queue */
1787 	wait_queue_head_t queue_wait;
1788 
1789 	/** @bat_priv: pointer to soft_iface this client belongs to */
1790 	struct batadv_priv *bat_priv;
1791 };
1792 
1793 /**
1794  * struct batadv_socket_packet - layer2 icmp packet for socket client
1795  */
1796 struct batadv_socket_packet {
1797 	/** @list: list node for &batadv_socket_client.queue_list */
1798 	struct list_head list;
1799 
1800 	/** @icmp_len: size of the layer2 icmp packet */
1801 	size_t icmp_len;
1802 
1803 	/** @icmp_packet: layer2 icmp packet */
1804 	u8 icmp_packet[BATADV_ICMP_MAX_PACKET_SIZE];
1805 };
1806 
1807 #ifdef CONFIG_BATMAN_ADV_BLA
1808 
1809 /**
1810  * struct batadv_bla_backbone_gw - batman-adv gateway bridged into the LAN
1811  */
1812 struct batadv_bla_backbone_gw {
1813 	/**
1814 	 * @orig: originator address of backbone node (mac address of primary
1815 	 *  iface)
1816 	 */
1817 	u8 orig[ETH_ALEN];
1818 
1819 	/** @vid: vlan id this gateway was detected on */
1820 	unsigned short vid;
1821 
1822 	/** @hash_entry: hlist node for &batadv_priv_bla.backbone_hash */
1823 	struct hlist_node hash_entry;
1824 
1825 	/** @bat_priv: pointer to soft_iface this backbone gateway belongs to */
1826 	struct batadv_priv *bat_priv;
1827 
1828 	/** @lasttime: last time we heard of this backbone gw */
1829 	unsigned long lasttime;
1830 
1831 	/**
1832 	 * @wait_periods: grace time for bridge forward delays and bla group
1833 	 *  forming at bootup phase - no bcast traffic is formwared until it has
1834 	 *  elapsed
1835 	 */
1836 	atomic_t wait_periods;
1837 
1838 	/**
1839 	 * @request_sent: if this bool is set to true we are out of sync with
1840 	 *  this backbone gateway - no bcast traffic is formwared until the
1841 	 *  situation was resolved
1842 	 */
1843 	atomic_t request_sent;
1844 
1845 	/** @crc: crc16 checksum over all claims */
1846 	u16 crc;
1847 
1848 	/** @crc_lock: lock protecting crc */
1849 	spinlock_t crc_lock;
1850 
1851 	/** @report_work: work struct for reporting detected loops */
1852 	struct work_struct report_work;
1853 
1854 	/** @refcount: number of contexts the object is used */
1855 	struct kref refcount;
1856 
1857 	/** @rcu: struct used for freeing in an RCU-safe manner */
1858 	struct rcu_head rcu;
1859 };
1860 
1861 /**
1862  * struct batadv_bla_claim - claimed non-mesh client structure
1863  */
1864 struct batadv_bla_claim {
1865 	/** @addr: mac address of claimed non-mesh client */
1866 	u8 addr[ETH_ALEN];
1867 
1868 	/** @vid: vlan id this client was detected on */
1869 	unsigned short vid;
1870 
1871 	/** @backbone_gw: pointer to backbone gw claiming this client */
1872 	struct batadv_bla_backbone_gw *backbone_gw;
1873 
1874 	/** @backbone_lock: lock protecting backbone_gw pointer */
1875 	spinlock_t backbone_lock;
1876 
1877 	/** @lasttime: last time we heard of claim (locals only) */
1878 	unsigned long lasttime;
1879 
1880 	/** @hash_entry: hlist node for &batadv_priv_bla.claim_hash */
1881 	struct hlist_node hash_entry;
1882 
1883 	/** @refcount: number of contexts the object is used */
1884 	struct rcu_head rcu;
1885 
1886 	/** @rcu: struct used for freeing in an RCU-safe manner */
1887 	struct kref refcount;
1888 };
1889 #endif
1890 
1891 /**
1892  * struct batadv_tt_common_entry - tt local & tt global common data
1893  */
1894 struct batadv_tt_common_entry {
1895 	/** @addr: mac address of non-mesh client */
1896 	u8 addr[ETH_ALEN];
1897 
1898 	/** @vid: VLAN identifier */
1899 	unsigned short vid;
1900 
1901 	/**
1902 	 * @hash_entry: hlist node for &batadv_priv_tt.local_hash or for
1903 	 *  &batadv_priv_tt.global_hash
1904 	 */
1905 	struct hlist_node hash_entry;
1906 
1907 	/** @flags: various state handling flags (see batadv_tt_client_flags) */
1908 	u16 flags;
1909 
1910 	/** @added_at: timestamp used for purging stale tt common entries */
1911 	unsigned long added_at;
1912 
1913 	/** @refcount: number of contexts the object is used */
1914 	struct kref refcount;
1915 
1916 	/** @rcu: struct used for freeing in an RCU-safe manner */
1917 	struct rcu_head rcu;
1918 };
1919 
1920 /**
1921  * struct batadv_tt_local_entry - translation table local entry data
1922  */
1923 struct batadv_tt_local_entry {
1924 	/** @common: general translation table data */
1925 	struct batadv_tt_common_entry common;
1926 
1927 	/** @last_seen: timestamp used for purging stale tt local entries */
1928 	unsigned long last_seen;
1929 
1930 	/** @vlan: soft-interface vlan of the entry */
1931 	struct batadv_softif_vlan *vlan;
1932 };
1933 
1934 /**
1935  * struct batadv_tt_global_entry - translation table global entry data
1936  */
1937 struct batadv_tt_global_entry {
1938 	/** @common: general translation table data */
1939 	struct batadv_tt_common_entry common;
1940 
1941 	/** @orig_list: list of orig nodes announcing this non-mesh client */
1942 	struct hlist_head orig_list;
1943 
1944 	/** @orig_list_count: number of items in the orig_list */
1945 	atomic_t orig_list_count;
1946 
1947 	/** @list_lock: lock protecting orig_list */
1948 	spinlock_t list_lock;
1949 
1950 	/** @roam_at: time at which TT_GLOBAL_ROAM was set */
1951 	unsigned long roam_at;
1952 };
1953 
1954 /**
1955  * struct batadv_tt_orig_list_entry - orig node announcing a non-mesh client
1956  */
1957 struct batadv_tt_orig_list_entry {
1958 	/** @orig_node: pointer to orig node announcing this non-mesh client */
1959 	struct batadv_orig_node *orig_node;
1960 
1961 	/**
1962 	 * @ttvn: translation table version number which added the non-mesh
1963 	 *  client
1964 	 */
1965 	u8 ttvn;
1966 
1967 	/** @flags: per orig entry TT sync flags */
1968 	u8 flags;
1969 
1970 	/** @list: list node for &batadv_tt_global_entry.orig_list */
1971 	struct hlist_node list;
1972 
1973 	/** @refcount: number of contexts the object is used */
1974 	struct kref refcount;
1975 
1976 	/** @rcu: struct used for freeing in an RCU-safe manner */
1977 	struct rcu_head rcu;
1978 };
1979 
1980 /**
1981  * struct batadv_tt_change_node - structure for tt changes occurred
1982  */
1983 struct batadv_tt_change_node {
1984 	/** @list: list node for &batadv_priv_tt.changes_list */
1985 	struct list_head list;
1986 
1987 	/** @change: holds the actual translation table diff data */
1988 	struct batadv_tvlv_tt_change change;
1989 };
1990 
1991 /**
1992  * struct batadv_tt_req_node - data to keep track of the tt requests in flight
1993  */
1994 struct batadv_tt_req_node {
1995 	/**
1996 	 * @addr: mac address address of the originator this request was sent to
1997 	 */
1998 	u8 addr[ETH_ALEN];
1999 
2000 	/** @issued_at: timestamp used for purging stale tt requests */
2001 	unsigned long issued_at;
2002 
2003 	/** @refcount: number of contexts the object is used by */
2004 	struct kref refcount;
2005 
2006 	/** @list: list node for &batadv_priv_tt.req_list */
2007 	struct hlist_node list;
2008 };
2009 
2010 /**
2011  * struct batadv_tt_roam_node - roaming client data
2012  */
2013 struct batadv_tt_roam_node {
2014 	/** @addr: mac address of the client in the roaming phase */
2015 	u8 addr[ETH_ALEN];
2016 
2017 	/**
2018 	 * @counter: number of allowed roaming events per client within a single
2019 	 * OGM interval (changes are committed with each OGM)
2020 	 */
2021 	atomic_t counter;
2022 
2023 	/**
2024 	 * @first_time: timestamp used for purging stale roaming node entries
2025 	 */
2026 	unsigned long first_time;
2027 
2028 	/** @list: list node for &batadv_priv_tt.roam_list */
2029 	struct list_head list;
2030 };
2031 
2032 /**
2033  * struct batadv_nc_node - network coding node
2034  */
2035 struct batadv_nc_node {
2036 	/** @list: next and prev pointer for the list handling */
2037 	struct list_head list;
2038 
2039 	/** @addr: the node's mac address */
2040 	u8 addr[ETH_ALEN];
2041 
2042 	/** @refcount: number of contexts the object is used by */
2043 	struct kref refcount;
2044 
2045 	/** @rcu: struct used for freeing in an RCU-safe manner */
2046 	struct rcu_head rcu;
2047 
2048 	/** @orig_node: pointer to corresponding orig node struct */
2049 	struct batadv_orig_node *orig_node;
2050 
2051 	/** @last_seen: timestamp of last ogm received from this node */
2052 	unsigned long last_seen;
2053 };
2054 
2055 /**
2056  * struct batadv_nc_path - network coding path
2057  */
2058 struct batadv_nc_path {
2059 	/** @hash_entry: next and prev pointer for the list handling */
2060 	struct hlist_node hash_entry;
2061 
2062 	/** @rcu: struct used for freeing in an RCU-safe manner */
2063 	struct rcu_head rcu;
2064 
2065 	/** @refcount: number of contexts the object is used by */
2066 	struct kref refcount;
2067 
2068 	/** @packet_list: list of buffered packets for this path */
2069 	struct list_head packet_list;
2070 
2071 	/** @packet_list_lock: access lock for packet list */
2072 	spinlock_t packet_list_lock;
2073 
2074 	/** @next_hop: next hop (destination) of path */
2075 	u8 next_hop[ETH_ALEN];
2076 
2077 	/** @prev_hop: previous hop (source) of path */
2078 	u8 prev_hop[ETH_ALEN];
2079 
2080 	/** @last_valid: timestamp for last validation of path */
2081 	unsigned long last_valid;
2082 };
2083 
2084 /**
2085  * struct batadv_nc_packet - network coding packet used when coding and
2086  *  decoding packets
2087  */
2088 struct batadv_nc_packet {
2089 	/** @list: next and prev pointer for the list handling */
2090 	struct list_head list;
2091 
2092 	/** @packet_id: crc32 checksum of skb data */
2093 	__be32 packet_id;
2094 
2095 	/**
2096 	 * @timestamp: field containing the info when the packet was added to
2097 	 *  path
2098 	 */
2099 	unsigned long timestamp;
2100 
2101 	/** @neigh_node: pointer to original next hop neighbor of skb */
2102 	struct batadv_neigh_node *neigh_node;
2103 
2104 	/** @skb: skb which can be encoded or used for decoding */
2105 	struct sk_buff *skb;
2106 
2107 	/** @nc_path: pointer to path this nc packet is attached to */
2108 	struct batadv_nc_path *nc_path;
2109 };
2110 
2111 /**
2112  * struct batadv_skb_cb - control buffer structure used to store private data
2113  *  relevant to batman-adv in the skb->cb buffer in skbs.
2114  */
2115 struct batadv_skb_cb {
2116 	/**
2117 	 * @decoded: Marks a skb as decoded, which is checked when searching for
2118 	 *  coding opportunities in network-coding.c
2119 	 */
2120 	unsigned char decoded:1;
2121 
2122 	/** @num_bcasts: Counter for broadcast packet retransmissions */
2123 	unsigned char num_bcasts;
2124 };
2125 
2126 /**
2127  * struct batadv_forw_packet - structure for bcast packets to be sent/forwarded
2128  */
2129 struct batadv_forw_packet {
2130 	/**
2131 	 * @list: list node for &batadv_priv.forw.bcast_list and
2132 	 *  &batadv_priv.forw.bat_list
2133 	 */
2134 	struct hlist_node list;
2135 
2136 	/** @cleanup_list: list node for purging functions */
2137 	struct hlist_node cleanup_list;
2138 
2139 	/** @send_time: execution time for delayed_work (packet sending) */
2140 	unsigned long send_time;
2141 
2142 	/**
2143 	 * @own: bool for locally generated packets (local OGMs are re-scheduled
2144 	 * after sending)
2145 	 */
2146 	u8 own;
2147 
2148 	/** @skb: bcast packet's skb buffer */
2149 	struct sk_buff *skb;
2150 
2151 	/** @packet_len: size of aggregated OGM packet inside the skb buffer */
2152 	u16 packet_len;
2153 
2154 	/** @direct_link_flags: direct link flags for aggregated OGM packets */
2155 	u32 direct_link_flags;
2156 
2157 	/** @num_packets: counter for aggregated OGMv1 packets */
2158 	u8 num_packets;
2159 
2160 	/** @delayed_work: work queue callback item for packet sending */
2161 	struct delayed_work delayed_work;
2162 
2163 	/**
2164 	 * @if_incoming: pointer to incoming hard-iface or primary iface if
2165 	 *  locally generated packet
2166 	 */
2167 	struct batadv_hard_iface *if_incoming;
2168 
2169 	/**
2170 	 * @if_outgoing: packet where the packet should be sent to, or NULL if
2171 	 *  unspecified
2172 	 */
2173 	struct batadv_hard_iface *if_outgoing;
2174 
2175 	/** @queue_left: The queue (counter) this packet was applied to */
2176 	atomic_t *queue_left;
2177 };
2178 
2179 /**
2180  * struct batadv_algo_iface_ops - mesh algorithm callbacks (interface specific)
2181  */
2182 struct batadv_algo_iface_ops {
2183 	/**
2184 	 * @activate: start routing mechanisms when hard-interface is brought up
2185 	 *  (optional)
2186 	 */
2187 	void (*activate)(struct batadv_hard_iface *hard_iface);
2188 
2189 	/** @enable: init routing info when hard-interface is enabled */
2190 	int (*enable)(struct batadv_hard_iface *hard_iface);
2191 
2192 	/** @enabled: notification when hard-interface was enabled (optional) */
2193 	void (*enabled)(struct batadv_hard_iface *hard_iface);
2194 
2195 	/** @disable: de-init routing info when hard-interface is disabled */
2196 	void (*disable)(struct batadv_hard_iface *hard_iface);
2197 
2198 	/**
2199 	 * @update_mac: (re-)init mac addresses of the protocol information
2200 	 *  belonging to this hard-interface
2201 	 */
2202 	void (*update_mac)(struct batadv_hard_iface *hard_iface);
2203 
2204 	/** @primary_set: called when primary interface is selected / changed */
2205 	void (*primary_set)(struct batadv_hard_iface *hard_iface);
2206 };
2207 
2208 /**
2209  * struct batadv_algo_neigh_ops - mesh algorithm callbacks (neighbour specific)
2210  */
2211 struct batadv_algo_neigh_ops {
2212 	/** @hardif_init: called on creation of single hop entry (optional) */
2213 	void (*hardif_init)(struct batadv_hardif_neigh_node *neigh);
2214 
2215 	/**
2216 	 * @cmp: compare the metrics of two neighbors for their respective
2217 	 *  outgoing interfaces
2218 	 */
2219 	int (*cmp)(struct batadv_neigh_node *neigh1,
2220 		   struct batadv_hard_iface *if_outgoing1,
2221 		   struct batadv_neigh_node *neigh2,
2222 		   struct batadv_hard_iface *if_outgoing2);
2223 
2224 	/**
2225 	 * @is_similar_or_better: check if neigh1 is equally similar or better
2226 	 *  than neigh2 for their respective outgoing interface from the metric
2227 	 *  prospective
2228 	 */
2229 	bool (*is_similar_or_better)(struct batadv_neigh_node *neigh1,
2230 				     struct batadv_hard_iface *if_outgoing1,
2231 				     struct batadv_neigh_node *neigh2,
2232 				     struct batadv_hard_iface *if_outgoing2);
2233 
2234 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
2235 	/** @print: print the single hop neighbor list (optional) */
2236 	void (*print)(struct batadv_priv *priv, struct seq_file *seq);
2237 #endif
2238 
2239 	/** @dump: dump neighbors to a netlink socket (optional) */
2240 	void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
2241 		     struct batadv_priv *priv,
2242 		     struct batadv_hard_iface *hard_iface);
2243 };
2244 
2245 /**
2246  * struct batadv_algo_orig_ops - mesh algorithm callbacks (originator specific)
2247  */
2248 struct batadv_algo_orig_ops {
2249 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
2250 	/** @print: print the originator table (optional) */
2251 	void (*print)(struct batadv_priv *priv, struct seq_file *seq,
2252 		      struct batadv_hard_iface *hard_iface);
2253 #endif
2254 
2255 	/** @dump: dump originators to a netlink socket (optional) */
2256 	void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
2257 		     struct batadv_priv *priv,
2258 		     struct batadv_hard_iface *hard_iface);
2259 };
2260 
2261 /**
2262  * struct batadv_algo_gw_ops - mesh algorithm callbacks (GW specific)
2263  */
2264 struct batadv_algo_gw_ops {
2265 	/** @init_sel_class: initialize GW selection class (optional) */
2266 	void (*init_sel_class)(struct batadv_priv *bat_priv);
2267 
2268 	/**
2269 	 * @store_sel_class: parse and stores a new GW selection class
2270 	 *  (optional)
2271 	 */
2272 	ssize_t (*store_sel_class)(struct batadv_priv *bat_priv, char *buff,
2273 				   size_t count);
2274 
2275 	/** @show_sel_class: prints the current GW selection class (optional) */
2276 	ssize_t (*show_sel_class)(struct batadv_priv *bat_priv, char *buff);
2277 
2278 	/**
2279 	 * @get_best_gw_node: select the best GW from the list of available
2280 	 *  nodes (optional)
2281 	 */
2282 	struct batadv_gw_node *(*get_best_gw_node)
2283 		(struct batadv_priv *bat_priv);
2284 
2285 	/**
2286 	 * @is_eligible: check if a newly discovered GW is a potential candidate
2287 	 *  for the election as best GW (optional)
2288 	 */
2289 	bool (*is_eligible)(struct batadv_priv *bat_priv,
2290 			    struct batadv_orig_node *curr_gw_orig,
2291 			    struct batadv_orig_node *orig_node);
2292 
2293 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
2294 	/** @print: print the gateway table (optional) */
2295 	void (*print)(struct batadv_priv *bat_priv, struct seq_file *seq);
2296 #endif
2297 
2298 	/** @dump: dump gateways to a netlink socket (optional) */
2299 	void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
2300 		     struct batadv_priv *priv);
2301 };
2302 
2303 /**
2304  * struct batadv_algo_ops - mesh algorithm callbacks
2305  */
2306 struct batadv_algo_ops {
2307 	/** @list: list node for the batadv_algo_list */
2308 	struct hlist_node list;
2309 
2310 	/** @name: name of the algorithm */
2311 	char *name;
2312 
2313 	/** @iface: callbacks related to interface handling */
2314 	struct batadv_algo_iface_ops iface;
2315 
2316 	/** @neigh: callbacks related to neighbors handling */
2317 	struct batadv_algo_neigh_ops neigh;
2318 
2319 	/** @orig: callbacks related to originators handling */
2320 	struct batadv_algo_orig_ops orig;
2321 
2322 	/** @gw: callbacks related to GW mode */
2323 	struct batadv_algo_gw_ops gw;
2324 };
2325 
2326 /**
2327  * struct batadv_dat_entry - it is a single entry of batman-adv ARP backend. It
2328  * is used to stored ARP entries needed for the global DAT cache
2329  */
2330 struct batadv_dat_entry {
2331 	/** @ip: the IPv4 corresponding to this DAT/ARP entry */
2332 	__be32 ip;
2333 
2334 	/** @mac_addr: the MAC address associated to the stored IPv4 */
2335 	u8 mac_addr[ETH_ALEN];
2336 
2337 	/** @vid: the vlan ID associated to this entry */
2338 	unsigned short vid;
2339 
2340 	/**
2341 	 * @last_update: time in jiffies when this entry was refreshed last time
2342 	 */
2343 	unsigned long last_update;
2344 
2345 	/** @hash_entry: hlist node for &batadv_priv_dat.hash */
2346 	struct hlist_node hash_entry;
2347 
2348 	/** @refcount: number of contexts the object is used */
2349 	struct kref refcount;
2350 
2351 	/** @rcu: struct used for freeing in an RCU-safe manner */
2352 	struct rcu_head rcu;
2353 };
2354 
2355 /**
2356  * struct batadv_hw_addr - a list entry for a MAC address
2357  */
2358 struct batadv_hw_addr {
2359 	/** @list: list node for the linking of entries */
2360 	struct hlist_node list;
2361 
2362 	/** @addr: the MAC address of this list entry */
2363 	unsigned char addr[ETH_ALEN];
2364 };
2365 
2366 /**
2367  * struct batadv_dat_candidate - candidate destination for DAT operations
2368  */
2369 struct batadv_dat_candidate {
2370 	/**
2371 	 * @type: the type of the selected candidate. It can one of the
2372 	 *  following:
2373 	 *	  - BATADV_DAT_CANDIDATE_NOT_FOUND
2374 	 *	  - BATADV_DAT_CANDIDATE_ORIG
2375 	 */
2376 	int type;
2377 
2378 	/**
2379 	 * @orig_node: if type is BATADV_DAT_CANDIDATE_ORIG this field points to
2380 	 * the corresponding originator node structure
2381 	 */
2382 	struct batadv_orig_node *orig_node;
2383 };
2384 
2385 /**
2386  * struct batadv_tvlv_container - container for tvlv appended to OGMs
2387  */
2388 struct batadv_tvlv_container {
2389 	/** @list: hlist node for &batadv_priv_tvlv.container_list */
2390 	struct hlist_node list;
2391 
2392 	/** @tvlv_hdr: tvlv header information needed to construct the tvlv */
2393 	struct batadv_tvlv_hdr tvlv_hdr;
2394 
2395 	/** @refcount: number of contexts the object is used */
2396 	struct kref refcount;
2397 };
2398 
2399 /**
2400  * struct batadv_tvlv_handler - handler for specific tvlv type and version
2401  */
2402 struct batadv_tvlv_handler {
2403 	/** @list: hlist node for &batadv_priv_tvlv.handler_list */
2404 	struct hlist_node list;
2405 
2406 	/**
2407 	 * @ogm_handler: handler callback which is given the tvlv payload to
2408 	 *  process on incoming OGM packets
2409 	 */
2410 	void (*ogm_handler)(struct batadv_priv *bat_priv,
2411 			    struct batadv_orig_node *orig,
2412 			    u8 flags, void *tvlv_value, u16 tvlv_value_len);
2413 
2414 	/**
2415 	 * @unicast_handler: handler callback which is given the tvlv payload to
2416 	 *  process on incoming unicast tvlv packets
2417 	 */
2418 	int (*unicast_handler)(struct batadv_priv *bat_priv,
2419 			       u8 *src, u8 *dst,
2420 			       void *tvlv_value, u16 tvlv_value_len);
2421 
2422 	/** @type: tvlv type this handler feels responsible for */
2423 	u8 type;
2424 
2425 	/** @version: tvlv version this handler feels responsible for */
2426 	u8 version;
2427 
2428 	/** @flags: tvlv handler flags */
2429 	u8 flags;
2430 
2431 	/** @refcount: number of contexts the object is used */
2432 	struct kref refcount;
2433 
2434 	/** @rcu: struct used for freeing in an RCU-safe manner */
2435 	struct rcu_head rcu;
2436 };
2437 
2438 /**
2439  * enum batadv_tvlv_handler_flags - tvlv handler flags definitions
2440  */
2441 enum batadv_tvlv_handler_flags {
2442 	/**
2443 	 * @BATADV_TVLV_HANDLER_OGM_CIFNOTFND: tvlv ogm processing function
2444 	 *  will call this handler even if its type was not found (with no data)
2445 	 */
2446 	BATADV_TVLV_HANDLER_OGM_CIFNOTFND = BIT(1),
2447 
2448 	/**
2449 	 * @BATADV_TVLV_HANDLER_OGM_CALLED: interval tvlv handling flag - the
2450 	 *  API marks a handler as being called, so it won't be called if the
2451 	 *  BATADV_TVLV_HANDLER_OGM_CIFNOTFND flag was set
2452 	 */
2453 	BATADV_TVLV_HANDLER_OGM_CALLED = BIT(2),
2454 };
2455 
2456 /**
2457  * struct batadv_store_mesh_work - Work queue item to detach add/del interface
2458  *  from sysfs locks
2459  */
2460 struct batadv_store_mesh_work {
2461 	/**
2462 	 * @net_dev: netdevice to add/remove to/from batman-adv soft-interface
2463 	 */
2464 	struct net_device *net_dev;
2465 
2466 	/** @soft_iface_name: name of soft-interface to modify */
2467 	char soft_iface_name[IFNAMSIZ];
2468 
2469 	/** @work: work queue item */
2470 	struct work_struct work;
2471 };
2472 
2473 #endif /* _NET_BATMAN_ADV_TYPES_H_ */
2474