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