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