1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright (C) B.A.T.M.A.N. contributors:
4 * Marek Lindner, Simon Wunderlich
7 #ifndef _NET_BATMAN_ADV_TYPES_H_
8 #define _NET_BATMAN_ADV_TYPES_H_
10 #ifndef _NET_BATMAN_ADV_MAIN_H_
11 #error only "main.h" can be included directly
14 #include <linux/average.h>
15 #include <linux/bitops.h>
16 #include <linux/compiler.h>
18 #include <linux/if_ether.h>
19 #include <linux/kref.h>
20 #include <linux/mutex.h>
21 #include <linux/netdevice.h>
22 #include <linux/netlink.h>
23 #include <linux/sched.h> /* for linux/wait.h */
24 #include <linux/skbuff.h>
25 #include <linux/spinlock.h>
26 #include <linux/timer.h>
27 #include <linux/types.h>
28 #include <linux/wait.h>
29 #include <linux/workqueue.h>
30 #include <uapi/linux/batadv_packet.h>
31 #include <uapi/linux/batman_adv.h>
33 #ifdef CONFIG_BATMAN_ADV_DAT
36 * typedef batadv_dat_addr_t - type used for all DHT addresses
38 * If it is changed, BATADV_DAT_ADDR_MAX is changed as well.
40 * *Please be careful: batadv_dat_addr_t must be UNSIGNED*
42 typedef u16 batadv_dat_addr_t;
44 #endif /* CONFIG_BATMAN_ADV_DAT */
47 * enum batadv_dhcp_recipient - dhcp destination
49 enum batadv_dhcp_recipient {
50 /** @BATADV_DHCP_NO: packet is not a dhcp message */
53 /** @BATADV_DHCP_TO_SERVER: dhcp message is directed to a server */
54 BATADV_DHCP_TO_SERVER,
56 /** @BATADV_DHCP_TO_CLIENT: dhcp message is directed to a client */
57 BATADV_DHCP_TO_CLIENT,
61 * BATADV_TT_REMOTE_MASK - bitmask selecting the flags that are sent over the
64 #define BATADV_TT_REMOTE_MASK 0x00FF
67 * BATADV_TT_SYNC_MASK - bitmask of the flags that need to be kept in sync
68 * among the nodes. These flags are used to compute the global/local CRC
70 #define BATADV_TT_SYNC_MASK 0x00F0
73 * struct batadv_hard_iface_bat_iv - per hard-interface B.A.T.M.A.N. IV data
75 struct batadv_hard_iface_bat_iv {
76 /** @ogm_buff: buffer holding the OGM packet */
77 unsigned char *ogm_buff;
79 /** @ogm_buff_len: length of the OGM packet buffer */
82 /** @ogm_seqno: OGM sequence number - used to identify each OGM */
85 /** @ogm_buff_mutex: lock protecting ogm_buff and ogm_buff_len */
86 struct mutex ogm_buff_mutex;
90 * enum batadv_v_hard_iface_flags - interface flags useful to B.A.T.M.A.N. V
92 enum batadv_v_hard_iface_flags {
94 * @BATADV_FULL_DUPLEX: tells if the connection over this link is
97 BATADV_FULL_DUPLEX = BIT(0),
100 * @BATADV_WARNING_DEFAULT: tells whether we have warned the user that
101 * no throughput data is available for this interface and that default
102 * values are assumed.
104 BATADV_WARNING_DEFAULT = BIT(1),
108 * struct batadv_hard_iface_bat_v - per hard-interface B.A.T.M.A.N. V data
110 struct batadv_hard_iface_bat_v {
111 /** @elp_interval: time interval between two ELP transmissions */
112 atomic_t elp_interval;
114 /** @elp_seqno: current ELP sequence number */
117 /** @elp_skb: base skb containing the ELP message to send */
118 struct sk_buff *elp_skb;
120 /** @elp_wq: workqueue used to schedule ELP transmissions */
121 struct delayed_work elp_wq;
123 /** @aggr_wq: workqueue used to transmit queued OGM packets */
124 struct delayed_work aggr_wq;
126 /** @aggr_list: queue for to be aggregated OGM packets */
127 struct sk_buff_head aggr_list;
129 /** @aggr_len: size of the OGM aggregate (excluding ethernet header) */
130 unsigned int aggr_len;
133 * @throughput_override: throughput override to disable link
136 atomic_t throughput_override;
138 /** @flags: interface specific flags */
143 * enum batadv_hard_iface_wifi_flags - Flags describing the wifi configuration
144 * of a batadv_hard_iface
146 enum batadv_hard_iface_wifi_flags {
147 /** @BATADV_HARDIF_WIFI_WEXT_DIRECT: it is a wext wifi device */
148 BATADV_HARDIF_WIFI_WEXT_DIRECT = BIT(0),
150 /** @BATADV_HARDIF_WIFI_CFG80211_DIRECT: it is a cfg80211 wifi device */
151 BATADV_HARDIF_WIFI_CFG80211_DIRECT = BIT(1),
154 * @BATADV_HARDIF_WIFI_WEXT_INDIRECT: link device is a wext wifi device
156 BATADV_HARDIF_WIFI_WEXT_INDIRECT = BIT(2),
159 * @BATADV_HARDIF_WIFI_CFG80211_INDIRECT: link device is a cfg80211 wifi
162 BATADV_HARDIF_WIFI_CFG80211_INDIRECT = BIT(3),
166 * struct batadv_hard_iface - network device known to batman-adv
168 struct batadv_hard_iface {
169 /** @list: list node for batadv_hardif_list */
170 struct list_head list;
172 /** @if_status: status of the interface for batman-adv */
176 * @num_bcasts: number of payload re-broadcasts on this interface (ARQ)
181 * @wifi_flags: flags whether this is (directly or indirectly) a wifi
186 /** @net_dev: pointer to the net_device */
187 struct net_device *net_dev;
189 /** @refcount: number of contexts the object is used */
190 struct kref refcount;
193 * @batman_adv_ptype: packet type describing packets that should be
194 * processed by batman-adv for this interface
196 struct packet_type batman_adv_ptype;
199 * @soft_iface: the batman-adv interface which uses this network
202 struct net_device *soft_iface;
204 /** @rcu: struct used for freeing in an RCU-safe manner */
208 * @hop_penalty: penalty which will be applied to the tq-field
209 * of an OGM received via this interface
211 atomic_t hop_penalty;
213 /** @bat_iv: per hard-interface B.A.T.M.A.N. IV data */
214 struct batadv_hard_iface_bat_iv bat_iv;
216 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
217 /** @bat_v: per hard-interface B.A.T.M.A.N. V data */
218 struct batadv_hard_iface_bat_v bat_v;
222 * @neigh_list: list of unique single hop neighbors via this interface
224 struct hlist_head neigh_list;
226 /** @neigh_list_lock: lock protecting neigh_list */
227 spinlock_t neigh_list_lock;
231 * struct batadv_orig_ifinfo_bat_iv - B.A.T.M.A.N. IV private orig_ifinfo
234 struct batadv_orig_ifinfo_bat_iv {
236 * @bcast_own: bitfield which counts the number of our OGMs this
237 * orig_node rebroadcasted "back" to us (relative to last_real_seqno)
239 DECLARE_BITMAP(bcast_own, BATADV_TQ_LOCAL_WINDOW_SIZE);
241 /** @bcast_own_sum: sum of bcast_own */
246 * struct batadv_orig_ifinfo - originator info per outgoing interface
248 struct batadv_orig_ifinfo {
249 /** @list: list node for &batadv_orig_node.ifinfo_list */
250 struct hlist_node list;
252 /** @if_outgoing: pointer to outgoing hard-interface */
253 struct batadv_hard_iface *if_outgoing;
255 /** @router: router that should be used to reach this originator */
256 struct batadv_neigh_node __rcu *router;
258 /** @last_real_seqno: last and best known sequence number */
261 /** @last_ttl: ttl of last received packet */
264 /** @last_seqno_forwarded: seqno of the OGM which was forwarded last */
265 u32 last_seqno_forwarded;
267 /** @batman_seqno_reset: time when the batman seqno window was reset */
268 unsigned long batman_seqno_reset;
270 /** @bat_iv: B.A.T.M.A.N. IV private structure */
271 struct batadv_orig_ifinfo_bat_iv bat_iv;
273 /** @refcount: number of contexts the object is used */
274 struct kref refcount;
276 /** @rcu: struct used for freeing in an RCU-safe manner */
281 * struct batadv_frag_table_entry - head in the fragment buffer table
283 struct batadv_frag_table_entry {
284 /** @fragment_list: head of list with fragments */
285 struct hlist_head fragment_list;
287 /** @lock: lock to protect the list of fragments */
290 /** @timestamp: time (jiffie) of last received fragment */
291 unsigned long timestamp;
293 /** @seqno: sequence number of the fragments in the list */
296 /** @size: accumulated size of packets in list */
299 /** @total_size: expected size of the assembled packet */
304 * struct batadv_frag_list_entry - entry in a list of fragments
306 struct batadv_frag_list_entry {
307 /** @list: list node information */
308 struct hlist_node list;
310 /** @skb: fragment */
313 /** @no: fragment number in the set */
318 * struct batadv_vlan_tt - VLAN specific TT attributes
320 struct batadv_vlan_tt {
321 /** @crc: CRC32 checksum of the entries belonging to this vlan */
324 /** @num_entries: number of TT entries for this VLAN */
325 atomic_t num_entries;
329 * struct batadv_orig_node_vlan - VLAN specific data per orig_node
331 struct batadv_orig_node_vlan {
332 /** @vid: the VLAN identifier */
335 /** @tt: VLAN specific TT attributes */
336 struct batadv_vlan_tt tt;
338 /** @list: list node for &batadv_orig_node.vlan_list */
339 struct hlist_node list;
342 * @refcount: number of context where this object is currently in use
344 struct kref refcount;
346 /** @rcu: struct used for freeing in a RCU-safe manner */
351 * struct batadv_orig_bat_iv - B.A.T.M.A.N. IV private orig_node members
353 struct batadv_orig_bat_iv {
355 * @ogm_cnt_lock: lock protecting &batadv_orig_ifinfo_bat_iv.bcast_own,
356 * &batadv_orig_ifinfo_bat_iv.bcast_own_sum,
357 * &batadv_neigh_ifinfo_bat_iv.bat_iv.real_bits and
358 * &batadv_neigh_ifinfo_bat_iv.real_packet_count
360 spinlock_t ogm_cnt_lock;
364 * struct batadv_orig_node - structure for orig_list maintaining nodes of mesh
366 struct batadv_orig_node {
367 /** @orig: originator ethernet address */
370 /** @ifinfo_list: list for routers per outgoing interface */
371 struct hlist_head ifinfo_list;
374 * @last_bonding_candidate: pointer to last ifinfo of last used router
376 struct batadv_orig_ifinfo *last_bonding_candidate;
378 #ifdef CONFIG_BATMAN_ADV_DAT
379 /** @dat_addr: address of the orig node in the distributed hash */
380 batadv_dat_addr_t dat_addr;
383 /** @last_seen: time when last packet from this node was received */
384 unsigned long last_seen;
387 * @bcast_seqno_reset: time when the broadcast seqno window was reset
389 unsigned long bcast_seqno_reset;
391 #ifdef CONFIG_BATMAN_ADV_MCAST
393 * @mcast_handler_lock: synchronizes mcast-capability and -flag changes
395 spinlock_t mcast_handler_lock;
397 /** @mcast_flags: multicast flags announced by the orig node */
401 * @mcast_want_all_unsnoopables_node: a list node for the
402 * mcast.want_all_unsnoopables list
404 struct hlist_node mcast_want_all_unsnoopables_node;
407 * @mcast_want_all_ipv4_node: a list node for the mcast.want_all_ipv4
410 struct hlist_node mcast_want_all_ipv4_node;
412 * @mcast_want_all_ipv6_node: a list node for the mcast.want_all_ipv6
415 struct hlist_node mcast_want_all_ipv6_node;
418 * @mcast_want_all_rtr4_node: a list node for the mcast.want_all_rtr4
421 struct hlist_node mcast_want_all_rtr4_node;
423 * @mcast_want_all_rtr6_node: a list node for the mcast.want_all_rtr6
426 struct hlist_node mcast_want_all_rtr6_node;
429 /** @capabilities: announced capabilities of this originator */
430 unsigned long capabilities;
433 * @capa_initialized: bitfield to remember whether a capability was
436 unsigned long capa_initialized;
438 /** @last_ttvn: last seen translation table version number */
441 /** @tt_buff: last tt changeset this node received from the orig node */
442 unsigned char *tt_buff;
445 * @tt_buff_len: length of the last tt changeset this node received
450 /** @tt_buff_lock: lock that protects tt_buff and tt_buff_len */
451 spinlock_t tt_buff_lock;
454 * @tt_lock: avoids concurrent read from and write to the table. Table
455 * update is made up of two operations (data structure update and
456 * metadata -CRC/TTVN-recalculation) and they have to be executed
457 * atomically in order to avoid another thread to read the
458 * table/metadata between those.
463 * @bcast_bits: bitfield containing the info which payload broadcast
464 * originated from this orig node this host already has seen (relative
465 * to last_bcast_seqno)
467 DECLARE_BITMAP(bcast_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
470 * @last_bcast_seqno: last broadcast sequence number received by this
473 u32 last_bcast_seqno;
476 * @neigh_list: list of potential next hop neighbor towards this orig
479 struct hlist_head neigh_list;
482 * @neigh_list_lock: lock protecting neigh_list, ifinfo_list,
483 * last_bonding_candidate and router
485 spinlock_t neigh_list_lock;
487 /** @hash_entry: hlist node for &batadv_priv.orig_hash */
488 struct hlist_node hash_entry;
490 /** @bat_priv: pointer to soft_iface this orig node belongs to */
491 struct batadv_priv *bat_priv;
493 /** @bcast_seqno_lock: lock protecting bcast_bits & last_bcast_seqno */
494 spinlock_t bcast_seqno_lock;
496 /** @refcount: number of contexts the object is used */
497 struct kref refcount;
499 /** @rcu: struct used for freeing in an RCU-safe manner */
502 #ifdef CONFIG_BATMAN_ADV_NC
503 /** @in_coding_list: list of nodes this orig can hear */
504 struct list_head in_coding_list;
506 /** @out_coding_list: list of nodes that can hear this orig */
507 struct list_head out_coding_list;
509 /** @in_coding_list_lock: protects in_coding_list */
510 spinlock_t in_coding_list_lock;
512 /** @out_coding_list_lock: protects out_coding_list */
513 spinlock_t out_coding_list_lock;
516 /** @fragments: array with heads for fragment chains */
517 struct batadv_frag_table_entry fragments[BATADV_FRAG_BUFFER_COUNT];
520 * @vlan_list: a list of orig_node_vlan structs, one per VLAN served by
521 * the originator represented by this object
523 struct hlist_head vlan_list;
525 /** @vlan_list_lock: lock protecting vlan_list */
526 spinlock_t vlan_list_lock;
528 /** @bat_iv: B.A.T.M.A.N. IV private structure */
529 struct batadv_orig_bat_iv bat_iv;
533 * enum batadv_orig_capabilities - orig node capabilities
535 enum batadv_orig_capabilities {
537 * @BATADV_ORIG_CAPA_HAS_DAT: orig node has distributed arp table
540 BATADV_ORIG_CAPA_HAS_DAT,
542 /** @BATADV_ORIG_CAPA_HAS_NC: orig node has network coding enabled */
543 BATADV_ORIG_CAPA_HAS_NC,
545 /** @BATADV_ORIG_CAPA_HAS_TT: orig node has tt capability */
546 BATADV_ORIG_CAPA_HAS_TT,
549 * @BATADV_ORIG_CAPA_HAS_MCAST: orig node has some multicast capability
550 * (= orig node announces a tvlv of type BATADV_TVLV_MCAST)
552 BATADV_ORIG_CAPA_HAS_MCAST,
556 * struct batadv_gw_node - structure for orig nodes announcing gw capabilities
558 struct batadv_gw_node {
559 /** @list: list node for &batadv_priv_gw.list */
560 struct hlist_node list;
562 /** @orig_node: pointer to corresponding orig node */
563 struct batadv_orig_node *orig_node;
565 /** @bandwidth_down: advertised uplink download bandwidth */
568 /** @bandwidth_up: advertised uplink upload bandwidth */
571 /** @refcount: number of contexts the object is used */
572 struct kref refcount;
574 /** @rcu: struct used for freeing in an RCU-safe manner */
578 DECLARE_EWMA(throughput, 10, 8)
581 * struct batadv_hardif_neigh_node_bat_v - B.A.T.M.A.N. V private neighbor
584 struct batadv_hardif_neigh_node_bat_v {
585 /** @throughput: ewma link throughput towards this neighbor */
586 struct ewma_throughput throughput;
588 /** @elp_interval: time interval between two ELP transmissions */
591 /** @elp_latest_seqno: latest and best known ELP sequence number */
592 u32 elp_latest_seqno;
595 * @last_unicast_tx: when the last unicast packet has been sent to this
598 unsigned long last_unicast_tx;
600 /** @metric_work: work queue callback item for metric update */
601 struct work_struct metric_work;
605 * struct batadv_hardif_neigh_node - unique neighbor per hard-interface
607 struct batadv_hardif_neigh_node {
608 /** @list: list node for &batadv_hard_iface.neigh_list */
609 struct hlist_node list;
611 /** @addr: the MAC address of the neighboring interface */
615 * @orig: the address of the originator this neighbor node belongs to
619 /** @if_incoming: pointer to incoming hard-interface */
620 struct batadv_hard_iface *if_incoming;
622 /** @last_seen: when last packet via this neighbor was received */
623 unsigned long last_seen;
625 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
626 /** @bat_v: B.A.T.M.A.N. V private data */
627 struct batadv_hardif_neigh_node_bat_v bat_v;
630 /** @refcount: number of contexts the object is used */
631 struct kref refcount;
633 /** @rcu: struct used for freeing in a RCU-safe manner */
638 * struct batadv_neigh_node - structure for single hops neighbors
640 struct batadv_neigh_node {
641 /** @list: list node for &batadv_orig_node.neigh_list */
642 struct hlist_node list;
644 /** @orig_node: pointer to corresponding orig_node */
645 struct batadv_orig_node *orig_node;
647 /** @addr: the MAC address of the neighboring interface */
650 /** @ifinfo_list: list for routing metrics per outgoing interface */
651 struct hlist_head ifinfo_list;
653 /** @ifinfo_lock: lock protecting ifinfo_list and its members */
654 spinlock_t ifinfo_lock;
656 /** @if_incoming: pointer to incoming hard-interface */
657 struct batadv_hard_iface *if_incoming;
659 /** @last_seen: when last packet via this neighbor was received */
660 unsigned long last_seen;
662 /** @hardif_neigh: hardif_neigh of this neighbor */
663 struct batadv_hardif_neigh_node *hardif_neigh;
665 /** @refcount: number of contexts the object is used */
666 struct kref refcount;
668 /** @rcu: struct used for freeing in an RCU-safe manner */
673 * struct batadv_neigh_ifinfo_bat_iv - neighbor information per outgoing
674 * interface for B.A.T.M.A.N. IV
676 struct batadv_neigh_ifinfo_bat_iv {
677 /** @tq_recv: ring buffer of received TQ values from this neigh node */
678 u8 tq_recv[BATADV_TQ_GLOBAL_WINDOW_SIZE];
680 /** @tq_index: ring buffer index */
684 * @tq_avg: averaged tq of all tq values in the ring buffer (tq_recv)
689 * @real_bits: bitfield containing the number of OGMs received from this
690 * neigh node (relative to orig_node->last_real_seqno)
692 DECLARE_BITMAP(real_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
694 /** @real_packet_count: counted result of real_bits */
695 u8 real_packet_count;
699 * struct batadv_neigh_ifinfo_bat_v - neighbor information per outgoing
700 * interface for B.A.T.M.A.N. V
702 struct batadv_neigh_ifinfo_bat_v {
704 * @throughput: last throughput metric received from originator via this
709 /** @last_seqno: last sequence number known for this neighbor */
714 * struct batadv_neigh_ifinfo - neighbor information per outgoing interface
716 struct batadv_neigh_ifinfo {
717 /** @list: list node for &batadv_neigh_node.ifinfo_list */
718 struct hlist_node list;
720 /** @if_outgoing: pointer to outgoing hard-interface */
721 struct batadv_hard_iface *if_outgoing;
723 /** @bat_iv: B.A.T.M.A.N. IV private structure */
724 struct batadv_neigh_ifinfo_bat_iv bat_iv;
726 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
727 /** @bat_v: B.A.T.M.A.N. V private data */
728 struct batadv_neigh_ifinfo_bat_v bat_v;
731 /** @last_ttl: last received ttl from this neigh node */
734 /** @refcount: number of contexts the object is used */
735 struct kref refcount;
737 /** @rcu: struct used for freeing in a RCU-safe manner */
741 #ifdef CONFIG_BATMAN_ADV_BLA
744 * struct batadv_bcast_duplist_entry - structure for LAN broadcast suppression
746 struct batadv_bcast_duplist_entry {
747 /** @orig: mac address of orig node originating the broadcast */
750 /** @crc: crc32 checksum of broadcast payload */
753 /** @entrytime: time when the broadcast packet was received */
754 unsigned long entrytime;
759 * enum batadv_counters - indices for traffic counters
761 enum batadv_counters {
762 /** @BATADV_CNT_TX: transmitted payload traffic packet counter */
765 /** @BATADV_CNT_TX_BYTES: transmitted payload traffic bytes counter */
769 * @BATADV_CNT_TX_DROPPED: dropped transmission payload traffic packet
772 BATADV_CNT_TX_DROPPED,
774 /** @BATADV_CNT_RX: received payload traffic packet counter */
777 /** @BATADV_CNT_RX_BYTES: received payload traffic bytes counter */
780 /** @BATADV_CNT_FORWARD: forwarded payload traffic packet counter */
784 * @BATADV_CNT_FORWARD_BYTES: forwarded payload traffic bytes counter
786 BATADV_CNT_FORWARD_BYTES,
789 * @BATADV_CNT_MGMT_TX: transmitted routing protocol traffic packet
795 * @BATADV_CNT_MGMT_TX_BYTES: transmitted routing protocol traffic bytes
798 BATADV_CNT_MGMT_TX_BYTES,
801 * @BATADV_CNT_MGMT_RX: received routing protocol traffic packet counter
806 * @BATADV_CNT_MGMT_RX_BYTES: received routing protocol traffic bytes
809 BATADV_CNT_MGMT_RX_BYTES,
811 /** @BATADV_CNT_FRAG_TX: transmitted fragment traffic packet counter */
815 * @BATADV_CNT_FRAG_TX_BYTES: transmitted fragment traffic bytes counter
817 BATADV_CNT_FRAG_TX_BYTES,
819 /** @BATADV_CNT_FRAG_RX: received fragment traffic packet counter */
823 * @BATADV_CNT_FRAG_RX_BYTES: received fragment traffic bytes counter
825 BATADV_CNT_FRAG_RX_BYTES,
827 /** @BATADV_CNT_FRAG_FWD: forwarded fragment traffic packet counter */
831 * @BATADV_CNT_FRAG_FWD_BYTES: forwarded fragment traffic bytes counter
833 BATADV_CNT_FRAG_FWD_BYTES,
836 * @BATADV_CNT_TT_REQUEST_TX: transmitted tt req traffic packet counter
838 BATADV_CNT_TT_REQUEST_TX,
840 /** @BATADV_CNT_TT_REQUEST_RX: received tt req traffic packet counter */
841 BATADV_CNT_TT_REQUEST_RX,
844 * @BATADV_CNT_TT_RESPONSE_TX: transmitted tt resp traffic packet
847 BATADV_CNT_TT_RESPONSE_TX,
850 * @BATADV_CNT_TT_RESPONSE_RX: received tt resp traffic packet counter
852 BATADV_CNT_TT_RESPONSE_RX,
855 * @BATADV_CNT_TT_ROAM_ADV_TX: transmitted tt roam traffic packet
858 BATADV_CNT_TT_ROAM_ADV_TX,
861 * @BATADV_CNT_TT_ROAM_ADV_RX: received tt roam traffic packet counter
863 BATADV_CNT_TT_ROAM_ADV_RX,
865 #ifdef CONFIG_BATMAN_ADV_DAT
867 * @BATADV_CNT_DAT_GET_TX: transmitted dht GET traffic packet counter
869 BATADV_CNT_DAT_GET_TX,
871 /** @BATADV_CNT_DAT_GET_RX: received dht GET traffic packet counter */
872 BATADV_CNT_DAT_GET_RX,
875 * @BATADV_CNT_DAT_PUT_TX: transmitted dht PUT traffic packet counter
877 BATADV_CNT_DAT_PUT_TX,
879 /** @BATADV_CNT_DAT_PUT_RX: received dht PUT traffic packet counter */
880 BATADV_CNT_DAT_PUT_RX,
883 * @BATADV_CNT_DAT_CACHED_REPLY_TX: transmitted dat cache reply traffic
886 BATADV_CNT_DAT_CACHED_REPLY_TX,
889 #ifdef CONFIG_BATMAN_ADV_NC
891 * @BATADV_CNT_NC_CODE: transmitted nc-combined traffic packet counter
896 * @BATADV_CNT_NC_CODE_BYTES: transmitted nc-combined traffic bytes
899 BATADV_CNT_NC_CODE_BYTES,
902 * @BATADV_CNT_NC_RECODE: transmitted nc-recombined traffic packet
905 BATADV_CNT_NC_RECODE,
908 * @BATADV_CNT_NC_RECODE_BYTES: transmitted nc-recombined traffic bytes
911 BATADV_CNT_NC_RECODE_BYTES,
914 * @BATADV_CNT_NC_BUFFER: counter for packets buffered for later nc
917 BATADV_CNT_NC_BUFFER,
920 * @BATADV_CNT_NC_DECODE: received and nc-decoded traffic packet counter
922 BATADV_CNT_NC_DECODE,
925 * @BATADV_CNT_NC_DECODE_BYTES: received and nc-decoded traffic bytes
928 BATADV_CNT_NC_DECODE_BYTES,
931 * @BATADV_CNT_NC_DECODE_FAILED: received and decode-failed traffic
934 BATADV_CNT_NC_DECODE_FAILED,
937 * @BATADV_CNT_NC_SNIFFED: counter for nc-decoded packets received in
940 BATADV_CNT_NC_SNIFFED,
943 /** @BATADV_CNT_NUM: number of traffic counters */
948 * struct batadv_priv_tt - per mesh interface translation table data
950 struct batadv_priv_tt {
951 /** @vn: translation table version number */
955 * @ogm_append_cnt: counter of number of OGMs containing the local tt
958 atomic_t ogm_append_cnt;
960 /** @local_changes: changes registered in an originator interval */
961 atomic_t local_changes;
964 * @changes_list: tracks tt local changes within an originator interval
966 struct list_head changes_list;
968 /** @local_hash: local translation table hash table */
969 struct batadv_hashtable *local_hash;
971 /** @global_hash: global translation table hash table */
972 struct batadv_hashtable *global_hash;
974 /** @req_list: list of pending & unanswered tt_requests */
975 struct hlist_head req_list;
978 * @roam_list: list of the last roaming events of each client limiting
979 * the number of roaming events to avoid route flapping
981 struct list_head roam_list;
983 /** @changes_list_lock: lock protecting changes_list */
984 spinlock_t changes_list_lock;
986 /** @req_list_lock: lock protecting req_list */
987 spinlock_t req_list_lock;
989 /** @roam_list_lock: lock protecting roam_list */
990 spinlock_t roam_list_lock;
992 /** @last_changeset: last tt changeset this host has generated */
993 unsigned char *last_changeset;
996 * @last_changeset_len: length of last tt changeset this host has
999 s16 last_changeset_len;
1002 * @last_changeset_lock: lock protecting last_changeset &
1003 * last_changeset_len
1005 spinlock_t last_changeset_lock;
1008 * @commit_lock: prevents from executing a local TT commit while reading
1009 * the local table. The local TT commit is made up of two operations
1010 * (data structure update and metadata -CRC/TTVN- recalculation) and
1011 * they have to be executed atomically in order to avoid another thread
1012 * to read the table/metadata between those.
1014 spinlock_t commit_lock;
1016 /** @work: work queue callback item for translation table purging */
1017 struct delayed_work work;
1020 #ifdef CONFIG_BATMAN_ADV_BLA
1023 * struct batadv_priv_bla - per mesh interface bridge loop avoidance data
1025 struct batadv_priv_bla {
1026 /** @num_requests: number of bla requests in flight */
1027 atomic_t num_requests;
1030 * @claim_hash: hash table containing mesh nodes this host has claimed
1032 struct batadv_hashtable *claim_hash;
1035 * @backbone_hash: hash table containing all detected backbone gateways
1037 struct batadv_hashtable *backbone_hash;
1039 /** @loopdetect_addr: MAC address used for own loopdetection frames */
1040 u8 loopdetect_addr[ETH_ALEN];
1043 * @loopdetect_lasttime: time when the loopdetection frames were sent
1045 unsigned long loopdetect_lasttime;
1048 * @loopdetect_next: how many periods to wait for the next loopdetect
1051 atomic_t loopdetect_next;
1054 * @bcast_duplist: recently received broadcast packets array (for
1055 * broadcast duplicate suppression)
1057 struct batadv_bcast_duplist_entry bcast_duplist[BATADV_DUPLIST_SIZE];
1060 * @bcast_duplist_curr: index of last broadcast packet added to
1063 int bcast_duplist_curr;
1066 * @bcast_duplist_lock: lock protecting bcast_duplist &
1067 * bcast_duplist_curr
1069 spinlock_t bcast_duplist_lock;
1071 /** @claim_dest: local claim data (e.g. claim group) */
1072 struct batadv_bla_claim_dst claim_dest;
1074 /** @work: work queue callback item for cleanups & bla announcements */
1075 struct delayed_work work;
1079 #ifdef CONFIG_BATMAN_ADV_DEBUG
1082 * struct batadv_priv_debug_log - debug logging data
1084 struct batadv_priv_debug_log {
1085 /** @log_buff: buffer holding the logs (ring buffer) */
1086 char log_buff[BATADV_LOG_BUF_LEN];
1088 /** @log_start: index of next character to read */
1089 unsigned long log_start;
1091 /** @log_end: index of next character to write */
1092 unsigned long log_end;
1094 /** @lock: lock protecting log_buff, log_start & log_end */
1097 /** @queue_wait: log reader's wait queue */
1098 wait_queue_head_t queue_wait;
1103 * struct batadv_priv_gw - per mesh interface gateway data
1105 struct batadv_priv_gw {
1106 /** @gateway_list: list of available gateway nodes */
1107 struct hlist_head gateway_list;
1109 /** @list_lock: lock protecting gateway_list, curr_gw, generation */
1110 spinlock_t list_lock;
1112 /** @curr_gw: pointer to currently selected gateway node */
1113 struct batadv_gw_node __rcu *curr_gw;
1115 /** @generation: current (generation) sequence number */
1116 unsigned int generation;
1119 * @mode: gateway operation: off, client or server (see batadv_gw_modes)
1123 /** @sel_class: gateway selection class (applies if gw_mode client) */
1127 * @bandwidth_down: advertised uplink download bandwidth (if gw_mode
1130 atomic_t bandwidth_down;
1133 * @bandwidth_up: advertised uplink upload bandwidth (if gw_mode server)
1135 atomic_t bandwidth_up;
1137 /** @reselect: bool indicating a gateway re-selection is in progress */
1142 * struct batadv_priv_tvlv - per mesh interface tvlv data
1144 struct batadv_priv_tvlv {
1146 * @container_list: list of registered tvlv containers to be sent with
1149 struct hlist_head container_list;
1151 /** @handler_list: list of the various tvlv content handlers */
1152 struct hlist_head handler_list;
1154 /** @container_list_lock: protects tvlv container list access */
1155 spinlock_t container_list_lock;
1157 /** @handler_list_lock: protects handler list access */
1158 spinlock_t handler_list_lock;
1161 #ifdef CONFIG_BATMAN_ADV_DAT
1164 * struct batadv_priv_dat - per mesh interface DAT private data
1166 struct batadv_priv_dat {
1167 /** @addr: node DAT address */
1168 batadv_dat_addr_t addr;
1170 /** @hash: hashtable representing the local ARP cache */
1171 struct batadv_hashtable *hash;
1173 /** @work: work queue callback item for cache purging */
1174 struct delayed_work work;
1178 #ifdef CONFIG_BATMAN_ADV_MCAST
1180 * struct batadv_mcast_querier_state - IGMP/MLD querier state when bridged
1182 struct batadv_mcast_querier_state {
1183 /** @exists: whether a querier exists in the mesh */
1184 unsigned char exists:1;
1187 * @shadowing: if a querier exists, whether it is potentially shadowing
1188 * multicast listeners (i.e. querier is behind our own bridge segment)
1190 unsigned char shadowing:1;
1194 * struct batadv_mcast_mla_flags - flags for the querier, bridge and tvlv state
1196 struct batadv_mcast_mla_flags {
1197 /** @querier_ipv4: the current state of an IGMP querier in the mesh */
1198 struct batadv_mcast_querier_state querier_ipv4;
1200 /** @querier_ipv6: the current state of an MLD querier in the mesh */
1201 struct batadv_mcast_querier_state querier_ipv6;
1203 /** @enabled: whether the multicast tvlv is currently enabled */
1204 unsigned char enabled:1;
1206 /** @bridged: whether the soft interface has a bridge on top */
1207 unsigned char bridged:1;
1209 /** @tvlv_flags: the flags we have last sent in our mcast tvlv */
1214 * struct batadv_priv_mcast - per mesh interface mcast data
1216 struct batadv_priv_mcast {
1218 * @mla_list: list of multicast addresses we are currently announcing
1221 struct hlist_head mla_list; /* see __batadv_mcast_mla_update() */
1224 * @want_all_unsnoopables_list: a list of orig_nodes wanting all
1225 * unsnoopable multicast traffic
1227 struct hlist_head want_all_unsnoopables_list;
1230 * @want_all_ipv4_list: a list of orig_nodes wanting all IPv4 multicast
1233 struct hlist_head want_all_ipv4_list;
1236 * @want_all_ipv6_list: a list of orig_nodes wanting all IPv6 multicast
1239 struct hlist_head want_all_ipv6_list;
1242 * @want_all_rtr4_list: a list of orig_nodes wanting all routable IPv4
1245 struct hlist_head want_all_rtr4_list;
1248 * @want_all_rtr6_list: a list of orig_nodes wanting all routable IPv6
1251 struct hlist_head want_all_rtr6_list;
1254 * @mla_flags: flags for the querier, bridge and tvlv state
1256 struct batadv_mcast_mla_flags mla_flags;
1259 * @mla_lock: a lock protecting mla_list and mla_flags
1261 spinlock_t mla_lock;
1264 * @num_want_all_unsnoopables: number of nodes wanting unsnoopable IP
1267 atomic_t num_want_all_unsnoopables;
1269 /** @num_want_all_ipv4: counter for items in want_all_ipv4_list */
1270 atomic_t num_want_all_ipv4;
1272 /** @num_want_all_ipv6: counter for items in want_all_ipv6_list */
1273 atomic_t num_want_all_ipv6;
1275 /** @num_want_all_rtr4: counter for items in want_all_rtr4_list */
1276 atomic_t num_want_all_rtr4;
1278 /** @num_want_all_rtr6: counter for items in want_all_rtr6_list */
1279 atomic_t num_want_all_rtr6;
1282 * @want_lists_lock: lock for protecting modifications to mcasts
1283 * want_all_{unsnoopables,ipv4,ipv6}_list (traversals are rcu-locked)
1285 spinlock_t want_lists_lock;
1287 /** @work: work queue callback item for multicast TT and TVLV updates */
1288 struct delayed_work work;
1293 * struct batadv_priv_nc - per mesh interface network coding private data
1295 struct batadv_priv_nc {
1296 /** @work: work queue callback item for cleanup */
1297 struct delayed_work work;
1300 * @min_tq: only consider neighbors for encoding if neigh_tq > min_tq
1305 * @max_fwd_delay: maximum packet forward delay to allow coding of
1311 * @max_buffer_time: buffer time for sniffed packets used to decoding
1313 u32 max_buffer_time;
1316 * @timestamp_fwd_flush: timestamp of last forward packet queue flush
1318 unsigned long timestamp_fwd_flush;
1321 * @timestamp_sniffed_purge: timestamp of last sniffed packet queue
1324 unsigned long timestamp_sniffed_purge;
1327 * @coding_hash: Hash table used to buffer skbs while waiting for
1328 * another incoming skb to code it with. Skbs are added to the buffer
1329 * just before being forwarded in routing.c
1331 struct batadv_hashtable *coding_hash;
1334 * @decoding_hash: Hash table used to buffer skbs that might be needed
1335 * to decode a received coded skb. The buffer is used for 1) skbs
1336 * arriving on the soft-interface; 2) skbs overheard on the
1337 * hard-interface; and 3) skbs forwarded by batman-adv.
1339 struct batadv_hashtable *decoding_hash;
1343 * struct batadv_tp_unacked - unacked packet meta-information
1345 * This struct is supposed to represent a buffer unacked packet. However, since
1346 * the purpose of the TP meter is to count the traffic only, there is no need to
1347 * store the entire sk_buff, the starting offset and the length are enough
1349 struct batadv_tp_unacked {
1350 /** @seqno: seqno of the unacked packet */
1353 /** @len: length of the packet */
1356 /** @list: list node for &batadv_tp_vars.unacked_list */
1357 struct list_head list;
1361 * enum batadv_tp_meter_role - Modus in tp meter session
1363 enum batadv_tp_meter_role {
1364 /** @BATADV_TP_RECEIVER: Initialized as receiver */
1367 /** @BATADV_TP_SENDER: Initialized as sender */
1372 * struct batadv_tp_vars - tp meter private variables per session
1374 struct batadv_tp_vars {
1375 /** @list: list node for &bat_priv.tp_list */
1376 struct hlist_node list;
1378 /** @timer: timer for ack (receiver) and retry (sender) */
1379 struct timer_list timer;
1381 /** @bat_priv: pointer to the mesh object */
1382 struct batadv_priv *bat_priv;
1384 /** @start_time: start time in jiffies */
1385 unsigned long start_time;
1387 /** @other_end: mac address of remote */
1388 u8 other_end[ETH_ALEN];
1390 /** @role: receiver/sender modi */
1391 enum batadv_tp_meter_role role;
1393 /** @sending: sending binary semaphore: 1 if sending, 0 is not */
1396 /** @reason: reason for a stopped session */
1397 enum batadv_tp_meter_reason reason;
1399 /** @finish_work: work item for the finishing procedure */
1400 struct delayed_work finish_work;
1402 /** @test_length: test length in milliseconds */
1405 /** @session: TP session identifier */
1408 /** @icmp_uid: local ICMP "socket" index */
1411 /* sender variables */
1413 /** @dec_cwnd: decimal part of the cwnd used during linear growth */
1416 /** @cwnd: current size of the congestion window */
1419 /** @cwnd_lock: lock do protect @cwnd & @dec_cwnd */
1420 spinlock_t cwnd_lock;
1423 * @ss_threshold: Slow Start threshold. Once cwnd exceeds this value the
1424 * connection switches to the Congestion Avoidance state
1428 /** @last_acked: last acked byte */
1429 atomic_t last_acked;
1431 /** @last_sent: last sent byte, not yet acked */
1434 /** @tot_sent: amount of data sent/ACKed so far */
1435 atomic64_t tot_sent;
1437 /** @dup_acks: duplicate ACKs counter */
1440 /** @fast_recovery: true if in Fast Recovery mode */
1441 unsigned char fast_recovery:1;
1443 /** @recover: last sent seqno when entering Fast Recovery */
1446 /** @rto: sender timeout */
1449 /** @srtt: smoothed RTT scaled by 2^3 */
1452 /** @rttvar: RTT variation scaled by 2^2 */
1456 * @more_bytes: waiting queue anchor when waiting for more ack/retry
1459 wait_queue_head_t more_bytes;
1461 /** @prerandom_offset: offset inside the prerandom buffer */
1462 u32 prerandom_offset;
1464 /** @prerandom_lock: spinlock protecting access to prerandom_offset */
1465 spinlock_t prerandom_lock;
1467 /* receiver variables */
1469 /** @last_recv: last in-order received packet */
1472 /** @unacked_list: list of unacked packets (meta-info only) */
1473 struct list_head unacked_list;
1475 /** @unacked_lock: protect unacked_list */
1476 spinlock_t unacked_lock;
1478 /** @last_recv_time: time (jiffies) a msg was received */
1479 unsigned long last_recv_time;
1481 /** @refcount: number of context where the object is used */
1482 struct kref refcount;
1484 /** @rcu: struct used for freeing in an RCU-safe manner */
1485 struct rcu_head rcu;
1489 * struct batadv_softif_vlan - per VLAN attributes set
1491 struct batadv_softif_vlan {
1492 /** @bat_priv: pointer to the mesh object */
1493 struct batadv_priv *bat_priv;
1495 /** @vid: VLAN identifier */
1498 /** @ap_isolation: AP isolation state */
1499 atomic_t ap_isolation; /* boolean */
1501 /** @tt: TT private attributes (VLAN specific) */
1502 struct batadv_vlan_tt tt;
1504 /** @list: list node for &bat_priv.softif_vlan_list */
1505 struct hlist_node list;
1508 * @refcount: number of context where this object is currently in use
1510 struct kref refcount;
1512 /** @rcu: struct used for freeing in a RCU-safe manner */
1513 struct rcu_head rcu;
1517 * struct batadv_priv_bat_v - B.A.T.M.A.N. V per soft-interface private data
1519 struct batadv_priv_bat_v {
1520 /** @ogm_buff: buffer holding the OGM packet */
1521 unsigned char *ogm_buff;
1523 /** @ogm_buff_len: length of the OGM packet buffer */
1526 /** @ogm_seqno: OGM sequence number - used to identify each OGM */
1529 /** @ogm_buff_mutex: lock protecting ogm_buff and ogm_buff_len */
1530 struct mutex ogm_buff_mutex;
1532 /** @ogm_wq: workqueue used to schedule OGM transmissions */
1533 struct delayed_work ogm_wq;
1537 * struct batadv_priv - per mesh interface data
1539 struct batadv_priv {
1541 * @mesh_state: current status of the mesh
1542 * (inactive/active/deactivating)
1544 atomic_t mesh_state;
1546 /** @soft_iface: net device which holds this struct as private data */
1547 struct net_device *soft_iface;
1550 * @bat_counters: mesh internal traffic statistic counters (see
1553 u64 __percpu *bat_counters; /* Per cpu counters */
1556 * @aggregated_ogms: bool indicating whether OGM aggregation is enabled
1558 atomic_t aggregated_ogms;
1560 /** @bonding: bool indicating whether traffic bonding is enabled */
1564 * @fragmentation: bool indicating whether traffic fragmentation is
1567 atomic_t fragmentation;
1570 * @packet_size_max: max packet size that can be transmitted via
1571 * multiple fragmented skbs or a single frame if fragmentation is
1574 atomic_t packet_size_max;
1577 * @frag_seqno: incremental counter to identify chains of egress
1580 atomic_t frag_seqno;
1582 #ifdef CONFIG_BATMAN_ADV_BLA
1584 * @bridge_loop_avoidance: bool indicating whether bridge loop
1585 * avoidance is enabled
1587 atomic_t bridge_loop_avoidance;
1590 #ifdef CONFIG_BATMAN_ADV_DAT
1592 * @distributed_arp_table: bool indicating whether distributed ARP table
1595 atomic_t distributed_arp_table;
1598 #ifdef CONFIG_BATMAN_ADV_MCAST
1600 * @multicast_mode: Enable or disable multicast optimizations on this
1601 * node's sender/originating side
1603 atomic_t multicast_mode;
1606 * @multicast_fanout: Maximum number of packet copies to generate for a
1607 * multicast-to-unicast conversion
1609 atomic_t multicast_fanout;
1612 /** @orig_interval: OGM broadcast interval in milliseconds */
1613 atomic_t orig_interval;
1616 * @hop_penalty: penalty which will be applied to an OGM's tq-field on
1619 atomic_t hop_penalty;
1621 #ifdef CONFIG_BATMAN_ADV_DEBUG
1622 /** @log_level: configured log level (see batadv_dbg_level) */
1627 * @isolation_mark: the skb->mark value used to match packets for AP
1633 * @isolation_mark_mask: bitmask identifying the bits in skb->mark to be
1634 * used for the isolation mark
1636 u32 isolation_mark_mask;
1638 /** @bcast_seqno: last sent broadcast packet sequence number */
1639 atomic_t bcast_seqno;
1642 * @bcast_queue_left: number of remaining buffered broadcast packet
1645 atomic_t bcast_queue_left;
1647 /** @batman_queue_left: number of remaining OGM packet slots */
1648 atomic_t batman_queue_left;
1650 /** @forw_bat_list: list of aggregated OGMs that will be forwarded */
1651 struct hlist_head forw_bat_list;
1654 * @forw_bcast_list: list of broadcast packets that will be
1657 struct hlist_head forw_bcast_list;
1659 /** @tp_list: list of tp sessions */
1660 struct hlist_head tp_list;
1662 /** @orig_hash: hash table containing mesh participants (orig nodes) */
1663 struct batadv_hashtable *orig_hash;
1665 /** @forw_bat_list_lock: lock protecting forw_bat_list */
1666 spinlock_t forw_bat_list_lock;
1668 /** @forw_bcast_list_lock: lock protecting forw_bcast_list */
1669 spinlock_t forw_bcast_list_lock;
1671 /** @tp_list_lock: spinlock protecting @tp_list */
1672 spinlock_t tp_list_lock;
1674 /** @tp_num: number of currently active tp sessions */
1677 /** @orig_work: work queue callback item for orig node purging */
1678 struct delayed_work orig_work;
1681 * @primary_if: one of the hard-interfaces assigned to this mesh
1682 * interface becomes the primary interface
1684 struct batadv_hard_iface __rcu *primary_if; /* rcu protected pointer */
1686 /** @algo_ops: routing algorithm used by this mesh interface */
1687 struct batadv_algo_ops *algo_ops;
1690 * @softif_vlan_list: a list of softif_vlan structs, one per VLAN
1691 * created on top of the mesh interface represented by this object
1693 struct hlist_head softif_vlan_list;
1695 /** @softif_vlan_list_lock: lock protecting softif_vlan_list */
1696 spinlock_t softif_vlan_list_lock;
1698 #ifdef CONFIG_BATMAN_ADV_BLA
1699 /** @bla: bridge loop avoidance data */
1700 struct batadv_priv_bla bla;
1703 #ifdef CONFIG_BATMAN_ADV_DEBUG
1704 /** @debug_log: holding debug logging relevant data */
1705 struct batadv_priv_debug_log *debug_log;
1708 /** @gw: gateway data */
1709 struct batadv_priv_gw gw;
1711 /** @tt: translation table data */
1712 struct batadv_priv_tt tt;
1714 /** @tvlv: type-version-length-value data */
1715 struct batadv_priv_tvlv tvlv;
1717 #ifdef CONFIG_BATMAN_ADV_DAT
1718 /** @dat: distributed arp table data */
1719 struct batadv_priv_dat dat;
1722 #ifdef CONFIG_BATMAN_ADV_MCAST
1723 /** @mcast: multicast data */
1724 struct batadv_priv_mcast mcast;
1727 #ifdef CONFIG_BATMAN_ADV_NC
1729 * @network_coding: bool indicating whether network coding is enabled
1731 atomic_t network_coding;
1733 /** @nc: network coding data */
1734 struct batadv_priv_nc nc;
1735 #endif /* CONFIG_BATMAN_ADV_NC */
1737 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
1738 /** @bat_v: B.A.T.M.A.N. V per soft-interface private data */
1739 struct batadv_priv_bat_v bat_v;
1744 * struct batadv_socket_client - layer2 icmp socket client data
1746 struct batadv_socket_client {
1748 * @queue_list: packet queue for packets destined for this socket client
1750 struct list_head queue_list;
1752 /** @queue_len: number of packets in the packet queue (queue_list) */
1753 unsigned int queue_len;
1755 /** @index: socket client's index in the batadv_socket_client_hash */
1756 unsigned char index;
1758 /** @lock: lock protecting queue_list, queue_len & index */
1761 /** @queue_wait: socket client's wait queue */
1762 wait_queue_head_t queue_wait;
1764 /** @bat_priv: pointer to soft_iface this client belongs to */
1765 struct batadv_priv *bat_priv;
1769 * struct batadv_socket_packet - layer2 icmp packet for socket client
1771 struct batadv_socket_packet {
1772 /** @list: list node for &batadv_socket_client.queue_list */
1773 struct list_head list;
1775 /** @icmp_len: size of the layer2 icmp packet */
1778 /** @icmp_packet: layer2 icmp packet */
1779 u8 icmp_packet[BATADV_ICMP_MAX_PACKET_SIZE];
1782 #ifdef CONFIG_BATMAN_ADV_BLA
1785 * struct batadv_bla_backbone_gw - batman-adv gateway bridged into the LAN
1787 struct batadv_bla_backbone_gw {
1789 * @orig: originator address of backbone node (mac address of primary
1794 /** @vid: vlan id this gateway was detected on */
1797 /** @hash_entry: hlist node for &batadv_priv_bla.backbone_hash */
1798 struct hlist_node hash_entry;
1800 /** @bat_priv: pointer to soft_iface this backbone gateway belongs to */
1801 struct batadv_priv *bat_priv;
1803 /** @lasttime: last time we heard of this backbone gw */
1804 unsigned long lasttime;
1807 * @wait_periods: grace time for bridge forward delays and bla group
1808 * forming at bootup phase - no bcast traffic is formwared until it has
1811 atomic_t wait_periods;
1814 * @request_sent: if this bool is set to true we are out of sync with
1815 * this backbone gateway - no bcast traffic is formwared until the
1816 * situation was resolved
1818 atomic_t request_sent;
1820 /** @crc: crc16 checksum over all claims */
1823 /** @crc_lock: lock protecting crc */
1824 spinlock_t crc_lock;
1826 /** @report_work: work struct for reporting detected loops */
1827 struct work_struct report_work;
1829 /** @refcount: number of contexts the object is used */
1830 struct kref refcount;
1832 /** @rcu: struct used for freeing in an RCU-safe manner */
1833 struct rcu_head rcu;
1837 * struct batadv_bla_claim - claimed non-mesh client structure
1839 struct batadv_bla_claim {
1840 /** @addr: mac address of claimed non-mesh client */
1843 /** @vid: vlan id this client was detected on */
1846 /** @backbone_gw: pointer to backbone gw claiming this client */
1847 struct batadv_bla_backbone_gw *backbone_gw;
1849 /** @backbone_lock: lock protecting backbone_gw pointer */
1850 spinlock_t backbone_lock;
1852 /** @lasttime: last time we heard of claim (locals only) */
1853 unsigned long lasttime;
1855 /** @hash_entry: hlist node for &batadv_priv_bla.claim_hash */
1856 struct hlist_node hash_entry;
1858 /** @refcount: number of contexts the object is used */
1859 struct rcu_head rcu;
1861 /** @rcu: struct used for freeing in an RCU-safe manner */
1862 struct kref refcount;
1867 * struct batadv_tt_common_entry - tt local & tt global common data
1869 struct batadv_tt_common_entry {
1870 /** @addr: mac address of non-mesh client */
1873 /** @vid: VLAN identifier */
1877 * @hash_entry: hlist node for &batadv_priv_tt.local_hash or for
1878 * &batadv_priv_tt.global_hash
1880 struct hlist_node hash_entry;
1882 /** @flags: various state handling flags (see batadv_tt_client_flags) */
1885 /** @added_at: timestamp used for purging stale tt common entries */
1886 unsigned long added_at;
1888 /** @refcount: number of contexts the object is used */
1889 struct kref refcount;
1891 /** @rcu: struct used for freeing in an RCU-safe manner */
1892 struct rcu_head rcu;
1896 * struct batadv_tt_local_entry - translation table local entry data
1898 struct batadv_tt_local_entry {
1899 /** @common: general translation table data */
1900 struct batadv_tt_common_entry common;
1902 /** @last_seen: timestamp used for purging stale tt local entries */
1903 unsigned long last_seen;
1905 /** @vlan: soft-interface vlan of the entry */
1906 struct batadv_softif_vlan *vlan;
1910 * struct batadv_tt_global_entry - translation table global entry data
1912 struct batadv_tt_global_entry {
1913 /** @common: general translation table data */
1914 struct batadv_tt_common_entry common;
1916 /** @orig_list: list of orig nodes announcing this non-mesh client */
1917 struct hlist_head orig_list;
1919 /** @orig_list_count: number of items in the orig_list */
1920 atomic_t orig_list_count;
1922 /** @list_lock: lock protecting orig_list */
1923 spinlock_t list_lock;
1925 /** @roam_at: time at which TT_GLOBAL_ROAM was set */
1926 unsigned long roam_at;
1930 * struct batadv_tt_orig_list_entry - orig node announcing a non-mesh client
1932 struct batadv_tt_orig_list_entry {
1933 /** @orig_node: pointer to orig node announcing this non-mesh client */
1934 struct batadv_orig_node *orig_node;
1937 * @ttvn: translation table version number which added the non-mesh
1942 /** @flags: per orig entry TT sync flags */
1945 /** @list: list node for &batadv_tt_global_entry.orig_list */
1946 struct hlist_node list;
1948 /** @refcount: number of contexts the object is used */
1949 struct kref refcount;
1951 /** @rcu: struct used for freeing in an RCU-safe manner */
1952 struct rcu_head rcu;
1956 * struct batadv_tt_change_node - structure for tt changes occurred
1958 struct batadv_tt_change_node {
1959 /** @list: list node for &batadv_priv_tt.changes_list */
1960 struct list_head list;
1962 /** @change: holds the actual translation table diff data */
1963 struct batadv_tvlv_tt_change change;
1967 * struct batadv_tt_req_node - data to keep track of the tt requests in flight
1969 struct batadv_tt_req_node {
1971 * @addr: mac address of the originator this request was sent to
1975 /** @issued_at: timestamp used for purging stale tt requests */
1976 unsigned long issued_at;
1978 /** @refcount: number of contexts the object is used by */
1979 struct kref refcount;
1981 /** @list: list node for &batadv_priv_tt.req_list */
1982 struct hlist_node list;
1986 * struct batadv_tt_roam_node - roaming client data
1988 struct batadv_tt_roam_node {
1989 /** @addr: mac address of the client in the roaming phase */
1993 * @counter: number of allowed roaming events per client within a single
1994 * OGM interval (changes are committed with each OGM)
1999 * @first_time: timestamp used for purging stale roaming node entries
2001 unsigned long first_time;
2003 /** @list: list node for &batadv_priv_tt.roam_list */
2004 struct list_head list;
2008 * struct batadv_nc_node - network coding node
2010 struct batadv_nc_node {
2011 /** @list: next and prev pointer for the list handling */
2012 struct list_head list;
2014 /** @addr: the node's mac address */
2017 /** @refcount: number of contexts the object is used by */
2018 struct kref refcount;
2020 /** @rcu: struct used for freeing in an RCU-safe manner */
2021 struct rcu_head rcu;
2023 /** @orig_node: pointer to corresponding orig node struct */
2024 struct batadv_orig_node *orig_node;
2026 /** @last_seen: timestamp of last ogm received from this node */
2027 unsigned long last_seen;
2031 * struct batadv_nc_path - network coding path
2033 struct batadv_nc_path {
2034 /** @hash_entry: next and prev pointer for the list handling */
2035 struct hlist_node hash_entry;
2037 /** @rcu: struct used for freeing in an RCU-safe manner */
2038 struct rcu_head rcu;
2040 /** @refcount: number of contexts the object is used by */
2041 struct kref refcount;
2043 /** @packet_list: list of buffered packets for this path */
2044 struct list_head packet_list;
2046 /** @packet_list_lock: access lock for packet list */
2047 spinlock_t packet_list_lock;
2049 /** @next_hop: next hop (destination) of path */
2050 u8 next_hop[ETH_ALEN];
2052 /** @prev_hop: previous hop (source) of path */
2053 u8 prev_hop[ETH_ALEN];
2055 /** @last_valid: timestamp for last validation of path */
2056 unsigned long last_valid;
2060 * struct batadv_nc_packet - network coding packet used when coding and
2063 struct batadv_nc_packet {
2064 /** @list: next and prev pointer for the list handling */
2065 struct list_head list;
2067 /** @packet_id: crc32 checksum of skb data */
2071 * @timestamp: field containing the info when the packet was added to
2074 unsigned long timestamp;
2076 /** @neigh_node: pointer to original next hop neighbor of skb */
2077 struct batadv_neigh_node *neigh_node;
2079 /** @skb: skb which can be encoded or used for decoding */
2080 struct sk_buff *skb;
2082 /** @nc_path: pointer to path this nc packet is attached to */
2083 struct batadv_nc_path *nc_path;
2087 * struct batadv_skb_cb - control buffer structure used to store private data
2088 * relevant to batman-adv in the skb->cb buffer in skbs.
2090 struct batadv_skb_cb {
2092 * @decoded: Marks a skb as decoded, which is checked when searching for
2093 * coding opportunities in network-coding.c
2095 unsigned char decoded:1;
2097 /** @num_bcasts: Counter for broadcast packet retransmissions */
2098 unsigned char num_bcasts;
2102 * struct batadv_forw_packet - structure for bcast packets to be sent/forwarded
2104 struct batadv_forw_packet {
2106 * @list: list node for &batadv_priv.forw.bcast_list and
2107 * &batadv_priv.forw.bat_list
2109 struct hlist_node list;
2111 /** @cleanup_list: list node for purging functions */
2112 struct hlist_node cleanup_list;
2114 /** @send_time: execution time for delayed_work (packet sending) */
2115 unsigned long send_time;
2118 * @own: bool for locally generated packets (local OGMs are re-scheduled
2123 /** @skb: bcast packet's skb buffer */
2124 struct sk_buff *skb;
2126 /** @packet_len: size of aggregated OGM packet inside the skb buffer */
2129 /** @direct_link_flags: direct link flags for aggregated OGM packets */
2130 u32 direct_link_flags;
2132 /** @num_packets: counter for aggregated OGMv1 packets */
2135 /** @delayed_work: work queue callback item for packet sending */
2136 struct delayed_work delayed_work;
2139 * @if_incoming: pointer to incoming hard-iface or primary iface if
2140 * locally generated packet
2142 struct batadv_hard_iface *if_incoming;
2145 * @if_outgoing: packet where the packet should be sent to, or NULL if
2148 struct batadv_hard_iface *if_outgoing;
2150 /** @queue_left: The queue (counter) this packet was applied to */
2151 atomic_t *queue_left;
2155 * struct batadv_algo_iface_ops - mesh algorithm callbacks (interface specific)
2157 struct batadv_algo_iface_ops {
2159 * @activate: start routing mechanisms when hard-interface is brought up
2162 void (*activate)(struct batadv_hard_iface *hard_iface);
2164 /** @enable: init routing info when hard-interface is enabled */
2165 int (*enable)(struct batadv_hard_iface *hard_iface);
2167 /** @enabled: notification when hard-interface was enabled (optional) */
2168 void (*enabled)(struct batadv_hard_iface *hard_iface);
2170 /** @disable: de-init routing info when hard-interface is disabled */
2171 void (*disable)(struct batadv_hard_iface *hard_iface);
2174 * @update_mac: (re-)init mac addresses of the protocol information
2175 * belonging to this hard-interface
2177 void (*update_mac)(struct batadv_hard_iface *hard_iface);
2179 /** @primary_set: called when primary interface is selected / changed */
2180 void (*primary_set)(struct batadv_hard_iface *hard_iface);
2184 * struct batadv_algo_neigh_ops - mesh algorithm callbacks (neighbour specific)
2186 struct batadv_algo_neigh_ops {
2187 /** @hardif_init: called on creation of single hop entry (optional) */
2188 void (*hardif_init)(struct batadv_hardif_neigh_node *neigh);
2191 * @cmp: compare the metrics of two neighbors for their respective
2192 * outgoing interfaces
2194 int (*cmp)(struct batadv_neigh_node *neigh1,
2195 struct batadv_hard_iface *if_outgoing1,
2196 struct batadv_neigh_node *neigh2,
2197 struct batadv_hard_iface *if_outgoing2);
2200 * @is_similar_or_better: check if neigh1 is equally similar or better
2201 * than neigh2 for their respective outgoing interface from the metric
2204 bool (*is_similar_or_better)(struct batadv_neigh_node *neigh1,
2205 struct batadv_hard_iface *if_outgoing1,
2206 struct batadv_neigh_node *neigh2,
2207 struct batadv_hard_iface *if_outgoing2);
2209 /** @dump: dump neighbors to a netlink socket (optional) */
2210 void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
2211 struct batadv_priv *priv,
2212 struct batadv_hard_iface *hard_iface);
2216 * struct batadv_algo_orig_ops - mesh algorithm callbacks (originator specific)
2218 struct batadv_algo_orig_ops {
2219 /** @dump: dump originators to a netlink socket (optional) */
2220 void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
2221 struct batadv_priv *priv,
2222 struct batadv_hard_iface *hard_iface);
2226 * struct batadv_algo_gw_ops - mesh algorithm callbacks (GW specific)
2228 struct batadv_algo_gw_ops {
2229 /** @init_sel_class: initialize GW selection class (optional) */
2230 void (*init_sel_class)(struct batadv_priv *bat_priv);
2233 * @store_sel_class: parse and stores a new GW selection class
2236 ssize_t (*store_sel_class)(struct batadv_priv *bat_priv, char *buff,
2239 * @get_best_gw_node: select the best GW from the list of available
2242 struct batadv_gw_node *(*get_best_gw_node)
2243 (struct batadv_priv *bat_priv);
2246 * @is_eligible: check if a newly discovered GW is a potential candidate
2247 * for the election as best GW (optional)
2249 bool (*is_eligible)(struct batadv_priv *bat_priv,
2250 struct batadv_orig_node *curr_gw_orig,
2251 struct batadv_orig_node *orig_node);
2253 /** @dump: dump gateways to a netlink socket (optional) */
2254 void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
2255 struct batadv_priv *priv);
2259 * struct batadv_algo_ops - mesh algorithm callbacks
2261 struct batadv_algo_ops {
2262 /** @list: list node for the batadv_algo_list */
2263 struct hlist_node list;
2265 /** @name: name of the algorithm */
2268 /** @iface: callbacks related to interface handling */
2269 struct batadv_algo_iface_ops iface;
2271 /** @neigh: callbacks related to neighbors handling */
2272 struct batadv_algo_neigh_ops neigh;
2274 /** @orig: callbacks related to originators handling */
2275 struct batadv_algo_orig_ops orig;
2277 /** @gw: callbacks related to GW mode */
2278 struct batadv_algo_gw_ops gw;
2282 * struct batadv_dat_entry - it is a single entry of batman-adv ARP backend. It
2283 * is used to stored ARP entries needed for the global DAT cache
2285 struct batadv_dat_entry {
2286 /** @ip: the IPv4 corresponding to this DAT/ARP entry */
2289 /** @mac_addr: the MAC address associated to the stored IPv4 */
2290 u8 mac_addr[ETH_ALEN];
2292 /** @vid: the vlan ID associated to this entry */
2296 * @last_update: time in jiffies when this entry was refreshed last time
2298 unsigned long last_update;
2300 /** @hash_entry: hlist node for &batadv_priv_dat.hash */
2301 struct hlist_node hash_entry;
2303 /** @refcount: number of contexts the object is used */
2304 struct kref refcount;
2306 /** @rcu: struct used for freeing in an RCU-safe manner */
2307 struct rcu_head rcu;
2311 * struct batadv_hw_addr - a list entry for a MAC address
2313 struct batadv_hw_addr {
2314 /** @list: list node for the linking of entries */
2315 struct hlist_node list;
2317 /** @addr: the MAC address of this list entry */
2318 unsigned char addr[ETH_ALEN];
2322 * struct batadv_dat_candidate - candidate destination for DAT operations
2324 struct batadv_dat_candidate {
2326 * @type: the type of the selected candidate. It can one of the
2328 * - BATADV_DAT_CANDIDATE_NOT_FOUND
2329 * - BATADV_DAT_CANDIDATE_ORIG
2334 * @orig_node: if type is BATADV_DAT_CANDIDATE_ORIG this field points to
2335 * the corresponding originator node structure
2337 struct batadv_orig_node *orig_node;
2341 * struct batadv_tvlv_container - container for tvlv appended to OGMs
2343 struct batadv_tvlv_container {
2344 /** @list: hlist node for &batadv_priv_tvlv.container_list */
2345 struct hlist_node list;
2347 /** @tvlv_hdr: tvlv header information needed to construct the tvlv */
2348 struct batadv_tvlv_hdr tvlv_hdr;
2350 /** @refcount: number of contexts the object is used */
2351 struct kref refcount;
2355 * struct batadv_tvlv_handler - handler for specific tvlv type and version
2357 struct batadv_tvlv_handler {
2358 /** @list: hlist node for &batadv_priv_tvlv.handler_list */
2359 struct hlist_node list;
2362 * @ogm_handler: handler callback which is given the tvlv payload to
2363 * process on incoming OGM packets
2365 void (*ogm_handler)(struct batadv_priv *bat_priv,
2366 struct batadv_orig_node *orig,
2367 u8 flags, void *tvlv_value, u16 tvlv_value_len);
2370 * @unicast_handler: handler callback which is given the tvlv payload to
2371 * process on incoming unicast tvlv packets
2373 int (*unicast_handler)(struct batadv_priv *bat_priv,
2375 void *tvlv_value, u16 tvlv_value_len);
2377 /** @type: tvlv type this handler feels responsible for */
2380 /** @version: tvlv version this handler feels responsible for */
2383 /** @flags: tvlv handler flags */
2386 /** @refcount: number of contexts the object is used */
2387 struct kref refcount;
2389 /** @rcu: struct used for freeing in an RCU-safe manner */
2390 struct rcu_head rcu;
2394 * enum batadv_tvlv_handler_flags - tvlv handler flags definitions
2396 enum batadv_tvlv_handler_flags {
2398 * @BATADV_TVLV_HANDLER_OGM_CIFNOTFND: tvlv ogm processing function
2399 * will call this handler even if its type was not found (with no data)
2401 BATADV_TVLV_HANDLER_OGM_CIFNOTFND = BIT(1),
2404 * @BATADV_TVLV_HANDLER_OGM_CALLED: interval tvlv handling flag - the
2405 * API marks a handler as being called, so it won't be called if the
2406 * BATADV_TVLV_HANDLER_OGM_CIFNOTFND flag was set
2408 BATADV_TVLV_HANDLER_OGM_CALLED = BIT(2),
2411 #endif /* _NET_BATMAN_ADV_TYPES_H_ */