net/batman-adv/types.h

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