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