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