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