]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - net/batman-adv/types.h
batman-adv: Multicast Listener Announcements via Translation Table
[mirror_ubuntu-bionic-kernel.git] / net / batman-adv / types.h
CommitLineData
e19f9759 1/* Copyright (C) 2007-2014 B.A.T.M.A.N. contributors:
c6c8fea2
SE
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
ebf38fb7 15 * along with this program; if not, see <http://www.gnu.org/licenses/>.
c6c8fea2
SE
16 */
17
c6c8fea2
SE
18#ifndef _NET_BATMAN_ADV_TYPES_H_
19#define _NET_BATMAN_ADV_TYPES_H_
20
21#include "packet.h"
22#include "bitarray.h"
c11fdfae 23#include <linux/kernel.h>
c6c8fea2 24
17224474
AQ
25#ifdef CONFIG_BATMAN_ADV_DAT
26
785ea114
AQ
27/* batadv_dat_addr_t is the type used for all DHT addresses. If it is changed,
28 * BATADV_DAT_ADDR_MAX is changed as well.
29 *
30 * *Please be careful: batadv_dat_addr_t must be UNSIGNED*
31 */
32#define batadv_dat_addr_t uint16_t
33
17224474
AQ
34#endif /* CONFIG_BATMAN_ADV_DAT */
35
6c413b1c
AQ
36/**
37 * enum batadv_dhcp_recipient - dhcp destination
38 * @BATADV_DHCP_NO: packet is not a dhcp message
39 * @BATADV_DHCP_TO_SERVER: dhcp message is directed to a server
40 * @BATADV_DHCP_TO_CLIENT: dhcp message is directed to a client
41 */
42enum batadv_dhcp_recipient {
43 BATADV_DHCP_NO = 0,
44 BATADV_DHCP_TO_SERVER,
45 BATADV_DHCP_TO_CLIENT,
46};
47
3c4f7ab6
AQ
48/**
49 * BATADV_TT_REMOTE_MASK - bitmask selecting the flags that are sent over the
50 * wire only
51 */
52#define BATADV_TT_REMOTE_MASK 0x00FF
53
0eb01568
AQ
54/**
55 * BATADV_TT_SYNC_MASK - bitmask of the flags that need to be kept in sync
56 * among the nodes. These flags are used to compute the global/local CRC
57 */
58#define BATADV_TT_SYNC_MASK 0x00F0
59
14511519
ML
60/**
61 * struct batadv_hard_iface_bat_iv - per hard interface B.A.T.M.A.N. IV data
62 * @ogm_buff: buffer holding the OGM packet
63 * @ogm_buff_len: length of the OGM packet buffer
64 * @ogm_seqno: OGM sequence number - used to identify each OGM
65 */
66struct batadv_hard_iface_bat_iv {
67 unsigned char *ogm_buff;
68 int ogm_buff_len;
69 atomic_t ogm_seqno;
70};
71
88a32c9a
ML
72/**
73 * struct batadv_hard_iface - network device known to batman-adv
74 * @list: list node for batadv_hardif_list
75 * @if_num: identificator of the interface
76 * @if_status: status of the interface for batman-adv
77 * @net_dev: pointer to the net_device
caf65bfc 78 * @num_bcasts: number of payload re-broadcasts on this interface (ARQ)
88a32c9a
ML
79 * @hardif_obj: kobject of the per interface sysfs "mesh" directory
80 * @refcount: number of contexts the object is used
81 * @batman_adv_ptype: packet type describing packets that should be processed by
82 * batman-adv for this interface
83 * @soft_iface: the batman-adv interface which uses this network interface
84 * @rcu: struct used for freeing in an RCU-safe manner
85 * @bat_iv: BATMAN IV specific per hard interface data
5bc44dc8 86 * @cleanup_work: work queue callback item for hard interface deinit
5bc7c1eb 87 * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
88a32c9a 88 */
56303d34 89struct batadv_hard_iface {
c6c8fea2
SE
90 struct list_head list;
91 int16_t if_num;
92 char if_status;
93 struct net_device *net_dev;
caf65bfc 94 uint8_t num_bcasts;
c6c8fea2 95 struct kobject *hardif_obj;
ed75ccbe 96 atomic_t refcount;
c6c8fea2
SE
97 struct packet_type batman_adv_ptype;
98 struct net_device *soft_iface;
99 struct rcu_head rcu;
14511519 100 struct batadv_hard_iface_bat_iv bat_iv;
5bc44dc8 101 struct work_struct cleanup_work;
5bc7c1eb 102 struct dentry *debug_dir;
c6c8fea2
SE
103};
104
7351a482
SW
105/**
106 * struct batadv_orig_ifinfo - originator info per outgoing interface
107 * @list: list node for orig_node::ifinfo_list
108 * @if_outgoing: pointer to outgoing hard interface
109 * @router: router that should be used to reach this originator
110 * @last_real_seqno: last and best known sequence number
111 * @last_ttl: ttl of last received packet
112 * @batman_seqno_reset: time when the batman seqno window was reset
113 * @refcount: number of contexts the object is used
114 * @rcu: struct used for freeing in an RCU-safe manner
115 */
116struct batadv_orig_ifinfo {
117 struct hlist_node list;
118 struct batadv_hard_iface *if_outgoing;
119 struct batadv_neigh_node __rcu *router; /* rcu protected pointer */
120 uint32_t last_real_seqno;
121 uint8_t last_ttl;
122 unsigned long batman_seqno_reset;
123 atomic_t refcount;
124 struct rcu_head rcu;
125};
126
610bfc6b
MH
127/**
128 * struct batadv_frag_table_entry - head in the fragment buffer table
129 * @head: head of list with fragments
130 * @lock: lock to protect the list of fragments
131 * @timestamp: time (jiffie) of last received fragment
132 * @seqno: sequence number of the fragments in the list
133 * @size: accumulated size of packets in list
134 */
135struct batadv_frag_table_entry {
136 struct hlist_head head;
137 spinlock_t lock; /* protects head */
138 unsigned long timestamp;
139 uint16_t seqno;
140 uint16_t size;
141};
142
143/**
144 * struct batadv_frag_list_entry - entry in a list of fragments
145 * @list: list node information
146 * @skb: fragment
147 * @no: fragment number in the set
148 */
149struct batadv_frag_list_entry {
150 struct hlist_node list;
151 struct sk_buff *skb;
152 uint8_t no;
153};
154
7ea7b4a1
AQ
155/**
156 * struct batadv_vlan_tt - VLAN specific TT attributes
157 * @crc: CRC32 checksum of the entries belonging to this vlan
158 * @num_entries: number of TT entries for this VLAN
159 */
160struct batadv_vlan_tt {
161 uint32_t crc;
162 atomic_t num_entries;
163};
164
165/**
1a321b0d 166 * struct batadv_orig_node_vlan - VLAN specific data per orig_node
7ea7b4a1
AQ
167 * @vid: the VLAN identifier
168 * @tt: VLAN specific TT attributes
169 * @list: list node for orig_node::vlan_list
170 * @refcount: number of context where this object is currently in use
171 * @rcu: struct used for freeing in a RCU-safe manner
172 */
173struct batadv_orig_node_vlan {
174 unsigned short vid;
175 struct batadv_vlan_tt tt;
176 struct list_head list;
177 atomic_t refcount;
178 struct rcu_head rcu;
179};
180
bbad0a5e
AQ
181/**
182 * struct batadv_orig_bat_iv - B.A.T.M.A.N. IV private orig_node members
183 * @bcast_own: bitfield containing the number of our OGMs this orig_node
184 * rebroadcasted "back" to us (relative to last_real_seqno)
185 * @bcast_own_sum: counted result of bcast_own
186 * @ogm_cnt_lock: lock protecting bcast_own, bcast_own_sum,
187 * neigh_node->bat_iv.real_bits & neigh_node->bat_iv.real_packet_count
188 */
189struct batadv_orig_bat_iv {
190 unsigned long *bcast_own;
191 uint8_t *bcast_own_sum;
192 /* ogm_cnt_lock protects: bcast_own, bcast_own_sum,
193 * neigh_node->bat_iv.real_bits & neigh_node->bat_iv.real_packet_count
194 */
195 spinlock_t ogm_cnt_lock;
196};
197
2c53040f 198/**
b6d0ab7c 199 * struct batadv_orig_node - structure for orig_list maintaining nodes of mesh
88a32c9a 200 * @orig: originator ethernet address
b6d0ab7c 201 * @primary_addr: hosts primary interface address
7351a482 202 * @ifinfo_list: list for routers per outgoing interface
f3b3d901 203 * @last_bonding_candidate: pointer to last ifinfo of last used router
88a32c9a 204 * @batadv_dat_addr_t: address of the orig node in the distributed hash
88a32c9a 205 * @last_seen: time when last packet from this node was received
b6d0ab7c 206 * @bcast_seqno_reset: time when the broadcast seqno window was reset
17cf0ea4 207 * @capabilities: announced capabilities of this originator
88a32c9a 208 * @last_ttvn: last seen translation table version number
88a32c9a
ML
209 * @tt_buff: last tt changeset this node received from the orig node
210 * @tt_buff_len: length of the last tt changeset this node received from the
211 * orig node
212 * @tt_buff_lock: lock that protects tt_buff and tt_buff_len
88a32c9a
ML
213 * @tt_initialised: bool keeping track of whether or not this node have received
214 * any translation table information from the orig node yet
a70a9aa9
AQ
215 * @tt_lock: prevents from updating the table while reading it. Table update is
216 * made up by two operations (data structure update and metdata -CRC/TTVN-
217 * recalculation) and they have to be executed atomically in order to avoid
218 * another thread to read the table/metadata between those.
88a32c9a
ML
219 * @bcast_bits: bitfield containing the info which payload broadcast originated
220 * from this orig node this host already has seen (relative to
221 * last_bcast_seqno)
b6d0ab7c 222 * @last_bcast_seqno: last broadcast sequence number received by this host
88a32c9a 223 * @neigh_list: list of potential next hop neighbor towards this orig node
f6c8b711 224 * @neigh_list_lock: lock protecting neigh_list and router
88a32c9a
ML
225 * @hash_entry: hlist node for batadv_priv::orig_hash
226 * @bat_priv: pointer to soft_iface this orig node belongs to
88a32c9a 227 * @bcast_seqno_lock: lock protecting bcast_bits & last_bcast_seqno
88a32c9a
ML
228 * @refcount: number of contexts the object is used
229 * @rcu: struct used for freeing in an RCU-safe manner
d56b1705
MH
230 * @in_coding_list: list of nodes this orig can hear
231 * @out_coding_list: list of nodes that can hear this orig
232 * @in_coding_list_lock: protects in_coding_list
233 * @out_coding_list_lock: protects out_coding_list
610bfc6b 234 * @fragments: array with heads for fragment chains
7ea7b4a1
AQ
235 * @vlan_list: a list of orig_node_vlan structs, one per VLAN served by the
236 * originator represented by this object
237 * @vlan_list_lock: lock protecting vlan_list
bbad0a5e 238 * @bat_iv: B.A.T.M.A.N. IV private structure
c6c8fea2 239 */
56303d34 240struct batadv_orig_node {
c6c8fea2
SE
241 uint8_t orig[ETH_ALEN];
242 uint8_t primary_addr[ETH_ALEN];
7351a482 243 struct hlist_head ifinfo_list;
f3b3d901 244 struct batadv_orig_ifinfo *last_bonding_candidate;
17224474 245#ifdef CONFIG_BATMAN_ADV_DAT
785ea114 246 batadv_dat_addr_t dat_addr;
17224474 247#endif
d7b2a97e 248 unsigned long last_seen;
c6c8fea2 249 unsigned long bcast_seqno_reset;
17cf0ea4 250 uint8_t capabilities;
88a32c9a 251 atomic_t last_ttvn;
2dafb49d
AQ
252 unsigned char *tt_buff;
253 int16_t tt_buff_len;
88a32c9a 254 spinlock_t tt_buff_lock; /* protects tt_buff & tt_buff_len */
17071578 255 bool tt_initialised;
a70a9aa9
AQ
256 /* prevents from changing the table while reading it */
257 spinlock_t tt_lock;
42d0b044 258 DECLARE_BITMAP(bcast_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
c6c8fea2 259 uint32_t last_bcast_seqno;
9591a79f 260 struct hlist_head neigh_list;
f6c8b711 261 /* neigh_list_lock protects: neigh_list and router */
88a32c9a 262 spinlock_t neigh_list_lock;
7aadf889 263 struct hlist_node hash_entry;
56303d34 264 struct batadv_priv *bat_priv;
88a32c9a 265 /* bcast_seqno_lock protects: bcast_bits & last_bcast_seqno */
6e215fd8 266 spinlock_t bcast_seqno_lock;
88a32c9a
ML
267 atomic_t refcount;
268 struct rcu_head rcu;
d56b1705
MH
269#ifdef CONFIG_BATMAN_ADV_NC
270 struct list_head in_coding_list;
271 struct list_head out_coding_list;
272 spinlock_t in_coding_list_lock; /* Protects in_coding_list */
273 spinlock_t out_coding_list_lock; /* Protects out_coding_list */
274#endif
610bfc6b 275 struct batadv_frag_table_entry fragments[BATADV_FRAG_BUFFER_COUNT];
7ea7b4a1
AQ
276 struct list_head vlan_list;
277 spinlock_t vlan_list_lock; /* protects vlan_list */
bbad0a5e 278 struct batadv_orig_bat_iv bat_iv;
c6c8fea2
SE
279};
280
17cf0ea4
ML
281/**
282 * enum batadv_orig_capabilities - orig node capabilities
283 * @BATADV_ORIG_CAPA_HAS_DAT: orig node has distributed arp table enabled
3f4841ff 284 * @BATADV_ORIG_CAPA_HAS_NC: orig node has network coding enabled
17cf0ea4
ML
285 */
286enum batadv_orig_capabilities {
287 BATADV_ORIG_CAPA_HAS_DAT = BIT(0),
3f4841ff 288 BATADV_ORIG_CAPA_HAS_NC = BIT(1),
17cf0ea4
ML
289};
290
88a32c9a
ML
291/**
292 * struct batadv_gw_node - structure for orig nodes announcing gw capabilities
293 * @list: list node for batadv_priv_gw::list
294 * @orig_node: pointer to corresponding orig node
414254e3
ML
295 * @bandwidth_down: advertised uplink download bandwidth
296 * @bandwidth_up: advertised uplink upload bandwidth
88a32c9a
ML
297 * @deleted: this struct is scheduled for deletion
298 * @refcount: number of contexts the object is used
299 * @rcu: struct used for freeing in an RCU-safe manner
300 */
56303d34 301struct batadv_gw_node {
c6c8fea2 302 struct hlist_node list;
56303d34 303 struct batadv_orig_node *orig_node;
414254e3
ML
304 uint32_t bandwidth_down;
305 uint32_t bandwidth_up;
c6c8fea2 306 unsigned long deleted;
25b6d3c1 307 atomic_t refcount;
c6c8fea2
SE
308 struct rcu_head rcu;
309};
310
88a32c9a 311/**
89652331
SW
312 * struct batadv_neigh_node - structure for single hops neighbors
313 * @list: list node for batadv_orig_node::neigh_list
314 * @orig_node: pointer to corresponding orig_node
315 * @addr: the MAC address of the neighboring interface
316 * @ifinfo_list: list for routing metrics per outgoing interface
317 * @ifinfo_lock: lock protecting private ifinfo members and list
318 * @if_incoming: pointer to incoming hard interface
319 * @last_seen: when last packet via this neighbor was received
320 * @last_ttl: last received ttl from this neigh node
321 * @rcu: struct used for freeing in an RCU-safe manner
322 * @bat_iv: B.A.T.M.A.N. IV private structure
323 */
324struct batadv_neigh_node {
325 struct hlist_node list;
326 struct batadv_orig_node *orig_node;
327 uint8_t addr[ETH_ALEN];
328 struct hlist_head ifinfo_list;
329 spinlock_t ifinfo_lock; /* protects ifinfo_list and its members */
330 struct batadv_hard_iface *if_incoming;
331 unsigned long last_seen;
332 atomic_t refcount;
333 struct rcu_head rcu;
334};
335
1b371d13 336/**
1a321b0d 337 * struct batadv_neigh_ifinfo_bat_iv - neighbor information per outgoing
89652331 338 * interface for BATMAN IV
88a32c9a
ML
339 * @tq_recv: ring buffer of received TQ values from this neigh node
340 * @tq_index: ring buffer index
341 * @tq_avg: averaged tq of all tq values in the ring buffer (tq_recv)
88a32c9a
ML
342 * @real_bits: bitfield containing the number of OGMs received from this neigh
343 * node (relative to orig_node->last_real_seqno)
344 * @real_packet_count: counted result of real_bits
0538f759 345 */
89652331 346struct batadv_neigh_ifinfo_bat_iv {
0538f759
AQ
347 uint8_t tq_recv[BATADV_TQ_GLOBAL_WINDOW_SIZE];
348 uint8_t tq_index;
349 uint8_t tq_avg;
350 DECLARE_BITMAP(real_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
351 uint8_t real_packet_count;
0538f759
AQ
352};
353
1b371d13
SW
354/**
355 * struct batadv_neigh_ifinfo - neighbor information per outgoing interface
89652331
SW
356 * @list: list node for batadv_neigh_node::ifinfo_list
357 * @if_outgoing: pointer to outgoing hard interface
358 * @bat_iv: B.A.T.M.A.N. IV private structure
0538f759 359 * @last_ttl: last received ttl from this neigh node
88a32c9a 360 * @refcount: number of contexts the object is used
89652331 361 * @rcu: struct used for freeing in a RCU-safe manner
c6c8fea2 362 */
89652331 363struct batadv_neigh_ifinfo {
9591a79f 364 struct hlist_node list;
89652331
SW
365 struct batadv_hard_iface *if_outgoing;
366 struct batadv_neigh_ifinfo_bat_iv bat_iv;
c6c8fea2 367 uint8_t last_ttl;
88a32c9a
ML
368 atomic_t refcount;
369 struct rcu_head rcu;
c6c8fea2
SE
370};
371
88a32c9a
ML
372/**
373 * struct batadv_bcast_duplist_entry - structure for LAN broadcast suppression
374 * @orig[ETH_ALEN]: mac address of orig node orginating the broadcast
375 * @crc: crc32 checksum of broadcast payload
376 * @entrytime: time when the broadcast packet was received
377 */
7a5cc242 378#ifdef CONFIG_BATMAN_ADV_BLA
56303d34 379struct batadv_bcast_duplist_entry {
fe2da6ff 380 uint8_t orig[ETH_ALEN];
004e86fc 381 __be32 crc;
fe2da6ff
SW
382 unsigned long entrytime;
383};
7a5cc242 384#endif
c6c8fea2 385
88a32c9a
ML
386/**
387 * enum batadv_counters - indices for traffic counters
388 * @BATADV_CNT_TX: transmitted payload traffic packet counter
389 * @BATADV_CNT_TX_BYTES: transmitted payload traffic bytes counter
390 * @BATADV_CNT_TX_DROPPED: dropped transmission payload traffic packet counter
391 * @BATADV_CNT_RX: received payload traffic packet counter
392 * @BATADV_CNT_RX_BYTES: received payload traffic bytes counter
393 * @BATADV_CNT_FORWARD: forwarded payload traffic packet counter
394 * @BATADV_CNT_FORWARD_BYTES: forwarded payload traffic bytes counter
395 * @BATADV_CNT_MGMT_TX: transmitted routing protocol traffic packet counter
396 * @BATADV_CNT_MGMT_TX_BYTES: transmitted routing protocol traffic bytes counter
397 * @BATADV_CNT_MGMT_RX: received routing protocol traffic packet counter
398 * @BATADV_CNT_MGMT_RX_BYTES: received routing protocol traffic bytes counter
ee75ed88
MH
399 * @BATADV_CNT_FRAG_TX: transmitted fragment traffic packet counter
400 * @BATADV_CNT_FRAG_TX_BYTES: transmitted fragment traffic bytes counter
610bfc6b
MH
401 * @BATADV_CNT_FRAG_RX: received fragment traffic packet counter
402 * @BATADV_CNT_FRAG_RX_BYTES: received fragment traffic bytes counter
403 * @BATADV_CNT_FRAG_FWD: forwarded fragment traffic packet counter
404 * @BATADV_CNT_FRAG_FWD_BYTES: forwarded fragment traffic bytes counter
88a32c9a
ML
405 * @BATADV_CNT_TT_REQUEST_TX: transmitted tt req traffic packet counter
406 * @BATADV_CNT_TT_REQUEST_RX: received tt req traffic packet counter
407 * @BATADV_CNT_TT_RESPONSE_TX: transmitted tt resp traffic packet counter
408 * @BATADV_CNT_TT_RESPONSE_RX: received tt resp traffic packet counter
409 * @BATADV_CNT_TT_ROAM_ADV_TX: transmitted tt roam traffic packet counter
410 * @BATADV_CNT_TT_ROAM_ADV_RX: received tt roam traffic packet counter
411 * @BATADV_CNT_DAT_GET_TX: transmitted dht GET traffic packet counter
412 * @BATADV_CNT_DAT_GET_RX: received dht GET traffic packet counter
413 * @BATADV_CNT_DAT_PUT_TX: transmitted dht PUT traffic packet counter
414 * @BATADV_CNT_DAT_PUT_RX: received dht PUT traffic packet counter
415 * @BATADV_CNT_DAT_CACHED_REPLY_TX: transmitted dat cache reply traffic packet
416 * counter
3c12de9a
MH
417 * @BATADV_CNT_NC_CODE: transmitted nc-combined traffic packet counter
418 * @BATADV_CNT_NC_CODE_BYTES: transmitted nc-combined traffic bytes counter
419 * @BATADV_CNT_NC_RECODE: transmitted nc-recombined traffic packet counter
420 * @BATADV_CNT_NC_RECODE_BYTES: transmitted nc-recombined traffic bytes counter
612d2b4f 421 * @BATADV_CNT_NC_BUFFER: counter for packets buffered for later nc decoding
2df5278b
MH
422 * @BATADV_CNT_NC_DECODE: received and nc-decoded traffic packet counter
423 * @BATADV_CNT_NC_DECODE_BYTES: received and nc-decoded traffic bytes counter
424 * @BATADV_CNT_NC_DECODE_FAILED: received and decode-failed traffic packet
425 * counter
426 * @BATADV_CNT_NC_SNIFFED: counter for nc-decoded packets received in promisc
427 * mode.
88a32c9a
ML
428 * @BATADV_CNT_NUM: number of traffic counters
429 */
d69909d2 430enum batadv_counters {
1c9b0550
ML
431 BATADV_CNT_TX,
432 BATADV_CNT_TX_BYTES,
433 BATADV_CNT_TX_DROPPED,
434 BATADV_CNT_RX,
435 BATADV_CNT_RX_BYTES,
d69909d2
SE
436 BATADV_CNT_FORWARD,
437 BATADV_CNT_FORWARD_BYTES,
438 BATADV_CNT_MGMT_TX,
439 BATADV_CNT_MGMT_TX_BYTES,
440 BATADV_CNT_MGMT_RX,
441 BATADV_CNT_MGMT_RX_BYTES,
ee75ed88
MH
442 BATADV_CNT_FRAG_TX,
443 BATADV_CNT_FRAG_TX_BYTES,
610bfc6b
MH
444 BATADV_CNT_FRAG_RX,
445 BATADV_CNT_FRAG_RX_BYTES,
446 BATADV_CNT_FRAG_FWD,
447 BATADV_CNT_FRAG_FWD_BYTES,
d69909d2
SE
448 BATADV_CNT_TT_REQUEST_TX,
449 BATADV_CNT_TT_REQUEST_RX,
450 BATADV_CNT_TT_RESPONSE_TX,
451 BATADV_CNT_TT_RESPONSE_RX,
452 BATADV_CNT_TT_ROAM_ADV_TX,
453 BATADV_CNT_TT_ROAM_ADV_RX,
4046b24a
MH
454#ifdef CONFIG_BATMAN_ADV_DAT
455 BATADV_CNT_DAT_GET_TX,
456 BATADV_CNT_DAT_GET_RX,
457 BATADV_CNT_DAT_PUT_TX,
458 BATADV_CNT_DAT_PUT_RX,
459 BATADV_CNT_DAT_CACHED_REPLY_TX,
3c12de9a
MH
460#endif
461#ifdef CONFIG_BATMAN_ADV_NC
462 BATADV_CNT_NC_CODE,
463 BATADV_CNT_NC_CODE_BYTES,
464 BATADV_CNT_NC_RECODE,
465 BATADV_CNT_NC_RECODE_BYTES,
612d2b4f 466 BATADV_CNT_NC_BUFFER,
2df5278b
MH
467 BATADV_CNT_NC_DECODE,
468 BATADV_CNT_NC_DECODE_BYTES,
469 BATADV_CNT_NC_DECODE_FAILED,
470 BATADV_CNT_NC_SNIFFED,
4046b24a 471#endif
d69909d2 472 BATADV_CNT_NUM,
f8214865
MH
473};
474
807736f6
SE
475/**
476 * struct batadv_priv_tt - per mesh interface translation table data
477 * @vn: translation table version number
88a32c9a 478 * @ogm_append_cnt: counter of number of OGMs containing the local tt diff
807736f6 479 * @local_changes: changes registered in an originator interval
807736f6 480 * @changes_list: tracks tt local changes within an originator interval
88a32c9a
ML
481 * @local_hash: local translation table hash table
482 * @global_hash: global translation table hash table
483 * @req_list: list of pending & unanswered tt_requests
484 * @roam_list: list of the last roaming events of each client limiting the
485 * number of roaming events to avoid route flapping
486 * @changes_list_lock: lock protecting changes_list
487 * @req_list_lock: lock protecting req_list
488 * @roam_list_lock: lock protecting roam_list
88a32c9a
ML
489 * @last_changeset: last tt changeset this host has generated
490 * @last_changeset_len: length of last tt changeset this host has generated
491 * @last_changeset_lock: lock protecting last_changeset & last_changeset_len
a70a9aa9
AQ
492 * @commit_lock: prevents from executing a local TT commit while reading the
493 * local table. The local TT commit is made up by two operations (data
494 * structure update and metdata -CRC/TTVN- recalculation) and they have to be
495 * executed atomically in order to avoid another thread to read the
496 * table/metadata between those.
88a32c9a 497 * @work: work queue callback item for translation table purging
807736f6
SE
498 */
499struct batadv_priv_tt {
500 atomic_t vn;
501 atomic_t ogm_append_cnt;
502 atomic_t local_changes;
807736f6
SE
503 struct list_head changes_list;
504 struct batadv_hashtable *local_hash;
505 struct batadv_hashtable *global_hash;
506 struct list_head req_list;
507 struct list_head roam_list;
508 spinlock_t changes_list_lock; /* protects changes */
509 spinlock_t req_list_lock; /* protects req_list */
510 spinlock_t roam_list_lock; /* protects roam_list */
807736f6
SE
511 unsigned char *last_changeset;
512 int16_t last_changeset_len;
88a32c9a
ML
513 /* protects last_changeset & last_changeset_len */
514 spinlock_t last_changeset_lock;
a70a9aa9
AQ
515 /* prevents from executing a commit while reading the table */
516 spinlock_t commit_lock;
807736f6
SE
517 struct delayed_work work;
518};
519
88a32c9a
ML
520/**
521 * struct batadv_priv_bla - per mesh interface bridge loope avoidance data
522 * @num_requests; number of bla requests in flight
523 * @claim_hash: hash table containing mesh nodes this host has claimed
524 * @backbone_hash: hash table containing all detected backbone gateways
525 * @bcast_duplist: recently received broadcast packets array (for broadcast
526 * duplicate suppression)
527 * @bcast_duplist_curr: index of last broadcast packet added to bcast_duplist
528 * @bcast_duplist_lock: lock protecting bcast_duplist & bcast_duplist_curr
529 * @claim_dest: local claim data (e.g. claim group)
530 * @work: work queue callback item for cleanups & bla announcements
531 */
807736f6
SE
532#ifdef CONFIG_BATMAN_ADV_BLA
533struct batadv_priv_bla {
88a32c9a 534 atomic_t num_requests;
807736f6
SE
535 struct batadv_hashtable *claim_hash;
536 struct batadv_hashtable *backbone_hash;
537 struct batadv_bcast_duplist_entry bcast_duplist[BATADV_DUPLIST_SIZE];
538 int bcast_duplist_curr;
88a32c9a 539 /* protects bcast_duplist & bcast_duplist_curr */
7dac7b76 540 spinlock_t bcast_duplist_lock;
807736f6
SE
541 struct batadv_bla_claim_dst claim_dest;
542 struct delayed_work work;
543};
544#endif
545
88a32c9a 546/**
1a321b0d 547 * struct batadv_priv_debug_log - debug logging data
88a32c9a
ML
548 * @log_buff: buffer holding the logs (ring bufer)
549 * @log_start: index of next character to read
550 * @log_end: index of next character to write
551 * @lock: lock protecting log_buff, log_start & log_end
552 * @queue_wait: log reader's wait queue
553 */
0abf5d81
ML
554#ifdef CONFIG_BATMAN_ADV_DEBUG
555struct batadv_priv_debug_log {
556 char log_buff[BATADV_LOG_BUF_LEN];
557 unsigned long log_start;
558 unsigned long log_end;
559 spinlock_t lock; /* protects log_buff, log_start and log_end */
560 wait_queue_head_t queue_wait;
561};
562#endif
563
88a32c9a
ML
564/**
565 * struct batadv_priv_gw - per mesh interface gateway data
566 * @list: list of available gateway nodes
567 * @list_lock: lock protecting gw_list & curr_gw
568 * @curr_gw: pointer to currently selected gateway node
414254e3
ML
569 * @bandwidth_down: advertised uplink download bandwidth (if gw_mode server)
570 * @bandwidth_up: advertised uplink upload bandwidth (if gw_mode server)
88a32c9a
ML
571 * @reselect: bool indicating a gateway re-selection is in progress
572 */
807736f6
SE
573struct batadv_priv_gw {
574 struct hlist_head list;
88a32c9a 575 spinlock_t list_lock; /* protects gw_list & curr_gw */
807736f6 576 struct batadv_gw_node __rcu *curr_gw; /* rcu protected pointer */
414254e3
ML
577 atomic_t bandwidth_down;
578 atomic_t bandwidth_up;
807736f6
SE
579 atomic_t reselect;
580};
581
ef261577
ML
582/**
583 * struct batadv_priv_tvlv - per mesh interface tvlv data
584 * @container_list: list of registered tvlv containers to be sent with each OGM
585 * @handler_list: list of the various tvlv content handlers
586 * @container_list_lock: protects tvlv container list access
587 * @handler_list_lock: protects handler list access
588 */
589struct batadv_priv_tvlv {
590 struct hlist_head container_list;
591 struct hlist_head handler_list;
592 spinlock_t container_list_lock; /* protects container_list */
593 spinlock_t handler_list_lock; /* protects handler_list */
594};
595
785ea114
AQ
596/**
597 * struct batadv_priv_dat - per mesh interface DAT private data
598 * @addr: node DAT address
2f1dfbe1
AQ
599 * @hash: hashtable representing the local ARP cache
600 * @work: work queue callback item for cache purging
785ea114 601 */
17224474 602#ifdef CONFIG_BATMAN_ADV_DAT
785ea114
AQ
603struct batadv_priv_dat {
604 batadv_dat_addr_t addr;
2f1dfbe1
AQ
605 struct batadv_hashtable *hash;
606 struct delayed_work work;
785ea114 607};
17224474 608#endif
785ea114 609
c5caf4ef
LL
610#ifdef CONFIG_BATMAN_ADV_MCAST
611/**
612 * struct batadv_priv_mcast - per mesh interface mcast data
613 * @mla_list: list of multicast addresses we are currently announcing via TT
614 */
615struct batadv_priv_mcast {
616 struct hlist_head mla_list;
617};
618#endif
619
d353d8d4
MH
620/**
621 * struct batadv_priv_nc - per mesh interface network coding private data
622 * @work: work queue callback item for cleanup
d56b1705
MH
623 * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
624 * @min_tq: only consider neighbors for encoding if neigh_tq > min_tq
95332477 625 * @max_fwd_delay: maximum packet forward delay to allow coding of packets
612d2b4f 626 * @max_buffer_time: buffer time for sniffed packets used to decoding
95332477 627 * @timestamp_fwd_flush: timestamp of last forward packet queue flush
612d2b4f 628 * @timestamp_sniffed_purge: timestamp of last sniffed packet queue purge
95332477
MH
629 * @coding_hash: Hash table used to buffer skbs while waiting for another
630 * incoming skb to code it with. Skbs are added to the buffer just before being
631 * forwarded in routing.c
612d2b4f
MH
632 * @decoding_hash: Hash table used to buffer skbs that might be needed to decode
633 * a received coded skb. The buffer is used for 1) skbs arriving on the
634 * soft-interface; 2) skbs overheard on the hard-interface; and 3) skbs
635 * forwarded by batman-adv.
d353d8d4
MH
636 */
637struct batadv_priv_nc {
638 struct delayed_work work;
d56b1705
MH
639 struct dentry *debug_dir;
640 u8 min_tq;
95332477 641 u32 max_fwd_delay;
612d2b4f 642 u32 max_buffer_time;
95332477 643 unsigned long timestamp_fwd_flush;
612d2b4f 644 unsigned long timestamp_sniffed_purge;
95332477 645 struct batadv_hashtable *coding_hash;
612d2b4f 646 struct batadv_hashtable *decoding_hash;
d353d8d4
MH
647};
648
5d2c05b2
AQ
649/**
650 * struct batadv_softif_vlan - per VLAN attributes set
651 * @vid: VLAN identifier
652 * @kobj: kobject for sysfs vlan subdirectory
b8cbd81d 653 * @ap_isolation: AP isolation state
7ea7b4a1 654 * @tt: TT private attributes (VLAN specific)
5d2c05b2
AQ
655 * @list: list node for bat_priv::softif_vlan_list
656 * @refcount: number of context where this object is currently in use
657 * @rcu: struct used for freeing in a RCU-safe manner
658 */
659struct batadv_softif_vlan {
660 unsigned short vid;
661 struct kobject *kobj;
b8cbd81d 662 atomic_t ap_isolation; /* boolean */
7ea7b4a1 663 struct batadv_vlan_tt tt;
5d2c05b2
AQ
664 struct hlist_node list;
665 atomic_t refcount;
666 struct rcu_head rcu;
667};
668
88a32c9a
ML
669/**
670 * struct batadv_priv - per mesh interface data
671 * @mesh_state: current status of the mesh (inactive/active/deactivating)
5bc44dc8 672 * @soft_iface: net device which holds this struct as private data
88a32c9a
ML
673 * @stats: structure holding the data for the ndo_get_stats() call
674 * @bat_counters: mesh internal traffic statistic counters (see batadv_counters)
675 * @aggregated_ogms: bool indicating whether OGM aggregation is enabled
676 * @bonding: bool indicating whether traffic bonding is enabled
677 * @fragmentation: bool indicating whether traffic fragmentation is enabled
a19d3d85
ML
678 * @packet_size_max: max packet size that can be transmitted via
679 * multiple fragmented skbs or a single frame if fragmentation is disabled
ee75ed88 680 * @frag_seqno: incremental counter to identify chains of egress fragments
88a32c9a
ML
681 * @bridge_loop_avoidance: bool indicating whether bridge loop avoidance is
682 * enabled
683 * @distributed_arp_table: bool indicating whether distributed ARP table is
684 * enabled
88a32c9a
ML
685 * @gw_mode: gateway operation: off, client or server (see batadv_gw_modes)
686 * @gw_sel_class: gateway selection class (applies if gw_mode client)
88a32c9a
ML
687 * @orig_interval: OGM broadcast interval in milliseconds
688 * @hop_penalty: penalty which will be applied to an OGM's tq-field on every hop
689 * @log_level: configured log level (see batadv_dbg_level)
690 * @bcast_seqno: last sent broadcast packet sequence number
691 * @bcast_queue_left: number of remaining buffered broadcast packet slots
692 * @batman_queue_left: number of remaining OGM packet slots
693 * @num_ifaces: number of interfaces assigned to this mesh interface
694 * @mesh_obj: kobject for sysfs mesh subdirectory
695 * @debug_dir: dentry for debugfs batman-adv subdirectory
696 * @forw_bat_list: list of aggregated OGMs that will be forwarded
697 * @forw_bcast_list: list of broadcast packets that will be rebroadcasted
698 * @orig_hash: hash table containing mesh participants (orig nodes)
699 * @forw_bat_list_lock: lock protecting forw_bat_list
700 * @forw_bcast_list_lock: lock protecting forw_bcast_list
701 * @orig_work: work queue callback item for orig node purging
5bc44dc8 702 * @cleanup_work: work queue callback item for soft interface deinit
88a32c9a
ML
703 * @primary_if: one of the hard interfaces assigned to this mesh interface
704 * becomes the primary interface
705 * @bat_algo_ops: routing algorithm used by this mesh interface
5d2c05b2
AQ
706 * @softif_vlan_list: a list of softif_vlan structs, one per VLAN created on top
707 * of the mesh interface represented by this object
708 * @softif_vlan_list_lock: lock protecting softif_vlan_list
88a32c9a
ML
709 * @bla: bridge loope avoidance data
710 * @debug_log: holding debug logging relevant data
711 * @gw: gateway data
712 * @tt: translation table data
ef261577 713 * @tvlv: type-version-length-value data
88a32c9a 714 * @dat: distributed arp table data
c5caf4ef 715 * @mcast: multicast data
d353d8d4
MH
716 * @network_coding: bool indicating whether network coding is enabled
717 * @batadv_priv_nc: network coding data
88a32c9a 718 */
56303d34 719struct batadv_priv {
c6c8fea2 720 atomic_t mesh_state;
5bc44dc8 721 struct net_device *soft_iface;
c6c8fea2 722 struct net_device_stats stats;
f8214865 723 uint64_t __percpu *bat_counters; /* Per cpu counters */
88a32c9a
ML
724 atomic_t aggregated_ogms;
725 atomic_t bonding;
726 atomic_t fragmentation;
a19d3d85 727 atomic_t packet_size_max;
ee75ed88 728 atomic_t frag_seqno;
fa706554 729#ifdef CONFIG_BATMAN_ADV_BLA
88a32c9a 730 atomic_t bridge_loop_avoidance;
fa706554 731#endif
33af49ad 732#ifdef CONFIG_BATMAN_ADV_DAT
88a32c9a 733 atomic_t distributed_arp_table;
33af49ad 734#endif
88a32c9a
ML
735 atomic_t gw_mode;
736 atomic_t gw_sel_class;
88a32c9a
ML
737 atomic_t orig_interval;
738 atomic_t hop_penalty;
0c430d0d 739#ifdef CONFIG_BATMAN_ADV_DEBUG
88a32c9a 740 atomic_t log_level;
0c430d0d 741#endif
c42edfe3
AQ
742 uint32_t isolation_mark;
743 uint32_t isolation_mark_mask;
c6c8fea2
SE
744 atomic_t bcast_seqno;
745 atomic_t bcast_queue_left;
746 atomic_t batman_queue_left;
747 char num_ifaces;
c6c8fea2
SE
748 struct kobject *mesh_obj;
749 struct dentry *debug_dir;
750 struct hlist_head forw_bat_list;
751 struct hlist_head forw_bcast_list;
5bf74e9c 752 struct batadv_hashtable *orig_hash;
c6c8fea2 753 spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
a7528f8d 754 spinlock_t forw_bcast_list_lock; /* protects forw_bcast_list */
c6c8fea2 755 struct delayed_work orig_work;
5bc44dc8 756 struct work_struct cleanup_work;
56303d34 757 struct batadv_hard_iface __rcu *primary_if; /* rcu protected pointer */
56303d34 758 struct batadv_algo_ops *bat_algo_ops;
5d2c05b2
AQ
759 struct hlist_head softif_vlan_list;
760 spinlock_t softif_vlan_list_lock; /* protects softif_vlan_list */
807736f6
SE
761#ifdef CONFIG_BATMAN_ADV_BLA
762 struct batadv_priv_bla bla;
0abf5d81
ML
763#endif
764#ifdef CONFIG_BATMAN_ADV_DEBUG
765 struct batadv_priv_debug_log *debug_log;
807736f6
SE
766#endif
767 struct batadv_priv_gw gw;
768 struct batadv_priv_tt tt;
ef261577 769 struct batadv_priv_tvlv tvlv;
17224474 770#ifdef CONFIG_BATMAN_ADV_DAT
785ea114 771 struct batadv_priv_dat dat;
17224474 772#endif
c5caf4ef
LL
773#ifdef CONFIG_BATMAN_ADV_MCAST
774 struct batadv_priv_mcast mcast;
775#endif
d353d8d4
MH
776#ifdef CONFIG_BATMAN_ADV_NC
777 atomic_t network_coding;
778 struct batadv_priv_nc nc;
779#endif /* CONFIG_BATMAN_ADV_NC */
c6c8fea2
SE
780};
781
88a32c9a
ML
782/**
783 * struct batadv_socket_client - layer2 icmp socket client data
784 * @queue_list: packet queue for packets destined for this socket client
785 * @queue_len: number of packets in the packet queue (queue_list)
786 * @index: socket client's index in the batadv_socket_client_hash
787 * @lock: lock protecting queue_list, queue_len & index
788 * @queue_wait: socket client's wait queue
789 * @bat_priv: pointer to soft_iface this client belongs to
790 */
56303d34 791struct batadv_socket_client {
c6c8fea2
SE
792 struct list_head queue_list;
793 unsigned int queue_len;
794 unsigned char index;
88a32c9a 795 spinlock_t lock; /* protects queue_list, queue_len & index */
c6c8fea2 796 wait_queue_head_t queue_wait;
56303d34 797 struct batadv_priv *bat_priv;
c6c8fea2
SE
798};
799
88a32c9a
ML
800/**
801 * struct batadv_socket_packet - layer2 icmp packet for socket client
802 * @list: list node for batadv_socket_client::queue_list
803 * @icmp_len: size of the layer2 icmp packet
804 * @icmp_packet: layer2 icmp packet
805 */
56303d34 806struct batadv_socket_packet {
c6c8fea2
SE
807 struct list_head list;
808 size_t icmp_len;
da6b8c20 809 uint8_t icmp_packet[BATADV_ICMP_MAX_PACKET_SIZE];
c6c8fea2
SE
810};
811
88a32c9a
ML
812/**
813 * struct batadv_bla_backbone_gw - batman-adv gateway bridged into the LAN
814 * @orig: originator address of backbone node (mac address of primary iface)
815 * @vid: vlan id this gateway was detected on
816 * @hash_entry: hlist node for batadv_priv_bla::backbone_hash
817 * @bat_priv: pointer to soft_iface this backbone gateway belongs to
818 * @lasttime: last time we heard of this backbone gw
819 * @wait_periods: grace time for bridge forward delays and bla group forming at
820 * bootup phase - no bcast traffic is formwared until it has elapsed
821 * @request_sent: if this bool is set to true we are out of sync with this
822 * backbone gateway - no bcast traffic is formwared until the situation was
823 * resolved
824 * @crc: crc16 checksum over all claims
825 * @refcount: number of contexts the object is used
826 * @rcu: struct used for freeing in an RCU-safe manner
827 */
2006fea8 828#ifdef CONFIG_BATMAN_ADV_BLA
bae98774 829struct batadv_bla_backbone_gw {
2006fea8 830 uint8_t orig[ETH_ALEN];
eb2deb6b 831 unsigned short vid;
2006fea8
ML
832 struct hlist_node hash_entry;
833 struct batadv_priv *bat_priv;
88a32c9a 834 unsigned long lasttime;
2006fea8
ML
835 atomic_t wait_periods;
836 atomic_t request_sent;
88a32c9a 837 uint16_t crc;
2006fea8
ML
838 atomic_t refcount;
839 struct rcu_head rcu;
2006fea8
ML
840};
841
88a32c9a
ML
842/**
843 * struct batadv_bla_claim - claimed non-mesh client structure
844 * @addr: mac address of claimed non-mesh client
845 * @vid: vlan id this client was detected on
846 * @batadv_bla_backbone_gw: pointer to backbone gw claiming this client
847 * @lasttime: last time we heard of claim (locals only)
848 * @hash_entry: hlist node for batadv_priv_bla::claim_hash
849 * @refcount: number of contexts the object is used
850 * @rcu: struct used for freeing in an RCU-safe manner
851 */
712bbfe4 852struct batadv_bla_claim {
2006fea8 853 uint8_t addr[ETH_ALEN];
eb2deb6b 854 unsigned short vid;
bae98774 855 struct batadv_bla_backbone_gw *backbone_gw;
88a32c9a
ML
856 unsigned long lasttime;
857 struct hlist_node hash_entry;
2006fea8
ML
858 struct rcu_head rcu;
859 atomic_t refcount;
2006fea8
ML
860};
861#endif
862
88a32c9a
ML
863/**
864 * struct batadv_tt_common_entry - tt local & tt global common data
865 * @addr: mac address of non-mesh client
c018ad3d 866 * @vid: VLAN identifier
88a32c9a
ML
867 * @hash_entry: hlist node for batadv_priv_tt::local_hash or for
868 * batadv_priv_tt::global_hash
869 * @flags: various state handling flags (see batadv_tt_client_flags)
870 * @added_at: timestamp used for purging stale tt common entries
871 * @refcount: number of contexts the object is used
872 * @rcu: struct used for freeing in an RCU-safe manner
873 */
56303d34 874struct batadv_tt_common_entry {
c6c8fea2 875 uint8_t addr[ETH_ALEN];
c018ad3d 876 unsigned short vid;
93840ac4 877 struct hlist_node hash_entry;
5fbc1598 878 uint16_t flags;
30cfd02b 879 unsigned long added_at;
7683fdc1
AQ
880 atomic_t refcount;
881 struct rcu_head rcu;
c6c8fea2
SE
882};
883
88a32c9a
ML
884/**
885 * struct batadv_tt_local_entry - translation table local entry data
886 * @common: general translation table data
887 * @last_seen: timestamp used for purging stale tt local entries
888 */
56303d34
SE
889struct batadv_tt_local_entry {
890 struct batadv_tt_common_entry common;
48100bac
AQ
891 unsigned long last_seen;
892};
893
88a32c9a
ML
894/**
895 * struct batadv_tt_global_entry - translation table global entry data
896 * @common: general translation table data
897 * @orig_list: list of orig nodes announcing this non-mesh client
898 * @list_lock: lock protecting orig_list
899 * @roam_at: time at which TT_GLOBAL_ROAM was set
900 */
56303d34
SE
901struct batadv_tt_global_entry {
902 struct batadv_tt_common_entry common;
db08e6e5 903 struct hlist_head orig_list;
88a32c9a
ML
904 spinlock_t list_lock; /* protects orig_list */
905 unsigned long roam_at;
db08e6e5
SW
906};
907
88a32c9a
ML
908/**
909 * struct batadv_tt_orig_list_entry - orig node announcing a non-mesh client
910 * @orig_node: pointer to orig node announcing this non-mesh client
911 * @ttvn: translation table version number which added the non-mesh client
912 * @list: list node for batadv_tt_global_entry::orig_list
913 * @refcount: number of contexts the object is used
914 * @rcu: struct used for freeing in an RCU-safe manner
915 */
56303d34
SE
916struct batadv_tt_orig_list_entry {
917 struct batadv_orig_node *orig_node;
a73105b8 918 uint8_t ttvn;
88a32c9a 919 struct hlist_node list;
d657e621 920 atomic_t refcount;
db08e6e5 921 struct rcu_head rcu;
c6c8fea2
SE
922};
923
88a32c9a
ML
924/**
925 * struct batadv_tt_change_node - structure for tt changes occured
926 * @list: list node for batadv_priv_tt::changes_list
927 * @change: holds the actual translation table diff data
928 */
56303d34 929struct batadv_tt_change_node {
a73105b8 930 struct list_head list;
e1bf0c14 931 struct batadv_tvlv_tt_change change;
a73105b8
AQ
932};
933
88a32c9a
ML
934/**
935 * struct batadv_tt_req_node - data to keep track of the tt requests in flight
936 * @addr: mac address address of the originator this request was sent to
937 * @issued_at: timestamp used for purging stale tt requests
938 * @list: list node for batadv_priv_tt::req_list
939 */
56303d34 940struct batadv_tt_req_node {
a73105b8
AQ
941 uint8_t addr[ETH_ALEN];
942 unsigned long issued_at;
943 struct list_head list;
944};
945
88a32c9a
ML
946/**
947 * struct batadv_tt_roam_node - roaming client data
948 * @addr: mac address of the client in the roaming phase
949 * @counter: number of allowed roaming events per client within a single
950 * OGM interval (changes are committed with each OGM)
951 * @first_time: timestamp used for purging stale roaming node entries
952 * @list: list node for batadv_priv_tt::roam_list
953 */
56303d34 954struct batadv_tt_roam_node {
cc47f66e
AQ
955 uint8_t addr[ETH_ALEN];
956 atomic_t counter;
957 unsigned long first_time;
958 struct list_head list;
959};
960
d56b1705
MH
961/**
962 * struct batadv_nc_node - network coding node
963 * @list: next and prev pointer for the list handling
964 * @addr: the node's mac address
965 * @refcount: number of contexts the object is used by
966 * @rcu: struct used for freeing in an RCU-safe manner
967 * @orig_node: pointer to corresponding orig node struct
968 * @last_seen: timestamp of last ogm received from this node
969 */
970struct batadv_nc_node {
971 struct list_head list;
972 uint8_t addr[ETH_ALEN];
973 atomic_t refcount;
974 struct rcu_head rcu;
975 struct batadv_orig_node *orig_node;
976 unsigned long last_seen;
977};
978
95332477
MH
979/**
980 * struct batadv_nc_path - network coding path
981 * @hash_entry: next and prev pointer for the list handling
982 * @rcu: struct used for freeing in an RCU-safe manner
983 * @refcount: number of contexts the object is used by
984 * @packet_list: list of buffered packets for this path
985 * @packet_list_lock: access lock for packet list
986 * @next_hop: next hop (destination) of path
987 * @prev_hop: previous hop (source) of path
988 * @last_valid: timestamp for last validation of path
989 */
990struct batadv_nc_path {
991 struct hlist_node hash_entry;
992 struct rcu_head rcu;
993 atomic_t refcount;
994 struct list_head packet_list;
995 spinlock_t packet_list_lock; /* Protects packet_list */
996 uint8_t next_hop[ETH_ALEN];
997 uint8_t prev_hop[ETH_ALEN];
998 unsigned long last_valid;
999};
1000
1001/**
1002 * struct batadv_nc_packet - network coding packet used when coding and
1003 * decoding packets
1004 * @list: next and prev pointer for the list handling
1005 * @packet_id: crc32 checksum of skb data
1006 * @timestamp: field containing the info when the packet was added to path
1007 * @neigh_node: pointer to original next hop neighbor of skb
1008 * @skb: skb which can be encoded or used for decoding
1009 * @nc_path: pointer to path this nc packet is attached to
1010 */
1011struct batadv_nc_packet {
1012 struct list_head list;
1013 __be32 packet_id;
1014 unsigned long timestamp;
1015 struct batadv_neigh_node *neigh_node;
1016 struct sk_buff *skb;
1017 struct batadv_nc_path *nc_path;
1018};
1019
3c12de9a 1020/**
1a321b0d
SW
1021 * struct batadv_skb_cb - control buffer structure used to store private data
1022 * relevant to batman-adv in the skb->cb buffer in skbs.
3c12de9a
MH
1023 * @decoded: Marks a skb as decoded, which is checked when searching for coding
1024 * opportunities in network-coding.c
1025 */
1026struct batadv_skb_cb {
1027 bool decoded;
1028};
1029
88a32c9a
ML
1030/**
1031 * struct batadv_forw_packet - structure for bcast packets to be sent/forwarded
1032 * @list: list node for batadv_socket_client::queue_list
1033 * @send_time: execution time for delayed_work (packet sending)
1034 * @own: bool for locally generated packets (local OGMs are re-scheduled after
1035 * sending)
1036 * @skb: bcast packet's skb buffer
1037 * @packet_len: size of aggregated OGM packet inside the skb buffer
1038 * @direct_link_flags: direct link flags for aggregated OGM packets
1039 * @num_packets: counter for bcast packet retransmission
1040 * @delayed_work: work queue callback item for packet sending
ef0a937f
SW
1041 * @if_incoming: pointer to incoming hard-iface or primary iface if
1042 * locally generated packet
1043 * @if_outgoing: packet where the packet should be sent to, or NULL if
1044 * unspecified
c6c8fea2 1045 */
56303d34 1046struct batadv_forw_packet {
c6c8fea2
SE
1047 struct hlist_node list;
1048 unsigned long send_time;
1049 uint8_t own;
1050 struct sk_buff *skb;
1051 uint16_t packet_len;
1052 uint32_t direct_link_flags;
1053 uint8_t num_packets;
1054 struct delayed_work delayed_work;
56303d34 1055 struct batadv_hard_iface *if_incoming;
ef0a937f 1056 struct batadv_hard_iface *if_outgoing;
c6c8fea2
SE
1057};
1058
88a32c9a
ML
1059/**
1060 * struct batadv_algo_ops - mesh algorithm callbacks
1061 * @list: list node for the batadv_algo_list
1062 * @name: name of the algorithm
1063 * @bat_iface_enable: init routing info when hard-interface is enabled
1064 * @bat_iface_disable: de-init routing info when hard-interface is disabled
1065 * @bat_iface_update_mac: (re-)init mac addresses of the protocol information
1066 * belonging to this hard-interface
1067 * @bat_primary_iface_set: called when primary interface is selected / changed
1068 * @bat_ogm_schedule: prepare a new outgoing OGM for the send queue
1069 * @bat_ogm_emit: send scheduled OGM
89652331
SW
1070 * @bat_neigh_cmp: compare the metrics of two neighbors for their respective
1071 * outgoing interfaces
1072 * @bat_neigh_is_equiv_or_better: check if neigh1 is equally good or better
1073 * than neigh2 for their respective outgoing interface from the metric
1074 * prospective
737a2a22 1075 * @bat_orig_print: print the originator table (optional)
d0015fdd
AQ
1076 * @bat_orig_free: free the resources allocated by the routing algorithm for an
1077 * orig_node object
1078 * @bat_orig_add_if: ask the routing algorithm to apply the needed changes to
1079 * the orig_node due to a new hard-interface being added into the mesh
1080 * @bat_orig_del_if: ask the routing algorithm to apply the needed changes to
1081 * the orig_node due to an hard-interface being removed from the mesh
88a32c9a 1082 */
56303d34 1083struct batadv_algo_ops {
1c280471
ML
1084 struct hlist_node list;
1085 char *name;
56303d34 1086 int (*bat_iface_enable)(struct batadv_hard_iface *hard_iface);
56303d34 1087 void (*bat_iface_disable)(struct batadv_hard_iface *hard_iface);
56303d34 1088 void (*bat_iface_update_mac)(struct batadv_hard_iface *hard_iface);
56303d34 1089 void (*bat_primary_iface_set)(struct batadv_hard_iface *hard_iface);
56303d34 1090 void (*bat_ogm_schedule)(struct batadv_hard_iface *hard_iface);
56303d34 1091 void (*bat_ogm_emit)(struct batadv_forw_packet *forw_packet);
a3285a8f 1092 int (*bat_neigh_cmp)(struct batadv_neigh_node *neigh1,
89652331
SW
1093 struct batadv_hard_iface *if_outgoing1,
1094 struct batadv_neigh_node *neigh2,
1095 struct batadv_hard_iface *if_outgoing2);
1096 bool (*bat_neigh_is_equiv_or_better)
1097 (struct batadv_neigh_node *neigh1,
1098 struct batadv_hard_iface *if_outgoing1,
1099 struct batadv_neigh_node *neigh2,
1100 struct batadv_hard_iface *if_outgoing2);
737a2a22 1101 /* orig_node handling API */
cb1c92ec
SW
1102 void (*bat_orig_print)(struct batadv_priv *priv, struct seq_file *seq,
1103 struct batadv_hard_iface *hard_iface);
d0015fdd
AQ
1104 void (*bat_orig_free)(struct batadv_orig_node *orig_node);
1105 int (*bat_orig_add_if)(struct batadv_orig_node *orig_node,
1106 int max_if_num);
1107 int (*bat_orig_del_if)(struct batadv_orig_node *orig_node,
1108 int max_if_num, int del_if_num);
1c280471
ML
1109};
1110
2f1dfbe1
AQ
1111/**
1112 * struct batadv_dat_entry - it is a single entry of batman-adv ARP backend. It
1113 * is used to stored ARP entries needed for the global DAT cache
1114 * @ip: the IPv4 corresponding to this DAT/ARP entry
1115 * @mac_addr: the MAC address associated to the stored IPv4
be1db4f6 1116 * @vid: the vlan ID associated to this entry
2f1dfbe1
AQ
1117 * @last_update: time in jiffies when this entry was refreshed last time
1118 * @hash_entry: hlist node for batadv_priv_dat::hash
1119 * @refcount: number of contexts the object is used
1120 * @rcu: struct used for freeing in an RCU-safe manner
1121 */
1122struct batadv_dat_entry {
1123 __be32 ip;
1124 uint8_t mac_addr[ETH_ALEN];
be1db4f6 1125 unsigned short vid;
2f1dfbe1
AQ
1126 unsigned long last_update;
1127 struct hlist_node hash_entry;
1128 atomic_t refcount;
1129 struct rcu_head rcu;
1130};
1131
c5caf4ef
LL
1132/**
1133 * struct batadv_hw_addr - a list entry for a MAC address
1134 * @list: list node for the linking of entries
1135 * @addr: the MAC address of this list entry
1136 */
1137struct batadv_hw_addr {
1138 struct hlist_node list;
1139 unsigned char addr[ETH_ALEN];
1140};
1141
785ea114
AQ
1142/**
1143 * struct batadv_dat_candidate - candidate destination for DAT operations
1144 * @type: the type of the selected candidate. It can one of the following:
1145 * - BATADV_DAT_CANDIDATE_NOT_FOUND
1146 * - BATADV_DAT_CANDIDATE_ORIG
1147 * @orig_node: if type is BATADV_DAT_CANDIDATE_ORIG this field points to the
1148 * corresponding originator node structure
1149 */
1150struct batadv_dat_candidate {
1151 int type;
1152 struct batadv_orig_node *orig_node;
1153};
1154
ef261577
ML
1155/**
1156 * struct batadv_tvlv_container - container for tvlv appended to OGMs
1157 * @list: hlist node for batadv_priv_tvlv::container_list
1158 * @tvlv_hdr: tvlv header information needed to construct the tvlv
1159 * @value_len: length of the buffer following this struct which contains
1160 * the actual tvlv payload
1161 * @refcount: number of contexts the object is used
1162 */
1163struct batadv_tvlv_container {
1164 struct hlist_node list;
1165 struct batadv_tvlv_hdr tvlv_hdr;
1166 atomic_t refcount;
1167};
1168
1169/**
1170 * struct batadv_tvlv_handler - handler for specific tvlv type and version
1171 * @list: hlist node for batadv_priv_tvlv::handler_list
1172 * @ogm_handler: handler callback which is given the tvlv payload to process on
1173 * incoming OGM packets
1174 * @unicast_handler: handler callback which is given the tvlv payload to process
1175 * on incoming unicast tvlv packets
1176 * @type: tvlv type this handler feels responsible for
1177 * @version: tvlv version this handler feels responsible for
1178 * @flags: tvlv handler flags
1179 * @refcount: number of contexts the object is used
1180 * @rcu: struct used for freeing in an RCU-safe manner
1181 */
1182struct batadv_tvlv_handler {
1183 struct hlist_node list;
1184 void (*ogm_handler)(struct batadv_priv *bat_priv,
1185 struct batadv_orig_node *orig,
1186 uint8_t flags,
1187 void *tvlv_value, uint16_t tvlv_value_len);
1188 int (*unicast_handler)(struct batadv_priv *bat_priv,
1189 uint8_t *src, uint8_t *dst,
1190 void *tvlv_value, uint16_t tvlv_value_len);
1191 uint8_t type;
1192 uint8_t version;
1193 uint8_t flags;
1194 atomic_t refcount;
1195 struct rcu_head rcu;
1196};
1197
1198/**
1199 * enum batadv_tvlv_handler_flags - tvlv handler flags definitions
1200 * @BATADV_TVLV_HANDLER_OGM_CIFNOTFND: tvlv ogm processing function will call
1201 * this handler even if its type was not found (with no data)
1202 * @BATADV_TVLV_HANDLER_OGM_CALLED: interval tvlv handling flag - the API marks
1203 * a handler as being called, so it won't be called if the
1204 * BATADV_TVLV_HANDLER_OGM_CIFNOTFND flag was set
1205 */
1206enum batadv_tvlv_handler_flags {
1207 BATADV_TVLV_HANDLER_OGM_CIFNOTFND = BIT(1),
1208 BATADV_TVLV_HANDLER_OGM_CALLED = BIT(2),
1209};
1210
c6c8fea2 1211#endif /* _NET_BATMAN_ADV_TYPES_H_ */