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