1 /* Copyright (C) 2007-2015 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, see <http://www.gnu.org/licenses/>.
18 #ifndef _NET_BATMAN_ADV_TYPES_H_
19 #define _NET_BATMAN_ADV_TYPES_H_
21 #ifndef _NET_BATMAN_ADV_MAIN_H_
22 #error only "main.h" can be included directly
25 #include <linux/bitops.h>
26 #include <linux/compiler.h>
27 #include <linux/if_ether.h>
28 #include <linux/netdevice.h>
29 #include <linux/sched.h> /* for linux/wait.h */
30 #include <linux/spinlock.h>
31 #include <linux/types.h>
32 #include <linux/wait.h>
33 #include <linux/workqueue.h>
39 #ifdef CONFIG_BATMAN_ADV_DAT
42 * batadv_dat_addr_t - it is the type used for all DHT addresses. If it is
43 * changed, BATADV_DAT_ADDR_MAX is changed as well.
45 * *Please be careful: batadv_dat_addr_t must be UNSIGNED*
47 #define batadv_dat_addr_t u16
49 #endif /* CONFIG_BATMAN_ADV_DAT */
52 * enum batadv_dhcp_recipient - dhcp destination
53 * @BATADV_DHCP_NO: packet is not a dhcp message
54 * @BATADV_DHCP_TO_SERVER: dhcp message is directed to a server
55 * @BATADV_DHCP_TO_CLIENT: dhcp message is directed to a client
57 enum batadv_dhcp_recipient
{
59 BATADV_DHCP_TO_SERVER
,
60 BATADV_DHCP_TO_CLIENT
,
64 * BATADV_TT_REMOTE_MASK - bitmask selecting the flags that are sent over the
67 #define BATADV_TT_REMOTE_MASK 0x00FF
70 * BATADV_TT_SYNC_MASK - bitmask of the flags that need to be kept in sync
71 * among the nodes. These flags are used to compute the global/local CRC
73 #define BATADV_TT_SYNC_MASK 0x00F0
76 * struct batadv_hard_iface_bat_iv - per hard interface B.A.T.M.A.N. IV data
77 * @ogm_buff: buffer holding the OGM packet
78 * @ogm_buff_len: length of the OGM packet buffer
79 * @ogm_seqno: OGM sequence number - used to identify each OGM
81 struct batadv_hard_iface_bat_iv
{
82 unsigned char *ogm_buff
;
88 * struct batadv_hard_iface - network device known to batman-adv
89 * @list: list node for batadv_hardif_list
90 * @if_num: identificator of the interface
91 * @if_status: status of the interface for batman-adv
92 * @net_dev: pointer to the net_device
93 * @num_bcasts: number of payload re-broadcasts on this interface (ARQ)
94 * @hardif_obj: kobject of the per interface sysfs "mesh" directory
95 * @refcount: number of contexts the object is used
96 * @batman_adv_ptype: packet type describing packets that should be processed by
97 * batman-adv for this interface
98 * @soft_iface: the batman-adv interface which uses this network interface
99 * @rcu: struct used for freeing in an RCU-safe manner
100 * @bat_iv: BATMAN IV specific per hard interface data
101 * @cleanup_work: work queue callback item for hard interface deinit
102 * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
103 * @neigh_list: list of unique single hop neighbors via this interface
104 * @neigh_list_lock: lock protecting neigh_list
106 struct batadv_hard_iface
{
107 struct list_head list
;
110 struct net_device
*net_dev
;
112 struct kobject
*hardif_obj
;
114 struct packet_type batman_adv_ptype
;
115 struct net_device
*soft_iface
;
117 struct batadv_hard_iface_bat_iv bat_iv
;
118 struct work_struct cleanup_work
;
119 struct dentry
*debug_dir
;
120 struct hlist_head neigh_list
;
121 /* neigh_list_lock protects: neigh_list */
122 spinlock_t neigh_list_lock
;
126 * struct batadv_orig_ifinfo - originator info per outgoing interface
127 * @list: list node for orig_node::ifinfo_list
128 * @if_outgoing: pointer to outgoing hard interface
129 * @router: router that should be used to reach this originator
130 * @last_real_seqno: last and best known sequence number
131 * @last_ttl: ttl of last received packet
132 * @batman_seqno_reset: time when the batman seqno window was reset
133 * @refcount: number of contexts the object is used
134 * @rcu: struct used for freeing in an RCU-safe manner
136 struct batadv_orig_ifinfo
{
137 struct hlist_node list
;
138 struct batadv_hard_iface
*if_outgoing
;
139 struct batadv_neigh_node __rcu
*router
; /* rcu protected pointer */
142 unsigned long batman_seqno_reset
;
148 * struct batadv_frag_table_entry - head in the fragment buffer table
149 * @head: head of list with fragments
150 * @lock: lock to protect the list of fragments
151 * @timestamp: time (jiffie) of last received fragment
152 * @seqno: sequence number of the fragments in the list
153 * @size: accumulated size of packets in list
154 * @total_size: expected size of the assembled packet
156 struct batadv_frag_table_entry
{
157 struct hlist_head head
;
158 spinlock_t lock
; /* protects head */
159 unsigned long timestamp
;
166 * struct batadv_frag_list_entry - entry in a list of fragments
167 * @list: list node information
169 * @no: fragment number in the set
171 struct batadv_frag_list_entry
{
172 struct hlist_node list
;
178 * struct batadv_vlan_tt - VLAN specific TT attributes
179 * @crc: CRC32 checksum of the entries belonging to this vlan
180 * @num_entries: number of TT entries for this VLAN
182 struct batadv_vlan_tt
{
184 atomic_t num_entries
;
188 * struct batadv_orig_node_vlan - VLAN specific data per orig_node
189 * @vid: the VLAN identifier
190 * @tt: VLAN specific TT attributes
191 * @list: list node for orig_node::vlan_list
192 * @refcount: number of context where this object is currently in use
193 * @rcu: struct used for freeing in a RCU-safe manner
195 struct batadv_orig_node_vlan
{
197 struct batadv_vlan_tt tt
;
198 struct hlist_node list
;
204 * struct batadv_orig_bat_iv - B.A.T.M.A.N. IV private orig_node members
205 * @bcast_own: set of bitfields (one per hard interface) where each one counts
206 * the number of our OGMs this orig_node rebroadcasted "back" to us (relative
207 * to last_real_seqno). Every bitfield is BATADV_TQ_LOCAL_WINDOW_SIZE bits long.
208 * @bcast_own_sum: sum of bcast_own
209 * @ogm_cnt_lock: lock protecting bcast_own, bcast_own_sum,
210 * neigh_node->bat_iv.real_bits & neigh_node->bat_iv.real_packet_count
212 struct batadv_orig_bat_iv
{
213 unsigned long *bcast_own
;
215 /* ogm_cnt_lock protects: bcast_own, bcast_own_sum,
216 * neigh_node->bat_iv.real_bits & neigh_node->bat_iv.real_packet_count
218 spinlock_t ogm_cnt_lock
;
222 * struct batadv_orig_node - structure for orig_list maintaining nodes of mesh
223 * @orig: originator ethernet address
224 * @ifinfo_list: list for routers per outgoing interface
225 * @last_bonding_candidate: pointer to last ifinfo of last used router
226 * @batadv_dat_addr_t: address of the orig node in the distributed hash
227 * @last_seen: time when last packet from this node was received
228 * @bcast_seqno_reset: time when the broadcast seqno window was reset
229 * @mcast_handler_lock: synchronizes mcast-capability and -flag changes
230 * @mcast_flags: multicast flags announced by the orig node
231 * @mcast_want_all_unsnoop_node: a list node for the
232 * mcast.want_all_unsnoopables list
233 * @mcast_want_all_ipv4_node: a list node for the mcast.want_all_ipv4 list
234 * @mcast_want_all_ipv6_node: a list node for the mcast.want_all_ipv6 list
235 * @capabilities: announced capabilities of this originator
236 * @capa_initialized: bitfield to remember whether a capability was initialized
237 * @last_ttvn: last seen translation table version number
238 * @tt_buff: last tt changeset this node received from the orig node
239 * @tt_buff_len: length of the last tt changeset this node received from the
241 * @tt_buff_lock: lock that protects tt_buff and tt_buff_len
242 * @tt_lock: prevents from updating the table while reading it. Table update is
243 * made up by two operations (data structure update and metdata -CRC/TTVN-
244 * recalculation) and they have to be executed atomically in order to avoid
245 * another thread to read the table/metadata between those.
246 * @bcast_bits: bitfield containing the info which payload broadcast originated
247 * from this orig node this host already has seen (relative to
249 * @last_bcast_seqno: last broadcast sequence number received by this host
250 * @neigh_list: list of potential next hop neighbor towards this orig node
251 * @neigh_list_lock: lock protecting neigh_list and router
252 * @hash_entry: hlist node for batadv_priv::orig_hash
253 * @bat_priv: pointer to soft_iface this orig node belongs to
254 * @bcast_seqno_lock: lock protecting bcast_bits & last_bcast_seqno
255 * @refcount: number of contexts the object is used
256 * @rcu: struct used for freeing in an RCU-safe manner
257 * @in_coding_list: list of nodes this orig can hear
258 * @out_coding_list: list of nodes that can hear this orig
259 * @in_coding_list_lock: protects in_coding_list
260 * @out_coding_list_lock: protects out_coding_list
261 * @fragments: array with heads for fragment chains
262 * @vlan_list: a list of orig_node_vlan structs, one per VLAN served by the
263 * originator represented by this object
264 * @vlan_list_lock: lock protecting vlan_list
265 * @bat_iv: B.A.T.M.A.N. IV private structure
267 struct batadv_orig_node
{
269 struct hlist_head ifinfo_list
;
270 struct batadv_orig_ifinfo
*last_bonding_candidate
;
271 #ifdef CONFIG_BATMAN_ADV_DAT
272 batadv_dat_addr_t dat_addr
;
274 unsigned long last_seen
;
275 unsigned long bcast_seqno_reset
;
276 #ifdef CONFIG_BATMAN_ADV_MCAST
277 /* synchronizes mcast tvlv specific orig changes */
278 spinlock_t mcast_handler_lock
;
280 struct hlist_node mcast_want_all_unsnoopables_node
;
281 struct hlist_node mcast_want_all_ipv4_node
;
282 struct hlist_node mcast_want_all_ipv6_node
;
284 unsigned long capabilities
;
285 unsigned long capa_initialized
;
287 unsigned char *tt_buff
;
289 spinlock_t tt_buff_lock
; /* protects tt_buff & tt_buff_len */
290 /* prevents from changing the table while reading it */
292 DECLARE_BITMAP(bcast_bits
, BATADV_TQ_LOCAL_WINDOW_SIZE
);
293 u32 last_bcast_seqno
;
294 struct hlist_head neigh_list
;
295 /* neigh_list_lock protects: neigh_list and router */
296 spinlock_t neigh_list_lock
;
297 struct hlist_node hash_entry
;
298 struct batadv_priv
*bat_priv
;
299 /* bcast_seqno_lock protects: bcast_bits & last_bcast_seqno */
300 spinlock_t bcast_seqno_lock
;
303 #ifdef CONFIG_BATMAN_ADV_NC
304 struct list_head in_coding_list
;
305 struct list_head out_coding_list
;
306 spinlock_t in_coding_list_lock
; /* Protects in_coding_list */
307 spinlock_t out_coding_list_lock
; /* Protects out_coding_list */
309 struct batadv_frag_table_entry fragments
[BATADV_FRAG_BUFFER_COUNT
];
310 struct hlist_head vlan_list
;
311 spinlock_t vlan_list_lock
; /* protects vlan_list */
312 struct batadv_orig_bat_iv bat_iv
;
316 * enum batadv_orig_capabilities - orig node capabilities
317 * @BATADV_ORIG_CAPA_HAS_DAT: orig node has distributed arp table enabled
318 * @BATADV_ORIG_CAPA_HAS_NC: orig node has network coding enabled
319 * @BATADV_ORIG_CAPA_HAS_TT: orig node has tt capability
320 * @BATADV_ORIG_CAPA_HAS_MCAST: orig node has some multicast capability
321 * (= orig node announces a tvlv of type BATADV_TVLV_MCAST)
323 enum batadv_orig_capabilities
{
324 BATADV_ORIG_CAPA_HAS_DAT
,
325 BATADV_ORIG_CAPA_HAS_NC
,
326 BATADV_ORIG_CAPA_HAS_TT
,
327 BATADV_ORIG_CAPA_HAS_MCAST
,
331 * struct batadv_gw_node - structure for orig nodes announcing gw capabilities
332 * @list: list node for batadv_priv_gw::list
333 * @orig_node: pointer to corresponding orig node
334 * @bandwidth_down: advertised uplink download bandwidth
335 * @bandwidth_up: advertised uplink upload bandwidth
336 * @refcount: number of contexts the object is used
337 * @rcu: struct used for freeing in an RCU-safe manner
339 struct batadv_gw_node
{
340 struct hlist_node list
;
341 struct batadv_orig_node
*orig_node
;
349 * batadv_hardif_neigh_node - unique neighbor per hard interface
350 * @list: list node for batadv_hard_iface::neigh_list
351 * @addr: the MAC address of the neighboring interface
352 * @if_incoming: pointer to incoming hard interface
353 * @refcount: number of contexts the object is used
354 * @rcu: struct used for freeing in a RCU-safe manner
356 struct batadv_hardif_neigh_node
{
357 struct hlist_node list
;
359 struct batadv_hard_iface
*if_incoming
;
360 unsigned long last_seen
;
366 * struct batadv_neigh_node - structure for single hops neighbors
367 * @list: list node for batadv_orig_node::neigh_list
368 * @orig_node: pointer to corresponding orig_node
369 * @addr: the MAC address of the neighboring interface
370 * @ifinfo_list: list for routing metrics per outgoing interface
371 * @ifinfo_lock: lock protecting private ifinfo members and list
372 * @if_incoming: pointer to incoming hard interface
373 * @last_seen: when last packet via this neighbor was received
374 * @last_ttl: last received ttl from this neigh node
375 * @rcu: struct used for freeing in an RCU-safe manner
376 * @bat_iv: B.A.T.M.A.N. IV private structure
378 struct batadv_neigh_node
{
379 struct hlist_node list
;
380 struct batadv_orig_node
*orig_node
;
382 struct hlist_head ifinfo_list
;
383 spinlock_t ifinfo_lock
; /* protects ifinfo_list and its members */
384 struct batadv_hard_iface
*if_incoming
;
385 unsigned long last_seen
;
391 * struct batadv_neigh_ifinfo_bat_iv - neighbor information per outgoing
392 * interface for BATMAN IV
393 * @tq_recv: ring buffer of received TQ values from this neigh node
394 * @tq_index: ring buffer index
395 * @tq_avg: averaged tq of all tq values in the ring buffer (tq_recv)
396 * @real_bits: bitfield containing the number of OGMs received from this neigh
397 * node (relative to orig_node->last_real_seqno)
398 * @real_packet_count: counted result of real_bits
400 struct batadv_neigh_ifinfo_bat_iv
{
401 u8 tq_recv
[BATADV_TQ_GLOBAL_WINDOW_SIZE
];
404 DECLARE_BITMAP(real_bits
, BATADV_TQ_LOCAL_WINDOW_SIZE
);
405 u8 real_packet_count
;
409 * struct batadv_neigh_ifinfo - neighbor information per outgoing interface
410 * @list: list node for batadv_neigh_node::ifinfo_list
411 * @if_outgoing: pointer to outgoing hard interface
412 * @bat_iv: B.A.T.M.A.N. IV private structure
413 * @last_ttl: last received ttl from this neigh node
414 * @refcount: number of contexts the object is used
415 * @rcu: struct used for freeing in a RCU-safe manner
417 struct batadv_neigh_ifinfo
{
418 struct hlist_node list
;
419 struct batadv_hard_iface
*if_outgoing
;
420 struct batadv_neigh_ifinfo_bat_iv bat_iv
;
426 #ifdef CONFIG_BATMAN_ADV_BLA
429 * struct batadv_bcast_duplist_entry - structure for LAN broadcast suppression
430 * @orig[ETH_ALEN]: mac address of orig node orginating the broadcast
431 * @crc: crc32 checksum of broadcast payload
432 * @entrytime: time when the broadcast packet was received
434 struct batadv_bcast_duplist_entry
{
437 unsigned long entrytime
;
442 * enum batadv_counters - indices for traffic counters
443 * @BATADV_CNT_TX: transmitted payload traffic packet counter
444 * @BATADV_CNT_TX_BYTES: transmitted payload traffic bytes counter
445 * @BATADV_CNT_TX_DROPPED: dropped transmission payload traffic packet counter
446 * @BATADV_CNT_RX: received payload traffic packet counter
447 * @BATADV_CNT_RX_BYTES: received payload traffic bytes counter
448 * @BATADV_CNT_FORWARD: forwarded payload traffic packet counter
449 * @BATADV_CNT_FORWARD_BYTES: forwarded payload traffic bytes counter
450 * @BATADV_CNT_MGMT_TX: transmitted routing protocol traffic packet counter
451 * @BATADV_CNT_MGMT_TX_BYTES: transmitted routing protocol traffic bytes counter
452 * @BATADV_CNT_MGMT_RX: received routing protocol traffic packet counter
453 * @BATADV_CNT_MGMT_RX_BYTES: received routing protocol traffic bytes counter
454 * @BATADV_CNT_FRAG_TX: transmitted fragment traffic packet counter
455 * @BATADV_CNT_FRAG_TX_BYTES: transmitted fragment traffic bytes counter
456 * @BATADV_CNT_FRAG_RX: received fragment traffic packet counter
457 * @BATADV_CNT_FRAG_RX_BYTES: received fragment traffic bytes counter
458 * @BATADV_CNT_FRAG_FWD: forwarded fragment traffic packet counter
459 * @BATADV_CNT_FRAG_FWD_BYTES: forwarded fragment traffic bytes counter
460 * @BATADV_CNT_TT_REQUEST_TX: transmitted tt req traffic packet counter
461 * @BATADV_CNT_TT_REQUEST_RX: received tt req traffic packet counter
462 * @BATADV_CNT_TT_RESPONSE_TX: transmitted tt resp traffic packet counter
463 * @BATADV_CNT_TT_RESPONSE_RX: received tt resp traffic packet counter
464 * @BATADV_CNT_TT_ROAM_ADV_TX: transmitted tt roam traffic packet counter
465 * @BATADV_CNT_TT_ROAM_ADV_RX: received tt roam traffic packet counter
466 * @BATADV_CNT_DAT_GET_TX: transmitted dht GET traffic packet counter
467 * @BATADV_CNT_DAT_GET_RX: received dht GET traffic packet counter
468 * @BATADV_CNT_DAT_PUT_TX: transmitted dht PUT traffic packet counter
469 * @BATADV_CNT_DAT_PUT_RX: received dht PUT traffic packet counter
470 * @BATADV_CNT_DAT_CACHED_REPLY_TX: transmitted dat cache reply traffic packet
472 * @BATADV_CNT_NC_CODE: transmitted nc-combined traffic packet counter
473 * @BATADV_CNT_NC_CODE_BYTES: transmitted nc-combined traffic bytes counter
474 * @BATADV_CNT_NC_RECODE: transmitted nc-recombined traffic packet counter
475 * @BATADV_CNT_NC_RECODE_BYTES: transmitted nc-recombined traffic bytes counter
476 * @BATADV_CNT_NC_BUFFER: counter for packets buffered for later nc decoding
477 * @BATADV_CNT_NC_DECODE: received and nc-decoded traffic packet counter
478 * @BATADV_CNT_NC_DECODE_BYTES: received and nc-decoded traffic bytes counter
479 * @BATADV_CNT_NC_DECODE_FAILED: received and decode-failed traffic packet
481 * @BATADV_CNT_NC_SNIFFED: counter for nc-decoded packets received in promisc
483 * @BATADV_CNT_NUM: number of traffic counters
485 enum batadv_counters
{
488 BATADV_CNT_TX_DROPPED
,
492 BATADV_CNT_FORWARD_BYTES
,
494 BATADV_CNT_MGMT_TX_BYTES
,
496 BATADV_CNT_MGMT_RX_BYTES
,
498 BATADV_CNT_FRAG_TX_BYTES
,
500 BATADV_CNT_FRAG_RX_BYTES
,
502 BATADV_CNT_FRAG_FWD_BYTES
,
503 BATADV_CNT_TT_REQUEST_TX
,
504 BATADV_CNT_TT_REQUEST_RX
,
505 BATADV_CNT_TT_RESPONSE_TX
,
506 BATADV_CNT_TT_RESPONSE_RX
,
507 BATADV_CNT_TT_ROAM_ADV_TX
,
508 BATADV_CNT_TT_ROAM_ADV_RX
,
509 #ifdef CONFIG_BATMAN_ADV_DAT
510 BATADV_CNT_DAT_GET_TX
,
511 BATADV_CNT_DAT_GET_RX
,
512 BATADV_CNT_DAT_PUT_TX
,
513 BATADV_CNT_DAT_PUT_RX
,
514 BATADV_CNT_DAT_CACHED_REPLY_TX
,
516 #ifdef CONFIG_BATMAN_ADV_NC
518 BATADV_CNT_NC_CODE_BYTES
,
519 BATADV_CNT_NC_RECODE
,
520 BATADV_CNT_NC_RECODE_BYTES
,
521 BATADV_CNT_NC_BUFFER
,
522 BATADV_CNT_NC_DECODE
,
523 BATADV_CNT_NC_DECODE_BYTES
,
524 BATADV_CNT_NC_DECODE_FAILED
,
525 BATADV_CNT_NC_SNIFFED
,
531 * struct batadv_priv_tt - per mesh interface translation table data
532 * @vn: translation table version number
533 * @ogm_append_cnt: counter of number of OGMs containing the local tt diff
534 * @local_changes: changes registered in an originator interval
535 * @changes_list: tracks tt local changes within an originator interval
536 * @local_hash: local translation table hash table
537 * @global_hash: global translation table hash table
538 * @req_list: list of pending & unanswered tt_requests
539 * @roam_list: list of the last roaming events of each client limiting the
540 * number of roaming events to avoid route flapping
541 * @changes_list_lock: lock protecting changes_list
542 * @req_list_lock: lock protecting req_list
543 * @roam_list_lock: lock protecting roam_list
544 * @last_changeset: last tt changeset this host has generated
545 * @last_changeset_len: length of last tt changeset this host has generated
546 * @last_changeset_lock: lock protecting last_changeset & last_changeset_len
547 * @commit_lock: prevents from executing a local TT commit while reading the
548 * local table. The local TT commit is made up by two operations (data
549 * structure update and metdata -CRC/TTVN- recalculation) and they have to be
550 * executed atomically in order to avoid another thread to read the
551 * table/metadata between those.
552 * @work: work queue callback item for translation table purging
554 struct batadv_priv_tt
{
556 atomic_t ogm_append_cnt
;
557 atomic_t local_changes
;
558 struct list_head changes_list
;
559 struct batadv_hashtable
*local_hash
;
560 struct batadv_hashtable
*global_hash
;
561 struct hlist_head req_list
;
562 struct list_head roam_list
;
563 spinlock_t changes_list_lock
; /* protects changes */
564 spinlock_t req_list_lock
; /* protects req_list */
565 spinlock_t roam_list_lock
; /* protects roam_list */
566 unsigned char *last_changeset
;
567 s16 last_changeset_len
;
568 /* protects last_changeset & last_changeset_len */
569 spinlock_t last_changeset_lock
;
570 /* prevents from executing a commit while reading the table */
571 spinlock_t commit_lock
;
572 struct delayed_work work
;
575 #ifdef CONFIG_BATMAN_ADV_BLA
578 * struct batadv_priv_bla - per mesh interface bridge loope avoidance data
579 * @num_requests; number of bla requests in flight
580 * @claim_hash: hash table containing mesh nodes this host has claimed
581 * @backbone_hash: hash table containing all detected backbone gateways
582 * @bcast_duplist: recently received broadcast packets array (for broadcast
583 * duplicate suppression)
584 * @bcast_duplist_curr: index of last broadcast packet added to bcast_duplist
585 * @bcast_duplist_lock: lock protecting bcast_duplist & bcast_duplist_curr
586 * @claim_dest: local claim data (e.g. claim group)
587 * @work: work queue callback item for cleanups & bla announcements
589 struct batadv_priv_bla
{
590 atomic_t num_requests
;
591 struct batadv_hashtable
*claim_hash
;
592 struct batadv_hashtable
*backbone_hash
;
593 struct batadv_bcast_duplist_entry bcast_duplist
[BATADV_DUPLIST_SIZE
];
594 int bcast_duplist_curr
;
595 /* protects bcast_duplist & bcast_duplist_curr */
596 spinlock_t bcast_duplist_lock
;
597 struct batadv_bla_claim_dst claim_dest
;
598 struct delayed_work work
;
602 #ifdef CONFIG_BATMAN_ADV_DEBUG
605 * struct batadv_priv_debug_log - debug logging data
606 * @log_buff: buffer holding the logs (ring bufer)
607 * @log_start: index of next character to read
608 * @log_end: index of next character to write
609 * @lock: lock protecting log_buff, log_start & log_end
610 * @queue_wait: log reader's wait queue
612 struct batadv_priv_debug_log
{
613 char log_buff
[BATADV_LOG_BUF_LEN
];
614 unsigned long log_start
;
615 unsigned long log_end
;
616 spinlock_t lock
; /* protects log_buff, log_start and log_end */
617 wait_queue_head_t queue_wait
;
622 * struct batadv_priv_gw - per mesh interface gateway data
623 * @list: list of available gateway nodes
624 * @list_lock: lock protecting gw_list & curr_gw
625 * @curr_gw: pointer to currently selected gateway node
626 * @bandwidth_down: advertised uplink download bandwidth (if gw_mode server)
627 * @bandwidth_up: advertised uplink upload bandwidth (if gw_mode server)
628 * @reselect: bool indicating a gateway re-selection is in progress
630 struct batadv_priv_gw
{
631 struct hlist_head list
;
632 spinlock_t list_lock
; /* protects gw_list & curr_gw */
633 struct batadv_gw_node __rcu
*curr_gw
; /* rcu protected pointer */
634 atomic_t bandwidth_down
;
635 atomic_t bandwidth_up
;
640 * struct batadv_priv_tvlv - per mesh interface tvlv data
641 * @container_list: list of registered tvlv containers to be sent with each OGM
642 * @handler_list: list of the various tvlv content handlers
643 * @container_list_lock: protects tvlv container list access
644 * @handler_list_lock: protects handler list access
646 struct batadv_priv_tvlv
{
647 struct hlist_head container_list
;
648 struct hlist_head handler_list
;
649 spinlock_t container_list_lock
; /* protects container_list */
650 spinlock_t handler_list_lock
; /* protects handler_list */
653 #ifdef CONFIG_BATMAN_ADV_DAT
656 * struct batadv_priv_dat - per mesh interface DAT private data
657 * @addr: node DAT address
658 * @hash: hashtable representing the local ARP cache
659 * @work: work queue callback item for cache purging
661 struct batadv_priv_dat
{
662 batadv_dat_addr_t addr
;
663 struct batadv_hashtable
*hash
;
664 struct delayed_work work
;
668 #ifdef CONFIG_BATMAN_ADV_MCAST
670 * struct batadv_priv_mcast - per mesh interface mcast data
671 * @mla_list: list of multicast addresses we are currently announcing via TT
672 * @want_all_unsnoopables_list: a list of orig_nodes wanting all unsnoopable
674 * @want_all_ipv4_list: a list of orig_nodes wanting all IPv4 multicast traffic
675 * @want_all_ipv6_list: a list of orig_nodes wanting all IPv6 multicast traffic
676 * @flags: the flags we have last sent in our mcast tvlv
677 * @enabled: whether the multicast tvlv is currently enabled
678 * @num_disabled: number of nodes that have no mcast tvlv
679 * @num_want_all_unsnoopables: number of nodes wanting unsnoopable IP traffic
680 * @num_want_all_ipv4: counter for items in want_all_ipv4_list
681 * @num_want_all_ipv6: counter for items in want_all_ipv6_list
682 * @want_lists_lock: lock for protecting modifications to mcast want lists
683 * (traversals are rcu-locked)
685 struct batadv_priv_mcast
{
686 struct hlist_head mla_list
;
687 struct hlist_head want_all_unsnoopables_list
;
688 struct hlist_head want_all_ipv4_list
;
689 struct hlist_head want_all_ipv6_list
;
692 atomic_t num_disabled
;
693 atomic_t num_want_all_unsnoopables
;
694 atomic_t num_want_all_ipv4
;
695 atomic_t num_want_all_ipv6
;
696 /* protects want_all_{unsnoopables,ipv4,ipv6}_list */
697 spinlock_t want_lists_lock
;
702 * struct batadv_priv_nc - per mesh interface network coding private data
703 * @work: work queue callback item for cleanup
704 * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
705 * @min_tq: only consider neighbors for encoding if neigh_tq > min_tq
706 * @max_fwd_delay: maximum packet forward delay to allow coding of packets
707 * @max_buffer_time: buffer time for sniffed packets used to decoding
708 * @timestamp_fwd_flush: timestamp of last forward packet queue flush
709 * @timestamp_sniffed_purge: timestamp of last sniffed packet queue purge
710 * @coding_hash: Hash table used to buffer skbs while waiting for another
711 * incoming skb to code it with. Skbs are added to the buffer just before being
712 * forwarded in routing.c
713 * @decoding_hash: Hash table used to buffer skbs that might be needed to decode
714 * a received coded skb. The buffer is used for 1) skbs arriving on the
715 * soft-interface; 2) skbs overheard on the hard-interface; and 3) skbs
716 * forwarded by batman-adv.
718 struct batadv_priv_nc
{
719 struct delayed_work work
;
720 struct dentry
*debug_dir
;
724 unsigned long timestamp_fwd_flush
;
725 unsigned long timestamp_sniffed_purge
;
726 struct batadv_hashtable
*coding_hash
;
727 struct batadv_hashtable
*decoding_hash
;
731 * struct batadv_softif_vlan - per VLAN attributes set
732 * @bat_priv: pointer to the mesh object
733 * @vid: VLAN identifier
734 * @kobj: kobject for sysfs vlan subdirectory
735 * @ap_isolation: AP isolation state
736 * @tt: TT private attributes (VLAN specific)
737 * @list: list node for bat_priv::softif_vlan_list
738 * @refcount: number of context where this object is currently in use
739 * @rcu: struct used for freeing in a RCU-safe manner
741 struct batadv_softif_vlan
{
742 struct batadv_priv
*bat_priv
;
744 struct kobject
*kobj
;
745 atomic_t ap_isolation
; /* boolean */
746 struct batadv_vlan_tt tt
;
747 struct hlist_node list
;
753 * struct batadv_priv - per mesh interface data
754 * @mesh_state: current status of the mesh (inactive/active/deactivating)
755 * @soft_iface: net device which holds this struct as private data
756 * @stats: structure holding the data for the ndo_get_stats() call
757 * @bat_counters: mesh internal traffic statistic counters (see batadv_counters)
758 * @aggregated_ogms: bool indicating whether OGM aggregation is enabled
759 * @bonding: bool indicating whether traffic bonding is enabled
760 * @fragmentation: bool indicating whether traffic fragmentation is enabled
761 * @packet_size_max: max packet size that can be transmitted via
762 * multiple fragmented skbs or a single frame if fragmentation is disabled
763 * @frag_seqno: incremental counter to identify chains of egress fragments
764 * @bridge_loop_avoidance: bool indicating whether bridge loop avoidance is
766 * @distributed_arp_table: bool indicating whether distributed ARP table is
768 * @multicast_mode: Enable or disable multicast optimizations on this node's
769 * sender/originating side
770 * @gw_mode: gateway operation: off, client or server (see batadv_gw_modes)
771 * @gw_sel_class: gateway selection class (applies if gw_mode client)
772 * @orig_interval: OGM broadcast interval in milliseconds
773 * @hop_penalty: penalty which will be applied to an OGM's tq-field on every hop
774 * @log_level: configured log level (see batadv_dbg_level)
775 * @bcast_seqno: last sent broadcast packet sequence number
776 * @bcast_queue_left: number of remaining buffered broadcast packet slots
777 * @batman_queue_left: number of remaining OGM packet slots
778 * @num_ifaces: number of interfaces assigned to this mesh interface
779 * @mesh_obj: kobject for sysfs mesh subdirectory
780 * @debug_dir: dentry for debugfs batman-adv subdirectory
781 * @forw_bat_list: list of aggregated OGMs that will be forwarded
782 * @forw_bcast_list: list of broadcast packets that will be rebroadcasted
783 * @orig_hash: hash table containing mesh participants (orig nodes)
784 * @forw_bat_list_lock: lock protecting forw_bat_list
785 * @forw_bcast_list_lock: lock protecting forw_bcast_list
786 * @orig_work: work queue callback item for orig node purging
787 * @cleanup_work: work queue callback item for soft interface deinit
788 * @primary_if: one of the hard interfaces assigned to this mesh interface
789 * becomes the primary interface
790 * @bat_algo_ops: routing algorithm used by this mesh interface
791 * @softif_vlan_list: a list of softif_vlan structs, one per VLAN created on top
792 * of the mesh interface represented by this object
793 * @softif_vlan_list_lock: lock protecting softif_vlan_list
794 * @bla: bridge loope avoidance data
795 * @debug_log: holding debug logging relevant data
797 * @tt: translation table data
798 * @tvlv: type-version-length-value data
799 * @dat: distributed arp table data
800 * @mcast: multicast data
801 * @network_coding: bool indicating whether network coding is enabled
802 * @batadv_priv_nc: network coding data
806 struct net_device
*soft_iface
;
807 struct net_device_stats stats
;
808 u64 __percpu
*bat_counters
; /* Per cpu counters */
809 atomic_t aggregated_ogms
;
811 atomic_t fragmentation
;
812 atomic_t packet_size_max
;
814 #ifdef CONFIG_BATMAN_ADV_BLA
815 atomic_t bridge_loop_avoidance
;
817 #ifdef CONFIG_BATMAN_ADV_DAT
818 atomic_t distributed_arp_table
;
820 #ifdef CONFIG_BATMAN_ADV_MCAST
821 atomic_t multicast_mode
;
824 atomic_t gw_sel_class
;
825 atomic_t orig_interval
;
826 atomic_t hop_penalty
;
827 #ifdef CONFIG_BATMAN_ADV_DEBUG
831 u32 isolation_mark_mask
;
832 atomic_t bcast_seqno
;
833 atomic_t bcast_queue_left
;
834 atomic_t batman_queue_left
;
836 struct kobject
*mesh_obj
;
837 struct dentry
*debug_dir
;
838 struct hlist_head forw_bat_list
;
839 struct hlist_head forw_bcast_list
;
840 struct batadv_hashtable
*orig_hash
;
841 spinlock_t forw_bat_list_lock
; /* protects forw_bat_list */
842 spinlock_t forw_bcast_list_lock
; /* protects forw_bcast_list */
843 struct delayed_work orig_work
;
844 struct work_struct cleanup_work
;
845 struct batadv_hard_iface __rcu
*primary_if
; /* rcu protected pointer */
846 struct batadv_algo_ops
*bat_algo_ops
;
847 struct hlist_head softif_vlan_list
;
848 spinlock_t softif_vlan_list_lock
; /* protects softif_vlan_list */
849 #ifdef CONFIG_BATMAN_ADV_BLA
850 struct batadv_priv_bla bla
;
852 #ifdef CONFIG_BATMAN_ADV_DEBUG
853 struct batadv_priv_debug_log
*debug_log
;
855 struct batadv_priv_gw gw
;
856 struct batadv_priv_tt tt
;
857 struct batadv_priv_tvlv tvlv
;
858 #ifdef CONFIG_BATMAN_ADV_DAT
859 struct batadv_priv_dat dat
;
861 #ifdef CONFIG_BATMAN_ADV_MCAST
862 struct batadv_priv_mcast mcast
;
864 #ifdef CONFIG_BATMAN_ADV_NC
865 atomic_t network_coding
;
866 struct batadv_priv_nc nc
;
867 #endif /* CONFIG_BATMAN_ADV_NC */
871 * struct batadv_socket_client - layer2 icmp socket client data
872 * @queue_list: packet queue for packets destined for this socket client
873 * @queue_len: number of packets in the packet queue (queue_list)
874 * @index: socket client's index in the batadv_socket_client_hash
875 * @lock: lock protecting queue_list, queue_len & index
876 * @queue_wait: socket client's wait queue
877 * @bat_priv: pointer to soft_iface this client belongs to
879 struct batadv_socket_client
{
880 struct list_head queue_list
;
881 unsigned int queue_len
;
883 spinlock_t lock
; /* protects queue_list, queue_len & index */
884 wait_queue_head_t queue_wait
;
885 struct batadv_priv
*bat_priv
;
889 * struct batadv_socket_packet - layer2 icmp packet for socket client
890 * @list: list node for batadv_socket_client::queue_list
891 * @icmp_len: size of the layer2 icmp packet
892 * @icmp_packet: layer2 icmp packet
894 struct batadv_socket_packet
{
895 struct list_head list
;
897 u8 icmp_packet
[BATADV_ICMP_MAX_PACKET_SIZE
];
900 #ifdef CONFIG_BATMAN_ADV_BLA
903 * struct batadv_bla_backbone_gw - batman-adv gateway bridged into the LAN
904 * @orig: originator address of backbone node (mac address of primary iface)
905 * @vid: vlan id this gateway was detected on
906 * @hash_entry: hlist node for batadv_priv_bla::backbone_hash
907 * @bat_priv: pointer to soft_iface this backbone gateway belongs to
908 * @lasttime: last time we heard of this backbone gw
909 * @wait_periods: grace time for bridge forward delays and bla group forming at
910 * bootup phase - no bcast traffic is formwared until it has elapsed
911 * @request_sent: if this bool is set to true we are out of sync with this
912 * backbone gateway - no bcast traffic is formwared until the situation was
914 * @crc: crc16 checksum over all claims
915 * @crc_lock: lock protecting crc
916 * @refcount: number of contexts the object is used
917 * @rcu: struct used for freeing in an RCU-safe manner
919 struct batadv_bla_backbone_gw
{
922 struct hlist_node hash_entry
;
923 struct batadv_priv
*bat_priv
;
924 unsigned long lasttime
;
925 atomic_t wait_periods
;
926 atomic_t request_sent
;
928 spinlock_t crc_lock
; /* protects crc */
934 * struct batadv_bla_claim - claimed non-mesh client structure
935 * @addr: mac address of claimed non-mesh client
936 * @vid: vlan id this client was detected on
937 * @batadv_bla_backbone_gw: pointer to backbone gw claiming this client
938 * @lasttime: last time we heard of claim (locals only)
939 * @hash_entry: hlist node for batadv_priv_bla::claim_hash
940 * @refcount: number of contexts the object is used
941 * @rcu: struct used for freeing in an RCU-safe manner
943 struct batadv_bla_claim
{
946 struct batadv_bla_backbone_gw
*backbone_gw
;
947 unsigned long lasttime
;
948 struct hlist_node hash_entry
;
955 * struct batadv_tt_common_entry - tt local & tt global common data
956 * @addr: mac address of non-mesh client
957 * @vid: VLAN identifier
958 * @hash_entry: hlist node for batadv_priv_tt::local_hash or for
959 * batadv_priv_tt::global_hash
960 * @flags: various state handling flags (see batadv_tt_client_flags)
961 * @added_at: timestamp used for purging stale tt common entries
962 * @refcount: number of contexts the object is used
963 * @rcu: struct used for freeing in an RCU-safe manner
965 struct batadv_tt_common_entry
{
968 struct hlist_node hash_entry
;
970 unsigned long added_at
;
976 * struct batadv_tt_local_entry - translation table local entry data
977 * @common: general translation table data
978 * @last_seen: timestamp used for purging stale tt local entries
980 struct batadv_tt_local_entry
{
981 struct batadv_tt_common_entry common
;
982 unsigned long last_seen
;
986 * struct batadv_tt_global_entry - translation table global entry data
987 * @common: general translation table data
988 * @orig_list: list of orig nodes announcing this non-mesh client
989 * @orig_list_count: number of items in the orig_list
990 * @list_lock: lock protecting orig_list
991 * @roam_at: time at which TT_GLOBAL_ROAM was set
993 struct batadv_tt_global_entry
{
994 struct batadv_tt_common_entry common
;
995 struct hlist_head orig_list
;
996 atomic_t orig_list_count
;
997 spinlock_t list_lock
; /* protects orig_list */
998 unsigned long roam_at
;
1002 * struct batadv_tt_orig_list_entry - orig node announcing a non-mesh client
1003 * @orig_node: pointer to orig node announcing this non-mesh client
1004 * @ttvn: translation table version number which added the non-mesh client
1005 * @list: list node for batadv_tt_global_entry::orig_list
1006 * @refcount: number of contexts the object is used
1007 * @rcu: struct used for freeing in an RCU-safe manner
1009 struct batadv_tt_orig_list_entry
{
1010 struct batadv_orig_node
*orig_node
;
1012 struct hlist_node list
;
1014 struct rcu_head rcu
;
1018 * struct batadv_tt_change_node - structure for tt changes occurred
1019 * @list: list node for batadv_priv_tt::changes_list
1020 * @change: holds the actual translation table diff data
1022 struct batadv_tt_change_node
{
1023 struct list_head list
;
1024 struct batadv_tvlv_tt_change change
;
1028 * struct batadv_tt_req_node - data to keep track of the tt requests in flight
1029 * @addr: mac address address of the originator this request was sent to
1030 * @issued_at: timestamp used for purging stale tt requests
1031 * @list: list node for batadv_priv_tt::req_list
1033 struct batadv_tt_req_node
{
1035 unsigned long issued_at
;
1036 struct hlist_node list
;
1040 * struct batadv_tt_roam_node - roaming client data
1041 * @addr: mac address of the client in the roaming phase
1042 * @counter: number of allowed roaming events per client within a single
1043 * OGM interval (changes are committed with each OGM)
1044 * @first_time: timestamp used for purging stale roaming node entries
1045 * @list: list node for batadv_priv_tt::roam_list
1047 struct batadv_tt_roam_node
{
1050 unsigned long first_time
;
1051 struct list_head list
;
1055 * struct batadv_nc_node - network coding node
1056 * @list: next and prev pointer for the list handling
1057 * @addr: the node's mac address
1058 * @refcount: number of contexts the object is used by
1059 * @rcu: struct used for freeing in an RCU-safe manner
1060 * @orig_node: pointer to corresponding orig node struct
1061 * @last_seen: timestamp of last ogm received from this node
1063 struct batadv_nc_node
{
1064 struct list_head list
;
1067 struct rcu_head rcu
;
1068 struct batadv_orig_node
*orig_node
;
1069 unsigned long last_seen
;
1073 * struct batadv_nc_path - network coding path
1074 * @hash_entry: next and prev pointer for the list handling
1075 * @rcu: struct used for freeing in an RCU-safe manner
1076 * @refcount: number of contexts the object is used by
1077 * @packet_list: list of buffered packets for this path
1078 * @packet_list_lock: access lock for packet list
1079 * @next_hop: next hop (destination) of path
1080 * @prev_hop: previous hop (source) of path
1081 * @last_valid: timestamp for last validation of path
1083 struct batadv_nc_path
{
1084 struct hlist_node hash_entry
;
1085 struct rcu_head rcu
;
1087 struct list_head packet_list
;
1088 spinlock_t packet_list_lock
; /* Protects packet_list */
1089 u8 next_hop
[ETH_ALEN
];
1090 u8 prev_hop
[ETH_ALEN
];
1091 unsigned long last_valid
;
1095 * struct batadv_nc_packet - network coding packet used when coding and
1097 * @list: next and prev pointer for the list handling
1098 * @packet_id: crc32 checksum of skb data
1099 * @timestamp: field containing the info when the packet was added to path
1100 * @neigh_node: pointer to original next hop neighbor of skb
1101 * @skb: skb which can be encoded or used for decoding
1102 * @nc_path: pointer to path this nc packet is attached to
1104 struct batadv_nc_packet
{
1105 struct list_head list
;
1107 unsigned long timestamp
;
1108 struct batadv_neigh_node
*neigh_node
;
1109 struct sk_buff
*skb
;
1110 struct batadv_nc_path
*nc_path
;
1114 * struct batadv_skb_cb - control buffer structure used to store private data
1115 * relevant to batman-adv in the skb->cb buffer in skbs.
1116 * @decoded: Marks a skb as decoded, which is checked when searching for coding
1117 * opportunities in network-coding.c
1119 struct batadv_skb_cb
{
1124 * struct batadv_forw_packet - structure for bcast packets to be sent/forwarded
1125 * @list: list node for batadv_socket_client::queue_list
1126 * @send_time: execution time for delayed_work (packet sending)
1127 * @own: bool for locally generated packets (local OGMs are re-scheduled after
1129 * @skb: bcast packet's skb buffer
1130 * @packet_len: size of aggregated OGM packet inside the skb buffer
1131 * @direct_link_flags: direct link flags for aggregated OGM packets
1132 * @num_packets: counter for bcast packet retransmission
1133 * @delayed_work: work queue callback item for packet sending
1134 * @if_incoming: pointer to incoming hard-iface or primary iface if
1135 * locally generated packet
1136 * @if_outgoing: packet where the packet should be sent to, or NULL if
1139 struct batadv_forw_packet
{
1140 struct hlist_node list
;
1141 unsigned long send_time
;
1143 struct sk_buff
*skb
;
1145 u32 direct_link_flags
;
1147 struct delayed_work delayed_work
;
1148 struct batadv_hard_iface
*if_incoming
;
1149 struct batadv_hard_iface
*if_outgoing
;
1153 * struct batadv_algo_ops - mesh algorithm callbacks
1154 * @list: list node for the batadv_algo_list
1155 * @name: name of the algorithm
1156 * @bat_iface_enable: init routing info when hard-interface is enabled
1157 * @bat_iface_disable: de-init routing info when hard-interface is disabled
1158 * @bat_iface_update_mac: (re-)init mac addresses of the protocol information
1159 * belonging to this hard-interface
1160 * @bat_primary_iface_set: called when primary interface is selected / changed
1161 * @bat_ogm_schedule: prepare a new outgoing OGM for the send queue
1162 * @bat_ogm_emit: send scheduled OGM
1163 * @bat_hardif_neigh_init: called on creation of single hop entry
1164 * @bat_neigh_cmp: compare the metrics of two neighbors for their respective
1165 * outgoing interfaces
1166 * @bat_neigh_is_similar_or_better: check if neigh1 is equally similar or
1167 * better than neigh2 for their respective outgoing interface from the metric
1169 * @bat_neigh_print: print the single hop neighbor list (optional)
1170 * @bat_neigh_free: free the resources allocated by the routing algorithm for a
1172 * @bat_orig_print: print the originator table (optional)
1173 * @bat_orig_free: free the resources allocated by the routing algorithm for an
1175 * @bat_orig_add_if: ask the routing algorithm to apply the needed changes to
1176 * the orig_node due to a new hard-interface being added into the mesh
1177 * @bat_orig_del_if: ask the routing algorithm to apply the needed changes to
1178 * the orig_node due to an hard-interface being removed from the mesh
1180 struct batadv_algo_ops
{
1181 struct hlist_node list
;
1183 int (*bat_iface_enable
)(struct batadv_hard_iface
*hard_iface
);
1184 void (*bat_iface_disable
)(struct batadv_hard_iface
*hard_iface
);
1185 void (*bat_iface_update_mac
)(struct batadv_hard_iface
*hard_iface
);
1186 void (*bat_primary_iface_set
)(struct batadv_hard_iface
*hard_iface
);
1187 void (*bat_ogm_schedule
)(struct batadv_hard_iface
*hard_iface
);
1188 void (*bat_ogm_emit
)(struct batadv_forw_packet
*forw_packet
);
1189 /* neigh_node handling API */
1190 void (*bat_hardif_neigh_init
)(struct batadv_hardif_neigh_node
*neigh
);
1191 int (*bat_neigh_cmp
)(struct batadv_neigh_node
*neigh1
,
1192 struct batadv_hard_iface
*if_outgoing1
,
1193 struct batadv_neigh_node
*neigh2
,
1194 struct batadv_hard_iface
*if_outgoing2
);
1195 bool (*bat_neigh_is_similar_or_better
)
1196 (struct batadv_neigh_node
*neigh1
,
1197 struct batadv_hard_iface
*if_outgoing1
,
1198 struct batadv_neigh_node
*neigh2
,
1199 struct batadv_hard_iface
*if_outgoing2
);
1200 void (*bat_neigh_print
)(struct batadv_priv
*priv
, struct seq_file
*seq
);
1201 void (*bat_neigh_free
)(struct batadv_neigh_node
*neigh
);
1202 /* orig_node handling API */
1203 void (*bat_orig_print
)(struct batadv_priv
*priv
, struct seq_file
*seq
,
1204 struct batadv_hard_iface
*hard_iface
);
1205 void (*bat_orig_free
)(struct batadv_orig_node
*orig_node
);
1206 int (*bat_orig_add_if
)(struct batadv_orig_node
*orig_node
,
1208 int (*bat_orig_del_if
)(struct batadv_orig_node
*orig_node
,
1209 int max_if_num
, int del_if_num
);
1213 * struct batadv_dat_entry - it is a single entry of batman-adv ARP backend. It
1214 * is used to stored ARP entries needed for the global DAT cache
1215 * @ip: the IPv4 corresponding to this DAT/ARP entry
1216 * @mac_addr: the MAC address associated to the stored IPv4
1217 * @vid: the vlan ID associated to this entry
1218 * @last_update: time in jiffies when this entry was refreshed last time
1219 * @hash_entry: hlist node for batadv_priv_dat::hash
1220 * @refcount: number of contexts the object is used
1221 * @rcu: struct used for freeing in an RCU-safe manner
1223 struct batadv_dat_entry
{
1225 u8 mac_addr
[ETH_ALEN
];
1227 unsigned long last_update
;
1228 struct hlist_node hash_entry
;
1230 struct rcu_head rcu
;
1234 * struct batadv_hw_addr - a list entry for a MAC address
1235 * @list: list node for the linking of entries
1236 * @addr: the MAC address of this list entry
1238 struct batadv_hw_addr
{
1239 struct hlist_node list
;
1240 unsigned char addr
[ETH_ALEN
];
1244 * struct batadv_dat_candidate - candidate destination for DAT operations
1245 * @type: the type of the selected candidate. It can one of the following:
1246 * - BATADV_DAT_CANDIDATE_NOT_FOUND
1247 * - BATADV_DAT_CANDIDATE_ORIG
1248 * @orig_node: if type is BATADV_DAT_CANDIDATE_ORIG this field points to the
1249 * corresponding originator node structure
1251 struct batadv_dat_candidate
{
1253 struct batadv_orig_node
*orig_node
;
1257 * struct batadv_tvlv_container - container for tvlv appended to OGMs
1258 * @list: hlist node for batadv_priv_tvlv::container_list
1259 * @tvlv_hdr: tvlv header information needed to construct the tvlv
1260 * @value_len: length of the buffer following this struct which contains
1261 * the actual tvlv payload
1262 * @refcount: number of contexts the object is used
1264 struct batadv_tvlv_container
{
1265 struct hlist_node list
;
1266 struct batadv_tvlv_hdr tvlv_hdr
;
1271 * struct batadv_tvlv_handler - handler for specific tvlv type and version
1272 * @list: hlist node for batadv_priv_tvlv::handler_list
1273 * @ogm_handler: handler callback which is given the tvlv payload to process on
1274 * incoming OGM packets
1275 * @unicast_handler: handler callback which is given the tvlv payload to process
1276 * on incoming unicast tvlv packets
1277 * @type: tvlv type this handler feels responsible for
1278 * @version: tvlv version this handler feels responsible for
1279 * @flags: tvlv handler flags
1280 * @refcount: number of contexts the object is used
1281 * @rcu: struct used for freeing in an RCU-safe manner
1283 struct batadv_tvlv_handler
{
1284 struct hlist_node list
;
1285 void (*ogm_handler
)(struct batadv_priv
*bat_priv
,
1286 struct batadv_orig_node
*orig
,
1287 u8 flags
, void *tvlv_value
, u16 tvlv_value_len
);
1288 int (*unicast_handler
)(struct batadv_priv
*bat_priv
,
1290 void *tvlv_value
, u16 tvlv_value_len
);
1295 struct rcu_head rcu
;
1299 * enum batadv_tvlv_handler_flags - tvlv handler flags definitions
1300 * @BATADV_TVLV_HANDLER_OGM_CIFNOTFND: tvlv ogm processing function will call
1301 * this handler even if its type was not found (with no data)
1302 * @BATADV_TVLV_HANDLER_OGM_CALLED: interval tvlv handling flag - the API marks
1303 * a handler as being called, so it won't be called if the
1304 * BATADV_TVLV_HANDLER_OGM_CIFNOTFND flag was set
1306 enum batadv_tvlv_handler_flags
{
1307 BATADV_TVLV_HANDLER_OGM_CIFNOTFND
= BIT(1),
1308 BATADV_TVLV_HANDLER_OGM_CALLED
= BIT(2),
1311 #endif /* _NET_BATMAN_ADV_TYPES_H_ */