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, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
20 #ifndef _NET_BATMAN_ADV_TYPES_H_
21 #define _NET_BATMAN_ADV_TYPES_H_
25 #include <linux/kernel.h>
28 * Maximum overhead for the encapsulation for a payload packet
30 #define BATADV_HEADER_LEN \
31 (ETH_HLEN + max(sizeof(struct batadv_unicast_packet), \
32 sizeof(struct batadv_bcast_packet)))
34 #ifdef CONFIG_BATMAN_ADV_DAT
36 /* batadv_dat_addr_t is the type used for all DHT addresses. If it is changed,
37 * BATADV_DAT_ADDR_MAX is changed as well.
39 * *Please be careful: batadv_dat_addr_t must be UNSIGNED*
41 #define batadv_dat_addr_t uint16_t
43 #endif /* CONFIG_BATMAN_ADV_DAT */
46 * struct batadv_hard_iface_bat_iv - per hard interface B.A.T.M.A.N. IV data
47 * @ogm_buff: buffer holding the OGM packet
48 * @ogm_buff_len: length of the OGM packet buffer
49 * @ogm_seqno: OGM sequence number - used to identify each OGM
51 struct batadv_hard_iface_bat_iv {
52 unsigned char *ogm_buff;
58 * struct batadv_hard_iface - network device known to batman-adv
59 * @list: list node for batadv_hardif_list
60 * @if_num: identificator of the interface
61 * @if_status: status of the interface for batman-adv
62 * @net_dev: pointer to the net_device
63 * @frag_seqno: last fragment sequence number sent by this interface
64 * @hardif_obj: kobject of the per interface sysfs "mesh" directory
65 * @refcount: number of contexts the object is used
66 * @batman_adv_ptype: packet type describing packets that should be processed by
67 * batman-adv for this interface
68 * @soft_iface: the batman-adv interface which uses this network interface
69 * @rcu: struct used for freeing in an RCU-safe manner
70 * @bat_iv: BATMAN IV specific per hard interface data
71 * @cleanup_work: work queue callback item for hard interface deinit
73 struct batadv_hard_iface {
74 struct list_head list;
77 struct net_device *net_dev;
79 struct kobject *hardif_obj;
81 struct packet_type batman_adv_ptype;
82 struct net_device *soft_iface;
84 struct batadv_hard_iface_bat_iv bat_iv;
85 struct work_struct cleanup_work;
89 * struct batadv_orig_node - structure for orig_list maintaining nodes of mesh
90 * @orig: originator ethernet address
91 * @primary_addr: hosts primary interface address
92 * @router: router that should be used to reach this originator
93 * @batadv_dat_addr_t: address of the orig node in the distributed hash
94 * @bcast_own: bitfield containing the number of our OGMs this orig_node
95 * rebroadcasted "back" to us (relative to last_real_seqno)
96 * @bcast_own_sum: counted result of bcast_own
97 * @last_seen: time when last packet from this node was received
98 * @bcast_seqno_reset: time when the broadcast seqno window was reset
99 * @batman_seqno_reset: time when the batman seqno window was reset
100 * @gw_flags: flags related to gateway class
101 * @flags: for now only VIS_SERVER flag
102 * @last_ttvn: last seen translation table version number
103 * @tt_crc: CRC of the translation table
104 * @tt_buff: last tt changeset this node received from the orig node
105 * @tt_buff_len: length of the last tt changeset this node received from the
107 * @tt_buff_lock: lock that protects tt_buff and tt_buff_len
108 * @tt_size: number of global TT entries announced by the orig node
109 * @tt_initialised: bool keeping track of whether or not this node have received
110 * any translation table information from the orig node yet
111 * @last_real_seqno: last and best known sequence number
112 * @last_ttl: ttl of last received packet
113 * @bcast_bits: bitfield containing the info which payload broadcast originated
114 * from this orig node this host already has seen (relative to
116 * @last_bcast_seqno: last broadcast sequence number received by this host
117 * @neigh_list: list of potential next hop neighbor towards this orig node
118 * @frag_list: fragmentation buffer list for fragment re-assembly
119 * @last_frag_packet: time when last fragmented packet from this node was
121 * @neigh_list_lock: lock protecting neigh_list, router and bonding_list
122 * @hash_entry: hlist node for batadv_priv::orig_hash
123 * @bat_priv: pointer to soft_iface this orig node belongs to
124 * @ogm_cnt_lock: lock protecting bcast_own, bcast_own_sum,
125 * neigh_node->real_bits & neigh_node->real_packet_count
126 * @bcast_seqno_lock: lock protecting bcast_bits & last_bcast_seqno
127 * @bond_candidates: how many candidates are available
128 * @bond_list: list of bonding candidates
129 * @refcount: number of contexts the object is used
130 * @rcu: struct used for freeing in an RCU-safe manner
131 * @in_coding_list: list of nodes this orig can hear
132 * @out_coding_list: list of nodes that can hear this orig
133 * @in_coding_list_lock: protects in_coding_list
134 * @out_coding_list_lock: protects out_coding_list
136 struct batadv_orig_node {
137 uint8_t orig[ETH_ALEN];
138 uint8_t primary_addr[ETH_ALEN];
139 struct batadv_neigh_node __rcu *router; /* rcu protected pointer */
140 #ifdef CONFIG_BATMAN_ADV_DAT
141 batadv_dat_addr_t dat_addr;
143 unsigned long *bcast_own;
144 uint8_t *bcast_own_sum;
145 unsigned long last_seen;
146 unsigned long bcast_seqno_reset;
147 unsigned long batman_seqno_reset;
152 unsigned char *tt_buff;
154 spinlock_t tt_buff_lock; /* protects tt_buff & tt_buff_len */
157 uint32_t last_real_seqno;
159 DECLARE_BITMAP(bcast_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
160 uint32_t last_bcast_seqno;
161 struct hlist_head neigh_list;
162 struct list_head frag_list;
163 unsigned long last_frag_packet;
164 /* neigh_list_lock protects: neigh_list, router & bonding_list */
165 spinlock_t neigh_list_lock;
166 struct hlist_node hash_entry;
167 struct batadv_priv *bat_priv;
168 /* ogm_cnt_lock protects: bcast_own, bcast_own_sum,
169 * neigh_node->real_bits & neigh_node->real_packet_count
171 spinlock_t ogm_cnt_lock;
172 /* bcast_seqno_lock protects: bcast_bits & last_bcast_seqno */
173 spinlock_t bcast_seqno_lock;
174 atomic_t bond_candidates;
175 struct list_head bond_list;
178 #ifdef CONFIG_BATMAN_ADV_NC
179 struct list_head in_coding_list;
180 struct list_head out_coding_list;
181 spinlock_t in_coding_list_lock; /* Protects in_coding_list */
182 spinlock_t out_coding_list_lock; /* Protects out_coding_list */
187 * struct batadv_gw_node - structure for orig nodes announcing gw capabilities
188 * @list: list node for batadv_priv_gw::list
189 * @orig_node: pointer to corresponding orig node
190 * @deleted: this struct is scheduled for deletion
191 * @refcount: number of contexts the object is used
192 * @rcu: struct used for freeing in an RCU-safe manner
194 struct batadv_gw_node {
195 struct hlist_node list;
196 struct batadv_orig_node *orig_node;
197 unsigned long deleted;
203 * struct batadv_neigh_node - structure for single hop neighbors
204 * @list: list node for batadv_orig_node::neigh_list
205 * @addr: mac address of neigh node
206 * @tq_recv: ring buffer of received TQ values from this neigh node
207 * @tq_index: ring buffer index
208 * @tq_avg: averaged tq of all tq values in the ring buffer (tq_recv)
209 * @last_ttl: last received ttl from this neigh node
210 * @bonding_list: list node for batadv_orig_node::bond_list
211 * @last_seen: when last packet via this neighbor was received
212 * @real_bits: bitfield containing the number of OGMs received from this neigh
213 * node (relative to orig_node->last_real_seqno)
214 * @real_packet_count: counted result of real_bits
215 * @orig_node: pointer to corresponding orig_node
216 * @if_incoming: pointer to incoming hard interface
217 * @lq_update_lock: lock protecting tq_recv & tq_index
218 * @refcount: number of contexts the object is used
219 * @rcu: struct used for freeing in an RCU-safe manner
221 struct batadv_neigh_node {
222 struct hlist_node list;
223 uint8_t addr[ETH_ALEN];
224 uint8_t tq_recv[BATADV_TQ_GLOBAL_WINDOW_SIZE];
228 struct list_head bonding_list;
229 unsigned long last_seen;
230 DECLARE_BITMAP(real_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
231 uint8_t real_packet_count;
232 struct batadv_orig_node *orig_node;
233 struct batadv_hard_iface *if_incoming;
234 spinlock_t lq_update_lock; /* protects tq_recv & tq_index */
240 * struct batadv_bcast_duplist_entry - structure for LAN broadcast suppression
241 * @orig[ETH_ALEN]: mac address of orig node orginating the broadcast
242 * @crc: crc32 checksum of broadcast payload
243 * @entrytime: time when the broadcast packet was received
245 #ifdef CONFIG_BATMAN_ADV_BLA
246 struct batadv_bcast_duplist_entry {
247 uint8_t orig[ETH_ALEN];
249 unsigned long entrytime;
254 * enum batadv_counters - indices for traffic counters
255 * @BATADV_CNT_TX: transmitted payload traffic packet counter
256 * @BATADV_CNT_TX_BYTES: transmitted payload traffic bytes counter
257 * @BATADV_CNT_TX_DROPPED: dropped transmission payload traffic packet counter
258 * @BATADV_CNT_RX: received payload traffic packet counter
259 * @BATADV_CNT_RX_BYTES: received payload traffic bytes counter
260 * @BATADV_CNT_FORWARD: forwarded payload traffic packet counter
261 * @BATADV_CNT_FORWARD_BYTES: forwarded payload traffic bytes counter
262 * @BATADV_CNT_MGMT_TX: transmitted routing protocol traffic packet counter
263 * @BATADV_CNT_MGMT_TX_BYTES: transmitted routing protocol traffic bytes counter
264 * @BATADV_CNT_MGMT_RX: received routing protocol traffic packet counter
265 * @BATADV_CNT_MGMT_RX_BYTES: received routing protocol traffic bytes counter
266 * @BATADV_CNT_TT_REQUEST_TX: transmitted tt req traffic packet counter
267 * @BATADV_CNT_TT_REQUEST_RX: received tt req traffic packet counter
268 * @BATADV_CNT_TT_RESPONSE_TX: transmitted tt resp traffic packet counter
269 * @BATADV_CNT_TT_RESPONSE_RX: received tt resp traffic packet counter
270 * @BATADV_CNT_TT_ROAM_ADV_TX: transmitted tt roam traffic packet counter
271 * @BATADV_CNT_TT_ROAM_ADV_RX: received tt roam traffic packet counter
272 * @BATADV_CNT_DAT_GET_TX: transmitted dht GET traffic packet counter
273 * @BATADV_CNT_DAT_GET_RX: received dht GET traffic packet counter
274 * @BATADV_CNT_DAT_PUT_TX: transmitted dht PUT traffic packet counter
275 * @BATADV_CNT_DAT_PUT_RX: received dht PUT traffic packet counter
276 * @BATADV_CNT_DAT_CACHED_REPLY_TX: transmitted dat cache reply traffic packet
278 * @BATADV_CNT_NUM: number of traffic counters
280 enum batadv_counters {
283 BATADV_CNT_TX_DROPPED,
287 BATADV_CNT_FORWARD_BYTES,
289 BATADV_CNT_MGMT_TX_BYTES,
291 BATADV_CNT_MGMT_RX_BYTES,
292 BATADV_CNT_TT_REQUEST_TX,
293 BATADV_CNT_TT_REQUEST_RX,
294 BATADV_CNT_TT_RESPONSE_TX,
295 BATADV_CNT_TT_RESPONSE_RX,
296 BATADV_CNT_TT_ROAM_ADV_TX,
297 BATADV_CNT_TT_ROAM_ADV_RX,
298 #ifdef CONFIG_BATMAN_ADV_DAT
299 BATADV_CNT_DAT_GET_TX,
300 BATADV_CNT_DAT_GET_RX,
301 BATADV_CNT_DAT_PUT_TX,
302 BATADV_CNT_DAT_PUT_RX,
303 BATADV_CNT_DAT_CACHED_REPLY_TX,
309 * struct batadv_priv_tt - per mesh interface translation table data
310 * @vn: translation table version number
311 * @ogm_append_cnt: counter of number of OGMs containing the local tt diff
312 * @local_changes: changes registered in an originator interval
313 * @changes_list: tracks tt local changes within an originator interval
314 * @local_hash: local translation table hash table
315 * @global_hash: global translation table hash table
316 * @req_list: list of pending & unanswered tt_requests
317 * @roam_list: list of the last roaming events of each client limiting the
318 * number of roaming events to avoid route flapping
319 * @changes_list_lock: lock protecting changes_list
320 * @req_list_lock: lock protecting req_list
321 * @roam_list_lock: lock protecting roam_list
322 * @local_entry_num: number of entries in the local hash table
323 * @local_crc: Checksum of the local table, recomputed before sending a new OGM
324 * @last_changeset: last tt changeset this host has generated
325 * @last_changeset_len: length of last tt changeset this host has generated
326 * @last_changeset_lock: lock protecting last_changeset & last_changeset_len
327 * @work: work queue callback item for translation table purging
329 struct batadv_priv_tt {
331 atomic_t ogm_append_cnt;
332 atomic_t local_changes;
333 struct list_head changes_list;
334 struct batadv_hashtable *local_hash;
335 struct batadv_hashtable *global_hash;
336 struct list_head req_list;
337 struct list_head roam_list;
338 spinlock_t changes_list_lock; /* protects changes */
339 spinlock_t req_list_lock; /* protects req_list */
340 spinlock_t roam_list_lock; /* protects roam_list */
341 atomic_t local_entry_num;
343 unsigned char *last_changeset;
344 int16_t last_changeset_len;
345 /* protects last_changeset & last_changeset_len */
346 spinlock_t last_changeset_lock;
347 struct delayed_work work;
351 * struct batadv_priv_bla - per mesh interface bridge loope avoidance data
352 * @num_requests; number of bla requests in flight
353 * @claim_hash: hash table containing mesh nodes this host has claimed
354 * @backbone_hash: hash table containing all detected backbone gateways
355 * @bcast_duplist: recently received broadcast packets array (for broadcast
356 * duplicate suppression)
357 * @bcast_duplist_curr: index of last broadcast packet added to bcast_duplist
358 * @bcast_duplist_lock: lock protecting bcast_duplist & bcast_duplist_curr
359 * @claim_dest: local claim data (e.g. claim group)
360 * @work: work queue callback item for cleanups & bla announcements
362 #ifdef CONFIG_BATMAN_ADV_BLA
363 struct batadv_priv_bla {
364 atomic_t num_requests;
365 struct batadv_hashtable *claim_hash;
366 struct batadv_hashtable *backbone_hash;
367 struct batadv_bcast_duplist_entry bcast_duplist[BATADV_DUPLIST_SIZE];
368 int bcast_duplist_curr;
369 /* protects bcast_duplist & bcast_duplist_curr */
370 spinlock_t bcast_duplist_lock;
371 struct batadv_bla_claim_dst claim_dest;
372 struct delayed_work work;
377 * struct batadv_debug_log - debug logging data
378 * @log_buff: buffer holding the logs (ring bufer)
379 * @log_start: index of next character to read
380 * @log_end: index of next character to write
381 * @lock: lock protecting log_buff, log_start & log_end
382 * @queue_wait: log reader's wait queue
384 #ifdef CONFIG_BATMAN_ADV_DEBUG
385 struct batadv_priv_debug_log {
386 char log_buff[BATADV_LOG_BUF_LEN];
387 unsigned long log_start;
388 unsigned long log_end;
389 spinlock_t lock; /* protects log_buff, log_start and log_end */
390 wait_queue_head_t queue_wait;
395 * struct batadv_priv_gw - per mesh interface gateway data
396 * @list: list of available gateway nodes
397 * @list_lock: lock protecting gw_list & curr_gw
398 * @curr_gw: pointer to currently selected gateway node
399 * @reselect: bool indicating a gateway re-selection is in progress
401 struct batadv_priv_gw {
402 struct hlist_head list;
403 spinlock_t list_lock; /* protects gw_list & curr_gw */
404 struct batadv_gw_node __rcu *curr_gw; /* rcu protected pointer */
409 * struct batadv_priv_vis - per mesh interface vis data
410 * @send_list: list of batadv_vis_info packets to sent
411 * @hash: hash table containing vis data from other nodes in the network
412 * @hash_lock: lock protecting the hash table
413 * @list_lock: lock protecting my_info::recv_list
414 * @work: work queue callback item for vis packet sending
415 * @my_info: holds this node's vis data sent on a regular basis
417 struct batadv_priv_vis {
418 struct list_head send_list;
419 struct batadv_hashtable *hash;
420 spinlock_t hash_lock; /* protects hash */
421 spinlock_t list_lock; /* protects my_info::recv_list */
422 struct delayed_work work;
423 struct batadv_vis_info *my_info;
427 * struct batadv_priv_dat - per mesh interface DAT private data
428 * @addr: node DAT address
429 * @hash: hashtable representing the local ARP cache
430 * @work: work queue callback item for cache purging
432 #ifdef CONFIG_BATMAN_ADV_DAT
433 struct batadv_priv_dat {
434 batadv_dat_addr_t addr;
435 struct batadv_hashtable *hash;
436 struct delayed_work work;
441 * struct batadv_priv_nc - per mesh interface network coding private data
442 * @work: work queue callback item for cleanup
443 * @debug_dir: dentry for nc subdir in batman-adv directory in debugfs
444 * @min_tq: only consider neighbors for encoding if neigh_tq > min_tq
445 * @max_fwd_delay: maximum packet forward delay to allow coding of packets
446 * @timestamp_fwd_flush: timestamp of last forward packet queue flush
447 * @coding_hash: Hash table used to buffer skbs while waiting for another
448 * incoming skb to code it with. Skbs are added to the buffer just before being
449 * forwarded in routing.c
451 struct batadv_priv_nc {
452 struct delayed_work work;
453 struct dentry *debug_dir;
456 unsigned long timestamp_fwd_flush;
457 struct batadv_hashtable *coding_hash;
461 * struct batadv_priv - per mesh interface data
462 * @mesh_state: current status of the mesh (inactive/active/deactivating)
463 * @soft_iface: net device which holds this struct as private data
464 * @stats: structure holding the data for the ndo_get_stats() call
465 * @bat_counters: mesh internal traffic statistic counters (see batadv_counters)
466 * @aggregated_ogms: bool indicating whether OGM aggregation is enabled
467 * @bonding: bool indicating whether traffic bonding is enabled
468 * @fragmentation: bool indicating whether traffic fragmentation is enabled
469 * @ap_isolation: bool indicating whether ap isolation is enabled
470 * @bridge_loop_avoidance: bool indicating whether bridge loop avoidance is
472 * @distributed_arp_table: bool indicating whether distributed ARP table is
474 * @vis_mode: vis operation: client or server (see batadv_vis_packettype)
475 * @gw_mode: gateway operation: off, client or server (see batadv_gw_modes)
476 * @gw_sel_class: gateway selection class (applies if gw_mode client)
477 * @gw_bandwidth: gateway announced bandwidth (applies if gw_mode server)
478 * @orig_interval: OGM broadcast interval in milliseconds
479 * @hop_penalty: penalty which will be applied to an OGM's tq-field on every hop
480 * @log_level: configured log level (see batadv_dbg_level)
481 * @bcast_seqno: last sent broadcast packet sequence number
482 * @bcast_queue_left: number of remaining buffered broadcast packet slots
483 * @batman_queue_left: number of remaining OGM packet slots
484 * @num_ifaces: number of interfaces assigned to this mesh interface
485 * @mesh_obj: kobject for sysfs mesh subdirectory
486 * @debug_dir: dentry for debugfs batman-adv subdirectory
487 * @forw_bat_list: list of aggregated OGMs that will be forwarded
488 * @forw_bcast_list: list of broadcast packets that will be rebroadcasted
489 * @orig_hash: hash table containing mesh participants (orig nodes)
490 * @forw_bat_list_lock: lock protecting forw_bat_list
491 * @forw_bcast_list_lock: lock protecting forw_bcast_list
492 * @orig_work: work queue callback item for orig node purging
493 * @cleanup_work: work queue callback item for soft interface deinit
494 * @primary_if: one of the hard interfaces assigned to this mesh interface
495 * becomes the primary interface
496 * @bat_algo_ops: routing algorithm used by this mesh interface
497 * @bla: bridge loope avoidance data
498 * @debug_log: holding debug logging relevant data
500 * @tt: translation table data
502 * @dat: distributed arp table data
503 * @network_coding: bool indicating whether network coding is enabled
504 * @batadv_priv_nc: network coding data
508 struct net_device *soft_iface;
509 struct net_device_stats stats;
510 uint64_t __percpu *bat_counters; /* Per cpu counters */
511 atomic_t aggregated_ogms;
513 atomic_t fragmentation;
514 atomic_t ap_isolation;
515 #ifdef CONFIG_BATMAN_ADV_BLA
516 atomic_t bridge_loop_avoidance;
518 #ifdef CONFIG_BATMAN_ADV_DAT
519 atomic_t distributed_arp_table;
523 atomic_t gw_sel_class;
524 atomic_t gw_bandwidth;
525 atomic_t orig_interval;
526 atomic_t hop_penalty;
527 #ifdef CONFIG_BATMAN_ADV_DEBUG
530 atomic_t bcast_seqno;
531 atomic_t bcast_queue_left;
532 atomic_t batman_queue_left;
534 struct kobject *mesh_obj;
535 struct dentry *debug_dir;
536 struct hlist_head forw_bat_list;
537 struct hlist_head forw_bcast_list;
538 struct batadv_hashtable *orig_hash;
539 spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
540 spinlock_t forw_bcast_list_lock; /* protects forw_bcast_list */
541 struct delayed_work orig_work;
542 struct work_struct cleanup_work;
543 struct batadv_hard_iface __rcu *primary_if; /* rcu protected pointer */
544 struct batadv_algo_ops *bat_algo_ops;
545 #ifdef CONFIG_BATMAN_ADV_BLA
546 struct batadv_priv_bla bla;
548 #ifdef CONFIG_BATMAN_ADV_DEBUG
549 struct batadv_priv_debug_log *debug_log;
551 struct batadv_priv_gw gw;
552 struct batadv_priv_tt tt;
553 struct batadv_priv_vis vis;
554 #ifdef CONFIG_BATMAN_ADV_DAT
555 struct batadv_priv_dat dat;
557 #ifdef CONFIG_BATMAN_ADV_NC
558 atomic_t network_coding;
559 struct batadv_priv_nc nc;
560 #endif /* CONFIG_BATMAN_ADV_NC */
564 * struct batadv_socket_client - layer2 icmp socket client data
565 * @queue_list: packet queue for packets destined for this socket client
566 * @queue_len: number of packets in the packet queue (queue_list)
567 * @index: socket client's index in the batadv_socket_client_hash
568 * @lock: lock protecting queue_list, queue_len & index
569 * @queue_wait: socket client's wait queue
570 * @bat_priv: pointer to soft_iface this client belongs to
572 struct batadv_socket_client {
573 struct list_head queue_list;
574 unsigned int queue_len;
576 spinlock_t lock; /* protects queue_list, queue_len & index */
577 wait_queue_head_t queue_wait;
578 struct batadv_priv *bat_priv;
582 * struct batadv_socket_packet - layer2 icmp packet for socket client
583 * @list: list node for batadv_socket_client::queue_list
584 * @icmp_len: size of the layer2 icmp packet
585 * @icmp_packet: layer2 icmp packet
587 struct batadv_socket_packet {
588 struct list_head list;
590 struct batadv_icmp_packet_rr icmp_packet;
594 * struct batadv_bla_backbone_gw - batman-adv gateway bridged into the LAN
595 * @orig: originator address of backbone node (mac address of primary iface)
596 * @vid: vlan id this gateway was detected on
597 * @hash_entry: hlist node for batadv_priv_bla::backbone_hash
598 * @bat_priv: pointer to soft_iface this backbone gateway belongs to
599 * @lasttime: last time we heard of this backbone gw
600 * @wait_periods: grace time for bridge forward delays and bla group forming at
601 * bootup phase - no bcast traffic is formwared until it has elapsed
602 * @request_sent: if this bool is set to true we are out of sync with this
603 * backbone gateway - no bcast traffic is formwared until the situation was
605 * @crc: crc16 checksum over all claims
606 * @refcount: number of contexts the object is used
607 * @rcu: struct used for freeing in an RCU-safe manner
609 #ifdef CONFIG_BATMAN_ADV_BLA
610 struct batadv_bla_backbone_gw {
611 uint8_t orig[ETH_ALEN];
613 struct hlist_node hash_entry;
614 struct batadv_priv *bat_priv;
615 unsigned long lasttime;
616 atomic_t wait_periods;
617 atomic_t request_sent;
624 * struct batadv_bla_claim - claimed non-mesh client structure
625 * @addr: mac address of claimed non-mesh client
626 * @vid: vlan id this client was detected on
627 * @batadv_bla_backbone_gw: pointer to backbone gw claiming this client
628 * @lasttime: last time we heard of claim (locals only)
629 * @hash_entry: hlist node for batadv_priv_bla::claim_hash
630 * @refcount: number of contexts the object is used
631 * @rcu: struct used for freeing in an RCU-safe manner
633 struct batadv_bla_claim {
634 uint8_t addr[ETH_ALEN];
636 struct batadv_bla_backbone_gw *backbone_gw;
637 unsigned long lasttime;
638 struct hlist_node hash_entry;
645 * struct batadv_tt_common_entry - tt local & tt global common data
646 * @addr: mac address of non-mesh client
647 * @hash_entry: hlist node for batadv_priv_tt::local_hash or for
648 * batadv_priv_tt::global_hash
649 * @flags: various state handling flags (see batadv_tt_client_flags)
650 * @added_at: timestamp used for purging stale tt common entries
651 * @refcount: number of contexts the object is used
652 * @rcu: struct used for freeing in an RCU-safe manner
654 struct batadv_tt_common_entry {
655 uint8_t addr[ETH_ALEN];
656 struct hlist_node hash_entry;
658 unsigned long added_at;
664 * struct batadv_tt_local_entry - translation table local entry data
665 * @common: general translation table data
666 * @last_seen: timestamp used for purging stale tt local entries
668 struct batadv_tt_local_entry {
669 struct batadv_tt_common_entry common;
670 unsigned long last_seen;
674 * struct batadv_tt_global_entry - translation table global entry data
675 * @common: general translation table data
676 * @orig_list: list of orig nodes announcing this non-mesh client
677 * @list_lock: lock protecting orig_list
678 * @roam_at: time at which TT_GLOBAL_ROAM was set
680 struct batadv_tt_global_entry {
681 struct batadv_tt_common_entry common;
682 struct hlist_head orig_list;
683 spinlock_t list_lock; /* protects orig_list */
684 unsigned long roam_at;
688 * struct batadv_tt_orig_list_entry - orig node announcing a non-mesh client
689 * @orig_node: pointer to orig node announcing this non-mesh client
690 * @ttvn: translation table version number which added the non-mesh client
691 * @list: list node for batadv_tt_global_entry::orig_list
692 * @refcount: number of contexts the object is used
693 * @rcu: struct used for freeing in an RCU-safe manner
695 struct batadv_tt_orig_list_entry {
696 struct batadv_orig_node *orig_node;
698 struct hlist_node list;
704 * struct batadv_tt_change_node - structure for tt changes occured
705 * @list: list node for batadv_priv_tt::changes_list
706 * @change: holds the actual translation table diff data
708 struct batadv_tt_change_node {
709 struct list_head list;
710 struct batadv_tt_change change;
714 * struct batadv_tt_req_node - data to keep track of the tt requests in flight
715 * @addr: mac address address of the originator this request was sent to
716 * @issued_at: timestamp used for purging stale tt requests
717 * @list: list node for batadv_priv_tt::req_list
719 struct batadv_tt_req_node {
720 uint8_t addr[ETH_ALEN];
721 unsigned long issued_at;
722 struct list_head list;
726 * struct batadv_tt_roam_node - roaming client data
727 * @addr: mac address of the client in the roaming phase
728 * @counter: number of allowed roaming events per client within a single
729 * OGM interval (changes are committed with each OGM)
730 * @first_time: timestamp used for purging stale roaming node entries
731 * @list: list node for batadv_priv_tt::roam_list
733 struct batadv_tt_roam_node {
734 uint8_t addr[ETH_ALEN];
736 unsigned long first_time;
737 struct list_head list;
741 * struct batadv_nc_node - network coding node
742 * @list: next and prev pointer for the list handling
743 * @addr: the node's mac address
744 * @refcount: number of contexts the object is used by
745 * @rcu: struct used for freeing in an RCU-safe manner
746 * @orig_node: pointer to corresponding orig node struct
747 * @last_seen: timestamp of last ogm received from this node
749 struct batadv_nc_node {
750 struct list_head list;
751 uint8_t addr[ETH_ALEN];
754 struct batadv_orig_node *orig_node;
755 unsigned long last_seen;
759 * struct batadv_nc_path - network coding path
760 * @hash_entry: next and prev pointer for the list handling
761 * @rcu: struct used for freeing in an RCU-safe manner
762 * @refcount: number of contexts the object is used by
763 * @packet_list: list of buffered packets for this path
764 * @packet_list_lock: access lock for packet list
765 * @next_hop: next hop (destination) of path
766 * @prev_hop: previous hop (source) of path
767 * @last_valid: timestamp for last validation of path
769 struct batadv_nc_path {
770 struct hlist_node hash_entry;
773 struct list_head packet_list;
774 spinlock_t packet_list_lock; /* Protects packet_list */
775 uint8_t next_hop[ETH_ALEN];
776 uint8_t prev_hop[ETH_ALEN];
777 unsigned long last_valid;
781 * struct batadv_nc_packet - network coding packet used when coding and
783 * @list: next and prev pointer for the list handling
784 * @packet_id: crc32 checksum of skb data
785 * @timestamp: field containing the info when the packet was added to path
786 * @neigh_node: pointer to original next hop neighbor of skb
787 * @skb: skb which can be encoded or used for decoding
788 * @nc_path: pointer to path this nc packet is attached to
790 struct batadv_nc_packet {
791 struct list_head list;
793 unsigned long timestamp;
794 struct batadv_neigh_node *neigh_node;
796 struct batadv_nc_path *nc_path;
800 * struct batadv_forw_packet - structure for bcast packets to be sent/forwarded
801 * @list: list node for batadv_socket_client::queue_list
802 * @send_time: execution time for delayed_work (packet sending)
803 * @own: bool for locally generated packets (local OGMs are re-scheduled after
805 * @skb: bcast packet's skb buffer
806 * @packet_len: size of aggregated OGM packet inside the skb buffer
807 * @direct_link_flags: direct link flags for aggregated OGM packets
808 * @num_packets: counter for bcast packet retransmission
809 * @delayed_work: work queue callback item for packet sending
810 * @if_incoming: pointer incoming hard-iface or primary iface if locally
813 struct batadv_forw_packet {
814 struct hlist_node list;
815 unsigned long send_time;
819 uint32_t direct_link_flags;
821 struct delayed_work delayed_work;
822 struct batadv_hard_iface *if_incoming;
826 * struct batadv_frag_packet_list_entry - storage for fragment packet
827 * @list: list node for orig_node::frag_list
828 * @seqno: sequence number of the fragment
829 * @skb: fragment's skb buffer
831 struct batadv_frag_packet_list_entry {
832 struct list_head list;
838 * struct batadv_vis_info - local data for vis information
839 * @first_seen: timestamp used for purging stale vis info entries
840 * @recv_list: List of server-neighbors we have received this packet from. This
841 * packet should not be re-forward to them again. List elements are struct
842 * batadv_vis_recvlist_node
843 * @send_list: list of packets to be forwarded
844 * @refcount: number of contexts the object is used
845 * @hash_entry: hlist node for batadv_priv_vis::hash
846 * @bat_priv: pointer to soft_iface this orig node belongs to
847 * @skb_packet: contains the vis packet
849 struct batadv_vis_info {
850 unsigned long first_seen;
851 struct list_head recv_list;
852 struct list_head send_list;
853 struct kref refcount;
854 struct hlist_node hash_entry;
855 struct batadv_priv *bat_priv;
856 struct sk_buff *skb_packet;
860 * struct batadv_vis_info_entry - contains link information for vis
861 * @src: source MAC of the link, all zero for local TT entry
862 * @dst: destination MAC of the link, client mac address for local TT entry
863 * @quality: transmission quality of the link, or 0 for local TT entry
865 struct batadv_vis_info_entry {
866 uint8_t src[ETH_ALEN];
867 uint8_t dest[ETH_ALEN];
872 * struct batadv_vis_recvlist_node - list entry for batadv_vis_info::recv_list
873 * @list: list node for batadv_vis_info::recv_list
874 * @mac: MAC address of the originator from where the vis_info was received
876 struct batadv_vis_recvlist_node {
877 struct list_head list;
878 uint8_t mac[ETH_ALEN];
882 * struct batadv_vis_if_list_entry - auxiliary data for vis data generation
883 * @addr: MAC address of the interface
884 * @primary: true if this interface is the primary interface
885 * @list: list node the interface list
887 * While scanning for vis-entries of a particular vis-originator
888 * this list collects its interfaces to create a subgraph/cluster
891 struct batadv_vis_if_list_entry {
892 uint8_t addr[ETH_ALEN];
894 struct hlist_node list;
898 * struct batadv_algo_ops - mesh algorithm callbacks
899 * @list: list node for the batadv_algo_list
900 * @name: name of the algorithm
901 * @bat_iface_enable: init routing info when hard-interface is enabled
902 * @bat_iface_disable: de-init routing info when hard-interface is disabled
903 * @bat_iface_update_mac: (re-)init mac addresses of the protocol information
904 * belonging to this hard-interface
905 * @bat_primary_iface_set: called when primary interface is selected / changed
906 * @bat_ogm_schedule: prepare a new outgoing OGM for the send queue
907 * @bat_ogm_emit: send scheduled OGM
909 struct batadv_algo_ops {
910 struct hlist_node list;
912 int (*bat_iface_enable)(struct batadv_hard_iface *hard_iface);
913 void (*bat_iface_disable)(struct batadv_hard_iface *hard_iface);
914 void (*bat_iface_update_mac)(struct batadv_hard_iface *hard_iface);
915 void (*bat_primary_iface_set)(struct batadv_hard_iface *hard_iface);
916 void (*bat_ogm_schedule)(struct batadv_hard_iface *hard_iface);
917 void (*bat_ogm_emit)(struct batadv_forw_packet *forw_packet);
921 * struct batadv_dat_entry - it is a single entry of batman-adv ARP backend. It
922 * is used to stored ARP entries needed for the global DAT cache
923 * @ip: the IPv4 corresponding to this DAT/ARP entry
924 * @mac_addr: the MAC address associated to the stored IPv4
925 * @last_update: time in jiffies when this entry was refreshed last time
926 * @hash_entry: hlist node for batadv_priv_dat::hash
927 * @refcount: number of contexts the object is used
928 * @rcu: struct used for freeing in an RCU-safe manner
930 struct batadv_dat_entry {
932 uint8_t mac_addr[ETH_ALEN];
933 unsigned long last_update;
934 struct hlist_node hash_entry;
940 * struct batadv_dat_candidate - candidate destination for DAT operations
941 * @type: the type of the selected candidate. It can one of the following:
942 * - BATADV_DAT_CANDIDATE_NOT_FOUND
943 * - BATADV_DAT_CANDIDATE_ORIG
944 * @orig_node: if type is BATADV_DAT_CANDIDATE_ORIG this field points to the
945 * corresponding originator node structure
947 struct batadv_dat_candidate {
949 struct batadv_orig_node *orig_node;
952 #endif /* _NET_BATMAN_ADV_TYPES_H_ */