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