net/batman-adv/types.h

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