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