]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - net/batman-adv/types.h
Merge branch 'pm-acpi' of git://git.kernel.org/pub/scm/linux/kernel/git/rafael/linux-pm
[mirror_ubuntu-artful-kernel.git] / net / batman-adv / types.h
CommitLineData
c6c8fea2 1/*
567db7b0 2 * Copyright (C) 2007-2012 B.A.T.M.A.N. contributors:
c6c8fea2
SE
3 *
4 * Marek Lindner, Simon Wunderlich
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of version 2 of the GNU General Public
8 * License as published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
18 * 02110-1301, USA
19 *
20 */
21
22
23
24#ifndef _NET_BATMAN_ADV_TYPES_H_
25#define _NET_BATMAN_ADV_TYPES_H_
26
27#include "packet.h"
28#include "bitarray.h"
29
0d125074 30#define BAT_HEADER_LEN (ETH_HLEN + \
c6c8fea2
SE
31 ((sizeof(struct unicast_packet) > sizeof(struct bcast_packet) ? \
32 sizeof(struct unicast_packet) : \
33 sizeof(struct bcast_packet))))
34
35
e6c10f43 36struct hard_iface {
c6c8fea2
SE
37 struct list_head list;
38 int16_t if_num;
39 char if_status;
40 struct net_device *net_dev;
41 atomic_t seqno;
42 atomic_t frag_seqno;
43 unsigned char *packet_buff;
44 int packet_len;
45 struct kobject *hardif_obj;
ed75ccbe 46 atomic_t refcount;
c6c8fea2
SE
47 struct packet_type batman_adv_ptype;
48 struct net_device *soft_iface;
49 struct rcu_head rcu;
50};
51
52/**
53 * orig_node - structure for orig_list maintaining nodes of mesh
54 * @primary_addr: hosts primary interface address
d7b2a97e 55 * @last_seen: when last packet from this node was received
c6c8fea2
SE
56 * @bcast_seqno_reset: time when the broadcast seqno window was reset
57 * @batman_seqno_reset: time when the batman seqno window was reset
58 * @gw_flags: flags related to gateway class
59 * @flags: for now only VIS_SERVER flag
015758d0 60 * @last_real_seqno: last and best known sequence number
c6c8fea2
SE
61 * @last_ttl: ttl of last received packet
62 * @last_bcast_seqno: last broadcast sequence number received by this host
63 *
64 * @candidates: how many candidates are available
65 * @selected: next bonding candidate
66 */
67struct orig_node {
68 uint8_t orig[ETH_ALEN];
69 uint8_t primary_addr[ETH_ALEN];
e1a5382f 70 struct neigh_node __rcu *router; /* rcu protected pointer */
c6c8fea2
SE
71 unsigned long *bcast_own;
72 uint8_t *bcast_own_sum;
d7b2a97e 73 unsigned long last_seen;
c6c8fea2
SE
74 unsigned long bcast_seqno_reset;
75 unsigned long batman_seqno_reset;
76 uint8_t gw_flags;
77 uint8_t flags;
a73105b8
AQ
78 atomic_t last_ttvn; /* last seen translation table version number */
79 uint16_t tt_crc;
2dafb49d
AQ
80 unsigned char *tt_buff;
81 int16_t tt_buff_len;
a73105b8
AQ
82 spinlock_t tt_buff_lock; /* protects tt_buff */
83 atomic_t tt_size;
17071578 84 bool tt_initialised;
cc47f66e
AQ
85 /* The tt_poss_change flag is used to detect an ongoing roaming phase.
86 * If true, then I sent a Roaming_adv to this orig_node and I have to
87 * inspect every packet directed to it to check whether it is still
88 * the true destination or not. This flag will be reset to false as
89 * soon as I receive a new TTVN from this orig_node */
90 bool tt_poss_change;
c6c8fea2
SE
91 uint32_t last_real_seqno;
92 uint8_t last_ttl;
0079d2ce 93 DECLARE_BITMAP(bcast_bits, TQ_LOCAL_WINDOW_SIZE);
c6c8fea2 94 uint32_t last_bcast_seqno;
9591a79f 95 struct hlist_head neigh_list;
c6c8fea2 96 struct list_head frag_list;
e1a5382f 97 spinlock_t neigh_list_lock; /* protects neigh_list and router */
7b36e8ee
ML
98 atomic_t refcount;
99 struct rcu_head rcu;
7aadf889 100 struct hlist_node hash_entry;
16b1aba8 101 struct bat_priv *bat_priv;
c6c8fea2 102 unsigned long last_frag_packet;
6e215fd8
SE
103 /* ogm_cnt_lock protects: bcast_own, bcast_own_sum,
104 * neigh_node->real_bits, neigh_node->real_packet_count */
105 spinlock_t ogm_cnt_lock;
106 /* bcast_seqno_lock protects bcast_bits, last_bcast_seqno */
107 spinlock_t bcast_seqno_lock;
a73105b8 108 spinlock_t tt_list_lock; /* protects tt_list */
a4c135c5
SW
109 atomic_t bond_candidates;
110 struct list_head bond_list;
c6c8fea2
SE
111};
112
113struct gw_node {
114 struct hlist_node list;
115 struct orig_node *orig_node;
116 unsigned long deleted;
25b6d3c1 117 atomic_t refcount;
c6c8fea2
SE
118 struct rcu_head rcu;
119};
120
121/**
122 * neigh_node
d7b2a97e 123 * @last_seen: when last packet via this neighbor was received
c6c8fea2
SE
124 */
125struct neigh_node {
9591a79f 126 struct hlist_node list;
c6c8fea2
SE
127 uint8_t addr[ETH_ALEN];
128 uint8_t real_packet_count;
129 uint8_t tq_recv[TQ_GLOBAL_WINDOW_SIZE];
130 uint8_t tq_index;
131 uint8_t tq_avg;
132 uint8_t last_ttl;
a4c135c5 133 struct list_head bonding_list;
d7b2a97e 134 unsigned long last_seen;
0079d2ce 135 DECLARE_BITMAP(real_bits, TQ_LOCAL_WINDOW_SIZE);
44524fcd 136 atomic_t refcount;
f987ed6e 137 struct rcu_head rcu;
c6c8fea2 138 struct orig_node *orig_node;
e6c10f43 139 struct hard_iface *if_incoming;
e3b0d0de 140 spinlock_t lq_update_lock; /* protects: tq_recv, tq_index */
c6c8fea2
SE
141};
142
7a5cc242 143#ifdef CONFIG_BATMAN_ADV_BLA
fe2da6ff
SW
144struct bcast_duplist_entry {
145 uint8_t orig[ETH_ALEN];
146 uint16_t crc;
147 unsigned long entrytime;
148};
7a5cc242 149#endif
c6c8fea2
SE
150
151struct bat_priv {
152 atomic_t mesh_state;
153 struct net_device_stats stats;
154 atomic_t aggregated_ogms; /* boolean */
155 atomic_t bonding; /* boolean */
156 atomic_t fragmentation; /* boolean */
59b699cd 157 atomic_t ap_isolation; /* boolean */
23721387 158 atomic_t bridge_loop_avoidance; /* boolean */
c6c8fea2
SE
159 atomic_t vis_mode; /* VIS_TYPE_* */
160 atomic_t gw_mode; /* GW_MODE_* */
161 atomic_t gw_sel_class; /* uint */
162 atomic_t gw_bandwidth; /* gw bandwidth */
163 atomic_t orig_interval; /* uint */
164 atomic_t hop_penalty; /* uint */
165 atomic_t log_level; /* uint */
166 atomic_t bcast_seqno;
167 atomic_t bcast_queue_left;
168 atomic_t batman_queue_left;
015758d0 169 atomic_t ttvn; /* translation table version number */
a73105b8
AQ
170 atomic_t tt_ogm_append_cnt;
171 atomic_t tt_local_changes; /* changes registered in a OGM interval */
23721387 172 atomic_t bla_num_requests; /* number of bla requests in flight */
cc47f66e
AQ
173 /* The tt_poss_change flag is used to detect an ongoing roaming phase.
174 * If true, then I received a Roaming_adv and I have to inspect every
175 * packet directed to me to check whether I am still the true
176 * destination or not. This flag will be reset to false as soon as I
177 * increase my TTVN */
178 bool tt_poss_change;
c6c8fea2 179 char num_ifaces;
c6c8fea2 180 struct debug_log *debug_log;
c6c8fea2
SE
181 struct kobject *mesh_obj;
182 struct dentry *debug_dir;
183 struct hlist_head forw_bat_list;
184 struct hlist_head forw_bcast_list;
185 struct hlist_head gw_list;
a73105b8 186 struct list_head tt_changes_list; /* tracks changes in a OGM int */
c6c8fea2
SE
187 struct list_head vis_send_list;
188 struct hashtable_t *orig_hash;
2dafb49d
AQ
189 struct hashtable_t *tt_local_hash;
190 struct hashtable_t *tt_global_hash;
7a5cc242 191#ifdef CONFIG_BATMAN_ADV_BLA
23721387
SW
192 struct hashtable_t *claim_hash;
193 struct hashtable_t *backbone_hash;
7a5cc242 194#endif
a73105b8 195 struct list_head tt_req_list; /* list of pending tt_requests */
cc47f66e 196 struct list_head tt_roam_list;
c6c8fea2 197 struct hashtable_t *vis_hash;
7a5cc242 198#ifdef CONFIG_BATMAN_ADV_BLA
fe2da6ff
SW
199 struct bcast_duplist_entry bcast_duplist[DUPLIST_SIZE];
200 int bcast_duplist_curr;
38ef3d1d 201 struct bla_claim_dst claim_dest;
7a5cc242 202#endif
c6c8fea2
SE
203 spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
204 spinlock_t forw_bcast_list_lock; /* protects */
a73105b8 205 spinlock_t tt_changes_list_lock; /* protects tt_changes */
a73105b8 206 spinlock_t tt_req_list_lock; /* protects tt_req_list */
cc47f66e 207 spinlock_t tt_roam_list_lock; /* protects tt_roam_list */
5d02b3cd 208 spinlock_t gw_list_lock; /* protects gw_list and curr_gw */
c6c8fea2
SE
209 spinlock_t vis_hash_lock; /* protects vis_hash */
210 spinlock_t vis_list_lock; /* protects vis_info::recv_list */
a73105b8
AQ
211 atomic_t num_local_tt;
212 /* Checksum of the local table, recomputed before sending a new OGM */
213 atomic_t tt_crc;
214 unsigned char *tt_buff;
215 int16_t tt_buff_len;
216 spinlock_t tt_buff_lock; /* protects tt_buff */
2dafb49d 217 struct delayed_work tt_work;
c6c8fea2
SE
218 struct delayed_work orig_work;
219 struct delayed_work vis_work;
23721387 220 struct delayed_work bla_work;
5d02b3cd 221 struct gw_node __rcu *curr_gw; /* rcu protected pointer */
2265c141 222 atomic_t gw_reselect;
32ae9b22 223 struct hard_iface __rcu *primary_if; /* rcu protected pointer */
c6c8fea2 224 struct vis_info *my_vis_info;
1c280471 225 struct bat_algo_ops *bat_algo_ops;
c6c8fea2
SE
226};
227
228struct socket_client {
229 struct list_head queue_list;
230 unsigned int queue_len;
231 unsigned char index;
232 spinlock_t lock; /* protects queue_list, queue_len, index */
233 wait_queue_head_t queue_wait;
234 struct bat_priv *bat_priv;
235};
236
237struct socket_packet {
238 struct list_head list;
239 size_t icmp_len;
240 struct icmp_packet_rr icmp_packet;
241};
242
48100bac 243struct tt_common_entry {
c6c8fea2 244 uint8_t addr[ETH_ALEN];
93840ac4 245 struct hlist_node hash_entry;
5fbc1598 246 uint16_t flags;
7683fdc1
AQ
247 atomic_t refcount;
248 struct rcu_head rcu;
c6c8fea2
SE
249};
250
48100bac
AQ
251struct tt_local_entry {
252 struct tt_common_entry common;
253 unsigned long last_seen;
254};
255
2dafb49d 256struct tt_global_entry {
48100bac 257 struct tt_common_entry common;
db08e6e5
SW
258 struct hlist_head orig_list;
259 spinlock_t list_lock; /* protects the list */
260 unsigned long roam_at; /* time at which TT_GLOBAL_ROAM was set */
261};
262
263struct tt_orig_list_entry {
c6c8fea2 264 struct orig_node *orig_node;
a73105b8 265 uint8_t ttvn;
db08e6e5
SW
266 struct rcu_head rcu;
267 struct hlist_node list;
c6c8fea2
SE
268};
269
7a5cc242 270#ifdef CONFIG_BATMAN_ADV_BLA
23721387
SW
271struct backbone_gw {
272 uint8_t orig[ETH_ALEN];
273 short vid; /* used VLAN ID */
274 struct hlist_node hash_entry;
275 struct bat_priv *bat_priv;
276 unsigned long lasttime; /* last time we heard of this backbone gw */
277 atomic_t request_sent;
278 atomic_t refcount;
279 struct rcu_head rcu;
280 uint16_t crc; /* crc checksum over all claims */
281};
282
283struct claim {
284 uint8_t addr[ETH_ALEN];
285 short vid;
286 struct backbone_gw *backbone_gw;
287 unsigned long lasttime; /* last time we heard of claim (locals only) */
288 struct rcu_head rcu;
289 atomic_t refcount;
290 struct hlist_node hash_entry;
291};
7a5cc242 292#endif
23721387 293
a73105b8
AQ
294struct tt_change_node {
295 struct list_head list;
296 struct tt_change change;
297};
298
299struct tt_req_node {
300 uint8_t addr[ETH_ALEN];
301 unsigned long issued_at;
302 struct list_head list;
303};
304
cc47f66e
AQ
305struct tt_roam_node {
306 uint8_t addr[ETH_ALEN];
307 atomic_t counter;
308 unsigned long first_time;
309 struct list_head list;
310};
311
c6c8fea2
SE
312/**
313 * forw_packet - structure for forw_list maintaining packets to be
314 * send/forwarded
315 */
316struct forw_packet {
317 struct hlist_node list;
318 unsigned long send_time;
319 uint8_t own;
320 struct sk_buff *skb;
321 uint16_t packet_len;
322 uint32_t direct_link_flags;
323 uint8_t num_packets;
324 struct delayed_work delayed_work;
e6c10f43 325 struct hard_iface *if_incoming;
c6c8fea2
SE
326};
327
328/* While scanning for vis-entries of a particular vis-originator
329 * this list collects its interfaces to create a subgraph/cluster
330 * out of them later
331 */
332struct if_list_entry {
333 uint8_t addr[ETH_ALEN];
334 bool primary;
335 struct hlist_node list;
336};
337
338struct debug_log {
339 char log_buff[LOG_BUF_LEN];
340 unsigned long log_start;
341 unsigned long log_end;
342 spinlock_t lock; /* protects log_buff, log_start and log_end */
343 wait_queue_head_t queue_wait;
344};
345
346struct frag_packet_list_entry {
347 struct list_head list;
348 uint16_t seqno;
349 struct sk_buff *skb;
350};
351
352struct vis_info {
40219672
AQ
353 unsigned long first_seen;
354 /* list of server-neighbors we received a vis-packet
355 * from. we should not reply to them. */
356 struct list_head recv_list;
c6c8fea2
SE
357 struct list_head send_list;
358 struct kref refcount;
7aadf889 359 struct hlist_node hash_entry;
c6c8fea2
SE
360 struct bat_priv *bat_priv;
361 /* this packet might be part of the vis send queue. */
362 struct sk_buff *skb_packet;
363 /* vis_info may follow here*/
aa0adb1a 364} __packed;
c6c8fea2
SE
365
366struct vis_info_entry {
367 uint8_t src[ETH_ALEN];
368 uint8_t dest[ETH_ALEN];
2dafb49d 369 uint8_t quality; /* quality = 0 client */
aa0adb1a 370} __packed;
c6c8fea2
SE
371
372struct recvlist_node {
373 struct list_head list;
374 uint8_t mac[ETH_ALEN];
375};
376
1c280471
ML
377struct bat_algo_ops {
378 struct hlist_node list;
379 char *name;
c2aca022 380 /* init routing info when hard-interface is enabled */
77af7575 381 int (*bat_iface_enable)(struct hard_iface *hard_iface);
00a50076
ML
382 /* de-init routing info when hard-interface is disabled */
383 void (*bat_iface_disable)(struct hard_iface *hard_iface);
c3229398
ML
384 /* (re-)init mac addresses of the protocol information
385 * belonging to this hard-interface
386 */
387 void (*bat_iface_update_mac)(struct hard_iface *hard_iface);
cd8b78e7
ML
388 /* called when primary interface is selected / changed */
389 void (*bat_primary_iface_set)(struct hard_iface *hard_iface);
01c4224b
ML
390 /* prepare a new outgoing OGM for the send queue */
391 void (*bat_ogm_schedule)(struct hard_iface *hard_iface,
392 int tt_num_changes);
393 /* send scheduled OGM */
394 void (*bat_ogm_emit)(struct forw_packet *forw_packet);
1c280471
ML
395};
396
c6c8fea2 397#endif /* _NET_BATMAN_ADV_TYPES_H_ */