2 * Copyright (C) 2007-2012 B.A.T.M.A.N. contributors:
4 * Marek Lindner, Simon Wunderlich
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.
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.
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
24 #ifndef _NET_BATMAN_ADV_TYPES_H_
25 #define _NET_BATMAN_ADV_TYPES_H_
30 #define BAT_HEADER_LEN (sizeof(struct ethhdr) + \
31 ((sizeof(struct unicast_packet) > sizeof(struct bcast_packet) ? \
32 sizeof(struct unicast_packet) : \
33 sizeof(struct bcast_packet))))
37 struct list_head list
;
40 struct net_device
*net_dev
;
43 unsigned char *packet_buff
;
45 struct kobject
*hardif_obj
;
47 struct packet_type batman_adv_ptype
;
48 struct net_device
*soft_iface
;
53 * orig_node - structure for orig_list maintaining nodes of mesh
54 * @primary_addr: hosts primary interface address
55 * @last_valid: when last packet from this node was received
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
60 * @last_real_seqno: last and best known sequence number
61 * @last_ttl: ttl of last received packet
62 * @last_bcast_seqno: last broadcast sequence number received by this host
64 * @candidates: how many candidates are available
65 * @selected: next bonding candidate
68 uint8_t orig
[ETH_ALEN
];
69 uint8_t primary_addr
[ETH_ALEN
];
70 struct neigh_node __rcu
*router
; /* rcu protected pointer */
71 unsigned long *bcast_own
;
72 uint8_t *bcast_own_sum
;
73 unsigned long last_valid
;
74 unsigned long bcast_seqno_reset
;
75 unsigned long batman_seqno_reset
;
78 atomic_t last_ttvn
; /* last seen translation table version number */
80 unsigned char *tt_buff
;
82 spinlock_t tt_buff_lock
; /* protects tt_buff */
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 */
91 uint32_t last_real_seqno
;
93 DECLARE_BITMAP(bcast_bits
, TQ_LOCAL_WINDOW_SIZE
);
94 uint32_t last_bcast_seqno
;
95 struct hlist_head neigh_list
;
96 struct list_head frag_list
;
97 spinlock_t neigh_list_lock
; /* protects neigh_list and router */
100 struct hlist_node hash_entry
;
101 struct bat_priv
*bat_priv
;
102 unsigned long last_frag_packet
;
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
;
108 spinlock_t tt_list_lock
; /* protects tt_list */
109 atomic_t bond_candidates
;
110 struct list_head bond_list
;
114 struct hlist_node list
;
115 struct orig_node
*orig_node
;
116 unsigned long deleted
;
123 * @last_valid: when last packet via this neighbor was received
126 struct hlist_node list
;
127 uint8_t addr
[ETH_ALEN
];
128 uint8_t real_packet_count
;
129 uint8_t tq_recv
[TQ_GLOBAL_WINDOW_SIZE
];
133 struct list_head bonding_list
;
134 unsigned long last_valid
;
135 DECLARE_BITMAP(real_bits
, TQ_LOCAL_WINDOW_SIZE
);
138 struct orig_node
*orig_node
;
139 struct hard_iface
*if_incoming
;
140 spinlock_t tq_lock
; /* protects: tq_recv, tq_index */
143 #ifdef CONFIG_BATMAN_ADV_BLA
144 struct bcast_duplist_entry
{
145 uint8_t orig
[ETH_ALEN
];
147 unsigned long entrytime
;
153 struct net_device_stats stats
;
154 atomic_t aggregated_ogms
; /* boolean */
155 atomic_t bonding
; /* boolean */
156 atomic_t fragmentation
; /* boolean */
157 atomic_t ap_isolation
; /* boolean */
158 atomic_t bridge_loop_avoidance
; /* boolean */
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
;
169 atomic_t ttvn
; /* translation table version number */
170 atomic_t tt_ogm_append_cnt
;
171 atomic_t tt_local_changes
; /* changes registered in a OGM interval */
172 atomic_t bla_num_requests
; /* number of bla requests in flight */
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 */
180 struct debug_log
*debug_log
;
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
;
186 struct list_head tt_changes_list
; /* tracks changes in a OGM int */
187 struct list_head vis_send_list
;
188 struct hashtable_t
*orig_hash
;
189 struct hashtable_t
*tt_local_hash
;
190 struct hashtable_t
*tt_global_hash
;
191 #ifdef CONFIG_BATMAN_ADV_BLA
192 struct hashtable_t
*claim_hash
;
193 struct hashtable_t
*backbone_hash
;
195 struct list_head tt_req_list
; /* list of pending tt_requests */
196 struct list_head tt_roam_list
;
197 struct hashtable_t
*vis_hash
;
198 #ifdef CONFIG_BATMAN_ADV_BLA
199 struct bcast_duplist_entry bcast_duplist
[DUPLIST_SIZE
];
200 int bcast_duplist_curr
;
201 struct bla_claim_dst claim_dest
;
203 spinlock_t forw_bat_list_lock
; /* protects forw_bat_list */
204 spinlock_t forw_bcast_list_lock
; /* protects */
205 spinlock_t tt_changes_list_lock
; /* protects tt_changes */
206 spinlock_t tt_req_list_lock
; /* protects tt_req_list */
207 spinlock_t tt_roam_list_lock
; /* protects tt_roam_list */
208 spinlock_t gw_list_lock
; /* protects gw_list and curr_gw */
209 spinlock_t vis_hash_lock
; /* protects vis_hash */
210 spinlock_t vis_list_lock
; /* protects vis_info::recv_list */
211 atomic_t num_local_tt
;
212 /* Checksum of the local table, recomputed before sending a new OGM */
214 unsigned char *tt_buff
;
216 spinlock_t tt_buff_lock
; /* protects tt_buff */
217 struct delayed_work tt_work
;
218 struct delayed_work orig_work
;
219 struct delayed_work vis_work
;
220 struct delayed_work bla_work
;
221 struct gw_node __rcu
*curr_gw
; /* rcu protected pointer */
222 atomic_t gw_reselect
;
223 struct hard_iface __rcu
*primary_if
; /* rcu protected pointer */
224 struct vis_info
*my_vis_info
;
225 struct bat_algo_ops
*bat_algo_ops
;
228 struct socket_client
{
229 struct list_head queue_list
;
230 unsigned int queue_len
;
232 spinlock_t lock
; /* protects queue_list, queue_len, index */
233 wait_queue_head_t queue_wait
;
234 struct bat_priv
*bat_priv
;
237 struct socket_packet
{
238 struct list_head list
;
240 struct icmp_packet_rr icmp_packet
;
243 struct tt_common_entry
{
244 uint8_t addr
[ETH_ALEN
];
245 struct hlist_node hash_entry
;
251 struct tt_local_entry
{
252 struct tt_common_entry common
;
253 unsigned long last_seen
;
256 struct tt_global_entry
{
257 struct tt_common_entry common
;
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 */
263 struct tt_orig_list_entry
{
264 struct orig_node
*orig_node
;
267 struct hlist_node list
;
270 #ifdef CONFIG_BATMAN_ADV_BLA
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
;
280 uint16_t crc
; /* crc checksum over all claims */
284 uint8_t addr
[ETH_ALEN
];
286 struct backbone_gw
*backbone_gw
;
287 unsigned long lasttime
; /* last time we heard of claim (locals only) */
290 struct hlist_node hash_entry
;
294 struct tt_change_node
{
295 struct list_head list
;
296 struct tt_change change
;
300 uint8_t addr
[ETH_ALEN
];
301 unsigned long issued_at
;
302 struct list_head list
;
305 struct tt_roam_node
{
306 uint8_t addr
[ETH_ALEN
];
308 unsigned long first_time
;
309 struct list_head list
;
313 * forw_packet - structure for forw_list maintaining packets to be
317 struct hlist_node list
;
318 unsigned long send_time
;
322 uint32_t direct_link_flags
;
324 struct delayed_work delayed_work
;
325 struct hard_iface
*if_incoming
;
328 /* While scanning for vis-entries of a particular vis-originator
329 * this list collects its interfaces to create a subgraph/cluster
332 struct if_list_entry
{
333 uint8_t addr
[ETH_ALEN
];
335 struct hlist_node list
;
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
;
346 struct frag_packet_list_entry
{
347 struct list_head list
;
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
;
357 struct list_head send_list
;
358 struct kref refcount
;
359 struct hlist_node hash_entry
;
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*/
366 struct vis_info_entry
{
367 uint8_t src
[ETH_ALEN
];
368 uint8_t dest
[ETH_ALEN
];
369 uint8_t quality
; /* quality = 0 client */
372 struct recvlist_node
{
373 struct list_head list
;
374 uint8_t mac
[ETH_ALEN
];
377 struct bat_algo_ops
{
378 struct hlist_node list
;
380 /* init OGM when hard-interface is enabled */
381 void (*bat_ogm_init
)(struct hard_iface
*hard_iface
);
382 /* init primary OGM when primary interface is selected */
383 void (*bat_ogm_init_primary
)(struct hard_iface
*hard_iface
);
384 /* init mac addresses of the OGM belonging to this hard-interface */
385 void (*bat_ogm_update_mac
)(struct hard_iface
*hard_iface
);
386 /* prepare a new outgoing OGM for the send queue */
387 void (*bat_ogm_schedule
)(struct hard_iface
*hard_iface
,
389 /* send scheduled OGM */
390 void (*bat_ogm_emit
)(struct forw_packet
*forw_packet
);
391 /* receive incoming OGM */
392 void (*bat_ogm_receive
)(struct hard_iface
*if_incoming
,
393 struct sk_buff
*skb
);
396 #endif /* _NET_BATMAN_ADV_TYPES_H_ */