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