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 * BATADV_TT_REMOTE_MASK - bitmask selecting the flags that are sent over the
40 #define BATADV_TT_REMOTE_MASK 0x00FF
43 * BATADV_TT_SYNC_MASK - bitmask of the flags that need to be kept in sync
44 * among the nodes. These flags are used to compute the global/local CRC
46 #define BATADV_TT_SYNC_MASK 0x00F0
49 * struct batadv_hard_iface_bat_iv - per hard interface B.A.T.M.A.N. IV data
50 * @ogm_buff: buffer holding the OGM packet
51 * @ogm_buff_len: length of the OGM packet buffer
52 * @ogm_seqno: OGM sequence number - used to identify each OGM
54 struct batadv_hard_iface_bat_iv {
55 unsigned char *ogm_buff;
61 * struct batadv_hard_iface - network device known to batman-adv
62 * @list: list node for batadv_hardif_list
63 * @if_num: identificator of the interface
64 * @if_status: status of the interface for batman-adv
65 * @net_dev: pointer to the net_device
66 * @num_bcasts: number of payload re-broadcasts on this interface (ARQ)
67 * @hardif_obj: kobject of the per interface sysfs "mesh" directory
68 * @refcount: number of contexts the object is used
69 * @batman_adv_ptype: packet type describing packets that should be processed by
70 * batman-adv for this interface
71 * @soft_iface: the batman-adv interface which uses this network interface
72 * @rcu: struct used for freeing in an RCU-safe manner
73 * @bat_iv: BATMAN IV specific per hard interface data
74 * @cleanup_work: work queue callback item for hard interface deinit
76 struct batadv_hard_iface {
77 struct list_head list;
80 struct net_device *net_dev;
82 struct kobject *hardif_obj;
84 struct packet_type batman_adv_ptype;
85 struct net_device *soft_iface;
87 struct batadv_hard_iface_bat_iv bat_iv;
88 struct work_struct cleanup_work;
92 * struct batadv_frag_table_entry - head in the fragment buffer table
93 * @head: head of list with fragments
94 * @lock: lock to protect the list of fragments
95 * @timestamp: time (jiffie) of last received fragment
96 * @seqno: sequence number of the fragments in the list
97 * @size: accumulated size of packets in list
99 struct batadv_frag_table_entry {
100 struct hlist_head head;
101 spinlock_t lock; /* protects head */
102 unsigned long timestamp;
108 * struct batadv_frag_list_entry - entry in a list of fragments
109 * @list: list node information
111 * @no: fragment number in the set
113 struct batadv_frag_list_entry {
114 struct hlist_node list;
120 * struct batadv_vlan_tt - VLAN specific TT attributes
121 * @crc: CRC32 checksum of the entries belonging to this vlan
122 * @num_entries: number of TT entries for this VLAN
124 struct batadv_vlan_tt {
126 atomic_t num_entries;
130 * batadv_orig_node_vlan - VLAN specific data per orig_node
131 * @vid: the VLAN identifier
132 * @tt: VLAN specific TT attributes
133 * @list: list node for orig_node::vlan_list
134 * @refcount: number of context where this object is currently in use
135 * @rcu: struct used for freeing in a RCU-safe manner
137 struct batadv_orig_node_vlan {
139 struct batadv_vlan_tt tt;
140 struct list_head list;
146 * struct batadv_orig_bat_iv - B.A.T.M.A.N. IV private orig_node members
147 * @bcast_own: bitfield containing the number of our OGMs this orig_node
148 * rebroadcasted "back" to us (relative to last_real_seqno)
149 * @bcast_own_sum: counted result of bcast_own
150 * @ogm_cnt_lock: lock protecting bcast_own, bcast_own_sum,
151 * neigh_node->bat_iv.real_bits & neigh_node->bat_iv.real_packet_count
153 struct batadv_orig_bat_iv {
154 unsigned long *bcast_own;
155 uint8_t *bcast_own_sum;
156 /* ogm_cnt_lock protects: bcast_own, bcast_own_sum,
157 * neigh_node->bat_iv.real_bits & neigh_node->bat_iv.real_packet_count
159 spinlock_t ogm_cnt_lock;
163 * struct batadv_orig_node - structure for orig_list maintaining nodes of mesh
164 * @orig: originator ethernet address
165 * @primary_addr: hosts primary interface address
166 * @router: router that should be used to reach this originator
167 * @batadv_dat_addr_t: address of the orig node in the distributed hash
168 * @last_seen: time when last packet from this node was received
169 * @bcast_seqno_reset: time when the broadcast seqno window was reset
170 * @batman_seqno_reset: time when the batman seqno window was reset
171 * @capabilities: announced capabilities of this originator
172 * @last_ttvn: last seen translation table version number
173 * @tt_buff: last tt changeset this node received from the orig node
174 * @tt_buff_len: length of the last tt changeset this node received from the
176 * @tt_buff_lock: lock that protects tt_buff and tt_buff_len
177 * @tt_initialised: bool keeping track of whether or not this node have received
178 * any translation table information from the orig node yet
179 * @tt_lock: prevents from updating the table while reading it. Table update is
180 * made up by two operations (data structure update and metdata -CRC/TTVN-
181 * recalculation) and they have to be executed atomically in order to avoid
182 * another thread to read the table/metadata between those.
183 * @last_real_seqno: last and best known sequence number
184 * @last_ttl: ttl of last received packet
185 * @bcast_bits: bitfield containing the info which payload broadcast originated
186 * from this orig node this host already has seen (relative to
188 * @last_bcast_seqno: last broadcast sequence number received by this host
189 * @neigh_list: list of potential next hop neighbor towards this orig node
190 * @neigh_list_lock: lock protecting neigh_list, router and bonding_list
191 * @hash_entry: hlist node for batadv_priv::orig_hash
192 * @bat_priv: pointer to soft_iface this orig node belongs to
193 * @bcast_seqno_lock: lock protecting bcast_bits & last_bcast_seqno
194 * @bond_candidates: how many candidates are available
195 * @bond_list: list of bonding candidates
196 * @refcount: number of contexts the object is used
197 * @rcu: struct used for freeing in an RCU-safe manner
198 * @in_coding_list: list of nodes this orig can hear
199 * @out_coding_list: list of nodes that can hear this orig
200 * @in_coding_list_lock: protects in_coding_list
201 * @out_coding_list_lock: protects out_coding_list
202 * @fragments: array with heads for fragment chains
203 * @vlan_list: a list of orig_node_vlan structs, one per VLAN served by the
204 * originator represented by this object
205 * @vlan_list_lock: lock protecting vlan_list
206 * @bat_iv: B.A.T.M.A.N. IV private structure
208 struct batadv_orig_node {
209 uint8_t orig[ETH_ALEN];
210 uint8_t primary_addr[ETH_ALEN];
211 struct batadv_neigh_node __rcu *router; /* rcu protected pointer */
212 #ifdef CONFIG_BATMAN_ADV_DAT
213 batadv_dat_addr_t dat_addr;
215 unsigned long last_seen;
216 unsigned long bcast_seqno_reset;
217 unsigned long batman_seqno_reset;
218 uint8_t capabilities;
220 unsigned char *tt_buff;
222 spinlock_t tt_buff_lock; /* protects tt_buff & tt_buff_len */
224 /* prevents from changing the table while reading it */
226 uint32_t last_real_seqno;
228 DECLARE_BITMAP(bcast_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
229 uint32_t last_bcast_seqno;
230 struct hlist_head neigh_list;
231 /* neigh_list_lock protects: neigh_list, router & bonding_list */
232 spinlock_t neigh_list_lock;
233 struct hlist_node hash_entry;
234 struct batadv_priv *bat_priv;
235 /* bcast_seqno_lock protects: bcast_bits & last_bcast_seqno */
236 spinlock_t bcast_seqno_lock;
237 atomic_t bond_candidates;
238 struct list_head bond_list;
241 #ifdef CONFIG_BATMAN_ADV_NC
242 struct list_head in_coding_list;
243 struct list_head out_coding_list;
244 spinlock_t in_coding_list_lock; /* Protects in_coding_list */
245 spinlock_t out_coding_list_lock; /* Protects out_coding_list */
247 struct batadv_frag_table_entry fragments[BATADV_FRAG_BUFFER_COUNT];
248 struct list_head vlan_list;
249 spinlock_t vlan_list_lock; /* protects vlan_list */
250 struct batadv_orig_bat_iv bat_iv;
254 * enum batadv_orig_capabilities - orig node capabilities
255 * @BATADV_ORIG_CAPA_HAS_DAT: orig node has distributed arp table enabled
256 * @BATADV_ORIG_CAPA_HAS_NC: orig node has network coding enabled
258 enum batadv_orig_capabilities {
259 BATADV_ORIG_CAPA_HAS_DAT = BIT(0),
260 BATADV_ORIG_CAPA_HAS_NC = BIT(1),
264 * struct batadv_gw_node - structure for orig nodes announcing gw capabilities
265 * @list: list node for batadv_priv_gw::list
266 * @orig_node: pointer to corresponding orig node
267 * @bandwidth_down: advertised uplink download bandwidth
268 * @bandwidth_up: advertised uplink upload bandwidth
269 * @deleted: this struct is scheduled for deletion
270 * @refcount: number of contexts the object is used
271 * @rcu: struct used for freeing in an RCU-safe manner
273 struct batadv_gw_node {
274 struct hlist_node list;
275 struct batadv_orig_node *orig_node;
276 uint32_t bandwidth_down;
277 uint32_t bandwidth_up;
278 unsigned long deleted;
284 * struct batadv_neigh_bat_iv - B.A.T.M.A.N. IV specific structure for single
286 * @tq_recv: ring buffer of received TQ values from this neigh node
287 * @tq_index: ring buffer index
288 * @tq_avg: averaged tq of all tq values in the ring buffer (tq_recv)
289 * @real_bits: bitfield containing the number of OGMs received from this neigh
290 * node (relative to orig_node->last_real_seqno)
291 * @real_packet_count: counted result of real_bits
292 * @lq_update_lock: lock protecting tq_recv & tq_index
294 struct batadv_neigh_bat_iv {
295 uint8_t tq_recv[BATADV_TQ_GLOBAL_WINDOW_SIZE];
298 DECLARE_BITMAP(real_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
299 uint8_t real_packet_count;
300 spinlock_t lq_update_lock; /* protects tq_recv & tq_index */
304 * struct batadv_neigh_node - structure for single hops neighbors
305 * @list: list node for batadv_orig_node::neigh_list
306 * @orig_node: pointer to corresponding orig_node
307 * @addr: the MAC address of the neighboring interface
308 * @if_incoming: pointer to incoming hard interface
309 * @last_seen: when last packet via this neighbor was received
310 * @last_ttl: last received ttl from this neigh node
311 * @bonding_list: list node for batadv_orig_node::bond_list
312 * @refcount: number of contexts the object is used
313 * @rcu: struct used for freeing in an RCU-safe manner
314 * @bat_iv: B.A.T.M.A.N. IV private structure
316 struct batadv_neigh_node {
317 struct hlist_node list;
318 struct batadv_orig_node *orig_node;
319 uint8_t addr[ETH_ALEN];
320 struct batadv_hard_iface *if_incoming;
321 unsigned long last_seen;
323 struct list_head bonding_list;
326 struct batadv_neigh_bat_iv bat_iv;
330 * struct batadv_bcast_duplist_entry - structure for LAN broadcast suppression
331 * @orig[ETH_ALEN]: mac address of orig node orginating the broadcast
332 * @crc: crc32 checksum of broadcast payload
333 * @entrytime: time when the broadcast packet was received
335 #ifdef CONFIG_BATMAN_ADV_BLA
336 struct batadv_bcast_duplist_entry {
337 uint8_t orig[ETH_ALEN];
339 unsigned long entrytime;
344 * enum batadv_counters - indices for traffic counters
345 * @BATADV_CNT_TX: transmitted payload traffic packet counter
346 * @BATADV_CNT_TX_BYTES: transmitted payload traffic bytes counter
347 * @BATADV_CNT_TX_DROPPED: dropped transmission payload traffic packet counter
348 * @BATADV_CNT_RX: received payload traffic packet counter
349 * @BATADV_CNT_RX_BYTES: received payload traffic bytes counter
350 * @BATADV_CNT_FORWARD: forwarded payload traffic packet counter
351 * @BATADV_CNT_FORWARD_BYTES: forwarded payload traffic bytes counter
352 * @BATADV_CNT_MGMT_TX: transmitted routing protocol traffic packet counter
353 * @BATADV_CNT_MGMT_TX_BYTES: transmitted routing protocol traffic bytes counter
354 * @BATADV_CNT_MGMT_RX: received routing protocol traffic packet counter
355 * @BATADV_CNT_MGMT_RX_BYTES: received routing protocol traffic bytes counter
356 * @BATADV_CNT_FRAG_TX: transmitted fragment traffic packet counter
357 * @BATADV_CNT_FRAG_TX_BYTES: transmitted fragment traffic bytes counter
358 * @BATADV_CNT_FRAG_RX: received fragment traffic packet counter
359 * @BATADV_CNT_FRAG_RX_BYTES: received fragment traffic bytes counter
360 * @BATADV_CNT_FRAG_FWD: forwarded fragment traffic packet counter
361 * @BATADV_CNT_FRAG_FWD_BYTES: forwarded fragment traffic bytes counter
362 * @BATADV_CNT_TT_REQUEST_TX: transmitted tt req traffic packet counter
363 * @BATADV_CNT_TT_REQUEST_RX: received tt req traffic packet counter
364 * @BATADV_CNT_TT_RESPONSE_TX: transmitted tt resp traffic packet counter
365 * @BATADV_CNT_TT_RESPONSE_RX: received tt resp traffic packet counter
366 * @BATADV_CNT_TT_ROAM_ADV_TX: transmitted tt roam traffic packet counter
367 * @BATADV_CNT_TT_ROAM_ADV_RX: received tt roam traffic packet counter
368 * @BATADV_CNT_DAT_GET_TX: transmitted dht GET traffic packet counter
369 * @BATADV_CNT_DAT_GET_RX: received dht GET traffic packet counter
370 * @BATADV_CNT_DAT_PUT_TX: transmitted dht PUT traffic packet counter
371 * @BATADV_CNT_DAT_PUT_RX: received dht PUT traffic packet counter
372 * @BATADV_CNT_DAT_CACHED_REPLY_TX: transmitted dat cache reply traffic packet
374 * @BATADV_CNT_NC_CODE: transmitted nc-combined traffic packet counter
375 * @BATADV_CNT_NC_CODE_BYTES: transmitted nc-combined traffic bytes counter
376 * @BATADV_CNT_NC_RECODE: transmitted nc-recombined traffic packet counter
377 * @BATADV_CNT_NC_RECODE_BYTES: transmitted nc-recombined traffic bytes counter
378 * @BATADV_CNT_NC_BUFFER: counter for packets buffered for later nc decoding
379 * @BATADV_CNT_NC_DECODE: received and nc-decoded traffic packet counter
380 * @BATADV_CNT_NC_DECODE_BYTES: received and nc-decoded traffic bytes counter
381 * @BATADV_CNT_NC_DECODE_FAILED: received and decode-failed traffic packet
383 * @BATADV_CNT_NC_SNIFFED: counter for nc-decoded packets received in promisc
385 * @BATADV_CNT_NUM: number of traffic counters
387 enum batadv_counters {
390 BATADV_CNT_TX_DROPPED,
394 BATADV_CNT_FORWARD_BYTES,
396 BATADV_CNT_MGMT_TX_BYTES,
398 BATADV_CNT_MGMT_RX_BYTES,
400 BATADV_CNT_FRAG_TX_BYTES,
402 BATADV_CNT_FRAG_RX_BYTES,
404 BATADV_CNT_FRAG_FWD_BYTES,
405 BATADV_CNT_TT_REQUEST_TX,
406 BATADV_CNT_TT_REQUEST_RX,
407 BATADV_CNT_TT_RESPONSE_TX,
408 BATADV_CNT_TT_RESPONSE_RX,
409 BATADV_CNT_TT_ROAM_ADV_TX,
410 BATADV_CNT_TT_ROAM_ADV_RX,
411 #ifdef CONFIG_BATMAN_ADV_DAT
412 BATADV_CNT_DAT_GET_TX,
413 BATADV_CNT_DAT_GET_RX,
414 BATADV_CNT_DAT_PUT_TX,
415 BATADV_CNT_DAT_PUT_RX,
416 BATADV_CNT_DAT_CACHED_REPLY_TX,
418 #ifdef CONFIG_BATMAN_ADV_NC
420 BATADV_CNT_NC_CODE_BYTES,
421 BATADV_CNT_NC_RECODE,
422 BATADV_CNT_NC_RECODE_BYTES,
423 BATADV_CNT_NC_BUFFER,
424 BATADV_CNT_NC_DECODE,
425 BATADV_CNT_NC_DECODE_BYTES,
426 BATADV_CNT_NC_DECODE_FAILED,
427 BATADV_CNT_NC_SNIFFED,
433 * struct batadv_priv_tt - per mesh interface translation table data
434 * @vn: translation table version number
435 * @ogm_append_cnt: counter of number of OGMs containing the local tt diff
436 * @local_changes: changes registered in an originator interval
437 * @changes_list: tracks tt local changes within an originator interval
438 * @local_hash: local translation table hash table
439 * @global_hash: global translation table hash table
440 * @req_list: list of pending & unanswered tt_requests
441 * @roam_list: list of the last roaming events of each client limiting the
442 * number of roaming events to avoid route flapping
443 * @changes_list_lock: lock protecting changes_list
444 * @req_list_lock: lock protecting req_list
445 * @roam_list_lock: lock protecting roam_list
446 * @last_changeset: last tt changeset this host has generated
447 * @last_changeset_len: length of last tt changeset this host has generated
448 * @last_changeset_lock: lock protecting last_changeset & last_changeset_len
449 * @commit_lock: prevents from executing a local TT commit while reading the
450 * local table. The local TT commit is made up by two operations (data
451 * structure update and metdata -CRC/TTVN- recalculation) and they have to be
452 * executed atomically in order to avoid another thread to read the
453 * table/metadata between those.
454 * @work: work queue callback item for translation table purging
456 struct batadv_priv_tt {
458 atomic_t ogm_append_cnt;
459 atomic_t local_changes;
460 struct list_head changes_list;
461 struct batadv_hashtable *local_hash;
462 struct batadv_hashtable *global_hash;
463 struct list_head req_list;
464 struct list_head roam_list;
465 spinlock_t changes_list_lock; /* protects changes */
466 spinlock_t req_list_lock; /* protects req_list */
467 spinlock_t roam_list_lock; /* protects roam_list */
468 unsigned char *last_changeset;
469 int16_t last_changeset_len;
470 /* protects last_changeset & last_changeset_len */
471 spinlock_t last_changeset_lock;
472 /* prevents from executing a commit while reading the table */
473 spinlock_t commit_lock;
474 struct delayed_work work;
478 * struct batadv_priv_bla - per mesh interface bridge loope avoidance data
479 * @num_requests; number of bla requests in flight
480 * @claim_hash: hash table containing mesh nodes this host has claimed
481 * @backbone_hash: hash table containing all detected backbone gateways
482 * @bcast_duplist: recently received broadcast packets array (for broadcast
483 * duplicate suppression)
484 * @bcast_duplist_curr: index of last broadcast packet added to bcast_duplist
485 * @bcast_duplist_lock: lock protecting bcast_duplist & bcast_duplist_curr
486 * @claim_dest: local claim data (e.g. claim group)
487 * @work: work queue callback item for cleanups & bla announcements
489 #ifdef CONFIG_BATMAN_ADV_BLA
490 struct batadv_priv_bla {
491 atomic_t num_requests;
492 struct batadv_hashtable *claim_hash;
493 struct batadv_hashtable *backbone_hash;
494 struct batadv_bcast_duplist_entry bcast_duplist[BATADV_DUPLIST_SIZE];
495 int bcast_duplist_curr;
496 /* protects bcast_duplist & bcast_duplist_curr */
497 spinlock_t bcast_duplist_lock;
498 struct batadv_bla_claim_dst claim_dest;
499 struct delayed_work work;
504 * struct batadv_debug_log - debug logging data
505 * @log_buff: buffer holding the logs (ring bufer)
506 * @log_start: index of next character to read
507 * @log_end: index of next character to write
508 * @lock: lock protecting log_buff, log_start & log_end
509 * @queue_wait: log reader's wait queue
511 #ifdef CONFIG_BATMAN_ADV_DEBUG
512 struct batadv_priv_debug_log {
513 char log_buff[BATADV_LOG_BUF_LEN];
514 unsigned long log_start;
515 unsigned long log_end;
516 spinlock_t lock; /* protects log_buff, log_start and log_end */
517 wait_queue_head_t queue_wait;
522 * struct batadv_priv_gw - per mesh interface gateway data
523 * @list: list of available gateway nodes
524 * @list_lock: lock protecting gw_list & curr_gw
525 * @curr_gw: pointer to currently selected gateway node
526 * @bandwidth_down: advertised uplink download bandwidth (if gw_mode server)
527 * @bandwidth_up: advertised uplink upload bandwidth (if gw_mode server)
528 * @reselect: bool indicating a gateway re-selection is in progress
530 struct batadv_priv_gw {
531 struct hlist_head list;
532 spinlock_t list_lock; /* protects gw_list & curr_gw */
533 struct batadv_gw_node __rcu *curr_gw; /* rcu protected pointer */
534 atomic_t bandwidth_down;
535 atomic_t bandwidth_up;
540 * struct batadv_priv_tvlv - per mesh interface tvlv data
541 * @container_list: list of registered tvlv containers to be sent with each OGM
542 * @handler_list: list of the various tvlv content handlers
543 * @container_list_lock: protects tvlv container list access
544 * @handler_list_lock: protects handler list access
546 struct batadv_priv_tvlv {
547 struct hlist_head container_list;
548 struct hlist_head handler_list;
549 spinlock_t container_list_lock; /* protects container_list */
550 spinlock_t handler_list_lock; /* protects handler_list */
554 * struct batadv_priv_dat - per mesh interface DAT private data
555 * @addr: node DAT address
556 * @hash: hashtable representing the local ARP cache
557 * @work: work queue callback item for cache purging
559 #ifdef CONFIG_BATMAN_ADV_DAT
560 struct batadv_priv_dat {
561 batadv_dat_addr_t addr;
562 struct batadv_hashtable *hash;
563 struct delayed_work work;
568 * struct batadv_priv_nc - per mesh interface network coding private data
569 * @work: work queue callback item for cleanup
570 * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
571 * @min_tq: only consider neighbors for encoding if neigh_tq > min_tq
572 * @max_fwd_delay: maximum packet forward delay to allow coding of packets
573 * @max_buffer_time: buffer time for sniffed packets used to decoding
574 * @timestamp_fwd_flush: timestamp of last forward packet queue flush
575 * @timestamp_sniffed_purge: timestamp of last sniffed packet queue purge
576 * @coding_hash: Hash table used to buffer skbs while waiting for another
577 * incoming skb to code it with. Skbs are added to the buffer just before being
578 * forwarded in routing.c
579 * @decoding_hash: Hash table used to buffer skbs that might be needed to decode
580 * a received coded skb. The buffer is used for 1) skbs arriving on the
581 * soft-interface; 2) skbs overheard on the hard-interface; and 3) skbs
582 * forwarded by batman-adv.
584 struct batadv_priv_nc {
585 struct delayed_work work;
586 struct dentry *debug_dir;
590 unsigned long timestamp_fwd_flush;
591 unsigned long timestamp_sniffed_purge;
592 struct batadv_hashtable *coding_hash;
593 struct batadv_hashtable *decoding_hash;
597 * struct batadv_softif_vlan - per VLAN attributes set
598 * @vid: VLAN identifier
599 * @kobj: kobject for sysfs vlan subdirectory
600 * @ap_isolation: AP isolation state
601 * @tt: TT private attributes (VLAN specific)
602 * @list: list node for bat_priv::softif_vlan_list
603 * @refcount: number of context where this object is currently in use
604 * @rcu: struct used for freeing in a RCU-safe manner
606 struct batadv_softif_vlan {
608 struct kobject *kobj;
609 atomic_t ap_isolation; /* boolean */
610 struct batadv_vlan_tt tt;
611 struct hlist_node list;
617 * struct batadv_priv - per mesh interface data
618 * @mesh_state: current status of the mesh (inactive/active/deactivating)
619 * @soft_iface: net device which holds this struct as private data
620 * @stats: structure holding the data for the ndo_get_stats() call
621 * @bat_counters: mesh internal traffic statistic counters (see batadv_counters)
622 * @aggregated_ogms: bool indicating whether OGM aggregation is enabled
623 * @bonding: bool indicating whether traffic bonding is enabled
624 * @fragmentation: bool indicating whether traffic fragmentation is enabled
625 * @packet_size_max: max packet size that can be transmitted via
626 * multiple fragmented skbs or a single frame if fragmentation is disabled
627 * @frag_seqno: incremental counter to identify chains of egress fragments
628 * @bridge_loop_avoidance: bool indicating whether bridge loop avoidance is
630 * @distributed_arp_table: bool indicating whether distributed ARP table is
632 * @gw_mode: gateway operation: off, client or server (see batadv_gw_modes)
633 * @gw_sel_class: gateway selection class (applies if gw_mode client)
634 * @orig_interval: OGM broadcast interval in milliseconds
635 * @hop_penalty: penalty which will be applied to an OGM's tq-field on every hop
636 * @log_level: configured log level (see batadv_dbg_level)
637 * @bcast_seqno: last sent broadcast packet sequence number
638 * @bcast_queue_left: number of remaining buffered broadcast packet slots
639 * @batman_queue_left: number of remaining OGM packet slots
640 * @num_ifaces: number of interfaces assigned to this mesh interface
641 * @mesh_obj: kobject for sysfs mesh subdirectory
642 * @debug_dir: dentry for debugfs batman-adv subdirectory
643 * @forw_bat_list: list of aggregated OGMs that will be forwarded
644 * @forw_bcast_list: list of broadcast packets that will be rebroadcasted
645 * @orig_hash: hash table containing mesh participants (orig nodes)
646 * @forw_bat_list_lock: lock protecting forw_bat_list
647 * @forw_bcast_list_lock: lock protecting forw_bcast_list
648 * @orig_work: work queue callback item for orig node purging
649 * @cleanup_work: work queue callback item for soft interface deinit
650 * @primary_if: one of the hard interfaces assigned to this mesh interface
651 * becomes the primary interface
652 * @bat_algo_ops: routing algorithm used by this mesh interface
653 * @softif_vlan_list: a list of softif_vlan structs, one per VLAN created on top
654 * of the mesh interface represented by this object
655 * @softif_vlan_list_lock: lock protecting softif_vlan_list
656 * @bla: bridge loope avoidance data
657 * @debug_log: holding debug logging relevant data
659 * @tt: translation table data
660 * @tvlv: type-version-length-value data
661 * @dat: distributed arp table data
662 * @network_coding: bool indicating whether network coding is enabled
663 * @batadv_priv_nc: network coding data
667 struct net_device *soft_iface;
668 struct net_device_stats stats;
669 uint64_t __percpu *bat_counters; /* Per cpu counters */
670 atomic_t aggregated_ogms;
672 atomic_t fragmentation;
673 atomic_t packet_size_max;
675 #ifdef CONFIG_BATMAN_ADV_BLA
676 atomic_t bridge_loop_avoidance;
678 #ifdef CONFIG_BATMAN_ADV_DAT
679 atomic_t distributed_arp_table;
682 atomic_t gw_sel_class;
683 atomic_t orig_interval;
684 atomic_t hop_penalty;
685 #ifdef CONFIG_BATMAN_ADV_DEBUG
688 atomic_t bcast_seqno;
689 atomic_t bcast_queue_left;
690 atomic_t batman_queue_left;
692 struct kobject *mesh_obj;
693 struct dentry *debug_dir;
694 struct hlist_head forw_bat_list;
695 struct hlist_head forw_bcast_list;
696 struct batadv_hashtable *orig_hash;
697 spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
698 spinlock_t forw_bcast_list_lock; /* protects forw_bcast_list */
699 struct delayed_work orig_work;
700 struct work_struct cleanup_work;
701 struct batadv_hard_iface __rcu *primary_if; /* rcu protected pointer */
702 struct batadv_algo_ops *bat_algo_ops;
703 struct hlist_head softif_vlan_list;
704 spinlock_t softif_vlan_list_lock; /* protects softif_vlan_list */
705 #ifdef CONFIG_BATMAN_ADV_BLA
706 struct batadv_priv_bla bla;
708 #ifdef CONFIG_BATMAN_ADV_DEBUG
709 struct batadv_priv_debug_log *debug_log;
711 struct batadv_priv_gw gw;
712 struct batadv_priv_tt tt;
713 struct batadv_priv_tvlv tvlv;
714 #ifdef CONFIG_BATMAN_ADV_DAT
715 struct batadv_priv_dat dat;
717 #ifdef CONFIG_BATMAN_ADV_NC
718 atomic_t network_coding;
719 struct batadv_priv_nc nc;
720 #endif /* CONFIG_BATMAN_ADV_NC */
724 * struct batadv_socket_client - layer2 icmp socket client data
725 * @queue_list: packet queue for packets destined for this socket client
726 * @queue_len: number of packets in the packet queue (queue_list)
727 * @index: socket client's index in the batadv_socket_client_hash
728 * @lock: lock protecting queue_list, queue_len & index
729 * @queue_wait: socket client's wait queue
730 * @bat_priv: pointer to soft_iface this client belongs to
732 struct batadv_socket_client {
733 struct list_head queue_list;
734 unsigned int queue_len;
736 spinlock_t lock; /* protects queue_list, queue_len & index */
737 wait_queue_head_t queue_wait;
738 struct batadv_priv *bat_priv;
742 * struct batadv_socket_packet - layer2 icmp packet for socket client
743 * @list: list node for batadv_socket_client::queue_list
744 * @icmp_len: size of the layer2 icmp packet
745 * @icmp_packet: layer2 icmp packet
747 struct batadv_socket_packet {
748 struct list_head list;
750 uint8_t icmp_packet[BATADV_ICMP_MAX_PACKET_SIZE];
754 * struct batadv_bla_backbone_gw - batman-adv gateway bridged into the LAN
755 * @orig: originator address of backbone node (mac address of primary iface)
756 * @vid: vlan id this gateway was detected on
757 * @hash_entry: hlist node for batadv_priv_bla::backbone_hash
758 * @bat_priv: pointer to soft_iface this backbone gateway belongs to
759 * @lasttime: last time we heard of this backbone gw
760 * @wait_periods: grace time for bridge forward delays and bla group forming at
761 * bootup phase - no bcast traffic is formwared until it has elapsed
762 * @request_sent: if this bool is set to true we are out of sync with this
763 * backbone gateway - no bcast traffic is formwared until the situation was
765 * @crc: crc16 checksum over all claims
766 * @refcount: number of contexts the object is used
767 * @rcu: struct used for freeing in an RCU-safe manner
769 #ifdef CONFIG_BATMAN_ADV_BLA
770 struct batadv_bla_backbone_gw {
771 uint8_t orig[ETH_ALEN];
773 struct hlist_node hash_entry;
774 struct batadv_priv *bat_priv;
775 unsigned long lasttime;
776 atomic_t wait_periods;
777 atomic_t request_sent;
784 * struct batadv_bla_claim - claimed non-mesh client structure
785 * @addr: mac address of claimed non-mesh client
786 * @vid: vlan id this client was detected on
787 * @batadv_bla_backbone_gw: pointer to backbone gw claiming this client
788 * @lasttime: last time we heard of claim (locals only)
789 * @hash_entry: hlist node for batadv_priv_bla::claim_hash
790 * @refcount: number of contexts the object is used
791 * @rcu: struct used for freeing in an RCU-safe manner
793 struct batadv_bla_claim {
794 uint8_t addr[ETH_ALEN];
796 struct batadv_bla_backbone_gw *backbone_gw;
797 unsigned long lasttime;
798 struct hlist_node hash_entry;
805 * struct batadv_tt_common_entry - tt local & tt global common data
806 * @addr: mac address of non-mesh client
807 * @vid: VLAN identifier
808 * @hash_entry: hlist node for batadv_priv_tt::local_hash or for
809 * batadv_priv_tt::global_hash
810 * @flags: various state handling flags (see batadv_tt_client_flags)
811 * @added_at: timestamp used for purging stale tt common entries
812 * @refcount: number of contexts the object is used
813 * @rcu: struct used for freeing in an RCU-safe manner
815 struct batadv_tt_common_entry {
816 uint8_t addr[ETH_ALEN];
818 struct hlist_node hash_entry;
820 unsigned long added_at;
826 * struct batadv_tt_local_entry - translation table local entry data
827 * @common: general translation table data
828 * @last_seen: timestamp used for purging stale tt local entries
830 struct batadv_tt_local_entry {
831 struct batadv_tt_common_entry common;
832 unsigned long last_seen;
836 * struct batadv_tt_global_entry - translation table global entry data
837 * @common: general translation table data
838 * @orig_list: list of orig nodes announcing this non-mesh client
839 * @list_lock: lock protecting orig_list
840 * @roam_at: time at which TT_GLOBAL_ROAM was set
842 struct batadv_tt_global_entry {
843 struct batadv_tt_common_entry common;
844 struct hlist_head orig_list;
845 spinlock_t list_lock; /* protects orig_list */
846 unsigned long roam_at;
850 * struct batadv_tt_orig_list_entry - orig node announcing a non-mesh client
851 * @orig_node: pointer to orig node announcing this non-mesh client
852 * @ttvn: translation table version number which added the non-mesh client
853 * @list: list node for batadv_tt_global_entry::orig_list
854 * @refcount: number of contexts the object is used
855 * @rcu: struct used for freeing in an RCU-safe manner
857 struct batadv_tt_orig_list_entry {
858 struct batadv_orig_node *orig_node;
860 struct hlist_node list;
866 * struct batadv_tt_change_node - structure for tt changes occured
867 * @list: list node for batadv_priv_tt::changes_list
868 * @change: holds the actual translation table diff data
870 struct batadv_tt_change_node {
871 struct list_head list;
872 struct batadv_tvlv_tt_change change;
876 * struct batadv_tt_req_node - data to keep track of the tt requests in flight
877 * @addr: mac address address of the originator this request was sent to
878 * @issued_at: timestamp used for purging stale tt requests
879 * @list: list node for batadv_priv_tt::req_list
881 struct batadv_tt_req_node {
882 uint8_t addr[ETH_ALEN];
883 unsigned long issued_at;
884 struct list_head list;
888 * struct batadv_tt_roam_node - roaming client data
889 * @addr: mac address of the client in the roaming phase
890 * @counter: number of allowed roaming events per client within a single
891 * OGM interval (changes are committed with each OGM)
892 * @first_time: timestamp used for purging stale roaming node entries
893 * @list: list node for batadv_priv_tt::roam_list
895 struct batadv_tt_roam_node {
896 uint8_t addr[ETH_ALEN];
898 unsigned long first_time;
899 struct list_head list;
903 * struct batadv_nc_node - network coding node
904 * @list: next and prev pointer for the list handling
905 * @addr: the node's mac address
906 * @refcount: number of contexts the object is used by
907 * @rcu: struct used for freeing in an RCU-safe manner
908 * @orig_node: pointer to corresponding orig node struct
909 * @last_seen: timestamp of last ogm received from this node
911 struct batadv_nc_node {
912 struct list_head list;
913 uint8_t addr[ETH_ALEN];
916 struct batadv_orig_node *orig_node;
917 unsigned long last_seen;
921 * struct batadv_nc_path - network coding path
922 * @hash_entry: next and prev pointer for the list handling
923 * @rcu: struct used for freeing in an RCU-safe manner
924 * @refcount: number of contexts the object is used by
925 * @packet_list: list of buffered packets for this path
926 * @packet_list_lock: access lock for packet list
927 * @next_hop: next hop (destination) of path
928 * @prev_hop: previous hop (source) of path
929 * @last_valid: timestamp for last validation of path
931 struct batadv_nc_path {
932 struct hlist_node hash_entry;
935 struct list_head packet_list;
936 spinlock_t packet_list_lock; /* Protects packet_list */
937 uint8_t next_hop[ETH_ALEN];
938 uint8_t prev_hop[ETH_ALEN];
939 unsigned long last_valid;
943 * struct batadv_nc_packet - network coding packet used when coding and
945 * @list: next and prev pointer for the list handling
946 * @packet_id: crc32 checksum of skb data
947 * @timestamp: field containing the info when the packet was added to path
948 * @neigh_node: pointer to original next hop neighbor of skb
949 * @skb: skb which can be encoded or used for decoding
950 * @nc_path: pointer to path this nc packet is attached to
952 struct batadv_nc_packet {
953 struct list_head list;
955 unsigned long timestamp;
956 struct batadv_neigh_node *neigh_node;
958 struct batadv_nc_path *nc_path;
962 * batadv_skb_cb - control buffer structure used to store private data relevant
963 * to batman-adv in the skb->cb buffer in skbs.
964 * @decoded: Marks a skb as decoded, which is checked when searching for coding
965 * opportunities in network-coding.c
967 struct batadv_skb_cb {
972 * struct batadv_forw_packet - structure for bcast packets to be sent/forwarded
973 * @list: list node for batadv_socket_client::queue_list
974 * @send_time: execution time for delayed_work (packet sending)
975 * @own: bool for locally generated packets (local OGMs are re-scheduled after
977 * @skb: bcast packet's skb buffer
978 * @packet_len: size of aggregated OGM packet inside the skb buffer
979 * @direct_link_flags: direct link flags for aggregated OGM packets
980 * @num_packets: counter for bcast packet retransmission
981 * @delayed_work: work queue callback item for packet sending
982 * @if_incoming: pointer incoming hard-iface or primary iface if locally
985 struct batadv_forw_packet {
986 struct hlist_node list;
987 unsigned long send_time;
991 uint32_t direct_link_flags;
993 struct delayed_work delayed_work;
994 struct batadv_hard_iface *if_incoming;
998 * struct batadv_algo_ops - mesh algorithm callbacks
999 * @list: list node for the batadv_algo_list
1000 * @name: name of the algorithm
1001 * @bat_iface_enable: init routing info when hard-interface is enabled
1002 * @bat_iface_disable: de-init routing info when hard-interface is disabled
1003 * @bat_iface_update_mac: (re-)init mac addresses of the protocol information
1004 * belonging to this hard-interface
1005 * @bat_primary_iface_set: called when primary interface is selected / changed
1006 * @bat_ogm_schedule: prepare a new outgoing OGM for the send queue
1007 * @bat_ogm_emit: send scheduled OGM
1008 * @bat_neigh_cmp: compare the metrics of two neighbors
1009 * @bat_neigh_is_equiv_or_better: check if neigh1 is equally good or
1010 * better than neigh2 from the metric prospective
1011 * @bat_orig_print: print the originator table (optional)
1012 * @bat_orig_free: free the resources allocated by the routing algorithm for an
1014 * @bat_orig_add_if: ask the routing algorithm to apply the needed changes to
1015 * the orig_node due to a new hard-interface being added into the mesh
1016 * @bat_orig_del_if: ask the routing algorithm to apply the needed changes to
1017 * the orig_node due to an hard-interface being removed from the mesh
1019 struct batadv_algo_ops {
1020 struct hlist_node list;
1022 int (*bat_iface_enable)(struct batadv_hard_iface *hard_iface);
1023 void (*bat_iface_disable)(struct batadv_hard_iface *hard_iface);
1024 void (*bat_iface_update_mac)(struct batadv_hard_iface *hard_iface);
1025 void (*bat_primary_iface_set)(struct batadv_hard_iface *hard_iface);
1026 void (*bat_ogm_schedule)(struct batadv_hard_iface *hard_iface);
1027 void (*bat_ogm_emit)(struct batadv_forw_packet *forw_packet);
1028 int (*bat_neigh_cmp)(struct batadv_neigh_node *neigh1,
1029 struct batadv_neigh_node *neigh2);
1030 bool (*bat_neigh_is_equiv_or_better)(struct batadv_neigh_node *neigh1,
1031 struct batadv_neigh_node *neigh2);
1032 /* orig_node handling API */
1033 void (*bat_orig_print)(struct batadv_priv *priv, struct seq_file *seq);
1034 void (*bat_orig_free)(struct batadv_orig_node *orig_node);
1035 int (*bat_orig_add_if)(struct batadv_orig_node *orig_node,
1037 int (*bat_orig_del_if)(struct batadv_orig_node *orig_node,
1038 int max_if_num, int del_if_num);
1042 * struct batadv_dat_entry - it is a single entry of batman-adv ARP backend. It
1043 * is used to stored ARP entries needed for the global DAT cache
1044 * @ip: the IPv4 corresponding to this DAT/ARP entry
1045 * @mac_addr: the MAC address associated to the stored IPv4
1046 * @vid: the vlan ID associated to this entry
1047 * @last_update: time in jiffies when this entry was refreshed last time
1048 * @hash_entry: hlist node for batadv_priv_dat::hash
1049 * @refcount: number of contexts the object is used
1050 * @rcu: struct used for freeing in an RCU-safe manner
1052 struct batadv_dat_entry {
1054 uint8_t mac_addr[ETH_ALEN];
1056 unsigned long last_update;
1057 struct hlist_node hash_entry;
1059 struct rcu_head rcu;
1063 * struct batadv_dat_candidate - candidate destination for DAT operations
1064 * @type: the type of the selected candidate. It can one of the following:
1065 * - BATADV_DAT_CANDIDATE_NOT_FOUND
1066 * - BATADV_DAT_CANDIDATE_ORIG
1067 * @orig_node: if type is BATADV_DAT_CANDIDATE_ORIG this field points to the
1068 * corresponding originator node structure
1070 struct batadv_dat_candidate {
1072 struct batadv_orig_node *orig_node;
1076 * struct batadv_tvlv_container - container for tvlv appended to OGMs
1077 * @list: hlist node for batadv_priv_tvlv::container_list
1078 * @tvlv_hdr: tvlv header information needed to construct the tvlv
1079 * @value_len: length of the buffer following this struct which contains
1080 * the actual tvlv payload
1081 * @refcount: number of contexts the object is used
1083 struct batadv_tvlv_container {
1084 struct hlist_node list;
1085 struct batadv_tvlv_hdr tvlv_hdr;
1090 * struct batadv_tvlv_handler - handler for specific tvlv type and version
1091 * @list: hlist node for batadv_priv_tvlv::handler_list
1092 * @ogm_handler: handler callback which is given the tvlv payload to process on
1093 * incoming OGM packets
1094 * @unicast_handler: handler callback which is given the tvlv payload to process
1095 * on incoming unicast tvlv packets
1096 * @type: tvlv type this handler feels responsible for
1097 * @version: tvlv version this handler feels responsible for
1098 * @flags: tvlv handler flags
1099 * @refcount: number of contexts the object is used
1100 * @rcu: struct used for freeing in an RCU-safe manner
1102 struct batadv_tvlv_handler {
1103 struct hlist_node list;
1104 void (*ogm_handler)(struct batadv_priv *bat_priv,
1105 struct batadv_orig_node *orig,
1107 void *tvlv_value, uint16_t tvlv_value_len);
1108 int (*unicast_handler)(struct batadv_priv *bat_priv,
1109 uint8_t *src, uint8_t *dst,
1110 void *tvlv_value, uint16_t tvlv_value_len);
1115 struct rcu_head rcu;
1119 * enum batadv_tvlv_handler_flags - tvlv handler flags definitions
1120 * @BATADV_TVLV_HANDLER_OGM_CIFNOTFND: tvlv ogm processing function will call
1121 * this handler even if its type was not found (with no data)
1122 * @BATADV_TVLV_HANDLER_OGM_CALLED: interval tvlv handling flag - the API marks
1123 * a handler as being called, so it won't be called if the
1124 * BATADV_TVLV_HANDLER_OGM_CIFNOTFND flag was set
1126 enum batadv_tvlv_handler_flags {
1127 BATADV_TVLV_HANDLER_OGM_CIFNOTFND = BIT(1),
1128 BATADV_TVLV_HANDLER_OGM_CALLED = BIT(2),
1131 #endif /* _NET_BATMAN_ADV_TYPES_H_ */