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/mutex.h>
31 #include <linux/netdevice.h>
32 #include <linux/netlink.h>
33 #include <linux/sched.h> /* for linux/wait.h */
34 #include <linux/spinlock.h>
35 #include <linux/types.h>
36 #include <linux/wait.h>
37 #include <linux/workqueue.h>
38 #include <uapi/linux/batman_adv.h>
44 #ifdef CONFIG_BATMAN_ADV_DAT
47 * batadv_dat_addr_t - it is the type used for all DHT addresses. If it is
48 * changed, BATADV_DAT_ADDR_MAX is changed as well.
50 * *Please be careful: batadv_dat_addr_t must be UNSIGNED*
52 #define batadv_dat_addr_t u16
54 #endif /* CONFIG_BATMAN_ADV_DAT */
57 * enum batadv_dhcp_recipient - dhcp destination
58 * @BATADV_DHCP_NO: packet is not a dhcp message
59 * @BATADV_DHCP_TO_SERVER: dhcp message is directed to a server
60 * @BATADV_DHCP_TO_CLIENT: dhcp message is directed to a client
62 enum batadv_dhcp_recipient {
64 BATADV_DHCP_TO_SERVER,
65 BATADV_DHCP_TO_CLIENT,
69 * BATADV_TT_REMOTE_MASK - bitmask selecting the flags that are sent over the
72 #define BATADV_TT_REMOTE_MASK 0x00FF
75 * BATADV_TT_SYNC_MASK - bitmask of the flags that need to be kept in sync
76 * among the nodes. These flags are used to compute the global/local CRC
78 #define BATADV_TT_SYNC_MASK 0x00F0
81 * struct batadv_hard_iface_bat_iv - per hard-interface B.A.T.M.A.N. IV data
82 * @ogm_buff: buffer holding the OGM packet
83 * @ogm_buff_len: length of the OGM packet buffer
84 * @ogm_seqno: OGM sequence number - used to identify each OGM
85 * @ogm_buff_mutex: lock protecting ogm_buff and ogm_buff_len
87 struct batadv_hard_iface_bat_iv {
88 unsigned char *ogm_buff;
91 struct mutex ogm_buff_mutex;
95 * enum batadv_v_hard_iface_flags - interface flags useful to B.A.T.M.A.N. V
96 * @BATADV_FULL_DUPLEX: tells if the connection over this link is full-duplex
97 * @BATADV_WARNING_DEFAULT: tells whether we have warned the user that no
98 * throughput data is available for this interface and that default values are
101 enum batadv_v_hard_iface_flags {
102 BATADV_FULL_DUPLEX = BIT(0),
103 BATADV_WARNING_DEFAULT = BIT(1),
107 * struct batadv_hard_iface_bat_v - per hard-interface B.A.T.M.A.N. V data
108 * @elp_interval: time interval between two ELP transmissions
109 * @elp_seqno: current ELP sequence number
110 * @elp_skb: base skb containing the ELP message to send
111 * @elp_wq: workqueue used to schedule ELP transmissions
112 * @throughput_override: throughput override to disable link auto-detection
113 * @flags: interface specific flags
115 struct batadv_hard_iface_bat_v {
116 atomic_t elp_interval;
118 struct sk_buff *elp_skb;
119 struct delayed_work elp_wq;
120 atomic_t throughput_override;
125 * struct batadv_hard_iface - network device known to batman-adv
126 * @list: list node for batadv_hardif_list
127 * @if_num: identificator of the interface
128 * @if_status: status of the interface for batman-adv
129 * @net_dev: pointer to the net_device
130 * @num_bcasts: number of payload re-broadcasts on this interface (ARQ)
131 * @hardif_obj: kobject of the per interface sysfs "mesh" directory
132 * @refcount: number of contexts the object is used
133 * @batman_adv_ptype: packet type describing packets that should be processed by
134 * batman-adv for this interface
135 * @soft_iface: the batman-adv interface which uses this network interface
136 * @rcu: struct used for freeing in an RCU-safe manner
137 * @bat_iv: per hard-interface B.A.T.M.A.N. IV data
138 * @bat_v: per hard-interface B.A.T.M.A.N. V data
139 * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
140 * @neigh_list: list of unique single hop neighbors via this interface
141 * @neigh_list_lock: lock protecting neigh_list
143 struct batadv_hard_iface {
144 struct list_head list;
147 struct net_device *net_dev;
149 struct kobject *hardif_obj;
150 struct kref refcount;
151 struct packet_type batman_adv_ptype;
152 struct net_device *soft_iface;
154 struct batadv_hard_iface_bat_iv bat_iv;
155 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
156 struct batadv_hard_iface_bat_v bat_v;
158 struct dentry *debug_dir;
159 struct hlist_head neigh_list;
160 /* neigh_list_lock protects: neigh_list */
161 spinlock_t neigh_list_lock;
165 * struct batadv_orig_ifinfo - originator info per outgoing interface
166 * @list: list node for orig_node::ifinfo_list
167 * @if_outgoing: pointer to outgoing hard-interface
168 * @router: router that should be used to reach this originator
169 * @last_real_seqno: last and best known sequence number
170 * @last_ttl: ttl of last received packet
171 * @last_seqno_forwarded: seqno of the OGM which was forwarded last
172 * @batman_seqno_reset: time when the batman seqno window was reset
173 * @refcount: number of contexts the object is used
174 * @rcu: struct used for freeing in an RCU-safe manner
176 struct batadv_orig_ifinfo {
177 struct hlist_node list;
178 struct batadv_hard_iface *if_outgoing;
179 struct batadv_neigh_node __rcu *router; /* rcu protected pointer */
182 u32 last_seqno_forwarded;
183 unsigned long batman_seqno_reset;
184 struct kref refcount;
189 * struct batadv_frag_table_entry - head in the fragment buffer table
190 * @head: head of list with fragments
191 * @lock: lock to protect the list of fragments
192 * @timestamp: time (jiffie) of last received fragment
193 * @seqno: sequence number of the fragments in the list
194 * @size: accumulated size of packets in list
195 * @total_size: expected size of the assembled packet
197 struct batadv_frag_table_entry {
198 struct hlist_head head;
199 spinlock_t lock; /* protects head */
200 unsigned long timestamp;
207 * struct batadv_frag_list_entry - entry in a list of fragments
208 * @list: list node information
210 * @no: fragment number in the set
212 struct batadv_frag_list_entry {
213 struct hlist_node list;
219 * struct batadv_vlan_tt - VLAN specific TT attributes
220 * @crc: CRC32 checksum of the entries belonging to this vlan
221 * @num_entries: number of TT entries for this VLAN
223 struct batadv_vlan_tt {
225 atomic_t num_entries;
229 * struct batadv_orig_node_vlan - VLAN specific data per orig_node
230 * @vid: the VLAN identifier
231 * @tt: VLAN specific TT attributes
232 * @list: list node for orig_node::vlan_list
233 * @refcount: number of context where this object is currently in use
234 * @rcu: struct used for freeing in a RCU-safe manner
236 struct batadv_orig_node_vlan {
238 struct batadv_vlan_tt tt;
239 struct hlist_node list;
240 struct kref refcount;
245 * struct batadv_orig_bat_iv - B.A.T.M.A.N. IV private orig_node members
246 * @bcast_own: set of bitfields (one per hard-interface) where each one counts
247 * the number of our OGMs this orig_node rebroadcasted "back" to us (relative
248 * to last_real_seqno). Every bitfield is BATADV_TQ_LOCAL_WINDOW_SIZE bits long.
249 * @bcast_own_sum: sum of bcast_own
250 * @ogm_cnt_lock: lock protecting bcast_own, bcast_own_sum,
251 * neigh_node->bat_iv.real_bits & neigh_node->bat_iv.real_packet_count
253 struct batadv_orig_bat_iv {
254 unsigned long *bcast_own;
256 /* ogm_cnt_lock protects: bcast_own, bcast_own_sum,
257 * neigh_node->bat_iv.real_bits & neigh_node->bat_iv.real_packet_count
259 spinlock_t ogm_cnt_lock;
263 * struct batadv_orig_node - structure for orig_list maintaining nodes of mesh
264 * @orig: originator ethernet address
265 * @ifinfo_list: list for routers per outgoing interface
266 * @last_bonding_candidate: pointer to last ifinfo of last used router
267 * @dat_addr: address of the orig node in the distributed hash
268 * @last_seen: time when last packet from this node was received
269 * @bcast_seqno_reset: time when the broadcast seqno window was reset
270 * @mcast_handler_lock: synchronizes mcast-capability and -flag changes
271 * @mcast_flags: multicast flags announced by the orig node
272 * @mcast_want_all_unsnoopables_node: a list node for the
273 * mcast.want_all_unsnoopables list
274 * @mcast_want_all_ipv4_node: a list node for the mcast.want_all_ipv4 list
275 * @mcast_want_all_ipv6_node: a list node for the mcast.want_all_ipv6 list
276 * @capabilities: announced capabilities of this originator
277 * @capa_initialized: bitfield to remember whether a capability was initialized
278 * @last_ttvn: last seen translation table version number
279 * @tt_buff: last tt changeset this node received from the orig node
280 * @tt_buff_len: length of the last tt changeset this node received from the
282 * @tt_buff_lock: lock that protects tt_buff and tt_buff_len
283 * @tt_lock: prevents from updating the table while reading it. Table update is
284 * made up by two operations (data structure update and metdata -CRC/TTVN-
285 * recalculation) and they have to be executed atomically in order to avoid
286 * another thread to read the table/metadata between those.
287 * @bcast_bits: bitfield containing the info which payload broadcast originated
288 * from this orig node this host already has seen (relative to
290 * @last_bcast_seqno: last broadcast sequence number received by this host
291 * @neigh_list: list of potential next hop neighbor towards this orig node
292 * @neigh_list_lock: lock protecting neigh_list and router
293 * @hash_entry: hlist node for batadv_priv::orig_hash
294 * @bat_priv: pointer to soft_iface this orig node belongs to
295 * @bcast_seqno_lock: lock protecting bcast_bits & last_bcast_seqno
296 * @refcount: number of contexts the object is used
297 * @rcu: struct used for freeing in an RCU-safe manner
298 * @in_coding_list: list of nodes this orig can hear
299 * @out_coding_list: list of nodes that can hear this orig
300 * @in_coding_list_lock: protects in_coding_list
301 * @out_coding_list_lock: protects out_coding_list
302 * @fragments: array with heads for fragment chains
303 * @vlan_list: a list of orig_node_vlan structs, one per VLAN served by the
304 * originator represented by this object
305 * @vlan_list_lock: lock protecting vlan_list
306 * @bat_iv: B.A.T.M.A.N. IV private structure
308 struct batadv_orig_node {
310 struct hlist_head ifinfo_list;
311 struct batadv_orig_ifinfo *last_bonding_candidate;
312 #ifdef CONFIG_BATMAN_ADV_DAT
313 batadv_dat_addr_t dat_addr;
315 unsigned long last_seen;
316 unsigned long bcast_seqno_reset;
317 #ifdef CONFIG_BATMAN_ADV_MCAST
318 /* synchronizes mcast tvlv specific orig changes */
319 spinlock_t mcast_handler_lock;
321 struct hlist_node mcast_want_all_unsnoopables_node;
322 struct hlist_node mcast_want_all_ipv4_node;
323 struct hlist_node mcast_want_all_ipv6_node;
325 unsigned long capabilities;
326 unsigned long capa_initialized;
328 unsigned char *tt_buff;
330 spinlock_t tt_buff_lock; /* protects tt_buff & tt_buff_len */
331 /* prevents from changing the table while reading it */
333 DECLARE_BITMAP(bcast_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
334 u32 last_bcast_seqno;
335 struct hlist_head neigh_list;
336 /* neigh_list_lock protects: neigh_list, ifinfo_list,
337 * last_bonding_candidate and router
339 spinlock_t neigh_list_lock;
340 struct hlist_node hash_entry;
341 struct batadv_priv *bat_priv;
342 /* bcast_seqno_lock protects: bcast_bits & last_bcast_seqno */
343 spinlock_t bcast_seqno_lock;
344 struct kref refcount;
346 #ifdef CONFIG_BATMAN_ADV_NC
347 struct list_head in_coding_list;
348 struct list_head out_coding_list;
349 spinlock_t in_coding_list_lock; /* Protects in_coding_list */
350 spinlock_t out_coding_list_lock; /* Protects out_coding_list */
352 struct batadv_frag_table_entry fragments[BATADV_FRAG_BUFFER_COUNT];
353 struct hlist_head vlan_list;
354 spinlock_t vlan_list_lock; /* protects vlan_list */
355 struct batadv_orig_bat_iv bat_iv;
359 * enum batadv_orig_capabilities - orig node capabilities
360 * @BATADV_ORIG_CAPA_HAS_DAT: orig node has distributed arp table enabled
361 * @BATADV_ORIG_CAPA_HAS_NC: orig node has network coding enabled
362 * @BATADV_ORIG_CAPA_HAS_TT: orig node has tt capability
363 * @BATADV_ORIG_CAPA_HAS_MCAST: orig node has some multicast capability
364 * (= orig node announces a tvlv of type BATADV_TVLV_MCAST)
366 enum batadv_orig_capabilities {
367 BATADV_ORIG_CAPA_HAS_DAT,
368 BATADV_ORIG_CAPA_HAS_NC,
369 BATADV_ORIG_CAPA_HAS_TT,
370 BATADV_ORIG_CAPA_HAS_MCAST,
374 * struct batadv_gw_node - structure for orig nodes announcing gw capabilities
375 * @list: list node for batadv_priv_gw::list
376 * @orig_node: pointer to corresponding orig node
377 * @bandwidth_down: advertised uplink download bandwidth
378 * @bandwidth_up: advertised uplink upload bandwidth
379 * @refcount: number of contexts the object is used
380 * @rcu: struct used for freeing in an RCU-safe manner
382 struct batadv_gw_node {
383 struct hlist_node list;
384 struct batadv_orig_node *orig_node;
387 struct kref refcount;
391 DECLARE_EWMA(throughput, 1024, 8)
394 * struct batadv_hardif_neigh_node_bat_v - B.A.T.M.A.N. V private neighbor
396 * @throughput: ewma link throughput towards this neighbor
397 * @elp_interval: time interval between two ELP transmissions
398 * @elp_latest_seqno: latest and best known ELP sequence number
399 * @last_unicast_tx: when the last unicast packet has been sent to this neighbor
400 * @metric_work: work queue callback item for metric update
402 struct batadv_hardif_neigh_node_bat_v {
403 struct ewma_throughput throughput;
405 u32 elp_latest_seqno;
406 unsigned long last_unicast_tx;
407 struct work_struct metric_work;
411 * struct batadv_hardif_neigh_node - unique neighbor per hard-interface
412 * @list: list node for batadv_hard_iface::neigh_list
413 * @addr: the MAC address of the neighboring interface
414 * @if_incoming: pointer to incoming hard-interface
415 * @last_seen: when last packet via this neighbor was received
416 * @bat_v: B.A.T.M.A.N. V private data
417 * @refcount: number of contexts the object is used
418 * @rcu: struct used for freeing in a RCU-safe manner
420 struct batadv_hardif_neigh_node {
421 struct hlist_node list;
423 struct batadv_hard_iface *if_incoming;
424 unsigned long last_seen;
425 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
426 struct batadv_hardif_neigh_node_bat_v bat_v;
428 struct kref refcount;
433 * struct batadv_neigh_node - structure for single hops neighbors
434 * @list: list node for batadv_orig_node::neigh_list
435 * @orig_node: pointer to corresponding orig_node
436 * @addr: the MAC address of the neighboring interface
437 * @ifinfo_list: list for routing metrics per outgoing interface
438 * @ifinfo_lock: lock protecting private ifinfo members and list
439 * @if_incoming: pointer to incoming hard-interface
440 * @last_seen: when last packet via this neighbor was received
441 * @hardif_neigh: hardif_neigh of this neighbor
442 * @refcount: number of contexts the object is used
443 * @rcu: struct used for freeing in an RCU-safe manner
445 struct batadv_neigh_node {
446 struct hlist_node list;
447 struct batadv_orig_node *orig_node;
449 struct hlist_head ifinfo_list;
450 spinlock_t ifinfo_lock; /* protects ifinfo_list and its members */
451 struct batadv_hard_iface *if_incoming;
452 unsigned long last_seen;
453 struct batadv_hardif_neigh_node *hardif_neigh;
454 struct kref refcount;
459 * struct batadv_neigh_ifinfo_bat_iv - neighbor information per outgoing
460 * interface for B.A.T.M.A.N. IV
461 * @tq_recv: ring buffer of received TQ values from this neigh node
462 * @tq_index: ring buffer index
463 * @tq_avg: averaged tq of all tq values in the ring buffer (tq_recv)
464 * @real_bits: bitfield containing the number of OGMs received from this neigh
465 * node (relative to orig_node->last_real_seqno)
466 * @real_packet_count: counted result of real_bits
468 struct batadv_neigh_ifinfo_bat_iv {
469 u8 tq_recv[BATADV_TQ_GLOBAL_WINDOW_SIZE];
472 DECLARE_BITMAP(real_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
473 u8 real_packet_count;
477 * struct batadv_neigh_ifinfo_bat_v - neighbor information per outgoing
478 * interface for B.A.T.M.A.N. V
479 * @throughput: last throughput metric received from originator via this neigh
480 * @last_seqno: last sequence number known for this neighbor
482 struct batadv_neigh_ifinfo_bat_v {
488 * struct batadv_neigh_ifinfo - neighbor information per outgoing interface
489 * @list: list node for batadv_neigh_node::ifinfo_list
490 * @if_outgoing: pointer to outgoing hard-interface
491 * @bat_iv: B.A.T.M.A.N. IV private structure
492 * @bat_v: B.A.T.M.A.N. V private data
493 * @last_ttl: last received ttl from this neigh node
494 * @refcount: number of contexts the object is used
495 * @rcu: struct used for freeing in a RCU-safe manner
497 struct batadv_neigh_ifinfo {
498 struct hlist_node list;
499 struct batadv_hard_iface *if_outgoing;
500 struct batadv_neigh_ifinfo_bat_iv bat_iv;
501 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
502 struct batadv_neigh_ifinfo_bat_v bat_v;
505 struct kref refcount;
509 #ifdef CONFIG_BATMAN_ADV_BLA
512 * struct batadv_bcast_duplist_entry - structure for LAN broadcast suppression
513 * @orig: mac address of orig node orginating the broadcast
514 * @crc: crc32 checksum of broadcast payload
515 * @entrytime: time when the broadcast packet was received
517 struct batadv_bcast_duplist_entry {
520 unsigned long entrytime;
525 * enum batadv_counters - indices for traffic counters
526 * @BATADV_CNT_TX: transmitted payload traffic packet counter
527 * @BATADV_CNT_TX_BYTES: transmitted payload traffic bytes counter
528 * @BATADV_CNT_TX_DROPPED: dropped transmission payload traffic packet counter
529 * @BATADV_CNT_RX: received payload traffic packet counter
530 * @BATADV_CNT_RX_BYTES: received payload traffic bytes counter
531 * @BATADV_CNT_FORWARD: forwarded payload traffic packet counter
532 * @BATADV_CNT_FORWARD_BYTES: forwarded payload traffic bytes counter
533 * @BATADV_CNT_MGMT_TX: transmitted routing protocol traffic packet counter
534 * @BATADV_CNT_MGMT_TX_BYTES: transmitted routing protocol traffic bytes counter
535 * @BATADV_CNT_MGMT_RX: received routing protocol traffic packet counter
536 * @BATADV_CNT_MGMT_RX_BYTES: received routing protocol traffic bytes counter
537 * @BATADV_CNT_FRAG_TX: transmitted fragment traffic packet counter
538 * @BATADV_CNT_FRAG_TX_BYTES: transmitted fragment traffic bytes counter
539 * @BATADV_CNT_FRAG_RX: received fragment traffic packet counter
540 * @BATADV_CNT_FRAG_RX_BYTES: received fragment traffic bytes counter
541 * @BATADV_CNT_FRAG_FWD: forwarded fragment traffic packet counter
542 * @BATADV_CNT_FRAG_FWD_BYTES: forwarded fragment traffic bytes counter
543 * @BATADV_CNT_TT_REQUEST_TX: transmitted tt req traffic packet counter
544 * @BATADV_CNT_TT_REQUEST_RX: received tt req traffic packet counter
545 * @BATADV_CNT_TT_RESPONSE_TX: transmitted tt resp traffic packet counter
546 * @BATADV_CNT_TT_RESPONSE_RX: received tt resp traffic packet counter
547 * @BATADV_CNT_TT_ROAM_ADV_TX: transmitted tt roam traffic packet counter
548 * @BATADV_CNT_TT_ROAM_ADV_RX: received tt roam traffic packet counter
549 * @BATADV_CNT_DAT_GET_TX: transmitted dht GET traffic packet counter
550 * @BATADV_CNT_DAT_GET_RX: received dht GET traffic packet counter
551 * @BATADV_CNT_DAT_PUT_TX: transmitted dht PUT traffic packet counter
552 * @BATADV_CNT_DAT_PUT_RX: received dht PUT traffic packet counter
553 * @BATADV_CNT_DAT_CACHED_REPLY_TX: transmitted dat cache reply traffic packet
555 * @BATADV_CNT_NC_CODE: transmitted nc-combined traffic packet counter
556 * @BATADV_CNT_NC_CODE_BYTES: transmitted nc-combined traffic bytes counter
557 * @BATADV_CNT_NC_RECODE: transmitted nc-recombined traffic packet counter
558 * @BATADV_CNT_NC_RECODE_BYTES: transmitted nc-recombined traffic bytes counter
559 * @BATADV_CNT_NC_BUFFER: counter for packets buffered for later nc decoding
560 * @BATADV_CNT_NC_DECODE: received and nc-decoded traffic packet counter
561 * @BATADV_CNT_NC_DECODE_BYTES: received and nc-decoded traffic bytes counter
562 * @BATADV_CNT_NC_DECODE_FAILED: received and decode-failed traffic packet
564 * @BATADV_CNT_NC_SNIFFED: counter for nc-decoded packets received in promisc
566 * @BATADV_CNT_NUM: number of traffic counters
568 enum batadv_counters {
571 BATADV_CNT_TX_DROPPED,
575 BATADV_CNT_FORWARD_BYTES,
577 BATADV_CNT_MGMT_TX_BYTES,
579 BATADV_CNT_MGMT_RX_BYTES,
581 BATADV_CNT_FRAG_TX_BYTES,
583 BATADV_CNT_FRAG_RX_BYTES,
585 BATADV_CNT_FRAG_FWD_BYTES,
586 BATADV_CNT_TT_REQUEST_TX,
587 BATADV_CNT_TT_REQUEST_RX,
588 BATADV_CNT_TT_RESPONSE_TX,
589 BATADV_CNT_TT_RESPONSE_RX,
590 BATADV_CNT_TT_ROAM_ADV_TX,
591 BATADV_CNT_TT_ROAM_ADV_RX,
592 #ifdef CONFIG_BATMAN_ADV_DAT
593 BATADV_CNT_DAT_GET_TX,
594 BATADV_CNT_DAT_GET_RX,
595 BATADV_CNT_DAT_PUT_TX,
596 BATADV_CNT_DAT_PUT_RX,
597 BATADV_CNT_DAT_CACHED_REPLY_TX,
599 #ifdef CONFIG_BATMAN_ADV_NC
601 BATADV_CNT_NC_CODE_BYTES,
602 BATADV_CNT_NC_RECODE,
603 BATADV_CNT_NC_RECODE_BYTES,
604 BATADV_CNT_NC_BUFFER,
605 BATADV_CNT_NC_DECODE,
606 BATADV_CNT_NC_DECODE_BYTES,
607 BATADV_CNT_NC_DECODE_FAILED,
608 BATADV_CNT_NC_SNIFFED,
614 * struct batadv_priv_tt - per mesh interface translation table data
615 * @vn: translation table version number
616 * @ogm_append_cnt: counter of number of OGMs containing the local tt diff
617 * @local_changes: changes registered in an originator interval
618 * @changes_list: tracks tt local changes within an originator interval
619 * @local_hash: local translation table hash table
620 * @global_hash: global translation table hash table
621 * @req_list: list of pending & unanswered tt_requests
622 * @roam_list: list of the last roaming events of each client limiting the
623 * number of roaming events to avoid route flapping
624 * @changes_list_lock: lock protecting changes_list
625 * @req_list_lock: lock protecting req_list
626 * @roam_list_lock: lock protecting roam_list
627 * @last_changeset: last tt changeset this host has generated
628 * @last_changeset_len: length of last tt changeset this host has generated
629 * @last_changeset_lock: lock protecting last_changeset & last_changeset_len
630 * @commit_lock: prevents from executing a local TT commit while reading the
631 * local table. The local TT commit is made up by two operations (data
632 * structure update and metdata -CRC/TTVN- recalculation) and they have to be
633 * executed atomically in order to avoid another thread to read the
634 * table/metadata between those.
635 * @work: work queue callback item for translation table purging
637 struct batadv_priv_tt {
639 atomic_t ogm_append_cnt;
640 atomic_t local_changes;
641 struct list_head changes_list;
642 struct batadv_hashtable *local_hash;
643 struct batadv_hashtable *global_hash;
644 struct hlist_head req_list;
645 struct list_head roam_list;
646 spinlock_t changes_list_lock; /* protects changes */
647 spinlock_t req_list_lock; /* protects req_list */
648 spinlock_t roam_list_lock; /* protects roam_list */
649 unsigned char *last_changeset;
650 s16 last_changeset_len;
651 /* protects last_changeset & last_changeset_len */
652 spinlock_t last_changeset_lock;
653 /* prevents from executing a commit while reading the table */
654 spinlock_t commit_lock;
655 struct delayed_work work;
658 #ifdef CONFIG_BATMAN_ADV_BLA
661 * struct batadv_priv_bla - per mesh interface bridge loope avoidance data
662 * @num_requests: number of bla requests in flight
663 * @claim_hash: hash table containing mesh nodes this host has claimed
664 * @backbone_hash: hash table containing all detected backbone gateways
665 * @loopdetect_addr: MAC address used for own loopdetection frames
666 * @loopdetect_lasttime: time when the loopdetection frames were sent
667 * @loopdetect_next: how many periods to wait for the next loopdetect process
668 * @bcast_duplist: recently received broadcast packets array (for broadcast
669 * duplicate suppression)
670 * @bcast_duplist_curr: index of last broadcast packet added to bcast_duplist
671 * @bcast_duplist_lock: lock protecting bcast_duplist & bcast_duplist_curr
672 * @claim_dest: local claim data (e.g. claim group)
673 * @work: work queue callback item for cleanups & bla announcements
675 struct batadv_priv_bla {
676 atomic_t num_requests;
677 struct batadv_hashtable *claim_hash;
678 struct batadv_hashtable *backbone_hash;
679 u8 loopdetect_addr[ETH_ALEN];
680 unsigned long loopdetect_lasttime;
681 atomic_t loopdetect_next;
682 struct batadv_bcast_duplist_entry bcast_duplist[BATADV_DUPLIST_SIZE];
683 int bcast_duplist_curr;
684 /* protects bcast_duplist & bcast_duplist_curr */
685 spinlock_t bcast_duplist_lock;
686 struct batadv_bla_claim_dst claim_dest;
687 struct delayed_work work;
691 #ifdef CONFIG_BATMAN_ADV_DEBUG
694 * struct batadv_priv_debug_log - debug logging data
695 * @log_buff: buffer holding the logs (ring bufer)
696 * @log_start: index of next character to read
697 * @log_end: index of next character to write
698 * @lock: lock protecting log_buff, log_start & log_end
699 * @queue_wait: log reader's wait queue
701 struct batadv_priv_debug_log {
702 char log_buff[BATADV_LOG_BUF_LEN];
703 unsigned long log_start;
704 unsigned long log_end;
705 spinlock_t lock; /* protects log_buff, log_start and log_end */
706 wait_queue_head_t queue_wait;
711 * struct batadv_priv_gw - per mesh interface gateway data
712 * @list: list of available gateway nodes
713 * @list_lock: lock protecting gw_list & curr_gw
714 * @curr_gw: pointer to currently selected gateway node
715 * @mode: gateway operation: off, client or server (see batadv_gw_modes)
716 * @sel_class: gateway selection class (applies if gw_mode client)
717 * @bandwidth_down: advertised uplink download bandwidth (if gw_mode server)
718 * @bandwidth_up: advertised uplink upload bandwidth (if gw_mode server)
719 * @reselect: bool indicating a gateway re-selection is in progress
721 struct batadv_priv_gw {
722 struct hlist_head list;
723 spinlock_t list_lock; /* protects gw_list & curr_gw */
724 struct batadv_gw_node __rcu *curr_gw; /* rcu protected pointer */
727 atomic_t bandwidth_down;
728 atomic_t bandwidth_up;
733 * struct batadv_priv_tvlv - per mesh interface tvlv data
734 * @container_list: list of registered tvlv containers to be sent with each OGM
735 * @handler_list: list of the various tvlv content handlers
736 * @container_list_lock: protects tvlv container list access
737 * @handler_list_lock: protects handler list access
739 struct batadv_priv_tvlv {
740 struct hlist_head container_list;
741 struct hlist_head handler_list;
742 spinlock_t container_list_lock; /* protects container_list */
743 spinlock_t handler_list_lock; /* protects handler_list */
746 #ifdef CONFIG_BATMAN_ADV_DAT
749 * struct batadv_priv_dat - per mesh interface DAT private data
750 * @addr: node DAT address
751 * @hash: hashtable representing the local ARP cache
752 * @work: work queue callback item for cache purging
754 struct batadv_priv_dat {
755 batadv_dat_addr_t addr;
756 struct batadv_hashtable *hash;
757 struct delayed_work work;
761 #ifdef CONFIG_BATMAN_ADV_MCAST
763 * struct batadv_mcast_querier_state - IGMP/MLD querier state when bridged
764 * @exists: whether a querier exists in the mesh
765 * @shadowing: if a querier exists, whether it is potentially shadowing
766 * multicast listeners (i.e. querier is behind our own bridge segment)
768 struct batadv_mcast_querier_state {
774 * struct batadv_priv_mcast - per mesh interface mcast data
775 * @mla_list: list of multicast addresses we are currently announcing via TT
776 * @want_all_unsnoopables_list: a list of orig_nodes wanting all unsnoopable
778 * @want_all_ipv4_list: a list of orig_nodes wanting all IPv4 multicast traffic
779 * @want_all_ipv6_list: a list of orig_nodes wanting all IPv6 multicast traffic
780 * @querier_ipv4: the current state of an IGMP querier in the mesh
781 * @querier_ipv6: the current state of an MLD querier in the mesh
782 * @flags: the flags we have last sent in our mcast tvlv
783 * @enabled: whether the multicast tvlv is currently enabled
784 * @bridged: whether the soft interface has a bridge on top
785 * @num_disabled: number of nodes that have no mcast tvlv
786 * @num_want_all_unsnoopables: number of nodes wanting unsnoopable IP traffic
787 * @num_want_all_ipv4: counter for items in want_all_ipv4_list
788 * @num_want_all_ipv6: counter for items in want_all_ipv6_list
789 * @want_lists_lock: lock for protecting modifications to mcast want lists
790 * (traversals are rcu-locked)
792 struct batadv_priv_mcast {
793 struct hlist_head mla_list;
794 struct hlist_head want_all_unsnoopables_list;
795 struct hlist_head want_all_ipv4_list;
796 struct hlist_head want_all_ipv6_list;
797 struct batadv_mcast_querier_state querier_ipv4;
798 struct batadv_mcast_querier_state querier_ipv6;
802 atomic_t num_disabled;
803 atomic_t num_want_all_unsnoopables;
804 atomic_t num_want_all_ipv4;
805 atomic_t num_want_all_ipv6;
806 /* protects want_all_{unsnoopables,ipv4,ipv6}_list */
807 spinlock_t want_lists_lock;
812 * struct batadv_priv_nc - per mesh interface network coding private data
813 * @work: work queue callback item for cleanup
814 * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
815 * @min_tq: only consider neighbors for encoding if neigh_tq > min_tq
816 * @max_fwd_delay: maximum packet forward delay to allow coding of packets
817 * @max_buffer_time: buffer time for sniffed packets used to decoding
818 * @timestamp_fwd_flush: timestamp of last forward packet queue flush
819 * @timestamp_sniffed_purge: timestamp of last sniffed packet queue purge
820 * @coding_hash: Hash table used to buffer skbs while waiting for another
821 * incoming skb to code it with. Skbs are added to the buffer just before being
822 * forwarded in routing.c
823 * @decoding_hash: Hash table used to buffer skbs that might be needed to decode
824 * a received coded skb. The buffer is used for 1) skbs arriving on the
825 * soft-interface; 2) skbs overheard on the hard-interface; and 3) skbs
826 * forwarded by batman-adv.
828 struct batadv_priv_nc {
829 struct delayed_work work;
830 struct dentry *debug_dir;
834 unsigned long timestamp_fwd_flush;
835 unsigned long timestamp_sniffed_purge;
836 struct batadv_hashtable *coding_hash;
837 struct batadv_hashtable *decoding_hash;
841 * struct batadv_tp_unacked - unacked packet meta-information
842 * @seqno: seqno of the unacked packet
843 * @len: length of the packet
844 * @list: list node for batadv_tp_vars::unacked_list
846 * This struct is supposed to represent a buffer unacked packet. However, since
847 * the purpose of the TP meter is to count the traffic only, there is no need to
848 * store the entire sk_buff, the starting offset and the length are enough
850 struct batadv_tp_unacked {
853 struct list_head list;
857 * enum batadv_tp_meter_role - Modus in tp meter session
858 * @BATADV_TP_RECEIVER: Initialized as receiver
859 * @BATADV_TP_SENDER: Initialized as sender
861 enum batadv_tp_meter_role {
867 * struct batadv_tp_vars - tp meter private variables per session
868 * @list: list node for bat_priv::tp_list
869 * @timer: timer for ack (receiver) and retry (sender)
870 * @bat_priv: pointer to the mesh object
871 * @start_time: start time in jiffies
872 * @other_end: mac address of remote
873 * @role: receiver/sender modi
874 * @sending: sending binary semaphore: 1 if sending, 0 is not
875 * @reason: reason for a stopped session
876 * @finish_work: work item for the finishing procedure
877 * @test_length: test length in milliseconds
878 * @session: TP session identifier
879 * @icmp_uid: local ICMP "socket" index
880 * @dec_cwnd: decimal part of the cwnd used during linear growth
881 * @cwnd: current size of the congestion window
882 * @cwnd_lock: lock do protect @cwnd & @dec_cwnd
883 * @ss_threshold: Slow Start threshold. Once cwnd exceeds this value the
884 * connection switches to the Congestion Avoidance state
885 * @last_acked: last acked byte
886 * @last_sent: last sent byte, not yet acked
887 * @tot_sent: amount of data sent/ACKed so far
888 * @dup_acks: duplicate ACKs counter
889 * @fast_recovery: true if in Fast Recovery mode
890 * @recover: last sent seqno when entering Fast Recovery
891 * @rto: sender timeout
892 * @srtt: smoothed RTT scaled by 2^3
893 * @rttvar: RTT variation scaled by 2^2
894 * @more_bytes: waiting queue anchor when waiting for more ack/retry timeout
895 * @prerandom_offset: offset inside the prerandom buffer
896 * @prerandom_lock: spinlock protecting access to prerandom_offset
897 * @last_recv: last in-order received packet
898 * @unacked_list: list of unacked packets (meta-info only)
899 * @unacked_lock: protect unacked_list
900 * @last_recv_time: time time (jiffies) a msg was received
901 * @refcount: number of context where the object is used
902 * @rcu: struct used for freeing in an RCU-safe manner
904 struct batadv_tp_vars {
905 struct hlist_node list;
906 struct timer_list timer;
907 struct batadv_priv *bat_priv;
908 unsigned long start_time;
909 u8 other_end[ETH_ALEN];
910 enum batadv_tp_meter_role role;
912 enum batadv_tp_meter_reason reason;
913 struct delayed_work finish_work;
918 /* sender variables */
921 spinlock_t cwnd_lock; /* Protects cwnd & dec_cwnd */
932 wait_queue_head_t more_bytes;
933 u32 prerandom_offset;
934 spinlock_t prerandom_lock; /* Protects prerandom_offset */
936 /* receiver variables */
938 struct list_head unacked_list;
939 spinlock_t unacked_lock; /* Protects unacked_list */
940 unsigned long last_recv_time;
941 struct kref refcount;
946 * struct batadv_softif_vlan - per VLAN attributes set
947 * @bat_priv: pointer to the mesh object
948 * @vid: VLAN identifier
949 * @kobj: kobject for sysfs vlan subdirectory
950 * @ap_isolation: AP isolation state
951 * @tt: TT private attributes (VLAN specific)
952 * @list: list node for bat_priv::softif_vlan_list
953 * @refcount: number of context where this object is currently in use
954 * @rcu: struct used for freeing in a RCU-safe manner
956 struct batadv_softif_vlan {
957 struct batadv_priv *bat_priv;
959 struct kobject *kobj;
960 atomic_t ap_isolation; /* boolean */
961 struct batadv_vlan_tt tt;
962 struct hlist_node list;
963 struct kref refcount;
968 * struct batadv_priv_bat_v - B.A.T.M.A.N. V per soft-interface private data
969 * @ogm_buff: buffer holding the OGM packet
970 * @ogm_buff_len: length of the OGM packet buffer
971 * @ogm_seqno: OGM sequence number - used to identify each OGM
972 * @ogm_buff_mutex: lock protecting ogm_buff and ogm_buff_len
973 * @ogm_wq: workqueue used to schedule OGM transmissions
975 struct batadv_priv_bat_v {
976 unsigned char *ogm_buff;
979 struct mutex ogm_buff_mutex;
980 struct delayed_work ogm_wq;
984 * struct batadv_priv - per mesh interface data
985 * @mesh_state: current status of the mesh (inactive/active/deactivating)
986 * @soft_iface: net device which holds this struct as private data
987 * @stats: structure holding the data for the ndo_get_stats() call
988 * @bat_counters: mesh internal traffic statistic counters (see batadv_counters)
989 * @aggregated_ogms: bool indicating whether OGM aggregation is enabled
990 * @bonding: bool indicating whether traffic bonding is enabled
991 * @fragmentation: bool indicating whether traffic fragmentation is enabled
992 * @packet_size_max: max packet size that can be transmitted via
993 * multiple fragmented skbs or a single frame if fragmentation is disabled
994 * @frag_seqno: incremental counter to identify chains of egress fragments
995 * @bridge_loop_avoidance: bool indicating whether bridge loop avoidance is
997 * @distributed_arp_table: bool indicating whether distributed ARP table is
999 * @multicast_mode: Enable or disable multicast optimizations on this node's
1000 * sender/originating side
1001 * @orig_interval: OGM broadcast interval in milliseconds
1002 * @hop_penalty: penalty which will be applied to an OGM's tq-field on every hop
1003 * @log_level: configured log level (see batadv_dbg_level)
1004 * @isolation_mark: the skb->mark value used to match packets for AP isolation
1005 * @isolation_mark_mask: bitmask identifying the bits in skb->mark to be used
1006 * for the isolation mark
1007 * @bcast_seqno: last sent broadcast packet sequence number
1008 * @bcast_queue_left: number of remaining buffered broadcast packet slots
1009 * @batman_queue_left: number of remaining OGM packet slots
1010 * @num_ifaces: number of interfaces assigned to this mesh interface
1011 * @mesh_obj: kobject for sysfs mesh subdirectory
1012 * @debug_dir: dentry for debugfs batman-adv subdirectory
1013 * @forw_bat_list: list of aggregated OGMs that will be forwarded
1014 * @forw_bcast_list: list of broadcast packets that will be rebroadcasted
1015 * @tp_list: list of tp sessions
1016 * @tp_num: number of currently active tp sessions
1017 * @orig_hash: hash table containing mesh participants (orig nodes)
1018 * @forw_bat_list_lock: lock protecting forw_bat_list
1019 * @forw_bcast_list_lock: lock protecting forw_bcast_list
1020 * @tp_list_lock: spinlock protecting @tp_list
1021 * @orig_work: work queue callback item for orig node purging
1022 * @primary_if: one of the hard-interfaces assigned to this mesh interface
1023 * becomes the primary interface
1024 * @algo_ops: routing algorithm used by this mesh interface
1025 * @softif_vlan_list: a list of softif_vlan structs, one per VLAN created on top
1026 * of the mesh interface represented by this object
1027 * @softif_vlan_list_lock: lock protecting softif_vlan_list
1028 * @bla: bridge loope avoidance data
1029 * @debug_log: holding debug logging relevant data
1031 * @tt: translation table data
1032 * @tvlv: type-version-length-value data
1033 * @dat: distributed arp table data
1034 * @mcast: multicast data
1035 * @network_coding: bool indicating whether network coding is enabled
1036 * @nc: network coding data
1037 * @bat_v: B.A.T.M.A.N. V per soft-interface private data
1039 struct batadv_priv {
1040 atomic_t mesh_state;
1041 struct net_device *soft_iface;
1042 struct net_device_stats stats;
1043 u64 __percpu *bat_counters; /* Per cpu counters */
1044 atomic_t aggregated_ogms;
1046 atomic_t fragmentation;
1047 atomic_t packet_size_max;
1048 atomic_t frag_seqno;
1049 #ifdef CONFIG_BATMAN_ADV_BLA
1050 atomic_t bridge_loop_avoidance;
1052 #ifdef CONFIG_BATMAN_ADV_DAT
1053 atomic_t distributed_arp_table;
1055 #ifdef CONFIG_BATMAN_ADV_MCAST
1056 atomic_t multicast_mode;
1058 atomic_t orig_interval;
1059 atomic_t hop_penalty;
1060 #ifdef CONFIG_BATMAN_ADV_DEBUG
1064 u32 isolation_mark_mask;
1065 atomic_t bcast_seqno;
1066 atomic_t bcast_queue_left;
1067 atomic_t batman_queue_left;
1068 unsigned int num_ifaces;
1069 struct kobject *mesh_obj;
1070 struct dentry *debug_dir;
1071 struct hlist_head forw_bat_list;
1072 struct hlist_head forw_bcast_list;
1073 struct hlist_head tp_list;
1074 struct batadv_hashtable *orig_hash;
1075 spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
1076 spinlock_t forw_bcast_list_lock; /* protects forw_bcast_list */
1077 spinlock_t tp_list_lock; /* protects tp_list */
1079 struct delayed_work orig_work;
1080 struct batadv_hard_iface __rcu *primary_if; /* rcu protected pointer */
1081 struct batadv_algo_ops *algo_ops;
1082 struct hlist_head softif_vlan_list;
1083 spinlock_t softif_vlan_list_lock; /* protects softif_vlan_list */
1084 #ifdef CONFIG_BATMAN_ADV_BLA
1085 struct batadv_priv_bla bla;
1087 #ifdef CONFIG_BATMAN_ADV_DEBUG
1088 struct batadv_priv_debug_log *debug_log;
1090 struct batadv_priv_gw gw;
1091 struct batadv_priv_tt tt;
1092 struct batadv_priv_tvlv tvlv;
1093 #ifdef CONFIG_BATMAN_ADV_DAT
1094 struct batadv_priv_dat dat;
1096 #ifdef CONFIG_BATMAN_ADV_MCAST
1097 struct batadv_priv_mcast mcast;
1099 #ifdef CONFIG_BATMAN_ADV_NC
1100 atomic_t network_coding;
1101 struct batadv_priv_nc nc;
1102 #endif /* CONFIG_BATMAN_ADV_NC */
1103 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
1104 struct batadv_priv_bat_v bat_v;
1109 * struct batadv_socket_client - layer2 icmp socket client data
1110 * @queue_list: packet queue for packets destined for this socket client
1111 * @queue_len: number of packets in the packet queue (queue_list)
1112 * @index: socket client's index in the batadv_socket_client_hash
1113 * @lock: lock protecting queue_list, queue_len & index
1114 * @queue_wait: socket client's wait queue
1115 * @bat_priv: pointer to soft_iface this client belongs to
1117 struct batadv_socket_client {
1118 struct list_head queue_list;
1119 unsigned int queue_len;
1120 unsigned char index;
1121 spinlock_t lock; /* protects queue_list, queue_len & index */
1122 wait_queue_head_t queue_wait;
1123 struct batadv_priv *bat_priv;
1127 * struct batadv_socket_packet - layer2 icmp packet for socket client
1128 * @list: list node for batadv_socket_client::queue_list
1129 * @icmp_len: size of the layer2 icmp packet
1130 * @icmp_packet: layer2 icmp packet
1132 struct batadv_socket_packet {
1133 struct list_head list;
1135 u8 icmp_packet[BATADV_ICMP_MAX_PACKET_SIZE];
1138 #ifdef CONFIG_BATMAN_ADV_BLA
1141 * struct batadv_bla_backbone_gw - batman-adv gateway bridged into the LAN
1142 * @orig: originator address of backbone node (mac address of primary iface)
1143 * @vid: vlan id this gateway was detected on
1144 * @hash_entry: hlist node for batadv_priv_bla::backbone_hash
1145 * @bat_priv: pointer to soft_iface this backbone gateway belongs to
1146 * @lasttime: last time we heard of this backbone gw
1147 * @wait_periods: grace time for bridge forward delays and bla group forming at
1148 * bootup phase - no bcast traffic is formwared until it has elapsed
1149 * @request_sent: if this bool is set to true we are out of sync with this
1150 * backbone gateway - no bcast traffic is formwared until the situation was
1152 * @crc: crc16 checksum over all claims
1153 * @crc_lock: lock protecting crc
1154 * @report_work: work struct for reporting detected loops
1155 * @refcount: number of contexts the object is used
1156 * @rcu: struct used for freeing in an RCU-safe manner
1158 struct batadv_bla_backbone_gw {
1161 struct hlist_node hash_entry;
1162 struct batadv_priv *bat_priv;
1163 unsigned long lasttime;
1164 atomic_t wait_periods;
1165 atomic_t request_sent;
1167 spinlock_t crc_lock; /* protects crc */
1168 struct work_struct report_work;
1169 struct kref refcount;
1170 struct rcu_head rcu;
1174 * struct batadv_bla_claim - claimed non-mesh client structure
1175 * @addr: mac address of claimed non-mesh client
1176 * @vid: vlan id this client was detected on
1177 * @backbone_gw: pointer to backbone gw claiming this client
1178 * @backbone_lock: lock protecting backbone_gw pointer
1179 * @lasttime: last time we heard of claim (locals only)
1180 * @hash_entry: hlist node for batadv_priv_bla::claim_hash
1181 * @refcount: number of contexts the object is used
1182 * @rcu: struct used for freeing in an RCU-safe manner
1184 struct batadv_bla_claim {
1187 struct batadv_bla_backbone_gw *backbone_gw;
1188 spinlock_t backbone_lock; /* protects backbone_gw */
1189 unsigned long lasttime;
1190 struct hlist_node hash_entry;
1191 struct rcu_head rcu;
1192 struct kref refcount;
1197 * struct batadv_tt_common_entry - tt local & tt global common data
1198 * @addr: mac address of non-mesh client
1199 * @vid: VLAN identifier
1200 * @hash_entry: hlist node for batadv_priv_tt::local_hash or for
1201 * batadv_priv_tt::global_hash
1202 * @flags: various state handling flags (see batadv_tt_client_flags)
1203 * @added_at: timestamp used for purging stale tt common entries
1204 * @refcount: number of contexts the object is used
1205 * @rcu: struct used for freeing in an RCU-safe manner
1207 struct batadv_tt_common_entry {
1210 struct hlist_node hash_entry;
1212 unsigned long added_at;
1213 struct kref refcount;
1214 struct rcu_head rcu;
1218 * struct batadv_tt_local_entry - translation table local entry data
1219 * @common: general translation table data
1220 * @last_seen: timestamp used for purging stale tt local entries
1221 * @vlan: soft-interface vlan of the entry
1223 struct batadv_tt_local_entry {
1224 struct batadv_tt_common_entry common;
1225 unsigned long last_seen;
1226 struct batadv_softif_vlan *vlan;
1230 * struct batadv_tt_global_entry - translation table global entry data
1231 * @common: general translation table data
1232 * @orig_list: list of orig nodes announcing this non-mesh client
1233 * @orig_list_count: number of items in the orig_list
1234 * @list_lock: lock protecting orig_list
1235 * @roam_at: time at which TT_GLOBAL_ROAM was set
1237 struct batadv_tt_global_entry {
1238 struct batadv_tt_common_entry common;
1239 struct hlist_head orig_list;
1240 atomic_t orig_list_count;
1241 spinlock_t list_lock; /* protects orig_list */
1242 unsigned long roam_at;
1246 * struct batadv_tt_orig_list_entry - orig node announcing a non-mesh client
1247 * @orig_node: pointer to orig node announcing this non-mesh client
1248 * @ttvn: translation table version number which added the non-mesh client
1249 * @flags: per orig entry TT sync flags
1250 * @list: list node for batadv_tt_global_entry::orig_list
1251 * @refcount: number of contexts the object is used
1252 * @rcu: struct used for freeing in an RCU-safe manner
1254 struct batadv_tt_orig_list_entry {
1255 struct batadv_orig_node *orig_node;
1258 struct hlist_node list;
1259 struct kref refcount;
1260 struct rcu_head rcu;
1264 * struct batadv_tt_change_node - structure for tt changes occurred
1265 * @list: list node for batadv_priv_tt::changes_list
1266 * @change: holds the actual translation table diff data
1268 struct batadv_tt_change_node {
1269 struct list_head list;
1270 struct batadv_tvlv_tt_change change;
1274 * struct batadv_tt_req_node - data to keep track of the tt requests in flight
1275 * @addr: mac address address of the originator this request was sent to
1276 * @issued_at: timestamp used for purging stale tt requests
1277 * @refcount: number of contexts the object is used by
1278 * @list: list node for batadv_priv_tt::req_list
1280 struct batadv_tt_req_node {
1282 unsigned long issued_at;
1283 struct kref refcount;
1284 struct hlist_node list;
1288 * struct batadv_tt_roam_node - roaming client data
1289 * @addr: mac address of the client in the roaming phase
1290 * @counter: number of allowed roaming events per client within a single
1291 * OGM interval (changes are committed with each OGM)
1292 * @first_time: timestamp used for purging stale roaming node entries
1293 * @list: list node for batadv_priv_tt::roam_list
1295 struct batadv_tt_roam_node {
1298 unsigned long first_time;
1299 struct list_head list;
1303 * struct batadv_nc_node - network coding node
1304 * @list: next and prev pointer for the list handling
1305 * @addr: the node's mac address
1306 * @refcount: number of contexts the object is used by
1307 * @rcu: struct used for freeing in an RCU-safe manner
1308 * @orig_node: pointer to corresponding orig node struct
1309 * @last_seen: timestamp of last ogm received from this node
1311 struct batadv_nc_node {
1312 struct list_head list;
1314 struct kref refcount;
1315 struct rcu_head rcu;
1316 struct batadv_orig_node *orig_node;
1317 unsigned long last_seen;
1321 * struct batadv_nc_path - network coding path
1322 * @hash_entry: next and prev pointer for the list handling
1323 * @rcu: struct used for freeing in an RCU-safe manner
1324 * @refcount: number of contexts the object is used by
1325 * @packet_list: list of buffered packets for this path
1326 * @packet_list_lock: access lock for packet list
1327 * @next_hop: next hop (destination) of path
1328 * @prev_hop: previous hop (source) of path
1329 * @last_valid: timestamp for last validation of path
1331 struct batadv_nc_path {
1332 struct hlist_node hash_entry;
1333 struct rcu_head rcu;
1334 struct kref refcount;
1335 struct list_head packet_list;
1336 spinlock_t packet_list_lock; /* Protects packet_list */
1337 u8 next_hop[ETH_ALEN];
1338 u8 prev_hop[ETH_ALEN];
1339 unsigned long last_valid;
1343 * struct batadv_nc_packet - network coding packet used when coding and
1345 * @list: next and prev pointer for the list handling
1346 * @packet_id: crc32 checksum of skb data
1347 * @timestamp: field containing the info when the packet was added to path
1348 * @neigh_node: pointer to original next hop neighbor of skb
1349 * @skb: skb which can be encoded or used for decoding
1350 * @nc_path: pointer to path this nc packet is attached to
1352 struct batadv_nc_packet {
1353 struct list_head list;
1355 unsigned long timestamp;
1356 struct batadv_neigh_node *neigh_node;
1357 struct sk_buff *skb;
1358 struct batadv_nc_path *nc_path;
1362 * struct batadv_skb_cb - control buffer structure used to store private data
1363 * relevant to batman-adv in the skb->cb buffer in skbs.
1364 * @decoded: Marks a skb as decoded, which is checked when searching for coding
1365 * opportunities in network-coding.c
1367 struct batadv_skb_cb {
1372 * struct batadv_forw_packet - structure for bcast packets to be sent/forwarded
1373 * @list: list node for batadv_socket_client::queue_list
1374 * @send_time: execution time for delayed_work (packet sending)
1375 * @own: bool for locally generated packets (local OGMs are re-scheduled after
1377 * @skb: bcast packet's skb buffer
1378 * @packet_len: size of aggregated OGM packet inside the skb buffer
1379 * @direct_link_flags: direct link flags for aggregated OGM packets
1380 * @num_packets: counter for bcast packet retransmission
1381 * @delayed_work: work queue callback item for packet sending
1382 * @if_incoming: pointer to incoming hard-iface or primary iface if
1383 * locally generated packet
1384 * @if_outgoing: packet where the packet should be sent to, or NULL if
1386 * @queue_left: The queue (counter) this packet was applied to
1388 struct batadv_forw_packet {
1389 struct hlist_node list;
1390 unsigned long send_time;
1392 struct sk_buff *skb;
1394 u32 direct_link_flags;
1396 struct delayed_work delayed_work;
1397 struct batadv_hard_iface *if_incoming;
1398 struct batadv_hard_iface *if_outgoing;
1399 atomic_t *queue_left;
1403 * struct batadv_algo_iface_ops - mesh algorithm callbacks (interface specific)
1404 * @activate: start routing mechanisms when hard-interface is brought up
1406 * @enable: init routing info when hard-interface is enabled
1407 * @enabled: notification when hard-interface was enabled (optional)
1408 * @disable: de-init routing info when hard-interface is disabled
1409 * @update_mac: (re-)init mac addresses of the protocol information
1410 * belonging to this hard-interface
1411 * @primary_set: called when primary interface is selected / changed
1413 struct batadv_algo_iface_ops {
1414 void (*activate)(struct batadv_hard_iface *hard_iface);
1415 int (*enable)(struct batadv_hard_iface *hard_iface);
1416 void (*enabled)(struct batadv_hard_iface *hard_iface);
1417 void (*disable)(struct batadv_hard_iface *hard_iface);
1418 void (*update_mac)(struct batadv_hard_iface *hard_iface);
1419 void (*primary_set)(struct batadv_hard_iface *hard_iface);
1423 * struct batadv_algo_neigh_ops - mesh algorithm callbacks (neighbour specific)
1424 * @hardif_init: called on creation of single hop entry
1426 * @cmp: compare the metrics of two neighbors for their respective outgoing
1428 * @is_similar_or_better: check if neigh1 is equally similar or better than
1429 * neigh2 for their respective outgoing interface from the metric prospective
1430 * @print: print the single hop neighbor list (optional)
1431 * @dump: dump neighbors to a netlink socket (optional)
1433 struct batadv_algo_neigh_ops {
1434 void (*hardif_init)(struct batadv_hardif_neigh_node *neigh);
1435 int (*cmp)(struct batadv_neigh_node *neigh1,
1436 struct batadv_hard_iface *if_outgoing1,
1437 struct batadv_neigh_node *neigh2,
1438 struct batadv_hard_iface *if_outgoing2);
1439 bool (*is_similar_or_better)(struct batadv_neigh_node *neigh1,
1440 struct batadv_hard_iface *if_outgoing1,
1441 struct batadv_neigh_node *neigh2,
1442 struct batadv_hard_iface *if_outgoing2);
1443 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
1444 void (*print)(struct batadv_priv *priv, struct seq_file *seq);
1446 void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
1447 struct batadv_priv *priv,
1448 struct batadv_hard_iface *hard_iface);
1452 * struct batadv_algo_orig_ops - mesh algorithm callbacks (originator specific)
1453 * @free: free the resources allocated by the routing algorithm for an orig_node
1455 * @add_if: ask the routing algorithm to apply the needed changes to the
1456 * orig_node due to a new hard-interface being added into the mesh (optional)
1457 * @del_if: ask the routing algorithm to apply the needed changes to the
1458 * orig_node due to an hard-interface being removed from the mesh (optional)
1459 * @print: print the originator table (optional)
1460 * @dump: dump originators to a netlink socket (optional)
1462 struct batadv_algo_orig_ops {
1463 void (*free)(struct batadv_orig_node *orig_node);
1464 int (*add_if)(struct batadv_orig_node *orig_node,
1465 unsigned int max_if_num);
1466 int (*del_if)(struct batadv_orig_node *orig_node,
1467 unsigned int max_if_num, unsigned int del_if_num);
1468 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
1469 void (*print)(struct batadv_priv *priv, struct seq_file *seq,
1470 struct batadv_hard_iface *hard_iface);
1472 void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
1473 struct batadv_priv *priv,
1474 struct batadv_hard_iface *hard_iface);
1478 * struct batadv_algo_gw_ops - mesh algorithm callbacks (GW specific)
1479 * @init_sel_class: initialize GW selection class (optional)
1480 * @store_sel_class: parse and stores a new GW selection class (optional)
1481 * @show_sel_class: prints the current GW selection class (optional)
1482 * @get_best_gw_node: select the best GW from the list of available nodes
1484 * @is_eligible: check if a newly discovered GW is a potential candidate for
1485 * the election as best GW (optional)
1486 * @print: print the gateway table (optional)
1487 * @dump: dump gateways to a netlink socket (optional)
1489 struct batadv_algo_gw_ops {
1490 void (*init_sel_class)(struct batadv_priv *bat_priv);
1491 ssize_t (*store_sel_class)(struct batadv_priv *bat_priv, char *buff,
1493 ssize_t (*show_sel_class)(struct batadv_priv *bat_priv, char *buff);
1494 struct batadv_gw_node *(*get_best_gw_node)
1495 (struct batadv_priv *bat_priv);
1496 bool (*is_eligible)(struct batadv_priv *bat_priv,
1497 struct batadv_orig_node *curr_gw_orig,
1498 struct batadv_orig_node *orig_node);
1499 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
1500 void (*print)(struct batadv_priv *bat_priv, struct seq_file *seq);
1502 void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
1503 struct batadv_priv *priv);
1507 * struct batadv_algo_ops - mesh algorithm callbacks
1508 * @list: list node for the batadv_algo_list
1509 * @name: name of the algorithm
1510 * @iface: callbacks related to interface handling
1511 * @neigh: callbacks related to neighbors handling
1512 * @orig: callbacks related to originators handling
1513 * @gw: callbacks related to GW mode
1515 struct batadv_algo_ops {
1516 struct hlist_node list;
1518 struct batadv_algo_iface_ops iface;
1519 struct batadv_algo_neigh_ops neigh;
1520 struct batadv_algo_orig_ops orig;
1521 struct batadv_algo_gw_ops gw;
1525 * struct batadv_dat_entry - it is a single entry of batman-adv ARP backend. It
1526 * is used to stored ARP entries needed for the global DAT cache
1527 * @ip: the IPv4 corresponding to this DAT/ARP entry
1528 * @mac_addr: the MAC address associated to the stored IPv4
1529 * @vid: the vlan ID associated to this entry
1530 * @last_update: time in jiffies when this entry was refreshed last time
1531 * @hash_entry: hlist node for batadv_priv_dat::hash
1532 * @refcount: number of contexts the object is used
1533 * @rcu: struct used for freeing in an RCU-safe manner
1535 struct batadv_dat_entry {
1537 u8 mac_addr[ETH_ALEN];
1539 unsigned long last_update;
1540 struct hlist_node hash_entry;
1541 struct kref refcount;
1542 struct rcu_head rcu;
1546 * struct batadv_hw_addr - a list entry for a MAC address
1547 * @list: list node for the linking of entries
1548 * @addr: the MAC address of this list entry
1550 struct batadv_hw_addr {
1551 struct hlist_node list;
1552 unsigned char addr[ETH_ALEN];
1556 * struct batadv_dat_candidate - candidate destination for DAT operations
1557 * @type: the type of the selected candidate. It can one of the following:
1558 * - BATADV_DAT_CANDIDATE_NOT_FOUND
1559 * - BATADV_DAT_CANDIDATE_ORIG
1560 * @orig_node: if type is BATADV_DAT_CANDIDATE_ORIG this field points to the
1561 * corresponding originator node structure
1563 struct batadv_dat_candidate {
1565 struct batadv_orig_node *orig_node;
1569 * struct batadv_tvlv_container - container for tvlv appended to OGMs
1570 * @list: hlist node for batadv_priv_tvlv::container_list
1571 * @tvlv_hdr: tvlv header information needed to construct the tvlv
1572 * @refcount: number of contexts the object is used
1574 struct batadv_tvlv_container {
1575 struct hlist_node list;
1576 struct batadv_tvlv_hdr tvlv_hdr;
1577 struct kref refcount;
1581 * struct batadv_tvlv_handler - handler for specific tvlv type and version
1582 * @list: hlist node for batadv_priv_tvlv::handler_list
1583 * @ogm_handler: handler callback which is given the tvlv payload to process on
1584 * incoming OGM packets
1585 * @unicast_handler: handler callback which is given the tvlv payload to process
1586 * on incoming unicast tvlv packets
1587 * @type: tvlv type this handler feels responsible for
1588 * @version: tvlv version this handler feels responsible for
1589 * @flags: tvlv handler flags
1590 * @refcount: number of contexts the object is used
1591 * @rcu: struct used for freeing in an RCU-safe manner
1593 struct batadv_tvlv_handler {
1594 struct hlist_node list;
1595 void (*ogm_handler)(struct batadv_priv *bat_priv,
1596 struct batadv_orig_node *orig,
1597 u8 flags, void *tvlv_value, u16 tvlv_value_len);
1598 int (*unicast_handler)(struct batadv_priv *bat_priv,
1600 void *tvlv_value, u16 tvlv_value_len);
1604 struct kref refcount;
1605 struct rcu_head rcu;
1609 * enum batadv_tvlv_handler_flags - tvlv handler flags definitions
1610 * @BATADV_TVLV_HANDLER_OGM_CIFNOTFND: tvlv ogm processing function will call
1611 * this handler even if its type was not found (with no data)
1612 * @BATADV_TVLV_HANDLER_OGM_CALLED: interval tvlv handling flag - the API marks
1613 * a handler as being called, so it won't be called if the
1614 * BATADV_TVLV_HANDLER_OGM_CIFNOTFND flag was set
1616 enum batadv_tvlv_handler_flags {
1617 BATADV_TVLV_HANDLER_OGM_CIFNOTFND = BIT(1),
1618 BATADV_TVLV_HANDLER_OGM_CALLED = BIT(2),
1622 * struct batadv_store_mesh_work - Work queue item to detach add/del interface
1624 * @net_dev: netdevice to add/remove to/from batman-adv soft-interface
1625 * @soft_iface_name: name of soft-interface to modify
1626 * @work: work queue item
1628 struct batadv_store_mesh_work {
1629 struct net_device *net_dev;
1630 char soft_iface_name[IFNAMSIZ];
1631 struct work_struct work;
1634 #endif /* _NET_BATMAN_ADV_TYPES_H_ */