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