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