1 /* Copyright (C) 2007-2013 B.A.T.M.A.N. contributors:
3 * Marek Lindner, Simon Wunderlich
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.
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.
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
20 #ifndef _NET_BATMAN_ADV_TYPES_H_
21 #define _NET_BATMAN_ADV_TYPES_H_
25 #include <linux/kernel.h>
28 * Maximum overhead for the encapsulation for a payload packet
30 #define BATADV_HEADER_LEN \
31 (ETH_HLEN + max(sizeof(struct batadv_unicast_packet), \
32 sizeof(struct batadv_bcast_packet)))
34 #ifdef CONFIG_BATMAN_ADV_DAT
36 /* batadv_dat_addr_t is the type used for all DHT addresses. If it is changed,
37 * BATADV_DAT_ADDR_MAX is changed as well.
39 * *Please be careful: batadv_dat_addr_t must be UNSIGNED*
41 #define batadv_dat_addr_t uint16_t
43 #endif /* CONFIG_BATMAN_ADV_DAT */
46 * struct batadv_hard_iface_bat_iv - per hard interface B.A.T.M.A.N. IV data
47 * @ogm_buff: buffer holding the OGM packet
48 * @ogm_buff_len: length of the OGM packet buffer
49 * @ogm_seqno: OGM sequence number - used to identify each OGM
51 struct batadv_hard_iface_bat_iv
{
52 unsigned char *ogm_buff
;
58 * struct batadv_hard_iface - network device known to batman-adv
59 * @list: list node for batadv_hardif_list
60 * @if_num: identificator of the interface
61 * @if_status: status of the interface for batman-adv
62 * @net_dev: pointer to the net_device
63 * @frag_seqno: last fragment sequence number sent by this interface
64 * @num_bcasts: number of payload re-broadcasts on this interface (ARQ)
65 * @hardif_obj: kobject of the per interface sysfs "mesh" directory
66 * @refcount: number of contexts the object is used
67 * @batman_adv_ptype: packet type describing packets that should be processed by
68 * batman-adv for this interface
69 * @soft_iface: the batman-adv interface which uses this network interface
70 * @rcu: struct used for freeing in an RCU-safe manner
71 * @bat_iv: BATMAN IV specific per hard interface data
72 * @cleanup_work: work queue callback item for hard interface deinit
74 struct batadv_hard_iface
{
75 struct list_head list
;
78 struct net_device
*net_dev
;
81 struct kobject
*hardif_obj
;
83 struct packet_type batman_adv_ptype
;
84 struct net_device
*soft_iface
;
86 struct batadv_hard_iface_bat_iv bat_iv
;
87 struct work_struct cleanup_work
;
91 * struct batadv_orig_node - structure for orig_list maintaining nodes of mesh
92 * @orig: originator ethernet address
93 * @primary_addr: hosts primary interface address
94 * @router: router that should be used to reach this originator
95 * @batadv_dat_addr_t: address of the orig node in the distributed hash
96 * @bcast_own: bitfield containing the number of our OGMs this orig_node
97 * rebroadcasted "back" to us (relative to last_real_seqno)
98 * @bcast_own_sum: counted result of bcast_own
99 * @last_seen: time when last packet from this node was received
100 * @bcast_seqno_reset: time when the broadcast seqno window was reset
101 * @batman_seqno_reset: time when the batman seqno window was reset
102 * @flags: for now only VIS_SERVER flag
103 * @last_ttvn: last seen translation table version number
104 * @tt_crc: CRC of the translation table
105 * @tt_buff: last tt changeset this node received from the orig node
106 * @tt_buff_len: length of the last tt changeset this node received from the
108 * @tt_buff_lock: lock that protects tt_buff and tt_buff_len
109 * @tt_size: number of global TT entries announced by the orig node
110 * @tt_initialised: bool keeping track of whether or not this node have received
111 * any translation table information from the orig node yet
112 * @last_real_seqno: last and best known sequence number
113 * @last_ttl: ttl of last received packet
114 * @bcast_bits: bitfield containing the info which payload broadcast originated
115 * from this orig node this host already has seen (relative to
117 * @last_bcast_seqno: last broadcast sequence number received by this host
118 * @neigh_list: list of potential next hop neighbor towards this orig node
119 * @frag_list: fragmentation buffer list for fragment re-assembly
120 * @last_frag_packet: time when last fragmented packet from this node was
122 * @neigh_list_lock: lock protecting neigh_list, router and bonding_list
123 * @hash_entry: hlist node for batadv_priv::orig_hash
124 * @bat_priv: pointer to soft_iface this orig node belongs to
125 * @ogm_cnt_lock: lock protecting bcast_own, bcast_own_sum,
126 * neigh_node->real_bits & neigh_node->real_packet_count
127 * @bcast_seqno_lock: lock protecting bcast_bits & last_bcast_seqno
128 * @bond_candidates: how many candidates are available
129 * @bond_list: list of bonding candidates
130 * @refcount: number of contexts the object is used
131 * @rcu: struct used for freeing in an RCU-safe manner
132 * @in_coding_list: list of nodes this orig can hear
133 * @out_coding_list: list of nodes that can hear this orig
134 * @in_coding_list_lock: protects in_coding_list
135 * @out_coding_list_lock: protects out_coding_list
137 struct batadv_orig_node
{
138 uint8_t orig
[ETH_ALEN
];
139 uint8_t primary_addr
[ETH_ALEN
];
140 struct batadv_neigh_node __rcu
*router
; /* rcu protected pointer */
141 #ifdef CONFIG_BATMAN_ADV_DAT
142 batadv_dat_addr_t dat_addr
;
144 unsigned long *bcast_own
;
145 uint8_t *bcast_own_sum
;
146 unsigned long last_seen
;
147 unsigned long bcast_seqno_reset
;
148 unsigned long batman_seqno_reset
;
152 unsigned char *tt_buff
;
154 spinlock_t tt_buff_lock
; /* protects tt_buff & tt_buff_len */
157 uint32_t last_real_seqno
;
159 DECLARE_BITMAP(bcast_bits
, BATADV_TQ_LOCAL_WINDOW_SIZE
);
160 uint32_t last_bcast_seqno
;
161 struct hlist_head neigh_list
;
162 struct list_head frag_list
;
163 unsigned long last_frag_packet
;
164 /* neigh_list_lock protects: neigh_list, router & bonding_list */
165 spinlock_t neigh_list_lock
;
166 struct hlist_node hash_entry
;
167 struct batadv_priv
*bat_priv
;
168 /* ogm_cnt_lock protects: bcast_own, bcast_own_sum,
169 * neigh_node->real_bits & neigh_node->real_packet_count
171 spinlock_t ogm_cnt_lock
;
172 /* bcast_seqno_lock protects: bcast_bits & last_bcast_seqno */
173 spinlock_t bcast_seqno_lock
;
174 atomic_t bond_candidates
;
175 struct list_head bond_list
;
178 #ifdef CONFIG_BATMAN_ADV_NC
179 struct list_head in_coding_list
;
180 struct list_head out_coding_list
;
181 spinlock_t in_coding_list_lock
; /* Protects in_coding_list */
182 spinlock_t out_coding_list_lock
; /* Protects out_coding_list */
187 * struct batadv_gw_node - structure for orig nodes announcing gw capabilities
188 * @list: list node for batadv_priv_gw::list
189 * @orig_node: pointer to corresponding orig node
190 * @bandwidth_down: advertised uplink download bandwidth
191 * @bandwidth_up: advertised uplink upload bandwidth
192 * @deleted: this struct is scheduled for deletion
193 * @refcount: number of contexts the object is used
194 * @rcu: struct used for freeing in an RCU-safe manner
196 struct batadv_gw_node
{
197 struct hlist_node list
;
198 struct batadv_orig_node
*orig_node
;
199 uint32_t bandwidth_down
;
200 uint32_t bandwidth_up
;
201 unsigned long deleted
;
207 * struct batadv_neigh_node - structure for single hop neighbors
208 * @list: list node for batadv_orig_node::neigh_list
209 * @addr: mac address of neigh node
210 * @tq_recv: ring buffer of received TQ values from this neigh node
211 * @tq_index: ring buffer index
212 * @tq_avg: averaged tq of all tq values in the ring buffer (tq_recv)
213 * @last_ttl: last received ttl from this neigh node
214 * @bonding_list: list node for batadv_orig_node::bond_list
215 * @last_seen: when last packet via this neighbor was received
216 * @real_bits: bitfield containing the number of OGMs received from this neigh
217 * node (relative to orig_node->last_real_seqno)
218 * @real_packet_count: counted result of real_bits
219 * @orig_node: pointer to corresponding orig_node
220 * @if_incoming: pointer to incoming hard interface
221 * @lq_update_lock: lock protecting tq_recv & tq_index
222 * @refcount: number of contexts the object is used
223 * @rcu: struct used for freeing in an RCU-safe manner
225 struct batadv_neigh_node
{
226 struct hlist_node list
;
227 uint8_t addr
[ETH_ALEN
];
228 uint8_t tq_recv
[BATADV_TQ_GLOBAL_WINDOW_SIZE
];
232 struct list_head bonding_list
;
233 unsigned long last_seen
;
234 DECLARE_BITMAP(real_bits
, BATADV_TQ_LOCAL_WINDOW_SIZE
);
235 uint8_t real_packet_count
;
236 struct batadv_orig_node
*orig_node
;
237 struct batadv_hard_iface
*if_incoming
;
238 spinlock_t lq_update_lock
; /* protects tq_recv & tq_index */
244 * struct batadv_bcast_duplist_entry - structure for LAN broadcast suppression
245 * @orig[ETH_ALEN]: mac address of orig node orginating the broadcast
246 * @crc: crc32 checksum of broadcast payload
247 * @entrytime: time when the broadcast packet was received
249 #ifdef CONFIG_BATMAN_ADV_BLA
250 struct batadv_bcast_duplist_entry
{
251 uint8_t orig
[ETH_ALEN
];
253 unsigned long entrytime
;
258 * enum batadv_counters - indices for traffic counters
259 * @BATADV_CNT_TX: transmitted payload traffic packet counter
260 * @BATADV_CNT_TX_BYTES: transmitted payload traffic bytes counter
261 * @BATADV_CNT_TX_DROPPED: dropped transmission payload traffic packet counter
262 * @BATADV_CNT_RX: received payload traffic packet counter
263 * @BATADV_CNT_RX_BYTES: received payload traffic bytes counter
264 * @BATADV_CNT_FORWARD: forwarded payload traffic packet counter
265 * @BATADV_CNT_FORWARD_BYTES: forwarded payload traffic bytes counter
266 * @BATADV_CNT_MGMT_TX: transmitted routing protocol traffic packet counter
267 * @BATADV_CNT_MGMT_TX_BYTES: transmitted routing protocol traffic bytes counter
268 * @BATADV_CNT_MGMT_RX: received routing protocol traffic packet counter
269 * @BATADV_CNT_MGMT_RX_BYTES: received routing protocol traffic bytes counter
270 * @BATADV_CNT_TT_REQUEST_TX: transmitted tt req traffic packet counter
271 * @BATADV_CNT_TT_REQUEST_RX: received tt req traffic packet counter
272 * @BATADV_CNT_TT_RESPONSE_TX: transmitted tt resp traffic packet counter
273 * @BATADV_CNT_TT_RESPONSE_RX: received tt resp traffic packet counter
274 * @BATADV_CNT_TT_ROAM_ADV_TX: transmitted tt roam traffic packet counter
275 * @BATADV_CNT_TT_ROAM_ADV_RX: received tt roam traffic packet counter
276 * @BATADV_CNT_DAT_GET_TX: transmitted dht GET traffic packet counter
277 * @BATADV_CNT_DAT_GET_RX: received dht GET traffic packet counter
278 * @BATADV_CNT_DAT_PUT_TX: transmitted dht PUT traffic packet counter
279 * @BATADV_CNT_DAT_PUT_RX: received dht PUT traffic packet counter
280 * @BATADV_CNT_DAT_CACHED_REPLY_TX: transmitted dat cache reply traffic packet
282 * @BATADV_CNT_NC_CODE: transmitted nc-combined traffic packet counter
283 * @BATADV_CNT_NC_CODE_BYTES: transmitted nc-combined traffic bytes counter
284 * @BATADV_CNT_NC_RECODE: transmitted nc-recombined traffic packet counter
285 * @BATADV_CNT_NC_RECODE_BYTES: transmitted nc-recombined traffic bytes counter
286 * @BATADV_CNT_NC_BUFFER: counter for packets buffered for later nc decoding
287 * @BATADV_CNT_NC_DECODE: received and nc-decoded traffic packet counter
288 * @BATADV_CNT_NC_DECODE_BYTES: received and nc-decoded traffic bytes counter
289 * @BATADV_CNT_NC_DECODE_FAILED: received and decode-failed traffic packet
291 * @BATADV_CNT_NC_SNIFFED: counter for nc-decoded packets received in promisc
293 * @BATADV_CNT_NUM: number of traffic counters
295 enum batadv_counters
{
298 BATADV_CNT_TX_DROPPED
,
302 BATADV_CNT_FORWARD_BYTES
,
304 BATADV_CNT_MGMT_TX_BYTES
,
306 BATADV_CNT_MGMT_RX_BYTES
,
307 BATADV_CNT_TT_REQUEST_TX
,
308 BATADV_CNT_TT_REQUEST_RX
,
309 BATADV_CNT_TT_RESPONSE_TX
,
310 BATADV_CNT_TT_RESPONSE_RX
,
311 BATADV_CNT_TT_ROAM_ADV_TX
,
312 BATADV_CNT_TT_ROAM_ADV_RX
,
313 #ifdef CONFIG_BATMAN_ADV_DAT
314 BATADV_CNT_DAT_GET_TX
,
315 BATADV_CNT_DAT_GET_RX
,
316 BATADV_CNT_DAT_PUT_TX
,
317 BATADV_CNT_DAT_PUT_RX
,
318 BATADV_CNT_DAT_CACHED_REPLY_TX
,
320 #ifdef CONFIG_BATMAN_ADV_NC
322 BATADV_CNT_NC_CODE_BYTES
,
323 BATADV_CNT_NC_RECODE
,
324 BATADV_CNT_NC_RECODE_BYTES
,
325 BATADV_CNT_NC_BUFFER
,
326 BATADV_CNT_NC_DECODE
,
327 BATADV_CNT_NC_DECODE_BYTES
,
328 BATADV_CNT_NC_DECODE_FAILED
,
329 BATADV_CNT_NC_SNIFFED
,
335 * struct batadv_priv_tt - per mesh interface translation table data
336 * @vn: translation table version number
337 * @ogm_append_cnt: counter of number of OGMs containing the local tt diff
338 * @local_changes: changes registered in an originator interval
339 * @changes_list: tracks tt local changes within an originator interval
340 * @local_hash: local translation table hash table
341 * @global_hash: global translation table hash table
342 * @req_list: list of pending & unanswered tt_requests
343 * @roam_list: list of the last roaming events of each client limiting the
344 * number of roaming events to avoid route flapping
345 * @changes_list_lock: lock protecting changes_list
346 * @req_list_lock: lock protecting req_list
347 * @roam_list_lock: lock protecting roam_list
348 * @local_entry_num: number of entries in the local hash table
349 * @local_crc: Checksum of the local table, recomputed before sending a new OGM
350 * @last_changeset: last tt changeset this host has generated
351 * @last_changeset_len: length of last tt changeset this host has generated
352 * @last_changeset_lock: lock protecting last_changeset & last_changeset_len
353 * @work: work queue callback item for translation table purging
355 struct batadv_priv_tt
{
357 atomic_t ogm_append_cnt
;
358 atomic_t local_changes
;
359 struct list_head changes_list
;
360 struct batadv_hashtable
*local_hash
;
361 struct batadv_hashtable
*global_hash
;
362 struct list_head req_list
;
363 struct list_head roam_list
;
364 spinlock_t changes_list_lock
; /* protects changes */
365 spinlock_t req_list_lock
; /* protects req_list */
366 spinlock_t roam_list_lock
; /* protects roam_list */
367 atomic_t local_entry_num
;
369 unsigned char *last_changeset
;
370 int16_t last_changeset_len
;
371 /* protects last_changeset & last_changeset_len */
372 spinlock_t last_changeset_lock
;
373 struct delayed_work work
;
377 * struct batadv_priv_bla - per mesh interface bridge loope avoidance data
378 * @num_requests; number of bla requests in flight
379 * @claim_hash: hash table containing mesh nodes this host has claimed
380 * @backbone_hash: hash table containing all detected backbone gateways
381 * @bcast_duplist: recently received broadcast packets array (for broadcast
382 * duplicate suppression)
383 * @bcast_duplist_curr: index of last broadcast packet added to bcast_duplist
384 * @bcast_duplist_lock: lock protecting bcast_duplist & bcast_duplist_curr
385 * @claim_dest: local claim data (e.g. claim group)
386 * @work: work queue callback item for cleanups & bla announcements
388 #ifdef CONFIG_BATMAN_ADV_BLA
389 struct batadv_priv_bla
{
390 atomic_t num_requests
;
391 struct batadv_hashtable
*claim_hash
;
392 struct batadv_hashtable
*backbone_hash
;
393 struct batadv_bcast_duplist_entry bcast_duplist
[BATADV_DUPLIST_SIZE
];
394 int bcast_duplist_curr
;
395 /* protects bcast_duplist & bcast_duplist_curr */
396 spinlock_t bcast_duplist_lock
;
397 struct batadv_bla_claim_dst claim_dest
;
398 struct delayed_work work
;
403 * struct batadv_debug_log - debug logging data
404 * @log_buff: buffer holding the logs (ring bufer)
405 * @log_start: index of next character to read
406 * @log_end: index of next character to write
407 * @lock: lock protecting log_buff, log_start & log_end
408 * @queue_wait: log reader's wait queue
410 #ifdef CONFIG_BATMAN_ADV_DEBUG
411 struct batadv_priv_debug_log
{
412 char log_buff
[BATADV_LOG_BUF_LEN
];
413 unsigned long log_start
;
414 unsigned long log_end
;
415 spinlock_t lock
; /* protects log_buff, log_start and log_end */
416 wait_queue_head_t queue_wait
;
421 * struct batadv_priv_gw - per mesh interface gateway data
422 * @list: list of available gateway nodes
423 * @list_lock: lock protecting gw_list & curr_gw
424 * @curr_gw: pointer to currently selected gateway node
425 * @bandwidth_down: advertised uplink download bandwidth (if gw_mode server)
426 * @bandwidth_up: advertised uplink upload bandwidth (if gw_mode server)
427 * @reselect: bool indicating a gateway re-selection is in progress
429 struct batadv_priv_gw
{
430 struct hlist_head list
;
431 spinlock_t list_lock
; /* protects gw_list & curr_gw */
432 struct batadv_gw_node __rcu
*curr_gw
; /* rcu protected pointer */
433 atomic_t bandwidth_down
;
434 atomic_t bandwidth_up
;
439 * struct batadv_priv_tvlv - per mesh interface tvlv data
440 * @container_list: list of registered tvlv containers to be sent with each OGM
441 * @handler_list: list of the various tvlv content handlers
442 * @container_list_lock: protects tvlv container list access
443 * @handler_list_lock: protects handler list access
445 struct batadv_priv_tvlv
{
446 struct hlist_head container_list
;
447 struct hlist_head handler_list
;
448 spinlock_t container_list_lock
; /* protects container_list */
449 spinlock_t handler_list_lock
; /* protects handler_list */
453 * struct batadv_priv_vis - per mesh interface vis data
454 * @send_list: list of batadv_vis_info packets to sent
455 * @hash: hash table containing vis data from other nodes in the network
456 * @hash_lock: lock protecting the hash table
457 * @list_lock: lock protecting my_info::recv_list
458 * @work: work queue callback item for vis packet sending
459 * @my_info: holds this node's vis data sent on a regular basis
461 struct batadv_priv_vis
{
462 struct list_head send_list
;
463 struct batadv_hashtable
*hash
;
464 spinlock_t hash_lock
; /* protects hash */
465 spinlock_t list_lock
; /* protects my_info::recv_list */
466 struct delayed_work work
;
467 struct batadv_vis_info
*my_info
;
471 * struct batadv_priv_dat - per mesh interface DAT private data
472 * @addr: node DAT address
473 * @hash: hashtable representing the local ARP cache
474 * @work: work queue callback item for cache purging
476 #ifdef CONFIG_BATMAN_ADV_DAT
477 struct batadv_priv_dat
{
478 batadv_dat_addr_t addr
;
479 struct batadv_hashtable
*hash
;
480 struct delayed_work work
;
485 * struct batadv_priv_nc - per mesh interface network coding private data
486 * @work: work queue callback item for cleanup
487 * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
488 * @min_tq: only consider neighbors for encoding if neigh_tq > min_tq
489 * @max_fwd_delay: maximum packet forward delay to allow coding of packets
490 * @max_buffer_time: buffer time for sniffed packets used to decoding
491 * @timestamp_fwd_flush: timestamp of last forward packet queue flush
492 * @timestamp_sniffed_purge: timestamp of last sniffed packet queue purge
493 * @coding_hash: Hash table used to buffer skbs while waiting for another
494 * incoming skb to code it with. Skbs are added to the buffer just before being
495 * forwarded in routing.c
496 * @decoding_hash: Hash table used to buffer skbs that might be needed to decode
497 * a received coded skb. The buffer is used for 1) skbs arriving on the
498 * soft-interface; 2) skbs overheard on the hard-interface; and 3) skbs
499 * forwarded by batman-adv.
501 struct batadv_priv_nc
{
502 struct delayed_work work
;
503 struct dentry
*debug_dir
;
507 unsigned long timestamp_fwd_flush
;
508 unsigned long timestamp_sniffed_purge
;
509 struct batadv_hashtable
*coding_hash
;
510 struct batadv_hashtable
*decoding_hash
;
514 * struct batadv_priv - per mesh interface data
515 * @mesh_state: current status of the mesh (inactive/active/deactivating)
516 * @soft_iface: net device which holds this struct as private data
517 * @stats: structure holding the data for the ndo_get_stats() call
518 * @bat_counters: mesh internal traffic statistic counters (see batadv_counters)
519 * @aggregated_ogms: bool indicating whether OGM aggregation is enabled
520 * @bonding: bool indicating whether traffic bonding is enabled
521 * @fragmentation: bool indicating whether traffic fragmentation is enabled
522 * @ap_isolation: bool indicating whether ap isolation is enabled
523 * @bridge_loop_avoidance: bool indicating whether bridge loop avoidance is
525 * @distributed_arp_table: bool indicating whether distributed ARP table is
527 * @vis_mode: vis operation: client or server (see batadv_vis_packettype)
528 * @gw_mode: gateway operation: off, client or server (see batadv_gw_modes)
529 * @gw_sel_class: gateway selection class (applies if gw_mode client)
530 * @orig_interval: OGM broadcast interval in milliseconds
531 * @hop_penalty: penalty which will be applied to an OGM's tq-field on every hop
532 * @log_level: configured log level (see batadv_dbg_level)
533 * @bcast_seqno: last sent broadcast packet sequence number
534 * @bcast_queue_left: number of remaining buffered broadcast packet slots
535 * @batman_queue_left: number of remaining OGM packet slots
536 * @num_ifaces: number of interfaces assigned to this mesh interface
537 * @mesh_obj: kobject for sysfs mesh subdirectory
538 * @debug_dir: dentry for debugfs batman-adv subdirectory
539 * @forw_bat_list: list of aggregated OGMs that will be forwarded
540 * @forw_bcast_list: list of broadcast packets that will be rebroadcasted
541 * @orig_hash: hash table containing mesh participants (orig nodes)
542 * @forw_bat_list_lock: lock protecting forw_bat_list
543 * @forw_bcast_list_lock: lock protecting forw_bcast_list
544 * @orig_work: work queue callback item for orig node purging
545 * @cleanup_work: work queue callback item for soft interface deinit
546 * @primary_if: one of the hard interfaces assigned to this mesh interface
547 * becomes the primary interface
548 * @bat_algo_ops: routing algorithm used by this mesh interface
549 * @bla: bridge loope avoidance data
550 * @debug_log: holding debug logging relevant data
552 * @tt: translation table data
553 * @tvlv: type-version-length-value data
555 * @dat: distributed arp table data
556 * @network_coding: bool indicating whether network coding is enabled
557 * @batadv_priv_nc: network coding data
561 struct net_device
*soft_iface
;
562 struct net_device_stats stats
;
563 uint64_t __percpu
*bat_counters
; /* Per cpu counters */
564 atomic_t aggregated_ogms
;
566 atomic_t fragmentation
;
567 atomic_t ap_isolation
;
568 #ifdef CONFIG_BATMAN_ADV_BLA
569 atomic_t bridge_loop_avoidance
;
571 #ifdef CONFIG_BATMAN_ADV_DAT
572 atomic_t distributed_arp_table
;
576 atomic_t gw_sel_class
;
577 atomic_t orig_interval
;
578 atomic_t hop_penalty
;
579 #ifdef CONFIG_BATMAN_ADV_DEBUG
582 atomic_t bcast_seqno
;
583 atomic_t bcast_queue_left
;
584 atomic_t batman_queue_left
;
586 struct kobject
*mesh_obj
;
587 struct dentry
*debug_dir
;
588 struct hlist_head forw_bat_list
;
589 struct hlist_head forw_bcast_list
;
590 struct batadv_hashtable
*orig_hash
;
591 spinlock_t forw_bat_list_lock
; /* protects forw_bat_list */
592 spinlock_t forw_bcast_list_lock
; /* protects forw_bcast_list */
593 struct delayed_work orig_work
;
594 struct work_struct cleanup_work
;
595 struct batadv_hard_iface __rcu
*primary_if
; /* rcu protected pointer */
596 struct batadv_algo_ops
*bat_algo_ops
;
597 #ifdef CONFIG_BATMAN_ADV_BLA
598 struct batadv_priv_bla bla
;
600 #ifdef CONFIG_BATMAN_ADV_DEBUG
601 struct batadv_priv_debug_log
*debug_log
;
603 struct batadv_priv_gw gw
;
604 struct batadv_priv_tt tt
;
605 struct batadv_priv_tvlv tvlv
;
606 struct batadv_priv_vis vis
;
607 #ifdef CONFIG_BATMAN_ADV_DAT
608 struct batadv_priv_dat dat
;
610 #ifdef CONFIG_BATMAN_ADV_NC
611 atomic_t network_coding
;
612 struct batadv_priv_nc nc
;
613 #endif /* CONFIG_BATMAN_ADV_NC */
617 * struct batadv_socket_client - layer2 icmp socket client data
618 * @queue_list: packet queue for packets destined for this socket client
619 * @queue_len: number of packets in the packet queue (queue_list)
620 * @index: socket client's index in the batadv_socket_client_hash
621 * @lock: lock protecting queue_list, queue_len & index
622 * @queue_wait: socket client's wait queue
623 * @bat_priv: pointer to soft_iface this client belongs to
625 struct batadv_socket_client
{
626 struct list_head queue_list
;
627 unsigned int queue_len
;
629 spinlock_t lock
; /* protects queue_list, queue_len & index */
630 wait_queue_head_t queue_wait
;
631 struct batadv_priv
*bat_priv
;
635 * struct batadv_socket_packet - layer2 icmp packet for socket client
636 * @list: list node for batadv_socket_client::queue_list
637 * @icmp_len: size of the layer2 icmp packet
638 * @icmp_packet: layer2 icmp packet
640 struct batadv_socket_packet
{
641 struct list_head list
;
643 struct batadv_icmp_packet_rr icmp_packet
;
647 * struct batadv_bla_backbone_gw - batman-adv gateway bridged into the LAN
648 * @orig: originator address of backbone node (mac address of primary iface)
649 * @vid: vlan id this gateway was detected on
650 * @hash_entry: hlist node for batadv_priv_bla::backbone_hash
651 * @bat_priv: pointer to soft_iface this backbone gateway belongs to
652 * @lasttime: last time we heard of this backbone gw
653 * @wait_periods: grace time for bridge forward delays and bla group forming at
654 * bootup phase - no bcast traffic is formwared until it has elapsed
655 * @request_sent: if this bool is set to true we are out of sync with this
656 * backbone gateway - no bcast traffic is formwared until the situation was
658 * @crc: crc16 checksum over all claims
659 * @refcount: number of contexts the object is used
660 * @rcu: struct used for freeing in an RCU-safe manner
662 #ifdef CONFIG_BATMAN_ADV_BLA
663 struct batadv_bla_backbone_gw
{
664 uint8_t orig
[ETH_ALEN
];
666 struct hlist_node hash_entry
;
667 struct batadv_priv
*bat_priv
;
668 unsigned long lasttime
;
669 atomic_t wait_periods
;
670 atomic_t request_sent
;
677 * struct batadv_bla_claim - claimed non-mesh client structure
678 * @addr: mac address of claimed non-mesh client
679 * @vid: vlan id this client was detected on
680 * @batadv_bla_backbone_gw: pointer to backbone gw claiming this client
681 * @lasttime: last time we heard of claim (locals only)
682 * @hash_entry: hlist node for batadv_priv_bla::claim_hash
683 * @refcount: number of contexts the object is used
684 * @rcu: struct used for freeing in an RCU-safe manner
686 struct batadv_bla_claim
{
687 uint8_t addr
[ETH_ALEN
];
689 struct batadv_bla_backbone_gw
*backbone_gw
;
690 unsigned long lasttime
;
691 struct hlist_node hash_entry
;
698 * struct batadv_tt_common_entry - tt local & tt global common data
699 * @addr: mac address of non-mesh client
700 * @hash_entry: hlist node for batadv_priv_tt::local_hash or for
701 * batadv_priv_tt::global_hash
702 * @flags: various state handling flags (see batadv_tt_client_flags)
703 * @added_at: timestamp used for purging stale tt common entries
704 * @refcount: number of contexts the object is used
705 * @rcu: struct used for freeing in an RCU-safe manner
707 struct batadv_tt_common_entry
{
708 uint8_t addr
[ETH_ALEN
];
709 struct hlist_node hash_entry
;
711 unsigned long added_at
;
717 * struct batadv_tt_local_entry - translation table local entry data
718 * @common: general translation table data
719 * @last_seen: timestamp used for purging stale tt local entries
721 struct batadv_tt_local_entry
{
722 struct batadv_tt_common_entry common
;
723 unsigned long last_seen
;
727 * struct batadv_tt_global_entry - translation table global entry data
728 * @common: general translation table data
729 * @orig_list: list of orig nodes announcing this non-mesh client
730 * @list_lock: lock protecting orig_list
731 * @roam_at: time at which TT_GLOBAL_ROAM was set
733 struct batadv_tt_global_entry
{
734 struct batadv_tt_common_entry common
;
735 struct hlist_head orig_list
;
736 spinlock_t list_lock
; /* protects orig_list */
737 unsigned long roam_at
;
741 * struct batadv_tt_orig_list_entry - orig node announcing a non-mesh client
742 * @orig_node: pointer to orig node announcing this non-mesh client
743 * @ttvn: translation table version number which added the non-mesh client
744 * @list: list node for batadv_tt_global_entry::orig_list
745 * @refcount: number of contexts the object is used
746 * @rcu: struct used for freeing in an RCU-safe manner
748 struct batadv_tt_orig_list_entry
{
749 struct batadv_orig_node
*orig_node
;
751 struct hlist_node list
;
757 * struct batadv_tt_change_node - structure for tt changes occured
758 * @list: list node for batadv_priv_tt::changes_list
759 * @change: holds the actual translation table diff data
761 struct batadv_tt_change_node
{
762 struct list_head list
;
763 struct batadv_tt_change change
;
767 * struct batadv_tt_req_node - data to keep track of the tt requests in flight
768 * @addr: mac address address of the originator this request was sent to
769 * @issued_at: timestamp used for purging stale tt requests
770 * @list: list node for batadv_priv_tt::req_list
772 struct batadv_tt_req_node
{
773 uint8_t addr
[ETH_ALEN
];
774 unsigned long issued_at
;
775 struct list_head list
;
779 * struct batadv_tt_roam_node - roaming client data
780 * @addr: mac address of the client in the roaming phase
781 * @counter: number of allowed roaming events per client within a single
782 * OGM interval (changes are committed with each OGM)
783 * @first_time: timestamp used for purging stale roaming node entries
784 * @list: list node for batadv_priv_tt::roam_list
786 struct batadv_tt_roam_node
{
787 uint8_t addr
[ETH_ALEN
];
789 unsigned long first_time
;
790 struct list_head list
;
794 * struct batadv_nc_node - network coding node
795 * @list: next and prev pointer for the list handling
796 * @addr: the node's mac address
797 * @refcount: number of contexts the object is used by
798 * @rcu: struct used for freeing in an RCU-safe manner
799 * @orig_node: pointer to corresponding orig node struct
800 * @last_seen: timestamp of last ogm received from this node
802 struct batadv_nc_node
{
803 struct list_head list
;
804 uint8_t addr
[ETH_ALEN
];
807 struct batadv_orig_node
*orig_node
;
808 unsigned long last_seen
;
812 * struct batadv_nc_path - network coding path
813 * @hash_entry: next and prev pointer for the list handling
814 * @rcu: struct used for freeing in an RCU-safe manner
815 * @refcount: number of contexts the object is used by
816 * @packet_list: list of buffered packets for this path
817 * @packet_list_lock: access lock for packet list
818 * @next_hop: next hop (destination) of path
819 * @prev_hop: previous hop (source) of path
820 * @last_valid: timestamp for last validation of path
822 struct batadv_nc_path
{
823 struct hlist_node hash_entry
;
826 struct list_head packet_list
;
827 spinlock_t packet_list_lock
; /* Protects packet_list */
828 uint8_t next_hop
[ETH_ALEN
];
829 uint8_t prev_hop
[ETH_ALEN
];
830 unsigned long last_valid
;
834 * struct batadv_nc_packet - network coding packet used when coding and
836 * @list: next and prev pointer for the list handling
837 * @packet_id: crc32 checksum of skb data
838 * @timestamp: field containing the info when the packet was added to path
839 * @neigh_node: pointer to original next hop neighbor of skb
840 * @skb: skb which can be encoded or used for decoding
841 * @nc_path: pointer to path this nc packet is attached to
843 struct batadv_nc_packet
{
844 struct list_head list
;
846 unsigned long timestamp
;
847 struct batadv_neigh_node
*neigh_node
;
849 struct batadv_nc_path
*nc_path
;
853 * batadv_skb_cb - control buffer structure used to store private data relevant
854 * to batman-adv in the skb->cb buffer in skbs.
855 * @decoded: Marks a skb as decoded, which is checked when searching for coding
856 * opportunities in network-coding.c
858 struct batadv_skb_cb
{
863 * struct batadv_forw_packet - structure for bcast packets to be sent/forwarded
864 * @list: list node for batadv_socket_client::queue_list
865 * @send_time: execution time for delayed_work (packet sending)
866 * @own: bool for locally generated packets (local OGMs are re-scheduled after
868 * @skb: bcast packet's skb buffer
869 * @packet_len: size of aggregated OGM packet inside the skb buffer
870 * @direct_link_flags: direct link flags for aggregated OGM packets
871 * @num_packets: counter for bcast packet retransmission
872 * @delayed_work: work queue callback item for packet sending
873 * @if_incoming: pointer incoming hard-iface or primary iface if locally
876 struct batadv_forw_packet
{
877 struct hlist_node list
;
878 unsigned long send_time
;
882 uint32_t direct_link_flags
;
884 struct delayed_work delayed_work
;
885 struct batadv_hard_iface
*if_incoming
;
889 * struct batadv_frag_packet_list_entry - storage for fragment packet
890 * @list: list node for orig_node::frag_list
891 * @seqno: sequence number of the fragment
892 * @skb: fragment's skb buffer
894 struct batadv_frag_packet_list_entry
{
895 struct list_head list
;
901 * struct batadv_vis_info - local data for vis information
902 * @first_seen: timestamp used for purging stale vis info entries
903 * @recv_list: List of server-neighbors we have received this packet from. This
904 * packet should not be re-forward to them again. List elements are struct
905 * batadv_vis_recvlist_node
906 * @send_list: list of packets to be forwarded
907 * @refcount: number of contexts the object is used
908 * @hash_entry: hlist node for batadv_priv_vis::hash
909 * @bat_priv: pointer to soft_iface this orig node belongs to
910 * @skb_packet: contains the vis packet
912 struct batadv_vis_info
{
913 unsigned long first_seen
;
914 struct list_head recv_list
;
915 struct list_head send_list
;
916 struct kref refcount
;
917 struct hlist_node hash_entry
;
918 struct batadv_priv
*bat_priv
;
919 struct sk_buff
*skb_packet
;
923 * struct batadv_vis_info_entry - contains link information for vis
924 * @src: source MAC of the link, all zero for local TT entry
925 * @dst: destination MAC of the link, client mac address for local TT entry
926 * @quality: transmission quality of the link, or 0 for local TT entry
928 struct batadv_vis_info_entry
{
929 uint8_t src
[ETH_ALEN
];
930 uint8_t dest
[ETH_ALEN
];
935 * struct batadv_vis_recvlist_node - list entry for batadv_vis_info::recv_list
936 * @list: list node for batadv_vis_info::recv_list
937 * @mac: MAC address of the originator from where the vis_info was received
939 struct batadv_vis_recvlist_node
{
940 struct list_head list
;
941 uint8_t mac
[ETH_ALEN
];
945 * struct batadv_vis_if_list_entry - auxiliary data for vis data generation
946 * @addr: MAC address of the interface
947 * @primary: true if this interface is the primary interface
948 * @list: list node the interface list
950 * While scanning for vis-entries of a particular vis-originator
951 * this list collects its interfaces to create a subgraph/cluster
954 struct batadv_vis_if_list_entry
{
955 uint8_t addr
[ETH_ALEN
];
957 struct hlist_node list
;
961 * struct batadv_algo_ops - mesh algorithm callbacks
962 * @list: list node for the batadv_algo_list
963 * @name: name of the algorithm
964 * @bat_iface_enable: init routing info when hard-interface is enabled
965 * @bat_iface_disable: de-init routing info when hard-interface is disabled
966 * @bat_iface_update_mac: (re-)init mac addresses of the protocol information
967 * belonging to this hard-interface
968 * @bat_primary_iface_set: called when primary interface is selected / changed
969 * @bat_ogm_schedule: prepare a new outgoing OGM for the send queue
970 * @bat_ogm_emit: send scheduled OGM
972 struct batadv_algo_ops
{
973 struct hlist_node list
;
975 int (*bat_iface_enable
)(struct batadv_hard_iface
*hard_iface
);
976 void (*bat_iface_disable
)(struct batadv_hard_iface
*hard_iface
);
977 void (*bat_iface_update_mac
)(struct batadv_hard_iface
*hard_iface
);
978 void (*bat_primary_iface_set
)(struct batadv_hard_iface
*hard_iface
);
979 void (*bat_ogm_schedule
)(struct batadv_hard_iface
*hard_iface
);
980 void (*bat_ogm_emit
)(struct batadv_forw_packet
*forw_packet
);
984 * struct batadv_dat_entry - it is a single entry of batman-adv ARP backend. It
985 * is used to stored ARP entries needed for the global DAT cache
986 * @ip: the IPv4 corresponding to this DAT/ARP entry
987 * @mac_addr: the MAC address associated to the stored IPv4
988 * @last_update: time in jiffies when this entry was refreshed last time
989 * @hash_entry: hlist node for batadv_priv_dat::hash
990 * @refcount: number of contexts the object is used
991 * @rcu: struct used for freeing in an RCU-safe manner
993 struct batadv_dat_entry
{
995 uint8_t mac_addr
[ETH_ALEN
];
996 unsigned long last_update
;
997 struct hlist_node hash_entry
;
1003 * struct batadv_dat_candidate - candidate destination for DAT operations
1004 * @type: the type of the selected candidate. It can one of the following:
1005 * - BATADV_DAT_CANDIDATE_NOT_FOUND
1006 * - BATADV_DAT_CANDIDATE_ORIG
1007 * @orig_node: if type is BATADV_DAT_CANDIDATE_ORIG this field points to the
1008 * corresponding originator node structure
1010 struct batadv_dat_candidate
{
1012 struct batadv_orig_node
*orig_node
;
1016 * struct batadv_tvlv_container - container for tvlv appended to OGMs
1017 * @list: hlist node for batadv_priv_tvlv::container_list
1018 * @tvlv_hdr: tvlv header information needed to construct the tvlv
1019 * @value_len: length of the buffer following this struct which contains
1020 * the actual tvlv payload
1021 * @refcount: number of contexts the object is used
1023 struct batadv_tvlv_container
{
1024 struct hlist_node list
;
1025 struct batadv_tvlv_hdr tvlv_hdr
;
1030 * struct batadv_tvlv_handler - handler for specific tvlv type and version
1031 * @list: hlist node for batadv_priv_tvlv::handler_list
1032 * @ogm_handler: handler callback which is given the tvlv payload to process on
1033 * incoming OGM packets
1034 * @unicast_handler: handler callback which is given the tvlv payload to process
1035 * on incoming unicast tvlv packets
1036 * @type: tvlv type this handler feels responsible for
1037 * @version: tvlv version this handler feels responsible for
1038 * @flags: tvlv handler flags
1039 * @refcount: number of contexts the object is used
1040 * @rcu: struct used for freeing in an RCU-safe manner
1042 struct batadv_tvlv_handler
{
1043 struct hlist_node list
;
1044 void (*ogm_handler
)(struct batadv_priv
*bat_priv
,
1045 struct batadv_orig_node
*orig
,
1047 void *tvlv_value
, uint16_t tvlv_value_len
);
1048 int (*unicast_handler
)(struct batadv_priv
*bat_priv
,
1049 uint8_t *src
, uint8_t *dst
,
1050 void *tvlv_value
, uint16_t tvlv_value_len
);
1055 struct rcu_head rcu
;
1059 * enum batadv_tvlv_handler_flags - tvlv handler flags definitions
1060 * @BATADV_TVLV_HANDLER_OGM_CIFNOTFND: tvlv ogm processing function will call
1061 * this handler even if its type was not found (with no data)
1062 * @BATADV_TVLV_HANDLER_OGM_CALLED: interval tvlv handling flag - the API marks
1063 * a handler as being called, so it won't be called if the
1064 * BATADV_TVLV_HANDLER_OGM_CIFNOTFND flag was set
1066 enum batadv_tvlv_handler_flags
{
1067 BATADV_TVLV_HANDLER_OGM_CIFNOTFND
= BIT(1),
1068 BATADV_TVLV_HANDLER_OGM_CALLED
= BIT(2),
1071 #endif /* _NET_BATMAN_ADV_TYPES_H_ */