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