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