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