net/batman-adv/types.h

   1 /* Copyright (C) 2007-2017  B.A.T.M.A.N. contributors:
   2  *
   3  * Marek Lindner, Simon Wunderlich
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of version 2 of the GNU General Public
   7  * License as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #ifndef _NET_BATMAN_ADV_TYPES_H_
  19 #define _NET_BATMAN_ADV_TYPES_H_
  20
  21 #ifndef _NET_BATMAN_ADV_MAIN_H_
  22 #error only "main.h" can be included directly
  23 #endif
  24
  25 #include <linux/average.h>
  26 #include <linux/bitops.h>
  27 #include <linux/compiler.h>
  28 #include <linux/if_ether.h>
  29 #include <linux/kref.h>
  30 #include <linux/netdevice.h>
  31 #include <linux/netlink.h>
  32 #include <linux/sched.h> /* for linux/wait.h */
  33 #include <linux/spinlock.h>
  34 #include <linux/types.h>
  35 #include <linux/wait.h>
  36 #include <linux/workqueue.h>
  37 #include <uapi/linux/batman_adv.h>
  38
  39 #include "packet.h"
  40
  41 struct seq_file;
  42
  43 #ifdef CONFIG_BATMAN_ADV_DAT
  44
  45 /**
  46  * batadv_dat_addr_t - it is the type used for all DHT addresses. If it is
  47  *  changed, BATADV_DAT_ADDR_MAX is changed as well.
  48  *
  49  * *Please be careful: batadv_dat_addr_t must be UNSIGNED*
  50  */
  51 #define batadv_dat_addr_t u16
  52
  53 #endif /* CONFIG_BATMAN_ADV_DAT */
  54
  55 /**
  56  * enum batadv_dhcp_recipient - dhcp destination
  57  * @BATADV_DHCP_NO: packet is not a dhcp message
  58  * @BATADV_DHCP_TO_SERVER: dhcp message is directed to a server
  59  * @BATADV_DHCP_TO_CLIENT: dhcp message is directed to a client
  60  */
  61 enum batadv_dhcp_recipient {
  62         BATADV_DHCP_NO = 0,
  63         BATADV_DHCP_TO_SERVER,
  64         BATADV_DHCP_TO_CLIENT,
  65 };
  66
  67 /**
  68  * BATADV_TT_REMOTE_MASK - bitmask selecting the flags that are sent over the
  69  *  wire only
  70  */
  71 #define BATADV_TT_REMOTE_MASK   0x00FF
  72
  73 /**
  74  * BATADV_TT_SYNC_MASK - bitmask of the flags that need to be kept in sync
  75  *  among the nodes. These flags are used to compute the global/local CRC
  76  */
  77 #define BATADV_TT_SYNC_MASK     0x00F0
  78
  79 /**
  80  * struct batadv_hard_iface_bat_iv - per hard-interface B.A.T.M.A.N. IV data
  81  * @ogm_buff: buffer holding the OGM packet
  82  * @ogm_buff_len: length of the OGM packet buffer
  83  * @ogm_seqno: OGM sequence number - used to identify each OGM
  84  */
  85 struct batadv_hard_iface_bat_iv {
  86         unsigned char *ogm_buff;
  87         int ogm_buff_len;
  88         atomic_t ogm_seqno;
  89 };
  90
  91 /**
  92  * enum batadv_v_hard_iface_flags - interface flags useful to B.A.T.M.A.N. V
  93  * @BATADV_FULL_DUPLEX: tells if the connection over this link is full-duplex
  94  * @BATADV_WARNING_DEFAULT: tells whether we have warned the user that no
  95  *  throughput data is available for this interface and that default values are
  96  *  assumed.
  97  */
  98 enum batadv_v_hard_iface_flags {
  99         BATADV_FULL_DUPLEX      = BIT(0),
 100         BATADV_WARNING_DEFAULT  = BIT(1),
 101 };
 102
 103 /**
 104  * struct batadv_hard_iface_bat_v - per hard-interface B.A.T.M.A.N. V data
 105  * @elp_interval: time interval between two ELP transmissions
 106  * @elp_seqno: current ELP sequence number
 107  * @elp_skb: base skb containing the ELP message to send
 108  * @elp_wq: workqueue used to schedule ELP transmissions
 109  * @throughput_override: throughput override to disable link auto-detection
 110  * @flags: interface specific flags
 111  */
 112 struct batadv_hard_iface_bat_v {
 113         atomic_t elp_interval;
 114         atomic_t elp_seqno;
 115         struct sk_buff *elp_skb;
 116         struct delayed_work elp_wq;
 117         atomic_t throughput_override;
 118         u8 flags;
 119 };
 120
 121 /**
 122  * enum batadv_hard_iface_wifi_flags - Flags describing the wifi configuration
 123  *  of a batadv_hard_iface
 124  * @BATADV_HARDIF_WIFI_WEXT_DIRECT: it is a wext wifi device
 125  * @BATADV_HARDIF_WIFI_CFG80211_DIRECT: it is a cfg80211 wifi device
 126  * @BATADV_HARDIF_WIFI_WEXT_INDIRECT: link device is a wext wifi device
 127  * @BATADV_HARDIF_WIFI_CFG80211_INDIRECT: link device is a cfg80211 wifi device
 128  */
 129 enum batadv_hard_iface_wifi_flags {
 130         BATADV_HARDIF_WIFI_WEXT_DIRECT = BIT(0),
 131         BATADV_HARDIF_WIFI_CFG80211_DIRECT = BIT(1),
 132         BATADV_HARDIF_WIFI_WEXT_INDIRECT = BIT(2),
 133         BATADV_HARDIF_WIFI_CFG80211_INDIRECT = BIT(3),
 134 };
 135
 136 /**
 137  * struct batadv_hard_iface - network device known to batman-adv
 138  * @list: list node for batadv_hardif_list
 139  * @if_num: identificator of the interface
 140  * @if_status: status of the interface for batman-adv
 141  * @num_bcasts: number of payload re-broadcasts on this interface (ARQ)
 142  * @wifi_flags: flags whether this is (directly or indirectly) a wifi interface
 143  * @net_dev: pointer to the net_device
 144  * @hardif_obj: kobject of the per interface sysfs "mesh" directory
 145  * @refcount: number of contexts the object is used
 146  * @batman_adv_ptype: packet type describing packets that should be processed by
 147  *  batman-adv for this interface
 148  * @soft_iface: the batman-adv interface which uses this network interface
 149  * @rcu: struct used for freeing in an RCU-safe manner
 150  * @bat_iv: per hard-interface B.A.T.M.A.N. IV data
 151  * @bat_v: per hard-interface B.A.T.M.A.N. V data
 152  * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
 153  * @neigh_list: list of unique single hop neighbors via this interface
 154  * @neigh_list_lock: lock protecting neigh_list
 155  */
 156 struct batadv_hard_iface {
 157         struct list_head list;
 158         s16 if_num;
 159         char if_status;
 160         u8 num_bcasts;
 161         u32 wifi_flags;
 162         struct net_device *net_dev;
 163         struct kobject *hardif_obj;
 164         struct kref refcount;
 165         struct packet_type batman_adv_ptype;
 166         struct net_device *soft_iface;
 167         struct rcu_head rcu;
 168         struct batadv_hard_iface_bat_iv bat_iv;
 169 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
 170         struct batadv_hard_iface_bat_v bat_v;
 171 #endif
 172         struct dentry *debug_dir;
 173         struct hlist_head neigh_list;
 174         /* neigh_list_lock protects: neigh_list */
 175         spinlock_t neigh_list_lock;
 176 };
 177
 178 /**
 179  * struct batadv_orig_ifinfo - originator info per outgoing interface
 180  * @list: list node for orig_node::ifinfo_list
 181  * @if_outgoing: pointer to outgoing hard-interface
 182  * @router: router that should be used to reach this originator
 183  * @last_real_seqno: last and best known sequence number
 184  * @last_ttl: ttl of last received packet
 185  * @last_seqno_forwarded: seqno of the OGM which was forwarded last
 186  * @batman_seqno_reset: time when the batman seqno window was reset
 187  * @refcount: number of contexts the object is used
 188  * @rcu: struct used for freeing in an RCU-safe manner
 189  */
 190 struct batadv_orig_ifinfo {
 191         struct hlist_node list;
 192         struct batadv_hard_iface *if_outgoing;
 193         struct batadv_neigh_node __rcu *router; /* rcu protected pointer */
 194         u32 last_real_seqno;
 195         u8 last_ttl;
 196         u32 last_seqno_forwarded;
 197         unsigned long batman_seqno_reset;
 198         struct kref refcount;
 199         struct rcu_head rcu;
 200 };
 201
 202 /**
 203  * struct batadv_frag_table_entry - head in the fragment buffer table
 204  * @fragment_list: head of list with fragments
 205  * @lock: lock to protect the list of fragments
 206  * @timestamp: time (jiffie) of last received fragment
 207  * @seqno: sequence number of the fragments in the list
 208  * @size: accumulated size of packets in list
 209  * @total_size: expected size of the assembled packet
 210  */
 211 struct batadv_frag_table_entry {
 212         struct hlist_head fragment_list;
 213         spinlock_t lock; /* protects fragment_list */
 214         unsigned long timestamp;
 215         u16 seqno;
 216         u16 size;
 217         u16 total_size;
 218 };
 219
 220 /**
 221  * struct batadv_frag_list_entry - entry in a list of fragments
 222  * @list: list node information
 223  * @skb: fragment
 224  * @no: fragment number in the set
 225  */
 226 struct batadv_frag_list_entry {
 227         struct hlist_node list;
 228         struct sk_buff *skb;
 229         u8 no;
 230 };
 231
 232 /**
 233  * struct batadv_vlan_tt - VLAN specific TT attributes
 234  * @crc: CRC32 checksum of the entries belonging to this vlan
 235  * @num_entries: number of TT entries for this VLAN
 236  */
 237 struct batadv_vlan_tt {
 238         u32 crc;
 239         atomic_t num_entries;
 240 };
 241
 242 /**
 243  * struct batadv_orig_node_vlan - VLAN specific data per orig_node
 244  * @vid: the VLAN identifier
 245  * @tt: VLAN specific TT attributes
 246  * @list: list node for orig_node::vlan_list
 247  * @refcount: number of context where this object is currently in use
 248  * @rcu: struct used for freeing in a RCU-safe manner
 249  */
 250 struct batadv_orig_node_vlan {
 251         unsigned short vid;
 252         struct batadv_vlan_tt tt;
 253         struct hlist_node list;
 254         struct kref refcount;
 255         struct rcu_head rcu;
 256 };
 257
 258 /**
 259  * struct batadv_orig_bat_iv - B.A.T.M.A.N. IV private orig_node members
 260  * @bcast_own: set of bitfields (one per hard-interface) where each one counts
 261  * the number of our OGMs this orig_node rebroadcasted "back" to us  (relative
 262  * to last_real_seqno). Every bitfield is BATADV_TQ_LOCAL_WINDOW_SIZE bits long.
 263  * @bcast_own_sum: sum of bcast_own
 264  * @ogm_cnt_lock: lock protecting bcast_own, bcast_own_sum,
 265  *  neigh_node->bat_iv.real_bits & neigh_node->bat_iv.real_packet_count
 266  */
 267 struct batadv_orig_bat_iv {
 268         unsigned long *bcast_own;
 269         u8 *bcast_own_sum;
 270         /* ogm_cnt_lock protects: bcast_own, bcast_own_sum,
 271          * neigh_node->bat_iv.real_bits & neigh_node->bat_iv.real_packet_count
 272          */
 273         spinlock_t ogm_cnt_lock;
 274 };
 275
 276 /**
 277  * struct batadv_orig_node - structure for orig_list maintaining nodes of mesh
 278  * @orig: originator ethernet address
 279  * @ifinfo_list: list for routers per outgoing interface
 280  * @last_bonding_candidate: pointer to last ifinfo of last used router
 281  * @dat_addr: address of the orig node in the distributed hash
 282  * @last_seen: time when last packet from this node was received
 283  * @bcast_seqno_reset: time when the broadcast seqno window was reset
 284  * @mcast_handler_lock: synchronizes mcast-capability and -flag changes
 285  * @mcast_flags: multicast flags announced by the orig node
 286  * @mcast_want_all_unsnoopables_node: a list node for the
 287  *  mcast.want_all_unsnoopables list
 288  * @mcast_want_all_ipv4_node: a list node for the mcast.want_all_ipv4 list
 289  * @mcast_want_all_ipv6_node: a list node for the mcast.want_all_ipv6 list
 290  * @capabilities: announced capabilities of this originator
 291  * @capa_initialized: bitfield to remember whether a capability was initialized
 292  * @last_ttvn: last seen translation table version number
 293  * @tt_buff: last tt changeset this node received from the orig node
 294  * @tt_buff_len: length of the last tt changeset this node received from the
 295  *  orig node
 296  * @tt_buff_lock: lock that protects tt_buff and tt_buff_len
 297  * @tt_lock: prevents from updating the table while reading it. Table update is
 298  *  made up by two operations (data structure update and metdata -CRC/TTVN-
 299  *  recalculation) and they have to be executed atomically in order to avoid
 300  *  another thread to read the table/metadata between those.
 301  * @bcast_bits: bitfield containing the info which payload broadcast originated
 302  *  from this orig node this host already has seen (relative to
 303  *  last_bcast_seqno)
 304  * @last_bcast_seqno: last broadcast sequence number received by this host
 305  * @neigh_list: list of potential next hop neighbor towards this orig node
 306  * @neigh_list_lock: lock protecting neigh_list and router
 307  * @hash_entry: hlist node for batadv_priv::orig_hash
 308  * @bat_priv: pointer to soft_iface this orig node belongs to
 309  * @bcast_seqno_lock: lock protecting bcast_bits & last_bcast_seqno
 310  * @refcount: number of contexts the object is used
 311  * @rcu: struct used for freeing in an RCU-safe manner
 312  * @in_coding_list: list of nodes this orig can hear
 313  * @out_coding_list: list of nodes that can hear this orig
 314  * @in_coding_list_lock: protects in_coding_list
 315  * @out_coding_list_lock: protects out_coding_list
 316  * @fragments: array with heads for fragment chains
 317  * @vlan_list: a list of orig_node_vlan structs, one per VLAN served by the
 318  *  originator represented by this object
 319  * @vlan_list_lock: lock protecting vlan_list
 320  * @bat_iv: B.A.T.M.A.N. IV private structure
 321  */
 322 struct batadv_orig_node {
 323         u8 orig[ETH_ALEN];
 324         struct hlist_head ifinfo_list;
 325         struct batadv_orig_ifinfo *last_bonding_candidate;
 326 #ifdef CONFIG_BATMAN_ADV_DAT
 327         batadv_dat_addr_t dat_addr;
 328 #endif
 329         unsigned long last_seen;
 330         unsigned long bcast_seqno_reset;
 331 #ifdef CONFIG_BATMAN_ADV_MCAST
 332         /* synchronizes mcast tvlv specific orig changes */
 333         spinlock_t mcast_handler_lock;
 334         u8 mcast_flags;
 335         struct hlist_node mcast_want_all_unsnoopables_node;
 336         struct hlist_node mcast_want_all_ipv4_node;
 337         struct hlist_node mcast_want_all_ipv6_node;
 338 #endif
 339         unsigned long capabilities;
 340         unsigned long capa_initialized;
 341         atomic_t last_ttvn;
 342         unsigned char *tt_buff;
 343         s16 tt_buff_len;
 344         spinlock_t tt_buff_lock; /* protects tt_buff & tt_buff_len */
 345         /* prevents from changing the table while reading it */
 346         spinlock_t tt_lock;
 347         DECLARE_BITMAP(bcast_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
 348         u32 last_bcast_seqno;
 349         struct hlist_head neigh_list;
 350         /* neigh_list_lock protects: neigh_list, ifinfo_list,
 351          * last_bonding_candidate and router
 352          */
 353         spinlock_t neigh_list_lock;
 354         struct hlist_node hash_entry;
 355         struct batadv_priv *bat_priv;
 356         /* bcast_seqno_lock protects: bcast_bits & last_bcast_seqno */
 357         spinlock_t bcast_seqno_lock;
 358         struct kref refcount;
 359         struct rcu_head rcu;
 360 #ifdef CONFIG_BATMAN_ADV_NC
 361         struct list_head in_coding_list;
 362         struct list_head out_coding_list;
 363         spinlock_t in_coding_list_lock; /* Protects in_coding_list */
 364         spinlock_t out_coding_list_lock; /* Protects out_coding_list */
 365 #endif
 366         struct batadv_frag_table_entry fragments[BATADV_FRAG_BUFFER_COUNT];
 367         struct hlist_head vlan_list;
 368         spinlock_t vlan_list_lock; /* protects vlan_list */
 369         struct batadv_orig_bat_iv bat_iv;
 370 };
 371
 372 /**
 373  * enum batadv_orig_capabilities - orig node capabilities
 374  * @BATADV_ORIG_CAPA_HAS_DAT: orig node has distributed arp table enabled
 375  * @BATADV_ORIG_CAPA_HAS_NC: orig node has network coding enabled
 376  * @BATADV_ORIG_CAPA_HAS_TT: orig node has tt capability
 377  * @BATADV_ORIG_CAPA_HAS_MCAST: orig node has some multicast capability
 378  *  (= orig node announces a tvlv of type BATADV_TVLV_MCAST)
 379  */
 380 enum batadv_orig_capabilities {
 381         BATADV_ORIG_CAPA_HAS_DAT,
 382         BATADV_ORIG_CAPA_HAS_NC,
 383         BATADV_ORIG_CAPA_HAS_TT,
 384         BATADV_ORIG_CAPA_HAS_MCAST,
 385 };
 386
 387 /**
 388  * struct batadv_gw_node - structure for orig nodes announcing gw capabilities
 389  * @list: list node for batadv_priv_gw::list
 390  * @orig_node: pointer to corresponding orig node
 391  * @bandwidth_down: advertised uplink download bandwidth
 392  * @bandwidth_up: advertised uplink upload bandwidth
 393  * @refcount: number of contexts the object is used
 394  * @rcu: struct used for freeing in an RCU-safe manner
 395  */
 396 struct batadv_gw_node {
 397         struct hlist_node list;
 398         struct batadv_orig_node *orig_node;
 399         u32 bandwidth_down;
 400         u32 bandwidth_up;
 401         struct kref refcount;
 402         struct rcu_head rcu;
 403 };
 404
 405 DECLARE_EWMA(throughput, 10, 8)
 406
 407 /**
 408  * struct batadv_hardif_neigh_node_bat_v - B.A.T.M.A.N. V private neighbor
 409  *  information
 410  * @throughput: ewma link throughput towards this neighbor
 411  * @elp_interval: time interval between two ELP transmissions
 412  * @elp_latest_seqno: latest and best known ELP sequence number
 413  * @last_unicast_tx: when the last unicast packet has been sent to this neighbor
 414  * @metric_work: work queue callback item for metric update
 415  */
 416 struct batadv_hardif_neigh_node_bat_v {
 417         struct ewma_throughput throughput;
 418         u32 elp_interval;
 419         u32 elp_latest_seqno;
 420         unsigned long last_unicast_tx;
 421         struct work_struct metric_work;
 422 };
 423
 424 /**
 425  * struct batadv_hardif_neigh_node - unique neighbor per hard-interface
 426  * @list: list node for batadv_hard_iface::neigh_list
 427  * @addr: the MAC address of the neighboring interface
 428  * @orig: the address of the originator this neighbor node belongs to
 429  * @if_incoming: pointer to incoming hard-interface
 430  * @last_seen: when last packet via this neighbor was received
 431  * @bat_v: B.A.T.M.A.N. V private data
 432  * @refcount: number of contexts the object is used
 433  * @rcu: struct used for freeing in a RCU-safe manner
 434  */
 435 struct batadv_hardif_neigh_node {
 436         struct hlist_node list;
 437         u8 addr[ETH_ALEN];
 438         u8 orig[ETH_ALEN];
 439         struct batadv_hard_iface *if_incoming;
 440         unsigned long last_seen;
 441 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
 442         struct batadv_hardif_neigh_node_bat_v bat_v;
 443 #endif
 444         struct kref refcount;
 445         struct rcu_head rcu;
 446 };
 447
 448 /**
 449  * struct batadv_neigh_node - structure for single hops neighbors
 450  * @list: list node for batadv_orig_node::neigh_list
 451  * @orig_node: pointer to corresponding orig_node
 452  * @addr: the MAC address of the neighboring interface
 453  * @ifinfo_list: list for routing metrics per outgoing interface
 454  * @ifinfo_lock: lock protecting private ifinfo members and list
 455  * @if_incoming: pointer to incoming hard-interface
 456  * @last_seen: when last packet via this neighbor was received
 457  * @hardif_neigh: hardif_neigh of this neighbor
 458  * @refcount: number of contexts the object is used
 459  * @rcu: struct used for freeing in an RCU-safe manner
 460  */
 461 struct batadv_neigh_node {
 462         struct hlist_node list;
 463         struct batadv_orig_node *orig_node;
 464         u8 addr[ETH_ALEN];
 465         struct hlist_head ifinfo_list;
 466         spinlock_t ifinfo_lock; /* protects ifinfo_list and its members */
 467         struct batadv_hard_iface *if_incoming;
 468         unsigned long last_seen;
 469         struct batadv_hardif_neigh_node *hardif_neigh;
 470         struct kref refcount;
 471         struct rcu_head rcu;
 472 };
 473
 474 /**
 475  * struct batadv_neigh_ifinfo_bat_iv - neighbor information per outgoing
 476  *  interface for B.A.T.M.A.N. IV
 477  * @tq_recv: ring buffer of received TQ values from this neigh node
 478  * @tq_index: ring buffer index
 479  * @tq_avg: averaged tq of all tq values in the ring buffer (tq_recv)
 480  * @real_bits: bitfield containing the number of OGMs received from this neigh
 481  *  node (relative to orig_node->last_real_seqno)
 482  * @real_packet_count: counted result of real_bits
 483  */
 484 struct batadv_neigh_ifinfo_bat_iv {
 485         u8 tq_recv[BATADV_TQ_GLOBAL_WINDOW_SIZE];
 486         u8 tq_index;
 487         u8 tq_avg;
 488         DECLARE_BITMAP(real_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
 489         u8 real_packet_count;
 490 };
 491
 492 /**
 493  * struct batadv_neigh_ifinfo_bat_v - neighbor information per outgoing
 494  *  interface for B.A.T.M.A.N. V
 495  * @throughput: last throughput metric received from originator via this neigh
 496  * @last_seqno: last sequence number known for this neighbor
 497  */
 498 struct batadv_neigh_ifinfo_bat_v {
 499         u32 throughput;
 500         u32 last_seqno;
 501 };
 502
 503 /**
 504  * struct batadv_neigh_ifinfo - neighbor information per outgoing interface
 505  * @list: list node for batadv_neigh_node::ifinfo_list
 506  * @if_outgoing: pointer to outgoing hard-interface
 507  * @bat_iv: B.A.T.M.A.N. IV private structure
 508  * @bat_v: B.A.T.M.A.N. V private data
 509  * @last_ttl: last received ttl from this neigh node
 510  * @refcount: number of contexts the object is used
 511  * @rcu: struct used for freeing in a RCU-safe manner
 512  */
 513 struct batadv_neigh_ifinfo {
 514         struct hlist_node list;
 515         struct batadv_hard_iface *if_outgoing;
 516         struct batadv_neigh_ifinfo_bat_iv bat_iv;
 517 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
 518         struct batadv_neigh_ifinfo_bat_v bat_v;
 519 #endif
 520         u8 last_ttl;
 521         struct kref refcount;
 522         struct rcu_head rcu;
 523 };
 524
 525 #ifdef CONFIG_BATMAN_ADV_BLA
 526
 527 /**
 528  * struct batadv_bcast_duplist_entry - structure for LAN broadcast suppression
 529  * @orig: mac address of orig node orginating the broadcast
 530  * @crc: crc32 checksum of broadcast payload
 531  * @entrytime: time when the broadcast packet was received
 532  */
 533 struct batadv_bcast_duplist_entry {
 534         u8 orig[ETH_ALEN];
 535         __be32 crc;
 536         unsigned long entrytime;
 537 };
 538 #endif
 539
 540 /**
 541  * enum batadv_counters - indices for traffic counters
 542  * @BATADV_CNT_TX: transmitted payload traffic packet counter
 543  * @BATADV_CNT_TX_BYTES: transmitted payload traffic bytes counter
 544  * @BATADV_CNT_TX_DROPPED: dropped transmission payload traffic packet counter
 545  * @BATADV_CNT_RX: received payload traffic packet counter
 546  * @BATADV_CNT_RX_BYTES: received payload traffic bytes counter
 547  * @BATADV_CNT_FORWARD: forwarded payload traffic packet counter
 548  * @BATADV_CNT_FORWARD_BYTES: forwarded payload traffic bytes counter
 549  * @BATADV_CNT_MGMT_TX: transmitted routing protocol traffic packet counter
 550  * @BATADV_CNT_MGMT_TX_BYTES: transmitted routing protocol traffic bytes counter
 551  * @BATADV_CNT_MGMT_RX: received routing protocol traffic packet counter
 552  * @BATADV_CNT_MGMT_RX_BYTES: received routing protocol traffic bytes counter
 553  * @BATADV_CNT_FRAG_TX: transmitted fragment traffic packet counter
 554  * @BATADV_CNT_FRAG_TX_BYTES: transmitted fragment traffic bytes counter
 555  * @BATADV_CNT_FRAG_RX: received fragment traffic packet counter
 556  * @BATADV_CNT_FRAG_RX_BYTES: received fragment traffic bytes counter
 557  * @BATADV_CNT_FRAG_FWD: forwarded fragment traffic packet counter
 558  * @BATADV_CNT_FRAG_FWD_BYTES: forwarded fragment traffic bytes counter
 559  * @BATADV_CNT_TT_REQUEST_TX: transmitted tt req traffic packet counter
 560  * @BATADV_CNT_TT_REQUEST_RX: received tt req traffic packet counter
 561  * @BATADV_CNT_TT_RESPONSE_TX: transmitted tt resp traffic packet counter
 562  * @BATADV_CNT_TT_RESPONSE_RX: received tt resp traffic packet counter
 563  * @BATADV_CNT_TT_ROAM_ADV_TX: transmitted tt roam traffic packet counter
 564  * @BATADV_CNT_TT_ROAM_ADV_RX: received tt roam traffic packet counter
 565  * @BATADV_CNT_DAT_GET_TX: transmitted dht GET traffic packet counter
 566  * @BATADV_CNT_DAT_GET_RX: received dht GET traffic packet counter
 567  * @BATADV_CNT_DAT_PUT_TX: transmitted dht PUT traffic packet counter
 568  * @BATADV_CNT_DAT_PUT_RX: received dht PUT traffic packet counter
 569  * @BATADV_CNT_DAT_CACHED_REPLY_TX: transmitted dat cache reply traffic packet
 570  *  counter
 571  * @BATADV_CNT_NC_CODE: transmitted nc-combined traffic packet counter
 572  * @BATADV_CNT_NC_CODE_BYTES: transmitted nc-combined traffic bytes counter
 573  * @BATADV_CNT_NC_RECODE: transmitted nc-recombined traffic packet counter
 574  * @BATADV_CNT_NC_RECODE_BYTES: transmitted nc-recombined traffic bytes counter
 575  * @BATADV_CNT_NC_BUFFER: counter for packets buffered for later nc decoding
 576  * @BATADV_CNT_NC_DECODE: received and nc-decoded traffic packet counter
 577  * @BATADV_CNT_NC_DECODE_BYTES: received and nc-decoded traffic bytes counter
 578  * @BATADV_CNT_NC_DECODE_FAILED: received and decode-failed traffic packet
 579  *  counter
 580  * @BATADV_CNT_NC_SNIFFED: counter for nc-decoded packets received in promisc
 581  *  mode.
 582  * @BATADV_CNT_NUM: number of traffic counters
 583  */
 584 enum batadv_counters {
 585         BATADV_CNT_TX,
 586         BATADV_CNT_TX_BYTES,
 587         BATADV_CNT_TX_DROPPED,
 588         BATADV_CNT_RX,
 589         BATADV_CNT_RX_BYTES,
 590         BATADV_CNT_FORWARD,
 591         BATADV_CNT_FORWARD_BYTES,
 592         BATADV_CNT_MGMT_TX,
 593         BATADV_CNT_MGMT_TX_BYTES,
 594         BATADV_CNT_MGMT_RX,
 595         BATADV_CNT_MGMT_RX_BYTES,
 596         BATADV_CNT_FRAG_TX,
 597         BATADV_CNT_FRAG_TX_BYTES,
 598         BATADV_CNT_FRAG_RX,
 599         BATADV_CNT_FRAG_RX_BYTES,
 600         BATADV_CNT_FRAG_FWD,
 601         BATADV_CNT_FRAG_FWD_BYTES,
 602         BATADV_CNT_TT_REQUEST_TX,
 603         BATADV_CNT_TT_REQUEST_RX,
 604         BATADV_CNT_TT_RESPONSE_TX,
 605         BATADV_CNT_TT_RESPONSE_RX,
 606         BATADV_CNT_TT_ROAM_ADV_TX,
 607         BATADV_CNT_TT_ROAM_ADV_RX,
 608 #ifdef CONFIG_BATMAN_ADV_DAT
 609         BATADV_CNT_DAT_GET_TX,
 610         BATADV_CNT_DAT_GET_RX,
 611         BATADV_CNT_DAT_PUT_TX,
 612         BATADV_CNT_DAT_PUT_RX,
 613         BATADV_CNT_DAT_CACHED_REPLY_TX,
 614 #endif
 615 #ifdef CONFIG_BATMAN_ADV_NC
 616         BATADV_CNT_NC_CODE,
 617         BATADV_CNT_NC_CODE_BYTES,
 618         BATADV_CNT_NC_RECODE,
 619         BATADV_CNT_NC_RECODE_BYTES,
 620         BATADV_CNT_NC_BUFFER,
 621         BATADV_CNT_NC_DECODE,
 622         BATADV_CNT_NC_DECODE_BYTES,
 623         BATADV_CNT_NC_DECODE_FAILED,
 624         BATADV_CNT_NC_SNIFFED,
 625 #endif
 626         BATADV_CNT_NUM,
 627 };
 628
 629 /**
 630  * struct batadv_priv_tt - per mesh interface translation table data
 631  * @vn: translation table version number
 632  * @ogm_append_cnt: counter of number of OGMs containing the local tt diff
 633  * @local_changes: changes registered in an originator interval
 634  * @changes_list: tracks tt local changes within an originator interval
 635  * @local_hash: local translation table hash table
 636  * @global_hash: global translation table hash table
 637  * @req_list: list of pending & unanswered tt_requests
 638  * @roam_list: list of the last roaming events of each client limiting the
 639  *  number of roaming events to avoid route flapping
 640  * @changes_list_lock: lock protecting changes_list
 641  * @req_list_lock: lock protecting req_list
 642  * @roam_list_lock: lock protecting roam_list
 643  * @last_changeset: last tt changeset this host has generated
 644  * @last_changeset_len: length of last tt changeset this host has generated
 645  * @last_changeset_lock: lock protecting last_changeset & last_changeset_len
 646  * @commit_lock: prevents from executing a local TT commit while reading the
 647  *  local table. The local TT commit is made up by two operations (data
 648  *  structure update and metdata -CRC/TTVN- recalculation) and they have to be
 649  *  executed atomically in order to avoid another thread to read the
 650  *  table/metadata between those.
 651  * @work: work queue callback item for translation table purging
 652  */
 653 struct batadv_priv_tt {
 654         atomic_t vn;
 655         atomic_t ogm_append_cnt;
 656         atomic_t local_changes;
 657         struct list_head changes_list;
 658         struct batadv_hashtable *local_hash;
 659         struct batadv_hashtable *global_hash;
 660         struct hlist_head req_list;
 661         struct list_head roam_list;
 662         spinlock_t changes_list_lock; /* protects changes */
 663         spinlock_t req_list_lock; /* protects req_list */
 664         spinlock_t roam_list_lock; /* protects roam_list */
 665         unsigned char *last_changeset;
 666         s16 last_changeset_len;
 667         /* protects last_changeset & last_changeset_len */
 668         spinlock_t last_changeset_lock;
 669         /* prevents from executing a commit while reading the table */
 670         spinlock_t commit_lock;
 671         struct delayed_work work;
 672 };
 673
 674 #ifdef CONFIG_BATMAN_ADV_BLA
 675
 676 /**
 677  * struct batadv_priv_bla - per mesh interface bridge loope avoidance data
 678  * @num_requests: number of bla requests in flight
 679  * @claim_hash: hash table containing mesh nodes this host has claimed
 680  * @backbone_hash: hash table containing all detected backbone gateways
 681  * @loopdetect_addr: MAC address used for own loopdetection frames
 682  * @loopdetect_lasttime: time when the loopdetection frames were sent
 683  * @loopdetect_next: how many periods to wait for the next loopdetect process
 684  * @bcast_duplist: recently received broadcast packets array (for broadcast
 685  *  duplicate suppression)
 686  * @bcast_duplist_curr: index of last broadcast packet added to bcast_duplist
 687  * @bcast_duplist_lock: lock protecting bcast_duplist & bcast_duplist_curr
 688  * @claim_dest: local claim data (e.g. claim group)
 689  * @work: work queue callback item for cleanups & bla announcements
 690  */
 691 struct batadv_priv_bla {
 692         atomic_t num_requests;
 693         struct batadv_hashtable *claim_hash;
 694         struct batadv_hashtable *backbone_hash;
 695         u8 loopdetect_addr[ETH_ALEN];
 696         unsigned long loopdetect_lasttime;
 697         atomic_t loopdetect_next;
 698         struct batadv_bcast_duplist_entry bcast_duplist[BATADV_DUPLIST_SIZE];
 699         int bcast_duplist_curr;
 700         /* protects bcast_duplist & bcast_duplist_curr */
 701         spinlock_t bcast_duplist_lock;
 702         struct batadv_bla_claim_dst claim_dest;
 703         struct delayed_work work;
 704 };
 705 #endif
 706
 707 #ifdef CONFIG_BATMAN_ADV_DEBUG
 708
 709 /**
 710  * struct batadv_priv_debug_log - debug logging data
 711  * @log_buff: buffer holding the logs (ring bufer)
 712  * @log_start: index of next character to read
 713  * @log_end: index of next character to write
 714  * @lock: lock protecting log_buff, log_start & log_end
 715  * @queue_wait: log reader's wait queue
 716  */
 717 struct batadv_priv_debug_log {
 718         char log_buff[BATADV_LOG_BUF_LEN];
 719         unsigned long log_start;
 720         unsigned long log_end;
 721         spinlock_t lock; /* protects log_buff, log_start and log_end */
 722         wait_queue_head_t queue_wait;
 723 };
 724 #endif
 725
 726 /**
 727  * struct batadv_priv_gw - per mesh interface gateway data
 728  * @gateway_list: list of available gateway nodes
 729  * @list_lock: lock protecting gateway_list & curr_gw
 730  * @curr_gw: pointer to currently selected gateway node
 731  * @mode: gateway operation: off, client or server (see batadv_gw_modes)
 732  * @sel_class: gateway selection class (applies if gw_mode client)
 733  * @bandwidth_down: advertised uplink download bandwidth (if gw_mode server)
 734  * @bandwidth_up: advertised uplink upload bandwidth (if gw_mode server)
 735  * @reselect: bool indicating a gateway re-selection is in progress
 736  */
 737 struct batadv_priv_gw {
 738         struct hlist_head gateway_list;
 739         spinlock_t list_lock; /* protects gateway_list & curr_gw */
 740         struct batadv_gw_node __rcu *curr_gw;  /* rcu protected pointer */
 741         atomic_t mode;
 742         atomic_t sel_class;
 743         atomic_t bandwidth_down;
 744         atomic_t bandwidth_up;
 745         atomic_t reselect;
 746 };
 747
 748 /**
 749  * struct batadv_priv_tvlv - per mesh interface tvlv data
 750  * @container_list: list of registered tvlv containers to be sent with each OGM
 751  * @handler_list: list of the various tvlv content handlers
 752  * @container_list_lock: protects tvlv container list access
 753  * @handler_list_lock: protects handler list access
 754  */
 755 struct batadv_priv_tvlv {
 756         struct hlist_head container_list;
 757         struct hlist_head handler_list;
 758         spinlock_t container_list_lock; /* protects container_list */
 759         spinlock_t handler_list_lock; /* protects handler_list */
 760 };
 761
 762 #ifdef CONFIG_BATMAN_ADV_DAT
 763
 764 /**
 765  * struct batadv_priv_dat - per mesh interface DAT private data
 766  * @addr: node DAT address
 767  * @hash: hashtable representing the local ARP cache
 768  * @work: work queue callback item for cache purging
 769  */
 770 struct batadv_priv_dat {
 771         batadv_dat_addr_t addr;
 772         struct batadv_hashtable *hash;
 773         struct delayed_work work;
 774 };
 775 #endif
 776
 777 #ifdef CONFIG_BATMAN_ADV_MCAST
 778 /**
 779  * struct batadv_mcast_querier_state - IGMP/MLD querier state when bridged
 780  * @exists: whether a querier exists in the mesh
 781  * @shadowing: if a querier exists, whether it is potentially shadowing
 782  *  multicast listeners (i.e. querier is behind our own bridge segment)
 783  */
 784 struct batadv_mcast_querier_state {
 785         bool exists;
 786         bool shadowing;
 787 };
 788
 789 /**
 790  * struct batadv_priv_mcast - per mesh interface mcast data
 791  * @mla_list: list of multicast addresses we are currently announcing via TT
 792  * @want_all_unsnoopables_list: a list of orig_nodes wanting all unsnoopable
 793  *  multicast traffic
 794  * @want_all_ipv4_list: a list of orig_nodes wanting all IPv4 multicast traffic
 795  * @want_all_ipv6_list: a list of orig_nodes wanting all IPv6 multicast traffic
 796  * @querier_ipv4: the current state of an IGMP querier in the mesh
 797  * @querier_ipv6: the current state of an MLD querier in the mesh
 798  * @flags: the flags we have last sent in our mcast tvlv
 799  * @enabled: whether the multicast tvlv is currently enabled
 800  * @bridged: whether the soft interface has a bridge on top
 801  * @num_disabled: number of nodes that have no mcast tvlv
 802  * @num_want_all_unsnoopables: number of nodes wanting unsnoopable IP traffic
 803  * @num_want_all_ipv4: counter for items in want_all_ipv4_list
 804  * @num_want_all_ipv6: counter for items in want_all_ipv6_list
 805  * @want_lists_lock: lock for protecting modifications to mcast want lists
 806  *  (traversals are rcu-locked)
 807  * @work: work queue callback item for multicast TT and TVLV updates
 808  */
 809 struct batadv_priv_mcast {
 810         struct hlist_head mla_list; /* see __batadv_mcast_mla_update() */
 811         struct hlist_head want_all_unsnoopables_list;
 812         struct hlist_head want_all_ipv4_list;
 813         struct hlist_head want_all_ipv6_list;
 814         struct batadv_mcast_querier_state querier_ipv4;
 815         struct batadv_mcast_querier_state querier_ipv6;
 816         u8 flags;
 817         bool enabled;
 818         bool bridged;
 819         atomic_t num_disabled;
 820         atomic_t num_want_all_unsnoopables;
 821         atomic_t num_want_all_ipv4;
 822         atomic_t num_want_all_ipv6;
 823         /* protects want_all_{unsnoopables,ipv4,ipv6}_list */
 824         spinlock_t want_lists_lock;
 825         struct delayed_work work;
 826 };
 827 #endif
 828
 829 /**
 830  * struct batadv_priv_nc - per mesh interface network coding private data
 831  * @work: work queue callback item for cleanup
 832  * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
 833  * @min_tq: only consider neighbors for encoding if neigh_tq > min_tq
 834  * @max_fwd_delay: maximum packet forward delay to allow coding of packets
 835  * @max_buffer_time: buffer time for sniffed packets used to decoding
 836  * @timestamp_fwd_flush: timestamp of last forward packet queue flush
 837  * @timestamp_sniffed_purge: timestamp of last sniffed packet queue purge
 838  * @coding_hash: Hash table used to buffer skbs while waiting for another
 839  *  incoming skb to code it with. Skbs are added to the buffer just before being
 840  *  forwarded in routing.c
 841  * @decoding_hash: Hash table used to buffer skbs that might be needed to decode
 842  *  a received coded skb. The buffer is used for 1) skbs arriving on the
 843  *  soft-interface; 2) skbs overheard on the hard-interface; and 3) skbs
 844  *  forwarded by batman-adv.
 845  */
 846 struct batadv_priv_nc {
 847         struct delayed_work work;
 848         struct dentry *debug_dir;
 849         u8 min_tq;
 850         u32 max_fwd_delay;
 851         u32 max_buffer_time;
 852         unsigned long timestamp_fwd_flush;
 853         unsigned long timestamp_sniffed_purge;
 854         struct batadv_hashtable *coding_hash;
 855         struct batadv_hashtable *decoding_hash;
 856 };
 857
 858 /**
 859  * struct batadv_tp_unacked - unacked packet meta-information
 860  * @seqno: seqno of the unacked packet
 861  * @len: length of the packet
 862  * @list: list node for batadv_tp_vars::unacked_list
 863  *
 864  * This struct is supposed to represent a buffer unacked packet. However, since
 865  * the purpose of the TP meter is to count the traffic only, there is no need to
 866  * store the entire sk_buff, the starting offset and the length are enough
 867  */
 868 struct batadv_tp_unacked {
 869         u32 seqno;
 870         u16 len;
 871         struct list_head list;
 872 };
 873
 874 /**
 875  * enum batadv_tp_meter_role - Modus in tp meter session
 876  * @BATADV_TP_RECEIVER: Initialized as receiver
 877  * @BATADV_TP_SENDER: Initialized as sender
 878  */
 879 enum batadv_tp_meter_role {
 880         BATADV_TP_RECEIVER,
 881         BATADV_TP_SENDER
 882 };
 883
 884 /**
 885  * struct batadv_tp_vars - tp meter private variables per session
 886  * @list: list node for bat_priv::tp_list
 887  * @timer: timer for ack (receiver) and retry (sender)
 888  * @bat_priv: pointer to the mesh object
 889  * @start_time: start time in jiffies
 890  * @other_end: mac address of remote
 891  * @role: receiver/sender modi
 892  * @sending: sending binary semaphore: 1 if sending, 0 is not
 893  * @reason: reason for a stopped session
 894  * @finish_work: work item for the finishing procedure
 895  * @test_length: test length in milliseconds
 896  * @session: TP session identifier
 897  * @icmp_uid: local ICMP "socket" index
 898  * @dec_cwnd: decimal part of the cwnd used during linear growth
 899  * @cwnd: current size of the congestion window
 900  * @cwnd_lock: lock do protect @cwnd & @dec_cwnd
 901  * @ss_threshold: Slow Start threshold. Once cwnd exceeds this value the
 902  *  connection switches to the Congestion Avoidance state
 903  * @last_acked: last acked byte
 904  * @last_sent: last sent byte, not yet acked
 905  * @tot_sent: amount of data sent/ACKed so far
 906  * @dup_acks: duplicate ACKs counter
 907  * @fast_recovery: true if in Fast Recovery mode
 908  * @recover: last sent seqno when entering Fast Recovery
 909  * @rto: sender timeout
 910  * @srtt: smoothed RTT scaled by 2^3
 911  * @rttvar: RTT variation scaled by 2^2
 912  * @more_bytes: waiting queue anchor when waiting for more ack/retry timeout
 913  * @prerandom_offset: offset inside the prerandom buffer
 914  * @prerandom_lock: spinlock protecting access to prerandom_offset
 915  * @last_recv: last in-order received packet
 916  * @unacked_list: list of unacked packets (meta-info only)
 917  * @unacked_lock: protect unacked_list
 918  * @last_recv_time: time time (jiffies) a msg was received
 919  * @refcount: number of context where the object is used
 920  * @rcu: struct used for freeing in an RCU-safe manner
 921  */
 922 struct batadv_tp_vars {
 923         struct hlist_node list;
 924         struct timer_list timer;
 925         struct batadv_priv *bat_priv;
 926         unsigned long start_time;
 927         u8 other_end[ETH_ALEN];
 928         enum batadv_tp_meter_role role;
 929         atomic_t sending;
 930         enum batadv_tp_meter_reason reason;
 931         struct delayed_work finish_work;
 932         u32 test_length;
 933         u8 session[2];
 934         u8 icmp_uid;
 935
 936         /* sender variables */
 937         u16 dec_cwnd;
 938         u32 cwnd;
 939         spinlock_t cwnd_lock; /* Protects cwnd & dec_cwnd */
 940         u32 ss_threshold;
 941         atomic_t last_acked;
 942         u32 last_sent;
 943         atomic64_t tot_sent;
 944         atomic_t dup_acks;
 945         bool fast_recovery;
 946         u32 recover;
 947         u32 rto;
 948         u32 srtt;
 949         u32 rttvar;
 950         wait_queue_head_t more_bytes;
 951         u32 prerandom_offset;
 952         spinlock_t prerandom_lock; /* Protects prerandom_offset */
 953
 954         /* receiver variables */
 955         u32 last_recv;
 956         struct list_head unacked_list;
 957         spinlock_t unacked_lock; /* Protects unacked_list */
 958         unsigned long last_recv_time;
 959         struct kref refcount;
 960         struct rcu_head rcu;
 961 };
 962
 963 /**
 964  * struct batadv_softif_vlan - per VLAN attributes set
 965  * @bat_priv: pointer to the mesh object
 966  * @vid: VLAN identifier
 967  * @kobj: kobject for sysfs vlan subdirectory
 968  * @ap_isolation: AP isolation state
 969  * @tt: TT private attributes (VLAN specific)
 970  * @list: list node for bat_priv::softif_vlan_list
 971  * @refcount: number of context where this object is currently in use
 972  * @rcu: struct used for freeing in a RCU-safe manner
 973  */
 974 struct batadv_softif_vlan {
 975         struct batadv_priv *bat_priv;
 976         unsigned short vid;
 977         struct kobject *kobj;
 978         atomic_t ap_isolation;          /* boolean */
 979         struct batadv_vlan_tt tt;
 980         struct hlist_node list;
 981         struct kref refcount;
 982         struct rcu_head rcu;
 983 };
 984
 985 /**
 986  * struct batadv_priv_bat_v - B.A.T.M.A.N. V per soft-interface private data
 987  * @ogm_buff: buffer holding the OGM packet
 988  * @ogm_buff_len: length of the OGM packet buffer
 989  * @ogm_seqno: OGM sequence number - used to identify each OGM
 990  * @ogm_wq: workqueue used to schedule OGM transmissions
 991  */
 992 struct batadv_priv_bat_v {
 993         unsigned char *ogm_buff;
 994         int ogm_buff_len;
 995         atomic_t ogm_seqno;
 996         struct delayed_work ogm_wq;
 997 };
 998
 999 /**
1000  * struct batadv_priv - per mesh interface data
1001  * @mesh_state: current status of the mesh (inactive/active/deactivating)
1002  * @soft_iface: net device which holds this struct as private data
1003  * @bat_counters: mesh internal traffic statistic counters (see batadv_counters)
1004  * @aggregated_ogms: bool indicating whether OGM aggregation is enabled
1005  * @bonding: bool indicating whether traffic bonding is enabled
1006  * @fragmentation: bool indicating whether traffic fragmentation is enabled
1007  * @packet_size_max: max packet size that can be transmitted via
1008  *  multiple fragmented skbs or a single frame if fragmentation is disabled
1009  * @frag_seqno: incremental counter to identify chains of egress fragments
1010  * @bridge_loop_avoidance: bool indicating whether bridge loop avoidance is
1011  *  enabled
1012  * @distributed_arp_table: bool indicating whether distributed ARP table is
1013  *  enabled
1014  * @multicast_mode: Enable or disable multicast optimizations on this node's
1015  *  sender/originating side
1016  * @orig_interval: OGM broadcast interval in milliseconds
1017  * @hop_penalty: penalty which will be applied to an OGM's tq-field on every hop
1018  * @log_level: configured log level (see batadv_dbg_level)
1019  * @isolation_mark: the skb->mark value used to match packets for AP isolation
1020  * @isolation_mark_mask: bitmask identifying the bits in skb->mark to be used
1021  *  for the isolation mark
1022  * @bcast_seqno: last sent broadcast packet sequence number
1023  * @bcast_queue_left: number of remaining buffered broadcast packet slots
1024  * @batman_queue_left: number of remaining OGM packet slots
1025  * @num_ifaces: number of interfaces assigned to this mesh interface
1026  * @mesh_obj: kobject for sysfs mesh subdirectory
1027  * @debug_dir: dentry for debugfs batman-adv subdirectory
1028  * @forw_bat_list: list of aggregated OGMs that will be forwarded
1029  * @forw_bcast_list: list of broadcast packets that will be rebroadcasted
1030  * @tp_list: list of tp sessions
1031  * @tp_num: number of currently active tp sessions
1032  * @orig_hash: hash table containing mesh participants (orig nodes)
1033  * @forw_bat_list_lock: lock protecting forw_bat_list
1034  * @forw_bcast_list_lock: lock protecting forw_bcast_list
1035  * @tp_list_lock: spinlock protecting @tp_list
1036  * @orig_work: work queue callback item for orig node purging
1037  * @primary_if: one of the hard-interfaces assigned to this mesh interface
1038  *  becomes the primary interface
1039  * @algo_ops: routing algorithm used by this mesh interface
1040  * @softif_vlan_list: a list of softif_vlan structs, one per VLAN created on top
1041  *  of the mesh interface represented by this object
1042  * @softif_vlan_list_lock: lock protecting softif_vlan_list
1043  * @bla: bridge loope avoidance data
1044  * @debug_log: holding debug logging relevant data
1045  * @gw: gateway data
1046  * @tt: translation table data
1047  * @tvlv: type-version-length-value data
1048  * @dat: distributed arp table data
1049  * @mcast: multicast data
1050  * @network_coding: bool indicating whether network coding is enabled
1051  * @nc: network coding data
1052  * @bat_v: B.A.T.M.A.N. V per soft-interface private data
1053  */
1054 struct batadv_priv {
1055         atomic_t mesh_state;
1056         struct net_device *soft_iface;
1057         u64 __percpu *bat_counters; /* Per cpu counters */
1058         atomic_t aggregated_ogms;
1059         atomic_t bonding;
1060         atomic_t fragmentation;
1061         atomic_t packet_size_max;
1062         atomic_t frag_seqno;
1063 #ifdef CONFIG_BATMAN_ADV_BLA
1064         atomic_t bridge_loop_avoidance;
1065 #endif
1066 #ifdef CONFIG_BATMAN_ADV_DAT
1067         atomic_t distributed_arp_table;
1068 #endif
1069 #ifdef CONFIG_BATMAN_ADV_MCAST
1070         atomic_t multicast_mode;
1071 #endif
1072         atomic_t orig_interval;
1073         atomic_t hop_penalty;
1074 #ifdef CONFIG_BATMAN_ADV_DEBUG
1075         atomic_t log_level;
1076 #endif
1077         u32 isolation_mark;
1078         u32 isolation_mark_mask;
1079         atomic_t bcast_seqno;
1080         atomic_t bcast_queue_left;
1081         atomic_t batman_queue_left;
1082         char num_ifaces;
1083         struct kobject *mesh_obj;
1084         struct dentry *debug_dir;
1085         struct hlist_head forw_bat_list;
1086         struct hlist_head forw_bcast_list;
1087         struct hlist_head tp_list;
1088         struct batadv_hashtable *orig_hash;
1089         spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
1090         spinlock_t forw_bcast_list_lock; /* protects forw_bcast_list */
1091         spinlock_t tp_list_lock; /* protects tp_list */
1092         atomic_t tp_num;
1093         struct delayed_work orig_work;
1094         struct batadv_hard_iface __rcu *primary_if;  /* rcu protected pointer */
1095         struct batadv_algo_ops *algo_ops;
1096         struct hlist_head softif_vlan_list;
1097         spinlock_t softif_vlan_list_lock; /* protects softif_vlan_list */
1098 #ifdef CONFIG_BATMAN_ADV_BLA
1099         struct batadv_priv_bla bla;
1100 #endif
1101 #ifdef CONFIG_BATMAN_ADV_DEBUG
1102         struct batadv_priv_debug_log *debug_log;
1103 #endif
1104         struct batadv_priv_gw gw;
1105         struct batadv_priv_tt tt;
1106         struct batadv_priv_tvlv tvlv;
1107 #ifdef CONFIG_BATMAN_ADV_DAT
1108         struct batadv_priv_dat dat;
1109 #endif
1110 #ifdef CONFIG_BATMAN_ADV_MCAST
1111         struct batadv_priv_mcast mcast;
1112 #endif
1113 #ifdef CONFIG_BATMAN_ADV_NC
1114         atomic_t network_coding;
1115         struct batadv_priv_nc nc;
1116 #endif /* CONFIG_BATMAN_ADV_NC */
1117 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
1118         struct batadv_priv_bat_v bat_v;
1119 #endif
1120 };
1121
1122 /**
1123  * struct batadv_socket_client - layer2 icmp socket client data
1124  * @queue_list: packet queue for packets destined for this socket client
1125  * @queue_len: number of packets in the packet queue (queue_list)
1126  * @index: socket client's index in the batadv_socket_client_hash
1127  * @lock: lock protecting queue_list, queue_len & index
1128  * @queue_wait: socket client's wait queue
1129  * @bat_priv: pointer to soft_iface this client belongs to
1130  */
1131 struct batadv_socket_client {
1132         struct list_head queue_list;
1133         unsigned int queue_len;
1134         unsigned char index;
1135         spinlock_t lock; /* protects queue_list, queue_len & index */
1136         wait_queue_head_t queue_wait;
1137         struct batadv_priv *bat_priv;
1138 };
1139
1140 /**
1141  * struct batadv_socket_packet - layer2 icmp packet for socket client
1142  * @list: list node for batadv_socket_client::queue_list
1143  * @icmp_len: size of the layer2 icmp packet
1144  * @icmp_packet: layer2 icmp packet
1145  */
1146 struct batadv_socket_packet {
1147         struct list_head list;
1148         size_t icmp_len;
1149         u8 icmp_packet[BATADV_ICMP_MAX_PACKET_SIZE];
1150 };
1151
1152 #ifdef CONFIG_BATMAN_ADV_BLA
1153
1154 /**
1155  * struct batadv_bla_backbone_gw - batman-adv gateway bridged into the LAN
1156  * @orig: originator address of backbone node (mac address of primary iface)
1157  * @vid: vlan id this gateway was detected on
1158  * @hash_entry: hlist node for batadv_priv_bla::backbone_hash
1159  * @bat_priv: pointer to soft_iface this backbone gateway belongs to
1160  * @lasttime: last time we heard of this backbone gw
1161  * @wait_periods: grace time for bridge forward delays and bla group forming at
1162  *  bootup phase - no bcast traffic is formwared until it has elapsed
1163  * @request_sent: if this bool is set to true we are out of sync with this
1164  *  backbone gateway - no bcast traffic is formwared until the situation was
1165  *  resolved
1166  * @crc: crc16 checksum over all claims
1167  * @crc_lock: lock protecting crc
1168  * @report_work: work struct for reporting detected loops
1169  * @refcount: number of contexts the object is used
1170  * @rcu: struct used for freeing in an RCU-safe manner
1171  */
1172 struct batadv_bla_backbone_gw {
1173         u8 orig[ETH_ALEN];
1174         unsigned short vid;
1175         struct hlist_node hash_entry;
1176         struct batadv_priv *bat_priv;
1177         unsigned long lasttime;
1178         atomic_t wait_periods;
1179         atomic_t request_sent;
1180         u16 crc;
1181         spinlock_t crc_lock; /* protects crc */
1182         struct work_struct report_work;
1183         struct kref refcount;
1184         struct rcu_head rcu;
1185 };
1186
1187 /**
1188  * struct batadv_bla_claim - claimed non-mesh client structure
1189  * @addr: mac address of claimed non-mesh client
1190  * @vid: vlan id this client was detected on
1191  * @backbone_gw: pointer to backbone gw claiming this client
1192  * @backbone_lock: lock protecting backbone_gw pointer
1193  * @lasttime: last time we heard of claim (locals only)
1194  * @hash_entry: hlist node for batadv_priv_bla::claim_hash
1195  * @refcount: number of contexts the object is used
1196  * @rcu: struct used for freeing in an RCU-safe manner
1197  */
1198 struct batadv_bla_claim {
1199         u8 addr[ETH_ALEN];
1200         unsigned short vid;
1201         struct batadv_bla_backbone_gw *backbone_gw;
1202         spinlock_t backbone_lock; /* protects backbone_gw */
1203         unsigned long lasttime;
1204         struct hlist_node hash_entry;
1205         struct rcu_head rcu;
1206         struct kref refcount;
1207 };
1208 #endif
1209
1210 /**
1211  * struct batadv_tt_common_entry - tt local & tt global common data
1212  * @addr: mac address of non-mesh client
1213  * @vid: VLAN identifier
1214  * @hash_entry: hlist node for batadv_priv_tt::local_hash or for
1215  *  batadv_priv_tt::global_hash
1216  * @flags: various state handling flags (see batadv_tt_client_flags)
1217  * @added_at: timestamp used for purging stale tt common entries
1218  * @refcount: number of contexts the object is used
1219  * @rcu: struct used for freeing in an RCU-safe manner
1220  */
1221 struct batadv_tt_common_entry {
1222         u8 addr[ETH_ALEN];
1223         unsigned short vid;
1224         struct hlist_node hash_entry;
1225         u16 flags;
1226         unsigned long added_at;
1227         struct kref refcount;
1228         struct rcu_head rcu;
1229 };
1230
1231 /**
1232  * struct batadv_tt_local_entry - translation table local entry data
1233  * @common: general translation table data
1234  * @last_seen: timestamp used for purging stale tt local entries
1235  * @vlan: soft-interface vlan of the entry
1236  */
1237 struct batadv_tt_local_entry {
1238         struct batadv_tt_common_entry common;
1239         unsigned long last_seen;
1240         struct batadv_softif_vlan *vlan;
1241 };
1242
1243 /**
1244  * struct batadv_tt_global_entry - translation table global entry data
1245  * @common: general translation table data
1246  * @orig_list: list of orig nodes announcing this non-mesh client
1247  * @orig_list_count: number of items in the orig_list
1248  * @list_lock: lock protecting orig_list
1249  * @roam_at: time at which TT_GLOBAL_ROAM was set
1250  */
1251 struct batadv_tt_global_entry {
1252         struct batadv_tt_common_entry common;
1253         struct hlist_head orig_list;
1254         atomic_t orig_list_count;
1255         spinlock_t list_lock;   /* protects orig_list */
1256         unsigned long roam_at;
1257 };
1258
1259 /**
1260  * struct batadv_tt_orig_list_entry - orig node announcing a non-mesh client
1261  * @orig_node: pointer to orig node announcing this non-mesh client
1262  * @ttvn: translation table version number which added the non-mesh client
1263  * @flags: per orig entry TT sync flags
1264  * @list: list node for batadv_tt_global_entry::orig_list
1265  * @refcount: number of contexts the object is used
1266  * @rcu: struct used for freeing in an RCU-safe manner
1267  */
1268 struct batadv_tt_orig_list_entry {
1269         struct batadv_orig_node *orig_node;
1270         u8 ttvn;
1271         u8 flags;
1272         struct hlist_node list;
1273         struct kref refcount;
1274         struct rcu_head rcu;
1275 };
1276
1277 /**
1278  * struct batadv_tt_change_node - structure for tt changes occurred
1279  * @list: list node for batadv_priv_tt::changes_list
1280  * @change: holds the actual translation table diff data
1281  */
1282 struct batadv_tt_change_node {
1283         struct list_head list;
1284         struct batadv_tvlv_tt_change change;
1285 };
1286
1287 /**
1288  * struct batadv_tt_req_node - data to keep track of the tt requests in flight
1289  * @addr: mac address address of the originator this request was sent to
1290  * @issued_at: timestamp used for purging stale tt requests
1291  * @refcount: number of contexts the object is used by
1292  * @list: list node for batadv_priv_tt::req_list
1293  */
1294 struct batadv_tt_req_node {
1295         u8 addr[ETH_ALEN];
1296         unsigned long issued_at;
1297         struct kref refcount;
1298         struct hlist_node list;
1299 };
1300
1301 /**
1302  * struct batadv_tt_roam_node - roaming client data
1303  * @addr: mac address of the client in the roaming phase
1304  * @counter: number of allowed roaming events per client within a single
1305  *  OGM interval (changes are committed with each OGM)
1306  * @first_time: timestamp used for purging stale roaming node entries
1307  * @list: list node for batadv_priv_tt::roam_list
1308  */
1309 struct batadv_tt_roam_node {
1310         u8 addr[ETH_ALEN];
1311         atomic_t counter;
1312         unsigned long first_time;
1313         struct list_head list;
1314 };
1315
1316 /**
1317  * struct batadv_nc_node - network coding node
1318  * @list: next and prev pointer for the list handling
1319  * @addr: the node's mac address
1320  * @refcount: number of contexts the object is used by
1321  * @rcu: struct used for freeing in an RCU-safe manner
1322  * @orig_node: pointer to corresponding orig node struct
1323  * @last_seen: timestamp of last ogm received from this node
1324  */
1325 struct batadv_nc_node {
1326         struct list_head list;
1327         u8 addr[ETH_ALEN];
1328         struct kref refcount;
1329         struct rcu_head rcu;
1330         struct batadv_orig_node *orig_node;
1331         unsigned long last_seen;
1332 };
1333
1334 /**
1335  * struct batadv_nc_path - network coding path
1336  * @hash_entry: next and prev pointer for the list handling
1337  * @rcu: struct used for freeing in an RCU-safe manner
1338  * @refcount: number of contexts the object is used by
1339  * @packet_list: list of buffered packets for this path
1340  * @packet_list_lock: access lock for packet list
1341  * @next_hop: next hop (destination) of path
1342  * @prev_hop: previous hop (source) of path
1343  * @last_valid: timestamp for last validation of path
1344  */
1345 struct batadv_nc_path {
1346         struct hlist_node hash_entry;
1347         struct rcu_head rcu;
1348         struct kref refcount;
1349         struct list_head packet_list;
1350         spinlock_t packet_list_lock; /* Protects packet_list */
1351         u8 next_hop[ETH_ALEN];
1352         u8 prev_hop[ETH_ALEN];
1353         unsigned long last_valid;
1354 };
1355
1356 /**
1357  * struct batadv_nc_packet - network coding packet used when coding and
1358  *  decoding packets
1359  * @list: next and prev pointer for the list handling
1360  * @packet_id: crc32 checksum of skb data
1361  * @timestamp: field containing the info when the packet was added to path
1362  * @neigh_node: pointer to original next hop neighbor of skb
1363  * @skb: skb which can be encoded or used for decoding
1364  * @nc_path: pointer to path this nc packet is attached to
1365  */
1366 struct batadv_nc_packet {
1367         struct list_head list;
1368         __be32 packet_id;
1369         unsigned long timestamp;
1370         struct batadv_neigh_node *neigh_node;
1371         struct sk_buff *skb;
1372         struct batadv_nc_path *nc_path;
1373 };
1374
1375 /**
1376  * struct batadv_skb_cb - control buffer structure used to store private data
1377  *  relevant to batman-adv in the skb->cb buffer in skbs.
1378  * @decoded: Marks a skb as decoded, which is checked when searching for coding
1379  *  opportunities in network-coding.c
1380  * @num_bcasts: Counter for broadcast packet retransmissions
1381  */
1382 struct batadv_skb_cb {
1383         bool decoded;
1384         unsigned int num_bcasts;
1385 };
1386
1387 /**
1388  * struct batadv_forw_packet - structure for bcast packets to be sent/forwarded
1389  * @list: list node for batadv_priv::forw_{bat,bcast}_list
1390  * @cleanup_list: list node for purging functions
1391  * @send_time: execution time for delayed_work (packet sending)
1392  * @own: bool for locally generated packets (local OGMs are re-scheduled after
1393  *  sending)
1394  * @skb: bcast packet's skb buffer
1395  * @packet_len: size of aggregated OGM packet inside the skb buffer
1396  * @direct_link_flags: direct link flags for aggregated OGM packets
1397  * @num_packets: counter for aggregated OGMv1 packets
1398  * @delayed_work: work queue callback item for packet sending
1399  * @if_incoming: pointer to incoming hard-iface or primary iface if
1400  *  locally generated packet
1401  * @if_outgoing: packet where the packet should be sent to, or NULL if
1402  *  unspecified
1403  * @queue_left: The queue (counter) this packet was applied to
1404  */
1405 struct batadv_forw_packet {
1406         struct hlist_node list;
1407         struct hlist_node cleanup_list;
1408         unsigned long send_time;
1409         u8 own;
1410         struct sk_buff *skb;
1411         u16 packet_len;
1412         u32 direct_link_flags;
1413         u8 num_packets;
1414         struct delayed_work delayed_work;
1415         struct batadv_hard_iface *if_incoming;
1416         struct batadv_hard_iface *if_outgoing;
1417         atomic_t *queue_left;
1418 };
1419
1420 /**
1421  * struct batadv_algo_iface_ops - mesh algorithm callbacks (interface specific)
1422  * @activate: start routing mechanisms when hard-interface is brought up
1423  *  (optional)
1424  * @enable: init routing info when hard-interface is enabled
1425  * @disable: de-init routing info when hard-interface is disabled
1426  * @update_mac: (re-)init mac addresses of the protocol information
1427  *  belonging to this hard-interface
1428  * @primary_set: called when primary interface is selected / changed
1429  */
1430 struct batadv_algo_iface_ops {
1431         void (*activate)(struct batadv_hard_iface *hard_iface);
1432         int (*enable)(struct batadv_hard_iface *hard_iface);
1433         void (*disable)(struct batadv_hard_iface *hard_iface);
1434         void (*update_mac)(struct batadv_hard_iface *hard_iface);
1435         void (*primary_set)(struct batadv_hard_iface *hard_iface);
1436 };
1437
1438 /**
1439  * struct batadv_algo_neigh_ops - mesh algorithm callbacks (neighbour specific)
1440  * @hardif_init: called on creation of single hop entry
1441  *  (optional)
1442  * @cmp: compare the metrics of two neighbors for their respective outgoing
1443  *  interfaces
1444  * @is_similar_or_better: check if neigh1 is equally similar or better than
1445  *  neigh2 for their respective outgoing interface from the metric prospective
1446  * @print: print the single hop neighbor list (optional)
1447  * @dump: dump neighbors to a netlink socket (optional)
1448  */
1449 struct batadv_algo_neigh_ops {
1450         void (*hardif_init)(struct batadv_hardif_neigh_node *neigh);
1451         int (*cmp)(struct batadv_neigh_node *neigh1,
1452                    struct batadv_hard_iface *if_outgoing1,
1453                    struct batadv_neigh_node *neigh2,
1454                    struct batadv_hard_iface *if_outgoing2);
1455         bool (*is_similar_or_better)(struct batadv_neigh_node *neigh1,
1456                                      struct batadv_hard_iface *if_outgoing1,
1457                                      struct batadv_neigh_node *neigh2,
1458                                      struct batadv_hard_iface *if_outgoing2);
1459 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
1460         void (*print)(struct batadv_priv *priv, struct seq_file *seq);
1461 #endif
1462         void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
1463                      struct batadv_priv *priv,
1464                      struct batadv_hard_iface *hard_iface);
1465 };
1466
1467 /**
1468  * struct batadv_algo_orig_ops - mesh algorithm callbacks (originator specific)
1469  * @free: free the resources allocated by the routing algorithm for an orig_node
1470  *  object (optional)
1471  * @add_if: ask the routing algorithm to apply the needed changes to the
1472  *  orig_node due to a new hard-interface being added into the mesh (optional)
1473  * @del_if: ask the routing algorithm to apply the needed changes to the
1474  *  orig_node due to an hard-interface being removed from the mesh (optional)
1475  * @print: print the originator table (optional)
1476  * @dump: dump originators to a netlink socket (optional)
1477  */
1478 struct batadv_algo_orig_ops {
1479         void (*free)(struct batadv_orig_node *orig_node);
1480         int (*add_if)(struct batadv_orig_node *orig_node, int max_if_num);
1481         int (*del_if)(struct batadv_orig_node *orig_node, int max_if_num,
1482                       int del_if_num);
1483 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
1484         void (*print)(struct batadv_priv *priv, struct seq_file *seq,
1485                       struct batadv_hard_iface *hard_iface);
1486 #endif
1487         void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
1488                      struct batadv_priv *priv,
1489                      struct batadv_hard_iface *hard_iface);
1490 };
1491
1492 /**
1493  * struct batadv_algo_gw_ops - mesh algorithm callbacks (GW specific)
1494  * @init_sel_class: initialize GW selection class (optional)
1495  * @store_sel_class: parse and stores a new GW selection class (optional)
1496  * @show_sel_class: prints the current GW selection class (optional)
1497  * @get_best_gw_node: select the best GW from the list of available nodes
1498  *  (optional)
1499  * @is_eligible: check if a newly discovered GW is a potential candidate for
1500  *  the election as best GW (optional)
1501  * @print: print the gateway table (optional)
1502  * @dump: dump gateways to a netlink socket (optional)
1503  */
1504 struct batadv_algo_gw_ops {
1505         void (*init_sel_class)(struct batadv_priv *bat_priv);
1506         ssize_t (*store_sel_class)(struct batadv_priv *bat_priv, char *buff,
1507                                    size_t count);
1508         ssize_t (*show_sel_class)(struct batadv_priv *bat_priv, char *buff);
1509         struct batadv_gw_node *(*get_best_gw_node)
1510                 (struct batadv_priv *bat_priv);
1511         bool (*is_eligible)(struct batadv_priv *bat_priv,
1512                             struct batadv_orig_node *curr_gw_orig,
1513                             struct batadv_orig_node *orig_node);
1514 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
1515         void (*print)(struct batadv_priv *bat_priv, struct seq_file *seq);
1516 #endif
1517         void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
1518                      struct batadv_priv *priv);
1519 };
1520
1521 /**
1522  * struct batadv_algo_ops - mesh algorithm callbacks
1523  * @list: list node for the batadv_algo_list
1524  * @name: name of the algorithm
1525  * @iface: callbacks related to interface handling
1526  * @neigh: callbacks related to neighbors handling
1527  * @orig: callbacks related to originators handling
1528  * @gw: callbacks related to GW mode
1529  */
1530 struct batadv_algo_ops {
1531         struct hlist_node list;
1532         char *name;
1533         struct batadv_algo_iface_ops iface;
1534         struct batadv_algo_neigh_ops neigh;
1535         struct batadv_algo_orig_ops orig;
1536         struct batadv_algo_gw_ops gw;
1537 };
1538
1539 /**
1540  * struct batadv_dat_entry - it is a single entry of batman-adv ARP backend. It
1541  * is used to stored ARP entries needed for the global DAT cache
1542  * @ip: the IPv4 corresponding to this DAT/ARP entry
1543  * @mac_addr: the MAC address associated to the stored IPv4
1544  * @vid: the vlan ID associated to this entry
1545  * @last_update: time in jiffies when this entry was refreshed last time
1546  * @hash_entry: hlist node for batadv_priv_dat::hash
1547  * @refcount: number of contexts the object is used
1548  * @rcu: struct used for freeing in an RCU-safe manner
1549  */
1550 struct batadv_dat_entry {
1551         __be32 ip;
1552         u8 mac_addr[ETH_ALEN];
1553         unsigned short vid;
1554         unsigned long last_update;
1555         struct hlist_node hash_entry;
1556         struct kref refcount;
1557         struct rcu_head rcu;
1558 };
1559
1560 /**
1561  * struct batadv_hw_addr - a list entry for a MAC address
1562  * @list: list node for the linking of entries
1563  * @addr: the MAC address of this list entry
1564  */
1565 struct batadv_hw_addr {
1566         struct hlist_node list;
1567         unsigned char addr[ETH_ALEN];
1568 };
1569
1570 /**
1571  * struct batadv_dat_candidate - candidate destination for DAT operations
1572  * @type: the type of the selected candidate. It can one of the following:
1573  *        - BATADV_DAT_CANDIDATE_NOT_FOUND
1574  *        - BATADV_DAT_CANDIDATE_ORIG
1575  * @orig_node: if type is BATADV_DAT_CANDIDATE_ORIG this field points to the
1576  *             corresponding originator node structure
1577  */
1578 struct batadv_dat_candidate {
1579         int type;
1580         struct batadv_orig_node *orig_node;
1581 };
1582
1583 /**
1584  * struct batadv_tvlv_container - container for tvlv appended to OGMs
1585  * @list: hlist node for batadv_priv_tvlv::container_list
1586  * @tvlv_hdr: tvlv header information needed to construct the tvlv
1587  * @refcount: number of contexts the object is used
1588  */
1589 struct batadv_tvlv_container {
1590         struct hlist_node list;
1591         struct batadv_tvlv_hdr tvlv_hdr;
1592         struct kref refcount;
1593 };
1594
1595 /**
1596  * struct batadv_tvlv_handler - handler for specific tvlv type and version
1597  * @list: hlist node for batadv_priv_tvlv::handler_list
1598  * @ogm_handler: handler callback which is given the tvlv payload to process on
1599  *  incoming OGM packets
1600  * @unicast_handler: handler callback which is given the tvlv payload to process
1601  *  on incoming unicast tvlv packets
1602  * @type: tvlv type this handler feels responsible for
1603  * @version: tvlv version this handler feels responsible for
1604  * @flags: tvlv handler flags
1605  * @refcount: number of contexts the object is used
1606  * @rcu: struct used for freeing in an RCU-safe manner
1607  */
1608 struct batadv_tvlv_handler {
1609         struct hlist_node list;
1610         void (*ogm_handler)(struct batadv_priv *bat_priv,
1611                             struct batadv_orig_node *orig,
1612                             u8 flags, void *tvlv_value, u16 tvlv_value_len);
1613         int (*unicast_handler)(struct batadv_priv *bat_priv,
1614                                u8 *src, u8 *dst,
1615                                void *tvlv_value, u16 tvlv_value_len);
1616         u8 type;
1617         u8 version;
1618         u8 flags;
1619         struct kref refcount;
1620         struct rcu_head rcu;
1621 };
1622
1623 /**
1624  * enum batadv_tvlv_handler_flags - tvlv handler flags definitions
1625  * @BATADV_TVLV_HANDLER_OGM_CIFNOTFND: tvlv ogm processing function will call
1626  *  this handler even if its type was not found (with no data)
1627  * @BATADV_TVLV_HANDLER_OGM_CALLED: interval tvlv handling flag - the API marks
1628  *  a handler as being called, so it won't be called if the
1629  *  BATADV_TVLV_HANDLER_OGM_CIFNOTFND flag was set
1630  */
1631 enum batadv_tvlv_handler_flags {
1632         BATADV_TVLV_HANDLER_OGM_CIFNOTFND = BIT(1),
1633         BATADV_TVLV_HANDLER_OGM_CALLED = BIT(2),
1634 };
1635
1636 /**
1637  * struct batadv_store_mesh_work - Work queue item to detach add/del interface
1638  *  from sysfs locks
1639  * @net_dev: netdevice to add/remove to/from batman-adv soft-interface
1640  * @soft_iface_name: name of soft-interface to modify
1641  * @work: work queue item
1642  */
1643 struct batadv_store_mesh_work {
1644         struct net_device *net_dev;
1645         char soft_iface_name[IFNAMSIZ];
1646         struct work_struct work;
1647 };
1648
1649 #endif /* _NET_BATMAN_ADV_TYPES_H_ */