xref: /linux/net/batman-adv/main.h (revision 30cfd02b60e1cb16f5effb0a01f826c5bb7e4c59)
19cfc7bd6SSven Eckelmann /* Copyright (C) 2007-2012 B.A.T.M.A.N. contributors:
2c6c8fea2SSven Eckelmann  *
3c6c8fea2SSven Eckelmann  * Marek Lindner, Simon Wunderlich
4c6c8fea2SSven Eckelmann  *
5c6c8fea2SSven Eckelmann  * This program is free software; you can redistribute it and/or
6c6c8fea2SSven Eckelmann  * modify it under the terms of version 2 of the GNU General Public
7c6c8fea2SSven Eckelmann  * License as published by the Free Software Foundation.
8c6c8fea2SSven Eckelmann  *
9c6c8fea2SSven Eckelmann  * This program is distributed in the hope that it will be useful, but
10c6c8fea2SSven Eckelmann  * WITHOUT ANY WARRANTY; without even the implied warranty of
11c6c8fea2SSven Eckelmann  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12c6c8fea2SSven Eckelmann  * General Public License for more details.
13c6c8fea2SSven Eckelmann  *
14c6c8fea2SSven Eckelmann  * You should have received a copy of the GNU General Public License
15c6c8fea2SSven Eckelmann  * along with this program; if not, write to the Free Software
16c6c8fea2SSven Eckelmann  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17c6c8fea2SSven Eckelmann  * 02110-1301, USA
18c6c8fea2SSven Eckelmann  */
19c6c8fea2SSven Eckelmann 
20c6c8fea2SSven Eckelmann #ifndef _NET_BATMAN_ADV_MAIN_H_
21c6c8fea2SSven Eckelmann #define _NET_BATMAN_ADV_MAIN_H_
22c6c8fea2SSven Eckelmann 
2342d0b044SSven Eckelmann #define BATADV_DRIVER_AUTHOR "Marek Lindner <lindner_marek@yahoo.de>, " \
24c6c8fea2SSven Eckelmann 			     "Simon Wunderlich <siwu@hrz.tu-chemnitz.de>"
2542d0b044SSven Eckelmann #define BATADV_DRIVER_DESC   "B.A.T.M.A.N. advanced"
2642d0b044SSven Eckelmann #define BATADV_DRIVER_DEVICE "batman-adv"
27c6c8fea2SSven Eckelmann 
2842d0b044SSven Eckelmann #ifndef BATADV_SOURCE_VERSION
2942d0b044SSven Eckelmann #define BATADV_SOURCE_VERSION "2012.3.0"
3044c4349aSSven Eckelmann #endif
31c6c8fea2SSven Eckelmann 
32c6c8fea2SSven Eckelmann /* B.A.T.M.A.N. parameters */
33c6c8fea2SSven Eckelmann 
3442d0b044SSven Eckelmann #define BATADV_TQ_MAX_VALUE 255
3542d0b044SSven Eckelmann #define BATADV_JITTER 20
36c6c8fea2SSven Eckelmann 
376e215fd8SSven Eckelmann /* Time To Live of broadcast messages */
3842d0b044SSven Eckelmann #define BATADV_TTL 50
396e215fd8SSven Eckelmann 
406e215fd8SSven Eckelmann /* purge originators after time in seconds if no valid packet comes in
4142d0b044SSven Eckelmann  * -> TODO: check influence on BATADV_TQ_LOCAL_WINDOW_SIZE
429cfc7bd6SSven Eckelmann  */
4342d0b044SSven Eckelmann #define BATADV_PURGE_TIMEOUT 200000 /* 200 seconds */
44a51fb9b2SAntonio Quartulli #define BATADV_TT_LOCAL_TIMEOUT 3600000 /* in milliseconds */
45a51fb9b2SAntonio Quartulli #define BATADV_TT_CLIENT_ROAM_TIMEOUT 600000 /* in milliseconds */
46*30cfd02bSAntonio Quartulli #define BATADV_TT_CLIENT_TEMP_TIMEOUT 600000 /* in milliseconds */
47015758d0SAntonio Quartulli /* sliding packet range of received originator messages in sequence numbers
489cfc7bd6SSven Eckelmann  * (should be a multiple of our word size)
499cfc7bd6SSven Eckelmann  */
5042d0b044SSven Eckelmann #define BATADV_TQ_LOCAL_WINDOW_SIZE 64
51a51fb9b2SAntonio Quartulli /* milliseconds we have to keep pending tt_req */
5242d0b044SSven Eckelmann #define BATADV_TT_REQUEST_TIMEOUT 3000
53a73105b8SAntonio Quartulli 
5442d0b044SSven Eckelmann #define BATADV_TQ_GLOBAL_WINDOW_SIZE 5
5542d0b044SSven Eckelmann #define BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM 1
5642d0b044SSven Eckelmann #define BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM 1
5742d0b044SSven Eckelmann #define BATADV_TQ_TOTAL_BIDRECT_LIMIT 1
58c6c8fea2SSven Eckelmann 
5942d0b044SSven Eckelmann /* number of OGMs sent with the last tt diff */
6042d0b044SSven Eckelmann #define BATADV_TT_OGM_APPEND_MAX 3
61a73105b8SAntonio Quartulli 
629cfc7bd6SSven Eckelmann /* Time in which a client can roam at most ROAMING_MAX_COUNT times in
63a51fb9b2SAntonio Quartulli  * milliseconds
649cfc7bd6SSven Eckelmann  */
6542d0b044SSven Eckelmann #define BATADV_ROAMING_MAX_TIME 20000
6642d0b044SSven Eckelmann #define BATADV_ROAMING_MAX_COUNT 5
67cc47f66eSAntonio Quartulli 
6842d0b044SSven Eckelmann #define BATADV_NO_FLAGS 0
69ecbd5321SMarek Lindner 
7042d0b044SSven Eckelmann #define BATADV_NULL_IFINDEX 0 /* dummy ifindex used to avoid iface checks */
71bc279080SAntonio Quartulli 
7242d0b044SSven Eckelmann #define BATADV_NUM_WORDS BITS_TO_LONGS(BATADV_TQ_LOCAL_WINDOW_SIZE)
73c6c8fea2SSven Eckelmann 
7442d0b044SSven Eckelmann #define BATADV_LOG_BUF_LEN 8192	  /* has to be a power of 2 */
75c6c8fea2SSven Eckelmann 
7642d0b044SSven Eckelmann #define BATADV_VIS_INTERVAL 5000	/* 5 seconds */
77c6c8fea2SSven Eckelmann 
786e215fd8SSven Eckelmann /* how much worse secondary interfaces may be to be considered as bonding
799cfc7bd6SSven Eckelmann  * candidates
809cfc7bd6SSven Eckelmann  */
8142d0b044SSven Eckelmann #define BATADV_BONDING_TQ_THRESHOLD	50
82c6c8fea2SSven Eckelmann 
836e215fd8SSven Eckelmann /* should not be bigger than 512 bytes or change the size of
849cfc7bd6SSven Eckelmann  * forw_packet->direct_link_flags
859cfc7bd6SSven Eckelmann  */
8642d0b044SSven Eckelmann #define BATADV_MAX_AGGREGATION_BYTES 512
8742d0b044SSven Eckelmann #define BATADV_MAX_AGGREGATION_MS 100
88c6c8fea2SSven Eckelmann 
8942d0b044SSven Eckelmann #define BATADV_BLA_PERIOD_LENGTH	10000	/* 10 seconds */
9042d0b044SSven Eckelmann #define BATADV_BLA_BACKBONE_TIMEOUT	(BATADV_BLA_PERIOD_LENGTH * 3)
9142d0b044SSven Eckelmann #define BATADV_BLA_CLAIM_TIMEOUT	(BATADV_BLA_PERIOD_LENGTH * 10)
92fe2da6ffSSimon Wunderlich 
9342d0b044SSven Eckelmann #define BATADV_DUPLIST_SIZE		16
9442d0b044SSven Eckelmann #define BATADV_DUPLIST_TIMEOUT		500	/* 500 ms */
956e215fd8SSven Eckelmann /* don't reset again within 30 seconds */
9642d0b044SSven Eckelmann #define BATADV_RESET_PROTECTION_MS 30000
9742d0b044SSven Eckelmann #define BATADV_EXPECTED_SEQNO_RANGE	65536
98c6c8fea2SSven Eckelmann 
9939c75a51SSven Eckelmann enum batadv_mesh_state {
10039c75a51SSven Eckelmann 	BATADV_MESH_INACTIVE,
10139c75a51SSven Eckelmann 	BATADV_MESH_ACTIVE,
10239c75a51SSven Eckelmann 	BATADV_MESH_DEACTIVATING,
103e8958dbfSSven Eckelmann };
104c6c8fea2SSven Eckelmann 
10542d0b044SSven Eckelmann #define BATADV_BCAST_QUEUE_LEN		256
10642d0b044SSven Eckelmann #define BATADV_BATMAN_QUEUE_LEN	256
107c6c8fea2SSven Eckelmann 
10839c75a51SSven Eckelmann enum batadv_uev_action {
10939c75a51SSven Eckelmann 	BATADV_UEV_ADD = 0,
11039c75a51SSven Eckelmann 	BATADV_UEV_DEL,
11139c75a51SSven Eckelmann 	BATADV_UEV_CHANGE,
112c6bda689SAntonio Quartulli };
113c6bda689SAntonio Quartulli 
11439c75a51SSven Eckelmann enum batadv_uev_type {
11539c75a51SSven Eckelmann 	BATADV_UEV_GW = 0,
116c6bda689SAntonio Quartulli };
117c6bda689SAntonio Quartulli 
11842d0b044SSven Eckelmann #define BATADV_GW_THRESHOLD	50
11943676ab5SAntonio Quartulli 
12021a1236bSSven Eckelmann /* Debug Messages */
121c6c8fea2SSven Eckelmann #ifdef pr_fmt
122c6c8fea2SSven Eckelmann #undef pr_fmt
123c6c8fea2SSven Eckelmann #endif
1246e215fd8SSven Eckelmann /* Append 'batman-adv: ' before kernel messages */
1256e215fd8SSven Eckelmann #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
126c6c8fea2SSven Eckelmann 
12721a1236bSSven Eckelmann /* Kernel headers */
128c6c8fea2SSven Eckelmann 
129c6c8fea2SSven Eckelmann #include <linux/mutex.h>	/* mutex */
130c6c8fea2SSven Eckelmann #include <linux/module.h>	/* needed by all modules */
131c6c8fea2SSven Eckelmann #include <linux/netdevice.h>	/* netdevice */
132015758d0SAntonio Quartulli #include <linux/etherdevice.h>  /* ethernet address classification */
133c6c8fea2SSven Eckelmann #include <linux/if_ether.h>	/* ethernet header */
134c6c8fea2SSven Eckelmann #include <linux/poll.h>		/* poll_table */
135c6c8fea2SSven Eckelmann #include <linux/kthread.h>	/* kernel threads */
136c6c8fea2SSven Eckelmann #include <linux/pkt_sched.h>	/* schedule types */
137c6c8fea2SSven Eckelmann #include <linux/workqueue.h>	/* workqueue */
138f8214865SMartin Hundebøll #include <linux/percpu.h>
139c6c8fea2SSven Eckelmann #include <linux/slab.h>
140c6c8fea2SSven Eckelmann #include <net/sock.h>		/* struct sock */
141c6c8fea2SSven Eckelmann #include <linux/jiffies.h>
142c6c8fea2SSven Eckelmann #include <linux/seq_file.h>
143c6c8fea2SSven Eckelmann #include "types.h"
144c6c8fea2SSven Eckelmann 
1453193e8fdSSven Eckelmann extern char batadv_routing_algo[];
1463193e8fdSSven Eckelmann extern struct list_head batadv_hardif_list;
147c6c8fea2SSven Eckelmann 
1483193e8fdSSven Eckelmann extern unsigned char batadv_broadcast_addr[];
1493193e8fdSSven Eckelmann extern struct workqueue_struct *batadv_event_workqueue;
150c6c8fea2SSven Eckelmann 
1513193e8fdSSven Eckelmann int batadv_mesh_init(struct net_device *soft_iface);
1523193e8fdSSven Eckelmann void batadv_mesh_free(struct net_device *soft_iface);
1533193e8fdSSven Eckelmann void batadv_inc_module_count(void);
1543193e8fdSSven Eckelmann void batadv_dec_module_count(void);
1553193e8fdSSven Eckelmann int batadv_is_my_mac(const uint8_t *addr);
1563193e8fdSSven Eckelmann int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev,
1573193e8fdSSven Eckelmann 			   struct packet_type *ptype,
1583193e8fdSSven Eckelmann 			   struct net_device *orig_dev);
15956303d34SSven Eckelmann int
16056303d34SSven Eckelmann batadv_recv_handler_register(uint8_t packet_type,
161ffa995e0SMarek Lindner 			     int (*recv_handler)(struct sk_buff *,
16256303d34SSven Eckelmann 						 struct batadv_hard_iface *));
1633193e8fdSSven Eckelmann void batadv_recv_handler_unregister(uint8_t packet_type);
16456303d34SSven Eckelmann int batadv_algo_register(struct batadv_algo_ops *bat_algo_ops);
16556303d34SSven Eckelmann int batadv_algo_select(struct batadv_priv *bat_priv, char *name);
1663193e8fdSSven Eckelmann int batadv_algo_seq_print_text(struct seq_file *seq, void *offset);
167c6c8fea2SSven Eckelmann 
1688de47de5SSven Eckelmann /* all messages related to routing / flooding / broadcasting / etc */
1698de47de5SSven Eckelmann enum batadv_dbg_level {
1708de47de5SSven Eckelmann 	BATADV_DBG_BATMAN = BIT(0),
1718de47de5SSven Eckelmann 	BATADV_DBG_ROUTES = BIT(1), /* route added / changed / deleted */
1728de47de5SSven Eckelmann 	BATADV_DBG_TT	  = BIT(2), /* translation table operations */
1738de47de5SSven Eckelmann 	BATADV_DBG_BLA    = BIT(3), /* bridge loop avoidance */
1748de47de5SSven Eckelmann 	BATADV_DBG_ALL    = 15,
1758de47de5SSven Eckelmann };
1768de47de5SSven Eckelmann 
177c6c8fea2SSven Eckelmann #ifdef CONFIG_BATMAN_ADV_DEBUG
17856303d34SSven Eckelmann int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...)
17940a072d7SSven Eckelmann __printf(2, 3);
180c6c8fea2SSven Eckelmann 
1811eda58bfSSven Eckelmann #define batadv_dbg(type, bat_priv, fmt, arg...)			\
182c6c8fea2SSven Eckelmann 	do {							\
183c6c8fea2SSven Eckelmann 		if (atomic_read(&bat_priv->log_level) & type)	\
18440a072d7SSven Eckelmann 			batadv_debug_log(bat_priv, fmt, ## arg);\
185c6c8fea2SSven Eckelmann 	}							\
186c6c8fea2SSven Eckelmann 	while (0)
187c6c8fea2SSven Eckelmann #else /* !CONFIG_BATMAN_ADV_DEBUG */
188d3a547beSSven Eckelmann __printf(3, 4)
1891eda58bfSSven Eckelmann static inline void batadv_dbg(int type __always_unused,
19056303d34SSven Eckelmann 			      struct batadv_priv *bat_priv __always_unused,
191747e4221SSven Eckelmann 			      const char *fmt __always_unused, ...)
192c6c8fea2SSven Eckelmann {
193c6c8fea2SSven Eckelmann }
194c6c8fea2SSven Eckelmann #endif
195c6c8fea2SSven Eckelmann 
1963e34819eSSven Eckelmann #define batadv_info(net_dev, fmt, arg...)				\
197c6c8fea2SSven Eckelmann 	do {								\
198c6c8fea2SSven Eckelmann 		struct net_device *_netdev = (net_dev);                 \
19956303d34SSven Eckelmann 		struct batadv_priv *_batpriv = netdev_priv(_netdev);    \
20039c75a51SSven Eckelmann 		batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg);	\
201c6c8fea2SSven Eckelmann 		pr_info("%s: " fmt, _netdev->name, ## arg);		\
202c6c8fea2SSven Eckelmann 	} while (0)
2033e34819eSSven Eckelmann #define batadv_err(net_dev, fmt, arg...)				\
204c6c8fea2SSven Eckelmann 	do {								\
205c6c8fea2SSven Eckelmann 		struct net_device *_netdev = (net_dev);                 \
20656303d34SSven Eckelmann 		struct batadv_priv *_batpriv = netdev_priv(_netdev);    \
20739c75a51SSven Eckelmann 		batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg);	\
208c6c8fea2SSven Eckelmann 		pr_err("%s: " fmt, _netdev->name, ## arg);		\
209c6c8fea2SSven Eckelmann 	} while (0)
210c6c8fea2SSven Eckelmann 
2119cfc7bd6SSven Eckelmann /* returns 1 if they are the same ethernet addr
21239901e71SMarek Lindner  *
21339901e71SMarek Lindner  * note: can't use compare_ether_addr() as it requires aligned memory
21439901e71SMarek Lindner  */
2151eda58bfSSven Eckelmann static inline int batadv_compare_eth(const void *data1, const void *data2)
21639901e71SMarek Lindner {
21739901e71SMarek Lindner 	return (memcmp(data1, data2, ETH_ALEN) == 0 ? 1 : 0);
21839901e71SMarek Lindner }
21939901e71SMarek Lindner 
2202c53040fSBen Hutchings /**
2212c53040fSBen Hutchings  * has_timed_out - compares current time (jiffies) and timestamp + timeout
222a04ccd59SMartin Hundebøll  * @timestamp:		base value to compare with (in jiffies)
223a04ccd59SMartin Hundebøll  * @timeout:		added to base value before comparing (in milliseconds)
224a04ccd59SMartin Hundebøll  *
225a04ccd59SMartin Hundebøll  * Returns true if current time is after timestamp + timeout
226a04ccd59SMartin Hundebøll  */
2271eda58bfSSven Eckelmann static inline bool batadv_has_timed_out(unsigned long timestamp,
2281eda58bfSSven Eckelmann 					unsigned int timeout)
229a04ccd59SMartin Hundebøll {
230a04ccd59SMartin Hundebøll 	return time_is_before_jiffies(timestamp + msecs_to_jiffies(timeout));
231a04ccd59SMartin Hundebøll }
232747e4221SSven Eckelmann 
2333e34819eSSven Eckelmann #define batadv_atomic_dec_not_zero(v)	atomic_add_unless((v), -1, 0)
2345f657ec0SAntonio Quartulli 
235f5d33d37SAntonio Quartulli /* Returns the smallest signed integer in two's complement with the sizeof x */
2363e34819eSSven Eckelmann #define batadv_smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u)))
237f5d33d37SAntonio Quartulli 
238f5d33d37SAntonio Quartulli /* Checks if a sequence number x is a predecessor/successor of y.
239f5d33d37SAntonio Quartulli  * they handle overflows/underflows and can correctly check for a
240f5d33d37SAntonio Quartulli  * predecessor/successor unless the variable sequence number has grown by
241f5d33d37SAntonio Quartulli  * more then 2**(bitwidth(x)-1)-1.
242f5d33d37SAntonio Quartulli  * This means that for a uint8_t with the maximum value 255, it would think:
243f5d33d37SAntonio Quartulli  *  - when adding nothing - it is neither a predecessor nor a successor
244f5d33d37SAntonio Quartulli  *  - before adding more than 127 to the starting value - it is a predecessor,
245f5d33d37SAntonio Quartulli  *  - when adding 128 - it is neither a predecessor nor a successor,
2469cfc7bd6SSven Eckelmann  *  - after adding more than 127 to the starting value - it is a successor
2479cfc7bd6SSven Eckelmann  */
2483e34819eSSven Eckelmann #define batadv_seq_before(x, y) ({typeof(x) _d1 = (x); \
2490bb85751SSven Eckelmann 				 typeof(y) _d2 = (y); \
2500bb85751SSven Eckelmann 				 typeof(x) _dummy = (_d1 - _d2); \
2510bb85751SSven Eckelmann 				 (void) (&_d1 == &_d2); \
2523e34819eSSven Eckelmann 				 _dummy > batadv_smallest_signed_int(_dummy); })
2533e34819eSSven Eckelmann #define batadv_seq_after(x, y) batadv_seq_before(y, x)
254f5d33d37SAntonio Quartulli 
255f8214865SMartin Hundebøll /* Stop preemption on local cpu while incrementing the counter */
25656303d34SSven Eckelmann static inline void batadv_add_counter(struct batadv_priv *bat_priv, size_t idx,
257f8214865SMartin Hundebøll 				      size_t count)
258f8214865SMartin Hundebøll {
259f8214865SMartin Hundebøll 	int cpu = get_cpu();
260f8214865SMartin Hundebøll 	per_cpu_ptr(bat_priv->bat_counters, cpu)[idx] += count;
261f8214865SMartin Hundebøll 	put_cpu();
262f8214865SMartin Hundebøll }
263f8214865SMartin Hundebøll 
264f8214865SMartin Hundebøll #define batadv_inc_counter(b, i) batadv_add_counter(b, i, 1)
265f8214865SMartin Hundebøll 
266f8214865SMartin Hundebøll /* Sum and return the cpu-local counters for index 'idx' */
26756303d34SSven Eckelmann static inline uint64_t batadv_sum_counter(struct batadv_priv *bat_priv,
26856303d34SSven Eckelmann 					  size_t idx)
269f8214865SMartin Hundebøll {
2700c5e45b6SMarek Lindner 	uint64_t *counters, sum = 0;
271f8214865SMartin Hundebøll 	int cpu;
272f8214865SMartin Hundebøll 
273f8214865SMartin Hundebøll 	for_each_possible_cpu(cpu) {
274f8214865SMartin Hundebøll 		counters = per_cpu_ptr(bat_priv->bat_counters, cpu);
275f8214865SMartin Hundebøll 		sum += counters[idx];
276f8214865SMartin Hundebøll 	}
277f8214865SMartin Hundebøll 
278f8214865SMartin Hundebøll 	return sum;
279f8214865SMartin Hundebøll }
280f8214865SMartin Hundebøll 
281c6c8fea2SSven Eckelmann #endif /* _NET_BATMAN_ADV_MAIN_H_ */
282