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 * @hardif_obj: kobject of the per interface sysfs "mesh" directory
65 * @refcount: number of contexts the object is used
66 * @batman_adv_ptype: packet type describing packets that should be processed by
67 * batman-adv for this interface
68 * @soft_iface: the batman-adv interface which uses this network interface
69 * @rcu: struct used for freeing in an RCU-safe manner
70 * @bat_iv: BATMAN IV specific per hard interface data
71 * @cleanup_work: work queue callback item for hard interface deinit
73 struct batadv_hard_iface
{
74 struct list_head list
;
77 struct net_device
*net_dev
;
79 struct kobject
*hardif_obj
;
81 struct packet_type batman_adv_ptype
;
82 struct net_device
*soft_iface
;
84 struct batadv_hard_iface_bat_iv bat_iv
;
85 struct work_struct cleanup_work
;
89 * struct batadv_orig_node - structure for orig_list maintaining nodes of mesh
90 * @orig: originator ethernet address
91 * @primary_addr: hosts primary interface address
92 * @router: router that should be used to reach this originator
93 * @batadv_dat_addr_t: address of the orig node in the distributed hash
94 * @bcast_own: bitfield containing the number of our OGMs this orig_node
95 * rebroadcasted "back" to us (relative to last_real_seqno)
96 * @bcast_own_sum: counted result of bcast_own
97 * @last_seen: time when last packet from this node was received
98 * @bcast_seqno_reset: time when the broadcast seqno window was reset
99 * @batman_seqno_reset: time when the batman seqno window was reset
100 * @gw_flags: flags related to gateway class
101 * @flags: for now only VIS_SERVER flag
102 * @last_ttvn: last seen translation table version number
103 * @tt_crc: CRC of the translation table
104 * @tt_buff: last tt changeset this node received from the orig node
105 * @tt_buff_len: length of the last tt changeset this node received from the
107 * @tt_buff_lock: lock that protects tt_buff and tt_buff_len
108 * @tt_size: number of global TT entries announced by the orig node
109 * @tt_initialised: bool keeping track of whether or not this node have received
110 * any translation table information from the orig node yet
111 * @last_real_seqno: last and best known sequence number
112 * @last_ttl: ttl of last received packet
113 * @bcast_bits: bitfield containing the info which payload broadcast originated
114 * from this orig node this host already has seen (relative to
116 * @last_bcast_seqno: last broadcast sequence number received by this host
117 * @neigh_list: list of potential next hop neighbor towards this orig node
118 * @frag_list: fragmentation buffer list for fragment re-assembly
119 * @last_frag_packet: time when last fragmented packet from this node was
121 * @neigh_list_lock: lock protecting neigh_list, router and bonding_list
122 * @hash_entry: hlist node for batadv_priv::orig_hash
123 * @bat_priv: pointer to soft_iface this orig node belongs to
124 * @ogm_cnt_lock: lock protecting bcast_own, bcast_own_sum,
125 * neigh_node->real_bits & neigh_node->real_packet_count
126 * @bcast_seqno_lock: lock protecting bcast_bits & last_bcast_seqno
127 * @bond_candidates: how many candidates are available
128 * @bond_list: list of bonding candidates
129 * @refcount: number of contexts the object is used
130 * @rcu: struct used for freeing in an RCU-safe manner
131 * @in_coding_list: list of nodes this orig can hear
132 * @out_coding_list: list of nodes that can hear this orig
133 * @in_coding_list_lock: protects in_coding_list
134 * @out_coding_list_lock: protects out_coding_list
136 struct batadv_orig_node
{
137 uint8_t orig
[ETH_ALEN
];
138 uint8_t primary_addr
[ETH_ALEN
];
139 struct batadv_neigh_node __rcu
*router
; /* rcu protected pointer */
140 #ifdef CONFIG_BATMAN_ADV_DAT
141 batadv_dat_addr_t dat_addr
;
143 unsigned long *bcast_own
;
144 uint8_t *bcast_own_sum
;
145 unsigned long last_seen
;
146 unsigned long bcast_seqno_reset
;
147 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 * @deleted: this struct is scheduled for deletion
191 * @refcount: number of contexts the object is used
192 * @rcu: struct used for freeing in an RCU-safe manner
194 struct batadv_gw_node
{
195 struct hlist_node list
;
196 struct batadv_orig_node
*orig_node
;
197 unsigned long deleted
;
203 * struct batadv_neigh_node - structure for single hop neighbors
204 * @list: list node for batadv_orig_node::neigh_list
205 * @addr: mac address of neigh node
206 * @tq_recv: ring buffer of received TQ values from this neigh node
207 * @tq_index: ring buffer index
208 * @tq_avg: averaged tq of all tq values in the ring buffer (tq_recv)
209 * @last_ttl: last received ttl from this neigh node
210 * @bonding_list: list node for batadv_orig_node::bond_list
211 * @last_seen: when last packet via this neighbor was received
212 * @real_bits: bitfield containing the number of OGMs received from this neigh
213 * node (relative to orig_node->last_real_seqno)
214 * @real_packet_count: counted result of real_bits
215 * @orig_node: pointer to corresponding orig_node
216 * @if_incoming: pointer to incoming hard interface
217 * @lq_update_lock: lock protecting tq_recv & tq_index
218 * @refcount: number of contexts the object is used
219 * @rcu: struct used for freeing in an RCU-safe manner
221 struct batadv_neigh_node
{
222 struct hlist_node list
;
223 uint8_t addr
[ETH_ALEN
];
224 uint8_t tq_recv
[BATADV_TQ_GLOBAL_WINDOW_SIZE
];
228 struct list_head bonding_list
;
229 unsigned long last_seen
;
230 DECLARE_BITMAP(real_bits
, BATADV_TQ_LOCAL_WINDOW_SIZE
);
231 uint8_t real_packet_count
;
232 struct batadv_orig_node
*orig_node
;
233 struct batadv_hard_iface
*if_incoming
;
234 spinlock_t lq_update_lock
; /* protects tq_recv & tq_index */
240 * struct batadv_bcast_duplist_entry - structure for LAN broadcast suppression
241 * @orig[ETH_ALEN]: mac address of orig node orginating the broadcast
242 * @crc: crc32 checksum of broadcast payload
243 * @entrytime: time when the broadcast packet was received
245 #ifdef CONFIG_BATMAN_ADV_BLA
246 struct batadv_bcast_duplist_entry
{
247 uint8_t orig
[ETH_ALEN
];
249 unsigned long entrytime
;
254 * enum batadv_counters - indices for traffic counters
255 * @BATADV_CNT_TX: transmitted payload traffic packet counter
256 * @BATADV_CNT_TX_BYTES: transmitted payload traffic bytes counter
257 * @BATADV_CNT_TX_DROPPED: dropped transmission payload traffic packet counter
258 * @BATADV_CNT_RX: received payload traffic packet counter
259 * @BATADV_CNT_RX_BYTES: received payload traffic bytes counter
260 * @BATADV_CNT_FORWARD: forwarded payload traffic packet counter
261 * @BATADV_CNT_FORWARD_BYTES: forwarded payload traffic bytes counter
262 * @BATADV_CNT_MGMT_TX: transmitted routing protocol traffic packet counter
263 * @BATADV_CNT_MGMT_TX_BYTES: transmitted routing protocol traffic bytes counter
264 * @BATADV_CNT_MGMT_RX: received routing protocol traffic packet counter
265 * @BATADV_CNT_MGMT_RX_BYTES: received routing protocol traffic bytes counter
266 * @BATADV_CNT_TT_REQUEST_TX: transmitted tt req traffic packet counter
267 * @BATADV_CNT_TT_REQUEST_RX: received tt req traffic packet counter
268 * @BATADV_CNT_TT_RESPONSE_TX: transmitted tt resp traffic packet counter
269 * @BATADV_CNT_TT_RESPONSE_RX: received tt resp traffic packet counter
270 * @BATADV_CNT_TT_ROAM_ADV_TX: transmitted tt roam traffic packet counter
271 * @BATADV_CNT_TT_ROAM_ADV_RX: received tt roam traffic packet counter
272 * @BATADV_CNT_DAT_GET_TX: transmitted dht GET traffic packet counter
273 * @BATADV_CNT_DAT_GET_RX: received dht GET traffic packet counter
274 * @BATADV_CNT_DAT_PUT_TX: transmitted dht PUT traffic packet counter
275 * @BATADV_CNT_DAT_PUT_RX: received dht PUT traffic packet counter
276 * @BATADV_CNT_DAT_CACHED_REPLY_TX: transmitted dat cache reply traffic packet
278 * @BATADV_CNT_NC_CODE: transmitted nc-combined traffic packet counter
279 * @BATADV_CNT_NC_CODE_BYTES: transmitted nc-combined traffic bytes counter
280 * @BATADV_CNT_NC_RECODE: transmitted nc-recombined traffic packet counter
281 * @BATADV_CNT_NC_RECODE_BYTES: transmitted nc-recombined traffic bytes counter
282 * @BATADV_CNT_NC_BUFFER: counter for packets buffered for later nc decoding
283 * @BATADV_CNT_NC_DECODE: received and nc-decoded traffic packet counter
284 * @BATADV_CNT_NC_DECODE_BYTES: received and nc-decoded traffic bytes counter
285 * @BATADV_CNT_NC_DECODE_FAILED: received and decode-failed traffic packet
287 * @BATADV_CNT_NC_SNIFFED: counter for nc-decoded packets received in promisc
289 * @BATADV_CNT_NUM: number of traffic counters
291 enum batadv_counters
{
294 BATADV_CNT_TX_DROPPED
,
298 BATADV_CNT_FORWARD_BYTES
,
300 BATADV_CNT_MGMT_TX_BYTES
,
302 BATADV_CNT_MGMT_RX_BYTES
,
303 BATADV_CNT_TT_REQUEST_TX
,
304 BATADV_CNT_TT_REQUEST_RX
,
305 BATADV_CNT_TT_RESPONSE_TX
,
306 BATADV_CNT_TT_RESPONSE_RX
,
307 BATADV_CNT_TT_ROAM_ADV_TX
,
308 BATADV_CNT_TT_ROAM_ADV_RX
,
309 #ifdef CONFIG_BATMAN_ADV_DAT
310 BATADV_CNT_DAT_GET_TX
,
311 BATADV_CNT_DAT_GET_RX
,
312 BATADV_CNT_DAT_PUT_TX
,
313 BATADV_CNT_DAT_PUT_RX
,
314 BATADV_CNT_DAT_CACHED_REPLY_TX
,
316 #ifdef CONFIG_BATMAN_ADV_NC
318 BATADV_CNT_NC_CODE_BYTES
,
319 BATADV_CNT_NC_RECODE
,
320 BATADV_CNT_NC_RECODE_BYTES
,
321 BATADV_CNT_NC_BUFFER
,
322 BATADV_CNT_NC_DECODE
,
323 BATADV_CNT_NC_DECODE_BYTES
,
324 BATADV_CNT_NC_DECODE_FAILED
,
325 BATADV_CNT_NC_SNIFFED
,
331 * struct batadv_priv_tt - per mesh interface translation table data
332 * @vn: translation table version number
333 * @ogm_append_cnt: counter of number of OGMs containing the local tt diff
334 * @local_changes: changes registered in an originator interval
335 * @changes_list: tracks tt local changes within an originator interval
336 * @local_hash: local translation table hash table
337 * @global_hash: global translation table hash table
338 * @req_list: list of pending & unanswered tt_requests
339 * @roam_list: list of the last roaming events of each client limiting the
340 * number of roaming events to avoid route flapping
341 * @changes_list_lock: lock protecting changes_list
342 * @req_list_lock: lock protecting req_list
343 * @roam_list_lock: lock protecting roam_list
344 * @local_entry_num: number of entries in the local hash table
345 * @local_crc: Checksum of the local table, recomputed before sending a new OGM
346 * @last_changeset: last tt changeset this host has generated
347 * @last_changeset_len: length of last tt changeset this host has generated
348 * @last_changeset_lock: lock protecting last_changeset & last_changeset_len
349 * @work: work queue callback item for translation table purging
351 struct batadv_priv_tt
{
353 atomic_t ogm_append_cnt
;
354 atomic_t local_changes
;
355 struct list_head changes_list
;
356 struct batadv_hashtable
*local_hash
;
357 struct batadv_hashtable
*global_hash
;
358 struct list_head req_list
;
359 struct list_head roam_list
;
360 spinlock_t changes_list_lock
; /* protects changes */
361 spinlock_t req_list_lock
; /* protects req_list */
362 spinlock_t roam_list_lock
; /* protects roam_list */
363 atomic_t local_entry_num
;
365 unsigned char *last_changeset
;
366 int16_t last_changeset_len
;
367 /* protects last_changeset & last_changeset_len */
368 spinlock_t last_changeset_lock
;
369 struct delayed_work work
;
373 * struct batadv_priv_bla - per mesh interface bridge loope avoidance data
374 * @num_requests; number of bla requests in flight
375 * @claim_hash: hash table containing mesh nodes this host has claimed
376 * @backbone_hash: hash table containing all detected backbone gateways
377 * @bcast_duplist: recently received broadcast packets array (for broadcast
378 * duplicate suppression)
379 * @bcast_duplist_curr: index of last broadcast packet added to bcast_duplist
380 * @bcast_duplist_lock: lock protecting bcast_duplist & bcast_duplist_curr
381 * @claim_dest: local claim data (e.g. claim group)
382 * @work: work queue callback item for cleanups & bla announcements
384 #ifdef CONFIG_BATMAN_ADV_BLA
385 struct batadv_priv_bla
{
386 atomic_t num_requests
;
387 struct batadv_hashtable
*claim_hash
;
388 struct batadv_hashtable
*backbone_hash
;
389 struct batadv_bcast_duplist_entry bcast_duplist
[BATADV_DUPLIST_SIZE
];
390 int bcast_duplist_curr
;
391 /* protects bcast_duplist & bcast_duplist_curr */
392 spinlock_t bcast_duplist_lock
;
393 struct batadv_bla_claim_dst claim_dest
;
394 struct delayed_work work
;
399 * struct batadv_debug_log - debug logging data
400 * @log_buff: buffer holding the logs (ring bufer)
401 * @log_start: index of next character to read
402 * @log_end: index of next character to write
403 * @lock: lock protecting log_buff, log_start & log_end
404 * @queue_wait: log reader's wait queue
406 #ifdef CONFIG_BATMAN_ADV_DEBUG
407 struct batadv_priv_debug_log
{
408 char log_buff
[BATADV_LOG_BUF_LEN
];
409 unsigned long log_start
;
410 unsigned long log_end
;
411 spinlock_t lock
; /* protects log_buff, log_start and log_end */
412 wait_queue_head_t queue_wait
;
417 * struct batadv_priv_gw - per mesh interface gateway data
418 * @list: list of available gateway nodes
419 * @list_lock: lock protecting gw_list & curr_gw
420 * @curr_gw: pointer to currently selected gateway node
421 * @reselect: bool indicating a gateway re-selection is in progress
423 struct batadv_priv_gw
{
424 struct hlist_head list
;
425 spinlock_t list_lock
; /* protects gw_list & curr_gw */
426 struct batadv_gw_node __rcu
*curr_gw
; /* rcu protected pointer */
431 * struct batadv_priv_vis - per mesh interface vis data
432 * @send_list: list of batadv_vis_info packets to sent
433 * @hash: hash table containing vis data from other nodes in the network
434 * @hash_lock: lock protecting the hash table
435 * @list_lock: lock protecting my_info::recv_list
436 * @work: work queue callback item for vis packet sending
437 * @my_info: holds this node's vis data sent on a regular basis
439 struct batadv_priv_vis
{
440 struct list_head send_list
;
441 struct batadv_hashtable
*hash
;
442 spinlock_t hash_lock
; /* protects hash */
443 spinlock_t list_lock
; /* protects my_info::recv_list */
444 struct delayed_work work
;
445 struct batadv_vis_info
*my_info
;
449 * struct batadv_priv_dat - per mesh interface DAT private data
450 * @addr: node DAT address
451 * @hash: hashtable representing the local ARP cache
452 * @work: work queue callback item for cache purging
454 #ifdef CONFIG_BATMAN_ADV_DAT
455 struct batadv_priv_dat
{
456 batadv_dat_addr_t addr
;
457 struct batadv_hashtable
*hash
;
458 struct delayed_work work
;
463 * struct batadv_priv_nc - per mesh interface network coding private data
464 * @work: work queue callback item for cleanup
465 * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
466 * @min_tq: only consider neighbors for encoding if neigh_tq > min_tq
467 * @max_fwd_delay: maximum packet forward delay to allow coding of packets
468 * @max_buffer_time: buffer time for sniffed packets used to decoding
469 * @timestamp_fwd_flush: timestamp of last forward packet queue flush
470 * @timestamp_sniffed_purge: timestamp of last sniffed packet queue purge
471 * @coding_hash: Hash table used to buffer skbs while waiting for another
472 * incoming skb to code it with. Skbs are added to the buffer just before being
473 * forwarded in routing.c
474 * @decoding_hash: Hash table used to buffer skbs that might be needed to decode
475 * a received coded skb. The buffer is used for 1) skbs arriving on the
476 * soft-interface; 2) skbs overheard on the hard-interface; and 3) skbs
477 * forwarded by batman-adv.
479 struct batadv_priv_nc
{
480 struct delayed_work work
;
481 struct dentry
*debug_dir
;
485 unsigned long timestamp_fwd_flush
;
486 unsigned long timestamp_sniffed_purge
;
487 struct batadv_hashtable
*coding_hash
;
488 struct batadv_hashtable
*decoding_hash
;
492 * struct batadv_priv - per mesh interface data
493 * @mesh_state: current status of the mesh (inactive/active/deactivating)
494 * @soft_iface: net device which holds this struct as private data
495 * @stats: structure holding the data for the ndo_get_stats() call
496 * @bat_counters: mesh internal traffic statistic counters (see batadv_counters)
497 * @aggregated_ogms: bool indicating whether OGM aggregation is enabled
498 * @bonding: bool indicating whether traffic bonding is enabled
499 * @fragmentation: bool indicating whether traffic fragmentation is enabled
500 * @ap_isolation: bool indicating whether ap isolation is enabled
501 * @bridge_loop_avoidance: bool indicating whether bridge loop avoidance is
503 * @distributed_arp_table: bool indicating whether distributed ARP table is
505 * @vis_mode: vis operation: client or server (see batadv_vis_packettype)
506 * @gw_mode: gateway operation: off, client or server (see batadv_gw_modes)
507 * @gw_sel_class: gateway selection class (applies if gw_mode client)
508 * @gw_bandwidth: gateway announced bandwidth (applies if gw_mode server)
509 * @orig_interval: OGM broadcast interval in milliseconds
510 * @hop_penalty: penalty which will be applied to an OGM's tq-field on every hop
511 * @log_level: configured log level (see batadv_dbg_level)
512 * @bcast_seqno: last sent broadcast packet sequence number
513 * @bcast_queue_left: number of remaining buffered broadcast packet slots
514 * @batman_queue_left: number of remaining OGM packet slots
515 * @num_ifaces: number of interfaces assigned to this mesh interface
516 * @mesh_obj: kobject for sysfs mesh subdirectory
517 * @debug_dir: dentry for debugfs batman-adv subdirectory
518 * @forw_bat_list: list of aggregated OGMs that will be forwarded
519 * @forw_bcast_list: list of broadcast packets that will be rebroadcasted
520 * @orig_hash: hash table containing mesh participants (orig nodes)
521 * @forw_bat_list_lock: lock protecting forw_bat_list
522 * @forw_bcast_list_lock: lock protecting forw_bcast_list
523 * @orig_work: work queue callback item for orig node purging
524 * @cleanup_work: work queue callback item for soft interface deinit
525 * @primary_if: one of the hard interfaces assigned to this mesh interface
526 * becomes the primary interface
527 * @bat_algo_ops: routing algorithm used by this mesh interface
528 * @bla: bridge loope avoidance data
529 * @debug_log: holding debug logging relevant data
531 * @tt: translation table data
533 * @dat: distributed arp table data
534 * @network_coding: bool indicating whether network coding is enabled
535 * @batadv_priv_nc: network coding data
539 struct net_device
*soft_iface
;
540 struct net_device_stats stats
;
541 uint64_t __percpu
*bat_counters
; /* Per cpu counters */
542 atomic_t aggregated_ogms
;
544 atomic_t fragmentation
;
545 atomic_t ap_isolation
;
546 #ifdef CONFIG_BATMAN_ADV_BLA
547 atomic_t bridge_loop_avoidance
;
549 #ifdef CONFIG_BATMAN_ADV_DAT
550 atomic_t distributed_arp_table
;
554 atomic_t gw_sel_class
;
555 atomic_t gw_bandwidth
;
556 atomic_t orig_interval
;
557 atomic_t hop_penalty
;
558 #ifdef CONFIG_BATMAN_ADV_DEBUG
561 atomic_t bcast_seqno
;
562 atomic_t bcast_queue_left
;
563 atomic_t batman_queue_left
;
565 struct kobject
*mesh_obj
;
566 struct dentry
*debug_dir
;
567 struct hlist_head forw_bat_list
;
568 struct hlist_head forw_bcast_list
;
569 struct batadv_hashtable
*orig_hash
;
570 spinlock_t forw_bat_list_lock
; /* protects forw_bat_list */
571 spinlock_t forw_bcast_list_lock
; /* protects forw_bcast_list */
572 struct delayed_work orig_work
;
573 struct work_struct cleanup_work
;
574 struct batadv_hard_iface __rcu
*primary_if
; /* rcu protected pointer */
575 struct batadv_algo_ops
*bat_algo_ops
;
576 #ifdef CONFIG_BATMAN_ADV_BLA
577 struct batadv_priv_bla bla
;
579 #ifdef CONFIG_BATMAN_ADV_DEBUG
580 struct batadv_priv_debug_log
*debug_log
;
582 struct batadv_priv_gw gw
;
583 struct batadv_priv_tt tt
;
584 struct batadv_priv_vis vis
;
585 #ifdef CONFIG_BATMAN_ADV_DAT
586 struct batadv_priv_dat dat
;
588 #ifdef CONFIG_BATMAN_ADV_NC
589 atomic_t network_coding
;
590 struct batadv_priv_nc nc
;
591 #endif /* CONFIG_BATMAN_ADV_NC */
595 * struct batadv_socket_client - layer2 icmp socket client data
596 * @queue_list: packet queue for packets destined for this socket client
597 * @queue_len: number of packets in the packet queue (queue_list)
598 * @index: socket client's index in the batadv_socket_client_hash
599 * @lock: lock protecting queue_list, queue_len & index
600 * @queue_wait: socket client's wait queue
601 * @bat_priv: pointer to soft_iface this client belongs to
603 struct batadv_socket_client
{
604 struct list_head queue_list
;
605 unsigned int queue_len
;
607 spinlock_t lock
; /* protects queue_list, queue_len & index */
608 wait_queue_head_t queue_wait
;
609 struct batadv_priv
*bat_priv
;
613 * struct batadv_socket_packet - layer2 icmp packet for socket client
614 * @list: list node for batadv_socket_client::queue_list
615 * @icmp_len: size of the layer2 icmp packet
616 * @icmp_packet: layer2 icmp packet
618 struct batadv_socket_packet
{
619 struct list_head list
;
621 struct batadv_icmp_packet_rr icmp_packet
;
625 * struct batadv_bla_backbone_gw - batman-adv gateway bridged into the LAN
626 * @orig: originator address of backbone node (mac address of primary iface)
627 * @vid: vlan id this gateway was detected on
628 * @hash_entry: hlist node for batadv_priv_bla::backbone_hash
629 * @bat_priv: pointer to soft_iface this backbone gateway belongs to
630 * @lasttime: last time we heard of this backbone gw
631 * @wait_periods: grace time for bridge forward delays and bla group forming at
632 * bootup phase - no bcast traffic is formwared until it has elapsed
633 * @request_sent: if this bool is set to true we are out of sync with this
634 * backbone gateway - no bcast traffic is formwared until the situation was
636 * @crc: crc16 checksum over all claims
637 * @refcount: number of contexts the object is used
638 * @rcu: struct used for freeing in an RCU-safe manner
640 #ifdef CONFIG_BATMAN_ADV_BLA
641 struct batadv_bla_backbone_gw
{
642 uint8_t orig
[ETH_ALEN
];
644 struct hlist_node hash_entry
;
645 struct batadv_priv
*bat_priv
;
646 unsigned long lasttime
;
647 atomic_t wait_periods
;
648 atomic_t request_sent
;
655 * struct batadv_bla_claim - claimed non-mesh client structure
656 * @addr: mac address of claimed non-mesh client
657 * @vid: vlan id this client was detected on
658 * @batadv_bla_backbone_gw: pointer to backbone gw claiming this client
659 * @lasttime: last time we heard of claim (locals only)
660 * @hash_entry: hlist node for batadv_priv_bla::claim_hash
661 * @refcount: number of contexts the object is used
662 * @rcu: struct used for freeing in an RCU-safe manner
664 struct batadv_bla_claim
{
665 uint8_t addr
[ETH_ALEN
];
667 struct batadv_bla_backbone_gw
*backbone_gw
;
668 unsigned long lasttime
;
669 struct hlist_node hash_entry
;
676 * struct batadv_tt_common_entry - tt local & tt global common data
677 * @addr: mac address of non-mesh client
678 * @hash_entry: hlist node for batadv_priv_tt::local_hash or for
679 * batadv_priv_tt::global_hash
680 * @flags: various state handling flags (see batadv_tt_client_flags)
681 * @added_at: timestamp used for purging stale tt common entries
682 * @refcount: number of contexts the object is used
683 * @rcu: struct used for freeing in an RCU-safe manner
685 struct batadv_tt_common_entry
{
686 uint8_t addr
[ETH_ALEN
];
687 struct hlist_node hash_entry
;
689 unsigned long added_at
;
695 * struct batadv_tt_local_entry - translation table local entry data
696 * @common: general translation table data
697 * @last_seen: timestamp used for purging stale tt local entries
699 struct batadv_tt_local_entry
{
700 struct batadv_tt_common_entry common
;
701 unsigned long last_seen
;
705 * struct batadv_tt_global_entry - translation table global entry data
706 * @common: general translation table data
707 * @orig_list: list of orig nodes announcing this non-mesh client
708 * @list_lock: lock protecting orig_list
709 * @roam_at: time at which TT_GLOBAL_ROAM was set
711 struct batadv_tt_global_entry
{
712 struct batadv_tt_common_entry common
;
713 struct hlist_head orig_list
;
714 spinlock_t list_lock
; /* protects orig_list */
715 unsigned long roam_at
;
719 * struct batadv_tt_orig_list_entry - orig node announcing a non-mesh client
720 * @orig_node: pointer to orig node announcing this non-mesh client
721 * @ttvn: translation table version number which added the non-mesh client
722 * @list: list node for batadv_tt_global_entry::orig_list
723 * @refcount: number of contexts the object is used
724 * @rcu: struct used for freeing in an RCU-safe manner
726 struct batadv_tt_orig_list_entry
{
727 struct batadv_orig_node
*orig_node
;
729 struct hlist_node list
;
735 * struct batadv_tt_change_node - structure for tt changes occured
736 * @list: list node for batadv_priv_tt::changes_list
737 * @change: holds the actual translation table diff data
739 struct batadv_tt_change_node
{
740 struct list_head list
;
741 struct batadv_tt_change change
;
745 * struct batadv_tt_req_node - data to keep track of the tt requests in flight
746 * @addr: mac address address of the originator this request was sent to
747 * @issued_at: timestamp used for purging stale tt requests
748 * @list: list node for batadv_priv_tt::req_list
750 struct batadv_tt_req_node
{
751 uint8_t addr
[ETH_ALEN
];
752 unsigned long issued_at
;
753 struct list_head list
;
757 * struct batadv_tt_roam_node - roaming client data
758 * @addr: mac address of the client in the roaming phase
759 * @counter: number of allowed roaming events per client within a single
760 * OGM interval (changes are committed with each OGM)
761 * @first_time: timestamp used for purging stale roaming node entries
762 * @list: list node for batadv_priv_tt::roam_list
764 struct batadv_tt_roam_node
{
765 uint8_t addr
[ETH_ALEN
];
767 unsigned long first_time
;
768 struct list_head list
;
772 * struct batadv_nc_node - network coding node
773 * @list: next and prev pointer for the list handling
774 * @addr: the node's mac address
775 * @refcount: number of contexts the object is used by
776 * @rcu: struct used for freeing in an RCU-safe manner
777 * @orig_node: pointer to corresponding orig node struct
778 * @last_seen: timestamp of last ogm received from this node
780 struct batadv_nc_node
{
781 struct list_head list
;
782 uint8_t addr
[ETH_ALEN
];
785 struct batadv_orig_node
*orig_node
;
786 unsigned long last_seen
;
790 * struct batadv_nc_path - network coding path
791 * @hash_entry: next and prev pointer for the list handling
792 * @rcu: struct used for freeing in an RCU-safe manner
793 * @refcount: number of contexts the object is used by
794 * @packet_list: list of buffered packets for this path
795 * @packet_list_lock: access lock for packet list
796 * @next_hop: next hop (destination) of path
797 * @prev_hop: previous hop (source) of path
798 * @last_valid: timestamp for last validation of path
800 struct batadv_nc_path
{
801 struct hlist_node hash_entry
;
804 struct list_head packet_list
;
805 spinlock_t packet_list_lock
; /* Protects packet_list */
806 uint8_t next_hop
[ETH_ALEN
];
807 uint8_t prev_hop
[ETH_ALEN
];
808 unsigned long last_valid
;
812 * struct batadv_nc_packet - network coding packet used when coding and
814 * @list: next and prev pointer for the list handling
815 * @packet_id: crc32 checksum of skb data
816 * @timestamp: field containing the info when the packet was added to path
817 * @neigh_node: pointer to original next hop neighbor of skb
818 * @skb: skb which can be encoded or used for decoding
819 * @nc_path: pointer to path this nc packet is attached to
821 struct batadv_nc_packet
{
822 struct list_head list
;
824 unsigned long timestamp
;
825 struct batadv_neigh_node
*neigh_node
;
827 struct batadv_nc_path
*nc_path
;
831 * batadv_skb_cb - control buffer structure used to store private data relevant
832 * to batman-adv in the skb->cb buffer in skbs.
833 * @decoded: Marks a skb as decoded, which is checked when searching for coding
834 * opportunities in network-coding.c
836 struct batadv_skb_cb
{
841 * struct batadv_forw_packet - structure for bcast packets to be sent/forwarded
842 * @list: list node for batadv_socket_client::queue_list
843 * @send_time: execution time for delayed_work (packet sending)
844 * @own: bool for locally generated packets (local OGMs are re-scheduled after
846 * @skb: bcast packet's skb buffer
847 * @packet_len: size of aggregated OGM packet inside the skb buffer
848 * @direct_link_flags: direct link flags for aggregated OGM packets
849 * @num_packets: counter for bcast packet retransmission
850 * @delayed_work: work queue callback item for packet sending
851 * @if_incoming: pointer incoming hard-iface or primary iface if locally
854 struct batadv_forw_packet
{
855 struct hlist_node list
;
856 unsigned long send_time
;
860 uint32_t direct_link_flags
;
862 struct delayed_work delayed_work
;
863 struct batadv_hard_iface
*if_incoming
;
867 * struct batadv_frag_packet_list_entry - storage for fragment packet
868 * @list: list node for orig_node::frag_list
869 * @seqno: sequence number of the fragment
870 * @skb: fragment's skb buffer
872 struct batadv_frag_packet_list_entry
{
873 struct list_head list
;
879 * struct batadv_vis_info - local data for vis information
880 * @first_seen: timestamp used for purging stale vis info entries
881 * @recv_list: List of server-neighbors we have received this packet from. This
882 * packet should not be re-forward to them again. List elements are struct
883 * batadv_vis_recvlist_node
884 * @send_list: list of packets to be forwarded
885 * @refcount: number of contexts the object is used
886 * @hash_entry: hlist node for batadv_priv_vis::hash
887 * @bat_priv: pointer to soft_iface this orig node belongs to
888 * @skb_packet: contains the vis packet
890 struct batadv_vis_info
{
891 unsigned long first_seen
;
892 struct list_head recv_list
;
893 struct list_head send_list
;
894 struct kref refcount
;
895 struct hlist_node hash_entry
;
896 struct batadv_priv
*bat_priv
;
897 struct sk_buff
*skb_packet
;
901 * struct batadv_vis_info_entry - contains link information for vis
902 * @src: source MAC of the link, all zero for local TT entry
903 * @dst: destination MAC of the link, client mac address for local TT entry
904 * @quality: transmission quality of the link, or 0 for local TT entry
906 struct batadv_vis_info_entry
{
907 uint8_t src
[ETH_ALEN
];
908 uint8_t dest
[ETH_ALEN
];
913 * struct batadv_vis_recvlist_node - list entry for batadv_vis_info::recv_list
914 * @list: list node for batadv_vis_info::recv_list
915 * @mac: MAC address of the originator from where the vis_info was received
917 struct batadv_vis_recvlist_node
{
918 struct list_head list
;
919 uint8_t mac
[ETH_ALEN
];
923 * struct batadv_vis_if_list_entry - auxiliary data for vis data generation
924 * @addr: MAC address of the interface
925 * @primary: true if this interface is the primary interface
926 * @list: list node the interface list
928 * While scanning for vis-entries of a particular vis-originator
929 * this list collects its interfaces to create a subgraph/cluster
932 struct batadv_vis_if_list_entry
{
933 uint8_t addr
[ETH_ALEN
];
935 struct hlist_node list
;
939 * struct batadv_algo_ops - mesh algorithm callbacks
940 * @list: list node for the batadv_algo_list
941 * @name: name of the algorithm
942 * @bat_iface_enable: init routing info when hard-interface is enabled
943 * @bat_iface_disable: de-init routing info when hard-interface is disabled
944 * @bat_iface_update_mac: (re-)init mac addresses of the protocol information
945 * belonging to this hard-interface
946 * @bat_primary_iface_set: called when primary interface is selected / changed
947 * @bat_ogm_schedule: prepare a new outgoing OGM for the send queue
948 * @bat_ogm_emit: send scheduled OGM
950 struct batadv_algo_ops
{
951 struct hlist_node list
;
953 int (*bat_iface_enable
)(struct batadv_hard_iface
*hard_iface
);
954 void (*bat_iface_disable
)(struct batadv_hard_iface
*hard_iface
);
955 void (*bat_iface_update_mac
)(struct batadv_hard_iface
*hard_iface
);
956 void (*bat_primary_iface_set
)(struct batadv_hard_iface
*hard_iface
);
957 void (*bat_ogm_schedule
)(struct batadv_hard_iface
*hard_iface
);
958 void (*bat_ogm_emit
)(struct batadv_forw_packet
*forw_packet
);
962 * struct batadv_dat_entry - it is a single entry of batman-adv ARP backend. It
963 * is used to stored ARP entries needed for the global DAT cache
964 * @ip: the IPv4 corresponding to this DAT/ARP entry
965 * @mac_addr: the MAC address associated to the stored IPv4
966 * @last_update: time in jiffies when this entry was refreshed last time
967 * @hash_entry: hlist node for batadv_priv_dat::hash
968 * @refcount: number of contexts the object is used
969 * @rcu: struct used for freeing in an RCU-safe manner
971 struct batadv_dat_entry
{
973 uint8_t mac_addr
[ETH_ALEN
];
974 unsigned long last_update
;
975 struct hlist_node hash_entry
;
981 * struct batadv_dat_candidate - candidate destination for DAT operations
982 * @type: the type of the selected candidate. It can one of the following:
983 * - BATADV_DAT_CANDIDATE_NOT_FOUND
984 * - BATADV_DAT_CANDIDATE_ORIG
985 * @orig_node: if type is BATADV_DAT_CANDIDATE_ORIG this field points to the
986 * corresponding originator node structure
988 struct batadv_dat_candidate
{
990 struct batadv_orig_node
*orig_node
;
993 #endif /* _NET_BATMAN_ADV_TYPES_H_ */