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