net/batman-adv/types.h

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