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