net/batman-adv/types.h

   1 /* Copyright (C) 2007-2014 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, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #ifndef _NET_BATMAN_ADV_TYPES_H_
  19 #define _NET_BATMAN_ADV_TYPES_H_
  20
  21 #include "packet.h"
  22 #include "bitarray.h"
  23 #include <linux/kernel.h>
  24
  25 #ifdef CONFIG_BATMAN_ADV_DAT
  26
  27 /**
  28  * batadv_dat_addr_t - it is the type used for all DHT addresses. If it is
  29  *  changed, BATADV_DAT_ADDR_MAX is changed as well.
  30  *
  31  * *Please be careful: batadv_dat_addr_t must be UNSIGNED*
  32  */
  33 #define batadv_dat_addr_t uint16_t
  34
  35 #endif /* CONFIG_BATMAN_ADV_DAT */
  36
  37 /**
  38  * enum batadv_dhcp_recipient - dhcp destination
  39  * @BATADV_DHCP_NO: packet is not a dhcp message
  40  * @BATADV_DHCP_TO_SERVER: dhcp message is directed to a server
  41  * @BATADV_DHCP_TO_CLIENT: dhcp message is directed to a client
  42  */
  43 enum batadv_dhcp_recipient {
  44         BATADV_DHCP_NO = 0,
  45         BATADV_DHCP_TO_SERVER,
  46         BATADV_DHCP_TO_CLIENT,
  47 };
  48
  49 /**
  50  * BATADV_TT_REMOTE_MASK - bitmask selecting the flags that are sent over the
  51  *  wire only
  52  */
  53 #define BATADV_TT_REMOTE_MASK   0x00FF
  54
  55 /**
  56  * BATADV_TT_SYNC_MASK - bitmask of the flags that need to be kept in sync
  57  *  among the nodes. These flags are used to compute the global/local CRC
  58  */
  59 #define BATADV_TT_SYNC_MASK     0x00F0
  60
  61 /**
  62  * struct batadv_hard_iface_bat_iv - per hard interface B.A.T.M.A.N. IV data
  63  * @ogm_buff: buffer holding the OGM packet
  64  * @ogm_buff_len: length of the OGM packet buffer
  65  * @ogm_seqno: OGM sequence number - used to identify each OGM
  66  */
  67 struct batadv_hard_iface_bat_iv {
  68         unsigned char *ogm_buff;
  69         int ogm_buff_len;
  70         atomic_t ogm_seqno;
  71 };
  72
  73 /**
  74  * struct batadv_hard_iface - network device known to batman-adv
  75  * @list: list node for batadv_hardif_list
  76  * @if_num: identificator of the interface
  77  * @if_status: status of the interface for batman-adv
  78  * @net_dev: pointer to the net_device
  79  * @num_bcasts: number of payload re-broadcasts on this interface (ARQ)
  80  * @hardif_obj: kobject of the per interface sysfs "mesh" directory
  81  * @refcount: number of contexts the object is used
  82  * @batman_adv_ptype: packet type describing packets that should be processed by
  83  *  batman-adv for this interface
  84  * @soft_iface: the batman-adv interface which uses this network interface
  85  * @rcu: struct used for freeing in an RCU-safe manner
  86  * @bat_iv: BATMAN IV specific per hard interface data
  87  * @cleanup_work: work queue callback item for hard interface deinit
  88  * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
  89  */
  90 struct batadv_hard_iface {
  91         struct list_head list;
  92         int16_t if_num;
  93         char if_status;
  94         struct net_device *net_dev;
  95         uint8_t num_bcasts;
  96         struct kobject *hardif_obj;
  97         atomic_t refcount;
  98         struct packet_type batman_adv_ptype;
  99         struct net_device *soft_iface;
 100         struct rcu_head rcu;
 101         struct batadv_hard_iface_bat_iv bat_iv;
 102         struct work_struct cleanup_work;
 103         struct dentry *debug_dir;
 104 };
 105
 106 /**
 107  * struct batadv_orig_ifinfo - originator info per outgoing interface
 108  * @list: list node for orig_node::ifinfo_list
 109  * @if_outgoing: pointer to outgoing hard interface
 110  * @router: router that should be used to reach this originator
 111  * @last_real_seqno: last and best known sequence number
 112  * @last_ttl: ttl of last received packet
 113  * @batman_seqno_reset: time when the batman seqno window was reset
 114  * @refcount: number of contexts the object is used
 115  * @rcu: struct used for freeing in an RCU-safe manner
 116  */
 117 struct batadv_orig_ifinfo {
 118         struct hlist_node list;
 119         struct batadv_hard_iface *if_outgoing;
 120         struct batadv_neigh_node __rcu *router; /* rcu protected pointer */
 121         uint32_t last_real_seqno;
 122         uint8_t last_ttl;
 123         unsigned long batman_seqno_reset;
 124         atomic_t refcount;
 125         struct rcu_head rcu;
 126 };
 127
 128 /**
 129  * struct batadv_frag_table_entry - head in the fragment buffer table
 130  * @head: head of list with fragments
 131  * @lock: lock to protect the list of fragments
 132  * @timestamp: time (jiffie) of last received fragment
 133  * @seqno: sequence number of the fragments in the list
 134  * @size: accumulated size of packets in list
 135  */
 136 struct batadv_frag_table_entry {
 137         struct hlist_head head;
 138         spinlock_t lock; /* protects head */
 139         unsigned long timestamp;
 140         uint16_t seqno;
 141         uint16_t size;
 142 };
 143
 144 /**
 145  * struct batadv_frag_list_entry - entry in a list of fragments
 146  * @list: list node information
 147  * @skb: fragment
 148  * @no: fragment number in the set
 149  */
 150 struct batadv_frag_list_entry {
 151         struct hlist_node list;
 152         struct sk_buff *skb;
 153         uint8_t no;
 154 };
 155
 156 /**
 157  * struct batadv_vlan_tt - VLAN specific TT attributes
 158  * @crc: CRC32 checksum of the entries belonging to this vlan
 159  * @num_entries: number of TT entries for this VLAN
 160  */
 161 struct batadv_vlan_tt {
 162         uint32_t crc;
 163         atomic_t num_entries;
 164 };
 165
 166 /**
 167  * struct batadv_orig_node_vlan - VLAN specific data per orig_node
 168  * @vid: the VLAN identifier
 169  * @tt: VLAN specific TT attributes
 170  * @list: list node for orig_node::vlan_list
 171  * @refcount: number of context where this object is currently in use
 172  * @rcu: struct used for freeing in a RCU-safe manner
 173  */
 174 struct batadv_orig_node_vlan {
 175         unsigned short vid;
 176         struct batadv_vlan_tt tt;
 177         struct list_head list;
 178         atomic_t refcount;
 179         struct rcu_head rcu;
 180 };
 181
 182 /**
 183  * struct batadv_orig_bat_iv - B.A.T.M.A.N. IV private orig_node members
 184  * @bcast_own: bitfield containing the number of our OGMs this orig_node
 185  *  rebroadcasted "back" to us (relative to last_real_seqno)
 186  * @bcast_own_sum: counted result of bcast_own
 187  * @ogm_cnt_lock: lock protecting bcast_own, bcast_own_sum,
 188  *  neigh_node->bat_iv.real_bits & neigh_node->bat_iv.real_packet_count
 189  */
 190 struct batadv_orig_bat_iv {
 191         unsigned long *bcast_own;
 192         uint8_t *bcast_own_sum;
 193         /* ogm_cnt_lock protects: bcast_own, bcast_own_sum,
 194          * neigh_node->bat_iv.real_bits & neigh_node->bat_iv.real_packet_count
 195          */
 196         spinlock_t ogm_cnt_lock;
 197 };
 198
 199 /**
 200  * struct batadv_orig_node - structure for orig_list maintaining nodes of mesh
 201  * @orig: originator ethernet address
 202  * @primary_addr: hosts primary interface address
 203  * @ifinfo_list: list for routers per outgoing interface
 204  * @last_bonding_candidate: pointer to last ifinfo of last used router
 205  * @batadv_dat_addr_t:  address of the orig node in the distributed hash
 206  * @last_seen: time when last packet from this node was received
 207  * @bcast_seqno_reset: time when the broadcast seqno window was reset
 208  * @mcast_flags: multicast flags announced by the orig node
 209  * @mcast_want_all_unsnoop_node: a list node for the
 210  *  mcast.want_all_unsnoopables list
 211  * @mcast_want_all_ipv4_node: a list node for the mcast.want_all_ipv4 list
 212  * @mcast_want_all_ipv6_node: a list node for the mcast.want_all_ipv6 list
 213  * @capabilities: announced capabilities of this originator
 214  * @capa_initialized: bitfield to remember whether a capability was initialized
 215  * @last_ttvn: last seen translation table version number
 216  * @tt_buff: last tt changeset this node received from the orig node
 217  * @tt_buff_len: length of the last tt changeset this node received from the
 218  *  orig node
 219  * @tt_buff_lock: lock that protects tt_buff and tt_buff_len
 220  * @tt_lock: prevents from updating the table while reading it. Table update is
 221  *  made up by two operations (data structure update and metdata -CRC/TTVN-
 222  *  recalculation) and they have to be executed atomically in order to avoid
 223  *  another thread to read the table/metadata between those.
 224  * @bcast_bits: bitfield containing the info which payload broadcast originated
 225  *  from this orig node this host already has seen (relative to
 226  *  last_bcast_seqno)
 227  * @last_bcast_seqno: last broadcast sequence number received by this host
 228  * @neigh_list: list of potential next hop neighbor towards this orig node
 229  * @neigh_list_lock: lock protecting neigh_list and router
 230  * @hash_entry: hlist node for batadv_priv::orig_hash
 231  * @bat_priv: pointer to soft_iface this orig node belongs to
 232  * @bcast_seqno_lock: lock protecting bcast_bits & last_bcast_seqno
 233  * @refcount: number of contexts the object is used
 234  * @rcu: struct used for freeing in an RCU-safe manner
 235  * @in_coding_list: list of nodes this orig can hear
 236  * @out_coding_list: list of nodes that can hear this orig
 237  * @in_coding_list_lock: protects in_coding_list
 238  * @out_coding_list_lock: protects out_coding_list
 239  * @fragments: array with heads for fragment chains
 240  * @vlan_list: a list of orig_node_vlan structs, one per VLAN served by the
 241  *  originator represented by this object
 242  * @vlan_list_lock: lock protecting vlan_list
 243  * @bat_iv: B.A.T.M.A.N. IV private structure
 244  */
 245 struct batadv_orig_node {
 246         uint8_t orig[ETH_ALEN];
 247         uint8_t primary_addr[ETH_ALEN];
 248         struct hlist_head ifinfo_list;
 249         struct batadv_orig_ifinfo *last_bonding_candidate;
 250 #ifdef CONFIG_BATMAN_ADV_DAT
 251         batadv_dat_addr_t dat_addr;
 252 #endif
 253         unsigned long last_seen;
 254         unsigned long bcast_seqno_reset;
 255 #ifdef CONFIG_BATMAN_ADV_MCAST
 256         uint8_t mcast_flags;
 257         struct hlist_node mcast_want_all_unsnoopables_node;
 258         struct hlist_node mcast_want_all_ipv4_node;
 259         struct hlist_node mcast_want_all_ipv6_node;
 260 #endif
 261         uint8_t capabilities;
 262         uint8_t capa_initialized;
 263         atomic_t last_ttvn;
 264         unsigned char *tt_buff;
 265         int16_t tt_buff_len;
 266         spinlock_t tt_buff_lock; /* protects tt_buff & tt_buff_len */
 267         /* prevents from changing the table while reading it */
 268         spinlock_t tt_lock;
 269         DECLARE_BITMAP(bcast_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
 270         uint32_t last_bcast_seqno;
 271         struct hlist_head neigh_list;
 272         /* neigh_list_lock protects: neigh_list and router */
 273         spinlock_t neigh_list_lock;
 274         struct hlist_node hash_entry;
 275         struct batadv_priv *bat_priv;
 276         /* bcast_seqno_lock protects: bcast_bits & last_bcast_seqno */
 277         spinlock_t bcast_seqno_lock;
 278         atomic_t refcount;
 279         struct rcu_head rcu;
 280 #ifdef CONFIG_BATMAN_ADV_NC
 281         struct list_head in_coding_list;
 282         struct list_head out_coding_list;
 283         spinlock_t in_coding_list_lock; /* Protects in_coding_list */
 284         spinlock_t out_coding_list_lock; /* Protects out_coding_list */
 285 #endif
 286         struct batadv_frag_table_entry fragments[BATADV_FRAG_BUFFER_COUNT];
 287         struct list_head vlan_list;
 288         spinlock_t vlan_list_lock; /* protects vlan_list */
 289         struct batadv_orig_bat_iv bat_iv;
 290 };
 291
 292 /**
 293  * enum batadv_orig_capabilities - orig node capabilities
 294  * @BATADV_ORIG_CAPA_HAS_DAT: orig node has distributed arp table enabled
 295  * @BATADV_ORIG_CAPA_HAS_NC: orig node has network coding enabled
 296  * @BATADV_ORIG_CAPA_HAS_TT: orig node has tt capability
 297  * @BATADV_ORIG_CAPA_HAS_MCAST: orig node has some multicast capability
 298  *  (= orig node announces a tvlv of type BATADV_TVLV_MCAST)
 299  */
 300 enum batadv_orig_capabilities {
 301         BATADV_ORIG_CAPA_HAS_DAT = BIT(0),
 302         BATADV_ORIG_CAPA_HAS_NC = BIT(1),
 303         BATADV_ORIG_CAPA_HAS_TT = BIT(2),
 304         BATADV_ORIG_CAPA_HAS_MCAST = BIT(3),
 305 };
 306
 307 /**
 308  * struct batadv_gw_node - structure for orig nodes announcing gw capabilities
 309  * @list: list node for batadv_priv_gw::list
 310  * @orig_node: pointer to corresponding orig node
 311  * @bandwidth_down: advertised uplink download bandwidth
 312  * @bandwidth_up: advertised uplink upload bandwidth
 313  * @deleted: this struct is scheduled for deletion
 314  * @refcount: number of contexts the object is used
 315  * @rcu: struct used for freeing in an RCU-safe manner
 316  */
 317 struct batadv_gw_node {
 318         struct hlist_node list;
 319         struct batadv_orig_node *orig_node;
 320         uint32_t bandwidth_down;
 321         uint32_t bandwidth_up;
 322         unsigned long deleted;
 323         atomic_t refcount;
 324         struct rcu_head rcu;
 325 };
 326
 327 /**
 328  * struct batadv_neigh_node - structure for single hops neighbors
 329  * @list: list node for batadv_orig_node::neigh_list
 330  * @orig_node: pointer to corresponding orig_node
 331  * @addr: the MAC address of the neighboring interface
 332  * @ifinfo_list: list for routing metrics per outgoing interface
 333  * @ifinfo_lock: lock protecting private ifinfo members and list
 334  * @if_incoming: pointer to incoming hard interface
 335  * @last_seen: when last packet via this neighbor was received
 336  * @last_ttl: last received ttl from this neigh node
 337  * @rcu: struct used for freeing in an RCU-safe manner
 338  * @bat_iv: B.A.T.M.A.N. IV private structure
 339  */
 340 struct batadv_neigh_node {
 341         struct hlist_node list;
 342         struct batadv_orig_node *orig_node;
 343         uint8_t addr[ETH_ALEN];
 344         struct hlist_head ifinfo_list;
 345         spinlock_t ifinfo_lock; /* protects ifinfo_list and its members */
 346         struct batadv_hard_iface *if_incoming;
 347         unsigned long last_seen;
 348         atomic_t refcount;
 349         struct rcu_head rcu;
 350 };
 351
 352 /**
 353  * struct batadv_neigh_ifinfo_bat_iv - neighbor information per outgoing
 354  *  interface for BATMAN IV
 355  * @tq_recv: ring buffer of received TQ values from this neigh node
 356  * @tq_index: ring buffer index
 357  * @tq_avg: averaged tq of all tq values in the ring buffer (tq_recv)
 358  * @real_bits: bitfield containing the number of OGMs received from this neigh
 359  *  node (relative to orig_node->last_real_seqno)
 360  * @real_packet_count: counted result of real_bits
 361  */
 362 struct batadv_neigh_ifinfo_bat_iv {
 363         uint8_t tq_recv[BATADV_TQ_GLOBAL_WINDOW_SIZE];
 364         uint8_t tq_index;
 365         uint8_t tq_avg;
 366         DECLARE_BITMAP(real_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
 367         uint8_t real_packet_count;
 368 };
 369
 370 /**
 371  * struct batadv_neigh_ifinfo - neighbor information per outgoing interface
 372  * @list: list node for batadv_neigh_node::ifinfo_list
 373  * @if_outgoing: pointer to outgoing hard interface
 374  * @bat_iv: B.A.T.M.A.N. IV private structure
 375  * @last_ttl: last received ttl from this neigh node
 376  * @refcount: number of contexts the object is used
 377  * @rcu: struct used for freeing in a RCU-safe manner
 378  */
 379 struct batadv_neigh_ifinfo {
 380         struct hlist_node list;
 381         struct batadv_hard_iface *if_outgoing;
 382         struct batadv_neigh_ifinfo_bat_iv bat_iv;
 383         uint8_t last_ttl;
 384         atomic_t refcount;
 385         struct rcu_head rcu;
 386 };
 387
 388 /**
 389  * struct batadv_bcast_duplist_entry - structure for LAN broadcast suppression
 390  * @orig[ETH_ALEN]: mac address of orig node orginating the broadcast
 391  * @crc: crc32 checksum of broadcast payload
 392  * @entrytime: time when the broadcast packet was received
 393  */
 394 #ifdef CONFIG_BATMAN_ADV_BLA
 395 struct batadv_bcast_duplist_entry {
 396         uint8_t orig[ETH_ALEN];
 397         __be32 crc;
 398         unsigned long entrytime;
 399 };
 400 #endif
 401
 402 /**
 403  * enum batadv_counters - indices for traffic counters
 404  * @BATADV_CNT_TX: transmitted payload traffic packet counter
 405  * @BATADV_CNT_TX_BYTES: transmitted payload traffic bytes counter
 406  * @BATADV_CNT_TX_DROPPED: dropped transmission payload traffic packet counter
 407  * @BATADV_CNT_RX: received payload traffic packet counter
 408  * @BATADV_CNT_RX_BYTES: received payload traffic bytes counter
 409  * @BATADV_CNT_FORWARD: forwarded payload traffic packet counter
 410  * @BATADV_CNT_FORWARD_BYTES: forwarded payload traffic bytes counter
 411  * @BATADV_CNT_MGMT_TX: transmitted routing protocol traffic packet counter
 412  * @BATADV_CNT_MGMT_TX_BYTES: transmitted routing protocol traffic bytes counter
 413  * @BATADV_CNT_MGMT_RX: received routing protocol traffic packet counter
 414  * @BATADV_CNT_MGMT_RX_BYTES: received routing protocol traffic bytes counter
 415  * @BATADV_CNT_FRAG_TX: transmitted fragment traffic packet counter
 416  * @BATADV_CNT_FRAG_TX_BYTES: transmitted fragment traffic bytes counter
 417  * @BATADV_CNT_FRAG_RX: received fragment traffic packet counter
 418  * @BATADV_CNT_FRAG_RX_BYTES: received fragment traffic bytes counter
 419  * @BATADV_CNT_FRAG_FWD: forwarded fragment traffic packet counter
 420  * @BATADV_CNT_FRAG_FWD_BYTES: forwarded fragment traffic bytes counter
 421  * @BATADV_CNT_TT_REQUEST_TX: transmitted tt req traffic packet counter
 422  * @BATADV_CNT_TT_REQUEST_RX: received tt req traffic packet counter
 423  * @BATADV_CNT_TT_RESPONSE_TX: transmitted tt resp traffic packet counter
 424  * @BATADV_CNT_TT_RESPONSE_RX: received tt resp traffic packet counter
 425  * @BATADV_CNT_TT_ROAM_ADV_TX: transmitted tt roam traffic packet counter
 426  * @BATADV_CNT_TT_ROAM_ADV_RX: received tt roam traffic packet counter
 427  * @BATADV_CNT_DAT_GET_TX: transmitted dht GET traffic packet counter
 428  * @BATADV_CNT_DAT_GET_RX: received dht GET traffic packet counter
 429  * @BATADV_CNT_DAT_PUT_TX: transmitted dht PUT traffic packet counter
 430  * @BATADV_CNT_DAT_PUT_RX: received dht PUT traffic packet counter
 431  * @BATADV_CNT_DAT_CACHED_REPLY_TX: transmitted dat cache reply traffic packet
 432  *  counter
 433  * @BATADV_CNT_NC_CODE: transmitted nc-combined traffic packet counter
 434  * @BATADV_CNT_NC_CODE_BYTES: transmitted nc-combined traffic bytes counter
 435  * @BATADV_CNT_NC_RECODE: transmitted nc-recombined traffic packet counter
 436  * @BATADV_CNT_NC_RECODE_BYTES: transmitted nc-recombined traffic bytes counter
 437  * @BATADV_CNT_NC_BUFFER: counter for packets buffered for later nc decoding
 438  * @BATADV_CNT_NC_DECODE: received and nc-decoded traffic packet counter
 439  * @BATADV_CNT_NC_DECODE_BYTES: received and nc-decoded traffic bytes counter
 440  * @BATADV_CNT_NC_DECODE_FAILED: received and decode-failed traffic packet
 441  *  counter
 442  * @BATADV_CNT_NC_SNIFFED: counter for nc-decoded packets received in promisc
 443  *  mode.
 444  * @BATADV_CNT_NUM: number of traffic counters
 445  */
 446 enum batadv_counters {
 447         BATADV_CNT_TX,
 448         BATADV_CNT_TX_BYTES,
 449         BATADV_CNT_TX_DROPPED,
 450         BATADV_CNT_RX,
 451         BATADV_CNT_RX_BYTES,
 452         BATADV_CNT_FORWARD,
 453         BATADV_CNT_FORWARD_BYTES,
 454         BATADV_CNT_MGMT_TX,
 455         BATADV_CNT_MGMT_TX_BYTES,
 456         BATADV_CNT_MGMT_RX,
 457         BATADV_CNT_MGMT_RX_BYTES,
 458         BATADV_CNT_FRAG_TX,
 459         BATADV_CNT_FRAG_TX_BYTES,
 460         BATADV_CNT_FRAG_RX,
 461         BATADV_CNT_FRAG_RX_BYTES,
 462         BATADV_CNT_FRAG_FWD,
 463         BATADV_CNT_FRAG_FWD_BYTES,
 464         BATADV_CNT_TT_REQUEST_TX,
 465         BATADV_CNT_TT_REQUEST_RX,
 466         BATADV_CNT_TT_RESPONSE_TX,
 467         BATADV_CNT_TT_RESPONSE_RX,
 468         BATADV_CNT_TT_ROAM_ADV_TX,
 469         BATADV_CNT_TT_ROAM_ADV_RX,
 470 #ifdef CONFIG_BATMAN_ADV_DAT
 471         BATADV_CNT_DAT_GET_TX,
 472         BATADV_CNT_DAT_GET_RX,
 473         BATADV_CNT_DAT_PUT_TX,
 474         BATADV_CNT_DAT_PUT_RX,
 475         BATADV_CNT_DAT_CACHED_REPLY_TX,
 476 #endif
 477 #ifdef CONFIG_BATMAN_ADV_NC
 478         BATADV_CNT_NC_CODE,
 479         BATADV_CNT_NC_CODE_BYTES,
 480         BATADV_CNT_NC_RECODE,
 481         BATADV_CNT_NC_RECODE_BYTES,
 482         BATADV_CNT_NC_BUFFER,
 483         BATADV_CNT_NC_DECODE,
 484         BATADV_CNT_NC_DECODE_BYTES,
 485         BATADV_CNT_NC_DECODE_FAILED,
 486         BATADV_CNT_NC_SNIFFED,
 487 #endif
 488         BATADV_CNT_NUM,
 489 };
 490
 491 /**
 492  * struct batadv_priv_tt - per mesh interface translation table data
 493  * @vn: translation table version number
 494  * @ogm_append_cnt: counter of number of OGMs containing the local tt diff
 495  * @local_changes: changes registered in an originator interval
 496  * @changes_list: tracks tt local changes within an originator interval
 497  * @local_hash: local translation table hash table
 498  * @global_hash: global translation table hash table
 499  * @req_list: list of pending & unanswered tt_requests
 500  * @roam_list: list of the last roaming events of each client limiting the
 501  *  number of roaming events to avoid route flapping
 502  * @changes_list_lock: lock protecting changes_list
 503  * @req_list_lock: lock protecting req_list
 504  * @roam_list_lock: lock protecting roam_list
 505  * @last_changeset: last tt changeset this host has generated
 506  * @last_changeset_len: length of last tt changeset this host has generated
 507  * @last_changeset_lock: lock protecting last_changeset & last_changeset_len
 508  * @commit_lock: prevents from executing a local TT commit while reading the
 509  *  local table. The local TT commit is made up by two operations (data
 510  *  structure update and metdata -CRC/TTVN- recalculation) and they have to be
 511  *  executed atomically in order to avoid another thread to read the
 512  *  table/metadata between those.
 513  * @work: work queue callback item for translation table purging
 514  */
 515 struct batadv_priv_tt {
 516         atomic_t vn;
 517         atomic_t ogm_append_cnt;
 518         atomic_t local_changes;
 519         struct list_head changes_list;
 520         struct batadv_hashtable *local_hash;
 521         struct batadv_hashtable *global_hash;
 522         struct list_head req_list;
 523         struct list_head roam_list;
 524         spinlock_t changes_list_lock; /* protects changes */
 525         spinlock_t req_list_lock; /* protects req_list */
 526         spinlock_t roam_list_lock; /* protects roam_list */
 527         unsigned char *last_changeset;
 528         int16_t last_changeset_len;
 529         /* protects last_changeset & last_changeset_len */
 530         spinlock_t last_changeset_lock;
 531         /* prevents from executing a commit while reading the table */
 532         spinlock_t commit_lock;
 533         struct delayed_work work;
 534 };
 535
 536 /**
 537  * struct batadv_priv_bla - per mesh interface bridge loope avoidance data
 538  * @num_requests; number of bla requests in flight
 539  * @claim_hash: hash table containing mesh nodes this host has claimed
 540  * @backbone_hash: hash table containing all detected backbone gateways
 541  * @bcast_duplist: recently received broadcast packets array (for broadcast
 542  *  duplicate suppression)
 543  * @bcast_duplist_curr: index of last broadcast packet added to bcast_duplist
 544  * @bcast_duplist_lock: lock protecting bcast_duplist & bcast_duplist_curr
 545  * @claim_dest: local claim data (e.g. claim group)
 546  * @work: work queue callback item for cleanups & bla announcements
 547  */
 548 #ifdef CONFIG_BATMAN_ADV_BLA
 549 struct batadv_priv_bla {
 550         atomic_t num_requests;
 551         struct batadv_hashtable *claim_hash;
 552         struct batadv_hashtable *backbone_hash;
 553         struct batadv_bcast_duplist_entry bcast_duplist[BATADV_DUPLIST_SIZE];
 554         int bcast_duplist_curr;
 555         /* protects bcast_duplist & bcast_duplist_curr */
 556         spinlock_t bcast_duplist_lock;
 557         struct batadv_bla_claim_dst claim_dest;
 558         struct delayed_work work;
 559 };
 560 #endif
 561
 562 /**
 563  * struct batadv_priv_debug_log - debug logging data
 564  * @log_buff: buffer holding the logs (ring bufer)
 565  * @log_start: index of next character to read
 566  * @log_end: index of next character to write
 567  * @lock: lock protecting log_buff, log_start & log_end
 568  * @queue_wait: log reader's wait queue
 569  */
 570 #ifdef CONFIG_BATMAN_ADV_DEBUG
 571 struct batadv_priv_debug_log {
 572         char log_buff[BATADV_LOG_BUF_LEN];
 573         unsigned long log_start;
 574         unsigned long log_end;
 575         spinlock_t lock; /* protects log_buff, log_start and log_end */
 576         wait_queue_head_t queue_wait;
 577 };
 578 #endif
 579
 580 /**
 581  * struct batadv_priv_gw - per mesh interface gateway data
 582  * @list: list of available gateway nodes
 583  * @list_lock: lock protecting gw_list & curr_gw
 584  * @curr_gw: pointer to currently selected gateway node
 585  * @bandwidth_down: advertised uplink download bandwidth (if gw_mode server)
 586  * @bandwidth_up: advertised uplink upload bandwidth (if gw_mode server)
 587  * @reselect: bool indicating a gateway re-selection is in progress
 588  */
 589 struct batadv_priv_gw {
 590         struct hlist_head list;
 591         spinlock_t list_lock; /* protects gw_list & curr_gw */
 592         struct batadv_gw_node __rcu *curr_gw;  /* rcu protected pointer */
 593         atomic_t bandwidth_down;
 594         atomic_t bandwidth_up;
 595         atomic_t reselect;
 596 };
 597
 598 /**
 599  * struct batadv_priv_tvlv - per mesh interface tvlv data
 600  * @container_list: list of registered tvlv containers to be sent with each OGM
 601  * @handler_list: list of the various tvlv content handlers
 602  * @container_list_lock: protects tvlv container list access
 603  * @handler_list_lock: protects handler list access
 604  */
 605 struct batadv_priv_tvlv {
 606         struct hlist_head container_list;
 607         struct hlist_head handler_list;
 608         spinlock_t container_list_lock; /* protects container_list */
 609         spinlock_t handler_list_lock; /* protects handler_list */
 610 };
 611
 612 /**
 613  * struct batadv_priv_dat - per mesh interface DAT private data
 614  * @addr: node DAT address
 615  * @hash: hashtable representing the local ARP cache
 616  * @work: work queue callback item for cache purging
 617  */
 618 #ifdef CONFIG_BATMAN_ADV_DAT
 619 struct batadv_priv_dat {
 620         batadv_dat_addr_t addr;
 621         struct batadv_hashtable *hash;
 622         struct delayed_work work;
 623 };
 624 #endif
 625
 626 #ifdef CONFIG_BATMAN_ADV_MCAST
 627 /**
 628  * struct batadv_priv_mcast - per mesh interface mcast data
 629  * @mla_list: list of multicast addresses we are currently announcing via TT
 630  * @want_all_unsnoopables_list: a list of orig_nodes wanting all unsnoopable
 631  *  multicast traffic
 632  * @want_all_ipv4_list: a list of orig_nodes wanting all IPv4 multicast traffic
 633  * @want_all_ipv6_list: a list of orig_nodes wanting all IPv6 multicast traffic
 634  * @flags: the flags we have last sent in our mcast tvlv
 635  * @enabled: whether the multicast tvlv is currently enabled
 636  * @num_disabled: number of nodes that have no mcast tvlv
 637  * @num_want_all_unsnoopables: number of nodes wanting unsnoopable IP traffic
 638  * @num_want_all_ipv4: counter for items in want_all_ipv4_list
 639  * @num_want_all_ipv6: counter for items in want_all_ipv6_list
 640  * @want_lists_lock: lock for protecting modifications to mcast want lists
 641  *  (traversals are rcu-locked)
 642  */
 643 struct batadv_priv_mcast {
 644         struct hlist_head mla_list;
 645         struct hlist_head want_all_unsnoopables_list;
 646         struct hlist_head want_all_ipv4_list;
 647         struct hlist_head want_all_ipv6_list;
 648         uint8_t flags;
 649         bool enabled;
 650         atomic_t num_disabled;
 651         atomic_t num_want_all_unsnoopables;
 652         atomic_t num_want_all_ipv4;
 653         atomic_t num_want_all_ipv6;
 654         /* protects want_all_{unsnoopables,ipv4,ipv6}_list */
 655         spinlock_t want_lists_lock;
 656 };
 657 #endif
 658
 659 /**
 660  * struct batadv_priv_nc - per mesh interface network coding private data
 661  * @work: work queue callback item for cleanup
 662  * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
 663  * @min_tq: only consider neighbors for encoding if neigh_tq > min_tq
 664  * @max_fwd_delay: maximum packet forward delay to allow coding of packets
 665  * @max_buffer_time: buffer time for sniffed packets used to decoding
 666  * @timestamp_fwd_flush: timestamp of last forward packet queue flush
 667  * @timestamp_sniffed_purge: timestamp of last sniffed packet queue purge
 668  * @coding_hash: Hash table used to buffer skbs while waiting for another
 669  *  incoming skb to code it with. Skbs are added to the buffer just before being
 670  *  forwarded in routing.c
 671  * @decoding_hash: Hash table used to buffer skbs that might be needed to decode
 672  *  a received coded skb. The buffer is used for 1) skbs arriving on the
 673  *  soft-interface; 2) skbs overheard on the hard-interface; and 3) skbs
 674  *  forwarded by batman-adv.
 675  */
 676 struct batadv_priv_nc {
 677         struct delayed_work work;
 678         struct dentry *debug_dir;
 679         u8 min_tq;
 680         u32 max_fwd_delay;
 681         u32 max_buffer_time;
 682         unsigned long timestamp_fwd_flush;
 683         unsigned long timestamp_sniffed_purge;
 684         struct batadv_hashtable *coding_hash;
 685         struct batadv_hashtable *decoding_hash;
 686 };
 687
 688 /**
 689  * struct batadv_softif_vlan - per VLAN attributes set
 690  * @bat_priv: pointer to the mesh object
 691  * @vid: VLAN identifier
 692  * @kobj: kobject for sysfs vlan subdirectory
 693  * @ap_isolation: AP isolation state
 694  * @tt: TT private attributes (VLAN specific)
 695  * @list: list node for bat_priv::softif_vlan_list
 696  * @refcount: number of context where this object is currently in use
 697  * @rcu: struct used for freeing in a RCU-safe manner
 698  */
 699 struct batadv_softif_vlan {
 700         struct batadv_priv *bat_priv;
 701         unsigned short vid;
 702         struct kobject *kobj;
 703         atomic_t ap_isolation;          /* boolean */
 704         struct batadv_vlan_tt tt;
 705         struct hlist_node list;
 706         atomic_t refcount;
 707         struct rcu_head rcu;
 708 };
 709
 710 /**
 711  * struct batadv_priv - per mesh interface data
 712  * @mesh_state: current status of the mesh (inactive/active/deactivating)
 713  * @soft_iface: net device which holds this struct as private data
 714  * @stats: structure holding the data for the ndo_get_stats() call
 715  * @bat_counters: mesh internal traffic statistic counters (see batadv_counters)
 716  * @aggregated_ogms: bool indicating whether OGM aggregation is enabled
 717  * @bonding: bool indicating whether traffic bonding is enabled
 718  * @fragmentation: bool indicating whether traffic fragmentation is enabled
 719  * @packet_size_max: max packet size that can be transmitted via
 720  *  multiple fragmented skbs or a single frame if fragmentation is disabled
 721  * @frag_seqno: incremental counter to identify chains of egress fragments
 722  * @bridge_loop_avoidance: bool indicating whether bridge loop avoidance is
 723  *  enabled
 724  * @distributed_arp_table: bool indicating whether distributed ARP table is
 725  *  enabled
 726  * @multicast_mode: Enable or disable multicast optimizations on this node's
 727  *  sender/originating side
 728  * @gw_mode: gateway operation: off, client or server (see batadv_gw_modes)
 729  * @gw_sel_class: gateway selection class (applies if gw_mode client)
 730  * @orig_interval: OGM broadcast interval in milliseconds
 731  * @hop_penalty: penalty which will be applied to an OGM's tq-field on every hop
 732  * @log_level: configured log level (see batadv_dbg_level)
 733  * @bcast_seqno: last sent broadcast packet sequence number
 734  * @bcast_queue_left: number of remaining buffered broadcast packet slots
 735  * @batman_queue_left: number of remaining OGM packet slots
 736  * @num_ifaces: number of interfaces assigned to this mesh interface
 737  * @mesh_obj: kobject for sysfs mesh subdirectory
 738  * @debug_dir: dentry for debugfs batman-adv subdirectory
 739  * @forw_bat_list: list of aggregated OGMs that will be forwarded
 740  * @forw_bcast_list: list of broadcast packets that will be rebroadcasted
 741  * @orig_hash: hash table containing mesh participants (orig nodes)
 742  * @forw_bat_list_lock: lock protecting forw_bat_list
 743  * @forw_bcast_list_lock: lock protecting forw_bcast_list
 744  * @orig_work: work queue callback item for orig node purging
 745  * @cleanup_work: work queue callback item for soft interface deinit
 746  * @primary_if: one of the hard interfaces assigned to this mesh interface
 747  *  becomes the primary interface
 748  * @bat_algo_ops: routing algorithm used by this mesh interface
 749  * @softif_vlan_list: a list of softif_vlan structs, one per VLAN created on top
 750  *  of the mesh interface represented by this object
 751  * @softif_vlan_list_lock: lock protecting softif_vlan_list
 752  * @bla: bridge loope avoidance data
 753  * @debug_log: holding debug logging relevant data
 754  * @gw: gateway data
 755  * @tt: translation table data
 756  * @tvlv: type-version-length-value data
 757  * @dat: distributed arp table data
 758  * @mcast: multicast data
 759  * @network_coding: bool indicating whether network coding is enabled
 760  * @batadv_priv_nc: network coding data
 761  */
 762 struct batadv_priv {
 763         atomic_t mesh_state;
 764         struct net_device *soft_iface;
 765         struct net_device_stats stats;
 766         uint64_t __percpu *bat_counters; /* Per cpu counters */
 767         atomic_t aggregated_ogms;
 768         atomic_t bonding;
 769         atomic_t fragmentation;
 770         atomic_t packet_size_max;
 771         atomic_t frag_seqno;
 772 #ifdef CONFIG_BATMAN_ADV_BLA
 773         atomic_t bridge_loop_avoidance;
 774 #endif
 775 #ifdef CONFIG_BATMAN_ADV_DAT
 776         atomic_t distributed_arp_table;
 777 #endif
 778 #ifdef CONFIG_BATMAN_ADV_MCAST
 779         atomic_t multicast_mode;
 780 #endif
 781         atomic_t gw_mode;
 782         atomic_t gw_sel_class;
 783         atomic_t orig_interval;
 784         atomic_t hop_penalty;
 785 #ifdef CONFIG_BATMAN_ADV_DEBUG
 786         atomic_t log_level;
 787 #endif
 788         uint32_t isolation_mark;
 789         uint32_t isolation_mark_mask;
 790         atomic_t bcast_seqno;
 791         atomic_t bcast_queue_left;
 792         atomic_t batman_queue_left;
 793         char num_ifaces;
 794         struct kobject *mesh_obj;
 795         struct dentry *debug_dir;
 796         struct hlist_head forw_bat_list;
 797         struct hlist_head forw_bcast_list;
 798         struct batadv_hashtable *orig_hash;
 799         spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
 800         spinlock_t forw_bcast_list_lock; /* protects forw_bcast_list */
 801         struct delayed_work orig_work;
 802         struct work_struct cleanup_work;
 803         struct batadv_hard_iface __rcu *primary_if;  /* rcu protected pointer */
 804         struct batadv_algo_ops *bat_algo_ops;
 805         struct hlist_head softif_vlan_list;
 806         spinlock_t softif_vlan_list_lock; /* protects softif_vlan_list */
 807 #ifdef CONFIG_BATMAN_ADV_BLA
 808         struct batadv_priv_bla bla;
 809 #endif
 810 #ifdef CONFIG_BATMAN_ADV_DEBUG
 811         struct batadv_priv_debug_log *debug_log;
 812 #endif
 813         struct batadv_priv_gw gw;
 814         struct batadv_priv_tt tt;
 815         struct batadv_priv_tvlv tvlv;
 816 #ifdef CONFIG_BATMAN_ADV_DAT
 817         struct batadv_priv_dat dat;
 818 #endif
 819 #ifdef CONFIG_BATMAN_ADV_MCAST
 820         struct batadv_priv_mcast mcast;
 821 #endif
 822 #ifdef CONFIG_BATMAN_ADV_NC
 823         atomic_t network_coding;
 824         struct batadv_priv_nc nc;
 825 #endif /* CONFIG_BATMAN_ADV_NC */
 826 };
 827
 828 /**
 829  * struct batadv_socket_client - layer2 icmp socket client data
 830  * @queue_list: packet queue for packets destined for this socket client
 831  * @queue_len: number of packets in the packet queue (queue_list)
 832  * @index: socket client's index in the batadv_socket_client_hash
 833  * @lock: lock protecting queue_list, queue_len & index
 834  * @queue_wait: socket client's wait queue
 835  * @bat_priv: pointer to soft_iface this client belongs to
 836  */
 837 struct batadv_socket_client {
 838         struct list_head queue_list;
 839         unsigned int queue_len;
 840         unsigned char index;
 841         spinlock_t lock; /* protects queue_list, queue_len & index */
 842         wait_queue_head_t queue_wait;
 843         struct batadv_priv *bat_priv;
 844 };
 845
 846 /**
 847  * struct batadv_socket_packet - layer2 icmp packet for socket client
 848  * @list: list node for batadv_socket_client::queue_list
 849  * @icmp_len: size of the layer2 icmp packet
 850  * @icmp_packet: layer2 icmp packet
 851  */
 852 struct batadv_socket_packet {
 853         struct list_head list;
 854         size_t icmp_len;
 855         uint8_t icmp_packet[BATADV_ICMP_MAX_PACKET_SIZE];
 856 };
 857
 858 /**
 859  * struct batadv_bla_backbone_gw - batman-adv gateway bridged into the LAN
 860  * @orig: originator address of backbone node (mac address of primary iface)
 861  * @vid: vlan id this gateway was detected on
 862  * @hash_entry: hlist node for batadv_priv_bla::backbone_hash
 863  * @bat_priv: pointer to soft_iface this backbone gateway belongs to
 864  * @lasttime: last time we heard of this backbone gw
 865  * @wait_periods: grace time for bridge forward delays and bla group forming at
 866  *  bootup phase - no bcast traffic is formwared until it has elapsed
 867  * @request_sent: if this bool is set to true we are out of sync with this
 868  *  backbone gateway - no bcast traffic is formwared until the situation was
 869  *  resolved
 870  * @crc: crc16 checksum over all claims
 871  * @refcount: number of contexts the object is used
 872  * @rcu: struct used for freeing in an RCU-safe manner
 873  */
 874 #ifdef CONFIG_BATMAN_ADV_BLA
 875 struct batadv_bla_backbone_gw {
 876         uint8_t orig[ETH_ALEN];
 877         unsigned short vid;
 878         struct hlist_node hash_entry;
 879         struct batadv_priv *bat_priv;
 880         unsigned long lasttime;
 881         atomic_t wait_periods;
 882         atomic_t request_sent;
 883         uint16_t crc;
 884         atomic_t refcount;
 885         struct rcu_head rcu;
 886 };
 887
 888 /**
 889  * struct batadv_bla_claim - claimed non-mesh client structure
 890  * @addr: mac address of claimed non-mesh client
 891  * @vid: vlan id this client was detected on
 892  * @batadv_bla_backbone_gw: pointer to backbone gw claiming this client
 893  * @lasttime: last time we heard of claim (locals only)
 894  * @hash_entry: hlist node for batadv_priv_bla::claim_hash
 895  * @refcount: number of contexts the object is used
 896  * @rcu: struct used for freeing in an RCU-safe manner
 897  */
 898 struct batadv_bla_claim {
 899         uint8_t addr[ETH_ALEN];
 900         unsigned short vid;
 901         struct batadv_bla_backbone_gw *backbone_gw;
 902         unsigned long lasttime;
 903         struct hlist_node hash_entry;
 904         struct rcu_head rcu;
 905         atomic_t refcount;
 906 };
 907 #endif
 908
 909 /**
 910  * struct batadv_tt_common_entry - tt local & tt global common data
 911  * @addr: mac address of non-mesh client
 912  * @vid: VLAN identifier
 913  * @hash_entry: hlist node for batadv_priv_tt::local_hash or for
 914  *  batadv_priv_tt::global_hash
 915  * @flags: various state handling flags (see batadv_tt_client_flags)
 916  * @added_at: timestamp used for purging stale tt common entries
 917  * @refcount: number of contexts the object is used
 918  * @rcu: struct used for freeing in an RCU-safe manner
 919  */
 920 struct batadv_tt_common_entry {
 921         uint8_t addr[ETH_ALEN];
 922         unsigned short vid;
 923         struct hlist_node hash_entry;
 924         uint16_t flags;
 925         unsigned long added_at;
 926         atomic_t refcount;
 927         struct rcu_head rcu;
 928 };
 929
 930 /**
 931  * struct batadv_tt_local_entry - translation table local entry data
 932  * @common: general translation table data
 933  * @last_seen: timestamp used for purging stale tt local entries
 934  */
 935 struct batadv_tt_local_entry {
 936         struct batadv_tt_common_entry common;
 937         unsigned long last_seen;
 938 };
 939
 940 /**
 941  * struct batadv_tt_global_entry - translation table global entry data
 942  * @common: general translation table data
 943  * @orig_list: list of orig nodes announcing this non-mesh client
 944  * @orig_list_count: number of items in the orig_list
 945  * @list_lock: lock protecting orig_list
 946  * @roam_at: time at which TT_GLOBAL_ROAM was set
 947  */
 948 struct batadv_tt_global_entry {
 949         struct batadv_tt_common_entry common;
 950         struct hlist_head orig_list;
 951         atomic_t orig_list_count;
 952         spinlock_t list_lock;   /* protects orig_list */
 953         unsigned long roam_at;
 954 };
 955
 956 /**
 957  * struct batadv_tt_orig_list_entry - orig node announcing a non-mesh client
 958  * @orig_node: pointer to orig node announcing this non-mesh client
 959  * @ttvn: translation table version number which added the non-mesh client
 960  * @list: list node for batadv_tt_global_entry::orig_list
 961  * @refcount: number of contexts the object is used
 962  * @rcu: struct used for freeing in an RCU-safe manner
 963  */
 964 struct batadv_tt_orig_list_entry {
 965         struct batadv_orig_node *orig_node;
 966         uint8_t ttvn;
 967         struct hlist_node list;
 968         atomic_t refcount;
 969         struct rcu_head rcu;
 970 };
 971
 972 /**
 973  * struct batadv_tt_change_node - structure for tt changes occured
 974  * @list: list node for batadv_priv_tt::changes_list
 975  * @change: holds the actual translation table diff data
 976  */
 977 struct batadv_tt_change_node {
 978         struct list_head list;
 979         struct batadv_tvlv_tt_change change;
 980 };
 981
 982 /**
 983  * struct batadv_tt_req_node - data to keep track of the tt requests in flight
 984  * @addr: mac address address of the originator this request was sent to
 985  * @issued_at: timestamp used for purging stale tt requests
 986  * @list: list node for batadv_priv_tt::req_list
 987  */
 988 struct batadv_tt_req_node {
 989         uint8_t addr[ETH_ALEN];
 990         unsigned long issued_at;
 991         struct list_head list;
 992 };
 993
 994 /**
 995  * struct batadv_tt_roam_node - roaming client data
 996  * @addr: mac address of the client in the roaming phase
 997  * @counter: number of allowed roaming events per client within a single
 998  *  OGM interval (changes are committed with each OGM)
 999  * @first_time: timestamp used for purging stale roaming node entries
1000  * @list: list node for batadv_priv_tt::roam_list
1001  */
1002 struct batadv_tt_roam_node {
1003         uint8_t addr[ETH_ALEN];
1004         atomic_t counter;
1005         unsigned long first_time;
1006         struct list_head list;
1007 };
1008
1009 /**
1010  * struct batadv_nc_node - network coding node
1011  * @list: next and prev pointer for the list handling
1012  * @addr: the node's mac address
1013  * @refcount: number of contexts the object is used by
1014  * @rcu: struct used for freeing in an RCU-safe manner
1015  * @orig_node: pointer to corresponding orig node struct
1016  * @last_seen: timestamp of last ogm received from this node
1017  */
1018 struct batadv_nc_node {
1019         struct list_head list;
1020         uint8_t addr[ETH_ALEN];
1021         atomic_t refcount;
1022         struct rcu_head rcu;
1023         struct batadv_orig_node *orig_node;
1024         unsigned long last_seen;
1025 };
1026
1027 /**
1028  * struct batadv_nc_path - network coding path
1029  * @hash_entry: next and prev pointer for the list handling
1030  * @rcu: struct used for freeing in an RCU-safe manner
1031  * @refcount: number of contexts the object is used by
1032  * @packet_list: list of buffered packets for this path
1033  * @packet_list_lock: access lock for packet list
1034  * @next_hop: next hop (destination) of path
1035  * @prev_hop: previous hop (source) of path
1036  * @last_valid: timestamp for last validation of path
1037  */
1038 struct batadv_nc_path {
1039         struct hlist_node hash_entry;
1040         struct rcu_head rcu;
1041         atomic_t refcount;
1042         struct list_head packet_list;
1043         spinlock_t packet_list_lock; /* Protects packet_list */
1044         uint8_t next_hop[ETH_ALEN];
1045         uint8_t prev_hop[ETH_ALEN];
1046         unsigned long last_valid;
1047 };
1048
1049 /**
1050  * struct batadv_nc_packet - network coding packet used when coding and
1051  *  decoding packets
1052  * @list: next and prev pointer for the list handling
1053  * @packet_id: crc32 checksum of skb data
1054  * @timestamp: field containing the info when the packet was added to path
1055  * @neigh_node: pointer to original next hop neighbor of skb
1056  * @skb: skb which can be encoded or used for decoding
1057  * @nc_path: pointer to path this nc packet is attached to
1058  */
1059 struct batadv_nc_packet {
1060         struct list_head list;
1061         __be32 packet_id;
1062         unsigned long timestamp;
1063         struct batadv_neigh_node *neigh_node;
1064         struct sk_buff *skb;
1065         struct batadv_nc_path *nc_path;
1066 };
1067
1068 /**
1069  * struct batadv_skb_cb - control buffer structure used to store private data
1070  *  relevant to batman-adv in the skb->cb buffer in skbs.
1071  * @decoded: Marks a skb as decoded, which is checked when searching for coding
1072  *  opportunities in network-coding.c
1073  */
1074 struct batadv_skb_cb {
1075         bool decoded;
1076 };
1077
1078 /**
1079  * struct batadv_forw_packet - structure for bcast packets to be sent/forwarded
1080  * @list: list node for batadv_socket_client::queue_list
1081  * @send_time: execution time for delayed_work (packet sending)
1082  * @own: bool for locally generated packets (local OGMs are re-scheduled after
1083  *  sending)
1084  * @skb: bcast packet's skb buffer
1085  * @packet_len: size of aggregated OGM packet inside the skb buffer
1086  * @direct_link_flags: direct link flags for aggregated OGM packets
1087  * @num_packets: counter for bcast packet retransmission
1088  * @delayed_work: work queue callback item for packet sending
1089  * @if_incoming: pointer to incoming hard-iface or primary iface if
1090  *  locally generated packet
1091  * @if_outgoing: packet where the packet should be sent to, or NULL if
1092  *  unspecified
1093  */
1094 struct batadv_forw_packet {
1095         struct hlist_node list;
1096         unsigned long send_time;
1097         uint8_t own;
1098         struct sk_buff *skb;
1099         uint16_t packet_len;
1100         uint32_t direct_link_flags;
1101         uint8_t num_packets;
1102         struct delayed_work delayed_work;
1103         struct batadv_hard_iface *if_incoming;
1104         struct batadv_hard_iface *if_outgoing;
1105 };
1106
1107 /**
1108  * struct batadv_algo_ops - mesh algorithm callbacks
1109  * @list: list node for the batadv_algo_list
1110  * @name: name of the algorithm
1111  * @bat_iface_enable: init routing info when hard-interface is enabled
1112  * @bat_iface_disable: de-init routing info when hard-interface is disabled
1113  * @bat_iface_update_mac: (re-)init mac addresses of the protocol information
1114  *  belonging to this hard-interface
1115  * @bat_primary_iface_set: called when primary interface is selected / changed
1116  * @bat_ogm_schedule: prepare a new outgoing OGM for the send queue
1117  * @bat_ogm_emit: send scheduled OGM
1118  * @bat_neigh_cmp: compare the metrics of two neighbors for their respective
1119  *  outgoing interfaces
1120  * @bat_neigh_is_equiv_or_better: check if neigh1 is equally good or better
1121  *  than neigh2 for their respective outgoing interface from the metric
1122  *  prospective
1123  * @bat_orig_print: print the originator table (optional)
1124  * @bat_orig_free: free the resources allocated by the routing algorithm for an
1125  *  orig_node object
1126  * @bat_orig_add_if: ask the routing algorithm to apply the needed changes to
1127  *  the orig_node due to a new hard-interface being added into the mesh
1128  * @bat_orig_del_if: ask the routing algorithm to apply the needed changes to
1129  *  the orig_node due to an hard-interface being removed from the mesh
1130  */
1131 struct batadv_algo_ops {
1132         struct hlist_node list;
1133         char *name;
1134         int (*bat_iface_enable)(struct batadv_hard_iface *hard_iface);
1135         void (*bat_iface_disable)(struct batadv_hard_iface *hard_iface);
1136         void (*bat_iface_update_mac)(struct batadv_hard_iface *hard_iface);
1137         void (*bat_primary_iface_set)(struct batadv_hard_iface *hard_iface);
1138         void (*bat_ogm_schedule)(struct batadv_hard_iface *hard_iface);
1139         void (*bat_ogm_emit)(struct batadv_forw_packet *forw_packet);
1140         int (*bat_neigh_cmp)(struct batadv_neigh_node *neigh1,
1141                              struct batadv_hard_iface *if_outgoing1,
1142                              struct batadv_neigh_node *neigh2,
1143                              struct batadv_hard_iface *if_outgoing2);
1144         bool (*bat_neigh_is_equiv_or_better)
1145                 (struct batadv_neigh_node *neigh1,
1146                  struct batadv_hard_iface *if_outgoing1,
1147                  struct batadv_neigh_node *neigh2,
1148                  struct batadv_hard_iface *if_outgoing2);
1149         /* orig_node handling API */
1150         void (*bat_orig_print)(struct batadv_priv *priv, struct seq_file *seq,
1151                                struct batadv_hard_iface *hard_iface);
1152         void (*bat_orig_free)(struct batadv_orig_node *orig_node);
1153         int (*bat_orig_add_if)(struct batadv_orig_node *orig_node,
1154                                int max_if_num);
1155         int (*bat_orig_del_if)(struct batadv_orig_node *orig_node,
1156                                int max_if_num, int del_if_num);
1157 };
1158
1159 /**
1160  * struct batadv_dat_entry - it is a single entry of batman-adv ARP backend. It
1161  * is used to stored ARP entries needed for the global DAT cache
1162  * @ip: the IPv4 corresponding to this DAT/ARP entry
1163  * @mac_addr: the MAC address associated to the stored IPv4
1164  * @vid: the vlan ID associated to this entry
1165  * @last_update: time in jiffies when this entry was refreshed last time
1166  * @hash_entry: hlist node for batadv_priv_dat::hash
1167  * @refcount: number of contexts the object is used
1168  * @rcu: struct used for freeing in an RCU-safe manner
1169  */
1170 struct batadv_dat_entry {
1171         __be32 ip;
1172         uint8_t mac_addr[ETH_ALEN];
1173         unsigned short vid;
1174         unsigned long last_update;
1175         struct hlist_node hash_entry;
1176         atomic_t refcount;
1177         struct rcu_head rcu;
1178 };
1179
1180 /**
1181  * struct batadv_hw_addr - a list entry for a MAC address
1182  * @list: list node for the linking of entries
1183  * @addr: the MAC address of this list entry
1184  */
1185 struct batadv_hw_addr {
1186         struct hlist_node list;
1187         unsigned char addr[ETH_ALEN];
1188 };
1189
1190 /**
1191  * struct batadv_dat_candidate - candidate destination for DAT operations
1192  * @type: the type of the selected candidate. It can one of the following:
1193  *        - BATADV_DAT_CANDIDATE_NOT_FOUND
1194  *        - BATADV_DAT_CANDIDATE_ORIG
1195  * @orig_node: if type is BATADV_DAT_CANDIDATE_ORIG this field points to the
1196  *             corresponding originator node structure
1197  */
1198 struct batadv_dat_candidate {
1199         int type;
1200         struct batadv_orig_node *orig_node;
1201 };
1202
1203 /**
1204  * struct batadv_tvlv_container - container for tvlv appended to OGMs
1205  * @list: hlist node for batadv_priv_tvlv::container_list
1206  * @tvlv_hdr: tvlv header information needed to construct the tvlv
1207  * @value_len: length of the buffer following this struct which contains
1208  *  the actual tvlv payload
1209  * @refcount: number of contexts the object is used
1210  */
1211 struct batadv_tvlv_container {
1212         struct hlist_node list;
1213         struct batadv_tvlv_hdr tvlv_hdr;
1214         atomic_t refcount;
1215 };
1216
1217 /**
1218  * struct batadv_tvlv_handler - handler for specific tvlv type and version
1219  * @list: hlist node for batadv_priv_tvlv::handler_list
1220  * @ogm_handler: handler callback which is given the tvlv payload to process on
1221  *  incoming OGM packets
1222  * @unicast_handler: handler callback which is given the tvlv payload to process
1223  *  on incoming unicast tvlv packets
1224  * @type: tvlv type this handler feels responsible for
1225  * @version: tvlv version this handler feels responsible for
1226  * @flags: tvlv handler flags
1227  * @refcount: number of contexts the object is used
1228  * @rcu: struct used for freeing in an RCU-safe manner
1229  */
1230 struct batadv_tvlv_handler {
1231         struct hlist_node list;
1232         void (*ogm_handler)(struct batadv_priv *bat_priv,
1233                             struct batadv_orig_node *orig,
1234                             uint8_t flags,
1235                             void *tvlv_value, uint16_t tvlv_value_len);
1236         int (*unicast_handler)(struct batadv_priv *bat_priv,
1237                                uint8_t *src, uint8_t *dst,
1238                                void *tvlv_value, uint16_t tvlv_value_len);
1239         uint8_t type;
1240         uint8_t version;
1241         uint8_t flags;
1242         atomic_t refcount;
1243         struct rcu_head rcu;
1244 };
1245
1246 /**
1247  * enum batadv_tvlv_handler_flags - tvlv handler flags definitions
1248  * @BATADV_TVLV_HANDLER_OGM_CIFNOTFND: tvlv ogm processing function will call
1249  *  this handler even if its type was not found (with no data)
1250  * @BATADV_TVLV_HANDLER_OGM_CALLED: interval tvlv handling flag - the API marks
1251  *  a handler as being called, so it won't be called if the
1252  *  BATADV_TVLV_HANDLER_OGM_CIFNOTFND flag was set
1253  */
1254 enum batadv_tvlv_handler_flags {
1255         BATADV_TVLV_HANDLER_OGM_CIFNOTFND = BIT(1),
1256         BATADV_TVLV_HANDLER_OGM_CALLED = BIT(2),
1257 };
1258
1259 #endif /* _NET_BATMAN_ADV_TYPES_H_ */