1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* Copyright (C) B.A.T.M.A.N. contributors: 3 * 4 * Marek Lindner, Simon Wunderlich 5 */ 6 7 #ifndef _NET_BATMAN_ADV_TYPES_H_ 8 #define _NET_BATMAN_ADV_TYPES_H_ 9 10 #ifndef _NET_BATMAN_ADV_MAIN_H_ 11 #error only "main.h" can be included directly 12 #endif 13 14 #include <linux/average.h> 15 #include <linux/bitops.h> 16 #include <linux/compiler.h> 17 #include <linux/if.h> 18 #include <linux/if_ether.h> 19 #include <linux/kref.h> 20 #include <linux/mutex.h> 21 #include <linux/netdevice.h> 22 #include <linux/netlink.h> 23 #include <linux/sched.h> /* for linux/wait.h */ 24 #include <linux/skbuff.h> 25 #include <linux/spinlock.h> 26 #include <linux/timer.h> 27 #include <linux/types.h> 28 #include <linux/wait.h> 29 #include <linux/workqueue.h> 30 #include <uapi/linux/batadv_packet.h> 31 #include <uapi/linux/batman_adv.h> 32 33 #ifdef CONFIG_BATMAN_ADV_DAT 34 35 /** 36 * typedef batadv_dat_addr_t - type used for all DHT addresses 37 * 38 * If it is changed, BATADV_DAT_ADDR_MAX is changed as well. 39 * 40 * *Please be careful: batadv_dat_addr_t must be UNSIGNED* 41 */ 42 typedef u16 batadv_dat_addr_t; 43 44 #endif /* CONFIG_BATMAN_ADV_DAT */ 45 46 /** 47 * enum batadv_dhcp_recipient - dhcp destination 48 */ 49 enum batadv_dhcp_recipient { 50 /** @BATADV_DHCP_NO: packet is not a dhcp message */ 51 BATADV_DHCP_NO = 0, 52 53 /** @BATADV_DHCP_TO_SERVER: dhcp message is directed to a server */ 54 BATADV_DHCP_TO_SERVER, 55 56 /** @BATADV_DHCP_TO_CLIENT: dhcp message is directed to a client */ 57 BATADV_DHCP_TO_CLIENT, 58 }; 59 60 /** 61 * BATADV_TT_REMOTE_MASK - bitmask selecting the flags that are sent over the 62 * wire only 63 */ 64 #define BATADV_TT_REMOTE_MASK 0x00FF 65 66 /** 67 * BATADV_TT_SYNC_MASK - bitmask of the flags that need to be kept in sync 68 * among the nodes. These flags are used to compute the global/local CRC 69 */ 70 #define BATADV_TT_SYNC_MASK 0x00F0 71 72 /** 73 * struct batadv_hard_iface_bat_iv - per hard-interface B.A.T.M.A.N. IV data 74 */ 75 struct batadv_hard_iface_bat_iv { 76 /** @ogm_buff: buffer holding the OGM packet */ 77 unsigned char *ogm_buff; 78 79 /** @ogm_buff_len: length of the OGM packet buffer */ 80 int ogm_buff_len; 81 82 /** @ogm_seqno: OGM sequence number - used to identify each OGM */ 83 atomic_t ogm_seqno; 84 85 /** @ogm_buff_mutex: lock protecting ogm_buff and ogm_buff_len */ 86 struct mutex ogm_buff_mutex; 87 }; 88 89 /** 90 * enum batadv_v_hard_iface_flags - interface flags useful to B.A.T.M.A.N. V 91 */ 92 enum batadv_v_hard_iface_flags { 93 /** 94 * @BATADV_FULL_DUPLEX: tells if the connection over this link is 95 * full-duplex 96 */ 97 BATADV_FULL_DUPLEX = BIT(0), 98 99 /** 100 * @BATADV_WARNING_DEFAULT: tells whether we have warned the user that 101 * no throughput data is available for this interface and that default 102 * values are assumed. 103 */ 104 BATADV_WARNING_DEFAULT = BIT(1), 105 }; 106 107 /** 108 * struct batadv_hard_iface_bat_v - per hard-interface B.A.T.M.A.N. V data 109 */ 110 struct batadv_hard_iface_bat_v { 111 /** @elp_interval: time interval between two ELP transmissions */ 112 atomic_t elp_interval; 113 114 /** @elp_seqno: current ELP sequence number */ 115 atomic_t elp_seqno; 116 117 /** @elp_skb: base skb containing the ELP message to send */ 118 struct sk_buff *elp_skb; 119 120 /** @elp_wq: workqueue used to schedule ELP transmissions */ 121 struct delayed_work elp_wq; 122 123 /** @aggr_wq: workqueue used to transmit queued OGM packets */ 124 struct delayed_work aggr_wq; 125 126 /** @aggr_list: queue for to be aggregated OGM packets */ 127 struct sk_buff_head aggr_list; 128 129 /** @aggr_len: size of the OGM aggregate (excluding ethernet header) */ 130 unsigned int aggr_len; 131 132 /** 133 * @throughput_override: throughput override to disable link 134 * auto-detection 135 */ 136 atomic_t throughput_override; 137 138 /** @flags: interface specific flags */ 139 u8 flags; 140 }; 141 142 /** 143 * enum batadv_hard_iface_wifi_flags - Flags describing the wifi configuration 144 * of a batadv_hard_iface 145 */ 146 enum batadv_hard_iface_wifi_flags { 147 /** @BATADV_HARDIF_WIFI_WEXT_DIRECT: it is a wext wifi device */ 148 BATADV_HARDIF_WIFI_WEXT_DIRECT = BIT(0), 149 150 /** @BATADV_HARDIF_WIFI_CFG80211_DIRECT: it is a cfg80211 wifi device */ 151 BATADV_HARDIF_WIFI_CFG80211_DIRECT = BIT(1), 152 153 /** 154 * @BATADV_HARDIF_WIFI_WEXT_INDIRECT: link device is a wext wifi device 155 */ 156 BATADV_HARDIF_WIFI_WEXT_INDIRECT = BIT(2), 157 158 /** 159 * @BATADV_HARDIF_WIFI_CFG80211_INDIRECT: link device is a cfg80211 wifi 160 * device 161 */ 162 BATADV_HARDIF_WIFI_CFG80211_INDIRECT = BIT(3), 163 }; 164 165 /** 166 * struct batadv_hard_iface - network device known to batman-adv 167 */ 168 struct batadv_hard_iface { 169 /** @list: list node for batadv_hardif_list */ 170 struct list_head list; 171 172 /** @if_status: status of the interface for batman-adv */ 173 char if_status; 174 175 /** 176 * @num_bcasts: number of payload re-broadcasts on this interface (ARQ) 177 */ 178 u8 num_bcasts; 179 180 /** 181 * @wifi_flags: flags whether this is (directly or indirectly) a wifi 182 * interface 183 */ 184 u32 wifi_flags; 185 186 /** @net_dev: pointer to the net_device */ 187 struct net_device *net_dev; 188 189 /** @refcount: number of contexts the object is used */ 190 struct kref refcount; 191 192 /** 193 * @batman_adv_ptype: packet type describing packets that should be 194 * processed by batman-adv for this interface 195 */ 196 struct packet_type batman_adv_ptype; 197 198 /** 199 * @soft_iface: the batman-adv interface which uses this network 200 * interface 201 */ 202 struct net_device *soft_iface; 203 204 /** @rcu: struct used for freeing in an RCU-safe manner */ 205 struct rcu_head rcu; 206 207 /** 208 * @hop_penalty: penalty which will be applied to the tq-field 209 * of an OGM received via this interface 210 */ 211 atomic_t hop_penalty; 212 213 /** @bat_iv: per hard-interface B.A.T.M.A.N. IV data */ 214 struct batadv_hard_iface_bat_iv bat_iv; 215 216 #ifdef CONFIG_BATMAN_ADV_BATMAN_V 217 /** @bat_v: per hard-interface B.A.T.M.A.N. V data */ 218 struct batadv_hard_iface_bat_v bat_v; 219 #endif 220 221 /** 222 * @neigh_list: list of unique single hop neighbors via this interface 223 */ 224 struct hlist_head neigh_list; 225 226 /** @neigh_list_lock: lock protecting neigh_list */ 227 spinlock_t neigh_list_lock; 228 }; 229 230 /** 231 * struct batadv_orig_ifinfo_bat_iv - B.A.T.M.A.N. IV private orig_ifinfo 232 * members 233 */ 234 struct batadv_orig_ifinfo_bat_iv { 235 /** 236 * @bcast_own: bitfield which counts the number of our OGMs this 237 * orig_node rebroadcasted "back" to us (relative to last_real_seqno) 238 */ 239 DECLARE_BITMAP(bcast_own, BATADV_TQ_LOCAL_WINDOW_SIZE); 240 241 /** @bcast_own_sum: sum of bcast_own */ 242 u8 bcast_own_sum; 243 }; 244 245 /** 246 * struct batadv_orig_ifinfo - originator info per outgoing interface 247 */ 248 struct batadv_orig_ifinfo { 249 /** @list: list node for &batadv_orig_node.ifinfo_list */ 250 struct hlist_node list; 251 252 /** @if_outgoing: pointer to outgoing hard-interface */ 253 struct batadv_hard_iface *if_outgoing; 254 255 /** @router: router that should be used to reach this originator */ 256 struct batadv_neigh_node __rcu *router; 257 258 /** @last_real_seqno: last and best known sequence number */ 259 u32 last_real_seqno; 260 261 /** @last_ttl: ttl of last received packet */ 262 u8 last_ttl; 263 264 /** @last_seqno_forwarded: seqno of the OGM which was forwarded last */ 265 u32 last_seqno_forwarded; 266 267 /** @batman_seqno_reset: time when the batman seqno window was reset */ 268 unsigned long batman_seqno_reset; 269 270 /** @bat_iv: B.A.T.M.A.N. IV private structure */ 271 struct batadv_orig_ifinfo_bat_iv bat_iv; 272 273 /** @refcount: number of contexts the object is used */ 274 struct kref refcount; 275 276 /** @rcu: struct used for freeing in an RCU-safe manner */ 277 struct rcu_head rcu; 278 }; 279 280 /** 281 * struct batadv_frag_table_entry - head in the fragment buffer table 282 */ 283 struct batadv_frag_table_entry { 284 /** @fragment_list: head of list with fragments */ 285 struct hlist_head fragment_list; 286 287 /** @lock: lock to protect the list of fragments */ 288 spinlock_t lock; 289 290 /** @timestamp: time (jiffie) of last received fragment */ 291 unsigned long timestamp; 292 293 /** @seqno: sequence number of the fragments in the list */ 294 u16 seqno; 295 296 /** @size: accumulated size of packets in list */ 297 u16 size; 298 299 /** @total_size: expected size of the assembled packet */ 300 u16 total_size; 301 }; 302 303 /** 304 * struct batadv_frag_list_entry - entry in a list of fragments 305 */ 306 struct batadv_frag_list_entry { 307 /** @list: list node information */ 308 struct hlist_node list; 309 310 /** @skb: fragment */ 311 struct sk_buff *skb; 312 313 /** @no: fragment number in the set */ 314 u8 no; 315 }; 316 317 /** 318 * struct batadv_vlan_tt - VLAN specific TT attributes 319 */ 320 struct batadv_vlan_tt { 321 /** @crc: CRC32 checksum of the entries belonging to this vlan */ 322 u32 crc; 323 324 /** @num_entries: number of TT entries for this VLAN */ 325 atomic_t num_entries; 326 }; 327 328 /** 329 * struct batadv_orig_node_vlan - VLAN specific data per orig_node 330 */ 331 struct batadv_orig_node_vlan { 332 /** @vid: the VLAN identifier */ 333 unsigned short vid; 334 335 /** @tt: VLAN specific TT attributes */ 336 struct batadv_vlan_tt tt; 337 338 /** @list: list node for &batadv_orig_node.vlan_list */ 339 struct hlist_node list; 340 341 /** 342 * @refcount: number of context where this object is currently in use 343 */ 344 struct kref refcount; 345 346 /** @rcu: struct used for freeing in a RCU-safe manner */ 347 struct rcu_head rcu; 348 }; 349 350 /** 351 * struct batadv_orig_bat_iv - B.A.T.M.A.N. IV private orig_node members 352 */ 353 struct batadv_orig_bat_iv { 354 /** 355 * @ogm_cnt_lock: lock protecting &batadv_orig_ifinfo_bat_iv.bcast_own, 356 * &batadv_orig_ifinfo_bat_iv.bcast_own_sum, 357 * &batadv_neigh_ifinfo_bat_iv.bat_iv.real_bits and 358 * &batadv_neigh_ifinfo_bat_iv.real_packet_count 359 */ 360 spinlock_t ogm_cnt_lock; 361 }; 362 363 /** 364 * struct batadv_orig_node - structure for orig_list maintaining nodes of mesh 365 */ 366 struct batadv_orig_node { 367 /** @orig: originator ethernet address */ 368 u8 orig[ETH_ALEN]; 369 370 /** @ifinfo_list: list for routers per outgoing interface */ 371 struct hlist_head ifinfo_list; 372 373 /** 374 * @last_bonding_candidate: pointer to last ifinfo of last used router 375 */ 376 struct batadv_orig_ifinfo *last_bonding_candidate; 377 378 #ifdef CONFIG_BATMAN_ADV_DAT 379 /** @dat_addr: address of the orig node in the distributed hash */ 380 batadv_dat_addr_t dat_addr; 381 #endif 382 383 /** @last_seen: time when last packet from this node was received */ 384 unsigned long last_seen; 385 386 /** 387 * @bcast_seqno_reset: time when the broadcast seqno window was reset 388 */ 389 unsigned long bcast_seqno_reset; 390 391 #ifdef CONFIG_BATMAN_ADV_MCAST 392 /** 393 * @mcast_handler_lock: synchronizes mcast-capability and -flag changes 394 */ 395 spinlock_t mcast_handler_lock; 396 397 /** @mcast_flags: multicast flags announced by the orig node */ 398 u8 mcast_flags; 399 400 /** 401 * @mcast_want_all_unsnoopables_node: a list node for the 402 * mcast.want_all_unsnoopables list 403 */ 404 struct hlist_node mcast_want_all_unsnoopables_node; 405 406 /** 407 * @mcast_want_all_ipv4_node: a list node for the mcast.want_all_ipv4 408 * list 409 */ 410 struct hlist_node mcast_want_all_ipv4_node; 411 /** 412 * @mcast_want_all_ipv6_node: a list node for the mcast.want_all_ipv6 413 * list 414 */ 415 struct hlist_node mcast_want_all_ipv6_node; 416 417 /** 418 * @mcast_want_all_rtr4_node: a list node for the mcast.want_all_rtr4 419 * list 420 */ 421 struct hlist_node mcast_want_all_rtr4_node; 422 /** 423 * @mcast_want_all_rtr6_node: a list node for the mcast.want_all_rtr6 424 * list 425 */ 426 struct hlist_node mcast_want_all_rtr6_node; 427 #endif 428 429 /** @capabilities: announced capabilities of this originator */ 430 unsigned long capabilities; 431 432 /** 433 * @capa_initialized: bitfield to remember whether a capability was 434 * initialized 435 */ 436 unsigned long capa_initialized; 437 438 /** @last_ttvn: last seen translation table version number */ 439 atomic_t last_ttvn; 440 441 /** @tt_buff: last tt changeset this node received from the orig node */ 442 unsigned char *tt_buff; 443 444 /** 445 * @tt_buff_len: length of the last tt changeset this node received 446 * from the orig node 447 */ 448 s16 tt_buff_len; 449 450 /** @tt_buff_lock: lock that protects tt_buff and tt_buff_len */ 451 spinlock_t tt_buff_lock; 452 453 /** 454 * @tt_lock: avoids concurrent read from and write to the table. Table 455 * update is made up of two operations (data structure update and 456 * metadata -CRC/TTVN-recalculation) and they have to be executed 457 * atomically in order to avoid another thread to read the 458 * table/metadata between those. 459 */ 460 spinlock_t tt_lock; 461 462 /** 463 * @bcast_bits: bitfield containing the info which payload broadcast 464 * originated from this orig node this host already has seen (relative 465 * to last_bcast_seqno) 466 */ 467 DECLARE_BITMAP(bcast_bits, BATADV_TQ_LOCAL_WINDOW_SIZE); 468 469 /** 470 * @last_bcast_seqno: last broadcast sequence number received by this 471 * host 472 */ 473 u32 last_bcast_seqno; 474 475 /** 476 * @neigh_list: list of potential next hop neighbor towards this orig 477 * node 478 */ 479 struct hlist_head neigh_list; 480 481 /** 482 * @neigh_list_lock: lock protecting neigh_list, ifinfo_list, 483 * last_bonding_candidate and router 484 */ 485 spinlock_t neigh_list_lock; 486 487 /** @hash_entry: hlist node for &batadv_priv.orig_hash */ 488 struct hlist_node hash_entry; 489 490 /** @bat_priv: pointer to soft_iface this orig node belongs to */ 491 struct batadv_priv *bat_priv; 492 493 /** @bcast_seqno_lock: lock protecting bcast_bits & last_bcast_seqno */ 494 spinlock_t bcast_seqno_lock; 495 496 /** @refcount: number of contexts the object is used */ 497 struct kref refcount; 498 499 /** @rcu: struct used for freeing in an RCU-safe manner */ 500 struct rcu_head rcu; 501 502 #ifdef CONFIG_BATMAN_ADV_NC 503 /** @in_coding_list: list of nodes this orig can hear */ 504 struct list_head in_coding_list; 505 506 /** @out_coding_list: list of nodes that can hear this orig */ 507 struct list_head out_coding_list; 508 509 /** @in_coding_list_lock: protects in_coding_list */ 510 spinlock_t in_coding_list_lock; 511 512 /** @out_coding_list_lock: protects out_coding_list */ 513 spinlock_t out_coding_list_lock; 514 #endif 515 516 /** @fragments: array with heads for fragment chains */ 517 struct batadv_frag_table_entry fragments[BATADV_FRAG_BUFFER_COUNT]; 518 519 /** 520 * @vlan_list: a list of orig_node_vlan structs, one per VLAN served by 521 * the originator represented by this object 522 */ 523 struct hlist_head vlan_list; 524 525 /** @vlan_list_lock: lock protecting vlan_list */ 526 spinlock_t vlan_list_lock; 527 528 /** @bat_iv: B.A.T.M.A.N. IV private structure */ 529 struct batadv_orig_bat_iv bat_iv; 530 }; 531 532 /** 533 * enum batadv_orig_capabilities - orig node capabilities 534 */ 535 enum batadv_orig_capabilities { 536 /** 537 * @BATADV_ORIG_CAPA_HAS_DAT: orig node has distributed arp table 538 * enabled 539 */ 540 BATADV_ORIG_CAPA_HAS_DAT, 541 542 /** @BATADV_ORIG_CAPA_HAS_NC: orig node has network coding enabled */ 543 BATADV_ORIG_CAPA_HAS_NC, 544 545 /** @BATADV_ORIG_CAPA_HAS_TT: orig node has tt capability */ 546 BATADV_ORIG_CAPA_HAS_TT, 547 548 /** 549 * @BATADV_ORIG_CAPA_HAS_MCAST: orig node has some multicast capability 550 * (= orig node announces a tvlv of type BATADV_TVLV_MCAST) 551 */ 552 BATADV_ORIG_CAPA_HAS_MCAST, 553 }; 554 555 /** 556 * struct batadv_gw_node - structure for orig nodes announcing gw capabilities 557 */ 558 struct batadv_gw_node { 559 /** @list: list node for &batadv_priv_gw.list */ 560 struct hlist_node list; 561 562 /** @orig_node: pointer to corresponding orig node */ 563 struct batadv_orig_node *orig_node; 564 565 /** @bandwidth_down: advertised uplink download bandwidth */ 566 u32 bandwidth_down; 567 568 /** @bandwidth_up: advertised uplink upload bandwidth */ 569 u32 bandwidth_up; 570 571 /** @refcount: number of contexts the object is used */ 572 struct kref refcount; 573 574 /** @rcu: struct used for freeing in an RCU-safe manner */ 575 struct rcu_head rcu; 576 }; 577 578 DECLARE_EWMA(throughput, 10, 8) 579 580 /** 581 * struct batadv_hardif_neigh_node_bat_v - B.A.T.M.A.N. V private neighbor 582 * information 583 */ 584 struct batadv_hardif_neigh_node_bat_v { 585 /** @throughput: ewma link throughput towards this neighbor */ 586 struct ewma_throughput throughput; 587 588 /** @elp_interval: time interval between two ELP transmissions */ 589 u32 elp_interval; 590 591 /** @elp_latest_seqno: latest and best known ELP sequence number */ 592 u32 elp_latest_seqno; 593 594 /** 595 * @last_unicast_tx: when the last unicast packet has been sent to this 596 * neighbor 597 */ 598 unsigned long last_unicast_tx; 599 }; 600 601 /** 602 * struct batadv_hardif_neigh_node - unique neighbor per hard-interface 603 */ 604 struct batadv_hardif_neigh_node { 605 /** @list: list node for &batadv_hard_iface.neigh_list */ 606 struct hlist_node list; 607 608 /** @addr: the MAC address of the neighboring interface */ 609 u8 addr[ETH_ALEN]; 610 611 /** 612 * @orig: the address of the originator this neighbor node belongs to 613 */ 614 u8 orig[ETH_ALEN]; 615 616 /** @if_incoming: pointer to incoming hard-interface */ 617 struct batadv_hard_iface *if_incoming; 618 619 /** @last_seen: when last packet via this neighbor was received */ 620 unsigned long last_seen; 621 622 #ifdef CONFIG_BATMAN_ADV_BATMAN_V 623 /** @bat_v: B.A.T.M.A.N. V private data */ 624 struct batadv_hardif_neigh_node_bat_v bat_v; 625 #endif 626 627 /** @refcount: number of contexts the object is used */ 628 struct kref refcount; 629 630 /** @rcu: struct used for freeing in a RCU-safe manner */ 631 struct rcu_head rcu; 632 }; 633 634 /** 635 * struct batadv_neigh_node - structure for single hops neighbors 636 */ 637 struct batadv_neigh_node { 638 /** @list: list node for &batadv_orig_node.neigh_list */ 639 struct hlist_node list; 640 641 /** @orig_node: pointer to corresponding orig_node */ 642 struct batadv_orig_node *orig_node; 643 644 /** @addr: the MAC address of the neighboring interface */ 645 u8 addr[ETH_ALEN]; 646 647 /** @ifinfo_list: list for routing metrics per outgoing interface */ 648 struct hlist_head ifinfo_list; 649 650 /** @ifinfo_lock: lock protecting ifinfo_list and its members */ 651 spinlock_t ifinfo_lock; 652 653 /** @if_incoming: pointer to incoming hard-interface */ 654 struct batadv_hard_iface *if_incoming; 655 656 /** @last_seen: when last packet via this neighbor was received */ 657 unsigned long last_seen; 658 659 /** @hardif_neigh: hardif_neigh of this neighbor */ 660 struct batadv_hardif_neigh_node *hardif_neigh; 661 662 /** @refcount: number of contexts the object is used */ 663 struct kref refcount; 664 665 /** @rcu: struct used for freeing in an RCU-safe manner */ 666 struct rcu_head rcu; 667 }; 668 669 /** 670 * struct batadv_neigh_ifinfo_bat_iv - neighbor information per outgoing 671 * interface for B.A.T.M.A.N. IV 672 */ 673 struct batadv_neigh_ifinfo_bat_iv { 674 /** @tq_recv: ring buffer of received TQ values from this neigh node */ 675 u8 tq_recv[BATADV_TQ_GLOBAL_WINDOW_SIZE]; 676 677 /** @tq_index: ring buffer index */ 678 u8 tq_index; 679 680 /** 681 * @tq_avg: averaged tq of all tq values in the ring buffer (tq_recv) 682 */ 683 u8 tq_avg; 684 685 /** 686 * @real_bits: bitfield containing the number of OGMs received from this 687 * neigh node (relative to orig_node->last_real_seqno) 688 */ 689 DECLARE_BITMAP(real_bits, BATADV_TQ_LOCAL_WINDOW_SIZE); 690 691 /** @real_packet_count: counted result of real_bits */ 692 u8 real_packet_count; 693 }; 694 695 /** 696 * struct batadv_neigh_ifinfo_bat_v - neighbor information per outgoing 697 * interface for B.A.T.M.A.N. V 698 */ 699 struct batadv_neigh_ifinfo_bat_v { 700 /** 701 * @throughput: last throughput metric received from originator via this 702 * neigh 703 */ 704 u32 throughput; 705 706 /** @last_seqno: last sequence number known for this neighbor */ 707 u32 last_seqno; 708 }; 709 710 /** 711 * struct batadv_neigh_ifinfo - neighbor information per outgoing interface 712 */ 713 struct batadv_neigh_ifinfo { 714 /** @list: list node for &batadv_neigh_node.ifinfo_list */ 715 struct hlist_node list; 716 717 /** @if_outgoing: pointer to outgoing hard-interface */ 718 struct batadv_hard_iface *if_outgoing; 719 720 /** @bat_iv: B.A.T.M.A.N. IV private structure */ 721 struct batadv_neigh_ifinfo_bat_iv bat_iv; 722 723 #ifdef CONFIG_BATMAN_ADV_BATMAN_V 724 /** @bat_v: B.A.T.M.A.N. V private data */ 725 struct batadv_neigh_ifinfo_bat_v bat_v; 726 #endif 727 728 /** @last_ttl: last received ttl from this neigh node */ 729 u8 last_ttl; 730 731 /** @refcount: number of contexts the object is used */ 732 struct kref refcount; 733 734 /** @rcu: struct used for freeing in a RCU-safe manner */ 735 struct rcu_head rcu; 736 }; 737 738 #ifdef CONFIG_BATMAN_ADV_BLA 739 740 /** 741 * struct batadv_bcast_duplist_entry - structure for LAN broadcast suppression 742 */ 743 struct batadv_bcast_duplist_entry { 744 /** @orig: mac address of orig node originating the broadcast */ 745 u8 orig[ETH_ALEN]; 746 747 /** @crc: crc32 checksum of broadcast payload */ 748 __be32 crc; 749 750 /** @entrytime: time when the broadcast packet was received */ 751 unsigned long entrytime; 752 }; 753 #endif 754 755 /** 756 * enum batadv_counters - indices for traffic counters 757 */ 758 enum batadv_counters { 759 /** @BATADV_CNT_TX: transmitted payload traffic packet counter */ 760 BATADV_CNT_TX, 761 762 /** @BATADV_CNT_TX_BYTES: transmitted payload traffic bytes counter */ 763 BATADV_CNT_TX_BYTES, 764 765 /** 766 * @BATADV_CNT_TX_DROPPED: dropped transmission payload traffic packet 767 * counter 768 */ 769 BATADV_CNT_TX_DROPPED, 770 771 /** @BATADV_CNT_RX: received payload traffic packet counter */ 772 BATADV_CNT_RX, 773 774 /** @BATADV_CNT_RX_BYTES: received payload traffic bytes counter */ 775 BATADV_CNT_RX_BYTES, 776 777 /** @BATADV_CNT_FORWARD: forwarded payload traffic packet counter */ 778 BATADV_CNT_FORWARD, 779 780 /** 781 * @BATADV_CNT_FORWARD_BYTES: forwarded payload traffic bytes counter 782 */ 783 BATADV_CNT_FORWARD_BYTES, 784 785 /** 786 * @BATADV_CNT_MGMT_TX: transmitted routing protocol traffic packet 787 * counter 788 */ 789 BATADV_CNT_MGMT_TX, 790 791 /** 792 * @BATADV_CNT_MGMT_TX_BYTES: transmitted routing protocol traffic bytes 793 * counter 794 */ 795 BATADV_CNT_MGMT_TX_BYTES, 796 797 /** 798 * @BATADV_CNT_MGMT_RX: received routing protocol traffic packet counter 799 */ 800 BATADV_CNT_MGMT_RX, 801 802 /** 803 * @BATADV_CNT_MGMT_RX_BYTES: received routing protocol traffic bytes 804 * counter 805 */ 806 BATADV_CNT_MGMT_RX_BYTES, 807 808 /** @BATADV_CNT_FRAG_TX: transmitted fragment traffic packet counter */ 809 BATADV_CNT_FRAG_TX, 810 811 /** 812 * @BATADV_CNT_FRAG_TX_BYTES: transmitted fragment traffic bytes counter 813 */ 814 BATADV_CNT_FRAG_TX_BYTES, 815 816 /** @BATADV_CNT_FRAG_RX: received fragment traffic packet counter */ 817 BATADV_CNT_FRAG_RX, 818 819 /** 820 * @BATADV_CNT_FRAG_RX_BYTES: received fragment traffic bytes counter 821 */ 822 BATADV_CNT_FRAG_RX_BYTES, 823 824 /** @BATADV_CNT_FRAG_FWD: forwarded fragment traffic packet counter */ 825 BATADV_CNT_FRAG_FWD, 826 827 /** 828 * @BATADV_CNT_FRAG_FWD_BYTES: forwarded fragment traffic bytes counter 829 */ 830 BATADV_CNT_FRAG_FWD_BYTES, 831 832 /** 833 * @BATADV_CNT_TT_REQUEST_TX: transmitted tt req traffic packet counter 834 */ 835 BATADV_CNT_TT_REQUEST_TX, 836 837 /** @BATADV_CNT_TT_REQUEST_RX: received tt req traffic packet counter */ 838 BATADV_CNT_TT_REQUEST_RX, 839 840 /** 841 * @BATADV_CNT_TT_RESPONSE_TX: transmitted tt resp traffic packet 842 * counter 843 */ 844 BATADV_CNT_TT_RESPONSE_TX, 845 846 /** 847 * @BATADV_CNT_TT_RESPONSE_RX: received tt resp traffic packet counter 848 */ 849 BATADV_CNT_TT_RESPONSE_RX, 850 851 /** 852 * @BATADV_CNT_TT_ROAM_ADV_TX: transmitted tt roam traffic packet 853 * counter 854 */ 855 BATADV_CNT_TT_ROAM_ADV_TX, 856 857 /** 858 * @BATADV_CNT_TT_ROAM_ADV_RX: received tt roam traffic packet counter 859 */ 860 BATADV_CNT_TT_ROAM_ADV_RX, 861 862 #ifdef CONFIG_BATMAN_ADV_DAT 863 /** 864 * @BATADV_CNT_DAT_GET_TX: transmitted dht GET traffic packet counter 865 */ 866 BATADV_CNT_DAT_GET_TX, 867 868 /** @BATADV_CNT_DAT_GET_RX: received dht GET traffic packet counter */ 869 BATADV_CNT_DAT_GET_RX, 870 871 /** 872 * @BATADV_CNT_DAT_PUT_TX: transmitted dht PUT traffic packet counter 873 */ 874 BATADV_CNT_DAT_PUT_TX, 875 876 /** @BATADV_CNT_DAT_PUT_RX: received dht PUT traffic packet counter */ 877 BATADV_CNT_DAT_PUT_RX, 878 879 /** 880 * @BATADV_CNT_DAT_CACHED_REPLY_TX: transmitted dat cache reply traffic 881 * packet counter 882 */ 883 BATADV_CNT_DAT_CACHED_REPLY_TX, 884 #endif 885 886 #ifdef CONFIG_BATMAN_ADV_NC 887 /** 888 * @BATADV_CNT_NC_CODE: transmitted nc-combined traffic packet counter 889 */ 890 BATADV_CNT_NC_CODE, 891 892 /** 893 * @BATADV_CNT_NC_CODE_BYTES: transmitted nc-combined traffic bytes 894 * counter 895 */ 896 BATADV_CNT_NC_CODE_BYTES, 897 898 /** 899 * @BATADV_CNT_NC_RECODE: transmitted nc-recombined traffic packet 900 * counter 901 */ 902 BATADV_CNT_NC_RECODE, 903 904 /** 905 * @BATADV_CNT_NC_RECODE_BYTES: transmitted nc-recombined traffic bytes 906 * counter 907 */ 908 BATADV_CNT_NC_RECODE_BYTES, 909 910 /** 911 * @BATADV_CNT_NC_BUFFER: counter for packets buffered for later nc 912 * decoding 913 */ 914 BATADV_CNT_NC_BUFFER, 915 916 /** 917 * @BATADV_CNT_NC_DECODE: received and nc-decoded traffic packet counter 918 */ 919 BATADV_CNT_NC_DECODE, 920 921 /** 922 * @BATADV_CNT_NC_DECODE_BYTES: received and nc-decoded traffic bytes 923 * counter 924 */ 925 BATADV_CNT_NC_DECODE_BYTES, 926 927 /** 928 * @BATADV_CNT_NC_DECODE_FAILED: received and decode-failed traffic 929 * packet counter 930 */ 931 BATADV_CNT_NC_DECODE_FAILED, 932 933 /** 934 * @BATADV_CNT_NC_SNIFFED: counter for nc-decoded packets received in 935 * promisc mode. 936 */ 937 BATADV_CNT_NC_SNIFFED, 938 #endif 939 940 /** @BATADV_CNT_NUM: number of traffic counters */ 941 BATADV_CNT_NUM, 942 }; 943 944 /** 945 * struct batadv_priv_tt - per mesh interface translation table data 946 */ 947 struct batadv_priv_tt { 948 /** @vn: translation table version number */ 949 atomic_t vn; 950 951 /** 952 * @ogm_append_cnt: counter of number of OGMs containing the local tt 953 * diff 954 */ 955 atomic_t ogm_append_cnt; 956 957 /** @local_changes: changes registered in an originator interval */ 958 atomic_t local_changes; 959 960 /** 961 * @changes_list: tracks tt local changes within an originator interval 962 */ 963 struct list_head changes_list; 964 965 /** @local_hash: local translation table hash table */ 966 struct batadv_hashtable *local_hash; 967 968 /** @global_hash: global translation table hash table */ 969 struct batadv_hashtable *global_hash; 970 971 /** @req_list: list of pending & unanswered tt_requests */ 972 struct hlist_head req_list; 973 974 /** 975 * @roam_list: list of the last roaming events of each client limiting 976 * the number of roaming events to avoid route flapping 977 */ 978 struct list_head roam_list; 979 980 /** @changes_list_lock: lock protecting changes_list */ 981 spinlock_t changes_list_lock; 982 983 /** @req_list_lock: lock protecting req_list */ 984 spinlock_t req_list_lock; 985 986 /** @roam_list_lock: lock protecting roam_list */ 987 spinlock_t roam_list_lock; 988 989 /** @last_changeset: last tt changeset this host has generated */ 990 unsigned char *last_changeset; 991 992 /** 993 * @last_changeset_len: length of last tt changeset this host has 994 * generated 995 */ 996 s16 last_changeset_len; 997 998 /** 999 * @last_changeset_lock: lock protecting last_changeset & 1000 * last_changeset_len 1001 */ 1002 spinlock_t last_changeset_lock; 1003 1004 /** 1005 * @commit_lock: prevents from executing a local TT commit while reading 1006 * the local table. The local TT commit is made up of two operations 1007 * (data structure update and metadata -CRC/TTVN- recalculation) and 1008 * they have to be executed atomically in order to avoid another thread 1009 * to read the table/metadata between those. 1010 */ 1011 spinlock_t commit_lock; 1012 1013 /** @work: work queue callback item for translation table purging */ 1014 struct delayed_work work; 1015 }; 1016 1017 #ifdef CONFIG_BATMAN_ADV_BLA 1018 1019 /** 1020 * struct batadv_priv_bla - per mesh interface bridge loop avoidance data 1021 */ 1022 struct batadv_priv_bla { 1023 /** @num_requests: number of bla requests in flight */ 1024 atomic_t num_requests; 1025 1026 /** 1027 * @claim_hash: hash table containing mesh nodes this host has claimed 1028 */ 1029 struct batadv_hashtable *claim_hash; 1030 1031 /** 1032 * @backbone_hash: hash table containing all detected backbone gateways 1033 */ 1034 struct batadv_hashtable *backbone_hash; 1035 1036 /** @loopdetect_addr: MAC address used for own loopdetection frames */ 1037 u8 loopdetect_addr[ETH_ALEN]; 1038 1039 /** 1040 * @loopdetect_lasttime: time when the loopdetection frames were sent 1041 */ 1042 unsigned long loopdetect_lasttime; 1043 1044 /** 1045 * @loopdetect_next: how many periods to wait for the next loopdetect 1046 * process 1047 */ 1048 atomic_t loopdetect_next; 1049 1050 /** 1051 * @bcast_duplist: recently received broadcast packets array (for 1052 * broadcast duplicate suppression) 1053 */ 1054 struct batadv_bcast_duplist_entry bcast_duplist[BATADV_DUPLIST_SIZE]; 1055 1056 /** 1057 * @bcast_duplist_curr: index of last broadcast packet added to 1058 * bcast_duplist 1059 */ 1060 int bcast_duplist_curr; 1061 1062 /** 1063 * @bcast_duplist_lock: lock protecting bcast_duplist & 1064 * bcast_duplist_curr 1065 */ 1066 spinlock_t bcast_duplist_lock; 1067 1068 /** @claim_dest: local claim data (e.g. claim group) */ 1069 struct batadv_bla_claim_dst claim_dest; 1070 1071 /** @work: work queue callback item for cleanups & bla announcements */ 1072 struct delayed_work work; 1073 }; 1074 #endif 1075 1076 #ifdef CONFIG_BATMAN_ADV_DEBUG 1077 1078 /** 1079 * struct batadv_priv_debug_log - debug logging data 1080 */ 1081 struct batadv_priv_debug_log { 1082 /** @log_buff: buffer holding the logs (ring buffer) */ 1083 char log_buff[BATADV_LOG_BUF_LEN]; 1084 1085 /** @log_start: index of next character to read */ 1086 unsigned long log_start; 1087 1088 /** @log_end: index of next character to write */ 1089 unsigned long log_end; 1090 1091 /** @lock: lock protecting log_buff, log_start & log_end */ 1092 spinlock_t lock; 1093 1094 /** @queue_wait: log reader's wait queue */ 1095 wait_queue_head_t queue_wait; 1096 }; 1097 #endif 1098 1099 /** 1100 * struct batadv_priv_gw - per mesh interface gateway data 1101 */ 1102 struct batadv_priv_gw { 1103 /** @gateway_list: list of available gateway nodes */ 1104 struct hlist_head gateway_list; 1105 1106 /** @list_lock: lock protecting gateway_list, curr_gw, generation */ 1107 spinlock_t list_lock; 1108 1109 /** @curr_gw: pointer to currently selected gateway node */ 1110 struct batadv_gw_node __rcu *curr_gw; 1111 1112 /** @generation: current (generation) sequence number */ 1113 unsigned int generation; 1114 1115 /** 1116 * @mode: gateway operation: off, client or server (see batadv_gw_modes) 1117 */ 1118 atomic_t mode; 1119 1120 /** @sel_class: gateway selection class (applies if gw_mode client) */ 1121 atomic_t sel_class; 1122 1123 /** 1124 * @bandwidth_down: advertised uplink download bandwidth (if gw_mode 1125 * server) 1126 */ 1127 atomic_t bandwidth_down; 1128 1129 /** 1130 * @bandwidth_up: advertised uplink upload bandwidth (if gw_mode server) 1131 */ 1132 atomic_t bandwidth_up; 1133 1134 /** @reselect: bool indicating a gateway re-selection is in progress */ 1135 atomic_t reselect; 1136 }; 1137 1138 /** 1139 * struct batadv_priv_tvlv - per mesh interface tvlv data 1140 */ 1141 struct batadv_priv_tvlv { 1142 /** 1143 * @container_list: list of registered tvlv containers to be sent with 1144 * each OGM 1145 */ 1146 struct hlist_head container_list; 1147 1148 /** @handler_list: list of the various tvlv content handlers */ 1149 struct hlist_head handler_list; 1150 1151 /** @container_list_lock: protects tvlv container list access */ 1152 spinlock_t container_list_lock; 1153 1154 /** @handler_list_lock: protects handler list access */ 1155 spinlock_t handler_list_lock; 1156 }; 1157 1158 #ifdef CONFIG_BATMAN_ADV_DAT 1159 1160 /** 1161 * struct batadv_priv_dat - per mesh interface DAT private data 1162 */ 1163 struct batadv_priv_dat { 1164 /** @addr: node DAT address */ 1165 batadv_dat_addr_t addr; 1166 1167 /** @hash: hashtable representing the local ARP cache */ 1168 struct batadv_hashtable *hash; 1169 1170 /** @work: work queue callback item for cache purging */ 1171 struct delayed_work work; 1172 }; 1173 #endif 1174 1175 #ifdef CONFIG_BATMAN_ADV_MCAST 1176 /** 1177 * struct batadv_mcast_querier_state - IGMP/MLD querier state when bridged 1178 */ 1179 struct batadv_mcast_querier_state { 1180 /** @exists: whether a querier exists in the mesh */ 1181 unsigned char exists:1; 1182 1183 /** 1184 * @shadowing: if a querier exists, whether it is potentially shadowing 1185 * multicast listeners (i.e. querier is behind our own bridge segment) 1186 */ 1187 unsigned char shadowing:1; 1188 }; 1189 1190 /** 1191 * struct batadv_mcast_mla_flags - flags for the querier, bridge and tvlv state 1192 */ 1193 struct batadv_mcast_mla_flags { 1194 /** @querier_ipv4: the current state of an IGMP querier in the mesh */ 1195 struct batadv_mcast_querier_state querier_ipv4; 1196 1197 /** @querier_ipv6: the current state of an MLD querier in the mesh */ 1198 struct batadv_mcast_querier_state querier_ipv6; 1199 1200 /** @enabled: whether the multicast tvlv is currently enabled */ 1201 unsigned char enabled:1; 1202 1203 /** @bridged: whether the soft interface has a bridge on top */ 1204 unsigned char bridged:1; 1205 1206 /** @tvlv_flags: the flags we have last sent in our mcast tvlv */ 1207 u8 tvlv_flags; 1208 }; 1209 1210 /** 1211 * struct batadv_priv_mcast - per mesh interface mcast data 1212 */ 1213 struct batadv_priv_mcast { 1214 /** 1215 * @mla_list: list of multicast addresses we are currently announcing 1216 * via TT 1217 */ 1218 struct hlist_head mla_list; /* see __batadv_mcast_mla_update() */ 1219 1220 /** 1221 * @want_all_unsnoopables_list: a list of orig_nodes wanting all 1222 * unsnoopable multicast traffic 1223 */ 1224 struct hlist_head want_all_unsnoopables_list; 1225 1226 /** 1227 * @want_all_ipv4_list: a list of orig_nodes wanting all IPv4 multicast 1228 * traffic 1229 */ 1230 struct hlist_head want_all_ipv4_list; 1231 1232 /** 1233 * @want_all_ipv6_list: a list of orig_nodes wanting all IPv6 multicast 1234 * traffic 1235 */ 1236 struct hlist_head want_all_ipv6_list; 1237 1238 /** 1239 * @want_all_rtr4_list: a list of orig_nodes wanting all routable IPv4 1240 * multicast traffic 1241 */ 1242 struct hlist_head want_all_rtr4_list; 1243 1244 /** 1245 * @want_all_rtr6_list: a list of orig_nodes wanting all routable IPv6 1246 * multicast traffic 1247 */ 1248 struct hlist_head want_all_rtr6_list; 1249 1250 /** 1251 * @mla_flags: flags for the querier, bridge and tvlv state 1252 */ 1253 struct batadv_mcast_mla_flags mla_flags; 1254 1255 /** 1256 * @mla_lock: a lock protecting mla_list and mla_flags 1257 */ 1258 spinlock_t mla_lock; 1259 1260 /** 1261 * @num_want_all_unsnoopables: number of nodes wanting unsnoopable IP 1262 * traffic 1263 */ 1264 atomic_t num_want_all_unsnoopables; 1265 1266 /** @num_want_all_ipv4: counter for items in want_all_ipv4_list */ 1267 atomic_t num_want_all_ipv4; 1268 1269 /** @num_want_all_ipv6: counter for items in want_all_ipv6_list */ 1270 atomic_t num_want_all_ipv6; 1271 1272 /** @num_want_all_rtr4: counter for items in want_all_rtr4_list */ 1273 atomic_t num_want_all_rtr4; 1274 1275 /** @num_want_all_rtr6: counter for items in want_all_rtr6_list */ 1276 atomic_t num_want_all_rtr6; 1277 1278 /** 1279 * @want_lists_lock: lock for protecting modifications to mcasts 1280 * want_all_{unsnoopables,ipv4,ipv6}_list (traversals are rcu-locked) 1281 */ 1282 spinlock_t want_lists_lock; 1283 1284 /** @work: work queue callback item for multicast TT and TVLV updates */ 1285 struct delayed_work work; 1286 }; 1287 #endif 1288 1289 /** 1290 * struct batadv_priv_nc - per mesh interface network coding private data 1291 */ 1292 struct batadv_priv_nc { 1293 /** @work: work queue callback item for cleanup */ 1294 struct delayed_work work; 1295 1296 /** 1297 * @min_tq: only consider neighbors for encoding if neigh_tq > min_tq 1298 */ 1299 u8 min_tq; 1300 1301 /** 1302 * @max_fwd_delay: maximum packet forward delay to allow coding of 1303 * packets 1304 */ 1305 u32 max_fwd_delay; 1306 1307 /** 1308 * @max_buffer_time: buffer time for sniffed packets used to decoding 1309 */ 1310 u32 max_buffer_time; 1311 1312 /** 1313 * @timestamp_fwd_flush: timestamp of last forward packet queue flush 1314 */ 1315 unsigned long timestamp_fwd_flush; 1316 1317 /** 1318 * @timestamp_sniffed_purge: timestamp of last sniffed packet queue 1319 * purge 1320 */ 1321 unsigned long timestamp_sniffed_purge; 1322 1323 /** 1324 * @coding_hash: Hash table used to buffer skbs while waiting for 1325 * another incoming skb to code it with. Skbs are added to the buffer 1326 * just before being forwarded in routing.c 1327 */ 1328 struct batadv_hashtable *coding_hash; 1329 1330 /** 1331 * @decoding_hash: Hash table used to buffer skbs that might be needed 1332 * to decode a received coded skb. The buffer is used for 1) skbs 1333 * arriving on the soft-interface; 2) skbs overheard on the 1334 * hard-interface; and 3) skbs forwarded by batman-adv. 1335 */ 1336 struct batadv_hashtable *decoding_hash; 1337 }; 1338 1339 /** 1340 * struct batadv_tp_unacked - unacked packet meta-information 1341 * 1342 * This struct is supposed to represent a buffer unacked packet. However, since 1343 * the purpose of the TP meter is to count the traffic only, there is no need to 1344 * store the entire sk_buff, the starting offset and the length are enough 1345 */ 1346 struct batadv_tp_unacked { 1347 /** @seqno: seqno of the unacked packet */ 1348 u32 seqno; 1349 1350 /** @len: length of the packet */ 1351 u16 len; 1352 1353 /** @list: list node for &batadv_tp_vars.unacked_list */ 1354 struct list_head list; 1355 }; 1356 1357 /** 1358 * enum batadv_tp_meter_role - Modus in tp meter session 1359 */ 1360 enum batadv_tp_meter_role { 1361 /** @BATADV_TP_RECEIVER: Initialized as receiver */ 1362 BATADV_TP_RECEIVER, 1363 1364 /** @BATADV_TP_SENDER: Initialized as sender */ 1365 BATADV_TP_SENDER 1366 }; 1367 1368 /** 1369 * struct batadv_tp_vars - tp meter private variables per session 1370 */ 1371 struct batadv_tp_vars { 1372 /** @list: list node for &bat_priv.tp_list */ 1373 struct hlist_node list; 1374 1375 /** @timer: timer for ack (receiver) and retry (sender) */ 1376 struct timer_list timer; 1377 1378 /** @bat_priv: pointer to the mesh object */ 1379 struct batadv_priv *bat_priv; 1380 1381 /** @start_time: start time in jiffies */ 1382 unsigned long start_time; 1383 1384 /** @other_end: mac address of remote */ 1385 u8 other_end[ETH_ALEN]; 1386 1387 /** @role: receiver/sender modi */ 1388 enum batadv_tp_meter_role role; 1389 1390 /** @sending: sending binary semaphore: 1 if sending, 0 is not */ 1391 atomic_t sending; 1392 1393 /** @reason: reason for a stopped session */ 1394 enum batadv_tp_meter_reason reason; 1395 1396 /** @finish_work: work item for the finishing procedure */ 1397 struct delayed_work finish_work; 1398 1399 /** @test_length: test length in milliseconds */ 1400 u32 test_length; 1401 1402 /** @session: TP session identifier */ 1403 u8 session[2]; 1404 1405 /** @icmp_uid: local ICMP "socket" index */ 1406 u8 icmp_uid; 1407 1408 /* sender variables */ 1409 1410 /** @dec_cwnd: decimal part of the cwnd used during linear growth */ 1411 u16 dec_cwnd; 1412 1413 /** @cwnd: current size of the congestion window */ 1414 u32 cwnd; 1415 1416 /** @cwnd_lock: lock do protect @cwnd & @dec_cwnd */ 1417 spinlock_t cwnd_lock; 1418 1419 /** 1420 * @ss_threshold: Slow Start threshold. Once cwnd exceeds this value the 1421 * connection switches to the Congestion Avoidance state 1422 */ 1423 u32 ss_threshold; 1424 1425 /** @last_acked: last acked byte */ 1426 atomic_t last_acked; 1427 1428 /** @last_sent: last sent byte, not yet acked */ 1429 u32 last_sent; 1430 1431 /** @tot_sent: amount of data sent/ACKed so far */ 1432 atomic64_t tot_sent; 1433 1434 /** @dup_acks: duplicate ACKs counter */ 1435 atomic_t dup_acks; 1436 1437 /** @fast_recovery: true if in Fast Recovery mode */ 1438 unsigned char fast_recovery:1; 1439 1440 /** @recover: last sent seqno when entering Fast Recovery */ 1441 u32 recover; 1442 1443 /** @rto: sender timeout */ 1444 u32 rto; 1445 1446 /** @srtt: smoothed RTT scaled by 2^3 */ 1447 u32 srtt; 1448 1449 /** @rttvar: RTT variation scaled by 2^2 */ 1450 u32 rttvar; 1451 1452 /** 1453 * @more_bytes: waiting queue anchor when waiting for more ack/retry 1454 * timeout 1455 */ 1456 wait_queue_head_t more_bytes; 1457 1458 /** @prerandom_offset: offset inside the prerandom buffer */ 1459 u32 prerandom_offset; 1460 1461 /** @prerandom_lock: spinlock protecting access to prerandom_offset */ 1462 spinlock_t prerandom_lock; 1463 1464 /* receiver variables */ 1465 1466 /** @last_recv: last in-order received packet */ 1467 u32 last_recv; 1468 1469 /** @unacked_list: list of unacked packets (meta-info only) */ 1470 struct list_head unacked_list; 1471 1472 /** @unacked_lock: protect unacked_list */ 1473 spinlock_t unacked_lock; 1474 1475 /** @last_recv_time: time (jiffies) a msg was received */ 1476 unsigned long last_recv_time; 1477 1478 /** @refcount: number of context where the object is used */ 1479 struct kref refcount; 1480 1481 /** @rcu: struct used for freeing in an RCU-safe manner */ 1482 struct rcu_head rcu; 1483 }; 1484 1485 /** 1486 * struct batadv_softif_vlan - per VLAN attributes set 1487 */ 1488 struct batadv_softif_vlan { 1489 /** @bat_priv: pointer to the mesh object */ 1490 struct batadv_priv *bat_priv; 1491 1492 /** @vid: VLAN identifier */ 1493 unsigned short vid; 1494 1495 /** @ap_isolation: AP isolation state */ 1496 atomic_t ap_isolation; /* boolean */ 1497 1498 /** @tt: TT private attributes (VLAN specific) */ 1499 struct batadv_vlan_tt tt; 1500 1501 /** @list: list node for &bat_priv.softif_vlan_list */ 1502 struct hlist_node list; 1503 1504 /** 1505 * @refcount: number of context where this object is currently in use 1506 */ 1507 struct kref refcount; 1508 1509 /** @rcu: struct used for freeing in a RCU-safe manner */ 1510 struct rcu_head rcu; 1511 }; 1512 1513 /** 1514 * struct batadv_priv_bat_v - B.A.T.M.A.N. V per soft-interface private data 1515 */ 1516 struct batadv_priv_bat_v { 1517 /** @ogm_buff: buffer holding the OGM packet */ 1518 unsigned char *ogm_buff; 1519 1520 /** @ogm_buff_len: length of the OGM packet buffer */ 1521 int ogm_buff_len; 1522 1523 /** @ogm_seqno: OGM sequence number - used to identify each OGM */ 1524 atomic_t ogm_seqno; 1525 1526 /** @ogm_buff_mutex: lock protecting ogm_buff and ogm_buff_len */ 1527 struct mutex ogm_buff_mutex; 1528 1529 /** @ogm_wq: workqueue used to schedule OGM transmissions */ 1530 struct delayed_work ogm_wq; 1531 }; 1532 1533 /** 1534 * struct batadv_priv - per mesh interface data 1535 */ 1536 struct batadv_priv { 1537 /** 1538 * @mesh_state: current status of the mesh 1539 * (inactive/active/deactivating) 1540 */ 1541 atomic_t mesh_state; 1542 1543 /** @soft_iface: net device which holds this struct as private data */ 1544 struct net_device *soft_iface; 1545 1546 /** 1547 * @mtu_set_by_user: MTU was set once by user 1548 * protected by rtnl_lock 1549 */ 1550 int mtu_set_by_user; 1551 1552 /** 1553 * @bat_counters: mesh internal traffic statistic counters (see 1554 * batadv_counters) 1555 */ 1556 u64 __percpu *bat_counters; /* Per cpu counters */ 1557 1558 /** 1559 * @aggregated_ogms: bool indicating whether OGM aggregation is enabled 1560 */ 1561 atomic_t aggregated_ogms; 1562 1563 /** @bonding: bool indicating whether traffic bonding is enabled */ 1564 atomic_t bonding; 1565 1566 /** 1567 * @fragmentation: bool indicating whether traffic fragmentation is 1568 * enabled 1569 */ 1570 atomic_t fragmentation; 1571 1572 /** 1573 * @packet_size_max: max packet size that can be transmitted via 1574 * multiple fragmented skbs or a single frame if fragmentation is 1575 * disabled 1576 */ 1577 atomic_t packet_size_max; 1578 1579 /** 1580 * @frag_seqno: incremental counter to identify chains of egress 1581 * fragments 1582 */ 1583 atomic_t frag_seqno; 1584 1585 #ifdef CONFIG_BATMAN_ADV_BLA 1586 /** 1587 * @bridge_loop_avoidance: bool indicating whether bridge loop 1588 * avoidance is enabled 1589 */ 1590 atomic_t bridge_loop_avoidance; 1591 #endif 1592 1593 #ifdef CONFIG_BATMAN_ADV_DAT 1594 /** 1595 * @distributed_arp_table: bool indicating whether distributed ARP table 1596 * is enabled 1597 */ 1598 atomic_t distributed_arp_table; 1599 #endif 1600 1601 #ifdef CONFIG_BATMAN_ADV_MCAST 1602 /** 1603 * @multicast_mode: Enable or disable multicast optimizations on this 1604 * node's sender/originating side 1605 */ 1606 atomic_t multicast_mode; 1607 1608 /** 1609 * @multicast_fanout: Maximum number of packet copies to generate for a 1610 * multicast-to-unicast conversion 1611 */ 1612 atomic_t multicast_fanout; 1613 #endif 1614 1615 /** @orig_interval: OGM broadcast interval in milliseconds */ 1616 atomic_t orig_interval; 1617 1618 /** 1619 * @hop_penalty: penalty which will be applied to an OGM's tq-field on 1620 * every hop 1621 */ 1622 atomic_t hop_penalty; 1623 1624 #ifdef CONFIG_BATMAN_ADV_DEBUG 1625 /** @log_level: configured log level (see batadv_dbg_level) */ 1626 atomic_t log_level; 1627 #endif 1628 1629 /** 1630 * @isolation_mark: the skb->mark value used to match packets for AP 1631 * isolation 1632 */ 1633 u32 isolation_mark; 1634 1635 /** 1636 * @isolation_mark_mask: bitmask identifying the bits in skb->mark to be 1637 * used for the isolation mark 1638 */ 1639 u32 isolation_mark_mask; 1640 1641 /** @bcast_seqno: last sent broadcast packet sequence number */ 1642 atomic_t bcast_seqno; 1643 1644 /** 1645 * @bcast_queue_left: number of remaining buffered broadcast packet 1646 * slots 1647 */ 1648 atomic_t bcast_queue_left; 1649 1650 /** @batman_queue_left: number of remaining OGM packet slots */ 1651 atomic_t batman_queue_left; 1652 1653 /** @forw_bat_list: list of aggregated OGMs that will be forwarded */ 1654 struct hlist_head forw_bat_list; 1655 1656 /** 1657 * @forw_bcast_list: list of broadcast packets that will be 1658 * rebroadcasted 1659 */ 1660 struct hlist_head forw_bcast_list; 1661 1662 /** @tp_list: list of tp sessions */ 1663 struct hlist_head tp_list; 1664 1665 /** @orig_hash: hash table containing mesh participants (orig nodes) */ 1666 struct batadv_hashtable *orig_hash; 1667 1668 /** @forw_bat_list_lock: lock protecting forw_bat_list */ 1669 spinlock_t forw_bat_list_lock; 1670 1671 /** @forw_bcast_list_lock: lock protecting forw_bcast_list */ 1672 spinlock_t forw_bcast_list_lock; 1673 1674 /** @tp_list_lock: spinlock protecting @tp_list */ 1675 spinlock_t tp_list_lock; 1676 1677 /** @tp_num: number of currently active tp sessions */ 1678 atomic_t tp_num; 1679 1680 /** @orig_work: work queue callback item for orig node purging */ 1681 struct delayed_work orig_work; 1682 1683 /** 1684 * @primary_if: one of the hard-interfaces assigned to this mesh 1685 * interface becomes the primary interface 1686 */ 1687 struct batadv_hard_iface __rcu *primary_if; /* rcu protected pointer */ 1688 1689 /** @algo_ops: routing algorithm used by this mesh interface */ 1690 struct batadv_algo_ops *algo_ops; 1691 1692 /** 1693 * @softif_vlan_list: a list of softif_vlan structs, one per VLAN 1694 * created on top of the mesh interface represented by this object 1695 */ 1696 struct hlist_head softif_vlan_list; 1697 1698 /** @softif_vlan_list_lock: lock protecting softif_vlan_list */ 1699 spinlock_t softif_vlan_list_lock; 1700 1701 #ifdef CONFIG_BATMAN_ADV_BLA 1702 /** @bla: bridge loop avoidance data */ 1703 struct batadv_priv_bla bla; 1704 #endif 1705 1706 #ifdef CONFIG_BATMAN_ADV_DEBUG 1707 /** @debug_log: holding debug logging relevant data */ 1708 struct batadv_priv_debug_log *debug_log; 1709 #endif 1710 1711 /** @gw: gateway data */ 1712 struct batadv_priv_gw gw; 1713 1714 /** @tt: translation table data */ 1715 struct batadv_priv_tt tt; 1716 1717 /** @tvlv: type-version-length-value data */ 1718 struct batadv_priv_tvlv tvlv; 1719 1720 #ifdef CONFIG_BATMAN_ADV_DAT 1721 /** @dat: distributed arp table data */ 1722 struct batadv_priv_dat dat; 1723 #endif 1724 1725 #ifdef CONFIG_BATMAN_ADV_MCAST 1726 /** @mcast: multicast data */ 1727 struct batadv_priv_mcast mcast; 1728 #endif 1729 1730 #ifdef CONFIG_BATMAN_ADV_NC 1731 /** 1732 * @network_coding: bool indicating whether network coding is enabled 1733 */ 1734 atomic_t network_coding; 1735 1736 /** @nc: network coding data */ 1737 struct batadv_priv_nc nc; 1738 #endif /* CONFIG_BATMAN_ADV_NC */ 1739 1740 #ifdef CONFIG_BATMAN_ADV_BATMAN_V 1741 /** @bat_v: B.A.T.M.A.N. V per soft-interface private data */ 1742 struct batadv_priv_bat_v bat_v; 1743 #endif 1744 }; 1745 1746 #ifdef CONFIG_BATMAN_ADV_BLA 1747 1748 /** 1749 * struct batadv_bla_backbone_gw - batman-adv gateway bridged into the LAN 1750 */ 1751 struct batadv_bla_backbone_gw { 1752 /** 1753 * @orig: originator address of backbone node (mac address of primary 1754 * iface) 1755 */ 1756 u8 orig[ETH_ALEN]; 1757 1758 /** @vid: vlan id this gateway was detected on */ 1759 unsigned short vid; 1760 1761 /** @hash_entry: hlist node for &batadv_priv_bla.backbone_hash */ 1762 struct hlist_node hash_entry; 1763 1764 /** @bat_priv: pointer to soft_iface this backbone gateway belongs to */ 1765 struct batadv_priv *bat_priv; 1766 1767 /** @lasttime: last time we heard of this backbone gw */ 1768 unsigned long lasttime; 1769 1770 /** 1771 * @wait_periods: grace time for bridge forward delays and bla group 1772 * forming at bootup phase - no bcast traffic is formwared until it has 1773 * elapsed 1774 */ 1775 atomic_t wait_periods; 1776 1777 /** 1778 * @request_sent: if this bool is set to true we are out of sync with 1779 * this backbone gateway - no bcast traffic is formwared until the 1780 * situation was resolved 1781 */ 1782 atomic_t request_sent; 1783 1784 /** @crc: crc16 checksum over all claims */ 1785 u16 crc; 1786 1787 /** @crc_lock: lock protecting crc */ 1788 spinlock_t crc_lock; 1789 1790 /** @report_work: work struct for reporting detected loops */ 1791 struct work_struct report_work; 1792 1793 /** @refcount: number of contexts the object is used */ 1794 struct kref refcount; 1795 1796 /** @rcu: struct used for freeing in an RCU-safe manner */ 1797 struct rcu_head rcu; 1798 }; 1799 1800 /** 1801 * struct batadv_bla_claim - claimed non-mesh client structure 1802 */ 1803 struct batadv_bla_claim { 1804 /** @addr: mac address of claimed non-mesh client */ 1805 u8 addr[ETH_ALEN]; 1806 1807 /** @vid: vlan id this client was detected on */ 1808 unsigned short vid; 1809 1810 /** @backbone_gw: pointer to backbone gw claiming this client */ 1811 struct batadv_bla_backbone_gw *backbone_gw; 1812 1813 /** @backbone_lock: lock protecting backbone_gw pointer */ 1814 spinlock_t backbone_lock; 1815 1816 /** @lasttime: last time we heard of claim (locals only) */ 1817 unsigned long lasttime; 1818 1819 /** @hash_entry: hlist node for &batadv_priv_bla.claim_hash */ 1820 struct hlist_node hash_entry; 1821 1822 /** @refcount: number of contexts the object is used */ 1823 struct rcu_head rcu; 1824 1825 /** @rcu: struct used for freeing in an RCU-safe manner */ 1826 struct kref refcount; 1827 }; 1828 #endif 1829 1830 /** 1831 * struct batadv_tt_common_entry - tt local & tt global common data 1832 */ 1833 struct batadv_tt_common_entry { 1834 /** @addr: mac address of non-mesh client */ 1835 u8 addr[ETH_ALEN]; 1836 1837 /** @vid: VLAN identifier */ 1838 unsigned short vid; 1839 1840 /** 1841 * @hash_entry: hlist node for &batadv_priv_tt.local_hash or for 1842 * &batadv_priv_tt.global_hash 1843 */ 1844 struct hlist_node hash_entry; 1845 1846 /** @flags: various state handling flags (see batadv_tt_client_flags) */ 1847 u16 flags; 1848 1849 /** @added_at: timestamp used for purging stale tt common entries */ 1850 unsigned long added_at; 1851 1852 /** @refcount: number of contexts the object is used */ 1853 struct kref refcount; 1854 1855 /** @rcu: struct used for freeing in an RCU-safe manner */ 1856 struct rcu_head rcu; 1857 }; 1858 1859 /** 1860 * struct batadv_tt_local_entry - translation table local entry data 1861 */ 1862 struct batadv_tt_local_entry { 1863 /** @common: general translation table data */ 1864 struct batadv_tt_common_entry common; 1865 1866 /** @last_seen: timestamp used for purging stale tt local entries */ 1867 unsigned long last_seen; 1868 1869 /** @vlan: soft-interface vlan of the entry */ 1870 struct batadv_softif_vlan *vlan; 1871 }; 1872 1873 /** 1874 * struct batadv_tt_global_entry - translation table global entry data 1875 */ 1876 struct batadv_tt_global_entry { 1877 /** @common: general translation table data */ 1878 struct batadv_tt_common_entry common; 1879 1880 /** @orig_list: list of orig nodes announcing this non-mesh client */ 1881 struct hlist_head orig_list; 1882 1883 /** @orig_list_count: number of items in the orig_list */ 1884 atomic_t orig_list_count; 1885 1886 /** @list_lock: lock protecting orig_list */ 1887 spinlock_t list_lock; 1888 1889 /** @roam_at: time at which TT_GLOBAL_ROAM was set */ 1890 unsigned long roam_at; 1891 }; 1892 1893 /** 1894 * struct batadv_tt_orig_list_entry - orig node announcing a non-mesh client 1895 */ 1896 struct batadv_tt_orig_list_entry { 1897 /** @orig_node: pointer to orig node announcing this non-mesh client */ 1898 struct batadv_orig_node *orig_node; 1899 1900 /** 1901 * @ttvn: translation table version number which added the non-mesh 1902 * client 1903 */ 1904 u8 ttvn; 1905 1906 /** @flags: per orig entry TT sync flags */ 1907 u8 flags; 1908 1909 /** @list: list node for &batadv_tt_global_entry.orig_list */ 1910 struct hlist_node list; 1911 1912 /** @refcount: number of contexts the object is used */ 1913 struct kref refcount; 1914 1915 /** @rcu: struct used for freeing in an RCU-safe manner */ 1916 struct rcu_head rcu; 1917 }; 1918 1919 /** 1920 * struct batadv_tt_change_node - structure for tt changes occurred 1921 */ 1922 struct batadv_tt_change_node { 1923 /** @list: list node for &batadv_priv_tt.changes_list */ 1924 struct list_head list; 1925 1926 /** @change: holds the actual translation table diff data */ 1927 struct batadv_tvlv_tt_change change; 1928 }; 1929 1930 /** 1931 * struct batadv_tt_req_node - data to keep track of the tt requests in flight 1932 */ 1933 struct batadv_tt_req_node { 1934 /** 1935 * @addr: mac address of the originator this request was sent to 1936 */ 1937 u8 addr[ETH_ALEN]; 1938 1939 /** @issued_at: timestamp used for purging stale tt requests */ 1940 unsigned long issued_at; 1941 1942 /** @refcount: number of contexts the object is used by */ 1943 struct kref refcount; 1944 1945 /** @list: list node for &batadv_priv_tt.req_list */ 1946 struct hlist_node list; 1947 }; 1948 1949 /** 1950 * struct batadv_tt_roam_node - roaming client data 1951 */ 1952 struct batadv_tt_roam_node { 1953 /** @addr: mac address of the client in the roaming phase */ 1954 u8 addr[ETH_ALEN]; 1955 1956 /** 1957 * @counter: number of allowed roaming events per client within a single 1958 * OGM interval (changes are committed with each OGM) 1959 */ 1960 atomic_t counter; 1961 1962 /** 1963 * @first_time: timestamp used for purging stale roaming node entries 1964 */ 1965 unsigned long first_time; 1966 1967 /** @list: list node for &batadv_priv_tt.roam_list */ 1968 struct list_head list; 1969 }; 1970 1971 /** 1972 * struct batadv_nc_node - network coding node 1973 */ 1974 struct batadv_nc_node { 1975 /** @list: next and prev pointer for the list handling */ 1976 struct list_head list; 1977 1978 /** @addr: the node's mac address */ 1979 u8 addr[ETH_ALEN]; 1980 1981 /** @refcount: number of contexts the object is used by */ 1982 struct kref refcount; 1983 1984 /** @rcu: struct used for freeing in an RCU-safe manner */ 1985 struct rcu_head rcu; 1986 1987 /** @orig_node: pointer to corresponding orig node struct */ 1988 struct batadv_orig_node *orig_node; 1989 1990 /** @last_seen: timestamp of last ogm received from this node */ 1991 unsigned long last_seen; 1992 }; 1993 1994 /** 1995 * struct batadv_nc_path - network coding path 1996 */ 1997 struct batadv_nc_path { 1998 /** @hash_entry: next and prev pointer for the list handling */ 1999 struct hlist_node hash_entry; 2000 2001 /** @rcu: struct used for freeing in an RCU-safe manner */ 2002 struct rcu_head rcu; 2003 2004 /** @refcount: number of contexts the object is used by */ 2005 struct kref refcount; 2006 2007 /** @packet_list: list of buffered packets for this path */ 2008 struct list_head packet_list; 2009 2010 /** @packet_list_lock: access lock for packet list */ 2011 spinlock_t packet_list_lock; 2012 2013 /** @next_hop: next hop (destination) of path */ 2014 u8 next_hop[ETH_ALEN]; 2015 2016 /** @prev_hop: previous hop (source) of path */ 2017 u8 prev_hop[ETH_ALEN]; 2018 2019 /** @last_valid: timestamp for last validation of path */ 2020 unsigned long last_valid; 2021 }; 2022 2023 /** 2024 * struct batadv_nc_packet - network coding packet used when coding and 2025 * decoding packets 2026 */ 2027 struct batadv_nc_packet { 2028 /** @list: next and prev pointer for the list handling */ 2029 struct list_head list; 2030 2031 /** @packet_id: crc32 checksum of skb data */ 2032 __be32 packet_id; 2033 2034 /** 2035 * @timestamp: field containing the info when the packet was added to 2036 * path 2037 */ 2038 unsigned long timestamp; 2039 2040 /** @neigh_node: pointer to original next hop neighbor of skb */ 2041 struct batadv_neigh_node *neigh_node; 2042 2043 /** @skb: skb which can be encoded or used for decoding */ 2044 struct sk_buff *skb; 2045 2046 /** @nc_path: pointer to path this nc packet is attached to */ 2047 struct batadv_nc_path *nc_path; 2048 }; 2049 2050 /** 2051 * struct batadv_skb_cb - control buffer structure used to store private data 2052 * relevant to batman-adv in the skb->cb buffer in skbs. 2053 */ 2054 struct batadv_skb_cb { 2055 /** 2056 * @decoded: Marks a skb as decoded, which is checked when searching for 2057 * coding opportunities in network-coding.c 2058 */ 2059 unsigned char decoded:1; 2060 2061 /** @num_bcasts: Counter for broadcast packet retransmissions */ 2062 unsigned char num_bcasts; 2063 }; 2064 2065 /** 2066 * struct batadv_forw_packet - structure for bcast packets to be sent/forwarded 2067 */ 2068 struct batadv_forw_packet { 2069 /** 2070 * @list: list node for &batadv_priv.forw.bcast_list and 2071 * &batadv_priv.forw.bat_list 2072 */ 2073 struct hlist_node list; 2074 2075 /** @cleanup_list: list node for purging functions */ 2076 struct hlist_node cleanup_list; 2077 2078 /** @send_time: execution time for delayed_work (packet sending) */ 2079 unsigned long send_time; 2080 2081 /** 2082 * @own: bool for locally generated packets (local OGMs are re-scheduled 2083 * after sending) 2084 */ 2085 u8 own; 2086 2087 /** @skb: bcast packet's skb buffer */ 2088 struct sk_buff *skb; 2089 2090 /** @packet_len: size of aggregated OGM packet inside the skb buffer */ 2091 u16 packet_len; 2092 2093 /** @direct_link_flags: direct link flags for aggregated OGM packets */ 2094 u32 direct_link_flags; 2095 2096 /** @num_packets: counter for aggregated OGMv1 packets */ 2097 u8 num_packets; 2098 2099 /** @delayed_work: work queue callback item for packet sending */ 2100 struct delayed_work delayed_work; 2101 2102 /** 2103 * @if_incoming: pointer to incoming hard-iface or primary iface if 2104 * locally generated packet 2105 */ 2106 struct batadv_hard_iface *if_incoming; 2107 2108 /** 2109 * @if_outgoing: packet where the packet should be sent to, or NULL if 2110 * unspecified 2111 */ 2112 struct batadv_hard_iface *if_outgoing; 2113 2114 /** @queue_left: The queue (counter) this packet was applied to */ 2115 atomic_t *queue_left; 2116 }; 2117 2118 /** 2119 * struct batadv_algo_iface_ops - mesh algorithm callbacks (interface specific) 2120 */ 2121 struct batadv_algo_iface_ops { 2122 /** 2123 * @activate: start routing mechanisms when hard-interface is brought up 2124 * (optional) 2125 */ 2126 void (*activate)(struct batadv_hard_iface *hard_iface); 2127 2128 /** @enable: init routing info when hard-interface is enabled */ 2129 int (*enable)(struct batadv_hard_iface *hard_iface); 2130 2131 /** @enabled: notification when hard-interface was enabled (optional) */ 2132 void (*enabled)(struct batadv_hard_iface *hard_iface); 2133 2134 /** @disable: de-init routing info when hard-interface is disabled */ 2135 void (*disable)(struct batadv_hard_iface *hard_iface); 2136 2137 /** 2138 * @update_mac: (re-)init mac addresses of the protocol information 2139 * belonging to this hard-interface 2140 */ 2141 void (*update_mac)(struct batadv_hard_iface *hard_iface); 2142 2143 /** @primary_set: called when primary interface is selected / changed */ 2144 void (*primary_set)(struct batadv_hard_iface *hard_iface); 2145 }; 2146 2147 /** 2148 * struct batadv_algo_neigh_ops - mesh algorithm callbacks (neighbour specific) 2149 */ 2150 struct batadv_algo_neigh_ops { 2151 /** @hardif_init: called on creation of single hop entry (optional) */ 2152 void (*hardif_init)(struct batadv_hardif_neigh_node *neigh); 2153 2154 /** 2155 * @cmp: compare the metrics of two neighbors for their respective 2156 * outgoing interfaces 2157 */ 2158 int (*cmp)(struct batadv_neigh_node *neigh1, 2159 struct batadv_hard_iface *if_outgoing1, 2160 struct batadv_neigh_node *neigh2, 2161 struct batadv_hard_iface *if_outgoing2); 2162 2163 /** 2164 * @is_similar_or_better: check if neigh1 is equally similar or better 2165 * than neigh2 for their respective outgoing interface from the metric 2166 * prospective 2167 */ 2168 bool (*is_similar_or_better)(struct batadv_neigh_node *neigh1, 2169 struct batadv_hard_iface *if_outgoing1, 2170 struct batadv_neigh_node *neigh2, 2171 struct batadv_hard_iface *if_outgoing2); 2172 2173 /** @dump: dump neighbors to a netlink socket (optional) */ 2174 void (*dump)(struct sk_buff *msg, struct netlink_callback *cb, 2175 struct batadv_priv *priv, 2176 struct batadv_hard_iface *hard_iface); 2177 }; 2178 2179 /** 2180 * struct batadv_algo_orig_ops - mesh algorithm callbacks (originator specific) 2181 */ 2182 struct batadv_algo_orig_ops { 2183 /** @dump: dump originators to a netlink socket (optional) */ 2184 void (*dump)(struct sk_buff *msg, struct netlink_callback *cb, 2185 struct batadv_priv *priv, 2186 struct batadv_hard_iface *hard_iface); 2187 }; 2188 2189 /** 2190 * struct batadv_algo_gw_ops - mesh algorithm callbacks (GW specific) 2191 */ 2192 struct batadv_algo_gw_ops { 2193 /** @init_sel_class: initialize GW selection class (optional) */ 2194 void (*init_sel_class)(struct batadv_priv *bat_priv); 2195 2196 /** 2197 * @sel_class_max: maximum allowed GW selection class 2198 */ 2199 u32 sel_class_max; 2200 2201 /** 2202 * @get_best_gw_node: select the best GW from the list of available 2203 * nodes (optional) 2204 */ 2205 struct batadv_gw_node *(*get_best_gw_node) 2206 (struct batadv_priv *bat_priv); 2207 2208 /** 2209 * @is_eligible: check if a newly discovered GW is a potential candidate 2210 * for the election as best GW (optional) 2211 */ 2212 bool (*is_eligible)(struct batadv_priv *bat_priv, 2213 struct batadv_orig_node *curr_gw_orig, 2214 struct batadv_orig_node *orig_node); 2215 2216 /** @dump: dump gateways to a netlink socket (optional) */ 2217 void (*dump)(struct sk_buff *msg, struct netlink_callback *cb, 2218 struct batadv_priv *priv); 2219 }; 2220 2221 /** 2222 * struct batadv_algo_ops - mesh algorithm callbacks 2223 */ 2224 struct batadv_algo_ops { 2225 /** @list: list node for the batadv_algo_list */ 2226 struct hlist_node list; 2227 2228 /** @name: name of the algorithm */ 2229 char *name; 2230 2231 /** @iface: callbacks related to interface handling */ 2232 struct batadv_algo_iface_ops iface; 2233 2234 /** @neigh: callbacks related to neighbors handling */ 2235 struct batadv_algo_neigh_ops neigh; 2236 2237 /** @orig: callbacks related to originators handling */ 2238 struct batadv_algo_orig_ops orig; 2239 2240 /** @gw: callbacks related to GW mode */ 2241 struct batadv_algo_gw_ops gw; 2242 }; 2243 2244 /** 2245 * struct batadv_dat_entry - it is a single entry of batman-adv ARP backend. It 2246 * is used to stored ARP entries needed for the global DAT cache 2247 */ 2248 struct batadv_dat_entry { 2249 /** @ip: the IPv4 corresponding to this DAT/ARP entry */ 2250 __be32 ip; 2251 2252 /** @mac_addr: the MAC address associated to the stored IPv4 */ 2253 u8 mac_addr[ETH_ALEN]; 2254 2255 /** @vid: the vlan ID associated to this entry */ 2256 unsigned short vid; 2257 2258 /** 2259 * @last_update: time in jiffies when this entry was refreshed last time 2260 */ 2261 unsigned long last_update; 2262 2263 /** @hash_entry: hlist node for &batadv_priv_dat.hash */ 2264 struct hlist_node hash_entry; 2265 2266 /** @refcount: number of contexts the object is used */ 2267 struct kref refcount; 2268 2269 /** @rcu: struct used for freeing in an RCU-safe manner */ 2270 struct rcu_head rcu; 2271 }; 2272 2273 /** 2274 * struct batadv_hw_addr - a list entry for a MAC address 2275 */ 2276 struct batadv_hw_addr { 2277 /** @list: list node for the linking of entries */ 2278 struct hlist_node list; 2279 2280 /** @addr: the MAC address of this list entry */ 2281 unsigned char addr[ETH_ALEN]; 2282 }; 2283 2284 /** 2285 * struct batadv_dat_candidate - candidate destination for DAT operations 2286 */ 2287 struct batadv_dat_candidate { 2288 /** 2289 * @type: the type of the selected candidate. It can one of the 2290 * following: 2291 * - BATADV_DAT_CANDIDATE_NOT_FOUND 2292 * - BATADV_DAT_CANDIDATE_ORIG 2293 */ 2294 int type; 2295 2296 /** 2297 * @orig_node: if type is BATADV_DAT_CANDIDATE_ORIG this field points to 2298 * the corresponding originator node structure 2299 */ 2300 struct batadv_orig_node *orig_node; 2301 }; 2302 2303 /** 2304 * struct batadv_tvlv_container - container for tvlv appended to OGMs 2305 */ 2306 struct batadv_tvlv_container { 2307 /** @list: hlist node for &batadv_priv_tvlv.container_list */ 2308 struct hlist_node list; 2309 2310 /** @tvlv_hdr: tvlv header information needed to construct the tvlv */ 2311 struct batadv_tvlv_hdr tvlv_hdr; 2312 2313 /** @refcount: number of contexts the object is used */ 2314 struct kref refcount; 2315 }; 2316 2317 /** 2318 * struct batadv_tvlv_handler - handler for specific tvlv type and version 2319 */ 2320 struct batadv_tvlv_handler { 2321 /** @list: hlist node for &batadv_priv_tvlv.handler_list */ 2322 struct hlist_node list; 2323 2324 /** 2325 * @ogm_handler: handler callback which is given the tvlv payload to 2326 * process on incoming OGM packets 2327 */ 2328 void (*ogm_handler)(struct batadv_priv *bat_priv, 2329 struct batadv_orig_node *orig, 2330 u8 flags, void *tvlv_value, u16 tvlv_value_len); 2331 2332 /** 2333 * @unicast_handler: handler callback which is given the tvlv payload to 2334 * process on incoming unicast tvlv packets 2335 */ 2336 int (*unicast_handler)(struct batadv_priv *bat_priv, 2337 u8 *src, u8 *dst, 2338 void *tvlv_value, u16 tvlv_value_len); 2339 2340 /** 2341 * @mcast_handler: handler callback which is given the tvlv payload to 2342 * process on incoming mcast packet 2343 */ 2344 int (*mcast_handler)(struct batadv_priv *bat_priv, struct sk_buff *skb); 2345 2346 /** @type: tvlv type this handler feels responsible for */ 2347 u8 type; 2348 2349 /** @version: tvlv version this handler feels responsible for */ 2350 u8 version; 2351 2352 /** @flags: tvlv handler flags */ 2353 u8 flags; 2354 2355 /** @refcount: number of contexts the object is used */ 2356 struct kref refcount; 2357 2358 /** @rcu: struct used for freeing in an RCU-safe manner */ 2359 struct rcu_head rcu; 2360 }; 2361 2362 /** 2363 * enum batadv_tvlv_handler_flags - tvlv handler flags definitions 2364 */ 2365 enum batadv_tvlv_handler_flags { 2366 /** 2367 * @BATADV_TVLV_HANDLER_OGM_CIFNOTFND: tvlv ogm processing function 2368 * will call this handler even if its type was not found (with no data) 2369 */ 2370 BATADV_TVLV_HANDLER_OGM_CIFNOTFND = BIT(1), 2371 2372 /** 2373 * @BATADV_TVLV_HANDLER_OGM_CALLED: interval tvlv handling flag - the 2374 * API marks a handler as being called, so it won't be called if the 2375 * BATADV_TVLV_HANDLER_OGM_CIFNOTFND flag was set 2376 */ 2377 BATADV_TVLV_HANDLER_OGM_CALLED = BIT(2), 2378 }; 2379 2380 #endif /* _NET_BATMAN_ADV_TYPES_H_ */ 2381