net/batman-adv/types.h

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