1 /* Copyright (C) 2007-2013 B.A.T.M.A.N. contributors:
3 * Marek Lindner, Simon Wunderlich
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.
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.
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
20 #ifndef _NET_BATMAN_ADV_MAIN_H_
21 #define _NET_BATMAN_ADV_MAIN_H_
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"
28 #ifndef BATADV_SOURCE_VERSION
29 #define BATADV_SOURCE_VERSION "2013.4.0"
32 /* B.A.T.M.A.N. parameters */
34 #define BATADV_TQ_MAX_VALUE 255
35 #define BATADV_JITTER 20
37 /* Time To Live of broadcast messages */
40 /* purge originators after time in seconds if no valid packet comes in
41 * -> TODO: check influence on BATADV_TQ_LOCAL_WINDOW_SIZE
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)
53 #define BATADV_TQ_LOCAL_WINDOW_SIZE 64
54 /* milliseconds we have to keep pending tt_req */
55 #define BATADV_TT_REQUEST_TIMEOUT 3000
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
62 /* number of OGMs sent with the last tt diff */
63 #define BATADV_TT_OGM_APPEND_MAX 3
65 /* Time in which a client can roam at most ROAMING_MAX_COUNT times in
68 #define BATADV_ROAMING_MAX_TIME 20000
69 #define BATADV_ROAMING_MAX_COUNT 5
71 #define BATADV_NO_FLAGS 0
73 #define BATADV_NULL_IFINDEX 0 /* dummy ifindex used to avoid iface checks */
75 #define BATADV_NUM_WORDS BITS_TO_LONGS(BATADV_TQ_LOCAL_WINDOW_SIZE)
77 #define BATADV_LOG_BUF_LEN 8192 /* has to be a power of 2 */
79 /* number of packets to send for broadcasts on different interface types */
80 #define BATADV_NUM_BCASTS_DEFAULT 1
81 #define BATADV_NUM_BCASTS_WIRELESS 3
82 #define BATADV_NUM_BCASTS_MAX 3
84 /* msecs after which an ARP_REQUEST is sent in broadcast as fallback */
85 #define ARP_REQ_DELAY 250
86 /* numbers of originator to contact for any PUT/GET DHT operation */
87 #define BATADV_DAT_CANDIDATES_NUM 3
89 /* how much worse secondary interfaces may be to be considered as bonding
92 #define BATADV_BONDING_TQ_THRESHOLD 50
94 /* should not be bigger than 512 bytes or change the size of
95 * forw_packet->direct_link_flags
97 #define BATADV_MAX_AGGREGATION_BYTES 512
98 #define BATADV_MAX_AGGREGATION_MS 100
100 #define BATADV_BLA_PERIOD_LENGTH 10000 /* 10 seconds */
101 #define BATADV_BLA_BACKBONE_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 3)
102 #define BATADV_BLA_CLAIM_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 10)
103 #define BATADV_BLA_WAIT_PERIODS 3
105 #define BATADV_DUPLIST_SIZE 16
106 #define BATADV_DUPLIST_TIMEOUT 500 /* 500 ms */
107 /* don't reset again within 30 seconds */
108 #define BATADV_RESET_PROTECTION_MS 30000
109 #define BATADV_EXPECTED_SEQNO_RANGE 65536
111 #define BATADV_NC_NODE_TIMEOUT 10000 /* Milliseconds */
113 enum batadv_mesh_state {
114 BATADV_MESH_INACTIVE,
116 BATADV_MESH_DEACTIVATING,
119 #define BATADV_BCAST_QUEUE_LEN 256
120 #define BATADV_BATMAN_QUEUE_LEN 256
122 enum batadv_uev_action {
128 enum batadv_uev_type {
132 #define BATADV_GW_THRESHOLD 50
134 #define BATADV_DAT_CANDIDATE_NOT_FOUND 0
135 #define BATADV_DAT_CANDIDATE_ORIG 1
141 /* Append 'batman-adv: ' before kernel messages */
142 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
146 #include <linux/mutex.h> /* mutex */
147 #include <linux/module.h> /* needed by all modules */
148 #include <linux/netdevice.h> /* netdevice */
149 #include <linux/etherdevice.h> /* ethernet address classification */
150 #include <linux/if_ether.h> /* ethernet header */
151 #include <linux/poll.h> /* poll_table */
152 #include <linux/kthread.h> /* kernel threads */
153 #include <linux/pkt_sched.h> /* schedule types */
154 #include <linux/workqueue.h> /* workqueue */
155 #include <linux/percpu.h>
156 #include <linux/slab.h>
157 #include <net/sock.h> /* struct sock */
158 #include <net/rtnetlink.h>
159 #include <linux/jiffies.h>
160 #include <linux/seq_file.h>
164 * batadv_vlan_flags - flags for the four MSB of any vlan ID field
165 * @BATADV_VLAN_HAS_TAG: whether the field contains a valid vlan tag or not
167 enum batadv_vlan_flags {
168 BATADV_VLAN_HAS_TAG = BIT(15),
171 #define BATADV_PRINT_VID(vid) (vid & BATADV_VLAN_HAS_TAG ? \
172 (int)(vid & VLAN_VID_MASK) : -1)
174 extern char batadv_routing_algo[];
175 extern struct list_head batadv_hardif_list;
177 extern unsigned char batadv_broadcast_addr[];
178 extern struct workqueue_struct *batadv_event_workqueue;
180 int batadv_mesh_init(struct net_device *soft_iface);
181 void batadv_mesh_free(struct net_device *soft_iface);
182 int batadv_is_my_mac(struct batadv_priv *bat_priv, const uint8_t *addr);
183 struct batadv_hard_iface *
184 batadv_seq_print_text_primary_if_get(struct seq_file *seq);
185 void batadv_skb_set_priority(struct sk_buff *skb, int offset);
186 int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev,
187 struct packet_type *ptype,
188 struct net_device *orig_dev);
190 batadv_recv_handler_register(uint8_t packet_type,
191 int (*recv_handler)(struct sk_buff *,
192 struct batadv_hard_iface *));
193 void batadv_recv_handler_unregister(uint8_t packet_type);
194 int batadv_algo_register(struct batadv_algo_ops *bat_algo_ops);
195 int batadv_algo_select(struct batadv_priv *bat_priv, char *name);
196 int batadv_algo_seq_print_text(struct seq_file *seq, void *offset);
197 __be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr);
200 * enum batadv_dbg_level - available log levels
201 * @BATADV_DBG_BATMAN: OGM and TQ computations related messages
202 * @BATADV_DBG_ROUTES: route added / changed / deleted
203 * @BATADV_DBG_TT: translation table messages
204 * @BATADV_DBG_BLA: bridge loop avoidance messages
205 * @BATADV_DBG_DAT: ARP snooping and DAT related messages
206 * @BATADV_DBG_NC: network coding related messages
207 * @BATADV_DBG_ALL: the union of all the above log levels
209 enum batadv_dbg_level {
210 BATADV_DBG_BATMAN = BIT(0),
211 BATADV_DBG_ROUTES = BIT(1),
212 BATADV_DBG_TT = BIT(2),
213 BATADV_DBG_BLA = BIT(3),
214 BATADV_DBG_DAT = BIT(4),
215 BATADV_DBG_NC = BIT(5),
219 #ifdef CONFIG_BATMAN_ADV_DEBUG
220 int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...)
223 #define batadv_dbg(type, bat_priv, fmt, arg...) \
225 if (atomic_read(&bat_priv->log_level) & type) \
226 batadv_debug_log(bat_priv, fmt, ## arg);\
229 #else /* !CONFIG_BATMAN_ADV_DEBUG */
231 static inline void batadv_dbg(int type __always_unused,
232 struct batadv_priv *bat_priv __always_unused,
233 const char *fmt __always_unused, ...)
238 #define batadv_info(net_dev, fmt, arg...) \
240 struct net_device *_netdev = (net_dev); \
241 struct batadv_priv *_batpriv = netdev_priv(_netdev); \
242 batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \
243 pr_info("%s: " fmt, _netdev->name, ## arg); \
245 #define batadv_err(net_dev, fmt, arg...) \
247 struct net_device *_netdev = (net_dev); \
248 struct batadv_priv *_batpriv = netdev_priv(_netdev); \
249 batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \
250 pr_err("%s: " fmt, _netdev->name, ## arg); \
253 /* returns 1 if they are the same ethernet addr
255 * note: can't use ether_addr_equal() as it requires aligned memory
257 static inline int batadv_compare_eth(const void *data1, const void *data2)
259 return (memcmp(data1, data2, ETH_ALEN) == 0 ? 1 : 0);
263 * has_timed_out - compares current time (jiffies) and timestamp + timeout
264 * @timestamp: base value to compare with (in jiffies)
265 * @timeout: added to base value before comparing (in milliseconds)
267 * Returns true if current time is after timestamp + timeout
269 static inline bool batadv_has_timed_out(unsigned long timestamp,
270 unsigned int timeout)
272 return time_is_before_jiffies(timestamp + msecs_to_jiffies(timeout));
275 #define batadv_atomic_dec_not_zero(v) atomic_add_unless((v), -1, 0)
277 /* Returns the smallest signed integer in two's complement with the sizeof x */
278 #define batadv_smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u)))
280 /* Checks if a sequence number x is a predecessor/successor of y.
281 * they handle overflows/underflows and can correctly check for a
282 * predecessor/successor unless the variable sequence number has grown by
283 * more then 2**(bitwidth(x)-1)-1.
284 * This means that for a uint8_t with the maximum value 255, it would think:
285 * - when adding nothing - it is neither a predecessor nor a successor
286 * - before adding more than 127 to the starting value - it is a predecessor,
287 * - when adding 128 - it is neither a predecessor nor a successor,
288 * - after adding more than 127 to the starting value - it is a successor
290 #define batadv_seq_before(x, y) ({typeof(x) _d1 = (x); \
291 typeof(y) _d2 = (y); \
292 typeof(x) _dummy = (_d1 - _d2); \
293 (void) (&_d1 == &_d2); \
294 _dummy > batadv_smallest_signed_int(_dummy); })
295 #define batadv_seq_after(x, y) batadv_seq_before(y, x)
297 /* Stop preemption on local cpu while incrementing the counter */
298 static inline void batadv_add_counter(struct batadv_priv *bat_priv, size_t idx,
301 this_cpu_add(bat_priv->bat_counters[idx], count);
304 #define batadv_inc_counter(b, i) batadv_add_counter(b, i, 1)
306 /* Sum and return the cpu-local counters for index 'idx' */
307 static inline uint64_t batadv_sum_counter(struct batadv_priv *bat_priv,
310 uint64_t *counters, sum = 0;
313 for_each_possible_cpu(cpu) {
314 counters = per_cpu_ptr(bat_priv->bat_counters, cpu);
315 sum += counters[idx];
321 /* Define a macro to reach the control buffer of the skb. The members of the
322 * control buffer are defined in struct batadv_skb_cb in types.h.
323 * The macro is inspired by the similar macro TCP_SKB_CB() in tcp.h.
325 #define BATADV_SKB_CB(__skb) ((struct batadv_skb_cb *)&((__skb)->cb[0]))
327 void batadv_tvlv_container_register(struct batadv_priv *bat_priv,
328 uint8_t type, uint8_t version,
329 void *tvlv_value, uint16_t tvlv_value_len);
330 uint16_t batadv_tvlv_container_ogm_append(struct batadv_priv *bat_priv,
331 unsigned char **packet_buff,
332 int *packet_buff_len,
334 void batadv_tvlv_ogm_receive(struct batadv_priv *bat_priv,
335 struct batadv_ogm_packet *batadv_ogm_packet,
336 struct batadv_orig_node *orig_node);
337 void batadv_tvlv_container_unregister(struct batadv_priv *bat_priv,
338 uint8_t type, uint8_t version);
340 void batadv_tvlv_handler_register(struct batadv_priv *bat_priv,
341 void (*optr)(struct batadv_priv *bat_priv,
342 struct batadv_orig_node *orig,
345 uint16_t tvlv_value_len),
346 int (*uptr)(struct batadv_priv *bat_priv,
347 uint8_t *src, uint8_t *dst,
349 uint16_t tvlv_value_len),
350 uint8_t type, uint8_t version, uint8_t flags);
351 void batadv_tvlv_handler_unregister(struct batadv_priv *bat_priv,
352 uint8_t type, uint8_t version);
353 int batadv_tvlv_containers_process(struct batadv_priv *bat_priv,
355 struct batadv_orig_node *orig_node,
356 uint8_t *src, uint8_t *dst,
357 void *tvlv_buff, uint16_t tvlv_buff_len);
358 void batadv_tvlv_unicast_send(struct batadv_priv *bat_priv, uint8_t *src,
359 uint8_t *dst, uint8_t type, uint8_t version,
360 void *tvlv_value, uint16_t tvlv_value_len);
362 #endif /* _NET_BATMAN_ADV_MAIN_H_ */