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

/* Copyright (C) 2007-2013 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA
 */

#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 "2013.4.0"
#endif

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

#define BATADV_TQ_MAX_VALUE 255
#define BATADV_JITTER 20

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

/* 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

/* 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_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

/* how much worse secondary interfaces may be to be considered as bonding
 * candidates
 */
#define BATADV_BONDING_TQ_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 * 3)
#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/mutex.h>	/* mutex */
#include <linux/module.h>	/* needed by all modules */
#include <linux/netdevice.h>	/* netdevice */
#include <linux/etherdevice.h>  /* ethernet address classification */
#include <linux/if_ether.h>	/* ethernet header */
#include <linux/poll.h>		/* poll_table */
#include <linux/kthread.h>	/* kernel threads */
#include <linux/pkt_sched.h>	/* schedule types */
#include <linux/workqueue.h>	/* workqueue */
#include <linux/percpu.h>
#include <linux/slab.h>
#include <net/sock.h>		/* struct sock */
#include <net/rtnetlink.h>
#include <linux/jiffies.h>
#include <linux/seq_file.h>
#include "types.h"

#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);
int batadv_is_my_mac(struct batadv_priv *bat_priv, const uint8_t *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(uint8_t packet_type,
			     int (*recv_handler)(struct sk_buff *,
						 struct batadv_hard_iface *));
void batadv_recv_handler_unregister(uint8_t 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);

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

#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)

/* returns 1 if they are the same ethernet addr
 *
 * note: can't use ether_addr_equal() as it requires aligned memory
 */
static inline int batadv_compare_eth(const void *data1, const void *data2)
{
	return (memcmp(data1, data2, ETH_ALEN) == 0 ? 1 : 0);
}

/**
 * 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)
 *
 * Returns 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 uint8_t 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)

/* Sum and return the cpu-local counters for index 'idx' */
static inline uint64_t batadv_sum_counter(struct batadv_priv *bat_priv,
					  size_t idx)
{
	uint64_t *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,
				    uint8_t type, uint8_t version,
				    void *tvlv_value, uint16_t tvlv_value_len);
uint16_t 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,
				      uint8_t type, uint8_t version);

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

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