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_RX: received fragment traffic packet counter
 304  * @BATADV_CNT_FRAG_RX_BYTES: received fragment traffic bytes counter
 305  * @BATADV_CNT_FRAG_FWD: forwarded fragment traffic packet counter
 306  * @BATADV_CNT_FRAG_FWD_BYTES: forwarded fragment traffic bytes counter
 307  * @BATADV_CNT_TT_REQUEST_TX: transmitted tt req traffic packet counter
 308  * @BATADV_CNT_TT_REQUEST_RX: received tt req traffic packet counter
 309  * @BATADV_CNT_TT_RESPONSE_TX: transmitted tt resp traffic packet counter
 310  * @BATADV_CNT_TT_RESPONSE_RX: received tt resp traffic packet counter
 311  * @BATADV_CNT_TT_ROAM_ADV_TX: transmitted tt roam traffic packet counter
 312  * @BATADV_CNT_TT_ROAM_ADV_RX: received tt roam traffic packet counter
 313  * @BATADV_CNT_DAT_GET_TX: transmitted dht GET traffic packet counter
 314  * @BATADV_CNT_DAT_GET_RX: received dht GET traffic packet counter
 315  * @BATADV_CNT_DAT_PUT_TX: transmitted dht PUT traffic packet counter
 316  * @BATADV_CNT_DAT_PUT_RX: received dht PUT traffic packet counter
 317  * @BATADV_CNT_DAT_CACHED_REPLY_TX: transmitted dat cache reply traffic packet
 318  *  counter
 319  * @BATADV_CNT_NC_CODE: transmitted nc-combined traffic packet counter
 320  * @BATADV_CNT_NC_CODE_BYTES: transmitted nc-combined traffic bytes counter
 321  * @BATADV_CNT_NC_RECODE: transmitted nc-recombined traffic packet counter
 322  * @BATADV_CNT_NC_RECODE_BYTES: transmitted nc-recombined traffic bytes counter
 323  * @BATADV_CNT_NC_BUFFER: counter for packets buffered for later nc decoding
 324  * @BATADV_CNT_NC_DECODE: received and nc-decoded traffic packet counter
 325  * @BATADV_CNT_NC_DECODE_BYTES: received and nc-decoded traffic bytes counter
 326  * @BATADV_CNT_NC_DECODE_FAILED: received and decode-failed traffic packet
 327  *  counter
 328  * @BATADV_CNT_NC_SNIFFED: counter for nc-decoded packets received in promisc
 329  *  mode.
 330  * @BATADV_CNT_NUM: number of traffic counters
 331  */
 332 enum batadv_counters {
 333         BATADV_CNT_TX,
 334         BATADV_CNT_TX_BYTES,
 335         BATADV_CNT_TX_DROPPED,
 336         BATADV_CNT_RX,
 337         BATADV_CNT_RX_BYTES,
 338         BATADV_CNT_FORWARD,
 339         BATADV_CNT_FORWARD_BYTES,
 340         BATADV_CNT_MGMT_TX,
 341         BATADV_CNT_MGMT_TX_BYTES,
 342         BATADV_CNT_MGMT_RX,
 343         BATADV_CNT_MGMT_RX_BYTES,
 344         BATADV_CNT_FRAG_RX,
 345         BATADV_CNT_FRAG_RX_BYTES,
 346         BATADV_CNT_FRAG_FWD,
 347         BATADV_CNT_FRAG_FWD_BYTES,
 348         BATADV_CNT_TT_REQUEST_TX,
 349         BATADV_CNT_TT_REQUEST_RX,
 350         BATADV_CNT_TT_RESPONSE_TX,
 351         BATADV_CNT_TT_RESPONSE_RX,
 352         BATADV_CNT_TT_ROAM_ADV_TX,
 353         BATADV_CNT_TT_ROAM_ADV_RX,
 354 #ifdef CONFIG_BATMAN_ADV_DAT
 355         BATADV_CNT_DAT_GET_TX,
 356         BATADV_CNT_DAT_GET_RX,
 357         BATADV_CNT_DAT_PUT_TX,
 358         BATADV_CNT_DAT_PUT_RX,
 359         BATADV_CNT_DAT_CACHED_REPLY_TX,
 360 #endif
 361 #ifdef CONFIG_BATMAN_ADV_NC
 362         BATADV_CNT_NC_CODE,
 363         BATADV_CNT_NC_CODE_BYTES,
 364         BATADV_CNT_NC_RECODE,
 365         BATADV_CNT_NC_RECODE_BYTES,
 366         BATADV_CNT_NC_BUFFER,
 367         BATADV_CNT_NC_DECODE,
 368         BATADV_CNT_NC_DECODE_BYTES,
 369         BATADV_CNT_NC_DECODE_FAILED,
 370         BATADV_CNT_NC_SNIFFED,
 371 #endif
 372         BATADV_CNT_NUM,
 373 };
 374
 375 /**
 376  * struct batadv_priv_tt - per mesh interface translation table data
 377  * @vn: translation table version number
 378  * @ogm_append_cnt: counter of number of OGMs containing the local tt diff
 379  * @local_changes: changes registered in an originator interval
 380  * @changes_list: tracks tt local changes within an originator interval
 381  * @local_hash: local translation table hash table
 382  * @global_hash: global translation table hash table
 383  * @req_list: list of pending & unanswered tt_requests
 384  * @roam_list: list of the last roaming events of each client limiting the
 385  *  number of roaming events to avoid route flapping
 386  * @changes_list_lock: lock protecting changes_list
 387  * @req_list_lock: lock protecting req_list
 388  * @roam_list_lock: lock protecting roam_list
 389  * @local_entry_num: number of entries in the local hash table
 390  * @local_crc: Checksum of the local table, recomputed before sending a new OGM
 391  * @last_changeset: last tt changeset this host has generated
 392  * @last_changeset_len: length of last tt changeset this host has generated
 393  * @last_changeset_lock: lock protecting last_changeset & last_changeset_len
 394  * @work: work queue callback item for translation table purging
 395  */
 396 struct batadv_priv_tt {
 397         atomic_t vn;
 398         atomic_t ogm_append_cnt;
 399         atomic_t local_changes;
 400         struct list_head changes_list;
 401         struct batadv_hashtable *local_hash;
 402         struct batadv_hashtable *global_hash;
 403         struct list_head req_list;
 404         struct list_head roam_list;
 405         spinlock_t changes_list_lock; /* protects changes */
 406         spinlock_t req_list_lock; /* protects req_list */
 407         spinlock_t roam_list_lock; /* protects roam_list */
 408         atomic_t local_entry_num;
 409         uint32_t local_crc;
 410         unsigned char *last_changeset;
 411         int16_t last_changeset_len;
 412         /* protects last_changeset & last_changeset_len */
 413         spinlock_t last_changeset_lock;
 414         struct delayed_work work;
 415 };
 416
 417 /**
 418  * struct batadv_priv_bla - per mesh interface bridge loope avoidance data
 419  * @num_requests; number of bla requests in flight
 420  * @claim_hash: hash table containing mesh nodes this host has claimed
 421  * @backbone_hash: hash table containing all detected backbone gateways
 422  * @bcast_duplist: recently received broadcast packets array (for broadcast
 423  *  duplicate suppression)
 424  * @bcast_duplist_curr: index of last broadcast packet added to bcast_duplist
 425  * @bcast_duplist_lock: lock protecting bcast_duplist & bcast_duplist_curr
 426  * @claim_dest: local claim data (e.g. claim group)
 427  * @work: work queue callback item for cleanups & bla announcements
 428  */
 429 #ifdef CONFIG_BATMAN_ADV_BLA
 430 struct batadv_priv_bla {
 431         atomic_t num_requests;
 432         struct batadv_hashtable *claim_hash;
 433         struct batadv_hashtable *backbone_hash;
 434         struct batadv_bcast_duplist_entry bcast_duplist[BATADV_DUPLIST_SIZE];
 435         int bcast_duplist_curr;
 436         /* protects bcast_duplist & bcast_duplist_curr */
 437         spinlock_t bcast_duplist_lock;
 438         struct batadv_bla_claim_dst claim_dest;
 439         struct delayed_work work;
 440 };
 441 #endif
 442
 443 /**
 444  * struct batadv_debug_log - debug logging data
 445  * @log_buff: buffer holding the logs (ring bufer)
 446  * @log_start: index of next character to read
 447  * @log_end: index of next character to write
 448  * @lock: lock protecting log_buff, log_start & log_end
 449  * @queue_wait: log reader's wait queue
 450  */
 451 #ifdef CONFIG_BATMAN_ADV_DEBUG
 452 struct batadv_priv_debug_log {
 453         char log_buff[BATADV_LOG_BUF_LEN];
 454         unsigned long log_start;
 455         unsigned long log_end;
 456         spinlock_t lock; /* protects log_buff, log_start and log_end */
 457         wait_queue_head_t queue_wait;
 458 };
 459 #endif
 460
 461 /**
 462  * struct batadv_priv_gw - per mesh interface gateway data
 463  * @list: list of available gateway nodes
 464  * @list_lock: lock protecting gw_list & curr_gw
 465  * @curr_gw: pointer to currently selected gateway node
 466  * @bandwidth_down: advertised uplink download bandwidth (if gw_mode server)
 467  * @bandwidth_up: advertised uplink upload bandwidth (if gw_mode server)
 468  * @reselect: bool indicating a gateway re-selection is in progress
 469  */
 470 struct batadv_priv_gw {
 471         struct hlist_head list;
 472         spinlock_t list_lock; /* protects gw_list & curr_gw */
 473         struct batadv_gw_node __rcu *curr_gw;  /* rcu protected pointer */
 474         atomic_t bandwidth_down;
 475         atomic_t bandwidth_up;
 476         atomic_t reselect;
 477 };
 478
 479 /**
 480  * struct batadv_priv_tvlv - per mesh interface tvlv data
 481  * @container_list: list of registered tvlv containers to be sent with each OGM
 482  * @handler_list: list of the various tvlv content handlers
 483  * @container_list_lock: protects tvlv container list access
 484  * @handler_list_lock: protects handler list access
 485  */
 486 struct batadv_priv_tvlv {
 487         struct hlist_head container_list;
 488         struct hlist_head handler_list;
 489         spinlock_t container_list_lock; /* protects container_list */
 490         spinlock_t handler_list_lock; /* protects handler_list */
 491 };
 492
 493 /**
 494  * struct batadv_priv_dat - per mesh interface DAT private data
 495  * @addr: node DAT address
 496  * @hash: hashtable representing the local ARP cache
 497  * @work: work queue callback item for cache purging
 498  */
 499 #ifdef CONFIG_BATMAN_ADV_DAT
 500 struct batadv_priv_dat {
 501         batadv_dat_addr_t addr;
 502         struct batadv_hashtable *hash;
 503         struct delayed_work work;
 504 };
 505 #endif
 506
 507 /**
 508  * struct batadv_priv_nc - per mesh interface network coding private data
 509  * @work: work queue callback item for cleanup
 510  * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
 511  * @min_tq: only consider neighbors for encoding if neigh_tq > min_tq
 512  * @max_fwd_delay: maximum packet forward delay to allow coding of packets
 513  * @max_buffer_time: buffer time for sniffed packets used to decoding
 514  * @timestamp_fwd_flush: timestamp of last forward packet queue flush
 515  * @timestamp_sniffed_purge: timestamp of last sniffed packet queue purge
 516  * @coding_hash: Hash table used to buffer skbs while waiting for another
 517  *  incoming skb to code it with. Skbs are added to the buffer just before being
 518  *  forwarded in routing.c
 519  * @decoding_hash: Hash table used to buffer skbs that might be needed to decode
 520  *  a received coded skb. The buffer is used for 1) skbs arriving on the
 521  *  soft-interface; 2) skbs overheard on the hard-interface; and 3) skbs
 522  *  forwarded by batman-adv.
 523  */
 524 struct batadv_priv_nc {
 525         struct delayed_work work;
 526         struct dentry *debug_dir;
 527         u8 min_tq;
 528         u32 max_fwd_delay;
 529         u32 max_buffer_time;
 530         unsigned long timestamp_fwd_flush;
 531         unsigned long timestamp_sniffed_purge;
 532         struct batadv_hashtable *coding_hash;
 533         struct batadv_hashtable *decoding_hash;
 534 };
 535
 536 /**
 537  * struct batadv_priv - per mesh interface data
 538  * @mesh_state: current status of the mesh (inactive/active/deactivating)
 539  * @soft_iface: net device which holds this struct as private data
 540  * @stats: structure holding the data for the ndo_get_stats() call
 541  * @bat_counters: mesh internal traffic statistic counters (see batadv_counters)
 542  * @aggregated_ogms: bool indicating whether OGM aggregation is enabled
 543  * @bonding: bool indicating whether traffic bonding is enabled
 544  * @fragmentation: bool indicating whether traffic fragmentation is enabled
 545  * @ap_isolation: bool indicating whether ap isolation is enabled
 546  * @bridge_loop_avoidance: bool indicating whether bridge loop avoidance is
 547  *  enabled
 548  * @distributed_arp_table: bool indicating whether distributed ARP table is
 549  *  enabled
 550  * @gw_mode: gateway operation: off, client or server (see batadv_gw_modes)
 551  * @gw_sel_class: gateway selection class (applies if gw_mode client)
 552  * @orig_interval: OGM broadcast interval in milliseconds
 553  * @hop_penalty: penalty which will be applied to an OGM's tq-field on every hop
 554  * @log_level: configured log level (see batadv_dbg_level)
 555  * @bcast_seqno: last sent broadcast packet sequence number
 556  * @bcast_queue_left: number of remaining buffered broadcast packet slots
 557  * @batman_queue_left: number of remaining OGM packet slots
 558  * @num_ifaces: number of interfaces assigned to this mesh interface
 559  * @mesh_obj: kobject for sysfs mesh subdirectory
 560  * @debug_dir: dentry for debugfs batman-adv subdirectory
 561  * @forw_bat_list: list of aggregated OGMs that will be forwarded
 562  * @forw_bcast_list: list of broadcast packets that will be rebroadcasted
 563  * @orig_hash: hash table containing mesh participants (orig nodes)
 564  * @forw_bat_list_lock: lock protecting forw_bat_list
 565  * @forw_bcast_list_lock: lock protecting forw_bcast_list
 566  * @orig_work: work queue callback item for orig node purging
 567  * @cleanup_work: work queue callback item for soft interface deinit
 568  * @primary_if: one of the hard interfaces assigned to this mesh interface
 569  *  becomes the primary interface
 570  * @bat_algo_ops: routing algorithm used by this mesh interface
 571  * @bla: bridge loope avoidance data
 572  * @debug_log: holding debug logging relevant data
 573  * @gw: gateway data
 574  * @tt: translation table data
 575  * @tvlv: type-version-length-value data
 576  * @dat: distributed arp table data
 577  * @network_coding: bool indicating whether network coding is enabled
 578  * @batadv_priv_nc: network coding data
 579  */
 580 struct batadv_priv {
 581         atomic_t mesh_state;
 582         struct net_device *soft_iface;
 583         struct net_device_stats stats;
 584         uint64_t __percpu *bat_counters; /* Per cpu counters */
 585         atomic_t aggregated_ogms;
 586         atomic_t bonding;
 587         atomic_t fragmentation;
 588         atomic_t ap_isolation;
 589 #ifdef CONFIG_BATMAN_ADV_BLA
 590         atomic_t bridge_loop_avoidance;
 591 #endif
 592 #ifdef CONFIG_BATMAN_ADV_DAT
 593         atomic_t distributed_arp_table;
 594 #endif
 595         atomic_t gw_mode;
 596         atomic_t gw_sel_class;
 597         atomic_t orig_interval;
 598         atomic_t hop_penalty;
 599 #ifdef CONFIG_BATMAN_ADV_DEBUG
 600         atomic_t log_level;
 601 #endif
 602         atomic_t bcast_seqno;
 603         atomic_t bcast_queue_left;
 604         atomic_t batman_queue_left;
 605         char num_ifaces;
 606         struct kobject *mesh_obj;
 607         struct dentry *debug_dir;
 608         struct hlist_head forw_bat_list;
 609         struct hlist_head forw_bcast_list;
 610         struct batadv_hashtable *orig_hash;
 611         spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
 612         spinlock_t forw_bcast_list_lock; /* protects forw_bcast_list */
 613         struct delayed_work orig_work;
 614         struct work_struct cleanup_work;
 615         struct batadv_hard_iface __rcu *primary_if;  /* rcu protected pointer */
 616         struct batadv_algo_ops *bat_algo_ops;
 617 #ifdef CONFIG_BATMAN_ADV_BLA
 618         struct batadv_priv_bla bla;
 619 #endif
 620 #ifdef CONFIG_BATMAN_ADV_DEBUG
 621         struct batadv_priv_debug_log *debug_log;
 622 #endif
 623         struct batadv_priv_gw gw;
 624         struct batadv_priv_tt tt;
 625         struct batadv_priv_tvlv tvlv;
 626 #ifdef CONFIG_BATMAN_ADV_DAT
 627         struct batadv_priv_dat dat;
 628 #endif
 629 #ifdef CONFIG_BATMAN_ADV_NC
 630         atomic_t network_coding;
 631         struct batadv_priv_nc nc;
 632 #endif /* CONFIG_BATMAN_ADV_NC */
 633 };
 634
 635 /**
 636  * struct batadv_socket_client - layer2 icmp socket client data
 637  * @queue_list: packet queue for packets destined for this socket client
 638  * @queue_len: number of packets in the packet queue (queue_list)
 639  * @index: socket client's index in the batadv_socket_client_hash
 640  * @lock: lock protecting queue_list, queue_len & index
 641  * @queue_wait: socket client's wait queue
 642  * @bat_priv: pointer to soft_iface this client belongs to
 643  */
 644 struct batadv_socket_client {
 645         struct list_head queue_list;
 646         unsigned int queue_len;
 647         unsigned char index;
 648         spinlock_t lock; /* protects queue_list, queue_len & index */
 649         wait_queue_head_t queue_wait;
 650         struct batadv_priv *bat_priv;
 651 };
 652
 653 /**
 654  * struct batadv_socket_packet - layer2 icmp packet for socket client
 655  * @list: list node for batadv_socket_client::queue_list
 656  * @icmp_len: size of the layer2 icmp packet
 657  * @icmp_packet: layer2 icmp packet
 658  */
 659 struct batadv_socket_packet {
 660         struct list_head list;
 661         size_t icmp_len;
 662         struct batadv_icmp_packet_rr icmp_packet;
 663 };
 664
 665 /**
 666  * struct batadv_bla_backbone_gw - batman-adv gateway bridged into the LAN
 667  * @orig: originator address of backbone node (mac address of primary iface)
 668  * @vid: vlan id this gateway was detected on
 669  * @hash_entry: hlist node for batadv_priv_bla::backbone_hash
 670  * @bat_priv: pointer to soft_iface this backbone gateway belongs to
 671  * @lasttime: last time we heard of this backbone gw
 672  * @wait_periods: grace time for bridge forward delays and bla group forming at
 673  *  bootup phase - no bcast traffic is formwared until it has elapsed
 674  * @request_sent: if this bool is set to true we are out of sync with this
 675  *  backbone gateway - no bcast traffic is formwared until the situation was
 676  *  resolved
 677  * @crc: crc16 checksum over all claims
 678  * @refcount: number of contexts the object is used
 679  * @rcu: struct used for freeing in an RCU-safe manner
 680  */
 681 #ifdef CONFIG_BATMAN_ADV_BLA
 682 struct batadv_bla_backbone_gw {
 683         uint8_t orig[ETH_ALEN];
 684         unsigned short vid;
 685         struct hlist_node hash_entry;
 686         struct batadv_priv *bat_priv;
 687         unsigned long lasttime;
 688         atomic_t wait_periods;
 689         atomic_t request_sent;
 690         uint16_t crc;
 691         atomic_t refcount;
 692         struct rcu_head rcu;
 693 };
 694
 695 /**
 696  * struct batadv_bla_claim - claimed non-mesh client structure
 697  * @addr: mac address of claimed non-mesh client
 698  * @vid: vlan id this client was detected on
 699  * @batadv_bla_backbone_gw: pointer to backbone gw claiming this client
 700  * @lasttime: last time we heard of claim (locals only)
 701  * @hash_entry: hlist node for batadv_priv_bla::claim_hash
 702  * @refcount: number of contexts the object is used
 703  * @rcu: struct used for freeing in an RCU-safe manner
 704  */
 705 struct batadv_bla_claim {
 706         uint8_t addr[ETH_ALEN];
 707         unsigned short vid;
 708         struct batadv_bla_backbone_gw *backbone_gw;
 709         unsigned long lasttime;
 710         struct hlist_node hash_entry;
 711         struct rcu_head rcu;
 712         atomic_t refcount;
 713 };
 714 #endif
 715
 716 /**
 717  * struct batadv_tt_common_entry - tt local & tt global common data
 718  * @addr: mac address of non-mesh client
 719  * @hash_entry: hlist node for batadv_priv_tt::local_hash or for
 720  *  batadv_priv_tt::global_hash
 721  * @flags: various state handling flags (see batadv_tt_client_flags)
 722  * @added_at: timestamp used for purging stale tt common entries
 723  * @refcount: number of contexts the object is used
 724  * @rcu: struct used for freeing in an RCU-safe manner
 725  */
 726 struct batadv_tt_common_entry {
 727         uint8_t addr[ETH_ALEN];
 728         struct hlist_node hash_entry;
 729         uint16_t flags;
 730         unsigned long added_at;
 731         atomic_t refcount;
 732         struct rcu_head rcu;
 733 };
 734
 735 /**
 736  * struct batadv_tt_local_entry - translation table local entry data
 737  * @common: general translation table data
 738  * @last_seen: timestamp used for purging stale tt local entries
 739  */
 740 struct batadv_tt_local_entry {
 741         struct batadv_tt_common_entry common;
 742         unsigned long last_seen;
 743 };
 744
 745 /**
 746  * struct batadv_tt_global_entry - translation table global entry data
 747  * @common: general translation table data
 748  * @orig_list: list of orig nodes announcing this non-mesh client
 749  * @list_lock: lock protecting orig_list
 750  * @roam_at: time at which TT_GLOBAL_ROAM was set
 751  */
 752 struct batadv_tt_global_entry {
 753         struct batadv_tt_common_entry common;
 754         struct hlist_head orig_list;
 755         spinlock_t list_lock;   /* protects orig_list */
 756         unsigned long roam_at;
 757 };
 758
 759 /**
 760  * struct batadv_tt_orig_list_entry - orig node announcing a non-mesh client
 761  * @orig_node: pointer to orig node announcing this non-mesh client
 762  * @ttvn: translation table version number which added the non-mesh client
 763  * @list: list node for batadv_tt_global_entry::orig_list
 764  * @refcount: number of contexts the object is used
 765  * @rcu: struct used for freeing in an RCU-safe manner
 766  */
 767 struct batadv_tt_orig_list_entry {
 768         struct batadv_orig_node *orig_node;
 769         uint8_t ttvn;
 770         struct hlist_node list;
 771         atomic_t refcount;
 772         struct rcu_head rcu;
 773 };
 774
 775 /**
 776  * struct batadv_tt_change_node - structure for tt changes occured
 777  * @list: list node for batadv_priv_tt::changes_list
 778  * @change: holds the actual translation table diff data
 779  */
 780 struct batadv_tt_change_node {
 781         struct list_head list;
 782         struct batadv_tvlv_tt_change change;
 783 };
 784
 785 /**
 786  * struct batadv_tt_req_node - data to keep track of the tt requests in flight
 787  * @addr: mac address address of the originator this request was sent to
 788  * @issued_at: timestamp used for purging stale tt requests
 789  * @list: list node for batadv_priv_tt::req_list
 790  */
 791 struct batadv_tt_req_node {
 792         uint8_t addr[ETH_ALEN];
 793         unsigned long issued_at;
 794         struct list_head list;
 795 };
 796
 797 /**
 798  * struct batadv_tt_roam_node - roaming client data
 799  * @addr: mac address of the client in the roaming phase
 800  * @counter: number of allowed roaming events per client within a single
 801  *  OGM interval (changes are committed with each OGM)
 802  * @first_time: timestamp used for purging stale roaming node entries
 803  * @list: list node for batadv_priv_tt::roam_list
 804  */
 805 struct batadv_tt_roam_node {
 806         uint8_t addr[ETH_ALEN];
 807         atomic_t counter;
 808         unsigned long first_time;
 809         struct list_head list;
 810 };
 811
 812 /**
 813  * struct batadv_nc_node - network coding node
 814  * @list: next and prev pointer for the list handling
 815  * @addr: the node's mac address
 816  * @refcount: number of contexts the object is used by
 817  * @rcu: struct used for freeing in an RCU-safe manner
 818  * @orig_node: pointer to corresponding orig node struct
 819  * @last_seen: timestamp of last ogm received from this node
 820  */
 821 struct batadv_nc_node {
 822         struct list_head list;
 823         uint8_t addr[ETH_ALEN];
 824         atomic_t refcount;
 825         struct rcu_head rcu;
 826         struct batadv_orig_node *orig_node;
 827         unsigned long last_seen;
 828 };
 829
 830 /**
 831  * struct batadv_nc_path - network coding path
 832  * @hash_entry: next and prev pointer for the list handling
 833  * @rcu: struct used for freeing in an RCU-safe manner
 834  * @refcount: number of contexts the object is used by
 835  * @packet_list: list of buffered packets for this path
 836  * @packet_list_lock: access lock for packet list
 837  * @next_hop: next hop (destination) of path
 838  * @prev_hop: previous hop (source) of path
 839  * @last_valid: timestamp for last validation of path
 840  */
 841 struct batadv_nc_path {
 842         struct hlist_node hash_entry;
 843         struct rcu_head rcu;
 844         atomic_t refcount;
 845         struct list_head packet_list;
 846         spinlock_t packet_list_lock; /* Protects packet_list */
 847         uint8_t next_hop[ETH_ALEN];
 848         uint8_t prev_hop[ETH_ALEN];
 849         unsigned long last_valid;
 850 };
 851
 852 /**
 853  * struct batadv_nc_packet - network coding packet used when coding and
 854  *  decoding packets
 855  * @list: next and prev pointer for the list handling
 856  * @packet_id: crc32 checksum of skb data
 857  * @timestamp: field containing the info when the packet was added to path
 858  * @neigh_node: pointer to original next hop neighbor of skb
 859  * @skb: skb which can be encoded or used for decoding
 860  * @nc_path: pointer to path this nc packet is attached to
 861  */
 862 struct batadv_nc_packet {
 863         struct list_head list;
 864         __be32 packet_id;
 865         unsigned long timestamp;
 866         struct batadv_neigh_node *neigh_node;
 867         struct sk_buff *skb;
 868         struct batadv_nc_path *nc_path;
 869 };
 870
 871 /**
 872  * batadv_skb_cb - control buffer structure used to store private data relevant
 873  *  to batman-adv in the skb->cb buffer in skbs.
 874  * @decoded: Marks a skb as decoded, which is checked when searching for coding
 875  *  opportunities in network-coding.c
 876  */
 877 struct batadv_skb_cb {
 878         bool decoded;
 879 };
 880
 881 /**
 882  * struct batadv_forw_packet - structure for bcast packets to be sent/forwarded
 883  * @list: list node for batadv_socket_client::queue_list
 884  * @send_time: execution time for delayed_work (packet sending)
 885  * @own: bool for locally generated packets (local OGMs are re-scheduled after
 886  *  sending)
 887  * @skb: bcast packet's skb buffer
 888  * @packet_len: size of aggregated OGM packet inside the skb buffer
 889  * @direct_link_flags: direct link flags for aggregated OGM packets
 890  * @num_packets: counter for bcast packet retransmission
 891  * @delayed_work: work queue callback item for packet sending
 892  * @if_incoming: pointer incoming hard-iface or primary iface if locally
 893  *  generated packet
 894  */
 895 struct batadv_forw_packet {
 896         struct hlist_node list;
 897         unsigned long send_time;
 898         uint8_t own;
 899         struct sk_buff *skb;
 900         uint16_t packet_len;
 901         uint32_t direct_link_flags;
 902         uint8_t num_packets;
 903         struct delayed_work delayed_work;
 904         struct batadv_hard_iface *if_incoming;
 905 };
 906
 907 /**
 908  * struct batadv_algo_ops - mesh algorithm callbacks
 909  * @list: list node for the batadv_algo_list
 910  * @name: name of the algorithm
 911  * @bat_iface_enable: init routing info when hard-interface is enabled
 912  * @bat_iface_disable: de-init routing info when hard-interface is disabled
 913  * @bat_iface_update_mac: (re-)init mac addresses of the protocol information
 914  *  belonging to this hard-interface
 915  * @bat_primary_iface_set: called when primary interface is selected / changed
 916  * @bat_ogm_schedule: prepare a new outgoing OGM for the send queue
 917  * @bat_ogm_emit: send scheduled OGM
 918  */
 919 struct batadv_algo_ops {
 920         struct hlist_node list;
 921         char *name;
 922         int (*bat_iface_enable)(struct batadv_hard_iface *hard_iface);
 923         void (*bat_iface_disable)(struct batadv_hard_iface *hard_iface);
 924         void (*bat_iface_update_mac)(struct batadv_hard_iface *hard_iface);
 925         void (*bat_primary_iface_set)(struct batadv_hard_iface *hard_iface);
 926         void (*bat_ogm_schedule)(struct batadv_hard_iface *hard_iface);
 927         void (*bat_ogm_emit)(struct batadv_forw_packet *forw_packet);
 928 };
 929
 930 /**
 931  * struct batadv_dat_entry - it is a single entry of batman-adv ARP backend. It
 932  * is used to stored ARP entries needed for the global DAT cache
 933  * @ip: the IPv4 corresponding to this DAT/ARP entry
 934  * @mac_addr: the MAC address associated to the stored IPv4
 935  * @last_update: time in jiffies when this entry was refreshed last time
 936  * @hash_entry: hlist node for batadv_priv_dat::hash
 937  * @refcount: number of contexts the object is used
 938  * @rcu: struct used for freeing in an RCU-safe manner
 939  */
 940 struct batadv_dat_entry {
 941         __be32 ip;
 942         uint8_t mac_addr[ETH_ALEN];
 943         unsigned long last_update;
 944         struct hlist_node hash_entry;
 945         atomic_t refcount;
 946         struct rcu_head rcu;
 947 };
 948
 949 /**
 950  * struct batadv_dat_candidate - candidate destination for DAT operations
 951  * @type: the type of the selected candidate. It can one of the following:
 952  *        - BATADV_DAT_CANDIDATE_NOT_FOUND
 953  *        - BATADV_DAT_CANDIDATE_ORIG
 954  * @orig_node: if type is BATADV_DAT_CANDIDATE_ORIG this field points to the
 955  *             corresponding originator node structure
 956  */
 957 struct batadv_dat_candidate {
 958         int type;
 959         struct batadv_orig_node *orig_node;
 960 };
 961
 962 /**
 963  * struct batadv_tvlv_container - container for tvlv appended to OGMs
 964  * @list: hlist node for batadv_priv_tvlv::container_list
 965  * @tvlv_hdr: tvlv header information needed to construct the tvlv
 966  * @value_len: length of the buffer following this struct which contains
 967  *  the actual tvlv payload
 968  * @refcount: number of contexts the object is used
 969  */
 970 struct batadv_tvlv_container {
 971         struct hlist_node list;
 972         struct batadv_tvlv_hdr tvlv_hdr;
 973         atomic_t refcount;
 974 };
 975
 976 /**
 977  * struct batadv_tvlv_handler - handler for specific tvlv type and version
 978  * @list: hlist node for batadv_priv_tvlv::handler_list
 979  * @ogm_handler: handler callback which is given the tvlv payload to process on
 980  *  incoming OGM packets
 981  * @unicast_handler: handler callback which is given the tvlv payload to process
 982  *  on incoming unicast tvlv packets
 983  * @type: tvlv type this handler feels responsible for
 984  * @version: tvlv version this handler feels responsible for
 985  * @flags: tvlv handler flags
 986  * @refcount: number of contexts the object is used
 987  * @rcu: struct used for freeing in an RCU-safe manner
 988  */
 989 struct batadv_tvlv_handler {
 990         struct hlist_node list;
 991         void (*ogm_handler)(struct batadv_priv *bat_priv,
 992                             struct batadv_orig_node *orig,
 993                             uint8_t flags,
 994                             void *tvlv_value, uint16_t tvlv_value_len);
 995         int (*unicast_handler)(struct batadv_priv *bat_priv,
 996                                uint8_t *src, uint8_t *dst,
 997                                void *tvlv_value, uint16_t tvlv_value_len);
 998         uint8_t type;
 999         uint8_t version;
1000         uint8_t flags;
1001         atomic_t refcount;
1002         struct rcu_head rcu;
1003 };
1004
1005 /**
1006  * enum batadv_tvlv_handler_flags - tvlv handler flags definitions
1007  * @BATADV_TVLV_HANDLER_OGM_CIFNOTFND: tvlv ogm processing function will call
1008  *  this handler even if its type was not found (with no data)
1009  * @BATADV_TVLV_HANDLER_OGM_CALLED: interval tvlv handling flag - the API marks
1010  *  a handler as being called, so it won't be called if the
1011  *  BATADV_TVLV_HANDLER_OGM_CIFNOTFND flag was set
1012  */
1013 enum batadv_tvlv_handler_flags {
1014         BATADV_TVLV_HANDLER_OGM_CIFNOTFND = BIT(1),
1015         BATADV_TVLV_HANDLER_OGM_CALLED = BIT(2),
1016 };
1017
1018 #endif /* _NET_BATMAN_ADV_TYPES_H_ */