1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* Copyright (C) B.A.T.M.A.N. contributors: 3 * 4 * Marek Lindner, Simon Wunderlich 5 */ 6 7 #ifndef _NET_BATMAN_ADV_MAIN_H_ 8 #define _NET_BATMAN_ADV_MAIN_H_ 9 10 #define BATADV_DRIVER_AUTHOR "Marek Lindner <marek.lindner@mailbox.org>, " \ 11 "Simon Wunderlich <sw@simonwunderlich.de>" 12 #define BATADV_DRIVER_DESC "B.A.T.M.A.N. advanced" 13 #define BATADV_DRIVER_DEVICE "batman-adv" 14 15 #ifndef BATADV_SOURCE_VERSION 16 #define BATADV_SOURCE_VERSION "2025.4" 17 #endif 18 19 /* B.A.T.M.A.N. parameters */ 20 21 #define BATADV_TQ_MAX_VALUE 255 22 #define BATADV_THROUGHPUT_MAX_VALUE 0xFFFFFFFF 23 #define BATADV_JITTER 20 24 25 #define BATADV_MAX_MTU (ETH_MAX_MTU - batadv_max_header_len()) 26 27 /* Time To Live of broadcast messages */ 28 #define BATADV_TTL 50 29 30 /* maximum sequence number age of broadcast messages */ 31 #define BATADV_BCAST_MAX_AGE 64 32 33 /* purge originators after time in seconds if no valid packet comes in 34 * -> TODO: check influence on BATADV_TQ_LOCAL_WINDOW_SIZE 35 */ 36 #define BATADV_PURGE_TIMEOUT 200000 /* 200 seconds */ 37 #define BATADV_TT_LOCAL_TIMEOUT 600000 /* in milliseconds */ 38 #define BATADV_TT_CLIENT_ROAM_TIMEOUT 600000 /* in milliseconds */ 39 #define BATADV_TT_CLIENT_TEMP_TIMEOUT 600000 /* in milliseconds */ 40 #define BATADV_TT_WORK_PERIOD 5000 /* 5 seconds */ 41 #define BATADV_ORIG_WORK_PERIOD 1000 /* 1 second */ 42 #define BATADV_MCAST_WORK_PERIOD 500 /* 0.5 seconds */ 43 #define BATADV_DAT_ENTRY_TIMEOUT (5 * 60000) /* 5 mins in milliseconds */ 44 /* sliding packet range of received originator messages in sequence numbers 45 * (should be a multiple of our word size) 46 */ 47 #define BATADV_TQ_LOCAL_WINDOW_SIZE 64 48 /* milliseconds we have to keep pending tt_req */ 49 #define BATADV_TT_REQUEST_TIMEOUT 3000 50 51 #define BATADV_TQ_GLOBAL_WINDOW_SIZE 5 52 #define BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM 1 53 #define BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM 1 54 #define BATADV_TQ_TOTAL_BIDRECT_LIMIT 1 55 56 /* B.A.T.M.A.N. V */ 57 #define BATADV_THROUGHPUT_DEFAULT_VALUE 10 /* 1 Mbps */ 58 #define BATADV_ELP_PROBES_PER_NODE 2 59 #define BATADV_ELP_MIN_PROBE_SIZE 200 /* bytes */ 60 #define BATADV_ELP_PROBE_MAX_TX_DIFF 100 /* milliseconds */ 61 #define BATADV_ELP_MAX_AGE 64 62 #define BATADV_OGM_MAX_ORIGDIFF 5 63 #define BATADV_OGM_MAX_AGE 64 64 65 /* number of OGMs sent with the last tt diff */ 66 #define BATADV_TT_OGM_APPEND_MAX 3 67 68 /* Time in which a client can roam at most ROAMING_MAX_COUNT times in 69 * milliseconds 70 */ 71 #define BATADV_ROAMING_MAX_TIME 20000 72 #define BATADV_ROAMING_MAX_COUNT 5 73 74 #define BATADV_NO_FLAGS 0 75 76 #define BATADV_NULL_IFINDEX 0 /* dummy ifindex used to avoid iface checks */ 77 78 #define BATADV_NO_MARK 0 79 80 /* default interface for multi interface operation. The default interface is 81 * used for communication which originated locally (i.e. is not forwarded) 82 * or where special forwarding is not desired/necessary. 83 */ 84 #define BATADV_IF_DEFAULT ((struct batadv_hard_iface *)NULL) 85 86 #define BATADV_NUM_WORDS BITS_TO_LONGS(BATADV_TQ_LOCAL_WINDOW_SIZE) 87 88 #define BATADV_LOG_BUF_LEN 8192 /* has to be a power of 2 */ 89 90 /* number of packets to send for broadcasts on different interface types */ 91 #define BATADV_NUM_BCASTS_DEFAULT 1 92 #define BATADV_NUM_BCASTS_WIRELESS 3 93 94 /* length of the single packet used by the TP meter */ 95 #define BATADV_TP_PACKET_LEN ETH_DATA_LEN 96 97 /* msecs after which an ARP_REQUEST is sent in broadcast as fallback */ 98 #define ARP_REQ_DELAY 250 99 /* numbers of originator to contact for any PUT/GET DHT operation */ 100 #define BATADV_DAT_CANDIDATES_NUM 3 101 102 /* BATADV_TQ_SIMILARITY_THRESHOLD - TQ points that a secondary metric can differ 103 * at most from the primary one in order to be still considered acceptable 104 */ 105 #define BATADV_TQ_SIMILARITY_THRESHOLD 50 106 107 #define BATADV_MAX_AGGREGATION_PACKETS 32 108 #define BATADV_MAX_AGGREGATION_BYTES 512 109 #define BATADV_MAX_AGGREGATION_MS 100 110 111 #define BATADV_BLA_PERIOD_LENGTH 10000 /* 10 seconds */ 112 #define BATADV_BLA_BACKBONE_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 6) 113 #define BATADV_BLA_CLAIM_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 10) 114 #define BATADV_BLA_WAIT_PERIODS 3 115 #define BATADV_BLA_LOOPDETECT_PERIODS 6 116 #define BATADV_BLA_LOOPDETECT_TIMEOUT 3000 /* 3 seconds */ 117 118 #define BATADV_DUPLIST_SIZE 16 119 #define BATADV_DUPLIST_TIMEOUT 500 /* 500 ms */ 120 /* don't reset again within 30 seconds */ 121 #define BATADV_RESET_PROTECTION_MS 30000 122 #define BATADV_EXPECTED_SEQNO_RANGE 65536 123 124 /** 125 * BATADV_TP_MAX_NUM - maximum number of simultaneously active tp sessions 126 */ 127 #define BATADV_TP_MAX_NUM 5 128 129 /** 130 * enum batadv_mesh_state - State of a mesh interface 131 */ 132 enum batadv_mesh_state { 133 /** @BATADV_MESH_INACTIVE: mesh interface is not yet running */ 134 BATADV_MESH_INACTIVE, 135 136 /** @BATADV_MESH_ACTIVE: interface is up and running */ 137 BATADV_MESH_ACTIVE, 138 139 /** @BATADV_MESH_DEACTIVATING: interface is getting shut down */ 140 BATADV_MESH_DEACTIVATING, 141 }; 142 143 #define BATADV_BCAST_QUEUE_LEN 256 144 #define BATADV_BATMAN_QUEUE_LEN 256 145 146 /** 147 * enum batadv_uev_action - action type of uevent 148 */ 149 enum batadv_uev_action { 150 /** @BATADV_UEV_ADD: gateway was selected (after none was selected) */ 151 BATADV_UEV_ADD = 0, 152 153 /** 154 * @BATADV_UEV_DEL: selected gateway was removed and none is selected 155 * anymore 156 */ 157 BATADV_UEV_DEL, 158 159 /** 160 * @BATADV_UEV_CHANGE: a different gateway was selected as based gateway 161 */ 162 BATADV_UEV_CHANGE, 163 164 /** 165 * @BATADV_UEV_LOOPDETECT: loop was detected which cannot be handled by 166 * bridge loop avoidance 167 */ 168 BATADV_UEV_LOOPDETECT, 169 }; 170 171 /** 172 * enum batadv_uev_type - Type of uevent 173 */ 174 enum batadv_uev_type { 175 /** @BATADV_UEV_GW: selected gateway was modified */ 176 BATADV_UEV_GW = 0, 177 178 /** @BATADV_UEV_BLA: bridge loop avoidance event */ 179 BATADV_UEV_BLA, 180 }; 181 182 #define BATADV_GW_THRESHOLD 50 183 184 /* Number of fragment chains for each orig_node */ 185 #define BATADV_FRAG_BUFFER_COUNT 8 186 /* Maximum number of fragments for one packet */ 187 #define BATADV_FRAG_MAX_FRAGMENTS 16 188 /* Maxumim size of each fragment */ 189 #define BATADV_FRAG_MAX_FRAG_SIZE 1280 190 /* Time to keep fragments while waiting for rest of the fragments */ 191 #define BATADV_FRAG_TIMEOUT 10000 192 193 #define BATADV_DAT_CANDIDATE_NOT_FOUND 0 194 #define BATADV_DAT_CANDIDATE_ORIG 1 195 196 /* Debug Messages */ 197 #ifdef pr_fmt 198 #undef pr_fmt 199 #endif 200 /* Append 'batman-adv: ' before kernel messages */ 201 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt 202 203 /* Kernel headers */ 204 205 #include <linux/atomic.h> 206 #include <linux/compiler.h> 207 #include <linux/etherdevice.h> 208 #include <linux/if_vlan.h> 209 #include <linux/jiffies.h> 210 #include <linux/netdevice.h> 211 #include <linux/percpu.h> 212 #include <linux/skbuff.h> 213 #include <linux/types.h> 214 #include <uapi/linux/batadv_packet.h> 215 216 #include "types.h" 217 #include "main.h" 218 219 /** 220 * batadv_print_vid() - return printable version of vid information 221 * @vid: the VLAN identifier 222 * 223 * Return: -1 when no VLAN is used, VLAN id otherwise 224 */ 225 static inline int batadv_print_vid(unsigned short vid) 226 { 227 if (vid & BATADV_VLAN_HAS_TAG) 228 return (int)(vid & VLAN_VID_MASK); 229 else 230 return -1; 231 } 232 233 extern struct list_head batadv_hardif_list; 234 extern unsigned int batadv_hardif_generation; 235 236 extern struct workqueue_struct *batadv_event_workqueue; 237 238 int batadv_mesh_init(struct net_device *mesh_iface); 239 void batadv_mesh_free(struct net_device *mesh_iface); 240 bool batadv_is_my_mac(struct batadv_priv *bat_priv, const u8 *addr); 241 int batadv_max_header_len(void); 242 void batadv_skb_set_priority(struct sk_buff *skb, int offset); 243 int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev, 244 struct packet_type *ptype, 245 struct net_device *orig_dev); 246 int 247 batadv_recv_handler_register(u8 packet_type, 248 int (*recv_handler)(struct sk_buff *, 249 struct batadv_hard_iface *)); 250 void batadv_recv_handler_unregister(u8 packet_type); 251 252 /** 253 * batadv_compare_eth() - Compare two not u16 aligned Ethernet addresses 254 * @data1: Pointer to a six-byte array containing the Ethernet address 255 * @data2: Pointer other six-byte array containing the Ethernet address 256 * 257 * note: can't use ether_addr_equal() as it requires aligned memory 258 * 259 * Return: true if they are the same ethernet addr 260 */ 261 static inline bool batadv_compare_eth(const void *data1, const void *data2) 262 { 263 return ether_addr_equal_unaligned(data1, data2); 264 } 265 266 /** 267 * batadv_has_timed_out() - compares current time (jiffies) and timestamp + 268 * timeout 269 * @timestamp: base value to compare with (in jiffies) 270 * @timeout: added to base value before comparing (in milliseconds) 271 * 272 * Return: true if current time is after timestamp + timeout 273 */ 274 static inline bool batadv_has_timed_out(unsigned long timestamp, 275 unsigned int timeout) 276 { 277 return time_is_before_jiffies(timestamp + msecs_to_jiffies(timeout)); 278 } 279 280 /** 281 * batadv_atomic_dec_not_zero() - Decrease unless the number is 0 282 * @v: pointer of type atomic_t 283 * 284 * Return: non-zero if v was not 0, and zero otherwise. 285 */ 286 #define batadv_atomic_dec_not_zero(v) atomic_add_unless((v), -1, 0) 287 288 /** 289 * batadv_smallest_signed_int() - Returns the smallest signed integer in two's 290 * complement with the sizeof x 291 * @x: type of integer 292 * 293 * Return: smallest signed integer of type 294 */ 295 #define batadv_smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u))) 296 297 /** 298 * batadv_seq_before() - Checks if a sequence number x is a predecessor of y 299 * @x: potential predecessor of @y 300 * @y: value to compare @x against 301 * 302 * It handles overflows/underflows and can correctly check for a predecessor 303 * unless the variable sequence number has grown by more than 304 * 2**(bitwidth(x)-1)-1. 305 * 306 * This means that for a u8 with the maximum value 255, it would think: 307 * 308 * * when adding nothing - it is neither a predecessor nor a successor 309 * * before adding more than 127 to the starting value - it is a predecessor, 310 * * when adding 128 - it is neither a predecessor nor a successor, 311 * * after adding more than 127 to the starting value - it is a successor 312 * 313 * Return: true when x is a predecessor of y, false otherwise 314 */ 315 #define batadv_seq_before(x, y) ({ \ 316 typeof(x)_d1 = (x); \ 317 typeof(y)_d2 = (y); \ 318 typeof(x)_dummy = (_d1 - _d2); \ 319 (void)(&_d1 == &_d2); \ 320 _dummy > batadv_smallest_signed_int(_dummy); \ 321 }) 322 323 /** 324 * batadv_seq_after() - Checks if a sequence number x is a successor of y 325 * @x: potential successor of @y 326 * @y: value to compare @x against 327 * 328 * It handles overflows/underflows and can correctly check for a successor 329 * unless the variable sequence number has grown by more than 330 * 2**(bitwidth(x)-1)-1. 331 * 332 * This means that for a u8 with the maximum value 255, it would think: 333 * 334 * * when adding nothing - it is neither a predecessor nor a successor 335 * * before adding more than 127 to the starting value - it is a predecessor, 336 * * when adding 128 - it is neither a predecessor nor a successor, 337 * * after adding more than 127 to the starting value - it is a successor 338 * 339 * Return: true when x is a successor of y, false otherwise 340 */ 341 #define batadv_seq_after(x, y) batadv_seq_before(y, x) 342 343 /** 344 * batadv_add_counter() - Add to per cpu statistics counter of mesh interface 345 * @bat_priv: the bat priv with all the mesh interface information 346 * @idx: counter index which should be modified 347 * @count: value to increase counter by 348 * 349 * Stop preemption on local cpu while incrementing the counter 350 */ 351 static inline void batadv_add_counter(struct batadv_priv *bat_priv, size_t idx, 352 size_t count) 353 { 354 this_cpu_add(bat_priv->bat_counters[idx], count); 355 } 356 357 /** 358 * batadv_inc_counter() - Increase per cpu statistics counter of mesh interface 359 * @b: the bat priv with all the mesh interface information 360 * @i: counter index which should be modified 361 */ 362 #define batadv_inc_counter(b, i) batadv_add_counter(b, i, 1) 363 364 /** 365 * BATADV_SKB_CB() - Get batadv_skb_cb from skb control buffer 366 * @__skb: skb holding the control buffer 367 * 368 * The members of the control buffer are defined in struct batadv_skb_cb in 369 * types.h. The macro is inspired by the similar macro TCP_SKB_CB() in tcp.h. 370 * 371 * Return: pointer to the batadv_skb_cb of the skb 372 */ 373 #define BATADV_SKB_CB(__skb) ((struct batadv_skb_cb *)&((__skb)->cb[0])) 374 375 unsigned short batadv_get_vid(struct sk_buff *skb, size_t header_len); 376 bool batadv_vlan_ap_isola_get(struct batadv_priv *bat_priv, unsigned short vid); 377 int batadv_throw_uevent(struct batadv_priv *bat_priv, enum batadv_uev_type type, 378 enum batadv_uev_action action, const char *data); 379 380 #endif /* _NET_BATMAN_ADV_MAIN_H_ */ 381