1 /* Copyright (C) 2007-2014 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
87 * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
89 struct batadv_hard_iface {
90 struct list_head list;
93 struct net_device *net_dev;
95 struct kobject *hardif_obj;
97 struct packet_type batman_adv_ptype;
98 struct net_device *soft_iface;
100 struct batadv_hard_iface_bat_iv bat_iv;
101 struct work_struct cleanup_work;
102 struct dentry *debug_dir;
106 * struct batadv_orig_ifinfo - originator info per outgoing interface
107 * @list: list node for orig_node::ifinfo_list
108 * @if_outgoing: pointer to outgoing hard interface
109 * @router: router that should be used to reach this originator
110 * @last_real_seqno: last and best known sequence number
111 * @last_ttl: ttl of last received packet
112 * @batman_seqno_reset: time when the batman seqno window was reset
113 * @refcount: number of contexts the object is used
114 * @rcu: struct used for freeing in an RCU-safe manner
116 struct batadv_orig_ifinfo {
117 struct hlist_node list;
118 struct batadv_hard_iface *if_outgoing;
119 struct batadv_neigh_node __rcu *router; /* rcu protected pointer */
120 uint32_t last_real_seqno;
122 unsigned long batman_seqno_reset;
128 * struct batadv_frag_table_entry - head in the fragment buffer table
129 * @head: head of list with fragments
130 * @lock: lock to protect the list of fragments
131 * @timestamp: time (jiffie) of last received fragment
132 * @seqno: sequence number of the fragments in the list
133 * @size: accumulated size of packets in list
135 struct batadv_frag_table_entry {
136 struct hlist_head head;
137 spinlock_t lock; /* protects head */
138 unsigned long timestamp;
144 * struct batadv_frag_list_entry - entry in a list of fragments
145 * @list: list node information
147 * @no: fragment number in the set
149 struct batadv_frag_list_entry {
150 struct hlist_node list;
156 * struct batadv_vlan_tt - VLAN specific TT attributes
157 * @crc: CRC32 checksum of the entries belonging to this vlan
158 * @num_entries: number of TT entries for this VLAN
160 struct batadv_vlan_tt {
162 atomic_t num_entries;
166 * batadv_orig_node_vlan - VLAN specific data per orig_node
167 * @vid: the VLAN identifier
168 * @tt: VLAN specific TT attributes
169 * @list: list node for orig_node::vlan_list
170 * @refcount: number of context where this object is currently in use
171 * @rcu: struct used for freeing in a RCU-safe manner
173 struct batadv_orig_node_vlan {
175 struct batadv_vlan_tt tt;
176 struct list_head list;
182 * struct batadv_orig_bat_iv - B.A.T.M.A.N. IV private orig_node members
183 * @bcast_own: bitfield containing the number of our OGMs this orig_node
184 * rebroadcasted "back" to us (relative to last_real_seqno)
185 * @bcast_own_sum: counted result of bcast_own
186 * @ogm_cnt_lock: lock protecting bcast_own, bcast_own_sum,
187 * neigh_node->bat_iv.real_bits & neigh_node->bat_iv.real_packet_count
189 struct batadv_orig_bat_iv {
190 unsigned long *bcast_own;
191 uint8_t *bcast_own_sum;
192 /* ogm_cnt_lock protects: bcast_own, bcast_own_sum,
193 * neigh_node->bat_iv.real_bits & neigh_node->bat_iv.real_packet_count
195 spinlock_t ogm_cnt_lock;
199 * struct batadv_orig_node - structure for orig_list maintaining nodes of mesh
200 * @orig: originator ethernet address
201 * @primary_addr: hosts primary interface address
202 * @ifinfo_list: list for routers per outgoing interface
203 * @last_bonding_candidate: pointer to last ifinfo of last used router
204 * @batadv_dat_addr_t: address of the orig node in the distributed hash
205 * @last_seen: time when last packet from this node was received
206 * @bcast_seqno_reset: time when the broadcast seqno window was reset
207 * @capabilities: announced capabilities of this originator
208 * @last_ttvn: last seen translation table version number
209 * @tt_buff: last tt changeset this node received from the orig node
210 * @tt_buff_len: length of the last tt changeset this node received from the
212 * @tt_buff_lock: lock that protects tt_buff and tt_buff_len
213 * @tt_initialised: bool keeping track of whether or not this node have received
214 * any translation table information from the orig node yet
215 * @tt_lock: prevents from updating the table while reading it. Table update is
216 * made up by two operations (data structure update and metdata -CRC/TTVN-
217 * recalculation) and they have to be executed atomically in order to avoid
218 * another thread to read the table/metadata between those.
219 * @bcast_bits: bitfield containing the info which payload broadcast originated
220 * from this orig node this host already has seen (relative to
222 * @last_bcast_seqno: last broadcast sequence number received by this host
223 * @neigh_list: list of potential next hop neighbor towards this orig node
224 * @neigh_list_lock: lock protecting neigh_list and router
225 * @hash_entry: hlist node for batadv_priv::orig_hash
226 * @bat_priv: pointer to soft_iface this orig node belongs to
227 * @bcast_seqno_lock: lock protecting bcast_bits & last_bcast_seqno
228 * @refcount: number of contexts the object is used
229 * @rcu: struct used for freeing in an RCU-safe manner
230 * @in_coding_list: list of nodes this orig can hear
231 * @out_coding_list: list of nodes that can hear this orig
232 * @in_coding_list_lock: protects in_coding_list
233 * @out_coding_list_lock: protects out_coding_list
234 * @fragments: array with heads for fragment chains
235 * @vlan_list: a list of orig_node_vlan structs, one per VLAN served by the
236 * originator represented by this object
237 * @vlan_list_lock: lock protecting vlan_list
238 * @bat_iv: B.A.T.M.A.N. IV private structure
240 struct batadv_orig_node {
241 uint8_t orig[ETH_ALEN];
242 uint8_t primary_addr[ETH_ALEN];
243 struct hlist_head ifinfo_list;
244 struct batadv_orig_ifinfo *last_bonding_candidate;
245 #ifdef CONFIG_BATMAN_ADV_DAT
246 batadv_dat_addr_t dat_addr;
248 unsigned long last_seen;
249 unsigned long bcast_seqno_reset;
250 uint8_t capabilities;
252 unsigned char *tt_buff;
254 spinlock_t tt_buff_lock; /* protects tt_buff & tt_buff_len */
256 /* prevents from changing the table while reading it */
258 DECLARE_BITMAP(bcast_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
259 uint32_t last_bcast_seqno;
260 struct hlist_head neigh_list;
261 /* neigh_list_lock protects: neigh_list and router */
262 spinlock_t neigh_list_lock;
263 struct hlist_node hash_entry;
264 struct batadv_priv *bat_priv;
265 /* bcast_seqno_lock protects: bcast_bits & last_bcast_seqno */
266 spinlock_t bcast_seqno_lock;
269 #ifdef CONFIG_BATMAN_ADV_NC
270 struct list_head in_coding_list;
271 struct list_head out_coding_list;
272 spinlock_t in_coding_list_lock; /* Protects in_coding_list */
273 spinlock_t out_coding_list_lock; /* Protects out_coding_list */
275 struct batadv_frag_table_entry fragments[BATADV_FRAG_BUFFER_COUNT];
276 struct list_head vlan_list;
277 spinlock_t vlan_list_lock; /* protects vlan_list */
278 struct batadv_orig_bat_iv bat_iv;
282 * enum batadv_orig_capabilities - orig node capabilities
283 * @BATADV_ORIG_CAPA_HAS_DAT: orig node has distributed arp table enabled
284 * @BATADV_ORIG_CAPA_HAS_NC: orig node has network coding enabled
286 enum batadv_orig_capabilities {
287 BATADV_ORIG_CAPA_HAS_DAT = BIT(0),
288 BATADV_ORIG_CAPA_HAS_NC = BIT(1),
292 * struct batadv_gw_node - structure for orig nodes announcing gw capabilities
293 * @list: list node for batadv_priv_gw::list
294 * @orig_node: pointer to corresponding orig node
295 * @bandwidth_down: advertised uplink download bandwidth
296 * @bandwidth_up: advertised uplink upload bandwidth
297 * @deleted: this struct is scheduled for deletion
298 * @refcount: number of contexts the object is used
299 * @rcu: struct used for freeing in an RCU-safe manner
301 struct batadv_gw_node {
302 struct hlist_node list;
303 struct batadv_orig_node *orig_node;
304 uint32_t bandwidth_down;
305 uint32_t bandwidth_up;
306 unsigned long deleted;
312 * struct batadv_neigh_node - structure for single hops neighbors
313 * @list: list node for batadv_orig_node::neigh_list
314 * @orig_node: pointer to corresponding orig_node
315 * @addr: the MAC address of the neighboring interface
316 * @ifinfo_list: list for routing metrics per outgoing interface
317 * @ifinfo_lock: lock protecting private ifinfo members and list
318 * @if_incoming: pointer to incoming hard interface
319 * @last_seen: when last packet via this neighbor was received
320 * @last_ttl: last received ttl from this neigh node
321 * @rcu: struct used for freeing in an RCU-safe manner
322 * @bat_iv: B.A.T.M.A.N. IV private structure
324 struct batadv_neigh_node {
325 struct hlist_node list;
326 struct batadv_orig_node *orig_node;
327 uint8_t addr[ETH_ALEN];
328 struct hlist_head ifinfo_list;
329 spinlock_t ifinfo_lock; /* protects ifinfo_list and its members */
330 struct batadv_hard_iface *if_incoming;
331 unsigned long last_seen;
336 /* struct batadv_neigh_node_bat_iv - neighbor information per outgoing
337 * interface for BATMAN IV
338 * @tq_recv: ring buffer of received TQ values from this neigh node
339 * @tq_index: ring buffer index
340 * @tq_avg: averaged tq of all tq values in the ring buffer (tq_recv)
341 * @real_bits: bitfield containing the number of OGMs received from this neigh
342 * node (relative to orig_node->last_real_seqno)
343 * @real_packet_count: counted result of real_bits
345 struct batadv_neigh_ifinfo_bat_iv {
346 uint8_t tq_recv[BATADV_TQ_GLOBAL_WINDOW_SIZE];
349 DECLARE_BITMAP(real_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
350 uint8_t real_packet_count;
353 /* struct batadv_neigh_ifinfo - neighbor information per outgoing interface
354 * @list: list node for batadv_neigh_node::ifinfo_list
355 * @if_outgoing: pointer to outgoing hard interface
356 * @bat_iv: B.A.T.M.A.N. IV private structure
357 * @last_ttl: last received ttl from this neigh node
358 * @refcount: number of contexts the object is used
359 * @rcu: struct used for freeing in a RCU-safe manner
361 struct batadv_neigh_ifinfo {
362 struct hlist_node list;
363 struct batadv_hard_iface *if_outgoing;
364 struct batadv_neigh_ifinfo_bat_iv bat_iv;
371 * struct batadv_bcast_duplist_entry - structure for LAN broadcast suppression
372 * @orig[ETH_ALEN]: mac address of orig node orginating the broadcast
373 * @crc: crc32 checksum of broadcast payload
374 * @entrytime: time when the broadcast packet was received
376 #ifdef CONFIG_BATMAN_ADV_BLA
377 struct batadv_bcast_duplist_entry {
378 uint8_t orig[ETH_ALEN];
380 unsigned long entrytime;
385 * enum batadv_counters - indices for traffic counters
386 * @BATADV_CNT_TX: transmitted payload traffic packet counter
387 * @BATADV_CNT_TX_BYTES: transmitted payload traffic bytes counter
388 * @BATADV_CNT_TX_DROPPED: dropped transmission payload traffic packet counter
389 * @BATADV_CNT_RX: received payload traffic packet counter
390 * @BATADV_CNT_RX_BYTES: received payload traffic bytes counter
391 * @BATADV_CNT_FORWARD: forwarded payload traffic packet counter
392 * @BATADV_CNT_FORWARD_BYTES: forwarded payload traffic bytes counter
393 * @BATADV_CNT_MGMT_TX: transmitted routing protocol traffic packet counter
394 * @BATADV_CNT_MGMT_TX_BYTES: transmitted routing protocol traffic bytes counter
395 * @BATADV_CNT_MGMT_RX: received routing protocol traffic packet counter
396 * @BATADV_CNT_MGMT_RX_BYTES: received routing protocol traffic bytes counter
397 * @BATADV_CNT_FRAG_TX: transmitted fragment traffic packet counter
398 * @BATADV_CNT_FRAG_TX_BYTES: transmitted fragment traffic bytes counter
399 * @BATADV_CNT_FRAG_RX: received fragment traffic packet counter
400 * @BATADV_CNT_FRAG_RX_BYTES: received fragment traffic bytes counter
401 * @BATADV_CNT_FRAG_FWD: forwarded fragment traffic packet counter
402 * @BATADV_CNT_FRAG_FWD_BYTES: forwarded fragment traffic bytes counter
403 * @BATADV_CNT_TT_REQUEST_TX: transmitted tt req traffic packet counter
404 * @BATADV_CNT_TT_REQUEST_RX: received tt req traffic packet counter
405 * @BATADV_CNT_TT_RESPONSE_TX: transmitted tt resp traffic packet counter
406 * @BATADV_CNT_TT_RESPONSE_RX: received tt resp traffic packet counter
407 * @BATADV_CNT_TT_ROAM_ADV_TX: transmitted tt roam traffic packet counter
408 * @BATADV_CNT_TT_ROAM_ADV_RX: received tt roam traffic packet counter
409 * @BATADV_CNT_DAT_GET_TX: transmitted dht GET traffic packet counter
410 * @BATADV_CNT_DAT_GET_RX: received dht GET traffic packet counter
411 * @BATADV_CNT_DAT_PUT_TX: transmitted dht PUT traffic packet counter
412 * @BATADV_CNT_DAT_PUT_RX: received dht PUT traffic packet counter
413 * @BATADV_CNT_DAT_CACHED_REPLY_TX: transmitted dat cache reply traffic packet
415 * @BATADV_CNT_NC_CODE: transmitted nc-combined traffic packet counter
416 * @BATADV_CNT_NC_CODE_BYTES: transmitted nc-combined traffic bytes counter
417 * @BATADV_CNT_NC_RECODE: transmitted nc-recombined traffic packet counter
418 * @BATADV_CNT_NC_RECODE_BYTES: transmitted nc-recombined traffic bytes counter
419 * @BATADV_CNT_NC_BUFFER: counter for packets buffered for later nc decoding
420 * @BATADV_CNT_NC_DECODE: received and nc-decoded traffic packet counter
421 * @BATADV_CNT_NC_DECODE_BYTES: received and nc-decoded traffic bytes counter
422 * @BATADV_CNT_NC_DECODE_FAILED: received and decode-failed traffic packet
424 * @BATADV_CNT_NC_SNIFFED: counter for nc-decoded packets received in promisc
426 * @BATADV_CNT_NUM: number of traffic counters
428 enum batadv_counters {
431 BATADV_CNT_TX_DROPPED,
435 BATADV_CNT_FORWARD_BYTES,
437 BATADV_CNT_MGMT_TX_BYTES,
439 BATADV_CNT_MGMT_RX_BYTES,
441 BATADV_CNT_FRAG_TX_BYTES,
443 BATADV_CNT_FRAG_RX_BYTES,
445 BATADV_CNT_FRAG_FWD_BYTES,
446 BATADV_CNT_TT_REQUEST_TX,
447 BATADV_CNT_TT_REQUEST_RX,
448 BATADV_CNT_TT_RESPONSE_TX,
449 BATADV_CNT_TT_RESPONSE_RX,
450 BATADV_CNT_TT_ROAM_ADV_TX,
451 BATADV_CNT_TT_ROAM_ADV_RX,
452 #ifdef CONFIG_BATMAN_ADV_DAT
453 BATADV_CNT_DAT_GET_TX,
454 BATADV_CNT_DAT_GET_RX,
455 BATADV_CNT_DAT_PUT_TX,
456 BATADV_CNT_DAT_PUT_RX,
457 BATADV_CNT_DAT_CACHED_REPLY_TX,
459 #ifdef CONFIG_BATMAN_ADV_NC
461 BATADV_CNT_NC_CODE_BYTES,
462 BATADV_CNT_NC_RECODE,
463 BATADV_CNT_NC_RECODE_BYTES,
464 BATADV_CNT_NC_BUFFER,
465 BATADV_CNT_NC_DECODE,
466 BATADV_CNT_NC_DECODE_BYTES,
467 BATADV_CNT_NC_DECODE_FAILED,
468 BATADV_CNT_NC_SNIFFED,
474 * struct batadv_priv_tt - per mesh interface translation table data
475 * @vn: translation table version number
476 * @ogm_append_cnt: counter of number of OGMs containing the local tt diff
477 * @local_changes: changes registered in an originator interval
478 * @changes_list: tracks tt local changes within an originator interval
479 * @local_hash: local translation table hash table
480 * @global_hash: global translation table hash table
481 * @req_list: list of pending & unanswered tt_requests
482 * @roam_list: list of the last roaming events of each client limiting the
483 * number of roaming events to avoid route flapping
484 * @changes_list_lock: lock protecting changes_list
485 * @req_list_lock: lock protecting req_list
486 * @roam_list_lock: lock protecting roam_list
487 * @last_changeset: last tt changeset this host has generated
488 * @last_changeset_len: length of last tt changeset this host has generated
489 * @last_changeset_lock: lock protecting last_changeset & last_changeset_len
490 * @commit_lock: prevents from executing a local TT commit while reading the
491 * local table. The local TT commit is made up by two operations (data
492 * structure update and metdata -CRC/TTVN- recalculation) and they have to be
493 * executed atomically in order to avoid another thread to read the
494 * table/metadata between those.
495 * @work: work queue callback item for translation table purging
497 struct batadv_priv_tt {
499 atomic_t ogm_append_cnt;
500 atomic_t local_changes;
501 struct list_head changes_list;
502 struct batadv_hashtable *local_hash;
503 struct batadv_hashtable *global_hash;
504 struct list_head req_list;
505 struct list_head roam_list;
506 spinlock_t changes_list_lock; /* protects changes */
507 spinlock_t req_list_lock; /* protects req_list */
508 spinlock_t roam_list_lock; /* protects roam_list */
509 unsigned char *last_changeset;
510 int16_t last_changeset_len;
511 /* protects last_changeset & last_changeset_len */
512 spinlock_t last_changeset_lock;
513 /* prevents from executing a commit while reading the table */
514 spinlock_t commit_lock;
515 struct delayed_work work;
519 * struct batadv_priv_bla - per mesh interface bridge loope avoidance data
520 * @num_requests; number of bla requests in flight
521 * @claim_hash: hash table containing mesh nodes this host has claimed
522 * @backbone_hash: hash table containing all detected backbone gateways
523 * @bcast_duplist: recently received broadcast packets array (for broadcast
524 * duplicate suppression)
525 * @bcast_duplist_curr: index of last broadcast packet added to bcast_duplist
526 * @bcast_duplist_lock: lock protecting bcast_duplist & bcast_duplist_curr
527 * @claim_dest: local claim data (e.g. claim group)
528 * @work: work queue callback item for cleanups & bla announcements
530 #ifdef CONFIG_BATMAN_ADV_BLA
531 struct batadv_priv_bla {
532 atomic_t num_requests;
533 struct batadv_hashtable *claim_hash;
534 struct batadv_hashtable *backbone_hash;
535 struct batadv_bcast_duplist_entry bcast_duplist[BATADV_DUPLIST_SIZE];
536 int bcast_duplist_curr;
537 /* protects bcast_duplist & bcast_duplist_curr */
538 spinlock_t bcast_duplist_lock;
539 struct batadv_bla_claim_dst claim_dest;
540 struct delayed_work work;
545 * struct batadv_debug_log - debug logging data
546 * @log_buff: buffer holding the logs (ring bufer)
547 * @log_start: index of next character to read
548 * @log_end: index of next character to write
549 * @lock: lock protecting log_buff, log_start & log_end
550 * @queue_wait: log reader's wait queue
552 #ifdef CONFIG_BATMAN_ADV_DEBUG
553 struct batadv_priv_debug_log {
554 char log_buff[BATADV_LOG_BUF_LEN];
555 unsigned long log_start;
556 unsigned long log_end;
557 spinlock_t lock; /* protects log_buff, log_start and log_end */
558 wait_queue_head_t queue_wait;
563 * struct batadv_priv_gw - per mesh interface gateway data
564 * @list: list of available gateway nodes
565 * @list_lock: lock protecting gw_list & curr_gw
566 * @curr_gw: pointer to currently selected gateway node
567 * @bandwidth_down: advertised uplink download bandwidth (if gw_mode server)
568 * @bandwidth_up: advertised uplink upload bandwidth (if gw_mode server)
569 * @reselect: bool indicating a gateway re-selection is in progress
571 struct batadv_priv_gw {
572 struct hlist_head list;
573 spinlock_t list_lock; /* protects gw_list & curr_gw */
574 struct batadv_gw_node __rcu *curr_gw; /* rcu protected pointer */
575 atomic_t bandwidth_down;
576 atomic_t bandwidth_up;
581 * struct batadv_priv_tvlv - per mesh interface tvlv data
582 * @container_list: list of registered tvlv containers to be sent with each OGM
583 * @handler_list: list of the various tvlv content handlers
584 * @container_list_lock: protects tvlv container list access
585 * @handler_list_lock: protects handler list access
587 struct batadv_priv_tvlv {
588 struct hlist_head container_list;
589 struct hlist_head handler_list;
590 spinlock_t container_list_lock; /* protects container_list */
591 spinlock_t handler_list_lock; /* protects handler_list */
595 * struct batadv_priv_dat - per mesh interface DAT private data
596 * @addr: node DAT address
597 * @hash: hashtable representing the local ARP cache
598 * @work: work queue callback item for cache purging
600 #ifdef CONFIG_BATMAN_ADV_DAT
601 struct batadv_priv_dat {
602 batadv_dat_addr_t addr;
603 struct batadv_hashtable *hash;
604 struct delayed_work work;
609 * struct batadv_priv_nc - per mesh interface network coding private data
610 * @work: work queue callback item for cleanup
611 * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
612 * @min_tq: only consider neighbors for encoding if neigh_tq > min_tq
613 * @max_fwd_delay: maximum packet forward delay to allow coding of packets
614 * @max_buffer_time: buffer time for sniffed packets used to decoding
615 * @timestamp_fwd_flush: timestamp of last forward packet queue flush
616 * @timestamp_sniffed_purge: timestamp of last sniffed packet queue purge
617 * @coding_hash: Hash table used to buffer skbs while waiting for another
618 * incoming skb to code it with. Skbs are added to the buffer just before being
619 * forwarded in routing.c
620 * @decoding_hash: Hash table used to buffer skbs that might be needed to decode
621 * a received coded skb. The buffer is used for 1) skbs arriving on the
622 * soft-interface; 2) skbs overheard on the hard-interface; and 3) skbs
623 * forwarded by batman-adv.
625 struct batadv_priv_nc {
626 struct delayed_work work;
627 struct dentry *debug_dir;
631 unsigned long timestamp_fwd_flush;
632 unsigned long timestamp_sniffed_purge;
633 struct batadv_hashtable *coding_hash;
634 struct batadv_hashtable *decoding_hash;
638 * struct batadv_softif_vlan - per VLAN attributes set
639 * @vid: VLAN identifier
640 * @kobj: kobject for sysfs vlan subdirectory
641 * @ap_isolation: AP isolation state
642 * @tt: TT private attributes (VLAN specific)
643 * @list: list node for bat_priv::softif_vlan_list
644 * @refcount: number of context where this object is currently in use
645 * @rcu: struct used for freeing in a RCU-safe manner
647 struct batadv_softif_vlan {
649 struct kobject *kobj;
650 atomic_t ap_isolation; /* boolean */
651 struct batadv_vlan_tt tt;
652 struct hlist_node list;
658 * struct batadv_priv - per mesh interface data
659 * @mesh_state: current status of the mesh (inactive/active/deactivating)
660 * @soft_iface: net device which holds this struct as private data
661 * @stats: structure holding the data for the ndo_get_stats() call
662 * @bat_counters: mesh internal traffic statistic counters (see batadv_counters)
663 * @aggregated_ogms: bool indicating whether OGM aggregation is enabled
664 * @bonding: bool indicating whether traffic bonding is enabled
665 * @fragmentation: bool indicating whether traffic fragmentation is enabled
666 * @packet_size_max: max packet size that can be transmitted via
667 * multiple fragmented skbs or a single frame if fragmentation is disabled
668 * @frag_seqno: incremental counter to identify chains of egress fragments
669 * @bridge_loop_avoidance: bool indicating whether bridge loop avoidance is
671 * @distributed_arp_table: bool indicating whether distributed ARP table is
673 * @gw_mode: gateway operation: off, client or server (see batadv_gw_modes)
674 * @gw_sel_class: gateway selection class (applies if gw_mode client)
675 * @orig_interval: OGM broadcast interval in milliseconds
676 * @hop_penalty: penalty which will be applied to an OGM's tq-field on every hop
677 * @log_level: configured log level (see batadv_dbg_level)
678 * @bcast_seqno: last sent broadcast packet sequence number
679 * @bcast_queue_left: number of remaining buffered broadcast packet slots
680 * @batman_queue_left: number of remaining OGM packet slots
681 * @num_ifaces: number of interfaces assigned to this mesh interface
682 * @mesh_obj: kobject for sysfs mesh subdirectory
683 * @debug_dir: dentry for debugfs batman-adv subdirectory
684 * @forw_bat_list: list of aggregated OGMs that will be forwarded
685 * @forw_bcast_list: list of broadcast packets that will be rebroadcasted
686 * @orig_hash: hash table containing mesh participants (orig nodes)
687 * @forw_bat_list_lock: lock protecting forw_bat_list
688 * @forw_bcast_list_lock: lock protecting forw_bcast_list
689 * @orig_work: work queue callback item for orig node purging
690 * @cleanup_work: work queue callback item for soft interface deinit
691 * @primary_if: one of the hard interfaces assigned to this mesh interface
692 * becomes the primary interface
693 * @bat_algo_ops: routing algorithm used by this mesh interface
694 * @softif_vlan_list: a list of softif_vlan structs, one per VLAN created on top
695 * of the mesh interface represented by this object
696 * @softif_vlan_list_lock: lock protecting softif_vlan_list
697 * @bla: bridge loope avoidance data
698 * @debug_log: holding debug logging relevant data
700 * @tt: translation table data
701 * @tvlv: type-version-length-value data
702 * @dat: distributed arp table data
703 * @network_coding: bool indicating whether network coding is enabled
704 * @batadv_priv_nc: network coding data
708 struct net_device *soft_iface;
709 struct net_device_stats stats;
710 uint64_t __percpu *bat_counters; /* Per cpu counters */
711 atomic_t aggregated_ogms;
713 atomic_t fragmentation;
714 atomic_t packet_size_max;
716 #ifdef CONFIG_BATMAN_ADV_BLA
717 atomic_t bridge_loop_avoidance;
719 #ifdef CONFIG_BATMAN_ADV_DAT
720 atomic_t distributed_arp_table;
723 atomic_t gw_sel_class;
724 atomic_t orig_interval;
725 atomic_t hop_penalty;
726 #ifdef CONFIG_BATMAN_ADV_DEBUG
729 uint32_t isolation_mark;
730 uint32_t isolation_mark_mask;
731 atomic_t bcast_seqno;
732 atomic_t bcast_queue_left;
733 atomic_t batman_queue_left;
735 struct kobject *mesh_obj;
736 struct dentry *debug_dir;
737 struct hlist_head forw_bat_list;
738 struct hlist_head forw_bcast_list;
739 struct batadv_hashtable *orig_hash;
740 spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
741 spinlock_t forw_bcast_list_lock; /* protects forw_bcast_list */
742 struct delayed_work orig_work;
743 struct work_struct cleanup_work;
744 struct batadv_hard_iface __rcu *primary_if; /* rcu protected pointer */
745 struct batadv_algo_ops *bat_algo_ops;
746 struct hlist_head softif_vlan_list;
747 spinlock_t softif_vlan_list_lock; /* protects softif_vlan_list */
748 #ifdef CONFIG_BATMAN_ADV_BLA
749 struct batadv_priv_bla bla;
751 #ifdef CONFIG_BATMAN_ADV_DEBUG
752 struct batadv_priv_debug_log *debug_log;
754 struct batadv_priv_gw gw;
755 struct batadv_priv_tt tt;
756 struct batadv_priv_tvlv tvlv;
757 #ifdef CONFIG_BATMAN_ADV_DAT
758 struct batadv_priv_dat dat;
760 #ifdef CONFIG_BATMAN_ADV_NC
761 atomic_t network_coding;
762 struct batadv_priv_nc nc;
763 #endif /* CONFIG_BATMAN_ADV_NC */
767 * struct batadv_socket_client - layer2 icmp socket client data
768 * @queue_list: packet queue for packets destined for this socket client
769 * @queue_len: number of packets in the packet queue (queue_list)
770 * @index: socket client's index in the batadv_socket_client_hash
771 * @lock: lock protecting queue_list, queue_len & index
772 * @queue_wait: socket client's wait queue
773 * @bat_priv: pointer to soft_iface this client belongs to
775 struct batadv_socket_client {
776 struct list_head queue_list;
777 unsigned int queue_len;
779 spinlock_t lock; /* protects queue_list, queue_len & index */
780 wait_queue_head_t queue_wait;
781 struct batadv_priv *bat_priv;
785 * struct batadv_socket_packet - layer2 icmp packet for socket client
786 * @list: list node for batadv_socket_client::queue_list
787 * @icmp_len: size of the layer2 icmp packet
788 * @icmp_packet: layer2 icmp packet
790 struct batadv_socket_packet {
791 struct list_head list;
793 uint8_t icmp_packet[BATADV_ICMP_MAX_PACKET_SIZE];
797 * struct batadv_bla_backbone_gw - batman-adv gateway bridged into the LAN
798 * @orig: originator address of backbone node (mac address of primary iface)
799 * @vid: vlan id this gateway was detected on
800 * @hash_entry: hlist node for batadv_priv_bla::backbone_hash
801 * @bat_priv: pointer to soft_iface this backbone gateway belongs to
802 * @lasttime: last time we heard of this backbone gw
803 * @wait_periods: grace time for bridge forward delays and bla group forming at
804 * bootup phase - no bcast traffic is formwared until it has elapsed
805 * @request_sent: if this bool is set to true we are out of sync with this
806 * backbone gateway - no bcast traffic is formwared until the situation was
808 * @crc: crc16 checksum over all claims
809 * @refcount: number of contexts the object is used
810 * @rcu: struct used for freeing in an RCU-safe manner
812 #ifdef CONFIG_BATMAN_ADV_BLA
813 struct batadv_bla_backbone_gw {
814 uint8_t orig[ETH_ALEN];
816 struct hlist_node hash_entry;
817 struct batadv_priv *bat_priv;
818 unsigned long lasttime;
819 atomic_t wait_periods;
820 atomic_t request_sent;
827 * struct batadv_bla_claim - claimed non-mesh client structure
828 * @addr: mac address of claimed non-mesh client
829 * @vid: vlan id this client was detected on
830 * @batadv_bla_backbone_gw: pointer to backbone gw claiming this client
831 * @lasttime: last time we heard of claim (locals only)
832 * @hash_entry: hlist node for batadv_priv_bla::claim_hash
833 * @refcount: number of contexts the object is used
834 * @rcu: struct used for freeing in an RCU-safe manner
836 struct batadv_bla_claim {
837 uint8_t addr[ETH_ALEN];
839 struct batadv_bla_backbone_gw *backbone_gw;
840 unsigned long lasttime;
841 struct hlist_node hash_entry;
848 * struct batadv_tt_common_entry - tt local & tt global common data
849 * @addr: mac address of non-mesh client
850 * @vid: VLAN identifier
851 * @hash_entry: hlist node for batadv_priv_tt::local_hash or for
852 * batadv_priv_tt::global_hash
853 * @flags: various state handling flags (see batadv_tt_client_flags)
854 * @added_at: timestamp used for purging stale tt common entries
855 * @refcount: number of contexts the object is used
856 * @rcu: struct used for freeing in an RCU-safe manner
858 struct batadv_tt_common_entry {
859 uint8_t addr[ETH_ALEN];
861 struct hlist_node hash_entry;
863 unsigned long added_at;
869 * struct batadv_tt_local_entry - translation table local entry data
870 * @common: general translation table data
871 * @last_seen: timestamp used for purging stale tt local entries
873 struct batadv_tt_local_entry {
874 struct batadv_tt_common_entry common;
875 unsigned long last_seen;
879 * struct batadv_tt_global_entry - translation table global entry data
880 * @common: general translation table data
881 * @orig_list: list of orig nodes announcing this non-mesh client
882 * @list_lock: lock protecting orig_list
883 * @roam_at: time at which TT_GLOBAL_ROAM was set
885 struct batadv_tt_global_entry {
886 struct batadv_tt_common_entry common;
887 struct hlist_head orig_list;
888 spinlock_t list_lock; /* protects orig_list */
889 unsigned long roam_at;
893 * struct batadv_tt_orig_list_entry - orig node announcing a non-mesh client
894 * @orig_node: pointer to orig node announcing this non-mesh client
895 * @ttvn: translation table version number which added the non-mesh client
896 * @list: list node for batadv_tt_global_entry::orig_list
897 * @refcount: number of contexts the object is used
898 * @rcu: struct used for freeing in an RCU-safe manner
900 struct batadv_tt_orig_list_entry {
901 struct batadv_orig_node *orig_node;
903 struct hlist_node list;
909 * struct batadv_tt_change_node - structure for tt changes occured
910 * @list: list node for batadv_priv_tt::changes_list
911 * @change: holds the actual translation table diff data
913 struct batadv_tt_change_node {
914 struct list_head list;
915 struct batadv_tvlv_tt_change change;
919 * struct batadv_tt_req_node - data to keep track of the tt requests in flight
920 * @addr: mac address address of the originator this request was sent to
921 * @issued_at: timestamp used for purging stale tt requests
922 * @list: list node for batadv_priv_tt::req_list
924 struct batadv_tt_req_node {
925 uint8_t addr[ETH_ALEN];
926 unsigned long issued_at;
927 struct list_head list;
931 * struct batadv_tt_roam_node - roaming client data
932 * @addr: mac address of the client in the roaming phase
933 * @counter: number of allowed roaming events per client within a single
934 * OGM interval (changes are committed with each OGM)
935 * @first_time: timestamp used for purging stale roaming node entries
936 * @list: list node for batadv_priv_tt::roam_list
938 struct batadv_tt_roam_node {
939 uint8_t addr[ETH_ALEN];
941 unsigned long first_time;
942 struct list_head list;
946 * struct batadv_nc_node - network coding node
947 * @list: next and prev pointer for the list handling
948 * @addr: the node's mac address
949 * @refcount: number of contexts the object is used by
950 * @rcu: struct used for freeing in an RCU-safe manner
951 * @orig_node: pointer to corresponding orig node struct
952 * @last_seen: timestamp of last ogm received from this node
954 struct batadv_nc_node {
955 struct list_head list;
956 uint8_t addr[ETH_ALEN];
959 struct batadv_orig_node *orig_node;
960 unsigned long last_seen;
964 * struct batadv_nc_path - network coding path
965 * @hash_entry: next and prev pointer for the list handling
966 * @rcu: struct used for freeing in an RCU-safe manner
967 * @refcount: number of contexts the object is used by
968 * @packet_list: list of buffered packets for this path
969 * @packet_list_lock: access lock for packet list
970 * @next_hop: next hop (destination) of path
971 * @prev_hop: previous hop (source) of path
972 * @last_valid: timestamp for last validation of path
974 struct batadv_nc_path {
975 struct hlist_node hash_entry;
978 struct list_head packet_list;
979 spinlock_t packet_list_lock; /* Protects packet_list */
980 uint8_t next_hop[ETH_ALEN];
981 uint8_t prev_hop[ETH_ALEN];
982 unsigned long last_valid;
986 * struct batadv_nc_packet - network coding packet used when coding and
988 * @list: next and prev pointer for the list handling
989 * @packet_id: crc32 checksum of skb data
990 * @timestamp: field containing the info when the packet was added to path
991 * @neigh_node: pointer to original next hop neighbor of skb
992 * @skb: skb which can be encoded or used for decoding
993 * @nc_path: pointer to path this nc packet is attached to
995 struct batadv_nc_packet {
996 struct list_head list;
998 unsigned long timestamp;
999 struct batadv_neigh_node *neigh_node;
1000 struct sk_buff *skb;
1001 struct batadv_nc_path *nc_path;
1005 * batadv_skb_cb - control buffer structure used to store private data relevant
1006 * to batman-adv in the skb->cb buffer in skbs.
1007 * @decoded: Marks a skb as decoded, which is checked when searching for coding
1008 * opportunities in network-coding.c
1010 struct batadv_skb_cb {
1015 * struct batadv_forw_packet - structure for bcast packets to be sent/forwarded
1016 * @list: list node for batadv_socket_client::queue_list
1017 * @send_time: execution time for delayed_work (packet sending)
1018 * @own: bool for locally generated packets (local OGMs are re-scheduled after
1020 * @skb: bcast packet's skb buffer
1021 * @packet_len: size of aggregated OGM packet inside the skb buffer
1022 * @direct_link_flags: direct link flags for aggregated OGM packets
1023 * @num_packets: counter for bcast packet retransmission
1024 * @delayed_work: work queue callback item for packet sending
1025 * @if_incoming: pointer to incoming hard-iface or primary iface if
1026 * locally generated packet
1027 * @if_outgoing: packet where the packet should be sent to, or NULL if
1030 struct batadv_forw_packet {
1031 struct hlist_node list;
1032 unsigned long send_time;
1034 struct sk_buff *skb;
1035 uint16_t packet_len;
1036 uint32_t direct_link_flags;
1037 uint8_t num_packets;
1038 struct delayed_work delayed_work;
1039 struct batadv_hard_iface *if_incoming;
1040 struct batadv_hard_iface *if_outgoing;
1044 * struct batadv_algo_ops - mesh algorithm callbacks
1045 * @list: list node for the batadv_algo_list
1046 * @name: name of the algorithm
1047 * @bat_iface_enable: init routing info when hard-interface is enabled
1048 * @bat_iface_disable: de-init routing info when hard-interface is disabled
1049 * @bat_iface_update_mac: (re-)init mac addresses of the protocol information
1050 * belonging to this hard-interface
1051 * @bat_primary_iface_set: called when primary interface is selected / changed
1052 * @bat_ogm_schedule: prepare a new outgoing OGM for the send queue
1053 * @bat_ogm_emit: send scheduled OGM
1054 * @bat_neigh_cmp: compare the metrics of two neighbors for their respective
1055 * outgoing interfaces
1056 * @bat_neigh_is_equiv_or_better: check if neigh1 is equally good or better
1057 * than neigh2 for their respective outgoing interface from the metric
1059 * @bat_orig_print: print the originator table (optional)
1060 * @bat_orig_free: free the resources allocated by the routing algorithm for an
1062 * @bat_orig_add_if: ask the routing algorithm to apply the needed changes to
1063 * the orig_node due to a new hard-interface being added into the mesh
1064 * @bat_orig_del_if: ask the routing algorithm to apply the needed changes to
1065 * the orig_node due to an hard-interface being removed from the mesh
1067 struct batadv_algo_ops {
1068 struct hlist_node list;
1070 int (*bat_iface_enable)(struct batadv_hard_iface *hard_iface);
1071 void (*bat_iface_disable)(struct batadv_hard_iface *hard_iface);
1072 void (*bat_iface_update_mac)(struct batadv_hard_iface *hard_iface);
1073 void (*bat_primary_iface_set)(struct batadv_hard_iface *hard_iface);
1074 void (*bat_ogm_schedule)(struct batadv_hard_iface *hard_iface);
1075 void (*bat_ogm_emit)(struct batadv_forw_packet *forw_packet);
1076 int (*bat_neigh_cmp)(struct batadv_neigh_node *neigh1,
1077 struct batadv_hard_iface *if_outgoing1,
1078 struct batadv_neigh_node *neigh2,
1079 struct batadv_hard_iface *if_outgoing2);
1080 bool (*bat_neigh_is_equiv_or_better)
1081 (struct batadv_neigh_node *neigh1,
1082 struct batadv_hard_iface *if_outgoing1,
1083 struct batadv_neigh_node *neigh2,
1084 struct batadv_hard_iface *if_outgoing2);
1085 /* orig_node handling API */
1086 void (*bat_orig_print)(struct batadv_priv *priv, struct seq_file *seq,
1087 struct batadv_hard_iface *hard_iface);
1088 void (*bat_orig_free)(struct batadv_orig_node *orig_node);
1089 int (*bat_orig_add_if)(struct batadv_orig_node *orig_node,
1091 int (*bat_orig_del_if)(struct batadv_orig_node *orig_node,
1092 int max_if_num, int del_if_num);
1096 * struct batadv_dat_entry - it is a single entry of batman-adv ARP backend. It
1097 * is used to stored ARP entries needed for the global DAT cache
1098 * @ip: the IPv4 corresponding to this DAT/ARP entry
1099 * @mac_addr: the MAC address associated to the stored IPv4
1100 * @vid: the vlan ID associated to this entry
1101 * @last_update: time in jiffies when this entry was refreshed last time
1102 * @hash_entry: hlist node for batadv_priv_dat::hash
1103 * @refcount: number of contexts the object is used
1104 * @rcu: struct used for freeing in an RCU-safe manner
1106 struct batadv_dat_entry {
1108 uint8_t mac_addr[ETH_ALEN];
1110 unsigned long last_update;
1111 struct hlist_node hash_entry;
1113 struct rcu_head rcu;
1117 * struct batadv_dat_candidate - candidate destination for DAT operations
1118 * @type: the type of the selected candidate. It can one of the following:
1119 * - BATADV_DAT_CANDIDATE_NOT_FOUND
1120 * - BATADV_DAT_CANDIDATE_ORIG
1121 * @orig_node: if type is BATADV_DAT_CANDIDATE_ORIG this field points to the
1122 * corresponding originator node structure
1124 struct batadv_dat_candidate {
1126 struct batadv_orig_node *orig_node;
1130 * struct batadv_tvlv_container - container for tvlv appended to OGMs
1131 * @list: hlist node for batadv_priv_tvlv::container_list
1132 * @tvlv_hdr: tvlv header information needed to construct the tvlv
1133 * @value_len: length of the buffer following this struct which contains
1134 * the actual tvlv payload
1135 * @refcount: number of contexts the object is used
1137 struct batadv_tvlv_container {
1138 struct hlist_node list;
1139 struct batadv_tvlv_hdr tvlv_hdr;
1144 * struct batadv_tvlv_handler - handler for specific tvlv type and version
1145 * @list: hlist node for batadv_priv_tvlv::handler_list
1146 * @ogm_handler: handler callback which is given the tvlv payload to process on
1147 * incoming OGM packets
1148 * @unicast_handler: handler callback which is given the tvlv payload to process
1149 * on incoming unicast tvlv packets
1150 * @type: tvlv type this handler feels responsible for
1151 * @version: tvlv version this handler feels responsible for
1152 * @flags: tvlv handler flags
1153 * @refcount: number of contexts the object is used
1154 * @rcu: struct used for freeing in an RCU-safe manner
1156 struct batadv_tvlv_handler {
1157 struct hlist_node list;
1158 void (*ogm_handler)(struct batadv_priv *bat_priv,
1159 struct batadv_orig_node *orig,
1161 void *tvlv_value, uint16_t tvlv_value_len);
1162 int (*unicast_handler)(struct batadv_priv *bat_priv,
1163 uint8_t *src, uint8_t *dst,
1164 void *tvlv_value, uint16_t tvlv_value_len);
1169 struct rcu_head rcu;
1173 * enum batadv_tvlv_handler_flags - tvlv handler flags definitions
1174 * @BATADV_TVLV_HANDLER_OGM_CIFNOTFND: tvlv ogm processing function will call
1175 * this handler even if its type was not found (with no data)
1176 * @BATADV_TVLV_HANDLER_OGM_CALLED: interval tvlv handling flag - the API marks
1177 * a handler as being called, so it won't be called if the
1178 * BATADV_TVLV_HANDLER_OGM_CIFNOTFND flag was set
1180 enum batadv_tvlv_handler_flags {
1181 BATADV_TVLV_HANDLER_OGM_CIFNOTFND = BIT(1),
1182 BATADV_TVLV_HANDLER_OGM_CALLED = BIT(2),
1185 #endif /* _NET_BATMAN_ADV_TYPES_H_ */