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