1 /* Copyright (C) 2007-2013 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 "2013.2.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 600000 /* 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_TT_WORK_PERIOD 5000 /* 5 seconds */
48 #define BATADV_ORIG_WORK_PERIOD 1000 /* 1 second */
49 #define BATADV_DAT_ENTRY_TIMEOUT (5*60000) /* 5 mins in milliseconds */
50 /* sliding packet range of received originator messages in sequence numbers
51 * (should be a multiple of our word size)
52 */
53 #define BATADV_TQ_LOCAL_WINDOW_SIZE 64
54 /* milliseconds we have to keep pending tt_req */
55 #define BATADV_TT_REQUEST_TIMEOUT 3000
56
57 #define BATADV_TQ_GLOBAL_WINDOW_SIZE 5
58 #define BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM 1
59 #define BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM 1
60 #define BATADV_TQ_TOTAL_BIDRECT_LIMIT 1
61
62 /* number of OGMs sent with the last tt diff */
63 #define BATADV_TT_OGM_APPEND_MAX 3
64
65 /* Time in which a client can roam at most ROAMING_MAX_COUNT times in
66 * milliseconds
67 */
68 #define BATADV_ROAMING_MAX_TIME 20000
69 #define BATADV_ROAMING_MAX_COUNT 5
70
71 #define BATADV_NO_FLAGS 0
72
73 #define BATADV_NULL_IFINDEX 0 /* dummy ifindex used to avoid iface checks */
74
75 #define BATADV_NUM_WORDS BITS_TO_LONGS(BATADV_TQ_LOCAL_WINDOW_SIZE)
76
77 #define BATADV_LOG_BUF_LEN 8192 /* has to be a power of 2 */
78
79 /* msecs after which an ARP_REQUEST is sent in broadcast as fallback */
80 #define ARP_REQ_DELAY 250
81 /* numbers of originator to contact for any PUT/GET DHT operation */
82 #define BATADV_DAT_CANDIDATES_NUM 3
83
84 #define BATADV_VIS_INTERVAL 5000 /* 5 seconds */
85
86 /* how much worse secondary interfaces may be to be considered as bonding
87 * candidates
88 */
89 #define BATADV_BONDING_TQ_THRESHOLD 50
90
91 /* should not be bigger than 512 bytes or change the size of
92 * forw_packet->direct_link_flags
93 */
94 #define BATADV_MAX_AGGREGATION_BYTES 512
95 #define BATADV_MAX_AGGREGATION_MS 100
96
97 #define BATADV_BLA_PERIOD_LENGTH 10000 /* 10 seconds */
98 #define BATADV_BLA_BACKBONE_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 3)
99 #define BATADV_BLA_CLAIM_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 10)
100 #define BATADV_BLA_WAIT_PERIODS 3
101
102 #define BATADV_DUPLIST_SIZE 16
103 #define BATADV_DUPLIST_TIMEOUT 500 /* 500 ms */
104 /* don't reset again within 30 seconds */
105 #define BATADV_RESET_PROTECTION_MS 30000
106 #define BATADV_EXPECTED_SEQNO_RANGE 65536
107
108 #define BATADV_NC_NODE_TIMEOUT 10000 /* Milliseconds */
109
110 enum batadv_mesh_state {
111 BATADV_MESH_INACTIVE,
112 BATADV_MESH_ACTIVE,
113 BATADV_MESH_DEACTIVATING,
114 };
115
116 #define BATADV_BCAST_QUEUE_LEN 256
117 #define BATADV_BATMAN_QUEUE_LEN 256
118
119 enum batadv_uev_action {
120 BATADV_UEV_ADD = 0,
121 BATADV_UEV_DEL,
122 BATADV_UEV_CHANGE,
123 };
124
125 enum batadv_uev_type {
126 BATADV_UEV_GW = 0,
127 };
128
129 #define BATADV_GW_THRESHOLD 50
130
131 #define BATADV_DAT_CANDIDATE_NOT_FOUND 0
132 #define BATADV_DAT_CANDIDATE_ORIG 1
133
134 /* Debug Messages */
135 #ifdef pr_fmt
136 #undef pr_fmt
137 #endif
138 /* Append 'batman-adv: ' before kernel messages */
139 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
140
141 /* Kernel headers */
142
143 #include <linux/mutex.h> /* mutex */
144 #include <linux/module.h> /* needed by all modules */
145 #include <linux/netdevice.h> /* netdevice */
146 #include <linux/etherdevice.h> /* ethernet address classification */
147 #include <linux/if_ether.h> /* ethernet header */
148 #include <linux/poll.h> /* poll_table */
149 #include <linux/kthread.h> /* kernel threads */
150 #include <linux/pkt_sched.h> /* schedule types */
151 #include <linux/workqueue.h> /* workqueue */
152 #include <linux/percpu.h>
153 #include <linux/slab.h>
154 #include <net/sock.h> /* struct sock */
155 #include <net/rtnetlink.h>
156 #include <linux/jiffies.h>
157 #include <linux/seq_file.h>
158 #include "types.h"
159
160 extern char batadv_routing_algo[];
161 extern struct list_head batadv_hardif_list;
162
163 extern unsigned char batadv_broadcast_addr[];
164 extern struct workqueue_struct *batadv_event_workqueue;
165
166 int batadv_mesh_init(struct net_device *soft_iface);
167 void batadv_mesh_free(struct net_device *soft_iface);
168 int batadv_is_my_mac(struct batadv_priv *bat_priv, const uint8_t *addr);
169 struct batadv_hard_iface *
170 batadv_seq_print_text_primary_if_get(struct seq_file *seq);
171 int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev,
172 struct packet_type *ptype,
173 struct net_device *orig_dev);
174 int
175 batadv_recv_handler_register(uint8_t packet_type,
176 int (*recv_handler)(struct sk_buff *,
177 struct batadv_hard_iface *));
178 void batadv_recv_handler_unregister(uint8_t packet_type);
179 int batadv_algo_register(struct batadv_algo_ops *bat_algo_ops);
180 int batadv_algo_select(struct batadv_priv *bat_priv, char *name);
181 int batadv_algo_seq_print_text(struct seq_file *seq, void *offset);
182 __be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr);
183
184 /**
185 * enum batadv_dbg_level - available log levels
186 * @BATADV_DBG_BATMAN: OGM and TQ computations related messages
187 * @BATADV_DBG_ROUTES: route added / changed / deleted
188 * @BATADV_DBG_TT: translation table messages
189 * @BATADV_DBG_BLA: bridge loop avoidance messages
190 * @BATADV_DBG_DAT: ARP snooping and DAT related messages
191 * @BATADV_DBG_NC: network coding related messages
192 * @BATADV_DBG_ALL: the union of all the above log levels
193 */
194 enum batadv_dbg_level {
195 BATADV_DBG_BATMAN = BIT(0),
196 BATADV_DBG_ROUTES = BIT(1),
197 BATADV_DBG_TT = BIT(2),
198 BATADV_DBG_BLA = BIT(3),
199 BATADV_DBG_DAT = BIT(4),
200 BATADV_DBG_NC = BIT(5),
201 BATADV_DBG_ALL = 63,
202 };
203
204 #ifdef CONFIG_BATMAN_ADV_DEBUG
205 int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...)
206 __printf(2, 3);
207
208 #define batadv_dbg(type, bat_priv, fmt, arg...) \
209 do { \
210 if (atomic_read(&bat_priv->log_level) & type) \
211 batadv_debug_log(bat_priv, fmt, ## arg);\
212 } \
213 while (0)
214 #else /* !CONFIG_BATMAN_ADV_DEBUG */
215 __printf(3, 4)
batadv_dbg(int type __always_unused,struct batadv_priv * bat_priv __always_unused,const char * fmt __always_unused,...)216 static inline void batadv_dbg(int type __always_unused,
217 struct batadv_priv *bat_priv __always_unused,
218 const char *fmt __always_unused, ...)
219 {
220 }
221 #endif
222
223 #define batadv_info(net_dev, fmt, arg...) \
224 do { \
225 struct net_device *_netdev = (net_dev); \
226 struct batadv_priv *_batpriv = netdev_priv(_netdev); \
227 batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \
228 pr_info("%s: " fmt, _netdev->name, ## arg); \
229 } while (0)
230 #define batadv_err(net_dev, fmt, arg...) \
231 do { \
232 struct net_device *_netdev = (net_dev); \
233 struct batadv_priv *_batpriv = netdev_priv(_netdev); \
234 batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \
235 pr_err("%s: " fmt, _netdev->name, ## arg); \
236 } while (0)
237
238 /* returns 1 if they are the same ethernet addr
239 *
240 * note: can't use compare_ether_addr() as it requires aligned memory
241 */
batadv_compare_eth(const void * data1,const void * data2)242 static inline int batadv_compare_eth(const void *data1, const void *data2)
243 {
244 return (memcmp(data1, data2, ETH_ALEN) == 0 ? 1 : 0);
245 }
246
247 /**
248 * has_timed_out - compares current time (jiffies) and timestamp + timeout
249 * @timestamp: base value to compare with (in jiffies)
250 * @timeout: added to base value before comparing (in milliseconds)
251 *
252 * Returns true if current time is after timestamp + timeout
253 */
batadv_has_timed_out(unsigned long timestamp,unsigned int timeout)254 static inline bool batadv_has_timed_out(unsigned long timestamp,
255 unsigned int timeout)
256 {
257 return time_is_before_jiffies(timestamp + msecs_to_jiffies(timeout));
258 }
259
260 #define batadv_atomic_dec_not_zero(v) atomic_add_unless((v), -1, 0)
261
262 /* Returns the smallest signed integer in two's complement with the sizeof x */
263 #define batadv_smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u)))
264
265 /* Checks if a sequence number x is a predecessor/successor of y.
266 * they handle overflows/underflows and can correctly check for a
267 * predecessor/successor unless the variable sequence number has grown by
268 * more then 2**(bitwidth(x)-1)-1.
269 * This means that for a uint8_t with the maximum value 255, it would think:
270 * - when adding nothing - it is neither a predecessor nor a successor
271 * - before adding more than 127 to the starting value - it is a predecessor,
272 * - when adding 128 - it is neither a predecessor nor a successor,
273 * - after adding more than 127 to the starting value - it is a successor
274 */
275 #define batadv_seq_before(x, y) ({typeof(x) _d1 = (x); \
276 typeof(y) _d2 = (y); \
277 typeof(x) _dummy = (_d1 - _d2); \
278 (void) (&_d1 == &_d2); \
279 _dummy > batadv_smallest_signed_int(_dummy); })
280 #define batadv_seq_after(x, y) batadv_seq_before(y, x)
281
282 /* Stop preemption on local cpu while incrementing the counter */
batadv_add_counter(struct batadv_priv * bat_priv,size_t idx,size_t count)283 static inline void batadv_add_counter(struct batadv_priv *bat_priv, size_t idx,
284 size_t count)
285 {
286 this_cpu_add(bat_priv->bat_counters[idx], count);
287 }
288
289 #define batadv_inc_counter(b, i) batadv_add_counter(b, i, 1)
290
291 /* Sum and return the cpu-local counters for index 'idx' */
batadv_sum_counter(struct batadv_priv * bat_priv,size_t idx)292 static inline uint64_t batadv_sum_counter(struct batadv_priv *bat_priv,
293 size_t idx)
294 {
295 uint64_t *counters, sum = 0;
296 int cpu;
297
298 for_each_possible_cpu(cpu) {
299 counters = per_cpu_ptr(bat_priv->bat_counters, cpu);
300 sum += counters[idx];
301 }
302
303 return sum;
304 }
305
306 /* Define a macro to reach the control buffer of the skb. The members of the
307 * control buffer are defined in struct batadv_skb_cb in types.h.
308 * The macro is inspired by the similar macro TCP_SKB_CB() in tcp.h.
309 */
310 #define BATADV_SKB_CB(__skb) ((struct batadv_skb_cb *)&((__skb)->cb[0]))
311
312 #endif /* _NET_BATMAN_ADV_MAIN_H_ */
313