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