Commit | Line | Data |
---|---|---|
9cfc7bd6 | 1 | /* Copyright (C) 2007-2012 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 | |
15 | * along with this program; if not, write to the Free Software | |
16 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA | |
17 | * 02110-1301, USA | |
c6c8fea2 SE |
18 | */ |
19 | ||
20 | #ifndef _NET_BATMAN_ADV_MAIN_H_ | |
21 | #define _NET_BATMAN_ADV_MAIN_H_ | |
22 | ||
42d0b044 SE |
23 | #define BATADV_DRIVER_AUTHOR "Marek Lindner <lindner_marek@yahoo.de>, " \ |
24 | "Simon Wunderlich <siwu@hrz.tu-chemnitz.de>" | |
25 | #define BATADV_DRIVER_DESC "B.A.T.M.A.N. advanced" | |
26 | #define BATADV_DRIVER_DEVICE "batman-adv" | |
c6c8fea2 | 27 | |
42d0b044 | 28 | #ifndef BATADV_SOURCE_VERSION |
fa4f0afc | 29 | #define BATADV_SOURCE_VERSION "2012.4.0" |
44c4349a | 30 | #endif |
c6c8fea2 SE |
31 | |
32 | /* B.A.T.M.A.N. parameters */ | |
33 | ||
42d0b044 SE |
34 | #define BATADV_TQ_MAX_VALUE 255 |
35 | #define BATADV_JITTER 20 | |
c6c8fea2 | 36 | |
9cfc7bd6 | 37 | /* Time To Live of broadcast messages */ |
42d0b044 | 38 | #define BATADV_TTL 50 |
6e215fd8 SE |
39 | |
40 | /* purge originators after time in seconds if no valid packet comes in | |
42d0b044 | 41 | * -> TODO: check influence on BATADV_TQ_LOCAL_WINDOW_SIZE |
9cfc7bd6 | 42 | */ |
42d0b044 | 43 | #define BATADV_PURGE_TIMEOUT 200000 /* 200 seconds */ |
a51fb9b2 AQ |
44 | #define BATADV_TT_LOCAL_TIMEOUT 3600000 /* in milliseconds */ |
45 | #define BATADV_TT_CLIENT_ROAM_TIMEOUT 600000 /* in milliseconds */ | |
30cfd02b | 46 | #define BATADV_TT_CLIENT_TEMP_TIMEOUT 600000 /* in milliseconds */ |
015758d0 | 47 | /* sliding packet range of received originator messages in sequence numbers |
9cfc7bd6 SE |
48 | * (should be a multiple of our word size) |
49 | */ | |
42d0b044 | 50 | #define BATADV_TQ_LOCAL_WINDOW_SIZE 64 |
a51fb9b2 | 51 | /* milliseconds we have to keep pending tt_req */ |
42d0b044 | 52 | #define BATADV_TT_REQUEST_TIMEOUT 3000 |
a73105b8 | 53 | |
42d0b044 SE |
54 | #define BATADV_TQ_GLOBAL_WINDOW_SIZE 5 |
55 | #define BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM 1 | |
56 | #define BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM 1 | |
57 | #define BATADV_TQ_TOTAL_BIDRECT_LIMIT 1 | |
c6c8fea2 | 58 | |
42d0b044 SE |
59 | /* number of OGMs sent with the last tt diff */ |
60 | #define BATADV_TT_OGM_APPEND_MAX 3 | |
a73105b8 | 61 | |
9cfc7bd6 | 62 | /* Time in which a client can roam at most ROAMING_MAX_COUNT times in |
a51fb9b2 | 63 | * milliseconds |
9cfc7bd6 | 64 | */ |
42d0b044 SE |
65 | #define BATADV_ROAMING_MAX_TIME 20000 |
66 | #define BATADV_ROAMING_MAX_COUNT 5 | |
cc47f66e | 67 | |
42d0b044 | 68 | #define BATADV_NO_FLAGS 0 |
ecbd5321 | 69 | |
42d0b044 | 70 | #define BATADV_NULL_IFINDEX 0 /* dummy ifindex used to avoid iface checks */ |
bc279080 | 71 | |
42d0b044 | 72 | #define BATADV_NUM_WORDS BITS_TO_LONGS(BATADV_TQ_LOCAL_WINDOW_SIZE) |
c6c8fea2 | 73 | |
42d0b044 | 74 | #define BATADV_LOG_BUF_LEN 8192 /* has to be a power of 2 */ |
c6c8fea2 | 75 | |
42d0b044 | 76 | #define BATADV_VIS_INTERVAL 5000 /* 5 seconds */ |
c6c8fea2 | 77 | |
6e215fd8 | 78 | /* how much worse secondary interfaces may be to be considered as bonding |
9cfc7bd6 SE |
79 | * candidates |
80 | */ | |
42d0b044 | 81 | #define BATADV_BONDING_TQ_THRESHOLD 50 |
c6c8fea2 | 82 | |
6e215fd8 | 83 | /* should not be bigger than 512 bytes or change the size of |
9cfc7bd6 SE |
84 | * forw_packet->direct_link_flags |
85 | */ | |
42d0b044 SE |
86 | #define BATADV_MAX_AGGREGATION_BYTES 512 |
87 | #define BATADV_MAX_AGGREGATION_MS 100 | |
c6c8fea2 | 88 | |
42d0b044 SE |
89 | #define BATADV_BLA_PERIOD_LENGTH 10000 /* 10 seconds */ |
90 | #define BATADV_BLA_BACKBONE_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 3) | |
91 | #define BATADV_BLA_CLAIM_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 10) | |
fe2da6ff | 92 | |
42d0b044 SE |
93 | #define BATADV_DUPLIST_SIZE 16 |
94 | #define BATADV_DUPLIST_TIMEOUT 500 /* 500 ms */ | |
6e215fd8 | 95 | /* don't reset again within 30 seconds */ |
42d0b044 SE |
96 | #define BATADV_RESET_PROTECTION_MS 30000 |
97 | #define BATADV_EXPECTED_SEQNO_RANGE 65536 | |
c6c8fea2 | 98 | |
39c75a51 SE |
99 | enum batadv_mesh_state { |
100 | BATADV_MESH_INACTIVE, | |
101 | BATADV_MESH_ACTIVE, | |
102 | BATADV_MESH_DEACTIVATING, | |
e8958dbf | 103 | }; |
c6c8fea2 | 104 | |
42d0b044 SE |
105 | #define BATADV_BCAST_QUEUE_LEN 256 |
106 | #define BATADV_BATMAN_QUEUE_LEN 256 | |
c6c8fea2 | 107 | |
39c75a51 SE |
108 | enum batadv_uev_action { |
109 | BATADV_UEV_ADD = 0, | |
110 | BATADV_UEV_DEL, | |
111 | BATADV_UEV_CHANGE, | |
c6bda689 AQ |
112 | }; |
113 | ||
39c75a51 SE |
114 | enum batadv_uev_type { |
115 | BATADV_UEV_GW = 0, | |
c6bda689 AQ |
116 | }; |
117 | ||
42d0b044 | 118 | #define BATADV_GW_THRESHOLD 50 |
43676ab5 | 119 | |
21a1236b | 120 | /* Debug Messages */ |
c6c8fea2 SE |
121 | #ifdef pr_fmt |
122 | #undef pr_fmt | |
123 | #endif | |
6e215fd8 SE |
124 | /* Append 'batman-adv: ' before kernel messages */ |
125 | #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt | |
c6c8fea2 | 126 | |
21a1236b | 127 | /* Kernel headers */ |
c6c8fea2 SE |
128 | |
129 | #include <linux/mutex.h> /* mutex */ | |
130 | #include <linux/module.h> /* needed by all modules */ | |
131 | #include <linux/netdevice.h> /* netdevice */ | |
015758d0 | 132 | #include <linux/etherdevice.h> /* ethernet address classification */ |
c6c8fea2 SE |
133 | #include <linux/if_ether.h> /* ethernet header */ |
134 | #include <linux/poll.h> /* poll_table */ | |
135 | #include <linux/kthread.h> /* kernel threads */ | |
136 | #include <linux/pkt_sched.h> /* schedule types */ | |
137 | #include <linux/workqueue.h> /* workqueue */ | |
f8214865 | 138 | #include <linux/percpu.h> |
c6c8fea2 SE |
139 | #include <linux/slab.h> |
140 | #include <net/sock.h> /* struct sock */ | |
141 | #include <linux/jiffies.h> | |
142 | #include <linux/seq_file.h> | |
143 | #include "types.h" | |
144 | ||
3193e8fd SE |
145 | extern char batadv_routing_algo[]; |
146 | extern struct list_head batadv_hardif_list; | |
147 | ||
148 | extern unsigned char batadv_broadcast_addr[]; | |
149 | extern struct workqueue_struct *batadv_event_workqueue; | |
150 | ||
151 | int batadv_mesh_init(struct net_device *soft_iface); | |
152 | void batadv_mesh_free(struct net_device *soft_iface); | |
3193e8fd | 153 | int batadv_is_my_mac(const uint8_t *addr); |
30da63a6 ML |
154 | struct batadv_hard_iface * |
155 | batadv_seq_print_text_primary_if_get(struct seq_file *seq); | |
3193e8fd SE |
156 | int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev, |
157 | struct packet_type *ptype, | |
158 | struct net_device *orig_dev); | |
56303d34 SE |
159 | int |
160 | batadv_recv_handler_register(uint8_t packet_type, | |
161 | int (*recv_handler)(struct sk_buff *, | |
162 | struct batadv_hard_iface *)); | |
3193e8fd | 163 | void batadv_recv_handler_unregister(uint8_t packet_type); |
56303d34 SE |
164 | int batadv_algo_register(struct batadv_algo_ops *bat_algo_ops); |
165 | int batadv_algo_select(struct batadv_priv *bat_priv, char *name); | |
3193e8fd | 166 | int batadv_algo_seq_print_text(struct seq_file *seq, void *offset); |
c6c8fea2 | 167 | |
0aca86cd AQ |
168 | /** |
169 | * enum batadv_dbg_level - available log levels | |
170 | * @BATADV_DBG_BATMAN: OGM and TQ computations related messages | |
171 | * @BATADV_DBG_ROUTES: route added / changed / deleted | |
172 | * @BATADV_DBG_TT: translation table messages | |
173 | * @BATADV_DBG_BLA: bridge loop avoidance messages | |
174 | * @BATADV_DBG_ALL: the union of all the above log levels | |
175 | */ | |
8de47de5 SE |
176 | enum batadv_dbg_level { |
177 | BATADV_DBG_BATMAN = BIT(0), | |
0aca86cd AQ |
178 | BATADV_DBG_ROUTES = BIT(1), |
179 | BATADV_DBG_TT = BIT(2), | |
180 | BATADV_DBG_BLA = BIT(3), | |
8de47de5 SE |
181 | BATADV_DBG_ALL = 15, |
182 | }; | |
183 | ||
c6c8fea2 | 184 | #ifdef CONFIG_BATMAN_ADV_DEBUG |
56303d34 | 185 | int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...) |
40a072d7 | 186 | __printf(2, 3); |
c6c8fea2 | 187 | |
1eda58bf | 188 | #define batadv_dbg(type, bat_priv, fmt, arg...) \ |
c6c8fea2 SE |
189 | do { \ |
190 | if (atomic_read(&bat_priv->log_level) & type) \ | |
40a072d7 | 191 | batadv_debug_log(bat_priv, fmt, ## arg);\ |
c6c8fea2 SE |
192 | } \ |
193 | while (0) | |
194 | #else /* !CONFIG_BATMAN_ADV_DEBUG */ | |
d3a547be | 195 | __printf(3, 4) |
1eda58bf | 196 | static inline void batadv_dbg(int type __always_unused, |
56303d34 | 197 | struct batadv_priv *bat_priv __always_unused, |
1eda58bf | 198 | const char *fmt __always_unused, ...) |
c6c8fea2 SE |
199 | { |
200 | } | |
201 | #endif | |
202 | ||
3e34819e | 203 | #define batadv_info(net_dev, fmt, arg...) \ |
c6c8fea2 SE |
204 | do { \ |
205 | struct net_device *_netdev = (net_dev); \ | |
56303d34 | 206 | struct batadv_priv *_batpriv = netdev_priv(_netdev); \ |
39c75a51 | 207 | batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \ |
c6c8fea2 SE |
208 | pr_info("%s: " fmt, _netdev->name, ## arg); \ |
209 | } while (0) | |
3e34819e | 210 | #define batadv_err(net_dev, fmt, arg...) \ |
c6c8fea2 SE |
211 | do { \ |
212 | struct net_device *_netdev = (net_dev); \ | |
56303d34 | 213 | struct batadv_priv *_batpriv = netdev_priv(_netdev); \ |
39c75a51 | 214 | batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \ |
c6c8fea2 SE |
215 | pr_err("%s: " fmt, _netdev->name, ## arg); \ |
216 | } while (0) | |
217 | ||
9cfc7bd6 | 218 | /* returns 1 if they are the same ethernet addr |
39901e71 ML |
219 | * |
220 | * note: can't use compare_ether_addr() as it requires aligned memory | |
221 | */ | |
1eda58bf | 222 | static inline int batadv_compare_eth(const void *data1, const void *data2) |
39901e71 ML |
223 | { |
224 | return (memcmp(data1, data2, ETH_ALEN) == 0 ? 1 : 0); | |
225 | } | |
226 | ||
2c53040f BH |
227 | /** |
228 | * has_timed_out - compares current time (jiffies) and timestamp + timeout | |
a04ccd59 MH |
229 | * @timestamp: base value to compare with (in jiffies) |
230 | * @timeout: added to base value before comparing (in milliseconds) | |
231 | * | |
232 | * Returns true if current time is after timestamp + timeout | |
233 | */ | |
1eda58bf SE |
234 | static inline bool batadv_has_timed_out(unsigned long timestamp, |
235 | unsigned int timeout) | |
a04ccd59 MH |
236 | { |
237 | return time_is_before_jiffies(timestamp + msecs_to_jiffies(timeout)); | |
238 | } | |
747e4221 | 239 | |
3e34819e | 240 | #define batadv_atomic_dec_not_zero(v) atomic_add_unless((v), -1, 0) |
5f657ec0 | 241 | |
f5d33d37 | 242 | /* Returns the smallest signed integer in two's complement with the sizeof x */ |
3e34819e | 243 | #define batadv_smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u))) |
f5d33d37 AQ |
244 | |
245 | /* Checks if a sequence number x is a predecessor/successor of y. | |
246 | * they handle overflows/underflows and can correctly check for a | |
247 | * predecessor/successor unless the variable sequence number has grown by | |
248 | * more then 2**(bitwidth(x)-1)-1. | |
249 | * This means that for a uint8_t with the maximum value 255, it would think: | |
250 | * - when adding nothing - it is neither a predecessor nor a successor | |
251 | * - before adding more than 127 to the starting value - it is a predecessor, | |
252 | * - when adding 128 - it is neither a predecessor nor a successor, | |
9cfc7bd6 SE |
253 | * - after adding more than 127 to the starting value - it is a successor |
254 | */ | |
3e34819e SE |
255 | #define batadv_seq_before(x, y) ({typeof(x) _d1 = (x); \ |
256 | typeof(y) _d2 = (y); \ | |
257 | typeof(x) _dummy = (_d1 - _d2); \ | |
258 | (void) (&_d1 == &_d2); \ | |
259 | _dummy > batadv_smallest_signed_int(_dummy); }) | |
260 | #define batadv_seq_after(x, y) batadv_seq_before(y, x) | |
f5d33d37 | 261 | |
f8214865 | 262 | /* Stop preemption on local cpu while incrementing the counter */ |
56303d34 | 263 | static inline void batadv_add_counter(struct batadv_priv *bat_priv, size_t idx, |
f8214865 MH |
264 | size_t count) |
265 | { | |
266 | int cpu = get_cpu(); | |
267 | per_cpu_ptr(bat_priv->bat_counters, cpu)[idx] += count; | |
268 | put_cpu(); | |
269 | } | |
270 | ||
271 | #define batadv_inc_counter(b, i) batadv_add_counter(b, i, 1) | |
272 | ||
273 | /* Sum and return the cpu-local counters for index 'idx' */ | |
56303d34 SE |
274 | static inline uint64_t batadv_sum_counter(struct batadv_priv *bat_priv, |
275 | size_t idx) | |
f8214865 | 276 | { |
0c5e45b6 | 277 | uint64_t *counters, sum = 0; |
f8214865 | 278 | int cpu; |
f8214865 MH |
279 | |
280 | for_each_possible_cpu(cpu) { | |
281 | counters = per_cpu_ptr(bat_priv->bat_counters, cpu); | |
282 | sum += counters[idx]; | |
283 | } | |
284 | ||
285 | return sum; | |
286 | } | |
287 | ||
c6c8fea2 | 288 | #endif /* _NET_BATMAN_ADV_MAIN_H_ */ |