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