1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright (C) B.A.T.M.A.N. contributors:
3 *
4 * Marek Lindner, Simon Wunderlich
5 */
6
7 #ifndef _NET_BATMAN_ADV_TYPES_H_
8 #define _NET_BATMAN_ADV_TYPES_H_
9
10 #ifndef _NET_BATMAN_ADV_MAIN_H_
11 #error only "main.h" can be included directly
12 #endif
13
14 #include <linux/average.h>
15 #include <linux/bitops.h>
16 #include <linux/compiler.h>
17 #include <linux/if.h>
18 #include <linux/if_ether.h>
19 #include <linux/kref.h>
20 #include <linux/mutex.h>
21 #include <linux/netdevice.h>
22 #include <linux/netlink.h>
23 #include <linux/sched.h> /* for linux/wait.h */
24 #include <linux/skbuff.h>
25 #include <linux/spinlock.h>
26 #include <linux/timer.h>
27 #include <linux/types.h>
28 #include <linux/wait.h>
29 #include <linux/workqueue.h>
30 #include <uapi/linux/batadv_packet.h>
31 #include <uapi/linux/batman_adv.h>
32
33 #ifdef CONFIG_BATMAN_ADV_DAT
34
35 /**
36 * typedef batadv_dat_addr_t - type used for all DHT addresses
37 *
38 * If it is changed, BATADV_DAT_ADDR_MAX is changed as well.
39 *
40 * *Please be careful: batadv_dat_addr_t must be UNSIGNED*
41 */
42 typedef u16 batadv_dat_addr_t;
43
44 #endif /* CONFIG_BATMAN_ADV_DAT */
45
46 /**
47 * enum batadv_dhcp_recipient - dhcp destination
48 */
49 enum batadv_dhcp_recipient {
50 /** @BATADV_DHCP_NO: packet is not a dhcp message */
51 BATADV_DHCP_NO = 0,
52
53 /** @BATADV_DHCP_TO_SERVER: dhcp message is directed to a server */
54 BATADV_DHCP_TO_SERVER,
55
56 /** @BATADV_DHCP_TO_CLIENT: dhcp message is directed to a client */
57 BATADV_DHCP_TO_CLIENT,
58 };
59
60 /**
61 * BATADV_TT_REMOTE_MASK - bitmask selecting the flags that are sent over the
62 * wire only
63 */
64 #define BATADV_TT_REMOTE_MASK 0x00FF
65
66 /**
67 * BATADV_TT_SYNC_MASK - bitmask of the flags that need to be kept in sync
68 * among the nodes. These flags are used to compute the global/local CRC
69 */
70 #define BATADV_TT_SYNC_MASK 0x00F0
71
72 /**
73 * struct batadv_hard_iface_bat_iv - per hard-interface B.A.T.M.A.N. IV data
74 */
75 struct batadv_hard_iface_bat_iv {
76 /** @ogm_buff: buffer holding the OGM packet */
77 unsigned char *ogm_buff;
78
79 /** @ogm_buff_len: length of the OGM packet buffer */
80 int ogm_buff_len;
81
82 /** @ogm_seqno: OGM sequence number - used to identify each OGM */
83 atomic_t ogm_seqno;
84
85 /** @ogm_buff_mutex: lock protecting ogm_buff and ogm_buff_len */
86 struct mutex ogm_buff_mutex;
87 };
88
89 /**
90 * enum batadv_v_hard_iface_flags - interface flags useful to B.A.T.M.A.N. V
91 */
92 enum batadv_v_hard_iface_flags {
93 /**
94 * @BATADV_FULL_DUPLEX: tells if the connection over this link is
95 * full-duplex
96 */
97 BATADV_FULL_DUPLEX = BIT(0),
98
99 /**
100 * @BATADV_WARNING_DEFAULT: tells whether we have warned the user that
101 * no throughput data is available for this interface and that default
102 * values are assumed.
103 */
104 BATADV_WARNING_DEFAULT = BIT(1),
105 };
106
107 /**
108 * struct batadv_hard_iface_bat_v - per hard-interface B.A.T.M.A.N. V data
109 */
110 struct batadv_hard_iface_bat_v {
111 /** @elp_interval: time interval between two ELP transmissions */
112 atomic_t elp_interval;
113
114 /** @elp_seqno: current ELP sequence number */
115 atomic_t elp_seqno;
116
117 /** @elp_skb: base skb containing the ELP message to send */
118 struct sk_buff *elp_skb;
119
120 /** @elp_wq: workqueue used to schedule ELP transmissions */
121 struct delayed_work elp_wq;
122
123 /** @aggr_wq: workqueue used to transmit queued OGM packets */
124 struct delayed_work aggr_wq;
125
126 /** @aggr_list: queue for to be aggregated OGM packets */
127 struct sk_buff_head aggr_list;
128
129 /** @aggr_len: size of the OGM aggregate (excluding ethernet header) */
130 unsigned int aggr_len;
131
132 /**
133 * @throughput_override: throughput override to disable link
134 * auto-detection
135 */
136 atomic_t throughput_override;
137
138 /** @flags: interface specific flags */
139 u8 flags;
140 };
141
142 /**
143 * enum batadv_hard_iface_wifi_flags - Flags describing the wifi configuration
144 * of a batadv_hard_iface
145 */
146 enum batadv_hard_iface_wifi_flags {
147 /** @BATADV_HARDIF_WIFI_WEXT_DIRECT: it is a wext wifi device */
148 BATADV_HARDIF_WIFI_WEXT_DIRECT = BIT(0),
149
150 /** @BATADV_HARDIF_WIFI_CFG80211_DIRECT: it is a cfg80211 wifi device */
151 BATADV_HARDIF_WIFI_CFG80211_DIRECT = BIT(1),
152
153 /**
154 * @BATADV_HARDIF_WIFI_WEXT_INDIRECT: link device is a wext wifi device
155 */
156 BATADV_HARDIF_WIFI_WEXT_INDIRECT = BIT(2),
157
158 /**
159 * @BATADV_HARDIF_WIFI_CFG80211_INDIRECT: link device is a cfg80211 wifi
160 * device
161 */
162 BATADV_HARDIF_WIFI_CFG80211_INDIRECT = BIT(3),
163 };
164
165 /**
166 * struct batadv_hard_iface - network device known to batman-adv
167 */
168 struct batadv_hard_iface {
169 /** @list: list node for batadv_hardif_list */
170 struct list_head list;
171
172 /** @if_status: status of the interface for batman-adv */
173 char if_status;
174
175 /**
176 * @num_bcasts: number of payload re-broadcasts on this interface (ARQ)
177 */
178 u8 num_bcasts;
179
180 /**
181 * @wifi_flags: flags whether this is (directly or indirectly) a wifi
182 * interface
183 */
184 u32 wifi_flags;
185
186 /** @net_dev: pointer to the net_device */
187 struct net_device *net_dev;
188
189 /** @refcount: number of contexts the object is used */
190 struct kref refcount;
191
192 /**
193 * @batman_adv_ptype: packet type describing packets that should be
194 * processed by batman-adv for this interface
195 */
196 struct packet_type batman_adv_ptype;
197
198 /**
199 * @soft_iface: the batman-adv interface which uses this network
200 * interface
201 */
202 struct net_device *soft_iface;
203
204 /** @rcu: struct used for freeing in an RCU-safe manner */
205 struct rcu_head rcu;
206
207 /**
208 * @hop_penalty: penalty which will be applied to the tq-field
209 * of an OGM received via this interface
210 */
211 atomic_t hop_penalty;
212
213 /** @bat_iv: per hard-interface B.A.T.M.A.N. IV data */
214 struct batadv_hard_iface_bat_iv bat_iv;
215
216 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
217 /** @bat_v: per hard-interface B.A.T.M.A.N. V data */
218 struct batadv_hard_iface_bat_v bat_v;
219 #endif
220
221 /**
222 * @neigh_list: list of unique single hop neighbors via this interface
223 */
224 struct hlist_head neigh_list;
225
226 /** @neigh_list_lock: lock protecting neigh_list */
227 spinlock_t neigh_list_lock;
228 };
229
230 /**
231 * struct batadv_orig_ifinfo_bat_iv - B.A.T.M.A.N. IV private orig_ifinfo
232 * members
233 */
234 struct batadv_orig_ifinfo_bat_iv {
235 /**
236 * @bcast_own: bitfield which counts the number of our OGMs this
237 * orig_node rebroadcasted "back" to us (relative to last_real_seqno)
238 */
239 DECLARE_BITMAP(bcast_own, BATADV_TQ_LOCAL_WINDOW_SIZE);
240
241 /** @bcast_own_sum: sum of bcast_own */
242 u8 bcast_own_sum;
243 };
244
245 /**
246 * struct batadv_orig_ifinfo - originator info per outgoing interface
247 */
248 struct batadv_orig_ifinfo {
249 /** @list: list node for &batadv_orig_node.ifinfo_list */
250 struct hlist_node list;
251
252 /** @if_outgoing: pointer to outgoing hard-interface */
253 struct batadv_hard_iface *if_outgoing;
254
255 /** @router: router that should be used to reach this originator */
256 struct batadv_neigh_node __rcu *router;
257
258 /** @last_real_seqno: last and best known sequence number */
259 u32 last_real_seqno;
260
261 /** @last_ttl: ttl of last received packet */
262 u8 last_ttl;
263
264 /** @last_seqno_forwarded: seqno of the OGM which was forwarded last */
265 u32 last_seqno_forwarded;
266
267 /** @batman_seqno_reset: time when the batman seqno window was reset */
268 unsigned long batman_seqno_reset;
269
270 /** @bat_iv: B.A.T.M.A.N. IV private structure */
271 struct batadv_orig_ifinfo_bat_iv bat_iv;
272
273 /** @refcount: number of contexts the object is used */
274 struct kref refcount;
275
276 /** @rcu: struct used for freeing in an RCU-safe manner */
277 struct rcu_head rcu;
278 };
279
280 /**
281 * struct batadv_frag_table_entry - head in the fragment buffer table
282 */
283 struct batadv_frag_table_entry {
284 /** @fragment_list: head of list with fragments */
285 struct hlist_head fragment_list;
286
287 /** @lock: lock to protect the list of fragments */
288 spinlock_t lock;
289
290 /** @timestamp: time (jiffie) of last received fragment */
291 unsigned long timestamp;
292
293 /** @seqno: sequence number of the fragments in the list */
294 u16 seqno;
295
296 /** @size: accumulated size of packets in list */
297 u16 size;
298
299 /** @total_size: expected size of the assembled packet */
300 u16 total_size;
301 };
302
303 /**
304 * struct batadv_frag_list_entry - entry in a list of fragments
305 */
306 struct batadv_frag_list_entry {
307 /** @list: list node information */
308 struct hlist_node list;
309
310 /** @skb: fragment */
311 struct sk_buff *skb;
312
313 /** @no: fragment number in the set */
314 u8 no;
315 };
316
317 /**
318 * struct batadv_vlan_tt - VLAN specific TT attributes
319 */
320 struct batadv_vlan_tt {
321 /** @crc: CRC32 checksum of the entries belonging to this vlan */
322 u32 crc;
323
324 /** @num_entries: number of TT entries for this VLAN */
325 atomic_t num_entries;
326 };
327
328 /**
329 * struct batadv_orig_node_vlan - VLAN specific data per orig_node
330 */
331 struct batadv_orig_node_vlan {
332 /** @vid: the VLAN identifier */
333 unsigned short vid;
334
335 /** @tt: VLAN specific TT attributes */
336 struct batadv_vlan_tt tt;
337
338 /** @list: list node for &batadv_orig_node.vlan_list */
339 struct hlist_node list;
340
341 /**
342 * @refcount: number of context where this object is currently in use
343 */
344 struct kref refcount;
345
346 /** @rcu: struct used for freeing in a RCU-safe manner */
347 struct rcu_head rcu;
348 };
349
350 /**
351 * struct batadv_orig_bat_iv - B.A.T.M.A.N. IV private orig_node members
352 */
353 struct batadv_orig_bat_iv {
354 /**
355 * @ogm_cnt_lock: lock protecting &batadv_orig_ifinfo_bat_iv.bcast_own,
356 * &batadv_orig_ifinfo_bat_iv.bcast_own_sum,
357 * &batadv_neigh_ifinfo_bat_iv.bat_iv.real_bits and
358 * &batadv_neigh_ifinfo_bat_iv.real_packet_count
359 */
360 spinlock_t ogm_cnt_lock;
361 };
362
363 /**
364 * struct batadv_orig_node - structure for orig_list maintaining nodes of mesh
365 */
366 struct batadv_orig_node {
367 /** @orig: originator ethernet address */
368 u8 orig[ETH_ALEN];
369
370 /** @ifinfo_list: list for routers per outgoing interface */
371 struct hlist_head ifinfo_list;
372
373 /**
374 * @last_bonding_candidate: pointer to last ifinfo of last used router
375 */
376 struct batadv_orig_ifinfo *last_bonding_candidate;
377
378 #ifdef CONFIG_BATMAN_ADV_DAT
379 /** @dat_addr: address of the orig node in the distributed hash */
380 batadv_dat_addr_t dat_addr;
381 #endif
382
383 /** @last_seen: time when last packet from this node was received */
384 unsigned long last_seen;
385
386 /**
387 * @bcast_seqno_reset: time when the broadcast seqno window was reset
388 */
389 unsigned long bcast_seqno_reset;
390
391 #ifdef CONFIG_BATMAN_ADV_MCAST
392 /**
393 * @mcast_handler_lock: synchronizes mcast-capability and -flag changes
394 */
395 spinlock_t mcast_handler_lock;
396
397 /** @mcast_flags: multicast flags announced by the orig node */
398 u8 mcast_flags;
399
400 /**
401 * @mcast_want_all_unsnoopables_node: a list node for the
402 * mcast.want_all_unsnoopables list
403 */
404 struct hlist_node mcast_want_all_unsnoopables_node;
405
406 /**
407 * @mcast_want_all_ipv4_node: a list node for the mcast.want_all_ipv4
408 * list
409 */
410 struct hlist_node mcast_want_all_ipv4_node;
411 /**
412 * @mcast_want_all_ipv6_node: a list node for the mcast.want_all_ipv6
413 * list
414 */
415 struct hlist_node mcast_want_all_ipv6_node;
416
417 /**
418 * @mcast_want_all_rtr4_node: a list node for the mcast.want_all_rtr4
419 * list
420 */
421 struct hlist_node mcast_want_all_rtr4_node;
422 /**
423 * @mcast_want_all_rtr6_node: a list node for the mcast.want_all_rtr6
424 * list
425 */
426 struct hlist_node mcast_want_all_rtr6_node;
427 #endif
428
429 /** @capabilities: announced capabilities of this originator */
430 unsigned long capabilities;
431
432 /**
433 * @capa_initialized: bitfield to remember whether a capability was
434 * initialized
435 */
436 unsigned long capa_initialized;
437
438 /** @last_ttvn: last seen translation table version number */
439 atomic_t last_ttvn;
440
441 /** @tt_buff: last tt changeset this node received from the orig node */
442 unsigned char *tt_buff;
443
444 /**
445 * @tt_buff_len: length of the last tt changeset this node received
446 * from the orig node
447 */
448 s16 tt_buff_len;
449
450 /** @tt_buff_lock: lock that protects tt_buff and tt_buff_len */
451 spinlock_t tt_buff_lock;
452
453 /**
454 * @tt_lock: avoids concurrent read from and write to the table. Table
455 * update is made up of two operations (data structure update and
456 * metadata -CRC/TTVN-recalculation) and they have to be executed
457 * atomically in order to avoid another thread to read the
458 * table/metadata between those.
459 */
460 spinlock_t tt_lock;
461
462 /**
463 * @bcast_bits: bitfield containing the info which payload broadcast
464 * originated from this orig node this host already has seen (relative
465 * to last_bcast_seqno)
466 */
467 DECLARE_BITMAP(bcast_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
468
469 /**
470 * @last_bcast_seqno: last broadcast sequence number received by this
471 * host
472 */
473 u32 last_bcast_seqno;
474
475 /**
476 * @neigh_list: list of potential next hop neighbor towards this orig
477 * node
478 */
479 struct hlist_head neigh_list;
480
481 /**
482 * @neigh_list_lock: lock protecting neigh_list, ifinfo_list,
483 * last_bonding_candidate and router
484 */
485 spinlock_t neigh_list_lock;
486
487 /** @hash_entry: hlist node for &batadv_priv.orig_hash */
488 struct hlist_node hash_entry;
489
490 /** @bat_priv: pointer to soft_iface this orig node belongs to */
491 struct batadv_priv *bat_priv;
492
493 /** @bcast_seqno_lock: lock protecting bcast_bits & last_bcast_seqno */
494 spinlock_t bcast_seqno_lock;
495
496 /** @refcount: number of contexts the object is used */
497 struct kref refcount;
498
499 /** @rcu: struct used for freeing in an RCU-safe manner */
500 struct rcu_head rcu;
501
502 #ifdef CONFIG_BATMAN_ADV_NC
503 /** @in_coding_list: list of nodes this orig can hear */
504 struct list_head in_coding_list;
505
506 /** @out_coding_list: list of nodes that can hear this orig */
507 struct list_head out_coding_list;
508
509 /** @in_coding_list_lock: protects in_coding_list */
510 spinlock_t in_coding_list_lock;
511
512 /** @out_coding_list_lock: protects out_coding_list */
513 spinlock_t out_coding_list_lock;
514 #endif
515
516 /** @fragments: array with heads for fragment chains */
517 struct batadv_frag_table_entry fragments[BATADV_FRAG_BUFFER_COUNT];
518
519 /**
520 * @vlan_list: a list of orig_node_vlan structs, one per VLAN served by
521 * the originator represented by this object
522 */
523 struct hlist_head vlan_list;
524
525 /** @vlan_list_lock: lock protecting vlan_list */
526 spinlock_t vlan_list_lock;
527
528 /** @bat_iv: B.A.T.M.A.N. IV private structure */
529 struct batadv_orig_bat_iv bat_iv;
530 };
531
532 /**
533 * enum batadv_orig_capabilities - orig node capabilities
534 */
535 enum batadv_orig_capabilities {
536 /**
537 * @BATADV_ORIG_CAPA_HAS_DAT: orig node has distributed arp table
538 * enabled
539 */
540 BATADV_ORIG_CAPA_HAS_DAT,
541
542 /** @BATADV_ORIG_CAPA_HAS_NC: orig node has network coding enabled */
543 BATADV_ORIG_CAPA_HAS_NC,
544
545 /** @BATADV_ORIG_CAPA_HAS_TT: orig node has tt capability */
546 BATADV_ORIG_CAPA_HAS_TT,
547
548 /**
549 * @BATADV_ORIG_CAPA_HAS_MCAST: orig node has some multicast capability
550 * (= orig node announces a tvlv of type BATADV_TVLV_MCAST)
551 */
552 BATADV_ORIG_CAPA_HAS_MCAST,
553 };
554
555 /**
556 * struct batadv_gw_node - structure for orig nodes announcing gw capabilities
557 */
558 struct batadv_gw_node {
559 /** @list: list node for &batadv_priv_gw.list */
560 struct hlist_node list;
561
562 /** @orig_node: pointer to corresponding orig node */
563 struct batadv_orig_node *orig_node;
564
565 /** @bandwidth_down: advertised uplink download bandwidth */
566 u32 bandwidth_down;
567
568 /** @bandwidth_up: advertised uplink upload bandwidth */
569 u32 bandwidth_up;
570
571 /** @refcount: number of contexts the object is used */
572 struct kref refcount;
573
574 /** @rcu: struct used for freeing in an RCU-safe manner */
575 struct rcu_head rcu;
576 };
577
578 DECLARE_EWMA(throughput, 10, 8)
579
580 /**
581 * struct batadv_hardif_neigh_node_bat_v - B.A.T.M.A.N. V private neighbor
582 * information
583 */
584 struct batadv_hardif_neigh_node_bat_v {
585 /** @throughput: ewma link throughput towards this neighbor */
586 struct ewma_throughput throughput;
587
588 /** @elp_interval: time interval between two ELP transmissions */
589 u32 elp_interval;
590
591 /** @elp_latest_seqno: latest and best known ELP sequence number */
592 u32 elp_latest_seqno;
593
594 /**
595 * @last_unicast_tx: when the last unicast packet has been sent to this
596 * neighbor
597 */
598 unsigned long last_unicast_tx;
599
600 /** @metric_work: work queue callback item for metric update */
601 struct work_struct metric_work;
602 };
603
604 /**
605 * struct batadv_hardif_neigh_node - unique neighbor per hard-interface
606 */
607 struct batadv_hardif_neigh_node {
608 /** @list: list node for &batadv_hard_iface.neigh_list */
609 struct hlist_node list;
610
611 /** @addr: the MAC address of the neighboring interface */
612 u8 addr[ETH_ALEN];
613
614 /**
615 * @orig: the address of the originator this neighbor node belongs to
616 */
617 u8 orig[ETH_ALEN];
618
619 /** @if_incoming: pointer to incoming hard-interface */
620 struct batadv_hard_iface *if_incoming;
621
622 /** @last_seen: when last packet via this neighbor was received */
623 unsigned long last_seen;
624
625 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
626 /** @bat_v: B.A.T.M.A.N. V private data */
627 struct batadv_hardif_neigh_node_bat_v bat_v;
628 #endif
629
630 /** @refcount: number of contexts the object is used */
631 struct kref refcount;
632
633 /** @rcu: struct used for freeing in a RCU-safe manner */
634 struct rcu_head rcu;
635 };
636
637 /**
638 * struct batadv_neigh_node - structure for single hops neighbors
639 */
640 struct batadv_neigh_node {
641 /** @list: list node for &batadv_orig_node.neigh_list */
642 struct hlist_node list;
643
644 /** @orig_node: pointer to corresponding orig_node */
645 struct batadv_orig_node *orig_node;
646
647 /** @addr: the MAC address of the neighboring interface */
648 u8 addr[ETH_ALEN];
649
650 /** @ifinfo_list: list for routing metrics per outgoing interface */
651 struct hlist_head ifinfo_list;
652
653 /** @ifinfo_lock: lock protecting ifinfo_list and its members */
654 spinlock_t ifinfo_lock;
655
656 /** @if_incoming: pointer to incoming hard-interface */
657 struct batadv_hard_iface *if_incoming;
658
659 /** @last_seen: when last packet via this neighbor was received */
660 unsigned long last_seen;
661
662 /** @hardif_neigh: hardif_neigh of this neighbor */
663 struct batadv_hardif_neigh_node *hardif_neigh;
664
665 /** @refcount: number of contexts the object is used */
666 struct kref refcount;
667
668 /** @rcu: struct used for freeing in an RCU-safe manner */
669 struct rcu_head rcu;
670 };
671
672 /**
673 * struct batadv_neigh_ifinfo_bat_iv - neighbor information per outgoing
674 * interface for B.A.T.M.A.N. IV
675 */
676 struct batadv_neigh_ifinfo_bat_iv {
677 /** @tq_recv: ring buffer of received TQ values from this neigh node */
678 u8 tq_recv[BATADV_TQ_GLOBAL_WINDOW_SIZE];
679
680 /** @tq_index: ring buffer index */
681 u8 tq_index;
682
683 /**
684 * @tq_avg: averaged tq of all tq values in the ring buffer (tq_recv)
685 */
686 u8 tq_avg;
687
688 /**
689 * @real_bits: bitfield containing the number of OGMs received from this
690 * neigh node (relative to orig_node->last_real_seqno)
691 */
692 DECLARE_BITMAP(real_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
693
694 /** @real_packet_count: counted result of real_bits */
695 u8 real_packet_count;
696 };
697
698 /**
699 * struct batadv_neigh_ifinfo_bat_v - neighbor information per outgoing
700 * interface for B.A.T.M.A.N. V
701 */
702 struct batadv_neigh_ifinfo_bat_v {
703 /**
704 * @throughput: last throughput metric received from originator via this
705 * neigh
706 */
707 u32 throughput;
708
709 /** @last_seqno: last sequence number known for this neighbor */
710 u32 last_seqno;
711 };
712
713 /**
714 * struct batadv_neigh_ifinfo - neighbor information per outgoing interface
715 */
716 struct batadv_neigh_ifinfo {
717 /** @list: list node for &batadv_neigh_node.ifinfo_list */
718 struct hlist_node list;
719
720 /** @if_outgoing: pointer to outgoing hard-interface */
721 struct batadv_hard_iface *if_outgoing;
722
723 /** @bat_iv: B.A.T.M.A.N. IV private structure */
724 struct batadv_neigh_ifinfo_bat_iv bat_iv;
725
726 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
727 /** @bat_v: B.A.T.M.A.N. V private data */
728 struct batadv_neigh_ifinfo_bat_v bat_v;
729 #endif
730
731 /** @last_ttl: last received ttl from this neigh node */
732 u8 last_ttl;
733
734 /** @refcount: number of contexts the object is used */
735 struct kref refcount;
736
737 /** @rcu: struct used for freeing in a RCU-safe manner */
738 struct rcu_head rcu;
739 };
740
741 #ifdef CONFIG_BATMAN_ADV_BLA
742
743 /**
744 * struct batadv_bcast_duplist_entry - structure for LAN broadcast suppression
745 */
746 struct batadv_bcast_duplist_entry {
747 /** @orig: mac address of orig node originating the broadcast */
748 u8 orig[ETH_ALEN];
749
750 /** @crc: crc32 checksum of broadcast payload */
751 __be32 crc;
752
753 /** @entrytime: time when the broadcast packet was received */
754 unsigned long entrytime;
755 };
756 #endif
757
758 /**
759 * enum batadv_counters - indices for traffic counters
760 */
761 enum batadv_counters {
762 /** @BATADV_CNT_TX: transmitted payload traffic packet counter */
763 BATADV_CNT_TX,
764
765 /** @BATADV_CNT_TX_BYTES: transmitted payload traffic bytes counter */
766 BATADV_CNT_TX_BYTES,
767
768 /**
769 * @BATADV_CNT_TX_DROPPED: dropped transmission payload traffic packet
770 * counter
771 */
772 BATADV_CNT_TX_DROPPED,
773
774 /** @BATADV_CNT_RX: received payload traffic packet counter */
775 BATADV_CNT_RX,
776
777 /** @BATADV_CNT_RX_BYTES: received payload traffic bytes counter */
778 BATADV_CNT_RX_BYTES,
779
780 /** @BATADV_CNT_FORWARD: forwarded payload traffic packet counter */
781 BATADV_CNT_FORWARD,
782
783 /**
784 * @BATADV_CNT_FORWARD_BYTES: forwarded payload traffic bytes counter
785 */
786 BATADV_CNT_FORWARD_BYTES,
787
788 /**
789 * @BATADV_CNT_MGMT_TX: transmitted routing protocol traffic packet
790 * counter
791 */
792 BATADV_CNT_MGMT_TX,
793
794 /**
795 * @BATADV_CNT_MGMT_TX_BYTES: transmitted routing protocol traffic bytes
796 * counter
797 */
798 BATADV_CNT_MGMT_TX_BYTES,
799
800 /**
801 * @BATADV_CNT_MGMT_RX: received routing protocol traffic packet counter
802 */
803 BATADV_CNT_MGMT_RX,
804
805 /**
806 * @BATADV_CNT_MGMT_RX_BYTES: received routing protocol traffic bytes
807 * counter
808 */
809 BATADV_CNT_MGMT_RX_BYTES,
810
811 /** @BATADV_CNT_FRAG_TX: transmitted fragment traffic packet counter */
812 BATADV_CNT_FRAG_TX,
813
814 /**
815 * @BATADV_CNT_FRAG_TX_BYTES: transmitted fragment traffic bytes counter
816 */
817 BATADV_CNT_FRAG_TX_BYTES,
818
819 /** @BATADV_CNT_FRAG_RX: received fragment traffic packet counter */
820 BATADV_CNT_FRAG_RX,
821
822 /**
823 * @BATADV_CNT_FRAG_RX_BYTES: received fragment traffic bytes counter
824 */
825 BATADV_CNT_FRAG_RX_BYTES,
826
827 /** @BATADV_CNT_FRAG_FWD: forwarded fragment traffic packet counter */
828 BATADV_CNT_FRAG_FWD,
829
830 /**
831 * @BATADV_CNT_FRAG_FWD_BYTES: forwarded fragment traffic bytes counter
832 */
833 BATADV_CNT_FRAG_FWD_BYTES,
834
835 /**
836 * @BATADV_CNT_TT_REQUEST_TX: transmitted tt req traffic packet counter
837 */
838 BATADV_CNT_TT_REQUEST_TX,
839
840 /** @BATADV_CNT_TT_REQUEST_RX: received tt req traffic packet counter */
841 BATADV_CNT_TT_REQUEST_RX,
842
843 /**
844 * @BATADV_CNT_TT_RESPONSE_TX: transmitted tt resp traffic packet
845 * counter
846 */
847 BATADV_CNT_TT_RESPONSE_TX,
848
849 /**
850 * @BATADV_CNT_TT_RESPONSE_RX: received tt resp traffic packet counter
851 */
852 BATADV_CNT_TT_RESPONSE_RX,
853
854 /**
855 * @BATADV_CNT_TT_ROAM_ADV_TX: transmitted tt roam traffic packet
856 * counter
857 */
858 BATADV_CNT_TT_ROAM_ADV_TX,
859
860 /**
861 * @BATADV_CNT_TT_ROAM_ADV_RX: received tt roam traffic packet counter
862 */
863 BATADV_CNT_TT_ROAM_ADV_RX,
864
865 #ifdef CONFIG_BATMAN_ADV_MCAST
866 /**
867 * @BATADV_CNT_MCAST_TX: transmitted batman-adv multicast packets
868 * counter
869 */
870 BATADV_CNT_MCAST_TX,
871
872 /**
873 * @BATADV_CNT_MCAST_TX_BYTES: transmitted batman-adv multicast packets
874 * bytes counter
875 */
876 BATADV_CNT_MCAST_TX_BYTES,
877
878 /**
879 * @BATADV_CNT_MCAST_TX_LOCAL: counter for multicast packets which
880 * were locally encapsulated and transmitted as batman-adv multicast
881 * packets
882 */
883 BATADV_CNT_MCAST_TX_LOCAL,
884
885 /**
886 * @BATADV_CNT_MCAST_TX_LOCAL_BYTES: bytes counter for multicast packets
887 * which were locally encapsulated and transmitted as batman-adv
888 * multicast packets
889 */
890 BATADV_CNT_MCAST_TX_LOCAL_BYTES,
891
892 /**
893 * @BATADV_CNT_MCAST_RX: received batman-adv multicast packet counter
894 */
895 BATADV_CNT_MCAST_RX,
896
897 /**
898 * @BATADV_CNT_MCAST_RX_BYTES: received batman-adv multicast packet
899 * bytes counter
900 */
901 BATADV_CNT_MCAST_RX_BYTES,
902
903 /**
904 * @BATADV_CNT_MCAST_RX_LOCAL: counter for received batman-adv multicast
905 * packets which were forwarded to the local soft interface
906 */
907 BATADV_CNT_MCAST_RX_LOCAL,
908
909 /**
910 * @BATADV_CNT_MCAST_RX_LOCAL_BYTES: bytes counter for received
911 * batman-adv multicast packets which were forwarded to the local soft
912 * interface
913 */
914 BATADV_CNT_MCAST_RX_LOCAL_BYTES,
915
916 /**
917 * @BATADV_CNT_MCAST_FWD: counter for received batman-adv multicast
918 * packets which were forwarded to other, neighboring nodes
919 */
920 BATADV_CNT_MCAST_FWD,
921
922 /**
923 * @BATADV_CNT_MCAST_FWD_BYTES: bytes counter for received batman-adv
924 * multicast packets which were forwarded to other, neighboring nodes
925 */
926 BATADV_CNT_MCAST_FWD_BYTES,
927 #endif
928
929 #ifdef CONFIG_BATMAN_ADV_DAT
930 /**
931 * @BATADV_CNT_DAT_GET_TX: transmitted dht GET traffic packet counter
932 */
933 BATADV_CNT_DAT_GET_TX,
934
935 /** @BATADV_CNT_DAT_GET_RX: received dht GET traffic packet counter */
936 BATADV_CNT_DAT_GET_RX,
937
938 /**
939 * @BATADV_CNT_DAT_PUT_TX: transmitted dht PUT traffic packet counter
940 */
941 BATADV_CNT_DAT_PUT_TX,
942
943 /** @BATADV_CNT_DAT_PUT_RX: received dht PUT traffic packet counter */
944 BATADV_CNT_DAT_PUT_RX,
945
946 /**
947 * @BATADV_CNT_DAT_CACHED_REPLY_TX: transmitted dat cache reply traffic
948 * packet counter
949 */
950 BATADV_CNT_DAT_CACHED_REPLY_TX,
951 #endif
952
953 #ifdef CONFIG_BATMAN_ADV_NC
954 /**
955 * @BATADV_CNT_NC_CODE: transmitted nc-combined traffic packet counter
956 */
957 BATADV_CNT_NC_CODE,
958
959 /**
960 * @BATADV_CNT_NC_CODE_BYTES: transmitted nc-combined traffic bytes
961 * counter
962 */
963 BATADV_CNT_NC_CODE_BYTES,
964
965 /**
966 * @BATADV_CNT_NC_RECODE: transmitted nc-recombined traffic packet
967 * counter
968 */
969 BATADV_CNT_NC_RECODE,
970
971 /**
972 * @BATADV_CNT_NC_RECODE_BYTES: transmitted nc-recombined traffic bytes
973 * counter
974 */
975 BATADV_CNT_NC_RECODE_BYTES,
976
977 /**
978 * @BATADV_CNT_NC_BUFFER: counter for packets buffered for later nc
979 * decoding
980 */
981 BATADV_CNT_NC_BUFFER,
982
983 /**
984 * @BATADV_CNT_NC_DECODE: received and nc-decoded traffic packet counter
985 */
986 BATADV_CNT_NC_DECODE,
987
988 /**
989 * @BATADV_CNT_NC_DECODE_BYTES: received and nc-decoded traffic bytes
990 * counter
991 */
992 BATADV_CNT_NC_DECODE_BYTES,
993
994 /**
995 * @BATADV_CNT_NC_DECODE_FAILED: received and decode-failed traffic
996 * packet counter
997 */
998 BATADV_CNT_NC_DECODE_FAILED,
999
1000 /**
1001 * @BATADV_CNT_NC_SNIFFED: counter for nc-decoded packets received in
1002 * promisc mode.
1003 */
1004 BATADV_CNT_NC_SNIFFED,
1005 #endif
1006
1007 /** @BATADV_CNT_NUM: number of traffic counters */
1008 BATADV_CNT_NUM,
1009 };
1010
1011 /**
1012 * struct batadv_priv_tt - per mesh interface translation table data
1013 */
1014 struct batadv_priv_tt {
1015 /** @vn: translation table version number */
1016 atomic_t vn;
1017
1018 /**
1019 * @ogm_append_cnt: counter of number of OGMs containing the local tt
1020 * diff
1021 */
1022 atomic_t ogm_append_cnt;
1023
1024 /** @local_changes: changes registered in an originator interval */
1025 atomic_t local_changes;
1026
1027 /**
1028 * @changes_list: tracks tt local changes within an originator interval
1029 */
1030 struct list_head changes_list;
1031
1032 /** @local_hash: local translation table hash table */
1033 struct batadv_hashtable *local_hash;
1034
1035 /** @global_hash: global translation table hash table */
1036 struct batadv_hashtable *global_hash;
1037
1038 /** @req_list: list of pending & unanswered tt_requests */
1039 struct hlist_head req_list;
1040
1041 /**
1042 * @roam_list: list of the last roaming events of each client limiting
1043 * the number of roaming events to avoid route flapping
1044 */
1045 struct list_head roam_list;
1046
1047 /** @changes_list_lock: lock protecting changes_list */
1048 spinlock_t changes_list_lock;
1049
1050 /** @req_list_lock: lock protecting req_list */
1051 spinlock_t req_list_lock;
1052
1053 /** @roam_list_lock: lock protecting roam_list */
1054 spinlock_t roam_list_lock;
1055
1056 /** @last_changeset: last tt changeset this host has generated */
1057 unsigned char *last_changeset;
1058
1059 /**
1060 * @last_changeset_len: length of last tt changeset this host has
1061 * generated
1062 */
1063 s16 last_changeset_len;
1064
1065 /**
1066 * @last_changeset_lock: lock protecting last_changeset &
1067 * last_changeset_len
1068 */
1069 spinlock_t last_changeset_lock;
1070
1071 /**
1072 * @commit_lock: prevents from executing a local TT commit while reading
1073 * the local table. The local TT commit is made up of two operations
1074 * (data structure update and metadata -CRC/TTVN- recalculation) and
1075 * they have to be executed atomically in order to avoid another thread
1076 * to read the table/metadata between those.
1077 */
1078 spinlock_t commit_lock;
1079
1080 /** @work: work queue callback item for translation table purging */
1081 struct delayed_work work;
1082 };
1083
1084 #ifdef CONFIG_BATMAN_ADV_BLA
1085
1086 /**
1087 * struct batadv_priv_bla - per mesh interface bridge loop avoidance data
1088 */
1089 struct batadv_priv_bla {
1090 /** @num_requests: number of bla requests in flight */
1091 atomic_t num_requests;
1092
1093 /**
1094 * @claim_hash: hash table containing mesh nodes this host has claimed
1095 */
1096 struct batadv_hashtable *claim_hash;
1097
1098 /**
1099 * @backbone_hash: hash table containing all detected backbone gateways
1100 */
1101 struct batadv_hashtable *backbone_hash;
1102
1103 /** @loopdetect_addr: MAC address used for own loopdetection frames */
1104 u8 loopdetect_addr[ETH_ALEN];
1105
1106 /**
1107 * @loopdetect_lasttime: time when the loopdetection frames were sent
1108 */
1109 unsigned long loopdetect_lasttime;
1110
1111 /**
1112 * @loopdetect_next: how many periods to wait for the next loopdetect
1113 * process
1114 */
1115 atomic_t loopdetect_next;
1116
1117 /**
1118 * @bcast_duplist: recently received broadcast packets array (for
1119 * broadcast duplicate suppression)
1120 */
1121 struct batadv_bcast_duplist_entry bcast_duplist[BATADV_DUPLIST_SIZE];
1122
1123 /**
1124 * @bcast_duplist_curr: index of last broadcast packet added to
1125 * bcast_duplist
1126 */
1127 int bcast_duplist_curr;
1128
1129 /**
1130 * @bcast_duplist_lock: lock protecting bcast_duplist &
1131 * bcast_duplist_curr
1132 */
1133 spinlock_t bcast_duplist_lock;
1134
1135 /** @claim_dest: local claim data (e.g. claim group) */
1136 struct batadv_bla_claim_dst claim_dest;
1137
1138 /** @work: work queue callback item for cleanups & bla announcements */
1139 struct delayed_work work;
1140 };
1141 #endif
1142
1143 #ifdef CONFIG_BATMAN_ADV_DEBUG
1144
1145 /**
1146 * struct batadv_priv_debug_log - debug logging data
1147 */
1148 struct batadv_priv_debug_log {
1149 /** @log_buff: buffer holding the logs (ring buffer) */
1150 char log_buff[BATADV_LOG_BUF_LEN];
1151
1152 /** @log_start: index of next character to read */
1153 unsigned long log_start;
1154
1155 /** @log_end: index of next character to write */
1156 unsigned long log_end;
1157
1158 /** @lock: lock protecting log_buff, log_start & log_end */
1159 spinlock_t lock;
1160
1161 /** @queue_wait: log reader's wait queue */
1162 wait_queue_head_t queue_wait;
1163 };
1164 #endif
1165
1166 /**
1167 * struct batadv_priv_gw - per mesh interface gateway data
1168 */
1169 struct batadv_priv_gw {
1170 /** @gateway_list: list of available gateway nodes */
1171 struct hlist_head gateway_list;
1172
1173 /** @list_lock: lock protecting gateway_list, curr_gw, generation */
1174 spinlock_t list_lock;
1175
1176 /** @curr_gw: pointer to currently selected gateway node */
1177 struct batadv_gw_node __rcu *curr_gw;
1178
1179 /** @generation: current (generation) sequence number */
1180 unsigned int generation;
1181
1182 /**
1183 * @mode: gateway operation: off, client or server (see batadv_gw_modes)
1184 */
1185 atomic_t mode;
1186
1187 /** @sel_class: gateway selection class (applies if gw_mode client) */
1188 atomic_t sel_class;
1189
1190 /**
1191 * @bandwidth_down: advertised uplink download bandwidth (if gw_mode
1192 * server)
1193 */
1194 atomic_t bandwidth_down;
1195
1196 /**
1197 * @bandwidth_up: advertised uplink upload bandwidth (if gw_mode server)
1198 */
1199 atomic_t bandwidth_up;
1200
1201 /** @reselect: bool indicating a gateway re-selection is in progress */
1202 atomic_t reselect;
1203 };
1204
1205 /**
1206 * struct batadv_priv_tvlv - per mesh interface tvlv data
1207 */
1208 struct batadv_priv_tvlv {
1209 /**
1210 * @container_list: list of registered tvlv containers to be sent with
1211 * each OGM
1212 */
1213 struct hlist_head container_list;
1214
1215 /** @handler_list: list of the various tvlv content handlers */
1216 struct hlist_head handler_list;
1217
1218 /** @container_list_lock: protects tvlv container list access */
1219 spinlock_t container_list_lock;
1220
1221 /** @handler_list_lock: protects handler list access */
1222 spinlock_t handler_list_lock;
1223 };
1224
1225 #ifdef CONFIG_BATMAN_ADV_DAT
1226
1227 /**
1228 * struct batadv_priv_dat - per mesh interface DAT private data
1229 */
1230 struct batadv_priv_dat {
1231 /** @addr: node DAT address */
1232 batadv_dat_addr_t addr;
1233
1234 /** @hash: hashtable representing the local ARP cache */
1235 struct batadv_hashtable *hash;
1236
1237 /** @work: work queue callback item for cache purging */
1238 struct delayed_work work;
1239 };
1240 #endif
1241
1242 #ifdef CONFIG_BATMAN_ADV_MCAST
1243 /**
1244 * struct batadv_mcast_querier_state - IGMP/MLD querier state when bridged
1245 */
1246 struct batadv_mcast_querier_state {
1247 /** @exists: whether a querier exists in the mesh */
1248 unsigned char exists:1;
1249
1250 /**
1251 * @shadowing: if a querier exists, whether it is potentially shadowing
1252 * multicast listeners (i.e. querier is behind our own bridge segment)
1253 */
1254 unsigned char shadowing:1;
1255 };
1256
1257 /**
1258 * struct batadv_mcast_mla_flags - flags for the querier, bridge and tvlv state
1259 */
1260 struct batadv_mcast_mla_flags {
1261 /** @querier_ipv4: the current state of an IGMP querier in the mesh */
1262 struct batadv_mcast_querier_state querier_ipv4;
1263
1264 /** @querier_ipv6: the current state of an MLD querier in the mesh */
1265 struct batadv_mcast_querier_state querier_ipv6;
1266
1267 /** @enabled: whether the multicast tvlv is currently enabled */
1268 unsigned char enabled:1;
1269
1270 /** @bridged: whether the soft interface has a bridge on top */
1271 unsigned char bridged:1;
1272
1273 /** @tvlv_flags: the flags we have last sent in our mcast tvlv */
1274 u8 tvlv_flags;
1275 };
1276
1277 /**
1278 * struct batadv_priv_mcast - per mesh interface mcast data
1279 */
1280 struct batadv_priv_mcast {
1281 /**
1282 * @mla_list: list of multicast addresses we are currently announcing
1283 * via TT
1284 */
1285 struct hlist_head mla_list; /* see __batadv_mcast_mla_update() */
1286
1287 /**
1288 * @want_all_unsnoopables_list: a list of orig_nodes wanting all
1289 * unsnoopable multicast traffic
1290 */
1291 struct hlist_head want_all_unsnoopables_list;
1292
1293 /**
1294 * @want_all_ipv4_list: a list of orig_nodes wanting all IPv4 multicast
1295 * traffic
1296 */
1297 struct hlist_head want_all_ipv4_list;
1298
1299 /**
1300 * @want_all_ipv6_list: a list of orig_nodes wanting all IPv6 multicast
1301 * traffic
1302 */
1303 struct hlist_head want_all_ipv6_list;
1304
1305 /**
1306 * @want_all_rtr4_list: a list of orig_nodes wanting all routable IPv4
1307 * multicast traffic
1308 */
1309 struct hlist_head want_all_rtr4_list;
1310
1311 /**
1312 * @want_all_rtr6_list: a list of orig_nodes wanting all routable IPv6
1313 * multicast traffic
1314 */
1315 struct hlist_head want_all_rtr6_list;
1316
1317 /**
1318 * @mla_flags: flags for the querier, bridge and tvlv state
1319 */
1320 struct batadv_mcast_mla_flags mla_flags;
1321
1322 /**
1323 * @mla_lock: a lock protecting mla_list and mla_flags
1324 */
1325 spinlock_t mla_lock;
1326
1327 /**
1328 * @num_want_all_unsnoopables: number of nodes wanting unsnoopable IP
1329 * traffic
1330 */
1331 atomic_t num_want_all_unsnoopables;
1332
1333 /** @num_want_all_ipv4: counter for items in want_all_ipv4_list */
1334 atomic_t num_want_all_ipv4;
1335
1336 /** @num_want_all_ipv6: counter for items in want_all_ipv6_list */
1337 atomic_t num_want_all_ipv6;
1338
1339 /** @num_want_all_rtr4: counter for items in want_all_rtr4_list */
1340 atomic_t num_want_all_rtr4;
1341
1342 /** @num_want_all_rtr6: counter for items in want_all_rtr6_list */
1343 atomic_t num_want_all_rtr6;
1344
1345 /**
1346 * @num_no_mc_ptype_capa: counter for number of nodes without the
1347 * BATADV_MCAST_HAVE_MC_PTYPE_CAPA flag
1348 */
1349 atomic_t num_no_mc_ptype_capa;
1350
1351 /**
1352 * @want_lists_lock: lock for protecting modifications to mcasts
1353 * want_all_{unsnoopables,ipv4,ipv6}_list (traversals are rcu-locked)
1354 */
1355 spinlock_t want_lists_lock;
1356
1357 /** @work: work queue callback item for multicast TT and TVLV updates */
1358 struct delayed_work work;
1359 };
1360 #endif
1361
1362 /**
1363 * struct batadv_priv_nc - per mesh interface network coding private data
1364 */
1365 struct batadv_priv_nc {
1366 /** @work: work queue callback item for cleanup */
1367 struct delayed_work work;
1368
1369 /**
1370 * @min_tq: only consider neighbors for encoding if neigh_tq > min_tq
1371 */
1372 u8 min_tq;
1373
1374 /**
1375 * @max_fwd_delay: maximum packet forward delay to allow coding of
1376 * packets
1377 */
1378 u32 max_fwd_delay;
1379
1380 /**
1381 * @max_buffer_time: buffer time for sniffed packets used to decoding
1382 */
1383 u32 max_buffer_time;
1384
1385 /**
1386 * @timestamp_fwd_flush: timestamp of last forward packet queue flush
1387 */
1388 unsigned long timestamp_fwd_flush;
1389
1390 /**
1391 * @timestamp_sniffed_purge: timestamp of last sniffed packet queue
1392 * purge
1393 */
1394 unsigned long timestamp_sniffed_purge;
1395
1396 /**
1397 * @coding_hash: Hash table used to buffer skbs while waiting for
1398 * another incoming skb to code it with. Skbs are added to the buffer
1399 * just before being forwarded in routing.c
1400 */
1401 struct batadv_hashtable *coding_hash;
1402
1403 /**
1404 * @decoding_hash: Hash table used to buffer skbs that might be needed
1405 * to decode a received coded skb. The buffer is used for 1) skbs
1406 * arriving on the soft-interface; 2) skbs overheard on the
1407 * hard-interface; and 3) skbs forwarded by batman-adv.
1408 */
1409 struct batadv_hashtable *decoding_hash;
1410 };
1411
1412 /**
1413 * struct batadv_tp_unacked - unacked packet meta-information
1414 *
1415 * This struct is supposed to represent a buffer unacked packet. However, since
1416 * the purpose of the TP meter is to count the traffic only, there is no need to
1417 * store the entire sk_buff, the starting offset and the length are enough
1418 */
1419 struct batadv_tp_unacked {
1420 /** @seqno: seqno of the unacked packet */
1421 u32 seqno;
1422
1423 /** @len: length of the packet */
1424 u16 len;
1425
1426 /** @list: list node for &batadv_tp_vars.unacked_list */
1427 struct list_head list;
1428 };
1429
1430 /**
1431 * enum batadv_tp_meter_role - Modus in tp meter session
1432 */
1433 enum batadv_tp_meter_role {
1434 /** @BATADV_TP_RECEIVER: Initialized as receiver */
1435 BATADV_TP_RECEIVER,
1436
1437 /** @BATADV_TP_SENDER: Initialized as sender */
1438 BATADV_TP_SENDER
1439 };
1440
1441 /**
1442 * struct batadv_tp_vars - tp meter private variables per session
1443 */
1444 struct batadv_tp_vars {
1445 /** @list: list node for &bat_priv.tp_list */
1446 struct hlist_node list;
1447
1448 /** @timer: timer for ack (receiver) and retry (sender) */
1449 struct timer_list timer;
1450
1451 /** @bat_priv: pointer to the mesh object */
1452 struct batadv_priv *bat_priv;
1453
1454 /** @start_time: start time in jiffies */
1455 unsigned long start_time;
1456
1457 /** @other_end: mac address of remote */
1458 u8 other_end[ETH_ALEN];
1459
1460 /** @role: receiver/sender modi */
1461 enum batadv_tp_meter_role role;
1462
1463 /** @sending: sending binary semaphore: 1 if sending, 0 is not */
1464 atomic_t sending;
1465
1466 /** @reason: reason for a stopped session */
1467 enum batadv_tp_meter_reason reason;
1468
1469 /** @finish_work: work item for the finishing procedure */
1470 struct delayed_work finish_work;
1471
1472 /** @test_length: test length in milliseconds */
1473 u32 test_length;
1474
1475 /** @session: TP session identifier */
1476 u8 session[2];
1477
1478 /** @icmp_uid: local ICMP "socket" index */
1479 u8 icmp_uid;
1480
1481 /* sender variables */
1482
1483 /** @dec_cwnd: decimal part of the cwnd used during linear growth */
1484 u16 dec_cwnd;
1485
1486 /** @cwnd: current size of the congestion window */
1487 u32 cwnd;
1488
1489 /** @cwnd_lock: lock do protect @cwnd & @dec_cwnd */
1490 spinlock_t cwnd_lock;
1491
1492 /**
1493 * @ss_threshold: Slow Start threshold. Once cwnd exceeds this value the
1494 * connection switches to the Congestion Avoidance state
1495 */
1496 u32 ss_threshold;
1497
1498 /** @last_acked: last acked byte */
1499 atomic_t last_acked;
1500
1501 /** @last_sent: last sent byte, not yet acked */
1502 u32 last_sent;
1503
1504 /** @tot_sent: amount of data sent/ACKed so far */
1505 atomic64_t tot_sent;
1506
1507 /** @dup_acks: duplicate ACKs counter */
1508 atomic_t dup_acks;
1509
1510 /** @fast_recovery: true if in Fast Recovery mode */
1511 unsigned char fast_recovery:1;
1512
1513 /** @recover: last sent seqno when entering Fast Recovery */
1514 u32 recover;
1515
1516 /** @rto: sender timeout */
1517 u32 rto;
1518
1519 /** @srtt: smoothed RTT scaled by 2^3 */
1520 u32 srtt;
1521
1522 /** @rttvar: RTT variation scaled by 2^2 */
1523 u32 rttvar;
1524
1525 /**
1526 * @more_bytes: waiting queue anchor when waiting for more ack/retry
1527 * timeout
1528 */
1529 wait_queue_head_t more_bytes;
1530
1531 /** @prerandom_offset: offset inside the prerandom buffer */
1532 u32 prerandom_offset;
1533
1534 /** @prerandom_lock: spinlock protecting access to prerandom_offset */
1535 spinlock_t prerandom_lock;
1536
1537 /* receiver variables */
1538
1539 /** @last_recv: last in-order received packet */
1540 u32 last_recv;
1541
1542 /** @unacked_list: list of unacked packets (meta-info only) */
1543 struct list_head unacked_list;
1544
1545 /** @unacked_lock: protect unacked_list */
1546 spinlock_t unacked_lock;
1547
1548 /** @last_recv_time: time (jiffies) a msg was received */
1549 unsigned long last_recv_time;
1550
1551 /** @refcount: number of context where the object is used */
1552 struct kref refcount;
1553
1554 /** @rcu: struct used for freeing in an RCU-safe manner */
1555 struct rcu_head rcu;
1556 };
1557
1558 /**
1559 * struct batadv_softif_vlan - per VLAN attributes set
1560 */
1561 struct batadv_softif_vlan {
1562 /** @bat_priv: pointer to the mesh object */
1563 struct batadv_priv *bat_priv;
1564
1565 /** @vid: VLAN identifier */
1566 unsigned short vid;
1567
1568 /** @ap_isolation: AP isolation state */
1569 atomic_t ap_isolation; /* boolean */
1570
1571 /** @tt: TT private attributes (VLAN specific) */
1572 struct batadv_vlan_tt tt;
1573
1574 /** @list: list node for &bat_priv.softif_vlan_list */
1575 struct hlist_node list;
1576
1577 /**
1578 * @refcount: number of context where this object is currently in use
1579 */
1580 struct kref refcount;
1581
1582 /** @rcu: struct used for freeing in a RCU-safe manner */
1583 struct rcu_head rcu;
1584 };
1585
1586 /**
1587 * struct batadv_priv_bat_v - B.A.T.M.A.N. V per soft-interface private data
1588 */
1589 struct batadv_priv_bat_v {
1590 /** @ogm_buff: buffer holding the OGM packet */
1591 unsigned char *ogm_buff;
1592
1593 /** @ogm_buff_len: length of the OGM packet buffer */
1594 int ogm_buff_len;
1595
1596 /** @ogm_seqno: OGM sequence number - used to identify each OGM */
1597 atomic_t ogm_seqno;
1598
1599 /** @ogm_buff_mutex: lock protecting ogm_buff and ogm_buff_len */
1600 struct mutex ogm_buff_mutex;
1601
1602 /** @ogm_wq: workqueue used to schedule OGM transmissions */
1603 struct delayed_work ogm_wq;
1604 };
1605
1606 /**
1607 * struct batadv_priv - per mesh interface data
1608 */
1609 struct batadv_priv {
1610 /**
1611 * @mesh_state: current status of the mesh
1612 * (inactive/active/deactivating)
1613 */
1614 atomic_t mesh_state;
1615
1616 /** @soft_iface: net device which holds this struct as private data */
1617 struct net_device *soft_iface;
1618
1619 /**
1620 * @mtu_set_by_user: MTU was set once by user
1621 * protected by rtnl_lock
1622 */
1623 int mtu_set_by_user;
1624
1625 /**
1626 * @bat_counters: mesh internal traffic statistic counters (see
1627 * batadv_counters)
1628 */
1629 u64 __percpu *bat_counters; /* Per cpu counters */
1630
1631 /**
1632 * @aggregated_ogms: bool indicating whether OGM aggregation is enabled
1633 */
1634 atomic_t aggregated_ogms;
1635
1636 /** @bonding: bool indicating whether traffic bonding is enabled */
1637 atomic_t bonding;
1638
1639 /**
1640 * @fragmentation: bool indicating whether traffic fragmentation is
1641 * enabled
1642 */
1643 atomic_t fragmentation;
1644
1645 /**
1646 * @packet_size_max: max packet size that can be transmitted via
1647 * multiple fragmented skbs or a single frame if fragmentation is
1648 * disabled
1649 */
1650 atomic_t packet_size_max;
1651
1652 /**
1653 * @frag_seqno: incremental counter to identify chains of egress
1654 * fragments
1655 */
1656 atomic_t frag_seqno;
1657
1658 #ifdef CONFIG_BATMAN_ADV_BLA
1659 /**
1660 * @bridge_loop_avoidance: bool indicating whether bridge loop
1661 * avoidance is enabled
1662 */
1663 atomic_t bridge_loop_avoidance;
1664 #endif
1665
1666 #ifdef CONFIG_BATMAN_ADV_DAT
1667 /**
1668 * @distributed_arp_table: bool indicating whether distributed ARP table
1669 * is enabled
1670 */
1671 atomic_t distributed_arp_table;
1672 #endif
1673
1674 #ifdef CONFIG_BATMAN_ADV_MCAST
1675 /**
1676 * @multicast_mode: Enable or disable multicast optimizations on this
1677 * node's sender/originating side
1678 */
1679 atomic_t multicast_mode;
1680
1681 /**
1682 * @multicast_fanout: Maximum number of packet copies to generate for a
1683 * multicast-to-unicast conversion
1684 */
1685 atomic_t multicast_fanout;
1686 #endif
1687
1688 /** @orig_interval: OGM broadcast interval in milliseconds */
1689 atomic_t orig_interval;
1690
1691 /**
1692 * @hop_penalty: penalty which will be applied to an OGM's tq-field on
1693 * every hop
1694 */
1695 atomic_t hop_penalty;
1696
1697 #ifdef CONFIG_BATMAN_ADV_DEBUG
1698 /** @log_level: configured log level (see batadv_dbg_level) */
1699 atomic_t log_level;
1700 #endif
1701
1702 /**
1703 * @isolation_mark: the skb->mark value used to match packets for AP
1704 * isolation
1705 */
1706 u32 isolation_mark;
1707
1708 /**
1709 * @isolation_mark_mask: bitmask identifying the bits in skb->mark to be
1710 * used for the isolation mark
1711 */
1712 u32 isolation_mark_mask;
1713
1714 /** @bcast_seqno: last sent broadcast packet sequence number */
1715 atomic_t bcast_seqno;
1716
1717 /**
1718 * @bcast_queue_left: number of remaining buffered broadcast packet
1719 * slots
1720 */
1721 atomic_t bcast_queue_left;
1722
1723 /** @batman_queue_left: number of remaining OGM packet slots */
1724 atomic_t batman_queue_left;
1725
1726 /** @forw_bat_list: list of aggregated OGMs that will be forwarded */
1727 struct hlist_head forw_bat_list;
1728
1729 /**
1730 * @forw_bcast_list: list of broadcast packets that will be
1731 * rebroadcasted
1732 */
1733 struct hlist_head forw_bcast_list;
1734
1735 /** @tp_list: list of tp sessions */
1736 struct hlist_head tp_list;
1737
1738 /** @orig_hash: hash table containing mesh participants (orig nodes) */
1739 struct batadv_hashtable *orig_hash;
1740
1741 /** @forw_bat_list_lock: lock protecting forw_bat_list */
1742 spinlock_t forw_bat_list_lock;
1743
1744 /** @forw_bcast_list_lock: lock protecting forw_bcast_list */
1745 spinlock_t forw_bcast_list_lock;
1746
1747 /** @tp_list_lock: spinlock protecting @tp_list */
1748 spinlock_t tp_list_lock;
1749
1750 /** @tp_num: number of currently active tp sessions */
1751 atomic_t tp_num;
1752
1753 /** @orig_work: work queue callback item for orig node purging */
1754 struct delayed_work orig_work;
1755
1756 /**
1757 * @primary_if: one of the hard-interfaces assigned to this mesh
1758 * interface becomes the primary interface
1759 */
1760 struct batadv_hard_iface __rcu *primary_if; /* rcu protected pointer */
1761
1762 /** @algo_ops: routing algorithm used by this mesh interface */
1763 struct batadv_algo_ops *algo_ops;
1764
1765 /**
1766 * @softif_vlan_list: a list of softif_vlan structs, one per VLAN
1767 * created on top of the mesh interface represented by this object
1768 */
1769 struct hlist_head softif_vlan_list;
1770
1771 /** @softif_vlan_list_lock: lock protecting softif_vlan_list */
1772 spinlock_t softif_vlan_list_lock;
1773
1774 #ifdef CONFIG_BATMAN_ADV_BLA
1775 /** @bla: bridge loop avoidance data */
1776 struct batadv_priv_bla bla;
1777 #endif
1778
1779 #ifdef CONFIG_BATMAN_ADV_DEBUG
1780 /** @debug_log: holding debug logging relevant data */
1781 struct batadv_priv_debug_log *debug_log;
1782 #endif
1783
1784 /** @gw: gateway data */
1785 struct batadv_priv_gw gw;
1786
1787 /** @tt: translation table data */
1788 struct batadv_priv_tt tt;
1789
1790 /** @tvlv: type-version-length-value data */
1791 struct batadv_priv_tvlv tvlv;
1792
1793 #ifdef CONFIG_BATMAN_ADV_DAT
1794 /** @dat: distributed arp table data */
1795 struct batadv_priv_dat dat;
1796 #endif
1797
1798 #ifdef CONFIG_BATMAN_ADV_MCAST
1799 /** @mcast: multicast data */
1800 struct batadv_priv_mcast mcast;
1801 #endif
1802
1803 #ifdef CONFIG_BATMAN_ADV_NC
1804 /**
1805 * @network_coding: bool indicating whether network coding is enabled
1806 */
1807 atomic_t network_coding;
1808
1809 /** @nc: network coding data */
1810 struct batadv_priv_nc nc;
1811 #endif /* CONFIG_BATMAN_ADV_NC */
1812
1813 #ifdef CONFIG_BATMAN_ADV_BATMAN_V
1814 /** @bat_v: B.A.T.M.A.N. V per soft-interface private data */
1815 struct batadv_priv_bat_v bat_v;
1816 #endif
1817 };
1818
1819 #ifdef CONFIG_BATMAN_ADV_BLA
1820
1821 /**
1822 * struct batadv_bla_backbone_gw - batman-adv gateway bridged into the LAN
1823 */
1824 struct batadv_bla_backbone_gw {
1825 /**
1826 * @orig: originator address of backbone node (mac address of primary
1827 * iface)
1828 */
1829 u8 orig[ETH_ALEN];
1830
1831 /** @vid: vlan id this gateway was detected on */
1832 unsigned short vid;
1833
1834 /** @hash_entry: hlist node for &batadv_priv_bla.backbone_hash */
1835 struct hlist_node hash_entry;
1836
1837 /** @bat_priv: pointer to soft_iface this backbone gateway belongs to */
1838 struct batadv_priv *bat_priv;
1839
1840 /** @lasttime: last time we heard of this backbone gw */
1841 unsigned long lasttime;
1842
1843 /**
1844 * @wait_periods: grace time for bridge forward delays and bla group
1845 * forming at bootup phase - no bcast traffic is formwared until it has
1846 * elapsed
1847 */
1848 atomic_t wait_periods;
1849
1850 /**
1851 * @request_sent: if this bool is set to true we are out of sync with
1852 * this backbone gateway - no bcast traffic is formwared until the
1853 * situation was resolved
1854 */
1855 atomic_t request_sent;
1856
1857 /** @crc: crc16 checksum over all claims */
1858 u16 crc;
1859
1860 /** @crc_lock: lock protecting crc */
1861 spinlock_t crc_lock;
1862
1863 /** @report_work: work struct for reporting detected loops */
1864 struct work_struct report_work;
1865
1866 /** @refcount: number of contexts the object is used */
1867 struct kref refcount;
1868
1869 /** @rcu: struct used for freeing in an RCU-safe manner */
1870 struct rcu_head rcu;
1871 };
1872
1873 /**
1874 * struct batadv_bla_claim - claimed non-mesh client structure
1875 */
1876 struct batadv_bla_claim {
1877 /** @addr: mac address of claimed non-mesh client */
1878 u8 addr[ETH_ALEN];
1879
1880 /** @vid: vlan id this client was detected on */
1881 unsigned short vid;
1882
1883 /** @backbone_gw: pointer to backbone gw claiming this client */
1884 struct batadv_bla_backbone_gw *backbone_gw;
1885
1886 /** @backbone_lock: lock protecting backbone_gw pointer */
1887 spinlock_t backbone_lock;
1888
1889 /** @lasttime: last time we heard of claim (locals only) */
1890 unsigned long lasttime;
1891
1892 /** @hash_entry: hlist node for &batadv_priv_bla.claim_hash */
1893 struct hlist_node hash_entry;
1894
1895 /** @refcount: number of contexts the object is used */
1896 struct rcu_head rcu;
1897
1898 /** @rcu: struct used for freeing in an RCU-safe manner */
1899 struct kref refcount;
1900 };
1901 #endif
1902
1903 /**
1904 * struct batadv_tt_common_entry - tt local & tt global common data
1905 */
1906 struct batadv_tt_common_entry {
1907 /** @addr: mac address of non-mesh client */
1908 u8 addr[ETH_ALEN];
1909
1910 /** @vid: VLAN identifier */
1911 unsigned short vid;
1912
1913 /**
1914 * @hash_entry: hlist node for &batadv_priv_tt.local_hash or for
1915 * &batadv_priv_tt.global_hash
1916 */
1917 struct hlist_node hash_entry;
1918
1919 /** @flags: various state handling flags (see batadv_tt_client_flags) */
1920 u16 flags;
1921
1922 /** @added_at: timestamp used for purging stale tt common entries */
1923 unsigned long added_at;
1924
1925 /** @refcount: number of contexts the object is used */
1926 struct kref refcount;
1927
1928 /** @rcu: struct used for freeing in an RCU-safe manner */
1929 struct rcu_head rcu;
1930 };
1931
1932 /**
1933 * struct batadv_tt_local_entry - translation table local entry data
1934 */
1935 struct batadv_tt_local_entry {
1936 /** @common: general translation table data */
1937 struct batadv_tt_common_entry common;
1938
1939 /** @last_seen: timestamp used for purging stale tt local entries */
1940 unsigned long last_seen;
1941
1942 /** @vlan: soft-interface vlan of the entry */
1943 struct batadv_softif_vlan *vlan;
1944 };
1945
1946 /**
1947 * struct batadv_tt_global_entry - translation table global entry data
1948 */
1949 struct batadv_tt_global_entry {
1950 /** @common: general translation table data */
1951 struct batadv_tt_common_entry common;
1952
1953 /** @orig_list: list of orig nodes announcing this non-mesh client */
1954 struct hlist_head orig_list;
1955
1956 /** @orig_list_count: number of items in the orig_list */
1957 atomic_t orig_list_count;
1958
1959 /** @list_lock: lock protecting orig_list */
1960 spinlock_t list_lock;
1961
1962 /** @roam_at: time at which TT_GLOBAL_ROAM was set */
1963 unsigned long roam_at;
1964 };
1965
1966 /**
1967 * struct batadv_tt_orig_list_entry - orig node announcing a non-mesh client
1968 */
1969 struct batadv_tt_orig_list_entry {
1970 /** @orig_node: pointer to orig node announcing this non-mesh client */
1971 struct batadv_orig_node *orig_node;
1972
1973 /**
1974 * @ttvn: translation table version number which added the non-mesh
1975 * client
1976 */
1977 u8 ttvn;
1978
1979 /** @flags: per orig entry TT sync flags */
1980 u8 flags;
1981
1982 /** @list: list node for &batadv_tt_global_entry.orig_list */
1983 struct hlist_node list;
1984
1985 /** @refcount: number of contexts the object is used */
1986 struct kref refcount;
1987
1988 /** @rcu: struct used for freeing in an RCU-safe manner */
1989 struct rcu_head rcu;
1990 };
1991
1992 /**
1993 * struct batadv_tt_change_node - structure for tt changes occurred
1994 */
1995 struct batadv_tt_change_node {
1996 /** @list: list node for &batadv_priv_tt.changes_list */
1997 struct list_head list;
1998
1999 /** @change: holds the actual translation table diff data */
2000 struct batadv_tvlv_tt_change change;
2001 };
2002
2003 /**
2004 * struct batadv_tt_req_node - data to keep track of the tt requests in flight
2005 */
2006 struct batadv_tt_req_node {
2007 /**
2008 * @addr: mac address of the originator this request was sent to
2009 */
2010 u8 addr[ETH_ALEN];
2011
2012 /** @issued_at: timestamp used for purging stale tt requests */
2013 unsigned long issued_at;
2014
2015 /** @refcount: number of contexts the object is used by */
2016 struct kref refcount;
2017
2018 /** @list: list node for &batadv_priv_tt.req_list */
2019 struct hlist_node list;
2020 };
2021
2022 /**
2023 * struct batadv_tt_roam_node - roaming client data
2024 */
2025 struct batadv_tt_roam_node {
2026 /** @addr: mac address of the client in the roaming phase */
2027 u8 addr[ETH_ALEN];
2028
2029 /**
2030 * @counter: number of allowed roaming events per client within a single
2031 * OGM interval (changes are committed with each OGM)
2032 */
2033 atomic_t counter;
2034
2035 /**
2036 * @first_time: timestamp used for purging stale roaming node entries
2037 */
2038 unsigned long first_time;
2039
2040 /** @list: list node for &batadv_priv_tt.roam_list */
2041 struct list_head list;
2042 };
2043
2044 /**
2045 * struct batadv_nc_node - network coding node
2046 */
2047 struct batadv_nc_node {
2048 /** @list: next and prev pointer for the list handling */
2049 struct list_head list;
2050
2051 /** @addr: the node's mac address */
2052 u8 addr[ETH_ALEN];
2053
2054 /** @refcount: number of contexts the object is used by */
2055 struct kref refcount;
2056
2057 /** @rcu: struct used for freeing in an RCU-safe manner */
2058 struct rcu_head rcu;
2059
2060 /** @orig_node: pointer to corresponding orig node struct */
2061 struct batadv_orig_node *orig_node;
2062
2063 /** @last_seen: timestamp of last ogm received from this node */
2064 unsigned long last_seen;
2065 };
2066
2067 /**
2068 * struct batadv_nc_path - network coding path
2069 */
2070 struct batadv_nc_path {
2071 /** @hash_entry: next and prev pointer for the list handling */
2072 struct hlist_node hash_entry;
2073
2074 /** @rcu: struct used for freeing in an RCU-safe manner */
2075 struct rcu_head rcu;
2076
2077 /** @refcount: number of contexts the object is used by */
2078 struct kref refcount;
2079
2080 /** @packet_list: list of buffered packets for this path */
2081 struct list_head packet_list;
2082
2083 /** @packet_list_lock: access lock for packet list */
2084 spinlock_t packet_list_lock;
2085
2086 /** @next_hop: next hop (destination) of path */
2087 u8 next_hop[ETH_ALEN];
2088
2089 /** @prev_hop: previous hop (source) of path */
2090 u8 prev_hop[ETH_ALEN];
2091
2092 /** @last_valid: timestamp for last validation of path */
2093 unsigned long last_valid;
2094 };
2095
2096 /**
2097 * struct batadv_nc_packet - network coding packet used when coding and
2098 * decoding packets
2099 */
2100 struct batadv_nc_packet {
2101 /** @list: next and prev pointer for the list handling */
2102 struct list_head list;
2103
2104 /** @packet_id: crc32 checksum of skb data */
2105 __be32 packet_id;
2106
2107 /**
2108 * @timestamp: field containing the info when the packet was added to
2109 * path
2110 */
2111 unsigned long timestamp;
2112
2113 /** @neigh_node: pointer to original next hop neighbor of skb */
2114 struct batadv_neigh_node *neigh_node;
2115
2116 /** @skb: skb which can be encoded or used for decoding */
2117 struct sk_buff *skb;
2118
2119 /** @nc_path: pointer to path this nc packet is attached to */
2120 struct batadv_nc_path *nc_path;
2121 };
2122
2123 /**
2124 * struct batadv_skb_cb - control buffer structure used to store private data
2125 * relevant to batman-adv in the skb->cb buffer in skbs.
2126 */
2127 struct batadv_skb_cb {
2128 /**
2129 * @decoded: Marks a skb as decoded, which is checked when searching for
2130 * coding opportunities in network-coding.c
2131 */
2132 unsigned char decoded:1;
2133
2134 /** @num_bcasts: Counter for broadcast packet retransmissions */
2135 unsigned char num_bcasts;
2136 };
2137
2138 /**
2139 * struct batadv_forw_packet - structure for bcast packets to be sent/forwarded
2140 */
2141 struct batadv_forw_packet {
2142 /**
2143 * @list: list node for &batadv_priv.forw.bcast_list and
2144 * &batadv_priv.forw.bat_list
2145 */
2146 struct hlist_node list;
2147
2148 /** @cleanup_list: list node for purging functions */
2149 struct hlist_node cleanup_list;
2150
2151 /** @send_time: execution time for delayed_work (packet sending) */
2152 unsigned long send_time;
2153
2154 /**
2155 * @own: bool for locally generated packets (local OGMs are re-scheduled
2156 * after sending)
2157 */
2158 u8 own;
2159
2160 /** @skb: bcast packet's skb buffer */
2161 struct sk_buff *skb;
2162
2163 /** @packet_len: size of aggregated OGM packet inside the skb buffer */
2164 u16 packet_len;
2165
2166 /** @direct_link_flags: direct link flags for aggregated OGM packets */
2167 u32 direct_link_flags;
2168
2169 /** @num_packets: counter for aggregated OGMv1 packets */
2170 u8 num_packets;
2171
2172 /** @delayed_work: work queue callback item for packet sending */
2173 struct delayed_work delayed_work;
2174
2175 /**
2176 * @if_incoming: pointer to incoming hard-iface or primary iface if
2177 * locally generated packet
2178 */
2179 struct batadv_hard_iface *if_incoming;
2180
2181 /**
2182 * @if_outgoing: packet where the packet should be sent to, or NULL if
2183 * unspecified
2184 */
2185 struct batadv_hard_iface *if_outgoing;
2186
2187 /** @queue_left: The queue (counter) this packet was applied to */
2188 atomic_t *queue_left;
2189 };
2190
2191 /**
2192 * struct batadv_algo_iface_ops - mesh algorithm callbacks (interface specific)
2193 */
2194 struct batadv_algo_iface_ops {
2195 /**
2196 * @activate: start routing mechanisms when hard-interface is brought up
2197 * (optional)
2198 */
2199 void (*activate)(struct batadv_hard_iface *hard_iface);
2200
2201 /** @enable: init routing info when hard-interface is enabled */
2202 int (*enable)(struct batadv_hard_iface *hard_iface);
2203
2204 /** @enabled: notification when hard-interface was enabled (optional) */
2205 void (*enabled)(struct batadv_hard_iface *hard_iface);
2206
2207 /** @disable: de-init routing info when hard-interface is disabled */
2208 void (*disable)(struct batadv_hard_iface *hard_iface);
2209
2210 /**
2211 * @update_mac: (re-)init mac addresses of the protocol information
2212 * belonging to this hard-interface
2213 */
2214 void (*update_mac)(struct batadv_hard_iface *hard_iface);
2215
2216 /** @primary_set: called when primary interface is selected / changed */
2217 void (*primary_set)(struct batadv_hard_iface *hard_iface);
2218 };
2219
2220 /**
2221 * struct batadv_algo_neigh_ops - mesh algorithm callbacks (neighbour specific)
2222 */
2223 struct batadv_algo_neigh_ops {
2224 /** @hardif_init: called on creation of single hop entry (optional) */
2225 void (*hardif_init)(struct batadv_hardif_neigh_node *neigh);
2226
2227 /**
2228 * @cmp: compare the metrics of two neighbors for their respective
2229 * outgoing interfaces
2230 */
2231 int (*cmp)(struct batadv_neigh_node *neigh1,
2232 struct batadv_hard_iface *if_outgoing1,
2233 struct batadv_neigh_node *neigh2,
2234 struct batadv_hard_iface *if_outgoing2);
2235
2236 /**
2237 * @is_similar_or_better: check if neigh1 is equally similar or better
2238 * than neigh2 for their respective outgoing interface from the metric
2239 * prospective
2240 */
2241 bool (*is_similar_or_better)(struct batadv_neigh_node *neigh1,
2242 struct batadv_hard_iface *if_outgoing1,
2243 struct batadv_neigh_node *neigh2,
2244 struct batadv_hard_iface *if_outgoing2);
2245
2246 /** @dump: dump neighbors to a netlink socket (optional) */
2247 void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
2248 struct batadv_priv *priv,
2249 struct batadv_hard_iface *hard_iface);
2250 };
2251
2252 /**
2253 * struct batadv_algo_orig_ops - mesh algorithm callbacks (originator specific)
2254 */
2255 struct batadv_algo_orig_ops {
2256 /** @dump: dump originators to a netlink socket (optional) */
2257 void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
2258 struct batadv_priv *priv,
2259 struct batadv_hard_iface *hard_iface);
2260 };
2261
2262 /**
2263 * struct batadv_algo_gw_ops - mesh algorithm callbacks (GW specific)
2264 */
2265 struct batadv_algo_gw_ops {
2266 /** @init_sel_class: initialize GW selection class (optional) */
2267 void (*init_sel_class)(struct batadv_priv *bat_priv);
2268
2269 /**
2270 * @sel_class_max: maximum allowed GW selection class
2271 */
2272 u32 sel_class_max;
2273
2274 /**
2275 * @get_best_gw_node: select the best GW from the list of available
2276 * nodes (optional)
2277 */
2278 struct batadv_gw_node *(*get_best_gw_node)
2279 (struct batadv_priv *bat_priv);
2280
2281 /**
2282 * @is_eligible: check if a newly discovered GW is a potential candidate
2283 * for the election as best GW (optional)
2284 */
2285 bool (*is_eligible)(struct batadv_priv *bat_priv,
2286 struct batadv_orig_node *curr_gw_orig,
2287 struct batadv_orig_node *orig_node);
2288
2289 /** @dump: dump gateways to a netlink socket (optional) */
2290 void (*dump)(struct sk_buff *msg, struct netlink_callback *cb,
2291 struct batadv_priv *priv);
2292 };
2293
2294 /**
2295 * struct batadv_algo_ops - mesh algorithm callbacks
2296 */
2297 struct batadv_algo_ops {
2298 /** @list: list node for the batadv_algo_list */
2299 struct hlist_node list;
2300
2301 /** @name: name of the algorithm */
2302 char *name;
2303
2304 /** @iface: callbacks related to interface handling */
2305 struct batadv_algo_iface_ops iface;
2306
2307 /** @neigh: callbacks related to neighbors handling */
2308 struct batadv_algo_neigh_ops neigh;
2309
2310 /** @orig: callbacks related to originators handling */
2311 struct batadv_algo_orig_ops orig;
2312
2313 /** @gw: callbacks related to GW mode */
2314 struct batadv_algo_gw_ops gw;
2315 };
2316
2317 /**
2318 * struct batadv_dat_entry - it is a single entry of batman-adv ARP backend. It
2319 * is used to stored ARP entries needed for the global DAT cache
2320 */
2321 struct batadv_dat_entry {
2322 /** @ip: the IPv4 corresponding to this DAT/ARP entry */
2323 __be32 ip;
2324
2325 /** @mac_addr: the MAC address associated to the stored IPv4 */
2326 u8 mac_addr[ETH_ALEN];
2327
2328 /** @vid: the vlan ID associated to this entry */
2329 unsigned short vid;
2330
2331 /**
2332 * @last_update: time in jiffies when this entry was refreshed last time
2333 */
2334 unsigned long last_update;
2335
2336 /** @hash_entry: hlist node for &batadv_priv_dat.hash */
2337 struct hlist_node hash_entry;
2338
2339 /** @refcount: number of contexts the object is used */
2340 struct kref refcount;
2341
2342 /** @rcu: struct used for freeing in an RCU-safe manner */
2343 struct rcu_head rcu;
2344 };
2345
2346 /**
2347 * struct batadv_hw_addr - a list entry for a MAC address
2348 */
2349 struct batadv_hw_addr {
2350 /** @list: list node for the linking of entries */
2351 struct hlist_node list;
2352
2353 /** @addr: the MAC address of this list entry */
2354 unsigned char addr[ETH_ALEN];
2355 };
2356
2357 /**
2358 * struct batadv_dat_candidate - candidate destination for DAT operations
2359 */
2360 struct batadv_dat_candidate {
2361 /**
2362 * @type: the type of the selected candidate. It can one of the
2363 * following:
2364 * - BATADV_DAT_CANDIDATE_NOT_FOUND
2365 * - BATADV_DAT_CANDIDATE_ORIG
2366 */
2367 int type;
2368
2369 /**
2370 * @orig_node: if type is BATADV_DAT_CANDIDATE_ORIG this field points to
2371 * the corresponding originator node structure
2372 */
2373 struct batadv_orig_node *orig_node;
2374 };
2375
2376 /**
2377 * struct batadv_tvlv_container - container for tvlv appended to OGMs
2378 */
2379 struct batadv_tvlv_container {
2380 /** @list: hlist node for &batadv_priv_tvlv.container_list */
2381 struct hlist_node list;
2382
2383 /** @tvlv_hdr: tvlv header information needed to construct the tvlv */
2384 struct batadv_tvlv_hdr tvlv_hdr;
2385
2386 /** @refcount: number of contexts the object is used */
2387 struct kref refcount;
2388 };
2389
2390 /**
2391 * struct batadv_tvlv_handler - handler for specific tvlv type and version
2392 */
2393 struct batadv_tvlv_handler {
2394 /** @list: hlist node for &batadv_priv_tvlv.handler_list */
2395 struct hlist_node list;
2396
2397 /**
2398 * @ogm_handler: handler callback which is given the tvlv payload to
2399 * process on incoming OGM packets
2400 */
2401 void (*ogm_handler)(struct batadv_priv *bat_priv,
2402 struct batadv_orig_node *orig,
2403 u8 flags, void *tvlv_value, u16 tvlv_value_len);
2404
2405 /**
2406 * @unicast_handler: handler callback which is given the tvlv payload to
2407 * process on incoming unicast tvlv packets
2408 */
2409 int (*unicast_handler)(struct batadv_priv *bat_priv,
2410 u8 *src, u8 *dst,
2411 void *tvlv_value, u16 tvlv_value_len);
2412
2413 /**
2414 * @mcast_handler: handler callback which is given the tvlv payload to
2415 * process on incoming mcast packet
2416 */
2417 int (*mcast_handler)(struct batadv_priv *bat_priv, struct sk_buff *skb);
2418
2419 /** @type: tvlv type this handler feels responsible for */
2420 u8 type;
2421
2422 /** @version: tvlv version this handler feels responsible for */
2423 u8 version;
2424
2425 /** @flags: tvlv handler flags */
2426 u8 flags;
2427
2428 /** @refcount: number of contexts the object is used */
2429 struct kref refcount;
2430
2431 /** @rcu: struct used for freeing in an RCU-safe manner */
2432 struct rcu_head rcu;
2433 };
2434
2435 /**
2436 * enum batadv_tvlv_handler_flags - tvlv handler flags definitions
2437 */
2438 enum batadv_tvlv_handler_flags {
2439 /**
2440 * @BATADV_TVLV_HANDLER_OGM_CIFNOTFND: tvlv ogm processing function
2441 * will call this handler even if its type was not found (with no data)
2442 */
2443 BATADV_TVLV_HANDLER_OGM_CIFNOTFND = BIT(1),
2444
2445 /**
2446 * @BATADV_TVLV_HANDLER_OGM_CALLED: interval tvlv handling flag - the
2447 * API marks a handler as being called, so it won't be called if the
2448 * BATADV_TVLV_HANDLER_OGM_CIFNOTFND flag was set
2449 */
2450 BATADV_TVLV_HANDLER_OGM_CALLED = BIT(2),
2451 };
2452
2453 #endif /* _NET_BATMAN_ADV_TYPES_H_ */
2454
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.