blob: ced08b936a9690a6f7d01af7f7eb8a31f3e1f29d [file] [log] [blame]
Antonio Quartulli0b873932013-01-04 03:05:31 +01001/* Copyright (C) 2007-2013 B.A.T.M.A.N. contributors:
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +00002 *
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
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000018 */
19
20#ifndef _NET_BATMAN_ADV_MAIN_H_
21#define _NET_BATMAN_ADV_MAIN_H_
22
Sven Eckelmann42d0b042012-06-03 22:19:17 +020023#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"
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000027
Sven Eckelmann42d0b042012-06-03 22:19:17 +020028#ifndef BATADV_SOURCE_VERSION
Antonio Quartulli5ac2a172013-01-03 12:22:10 +010029#define BATADV_SOURCE_VERSION "2013.1.0"
Sven Eckelmann44c43492011-07-05 10:42:51 +020030#endif
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000031
32/* B.A.T.M.A.N. parameters */
33
Sven Eckelmann42d0b042012-06-03 22:19:17 +020034#define BATADV_TQ_MAX_VALUE 255
35#define BATADV_JITTER 20
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000036
Sven Eckelmann9cfc7bd2012-05-12 02:09:43 +020037/* Time To Live of broadcast messages */
Sven Eckelmann42d0b042012-06-03 22:19:17 +020038#define BATADV_TTL 50
Sven Eckelmann6e215fd2011-05-08 12:45:45 +020039
40/* purge originators after time in seconds if no valid packet comes in
Sven Eckelmann42d0b042012-06-03 22:19:17 +020041 * -> TODO: check influence on BATADV_TQ_LOCAL_WINDOW_SIZE
Sven Eckelmann9cfc7bd2012-05-12 02:09:43 +020042 */
Sven Eckelmann42d0b042012-06-03 22:19:17 +020043#define BATADV_PURGE_TIMEOUT 200000 /* 200 seconds */
Antonio Quartulli7cf4d522012-11-08 22:16:15 +010044#define BATADV_TT_LOCAL_TIMEOUT 600000 /* in milliseconds */
Antonio Quartullia51fb9b2012-07-01 19:07:31 +020045#define BATADV_TT_CLIENT_ROAM_TIMEOUT 600000 /* in milliseconds */
Antonio Quartulli30cfd022012-07-05 23:38:29 +020046#define BATADV_TT_CLIENT_TEMP_TIMEOUT 600000 /* in milliseconds */
Antonio Quartulli72414442012-12-25 13:14:37 +010047#define BATADV_TT_WORK_PERIOD 5000 /* 5 seconds */
48#define BATADV_ORIG_WORK_PERIOD 1000 /* 1 second */
Antonio Quartulli2f1dfbe2012-06-30 20:01:19 +020049#define BATADV_DAT_ENTRY_TIMEOUT (5*60000) /* 5 mins in milliseconds */
Antonio Quartulli015758d2011-07-09 17:52:13 +020050/* sliding packet range of received originator messages in sequence numbers
Sven Eckelmann9cfc7bd2012-05-12 02:09:43 +020051 * (should be a multiple of our word size)
52 */
Sven Eckelmann42d0b042012-06-03 22:19:17 +020053#define BATADV_TQ_LOCAL_WINDOW_SIZE 64
Antonio Quartullia51fb9b2012-07-01 19:07:31 +020054/* milliseconds we have to keep pending tt_req */
Sven Eckelmann42d0b042012-06-03 22:19:17 +020055#define BATADV_TT_REQUEST_TIMEOUT 3000
Antonio Quartullia73105b2011-04-27 14:27:44 +020056
Sven Eckelmann42d0b042012-06-03 22:19:17 +020057#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
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000061
Sven Eckelmann42d0b042012-06-03 22:19:17 +020062/* number of OGMs sent with the last tt diff */
63#define BATADV_TT_OGM_APPEND_MAX 3
Antonio Quartullia73105b2011-04-27 14:27:44 +020064
Sven Eckelmann9cfc7bd2012-05-12 02:09:43 +020065/* Time in which a client can roam at most ROAMING_MAX_COUNT times in
Antonio Quartullia51fb9b2012-07-01 19:07:31 +020066 * milliseconds
Sven Eckelmann9cfc7bd2012-05-12 02:09:43 +020067 */
Sven Eckelmann42d0b042012-06-03 22:19:17 +020068#define BATADV_ROAMING_MAX_TIME 20000
69#define BATADV_ROAMING_MAX_COUNT 5
Antonio Quartullicc47f662011-04-27 14:27:57 +020070
Sven Eckelmann42d0b042012-06-03 22:19:17 +020071#define BATADV_NO_FLAGS 0
Marek Lindnerecbd5322011-06-09 17:13:09 +020072
Sven Eckelmann42d0b042012-06-03 22:19:17 +020073#define BATADV_NULL_IFINDEX 0 /* dummy ifindex used to avoid iface checks */
Antonio Quartullibc279082011-07-07 15:35:35 +020074
Sven Eckelmann42d0b042012-06-03 22:19:17 +020075#define BATADV_NUM_WORDS BITS_TO_LONGS(BATADV_TQ_LOCAL_WINDOW_SIZE)
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000076
Sven Eckelmann42d0b042012-06-03 22:19:17 +020077#define BATADV_LOG_BUF_LEN 8192 /* has to be a power of 2 */
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000078
Antonio Quartullic384ea32011-06-26 03:37:18 +020079/* msecs after which an ARP_REQUEST is sent in broadcast as fallback */
80#define ARP_REQ_DELAY 250
Antonio Quartulli785ea112011-11-23 11:35:44 +010081/* numbers of originator to contact for any PUT/GET DHT operation */
82#define BATADV_DAT_CANDIDATES_NUM 3
83
Sven Eckelmann42d0b042012-06-03 22:19:17 +020084#define BATADV_VIS_INTERVAL 5000 /* 5 seconds */
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000085
Sven Eckelmann6e215fd2011-05-08 12:45:45 +020086/* how much worse secondary interfaces may be to be considered as bonding
Sven Eckelmann9cfc7bd2012-05-12 02:09:43 +020087 * candidates
88 */
Sven Eckelmann42d0b042012-06-03 22:19:17 +020089#define BATADV_BONDING_TQ_THRESHOLD 50
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000090
Sven Eckelmann6e215fd2011-05-08 12:45:45 +020091/* should not be bigger than 512 bytes or change the size of
Sven Eckelmann9cfc7bd2012-05-12 02:09:43 +020092 * forw_packet->direct_link_flags
93 */
Sven Eckelmann42d0b042012-06-03 22:19:17 +020094#define BATADV_MAX_AGGREGATION_BYTES 512
95#define BATADV_MAX_AGGREGATION_MS 100
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +000096
Sven Eckelmann42d0b042012-06-03 22:19:17 +020097#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)
Simon Wunderlich28709872012-09-13 18:18:46 +0200100#define BATADV_BLA_WAIT_PERIODS 3
Simon Wunderlichfe2da6f2012-01-22 20:00:24 +0100101
Sven Eckelmann42d0b042012-06-03 22:19:17 +0200102#define BATADV_DUPLIST_SIZE 16
103#define BATADV_DUPLIST_TIMEOUT 500 /* 500 ms */
Sven Eckelmann6e215fd2011-05-08 12:45:45 +0200104/* don't reset again within 30 seconds */
Sven Eckelmann42d0b042012-06-03 22:19:17 +0200105#define BATADV_RESET_PROTECTION_MS 30000
106#define BATADV_EXPECTED_SEQNO_RANGE 65536
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000107
Sven Eckelmann39c75a52012-06-03 22:19:22 +0200108enum batadv_mesh_state {
109 BATADV_MESH_INACTIVE,
110 BATADV_MESH_ACTIVE,
111 BATADV_MESH_DEACTIVATING,
Sven Eckelmanne8958db2011-06-04 11:26:00 +0200112};
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000113
Sven Eckelmann42d0b042012-06-03 22:19:17 +0200114#define BATADV_BCAST_QUEUE_LEN 256
115#define BATADV_BATMAN_QUEUE_LEN 256
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000116
Sven Eckelmann39c75a52012-06-03 22:19:22 +0200117enum batadv_uev_action {
118 BATADV_UEV_ADD = 0,
119 BATADV_UEV_DEL,
120 BATADV_UEV_CHANGE,
Antonio Quartullic6bda682011-04-26 18:26:01 +0200121};
122
Sven Eckelmann39c75a52012-06-03 22:19:22 +0200123enum batadv_uev_type {
124 BATADV_UEV_GW = 0,
Antonio Quartullic6bda682011-04-26 18:26:01 +0200125};
126
Sven Eckelmann42d0b042012-06-03 22:19:17 +0200127#define BATADV_GW_THRESHOLD 50
Antonio Quartulli43676ab2011-04-26 21:31:45 +0200128
Antonio Quartulli785ea112011-11-23 11:35:44 +0100129#define BATADV_DAT_CANDIDATE_NOT_FOUND 0
130#define BATADV_DAT_CANDIDATE_ORIG 1
131
Sven Eckelmann21a12362012-03-07 09:07:46 +0100132/* Debug Messages */
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000133#ifdef pr_fmt
134#undef pr_fmt
135#endif
Sven Eckelmann6e215fd2011-05-08 12:45:45 +0200136/* Append 'batman-adv: ' before kernel messages */
137#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000138
Sven Eckelmann21a12362012-03-07 09:07:46 +0100139/* Kernel headers */
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000140
141#include <linux/mutex.h> /* mutex */
142#include <linux/module.h> /* needed by all modules */
143#include <linux/netdevice.h> /* netdevice */
Antonio Quartulli015758d2011-07-09 17:52:13 +0200144#include <linux/etherdevice.h> /* ethernet address classification */
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000145#include <linux/if_ether.h> /* ethernet header */
146#include <linux/poll.h> /* poll_table */
147#include <linux/kthread.h> /* kernel threads */
148#include <linux/pkt_sched.h> /* schedule types */
149#include <linux/workqueue.h> /* workqueue */
Martin Hundebøllf8214862012-04-20 17:02:45 +0200150#include <linux/percpu.h>
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000151#include <linux/slab.h>
152#include <net/sock.h> /* struct sock */
153#include <linux/jiffies.h>
154#include <linux/seq_file.h>
155#include "types.h"
156
Sven Eckelmann3193e8f2012-05-12 02:09:42 +0200157extern char batadv_routing_algo[];
158extern struct list_head batadv_hardif_list;
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000159
Sven Eckelmann3193e8f2012-05-12 02:09:42 +0200160extern unsigned char batadv_broadcast_addr[];
161extern struct workqueue_struct *batadv_event_workqueue;
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000162
Sven Eckelmann3193e8f2012-05-12 02:09:42 +0200163int batadv_mesh_init(struct net_device *soft_iface);
164void batadv_mesh_free(struct net_device *soft_iface);
Sven Eckelmann3193e8f2012-05-12 02:09:42 +0200165int batadv_is_my_mac(const uint8_t *addr);
Marek Lindner30da63a2012-08-03 17:15:46 +0200166struct batadv_hard_iface *
167batadv_seq_print_text_primary_if_get(struct seq_file *seq);
Sven Eckelmann3193e8f2012-05-12 02:09:42 +0200168int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev,
169 struct packet_type *ptype,
170 struct net_device *orig_dev);
Sven Eckelmann56303d32012-06-05 22:31:31 +0200171int
172batadv_recv_handler_register(uint8_t packet_type,
173 int (*recv_handler)(struct sk_buff *,
174 struct batadv_hard_iface *));
Sven Eckelmann3193e8f2012-05-12 02:09:42 +0200175void batadv_recv_handler_unregister(uint8_t packet_type);
Sven Eckelmann56303d32012-06-05 22:31:31 +0200176int batadv_algo_register(struct batadv_algo_ops *bat_algo_ops);
177int batadv_algo_select(struct batadv_priv *bat_priv, char *name);
Sven Eckelmann3193e8f2012-05-12 02:09:42 +0200178int batadv_algo_seq_print_text(struct seq_file *seq, void *offset);
Sven Eckelmann95a066d2012-10-17 21:10:39 +0200179__be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr);
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000180
Antonio Quartulli0aca86c2012-08-27 11:45:37 +0200181/**
182 * enum batadv_dbg_level - available log levels
183 * @BATADV_DBG_BATMAN: OGM and TQ computations related messages
184 * @BATADV_DBG_ROUTES: route added / changed / deleted
185 * @BATADV_DBG_TT: translation table messages
186 * @BATADV_DBG_BLA: bridge loop avoidance messages
Antonio Quartulli0e861a32012-10-01 09:57:36 +0200187 * @BATADV_DBG_DAT: ARP snooping and DAT related messages
Antonio Quartulli0aca86c2012-08-27 11:45:37 +0200188 * @BATADV_DBG_ALL: the union of all the above log levels
189 */
Sven Eckelmann8de47de2012-07-08 16:32:09 +0200190enum batadv_dbg_level {
191 BATADV_DBG_BATMAN = BIT(0),
Antonio Quartulli0aca86c2012-08-27 11:45:37 +0200192 BATADV_DBG_ROUTES = BIT(1),
193 BATADV_DBG_TT = BIT(2),
194 BATADV_DBG_BLA = BIT(3),
Antonio Quartulli0e861a32012-10-01 09:57:36 +0200195 BATADV_DBG_DAT = BIT(4),
196 BATADV_DBG_ALL = 31,
Sven Eckelmann8de47de2012-07-08 16:32:09 +0200197};
198
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000199#ifdef CONFIG_BATMAN_ADV_DEBUG
Sven Eckelmann56303d32012-06-05 22:31:31 +0200200int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...)
Sven Eckelmann40a072d2012-05-12 02:09:23 +0200201__printf(2, 3);
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000202
Sven Eckelmann1eda58b2012-05-12 13:48:58 +0200203#define batadv_dbg(type, bat_priv, fmt, arg...) \
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000204 do { \
205 if (atomic_read(&bat_priv->log_level) & type) \
Sven Eckelmann40a072d2012-05-12 02:09:23 +0200206 batadv_debug_log(bat_priv, fmt, ## arg);\
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000207 } \
208 while (0)
209#else /* !CONFIG_BATMAN_ADV_DEBUG */
Sven Eckelmannd3a547b2011-05-14 23:14:46 +0200210__printf(3, 4)
Sven Eckelmann1eda58b2012-05-12 13:48:58 +0200211static inline void batadv_dbg(int type __always_unused,
Sven Eckelmann56303d32012-06-05 22:31:31 +0200212 struct batadv_priv *bat_priv __always_unused,
Sven Eckelmann1eda58b2012-05-12 13:48:58 +0200213 const char *fmt __always_unused, ...)
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000214{
215}
216#endif
217
Sven Eckelmann3e348192012-05-16 20:23:22 +0200218#define batadv_info(net_dev, fmt, arg...) \
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000219 do { \
220 struct net_device *_netdev = (net_dev); \
Sven Eckelmann56303d32012-06-05 22:31:31 +0200221 struct batadv_priv *_batpriv = netdev_priv(_netdev); \
Sven Eckelmann39c75a52012-06-03 22:19:22 +0200222 batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000223 pr_info("%s: " fmt, _netdev->name, ## arg); \
224 } while (0)
Sven Eckelmann3e348192012-05-16 20:23:22 +0200225#define batadv_err(net_dev, fmt, arg...) \
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000226 do { \
227 struct net_device *_netdev = (net_dev); \
Sven Eckelmann56303d32012-06-05 22:31:31 +0200228 struct batadv_priv *_batpriv = netdev_priv(_netdev); \
Sven Eckelmann39c75a52012-06-03 22:19:22 +0200229 batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000230 pr_err("%s: " fmt, _netdev->name, ## arg); \
231 } while (0)
232
Sven Eckelmann9cfc7bd2012-05-12 02:09:43 +0200233/* returns 1 if they are the same ethernet addr
Marek Lindner39901e72011-02-18 12:28:08 +0000234 *
235 * note: can't use compare_ether_addr() as it requires aligned memory
236 */
Sven Eckelmann1eda58b2012-05-12 13:48:58 +0200237static inline int batadv_compare_eth(const void *data1, const void *data2)
Marek Lindner39901e72011-02-18 12:28:08 +0000238{
239 return (memcmp(data1, data2, ETH_ALEN) == 0 ? 1 : 0);
240}
241
Ben Hutchings2c530402012-07-10 10:55:09 +0000242/**
243 * has_timed_out - compares current time (jiffies) and timestamp + timeout
Martin Hundebølla04ccd52011-12-08 13:32:41 +0100244 * @timestamp: base value to compare with (in jiffies)
245 * @timeout: added to base value before comparing (in milliseconds)
246 *
247 * Returns true if current time is after timestamp + timeout
248 */
Sven Eckelmann1eda58b2012-05-12 13:48:58 +0200249static inline bool batadv_has_timed_out(unsigned long timestamp,
250 unsigned int timeout)
Martin Hundebølla04ccd52011-12-08 13:32:41 +0100251{
252 return time_is_before_jiffies(timestamp + msecs_to_jiffies(timeout));
253}
Sven Eckelmann747e4222011-05-14 23:14:50 +0200254
Sven Eckelmann3e348192012-05-16 20:23:22 +0200255#define batadv_atomic_dec_not_zero(v) atomic_add_unless((v), -1, 0)
Antonio Quartulli5f657ec2011-04-20 09:52:56 +0200256
Antonio Quartullif5d33d32011-05-18 09:20:50 +0200257/* Returns the smallest signed integer in two's complement with the sizeof x */
Sven Eckelmann3e348192012-05-16 20:23:22 +0200258#define batadv_smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u)))
Antonio Quartullif5d33d32011-05-18 09:20:50 +0200259
260/* Checks if a sequence number x is a predecessor/successor of y.
261 * they handle overflows/underflows and can correctly check for a
262 * predecessor/successor unless the variable sequence number has grown by
263 * more then 2**(bitwidth(x)-1)-1.
264 * This means that for a uint8_t with the maximum value 255, it would think:
265 * - when adding nothing - it is neither a predecessor nor a successor
266 * - before adding more than 127 to the starting value - it is a predecessor,
267 * - when adding 128 - it is neither a predecessor nor a successor,
Sven Eckelmann9cfc7bd2012-05-12 02:09:43 +0200268 * - after adding more than 127 to the starting value - it is a successor
269 */
Sven Eckelmann3e348192012-05-16 20:23:22 +0200270#define batadv_seq_before(x, y) ({typeof(x) _d1 = (x); \
271 typeof(y) _d2 = (y); \
272 typeof(x) _dummy = (_d1 - _d2); \
273 (void) (&_d1 == &_d2); \
274 _dummy > batadv_smallest_signed_int(_dummy); })
275#define batadv_seq_after(x, y) batadv_seq_before(y, x)
Antonio Quartullif5d33d32011-05-18 09:20:50 +0200276
Martin Hundebøllf8214862012-04-20 17:02:45 +0200277/* Stop preemption on local cpu while incrementing the counter */
Sven Eckelmann56303d32012-06-05 22:31:31 +0200278static inline void batadv_add_counter(struct batadv_priv *bat_priv, size_t idx,
Martin Hundebøllf8214862012-04-20 17:02:45 +0200279 size_t count)
280{
Shan Wei56917442012-11-13 09:53:26 +0800281 this_cpu_add(bat_priv->bat_counters[idx], count);
Martin Hundebøllf8214862012-04-20 17:02:45 +0200282}
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' */
Sven Eckelmann56303d32012-06-05 22:31:31 +0200287static inline uint64_t batadv_sum_counter(struct batadv_priv *bat_priv,
288 size_t idx)
Martin Hundebøllf8214862012-04-20 17:02:45 +0200289{
Marek Lindner0c5e45b2012-06-23 11:46:05 +0200290 uint64_t *counters, sum = 0;
Martin Hundebøllf8214862012-04-20 17:02:45 +0200291 int cpu;
Martin Hundebøllf8214862012-04-20 17:02:45 +0200292
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
Sven Eckelmannc6c8fea2010-12-13 11:19:28 +0000301#endif /* _NET_BATMAN_ADV_MAIN_H_ */