net/batman-adv/types.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /* Copyright (C) 2007-2019  B.A.T.M.A.N. contributors:
   3  *
   4  * Marek Lindner, Simon Wunderlich
   5  */
   6
   7 #ifndef _NET_BATMAN_ADV_TYPES_H_
   8 #define _NET_BATMAN_ADV_TYPES_H_
   9
  10 #ifndef _NET_BATMAN_ADV_MAIN_H_
  11 #error only "main.h" can be included directly
  12 #endif
  13
  14 #include <linux/average.h>
  15 #include <linux/bitops.h>
  16 #include <linux/compiler.h>
  17 #include <linux/if_ether.h>
  18 #include <linux/kref.h>
  19 #include <linux/netdevice.h>
  20 #include <linux/netlink.h>
  21 #include <linux/sched.h> /* for linux/wait.h */
  22 #include <linux/spinlock.h>
  23 #include <linux/types.h>
  24 #include <linux/wait.h>
  25 #include <linux/workqueue.h>
  26 #include <uapi/linux/batadv_packet.h>
  27 #include <uapi/linux/batman_adv.h>
  28
  29 struct seq_file;
  30
  31 #ifdef CONFIG_BATMAN_ADV_DAT
  32
  33 /**
  34  * typedef batadv_dat_addr_t - type used for all DHT addresses
  35  *
  36  * If it is changed, BATADV_DAT_ADDR_MAX is changed as well.
  37  *
  38  * *Please be careful: batadv_dat_addr_t must be UNSIGNED*
  39  */
  40 typedef u16 batadv_dat_addr_t;
  41
  42 #endif /* CONFIG_BATMAN_ADV_DAT */
  43
  44 /**
  45  * enum batadv_dhcp_recipient - dhcp destination
  46  */
  47 enum batadv_dhcp_recipient {
  48         /** @BATADV_DHCP_NO: packet is not a dhcp message */
  49         BATADV_DHCP_NO = 0,
  50
  51         /** @BATADV_DHCP_TO_SERVER: dhcp message is directed to a server */
  52         BATADV_DHCP_TO_SERVER,
  53
  54         /** @BATADV_DHCP_TO_CLIENT: dhcp message is directed to a client */
  55         BATADV_DHCP_TO_CLIENT,
  56 };
  57
  58 /**
  59  * BATADV_TT_REMOTE_MASK - bitmask selecting the flags that are sent over the
  60  *  wire only
  61  */
  62 #define BATADV_TT_REMOTE_MASK   0x00FF
  63
  64 /**
  65  * BATADV_TT_SYNC_MASK - bitmask of the flags that need to be kept in sync
  66  *  among the nodes. These flags are used to compute the global/local CRC
  67  */
  68 #define BATADV_TT_SYNC_MASK     0x00F0
  69
  70 /**
  71  * struct batadv_hard_iface_bat_iv - per hard-interface B.A.T.M.A.N. IV data
  72  */
  73 struct batadv_hard_iface_bat_iv {
  74         /** @ogm_buff: buffer holding the OGM packet */
  75         unsigned char *ogm_buff;
  76
  77         /** @ogm_buff_len: length of the OGM packet buffer */
  78         int ogm_buff_len;
  79
  80         /** @ogm_seqno: OGM sequence number - used to identify each OGM */
  81         atomic_t ogm_seqno;
  82 };
  83
  84 /**
  85  * enum batadv_v_hard_iface_flags - interface flags useful to B.A.T.M.A.N. V
  86  */
  87 enum batadv_v_hard_iface_flags {
  88         /**
  89          * @BATADV_FULL_DUPLEX: tells if the connection over this link is
  90          *  full-duplex
  91          */
  92         BATADV_FULL_DUPLEX      = BIT(0),
  93
  94         /**
  95          * @BATADV_WARNING_DEFAULT: tells whether we have warned the user that
  96          *  no throughput data is available for this interface and that default
  97          *  values are assumed.
  98          */
  99         BATADV_WARNING_DEFAULT  = BIT(1),
 100 };
 101
 102 /**
 103  * struct batadv_hard_iface_bat_v - per hard-interface B.A.T.M.A.N. V data
 104  */
 105 struct batadv_hard_iface_bat_v {
 106         /** @elp_interval: time interval between two ELP transmissions */
 107         atomic_t elp_interval;
 108
 109         /** @elp_seqno: current ELP sequence number */
 110         atomic_t elp_seqno;
 111
 112         /** @elp_skb: base skb containing the ELP message to send */
 113         struct sk_buff *elp_skb;
 114
 115         /** @elp_wq: workqueue used to schedule ELP transmissions */
 116         struct delayed_work elp_wq;
 117
 118         /**
 119          * @throughput_override: throughput override to disable link
 120          *  auto-detection
 121          */
 122         atomic_t throughput_override;
 123
 124         /** @flags: interface specific flags */
 125         u8 flags;
 126 };
 127
 128 /**
 129  * enum batadv_hard_iface_wifi_flags - Flags describing the wifi configuration
 130  *  of a batadv_hard_iface
 131  */
 132 enum batadv_hard_iface_wifi_flags {
 133         /** @BATADV_HARDIF_WIFI_WEXT_DIRECT: it is a wext wifi device */
 134         BATADV_HARDIF_WIFI_WEXT_DIRECT = BIT(0),
 135
 136         /** @BATADV_HARDIF_WIFI_CFG80211_DIRECT: it is a cfg80211 wifi device */
 137         BATADV_HARDIF_WIFI_CFG80211_DIRECT = BIT(1),
 138
 139         /**
 140          * @BATADV_HARDIF_WIFI_WEXT_INDIRECT: link device is a wext wifi device
 141          */
 142         BATADV_HARDIF_WIFI_WEXT_INDIRECT = BIT(2),
 143
 144         /**
 145          * @BATADV_HARDIF_WIFI_CFG80211_INDIRECT: link device is a cfg80211 wifi
 146          * device
 147          */
 148         BATADV_HARDIF_WIFI_CFG80211_INDIRECT = BIT(3),
 149 };
 150
 151 /**
 152  * struct batadv_hard_iface - network device known to batman-adv
 153  */
 154 struct batadv_hard_iface {
 155         /** @list: list node for batadv_hardif_list */
 156         struct list_head list;
 157
 158         /** @if_status: status of the interface for batman-adv */
 159         char if_status;
 160
 161         /**
 162          * @num_bcasts: number of payload re-broadcasts on this interface (ARQ)
 163          */
 164         u8 num_bcasts;
 165
 166         /**
 167          * @wifi_flags: flags whether this is (directly or indirectly) a wifi
 168          *  interface
 169          */
 170         u32 wifi_flags;
 171
 172         /** @net_dev: pointer to the net_device */
 173         struct net_device *net_dev;
 174
 175         /** @hardif_obj: kobject of the per interface sysfs "mesh" directory */
 176         struct kobject *hardif_obj;
 177
 178         /** @refcount: number of contexts the object is used */
 179         struct kref refcount;
 180
 181         /**
 182          * @batman_adv_ptype: packet type describing packets that should be
 183          * processed by batman-adv for this interface
 184          */
 185         struct packet_type batman_adv_ptype;
 186
 187         /**
 188          * @soft_iface: the batman-adv interface which uses this network
 189          *  interface
 190          */
 191         struct net_device *soft_iface;
 192
 193         /** @rcu: struct used for freeing in an RCU-safe manner */
 194         struct rcu_head rcu;
 195
 196         /** @bat_iv: per hard-interface B.A.T.M.A.N. IV data */
 197         struct batadv_hard_iface_bat_iv bat_iv;
 198
 199 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
 200         /** @bat_v: per hard-interface B.A.T.M.A.N. V data */
 201         struct batadv_hard_iface_bat_v bat_v;
 202 #endif
 203
 204 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
 205         /**
 206          * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
 207          */
 208         struct dentry *debug_dir;
 209 #endif
 210
 211         /**
 212          * @neigh_list: list of unique single hop neighbors via this interface
 213          */
 214         struct hlist_head neigh_list;
 215
 216         /** @neigh_list_lock: lock protecting neigh_list */
 217         spinlock_t neigh_list_lock;
 218 };
 219
 220 /**
 221  * struct batadv_orig_ifinfo - B.A.T.M.A.N. IV private orig_ifinfo members
 222  */
 223 struct batadv_orig_ifinfo_bat_iv {
 224         /**
 225          * @bcast_own: bitfield which counts the number of our OGMs this
 226          * orig_node rebroadcasted "back" to us  (relative to last_real_seqno)
 227          */
 228         DECLARE_BITMAP(bcast_own, BATADV_TQ_LOCAL_WINDOW_SIZE);
 229
 230         /** @bcast_own_sum: sum of bcast_own */
 231         u8 bcast_own_sum;
 232 };
 233
 234 /**
 235  * struct batadv_orig_ifinfo - originator info per outgoing interface
 236  */
 237 struct batadv_orig_ifinfo {
 238         /** @list: list node for &batadv_orig_node.ifinfo_list */
 239         struct hlist_node list;
 240
 241         /** @if_outgoing: pointer to outgoing hard-interface */
 242         struct batadv_hard_iface *if_outgoing;
 243
 244         /** @router: router that should be used to reach this originator */
 245         struct batadv_neigh_node __rcu *router;
 246
 247         /** @last_real_seqno: last and best known sequence number */
 248         u32 last_real_seqno;
 249
 250         /** @last_ttl: ttl of last received packet */
 251         u8 last_ttl;
 252
 253         /** @last_seqno_forwarded: seqno of the OGM which was forwarded last */
 254         u32 last_seqno_forwarded;
 255
 256         /** @batman_seqno_reset: time when the batman seqno window was reset */
 257         unsigned long batman_seqno_reset;
 258
 259         /** @bat_iv: B.A.T.M.A.N. IV private structure */
 260         struct batadv_orig_ifinfo_bat_iv bat_iv;
 261
 262         /** @refcount: number of contexts the object is used */
 263         struct kref refcount;
 264
 265         /** @rcu: struct used for freeing in an RCU-safe manner */
 266         struct rcu_head rcu;
 267 };
 268
 269 /**
 270  * struct batadv_frag_table_entry - head in the fragment buffer table
 271  */
 272 struct batadv_frag_table_entry {
 273         /** @fragment_list: head of list with fragments */
 274         struct hlist_head fragment_list;
 275
 276         /** @lock: lock to protect the list of fragments */
 277         spinlock_t lock;
 278
 279         /** @timestamp: time (jiffie) of last received fragment */
 280         unsigned long timestamp;
 281
 282         /** @seqno: sequence number of the fragments in the list */
 283         u16 seqno;
 284
 285         /** @size: accumulated size of packets in list */
 286         u16 size;
 287
 288         /** @total_size: expected size of the assembled packet */
 289         u16 total_size;
 290 };
 291
 292 /**
 293  * struct batadv_frag_list_entry - entry in a list of fragments
 294  */
 295 struct batadv_frag_list_entry {
 296         /** @list: list node information */
 297         struct hlist_node list;
 298
 299         /** @skb: fragment */
 300         struct sk_buff *skb;
 301
 302         /** @no: fragment number in the set */
 303         u8 no;
 304 };
 305
 306 /**
 307  * struct batadv_vlan_tt - VLAN specific TT attributes
 308  */
 309 struct batadv_vlan_tt {
 310         /** @crc: CRC32 checksum of the entries belonging to this vlan */
 311         u32 crc;
 312
 313         /** @num_entries: number of TT entries for this VLAN */
 314         atomic_t num_entries;
 315 };
 316
 317 /**
 318  * struct batadv_orig_node_vlan - VLAN specific data per orig_node
 319  */
 320 struct batadv_orig_node_vlan {
 321         /** @vid: the VLAN identifier */
 322         unsigned short vid;
 323
 324         /** @tt: VLAN specific TT attributes */
 325         struct batadv_vlan_tt tt;
 326
 327         /** @list: list node for &batadv_orig_node.vlan_list */
 328         struct hlist_node list;
 329
 330         /**
 331          * @refcount: number of context where this object is currently in use
 332          */
 333         struct kref refcount;
 334
 335         /** @rcu: struct used for freeing in a RCU-safe manner */
 336         struct rcu_head rcu;
 337 };
 338
 339 /**
 340  * struct batadv_orig_bat_iv - B.A.T.M.A.N. IV private orig_node members
 341  */
 342 struct batadv_orig_bat_iv {
 343         /**
 344          * @ogm_cnt_lock: lock protecting &batadv_orig_ifinfo_bat_iv.bcast_own,
 345          * &batadv_orig_ifinfo_bat_iv.bcast_own_sum,
 346          * &batadv_neigh_ifinfo_bat_iv.bat_iv.real_bits and
 347          * &batadv_neigh_ifinfo_bat_iv.real_packet_count
 348          */
 349         spinlock_t ogm_cnt_lock;
 350 };
 351
 352 /**
 353  * struct batadv_orig_node - structure for orig_list maintaining nodes of mesh
 354  */
 355 struct batadv_orig_node {
 356         /** @orig: originator ethernet address */
 357         u8 orig[ETH_ALEN];
 358
 359         /** @ifinfo_list: list for routers per outgoing interface */
 360         struct hlist_head ifinfo_list;
 361
 362         /**
 363          * @last_bonding_candidate: pointer to last ifinfo of last used router
 364          */
 365         struct batadv_orig_ifinfo *last_bonding_candidate;
 366
 367 #ifdef CONFIG_BATMAN_ADV_DAT
 368         /** @dat_addr: address of the orig node in the distributed hash */
 369         batadv_dat_addr_t dat_addr;
 370 #endif
 371
 372         /** @last_seen: time when last packet from this node was received */
 373         unsigned long last_seen;
 374
 375         /**
 376          * @bcast_seqno_reset: time when the broadcast seqno window was reset
 377          */
 378         unsigned long bcast_seqno_reset;
 379
 380 #ifdef CONFIG_BATMAN_ADV_MCAST
 381         /**
 382          * @mcast_handler_lock: synchronizes mcast-capability and -flag changes
 383          */
 384         spinlock_t mcast_handler_lock;
 385
 386         /** @mcast_flags: multicast flags announced by the orig node */
 387         u8 mcast_flags;
 388
 389         /**
 390          * @mcast_want_all_unsnoopables_node: a list node for the
 391          *  mcast.want_all_unsnoopables list
 392          */
 393         struct hlist_node mcast_want_all_unsnoopables_node;
 394
 395         /**
 396          * @mcast_want_all_ipv4_node: a list node for the mcast.want_all_ipv4
 397          *  list
 398          */
 399         struct hlist_node mcast_want_all_ipv4_node;
 400         /**
 401          * @mcast_want_all_ipv6_node: a list node for the mcast.want_all_ipv6
 402          *  list
 403          */
 404         struct hlist_node mcast_want_all_ipv6_node;
 405 #endif
 406
 407         /** @capabilities: announced capabilities of this originator */
 408         unsigned long capabilities;
 409
 410         /**
 411          * @capa_initialized: bitfield to remember whether a capability was
 412          *  initialized
 413          */
 414         unsigned long capa_initialized;
 415
 416         /** @last_ttvn: last seen translation table version number */
 417         atomic_t last_ttvn;
 418
 419         /** @tt_buff: last tt changeset this node received from the orig node */
 420         unsigned char *tt_buff;
 421
 422         /**
 423          * @tt_buff_len: length of the last tt changeset this node received
 424          *  from the orig node
 425          */
 426         s16 tt_buff_len;
 427
 428         /** @tt_buff_lock: lock that protects tt_buff and tt_buff_len */
 429         spinlock_t tt_buff_lock;
 430
 431         /**
 432          * @tt_lock: prevents from updating the table while reading it. Table
 433          *  update is made up by two operations (data structure update and
 434          *  metdata -CRC/TTVN-recalculation) and they have to be executed
 435          *  atomically in order to avoid another thread to read the
 436          *  table/metadata between those.
 437          */
 438         spinlock_t tt_lock;
 439
 440         /**
 441          * @bcast_bits: bitfield containing the info which payload broadcast
 442          *  originated from this orig node this host already has seen (relative
 443          *  to last_bcast_seqno)
 444          */
 445         DECLARE_BITMAP(bcast_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
 446
 447         /**
 448          * @last_bcast_seqno: last broadcast sequence number received by this
 449          *  host
 450          */
 451         u32 last_bcast_seqno;
 452
 453         /**
 454          * @neigh_list: list of potential next hop neighbor towards this orig
 455          *  node
 456          */
 457         struct hlist_head neigh_list;
 458
 459         /**
 460          * @neigh_list_lock: lock protecting neigh_list, ifinfo_list,
 461          *  last_bonding_candidate and router
 462          */
 463         spinlock_t neigh_list_lock;
 464
 465         /** @hash_entry: hlist node for &batadv_priv.orig_hash */
 466         struct hlist_node hash_entry;
 467
 468         /** @bat_priv: pointer to soft_iface this orig node belongs to */
 469         struct batadv_priv *bat_priv;
 470
 471         /** @bcast_seqno_lock: lock protecting bcast_bits & last_bcast_seqno */
 472         spinlock_t bcast_seqno_lock;
 473
 474         /** @refcount: number of contexts the object is used */
 475         struct kref refcount;
 476
 477         /** @rcu: struct used for freeing in an RCU-safe manner */
 478         struct rcu_head rcu;
 479
 480 #ifdef CONFIG_BATMAN_ADV_NC
 481         /** @in_coding_list: list of nodes this orig can hear */
 482         struct list_head in_coding_list;
 483
 484         /** @out_coding_list: list of nodes that can hear this orig */
 485         struct list_head out_coding_list;
 486
 487         /** @in_coding_list_lock: protects in_coding_list */
 488         spinlock_t in_coding_list_lock;
 489
 490         /** @out_coding_list_lock: protects out_coding_list */
 491         spinlock_t out_coding_list_lock;
 492 #endif
 493
 494         /** @fragments: array with heads for fragment chains */
 495         struct batadv_frag_table_entry fragments[BATADV_FRAG_BUFFER_COUNT];
 496
 497         /**
 498          * @vlan_list: a list of orig_node_vlan structs, one per VLAN served by
 499          *  the originator represented by this object
 500          */
 501         struct hlist_head vlan_list;
 502
 503         /** @vlan_list_lock: lock protecting vlan_list */
 504         spinlock_t vlan_list_lock;
 505
 506         /** @bat_iv: B.A.T.M.A.N. IV private structure */
 507         struct batadv_orig_bat_iv bat_iv;
 508 };
 509
 510 /**
 511  * enum batadv_orig_capabilities - orig node capabilities
 512  */
 513 enum batadv_orig_capabilities {
 514         /**
 515          * @BATADV_ORIG_CAPA_HAS_DAT: orig node has distributed arp table
 516          *  enabled
 517          */
 518         BATADV_ORIG_CAPA_HAS_DAT,
 519
 520         /** @BATADV_ORIG_CAPA_HAS_NC: orig node has network coding enabled */
 521         BATADV_ORIG_CAPA_HAS_NC,
 522
 523         /** @BATADV_ORIG_CAPA_HAS_TT: orig node has tt capability */
 524         BATADV_ORIG_CAPA_HAS_TT,
 525
 526         /**
 527          * @BATADV_ORIG_CAPA_HAS_MCAST: orig node has some multicast capability
 528          *  (= orig node announces a tvlv of type BATADV_TVLV_MCAST)
 529          */
 530         BATADV_ORIG_CAPA_HAS_MCAST,
 531 };
 532
 533 /**
 534  * struct batadv_gw_node - structure for orig nodes announcing gw capabilities
 535  */
 536 struct batadv_gw_node {
 537         /** @list: list node for &batadv_priv_gw.list */
 538         struct hlist_node list;
 539
 540         /** @orig_node: pointer to corresponding orig node */
 541         struct batadv_orig_node *orig_node;
 542
 543         /** @bandwidth_down: advertised uplink download bandwidth */
 544         u32 bandwidth_down;
 545
 546         /** @bandwidth_up: advertised uplink upload bandwidth */
 547         u32 bandwidth_up;
 548
 549         /** @refcount: number of contexts the object is used */
 550         struct kref refcount;
 551
 552         /** @rcu: struct used for freeing in an RCU-safe manner */
 553         struct rcu_head rcu;
 554 };
 555
 556 DECLARE_EWMA(throughput, 10, 8)
 557
 558 /**
 559  * struct batadv_hardif_neigh_node_bat_v - B.A.T.M.A.N. V private neighbor
 560  *  information
 561  */
 562 struct batadv_hardif_neigh_node_bat_v {
 563         /** @throughput: ewma link throughput towards this neighbor */
 564         struct ewma_throughput throughput;
 565
 566         /** @elp_interval: time interval between two ELP transmissions */
 567         u32 elp_interval;
 568
 569         /** @elp_latest_seqno: latest and best known ELP sequence number */
 570         u32 elp_latest_seqno;
 571
 572         /**
 573          * @last_unicast_tx: when the last unicast packet has been sent to this
 574          *  neighbor
 575          */
 576         unsigned long last_unicast_tx;
 577
 578         /** @metric_work: work queue callback item for metric update */
 579         struct work_struct metric_work;
 580 };
 581
 582 /**
 583  * struct batadv_hardif_neigh_node - unique neighbor per hard-interface
 584  */
 585 struct batadv_hardif_neigh_node {
 586         /** @list: list node for &batadv_hard_iface.neigh_list */
 587         struct hlist_node list;
 588
 589         /** @addr: the MAC address of the neighboring interface */
 590         u8 addr[ETH_ALEN];
 591
 592         /**
 593          * @orig: the address of the originator this neighbor node belongs to
 594          */
 595         u8 orig[ETH_ALEN];
 596
 597         /** @if_incoming: pointer to incoming hard-interface */
 598         struct batadv_hard_iface *if_incoming;
 599
 600         /** @last_seen: when last packet via this neighbor was received */
 601         unsigned long last_seen;
 602
 603 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
 604         /** @bat_v: B.A.T.M.A.N. V private data */
 605         struct batadv_hardif_neigh_node_bat_v bat_v;
 606 #endif
 607
 608         /** @refcount: number of contexts the object is used */
 609         struct kref refcount;
 610
 611         /** @rcu: struct used for freeing in a RCU-safe manner */
 612         struct rcu_head rcu;
 613 };
 614
 615 /**
 616  * struct batadv_neigh_node - structure for single hops neighbors
 617  */
 618 struct batadv_neigh_node {
 619         /** @list: list node for &batadv_orig_node.neigh_list */
 620         struct hlist_node list;
 621
 622         /** @orig_node: pointer to corresponding orig_node */
 623         struct batadv_orig_node *orig_node;
 624
 625         /** @addr: the MAC address of the neighboring interface */
 626         u8 addr[ETH_ALEN];
 627
 628         /** @ifinfo_list: list for routing metrics per outgoing interface */
 629         struct hlist_head ifinfo_list;
 630
 631         /** @ifinfo_lock: lock protecting ifinfo_list and its members */
 632         spinlock_t ifinfo_lock;
 633
 634         /** @if_incoming: pointer to incoming hard-interface */
 635         struct batadv_hard_iface *if_incoming;
 636
 637         /** @last_seen: when last packet via this neighbor was received */
 638         unsigned long last_seen;
 639
 640         /** @hardif_neigh: hardif_neigh of this neighbor */
 641         struct batadv_hardif_neigh_node *hardif_neigh;
 642
 643         /** @refcount: number of contexts the object is used */
 644         struct kref refcount;
 645
 646         /** @rcu: struct used for freeing in an RCU-safe manner */
 647         struct rcu_head rcu;
 648 };
 649
 650 /**
 651  * struct batadv_neigh_ifinfo_bat_iv - neighbor information per outgoing
 652  *  interface for B.A.T.M.A.N. IV
 653  */
 654 struct batadv_neigh_ifinfo_bat_iv {
 655         /** @tq_recv: ring buffer of received TQ values from this neigh node */
 656         u8 tq_recv[BATADV_TQ_GLOBAL_WINDOW_SIZE];
 657
 658         /** @tq_index: ring buffer index */
 659         u8 tq_index;
 660
 661         /**
 662          * @tq_avg: averaged tq of all tq values in the ring buffer (tq_recv)
 663          */
 664         u8 tq_avg;
 665
 666         /**
 667          * @real_bits: bitfield containing the number of OGMs received from this
 668          *  neigh node (relative to orig_node->last_real_seqno)
 669          */
 670         DECLARE_BITMAP(real_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
 671
 672         /** @real_packet_count: counted result of real_bits */
 673         u8 real_packet_count;
 674 };
 675
 676 /**
 677  * struct batadv_neigh_ifinfo_bat_v - neighbor information per outgoing
 678  *  interface for B.A.T.M.A.N. V
 679  */
 680 struct batadv_neigh_ifinfo_bat_v {
 681         /**
 682          * @throughput: last throughput metric received from originator via this
 683          *  neigh
 684          */
 685         u32 throughput;
 686
 687         /** @last_seqno: last sequence number known for this neighbor */
 688         u32 last_seqno;
 689 };
 690
 691 /**
 692  * struct batadv_neigh_ifinfo - neighbor information per outgoing interface
 693  */
 694 struct batadv_neigh_ifinfo {
 695         /** @list: list node for &batadv_neigh_node.ifinfo_list */
 696         struct hlist_node list;
 697
 698         /** @if_outgoing: pointer to outgoing hard-interface */
 699         struct batadv_hard_iface *if_outgoing;
 700
 701         /** @bat_iv: B.A.T.M.A.N. IV private structure */
 702         struct batadv_neigh_ifinfo_bat_iv bat_iv;
 703
 704 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
 705         /** @bat_v: B.A.T.M.A.N. V private data */
 706         struct batadv_neigh_ifinfo_bat_v bat_v;
 707 #endif
 708
 709         /** @last_ttl: last received ttl from this neigh node */
 710         u8 last_ttl;
 711
 712         /** @refcount: number of contexts the object is used */
 713         struct kref refcount;
 714
 715         /** @rcu: struct used for freeing in a RCU-safe manner */
 716         struct rcu_head rcu;
 717 };
 718
 719 #ifdef CONFIG_BATMAN_ADV_BLA
 720
 721 /**
 722  * struct batadv_bcast_duplist_entry - structure for LAN broadcast suppression
 723  */
 724 struct batadv_bcast_duplist_entry {
 725         /** @orig: mac address of orig node orginating the broadcast */
 726         u8 orig[ETH_ALEN];
 727
 728         /** @crc: crc32 checksum of broadcast payload */
 729         __be32 crc;
 730
 731         /** @entrytime: time when the broadcast packet was received */
 732         unsigned long entrytime;
 733 };
 734 #endif
 735
 736 /**
 737  * enum batadv_counters - indices for traffic counters
 738  */
 739 enum batadv_counters {
 740         /** @BATADV_CNT_TX: transmitted payload traffic packet counter */
 741         BATADV_CNT_TX,
 742
 743         /** @BATADV_CNT_TX_BYTES: transmitted payload traffic bytes counter */
 744         BATADV_CNT_TX_BYTES,
 745
 746         /**
 747          * @BATADV_CNT_TX_DROPPED: dropped transmission payload traffic packet
 748          *  counter
 749          */
 750         BATADV_CNT_TX_DROPPED,
 751
 752         /** @BATADV_CNT_RX: received payload traffic packet counter */
 753         BATADV_CNT_RX,
 754
 755         /** @BATADV_CNT_RX_BYTES: received payload traffic bytes counter */
 756         BATADV_CNT_RX_BYTES,
 757
 758         /** @BATADV_CNT_FORWARD: forwarded payload traffic packet counter */
 759         BATADV_CNT_FORWARD,
 760
 761         /**
 762          * @BATADV_CNT_FORWARD_BYTES: forwarded payload traffic bytes counter
 763          */
 764         BATADV_CNT_FORWARD_BYTES,
 765
 766         /**
 767          * @BATADV_CNT_MGMT_TX: transmitted routing protocol traffic packet
 768          *  counter
 769          */
 770         BATADV_CNT_MGMT_TX,
 771
 772         /**
 773          * @BATADV_CNT_MGMT_TX_BYTES: transmitted routing protocol traffic bytes
 774          *  counter
 775          */
 776         BATADV_CNT_MGMT_TX_BYTES,
 777
 778         /**
 779          * @BATADV_CNT_MGMT_RX: received routing protocol traffic packet counter
 780          */
 781         BATADV_CNT_MGMT_RX,
 782
 783         /**
 784          * @BATADV_CNT_MGMT_RX_BYTES: received routing protocol traffic bytes
 785          *  counter
 786          */
 787         BATADV_CNT_MGMT_RX_BYTES,
 788
 789         /** @BATADV_CNT_FRAG_TX: transmitted fragment traffic packet counter */
 790         BATADV_CNT_FRAG_TX,
 791
 792         /**
 793          * @BATADV_CNT_FRAG_TX_BYTES: transmitted fragment traffic bytes counter
 794          */
 795         BATADV_CNT_FRAG_TX_BYTES,
 796
 797         /** @BATADV_CNT_FRAG_RX: received fragment traffic packet counter */
 798         BATADV_CNT_FRAG_RX,
 799
 800         /**
 801          * @BATADV_CNT_FRAG_RX_BYTES: received fragment traffic bytes counter
 802          */
 803         BATADV_CNT_FRAG_RX_BYTES,
 804
 805         /** @BATADV_CNT_FRAG_FWD: forwarded fragment traffic packet counter */
 806         BATADV_CNT_FRAG_FWD,
 807
 808         /**
 809          * @BATADV_CNT_FRAG_FWD_BYTES: forwarded fragment traffic bytes counter
 810          */
 811         BATADV_CNT_FRAG_FWD_BYTES,
 812
 813         /**
 814          * @BATADV_CNT_TT_REQUEST_TX: transmitted tt req traffic packet counter
 815          */
 816         BATADV_CNT_TT_REQUEST_TX,
 817
 818         /** @BATADV_CNT_TT_REQUEST_RX: received tt req traffic packet counter */
 819         BATADV_CNT_TT_REQUEST_RX,
 820
 821         /**
 822          * @BATADV_CNT_TT_RESPONSE_TX: transmitted tt resp traffic packet
 823          *  counter
 824          */
 825         BATADV_CNT_TT_RESPONSE_TX,
 826
 827         /**
 828          * @BATADV_CNT_TT_RESPONSE_RX: received tt resp traffic packet counter
 829          */
 830         BATADV_CNT_TT_RESPONSE_RX,
 831
 832         /**
 833          * @BATADV_CNT_TT_ROAM_ADV_TX: transmitted tt roam traffic packet
 834          *  counter
 835          */
 836         BATADV_CNT_TT_ROAM_ADV_TX,
 837
 838         /**
 839          * @BATADV_CNT_TT_ROAM_ADV_RX: received tt roam traffic packet counter
 840          */
 841         BATADV_CNT_TT_ROAM_ADV_RX,
 842
 843 #ifdef CONFIG_BATMAN_ADV_DAT
 844         /**
 845          * @BATADV_CNT_DAT_GET_TX: transmitted dht GET traffic packet counter
 846          */
 847         BATADV_CNT_DAT_GET_TX,
 848
 849         /** @BATADV_CNT_DAT_GET_RX: received dht GET traffic packet counter */
 850         BATADV_CNT_DAT_GET_RX,
 851
 852         /**
 853          * @BATADV_CNT_DAT_PUT_TX: transmitted dht PUT traffic packet counter
 854          */
 855         BATADV_CNT_DAT_PUT_TX,
 856
 857         /** @BATADV_CNT_DAT_PUT_RX: received dht PUT traffic packet counter */
 858         BATADV_CNT_DAT_PUT_RX,
 859
 860         /**
 861          * @BATADV_CNT_DAT_CACHED_REPLY_TX: transmitted dat cache reply traffic
 862          *  packet counter
 863          */
 864         BATADV_CNT_DAT_CACHED_REPLY_TX,
 865 #endif
 866
 867 #ifdef CONFIG_BATMAN_ADV_NC
 868         /**
 869          * @BATADV_CNT_NC_CODE: transmitted nc-combined traffic packet counter
 870          */
 871         BATADV_CNT_NC_CODE,
 872
 873         /**
 874          * @BATADV_CNT_NC_CODE_BYTES: transmitted nc-combined traffic bytes
 875          *  counter
 876          */
 877         BATADV_CNT_NC_CODE_BYTES,
 878
 879         /**
 880          * @BATADV_CNT_NC_RECODE: transmitted nc-recombined traffic packet
 881          *  counter
 882          */
 883         BATADV_CNT_NC_RECODE,
 884
 885         /**
 886          * @BATADV_CNT_NC_RECODE_BYTES: transmitted nc-recombined traffic bytes
 887          *  counter
 888          */
 889         BATADV_CNT_NC_RECODE_BYTES,
 890
 891         /**
 892          * @BATADV_CNT_NC_BUFFER: counter for packets buffered for later nc
 893          *  decoding
 894          */
 895         BATADV_CNT_NC_BUFFER,
 896
 897         /**
 898          * @BATADV_CNT_NC_DECODE: received and nc-decoded traffic packet counter
 899          */
 900         BATADV_CNT_NC_DECODE,
 901
 902         /**
 903          * @BATADV_CNT_NC_DECODE_BYTES: received and nc-decoded traffic bytes
 904          *  counter
 905          */
 906         BATADV_CNT_NC_DECODE_BYTES,
 907
 908         /**
 909          * @BATADV_CNT_NC_DECODE_FAILED: received and decode-failed traffic
 910          *  packet counter
 911          */
 912         BATADV_CNT_NC_DECODE_FAILED,
 913
 914         /**
 915          * @BATADV_CNT_NC_SNIFFED: counter for nc-decoded packets received in
 916          *  promisc mode.
 917          */
 918         BATADV_CNT_NC_SNIFFED,
 919 #endif
 920
 921         /** @BATADV_CNT_NUM: number of traffic counters */
 922         BATADV_CNT_NUM,
 923 };
 924
 925 /**
 926  * struct batadv_priv_tt - per mesh interface translation table data
 927  */
 928 struct batadv_priv_tt {
 929         /** @vn: translation table version number */
 930         atomic_t vn;
 931
 932         /**
 933          * @ogm_append_cnt: counter of number of OGMs containing the local tt
 934          *  diff
 935          */
 936         atomic_t ogm_append_cnt;
 937
 938         /** @local_changes: changes registered in an originator interval */
 939         atomic_t local_changes;
 940
 941         /**
 942          * @changes_list: tracks tt local changes within an originator interval
 943          */
 944         struct list_head changes_list;
 945
 946         /** @local_hash: local translation table hash table */
 947         struct batadv_hashtable *local_hash;
 948
 949         /** @global_hash: global translation table hash table */
 950         struct batadv_hashtable *global_hash;
 951
 952         /** @req_list: list of pending & unanswered tt_requests */
 953         struct hlist_head req_list;
 954
 955         /**
 956          * @roam_list: list of the last roaming events of each client limiting
 957          *  the number of roaming events to avoid route flapping
 958          */
 959         struct list_head roam_list;
 960
 961         /** @changes_list_lock: lock protecting changes_list */
 962         spinlock_t changes_list_lock;
 963
 964         /** @req_list_lock: lock protecting req_list */
 965         spinlock_t req_list_lock;
 966
 967         /** @roam_list_lock: lock protecting roam_list */
 968         spinlock_t roam_list_lock;
 969
 970         /** @last_changeset: last tt changeset this host has generated */
 971         unsigned char *last_changeset;
 972
 973         /**
 974          * @last_changeset_len: length of last tt changeset this host has
 975          *  generated
 976          */
 977         s16 last_changeset_len;
 978
 979         /**
 980          * @last_changeset_lock: lock protecting last_changeset &
 981          *  last_changeset_len
 982          */
 983         spinlock_t last_changeset_lock;
 984
 985         /**
 986          * @commit_lock: prevents from executing a local TT commit while reading
 987          *  the local table. The local TT commit is made up by two operations
 988          *  (data structure update and metdata -CRC/TTVN- recalculation) and
 989          *  they have to be executed atomically in order to avoid another thread
 990          *  to read the table/metadata between those.
 991          */
 992         spinlock_t commit_lock;
 993
 994         /** @work: work queue callback item for translation table purging */
 995         struct delayed_work work;
 996 };
 997
 998 #ifdef CONFIG_BATMAN_ADV_BLA
 999
1000 /**
1001  * struct batadv_priv_bla - per mesh interface bridge loope avoidance data
1002  */
1003 struct batadv_priv_bla {
1004         /** @num_requests: number of bla requests in flight */
1005         atomic_t num_requests;
1006
1007         /**
1008          * @claim_hash: hash table containing mesh nodes this host has claimed
1009          */
1010         struct batadv_hashtable *claim_hash;
1011
1012         /**
1013          * @backbone_hash: hash table containing all detected backbone gateways
1014          */
1015         struct batadv_hashtable *backbone_hash;
1016
1017         /** @loopdetect_addr: MAC address used for own loopdetection frames */
1018         u8 loopdetect_addr[ETH_ALEN];
1019
1020         /**
1021          * @loopdetect_lasttime: time when the loopdetection frames were sent
1022          */
1023         unsigned long loopdetect_lasttime;
1024
1025         /**
1026          * @loopdetect_next: how many periods to wait for the next loopdetect
1027          *  process
1028          */
1029         atomic_t loopdetect_next;
1030
1031         /**
1032          * @bcast_duplist: recently received broadcast packets array (for
1033          *  broadcast duplicate suppression)
1034          */
1035         struct batadv_bcast_duplist_entry bcast_duplist[BATADV_DUPLIST_SIZE];
1036
1037         /**
1038          * @bcast_duplist_curr: index of last broadcast packet added to
1039          *  bcast_duplist
1040          */
1041         int bcast_duplist_curr;
1042
1043         /**
1044          * @bcast_duplist_lock: lock protecting bcast_duplist &
1045          *  bcast_duplist_curr
1046          */
1047         spinlock_t bcast_duplist_lock;
1048
1049         /** @claim_dest: local claim data (e.g. claim group) */
1050         struct batadv_bla_claim_dst claim_dest;
1051
1052         /** @work: work queue callback item for cleanups & bla announcements */
1053         struct delayed_work work;
1054 };
1055 #endif
1056
1057 #ifdef CONFIG_BATMAN_ADV_DEBUG
1058
1059 /**
1060  * struct batadv_priv_debug_log - debug logging data
1061  */
1062 struct batadv_priv_debug_log {
1063         /** @log_buff: buffer holding the logs (ring bufer) */
1064         char log_buff[BATADV_LOG_BUF_LEN];
1065
1066         /** @log_start: index of next character to read */
1067         unsigned long log_start;
1068
1069         /** @log_end: index of next character to write */
1070         unsigned long log_end;
1071
1072         /** @lock: lock protecting log_buff, log_start & log_end */
1073         spinlock_t lock;
1074
1075         /** @queue_wait: log reader's wait queue */
1076         wait_queue_head_t queue_wait;
1077 };
1078 #endif
1079
1080 /**
1081  * struct batadv_priv_gw - per mesh interface gateway data
1082  */
1083 struct batadv_priv_gw {
1084         /** @gateway_list: list of available gateway nodes */
1085         struct hlist_head gateway_list;
1086
1087         /** @list_lock: lock protecting gateway_list, curr_gw, generation */
1088         spinlock_t list_lock;
1089
1090         /** @curr_gw: pointer to currently selected gateway node */
1091         struct batadv_gw_node __rcu *curr_gw;
1092
1093         /** @generation: current (generation) sequence number */
1094         unsigned int generation;
1095
1096         /**
1097          * @mode: gateway operation: off, client or server (see batadv_gw_modes)
1098          */
1099         atomic_t mode;
1100
1101         /** @sel_class: gateway selection class (applies if gw_mode client) */
1102         atomic_t sel_class;
1103
1104         /**
1105          * @bandwidth_down: advertised uplink download bandwidth (if gw_mode
1106          *  server)
1107          */
1108         atomic_t bandwidth_down;
1109
1110         /**
1111          * @bandwidth_up: advertised uplink upload bandwidth (if gw_mode server)
1112          */
1113         atomic_t bandwidth_up;
1114
1115         /** @reselect: bool indicating a gateway re-selection is in progress */
1116         atomic_t reselect;
1117 };
1118
1119 /**
1120  * struct batadv_priv_tvlv - per mesh interface tvlv data
1121  */
1122 struct batadv_priv_tvlv {
1123         /**
1124          * @container_list: list of registered tvlv containers to be sent with
1125          *  each OGM
1126          */
1127         struct hlist_head container_list;
1128
1129         /** @handler_list: list of the various tvlv content handlers */
1130         struct hlist_head handler_list;
1131
1132         /** @container_list_lock: protects tvlv container list access */
1133         spinlock_t container_list_lock;
1134
1135         /** @handler_list_lock: protects handler list access */
1136         spinlock_t handler_list_lock;
1137 };
1138
1139 #ifdef CONFIG_BATMAN_ADV_DAT
1140
1141 /**
1142  * struct batadv_priv_dat - per mesh interface DAT private data
1143  */
1144 struct batadv_priv_dat {
1145         /** @addr: node DAT address */
1146         batadv_dat_addr_t addr;
1147
1148         /** @hash: hashtable representing the local ARP cache */
1149         struct batadv_hashtable *hash;
1150
1151         /** @work: work queue callback item for cache purging */
1152         struct delayed_work work;
1153 };
1154 #endif
1155
1156 #ifdef CONFIG_BATMAN_ADV_MCAST
1157 /**
1158  * struct batadv_mcast_querier_state - IGMP/MLD querier state when bridged
1159  */
1160 struct batadv_mcast_querier_state {
1161         /** @exists: whether a querier exists in the mesh */
1162         unsigned char exists:1;
1163
1164         /**
1165          * @shadowing: if a querier exists, whether it is potentially shadowing
1166          *  multicast listeners (i.e. querier is behind our own bridge segment)
1167          */
1168         unsigned char shadowing:1;
1169 };
1170
1171 /**
1172  * struct batadv_priv_mcast - per mesh interface mcast data
1173  */
1174 struct batadv_priv_mcast {
1175         /**
1176          * @mla_list: list of multicast addresses we are currently announcing
1177          *  via TT
1178          */
1179         struct hlist_head mla_list; /* see __batadv_mcast_mla_update() */
1180
1181         /**
1182          * @want_all_unsnoopables_list: a list of orig_nodes wanting all
1183          *  unsnoopable multicast traffic
1184          */
1185         struct hlist_head want_all_unsnoopables_list;
1186
1187         /**
1188          * @want_all_ipv4_list: a list of orig_nodes wanting all IPv4 multicast
1189          *  traffic
1190          */
1191         struct hlist_head want_all_ipv4_list;
1192
1193         /**
1194          * @want_all_ipv6_list: a list of orig_nodes wanting all IPv6 multicast
1195          *  traffic
1196          */
1197         struct hlist_head want_all_ipv6_list;
1198
1199         /** @querier_ipv4: the current state of an IGMP querier in the mesh */
1200         struct batadv_mcast_querier_state querier_ipv4;
1201
1202         /** @querier_ipv6: the current state of an MLD querier in the mesh */
1203         struct batadv_mcast_querier_state querier_ipv6;
1204
1205         /** @flags: the flags we have last sent in our mcast tvlv */
1206         u8 flags;
1207
1208         /** @enabled: whether the multicast tvlv is currently enabled */
1209         unsigned char enabled:1;
1210
1211         /** @bridged: whether the soft interface has a bridge on top */
1212         unsigned char bridged:1;
1213
1214         /**
1215          * @mla_lock: a lock protecting mla_list and mla_flags
1216          */
1217         spinlock_t mla_lock;
1218
1219         /**
1220          * @num_want_all_unsnoopables: number of nodes wanting unsnoopable IP
1221          *  traffic
1222          */
1223         atomic_t num_want_all_unsnoopables;
1224
1225         /** @num_want_all_ipv4: counter for items in want_all_ipv4_list */
1226         atomic_t num_want_all_ipv4;
1227
1228         /** @num_want_all_ipv6: counter for items in want_all_ipv6_list */
1229         atomic_t num_want_all_ipv6;
1230
1231         /**
1232          * @want_lists_lock: lock for protecting modifications to mcasts
1233          *  want_all_{unsnoopables,ipv4,ipv6}_list (traversals are rcu-locked)
1234          */
1235         spinlock_t want_lists_lock;
1236
1237         /** @work: work queue callback item for multicast TT and TVLV updates */
1238         struct delayed_work work;
1239 };
1240 #endif
1241
1242 /**
1243  * struct batadv_priv_nc - per mesh interface network coding private data
1244  */
1245 struct batadv_priv_nc {
1246         /** @work: work queue callback item for cleanup */
1247         struct delayed_work work;
1248
1249 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
1250         /**
1251          * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
1252          */
1253         struct dentry *debug_dir;
1254 #endif
1255
1256         /**
1257          * @min_tq: only consider neighbors for encoding if neigh_tq > min_tq
1258          */
1259         u8 min_tq;
1260
1261         /**
1262          * @max_fwd_delay: maximum packet forward delay to allow coding of
1263          *  packets
1264          */
1265         u32 max_fwd_delay;
1266
1267         /**
1268          * @max_buffer_time: buffer time for sniffed packets used to decoding
1269          */
1270         u32 max_buffer_time;
1271
1272         /**
1273          * @timestamp_fwd_flush: timestamp of last forward packet queue flush
1274          */
1275         unsigned long timestamp_fwd_flush;
1276
1277         /**
1278          * @timestamp_sniffed_purge: timestamp of last sniffed packet queue
1279          *  purge
1280          */
1281         unsigned long timestamp_sniffed_purge;
1282
1283         /**
1284          * @coding_hash: Hash table used to buffer skbs while waiting for
1285          *  another incoming skb to code it with. Skbs are added to the buffer
1286          *  just before being forwarded in routing.c
1287          */
1288         struct batadv_hashtable *coding_hash;
1289
1290         /**
1291          * @decoding_hash: Hash table used to buffer skbs that might be needed
1292          *  to decode a received coded skb. The buffer is used for 1) skbs
1293          *  arriving on the soft-interface; 2) skbs overheard on the
1294          *  hard-interface; and 3) skbs forwarded by batman-adv.
1295          */
1296         struct batadv_hashtable *decoding_hash;
1297 };
1298
1299 /**
1300  * struct batadv_tp_unacked - unacked packet meta-information
1301  *
1302  * This struct is supposed to represent a buffer unacked packet. However, since
1303  * the purpose of the TP meter is to count the traffic only, there is no need to
1304  * store the entire sk_buff, the starting offset and the length are enough
1305  */
1306 struct batadv_tp_unacked {
1307         /** @seqno: seqno of the unacked packet */
1308         u32 seqno;
1309
1310         /** @len: length of the packet */
1311         u16 len;
1312
1313         /** @list: list node for &batadv_tp_vars.unacked_list */
1314         struct list_head list;
1315 };
1316
1317 /**
1318  * enum batadv_tp_meter_role - Modus in tp meter session
1319  */
1320 enum batadv_tp_meter_role {
1321         /** @BATADV_TP_RECEIVER: Initialized as receiver */
1322         BATADV_TP_RECEIVER,
1323
1324         /** @BATADV_TP_SENDER: Initialized as sender */
1325         BATADV_TP_SENDER
1326 };
1327
1328 /**
1329  * struct batadv_tp_vars - tp meter private variables per session
1330  */
1331 struct batadv_tp_vars {
1332         /** @list: list node for &bat_priv.tp_list */
1333         struct hlist_node list;
1334
1335         /** @timer: timer for ack (receiver) and retry (sender) */
1336         struct timer_list timer;
1337
1338         /** @bat_priv: pointer to the mesh object */
1339         struct batadv_priv *bat_priv;
1340
1341         /** @start_time: start time in jiffies */
1342         unsigned long start_time;
1343
1344         /** @other_end: mac address of remote */
1345         u8 other_end[ETH_ALEN];
1346
1347         /** @role: receiver/sender modi */
1348         enum batadv_tp_meter_role role;
1349
1350         /** @sending: sending binary semaphore: 1 if sending, 0 is not */
1351         atomic_t sending;
1352
1353         /** @reason: reason for a stopped session */
1354         enum batadv_tp_meter_reason reason;
1355
1356         /** @finish_work: work item for the finishing procedure */
1357         struct delayed_work finish_work;
1358
1359         /** @test_length: test length in milliseconds */
1360         u32 test_length;
1361
1362         /** @session: TP session identifier */
1363         u8 session[2];
1364
1365         /** @icmp_uid: local ICMP "socket" index */
1366         u8 icmp_uid;
1367
1368         /* sender variables */
1369
1370         /** @dec_cwnd: decimal part of the cwnd used during linear growth */
1371         u16 dec_cwnd;
1372
1373         /** @cwnd: current size of the congestion window */
1374         u32 cwnd;
1375
1376         /** @cwnd_lock: lock do protect @cwnd & @dec_cwnd */
1377         spinlock_t cwnd_lock;
1378
1379         /**
1380          * @ss_threshold: Slow Start threshold. Once cwnd exceeds this value the
1381          *  connection switches to the Congestion Avoidance state
1382          */
1383         u32 ss_threshold;
1384
1385         /** @last_acked: last acked byte */
1386         atomic_t last_acked;
1387
1388         /** @last_sent: last sent byte, not yet acked */
1389         u32 last_sent;
1390
1391         /** @tot_sent: amount of data sent/ACKed so far */
1392         atomic64_t tot_sent;
1393
1394         /** @dup_acks: duplicate ACKs counter */
1395         atomic_t dup_acks;
1396
1397         /** @fast_recovery: true if in Fast Recovery mode */
1398         unsigned char fast_recovery:1;
1399
1400         /** @recover: last sent seqno when entering Fast Recovery */
1401         u32 recover;
1402
1403         /** @rto: sender timeout */
1404         u32 rto;
1405
1406         /** @srtt: smoothed RTT scaled by 2^3 */
1407         u32 srtt;
1408
1409         /** @rttvar: RTT variation scaled by 2^2 */
1410         u32 rttvar;
1411
1412         /**
1413          * @more_bytes: waiting queue anchor when waiting for more ack/retry
1414          *  timeout
1415          */
1416         wait_queue_head_t more_bytes;
1417
1418         /** @prerandom_offset: offset inside the prerandom buffer */
1419         u32 prerandom_offset;
1420
1421         /** @prerandom_lock: spinlock protecting access to prerandom_offset */
1422         spinlock_t prerandom_lock;
1423
1424         /* receiver variables */
1425
1426         /** @last_recv: last in-order received packet */
1427         u32 last_recv;
1428
1429         /** @unacked_list: list of unacked packets (meta-info only) */
1430         struct list_head unacked_list;
1431
1432         /** @unacked_lock: protect unacked_list */
1433         spinlock_t unacked_lock;
1434
1435         /** @last_recv_time: time time (jiffies) a msg was received */
1436         unsigned long last_recv_time;
1437
1438         /** @refcount: number of context where the object is used */
1439         struct kref refcount;
1440
1441         /** @rcu: struct used for freeing in an RCU-safe manner */
1442         struct rcu_head rcu;
1443 };
1444
1445 /**
1446  * struct batadv_softif_vlan - per VLAN attributes set
1447  */
1448 struct batadv_softif_vlan {
1449         /** @bat_priv: pointer to the mesh object */
1450         struct batadv_priv *bat_priv;
1451
1452         /** @vid: VLAN identifier */
1453         unsigned short vid;
1454
1455         /** @kobj: kobject for sysfs vlan subdirectory */
1456         struct kobject *kobj;
1457
1458         /** @ap_isolation: AP isolation state */
1459         atomic_t ap_isolation;          /* boolean */
1460
1461         /** @tt: TT private attributes (VLAN specific) */
1462         struct batadv_vlan_tt tt;
1463
1464         /** @list: list node for &bat_priv.softif_vlan_list */
1465         struct hlist_node list;
1466
1467         /**
1468          * @refcount: number of context where this object is currently in use
1469          */
1470         struct kref refcount;
1471
1472         /** @rcu: struct used for freeing in a RCU-safe manner */
1473         struct rcu_head rcu;
1474 };
1475
1476 /**
1477  * struct batadv_priv_bat_v - B.A.T.M.A.N. V per soft-interface private data
1478  */
1479 struct batadv_priv_bat_v {
1480         /** @ogm_buff: buffer holding the OGM packet */
1481         unsigned char *ogm_buff;
1482
1483         /** @ogm_buff_len: length of the OGM packet buffer */
1484         int ogm_buff_len;
1485
1486         /** @ogm_seqno: OGM sequence number - used to identify each OGM */
1487         atomic_t ogm_seqno;
1488
1489         /** @ogm_wq: workqueue used to schedule OGM transmissions */
1490         struct delayed_work ogm_wq;
1491 };
1492
1493 /**
1494  * struct batadv_priv - per mesh interface data
1495  */
1496 struct batadv_priv {
1497         /**
1498          * @mesh_state: current status of the mesh
1499          *  (inactive/active/deactivating)
1500          */
1501         atomic_t mesh_state;
1502
1503         /** @soft_iface: net device which holds this struct as private data */
1504         struct net_device *soft_iface;
1505
1506         /**
1507          * @bat_counters: mesh internal traffic statistic counters (see
1508          *  batadv_counters)
1509          */
1510         u64 __percpu *bat_counters; /* Per cpu counters */
1511
1512         /**
1513          * @aggregated_ogms: bool indicating whether OGM aggregation is enabled
1514          */
1515         atomic_t aggregated_ogms;
1516
1517         /** @bonding: bool indicating whether traffic bonding is enabled */
1518         atomic_t bonding;
1519
1520         /**
1521          * @fragmentation: bool indicating whether traffic fragmentation is
1522          *  enabled
1523          */
1524         atomic_t fragmentation;
1525
1526         /**
1527          * @packet_size_max: max packet size that can be transmitted via
1528          *  multiple fragmented skbs or a single frame if fragmentation is
1529          *  disabled
1530          */
1531         atomic_t packet_size_max;
1532
1533         /**
1534          * @frag_seqno: incremental counter to identify chains of egress
1535          *  fragments
1536          */
1537         atomic_t frag_seqno;
1538
1539 #ifdef CONFIG_BATMAN_ADV_BLA
1540         /**
1541          * @bridge_loop_avoidance: bool indicating whether bridge loop
1542          *  avoidance is enabled
1543          */
1544         atomic_t bridge_loop_avoidance;
1545 #endif
1546
1547 #ifdef CONFIG_BATMAN_ADV_DAT
1548         /**
1549          * @distributed_arp_table: bool indicating whether distributed ARP table
1550          *  is enabled
1551          */
1552         atomic_t distributed_arp_table;
1553 #endif
1554
1555 #ifdef CONFIG_BATMAN_ADV_MCAST
1556         /**
1557          * @multicast_mode: Enable or disable multicast optimizations on this
1558          *  node's sender/originating side
1559          */
1560         atomic_t multicast_mode;
1561
1562         /**
1563          * @multicast_fanout: Maximum number of packet copies to generate for a
1564          *  multicast-to-unicast conversion
1565          */
1566         atomic_t multicast_fanout;
1567 #endif
1568
1569         /** @orig_interval: OGM broadcast interval in milliseconds */
1570         atomic_t orig_interval;
1571
1572         /**
1573          * @hop_penalty: penalty which will be applied to an OGM's tq-field on
1574          *  every hop
1575          */
1576         atomic_t hop_penalty;
1577
1578 #ifdef CONFIG_BATMAN_ADV_DEBUG
1579         /** @log_level: configured log level (see batadv_dbg_level) */
1580         atomic_t log_level;
1581 #endif
1582
1583         /**
1584          * @isolation_mark: the skb->mark value used to match packets for AP
1585          *  isolation
1586          */
1587         u32 isolation_mark;
1588
1589         /**
1590          * @isolation_mark_mask: bitmask identifying the bits in skb->mark to be
1591          *  used for the isolation mark
1592          */
1593         u32 isolation_mark_mask;
1594
1595         /** @bcast_seqno: last sent broadcast packet sequence number */
1596         atomic_t bcast_seqno;
1597
1598         /**
1599          * @bcast_queue_left: number of remaining buffered broadcast packet
1600          *  slots
1601          */
1602         atomic_t bcast_queue_left;
1603
1604         /** @batman_queue_left: number of remaining OGM packet slots */
1605         atomic_t batman_queue_left;
1606
1607         /** @mesh_obj: kobject for sysfs mesh subdirectory */
1608         struct kobject *mesh_obj;
1609
1610 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
1611         /** @debug_dir: dentry for debugfs batman-adv subdirectory */
1612         struct dentry *debug_dir;
1613 #endif
1614
1615         /** @forw_bat_list: list of aggregated OGMs that will be forwarded */
1616         struct hlist_head forw_bat_list;
1617
1618         /**
1619          * @forw_bcast_list: list of broadcast packets that will be
1620          *  rebroadcasted
1621          */
1622         struct hlist_head forw_bcast_list;
1623
1624         /** @tp_list: list of tp sessions */
1625         struct hlist_head tp_list;
1626
1627         /** @tp_num: number of currently active tp sessions */
1628         struct batadv_hashtable *orig_hash;
1629
1630         /** @orig_hash: hash table containing mesh participants (orig nodes) */
1631         spinlock_t forw_bat_list_lock;
1632
1633         /** @forw_bat_list_lock: lock protecting forw_bat_list */
1634         spinlock_t forw_bcast_list_lock;
1635
1636         /** @forw_bcast_list_lock: lock protecting forw_bcast_list */
1637         spinlock_t tp_list_lock;
1638
1639         /** @tp_list_lock: spinlock protecting @tp_list */
1640         atomic_t tp_num;
1641
1642         /** @orig_work: work queue callback item for orig node purging */
1643         struct delayed_work orig_work;
1644
1645         /**
1646          * @primary_if: one of the hard-interfaces assigned to this mesh
1647          *  interface becomes the primary interface
1648          */
1649         struct batadv_hard_iface __rcu *primary_if;  /* rcu protected pointer */
1650
1651         /** @algo_ops: routing algorithm used by this mesh interface */
1652         struct batadv_algo_ops *algo_ops;
1653
1654         /**
1655          * @softif_vlan_list: a list of softif_vlan structs, one per VLAN
1656          *  created on top of the mesh interface represented by this object
1657          */
1658         struct hlist_head softif_vlan_list;
1659
1660         /** @softif_vlan_list_lock: lock protecting softif_vlan_list */
1661         spinlock_t softif_vlan_list_lock;
1662
1663 #ifdef CONFIG_BATMAN_ADV_BLA
1664         /** @bla: bridge loope avoidance data */
1665         struct batadv_priv_bla bla;
1666 #endif
1667
1668 #ifdef CONFIG_BATMAN_ADV_DEBUG
1669         /** @debug_log: holding debug logging relevant data */
1670         struct batadv_priv_debug_log *debug_log;
1671 #endif
1672
1673         /** @gw: gateway data */
1674         struct batadv_priv_gw gw;
1675
1676         /** @tt: translation table data */
1677         struct batadv_priv_tt tt;
1678
1679         /** @tvlv: type-version-length-value data */
1680         struct batadv_priv_tvlv tvlv;
1681
1682 #ifdef CONFIG_BATMAN_ADV_DAT
1683         /** @dat: distributed arp table data */
1684         struct batadv_priv_dat dat;
1685 #endif
1686
1687 #ifdef CONFIG_BATMAN_ADV_MCAST
1688         /** @mcast: multicast data */
1689         struct batadv_priv_mcast mcast;
1690 #endif
1691
1692 #ifdef CONFIG_BATMAN_ADV_NC
1693         /**
1694          * @network_coding: bool indicating whether network coding is enabled
1695          */
1696         atomic_t network_coding;
1697
1698         /** @nc: network coding data */
1699         struct batadv_priv_nc nc;
1700 #endif /* CONFIG_BATMAN_ADV_NC */
1701
1702 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
1703         /** @bat_v: B.A.T.M.A.N. V per soft-interface private data */
1704         struct batadv_priv_bat_v bat_v;
1705 #endif
1706 };
1707
1708 /**
1709  * struct batadv_socket_client - layer2 icmp socket client data
1710  */
1711 struct batadv_socket_client {
1712         /**
1713          * @queue_list: packet queue for packets destined for this socket client
1714          */
1715         struct list_head queue_list;
1716
1717         /** @queue_len: number of packets in the packet queue (queue_list) */
1718         unsigned int queue_len;
1719
1720         /** @index: socket client's index in the batadv_socket_client_hash */
1721         unsigned char index;
1722
1723         /** @lock: lock protecting queue_list, queue_len & index */
1724         spinlock_t lock;
1725
1726         /** @queue_wait: socket client's wait queue */
1727         wait_queue_head_t queue_wait;
1728
1729         /** @bat_priv: pointer to soft_iface this client belongs to */
1730         struct batadv_priv *bat_priv;
1731 };
1732
1733 /**
1734  * struct batadv_socket_packet - layer2 icmp packet for socket client
1735  */
1736 struct batadv_socket_packet {
1737         /** @list: list node for &batadv_socket_client.queue_list */
1738         struct list_head list;
1739
1740         /** @icmp_len: size of the layer2 icmp packet */
1741         size_t icmp_len;
1742
1743         /** @icmp_packet: layer2 icmp packet */
1744         u8 icmp_packet[BATADV_ICMP_MAX_PACKET_SIZE];
1745 };
1746
1747 #ifdef CONFIG_BATMAN_ADV_BLA
1748
1749 /**
1750  * struct batadv_bla_backbone_gw - batman-adv gateway bridged into the LAN
1751  */
1752 struct batadv_bla_backbone_gw {
1753         /**
1754          * @orig: originator address of backbone node (mac address of primary
1755          *  iface)
1756          */
1757         u8 orig[ETH_ALEN];
1758
1759         /** @vid: vlan id this gateway was detected on */
1760         unsigned short vid;
1761
1762         /** @hash_entry: hlist node for &batadv_priv_bla.backbone_hash */
1763         struct hlist_node hash_entry;
1764
1765         /** @bat_priv: pointer to soft_iface this backbone gateway belongs to */
1766         struct batadv_priv *bat_priv;
1767
1768         /** @lasttime: last time we heard of this backbone gw */
1769         unsigned long lasttime;
1770
1771         /**
1772          * @wait_periods: grace time for bridge forward delays and bla group
1773          *  forming at bootup phase - no bcast traffic is formwared until it has
1774          *  elapsed
1775          */
1776         atomic_t wait_periods;
1777
1778         /**
1779          * @request_sent: if this bool is set to true we are out of sync with
1780          *  this backbone gateway - no bcast traffic is formwared until the
1781          *  situation was resolved
1782          */
1783         atomic_t request_sent;
1784
1785         /** @crc: crc16 checksum over all claims */
1786         u16 crc;
1787
1788         /** @crc_lock: lock protecting crc */
1789         spinlock_t crc_lock;
1790
1791         /** @report_work: work struct for reporting detected loops */
1792         struct work_struct report_work;
1793
1794         /** @refcount: number of contexts the object is used */
1795         struct kref refcount;
1796
1797         /** @rcu: struct used for freeing in an RCU-safe manner */
1798         struct rcu_head rcu;
1799 };
1800
1801 /**
1802  * struct batadv_bla_claim - claimed non-mesh client structure
1803  */
1804 struct batadv_bla_claim {
1805         /** @addr: mac address of claimed non-mesh client */
1806         u8 addr[ETH_ALEN];
1807
1808         /** @vid: vlan id this client was detected on */
1809         unsigned short vid;
1810
1811         /** @backbone_gw: pointer to backbone gw claiming this client */
1812         struct batadv_bla_backbone_gw *backbone_gw;
1813
1814         /** @backbone_lock: lock protecting backbone_gw pointer */
1815         spinlock_t backbone_lock;
1816
1817         /** @lasttime: last time we heard of claim (locals only) */
1818         unsigned long lasttime;
1819
1820         /** @hash_entry: hlist node for &batadv_priv_bla.claim_hash */
1821         struct hlist_node hash_entry;
1822
1823         /** @refcount: number of contexts the object is used */
1824         struct rcu_head rcu;
1825
1826         /** @rcu: struct used for freeing in an RCU-safe manner */
1827         struct kref refcount;
1828 };
1829 #endif
1830
1831 /**
1832  * struct batadv_tt_common_entry - tt local & tt global common data
1833  */
1834 struct batadv_tt_common_entry {
1835         /** @addr: mac address of non-mesh client */
1836         u8 addr[ETH_ALEN];
1837
1838         /** @vid: VLAN identifier */
1839         unsigned short vid;
1840
1841         /**
1842          * @hash_entry: hlist node for &batadv_priv_tt.local_hash or for
1843          *  &batadv_priv_tt.global_hash
1844          */
1845         struct hlist_node hash_entry;
1846
1847         /** @flags: various state handling flags (see batadv_tt_client_flags) */
1848         u16 flags;
1849
1850         /** @added_at: timestamp used for purging stale tt common entries */
1851         unsigned long added_at;
1852
1853         /** @refcount: number of contexts the object is used */
1854         struct kref refcount;
1855
1856         /** @rcu: struct used for freeing in an RCU-safe manner */
1857         struct rcu_head rcu;
1858 };
1859
1860 /**
1861  * struct batadv_tt_local_entry - translation table local entry data
1862  */
1863 struct batadv_tt_local_entry {
1864         /** @common: general translation table data */
1865         struct batadv_tt_common_entry common;
1866
1867         /** @last_seen: timestamp used for purging stale tt local entries */
1868         unsigned long last_seen;
1869
1870         /** @vlan: soft-interface vlan of the entry */
1871         struct batadv_softif_vlan *vlan;
1872 };
1873
1874 /**
1875  * struct batadv_tt_global_entry - translation table global entry data
1876  */
1877 struct batadv_tt_global_entry {
1878         /** @common: general translation table data */
1879         struct batadv_tt_common_entry common;
1880
1881         /** @orig_list: list of orig nodes announcing this non-mesh client */
1882         struct hlist_head orig_list;
1883
1884         /** @orig_list_count: number of items in the orig_list */
1885         atomic_t orig_list_count;
1886
1887         /** @list_lock: lock protecting orig_list */
1888         spinlock_t list_lock;
1889
1890         /** @roam_at: time at which TT_GLOBAL_ROAM was set */
1891         unsigned long roam_at;
1892 };
1893
1894 /**
1895  * struct batadv_tt_orig_list_entry - orig node announcing a non-mesh client
1896  */
1897 struct batadv_tt_orig_list_entry {
1898         /** @orig_node: pointer to orig node announcing this non-mesh client */
1899         struct batadv_orig_node *orig_node;
1900
1901         /**
1902          * @ttvn: translation table version number which added the non-mesh
1903          *  client
1904          */
1905         u8 ttvn;
1906
1907         /** @flags: per orig entry TT sync flags */
1908         u8 flags;
1909
1910         /** @list: list node for &batadv_tt_global_entry.orig_list */
1911         struct hlist_node list;
1912
1913         /** @refcount: number of contexts the object is used */
1914         struct kref refcount;
1915
1916         /** @rcu: struct used for freeing in an RCU-safe manner */
1917         struct rcu_head rcu;
1918 };
1919
1920 /**
1921  * struct batadv_tt_change_node - structure for tt changes occurred
1922  */
1923 struct batadv_tt_change_node {
1924         /** @list: list node for &batadv_priv_tt.changes_list */
1925         struct list_head list;
1926
1927         /** @change: holds the actual translation table diff data */
1928         struct batadv_tvlv_tt_change change;
1929 };
1930
1931 /**
1932  * struct batadv_tt_req_node - data to keep track of the tt requests in flight
1933  */
1934 struct batadv_tt_req_node {
1935         /**
1936          * @addr: mac address address of the originator this request was sent to
1937          */
1938         u8 addr[ETH_ALEN];
1939
1940         /** @issued_at: timestamp used for purging stale tt requests */
1941         unsigned long issued_at;
1942
1943         /** @refcount: number of contexts the object is used by */
1944         struct kref refcount;
1945
1946         /** @list: list node for &batadv_priv_tt.req_list */
1947         struct hlist_node list;
1948 };
1949
1950 /**
1951  * struct batadv_tt_roam_node - roaming client data
1952  */
1953 struct batadv_tt_roam_node {
1954         /** @addr: mac address of the client in the roaming phase */
1955         u8 addr[ETH_ALEN];
1956
1957         /**
1958          * @counter: number of allowed roaming events per client within a single
1959          * OGM interval (changes are committed with each OGM)
1960          */
1961         atomic_t counter;
1962
1963         /**
1964          * @first_time: timestamp used for purging stale roaming node entries
1965          */
1966         unsigned long first_time;
1967
1968         /** @list: list node for &batadv_priv_tt.roam_list */
1969         struct list_head list;
1970 };
1971
1972 /**
1973  * struct batadv_nc_node - network coding node
1974  */
1975 struct batadv_nc_node {
1976         /** @list: next and prev pointer for the list handling */
1977         struct list_head list;
1978
1979         /** @addr: the node's mac address */
1980         u8 addr[ETH_ALEN];
1981
1982         /** @refcount: number of contexts the object is used by */
1983         struct kref refcount;
1984
1985         /** @rcu: struct used for freeing in an RCU-safe manner */
1986         struct rcu_head rcu;
1987
1988         /** @orig_node: pointer to corresponding orig node struct */
1989         struct batadv_orig_node *orig_node;
1990
1991         /** @last_seen: timestamp of last ogm received from this node */
1992         unsigned long last_seen;
1993 };
1994
1995 /**
1996  * struct batadv_nc_path - network coding path
1997  */
1998 struct batadv_nc_path {
1999         /** @hash_entry: next and prev pointer for the list handling */
2000         struct hlist_node hash_entry;
2001
2002         /** @rcu: struct used for freeing in an RCU-safe manner */
2003         struct rcu_head rcu;
2004
2005         /** @refcount: number of contexts the object is used by */
2006         struct kref refcount;
2007
2008         /** @packet_list: list of buffered packets for this path */
2009         struct list_head packet_list;
2010
2011         /** @packet_list_lock: access lock for packet list */
2012         spinlock_t packet_list_lock;
2013
2014         /** @next_hop: next hop (destination) of path */
2015         u8 next_hop[ETH_ALEN];
2016
2017         /** @prev_hop: previous hop (source) of path */
2018         u8 prev_hop[ETH_ALEN];
2019
2020         /** @last_valid: timestamp for last validation of path */
2021         unsigned long last_valid;
2022 };
2023
2024 /**
2025  * struct batadv_nc_packet - network coding packet used when coding and
2026  *  decoding packets
2027  */
2028 struct batadv_nc_packet {
2029         /** @list: next and prev pointer for the list handling */
2030         struct list_head list;
2031
2032         /** @packet_id: crc32 checksum of skb data */
2033         __be32 packet_id;
2034
2035         /**
2036          * @timestamp: field containing the info when the packet was added to
2037          *  path
2038          */
2039         unsigned long timestamp;
2040
2041         /** @neigh_node: pointer to original next hop neighbor of skb */
2042         struct batadv_neigh_node *neigh_node;
2043
2044         /** @skb: skb which can be encoded or used for decoding */
2045         struct sk_buff *skb;
2046
2047         /** @nc_path: pointer to path this nc packet is attached to */
2048         struct batadv_nc_path *nc_path;
2049 };
2050
2051 /**
2052  * struct batadv_skb_cb - control buffer structure used to store private data
2053  *  relevant to batman-adv in the skb->cb buffer in skbs.
2054  */
2055 struct batadv_skb_cb {
2056         /**
2057          * @decoded: Marks a skb as decoded, which is checked when searching for
2058          *  coding opportunities in network-coding.c
2059          */
2060         unsigned char decoded:1;
2061
2062         /** @num_bcasts: Counter for broadcast packet retransmissions */
2063         unsigned char num_bcasts;
2064 };
2065
2066 /**
2067  * struct batadv_forw_packet - structure for bcast packets to be sent/forwarded
2068  */
2069 struct batadv_forw_packet {
2070         /**
2071          * @list: list node for &batadv_priv.forw.bcast_list and
2072          *  &batadv_priv.forw.bat_list
2073          */
2074         struct hlist_node list;
2075
2076         /** @cleanup_list: list node for purging functions */
2077         struct hlist_node cleanup_list;
2078
2079         /** @send_time: execution time for delayed_work (packet sending) */
2080         unsigned long send_time;
2081
2082         /**
2083          * @own: bool for locally generated packets (local OGMs are re-scheduled
2084          * after sending)
2085          */
2086         u8 own;
2087
2088         /** @skb: bcast packet's skb buffer */
2089         struct sk_buff *skb;
2090
2091         /** @packet_len: size of aggregated OGM packet inside the skb buffer */
2092         u16 packet_len;
2093
2094         /** @direct_link_flags: direct link flags for aggregated OGM packets */
2095         u32 direct_link_flags;
2096
2097         /** @num_packets: counter for aggregated OGMv1 packets */
2098         u8 num_packets;
2099
2100         /** @delayed_work: work queue callback item for packet sending */
2101         struct delayed_work delayed_work;
2102
2103         /**
2104          * @if_incoming: pointer to incoming hard-iface or primary iface if
2105          *  locally generated packet
2106          */
2107         struct batadv_hard_iface *if_incoming;
2108
2109         /**
2110          * @if_outgoing: packet where the packet should be sent to, or NULL if
2111          *  unspecified
2112          */
2113         struct batadv_hard_iface *if_outgoing;
2114
2115         /** @queue_left: The queue (counter) this packet was applied to */
2116         atomic_t *queue_left;
2117 };
2118
2119 /**
2120  * struct batadv_algo_iface_ops - mesh algorithm callbacks (interface specific)
2121  */
2122 struct batadv_algo_iface_ops {
2123         /**
2124          * @activate: start routing mechanisms when hard-interface is brought up
2125          *  (optional)
2126          */
2127         void (*activate)(struct batadv_hard_iface *hard_iface);
2128
2129         /** @enable: init routing info when hard-interface is enabled */
2130         int (*enable)(struct batadv_hard_iface *hard_iface);
2131
2132         /** @disable: de-init routing info when hard-interface is disabled */
2133         void (*disable)(struct batadv_hard_iface *hard_iface);
2134
2135         /**
2136          * @update_mac: (re-)init mac addresses of the protocol information
2137          *  belonging to this hard-interface
2138          */
2139         void (*update_mac)(struct batadv_hard_iface *hard_iface);
2140
2141         /** @primary_set: called when primary interface is selected / changed */
2142         void (*primary_set)(struct batadv_hard_iface *hard_iface);
2143 };
2144
2145 /**
2146  * struct batadv_algo_neigh_ops - mesh algorithm callbacks (neighbour specific)
2147  */
2148 struct batadv_algo_neigh_ops {
2149         /** @hardif_init: called on creation of single hop entry (optional) */
2150         void (*hardif_init)(struct batadv_hardif_neigh_node *neigh);
2151
2152         /**
2153          * @cmp: compare the metrics of two neighbors for their respective
2154          *  outgoing interfaces
2155          */
2156         int (*cmp)(struct batadv_neigh_node *neigh1,
2157                    struct batadv_hard_iface *if_outgoing1,
2158                    struct batadv_neigh_node *neigh2,
2159                    struct batadv_hard_iface *if_outgoing2);
2160
2161         /**
2162          * @is_similar_or_better: check if neigh1 is equally similar or better
2163          *  than neigh2 for their respective outgoing interface from the metric
2164          *  prospective
2165          */
2166         bool (*is_similar_or_better)(struct batadv_neigh_node *neigh1,
2167                                      struct batadv_hard_iface *if_outgoing1,
2168                                      struct batadv_neigh_node *neigh2,
2169                                      struct batadv_hard_iface *if_outgoing2);
2170
2171 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
2172         /** @print: print the single hop neighbor list (optional) */
2173         void (*print)(struct batadv_priv *priv, struct seq_file *seq);
2174 #endif
2175
2176         /** @dump: dump neighbors to a netlink socket (optional) */
2177         void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
2178                      struct batadv_priv *priv,
2179                      struct batadv_hard_iface *hard_iface);
2180 };
2181
2182 /**
2183  * struct batadv_algo_orig_ops - mesh algorithm callbacks (originator specific)
2184  */
2185 struct batadv_algo_orig_ops {
2186 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
2187         /** @print: print the originator table (optional) */
2188         void (*print)(struct batadv_priv *priv, struct seq_file *seq,
2189                       struct batadv_hard_iface *hard_iface);
2190 #endif
2191
2192         /** @dump: dump originators to a netlink socket (optional) */
2193         void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
2194                      struct batadv_priv *priv,
2195                      struct batadv_hard_iface *hard_iface);
2196 };
2197
2198 /**
2199  * struct batadv_algo_gw_ops - mesh algorithm callbacks (GW specific)
2200  */
2201 struct batadv_algo_gw_ops {
2202         /** @init_sel_class: initialize GW selection class (optional) */
2203         void (*init_sel_class)(struct batadv_priv *bat_priv);
2204
2205         /**
2206          * @store_sel_class: parse and stores a new GW selection class
2207          *  (optional)
2208          */
2209         ssize_t (*store_sel_class)(struct batadv_priv *bat_priv, char *buff,
2210                                    size_t count);
2211
2212         /** @show_sel_class: prints the current GW selection class (optional) */
2213         ssize_t (*show_sel_class)(struct batadv_priv *bat_priv, char *buff);
2214
2215         /**
2216          * @get_best_gw_node: select the best GW from the list of available
2217          *  nodes (optional)
2218          */
2219         struct batadv_gw_node *(*get_best_gw_node)
2220                 (struct batadv_priv *bat_priv);
2221
2222         /**
2223          * @is_eligible: check if a newly discovered GW is a potential candidate
2224          *  for the election as best GW (optional)
2225          */
2226         bool (*is_eligible)(struct batadv_priv *bat_priv,
2227                             struct batadv_orig_node *curr_gw_orig,
2228                             struct batadv_orig_node *orig_node);
2229
2230 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
2231         /** @print: print the gateway table (optional) */
2232         void (*print)(struct batadv_priv *bat_priv, struct seq_file *seq);
2233 #endif
2234
2235         /** @dump: dump gateways to a netlink socket (optional) */
2236         void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
2237                      struct batadv_priv *priv);
2238 };
2239
2240 /**
2241  * struct batadv_algo_ops - mesh algorithm callbacks
2242  */
2243 struct batadv_algo_ops {
2244         /** @list: list node for the batadv_algo_list */
2245         struct hlist_node list;
2246
2247         /** @name: name of the algorithm */
2248         char *name;
2249
2250         /** @iface: callbacks related to interface handling */
2251         struct batadv_algo_iface_ops iface;
2252
2253         /** @neigh: callbacks related to neighbors handling */
2254         struct batadv_algo_neigh_ops neigh;
2255
2256         /** @orig: callbacks related to originators handling */
2257         struct batadv_algo_orig_ops orig;
2258
2259         /** @gw: callbacks related to GW mode */
2260         struct batadv_algo_gw_ops gw;
2261 };
2262
2263 /**
2264  * struct batadv_dat_entry - it is a single entry of batman-adv ARP backend. It
2265  * is used to stored ARP entries needed for the global DAT cache
2266  */
2267 struct batadv_dat_entry {
2268         /** @ip: the IPv4 corresponding to this DAT/ARP entry */
2269         __be32 ip;
2270
2271         /** @mac_addr: the MAC address associated to the stored IPv4 */
2272         u8 mac_addr[ETH_ALEN];
2273
2274         /** @vid: the vlan ID associated to this entry */
2275         unsigned short vid;
2276
2277         /**
2278          * @last_update: time in jiffies when this entry was refreshed last time
2279          */
2280         unsigned long last_update;
2281
2282         /** @hash_entry: hlist node for &batadv_priv_dat.hash */
2283         struct hlist_node hash_entry;
2284
2285         /** @refcount: number of contexts the object is used */
2286         struct kref refcount;
2287
2288         /** @rcu: struct used for freeing in an RCU-safe manner */
2289         struct rcu_head rcu;
2290 };
2291
2292 /**
2293  * struct batadv_hw_addr - a list entry for a MAC address
2294  */
2295 struct batadv_hw_addr {
2296         /** @list: list node for the linking of entries */
2297         struct hlist_node list;
2298
2299         /** @addr: the MAC address of this list entry */
2300         unsigned char addr[ETH_ALEN];
2301 };
2302
2303 /**
2304  * struct batadv_dat_candidate - candidate destination for DAT operations
2305  */
2306 struct batadv_dat_candidate {
2307         /**
2308          * @type: the type of the selected candidate. It can one of the
2309          *  following:
2310          *        - BATADV_DAT_CANDIDATE_NOT_FOUND
2311          *        - BATADV_DAT_CANDIDATE_ORIG
2312          */
2313         int type;
2314
2315         /**
2316          * @orig_node: if type is BATADV_DAT_CANDIDATE_ORIG this field points to
2317          * the corresponding originator node structure
2318          */
2319         struct batadv_orig_node *orig_node;
2320 };
2321
2322 /**
2323  * struct batadv_tvlv_container - container for tvlv appended to OGMs
2324  */
2325 struct batadv_tvlv_container {
2326         /** @list: hlist node for &batadv_priv_tvlv.container_list */
2327         struct hlist_node list;
2328
2329         /** @tvlv_hdr: tvlv header information needed to construct the tvlv */
2330         struct batadv_tvlv_hdr tvlv_hdr;
2331
2332         /** @refcount: number of contexts the object is used */
2333         struct kref refcount;
2334 };
2335
2336 /**
2337  * struct batadv_tvlv_handler - handler for specific tvlv type and version
2338  */
2339 struct batadv_tvlv_handler {
2340         /** @list: hlist node for &batadv_priv_tvlv.handler_list */
2341         struct hlist_node list;
2342
2343         /**
2344          * @ogm_handler: handler callback which is given the tvlv payload to
2345          *  process on incoming OGM packets
2346          */
2347         void (*ogm_handler)(struct batadv_priv *bat_priv,
2348                             struct batadv_orig_node *orig,
2349                             u8 flags, void *tvlv_value, u16 tvlv_value_len);
2350
2351         /**
2352          * @unicast_handler: handler callback which is given the tvlv payload to
2353          *  process on incoming unicast tvlv packets
2354          */
2355         int (*unicast_handler)(struct batadv_priv *bat_priv,
2356                                u8 *src, u8 *dst,
2357                                void *tvlv_value, u16 tvlv_value_len);
2358
2359         /** @type: tvlv type this handler feels responsible for */
2360         u8 type;
2361
2362         /** @version: tvlv version this handler feels responsible for */
2363         u8 version;
2364
2365         /** @flags: tvlv handler flags */
2366         u8 flags;
2367
2368         /** @refcount: number of contexts the object is used */
2369         struct kref refcount;
2370
2371         /** @rcu: struct used for freeing in an RCU-safe manner */
2372         struct rcu_head rcu;
2373 };
2374
2375 /**
2376  * enum batadv_tvlv_handler_flags - tvlv handler flags definitions
2377  */
2378 enum batadv_tvlv_handler_flags {
2379         /**
2380          * @BATADV_TVLV_HANDLER_OGM_CIFNOTFND: tvlv ogm processing function
2381          *  will call this handler even if its type was not found (with no data)
2382          */
2383         BATADV_TVLV_HANDLER_OGM_CIFNOTFND = BIT(1),
2384
2385         /**
2386          * @BATADV_TVLV_HANDLER_OGM_CALLED: interval tvlv handling flag - the
2387          *  API marks a handler as being called, so it won't be called if the
2388          *  BATADV_TVLV_HANDLER_OGM_CIFNOTFND flag was set
2389          */
2390         BATADV_TVLV_HANDLER_OGM_CALLED = BIT(2),
2391 };
2392
2393 /**
2394  * struct batadv_store_mesh_work - Work queue item to detach add/del interface
2395  *  from sysfs locks
2396  */
2397 struct batadv_store_mesh_work {
2398         /**
2399          * @net_dev: netdevice to add/remove to/from batman-adv soft-interface
2400          */
2401         struct net_device *net_dev;
2402
2403         /** @soft_iface_name: name of soft-interface to modify */
2404         char soft_iface_name[IFNAMSIZ];
2405
2406         /** @work: work queue item */
2407         struct work_struct work;
2408 };
2409
2410 #endif /* _NET_BATMAN_ADV_TYPES_H_ */