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