1 /* Copyright (C) 2007-2013 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
27 /* batadv_dat_addr_t is the type used for all DHT addresses. If it is changed,
28 * BATADV_DAT_ADDR_MAX is changed as well.
30 * *Please be careful: batadv_dat_addr_t must be UNSIGNED*
32 #define batadv_dat_addr_t uint16_t
34 #endif /* CONFIG_BATMAN_ADV_DAT */
37 * enum batadv_dhcp_recipient - dhcp destination
38 * @BATADV_DHCP_NO: packet is not a dhcp message
39 * @BATADV_DHCP_TO_SERVER: dhcp message is directed to a server
40 * @BATADV_DHCP_TO_CLIENT: dhcp message is directed to a client
42 enum batadv_dhcp_recipient {
44 BATADV_DHCP_TO_SERVER,
45 BATADV_DHCP_TO_CLIENT,
49 * BATADV_TT_REMOTE_MASK - bitmask selecting the flags that are sent over the
52 #define BATADV_TT_REMOTE_MASK 0x00FF
55 * BATADV_TT_SYNC_MASK - bitmask of the flags that need to be kept in sync
56 * among the nodes. These flags are used to compute the global/local CRC
58 #define BATADV_TT_SYNC_MASK 0x00F0
61 * struct batadv_hard_iface_bat_iv - per hard interface B.A.T.M.A.N. IV data
62 * @ogm_buff: buffer holding the OGM packet
63 * @ogm_buff_len: length of the OGM packet buffer
64 * @ogm_seqno: OGM sequence number - used to identify each OGM
66 struct batadv_hard_iface_bat_iv {
67 unsigned char *ogm_buff;
73 * struct batadv_hard_iface - network device known to batman-adv
74 * @list: list node for batadv_hardif_list
75 * @if_num: identificator of the interface
76 * @if_status: status of the interface for batman-adv
77 * @net_dev: pointer to the net_device
78 * @num_bcasts: number of payload re-broadcasts on this interface (ARQ)
79 * @hardif_obj: kobject of the per interface sysfs "mesh" directory
80 * @refcount: number of contexts the object is used
81 * @batman_adv_ptype: packet type describing packets that should be processed by
82 * batman-adv for this interface
83 * @soft_iface: the batman-adv interface which uses this network interface
84 * @rcu: struct used for freeing in an RCU-safe manner
85 * @bat_iv: BATMAN IV specific per hard interface data
86 * @cleanup_work: work queue callback item for hard interface deinit
88 struct batadv_hard_iface {
89 struct list_head list;
92 struct net_device *net_dev;
94 struct kobject *hardif_obj;
96 struct packet_type batman_adv_ptype;
97 struct net_device *soft_iface;
99 struct batadv_hard_iface_bat_iv bat_iv;
100 struct work_struct cleanup_work;
104 * struct batadv_frag_table_entry - head in the fragment buffer table
105 * @head: head of list with fragments
106 * @lock: lock to protect the list of fragments
107 * @timestamp: time (jiffie) of last received fragment
108 * @seqno: sequence number of the fragments in the list
109 * @size: accumulated size of packets in list
111 struct batadv_frag_table_entry {
112 struct hlist_head head;
113 spinlock_t lock; /* protects head */
114 unsigned long timestamp;
120 * struct batadv_frag_list_entry - entry in a list of fragments
121 * @list: list node information
123 * @no: fragment number in the set
125 struct batadv_frag_list_entry {
126 struct hlist_node list;
132 * struct batadv_vlan_tt - VLAN specific TT attributes
133 * @crc: CRC32 checksum of the entries belonging to this vlan
134 * @num_entries: number of TT entries for this VLAN
136 struct batadv_vlan_tt {
138 atomic_t num_entries;
142 * batadv_orig_node_vlan - VLAN specific data per orig_node
143 * @vid: the VLAN identifier
144 * @tt: VLAN specific TT attributes
145 * @list: list node for orig_node::vlan_list
146 * @refcount: number of context where this object is currently in use
147 * @rcu: struct used for freeing in a RCU-safe manner
149 struct batadv_orig_node_vlan {
151 struct batadv_vlan_tt tt;
152 struct list_head list;
158 * struct batadv_orig_bat_iv - B.A.T.M.A.N. IV private orig_node members
159 * @bcast_own: bitfield containing the number of our OGMs this orig_node
160 * rebroadcasted "back" to us (relative to last_real_seqno)
161 * @bcast_own_sum: counted result of bcast_own
162 * @ogm_cnt_lock: lock protecting bcast_own, bcast_own_sum,
163 * neigh_node->bat_iv.real_bits & neigh_node->bat_iv.real_packet_count
165 struct batadv_orig_bat_iv {
166 unsigned long *bcast_own;
167 uint8_t *bcast_own_sum;
168 /* ogm_cnt_lock protects: bcast_own, bcast_own_sum,
169 * neigh_node->bat_iv.real_bits & neigh_node->bat_iv.real_packet_count
171 spinlock_t ogm_cnt_lock;
175 * struct batadv_orig_node - structure for orig_list maintaining nodes of mesh
176 * @orig: originator ethernet address
177 * @primary_addr: hosts primary interface address
178 * @router: router that should be used to reach this originator
179 * @batadv_dat_addr_t: address of the orig node in the distributed hash
180 * @last_seen: time when last packet from this node was received
181 * @bcast_seqno_reset: time when the broadcast seqno window was reset
182 * @batman_seqno_reset: time when the batman seqno window was reset
183 * @capabilities: announced capabilities of this originator
184 * @last_ttvn: last seen translation table version number
185 * @tt_buff: last tt changeset this node received from the orig node
186 * @tt_buff_len: length of the last tt changeset this node received from the
188 * @tt_buff_lock: lock that protects tt_buff and tt_buff_len
189 * @tt_initialised: bool keeping track of whether or not this node have received
190 * any translation table information from the orig node yet
191 * @tt_lock: prevents from updating the table while reading it. Table update is
192 * made up by two operations (data structure update and metdata -CRC/TTVN-
193 * recalculation) and they have to be executed atomically in order to avoid
194 * another thread to read the table/metadata between those.
195 * @last_real_seqno: last and best known sequence number
196 * @last_ttl: ttl of last received packet
197 * @bcast_bits: bitfield containing the info which payload broadcast originated
198 * from this orig node this host already has seen (relative to
200 * @last_bcast_seqno: last broadcast sequence number received by this host
201 * @neigh_list: list of potential next hop neighbor towards this orig node
202 * @neigh_list_lock: lock protecting neigh_list and router
203 * @hash_entry: hlist node for batadv_priv::orig_hash
204 * @bat_priv: pointer to soft_iface this orig node belongs to
205 * @bcast_seqno_lock: lock protecting bcast_bits & last_bcast_seqno
206 * @refcount: number of contexts the object is used
207 * @rcu: struct used for freeing in an RCU-safe manner
208 * @in_coding_list: list of nodes this orig can hear
209 * @out_coding_list: list of nodes that can hear this orig
210 * @in_coding_list_lock: protects in_coding_list
211 * @out_coding_list_lock: protects out_coding_list
212 * @fragments: array with heads for fragment chains
213 * @vlan_list: a list of orig_node_vlan structs, one per VLAN served by the
214 * originator represented by this object
215 * @vlan_list_lock: lock protecting vlan_list
216 * @bat_iv: B.A.T.M.A.N. IV private structure
218 struct batadv_orig_node {
219 uint8_t orig[ETH_ALEN];
220 uint8_t primary_addr[ETH_ALEN];
221 struct batadv_neigh_node __rcu *router; /* rcu protected pointer */
222 #ifdef CONFIG_BATMAN_ADV_DAT
223 batadv_dat_addr_t dat_addr;
225 unsigned long last_seen;
226 unsigned long bcast_seqno_reset;
227 unsigned long batman_seqno_reset;
228 uint8_t capabilities;
230 unsigned char *tt_buff;
232 spinlock_t tt_buff_lock; /* protects tt_buff & tt_buff_len */
234 /* prevents from changing the table while reading it */
236 uint32_t last_real_seqno;
238 DECLARE_BITMAP(bcast_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
239 uint32_t last_bcast_seqno;
240 struct hlist_head neigh_list;
241 /* neigh_list_lock protects: neigh_list and router */
242 spinlock_t neigh_list_lock;
243 struct hlist_node hash_entry;
244 struct batadv_priv *bat_priv;
245 /* bcast_seqno_lock protects: bcast_bits & last_bcast_seqno */
246 spinlock_t bcast_seqno_lock;
249 #ifdef CONFIG_BATMAN_ADV_NC
250 struct list_head in_coding_list;
251 struct list_head out_coding_list;
252 spinlock_t in_coding_list_lock; /* Protects in_coding_list */
253 spinlock_t out_coding_list_lock; /* Protects out_coding_list */
255 struct batadv_frag_table_entry fragments[BATADV_FRAG_BUFFER_COUNT];
256 struct list_head vlan_list;
257 spinlock_t vlan_list_lock; /* protects vlan_list */
258 struct batadv_orig_bat_iv bat_iv;
262 * enum batadv_orig_capabilities - orig node capabilities
263 * @BATADV_ORIG_CAPA_HAS_DAT: orig node has distributed arp table enabled
264 * @BATADV_ORIG_CAPA_HAS_NC: orig node has network coding enabled
266 enum batadv_orig_capabilities {
267 BATADV_ORIG_CAPA_HAS_DAT = BIT(0),
268 BATADV_ORIG_CAPA_HAS_NC = BIT(1),
272 * struct batadv_gw_node - structure for orig nodes announcing gw capabilities
273 * @list: list node for batadv_priv_gw::list
274 * @orig_node: pointer to corresponding orig node
275 * @bandwidth_down: advertised uplink download bandwidth
276 * @bandwidth_up: advertised uplink upload bandwidth
277 * @deleted: this struct is scheduled for deletion
278 * @refcount: number of contexts the object is used
279 * @rcu: struct used for freeing in an RCU-safe manner
281 struct batadv_gw_node {
282 struct hlist_node list;
283 struct batadv_orig_node *orig_node;
284 uint32_t bandwidth_down;
285 uint32_t bandwidth_up;
286 unsigned long deleted;
292 * struct batadv_neigh_node - structure for single hops neighbors
293 * @list: list node for batadv_orig_node::neigh_list
294 * @orig_node: pointer to corresponding orig_node
295 * @addr: the MAC address of the neighboring interface
296 * @ifinfo_list: list for routing metrics per outgoing interface
297 * @ifinfo_lock: lock protecting private ifinfo members and list
298 * @if_incoming: pointer to incoming hard interface
299 * @last_seen: when last packet via this neighbor was received
300 * @last_ttl: last received ttl from this neigh node
301 * @rcu: struct used for freeing in an RCU-safe manner
302 * @bat_iv: B.A.T.M.A.N. IV private structure
304 struct batadv_neigh_node {
305 struct hlist_node list;
306 struct batadv_orig_node *orig_node;
307 uint8_t addr[ETH_ALEN];
308 struct hlist_head ifinfo_list;
309 spinlock_t ifinfo_lock; /* protects ifinfo_list and its members */
310 struct batadv_hard_iface *if_incoming;
311 unsigned long last_seen;
316 /* struct batadv_neigh_node_bat_iv - neighbor information per outgoing
317 * interface for BATMAN IV
318 * @tq_recv: ring buffer of received TQ values from this neigh node
319 * @tq_index: ring buffer index
320 * @tq_avg: averaged tq of all tq values in the ring buffer (tq_recv)
321 * @real_bits: bitfield containing the number of OGMs received from this neigh
322 * node (relative to orig_node->last_real_seqno)
323 * @real_packet_count: counted result of real_bits
325 struct batadv_neigh_ifinfo_bat_iv {
326 uint8_t tq_recv[BATADV_TQ_GLOBAL_WINDOW_SIZE];
329 DECLARE_BITMAP(real_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
330 uint8_t real_packet_count;
333 /* struct batadv_neigh_ifinfo - neighbor information per outgoing interface
334 * @list: list node for batadv_neigh_node::ifinfo_list
335 * @if_outgoing: pointer to outgoing hard interface
336 * @bat_iv: B.A.T.M.A.N. IV private structure
337 * @last_ttl: last received ttl from this neigh node
338 * @refcount: number of contexts the object is used
339 * @rcu: struct used for freeing in a RCU-safe manner
341 struct batadv_neigh_ifinfo {
342 struct hlist_node list;
343 struct batadv_hard_iface *if_outgoing;
344 struct batadv_neigh_ifinfo_bat_iv bat_iv;
351 * struct batadv_bcast_duplist_entry - structure for LAN broadcast suppression
352 * @orig[ETH_ALEN]: mac address of orig node orginating the broadcast
353 * @crc: crc32 checksum of broadcast payload
354 * @entrytime: time when the broadcast packet was received
356 #ifdef CONFIG_BATMAN_ADV_BLA
357 struct batadv_bcast_duplist_entry {
358 uint8_t orig[ETH_ALEN];
360 unsigned long entrytime;
365 * enum batadv_counters - indices for traffic counters
366 * @BATADV_CNT_TX: transmitted payload traffic packet counter
367 * @BATADV_CNT_TX_BYTES: transmitted payload traffic bytes counter
368 * @BATADV_CNT_TX_DROPPED: dropped transmission payload traffic packet counter
369 * @BATADV_CNT_RX: received payload traffic packet counter
370 * @BATADV_CNT_RX_BYTES: received payload traffic bytes counter
371 * @BATADV_CNT_FORWARD: forwarded payload traffic packet counter
372 * @BATADV_CNT_FORWARD_BYTES: forwarded payload traffic bytes counter
373 * @BATADV_CNT_MGMT_TX: transmitted routing protocol traffic packet counter
374 * @BATADV_CNT_MGMT_TX_BYTES: transmitted routing protocol traffic bytes counter
375 * @BATADV_CNT_MGMT_RX: received routing protocol traffic packet counter
376 * @BATADV_CNT_MGMT_RX_BYTES: received routing protocol traffic bytes counter
377 * @BATADV_CNT_FRAG_TX: transmitted fragment traffic packet counter
378 * @BATADV_CNT_FRAG_TX_BYTES: transmitted fragment traffic bytes counter
379 * @BATADV_CNT_FRAG_RX: received fragment traffic packet counter
380 * @BATADV_CNT_FRAG_RX_BYTES: received fragment traffic bytes counter
381 * @BATADV_CNT_FRAG_FWD: forwarded fragment traffic packet counter
382 * @BATADV_CNT_FRAG_FWD_BYTES: forwarded fragment traffic bytes counter
383 * @BATADV_CNT_TT_REQUEST_TX: transmitted tt req traffic packet counter
384 * @BATADV_CNT_TT_REQUEST_RX: received tt req traffic packet counter
385 * @BATADV_CNT_TT_RESPONSE_TX: transmitted tt resp traffic packet counter
386 * @BATADV_CNT_TT_RESPONSE_RX: received tt resp traffic packet counter
387 * @BATADV_CNT_TT_ROAM_ADV_TX: transmitted tt roam traffic packet counter
388 * @BATADV_CNT_TT_ROAM_ADV_RX: received tt roam traffic packet counter
389 * @BATADV_CNT_DAT_GET_TX: transmitted dht GET traffic packet counter
390 * @BATADV_CNT_DAT_GET_RX: received dht GET traffic packet counter
391 * @BATADV_CNT_DAT_PUT_TX: transmitted dht PUT traffic packet counter
392 * @BATADV_CNT_DAT_PUT_RX: received dht PUT traffic packet counter
393 * @BATADV_CNT_DAT_CACHED_REPLY_TX: transmitted dat cache reply traffic packet
395 * @BATADV_CNT_NC_CODE: transmitted nc-combined traffic packet counter
396 * @BATADV_CNT_NC_CODE_BYTES: transmitted nc-combined traffic bytes counter
397 * @BATADV_CNT_NC_RECODE: transmitted nc-recombined traffic packet counter
398 * @BATADV_CNT_NC_RECODE_BYTES: transmitted nc-recombined traffic bytes counter
399 * @BATADV_CNT_NC_BUFFER: counter for packets buffered for later nc decoding
400 * @BATADV_CNT_NC_DECODE: received and nc-decoded traffic packet counter
401 * @BATADV_CNT_NC_DECODE_BYTES: received and nc-decoded traffic bytes counter
402 * @BATADV_CNT_NC_DECODE_FAILED: received and decode-failed traffic packet
404 * @BATADV_CNT_NC_SNIFFED: counter for nc-decoded packets received in promisc
406 * @BATADV_CNT_NUM: number of traffic counters
408 enum batadv_counters {
411 BATADV_CNT_TX_DROPPED,
415 BATADV_CNT_FORWARD_BYTES,
417 BATADV_CNT_MGMT_TX_BYTES,
419 BATADV_CNT_MGMT_RX_BYTES,
421 BATADV_CNT_FRAG_TX_BYTES,
423 BATADV_CNT_FRAG_RX_BYTES,
425 BATADV_CNT_FRAG_FWD_BYTES,
426 BATADV_CNT_TT_REQUEST_TX,
427 BATADV_CNT_TT_REQUEST_RX,
428 BATADV_CNT_TT_RESPONSE_TX,
429 BATADV_CNT_TT_RESPONSE_RX,
430 BATADV_CNT_TT_ROAM_ADV_TX,
431 BATADV_CNT_TT_ROAM_ADV_RX,
432 #ifdef CONFIG_BATMAN_ADV_DAT
433 BATADV_CNT_DAT_GET_TX,
434 BATADV_CNT_DAT_GET_RX,
435 BATADV_CNT_DAT_PUT_TX,
436 BATADV_CNT_DAT_PUT_RX,
437 BATADV_CNT_DAT_CACHED_REPLY_TX,
439 #ifdef CONFIG_BATMAN_ADV_NC
441 BATADV_CNT_NC_CODE_BYTES,
442 BATADV_CNT_NC_RECODE,
443 BATADV_CNT_NC_RECODE_BYTES,
444 BATADV_CNT_NC_BUFFER,
445 BATADV_CNT_NC_DECODE,
446 BATADV_CNT_NC_DECODE_BYTES,
447 BATADV_CNT_NC_DECODE_FAILED,
448 BATADV_CNT_NC_SNIFFED,
454 * struct batadv_priv_tt - per mesh interface translation table data
455 * @vn: translation table version number
456 * @ogm_append_cnt: counter of number of OGMs containing the local tt diff
457 * @local_changes: changes registered in an originator interval
458 * @changes_list: tracks tt local changes within an originator interval
459 * @local_hash: local translation table hash table
460 * @global_hash: global translation table hash table
461 * @req_list: list of pending & unanswered tt_requests
462 * @roam_list: list of the last roaming events of each client limiting the
463 * number of roaming events to avoid route flapping
464 * @changes_list_lock: lock protecting changes_list
465 * @req_list_lock: lock protecting req_list
466 * @roam_list_lock: lock protecting roam_list
467 * @last_changeset: last tt changeset this host has generated
468 * @last_changeset_len: length of last tt changeset this host has generated
469 * @last_changeset_lock: lock protecting last_changeset & last_changeset_len
470 * @commit_lock: prevents from executing a local TT commit while reading the
471 * local table. The local TT commit is made up by two operations (data
472 * structure update and metdata -CRC/TTVN- recalculation) and they have to be
473 * executed atomically in order to avoid another thread to read the
474 * table/metadata between those.
475 * @work: work queue callback item for translation table purging
477 struct batadv_priv_tt {
479 atomic_t ogm_append_cnt;
480 atomic_t local_changes;
481 struct list_head changes_list;
482 struct batadv_hashtable *local_hash;
483 struct batadv_hashtable *global_hash;
484 struct list_head req_list;
485 struct list_head roam_list;
486 spinlock_t changes_list_lock; /* protects changes */
487 spinlock_t req_list_lock; /* protects req_list */
488 spinlock_t roam_list_lock; /* protects roam_list */
489 unsigned char *last_changeset;
490 int16_t last_changeset_len;
491 /* protects last_changeset & last_changeset_len */
492 spinlock_t last_changeset_lock;
493 /* prevents from executing a commit while reading the table */
494 spinlock_t commit_lock;
495 struct delayed_work work;
499 * struct batadv_priv_bla - per mesh interface bridge loope avoidance data
500 * @num_requests; number of bla requests in flight
501 * @claim_hash: hash table containing mesh nodes this host has claimed
502 * @backbone_hash: hash table containing all detected backbone gateways
503 * @bcast_duplist: recently received broadcast packets array (for broadcast
504 * duplicate suppression)
505 * @bcast_duplist_curr: index of last broadcast packet added to bcast_duplist
506 * @bcast_duplist_lock: lock protecting bcast_duplist & bcast_duplist_curr
507 * @claim_dest: local claim data (e.g. claim group)
508 * @work: work queue callback item for cleanups & bla announcements
510 #ifdef CONFIG_BATMAN_ADV_BLA
511 struct batadv_priv_bla {
512 atomic_t num_requests;
513 struct batadv_hashtable *claim_hash;
514 struct batadv_hashtable *backbone_hash;
515 struct batadv_bcast_duplist_entry bcast_duplist[BATADV_DUPLIST_SIZE];
516 int bcast_duplist_curr;
517 /* protects bcast_duplist & bcast_duplist_curr */
518 spinlock_t bcast_duplist_lock;
519 struct batadv_bla_claim_dst claim_dest;
520 struct delayed_work work;
525 * struct batadv_debug_log - debug logging data
526 * @log_buff: buffer holding the logs (ring bufer)
527 * @log_start: index of next character to read
528 * @log_end: index of next character to write
529 * @lock: lock protecting log_buff, log_start & log_end
530 * @queue_wait: log reader's wait queue
532 #ifdef CONFIG_BATMAN_ADV_DEBUG
533 struct batadv_priv_debug_log {
534 char log_buff[BATADV_LOG_BUF_LEN];
535 unsigned long log_start;
536 unsigned long log_end;
537 spinlock_t lock; /* protects log_buff, log_start and log_end */
538 wait_queue_head_t queue_wait;
543 * struct batadv_priv_gw - per mesh interface gateway data
544 * @list: list of available gateway nodes
545 * @list_lock: lock protecting gw_list & curr_gw
546 * @curr_gw: pointer to currently selected gateway node
547 * @bandwidth_down: advertised uplink download bandwidth (if gw_mode server)
548 * @bandwidth_up: advertised uplink upload bandwidth (if gw_mode server)
549 * @reselect: bool indicating a gateway re-selection is in progress
551 struct batadv_priv_gw {
552 struct hlist_head list;
553 spinlock_t list_lock; /* protects gw_list & curr_gw */
554 struct batadv_gw_node __rcu *curr_gw; /* rcu protected pointer */
555 atomic_t bandwidth_down;
556 atomic_t bandwidth_up;
561 * struct batadv_priv_tvlv - per mesh interface tvlv data
562 * @container_list: list of registered tvlv containers to be sent with each OGM
563 * @handler_list: list of the various tvlv content handlers
564 * @container_list_lock: protects tvlv container list access
565 * @handler_list_lock: protects handler list access
567 struct batadv_priv_tvlv {
568 struct hlist_head container_list;
569 struct hlist_head handler_list;
570 spinlock_t container_list_lock; /* protects container_list */
571 spinlock_t handler_list_lock; /* protects handler_list */
575 * struct batadv_priv_dat - per mesh interface DAT private data
576 * @addr: node DAT address
577 * @hash: hashtable representing the local ARP cache
578 * @work: work queue callback item for cache purging
580 #ifdef CONFIG_BATMAN_ADV_DAT
581 struct batadv_priv_dat {
582 batadv_dat_addr_t addr;
583 struct batadv_hashtable *hash;
584 struct delayed_work work;
589 * struct batadv_priv_nc - per mesh interface network coding private data
590 * @work: work queue callback item for cleanup
591 * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
592 * @min_tq: only consider neighbors for encoding if neigh_tq > min_tq
593 * @max_fwd_delay: maximum packet forward delay to allow coding of packets
594 * @max_buffer_time: buffer time for sniffed packets used to decoding
595 * @timestamp_fwd_flush: timestamp of last forward packet queue flush
596 * @timestamp_sniffed_purge: timestamp of last sniffed packet queue purge
597 * @coding_hash: Hash table used to buffer skbs while waiting for another
598 * incoming skb to code it with. Skbs are added to the buffer just before being
599 * forwarded in routing.c
600 * @decoding_hash: Hash table used to buffer skbs that might be needed to decode
601 * a received coded skb. The buffer is used for 1) skbs arriving on the
602 * soft-interface; 2) skbs overheard on the hard-interface; and 3) skbs
603 * forwarded by batman-adv.
605 struct batadv_priv_nc {
606 struct delayed_work work;
607 struct dentry *debug_dir;
611 unsigned long timestamp_fwd_flush;
612 unsigned long timestamp_sniffed_purge;
613 struct batadv_hashtable *coding_hash;
614 struct batadv_hashtable *decoding_hash;
618 * struct batadv_softif_vlan - per VLAN attributes set
619 * @vid: VLAN identifier
620 * @kobj: kobject for sysfs vlan subdirectory
621 * @ap_isolation: AP isolation state
622 * @tt: TT private attributes (VLAN specific)
623 * @list: list node for bat_priv::softif_vlan_list
624 * @refcount: number of context where this object is currently in use
625 * @rcu: struct used for freeing in a RCU-safe manner
627 struct batadv_softif_vlan {
629 struct kobject *kobj;
630 atomic_t ap_isolation; /* boolean */
631 struct batadv_vlan_tt tt;
632 struct hlist_node list;
638 * struct batadv_priv - per mesh interface data
639 * @mesh_state: current status of the mesh (inactive/active/deactivating)
640 * @soft_iface: net device which holds this struct as private data
641 * @stats: structure holding the data for the ndo_get_stats() call
642 * @bat_counters: mesh internal traffic statistic counters (see batadv_counters)
643 * @aggregated_ogms: bool indicating whether OGM aggregation is enabled
644 * @bonding: bool indicating whether traffic bonding is enabled
645 * @fragmentation: bool indicating whether traffic fragmentation is enabled
646 * @packet_size_max: max packet size that can be transmitted via
647 * multiple fragmented skbs or a single frame if fragmentation is disabled
648 * @frag_seqno: incremental counter to identify chains of egress fragments
649 * @bridge_loop_avoidance: bool indicating whether bridge loop avoidance is
651 * @distributed_arp_table: bool indicating whether distributed ARP table is
653 * @gw_mode: gateway operation: off, client or server (see batadv_gw_modes)
654 * @gw_sel_class: gateway selection class (applies if gw_mode client)
655 * @orig_interval: OGM broadcast interval in milliseconds
656 * @hop_penalty: penalty which will be applied to an OGM's tq-field on every hop
657 * @log_level: configured log level (see batadv_dbg_level)
658 * @bcast_seqno: last sent broadcast packet sequence number
659 * @bcast_queue_left: number of remaining buffered broadcast packet slots
660 * @batman_queue_left: number of remaining OGM packet slots
661 * @num_ifaces: number of interfaces assigned to this mesh interface
662 * @mesh_obj: kobject for sysfs mesh subdirectory
663 * @debug_dir: dentry for debugfs batman-adv subdirectory
664 * @forw_bat_list: list of aggregated OGMs that will be forwarded
665 * @forw_bcast_list: list of broadcast packets that will be rebroadcasted
666 * @orig_hash: hash table containing mesh participants (orig nodes)
667 * @forw_bat_list_lock: lock protecting forw_bat_list
668 * @forw_bcast_list_lock: lock protecting forw_bcast_list
669 * @orig_work: work queue callback item for orig node purging
670 * @cleanup_work: work queue callback item for soft interface deinit
671 * @primary_if: one of the hard interfaces assigned to this mesh interface
672 * becomes the primary interface
673 * @bat_algo_ops: routing algorithm used by this mesh interface
674 * @softif_vlan_list: a list of softif_vlan structs, one per VLAN created on top
675 * of the mesh interface represented by this object
676 * @softif_vlan_list_lock: lock protecting softif_vlan_list
677 * @bla: bridge loope avoidance data
678 * @debug_log: holding debug logging relevant data
680 * @tt: translation table data
681 * @tvlv: type-version-length-value data
682 * @dat: distributed arp table data
683 * @network_coding: bool indicating whether network coding is enabled
684 * @batadv_priv_nc: network coding data
688 struct net_device *soft_iface;
689 struct net_device_stats stats;
690 uint64_t __percpu *bat_counters; /* Per cpu counters */
691 atomic_t aggregated_ogms;
693 atomic_t fragmentation;
694 atomic_t packet_size_max;
696 #ifdef CONFIG_BATMAN_ADV_BLA
697 atomic_t bridge_loop_avoidance;
699 #ifdef CONFIG_BATMAN_ADV_DAT
700 atomic_t distributed_arp_table;
703 atomic_t gw_sel_class;
704 atomic_t orig_interval;
705 atomic_t hop_penalty;
706 #ifdef CONFIG_BATMAN_ADV_DEBUG
709 uint32_t isolation_mark;
710 uint32_t isolation_mark_mask;
711 atomic_t bcast_seqno;
712 atomic_t bcast_queue_left;
713 atomic_t batman_queue_left;
715 struct kobject *mesh_obj;
716 struct dentry *debug_dir;
717 struct hlist_head forw_bat_list;
718 struct hlist_head forw_bcast_list;
719 struct batadv_hashtable *orig_hash;
720 spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
721 spinlock_t forw_bcast_list_lock; /* protects forw_bcast_list */
722 struct delayed_work orig_work;
723 struct work_struct cleanup_work;
724 struct batadv_hard_iface __rcu *primary_if; /* rcu protected pointer */
725 struct batadv_algo_ops *bat_algo_ops;
726 struct hlist_head softif_vlan_list;
727 spinlock_t softif_vlan_list_lock; /* protects softif_vlan_list */
728 #ifdef CONFIG_BATMAN_ADV_BLA
729 struct batadv_priv_bla bla;
731 #ifdef CONFIG_BATMAN_ADV_DEBUG
732 struct batadv_priv_debug_log *debug_log;
734 struct batadv_priv_gw gw;
735 struct batadv_priv_tt tt;
736 struct batadv_priv_tvlv tvlv;
737 #ifdef CONFIG_BATMAN_ADV_DAT
738 struct batadv_priv_dat dat;
740 #ifdef CONFIG_BATMAN_ADV_NC
741 atomic_t network_coding;
742 struct batadv_priv_nc nc;
743 #endif /* CONFIG_BATMAN_ADV_NC */
747 * struct batadv_socket_client - layer2 icmp socket client data
748 * @queue_list: packet queue for packets destined for this socket client
749 * @queue_len: number of packets in the packet queue (queue_list)
750 * @index: socket client's index in the batadv_socket_client_hash
751 * @lock: lock protecting queue_list, queue_len & index
752 * @queue_wait: socket client's wait queue
753 * @bat_priv: pointer to soft_iface this client belongs to
755 struct batadv_socket_client {
756 struct list_head queue_list;
757 unsigned int queue_len;
759 spinlock_t lock; /* protects queue_list, queue_len & index */
760 wait_queue_head_t queue_wait;
761 struct batadv_priv *bat_priv;
765 * struct batadv_socket_packet - layer2 icmp packet for socket client
766 * @list: list node for batadv_socket_client::queue_list
767 * @icmp_len: size of the layer2 icmp packet
768 * @icmp_packet: layer2 icmp packet
770 struct batadv_socket_packet {
771 struct list_head list;
773 uint8_t icmp_packet[BATADV_ICMP_MAX_PACKET_SIZE];
777 * struct batadv_bla_backbone_gw - batman-adv gateway bridged into the LAN
778 * @orig: originator address of backbone node (mac address of primary iface)
779 * @vid: vlan id this gateway was detected on
780 * @hash_entry: hlist node for batadv_priv_bla::backbone_hash
781 * @bat_priv: pointer to soft_iface this backbone gateway belongs to
782 * @lasttime: last time we heard of this backbone gw
783 * @wait_periods: grace time for bridge forward delays and bla group forming at
784 * bootup phase - no bcast traffic is formwared until it has elapsed
785 * @request_sent: if this bool is set to true we are out of sync with this
786 * backbone gateway - no bcast traffic is formwared until the situation was
788 * @crc: crc16 checksum over all claims
789 * @refcount: number of contexts the object is used
790 * @rcu: struct used for freeing in an RCU-safe manner
792 #ifdef CONFIG_BATMAN_ADV_BLA
793 struct batadv_bla_backbone_gw {
794 uint8_t orig[ETH_ALEN];
796 struct hlist_node hash_entry;
797 struct batadv_priv *bat_priv;
798 unsigned long lasttime;
799 atomic_t wait_periods;
800 atomic_t request_sent;
807 * struct batadv_bla_claim - claimed non-mesh client structure
808 * @addr: mac address of claimed non-mesh client
809 * @vid: vlan id this client was detected on
810 * @batadv_bla_backbone_gw: pointer to backbone gw claiming this client
811 * @lasttime: last time we heard of claim (locals only)
812 * @hash_entry: hlist node for batadv_priv_bla::claim_hash
813 * @refcount: number of contexts the object is used
814 * @rcu: struct used for freeing in an RCU-safe manner
816 struct batadv_bla_claim {
817 uint8_t addr[ETH_ALEN];
819 struct batadv_bla_backbone_gw *backbone_gw;
820 unsigned long lasttime;
821 struct hlist_node hash_entry;
828 * struct batadv_tt_common_entry - tt local & tt global common data
829 * @addr: mac address of non-mesh client
830 * @vid: VLAN identifier
831 * @hash_entry: hlist node for batadv_priv_tt::local_hash or for
832 * batadv_priv_tt::global_hash
833 * @flags: various state handling flags (see batadv_tt_client_flags)
834 * @added_at: timestamp used for purging stale tt common entries
835 * @refcount: number of contexts the object is used
836 * @rcu: struct used for freeing in an RCU-safe manner
838 struct batadv_tt_common_entry {
839 uint8_t addr[ETH_ALEN];
841 struct hlist_node hash_entry;
843 unsigned long added_at;
849 * struct batadv_tt_local_entry - translation table local entry data
850 * @common: general translation table data
851 * @last_seen: timestamp used for purging stale tt local entries
853 struct batadv_tt_local_entry {
854 struct batadv_tt_common_entry common;
855 unsigned long last_seen;
859 * struct batadv_tt_global_entry - translation table global entry data
860 * @common: general translation table data
861 * @orig_list: list of orig nodes announcing this non-mesh client
862 * @list_lock: lock protecting orig_list
863 * @roam_at: time at which TT_GLOBAL_ROAM was set
865 struct batadv_tt_global_entry {
866 struct batadv_tt_common_entry common;
867 struct hlist_head orig_list;
868 spinlock_t list_lock; /* protects orig_list */
869 unsigned long roam_at;
873 * struct batadv_tt_orig_list_entry - orig node announcing a non-mesh client
874 * @orig_node: pointer to orig node announcing this non-mesh client
875 * @ttvn: translation table version number which added the non-mesh client
876 * @list: list node for batadv_tt_global_entry::orig_list
877 * @refcount: number of contexts the object is used
878 * @rcu: struct used for freeing in an RCU-safe manner
880 struct batadv_tt_orig_list_entry {
881 struct batadv_orig_node *orig_node;
883 struct hlist_node list;
889 * struct batadv_tt_change_node - structure for tt changes occured
890 * @list: list node for batadv_priv_tt::changes_list
891 * @change: holds the actual translation table diff data
893 struct batadv_tt_change_node {
894 struct list_head list;
895 struct batadv_tvlv_tt_change change;
899 * struct batadv_tt_req_node - data to keep track of the tt requests in flight
900 * @addr: mac address address of the originator this request was sent to
901 * @issued_at: timestamp used for purging stale tt requests
902 * @list: list node for batadv_priv_tt::req_list
904 struct batadv_tt_req_node {
905 uint8_t addr[ETH_ALEN];
906 unsigned long issued_at;
907 struct list_head list;
911 * struct batadv_tt_roam_node - roaming client data
912 * @addr: mac address of the client in the roaming phase
913 * @counter: number of allowed roaming events per client within a single
914 * OGM interval (changes are committed with each OGM)
915 * @first_time: timestamp used for purging stale roaming node entries
916 * @list: list node for batadv_priv_tt::roam_list
918 struct batadv_tt_roam_node {
919 uint8_t addr[ETH_ALEN];
921 unsigned long first_time;
922 struct list_head list;
926 * struct batadv_nc_node - network coding node
927 * @list: next and prev pointer for the list handling
928 * @addr: the node's mac address
929 * @refcount: number of contexts the object is used by
930 * @rcu: struct used for freeing in an RCU-safe manner
931 * @orig_node: pointer to corresponding orig node struct
932 * @last_seen: timestamp of last ogm received from this node
934 struct batadv_nc_node {
935 struct list_head list;
936 uint8_t addr[ETH_ALEN];
939 struct batadv_orig_node *orig_node;
940 unsigned long last_seen;
944 * struct batadv_nc_path - network coding path
945 * @hash_entry: next and prev pointer for the list handling
946 * @rcu: struct used for freeing in an RCU-safe manner
947 * @refcount: number of contexts the object is used by
948 * @packet_list: list of buffered packets for this path
949 * @packet_list_lock: access lock for packet list
950 * @next_hop: next hop (destination) of path
951 * @prev_hop: previous hop (source) of path
952 * @last_valid: timestamp for last validation of path
954 struct batadv_nc_path {
955 struct hlist_node hash_entry;
958 struct list_head packet_list;
959 spinlock_t packet_list_lock; /* Protects packet_list */
960 uint8_t next_hop[ETH_ALEN];
961 uint8_t prev_hop[ETH_ALEN];
962 unsigned long last_valid;
966 * struct batadv_nc_packet - network coding packet used when coding and
968 * @list: next and prev pointer for the list handling
969 * @packet_id: crc32 checksum of skb data
970 * @timestamp: field containing the info when the packet was added to path
971 * @neigh_node: pointer to original next hop neighbor of skb
972 * @skb: skb which can be encoded or used for decoding
973 * @nc_path: pointer to path this nc packet is attached to
975 struct batadv_nc_packet {
976 struct list_head list;
978 unsigned long timestamp;
979 struct batadv_neigh_node *neigh_node;
981 struct batadv_nc_path *nc_path;
985 * batadv_skb_cb - control buffer structure used to store private data relevant
986 * to batman-adv in the skb->cb buffer in skbs.
987 * @decoded: Marks a skb as decoded, which is checked when searching for coding
988 * opportunities in network-coding.c
990 struct batadv_skb_cb {
995 * struct batadv_forw_packet - structure for bcast packets to be sent/forwarded
996 * @list: list node for batadv_socket_client::queue_list
997 * @send_time: execution time for delayed_work (packet sending)
998 * @own: bool for locally generated packets (local OGMs are re-scheduled after
1000 * @skb: bcast packet's skb buffer
1001 * @packet_len: size of aggregated OGM packet inside the skb buffer
1002 * @direct_link_flags: direct link flags for aggregated OGM packets
1003 * @num_packets: counter for bcast packet retransmission
1004 * @delayed_work: work queue callback item for packet sending
1005 * @if_incoming: pointer incoming hard-iface or primary iface if locally
1008 struct batadv_forw_packet {
1009 struct hlist_node list;
1010 unsigned long send_time;
1012 struct sk_buff *skb;
1013 uint16_t packet_len;
1014 uint32_t direct_link_flags;
1015 uint8_t num_packets;
1016 struct delayed_work delayed_work;
1017 struct batadv_hard_iface *if_incoming;
1021 * struct batadv_algo_ops - mesh algorithm callbacks
1022 * @list: list node for the batadv_algo_list
1023 * @name: name of the algorithm
1024 * @bat_iface_enable: init routing info when hard-interface is enabled
1025 * @bat_iface_disable: de-init routing info when hard-interface is disabled
1026 * @bat_iface_update_mac: (re-)init mac addresses of the protocol information
1027 * belonging to this hard-interface
1028 * @bat_primary_iface_set: called when primary interface is selected / changed
1029 * @bat_ogm_schedule: prepare a new outgoing OGM for the send queue
1030 * @bat_ogm_emit: send scheduled OGM
1031 * @bat_neigh_cmp: compare the metrics of two neighbors for their respective
1032 * outgoing interfaces
1033 * @bat_neigh_is_equiv_or_better: check if neigh1 is equally good or better
1034 * than neigh2 for their respective outgoing interface from the metric
1036 * @bat_orig_print: print the originator table (optional)
1037 * @bat_orig_free: free the resources allocated by the routing algorithm for an
1039 * @bat_orig_add_if: ask the routing algorithm to apply the needed changes to
1040 * the orig_node due to a new hard-interface being added into the mesh
1041 * @bat_orig_del_if: ask the routing algorithm to apply the needed changes to
1042 * the orig_node due to an hard-interface being removed from the mesh
1044 struct batadv_algo_ops {
1045 struct hlist_node list;
1047 int (*bat_iface_enable)(struct batadv_hard_iface *hard_iface);
1048 void (*bat_iface_disable)(struct batadv_hard_iface *hard_iface);
1049 void (*bat_iface_update_mac)(struct batadv_hard_iface *hard_iface);
1050 void (*bat_primary_iface_set)(struct batadv_hard_iface *hard_iface);
1051 void (*bat_ogm_schedule)(struct batadv_hard_iface *hard_iface);
1052 void (*bat_ogm_emit)(struct batadv_forw_packet *forw_packet);
1053 int (*bat_neigh_cmp)(struct batadv_neigh_node *neigh1,
1054 struct batadv_hard_iface *if_outgoing1,
1055 struct batadv_neigh_node *neigh2,
1056 struct batadv_hard_iface *if_outgoing2);
1057 bool (*bat_neigh_is_equiv_or_better)
1058 (struct batadv_neigh_node *neigh1,
1059 struct batadv_hard_iface *if_outgoing1,
1060 struct batadv_neigh_node *neigh2,
1061 struct batadv_hard_iface *if_outgoing2);
1062 /* orig_node handling API */
1063 void (*bat_orig_print)(struct batadv_priv *priv, struct seq_file *seq);
1064 void (*bat_orig_free)(struct batadv_orig_node *orig_node);
1065 int (*bat_orig_add_if)(struct batadv_orig_node *orig_node,
1067 int (*bat_orig_del_if)(struct batadv_orig_node *orig_node,
1068 int max_if_num, int del_if_num);
1072 * struct batadv_dat_entry - it is a single entry of batman-adv ARP backend. It
1073 * is used to stored ARP entries needed for the global DAT cache
1074 * @ip: the IPv4 corresponding to this DAT/ARP entry
1075 * @mac_addr: the MAC address associated to the stored IPv4
1076 * @vid: the vlan ID associated to this entry
1077 * @last_update: time in jiffies when this entry was refreshed last time
1078 * @hash_entry: hlist node for batadv_priv_dat::hash
1079 * @refcount: number of contexts the object is used
1080 * @rcu: struct used for freeing in an RCU-safe manner
1082 struct batadv_dat_entry {
1084 uint8_t mac_addr[ETH_ALEN];
1086 unsigned long last_update;
1087 struct hlist_node hash_entry;
1089 struct rcu_head rcu;
1093 * struct batadv_dat_candidate - candidate destination for DAT operations
1094 * @type: the type of the selected candidate. It can one of the following:
1095 * - BATADV_DAT_CANDIDATE_NOT_FOUND
1096 * - BATADV_DAT_CANDIDATE_ORIG
1097 * @orig_node: if type is BATADV_DAT_CANDIDATE_ORIG this field points to the
1098 * corresponding originator node structure
1100 struct batadv_dat_candidate {
1102 struct batadv_orig_node *orig_node;
1106 * struct batadv_tvlv_container - container for tvlv appended to OGMs
1107 * @list: hlist node for batadv_priv_tvlv::container_list
1108 * @tvlv_hdr: tvlv header information needed to construct the tvlv
1109 * @value_len: length of the buffer following this struct which contains
1110 * the actual tvlv payload
1111 * @refcount: number of contexts the object is used
1113 struct batadv_tvlv_container {
1114 struct hlist_node list;
1115 struct batadv_tvlv_hdr tvlv_hdr;
1120 * struct batadv_tvlv_handler - handler for specific tvlv type and version
1121 * @list: hlist node for batadv_priv_tvlv::handler_list
1122 * @ogm_handler: handler callback which is given the tvlv payload to process on
1123 * incoming OGM packets
1124 * @unicast_handler: handler callback which is given the tvlv payload to process
1125 * on incoming unicast tvlv packets
1126 * @type: tvlv type this handler feels responsible for
1127 * @version: tvlv version this handler feels responsible for
1128 * @flags: tvlv handler flags
1129 * @refcount: number of contexts the object is used
1130 * @rcu: struct used for freeing in an RCU-safe manner
1132 struct batadv_tvlv_handler {
1133 struct hlist_node list;
1134 void (*ogm_handler)(struct batadv_priv *bat_priv,
1135 struct batadv_orig_node *orig,
1137 void *tvlv_value, uint16_t tvlv_value_len);
1138 int (*unicast_handler)(struct batadv_priv *bat_priv,
1139 uint8_t *src, uint8_t *dst,
1140 void *tvlv_value, uint16_t tvlv_value_len);
1145 struct rcu_head rcu;
1149 * enum batadv_tvlv_handler_flags - tvlv handler flags definitions
1150 * @BATADV_TVLV_HANDLER_OGM_CIFNOTFND: tvlv ogm processing function will call
1151 * this handler even if its type was not found (with no data)
1152 * @BATADV_TVLV_HANDLER_OGM_CALLED: interval tvlv handling flag - the API marks
1153 * a handler as being called, so it won't be called if the
1154 * BATADV_TVLV_HANDLER_OGM_CIFNOTFND flag was set
1156 enum batadv_tvlv_handler_flags {
1157 BATADV_TVLV_HANDLER_OGM_CIFNOTFND = BIT(1),
1158 BATADV_TVLV_HANDLER_OGM_CALLED = BIT(2),
1161 #endif /* _NET_BATMAN_ADV_TYPES_H_ */