1 /* Copyright (C) 2007-2016 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/average.h>
26 #include <linux/bitops.h>
27 #include <linux/compiler.h>
28 #include <linux/if_ether.h>
29 #include <linux/kref.h>
30 #include <linux/netdevice.h>
31 #include <linux/sched.h> /* for linux/wait.h */
32 #include <linux/spinlock.h>
33 #include <linux/types.h>
34 #include <linux/wait.h>
35 #include <linux/workqueue.h>
41 #ifdef CONFIG_BATMAN_ADV_DAT
44 * batadv_dat_addr_t - it is the type used for all DHT addresses. If it is
45 * changed, BATADV_DAT_ADDR_MAX is changed as well.
47 * *Please be careful: batadv_dat_addr_t must be UNSIGNED*
49 #define batadv_dat_addr_t u16
51 #endif /* CONFIG_BATMAN_ADV_DAT */
54 * enum batadv_dhcp_recipient - dhcp destination
55 * @BATADV_DHCP_NO: packet is not a dhcp message
56 * @BATADV_DHCP_TO_SERVER: dhcp message is directed to a server
57 * @BATADV_DHCP_TO_CLIENT: dhcp message is directed to a client
59 enum batadv_dhcp_recipient
{
61 BATADV_DHCP_TO_SERVER
,
62 BATADV_DHCP_TO_CLIENT
,
66 * BATADV_TT_REMOTE_MASK - bitmask selecting the flags that are sent over the
69 #define BATADV_TT_REMOTE_MASK 0x00FF
72 * BATADV_TT_SYNC_MASK - bitmask of the flags that need to be kept in sync
73 * among the nodes. These flags are used to compute the global/local CRC
75 #define BATADV_TT_SYNC_MASK 0x00F0
78 * struct batadv_hard_iface_bat_iv - per hard-interface B.A.T.M.A.N. IV data
79 * @ogm_buff: buffer holding the OGM packet
80 * @ogm_buff_len: length of the OGM packet buffer
81 * @ogm_seqno: OGM sequence number - used to identify each OGM
83 struct batadv_hard_iface_bat_iv
{
84 unsigned char *ogm_buff
;
90 * enum batadv_v_hard_iface_flags - interface flags useful to B.A.T.M.A.N. V
91 * @BATADV_FULL_DUPLEX: tells if the connection over this link is full-duplex
92 * @BATADV_WARNING_DEFAULT: tells whether we have warned the user that no
93 * throughput data is available for this interface and that default values are
96 enum batadv_v_hard_iface_flags
{
97 BATADV_FULL_DUPLEX
= BIT(0),
98 BATADV_WARNING_DEFAULT
= BIT(1),
102 * struct batadv_hard_iface_bat_v - per hard-interface B.A.T.M.A.N. V data
103 * @elp_interval: time interval between two ELP transmissions
104 * @elp_seqno: current ELP sequence number
105 * @elp_skb: base skb containing the ELP message to send
106 * @elp_wq: workqueue used to schedule ELP transmissions
107 * @throughput_override: throughput override to disable link auto-detection
108 * @flags: interface specific flags
110 struct batadv_hard_iface_bat_v
{
111 atomic_t elp_interval
;
113 struct sk_buff
*elp_skb
;
114 struct delayed_work elp_wq
;
115 atomic_t throughput_override
;
120 * struct batadv_hard_iface - network device known to batman-adv
121 * @list: list node for batadv_hardif_list
122 * @if_num: identificator of the interface
123 * @if_status: status of the interface for batman-adv
124 * @net_dev: pointer to the net_device
125 * @num_bcasts: number of payload re-broadcasts on this interface (ARQ)
126 * @hardif_obj: kobject of the per interface sysfs "mesh" directory
127 * @refcount: number of contexts the object is used
128 * @batman_adv_ptype: packet type describing packets that should be processed by
129 * batman-adv for this interface
130 * @soft_iface: the batman-adv interface which uses this network interface
131 * @rcu: struct used for freeing in an RCU-safe manner
132 * @bat_iv: per hard-interface B.A.T.M.A.N. IV data
133 * @bat_v: per hard-interface B.A.T.M.A.N. V data
134 * @cleanup_work: work queue callback item for hard-interface deinit
135 * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
136 * @neigh_list: list of unique single hop neighbors via this interface
137 * @neigh_list_lock: lock protecting neigh_list
139 struct batadv_hard_iface
{
140 struct list_head list
;
143 struct net_device
*net_dev
;
145 struct kobject
*hardif_obj
;
146 struct kref refcount
;
147 struct packet_type batman_adv_ptype
;
148 struct net_device
*soft_iface
;
150 struct batadv_hard_iface_bat_iv bat_iv
;
151 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
152 struct batadv_hard_iface_bat_v bat_v
;
154 struct work_struct cleanup_work
;
155 struct dentry
*debug_dir
;
156 struct hlist_head neigh_list
;
157 /* neigh_list_lock protects: neigh_list */
158 spinlock_t neigh_list_lock
;
162 * struct batadv_orig_ifinfo - originator info per outgoing interface
163 * @list: list node for orig_node::ifinfo_list
164 * @if_outgoing: pointer to outgoing hard-interface
165 * @router: router that should be used to reach this originator
166 * @last_real_seqno: last and best known sequence number
167 * @last_ttl: ttl of last received packet
168 * @last_seqno_forwarded: seqno of the OGM which was forwarded last
169 * @batman_seqno_reset: time when the batman seqno window was reset
170 * @refcount: number of contexts the object is used
171 * @rcu: struct used for freeing in an RCU-safe manner
173 struct batadv_orig_ifinfo
{
174 struct hlist_node list
;
175 struct batadv_hard_iface
*if_outgoing
;
176 struct batadv_neigh_node __rcu
*router
; /* rcu protected pointer */
179 u32 last_seqno_forwarded
;
180 unsigned long batman_seqno_reset
;
181 struct kref refcount
;
186 * struct batadv_frag_table_entry - head in the fragment buffer table
187 * @head: head of list with fragments
188 * @lock: lock to protect the list of fragments
189 * @timestamp: time (jiffie) of last received fragment
190 * @seqno: sequence number of the fragments in the list
191 * @size: accumulated size of packets in list
192 * @total_size: expected size of the assembled packet
194 struct batadv_frag_table_entry
{
195 struct hlist_head head
;
196 spinlock_t lock
; /* protects head */
197 unsigned long timestamp
;
204 * struct batadv_frag_list_entry - entry in a list of fragments
205 * @list: list node information
207 * @no: fragment number in the set
209 struct batadv_frag_list_entry
{
210 struct hlist_node list
;
216 * struct batadv_vlan_tt - VLAN specific TT attributes
217 * @crc: CRC32 checksum of the entries belonging to this vlan
218 * @num_entries: number of TT entries for this VLAN
220 struct batadv_vlan_tt
{
222 atomic_t num_entries
;
226 * struct batadv_orig_node_vlan - VLAN specific data per orig_node
227 * @vid: the VLAN identifier
228 * @tt: VLAN specific TT attributes
229 * @list: list node for orig_node::vlan_list
230 * @refcount: number of context where this object is currently in use
231 * @rcu: struct used for freeing in a RCU-safe manner
233 struct batadv_orig_node_vlan
{
235 struct batadv_vlan_tt tt
;
236 struct hlist_node list
;
237 struct kref refcount
;
242 * struct batadv_orig_bat_iv - B.A.T.M.A.N. IV private orig_node members
243 * @bcast_own: set of bitfields (one per hard-interface) where each one counts
244 * the number of our OGMs this orig_node rebroadcasted "back" to us (relative
245 * to last_real_seqno). Every bitfield is BATADV_TQ_LOCAL_WINDOW_SIZE bits long.
246 * @bcast_own_sum: sum of bcast_own
247 * @ogm_cnt_lock: lock protecting bcast_own, bcast_own_sum,
248 * neigh_node->bat_iv.real_bits & neigh_node->bat_iv.real_packet_count
250 struct batadv_orig_bat_iv
{
251 unsigned long *bcast_own
;
253 /* ogm_cnt_lock protects: bcast_own, bcast_own_sum,
254 * neigh_node->bat_iv.real_bits & neigh_node->bat_iv.real_packet_count
256 spinlock_t ogm_cnt_lock
;
260 * struct batadv_orig_node - structure for orig_list maintaining nodes of mesh
261 * @orig: originator ethernet address
262 * @ifinfo_list: list for routers per outgoing interface
263 * @last_bonding_candidate: pointer to last ifinfo of last used router
264 * @dat_addr: address of the orig node in the distributed hash
265 * @last_seen: time when last packet from this node was received
266 * @bcast_seqno_reset: time when the broadcast seqno window was reset
267 * @mcast_handler_lock: synchronizes mcast-capability and -flag changes
268 * @mcast_flags: multicast flags announced by the orig node
269 * @mcast_want_all_unsnoopables_node: a list node for the
270 * mcast.want_all_unsnoopables list
271 * @mcast_want_all_ipv4_node: a list node for the mcast.want_all_ipv4 list
272 * @mcast_want_all_ipv6_node: a list node for the mcast.want_all_ipv6 list
273 * @capabilities: announced capabilities of this originator
274 * @capa_initialized: bitfield to remember whether a capability was initialized
275 * @last_ttvn: last seen translation table version number
276 * @tt_buff: last tt changeset this node received from the orig node
277 * @tt_buff_len: length of the last tt changeset this node received from the
279 * @tt_buff_lock: lock that protects tt_buff and tt_buff_len
280 * @tt_lock: prevents from updating the table while reading it. Table update is
281 * made up by two operations (data structure update and metdata -CRC/TTVN-
282 * recalculation) and they have to be executed atomically in order to avoid
283 * another thread to read the table/metadata between those.
284 * @bcast_bits: bitfield containing the info which payload broadcast originated
285 * from this orig node this host already has seen (relative to
287 * @last_bcast_seqno: last broadcast sequence number received by this host
288 * @neigh_list: list of potential next hop neighbor towards this orig node
289 * @neigh_list_lock: lock protecting neigh_list and router
290 * @hash_entry: hlist node for batadv_priv::orig_hash
291 * @bat_priv: pointer to soft_iface this orig node belongs to
292 * @bcast_seqno_lock: lock protecting bcast_bits & last_bcast_seqno
293 * @refcount: number of contexts the object is used
294 * @rcu: struct used for freeing in an RCU-safe manner
295 * @in_coding_list: list of nodes this orig can hear
296 * @out_coding_list: list of nodes that can hear this orig
297 * @in_coding_list_lock: protects in_coding_list
298 * @out_coding_list_lock: protects out_coding_list
299 * @fragments: array with heads for fragment chains
300 * @vlan_list: a list of orig_node_vlan structs, one per VLAN served by the
301 * originator represented by this object
302 * @vlan_list_lock: lock protecting vlan_list
303 * @bat_iv: B.A.T.M.A.N. IV private structure
305 struct batadv_orig_node
{
307 struct hlist_head ifinfo_list
;
308 struct batadv_orig_ifinfo
*last_bonding_candidate
;
309 #ifdef CONFIG_BATMAN_ADV_DAT
310 batadv_dat_addr_t dat_addr
;
312 unsigned long last_seen
;
313 unsigned long bcast_seqno_reset
;
314 #ifdef CONFIG_BATMAN_ADV_MCAST
315 /* synchronizes mcast tvlv specific orig changes */
316 spinlock_t mcast_handler_lock
;
318 struct hlist_node mcast_want_all_unsnoopables_node
;
319 struct hlist_node mcast_want_all_ipv4_node
;
320 struct hlist_node mcast_want_all_ipv6_node
;
322 unsigned long capabilities
;
323 unsigned long capa_initialized
;
325 unsigned char *tt_buff
;
327 spinlock_t tt_buff_lock
; /* protects tt_buff & tt_buff_len */
328 /* prevents from changing the table while reading it */
330 DECLARE_BITMAP(bcast_bits
, BATADV_TQ_LOCAL_WINDOW_SIZE
);
331 u32 last_bcast_seqno
;
332 struct hlist_head neigh_list
;
333 /* neigh_list_lock protects: neigh_list and router */
334 spinlock_t neigh_list_lock
;
335 struct hlist_node hash_entry
;
336 struct batadv_priv
*bat_priv
;
337 /* bcast_seqno_lock protects: bcast_bits & last_bcast_seqno */
338 spinlock_t bcast_seqno_lock
;
339 struct kref refcount
;
341 #ifdef CONFIG_BATMAN_ADV_NC
342 struct list_head in_coding_list
;
343 struct list_head out_coding_list
;
344 spinlock_t in_coding_list_lock
; /* Protects in_coding_list */
345 spinlock_t out_coding_list_lock
; /* Protects out_coding_list */
347 struct batadv_frag_table_entry fragments
[BATADV_FRAG_BUFFER_COUNT
];
348 struct hlist_head vlan_list
;
349 spinlock_t vlan_list_lock
; /* protects vlan_list */
350 struct batadv_orig_bat_iv bat_iv
;
354 * enum batadv_orig_capabilities - orig node capabilities
355 * @BATADV_ORIG_CAPA_HAS_DAT: orig node has distributed arp table enabled
356 * @BATADV_ORIG_CAPA_HAS_NC: orig node has network coding enabled
357 * @BATADV_ORIG_CAPA_HAS_TT: orig node has tt capability
358 * @BATADV_ORIG_CAPA_HAS_MCAST: orig node has some multicast capability
359 * (= orig node announces a tvlv of type BATADV_TVLV_MCAST)
361 enum batadv_orig_capabilities
{
362 BATADV_ORIG_CAPA_HAS_DAT
,
363 BATADV_ORIG_CAPA_HAS_NC
,
364 BATADV_ORIG_CAPA_HAS_TT
,
365 BATADV_ORIG_CAPA_HAS_MCAST
,
369 * struct batadv_gw_node - structure for orig nodes announcing gw capabilities
370 * @list: list node for batadv_priv_gw::list
371 * @orig_node: pointer to corresponding orig node
372 * @bandwidth_down: advertised uplink download bandwidth
373 * @bandwidth_up: advertised uplink upload bandwidth
374 * @refcount: number of contexts the object is used
375 * @rcu: struct used for freeing in an RCU-safe manner
377 struct batadv_gw_node
{
378 struct hlist_node list
;
379 struct batadv_orig_node
*orig_node
;
382 struct kref refcount
;
386 DECLARE_EWMA(throughput
, 1024, 8)
389 * struct batadv_hardif_neigh_node_bat_v - B.A.T.M.A.N. V private neighbor
391 * @throughput: ewma link throughput towards this neighbor
392 * @elp_interval: time interval between two ELP transmissions
393 * @elp_latest_seqno: latest and best known ELP sequence number
394 * @last_unicast_tx: when the last unicast packet has been sent to this neighbor
395 * @metric_work: work queue callback item for metric update
397 struct batadv_hardif_neigh_node_bat_v
{
398 struct ewma_throughput throughput
;
400 u32 elp_latest_seqno
;
401 unsigned long last_unicast_tx
;
402 struct work_struct metric_work
;
406 * struct batadv_hardif_neigh_node - unique neighbor per hard-interface
407 * @list: list node for batadv_hard_iface::neigh_list
408 * @addr: the MAC address of the neighboring interface
409 * @if_incoming: pointer to incoming hard-interface
410 * @last_seen: when last packet via this neighbor was received
411 * @bat_v: B.A.T.M.A.N. V private data
412 * @refcount: number of contexts the object is used
413 * @rcu: struct used for freeing in a RCU-safe manner
415 struct batadv_hardif_neigh_node
{
416 struct hlist_node list
;
418 struct batadv_hard_iface
*if_incoming
;
419 unsigned long last_seen
;
420 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
421 struct batadv_hardif_neigh_node_bat_v bat_v
;
423 struct kref refcount
;
428 * struct batadv_neigh_node - structure for single hops neighbors
429 * @list: list node for batadv_orig_node::neigh_list
430 * @orig_node: pointer to corresponding orig_node
431 * @addr: the MAC address of the neighboring interface
432 * @ifinfo_list: list for routing metrics per outgoing interface
433 * @ifinfo_lock: lock protecting private ifinfo members and list
434 * @if_incoming: pointer to incoming hard-interface
435 * @last_seen: when last packet via this neighbor was received
436 * @hardif_neigh: hardif_neigh of this neighbor
437 * @refcount: number of contexts the object is used
438 * @rcu: struct used for freeing in an RCU-safe manner
440 struct batadv_neigh_node
{
441 struct hlist_node list
;
442 struct batadv_orig_node
*orig_node
;
444 struct hlist_head ifinfo_list
;
445 spinlock_t ifinfo_lock
; /* protects ifinfo_list and its members */
446 struct batadv_hard_iface
*if_incoming
;
447 unsigned long last_seen
;
448 struct batadv_hardif_neigh_node
*hardif_neigh
;
449 struct kref refcount
;
454 * struct batadv_neigh_ifinfo_bat_iv - neighbor information per outgoing
455 * interface for B.A.T.M.A.N. IV
456 * @tq_recv: ring buffer of received TQ values from this neigh node
457 * @tq_index: ring buffer index
458 * @tq_avg: averaged tq of all tq values in the ring buffer (tq_recv)
459 * @real_bits: bitfield containing the number of OGMs received from this neigh
460 * node (relative to orig_node->last_real_seqno)
461 * @real_packet_count: counted result of real_bits
463 struct batadv_neigh_ifinfo_bat_iv
{
464 u8 tq_recv
[BATADV_TQ_GLOBAL_WINDOW_SIZE
];
467 DECLARE_BITMAP(real_bits
, BATADV_TQ_LOCAL_WINDOW_SIZE
);
468 u8 real_packet_count
;
472 * struct batadv_neigh_ifinfo_bat_v - neighbor information per outgoing
473 * interface for B.A.T.M.A.N. V
474 * @throughput: last throughput metric received from originator via this neigh
475 * @last_seqno: last sequence number known for this neighbor
477 struct batadv_neigh_ifinfo_bat_v
{
483 * struct batadv_neigh_ifinfo - neighbor information per outgoing interface
484 * @list: list node for batadv_neigh_node::ifinfo_list
485 * @if_outgoing: pointer to outgoing hard-interface
486 * @bat_iv: B.A.T.M.A.N. IV private structure
487 * @bat_v: B.A.T.M.A.N. V private data
488 * @last_ttl: last received ttl from this neigh node
489 * @refcount: number of contexts the object is used
490 * @rcu: struct used for freeing in a RCU-safe manner
492 struct batadv_neigh_ifinfo
{
493 struct hlist_node list
;
494 struct batadv_hard_iface
*if_outgoing
;
495 struct batadv_neigh_ifinfo_bat_iv bat_iv
;
496 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
497 struct batadv_neigh_ifinfo_bat_v bat_v
;
500 struct kref refcount
;
504 #ifdef CONFIG_BATMAN_ADV_BLA
507 * struct batadv_bcast_duplist_entry - structure for LAN broadcast suppression
508 * @orig: mac address of orig node orginating the broadcast
509 * @crc: crc32 checksum of broadcast payload
510 * @entrytime: time when the broadcast packet was received
512 struct batadv_bcast_duplist_entry
{
515 unsigned long entrytime
;
520 * enum batadv_counters - indices for traffic counters
521 * @BATADV_CNT_TX: transmitted payload traffic packet counter
522 * @BATADV_CNT_TX_BYTES: transmitted payload traffic bytes counter
523 * @BATADV_CNT_TX_DROPPED: dropped transmission payload traffic packet counter
524 * @BATADV_CNT_RX: received payload traffic packet counter
525 * @BATADV_CNT_RX_BYTES: received payload traffic bytes counter
526 * @BATADV_CNT_FORWARD: forwarded payload traffic packet counter
527 * @BATADV_CNT_FORWARD_BYTES: forwarded payload traffic bytes counter
528 * @BATADV_CNT_MGMT_TX: transmitted routing protocol traffic packet counter
529 * @BATADV_CNT_MGMT_TX_BYTES: transmitted routing protocol traffic bytes counter
530 * @BATADV_CNT_MGMT_RX: received routing protocol traffic packet counter
531 * @BATADV_CNT_MGMT_RX_BYTES: received routing protocol traffic bytes counter
532 * @BATADV_CNT_FRAG_TX: transmitted fragment traffic packet counter
533 * @BATADV_CNT_FRAG_TX_BYTES: transmitted fragment traffic bytes counter
534 * @BATADV_CNT_FRAG_RX: received fragment traffic packet counter
535 * @BATADV_CNT_FRAG_RX_BYTES: received fragment traffic bytes counter
536 * @BATADV_CNT_FRAG_FWD: forwarded fragment traffic packet counter
537 * @BATADV_CNT_FRAG_FWD_BYTES: forwarded fragment traffic bytes counter
538 * @BATADV_CNT_TT_REQUEST_TX: transmitted tt req traffic packet counter
539 * @BATADV_CNT_TT_REQUEST_RX: received tt req traffic packet counter
540 * @BATADV_CNT_TT_RESPONSE_TX: transmitted tt resp traffic packet counter
541 * @BATADV_CNT_TT_RESPONSE_RX: received tt resp traffic packet counter
542 * @BATADV_CNT_TT_ROAM_ADV_TX: transmitted tt roam traffic packet counter
543 * @BATADV_CNT_TT_ROAM_ADV_RX: received tt roam traffic packet counter
544 * @BATADV_CNT_DAT_GET_TX: transmitted dht GET traffic packet counter
545 * @BATADV_CNT_DAT_GET_RX: received dht GET traffic packet counter
546 * @BATADV_CNT_DAT_PUT_TX: transmitted dht PUT traffic packet counter
547 * @BATADV_CNT_DAT_PUT_RX: received dht PUT traffic packet counter
548 * @BATADV_CNT_DAT_CACHED_REPLY_TX: transmitted dat cache reply traffic packet
550 * @BATADV_CNT_NC_CODE: transmitted nc-combined traffic packet counter
551 * @BATADV_CNT_NC_CODE_BYTES: transmitted nc-combined traffic bytes counter
552 * @BATADV_CNT_NC_RECODE: transmitted nc-recombined traffic packet counter
553 * @BATADV_CNT_NC_RECODE_BYTES: transmitted nc-recombined traffic bytes counter
554 * @BATADV_CNT_NC_BUFFER: counter for packets buffered for later nc decoding
555 * @BATADV_CNT_NC_DECODE: received and nc-decoded traffic packet counter
556 * @BATADV_CNT_NC_DECODE_BYTES: received and nc-decoded traffic bytes counter
557 * @BATADV_CNT_NC_DECODE_FAILED: received and decode-failed traffic packet
559 * @BATADV_CNT_NC_SNIFFED: counter for nc-decoded packets received in promisc
561 * @BATADV_CNT_NUM: number of traffic counters
563 enum batadv_counters
{
566 BATADV_CNT_TX_DROPPED
,
570 BATADV_CNT_FORWARD_BYTES
,
572 BATADV_CNT_MGMT_TX_BYTES
,
574 BATADV_CNT_MGMT_RX_BYTES
,
576 BATADV_CNT_FRAG_TX_BYTES
,
578 BATADV_CNT_FRAG_RX_BYTES
,
580 BATADV_CNT_FRAG_FWD_BYTES
,
581 BATADV_CNT_TT_REQUEST_TX
,
582 BATADV_CNT_TT_REQUEST_RX
,
583 BATADV_CNT_TT_RESPONSE_TX
,
584 BATADV_CNT_TT_RESPONSE_RX
,
585 BATADV_CNT_TT_ROAM_ADV_TX
,
586 BATADV_CNT_TT_ROAM_ADV_RX
,
587 #ifdef CONFIG_BATMAN_ADV_DAT
588 BATADV_CNT_DAT_GET_TX
,
589 BATADV_CNT_DAT_GET_RX
,
590 BATADV_CNT_DAT_PUT_TX
,
591 BATADV_CNT_DAT_PUT_RX
,
592 BATADV_CNT_DAT_CACHED_REPLY_TX
,
594 #ifdef CONFIG_BATMAN_ADV_NC
596 BATADV_CNT_NC_CODE_BYTES
,
597 BATADV_CNT_NC_RECODE
,
598 BATADV_CNT_NC_RECODE_BYTES
,
599 BATADV_CNT_NC_BUFFER
,
600 BATADV_CNT_NC_DECODE
,
601 BATADV_CNT_NC_DECODE_BYTES
,
602 BATADV_CNT_NC_DECODE_FAILED
,
603 BATADV_CNT_NC_SNIFFED
,
609 * struct batadv_priv_tt - per mesh interface translation table data
610 * @vn: translation table version number
611 * @ogm_append_cnt: counter of number of OGMs containing the local tt diff
612 * @local_changes: changes registered in an originator interval
613 * @changes_list: tracks tt local changes within an originator interval
614 * @local_hash: local translation table hash table
615 * @global_hash: global translation table hash table
616 * @req_list: list of pending & unanswered tt_requests
617 * @roam_list: list of the last roaming events of each client limiting the
618 * number of roaming events to avoid route flapping
619 * @changes_list_lock: lock protecting changes_list
620 * @req_list_lock: lock protecting req_list
621 * @roam_list_lock: lock protecting roam_list
622 * @last_changeset: last tt changeset this host has generated
623 * @last_changeset_len: length of last tt changeset this host has generated
624 * @last_changeset_lock: lock protecting last_changeset & last_changeset_len
625 * @commit_lock: prevents from executing a local TT commit while reading the
626 * local table. The local TT commit is made up by two operations (data
627 * structure update and metdata -CRC/TTVN- recalculation) and they have to be
628 * executed atomically in order to avoid another thread to read the
629 * table/metadata between those.
630 * @work: work queue callback item for translation table purging
632 struct batadv_priv_tt
{
634 atomic_t ogm_append_cnt
;
635 atomic_t local_changes
;
636 struct list_head changes_list
;
637 struct batadv_hashtable
*local_hash
;
638 struct batadv_hashtable
*global_hash
;
639 struct hlist_head req_list
;
640 struct list_head roam_list
;
641 spinlock_t changes_list_lock
; /* protects changes */
642 spinlock_t req_list_lock
; /* protects req_list */
643 spinlock_t roam_list_lock
; /* protects roam_list */
644 unsigned char *last_changeset
;
645 s16 last_changeset_len
;
646 /* protects last_changeset & last_changeset_len */
647 spinlock_t last_changeset_lock
;
648 /* prevents from executing a commit while reading the table */
649 spinlock_t commit_lock
;
650 struct delayed_work work
;
653 #ifdef CONFIG_BATMAN_ADV_BLA
656 * struct batadv_priv_bla - per mesh interface bridge loope avoidance data
657 * @num_requests: number of bla requests in flight
658 * @claim_hash: hash table containing mesh nodes this host has claimed
659 * @backbone_hash: hash table containing all detected backbone gateways
660 * @loopdetect_addr: MAC address used for own loopdetection frames
661 * @loopdetect_lasttime: time when the loopdetection frames were sent
662 * @loopdetect_next: how many periods to wait for the next loopdetect process
663 * @bcast_duplist: recently received broadcast packets array (for broadcast
664 * duplicate suppression)
665 * @bcast_duplist_curr: index of last broadcast packet added to bcast_duplist
666 * @bcast_duplist_lock: lock protecting bcast_duplist & bcast_duplist_curr
667 * @claim_dest: local claim data (e.g. claim group)
668 * @work: work queue callback item for cleanups & bla announcements
670 struct batadv_priv_bla
{
671 atomic_t num_requests
;
672 struct batadv_hashtable
*claim_hash
;
673 struct batadv_hashtable
*backbone_hash
;
674 u8 loopdetect_addr
[ETH_ALEN
];
675 unsigned long loopdetect_lasttime
;
676 atomic_t loopdetect_next
;
677 struct batadv_bcast_duplist_entry bcast_duplist
[BATADV_DUPLIST_SIZE
];
678 int bcast_duplist_curr
;
679 /* protects bcast_duplist & bcast_duplist_curr */
680 spinlock_t bcast_duplist_lock
;
681 struct batadv_bla_claim_dst claim_dest
;
682 struct delayed_work work
;
686 #ifdef CONFIG_BATMAN_ADV_DEBUG
689 * struct batadv_priv_debug_log - debug logging data
690 * @log_buff: buffer holding the logs (ring bufer)
691 * @log_start: index of next character to read
692 * @log_end: index of next character to write
693 * @lock: lock protecting log_buff, log_start & log_end
694 * @queue_wait: log reader's wait queue
696 struct batadv_priv_debug_log
{
697 char log_buff
[BATADV_LOG_BUF_LEN
];
698 unsigned long log_start
;
699 unsigned long log_end
;
700 spinlock_t lock
; /* protects log_buff, log_start and log_end */
701 wait_queue_head_t queue_wait
;
706 * struct batadv_priv_gw - per mesh interface gateway data
707 * @list: list of available gateway nodes
708 * @list_lock: lock protecting gw_list & curr_gw
709 * @curr_gw: pointer to currently selected gateway node
710 * @mode: gateway operation: off, client or server (see batadv_gw_modes)
711 * @sel_class: gateway selection class (applies if gw_mode client)
712 * @bandwidth_down: advertised uplink download bandwidth (if gw_mode server)
713 * @bandwidth_up: advertised uplink upload bandwidth (if gw_mode server)
714 * @reselect: bool indicating a gateway re-selection is in progress
716 struct batadv_priv_gw
{
717 struct hlist_head list
;
718 spinlock_t list_lock
; /* protects gw_list & curr_gw */
719 struct batadv_gw_node __rcu
*curr_gw
; /* rcu protected pointer */
722 atomic_t bandwidth_down
;
723 atomic_t bandwidth_up
;
728 * struct batadv_priv_tvlv - per mesh interface tvlv data
729 * @container_list: list of registered tvlv containers to be sent with each OGM
730 * @handler_list: list of the various tvlv content handlers
731 * @container_list_lock: protects tvlv container list access
732 * @handler_list_lock: protects handler list access
734 struct batadv_priv_tvlv
{
735 struct hlist_head container_list
;
736 struct hlist_head handler_list
;
737 spinlock_t container_list_lock
; /* protects container_list */
738 spinlock_t handler_list_lock
; /* protects handler_list */
741 #ifdef CONFIG_BATMAN_ADV_DAT
744 * struct batadv_priv_dat - per mesh interface DAT private data
745 * @addr: node DAT address
746 * @hash: hashtable representing the local ARP cache
747 * @work: work queue callback item for cache purging
749 struct batadv_priv_dat
{
750 batadv_dat_addr_t addr
;
751 struct batadv_hashtable
*hash
;
752 struct delayed_work work
;
756 #ifdef CONFIG_BATMAN_ADV_MCAST
758 * struct batadv_mcast_querier_state - IGMP/MLD querier state when bridged
759 * @exists: whether a querier exists in the mesh
760 * @shadowing: if a querier exists, whether it is potentially shadowing
761 * multicast listeners (i.e. querier is behind our own bridge segment)
763 struct batadv_mcast_querier_state
{
769 * struct batadv_priv_mcast - per mesh interface mcast data
770 * @mla_list: list of multicast addresses we are currently announcing via TT
771 * @want_all_unsnoopables_list: a list of orig_nodes wanting all unsnoopable
773 * @want_all_ipv4_list: a list of orig_nodes wanting all IPv4 multicast traffic
774 * @want_all_ipv6_list: a list of orig_nodes wanting all IPv6 multicast traffic
775 * @flags: the flags we have last sent in our mcast tvlv
776 * @enabled: whether the multicast tvlv is currently enabled
777 * @bridged: whether the soft interface has a bridge on top
778 * @num_disabled: number of nodes that have no mcast tvlv
779 * @num_want_all_unsnoopables: number of nodes wanting unsnoopable IP traffic
780 * @num_want_all_ipv4: counter for items in want_all_ipv4_list
781 * @num_want_all_ipv6: counter for items in want_all_ipv6_list
782 * @want_lists_lock: lock for protecting modifications to mcast want lists
783 * (traversals are rcu-locked)
785 struct batadv_priv_mcast
{
786 struct hlist_head mla_list
;
787 struct hlist_head want_all_unsnoopables_list
;
788 struct hlist_head want_all_ipv4_list
;
789 struct hlist_head want_all_ipv6_list
;
793 atomic_t num_disabled
;
794 atomic_t num_want_all_unsnoopables
;
795 atomic_t num_want_all_ipv4
;
796 atomic_t num_want_all_ipv6
;
797 /* protects want_all_{unsnoopables,ipv4,ipv6}_list */
798 spinlock_t want_lists_lock
;
803 * struct batadv_priv_nc - per mesh interface network coding private data
804 * @work: work queue callback item for cleanup
805 * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
806 * @min_tq: only consider neighbors for encoding if neigh_tq > min_tq
807 * @max_fwd_delay: maximum packet forward delay to allow coding of packets
808 * @max_buffer_time: buffer time for sniffed packets used to decoding
809 * @timestamp_fwd_flush: timestamp of last forward packet queue flush
810 * @timestamp_sniffed_purge: timestamp of last sniffed packet queue purge
811 * @coding_hash: Hash table used to buffer skbs while waiting for another
812 * incoming skb to code it with. Skbs are added to the buffer just before being
813 * forwarded in routing.c
814 * @decoding_hash: Hash table used to buffer skbs that might be needed to decode
815 * a received coded skb. The buffer is used for 1) skbs arriving on the
816 * soft-interface; 2) skbs overheard on the hard-interface; and 3) skbs
817 * forwarded by batman-adv.
819 struct batadv_priv_nc
{
820 struct delayed_work work
;
821 struct dentry
*debug_dir
;
825 unsigned long timestamp_fwd_flush
;
826 unsigned long timestamp_sniffed_purge
;
827 struct batadv_hashtable
*coding_hash
;
828 struct batadv_hashtable
*decoding_hash
;
832 * struct batadv_softif_vlan - per VLAN attributes set
833 * @bat_priv: pointer to the mesh object
834 * @vid: VLAN identifier
835 * @kobj: kobject for sysfs vlan subdirectory
836 * @ap_isolation: AP isolation state
837 * @tt: TT private attributes (VLAN specific)
838 * @list: list node for bat_priv::softif_vlan_list
839 * @refcount: number of context where this object is currently in use
840 * @rcu: struct used for freeing in a RCU-safe manner
842 struct batadv_softif_vlan
{
843 struct batadv_priv
*bat_priv
;
845 struct kobject
*kobj
;
846 atomic_t ap_isolation
; /* boolean */
847 struct batadv_vlan_tt tt
;
848 struct hlist_node list
;
849 struct kref refcount
;
854 * struct batadv_priv_bat_v - B.A.T.M.A.N. V per soft-interface private data
855 * @ogm_buff: buffer holding the OGM packet
856 * @ogm_buff_len: length of the OGM packet buffer
857 * @ogm_seqno: OGM sequence number - used to identify each OGM
858 * @ogm_wq: workqueue used to schedule OGM transmissions
860 struct batadv_priv_bat_v
{
861 unsigned char *ogm_buff
;
864 struct delayed_work ogm_wq
;
868 * struct batadv_priv - per mesh interface data
869 * @mesh_state: current status of the mesh (inactive/active/deactivating)
870 * @soft_iface: net device which holds this struct as private data
871 * @stats: structure holding the data for the ndo_get_stats() call
872 * @bat_counters: mesh internal traffic statistic counters (see batadv_counters)
873 * @aggregated_ogms: bool indicating whether OGM aggregation is enabled
874 * @bonding: bool indicating whether traffic bonding is enabled
875 * @fragmentation: bool indicating whether traffic fragmentation is enabled
876 * @packet_size_max: max packet size that can be transmitted via
877 * multiple fragmented skbs or a single frame if fragmentation is disabled
878 * @frag_seqno: incremental counter to identify chains of egress fragments
879 * @bridge_loop_avoidance: bool indicating whether bridge loop avoidance is
881 * @distributed_arp_table: bool indicating whether distributed ARP table is
883 * @multicast_mode: Enable or disable multicast optimizations on this node's
884 * sender/originating side
885 * @orig_interval: OGM broadcast interval in milliseconds
886 * @hop_penalty: penalty which will be applied to an OGM's tq-field on every hop
887 * @log_level: configured log level (see batadv_dbg_level)
888 * @isolation_mark: the skb->mark value used to match packets for AP isolation
889 * @isolation_mark_mask: bitmask identifying the bits in skb->mark to be used
890 * for the isolation mark
891 * @bcast_seqno: last sent broadcast packet sequence number
892 * @bcast_queue_left: number of remaining buffered broadcast packet slots
893 * @batman_queue_left: number of remaining OGM packet slots
894 * @num_ifaces: number of interfaces assigned to this mesh interface
895 * @mesh_obj: kobject for sysfs mesh subdirectory
896 * @debug_dir: dentry for debugfs batman-adv subdirectory
897 * @forw_bat_list: list of aggregated OGMs that will be forwarded
898 * @forw_bcast_list: list of broadcast packets that will be rebroadcasted
899 * @orig_hash: hash table containing mesh participants (orig nodes)
900 * @forw_bat_list_lock: lock protecting forw_bat_list
901 * @forw_bcast_list_lock: lock protecting forw_bcast_list
902 * @orig_work: work queue callback item for orig node purging
903 * @cleanup_work: work queue callback item for soft-interface deinit
904 * @primary_if: one of the hard-interfaces assigned to this mesh interface
905 * becomes the primary interface
906 * @bat_algo_ops: routing algorithm used by this mesh interface
907 * @softif_vlan_list: a list of softif_vlan structs, one per VLAN created on top
908 * of the mesh interface represented by this object
909 * @softif_vlan_list_lock: lock protecting softif_vlan_list
910 * @bla: bridge loope avoidance data
911 * @debug_log: holding debug logging relevant data
913 * @tt: translation table data
914 * @tvlv: type-version-length-value data
915 * @dat: distributed arp table data
916 * @mcast: multicast data
917 * @network_coding: bool indicating whether network coding is enabled
918 * @nc: network coding data
919 * @bat_v: B.A.T.M.A.N. V per soft-interface private data
923 struct net_device
*soft_iface
;
924 struct net_device_stats stats
;
925 u64 __percpu
*bat_counters
; /* Per cpu counters */
926 atomic_t aggregated_ogms
;
928 atomic_t fragmentation
;
929 atomic_t packet_size_max
;
931 #ifdef CONFIG_BATMAN_ADV_BLA
932 atomic_t bridge_loop_avoidance
;
934 #ifdef CONFIG_BATMAN_ADV_DAT
935 atomic_t distributed_arp_table
;
937 #ifdef CONFIG_BATMAN_ADV_MCAST
938 atomic_t multicast_mode
;
940 atomic_t orig_interval
;
941 atomic_t hop_penalty
;
942 #ifdef CONFIG_BATMAN_ADV_DEBUG
946 u32 isolation_mark_mask
;
947 atomic_t bcast_seqno
;
948 atomic_t bcast_queue_left
;
949 atomic_t batman_queue_left
;
951 struct kobject
*mesh_obj
;
952 struct dentry
*debug_dir
;
953 struct hlist_head forw_bat_list
;
954 struct hlist_head forw_bcast_list
;
955 struct batadv_hashtable
*orig_hash
;
956 spinlock_t forw_bat_list_lock
; /* protects forw_bat_list */
957 spinlock_t forw_bcast_list_lock
; /* protects forw_bcast_list */
958 struct delayed_work orig_work
;
959 struct work_struct cleanup_work
;
960 struct batadv_hard_iface __rcu
*primary_if
; /* rcu protected pointer */
961 struct batadv_algo_ops
*bat_algo_ops
;
962 struct hlist_head softif_vlan_list
;
963 spinlock_t softif_vlan_list_lock
; /* protects softif_vlan_list */
964 #ifdef CONFIG_BATMAN_ADV_BLA
965 struct batadv_priv_bla bla
;
967 #ifdef CONFIG_BATMAN_ADV_DEBUG
968 struct batadv_priv_debug_log
*debug_log
;
970 struct batadv_priv_gw gw
;
971 struct batadv_priv_tt tt
;
972 struct batadv_priv_tvlv tvlv
;
973 #ifdef CONFIG_BATMAN_ADV_DAT
974 struct batadv_priv_dat dat
;
976 #ifdef CONFIG_BATMAN_ADV_MCAST
977 struct batadv_priv_mcast mcast
;
979 #ifdef CONFIG_BATMAN_ADV_NC
980 atomic_t network_coding
;
981 struct batadv_priv_nc nc
;
982 #endif /* CONFIG_BATMAN_ADV_NC */
983 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
984 struct batadv_priv_bat_v bat_v
;
989 * struct batadv_socket_client - layer2 icmp socket client data
990 * @queue_list: packet queue for packets destined for this socket client
991 * @queue_len: number of packets in the packet queue (queue_list)
992 * @index: socket client's index in the batadv_socket_client_hash
993 * @lock: lock protecting queue_list, queue_len & index
994 * @queue_wait: socket client's wait queue
995 * @bat_priv: pointer to soft_iface this client belongs to
997 struct batadv_socket_client
{
998 struct list_head queue_list
;
999 unsigned int queue_len
;
1000 unsigned char index
;
1001 spinlock_t lock
; /* protects queue_list, queue_len & index */
1002 wait_queue_head_t queue_wait
;
1003 struct batadv_priv
*bat_priv
;
1007 * struct batadv_socket_packet - layer2 icmp packet for socket client
1008 * @list: list node for batadv_socket_client::queue_list
1009 * @icmp_len: size of the layer2 icmp packet
1010 * @icmp_packet: layer2 icmp packet
1012 struct batadv_socket_packet
{
1013 struct list_head list
;
1015 u8 icmp_packet
[BATADV_ICMP_MAX_PACKET_SIZE
];
1018 #ifdef CONFIG_BATMAN_ADV_BLA
1021 * struct batadv_bla_backbone_gw - batman-adv gateway bridged into the LAN
1022 * @orig: originator address of backbone node (mac address of primary iface)
1023 * @vid: vlan id this gateway was detected on
1024 * @hash_entry: hlist node for batadv_priv_bla::backbone_hash
1025 * @bat_priv: pointer to soft_iface this backbone gateway belongs to
1026 * @lasttime: last time we heard of this backbone gw
1027 * @wait_periods: grace time for bridge forward delays and bla group forming at
1028 * bootup phase - no bcast traffic is formwared until it has elapsed
1029 * @request_sent: if this bool is set to true we are out of sync with this
1030 * backbone gateway - no bcast traffic is formwared until the situation was
1032 * @crc: crc16 checksum over all claims
1033 * @crc_lock: lock protecting crc
1034 * @report_work: work struct for reporting detected loops
1035 * @refcount: number of contexts the object is used
1036 * @rcu: struct used for freeing in an RCU-safe manner
1038 struct batadv_bla_backbone_gw
{
1041 struct hlist_node hash_entry
;
1042 struct batadv_priv
*bat_priv
;
1043 unsigned long lasttime
;
1044 atomic_t wait_periods
;
1045 atomic_t request_sent
;
1047 spinlock_t crc_lock
; /* protects crc */
1048 struct work_struct report_work
;
1049 struct kref refcount
;
1050 struct rcu_head rcu
;
1054 * struct batadv_bla_claim - claimed non-mesh client structure
1055 * @addr: mac address of claimed non-mesh client
1056 * @vid: vlan id this client was detected on
1057 * @backbone_gw: pointer to backbone gw claiming this client
1058 * @lasttime: last time we heard of claim (locals only)
1059 * @hash_entry: hlist node for batadv_priv_bla::claim_hash
1060 * @refcount: number of contexts the object is used
1061 * @rcu: struct used for freeing in an RCU-safe manner
1063 struct batadv_bla_claim
{
1066 struct batadv_bla_backbone_gw
*backbone_gw
;
1067 unsigned long lasttime
;
1068 struct hlist_node hash_entry
;
1069 struct rcu_head rcu
;
1070 struct kref refcount
;
1075 * struct batadv_tt_common_entry - tt local & tt global common data
1076 * @addr: mac address of non-mesh client
1077 * @vid: VLAN identifier
1078 * @hash_entry: hlist node for batadv_priv_tt::local_hash or for
1079 * batadv_priv_tt::global_hash
1080 * @flags: various state handling flags (see batadv_tt_client_flags)
1081 * @added_at: timestamp used for purging stale tt common entries
1082 * @refcount: number of contexts the object is used
1083 * @rcu: struct used for freeing in an RCU-safe manner
1085 struct batadv_tt_common_entry
{
1088 struct hlist_node hash_entry
;
1090 unsigned long added_at
;
1091 struct kref refcount
;
1092 struct rcu_head rcu
;
1096 * struct batadv_tt_local_entry - translation table local entry data
1097 * @common: general translation table data
1098 * @last_seen: timestamp used for purging stale tt local entries
1099 * @vlan: soft-interface vlan of the entry
1101 struct batadv_tt_local_entry
{
1102 struct batadv_tt_common_entry common
;
1103 unsigned long last_seen
;
1104 struct batadv_softif_vlan
*vlan
;
1108 * struct batadv_tt_global_entry - translation table global entry data
1109 * @common: general translation table data
1110 * @orig_list: list of orig nodes announcing this non-mesh client
1111 * @orig_list_count: number of items in the orig_list
1112 * @list_lock: lock protecting orig_list
1113 * @roam_at: time at which TT_GLOBAL_ROAM was set
1115 struct batadv_tt_global_entry
{
1116 struct batadv_tt_common_entry common
;
1117 struct hlist_head orig_list
;
1118 atomic_t orig_list_count
;
1119 spinlock_t list_lock
; /* protects orig_list */
1120 unsigned long roam_at
;
1124 * struct batadv_tt_orig_list_entry - orig node announcing a non-mesh client
1125 * @orig_node: pointer to orig node announcing this non-mesh client
1126 * @ttvn: translation table version number which added the non-mesh client
1127 * @list: list node for batadv_tt_global_entry::orig_list
1128 * @refcount: number of contexts the object is used
1129 * @rcu: struct used for freeing in an RCU-safe manner
1131 struct batadv_tt_orig_list_entry
{
1132 struct batadv_orig_node
*orig_node
;
1134 struct hlist_node list
;
1135 struct kref refcount
;
1136 struct rcu_head rcu
;
1140 * struct batadv_tt_change_node - structure for tt changes occurred
1141 * @list: list node for batadv_priv_tt::changes_list
1142 * @change: holds the actual translation table diff data
1144 struct batadv_tt_change_node
{
1145 struct list_head list
;
1146 struct batadv_tvlv_tt_change change
;
1150 * struct batadv_tt_req_node - data to keep track of the tt requests in flight
1151 * @addr: mac address address of the originator this request was sent to
1152 * @issued_at: timestamp used for purging stale tt requests
1153 * @list: list node for batadv_priv_tt::req_list
1155 struct batadv_tt_req_node
{
1157 unsigned long issued_at
;
1158 struct hlist_node list
;
1162 * struct batadv_tt_roam_node - roaming client data
1163 * @addr: mac address of the client in the roaming phase
1164 * @counter: number of allowed roaming events per client within a single
1165 * OGM interval (changes are committed with each OGM)
1166 * @first_time: timestamp used for purging stale roaming node entries
1167 * @list: list node for batadv_priv_tt::roam_list
1169 struct batadv_tt_roam_node
{
1172 unsigned long first_time
;
1173 struct list_head list
;
1177 * struct batadv_nc_node - network coding node
1178 * @list: next and prev pointer for the list handling
1179 * @addr: the node's mac address
1180 * @refcount: number of contexts the object is used by
1181 * @rcu: struct used for freeing in an RCU-safe manner
1182 * @orig_node: pointer to corresponding orig node struct
1183 * @last_seen: timestamp of last ogm received from this node
1185 struct batadv_nc_node
{
1186 struct list_head list
;
1188 struct kref refcount
;
1189 struct rcu_head rcu
;
1190 struct batadv_orig_node
*orig_node
;
1191 unsigned long last_seen
;
1195 * struct batadv_nc_path - network coding path
1196 * @hash_entry: next and prev pointer for the list handling
1197 * @rcu: struct used for freeing in an RCU-safe manner
1198 * @refcount: number of contexts the object is used by
1199 * @packet_list: list of buffered packets for this path
1200 * @packet_list_lock: access lock for packet list
1201 * @next_hop: next hop (destination) of path
1202 * @prev_hop: previous hop (source) of path
1203 * @last_valid: timestamp for last validation of path
1205 struct batadv_nc_path
{
1206 struct hlist_node hash_entry
;
1207 struct rcu_head rcu
;
1208 struct kref refcount
;
1209 struct list_head packet_list
;
1210 spinlock_t packet_list_lock
; /* Protects packet_list */
1211 u8 next_hop
[ETH_ALEN
];
1212 u8 prev_hop
[ETH_ALEN
];
1213 unsigned long last_valid
;
1217 * struct batadv_nc_packet - network coding packet used when coding and
1219 * @list: next and prev pointer for the list handling
1220 * @packet_id: crc32 checksum of skb data
1221 * @timestamp: field containing the info when the packet was added to path
1222 * @neigh_node: pointer to original next hop neighbor of skb
1223 * @skb: skb which can be encoded or used for decoding
1224 * @nc_path: pointer to path this nc packet is attached to
1226 struct batadv_nc_packet
{
1227 struct list_head list
;
1229 unsigned long timestamp
;
1230 struct batadv_neigh_node
*neigh_node
;
1231 struct sk_buff
*skb
;
1232 struct batadv_nc_path
*nc_path
;
1236 * struct batadv_skb_cb - control buffer structure used to store private data
1237 * relevant to batman-adv in the skb->cb buffer in skbs.
1238 * @decoded: Marks a skb as decoded, which is checked when searching for coding
1239 * opportunities in network-coding.c
1241 struct batadv_skb_cb
{
1246 * struct batadv_forw_packet - structure for bcast packets to be sent/forwarded
1247 * @list: list node for batadv_socket_client::queue_list
1248 * @send_time: execution time for delayed_work (packet sending)
1249 * @own: bool for locally generated packets (local OGMs are re-scheduled after
1251 * @skb: bcast packet's skb buffer
1252 * @packet_len: size of aggregated OGM packet inside the skb buffer
1253 * @direct_link_flags: direct link flags for aggregated OGM packets
1254 * @num_packets: counter for bcast packet retransmission
1255 * @delayed_work: work queue callback item for packet sending
1256 * @if_incoming: pointer to incoming hard-iface or primary iface if
1257 * locally generated packet
1258 * @if_outgoing: packet where the packet should be sent to, or NULL if
1261 struct batadv_forw_packet
{
1262 struct hlist_node list
;
1263 unsigned long send_time
;
1265 struct sk_buff
*skb
;
1267 u32 direct_link_flags
;
1269 struct delayed_work delayed_work
;
1270 struct batadv_hard_iface
*if_incoming
;
1271 struct batadv_hard_iface
*if_outgoing
;
1275 * struct batadv_algo_ops - mesh algorithm callbacks
1276 * @list: list node for the batadv_algo_list
1277 * @name: name of the algorithm
1278 * @bat_iface_activate: start routing mechanisms when hard-interface is brought
1280 * @bat_iface_enable: init routing info when hard-interface is enabled
1281 * @bat_iface_disable: de-init routing info when hard-interface is disabled
1282 * @bat_iface_update_mac: (re-)init mac addresses of the protocol information
1283 * belonging to this hard-interface
1284 * @bat_primary_iface_set: called when primary interface is selected / changed
1285 * @bat_hardif_neigh_init: called on creation of single hop entry
1286 * @bat_neigh_cmp: compare the metrics of two neighbors for their respective
1287 * outgoing interfaces
1288 * @bat_neigh_is_similar_or_better: check if neigh1 is equally similar or
1289 * better than neigh2 for their respective outgoing interface from the metric
1291 * @bat_neigh_print: print the single hop neighbor list (optional)
1292 * @bat_orig_print: print the originator table (optional)
1293 * @bat_orig_free: free the resources allocated by the routing algorithm for an
1295 * @bat_orig_add_if: ask the routing algorithm to apply the needed changes to
1296 * the orig_node due to a new hard-interface being added into the mesh
1297 * @bat_orig_del_if: ask the routing algorithm to apply the needed changes to
1298 * the orig_node due to an hard-interface being removed from the mesh
1300 struct batadv_algo_ops
{
1301 struct hlist_node list
;
1303 void (*bat_iface_activate
)(struct batadv_hard_iface
*hard_iface
);
1304 int (*bat_iface_enable
)(struct batadv_hard_iface
*hard_iface
);
1305 void (*bat_iface_disable
)(struct batadv_hard_iface
*hard_iface
);
1306 void (*bat_iface_update_mac
)(struct batadv_hard_iface
*hard_iface
);
1307 void (*bat_primary_iface_set
)(struct batadv_hard_iface
*hard_iface
);
1308 /* neigh_node handling API */
1309 void (*bat_hardif_neigh_init
)(struct batadv_hardif_neigh_node
*neigh
);
1310 int (*bat_neigh_cmp
)(struct batadv_neigh_node
*neigh1
,
1311 struct batadv_hard_iface
*if_outgoing1
,
1312 struct batadv_neigh_node
*neigh2
,
1313 struct batadv_hard_iface
*if_outgoing2
);
1314 bool (*bat_neigh_is_similar_or_better
)
1315 (struct batadv_neigh_node
*neigh1
,
1316 struct batadv_hard_iface
*if_outgoing1
,
1317 struct batadv_neigh_node
*neigh2
,
1318 struct batadv_hard_iface
*if_outgoing2
);
1319 void (*bat_neigh_print
)(struct batadv_priv
*priv
, struct seq_file
*seq
);
1320 /* orig_node handling API */
1321 void (*bat_orig_print
)(struct batadv_priv
*priv
, struct seq_file
*seq
,
1322 struct batadv_hard_iface
*hard_iface
);
1323 void (*bat_orig_free
)(struct batadv_orig_node
*orig_node
);
1324 int (*bat_orig_add_if
)(struct batadv_orig_node
*orig_node
,
1326 int (*bat_orig_del_if
)(struct batadv_orig_node
*orig_node
,
1327 int max_if_num
, int del_if_num
);
1331 * struct batadv_dat_entry - it is a single entry of batman-adv ARP backend. It
1332 * is used to stored ARP entries needed for the global DAT cache
1333 * @ip: the IPv4 corresponding to this DAT/ARP entry
1334 * @mac_addr: the MAC address associated to the stored IPv4
1335 * @vid: the vlan ID associated to this entry
1336 * @last_update: time in jiffies when this entry was refreshed last time
1337 * @hash_entry: hlist node for batadv_priv_dat::hash
1338 * @refcount: number of contexts the object is used
1339 * @rcu: struct used for freeing in an RCU-safe manner
1341 struct batadv_dat_entry
{
1343 u8 mac_addr
[ETH_ALEN
];
1345 unsigned long last_update
;
1346 struct hlist_node hash_entry
;
1347 struct kref refcount
;
1348 struct rcu_head rcu
;
1352 * struct batadv_hw_addr - a list entry for a MAC address
1353 * @list: list node for the linking of entries
1354 * @addr: the MAC address of this list entry
1356 struct batadv_hw_addr
{
1357 struct hlist_node list
;
1358 unsigned char addr
[ETH_ALEN
];
1362 * struct batadv_dat_candidate - candidate destination for DAT operations
1363 * @type: the type of the selected candidate. It can one of the following:
1364 * - BATADV_DAT_CANDIDATE_NOT_FOUND
1365 * - BATADV_DAT_CANDIDATE_ORIG
1366 * @orig_node: if type is BATADV_DAT_CANDIDATE_ORIG this field points to the
1367 * corresponding originator node structure
1369 struct batadv_dat_candidate
{
1371 struct batadv_orig_node
*orig_node
;
1375 * struct batadv_tvlv_container - container for tvlv appended to OGMs
1376 * @list: hlist node for batadv_priv_tvlv::container_list
1377 * @tvlv_hdr: tvlv header information needed to construct the tvlv
1378 * @refcount: number of contexts the object is used
1380 struct batadv_tvlv_container
{
1381 struct hlist_node list
;
1382 struct batadv_tvlv_hdr tvlv_hdr
;
1383 struct kref refcount
;
1387 * struct batadv_tvlv_handler - handler for specific tvlv type and version
1388 * @list: hlist node for batadv_priv_tvlv::handler_list
1389 * @ogm_handler: handler callback which is given the tvlv payload to process on
1390 * incoming OGM packets
1391 * @unicast_handler: handler callback which is given the tvlv payload to process
1392 * on incoming unicast tvlv packets
1393 * @type: tvlv type this handler feels responsible for
1394 * @version: tvlv version this handler feels responsible for
1395 * @flags: tvlv handler flags
1396 * @refcount: number of contexts the object is used
1397 * @rcu: struct used for freeing in an RCU-safe manner
1399 struct batadv_tvlv_handler
{
1400 struct hlist_node list
;
1401 void (*ogm_handler
)(struct batadv_priv
*bat_priv
,
1402 struct batadv_orig_node
*orig
,
1403 u8 flags
, void *tvlv_value
, u16 tvlv_value_len
);
1404 int (*unicast_handler
)(struct batadv_priv
*bat_priv
,
1406 void *tvlv_value
, u16 tvlv_value_len
);
1410 struct kref refcount
;
1411 struct rcu_head rcu
;
1415 * enum batadv_tvlv_handler_flags - tvlv handler flags definitions
1416 * @BATADV_TVLV_HANDLER_OGM_CIFNOTFND: tvlv ogm processing function will call
1417 * this handler even if its type was not found (with no data)
1418 * @BATADV_TVLV_HANDLER_OGM_CALLED: interval tvlv handling flag - the API marks
1419 * a handler as being called, so it won't be called if the
1420 * BATADV_TVLV_HANDLER_OGM_CIFNOTFND flag was set
1422 enum batadv_tvlv_handler_flags
{
1423 BATADV_TVLV_HANDLER_OGM_CIFNOTFND
= BIT(1),
1424 BATADV_TVLV_HANDLER_OGM_CALLED
= BIT(2),
1427 #endif /* _NET_BATMAN_ADV_TYPES_H_ */