[mirror_ubuntu-bionic-kernel.git] / net / batman-adv / main.h

/* Copyright (C) 2007-2016  B.A.T.M.A.N. contributors:
 *
 * Marek Lindner, Simon Wunderlich
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _NET_BATMAN_ADV_MAIN_H_
#define _NET_BATMAN_ADV_MAIN_H_

#define BATADV_DRIVER_AUTHOR "Marek Lindner <mareklindner@neomailbox.ch>, " \
			     "Simon Wunderlich <sw@simonwunderlich.de>"
#define BATADV_DRIVER_DESC   "B.A.T.M.A.N. advanced"
#define BATADV_DRIVER_DEVICE "batman-adv"

#ifndef BATADV_SOURCE_VERSION
#define BATADV_SOURCE_VERSION "2016.0"
#endif

/* B.A.T.M.A.N. parameters */

#define BATADV_TQ_MAX_VALUE 255
#define BATADV_THROUGHPUT_MAX_VALUE 0xFFFFFFFF
#define BATADV_JITTER 20

/* Time To Live of broadcast messages */
#define BATADV_TTL 50

/* maximum sequence number age of broadcast messages */
#define BATADV_BCAST_MAX_AGE 64

/* purge originators after time in seconds if no valid packet comes in
 * -> TODO: check influence on BATADV_TQ_LOCAL_WINDOW_SIZE
 */
#define BATADV_PURGE_TIMEOUT 200000 /* 200 seconds */
#define BATADV_TT_LOCAL_TIMEOUT 600000 /* in milliseconds */
#define BATADV_TT_CLIENT_ROAM_TIMEOUT 600000 /* in milliseconds */
#define BATADV_TT_CLIENT_TEMP_TIMEOUT 600000 /* in milliseconds */
#define BATADV_TT_WORK_PERIOD 5000 /* 5 seconds */
#define BATADV_ORIG_WORK_PERIOD 1000 /* 1 second */
#define BATADV_DAT_ENTRY_TIMEOUT (5 * 60000) /* 5 mins in milliseconds */
/* sliding packet range of received originator messages in sequence numbers
 * (should be a multiple of our word size)
 */
#define BATADV_TQ_LOCAL_WINDOW_SIZE 64
/* milliseconds we have to keep pending tt_req */
#define BATADV_TT_REQUEST_TIMEOUT 3000

#define BATADV_TQ_GLOBAL_WINDOW_SIZE 5
#define BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM 1
#define BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM 1
#define BATADV_TQ_TOTAL_BIDRECT_LIMIT 1

/* B.A.T.M.A.N. V */
#define BATADV_ELP_MAX_AGE 64

/* number of OGMs sent with the last tt diff */
#define BATADV_TT_OGM_APPEND_MAX 3

/* Time in which a client can roam at most ROAMING_MAX_COUNT times in
 * milliseconds
 */
#define BATADV_ROAMING_MAX_TIME 20000
#define BATADV_ROAMING_MAX_COUNT 5

#define BATADV_NO_FLAGS 0

#define BATADV_NULL_IFINDEX 0 /* dummy ifindex used to avoid iface checks */

#define BATADV_NO_MARK 0

/* default interface for multi interface operation. The default interface is
 * used for communication which originated locally (i.e. is not forwarded)
 * or where special forwarding is not desired/necessary.
 */
#define BATADV_IF_DEFAULT	((struct batadv_hard_iface *)NULL)

#define BATADV_NUM_WORDS BITS_TO_LONGS(BATADV_TQ_LOCAL_WINDOW_SIZE)

#define BATADV_LOG_BUF_LEN 8192	  /* has to be a power of 2 */

/* number of packets to send for broadcasts on different interface types */
#define BATADV_NUM_BCASTS_DEFAULT 1
#define BATADV_NUM_BCASTS_WIRELESS 3
#define BATADV_NUM_BCASTS_MAX 3

/* msecs after which an ARP_REQUEST is sent in broadcast as fallback */
#define ARP_REQ_DELAY 250
/* numbers of originator to contact for any PUT/GET DHT operation */
#define BATADV_DAT_CANDIDATES_NUM 3

/* BATADV_TQ_SIMILARITY_THRESHOLD - TQ points that a secondary metric can differ
 * at most from the primary one in order to be still considered acceptable
 */
#define BATADV_TQ_SIMILARITY_THRESHOLD 50

/* should not be bigger than 512 bytes or change the size of
 * forw_packet->direct_link_flags
 */
#define BATADV_MAX_AGGREGATION_BYTES 512
#define BATADV_MAX_AGGREGATION_MS 100

#define BATADV_BLA_PERIOD_LENGTH	10000	/* 10 seconds */
#define BATADV_BLA_BACKBONE_TIMEOUT	(BATADV_BLA_PERIOD_LENGTH * 6)
#define BATADV_BLA_CLAIM_TIMEOUT	(BATADV_BLA_PERIOD_LENGTH * 10)
#define BATADV_BLA_WAIT_PERIODS		3

#define BATADV_DUPLIST_SIZE		16
#define BATADV_DUPLIST_TIMEOUT		500	/* 500 ms */
/* don't reset again within 30 seconds */
#define BATADV_RESET_PROTECTION_MS 30000
#define BATADV_EXPECTED_SEQNO_RANGE	65536

#define BATADV_NC_NODE_TIMEOUT 10000 /* Milliseconds */

enum batadv_mesh_state {
	BATADV_MESH_INACTIVE,
	BATADV_MESH_ACTIVE,
	BATADV_MESH_DEACTIVATING,
};

#define BATADV_BCAST_QUEUE_LEN		256
#define BATADV_BATMAN_QUEUE_LEN	256

enum batadv_uev_action {
	BATADV_UEV_ADD = 0,
	BATADV_UEV_DEL,
	BATADV_UEV_CHANGE,
};

enum batadv_uev_type {
	BATADV_UEV_GW = 0,
};

#define BATADV_GW_THRESHOLD	50

/* Number of fragment chains for each orig_node */
#define BATADV_FRAG_BUFFER_COUNT 8
/* Maximum number of fragments for one packet */
#define BATADV_FRAG_MAX_FRAGMENTS 16
/* Maxumim size of each fragment */
#define BATADV_FRAG_MAX_FRAG_SIZE 1400
/* Time to keep fragments while waiting for rest of the fragments */
#define BATADV_FRAG_TIMEOUT 10000

#define BATADV_DAT_CANDIDATE_NOT_FOUND	0
#define BATADV_DAT_CANDIDATE_ORIG	1

/* Debug Messages */
#ifdef pr_fmt
#undef pr_fmt
#endif
/* Append 'batman-adv: ' before kernel messages */
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

/* Kernel headers */

#include <linux/atomic.h>
#include <linux/bitops.h> /* for packet.h */
#include <linux/compiler.h>
#include <linux/cpumask.h>
#include <linux/etherdevice.h>
#include <linux/if_ether.h> /* for packet.h */
#include <linux/netdevice.h>
#include <linux/printk.h>
#include <linux/types.h>
#include <linux/percpu.h>
#include <linux/jiffies.h>
#include <linux/if_vlan.h>

#include "types.h"

struct batadv_ogm_packet;
struct seq_file;
struct sk_buff;

#define BATADV_PRINT_VID(vid) ((vid & BATADV_VLAN_HAS_TAG) ? \
			       (int)(vid & VLAN_VID_MASK) : -1)

extern char batadv_routing_algo[];
extern struct list_head batadv_hardif_list;

extern unsigned char batadv_broadcast_addr[];
extern struct workqueue_struct *batadv_event_workqueue;

int batadv_mesh_init(struct net_device *soft_iface);
void batadv_mesh_free(struct net_device *soft_iface);
bool batadv_is_my_mac(struct batadv_priv *bat_priv, const u8 *addr);
struct batadv_hard_iface *
batadv_seq_print_text_primary_if_get(struct seq_file *seq);
int batadv_max_header_len(void);
void batadv_skb_set_priority(struct sk_buff *skb, int offset);
int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev,
			   struct packet_type *ptype,
			   struct net_device *orig_dev);
int
batadv_recv_handler_register(u8 packet_type,
			     int (*recv_handler)(struct sk_buff *,
						 struct batadv_hard_iface *));
void batadv_recv_handler_unregister(u8 packet_type);
int batadv_algo_register(struct batadv_algo_ops *bat_algo_ops);
int batadv_algo_select(struct batadv_priv *bat_priv, char *name);
int batadv_algo_seq_print_text(struct seq_file *seq, void *offset);
__be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr);

/**
 * enum batadv_dbg_level - available log levels
 * @BATADV_DBG_BATMAN: OGM and TQ computations related messages
 * @BATADV_DBG_ROUTES: route added / changed / deleted
 * @BATADV_DBG_TT: translation table messages
 * @BATADV_DBG_BLA: bridge loop avoidance messages
 * @BATADV_DBG_DAT: ARP snooping and DAT related messages
 * @BATADV_DBG_NC: network coding related messages
 * @BATADV_DBG_ALL: the union of all the above log levels
 */
enum batadv_dbg_level {
	BATADV_DBG_BATMAN = BIT(0),
	BATADV_DBG_ROUTES = BIT(1),
	BATADV_DBG_TT	  = BIT(2),
	BATADV_DBG_BLA    = BIT(3),
	BATADV_DBG_DAT    = BIT(4),
	BATADV_DBG_NC	  = BIT(5),
	BATADV_DBG_ALL    = 63,
};

#ifdef CONFIG_BATMAN_ADV_DEBUG
int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...)
__printf(2, 3);

/* possibly ratelimited debug output */
#define _batadv_dbg(type, bat_priv, ratelimited, fmt, arg...)	\
	do {							\
		if (atomic_read(&bat_priv->log_level) & type && \
		    (!ratelimited || net_ratelimit()))		\
			batadv_debug_log(bat_priv, fmt, ## arg);\
	}							\
	while (0)
#else /* !CONFIG_BATMAN_ADV_DEBUG */
__printf(4, 5)
static inline void _batadv_dbg(int type __always_unused,
			       struct batadv_priv *bat_priv __always_unused,
			       int ratelimited __always_unused,
			       const char *fmt __always_unused, ...)
{
}
#endif

#define batadv_dbg(type, bat_priv, arg...) \
	_batadv_dbg(type, bat_priv, 0, ## arg)
#define batadv_dbg_ratelimited(type, bat_priv, arg...) \
	_batadv_dbg(type, bat_priv, 1, ## arg)

#define batadv_info(net_dev, fmt, arg...)				\
	do {								\
		struct net_device *_netdev = (net_dev);                 \
		struct batadv_priv *_batpriv = netdev_priv(_netdev);    \
		batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg);	\
		pr_info("%s: " fmt, _netdev->name, ## arg);		\
	} while (0)
#define batadv_err(net_dev, fmt, arg...)				\
	do {								\
		struct net_device *_netdev = (net_dev);                 \
		struct batadv_priv *_batpriv = netdev_priv(_netdev);    \
		batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg);	\
		pr_err("%s: " fmt, _netdev->name, ## arg);		\
	} while (0)

/**
 * batadv_compare_eth - Compare two not u16 aligned Ethernet addresses
 * @data1: Pointer to a six-byte array containing the Ethernet address
 * @data2: Pointer other six-byte array containing the Ethernet address
 *
 * note: can't use ether_addr_equal() as it requires aligned memory
 *
 * Return: 1 if they are the same ethernet addr
 */
static inline bool batadv_compare_eth(const void *data1, const void *data2)
{
	return ether_addr_equal_unaligned(data1, data2);
}

/**
 * has_timed_out - compares current time (jiffies) and timestamp + timeout
 * @timestamp:		base value to compare with (in jiffies)
 * @timeout:		added to base value before comparing (in milliseconds)
 *
 * Return: true if current time is after timestamp + timeout
 */
static inline bool batadv_has_timed_out(unsigned long timestamp,
					unsigned int timeout)
{
	return time_is_before_jiffies(timestamp + msecs_to_jiffies(timeout));
}

#define batadv_atomic_dec_not_zero(v)	atomic_add_unless((v), -1, 0)

/* Returns the smallest signed integer in two's complement with the sizeof x */
#define batadv_smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u)))

/* Checks if a sequence number x is a predecessor/successor of y.
 * they handle overflows/underflows and can correctly check for a
 * predecessor/successor unless the variable sequence number has grown by
 * more then 2**(bitwidth(x)-1)-1.
 * This means that for a u8 with the maximum value 255, it would think:
 *  - when adding nothing - it is neither a predecessor nor a successor
 *  - before adding more than 127 to the starting value - it is a predecessor,
 *  - when adding 128 - it is neither a predecessor nor a successor,
 *  - after adding more than 127 to the starting value - it is a successor
 */
#define batadv_seq_before(x, y) ({typeof(x)_d1 = (x); \
				 typeof(y)_d2 = (y); \
				 typeof(x)_dummy = (_d1 - _d2); \
				 (void)(&_d1 == &_d2); \
				 _dummy > batadv_smallest_signed_int(_dummy); })
#define batadv_seq_after(x, y) batadv_seq_before(y, x)

/* Stop preemption on local cpu while incrementing the counter */
static inline void batadv_add_counter(struct batadv_priv *bat_priv, size_t idx,
				      size_t count)
{
	this_cpu_add(bat_priv->bat_counters[idx], count);
}

#define batadv_inc_counter(b, i) batadv_add_counter(b, i, 1)

/**
 * batadv_sum_counter - Sum the cpu-local counters for index 'idx'
 * @bat_priv: the bat priv with all the soft interface information
 * @idx: index of counter to sum up
 *
 * Return: sum of all cpu-local counters
 */
static inline u64 batadv_sum_counter(struct batadv_priv *bat_priv,  size_t idx)
{
	u64 *counters, sum = 0;
	int cpu;

	for_each_possible_cpu(cpu) {
		counters = per_cpu_ptr(bat_priv->bat_counters, cpu);
		sum += counters[idx];
	}

	return sum;
}

/* Define a macro to reach the control buffer of the skb. The members of the
 * control buffer are defined in struct batadv_skb_cb in types.h.
 * The macro is inspired by the similar macro TCP_SKB_CB() in tcp.h.
 */
#define BATADV_SKB_CB(__skb)       ((struct batadv_skb_cb *)&((__skb)->cb[0]))

void batadv_tvlv_container_register(struct batadv_priv *bat_priv,
				    u8 type, u8 version,
				    void *tvlv_value, u16 tvlv_value_len);
u16 batadv_tvlv_container_ogm_append(struct batadv_priv *bat_priv,
				     unsigned char **packet_buff,
				     int *packet_buff_len, int packet_min_len);
void batadv_tvlv_ogm_receive(struct batadv_priv *bat_priv,
			     struct batadv_ogm_packet *batadv_ogm_packet,
			     struct batadv_orig_node *orig_node);
void batadv_tvlv_container_unregister(struct batadv_priv *bat_priv,
				      u8 type, u8 version);

void batadv_tvlv_handler_register(struct batadv_priv *bat_priv,
				  void (*optr)(struct batadv_priv *bat_priv,
					       struct batadv_orig_node *orig,
					       u8 flags,
					       void *tvlv_value,
					       u16 tvlv_value_len),
				  int (*uptr)(struct batadv_priv *bat_priv,
					      u8 *src, u8 *dst,
					      void *tvlv_value,
					      u16 tvlv_value_len),
				  u8 type, u8 version, u8 flags);
void batadv_tvlv_handler_unregister(struct batadv_priv *bat_priv,
				    u8 type, u8 version);
int batadv_tvlv_containers_process(struct batadv_priv *bat_priv,
				   bool ogm_source,
				   struct batadv_orig_node *orig_node,
				   u8 *src, u8 *dst,
				   void *tvlv_buff, u16 tvlv_buff_len);
void batadv_tvlv_unicast_send(struct batadv_priv *bat_priv, u8 *src,
			      u8 *dst, u8 type, u8 version,
			      void *tvlv_value, u16 tvlv_value_len);
unsigned short batadv_get_vid(struct sk_buff *skb, size_t header_len);
bool batadv_vlan_ap_isola_get(struct batadv_priv *bat_priv, unsigned short vid);

#endif /* _NET_BATMAN_ADV_MAIN_H_ */
Commit	Line	Data
0046b040	1	/* Copyright (C) 2007-2016 B.A.T.M.A.N. contributors:
c6c8fea2 SE	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
ebf38fb7	15	* along with this program; if not, see <http://www.gnu.org/licenses/>.
c6c8fea2 SE	16	*/
	17
	18	#ifndef _NET_BATMAN_ADV_MAIN_H_
	19	#define _NET_BATMAN_ADV_MAIN_H_
	20
bc58eeef	21	#define BATADV_DRIVER_AUTHOR "Marek Lindner <mareklindner@neomailbox.ch>, " \
c679ff8f	22	"Simon Wunderlich <sw@simonwunderlich.de>"
42d0b044 SE	23	#define BATADV_DRIVER_DESC "B.A.T.M.A.N. advanced"
42d0b044 SE	24	#define BATADV_DRIVER_DEVICE "batman-adv"
c6c8fea2	25
42d0b044	26	#ifndef BATADV_SOURCE_VERSION
4a4d045e	27	#define BATADV_SOURCE_VERSION "2016.0"
44c4349a	28	#endif
c6c8fea2 SE	29
	30	/* B.A.T.M.A.N. parameters */
	31
42d0b044	32	#define BATADV_TQ_MAX_VALUE 255
0da00359	33	#define BATADV_THROUGHPUT_MAX_VALUE 0xFFFFFFFF
42d0b044	34	#define BATADV_JITTER 20
c6c8fea2	35
9cfc7bd6	36	/* Time To Live of broadcast messages */
42d0b044	37	#define BATADV_TTL 50
6e215fd8	38
81f02683 SW	39	/* maximum sequence number age of broadcast messages */
	40	#define BATADV_BCAST_MAX_AGE 64
	41
6e215fd8	42	/* purge originators after time in seconds if no valid packet comes in
42d0b044	43	* -> TODO: check influence on BATADV_TQ_LOCAL_WINDOW_SIZE
9cfc7bd6	44	*/
42d0b044	45	#define BATADV_PURGE_TIMEOUT 200000 /* 200 seconds */
7cf4d520	46	#define BATADV_TT_LOCAL_TIMEOUT 600000 /* in milliseconds */
a51fb9b2	47	#define BATADV_TT_CLIENT_ROAM_TIMEOUT 600000 /* in milliseconds */
30cfd02b	48	#define BATADV_TT_CLIENT_TEMP_TIMEOUT 600000 /* in milliseconds */
72414442 AQ	49	#define BATADV_TT_WORK_PERIOD 5000 /* 5 seconds */
72414442 AQ	50	#define BATADV_ORIG_WORK_PERIOD 1000 /* 1 second */
fc1f8693	51	#define BATADV_DAT_ENTRY_TIMEOUT (5 * 60000) /* 5 mins in milliseconds */
015758d0	52	/* sliding packet range of received originator messages in sequence numbers
9cfc7bd6 SE	53	* (should be a multiple of our word size)
9cfc7bd6 SE	54	*/
42d0b044	55	#define BATADV_TQ_LOCAL_WINDOW_SIZE 64
a51fb9b2	56	/* milliseconds we have to keep pending tt_req */
42d0b044	57	#define BATADV_TT_REQUEST_TIMEOUT 3000
a73105b8	58
42d0b044 SE	59	#define BATADV_TQ_GLOBAL_WINDOW_SIZE 5
	60	#define BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM 1
	61	#define BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM 1
	62	#define BATADV_TQ_TOTAL_BIDRECT_LIMIT 1
c6c8fea2	63
162bd64c LL	64	/* B.A.T.M.A.N. V */
	65	#define BATADV_ELP_MAX_AGE 64
	66
42d0b044 SE	67	/* number of OGMs sent with the last tt diff */
42d0b044 SE	68	#define BATADV_TT_OGM_APPEND_MAX 3
a73105b8	69
9cfc7bd6	70	/* Time in which a client can roam at most ROAMING_MAX_COUNT times in
a51fb9b2	71	* milliseconds
9cfc7bd6	72	*/
42d0b044 SE	73	#define BATADV_ROAMING_MAX_TIME 20000
42d0b044 SE	74	#define BATADV_ROAMING_MAX_COUNT 5
cc47f66e	75
42d0b044	76	#define BATADV_NO_FLAGS 0
ecbd5321	77
42d0b044	78	#define BATADV_NULL_IFINDEX 0 /* dummy ifindex used to avoid iface checks */
bc279080	79
9464d071 AQ	80	#define BATADV_NO_MARK 0
9464d071 AQ	81
89652331 SW	82	/* default interface for multi interface operation. The default interface is
	83	* used for communication which originated locally (i.e. is not forwarded)
	84	* or where special forwarding is not desired/necessary.
	85	*/
	86	#define BATADV_IF_DEFAULT ((struct batadv_hard_iface *)NULL)
	87
42d0b044	88	#define BATADV_NUM_WORDS BITS_TO_LONGS(BATADV_TQ_LOCAL_WINDOW_SIZE)
c6c8fea2	89
42d0b044	90	#define BATADV_LOG_BUF_LEN 8192 /* has to be a power of 2 */
c6c8fea2	91
caf65bfc MS	92	/* number of packets to send for broadcasts on different interface types */
	93	#define BATADV_NUM_BCASTS_DEFAULT 1
	94	#define BATADV_NUM_BCASTS_WIRELESS 3
	95	#define BATADV_NUM_BCASTS_MAX 3
	96
c384ea3e AQ	97	/* msecs after which an ARP_REQUEST is sent in broadcast as fallback */
c384ea3e AQ	98	#define ARP_REQ_DELAY 250
785ea114 AQ	99	/* numbers of originator to contact for any PUT/GET DHT operation */
	100	#define BATADV_DAT_CANDIDATES_NUM 3
	101
a0e28775 MH	102	/* BATADV_TQ_SIMILARITY_THRESHOLD - TQ points that a secondary metric can differ
a0e28775 MH	103	* at most from the primary one in order to be still considered acceptable
c43c981e AQ	104	*/
	105	#define BATADV_TQ_SIMILARITY_THRESHOLD 50
	106
6e215fd8	107	/* should not be bigger than 512 bytes or change the size of
9cfc7bd6 SE	108	* forw_packet->direct_link_flags
9cfc7bd6 SE	109	*/
42d0b044 SE	110	#define BATADV_MAX_AGGREGATION_BYTES 512
42d0b044 SE	111	#define BATADV_MAX_AGGREGATION_MS 100
c6c8fea2	112
42d0b044	113	#define BATADV_BLA_PERIOD_LENGTH 10000 /* 10 seconds */
e1544f3c	114	#define BATADV_BLA_BACKBONE_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 6)
42d0b044	115	#define BATADV_BLA_CLAIM_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 10)
28709878	116	#define BATADV_BLA_WAIT_PERIODS 3
fe2da6ff	117
42d0b044 SE	118	#define BATADV_DUPLIST_SIZE 16
42d0b044 SE	119	#define BATADV_DUPLIST_TIMEOUT 500 /* 500 ms */
6e215fd8	120	/* don't reset again within 30 seconds */
42d0b044 SE	121	#define BATADV_RESET_PROTECTION_MS 30000
42d0b044 SE	122	#define BATADV_EXPECTED_SEQNO_RANGE 65536
c6c8fea2	123
d56b1705 MH	124	#define BATADV_NC_NODE_TIMEOUT 10000 /* Milliseconds */
d56b1705 MH	125
39c75a51 SE	126	enum batadv_mesh_state {
	127	BATADV_MESH_INACTIVE,
	128	BATADV_MESH_ACTIVE,
	129	BATADV_MESH_DEACTIVATING,
e8958dbf	130	};
c6c8fea2	131
42d0b044 SE	132	#define BATADV_BCAST_QUEUE_LEN 256
42d0b044 SE	133	#define BATADV_BATMAN_QUEUE_LEN 256
c6c8fea2	134
39c75a51 SE	135	enum batadv_uev_action {
	136	BATADV_UEV_ADD = 0,
	137	BATADV_UEV_DEL,
	138	BATADV_UEV_CHANGE,
c6bda689 AQ	139	};
c6bda689 AQ	140
39c75a51 SE	141	enum batadv_uev_type {
39c75a51 SE	142	BATADV_UEV_GW = 0,
c6bda689 AQ	143	};
c6bda689 AQ	144
42d0b044	145	#define BATADV_GW_THRESHOLD 50
43676ab5	146
610bfc6b MH	147	/* Number of fragment chains for each orig_node */
	148	#define BATADV_FRAG_BUFFER_COUNT 8
	149	/* Maximum number of fragments for one packet */
	150	#define BATADV_FRAG_MAX_FRAGMENTS 16
	151	/* Maxumim size of each fragment */
	152	#define BATADV_FRAG_MAX_FRAG_SIZE 1400
	153	/* Time to keep fragments while waiting for rest of the fragments */
	154	#define BATADV_FRAG_TIMEOUT 10000
	155
785ea114 AQ	156	#define BATADV_DAT_CANDIDATE_NOT_FOUND 0
	157	#define BATADV_DAT_CANDIDATE_ORIG 1
	158
21a1236b	159	/* Debug Messages */
c6c8fea2 SE	160	#ifdef pr_fmt
	161	#undef pr_fmt
	162	#endif
6e215fd8 SE	163	/* Append 'batman-adv: ' before kernel messages */
6e215fd8 SE	164	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
c6c8fea2	165
21a1236b	166	/* Kernel headers */
c6c8fea2	167
1e2c2a4f SE	168	#include <linux/atomic.h>
	169	#include <linux/bitops.h> /* for packet.h */
	170	#include <linux/compiler.h>
	171	#include <linux/cpumask.h>
	172	#include <linux/etherdevice.h>
	173	#include <linux/if_ether.h> /* for packet.h */
	174	#include <linux/netdevice.h>
	175	#include <linux/printk.h>
	176	#include <linux/types.h>
f8214865	177	#include <linux/percpu.h>
c6c8fea2	178	#include <linux/jiffies.h>
16052789 AQ	179	#include <linux/if_vlan.h>
16052789 AQ	180
c6c8fea2 SE	181	#include "types.h"
c6c8fea2 SE	182
1e2c2a4f SE	183	struct batadv_ogm_packet;
	184	struct seq_file;
	185	struct sk_buff;
	186
a2f2b6cd	187	#define BATADV_PRINT_VID(vid) ((vid & BATADV_VLAN_HAS_TAG) ? \
eb2deb6b AQ	188	(int)(vid & VLAN_VID_MASK) : -1)
eb2deb6b AQ	189
3193e8fd SE	190	extern char batadv_routing_algo[];
	191	extern struct list_head batadv_hardif_list;
	192
	193	extern unsigned char batadv_broadcast_addr[];
	194	extern struct workqueue_struct *batadv_event_workqueue;
	195
	196	int batadv_mesh_init(struct net_device *soft_iface);
	197	void batadv_mesh_free(struct net_device *soft_iface);
6b5e971a	198	bool batadv_is_my_mac(struct batadv_priv bat_priv, const u8 addr);
30da63a6 ML	199	struct batadv_hard_iface *
30da63a6 ML	200	batadv_seq_print_text_primary_if_get(struct seq_file *seq);
411d6ed9	201	int batadv_max_header_len(void);
c54f38c9	202	void batadv_skb_set_priority(struct sk_buff *skb, int offset);
3193e8fd SE	203	int batadv_batman_skb_recv(struct sk_buff skb, struct net_device dev,
	204	struct packet_type *ptype,
	205	struct net_device *orig_dev);
56303d34	206	int
6b5e971a	207	batadv_recv_handler_register(u8 packet_type,
56303d34 SE	208	int (recv_handler)(struct sk_buff ,
56303d34 SE	209	struct batadv_hard_iface *));
6b5e971a	210	void batadv_recv_handler_unregister(u8 packet_type);
56303d34 SE	211	int batadv_algo_register(struct batadv_algo_ops *bat_algo_ops);
56303d34 SE	212	int batadv_algo_select(struct batadv_priv bat_priv, char name);
3193e8fd	213	int batadv_algo_seq_print_text(struct seq_file seq, void offset);
95a066d8	214	__be32 batadv_skb_crc32(struct sk_buff skb, u8 payload_ptr);
c6c8fea2	215
0aca86cd AQ	216	/**
	217	* enum batadv_dbg_level - available log levels
	218	* @BATADV_DBG_BATMAN: OGM and TQ computations related messages
	219	* @BATADV_DBG_ROUTES: route added / changed / deleted
	220	* @BATADV_DBG_TT: translation table messages
	221	* @BATADV_DBG_BLA: bridge loop avoidance messages
0e861a3c	222	* @BATADV_DBG_DAT: ARP snooping and DAT related messages
d353d8d4	223	* @BATADV_DBG_NC: network coding related messages
0aca86cd AQ	224	* @BATADV_DBG_ALL: the union of all the above log levels
0aca86cd AQ	225	*/
8de47de5 SE	226	enum batadv_dbg_level {
8de47de5 SE	227	BATADV_DBG_BATMAN = BIT(0),
0aca86cd AQ	228	BATADV_DBG_ROUTES = BIT(1),
	229	BATADV_DBG_TT = BIT(2),
	230	BATADV_DBG_BLA = BIT(3),
0e861a3c	231	BATADV_DBG_DAT = BIT(4),
d353d8d4 MH	232	BATADV_DBG_NC = BIT(5),
d353d8d4 MH	233	BATADV_DBG_ALL = 63,
8de47de5 SE	234	};
8de47de5 SE	235
c6c8fea2	236	#ifdef CONFIG_BATMAN_ADV_DEBUG
56303d34	237	int batadv_debug_log(struct batadv_priv bat_priv, const char fmt, ...)
40a072d7	238	__printf(2, 3);
c6c8fea2	239
23c4ec10 AG	240	/* possibly ratelimited debug output */
23c4ec10 AG	241	#define _batadv_dbg(type, bat_priv, ratelimited, fmt, arg...) \
c6c8fea2	242	do { \
23c4ec10 AG	243	if (atomic_read(&bat_priv->log_level) & type && \
23c4ec10 AG	244	(!ratelimited \|\| net_ratelimit())) \
40a072d7	245	batadv_debug_log(bat_priv, fmt, ## arg);\
c6c8fea2 SE	246	} \
	247	while (0)
	248	#else /* !CONFIG_BATMAN_ADV_DEBUG */
23c4ec10 AG	249	__printf(4, 5)
	250	static inline void _batadv_dbg(int type __always_unused,
	251	struct batadv_priv *bat_priv __always_unused,
	252	int ratelimited __always_unused,
	253	const char *fmt __always_unused, ...)
c6c8fea2 SE	254	{
	255	}
	256	#endif
	257
23c4ec10 AG	258	#define batadv_dbg(type, bat_priv, arg...) \
	259	_batadv_dbg(type, bat_priv, 0, ## arg)
	260	#define batadv_dbg_ratelimited(type, bat_priv, arg...) \
	261	_batadv_dbg(type, bat_priv, 1, ## arg)
	262
3e34819e	263	#define batadv_info(net_dev, fmt, arg...) \
c6c8fea2 SE	264	do { \
c6c8fea2 SE	265	struct net_device *_netdev = (net_dev); \
56303d34	266	struct batadv_priv *_batpriv = netdev_priv(_netdev); \
39c75a51	267	batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \
c6c8fea2 SE	268	pr_info("%s: " fmt, _netdev->name, ## arg); \
c6c8fea2 SE	269	} while (0)
3e34819e	270	#define batadv_err(net_dev, fmt, arg...) \
c6c8fea2 SE	271	do { \
c6c8fea2 SE	272	struct net_device *_netdev = (net_dev); \
56303d34	273	struct batadv_priv *_batpriv = netdev_priv(_netdev); \
39c75a51	274	batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \
c6c8fea2 SE	275	pr_err("%s: " fmt, _netdev->name, ## arg); \
	276	} while (0)
	277
62fe710f SE	278	/**
62fe710f SE	279	* batadv_compare_eth - Compare two not u16 aligned Ethernet addresses
7afcbbef SE	280	* @data1: Pointer to a six-byte array containing the Ethernet address
7afcbbef SE	281	* @data2: Pointer other six-byte array containing the Ethernet address
39901e71	282	*
c3923b7a	283	* note: can't use ether_addr_equal() as it requires aligned memory
62fe710f SE	284	*
62fe710f SE	285	* Return: 1 if they are the same ethernet addr
39901e71	286	*/
f2d5cf2a	287	static inline bool batadv_compare_eth(const void data1, const void data2)
39901e71	288	{
d9cd4fe5	289	return ether_addr_equal_unaligned(data1, data2);
39901e71 ML	290	}
39901e71 ML	291
2c53040f BH	292	/**
2c53040f BH	293	* has_timed_out - compares current time (jiffies) and timestamp + timeout
a04ccd59 MH	294	* @timestamp: base value to compare with (in jiffies)
	295	* @timeout: added to base value before comparing (in milliseconds)
	296	*
62fe710f	297	* Return: true if current time is after timestamp + timeout
a04ccd59	298	*/
1eda58bf SE	299	static inline bool batadv_has_timed_out(unsigned long timestamp,
1eda58bf SE	300	unsigned int timeout)
a04ccd59 MH	301	{
	302	return time_is_before_jiffies(timestamp + msecs_to_jiffies(timeout));
	303	}
747e4221	304
3e34819e	305	#define batadv_atomic_dec_not_zero(v) atomic_add_unless((v), -1, 0)
5f657ec0	306
f5d33d37	307	/* Returns the smallest signed integer in two's complement with the sizeof x */
3e34819e	308	#define batadv_smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u)))
f5d33d37 AQ	309
	310	/* Checks if a sequence number x is a predecessor/successor of y.
	311	* they handle overflows/underflows and can correctly check for a
	312	* predecessor/successor unless the variable sequence number has grown by
	313	* more then 2**(bitwidth(x)-1)-1.
6b5e971a	314	* This means that for a u8 with the maximum value 255, it would think:
f5d33d37 AQ	315	* - when adding nothing - it is neither a predecessor nor a successor
	316	* - before adding more than 127 to the starting value - it is a predecessor,
	317	* - when adding 128 - it is neither a predecessor nor a successor,
9cfc7bd6 SE	318	* - after adding more than 127 to the starting value - it is a successor
9cfc7bd6 SE	319	*/
9687a31c AQ	320	#define batadv_seq_before(x, y) ({typeof(x)_d1 = (x); \
	321	typeof(y)_d2 = (y); \
	322	typeof(x)_dummy = (_d1 - _d2); \
	323	(void)(&_d1 == &_d2); \
3e34819e SE	324	_dummy > batadv_smallest_signed_int(_dummy); })
3e34819e SE	325	#define batadv_seq_after(x, y) batadv_seq_before(y, x)
f5d33d37	326
f8214865	327	/* Stop preemption on local cpu while incrementing the counter */
56303d34	328	static inline void batadv_add_counter(struct batadv_priv *bat_priv, size_t idx,
f8214865 MH	329	size_t count)
f8214865 MH	330	{
56917443	331	this_cpu_add(bat_priv->bat_counters[idx], count);
f8214865 MH	332	}
	333
	334	#define batadv_inc_counter(b, i) batadv_add_counter(b, i, 1)
	335
62fe710f SE	336	/**
62fe710f SE	337	* batadv_sum_counter - Sum the cpu-local counters for index 'idx'
7afcbbef SE	338	* @bat_priv: the bat priv with all the soft interface information
7afcbbef SE	339	* @idx: index of counter to sum up
62fe710f SE	340	*
	341	* Return: sum of all cpu-local counters
	342	*/
6b5e971a	343	static inline u64 batadv_sum_counter(struct batadv_priv *bat_priv, size_t idx)
f8214865	344	{
6b5e971a	345	u64 *counters, sum = 0;
f8214865	346	int cpu;
f8214865 MH	347
	348	for_each_possible_cpu(cpu) {
	349	counters = per_cpu_ptr(bat_priv->bat_counters, cpu);
	350	sum += counters[idx];
	351	}
	352
	353	return sum;
	354	}
	355
3c12de9a MH	356	/* Define a macro to reach the control buffer of the skb. The members of the
	357	* control buffer are defined in struct batadv_skb_cb in types.h.
	358	* The macro is inspired by the similar macro TCP_SKB_CB() in tcp.h.
	359	*/
	360	#define BATADV_SKB_CB(__skb) ((struct batadv_skb_cb *)&((__skb)->cb[0]))
	361
ef261577	362	void batadv_tvlv_container_register(struct batadv_priv *bat_priv,
6b5e971a SE	363	u8 type, u8 version,
	364	void *tvlv_value, u16 tvlv_value_len);
	365	u16 batadv_tvlv_container_ogm_append(struct batadv_priv *bat_priv,
	366	unsigned char **packet_buff,
	367	int *packet_buff_len, int packet_min_len);
ef261577 ML	368	void batadv_tvlv_ogm_receive(struct batadv_priv *bat_priv,
	369	struct batadv_ogm_packet *batadv_ogm_packet,
	370	struct batadv_orig_node *orig_node);
	371	void batadv_tvlv_container_unregister(struct batadv_priv *bat_priv,
6b5e971a	372	u8 type, u8 version);
ef261577 ML	373
	374	void batadv_tvlv_handler_register(struct batadv_priv *bat_priv,
	375	void (optr)(struct batadv_priv bat_priv,
	376	struct batadv_orig_node *orig,
6b5e971a	377	u8 flags,
ef261577	378	void *tvlv_value,
6b5e971a	379	u16 tvlv_value_len),
ef261577	380	int (uptr)(struct batadv_priv bat_priv,
6b5e971a	381	u8 src, u8 dst,
ef261577	382	void *tvlv_value,
6b5e971a SE	383	u16 tvlv_value_len),
6b5e971a SE	384	u8 type, u8 version, u8 flags);
ef261577	385	void batadv_tvlv_handler_unregister(struct batadv_priv *bat_priv,
6b5e971a	386	u8 type, u8 version);
ef261577 ML	387	int batadv_tvlv_containers_process(struct batadv_priv *bat_priv,
	388	bool ogm_source,
	389	struct batadv_orig_node *orig_node,
6b5e971a SE	390	u8 src, u8 dst,
	391	void *tvlv_buff, u16 tvlv_buff_len);
	392	void batadv_tvlv_unicast_send(struct batadv_priv bat_priv, u8 src,
	393	u8 *dst, u8 type, u8 version,
	394	void *tvlv_value, u16 tvlv_value_len);
c018ad3d	395	unsigned short batadv_get_vid(struct sk_buff *skb, size_t header_len);
eceb22ae	396	bool batadv_vlan_ap_isola_get(struct batadv_priv *bat_priv, unsigned short vid);
ef261577	397
c6c8fea2	398	#endif /* _NET_BATMAN_ADV_MAIN_H_ */