net/batman-adv/types.h

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