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