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