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