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