[deliverable/linux.git] / net / batman-adv / types.h

/*
 * Copyright (C) 2007-2011 B.A.T.M.A.N. contributors:
 *
 * 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"

#define BAT_HEADER_LEN (sizeof(struct ethhdr) + \
	((sizeof(struct unicast_packet) > sizeof(struct bcast_packet) ? \
	 sizeof(struct unicast_packet) : \
	 sizeof(struct bcast_packet))))


struct hard_iface {
	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;
	atomic_t refcount;
	struct packet_type batman_adv_ptype;
	struct net_device *soft_iface;
	struct rcu_head rcu;
};

/**
 *	orig_node - structure for orig_list maintaining nodes of mesh
 *	@primary_addr: hosts primary interface address
 *	@last_valid: when last packet from this node was received
 *	@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
 *	@last_real_seqno: last and best known squence number
 *	@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];
	struct neigh_node __rcu *router; /* rcu protected pointer */
	unsigned long *bcast_own;
	uint8_t *bcast_own_sum;
	unsigned long last_valid;
	unsigned long bcast_seqno_reset;
	unsigned long batman_seqno_reset;
	uint8_t gw_flags;
	uint8_t flags;
	unsigned char *tt_buff;
	int16_t tt_buff_len;
	uint32_t last_real_seqno;
	uint8_t last_ttl;
	unsigned long bcast_bits[NUM_WORDS];
	uint32_t last_bcast_seqno;
	struct hlist_head neigh_list;
	struct list_head frag_list;
	spinlock_t neigh_list_lock; /* protects neigh_list and router */
	atomic_t refcount;
	struct rcu_head rcu;
	struct hlist_node hash_entry;
	struct bat_priv *bat_priv;
	unsigned long last_frag_packet;
	/* ogm_cnt_lock protects: bcast_own, bcast_own_sum,
	 * neigh_node->real_bits, neigh_node->real_packet_count */
	spinlock_t ogm_cnt_lock;
	/* bcast_seqno_lock protects bcast_bits, last_bcast_seqno */
	spinlock_t bcast_seqno_lock;
	atomic_t bond_candidates;
	struct list_head bond_list;
};

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

/**
 *	neigh_node
 *	@last_valid: when last packet via this neighbor was received
 */
struct neigh_node {
	struct hlist_node list;
	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;
	struct list_head bonding_list;
	unsigned long last_valid;
	unsigned long real_bits[NUM_WORDS];
	atomic_t refcount;
	struct rcu_head rcu;
	struct orig_node *orig_node;
	struct hard_iface *if_incoming;
	spinlock_t tq_lock;	/* protects: tq_recv, tq_index */
};


struct bat_priv {
	atomic_t mesh_state;
	struct net_device_stats stats;
	atomic_t aggregated_ogms;	/* boolean */
	atomic_t bonding;		/* boolean */
	atomic_t fragmentation;		/* boolean */
	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;
	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;
	struct hlist_head softif_neigh_vids;
	struct list_head vis_send_list;
	struct hashtable_t *orig_hash;
	struct hashtable_t *tt_local_hash;
	struct hashtable_t *tt_global_hash;
	struct hashtable_t *vis_hash;
	spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
	spinlock_t forw_bcast_list_lock; /* protects  */
	spinlock_t tt_lhash_lock; /* protects tt_local_hash */
	spinlock_t tt_ghash_lock; /* protects tt_global_hash */
	spinlock_t gw_list_lock; /* protects gw_list and curr_gw */
	spinlock_t vis_hash_lock; /* protects vis_hash */
	spinlock_t vis_list_lock; /* protects vis_info::recv_list */
	spinlock_t softif_neigh_lock; /* protects soft-interface neigh list */
	spinlock_t softif_neigh_vid_lock; /* protects soft-interface vid list */
	int16_t num_local_tt;
	atomic_t tt_local_changed;
	struct delayed_work tt_work;
	struct delayed_work orig_work;
	struct delayed_work vis_work;
	struct gw_node __rcu *curr_gw;  /* rcu protected pointer */
	struct hard_iface __rcu *primary_if;  /* rcu protected pointer */
	struct vis_info *my_vis_info;
};

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;
};

struct tt_local_entry {
	uint8_t addr[ETH_ALEN];
	unsigned long last_seen;
	char never_purge;
	struct hlist_node hash_entry;
};

struct tt_global_entry {
	uint8_t addr[ETH_ALEN];
	struct orig_node *orig_node;
	struct hlist_node hash_entry;
};

/**
 *	forw_packet - structure for forw_list maintaining packets to be
 *	              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;
	struct hard_iface *if_incoming;
};

/* 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 {
	unsigned long       first_seen;
	struct list_head    recv_list;
			    /* list of server-neighbors we received a vis-packet
			     * from.  we should not reply to them. */
	struct list_head send_list;
	struct kref refcount;
	struct hlist_node hash_entry;
	struct bat_priv *bat_priv;
	/* this packet might be part of the vis send queue. */
	struct sk_buff *skb_packet;
	/* vis_info may follow here*/
} __packed;

struct vis_info_entry {
	uint8_t  src[ETH_ALEN];
	uint8_t  dest[ETH_ALEN];
	uint8_t  quality;	/* quality = 0 client */
} __packed;

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

struct softif_neigh_vid {
	struct hlist_node list;
	struct bat_priv *bat_priv;
	short vid;
	atomic_t refcount;
	struct softif_neigh __rcu *softif_neigh;
	struct rcu_head rcu;
	struct hlist_head softif_neigh_list;
};

struct softif_neigh {
	struct hlist_node list;
	uint8_t addr[ETH_ALEN];
	unsigned long last_seen;
	atomic_t refcount;
	struct rcu_head rcu;
};

#endif /* _NET_BATMAN_ADV_TYPES_H_ */
Commit	Line	Data
c6c8fea2	1	/*
64afe353	2	* Copyright (C) 2007-2011 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
	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))))
	34
	35
e6c10f43	36	struct 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
	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 squence number
	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	*/
	67	struct 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;
c6c8fea2 SE	72	uint8_t *bcast_own_sum;
c6c8fea2 SE	73	unsigned long last_valid;
	74	unsigned long bcast_seqno_reset;
	75	unsigned long batman_seqno_reset;
	76	uint8_t gw_flags;
	77	uint8_t flags;
2dafb49d AQ	78	unsigned char *tt_buff;
2dafb49d AQ	79	int16_t tt_buff_len;
c6c8fea2 SE	80	uint32_t last_real_seqno;
	81	uint8_t last_ttl;
	82	unsigned long bcast_bits[NUM_WORDS];
	83	uint32_t last_bcast_seqno;
9591a79f	84	struct hlist_head neigh_list;
c6c8fea2	85	struct list_head frag_list;
e1a5382f	86	spinlock_t neigh_list_lock; /* protects neigh_list and router */
7b36e8ee ML	87	atomic_t refcount;
7b36e8ee ML	88	struct rcu_head rcu;
7aadf889	89	struct hlist_node hash_entry;
16b1aba8	90	struct bat_priv *bat_priv;
c6c8fea2	91	unsigned long last_frag_packet;
6e215fd8 SE	92	/* ogm_cnt_lock protects: bcast_own, bcast_own_sum,
	93	* neigh_node->real_bits, neigh_node->real_packet_count */
	94	spinlock_t ogm_cnt_lock;
	95	/* bcast_seqno_lock protects bcast_bits, last_bcast_seqno */
	96	spinlock_t bcast_seqno_lock;
a4c135c5 SW	97	atomic_t bond_candidates;
a4c135c5 SW	98	struct list_head bond_list;
c6c8fea2 SE	99	};
	100
	101	struct gw_node {
	102	struct hlist_node list;
	103	struct orig_node *orig_node;
	104	unsigned long deleted;
25b6d3c1	105	atomic_t refcount;
c6c8fea2 SE	106	struct rcu_head rcu;
	107	};
	108
	109	/**
	110	* neigh_node
	111	* @last_valid: when last packet via this neighbor was received
	112	*/
	113	struct neigh_node {
9591a79f	114	struct hlist_node list;
c6c8fea2 SE	115	uint8_t addr[ETH_ALEN];
	116	uint8_t real_packet_count;
	117	uint8_t tq_recv[TQ_GLOBAL_WINDOW_SIZE];
	118	uint8_t tq_index;
	119	uint8_t tq_avg;
	120	uint8_t last_ttl;
a4c135c5	121	struct list_head bonding_list;
c6c8fea2 SE	122	unsigned long last_valid;
c6c8fea2 SE	123	unsigned long real_bits[NUM_WORDS];
44524fcd	124	atomic_t refcount;
f987ed6e	125	struct rcu_head rcu;
c6c8fea2	126	struct orig_node *orig_node;
e6c10f43	127	struct hard_iface *if_incoming;
68003903	128	spinlock_t tq_lock; /* protects: tq_recv, tq_index */
c6c8fea2 SE	129	};
	130
	131
	132	struct bat_priv {
	133	atomic_t mesh_state;
	134	struct net_device_stats stats;
	135	atomic_t aggregated_ogms; /* boolean */
	136	atomic_t bonding; /* boolean */
	137	atomic_t fragmentation; /* boolean */
	138	atomic_t vis_mode; /* VIS_TYPE_* */
	139	atomic_t gw_mode; /* GW_MODE_* */
	140	atomic_t gw_sel_class; /* uint */
	141	atomic_t gw_bandwidth; /* gw bandwidth */
	142	atomic_t orig_interval; /* uint */
	143	atomic_t hop_penalty; /* uint */
	144	atomic_t log_level; /* uint */
	145	atomic_t bcast_seqno;
	146	atomic_t bcast_queue_left;
	147	atomic_t batman_queue_left;
	148	char num_ifaces;
c6c8fea2	149	struct debug_log *debug_log;
c6c8fea2 SE	150	struct kobject *mesh_obj;
	151	struct dentry *debug_dir;
	152	struct hlist_head forw_bat_list;
	153	struct hlist_head forw_bcast_list;
	154	struct hlist_head gw_list;
61906ae8	155	struct hlist_head softif_neigh_vids;
c6c8fea2 SE	156	struct list_head vis_send_list;
c6c8fea2 SE	157	struct hashtable_t *orig_hash;
2dafb49d AQ	158	struct hashtable_t *tt_local_hash;
2dafb49d AQ	159	struct hashtable_t *tt_global_hash;
c6c8fea2	160	struct hashtable_t *vis_hash;
c6c8fea2 SE	161	spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
c6c8fea2 SE	162	spinlock_t forw_bcast_list_lock; /* protects */
2dafb49d AQ	163	spinlock_t tt_lhash_lock; /* protects tt_local_hash */
2dafb49d AQ	164	spinlock_t tt_ghash_lock; /* protects tt_global_hash */
5d02b3cd	165	spinlock_t gw_list_lock; /* protects gw_list and curr_gw */
c6c8fea2 SE	166	spinlock_t vis_hash_lock; /* protects vis_hash */
	167	spinlock_t vis_list_lock; /* protects vis_info::recv_list */
	168	spinlock_t softif_neigh_lock; /* protects soft-interface neigh list */
61906ae8	169	spinlock_t softif_neigh_vid_lock; /* protects soft-interface vid list */
2dafb49d AQ	170	int16_t num_local_tt;
	171	atomic_t tt_local_changed;
	172	struct delayed_work tt_work;
c6c8fea2 SE	173	struct delayed_work orig_work;
c6c8fea2 SE	174	struct delayed_work vis_work;
5d02b3cd	175	struct gw_node __rcu curr_gw; / rcu protected pointer */
32ae9b22	176	struct hard_iface __rcu primary_if; / rcu protected pointer */
c6c8fea2 SE	177	struct vis_info *my_vis_info;
	178	};
	179
	180	struct socket_client {
	181	struct list_head queue_list;
	182	unsigned int queue_len;
	183	unsigned char index;
	184	spinlock_t lock; /* protects queue_list, queue_len, index */
	185	wait_queue_head_t queue_wait;
	186	struct bat_priv *bat_priv;
	187	};
	188
	189	struct socket_packet {
	190	struct list_head list;
	191	size_t icmp_len;
	192	struct icmp_packet_rr icmp_packet;
	193	};
	194
2dafb49d	195	struct tt_local_entry {
c6c8fea2 SE	196	uint8_t addr[ETH_ALEN];
	197	unsigned long last_seen;
	198	char never_purge;
7aadf889	199	struct hlist_node hash_entry;
c6c8fea2 SE	200	};
c6c8fea2 SE	201
2dafb49d	202	struct tt_global_entry {
c6c8fea2 SE	203	uint8_t addr[ETH_ALEN];
c6c8fea2 SE	204	struct orig_node *orig_node;
7aadf889	205	struct hlist_node hash_entry;
c6c8fea2 SE	206	};
	207
	208	/**
	209	* forw_packet - structure for forw_list maintaining packets to be
	210	* send/forwarded
	211	*/
	212	struct forw_packet {
	213	struct hlist_node list;
	214	unsigned long send_time;
	215	uint8_t own;
	216	struct sk_buff *skb;
	217	uint16_t packet_len;
	218	uint32_t direct_link_flags;
	219	uint8_t num_packets;
	220	struct delayed_work delayed_work;
e6c10f43	221	struct hard_iface *if_incoming;
c6c8fea2 SE	222	};
	223
	224	/* While scanning for vis-entries of a particular vis-originator
	225	* this list collects its interfaces to create a subgraph/cluster
	226	* out of them later
	227	*/
	228	struct if_list_entry {
	229	uint8_t addr[ETH_ALEN];
	230	bool primary;
	231	struct hlist_node list;
	232	};
	233
	234	struct debug_log {
	235	char log_buff[LOG_BUF_LEN];
	236	unsigned long log_start;
	237	unsigned long log_end;
	238	spinlock_t lock; /* protects log_buff, log_start and log_end */
	239	wait_queue_head_t queue_wait;
	240	};
	241
	242	struct frag_packet_list_entry {
	243	struct list_head list;
	244	uint16_t seqno;
	245	struct sk_buff *skb;
	246	};
	247
	248	struct vis_info {
	249	unsigned long first_seen;
	250	struct list_head recv_list;
	251	/* list of server-neighbors we received a vis-packet
	252	* from. we should not reply to them. */
	253	struct list_head send_list;
	254	struct kref refcount;
7aadf889	255	struct hlist_node hash_entry;
c6c8fea2 SE	256	struct bat_priv *bat_priv;
	257	/* this packet might be part of the vis send queue. */
	258	struct sk_buff *skb_packet;
	259	/* vis_info may follow here*/
aa0adb1a	260	} __packed;
c6c8fea2 SE	261
	262	struct vis_info_entry {
	263	uint8_t src[ETH_ALEN];
	264	uint8_t dest[ETH_ALEN];
2dafb49d	265	uint8_t quality; /* quality = 0 client */
aa0adb1a	266	} __packed;
c6c8fea2 SE	267
	268	struct recvlist_node {
	269	struct list_head list;
	270	uint8_t mac[ETH_ALEN];
	271	};
	272
61906ae8 ML	273	struct softif_neigh_vid {
	274	struct hlist_node list;
	275	struct bat_priv *bat_priv;
	276	short vid;
	277	atomic_t refcount;
	278	struct softif_neigh __rcu *softif_neigh;
	279	struct rcu_head rcu;
	280	struct hlist_head softif_neigh_list;
	281	};
	282
c6c8fea2 SE	283	struct softif_neigh {
	284	struct hlist_node list;
	285	uint8_t addr[ETH_ALEN];
	286	unsigned long last_seen;
7d2b5548	287	atomic_t refcount;
c6c8fea2 SE	288	struct rcu_head rcu;
	289	};
	290
	291	#endif /* _NET_BATMAN_ADV_TYPES_H_ */