1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright (C) 2007-2019 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/netdevice.h>
21 #include <linux/netlink.h>
22 #include <linux/sched.h> /* for linux/wait.h */
23 #include <linux/seq_file.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 */
87 * enum batadv_v_hard_iface_flags - interface flags useful to B.A.T.M.A.N. V
89 enum batadv_v_hard_iface_flags {
91 * @BATADV_FULL_DUPLEX: tells if the connection over this link is
94 BATADV_FULL_DUPLEX = BIT(0),
97 * @BATADV_WARNING_DEFAULT: tells whether we have warned the user that
98 * no throughput data is available for this interface and that default
101 BATADV_WARNING_DEFAULT = BIT(1),
105 * struct batadv_hard_iface_bat_v - per hard-interface B.A.T.M.A.N. V data
107 struct batadv_hard_iface_bat_v {
108 /** @elp_interval: time interval between two ELP transmissions */
109 atomic_t elp_interval;
111 /** @elp_seqno: current ELP sequence number */
114 /** @elp_skb: base skb containing the ELP message to send */
115 struct sk_buff *elp_skb;
117 /** @elp_wq: workqueue used to schedule ELP transmissions */
118 struct delayed_work elp_wq;
120 /** @aggr_wq: workqueue used to transmit queued OGM packets */
121 struct delayed_work aggr_wq;
123 /** @aggr_list: queue for to be aggregated OGM packets */
124 struct sk_buff_head aggr_list;
126 /** @aggr_len: size of the OGM aggregate (excluding ethernet header) */
127 unsigned int aggr_len;
129 /** @aggr_list_lock: protects aggr_list */
130 spinlock_t aggr_list_lock;
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 /** @hardif_obj: kobject of the per interface sysfs "mesh" directory */
190 struct kobject *hardif_obj;
192 /** @refcount: number of contexts the object is used */
193 struct kref refcount;
196 * @batman_adv_ptype: packet type describing packets that should be
197 * processed by batman-adv for this interface
199 struct packet_type batman_adv_ptype;
202 * @soft_iface: the batman-adv interface which uses this network
205 struct net_device *soft_iface;
207 /** @rcu: struct used for freeing in an RCU-safe manner */
210 /** @bat_iv: per hard-interface B.A.T.M.A.N. IV data */
211 struct batadv_hard_iface_bat_iv bat_iv;
213 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
214 /** @bat_v: per hard-interface B.A.T.M.A.N. V data */
215 struct batadv_hard_iface_bat_v bat_v;
218 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
220 * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
222 struct dentry *debug_dir;
226 * @neigh_list: list of unique single hop neighbors via this interface
228 struct hlist_head neigh_list;
230 /** @neigh_list_lock: lock protecting neigh_list */
231 spinlock_t neigh_list_lock;
235 * struct batadv_orig_ifinfo - B.A.T.M.A.N. IV private orig_ifinfo members
237 struct batadv_orig_ifinfo_bat_iv {
239 * @bcast_own: bitfield which counts the number of our OGMs this
240 * orig_node rebroadcasted "back" to us (relative to last_real_seqno)
242 DECLARE_BITMAP(bcast_own, BATADV_TQ_LOCAL_WINDOW_SIZE);
244 /** @bcast_own_sum: sum of bcast_own */
249 * struct batadv_orig_ifinfo - originator info per outgoing interface
251 struct batadv_orig_ifinfo {
252 /** @list: list node for &batadv_orig_node.ifinfo_list */
253 struct hlist_node list;
255 /** @if_outgoing: pointer to outgoing hard-interface */
256 struct batadv_hard_iface *if_outgoing;
258 /** @router: router that should be used to reach this originator */
259 struct batadv_neigh_node __rcu *router;
261 /** @last_real_seqno: last and best known sequence number */
264 /** @last_ttl: ttl of last received packet */
267 /** @last_seqno_forwarded: seqno of the OGM which was forwarded last */
268 u32 last_seqno_forwarded;
270 /** @batman_seqno_reset: time when the batman seqno window was reset */
271 unsigned long batman_seqno_reset;
273 /** @bat_iv: B.A.T.M.A.N. IV private structure */
274 struct batadv_orig_ifinfo_bat_iv bat_iv;
276 /** @refcount: number of contexts the object is used */
277 struct kref refcount;
279 /** @rcu: struct used for freeing in an RCU-safe manner */
284 * struct batadv_frag_table_entry - head in the fragment buffer table
286 struct batadv_frag_table_entry {
287 /** @fragment_list: head of list with fragments */
288 struct hlist_head fragment_list;
290 /** @lock: lock to protect the list of fragments */
293 /** @timestamp: time (jiffie) of last received fragment */
294 unsigned long timestamp;
296 /** @seqno: sequence number of the fragments in the list */
299 /** @size: accumulated size of packets in list */
302 /** @total_size: expected size of the assembled packet */
307 * struct batadv_frag_list_entry - entry in a list of fragments
309 struct batadv_frag_list_entry {
310 /** @list: list node information */
311 struct hlist_node list;
313 /** @skb: fragment */
316 /** @no: fragment number in the set */
321 * struct batadv_vlan_tt - VLAN specific TT attributes
323 struct batadv_vlan_tt {
324 /** @crc: CRC32 checksum of the entries belonging to this vlan */
327 /** @num_entries: number of TT entries for this VLAN */
328 atomic_t num_entries;
332 * struct batadv_orig_node_vlan - VLAN specific data per orig_node
334 struct batadv_orig_node_vlan {
335 /** @vid: the VLAN identifier */
338 /** @tt: VLAN specific TT attributes */
339 struct batadv_vlan_tt tt;
341 /** @list: list node for &batadv_orig_node.vlan_list */
342 struct hlist_node list;
345 * @refcount: number of context where this object is currently in use
347 struct kref refcount;
349 /** @rcu: struct used for freeing in a RCU-safe manner */
354 * struct batadv_orig_bat_iv - B.A.T.M.A.N. IV private orig_node members
356 struct batadv_orig_bat_iv {
358 * @ogm_cnt_lock: lock protecting &batadv_orig_ifinfo_bat_iv.bcast_own,
359 * &batadv_orig_ifinfo_bat_iv.bcast_own_sum,
360 * &batadv_neigh_ifinfo_bat_iv.bat_iv.real_bits and
361 * &batadv_neigh_ifinfo_bat_iv.real_packet_count
363 spinlock_t ogm_cnt_lock;
367 * struct batadv_orig_node - structure for orig_list maintaining nodes of mesh
369 struct batadv_orig_node {
370 /** @orig: originator ethernet address */
373 /** @ifinfo_list: list for routers per outgoing interface */
374 struct hlist_head ifinfo_list;
377 * @last_bonding_candidate: pointer to last ifinfo of last used router
379 struct batadv_orig_ifinfo *last_bonding_candidate;
381 #ifdef CONFIG_BATMAN_ADV_DAT
382 /** @dat_addr: address of the orig node in the distributed hash */
383 batadv_dat_addr_t dat_addr;
386 /** @last_seen: time when last packet from this node was received */
387 unsigned long last_seen;
390 * @bcast_seqno_reset: time when the broadcast seqno window was reset
392 unsigned long bcast_seqno_reset;
394 #ifdef CONFIG_BATMAN_ADV_MCAST
396 * @mcast_handler_lock: synchronizes mcast-capability and -flag changes
398 spinlock_t mcast_handler_lock;
400 /** @mcast_flags: multicast flags announced by the orig node */
404 * @mcast_want_all_unsnoopables_node: a list node for the
405 * mcast.want_all_unsnoopables list
407 struct hlist_node mcast_want_all_unsnoopables_node;
410 * @mcast_want_all_ipv4_node: a list node for the mcast.want_all_ipv4
413 struct hlist_node mcast_want_all_ipv4_node;
415 * @mcast_want_all_ipv6_node: a list node for the mcast.want_all_ipv6
418 struct hlist_node mcast_want_all_ipv6_node;
421 * @mcast_want_all_rtr4_node: a list node for the mcast.want_all_rtr4
424 struct hlist_node mcast_want_all_rtr4_node;
426 * @mcast_want_all_rtr6_node: a list node for the mcast.want_all_rtr6
429 struct hlist_node mcast_want_all_rtr6_node;
432 /** @capabilities: announced capabilities of this originator */
433 unsigned long capabilities;
436 * @capa_initialized: bitfield to remember whether a capability was
439 unsigned long capa_initialized;
441 /** @last_ttvn: last seen translation table version number */
444 /** @tt_buff: last tt changeset this node received from the orig node */
445 unsigned char *tt_buff;
448 * @tt_buff_len: length of the last tt changeset this node received
453 /** @tt_buff_lock: lock that protects tt_buff and tt_buff_len */
454 spinlock_t tt_buff_lock;
457 * @tt_lock: prevents from updating the table while reading it. Table
458 * update is made up by two operations (data structure update and
459 * metdata -CRC/TTVN-recalculation) and they have to be executed
460 * atomically in order to avoid another thread to read the
461 * table/metadata between those.
466 * @bcast_bits: bitfield containing the info which payload broadcast
467 * originated from this orig node this host already has seen (relative
468 * to last_bcast_seqno)
470 DECLARE_BITMAP(bcast_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
473 * @last_bcast_seqno: last broadcast sequence number received by this
476 u32 last_bcast_seqno;
479 * @neigh_list: list of potential next hop neighbor towards this orig
482 struct hlist_head neigh_list;
485 * @neigh_list_lock: lock protecting neigh_list, ifinfo_list,
486 * last_bonding_candidate and router
488 spinlock_t neigh_list_lock;
490 /** @hash_entry: hlist node for &batadv_priv.orig_hash */
491 struct hlist_node hash_entry;
493 /** @bat_priv: pointer to soft_iface this orig node belongs to */
494 struct batadv_priv *bat_priv;
496 /** @bcast_seqno_lock: lock protecting bcast_bits & last_bcast_seqno */
497 spinlock_t bcast_seqno_lock;
499 /** @refcount: number of contexts the object is used */
500 struct kref refcount;
502 /** @rcu: struct used for freeing in an RCU-safe manner */
505 #ifdef CONFIG_BATMAN_ADV_NC
506 /** @in_coding_list: list of nodes this orig can hear */
507 struct list_head in_coding_list;
509 /** @out_coding_list: list of nodes that can hear this orig */
510 struct list_head out_coding_list;
512 /** @in_coding_list_lock: protects in_coding_list */
513 spinlock_t in_coding_list_lock;
515 /** @out_coding_list_lock: protects out_coding_list */
516 spinlock_t out_coding_list_lock;
519 /** @fragments: array with heads for fragment chains */
520 struct batadv_frag_table_entry fragments[BATADV_FRAG_BUFFER_COUNT];
523 * @vlan_list: a list of orig_node_vlan structs, one per VLAN served by
524 * the originator represented by this object
526 struct hlist_head vlan_list;
528 /** @vlan_list_lock: lock protecting vlan_list */
529 spinlock_t vlan_list_lock;
531 /** @bat_iv: B.A.T.M.A.N. IV private structure */
532 struct batadv_orig_bat_iv bat_iv;
536 * enum batadv_orig_capabilities - orig node capabilities
538 enum batadv_orig_capabilities {
540 * @BATADV_ORIG_CAPA_HAS_DAT: orig node has distributed arp table
543 BATADV_ORIG_CAPA_HAS_DAT,
545 /** @BATADV_ORIG_CAPA_HAS_NC: orig node has network coding enabled */
546 BATADV_ORIG_CAPA_HAS_NC,
548 /** @BATADV_ORIG_CAPA_HAS_TT: orig node has tt capability */
549 BATADV_ORIG_CAPA_HAS_TT,
552 * @BATADV_ORIG_CAPA_HAS_MCAST: orig node has some multicast capability
553 * (= orig node announces a tvlv of type BATADV_TVLV_MCAST)
555 BATADV_ORIG_CAPA_HAS_MCAST,
559 * struct batadv_gw_node - structure for orig nodes announcing gw capabilities
561 struct batadv_gw_node {
562 /** @list: list node for &batadv_priv_gw.list */
563 struct hlist_node list;
565 /** @orig_node: pointer to corresponding orig node */
566 struct batadv_orig_node *orig_node;
568 /** @bandwidth_down: advertised uplink download bandwidth */
571 /** @bandwidth_up: advertised uplink upload bandwidth */
574 /** @refcount: number of contexts the object is used */
575 struct kref refcount;
577 /** @rcu: struct used for freeing in an RCU-safe manner */
581 DECLARE_EWMA(throughput, 10, 8)
584 * struct batadv_hardif_neigh_node_bat_v - B.A.T.M.A.N. V private neighbor
587 struct batadv_hardif_neigh_node_bat_v {
588 /** @throughput: ewma link throughput towards this neighbor */
589 struct ewma_throughput throughput;
591 /** @elp_interval: time interval between two ELP transmissions */
594 /** @elp_latest_seqno: latest and best known ELP sequence number */
595 u32 elp_latest_seqno;
598 * @last_unicast_tx: when the last unicast packet has been sent to this
601 unsigned long last_unicast_tx;
603 /** @metric_work: work queue callback item for metric update */
604 struct work_struct metric_work;
608 * struct batadv_hardif_neigh_node - unique neighbor per hard-interface
610 struct batadv_hardif_neigh_node {
611 /** @list: list node for &batadv_hard_iface.neigh_list */
612 struct hlist_node list;
614 /** @addr: the MAC address of the neighboring interface */
618 * @orig: the address of the originator this neighbor node belongs to
622 /** @if_incoming: pointer to incoming hard-interface */
623 struct batadv_hard_iface *if_incoming;
625 /** @last_seen: when last packet via this neighbor was received */
626 unsigned long last_seen;
628 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
629 /** @bat_v: B.A.T.M.A.N. V private data */
630 struct batadv_hardif_neigh_node_bat_v bat_v;
633 /** @refcount: number of contexts the object is used */
634 struct kref refcount;
636 /** @rcu: struct used for freeing in a RCU-safe manner */
641 * struct batadv_neigh_node - structure for single hops neighbors
643 struct batadv_neigh_node {
644 /** @list: list node for &batadv_orig_node.neigh_list */
645 struct hlist_node list;
647 /** @orig_node: pointer to corresponding orig_node */
648 struct batadv_orig_node *orig_node;
650 /** @addr: the MAC address of the neighboring interface */
653 /** @ifinfo_list: list for routing metrics per outgoing interface */
654 struct hlist_head ifinfo_list;
656 /** @ifinfo_lock: lock protecting ifinfo_list and its members */
657 spinlock_t ifinfo_lock;
659 /** @if_incoming: pointer to incoming hard-interface */
660 struct batadv_hard_iface *if_incoming;
662 /** @last_seen: when last packet via this neighbor was received */
663 unsigned long last_seen;
665 /** @hardif_neigh: hardif_neigh of this neighbor */
666 struct batadv_hardif_neigh_node *hardif_neigh;
668 /** @refcount: number of contexts the object is used */
669 struct kref refcount;
671 /** @rcu: struct used for freeing in an RCU-safe manner */
676 * struct batadv_neigh_ifinfo_bat_iv - neighbor information per outgoing
677 * interface for B.A.T.M.A.N. IV
679 struct batadv_neigh_ifinfo_bat_iv {
680 /** @tq_recv: ring buffer of received TQ values from this neigh node */
681 u8 tq_recv[BATADV_TQ_GLOBAL_WINDOW_SIZE];
683 /** @tq_index: ring buffer index */
687 * @tq_avg: averaged tq of all tq values in the ring buffer (tq_recv)
692 * @real_bits: bitfield containing the number of OGMs received from this
693 * neigh node (relative to orig_node->last_real_seqno)
695 DECLARE_BITMAP(real_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
697 /** @real_packet_count: counted result of real_bits */
698 u8 real_packet_count;
702 * struct batadv_neigh_ifinfo_bat_v - neighbor information per outgoing
703 * interface for B.A.T.M.A.N. V
705 struct batadv_neigh_ifinfo_bat_v {
707 * @throughput: last throughput metric received from originator via this
712 /** @last_seqno: last sequence number known for this neighbor */
717 * struct batadv_neigh_ifinfo - neighbor information per outgoing interface
719 struct batadv_neigh_ifinfo {
720 /** @list: list node for &batadv_neigh_node.ifinfo_list */
721 struct hlist_node list;
723 /** @if_outgoing: pointer to outgoing hard-interface */
724 struct batadv_hard_iface *if_outgoing;
726 /** @bat_iv: B.A.T.M.A.N. IV private structure */
727 struct batadv_neigh_ifinfo_bat_iv bat_iv;
729 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
730 /** @bat_v: B.A.T.M.A.N. V private data */
731 struct batadv_neigh_ifinfo_bat_v bat_v;
734 /** @last_ttl: last received ttl from this neigh node */
737 /** @refcount: number of contexts the object is used */
738 struct kref refcount;
740 /** @rcu: struct used for freeing in a RCU-safe manner */
744 #ifdef CONFIG_BATMAN_ADV_BLA
747 * struct batadv_bcast_duplist_entry - structure for LAN broadcast suppression
749 struct batadv_bcast_duplist_entry {
750 /** @orig: mac address of orig node orginating the broadcast */
753 /** @crc: crc32 checksum of broadcast payload */
756 /** @entrytime: time when the broadcast packet was received */
757 unsigned long entrytime;
762 * enum batadv_counters - indices for traffic counters
764 enum batadv_counters {
765 /** @BATADV_CNT_TX: transmitted payload traffic packet counter */
768 /** @BATADV_CNT_TX_BYTES: transmitted payload traffic bytes counter */
772 * @BATADV_CNT_TX_DROPPED: dropped transmission payload traffic packet
775 BATADV_CNT_TX_DROPPED,
777 /** @BATADV_CNT_RX: received payload traffic packet counter */
780 /** @BATADV_CNT_RX_BYTES: received payload traffic bytes counter */
783 /** @BATADV_CNT_FORWARD: forwarded payload traffic packet counter */
787 * @BATADV_CNT_FORWARD_BYTES: forwarded payload traffic bytes counter
789 BATADV_CNT_FORWARD_BYTES,
792 * @BATADV_CNT_MGMT_TX: transmitted routing protocol traffic packet
798 * @BATADV_CNT_MGMT_TX_BYTES: transmitted routing protocol traffic bytes
801 BATADV_CNT_MGMT_TX_BYTES,
804 * @BATADV_CNT_MGMT_RX: received routing protocol traffic packet counter
809 * @BATADV_CNT_MGMT_RX_BYTES: received routing protocol traffic bytes
812 BATADV_CNT_MGMT_RX_BYTES,
814 /** @BATADV_CNT_FRAG_TX: transmitted fragment traffic packet counter */
818 * @BATADV_CNT_FRAG_TX_BYTES: transmitted fragment traffic bytes counter
820 BATADV_CNT_FRAG_TX_BYTES,
822 /** @BATADV_CNT_FRAG_RX: received fragment traffic packet counter */
826 * @BATADV_CNT_FRAG_RX_BYTES: received fragment traffic bytes counter
828 BATADV_CNT_FRAG_RX_BYTES,
830 /** @BATADV_CNT_FRAG_FWD: forwarded fragment traffic packet counter */
834 * @BATADV_CNT_FRAG_FWD_BYTES: forwarded fragment traffic bytes counter
836 BATADV_CNT_FRAG_FWD_BYTES,
839 * @BATADV_CNT_TT_REQUEST_TX: transmitted tt req traffic packet counter
841 BATADV_CNT_TT_REQUEST_TX,
843 /** @BATADV_CNT_TT_REQUEST_RX: received tt req traffic packet counter */
844 BATADV_CNT_TT_REQUEST_RX,
847 * @BATADV_CNT_TT_RESPONSE_TX: transmitted tt resp traffic packet
850 BATADV_CNT_TT_RESPONSE_TX,
853 * @BATADV_CNT_TT_RESPONSE_RX: received tt resp traffic packet counter
855 BATADV_CNT_TT_RESPONSE_RX,
858 * @BATADV_CNT_TT_ROAM_ADV_TX: transmitted tt roam traffic packet
861 BATADV_CNT_TT_ROAM_ADV_TX,
864 * @BATADV_CNT_TT_ROAM_ADV_RX: received tt roam traffic packet counter
866 BATADV_CNT_TT_ROAM_ADV_RX,
868 #ifdef CONFIG_BATMAN_ADV_DAT
870 * @BATADV_CNT_DAT_GET_TX: transmitted dht GET traffic packet counter
872 BATADV_CNT_DAT_GET_TX,
874 /** @BATADV_CNT_DAT_GET_RX: received dht GET traffic packet counter */
875 BATADV_CNT_DAT_GET_RX,
878 * @BATADV_CNT_DAT_PUT_TX: transmitted dht PUT traffic packet counter
880 BATADV_CNT_DAT_PUT_TX,
882 /** @BATADV_CNT_DAT_PUT_RX: received dht PUT traffic packet counter */
883 BATADV_CNT_DAT_PUT_RX,
886 * @BATADV_CNT_DAT_CACHED_REPLY_TX: transmitted dat cache reply traffic
889 BATADV_CNT_DAT_CACHED_REPLY_TX,
892 #ifdef CONFIG_BATMAN_ADV_NC
894 * @BATADV_CNT_NC_CODE: transmitted nc-combined traffic packet counter
899 * @BATADV_CNT_NC_CODE_BYTES: transmitted nc-combined traffic bytes
902 BATADV_CNT_NC_CODE_BYTES,
905 * @BATADV_CNT_NC_RECODE: transmitted nc-recombined traffic packet
908 BATADV_CNT_NC_RECODE,
911 * @BATADV_CNT_NC_RECODE_BYTES: transmitted nc-recombined traffic bytes
914 BATADV_CNT_NC_RECODE_BYTES,
917 * @BATADV_CNT_NC_BUFFER: counter for packets buffered for later nc
920 BATADV_CNT_NC_BUFFER,
923 * @BATADV_CNT_NC_DECODE: received and nc-decoded traffic packet counter
925 BATADV_CNT_NC_DECODE,
928 * @BATADV_CNT_NC_DECODE_BYTES: received and nc-decoded traffic bytes
931 BATADV_CNT_NC_DECODE_BYTES,
934 * @BATADV_CNT_NC_DECODE_FAILED: received and decode-failed traffic
937 BATADV_CNT_NC_DECODE_FAILED,
940 * @BATADV_CNT_NC_SNIFFED: counter for nc-decoded packets received in
943 BATADV_CNT_NC_SNIFFED,
946 /** @BATADV_CNT_NUM: number of traffic counters */
951 * struct batadv_priv_tt - per mesh interface translation table data
953 struct batadv_priv_tt {
954 /** @vn: translation table version number */
958 * @ogm_append_cnt: counter of number of OGMs containing the local tt
961 atomic_t ogm_append_cnt;
963 /** @local_changes: changes registered in an originator interval */
964 atomic_t local_changes;
967 * @changes_list: tracks tt local changes within an originator interval
969 struct list_head changes_list;
971 /** @local_hash: local translation table hash table */
972 struct batadv_hashtable *local_hash;
974 /** @global_hash: global translation table hash table */
975 struct batadv_hashtable *global_hash;
977 /** @req_list: list of pending & unanswered tt_requests */
978 struct hlist_head req_list;
981 * @roam_list: list of the last roaming events of each client limiting
982 * the number of roaming events to avoid route flapping
984 struct list_head roam_list;
986 /** @changes_list_lock: lock protecting changes_list */
987 spinlock_t changes_list_lock;
989 /** @req_list_lock: lock protecting req_list */
990 spinlock_t req_list_lock;
992 /** @roam_list_lock: lock protecting roam_list */
993 spinlock_t roam_list_lock;
995 /** @last_changeset: last tt changeset this host has generated */
996 unsigned char *last_changeset;
999 * @last_changeset_len: length of last tt changeset this host has
1002 s16 last_changeset_len;
1005 * @last_changeset_lock: lock protecting last_changeset &
1006 * last_changeset_len
1008 spinlock_t last_changeset_lock;
1011 * @commit_lock: prevents from executing a local TT commit while reading
1012 * the local table. The local TT commit is made up by two operations
1013 * (data structure update and metdata -CRC/TTVN- recalculation) and
1014 * they have to be executed atomically in order to avoid another thread
1015 * to read the table/metadata between those.
1017 spinlock_t commit_lock;
1019 /** @work: work queue callback item for translation table purging */
1020 struct delayed_work work;
1023 #ifdef CONFIG_BATMAN_ADV_BLA
1026 * struct batadv_priv_bla - per mesh interface bridge loope avoidance data
1028 struct batadv_priv_bla {
1029 /** @num_requests: number of bla requests in flight */
1030 atomic_t num_requests;
1033 * @claim_hash: hash table containing mesh nodes this host has claimed
1035 struct batadv_hashtable *claim_hash;
1038 * @backbone_hash: hash table containing all detected backbone gateways
1040 struct batadv_hashtable *backbone_hash;
1042 /** @loopdetect_addr: MAC address used for own loopdetection frames */
1043 u8 loopdetect_addr[ETH_ALEN];
1046 * @loopdetect_lasttime: time when the loopdetection frames were sent
1048 unsigned long loopdetect_lasttime;
1051 * @loopdetect_next: how many periods to wait for the next loopdetect
1054 atomic_t loopdetect_next;
1057 * @bcast_duplist: recently received broadcast packets array (for
1058 * broadcast duplicate suppression)
1060 struct batadv_bcast_duplist_entry bcast_duplist[BATADV_DUPLIST_SIZE];
1063 * @bcast_duplist_curr: index of last broadcast packet added to
1066 int bcast_duplist_curr;
1069 * @bcast_duplist_lock: lock protecting bcast_duplist &
1070 * bcast_duplist_curr
1072 spinlock_t bcast_duplist_lock;
1074 /** @claim_dest: local claim data (e.g. claim group) */
1075 struct batadv_bla_claim_dst claim_dest;
1077 /** @work: work queue callback item for cleanups & bla announcements */
1078 struct delayed_work work;
1082 #ifdef CONFIG_BATMAN_ADV_DEBUG
1085 * struct batadv_priv_debug_log - debug logging data
1087 struct batadv_priv_debug_log {
1088 /** @log_buff: buffer holding the logs (ring bufer) */
1089 char log_buff[BATADV_LOG_BUF_LEN];
1091 /** @log_start: index of next character to read */
1092 unsigned long log_start;
1094 /** @log_end: index of next character to write */
1095 unsigned long log_end;
1097 /** @lock: lock protecting log_buff, log_start & log_end */
1100 /** @queue_wait: log reader's wait queue */
1101 wait_queue_head_t queue_wait;
1106 * struct batadv_priv_gw - per mesh interface gateway data
1108 struct batadv_priv_gw {
1109 /** @gateway_list: list of available gateway nodes */
1110 struct hlist_head gateway_list;
1112 /** @list_lock: lock protecting gateway_list, curr_gw, generation */
1113 spinlock_t list_lock;
1115 /** @curr_gw: pointer to currently selected gateway node */
1116 struct batadv_gw_node __rcu *curr_gw;
1118 /** @generation: current (generation) sequence number */
1119 unsigned int generation;
1122 * @mode: gateway operation: off, client or server (see batadv_gw_modes)
1126 /** @sel_class: gateway selection class (applies if gw_mode client) */
1130 * @bandwidth_down: advertised uplink download bandwidth (if gw_mode
1133 atomic_t bandwidth_down;
1136 * @bandwidth_up: advertised uplink upload bandwidth (if gw_mode server)
1138 atomic_t bandwidth_up;
1140 /** @reselect: bool indicating a gateway re-selection is in progress */
1145 * struct batadv_priv_tvlv - per mesh interface tvlv data
1147 struct batadv_priv_tvlv {
1149 * @container_list: list of registered tvlv containers to be sent with
1152 struct hlist_head container_list;
1154 /** @handler_list: list of the various tvlv content handlers */
1155 struct hlist_head handler_list;
1157 /** @container_list_lock: protects tvlv container list access */
1158 spinlock_t container_list_lock;
1160 /** @handler_list_lock: protects handler list access */
1161 spinlock_t handler_list_lock;
1164 #ifdef CONFIG_BATMAN_ADV_DAT
1167 * struct batadv_priv_dat - per mesh interface DAT private data
1169 struct batadv_priv_dat {
1170 /** @addr: node DAT address */
1171 batadv_dat_addr_t addr;
1173 /** @hash: hashtable representing the local ARP cache */
1174 struct batadv_hashtable *hash;
1176 /** @work: work queue callback item for cache purging */
1177 struct delayed_work work;
1181 #ifdef CONFIG_BATMAN_ADV_MCAST
1183 * struct batadv_mcast_querier_state - IGMP/MLD querier state when bridged
1185 struct batadv_mcast_querier_state {
1186 /** @exists: whether a querier exists in the mesh */
1187 unsigned char exists:1;
1190 * @shadowing: if a querier exists, whether it is potentially shadowing
1191 * multicast listeners (i.e. querier is behind our own bridge segment)
1193 unsigned char shadowing:1;
1197 * struct batadv_mcast_mla_flags - flags for the querier, bridge and tvlv state
1199 struct batadv_mcast_mla_flags {
1200 /** @querier_ipv4: the current state of an IGMP querier in the mesh */
1201 struct batadv_mcast_querier_state querier_ipv4;
1203 /** @querier_ipv6: the current state of an MLD querier in the mesh */
1204 struct batadv_mcast_querier_state querier_ipv6;
1206 /** @enabled: whether the multicast tvlv is currently enabled */
1207 unsigned char enabled:1;
1209 /** @bridged: whether the soft interface has a bridge on top */
1210 unsigned char bridged:1;
1212 /** @tvlv_flags: the flags we have last sent in our mcast tvlv */
1217 * struct batadv_priv_mcast - per mesh interface mcast data
1219 struct batadv_priv_mcast {
1221 * @mla_list: list of multicast addresses we are currently announcing
1224 struct hlist_head mla_list; /* see __batadv_mcast_mla_update() */
1227 * @want_all_unsnoopables_list: a list of orig_nodes wanting all
1228 * unsnoopable multicast traffic
1230 struct hlist_head want_all_unsnoopables_list;
1233 * @want_all_ipv4_list: a list of orig_nodes wanting all IPv4 multicast
1236 struct hlist_head want_all_ipv4_list;
1239 * @want_all_ipv6_list: a list of orig_nodes wanting all IPv6 multicast
1242 struct hlist_head want_all_ipv6_list;
1245 * @want_all_rtr4_list: a list of orig_nodes wanting all routable IPv4
1248 struct hlist_head want_all_rtr4_list;
1251 * @want_all_rtr6_list: a list of orig_nodes wanting all routable IPv6
1254 struct hlist_head want_all_rtr6_list;
1257 * @mla_flags: flags for the querier, bridge and tvlv state
1259 struct batadv_mcast_mla_flags mla_flags;
1262 * @mla_lock: a lock protecting mla_list and mla_flags
1264 spinlock_t mla_lock;
1267 * @num_want_all_unsnoopables: number of nodes wanting unsnoopable IP
1270 atomic_t num_want_all_unsnoopables;
1272 /** @num_want_all_ipv4: counter for items in want_all_ipv4_list */
1273 atomic_t num_want_all_ipv4;
1275 /** @num_want_all_ipv6: counter for items in want_all_ipv6_list */
1276 atomic_t num_want_all_ipv6;
1278 /** @num_want_all_rtr4: counter for items in want_all_rtr4_list */
1279 atomic_t num_want_all_rtr4;
1281 /** @num_want_all_rtr6: counter for items in want_all_rtr6_list */
1282 atomic_t num_want_all_rtr6;
1285 * @want_lists_lock: lock for protecting modifications to mcasts
1286 * want_all_{unsnoopables,ipv4,ipv6}_list (traversals are rcu-locked)
1288 spinlock_t want_lists_lock;
1290 /** @work: work queue callback item for multicast TT and TVLV updates */
1291 struct delayed_work work;
1296 * struct batadv_priv_nc - per mesh interface network coding private data
1298 struct batadv_priv_nc {
1299 /** @work: work queue callback item for cleanup */
1300 struct delayed_work work;
1302 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
1304 * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
1306 struct dentry *debug_dir;
1310 * @min_tq: only consider neighbors for encoding if neigh_tq > min_tq
1315 * @max_fwd_delay: maximum packet forward delay to allow coding of
1321 * @max_buffer_time: buffer time for sniffed packets used to decoding
1323 u32 max_buffer_time;
1326 * @timestamp_fwd_flush: timestamp of last forward packet queue flush
1328 unsigned long timestamp_fwd_flush;
1331 * @timestamp_sniffed_purge: timestamp of last sniffed packet queue
1334 unsigned long timestamp_sniffed_purge;
1337 * @coding_hash: Hash table used to buffer skbs while waiting for
1338 * another incoming skb to code it with. Skbs are added to the buffer
1339 * just before being forwarded in routing.c
1341 struct batadv_hashtable *coding_hash;
1344 * @decoding_hash: Hash table used to buffer skbs that might be needed
1345 * to decode a received coded skb. The buffer is used for 1) skbs
1346 * arriving on the soft-interface; 2) skbs overheard on the
1347 * hard-interface; and 3) skbs forwarded by batman-adv.
1349 struct batadv_hashtable *decoding_hash;
1353 * struct batadv_tp_unacked - unacked packet meta-information
1355 * This struct is supposed to represent a buffer unacked packet. However, since
1356 * the purpose of the TP meter is to count the traffic only, there is no need to
1357 * store the entire sk_buff, the starting offset and the length are enough
1359 struct batadv_tp_unacked {
1360 /** @seqno: seqno of the unacked packet */
1363 /** @len: length of the packet */
1366 /** @list: list node for &batadv_tp_vars.unacked_list */
1367 struct list_head list;
1371 * enum batadv_tp_meter_role - Modus in tp meter session
1373 enum batadv_tp_meter_role {
1374 /** @BATADV_TP_RECEIVER: Initialized as receiver */
1377 /** @BATADV_TP_SENDER: Initialized as sender */
1382 * struct batadv_tp_vars - tp meter private variables per session
1384 struct batadv_tp_vars {
1385 /** @list: list node for &bat_priv.tp_list */
1386 struct hlist_node list;
1388 /** @timer: timer for ack (receiver) and retry (sender) */
1389 struct timer_list timer;
1391 /** @bat_priv: pointer to the mesh object */
1392 struct batadv_priv *bat_priv;
1394 /** @start_time: start time in jiffies */
1395 unsigned long start_time;
1397 /** @other_end: mac address of remote */
1398 u8 other_end[ETH_ALEN];
1400 /** @role: receiver/sender modi */
1401 enum batadv_tp_meter_role role;
1403 /** @sending: sending binary semaphore: 1 if sending, 0 is not */
1406 /** @reason: reason for a stopped session */
1407 enum batadv_tp_meter_reason reason;
1409 /** @finish_work: work item for the finishing procedure */
1410 struct delayed_work finish_work;
1412 /** @test_length: test length in milliseconds */
1415 /** @session: TP session identifier */
1418 /** @icmp_uid: local ICMP "socket" index */
1421 /* sender variables */
1423 /** @dec_cwnd: decimal part of the cwnd used during linear growth */
1426 /** @cwnd: current size of the congestion window */
1429 /** @cwnd_lock: lock do protect @cwnd & @dec_cwnd */
1430 spinlock_t cwnd_lock;
1433 * @ss_threshold: Slow Start threshold. Once cwnd exceeds this value the
1434 * connection switches to the Congestion Avoidance state
1438 /** @last_acked: last acked byte */
1439 atomic_t last_acked;
1441 /** @last_sent: last sent byte, not yet acked */
1444 /** @tot_sent: amount of data sent/ACKed so far */
1445 atomic64_t tot_sent;
1447 /** @dup_acks: duplicate ACKs counter */
1450 /** @fast_recovery: true if in Fast Recovery mode */
1451 unsigned char fast_recovery:1;
1453 /** @recover: last sent seqno when entering Fast Recovery */
1456 /** @rto: sender timeout */
1459 /** @srtt: smoothed RTT scaled by 2^3 */
1462 /** @rttvar: RTT variation scaled by 2^2 */
1466 * @more_bytes: waiting queue anchor when waiting for more ack/retry
1469 wait_queue_head_t more_bytes;
1471 /** @prerandom_offset: offset inside the prerandom buffer */
1472 u32 prerandom_offset;
1474 /** @prerandom_lock: spinlock protecting access to prerandom_offset */
1475 spinlock_t prerandom_lock;
1477 /* receiver variables */
1479 /** @last_recv: last in-order received packet */
1482 /** @unacked_list: list of unacked packets (meta-info only) */
1483 struct list_head unacked_list;
1485 /** @unacked_lock: protect unacked_list */
1486 spinlock_t unacked_lock;
1488 /** @last_recv_time: time time (jiffies) a msg was received */
1489 unsigned long last_recv_time;
1491 /** @refcount: number of context where the object is used */
1492 struct kref refcount;
1494 /** @rcu: struct used for freeing in an RCU-safe manner */
1495 struct rcu_head rcu;
1499 * struct batadv_softif_vlan - per VLAN attributes set
1501 struct batadv_softif_vlan {
1502 /** @bat_priv: pointer to the mesh object */
1503 struct batadv_priv *bat_priv;
1505 /** @vid: VLAN identifier */
1508 /** @kobj: kobject for sysfs vlan subdirectory */
1509 struct kobject *kobj;
1511 /** @ap_isolation: AP isolation state */
1512 atomic_t ap_isolation; /* boolean */
1514 /** @tt: TT private attributes (VLAN specific) */
1515 struct batadv_vlan_tt tt;
1517 /** @list: list node for &bat_priv.softif_vlan_list */
1518 struct hlist_node list;
1521 * @refcount: number of context where this object is currently in use
1523 struct kref refcount;
1525 /** @rcu: struct used for freeing in a RCU-safe manner */
1526 struct rcu_head rcu;
1530 * struct batadv_priv_bat_v - B.A.T.M.A.N. V per soft-interface private data
1532 struct batadv_priv_bat_v {
1533 /** @ogm_buff: buffer holding the OGM packet */
1534 unsigned char *ogm_buff;
1536 /** @ogm_buff_len: length of the OGM packet buffer */
1539 /** @ogm_seqno: OGM sequence number - used to identify each OGM */
1542 /** @ogm_wq: workqueue used to schedule OGM transmissions */
1543 struct delayed_work ogm_wq;
1547 * struct batadv_priv - per mesh interface data
1549 struct batadv_priv {
1551 * @mesh_state: current status of the mesh
1552 * (inactive/active/deactivating)
1554 atomic_t mesh_state;
1556 /** @soft_iface: net device which holds this struct as private data */
1557 struct net_device *soft_iface;
1560 * @bat_counters: mesh internal traffic statistic counters (see
1563 u64 __percpu *bat_counters; /* Per cpu counters */
1566 * @aggregated_ogms: bool indicating whether OGM aggregation is enabled
1568 atomic_t aggregated_ogms;
1570 /** @bonding: bool indicating whether traffic bonding is enabled */
1574 * @fragmentation: bool indicating whether traffic fragmentation is
1577 atomic_t fragmentation;
1580 * @packet_size_max: max packet size that can be transmitted via
1581 * multiple fragmented skbs or a single frame if fragmentation is
1584 atomic_t packet_size_max;
1587 * @frag_seqno: incremental counter to identify chains of egress
1590 atomic_t frag_seqno;
1592 #ifdef CONFIG_BATMAN_ADV_BLA
1594 * @bridge_loop_avoidance: bool indicating whether bridge loop
1595 * avoidance is enabled
1597 atomic_t bridge_loop_avoidance;
1600 #ifdef CONFIG_BATMAN_ADV_DAT
1602 * @distributed_arp_table: bool indicating whether distributed ARP table
1605 atomic_t distributed_arp_table;
1608 #ifdef CONFIG_BATMAN_ADV_MCAST
1610 * @multicast_mode: Enable or disable multicast optimizations on this
1611 * node's sender/originating side
1613 atomic_t multicast_mode;
1616 * @multicast_fanout: Maximum number of packet copies to generate for a
1617 * multicast-to-unicast conversion
1619 atomic_t multicast_fanout;
1622 /** @orig_interval: OGM broadcast interval in milliseconds */
1623 atomic_t orig_interval;
1626 * @hop_penalty: penalty which will be applied to an OGM's tq-field on
1629 atomic_t hop_penalty;
1631 #ifdef CONFIG_BATMAN_ADV_DEBUG
1632 /** @log_level: configured log level (see batadv_dbg_level) */
1637 * @isolation_mark: the skb->mark value used to match packets for AP
1643 * @isolation_mark_mask: bitmask identifying the bits in skb->mark to be
1644 * used for the isolation mark
1646 u32 isolation_mark_mask;
1648 /** @bcast_seqno: last sent broadcast packet sequence number */
1649 atomic_t bcast_seqno;
1652 * @bcast_queue_left: number of remaining buffered broadcast packet
1655 atomic_t bcast_queue_left;
1657 /** @batman_queue_left: number of remaining OGM packet slots */
1658 atomic_t batman_queue_left;
1660 /** @mesh_obj: kobject for sysfs mesh subdirectory */
1661 struct kobject *mesh_obj;
1663 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
1664 /** @debug_dir: dentry for debugfs batman-adv subdirectory */
1665 struct dentry *debug_dir;
1668 /** @forw_bat_list: list of aggregated OGMs that will be forwarded */
1669 struct hlist_head forw_bat_list;
1672 * @forw_bcast_list: list of broadcast packets that will be
1675 struct hlist_head forw_bcast_list;
1677 /** @tp_list: list of tp sessions */
1678 struct hlist_head tp_list;
1680 /** @tp_num: number of currently active tp sessions */
1681 struct batadv_hashtable *orig_hash;
1683 /** @orig_hash: hash table containing mesh participants (orig nodes) */
1684 spinlock_t forw_bat_list_lock;
1686 /** @forw_bat_list_lock: lock protecting forw_bat_list */
1687 spinlock_t forw_bcast_list_lock;
1689 /** @forw_bcast_list_lock: lock protecting forw_bcast_list */
1690 spinlock_t tp_list_lock;
1692 /** @tp_list_lock: spinlock protecting @tp_list */
1695 /** @orig_work: work queue callback item for orig node purging */
1696 struct delayed_work orig_work;
1699 * @primary_if: one of the hard-interfaces assigned to this mesh
1700 * interface becomes the primary interface
1702 struct batadv_hard_iface __rcu *primary_if; /* rcu protected pointer */
1704 /** @algo_ops: routing algorithm used by this mesh interface */
1705 struct batadv_algo_ops *algo_ops;
1708 * @softif_vlan_list: a list of softif_vlan structs, one per VLAN
1709 * created on top of the mesh interface represented by this object
1711 struct hlist_head softif_vlan_list;
1713 /** @softif_vlan_list_lock: lock protecting softif_vlan_list */
1714 spinlock_t softif_vlan_list_lock;
1716 #ifdef CONFIG_BATMAN_ADV_BLA
1717 /** @bla: bridge loope avoidance data */
1718 struct batadv_priv_bla bla;
1721 #ifdef CONFIG_BATMAN_ADV_DEBUG
1722 /** @debug_log: holding debug logging relevant data */
1723 struct batadv_priv_debug_log *debug_log;
1726 /** @gw: gateway data */
1727 struct batadv_priv_gw gw;
1729 /** @tt: translation table data */
1730 struct batadv_priv_tt tt;
1732 /** @tvlv: type-version-length-value data */
1733 struct batadv_priv_tvlv tvlv;
1735 #ifdef CONFIG_BATMAN_ADV_DAT
1736 /** @dat: distributed arp table data */
1737 struct batadv_priv_dat dat;
1740 #ifdef CONFIG_BATMAN_ADV_MCAST
1741 /** @mcast: multicast data */
1742 struct batadv_priv_mcast mcast;
1745 #ifdef CONFIG_BATMAN_ADV_NC
1747 * @network_coding: bool indicating whether network coding is enabled
1749 atomic_t network_coding;
1751 /** @nc: network coding data */
1752 struct batadv_priv_nc nc;
1753 #endif /* CONFIG_BATMAN_ADV_NC */
1755 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
1756 /** @bat_v: B.A.T.M.A.N. V per soft-interface private data */
1757 struct batadv_priv_bat_v bat_v;
1762 * struct batadv_socket_client - layer2 icmp socket client data
1764 struct batadv_socket_client {
1766 * @queue_list: packet queue for packets destined for this socket client
1768 struct list_head queue_list;
1770 /** @queue_len: number of packets in the packet queue (queue_list) */
1771 unsigned int queue_len;
1773 /** @index: socket client's index in the batadv_socket_client_hash */
1774 unsigned char index;
1776 /** @lock: lock protecting queue_list, queue_len & index */
1779 /** @queue_wait: socket client's wait queue */
1780 wait_queue_head_t queue_wait;
1782 /** @bat_priv: pointer to soft_iface this client belongs to */
1783 struct batadv_priv *bat_priv;
1787 * struct batadv_socket_packet - layer2 icmp packet for socket client
1789 struct batadv_socket_packet {
1790 /** @list: list node for &batadv_socket_client.queue_list */
1791 struct list_head list;
1793 /** @icmp_len: size of the layer2 icmp packet */
1796 /** @icmp_packet: layer2 icmp packet */
1797 u8 icmp_packet[BATADV_ICMP_MAX_PACKET_SIZE];
1800 #ifdef CONFIG_BATMAN_ADV_BLA
1803 * struct batadv_bla_backbone_gw - batman-adv gateway bridged into the LAN
1805 struct batadv_bla_backbone_gw {
1807 * @orig: originator address of backbone node (mac address of primary
1812 /** @vid: vlan id this gateway was detected on */
1815 /** @hash_entry: hlist node for &batadv_priv_bla.backbone_hash */
1816 struct hlist_node hash_entry;
1818 /** @bat_priv: pointer to soft_iface this backbone gateway belongs to */
1819 struct batadv_priv *bat_priv;
1821 /** @lasttime: last time we heard of this backbone gw */
1822 unsigned long lasttime;
1825 * @wait_periods: grace time for bridge forward delays and bla group
1826 * forming at bootup phase - no bcast traffic is formwared until it has
1829 atomic_t wait_periods;
1832 * @request_sent: if this bool is set to true we are out of sync with
1833 * this backbone gateway - no bcast traffic is formwared until the
1834 * situation was resolved
1836 atomic_t request_sent;
1838 /** @crc: crc16 checksum over all claims */
1841 /** @crc_lock: lock protecting crc */
1842 spinlock_t crc_lock;
1844 /** @report_work: work struct for reporting detected loops */
1845 struct work_struct report_work;
1847 /** @refcount: number of contexts the object is used */
1848 struct kref refcount;
1850 /** @rcu: struct used for freeing in an RCU-safe manner */
1851 struct rcu_head rcu;
1855 * struct batadv_bla_claim - claimed non-mesh client structure
1857 struct batadv_bla_claim {
1858 /** @addr: mac address of claimed non-mesh client */
1861 /** @vid: vlan id this client was detected on */
1864 /** @backbone_gw: pointer to backbone gw claiming this client */
1865 struct batadv_bla_backbone_gw *backbone_gw;
1867 /** @backbone_lock: lock protecting backbone_gw pointer */
1868 spinlock_t backbone_lock;
1870 /** @lasttime: last time we heard of claim (locals only) */
1871 unsigned long lasttime;
1873 /** @hash_entry: hlist node for &batadv_priv_bla.claim_hash */
1874 struct hlist_node hash_entry;
1876 /** @refcount: number of contexts the object is used */
1877 struct rcu_head rcu;
1879 /** @rcu: struct used for freeing in an RCU-safe manner */
1880 struct kref refcount;
1885 * struct batadv_tt_common_entry - tt local & tt global common data
1887 struct batadv_tt_common_entry {
1888 /** @addr: mac address of non-mesh client */
1891 /** @vid: VLAN identifier */
1895 * @hash_entry: hlist node for &batadv_priv_tt.local_hash or for
1896 * &batadv_priv_tt.global_hash
1898 struct hlist_node hash_entry;
1900 /** @flags: various state handling flags (see batadv_tt_client_flags) */
1903 /** @added_at: timestamp used for purging stale tt common entries */
1904 unsigned long added_at;
1906 /** @refcount: number of contexts the object is used */
1907 struct kref refcount;
1909 /** @rcu: struct used for freeing in an RCU-safe manner */
1910 struct rcu_head rcu;
1914 * struct batadv_tt_local_entry - translation table local entry data
1916 struct batadv_tt_local_entry {
1917 /** @common: general translation table data */
1918 struct batadv_tt_common_entry common;
1920 /** @last_seen: timestamp used for purging stale tt local entries */
1921 unsigned long last_seen;
1923 /** @vlan: soft-interface vlan of the entry */
1924 struct batadv_softif_vlan *vlan;
1928 * struct batadv_tt_global_entry - translation table global entry data
1930 struct batadv_tt_global_entry {
1931 /** @common: general translation table data */
1932 struct batadv_tt_common_entry common;
1934 /** @orig_list: list of orig nodes announcing this non-mesh client */
1935 struct hlist_head orig_list;
1937 /** @orig_list_count: number of items in the orig_list */
1938 atomic_t orig_list_count;
1940 /** @list_lock: lock protecting orig_list */
1941 spinlock_t list_lock;
1943 /** @roam_at: time at which TT_GLOBAL_ROAM was set */
1944 unsigned long roam_at;
1948 * struct batadv_tt_orig_list_entry - orig node announcing a non-mesh client
1950 struct batadv_tt_orig_list_entry {
1951 /** @orig_node: pointer to orig node announcing this non-mesh client */
1952 struct batadv_orig_node *orig_node;
1955 * @ttvn: translation table version number which added the non-mesh
1960 /** @flags: per orig entry TT sync flags */
1963 /** @list: list node for &batadv_tt_global_entry.orig_list */
1964 struct hlist_node list;
1966 /** @refcount: number of contexts the object is used */
1967 struct kref refcount;
1969 /** @rcu: struct used for freeing in an RCU-safe manner */
1970 struct rcu_head rcu;
1974 * struct batadv_tt_change_node - structure for tt changes occurred
1976 struct batadv_tt_change_node {
1977 /** @list: list node for &batadv_priv_tt.changes_list */
1978 struct list_head list;
1980 /** @change: holds the actual translation table diff data */
1981 struct batadv_tvlv_tt_change change;
1985 * struct batadv_tt_req_node - data to keep track of the tt requests in flight
1987 struct batadv_tt_req_node {
1989 * @addr: mac address address of the originator this request was sent to
1993 /** @issued_at: timestamp used for purging stale tt requests */
1994 unsigned long issued_at;
1996 /** @refcount: number of contexts the object is used by */
1997 struct kref refcount;
1999 /** @list: list node for &batadv_priv_tt.req_list */
2000 struct hlist_node list;
2004 * struct batadv_tt_roam_node - roaming client data
2006 struct batadv_tt_roam_node {
2007 /** @addr: mac address of the client in the roaming phase */
2011 * @counter: number of allowed roaming events per client within a single
2012 * OGM interval (changes are committed with each OGM)
2017 * @first_time: timestamp used for purging stale roaming node entries
2019 unsigned long first_time;
2021 /** @list: list node for &batadv_priv_tt.roam_list */
2022 struct list_head list;
2026 * struct batadv_nc_node - network coding node
2028 struct batadv_nc_node {
2029 /** @list: next and prev pointer for the list handling */
2030 struct list_head list;
2032 /** @addr: the node's mac address */
2035 /** @refcount: number of contexts the object is used by */
2036 struct kref refcount;
2038 /** @rcu: struct used for freeing in an RCU-safe manner */
2039 struct rcu_head rcu;
2041 /** @orig_node: pointer to corresponding orig node struct */
2042 struct batadv_orig_node *orig_node;
2044 /** @last_seen: timestamp of last ogm received from this node */
2045 unsigned long last_seen;
2049 * struct batadv_nc_path - network coding path
2051 struct batadv_nc_path {
2052 /** @hash_entry: next and prev pointer for the list handling */
2053 struct hlist_node hash_entry;
2055 /** @rcu: struct used for freeing in an RCU-safe manner */
2056 struct rcu_head rcu;
2058 /** @refcount: number of contexts the object is used by */
2059 struct kref refcount;
2061 /** @packet_list: list of buffered packets for this path */
2062 struct list_head packet_list;
2064 /** @packet_list_lock: access lock for packet list */
2065 spinlock_t packet_list_lock;
2067 /** @next_hop: next hop (destination) of path */
2068 u8 next_hop[ETH_ALEN];
2070 /** @prev_hop: previous hop (source) of path */
2071 u8 prev_hop[ETH_ALEN];
2073 /** @last_valid: timestamp for last validation of path */
2074 unsigned long last_valid;
2078 * struct batadv_nc_packet - network coding packet used when coding and
2081 struct batadv_nc_packet {
2082 /** @list: next and prev pointer for the list handling */
2083 struct list_head list;
2085 /** @packet_id: crc32 checksum of skb data */
2089 * @timestamp: field containing the info when the packet was added to
2092 unsigned long timestamp;
2094 /** @neigh_node: pointer to original next hop neighbor of skb */
2095 struct batadv_neigh_node *neigh_node;
2097 /** @skb: skb which can be encoded or used for decoding */
2098 struct sk_buff *skb;
2100 /** @nc_path: pointer to path this nc packet is attached to */
2101 struct batadv_nc_path *nc_path;
2105 * struct batadv_skb_cb - control buffer structure used to store private data
2106 * relevant to batman-adv in the skb->cb buffer in skbs.
2108 struct batadv_skb_cb {
2110 * @decoded: Marks a skb as decoded, which is checked when searching for
2111 * coding opportunities in network-coding.c
2113 unsigned char decoded:1;
2115 /** @num_bcasts: Counter for broadcast packet retransmissions */
2116 unsigned char num_bcasts;
2120 * struct batadv_forw_packet - structure for bcast packets to be sent/forwarded
2122 struct batadv_forw_packet {
2124 * @list: list node for &batadv_priv.forw.bcast_list and
2125 * &batadv_priv.forw.bat_list
2127 struct hlist_node list;
2129 /** @cleanup_list: list node for purging functions */
2130 struct hlist_node cleanup_list;
2132 /** @send_time: execution time for delayed_work (packet sending) */
2133 unsigned long send_time;
2136 * @own: bool for locally generated packets (local OGMs are re-scheduled
2141 /** @skb: bcast packet's skb buffer */
2142 struct sk_buff *skb;
2144 /** @packet_len: size of aggregated OGM packet inside the skb buffer */
2147 /** @direct_link_flags: direct link flags for aggregated OGM packets */
2148 u32 direct_link_flags;
2150 /** @num_packets: counter for aggregated OGMv1 packets */
2153 /** @delayed_work: work queue callback item for packet sending */
2154 struct delayed_work delayed_work;
2157 * @if_incoming: pointer to incoming hard-iface or primary iface if
2158 * locally generated packet
2160 struct batadv_hard_iface *if_incoming;
2163 * @if_outgoing: packet where the packet should be sent to, or NULL if
2166 struct batadv_hard_iface *if_outgoing;
2168 /** @queue_left: The queue (counter) this packet was applied to */
2169 atomic_t *queue_left;
2173 * struct batadv_algo_iface_ops - mesh algorithm callbacks (interface specific)
2175 struct batadv_algo_iface_ops {
2177 * @activate: start routing mechanisms when hard-interface is brought up
2180 void (*activate)(struct batadv_hard_iface *hard_iface);
2182 /** @enable: init routing info when hard-interface is enabled */
2183 int (*enable)(struct batadv_hard_iface *hard_iface);
2185 /** @enabled: notification when hard-interface was enabled (optional) */
2186 void (*enabled)(struct batadv_hard_iface *hard_iface);
2188 /** @disable: de-init routing info when hard-interface is disabled */
2189 void (*disable)(struct batadv_hard_iface *hard_iface);
2192 * @update_mac: (re-)init mac addresses of the protocol information
2193 * belonging to this hard-interface
2195 void (*update_mac)(struct batadv_hard_iface *hard_iface);
2197 /** @primary_set: called when primary interface is selected / changed */
2198 void (*primary_set)(struct batadv_hard_iface *hard_iface);
2202 * struct batadv_algo_neigh_ops - mesh algorithm callbacks (neighbour specific)
2204 struct batadv_algo_neigh_ops {
2205 /** @hardif_init: called on creation of single hop entry (optional) */
2206 void (*hardif_init)(struct batadv_hardif_neigh_node *neigh);
2209 * @cmp: compare the metrics of two neighbors for their respective
2210 * outgoing interfaces
2212 int (*cmp)(struct batadv_neigh_node *neigh1,
2213 struct batadv_hard_iface *if_outgoing1,
2214 struct batadv_neigh_node *neigh2,
2215 struct batadv_hard_iface *if_outgoing2);
2218 * @is_similar_or_better: check if neigh1 is equally similar or better
2219 * than neigh2 for their respective outgoing interface from the metric
2222 bool (*is_similar_or_better)(struct batadv_neigh_node *neigh1,
2223 struct batadv_hard_iface *if_outgoing1,
2224 struct batadv_neigh_node *neigh2,
2225 struct batadv_hard_iface *if_outgoing2);
2227 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
2228 /** @print: print the single hop neighbor list (optional) */
2229 void (*print)(struct batadv_priv *priv, struct seq_file *seq);
2232 /** @dump: dump neighbors to a netlink socket (optional) */
2233 void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
2234 struct batadv_priv *priv,
2235 struct batadv_hard_iface *hard_iface);
2239 * struct batadv_algo_orig_ops - mesh algorithm callbacks (originator specific)
2241 struct batadv_algo_orig_ops {
2242 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
2243 /** @print: print the originator table (optional) */
2244 void (*print)(struct batadv_priv *priv, struct seq_file *seq,
2245 struct batadv_hard_iface *hard_iface);
2248 /** @dump: dump originators to a netlink socket (optional) */
2249 void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
2250 struct batadv_priv *priv,
2251 struct batadv_hard_iface *hard_iface);
2255 * struct batadv_algo_gw_ops - mesh algorithm callbacks (GW specific)
2257 struct batadv_algo_gw_ops {
2258 /** @init_sel_class: initialize GW selection class (optional) */
2259 void (*init_sel_class)(struct batadv_priv *bat_priv);
2262 * @store_sel_class: parse and stores a new GW selection class
2265 ssize_t (*store_sel_class)(struct batadv_priv *bat_priv, char *buff,
2268 /** @show_sel_class: prints the current GW selection class (optional) */
2269 ssize_t (*show_sel_class)(struct batadv_priv *bat_priv, char *buff);
2272 * @get_best_gw_node: select the best GW from the list of available
2275 struct batadv_gw_node *(*get_best_gw_node)
2276 (struct batadv_priv *bat_priv);
2279 * @is_eligible: check if a newly discovered GW is a potential candidate
2280 * for the election as best GW (optional)
2282 bool (*is_eligible)(struct batadv_priv *bat_priv,
2283 struct batadv_orig_node *curr_gw_orig,
2284 struct batadv_orig_node *orig_node);
2286 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
2287 /** @print: print the gateway table (optional) */
2288 void (*print)(struct batadv_priv *bat_priv, struct seq_file *seq);
2291 /** @dump: dump gateways to a netlink socket (optional) */
2292 void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
2293 struct batadv_priv *priv);
2297 * struct batadv_algo_ops - mesh algorithm callbacks
2299 struct batadv_algo_ops {
2300 /** @list: list node for the batadv_algo_list */
2301 struct hlist_node list;
2303 /** @name: name of the algorithm */
2306 /** @iface: callbacks related to interface handling */
2307 struct batadv_algo_iface_ops iface;
2309 /** @neigh: callbacks related to neighbors handling */
2310 struct batadv_algo_neigh_ops neigh;
2312 /** @orig: callbacks related to originators handling */
2313 struct batadv_algo_orig_ops orig;
2315 /** @gw: callbacks related to GW mode */
2316 struct batadv_algo_gw_ops gw;
2320 * struct batadv_dat_entry - it is a single entry of batman-adv ARP backend. It
2321 * is used to stored ARP entries needed for the global DAT cache
2323 struct batadv_dat_entry {
2324 /** @ip: the IPv4 corresponding to this DAT/ARP entry */
2327 /** @mac_addr: the MAC address associated to the stored IPv4 */
2328 u8 mac_addr[ETH_ALEN];
2330 /** @vid: the vlan ID associated to this entry */
2334 * @last_update: time in jiffies when this entry was refreshed last time
2336 unsigned long last_update;
2338 /** @hash_entry: hlist node for &batadv_priv_dat.hash */
2339 struct hlist_node hash_entry;
2341 /** @refcount: number of contexts the object is used */
2342 struct kref refcount;
2344 /** @rcu: struct used for freeing in an RCU-safe manner */
2345 struct rcu_head rcu;
2349 * struct batadv_hw_addr - a list entry for a MAC address
2351 struct batadv_hw_addr {
2352 /** @list: list node for the linking of entries */
2353 struct hlist_node list;
2355 /** @addr: the MAC address of this list entry */
2356 unsigned char addr[ETH_ALEN];
2360 * struct batadv_dat_candidate - candidate destination for DAT operations
2362 struct batadv_dat_candidate {
2364 * @type: the type of the selected candidate. It can one of the
2366 * - BATADV_DAT_CANDIDATE_NOT_FOUND
2367 * - BATADV_DAT_CANDIDATE_ORIG
2372 * @orig_node: if type is BATADV_DAT_CANDIDATE_ORIG this field points to
2373 * the corresponding originator node structure
2375 struct batadv_orig_node *orig_node;
2379 * struct batadv_tvlv_container - container for tvlv appended to OGMs
2381 struct batadv_tvlv_container {
2382 /** @list: hlist node for &batadv_priv_tvlv.container_list */
2383 struct hlist_node list;
2385 /** @tvlv_hdr: tvlv header information needed to construct the tvlv */
2386 struct batadv_tvlv_hdr tvlv_hdr;
2388 /** @refcount: number of contexts the object is used */
2389 struct kref refcount;
2393 * struct batadv_tvlv_handler - handler for specific tvlv type and version
2395 struct batadv_tvlv_handler {
2396 /** @list: hlist node for &batadv_priv_tvlv.handler_list */
2397 struct hlist_node list;
2400 * @ogm_handler: handler callback which is given the tvlv payload to
2401 * process on incoming OGM packets
2403 void (*ogm_handler)(struct batadv_priv *bat_priv,
2404 struct batadv_orig_node *orig,
2405 u8 flags, void *tvlv_value, u16 tvlv_value_len);
2408 * @unicast_handler: handler callback which is given the tvlv payload to
2409 * process on incoming unicast tvlv packets
2411 int (*unicast_handler)(struct batadv_priv *bat_priv,
2413 void *tvlv_value, u16 tvlv_value_len);
2415 /** @type: tvlv type this handler feels responsible for */
2418 /** @version: tvlv version this handler feels responsible for */
2421 /** @flags: tvlv handler flags */
2424 /** @refcount: number of contexts the object is used */
2425 struct kref refcount;
2427 /** @rcu: struct used for freeing in an RCU-safe manner */
2428 struct rcu_head rcu;
2432 * enum batadv_tvlv_handler_flags - tvlv handler flags definitions
2434 enum batadv_tvlv_handler_flags {
2436 * @BATADV_TVLV_HANDLER_OGM_CIFNOTFND: tvlv ogm processing function
2437 * will call this handler even if its type was not found (with no data)
2439 BATADV_TVLV_HANDLER_OGM_CIFNOTFND = BIT(1),
2442 * @BATADV_TVLV_HANDLER_OGM_CALLED: interval tvlv handling flag - the
2443 * API marks a handler as being called, so it won't be called if the
2444 * BATADV_TVLV_HANDLER_OGM_CIFNOTFND flag was set
2446 BATADV_TVLV_HANDLER_OGM_CALLED = BIT(2),
2450 * struct batadv_store_mesh_work - Work queue item to detach add/del interface
2453 struct batadv_store_mesh_work {
2455 * @net_dev: netdevice to add/remove to/from batman-adv soft-interface
2457 struct net_device *net_dev;
2459 /** @soft_iface_name: name of soft-interface to modify */
2460 char soft_iface_name[IFNAMSIZ];
2462 /** @work: work queue item */
2463 struct work_struct work;
2466 #endif /* _NET_BATMAN_ADV_TYPES_H_ */