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