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