net/batman-adv/types.h

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