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