1 /* Copyright (C) 2007-2012 B.A.T.M.A.N. contributors:
3 * Marek Lindner, Simon Wunderlich
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.
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.
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
20 #ifndef _NET_BATMAN_ADV_TYPES_H_
21 #define _NET_BATMAN_ADV_TYPES_H_
25 #include <linux/kernel.h>
27 #define BATADV_HEADER_LEN \
28 (ETH_HLEN + max(sizeof(struct batadv_unicast_packet), \
29 sizeof(struct batadv_bcast_packet)))
31 #ifdef CONFIG_BATMAN_ADV_DAT
33 /* batadv_dat_addr_t is the type used for all DHT addresses. If it is changed,
34 * BATADV_DAT_ADDR_MAX is changed as well.
36 * *Please be careful: batadv_dat_addr_t must be UNSIGNED*
38 #define batadv_dat_addr_t uint16_t
40 #endif /* CONFIG_BATMAN_ADV_DAT */
43 * struct batadv_hard_iface_bat_iv - per hard interface B.A.T.M.A.N. IV data
44 * @ogm_buff: buffer holding the OGM packet
45 * @ogm_buff_len: length of the OGM packet buffer
46 * @ogm_seqno: OGM sequence number - used to identify each OGM
48 struct batadv_hard_iface_bat_iv {
49 unsigned char *ogm_buff;
54 struct batadv_hard_iface {
55 struct list_head list;
58 struct net_device *net_dev;
60 struct kobject *hardif_obj;
62 struct packet_type batman_adv_ptype;
63 struct net_device *soft_iface;
65 struct batadv_hard_iface_bat_iv bat_iv;
69 * struct batadv_orig_node - structure for orig_list maintaining nodes of mesh
70 * @primary_addr: hosts primary interface address
71 * @last_seen: when last packet from this node was received
72 * @bcast_seqno_reset: time when the broadcast seqno window was reset
73 * @batman_seqno_reset: time when the batman seqno window was reset
74 * @gw_flags: flags related to gateway class
75 * @flags: for now only VIS_SERVER flag
76 * @last_real_seqno: last and best known sequence number
77 * @last_ttl: ttl of last received packet
78 * @last_bcast_seqno: last broadcast sequence number received by this host
80 * @candidates: how many candidates are available
81 * @selected: next bonding candidate
83 struct batadv_orig_node {
84 uint8_t orig[ETH_ALEN];
85 uint8_t primary_addr[ETH_ALEN];
86 struct batadv_neigh_node __rcu *router; /* rcu protected pointer */
87 #ifdef CONFIG_BATMAN_ADV_DAT
88 batadv_dat_addr_t dat_addr;
90 unsigned long *bcast_own;
91 uint8_t *bcast_own_sum;
92 unsigned long last_seen;
93 unsigned long bcast_seqno_reset;
94 unsigned long batman_seqno_reset;
97 atomic_t last_ttvn; /* last seen translation table version number */
99 unsigned char *tt_buff;
101 spinlock_t tt_buff_lock; /* protects tt_buff */
104 /* The tt_poss_change flag is used to detect an ongoing roaming phase.
105 * If true, then I sent a Roaming_adv to this orig_node and I have to
106 * inspect every packet directed to it to check whether it is still
107 * the true destination or not. This flag will be reset to false as
108 * soon as I receive a new TTVN from this orig_node
111 uint32_t last_real_seqno;
113 DECLARE_BITMAP(bcast_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
114 uint32_t last_bcast_seqno;
115 struct hlist_head neigh_list;
116 struct list_head frag_list;
117 spinlock_t neigh_list_lock; /* protects neigh_list and router */
120 struct hlist_node hash_entry;
121 struct batadv_priv *bat_priv;
122 unsigned long last_frag_packet;
123 /* ogm_cnt_lock protects: bcast_own, bcast_own_sum,
124 * neigh_node->real_bits, neigh_node->real_packet_count
126 spinlock_t ogm_cnt_lock;
127 /* bcast_seqno_lock protects bcast_bits, last_bcast_seqno */
128 spinlock_t bcast_seqno_lock;
129 spinlock_t tt_list_lock; /* protects tt_list */
130 atomic_t bond_candidates;
131 struct list_head bond_list;
134 struct batadv_gw_node {
135 struct hlist_node list;
136 struct batadv_orig_node *orig_node;
137 unsigned long deleted;
143 * @last_seen: when last packet via this neighbor was received
145 struct batadv_neigh_node {
146 struct hlist_node list;
147 uint8_t addr[ETH_ALEN];
148 uint8_t real_packet_count;
149 uint8_t tq_recv[BATADV_TQ_GLOBAL_WINDOW_SIZE];
153 struct list_head bonding_list;
154 unsigned long last_seen;
155 DECLARE_BITMAP(real_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
158 struct batadv_orig_node *orig_node;
159 struct batadv_hard_iface *if_incoming;
160 spinlock_t lq_update_lock; /* protects: tq_recv, tq_index */
163 #ifdef CONFIG_BATMAN_ADV_BLA
164 struct batadv_bcast_duplist_entry {
165 uint8_t orig[ETH_ALEN];
167 unsigned long entrytime;
171 enum batadv_counters {
174 BATADV_CNT_TX_DROPPED,
178 BATADV_CNT_FORWARD_BYTES,
180 BATADV_CNT_MGMT_TX_BYTES,
182 BATADV_CNT_MGMT_RX_BYTES,
183 BATADV_CNT_TT_REQUEST_TX,
184 BATADV_CNT_TT_REQUEST_RX,
185 BATADV_CNT_TT_RESPONSE_TX,
186 BATADV_CNT_TT_RESPONSE_RX,
187 BATADV_CNT_TT_ROAM_ADV_TX,
188 BATADV_CNT_TT_ROAM_ADV_RX,
193 * struct batadv_priv_tt - per mesh interface translation table data
194 * @vn: translation table version number
195 * @local_changes: changes registered in an originator interval
196 * @poss_change: Detect an ongoing roaming phase. If true, then this node
197 * received a roaming_adv and has to inspect every packet directed to it to
198 * check whether it still is the true destination or not. This flag will be
199 * reset to false as soon as the this node's ttvn is increased
200 * @changes_list: tracks tt local changes within an originator interval
201 * @req_list: list of pending tt_requests
202 * @local_crc: Checksum of the local table, recomputed before sending a new OGM
204 struct batadv_priv_tt {
206 atomic_t ogm_append_cnt;
207 atomic_t local_changes;
209 struct list_head changes_list;
210 struct batadv_hashtable *local_hash;
211 struct batadv_hashtable *global_hash;
212 struct list_head req_list;
213 struct list_head roam_list;
214 spinlock_t changes_list_lock; /* protects changes */
215 spinlock_t req_list_lock; /* protects req_list */
216 spinlock_t roam_list_lock; /* protects roam_list */
217 atomic_t local_entry_num;
219 unsigned char *last_changeset;
220 int16_t last_changeset_len;
221 spinlock_t last_changeset_lock; /* protects last_changeset */
222 struct delayed_work work;
225 #ifdef CONFIG_BATMAN_ADV_BLA
226 struct batadv_priv_bla {
227 atomic_t num_requests; /* number of bla requests in flight */
228 struct batadv_hashtable *claim_hash;
229 struct batadv_hashtable *backbone_hash;
230 struct batadv_bcast_duplist_entry bcast_duplist[BATADV_DUPLIST_SIZE];
231 int bcast_duplist_curr;
232 /* protects bcast_duplist and bcast_duplist_curr */
233 spinlock_t bcast_duplist_lock;
234 struct batadv_bla_claim_dst claim_dest;
235 struct delayed_work work;
239 struct batadv_priv_gw {
240 struct hlist_head list;
241 spinlock_t list_lock; /* protects gw_list and curr_gw */
242 struct batadv_gw_node __rcu *curr_gw; /* rcu protected pointer */
246 struct batadv_priv_vis {
247 struct list_head send_list;
248 struct batadv_hashtable *hash;
249 spinlock_t hash_lock; /* protects hash */
250 spinlock_t list_lock; /* protects info::recv_list */
251 struct delayed_work work;
252 struct batadv_vis_info *my_info;
256 * struct batadv_priv_dat - per mesh interface DAT private data
257 * @addr: node DAT address
258 * @hash: hashtable representing the local ARP cache
259 * @work: work queue callback item for cache purging
261 #ifdef CONFIG_BATMAN_ADV_DAT
262 struct batadv_priv_dat {
263 batadv_dat_addr_t addr;
264 struct batadv_hashtable *hash;
265 struct delayed_work work;
271 struct net_device_stats stats;
272 uint64_t __percpu *bat_counters; /* Per cpu counters */
273 atomic_t aggregated_ogms; /* boolean */
274 atomic_t bonding; /* boolean */
275 atomic_t fragmentation; /* boolean */
276 atomic_t ap_isolation; /* boolean */
277 atomic_t bridge_loop_avoidance; /* boolean */
278 atomic_t vis_mode; /* VIS_TYPE_* */
279 atomic_t gw_mode; /* GW_MODE_* */
280 atomic_t gw_sel_class; /* uint */
281 atomic_t gw_bandwidth; /* gw bandwidth */
282 atomic_t orig_interval; /* uint */
283 atomic_t hop_penalty; /* uint */
284 atomic_t log_level; /* uint */
285 atomic_t bcast_seqno;
286 atomic_t bcast_queue_left;
287 atomic_t batman_queue_left;
289 struct batadv_debug_log *debug_log;
290 struct kobject *mesh_obj;
291 struct dentry *debug_dir;
292 struct hlist_head forw_bat_list;
293 struct hlist_head forw_bcast_list;
294 struct batadv_hashtable *orig_hash;
295 spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
296 spinlock_t forw_bcast_list_lock; /* protects */
297 struct delayed_work orig_work;
298 struct batadv_hard_iface __rcu *primary_if; /* rcu protected pointer */
299 struct batadv_algo_ops *bat_algo_ops;
300 #ifdef CONFIG_BATMAN_ADV_BLA
301 struct batadv_priv_bla bla;
303 struct batadv_priv_gw gw;
304 struct batadv_priv_tt tt;
305 struct batadv_priv_vis vis;
306 #ifdef CONFIG_BATMAN_ADV_DAT
307 struct batadv_priv_dat dat;
311 struct batadv_socket_client {
312 struct list_head queue_list;
313 unsigned int queue_len;
315 spinlock_t lock; /* protects queue_list, queue_len, index */
316 wait_queue_head_t queue_wait;
317 struct batadv_priv *bat_priv;
320 struct batadv_socket_packet {
321 struct list_head list;
323 struct batadv_icmp_packet_rr icmp_packet;
326 struct batadv_tt_common_entry {
327 uint8_t addr[ETH_ALEN];
328 struct hlist_node hash_entry;
330 unsigned long added_at;
335 struct batadv_tt_local_entry {
336 struct batadv_tt_common_entry common;
337 unsigned long last_seen;
340 struct batadv_tt_global_entry {
341 struct batadv_tt_common_entry common;
342 struct hlist_head orig_list;
343 spinlock_t list_lock; /* protects the list */
344 unsigned long roam_at; /* time at which TT_GLOBAL_ROAM was set */
347 struct batadv_tt_orig_list_entry {
348 struct batadv_orig_node *orig_node;
352 struct hlist_node list;
355 #ifdef CONFIG_BATMAN_ADV_BLA
356 struct batadv_backbone_gw {
357 uint8_t orig[ETH_ALEN];
358 short vid; /* used VLAN ID */
359 struct hlist_node hash_entry;
360 struct batadv_priv *bat_priv;
361 unsigned long lasttime; /* last time we heard of this backbone gw */
362 atomic_t request_sent;
365 uint16_t crc; /* crc checksum over all claims */
368 struct batadv_claim {
369 uint8_t addr[ETH_ALEN];
371 struct batadv_backbone_gw *backbone_gw;
372 unsigned long lasttime; /* last time we heard of claim (locals only) */
375 struct hlist_node hash_entry;
379 struct batadv_tt_change_node {
380 struct list_head list;
381 struct batadv_tt_change change;
384 struct batadv_tt_req_node {
385 uint8_t addr[ETH_ALEN];
386 unsigned long issued_at;
387 struct list_head list;
390 struct batadv_tt_roam_node {
391 uint8_t addr[ETH_ALEN];
393 unsigned long first_time;
394 struct list_head list;
397 /* forw_packet - structure for forw_list maintaining packets to be
400 struct batadv_forw_packet {
401 struct hlist_node list;
402 unsigned long send_time;
406 uint32_t direct_link_flags;
408 struct delayed_work delayed_work;
409 struct batadv_hard_iface *if_incoming;
412 /* While scanning for vis-entries of a particular vis-originator
413 * this list collects its interfaces to create a subgraph/cluster
416 struct batadv_if_list_entry {
417 uint8_t addr[ETH_ALEN];
419 struct hlist_node list;
422 struct batadv_debug_log {
423 char log_buff[BATADV_LOG_BUF_LEN];
424 unsigned long log_start;
425 unsigned long log_end;
426 spinlock_t lock; /* protects log_buff, log_start and log_end */
427 wait_queue_head_t queue_wait;
430 struct batadv_frag_packet_list_entry {
431 struct list_head list;
436 struct batadv_vis_info {
437 unsigned long first_seen;
438 /* list of server-neighbors we received a vis-packet
439 * from. we should not reply to them.
441 struct list_head recv_list;
442 struct list_head send_list;
443 struct kref refcount;
444 struct hlist_node hash_entry;
445 struct batadv_priv *bat_priv;
446 /* this packet might be part of the vis send queue. */
447 struct sk_buff *skb_packet;
448 /* vis_info may follow here */
451 struct batadv_vis_info_entry {
452 uint8_t src[ETH_ALEN];
453 uint8_t dest[ETH_ALEN];
454 uint8_t quality; /* quality = 0 client */
457 struct batadv_recvlist_node {
458 struct list_head list;
459 uint8_t mac[ETH_ALEN];
462 struct batadv_algo_ops {
463 struct hlist_node list;
465 /* init routing info when hard-interface is enabled */
466 int (*bat_iface_enable)(struct batadv_hard_iface *hard_iface);
467 /* de-init routing info when hard-interface is disabled */
468 void (*bat_iface_disable)(struct batadv_hard_iface *hard_iface);
469 /* (re-)init mac addresses of the protocol information
470 * belonging to this hard-interface
472 void (*bat_iface_update_mac)(struct batadv_hard_iface *hard_iface);
473 /* called when primary interface is selected / changed */
474 void (*bat_primary_iface_set)(struct batadv_hard_iface *hard_iface);
475 /* prepare a new outgoing OGM for the send queue */
476 void (*bat_ogm_schedule)(struct batadv_hard_iface *hard_iface);
477 /* send scheduled OGM */
478 void (*bat_ogm_emit)(struct batadv_forw_packet *forw_packet);
482 * struct batadv_dat_entry - it is a single entry of batman-adv ARP backend. It
483 * is used to stored ARP entries needed for the global DAT cache
484 * @ip: the IPv4 corresponding to this DAT/ARP entry
485 * @mac_addr: the MAC address associated to the stored IPv4
486 * @last_update: time in jiffies when this entry was refreshed last time
487 * @hash_entry: hlist node for batadv_priv_dat::hash
488 * @refcount: number of contexts the object is used
489 * @rcu: struct used for freeing in an RCU-safe manner
491 struct batadv_dat_entry {
493 uint8_t mac_addr[ETH_ALEN];
494 unsigned long last_update;
495 struct hlist_node hash_entry;
501 * struct batadv_dat_candidate - candidate destination for DAT operations
502 * @type: the type of the selected candidate. It can one of the following:
503 * - BATADV_DAT_CANDIDATE_NOT_FOUND
504 * - BATADV_DAT_CANDIDATE_ORIG
505 * @orig_node: if type is BATADV_DAT_CANDIDATE_ORIG this field points to the
506 * corresponding originator node structure
508 struct batadv_dat_candidate {
510 struct batadv_orig_node *orig_node;
513 #endif /* _NET_BATMAN_ADV_TYPES_H_ */