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