xref: /openbmc/linux/net/batman-adv/types.h (revision 4800cd83)
1 /*
2  * Copyright (C) 2007-2010 B.A.T.M.A.N. contributors:
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 
36 struct batman_if {
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;
46 	struct kref refcount;
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];
70 	struct neigh_node *router;
71 	unsigned long *bcast_own;
72 	uint8_t *bcast_own_sum;
73 	uint8_t tq_own;
74 	int tq_asym_penalty;
75 	unsigned long last_valid;
76 	unsigned long bcast_seqno_reset;
77 	unsigned long batman_seqno_reset;
78 	uint8_t gw_flags;
79 	uint8_t flags;
80 	unsigned char *hna_buff;
81 	int16_t hna_buff_len;
82 	uint32_t last_real_seqno;
83 	uint8_t last_ttl;
84 	unsigned long bcast_bits[NUM_WORDS];
85 	uint32_t last_bcast_seqno;
86 	struct list_head neigh_list;
87 	struct list_head frag_list;
88 	unsigned long last_frag_packet;
89 	struct {
90 		uint8_t candidates;
91 		struct neigh_node *selected;
92 	} bond;
93 };
94 
95 struct gw_node {
96 	struct hlist_node list;
97 	struct orig_node *orig_node;
98 	unsigned long deleted;
99 	struct kref refcount;
100 	struct rcu_head rcu;
101 };
102 
103 /**
104  *	neigh_node
105  *	@last_valid: when last packet via this neighbor was received
106  */
107 struct neigh_node {
108 	struct list_head list;
109 	uint8_t addr[ETH_ALEN];
110 	uint8_t real_packet_count;
111 	uint8_t tq_recv[TQ_GLOBAL_WINDOW_SIZE];
112 	uint8_t tq_index;
113 	uint8_t tq_avg;
114 	uint8_t last_ttl;
115 	struct neigh_node *next_bond_candidate;
116 	unsigned long last_valid;
117 	unsigned long real_bits[NUM_WORDS];
118 	struct orig_node *orig_node;
119 	struct batman_if *if_incoming;
120 };
121 
122 
123 struct bat_priv {
124 	atomic_t mesh_state;
125 	struct net_device_stats stats;
126 	atomic_t aggregated_ogms;	/* boolean */
127 	atomic_t bonding;		/* boolean */
128 	atomic_t fragmentation;		/* boolean */
129 	atomic_t vis_mode;		/* VIS_TYPE_* */
130 	atomic_t gw_mode;		/* GW_MODE_* */
131 	atomic_t gw_sel_class;		/* uint */
132 	atomic_t gw_bandwidth;		/* gw bandwidth */
133 	atomic_t orig_interval;		/* uint */
134 	atomic_t hop_penalty;		/* uint */
135 	atomic_t log_level;		/* uint */
136 	atomic_t bcast_seqno;
137 	atomic_t bcast_queue_left;
138 	atomic_t batman_queue_left;
139 	char num_ifaces;
140 	struct hlist_head softif_neigh_list;
141 	struct softif_neigh *softif_neigh;
142 	struct debug_log *debug_log;
143 	struct batman_if *primary_if;
144 	struct kobject *mesh_obj;
145 	struct dentry *debug_dir;
146 	struct hlist_head forw_bat_list;
147 	struct hlist_head forw_bcast_list;
148 	struct hlist_head gw_list;
149 	struct list_head vis_send_list;
150 	struct hashtable_t *orig_hash;
151 	struct hashtable_t *hna_local_hash;
152 	struct hashtable_t *hna_global_hash;
153 	struct hashtable_t *vis_hash;
154 	spinlock_t orig_hash_lock; /* protects orig_hash */
155 	spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
156 	spinlock_t forw_bcast_list_lock; /* protects  */
157 	spinlock_t hna_lhash_lock; /* protects hna_local_hash */
158 	spinlock_t hna_ghash_lock; /* protects hna_global_hash */
159 	spinlock_t gw_list_lock; /* protects gw_list */
160 	spinlock_t vis_hash_lock; /* protects vis_hash */
161 	spinlock_t vis_list_lock; /* protects vis_info::recv_list */
162 	spinlock_t softif_neigh_lock; /* protects soft-interface neigh list */
163 	int16_t num_local_hna;
164 	atomic_t hna_local_changed;
165 	struct delayed_work hna_work;
166 	struct delayed_work orig_work;
167 	struct delayed_work vis_work;
168 	struct gw_node *curr_gw;
169 	struct vis_info *my_vis_info;
170 };
171 
172 struct socket_client {
173 	struct list_head queue_list;
174 	unsigned int queue_len;
175 	unsigned char index;
176 	spinlock_t lock; /* protects queue_list, queue_len, index */
177 	wait_queue_head_t queue_wait;
178 	struct bat_priv *bat_priv;
179 };
180 
181 struct socket_packet {
182 	struct list_head list;
183 	size_t icmp_len;
184 	struct icmp_packet_rr icmp_packet;
185 };
186 
187 struct hna_local_entry {
188 	uint8_t addr[ETH_ALEN];
189 	unsigned long last_seen;
190 	char never_purge;
191 };
192 
193 struct hna_global_entry {
194 	uint8_t addr[ETH_ALEN];
195 	struct orig_node *orig_node;
196 };
197 
198 /**
199  *	forw_packet - structure for forw_list maintaining packets to be
200  *	              send/forwarded
201  */
202 struct forw_packet {
203 	struct hlist_node list;
204 	unsigned long send_time;
205 	uint8_t own;
206 	struct sk_buff *skb;
207 	uint16_t packet_len;
208 	uint32_t direct_link_flags;
209 	uint8_t num_packets;
210 	struct delayed_work delayed_work;
211 	struct batman_if *if_incoming;
212 };
213 
214 /* While scanning for vis-entries of a particular vis-originator
215  * this list collects its interfaces to create a subgraph/cluster
216  * out of them later
217  */
218 struct if_list_entry {
219 	uint8_t addr[ETH_ALEN];
220 	bool primary;
221 	struct hlist_node list;
222 };
223 
224 struct debug_log {
225 	char log_buff[LOG_BUF_LEN];
226 	unsigned long log_start;
227 	unsigned long log_end;
228 	spinlock_t lock; /* protects log_buff, log_start and log_end */
229 	wait_queue_head_t queue_wait;
230 };
231 
232 struct frag_packet_list_entry {
233 	struct list_head list;
234 	uint16_t seqno;
235 	struct sk_buff *skb;
236 };
237 
238 struct vis_info {
239 	unsigned long       first_seen;
240 	struct list_head    recv_list;
241 			    /* list of server-neighbors we received a vis-packet
242 			     * from.  we should not reply to them. */
243 	struct list_head send_list;
244 	struct kref refcount;
245 	struct bat_priv *bat_priv;
246 	/* this packet might be part of the vis send queue. */
247 	struct sk_buff *skb_packet;
248 	/* vis_info may follow here*/
249 } __packed;
250 
251 struct vis_info_entry {
252 	uint8_t  src[ETH_ALEN];
253 	uint8_t  dest[ETH_ALEN];
254 	uint8_t  quality;	/* quality = 0 means HNA */
255 } __packed;
256 
257 struct recvlist_node {
258 	struct list_head list;
259 	uint8_t mac[ETH_ALEN];
260 };
261 
262 struct softif_neigh {
263 	struct hlist_node list;
264 	uint8_t addr[ETH_ALEN];
265 	unsigned long last_seen;
266 	short vid;
267 	struct kref refcount;
268 	struct rcu_head rcu;
269 };
270 
271 #endif /* _NET_BATMAN_ADV_TYPES_H_ */
272