1 /* Copyright (C) 2007-2014 B.A.T.M.A.N. contributors:
2 *
3 * Marek Lindner, Simon Wunderlich
4 *
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.
8 *
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.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, see <http://www.gnu.org/licenses/>.
16 */
17
18 #ifndef _NET_BATMAN_ADV_MAIN_H_
19 #define _NET_BATMAN_ADV_MAIN_H_
20
21 #define BATADV_DRIVER_AUTHOR "Marek Lindner <mareklindner@neomailbox.ch>, " \
22 "Simon Wunderlich <sw@simonwunderlich.de>"
23 #define BATADV_DRIVER_DESC "B.A.T.M.A.N. advanced"
24 #define BATADV_DRIVER_DEVICE "batman-adv"
25
26 #ifndef BATADV_SOURCE_VERSION
27 #define BATADV_SOURCE_VERSION "2014.4.0"
28 #endif
29
30 /* B.A.T.M.A.N. parameters */
31
32 #define BATADV_TQ_MAX_VALUE 255
33 #define BATADV_JITTER 20
34
35 /* Time To Live of broadcast messages */
36 #define BATADV_TTL 50
37
38 /* purge originators after time in seconds if no valid packet comes in
39 * -> TODO: check influence on BATADV_TQ_LOCAL_WINDOW_SIZE
40 */
41 #define BATADV_PURGE_TIMEOUT 200000 /* 200 seconds */
42 #define BATADV_TT_LOCAL_TIMEOUT 600000 /* in milliseconds */
43 #define BATADV_TT_CLIENT_ROAM_TIMEOUT 600000 /* in milliseconds */
44 #define BATADV_TT_CLIENT_TEMP_TIMEOUT 600000 /* in milliseconds */
45 #define BATADV_TT_WORK_PERIOD 5000 /* 5 seconds */
46 #define BATADV_ORIG_WORK_PERIOD 1000 /* 1 second */
47 #define BATADV_DAT_ENTRY_TIMEOUT (5*60000) /* 5 mins in milliseconds */
48 /* sliding packet range of received originator messages in sequence numbers
49 * (should be a multiple of our word size)
50 */
51 #define BATADV_TQ_LOCAL_WINDOW_SIZE 64
52 /* milliseconds we have to keep pending tt_req */
53 #define BATADV_TT_REQUEST_TIMEOUT 3000
54
55 #define BATADV_TQ_GLOBAL_WINDOW_SIZE 5
56 #define BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM 1
57 #define BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM 1
58 #define BATADV_TQ_TOTAL_BIDRECT_LIMIT 1
59
60 /* number of OGMs sent with the last tt diff */
61 #define BATADV_TT_OGM_APPEND_MAX 3
62
63 /* Time in which a client can roam at most ROAMING_MAX_COUNT times in
64 * milliseconds
65 */
66 #define BATADV_ROAMING_MAX_TIME 20000
67 #define BATADV_ROAMING_MAX_COUNT 5
68
69 #define BATADV_NO_FLAGS 0
70
71 #define BATADV_NULL_IFINDEX 0 /* dummy ifindex used to avoid iface checks */
72
73 #define BATADV_NO_MARK 0
74
75 /* default interface for multi interface operation. The default interface is
76 * used for communication which originated locally (i.e. is not forwarded)
77 * or where special forwarding is not desired/necessary.
78 */
79 #define BATADV_IF_DEFAULT ((struct batadv_hard_iface *)NULL)
80
81 #define BATADV_NUM_WORDS BITS_TO_LONGS(BATADV_TQ_LOCAL_WINDOW_SIZE)
82
83 #define BATADV_LOG_BUF_LEN 8192 /* has to be a power of 2 */
84
85 /* number of packets to send for broadcasts on different interface types */
86 #define BATADV_NUM_BCASTS_DEFAULT 1
87 #define BATADV_NUM_BCASTS_WIRELESS 3
88 #define BATADV_NUM_BCASTS_MAX 3
89
90 /* msecs after which an ARP_REQUEST is sent in broadcast as fallback */
91 #define ARP_REQ_DELAY 250
92 /* numbers of originator to contact for any PUT/GET DHT operation */
93 #define BATADV_DAT_CANDIDATES_NUM 3
94
95 /**
96 * BATADV_TQ_SIMILARITY_THRESHOLD - TQ points that a secondary metric can differ
97 * at most from the primary one in order to be still considered acceptable
98 */
99 #define BATADV_TQ_SIMILARITY_THRESHOLD 50
100
101 /* how much worse secondary interfaces may be to be considered as bonding
102 * candidates
103 */
104 #define BATADV_BONDING_TQ_THRESHOLD 50
105
106 /* should not be bigger than 512 bytes or change the size of
107 * forw_packet->direct_link_flags
108 */
109 #define BATADV_MAX_AGGREGATION_BYTES 512
110 #define BATADV_MAX_AGGREGATION_MS 100
111
112 #define BATADV_BLA_PERIOD_LENGTH 10000 /* 10 seconds */
113 #define BATADV_BLA_BACKBONE_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 3)
114 #define BATADV_BLA_CLAIM_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 10)
115 #define BATADV_BLA_WAIT_PERIODS 3
116
117 #define BATADV_DUPLIST_SIZE 16
118 #define BATADV_DUPLIST_TIMEOUT 500 /* 500 ms */
119 /* don't reset again within 30 seconds */
120 #define BATADV_RESET_PROTECTION_MS 30000
121 #define BATADV_EXPECTED_SEQNO_RANGE 65536
122
123 #define BATADV_NC_NODE_TIMEOUT 10000 /* Milliseconds */
124
125 enum batadv_mesh_state {
126 BATADV_MESH_INACTIVE,
127 BATADV_MESH_ACTIVE,
128 BATADV_MESH_DEACTIVATING,
129 };
130
131 #define BATADV_BCAST_QUEUE_LEN 256
132 #define BATADV_BATMAN_QUEUE_LEN 256
133
134 enum batadv_uev_action {
135 BATADV_UEV_ADD = 0,
136 BATADV_UEV_DEL,
137 BATADV_UEV_CHANGE,
138 };
139
140 enum batadv_uev_type {
141 BATADV_UEV_GW = 0,
142 };
143
144 #define BATADV_GW_THRESHOLD 50
145
146 /* Number of fragment chains for each orig_node */
147 #define BATADV_FRAG_BUFFER_COUNT 8
148 /* Maximum number of fragments for one packet */
149 #define BATADV_FRAG_MAX_FRAGMENTS 16
150 /* Maxumim size of each fragment */
151 #define BATADV_FRAG_MAX_FRAG_SIZE 1400
152 /* Time to keep fragments while waiting for rest of the fragments */
153 #define BATADV_FRAG_TIMEOUT 10000
154
155 #define BATADV_DAT_CANDIDATE_NOT_FOUND 0
156 #define BATADV_DAT_CANDIDATE_ORIG 1
157
158 /* Debug Messages */
159 #ifdef pr_fmt
160 #undef pr_fmt
161 #endif
162 /* Append 'batman-adv: ' before kernel messages */
163 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
164
165 /* Kernel headers */
166
167 #include <linux/mutex.h> /* mutex */
168 #include <linux/module.h> /* needed by all modules */
169 #include <linux/netdevice.h> /* netdevice */
170 #include <linux/etherdevice.h> /* ethernet address classification */
171 #include <linux/if_ether.h> /* ethernet header */
172 #include <linux/poll.h> /* poll_table */
173 #include <linux/kthread.h> /* kernel threads */
174 #include <linux/pkt_sched.h> /* schedule types */
175 #include <linux/workqueue.h> /* workqueue */
176 #include <linux/percpu.h>
177 #include <linux/slab.h>
178 #include <net/sock.h> /* struct sock */
179 #include <net/addrconf.h> /* ipv6 address stuff */
180 #include <linux/ip.h>
181 #include <net/rtnetlink.h>
182 #include <linux/jiffies.h>
183 #include <linux/seq_file.h>
184 #include <linux/if_vlan.h>
185
186 #include "types.h"
187
188 #define BATADV_PRINT_VID(vid) (vid & BATADV_VLAN_HAS_TAG ? \
189 (int)(vid & VLAN_VID_MASK) : -1)
190
191 extern char batadv_routing_algo[];
192 extern struct list_head batadv_hardif_list;
193
194 extern unsigned char batadv_broadcast_addr[];
195 extern struct workqueue_struct *batadv_event_workqueue;
196
197 int batadv_mesh_init(struct net_device *soft_iface);
198 void batadv_mesh_free(struct net_device *soft_iface);
199 int batadv_is_my_mac(struct batadv_priv *bat_priv, const uint8_t *addr);
200 struct batadv_hard_iface *
201 batadv_seq_print_text_primary_if_get(struct seq_file *seq);
202 int batadv_max_header_len(void);
203 void batadv_skb_set_priority(struct sk_buff *skb, int offset);
204 int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev,
205 struct packet_type *ptype,
206 struct net_device *orig_dev);
207 int
208 batadv_recv_handler_register(uint8_t packet_type,
209 int (*recv_handler)(struct sk_buff *,
210 struct batadv_hard_iface *));
211 void batadv_recv_handler_unregister(uint8_t packet_type);
212 int batadv_algo_register(struct batadv_algo_ops *bat_algo_ops);
213 int batadv_algo_select(struct batadv_priv *bat_priv, char *name);
214 int batadv_algo_seq_print_text(struct seq_file *seq, void *offset);
215 __be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr);
216
217 /**
218 * enum batadv_dbg_level - available log levels
219 * @BATADV_DBG_BATMAN: OGM and TQ computations related messages
220 * @BATADV_DBG_ROUTES: route added / changed / deleted
221 * @BATADV_DBG_TT: translation table messages
222 * @BATADV_DBG_BLA: bridge loop avoidance messages
223 * @BATADV_DBG_DAT: ARP snooping and DAT related messages
224 * @BATADV_DBG_NC: network coding related messages
225 * @BATADV_DBG_ALL: the union of all the above log levels
226 */
227 enum batadv_dbg_level {
228 BATADV_DBG_BATMAN = BIT(0),
229 BATADV_DBG_ROUTES = BIT(1),
230 BATADV_DBG_TT = BIT(2),
231 BATADV_DBG_BLA = BIT(3),
232 BATADV_DBG_DAT = BIT(4),
233 BATADV_DBG_NC = BIT(5),
234 BATADV_DBG_ALL = 63,
235 };
236
237 #ifdef CONFIG_BATMAN_ADV_DEBUG
238 int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...)
239 __printf(2, 3);
240
241 /* possibly ratelimited debug output */
242 #define _batadv_dbg(type, bat_priv, ratelimited, fmt, arg...) \
243 do { \
244 if (atomic_read(&bat_priv->log_level) & type && \
245 (!ratelimited || net_ratelimit())) \
246 batadv_debug_log(bat_priv, fmt, ## arg);\
247 } \
248 while (0)
249 #else /* !CONFIG_BATMAN_ADV_DEBUG */
250 __printf(4, 5)
_batadv_dbg(int type __always_unused,struct batadv_priv * bat_priv __always_unused,int ratelimited __always_unused,const char * fmt __always_unused,...)251 static inline void _batadv_dbg(int type __always_unused,
252 struct batadv_priv *bat_priv __always_unused,
253 int ratelimited __always_unused,
254 const char *fmt __always_unused, ...)
255 {
256 }
257 #endif
258
259 #define batadv_dbg(type, bat_priv, arg...) \
260 _batadv_dbg(type, bat_priv, 0, ## arg)
261 #define batadv_dbg_ratelimited(type, bat_priv, arg...) \
262 _batadv_dbg(type, bat_priv, 1, ## arg)
263
264 #define batadv_info(net_dev, fmt, arg...) \
265 do { \
266 struct net_device *_netdev = (net_dev); \
267 struct batadv_priv *_batpriv = netdev_priv(_netdev); \
268 batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \
269 pr_info("%s: " fmt, _netdev->name, ## arg); \
270 } while (0)
271 #define batadv_err(net_dev, fmt, arg...) \
272 do { \
273 struct net_device *_netdev = (net_dev); \
274 struct batadv_priv *_batpriv = netdev_priv(_netdev); \
275 batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \
276 pr_err("%s: " fmt, _netdev->name, ## arg); \
277 } while (0)
278
279 /* returns 1 if they are the same ethernet addr
280 *
281 * note: can't use ether_addr_equal() as it requires aligned memory
282 */
batadv_compare_eth(const void * data1,const void * data2)283 static inline int batadv_compare_eth(const void *data1, const void *data2)
284 {
285 return ether_addr_equal_unaligned(data1, data2);
286 }
287
288 /**
289 * has_timed_out - compares current time (jiffies) and timestamp + timeout
290 * @timestamp: base value to compare with (in jiffies)
291 * @timeout: added to base value before comparing (in milliseconds)
292 *
293 * Returns true if current time is after timestamp + timeout
294 */
batadv_has_timed_out(unsigned long timestamp,unsigned int timeout)295 static inline bool batadv_has_timed_out(unsigned long timestamp,
296 unsigned int timeout)
297 {
298 return time_is_before_jiffies(timestamp + msecs_to_jiffies(timeout));
299 }
300
301 #define batadv_atomic_dec_not_zero(v) atomic_add_unless((v), -1, 0)
302
303 /* Returns the smallest signed integer in two's complement with the sizeof x */
304 #define batadv_smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u)))
305
306 /* Checks if a sequence number x is a predecessor/successor of y.
307 * they handle overflows/underflows and can correctly check for a
308 * predecessor/successor unless the variable sequence number has grown by
309 * more then 2**(bitwidth(x)-1)-1.
310 * This means that for a uint8_t with the maximum value 255, it would think:
311 * - when adding nothing - it is neither a predecessor nor a successor
312 * - before adding more than 127 to the starting value - it is a predecessor,
313 * - when adding 128 - it is neither a predecessor nor a successor,
314 * - after adding more than 127 to the starting value - it is a successor
315 */
316 #define batadv_seq_before(x, y) ({typeof(x) _d1 = (x); \
317 typeof(y) _d2 = (y); \
318 typeof(x) _dummy = (_d1 - _d2); \
319 (void) (&_d1 == &_d2); \
320 _dummy > batadv_smallest_signed_int(_dummy); })
321 #define batadv_seq_after(x, y) batadv_seq_before(y, x)
322
323 /* Stop preemption on local cpu while incrementing the counter */
batadv_add_counter(struct batadv_priv * bat_priv,size_t idx,size_t count)324 static inline void batadv_add_counter(struct batadv_priv *bat_priv, size_t idx,
325 size_t count)
326 {
327 this_cpu_add(bat_priv->bat_counters[idx], count);
328 }
329
330 #define batadv_inc_counter(b, i) batadv_add_counter(b, i, 1)
331
332 /* Sum and return the cpu-local counters for index 'idx' */
batadv_sum_counter(struct batadv_priv * bat_priv,size_t idx)333 static inline uint64_t batadv_sum_counter(struct batadv_priv *bat_priv,
334 size_t idx)
335 {
336 uint64_t *counters, sum = 0;
337 int cpu;
338
339 for_each_possible_cpu(cpu) {
340 counters = per_cpu_ptr(bat_priv->bat_counters, cpu);
341 sum += counters[idx];
342 }
343
344 return sum;
345 }
346
347 /* Define a macro to reach the control buffer of the skb. The members of the
348 * control buffer are defined in struct batadv_skb_cb in types.h.
349 * The macro is inspired by the similar macro TCP_SKB_CB() in tcp.h.
350 */
351 #define BATADV_SKB_CB(__skb) ((struct batadv_skb_cb *)&((__skb)->cb[0]))
352
353 void batadv_tvlv_container_register(struct batadv_priv *bat_priv,
354 uint8_t type, uint8_t version,
355 void *tvlv_value, uint16_t tvlv_value_len);
356 uint16_t batadv_tvlv_container_ogm_append(struct batadv_priv *bat_priv,
357 unsigned char **packet_buff,
358 int *packet_buff_len,
359 int packet_min_len);
360 void batadv_tvlv_ogm_receive(struct batadv_priv *bat_priv,
361 struct batadv_ogm_packet *batadv_ogm_packet,
362 struct batadv_orig_node *orig_node);
363 void batadv_tvlv_container_unregister(struct batadv_priv *bat_priv,
364 uint8_t type, uint8_t version);
365
366 void batadv_tvlv_handler_register(struct batadv_priv *bat_priv,
367 void (*optr)(struct batadv_priv *bat_priv,
368 struct batadv_orig_node *orig,
369 uint8_t flags,
370 void *tvlv_value,
371 uint16_t tvlv_value_len),
372 int (*uptr)(struct batadv_priv *bat_priv,
373 uint8_t *src, uint8_t *dst,
374 void *tvlv_value,
375 uint16_t tvlv_value_len),
376 uint8_t type, uint8_t version, uint8_t flags);
377 void batadv_tvlv_handler_unregister(struct batadv_priv *bat_priv,
378 uint8_t type, uint8_t version);
379 int batadv_tvlv_containers_process(struct batadv_priv *bat_priv,
380 bool ogm_source,
381 struct batadv_orig_node *orig_node,
382 uint8_t *src, uint8_t *dst,
383 void *tvlv_buff, uint16_t tvlv_buff_len);
384 void batadv_tvlv_unicast_send(struct batadv_priv *bat_priv, uint8_t *src,
385 uint8_t *dst, uint8_t type, uint8_t version,
386 void *tvlv_value, uint16_t tvlv_value_len);
387 unsigned short batadv_get_vid(struct sk_buff *skb, size_t header_len);
388 bool batadv_vlan_ap_isola_get(struct batadv_priv *bat_priv, unsigned short vid);
389
390 #endif /* _NET_BATMAN_ADV_MAIN_H_ */
391