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