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