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