net/batman-adv/main.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 /* Copyright (C) B.A.T.M.A.N. contributors:
0003  *
0004  * Marek Lindner, Simon Wunderlich
0005  */
0006
0007 #ifndef _NET_BATMAN_ADV_MAIN_H_
0008 #define _NET_BATMAN_ADV_MAIN_H_
0009
0010 #define BATADV_DRIVER_AUTHOR "Marek Lindner <mareklindner@neomailbox.ch>, " \
0011                  "Simon Wunderlich <sw@simonwunderlich.de>"
0012 #define BATADV_DRIVER_DESC   "B.A.T.M.A.N. advanced"
0013 #define BATADV_DRIVER_DEVICE "batman-adv"
0014
0015 #ifndef BATADV_SOURCE_VERSION
0016 #define BATADV_SOURCE_VERSION "2022.2"
0017 #endif
0018
0019 /* B.A.T.M.A.N. parameters */
0020
0021 #define BATADV_TQ_MAX_VALUE 255
0022 #define BATADV_THROUGHPUT_MAX_VALUE 0xFFFFFFFF
0023 #define BATADV_JITTER 20
0024
0025 /* Time To Live of broadcast messages */
0026 #define BATADV_TTL 50
0027
0028 /* maximum sequence number age of broadcast messages */
0029 #define BATADV_BCAST_MAX_AGE 64
0030
0031 /* purge originators after time in seconds if no valid packet comes in
0032  * -> TODO: check influence on BATADV_TQ_LOCAL_WINDOW_SIZE
0033  */
0034 #define BATADV_PURGE_TIMEOUT 200000 /* 200 seconds */
0035 #define BATADV_TT_LOCAL_TIMEOUT 600000 /* in milliseconds */
0036 #define BATADV_TT_CLIENT_ROAM_TIMEOUT 600000 /* in milliseconds */
0037 #define BATADV_TT_CLIENT_TEMP_TIMEOUT 600000 /* in milliseconds */
0038 #define BATADV_TT_WORK_PERIOD 5000 /* 5 seconds */
0039 #define BATADV_ORIG_WORK_PERIOD 1000 /* 1 second */
0040 #define BATADV_MCAST_WORK_PERIOD 500 /* 0.5 seconds */
0041 #define BATADV_DAT_ENTRY_TIMEOUT (5 * 60000) /* 5 mins in milliseconds */
0042 /* sliding packet range of received originator messages in sequence numbers
0043  * (should be a multiple of our word size)
0044  */
0045 #define BATADV_TQ_LOCAL_WINDOW_SIZE 64
0046 /* milliseconds we have to keep pending tt_req */
0047 #define BATADV_TT_REQUEST_TIMEOUT 3000
0048
0049 #define BATADV_TQ_GLOBAL_WINDOW_SIZE 5
0050 #define BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM 1
0051 #define BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM 1
0052 #define BATADV_TQ_TOTAL_BIDRECT_LIMIT 1
0053
0054 /* B.A.T.M.A.N. V */
0055 #define BATADV_THROUGHPUT_DEFAULT_VALUE 10 /* 1 Mbps */
0056 #define BATADV_ELP_PROBES_PER_NODE 2
0057 #define BATADV_ELP_MIN_PROBE_SIZE 200 /* bytes */
0058 #define BATADV_ELP_PROBE_MAX_TX_DIFF 100 /* milliseconds */
0059 #define BATADV_ELP_MAX_AGE 64
0060 #define BATADV_OGM_MAX_ORIGDIFF 5
0061 #define BATADV_OGM_MAX_AGE 64
0062
0063 /* number of OGMs sent with the last tt diff */
0064 #define BATADV_TT_OGM_APPEND_MAX 3
0065
0066 /* Time in which a client can roam at most ROAMING_MAX_COUNT times in
0067  * milliseconds
0068  */
0069 #define BATADV_ROAMING_MAX_TIME 20000
0070 #define BATADV_ROAMING_MAX_COUNT 5
0071
0072 #define BATADV_NO_FLAGS 0
0073
0074 #define BATADV_NULL_IFINDEX 0 /* dummy ifindex used to avoid iface checks */
0075
0076 #define BATADV_NO_MARK 0
0077
0078 /* default interface for multi interface operation. The default interface is
0079  * used for communication which originated locally (i.e. is not forwarded)
0080  * or where special forwarding is not desired/necessary.
0081  */
0082 #define BATADV_IF_DEFAULT   ((struct batadv_hard_iface *)NULL)
0083
0084 #define BATADV_NUM_WORDS BITS_TO_LONGS(BATADV_TQ_LOCAL_WINDOW_SIZE)
0085
0086 #define BATADV_LOG_BUF_LEN 8192   /* has to be a power of 2 */
0087
0088 /* number of packets to send for broadcasts on different interface types */
0089 #define BATADV_NUM_BCASTS_DEFAULT 1
0090 #define BATADV_NUM_BCASTS_WIRELESS 3
0091
0092 /* length of the single packet used by the TP meter */
0093 #define BATADV_TP_PACKET_LEN ETH_DATA_LEN
0094
0095 /* msecs after which an ARP_REQUEST is sent in broadcast as fallback */
0096 #define ARP_REQ_DELAY 250
0097 /* numbers of originator to contact for any PUT/GET DHT operation */
0098 #define BATADV_DAT_CANDIDATES_NUM 3
0099
0100 /* BATADV_TQ_SIMILARITY_THRESHOLD - TQ points that a secondary metric can differ
0101  * at most from the primary one in order to be still considered acceptable
0102  */
0103 #define BATADV_TQ_SIMILARITY_THRESHOLD 50
0104
0105 /* should not be bigger than 512 bytes or change the size of
0106  * forw_packet->direct_link_flags
0107  */
0108 #define BATADV_MAX_AGGREGATION_BYTES 512
0109 #define BATADV_MAX_AGGREGATION_MS 100
0110
0111 #define BATADV_BLA_PERIOD_LENGTH    10000   /* 10 seconds */
0112 #define BATADV_BLA_BACKBONE_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 6)
0113 #define BATADV_BLA_CLAIM_TIMEOUT    (BATADV_BLA_PERIOD_LENGTH * 10)
0114 #define BATADV_BLA_WAIT_PERIODS     3
0115 #define BATADV_BLA_LOOPDETECT_PERIODS   6
0116 #define BATADV_BLA_LOOPDETECT_TIMEOUT   3000    /* 3 seconds */
0117
0118 #define BATADV_DUPLIST_SIZE     16
0119 #define BATADV_DUPLIST_TIMEOUT      500 /* 500 ms */
0120 /* don't reset again within 30 seconds */
0121 #define BATADV_RESET_PROTECTION_MS 30000
0122 #define BATADV_EXPECTED_SEQNO_RANGE 65536
0123
0124 #define BATADV_NC_NODE_TIMEOUT 10000 /* Milliseconds */
0125
0126 /**
0127  * BATADV_TP_MAX_NUM - maximum number of simultaneously active tp sessions
0128  */
0129 #define BATADV_TP_MAX_NUM 5
0130
0131 /**
0132  * enum batadv_mesh_state - State of a soft interface
0133  */
0134 enum batadv_mesh_state {
0135     /** @BATADV_MESH_INACTIVE: soft interface is not yet running */
0136     BATADV_MESH_INACTIVE,
0137
0138     /** @BATADV_MESH_ACTIVE: interface is up and running */
0139     BATADV_MESH_ACTIVE,
0140
0141     /** @BATADV_MESH_DEACTIVATING: interface is getting shut down */
0142     BATADV_MESH_DEACTIVATING,
0143 };
0144
0145 #define BATADV_BCAST_QUEUE_LEN      256
0146 #define BATADV_BATMAN_QUEUE_LEN 256
0147
0148 /**
0149  * enum batadv_uev_action - action type of uevent
0150  */
0151 enum batadv_uev_action {
0152     /** @BATADV_UEV_ADD: gateway was selected (after none was selected) */
0153     BATADV_UEV_ADD = 0,
0154
0155     /**
0156      * @BATADV_UEV_DEL: selected gateway was removed and none is selected
0157      * anymore
0158      */
0159     BATADV_UEV_DEL,
0160
0161     /**
0162      * @BATADV_UEV_CHANGE: a different gateway was selected as based gateway
0163      */
0164     BATADV_UEV_CHANGE,
0165
0166     /**
0167      * @BATADV_UEV_LOOPDETECT: loop was detected which cannot be handled by
0168      * bridge loop avoidance
0169      */
0170     BATADV_UEV_LOOPDETECT,
0171 };
0172
0173 /**
0174  * enum batadv_uev_type - Type of uevent
0175  */
0176 enum batadv_uev_type {
0177     /** @BATADV_UEV_GW: selected gateway was modified */
0178     BATADV_UEV_GW = 0,
0179
0180     /** @BATADV_UEV_BLA: bridge loop avoidance event */
0181     BATADV_UEV_BLA,
0182 };
0183
0184 #define BATADV_GW_THRESHOLD 50
0185
0186 /* Number of fragment chains for each orig_node */
0187 #define BATADV_FRAG_BUFFER_COUNT 8
0188 /* Maximum number of fragments for one packet */
0189 #define BATADV_FRAG_MAX_FRAGMENTS 16
0190 /* Maxumim size of each fragment */
0191 #define BATADV_FRAG_MAX_FRAG_SIZE 1280
0192 /* Time to keep fragments while waiting for rest of the fragments */
0193 #define BATADV_FRAG_TIMEOUT 10000
0194
0195 #define BATADV_DAT_CANDIDATE_NOT_FOUND  0
0196 #define BATADV_DAT_CANDIDATE_ORIG   1
0197
0198 /* Debug Messages */
0199 #ifdef pr_fmt
0200 #undef pr_fmt
0201 #endif
0202 /* Append 'batman-adv: ' before kernel messages */
0203 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
0204
0205 /* Kernel headers */
0206
0207 #include <linux/atomic.h>
0208 #include <linux/compiler.h>
0209 #include <linux/etherdevice.h>
0210 #include <linux/if_vlan.h>
0211 #include <linux/jiffies.h>
0212 #include <linux/netdevice.h>
0213 #include <linux/percpu.h>
0214 #include <linux/skbuff.h>
0215 #include <linux/types.h>
0216 #include <uapi/linux/batadv_packet.h>
0217
0218 #include "types.h"
0219 #include "main.h"
0220
0221 /**
0222  * batadv_print_vid() - return printable version of vid information
0223  * @vid: the VLAN identifier
0224  *
0225  * Return: -1 when no VLAN is used, VLAN id otherwise
0226  */
0227 static inline int batadv_print_vid(unsigned short vid)
0228 {
0229     if (vid & BATADV_VLAN_HAS_TAG)
0230         return (int)(vid & VLAN_VID_MASK);
0231     else
0232         return -1;
0233 }
0234
0235 extern struct list_head batadv_hardif_list;
0236 extern unsigned int batadv_hardif_generation;
0237
0238 extern unsigned char batadv_broadcast_addr[];
0239 extern struct workqueue_struct *batadv_event_workqueue;
0240
0241 int batadv_mesh_init(struct net_device *soft_iface);
0242 void batadv_mesh_free(struct net_device *soft_iface);
0243 bool batadv_is_my_mac(struct batadv_priv *bat_priv, const u8 *addr);
0244 int batadv_max_header_len(void);
0245 void batadv_skb_set_priority(struct sk_buff *skb, int offset);
0246 int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev,
0247                struct packet_type *ptype,
0248                struct net_device *orig_dev);
0249 int
0250 batadv_recv_handler_register(u8 packet_type,
0251                  int (*recv_handler)(struct sk_buff *,
0252                          struct batadv_hard_iface *));
0253 void batadv_recv_handler_unregister(u8 packet_type);
0254 __be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr);
0255
0256 /**
0257  * batadv_compare_eth() - Compare two not u16 aligned Ethernet addresses
0258  * @data1: Pointer to a six-byte array containing the Ethernet address
0259  * @data2: Pointer other six-byte array containing the Ethernet address
0260  *
0261  * note: can't use ether_addr_equal() as it requires aligned memory
0262  *
0263  * Return: true if they are the same ethernet addr
0264  */
0265 static inline bool batadv_compare_eth(const void *data1, const void *data2)
0266 {
0267     return ether_addr_equal_unaligned(data1, data2);
0268 }
0269
0270 /**
0271  * batadv_has_timed_out() - compares current time (jiffies) and timestamp +
0272  *  timeout
0273  * @timestamp:      base value to compare with (in jiffies)
0274  * @timeout:        added to base value before comparing (in milliseconds)
0275  *
0276  * Return: true if current time is after timestamp + timeout
0277  */
0278 static inline bool batadv_has_timed_out(unsigned long timestamp,
0279                     unsigned int timeout)
0280 {
0281     return time_is_before_jiffies(timestamp + msecs_to_jiffies(timeout));
0282 }
0283
0284 /**
0285  * batadv_atomic_dec_not_zero() - Decrease unless the number is 0
0286  * @v: pointer of type atomic_t
0287  *
0288  * Return: non-zero if v was not 0, and zero otherwise.
0289  */
0290 #define batadv_atomic_dec_not_zero(v)   atomic_add_unless((v), -1, 0)
0291
0292 /**
0293  * batadv_smallest_signed_int() - Returns the smallest signed integer in two's
0294  *  complement with the sizeof x
0295  * @x: type of integer
0296  *
0297  * Return: smallest signed integer of type
0298  */
0299 #define batadv_smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u)))
0300
0301 /**
0302  * batadv_seq_before() - Checks if a sequence number x is a predecessor of y
0303  * @x: potential predecessor of @y
0304  * @y: value to compare @x against
0305  *
0306  * It handles overflows/underflows and can correctly check for a predecessor
0307  * unless the variable sequence number has grown by more than
0308  * 2**(bitwidth(x)-1)-1.
0309  *
0310  * This means that for a u8 with the maximum value 255, it would think:
0311  *
0312  * * when adding nothing - it is neither a predecessor nor a successor
0313  * * before adding more than 127 to the starting value - it is a predecessor,
0314  * * when adding 128 - it is neither a predecessor nor a successor,
0315  * * after adding more than 127 to the starting value - it is a successor
0316  *
0317  * Return: true when x is a predecessor of y, false otherwise
0318  */
0319 #define batadv_seq_before(x, y) ({ \
0320     typeof(x)_d1 = (x); \
0321     typeof(y)_d2 = (y); \
0322     typeof(x)_dummy = (_d1 - _d2); \
0323     (void)(&_d1 == &_d2); \
0324     _dummy > batadv_smallest_signed_int(_dummy); \
0325 })
0326
0327 /**
0328  * batadv_seq_after() - Checks if a sequence number x is a successor of y
0329  * @x: potential successor of @y
0330  * @y: value to compare @x against
0331  *
0332  * It handles overflows/underflows and can correctly check for a successor
0333  * unless the variable sequence number has grown by more than
0334  * 2**(bitwidth(x)-1)-1.
0335  *
0336  * This means that for a u8 with the maximum value 255, it would think:
0337  *
0338  * * when adding nothing - it is neither a predecessor nor a successor
0339  * * before adding more than 127 to the starting value - it is a predecessor,
0340  * * when adding 128 - it is neither a predecessor nor a successor,
0341  * * after adding more than 127 to the starting value - it is a successor
0342  *
0343  * Return: true when x is a successor of y, false otherwise
0344  */
0345 #define batadv_seq_after(x, y) batadv_seq_before(y, x)
0346
0347 /**
0348  * batadv_add_counter() - Add to per cpu statistics counter of soft interface
0349  * @bat_priv: the bat priv with all the soft interface information
0350  * @idx: counter index which should be modified
0351  * @count: value to increase counter by
0352  *
0353  * Stop preemption on local cpu while incrementing the counter
0354  */
0355 static inline void batadv_add_counter(struct batadv_priv *bat_priv, size_t idx,
0356                       size_t count)
0357 {
0358     this_cpu_add(bat_priv->bat_counters[idx], count);
0359 }
0360
0361 /**
0362  * batadv_inc_counter() - Increase per cpu statistics counter of soft interface
0363  * @b: the bat priv with all the soft interface information
0364  * @i: counter index which should be modified
0365  */
0366 #define batadv_inc_counter(b, i) batadv_add_counter(b, i, 1)
0367
0368 /**
0369  * BATADV_SKB_CB() - Get batadv_skb_cb from skb control buffer
0370  * @__skb: skb holding the control buffer
0371  *
0372  * The members of the control buffer are defined in struct batadv_skb_cb in
0373  * types.h. The macro is inspired by the similar macro TCP_SKB_CB() in tcp.h.
0374  *
0375  * Return: pointer to the batadv_skb_cb of the skb
0376  */
0377 #define BATADV_SKB_CB(__skb)       ((struct batadv_skb_cb *)&((__skb)->cb[0]))
0378
0379 unsigned short batadv_get_vid(struct sk_buff *skb, size_t header_len);
0380 bool batadv_vlan_ap_isola_get(struct batadv_priv *bat_priv, unsigned short vid);
0381 int batadv_throw_uevent(struct batadv_priv *bat_priv, enum batadv_uev_type type,
0382             enum batadv_uev_action action, const char *data);
0383
0384 #endif /* _NET_BATMAN_ADV_MAIN_H_ */