Merge branch 'next' of git://git.kernel.org/pub/scm/linux/kernel/git/rzhang/linux
[cascardo/linux.git] / net / batman-adv / types.h
1 /* Copyright (C) 2007-2016  B.A.T.M.A.N. contributors:
2  *
3  * Marek Lindner, Simon Wunderlich
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of version 2 of the GNU General Public
7  * License as published by the Free Software Foundation.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, see <http://www.gnu.org/licenses/>.
16  */
17
18 #ifndef _NET_BATMAN_ADV_TYPES_H_
19 #define _NET_BATMAN_ADV_TYPES_H_
20
21 #ifndef _NET_BATMAN_ADV_MAIN_H_
22 #error only "main.h" can be included directly
23 #endif
24
25 #include <linux/average.h>
26 #include <linux/bitops.h>
27 #include <linux/compiler.h>
28 #include <linux/if_ether.h>
29 #include <linux/kref.h>
30 #include <linux/netdevice.h>
31 #include <linux/netlink.h>
32 #include <linux/sched.h> /* for linux/wait.h */
33 #include <linux/spinlock.h>
34 #include <linux/types.h>
35 #include <linux/wait.h>
36 #include <linux/workqueue.h>
37 #include <uapi/linux/batman_adv.h>
38
39 #include "packet.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  * @BATADV_DHCP_NO: packet is not a dhcp message
58  * @BATADV_DHCP_TO_SERVER: dhcp message is directed to a server
59  * @BATADV_DHCP_TO_CLIENT: dhcp message is directed to a client
60  */
61 enum batadv_dhcp_recipient {
62         BATADV_DHCP_NO = 0,
63         BATADV_DHCP_TO_SERVER,
64         BATADV_DHCP_TO_CLIENT,
65 };
66
67 /**
68  * BATADV_TT_REMOTE_MASK - bitmask selecting the flags that are sent over the
69  *  wire only
70  */
71 #define BATADV_TT_REMOTE_MASK   0x00FF
72
73 /**
74  * BATADV_TT_SYNC_MASK - bitmask of the flags that need to be kept in sync
75  *  among the nodes. These flags are used to compute the global/local CRC
76  */
77 #define BATADV_TT_SYNC_MASK     0x00F0
78
79 /**
80  * struct batadv_hard_iface_bat_iv - per hard-interface B.A.T.M.A.N. IV data
81  * @ogm_buff: buffer holding the OGM packet
82  * @ogm_buff_len: length of the OGM packet buffer
83  * @ogm_seqno: OGM sequence number - used to identify each OGM
84  */
85 struct batadv_hard_iface_bat_iv {
86         unsigned char *ogm_buff;
87         int ogm_buff_len;
88         atomic_t ogm_seqno;
89 };
90
91 /**
92  * enum batadv_v_hard_iface_flags - interface flags useful to B.A.T.M.A.N. V
93  * @BATADV_FULL_DUPLEX: tells if the connection over this link is full-duplex
94  * @BATADV_WARNING_DEFAULT: tells whether we have warned the user that no
95  *  throughput data is available for this interface and that default values are
96  *  assumed.
97  */
98 enum batadv_v_hard_iface_flags {
99         BATADV_FULL_DUPLEX      = BIT(0),
100         BATADV_WARNING_DEFAULT  = BIT(1),
101 };
102
103 /**
104  * struct batadv_hard_iface_bat_v - per hard-interface B.A.T.M.A.N. V data
105  * @elp_interval: time interval between two ELP transmissions
106  * @elp_seqno: current ELP sequence number
107  * @elp_skb: base skb containing the ELP message to send
108  * @elp_wq: workqueue used to schedule ELP transmissions
109  * @throughput_override: throughput override to disable link auto-detection
110  * @flags: interface specific flags
111  */
112 struct batadv_hard_iface_bat_v {
113         atomic_t elp_interval;
114         atomic_t elp_seqno;
115         struct sk_buff *elp_skb;
116         struct delayed_work elp_wq;
117         atomic_t throughput_override;
118         u8 flags;
119 };
120
121 /**
122  * struct batadv_hard_iface - network device known to batman-adv
123  * @list: list node for batadv_hardif_list
124  * @if_num: identificator of the interface
125  * @if_status: status of the interface for batman-adv
126  * @net_dev: pointer to the net_device
127  * @num_bcasts: number of payload re-broadcasts on this interface (ARQ)
128  * @hardif_obj: kobject of the per interface sysfs "mesh" directory
129  * @refcount: number of contexts the object is used
130  * @batman_adv_ptype: packet type describing packets that should be processed by
131  *  batman-adv for this interface
132  * @soft_iface: the batman-adv interface which uses this network interface
133  * @rcu: struct used for freeing in an RCU-safe manner
134  * @bat_iv: per hard-interface B.A.T.M.A.N. IV data
135  * @bat_v: per hard-interface B.A.T.M.A.N. V data
136  * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
137  * @neigh_list: list of unique single hop neighbors via this interface
138  * @neigh_list_lock: lock protecting neigh_list
139  */
140 struct batadv_hard_iface {
141         struct list_head list;
142         s16 if_num;
143         char if_status;
144         struct net_device *net_dev;
145         u8 num_bcasts;
146         struct kobject *hardif_obj;
147         struct kref refcount;
148         struct packet_type batman_adv_ptype;
149         struct net_device *soft_iface;
150         struct rcu_head rcu;
151         struct batadv_hard_iface_bat_iv bat_iv;
152 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
153         struct batadv_hard_iface_bat_v bat_v;
154 #endif
155         struct dentry *debug_dir;
156         struct hlist_head neigh_list;
157         /* neigh_list_lock protects: neigh_list */
158         spinlock_t neigh_list_lock;
159 };
160
161 /**
162  * struct batadv_orig_ifinfo - originator info per outgoing interface
163  * @list: list node for orig_node::ifinfo_list
164  * @if_outgoing: pointer to outgoing hard-interface
165  * @router: router that should be used to reach this originator
166  * @last_real_seqno: last and best known sequence number
167  * @last_ttl: ttl of last received packet
168  * @last_seqno_forwarded: seqno of the OGM which was forwarded last
169  * @batman_seqno_reset: time when the batman seqno window was reset
170  * @refcount: number of contexts the object is used
171  * @rcu: struct used for freeing in an RCU-safe manner
172  */
173 struct batadv_orig_ifinfo {
174         struct hlist_node list;
175         struct batadv_hard_iface *if_outgoing;
176         struct batadv_neigh_node __rcu *router; /* rcu protected pointer */
177         u32 last_real_seqno;
178         u8 last_ttl;
179         u32 last_seqno_forwarded;
180         unsigned long batman_seqno_reset;
181         struct kref refcount;
182         struct rcu_head rcu;
183 };
184
185 /**
186  * struct batadv_frag_table_entry - head in the fragment buffer table
187  * @head: head of list with fragments
188  * @lock: lock to protect the list of fragments
189  * @timestamp: time (jiffie) of last received fragment
190  * @seqno: sequence number of the fragments in the list
191  * @size: accumulated size of packets in list
192  * @total_size: expected size of the assembled packet
193  */
194 struct batadv_frag_table_entry {
195         struct hlist_head head;
196         spinlock_t lock; /* protects head */
197         unsigned long timestamp;
198         u16 seqno;
199         u16 size;
200         u16 total_size;
201 };
202
203 /**
204  * struct batadv_frag_list_entry - entry in a list of fragments
205  * @list: list node information
206  * @skb: fragment
207  * @no: fragment number in the set
208  */
209 struct batadv_frag_list_entry {
210         struct hlist_node list;
211         struct sk_buff *skb;
212         u8 no;
213 };
214
215 /**
216  * struct batadv_vlan_tt - VLAN specific TT attributes
217  * @crc: CRC32 checksum of the entries belonging to this vlan
218  * @num_entries: number of TT entries for this VLAN
219  */
220 struct batadv_vlan_tt {
221         u32 crc;
222         atomic_t num_entries;
223 };
224
225 /**
226  * struct batadv_orig_node_vlan - VLAN specific data per orig_node
227  * @vid: the VLAN identifier
228  * @tt: VLAN specific TT attributes
229  * @list: list node for orig_node::vlan_list
230  * @refcount: number of context where this object is currently in use
231  * @rcu: struct used for freeing in a RCU-safe manner
232  */
233 struct batadv_orig_node_vlan {
234         unsigned short vid;
235         struct batadv_vlan_tt tt;
236         struct hlist_node list;
237         struct kref refcount;
238         struct rcu_head rcu;
239 };
240
241 /**
242  * struct batadv_orig_bat_iv - B.A.T.M.A.N. IV private orig_node members
243  * @bcast_own: set of bitfields (one per hard-interface) where each one counts
244  * the number of our OGMs this orig_node rebroadcasted "back" to us  (relative
245  * to last_real_seqno). Every bitfield is BATADV_TQ_LOCAL_WINDOW_SIZE bits long.
246  * @bcast_own_sum: sum of bcast_own
247  * @ogm_cnt_lock: lock protecting bcast_own, bcast_own_sum,
248  *  neigh_node->bat_iv.real_bits & neigh_node->bat_iv.real_packet_count
249  */
250 struct batadv_orig_bat_iv {
251         unsigned long *bcast_own;
252         u8 *bcast_own_sum;
253         /* ogm_cnt_lock protects: bcast_own, bcast_own_sum,
254          * neigh_node->bat_iv.real_bits & neigh_node->bat_iv.real_packet_count
255          */
256         spinlock_t ogm_cnt_lock;
257 };
258
259 /**
260  * struct batadv_orig_node - structure for orig_list maintaining nodes of mesh
261  * @orig: originator ethernet address
262  * @ifinfo_list: list for routers per outgoing interface
263  * @last_bonding_candidate: pointer to last ifinfo of last used router
264  * @dat_addr: address of the orig node in the distributed hash
265  * @last_seen: time when last packet from this node was received
266  * @bcast_seqno_reset: time when the broadcast seqno window was reset
267  * @mcast_handler_lock: synchronizes mcast-capability and -flag changes
268  * @mcast_flags: multicast flags announced by the orig node
269  * @mcast_want_all_unsnoopables_node: a list node for the
270  *  mcast.want_all_unsnoopables list
271  * @mcast_want_all_ipv4_node: a list node for the mcast.want_all_ipv4 list
272  * @mcast_want_all_ipv6_node: a list node for the mcast.want_all_ipv6 list
273  * @capabilities: announced capabilities of this originator
274  * @capa_initialized: bitfield to remember whether a capability was initialized
275  * @last_ttvn: last seen translation table version number
276  * @tt_buff: last tt changeset this node received from the orig node
277  * @tt_buff_len: length of the last tt changeset this node received from the
278  *  orig node
279  * @tt_buff_lock: lock that protects tt_buff and tt_buff_len
280  * @tt_lock: prevents from updating the table while reading it. Table update is
281  *  made up by two operations (data structure update and metdata -CRC/TTVN-
282  *  recalculation) and they have to be executed atomically in order to avoid
283  *  another thread to read the table/metadata between those.
284  * @bcast_bits: bitfield containing the info which payload broadcast originated
285  *  from this orig node this host already has seen (relative to
286  *  last_bcast_seqno)
287  * @last_bcast_seqno: last broadcast sequence number received by this host
288  * @neigh_list: list of potential next hop neighbor towards this orig node
289  * @neigh_list_lock: lock protecting neigh_list and router
290  * @hash_entry: hlist node for batadv_priv::orig_hash
291  * @bat_priv: pointer to soft_iface this orig node belongs to
292  * @bcast_seqno_lock: lock protecting bcast_bits & last_bcast_seqno
293  * @refcount: number of contexts the object is used
294  * @rcu: struct used for freeing in an RCU-safe manner
295  * @in_coding_list: list of nodes this orig can hear
296  * @out_coding_list: list of nodes that can hear this orig
297  * @in_coding_list_lock: protects in_coding_list
298  * @out_coding_list_lock: protects out_coding_list
299  * @fragments: array with heads for fragment chains
300  * @vlan_list: a list of orig_node_vlan structs, one per VLAN served by the
301  *  originator represented by this object
302  * @vlan_list_lock: lock protecting vlan_list
303  * @bat_iv: B.A.T.M.A.N. IV private structure
304  */
305 struct batadv_orig_node {
306         u8 orig[ETH_ALEN];
307         struct hlist_head ifinfo_list;
308         struct batadv_orig_ifinfo *last_bonding_candidate;
309 #ifdef CONFIG_BATMAN_ADV_DAT
310         batadv_dat_addr_t dat_addr;
311 #endif
312         unsigned long last_seen;
313         unsigned long bcast_seqno_reset;
314 #ifdef CONFIG_BATMAN_ADV_MCAST
315         /* synchronizes mcast tvlv specific orig changes */
316         spinlock_t mcast_handler_lock;
317         u8 mcast_flags;
318         struct hlist_node mcast_want_all_unsnoopables_node;
319         struct hlist_node mcast_want_all_ipv4_node;
320         struct hlist_node mcast_want_all_ipv6_node;
321 #endif
322         unsigned long capabilities;
323         unsigned long capa_initialized;
324         atomic_t last_ttvn;
325         unsigned char *tt_buff;
326         s16 tt_buff_len;
327         spinlock_t tt_buff_lock; /* protects tt_buff & tt_buff_len */
328         /* prevents from changing the table while reading it */
329         spinlock_t tt_lock;
330         DECLARE_BITMAP(bcast_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
331         u32 last_bcast_seqno;
332         struct hlist_head neigh_list;
333         /* neigh_list_lock protects: neigh_list, ifinfo_list,
334          * last_bonding_candidate and router
335          */
336         spinlock_t neigh_list_lock;
337         struct hlist_node hash_entry;
338         struct batadv_priv *bat_priv;
339         /* bcast_seqno_lock protects: bcast_bits & last_bcast_seqno */
340         spinlock_t bcast_seqno_lock;
341         struct kref refcount;
342         struct rcu_head rcu;
343 #ifdef CONFIG_BATMAN_ADV_NC
344         struct list_head in_coding_list;
345         struct list_head out_coding_list;
346         spinlock_t in_coding_list_lock; /* Protects in_coding_list */
347         spinlock_t out_coding_list_lock; /* Protects out_coding_list */
348 #endif
349         struct batadv_frag_table_entry fragments[BATADV_FRAG_BUFFER_COUNT];
350         struct hlist_head vlan_list;
351         spinlock_t vlan_list_lock; /* protects vlan_list */
352         struct batadv_orig_bat_iv bat_iv;
353 };
354
355 /**
356  * enum batadv_orig_capabilities - orig node capabilities
357  * @BATADV_ORIG_CAPA_HAS_DAT: orig node has distributed arp table enabled
358  * @BATADV_ORIG_CAPA_HAS_NC: orig node has network coding enabled
359  * @BATADV_ORIG_CAPA_HAS_TT: orig node has tt capability
360  * @BATADV_ORIG_CAPA_HAS_MCAST: orig node has some multicast capability
361  *  (= orig node announces a tvlv of type BATADV_TVLV_MCAST)
362  */
363 enum batadv_orig_capabilities {
364         BATADV_ORIG_CAPA_HAS_DAT,
365         BATADV_ORIG_CAPA_HAS_NC,
366         BATADV_ORIG_CAPA_HAS_TT,
367         BATADV_ORIG_CAPA_HAS_MCAST,
368 };
369
370 /**
371  * struct batadv_gw_node - structure for orig nodes announcing gw capabilities
372  * @list: list node for batadv_priv_gw::list
373  * @orig_node: pointer to corresponding orig node
374  * @bandwidth_down: advertised uplink download bandwidth
375  * @bandwidth_up: advertised uplink upload bandwidth
376  * @refcount: number of contexts the object is used
377  * @rcu: struct used for freeing in an RCU-safe manner
378  */
379 struct batadv_gw_node {
380         struct hlist_node list;
381         struct batadv_orig_node *orig_node;
382         u32 bandwidth_down;
383         u32 bandwidth_up;
384         struct kref refcount;
385         struct rcu_head rcu;
386 };
387
388 DECLARE_EWMA(throughput, 1024, 8)
389
390 /**
391  * struct batadv_hardif_neigh_node_bat_v - B.A.T.M.A.N. V private neighbor
392  *  information
393  * @throughput: ewma link throughput towards this neighbor
394  * @elp_interval: time interval between two ELP transmissions
395  * @elp_latest_seqno: latest and best known ELP sequence number
396  * @last_unicast_tx: when the last unicast packet has been sent to this neighbor
397  * @metric_work: work queue callback item for metric update
398  */
399 struct batadv_hardif_neigh_node_bat_v {
400         struct ewma_throughput throughput;
401         u32 elp_interval;
402         u32 elp_latest_seqno;
403         unsigned long last_unicast_tx;
404         struct work_struct metric_work;
405 };
406
407 /**
408  * struct batadv_hardif_neigh_node - unique neighbor per hard-interface
409  * @list: list node for batadv_hard_iface::neigh_list
410  * @addr: the MAC address of the neighboring interface
411  * @if_incoming: pointer to incoming hard-interface
412  * @last_seen: when last packet via this neighbor was received
413  * @bat_v: B.A.T.M.A.N. V private data
414  * @refcount: number of contexts the object is used
415  * @rcu: struct used for freeing in a RCU-safe manner
416  */
417 struct batadv_hardif_neigh_node {
418         struct hlist_node list;
419         u8 addr[ETH_ALEN];
420         struct batadv_hard_iface *if_incoming;
421         unsigned long last_seen;
422 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
423         struct batadv_hardif_neigh_node_bat_v bat_v;
424 #endif
425         struct kref refcount;
426         struct rcu_head rcu;
427 };
428
429 /**
430  * struct batadv_neigh_node - structure for single hops neighbors
431  * @list: list node for batadv_orig_node::neigh_list
432  * @orig_node: pointer to corresponding orig_node
433  * @addr: the MAC address of the neighboring interface
434  * @ifinfo_list: list for routing metrics per outgoing interface
435  * @ifinfo_lock: lock protecting private ifinfo members and list
436  * @if_incoming: pointer to incoming hard-interface
437  * @last_seen: when last packet via this neighbor was received
438  * @hardif_neigh: hardif_neigh of this neighbor
439  * @refcount: number of contexts the object is used
440  * @rcu: struct used for freeing in an RCU-safe manner
441  */
442 struct batadv_neigh_node {
443         struct hlist_node list;
444         struct batadv_orig_node *orig_node;
445         u8 addr[ETH_ALEN];
446         struct hlist_head ifinfo_list;
447         spinlock_t ifinfo_lock; /* protects ifinfo_list and its members */
448         struct batadv_hard_iface *if_incoming;
449         unsigned long last_seen;
450         struct batadv_hardif_neigh_node *hardif_neigh;
451         struct kref refcount;
452         struct rcu_head rcu;
453 };
454
455 /**
456  * struct batadv_neigh_ifinfo_bat_iv - neighbor information per outgoing
457  *  interface for B.A.T.M.A.N. IV
458  * @tq_recv: ring buffer of received TQ values from this neigh node
459  * @tq_index: ring buffer index
460  * @tq_avg: averaged tq of all tq values in the ring buffer (tq_recv)
461  * @real_bits: bitfield containing the number of OGMs received from this neigh
462  *  node (relative to orig_node->last_real_seqno)
463  * @real_packet_count: counted result of real_bits
464  */
465 struct batadv_neigh_ifinfo_bat_iv {
466         u8 tq_recv[BATADV_TQ_GLOBAL_WINDOW_SIZE];
467         u8 tq_index;
468         u8 tq_avg;
469         DECLARE_BITMAP(real_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
470         u8 real_packet_count;
471 };
472
473 /**
474  * struct batadv_neigh_ifinfo_bat_v - neighbor information per outgoing
475  *  interface for B.A.T.M.A.N. V
476  * @throughput: last throughput metric received from originator via this neigh
477  * @last_seqno: last sequence number known for this neighbor
478  */
479 struct batadv_neigh_ifinfo_bat_v {
480         u32 throughput;
481         u32 last_seqno;
482 };
483
484 /**
485  * struct batadv_neigh_ifinfo - neighbor information per outgoing interface
486  * @list: list node for batadv_neigh_node::ifinfo_list
487  * @if_outgoing: pointer to outgoing hard-interface
488  * @bat_iv: B.A.T.M.A.N. IV private structure
489  * @bat_v: B.A.T.M.A.N. V private data
490  * @last_ttl: last received ttl from this neigh node
491  * @refcount: number of contexts the object is used
492  * @rcu: struct used for freeing in a RCU-safe manner
493  */
494 struct batadv_neigh_ifinfo {
495         struct hlist_node list;
496         struct batadv_hard_iface *if_outgoing;
497         struct batadv_neigh_ifinfo_bat_iv bat_iv;
498 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
499         struct batadv_neigh_ifinfo_bat_v bat_v;
500 #endif
501         u8 last_ttl;
502         struct kref refcount;
503         struct rcu_head rcu;
504 };
505
506 #ifdef CONFIG_BATMAN_ADV_BLA
507
508 /**
509  * struct batadv_bcast_duplist_entry - structure for LAN broadcast suppression
510  * @orig: mac address of orig node orginating the broadcast
511  * @crc: crc32 checksum of broadcast payload
512  * @entrytime: time when the broadcast packet was received
513  */
514 struct batadv_bcast_duplist_entry {
515         u8 orig[ETH_ALEN];
516         __be32 crc;
517         unsigned long entrytime;
518 };
519 #endif
520
521 /**
522  * enum batadv_counters - indices for traffic counters
523  * @BATADV_CNT_TX: transmitted payload traffic packet counter
524  * @BATADV_CNT_TX_BYTES: transmitted payload traffic bytes counter
525  * @BATADV_CNT_TX_DROPPED: dropped transmission payload traffic packet counter
526  * @BATADV_CNT_RX: received payload traffic packet counter
527  * @BATADV_CNT_RX_BYTES: received payload traffic bytes counter
528  * @BATADV_CNT_FORWARD: forwarded payload traffic packet counter
529  * @BATADV_CNT_FORWARD_BYTES: forwarded payload traffic bytes counter
530  * @BATADV_CNT_MGMT_TX: transmitted routing protocol traffic packet counter
531  * @BATADV_CNT_MGMT_TX_BYTES: transmitted routing protocol traffic bytes counter
532  * @BATADV_CNT_MGMT_RX: received routing protocol traffic packet counter
533  * @BATADV_CNT_MGMT_RX_BYTES: received routing protocol traffic bytes counter
534  * @BATADV_CNT_FRAG_TX: transmitted fragment traffic packet counter
535  * @BATADV_CNT_FRAG_TX_BYTES: transmitted fragment traffic bytes counter
536  * @BATADV_CNT_FRAG_RX: received fragment traffic packet counter
537  * @BATADV_CNT_FRAG_RX_BYTES: received fragment traffic bytes counter
538  * @BATADV_CNT_FRAG_FWD: forwarded fragment traffic packet counter
539  * @BATADV_CNT_FRAG_FWD_BYTES: forwarded fragment traffic bytes counter
540  * @BATADV_CNT_TT_REQUEST_TX: transmitted tt req traffic packet counter
541  * @BATADV_CNT_TT_REQUEST_RX: received tt req traffic packet counter
542  * @BATADV_CNT_TT_RESPONSE_TX: transmitted tt resp traffic packet counter
543  * @BATADV_CNT_TT_RESPONSE_RX: received tt resp traffic packet counter
544  * @BATADV_CNT_TT_ROAM_ADV_TX: transmitted tt roam traffic packet counter
545  * @BATADV_CNT_TT_ROAM_ADV_RX: received tt roam traffic packet counter
546  * @BATADV_CNT_DAT_GET_TX: transmitted dht GET traffic packet counter
547  * @BATADV_CNT_DAT_GET_RX: received dht GET traffic packet counter
548  * @BATADV_CNT_DAT_PUT_TX: transmitted dht PUT traffic packet counter
549  * @BATADV_CNT_DAT_PUT_RX: received dht PUT traffic packet counter
550  * @BATADV_CNT_DAT_CACHED_REPLY_TX: transmitted dat cache reply traffic packet
551  *  counter
552  * @BATADV_CNT_NC_CODE: transmitted nc-combined traffic packet counter
553  * @BATADV_CNT_NC_CODE_BYTES: transmitted nc-combined traffic bytes counter
554  * @BATADV_CNT_NC_RECODE: transmitted nc-recombined traffic packet counter
555  * @BATADV_CNT_NC_RECODE_BYTES: transmitted nc-recombined traffic bytes counter
556  * @BATADV_CNT_NC_BUFFER: counter for packets buffered for later nc decoding
557  * @BATADV_CNT_NC_DECODE: received and nc-decoded traffic packet counter
558  * @BATADV_CNT_NC_DECODE_BYTES: received and nc-decoded traffic bytes counter
559  * @BATADV_CNT_NC_DECODE_FAILED: received and decode-failed traffic packet
560  *  counter
561  * @BATADV_CNT_NC_SNIFFED: counter for nc-decoded packets received in promisc
562  *  mode.
563  * @BATADV_CNT_NUM: number of traffic counters
564  */
565 enum batadv_counters {
566         BATADV_CNT_TX,
567         BATADV_CNT_TX_BYTES,
568         BATADV_CNT_TX_DROPPED,
569         BATADV_CNT_RX,
570         BATADV_CNT_RX_BYTES,
571         BATADV_CNT_FORWARD,
572         BATADV_CNT_FORWARD_BYTES,
573         BATADV_CNT_MGMT_TX,
574         BATADV_CNT_MGMT_TX_BYTES,
575         BATADV_CNT_MGMT_RX,
576         BATADV_CNT_MGMT_RX_BYTES,
577         BATADV_CNT_FRAG_TX,
578         BATADV_CNT_FRAG_TX_BYTES,
579         BATADV_CNT_FRAG_RX,
580         BATADV_CNT_FRAG_RX_BYTES,
581         BATADV_CNT_FRAG_FWD,
582         BATADV_CNT_FRAG_FWD_BYTES,
583         BATADV_CNT_TT_REQUEST_TX,
584         BATADV_CNT_TT_REQUEST_RX,
585         BATADV_CNT_TT_RESPONSE_TX,
586         BATADV_CNT_TT_RESPONSE_RX,
587         BATADV_CNT_TT_ROAM_ADV_TX,
588         BATADV_CNT_TT_ROAM_ADV_RX,
589 #ifdef CONFIG_BATMAN_ADV_DAT
590         BATADV_CNT_DAT_GET_TX,
591         BATADV_CNT_DAT_GET_RX,
592         BATADV_CNT_DAT_PUT_TX,
593         BATADV_CNT_DAT_PUT_RX,
594         BATADV_CNT_DAT_CACHED_REPLY_TX,
595 #endif
596 #ifdef CONFIG_BATMAN_ADV_NC
597         BATADV_CNT_NC_CODE,
598         BATADV_CNT_NC_CODE_BYTES,
599         BATADV_CNT_NC_RECODE,
600         BATADV_CNT_NC_RECODE_BYTES,
601         BATADV_CNT_NC_BUFFER,
602         BATADV_CNT_NC_DECODE,
603         BATADV_CNT_NC_DECODE_BYTES,
604         BATADV_CNT_NC_DECODE_FAILED,
605         BATADV_CNT_NC_SNIFFED,
606 #endif
607         BATADV_CNT_NUM,
608 };
609
610 /**
611  * struct batadv_priv_tt - per mesh interface translation table data
612  * @vn: translation table version number
613  * @ogm_append_cnt: counter of number of OGMs containing the local tt diff
614  * @local_changes: changes registered in an originator interval
615  * @changes_list: tracks tt local changes within an originator interval
616  * @local_hash: local translation table hash table
617  * @global_hash: global translation table hash table
618  * @req_list: list of pending & unanswered tt_requests
619  * @roam_list: list of the last roaming events of each client limiting the
620  *  number of roaming events to avoid route flapping
621  * @changes_list_lock: lock protecting changes_list
622  * @req_list_lock: lock protecting req_list
623  * @roam_list_lock: lock protecting roam_list
624  * @last_changeset: last tt changeset this host has generated
625  * @last_changeset_len: length of last tt changeset this host has generated
626  * @last_changeset_lock: lock protecting last_changeset & last_changeset_len
627  * @commit_lock: prevents from executing a local TT commit while reading the
628  *  local table. The local TT commit is made up by two operations (data
629  *  structure update and metdata -CRC/TTVN- recalculation) and they have to be
630  *  executed atomically in order to avoid another thread to read the
631  *  table/metadata between those.
632  * @work: work queue callback item for translation table purging
633  */
634 struct batadv_priv_tt {
635         atomic_t vn;
636         atomic_t ogm_append_cnt;
637         atomic_t local_changes;
638         struct list_head changes_list;
639         struct batadv_hashtable *local_hash;
640         struct batadv_hashtable *global_hash;
641         struct hlist_head req_list;
642         struct list_head roam_list;
643         spinlock_t changes_list_lock; /* protects changes */
644         spinlock_t req_list_lock; /* protects req_list */
645         spinlock_t roam_list_lock; /* protects roam_list */
646         unsigned char *last_changeset;
647         s16 last_changeset_len;
648         /* protects last_changeset & last_changeset_len */
649         spinlock_t last_changeset_lock;
650         /* prevents from executing a commit while reading the table */
651         spinlock_t commit_lock;
652         struct delayed_work work;
653 };
654
655 #ifdef CONFIG_BATMAN_ADV_BLA
656
657 /**
658  * struct batadv_priv_bla - per mesh interface bridge loope avoidance data
659  * @num_requests: number of bla requests in flight
660  * @claim_hash: hash table containing mesh nodes this host has claimed
661  * @backbone_hash: hash table containing all detected backbone gateways
662  * @loopdetect_addr: MAC address used for own loopdetection frames
663  * @loopdetect_lasttime: time when the loopdetection frames were sent
664  * @loopdetect_next: how many periods to wait for the next loopdetect process
665  * @bcast_duplist: recently received broadcast packets array (for broadcast
666  *  duplicate suppression)
667  * @bcast_duplist_curr: index of last broadcast packet added to bcast_duplist
668  * @bcast_duplist_lock: lock protecting bcast_duplist & bcast_duplist_curr
669  * @claim_dest: local claim data (e.g. claim group)
670  * @work: work queue callback item for cleanups & bla announcements
671  */
672 struct batadv_priv_bla {
673         atomic_t num_requests;
674         struct batadv_hashtable *claim_hash;
675         struct batadv_hashtable *backbone_hash;
676         u8 loopdetect_addr[ETH_ALEN];
677         unsigned long loopdetect_lasttime;
678         atomic_t loopdetect_next;
679         struct batadv_bcast_duplist_entry bcast_duplist[BATADV_DUPLIST_SIZE];
680         int bcast_duplist_curr;
681         /* protects bcast_duplist & bcast_duplist_curr */
682         spinlock_t bcast_duplist_lock;
683         struct batadv_bla_claim_dst claim_dest;
684         struct delayed_work work;
685 };
686 #endif
687
688 #ifdef CONFIG_BATMAN_ADV_DEBUG
689
690 /**
691  * struct batadv_priv_debug_log - debug logging data
692  * @log_buff: buffer holding the logs (ring bufer)
693  * @log_start: index of next character to read
694  * @log_end: index of next character to write
695  * @lock: lock protecting log_buff, log_start & log_end
696  * @queue_wait: log reader's wait queue
697  */
698 struct batadv_priv_debug_log {
699         char log_buff[BATADV_LOG_BUF_LEN];
700         unsigned long log_start;
701         unsigned long log_end;
702         spinlock_t lock; /* protects log_buff, log_start and log_end */
703         wait_queue_head_t queue_wait;
704 };
705 #endif
706
707 /**
708  * struct batadv_priv_gw - per mesh interface gateway data
709  * @list: list of available gateway nodes
710  * @list_lock: lock protecting gw_list & curr_gw
711  * @curr_gw: pointer to currently selected gateway node
712  * @mode: gateway operation: off, client or server (see batadv_gw_modes)
713  * @sel_class: gateway selection class (applies if gw_mode client)
714  * @bandwidth_down: advertised uplink download bandwidth (if gw_mode server)
715  * @bandwidth_up: advertised uplink upload bandwidth (if gw_mode server)
716  * @reselect: bool indicating a gateway re-selection is in progress
717  */
718 struct batadv_priv_gw {
719         struct hlist_head list;
720         spinlock_t list_lock; /* protects gw_list & curr_gw */
721         struct batadv_gw_node __rcu *curr_gw;  /* rcu protected pointer */
722         atomic_t mode;
723         atomic_t sel_class;
724         atomic_t bandwidth_down;
725         atomic_t bandwidth_up;
726         atomic_t reselect;
727 };
728
729 /**
730  * struct batadv_priv_tvlv - per mesh interface tvlv data
731  * @container_list: list of registered tvlv containers to be sent with each OGM
732  * @handler_list: list of the various tvlv content handlers
733  * @container_list_lock: protects tvlv container list access
734  * @handler_list_lock: protects handler list access
735  */
736 struct batadv_priv_tvlv {
737         struct hlist_head container_list;
738         struct hlist_head handler_list;
739         spinlock_t container_list_lock; /* protects container_list */
740         spinlock_t handler_list_lock; /* protects handler_list */
741 };
742
743 #ifdef CONFIG_BATMAN_ADV_DAT
744
745 /**
746  * struct batadv_priv_dat - per mesh interface DAT private data
747  * @addr: node DAT address
748  * @hash: hashtable representing the local ARP cache
749  * @work: work queue callback item for cache purging
750  */
751 struct batadv_priv_dat {
752         batadv_dat_addr_t addr;
753         struct batadv_hashtable *hash;
754         struct delayed_work work;
755 };
756 #endif
757
758 #ifdef CONFIG_BATMAN_ADV_MCAST
759 /**
760  * struct batadv_mcast_querier_state - IGMP/MLD querier state when bridged
761  * @exists: whether a querier exists in the mesh
762  * @shadowing: if a querier exists, whether it is potentially shadowing
763  *  multicast listeners (i.e. querier is behind our own bridge segment)
764  */
765 struct batadv_mcast_querier_state {
766         bool exists;
767         bool shadowing;
768 };
769
770 /**
771  * struct batadv_priv_mcast - per mesh interface mcast data
772  * @mla_list: list of multicast addresses we are currently announcing via TT
773  * @want_all_unsnoopables_list: a list of orig_nodes wanting all unsnoopable
774  *  multicast traffic
775  * @want_all_ipv4_list: a list of orig_nodes wanting all IPv4 multicast traffic
776  * @want_all_ipv6_list: a list of orig_nodes wanting all IPv6 multicast traffic
777  * @querier_ipv4: the current state of an IGMP querier in the mesh
778  * @querier_ipv6: the current state of an MLD querier in the mesh
779  * @flags: the flags we have last sent in our mcast tvlv
780  * @enabled: whether the multicast tvlv is currently enabled
781  * @bridged: whether the soft interface has a bridge on top
782  * @num_disabled: number of nodes that have no mcast tvlv
783  * @num_want_all_unsnoopables: number of nodes wanting unsnoopable IP traffic
784  * @num_want_all_ipv4: counter for items in want_all_ipv4_list
785  * @num_want_all_ipv6: counter for items in want_all_ipv6_list
786  * @want_lists_lock: lock for protecting modifications to mcast want lists
787  *  (traversals are rcu-locked)
788  */
789 struct batadv_priv_mcast {
790         struct hlist_head mla_list;
791         struct hlist_head want_all_unsnoopables_list;
792         struct hlist_head want_all_ipv4_list;
793         struct hlist_head want_all_ipv6_list;
794         struct batadv_mcast_querier_state querier_ipv4;
795         struct batadv_mcast_querier_state querier_ipv6;
796         u8 flags;
797         bool enabled;
798         bool bridged;
799         atomic_t num_disabled;
800         atomic_t num_want_all_unsnoopables;
801         atomic_t num_want_all_ipv4;
802         atomic_t num_want_all_ipv6;
803         /* protects want_all_{unsnoopables,ipv4,ipv6}_list */
804         spinlock_t want_lists_lock;
805 };
806 #endif
807
808 /**
809  * struct batadv_priv_nc - per mesh interface network coding private data
810  * @work: work queue callback item for cleanup
811  * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
812  * @min_tq: only consider neighbors for encoding if neigh_tq > min_tq
813  * @max_fwd_delay: maximum packet forward delay to allow coding of packets
814  * @max_buffer_time: buffer time for sniffed packets used to decoding
815  * @timestamp_fwd_flush: timestamp of last forward packet queue flush
816  * @timestamp_sniffed_purge: timestamp of last sniffed packet queue purge
817  * @coding_hash: Hash table used to buffer skbs while waiting for another
818  *  incoming skb to code it with. Skbs are added to the buffer just before being
819  *  forwarded in routing.c
820  * @decoding_hash: Hash table used to buffer skbs that might be needed to decode
821  *  a received coded skb. The buffer is used for 1) skbs arriving on the
822  *  soft-interface; 2) skbs overheard on the hard-interface; and 3) skbs
823  *  forwarded by batman-adv.
824  */
825 struct batadv_priv_nc {
826         struct delayed_work work;
827         struct dentry *debug_dir;
828         u8 min_tq;
829         u32 max_fwd_delay;
830         u32 max_buffer_time;
831         unsigned long timestamp_fwd_flush;
832         unsigned long timestamp_sniffed_purge;
833         struct batadv_hashtable *coding_hash;
834         struct batadv_hashtable *decoding_hash;
835 };
836
837 /**
838  * struct batadv_tp_unacked - unacked packet meta-information
839  * @seqno: seqno of the unacked packet
840  * @len: length of the packet
841  * @list: list node for batadv_tp_vars::unacked_list
842  *
843  * This struct is supposed to represent a buffer unacked packet. However, since
844  * the purpose of the TP meter is to count the traffic only, there is no need to
845  * store the entire sk_buff, the starting offset and the length are enough
846  */
847 struct batadv_tp_unacked {
848         u32 seqno;
849         u16 len;
850         struct list_head list;
851 };
852
853 /**
854  * enum batadv_tp_meter_role - Modus in tp meter session
855  * @BATADV_TP_RECEIVER: Initialized as receiver
856  * @BATADV_TP_SENDER: Initialized as sender
857  */
858 enum batadv_tp_meter_role {
859         BATADV_TP_RECEIVER,
860         BATADV_TP_SENDER
861 };
862
863 /**
864  * struct batadv_tp_vars - tp meter private variables per session
865  * @list: list node for bat_priv::tp_list
866  * @timer: timer for ack (receiver) and retry (sender)
867  * @bat_priv: pointer to the mesh object
868  * @start_time: start time in jiffies
869  * @other_end: mac address of remote
870  * @role: receiver/sender modi
871  * @sending: sending binary semaphore: 1 if sending, 0 is not
872  * @reason: reason for a stopped session
873  * @finish_work: work item for the finishing procedure
874  * @test_length: test length in milliseconds
875  * @session: TP session identifier
876  * @icmp_uid: local ICMP "socket" index
877  * @dec_cwnd: decimal part of the cwnd used during linear growth
878  * @cwnd: current size of the congestion window
879  * @cwnd_lock: lock do protect @cwnd & @dec_cwnd
880  * @ss_threshold: Slow Start threshold. Once cwnd exceeds this value the
881  *  connection switches to the Congestion Avoidance state
882  * @last_acked: last acked byte
883  * @last_sent: last sent byte, not yet acked
884  * @tot_sent: amount of data sent/ACKed so far
885  * @dup_acks: duplicate ACKs counter
886  * @fast_recovery: true if in Fast Recovery mode
887  * @recover: last sent seqno when entering Fast Recovery
888  * @rto: sender timeout
889  * @srtt: smoothed RTT scaled by 2^3
890  * @rttvar: RTT variation scaled by 2^2
891  * @more_bytes: waiting queue anchor when waiting for more ack/retry timeout
892  * @prerandom_offset: offset inside the prerandom buffer
893  * @prerandom_lock: spinlock protecting access to prerandom_offset
894  * @last_recv: last in-order received packet
895  * @unacked_list: list of unacked packets (meta-info only)
896  * @unacked_lock: protect unacked_list
897  * @last_recv_time: time time (jiffies) a msg was received
898  * @refcount: number of context where the object is used
899  * @rcu: struct used for freeing in an RCU-safe manner
900  */
901 struct batadv_tp_vars {
902         struct hlist_node list;
903         struct timer_list timer;
904         struct batadv_priv *bat_priv;
905         unsigned long start_time;
906         u8 other_end[ETH_ALEN];
907         enum batadv_tp_meter_role role;
908         atomic_t sending;
909         enum batadv_tp_meter_reason reason;
910         struct delayed_work finish_work;
911         u32 test_length;
912         u8 session[2];
913         u8 icmp_uid;
914
915         /* sender variables */
916         u16 dec_cwnd;
917         u32 cwnd;
918         spinlock_t cwnd_lock; /* Protects cwnd & dec_cwnd */
919         u32 ss_threshold;
920         atomic_t last_acked;
921         u32 last_sent;
922         atomic64_t tot_sent;
923         atomic_t dup_acks;
924         bool fast_recovery;
925         u32 recover;
926         u32 rto;
927         u32 srtt;
928         u32 rttvar;
929         wait_queue_head_t more_bytes;
930         u32 prerandom_offset;
931         spinlock_t prerandom_lock; /* Protects prerandom_offset */
932
933         /* receiver variables */
934         u32 last_recv;
935         struct list_head unacked_list;
936         spinlock_t unacked_lock; /* Protects unacked_list */
937         unsigned long last_recv_time;
938         struct kref refcount;
939         struct rcu_head rcu;
940 };
941
942 /**
943  * struct batadv_softif_vlan - per VLAN attributes set
944  * @bat_priv: pointer to the mesh object
945  * @vid: VLAN identifier
946  * @kobj: kobject for sysfs vlan subdirectory
947  * @ap_isolation: AP isolation state
948  * @tt: TT private attributes (VLAN specific)
949  * @list: list node for bat_priv::softif_vlan_list
950  * @refcount: number of context where this object is currently in use
951  * @rcu: struct used for freeing in a RCU-safe manner
952  */
953 struct batadv_softif_vlan {
954         struct batadv_priv *bat_priv;
955         unsigned short vid;
956         struct kobject *kobj;
957         atomic_t ap_isolation;          /* boolean */
958         struct batadv_vlan_tt tt;
959         struct hlist_node list;
960         struct kref refcount;
961         struct rcu_head rcu;
962 };
963
964 /**
965  * struct batadv_priv_bat_v - B.A.T.M.A.N. V per soft-interface private data
966  * @ogm_buff: buffer holding the OGM packet
967  * @ogm_buff_len: length of the OGM packet buffer
968  * @ogm_seqno: OGM sequence number - used to identify each OGM
969  * @ogm_wq: workqueue used to schedule OGM transmissions
970  */
971 struct batadv_priv_bat_v {
972         unsigned char *ogm_buff;
973         int ogm_buff_len;
974         atomic_t ogm_seqno;
975         struct delayed_work ogm_wq;
976 };
977
978 /**
979  * struct batadv_priv - per mesh interface data
980  * @mesh_state: current status of the mesh (inactive/active/deactivating)
981  * @soft_iface: net device which holds this struct as private data
982  * @stats: structure holding the data for the ndo_get_stats() call
983  * @bat_counters: mesh internal traffic statistic counters (see batadv_counters)
984  * @aggregated_ogms: bool indicating whether OGM aggregation is enabled
985  * @bonding: bool indicating whether traffic bonding is enabled
986  * @fragmentation: bool indicating whether traffic fragmentation is enabled
987  * @packet_size_max: max packet size that can be transmitted via
988  *  multiple fragmented skbs or a single frame if fragmentation is disabled
989  * @frag_seqno: incremental counter to identify chains of egress fragments
990  * @bridge_loop_avoidance: bool indicating whether bridge loop avoidance is
991  *  enabled
992  * @distributed_arp_table: bool indicating whether distributed ARP table is
993  *  enabled
994  * @multicast_mode: Enable or disable multicast optimizations on this node's
995  *  sender/originating side
996  * @orig_interval: OGM broadcast interval in milliseconds
997  * @hop_penalty: penalty which will be applied to an OGM's tq-field on every hop
998  * @log_level: configured log level (see batadv_dbg_level)
999  * @isolation_mark: the skb->mark value used to match packets for AP isolation
1000  * @isolation_mark_mask: bitmask identifying the bits in skb->mark to be used
1001  *  for the isolation mark
1002  * @bcast_seqno: last sent broadcast packet sequence number
1003  * @bcast_queue_left: number of remaining buffered broadcast packet slots
1004  * @batman_queue_left: number of remaining OGM packet slots
1005  * @num_ifaces: number of interfaces assigned to this mesh interface
1006  * @mesh_obj: kobject for sysfs mesh subdirectory
1007  * @debug_dir: dentry for debugfs batman-adv subdirectory
1008  * @forw_bat_list: list of aggregated OGMs that will be forwarded
1009  * @forw_bcast_list: list of broadcast packets that will be rebroadcasted
1010  * @tp_list: list of tp sessions
1011  * @tp_num: number of currently active tp sessions
1012  * @orig_hash: hash table containing mesh participants (orig nodes)
1013  * @forw_bat_list_lock: lock protecting forw_bat_list
1014  * @forw_bcast_list_lock: lock protecting forw_bcast_list
1015  * @tp_list_lock: spinlock protecting @tp_list
1016  * @orig_work: work queue callback item for orig node purging
1017  * @primary_if: one of the hard-interfaces assigned to this mesh interface
1018  *  becomes the primary interface
1019  * @algo_ops: routing algorithm used by this mesh interface
1020  * @softif_vlan_list: a list of softif_vlan structs, one per VLAN created on top
1021  *  of the mesh interface represented by this object
1022  * @softif_vlan_list_lock: lock protecting softif_vlan_list
1023  * @bla: bridge loope avoidance data
1024  * @debug_log: holding debug logging relevant data
1025  * @gw: gateway data
1026  * @tt: translation table data
1027  * @tvlv: type-version-length-value data
1028  * @dat: distributed arp table data
1029  * @mcast: multicast data
1030  * @network_coding: bool indicating whether network coding is enabled
1031  * @nc: network coding data
1032  * @bat_v: B.A.T.M.A.N. V per soft-interface private data
1033  */
1034 struct batadv_priv {
1035         atomic_t mesh_state;
1036         struct net_device *soft_iface;
1037         struct net_device_stats stats;
1038         u64 __percpu *bat_counters; /* Per cpu counters */
1039         atomic_t aggregated_ogms;
1040         atomic_t bonding;
1041         atomic_t fragmentation;
1042         atomic_t packet_size_max;
1043         atomic_t frag_seqno;
1044 #ifdef CONFIG_BATMAN_ADV_BLA
1045         atomic_t bridge_loop_avoidance;
1046 #endif
1047 #ifdef CONFIG_BATMAN_ADV_DAT
1048         atomic_t distributed_arp_table;
1049 #endif
1050 #ifdef CONFIG_BATMAN_ADV_MCAST
1051         atomic_t multicast_mode;
1052 #endif
1053         atomic_t orig_interval;
1054         atomic_t hop_penalty;
1055 #ifdef CONFIG_BATMAN_ADV_DEBUG
1056         atomic_t log_level;
1057 #endif
1058         u32 isolation_mark;
1059         u32 isolation_mark_mask;
1060         atomic_t bcast_seqno;
1061         atomic_t bcast_queue_left;
1062         atomic_t batman_queue_left;
1063         char num_ifaces;
1064         struct kobject *mesh_obj;
1065         struct dentry *debug_dir;
1066         struct hlist_head forw_bat_list;
1067         struct hlist_head forw_bcast_list;
1068         struct hlist_head tp_list;
1069         struct batadv_hashtable *orig_hash;
1070         spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
1071         spinlock_t forw_bcast_list_lock; /* protects forw_bcast_list */
1072         spinlock_t tp_list_lock; /* protects tp_list */
1073         atomic_t tp_num;
1074         struct delayed_work orig_work;
1075         struct batadv_hard_iface __rcu *primary_if;  /* rcu protected pointer */
1076         struct batadv_algo_ops *algo_ops;
1077         struct hlist_head softif_vlan_list;
1078         spinlock_t softif_vlan_list_lock; /* protects softif_vlan_list */
1079 #ifdef CONFIG_BATMAN_ADV_BLA
1080         struct batadv_priv_bla bla;
1081 #endif
1082 #ifdef CONFIG_BATMAN_ADV_DEBUG
1083         struct batadv_priv_debug_log *debug_log;
1084 #endif
1085         struct batadv_priv_gw gw;
1086         struct batadv_priv_tt tt;
1087         struct batadv_priv_tvlv tvlv;
1088 #ifdef CONFIG_BATMAN_ADV_DAT
1089         struct batadv_priv_dat dat;
1090 #endif
1091 #ifdef CONFIG_BATMAN_ADV_MCAST
1092         struct batadv_priv_mcast mcast;
1093 #endif
1094 #ifdef CONFIG_BATMAN_ADV_NC
1095         atomic_t network_coding;
1096         struct batadv_priv_nc nc;
1097 #endif /* CONFIG_BATMAN_ADV_NC */
1098 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
1099         struct batadv_priv_bat_v bat_v;
1100 #endif
1101 };
1102
1103 /**
1104  * struct batadv_socket_client - layer2 icmp socket client data
1105  * @queue_list: packet queue for packets destined for this socket client
1106  * @queue_len: number of packets in the packet queue (queue_list)
1107  * @index: socket client's index in the batadv_socket_client_hash
1108  * @lock: lock protecting queue_list, queue_len & index
1109  * @queue_wait: socket client's wait queue
1110  * @bat_priv: pointer to soft_iface this client belongs to
1111  */
1112 struct batadv_socket_client {
1113         struct list_head queue_list;
1114         unsigned int queue_len;
1115         unsigned char index;
1116         spinlock_t lock; /* protects queue_list, queue_len & index */
1117         wait_queue_head_t queue_wait;
1118         struct batadv_priv *bat_priv;
1119 };
1120
1121 /**
1122  * struct batadv_socket_packet - layer2 icmp packet for socket client
1123  * @list: list node for batadv_socket_client::queue_list
1124  * @icmp_len: size of the layer2 icmp packet
1125  * @icmp_packet: layer2 icmp packet
1126  */
1127 struct batadv_socket_packet {
1128         struct list_head list;
1129         size_t icmp_len;
1130         u8 icmp_packet[BATADV_ICMP_MAX_PACKET_SIZE];
1131 };
1132
1133 #ifdef CONFIG_BATMAN_ADV_BLA
1134
1135 /**
1136  * struct batadv_bla_backbone_gw - batman-adv gateway bridged into the LAN
1137  * @orig: originator address of backbone node (mac address of primary iface)
1138  * @vid: vlan id this gateway was detected on
1139  * @hash_entry: hlist node for batadv_priv_bla::backbone_hash
1140  * @bat_priv: pointer to soft_iface this backbone gateway belongs to
1141  * @lasttime: last time we heard of this backbone gw
1142  * @wait_periods: grace time for bridge forward delays and bla group forming at
1143  *  bootup phase - no bcast traffic is formwared until it has elapsed
1144  * @request_sent: if this bool is set to true we are out of sync with this
1145  *  backbone gateway - no bcast traffic is formwared until the situation was
1146  *  resolved
1147  * @crc: crc16 checksum over all claims
1148  * @crc_lock: lock protecting crc
1149  * @report_work: work struct for reporting detected loops
1150  * @refcount: number of contexts the object is used
1151  * @rcu: struct used for freeing in an RCU-safe manner
1152  */
1153 struct batadv_bla_backbone_gw {
1154         u8 orig[ETH_ALEN];
1155         unsigned short vid;
1156         struct hlist_node hash_entry;
1157         struct batadv_priv *bat_priv;
1158         unsigned long lasttime;
1159         atomic_t wait_periods;
1160         atomic_t request_sent;
1161         u16 crc;
1162         spinlock_t crc_lock; /* protects crc */
1163         struct work_struct report_work;
1164         struct kref refcount;
1165         struct rcu_head rcu;
1166 };
1167
1168 /**
1169  * struct batadv_bla_claim - claimed non-mesh client structure
1170  * @addr: mac address of claimed non-mesh client
1171  * @vid: vlan id this client was detected on
1172  * @backbone_gw: pointer to backbone gw claiming this client
1173  * @backbone_lock: lock protecting backbone_gw pointer
1174  * @lasttime: last time we heard of claim (locals only)
1175  * @hash_entry: hlist node for batadv_priv_bla::claim_hash
1176  * @refcount: number of contexts the object is used
1177  * @rcu: struct used for freeing in an RCU-safe manner
1178  */
1179 struct batadv_bla_claim {
1180         u8 addr[ETH_ALEN];
1181         unsigned short vid;
1182         struct batadv_bla_backbone_gw *backbone_gw;
1183         spinlock_t backbone_lock; /* protects backbone_gw */
1184         unsigned long lasttime;
1185         struct hlist_node hash_entry;
1186         struct rcu_head rcu;
1187         struct kref refcount;
1188 };
1189 #endif
1190
1191 /**
1192  * struct batadv_tt_common_entry - tt local & tt global common data
1193  * @addr: mac address of non-mesh client
1194  * @vid: VLAN identifier
1195  * @hash_entry: hlist node for batadv_priv_tt::local_hash or for
1196  *  batadv_priv_tt::global_hash
1197  * @flags: various state handling flags (see batadv_tt_client_flags)
1198  * @added_at: timestamp used for purging stale tt common entries
1199  * @refcount: number of contexts the object is used
1200  * @rcu: struct used for freeing in an RCU-safe manner
1201  */
1202 struct batadv_tt_common_entry {
1203         u8 addr[ETH_ALEN];
1204         unsigned short vid;
1205         struct hlist_node hash_entry;
1206         u16 flags;
1207         unsigned long added_at;
1208         struct kref refcount;
1209         struct rcu_head rcu;
1210 };
1211
1212 /**
1213  * struct batadv_tt_local_entry - translation table local entry data
1214  * @common: general translation table data
1215  * @last_seen: timestamp used for purging stale tt local entries
1216  * @vlan: soft-interface vlan of the entry
1217  */
1218 struct batadv_tt_local_entry {
1219         struct batadv_tt_common_entry common;
1220         unsigned long last_seen;
1221         struct batadv_softif_vlan *vlan;
1222 };
1223
1224 /**
1225  * struct batadv_tt_global_entry - translation table global entry data
1226  * @common: general translation table data
1227  * @orig_list: list of orig nodes announcing this non-mesh client
1228  * @orig_list_count: number of items in the orig_list
1229  * @list_lock: lock protecting orig_list
1230  * @roam_at: time at which TT_GLOBAL_ROAM was set
1231  */
1232 struct batadv_tt_global_entry {
1233         struct batadv_tt_common_entry common;
1234         struct hlist_head orig_list;
1235         atomic_t orig_list_count;
1236         spinlock_t list_lock;   /* protects orig_list */
1237         unsigned long roam_at;
1238 };
1239
1240 /**
1241  * struct batadv_tt_orig_list_entry - orig node announcing a non-mesh client
1242  * @orig_node: pointer to orig node announcing this non-mesh client
1243  * @ttvn: translation table version number which added the non-mesh client
1244  * @list: list node for batadv_tt_global_entry::orig_list
1245  * @refcount: number of contexts the object is used
1246  * @rcu: struct used for freeing in an RCU-safe manner
1247  */
1248 struct batadv_tt_orig_list_entry {
1249         struct batadv_orig_node *orig_node;
1250         u8 ttvn;
1251         struct hlist_node list;
1252         struct kref refcount;
1253         struct rcu_head rcu;
1254 };
1255
1256 /**
1257  * struct batadv_tt_change_node - structure for tt changes occurred
1258  * @list: list node for batadv_priv_tt::changes_list
1259  * @change: holds the actual translation table diff data
1260  */
1261 struct batadv_tt_change_node {
1262         struct list_head list;
1263         struct batadv_tvlv_tt_change change;
1264 };
1265
1266 /**
1267  * struct batadv_tt_req_node - data to keep track of the tt requests in flight
1268  * @addr: mac address address of the originator this request was sent to
1269  * @issued_at: timestamp used for purging stale tt requests
1270  * @refcount: number of contexts the object is used by
1271  * @list: list node for batadv_priv_tt::req_list
1272  */
1273 struct batadv_tt_req_node {
1274         u8 addr[ETH_ALEN];
1275         unsigned long issued_at;
1276         struct kref refcount;
1277         struct hlist_node list;
1278 };
1279
1280 /**
1281  * struct batadv_tt_roam_node - roaming client data
1282  * @addr: mac address of the client in the roaming phase
1283  * @counter: number of allowed roaming events per client within a single
1284  *  OGM interval (changes are committed with each OGM)
1285  * @first_time: timestamp used for purging stale roaming node entries
1286  * @list: list node for batadv_priv_tt::roam_list
1287  */
1288 struct batadv_tt_roam_node {
1289         u8 addr[ETH_ALEN];
1290         atomic_t counter;
1291         unsigned long first_time;
1292         struct list_head list;
1293 };
1294
1295 /**
1296  * struct batadv_nc_node - network coding node
1297  * @list: next and prev pointer for the list handling
1298  * @addr: the node's mac address
1299  * @refcount: number of contexts the object is used by
1300  * @rcu: struct used for freeing in an RCU-safe manner
1301  * @orig_node: pointer to corresponding orig node struct
1302  * @last_seen: timestamp of last ogm received from this node
1303  */
1304 struct batadv_nc_node {
1305         struct list_head list;
1306         u8 addr[ETH_ALEN];
1307         struct kref refcount;
1308         struct rcu_head rcu;
1309         struct batadv_orig_node *orig_node;
1310         unsigned long last_seen;
1311 };
1312
1313 /**
1314  * struct batadv_nc_path - network coding path
1315  * @hash_entry: next and prev pointer for the list handling
1316  * @rcu: struct used for freeing in an RCU-safe manner
1317  * @refcount: number of contexts the object is used by
1318  * @packet_list: list of buffered packets for this path
1319  * @packet_list_lock: access lock for packet list
1320  * @next_hop: next hop (destination) of path
1321  * @prev_hop: previous hop (source) of path
1322  * @last_valid: timestamp for last validation of path
1323  */
1324 struct batadv_nc_path {
1325         struct hlist_node hash_entry;
1326         struct rcu_head rcu;
1327         struct kref refcount;
1328         struct list_head packet_list;
1329         spinlock_t packet_list_lock; /* Protects packet_list */
1330         u8 next_hop[ETH_ALEN];
1331         u8 prev_hop[ETH_ALEN];
1332         unsigned long last_valid;
1333 };
1334
1335 /**
1336  * struct batadv_nc_packet - network coding packet used when coding and
1337  *  decoding packets
1338  * @list: next and prev pointer for the list handling
1339  * @packet_id: crc32 checksum of skb data
1340  * @timestamp: field containing the info when the packet was added to path
1341  * @neigh_node: pointer to original next hop neighbor of skb
1342  * @skb: skb which can be encoded or used for decoding
1343  * @nc_path: pointer to path this nc packet is attached to
1344  */
1345 struct batadv_nc_packet {
1346         struct list_head list;
1347         __be32 packet_id;
1348         unsigned long timestamp;
1349         struct batadv_neigh_node *neigh_node;
1350         struct sk_buff *skb;
1351         struct batadv_nc_path *nc_path;
1352 };
1353
1354 /**
1355  * struct batadv_skb_cb - control buffer structure used to store private data
1356  *  relevant to batman-adv in the skb->cb buffer in skbs.
1357  * @decoded: Marks a skb as decoded, which is checked when searching for coding
1358  *  opportunities in network-coding.c
1359  */
1360 struct batadv_skb_cb {
1361         bool decoded;
1362 };
1363
1364 /**
1365  * struct batadv_forw_packet - structure for bcast packets to be sent/forwarded
1366  * @list: list node for batadv_socket_client::queue_list
1367  * @send_time: execution time for delayed_work (packet sending)
1368  * @own: bool for locally generated packets (local OGMs are re-scheduled after
1369  *  sending)
1370  * @skb: bcast packet's skb buffer
1371  * @packet_len: size of aggregated OGM packet inside the skb buffer
1372  * @direct_link_flags: direct link flags for aggregated OGM packets
1373  * @num_packets: counter for bcast packet retransmission
1374  * @delayed_work: work queue callback item for packet sending
1375  * @if_incoming: pointer to incoming hard-iface or primary iface if
1376  *  locally generated packet
1377  * @if_outgoing: packet where the packet should be sent to, or NULL if
1378  *  unspecified
1379  * @queue_left: The queue (counter) this packet was applied to
1380  */
1381 struct batadv_forw_packet {
1382         struct hlist_node list;
1383         unsigned long send_time;
1384         u8 own;
1385         struct sk_buff *skb;
1386         u16 packet_len;
1387         u32 direct_link_flags;
1388         u8 num_packets;
1389         struct delayed_work delayed_work;
1390         struct batadv_hard_iface *if_incoming;
1391         struct batadv_hard_iface *if_outgoing;
1392         atomic_t *queue_left;
1393 };
1394
1395 /**
1396  * struct batadv_algo_iface_ops - mesh algorithm callbacks (interface specific)
1397  * @activate: start routing mechanisms when hard-interface is brought up
1398  *  (optional)
1399  * @enable: init routing info when hard-interface is enabled
1400  * @disable: de-init routing info when hard-interface is disabled
1401  * @update_mac: (re-)init mac addresses of the protocol information
1402  *  belonging to this hard-interface
1403  * @primary_set: called when primary interface is selected / changed
1404  */
1405 struct batadv_algo_iface_ops {
1406         void (*activate)(struct batadv_hard_iface *hard_iface);
1407         int (*enable)(struct batadv_hard_iface *hard_iface);
1408         void (*disable)(struct batadv_hard_iface *hard_iface);
1409         void (*update_mac)(struct batadv_hard_iface *hard_iface);
1410         void (*primary_set)(struct batadv_hard_iface *hard_iface);
1411 };
1412
1413 /**
1414  * struct batadv_algo_neigh_ops - mesh algorithm callbacks (neighbour specific)
1415  * @hardif_init: called on creation of single hop entry
1416  *  (optional)
1417  * @cmp: compare the metrics of two neighbors for their respective outgoing
1418  *  interfaces
1419  * @is_similar_or_better: check if neigh1 is equally similar or better than
1420  *  neigh2 for their respective outgoing interface from the metric prospective
1421  * @print: print the single hop neighbor list (optional)
1422  * @dump: dump neighbors to a netlink socket (optional)
1423  */
1424 struct batadv_algo_neigh_ops {
1425         void (*hardif_init)(struct batadv_hardif_neigh_node *neigh);
1426         int (*cmp)(struct batadv_neigh_node *neigh1,
1427                    struct batadv_hard_iface *if_outgoing1,
1428                    struct batadv_neigh_node *neigh2,
1429                    struct batadv_hard_iface *if_outgoing2);
1430         bool (*is_similar_or_better)(struct batadv_neigh_node *neigh1,
1431                                      struct batadv_hard_iface *if_outgoing1,
1432                                      struct batadv_neigh_node *neigh2,
1433                                      struct batadv_hard_iface *if_outgoing2);
1434 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
1435         void (*print)(struct batadv_priv *priv, struct seq_file *seq);
1436 #endif
1437         void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
1438                      struct batadv_priv *priv,
1439                      struct batadv_hard_iface *hard_iface);
1440 };
1441
1442 /**
1443  * struct batadv_algo_orig_ops - mesh algorithm callbacks (originator specific)
1444  * @free: free the resources allocated by the routing algorithm for an orig_node
1445  *  object (optional)
1446  * @add_if: ask the routing algorithm to apply the needed changes to the
1447  *  orig_node due to a new hard-interface being added into the mesh (optional)
1448  * @del_if: ask the routing algorithm to apply the needed changes to the
1449  *  orig_node due to an hard-interface being removed from the mesh (optional)
1450  * @print: print the originator table (optional)
1451  * @dump: dump originators to a netlink socket (optional)
1452  */
1453 struct batadv_algo_orig_ops {
1454         void (*free)(struct batadv_orig_node *orig_node);
1455         int (*add_if)(struct batadv_orig_node *orig_node, int max_if_num);
1456         int (*del_if)(struct batadv_orig_node *orig_node, int max_if_num,
1457                       int del_if_num);
1458 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
1459         void (*print)(struct batadv_priv *priv, struct seq_file *seq,
1460                       struct batadv_hard_iface *hard_iface);
1461 #endif
1462         void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
1463                      struct batadv_priv *priv,
1464                      struct batadv_hard_iface *hard_iface);
1465 };
1466
1467 /**
1468  * struct batadv_algo_gw_ops - mesh algorithm callbacks (GW specific)
1469  * @store_sel_class: parse and stores a new GW selection class (optional)
1470  * @show_sel_class: prints the current GW selection class (optional)
1471  * @get_best_gw_node: select the best GW from the list of available nodes
1472  *  (optional)
1473  * @is_eligible: check if a newly discovered GW is a potential candidate for
1474  *  the election as best GW (optional)
1475  * @print: print the gateway table (optional)
1476  * @dump: dump gateways to a netlink socket (optional)
1477  */
1478 struct batadv_algo_gw_ops {
1479         ssize_t (*store_sel_class)(struct batadv_priv *bat_priv, char *buff,
1480                                    size_t count);
1481         ssize_t (*show_sel_class)(struct batadv_priv *bat_priv, char *buff);
1482         struct batadv_gw_node *(*get_best_gw_node)
1483                 (struct batadv_priv *bat_priv);
1484         bool (*is_eligible)(struct batadv_priv *bat_priv,
1485                             struct batadv_orig_node *curr_gw_orig,
1486                             struct batadv_orig_node *orig_node);
1487 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
1488         void (*print)(struct batadv_priv *bat_priv, struct seq_file *seq);
1489 #endif
1490         void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
1491                      struct batadv_priv *priv);
1492 };
1493
1494 /**
1495  * struct batadv_algo_ops - mesh algorithm callbacks
1496  * @list: list node for the batadv_algo_list
1497  * @name: name of the algorithm
1498  * @iface: callbacks related to interface handling
1499  * @neigh: callbacks related to neighbors handling
1500  * @orig: callbacks related to originators handling
1501  * @gw: callbacks related to GW mode
1502  */
1503 struct batadv_algo_ops {
1504         struct hlist_node list;
1505         char *name;
1506         struct batadv_algo_iface_ops iface;
1507         struct batadv_algo_neigh_ops neigh;
1508         struct batadv_algo_orig_ops orig;
1509         struct batadv_algo_gw_ops gw;
1510 };
1511
1512 /**
1513  * struct batadv_dat_entry - it is a single entry of batman-adv ARP backend. It
1514  * is used to stored ARP entries needed for the global DAT cache
1515  * @ip: the IPv4 corresponding to this DAT/ARP entry
1516  * @mac_addr: the MAC address associated to the stored IPv4
1517  * @vid: the vlan ID associated to this entry
1518  * @last_update: time in jiffies when this entry was refreshed last time
1519  * @hash_entry: hlist node for batadv_priv_dat::hash
1520  * @refcount: number of contexts the object is used
1521  * @rcu: struct used for freeing in an RCU-safe manner
1522  */
1523 struct batadv_dat_entry {
1524         __be32 ip;
1525         u8 mac_addr[ETH_ALEN];
1526         unsigned short vid;
1527         unsigned long last_update;
1528         struct hlist_node hash_entry;
1529         struct kref refcount;
1530         struct rcu_head rcu;
1531 };
1532
1533 /**
1534  * struct batadv_hw_addr - a list entry for a MAC address
1535  * @list: list node for the linking of entries
1536  * @addr: the MAC address of this list entry
1537  */
1538 struct batadv_hw_addr {
1539         struct hlist_node list;
1540         unsigned char addr[ETH_ALEN];
1541 };
1542
1543 /**
1544  * struct batadv_dat_candidate - candidate destination for DAT operations
1545  * @type: the type of the selected candidate. It can one of the following:
1546  *        - BATADV_DAT_CANDIDATE_NOT_FOUND
1547  *        - BATADV_DAT_CANDIDATE_ORIG
1548  * @orig_node: if type is BATADV_DAT_CANDIDATE_ORIG this field points to the
1549  *             corresponding originator node structure
1550  */
1551 struct batadv_dat_candidate {
1552         int type;
1553         struct batadv_orig_node *orig_node;
1554 };
1555
1556 /**
1557  * struct batadv_tvlv_container - container for tvlv appended to OGMs
1558  * @list: hlist node for batadv_priv_tvlv::container_list
1559  * @tvlv_hdr: tvlv header information needed to construct the tvlv
1560  * @refcount: number of contexts the object is used
1561  */
1562 struct batadv_tvlv_container {
1563         struct hlist_node list;
1564         struct batadv_tvlv_hdr tvlv_hdr;
1565         struct kref refcount;
1566 };
1567
1568 /**
1569  * struct batadv_tvlv_handler - handler for specific tvlv type and version
1570  * @list: hlist node for batadv_priv_tvlv::handler_list
1571  * @ogm_handler: handler callback which is given the tvlv payload to process on
1572  *  incoming OGM packets
1573  * @unicast_handler: handler callback which is given the tvlv payload to process
1574  *  on incoming unicast tvlv packets
1575  * @type: tvlv type this handler feels responsible for
1576  * @version: tvlv version this handler feels responsible for
1577  * @flags: tvlv handler flags
1578  * @refcount: number of contexts the object is used
1579  * @rcu: struct used for freeing in an RCU-safe manner
1580  */
1581 struct batadv_tvlv_handler {
1582         struct hlist_node list;
1583         void (*ogm_handler)(struct batadv_priv *bat_priv,
1584                             struct batadv_orig_node *orig,
1585                             u8 flags, void *tvlv_value, u16 tvlv_value_len);
1586         int (*unicast_handler)(struct batadv_priv *bat_priv,
1587                                u8 *src, u8 *dst,
1588                                void *tvlv_value, u16 tvlv_value_len);
1589         u8 type;
1590         u8 version;
1591         u8 flags;
1592         struct kref refcount;
1593         struct rcu_head rcu;
1594 };
1595
1596 /**
1597  * enum batadv_tvlv_handler_flags - tvlv handler flags definitions
1598  * @BATADV_TVLV_HANDLER_OGM_CIFNOTFND: tvlv ogm processing function will call
1599  *  this handler even if its type was not found (with no data)
1600  * @BATADV_TVLV_HANDLER_OGM_CALLED: interval tvlv handling flag - the API marks
1601  *  a handler as being called, so it won't be called if the
1602  *  BATADV_TVLV_HANDLER_OGM_CIFNOTFND flag was set
1603  */
1604 enum batadv_tvlv_handler_flags {
1605         BATADV_TVLV_HANDLER_OGM_CIFNOTFND = BIT(1),
1606         BATADV_TVLV_HANDLER_OGM_CALLED = BIT(2),
1607 };
1608
1609 /**
1610  * struct batadv_store_mesh_work - Work queue item to detach add/del interface
1611  *  from sysfs locks
1612  * @net_dev: netdevice to add/remove to/from batman-adv soft-interface
1613  * @soft_iface_name: name of soft-interface to modify
1614  * @work: work queue item
1615  */
1616 struct batadv_store_mesh_work {
1617         struct net_device *net_dev;
1618         char soft_iface_name[IFNAMSIZ];
1619         struct work_struct work;
1620 };
1621
1622 #endif /* _NET_BATMAN_ADV_TYPES_H_ */