types.h 11.7 KB
Newer Older
1
/* Copyright (C) 2007-2012 B.A.T.M.A.N. contributors:
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
 *
 * Marek Lindner, Simon Wunderlich
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA
 */

#ifndef _NET_BATMAN_ADV_TYPES_H_
#define _NET_BATMAN_ADV_TYPES_H_

#include "packet.h"
#include "bitarray.h"

26
#define BAT_HEADER_LEN (ETH_HLEN + \
27 28 29 30 31
	((sizeof(struct unicast_packet) > sizeof(struct bcast_packet) ? \
	 sizeof(struct unicast_packet) : \
	 sizeof(struct bcast_packet))))


32
struct hard_iface {
33 34 35 36 37 38 39 40 41
	struct list_head list;
	int16_t if_num;
	char if_status;
	struct net_device *net_dev;
	atomic_t seqno;
	atomic_t frag_seqno;
	unsigned char *packet_buff;
	int packet_len;
	struct kobject *hardif_obj;
42
	atomic_t refcount;
43 44 45 46 47
	struct packet_type batman_adv_ptype;
	struct net_device *soft_iface;
	struct rcu_head rcu;
};

48
/*	orig_node - structure for orig_list maintaining nodes of mesh
49
 *	@primary_addr: hosts primary interface address
50
 *	@last_seen: when last packet from this node was received
51 52 53 54
 *	@bcast_seqno_reset: time when the broadcast seqno window was reset
 *	@batman_seqno_reset: time when the batman seqno window was reset
 *	@gw_flags: flags related to gateway class
 *	@flags: for now only VIS_SERVER flag
55
 *	@last_real_seqno: last and best known sequence number
56 57 58 59 60 61 62 63 64
 *	@last_ttl: ttl of last received packet
 *	@last_bcast_seqno: last broadcast sequence number received by this host
 *
 *	@candidates: how many candidates are available
 *	@selected: next bonding candidate
 */
struct orig_node {
	uint8_t orig[ETH_ALEN];
	uint8_t primary_addr[ETH_ALEN];
65
	struct neigh_node __rcu *router; /* rcu protected pointer */
66 67
	unsigned long *bcast_own;
	uint8_t *bcast_own_sum;
68
	unsigned long last_seen;
69 70 71 72
	unsigned long bcast_seqno_reset;
	unsigned long batman_seqno_reset;
	uint8_t gw_flags;
	uint8_t flags;
73 74
	atomic_t last_ttvn; /* last seen translation table version number */
	uint16_t tt_crc;
75 76
	unsigned char *tt_buff;
	int16_t tt_buff_len;
77 78
	spinlock_t tt_buff_lock; /* protects tt_buff */
	atomic_t tt_size;
79
	bool tt_initialised;
80 81 82 83
	/* The tt_poss_change flag is used to detect an ongoing roaming phase.
	 * If true, then I sent a Roaming_adv to this orig_node and I have to
	 * inspect every packet directed to it to check whether it is still
	 * the true destination or not. This flag will be reset to false as
84 85
	 * soon as I receive a new TTVN from this orig_node
	 */
86
	bool tt_poss_change;
87 88
	uint32_t last_real_seqno;
	uint8_t last_ttl;
89
	DECLARE_BITMAP(bcast_bits, TQ_LOCAL_WINDOW_SIZE);
90
	uint32_t last_bcast_seqno;
91
	struct hlist_head neigh_list;
92
	struct list_head frag_list;
93
	spinlock_t neigh_list_lock; /* protects neigh_list and router */
94 95
	atomic_t refcount;
	struct rcu_head rcu;
96
	struct hlist_node hash_entry;
97
	struct bat_priv *bat_priv;
98
	unsigned long last_frag_packet;
99
	/* ogm_cnt_lock protects: bcast_own, bcast_own_sum,
100 101
	 * neigh_node->real_bits, neigh_node->real_packet_count
	 */
102 103 104
	spinlock_t ogm_cnt_lock;
	/* bcast_seqno_lock protects bcast_bits, last_bcast_seqno */
	spinlock_t bcast_seqno_lock;
105
	spinlock_t tt_list_lock; /* protects tt_list */
106 107
	atomic_t bond_candidates;
	struct list_head bond_list;
108 109 110 111 112 113
};

struct gw_node {
	struct hlist_node list;
	struct orig_node *orig_node;
	unsigned long deleted;
114
	atomic_t refcount;
115 116 117
	struct rcu_head rcu;
};

118
/*	neigh_node
119
 *	@last_seen: when last packet via this neighbor was received
120 121
 */
struct neigh_node {
122
	struct hlist_node list;
123 124 125 126 127 128
	uint8_t addr[ETH_ALEN];
	uint8_t real_packet_count;
	uint8_t tq_recv[TQ_GLOBAL_WINDOW_SIZE];
	uint8_t tq_index;
	uint8_t tq_avg;
	uint8_t last_ttl;
129
	struct list_head bonding_list;
130
	unsigned long last_seen;
131
	DECLARE_BITMAP(real_bits, TQ_LOCAL_WINDOW_SIZE);
132
	atomic_t refcount;
133
	struct rcu_head rcu;
134
	struct orig_node *orig_node;
135
	struct hard_iface *if_incoming;
136
	spinlock_t lq_update_lock;	/* protects: tq_recv, tq_index */
137 138
};

139
#ifdef CONFIG_BATMAN_ADV_BLA
140 141 142 143 144
struct bcast_duplist_entry {
	uint8_t orig[ETH_ALEN];
	uint16_t crc;
	unsigned long entrytime;
};
145
#endif
146

147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
enum bat_counters {
	BAT_CNT_FORWARD,
	BAT_CNT_FORWARD_BYTES,
	BAT_CNT_MGMT_TX,
	BAT_CNT_MGMT_TX_BYTES,
	BAT_CNT_MGMT_RX,
	BAT_CNT_MGMT_RX_BYTES,
	BAT_CNT_TT_REQUEST_TX,
	BAT_CNT_TT_REQUEST_RX,
	BAT_CNT_TT_RESPONSE_TX,
	BAT_CNT_TT_RESPONSE_RX,
	BAT_CNT_TT_ROAM_ADV_TX,
	BAT_CNT_TT_ROAM_ADV_RX,
	BAT_CNT_NUM,
};

163 164 165
struct bat_priv {
	atomic_t mesh_state;
	struct net_device_stats stats;
166
	uint64_t __percpu *bat_counters; /* Per cpu counters */
167 168 169
	atomic_t aggregated_ogms;	/* boolean */
	atomic_t bonding;		/* boolean */
	atomic_t fragmentation;		/* boolean */
170
	atomic_t ap_isolation;		/* boolean */
171
	atomic_t bridge_loop_avoidance;	/* boolean */
172 173 174 175 176 177 178 179 180 181
	atomic_t vis_mode;		/* VIS_TYPE_* */
	atomic_t gw_mode;		/* GW_MODE_* */
	atomic_t gw_sel_class;		/* uint */
	atomic_t gw_bandwidth;		/* gw bandwidth */
	atomic_t orig_interval;		/* uint */
	atomic_t hop_penalty;		/* uint */
	atomic_t log_level;		/* uint */
	atomic_t bcast_seqno;
	atomic_t bcast_queue_left;
	atomic_t batman_queue_left;
182
	atomic_t ttvn; /* translation table version number */
183 184
	atomic_t tt_ogm_append_cnt;
	atomic_t tt_local_changes; /* changes registered in a OGM interval */
185
	atomic_t bla_num_requests; /* number of bla requests in flight */
186 187 188 189
	/* The tt_poss_change flag is used to detect an ongoing roaming phase.
	 * If true, then I received a Roaming_adv and I have to inspect every
	 * packet directed to me to check whether I am still the true
	 * destination or not. This flag will be reset to false as soon as I
190 191
	 * increase my TTVN
	 */
192
	bool tt_poss_change;
193 194 195 196 197 198 199
	char num_ifaces;
	struct debug_log *debug_log;
	struct kobject *mesh_obj;
	struct dentry *debug_dir;
	struct hlist_head forw_bat_list;
	struct hlist_head forw_bcast_list;
	struct hlist_head gw_list;
200
	struct list_head tt_changes_list; /* tracks changes in a OGM int */
201 202
	struct list_head vis_send_list;
	struct hashtable_t *orig_hash;
203 204
	struct hashtable_t *tt_local_hash;
	struct hashtable_t *tt_global_hash;
205
#ifdef CONFIG_BATMAN_ADV_BLA
206 207
	struct hashtable_t *claim_hash;
	struct hashtable_t *backbone_hash;
208
#endif
209
	struct list_head tt_req_list; /* list of pending tt_requests */
210
	struct list_head tt_roam_list;
211
	struct hashtable_t *vis_hash;
212
#ifdef CONFIG_BATMAN_ADV_BLA
213 214
	struct bcast_duplist_entry bcast_duplist[DUPLIST_SIZE];
	int bcast_duplist_curr;
215
	struct bla_claim_dst claim_dest;
216
#endif
217 218
	spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
	spinlock_t forw_bcast_list_lock; /* protects  */
219 220
	spinlock_t tt_changes_list_lock; /* protects tt_changes */
	spinlock_t tt_req_list_lock; /* protects tt_req_list */
221
	spinlock_t tt_roam_list_lock; /* protects tt_roam_list */
222
	spinlock_t gw_list_lock; /* protects gw_list and curr_gw */
223 224
	spinlock_t vis_hash_lock; /* protects vis_hash */
	spinlock_t vis_list_lock; /* protects vis_info::recv_list */
225 226
	atomic_t num_local_tt;
	/* Checksum of the local table, recomputed before sending a new OGM */
227
	uint16_t tt_crc;
228 229 230
	unsigned char *tt_buff;
	int16_t tt_buff_len;
	spinlock_t tt_buff_lock; /* protects tt_buff */
231
	struct delayed_work tt_work;
232 233
	struct delayed_work orig_work;
	struct delayed_work vis_work;
234
	struct delayed_work bla_work;
235
	struct gw_node __rcu *curr_gw;  /* rcu protected pointer */
236
	atomic_t gw_reselect;
237
	struct hard_iface __rcu *primary_if;  /* rcu protected pointer */
238
	struct vis_info *my_vis_info;
239
	struct bat_algo_ops *bat_algo_ops;
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
};

struct socket_client {
	struct list_head queue_list;
	unsigned int queue_len;
	unsigned char index;
	spinlock_t lock; /* protects queue_list, queue_len, index */
	wait_queue_head_t queue_wait;
	struct bat_priv *bat_priv;
};

struct socket_packet {
	struct list_head list;
	size_t icmp_len;
	struct icmp_packet_rr icmp_packet;
};

257
struct tt_common_entry {
258
	uint8_t addr[ETH_ALEN];
259
	struct hlist_node hash_entry;
260
	uint16_t flags;
261 262
	atomic_t refcount;
	struct rcu_head rcu;
263 264
};

265 266 267 268 269
struct tt_local_entry {
	struct tt_common_entry common;
	unsigned long last_seen;
};

270
struct tt_global_entry {
271
	struct tt_common_entry common;
272 273 274 275 276 277
	struct hlist_head orig_list;
	spinlock_t list_lock;	/* protects the list */
	unsigned long roam_at; /* time at which TT_GLOBAL_ROAM was set */
};

struct tt_orig_list_entry {
278
	struct orig_node *orig_node;
279
	uint8_t ttvn;
280 281
	struct rcu_head rcu;
	struct hlist_node list;
282 283
};

284
#ifdef CONFIG_BATMAN_ADV_BLA
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
struct backbone_gw {
	uint8_t orig[ETH_ALEN];
	short vid;		/* used VLAN ID */
	struct hlist_node hash_entry;
	struct bat_priv *bat_priv;
	unsigned long lasttime;	/* last time we heard of this backbone gw */
	atomic_t request_sent;
	atomic_t refcount;
	struct rcu_head rcu;
	uint16_t crc;		/* crc checksum over all claims */
};

struct claim {
	uint8_t addr[ETH_ALEN];
	short vid;
	struct backbone_gw *backbone_gw;
	unsigned long lasttime;	/* last time we heard of claim (locals only) */
	struct rcu_head rcu;
	atomic_t refcount;
	struct hlist_node hash_entry;
};
306
#endif
307

308 309 310 311 312 313 314 315 316 317 318
struct tt_change_node {
	struct list_head list;
	struct tt_change change;
};

struct tt_req_node {
	uint8_t addr[ETH_ALEN];
	unsigned long issued_at;
	struct list_head list;
};

319 320 321 322 323 324 325
struct tt_roam_node {
	uint8_t addr[ETH_ALEN];
	atomic_t counter;
	unsigned long first_time;
	struct list_head list;
};

326
/*	forw_packet - structure for forw_list maintaining packets to be
327 328 329 330 331 332 333 334 335 336 337
 *	              send/forwarded
 */
struct forw_packet {
	struct hlist_node list;
	unsigned long send_time;
	uint8_t own;
	struct sk_buff *skb;
	uint16_t packet_len;
	uint32_t direct_link_flags;
	uint8_t num_packets;
	struct delayed_work delayed_work;
338
	struct hard_iface *if_incoming;
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
};

/* While scanning for vis-entries of a particular vis-originator
 * this list collects its interfaces to create a subgraph/cluster
 * out of them later
 */
struct if_list_entry {
	uint8_t addr[ETH_ALEN];
	bool primary;
	struct hlist_node list;
};

struct debug_log {
	char log_buff[LOG_BUF_LEN];
	unsigned long log_start;
	unsigned long log_end;
	spinlock_t lock; /* protects log_buff, log_start and log_end */
	wait_queue_head_t queue_wait;
};

struct frag_packet_list_entry {
	struct list_head list;
	uint16_t seqno;
	struct sk_buff *skb;
};

struct vis_info {
366 367
	unsigned long first_seen;
	/* list of server-neighbors we received a vis-packet
368 369
	 * from.  we should not reply to them.
	 */
370
	struct list_head recv_list;
371 372
	struct list_head send_list;
	struct kref refcount;
373
	struct hlist_node hash_entry;
374 375 376
	struct bat_priv *bat_priv;
	/* this packet might be part of the vis send queue. */
	struct sk_buff *skb_packet;
377
	/* vis_info may follow here */
378
} __packed;
379 380 381 382

struct vis_info_entry {
	uint8_t  src[ETH_ALEN];
	uint8_t  dest[ETH_ALEN];
383
	uint8_t  quality;	/* quality = 0 client */
384
} __packed;
385 386 387 388 389 390

struct recvlist_node {
	struct list_head list;
	uint8_t mac[ETH_ALEN];
};

391 392 393
struct bat_algo_ops {
	struct hlist_node list;
	char *name;
394
	/* init routing info when hard-interface is enabled */
395
	int (*bat_iface_enable)(struct hard_iface *hard_iface);
396 397
	/* de-init routing info when hard-interface is disabled */
	void (*bat_iface_disable)(struct hard_iface *hard_iface);
398 399 400 401
	/* (re-)init mac addresses of the protocol information
	 * belonging to this hard-interface
	 */
	void (*bat_iface_update_mac)(struct hard_iface *hard_iface);
402 403
	/* called when primary interface is selected / changed */
	void (*bat_primary_iface_set)(struct hard_iface *hard_iface);
404
	/* prepare a new outgoing OGM for the send queue */
405
	void (*bat_ogm_schedule)(struct hard_iface *hard_iface);
406 407
	/* send scheduled OGM */
	void (*bat_ogm_emit)(struct forw_packet *forw_packet);
408 409
};

410
#endif /* _NET_BATMAN_ADV_TYPES_H_ */