net/batman-adv/types.h

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